@tailor-platform/sdk 1.76.2 → 1.79.0

package/dist/runtime/workflow.d.mts

@@ -1,5 +1,5 @@
 declare namespace workflow_d_exports {
-  export { AuthInvoker, ExecutionPolicyKey, TailorWorkflowAPI, TriggerJobFunctionOptions, TriggerWorkflowOptions, resolve, resumeWorkflow, triggerJobFunction, triggerWorkflow, wait };
+  export { AuthInvoker, ExecutionPolicyKey, StartJobFunctionOptions, StartWorkflowOptions, TailorWorkflowAPI, TriggerJobFunctionOptions, TriggerWorkflowOptions, resolve, resumeWorkflow, resumeWorkflowExecution, startJobFunction, startWorkflow, triggerJobFunction, triggerWorkflow, wait };
 }
 /**
  * Workflow utilities.
@@ -7,10 +7,16 @@ declare namespace workflow_d_exports {
  * Thin typed wrapper around the platform-provided `tailor.workflow` runtime API.
  * At runtime this delegates to `globalThis.tailor.workflow`. Use `mockWorkflow`
  * from `@tailor-platform/sdk/vitest` to mock these calls in unit tests.
+ *
+ * The canonical names (`startWorkflow`, `startJobFunction`,
+ * `resumeWorkflowExecution`) mirror the public `tailor.v1` RPC vocabulary.
+ * The pre-alignment names (`triggerWorkflow`, `triggerJobFunction`,
+ * `resumeWorkflow`) are kept as frozen aliases that reference the same platform
+ * implementations, so existing code continues to work unchanged.
  * @example
  * import { workflow } from "@tailor-platform/sdk/runtime";
  *
- * const executionId = await workflow.triggerWorkflow("myWorkflow", { data: "value" });
+ * const executionId = await workflow.startWorkflow("myWorkflow", { data: "value" });
  */
 /**
  * Specifies the machine user that should be used to execute the workflow.
@@ -22,11 +28,16 @@ interface AuthInvoker {
   /** The name of the machine user to use for workflow execution */
   machineUserName: string;
 }
-/** Options for {@link triggerWorkflow}. */
-interface TriggerWorkflowOptions {
+/** Options for {@link startWorkflow}. */
+interface StartWorkflowOptions {
   /** Optional authentication invoker to specify which machine user should execute the workflow */
   authInvoker?: AuthInvoker;
 }
+/**
+ * Frozen alias for {@link StartWorkflowOptions}. Kept for backward compatibility.
+ * @deprecated Use {@link StartWorkflowOptions} instead.
+ */
+type TriggerWorkflowOptions = StartWorkflowOptions;
 declare const executionPolicyKeyBrand: unique symbol;
 /**
  * A concrete runtime key produced by an execution policy instance — either an
@@ -37,14 +48,19 @@ declare const executionPolicyKeyBrand: unique symbol;
 type ExecutionPolicyKey = string & {
   readonly [executionPolicyKeyBrand]: never;
 };
-/** Options for {@link triggerJobFunction}. */
-interface TriggerJobFunctionOptions {
+/** Options for {@link startJobFunction}. */
+interface StartJobFunctionOptions {
   /**
    * Execution policy key matched by the platform against the policies
    * declared with `defineWorkflowExecutionPolicies` in `tailor.config.ts`.
    */
   executionPolicyKey?: ExecutionPolicyKey;
 }
+/**
+ * Frozen alias for {@link StartJobFunctionOptions}. Kept for backward compatibility.
+ * @deprecated Use {@link StartJobFunctionOptions} instead.
+ */
+type TriggerJobFunctionOptions = StartJobFunctionOptions;
 /**
  * Platform API surface for `tailor.workflow`. Describes the shape the platform
  * runtime injects on `globalThis.tailor.workflow`.
@@ -55,26 +71,53 @@ interface TriggerJobFunctionOptions {
  */
 interface TailorWorkflowAPI {
   /**
-   * Triggers a workflow and returns its execution ID.
+   * Starts a workflow and returns its execution ID.
+   *
+   * Canonical name that mirrors the `tailor.v1` RPC vocabulary.
+   * {@link triggerWorkflow} is a frozen alias that resolves to the same
+   * platform implementation.
    * @param workflowName - Workflow name as defined in tailor.config
    * @param args - Arguments forwarded to the workflow's main job
-   * @param options - Optional trigger options (e.g. `authInvoker`)
-   * @returns The execution ID of the triggered workflow
+   * @param options - Optional start options (e.g. `authInvoker`)
+   * @returns The execution ID of the started workflow
+   */
+  startWorkflow(workflowName: string, args?: any, options?: StartWorkflowOptions): Promise<string>;
+  /**
+   * Frozen alias for {@link startWorkflow}. Kept for backward compatibility.
+   * @deprecated Use {@link startWorkflow} instead.
    */
   triggerWorkflow(workflowName: string, args?: any, options?: TriggerWorkflowOptions): Promise<string>;
   /**
    * Resumes a failed or pending-retry workflow execution and returns its execution ID.
+   *
+   * Canonical name that mirrors the `tailor.v1` RPC vocabulary.
+   * {@link resumeWorkflow} is a frozen alias that resolves to the same
+   * platform implementation.
    * @param executionId - The execution to resume
    * @returns The execution ID of the resumed workflow
    */
+  resumeWorkflowExecution(executionId: string): Promise<string>;
+  /**
+   * Frozen alias for {@link resumeWorkflowExecution}. Kept for backward compatibility.
+   * @deprecated Use {@link resumeWorkflowExecution} instead.
+   */
   resumeWorkflow(executionId: string): Promise<string>;
   /**
-   * Triggers a job function and returns its result.
+   * Starts a job function and returns its result.
+   *
+   * Canonical name that mirrors the `tailor.v1` RPC vocabulary.
+   * {@link triggerJobFunction} is a frozen alias that resolves to the same
+   * platform implementation.
    * @param jobName - Job name as defined in the workflow
    * @param args - Arguments forwarded to the job
-   * @param options - Optional trigger options (e.g. `executionPolicyKey`)
+   * @param options - Optional start options (e.g. `executionPolicyKey`)
    * @returns The job's return value
    */
+  startJobFunction(jobName: string, args?: any, options?: StartJobFunctionOptions): any;
+  /**
+   * Frozen alias for {@link startJobFunction}. Kept for backward compatibility.
+   * @deprecated Use {@link startJobFunction} instead.
+   */
   triggerJobFunction(jobName: string, args?: any, options?: TriggerJobFunctionOptions): any;
   /**
    * Suspends the current workflow execution and waits for an external signal to resume.
@@ -93,19 +136,40 @@ interface TailorWorkflowAPI {
   resolve(executionId: string, key: string, callback: (waitPayload: any) => any): Promise<void>;
 }
 /**
- * See {@link TailorWorkflowAPI.triggerWorkflow}.
+ * See {@link TailorWorkflowAPI.startWorkflow}.
+ * @param args - Forwarded to {@link TailorWorkflowAPI.startWorkflow}
+ * @returns The execution ID of the started workflow
+ */
+declare const startWorkflow: TailorWorkflowAPI["startWorkflow"];
+/**
+ * Frozen alias for {@link startWorkflow}. Kept for backward compatibility.
+ * @deprecated Use {@link startWorkflow} instead.
  * @param args - Forwarded to {@link TailorWorkflowAPI.triggerWorkflow}
  * @returns The execution ID of the triggered workflow
  */
 declare const triggerWorkflow: TailorWorkflowAPI["triggerWorkflow"];
 /**
- * See {@link TailorWorkflowAPI.resumeWorkflow}.
+ * See {@link TailorWorkflowAPI.resumeWorkflowExecution}.
+ * @param args - Forwarded to {@link TailorWorkflowAPI.resumeWorkflowExecution}
+ * @returns The execution ID of the resumed workflow
+ */
+declare const resumeWorkflowExecution: TailorWorkflowAPI["resumeWorkflowExecution"];
+/**
+ * Frozen alias for {@link resumeWorkflowExecution}. Kept for backward compatibility.
+ * @deprecated Use {@link resumeWorkflowExecution} instead.
  * @param args - Forwarded to {@link TailorWorkflowAPI.resumeWorkflow}
  * @returns The execution ID of the resumed workflow
  */
 declare const resumeWorkflow: TailorWorkflowAPI["resumeWorkflow"];
 /**
- * See {@link TailorWorkflowAPI.triggerJobFunction}.
+ * See {@link TailorWorkflowAPI.startJobFunction}.
+ * @param args - Forwarded to {@link TailorWorkflowAPI.startJobFunction}
+ * @returns The job's return value
+ */
+declare const startJobFunction: TailorWorkflowAPI["startJobFunction"];
+/**
+ * Frozen alias for {@link startJobFunction}. Kept for backward compatibility.
+ * @deprecated Use {@link startJobFunction} instead.
  * @param args - Forwarded to {@link TailorWorkflowAPI.triggerJobFunction}
  * @returns The job's return value
  */
@@ -123,4 +187,4 @@ declare const wait: TailorWorkflowAPI["wait"];
  */
 declare const resolve: TailorWorkflowAPI["resolve"];
 //#endregion
-export { AuthInvoker, ExecutionPolicyKey, TailorWorkflowAPI, TriggerJobFunctionOptions, TriggerWorkflowOptions, resolve, resumeWorkflow, triggerJobFunction, triggerWorkflow, wait, workflow_d_exports };
+export { AuthInvoker, ExecutionPolicyKey, StartJobFunctionOptions, StartWorkflowOptions, TailorWorkflowAPI, TriggerJobFunctionOptions, TriggerWorkflowOptions, resolve, resumeWorkflow, resumeWorkflowExecution, startJobFunction, startWorkflow, triggerJobFunction, triggerWorkflow, wait, workflow_d_exports };

package/dist/runtime/workflow.mjs

@@ -1,3 +1,3 @@
-import { a as wait, i as triggerWorkflow, n as resumeWorkflow, r as triggerJobFunction, t as resolve } from "../workflow-DSwnYPPP.mjs";
+import { a as startWorkflow, c as wait, i as startJobFunction, n as resumeWorkflow, o as triggerJobFunction, r as resumeWorkflowExecution, s as triggerWorkflow, t as resolve } from "../workflow-CkIDJpdg.mjs";
 
-export { resolve, resumeWorkflow, triggerJobFunction, triggerWorkflow, wait };
+export { resolve, resumeWorkflow, resumeWorkflowExecution, startJobFunction, startWorkflow, triggerJobFunction, triggerWorkflow, wait };