@protobase/schema 0.67.12 → 0.68.0

package/dist/internal.d.ts

@@ -11,7 +11,7 @@ import { parseCapability } from "./access/capability.js";
 import { checkEventFilter } from "./events/event-models.js";
 import { webhookResources } from "./webhooks/webhook-resources.js";
 import { workflowResources } from "./workflows/workflow-resources.js";
-import { StepInput, StepInputKind, WorkflowStepType, requiredStepInputs, workflowStepTypes } from "./workflows/step-types.js";
+import { WorkflowTypeEntry, WorkflowTypeList, workflowTypesPath } from "./workflows/workflow-types-path.js";
 import { PropShapes, RefShape, pruneByShape, shapes } from "./ref-shape.js";
 import { SearchTerm, matchedSearchField, matchesSearch, searchTerms, termMatches } from "./search-match.js";
 import { defaultRecentLimit, navRecentErrors, statusTones } from "./nav-recent.js";
@@ -45,4 +45,4 @@ import { builtInFieldTypes } from "./built-in-field-types.js";
 import { CallCandidate, CallClientMessage, CallDescription, CallGuestLink, CallGuestRefusal, CallGuestState, CallLeftReason, CallLobbyGuest, CallMode, CallRemoteTrack, CallResume, CallRosterMember, CallServerMessage, CallTrackRequest, CallTrackSource, CallVideoLayer } from "./calls/call-protocol.js";
 import { guestCallsPath } from "./calls/call-guests.js";
 import { CallRing, callsChannelEvent, declineWord, ringNotice, ringsPath } from "./calls/call-rings.js";
-export { type AddressCheck, type Availability, type CallCandidate, type CallClientMessage, type CallDescription, type CallGuestLink, type CallGuestRefusal, type CallGuestState, type CallLeftReason, type CallLobbyGuest, type CallMode, type CallRemoteTrack, type CallResume, type CallRing, type CallRosterMember, type CallServerMessage, type CallTrackRequest, type CallTrackSource, type CallVideoLayer, type FormulaNode, type Locale, type MobileReleaseAnswer, type PersonStatus, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type ReleaseBinding, type SearchTerm, type StatusInput, type StepInput, type StepInputKind, type WorkflowStepType, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, availabilities, boardErrors, bottomBarFor, builtInFieldTypes, callsChannelEvent, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, confirmationMinutes, datesErrors, declineWord, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emailCodeMinutes, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, firstPartyCodeKey, guestCallsPath, heldStatus, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, maxStatusText, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, requiredStepInputs, ringNotice, ringsPath, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources, workflowResources, workflowStepTypes };
+export { type AddressCheck, type Availability, type CallCandidate, type CallClientMessage, type CallDescription, type CallGuestLink, type CallGuestRefusal, type CallGuestState, type CallLeftReason, type CallLobbyGuest, type CallMode, type CallRemoteTrack, type CallResume, type CallRing, type CallRosterMember, type CallServerMessage, type CallTrackRequest, type CallTrackSource, type CallVideoLayer, type FormulaNode, type Locale, type MobileReleaseAnswer, type PersonStatus, type PluginHost, type PluginRequirement, type PropShapes, type RefShape, type ReleaseBinding, type SearchTerm, type StatusInput, type WorkflowTypeEntry, type WorkflowTypeList, actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, availabilities, boardErrors, bottomBarFor, builtInFieldTypes, callsChannelEvent, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, confirmationMinutes, datesErrors, declineWord, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emailCodeMinutes, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, firstPartyCodeKey, guestCallsPath, heldStatus, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, maxStatusText, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, ringNotice, ringsPath, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources, workflowResources, workflowTypesPath };

package/dist/internal.js

@@ -19,7 +19,7 @@ import { bottomBarFor } from "./bottom-bar.js";
 import { decodeKey, encodeKey } from "./keys.js";
 import { webhookResources } from "./webhooks/webhook-resources.js";
 import { workflowResources } from "./workflows/workflow-resources.js";
-import { requiredStepInputs, workflowStepTypes } from "./workflows/step-types.js";
+import { workflowTypesPath } from "./workflows/workflow-types-path.js";
 import { pruneByShape, shapes } from "./ref-shape.js";
 import { inRange, pluginProblem } from "./plugin-version.js";
 import { redactSecrets } from "./redact-secrets.js";
@@ -44,4 +44,4 @@ import { listColumnNames } from "./list-columns.js";
 import { builtInFieldTypes } from "./built-in-field-types.js";
 import { guestCallsPath } from "./calls/call-guests.js";
 import { callsChannelEvent, declineWord, ringNotice, ringsPath } from "./calls/call-rings.js";
-export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, availabilities, boardErrors, bottomBarFor, builtInFieldTypes, callsChannelEvent, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, confirmationMinutes, datesErrors, declineWord, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emailCodeMinutes, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, firstPartyCodeKey, guestCallsPath, heldStatus, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, maxStatusText, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, requiredStepInputs, ringNotice, ringsPath, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources, workflowResources, workflowStepTypes };
+export { actionConditionError, actionInputErrors, addressErrors, addressPlaceholders, apiOriginMeta, appHrefError, applyAssistantEvent, authBasePath, availabilities, boardErrors, bottomBarFor, builtInFieldTypes, callsChannelEvent, capacitorOrigin, cardPhotoLimit, chartFields, checkEventFilter, checkedAccept, checkedProvider, confirmationMinutes, datesErrors, declineWord, decodeKey, defaultRecentLimit, deviceIdParam, devicesPath, displayFields, emailCodeMinutes, emptyAssistantState, encodeKey, fieldRefsIn, fillAddress, firstPartyCodeKey, guestCallsPath, heldStatus, historyIdParam, historyIdPattern, historyPath, hrefField, hrefPlaceholders, humanize, inRange, isFieldRef, isGroupChart, isLocale, labelFieldOf, layoutItems, leavesApp, linkActionError, listColumnNames, locales, markFieldRefs, matchedSearchField, matchesSearch, maxStatusText, mobileReleaseBasePath, mobileReleaseParams, mobileReleasePath, mobileReleaseQuery, mobileReleasesPath, navRecentErrors, parseCapability, parseFormula, parseSize, parseTable, pickLocale, pluginProblem, promptError, promptFields, pruneByShape, pushRecord, readEventStream, recordTitle, recordTitleField, redactSecrets, releaseManifestFile, releaseStatementContext, releaseStatementFile, renderPrompt, ringNotice, ringsPath, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources, workflowResources, workflowTypesPath };

package/dist/workflows/workflow-resources.d.ts

@@ -15,6 +15,7 @@ export declare const workflowResources: (schema: string) => {
     readonly description: Field<string | null>;
     readonly definition: Field<import("zod").JSONType>;
     readonly version: Field<number | null>;
+    readonly enabled_version: Field<number | null>;
     readonly tenant_id: Field<string | null>;
     readonly created_at: Field<string>;
     readonly updated_at: Field<string>;
@@ -25,6 +26,7 @@ export declare const workflowResources: (schema: string) => {
     readonly description: Field<string | null>;
     readonly definition: Field<import("zod").JSONType>;
     readonly version: Field<number | null>;
+    readonly enabled_version: Field<number | null>;
     readonly tenant_id: Field<string | null>;
     readonly created_at: Field<string>;
     readonly updated_at: Field<string>;
@@ -125,5 +127,27 @@ export declare const workflowResources: (schema: string) => {
     readonly finished_at: Field<string>;
     readonly duration_ms: Field<string | null>;
   }, Ref<"id", string>>>;
+  workflowTriggers: ResourceBuilder<{
+    readonly id: Field<string>;
+    readonly workflow_id: Field<string | number>;
+    readonly version: Field<number>;
+    readonly type: Field<string>;
+    readonly status: Field<"active" | "failing" | "needs_sign_in" | "stopping">;
+    readonly last_error: Field<import("zod").JSONType>;
+    readonly next_poll_at: Field<string | null>;
+    readonly tenant_id: Field<string | null>;
+    readonly updated_at: Field<string>;
+  }, Ref<"id", string>>;
+  workflowTriggersView: ViewBuilder<ResourceBuilder<{
+    readonly id: Field<string>;
+    readonly workflow_id: Field<string | number>;
+    readonly version: Field<number>;
+    readonly type: Field<string>;
+    readonly status: Field<"active" | "failing" | "needs_sign_in" | "stopping">;
+    readonly last_error: Field<import("zod").JSONType>;
+    readonly next_poll_at: Field<string | null>;
+    readonly tenant_id: Field<string | null>;
+    readonly updated_at: Field<string>;
+  }, Ref<"id", string>>>;
 };
 //#endregion

package/dist/workflows/workflow-resources.js

@@ -27,6 +27,7 @@ const workflowsResource = (schema) => resource("workflows").table(`${schema}.wor
 	description: f.text().optional().max(2e3),
 	definition: f.json(),
 	version: f.integer().optional().readOnly(),
+	enabled_version: f.integer().optional(),
 	tenant_id: f.text().optional().readOnly(),
 	created_at: f.timestamp().readOnly().dbDefault(),
 	updated_at: f.timestamp().readOnly().dbDefault().sortable()
@@ -35,6 +36,7 @@ const workflowsView = view("workflows").names({
 	singular: "Workflow",
 	plural: "Workflows"
 }).icon("workflow").title((r) => r.name).help("Steps that run one after another along their edges, written in the States Language with JSONata expressions. Each save that changes its definition is a new version; a run keeps the version it started on.").fields((r) => ({
+	enabled_version: r.enabled_version.label("Enabled version").help("The version whose trigger starts runs; set it to the current version to turn the trigger on, and clear it to turn it off. A save keeps an enabled workflow enabled on its new version."),
 	definition: r.definition.help("Its trigger and its steps, drawn as a graph that lays itself out. Every value is read by name: the run's input as $states.context.Execution.Input, an earlier result by the variable a state assigned").widget("workflow"),
 	updated_at: r.updated_at.label("Updated")
 })).list((r) => ({
@@ -56,6 +58,7 @@ const workflowsView = view("workflows").names({
 	layout.section("Workflow", [
 		r.name,
 		r.description,
+		r.enabled_version,
 		r.definition
 	]),
 	layout.sidebar([
@@ -63,6 +66,17 @@ const workflowsView = view("workflows").names({
 		r.created_at,
 		r.updated_at
 	]),
+	layout.related("Trigger", {
+		resource: "workflow_triggers",
+		field: "workflow_id",
+		columns: [
+			"type",
+			"status",
+			"version",
+			"last_error",
+			"updated_at"
+		]
+	}),
 	layout.related("Runs", {
 		resource: "workflow_runs",
 		field: "workflow_id",
@@ -308,6 +322,55 @@ const stepsView = view("workflow_steps").names({
 	r.finished_at,
 	r.duration_ms
 ])]);
+const triggerStatuses = [
+	"active",
+	"failing",
+	"needs_sign_in",
+	"stopping"
+];
+/** The trigger of each enabled workflow, as the engine keeps it: its type, status and last error, never its state. */
+const triggersResource = (schema) => resource("workflow_triggers").table(`${schema}.triggers`).fields({
+	id: f.uuid().readOnly().dbDefault(),
+	workflow_id: f.relation("workflows").readOnly().filterable(),
+	version: f.integer().readOnly(),
+	type: f.text().readOnly(),
+	status: f.enum(triggerStatuses).readOnly().filterable(),
+	last_error: f.json().optional().readOnly(),
+	next_poll_at: f.timestamp().optional().readOnly(),
+	tenant_id: f.text().optional().readOnly(),
+	updated_at: f.timestamp().readOnly().dbDefault().sortable()
+}).primaryKey((r) => r.id).tenant((r) => r.tenant_id).explicitGrants().access({
+	create: () => false,
+	update: () => false,
+	delete: () => false
+});
+const triggersView = view("workflow_triggers").names({
+	singular: "Workflow trigger",
+	plural: "Workflow triggers"
+}).icon("zap").title((r) => r.type).fields((r) => ({
+	workflow_id: r.workflow_id.label("Workflow"),
+	status: r.status.valueLabels({
+		active: "Active",
+		failing: "Failing",
+		needs_sign_in: "Needs sign-in",
+		stopping: "Stopping"
+	}).valueColors({
+		active: "green",
+		failing: "red",
+		needs_sign_in: "amber"
+	}),
+	last_error: r.last_error.label("Last error"),
+	next_poll_at: r.next_poll_at.label("Next poll"),
+	updated_at: r.updated_at.label("Updated")
+})).list((r) => ({
+	columns: [
+		r.workflow_id,
+		r.type,
+		r.status,
+		r.updated_at
+	],
+	sort: [[r.updated_at, "desc"]]
+}));
 /**
 * The resources and views `workflows` adds to an app, over the tables of `schema`: Workflows with their versions, runs
 * and steps. Config only; the server checks and runs them.
@@ -320,7 +383,9 @@ const workflowResources = (schema) => ({
 	workflowRuns: runsResource(schema),
 	workflowRunsView: runsView,
 	workflowSteps: stepsResource(schema),
-	workflowStepsView: stepsView
+	workflowStepsView: stepsView,
+	workflowTriggers: triggersResource(schema),
+	workflowTriggersView: triggersView
 });
 //#endregion
 export { workflowResources };

package/dist/workflows/workflow-types-path.d.ts

@@ -0,0 +1,22 @@
+//#region src/workflows/workflow-types-path.d.ts
+/** The path of the app's workflow trigger and step types under the API's system path (`/api`), as the editor reads them. */
+export declare const workflowTypesPath: (systemPath: string) => string;
+/**
+ * A trigger or step type as the server lists it: `id` is a Task's `Resource` or the key of a definition's `trigger`,
+ * `input` the JSON Schema of its input, and `available` false, with the `reason`, when this app cannot run it.
+ */
+export type WorkflowTypeEntry = {
+  id: string;
+  kind: string;
+  label: string;
+  description: string;
+  input: Record<string, unknown>;
+  available: boolean;
+  reason?: string;
+};
+/** The app's step types and triggers, `manual` among them, built-in and plugin types alike. */
+export type WorkflowTypeList = {
+  step_types: WorkflowTypeEntry[];
+  triggers: WorkflowTypeEntry[];
+};
+//#endregion

package/dist/workflows/workflow-types-path.js

@@ -0,0 +1,5 @@
+//#region src/workflows/workflow-types-path.ts
+/** The path of the app's workflow trigger and step types under the API's system path (`/api`), as the editor reads them. */
+const workflowTypesPath = (systemPath) => `${systemPath}/workflows/types`;
+//#endregion
+export { workflowTypesPath };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/schema",
-  "version": "0.67.12",
+  "version": "0.68.0",
   "description": "Resource, field, view and access definitions for Protobase configs.",
   "license": "Apache-2.0",
   "repository": {

package/dist/workflows/step-types.d.ts

@@ -1,30 +0,0 @@
-//#region src/workflows/step-types.d.ts
-/**
- * How a step type's argument is written: `text`, one line, which may be an expression; `choice`, one of `options`;
- * `json`, any JSON value or an expression, such as an object of field values.
- */
-export type StepInputKind = 'text' | 'choice' | 'json';
-/** An argument of a step type: its name in `Arguments`, how it is written, and whether a save needs it. */
-export type StepInput = {
-  name: string;
-  kind: StepInputKind;
-  required?: boolean;
-  options?: readonly string[];
-};
-/**
- * The step types a workflow's Task names as its `Resource`, each with its arguments: the server runs them, a save
- * refuses a Task without a required one, and the editor draws a form of them.
- */
-export declare const workflowStepTypes: {
-  readonly 'app:http': readonly [StepInput, StepInput, StepInput, StepInput, StepInput, StepInput];
-  readonly 'app:records.create': readonly [StepInput, StepInput];
-  readonly 'app:records.update': readonly [StepInput, StepInput, StepInput];
-  readonly 'app:records.get': readonly [StepInput, StepInput];
-  readonly 'app:records.list': readonly [StepInput, StepInput, StepInput, StepInput];
-  readonly 'app:mail.send': readonly [StepInput, StepInput, StepInput, StepInput, StepInput];
-  readonly 'app:piece': readonly [StepInput, StepInput, StepInput, StepInput];
-};
-export type WorkflowStepType = keyof typeof workflowStepTypes;
-/** The names of the arguments each step type needs, as the definition check takes them. */
-export declare const requiredStepInputs: Record<WorkflowStepType, string[]>;
-//#endregion

package/dist/workflows/step-types.js

@@ -1,70 +0,0 @@
-//#region src/workflows/step-types.ts
-const text = (name, required = false) => ({
-	name,
-	kind: "text",
-	...required && { required }
-});
-const json = (name, required = false) => ({
-	name,
-	kind: "json",
-	...required && { required }
-});
-const choice = (name, options) => ({
-	name,
-	kind: "choice",
-	options
-});
-/**
-* The step types a workflow's Task names as its `Resource`, each with its arguments: the server runs them, a save
-* refuses a Task without a required one, and the editor draws a form of them.
-*/
-const workflowStepTypes = {
-	"app:http": [
-		text("url", true),
-		choice("method", [
-			"GET",
-			"POST",
-			"PUT",
-			"PATCH",
-			"DELETE"
-		]),
-		json("headers"),
-		json("query"),
-		json("body"),
-		choice("response", [
-			"json",
-			"text",
-			"file"
-		])
-	],
-	"app:records.create": [text("resource", true), json("data", true)],
-	"app:records.update": [
-		text("resource", true),
-		json("key", true),
-		json("data", true)
-	],
-	"app:records.get": [text("resource", true), json("key", true)],
-	"app:records.list": [
-		text("resource", true),
-		text("filter"),
-		text("order_by"),
-		json("limit")
-	],
-	"app:mail.send": [
-		json("to", true),
-		text("subject", true),
-		text("text", true),
-		text("html"),
-		json("attachments")
-	],
-	"app:piece": [
-		text("piece", true),
-		text("action", true),
-		text("connection"),
-		json("props")
-	]
-};
-/** The names of the arguments each step type needs, as the definition check takes them. */
-const requiredStepInputs = Object.fromEntries(Object.entries(workflowStepTypes).map(([type, inputs]) => [type, inputs.filter((input) => input.required).map((input) => input.name)]));
-//#endregion
-export { requiredStepInputs, workflowStepTypes };