@botpress/sdk 4.15.9 → 4.15.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,20 +1,20 @@
1
1
 
2
- > @botpress/sdk@4.15.9 build /home/runner/work/botpress/botpress/packages/sdk
2
+ > @botpress/sdk@4.15.10 build /home/runner/work/botpress/botpress/packages/sdk
3
3
  > pnpm build:type && pnpm build:node && pnpm build:browser
4
4
 
5
5
 
6
- > @botpress/sdk@4.15.9 build:type /home/runner/work/botpress/botpress/packages/sdk
6
+ > @botpress/sdk@4.15.10 build:type /home/runner/work/botpress/botpress/packages/sdk
7
7
  > tsc -p ./tsconfig.package.json --emitDeclarationOnly --declaration
8
8
 
9
9
 
10
- > @botpress/sdk@4.15.9 build:node /home/runner/work/botpress/botpress/packages/sdk
10
+ > @botpress/sdk@4.15.10 build:node /home/runner/work/botpress/botpress/packages/sdk
11
11
  > ts-node -T ./build.ts --node
12
12
 
13
13
  Done
14
14
 
15
- > @botpress/sdk@4.15.9 build:browser /home/runner/work/botpress/botpress/packages/sdk
15
+ > @botpress/sdk@4.15.10 build:browser /home/runner/work/botpress/botpress/packages/sdk
16
16
  > ts-node -T ./build.ts --browser
17
17
 
18
- (node:3750) [DEP0180] DeprecationWarning: fs.Stats constructor is deprecated.
18
+ (node:3724) [DEP0180] DeprecationWarning: fs.Stats constructor is deprecated.
19
19
  (Use `node --trace-deprecation ...` to show where the warning was created)
20
20
  Done
@@ -2,9 +2,11 @@ import type * as client from '@botpress/client';
2
2
  import type { BotSpecificClient } from '../../bot';
3
3
  import type * as typeUtils from '../../utils/type-utils';
4
4
  import type { BaseBot } from '../common';
5
+ import * as botServerTypes from '../server/types';
5
6
  import type { WorkflowProxy, WorkflowWithUtilities } from './types';
6
7
  export declare const proxyWorkflows: <TBot extends BaseBot>(client: BotSpecificClient<TBot> | client.Client) => WorkflowProxy<TBot>;
7
8
  export declare const wrapWorkflowInstance: <TBot extends BaseBot, TWorkflowName extends typeUtils.StringKeys<TBot["workflows"]>>(props: {
8
9
  client: BotSpecificClient<TBot> | client.Client;
9
10
  workflow: client.Workflow;
11
+ event?: botServerTypes.WorkflowUpdateEvent;
10
12
  }) => WorkflowWithUtilities<TBot, TWorkflowName>;
@@ -40,6 +40,19 @@ export type WorkflowWithUtilities<TBot extends commonTypes.BaseBot, TWorkflowNam
40
40
  }>): Promise<{
41
41
  workflow: WorkflowWithUtilities<TBot, TWorkflowName>;
42
42
  }>;
43
+ /**
44
+ * Acknowledges the start of processing for a pending workflow instance.
45
+ * If the workflow is not in pending status or has already been
46
+ * acknowledged, this is a no-op.
47
+ *
48
+ * This method **should be called in every workflow handler** as soon as the
49
+ * workflow **starts doing work**. If no work needs to be done, setCompleted
50
+ * or setFailed should be called instead.
51
+ *
52
+ * Should a workflow not be acknowledged **in a timely fashion**, it will be
53
+ * retriggered 3 times before being marked as failed.
54
+ */
55
+ acknowledgeStartOfProcessing(): Promise<void>;
43
56
  /**
44
57
  * Marks the current workflow instance as failed and stops execution
45
58
  */