@contractspec/example.workflow-system 3.8.9 → 3.8.11

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 (95) hide show
  1. package/dist/approval/approval.enum.js +1 -22
  2. package/dist/approval/approval.event.js +1 -112
  3. package/dist/approval/approval.operations.js +1 -369
  4. package/dist/approval/approval.schema.js +1 -73
  5. package/dist/approval/index.js +1 -484
  6. package/dist/browser/approval/approval.enum.js +1 -22
  7. package/dist/browser/approval/approval.event.js +1 -112
  8. package/dist/browser/approval/approval.operations.js +1 -369
  9. package/dist/browser/approval/approval.schema.js +1 -73
  10. package/dist/browser/approval/index.js +1 -484
  11. package/dist/browser/docs/index.js +5 -49
  12. package/dist/browser/docs/workflow-system.docblock.js +5 -49
  13. package/dist/browser/entities/approval.js +1 -119
  14. package/dist/browser/entities/index.js +1 -508
  15. package/dist/browser/entities/instance.js +1 -161
  16. package/dist/browser/entities/step.js +1 -124
  17. package/dist/browser/entities/workflow.js +1 -82
  18. package/dist/browser/example.js +1 -42
  19. package/dist/browser/handlers/index.js +8 -253
  20. package/dist/browser/handlers/workflow.handlers.js +8 -253
  21. package/dist/browser/index.js +13 -3524
  22. package/dist/browser/instance/index.js +1 -677
  23. package/dist/browser/instance/instance.enum.js +1 -15
  24. package/dist/browser/instance/instance.event.js +1 -164
  25. package/dist/browser/instance/instance.handler.js +1 -356
  26. package/dist/browser/instance/instance.operations.js +1 -9
  27. package/dist/browser/instance/instance.schema.js +1 -101
  28. package/dist/browser/presentations/index.js +1 -109
  29. package/dist/browser/seeders/index.js +1 -3
  30. package/dist/browser/shared/demo-scenario.js +1 -213
  31. package/dist/browser/shared/index.js +1 -3
  32. package/dist/browser/shared/mock-data.js +1 -11
  33. package/dist/browser/state-machine/index.js +1 -6
  34. package/dist/browser/tests/operations.test-spec.js +1 -6
  35. package/dist/browser/ui/WorkflowDashboard.js +1 -3
  36. package/dist/browser/ui/WorkflowDashboard.visualizations.js +1 -239
  37. package/dist/browser/ui/hooks/index.js +1 -3
  38. package/dist/browser/ui/hooks/useWorkflowList.js +1 -52
  39. package/dist/browser/ui/index.js +1 -56
  40. package/dist/browser/ui/renderers/index.js +5 -562
  41. package/dist/browser/ui/renderers/workflow.markdown.js +5 -562
  42. package/dist/browser/visualizations/catalog.js +1 -132
  43. package/dist/browser/visualizations/index.js +1 -133
  44. package/dist/browser/visualizations/selectors.js +1 -195
  45. package/dist/browser/workflow/index.js +1 -21
  46. package/dist/browser/workflow/workflow.enum.js +1 -36
  47. package/dist/browser/workflow/workflow.event.js +1 -6
  48. package/dist/browser/workflow/workflow.handler.js +1 -5
  49. package/dist/browser/workflow/workflow.operations.js +1 -8
  50. package/dist/browser/workflow/workflow.schema.js +1 -151
  51. package/dist/browser/workflow-system.capability.js +1 -5
  52. package/dist/browser/workflow-system.feature.js +1 -3
  53. package/dist/docs/index.js +5 -49
  54. package/dist/docs/workflow-system.docblock.js +5 -49
  55. package/dist/entities/approval.js +1 -119
  56. package/dist/entities/index.js +1 -508
  57. package/dist/entities/instance.js +1 -161
  58. package/dist/entities/step.js +1 -124
  59. package/dist/entities/workflow.js +1 -82
  60. package/dist/example.js +1 -42
  61. package/dist/handlers/index.js +8 -253
  62. package/dist/handlers/workflow.handlers.js +8 -253
  63. package/dist/index.js +13 -3524
  64. package/dist/instance/index.js +1 -677
  65. package/dist/instance/instance.enum.js +1 -15
  66. package/dist/instance/instance.event.js +1 -164
  67. package/dist/instance/instance.handler.js +1 -356
  68. package/dist/instance/instance.operations.js +1 -9
  69. package/dist/instance/instance.schema.js +1 -101
  70. package/dist/presentations/index.js +1 -109
  71. package/dist/seeders/index.js +1 -3
  72. package/dist/shared/demo-scenario.js +1 -213
  73. package/dist/shared/index.js +1 -3
  74. package/dist/shared/mock-data.js +1 -11
  75. package/dist/state-machine/index.js +1 -6
  76. package/dist/tests/operations.test-spec.js +1 -6
  77. package/dist/ui/WorkflowDashboard.js +1 -3
  78. package/dist/ui/WorkflowDashboard.visualizations.js +1 -239
  79. package/dist/ui/hooks/index.js +1 -3
  80. package/dist/ui/hooks/useWorkflowList.js +1 -52
  81. package/dist/ui/index.js +1 -56
  82. package/dist/ui/renderers/index.js +5 -562
  83. package/dist/ui/renderers/workflow.markdown.js +5 -562
  84. package/dist/visualizations/catalog.js +1 -132
  85. package/dist/visualizations/index.js +1 -133
  86. package/dist/visualizations/selectors.js +1 -195
  87. package/dist/workflow/index.js +1 -21
  88. package/dist/workflow/workflow.enum.js +1 -36
  89. package/dist/workflow/workflow.event.js +1 -6
  90. package/dist/workflow/workflow.handler.js +1 -5
  91. package/dist/workflow/workflow.operations.js +1 -8
  92. package/dist/workflow/workflow.schema.js +1 -151
  93. package/dist/workflow-system.capability.js +1 -5
  94. package/dist/workflow-system.feature.js +1 -3
  95. package/package.json +8 -8
@@ -1,119 +1 @@
1
- // src/entities/approval.ts
2
- import {
3
- defineEntity,
4
- defineEntityEnum,
5
- field,
6
- index
7
- } from "@contractspec/lib.schema";
8
- var ApprovalStatusEnum = defineEntityEnum({
9
- name: "ApprovalStatus",
10
- values: [
11
- "PENDING",
12
- "APPROVED",
13
- "REJECTED",
14
- "DELEGATED",
15
- "ESCALATED",
16
- "WITHDRAWN",
17
- "EXPIRED"
18
- ],
19
- schema: "workflow",
20
- description: "Status of an approval request."
21
- });
22
- var ApprovalDecisionEnum = defineEntityEnum({
23
- name: "ApprovalDecision",
24
- values: [
25
- "APPROVE",
26
- "REJECT",
27
- "REQUEST_CHANGES",
28
- "DELEGATE",
29
- "ABSTAIN"
30
- ],
31
- schema: "workflow",
32
- description: "Possible approval decisions."
33
- });
34
- var ApprovalRequestEntity = defineEntity({
35
- name: "ApprovalRequest",
36
- description: "A pending approval request for a workflow step.",
37
- schema: "workflow",
38
- map: "approval_request",
39
- fields: {
40
- id: field.id({ description: "Unique approval request ID" }),
41
- workflowInstanceId: field.foreignKey(),
42
- stepExecutionId: field.foreignKey(),
43
- approverId: field.foreignKey({ description: "User requested to approve" }),
44
- approverRole: field.string({
45
- isOptional: true,
46
- description: "Role of the approver"
47
- }),
48
- title: field.string({ description: "Approval request title" }),
49
- description: field.string({ isOptional: true }),
50
- status: field.enum("ApprovalStatus", { default: "PENDING" }),
51
- decision: field.enum("ApprovalDecision", { isOptional: true }),
52
- decisionComment: field.string({
53
- isOptional: true,
54
- description: "Comment explaining decision"
55
- }),
56
- decidedAt: field.dateTime({ isOptional: true }),
57
- delegatedTo: field.string({
58
- isOptional: true,
59
- description: "User delegated to"
60
- }),
61
- delegationReason: field.string({ isOptional: true }),
62
- escalationLevel: field.int({
63
- default: 0,
64
- description: "Current escalation level"
65
- }),
66
- escalatedAt: field.dateTime({ isOptional: true }),
67
- dueAt: field.dateTime({
68
- isOptional: true,
69
- description: "When approval is due"
70
- }),
71
- reminderSentAt: field.dateTime({ isOptional: true }),
72
- contextSnapshot: field.json({
73
- isOptional: true,
74
- description: "Snapshot of relevant data for review"
75
- }),
76
- sequenceOrder: field.int({
77
- default: 0,
78
- description: "Order in approval chain"
79
- }),
80
- createdAt: field.createdAt(),
81
- updatedAt: field.updatedAt(),
82
- workflowInstance: field.belongsTo("WorkflowInstance", ["workflowInstanceId"], ["id"], { onDelete: "Cascade" }),
83
- stepExecution: field.belongsTo("StepExecution", ["stepExecutionId"], ["id"])
84
- },
85
- indexes: [
86
- index.on(["approverId", "status"]),
87
- index.on(["workflowInstanceId", "status"]),
88
- index.on(["stepExecutionId"]),
89
- index.on(["status", "dueAt"]),
90
- index.on(["createdAt"])
91
- ],
92
- enums: [ApprovalStatusEnum, ApprovalDecisionEnum]
93
- });
94
- var ApprovalCommentEntity = defineEntity({
95
- name: "ApprovalComment",
96
- description: "A comment on an approval request.",
97
- schema: "workflow",
98
- map: "approval_comment",
99
- fields: {
100
- id: field.id(),
101
- approvalRequestId: field.foreignKey(),
102
- authorId: field.foreignKey(),
103
- content: field.string({ description: "Comment text" }),
104
- isInternal: field.boolean({
105
- default: false,
106
- description: "Internal note vs public comment"
107
- }),
108
- createdAt: field.createdAt(),
109
- updatedAt: field.updatedAt(),
110
- approvalRequest: field.belongsTo("ApprovalRequest", ["approvalRequestId"], ["id"], { onDelete: "Cascade" })
111
- },
112
- indexes: [index.on(["approvalRequestId", "createdAt"])]
113
- });
114
- export {
115
- ApprovalStatusEnum,
116
- ApprovalRequestEntity,
117
- ApprovalDecisionEnum,
118
- ApprovalCommentEntity
119
- };
1
+ import{defineEntity as k,defineEntityEnum as w,field as g,index as j}from"@contractspec/lib.schema";var z=w({name:"ApprovalStatus",values:["PENDING","APPROVED","REJECTED","DELEGATED","ESCALATED","WITHDRAWN","EXPIRED"],schema:"workflow",description:"Status of an approval request."}),B=w({name:"ApprovalDecision",values:["APPROVE","REJECT","REQUEST_CHANGES","DELEGATE","ABSTAIN"],schema:"workflow",description:"Possible approval decisions."}),G=k({name:"ApprovalRequest",description:"A pending approval request for a workflow step.",schema:"workflow",map:"approval_request",fields:{id:g.id({description:"Unique approval request ID"}),workflowInstanceId:g.foreignKey(),stepExecutionId:g.foreignKey(),approverId:g.foreignKey({description:"User requested to approve"}),approverRole:g.string({isOptional:!0,description:"Role of the approver"}),title:g.string({description:"Approval request title"}),description:g.string({isOptional:!0}),status:g.enum("ApprovalStatus",{default:"PENDING"}),decision:g.enum("ApprovalDecision",{isOptional:!0}),decisionComment:g.string({isOptional:!0,description:"Comment explaining decision"}),decidedAt:g.dateTime({isOptional:!0}),delegatedTo:g.string({isOptional:!0,description:"User delegated to"}),delegationReason:g.string({isOptional:!0}),escalationLevel:g.int({default:0,description:"Current escalation level"}),escalatedAt:g.dateTime({isOptional:!0}),dueAt:g.dateTime({isOptional:!0,description:"When approval is due"}),reminderSentAt:g.dateTime({isOptional:!0}),contextSnapshot:g.json({isOptional:!0,description:"Snapshot of relevant data for review"}),sequenceOrder:g.int({default:0,description:"Order in approval chain"}),createdAt:g.createdAt(),updatedAt:g.updatedAt(),workflowInstance:g.belongsTo("WorkflowInstance",["workflowInstanceId"],["id"],{onDelete:"Cascade"}),stepExecution:g.belongsTo("StepExecution",["stepExecutionId"],["id"])},indexes:[j.on(["approverId","status"]),j.on(["workflowInstanceId","status"]),j.on(["stepExecutionId"]),j.on(["status","dueAt"]),j.on(["createdAt"])],enums:[z,B]}),H=k({name:"ApprovalComment",description:"A comment on an approval request.",schema:"workflow",map:"approval_comment",fields:{id:g.id(),approvalRequestId:g.foreignKey(),authorId:g.foreignKey(),content:g.string({description:"Comment text"}),isInternal:g.boolean({default:!1,description:"Internal note vs public comment"}),createdAt:g.createdAt(),updatedAt:g.updatedAt(),approvalRequest:g.belongsTo("ApprovalRequest",["approvalRequestId"],["id"],{onDelete:"Cascade"})},indexes:[j.on(["approvalRequestId","createdAt"])]});export{z as ApprovalStatusEnum,G as ApprovalRequestEntity,B as ApprovalDecisionEnum,H as ApprovalCommentEntity};
@@ -1,508 +1 @@
1
- // src/entities/approval.ts
2
- import {
3
- defineEntity,
4
- defineEntityEnum,
5
- field,
6
- index
7
- } from "@contractspec/lib.schema";
8
- var ApprovalStatusEnum = defineEntityEnum({
9
- name: "ApprovalStatus",
10
- values: [
11
- "PENDING",
12
- "APPROVED",
13
- "REJECTED",
14
- "DELEGATED",
15
- "ESCALATED",
16
- "WITHDRAWN",
17
- "EXPIRED"
18
- ],
19
- schema: "workflow",
20
- description: "Status of an approval request."
21
- });
22
- var ApprovalDecisionEnum = defineEntityEnum({
23
- name: "ApprovalDecision",
24
- values: [
25
- "APPROVE",
26
- "REJECT",
27
- "REQUEST_CHANGES",
28
- "DELEGATE",
29
- "ABSTAIN"
30
- ],
31
- schema: "workflow",
32
- description: "Possible approval decisions."
33
- });
34
- var ApprovalRequestEntity = defineEntity({
35
- name: "ApprovalRequest",
36
- description: "A pending approval request for a workflow step.",
37
- schema: "workflow",
38
- map: "approval_request",
39
- fields: {
40
- id: field.id({ description: "Unique approval request ID" }),
41
- workflowInstanceId: field.foreignKey(),
42
- stepExecutionId: field.foreignKey(),
43
- approverId: field.foreignKey({ description: "User requested to approve" }),
44
- approverRole: field.string({
45
- isOptional: true,
46
- description: "Role of the approver"
47
- }),
48
- title: field.string({ description: "Approval request title" }),
49
- description: field.string({ isOptional: true }),
50
- status: field.enum("ApprovalStatus", { default: "PENDING" }),
51
- decision: field.enum("ApprovalDecision", { isOptional: true }),
52
- decisionComment: field.string({
53
- isOptional: true,
54
- description: "Comment explaining decision"
55
- }),
56
- decidedAt: field.dateTime({ isOptional: true }),
57
- delegatedTo: field.string({
58
- isOptional: true,
59
- description: "User delegated to"
60
- }),
61
- delegationReason: field.string({ isOptional: true }),
62
- escalationLevel: field.int({
63
- default: 0,
64
- description: "Current escalation level"
65
- }),
66
- escalatedAt: field.dateTime({ isOptional: true }),
67
- dueAt: field.dateTime({
68
- isOptional: true,
69
- description: "When approval is due"
70
- }),
71
- reminderSentAt: field.dateTime({ isOptional: true }),
72
- contextSnapshot: field.json({
73
- isOptional: true,
74
- description: "Snapshot of relevant data for review"
75
- }),
76
- sequenceOrder: field.int({
77
- default: 0,
78
- description: "Order in approval chain"
79
- }),
80
- createdAt: field.createdAt(),
81
- updatedAt: field.updatedAt(),
82
- workflowInstance: field.belongsTo("WorkflowInstance", ["workflowInstanceId"], ["id"], { onDelete: "Cascade" }),
83
- stepExecution: field.belongsTo("StepExecution", ["stepExecutionId"], ["id"])
84
- },
85
- indexes: [
86
- index.on(["approverId", "status"]),
87
- index.on(["workflowInstanceId", "status"]),
88
- index.on(["stepExecutionId"]),
89
- index.on(["status", "dueAt"]),
90
- index.on(["createdAt"])
91
- ],
92
- enums: [ApprovalStatusEnum, ApprovalDecisionEnum]
93
- });
94
- var ApprovalCommentEntity = defineEntity({
95
- name: "ApprovalComment",
96
- description: "A comment on an approval request.",
97
- schema: "workflow",
98
- map: "approval_comment",
99
- fields: {
100
- id: field.id(),
101
- approvalRequestId: field.foreignKey(),
102
- authorId: field.foreignKey(),
103
- content: field.string({ description: "Comment text" }),
104
- isInternal: field.boolean({
105
- default: false,
106
- description: "Internal note vs public comment"
107
- }),
108
- createdAt: field.createdAt(),
109
- updatedAt: field.updatedAt(),
110
- approvalRequest: field.belongsTo("ApprovalRequest", ["approvalRequestId"], ["id"], { onDelete: "Cascade" })
111
- },
112
- indexes: [index.on(["approvalRequestId", "createdAt"])]
113
- });
114
-
115
- // src/entities/instance.ts
116
- import {
117
- defineEntity as defineEntity2,
118
- defineEntityEnum as defineEntityEnum2,
119
- field as field2,
120
- index as index2
121
- } from "@contractspec/lib.schema";
122
- var InstanceStatusEnum = defineEntityEnum2({
123
- name: "InstanceStatus",
124
- values: [
125
- "PENDING",
126
- "RUNNING",
127
- "WAITING",
128
- "PAUSED",
129
- "COMPLETED",
130
- "CANCELLED",
131
- "FAILED",
132
- "TIMEOUT"
133
- ],
134
- schema: "workflow",
135
- description: "Status of a workflow instance."
136
- });
137
- var StepExecutionStatusEnum = defineEntityEnum2({
138
- name: "StepExecutionStatus",
139
- values: [
140
- "PENDING",
141
- "ACTIVE",
142
- "COMPLETED",
143
- "SKIPPED",
144
- "FAILED",
145
- "TIMEOUT"
146
- ],
147
- schema: "workflow",
148
- description: "Status of a step execution."
149
- });
150
- var WorkflowInstanceEntity = defineEntity2({
151
- name: "WorkflowInstance",
152
- description: "A running instance of a workflow definition.",
153
- schema: "workflow",
154
- map: "workflow_instance",
155
- fields: {
156
- id: field2.id({ description: "Unique instance ID" }),
157
- workflowDefinitionId: field2.foreignKey(),
158
- referenceId: field2.string({
159
- isOptional: true,
160
- description: "External reference (e.g., order ID)"
161
- }),
162
- referenceType: field2.string({
163
- isOptional: true,
164
- description: 'Type of reference (e.g., "Order")'
165
- }),
166
- status: field2.enum("InstanceStatus", { default: "PENDING" }),
167
- currentStepId: field2.string({
168
- isOptional: true,
169
- description: "Current step being executed"
170
- }),
171
- contextData: field2.json({ description: "Data context for this instance" }),
172
- triggeredBy: field2.foreignKey({
173
- description: "User who triggered the workflow"
174
- }),
175
- triggerSource: field2.string({
176
- isOptional: true,
177
- description: 'Source of trigger (e.g., "api", "ui")'
178
- }),
179
- organizationId: field2.foreignKey(),
180
- priority: field2.int({
181
- default: 0,
182
- description: "Processing priority (higher = more urgent)"
183
- }),
184
- dueAt: field2.dateTime({
185
- isOptional: true,
186
- description: "When this instance should complete"
187
- }),
188
- outcome: field2.string({
189
- isOptional: true,
190
- description: 'Final outcome (e.g., "approved", "rejected")'
191
- }),
192
- resultData: field2.json({
193
- isOptional: true,
194
- description: "Final result data"
195
- }),
196
- errorMessage: field2.string({
197
- isOptional: true,
198
- description: "Error message if failed"
199
- }),
200
- createdAt: field2.createdAt(),
201
- updatedAt: field2.updatedAt(),
202
- startedAt: field2.dateTime({ isOptional: true }),
203
- completedAt: field2.dateTime({ isOptional: true }),
204
- workflowDefinition: field2.belongsTo("WorkflowDefinition", ["workflowDefinitionId"], ["id"]),
205
- currentStep: field2.belongsTo("WorkflowStep", ["currentStepId"], ["id"]),
206
- stepExecutions: field2.hasMany("StepExecution"),
207
- approvalRequests: field2.hasMany("ApprovalRequest")
208
- },
209
- indexes: [
210
- index2.on(["organizationId", "status"]),
211
- index2.on(["workflowDefinitionId", "status"]),
212
- index2.on(["referenceType", "referenceId"]),
213
- index2.on(["triggeredBy", "status"]),
214
- index2.on(["status", "dueAt"]),
215
- index2.on(["createdAt"])
216
- ],
217
- enums: [InstanceStatusEnum]
218
- });
219
- var StepExecutionEntity = defineEntity2({
220
- name: "StepExecution",
221
- description: "Execution record of a step within a workflow instance.",
222
- schema: "workflow",
223
- map: "step_execution",
224
- fields: {
225
- id: field2.id({ description: "Unique execution ID" }),
226
- workflowInstanceId: field2.foreignKey(),
227
- workflowStepId: field2.foreignKey(),
228
- status: field2.enum("StepExecutionStatus", { default: "PENDING" }),
229
- executionOrder: field2.int({
230
- default: 0,
231
- description: "Order of execution within instance"
232
- }),
233
- inputData: field2.json({
234
- isOptional: true,
235
- description: "Data when entering step"
236
- }),
237
- outputData: field2.json({
238
- isOptional: true,
239
- description: "Data when exiting step"
240
- }),
241
- actionTaken: field2.string({
242
- isOptional: true,
243
- description: 'Action that caused transition (e.g., "approve")'
244
- }),
245
- transitionedTo: field2.string({
246
- isOptional: true,
247
- description: "Step key transitioned to"
248
- }),
249
- executedBy: field2.string({
250
- isOptional: true,
251
- description: "User who completed this step"
252
- }),
253
- errorMessage: field2.string({ isOptional: true }),
254
- errorDetails: field2.json({ isOptional: true }),
255
- retryCount: field2.int({ default: 0 }),
256
- createdAt: field2.createdAt(),
257
- updatedAt: field2.updatedAt(),
258
- startedAt: field2.dateTime({ isOptional: true }),
259
- completedAt: field2.dateTime({ isOptional: true }),
260
- workflowInstance: field2.belongsTo("WorkflowInstance", ["workflowInstanceId"], ["id"], { onDelete: "Cascade" }),
261
- workflowStep: field2.belongsTo("WorkflowStep", ["workflowStepId"], ["id"])
262
- },
263
- indexes: [
264
- index2.on(["workflowInstanceId", "executionOrder"]),
265
- index2.on(["workflowInstanceId", "workflowStepId"]),
266
- index2.on(["status"])
267
- ],
268
- enums: [StepExecutionStatusEnum]
269
- });
270
-
271
- // src/entities/step.ts
272
- import {
273
- defineEntity as defineEntity3,
274
- defineEntityEnum as defineEntityEnum3,
275
- field as field3,
276
- index as index3
277
- } from "@contractspec/lib.schema";
278
- var StepTypeEnum = defineEntityEnum3({
279
- name: "StepType",
280
- values: [
281
- "START",
282
- "APPROVAL",
283
- "TASK",
284
- "CONDITION",
285
- "PARALLEL",
286
- "WAIT",
287
- "ACTION",
288
- "END"
289
- ],
290
- schema: "workflow",
291
- description: "Type of workflow step."
292
- });
293
- var ApprovalModeEnum = defineEntityEnum3({
294
- name: "ApprovalMode",
295
- values: [
296
- "ANY",
297
- "ALL",
298
- "MAJORITY",
299
- "SEQUENTIAL"
300
- ],
301
- schema: "workflow",
302
- description: "How multiple approvers are handled."
303
- });
304
- var WorkflowStepEntity = defineEntity3({
305
- name: "WorkflowStep",
306
- description: "A single step/state in a workflow definition.",
307
- schema: "workflow",
308
- map: "workflow_step",
309
- fields: {
310
- id: field3.id({ description: "Unique step ID" }),
311
- workflowDefinitionId: field3.foreignKey(),
312
- name: field3.string({ description: "Human-readable step name" }),
313
- key: field3.string({
314
- description: 'Unique key within workflow (e.g., "manager_approval")'
315
- }),
316
- description: field3.string({ isOptional: true }),
317
- type: field3.enum("StepType", { default: "TASK" }),
318
- position: field3.int({ default: 0, description: "Order for display" }),
319
- transitions: field3.json({ description: "Map of action -> next step key" }),
320
- approvalMode: field3.enum("ApprovalMode", {
321
- default: "ANY",
322
- isOptional: true
323
- }),
324
- approverRoles: field3.string({
325
- isArray: true,
326
- description: "Roles that can approve"
327
- }),
328
- approverUserIds: field3.string({
329
- isArray: true,
330
- description: "Specific users that can approve"
331
- }),
332
- escalationConfig: field3.json({
333
- isOptional: true,
334
- description: "Escalation rules"
335
- }),
336
- assigneeRoles: field3.string({
337
- isArray: true,
338
- description: "Roles that can be assigned"
339
- }),
340
- taskTemplate: field3.json({
341
- isOptional: true,
342
- description: "Template for task creation"
343
- }),
344
- conditionExpression: field3.string({
345
- isOptional: true,
346
- description: "Expression for branching"
347
- }),
348
- waitDuration: field3.int({
349
- isOptional: true,
350
- description: "Wait duration in seconds"
351
- }),
352
- waitForEvent: field3.string({
353
- isOptional: true,
354
- description: "Event name to wait for"
355
- }),
356
- actionType: field3.string({
357
- isOptional: true,
358
- description: "Action to execute"
359
- }),
360
- actionConfig: field3.json({
361
- isOptional: true,
362
- description: "Action parameters"
363
- }),
364
- timeoutSeconds: field3.int({
365
- isOptional: true,
366
- description: "Step timeout"
367
- }),
368
- slaSeconds: field3.int({ isOptional: true, description: "SLA deadline" }),
369
- notifyOnEnter: field3.json({
370
- isOptional: true,
371
- description: "Notification config when entering step"
372
- }),
373
- notifyOnExit: field3.json({
374
- isOptional: true,
375
- description: "Notification config when exiting step"
376
- }),
377
- metadata: field3.json({ isOptional: true }),
378
- createdAt: field3.createdAt(),
379
- updatedAt: field3.updatedAt(),
380
- workflowDefinition: field3.belongsTo("WorkflowDefinition", ["workflowDefinitionId"], ["id"], { onDelete: "Cascade" }),
381
- executions: field3.hasMany("StepExecution")
382
- },
383
- indexes: [
384
- index3.unique(["workflowDefinitionId", "key"]),
385
- index3.on(["workflowDefinitionId", "position"]),
386
- index3.on(["type"])
387
- ],
388
- enums: [StepTypeEnum, ApprovalModeEnum]
389
- });
390
-
391
- // src/entities/workflow.ts
392
- import {
393
- defineEntity as defineEntity4,
394
- defineEntityEnum as defineEntityEnum4,
395
- field as field4,
396
- index as index4
397
- } from "@contractspec/lib.schema";
398
- var WorkflowStatusEnum = defineEntityEnum4({
399
- name: "WorkflowStatus",
400
- values: ["DRAFT", "ACTIVE", "DEPRECATED", "ARCHIVED"],
401
- schema: "workflow",
402
- description: "Status of a workflow definition."
403
- });
404
- var WorkflowTriggerTypeEnum = defineEntityEnum4({
405
- name: "WorkflowTriggerType",
406
- values: ["MANUAL", "EVENT", "SCHEDULED", "API"],
407
- schema: "workflow",
408
- description: "What triggers workflow instantiation."
409
- });
410
- var WorkflowDefinitionEntity = defineEntity4({
411
- name: "WorkflowDefinition",
412
- description: "A workflow blueprint that defines the process structure.",
413
- schema: "workflow",
414
- map: "workflow_definition",
415
- fields: {
416
- id: field4.id({ description: "Unique workflow definition ID" }),
417
- name: field4.string({ description: "Human-readable workflow name" }),
418
- key: field4.string({
419
- description: 'Unique key for referencing (e.g., "purchase_approval")'
420
- }),
421
- description: field4.string({
422
- isOptional: true,
423
- description: "Detailed description"
424
- }),
425
- version: field4.int({
426
- default: 1,
427
- description: "Version number for versioning definitions"
428
- }),
429
- status: field4.enum("WorkflowStatus", { default: "DRAFT" }),
430
- triggerType: field4.enum("WorkflowTriggerType", { default: "MANUAL" }),
431
- triggerConfig: field4.json({
432
- isOptional: true,
433
- description: "Trigger-specific configuration"
434
- }),
435
- initialStepId: field4.string({
436
- isOptional: true,
437
- description: "First step when workflow starts"
438
- }),
439
- featureFlagKey: field4.string({
440
- isOptional: true,
441
- description: "Feature flag to control availability"
442
- }),
443
- settings: field4.json({
444
- isOptional: true,
445
- description: "Workflow-wide settings"
446
- }),
447
- metadata: field4.json({ isOptional: true, description: "Custom metadata" }),
448
- organizationId: field4.foreignKey({ description: "Owning organization" }),
449
- createdBy: field4.foreignKey({
450
- description: "User who created this workflow"
451
- }),
452
- createdAt: field4.createdAt(),
453
- updatedAt: field4.updatedAt(),
454
- publishedAt: field4.dateTime({
455
- isOptional: true,
456
- description: "When workflow was activated"
457
- }),
458
- steps: field4.hasMany("WorkflowStep"),
459
- instances: field4.hasMany("WorkflowInstance")
460
- },
461
- indexes: [
462
- index4.unique(["organizationId", "key", "version"]),
463
- index4.on(["organizationId", "status"]),
464
- index4.on(["key", "version"])
465
- ],
466
- enums: [WorkflowStatusEnum, WorkflowTriggerTypeEnum]
467
- });
468
- // src/entities/index.ts
469
- var workflowSystemEntities = [
470
- WorkflowDefinitionEntity,
471
- WorkflowStepEntity,
472
- WorkflowInstanceEntity,
473
- StepExecutionEntity,
474
- ApprovalRequestEntity,
475
- ApprovalCommentEntity
476
- ];
477
- var workflowSystemSchemaContribution = {
478
- moduleId: "@contractspec/example.workflow-system",
479
- entities: workflowSystemEntities,
480
- enums: [
481
- WorkflowStatusEnum,
482
- WorkflowTriggerTypeEnum,
483
- StepTypeEnum,
484
- ApprovalModeEnum,
485
- InstanceStatusEnum,
486
- StepExecutionStatusEnum,
487
- ApprovalStatusEnum,
488
- ApprovalDecisionEnum
489
- ]
490
- };
491
- export {
492
- workflowSystemSchemaContribution,
493
- workflowSystemEntities,
494
- WorkflowTriggerTypeEnum,
495
- WorkflowStepEntity,
496
- WorkflowStatusEnum,
497
- WorkflowInstanceEntity,
498
- WorkflowDefinitionEntity,
499
- StepTypeEnum,
500
- StepExecutionStatusEnum,
501
- StepExecutionEntity,
502
- InstanceStatusEnum,
503
- ApprovalStatusEnum,
504
- ApprovalRequestEntity,
505
- ApprovalModeEnum,
506
- ApprovalDecisionEnum,
507
- ApprovalCommentEntity
508
- };
1
+ import{defineEntity as U,defineEntityEnum as V,field as p,index as W}from"@contractspec/lib.schema";var k=V({name:"ApprovalStatus",values:["PENDING","APPROVED","REJECTED","DELEGATED","ESCALATED","WITHDRAWN","EXPIRED"],schema:"workflow",description:"Status of an approval request."}),w=V({name:"ApprovalDecision",values:["APPROVE","REJECT","REQUEST_CHANGES","DELEGATE","ABSTAIN"],schema:"workflow",description:"Possible approval decisions."}),j=U({name:"ApprovalRequest",description:"A pending approval request for a workflow step.",schema:"workflow",map:"approval_request",fields:{id:p.id({description:"Unique approval request ID"}),workflowInstanceId:p.foreignKey(),stepExecutionId:p.foreignKey(),approverId:p.foreignKey({description:"User requested to approve"}),approverRole:p.string({isOptional:!0,description:"Role of the approver"}),title:p.string({description:"Approval request title"}),description:p.string({isOptional:!0}),status:p.enum("ApprovalStatus",{default:"PENDING"}),decision:p.enum("ApprovalDecision",{isOptional:!0}),decisionComment:p.string({isOptional:!0,description:"Comment explaining decision"}),decidedAt:p.dateTime({isOptional:!0}),delegatedTo:p.string({isOptional:!0,description:"User delegated to"}),delegationReason:p.string({isOptional:!0}),escalationLevel:p.int({default:0,description:"Current escalation level"}),escalatedAt:p.dateTime({isOptional:!0}),dueAt:p.dateTime({isOptional:!0,description:"When approval is due"}),reminderSentAt:p.dateTime({isOptional:!0}),contextSnapshot:p.json({isOptional:!0,description:"Snapshot of relevant data for review"}),sequenceOrder:p.int({default:0,description:"Order in approval chain"}),createdAt:p.createdAt(),updatedAt:p.updatedAt(),workflowInstance:p.belongsTo("WorkflowInstance",["workflowInstanceId"],["id"],{onDelete:"Cascade"}),stepExecution:p.belongsTo("StepExecution",["stepExecutionId"],["id"])},indexes:[W.on(["approverId","status"]),W.on(["workflowInstanceId","status"]),W.on(["stepExecutionId"]),W.on(["status","dueAt"]),W.on(["createdAt"])],enums:[k,w]}),z=U({name:"ApprovalComment",description:"A comment on an approval request.",schema:"workflow",map:"approval_comment",fields:{id:p.id(),approvalRequestId:p.foreignKey(),authorId:p.foreignKey(),content:p.string({description:"Comment text"}),isInternal:p.boolean({default:!1,description:"Internal note vs public comment"}),createdAt:p.createdAt(),updatedAt:p.updatedAt(),approvalRequest:p.belongsTo("ApprovalRequest",["approvalRequestId"],["id"],{onDelete:"Cascade"})},indexes:[W.on(["approvalRequestId","createdAt"])]});import{defineEntity as X,defineEntityEnum as Y,field as o,index as m}from"@contractspec/lib.schema";var v=Y({name:"InstanceStatus",values:["PENDING","RUNNING","WAITING","PAUSED","COMPLETED","CANCELLED","FAILED","TIMEOUT"],schema:"workflow",description:"Status of a workflow instance."}),D=Y({name:"StepExecutionStatus",values:["PENDING","ACTIVE","COMPLETED","SKIPPED","FAILED","TIMEOUT"],schema:"workflow",description:"Status of a step execution."}),B=X({name:"WorkflowInstance",description:"A running instance of a workflow definition.",schema:"workflow",map:"workflow_instance",fields:{id:o.id({description:"Unique instance ID"}),workflowDefinitionId:o.foreignKey(),referenceId:o.string({isOptional:!0,description:"External reference (e.g., order ID)"}),referenceType:o.string({isOptional:!0,description:'Type of reference (e.g., "Order")'}),status:o.enum("InstanceStatus",{default:"PENDING"}),currentStepId:o.string({isOptional:!0,description:"Current step being executed"}),contextData:o.json({description:"Data context for this instance"}),triggeredBy:o.foreignKey({description:"User who triggered the workflow"}),triggerSource:o.string({isOptional:!0,description:'Source of trigger (e.g., "api", "ui")'}),organizationId:o.foreignKey(),priority:o.int({default:0,description:"Processing priority (higher = more urgent)"}),dueAt:o.dateTime({isOptional:!0,description:"When this instance should complete"}),outcome:o.string({isOptional:!0,description:'Final outcome (e.g., "approved", "rejected")'}),resultData:o.json({isOptional:!0,description:"Final result data"}),errorMessage:o.string({isOptional:!0,description:"Error message if failed"}),createdAt:o.createdAt(),updatedAt:o.updatedAt(),startedAt:o.dateTime({isOptional:!0}),completedAt:o.dateTime({isOptional:!0}),workflowDefinition:o.belongsTo("WorkflowDefinition",["workflowDefinitionId"],["id"]),currentStep:o.belongsTo("WorkflowStep",["currentStepId"],["id"]),stepExecutions:o.hasMany("StepExecution"),approvalRequests:o.hasMany("ApprovalRequest")},indexes:[m.on(["organizationId","status"]),m.on(["workflowDefinitionId","status"]),m.on(["referenceType","referenceId"]),m.on(["triggeredBy","status"]),m.on(["status","dueAt"]),m.on(["createdAt"])],enums:[v]}),G=X({name:"StepExecution",description:"Execution record of a step within a workflow instance.",schema:"workflow",map:"step_execution",fields:{id:o.id({description:"Unique execution ID"}),workflowInstanceId:o.foreignKey(),workflowStepId:o.foreignKey(),status:o.enum("StepExecutionStatus",{default:"PENDING"}),executionOrder:o.int({default:0,description:"Order of execution within instance"}),inputData:o.json({isOptional:!0,description:"Data when entering step"}),outputData:o.json({isOptional:!0,description:"Data when exiting step"}),actionTaken:o.string({isOptional:!0,description:'Action that caused transition (e.g., "approve")'}),transitionedTo:o.string({isOptional:!0,description:"Step key transitioned to"}),executedBy:o.string({isOptional:!0,description:"User who completed this step"}),errorMessage:o.string({isOptional:!0}),errorDetails:o.json({isOptional:!0}),retryCount:o.int({default:0}),createdAt:o.createdAt(),updatedAt:o.updatedAt(),startedAt:o.dateTime({isOptional:!0}),completedAt:o.dateTime({isOptional:!0}),workflowInstance:o.belongsTo("WorkflowInstance",["workflowInstanceId"],["id"],{onDelete:"Cascade"}),workflowStep:o.belongsTo("WorkflowStep",["workflowStepId"],["id"])},indexes:[m.on(["workflowInstanceId","executionOrder"]),m.on(["workflowInstanceId","workflowStepId"]),m.on(["status"])],enums:[D]});import{defineEntity as $,defineEntityEnum as Z,field as r,index as H}from"@contractspec/lib.schema";var M=Z({name:"StepType",values:["START","APPROVAL","TASK","CONDITION","PARALLEL","WAIT","ACTION","END"],schema:"workflow",description:"Type of workflow step."}),q=Z({name:"ApprovalMode",values:["ANY","ALL","MAJORITY","SEQUENTIAL"],schema:"workflow",description:"How multiple approvers are handled."}),J=$({name:"WorkflowStep",description:"A single step/state in a workflow definition.",schema:"workflow",map:"workflow_step",fields:{id:r.id({description:"Unique step ID"}),workflowDefinitionId:r.foreignKey(),name:r.string({description:"Human-readable step name"}),key:r.string({description:'Unique key within workflow (e.g., "manager_approval")'}),description:r.string({isOptional:!0}),type:r.enum("StepType",{default:"TASK"}),position:r.int({default:0,description:"Order for display"}),transitions:r.json({description:"Map of action -> next step key"}),approvalMode:r.enum("ApprovalMode",{default:"ANY",isOptional:!0}),approverRoles:r.string({isArray:!0,description:"Roles that can approve"}),approverUserIds:r.string({isArray:!0,description:"Specific users that can approve"}),escalationConfig:r.json({isOptional:!0,description:"Escalation rules"}),assigneeRoles:r.string({isArray:!0,description:"Roles that can be assigned"}),taskTemplate:r.json({isOptional:!0,description:"Template for task creation"}),conditionExpression:r.string({isOptional:!0,description:"Expression for branching"}),waitDuration:r.int({isOptional:!0,description:"Wait duration in seconds"}),waitForEvent:r.string({isOptional:!0,description:"Event name to wait for"}),actionType:r.string({isOptional:!0,description:"Action to execute"}),actionConfig:r.json({isOptional:!0,description:"Action parameters"}),timeoutSeconds:r.int({isOptional:!0,description:"Step timeout"}),slaSeconds:r.int({isOptional:!0,description:"SLA deadline"}),notifyOnEnter:r.json({isOptional:!0,description:"Notification config when entering step"}),notifyOnExit:r.json({isOptional:!0,description:"Notification config when exiting step"}),metadata:r.json({isOptional:!0}),createdAt:r.createdAt(),updatedAt:r.updatedAt(),workflowDefinition:r.belongsTo("WorkflowDefinition",["workflowDefinitionId"],["id"],{onDelete:"Cascade"}),executions:r.hasMany("StepExecution")},indexes:[H.unique(["workflowDefinitionId","key"]),H.on(["workflowDefinitionId","position"]),H.on(["type"])],enums:[M,q]});import{defineEntity as F,defineEntityEnum as _,field as S,index as K}from"@contractspec/lib.schema";var A=_({name:"WorkflowStatus",values:["DRAFT","ACTIVE","DEPRECATED","ARCHIVED"],schema:"workflow",description:"Status of a workflow definition."}),C=_({name:"WorkflowTriggerType",values:["MANUAL","EVENT","SCHEDULED","API"],schema:"workflow",description:"What triggers workflow instantiation."}),Q=F({name:"WorkflowDefinition",description:"A workflow blueprint that defines the process structure.",schema:"workflow",map:"workflow_definition",fields:{id:S.id({description:"Unique workflow definition ID"}),name:S.string({description:"Human-readable workflow name"}),key:S.string({description:'Unique key for referencing (e.g., "purchase_approval")'}),description:S.string({isOptional:!0,description:"Detailed description"}),version:S.int({default:1,description:"Version number for versioning definitions"}),status:S.enum("WorkflowStatus",{default:"DRAFT"}),triggerType:S.enum("WorkflowTriggerType",{default:"MANUAL"}),triggerConfig:S.json({isOptional:!0,description:"Trigger-specific configuration"}),initialStepId:S.string({isOptional:!0,description:"First step when workflow starts"}),featureFlagKey:S.string({isOptional:!0,description:"Feature flag to control availability"}),settings:S.json({isOptional:!0,description:"Workflow-wide settings"}),metadata:S.json({isOptional:!0,description:"Custom metadata"}),organizationId:S.foreignKey({description:"Owning organization"}),createdBy:S.foreignKey({description:"User who created this workflow"}),createdAt:S.createdAt(),updatedAt:S.updatedAt(),publishedAt:S.dateTime({isOptional:!0,description:"When workflow was activated"}),steps:S.hasMany("WorkflowStep"),instances:S.hasMany("WorkflowInstance")},indexes:[K.unique(["organizationId","key","version"]),K.on(["organizationId","status"]),K.on(["key","version"])],enums:[A,C]});var I=[Q,J,B,G,j,z],c={moduleId:"@contractspec/example.workflow-system",entities:I,enums:[A,C,M,q,v,D,k,w]};export{c as workflowSystemSchemaContribution,I as workflowSystemEntities,C as WorkflowTriggerTypeEnum,J as WorkflowStepEntity,A as WorkflowStatusEnum,B as WorkflowInstanceEntity,Q as WorkflowDefinitionEntity,M as StepTypeEnum,D as StepExecutionStatusEnum,G as StepExecutionEntity,v as InstanceStatusEnum,k as ApprovalStatusEnum,j as ApprovalRequestEntity,q as ApprovalModeEnum,w as ApprovalDecisionEnum,z as ApprovalCommentEntity};