better-supabase 0.5.1 → 0.6.0

package/dist/blocks/workflow-builder/index.d.ts

@@ -0,0 +1,21 @@
+import { i as sqlTransport, r as rpcTransport, t as BlockTransport } from "../../block-transport-DvaoPuZ9.js";
+import { A as approved, C as WorkflowCondition, D as WorkflowGraphEdge, E as WorkflowGraphDiff, F as validateGraph, M as durationMs, N as evaluateCondition, O as WorkflowGraphNode, P as topologicalOrder, S as WorkflowVersionStatus, T as WorkflowGraph, _ as WorkflowNodeRunStatus, a as CredentialInput, b as WorkflowTriggerKind, c as NodeRunRecord, d as TriggerInput, f as WorkflowAlert, g as WorkflowNodeRun, h as WorkflowDefinition, i as BuilderStarter, j as diffGraphs, k as WorkflowNodeKind, l as OutboxLikeEvent, m as WorkflowCredential, n as BuilderOptions, o as DefinitionInput, p as WorkflowBuilder, r as BuilderStartCall, s as GraphCompiler, t as AlertInput, u as RunInput, v as WorkflowStepInfo, w as WorkflowConditionOperator, x as WorkflowVersion, y as WorkflowTrigger } from "../../types-BI-0Sl2v.js";
+import { i as executeGraph, n as GraphStepCall, r as approvalToken, t as GraphRuntime } from "../../executor-D14tGopJ.js";
+//#region src/blocks/workflow-builder/workflow-builder.d.ts
+/**
+ * The `workflow-builder` module's definitions, versions, triggers,
+ * credentials, step library, node runs and alerts. The engine plugs in
+ * through `compile` and `start`; credential rows resolve through the
+ * `credentials` providers.
+ *
+ * ```ts
+ * const builder = createBuilder({
+ *   transport: rpcTransport(supabase),
+ *   compile: compileGraph,
+ *   start: graphStarter({ executor: builderWorkflow, steps: { runNode } }),
+ * });
+ * ```
+ */
+export declare function createBuilder(options: BuilderOptions): WorkflowBuilder;
+//#endregion
+export { type AlertInput, type BlockTransport, type BuilderOptions, type BuilderStartCall, type BuilderStarter, type CredentialInput, type DefinitionInput, type GraphCompiler, type GraphRuntime, type GraphStepCall, type NodeRunRecord, type OutboxLikeEvent, type RunInput, type TriggerInput, type WorkflowAlert, type WorkflowBuilder, type WorkflowCondition, type WorkflowConditionOperator, type WorkflowCredential, type WorkflowDefinition, type WorkflowGraph, type WorkflowGraphDiff, type WorkflowGraphEdge, type WorkflowGraphNode, type WorkflowNodeKind, type WorkflowNodeRun, type WorkflowNodeRunStatus, type WorkflowStepInfo, type WorkflowTrigger, type WorkflowTriggerKind, type WorkflowVersion, type WorkflowVersionStatus, approvalToken, approved, diffGraphs, durationMs, evaluateCondition, executeGraph, rpcTransport, sqlTransport, topologicalOrder, validateGraph };

package/dist/blocks/workflow-builder/index.js

@@ -0,0 +1,5 @@
+import { n as rpcTransport, r as sqlTransport } from "../../block-transport-BLr-ZgLc.js";
+import { a as evaluateCondition, c as topologicalOrder, i as durationMs, l as validateGraph, r as diffGraphs, t as approved } from "../../graph-BGyLLFLX.js";
+import { t as createBuilder } from "../../workflow-builder-DJ1oHn8g.js";
+import { n as executeGraph, t as approvalToken } from "../../executor-C-R4pucm.js";
+export { approvalToken, approved, createBuilder, diffGraphs, durationMs, evaluateCondition, executeGraph, rpcTransport, sqlTransport, topologicalOrder, validateGraph };

package/dist/blocks/workflow-builder/react/index.d.ts

@@ -0,0 +1,47 @@
+import { b as DbError } from "../../../result-D7y2fT87.js";
+import { x as SubscriptionStatus } from "../../../index-DunNRdnT.js";
+import { t as WorkflowRun } from "../../../workflows-B0j9WKPu.js";
+import { g as WorkflowNodeRun, h as WorkflowDefinition, p as WorkflowBuilder, v as WorkflowStepInfo } from "../../../types-BI-0Sl2v.js";
+//#region src/blocks/workflow-builder/react/index.d.ts
+export interface UseWorkflowBuilderOptions {
+  /** The tenant whose definitions to list. */
+  readonly tenant?: string | null;
+  /** The schema the calls go to (default `better_supabase`). */
+  readonly schema?: string;
+}
+export interface WorkflowBuilderState {
+  /** `undefined` until the first load. */
+  readonly definitions: readonly WorkflowDefinition[] | undefined;
+  /** The step library, the canvas's palette. */
+  readonly steps: readonly WorkflowStepInfo[] | undefined;
+  readonly error: DbError | undefined;
+  readonly refresh: () => Promise<void>;
+  /** The builder for the signed-in user, for saves, publishes and runs. */
+  readonly builder: WorkflowBuilder;
+}
+/**
+ * The definitions the signed-in user may read and the step library, with a
+ * builder bound to the user's session.
+ *
+ * ```tsx
+ * const { definitions, steps, builder } = useWorkflowBuilder({ tenant });
+ * ```
+ */
+export declare function useWorkflowBuilder(options?: UseWorkflowBuilderOptions): WorkflowBuilderState;
+export interface UseWorkflowCanvasRunOptions {
+  readonly schema?: string;
+}
+export interface WorkflowCanvasRunState {
+  readonly run: WorkflowRun | undefined;
+  /** Each node's status by node id, for the canvas overlay. */
+  readonly nodes: Readonly<Record<string, WorkflowNodeRun>>;
+  readonly error: DbError | undefined;
+  readonly status: SubscriptionStatus;
+  readonly refresh: () => Promise<void>;
+}
+/**
+ * A run and the status of each of its nodes, loaded again on each message
+ * on `workflow-run:<id>` (run status changes and node records).
+ */
+export declare function useWorkflowCanvasRun(run: string | null, options?: UseWorkflowCanvasRunOptions): WorkflowCanvasRunState;
+//#endregion

package/dist/blocks/workflow-builder/react/index.js

@@ -0,0 +1,119 @@
+"use client";
+import { i as useAuth, l as useSupabase } from "../../../hooks-1BTCJsiw.js";
+import { n as rpcTransport } from "../../../block-transport-BLr-ZgLc.js";
+import { t as watchTopic } from "../../../react-topic-seAWjL3_.js";
+import { t as createWorkflows } from "../../../workflows-wu1WWBn7.js";
+import { t as createBuilder } from "../../../workflow-builder-DJ1oHn8g.js";
+import { useCallback, useEffect, useMemo, useState } from "react";
+//#region src/blocks/workflow-builder/react/index.ts
+/**
+* The definitions the signed-in user may read and the step library, with a
+* builder bound to the user's session.
+*
+* ```tsx
+* const { definitions, steps, builder } = useWorkflowBuilder({ tenant });
+* ```
+*/
+function useWorkflowBuilder(options = {}) {
+	const supabase = useSupabase();
+	const auth = useAuth();
+	const [definitions, setDefinitions] = useState(void 0);
+	const [steps, setSteps] = useState(void 0);
+	const [error, setError] = useState(void 0);
+	const tenant = options.tenant ?? null;
+	const schema = options.schema;
+	const builder = useMemo(() => createBuilder({
+		transport: rpcTransport(supabase),
+		...schema === void 0 ? {} : { schema }
+	}), [supabase, schema]);
+	const userId = auth.user?.id ?? null;
+	const refresh = useCallback(async () => {
+		const [listed, library] = await Promise.all([builder.definitions.list(tenant ?? void 0), builder.steps.list()]);
+		if (listed.ok) setDefinitions(listed.data);
+		if (library.ok) setSteps(library.data);
+		setError(listed.ok ? library.ok ? void 0 : library.error : listed.error);
+	}, [builder, tenant]);
+	useEffect(() => {
+		if (auth.status !== "signed-in") return;
+		refresh();
+	}, [
+		userId,
+		auth.status,
+		refresh
+	]);
+	return {
+		definitions,
+		steps,
+		error,
+		refresh,
+		builder
+	};
+}
+const NO_NODES = {};
+/**
+* A run and the status of each of its nodes, loaded again on each message
+* on `workflow-run:<id>` (run status changes and node records).
+*/
+function useWorkflowCanvasRun(run, options = {}) {
+	const supabase = useSupabase();
+	const auth = useAuth();
+	const [current, setCurrent] = useState(void 0);
+	const [nodes, setNodes] = useState(NO_NODES);
+	const [error, setError] = useState(void 0);
+	const [status, setStatus] = useState("closed");
+	const schema = options.schema;
+	const clients = useMemo(() => {
+		const transport = rpcTransport(supabase);
+		const scoped = schema === void 0 ? {} : { schema };
+		return {
+			workflows: createWorkflows({
+				transport,
+				...scoped
+			}),
+			builder: createBuilder({
+				transport,
+				...scoped
+			})
+		};
+	}, [supabase, schema]);
+	const userId = auth.user?.id ?? null;
+	const refresh = useCallback(async () => {
+		if (run === null) return;
+		const [found, listed] = await Promise.all([clients.workflows.runs.get(run), clients.builder.nodeRuns.list(run)]);
+		if (found.ok) setCurrent(found.data);
+		if (listed.ok) setNodes(Object.fromEntries(listed.data.map((node) => [node.node, node])));
+		setError(found.ok ? listed.ok ? void 0 : listed.error : found.error);
+	}, [clients, run]);
+	useEffect(() => {
+		if (auth.status !== "signed-in" || run === null) return;
+		refresh();
+	}, [
+		run,
+		userId,
+		auth.status,
+		refresh
+	]);
+	const id = current?.id ?? null;
+	useEffect(() => {
+		if (auth.status !== "signed-in" || id === null) return;
+		return watchTopic(supabase, `workflow-run:${id}`, {
+			onMessage: () => void refresh(),
+			onRejoin: () => void refresh(),
+			onStatus: setStatus
+		});
+	}, [
+		supabase,
+		id,
+		auth.status,
+		refresh
+	]);
+	return {
+		run: current,
+		nodes,
+		error,
+		status,
+		refresh
+	};
+}
+//#endregion
+export { useWorkflowBuilder, useWorkflowCanvasRun };

package/dist/blocks/workflow-builder/react/server.d.ts

@@ -0,0 +1,8 @@
+import { UseWorkflowBuilderOptions, UseWorkflowCanvasRunOptions, WorkflowBuilderState, WorkflowCanvasRunState } from "./index.js";
+//#region src/blocks/workflow-builder/react/server.d.ts
+/** The `react-server` build of `useWorkflowBuilder`: call `builder.definitions.list()` instead. */
+export declare const useWorkflowBuilder: (options?: UseWorkflowBuilderOptions) => WorkflowBuilderState;
+/** The `react-server` build of `useWorkflowCanvasRun`: call `builder.nodeRuns.list()` instead. */
+export declare const useWorkflowCanvasRun: (run: string | null, options?: UseWorkflowCanvasRunOptions) => WorkflowCanvasRunState;
+//#endregion
+export type { UseWorkflowBuilderOptions, UseWorkflowCanvasRunOptions, WorkflowBuilderState, WorkflowCanvasRunState };

package/dist/blocks/workflow-builder/react/server.js

@@ -0,0 +1,11 @@
+//#region src/blocks/workflow-builder/react/server.ts
+/** The `react-server` build of `useWorkflowBuilder`: call `builder.definitions.list()` instead. */
+const useWorkflowBuilder = () => {
+	throw new Error("better-supabase: useWorkflowBuilder() runs in Client Components only. In Server Components call `builder.definitions.list()` instead.");
+};
+/** The `react-server` build of `useWorkflowCanvasRun`: call `builder.nodeRuns.list()` instead. */
+const useWorkflowCanvasRun = () => {
+	throw new Error("better-supabase: useWorkflowCanvasRun() runs in Client Components only. In Server Components call `builder.nodeRuns.list()` instead.");
+};
+//#endregion
+export { useWorkflowBuilder, useWorkflowCanvasRun };

package/dist/blocks/workflows/index.d.ts

@@ -0,0 +1,3 @@
+import { i as sqlTransport, r as rpcTransport, t as BlockTransport } from "../../block-transport-DvaoPuZ9.js";
+import { a as WorkflowSchedule, c as WorkflowStartRequest, d as WorkflowTickOptions, f as WorkflowTickResult, h as createWorkflows, i as WorkflowRunsQuery, l as WorkflowStartTicket, m as WorkflowsOptions, n as WorkflowRunRecord, o as WorkflowScheduleInput, p as Workflows, r as WorkflowRunStatus, s as WorkflowStartCall, t as WorkflowRun, u as WorkflowStarter } from "../../workflows-B0j9WKPu.js";
+export { type BlockTransport, type WorkflowRun, type WorkflowRunRecord, type WorkflowRunStatus, type WorkflowRunsQuery, type WorkflowSchedule, type WorkflowScheduleInput, type WorkflowStartCall, type WorkflowStartRequest, type WorkflowStartTicket, type WorkflowStarter, type WorkflowTickOptions, type WorkflowTickResult, type Workflows, type WorkflowsOptions, createWorkflows, rpcTransport, sqlTransport };

package/dist/blocks/workflows/index.js

@@ -0,0 +1,3 @@
+import { n as rpcTransport, r as sqlTransport } from "../../block-transport-BLr-ZgLc.js";
+import { t as createWorkflows } from "../../workflows-wu1WWBn7.js";
+export { createWorkflows, rpcTransport, sqlTransport };

package/dist/blocks/workflows/react/index.d.ts

@@ -0,0 +1,47 @@
+import { b as DbError } from "../../../result-D7y2fT87.js";
+import { x as SubscriptionStatus } from "../../../index-DunNRdnT.js";
+import { r as WorkflowRunStatus, t as WorkflowRun } from "../../../workflows-B0j9WKPu.js";
+//#region src/blocks/workflows/react/index.d.ts
+export interface UseWorkflowRunsOptions {
+  /** The tenant whose runs to list; it also joins the tenant's `workflow-runs:<tenant>` topic. Without one, the signed-in user's own runs load once. */
+  readonly tenant?: string | null;
+  readonly definition?: string;
+  readonly status?: WorkflowRunStatus;
+  readonly limit?: number;
+  /** The schema the calls go to: the module schema (default `better_supabase`), or the API schema from `sql.modules.workflows.api`. */
+  readonly schema?: string;
+}
+export interface WorkflowRunsState {
+  /** `undefined` until the first load. */
+  readonly runs: readonly WorkflowRun[] | undefined;
+  readonly error: DbError | undefined;
+  readonly status: SubscriptionStatus;
+  readonly refresh: () => Promise<void>;
+}
+/**
+ * The runs the signed-in user may read, newest first, loaded again when a
+ * run in the tenant changes status.
+ *
+ * ```tsx
+ * const { runs } = useWorkflowRuns({ tenant: organizationId });
+ * ```
+ */
+export declare function useWorkflowRuns(options?: UseWorkflowRunsOptions): WorkflowRunsState;
+export interface UseWorkflowRunOptions {
+  readonly schema?: string;
+}
+export interface WorkflowRunState {
+  /** `undefined` until the first load, and when the user may not read the run. */
+  readonly run: WorkflowRun | undefined;
+  readonly error: DbError | undefined;
+  readonly status: SubscriptionStatus;
+  readonly refresh: () => Promise<void>;
+  /** Asks the engine to cancel the run, then loads it again. */
+  readonly cancel: () => Promise<void>;
+}
+/**
+ * One run by its id or its engine's id, loaded again on each status change
+ * broadcast on `workflow-run:<id>`.
+ */
+export declare function useWorkflowRun(run: string | null, options?: UseWorkflowRunOptions): WorkflowRunState;
+//#endregion

package/dist/blocks/workflows/react/index.js

@@ -0,0 +1,137 @@
+"use client";
+import { i as useAuth, l as useSupabase } from "../../../hooks-1BTCJsiw.js";
+import { n as rpcTransport } from "../../../block-transport-BLr-ZgLc.js";
+import { t as watchTopic } from "../../../react-topic-seAWjL3_.js";
+import { t as createWorkflows } from "../../../workflows-wu1WWBn7.js";
+import { useCallback, useEffect, useMemo, useState } from "react";
+//#region src/blocks/workflows/react/index.ts
+/**
+* The runs the signed-in user may read, newest first, loaded again when a
+* run in the tenant changes status.
+*
+* ```tsx
+* const { runs } = useWorkflowRuns({ tenant: organizationId });
+* ```
+*/
+function useWorkflowRuns(options = {}) {
+	const supabase = useSupabase();
+	const auth = useAuth();
+	const [runs, setRuns] = useState(void 0);
+	const [error, setError] = useState(void 0);
+	const [status, setStatus] = useState("closed");
+	const { schema, definition, limit } = options;
+	const runStatus = options.status;
+	const tenant = options.tenant ?? null;
+	const workflows = useMemo(() => createWorkflows({
+		transport: rpcTransport(supabase),
+		...schema === void 0 ? {} : { schema }
+	}), [supabase, schema]);
+	const userId = auth.user?.id ?? null;
+	const refresh = useCallback(async () => {
+		const result = await workflows.runs.list({
+			...tenant === null ? {} : { tenant },
+			...definition === void 0 ? {} : { definition },
+			...runStatus === void 0 ? {} : { status: runStatus },
+			...limit === void 0 ? {} : { limit }
+		});
+		if (result.ok) {
+			setRuns(result.data);
+			setError(void 0);
+		} else setError(result.error);
+	}, [
+		workflows,
+		tenant,
+		definition,
+		runStatus,
+		limit
+	]);
+	useEffect(() => {
+		if (auth.status !== "signed-in") return;
+		refresh();
+		if (tenant === null) return;
+		return watchTopic(supabase, `workflow-runs:${tenant}`, {
+			onMessage: () => void refresh(),
+			onRejoin: () => void refresh(),
+			onStatus: setStatus
+		});
+	}, [
+		supabase,
+		tenant,
+		userId,
+		auth.status,
+		refresh
+	]);
+	return {
+		runs,
+		error,
+		status,
+		refresh
+	};
+}
+/**
+* One run by its id or its engine's id, loaded again on each status change
+* broadcast on `workflow-run:<id>`.
+*/
+function useWorkflowRun(run, options = {}) {
+	const supabase = useSupabase();
+	const auth = useAuth();
+	const [current, setCurrent] = useState(void 0);
+	const [error, setError] = useState(void 0);
+	const [status, setStatus] = useState("closed");
+	const schema = options.schema;
+	const workflows = useMemo(() => createWorkflows({
+		transport: rpcTransport(supabase),
+		...schema === void 0 ? {} : { schema }
+	}), [supabase, schema]);
+	const userId = auth.user?.id ?? null;
+	const refresh = useCallback(async () => {
+		if (run === null) return;
+		const result = await workflows.runs.get(run);
+		if (result.ok) {
+			setCurrent(result.data);
+			setError(void 0);
+		} else setError(result.error);
+	}, [workflows, run]);
+	const cancel = useCallback(async () => {
+		if (run === null) return;
+		const result = await workflows.runs.requestCancel(run);
+		if (result.ok) await refresh();
+		else setError(result.error);
+	}, [
+		workflows,
+		run,
+		refresh
+	]);
+	useEffect(() => {
+		if (auth.status !== "signed-in" || run === null) return;
+		refresh();
+	}, [
+		run,
+		userId,
+		auth.status,
+		refresh
+	]);
+	const id = current?.id ?? null;
+	useEffect(() => {
+		if (auth.status !== "signed-in" || id === null) return;
+		return watchTopic(supabase, `workflow-run:${id}`, {
+			onMessage: () => void refresh(),
+			onRejoin: () => void refresh(),
+			onStatus: setStatus
+		});
+	}, [
+		supabase,
+		id,
+		auth.status,
+		refresh
+	]);
+	return {
+		run: current,
+		error,
+		status,
+		refresh,
+		cancel
+	};
+}
+//#endregion
+export { useWorkflowRun, useWorkflowRuns };

package/dist/blocks/workflows/react/server.d.ts

@@ -0,0 +1,8 @@
+import { UseWorkflowRunOptions, UseWorkflowRunsOptions, WorkflowRunState, WorkflowRunsState } from "./index.js";
+//#region src/blocks/workflows/react/server.d.ts
+/** The `react-server` build of `useWorkflowRuns`: call `workflows.runs.list()` instead. */
+export declare const useWorkflowRuns: (options?: UseWorkflowRunsOptions) => WorkflowRunsState;
+/** The `react-server` build of `useWorkflowRun`: call `workflows.runs.get()` instead. */
+export declare const useWorkflowRun: (run: string | null, options?: UseWorkflowRunOptions) => WorkflowRunState;
+//#endregion
+export type { UseWorkflowRunOptions, UseWorkflowRunsOptions, WorkflowRunState, WorkflowRunsState };

package/dist/blocks/workflows/react/server.js

@@ -0,0 +1,11 @@
+//#region src/blocks/workflows/react/server.ts
+/** The `react-server` build of `useWorkflowRuns`: call `workflows.runs.list()` instead. */
+const useWorkflowRuns = () => {
+	throw new Error("better-supabase: useWorkflowRuns() runs in Client Components only. In Server Components call `workflows.runs.list()` instead.");
+};
+/** The `react-server` build of `useWorkflowRun`: call `workflows.runs.get()` instead. */
+const useWorkflowRun = () => {
+	throw new Error("better-supabase: useWorkflowRun() runs in Client Components only. In Server Components call `workflows.runs.get()` instead.");
+};
+//#endregion
+export { useWorkflowRun, useWorkflowRuns };