@cipherstash/jseql-ffi
v0.2.0-0
Published
This project was bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).
Downloads
259
Keywords
Readme
jseql-ffi
This project was bootstrapped by create-neon.
Building
Building requires a supported version of Node and Rust.
To run the build, run:
$ npm run build
This command uses the @neon-rs/cli utility to assemble the binary Node addon from the output of cargo
.
Exploring
After building jseql-ffi
, you can explore its exports at the Node console.
CS_CLIENT_ID
and CS_CLIENT_KEY
must be set in your environment for the call to newClient()
to succeed.
$ npm i
$ npm run build
$ node
> const addon = require(".");
> const client = await addon.newClient();
> const ciphertext = await addon.encrypt("plaintext", "column_name", client);
> const plaintext = await addon.decrypt(ciphertext, client);
> console.log({ciphertext, plaintext});
Available Scripts
In the project directory, you can run:
npm run build
Builds the Node addon (index.node
) from source, generating a release build with cargo --release
.
Additional cargo build
arguments may be passed to npm run build
and similar commands. For example, to enable a cargo feature:
npm run build -- --feature=beetle
npm run debug
Similar to npm run build
but generates a debug build with cargo
.
npm run cross
Similar to npm run build
but uses cross-rs to cross-compile for another platform. Use the CARGO_BUILD_TARGET
environment variable to select the build target.
npm run release
Initiate a full build and publication of a new patch release of this library via GitHub Actions.
npm run dryrun
Initiate a dry run of a patch release of this library via GitHub Actions. This performs a full build but does not publish the final result.
npm test
Runs the unit tests by calling cargo test
. You can learn more about adding tests to your Rust code from the Rust book.
Project Layout
The directory structure of this project is:
jseql-ffi/
├── Cargo.toml
├── README.md
├── lib/
├── src/
| ├── index.mts
| └── index.cts
├── crates/
| └── jseql-ffi/
| └── src/
| └── lib.rs
├── platforms/
├── package.json
└── target/
| Entry | Purpose |
|----------------|------------------------------------------------------------------------------------------------------------------------------------------|
| Cargo.toml
| The Cargo manifest file, which informs the cargo
command. |
| README.md
| This file. |
| lib/
| The directory containing the generated output from tsc. |
| src/
| The directory containing the TypeScript source files. |
| index.mts
| Entry point for when this library is loaded via ESM import
syntax. |
| index.cts
| Entry point for when this library is loaded via CJS require
. |
| crates/
| The directory tree containing the Rust source code for the project. |
| lib.rs
| Entry point for the Rust source code. |
| platforms/
| The directory containing distributions of the binary addon backend for each platform supported by this library. |
| package.json
| The npm manifest file, which informs the npm
command. |
| target/
| Binary artifacts generated by the Rust build. |
Learn More
Learn more about: