@botpress/sdk 0.0.5

package/dist/message.d.ts

@@ -0,0 +1,223 @@
+import { z } from 'zod';
+export declare const defaults: {
+    readonly text: {
+        readonly schema: z.ZodObject<{
+            text: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            text: string;
+        }, {
+            text: string;
+        }>;
+    };
+    readonly markdown: {
+        readonly schema: z.ZodObject<{
+            markdown: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            markdown: string;
+        }, {
+            markdown: string;
+        }>;
+    };
+    readonly image: {
+        readonly schema: z.ZodObject<{
+            imageUrl: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            imageUrl: string;
+        }, {
+            imageUrl: string;
+        }>;
+    };
+    readonly audio: {
+        readonly schema: z.ZodObject<{
+            audioUrl: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            audioUrl: string;
+        }, {
+            audioUrl: string;
+        }>;
+    };
+    readonly video: {
+        readonly schema: z.ZodObject<{
+            videoUrl: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            videoUrl: string;
+        }, {
+            videoUrl: string;
+        }>;
+    };
+    readonly file: {
+        readonly schema: z.ZodObject<{
+            fileUrl: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            fileUrl: string;
+        }, {
+            fileUrl: string;
+        }>;
+    };
+    readonly location: {
+        readonly schema: z.ZodObject<{
+            latitude: z.ZodNumber;
+            longitude: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            latitude: number;
+            longitude: number;
+        }, {
+            latitude: number;
+            longitude: number;
+        }>;
+    };
+    readonly carousel: {
+        readonly schema: z.ZodObject<{
+            items: z.ZodArray<z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                imageUrl: z.ZodOptional<z.ZodString>;
+                actions: z.ZodArray<z.ZodObject<{
+                    action: z.ZodEnum<["postback", "url", "say"]>;
+                    label: z.ZodString;
+                    value: z.ZodString;
+                }, "strip", z.ZodTypeAny, {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }, {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }>, "many">;
+            }, "strip", z.ZodTypeAny, {
+                imageUrl?: string | undefined;
+                subtitle?: string | undefined;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                title: string;
+            }, {
+                imageUrl?: string | undefined;
+                subtitle?: string | undefined;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                title: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            items: {
+                imageUrl?: string | undefined;
+                subtitle?: string | undefined;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                title: string;
+            }[];
+        }, {
+            items: {
+                imageUrl?: string | undefined;
+                subtitle?: string | undefined;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                title: string;
+            }[];
+        }>;
+    };
+    readonly card: {
+        readonly schema: z.ZodObject<{
+            title: z.ZodString;
+            subtitle: z.ZodOptional<z.ZodString>;
+            imageUrl: z.ZodOptional<z.ZodString>;
+            actions: z.ZodArray<z.ZodObject<{
+                action: z.ZodEnum<["postback", "url", "say"]>;
+                label: z.ZodString;
+                value: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }, {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            imageUrl?: string | undefined;
+            subtitle?: string | undefined;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            title: string;
+        }, {
+            imageUrl?: string | undefined;
+            subtitle?: string | undefined;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            title: string;
+        }>;
+    };
+    readonly dropdown: {
+        readonly schema: z.ZodObject<{
+            text: z.ZodString;
+            options: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                value: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                value: string;
+                label: string;
+            }, {
+                value: string;
+                label: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }, {
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }>;
+    };
+    readonly choice: {
+        readonly schema: z.ZodObject<{
+            text: z.ZodString;
+            options: z.ZodArray<z.ZodObject<{
+                label: z.ZodString;
+                value: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                value: string;
+                label: string;
+            }, {
+                value: string;
+                label: string;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }, {
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }>;
+    };
+};

package/dist/serve.d.ts

@@ -0,0 +1,18 @@
+export type Request = {
+    body?: string;
+    path: string;
+    query: string;
+    method: string;
+    headers: {
+        [key: string]: string | undefined;
+    };
+};
+export type Response = {
+    body?: string;
+    headers?: {
+        [key: string]: string;
+    };
+    status?: number;
+};
+export type Handler = (req: Request) => Promise<Response | void>;
+export declare function serve(handler: Handler, port?: number, callback?: (port: number) => void): Promise<void>;

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@botpress/sdk",
+  "version": "0.0.5",
+  "description": "",
+  "main": "./src/index.ts",
+  "scripts": {
+    "build:type": "tsc --emitDeclarationOnly --declaration --target es2019 --module commonjs --moduleResolution node --lib es2019",
+    "build:index": "esbuild --bundle --platform=node --minify --sourcemap --outfile=dist/index.js src/index.ts",
+    "build": "pnpm build:type && pnpm build:index"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@botpress/client": "0.0.6",
+    "axios": "0.27.2",
+    "radash": "^9.5.0",
+    "zod": "^3.20.6",
+    "zod-to-json-schema": "^3.20.1"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.17",
+    "type-fest": "^3.4.0",
+    "esbuild": "^0.16.10",
+    "typescript": "^4.9.4"
+  }
+}

package/readme.md

@@ -0,0 +1,62 @@
+# Botpress SDK
+
+Official Botpress SDK for TypeScript. Made for building bots and integrations as code.
+
+## Disclaimer ⚠️
+
+This package is still in development and is not ready for production use. Use it at your own risk.
+
+## Installation
+
+```bash
+npm install --save @botpress/sdk # for npm
+yarn add @botpress/sdk # for yarn
+pnpm add @botpress/sdk # for pnpm
+```
+
+## Usage
+
+1. First, write your bot in a TypeScript file. For example, `src/index.ts`:
+
+```ts
+import { Bot, messages } from '@botpress/sdk'
+
+const bot = new Bot({})
+
+bot.message('', async ({ message, client, ctx }) => {
+  log.info('Received message', message)
+
+  await client.createMessage({
+    conversationId: message.conversationId,
+    userId: ctx.botId,
+    tags: {},
+    type: 'text',
+    payload: {
+      text: `I'm a stub bot. You said: ${message.payload.text}`,
+    },
+  })
+  console.log('text message sent')
+})
+
+export default bot
+```
+
+2. Then, you can run it locally:
+
+```bash
+bp serve --entry-point ./src/index.ts # using the botpress CLI
+
+ts-node -e "import bot from './src'; void bot.serve()" # or using ts-node directly
+```
+
+3. Or, you can bundle it and deploy it to Botpress Cloud:
+
+```bash
+bp deploy --entry-point ./src/index.ts # using the botpress CLI
+
+# or, using esbuild and the Botpress API
+esbuild --bundle --target=es2019 --platform=node --format=cjs --outfile=bundle.js ./src/index.ts
+code=$(cat bundle.js)
+# call the Botpress API using curl or any other HTTP client
+# see https://botpress.com/docs/api/#bot-update-bot
+```