-
Notifications
You must be signed in to change notification settings - Fork 0
docs: correct Node.js requirement, add core-ts README, bootstrap 0.1.2 release #52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+50
−1
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # @cachekit-io/cachekit-core-ts | ||
|
|
||
| Native Rust bindings for [`@cachekit-io/cachekit`](https://www.npmjs.com/package/@cachekit-io/cachekit). Provides byte-storage (LZ4 + xxHash3), HKDF key derivation, and AES-256-GCM encryption primitives via N-API. | ||
|
|
||
| > **Version note**: 0.1.1 was tagged in git but never published to npm (a CI flag-rename bug in @napi-rs/cli v3, fixed in #51). Published versions on npm jump 0.1.0 → 0.1.2. If you're pinning, use 0.1.2 or later. | ||
|
|
||
| ## Installation | ||
|
|
||
| You shouldn't need to install this directly — it's a peer of `@cachekit-io/cachekit`. Installing the main SDK pulls in the right platform binary automatically: | ||
|
|
||
| ```bash | ||
| npm install @cachekit-io/cachekit | ||
| ``` | ||
|
|
||
| ## Platform support | ||
|
|
||
| Prebuilt binaries are shipped via per-platform npm packages, selected at install time by the `optionalDependencies` mechanism: | ||
|
|
||
| | Platform | Target | Package | | ||
| | --------------------- | --------------------------- | ----------------------------------------------- | | ||
| | Linux x86_64 (glibc) | `x86_64-unknown-linux-gnu` | `@cachekit-io/cachekit-core-ts-linux-x64-gnu` | | ||
| | Linux aarch64 (glibc) | `aarch64-unknown-linux-gnu` | `@cachekit-io/cachekit-core-ts-linux-arm64-gnu` | | ||
| | macOS x86_64 | `x86_64-apple-darwin` | `@cachekit-io/cachekit-core-ts-darwin-x64` | | ||
| | macOS arm64 | `aarch64-apple-darwin` | `@cachekit-io/cachekit-core-ts-darwin-arm64` | | ||
| | Windows x86_64 (MSVC) | `x86_64-pc-windows-msvc` | `@cachekit-io/cachekit-core-ts-win32-x64-msvc` | | ||
|
|
||
| If your platform isn't listed, the package will fail to load at runtime. Open an issue if you need an additional target. | ||
|
|
||
| ## API surface | ||
|
|
||
| Public exports (consumed by `@cachekit-io/cachekit`): | ||
|
|
||
| - `ByteStorage` — LZ4 compression + xxHash3-64 integrity envelope | ||
| - `TenantKeys` — HKDF-SHA256 per-tenant derived keys with `ZeroizeOnDrop` | ||
| - `deriveKey` — single-domain HKDF key derivation | ||
| - `encrypt` / `decrypt` — AES-256-GCM with AAD binding | ||
| - `version` — version string from the underlying Cargo crate | ||
|
|
||
| See the [main SDK README](https://www.npmjs.com/package/@cachekit-io/cachekit) for usage; this package isn't intended for direct consumption. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Node.js 22+ | ||
|
|
||
| ## License | ||
|
|
||
| MIT | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.