@botpress/sdk 4.15.9 → 4.15.11

package/.turbo/turbo-build.log

@@ -1,20 +1,20 @@
 
-> @botpress/sdk@4.15.9 build /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.15.11 build /home/runner/work/botpress/botpress/packages/sdk
 > pnpm build:type && pnpm build:node && pnpm build:browser
 
 
-> @botpress/sdk@4.15.9 build:type /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.15.11 build:type /home/runner/work/botpress/botpress/packages/sdk
 > tsc -p ./tsconfig.package.json --emitDeclarationOnly --declaration
 
 
-> @botpress/sdk@4.15.9 build:node /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.15.11 build:node /home/runner/work/botpress/botpress/packages/sdk
 > ts-node -T ./build.ts --node
 
 Done
 
-> @botpress/sdk@4.15.9 build:browser /home/runner/work/botpress/botpress/packages/sdk
+> @botpress/sdk@4.15.11 build:browser /home/runner/work/botpress/botpress/packages/sdk
 > ts-node -T ./build.ts --browser
 
-(node:3750) [DEP0180] DeprecationWarning: fs.Stats constructor is deprecated.
+(node:3706) [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

@@ -111,6 +111,9 @@ export type BotDefinitionProps<TStates extends BaseStates = BaseStates, TEvents
         [K in keyof TWorkflows]: WorkflowDefinition<TWorkflows[K]>;
     };
     attributes?: Record<string, string>;
+    __advanced?: {
+        useLegacyZuiTransformer?: boolean;
+    };
 };
 export declare class BotDefinition<TStates extends BaseStates = BaseStates, TEvents extends BaseEvents = BaseEvents, TActions extends BaseActions = BaseActions, TTables extends BaseTables = BaseTables, TWorkflows extends BaseWorkflows = BaseWorkflows> {
     readonly props: BotDefinitionProps<TStates, TEvents, TActions, TTables, TWorkflows>;
@@ -127,6 +130,7 @@ export declare class BotDefinition<TStates extends BaseStates = BaseStates, TEve
     readonly tables: this['props']['tables'];
     readonly workflows: this['props']['workflows'];
     readonly attributes: this['props']['attributes'];
+    readonly __advanced: this['props']['__advanced'];
     /** Bot definition with plugins merged into it */
     readonly withPlugins: Pick<this['props'], 'user' | 'conversation' | 'message' | 'states' | 'events' | 'recurringEvents' | 'actions' | 'tables' | 'workflows'>;
     constructor(props: BotDefinitionProps<TStates, TEvents, TActions, TTables, TWorkflows>);

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

@@ -2,9 +2,12 @@ import type * as client from '@botpress/client';
 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>;
 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>;

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

@@ -40,6 +40,21 @@ export type WorkflowWithUtilities<TBot extends commonTypes.BaseBot, TWorkflowNam
     }>): Promise<{
         workflow: WorkflowWithUtilities<TBot, TWorkflowName>;
     }>;
+    /**
+     * Acknowledges the start of processing for a pending workflow instance.
+     * If the workflow is not in pending status or has already been
+     * acknowledged, this is a no-op.
+     *
+     * This method **should be called in every workflow handler** as soon as the
+     * workflow **starts doing work**. If no work needs to be done, setCompleted
+     * or setFailed should be called instead.
+     *
+     * Should a workflow not be acknowledged **in a timely fashion**, it will be
+     * retriggered 3 times before being marked as failed.
+     */
+    acknowledgeStartOfProcessing(): Promise<{
+        workflow: WorkflowWithUtilities<TBot, TWorkflowName>;
+    }>;
     /**
      * Marks the current workflow instance as failed and stops execution
      */