@narrative.io/data-collaboration-sdk-ts 3.8.0 → 4.0.0-beta.1

package/build/workflows/index.js

@@ -9,11 +9,15 @@ class WorkflowsApi extends BaseApi {
     /**
      * List all active workflows for the authenticated company.
      *
-     * @param {PaginationOptions} [params] - Optional pagination parameters.
+     * @param {ListWorkflowsParams} [params] - Optional pagination parameters, plus
+     * `data_plane_id` to return only the workflows on that data plane.
      * @returns {Promise<ListWorkflowsResponse>} A promise that resolves to a paginated list of workflows.
      */
     async listWorkflows(params) {
-        return await this.get(resourceName, params);
+        // Spread so the argument is an anonymous object type rather than an
+        // interface: only the former satisfies `get`'s index-signature constraint.
+        // See {@link ListRunsParams} on why these params carry no index signature.
+        return await this.get(resourceName, params && { ...params });
     }
     /**
      * Create a new workflow from a YAML specification.
@@ -68,11 +72,12 @@ class WorkflowsApi extends BaseApi {
      * List execution runs for a workflow. Results are ordered by start time descending.
      *
      * @param {string} workflowId - The unique identifier for the workflow.
-     * @param {ListRunsParams} [params] - Optional pagination parameters (pageSize, pageToken).
+     * @param {ListRunsParams} [params] - Optional pagination parameters (per_page, page_token).
      * @returns {Promise<ListRunsResponse>} A promise that resolves to a paginated list of workflow runs.
      */
     async listWorkflowRuns(workflowId, params) {
-        return await this.get(`${resourceName}/${workflowId}/runs`, params);
+        // See the spread in `listWorkflows`.
+        return await this.get(`${resourceName}/${workflowId}/runs`, params && { ...params });
     }
 }
 export { WorkflowsApi, };

package/build/workflows/types.d.ts

@@ -1,3 +1,4 @@
+import type { PaginationOptions } from "../types";
 export type WorkflowStatus = "active" | "archived";
 export type WorkflowRunStatus = "running" | "completed" | "failed" | "canceled" | "terminated" | "unknown";
 export interface WorkflowResponse {
@@ -10,13 +11,17 @@ export interface WorkflowResponse {
     created_by: number;
     updated_at: string;
     status: WorkflowStatus;
-    archived_at?: string | null;
+    archived_at: string | null;
+    /** Tags that describe the workflow. */
+    tags: string[];
 }
 export interface CreateWorkflowRequest {
     specification: string;
     data_plane_id: string;
     trigger_immediately?: boolean | null;
     schedule_immediately?: boolean | null;
+    /** Tags that describe the workflow. Defaults to an empty list. */
+    tags?: string[];
 }
 export interface CreateWorkflowResponse extends WorkflowResponse {
     run_id?: string | null;
@@ -48,7 +53,21 @@ export interface ListRunsResponse {
     runs: WorkflowRun[];
     next_page_token?: string | null;
 }
-export interface ListRunsParams extends Record<string, unknown> {
-    pageSize?: number;
-    pageToken?: string;
+/**
+ * Query parameters for `GET /workflows/{id}/runs`.
+ *
+ * Deliberately has no index signature: an index signature would silently accept
+ * misspelled or legacy parameter names (e.g. `pageSize`/`pageToken`), which the
+ * server ignores — the request succeeds and pagination just never advances.
+ */
+export interface ListRunsParams {
+    /** Maximum number of runs to return per page (`per_page` query param). Defaults to 10. */
+    per_page?: number;
+    /** Opaque token from a previous response (`page_token` query param). */
+    page_token?: string;
+}
+/** Query parameters for `GET /workflows`. See {@link ListRunsParams} on why there's no index signature. */
+export interface ListWorkflowsParams extends PaginationOptions {
+    /** Narrow results to workflows on this data plane. */
+    data_plane_id?: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@narrative.io/data-collaboration-sdk-ts",
-	"version": "3.8.0",
+	"version": "4.0.0-beta.1",
 	"main": "build/index.js",
 	"repository": "github:narrative-io/data-collaboration-sdk-ts",
 	"source": "src/index.ts",
@@ -30,7 +30,7 @@
 		"@babel/core": "8.0.1",
 		"@babel/preset-env": "8.0.2",
 		"@babel/preset-typescript": "8.0.1",
-		"@biomejs/biome": "2.5.4",
+		"@biomejs/biome": "2.5.5",
 		"@commitlint/cli": "21.2.1",
 		"@commitlint/config-conventional": "21.2.0",
 		"@types/jest": "30.0.0",
@@ -38,7 +38,7 @@
 		"babel-jest": "30.4.1",
 		"jest": "30.4.2",
 		"lefthook": "2.1.10",
-		"ts-jest": "29.4.11",
+		"ts-jest": "29.4.12",
 		"typescript": "6.0.0-dev.20260416"
 	},
 	"dependencies": {