better-supabase 0.8.0 → 0.9.0

package/dist/types-CD6yCDx3.d.ts

@@ -1,359 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { t as AsyncResult, w as ErrorMapper } from "./result-BchM1XZn.js";
-import { t as BlockTransport } from "./block-transport-inD4fFq-.js";
-import { i as CredentialRef, o as CredentialToken, r as CredentialProvider } from "./provider-ib9wzUDz.js";
-import { r as BlockTemporalOptions } from "./block-helpers-C0Xj8War.js";
-import { a as WorkflowSchedule, u as WorkflowStarter } from "./workflows-CcpCBfIe.js";
-//#region src/blocks/workflow-builder/graph.d.ts
-type WorkflowNodeKind = "trigger" | "step" | "sleep" | "approval" | "condition";
-type WorkflowConditionOperator = "equals" | "notEquals" | "exists" | "truthy" | "greaterThan" | "lessThan" | "contains";
-/**
- * A test on the run's data. `path` starts at `input` (the trigger's input)
- * or `results` (each node's output by node id), e.g. `results.lookup.plan`.
- */
-interface WorkflowCondition {
-  readonly path: string;
-  readonly op: WorkflowConditionOperator;
-  readonly value?: unknown;
-}
-/**
- * One node of a graph. A `step` node calls the library step `step` with its
- * `config`; a `sleep` node waits `config.duration` (milliseconds, or `30s`,
- * `5m`, `2h`, `1d`); an `approval` node waits for its hook to be resumed;
- * a `condition` node tests `config` (a `WorkflowCondition`).
- */
-interface WorkflowGraphNode {
-  readonly id: string;
-  readonly kind: WorkflowNodeKind;
-  readonly label?: string;
-  readonly step?: string;
-  readonly config?: Readonly<Record<string, unknown>>;
-  /** Where the canvas draws it; the engines ignore it. */
-  readonly position?: {
-    readonly x: number;
-    readonly y: number;
-  };
-}
-/**
- * An edge runs its target after its source. From a `condition` or an
- * `approval` node, `branch` picks the outcome it follows (an approval is
- * `true` unless its payload has `approved: false`).
- */
-interface WorkflowGraphEdge {
-  readonly id: string;
-  readonly source: string;
-  readonly target: string;
-  readonly branch?: "true" | "false";
-}
-/** The engine-neutral graph a workflow version stores. */
-interface WorkflowGraph {
-  readonly nodes: readonly WorkflowGraphNode[];
-  readonly edges: readonly WorkflowGraphEdge[];
-}
-/** A sleep duration in milliseconds; `undefined` when `value` isn't one. */
-declare function durationMs(value: unknown): number | undefined;
-/** Whether `condition` holds for the run's data. */
-declare function evaluateCondition(condition: WorkflowCondition, scope: {
-  readonly input: unknown;
-  readonly results: unknown;
-}): boolean;
-/** Whether an approval payload approves: anything but `{ approved: false }`. */
-declare const approved: (payload: unknown) => boolean;
-/**
- * The nodes in an order that runs every source before its targets, keeping
- * the graph's order among independent nodes; `undefined` when edges form a
- * cycle.
- */
-declare function topologicalOrder(graph: WorkflowGraph): readonly WorkflowGraphNode[] | undefined;
-/**
- * Problems that keep `graph` from running, as messages; empty when it can.
- * Pass the step library's names to check that every step node uses one
- * (`publish` checks it again in SQL).
- */
-declare function validateGraph(graph: unknown, steps?: Iterable<string>): readonly string[];
-interface WorkflowGraphDiff {
-  readonly nodes: {
-    readonly added: readonly string[];
-    readonly removed: readonly string[];
-    /** Nodes whose kind, step, label or config changed; moving one doesn't count. */
-    readonly changed: readonly string[];
-  };
-  readonly edges: {
-    readonly added: readonly string[];
-    readonly removed: readonly string[];
-  };
-}
-/** What changed from `before` to `after`, by node id and by edge ends. */
-declare function diffGraphs(before: WorkflowGraph, after: WorkflowGraph): WorkflowGraphDiff;
-//#endregion
-//#region src/blocks/workflow-builder/types.d.ts
-type WorkflowVersionStatus = "draft" | "published" | "archived";
-type WorkflowTriggerKind = "manual" | "webhook" | "schedule" | "event" | "form" | "chat";
-type WorkflowNodeRunStatus = "running" | "waiting" | "completed" | "failed" | "skipped";
-interface WorkflowDefinition {
-  readonly id: string;
-  readonly tenant: string | undefined;
-  readonly slug: string;
-  readonly name: string;
-  readonly description: string | undefined;
-  readonly createdBy: string | undefined;
-  readonly createdAt: Temporal.Instant;
-  readonly updatedAt: Temporal.Instant;
-  /** The published version's number (lists only). */
-  readonly published?: number | undefined;
-  /** Whether a draft is open (lists only). */
-  readonly draft?: boolean;
-}
-interface WorkflowVersion {
-  readonly id: string;
-  readonly definition: string;
-  readonly version: number;
-  readonly status: WorkflowVersionStatus;
-  readonly createdBy: string | undefined;
-  readonly createdAt: Temporal.Instant;
-  readonly publishedAt: Temporal.Instant | undefined;
-  /** Set by `get`, `save` and `publish`; lists leave it out. */
-  readonly graph?: WorkflowGraph;
-  /** What the engine's `compile` returned on publish. */
-  readonly compiled?: unknown;
-}
-interface WorkflowTrigger {
-  readonly id: string;
-  readonly definition: string;
-  readonly kind: WorkflowTriggerKind;
-  /**
-   * `schedule`: `{ cron, timezone?, input? }`; `event`: `{ type }`; `form`:
-   * `{ schema }`; the others are the app's.
-   */
-  readonly config: Readonly<Record<string, unknown>>;
-  readonly enabled: boolean;
-  readonly createdAt: Temporal.Instant;
-  readonly updatedAt: Temporal.Instant;
-}
-/** A credential a tenant's steps use, by reference: the row never holds the secret. */
-interface WorkflowCredential {
-  readonly id: string;
-  readonly tenant: string | undefined;
-  /** What it is for, matched against a step's `credentialKind`. */
-  readonly kind: string;
-  readonly name: string;
-  readonly ref: CredentialRef;
-  readonly scopes: readonly string[];
-  readonly createdBy: string | undefined;
-  readonly createdAt: Temporal.Instant;
-}
-/** A step the deployment provides, as the builder's palette shows it. */
-interface WorkflowStepInfo {
-  readonly name: string;
-  readonly title: string;
-  readonly description?: string | undefined;
-  /** JSON Schema of the node's config. */
-  readonly inputSchema?: Readonly<Record<string, unknown>>;
-  readonly outputSchema?: Readonly<Record<string, unknown>>;
-  /** The credential kind the step resolves, when it needs one. */
-  readonly credentialKind?: string | undefined;
-}
-interface WorkflowNodeRun {
-  readonly run: string;
-  readonly node: string;
-  readonly status: WorkflowNodeRunStatus;
-  readonly attempts: number;
-  readonly output: unknown;
-  readonly error: string | undefined;
-  readonly startedAt: Temporal.Instant | undefined;
-  readonly endedAt: Temporal.Instant | undefined;
-}
-interface WorkflowAlert {
-  readonly id: string;
-  readonly definition: string;
-  readonly onEvent: "failed" | "slow";
-  /** Seconds a run may stay unfinished (slow alerts). */
-  readonly threshold: number | undefined;
-  /** Where the app sends it, e.g. `{ type: "email", to }`; the module only stores it. */
-  readonly channel: Readonly<Record<string, unknown>>;
-  readonly createdBy: string | undefined;
-  readonly createdAt: Temporal.Instant;
-}
-/** What `start` gets to start a run of a published version. */
-interface BuilderStartCall {
-  readonly definition: WorkflowDefinition;
-  /** The published version, with its graph and compiled form. */
-  readonly version: WorkflowVersion;
-  readonly input: unknown;
-  readonly tenant: string | undefined;
-  readonly actor: string | undefined;
-  /** Pass to the engine so a repeated start returns the same run. */
-  readonly idempotencyKey: string;
-  /** The trigger that started it, when one did. */
-  readonly trigger?: WorkflowTrigger;
-}
-/** Starts a run with the engine and returns the engine's run id. */
-type BuilderStarter = ((call: BuilderStartCall) => Promise<string>) & {
-  /** The starter contract version. Omitted means 1. */
-  readonly apiVersion?: 1;
-};
-/** The engine's compiled form of a graph, stored with the version on publish. */
-type GraphCompiler = ((graph: WorkflowGraph) => unknown) & {
-  /** The compiler contract version. Omitted means 1. */
-  readonly apiVersion?: 1;
-};
-interface BuilderOptions extends BlockTemporalOptions {
-  /** The caller's transport: RLS and the module's permissions apply. */
-  readonly transport: BlockTransport;
-  /**
-   * A service-role transport for the calls only the server makes: webhook
-   * and event targets, `credentials.resolve`, `nodeRuns.record`,
-   * `steps.sync` and `alerts.check`. Defaults to `transport`.
-   */
-  readonly service?: BlockTransport;
-  /** The module schema (`sql.modules.workflow-builder.schema`), default `better_supabase`. */
-  readonly schema?: string;
-  readonly mappers?: readonly ErrorMapper[];
-  /** The steps `steps.sync()` writes to the library. */
-  readonly steps?: readonly WorkflowStepInfo[];
-  /**
-   * Runs on publish and fails it when it throws; the result is stored
-   * through `service`. `better-supabase/workflow-sdk/builder` exports `compileGraph`.
-   */
-  readonly compile?: GraphCompiler;
-  /** Starts runs; `better-supabase/workflow-sdk/builder` exports `graphStarter`. */
-  readonly start?: BuilderStarter;
-  /** The providers credential rows resolve through, picked by `ref.provider`. */
-  readonly credentials?: CredentialProvider | readonly CredentialProvider[];
-}
-interface DefinitionInput {
-  readonly tenant?: string;
-  /** Lowercase letters, digits and dashes; saving the same slug again renames it. */
-  readonly slug: string;
-  readonly name: string;
-  readonly description?: string;
-}
-interface TriggerInput {
-  readonly definition: string;
-  readonly kind: WorkflowTriggerKind;
-  readonly config?: Readonly<Record<string, unknown>>;
-  readonly enabled?: boolean;
-  /** Updates this trigger instead of creating one. */
-  readonly id?: string;
-}
-interface CredentialInput {
-  readonly tenant?: string;
-  readonly kind: string;
-  readonly name: string;
-  readonly ref: CredentialRef;
-  readonly scopes?: readonly string[];
-  /** Stores the secret first, through a provider that can (`vaultCredentials` can). */
-  readonly secret?: string;
-}
-interface AlertInput {
-  readonly definition: string;
-  readonly onEvent: "failed" | "slow";
-  readonly channel?: Readonly<Record<string, unknown>>;
-  /** Seconds a run may stay unfinished (slow alerts). */
-  readonly threshold?: number;
-  readonly id?: string;
-}
-interface NodeRunRecord {
-  /** The run's id or its engine's id. */
-  readonly run: string;
-  readonly node: string;
-  readonly status: WorkflowNodeRunStatus;
-  readonly attempt?: number;
-  readonly output?: unknown;
-  readonly error?: string;
-}
-interface RunInput {
-  readonly definition: string;
-  readonly input?: unknown;
-  /** Defaults to a fresh key, so every call starts a run. */
-  readonly idempotencyKey?: string;
-  readonly actor?: string;
-}
-interface OutboxLikeEvent {
-  readonly id: string;
-  readonly type: string;
-  readonly payload?: unknown;
-  readonly tenant?: string | undefined;
-}
-interface WorkflowBuilder {
-  readonly definitions: {
-    save(input: DefinitionInput): AsyncResult<WorkflowDefinition>;
-    list(tenant?: string): AsyncResult<readonly WorkflowDefinition[]>;
-    get(id: string): AsyncResult<WorkflowDefinition | undefined>;
-    remove(id: string): AsyncResult<boolean>;
-  };
-  readonly versions: {
-    /** Saves the draft: updates the open one, or opens the next version. */
-    save(definition: string, graph: WorkflowGraph): AsyncResult<WorkflowVersion>;
-    /**
-     * Compiles the graph with `compile`, then publishes as the caller; the
-     * previous version is archived. The compiled form is stored through
-     * `service` only, and not at all without it.
-     */
-    publish(version: string): AsyncResult<WorkflowVersion>;
-    list(definition: string): AsyncResult<readonly WorkflowVersion[]>;
-    get(version: string): AsyncResult<WorkflowVersion | undefined>;
-    diff(from: string, to: string): AsyncResult<WorkflowGraphDiff>;
-  };
-  /** Starts a run of the published version: `workflow.run` in its tenant. */
-  run(input: RunInput): AsyncResult<string>;
-  readonly triggers: {
-    save(input: TriggerInput): AsyncResult<WorkflowTrigger>;
-    list(definition: string): AsyncResult<readonly WorkflowTrigger[]>;
-    remove(id: string): AsyncResult<boolean>;
-    /** A new token for a webhook trigger; the old one stops working. Shown once. */
-    rotateToken(id: string): AsyncResult<string>;
-    /**
-     * A route handler for webhook triggers: the token is the last path
-     * segment or a `Bearer` header, the JSON body is the input, and an
-     * `Idempotency-Key` header keys the start. Answers 202 with `{ runId }`.
-     */
-    webhook(request: Request): Promise<Response>;
-    /** Starts the definitions whose event triggers listen for `event.type`. */
-    onEvent(event: OutboxLikeEvent): AsyncResult<readonly string[]>;
-    /**
-     * Creates or updates the `workflows` schedule of a schedule trigger (its
-     * `config.cron`), named `builder-trigger:<id>`. Uses `service`.
-     */
-    syncSchedule(trigger: WorkflowTrigger, tenant?: string): AsyncResult<WorkflowSchedule>;
-    /**
-     * The `start` for `workflows.schedules.tick`: starts `builder:<definition>`
-     * schedules here and passes the others to `fallback`.
-     */
-    starter(fallback?: WorkflowStarter): WorkflowStarter;
-  };
-  readonly credentials: {
-    list(tenant?: string): AsyncResult<readonly WorkflowCredential[]>;
-    create(input: CredentialInput): AsyncResult<WorkflowCredential>;
-    /** The URL that connects the account, for providers that authorize. */
-    authorize(id: string, options: {
-      readonly redirectUri: string;
-      readonly state?: string;
-    }): AsyncResult<string>;
-    /** Deletes the row, then revokes the secret it names. */
-    revoke(id: string): AsyncResult<boolean>;
-    /** The token for a credential, with the app subject and the row's scopes (service role; call it inside a step). */
-    resolve(id: string): AsyncResult<CredentialToken>;
-  };
-  readonly steps: {
-    /** Replaces the library with `steps` (service role). */
-    sync(steps?: readonly WorkflowStepInfo[]): AsyncResult<number>;
-    list(): AsyncResult<readonly WorkflowStepInfo[]>;
-  };
-  readonly nodeRuns: {
-    /** Records a node's status and pings `workflow-run:<id>` (service role). */
-    record(input: NodeRunRecord): AsyncResult<boolean>;
-    list(run: string): AsyncResult<readonly WorkflowNodeRun[]>;
-  };
-  readonly alerts: {
-    save(input: AlertInput): AsyncResult<WorkflowAlert>;
-    list(definition: string): AsyncResult<readonly WorkflowAlert[]>;
-    remove(id: string): AsyncResult<boolean>;
-    /** Fires the slow alerts that are due (service role); returns how many fired. */
-    check(options?: {
-      readonly batch?: number;
-    }): AsyncResult<number>;
-  };
-}
-//#endregion
-export { approved as A, WorkflowCondition as C, WorkflowGraphEdge as D, WorkflowGraphDiff as E, validateGraph as F, durationMs as M, evaluateCondition as N, WorkflowGraphNode as O, topologicalOrder as P, WorkflowVersionStatus as S, WorkflowGraph as T, WorkflowNodeRunStatus as _, CredentialInput as a, WorkflowTriggerKind as b, NodeRunRecord as c, TriggerInput as d, WorkflowAlert as f, WorkflowNodeRun as g, WorkflowDefinition as h, BuilderStarter as i, diffGraphs as j, WorkflowNodeKind as k, OutboxLikeEvent as l, WorkflowCredential as m, BuilderOptions as n, DefinitionInput as o, WorkflowBuilder as p, BuilderStartCall as r, GraphCompiler as s, AlertInput as t, RunInput as u, WorkflowStepInfo as v, WorkflowConditionOperator as w, WorkflowVersion as x, WorkflowTrigger as y };

package/dist/types-CbOUc5IH.d.ts

@@ -1,156 +0,0 @@
-/// <reference lib="esnext.temporal" />
-import { t as AsyncResult, w as ErrorMapper } from "./result-BchM1XZn.js";
-import { t as BlockTransport } from "./block-transport-inD4fFq-.js";
-import { i as CredentialRef, r as CredentialProvider } from "./provider-ib9wzUDz.js";
-import { i as CursorPageOptions, r as BlockTemporalOptions } from "./block-helpers-C0Xj8War.js";
-//#region src/blocks/ai-providers/types.d.ts
-/** A tenant's own key for a provider. The key itself stays in the credential provider. */
-interface AiProviderKey {
-  readonly id: string;
-  readonly organizationId: string;
-  /** The AI Gateway's provider slug, such as `anthropic` or `openai`. */
-  readonly provider: string;
-  /** Tells several keys of one provider apart; `default` unless named. */
-  readonly name: string;
-  readonly credentialRef: CredentialRef;
-  /** The provider's other options, such as a region; never a secret. */
-  readonly settings: Readonly<Record<string, unknown>>;
-  readonly enabled: boolean;
-  readonly createdBy: string | undefined;
-  readonly createdAt: Temporal.Instant;
-  readonly updatedAt: Temporal.Instant;
-}
-interface AiProviderKeyInput {
-  readonly provider: string;
-  /** Store the key first, for example with `vaultCredentials().set(ref, apiKey)`. */
-  readonly credentialRef: CredentialRef;
-  readonly name?: string;
-  readonly settings?: Readonly<Record<string, unknown>>;
-  readonly enabled?: boolean;
-}
-/** A key resolved for one request. */
-interface ResolvedProviderKey {
-  readonly provider: string;
-  readonly name: string;
-  readonly token: string;
-  readonly headers: Readonly<Record<string, string>>;
-  readonly settings: Readonly<Record<string, unknown>>;
-}
-type AiBatchStatus = "pending" | "completed" | "failed" | "cancelled";
-interface AiBatchCounts {
-  readonly total?: number;
-  readonly pending?: number;
-  readonly completed?: number;
-  readonly failed?: number;
-}
-interface AiBatch {
-  readonly id: string;
-  readonly organizationId: string;
-  readonly userId: string | undefined;
-  readonly provider: string;
-  /** The SDK's batch reference, such as `{ version, id, provider }`. */
-  readonly reference: Readonly<Record<string, unknown>>;
-  readonly status: AiBatchStatus;
-  /** The provider's own status word. */
-  readonly rawStatus: string | undefined;
-  readonly itemCount: number;
-  readonly counts: AiBatchCounts;
-  readonly error: string | undefined;
-  readonly metadata: Readonly<Record<string, unknown>>;
-  /** The results are in `items`. */
-  readonly resultsSaved: boolean;
-  readonly polls: number;
-  readonly nextPollAt: Temporal.Instant | undefined;
-  readonly expiresAt: Temporal.Instant | undefined;
-  readonly completedAt: Temporal.Instant | undefined;
-  readonly createdAt: Temporal.Instant;
-  readonly updatedAt: Temporal.Instant;
-}
-interface NewAiBatch {
-  readonly provider: string;
-  readonly reference: Readonly<Record<string, unknown>>;
-  readonly itemCount?: number;
-  readonly metadata?: Readonly<Record<string, unknown>>;
-  /** Service role only: the user the batch is for. */
-  readonly userId?: string;
-  readonly status?: AiBatchStatus;
-  readonly rawStatus?: string;
-  readonly counts?: AiBatchCounts;
-  readonly expiresAt?: Temporal.Instant;
-}
-interface AiBatchPatch {
-  readonly status?: AiBatchStatus;
-  readonly rawStatus?: string;
-  readonly counts?: AiBatchCounts;
-  readonly error?: string | null;
-  readonly expiresAt?: Temporal.Instant;
-  readonly resultsSaved?: boolean;
-  /** `null` stops polling. */
-  readonly nextPollAt?: Temporal.Instant | null;
-}
-type AiBatchItemStatus = "succeeded" | "failed" | "cancelled" | "expired";
-interface AiBatchItem {
-  readonly batchId: string;
-  readonly requestId: string;
-  readonly organizationId: string;
-  readonly status: AiBatchItemStatus;
-  readonly output: unknown;
-  readonly usage: unknown;
-  readonly error: string | undefined;
-  readonly createdAt: Temporal.Instant;
-}
-interface AiBatchItemInput {
-  readonly requestId: string;
-  readonly status: AiBatchItemStatus;
-  readonly output?: unknown;
-  readonly usage?: unknown;
-  readonly error?: string;
-}
-interface AiProvidersOptions extends BlockTemporalOptions {
-  /** Calls as the user: `rpcTransport(supabase)`. */
-  readonly transport: BlockTransport;
-  /** Calls as the service role, for resolving keys, polling and the idle stop. */
-  readonly service?: BlockTransport;
-  /** Resolves and revokes the keys' credential refs. */
-  readonly credentials?: CredentialProvider;
-  /** The module schema (`sql.modules.ai-providers.schema`), default `better_supabase`. */
-  readonly schema?: string;
-  readonly mappers?: readonly ErrorMapper[];
-}
-interface AiProviders {
-  readonly keys: {
-    list(organizationId: string): AsyncResult<readonly AiProviderKey[]>;
-    /** Adds or replaces a key (`ai.admin`), and revokes the credential it replaced. */
-    save(organizationId: string, key: AiProviderKeyInput): AsyncResult<AiProviderKey>;
-    /** Deletes a key and revokes its credential. `false` when there was none. */
-    remove(keyId: string): AsyncResult<boolean>;
-    /**
-     * Deletes every key of a tenant and revokes each credential (service
-     * role): the step to run when a tenant is deleted. Returns how many.
-     */
-    removeAll(organizationId: string): AsyncResult<number>;
-    /** The tenant's enabled keys with their tokens, for one request (service role). */
-    resolve(organizationId: string, options?: {
-      readonly providers?: readonly string[];
-      readonly signal?: AbortSignal;
-    }): AsyncResult<readonly ResolvedProviderKey[]>;
-  };
-  readonly batches: {
-    record(organizationId: string, batch: NewAiBatch): AsyncResult<AiBatch>;
-    get(batchId: string): AsyncResult<AiBatch | undefined>;
-    list(organizationId: string, options?: {
-      readonly status?: AiBatchStatus;
-      readonly limit?: number;
-    }): AsyncResult<readonly AiBatch[]>;
-    items(batchId: string, options?: CursorPageOptions<string>): AsyncResult<readonly AiBatchItem[]>;
-    /** Claims batches to poll for `leaseSeconds` (service role). */
-    due(options?: {
-      readonly batch?: number;
-      readonly leaseSeconds?: number;
-    }): AsyncResult<readonly AiBatch[]>;
-    update(batchId: string, patch: AiBatchPatch): AsyncResult<AiBatch>;
-    saveItems(batchId: string, items: readonly AiBatchItemInput[]): AsyncResult<number>;
-  };
-}
-//#endregion
-export { AiBatchItemStatus as a, AiProviderKey as c, AiProvidersOptions as d, NewAiBatch as f, AiBatchItemInput as i, AiProviderKeyInput as l, AiBatchCounts as n, AiBatchPatch as o, ResolvedProviderKey as p, AiBatchItem as r, AiBatchStatus as s, AiBatch as t, AiProviders as u };