@xeplr/workflow-engine 3.1.0 → 3.2.0

package/README.md

@@ -105,6 +105,10 @@ host gives workflow is the boundary.
   first match wins (`@xeplr/expression-handler`); a blank condition is the
   catch-all; targets are a `stepKey`, `end_success` or `end_failed`. No match
   and no catch-all **fails the run**.
+- **Screens hand over to screens**: a flow's run view carries `previous` — what
+  every screen submitted earlier in the run, keyed by screen key, the saved row
+  as `values.id` (`lib/flows.js` `previousOf`). Read-only, built from the step
+  runs; nothing new is stored, and nothing is checked between screens.
 - **Letting a function decide**: a transition `{ decide: 'routeByAmount', targets?: [...] }`
   asks a function the app registered with `@xeplr/actions` under `event: 'decide'`
   where to go. It is called with `{ output, values (= output), params, item, trigger,

package/lib/flows.js

@@ -597,7 +597,9 @@ function runView(run, steps, stepRuns) {
     // the resolved input is kept (workflowRunner patches `input` as it parks)
     // — the step row holds the tokens, and a browser has nothing to resolve
     // them with.
-    given: {}
+    given: {},
+    // WHAT THE SCREENS BEFORE THIS ONE SAVED, by screen key — see previousOf.
+    previous: {}
   };
   if (!waiting) {
     if (run.status === 'failed' && run.error) view.error = run.error;
@@ -614,9 +616,43 @@ function runView(run, steps, stepRuns) {
     if (sr.stepKey !== waiting.stepKey) return;
     Object.assign(view.values, sr.output || {});
   });
+  view.previous = previousOf(steps, stepRuns, waiting);
   return view;
 }
 
+/**
+ * THE HAND-OVER BETWEEN SCREENS — what every screen submitted earlier in this
+ * run, keyed by the SCREEN's key:
+ *
+ *   { department_edit: { values: { id: "6f2a…", name: "Finance", … } } }
+ *
+ * A field on the next screen fills itself from it with a default of
+ * `{previous.department_edit.values.name}` (@xeplr/ui-factory). By screen and
+ * not by step, because the binding lives ON the screen, and a screen is the
+ * same form in every flow that shows it. `id` is the row that screen saved —
+ * part of the values, as it is of the row.
+ *
+ * Nothing is checked: a screen not reached on this run's branch is simply
+ * absent, and a binding to it comes out empty. A screen shown twice (a loop)
+ * hands over its latest. The step being shown now is not its own "previous".
+ */
+function previousOf(steps, stepRuns, waiting) {
+  var screenOf = {};
+  steps.forEach(function(st) {
+    if (st.actionName === SCREEN_ACTION && st.values && st.values.screen) screenOf[st.stepKey] = st.values.screen;
+  });
+  var out = {};
+  stepRuns.forEach(function(sr) {
+    if (sr.status !== 'success' || (waiting && sr.id === waiting.id)) return;
+    var screen = screenOf[sr.stepKey];
+    if (!screen) return;
+    var values = Object.assign({}, sr.output || {});
+    if (values.recordId !== undefined) { values.id = values.recordId; delete values.recordId; }
+    out[screen] = { values: values };
+  });
+  return out;
+}
+
 async function stepRunsOf(runId) {
   return db.model('WorkflowStepRun').query().where({ runId: runId }).orderBy('recordCreatedDate', 'asc');
 }
@@ -937,6 +973,7 @@ module.exports = {
   fail: fail,
   END_TARGETS: END_TARGETS,
   conditionToWhen: conditionToWhen,
+  previousOf: previousOf,
   toStepRows: toStepRows,
   validateFlow: validateFlow,
   runView: runView,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeplr/workflow-engine",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "license": "MIT",
   "description": "The free workflow engine: runs, actions as steps, branching, waits, and triggers — manual, API, a schedule, a job finishing. No HTTP: @xeplr/workflow-api puts the routes on top.",
   "keywords": [