@contractspec/example.workflow-system 3.8.9 → 3.8.10

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,678 +1,2 @@
1
1
  // @bun
2
- // src/instance/instance.enum.ts
3
- import { defineEnum } from "@contractspec/lib.schema";
4
- var InstanceStatusEnum = defineEnum("InstanceStatus", [
5
- "PENDING",
6
- "RUNNING",
7
- "WAITING",
8
- "PAUSED",
9
- "COMPLETED",
10
- "CANCELLED",
11
- "FAILED",
12
- "TIMEOUT"
13
- ]);
14
-
15
- // src/instance/instance.event.ts
16
- import { defineEvent } from "@contractspec/lib.contracts-spec";
17
- import { defineSchemaModel, ScalarTypeEnum } from "@contractspec/lib.schema";
18
- var InstanceEventPayload = defineSchemaModel({
19
- name: "InstanceEventPayload",
20
- description: "Base payload for instance events",
21
- fields: {
22
- instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
23
- workflowId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
24
- workflowKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
25
- status: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
26
- referenceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
27
- referenceType: {
28
- type: ScalarTypeEnum.String_unsecure(),
29
- isOptional: true
30
- },
31
- triggeredBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
32
- organizationId: {
33
- type: ScalarTypeEnum.String_unsecure(),
34
- isOptional: false
35
- },
36
- timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
37
- }
38
- });
39
- var StepTransitionPayload = defineSchemaModel({
40
- name: "StepTransitionEventPayload",
41
- description: "Payload for step transition events",
42
- fields: {
43
- instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
44
- workflowId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
45
- fromStepKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
46
- toStepKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
47
- action: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
48
- executedBy: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
49
- timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
50
- }
51
- });
52
- var InstanceCompletedPayload = defineSchemaModel({
53
- name: "InstanceCompletedEventPayload",
54
- description: "Payload when instance completes",
55
- fields: {
56
- instanceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
57
- workflowId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
58
- workflowKey: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
59
- outcome: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
60
- referenceId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
61
- referenceType: {
62
- type: ScalarTypeEnum.String_unsecure(),
63
- isOptional: true
64
- },
65
- duration: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
66
- timestamp: { type: ScalarTypeEnum.DateTime(), isOptional: false }
67
- }
68
- });
69
- var InstanceStartedEvent = defineEvent({
70
- meta: {
71
- key: "workflow.instance.started",
72
- version: "1.0.0",
73
- description: "A new workflow instance has been started.",
74
- stability: "stable",
75
- owners: ["@workflow-team"],
76
- tags: ["workflow", "instance", "started"]
77
- },
78
- payload: InstanceEventPayload
79
- });
80
- var StepEnteredEvent = defineEvent({
81
- meta: {
82
- key: "workflow.step.entered",
83
- version: "1.0.0",
84
- description: "A workflow instance has entered a new step.",
85
- stability: "stable",
86
- owners: ["@workflow-team"],
87
- tags: ["workflow", "step", "entered"]
88
- },
89
- payload: StepTransitionPayload
90
- });
91
- var StepExitedEvent = defineEvent({
92
- meta: {
93
- key: "workflow.step.exited",
94
- version: "1.0.0",
95
- description: "A workflow instance has exited a step.",
96
- stability: "stable",
97
- owners: ["@workflow-team"],
98
- tags: ["workflow", "step", "exited"]
99
- },
100
- payload: StepTransitionPayload
101
- });
102
- var InstanceCompletedEvent = defineEvent({
103
- meta: {
104
- key: "workflow.instance.completed",
105
- version: "1.0.0",
106
- description: "A workflow instance has completed.",
107
- stability: "stable",
108
- owners: ["@workflow-team"],
109
- tags: ["workflow", "instance", "completed"]
110
- },
111
- payload: InstanceCompletedPayload
112
- });
113
- var InstanceCancelledEvent = defineEvent({
114
- meta: {
115
- key: "workflow.instance.cancelled",
116
- version: "1.0.0",
117
- description: "A workflow instance has been cancelled.",
118
- stability: "stable",
119
- owners: ["@workflow-team"],
120
- tags: ["workflow", "instance", "cancelled"]
121
- },
122
- payload: InstanceEventPayload
123
- });
124
- var InstancePausedEvent = defineEvent({
125
- meta: {
126
- key: "workflow.instance.paused",
127
- version: "1.0.0",
128
- description: "A workflow instance has been paused.",
129
- stability: "stable",
130
- owners: ["@workflow-team"],
131
- tags: ["workflow", "instance", "paused"]
132
- },
133
- payload: InstanceEventPayload
134
- });
135
- var InstanceResumedEvent = defineEvent({
136
- meta: {
137
- key: "workflow.instance.resumed",
138
- version: "1.0.0",
139
- description: "A workflow instance has been resumed.",
140
- stability: "stable",
141
- owners: ["@workflow-team"],
142
- tags: ["workflow", "instance", "resumed"]
143
- },
144
- payload: InstanceEventPayload
145
- });
146
- var InstanceFailedEvent = defineEvent({
147
- meta: {
148
- key: "workflow.instance.failed",
149
- version: "1.0.0",
150
- description: "A workflow instance has failed.",
151
- stability: "stable",
152
- owners: ["@workflow-team"],
153
- tags: ["workflow", "instance", "failed"]
154
- },
155
- payload: InstanceEventPayload
156
- });
157
- var InstanceTimedOutEvent = defineEvent({
158
- meta: {
159
- key: "workflow.instance.timedOut",
160
- version: "1.0.0",
161
- description: "A workflow instance has timed out.",
162
- stability: "stable",
163
- owners: ["@workflow-team"],
164
- tags: ["workflow", "instance", "timeout"]
165
- },
166
- payload: InstanceEventPayload
167
- });
168
-
169
- // src/instance/instance.schema.ts
170
- import { defineSchemaModel as defineSchemaModel2, ScalarTypeEnum as ScalarTypeEnum2 } from "@contractspec/lib.schema";
171
- var WorkflowInstanceModel = defineSchemaModel2({
172
- name: "WorkflowInstanceModel",
173
- description: "A running workflow instance",
174
- fields: {
175
- id: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
176
- workflowDefinitionId: {
177
- type: ScalarTypeEnum2.String_unsecure(),
178
- isOptional: false
179
- },
180
- referenceId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
181
- referenceType: {
182
- type: ScalarTypeEnum2.String_unsecure(),
183
- isOptional: true
184
- },
185
- status: { type: InstanceStatusEnum, isOptional: false },
186
- currentStepId: {
187
- type: ScalarTypeEnum2.String_unsecure(),
188
- isOptional: true
189
- },
190
- contextData: { type: ScalarTypeEnum2.JSON(), isOptional: true },
191
- triggeredBy: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
192
- organizationId: {
193
- type: ScalarTypeEnum2.String_unsecure(),
194
- isOptional: false
195
- },
196
- priority: { type: ScalarTypeEnum2.Int_unsecure(), isOptional: false },
197
- dueAt: { type: ScalarTypeEnum2.DateTime(), isOptional: true },
198
- outcome: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
199
- resultData: { type: ScalarTypeEnum2.JSON(), isOptional: true },
200
- errorMessage: {
201
- type: ScalarTypeEnum2.String_unsecure(),
202
- isOptional: true
203
- },
204
- createdAt: { type: ScalarTypeEnum2.DateTime(), isOptional: false },
205
- startedAt: { type: ScalarTypeEnum2.DateTime(), isOptional: true },
206
- completedAt: { type: ScalarTypeEnum2.DateTime(), isOptional: true }
207
- }
208
- });
209
- var StartWorkflowInputModel = defineSchemaModel2({
210
- name: "StartWorkflowInput",
211
- description: "Input for starting a workflow",
212
- fields: {
213
- workflowKey: { type: ScalarTypeEnum2.NonEmptyString(), isOptional: false },
214
- contextData: { type: ScalarTypeEnum2.JSON(), isOptional: true },
215
- referenceId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true },
216
- referenceType: {
217
- type: ScalarTypeEnum2.String_unsecure(),
218
- isOptional: true
219
- },
220
- priority: { type: ScalarTypeEnum2.Int_unsecure(), isOptional: true },
221
- dueAt: { type: ScalarTypeEnum2.DateTime(), isOptional: true }
222
- }
223
- });
224
- var TransitionInputModel = defineSchemaModel2({
225
- name: "TransitionInput",
226
- description: "Input for transitioning a workflow",
227
- fields: {
228
- instanceId: { type: ScalarTypeEnum2.String_unsecure(), isOptional: false },
229
- action: { type: ScalarTypeEnum2.NonEmptyString(), isOptional: false },
230
- data: { type: ScalarTypeEnum2.JSON(), isOptional: true },
231
- comment: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true }
232
- }
233
- });
234
- var TransitionResultModel = defineSchemaModel2({
235
- name: "TransitionResult",
236
- description: "Result of a workflow transition",
237
- fields: {
238
- success: { type: ScalarTypeEnum2.Boolean(), isOptional: false },
239
- instance: { type: WorkflowInstanceModel, isOptional: false },
240
- previousStepKey: {
241
- type: ScalarTypeEnum2.String_unsecure(),
242
- isOptional: true
243
- },
244
- currentStepKey: {
245
- type: ScalarTypeEnum2.String_unsecure(),
246
- isOptional: true
247
- },
248
- message: { type: ScalarTypeEnum2.String_unsecure(), isOptional: true }
249
- }
250
- });
251
-
252
- // src/instance/instance.operations.ts
253
- import {
254
- defineCommand,
255
- defineQuery
256
- } from "@contractspec/lib.contracts-spec/operations";
257
- import { defineSchemaModel as defineSchemaModel3, ScalarTypeEnum as ScalarTypeEnum3 } from "@contractspec/lib.schema";
258
- var OWNERS = ["@example.workflow-system"];
259
- var StartWorkflowContract = defineCommand({
260
- meta: {
261
- key: "workflow.instance.start",
262
- version: "1.0.0",
263
- stability: "stable",
264
- owners: [...OWNERS],
265
- tags: ["workflow", "instance", "start"],
266
- description: "Start a new workflow instance.",
267
- goal: "Initiate a workflow for a business process.",
268
- context: "Order creation, request submission, etc."
269
- },
270
- io: {
271
- input: StartWorkflowInputModel,
272
- output: WorkflowInstanceModel
273
- },
274
- policy: { auth: "user" },
275
- sideEffects: {
276
- emits: [
277
- {
278
- key: "workflow.instance.started",
279
- version: "1.0.0",
280
- when: "Workflow starts",
281
- payload: WorkflowInstanceModel
282
- },
283
- {
284
- key: "workflow.step.entered",
285
- version: "1.0.0",
286
- when: "First step entered",
287
- payload: WorkflowInstanceModel
288
- }
289
- ],
290
- audit: ["workflow.instance.started"]
291
- },
292
- acceptance: {
293
- scenarios: [
294
- {
295
- key: "start-workflow-happy-path",
296
- given: ["Workflow definition exists"],
297
- when: ["User starts workflow"],
298
- then: ["Instance is created and started"]
299
- }
300
- ],
301
- examples: [
302
- {
303
- key: "start-onboarding",
304
- input: {
305
- workflowKey: "onboarding-v1",
306
- context: { employeeId: "emp-123" }
307
- },
308
- output: { id: "inst-456", status: "running" }
309
- }
310
- ]
311
- }
312
- });
313
- var TransitionWorkflowContract = defineCommand({
314
- meta: {
315
- key: "workflow.instance.transition",
316
- version: "1.0.0",
317
- stability: "stable",
318
- owners: [...OWNERS],
319
- tags: ["workflow", "instance", "transition", "state-machine"],
320
- description: "Transition a workflow instance to the next step.",
321
- goal: "Move workflow forward based on action.",
322
- context: "Task completion, approval decisions."
323
- },
324
- io: {
325
- input: TransitionInputModel,
326
- output: TransitionResultModel
327
- },
328
- policy: { auth: "user" },
329
- sideEffects: {
330
- emits: [
331
- {
332
- key: "workflow.step.exited",
333
- version: "1.0.0",
334
- when: "Step is exited",
335
- payload: WorkflowInstanceModel
336
- },
337
- {
338
- key: "workflow.step.entered",
339
- version: "1.0.0",
340
- when: "New step is entered",
341
- payload: WorkflowInstanceModel
342
- },
343
- {
344
- key: "workflow.instance.completed",
345
- version: "1.0.0",
346
- when: "Workflow reaches end",
347
- payload: WorkflowInstanceModel
348
- }
349
- ],
350
- audit: ["workflow.instance.transitioned"]
351
- },
352
- acceptance: {
353
- scenarios: [
354
- {
355
- key: "transition-workflow-happy-path",
356
- given: ["Workflow instance is waiting at step"],
357
- when: ["User provides input"],
358
- then: ["Instance moves to next step"]
359
- }
360
- ],
361
- examples: [
362
- {
363
- key: "complete-task",
364
- input: {
365
- instanceId: "inst-456",
366
- action: "complete",
367
- data: { approved: true }
368
- },
369
- output: { success: true, nextStep: "notify-hr" }
370
- }
371
- ]
372
- }
373
- });
374
- var PauseWorkflowContract = defineCommand({
375
- meta: {
376
- key: "workflow.instance.pause",
377
- version: "1.0.0",
378
- stability: "stable",
379
- owners: [...OWNERS],
380
- tags: ["workflow", "instance", "pause"],
381
- description: "Pause a running workflow instance.",
382
- goal: "Temporarily halt workflow execution.",
383
- context: "Administrative action, emergency stop."
384
- },
385
- io: {
386
- input: defineSchemaModel3({
387
- name: "PauseResumeInput",
388
- fields: {
389
- instanceId: {
390
- type: ScalarTypeEnum3.String_unsecure(),
391
- isOptional: false
392
- },
393
- reason: { type: ScalarTypeEnum3.String_unsecure(), isOptional: true }
394
- }
395
- }),
396
- output: WorkflowInstanceModel
397
- },
398
- policy: { auth: "user" },
399
- sideEffects: {
400
- emits: [
401
- {
402
- key: "workflow.instance.paused",
403
- version: "1.0.0",
404
- when: "Workflow is paused",
405
- payload: WorkflowInstanceModel
406
- }
407
- ],
408
- audit: ["workflow.instance.paused"]
409
- },
410
- acceptance: {
411
- scenarios: [
412
- {
413
- key: "pause-workflow-happy-path",
414
- given: ["Workflow is running"],
415
- when: ["Admin pauses workflow"],
416
- then: ["Instance status becomes PAUSED"]
417
- }
418
- ],
419
- examples: [
420
- {
421
- key: "pause-maintenance",
422
- input: { instanceId: "inst-456", reason: "System maintenance" },
423
- output: { id: "inst-456", status: "paused" }
424
- }
425
- ]
426
- }
427
- });
428
- var ResumeWorkflowContract = defineCommand({
429
- meta: {
430
- key: "workflow.instance.resume",
431
- version: "1.0.0",
432
- stability: "stable",
433
- owners: [...OWNERS],
434
- tags: ["workflow", "instance", "resume"],
435
- description: "Resume a paused workflow instance.",
436
- goal: "Continue workflow execution.",
437
- context: "Administrative action."
438
- },
439
- io: {
440
- input: defineSchemaModel3({
441
- name: "PauseResumeInput",
442
- fields: {
443
- instanceId: {
444
- type: ScalarTypeEnum3.String_unsecure(),
445
- isOptional: false
446
- },
447
- reason: { type: ScalarTypeEnum3.String_unsecure(), isOptional: true }
448
- }
449
- }),
450
- output: WorkflowInstanceModel
451
- },
452
- policy: { auth: "user" },
453
- sideEffects: {
454
- emits: [
455
- {
456
- key: "workflow.instance.resumed",
457
- version: "1.0.0",
458
- when: "Workflow is resumed",
459
- payload: WorkflowInstanceModel
460
- }
461
- ],
462
- audit: ["workflow.instance.resumed"]
463
- },
464
- acceptance: {
465
- scenarios: [
466
- {
467
- key: "resume-workflow-happy-path",
468
- given: ["Workflow is paused"],
469
- when: ["Admin resumes workflow"],
470
- then: ["Instance status becomes RUNNING"]
471
- }
472
- ],
473
- examples: [
474
- {
475
- key: "resume-normal",
476
- input: { instanceId: "inst-456", reason: "Issue resolved" },
477
- output: { id: "inst-456", status: "running" }
478
- }
479
- ]
480
- }
481
- });
482
- var CancelWorkflowContract = defineCommand({
483
- meta: {
484
- key: "workflow.instance.cancel",
485
- version: "1.0.0",
486
- stability: "stable",
487
- owners: [...OWNERS],
488
- tags: ["workflow", "instance", "cancel"],
489
- description: "Cancel a workflow instance.",
490
- goal: "Terminate workflow without completion.",
491
- context: "User request, system cancellation."
492
- },
493
- io: {
494
- input: defineSchemaModel3({
495
- name: "CancelWorkflowInput",
496
- fields: {
497
- instanceId: {
498
- type: ScalarTypeEnum3.String_unsecure(),
499
- isOptional: false
500
- },
501
- reason: {
502
- type: ScalarTypeEnum3.String_unsecure(),
503
- isOptional: false
504
- }
505
- }
506
- }),
507
- output: WorkflowInstanceModel
508
- },
509
- policy: { auth: "user" },
510
- sideEffects: {
511
- emits: [
512
- {
513
- key: "workflow.instance.cancelled",
514
- version: "1.0.0",
515
- when: "Workflow is cancelled",
516
- payload: WorkflowInstanceModel
517
- }
518
- ],
519
- audit: ["workflow.instance.cancelled"]
520
- },
521
- acceptance: {
522
- scenarios: [
523
- {
524
- key: "cancel-workflow-happy-path",
525
- given: ["Workflow is running"],
526
- when: ["User cancels workflow"],
527
- then: ["Instance status becomes CANCELLED"]
528
- }
529
- ],
530
- examples: [
531
- {
532
- key: "cancel-mistake",
533
- input: { instanceId: "inst-456", reason: "Created by mistake" },
534
- output: { id: "inst-456", status: "cancelled" }
535
- }
536
- ]
537
- }
538
- });
539
- var ListInstancesContract = defineQuery({
540
- meta: {
541
- key: "workflow.instance.list",
542
- version: "1.0.0",
543
- stability: "stable",
544
- owners: [...OWNERS],
545
- tags: ["workflow", "instance", "list"],
546
- description: "List workflow instances with filtering.",
547
- goal: "Browse and search running workflows.",
548
- context: "Dashboard, monitoring."
549
- },
550
- io: {
551
- input: defineSchemaModel3({
552
- name: "ListInstancesInput",
553
- fields: {
554
- workflowKey: {
555
- type: ScalarTypeEnum3.String_unsecure(),
556
- isOptional: true
557
- },
558
- status: { type: InstanceStatusEnum, isOptional: true },
559
- referenceType: {
560
- type: ScalarTypeEnum3.String_unsecure(),
561
- isOptional: true
562
- },
563
- referenceId: {
564
- type: ScalarTypeEnum3.String_unsecure(),
565
- isOptional: true
566
- },
567
- triggeredBy: {
568
- type: ScalarTypeEnum3.String_unsecure(),
569
- isOptional: true
570
- },
571
- limit: {
572
- type: ScalarTypeEnum3.Int_unsecure(),
573
- isOptional: true,
574
- defaultValue: 20
575
- },
576
- offset: {
577
- type: ScalarTypeEnum3.Int_unsecure(),
578
- isOptional: true,
579
- defaultValue: 0
580
- }
581
- }
582
- }),
583
- output: defineSchemaModel3({
584
- name: "ListInstancesOutput",
585
- fields: {
586
- instances: {
587
- type: WorkflowInstanceModel,
588
- isArray: true,
589
- isOptional: false
590
- },
591
- total: { type: ScalarTypeEnum3.Int_unsecure(), isOptional: false }
592
- }
593
- })
594
- },
595
- policy: { auth: "user" },
596
- acceptance: {
597
- scenarios: [
598
- {
599
- key: "list-instances-happy-path",
600
- given: ["Workflow instances exist"],
601
- when: ["User lists instances"],
602
- then: ["List of instances is returned"]
603
- }
604
- ],
605
- examples: [
606
- {
607
- key: "list-running",
608
- input: { status: "running", limit: 10 },
609
- output: { instances: [], total: 5 }
610
- }
611
- ]
612
- }
613
- });
614
- var GetInstanceContract = defineQuery({
615
- meta: {
616
- key: "workflow.instance.get",
617
- version: "1.0.0",
618
- stability: "stable",
619
- owners: [...OWNERS],
620
- tags: ["workflow", "instance", "get"],
621
- description: "Get a workflow instance with details.",
622
- goal: "View workflow instance details.",
623
- context: "Instance detail view."
624
- },
625
- io: {
626
- input: defineSchemaModel3({
627
- name: "GetInstanceInput",
628
- fields: {
629
- instanceId: {
630
- type: ScalarTypeEnum3.String_unsecure(),
631
- isOptional: false
632
- }
633
- }
634
- }),
635
- output: WorkflowInstanceModel
636
- },
637
- policy: { auth: "user" },
638
- acceptance: {
639
- scenarios: [
640
- {
641
- key: "get-instance-happy-path",
642
- given: ["Instance exists"],
643
- when: ["User requests instance details"],
644
- then: ["Instance details are returned"]
645
- }
646
- ],
647
- examples: [
648
- {
649
- key: "get-details",
650
- input: { instanceId: "inst-456" },
651
- output: { id: "inst-456", workflowKey: "onboarding-v1" }
652
- }
653
- ]
654
- }
655
- });
656
- export {
657
- WorkflowInstanceModel,
658
- TransitionWorkflowContract,
659
- TransitionResultModel,
660
- TransitionInputModel,
661
- StepExitedEvent,
662
- StepEnteredEvent,
663
- StartWorkflowInputModel,
664
- StartWorkflowContract,
665
- ResumeWorkflowContract,
666
- PauseWorkflowContract,
667
- ListInstancesContract,
668
- InstanceTimedOutEvent,
669
- InstanceStatusEnum,
670
- InstanceStartedEvent,
671
- InstanceResumedEvent,
672
- InstancePausedEvent,
673
- InstanceFailedEvent,
674
- InstanceCompletedEvent,
675
- InstanceCancelledEvent,
676
- GetInstanceContract,
677
- CancelWorkflowContract
678
- };
2
+ import{defineEnum as X}from"@contractspec/lib.schema";var z=X("InstanceStatus",["PENDING","RUNNING","WAITING","PAUSED","COMPLETED","CANCELLED","FAILED","TIMEOUT"]);import{defineEvent as G}from"@contractspec/lib.contracts-spec";import{defineSchemaModel as D,ScalarTypeEnum as C}from"@contractspec/lib.schema";var j=D({name:"InstanceEventPayload",description:"Base payload for instance events",fields:{instanceId:{type:C.String_unsecure(),isOptional:!1},workflowId:{type:C.String_unsecure(),isOptional:!1},workflowKey:{type:C.String_unsecure(),isOptional:!1},status:{type:C.String_unsecure(),isOptional:!1},referenceId:{type:C.String_unsecure(),isOptional:!0},referenceType:{type:C.String_unsecure(),isOptional:!0},triggeredBy:{type:C.String_unsecure(),isOptional:!1},organizationId:{type:C.String_unsecure(),isOptional:!1},timestamp:{type:C.DateTime(),isOptional:!1}}}),U=D({name:"StepTransitionEventPayload",description:"Payload for step transition events",fields:{instanceId:{type:C.String_unsecure(),isOptional:!1},workflowId:{type:C.String_unsecure(),isOptional:!1},fromStepKey:{type:C.String_unsecure(),isOptional:!0},toStepKey:{type:C.String_unsecure(),isOptional:!1},action:{type:C.String_unsecure(),isOptional:!0},executedBy:{type:C.String_unsecure(),isOptional:!1},timestamp:{type:C.DateTime(),isOptional:!1}}}),Y=D({name:"InstanceCompletedEventPayload",description:"Payload when instance completes",fields:{instanceId:{type:C.String_unsecure(),isOptional:!1},workflowId:{type:C.String_unsecure(),isOptional:!1},workflowKey:{type:C.String_unsecure(),isOptional:!1},outcome:{type:C.String_unsecure(),isOptional:!1},referenceId:{type:C.String_unsecure(),isOptional:!0},referenceType:{type:C.String_unsecure(),isOptional:!0},duration:{type:C.Int_unsecure(),isOptional:!1},timestamp:{type:C.DateTime(),isOptional:!1}}}),Z=G({meta:{key:"workflow.instance.started",version:"1.0.0",description:"A new workflow instance has been started.",stability:"stable",owners:["@workflow-team"],tags:["workflow","instance","started"]},payload:j}),_=G({meta:{key:"workflow.step.entered",version:"1.0.0",description:"A workflow instance has entered a new step.",stability:"stable",owners:["@workflow-team"],tags:["workflow","step","entered"]},payload:U}),$=G({meta:{key:"workflow.step.exited",version:"1.0.0",description:"A workflow instance has exited a step.",stability:"stable",owners:["@workflow-team"],tags:["workflow","step","exited"]},payload:U}),Q=G({meta:{key:"workflow.instance.completed",version:"1.0.0",description:"A workflow instance has completed.",stability:"stable",owners:["@workflow-team"],tags:["workflow","instance","completed"]},payload:Y}),b=G({meta:{key:"workflow.instance.cancelled",version:"1.0.0",description:"A workflow instance has been cancelled.",stability:"stable",owners:["@workflow-team"],tags:["workflow","instance","cancelled"]},payload:j}),v=G({meta:{key:"workflow.instance.paused",version:"1.0.0",description:"A workflow instance has been paused.",stability:"stable",owners:["@workflow-team"],tags:["workflow","instance","paused"]},payload:j}),O=G({meta:{key:"workflow.instance.resumed",version:"1.0.0",description:"A workflow instance has been resumed.",stability:"stable",owners:["@workflow-team"],tags:["workflow","instance","resumed"]},payload:j}),R=G({meta:{key:"workflow.instance.failed",version:"1.0.0",description:"A workflow instance has failed.",stability:"stable",owners:["@workflow-team"],tags:["workflow","instance","failed"]},payload:j}),N=G({meta:{key:"workflow.instance.timedOut",version:"1.0.0",description:"A workflow instance has timed out.",stability:"stable",owners:["@workflow-team"],tags:["workflow","instance","timeout"]},payload:j});import{defineSchemaModel as B,ScalarTypeEnum as x}from"@contractspec/lib.schema";var g=B({name:"WorkflowInstanceModel",description:"A running workflow instance",fields:{id:{type:x.String_unsecure(),isOptional:!1},workflowDefinitionId:{type:x.String_unsecure(),isOptional:!1},referenceId:{type:x.String_unsecure(),isOptional:!0},referenceType:{type:x.String_unsecure(),isOptional:!0},status:{type:z,isOptional:!1},currentStepId:{type:x.String_unsecure(),isOptional:!0},contextData:{type:x.JSON(),isOptional:!0},triggeredBy:{type:x.String_unsecure(),isOptional:!1},organizationId:{type:x.String_unsecure(),isOptional:!1},priority:{type:x.Int_unsecure(),isOptional:!1},dueAt:{type:x.DateTime(),isOptional:!0},outcome:{type:x.String_unsecure(),isOptional:!0},resultData:{type:x.JSON(),isOptional:!0},errorMessage:{type:x.String_unsecure(),isOptional:!0},createdAt:{type:x.DateTime(),isOptional:!1},startedAt:{type:x.DateTime(),isOptional:!0},completedAt:{type:x.DateTime(),isOptional:!0}}}),H=B({name:"StartWorkflowInput",description:"Input for starting a workflow",fields:{workflowKey:{type:x.NonEmptyString(),isOptional:!1},contextData:{type:x.JSON(),isOptional:!0},referenceId:{type:x.String_unsecure(),isOptional:!0},referenceType:{type:x.String_unsecure(),isOptional:!0},priority:{type:x.Int_unsecure(),isOptional:!0},dueAt:{type:x.DateTime(),isOptional:!0}}}),J=B({name:"TransitionInput",description:"Input for transitioning a workflow",fields:{instanceId:{type:x.String_unsecure(),isOptional:!1},action:{type:x.NonEmptyString(),isOptional:!1},data:{type:x.JSON(),isOptional:!0},comment:{type:x.String_unsecure(),isOptional:!0}}}),K=B({name:"TransitionResult",description:"Result of a workflow transition",fields:{success:{type:x.Boolean(),isOptional:!1},instance:{type:g,isOptional:!1},previousStepKey:{type:x.String_unsecure(),isOptional:!0},currentStepKey:{type:x.String_unsecure(),isOptional:!0},message:{type:x.String_unsecure(),isOptional:!0}}});import{defineCommand as A,defineQuery as V}from"@contractspec/lib.contracts-spec/operations";import{defineSchemaModel as q,ScalarTypeEnum as F}from"@contractspec/lib.schema";var L=["@example.workflow-system"],P=A({meta:{key:"workflow.instance.start",version:"1.0.0",stability:"stable",owners:[...L],tags:["workflow","instance","start"],description:"Start a new workflow instance.",goal:"Initiate a workflow for a business process.",context:"Order creation, request submission, etc."},io:{input:H,output:g},policy:{auth:"user"},sideEffects:{emits:[{key:"workflow.instance.started",version:"1.0.0",when:"Workflow starts",payload:g},{key:"workflow.step.entered",version:"1.0.0",when:"First step entered",payload:g}],audit:["workflow.instance.started"]},acceptance:{scenarios:[{key:"start-workflow-happy-path",given:["Workflow definition exists"],when:["User starts workflow"],then:["Instance is created and started"]}],examples:[{key:"start-onboarding",input:{workflowKey:"onboarding-v1",context:{employeeId:"emp-123"}},output:{id:"inst-456",status:"running"}}]}}),k=A({meta:{key:"workflow.instance.transition",version:"1.0.0",stability:"stable",owners:[...L],tags:["workflow","instance","transition","state-machine"],description:"Transition a workflow instance to the next step.",goal:"Move workflow forward based on action.",context:"Task completion, approval decisions."},io:{input:J,output:K},policy:{auth:"user"},sideEffects:{emits:[{key:"workflow.step.exited",version:"1.0.0",when:"Step is exited",payload:g},{key:"workflow.step.entered",version:"1.0.0",when:"New step is entered",payload:g},{key:"workflow.instance.completed",version:"1.0.0",when:"Workflow reaches end",payload:g}],audit:["workflow.instance.transitioned"]},acceptance:{scenarios:[{key:"transition-workflow-happy-path",given:["Workflow instance is waiting at step"],when:["User provides input"],then:["Instance moves to next step"]}],examples:[{key:"complete-task",input:{instanceId:"inst-456",action:"complete",data:{approved:!0}},output:{success:!0,nextStep:"notify-hr"}}]}}),w=A({meta:{key:"workflow.instance.pause",version:"1.0.0",stability:"stable",owners:[...L],tags:["workflow","instance","pause"],description:"Pause a running workflow instance.",goal:"Temporarily halt workflow execution.",context:"Administrative action, emergency stop."},io:{input:q({name:"PauseResumeInput",fields:{instanceId:{type:F.String_unsecure(),isOptional:!1},reason:{type:F.String_unsecure(),isOptional:!0}}}),output:g},policy:{auth:"user"},sideEffects:{emits:[{key:"workflow.instance.paused",version:"1.0.0",when:"Workflow is paused",payload:g}],audit:["workflow.instance.paused"]},acceptance:{scenarios:[{key:"pause-workflow-happy-path",given:["Workflow is running"],when:["Admin pauses workflow"],then:["Instance status becomes PAUSED"]}],examples:[{key:"pause-maintenance",input:{instanceId:"inst-456",reason:"System maintenance"},output:{id:"inst-456",status:"paused"}}]}}),I=A({meta:{key:"workflow.instance.resume",version:"1.0.0",stability:"stable",owners:[...L],tags:["workflow","instance","resume"],description:"Resume a paused workflow instance.",goal:"Continue workflow execution.",context:"Administrative action."},io:{input:q({name:"PauseResumeInput",fields:{instanceId:{type:F.String_unsecure(),isOptional:!1},reason:{type:F.String_unsecure(),isOptional:!0}}}),output:g},policy:{auth:"user"},sideEffects:{emits:[{key:"workflow.instance.resumed",version:"1.0.0",when:"Workflow is resumed",payload:g}],audit:["workflow.instance.resumed"]},acceptance:{scenarios:[{key:"resume-workflow-happy-path",given:["Workflow is paused"],when:["Admin resumes workflow"],then:["Instance status becomes RUNNING"]}],examples:[{key:"resume-normal",input:{instanceId:"inst-456",reason:"Issue resolved"},output:{id:"inst-456",status:"running"}}]}}),W=A({meta:{key:"workflow.instance.cancel",version:"1.0.0",stability:"stable",owners:[...L],tags:["workflow","instance","cancel"],description:"Cancel a workflow instance.",goal:"Terminate workflow without completion.",context:"User request, system cancellation."},io:{input:q({name:"CancelWorkflowInput",fields:{instanceId:{type:F.String_unsecure(),isOptional:!1},reason:{type:F.String_unsecure(),isOptional:!1}}}),output:g},policy:{auth:"user"},sideEffects:{emits:[{key:"workflow.instance.cancelled",version:"1.0.0",when:"Workflow is cancelled",payload:g}],audit:["workflow.instance.cancelled"]},acceptance:{scenarios:[{key:"cancel-workflow-happy-path",given:["Workflow is running"],when:["User cancels workflow"],then:["Instance status becomes CANCELLED"]}],examples:[{key:"cancel-mistake",input:{instanceId:"inst-456",reason:"Created by mistake"},output:{id:"inst-456",status:"cancelled"}}]}}),t=V({meta:{key:"workflow.instance.list",version:"1.0.0",stability:"stable",owners:[...L],tags:["workflow","instance","list"],description:"List workflow instances with filtering.",goal:"Browse and search running workflows.",context:"Dashboard, monitoring."},io:{input:q({name:"ListInstancesInput",fields:{workflowKey:{type:F.String_unsecure(),isOptional:!0},status:{type:z,isOptional:!0},referenceType:{type:F.String_unsecure(),isOptional:!0},referenceId:{type:F.String_unsecure(),isOptional:!0},triggeredBy:{type:F.String_unsecure(),isOptional:!0},limit:{type:F.Int_unsecure(),isOptional:!0,defaultValue:20},offset:{type:F.Int_unsecure(),isOptional:!0,defaultValue:0}}}),output:q({name:"ListInstancesOutput",fields:{instances:{type:g,isArray:!0,isOptional:!1},total:{type:F.Int_unsecure(),isOptional:!1}}})},policy:{auth:"user"},acceptance:{scenarios:[{key:"list-instances-happy-path",given:["Workflow instances exist"],when:["User lists instances"],then:["List of instances is returned"]}],examples:[{key:"list-running",input:{status:"running",limit:10},output:{instances:[],total:5}}]}}),h=V({meta:{key:"workflow.instance.get",version:"1.0.0",stability:"stable",owners:[...L],tags:["workflow","instance","get"],description:"Get a workflow instance with details.",goal:"View workflow instance details.",context:"Instance detail view."},io:{input:q({name:"GetInstanceInput",fields:{instanceId:{type:F.String_unsecure(),isOptional:!1}}}),output:g},policy:{auth:"user"},acceptance:{scenarios:[{key:"get-instance-happy-path",given:["Instance exists"],when:["User requests instance details"],then:["Instance details are returned"]}],examples:[{key:"get-details",input:{instanceId:"inst-456"},output:{id:"inst-456",workflowKey:"onboarding-v1"}}]}});export{g as WorkflowInstanceModel,k as TransitionWorkflowContract,K as TransitionResultModel,J as TransitionInputModel,$ as StepExitedEvent,_ as StepEnteredEvent,H as StartWorkflowInputModel,P as StartWorkflowContract,I as ResumeWorkflowContract,w as PauseWorkflowContract,t as ListInstancesContract,N as InstanceTimedOutEvent,z as InstanceStatusEnum,Z as InstanceStartedEvent,O as InstanceResumedEvent,v as InstancePausedEvent,R as InstanceFailedEvent,Q as InstanceCompletedEvent,b as InstanceCancelledEvent,h as GetInstanceContract,W as CancelWorkflowContract};