@tailor-platform/sdk 1.74.0 → 1.75.0

package/dist/registry-NfSW0BRo.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry-NfSW0BRo.mjs","names":[],"sources":["../src/utils/test/platform-serialize.ts","../src/configure/services/workflow/test-env-key.ts","../src/configure/services/workflow/registry.ts"],"sourcesContent":["/**\n * Validate and serialize a value as it would cross the Platform JSON boundary.\n *\n * Mirrors the runtime checks the platform performs on workflow arguments,\n * wait payloads, and trigger inputs so that local tests fail in the same\n * places production fails.\n *\n * Throws on:\n * - `NaN` / `Infinity` / `-Infinity` (`JSON.stringify` would silently emit `null`)\n * - `BigInt` (TypeError is thrown by `JSON.stringify`; we emit a clearer message)\n * - Non-plain objects (class instances, including `Date`, `Map`, `Set`, `Error`,\n *   and user-defined DTOs whose prototype is not `Object.prototype`)\n *\n * The replacer reads `this[key]` so the check sees the original value before\n * any `toJSON` conversion (e.g. `Date.prototype.toJSON`).\n * @param value - Value to validate and round-trip\n * @returns The JSON-normalized value (undefined/function properties stripped, etc.)\n */\nexport function platformSerialize<T>(value: T): T {\n  // Top-level undefined is allowed (jobs may take no input).\n  if (value === undefined) return undefined as T;\n\n  // Root function/symbol stringify to `undefined`; throw a specific message here.\n  if (typeof value === \"function\") {\n    throw new TypeError(\"platformSerialize: function is not JSON-serializable at <root>\");\n  }\n  if (typeof value === \"symbol\") {\n    throw new TypeError(\"platformSerialize: Symbol is not JSON-serializable at <root>\");\n  }\n\n  const serialized = JSON.stringify(value, function (key, val) {\n    if (typeof val === \"number\" && !Number.isFinite(val)) {\n      throw new TypeError(\n        `platformSerialize: non-finite number at ${formatPath(key)}: ${String(val)}`,\n      );\n    }\n    if (typeof val === \"bigint\") {\n      throw new TypeError(\n        `platformSerialize: BigInt is not JSON-serializable at ${formatPath(key)}`,\n      );\n    }\n    // Look at the pre-toJSON value so Date/Map/Set/etc. can be detected.\n    const raw = (this as Record<string, unknown>)[key];\n    if (raw !== null && typeof raw === \"object\" && !Array.isArray(raw)) {\n      const proto = Object.getPrototypeOf(raw);\n      if (proto !== Object.prototype && proto !== null) {\n        const ctor = (raw as { constructor?: { name?: string } }).constructor?.name ?? \"anonymous\";\n        throw new TypeError(\n          `platformSerialize: non-plain object at ${formatPath(key)} (${ctor} instance)`,\n        );\n      }\n    }\n    return val;\n  });\n\n  // `JSON.stringify` returns `undefined` when the root collapses (e.g. a `toJSON`\n  // returning `undefined`); parsing that would throw opaquely.\n  // JSON.stringify returns undefined for non-serializable values\n  // oxlint-disable-next-line typescript/no-unnecessary-condition\n  if (serialized === undefined) {\n    throw new TypeError(\"platformSerialize: value is not JSON-serializable at <root>\");\n  }\n\n  return JSON.parse(serialized) as T;\n}\n\nfunction formatPath(key: string): string {\n  return key === \"\" ? \"<root>\" : `\"${key}\"`;\n}\n","/**\n * Typed accessors for the test-time globalThis slot used to pass `env` from\n * `mockWorkflow().setEnv()` (in `@tailor-platform/sdk/vitest`) to\n * `createWorkflowJob().trigger()` bodies. The slot key is private to this\n * module; callers go through the get/set/clear functions below so both sides\n * share the same access path.\n *\n * Lives in its own file (with no `@/` imports) so `vitest/mock.ts` can load\n * it from nested Vitest configs that do not resolve `@/` aliases.\n * @internal\n */\nimport type { TailorEnv, TailorInvoker } from \"../../../runtime/types\";\n\nconst SLOT_KEY = \"__tailorWorkflowTestEnv\";\n\n/**\n * Read the test-time env slot.\n * @returns Current env, or `undefined` when unset.\n * @internal\n */\nexport function readWorkflowTestEnv(): TailorEnv | undefined {\n  return (globalThis as unknown as Record<string, TailorEnv | undefined>)[SLOT_KEY];\n}\n\n/**\n * Write the test-time env slot.\n * @param env - Env value to expose to `.trigger()` bodies.\n * @internal\n */\nexport function writeWorkflowTestEnv(env: TailorEnv): void {\n  (globalThis as unknown as Record<string, TailorEnv>)[SLOT_KEY] = env;\n}\n\n/**\n * Clear the test-time env slot.\n * @internal\n */\nexport function clearWorkflowTestEnv(): void {\n  delete (globalThis as unknown as Record<string, unknown>)[SLOT_KEY];\n}\n\n/**\n * Env-var fallback read by `.trigger()` when `mockWorkflow().setEnv()` is unset.\n * @deprecated Use `mockWorkflow().setEnv()` from `@tailor-platform/sdk/vitest`.\n * @internal\n */\nexport const WORKFLOW_TEST_ENV_KEY = \"TAILOR_TEST_WORKFLOW_ENV\";\n\n// env from `mockWorkflow().setEnv()`, else the deprecated env-var. Shallow-copied\n// to isolate against cross-trigger mutation.\nexport function buildJobContext(): { env: TailorEnv; invoker?: TailorInvoker } {\n  const fromGlobal = readWorkflowTestEnv();\n  if (fromGlobal !== undefined) return { env: { ...fromGlobal } };\n  const raw = process.env[WORKFLOW_TEST_ENV_KEY];\n  if (!raw) return { env: {} as TailorEnv };\n  let parsed: unknown;\n  try {\n    parsed = JSON.parse(raw);\n  } catch (cause) {\n    throw new Error(\n      `Invalid JSON in ${WORKFLOW_TEST_ENV_KEY}; provide valid JSON or use mockWorkflow().setEnv().`,\n      { cause },\n    );\n  }\n  if (parsed === null || typeof parsed !== \"object\" || Array.isArray(parsed)) {\n    throw new Error(\n      `${WORKFLOW_TEST_ENV_KEY} must be a JSON object; provide a record or use mockWorkflow().setEnv().`,\n    );\n  }\n  return { env: { ...(parsed as TailorEnv) } };\n}\n","import { platformSerialize } from \"#/utils/test/platform-serialize\";\nimport { buildJobContext } from \"./test-env-key\";\nimport type { TailorEnv, TailorInvoker } from \"#/runtime/types\";\nimport type { TriggerJobFunctionOptions } from \"#/runtime/workflow\";\n\n/**\n * Body signature shared by workflow jobs at registry-write time.\n * The user's `createWorkflowJob`/`createWorkflow` body uses concrete types,\n * but the registry erases them for storage.\n */\nexport type RegisteredJobBody = (\n  args: unknown,\n  context: { env: TailorEnv; invoker?: TailorInvoker },\n) => unknown | Promise<unknown>;\n\nexport interface RegisteredWorkflow {\n  mainJobName: string;\n}\n\nconst JOB_REGISTRY_KEY: unique symbol = Symbol.for(\"tailor-platform/sdk:job-registry\");\nconst WORKFLOW_REGISTRY_KEY: unique symbol = Symbol.for(\"tailor-platform/sdk:workflow-registry\");\n\ntype PlatformWorkflow = {\n  triggerWorkflow: (name: string, args?: unknown, options?: unknown) => Promise<string>;\n  triggerJobFunction: (\n    name: string,\n    args?: unknown,\n    options?: TriggerJobFunctionOptions,\n  ) => unknown;\n};\n\ntype GlobalWithRegistry = typeof globalThis & {\n  [JOB_REGISTRY_KEY]?: Map<string, RegisteredJobBody>;\n  [WORKFLOW_REGISTRY_KEY]?: Map<string, RegisteredWorkflow>;\n  tailor?: { workflow?: PlatformWorkflow };\n};\n\nfunction jobs(): Map<string, RegisteredJobBody> {\n  const g = globalThis as GlobalWithRegistry;\n  let map = g[JOB_REGISTRY_KEY];\n  if (!map) {\n    map = new Map();\n    g[JOB_REGISTRY_KEY] = map;\n  }\n  return map;\n}\n\nfunction workflows(): Map<string, RegisteredWorkflow> {\n  const g = globalThis as GlobalWithRegistry;\n  let map = g[WORKFLOW_REGISTRY_KEY];\n  if (!map) {\n    map = new Map();\n    g[WORKFLOW_REGISTRY_KEY] = map;\n  }\n  return map;\n}\n\n/**\n * Register a job body keyed by job name. Called as a side effect by\n * `createWorkflowJob` so the vitest mock can execute the body when\n * `globalThis.tailor.workflow.triggerJobFunction(name, args)` is invoked.\n *\n * In production builds the bundler rewrites `.trigger()` calls so this registry\n * is never read; the gated write is dropped as dead code.\n * @param name - Job name\n * @param body - Job body function\n */\nexport function registerJob(name: string, body: RegisteredJobBody): void {\n  jobs().set(name, body);\n}\n\n/**\n * Look up a registered job body by name.\n * @param name - Job name\n * @returns The registered body, or undefined when no job is registered\n */\nexport function getRegisteredJob(name: string): RegisteredJobBody | undefined {\n  return jobs().get(name);\n}\n\n/**\n * Register a workflow's main job name so the mock can run the workflow locally.\n * @param name - Workflow name\n * @param mainJobName - Name of the workflow's main job\n */\nexport function registerWorkflow(name: string, mainJobName: string): void {\n  workflows().set(name, { mainJobName });\n}\n\n/**\n * Look up a registered workflow by name.\n * @param name - Workflow name\n * @returns The registered workflow, or undefined\n */\nexport function getRegisteredWorkflow(name: string): RegisteredWorkflow | undefined {\n  return workflows().get(name);\n}\n\nfunction currentPlatformWorkflow(): PlatformWorkflow | undefined {\n  // globalThis may not have the tailor property at runtime\n  // oxlint-disable-next-line typescript/no-unnecessary-condition\n  return (globalThis as GlobalWithRegistry).tailor?.workflow;\n}\n\n// A valid placeholder UUID, so callers that validate the execution id behave the\n// same locally as against the platform.\nexport const TRIGGER_DEFAULT = \"00000000-0000-4000-8000-000000000000\";\n\nfunction serializeReturn(out: unknown): unknown {\n  return out instanceof Promise ? out.then((v) => platformSerialize(v)) : platformSerialize(out);\n}\n\n// Runs the registered body across the platform JSON boundary. Shared by the\n// `tailor-runtime` default runner and the no-shim `.trigger()` fallback below.\nexport function runRegisteredJob(name: string, args?: unknown): unknown {\n  const body = getRegisteredJob(name);\n  const out = body ? body(platformSerialize(args), buildJobContext()) : null;\n  return serializeReturn(out);\n}\n\nexport async function runRegisteredWorkflow(name: string, args?: unknown): Promise<string> {\n  const workflow = getRegisteredWorkflow(name);\n  if (workflow) await runRegisteredJob(workflow.mainJobName, args);\n  return TRIGGER_DEFAULT;\n}\n\n// `.trigger()` routes through the installed `tailor.workflow` shim, falling back\n// to running the registered body/workflow locally when none is installed.\n// Preserve arity: the shim sees a 2-argument call when the caller supplied no\n// options, and a 3-argument call otherwise, mirroring the bundler rewrite so\n// mocks observe the same shape in local execution and in bundled workflows.\nexport function dispatchTriggerJob(\n  name: string,\n  args?: unknown,\n  options?: TriggerJobFunctionOptions,\n): unknown {\n  const workflow = currentPlatformWorkflow();\n  if (!workflow) return runRegisteredJob(name, args);\n  // oxlint-disable-next-line prefer-rest-params\n  return arguments.length >= 3\n    ? workflow.triggerJobFunction(name, args, options)\n    : workflow.triggerJobFunction(name, args);\n}\n\nexport function dispatchTriggerWorkflow(\n  name: string,\n  args?: unknown,\n  options?: unknown,\n): Promise<string> {\n  const workflow = currentPlatformWorkflow();\n  return workflow\n    ? workflow.triggerWorkflow(name, args, options)\n    : runRegisteredWorkflow(name, args);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAkBA,SAAgB,kBAAqB,OAAa;CAEhD,IAAI,UAAU,QAAW,OAAO;CAGhC,IAAI,OAAO,UAAU,YACnB,MAAM,IAAI,UAAU,gEAAgE;CAEtF,IAAI,OAAO,UAAU,UACnB,MAAM,IAAI,UAAU,8DAA8D;CAGpF,MAAM,aAAa,KAAK,UAAU,OAAO,SAAU,KAAK,KAAK;EAC3D,IAAI,OAAO,QAAQ,YAAY,CAAC,OAAO,SAAS,GAAG,GACjD,MAAM,IAAI,UACR,2CAA2C,WAAW,GAAG,EAAE,IAAI,OAAO,GAAG,GAC3E;EAEF,IAAI,OAAO,QAAQ,UACjB,MAAM,IAAI,UACR,yDAAyD,WAAW,GAAG,GACzE;EAGF,MAAM,MAAO,KAAiC;EAC9C,IAAI,QAAQ,QAAQ,OAAO,QAAQ,YAAY,CAAC,MAAM,QAAQ,GAAG,GAAG;GAClE,MAAM,QAAQ,OAAO,eAAe,GAAG;GACvC,IAAI,UAAU,OAAO,aAAa,UAAU,MAAM;IAChD,MAAM,OAAQ,IAA4C,aAAa,QAAQ;IAC/E,MAAM,IAAI,UACR,0CAA0C,WAAW,GAAG,EAAE,IAAI,KAAK,WACrE;GACF;EACF;EACA,OAAO;CACT,CAAC;CAMD,IAAI,eAAe,QACjB,MAAM,IAAI,UAAU,6DAA6D;CAGnF,OAAO,KAAK,MAAM,UAAU;AAC9B;AAEA,SAAS,WAAW,KAAqB;CACvC,OAAO,QAAQ,KAAK,WAAW,IAAI,IAAI;AACzC;;;;ACvDA,MAAM,WAAW;;;;;;AAOjB,SAAgB,sBAA6C;CAC3D,OAAQ,WAAgE;AAC1E;;;;;;AAOA,SAAgB,qBAAqB,KAAsB;CACzD,AAAC,WAAoD,YAAY;AACnE;;;;;AAMA,SAAgB,uBAA6B;CAC3C,OAAQ,WAAkD;AAC5D;;;;;;AAOA,MAAa,wBAAwB;AAIrC,SAAgB,kBAA+D;CAC7E,MAAM,aAAa,oBAAoB;CACvC,IAAI,eAAe,QAAW,OAAO,EAAE,KAAK,EAAE,GAAG,WAAW,EAAE;CAC9D,MAAM,MAAM,QAAQ,IAAI;CACxB,IAAI,CAAC,KAAK,OAAO,EAAE,KAAK,CAAC,EAAe;CACxC,IAAI;CACJ,IAAI;EACF,SAAS,KAAK,MAAM,GAAG;CACzB,SAAS,OAAO;EACd,MAAM,IAAI,MACR,mBAAmB,sBAAsB,uDACzC,EAAE,MAAM,CACV;CACF;CACA,IAAI,WAAW,QAAQ,OAAO,WAAW,YAAY,MAAM,QAAQ,MAAM,GACvE,MAAM,IAAI,MACR,GAAG,sBAAsB,yEAC3B;CAEF,OAAO,EAAE,KAAK,EAAE,GAAI,OAAqB,EAAE;AAC7C;;;;ACnDA,MAAM,mBAAkC,OAAO,IAAI,kCAAkC;AACrF,MAAM,wBAAuC,OAAO,IAAI,uCAAuC;AAiB/F,SAAS,OAAuC;CAC9C,MAAM,IAAI;CACV,IAAI,MAAM,EAAE;CACZ,IAAI,CAAC,KAAK;EACR,sBAAM,IAAI,IAAI;EACd,EAAE,oBAAoB;CACxB;CACA,OAAO;AACT;AAEA,SAAS,YAA6C;CACpD,MAAM,IAAI;CACV,IAAI,MAAM,EAAE;CACZ,IAAI,CAAC,KAAK;EACR,sBAAM,IAAI,IAAI;EACd,EAAE,yBAAyB;CAC7B;CACA,OAAO;AACT;;;;;;;;;;;AAYA,SAAgB,YAAY,MAAc,MAA+B;CACvE,KAAK,CAAC,CAAC,IAAI,MAAM,IAAI;AACvB;;;;;;AAOA,SAAgB,iBAAiB,MAA6C;CAC5E,OAAO,KAAK,CAAC,CAAC,IAAI,IAAI;AACxB;;;;;;AAOA,SAAgB,iBAAiB,MAAc,aAA2B;CACxE,UAAU,CAAC,CAAC,IAAI,MAAM,EAAE,YAAY,CAAC;AACvC;;;;;;AAOA,SAAgB,sBAAsB,MAA8C;CAClF,OAAO,UAAU,CAAC,CAAC,IAAI,IAAI;AAC7B;AAEA,SAAS,0BAAwD;CAG/D,OAAQ,WAAkC,QAAQ;AACpD;AAIA,MAAa,kBAAkB;AAE/B,SAAS,gBAAgB,KAAuB;CAC9C,OAAO,eAAe,UAAU,IAAI,MAAM,MAAM,kBAAkB,CAAC,CAAC,IAAI,kBAAkB,GAAG;AAC/F;AAIA,SAAgB,iBAAiB,MAAc,MAAyB;CACtE,MAAM,OAAO,iBAAiB,IAAI;CAElC,OAAO,gBADK,OAAO,KAAK,kBAAkB,IAAI,GAAG,gBAAgB,CAAC,IAAI,IAC5C;AAC5B;AAEA,eAAsB,sBAAsB,MAAc,MAAiC;CACzF,MAAM,WAAW,sBAAsB,IAAI;CAC3C,IAAI,UAAU,MAAM,iBAAiB,SAAS,aAAa,IAAI;CAC/D,OAAO;AACT;AAOA,SAAgB,mBACd,MACA,MACA,SACS;CACT,MAAM,WAAW,wBAAwB;CACzC,IAAI,CAAC,UAAU,OAAO,iBAAiB,MAAM,IAAI;CAEjD,OAAO,UAAU,UAAU,IACvB,SAAS,mBAAmB,MAAM,MAAM,OAAO,IAC/C,SAAS,mBAAmB,MAAM,IAAI;AAC5C;AAEA,SAAgB,wBACd,MACA,MACA,SACiB;CACjB,MAAM,WAAW,wBAAwB;CACzC,OAAO,WACH,SAAS,gBAAgB,MAAM,MAAM,OAAO,IAC5C,sBAAsB,MAAM,IAAI;AACtC"}

package/dist/runtime/globals.d.mts

@@ -1,8 +1,8 @@
+import { AuthInvoker, TriggerWorkflowOptions } from "./workflow.mjs";
 import { ContextInvoker } from "./context.mjs";
 import { TailorDBFileErrorCode } from "./file.mjs";
 import { IconvInstance } from "./iconv.mjs";
 import { ClientConfig, CreateUserInput, IdpClientInstance, ListUsersOptions, ListUsersResponse, SendPasswordResetEmailInput, UnenrollMfaInput, UpdateUserInput, User, UserQuery } from "./idp.mjs";
-import { AuthInvoker, TriggerWorkflowOptions } from "./workflow.mjs";
 import { TailorRuntime, TailordbClientInstance, TailordbCommandType, TailordbQueryResult, TailordbRuntime } from "./index.mjs";
 
 //#region src/runtime/globals.d.ts

package/dist/runtime/index.d.mts

@@ -1,3 +1,4 @@
+import { TailorWorkflowAPI, workflow_d_exports } from "./workflow.mjs";
 import { TailorAigatewayAPI, aigateway_d_exports } from "./aigateway.mjs";
 import { TailorAuthconnectionAPI, authconnection_d_exports } from "./authconnection.mjs";
 import { TailorContextAPI, context_d_exports } from "./context.mjs";
@@ -5,7 +6,6 @@ import { TailorDBFileAPI, file_d_exports } from "./file.mjs";
 import { TailorIconvAPI, iconv_d_exports } from "./iconv.mjs";
 import { TailorIdpAPI, idp_d_exports } from "./idp.mjs";
 import { TailorSecretmanagerAPI, secretmanager_d_exports } from "./secretmanager.mjs";
-import { TailorWorkflowAPI, workflow_d_exports } from "./workflow.mjs";
 
 //#region src/runtime/index.d.ts
 /** SQL command type recorded on a {@link TailordbQueryResult}. */

package/dist/runtime/workflow.d.mts

@@ -1,5 +1,5 @@
 declare namespace workflow_d_exports {
-  export { AuthInvoker, TailorWorkflowAPI, TriggerWorkflowOptions, resolve, resumeWorkflow, triggerJobFunction, triggerWorkflow, wait };
+  export { AuthInvoker, ExecutionPolicyKey, TailorWorkflowAPI, TriggerJobFunctionOptions, TriggerWorkflowOptions, resolve, resumeWorkflow, triggerJobFunction, triggerWorkflow, wait };
 }
 /**
  * Workflow utilities.
@@ -27,6 +27,24 @@ interface TriggerWorkflowOptions {
   /** Optional authentication invoker to specify which machine user should execute the workflow */
   authInvoker?: AuthInvoker;
 }
+declare const executionPolicyKeyBrand: unique symbol;
+/**
+ * A concrete runtime key produced by an execution policy instance — either an
+ * exact-match policy's `.key`, or a wildcard policy's `.keyFor(suffix)` (see
+ * `defineWorkflowExecutionPolicies`). Branded so an arbitrary string that
+ * wasn't derived from a declared policy can't be passed as `executionPolicyKey`.
+ */
+type ExecutionPolicyKey = string & {
+  readonly [executionPolicyKeyBrand]: never;
+};
+/** Options for {@link triggerJobFunction}. */
+interface TriggerJobFunctionOptions {
+  /**
+   * Execution policy key matched by the platform against the policies
+   * declared with `defineWorkflowExecutionPolicies` in `tailor.config.ts`.
+   */
+  executionPolicyKey?: ExecutionPolicyKey;
+}
 /**
  * Platform API surface for `tailor.workflow`. Describes the shape the platform
  * runtime injects on `globalThis.tailor.workflow`.
@@ -54,9 +72,10 @@ interface TailorWorkflowAPI {
    * Triggers a job function and returns its result.
    * @param jobName - Job name as defined in the workflow
    * @param args - Arguments forwarded to the job
+   * @param options - Optional trigger options (e.g. `executionPolicyKey`)
    * @returns The job's return value
    */
-  triggerJobFunction(jobName: string, args?: any): any;
+  triggerJobFunction(jobName: string, args?: any, options?: TriggerJobFunctionOptions): any;
   /**
    * Suspends the current workflow execution and waits for an external signal to resume.
    * @param key - Wait point key
@@ -104,4 +123,4 @@ declare const wait: TailorWorkflowAPI["wait"];
  */
 declare const resolve: TailorWorkflowAPI["resolve"];
 //#endregion
-export { AuthInvoker, TailorWorkflowAPI, TriggerWorkflowOptions, resolve, resumeWorkflow, triggerJobFunction, triggerWorkflow, wait, workflow_d_exports };
+export { AuthInvoker, ExecutionPolicyKey, TailorWorkflowAPI, TriggerJobFunctionOptions, TriggerWorkflowOptions, resolve, resumeWorkflow, triggerJobFunction, triggerWorkflow, wait, workflow_d_exports };