@narrative.io/data-collaboration-sdk-ts 3.8.0 → 3.9.0
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,7 +1,5 @@
|
|
|
1
1
|
import { BaseApi } from "../base-api";
|
|
2
|
-
import type {
|
|
3
|
-
type WorkflowPaginationOptions = PaginationOptions & Record<string, unknown>;
|
|
4
|
-
import type { CreateWorkflowRequest, CreateWorkflowResponse, ListRunsParams, ListRunsResponse, ListWorkflowsResponse, ScheduleWorkflowRequest, ScheduleWorkflowResponse, TriggerWorkflowResponse, WorkflowResponse, WorkflowRun, WorkflowRunStatus, WorkflowStatus } from "./types";
|
|
2
|
+
import type { CreateWorkflowRequest, CreateWorkflowResponse, ListRunsParams, ListRunsResponse, ListWorkflowsParams, ListWorkflowsResponse, ScheduleWorkflowRequest, ScheduleWorkflowResponse, TriggerWorkflowResponse, WorkflowResponse, WorkflowRun, WorkflowRunStatus, WorkflowStatus } from "./types";
|
|
5
3
|
/**
|
|
6
4
|
* @module WorkflowsApi
|
|
7
5
|
* @description This module provides methods for creating, scheduling, triggering, and archiving workflows.
|
|
@@ -11,10 +9,11 @@ declare class WorkflowsApi extends BaseApi {
|
|
|
11
9
|
/**
|
|
12
10
|
* List all active workflows for the authenticated company.
|
|
13
11
|
*
|
|
14
|
-
* @param {
|
|
12
|
+
* @param {ListWorkflowsParams} [params] - Optional pagination parameters, plus
|
|
13
|
+
* `data_plane_id` to return only the workflows on that data plane.
|
|
15
14
|
* @returns {Promise<ListWorkflowsResponse>} A promise that resolves to a paginated list of workflows.
|
|
16
15
|
*/
|
|
17
|
-
listWorkflows(params?:
|
|
16
|
+
listWorkflows(params?: ListWorkflowsParams): Promise<ListWorkflowsResponse>;
|
|
18
17
|
/**
|
|
19
18
|
* Create a new workflow from a YAML specification.
|
|
20
19
|
* The specification is parsed and validated before the workflow is persisted.
|
|
@@ -63,4 +62,4 @@ declare class WorkflowsApi extends BaseApi {
|
|
|
63
62
|
*/
|
|
64
63
|
listWorkflowRuns(workflowId: string, params?: ListRunsParams): Promise<ListRunsResponse>;
|
|
65
64
|
}
|
|
66
|
-
export { type CreateWorkflowRequest, type CreateWorkflowResponse, type ListRunsParams, type ListRunsResponse, type ListWorkflowsResponse, type ScheduleWorkflowRequest, type ScheduleWorkflowResponse, type TriggerWorkflowResponse, type WorkflowResponse, type WorkflowRun, type WorkflowRunStatus, type WorkflowStatus, WorkflowsApi, };
|
|
65
|
+
export { type CreateWorkflowRequest, type CreateWorkflowResponse, type ListRunsParams, type ListRunsResponse, type ListWorkflowsParams, type ListWorkflowsResponse, type ScheduleWorkflowRequest, type ScheduleWorkflowResponse, type TriggerWorkflowResponse, type WorkflowResponse, type WorkflowRun, type WorkflowRunStatus, type WorkflowStatus, WorkflowsApi, };
|
package/build/workflows/index.js
CHANGED
|
@@ -9,7 +9,8 @@ class WorkflowsApi extends BaseApi {
|
|
|
9
9
|
/**
|
|
10
10
|
* List all active workflows for the authenticated company.
|
|
11
11
|
*
|
|
12
|
-
* @param {
|
|
12
|
+
* @param {ListWorkflowsParams} [params] - Optional pagination parameters, plus
|
|
13
|
+
* `data_plane_id` to return only the workflows on that data plane.
|
|
13
14
|
* @returns {Promise<ListWorkflowsResponse>} A promise that resolves to a paginated list of workflows.
|
|
14
15
|
*/
|
|
15
16
|
async listWorkflows(params) {
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { PaginationOptions } from "../types";
|
|
1
2
|
export type WorkflowStatus = "active" | "archived";
|
|
2
3
|
export type WorkflowRunStatus = "running" | "completed" | "failed" | "canceled" | "terminated" | "unknown";
|
|
3
4
|
export interface WorkflowResponse {
|
|
@@ -52,3 +53,7 @@ export interface ListRunsParams extends Record<string, unknown> {
|
|
|
52
53
|
pageSize?: number;
|
|
53
54
|
pageToken?: string;
|
|
54
55
|
}
|
|
56
|
+
export interface ListWorkflowsParams extends PaginationOptions, Record<string, unknown> {
|
|
57
|
+
/** Narrow results to workflows on this data plane. */
|
|
58
|
+
data_plane_id?: string;
|
|
59
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@narrative.io/data-collaboration-sdk-ts",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.9.0",
|
|
4
4
|
"main": "build/index.js",
|
|
5
5
|
"repository": "github:narrative-io/data-collaboration-sdk-ts",
|
|
6
6
|
"source": "src/index.ts",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"@babel/core": "8.0.1",
|
|
31
31
|
"@babel/preset-env": "8.0.2",
|
|
32
32
|
"@babel/preset-typescript": "8.0.1",
|
|
33
|
-
"@biomejs/biome": "2.5.
|
|
33
|
+
"@biomejs/biome": "2.5.5",
|
|
34
34
|
"@commitlint/cli": "21.2.1",
|
|
35
35
|
"@commitlint/config-conventional": "21.2.0",
|
|
36
36
|
"@types/jest": "30.0.0",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"babel-jest": "30.4.1",
|
|
39
39
|
"jest": "30.4.2",
|
|
40
40
|
"lefthook": "2.1.10",
|
|
41
|
-
"ts-jest": "29.4.
|
|
41
|
+
"ts-jest": "29.4.12",
|
|
42
42
|
"typescript": "6.0.0-dev.20260416"
|
|
43
43
|
},
|
|
44
44
|
"dependencies": {
|