@protobase/schema 0.67.10 → 0.67.12

package/dist/built-in-field-types.d.ts

@@ -1,9 +1,14 @@
 //#region src/built-in-field-types.d.ts
 /**
  * The field types Protobase brings, which a view chooses with `.widget(name)` like a plugin's, by the storage types
- * each shows: `members`, a JSON array of the user ids of an organization's members. A plugin's of the same name wins.
+ * each shows: `json`, any JSON value edited as JSON text, `members`, a JSON array of the user ids of an organization's members, `workflow`, a workflow's
+ * definition drawn as a graph to edit, and `workflow_run`, a run's id, drawn as its steps on its workflow's graph. A
+ * plugin's of the same name wins.
  */
 export declare const builtInFieldTypes: {
+  readonly json: readonly ["json"];
   readonly members: readonly ["json"];
+  readonly workflow: readonly ["json"];
+  readonly workflow_run: readonly ["uuid"];
 };
 //#endregion

package/dist/built-in-field-types.js

@@ -1,8 +1,15 @@
 //#region src/built-in-field-types.ts
 /**
 * The field types Protobase brings, which a view chooses with `.widget(name)` like a plugin's, by the storage types
-* each shows: `members`, a JSON array of the user ids of an organization's members. A plugin's of the same name wins.
+* each shows: `json`, any JSON value edited as JSON text, `members`, a JSON array of the user ids of an organization's members, `workflow`, a workflow's
+* definition drawn as a graph to edit, and `workflow_run`, a run's id, drawn as its steps on its workflow's graph. A
+* plugin's of the same name wins.
 */
-const builtInFieldTypes = { members: ["json"] };
+const builtInFieldTypes = {
+	json: ["json"],
+	members: ["json"],
+	workflow: ["json"],
+	workflow_run: ["uuid"]
+};
 //#endregion
 export { builtInFieldTypes };

package/dist/internal.d.ts

@@ -11,6 +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 { 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";
@@ -44,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, 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 };
+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 };

package/dist/internal.js

@@ -19,6 +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 { pruneByShape, shapes } from "./ref-shape.js";
 import { inRange, pluginProblem } from "./plugin-version.js";
 import { redactSecrets } from "./redact-secrets.js";
@@ -43,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, ringNotice, ringsPath, searchTerms, serviceWorkerFile, shapes, shownInputs, statusPath, statusTextProblem, statusTones, tableDisplay, termMatches, unmarkFieldRefs, updateSetErrors, updateValues, viewOfList, webhookResources, workflowResources };
+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 };

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

@@ -0,0 +1,30 @@
+//#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

@@ -0,0 +1,70 @@
+//#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 };

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

@@ -57,6 +57,7 @@ export declare const workflowResources: (schema: string) => {
     readonly cause: Field<string | null>;
     readonly resume_at: Field<string | null>;
     readonly started_by: Field<string | null>;
+    readonly rerun_of: Field<string | number | null>;
     readonly tenant_id: Field<string | null>;
     readonly created_at: Field<string>;
     readonly finished_at: Field<string | null>;
@@ -74,6 +75,7 @@ export declare const workflowResources: (schema: string) => {
     readonly cause: Field<string | null>;
     readonly resume_at: Field<string | null>;
     readonly started_by: Field<string | null>;
+    readonly rerun_of: Field<string | number | null>;
     readonly tenant_id: Field<string | null>;
     readonly created_at: Field<string>;
     readonly finished_at: Field<string | null>;

package/dist/workflows/workflow-resources.js

@@ -35,7 +35,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) => ({
-	definition: r.definition.help("Its trigger and its state machine in the States Language with JSONata, every value read by name: the run's input as $states.context.Execution.Input, an earlier result by the variable a state assigned"),
+	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) => ({
 	columns: [
@@ -44,7 +44,15 @@ const workflowsView = view("workflows").names({
 		r.updated_at
 	],
 	sort: [[r.updated_at, "desc"]]
-})).layout((r) => [
+})).actions((a) => [a.link("test_run", {
+	label: "Test run",
+	icon: "play",
+	to: {
+		kind: "create",
+		resource: "workflow_runs",
+		values: { workflow_id: "{id}" }
+	}
+})]).layout((r) => [
 	layout.section("Workflow", [
 		r.name,
 		r.description,
@@ -60,9 +68,10 @@ const workflowsView = view("workflows").names({
 		field: "workflow_id",
 		columns: [
 			"status",
-			"version",
+			"started_by",
 			"created_at",
 			"duration_ms",
+			"version",
 			"error"
 		]
 	}),
@@ -117,6 +126,7 @@ const runsResource = (schema) => resource("workflow_runs").table(`${schema}.runs
 	cause: f.text().optional().readOnly(),
 	resume_at: f.timestamp().optional().readOnly(),
 	started_by: f.text().optional().readOnly(),
+	rerun_of: f.relation("workflow_runs").optional().filterable(),
 	tenant_id: f.text().optional().readOnly(),
 	created_at: f.timestamp().readOnly().dbDefault().sortable(),
 	finished_at: f.timestamp().optional().readOnly(),
@@ -129,8 +139,10 @@ const runsView = view("workflow_runs").names({
 	singular: "Workflow run",
 	plural: "Workflow runs"
 }).icon("play").title((r) => r.created_at).help("A run of a workflow with its input. It takes up where it stands after a restart; each of its steps is listed with what it read, gave and logged.").fields((r) => ({
+	id: r.id.label("Steps").widget("workflow_run"),
 	workflow_id: r.workflow_id.label("Workflow"),
-	input: r.input.help("Read by every state as $states.context.Execution.Input"),
+	input: r.input.widget("json").help("Read by every state as $states.context.Execution.Input; a re-run takes the input of the run it re-runs"),
+	rerun_of: r.rerun_of.label("Re-run of").help("A failed run of the workflow: the re-run keeps its steps before the one that failed, and goes on from there on the workflow as it is now"),
 	key: r.key.help("A workflow runs once per key, such as the record a trigger found ready"),
 	status: r.status.valueLabels({
 		queued: "Queued",
@@ -142,6 +154,7 @@ const runsView = view("workflow_runs").names({
 		succeeded: "green",
 		failed: "red"
 	}),
+	output: r.output.widget("json"),
 	resume_at: r.resume_at.label("Goes on at"),
 	started_by: r.started_by.label("Started by"),
 	created_at: r.created_at.label("Started"),
@@ -152,11 +165,25 @@ const runsView = view("workflow_runs").names({
 		r.created_at,
 		r.workflow_id,
 		r.status,
+		r.started_by,
 		r.duration_ms,
 		r.error
 	],
 	sort: [[r.created_at, "desc"]]
-})).layout((r) => [
+})).actions((a) => [a.link("rerun", {
+	label: "Re-run from the failed step",
+	icon: "restart",
+	to: {
+		kind: "create",
+		resource: "workflow_runs",
+		values: {
+			workflow_id: "{workflow_id}",
+			rerun_of: "{id}"
+		}
+	},
+	when: "status = \"failed\""
+})]).layout((r) => [
+	layout.section("Trace", [r.id]),
 	layout.section("Run", [
 		r.workflow_id,
 		r.input,
@@ -168,6 +195,7 @@ const runsView = view("workflow_runs").names({
 		r.status,
 		r.version,
 		r.started_by,
+		r.rerun_of,
 		r.created_at,
 		r.resume_at,
 		r.finished_at,
@@ -185,6 +213,17 @@ const runsView = view("workflow_runs").names({
 			"duration_ms",
 			"error"
 		]
+	}),
+	layout.related("Re-runs", {
+		resource: "workflow_runs",
+		field: "rerun_of",
+		columns: [
+			"status",
+			"started_by",
+			"created_at",
+			"duration_ms",
+			"error"
+		]
 	})
 ]);
 /** Every step of every run: its input with secrets redacted, output, variables, logs, timing, try and error. */

package/package.json

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