@botpress/sdk 4.0.0 → 4.0.1

package/dist/plugin/action-proxy/proxy.d.ts

@@ -1,5 +1,5 @@
 import { Client } from '@botpress/client';
 import { BotSpecificClient } from '../../bot';
-import { BasePlugin, PluginInterfaceExtensions } from '../common';
+import { BasePlugin, PluginRuntimeProps } from '../common';
 import { ActionProxy } from './types';
-export declare const proxyActions: <TPlugin extends BasePlugin>(client: BotSpecificClient<TPlugin> | Client, interfaces: PluginInterfaceExtensions<TPlugin>) => ActionProxy<TPlugin>;
+export declare const proxyActions: <TPlugin extends BasePlugin>(client: BotSpecificClient<TPlugin> | Client, props: PluginRuntimeProps<TPlugin>) => ActionProxy<TPlugin>;

package/dist/plugin/common/types.d.ts

@@ -38,4 +38,10 @@ export type PluginInterfaceExtension<TInterface extends BaseInterface = BaseInte
 export type PluginInterfaceExtensions<TPlugin extends BasePlugin = BasePlugin> = {
     [K in keyof TPlugin['interfaces']]: PluginInterfaceExtension<TPlugin['interfaces'][K]>;
 };
+export type PluginConfiguration<TPlugin extends BasePlugin> = TPlugin['configuration'];
+export type PluginRuntimeProps<TPlugin extends BasePlugin = BasePlugin> = {
+    alias?: string;
+    configuration: PluginConfiguration<TPlugin>;
+    interfaces: PluginInterfaceExtensions<TPlugin>;
+};
 export {};

package/dist/plugin/implementation.d.ts

@@ -1,15 +1,10 @@
 import type { MessageHandlersMap as BotMessageHandlersMap, EventHandlersMap as BotEventHandlersMap, StateExpiredHandlersMap as BotStateExpiredHandlersMap, HookHandlersMap as BotHookHandlersMap, WorkflowHandlersMap as BotWorkflowHandlersMap, ActionHandlers as BotActionHandlers, BotHandlers } from '../bot';
 import * as utils from '../utils';
-import { BasePlugin, PluginInterfaceExtensions } from './common';
-import { ActionHandlers, MessageHandlers, EventHandlers, StateExpiredHandlers, HookHandlers, WorkflowHandlers, MessageHandlersMap, EventHandlersMap, StateExpiredHandlersMap, HookHandlersMap, WorkflowHandlersMap, PluginConfiguration } from './server/types';
+import { BasePlugin, PluginRuntimeProps } from './common';
+import { ActionHandlers, MessageHandlers, EventHandlers, StateExpiredHandlers, HookHandlers, WorkflowHandlers, MessageHandlersMap, EventHandlersMap, StateExpiredHandlersMap, HookHandlersMap, WorkflowHandlersMap } from './server/types';
 export type PluginImplementationProps<TPlugin extends BasePlugin = BasePlugin> = {
     actions: ActionHandlers<TPlugin>;
 };
-export type PluginRuntimeProps<TPlugin extends BasePlugin = BasePlugin> = {
-    alias?: string;
-    configuration: PluginConfiguration<TPlugin>;
-    interfaces: PluginInterfaceExtensions<TPlugin>;
-};
 export declare class PluginImplementation<TPlugin extends BasePlugin = BasePlugin> implements BotHandlers<TPlugin> {
     readonly props: PluginImplementationProps<TPlugin>;
     private _runtimeProps;

package/dist/plugin/server/types.d.ts

@@ -4,6 +4,7 @@ import * as workflowProxy from '../../bot/workflow-proxy';
 import * as utils from '../../utils/type-utils';
 import * as actionProxy from '../action-proxy';
 import * as common from '../common';
+import * as stateProxy from '../state-proxy';
 type EnumeratePluginEvents<TPlugin extends common.BasePlugin> = bot.EnumerateEvents<TPlugin> & common.EnumerateInterfaceEvents<TPlugin>;
 type _IncomingEvents<TPlugin extends common.BasePlugin> = {
     [K in utils.StringKeys<EnumeratePluginEvents<TPlugin>>]: utils.Merge<client.Event, {
@@ -76,14 +77,14 @@ export type OutgoingCallActionResponses<TPlugin extends common.BasePlugin> = _Ou
     '*': AnyOutgoingCallActionResponse<TPlugin>;
 };
 export type PluginClient<_TPlugin extends common.BasePlugin> = bot.BotSpecificClient<common.BasePlugin>;
-export type PluginConfiguration<TPlugin extends common.BasePlugin> = TPlugin['configuration'];
 export type CommonHandlerProps<TPlugin extends common.BasePlugin> = {
     ctx: bot.BotContext;
     logger: bot.BotLogger;
     client: PluginClient<TPlugin>;
-    configuration: PluginConfiguration<TPlugin>;
+    configuration: common.PluginConfiguration<TPlugin>;
     interfaces: common.PluginInterfaceExtensions<TPlugin>;
     actions: actionProxy.ActionProxy<TPlugin>;
+    states: stateProxy.StateProxy<TPlugin>;
     /**
      * # EXPERIMENTAL
      * This API is experimental and may change in the future.
@@ -96,12 +97,6 @@ export type MessagePayloads<TPlugin extends common.BasePlugin> = {
         user: client.User;
         conversation: client.Conversation;
         event: client.Event;
-        states: {
-            [TState in utils.StringKeys<TPlugin['states']>]: {
-                type: 'user' | 'conversation' | 'bot';
-                payload: TPlugin['states'][TState];
-            };
-        };
     };
 };
 export type MessageHandlers<TPlugin extends common.BasePlugin> = {

package/dist/plugin/state-proxy/index.d.ts

@@ -0,0 +1,2 @@
+export * from './proxy';
+export * from './types';

package/dist/plugin/state-proxy/proxy.d.ts

@@ -0,0 +1,5 @@
+import { Client } from '@botpress/client';
+import { BotSpecificClient } from '../../bot';
+import { BasePlugin, PluginRuntimeProps } from '../common';
+import { StateProxy } from './types';
+export declare const proxyStates: <TPlugin extends BasePlugin>(client: BotSpecificClient<TPlugin> | Client, props: PluginRuntimeProps<TPlugin>) => StateProxy<TPlugin>;

package/dist/plugin/state-proxy/types.d.ts

@@ -0,0 +1,25 @@
+import * as bot from '../../bot';
+import * as utils from '../../utils/type-utils';
+import { BasePlugin } from '../common';
+type _EnumerateStates<TPlugin extends BasePlugin> = {
+    [TStateName in keyof TPlugin['states']]: TPlugin['states'][TStateName] & {
+        name: TStateName;
+    };
+};
+type _FilterStates<TPlugin extends BasePlugin, TStateType extends bot.StateType> = Extract<utils.ValueOf<_EnumerateStates<TPlugin>>, {
+    type: TStateType;
+}>['name'];
+type _GetStatePayload<TPlugin extends BasePlugin, TStateName extends string | number | symbol> = TPlugin['states'][utils.Cast<TStateName, keyof TPlugin['states']>]['payload'];
+export type StateRepo<TPayload> = {
+    get: (id: string) => Promise<TPayload>;
+    set: (id: string, payload: TPayload) => Promise<void>;
+    getOrSet: (id: string, payload: TPayload) => Promise<TPayload>;
+    delete: (id: string) => Promise<void>;
+    patch: (id: string, payload: Partial<TPayload>) => Promise<void>;
+};
+export type StateProxy<TPlugin extends BasePlugin> = utils.Normalize<{
+    [TStateType in bot.StateType]: {
+        [TStateName in _FilterStates<TPlugin, TStateType>]: StateRepo<_GetStatePayload<TPlugin, TStateName>>;
+    };
+}>;
+export {};

package/dist/plugin/state-proxy/types.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/type-utils.d.ts

@@ -46,10 +46,13 @@ export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) ex
 export type ToSealedRecord<R extends Record<string, any>> = {
     [K in keyof R as string extends K ? never : K]: R[K];
 };
+type NormalizeTuple<T> = T extends [...infer A] ? {
+    [K in keyof A]: Normalize<A[K]>;
+} : never;
 type NormalizeObject<T extends object> = T extends infer O ? {
     [K in keyof O]: Normalize<O[K]>;
 } : never;
-export type Normalize<T> = T extends (...args: infer A) => infer R ? (...args: Normalize<A>) => Normalize<R> : T extends Array<infer E> ? Array<Normalize<E>> : T extends ReadonlyArray<infer E> ? ReadonlyArray<Normalize<E>> : T extends Promise<infer R> ? Promise<Normalize<R>> : T extends Buffer ? Buffer : T extends object ? NormalizeObject<T> : T;
+export type Normalize<T> = T extends (...args: infer A) => infer R ? (...args: NormalizeTuple<A>) => Normalize<R> : T extends Array<infer E> ? Array<Normalize<E>> : T extends ReadonlyArray<infer E> ? ReadonlyArray<Normalize<E>> : T extends Promise<infer R> ? Promise<Normalize<R>> : T extends Buffer ? Buffer : T extends object ? NormalizeObject<T> : T;
 type DeepPartialObject<T extends object> = T extends infer O ? {
     [K in keyof O]?: DeepPartial<O[K]>;
 } : never;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/sdk",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Botpress SDK",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -16,7 +16,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "@botpress/client": "0.48.3",
+    "@botpress/client": "1.0.0",
     "browser-or-node": "^2.1.1"
   },
   "devDependencies": {

package/readme.md

@@ -1,6 +1,6 @@
 # Botpress SDK
 
-Official Botpress SDK for TypeScript. Made for building bots and integrations as code.
+Official Botpress SDK for TypeScript. Made for building bots, plugins and integrations as code.
 
 ## Installation
 
@@ -9,50 +9,3 @@ 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
-```