@proteos/sdk 0.18.1

package/src/workflow/workflows.ts

@@ -0,0 +1,152 @@
+import type { ProteosClient } from '../client.js'
+import { PageIterator } from '../iterator.js'
+import type { ListOptions, ListResult } from '../types/common.js'
+import type {
+  CreateWorkflowRequest,
+  ListWorkflowsOptions,
+  RunWorkflowRequest,
+  TestNodeRequest,
+  TestNodeResponse,
+  UpdateWorkflowRequest,
+  Workflow,
+  WorkflowExecution,
+  WorkflowVersion,
+  WorkflowVersionSummary,
+} from './types.js'
+
+const WORKFLOWS_BASE_PATH = '/workflows/v1/workflows'
+
+/**
+ * Service for managing Workflows — n8n-shaped automation definitions keyed by an
+ * immutable kebab-case `key`. Run/pause/unpause drive the Temporal-backed runtime.
+ */
+export interface WorkflowService {
+  /** Lists workflows, auto-paginating. */
+  list(options?: ListWorkflowsOptions): PageIterator<Workflow, ListWorkflowsOptions>
+  /** Fetches a single page of workflows with pagination metadata. */
+  listPage(options?: ListWorkflowsOptions): Promise<ListResult<Workflow>>
+  /** Gets a single workflow by key. @throws {ProteosError} 404 if not found. */
+  get(key: string): Promise<Workflow>
+  /** Creates a new workflow. @throws {ProteosError} 400/409. */
+  create(request: CreateWorkflowRequest): Promise<Workflow>
+  /** Fully replaces a workflow's metadata + graph (version bumped server-side). */
+  update(key: string, request: UpdateWorkflowRequest): Promise<Workflow>
+  /** Deletes a workflow. @throws {ProteosError} 404 if not found. */
+  delete(key: string): Promise<void>
+  /**
+   * Triggers one manual run; returns the pending execution. Pass
+   * `destination_node_id` for a partial "run until here" execution (only the
+   * destination's ancestors run).
+   */
+  run(key: string, request?: RunWorkflowRequest): Promise<WorkflowExecution>
+  /**
+   * Runs ONE node ephemerally against its last-known (or pinned) input and
+   * blocks for the result — the editor's "Run this node". No execution rows
+   * are written; side effects are real.
+   */
+  testNode(key: string, nodeId: string, request: TestNodeRequest): Promise<TestNodeResponse>
+  /** Pauses scheduled/triggered firings. */
+  pause(key: string): Promise<Workflow>
+  /** Resumes a paused workflow. */
+  unpause(key: string): Promise<Workflow>
+  /** Lists a workflow's version history (newest first), auto-paginating. */
+  listVersions(
+    key: string,
+    options?: ListOptions,
+  ): PageIterator<WorkflowVersionSummary, ListOptions>
+  /** Fetches a single page of a workflow's version history (newest first). */
+  listVersionsPage(key: string, options?: ListOptions): Promise<ListResult<WorkflowVersionSummary>>
+  /** Gets one immutable version of a workflow, graph included. @throws {ProteosError} 404. */
+  getVersion(key: string, version: number): Promise<WorkflowVersion>
+  /**
+   * Restores an old version by saving its graph as a NEW bumped version;
+   * returns the updated workflow (its `.version` is the new current version).
+   * @throws {ProteosError} 400 when restoring the current version.
+   */
+  restoreVersion(key: string, version: number): Promise<Workflow>
+}
+
+export class WorkflowServiceImpl implements WorkflowService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(options: ListWorkflowsOptions = {}): PageIterator<Workflow, ListWorkflowsOptions> {
+    return new PageIterator((opts) => this.listPage(opts), options)
+  }
+
+  async listPage(options: ListWorkflowsOptions = {}): Promise<ListResult<Workflow>> {
+    return this.client.requestWithQuery<ListResult<Workflow>>('GET', WORKFLOWS_BASE_PATH, options)
+  }
+
+  async get(key: string): Promise<Workflow> {
+    return this.client.request<Workflow>('GET', `${WORKFLOWS_BASE_PATH}/${key}`)
+  }
+
+  async create(request: CreateWorkflowRequest): Promise<Workflow> {
+    return this.client.request<Workflow>('POST', WORKFLOWS_BASE_PATH, request)
+  }
+
+  async update(key: string, request: UpdateWorkflowRequest): Promise<Workflow> {
+    return this.client.request<Workflow>('PATCH', `${WORKFLOWS_BASE_PATH}/${key}`, request)
+  }
+
+  async delete(key: string): Promise<void> {
+    await this.client.request<void>('DELETE', `${WORKFLOWS_BASE_PATH}/${key}`)
+  }
+
+  async run(key: string, request: RunWorkflowRequest = {}): Promise<WorkflowExecution> {
+    return this.client.request<WorkflowExecution>(
+      'POST',
+      `${WORKFLOWS_BASE_PATH}/${key}/run`,
+      request,
+    )
+  }
+
+  async testNode(key: string, nodeId: string, request: TestNodeRequest): Promise<TestNodeResponse> {
+    return this.client.request<TestNodeResponse>(
+      'POST',
+      `${WORKFLOWS_BASE_PATH}/${key}/nodes/${nodeId}/test`,
+      request,
+    )
+  }
+
+  async pause(key: string): Promise<Workflow> {
+    return this.client.request<Workflow>('POST', `${WORKFLOWS_BASE_PATH}/${key}/pause`, {})
+  }
+
+  async unpause(key: string): Promise<Workflow> {
+    return this.client.request<Workflow>('POST', `${WORKFLOWS_BASE_PATH}/${key}/unpause`, {})
+  }
+
+  listVersions(
+    key: string,
+    options: ListOptions = {},
+  ): PageIterator<WorkflowVersionSummary, ListOptions> {
+    return new PageIterator((opts) => this.listVersionsPage(key, opts), options)
+  }
+
+  async listVersionsPage(
+    key: string,
+    options: ListOptions = {},
+  ): Promise<ListResult<WorkflowVersionSummary>> {
+    return this.client.requestWithQuery<ListResult<WorkflowVersionSummary>>(
+      'GET',
+      `${WORKFLOWS_BASE_PATH}/${key}/versions`,
+      options,
+    )
+  }
+
+  async getVersion(key: string, version: number): Promise<WorkflowVersion> {
+    return this.client.request<WorkflowVersion>(
+      'GET',
+      `${WORKFLOWS_BASE_PATH}/${key}/versions/${version}`,
+    )
+  }
+
+  async restoreVersion(key: string, version: number): Promise<Workflow> {
+    return this.client.request<Workflow>(
+      'POST',
+      `${WORKFLOWS_BASE_PATH}/${key}/versions/${version}/restore`,
+      {},
+    )
+  }
+}