@botpress/sdk 3.6.3 → 4.0.1

package/.turbo/turbo-build.log

@@ -1,18 +1,18 @@
 
-> @botpress/sdk@3.6.3 build /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.0.1 build /home/runner/work/botpress/botpress/packages/sdk
 > pnpm build:type && pnpm build:node && pnpm build:browser
 
 
-> @botpress/sdk@3.6.3 build:type /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.0.1 build:type /home/runner/work/botpress/botpress/packages/sdk
 > tsc --emitDeclarationOnly --declaration
 
 
-> @botpress/sdk@3.6.3 build:node /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.0.1 build:node /home/runner/work/botpress/botpress/packages/sdk
 > ts-node -T ./build.ts --node
 
 Done
 
-> @botpress/sdk@3.6.3 build:browser /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.0.1 build:browser /home/runner/work/botpress/botpress/packages/sdk
 > ts-node -T ./build.ts --browser
 
 Done

package/dist/bot/client/types.d.ts

@@ -21,7 +21,8 @@ type MessageResponse<TBot extends common.BaseBot, TMessage extends keyof common.
 };
 type StateResponse<TBot extends common.BaseBot, TState extends keyof TBot['states'] = keyof TBot['states']> = utils.Merge<Awaited<Res<client.Client['getState']>>, {
     state: utils.Merge<Awaited<Res<client.Client['getState']>>['state'], {
-        payload: TBot['states'][TState];
+        type: utils.Cast<TBot['states'][TState]['type'], string>;
+        payload: TBot['states'][TState]['payload'];
     }>;
 }>;
 export type CreateConversation<_TBot extends common.BaseBot> = client.Client['createConversation'];
@@ -60,23 +61,23 @@ export type UpdateUser<_TBot extends common.BaseBot> = client.Client['updateUser
 export type DeleteUser<_TBot extends common.BaseBot> = client.Client['deleteUser'];
 export type GetState<TBot extends common.BaseBot> = <TState extends keyof TBot['states']>(x: utils.Merge<Arg<client.Client['getState']>, {
     name: utils.Cast<TState, string>;
+    type: utils.Cast<TBot['states'][TState]['type'], string>;
 }>) => Promise<StateResponse<TBot, TState>>;
 export type SetState<TBot extends common.BaseBot> = <TState extends keyof TBot['states']>(x: utils.Merge<Arg<client.Client['setState']>, {
     name: utils.Cast<TState, string>;
-    payload: TBot['states'][TState] | null;
+    type: utils.Cast<TBot['states'][TState]['type'], string>;
+    payload: TBot['states'][TState]['payload'] | null;
 }>) => Promise<StateResponse<TBot, TState>>;
 export type GetOrSetState<TBot extends common.BaseBot> = <TState extends keyof TBot['states']>(x: utils.Merge<Arg<client.Client['getOrSetState']>, {
     name: utils.Cast<TState, string>;
-    payload: TBot['states'][TState];
+    type: utils.Cast<TBot['states'][TState]['type'], string>;
+    payload: TBot['states'][TState]['payload'];
 }>) => Promise<StateResponse<TBot, TState>>;
 export type PatchState<TBot extends common.BaseBot> = <TState extends keyof TBot['states']>(x: utils.Merge<Arg<client.Client['patchState']>, {
     name: utils.Cast<TState, string>;
-    payload: Partial<TBot['states'][TState]>;
-}>) => Promise<{
-    state: utils.Merge<Awaited<Res<client.Client['patchState']>>['state'], {
-        payload: TBot['states'][TState];
-    }>;
-}>;
+    type: utils.Cast<TBot['states'][TState]['type'], string>;
+    payload: Partial<TBot['states'][TState]['payload']>;
+}>) => Promise<StateResponse<TBot, TState>>;
 export type CallAction<TBot extends common.BaseBot> = <ActionType extends keyof common.EnumerateActions<TBot>>(x: utils.Merge<Arg<client.Client['callAction']>, {
     type: utils.Cast<ActionType, string>;
     input: utils.Cast<common.EnumerateActions<TBot>[ActionType], common.IntegrationInstanceActionDefinition>['input'];

package/dist/bot/common/generic.d.ts

@@ -1,5 +1,6 @@
 import { BaseIntegration, DefaultIntegration, InputBaseIntegration } from '../../integration/common/generic';
 import * as utils from '../../utils/type-utils';
+import * as def from '../definition';
 export * from '../../integration/common/generic';
 export type BaseAction = {
     input: any;
@@ -15,10 +16,14 @@ export type BaseWorkflow = {
         [k: string]: string;
     };
 };
+export type BaseState = {
+    type: def.StateType;
+    payload: any;
+};
 export type BaseBot = {
     integrations: Record<string, BaseIntegration>;
     events: Record<string, any>;
-    states: Record<string, any>;
+    states: Record<string, BaseState>;
     actions: Record<string, BaseAction>;
     tables: Record<string, BaseTable>;
     workflows: Record<string, BaseWorkflow>;

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

@@ -30,7 +30,8 @@ type _IncomingMessages<TBot extends common.BaseBot> = {
 type _IncomingStates<TBot extends common.BaseBot> = {
     [K in utils.StringKeys<common.EnumerateStates<TBot>>]: utils.Merge<client.State, {
         name: K;
-        payload: common.EnumerateStates<TBot>[K];
+        type: common.EnumerateStates<TBot>[K]['type'];
+        payload: common.EnumerateStates<TBot>[K]['payload'];
     }>;
 };
 type _OutgoingMessageRequests<TBot extends common.BaseBot> = {
@@ -102,12 +103,6 @@ export type MessagePayloads<TBot extends common.BaseBot> = {
         user: client.User;
         conversation: client.Conversation;
         event: client.Event;
-        states: {
-            [TState in utils.StringKeys<TBot['states']>]: {
-                type: 'user' | 'conversation' | 'bot';
-                payload: TBot['states'][TState];
-            };
-        };
     };
 };
 export type MessageHandlers<TBot extends common.BaseBot> = {

package/dist/consts.d.ts

@@ -0,0 +1 @@
+export declare const PLUGIN_PREFIX_SEPARATOR = "#";

package/dist/fixtures.d.ts

@@ -169,8 +169,11 @@ export type FooBarBazBot = DefaultBot<{
     };
     states: {
         currentUser: {
-            name: string;
-            age: number;
+            type: 'conversation';
+            payload: {
+                name: string;
+                age: number;
+            };
         };
     };
     workflows: {
@@ -221,6 +224,32 @@ export type FooBarBazPlugin = DefaultPlugin<{
             };
         };
     };
+    states: {
+        alpha: {
+            type: 'conversation';
+            payload: {
+                alpha: string;
+            };
+        };
+        beta: {
+            type: 'user';
+            payload: {
+                beta: number;
+            };
+        };
+        gamma: {
+            type: 'bot';
+            payload: {
+                gamma: boolean;
+            };
+        };
+        delta: {
+            type: 'conversation';
+            payload: {
+                delta: null;
+            };
+        };
+    };
 }>;
 export type EmptyBot = DefaultBot<{
     integrations: {};