@contractspec/example.workflow-system 1.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +124 -0
  3. package/dist/approval/approval.enum.d.ts +14 -0
  4. package/dist/approval/approval.enum.d.ts.map +1 -0
  5. package/dist/approval/approval.enum.js +29 -0
  6. package/dist/approval/approval.enum.js.map +1 -0
  7. package/dist/approval/approval.event.d.ts +131 -0
  8. package/dist/approval/approval.event.d.ts.map +1 -0
  9. package/dist/approval/approval.event.js +220 -0
  10. package/dist/approval/approval.event.js.map +1 -0
  11. package/dist/approval/approval.handler.d.ts +23 -0
  12. package/dist/approval/approval.handler.d.ts.map +1 -0
  13. package/dist/approval/approval.handler.js +72 -0
  14. package/dist/approval/approval.handler.js.map +1 -0
  15. package/dist/approval/approval.operations.d.ts +535 -0
  16. package/dist/approval/approval.operations.d.ts.map +1 -0
  17. package/dist/approval/approval.operations.js +345 -0
  18. package/dist/approval/approval.operations.js.map +1 -0
  19. package/dist/approval/approval.schema.d.ts +100 -0
  20. package/dist/approval/approval.schema.d.ts.map +1 -0
  21. package/dist/approval/approval.schema.js +110 -0
  22. package/dist/approval/approval.schema.js.map +1 -0
  23. package/dist/approval/index.d.ts +5 -0
  24. package/dist/approval/index.js +6 -0
  25. package/dist/docs/index.d.ts +1 -0
  26. package/dist/docs/index.js +1 -0
  27. package/dist/docs/workflow-system.docblock.d.ts +1 -0
  28. package/dist/docs/workflow-system.docblock.js +115 -0
  29. package/dist/docs/workflow-system.docblock.js.map +1 -0
  30. package/dist/entities/approval.d.ts +58 -0
  31. package/dist/entities/approval.d.ts.map +1 -0
  32. package/dist/entities/approval.js +128 -0
  33. package/dist/entities/approval.js.map +1 -0
  34. package/dist/entities/index.d.ts +139 -0
  35. package/dist/entities/index.d.ts.map +1 -0
  36. package/dist/entities/index.js +32 -0
  37. package/dist/entities/index.js.map +1 -0
  38. package/dist/entities/instance.d.ts +69 -0
  39. package/dist/entities/instance.d.ts.map +1 -0
  40. package/dist/entities/instance.js +168 -0
  41. package/dist/entities/instance.js.map +1 -0
  42. package/dist/entities/step.d.ts +50 -0
  43. package/dist/entities/step.d.ts.map +1 -0
  44. package/dist/entities/step.js +135 -0
  45. package/dist/entities/step.js.map +1 -0
  46. package/dist/entities/workflow.d.ts +41 -0
  47. package/dist/entities/workflow.d.ts.map +1 -0
  48. package/dist/entities/workflow.js +102 -0
  49. package/dist/entities/workflow.js.map +1 -0
  50. package/dist/example.d.ts +40 -0
  51. package/dist/example.d.ts.map +1 -0
  52. package/dist/example.js +51 -0
  53. package/dist/example.js.map +1 -0
  54. package/dist/index.d.ts +21 -0
  55. package/dist/index.js +21 -0
  56. package/dist/instance/index.d.ts +5 -0
  57. package/dist/instance/index.js +6 -0
  58. package/dist/instance/instance.enum.d.ts +10 -0
  59. package/dist/instance/instance.enum.d.ts.map +1 -0
  60. package/dist/instance/instance.enum.js +20 -0
  61. package/dist/instance/instance.enum.js.map +1 -0
  62. package/dist/instance/instance.event.d.ts +356 -0
  63. package/dist/instance/instance.event.d.ts.map +1 -0
  64. package/dist/instance/instance.event.js +293 -0
  65. package/dist/instance/instance.event.js.map +1 -0
  66. package/dist/instance/instance.handler.d.ts +27 -0
  67. package/dist/instance/instance.handler.d.ts.map +1 -0
  68. package/dist/instance/instance.handler.js +94 -0
  69. package/dist/instance/instance.handler.js.map +1 -0
  70. package/dist/instance/instance.operations.d.ts +1024 -0
  71. package/dist/instance/instance.operations.d.ts.map +1 -0
  72. package/dist/instance/instance.operations.js +464 -0
  73. package/dist/instance/instance.operations.js.map +1 -0
  74. package/dist/instance/instance.schema.d.ts +223 -0
  75. package/dist/instance/instance.schema.d.ts.map +1 -0
  76. package/dist/instance/instance.schema.js +172 -0
  77. package/dist/instance/instance.schema.js.map +1 -0
  78. package/dist/presentations/index.d.ts +64 -0
  79. package/dist/presentations/index.d.ts.map +1 -0
  80. package/dist/presentations/index.js +337 -0
  81. package/dist/presentations/index.js.map +1 -0
  82. package/dist/shared/index.d.ts +3 -0
  83. package/dist/shared/index.js +3 -0
  84. package/dist/shared/mock-data.d.ts +19 -0
  85. package/dist/shared/mock-data.d.ts.map +1 -0
  86. package/dist/shared/mock-data.js +12 -0
  87. package/dist/shared/mock-data.js.map +1 -0
  88. package/dist/shared/types.d.ts +81 -0
  89. package/dist/shared/types.d.ts.map +1 -0
  90. package/dist/shared/types.js +0 -0
  91. package/dist/state-machine/index.d.ts +148 -0
  92. package/dist/state-machine/index.d.ts.map +1 -0
  93. package/dist/state-machine/index.js +158 -0
  94. package/dist/state-machine/index.js.map +1 -0
  95. package/dist/workflow/index.d.ts +5 -0
  96. package/dist/workflow/index.js +6 -0
  97. package/dist/workflow/workflow.enum.d.ts +22 -0
  98. package/dist/workflow/workflow.enum.d.ts.map +1 -0
  99. package/dist/workflow/workflow.enum.js +47 -0
  100. package/dist/workflow/workflow.enum.js.map +1 -0
  101. package/dist/workflow/workflow.event.d.ts +135 -0
  102. package/dist/workflow/workflow.event.d.ts.map +1 -0
  103. package/dist/workflow/workflow.event.js +150 -0
  104. package/dist/workflow/workflow.event.js.map +1 -0
  105. package/dist/workflow/workflow.handler.d.ts +29 -0
  106. package/dist/workflow/workflow.handler.d.ts.map +1 -0
  107. package/dist/workflow/workflow.handler.js +66 -0
  108. package/dist/workflow/workflow.handler.js.map +1 -0
  109. package/dist/workflow/workflow.operations.d.ts +1011 -0
  110. package/dist/workflow/workflow.operations.d.ts.map +1 -0
  111. package/dist/workflow/workflow.operations.js +345 -0
  112. package/dist/workflow/workflow.operations.js.map +1 -0
  113. package/dist/workflow/workflow.schema.d.ts +265 -0
  114. package/dist/workflow/workflow.schema.d.ts.map +1 -0
  115. package/dist/workflow/workflow.schema.js +249 -0
  116. package/dist/workflow/workflow.schema.js.map +1 -0
  117. package/dist/workflow-system.feature.d.ts +12 -0
  118. package/dist/workflow-system.feature.d.ts.map +1 -0
  119. package/dist/workflow-system.feature.js +339 -0
  120. package/dist/workflow-system.feature.js.map +1 -0
  121. package/package.json +124 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Chaman Ventures, SASU
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,124 @@
1
+ # @contractspec/example.workflow-system
2
+
3
+ Website: https://contractspec.io/
4
+
5
+
6
+ A comprehensive workflow and approval system example demonstrating ContractSpec principles.
7
+
8
+ ## Features
9
+
10
+ - **State Machine Engine**: Define workflows as state machines with typed transitions
11
+ - **Role-Based Approvals**: Configure approval chains with multiple modes (ANY, ALL, MAJORITY, SEQUENTIAL)
12
+ - **Delegation**: Allow approvers to delegate to others
13
+ - **Escalation**: Automatic escalation on timeout
14
+ - **Feature Flag Integration**: Control workflow availability via feature flags
15
+ - **Full Audit Trail**: Track all workflow actions and decisions
16
+ - **Multi-Surface Presentations**: React components + Markdown renderers
17
+
18
+ ## Entities
19
+
20
+ ### Workflow Definition
21
+ - `WorkflowDefinition` - Blueprint for a workflow
22
+ - `WorkflowStep` - Steps within a workflow (START, APPROVAL, TASK, CONDITION, PARALLEL, WAIT, ACTION, END)
23
+
24
+ ### Workflow Instance
25
+ - `WorkflowInstance` - Running instance of a workflow
26
+ - `StepExecution` - Execution record for each step
27
+
28
+ ### Approval
29
+ - `ApprovalRequest` - Pending approval request
30
+ - `ApprovalComment` - Comments on approvals
31
+
32
+ ## Contracts
33
+
34
+ ### Workflow Definition Management
35
+ - `workflow.definition.create` - Create a new workflow
36
+ - `workflow.definition.update` - Update workflow
37
+ - `workflow.step.add` - Add step to workflow
38
+ - `workflow.definition.publish` - Activate workflow
39
+ - `workflow.definition.list` - List workflows
40
+ - `workflow.definition.get` - Get workflow details
41
+
42
+ ### Workflow Instance Operations
43
+ - `workflow.instance.start` - Start a new workflow
44
+ - `workflow.instance.transition` - Transition to next step
45
+ - `workflow.instance.pause` - Pause workflow
46
+ - `workflow.instance.resume` - Resume workflow
47
+ - `workflow.instance.cancel` - Cancel workflow
48
+ - `workflow.instance.list` - List instances
49
+ - `workflow.instance.get` - Get instance details
50
+
51
+ ### Approval Operations
52
+ - `workflow.approval.decide` - Submit approval decision
53
+ - `workflow.approval.delegate` - Delegate to another user
54
+ - `workflow.approval.comment.add` - Add comment
55
+ - `workflow.approval.list.mine` - List my pending approvals
56
+ - `workflow.approval.get` - Get approval details
57
+
58
+ ## State Machine
59
+
60
+ The workflow engine uses a state machine model where:
61
+
62
+ 1. Each step defines available actions and their target steps
63
+ 2. Transitions are validated against:
64
+ - Current workflow status
65
+ - User roles (role-based access control)
66
+ - Step-specific conditions
67
+ 3. Actions trigger events for audit trail and notifications
68
+
69
+ Example step definition:
70
+
71
+ ```typescript
72
+ {
73
+ key: 'manager_approval',
74
+ type: 'APPROVAL',
75
+ transitions: {
76
+ approve: 'finance_review',
77
+ reject: 'rejected',
78
+ request_changes: 'revision_needed'
79
+ },
80
+ approvalMode: 'ANY',
81
+ approverRoles: ['manager', 'director'],
82
+ timeoutSeconds: 86400, // 24 hours
83
+ }
84
+ ```
85
+
86
+ ## Events
87
+
88
+ - `workflow.definition.created/updated/published`
89
+ - `workflow.step.added`
90
+ - `workflow.instance.started/completed/cancelled/paused/resumed/failed/timeout`
91
+ - `workflow.step.entered/exited`
92
+ - `workflow.approval.requested/decided/delegated/escalated`
93
+
94
+ ## Usage
95
+
96
+ ```typescript
97
+ import {
98
+ StartWorkflowContract,
99
+ TransitionWorkflowContract,
100
+ workflowSystemSchemaContribution
101
+ } from '@contractspec/example.workflow-system';
102
+
103
+ // Start a workflow
104
+ const instance = await executeContract(StartWorkflowContract, {
105
+ workflowKey: 'purchase_approval',
106
+ contextData: { amount: 5000, vendor: 'ACME Corp' },
107
+ referenceId: 'PO-12345',
108
+ referenceType: 'PurchaseOrder',
109
+ });
110
+
111
+ // Make a transition
112
+ const result = await executeContract(TransitionWorkflowContract, {
113
+ instanceId: instance.id,
114
+ action: 'approve',
115
+ comment: 'Approved for standard purchase',
116
+ });
117
+ ```
118
+
119
+ ## Dependencies
120
+
121
+ - `@contractspec/lib.identity-rbac` - User identity and roles
122
+ - `@contractspec/lib.feature-flags` - Feature flag evaluation
123
+ - `@contractspec/module.audit-trail` - Action auditing
124
+ - `@contractspec/module.notifications` - Approval notifications
@@ -0,0 +1,14 @@
1
+ import * as _contractspec_lib_schema96 from "@contractspec/lib.schema";
2
+
3
+ //#region src/approval/approval.enum.d.ts
4
+ /**
5
+ * Approval status enum.
6
+ */
7
+ declare const ApprovalStatusEnum: _contractspec_lib_schema96.EnumType<[string, string, string, string, string, string, string]>;
8
+ /**
9
+ * Approval decision enum.
10
+ */
11
+ declare const ApprovalDecisionEnum: _contractspec_lib_schema96.EnumType<[string, string, string, string, string]>;
12
+ //#endregion
13
+ export { ApprovalDecisionEnum, ApprovalStatusEnum };
14
+ //# sourceMappingURL=approval.enum.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"approval.enum.d.ts","names":[],"sources":["../../src/approval/approval.enum.ts"],"sourcesContent":[],"mappings":";;;;;;AAKa,cAAA,kBAQX,EAAA,0BAAA,CAR6B,QAAA,CAAA,CAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,CAAA,CAAA;AAa/B;;;cAAa,sBAMX,0BAAA,CAN+B"}
@@ -0,0 +1,29 @@
1
+ import { defineEnum } from "@contractspec/lib.schema";
2
+
3
+ //#region src/approval/approval.enum.ts
4
+ /**
5
+ * Approval status enum.
6
+ */
7
+ const ApprovalStatusEnum = defineEnum("ApprovalStatus", [
8
+ "PENDING",
9
+ "APPROVED",
10
+ "REJECTED",
11
+ "DELEGATED",
12
+ "ESCALATED",
13
+ "WITHDRAWN",
14
+ "EXPIRED"
15
+ ]);
16
+ /**
17
+ * Approval decision enum.
18
+ */
19
+ const ApprovalDecisionEnum = defineEnum("ApprovalDecision", [
20
+ "APPROVE",
21
+ "REJECT",
22
+ "REQUEST_CHANGES",
23
+ "DELEGATE",
24
+ "ABSTAIN"
25
+ ]);
26
+
27
+ //#endregion
28
+ export { ApprovalDecisionEnum, ApprovalStatusEnum };
29
+ //# sourceMappingURL=approval.enum.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"approval.enum.js","names":[],"sources":["../../src/approval/approval.enum.ts"],"sourcesContent":["import { defineEnum } from '@contractspec/lib.schema';\n\n/**\n * Approval status enum.\n */\nexport const ApprovalStatusEnum = defineEnum('ApprovalStatus', [\n 'PENDING',\n 'APPROVED',\n 'REJECTED',\n 'DELEGATED',\n 'ESCALATED',\n 'WITHDRAWN',\n 'EXPIRED',\n]);\n\n/**\n * Approval decision enum.\n */\nexport const ApprovalDecisionEnum = defineEnum('ApprovalDecision', [\n 'APPROVE',\n 'REJECT',\n 'REQUEST_CHANGES',\n 'DELEGATE',\n 'ABSTAIN',\n]);\n"],"mappings":";;;;;;AAKA,MAAa,qBAAqB,WAAW,kBAAkB;CAC7D;CACA;CACA;CACA;CACA;CACA;CACA;CACD,CAAC;;;;AAKF,MAAa,uBAAuB,WAAW,oBAAoB;CACjE;CACA;CACA;CACA;CACA;CACD,CAAC"}
@@ -0,0 +1,131 @@
1
+ import * as _contractspec_lib_schema224 from "@contractspec/lib.schema";
2
+ import * as _contractspec_lib_contracts0 from "@contractspec/lib.contracts";
3
+
4
+ //#region src/approval/approval.event.d.ts
5
+ /**
6
+ * ApprovalRequestedEvent - An approval has been requested.
7
+ */
8
+ declare const ApprovalRequestedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema224.SchemaModel<{
9
+ requestId: {
10
+ type: _contractspec_lib_schema224.FieldType<string, string>;
11
+ isOptional: false;
12
+ };
13
+ instanceId: {
14
+ type: _contractspec_lib_schema224.FieldType<string, string>;
15
+ isOptional: false;
16
+ };
17
+ workflowKey: {
18
+ type: _contractspec_lib_schema224.FieldType<string, string>;
19
+ isOptional: false;
20
+ };
21
+ approverId: {
22
+ type: _contractspec_lib_schema224.FieldType<string, string>;
23
+ isOptional: false;
24
+ };
25
+ approverRole: {
26
+ type: _contractspec_lib_schema224.FieldType<string, string>;
27
+ isOptional: true;
28
+ };
29
+ title: {
30
+ type: _contractspec_lib_schema224.FieldType<string, string>;
31
+ isOptional: false;
32
+ };
33
+ dueAt: {
34
+ type: _contractspec_lib_schema224.FieldType<Date, string>;
35
+ isOptional: true;
36
+ };
37
+ timestamp: {
38
+ type: _contractspec_lib_schema224.FieldType<Date, string>;
39
+ isOptional: false;
40
+ };
41
+ }>>;
42
+ /**
43
+ * ApprovalDecidedEvent - An approval decision has been made.
44
+ */
45
+ declare const ApprovalDecidedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema224.SchemaModel<{
46
+ requestId: {
47
+ type: _contractspec_lib_schema224.FieldType<string, string>;
48
+ isOptional: false;
49
+ };
50
+ instanceId: {
51
+ type: _contractspec_lib_schema224.FieldType<string, string>;
52
+ isOptional: false;
53
+ };
54
+ decision: {
55
+ type: _contractspec_lib_schema224.FieldType<string, string>;
56
+ isOptional: false;
57
+ };
58
+ decidedBy: {
59
+ type: _contractspec_lib_schema224.FieldType<string, string>;
60
+ isOptional: false;
61
+ };
62
+ comment: {
63
+ type: _contractspec_lib_schema224.FieldType<string, string>;
64
+ isOptional: true;
65
+ };
66
+ timestamp: {
67
+ type: _contractspec_lib_schema224.FieldType<Date, string>;
68
+ isOptional: false;
69
+ };
70
+ }>>;
71
+ /**
72
+ * ApprovalDelegatedEvent - An approval has been delegated.
73
+ */
74
+ declare const ApprovalDelegatedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema224.SchemaModel<{
75
+ requestId: {
76
+ type: _contractspec_lib_schema224.FieldType<string, string>;
77
+ isOptional: false;
78
+ };
79
+ instanceId: {
80
+ type: _contractspec_lib_schema224.FieldType<string, string>;
81
+ isOptional: false;
82
+ };
83
+ fromUserId: {
84
+ type: _contractspec_lib_schema224.FieldType<string, string>;
85
+ isOptional: false;
86
+ };
87
+ toUserId: {
88
+ type: _contractspec_lib_schema224.FieldType<string, string>;
89
+ isOptional: false;
90
+ };
91
+ reason: {
92
+ type: _contractspec_lib_schema224.FieldType<string, string>;
93
+ isOptional: true;
94
+ };
95
+ timestamp: {
96
+ type: _contractspec_lib_schema224.FieldType<Date, string>;
97
+ isOptional: false;
98
+ };
99
+ }>>;
100
+ /**
101
+ * ApprovalEscalatedEvent - An approval has been escalated.
102
+ */
103
+ declare const ApprovalEscalatedEvent: _contractspec_lib_contracts0.EventSpec<_contractspec_lib_schema224.SchemaModel<{
104
+ requestId: {
105
+ type: _contractspec_lib_schema224.FieldType<string, string>;
106
+ isOptional: false;
107
+ };
108
+ instanceId: {
109
+ type: _contractspec_lib_schema224.FieldType<string, string>;
110
+ isOptional: false;
111
+ };
112
+ escalationLevel: {
113
+ type: _contractspec_lib_schema224.FieldType<number, number>;
114
+ isOptional: false;
115
+ };
116
+ escalatedTo: {
117
+ type: _contractspec_lib_schema224.FieldType<string, string>;
118
+ isOptional: false;
119
+ };
120
+ reason: {
121
+ type: _contractspec_lib_schema224.FieldType<string, string>;
122
+ isOptional: false;
123
+ };
124
+ timestamp: {
125
+ type: _contractspec_lib_schema224.FieldType<Date, string>;
126
+ isOptional: false;
127
+ };
128
+ }>>;
129
+ //#endregion
130
+ export { ApprovalDecidedEvent, ApprovalDelegatedEvent, ApprovalEscalatedEvent, ApprovalRequestedEvent };
131
+ //# sourceMappingURL=approval.event.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"approval.event.d.ts","names":[],"sources":["../../src/approval/approval.event.ts"],"sourcesContent":[],"mappings":";;;;;;;cAiFa,wBAAsB,4BAAA,CAAA,sCAAA;EAAtB,SAAA,EAAA;IAUX,IAAA,EAAA,2BAAA,CAAA,SAAA,CAAA,MAAA,EAAA,MAAA,CAAA;;;;;;;;;;;EAViC,UAAA,EAAA;IAAA,IAAA,uCAAA,CAAA,MAAA,EAAA,MAAA,CAAA;IAetB,UAAA,EAAA,KAAA;EAUX,CAAA;;;;;;;;EAV+B,CAAA;EAAA,KAAA,EAAA;IAepB,IAAA,uCAUX,KAAA,EAAA,MAAA,CAAA;IAAA,UAAA,EAAA,IAAA;;;;;;;;;;AAKW,cA9BA,oBAwCX,EAxC+B,4BAAA,CAAA,SAwC/B,6BAxC+B,WAwC/B,CAAA;EAAA,SAAA,EAAA;UA9BA,2BAAA,CAAA;;;;;;;EAoBiC,QAAA,EAAA;IAAA,IAAA,uCAAA,CAAA,MAAA,EAAA,MAAA,CAAA;;;;;;;;;;;;;;;;;;;cAftB,wBAAsB,4BAAA,CAAA,sCAAA;;UAUjC,2BAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;cAKW,wBAAsB,4BAAA,CAAA,sCAAA;;UAUjC,2BAAA,CAAA"}
@@ -0,0 +1,220 @@
1
+ import { ScalarTypeEnum } from "@contractspec/lib.schema";
2
+ import { defineEvent, defineSchemaModel as defineSchemaModel$1 } from "@contractspec/lib.contracts";
3
+
4
+ //#region src/approval/approval.event.ts
5
+ /**
6
+ * Payload when approval is requested.
7
+ */
8
+ const ApprovalRequestedPayload = defineSchemaModel$1({
9
+ name: "ApprovalRequestedEventPayload",
10
+ description: "Payload when approval is requested",
11
+ fields: {
12
+ requestId: {
13
+ type: ScalarTypeEnum.String_unsecure(),
14
+ isOptional: false
15
+ },
16
+ instanceId: {
17
+ type: ScalarTypeEnum.String_unsecure(),
18
+ isOptional: false
19
+ },
20
+ workflowKey: {
21
+ type: ScalarTypeEnum.String_unsecure(),
22
+ isOptional: false
23
+ },
24
+ approverId: {
25
+ type: ScalarTypeEnum.String_unsecure(),
26
+ isOptional: false
27
+ },
28
+ approverRole: {
29
+ type: ScalarTypeEnum.String_unsecure(),
30
+ isOptional: true
31
+ },
32
+ title: {
33
+ type: ScalarTypeEnum.String_unsecure(),
34
+ isOptional: false
35
+ },
36
+ dueAt: {
37
+ type: ScalarTypeEnum.DateTime(),
38
+ isOptional: true
39
+ },
40
+ timestamp: {
41
+ type: ScalarTypeEnum.DateTime(),
42
+ isOptional: false
43
+ }
44
+ }
45
+ });
46
+ /**
47
+ * Payload when approval decision is made.
48
+ */
49
+ const ApprovalDecidedPayload = defineSchemaModel$1({
50
+ name: "ApprovalDecidedEventPayload",
51
+ description: "Payload when approval decision is made",
52
+ fields: {
53
+ requestId: {
54
+ type: ScalarTypeEnum.String_unsecure(),
55
+ isOptional: false
56
+ },
57
+ instanceId: {
58
+ type: ScalarTypeEnum.String_unsecure(),
59
+ isOptional: false
60
+ },
61
+ decision: {
62
+ type: ScalarTypeEnum.String_unsecure(),
63
+ isOptional: false
64
+ },
65
+ decidedBy: {
66
+ type: ScalarTypeEnum.String_unsecure(),
67
+ isOptional: false
68
+ },
69
+ comment: {
70
+ type: ScalarTypeEnum.String_unsecure(),
71
+ isOptional: true
72
+ },
73
+ timestamp: {
74
+ type: ScalarTypeEnum.DateTime(),
75
+ isOptional: false
76
+ }
77
+ }
78
+ });
79
+ /**
80
+ * Payload when approval is delegated.
81
+ */
82
+ const ApprovalDelegatedPayload = defineSchemaModel$1({
83
+ name: "ApprovalDelegatedEventPayload",
84
+ description: "Payload when approval is delegated",
85
+ fields: {
86
+ requestId: {
87
+ type: ScalarTypeEnum.String_unsecure(),
88
+ isOptional: false
89
+ },
90
+ instanceId: {
91
+ type: ScalarTypeEnum.String_unsecure(),
92
+ isOptional: false
93
+ },
94
+ fromUserId: {
95
+ type: ScalarTypeEnum.String_unsecure(),
96
+ isOptional: false
97
+ },
98
+ toUserId: {
99
+ type: ScalarTypeEnum.String_unsecure(),
100
+ isOptional: false
101
+ },
102
+ reason: {
103
+ type: ScalarTypeEnum.String_unsecure(),
104
+ isOptional: true
105
+ },
106
+ timestamp: {
107
+ type: ScalarTypeEnum.DateTime(),
108
+ isOptional: false
109
+ }
110
+ }
111
+ });
112
+ /**
113
+ * Payload when approval is escalated.
114
+ */
115
+ const ApprovalEscalatedPayload = defineSchemaModel$1({
116
+ name: "ApprovalEscalatedEventPayload",
117
+ description: "Payload when approval is escalated",
118
+ fields: {
119
+ requestId: {
120
+ type: ScalarTypeEnum.String_unsecure(),
121
+ isOptional: false
122
+ },
123
+ instanceId: {
124
+ type: ScalarTypeEnum.String_unsecure(),
125
+ isOptional: false
126
+ },
127
+ escalationLevel: {
128
+ type: ScalarTypeEnum.Int_unsecure(),
129
+ isOptional: false
130
+ },
131
+ escalatedTo: {
132
+ type: ScalarTypeEnum.String_unsecure(),
133
+ isOptional: false
134
+ },
135
+ reason: {
136
+ type: ScalarTypeEnum.String_unsecure(),
137
+ isOptional: false
138
+ },
139
+ timestamp: {
140
+ type: ScalarTypeEnum.DateTime(),
141
+ isOptional: false
142
+ }
143
+ }
144
+ });
145
+ /**
146
+ * ApprovalRequestedEvent - An approval has been requested.
147
+ */
148
+ const ApprovalRequestedEvent = defineEvent({
149
+ meta: {
150
+ key: "workflow.approval.requested",
151
+ version: 1,
152
+ description: "An approval has been requested.",
153
+ stability: "stable",
154
+ owners: ["@workflow-team"],
155
+ tags: [
156
+ "workflow",
157
+ "approval",
158
+ "requested"
159
+ ]
160
+ },
161
+ payload: ApprovalRequestedPayload
162
+ });
163
+ /**
164
+ * ApprovalDecidedEvent - An approval decision has been made.
165
+ */
166
+ const ApprovalDecidedEvent = defineEvent({
167
+ meta: {
168
+ key: "workflow.approval.decided",
169
+ version: 1,
170
+ description: "An approval decision has been made.",
171
+ stability: "stable",
172
+ owners: ["@workflow-team"],
173
+ tags: [
174
+ "workflow",
175
+ "approval",
176
+ "decided"
177
+ ]
178
+ },
179
+ payload: ApprovalDecidedPayload
180
+ });
181
+ /**
182
+ * ApprovalDelegatedEvent - An approval has been delegated.
183
+ */
184
+ const ApprovalDelegatedEvent = defineEvent({
185
+ meta: {
186
+ key: "workflow.approval.delegated",
187
+ version: 1,
188
+ description: "An approval has been delegated.",
189
+ stability: "stable",
190
+ owners: ["@workflow-team"],
191
+ tags: [
192
+ "workflow",
193
+ "approval",
194
+ "delegated"
195
+ ]
196
+ },
197
+ payload: ApprovalDelegatedPayload
198
+ });
199
+ /**
200
+ * ApprovalEscalatedEvent - An approval has been escalated.
201
+ */
202
+ const ApprovalEscalatedEvent = defineEvent({
203
+ meta: {
204
+ key: "workflow.approval.escalated",
205
+ version: 1,
206
+ description: "An approval has been escalated.",
207
+ stability: "stable",
208
+ owners: ["@workflow-team"],
209
+ tags: [
210
+ "workflow",
211
+ "approval",
212
+ "escalated"
213
+ ]
214
+ },
215
+ payload: ApprovalEscalatedPayload
216
+ });
217
+
218
+ //#endregion
219
+ export { ApprovalDecidedEvent, ApprovalDelegatedEvent, ApprovalEscalatedEvent, ApprovalRequestedEvent };
220
+ //# sourceMappingURL=approval.event.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"approval.event.js","names":["defineSchemaModel"],"sources":["../../src/approval/approval.event.ts"],"sourcesContent":["import { defineEvent, defineSchemaModel } from '@contractspec/lib.contracts';\nimport { ScalarTypeEnum } from '@contractspec/lib.schema';\n\n/**\n * Payload when approval is requested.\n */\nconst ApprovalRequestedPayload = defineSchemaModel({\n name: 'ApprovalRequestedEventPayload',\n description: 'Payload when approval is requested',\n fields: {\n requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n workflowKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n approverId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n approverRole: {\n type: ScalarTypeEnum.String_unsecure(),\n isOptional: true,\n },\n title: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n dueAt: { type: ScalarTypeEnum.DateTime(), isOptional: true },\n timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false },\n },\n});\n\n/**\n * Payload when approval decision is made.\n */\nconst ApprovalDecidedPayload = defineSchemaModel({\n name: 'ApprovalDecidedEventPayload',\n description: 'Payload when approval decision is made',\n fields: {\n requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n decision: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n decidedBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n comment: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false },\n },\n});\n\n/**\n * Payload when approval is delegated.\n */\nconst ApprovalDelegatedPayload = defineSchemaModel({\n name: 'ApprovalDelegatedEventPayload',\n description: 'Payload when approval is delegated',\n fields: {\n requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n fromUserId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n toUserId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },\n timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false },\n },\n});\n\n/**\n * Payload when approval is escalated.\n */\nconst ApprovalEscalatedPayload = defineSchemaModel({\n name: 'ApprovalEscalatedEventPayload',\n description: 'Payload when approval is escalated',\n fields: {\n requestId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n escalationLevel: {\n type: ScalarTypeEnum.Int_unsecure(),\n isOptional: false,\n },\n escalatedTo: {\n type: ScalarTypeEnum.String_unsecure(),\n isOptional: false,\n },\n reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },\n timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false },\n },\n});\n\n/**\n * ApprovalRequestedEvent - An approval has been requested.\n */\nexport const ApprovalRequestedEvent = defineEvent({\n meta: {\n key: 'workflow.approval.requested',\n version: 1,\n description: 'An approval has been requested.',\n stability: 'stable',\n owners: ['@workflow-team'],\n tags: ['workflow', 'approval', 'requested'],\n },\n payload: ApprovalRequestedPayload,\n});\n\n/**\n * ApprovalDecidedEvent - An approval decision has been made.\n */\nexport const ApprovalDecidedEvent = defineEvent({\n meta: {\n key: 'workflow.approval.decided',\n version: 1,\n description: 'An approval decision has been made.',\n stability: 'stable',\n owners: ['@workflow-team'],\n tags: ['workflow', 'approval', 'decided'],\n },\n payload: ApprovalDecidedPayload,\n});\n\n/**\n * ApprovalDelegatedEvent - An approval has been delegated.\n */\nexport const ApprovalDelegatedEvent = defineEvent({\n meta: {\n key: 'workflow.approval.delegated',\n version: 1,\n description: 'An approval has been delegated.',\n stability: 'stable',\n owners: ['@workflow-team'],\n tags: ['workflow', 'approval', 'delegated'],\n },\n payload: ApprovalDelegatedPayload,\n});\n\n/**\n * ApprovalEscalatedEvent - An approval has been escalated.\n */\nexport const ApprovalEscalatedEvent = defineEvent({\n meta: {\n key: 'workflow.approval.escalated',\n version: 1,\n description: 'An approval has been escalated.',\n stability: 'stable',\n owners: ['@workflow-team'],\n tags: ['workflow', 'approval', 'escalated'],\n },\n payload: ApprovalEscalatedPayload,\n});\n"],"mappings":";;;;;;;AAMA,MAAM,2BAA2BA,oBAAkB;CACjD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACxE,YAAY;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACzE,aAAa;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EAC1E,YAAY;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACzE,cAAc;GACZ,MAAM,eAAe,iBAAiB;GACtC,YAAY;GACb;EACD,OAAO;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACpE,OAAO;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAM;EAC5D,WAAW;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAO;EAClE;CACF,CAAC;;;;AAKF,MAAM,yBAAyBA,oBAAkB;CAC/C,MAAM;CACN,aAAa;CACb,QAAQ;EACN,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACxE,YAAY;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACzE,UAAU;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACvE,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACxE,SAAS;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACrE,WAAW;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAO;EAClE;CACF,CAAC;;;;AAKF,MAAM,2BAA2BA,oBAAkB;CACjD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACxE,YAAY;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACzE,YAAY;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACzE,UAAU;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACvE,QAAQ;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAM;EACpE,WAAW;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAO;EAClE;CACF,CAAC;;;;AAKF,MAAM,2BAA2BA,oBAAkB;CACjD,MAAM;CACN,aAAa;CACb,QAAQ;EACN,WAAW;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACxE,YAAY;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACzE,iBAAiB;GACf,MAAM,eAAe,cAAc;GACnC,YAAY;GACb;EACD,aAAa;GACX,MAAM,eAAe,iBAAiB;GACtC,YAAY;GACb;EACD,QAAQ;GAAE,MAAM,eAAe,iBAAiB;GAAE,YAAY;GAAO;EACrE,WAAW;GAAE,MAAM,eAAe,UAAU;GAAE,YAAY;GAAO;EAClE;CACF,CAAC;;;;AAKF,MAAa,yBAAyB,YAAY;CAChD,MAAM;EACJ,KAAK;EACL,SAAS;EACT,aAAa;EACb,WAAW;EACX,QAAQ,CAAC,iBAAiB;EAC1B,MAAM;GAAC;GAAY;GAAY;GAAY;EAC5C;CACD,SAAS;CACV,CAAC;;;;AAKF,MAAa,uBAAuB,YAAY;CAC9C,MAAM;EACJ,KAAK;EACL,SAAS;EACT,aAAa;EACb,WAAW;EACX,QAAQ,CAAC,iBAAiB;EAC1B,MAAM;GAAC;GAAY;GAAY;GAAU;EAC1C;CACD,SAAS;CACV,CAAC;;;;AAKF,MAAa,yBAAyB,YAAY;CAChD,MAAM;EACJ,KAAK;EACL,SAAS;EACT,aAAa;EACb,WAAW;EACX,QAAQ,CAAC,iBAAiB;EAC1B,MAAM;GAAC;GAAY;GAAY;GAAY;EAC5C;CACD,SAAS;CACV,CAAC;;;;AAKF,MAAa,yBAAyB,YAAY;CAChD,MAAM;EACJ,KAAK;EACL,SAAS;EACT,aAAa;EACb,WAAW;EACX,QAAQ,CAAC,iBAAiB;EAC1B,MAAM;GAAC;GAAY;GAAY;GAAY;EAC5C;CACD,SAAS;CACV,CAAC"}
@@ -0,0 +1,23 @@
1
+ import { ApprovalRequestRecord, HandlerContext, WorkflowInstanceRecord, WorkflowStepRecord } from "../shared/types.js";
2
+
3
+ //#region src/approval/approval.handler.d.ts
4
+
5
+ declare function createApprovalRequests(instance: WorkflowInstanceRecord, step: WorkflowStepRecord, _context: HandlerContext): Promise<void>;
6
+ declare function handleSubmitDecision(input: {
7
+ requestId: string;
8
+ decision: 'APPROVE' | 'REJECT' | 'REQUEST_CHANGES' | 'DELEGATE' | 'ABSTAIN';
9
+ comment?: string;
10
+ data?: Record<string, unknown>;
11
+ }, context: HandlerContext): Promise<ApprovalRequestRecord>;
12
+ declare function handleListMyApprovals(input: {
13
+ status?: 'PENDING' | 'APPROVED' | 'REJECTED' | 'DELEGATED' | 'ESCALATED' | 'WITHDRAWN' | 'EXPIRED';
14
+ limit?: number;
15
+ offset?: number;
16
+ }, context: HandlerContext): Promise<{
17
+ requests: ApprovalRequestRecord[];
18
+ total: number;
19
+ pendingCount: number;
20
+ }>;
21
+ //#endregion
22
+ export { createApprovalRequests, handleListMyApprovals, handleSubmitDecision };
23
+ //# sourceMappingURL=approval.handler.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"approval.handler.d.ts","names":[],"sources":["../../src/approval/approval.handler.ts"],"sourcesContent":[],"mappings":";;;;AAcY,iBADU,sBAAA,CACV,QAAA,EAAA,sBAAA,EAAA,IAAA,EACJ,kBADI,EAAA,QAAA,EAEA,cAFA,CAAA,EAGT,OAHS,CAAA,IAAA,CAAA;AACJ,iBA8Bc,oBAAA,CA9Bd,KAAA,EAAA;EACI,SAAA,EAAA,MAAA;EACT,QAAA,EAAA,SAAA,GAAA,QAAA,GAAA,iBAAA,GAAA,UAAA,GAAA,SAAA;EAAO,OAAA,CAAA,EAAA,MAAA;EA4BY,IAAA,CAAA,EAKX,MALW,CAAA,MAAA,EAAA,OAAoB,CAAA;CAK/B,EAAA,OAAA,EAEA,cAFA,CAAA,EAGR,OAHQ,CAGA,qBAHA,CAAA;AAEA,iBAiDW,qBAAA,CAjDX,KAAA,EAAA;EACA,MAAA,CAAA,EAAA,SAAA,GAAA,UAAA,GAAA,UAAA,GAAA,WAAA,GAAA,WAAA,GAAA,WAAA,GAAA,SAAA;EAAR,KAAA,CAAA,EAAA,MAAA;EAAO,MAAA,CAAA,EAAA,MAAA;AAgDV,CAAA,EAAA,OAAsB,EAaX,cAbW,CAAA,EAcnB,OAdwC,CAAA;EAahC,QAAA,EAEC,qBAFD,EAAA;EAEC,KAAA,EAAA,MAAA;EADT,YAAA,EAAA,MAAA;CAAO,CAAA"}
@@ -0,0 +1,72 @@
1
+ import { mockDataStore } from "../shared/mock-data.js";
2
+ import { handleTransitionWorkflow } from "../instance/instance.handler.js";
3
+
4
+ //#region src/approval/approval.handler.ts
5
+ async function createApprovalRequests(instance, step, _context) {
6
+ const now = /* @__PURE__ */ new Date();
7
+ for (let i = 0; i < step.approverRoles.length; i++) {
8
+ const role = step.approverRoles[i];
9
+ const id = `approval_${Date.now()}_${i}`;
10
+ const request = {
11
+ id,
12
+ workflowInstanceId: instance.id,
13
+ stepExecutionId: `exec_${instance.id}_${step.id}`,
14
+ approverId: `user_${role}`,
15
+ approverRole: role,
16
+ title: `Approval required for ${step.name}`,
17
+ description: step.description,
18
+ status: "PENDING",
19
+ contextSnapshot: instance.contextData,
20
+ sequenceOrder: i,
21
+ createdAt: now,
22
+ updatedAt: now
23
+ };
24
+ mockDataStore.approvals.set(id, request);
25
+ }
26
+ }
27
+ async function handleSubmitDecision(input, context) {
28
+ const request = mockDataStore.approvals.get(input.requestId);
29
+ if (!request) throw new Error(`Approval request ${input.requestId} not found`);
30
+ if (request.approverId !== context.userId && !context.userRoles.includes(request.approverRole ?? "")) throw new Error("User is not authorized to make this decision");
31
+ const now = /* @__PURE__ */ new Date();
32
+ request.decision = input.decision;
33
+ request.decisionComment = input.comment;
34
+ request.decidedAt = now;
35
+ request.updatedAt = now;
36
+ if (input.decision === "APPROVE") {
37
+ request.status = "APPROVED";
38
+ await handleTransitionWorkflow({
39
+ instanceId: request.workflowInstanceId,
40
+ action: "approve",
41
+ data: input.data,
42
+ comment: input.comment
43
+ }, context);
44
+ } else if (input.decision === "REJECT") {
45
+ request.status = "REJECTED";
46
+ await handleTransitionWorkflow({
47
+ instanceId: request.workflowInstanceId,
48
+ action: "reject",
49
+ data: input.data,
50
+ comment: input.comment
51
+ }, context);
52
+ }
53
+ return request;
54
+ }
55
+ async function handleListMyApprovals(input, context) {
56
+ let requests = Array.from(mockDataStore.approvals.values()).filter((r) => r.approverId === context.userId || context.userRoles.includes(r.approverRole ?? ""));
57
+ const pendingCount = requests.filter((r) => r.status === "PENDING").length;
58
+ if (input.status) requests = requests.filter((r) => r.status === input.status);
59
+ const total = requests.length;
60
+ const offset = input.offset ?? 0;
61
+ const limit = input.limit ?? 20;
62
+ requests = requests.sort((a, b) => b.createdAt.getTime() - a.createdAt.getTime()).slice(offset, offset + limit);
63
+ return {
64
+ requests,
65
+ total,
66
+ pendingCount
67
+ };
68
+ }
69
+
70
+ //#endregion
71
+ export { createApprovalRequests, handleListMyApprovals, handleSubmitDecision };
72
+ //# sourceMappingURL=approval.handler.js.map