@opencrvs/toolkit 2.0.0-rc.b0a238f → 2.0.0-rc.b0c39c7

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 (105) hide show
  1. package/README.md +15 -0
  2. package/build.sh +3 -2
  3. package/create-countryconfig/index.js +50 -20
  4. package/create-countryconfig/package.json +12 -2
  5. package/dist/application-config/index.js +273 -98
  6. package/dist/cli.js +3263 -49
  7. package/dist/commons/api/router.d.ts +117 -21
  8. package/dist/commons/application-config/index.d.ts +1 -0
  9. package/dist/commons/conditionals/conditionals.d.ts +357 -7
  10. package/dist/commons/conditionals/validate.d.ts +51 -2
  11. package/dist/commons/events/ActionConfig.d.ts +35 -2
  12. package/dist/commons/events/ActionDocument.d.ts +6 -0
  13. package/dist/commons/events/ActionInput.d.ts +42 -36
  14. package/dist/commons/events/AdvancedSearchConfig.d.ts +354 -0
  15. package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
  16. package/dist/commons/events/Draft.d.ts +2 -3
  17. package/dist/commons/events/EventConfig.d.ts +2 -0
  18. package/dist/commons/events/EventDocument.d.ts +3 -0
  19. package/dist/commons/events/EventIndex.d.ts +25 -0
  20. package/dist/commons/events/EventMetadata.d.ts +26 -0
  21. package/dist/commons/events/FieldConfig.d.ts +388 -50
  22. package/dist/commons/events/FieldType.d.ts +1 -0
  23. package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
  24. package/dist/commons/events/FieldValue.d.ts +6 -0
  25. package/dist/commons/events/WorkqueueConfig.d.ts +189 -150
  26. package/dist/commons/events/field.d.ts +53 -1
  27. package/dist/commons/events/index.d.ts +2 -0
  28. package/dist/commons/events/locations.d.ts +1 -0
  29. package/dist/commons/events/state/flags.d.ts +16 -0
  30. package/dist/commons/events/state/index.d.ts +8 -0
  31. package/dist/commons/events/state/utils.d.ts +21 -287
  32. package/dist/commons/events/utils.d.ts +20 -1
  33. package/dist/conditionals/index.js +63 -5
  34. package/dist/environment/custom-types.d.ts +33 -0
  35. package/dist/environment/custom-types.d.ts.map +1 -0
  36. package/dist/environment/custom-types.js +12 -0
  37. package/dist/environment/derived-variables.d.ts +134 -0
  38. package/dist/environment/derived-variables.d.ts.map +1 -0
  39. package/dist/environment/derived-variables.js +169 -0
  40. package/dist/environment/editor-questions.d.ts +4 -0
  41. package/dist/environment/editor-questions.d.ts.map +1 -0
  42. package/dist/environment/editor-questions.js +67 -0
  43. package/dist/environment/git.d.ts +5 -0
  44. package/dist/environment/git.d.ts.map +1 -0
  45. package/dist/environment/git.js +38 -0
  46. package/dist/environment/github.d.ts +26 -0
  47. package/dist/environment/github.d.ts.map +1 -0
  48. package/dist/environment/github.js +247 -0
  49. package/dist/environment/index.d.ts +5 -0
  50. package/dist/environment/index.d.ts.map +1 -0
  51. package/dist/environment/index.js +71 -0
  52. package/dist/environment/logger.d.ts +15 -0
  53. package/dist/environment/logger.d.ts.map +1 -0
  54. package/dist/environment/logger.js +25 -0
  55. package/dist/environment/manage-users.d.ts +11 -0
  56. package/dist/environment/manage-users.d.ts.map +1 -0
  57. package/dist/environment/manage-users.js +497 -0
  58. package/dist/environment/questions-helper.d.ts +15 -0
  59. package/dist/environment/questions-helper.d.ts.map +1 -0
  60. package/dist/environment/questions-helper.js +70 -0
  61. package/dist/environment/questions.d.ts +199 -0
  62. package/dist/environment/questions.d.ts.map +1 -0
  63. package/dist/environment/questions.js +412 -0
  64. package/dist/environment/setup-environment.d.ts +2 -0
  65. package/dist/environment/setup-environment.d.ts.map +1 -0
  66. package/dist/environment/setup-environment.js +794 -0
  67. package/dist/environment/ssh-keygen.d.ts +5 -0
  68. package/dist/environment/ssh-keygen.d.ts.map +1 -0
  69. package/dist/environment/ssh-keygen.js +21 -0
  70. package/dist/environment/swarm-to-k8s.d.ts +2 -0
  71. package/dist/environment/swarm-to-k8s.d.ts.map +1 -0
  72. package/dist/environment/swarm-to-k8s.js +173 -0
  73. package/dist/environment/templates.d.ts +27 -0
  74. package/dist/environment/templates.d.ts.map +1 -0
  75. package/dist/environment/templates.js +163 -0
  76. package/dist/environment/update-workflows.d.ts +2 -0
  77. package/dist/environment/update-workflows.d.ts.map +1 -0
  78. package/dist/environment/update-workflows.js +169 -0
  79. package/dist/environment/users.d.ts +2 -0
  80. package/dist/environment/users.d.ts.map +1 -0
  81. package/dist/environment/users.js +112 -0
  82. package/dist/environment/utils.d.ts +18 -0
  83. package/dist/environment/utils.d.ts.map +1 -0
  84. package/dist/environment/utils.js +100 -0
  85. package/dist/events/index.js +1115 -247
  86. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  87. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  88. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -1
  89. package/dist/migrations/v2.0/index.js +21 -8
  90. package/dist/notification/index.js +912 -144
  91. package/dist/scopes/index.d.ts +93 -7
  92. package/dist/scopes/index.js +20 -7
  93. package/dist/templates/charts-values/dependencies/values.override.yaml +4 -0
  94. package/dist/templates/charts-values/dependencies/values.yaml +83 -0
  95. package/dist/templates/charts-values/opencrvs-services/values.override.yaml +4 -0
  96. package/dist/templates/charts-values/opencrvs-services/values.yaml +81 -0
  97. package/dist/templates/charts-values/traefik/values.override.yaml +4 -0
  98. package/dist/templates/charts-values/traefik/values.yaml +115 -0
  99. package/dist/templates/inventory/inventory.template.yml +100 -0
  100. package/dist/templates/inventory/production.example.yml +77 -0
  101. package/dist/templates/inventory/qa.example.yml +48 -0
  102. package/opencrvs-toolkit-2.0.0-rc.b0c39c7.tgz +0 -0
  103. package/package.json +20 -2
  104. package/tsconfig.tsbuildinfo +1 -1
  105. package/opencrvs-toolkit-2.0.0-rc.b0a238f.tgz +0 -0
@@ -22,6 +22,7 @@ export * from './FieldValue';
22
22
  export * from './FormConfig';
23
23
  export * from './CompositeFieldValue';
24
24
  export * from './state';
25
+ export * from './state/flags';
25
26
  export * from './utils';
26
27
  export * from './defineConfig';
27
28
  export * from './DeduplicationConfig';
@@ -37,6 +38,7 @@ export * from './scopes';
37
38
  export * from './serializer';
38
39
  export * from './state/availableActions';
39
40
  export * from './FileUtils';
41
+ export * from './mocks.test.utils';
40
42
  export * from '../conditionals/conditionals';
41
43
  export * from '../conditionals/validate';
42
44
  export * from './field';
@@ -40,6 +40,7 @@ type ToArrayFields<T, K extends PropertyKey> = T extends unknown ? T extends obj
40
40
  */
41
41
  export type EventIndexWithAdministrativeHierarchy = Omit<ToArrayFields<EventIndex, 'createdAtLocation' | 'updatedAtLocation' | 'placeOfEvent'>, 'legalStatuses'> & {
42
42
  legalStatuses: {
43
+ NOTIFIED: ToArrayFields<ActionCreationMetadata, 'createdAtLocation'> | undefined;
43
44
  DECLARED: ToArrayFields<ActionCreationMetadata, 'createdAtLocation'> | undefined;
44
45
  REGISTERED: ToArrayFields<RegistrationCreationMetadata, 'createdAtLocation'> | undefined;
45
46
  };
@@ -1,6 +1,9 @@
1
+ import { Action, RequestedCorrectionAction } from '../ActionDocument';
1
2
  import { Flag, CustomFlag } from '../Flag';
2
3
  import { EventConfig } from '../EventConfig';
3
4
  import { EventDocument } from '../EventDocument';
5
+ export declare function findPendingCorrectionAction(writeActions: Action[]): RequestedCorrectionAction | undefined;
6
+ export declare function isPotentialDuplicate(actions: Action[]): boolean;
4
7
  /**
5
8
  * This function resolves custom flags for an event based on its actions.
6
9
  * Flags are not stored to the event state or any database directly, instead they are always computed/evaluated from the event actions.
@@ -18,5 +21,18 @@ import { EventDocument } from '../EventDocument';
18
21
  * // Returns: ['flag-1', 'flag-3']
19
22
  */
20
23
  export declare function resolveEventCustomFlags(event: EventDocument, eventConfiguration: EventConfig): CustomFlag[];
24
+ /**
25
+ * Computes all flags (inherent, action status, and custom) that should be attached to the given event,
26
+ * based on its actions and event-specific configuration.
27
+ *
28
+ * Flags are determined by combining:
29
+ * - Action status flags (format 'ActionType:ActionStatus')
30
+ * - Inherent flags (e.g. incomplete, rejected, correction requested, potential duplicate, edit in progress)
31
+ * - Event type-specific custom flags defined in the event configuration
32
+ *
33
+ * @param event - The EventDocument containing the action history and payload
34
+ * @param config - The EventConfig providing rules for custom flag evaluation
35
+ * @returns An array of flags currently relevant/applicable to the event
36
+ */
21
37
  export declare function getEventFlags(event: EventDocument, config: EventConfig): Flag[];
22
38
  //# sourceMappingURL=flags.d.ts.map
@@ -65,6 +65,14 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
65
65
  type: string;
66
66
  status: "CREATED" | "NOTIFIED" | "DECLARED" | "REGISTERED" | "ARCHIVED";
67
67
  legalStatuses: {
68
+ NOTIFIED?: {
69
+ createdAt: string;
70
+ createdBy: string;
71
+ acceptedAt: string;
72
+ createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
73
+ createdByUserType?: "user" | "system" | null | undefined;
74
+ createdByRole?: string | undefined;
75
+ } | null | undefined;
68
76
  DECLARED?: {
69
77
  createdAt: string;
70
78
  createdBy: string;
@@ -1,279 +1,17 @@
1
1
  import { Action } from '../ActionDocument';
2
2
  /**
3
- * Given action type and actions, returns the action creation metadata for the event.
4
- * Since we do not consistently store the request action, we need to check if it exists.
5
- * @returns details of last user who triggered **Declaration** action.
6
- * @see EventIndex for the description of the returned object.
3
+ * Returns the creation metadata of the last update action (Requested or Accepted).
4
+ * Requested actions are included so that async flows (202) correctly reflect the
5
+ * metadata of the user who triggered the action before country config accepts it.
7
6
  *
8
- * */
9
- export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
10
- id: string & import("zod").$brand<"UUID">;
11
- transactionId: string;
12
- createdByUserType: "user" | "system";
13
- createdAt: string;
14
- createdBy: string;
15
- declaration: Record<string, import("..").FieldUpdateValue>;
16
- status: "Requested" | "Accepted" | "Rejected";
17
- type: "REGISTER";
18
- createdByRole?: string | undefined;
19
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
20
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
21
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
22
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
23
- registrationNumber?: string | undefined;
24
- } | {
25
- id: string & import("zod").$brand<"UUID">;
26
- transactionId: string;
27
- createdByUserType: "user" | "system";
28
- createdAt: string;
29
- createdBy: string;
30
- declaration: Record<string, import("..").FieldUpdateValue>;
31
- status: "Requested" | "Accepted" | "Rejected";
32
- type: "DUPLICATE_DETECTED";
33
- content: {
34
- duplicates: {
35
- id: string & import("zod").$brand<"UUID">;
36
- trackingId: string;
37
- }[];
38
- };
39
- createdByRole?: string | undefined;
40
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
41
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
42
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
43
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
44
- } | {
45
- id: string & import("zod").$brand<"UUID">;
46
- transactionId: string;
47
- createdByUserType: "user" | "system";
48
- createdAt: string;
49
- createdBy: string;
50
- declaration: Record<string, import("..").FieldUpdateValue>;
51
- status: "Requested" | "Accepted" | "Rejected";
52
- type: "EDIT";
53
- content: {
54
- comment?: string | undefined;
55
- };
56
- createdByRole?: string | undefined;
57
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
58
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
59
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
60
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
61
- } | {
62
- id: string & import("zod").$brand<"UUID">;
63
- transactionId: string;
64
- createdByUserType: "user" | "system";
65
- createdAt: string;
66
- createdBy: string;
67
- declaration: Record<string, import("..").FieldUpdateValue>;
68
- status: "Requested" | "Accepted" | "Rejected";
69
- type: "PRINT_CERTIFICATE";
70
- createdByRole?: string | undefined;
71
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
72
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
73
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
74
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
75
- content?: {
76
- templateId?: string | undefined;
77
- } | null | undefined;
78
- } | {
79
- id: string & import("zod").$brand<"UUID">;
80
- transactionId: string;
81
- createdByUserType: "user" | "system";
82
- createdAt: string;
83
- createdBy: string;
84
- declaration: Record<string, import("..").FieldUpdateValue>;
85
- status: "Requested" | "Accepted" | "Rejected";
86
- type: "REQUEST_CORRECTION";
87
- createdByRole?: string | undefined;
88
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
89
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
90
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
91
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
92
- } | {
93
- id: string & import("zod").$brand<"UUID">;
94
- transactionId: string;
95
- createdByUserType: "user" | "system";
96
- createdAt: string;
97
- createdBy: string;
98
- declaration: Record<string, import("..").FieldUpdateValue>;
99
- status: "Requested" | "Accepted" | "Rejected";
100
- type: "CUSTOM";
101
- customActionType: string;
102
- createdByRole?: string | undefined;
103
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
104
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
105
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
106
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
107
- } | {
108
- id: string & import("zod").$brand<"UUID">;
109
- transactionId: string;
110
- createdByUserType: "user" | "system";
111
- createdAt: string;
112
- createdBy: string;
113
- declaration: Record<string, import("..").FieldUpdateValue>;
114
- status: "Requested" | "Accepted" | "Rejected";
115
- type: "CREATE";
116
- createdByRole?: string | undefined;
117
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
118
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
119
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
120
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
121
- } | {
122
- id: string & import("zod").$brand<"UUID">;
123
- transactionId: string;
124
- createdByUserType: "user" | "system";
125
- createdAt: string;
126
- createdBy: string;
127
- declaration: Record<string, import("..").FieldUpdateValue>;
128
- status: "Requested" | "Accepted" | "Rejected";
129
- type: "REJECT";
130
- content: {
131
- reason: string;
132
- };
133
- createdByRole?: string | undefined;
134
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
135
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
136
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
137
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
138
- } | {
139
- id: string & import("zod").$brand<"UUID">;
140
- transactionId: string;
141
- createdByUserType: "user" | "system";
142
- createdAt: string;
143
- createdBy: string;
144
- declaration: Record<string, import("..").FieldUpdateValue>;
145
- status: "Requested" | "Accepted" | "Rejected";
146
- type: "MARK_AS_NOT_DUPLICATE";
147
- createdByRole?: string | undefined;
148
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
149
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
150
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
151
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
152
- } | {
153
- id: string & import("zod").$brand<"UUID">;
154
- transactionId: string;
155
- createdByUserType: "user" | "system";
156
- createdAt: string;
157
- createdBy: string;
158
- declaration: Record<string, import("..").FieldUpdateValue>;
159
- status: "Requested" | "Accepted" | "Rejected";
160
- type: "MARK_AS_DUPLICATE";
161
- createdByRole?: string | undefined;
162
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
163
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
164
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
165
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
166
- content?: {
167
- duplicateOf: string & import("zod").$brand<"UUID">;
168
- } | undefined;
169
- } | {
170
- id: string & import("zod").$brand<"UUID">;
171
- transactionId: string;
172
- createdByUserType: "user" | "system";
173
- createdAt: string;
174
- createdBy: string;
175
- declaration: Record<string, import("..").FieldUpdateValue>;
176
- status: "Requested" | "Accepted" | "Rejected";
177
- type: "ARCHIVE";
178
- content: {
179
- reason: string;
180
- };
181
- createdByRole?: string | undefined;
182
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
183
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
184
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
185
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
186
- } | {
187
- id: string & import("zod").$brand<"UUID">;
188
- transactionId: string;
189
- createdByUserType: "user" | "system";
190
- createdAt: string;
191
- createdBy: string;
192
- declaration: Record<string, import("..").FieldUpdateValue>;
193
- status: "Requested" | "Accepted" | "Rejected";
194
- type: "NOTIFY";
195
- createdByRole?: string | undefined;
196
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
197
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
198
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
199
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
200
- } | {
201
- id: string & import("zod").$brand<"UUID">;
202
- transactionId: string;
203
- createdByUserType: "user" | "system";
204
- createdAt: string;
205
- createdBy: string;
206
- declaration: Record<string, import("..").FieldUpdateValue>;
207
- status: "Requested" | "Accepted" | "Rejected";
208
- type: "DECLARE";
209
- createdByRole?: string | undefined;
210
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
211
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
212
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
213
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
214
- } | {
215
- id: string & import("zod").$brand<"UUID">;
216
- transactionId: string;
217
- createdByUserType: "user" | "system";
218
- createdAt: string;
219
- createdBy: string;
220
- declaration: Record<string, import("..").FieldUpdateValue>;
221
- status: "Requested" | "Accepted" | "Rejected";
222
- type: "ASSIGN";
223
- assignedTo: string;
224
- createdByRole?: string | undefined;
225
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
226
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
227
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
228
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
229
- } | {
230
- id: string & import("zod").$brand<"UUID">;
231
- transactionId: string;
232
- createdByUserType: "user" | "system";
233
- createdAt: string;
234
- createdBy: string;
235
- declaration: Record<string, import("..").FieldUpdateValue>;
236
- status: "Requested" | "Accepted" | "Rejected";
237
- type: "APPROVE_CORRECTION";
238
- requestId: string;
239
- createdByRole?: string | undefined;
240
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
241
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
242
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
243
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
244
- } | {
245
- id: string & import("zod").$brand<"UUID">;
246
- transactionId: string;
247
- createdByUserType: "user" | "system";
248
- createdAt: string;
249
- createdBy: string;
250
- declaration: Record<string, import("..").FieldUpdateValue>;
251
- status: "Requested" | "Accepted" | "Rejected";
252
- type: "REJECT_CORRECTION";
253
- requestId: string;
254
- content: {
255
- reason: string;
256
- };
257
- createdByRole?: string | undefined;
258
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
259
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
260
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
261
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
262
- } | {
263
- id: string & import("zod").$brand<"UUID">;
264
- transactionId: string;
265
- createdByUserType: "user" | "system";
266
- createdAt: string;
267
- createdBy: string;
268
- declaration: Record<string, import("..").FieldUpdateValue>;
269
- status: "Requested" | "Accepted" | "Rejected";
270
- type: "UNASSIGN";
271
- createdByRole?: string | undefined;
272
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
273
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
274
- annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
275
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
276
- } | {
7
+ * When an Accepted action carries an originalActionId, its metadata is sourced from
8
+ * the original Requested action (the human who triggered it), not from the system
9
+ * or 3rd party that accepted it.
10
+ *
11
+ * @returns metadata of the last user who triggered a status-changing action.
12
+ * @see EventIndex for the description of the returned object.
13
+ */
14
+ export declare function getActionUpdateMetadata(actions: Action[]): Pick<{
277
15
  id: string & import("zod").$brand<"UUID">;
278
16
  transactionId: string;
279
17
  createdByUserType: "user" | "system";
@@ -281,30 +19,26 @@ export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
281
19
  createdBy: string;
282
20
  declaration: Record<string, import("..").FieldUpdateValue>;
283
21
  status: "Requested" | "Accepted" | "Rejected";
284
- type: "READ";
285
22
  createdByRole?: string | undefined;
286
23
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
287
24
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
288
25
  annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
289
26
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
290
- } | {
291
- id: string & import("zod").$brand<"UUID">;
292
- transactionId: string;
293
- createdByUserType: "user" | "system";
294
- createdAt: string;
295
- createdBy: string;
296
- type: "CUSTOM" | "NOTIFY" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION";
297
- status: "Rejected";
298
- createdByRole?: string | undefined;
299
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
300
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
301
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
302
- }>;
27
+ }, "createdByUserType" | "createdAt" | "createdBy" | "createdByRole" | "createdAtLocation">;
303
28
  /**
304
29
  * @returns the legal statuses of the event. Event is considered legal if it has been accepted.
305
30
  * @see EventIndex for the description of the returned object.
306
31
  */
307
32
  export declare function getLegalStatuses(actions: Action[]): {
33
+ NOTIFIED: {
34
+ createdAt: string;
35
+ createdBy: string;
36
+ createdByUserType: "user" | "system";
37
+ createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
38
+ acceptedAt: string;
39
+ createdByRole: string | undefined;
40
+ registrationNumber: string | null | undefined;
41
+ } | null;
308
42
  DECLARED: {
309
43
  createdAt: string;
310
44
  createdBy: string;
@@ -50,6 +50,14 @@ export declare function getActionConfig({ eventConfiguration, actionType, custom
50
50
  customActionType?: string;
51
51
  }): ActionConfig | undefined;
52
52
  export declare function getCustomActionFields(eventConfiguration: EventConfig, customActionType: string): FieldConfig[];
53
+ /**
54
+ * Returns the fields configured for an action's confirmation dialog.
55
+ *
56
+ * Unlike review fields and supporting copy, NOTIFY does NOT fall back to the
57
+ * DECLARE config here: dialog fields always come from the action's own
58
+ * configuration entry.
59
+ */
60
+ export declare function getActionFormFields(eventConfiguration: EventConfig, actionType: ActionType, customActionType?: string): FieldConfig[];
53
61
  export declare function getPrintCertificatePages(configuration: EventConfig): ({
54
62
  id: string;
55
63
  title: {
@@ -386,6 +394,9 @@ export declare function findLastAssignmentAction(actions: Action[]): {
386
394
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
387
395
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
388
396
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
397
+ content?: {
398
+ immediateCorrection?: boolean | undefined;
399
+ } | undefined;
389
400
  } | {
390
401
  id: string & import("zod").$brand<"UUID">;
391
402
  transactionId: string;
@@ -559,7 +570,15 @@ export declare function timePeriodToDateRange(value: SelectDateRangeValue): {
559
570
  };
560
571
  export declare function mergeDrafts(currentDraft: Draft, incomingDraft: Draft): Draft;
561
572
  export declare function getPendingAction(actions: Action[]): ActionDocument;
562
- export declare function getCompleteActionAnnotation(annotation: ActionUpdate, event: EventDocument, action: ActionDocument): ActionUpdate;
573
+ export declare function getCompleteActionAnnotation(event: EventDocument, action: ActionDocument): ActionUpdate;
574
+ /**
575
+ * Resolves the complete content for an action, inheriting from its original
576
+ * Requested action when the Accepted action carries no content of its own.
577
+ *
578
+ * Mirrors the same "originalActionId → merge from Requested" pattern used by
579
+ * getCompleteActionAnnotation and getCompleteActionDeclaration.
580
+ */
581
+ export declare function getCompleteActionContent(event: EventDocument, action: ActionDocument): Record<string, unknown> | null | undefined;
563
582
  export declare function getCompleteActionDeclaration<T extends EventState | ActionUpdate>(declaration: T, event: EventDocument, action: ActionDocument): T;
564
583
  export declare function getAcceptedActions(event: EventDocument): ActionDocument[];
565
584
  export declare function aggregateActionDeclarations(event: EventDocument): EventState;
@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
30
30
  // src/conditionals/index.ts
31
31
  var conditionals_exports = {};
32
32
  __export(conditionals_exports, {
33
+ always: () => always,
33
34
  alwaysTrue: () => alwaysTrue,
34
35
  and: () => and,
35
36
  createFieldConditionals: () => createFieldConditionals,
@@ -190,11 +191,13 @@ var scopeOptionsPlaceEvent = z6.object({
190
191
  event: scopeByEvent,
191
192
  placeOfEvent: JurisdictionFilter.optional()
192
193
  }).describe("Options applicable to all record scopes.");
193
- var scopeOptionsDeclared = scopeOptionsPlaceEvent.extend({
194
+ var scopeOptionsDeclaredOrNotified = scopeOptionsPlaceEvent.extend({
195
+ notifiedIn: JurisdictionFilter.optional(),
196
+ notifiedBy: UserFilter.optional(),
194
197
  declaredIn: JurisdictionFilter.optional(),
195
198
  declaredBy: UserFilter.optional()
196
199
  }).describe("Options applicable to actions that may take place after DECLARE");
197
- var AllRecordScopeOptions = scopeOptionsDeclared.extend({
200
+ var AllRecordScopeOptions = scopeOptionsDeclaredOrNotified.extend({
198
201
  registeredIn: JurisdictionFilter.optional(),
199
202
  registeredBy: UserFilter.optional()
200
203
  }).describe(
@@ -232,6 +235,8 @@ var ResolvedScopeOptionsPlaceEvent = z6.object({
232
235
  "Resolved options applicable to all record scopes, with location ID instead of jurisdiction filter."
233
236
  );
234
237
  var ResolvedScopeOptionsDeclared = ResolvedScopeOptionsPlaceEvent.extend({
238
+ notifiedIn: UUID.nullish(),
239
+ notifiedBy: z6.string().optional(),
235
240
  declaredIn: UUID.nullish(),
236
241
  declaredBy: z6.string().optional()
237
242
  }).describe(
@@ -277,7 +282,7 @@ var RecordScopeV2 = z6.discriminatedUnion("type", [
277
282
  }),
278
283
  z6.object({
279
284
  type: ScopesWithDeclaredOptions,
280
- options: scopeOptionsDeclared.optional()
285
+ options: scopeOptionsDeclaredOrNotified.optional()
281
286
  }),
282
287
  z6.object({
283
288
  type: ScopesWithFullOptions,
@@ -365,7 +370,10 @@ var ScopeType2 = z6.enum([
365
370
  var EncodedScope2 = z6.string().brand("EncodedScope");
366
371
  var DEFAULT_SCOPE_OPTIONS = {
367
372
  placeOfEvent: JurisdictionFilter.enum.all,
368
- accessLevel: JurisdictionFilter.enum.all
373
+ accessLevel: JurisdictionFilter.enum.all,
374
+ notifiedIn: JurisdictionFilter.enum.all,
375
+ declaredIn: JurisdictionFilter.enum.all,
376
+ registeredIn: JurisdictionFilter.enum.all
369
377
  };
370
378
 
371
379
  // ../commons/src/users/userReferences.ts
@@ -452,6 +460,9 @@ function not(condition) {
452
460
  function never() {
453
461
  return not(alwaysTrue());
454
462
  }
463
+ function always() {
464
+ return defineConditional(alwaysTrue());
465
+ }
455
466
  function jsonFieldPath(field) {
456
467
  return [field.$$field, ...field.$$subfield].join("/");
457
468
  }
@@ -999,7 +1010,54 @@ function createFieldConditionals(fieldId) {
999
1010
  }
1000
1011
  },
1001
1012
  required: [fieldId]
1002
- })
1013
+ }),
1014
+ /**
1015
+ * Custom client-side validator. The provided function is serialised and executed
1016
+ * just-in-time on the client only. External references (e.g. lodash) are not
1017
+ * available inside the function body — all logic must be self-contained.
1018
+ *
1019
+ * @example
1020
+ * field('nid').customClientValidator((value) => {
1021
+ * // LUHN check — all logic must be inline
1022
+ * const digits = String(value).split('').map(Number)
1023
+ * // ...
1024
+ * return isValid
1025
+ * })
1026
+ */
1027
+ customClientValidator(validationFn) {
1028
+ const code = validationFn.toString();
1029
+ return defineFormConditional({
1030
+ type: "object",
1031
+ properties: wrapToPath(
1032
+ { [fieldId]: { customClientValidator: { code } } },
1033
+ this.$$subfield
1034
+ ),
1035
+ required: [fieldId]
1036
+ });
1037
+ },
1038
+ /**
1039
+ * Custom client-side evaluation. Returns a {@link FieldReference} descriptor
1040
+ * that can be used as the `value` property or a DATA component entry.
1041
+ * The function receives the referenced field's value as the first argument and
1042
+ * the full form context as the second; its return value replaces the field reference.
1043
+ * The function is serialised and executed just-in-time on the client only.
1044
+ * External references (e.g. lodash) are not available inside the function body.
1045
+ *
1046
+ * For computing a default value without referencing a specific field, use
1047
+ * `evaluate(fn)` in the `defaultValue` property instead.
1048
+ *
1049
+ * @example
1050
+ * field('a').customClientEvaluation((aValue, ctx) =>
1051
+ * Number(aValue) + Number(ctx.$form.b)
1052
+ * )
1053
+ */
1054
+ customClientEvaluation(computationFn) {
1055
+ return {
1056
+ $$code: computationFn.toString(),
1057
+ $$field: fieldId,
1058
+ $$subfield: this.$$subfield
1059
+ };
1060
+ }
1003
1061
  };
1004
1062
  }
1005
1063
 
@@ -0,0 +1,33 @@
1
+ import { PromptObject } from 'prompts';
2
+ import { Secret, Variable } from './github';
3
+ export type Question<T extends string> = PromptObject<T> & {
4
+ name: T;
5
+ valueType?: 'SECRET' | 'VARIABLE';
6
+ scope: 'ENVIRONMENT' | 'REPOSITORY';
7
+ valueLabel?: string;
8
+ };
9
+ export type QuestionDescriptor<T extends string> = Omit<Question<T>, 'type'> & {
10
+ type: 'disabled' | PromptObject<T>['type'];
11
+ };
12
+ export type SecretAnswer = {
13
+ type: 'SECRET';
14
+ scope: 'ENVIRONMENT' | 'REPOSITORY';
15
+ name: string;
16
+ value: string;
17
+ didExist: Secret | undefined;
18
+ };
19
+ export type VariableAnswer = {
20
+ type: 'VARIABLE';
21
+ name: string;
22
+ didExist: Variable | undefined;
23
+ value: string;
24
+ scope: 'ENVIRONMENT' | 'REPOSITORY';
25
+ };
26
+ export type Answer = SecretAnswer | VariableAnswer;
27
+ export type Answers = Answer[];
28
+ export type AnswerWithNullValue = (Omit<SecretAnswer, 'value'> & {
29
+ value: SecretAnswer['value'] | null;
30
+ }) | (Omit<VariableAnswer, 'value'> & {
31
+ value: VariableAnswer['value'] | null;
32
+ });
33
+ //# sourceMappingURL=custom-types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"custom-types.d.ts","sourceRoot":"","sources":["../../src/environment/custom-types.ts"],"names":[],"mappings":"AAWA,OAAgB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAE3C,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG;IACzD,IAAI,EAAE,CAAC,CAAA;IACP,SAAS,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAA;IACjC,KAAK,EAAE,aAAa,GAAG,YAAY,CAAA;IACnC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG;IAC7E,IAAI,EAAE,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,QAAQ,CAAA;IACd,KAAK,EAAE,aAAa,GAAG,YAAY,CAAA;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,UAAU,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,aAAa,GAAG,YAAY,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,YAAY,GAAG,cAAc,CAAA;AAClD,MAAM,MAAM,OAAO,GAAG,MAAM,EAAE,CAAA;AAC9B,MAAM,MAAM,mBAAmB,GAC3B,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG;IAC7B,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;CACpC,CAAC,GACF,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,GAAG;IAC/B,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;CACtC,CAAC,CAAA"}
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ /*
3
+ * This Source Code Form is subject to the terms of the Mozilla Public
4
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
5
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
6
+ *
7
+ * OpenCRVS is also distributed under the terms of the Civil Registration
8
+ * & Healthcare Disclaimer located at http://opencrvs.org/license.
9
+ *
10
+ * Copyright (C) The OpenCRVS Authors located at https://github.com/opencrvs/opencrvs-core/blob/master/AUTHORS.
11
+ */
12
+ Object.defineProperty(exports, "__esModule", { value: true });