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

package/dist/vitest/index.d.mts

@@ -1,430 +1,16 @@
-import { V as TailorEnv } from "../types-DCUhgpyI.mjs";
-import { i as Workflow, s as WorkflowJob } from "../index-ZePLwxw7.mjs";
-import { Kysely, OperationNode, OperationNodeKind, Transaction } from "kysely";
-import { Mock } from "vitest";
+import { MockAigatewayOptions, mockAigateway } from "./mocks/aigateway.mjs";
+import { MockAuthconnectionOptions, mockAuthconnection } from "./mocks/authconnection.mjs";
+import { MockFileOptions, mockFile } from "./mocks/file.mjs";
+import { MockIconvOptions, mockIconv } from "./mocks/iconv.mjs";
+import { MockIdpOptions, mockIdp } from "./mocks/idp.mjs";
+import { MockLoggerOptions, mockLogger } from "./mocks/logger.mjs";
+import { MockSecretmanagerOptions, mockSecretmanager } from "./mocks/secretmanager.mjs";
+import { MockTailordbOptions, QueryBehavior, QueryMatch, QueryMatcher, mockTailordb } from "./mocks/tailordb.mjs";
+import { mockWorkflow } from "./mocks/workflow.mjs";
+import "./mock.mjs";
+import { RunWorkflowLocallyOptions, runWorkflowLocally } from "./workflow-local.mjs";
+import { ExecutedQuery, KyselyMock, createKyselyMock } from "./mock-kysely.mjs";
 import { Plugin } from "vitest/config";
-
-//#region src/vitest/mock.d.ts
-type QueryResolver$1 = (query: string, params: unknown[]) => unknown[];
-type JobHandler = (jobName: string, args: unknown) => unknown;
-type IdpResolver = (method: string, args: unknown[], namespace: string) => unknown;
-type FileResolver = (method: string, call: FileCall) => unknown;
-type IconvResolver = (method: string, args: unknown[]) => unknown;
-type TriggerWorkflowOptions = {
-  authInvoker?: {
-    namespace: string;
-    machineUserName: string;
-  };
-};
-type TriggerHandlerFn = (workflowName: string, args: unknown, options?: TriggerWorkflowOptions) => 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 ExecutedQuery$1 {
-  query: string;
-  params: unknown[];
-}
-interface CreatedClient {
-  namespace: string | undefined;
-  ended: boolean;
-}
-interface TriggeredJob {
-  jobName: string;
-  args: unknown;
-}
-interface SecretCall {
-  method: "getSecret" | "getSecrets";
-  vault: string;
-  name?: string;
-  names?: readonly string[];
-}
-interface AuthConnectionCall {
-  connectionName: string;
-}
-interface IdpCall {
-  method: string;
-  args: unknown[];
-  namespace: string;
-}
-interface FileCall {
-  method: string;
-  namespace: string;
-  typeName: string;
-  fieldName: string;
-  recordId: string;
-}
-interface IconvCall {
-  method: string;
-  args: unknown[];
-}
-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: Mock<(this: any, config?: {
-    namespace?: string;
-  }) => void>; /** The shared `queryObject` `vi.fn` used by every client and transaction. */
-  queryObject: 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$1): 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$1[];
-  /**
-   * 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;
-/**
- * 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: Mock<(jobName: string, _args?: unknown) => unknown>; /** The `triggerWorkflow` `vi.fn`. */
-  triggerWorkflow: Mock<(_workflowName: string, _args?: unknown, _options?: TriggerWorkflowOptions) => Promise<string>>; /** The `wait` `vi.fn`. */
-  wait: Mock<(_key: string, _payload?: unknown) => unknown>; /** The `resolve` `vi.fn`. */
-  resolve: 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 `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 `runWorkflowLocally()`.
-   * 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;
-/**
- * Acquire a disposable mock for `tailor.secretmanager`. The secret store is
- * inherited (cloned) from the currently-installed mock on acquisition and
- * restored on dispose, so secrets seeded outside the test survive across
- * `using` scopes while per-test `setSecrets()` overrides stay isolated.
- * @returns Disposable SecretManager mock control object
- * @example
- * ```typescript
- * import { mockSecretmanager } from "@tailor-platform/sdk/vitest";
- *
- * test("reads secrets from vault", async () => {
- *   using sm = mockSecretmanager();
- *   sm.setSecrets({ "my-vault": { API_KEY: "sk-123" } });
- *   // …
- * });
- * ```
- */
-declare function mockSecretmanager(): {
-  /** The `getSecret` `vi.fn`. */getSecret: Mock<(vault: string, name: string) => Promise<string | undefined>>; /** The `getSecrets` `vi.fn`. */
-  getSecrets: Mock<(<const T extends readonly string[]>(vault: string, names: T) => Promise<Partial<Record<T[number], string>>>)>;
-  setSecrets(secrets: Record<string, Record<string, string>>): void;
-  readonly calls: SecretCall[];
-  reset(): void;
-} & Disposable;
-/**
- * Acquire a disposable mock for `tailor.authconnection`. Restored on dispose.
- * @returns Disposable AuthConnection mock control object
- * @example
- * ```typescript
- * import { mockAuthconnection } from "@tailor-platform/sdk/vitest";
- *
- * test("returns configured token", async () => {
- *   using ac = mockAuthconnection();
- *   ac.setTokens({ google: { access_token: "ya29.xxx" } });
- *   // …
- * });
- * ```
- */
-declare function mockAuthconnection(): {
-  /** The `getConnectionToken` `vi.fn`. */getConnectionToken: Mock<(connectionName: string) => Promise<any>>;
-  setTokens(value: Record<string, unknown>): void;
-  readonly calls: AuthConnectionCall[];
-  reset(): void;
-} & Disposable;
-/**
- * Acquire a disposable mock for `tailor.idp`. Restored on dispose.
- * @returns Disposable IDP mock control object
- * @example
- * ```typescript
- * import { mockIdp } from "@tailor-platform/sdk/vitest";
- *
- * test("resolver-based", async () => {
- *   using idp = mockIdp();
- *   idp.setResolver((method) =>
- *     method === "user" ? { id: "u-1", name: "alice", disabled: false } : null,
- *   );
- *   // …
- * });
- * ```
- */
-declare function mockIdp(): {
-  /** The mock IDP `Client` constructor (`vi.fn`). */Client: Mock;
-  setResolver(value: IdpResolver): void;
-  /**
-   * Enqueue a single result for the next IDP call (FIFO; falls back to
-   * `setResolver` when exhausted).
-   * @param result - Result to return from the next IDP call
-   */
-  enqueueResult(result: unknown): void;
-  /**
-   * Enqueue results for multiple subsequent IDP calls.
-   * @param results - Results to enqueue, one per upcoming call
-   */
-  enqueueResults(...results: unknown[]): void;
-  readonly calls: IdpCall[];
-  reset(): void;
-} & Disposable;
-/**
- * Acquire a disposable mock for `tailor.iconv`. Restored on dispose.
- * @returns Disposable Iconv mock control object
- * @example
- * ```typescript
- * import { mockIconv } from "@tailor-platform/sdk/vitest";
- *
- * test("mock encoding conversion", () => {
- *   using iconv = mockIconv();
- *   iconv.setResolver((method) => (method === "decode" ? "decoded-text" : null));
- *   // …
- * });
- * ```
- */
-declare function mockIconv(): {
-  setResolver(value: IconvResolver): void;
-  readonly calls: IconvCall[];
-  reset(): void;
-} & Disposable;
-/**
- * Acquire a disposable mock for `tailordb.file`. Restored on dispose.
- * @returns Disposable File mock control object
- * @example
- * ```typescript
- * import { mockFile } from "@tailor-platform/sdk/vitest";
- *
- * test("mock file download", async () => {
- *   using file = mockFile();
- *   file.enqueueResult({ data: new Uint8Array([1, 2, 3]), metadata: { ... } });
- *   // …
- * });
- * ```
- */
-declare function mockFile(): {
-  setResolver(value: FileResolver): void;
-  /**
-   * Enqueue a single result for the next `tailordb.file` call (FIFO; falls
-   * back to `setResolver` when exhausted).
-   * @param result - Result to return from the next file call
-   */
-  enqueueResult(result: unknown): void;
-  /**
-   * Enqueue results for multiple subsequent `tailordb.file` calls.
-   * @param results - Results to enqueue, one per upcoming call
-   */
-  enqueueResults(...results: unknown[]): void;
-  readonly calls: FileCall[];
-  reset(): void;
-} & Disposable;
-//#endregion
-//#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
-//#region src/vitest/mock-kysely.d.ts
-/** A single statement executed against the mock, captured in order. */
-interface ExecutedQuery {
-  /** The Kysely operation node kind, e.g. `"SelectQueryNode"`. */
-  kind: OperationNodeKind;
-  /** The compiled SQL string. */
-  sql: string;
-  /** The bound parameter values, in positional order. */
-  parameters: readonly unknown[];
-  /** The compiled Kysely operation node. */
-  node: OperationNode;
-  /** One `{ column: value }` map per row written by an insert. */
-  insertRows: () => Record<string, unknown>[];
-  /** The `{ column: value }` map written by a single-row insert. */
-  insertValues: () => Record<string, unknown>;
-  /** The `{ column: value }` map written by an update's SET clause. */
-  updateValues: () => Record<string, unknown>;
-}
-type MockRow = Record<string, unknown>;
-type MockResult = MockRow[] | {
-  rows?: MockRow[];
-  numAffectedRows?: number | bigint;
-};
-type QueryResolver = (query: ExecutedQuery) => MockResult | undefined;
-/** Controls and assertions for a {@link createKyselyMock} instance. */
-interface KyselyMock<DB> {
-  /** The mock Kysely instance to run queries against. */
-  db: Kysely<DB>;
-  /** Every recorded query, in execution order. */
-  executedQueries: ExecutedQuery[];
-  /** Recorded SELECT queries. */
-  selects: ExecutedQuery[];
-  /** Recorded INSERT queries. */
-  inserts: ExecutedQuery[];
-  /** Recorded UPDATE queries. */
-  updates: ExecutedQuery[];
-  /** Recorded DELETE queries. */
-  deletes: ExecutedQuery[];
-  /** Stage the rows the next query returns. */
-  enqueueResult: (result: MockResult) => void;
-  /** Stage the rows for several upcoming queries, consumed in order. */
-  enqueueResults: (...results: MockResult[]) => void;
-  /** Set a resolver that returns rows by inspecting each query. */
-  setQueryResolver: (resolver: QueryResolver) => void;
-  /** Run `fn` inside a real transaction and return its result. */
-  withTx: <R>(fn: (trx: Transaction<DB>) => Promise<R>) => Promise<R>;
-  /** Clear recorded queries and staged results. */
-  reset: () => void;
-  /** Same as {@link KyselyMock.reset}; enables `using` disposal. */
-  [Symbol.dispose]: () => void;
-}
-/**
- * Create a mock Kysely instance for unit-testing code that runs Kysely queries.
- * Pass the namespace schema as the type argument, e.g.
- * `createKyselyMock<Namespace["main-db"]>()`.
- * @returns A {@link KyselyMock} with the mock `db`, recorded queries, and result staging.
- */
-declare function createKyselyMock<DB = Record<string, never>>(): KyselyMock<DB>;
-//#endregion
 //#region src/vitest/index.d.ts
 /**
  * Creates Vitest plugins that emulate the Tailor Platform function runtime environment.
@@ -447,7 +33,8 @@ declare function createKyselyMock<DB = Record<string, never>>(): KyselyMock<DB>;
  *
  * 3. **Platform API mocks** (environment) — All platform APIs are auto-injected with
  *    control objects: `mockTailordb`, `mockWorkflow`, `mockSecretmanager`,
- *    `mockAuthconnection`, `mockIdp`, `mockFile`, `mockIconv`. Each
+ *    `mockAuthconnection`, `mockIdp`, `mockFile`, `mockIconv`, `mockAigateway`,
+ *    `mockLogger`. Each
  *    provides response configuration, call recording, and reset.
  *
  * 4. **Environment resolution** — Rewrites `environment: "tailor-runtime"` to the
@@ -484,5 +71,4 @@ declare function tailorRuntime(options?: {
   config?: string;
 }): Plugin[];
 //#endregion
-export { type ExecutedQuery, type KyselyMock, type RunWorkflowLocallyOptions, createKyselyMock, mockAuthconnection, mockFile, mockIconv, mockIdp, mockSecretmanager, mockTailordb, mockWorkflow, runWorkflowLocally, tailorRuntime };
-//# sourceMappingURL=index.d.mts.map
+export { type ExecutedQuery, type KyselyMock, type MockAigatewayOptions, type MockAuthconnectionOptions, type MockFileOptions, type MockIconvOptions, type MockIdpOptions, type MockLoggerOptions, type MockSecretmanagerOptions, type MockTailordbOptions, type QueryBehavior, type QueryMatch, type QueryMatcher, type RunWorkflowLocallyOptions, createKyselyMock, mockAigateway, mockAuthconnection, mockFile, mockIconv, mockIdp, mockLogger, mockSecretmanager, mockTailordb, mockWorkflow, runWorkflowLocally, tailorRuntime };