@tailor-platform/sdk 2.0.0-next.4 → 2.0.0-next.6

package/dist/workflow-9kHGKxF2.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-9kHGKxF2.mjs","names":[],"sources":["../src/runtime/workflow.ts"],"sourcesContent":["/**\n * Workflow utilities.\n *\n * Thin typed wrapper around the platform-provided `tailor.workflow` runtime API.\n * At runtime this delegates to `globalThis.tailor.workflow`. Use `mockWorkflow`\n * from `@tailor-platform/sdk/vitest` to mock these calls in unit tests.\n *\n * The canonical names (`startWorkflow`, `startJobFunction`,\n * `resumeWorkflowExecution`) mirror the public `tailor.v1` RPC vocabulary.\n * The pre-alignment names (`triggerWorkflow`, `triggerJobFunction`,\n * `resumeWorkflow`) are kept as frozen aliases that reference the same platform\n * implementations, so existing code continues to work unchanged.\n * @example\n * import { workflow } from \"@tailor-platform/sdk/runtime\";\n *\n * const executionId = await workflow.startWorkflow(\"myWorkflow\", { data: \"value\" });\n */\n\n/* eslint-disable @typescript-eslint/no-explicit-any */\n\n/**\n * Specifies the machine user that should be used to execute the workflow.\n * This allows workflows to run with specific authentication context.\n */\nexport interface Invoker {\n  /** The namespace where the machine user is defined */\n  namespace: string;\n  /** The name of the machine user to use for workflow execution */\n  machineUserName: string;\n}\n\n/** Options for {@link startWorkflow}. */\nexport interface StartWorkflowOptions {\n  /** Optional authentication invoker to specify which machine user should execute the workflow */\n  authInvoker?: Invoker;\n}\n\n/**\n * Options for the legacy {@link triggerWorkflow} alias, using the SDK-facing\n * `invoker` key that {@link triggerWorkflow} converts to `authInvoker` before\n * calling the platform.\n * @deprecated Use {@link startWorkflow} and {@link StartWorkflowOptions} instead.\n */\nexport interface TriggerWorkflowOptions {\n  /** Optional invoker to specify which machine user should execute the workflow */\n  invoker?: Invoker;\n}\n\nexport interface PlatformTriggerWorkflowOptions {\n  authInvoker?: Invoker;\n}\n\ndeclare const executionPolicyKeyBrand: unique symbol;\n\n/**\n * A concrete runtime key produced by an execution policy instance — either an\n * exact-match policy's `.key`, or a wildcard policy's `.keyFor(suffix)` (see\n * `defineWorkflowExecutionPolicies`). Branded so an arbitrary string that\n * wasn't derived from a declared policy can't be passed as `executionPolicyKey`.\n */\nexport type ExecutionPolicyKey = string & { readonly [executionPolicyKeyBrand]: never };\n\n/** Options for {@link startJobFunction}. */\nexport interface StartJobFunctionOptions {\n  /**\n   * Execution policy key matched by the platform against the policies\n   * declared with `defineWorkflowExecutionPolicies` in `tailor.config.ts`.\n   */\n  executionPolicyKey?: ExecutionPolicyKey;\n}\n\n/**\n * Frozen alias for {@link StartJobFunctionOptions}. Kept for backward compatibility.\n * @deprecated Use {@link StartJobFunctionOptions} instead.\n */\nexport type TriggerJobFunctionOptions = StartJobFunctionOptions;\n\n/**\n * Platform API surface for `tailor.workflow`. Describes the shape the platform\n * runtime injects on `globalThis.tailor.workflow`.\n */\nexport interface PlatformWorkflowAPI {\n  /**\n   * Starts a workflow and returns its execution ID.\n   *\n   * Canonical name that mirrors the `tailor.v1` RPC vocabulary.\n   * {@link triggerWorkflow} is a frozen alias that resolves to the same\n   * platform implementation.\n   * @param workflowName - Workflow name as defined in tailor.config\n   * @param args - Arguments forwarded to the workflow's main job\n   * @param options - Optional start options (e.g. `authInvoker`)\n   * @returns The execution ID of the started workflow\n   */\n  startWorkflow(workflowName: string, args?: any, options?: StartWorkflowOptions): Promise<string>;\n\n  /**\n   * Frozen alias for {@link startWorkflow}. Kept for backward compatibility.\n   * @deprecated Use {@link startWorkflow} instead.\n   */\n  triggerWorkflow(\n    workflowName: string,\n    args?: any,\n    options?: PlatformTriggerWorkflowOptions,\n  ): Promise<string>;\n\n  /**\n   * Resumes a failed or pending-retry workflow execution and returns its execution ID.\n   *\n   * Canonical name that mirrors the `tailor.v1` RPC vocabulary.\n   * {@link resumeWorkflow} is a frozen alias that resolves to the same\n   * platform implementation.\n   * @param executionId - The execution to resume\n   * @returns The execution ID of the resumed workflow\n   */\n  resumeWorkflowExecution(executionId: string): Promise<string>;\n\n  /**\n   * Frozen alias for {@link resumeWorkflowExecution}. Kept for backward compatibility.\n   * @deprecated Use {@link resumeWorkflowExecution} instead.\n   */\n  resumeWorkflow(executionId: string): Promise<string>;\n\n  /**\n   * Starts a job function and returns its result.\n   *\n   * Canonical name that mirrors the `tailor.v1` RPC vocabulary.\n   * {@link triggerJobFunction} is a frozen alias that resolves to the same\n   * platform implementation.\n   * @param jobName - Job name as defined in the workflow\n   * @param args - Arguments forwarded to the job\n   * @param options - Optional start options (e.g. `executionPolicyKey`)\n   * @returns The job's return value\n   */\n  startJobFunction(jobName: string, args?: any, options?: StartJobFunctionOptions): any;\n\n  /**\n   * Frozen alias for {@link startJobFunction}. Kept for backward compatibility.\n   * @deprecated Use {@link startJobFunction} instead.\n   */\n  triggerJobFunction(jobName: string, args?: any, options?: TriggerJobFunctionOptions): any;\n\n  /**\n   * Suspends the current workflow execution and waits for an external signal to resume.\n   * @param key - Wait point key\n   * @param payload - Optional payload to record with the wait point\n   * @returns The payload supplied by the corresponding `resolve` call\n   */\n  wait(key: string, payload?: any): any;\n\n  /**\n   * Resolves a waiting workflow execution, causing it to resume.\n   * @param executionId - The execution to resume\n   * @param key - Wait point key to resolve\n   * @param callback - Callback receiving the wait payload; its return value is forwarded to `wait`\n   * @returns A promise that resolves once the resolve has been recorded\n   */\n  resolve(executionId: string, key: string, callback: (waitPayload: any) => any): Promise<void>;\n}\n\n/** Runtime wrapper API for workflow and job control. */\nexport interface TailorWorkflowAPI extends Omit<PlatformWorkflowAPI, \"triggerWorkflow\"> {\n  /**\n   * Triggers a workflow and returns its execution ID.\n   * @param workflowName - Workflow name as defined in tailor.config\n   * @param args - Arguments forwarded to the workflow's main job\n   * @param options - Optional SDK trigger options\n   * @returns The execution ID of the triggered workflow\n   */\n  triggerWorkflow(\n    workflowName: string,\n    args?: any,\n    options?: TriggerWorkflowOptions,\n  ): Promise<string>;\n}\n\nconst api = (): PlatformWorkflowAPI =>\n  (globalThis as unknown as { tailor: { workflow: PlatformWorkflowAPI } }).tailor.workflow;\n\n/**\n * See {@link TailorWorkflowAPI.startWorkflow}.\n * @param args - Forwarded to {@link TailorWorkflowAPI.startWorkflow}\n * @returns The execution ID of the started workflow\n */\nconst startWorkflow: PlatformWorkflowAPI[\"startWorkflow\"] = (...args) =>\n  api().startWorkflow(...args);\n\n/**\n * Frozen alias for {@link startWorkflow}. Kept for backward compatibility.\n * Converts the SDK-facing `invoker` option to the platform's `authInvoker`.\n * @param workflowName - Workflow name as defined in tailor.config\n * @param args - Arguments forwarded to the workflow's main job\n * @param options - Optional SDK trigger options\n * @returns The execution ID of the triggered workflow\n * @deprecated Use {@link startWorkflow} instead.\n */\nfunction triggerWorkflow(\n  workflowName: string,\n  args?: any,\n  options?: TriggerWorkflowOptions,\n): Promise<string> {\n  if (options?.invoker === undefined) {\n    return api().triggerWorkflow(workflowName, args);\n  }\n  return api().triggerWorkflow(workflowName, args, { authInvoker: options.invoker });\n}\n\n/**\n * See {@link TailorWorkflowAPI.resumeWorkflowExecution}.\n * @param args - Forwarded to {@link TailorWorkflowAPI.resumeWorkflowExecution}\n * @returns The execution ID of the resumed workflow\n */\nconst resumeWorkflowExecution: PlatformWorkflowAPI[\"resumeWorkflowExecution\"] = (...args) =>\n  api().resumeWorkflowExecution(...args);\n\n/**\n * Frozen alias for {@link resumeWorkflowExecution}. Kept for backward compatibility.\n * @param args - Forwarded to {@link resumeWorkflowExecution}\n * @returns The execution ID of the resumed workflow\n * @deprecated Use {@link resumeWorkflowExecution} instead.\n */\nconst resumeWorkflow: PlatformWorkflowAPI[\"resumeWorkflow\"] = (...args) =>\n  api().resumeWorkflow(...args);\n\n/**\n * See {@link TailorWorkflowAPI.startJobFunction}.\n * @param args - Forwarded to {@link TailorWorkflowAPI.startJobFunction}\n * @returns The job's return value\n */\nconst startJobFunction: PlatformWorkflowAPI[\"startJobFunction\"] = (...args) =>\n  api().startJobFunction(...args);\n\n/**\n * Frozen alias for {@link startJobFunction}. Kept for backward compatibility.\n * @param args - Forwarded to {@link startJobFunction}\n * @returns The job's return value\n * @deprecated Use {@link startJobFunction} instead.\n */\nconst triggerJobFunction: PlatformWorkflowAPI[\"triggerJobFunction\"] = (...args) =>\n  api().triggerJobFunction(...args);\n\nconst wait: PlatformWorkflowAPI[\"wait\"] = (...args) => api().wait(...args);\n\nconst resolve: PlatformWorkflowAPI[\"resolve\"] = (...args) => api().resolve(...args);\n\n/** Runtime wrapper namespace for `tailor.workflow`. */\nexport const workflow = {\n  startWorkflow,\n  triggerWorkflow,\n  resumeWorkflowExecution,\n  resumeWorkflow,\n  startJobFunction,\n  triggerJobFunction,\n  wait,\n  resolve,\n} as const satisfies TailorWorkflowAPI;\n"],"mappings":";AA+KA,MAAM,YACH,WAAwE,OAAO;;;;;;AAOlF,MAAM,iBAAuD,GAAG,SAC9D,IAAI,CAAC,CAAC,cAAc,GAAG,IAAI;;;;;;;;;;AAW7B,SAAS,gBACP,cACA,MACA,SACiB;CACjB,IAAI,SAAS,YAAY,QACvB,OAAO,IAAI,CAAC,CAAC,gBAAgB,cAAc,IAAI;CAEjD,OAAO,IAAI,CAAC,CAAC,gBAAgB,cAAc,MAAM,EAAE,aAAa,QAAQ,QAAQ,CAAC;AACnF;;;;;;AAOA,MAAM,2BAA2E,GAAG,SAClF,IAAI,CAAC,CAAC,wBAAwB,GAAG,IAAI;;;;;;;AAQvC,MAAM,kBAAyD,GAAG,SAChE,IAAI,CAAC,CAAC,eAAe,GAAG,IAAI;;;;;;AAO9B,MAAM,oBAA6D,GAAG,SACpE,IAAI,CAAC,CAAC,iBAAiB,GAAG,IAAI;;;;;;;AAQhC,MAAM,sBAAiE,GAAG,SACxE,IAAI,CAAC,CAAC,mBAAmB,GAAG,IAAI;AAElC,MAAM,QAAqC,GAAG,SAAS,IAAI,CAAC,CAAC,KAAK,GAAG,IAAI;AAEzE,MAAM,WAA2C,GAAG,SAAS,IAAI,CAAC,CAAC,QAAQ,GAAG,IAAI;;AAGlF,MAAa,WAAW;CACtB;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF"}