aspnetzero-workflow-designer 1.0.1 → 1.0.2

package/README.md

@@ -167,8 +167,8 @@ because it carries no framework dependency and therefore works identically insid
 
 ### How the hosts get the designer
 
-The hosts never use this folder. All three install the published `aspnetzero-workflow-designer` package
-from npm, so the three UIs run the same build:
+ASP.NET Zero lives in its own repository and never reads this one. All three of its UIs install the
+published `aspnetzero-workflow-designer` package from npm, so they run the same build:
 
 | Host | How it gets the designer |
 |---|---|
@@ -176,29 +176,36 @@ from npm, so the three UIs run the same build:
 | React (`react/`) | `aspnetzero-workflow-designer` dependency, imports the ESM build |
 | ASP.NET Core MVC (`Web.Mvc`) | `aspnetzero-workflow-designer` dependency; `bundles.json` turns `dist/workflow-designer.umd.cjs` into `_Bundles/workflow-designer.min.js` |
 
+### The contract with the server
+
+`npm run build` also writes `dist/workflow-contract.json`: the step kinds, input names, default keys,
+vocabularies, schema versions and localization keys this version uses, taken from the same constants the
+bundle is built from (see `src/contract/workflow-contract.ts`). ASP.NET Zero keeps a copy in its test
+project. `WorkflowDesignerContract_Tests` and the other contract tests there compare the server with that
+copy, and fail when the copy is not the version a host locks.
+
 ### Releasing a change
 
 1. Change the package, then run `npm test` and `npm run build`.
 2. Raise `version` in `package.json` (a new step kind or input is a minor version, a fix a patch).
 3. Run `npm publish`. `prepublishOnly` runs the tests and the build again, so a broken package is not
    published.
-4. In `angular/`, `react/` and `aspnet-core/src/MyCompanyName.AbpZeroTemplate.Web.Mvc/`, run
-   `pnpm update aspnetzero-workflow-designer` and commit the lockfiles with the server change that
-   needed the new version.
-
-`WorkflowNodeTypeContract_Tests` and the other contract tests in the server test project read this
-folder's `src/`, so the server and the designer can not drift apart unnoticed.
+4. In the ASP.NET Zero repository, in `angular/`, `react/` and
+   `aspnet-core/src/MyCompanyName.AbpZeroTemplate.Web.Mvc/`, run
+   `pnpm add aspnetzero-workflow-designer@~<version>`.
+5. At the root of that repository, run `npm run refresh-workflow-designer-contract`, then commit the
+   result and the lockfiles with the server change that needed the new version.
 
 ### Trying a change in a host before publishing
 
-Point a host at this folder for the time being:
+With the two repositories checked out side by side, point a host at this folder for the time being:
 
 ```bash
 cd angular            # or react
-pnpm link ../workflow-designer
+pnpm link ../../workflow-designer
 
 cd aspnet-core/src/MyCompanyName.AbpZeroTemplate.Web.Mvc
-pnpm link ../../../workflow-designer
+pnpm link ../../../../workflow-designer
 ```
 
 The host now reads this folder's `dist/`, so run `npm run build` here after each change (MVC also needs

package/dist/workflow-contract.json

@@ -0,0 +1,535 @@
+{
+  "packageVersion": "1.0.2",
+  "graphSchemaVersion": 3,
+  "formSchemaVersion": 1,
+  "nodeTypes": {
+    "Start": 1,
+    "FormSubmission": 2,
+    "Approval": 3,
+    "Condition": 4,
+    "Notification": 5,
+    "Action": 6,
+    "Approved": 7,
+    "Rejected": 8,
+    "Cancelled": 9,
+    "Parallel": 10,
+    "Join": 11,
+    "Timer": 12,
+    "Subprocess": 13,
+    "EventWait": 14,
+    "SendSlackMessage": 15,
+    "SendTeamsMessage": 16,
+    "RunAiAgent": 17
+  },
+  "selfApprovalPolicies": {
+    "TenantDefault": 0,
+    "Deny": 1,
+    "Allow": 2,
+    "SkipStep": 3
+  },
+  "conditionOperandTypes": {
+    "FormField": 1,
+    "Constant": 2,
+    "RequesterContext": 3,
+    "TenantContext": 4,
+    "SystemContext": 5,
+    "Variable": 6
+  },
+  "variableTypeNames": [
+    "String",
+    "Boolean",
+    "Int32",
+    "Int64",
+    "Decimal",
+    "Double",
+    "DateTime",
+    "Guid",
+    "Json"
+  ],
+  "variableScopes": {
+    "instance": 1,
+    "branch": 2
+  },
+  "schemaVariableScopes": {
+    "instance": 1,
+    "branch": 2
+  },
+  "variableDefinitionFields": [
+    "id",
+    "name",
+    "typeName",
+    "isArray",
+    "value",
+    "scope",
+    "isSensitive",
+    "displayName"
+  ],
+  "reservedVariablePrefix": "__out.",
+  "uiHints": [
+    "singleline",
+    "multiline",
+    "checkbox",
+    "checklist",
+    "radiolist",
+    "dropdown",
+    "multitext",
+    "dictionary",
+    "json-editor",
+    "datetime-picker",
+    "variable-picker",
+    "output-picker",
+    "outcome-picker",
+    "dynamic-outcomes",
+    "workflow-definition-picker",
+    "expression-editor",
+    "secret-picker",
+    "connection-dropdown",
+    "http-status-codes",
+    "assignee-picker",
+    "role-picker",
+    "organization-unit-picker",
+    "form-field-picker",
+    "condition-builder",
+    "field-mapping-table",
+    "sla-editor",
+    "channel-editor",
+    "adaptive-card-editor",
+    "event-payload-mapping-table",
+    "action-parameter-table",
+    "condition-branch-table",
+    "parallel-branch-table",
+    "start-trigger-editor",
+    "notification-recipients"
+  ],
+  "expressionSyntaxes": [
+    "Literal",
+    "FormField",
+    "Context",
+    "Variable",
+    "Output",
+    "Condition",
+    "Template",
+    "Secret"
+  ],
+  "builtInInputs": {
+    "FormSubmission": [
+      "formSubmission.readOnlyFieldIds",
+      "formSubmission.allowAttachments",
+      "formSubmission.allowWithdraw",
+      "sla"
+    ],
+    "Approval": [
+      "approval.targets",
+      "approval.approvalPolicy",
+      "approval.quorumCount",
+      "approval.allowDelegation",
+      "approval.allowRequestChanges",
+      "approval.requireReasonOnReject",
+      "channels.channels",
+      "channels.connectionProfileName",
+      "channels.allowDecisionFromChannel",
+      "sla"
+    ],
+    "Condition": [
+      "condition.branches"
+    ],
+    "Notification": [
+      "notification.notificationName",
+      "notification.subject",
+      "notification.body",
+      "notification.sendInApp",
+      "notification.sendEmail",
+      "notification.recipients",
+      "channels.channels",
+      "channels.connectionProfileName"
+    ],
+    "Action": [
+      "action.kind",
+      "action.actionName",
+      "action.webhookName",
+      "action.connectionProfileName",
+      "action.relativePath",
+      "action.httpMethod",
+      "action.timeoutInSeconds",
+      "action.maxAttempts",
+      "action.continueOnFailure",
+      "action.inputBindings"
+    ],
+    "Parallel": [
+      "parallel.joinNodeId",
+      "parallel.cancelRemainingBranchesOnRejection"
+    ],
+    "Join": [
+      "join.parallelNodeId",
+      "join.mode",
+      "join.requiredBranchCount"
+    ],
+    "Timer": [
+      "timer.mode",
+      "timer.durationInMinutes",
+      "timer.fieldId",
+      "timer.offsetInMinutes",
+      "timer.fixedDate",
+      "timer.useBusinessCalendar"
+    ],
+    "Subprocess": [
+      "subprocess.workflowDefinitionId",
+      "subprocess.waitForCompletion",
+      "subprocess.outcomeMode",
+      "subprocess.cancelChildOnParentCancel",
+      "subprocess.inputMappings"
+    ],
+    "EventWait": [
+      "eventWait.eventName",
+      "eventWait.correlationSource",
+      "eventWait.correlationFieldKey",
+      "eventWait.timeout.dueInMinutes",
+      "eventWait.timeout.useBusinessCalendar",
+      "eventWait.onTimeout",
+      "eventWait.payloadMappings",
+      "eventWait.waitingMessage"
+    ]
+  },
+  "builtInInputDefaults": {
+    "FormSubmission": [
+      "formSubmission.allowAttachments",
+      "formSubmission.allowWithdraw"
+    ],
+    "Approval": [
+      "approval.targets",
+      "approval.approvalPolicy",
+      "approval.rejectionPolicy",
+      "approval.selfApprovalPolicy",
+      "approval.allowDelegation",
+      "approval.allowRequestChanges",
+      "approval.requireReasonOnApprove",
+      "approval.requireReasonOnReject",
+      "approval.requireReasonOnRequestChanges",
+      "channels.allowDecisionFromChannel"
+    ],
+    "Condition": [
+      "condition.branches"
+    ],
+    "Notification": [
+      "notification.sendInApp",
+      "notification.sendEmail"
+    ],
+    "Action": [
+      "action.kind",
+      "action.continueOnFailure"
+    ],
+    "Parallel": [
+      "parallel.cancelRemainingBranchesOnRejection"
+    ],
+    "Join": [
+      "join.mode"
+    ],
+    "Timer": [
+      "timer.mode",
+      "timer.durationInMinutes",
+      "timer.useBusinessCalendar"
+    ],
+    "Subprocess": [
+      "subprocess.waitForCompletion",
+      "subprocess.outcomeMode",
+      "subprocess.cancelChildOnParentCancel",
+      "subprocess.inputMappings"
+    ],
+    "EventWait": [
+      "eventWait.correlationSource",
+      "eventWait.onTimeout",
+      "eventWait.payloadMappings"
+    ],
+    "SendSlackMessage": [
+      "sendSlackMessage.severity",
+      "sendSlackMessage.includeDeepLink",
+      "sendSlackMessage.factFieldIds"
+    ],
+    "SendTeamsMessage": [
+      "sendTeamsMessage.severity",
+      "sendTeamsMessage.includeDeepLink",
+      "sendTeamsMessage.factFieldIds"
+    ],
+    "RunAiAgent": [
+      "runAiAgent.continueOnFailure"
+    ]
+  },
+  "localizationKeys": [
+    "WorkflowActionBinding_Condition",
+    "WorkflowActionBinding_Constant",
+    "WorkflowActionBinding_Context",
+    "WorkflowActionBinding_FormField",
+    "WorkflowActionBinding_Output",
+    "WorkflowActionBinding_Secret",
+    "WorkflowActionBinding_Template",
+    "WorkflowActionBinding_Variable",
+    "WorkflowActionConnectionProfile",
+    "WorkflowActionContinueOnFailure",
+    "WorkflowActionHasNoInputs",
+    "WorkflowActionHttpMethod",
+    "WorkflowActionHttpMethod_Delete",
+    "WorkflowActionHttpMethod_Get",
+    "WorkflowActionHttpMethod_Patch",
+    "WorkflowActionHttpMethod_Post",
+    "WorkflowActionHttpMethod_Put",
+    "WorkflowActionInputs",
+    "WorkflowActionKind",
+    "WorkflowActionKind_HttpConnectionProfile",
+    "WorkflowActionKind_RegisteredApplicationAction",
+    "WorkflowActionKind_Webhook",
+    "WorkflowActionMaxAttempts",
+    "WorkflowActionMaxLength",
+    "WorkflowActionName",
+    "WorkflowActionRelativePath",
+    "WorkflowActionRequiresFeature",
+    "WorkflowActionTimeout",
+    "WorkflowActionWebhookName",
+    "WorkflowAi_SummaryCouldNotBeProduced",
+    "WorkflowApprovalAllowDelegation",
+    "WorkflowApprovalAllowRequestChanges",
+    "WorkflowApprovalPolicy",
+    "WorkflowApprovalPolicy_Anyone",
+    "WorkflowApprovalPolicy_Everyone",
+    "WorkflowApprovalPolicy_Quorum",
+    "WorkflowApprovalQuorumCount",
+    "WorkflowApprovalRequireReasonOnReject",
+    "WorkflowBranch",
+    "WorkflowBranchAdd",
+    "WorkflowBranchAdvancedExpression",
+    "WorkflowBranchChooseField",
+    "WorkflowBranchField",
+    "WorkflowBranchName",
+    "WorkflowBranchNeedsFormFields",
+    "WorkflowBranchNotConnected",
+    "WorkflowBranchOperator",
+    "WorkflowBranchRemove",
+    "WorkflowBranchValue",
+    "WorkflowBranchValueList",
+    "WorkflowBranches",
+    "WorkflowBranchesEmpty",
+    "WorkflowChannelAllowDecision",
+    "WorkflowChannelConnectionProfile",
+    "WorkflowChannel_Slack",
+    "WorkflowChannel_Teams",
+    "WorkflowChannels",
+    "WorkflowChannelsNodeHint",
+    "WorkflowConditionSuggest",
+    "WorkflowConditionSuggestApply",
+    "WorkflowConditionSuggestFailed",
+    "WorkflowConditionSuggestHint",
+    "WorkflowDesignerAddVariable",
+    "WorkflowDesignerAutoLayout",
+    "WorkflowDesignerCanvasView",
+    "WorkflowDesignerCardNoBody",
+    "WorkflowDesignerCardNotAnObject",
+    "WorkflowDesignerCardNotJson",
+    "WorkflowDesignerCardPlaceholder",
+    "WorkflowDesignerCardWrongType",
+    "WorkflowDesignerConnection",
+    "WorkflowDesignerConnectionOutcome",
+    "WorkflowDesignerConnections",
+    "WorkflowDesignerCopy",
+    "WorkflowDesignerDelete",
+    "WorkflowDesignerDropHere",
+    "WorkflowDesignerHidePalette",
+    "WorkflowDesignerInspector",
+    "WorkflowDesignerMarkReviewed",
+    "WorkflowDesignerMultiSelection",
+    "WorkflowDesignerNoOptions",
+    "WorkflowDesignerNoSecrets",
+    "WorkflowDesignerNoSelection",
+    "WorkflowDesignerNoStepMatches",
+    "WorkflowDesignerNotSelected",
+    "WorkflowDesignerOutline",
+    "WorkflowDesignerOutlineEmpty",
+    "WorkflowDesignerOutlineHint",
+    "WorkflowDesignerPalette",
+    "WorkflowDesignerPaste",
+    "WorkflowDesignerRedo",
+    "WorkflowDesignerRemoveConnection",
+    "WorkflowDesignerRemoveStep",
+    "WorkflowDesignerResetZoom",
+    "WorkflowDesignerSchemaVersionDesignerOutdated",
+    "WorkflowDesignerSchemaVersionServerOutdated",
+    "WorkflowDesignerSearchSteps",
+    "WorkflowDesignerSecretUnusable",
+    "WorkflowDesignerSensitiveKept",
+    "WorkflowDesignerShowIssue",
+    "WorkflowDesignerShowPalette",
+    "WorkflowDesignerStepCount",
+    "WorkflowDesignerStepDescription",
+    "WorkflowDesignerStepLimitReached",
+    "WorkflowDesignerStepName",
+    "WorkflowDesignerStepNotReviewed",
+    "WorkflowDesignerSummary",
+    "WorkflowDesignerSummaryAction",
+    "WorkflowDesignerSummaryApproval",
+    "WorkflowDesignerSummaryApprovalOutcomes",
+    "WorkflowDesignerSummaryApproved",
+    "WorkflowDesignerSummaryCancelled",
+    "WorkflowDesignerSummaryCondition",
+    "WorkflowDesignerSummaryDue",
+    "WorkflowDesignerSummaryEmpty",
+    "WorkflowDesignerSummaryForm",
+    "WorkflowDesignerSummaryHide",
+    "WorkflowDesignerSummaryJoin",
+    "WorkflowDesignerSummaryNotification",
+    "WorkflowDesignerSummaryParallel",
+    "WorkflowDesignerSummaryRejected",
+    "WorkflowDesignerSummaryShow",
+    "WorkflowDesignerSummaryStart",
+    "WorkflowDesignerSummarySubprocess",
+    "WorkflowDesignerSummaryTimer",
+    "WorkflowDesignerSummaryTimerDuration",
+    "WorkflowDesignerTabGeneral",
+    "WorkflowDesignerUndo",
+    "WorkflowDesignerUnknownOutput",
+    "WorkflowDesignerUnknownSecret",
+    "WorkflowDesignerUnknownVariable",
+    "WorkflowDesignerVariableName",
+    "WorkflowDesignerVariableNameDuplicate",
+    "WorkflowDesignerVariableNameRequired",
+    "WorkflowDesignerVariableNameReserved",
+    "WorkflowDesignerVariableScope",
+    "WorkflowDesignerVariableScopeBranch",
+    "WorkflowDesignerVariableScopeInstance",
+    "WorkflowDesignerVariableSensitive",
+    "WorkflowDesignerVariableType",
+    "WorkflowDesignerVariableValue",
+    "WorkflowDesignerVariables",
+    "WorkflowDesignerVariablesHint",
+    "WorkflowDesignerZoomIn",
+    "WorkflowDesignerZoomOut",
+    "WorkflowDesignerZoomToFit",
+    "WorkflowEdgeKind_Approved",
+    "WorkflowEdgeKind_ChangesRequested",
+    "WorkflowEdgeKind_ConditionBranch",
+    "WorkflowEdgeKind_Default",
+    "WorkflowEdgeKind_EventReceived",
+    "WorkflowEdgeKind_EventTimeout",
+    "WorkflowEdgeKind_Otherwise",
+    "WorkflowEdgeKind_ParallelBranch",
+    "WorkflowEdgeKind_Rejected",
+    "WorkflowEdgeKind_SubprocessCompleted",
+    "WorkflowEdgeKind_SubprocessRejected",
+    "WorkflowEdgeKind_TimerElapsed",
+    "WorkflowEdgeKind_Unknown",
+    "WorkflowEventCorrelationSource_BusinessKey",
+    "WorkflowEventCorrelationSource_FormField",
+    "WorkflowEventCorrelationSource_ReferenceNumber",
+    "WorkflowEventTimeoutBehavior_ContinueTimeoutPath",
+    "WorkflowEventTimeoutBehavior_NeedsAttention",
+    "WorkflowEventWaitAddMapping",
+    "WorkflowEventWaitCorrelation",
+    "WorkflowEventWaitCorrelationField",
+    "WorkflowEventWaitEvent",
+    "WorkflowEventWaitMappingsEmpty",
+    "WorkflowEventWaitNeedsTargetField",
+    "WorkflowEventWaitOnTimeout",
+    "WorkflowEventWaitPayloadMappings",
+    "WorkflowEventWaitRemoveMapping",
+    "WorkflowEventWaitSourcePath",
+    "WorkflowEventWaitTargetField",
+    "WorkflowEventWaitTimeout",
+    "WorkflowEventWaitTimeoutEdgeNotAllowedHint",
+    "WorkflowEventWaitTimeoutEdgeRequiredHint",
+    "WorkflowEventWaitTimeoutHint",
+    "WorkflowEventWaitWaitingMessage",
+    "WorkflowEvent_EventWaitIsDisabled",
+    "WorkflowFieldType_Unknown",
+    "WorkflowFormAddOption",
+    "WorkflowFormAddSection",
+    "WorkflowFormAllowAttachments",
+    "WorkflowFormAllowWithdraw",
+    "WorkflowFormBuilderAttachmentsHint",
+    "WorkflowFormBuilderEmpty",
+    "WorkflowFormBuilderFields",
+    "WorkflowFormBuilderLayout",
+    "WorkflowFormBuilderNoSelection",
+    "WorkflowFormFieldKey",
+    "WorkflowFormFieldKeyFollowsLabelHint",
+    "WorkflowFormFieldKeyHint",
+    "WorkflowFormFieldLabel",
+    "WorkflowFormFieldSection",
+    "WorkflowFormFileAttachmentPublicFormOnly",
+    "WorkflowFormMoveDown",
+    "WorkflowFormMoveUp",
+    "WorkflowFormNewOption",
+    "WorkflowFormNewSection",
+    "WorkflowFormNoOptions",
+    "WorkflowFormOptionText",
+    "WorkflowFormReadOnlyFields",
+    "WorkflowFormRemoveField",
+    "WorkflowFormRemoveOption",
+    "WorkflowFormRemoveSection",
+    "WorkflowFormRepeaterAddField",
+    "WorkflowFormRepeaterFieldType",
+    "WorkflowFormRepeaterFields",
+    "WorkflowFormRequiredField",
+    "WorkflowFormSectionEmpty",
+    "WorkflowFormSectionTitle",
+    "WorkflowJoinMode",
+    "WorkflowJoinMode_WaitAll",
+    "WorkflowJoinMode_WaitAny",
+    "WorkflowJoinMode_WaitCount",
+    "WorkflowJoinParallelNode",
+    "WorkflowJoinRequiredBranchCount",
+    "WorkflowNodeCategory_Control",
+    "WorkflowNodeCategory_Flow",
+    "WorkflowNodeCategory_Human",
+    "WorkflowNodeCategory_Integration",
+    "WorkflowNodeCategory_Terminal",
+    "WorkflowNodeType_Unknown",
+    "WorkflowNotificationBody",
+    "WorkflowNotificationName",
+    "WorkflowNotificationRecipientPeople",
+    "WorkflowNotificationRecipientPreviousApprovers",
+    "WorkflowNotificationRecipientRequester",
+    "WorkflowNotificationRecipients",
+    "WorkflowNotificationSendEmail",
+    "WorkflowNotificationSendInApp",
+    "WorkflowNotificationSubject",
+    "WorkflowParallelCancelOnRejection",
+    "WorkflowParallelJoinNode",
+    "WorkflowSla",
+    "WorkflowSlaDueInMinutes",
+    "WorkflowSlaEscalateAfter",
+    "WorkflowSlaEscalateOnOverdue",
+    "WorkflowSlaEscalationTarget",
+    "WorkflowSlaReminderInterval",
+    "WorkflowSlaUseBusinessCalendar",
+    "WorkflowSubprocessAddMapping",
+    "WorkflowSubprocessCancelChild",
+    "WorkflowSubprocessInputMappings",
+    "WorkflowSubprocessMappingsEmpty",
+    "WorkflowSubprocessOutcomeMode",
+    "WorkflowSubprocessOutcomeMode_ApprovalOutcome",
+    "WorkflowSubprocessOutcomeMode_SingleOutcome",
+    "WorkflowSubprocessRemoveMapping",
+    "WorkflowSubprocessSourceField",
+    "WorkflowSubprocessTargetKey",
+    "WorkflowSubprocessWait",
+    "WorkflowSubprocessWorkflow",
+    "WorkflowSummaryExplainWithAi",
+    "WorkflowTargetAdd",
+    "WorkflowTargetRemove",
+    "WorkflowTargetSearch",
+    "WorkflowTargetType",
+    "WorkflowTarget_FallbackRole",
+    "WorkflowTarget_OrganizationUnit",
+    "WorkflowTarget_RequesterManager",
+    "WorkflowTarget_Role",
+    "WorkflowTarget_User",
+    "WorkflowTargets",
+    "WorkflowTargetsEmpty",
+    "WorkflowTimerDuration",
+    "WorkflowTimerField",
+    "WorkflowTimerFixedDate",
+    "WorkflowTimerMode",
+    "WorkflowTimerMode_Duration",
+    "WorkflowTimerMode_FixedDate",
+    "WorkflowTimerMode_FormFieldDate",
+    "WorkflowTimerOffset",
+    "WorkflowValidation_FieldAttachmentsRequireAttachmentsFeature"
+  ]
+}