@mastra/client-js 1.0.0-beta.15 → 1.0.0-beta.16
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.
- package/CHANGELOG.md +9 -0
- package/dist/index.cjs +67 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +67 -0
- package/dist/index.js.map +1 -1
- package/dist/resources/run.d.ts +65 -0
- package/dist/resources/run.d.ts.map +1 -1
- package/package.json +4 -4
package/dist/resources/run.d.ts
CHANGED
|
@@ -13,10 +13,75 @@ export declare class Run extends BaseResource {
|
|
|
13
13
|
/**
|
|
14
14
|
* Cancels a specific workflow run by its ID
|
|
15
15
|
* @returns Promise containing a success message
|
|
16
|
+
* @deprecated Use `cancel()` instead
|
|
16
17
|
*/
|
|
17
18
|
cancelRun(): Promise<{
|
|
18
19
|
message: string;
|
|
19
20
|
}>;
|
|
21
|
+
/**
|
|
22
|
+
* Cancels a workflow run.
|
|
23
|
+
*
|
|
24
|
+
* This method aborts any running steps and updates the workflow status to 'canceled' .
|
|
25
|
+
* It works for both actively running workflows and suspended/waiting workflows.
|
|
26
|
+
*
|
|
27
|
+
* ## How cancellation works
|
|
28
|
+
*
|
|
29
|
+
* When called, the workflow will:
|
|
30
|
+
* 1. **Trigger the abort signal** - Uses the standard Web API AbortSignal to notify running steps
|
|
31
|
+
* 2. **Prevent subsequent steps** - No further steps will be executed
|
|
32
|
+
*
|
|
33
|
+
* ## Abort signal behavior
|
|
34
|
+
*
|
|
35
|
+
* Steps that check the `abortSignal` parameter can respond to cancellation:
|
|
36
|
+
* - Steps can listen to the 'abort' event: `abortSignal.addEventListener('abort', callback)`
|
|
37
|
+
* - Steps can check if already aborted: `if (abortSignal.aborted) { ... }`
|
|
38
|
+
* - Useful for canceling timeouts, network requests, or long-running operations
|
|
39
|
+
*
|
|
40
|
+
* **Note:** Steps must actively check the abort signal to be canceled mid-execution.
|
|
41
|
+
* Steps that don't check the signal will run to completion, but subsequent steps won't execute.
|
|
42
|
+
*
|
|
43
|
+
* @returns Promise that resolves with `{ message: 'Workflow run canceled' }` when cancellation succeeds
|
|
44
|
+
* @throws {HTTPException} 400 - If workflow ID or run ID is missing
|
|
45
|
+
* @throws {HTTPException} 404 - If workflow or workflow run is not found
|
|
46
|
+
*
|
|
47
|
+
* @example
|
|
48
|
+
* ```typescript
|
|
49
|
+
* const run = await workflow.createRun({ runId: 'run-123' });
|
|
50
|
+
* await run.cancel();
|
|
51
|
+
* // Returns: { message: 'Workflow run canceled' }
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @example
|
|
55
|
+
* ```typescript
|
|
56
|
+
* // Example of a step that responds to cancellation
|
|
57
|
+
* const step = createStep({
|
|
58
|
+
* id: 'long-running-step',
|
|
59
|
+
* execute: async ({ inputData, abortSignal, abort }) => {
|
|
60
|
+
* const timeout = new Promise((resolve) => {
|
|
61
|
+
* const timer = setTimeout(() => resolve('done'), 10000);
|
|
62
|
+
*
|
|
63
|
+
* // Clean up if canceled
|
|
64
|
+
* abortSignal.addEventListener('abort', () => {
|
|
65
|
+
* clearTimeout(timer);
|
|
66
|
+
* resolve('canceled');
|
|
67
|
+
* });
|
|
68
|
+
* });
|
|
69
|
+
*
|
|
70
|
+
* const result = await timeout;
|
|
71
|
+
*
|
|
72
|
+
* // Check if aborted after async operation
|
|
73
|
+
* if (abortSignal.aborted) {
|
|
74
|
+
* return abort(); // Stop execution
|
|
75
|
+
* }
|
|
76
|
+
*
|
|
77
|
+
* return { result };
|
|
78
|
+
* }
|
|
79
|
+
* });
|
|
80
|
+
* ```
|
|
81
|
+
*/
|
|
82
|
+
cancel(): Promise<{
|
|
83
|
+
message: string;
|
|
84
|
+
}>;
|
|
20
85
|
/**
|
|
21
86
|
* Starts a workflow run synchronously without waiting for the workflow to complete
|
|
22
87
|
* @param params - Object containing the inputData, initialState and requestContext
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/resources/run.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAGzG,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAkBtC,qBAAa,GAAI,SAAQ,YAAY;IAGjC,OAAO,CAAC,UAAU;aACF,KAAK,EAAE,MAAM;gBAF7B,OAAO,EAAE,aAAa,EACd,UAAU,EAAE,MAAM,EACV,KAAK,EAAE,MAAM;IAK/B;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAkClC
|
|
1
|
+
{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/resources/run.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAGzG,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAkBtC,qBAAa,GAAI,SAAQ,YAAY;IAGjC,OAAO,CAAC,UAAU;aACF,KAAK,EAAE,MAAM;gBAF7B,OAAO,EAAE,aAAa,EACd,UAAU,EAAE,MAAM,EACV,KAAK,EAAE,MAAM;IAK/B;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAkClC;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAMzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;IACH,MAAM,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAMtC;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE;QACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAchC;;;;OAIG;IACH,MAAM,CAAC,EACL,IAAI,EACJ,UAAU,EACV,cAAc,EACd,OAAO,EACP,GAAG,IAAI,EACR,EAAE;QACD,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAchC;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAoB9B;;;;OAIG;IACG,MAAM,CAAC,MAAM,EAAE;QACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;IAkCD;;;OAGG;IACG,aAAa;IAuBnB;;;;OAIG;IACG,WAAW,CAAC,MAAM,EAAE;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAChC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACnC,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;IAmCD;;;OAGG;IACG,kBAAkB;IAwBxB;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE;QAClB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAc9B;;;;OAIG;IACG,iBAAiB,CAAC,MAAM,EAAE;QAC9B,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;QAChC,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;IA+BD;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE;QACd,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;KACjC,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAWhC;;;;OAIG;IACH,YAAY,CAAC,MAAM,CAAC,EAAE;QACpB,cAAc,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACtD,cAAc,CAAC,EAAE,cAAc,CAAC;KACjC,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAW9B;;;;OAIG;IACH,UAAU,CAAC,EAAE,cAAc,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,EAAE,gBAAgB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAW/G;;;;OAIG;IACH,eAAe,CAAC,EAAE,cAAc,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,EAAE,gBAAgB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAWlH;;;;OAIG;IACG,gBAAgB,CAAC,EAAE,cAAc,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,EAAE,gBAAgB;CAyB7F"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mastra/client-js",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.16",
|
|
4
4
|
"description": "The official TypeScript library for the Mastra Client API",
|
|
5
5
|
"author": "",
|
|
6
6
|
"type": "module",
|
|
@@ -36,8 +36,8 @@
|
|
|
36
36
|
"dependencies": {
|
|
37
37
|
"@lukeed/uuid": "^2.0.1",
|
|
38
38
|
"json-schema": "^0.4.0",
|
|
39
|
-
"@mastra/
|
|
40
|
-
"@mastra/
|
|
39
|
+
"@mastra/core": "1.0.0-beta.16",
|
|
40
|
+
"@mastra/schema-compat": "1.0.0-beta.3"
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|
|
43
43
|
"zod": "^3.25.0 || ^4.0.0"
|
|
@@ -53,9 +53,9 @@
|
|
|
53
53
|
"typescript": "^5.8.3",
|
|
54
54
|
"vitest": "4.0.12",
|
|
55
55
|
"zod": "^3.25.76",
|
|
56
|
-
"@internal/lint": "0.0.53",
|
|
57
56
|
"@internal/ai-sdk-v4": "0.0.0",
|
|
58
57
|
"@internal/types-builder": "0.0.28",
|
|
58
|
+
"@internal/lint": "0.0.53",
|
|
59
59
|
"@internal/ai-sdk-v5": "0.0.0"
|
|
60
60
|
},
|
|
61
61
|
"engines": {
|