@protobase/server 0.67.8 → 0.67.10

package/dist/workflows/workflow-engine.js

@@ -0,0 +1,37 @@
+import { stepTypeNames, stepTypes } from "./step-types.js";
+import { betterAuthOwnerRoles } from "../webhooks/table/owner-roles.js";
+import { runInputCheck } from "./input-limits.js";
+import { workflowSecrets, workflowsSchema } from "./options.js";
+import { workflowSaveHook } from "./save-hook.js";
+import { workflowsRunner } from "./segment-job.js";
+import { runStartHook } from "./start-hook.js";
+//#region src/workflows/workflow-engine.ts
+/**
+* What `createAdmin` needs for `workflows`: the hooks that check saves and start runs, the check of a run's input before
+* it is validated, and the segment job, whose step
+* types act on records as each workflow's last editor (from Better Auth unless the options say otherwise).
+*/
+const workflowEngine = (options, deps, auth) => {
+	const schema = workflowsSchema(options);
+	const roles = options.savedByRoles ?? (auth && betterAuthOwnerRoles(auth));
+	if (!roles) throw new Error("workflows act on records as each workflow's last editor, with their current roles: give the config `auth` (Better Auth), or `workflows.savedByRoles`");
+	const input = {
+		deps,
+		schema,
+		roles,
+		allowPrivateAddresses: Boolean(options.allowPrivateAddresses)
+	};
+	const secrets = workflowSecrets(options, globalThis.process?.env ?? {});
+	const { runner, job } = workflowsRunner({
+		schema,
+		tasks: (context) => stepTypes(input, context.mail),
+		secrets
+	});
+	return {
+		hooks: [workflowSaveHook(schema, stepTypeNames), runStartHook(runner, deps)],
+		writeChecks: [runInputCheck],
+		job
+	};
+};
+//#endregion
+export { workflowEngine };

package/dist/workflows/workflows-module.d.ts

@@ -0,0 +1,124 @@
+import { WorkflowsOptions } from "./options.js";
+//#region src/workflows/workflows-module.d.ts
+/**
+ * What `workflows` in `protobase.config.ts` adds to the app's resources: Workflows, their versions, runs and steps,
+ * over a `workflows` schema that `protobase migration` writes. Who may make, change and run them and read their runs
+ * is the resources' access (`workflows.create`, `workflow_runs.create`, `workflow_steps.read`, ...).
+ */
+export declare const workflowsModule: (options?: WorkflowsOptions) => {
+  workflows: import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly name: import("@protobase/schema").Field<string>;
+    readonly description: import("@protobase/schema").Field<string | null>;
+    readonly definition: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly version: import("@protobase/schema").Field<number | null>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly created_at: import("@protobase/schema").Field<string>;
+    readonly updated_at: import("@protobase/schema").Field<string>;
+  }, import("@protobase/schema").Ref<"id", string>>;
+  workflowsView: import("@protobase/schema").ViewBuilder<import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly name: import("@protobase/schema").Field<string>;
+    readonly description: import("@protobase/schema").Field<string | null>;
+    readonly definition: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly version: import("@protobase/schema").Field<number | null>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly created_at: import("@protobase/schema").Field<string>;
+    readonly updated_at: import("@protobase/schema").Field<string>;
+  }, import("@protobase/schema").Ref<"id", string>>>;
+  workflowVersions: import("@protobase/schema").ResourceBuilder<{
+    readonly workflow_id: import("@protobase/schema").Field<string | number>;
+    readonly version: import("@protobase/schema").Field<number>;
+    readonly definition: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly saved_by: import("@protobase/schema").Field<string | null>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly saved_at: import("@protobase/schema").Field<string>;
+  }, readonly [import("@protobase/schema").Ref<"workflow_id", string | number>, import("@protobase/schema").Ref<"version", number>]>;
+  workflowVersionsView: import("@protobase/schema").ViewBuilder<import("@protobase/schema").ResourceBuilder<{
+    readonly workflow_id: import("@protobase/schema").Field<string | number>;
+    readonly version: import("@protobase/schema").Field<number>;
+    readonly definition: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly saved_by: import("@protobase/schema").Field<string | null>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly saved_at: import("@protobase/schema").Field<string>;
+  }, readonly [import("@protobase/schema").Ref<"workflow_id", string | number>, import("@protobase/schema").Ref<"version", number>]>>;
+  workflowRuns: import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly workflow_id: import("@protobase/schema").Field<string | number>;
+    readonly version: import("@protobase/schema").Field<number | null>;
+    readonly input: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly key: import("@protobase/schema").Field<string | null>;
+    readonly status: import("@protobase/schema").Field<"waiting" | "failed" | "queued" | "running" | "succeeded">;
+    readonly output: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly error: import("@protobase/schema").Field<string | null>;
+    readonly cause: import("@protobase/schema").Field<string | null>;
+    readonly resume_at: import("@protobase/schema").Field<string | null>;
+    readonly started_by: import("@protobase/schema").Field<string | null>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly created_at: import("@protobase/schema").Field<string>;
+    readonly finished_at: import("@protobase/schema").Field<string | null>;
+    readonly duration_ms: import("@protobase/schema").Field<string | null>;
+  }, import("@protobase/schema").Ref<"id", string>>;
+  workflowRunsView: import("@protobase/schema").ViewBuilder<import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly workflow_id: import("@protobase/schema").Field<string | number>;
+    readonly version: import("@protobase/schema").Field<number | null>;
+    readonly input: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly key: import("@protobase/schema").Field<string | null>;
+    readonly status: import("@protobase/schema").Field<"waiting" | "failed" | "queued" | "running" | "succeeded">;
+    readonly output: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly error: import("@protobase/schema").Field<string | null>;
+    readonly cause: import("@protobase/schema").Field<string | null>;
+    readonly resume_at: import("@protobase/schema").Field<string | null>;
+    readonly started_by: import("@protobase/schema").Field<string | null>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly created_at: import("@protobase/schema").Field<string>;
+    readonly finished_at: import("@protobase/schema").Field<string | null>;
+    readonly duration_ms: import("@protobase/schema").Field<string | null>;
+  }, import("@protobase/schema").Ref<"id", string>>>;
+  workflowSteps: import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly run_id: import("@protobase/schema").Field<string | number>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly scope: import("@protobase/schema").Field<string>;
+    readonly seq: import("@protobase/schema").Field<number>;
+    readonly state: import("@protobase/schema").Field<string>;
+    readonly type: import("@protobase/schema").Field<string>;
+    readonly status: import("@protobase/schema").Field<"failed" | "succeeded" | "retrying" | "caught">;
+    readonly attempt: import("@protobase/schema").Field<number>;
+    readonly input: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly output: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly assigned: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly next: import("@protobase/schema").Field<string | null>;
+    readonly resume_at: import("@protobase/schema").Field<string | null>;
+    readonly error: import("@protobase/schema").Field<string | null>;
+    readonly cause: import("@protobase/schema").Field<string | null>;
+    readonly logs: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly started_at: import("@protobase/schema").Field<string>;
+    readonly finished_at: import("@protobase/schema").Field<string>;
+    readonly duration_ms: import("@protobase/schema").Field<string | null>;
+  }, import("@protobase/schema").Ref<"id", string>>;
+  workflowStepsView: import("@protobase/schema").ViewBuilder<import("@protobase/schema").ResourceBuilder<{
+    readonly id: import("@protobase/schema").Field<string>;
+    readonly run_id: import("@protobase/schema").Field<string | number>;
+    readonly tenant_id: import("@protobase/schema").Field<string | null>;
+    readonly scope: import("@protobase/schema").Field<string>;
+    readonly seq: import("@protobase/schema").Field<number>;
+    readonly state: import("@protobase/schema").Field<string>;
+    readonly type: import("@protobase/schema").Field<string>;
+    readonly status: import("@protobase/schema").Field<"failed" | "succeeded" | "retrying" | "caught">;
+    readonly attempt: import("@protobase/schema").Field<number>;
+    readonly input: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly output: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly assigned: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly next: import("@protobase/schema").Field<string | null>;
+    readonly resume_at: import("@protobase/schema").Field<string | null>;
+    readonly error: import("@protobase/schema").Field<string | null>;
+    readonly cause: import("@protobase/schema").Field<string | null>;
+    readonly logs: import("@protobase/schema").Field<import("zod").JSONType>;
+    readonly started_at: import("@protobase/schema").Field<string>;
+    readonly finished_at: import("@protobase/schema").Field<string>;
+    readonly duration_ms: import("@protobase/schema").Field<string | null>;
+  }, import("@protobase/schema").Ref<"id", string>>>;
+};
+//#endregion

package/dist/workflows/workflows-module.js

@@ -0,0 +1,11 @@
+import { workflowsSchema } from "./options.js";
+import { workflowResources } from "@protobase/schema/internal";
+//#region src/workflows/workflows-module.ts
+/**
+* What `workflows` in `protobase.config.ts` adds to the app's resources: Workflows, their versions, runs and steps,
+* over a `workflows` schema that `protobase migration` writes. Who may make, change and run them and read their runs
+* is the resources' access (`workflows.create`, `workflow_runs.create`, `workflow_steps.read`, ...).
+*/
+const workflowsModule = (options = {}) => workflowResources(workflowsSchema(options));
+//#endregion
+export { workflowsModule };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/server",
-  "version": "0.67.8",
+  "version": "0.67.10",
   "description": "The Protobase REST API as a Hono app, with Better Auth sign-in.",
   "license": "Apache-2.0",
   "repository": {
@@ -44,9 +44,10 @@
     "@better-auth/sso": "^1.7.12",
     "@livekit/protocol": "1.53.1",
     "@modelcontextprotocol/server": "^2.3.1",
-    "@protobase/layout": "0.67.8",
-    "@protobase/query": "0.67.8",
-    "@protobase/schema": "0.67.8",
+    "@protobase/layout": "0.67.10",
+    "@protobase/query": "0.67.10",
+    "@protobase/schema": "0.67.10",
+    "@protobase/workflows": "0.67.10",
     "@react-email/render": "^2.1.0",
     "@react-pdf/primitives": "^4.4.0",
     "@react-pdf/renderer": "^4.9.0",