@narrative.io/data-collaboration-sdk-ts 3.7.0 → 4.0.0-beta.0

package/build/workflows/index.d.ts

@@ -1,7 +1,5 @@
 import { BaseApi } from "../base-api";
-import type { PaginationOptions } from "../types";
-type WorkflowPaginationOptions = PaginationOptions & Record<string, unknown>;
-import type { CreateWorkflowRequest, CreateWorkflowResponse, ListRunsParams, ListRunsResponse, ListWorkflowsResponse, ScheduleWorkflowRequest, ScheduleWorkflowResponse, TriggerWorkflowResponse, WorkflowResponse, WorkflowRun, WorkflowRunStatus, WorkflowStatus } from "./types";
+import type { CreateWorkflowRequest, CreateWorkflowResponse, ListRunsParams, ListRunsResponse, ListWorkflowsParams, ListWorkflowsResponse, ScheduleWorkflowRequest, ScheduleWorkflowResponse, TriggerWorkflowResponse, WorkflowResponse, WorkflowRun, WorkflowRunStatus, WorkflowStatus } from "./types";
 /**
  * @module WorkflowsApi
  * @description This module provides methods for creating, scheduling, triggering, and archiving workflows.
@@ -11,10 +9,11 @@ declare 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.
      */
-    listWorkflows(params?: WorkflowPaginationOptions): Promise<ListWorkflowsResponse>;
+    listWorkflows(params?: ListWorkflowsParams): Promise<ListWorkflowsResponse>;
     /**
      * Create a new workflow from a YAML specification.
      * The specification is parsed and validated before the workflow is persisted.
@@ -58,9 +57,9 @@ declare 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.
      */
     listWorkflowRuns(workflowId: string, params?: ListRunsParams): Promise<ListRunsResponse>;
 }
-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, };
+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

@@ -9,7 +9,8 @@ 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) {
@@ -68,7 +69,7 @@ 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) {

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;
@@ -49,6 +54,12 @@ export interface ListRunsResponse {
     next_page_token?: string | null;
 }
 export interface ListRunsParams extends Record<string, unknown> {
-    pageSize?: number;
-    pageToken?: string;
+    /** 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;
+}
+export interface ListWorkflowsParams extends PaginationOptions, Record<string, unknown> {
+    /** 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.7.0",
+	"version": "4.0.0-beta.0",
 	"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": {