@opencrvs/toolkit 2.1.0-rc.1dde62b → 2.1.0-rc.1f688f9
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.
- package/README.md +1 -0
- package/build.sh +3 -0
- package/create-countryconfig/index.js +284 -62
- package/create-countryconfig/node_modules/.bin/degit +21 -0
- package/create-countryconfig/package.json +4 -1
- package/dist/application-config/index.js +343 -275
- package/dist/cli.js +1085 -101
- package/dist/commons/api/router.d.ts +3971 -3373
- package/dist/commons/application-config/index.d.ts +6 -6
- package/dist/commons/conditionals/conditionals.d.ts +32 -323
- package/dist/commons/conditionals/validate.d.ts +16 -5
- package/dist/commons/events/ActionConfig.d.ts +112 -105
- package/dist/commons/events/ActionDocument.d.ts +121 -127
- package/dist/commons/events/ActionInput.d.ts +4 -10
- package/dist/commons/events/ActionStatus.d.ts +14 -0
- package/dist/commons/events/ActionType.d.ts +62 -62
- package/dist/commons/events/AdvancedSearchConfig.d.ts +531 -507
- package/dist/commons/events/AuditLog.d.ts +189 -42
- package/dist/commons/events/CompositeFieldValue.d.ts +4 -4
- package/dist/commons/events/Conditional.d.ts +3 -3
- package/dist/commons/events/CountryConfigQueryInput.d.ts +590 -590
- package/dist/commons/events/Draft.d.ts +37 -37
- package/dist/commons/events/DynamicFieldValue.d.ts +9 -9
- package/dist/commons/events/EventConfig.d.ts +8 -5
- package/dist/commons/events/EventDocument.d.ts +518 -50
- package/dist/commons/events/EventIndex.d.ts +49 -72
- package/dist/commons/events/EventMetadata.d.ts +39 -49
- package/dist/commons/events/EventStatus.d.ts +19 -0
- package/dist/commons/events/FieldConfig.d.ts +424 -389
- package/dist/commons/events/FieldType.d.ts +51 -51
- package/dist/commons/events/FieldTypeMapping.d.ts +86 -86
- package/dist/commons/events/FieldValue.d.ts +14 -14
- package/dist/commons/events/Flag.d.ts +57 -15
- package/dist/commons/events/PlainDate.d.ts +8 -0
- package/dist/commons/events/SummaryConfig.d.ts +249 -0
- package/dist/commons/events/TemplateConfig.d.ts +1 -1
- package/dist/commons/events/WorkqueueColumnConfig.d.ts +40 -40
- package/dist/commons/events/WorkqueueConfig.d.ts +817 -814
- package/dist/commons/events/deduplication.d.ts +1 -1
- package/dist/commons/events/event.d.ts +14 -2
- package/dist/commons/events/field.d.ts +69 -198
- package/dist/commons/events/index.d.ts +1 -0
- package/dist/commons/events/locationPayloads.d.ts +95 -0
- package/dist/commons/events/locations.d.ts +243 -14
- package/dist/commons/events/mocks.test.utils.d.ts +48 -4
- package/dist/commons/events/scopes.d.ts +4 -4
- package/dist/commons/events/state/index.d.ts +17 -17
- package/dist/commons/events/state/utils.d.ts +7 -7
- package/dist/commons/events/test.utils.d.ts +47 -46
- package/dist/commons/events/utils.d.ts +122 -114
- package/dist/commons/notification/UserNotifications.d.ts +38 -23
- package/dist/commons/notification/dispatch.d.ts +15 -0
- package/dist/commons/notification/index.d.ts +1 -0
- package/dist/conditionals/index.js +328 -58
- package/dist/environment/derived-variables.d.ts +119 -119
- package/dist/environment/derived-variables.d.ts.map +1 -1
- package/dist/environment/index.d.ts +1 -0
- package/dist/environment/index.d.ts.map +1 -1
- package/dist/environment/index.js +10 -0
- package/dist/environment/logger.d.ts +3 -3
- package/dist/environment/manage-users.js +17 -7
- package/dist/environment/paths.d.ts +7 -0
- package/dist/environment/paths.d.ts.map +1 -0
- package/dist/environment/paths.js +72 -0
- package/dist/environment/questions.d.ts +75 -74
- package/dist/environment/questions.d.ts.map +1 -1
- package/dist/environment/questions.js +20 -14
- package/dist/environment/setup-environment.js +11 -16
- package/dist/environment/swarm-to-k8s.js +17 -7
- package/dist/environment/templates.d.ts.map +1 -1
- package/dist/environment/templates.js +2 -1
- package/dist/environment/update-workflows.d.ts.map +1 -1
- package/dist/environment/update-workflows.js +34 -12
- package/dist/environment/upgrade.d.ts +2 -0
- package/dist/environment/upgrade.d.ts.map +1 -0
- package/dist/environment/upgrade.js +82 -0
- package/dist/environment/users.js +28 -20
- package/dist/environment/utils.d.ts +1 -1
- package/dist/environment/utils.js +17 -7
- package/dist/events/deduplication.d.ts +1 -1
- package/dist/events/index.js +3804 -3388
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts +2 -2
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.js +2 -2
- package/dist/migrations/v2.0/convert-config-files-to-ts.js +17 -7
- package/dist/migrations/v2.0/migrate-application-config-url.js +4 -3
- package/dist/migrations/v2.0/remove-hearth-migrations.js +17 -7
- package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +3 -0
- package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +1 -0
- package/dist/migrations/v2.1/add-recovery-link-notifications.js +530 -0
- package/dist/migrations/v2.1/enable-telemetry.d.ts +3 -0
- package/dist/migrations/v2.1/enable-telemetry.d.ts.map +1 -0
- package/dist/migrations/v2.1/enable-telemetry.js +438 -0
- package/dist/migrations/v2.1/index.d.ts.map +1 -1
- package/dist/migrations/v2.1/index.js +862 -0
- package/dist/notification/index.js +1862 -1460
- package/dist/scopes/index.d.ts +464 -169
- package/dist/scopes/index.js +329 -58
- package/dist/telemetry/index.d.ts +45 -0
- package/dist/telemetry/index.d.ts.map +1 -0
- package/dist/telemetry/index.js +39 -0
- package/dist/templates/charts-values/opencrvs-services/values.yaml +4 -3
- package/dist/templates/charts-values/opentelemetry/values.yaml +95 -0
- package/dist/templates/charts-values/traefik/values.yaml +23 -9
- package/dist/templates/inventory/inventory.template.yml +1 -3
- package/opencrvs-toolkit-2.1.0-rc.1f688f9.tgz +0 -0
- package/package.json +8 -7
- package/tsconfig.tsbuildinfo +1 -1
- package/dist/templates/inventory/production.example.yml +0 -77
- package/dist/templates/inventory/qa.example.yml +0 -48
- package/opencrvs-toolkit-2.1.0-rc.1dde62b.tgz +0 -0
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { NonSearchableEventMetadataTimeFieldIdInput, AdvancedSearchConfig } from '../event-config/event-configuration';
|
|
2
2
|
import { ActionType } from './ActionType';
|
|
3
3
|
import { EventFieldIdInput } from './AdvancedSearchConfig';
|
|
4
|
+
import { EventStatus } from './EventMetadata';
|
|
5
|
+
import { Flag } from './Flag';
|
|
4
6
|
import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConfig';
|
|
5
7
|
/**
|
|
6
8
|
* Creates a function that acts like a callable + static method container.
|
|
@@ -20,6 +22,8 @@ declare const event: typeof eventFn & {
|
|
|
20
22
|
* @param action - The action type to check for.
|
|
21
23
|
*/
|
|
22
24
|
hasAction: (action: ActionType) => {
|
|
25
|
+
$id: string;
|
|
26
|
+
__nominal__type: 'JSONSchema';
|
|
23
27
|
/**
|
|
24
28
|
* Creates a conditional that checks if the event contains a specific action type
|
|
25
29
|
* with a minimum count of occurrences.
|
|
@@ -71,10 +75,18 @@ declare const event: typeof eventFn & {
|
|
|
71
75
|
*/
|
|
72
76
|
maxCount: (maxCount: number) => import("../conditionals/conditionals").JSONSchema;
|
|
73
77
|
};
|
|
74
|
-
$id: string;
|
|
75
|
-
__nominal__type: "JSONSchema";
|
|
76
78
|
};
|
|
77
79
|
field(field: WorkqueueColumnKeys): WorkqueueColumnValue;
|
|
80
|
+
/**
|
|
81
|
+
* Checks if the event currently has the given status.
|
|
82
|
+
* @param eventStatus - The status to check for.
|
|
83
|
+
*/
|
|
84
|
+
hasStatus: (eventStatus: EventStatus) => import("../conditionals/conditionals").JSONSchema;
|
|
85
|
+
/**
|
|
86
|
+
* Checks if the event currently carries the given flag.
|
|
87
|
+
* @param flagValue - The flag to check for.
|
|
88
|
+
*/
|
|
89
|
+
hasFlag: (flagValue: Flag) => import("../conditionals/conditionals").JSONSchema;
|
|
78
90
|
};
|
|
79
91
|
export { event };
|
|
80
92
|
//# sourceMappingURL=event.d.ts.map
|
|
@@ -38,71 +38,19 @@ export declare function field(fieldId: string, options?: {
|
|
|
38
38
|
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
39
39
|
allowedLocations?: JurisdictionReference;
|
|
40
40
|
}): {
|
|
41
|
-
range: () => {
|
|
42
|
-
options?: SelectOption[];
|
|
43
|
-
conditionals?: FieldConditional[];
|
|
44
|
-
validations?: ValidationConfig[];
|
|
45
|
-
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
46
|
-
allowedLocations?: JurisdictionReference;
|
|
47
|
-
fieldId: string;
|
|
48
|
-
fieldType: "field";
|
|
49
|
-
} & {
|
|
50
|
-
config: {
|
|
51
|
-
type: "range";
|
|
52
|
-
};
|
|
53
|
-
};
|
|
54
|
-
exact: () => {
|
|
55
|
-
options?: SelectOption[];
|
|
56
|
-
conditionals?: FieldConditional[];
|
|
57
|
-
validations?: ValidationConfig[];
|
|
58
|
-
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
59
|
-
allowedLocations?: JurisdictionReference;
|
|
60
|
-
fieldId: string;
|
|
61
|
-
fieldType: "field";
|
|
62
|
-
} & {
|
|
63
|
-
config: {
|
|
64
|
-
type: "exact";
|
|
65
|
-
};
|
|
66
|
-
};
|
|
67
|
-
fuzzy: () => {
|
|
68
|
-
options?: SelectOption[];
|
|
69
|
-
conditionals?: FieldConditional[];
|
|
70
|
-
validations?: ValidationConfig[];
|
|
71
|
-
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
72
|
-
allowedLocations?: JurisdictionReference;
|
|
73
|
-
fieldId: string;
|
|
74
|
-
fieldType: "field";
|
|
75
|
-
} & {
|
|
76
|
-
config: {
|
|
77
|
-
type: "fuzzy";
|
|
78
|
-
};
|
|
79
|
-
};
|
|
80
|
-
within: () => {
|
|
81
|
-
options?: SelectOption[];
|
|
82
|
-
conditionals?: FieldConditional[];
|
|
83
|
-
validations?: ValidationConfig[];
|
|
84
|
-
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
85
|
-
allowedLocations?: JurisdictionReference;
|
|
86
|
-
fieldId: string;
|
|
87
|
-
fieldType: "field";
|
|
88
|
-
} & {
|
|
89
|
-
config: {
|
|
90
|
-
type: "within";
|
|
91
|
-
};
|
|
92
|
-
};
|
|
93
41
|
$$field: string;
|
|
94
42
|
$$subfield: string[];
|
|
95
43
|
get(fieldPath: string): {
|
|
96
|
-
$$subfield: string[];
|
|
97
44
|
$$field: string;
|
|
98
|
-
get(fieldPath: string): any;
|
|
45
|
+
get(fieldPath: string): /*elided*/ any;
|
|
46
|
+
$$subfield: string[];
|
|
99
47
|
getByPath(fieldPath: string[]): {
|
|
100
|
-
$$subfield: string[];
|
|
101
48
|
$$field: string;
|
|
102
|
-
get(fieldPath: string): any;
|
|
103
|
-
getByPath(fieldPath: string[]): any;
|
|
104
|
-
|
|
105
|
-
|
|
49
|
+
get(fieldPath: string): /*elided*/ any;
|
|
50
|
+
getByPath(fieldPath: string[]): /*elided*/ any;
|
|
51
|
+
$$subfield: string[];
|
|
52
|
+
asDob(): /*elided*/ any;
|
|
53
|
+
asAge(): /*elided*/ any;
|
|
106
54
|
isAfter(): {
|
|
107
55
|
days: (days: number) => {
|
|
108
56
|
inPast: () => import("../conditionals/conditionals").JSONSchema;
|
|
@@ -140,8 +88,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
140
88
|
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
141
89
|
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
142
90
|
};
|
|
143
|
-
asDob(): any;
|
|
144
|
-
asAge(): any;
|
|
91
|
+
asDob(): /*elided*/ any;
|
|
92
|
+
asAge(): /*elided*/ any;
|
|
145
93
|
isAfter(): {
|
|
146
94
|
days: (days: number) => {
|
|
147
95
|
inPast: () => import("../conditionals/conditionals").JSONSchema;
|
|
@@ -180,141 +128,12 @@ export declare function field(fieldId: string, options?: {
|
|
|
180
128
|
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
181
129
|
};
|
|
182
130
|
getByPath(fieldPath: string[]): {
|
|
183
|
-
$$subfield: string[];
|
|
184
131
|
$$field: string;
|
|
185
|
-
get(fieldPath: string):
|
|
186
|
-
$$subfield: string[];
|
|
187
|
-
$$field: string;
|
|
188
|
-
get(fieldPath: string): any;
|
|
189
|
-
getByPath(fieldPath: string[]): any;
|
|
190
|
-
asDob(): any;
|
|
191
|
-
asAge(): any;
|
|
192
|
-
isAfter(): {
|
|
193
|
-
days: (days: number) => {
|
|
194
|
-
inPast: () => import("../conditionals/conditionals").JSONSchema;
|
|
195
|
-
inFuture: () => import("../conditionals/conditionals").JSONSchema;
|
|
196
|
-
fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
197
|
-
fromNow: () => import("../conditionals/conditionals").JSONSchema;
|
|
198
|
-
};
|
|
199
|
-
date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
200
|
-
now: () => import("../conditionals/conditionals").JSONSchema;
|
|
201
|
-
};
|
|
202
|
-
isBefore(): {
|
|
203
|
-
days: (days: number) => {
|
|
204
|
-
inPast: () => import("../conditionals/conditionals").JSONSchema;
|
|
205
|
-
inFuture: () => import("../conditionals/conditionals").JSONSchema;
|
|
206
|
-
fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
207
|
-
fromNow: () => import("../conditionals/conditionals").JSONSchema;
|
|
208
|
-
};
|
|
209
|
-
date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
210
|
-
now: () => import("../conditionals/conditionals").JSONSchema;
|
|
211
|
-
};
|
|
212
|
-
isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
|
|
213
|
-
isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
|
|
214
|
-
isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
|
|
215
|
-
isFalsy(): import("../conditionals/conditionals").JSONSchema;
|
|
216
|
-
isUndefined(): import("../conditionals/conditionals").JSONSchema;
|
|
217
|
-
inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
|
|
218
|
-
isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
|
|
219
|
-
isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
|
|
220
|
-
matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
|
|
221
|
-
isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
|
|
222
|
-
getId: () => {
|
|
223
|
-
fieldId: string;
|
|
224
|
-
};
|
|
225
|
-
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
226
|
-
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
227
|
-
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
228
|
-
};
|
|
132
|
+
get(fieldPath: string): any;
|
|
229
133
|
getByPath(fieldPath: string[]): any;
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
get(fieldPath: string): any;
|
|
234
|
-
getByPath(fieldPath: string[]): any;
|
|
235
|
-
asDob(): any;
|
|
236
|
-
asAge(): any;
|
|
237
|
-
isAfter(): {
|
|
238
|
-
days: (days: number) => {
|
|
239
|
-
inPast: () => import("../conditionals/conditionals").JSONSchema;
|
|
240
|
-
inFuture: () => import("../conditionals/conditionals").JSONSchema;
|
|
241
|
-
fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
242
|
-
fromNow: () => import("../conditionals/conditionals").JSONSchema;
|
|
243
|
-
};
|
|
244
|
-
date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
245
|
-
now: () => import("../conditionals/conditionals").JSONSchema;
|
|
246
|
-
};
|
|
247
|
-
isBefore(): {
|
|
248
|
-
days: (days: number) => {
|
|
249
|
-
inPast: () => import("../conditionals/conditionals").JSONSchema;
|
|
250
|
-
inFuture: () => import("../conditionals/conditionals").JSONSchema;
|
|
251
|
-
fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
252
|
-
fromNow: () => import("../conditionals/conditionals").JSONSchema;
|
|
253
|
-
};
|
|
254
|
-
date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
255
|
-
now: () => import("../conditionals/conditionals").JSONSchema;
|
|
256
|
-
};
|
|
257
|
-
isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
|
|
258
|
-
isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
|
|
259
|
-
isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
|
|
260
|
-
isFalsy(): import("../conditionals/conditionals").JSONSchema;
|
|
261
|
-
isUndefined(): import("../conditionals/conditionals").JSONSchema;
|
|
262
|
-
inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
|
|
263
|
-
isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
|
|
264
|
-
isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
|
|
265
|
-
matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
|
|
266
|
-
isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
|
|
267
|
-
getId: () => {
|
|
268
|
-
fieldId: string;
|
|
269
|
-
};
|
|
270
|
-
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
271
|
-
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
272
|
-
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
273
|
-
};
|
|
274
|
-
asAge(): {
|
|
275
|
-
$$subfield: string[];
|
|
276
|
-
$$field: string;
|
|
277
|
-
get(fieldPath: string): any;
|
|
278
|
-
getByPath(fieldPath: string[]): any;
|
|
279
|
-
asDob(): any;
|
|
280
|
-
asAge(): any;
|
|
281
|
-
isAfter(): {
|
|
282
|
-
days: (days: number) => {
|
|
283
|
-
inPast: () => import("../conditionals/conditionals").JSONSchema;
|
|
284
|
-
inFuture: () => import("../conditionals/conditionals").JSONSchema;
|
|
285
|
-
fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
286
|
-
fromNow: () => import("../conditionals/conditionals").JSONSchema;
|
|
287
|
-
};
|
|
288
|
-
date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
289
|
-
now: () => import("../conditionals/conditionals").JSONSchema;
|
|
290
|
-
};
|
|
291
|
-
isBefore(): {
|
|
292
|
-
days: (days: number) => {
|
|
293
|
-
inPast: () => import("../conditionals/conditionals").JSONSchema;
|
|
294
|
-
inFuture: () => import("../conditionals/conditionals").JSONSchema;
|
|
295
|
-
fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
296
|
-
fromNow: () => import("../conditionals/conditionals").JSONSchema;
|
|
297
|
-
};
|
|
298
|
-
date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
|
|
299
|
-
now: () => import("../conditionals/conditionals").JSONSchema;
|
|
300
|
-
};
|
|
301
|
-
isGreaterThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
|
|
302
|
-
isLessThan(value: number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
|
|
303
|
-
isEqualTo(value: string | boolean | number | import("./FieldConfig").FieldReference): import("../conditionals/conditionals").JSONSchema;
|
|
304
|
-
isFalsy(): import("../conditionals/conditionals").JSONSchema;
|
|
305
|
-
isUndefined(): import("../conditionals/conditionals").JSONSchema;
|
|
306
|
-
inArray(values: string[]): import("../conditionals/conditionals").JSONSchema;
|
|
307
|
-
isValidEnglishName(): import("../conditionals/conditionals").JSONSchema;
|
|
308
|
-
isValidAdministrativeLeafLevel(): import("../conditionals/conditionals").JSONSchema;
|
|
309
|
-
matches(pattern: string): import("../conditionals/conditionals").JSONSchema;
|
|
310
|
-
isBetween(min: number, max: number): import("../conditionals/conditionals").JSONSchema;
|
|
311
|
-
getId: () => {
|
|
312
|
-
fieldId: string;
|
|
313
|
-
};
|
|
314
|
-
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
315
|
-
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
316
|
-
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
317
|
-
};
|
|
134
|
+
$$subfield: string[];
|
|
135
|
+
asDob(): any;
|
|
136
|
+
asAge(): any;
|
|
318
137
|
isAfter(): {
|
|
319
138
|
days: (days: number) => {
|
|
320
139
|
inPast: () => import("../conditionals/conditionals").JSONSchema;
|
|
@@ -353,14 +172,14 @@ export declare function field(fieldId: string, options?: {
|
|
|
353
172
|
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
354
173
|
};
|
|
355
174
|
asDob(): {
|
|
356
|
-
$$subfield: string[];
|
|
357
175
|
$$field: string;
|
|
358
176
|
get(fieldPath: string): any;
|
|
177
|
+
$$subfield: string[];
|
|
359
178
|
getByPath(fieldPath: string[]): {
|
|
360
|
-
$$subfield: string[];
|
|
361
179
|
$$field: string;
|
|
362
180
|
get(fieldPath: string): any;
|
|
363
181
|
getByPath(fieldPath: string[]): any;
|
|
182
|
+
$$subfield: string[];
|
|
364
183
|
asDob(): any;
|
|
365
184
|
asAge(): any;
|
|
366
185
|
isAfter(): {
|
|
@@ -440,14 +259,14 @@ export declare function field(fieldId: string, options?: {
|
|
|
440
259
|
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
441
260
|
};
|
|
442
261
|
asAge(): {
|
|
443
|
-
$$subfield: string[];
|
|
444
262
|
$$field: string;
|
|
445
263
|
get(fieldPath: string): any;
|
|
264
|
+
$$subfield: string[];
|
|
446
265
|
getByPath(fieldPath: string[]): {
|
|
447
|
-
$$subfield: string[];
|
|
448
266
|
$$field: string;
|
|
449
267
|
get(fieldPath: string): any;
|
|
450
268
|
getByPath(fieldPath: string[]): any;
|
|
269
|
+
$$subfield: string[];
|
|
451
270
|
asDob(): any;
|
|
452
271
|
asAge(): any;
|
|
453
272
|
isAfter(): {
|
|
@@ -562,5 +381,57 @@ export declare function field(fieldId: string, options?: {
|
|
|
562
381
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
563
382
|
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
564
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
|
+
};
|
|
565
436
|
};
|
|
566
437
|
//# sourceMappingURL=field.d.ts.map
|
|
@@ -45,6 +45,7 @@ export * from './field';
|
|
|
45
45
|
export * from './Flag';
|
|
46
46
|
export * from './event';
|
|
47
47
|
export * from './locations';
|
|
48
|
+
export * from './locationPayloads';
|
|
48
49
|
export { UUID } from '../uuid';
|
|
49
50
|
export { DocumentPath } from '../documents';
|
|
50
51
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import * as z from 'zod/v4';
|
|
2
|
+
/**
|
|
3
|
+
* Input payload for creating a location: the identity fields (parent and
|
|
4
|
+
* locationType are set once, immutable thereafter) plus the first version.
|
|
5
|
+
* `id` and `versionId` may be supplied by the caller for idempotent retries.
|
|
6
|
+
* `effectiveFrom` defaults to the beginning-of-time sentinel on the server.
|
|
7
|
+
*/
|
|
8
|
+
export declare const CreateLocationPayload: z.ZodObject<{
|
|
9
|
+
id: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
10
|
+
versionId: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
11
|
+
name: z.ZodString;
|
|
12
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
13
|
+
administrativeAreaId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
14
|
+
locationType: z.ZodNullable<z.ZodString>;
|
|
15
|
+
effectiveFrom: z.ZodOptional<z.ZodISODate>;
|
|
16
|
+
status: z.ZodDefault<z.ZodEnum<{
|
|
17
|
+
active: "active";
|
|
18
|
+
inactive: "inactive";
|
|
19
|
+
}>>;
|
|
20
|
+
}, z.core.$strip>;
|
|
21
|
+
export type CreateLocationPayload = z.infer<typeof CreateLocationPayload>;
|
|
22
|
+
/**
|
|
23
|
+
* Input payload for appending a new version to a location. A full snapshot of
|
|
24
|
+
* every versioned field is required — omitted does not mean unchanged. The
|
|
25
|
+
* schema is strict: identity fields (`administrativeAreaId`, `locationType`)
|
|
26
|
+
* are rejected rather than ignored, as they cannot change. `lastVersionId`
|
|
27
|
+
* is the optimistic-concurrency check: it must be the id of the last element
|
|
28
|
+
* the caller observed. `effectiveFrom` defaults to today on the server;
|
|
29
|
+
* supply it explicitly for idempotent retries.
|
|
30
|
+
*/
|
|
31
|
+
export declare const UpdateLocationPayload: z.ZodObject<{
|
|
32
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
33
|
+
versionId: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
34
|
+
name: z.ZodString;
|
|
35
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
36
|
+
status: z.ZodEnum<{
|
|
37
|
+
active: "active";
|
|
38
|
+
inactive: "inactive";
|
|
39
|
+
}>;
|
|
40
|
+
effectiveFrom: z.ZodOptional<z.ZodISODate>;
|
|
41
|
+
lastVersionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
42
|
+
}, z.core.$strict>;
|
|
43
|
+
export type UpdateLocationPayload = z.infer<typeof UpdateLocationPayload>;
|
|
44
|
+
/**
|
|
45
|
+
* Input payload for withdrawing a pending (future-dated) version element.
|
|
46
|
+
* Only elements whose `effectiveFrom` has not yet passed can be withdrawn.
|
|
47
|
+
*/
|
|
48
|
+
export declare const WithdrawLocationVersionPayload: z.ZodObject<{
|
|
49
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
50
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
51
|
+
}, z.core.$strip>;
|
|
52
|
+
export type WithdrawLocationVersionPayload = z.infer<typeof WithdrawLocationVersionPayload>;
|
|
53
|
+
/**
|
|
54
|
+
* Administrative-area twin of {@link CreateLocationPayload}: `parentId`
|
|
55
|
+
* instead of `administrativeAreaId`, no `locationType`.
|
|
56
|
+
*/
|
|
57
|
+
export declare const CreateAdministrativeAreaPayload: z.ZodObject<{
|
|
58
|
+
id: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
59
|
+
versionId: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
60
|
+
name: z.ZodString;
|
|
61
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
62
|
+
parentId: z.ZodNullable<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
63
|
+
effectiveFrom: z.ZodOptional<z.ZodISODate>;
|
|
64
|
+
status: z.ZodDefault<z.ZodEnum<{
|
|
65
|
+
active: "active";
|
|
66
|
+
inactive: "inactive";
|
|
67
|
+
}>>;
|
|
68
|
+
}, z.core.$strip>;
|
|
69
|
+
export type CreateAdministrativeAreaPayload = z.infer<typeof CreateAdministrativeAreaPayload>;
|
|
70
|
+
/**
|
|
71
|
+
* Administrative-area twin of {@link UpdateLocationPayload} — strict for the
|
|
72
|
+
* same reason: the identity field (`parentId`) is rejected, not ignored.
|
|
73
|
+
*/
|
|
74
|
+
export declare const UpdateAdministrativeAreaPayload: z.ZodObject<{
|
|
75
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
76
|
+
versionId: z.ZodOptional<z.core.$ZodBranded<z.ZodUUID, "UUID", "out">>;
|
|
77
|
+
name: z.ZodString;
|
|
78
|
+
externalId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
79
|
+
status: z.ZodEnum<{
|
|
80
|
+
active: "active";
|
|
81
|
+
inactive: "inactive";
|
|
82
|
+
}>;
|
|
83
|
+
effectiveFrom: z.ZodOptional<z.ZodISODate>;
|
|
84
|
+
lastVersionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
85
|
+
}, z.core.$strict>;
|
|
86
|
+
export type UpdateAdministrativeAreaPayload = z.infer<typeof UpdateAdministrativeAreaPayload>;
|
|
87
|
+
/**
|
|
88
|
+
* Administrative-area twin of {@link WithdrawLocationVersionPayload}.
|
|
89
|
+
*/
|
|
90
|
+
export declare const WithdrawAdministrativeAreaVersionPayload: z.ZodObject<{
|
|
91
|
+
id: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
92
|
+
versionId: z.core.$ZodBranded<z.ZodUUID, "UUID", "out">;
|
|
93
|
+
}, z.core.$strip>;
|
|
94
|
+
export type WithdrawAdministrativeAreaVersionPayload = z.infer<typeof WithdrawAdministrativeAreaVersionPayload>;
|
|
95
|
+
//# sourceMappingURL=locationPayloads.d.ts.map
|