Merged
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned Files
|
There was a problem hiding this comment.
Pull Request Overview
Introduce a revamped compress-kit API, align documentation and examples across packages, and make small doc refinements in cipher-kit.
- compress-kit: refactor to internal helpers, add throwing/non-throwing APIs, drop cipher-kit dependency, add tests, and update README/package.json
- Standardize README badges/quotes for multiple packages
- Minor documentation improvements in cipher-kit (naming/clarity)
Reviewed Changes
Copilot reviewed 25 out of 26 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/modern-cookies/README.md | Update npm downloads badge to total and switch to double quotes in examples |
| packages/get-client-ip/README.md | Update npm downloads badge to total and switch to double quotes in examples |
| packages/generate-certs/README.md | Update npm downloads badge to total and switch to double quotes in examples |
| packages/compress-kit/src/utils.ts | Remove legacy helpers in favor of new helpers module structure |
| packages/compress-kit/src/tests/compress.test.ts | Remove old tests; superseded by new tests |
| packages/compress-kit/src/index.ts | New public API with try/throwing variants for string/object compress/decompress and improved docs |
| packages/compress-kit/src/helpers/validate.ts | Add validation helpers for strings, integers-in-range, and plain objects |
| packages/compress-kit/src/helpers/types.ts | Define CompressOptions/DecompressOptions and encodings/types |
| packages/compress-kit/src/helpers/object.ts | Add JSON stringify/parse helpers with Result semantics |
| packages/compress-kit/src/helpers/error.ts | Introduce standardized Result and error helpers |
| packages/compress-kit/src/helpers/encode.ts | Add encoding/decoding helpers (utf8/base64/base64url/hex/latin1) |
| packages/compress-kit/src/error.ts | Remove legacy Result/error helpers (replaced by new helpers) |
| packages/compress-kit/src/compress.ts | Re-implement compress/decompress using pako and new helper stack |
| packages/compress-kit/src/tests/encode.test.ts | Add tests for compress/decompress (strings and objects) |
| packages/compress-kit/src/tests/helpers.ts | Test fixtures for new tests |
| packages/compress-kit/package.json | Bump to 2.0.0, remove cipher-kit dependency, update description/keywords |
| packages/compress-kit/README.md | Rewrite with Quick Start, API reference, and updated badges/platforms |
| packages/cipher-kit/src/web/kit.ts | Docstring param rename (data→obj) and clarity tweaks |
| packages/cipher-kit/src/node/kit.ts | Docstring param rename (data→obj) and clarity tweaks |
| packages/cipher-kit/src/helpers/validate.ts | Minor signature tweak (format union order) |
| packages/cipher-kit/src/helpers/types.ts | Doc clarifications and capitalization fixes in comments |
| packages/cipher-kit/src/helpers/object.ts | Harmonize JSON error messages |
| packages/cipher-kit/src/helpers/error.ts | Rework Result to standardized shape and helpers |
| packages/cipher-kit/package.json | Patch version bump to 2.1.1 |
| packages/cipher-kit/README.md | Rename “Usage” to “API Reference” |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.