@botpress/sdk 4.21.0 → 5.0.0

package/.turbo/turbo-build.log

@@ -1,20 +1,20 @@
 
-> @botpress/sdk@4.21.0 build /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@5.0.0 build /home/runner/work/botpress/botpress/packages/sdk
 > pnpm build:type && pnpm build:node && pnpm build:browser
 
 
-> @botpress/sdk@4.21.0 build:type /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@5.0.0 build:type /home/runner/work/botpress/botpress/packages/sdk
 > tsc -p ./tsconfig.package.json --emitDeclarationOnly --declaration
 
 
-> @botpress/sdk@4.21.0 build:node /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@5.0.0 build:node /home/runner/work/botpress/botpress/packages/sdk
 > ts-node -T ./build.ts --node
 
 Done
 
-> @botpress/sdk@4.21.0 build:browser /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@5.0.0 build:browser /home/runner/work/botpress/botpress/packages/sdk
 > ts-node -T ./build.ts --browser
 
-(node:3050) [DEP0180] DeprecationWarning: fs.Stats constructor is deprecated.
+(node:3093) [DEP0180] DeprecationWarning: fs.Stats constructor is deprecated.
 (Use `node --trace-deprecation ...` to show where the warning was created)
 Done

package/dist/bot/definition.d.ts

@@ -1,6 +1,6 @@
 import { Table } from '@botpress/client';
 import { IntegrationPackage, PluginPackage } from '../package';
-import { PluginInterfaceExtension } from '../plugin';
+import { PluginInterfaceExtension, PluginIntegrationExtension } from '../plugin';
 import { SchemaDefinition } from '../schema';
 import { ValueOf, Merge, StringKeys } from '../utils/type-utils';
 import z, { ZuiObjectSchema, ZuiObjectOrRefSchema } from '../zui';
@@ -58,9 +58,9 @@ export type WorkflowDefinition<TWorkflow extends BaseWorkflows[string] = BaseWor
 export type TableDefinition<TTable extends BaseTables[string] = BaseTables[string]> = Merge<Omit<Table, 'id' | 'createdAt' | 'updatedAt' | 'name'>, {
     schema: TTable;
 }>;
-export type IntegrationConfigInstance<I extends IntegrationPackage = IntegrationPackage> = {
-    enabled: boolean;
-    alias?: string;
+export type ResolvedIntegrationConfigInstance<I extends IntegrationPackage = IntegrationPackage> = {
+    enabled?: boolean;
+    alias: string;
     disabledChannels?: StringKeys<NonNullable<I['definition']['channels']>>[];
 } & ({
     configurationType?: null;
@@ -71,15 +71,53 @@ export type IntegrationConfigInstance<I extends IntegrationPackage = Integration
         configuration: z.infer<NonNullable<I['definition']['configurations']>[K]['schema']>;
     };
 }>);
-export type PluginConfigInstance<P extends PluginPackage = PluginPackage> = {
+type IntegrationConfigInstance<I extends IntegrationPackage = IntegrationPackage> = Omit<ResolvedIntegrationConfigInstance<I>, 'alias'> & {
     alias?: string;
+};
+type _ResolvedPluginConfigInstance<P extends PluginPackage = PluginPackage> = {
+    alias: string;
     configuration: z.infer<NonNullable<P['definition']['configuration']>['schema']>;
     interfaces: {
         [I in keyof NonNullable<P['definition']['interfaces']>]: PluginInterfaceExtension;
     };
+    integrations: {
+        [I in keyof NonNullable<P['definition']['integrations']>]: PluginIntegrationExtension;
+    };
+};
+type PluginConfigInstance<P extends PluginPackage = PluginPackage> = Omit<_ResolvedPluginConfigInstance<P>, 'alias' | 'integrations' | 'interfaces'> & {
+    alias?: string;
+    /** Backing integrations for the plugin's dependencies */
+    dependencies: {
+        [K in StringKeys<NonNullable<P['definition']['interfaces']>>]: {
+            /**
+             * Alias of the integration to use to fullfil this dependency.
+             *
+             * This is the alias given when adding the integration to the bot
+             * via `addIntegration()`.
+             */
+            integrationAlias: string;
+            /**
+             * Alias of the interface within the integration.
+             *
+             * This is the alias defined by the integration package for the
+             * interface it implements.
+             */
+            integrationInterfaceAlias: string;
+        };
+    } & {
+        [K in StringKeys<NonNullable<P['definition']['integrations']>>]: {
+            /**
+             * Alias of the integration to use to fullfil this dependency.
+             *
+             * This is the alias given when adding the integration to the bot
+             * via `addIntegration()`.
+             */
+            integrationAlias: string;
+        };
+    };
 };
-export type IntegrationInstance = IntegrationPackage & Partial<IntegrationConfigInstance>;
-export type PluginInstance = PluginPackage & PluginConfigInstance;
+export type IntegrationInstance = IntegrationPackage & ResolvedIntegrationConfigInstance;
+export type PluginInstance = PluginPackage & _ResolvedPluginConfigInstance;
 export type BotDefinitionProps<TStates extends BaseStates = BaseStates, TEvents extends BaseEvents = BaseEvents, TActions extends BaseActions = BaseActions, TTables extends BaseTables = BaseTables, TWorkflows extends BaseWorkflows = BaseWorkflows> = {
     integrations?: {
         [K: string]: IntegrationInstance;

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

@@ -181,7 +181,7 @@ export type WorkflowPayloads<TBot extends common.BaseBot> = {
          * # EXPERIMENTAL
          * This API is experimental and may change in the future.
          */
-        workflow: workflowProxy.WorkflowWithUtilities<TBot, TWorkflowName>;
+        workflow: workflowProxy.ActionableWorkflow<TBot, TWorkflowName>;
     };
 };
 export type WorkflowHandlers<TBot extends common.BaseBot> = {
@@ -377,10 +377,7 @@ export type InjectedBotHandlers<TBot extends common.BaseBot> = {
     };
     workflowHandlers: {
         [TWorkflowUpdateType in WorkflowUpdateType]: {
-            [TWorkflowName in utils.StringKeys<TBot['workflows']>]?: {
-                handler: WorkflowHandlers<TBot>[TWorkflowName];
-                order: number;
-            }[];
+            [TWorkflowName in utils.StringKeys<TBot['workflows']>]?: WorkflowHandlers<TBot>[TWorkflowName][];
         };
     };
 };

package/dist/bot/workflow-proxy/proxy.d.ts

@@ -3,11 +3,15 @@ import type { BotSpecificClient } from '../../bot';
 import type * as typeUtils from '../../utils/type-utils';
 import type { BaseBot } from '../common';
 import * as botServerTypes from '../server/types';
-import type { WorkflowProxy, WorkflowWithUtilities } from './types';
-export declare const proxyWorkflows: <TBot extends BaseBot>(client: BotSpecificClient<TBot> | client.Client) => WorkflowProxy<TBot>;
+import type { WorkflowProxy, ActionableWorkflow } from './types';
+export declare const proxyWorkflows: <TBot extends BaseBot>(props: {
+    client: BotSpecificClient<TBot> | client.Client;
+    pluginAlias?: string;
+}) => WorkflowProxy<TBot>;
 export declare const wrapWorkflowInstance: <TBot extends BaseBot, TWorkflowName extends typeUtils.StringKeys<TBot["workflows"]>>(props: {
     client: BotSpecificClient<TBot> | client.Client;
     workflow: client.Workflow;
     event?: botServerTypes.WorkflowUpdateEvent;
     onWorkflowUpdate?: (newState: client.Workflow) => Promise<void> | void;
-}) => WorkflowWithUtilities<TBot, TWorkflowName>;
+    pluginAlias?: string;
+}) => ActionableWorkflow<TBot, TWorkflowName>;

package/dist/bot/workflow-proxy/types.d.ts

@@ -1,4 +1,5 @@
 import type * as client from '@botpress/client';
+import { AsyncCollection } from '../../utils/api-paging-utils';
 import type * as typeUtils from '../../utils/type-utils';
 import type * as commonTypes from '../common';
 export type WorkflowProxy<TBot extends commonTypes.BaseBot = commonTypes.BaseBot> = Readonly<{
@@ -7,26 +8,27 @@ export type WorkflowProxy<TBot extends commonTypes.BaseBot = commonTypes.BaseBot
             tags?: typeUtils.AtLeastOneProperty<TBot['workflows'][TWorkflowName]['tags']>;
             input: TBot['workflows'][TWorkflowName]['input'];
         }) => Promise<Readonly<Omit<client.ClientOutputs['createWorkflow'], 'workflow'> & {
-            workflow: WorkflowWithUtilities<TBot, TWorkflowName>;
+            workflow: ActionableWorkflow<TBot, TWorkflowName>;
         }>>;
-        listInstances: Readonly<{
-            all: _ListInstances<TBot, TWorkflowName>;
-            running: _ListInstances<TBot, TWorkflowName>;
-            scheduled: _ListInstances<TBot, TWorkflowName>;
-            allFinished: _ListInstances<TBot, TWorkflowName>;
-            succeeded: _ListInstances<TBot, TWorkflowName>;
-            cancelled: _ListInstances<TBot, TWorkflowName>;
-            timedOut: _ListInstances<TBot, TWorkflowName>;
-            failed: _ListInstances<TBot, TWorkflowName>;
-        }>;
+        listInstances: (x?: Pick<client.ClientInputs['listWorkflows'], 'conversationId' | 'userId'> & {
+            tags?: typeUtils.AtLeastOneProperty<TBot['workflows'][TWorkflowName]['tags']>;
+            /**
+             * Filter by statuses:
+             *
+             * - `pending` - Workflow is created but not started yet
+             * - `in_progress` - Workflow is currently running
+             * - `failed` - Workflow finished with errors
+             * - `completed` - Workflow finished successfully
+             * - `cancelled` - Workflow finished due to cancellation through the API
+             * - `timedout` - Workflow finished due to timeout
+             * - `listening` - Workflow is waiting for an event to continue
+             * - `paused` - Workflow was paused through the API
+             */
+            statuses?: client.Workflow['status'][];
+        }) => AsyncCollection<ActionableWorkflow<TBot, TWorkflowName>>;
     }>;
 }>;
-type _ListInstances<TBot extends commonTypes.BaseBot, TWorkflowName extends typeUtils.StringKeys<TBot['workflows']>> = (x?: Pick<client.ClientInputs['listWorkflows'], 'nextToken' | 'conversationId' | 'userId'> & {
-    tags?: typeUtils.AtLeastOneProperty<TBot['workflows'][TWorkflowName]['tags']>;
-}) => Promise<Readonly<Omit<client.ClientOutputs['listWorkflows'], 'workflows'> & {
-    workflows: WorkflowWithUtilities<TBot, TWorkflowName>[];
-}>>;
-export type WorkflowWithUtilities<TBot extends commonTypes.BaseBot, TWorkflowName extends typeUtils.StringKeys<TBot['workflows']>> = Readonly<client.Workflow & {
+export type ActionableWorkflow<TBot extends commonTypes.BaseBot, TWorkflowName extends typeUtils.StringKeys<TBot['workflows']>> = Readonly<client.Workflow & {
     name: TWorkflowName;
     input: typeUtils.Cast<TBot['workflows'][TWorkflowName], commonTypes.IntegrationInstanceActionDefinition>['input'];
     output: Partial<typeUtils.Cast<TBot['workflows'][TWorkflowName], commonTypes.IntegrationInstanceActionDefinition>['output']>;
@@ -38,7 +40,7 @@ export type WorkflowWithUtilities<TBot extends commonTypes.BaseBot, TWorkflowNam
         tags?: typeUtils.AtLeastOneProperty<TBot['workflows'][TWorkflowName]['tags']>;
         output?: typeUtils.Cast<TBot['workflows'][TWorkflowName], commonTypes.IntegrationInstanceActionDefinition>['output'];
     }>): Promise<{
-        workflow: WorkflowWithUtilities<TBot, TWorkflowName>;
+        workflow: ActionableWorkflow<TBot, TWorkflowName>;
     }>;
     /**
      * Acknowledges the start of processing for a pending workflow instance.
@@ -53,13 +55,13 @@ export type WorkflowWithUtilities<TBot extends commonTypes.BaseBot, TWorkflowNam
      * retriggered 3 times before being marked as failed.
      */
     acknowledgeStartOfProcessing(): Promise<{
-        workflow: WorkflowWithUtilities<TBot, TWorkflowName>;
+        workflow: ActionableWorkflow<TBot, TWorkflowName>;
     }>;
     /**
      * Marks the current workflow instance as failed and stops execution
      */
     setFailed(x: Required<Pick<client.ClientInputs['updateWorkflow'], 'failureReason'>>): Promise<{
-        workflow: WorkflowWithUtilities<TBot, TWorkflowName>;
+        workflow: ActionableWorkflow<TBot, TWorkflowName>;
     }>;
     /**
      * Marks the current workflow instance as completed and stops execution
@@ -67,13 +69,12 @@ export type WorkflowWithUtilities<TBot extends commonTypes.BaseBot, TWorkflowNam
     setCompleted(x?: {
         output?: typeUtils.Cast<TBot['workflows'][TWorkflowName], commonTypes.IntegrationInstanceActionDefinition>['output'];
     }): Promise<{
-        workflow: WorkflowWithUtilities<TBot, TWorkflowName>;
+        workflow: ActionableWorkflow<TBot, TWorkflowName>;
     }>;
     /**
      * Discards all output data and cancels the current workflow instance
      */
     cancel(): Promise<{
-        workflow: WorkflowWithUtilities<TBot, TWorkflowName>;
+        workflow: ActionableWorkflow<TBot, TWorkflowName>;
     }>;
 }>;
-export {};

package/dist/common/index.d.ts

@@ -0,0 +1 @@
+export type * as commonTypes from './types';

package/dist/common/types.d.ts

@@ -0,0 +1,2 @@
+import * as typeUtils from '../utils/type-utils';
+export type ToTags<TTags extends string | number | symbol> = typeUtils.Cast<Partial<Record<TTags, string>>, Record<string, string>>;

package/dist/fixtures.d.ts

@@ -1,7 +1,8 @@
-import { DefaultBot } from './bot/common/generic';
-import { DefaultChannel, DefaultIntegration } from './integration/common/generic';
-import { DefaultPlugin } from './plugin/common/generic';
-type _FooBarBazIntegration = {
+import type { DefaultBot } from './bot/common/generic';
+import type { DefaultChannel, DefaultIntegration } from './integration/common/generic';
+import type { DefaultInterface } from './interface/common/generic';
+import type { DefaultPlugin } from './plugin/common/generic';
+export type FooBarBazIntegration = DefaultIntegration<{
     actions: {
         doFoo: {
             input: {
@@ -111,8 +112,8 @@ type _FooBarBazIntegration = {
             fooUserTag3: '';
         };
     };
-};
-type _TotoTutuTataInterface = {
+}>;
+export type TotoTutuTataInterface = DefaultInterface<{
     actions: {
         doToto: {
             input: {
@@ -150,12 +151,75 @@ type _TotoTutuTataInterface = {
             eventTata: boolean;
         };
     };
-};
-export type FooBarBazIntegration = DefaultIntegration<_FooBarBazIntegration>;
-export type TotoTutuTataIntegration = DefaultIntegration<_TotoTutuTataInterface>;
+    channels: {
+        channelFoo: DefaultChannel<{
+            messages: {
+                messageFoo: {
+                    foo: string;
+                };
+            };
+            message: {
+                tags: {
+                    fooMessageTag1: '';
+                    fooMessageTag2: '';
+                    fooMessageTag3: '';
+                };
+            };
+            conversation: {
+                tags: {
+                    fooConversationTag1: '';
+                    fooConversationTag2: '';
+                    fooConversationTag3: '';
+                };
+            };
+        }>;
+        channelBar: DefaultChannel<{
+            messages: {
+                messageBar: {
+                    bar: number;
+                };
+            };
+            message: {
+                tags: {
+                    barMessageTag1: '';
+                    barMessageTag2: '';
+                    barMessageTag3: '';
+                };
+            };
+            conversation: {
+                tags: {
+                    barConversationTag1: '';
+                    barConversationTag2: '';
+                    barConversationTag3: '';
+                };
+            };
+        }>;
+        channelBaz: DefaultChannel<{
+            messages: {
+                messageBaz: {
+                    baz: boolean;
+                };
+            };
+            message: {
+                tags: {
+                    bazMessageTag1: '';
+                    bazMessageTag2: '';
+                    bazMessageTag3: '';
+                };
+            };
+            conversation: {
+                tags: {
+                    bazConversationTag1: '';
+                    bazConversationTag2: '';
+                    bazConversationTag3: '';
+                };
+            };
+        }>;
+    };
+}>;
 export type FooBarBazBot = DefaultBot<{
     integrations: {
-        fooBarBaz: _FooBarBazIntegration;
+        fooBarBaz: FooBarBazIntegration;
     };
     actions: {
         act: {
@@ -202,10 +266,17 @@ export type FooBarBazBot = DefaultBot<{
 }>;
 export type FooBarBazPlugin = DefaultPlugin<{
     integrations: {
-        fooBarBaz: _FooBarBazIntegration;
+        fooBarBaz: FooBarBazIntegration;
     };
     interfaces: {
-        totoTutuTata: _TotoTutuTataInterface;
+        totoTutuTata: TotoTutuTataInterface;
+    };
+    message: {
+        tags: {
+            pluginMessageTag1: '';
+            pluginMessageTag2: '';
+            pluginMessageTag3: '';
+        };
     };
     actions: {
         act: {
@@ -280,7 +351,7 @@ export type EmptyBot = DefaultBot<{
 }>;
 export type EmptyPlugin = DefaultPlugin<{
     integrations: {};
+    interfaces: {};
     actions: {};
     events: {};
 }>;
-export {};