@opencrvs/toolkit 2.0.0-rc.ca280e0 → 2.0.0-rc.ca3fe84

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/README.md +15 -0
  2. package/build.sh +3 -2
  3. package/dist/application-config/index.js +70 -40
  4. package/dist/cli.js +3262 -50
  5. package/dist/commons/api/router.d.ts +3012 -2927
  6. package/dist/commons/application-config/index.d.ts +7 -6
  7. package/dist/commons/conditionals/conditionals.d.ts +287 -234
  8. package/dist/commons/conditionals/validate.d.ts +51 -2
  9. package/dist/commons/events/ActionConfig.d.ts +93 -67
  10. package/dist/commons/events/ActionDocument.d.ts +113 -107
  11. package/dist/commons/events/ActionInput.d.ts +6 -0
  12. package/dist/commons/events/ActionType.d.ts +57 -57
  13. package/dist/commons/events/AdvancedSearchConfig.d.ts +651 -297
  14. package/dist/commons/events/AuditLog.d.ts +41 -41
  15. package/dist/commons/events/CompositeFieldValue.d.ts +4 -4
  16. package/dist/commons/events/Conditional.d.ts +3 -3
  17. package/dist/commons/events/CountryConfigQueryInput.d.ts +603 -561
  18. package/dist/commons/events/Draft.d.ts +35 -35
  19. package/dist/commons/events/DynamicFieldValue.d.ts +9 -9
  20. package/dist/commons/events/EventConfig.d.ts +5 -3
  21. package/dist/commons/events/EventDocument.d.ts +46 -43
  22. package/dist/commons/events/EventIndex.d.ts +76 -51
  23. package/dist/commons/events/EventMetadata.d.ts +60 -34
  24. package/dist/commons/events/FieldConfig.d.ts +710 -372
  25. package/dist/commons/events/FieldType.d.ts +51 -50
  26. package/dist/commons/events/FieldTypeMapping.d.ts +101 -101
  27. package/dist/commons/events/FieldValue.d.ts +18 -12
  28. package/dist/commons/events/Flag.d.ts +15 -15
  29. package/dist/commons/events/TemplateConfig.d.ts +1 -1
  30. package/dist/commons/events/WorkqueueColumnConfig.d.ts +40 -40
  31. package/dist/commons/events/WorkqueueConfig.d.ts +837 -798
  32. package/dist/commons/events/deduplication.d.ts +1 -1
  33. package/dist/commons/events/event.d.ts +2 -2
  34. package/dist/commons/events/field.d.ts +112 -189
  35. package/dist/commons/events/index.d.ts +1 -0
  36. package/dist/commons/events/locations.d.ts +5 -4
  37. package/dist/commons/events/mocks.test.utils.d.ts +2 -2
  38. package/dist/commons/events/scopes.d.ts +4 -4
  39. package/dist/commons/events/state/flags.d.ts +16 -0
  40. package/dist/commons/events/state/index.d.ts +23 -15
  41. package/dist/commons/events/state/utils.d.ts +25 -291
  42. package/dist/commons/events/test.utils.d.ts +33 -33
  43. package/dist/commons/events/utils.d.ts +120 -109
  44. package/dist/commons/notification/UserNotifications.d.ts +10 -10
  45. package/dist/conditionals/index.js +58 -6
  46. package/dist/environment/custom-types.d.ts +33 -0
  47. package/dist/environment/custom-types.d.ts.map +1 -0
  48. package/dist/environment/custom-types.js +12 -0
  49. package/dist/environment/derived-variables.d.ts +134 -0
  50. package/dist/environment/derived-variables.d.ts.map +1 -0
  51. package/dist/environment/derived-variables.js +169 -0
  52. package/dist/environment/editor-questions.d.ts +4 -0
  53. package/dist/environment/editor-questions.d.ts.map +1 -0
  54. package/dist/environment/editor-questions.js +67 -0
  55. package/dist/environment/git.d.ts +5 -0
  56. package/dist/environment/git.d.ts.map +1 -0
  57. package/dist/environment/git.js +38 -0
  58. package/dist/environment/github.d.ts +26 -0
  59. package/dist/environment/github.d.ts.map +1 -0
  60. package/dist/environment/github.js +247 -0
  61. package/dist/environment/index.d.ts +5 -0
  62. package/dist/environment/index.d.ts.map +1 -0
  63. package/dist/environment/index.js +71 -0
  64. package/dist/environment/logger.d.ts +6 -0
  65. package/dist/environment/logger.d.ts.map +1 -0
  66. package/dist/environment/logger.js +25 -0
  67. package/dist/environment/manage-users.d.ts +11 -0
  68. package/dist/environment/manage-users.d.ts.map +1 -0
  69. package/dist/environment/manage-users.js +507 -0
  70. package/dist/environment/questions-helper.d.ts +15 -0
  71. package/dist/environment/questions-helper.d.ts.map +1 -0
  72. package/dist/environment/questions-helper.js +70 -0
  73. package/dist/environment/questions.d.ts +200 -0
  74. package/dist/environment/questions.d.ts.map +1 -0
  75. package/dist/environment/questions.js +412 -0
  76. package/dist/environment/setup-environment.d.ts +2 -0
  77. package/dist/environment/setup-environment.d.ts.map +1 -0
  78. package/dist/environment/setup-environment.js +788 -0
  79. package/dist/environment/ssh-keygen.d.ts +5 -0
  80. package/dist/environment/ssh-keygen.d.ts.map +1 -0
  81. package/dist/environment/ssh-keygen.js +21 -0
  82. package/dist/environment/swarm-to-k8s.d.ts +2 -0
  83. package/dist/environment/swarm-to-k8s.d.ts.map +1 -0
  84. package/dist/environment/swarm-to-k8s.js +183 -0
  85. package/dist/environment/templates.d.ts +27 -0
  86. package/dist/environment/templates.d.ts.map +1 -0
  87. package/dist/environment/templates.js +163 -0
  88. package/dist/environment/update-workflows.d.ts +2 -0
  89. package/dist/environment/update-workflows.d.ts.map +1 -0
  90. package/dist/environment/update-workflows.js +179 -0
  91. package/dist/environment/users.d.ts +2 -0
  92. package/dist/environment/users.d.ts.map +1 -0
  93. package/dist/environment/users.js +122 -0
  94. package/dist/environment/utils.d.ts +18 -0
  95. package/dist/environment/utils.d.ts.map +1 -0
  96. package/dist/environment/utils.js +110 -0
  97. package/dist/events/deduplication.d.ts +1 -1
  98. package/dist/events/index.js +446 -147
  99. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  100. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  101. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -1
  102. package/dist/migrations/v2.0/convert-config-files-to-ts.js +17 -7
  103. package/dist/migrations/v2.0/index.js +20 -9
  104. package/dist/migrations/v2.0/migrate-application-config-url.js +4 -3
  105. package/dist/migrations/v2.0/remove-hearth-migrations.js +17 -7
  106. package/dist/notification/index.js +265 -45
  107. package/dist/scopes/index.d.ts +209 -123
  108. package/dist/scopes/index.js +19 -8
  109. package/dist/templates/charts-values/dependencies/values.override.yaml +4 -0
  110. package/dist/templates/charts-values/dependencies/values.yaml +83 -0
  111. package/dist/templates/charts-values/opencrvs-services/values.override.yaml +4 -0
  112. package/dist/templates/charts-values/opencrvs-services/values.yaml +81 -0
  113. package/dist/templates/charts-values/traefik/values.override.yaml +4 -0
  114. package/dist/templates/charts-values/traefik/values.yaml +115 -0
  115. package/dist/templates/inventory/inventory.template.yml +100 -0
  116. package/dist/templates/inventory/production.example.yml +77 -0
  117. package/dist/templates/inventory/qa.example.yml +48 -0
  118. package/opencrvs-toolkit-2.0.0-rc.ca3fe84.tgz +0 -0
  119. package/package.json +16 -3
  120. package/tsconfig.tsbuildinfo +1 -1
  121. package/opencrvs-toolkit-2.0.0-rc.ca280e0.tgz +0 -0
@@ -59,8 +59,8 @@ export declare function field(fieldId: string): {
59
59
  fieldId: string;
60
60
  type: "dateRange";
61
61
  options: {
62
- days: number;
63
62
  pivot?: number | undefined;
63
+ days: number;
64
64
  boost?: number | undefined;
65
65
  matchAgainst?: string | undefined;
66
66
  };
@@ -20,6 +20,8 @@ declare const event: typeof eventFn & {
20
20
  * @param action - The action type to check for.
21
21
  */
22
22
  hasAction: (action: ActionType) => {
23
+ $id: string;
24
+ __nominal__type: 'JSONSchema';
23
25
  /**
24
26
  * Creates a conditional that checks if the event contains a specific action type
25
27
  * with a minimum count of occurrences.
@@ -71,8 +73,6 @@ declare const event: typeof eventFn & {
71
73
  */
72
74
  maxCount: (maxCount: number) => import("../conditionals/conditionals").JSONSchema;
73
75
  };
74
- $id: string;
75
- __nominal__type: "JSONSchema";
76
76
  };
77
77
  field(field: WorkqueueColumnKeys): WorkqueueColumnValue;
78
78
  };
@@ -1,6 +1,31 @@
1
+ import { FormConditionalParameters } from '../conditionals/conditionals';
1
2
  import { FieldConditional } from './Conditional';
2
3
  import { TranslationConfig } from './TranslationConfig';
3
- import { SelectOption, ValidationConfig } from './FieldConfig';
4
+ import { JurisdictionReference } from '../users/userReferences';
5
+ import { ComputedDefaultValue, SelectOption, ValidationConfig } from './FieldConfig';
6
+ /**
7
+ * Creates a {@link ComputedDefaultValue} descriptor for use in a field's `defaultValue`.
8
+ *
9
+ * Unlike `field(id).customClientEvaluation(fn)`, this builder is **not tied to any
10
+ * specific field**. Use it when the initial value should be derived purely from
11
+ * context variables (`$now`, `$online`, system variables such as `$user`) rather
12
+ * than from another field's current value.
13
+ *
14
+ * The serialised function receives `(undefined, context)` at runtime, where
15
+ * `context` is a {@link FormConditionalParameters} object.
16
+ *
17
+ * External references (e.g. lodash) are **not** available inside the function body —
18
+ * all logic must be self-contained so the code survives serialisation.
19
+ *
20
+ * @example
21
+ * // Default a date field to today
22
+ * defaultValue: evaluate((_, ctx) => ctx.$now)
23
+ *
24
+ * @example
25
+ * // Default to the current user's role
26
+ * defaultValue: evaluate((_, ctx) => ctx.user.role)
27
+ */
28
+ export declare function evaluate(computationFn: (fieldValue: undefined, context: FormConditionalParameters) => unknown): ComputedDefaultValue;
4
29
  /**
5
30
  * Entry point for defining conditional logic or configuration for a form field.
6
31
  * @param fieldId - The ID of the field to define rules or config for.
@@ -11,68 +36,21 @@ export declare function field(fieldId: string, options?: {
11
36
  conditionals?: FieldConditional[];
12
37
  validations?: ValidationConfig[];
13
38
  searchCriteriaLabelPrefix?: TranslationConfig;
39
+ allowedLocations?: JurisdictionReference;
14
40
  }): {
15
- range: () => {
16
- options?: SelectOption[];
17
- conditionals?: FieldConditional[];
18
- validations?: ValidationConfig[];
19
- searchCriteriaLabelPrefix?: TranslationConfig;
20
- fieldId: string;
21
- fieldType: "field";
22
- } & {
23
- config: {
24
- type: "range";
25
- };
26
- };
27
- exact: () => {
28
- options?: SelectOption[];
29
- conditionals?: FieldConditional[];
30
- validations?: ValidationConfig[];
31
- searchCriteriaLabelPrefix?: TranslationConfig;
32
- fieldId: string;
33
- fieldType: "field";
34
- } & {
35
- config: {
36
- type: "exact";
37
- };
38
- };
39
- fuzzy: () => {
40
- options?: SelectOption[];
41
- conditionals?: FieldConditional[];
42
- validations?: ValidationConfig[];
43
- searchCriteriaLabelPrefix?: TranslationConfig;
44
- fieldId: string;
45
- fieldType: "field";
46
- } & {
47
- config: {
48
- type: "fuzzy";
49
- };
50
- };
51
- within: () => {
52
- options?: SelectOption[];
53
- conditionals?: FieldConditional[];
54
- validations?: ValidationConfig[];
55
- searchCriteriaLabelPrefix?: TranslationConfig;
56
- fieldId: string;
57
- fieldType: "field";
58
- } & {
59
- config: {
60
- type: "within";
61
- };
62
- };
63
41
  $$field: string;
64
42
  $$subfield: string[];
65
43
  get(fieldPath: string): {
66
- $$subfield: string[];
67
44
  $$field: string;
68
- get(fieldPath: string): any;
45
+ get(fieldPath: string): /*elided*/ any;
46
+ $$subfield: string[];
69
47
  getByPath(fieldPath: string[]): {
70
- $$subfield: string[];
71
48
  $$field: string;
72
- get(fieldPath: string): any;
73
- getByPath(fieldPath: string[]): any;
74
- asDob(): any;
75
- asAge(): any;
49
+ get(fieldPath: string): /*elided*/ any;
50
+ getByPath(fieldPath: string[]): /*elided*/ any;
51
+ $$subfield: string[];
52
+ asDob(): /*elided*/ any;
53
+ asAge(): /*elided*/ any;
76
54
  isAfter(): {
77
55
  days: (days: number) => {
78
56
  inPast: () => import("../conditionals/conditionals").JSONSchema;
@@ -107,9 +85,11 @@ export declare function field(fieldId: string, options?: {
107
85
  fieldId: string;
108
86
  };
109
87
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
88
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
89
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
110
90
  };
111
- asDob(): any;
112
- asAge(): any;
91
+ asDob(): /*elided*/ any;
92
+ asAge(): /*elided*/ any;
113
93
  isAfter(): {
114
94
  days: (days: number) => {
115
95
  inPast: () => import("../conditionals/conditionals").JSONSchema;
@@ -144,137 +124,16 @@ export declare function field(fieldId: string, options?: {
144
124
  fieldId: string;
145
125
  };
146
126
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
127
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
128
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
147
129
  };
148
130
  getByPath(fieldPath: string[]): {
149
- $$subfield: string[];
150
131
  $$field: string;
151
- get(fieldPath: string): {
152
- $$subfield: string[];
153
- $$field: string;
154
- get(fieldPath: string): any;
155
- getByPath(fieldPath: string[]): any;
156
- asDob(): any;
157
- asAge(): any;
158
- isAfter(): {
159
- days: (days: number) => {
160
- inPast: () => import("../conditionals/conditionals").JSONSchema;
161
- inFuture: () => import("../conditionals/conditionals").JSONSchema;
162
- fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
163
- fromNow: () => import("../conditionals/conditionals").JSONSchema;
164
- };
165
- date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
166
- now: () => import("../conditionals/conditionals").JSONSchema;
167
- };
168
- isBefore(): {
169
- days: (days: number) => {
170
- inPast: () => import("../conditionals/conditionals").JSONSchema;
171
- inFuture: () => import("../conditionals/conditionals").JSONSchema;
172
- fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
173
- fromNow: () => import("../conditionals/conditionals").JSONSchema;
174
- };
175
- date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
176
- now: () => import("../conditionals/conditionals").JSONSchema;
177
- };
178
- isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
179
- isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
180
- isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
181
- isFalsy(): import("../conditionals/conditionals").JSONSchema;
182
- isUndefined(): import("../conditionals/conditionals").JSONSchema;
183
- inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
184
- isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
185
- isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
186
- matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
187
- isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
188
- getId: () => {
189
- fieldId: string;
190
- };
191
- object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
192
- };
132
+ get(fieldPath: string): any;
193
133
  getByPath(fieldPath: string[]): any;
194
- asDob(): {
195
- $$subfield: string[];
196
- $$field: string;
197
- get(fieldPath: string): any;
198
- getByPath(fieldPath: string[]): any;
199
- asDob(): any;
200
- asAge(): any;
201
- isAfter(): {
202
- days: (days: number) => {
203
- inPast: () => import("../conditionals/conditionals").JSONSchema;
204
- inFuture: () => import("../conditionals/conditionals").JSONSchema;
205
- fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
206
- fromNow: () => import("../conditionals/conditionals").JSONSchema;
207
- };
208
- date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
209
- now: () => import("../conditionals/conditionals").JSONSchema;
210
- };
211
- isBefore(): {
212
- days: (days: number) => {
213
- inPast: () => import("../conditionals/conditionals").JSONSchema;
214
- inFuture: () => import("../conditionals/conditionals").JSONSchema;
215
- fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
216
- fromNow: () => import("../conditionals/conditionals").JSONSchema;
217
- };
218
- date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
219
- now: () => import("../conditionals/conditionals").JSONSchema;
220
- };
221
- isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
222
- isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
223
- isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
224
- isFalsy(): import("../conditionals/conditionals").JSONSchema;
225
- isUndefined(): import("../conditionals/conditionals").JSONSchema;
226
- inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
227
- isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
228
- isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
229
- matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
230
- isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
231
- getId: () => {
232
- fieldId: string;
233
- };
234
- object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
235
- };
236
- asAge(): {
237
- $$subfield: string[];
238
- $$field: string;
239
- get(fieldPath: string): any;
240
- getByPath(fieldPath: string[]): any;
241
- asDob(): any;
242
- asAge(): any;
243
- isAfter(): {
244
- days: (days: number) => {
245
- inPast: () => import("../conditionals/conditionals").JSONSchema;
246
- inFuture: () => import("../conditionals/conditionals").JSONSchema;
247
- fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
248
- fromNow: () => import("../conditionals/conditionals").JSONSchema;
249
- };
250
- date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
251
- now: () => import("../conditionals/conditionals").JSONSchema;
252
- };
253
- isBefore(): {
254
- days: (days: number) => {
255
- inPast: () => import("../conditionals/conditionals").JSONSchema;
256
- inFuture: () => import("../conditionals/conditionals").JSONSchema;
257
- fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
258
- fromNow: () => import("../conditionals/conditionals").JSONSchema;
259
- };
260
- date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
261
- now: () => import("../conditionals/conditionals").JSONSchema;
262
- };
263
- isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
264
- isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
265
- isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
266
- isFalsy(): import("../conditionals/conditionals").JSONSchema;
267
- isUndefined(): import("../conditionals/conditionals").JSONSchema;
268
- inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
269
- isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
270
- isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
271
- matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
272
- isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
273
- getId: () => {
274
- fieldId: string;
275
- };
276
- object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
277
- };
134
+ $$subfield: string[];
135
+ asDob(): any;
136
+ asAge(): any;
278
137
  isAfter(): {
279
138
  days: (days: number) => {
280
139
  inPast: () => import("../conditionals/conditionals").JSONSchema;
@@ -309,16 +168,18 @@ export declare function field(fieldId: string, options?: {
309
168
  fieldId: string;
310
169
  };
311
170
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
171
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
172
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
312
173
  };
313
174
  asDob(): {
314
- $$subfield: string[];
315
175
  $$field: string;
316
176
  get(fieldPath: string): any;
177
+ $$subfield: string[];
317
178
  getByPath(fieldPath: string[]): {
318
- $$subfield: string[];
319
179
  $$field: string;
320
180
  get(fieldPath: string): any;
321
181
  getByPath(fieldPath: string[]): any;
182
+ $$subfield: string[];
322
183
  asDob(): any;
323
184
  asAge(): any;
324
185
  isAfter(): {
@@ -355,6 +216,8 @@ export declare function field(fieldId: string, options?: {
355
216
  fieldId: string;
356
217
  };
357
218
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
219
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
220
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
358
221
  };
359
222
  asDob(): any;
360
223
  asAge(): any;
@@ -392,16 +255,18 @@ export declare function field(fieldId: string, options?: {
392
255
  fieldId: string;
393
256
  };
394
257
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
258
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
259
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
395
260
  };
396
261
  asAge(): {
397
- $$subfield: string[];
398
262
  $$field: string;
399
263
  get(fieldPath: string): any;
264
+ $$subfield: string[];
400
265
  getByPath(fieldPath: string[]): {
401
- $$subfield: string[];
402
266
  $$field: string;
403
267
  get(fieldPath: string): any;
404
268
  getByPath(fieldPath: string[]): any;
269
+ $$subfield: string[];
405
270
  asDob(): any;
406
271
  asAge(): any;
407
272
  isAfter(): {
@@ -438,6 +303,8 @@ export declare function field(fieldId: string, options?: {
438
303
  fieldId: string;
439
304
  };
440
305
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
306
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
307
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
441
308
  };
442
309
  asDob(): any;
443
310
  asAge(): any;
@@ -475,6 +342,8 @@ export declare function field(fieldId: string, options?: {
475
342
  fieldId: string;
476
343
  };
477
344
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
345
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
346
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
478
347
  };
479
348
  isAfter(): {
480
349
  days: (days: number) => {
@@ -510,5 +379,59 @@ export declare function field(fieldId: string, options?: {
510
379
  fieldId: string;
511
380
  };
512
381
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
382
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
383
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
384
+ range: () => {
385
+ options?: SelectOption[];
386
+ conditionals?: FieldConditional[];
387
+ validations?: ValidationConfig[];
388
+ searchCriteriaLabelPrefix?: TranslationConfig;
389
+ allowedLocations?: JurisdictionReference;
390
+ fieldId: string;
391
+ fieldType: 'field';
392
+ } & {
393
+ config: {
394
+ type: 'range';
395
+ };
396
+ };
397
+ exact: () => {
398
+ options?: SelectOption[];
399
+ conditionals?: FieldConditional[];
400
+ validations?: ValidationConfig[];
401
+ searchCriteriaLabelPrefix?: TranslationConfig;
402
+ allowedLocations?: JurisdictionReference;
403
+ fieldId: string;
404
+ fieldType: 'field';
405
+ } & {
406
+ config: {
407
+ type: 'exact';
408
+ };
409
+ };
410
+ fuzzy: () => {
411
+ options?: SelectOption[];
412
+ conditionals?: FieldConditional[];
413
+ validations?: ValidationConfig[];
414
+ searchCriteriaLabelPrefix?: TranslationConfig;
415
+ allowedLocations?: JurisdictionReference;
416
+ fieldId: string;
417
+ fieldType: 'field';
418
+ } & {
419
+ config: {
420
+ type: 'fuzzy';
421
+ };
422
+ };
423
+ within: () => {
424
+ options?: SelectOption[];
425
+ conditionals?: FieldConditional[];
426
+ validations?: ValidationConfig[];
427
+ searchCriteriaLabelPrefix?: TranslationConfig;
428
+ allowedLocations?: JurisdictionReference;
429
+ fieldId: string;
430
+ fieldType: 'field';
431
+ } & {
432
+ config: {
433
+ type: 'within';
434
+ };
435
+ };
513
436
  };
514
437
  //# sourceMappingURL=field.d.ts.map
@@ -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';
@@ -7,8 +7,8 @@ import { SystemContext, UserContext } from '../users/User';
7
7
  /** @deprecated Moving on, location types are arbitrary and defined by the country config. */
8
8
  export declare const LocationTypeV1: z.ZodEnum<{
9
9
  ADMIN_STRUCTURE: "ADMIN_STRUCTURE";
10
- HEALTH_FACILITY: "HEALTH_FACILITY";
11
10
  CRVS_OFFICE: "CRVS_OFFICE";
11
+ HEALTH_FACILITY: "HEALTH_FACILITY";
12
12
  }>;
13
13
  export type LocationTypeV1 = z.infer<typeof LocationTypeV1>;
14
14
  export declare const AdministrativeArea: z.ZodObject<{
@@ -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
  };
@@ -74,11 +75,11 @@ export declare function canAccessOtherUserWithScopes({ scopes, userToAccess, use
74
75
  */
75
76
  export declare function userCanAccessEventWithScopes(event: Partial<EventIndexWithAdministrativeHierarchy>, scopes: RecordScopeV2[], user: UserContext | SystemContext, customActionType?: string): boolean;
76
77
  export declare function getAdministrativeAreaHierarchy(administrativeAreaId: string | undefined | null, administrativeAreas: Map<UUID, AdministrativeArea>): {
77
- id: string & z.core.$brand<"UUID">;
78
+ id: string & z.$brand<"UUID">;
78
79
  name: string;
79
- parentId: (string & z.core.$brand<"UUID">) | null;
80
- validUntil: string | null;
81
80
  externalId?: string | null | undefined;
81
+ parentId: (string & z.$brand<"UUID">) | null;
82
+ validUntil: string | null;
82
83
  }[];
83
84
  /**
84
85
  * Resolves a location or administrative area UUID into a root-first hierarchy of UUIDs.
@@ -4,16 +4,16 @@ export declare const V2_DEFAULT_MOCK_LOCATIONS: Location[];
4
4
  export declare const V2_DEFAULT_MOCK_LOCATIONS_MAP: Map<string & import("zod").$brand<"UUID">, {
5
5
  id: string & import("zod").$brand<"UUID">;
6
6
  name: string;
7
+ externalId?: string | null | undefined;
7
8
  administrativeAreaId: (string & import("zod").$brand<"UUID">) | null;
8
9
  validUntil: string | null;
9
10
  locationType: string | null;
10
- externalId?: string | null | undefined;
11
11
  }>;
12
12
  export declare const V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS_MAP: Map<string & import("zod").$brand<"UUID">, {
13
13
  id: string & import("zod").$brand<"UUID">;
14
14
  name: string;
15
+ externalId?: string | null | undefined;
15
16
  parentId: (string & import("zod").$brand<"UUID">) | null;
16
17
  validUntil: string | null;
17
- externalId?: string | null | undefined;
18
18
  }>;
19
19
  //# sourceMappingURL=mocks.test.utils.d.ts.map
@@ -13,7 +13,7 @@ export declare const ACTION_SCOPE_MAP: {
13
13
  DELETE: ("record.declare" | "record.notify")[];
14
14
  REGISTER: "record.register"[];
15
15
  PRINT_CERTIFICATE: "record.print-certified-copies"[];
16
- REQUEST_CORRECTION: ("record.request-correction" | "record.correct")[];
16
+ REQUEST_CORRECTION: ("record.correct" | "record.request-correction")[];
17
17
  REVIEW_CORRECTION_REQUEST: "record.correct"[];
18
18
  REJECT_CORRECTION: "record.correct"[];
19
19
  APPROVE_CORRECTION: "record.correct"[];
@@ -28,9 +28,9 @@ export declare const ACTION_SCOPE_MAP: {
28
28
  };
29
29
  export declare function hasAnyOfScopes(a: string[], b: string[]): boolean;
30
30
  export declare const AssignmentStatus: {
31
- readonly ASSIGNED_TO_SELF: "ASSIGNED_TO_SELF";
32
- readonly ASSIGNED_TO_OTHERS: "ASSIGNED_TO_OTHERS";
33
- readonly UNASSIGNED: "UNASSIGNED";
31
+ readonly ASSIGNED_TO_SELF: 'ASSIGNED_TO_SELF';
32
+ readonly ASSIGNED_TO_OTHERS: 'ASSIGNED_TO_OTHERS';
33
+ readonly UNASSIGNED: 'UNASSIGNED';
34
34
  };
35
35
  export type AssignmentStatus = (typeof AssignmentStatus)[keyof typeof AssignmentStatus];
36
36
  export declare function getAssignmentStatus(eventState: EventIndex | EventIndexWithAdministrativeHierarchy, userId: string): AssignmentStatus;
@@ -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
@@ -7,7 +7,7 @@ import { Draft } from '../Draft';
7
7
  import { EventConfig } from '../EventConfig';
8
8
  import { UUID } from '../../uuid';
9
9
  import { DocumentPath } from '../../documents';
10
- export declare function getStatusFromActions(actions: Array<Action>): "CREATED" | "NOTIFIED" | "DECLARED" | "REGISTERED" | "ARCHIVED";
10
+ export declare function getStatusFromActions(actions: Array<Action>): "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED";
11
11
  export declare function getAssignedUserFromActions(actions: Array<ActionDocument>): string | null;
12
12
  type NonNullableDeep<T> = T extends [unknown, ...unknown[]] ? {
13
13
  [K in keyof T]: NonNullableDeep<NonNullable<T[K]>>;
@@ -63,29 +63,45 @@ export declare function applyDeclarationToEventIndex(eventIndex: EventIndex, dec
63
63
  export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Draft, eventConfiguration: EventConfig): {
64
64
  id: string & import("zod").$brand<"UUID">;
65
65
  type: string;
66
- status: "CREATED" | "NOTIFIED" | "DECLARED" | "REGISTERED" | "ARCHIVED";
66
+ status: "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED";
67
67
  legalStatuses: {
68
- DECLARED?: {
68
+ NOTIFIED?: {
69
69
  createdAt: string;
70
70
  createdBy: string;
71
+ createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
72
+ createdByUserType?: "system" | "user" | null | undefined;
71
73
  acceptedAt: string;
74
+ createdByRole?: string | undefined;
75
+ } | null | undefined;
76
+ DECLARED?: {
77
+ createdAt: string;
78
+ createdBy: string;
72
79
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
73
- createdByUserType?: "user" | "system" | null | undefined;
80
+ createdByUserType?: "system" | "user" | null | undefined;
81
+ acceptedAt: string;
74
82
  createdByRole?: string | undefined;
75
83
  } | null | undefined;
76
84
  REGISTERED?: {
77
85
  createdAt: string;
78
86
  createdBy: string;
79
- acceptedAt: string;
80
- registrationNumber: string;
81
87
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
82
- createdByUserType?: "user" | "system" | null | undefined;
88
+ createdByUserType?: "system" | "user" | null | undefined;
89
+ acceptedAt: string;
83
90
  createdByRole?: string | undefined;
91
+ registrationNumber: string;
84
92
  } | null | undefined;
85
93
  };
86
94
  createdAt: string;
95
+ dateOfEvent?: string | null | undefined;
96
+ placeOfEvent?: (string & import("zod").$brand<"UUID">) | null | undefined;
87
97
  createdBy: string;
98
+ createdByUserType?: "system" | "user" | null | undefined;
99
+ updatedByUserRole?: string | null | undefined;
100
+ createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
101
+ updatedAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
88
102
  updatedAt: string;
103
+ assignedTo?: string | null | undefined;
104
+ updatedBy?: string | null | undefined;
89
105
  trackingId: string;
90
106
  potentialDuplicates: {
91
107
  id: string & import("zod").$brand<"UUID">;
@@ -93,14 +109,6 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
93
109
  }[];
94
110
  flags: string[];
95
111
  declaration: Record<string, import("..").FieldValue>;
96
- dateOfEvent?: string | null | undefined;
97
- placeOfEvent?: (string & import("zod").$brand<"UUID">) | null | undefined;
98
- createdByUserType?: "user" | "system" | null | undefined;
99
- updatedByUserRole?: string | null | undefined;
100
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
101
- updatedAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
102
- assignedTo?: string | null | undefined;
103
- updatedBy?: string | null | undefined;
104
112
  };
105
113
  /**
106
114
  * Annotation is always specific to the action. when action with annotation is triggered multiple times,