Add Beak.js server (#14)

Author: mme

.github/workflows/release.yml

@@ -36,3 +36,23 @@ jobs:
           yarn workspace @beakjs/react publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish (server)
+        run: |
+          yarn workspace @beakjs/server publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish (next)
+        run: |
+          yarn workspace @beakjs/next publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish (next)
+        run: |
+          yarn workspace @beakjs/remix publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Publish (express)
+        run: |
+          yarn workspace @beakjs/express publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.vscode/cspell.json

@@ -14,6 +14,10 @@
     "chatcmpl",
     "uuidv4",
     "Hola",
-    "Mundo"
+    "Mundo",
+    "OpenAIAPIKey",
+    "nextjs",
+    "typecheck",
+    "isbot"
   ]
 }

README.md

@@ -1,6 +1,6 @@
 # 🐦 Beak.js [![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/mme_xyz?style=flat&logo=x)](https://twitter.com/mme_xyz) [![npm (scoped)](https://img.shields.io/npm/v/%40beakjs/react)](https://www.npmjs.com/package/@beakjs/react)
 
-Beak.js lets you integrate custom conversational assistants into your React applications.
+Beak.js contains everything you need to create custom AI-powered assistants for your React app.
 
 **Key Features:**
 
@@ -32,7 +32,7 @@ import { Beak } from "@beakjs/react";
 
 const App = () => (
   <Beak
-    openAIApiKey="sk-..."
+    __unsafeOpenAIApiKey__="sk-..."
     instructions="Assistant is running in a web app and helps the user with XYZ."
   >
     <MyApp />
@@ -43,7 +43,7 @@ const App = () => (
 
 Now, you've got a chat window ready in the bottom right corner of your website. Give it a try!
 
-**Note:** Don't expose your API key in public-facing apps. We will be adding a solution for securely using your API key soon.
+**Note:** Don't expose your API key in public-facing apps - this is for development only. See [Deployment](#deployment) for information on how to securely deploy your app without compromising your API key.
 
 ### Making Beak.js work with your app
 
@@ -94,6 +94,18 @@ const MyApp = () => {
 
 By using `useBeakFunction` together with `useBeakInfo`, your assistant can see what's happening on the screen and take action within your app depending on the current context.
 
+## Deployment
+
+To keep your API keys safe, we set up a server that forwards your assistant's requests to OpenAI.
+
+Currently, we support the following deployment options:
+
+- [Next.js](/docs/deployment/next.md)
+- [Remix](/docs/deployment/remix.md)
+- [Express](/docs/deployment/express.md)
+
+Read more by clicking the links above.
+
 ## Run the Demo
 
 To run the demo, build the project and start the demo app:

VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

demo/backend/express/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+.env
+dist

demo/backend/express/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "demo-backend-express",
+  "version": "0.0.6",
+  "main": "dist/index.js",
+  "repository": "https://github.com/mme/beakjs.git",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf node_modules && rm -rf .next && rm -rf dist",
+    "start": "node dist/index.js"
+  },
+  "author": "Markus Ecker",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "@beakjs/express": "0.0.6",
+    "dotenv": "^16.3.1",
+    "express": "^4.18.2"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "typescript": "^5.0.4"
+  }
+}

demo/backend/express/src/index.ts

@@ -0,0 +1,14 @@
+import express from "express";
+import { beakHandler } from "@beakjs/express";
+import dotenv from "dotenv";
+dotenv.config();
+
+const app = express();
+const port = 3000;
+
+app.use(express.json());
+app.use("/beak", beakHandler());
+
+app.listen(port, () => {
+  console.log(`Server running on http://localhost:${port}`);
+});

demo/backend/express/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "es2019",
+    "module": "ESNext",
+    "declaration": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "dist",
+    "lib": ["es2019"],
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false,
+    "types": ["node"]
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}