@tailor-platform/sdk 2.0.0-next.1 → 2.0.0-next.3

package/dist/vitest/mocks/tailordb.d.mts

@@ -0,0 +1,71 @@
+//#region src/vitest/mocks/tailordb.d.ts
+type QueryResolver = (query: string, params: unknown[]) => unknown[];
+interface ExecutedQuery {
+  query: string;
+  params: unknown[];
+}
+interface CreatedClient {
+  namespace: string | undefined;
+  ended: boolean;
+}
+declare class MockQueryResult {
+  command: string;
+  rowCount: number;
+  rows: unknown[];
+  constructor(rows: unknown[]);
+}
+/**
+ * Acquire a disposable mock for TailorDB operations. Installs a mock
+ * `tailordb.Client` whose `queryObject` is a shared `vi.fn()` (so query
+ * responses can be staged before the client is constructed). Restored on
+ * dispose.
+ * @returns Disposable TailorDB mock control object
+ * @example
+ * ```typescript
+ * import { mockTailordb } from "@tailor-platform/sdk/vitest";
+ *
+ * test("order-based", async () => {
+ *   using db = mockTailordb();
+ *   db.enqueueResults([], [{ age: 30 }], []); // BEGIN / SELECT / COMMIT
+ *   // …
+ *   expect(db.queryObject).toHaveBeenCalledTimes(3);
+ *   expect(db.Client).toHaveBeenCalledWith({ namespace: "tailordb" });
+ * });
+ * ```
+ */
+declare function mockTailordb(): {
+  /** The mock `tailordb.Client` constructor (`vi.fn`). */Client: import("vitest").Mock<(this: any, config?: {
+    namespace?: string;
+  }) => void>; /** The shared `queryObject` `vi.fn` used by every client and transaction. */
+  queryObject: import("vitest").Mock<(_query: string, _params?: unknown[]) => Promise<MockQueryResult>>;
+  /**
+   * Set a fallback query resolver. Called when the enqueue queue is empty.
+   * @param resolver - Function that returns rows for a given query and params
+   */
+  setQueryResolver(resolver: QueryResolver): void;
+  /**
+   * Enqueue rows for the next `queryObject` call (FIFO; takes priority over
+   * `setQueryResolver`). Call with no arguments for an empty result.
+   * @param rows - Row objects to return from the next `queryObject` call
+   */
+  enqueueResult(...rows: unknown[]): void;
+  /**
+   * Enqueue rows for multiple subsequent `queryObject` calls (FIFO).
+   * @param rowsList - Rows arrays, one per upcoming query
+   */
+  enqueueResults(...rowsList: unknown[][]): void;
+  /**
+   * All queries executed via `queryObject`, in order, derived from the vi.fn
+   * call records.
+   * @returns Executed queries array
+   */
+  readonly executedQueries: ExecutedQuery[];
+  /**
+   * All TailorDB clients created, with their namespace and end state.
+   * @returns Created clients array
+   */
+  readonly createdClients: CreatedClient[]; /** Reset query responses and recorded calls (keeps the mock installed). */
+  reset(): void;
+} & Disposable;
+//#endregion
+export { mockTailordb };

package/dist/vitest/mocks/workflow.d.mts

@@ -0,0 +1,115 @@
+import { TailorEnv } from "../../runtime/types.mjs";
+
+//#region src/vitest/mocks/workflow.d.ts
+type JobHandler = (jobName: string, args: unknown) => unknown;
+type TriggerWorkflowOptions = {
+  authInvoker?: {
+    namespace: string;
+    machineUserName: string;
+  };
+};
+type TriggerHandlerFn = (workflowName: string, args: unknown, options?: TriggerWorkflowOptions) => string;
+type ResumeHandlerFn = (executionId: string) => string;
+type WaitHandlerFn = (key: string, payload: unknown) => unknown;
+type ResolveHandler = (executionId: string, key: string, callback: (payload: unknown) => unknown) => unknown | Promise<unknown>;
+type SetWaitHandler = {
+  (handler: WaitHandlerFn): void;
+  (handler: unknown): void;
+};
+interface TriggeredJob {
+  jobName: string;
+  args: unknown;
+}
+/**
+ * Acquire a disposable mock for workflow operations (`tailor.workflow`).
+ * Restored on dispose.
+ * @returns Disposable workflow mock control object
+ * @example
+ * ```typescript
+ * import { mockWorkflow } from "@tailor-platform/sdk/vitest";
+ *
+ * test("job handler", async () => {
+ *   using wf = mockWorkflow();
+ *   wf.setJobHandler((name) => (name === "validate" ? { valid: true } : null));
+ *   await runWorkflowUnderTest(); // calls tailor.workflow.triggerJobFunction("validate", {})
+ *   expect(wf.triggerJobFunction).toHaveBeenCalledWith("validate", {});
+ * });
+ * ```
+ */
+declare function mockWorkflow(): {
+  /** The `triggerJobFunction` `vi.fn`. */triggerJobFunction: import("vitest").Mock<(jobName: string, _args?: unknown) => unknown>; /** The `triggerWorkflow` `vi.fn`. */
+  triggerWorkflow: import("vitest").Mock<(_workflowName: string, _args?: unknown, _options?: TriggerWorkflowOptions) => Promise<string>>; /** The `resumeWorkflow` `vi.fn`. */
+  resumeWorkflow: import("vitest").Mock<(executionId: string) => Promise<string>>; /** The `wait` `vi.fn`. */
+  wait: import("vitest").Mock<(_key: string, _payload?: unknown) => unknown>; /** The `resolve` `vi.fn`. */
+  resolve: import("vitest").Mock<(_executionId: string, _key: string, _callback: (payload: unknown) => unknown) => Promise<void>>;
+  /**
+   * Set a fallback job handler. Called when the enqueue queue is empty.
+   * @param handler - Function returning a result for a job name and args
+   */
+  setJobHandler(handler: JobHandler): void;
+  /**
+   * Enqueue a single result for the next `triggerJobFunction` call (FIFO;
+   * takes priority over `setJobHandler`).
+   * @param result - Result to return from the next call
+   */
+  enqueueResult(result: unknown): void;
+  /**
+   * Enqueue results for multiple subsequent `triggerJobFunction` calls (FIFO).
+   * @param results - Results to enqueue, one per upcoming call
+   */
+  enqueueResults(...results: unknown[]): void;
+  /**
+   * All jobs triggered via `triggerJobFunction`, in order.
+   * @returns Triggered jobs array
+   */
+  readonly triggeredJobs: TriggeredJob[];
+  /**
+   * Configure what `triggerWorkflow` returns. Pass a string (same id every
+   * call) or `(name, args, options) => string`. Default: a placeholder UUID.
+   * @param handler - Static execution ID or a function returning one
+   */
+  setTriggerHandler(handler: string | TriggerHandlerFn): void;
+  /**
+   * Configure what `resumeWorkflow` returns. Pass a string (same id every
+   * call) or `(executionId) => string`. Default: echoes the input executionId.
+   * @param handler - Static execution ID or a function returning one
+   */
+  setResumeHandler(handler: string | ResumeHandlerFn): void;
+  /**
+   * Configure what `wait` returns. Pass `(key, payload) => unknown` or any
+   * other value to return it for every call. Default: `null`.
+   * @param handler - Static value or a function returning one
+   */
+  setWaitHandler: SetWaitHandler;
+  /**
+   * Set the `env` passed to job bodies invoked via `createWorkflowJob().trigger()`.
+   * Cleared on dispose / reset.
+   * @param env - Env passed to job bodies.
+   */
+  setEnv(env: TailorEnv): void;
+  /**
+   * Configure how `resolve` runs the user-supplied callback. Default: callback
+   * is not invoked (records the call only).
+   * @param handler - Function invoked per `resolve` call
+   */
+  setResolveHandler(handler: ResolveHandler): void;
+  /**
+   * `wait` calls reshaped as `{ key, payload }` for assertions.
+   * @returns Wait call records
+   */
+  readonly waitCalls: {
+    key: string;
+    payload: unknown;
+  }[];
+  /**
+   * `resolve` calls reshaped as `{ executionId, key }` for assertions.
+   * @returns Resolve call records
+   */
+  readonly resolveCalls: {
+    executionId: string;
+    key: string;
+  }[]; /** Reset all workflow responses and recorded calls (keeps the mock installed). */
+  reset(): void;
+} & Disposable;
+//#endregion
+export { mockWorkflow };

package/dist/vitest/setup.d.mts

@@ -59,5 +59,4 @@ declare function removeBlockedGlobals(globalObj: Record<string, unknown>, keys:
  */
 declare function restoreBlockedGlobals(globalObj: Record<string, unknown>, saved: SavedGlobals): void;
 //#endregion
-export { createBlockedGlobalsLifecycle, extractVaultStore, loadSecretsFromConfig, removeBlockedGlobals, restoreBlockedGlobals };
-//# sourceMappingURL=setup.d.mts.map
+export { createBlockedGlobalsLifecycle, extractVaultStore, loadSecretsFromConfig, removeBlockedGlobals, restoreBlockedGlobals };

package/dist/vitest/setup.mjs

@@ -1,5 +1,5 @@
-import { t as RUNTIME_FLAG_KEY } from "../globals-Crz8o65k.mjs";
-import { a as mockSecretmanager } from "../mock-BjFj5o1I.mjs";
+import { t as RUNTIME_FLAG_KEY } from "../globals-DhwZj0RB.mjs";
+import { t as mockSecretmanager } from "../secretmanager-Bd45j7an.mjs";
 import { pathToFileURL } from "node:url";
 import { afterEach, beforeAll, beforeEach } from "vitest";
 

package/dist/vitest/workflow-local.d.mts

@@ -0,0 +1,40 @@
+import { TailorEnv } from "../runtime/types.mjs";
+import { WorkflowJob } from "../configure/services/workflow/job.mjs";
+import { Workflow } from "../configure/services/workflow/workflow.mjs";
+//#region src/vitest/workflow-local.d.ts
+type AnyWorkflowJob = WorkflowJob<string, any, any>;
+type AnyWorkflow = Workflow<AnyWorkflowJob>;
+type WorkflowInput<W extends AnyWorkflow> = W["mainJob"] extends WorkflowJob<string, infer I, any> ? I : never;
+type WorkflowOutput<W extends AnyWorkflow> = W["mainJob"] extends WorkflowJob<string, any, infer O> ? Awaited<O> : never;
+interface RunWorkflowLocallyOptions {
+  /** Env passed to workflow job bodies during this local run. */
+  env?: TailorEnv;
+}
+/**
+ * Run a workflow's main job and dependent job triggers locally with real job bodies.
+ *
+ * Use this for local full-chain workflow tests. Regular `.trigger()` calls
+ * delegate to the platform workflow runtime and should be mocked with
+ * `mockWorkflow()` when you are not intentionally running the local chain.
+ * @param workflow - Workflow definition to run
+ * @returns The main job output
+ */
+declare function runWorkflowLocally<W extends Workflow<WorkflowJob<string, undefined, any>>>(workflow: W): Promise<WorkflowOutput<W>>;
+/**
+ * Run a no-input workflow locally with optional runner settings.
+ * @param workflow - Workflow definition to run
+ * @param args - Must be `undefined` for no-input workflows
+ * @param options - Local runner options
+ * @returns The main job output
+ */
+declare function runWorkflowLocally<W extends Workflow<WorkflowJob<string, undefined, any>>>(workflow: W, args: undefined, options?: RunWorkflowLocallyOptions): Promise<WorkflowOutput<W>>;
+/**
+ * Run a workflow locally with real job bodies.
+ * @param workflow - Workflow definition to run
+ * @param args - Arguments passed to the workflow's main job
+ * @param options - Local runner options
+ * @returns The main job output
+ */
+declare function runWorkflowLocally<W extends AnyWorkflow>(workflow: W, args: WorkflowInput<W>, options?: RunWorkflowLocallyOptions): Promise<WorkflowOutput<W>>;
+//#endregion
+export { RunWorkflowLocallyOptions, runWorkflowLocally };

package/dist/{workflow-DgemCAz3.mjs → workflow-Bo59B75H.mjs}

@@ -3,6 +3,7 @@ import { t as __exportAll } from "./rolldown-runtime-DXywRVcq.mjs";
 //#region src/runtime/workflow.ts
 var workflow_exports = /* @__PURE__ */ __exportAll({
 	resolve: () => resolve,
+	resumeWorkflow: () => resumeWorkflow,
 	triggerJobFunction: () => triggerJobFunction,
 	triggerWorkflow: () => triggerWorkflow,
 	wait: () => wait
@@ -10,10 +11,21 @@ var workflow_exports = /* @__PURE__ */ __exportAll({
 const api = () => globalThis.tailor.workflow;
 /**
 * See {@link TailorWorkflowAPI.triggerWorkflow}.
-* @param args - Forwarded to {@link TailorWorkflowAPI.triggerWorkflow}
+* @param workflowName - Workflow name as defined in tailor.config
+* @param args - Arguments forwarded to the workflow's main job
+* @param options - Optional trigger options
 * @returns The execution ID of the triggered workflow
 */
-const triggerWorkflow = (...args) => api().triggerWorkflow(...args);
+function triggerWorkflow(workflowName, args, options) {
+	if (options?.invoker === void 0) return api().triggerWorkflow(workflowName, args);
+	return api().triggerWorkflow(workflowName, args, { authInvoker: options.invoker });
+}
+/**
+* See {@link TailorWorkflowAPI.resumeWorkflow}.
+* @param args - Forwarded to {@link TailorWorkflowAPI.resumeWorkflow}
+* @returns The execution ID of the resumed workflow
+*/
+const resumeWorkflow = (...args) => api().resumeWorkflow(...args);
 /**
 * See {@link TailorWorkflowAPI.triggerJobFunction}.
 * @param args - Forwarded to {@link TailorWorkflowAPI.triggerJobFunction}
@@ -34,5 +46,5 @@ const wait = (...args) => api().wait(...args);
 const resolve = (...args) => api().resolve(...args);
 
 //#endregion
-export { workflow_exports as a, wait as i, triggerJobFunction as n, triggerWorkflow as r, resolve as t };
-//# sourceMappingURL=workflow-DgemCAz3.mjs.map
+export { wait as a, triggerWorkflow as i, resumeWorkflow as n, workflow_exports as o, triggerJobFunction as r, resolve as t };
+//# sourceMappingURL=workflow-Bo59B75H.mjs.map

package/dist/workflow-Bo59B75H.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-Bo59B75H.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 * @example\n * import { workflow } from \"@tailor-platform/sdk/runtime\";\n *\n * const executionId = await workflow.triggerWorkflow(\"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 triggerWorkflow}. */\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\n/**\n * Platform API surface for `tailor.workflow`. Describes the shape the platform\n * runtime injects on `globalThis.tailor.workflow`.\n *\n * Each method below is also re-exported as a top-level named export from this\n * module so callers can either `import * as workflow from\n * \"@tailor-platform/sdk/runtime/workflow\"` or pick individual methods.\n */\nexport interface TailorWorkflowAPI {\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 platform trigger options\n   * @returns The execution ID of the triggered workflow\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   * @param executionId - The execution to resume\n   * @returns The execution ID of the resumed workflow\n   */\n  resumeWorkflow(executionId: string): Promise<string>;\n\n  /**\n   * Triggers a job function and returns its result.\n   * @param jobName - Job name as defined in the workflow\n   * @param args - Arguments forwarded to the job\n   * @returns The job's return value\n   */\n  triggerJobFunction(jobName: string, args?: any): 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\nconst api = (): TailorWorkflowAPI =>\n  (globalThis as { tailor: { workflow: TailorWorkflowAPI } }).tailor.workflow;\n\n/**\n * See {@link TailorWorkflowAPI.triggerWorkflow}.\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 trigger options\n * @returns The execution ID of the triggered workflow\n */\nexport function 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.resumeWorkflow}.\n * @param args - Forwarded to {@link TailorWorkflowAPI.resumeWorkflow}\n * @returns The execution ID of the resumed workflow\n */\nexport const resumeWorkflow: TailorWorkflowAPI[\"resumeWorkflow\"] = (...args) =>\n  api().resumeWorkflow(...args);\n\n/**\n * See {@link TailorWorkflowAPI.triggerJobFunction}.\n * @param args - Forwarded to {@link TailorWorkflowAPI.triggerJobFunction}\n * @returns The job's return value\n */\nexport const triggerJobFunction: TailorWorkflowAPI[\"triggerJobFunction\"] = (...args) =>\n  api().triggerJobFunction(...args);\n\n/**\n * See {@link TailorWorkflowAPI.wait}.\n * @param args - Forwarded to {@link TailorWorkflowAPI.wait}\n * @returns The payload supplied by the corresponding `resolve` call\n */\nexport const wait: TailorWorkflowAPI[\"wait\"] = (...args) => api().wait(...args);\n\n/**\n * See {@link TailorWorkflowAPI.resolve}.\n * @param args - Forwarded to {@link TailorWorkflowAPI.resolve}\n * @returns A promise that resolves once the resolve has been recorded\n */\nexport const resolve: TailorWorkflowAPI[\"resolve\"] = (...args) => api().resolve(...args);\n"],"mappings":";;;;;;;;;;AA0FA,MAAM,YACH,WAA2D,OAAO;;;;;;;;AASrE,SAAgB,gBACd,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,MAAa,kBAAuD,GAAG,SACrE,IAAI,CAAC,CAAC,eAAe,GAAG,IAAI;;;;;;AAO9B,MAAa,sBAA+D,GAAG,SAC7E,IAAI,CAAC,CAAC,mBAAmB,GAAG,IAAI;;;;;;AAOlC,MAAa,QAAmC,GAAG,SAAS,IAAI,CAAC,CAAC,KAAK,GAAG,IAAI;;;;;;AAO9E,MAAa,WAAyC,GAAG,SAAS,IAAI,CAAC,CAAC,QAAQ,GAAG,IAAI"}