@aglyn/plugins-workflows 1.0.0-beta.221 → 1.0.0-beta.223

package/README.md

@@ -26,13 +26,15 @@ runs an automation:
 - `run-event-workflows.ts` and `run-event-actions.ts` — the runners. A host
   event runs the workflows triggered by it and the actions listening for it;
   the site-event dispatch runs one action a published page fired.
-- `run-event-actions.ts` also holds the step executors — datasets, email,
-  webhooks, lists, campaigns, alerts, custom events — and the flow steps —
-  behind `runServerStep`, one step at a time, which is what lets a workflow
-  perform an Actions step without a second copy of any of them. Its
-  `executeWorkflow` is the workflow half: function calls through the pure
-  evaluator, Actions steps through that executor, in one scope.
-- `crm-action-steps.ts` — the five CRM steps.
+- `run-event-actions.ts` also holds the step executors — email, webhooks,
+  lists, campaigns, alerts, custom events — and the flow steps — behind
+  `runServerStep`, one step at a time, which is what lets a workflow perform
+  an Actions step without a second copy of any of them. A step that writes
+  another plugin's records — a dataset row, a contact's stage — is handed to
+  the executor that plugin registered on the server-step seam
+  (`plugin-server-steps`). Its `executeWorkflow` is the workflow half:
+  function calls through the pure evaluator, Actions steps through that
+  executor, in one scope.
 - `flow-enrollments.ts` — where a person waits between one step of a flow and
   the next, resumed by the `resume-flow-waits` job. A workflow's enrollment id
   is kept apart from an action's, so the two kinds never share a row.
@@ -75,13 +77,17 @@ the page view is core's own, and every other event is declared under
 `hostEvents` by the plugin whose doors raise it. What only the engine reads
 is this plugin's: the run history's past-tense step phrases
 (`model/step-outcomes.ts`), a webhook's stored shape and its URL guard
-(`model/webhooks.ts`), the CRM steps' grouping (`engine/crm-action-steps.ts`)
-and the event-chaining depth (`model/workflows.ts`). The automation
-vocabulary the other plugins author against — the server steps, flows,
-recipes and their validation — is still in the core
-(`@aglyn/aglyn/app-utils/actions`), because the AI plugin drafts automations
-against it and the CRM plugin installs its recipes, and neither may import
-this plugin.
+(`model/webhooks.ts`) and the event-chaining depth (`model/workflows.ts`). The
+automation vocabulary — the server steps' shapes, the flow's bounds and each
+server step's checks — is this plugin's too (`model/host-actions.ts`). The
+plugins that write automations without loading this one meet it through core
+seams: each step's name, hold and typed fields are declared under
+`interactionSteps` in `plugins.config.json`; the checks are registered from
+this plugin's `declarations` entry (`interaction-step-checks`), so a recipe the
+CRM installs or a draft the AI grades is refused as this editor would refuse
+it; the stored shape and the slice a visitor's page receives are core's
+(`site-interactions`); and a drafted automation is handed over through the
+`automation` resource's draft writer (`server-automation-drafts.ts`).
 
 ## Entry points
 
@@ -90,6 +96,8 @@ this plugin.
   flow-resume job, the automation draft writer, the org automation doors, and
   the Actions card's test run (`automations/actions/test-run`, console only —
   the page runtime's `events/dispatch` is a tenant route).
+- `./declarations` — the server steps' checks, registered in both apps and in
+  the console's browser before any surface loads.
 - `./declarations.server` — the boot registration above.
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aglyn/plugins-workflows",
-  "version": "1.0.0-beta.221",
+  "version": "1.0.0-beta.223",
   "license": "Apache-2.0",
   "homepage": "https://aglyn.com",
   "repository": {
@@ -25,17 +25,17 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@aglyn/aglyn": "1.0.0-beta.221",
-    "@aglyn/shared-data-mdi": "1.0.0-beta.221",
-    "@aglyn/shared-ui-jsx": "1.0.0-beta.221",
-    "@aglyn/shared-ui-next": "1.0.0-beta.221",
-    "@aglyn/shared-ui-snackstack": "1.0.0-beta.221",
-    "@aglyn/shared-util-email": "1.0.0-beta.221",
-    "@aglyn/shared-util-http": "1.0.0-beta.221",
-    "@aglyn/shared-util-timestamp": "1.0.0-beta.221",
-    "@aglyn/tenant-data-admin": "1.0.0-beta.221",
-    "@aglyn/tenant-feature-instance": "1.0.0-beta.221",
-    "@aglyn/tenant-runtime": "1.0.0-beta.221",
+    "@aglyn/aglyn": "1.0.0-beta.223",
+    "@aglyn/shared-data-mdi": "1.0.0-beta.223",
+    "@aglyn/shared-ui-jsx": "1.0.0-beta.223",
+    "@aglyn/shared-ui-next": "1.0.0-beta.223",
+    "@aglyn/shared-ui-snackstack": "1.0.0-beta.223",
+    "@aglyn/shared-util-email": "1.0.0-beta.223",
+    "@aglyn/shared-util-http": "1.0.0-beta.223",
+    "@aglyn/shared-util-timestamp": "1.0.0-beta.223",
+    "@aglyn/tenant-data-admin": "1.0.0-beta.223",
+    "@aglyn/tenant-feature-instance": "1.0.0-beta.223",
+    "@aglyn/tenant-runtime": "1.0.0-beta.223",
     "@swc/helpers": "0.5.23"
   },
   "peerDependencies": {

package/src/lib/components/automation-step-fields.component.d.ts

@@ -1,19 +1,5 @@
-/**
- * ONE STEP EDITOR FOR BOTH AUTOMATION BUILDERS (AGL-3105).
- *
- * A step's fields belong to the step, not to the card the step is edited on.
- * The Actions builder and the Workflows builder both hold an ordered list of
- * steps, and a workflow step may be any server-side Actions step, so the
- * fields it takes — which dataset, which campaign, how long to wait, what to
- * say — are asked here and in one place. A second copy would be two editors
- * of one vocabulary, drifting a field at a time.
- *
- * What the card keeps is the list: what "Add step" builds, how many are
- * allowed, and what a kind the Actions vocabulary does not hold looks like —
- * a workflow's function call, handed in as `fields`.
- */
-import { type HostActionStep, type HostActionStepType } from '@aglyn/aglyn';
 import type { ReactNode } from 'react';
+import { type HostActionStep, type HostActionStepType } from '../model/host-actions';
 /**
  * What a field holding a placeholder shows: an error state and what to do
  * about it. A placeholder is a value a person still has to supply, written in
@@ -66,9 +52,23 @@ export interface AutomationStepFieldsProps {
      * step and a function call is not one.
      */
     fields?: ReactNode;
+    /**
+     * Where the step sits (AGL-3458): the automation's trigger event and
+     * whether a wait comes before it — what decides whether a `sendEmail` step
+     * can be a transactional reply. Absent, the email step shows no switch.
+     */
+    replyContext?: {
+        event: string | null | undefined;
+        afterWait: boolean;
+    };
 }
+/**
+ * What the email step says about its merge tags (AGL-3458): both spellings
+ * the run fills, from the contact or the lead the event is about.
+ */
+export declare const SEND_EMAIL_MERGE_HELP: string;
 /**
  * One step's row: its number, what it does, the fields that kind takes, and
  * the condition that gates it.
  */
-export declare function AutomationStepFields({ step, index, kind, kinds, stepForKind, pickers, onSteps, fields, }: AutomationStepFieldsProps): import("react").JSX.Element;
+export declare function AutomationStepFields({ step, index, kind, kinds, stepForKind, pickers, onSteps, fields, replyContext, }: AutomationStepFieldsProps): import("react").JSX.Element;

package/src/lib/components/automation-step-fields.component.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */ 'use client';
 import { _ as _extends } from "@swc/helpers/_/_extends";
+import { _ as _object_without_properties_loose } from "@swc/helpers/_/_object_without_properties_loose";
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
 /**
  * ONE STEP EDITOR FOR BOTH AUTOMATION BUILDERS (AGL-3105).
@@ -29,9 +30,24 @@ import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-run
  * What the card keeps is the list: what "Add step" builds, how many are
  * allowed, and what a kind the Actions vocabulary does not hold looks like —
  * a workflow's function call, handed in as `fields`.
- */ import { CONTACT_LIFECYCLE_STAGE_LABELS, CONTACT_LIFECYCLE_STAGES, CONTACT_TAG_MAX_LENGTH, CRM_ACTIVITY_KIND_LABELS, CRM_ACTIVITY_KINDS, CRM_TASK_KIND_LABELS, CRM_TASK_KINDS, CRM_TASK_MAX_DUE_DAYS, HOST_EVENT_TYPES, hostEventLabel, isInteractionAttributeAllowed } from "@aglyn/aglyn";
-import { automationPlaceholderIn } from "@aglyn/aglyn/app-utils/automation-placeholders";
-import { IconButton, MenuItem, Stack, TextField, Typography } from "@mui/material";
+ */ import { CONTACT_LIFECYCLE_STAGE_LABELS, CONTACT_LIFECYCLE_STAGES, CONTACT_TAG_MAX_LENGTH, CRM_ACTIVITY_DIRECTION_LABELS, CRM_ACTIVITY_DIRECTIONS, CRM_ACTIVITY_KIND_LABELS, CRM_ACTIVITY_KINDS, CRM_TASK_KIND_LABELS, CRM_TASK_KINDS, CRM_TASK_MAX_DUE_DAYS, HOST_EVENT_TYPES, hostEventLabel, isInteractionAttributeAllowed } from "@aglyn/aglyn";
+import { FormControlLabel, FormHelperText, IconButton, MenuItem, Stack, Switch, TextField, Typography } from "@mui/material";
+import { SEND_EMAIL_REPLY_INELIGIBLE_REASONS, sendEmailIsTransactionalReply, sendEmailReplyIneligibility } from "../model/host-actions.js";
+import { draftPlaceholderIn } from "@aglyn/aglyn/app-utils/draft-placeholders";
+/** A task's priorities, by meaning, as the create-task step offers them (AGL-3517). */ const TASK_PRIORITY_OPTIONS = [
+    {
+        value: 'high',
+        label: 'High'
+    },
+    {
+        value: 'normal',
+        label: 'Normal'
+    },
+    {
+        value: 'low',
+        label: 'Low'
+    }
+];
 /**
  * The durations a wait may be set to, from the picker.
  *
@@ -120,7 +136,7 @@ import { IconButton, MenuItem, Stack, TextField, Typography } from "@mui/materia
  * square brackets where it belongs — an automation drafted for review carries
  * one wherever it could not name a real record or did not know a fact.
  */ export function placeholderState(value, help) {
-    return automationPlaceholderIn(value) ? {
+    return draftPlaceholderIn(value) ? {
         error: true,
         helperText: help
     } : {};
@@ -129,7 +145,7 @@ import { IconButton, MenuItem, Stack, TextField, Typography } from "@mui/materia
  * A picker whose stored reference is a placeholder name and no id: the record
  * the draft asked for, which the site did not have when it was written.
  */ function placeholderReference(name, id, noun) {
-    const words = String(id != null ? id : '').trim() ? null : automationPlaceholderIn(name);
+    const words = String(id != null ? id : '').trim() ? null : draftPlaceholderIn(name);
     return words ? {
         error: true,
         helperText: `Pick the ${noun} — the draft asked for “${words}”`
@@ -323,12 +339,52 @@ export function defaultStep(type) {
             };
     }
 }
+/**
+ * The email step's TRANSACTIONAL REPLY switch (AGL-3458) — visible on every
+ * email step, so which kind of message it sends is never a guess.
+ *
+ * On by default for a step that qualifies: the trigger is the recipient's own
+ * form submission, booking or sign-up, nothing waits before the step, and it
+ * goes to the address the event carries. Such a reply leaves with no
+ * unsubscribe header and no unsubscribe link. A step that does not qualify
+ * shows the switch off and disabled, saying why, because it is a mailing and
+ * keeps its unsubscribe whatever it says.
+ */ function SendEmailReplySwitch({ step, context, onChange }) {
+    const ineligible = sendEmailReplyIneligibility(step, context);
+    const on = sendEmailIsTransactionalReply(step, context);
+    return /*#__PURE__*/ _jsxs(Stack, {
+        sx: {
+            pl: 3
+        },
+        children: [
+            /*#__PURE__*/ _jsx(FormControlLabel, {
+                control: /*#__PURE__*/ _jsx(Switch, {
+                    size: "small",
+                    checked: on,
+                    disabled: ineligible !== null,
+                    onChange: (event)=>onChange(event.target.checked)
+                }),
+                label: "Transactional reply (no unsubscribe)"
+            }),
+            /*#__PURE__*/ _jsx(FormHelperText, {
+                sx: {
+                    mt: 0
+                },
+                children: ineligible ? `Sent as a mailing with an unsubscribe link: ${SEND_EMAIL_REPLY_INELIGIBLE_REASONS[ineligible]}.` : on ? 'Answers what this person just did, so it goes without an unsubscribe ' + 'link or header. Bounced, complaining and unsubscribed addresses are still skipped.' : 'Sent as a mailing, with an unsubscribe link and header.'
+            })
+        ]
+    });
+}
+/**
+ * What the email step says about its merge tags (AGL-3458): both spellings
+ * the run fills, from the contact or the lead the event is about.
+ */ export const SEND_EMAIL_MERGE_HELP = 'Merge tags: {{firstName|there}}, {{name}}, {{email}}, or {{contact.firstName}}, ' + '{{lead.company}}, {{site.name}} — filled from the contact or lead the event is ' + 'about; the text after | is used when there is no value.';
 /**
  * One step's row: its number, what it does, the fields that kind takes, and
  * the condition that gates it.
- */ export function AutomationStepFields({ step, index, kind, kinds, stepForKind, pickers, onSteps, fields }) {
-    var _ref, _step_workflowId, _step_severity, _ref1, _step_webhookId, _ref2, _step_datasetId, _step_overlayId, _step_selector, _step_selector1, _step_className, _step_selector2, _step_selector3, _step_offsetPx, _step_selector4, _step_name, _step_value, _step_drawerNodeId, _step_menuNodeId, _step_html, _step_code, _step_url, _step_eventName, _step_subject, _step_body, _step_title, _step_listId, _step_campaignId, _step_lifecycleStage, _step_tag, _step_title1, _step_kind, _step_dueInDays, _step_kind1, _step_body1, _step_eventName1, _step_timeoutMinutes, _step_delayMinutes, _ref3, _step_when_conditions__field, _step_when_conditions__value;
-    var _workflowOptions_find, _webhookOptions_find, _datasetOptions_find, _step_when_conditions_, _step_when_conditions, _step_when, _step_when_conditions_1, _step_when_conditions1, _step_when1, _step_when_conditions_2, _step_when_conditions2, _step_when2, _step_when_conditions_3, _step_when_conditions3, _step_when3;
+ */ export function AutomationStepFields({ step, index, kind, kinds, stepForKind, pickers, onSteps, fields, replyContext }) {
+    var _ref, _step_workflowId, _step_severity, _ref1, _step_webhookId, _ref2, _step_datasetId, _step_overlayId, _step_selector, _step_selector1, _step_className, _step_selector2, _step_selector3, _step_offsetPx, _step_selector4, _step_name, _step_value, _step_drawerNodeId, _step_menuNodeId, _step_html, _step_code, _step_url, _step_eventName, _step_subject, _step_body, _step_title, _step_listId, _step_campaignId, _step_lifecycleStage, _step_tag, _step_title1, _step_kind, _step_priority, _step_dueInDays, _step_kind1, _step_direction, _CRM_ACTIVITY_DIRECTIONS_step_kind, _step_body1, _step_eventName1, _step_timeoutMinutes, _step_delayMinutes, _ref3, _step_when_conditions__field, _step_when_conditions__value;
+    var _workflowOptions_find, _webhookOptions_find, _datasetOptions_find, _CRM_ACTIVITY_DIRECTIONS_step_kind1, _step_when_conditions_, _step_when_conditions, _step_when, _step_when_conditions_1, _step_when_conditions1, _step_when1, _step_when_conditions_2, _step_when_conditions2, _step_when2, _step_when_conditions_3, _step_when_conditions3, _step_when3;
     const { workflowOptions, datasetOptions, overlayOptions, listOptions, campaignOptions, webhookOptions } = pickers;
     /*
    * The list, edited as a draft holding it — the shape both cards' own
@@ -774,6 +830,7 @@ export function defaultStep(type) {
                                 size: "small",
                                 multiline: true,
                                 maxRows: 3,
+                                helperText: SEND_EMAIL_MERGE_HELP,
                                 sx: {
                                     flex: 1
                                 }
@@ -962,7 +1019,7 @@ export function defaultStep(type) {
                             })),
                             /*#__PURE__*/ _jsx(TextField, {
                                 select: true,
-                                label: "Kind",
+                                label: "Type",
                                 value: (_step_kind = step.kind) != null ? _step_kind : '',
                                 onChange: (event)=>patch((previous)=>_extends({}, previous, {
                                             steps: previous.steps.map((s, index2)=>index2 === index && s.type === 'createCrmTask' ? _extends({}, s, {
@@ -978,6 +1035,24 @@ export function defaultStep(type) {
                                         children: CRM_TASK_KIND_LABELS[kind]
                                     }, kind))
                             }),
+                            /*#__PURE__*/ _jsx(TextField, {
+                                select: true,
+                                label: "Priority",
+                                value: (_step_priority = step.priority) != null ? _step_priority : 'normal',
+                                onChange: (event)=>patch((previous)=>_extends({}, previous, {
+                                            steps: previous.steps.map((s, index2)=>index2 === index && s.type === 'createCrmTask' ? _extends({}, s, {
+                                                    priority: event.target.value
+                                                }) : s)
+                                        })),
+                                size: "small",
+                                sx: {
+                                    minWidth: 110
+                                },
+                                children: TASK_PRIORITY_OPTIONS.map((option)=>/*#__PURE__*/ _jsx(MenuItem, {
+                                        value: option.value,
+                                        children: option.label
+                                    }, option.value))
+                            }),
                             /*#__PURE__*/ _jsx(TextField, {
                                 type: "number",
                                 label: "Due in (days)",
@@ -1012,9 +1087,21 @@ export function defaultStep(type) {
                                 label: "Kind",
                                 value: (_step_kind1 = step.kind) != null ? _step_kind1 : '',
                                 onChange: (event)=>patch((previous)=>_extends({}, previous, {
-                                            steps: previous.steps.map((s, index2)=>index2 === index && s.type === 'logCrmActivity' ? _extends({}, s, {
-                                                    kind: event.target.value
-                                                }) : s)
+                                            steps: previous.steps.map((s, index2)=>{
+                                                var _CRM_ACTIVITY_DIRECTIONS_kind;
+                                                if (index2 !== index || s.type !== 'logCrmActivity') return s;
+                                                const kind = event.target.value;
+                                                // A direction the new kind does not take goes with the old one.
+                                                const { direction } = s, rest = _object_without_properties_loose(s, [
+                                                    "direction"
+                                                ]);
+                                                return direction && ((_CRM_ACTIVITY_DIRECTIONS_kind = CRM_ACTIVITY_DIRECTIONS[kind]) != null ? _CRM_ACTIVITY_DIRECTIONS_kind : []).includes(direction) ? _extends({}, rest, {
+                                                    kind,
+                                                    direction
+                                                }) : _extends({}, rest, {
+                                                    kind
+                                                });
+                                            })
                                         })),
                                 size: "small",
                                 sx: {
@@ -1025,6 +1112,44 @@ export function defaultStep(type) {
                                         children: CRM_ACTIVITY_KIND_LABELS[kind]
                                     }, kind))
                             }),
+                            ((_CRM_ACTIVITY_DIRECTIONS_step_kind1 = CRM_ACTIVITY_DIRECTIONS[step.kind]) == null ? void 0 : _CRM_ACTIVITY_DIRECTIONS_step_kind1.length) ? /*#__PURE__*/ _jsxs(TextField, {
+                                select: true,
+                                label: "Direction",
+                                value: (_step_direction = step.direction) != null ? _step_direction : '',
+                                onChange: (event)=>patch((previous)=>_extends({}, previous, {
+                                            steps: previous.steps.map((s, index2)=>{
+                                                if (index2 !== index || s.type !== 'logCrmActivity') return s;
+                                                const { direction: _direction } = s, rest = _object_without_properties_loose(s, [
+                                                    "direction"
+                                                ]);
+                                                return event.target.value ? _extends({}, rest, {
+                                                    direction: event.target.value
+                                                }) : rest;
+                                            })
+                                        })),
+                                size: "small",
+                                sx: {
+                                    minWidth: 120
+                                },
+                                slotProps: {
+                                    select: {
+                                        displayEmpty: true
+                                    },
+                                    inputLabel: {
+                                        shrink: true
+                                    }
+                                },
+                                children: [
+                                    /*#__PURE__*/ _jsx(MenuItem, {
+                                        value: "",
+                                        children: 'Not said'
+                                    }),
+                                    ((_CRM_ACTIVITY_DIRECTIONS_step_kind = CRM_ACTIVITY_DIRECTIONS[step.kind]) != null ? _CRM_ACTIVITY_DIRECTIONS_step_kind : []).map((direction)=>/*#__PURE__*/ _jsx(MenuItem, {
+                                            value: direction,
+                                            children: CRM_ACTIVITY_DIRECTION_LABELS[direction]
+                                        }, direction))
+                                ]
+                            }) : null,
                             /*#__PURE__*/ _jsx(TextField, _extends({
                                 label: "What happened"
                             }, placeholderState(step.body, 'Fill in the placeholders'), {
@@ -1103,6 +1228,15 @@ export function defaultStep(type) {
                     })
                 ]
             }),
+            !fields && step.type === 'sendEmail' && replyContext ? /*#__PURE__*/ _jsx(SendEmailReplySwitch, {
+                step: step,
+                context: replyContext,
+                onChange: (transactional)=>patch((previous)=>_extends({}, previous, {
+                            steps: previous.steps.map((s, index2)=>index2 === index ? _extends({}, s, {
+                                    transactional
+                                }) : s)
+                        }))
+            }) : null,
             fields ? null : /*#__PURE__*/ _jsxs(Stack, {
                 direction: "row",
                 spacing: 1,