@narrative.io/data-collaboration-sdk-ts 2.93.0 → 2.94.1

package/build/compute-pools/index.d.ts

@@ -0,0 +1,10 @@
+import { BaseApi } from "../base-api";
+import type { ComputePoolResponse, CreateComputePoolRequest, ListComputePoolsParams, ListComputePoolsResponse, UpdateComputePoolRequest } from "./types";
+export declare class ComputePoolsApi extends BaseApi {
+    private computePoolsResourcePath;
+    listComputePools(dataPlaneId: string, params?: ListComputePoolsParams): Promise<ListComputePoolsResponse>;
+    createComputePool(dataPlaneId: string, request: CreateComputePoolRequest): Promise<ComputePoolResponse>;
+    getComputePool(dataPlaneId: string, computePoolId: string): Promise<ComputePoolResponse>;
+    updateComputePool(dataPlaneId: string, computePoolId: string, request: UpdateComputePoolRequest): Promise<ComputePoolResponse>;
+    archiveComputePool(dataPlaneId: string, computePoolId: string): Promise<void>;
+}

package/build/compute-pools/index.js

@@ -0,0 +1,21 @@
+import { BaseApi } from "../base-api";
+export class ComputePoolsApi extends BaseApi {
+    computePoolsResourcePath(dataPlaneId) {
+        return `data-planes/${dataPlaneId}/compute-pools`;
+    }
+    async listComputePools(dataPlaneId, params) {
+        return await this.get(this.computePoolsResourcePath(dataPlaneId), params);
+    }
+    async createComputePool(dataPlaneId, request) {
+        return await this.post(this.computePoolsResourcePath(dataPlaneId), request);
+    }
+    async getComputePool(dataPlaneId, computePoolId) {
+        return await this.get(`${this.computePoolsResourcePath(dataPlaneId)}/${computePoolId}`);
+    }
+    async updateComputePool(dataPlaneId, computePoolId, request) {
+        return await this.put(`${this.computePoolsResourcePath(dataPlaneId)}/${computePoolId}`, request);
+    }
+    async archiveComputePool(dataPlaneId, computePoolId) {
+        await this.delete(`${this.computePoolsResourcePath(dataPlaneId)}/${computePoolId}`);
+    }
+}

package/build/compute-pools/types.d.ts

@@ -0,0 +1,97 @@
+export type ComputePoolType = "owned" | "shared";
+export type ComputePoolStatus = "active" | "archived";
+export type SnowflakeWarehouseSize = "x-small" | "small" | "medium" | "large" | "x-large" | "2x-large" | "3x-large" | "4x-large" | "5x-large" | "6x-large";
+export type SnowflakeWarehouseType = "standard" | "snowpark_optimized";
+export type ScalingPolicy = "standard" | "economy";
+export interface SnowflakeWarehouseExternalId {
+    type: "snowflake_warehouse";
+    name: string;
+    alias: string;
+}
+export type ComputePoolExternalId = SnowflakeWarehouseExternalId;
+export interface SnowflakeWarehouseProvider {
+    type: "snowflake_warehouse";
+    size?: SnowflakeWarehouseSize;
+    warehouse_type?: SnowflakeWarehouseType;
+    auto_suspend?: number;
+    auto_resume?: boolean;
+    min_cluster_count?: number;
+    max_cluster_count?: number;
+    scaling_policy?: ScalingPolicy;
+    max_concurrency_level?: number;
+    statement_timeout_in_seconds?: number;
+    statement_queued_timeout_in_seconds?: number;
+    enable_query_acceleration?: boolean;
+    query_acceleration_max_scale_factor?: number;
+    resource_constraint?: string;
+    comment?: string;
+}
+export type ComputePoolProvider = SnowflakeWarehouseProvider;
+export interface ParticipantsAll {
+    type: "all";
+}
+export interface ParticipantsNone {
+    type: "none";
+}
+export interface ParticipantsInclusion {
+    type: "inclusion";
+    company_ids: number[];
+}
+export type Participants = ParticipantsAll | ParticipantsNone | ParticipantsInclusion;
+export interface ComputePoolCollaborators {
+    use: Participants;
+}
+export interface ComputePoolOwnedResponse {
+    type: "owned";
+    id: string;
+    company_id: number;
+    data_plane_id: string;
+    external_id: ComputePoolExternalId;
+    name: string;
+    display_name: string;
+    description?: string;
+    status: ComputePoolStatus;
+    created_at: string;
+    updated_at?: string;
+    tags: string[];
+    provider: ComputePoolProvider;
+    collaborators: ComputePoolCollaborators;
+}
+export interface ComputePoolSharedResponse {
+    type: "shared";
+    id: string;
+    company_id: number;
+    data_plane_id: string;
+    external_id: ComputePoolExternalId;
+    name: string;
+    display_name: string;
+    description?: string;
+    status: ComputePoolStatus;
+    created_at: string;
+    updated_at?: string;
+    tags: string[];
+    provider: ComputePoolProvider;
+}
+export type ComputePoolResponse = ComputePoolOwnedResponse | ComputePoolSharedResponse;
+export interface CreateComputePoolRequest {
+    external_id: ComputePoolExternalId;
+    name: string;
+    display_name: string;
+    description?: string;
+    tags?: string[];
+    collaborators?: ComputePoolCollaborators;
+    provider: ComputePoolProvider;
+}
+export interface UpdateComputePoolRequest {
+    display_name?: string;
+    description?: string;
+    tags?: string[];
+    provider?: ComputePoolProvider;
+    collaborators?: ComputePoolCollaborators;
+}
+export interface ListComputePoolsResponse {
+    records: ComputePoolResponse[];
+}
+export type ListComputePoolsParams = {
+    status?: ComputePoolStatus;
+} & Record<string, unknown>;

package/build/compute-pools/types.js

@@ -0,0 +1 @@
+export {};

package/build/data-planes/index.d.ts

@@ -4,4 +4,6 @@ import type { DataPlane } from "./types";
 export declare class DataPlaneApi extends BaseApi {
     getDataPlanes(): Promise<ApiRecords<DataPlane>>;
     getDataPlane(dataPlaneId: string): Promise<DataPlane>;
+    setDefaultComputePool(dataPlaneId: string, computePoolId: string): Promise<DataPlane>;
+    clearDefaultComputePool(dataPlaneId: string): Promise<void>;
 }

package/build/data-planes/index.js

@@ -7,4 +7,10 @@ export class DataPlaneApi extends BaseApi {
     async getDataPlane(dataPlaneId) {
         return await this.get(`${resourceName}/${dataPlaneId}`);
     }
+    async setDefaultComputePool(dataPlaneId, computePoolId) {
+        return await this.put(`${resourceName}/${dataPlaneId}/default-compute-pool/${computePoolId}`, undefined);
+    }
+    async clearDefaultComputePool(dataPlaneId) {
+        await this.delete(`${resourceName}/${dataPlaneId}/default-compute-pool`);
+    }
 }

package/build/data-planes/types.d.ts

@@ -1,6 +1,7 @@
+import type { ComputePoolResponse, Participants } from "../compute-pools/types";
 export type DataPlaneType = "owned" | "shared";
-export type DataPlaneStatus = "active" | "inactive";
-export type DataPlanePlatformType = "platform_snowflake" | "platform_aws" | "platform_shared_aws";
+export type DataPlaneStatus = "active" | "inactive" | "archived";
+export type DataPlanePlatformType = "platform_snowflake" | "platform_shared_snowflake" | "platform_aws" | "platform_shared_aws";
 export type DataPlaneRegionType = "region_aws";
 export interface DataPlanePlatformRegion {
     type: DataPlaneRegionType;
@@ -13,6 +14,9 @@ export interface DataPlanePlatform {
     organization_name: string;
     region: DataPlanePlatformRegion;
 }
+export interface DataPlaneCollaborators {
+    use: Participants;
+}
 export interface DataPlane {
     type: DataPlaneType;
     id: string;
@@ -23,4 +27,10 @@ export interface DataPlane {
     platform: DataPlanePlatform;
     status: DataPlaneStatus;
     updated_at: string;
+    description?: string;
+    tags?: string[];
+    last_heartbeat_at?: string;
+    default_compute_pool_id?: string;
+    compute_pools?: ComputePoolResponse[];
+    collaborators?: DataPlaneCollaborators;
 }

package/build/index.d.ts

@@ -7,6 +7,8 @@ export * from "./authentication";
 export * from "./base-api";
 export * from "./collaboration-policy";
 export * from "./company-info";
+export * from "./compute-pools";
+export * from "./compute-pools/types";
 export * from "./connections";
 export * from "./contracts";
 export * from "./data-planes";
@@ -48,6 +50,8 @@ export { applyMixins } from "./utils";
 export * from "./views";
 export * from "./whoami";
 export * from "./whoami/types";
+export * from "./workflows";
+export * from "./workflows/types";
 import { AccessRulesApi } from "./access-rules/";
 import { AccessTokensApi } from "./access-tokens";
 import { AppsApi } from "./apps";
@@ -55,6 +59,7 @@ import { AttributeApi, AttributeApiV2 } from "./attributes";
 import { AuthenticationApi } from "./authentication";
 import { BaseApi } from "./base-api";
 import { CompanyInfoApi } from "./company-info";
+import { ComputePoolsApi } from "./compute-pools";
 import { ConnectionsApi } from "./connections";
 import { ContractsApi } from "./contracts";
 import { DataPlaneApi } from "./data-planes";
@@ -78,8 +83,9 @@ import { SubscriptionsApi } from "./subscriptions";
 import { UploadsApi } from "./uploads";
 import { ViewsApi } from "./views";
 import { WhoAmIApi } from "./whoami";
+import { WorkflowsApi } from "./workflows";
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, AttributeApiV2, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelsApi, ModelTrainingApi, ModelInferenceApi, EncryptionMaterialApi, WhoAmIApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, AccessTokensApi, DataPlaneApi, DatasetApi, RosettaStoneApi, AttributeApi, AttributeApiV2, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, QueriesApi, ViewsApi, ModelsApi, ModelTrainingApi, ModelInferenceApi, EncryptionMaterialApi, WhoAmIApi, WorkflowsApi, ComputePoolsApi {
 }
 export { NarrativeApi };

package/build/index.js

@@ -7,6 +7,8 @@ export * from "./authentication";
 export * from "./base-api";
 export * from "./collaboration-policy";
 export * from "./company-info";
+export * from "./compute-pools";
+export * from "./compute-pools/types";
 export * from "./connections";
 export * from "./contracts";
 export * from "./data-planes";
@@ -48,6 +50,8 @@ export { applyMixins } from "./utils";
 export * from "./views";
 export * from "./whoami";
 export * from "./whoami/types";
+export * from "./workflows";
+export * from "./workflows/types";
 import { AccessRulesApi } from "./access-rules/";
 import { AccessTokensApi } from "./access-tokens";
 import { AppsApi } from "./apps";
@@ -56,6 +60,7 @@ import { AuthenticationApi } from "./authentication";
 // Handle the NarrativeApi class with mixins
 import { BaseApi } from "./base-api";
 import { CompanyInfoApi } from "./company-info";
+import { ComputePoolsApi } from "./compute-pools";
 import { ConnectionsApi } from "./connections";
 import { ContractsApi } from "./contracts";
 import { DataPlaneApi } from "./data-planes";
@@ -80,6 +85,7 @@ import { UploadsApi } from "./uploads";
 import { applyMixins } from "./utils";
 import { ViewsApi } from "./views";
 import { WhoAmIApi } from "./whoami";
+import { WorkflowsApi } from "./workflows";
 class NarrativeApi extends BaseApi {
 }
 applyMixins(NarrativeApi, [
@@ -114,5 +120,7 @@ applyMixins(NarrativeApi, [
     ModelInferenceApi,
     EncryptionMaterialApi,
     WhoAmIApi,
+    WorkflowsApi,
+    ComputePoolsApi,
 ]);
 export { NarrativeApi };

package/build/workflows/index.d.ts

@@ -0,0 +1,66 @@
+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";
+/**
+ * @module WorkflowsApi
+ * @description This module provides methods for creating, scheduling, triggering, and archiving workflows.
+ * @extends BaseApi
+ */
+declare class WorkflowsApi extends BaseApi {
+    /**
+     * List all active workflows for the authenticated company.
+     *
+     * @param {PaginationOptions} [params] - Optional pagination parameters.
+     * @returns {Promise<ListWorkflowsResponse>} A promise that resolves to a paginated list of workflows.
+     */
+    listWorkflows(params?: WorkflowPaginationOptions): Promise<ListWorkflowsResponse>;
+    /**
+     * Create a new workflow from a YAML specification.
+     * The specification is parsed and validated before the workflow is persisted.
+     *
+     * @param {CreateWorkflowRequest} request - The workflow creation request.
+     * @returns {Promise<CreateWorkflowResponse>} A promise that resolves to the created workflow.
+     */
+    createWorkflow(request: CreateWorkflowRequest): Promise<CreateWorkflowResponse>;
+    /**
+     * Retrieve a workflow by its ID.
+     *
+     * @param {string} workflowId - The unique identifier for the workflow.
+     * @returns {Promise<WorkflowResponse>} A promise that resolves to the workflow.
+     */
+    getWorkflow(workflowId: string): Promise<WorkflowResponse>;
+    /**
+     * Archive a workflow. This terminates any active schedule and running execution,
+     * then marks the workflow as archived.
+     *
+     * @param {string} workflowId - The unique identifier for the workflow to archive.
+     * @returns {Promise<void>} A promise that resolves when the workflow is archived.
+     */
+    archiveWorkflow(workflowId: string): Promise<void>;
+    /**
+     * Trigger an immediate execution of a workflow.
+     *
+     * @param {string} workflowId - The unique identifier for the workflow to trigger.
+     * @returns {Promise<TriggerWorkflowResponse>} A promise that resolves to the run ID of the new execution.
+     */
+    triggerWorkflow(workflowId: string): Promise<TriggerWorkflowResponse>;
+    /**
+     * Create a schedule for a workflow based on the cron expression defined in its specification.
+     * Optionally, the workflow can also be triggered immediately.
+     *
+     * @param {string} workflowId - The unique identifier for the workflow to schedule.
+     * @param {ScheduleWorkflowRequest} [request] - Optional request body with trigger_immediately flag.
+     * @returns {Promise<ScheduleWorkflowResponse>} A promise that resolves to the schedule response.
+     */
+    scheduleWorkflow(workflowId: string, request?: ScheduleWorkflowRequest): Promise<ScheduleWorkflowResponse>;
+    /**
+     * 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).
+     * @returns {Promise<ListRunsResponse>} A promise that resolves to a paginated list of workflow runs.
+     */
+    listWorkflowRuns(workflowId: string, params?: ListRunsParams): Promise<ListRunsResponse>;
+}
+export { WorkflowsApi, type CreateWorkflowRequest, type CreateWorkflowResponse, type ListRunsParams, type ListRunsResponse, type ListWorkflowsResponse, type ScheduleWorkflowRequest, type ScheduleWorkflowResponse, type TriggerWorkflowResponse, type WorkflowResponse, type WorkflowRun, type WorkflowRunStatus, type WorkflowStatus, };

package/build/workflows/index.js

@@ -0,0 +1,78 @@
+import { BaseApi } from "../base-api";
+const resourceName = "workflows";
+/**
+ * @module WorkflowsApi
+ * @description This module provides methods for creating, scheduling, triggering, and archiving workflows.
+ * @extends BaseApi
+ */
+class WorkflowsApi extends BaseApi {
+    /**
+     * List all active workflows for the authenticated company.
+     *
+     * @param {PaginationOptions} [params] - Optional pagination parameters.
+     * @returns {Promise<ListWorkflowsResponse>} A promise that resolves to a paginated list of workflows.
+     */
+    async listWorkflows(params) {
+        return await this.get(resourceName, params);
+    }
+    /**
+     * Create a new workflow from a YAML specification.
+     * The specification is parsed and validated before the workflow is persisted.
+     *
+     * @param {CreateWorkflowRequest} request - The workflow creation request.
+     * @returns {Promise<CreateWorkflowResponse>} A promise that resolves to the created workflow.
+     */
+    async createWorkflow(request) {
+        return await this.post(resourceName, request);
+    }
+    /**
+     * Retrieve a workflow by its ID.
+     *
+     * @param {string} workflowId - The unique identifier for the workflow.
+     * @returns {Promise<WorkflowResponse>} A promise that resolves to the workflow.
+     */
+    async getWorkflow(workflowId) {
+        return await this.get(`${resourceName}/${workflowId}`);
+    }
+    /**
+     * Archive a workflow. This terminates any active schedule and running execution,
+     * then marks the workflow as archived.
+     *
+     * @param {string} workflowId - The unique identifier for the workflow to archive.
+     * @returns {Promise<void>} A promise that resolves when the workflow is archived.
+     */
+    async archiveWorkflow(workflowId) {
+        await this.delete(`${resourceName}/${workflowId}`);
+    }
+    /**
+     * Trigger an immediate execution of a workflow.
+     *
+     * @param {string} workflowId - The unique identifier for the workflow to trigger.
+     * @returns {Promise<TriggerWorkflowResponse>} A promise that resolves to the run ID of the new execution.
+     */
+    async triggerWorkflow(workflowId) {
+        return await this.post(`${resourceName}/${workflowId}/trigger`);
+    }
+    /**
+     * Create a schedule for a workflow based on the cron expression defined in its specification.
+     * Optionally, the workflow can also be triggered immediately.
+     *
+     * @param {string} workflowId - The unique identifier for the workflow to schedule.
+     * @param {ScheduleWorkflowRequest} [request] - Optional request body with trigger_immediately flag.
+     * @returns {Promise<ScheduleWorkflowResponse>} A promise that resolves to the schedule response.
+     */
+    async scheduleWorkflow(workflowId, request) {
+        return await this.post(`${resourceName}/${workflowId}/schedule`, request);
+    }
+    /**
+     * 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).
+     * @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);
+    }
+}
+export { WorkflowsApi, };

package/build/workflows/types.d.ts

@@ -0,0 +1,54 @@
+export type WorkflowStatus = "active" | "archived";
+export type WorkflowRunStatus = "running" | "completed" | "failed" | "canceled" | "terminated" | "unknown";
+export interface WorkflowResponse {
+    id: string;
+    name: string;
+    specification: string;
+    data_plane_id: string;
+    company_id: number;
+    created_at: string;
+    created_by: number;
+    updated_at: string;
+    status: WorkflowStatus;
+    archived_at?: string | null;
+}
+export interface CreateWorkflowRequest {
+    specification: string;
+    data_plane_id: string;
+    trigger_immediately?: boolean | null;
+    schedule_immediately?: boolean | null;
+}
+export interface CreateWorkflowResponse extends WorkflowResponse {
+    run_id?: string | null;
+}
+export interface TriggerWorkflowResponse {
+    run_id: string;
+}
+export interface ScheduleWorkflowRequest {
+    trigger_immediately?: boolean | null;
+}
+export interface ScheduleWorkflowResponse {
+    run_id?: string | null;
+}
+export interface ListWorkflowsResponse {
+    records: WorkflowResponse[];
+    prev_page?: number | null;
+    current_page: number;
+    next_page?: number | null;
+    total_records: number;
+    total_pages: number;
+}
+export interface WorkflowRun {
+    run_id: string;
+    status: WorkflowRunStatus;
+    start_time: string;
+    close_time?: string | null;
+}
+export interface ListRunsResponse {
+    runs: WorkflowRun[];
+    next_page_token?: string | null;
+}
+export interface ListRunsParams extends Record<string, unknown> {
+    pageSize?: number;
+    pageToken?: string;
+}

package/build/workflows/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@narrative.io/data-collaboration-sdk-ts",
-	"version": "2.93.0",
+	"version": "2.94.1",
 	"main": "build/index.js",
 	"repository": "github:narrative-io/data-collaboration-sdk-ts",
 	"source": "src/index.ts",
@@ -25,21 +25,21 @@
 	"author": "",
 	"license": "ISC",
 	"devDependencies": {
-		"@babel/core": "7.28.6",
-		"@babel/preset-env": "7.28.6",
+		"@babel/core": "7.29.0",
+		"@babel/preset-env": "7.29.0",
 		"@babel/preset-typescript": "7.28.5",
-		"@biomejs/biome": "2.3.11",
-		"@commitlint/cli": "20.3.1",
-		"@commitlint/config-conventional": "20.3.1",
+		"@biomejs/biome": "2.3.14",
+		"@commitlint/cli": "20.4.1",
+		"@commitlint/config-conventional": "20.4.1",
 		"@types/jest": "30.0.0",
 		"babel-jest": "30.2.0",
 		"jest": "30.2.0",
-		"lefthook": "2.0.15",
+		"lefthook": "2.1.0",
 		"ts-jest": "29.4.6"
 	},
 	"dependencies": {
 		"mande": "2.0.9",
-		"zod": "4.3.5",
+		"zod": "4.3.6",
 		"bignumber.js": "9.3.1"
 	},
 	"overrides": {