@tailor-platform/sdk 2.36.0 → 2.37.0

package/dist/vitest/migration-steps.d.mts

@@ -2,13 +2,18 @@
  * Run a multi-step migration script's `steps` in tests the way `tailor deploy`
  * does: in dependency order, each step in its own transaction.
  */
-/** A step as declared in a migration script's `steps`. */
+/**
+ * A step as declared in a migration script's `steps`.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface RunnableMigrationStep<Trx, Context> {
   /** Steps that must complete before this one starts. */
   readonly dependsOn?: readonly string[];
   /** The step body; it receives its own transaction. */
   run: (trx: Trx, context: Context) => Promise<unknown>;
 }
+/** **Beta:** This API may change in future releases. */
 export interface RunMigrationStepsOptions<Trx, Context extends {
   env: unknown;
 }> {
@@ -21,7 +26,11 @@ export interface RunMigrationStepsOptions<Trx, Context extends {
   /** Values passed as `env` to every step; defaults to `{}`. */
   env?: Context["env"];
 }
-/** Thrown by {@link runMigrationSteps} when a step fails. */
+/**
+ * Thrown by {@link runMigrationSteps} when a step fails.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export declare class MigrationStepError extends Error {
   /** The step that failed. */
   readonly step: string;
@@ -33,6 +42,8 @@ export declare class MigrationStepError extends Error {
  * Run a migration script's `steps` in the order `tailor deploy` runs them,
  * committing each step separately, so a test can observe what a failure in a
  * later step leaves behind.
+ *
+ * **Beta:** This API may change in future releases.
  * @param steps - The script's exported `steps`
  * @param options - Transaction runner and env
  * @returns Names of the steps that ran, in execution order

package/dist/vitest/mock-kysely.d.mts

@@ -1,5 +1,9 @@
 import { Kysely, OperationNode, OperationNodeKind, Transaction } from "kysely";
-/** A single statement executed against the mock, captured in order. */
+/**
+ * A single statement executed against the mock, captured in order.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface ExecutedQuery {
   /** The Kysely operation node kind, e.g. `"SelectQueryNode"`. */
   kind: OperationNodeKind;
@@ -22,7 +26,11 @@ type MockResult = MockRow[] | {
   numAffectedRows?: number | bigint;
 };
 type QueryResolver = (query: ExecutedQuery) => MockResult | undefined;
-/** Controls and assertions for a {@link createKyselyMock} instance. */
+/**
+ * Controls and assertions for a {@link createKyselyMock} instance.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface KyselyMock<DB> {
   /** The mock Kysely instance to run queries against. */
   db: Kysely<DB>;
@@ -53,6 +61,8 @@ export interface KyselyMock<DB> {
  * 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"]>()`.
+ *
+ * **Beta:** This API may change in future releases.
  * @returns A {@link KyselyMock} with the mock `db`, recorded queries, and result staging.
  */
 export declare function createKyselyMock<DB = Record<string, never>>(): KyselyMock<DB>;

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

@@ -2,13 +2,19 @@ import { AIGatewayName } from "@tailor-platform/sdk";
 interface AigatewayCall {
   name: AIGatewayName;
 }
-/** Initial fixtures for an AI Gateway mock. */
+/**
+ * Initial fixtures for an AI Gateway mock.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface MockAigatewayOptions {
   /** AI Gateway URLs available when the mock is acquired. */
   urls?: Partial<Record<AIGatewayName, string>>;
 }
 /**
  * Acquire a disposable mock for `tailor.aigateway`. Restored on dispose.
+ *
+ * **Beta:** This API may change in future releases.
  * @param options - Initial AI Gateway URL fixtures
  * @returns Disposable AI Gateway mock control object
  * @example

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

@@ -2,7 +2,11 @@ import { AuthConnectionTokenResult, ConnectionName } from "@tailor-platform/sdk"
 interface AuthConnectionCall {
   connectionName: ConnectionName;
 }
-/** Initial fixtures and fallback behavior for an AuthConnection mock. */
+/**
+ * Initial fixtures and fallback behavior for an AuthConnection mock.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface MockAuthconnectionOptions {
   /** Tokens available when the mock is acquired. */
   tokens?: Partial<Record<ConnectionName, AuthConnectionTokenResult>>;
@@ -11,6 +15,8 @@ export interface MockAuthconnectionOptions {
 }
 /**
  * Acquire a disposable mock for `tailor.authconnection`. Restored on dispose.
+ *
+ * **Beta:** This API may change in future releases.
  * @param options - Initial token fixtures and fallback behavior
  * @returns Disposable AuthConnection mock control object
  * @example

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

@@ -8,13 +8,19 @@ interface FileCall {
   fieldName: string;
   recordId: string;
 }
-/** Controls fallback behavior for File calls without a configured result. */
+/**
+ * Controls fallback behavior for File calls without a configured result.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface MockFileOptions {
   /** Return a type-compatible fixture or throw when no behavior is configured. */
   onUnhandled?: "fallback" | "error";
 }
 /**
  * Acquire a disposable mock for `tailordb.file`. Restored on dispose.
+ *
+ * **Beta:** This API may change in future releases.
  * @param options - Controls behavior for calls without a configured result
  * @returns Disposable File mock control object
  * @example
@@ -45,9 +51,9 @@ export declare function mockFile(options?: MockFileOptions): {
   calls: FileCall[];
   clear(): void;
   reset(): void;
+  delete: Mock<(namespace: string, tableName: string, fieldName: string, recordId: string) => Promise<void>>;
   download: Mock<(namespace: string, tableName: string, fieldName: string, recordId: string) => Promise<FileDownloadResponse>>;
   downloadAsBase64: Mock<(namespace: string, tableName: string, fieldName: string, recordId: string) => Promise<FileDownloadAsBase64Response>>;
-  delete: Mock<(namespace: string, tableName: string, fieldName: string, recordId: string) => Promise<void>>;
   getMetadata: Mock<(namespace: string, tableName: string, fieldName: string, recordId: string) => Promise<FileMetadata>>;
   downloadStream: Mock<(namespace: string, tableName: string, fieldName: string, recordId: string) => Promise<FileDownloadStreamResponse>>;
   uploadStream: Mock<(namespace: string, tableName: string, fieldName: string, recordId: string, readableStream: ReadableStream<Uint8Array | ArrayBuffer>, options?: FileUploadStreamOptions) => Promise<FileUploadResponse>>;

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

@@ -10,13 +10,19 @@ type ConvertMockProcedure = (input: string | Uint8Array | ArrayBuffer, fromEncod
 type ConvertBufferMockProcedure = (input: Uint8Array | ArrayBuffer, fromEncoding: string, toEncoding: string) => ConversionResult;
 type EncodeMockProcedure = (input: string, encoding: string) => ConversionResult;
 type TypedOperationMock<RuntimeProcedure, MockProcedure extends (...args: never[]) => unknown> = RuntimeProcedure & MockInstance<MockProcedure>;
-/** Controls how unconfigured Iconv operations are handled. */
+/**
+ * Controls how unconfigured Iconv operations are handled.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface MockIconvOptions {
   /** Return an empty type-compatible value or throw when no behavior is configured. */
   onUnhandled?: "fallback" | "error";
 }
 /**
  * Acquire a disposable mock for `tailor.iconv`. Restored on dispose.
+ *
+ * **Beta:** This API may change in future releases.
  * @param options - Fallback behavior for unconfigured operations
  * @returns Disposable Iconv mock control object
  * @example

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

@@ -7,7 +7,11 @@ interface IdpCall {
   args: unknown[];
   namespace: string;
 }
-/** Controls fallback behavior for IdP calls without a configured result. */
+/**
+ * Controls fallback behavior for IdP calls without a configured result.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface MockIdpOptions {
   /** Return a type-compatible fixture or throw when no behavior is configured. */
   onUnhandled?: "fallback" | "error";
@@ -15,6 +19,8 @@ export interface MockIdpOptions {
 type IdpNamespaceMocks = { [Method in IdpMethod]: Mock<IdpClientInstance[Method]>; };
 /**
  * Acquire a disposable mock for `tailor.idp`. Restored on dispose.
+ *
+ * **Beta:** This API may change in future releases.
  * @param options - Controls behavior for calls without a configured result
  * @returns Disposable IDP mock control object
  * @example

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

@@ -6,12 +6,18 @@ interface LogCall {
   message: string;
   attributes?: LogAttributes;
 }
-/** Initial fixtures for a logger mock. */
+/**
+ * Initial fixtures for a logger mock.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface MockLoggerOptions {}
 /**
  * Acquire a disposable mock for `tailor.logger`. Each method is a `vi.fn`, so
  * calls can be asserted directly; `calls` returns the `debug`/`info`/`warn`/
  * `error` entries in the order they were emitted. Restored on dispose.
+ *
+ * **Beta:** This API may change in future releases.
  * @param _options - Reserved for future initial fixtures
  * @returns Disposable logger mock control object
  * @example

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

@@ -4,7 +4,11 @@ interface SecretCall {
   name?: string;
   names?: readonly string[];
 }
-/** Initial fixtures for a Secret Manager mock. */
+/**
+ * Initial fixtures for a Secret Manager mock.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface MockSecretmanagerOptions {
   /** Secrets to merge over fixtures inherited from the currently installed mock. */
   secrets?: Record<string, Record<string, string>>;
@@ -14,6 +18,8 @@ export interface MockSecretmanagerOptions {
  * 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.
+ *
+ * **Beta:** This API may change in future releases.
  * @param options - Initial Secret Manager fixtures
  * @returns Disposable SecretManager mock control object
  * @example

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

@@ -1,5 +1,9 @@
 import { PGliteClient } from "../pglite-kysely.mjs";
-/** A query executed through the PGlite-backed TailorDB client. */
+/**
+ * A query executed through the PGlite-backed TailorDB client.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface ExecutedPGliteQuery {
   /** Namespace of the `getDB` call that issued the query. */
   namespace: string;
@@ -8,7 +12,11 @@ export interface ExecutedPGliteQuery {
   /** Parameter values bound to the placeholders. */
   params: unknown[];
 }
-/** Options for {@link mockTailordbWithPGlite}. */
+/**
+ * Options for {@link mockTailordbWithPGlite}.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface MockTailordbPGliteOptions {
   /**
    * PGlite instance per `getDB` namespace. A `getDB` call for a namespace
@@ -28,6 +36,8 @@ interface CreatedClient {
  * PGlite instances are borrowed, never closed — close them yourself (e.g. in
  * `afterAll`).
  *
+ * **Beta:** This API may change in future releases.
+ *
  * Create the tables a test needs up front: run the script `kyselyTypePlugin`
  * writes when `pgliteSchemaPath` is set, or your own `CREATE TABLE`
  * statements matching the generated Kysely types. PGlite runs full PostgreSQL

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

@@ -1,19 +1,35 @@
 type QueryResolver = (query: string, params: unknown[]) => unknown[] | undefined;
-/** Controls how unmatched TailorDB queries are handled. */
+/**
+ * Controls how unmatched TailorDB queries are handled.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface MockTailordbOptions {
   /** Return an empty result or throw when no configured query behavior matches. */
   onUnhandled?: "fallback" | "error";
 }
-/** Matches a TailorDB query by SQL text and optionally by parameters. */
+/**
+ * Matches a TailorDB query by SQL text and optionally by parameters.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface QueryMatch {
   /** Exact SQL text or regular expression to match. */
   sql: string | RegExp;
   /** Exact parameters or a predicate for parameter matching. */
   params?: readonly unknown[] | ((params: unknown[]) => boolean);
 }
-/** Selects TailorDB queries that receive a configured response. */
+/**
+ * Selects TailorDB queries that receive a configured response.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export type QueryMatcher = string | RegExp | QueryMatch | ((query: string, params: unknown[]) => boolean);
-/** Configures persistent and one-time responses for matched queries. */
+/**
+ * Configures persistent and one-time responses for matched queries.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface QueryBehavior<Row> {
   /** Return these rows for every matching query after one-time responses are consumed. */
   returnsRows(rows: Row[]): QueryBehavior<Row>;
@@ -43,6 +59,8 @@ declare class MockQueryResult {
  * `tailordb.Client` whose `queryObject` is a shared `vi.fn()` (so query
  * responses can be staged before the client is constructed). Restored on
  * dispose.
+ *
+ * **Beta:** This API may change in future releases.
  * @param options - Query fallback behavior
  * @returns Disposable TailorDB mock control object
  * @example

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

@@ -22,7 +22,8 @@ type WaitPayload<Payload> = [Payload] extends [undefined] ? undefined : Payload;
 /**
  * Acquire a disposable mock for workflow operations (`tailor.workflow`).
  * Restored on dispose.
-
+ *
+ * **Beta:** This API may change in future releases.
  * @returns Disposable workflow mock control object
  * @example
  * ```typescript

package/dist/vitest/pglite-kysely.d.mts

@@ -1,6 +1,10 @@
 import { PGliteField } from "./pglite-temporal.mjs";
 import { ColumnType, Kysely } from "kysely";
-/** Result of a {@link PGliteClient.query} call. */
+/**
+ * Result of a {@link PGliteClient.query} call.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface PGliteQueryResult {
   /** Rows returned by the statement. */
   rows: unknown[];
@@ -17,6 +21,8 @@ export interface PGliteQueryResult {
  * The subset of a `@electric-sql/pglite` `PGlite` instance used by
  * {@link createKyselyPGlite}. Any client with a compatible `query`/`close`
  * pair works.
+ *
+ * **Beta:** This API may change in future releases.
  */
 export interface PGliteClient {
   /** Run a single SQL statement with positional (`$1`, `$2`, ...) parameters. */
@@ -30,6 +36,8 @@ type UnmigratedColumn<C> = C extends ColumnType<infer S, infer I, infer U> ? Col
  * `DB` as its rows stand before the migration script has run: every column
  * accepts on insert and update whatever it can still hold on read.
  *
+ * **Beta:** This API may change in future releases.
+ *
  * The generated `db.ts` types a column the migration makes required as
  * `ColumnType<T | null, T, T>`, and an enum whose values it narrows as
  * `ColumnType<Before, After, After>`, so `migrate.ts` cannot write a null
@@ -45,7 +53,11 @@ type UnmigratedColumn<C> = C extends ColumnType<infer S, infer I, infer U> ? Col
  * ```
  */
 export type Unmigrated<DB> = { [T in keyof DB]: { [C in keyof DB[T]]: UnmigratedColumn<DB[T][C]>; }; };
-/** Options for {@link createKyselyPGlite}. */
+/**
+ * Options for {@link createKyselyPGlite}.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface CreateKyselyPGliteOptions {
   /**
    * Read date/datetime/time columns back as `Temporal.PlainDate`/`Temporal.Instant`/
@@ -61,6 +73,8 @@ export interface CreateKyselyPGliteOptions {
  * {@link Unmigrated} so the test can stage the rows the script has not yet
  * backfilled: `createKyselyPGlite<Unmigrated<Database>>(new PGlite())`.
  *
+ * **Beta:** This API may change in future releases.
+ *
  * PGlite runs full PostgreSQL while TailorDB supports a subset of it, so a
  * statement passing here can still be rejected by the platform; keep a
  * statement-level test (see `createKyselyMock`) alongside.
@@ -93,6 +107,8 @@ export declare function createKyselyPGlite<DB = Record<string, never>>(client: P
  * throws, so the script under test still runs against checked relations, and calls that are nested
  * or overlap keep relations unchecked until all of them are done. NOT NULL, UNIQUE, and CHECK
  * constraints stay enforced.
+ *
+ * **Beta:** This API may change in future releases.
  * @param client - The PGlite instance the rows are written to
  * @param prepare - Writes the rows, for example with the Kysely instance of the same client
  * @returns Whatever `prepare` returns

package/dist/vitest/pglite-temporal.d.mts

@@ -1,4 +1,8 @@
-/** Name and Postgres type OID of a column PGlite returned. */
+/**
+ * Name and Postgres type OID of a column PGlite returned.
+ *
+ * **Beta:** This API may change in future releases.
+ */
 export interface PGliteField {
   /** Column name */
   name: string;

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

@@ -6,6 +6,7 @@ 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;
+/** **Beta:** This API may change in future releases. */
 export interface RunWorkflowLocallyOptions {
   /** Env passed to workflow job bodies during this local run. */
   env?: TailorEnv;
@@ -13,6 +14,8 @@ export interface RunWorkflowLocallyOptions {
 /**
  * Run a workflow's main job and dependent job starts locally with real job bodies.
  *
+ * **Beta:** This API may change in future releases.
+ *
  * Use this for local full-chain workflow tests. Regular `.start()` calls
  * delegate to the platform workflow runtime and should be mocked with
  * `mockWorkflow()` when you are not intentionally running the local chain.
@@ -22,6 +25,8 @@ export interface RunWorkflowLocallyOptions {
 export 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.
+ *
+ * **Beta:** This API may change in future releases.
  * @param workflow - Workflow definition to run
  * @param args - Must be `undefined` for no-input workflows
  * @param options - Local runner options
@@ -30,6 +35,8 @@ export declare function runWorkflowLocally<W extends Workflow<WorkflowJob<string
 export 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.
+ *
+ * **Beta:** This API may change in future releases.
  * @param workflow - Workflow definition to run
  * @param args - Arguments passed to the workflow's main job
  * @param options - Local runner options