Merge pull request #11 from cipherstash/rebrand

feat: rebrand jseql to protect
cipherstash · Feb 17, 2025 · eb73e1b · eb73e1b
2 parents 73a5bfd + 07b8f6e
commit eb73e1b
Show file tree

Hide file tree

Showing 18 changed files with 60 additions and 59 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,3 +1,3 @@
 [workspace]
-members = ["crates/jseql-ffi"]
+members = ["crates/protect-ffi"]
 resolver = "2"
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
-# jseql-ffi
+# protect-ffi
 
 > [!IMPORTANT]  
-> If you are looking to implement this package into your application please use the official [jseql package](https://github.com/cipherstash/jseql).
+> If you are looking to implement this package into your application please use the official [protect package](https://github.com/cipherstash/protect).
 
 This project provides the JS bindings for the CipherStash Client Rust SDK and is bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon).
 
@@ -19,7 +19,7 @@ This command uses the [@neon-rs/cli](https://www.npmjs.com/package/@neon-rs/cli)
 
 ## Exploring
 
-After building `jseql-ffi`, you can explore its exports at the Node console.
+After building `protect-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.
 
 ```sh
@@ -72,15 +72,15 @@ Runs the unit tests by calling `cargo test`. You can learn more about [adding te
 The directory structure of this project is:
 
 ```
-jseql-ffi/
+protect-ffi/
 ├── Cargo.toml
 ├── README.md
 ├── lib/
 ├── src/
 |   ├── index.mts
 |   └── index.cts
 ├── crates/
-|   └── jseql-ffi/
+|   └── protect-ffi/
 |       └── src/
 |           └── lib.rs
 ├── platforms/
@@ -108,12 +108,12 @@ Releases are handled by GitHub Actions using a `workflow_dispatch` event trigger
 The [release workflow](./.github/workflows/release.yml) was generated by [Neon](https://neon-rs.dev/).
 
 The release workflow is responsible for:
-- Building and publishing the main `@cipherstash/jseql-ffi` package as well as the native packages for each platform (e.g. `@cipherstash/jseql-ffi-darwin-arm64`).
+- Building and publishing the main `@cipherstash/protect-ffi` package as well as the native packages for each platform (e.g. `@cipherstash/protect-ffi-darwin-arm64`).
 - Creating the GitHub release.
 - Creating a Git tag for the version.
 
 To perform a release:
-1. Navigate to the ["Release" workflow page](https://github.com/cipherstash/jseql-ffi/actions/workflows/release.yml) in GitHub.
+1. Navigate to the ["Release" workflow page](https://github.com/cipherstash/protect-ffi/actions/workflows/release.yml) in GitHub.
 1. Click on "Run workflow".
 1. Select the branch to release from.
 Use the default of "main" unless you want to do a pre-release version or dry run from a branch.

diff --git a/crates/jseql-ffi/Cargo.toml → crates/protect-ffi/Cargo.toml b/crates/jseql-ffi/Cargo.toml → crates/protect-ffi/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "jseql-ffi"
+name = "protect-ffi"
 version = "0.1.0"
 license = "ISC"
 edition = "2021"

diff --git a/crates/jseql-ffi/src/lib.rs → crates/protect-ffi/src/lib.rs b/crates/jseql-ffi/src/lib.rs → crates/protect-ffi/src/lib.rs
@@ -42,11 +42,11 @@ pub enum Error {
     TypeParse(#[from] TypeParseError),
     #[error(transparent)]
     Encryption(#[from] EncryptionError),
-    #[error("jseql-ffi invariant violation: {0}. This is a bug in jseql-ffi. Please file an issue at https://github.com/cipherstash/jseql/issues.")]
+    #[error("protect-ffi invariant violation: {0}. This is a bug in protect-ffi. Please file an issue at https://github.com/cipherstash/protectjs/issues.")]
     InvariantViolation(String),
     #[error("{0}")]
     Base85(String),
-    #[error("unimplemented: {0} not supported yet by jseql-ffi")]
+    #[error("unimplemented: {0} not supported yet by protect-ffi")]
     Unimplemented(String),
 }
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "@cipherstash/jseql-ffi",
-  "version": "0.5.0",
+  "name": "@cipherstash/protect-ffi",
+  "version": "0.5.2",
   "description": "",
   "main": "./lib/index.cjs",
   "scripts": {
@@ -40,7 +40,7 @@
     "org": "@cipherstash",
     "platforms": "common",
     "load": "./src/load.cts",
-    "prefix": "jseql-ffi-"
+    "prefix": "protect-ffi-"
   },
   "devDependencies": {
     "@neon-rs/cli": "^0.1.82",

diff --git a/platforms/darwin-arm64/README.md b/platforms/darwin-arm64/README.md
@@ -1,3 +1,3 @@
-# `@cipherstash/jseql-ffi-darwin-arm64`
+# `@cipherstash/protect-ffi-darwin-arm64`
 
-Prebuilt binary package for `@cipherstash/jseql-ffi` on `darwin-arm64`.
+Prebuilt binary package for `@cipherstash/protect-ffi` on `darwin-arm64`.
diff --git a/platforms/darwin-arm64/package.json b/platforms/darwin-arm64/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@cipherstash/jseql-ffi-darwin-arm64",
-  "description": "Prebuilt binary package for `@cipherstash/jseql-ffi` on `darwin-arm64`.",
-  "version": "0.5.0",
+  "name": "@cipherstash/protect-ffi-darwin-arm64",
+  "description": "Prebuilt binary package for `@cipherstash/protect-ffi` on `darwin-arm64`.",
+  "version": "0.5.2",
   "os": [
     "darwin"
   ],

diff --git a/platforms/darwin-x64/README.md b/platforms/darwin-x64/README.md
@@ -1,3 +1,3 @@
-# `@cipherstash/jseql-ffi-darwin-x64`
+# `@cipherstash/protect-ffi-darwin-x64`
 
-Prebuilt binary package for `@cipherstash/jseql-ffi` on `darwin-x64`.
+Prebuilt binary package for `@cipherstash/protect-ffi` on `darwin-x64`.
diff --git a/platforms/darwin-x64/package.json b/platforms/darwin-x64/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@cipherstash/jseql-ffi-darwin-x64",
-  "description": "Prebuilt binary package for `@cipherstash/jseql-ffi` on `darwin-x64`.",
-  "version": "0.5.0",
+  "name": "@cipherstash/protect-ffi-darwin-x64",
+  "description": "Prebuilt binary package for `@cipherstash/protect-ffi` on `darwin-x64`.",
+  "version": "0.5.2",
   "os": [
     "darwin"
   ],

diff --git a/platforms/linux-arm64-gnu/README.md b/platforms/linux-arm64-gnu/README.md
@@ -1,3 +1,3 @@
-# `@cipherstash/jseql-ffi-linux-arm64-gnu`
+# `@cipherstash/protect-ffi-linux-arm64-gnu`
 
-Prebuilt binary package for `@cipherstash/jseql-ffi` on `linux-arm64-gnu`.
+Prebuilt binary package for `@cipherstash/protect-ffi` on `linux-arm64-gnu`.
diff --git a/platforms/linux-arm64-gnu/package.json b/platforms/linux-arm64-gnu/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@cipherstash/jseql-ffi-linux-arm64-gnu",
-  "description": "Prebuilt binary package for `@cipherstash/jseql-ffi` on `linux-arm64-gnu`.",
-  "version": "0.5.0",
+  "name": "@cipherstash/protect-ffi-linux-arm64-gnu",
+  "description": "Prebuilt binary package for `@cipherstash/protect-ffi` on `linux-arm64-gnu`.",
+  "version": "0.5.2",
   "os": [
     "linux"
   ],

diff --git a/platforms/linux-x64-gnu/README.md b/platforms/linux-x64-gnu/README.md
@@ -1,3 +1,3 @@
-# `@cipherstash/jseql-ffi-linux-x64-gnu`
+# `@cipherstash/protect-ffi-linux-x64-gnu`
 
-Prebuilt binary package for `@cipherstash/jseql-ffi` on `linux-x64-gnu`.
+Prebuilt binary package for `@cipherstash/protect-ffi` on `linux-x64-gnu`.
diff --git a/platforms/linux-x64-gnu/package.json b/platforms/linux-x64-gnu/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@cipherstash/jseql-ffi-linux-x64-gnu",
-  "description": "Prebuilt binary package for `@cipherstash/jseql-ffi` on `linux-x64-gnu`.",
-  "version": "0.5.0",
+  "name": "@cipherstash/protect-ffi-linux-x64-gnu",
+  "description": "Prebuilt binary package for `@cipherstash/protect-ffi` on `linux-x64-gnu`.",
+  "version": "0.5.2",
   "os": [
     "linux"
   ],

diff --git a/platforms/win32-x64-msvc/README.md b/platforms/win32-x64-msvc/README.md
@@ -1,3 +1,3 @@
-# `@cipherstash/jseql-ffi-win32-x64-msvc`
+# `@cipherstash/protect-ffi-win32-x64-msvc`
 
-Prebuilt binary package for `@cipherstash/jseql-ffi` on `win32-x64-msvc`.
+Prebuilt binary package for `@cipherstash/protect-ffi` on `win32-x64-msvc`.
diff --git a/platforms/win32-x64-msvc/package.json b/platforms/win32-x64-msvc/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@cipherstash/jseql-ffi-win32-x64-msvc",
-  "description": "Prebuilt binary package for `@cipherstash/jseql-ffi` on `win32-x64-msvc`.",
-  "version": "0.5.0",
+  "name": "@cipherstash/protect-ffi-win32-x64-msvc",
+  "description": "Prebuilt binary package for `@cipherstash/protect-ffi` on `win32-x64-msvc`.",
+  "version": "0.5.2",
   "os": [
     "win32"
   ],

diff --git a/src/load.cts b/src/load.cts
@@ -7,11 +7,12 @@
 
 module.exports = require('@neon-rs/load').proxy({
   platforms: {
-    'win32-x64-msvc': () => require('@cipherstash/jseql-ffi-win32-x64-msvc'),
-    'darwin-x64': () => require('@cipherstash/jseql-ffi-darwin-x64'),
-    'darwin-arm64': () => require('@cipherstash/jseql-ffi-darwin-arm64'),
-    'linux-x64-gnu': () => require('@cipherstash/jseql-ffi-linux-x64-gnu'),
-    'linux-arm64-gnu': () => require('@cipherstash/jseql-ffi-linux-arm64-gnu'),
+    'win32-x64-msvc': () => require('@cipherstash/protect-ffi-win32-x64-msvc'),
+    'darwin-x64': () => require('@cipherstash/protect-ffi-darwin-x64'),
+    'darwin-arm64': () => require('@cipherstash/protect-ffi-darwin-arm64'),
+    'linux-x64-gnu': () => require('@cipherstash/protect-ffi-linux-x64-gnu'),
+    'linux-arm64-gnu': () =>
+      require('@cipherstash/protect-ffi-linux-arm64-gnu'),
   },
   debug: () => require('../index.node'),
 })