Merge pull request #303 from cipherstash/remove-examples

chore: remove outdated examples

Author: calvinbrewer

examples/basic/README.md

@@ -1,6 +1,6 @@
-# Basic example of using @cipherstash/protect
+# Basic example of using @cipherstash/stack
 
-This basic example demonstrates how to use the `@cipherstash/protect` package to encrypt arbitrary input.
+This basic example demonstrates how to use the `@cipherstash/stack` package and the **Encryption SDK** to encrypt and decrypt arbitrary input.
 
 ## Installing the basic example
 
@@ -16,7 +16,7 @@ git clone https://github.com/cipherstash/protectjs
 Install dependencies:
 
 ```bash
-# Build Project.js
+# Build the repo (including @cipherstash/stack)
 cd protectjs
 pnpm build
 
@@ -43,7 +43,7 @@ Lastly, install the CipherStash CLI:
 > [!IMPORTANT]
 > Make sure you have [installed the CipherStash CLI](#installation) before following these steps.
 
-Set up all the configuration and credentials required for Protect.js:
+Set up all the configuration and credentials required for the Encryption SDK:
 
 ```bash
 stash setup
@@ -53,8 +53,8 @@ If you have not already signed up for a CipherStash account, this will prompt yo
 
 At the end of `stash setup`, you will have two files in your project:
 
-- `cipherstash.toml` which contains the configuration for Protect.js
-- `cipherstash.secret.toml` which contains the credentials for Protect.js
+- `cipherstash.toml` which contains the configuration for the Encryption SDK
+- `cipherstash.secret.toml` which contains the credentials for the Encryption SDK
 
 > [!WARNING]
 > Do not commit `cipherstash.secret.toml` to git, because it contains sensitive credentials.
@@ -68,8 +68,4 @@ Run the example:
 pnpm start
 ```
 
-The application will log the plaintext to the console that has been encrypted using the CipherStash, decrypted, and logged the original plaintext.
-
-## Next steps
-
-Check out the [Protect.js + Next.js + Clerk example app](../nextjs-clerk) to see how to add end-user identity as an extra control when encrypting data.
+The application will prompt for a name, encrypt it with CipherStash, log the ciphertext, decrypt it, and log the original plaintext. It then runs a short bulk-encryption demo.

examples/basic/encrypt.ts

@@ -0,0 +1,14 @@
+import 'dotenv/config'
+import {
+  Encryption,
+  encryptedTable,
+  encryptedColumn,
+} from '@cipherstash/stack'
+
+export const users = encryptedTable('users', {
+  name: encryptedColumn('name'),
+})
+
+export const client = await Encryption({
+  schemas: [users],
+})

examples/basic/index.ts

@@ -1,6 +1,6 @@
 import 'dotenv/config'
 import readline from 'node:readline'
-import { protectClient, users } from './protect'
+import { client, users } from './encrypt'
 
 const rl = readline.createInterface({
   input: process.stdin,
@@ -18,24 +18,24 @@ const askQuestion = (): Promise<string> => {
 async function main() {
   const input = await askQuestion()
 
-  const encryptResult = await protectClient.encrypt(input, {
+  const encryptResult = await client.encrypt(input, {
     column: users.name,
     table: users,
   })
 
   if (encryptResult.failure) {
-    throw new Error(`[protect]: ${encryptResult.failure.message}`)
+    throw new Error(`[encryption]: ${encryptResult.failure.message}`)
   }
 
   const ciphertext = encryptResult.data
 
   console.log('Encrypting your name...')
   console.log('The ciphertext is:', ciphertext)
 
-  const decryptResult = await protectClient.decrypt(ciphertext)
+  const decryptResult = await client.decrypt(ciphertext)
 
   if (decryptResult.failure) {
-    throw new Error(`[protect]: ${decryptResult.failure.message}`)
+    throw new Error(`[encryption]: ${decryptResult.failure.message}`)
   }
 
   const plaintext = decryptResult.data
@@ -50,21 +50,20 @@ async function main() {
     { id: '1', plaintext: 'Alice' },
     { id: '2', plaintext: 'Bob' },
     { id: '3', plaintext: 'Charlie' },
-    { id: '4', plaintext: null },
   ]
 
   console.log(
     'Bulk encrypting names:',
     bulkPlaintexts.map((p) => p.plaintext),
   )
 
-  const bulkEncryptResult = await protectClient.bulkEncrypt(bulkPlaintexts, {
+  const bulkEncryptResult = await client.bulkEncrypt(bulkPlaintexts, {
     column: users.name,
     table: users,
   })
 
   if (bulkEncryptResult.failure) {
-    throw new Error(`[protect]: ${bulkEncryptResult.failure.message}`)
+    throw new Error(`[encryption]: ${bulkEncryptResult.failure.message}`)
   }
 
   console.log('Bulk encrypted data:', bulkEncryptResult.data)

examples/basic/package.json

@@ -11,7 +11,7 @@
   "license": "ISC",
   "description": "",
   "dependencies": {
-    "@cipherstash/protect": "workspace:*",
+    "@cipherstash/stack": "workspace:*",
     "dotenv": "^16.4.7"
   },
   "devDependencies": {