@opencrvs/toolkit 2.0.0-rc.e1f588f → 2.0.0-rc.e25c39b

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 (63) hide show
  1. package/create-countryconfig/index.js +103 -0
  2. package/create-countryconfig/package.json +21 -0
  3. package/dist/application-config/index.js +314 -131
  4. package/dist/cli.js +548 -178
  5. package/dist/commons/api/router.d.ts +3392 -241
  6. package/dist/commons/application-config/index.d.ts +17 -4
  7. package/dist/commons/conditionals/conditionals.d.ts +360 -10
  8. package/dist/commons/conditionals/validate.d.ts +52 -2
  9. package/dist/commons/events/ActionConfig.d.ts +28 -2
  10. package/dist/commons/events/ActionDocument.d.ts +6 -0
  11. package/dist/commons/events/ActionInput.d.ts +114 -0
  12. package/dist/commons/events/AdvancedSearchConfig.d.ts +342 -0
  13. package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
  14. package/dist/commons/events/Draft.d.ts +4 -2
  15. package/dist/commons/events/EventDocument.d.ts +3 -0
  16. package/dist/commons/events/EventIndex.d.ts +14 -3
  17. package/dist/commons/events/EventMetadata.d.ts +0 -7
  18. package/dist/commons/events/FieldConfig.d.ts +388 -50
  19. package/dist/commons/events/FieldType.d.ts +1 -0
  20. package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
  21. package/dist/commons/events/FieldValue.d.ts +6 -0
  22. package/dist/commons/events/WorkqueueConfig.d.ts +189 -150
  23. package/dist/commons/events/field.d.ts +53 -1
  24. package/dist/commons/events/index.d.ts +2 -0
  25. package/dist/commons/events/locations.d.ts +38 -1
  26. package/dist/commons/events/mocks.test.utils.d.ts +19 -0
  27. package/dist/commons/events/scopes.d.ts +24 -1
  28. package/dist/commons/events/state/flags.d.ts +16 -0
  29. package/dist/commons/events/state/index.d.ts +0 -4
  30. package/dist/commons/events/state/utils.d.ts +12 -289
  31. package/dist/commons/events/utils.d.ts +13 -2
  32. package/dist/conditionals/index.js +92 -9
  33. package/dist/events/index.js +1206 -291
  34. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
  35. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +60 -35
  36. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  37. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  38. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -2
  39. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +9 -1
  40. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -1
  41. package/dist/migrations/v2.0/delete-infrastructure-directory.js +66 -20
  42. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  43. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  44. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  45. package/dist/migrations/v2.0/index.d.ts +5 -3
  46. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  47. package/dist/migrations/v2.0/index.js +546 -176
  48. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
  49. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +90 -1
  50. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +11 -1
  51. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -1
  52. package/dist/migrations/v2.0/merge-infrastructure-directory.js +17 -16
  53. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  54. package/dist/migrations/v2.0/migrate-scopes.js +54 -30
  55. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  56. package/dist/migrations/v2.0/migrate-workqueue-configs.js +140 -59
  57. package/dist/notification/index.js +938 -163
  58. package/dist/scopes/index.d.ts +91 -16
  59. package/dist/scopes/index.js +55 -12
  60. package/opencrvs-toolkit-2.0.0-rc.e25c39b.tgz +0 -0
  61. package/package.json +6 -2
  62. package/tsconfig.tsbuildinfo +1 -1
  63. package/opencrvs-toolkit-2.0.0-rc.e1f588f.tgz +0 -0
@@ -75,7 +75,10 @@ var ActionConditional = z.discriminatedUnion("type", [
75
75
  ShowConditional,
76
76
  // Action can be shown to the user in the list but as disabled
77
77
  EnableConditional
78
- ]);
78
+ ]).meta({
79
+ id: "ActionConditional",
80
+ description: "Conditional gating whether an action is shown (SHOW) or enabled (ENABLE). When omitted from an action, the action is shown and enabled for everyone."
81
+ });
79
82
  var DisplayOnReviewConditional = z.object({
80
83
  type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
81
84
  conditional: Conditional
@@ -90,8 +93,8 @@ var FieldConditional = z.discriminatedUnion("type", [
90
93
  // Field output can be shown / hidden on the review page
91
94
  DisplayOnReviewConditional
92
95
  ]).meta({
93
- description: "Field conditional configuration",
94
- id: "FieldConditional"
96
+ id: "FieldConditional",
97
+ description: "Conditional gating whether a form field is shown (SHOW), enabled (ENABLE), or displayed on the review page (DISPLAY_ON_REVIEW). When omitted, the field is shown and enabled for everyone, and is displayed on review whenever it has a value."
95
98
  });
96
99
 
97
100
  // ../commons/src/events/TranslationConfig.ts
@@ -203,6 +206,11 @@ var FieldTypesToHideInReview = [
203
206
  FieldType.ALPHA_PRINT_BUTTON,
204
207
  FieldType.ALPHA_HIDDEN
205
208
  ];
209
+ var HiddenFieldTypes = [
210
+ FieldType.HTTP,
211
+ FieldType.QUERY_PARAM_READER,
212
+ FieldType.ALPHA_HIDDEN
213
+ ];
206
214
 
207
215
  // ../commons/src/events/FieldValue.ts
208
216
  var z7 = __toESM(require("zod/v4"));
@@ -321,7 +329,7 @@ var PlainDate = import_zod.z.string().date().brand("PlainDate").describe("Date i
321
329
  // ../commons/src/events/FieldValue.ts
322
330
  var TextValue = z7.string();
323
331
  var HiddenFieldValue = z7.string();
324
- var NonEmptyTextValue = TextValue.min(1);
332
+ var NonEmptyTextValue = z7.string().trim().min(1);
325
333
  var DateValue = z7.iso.date().describe("Date in the format YYYY-MM-DD");
326
334
  var AgeValue = z7.object({
327
335
  age: z7.number(),
@@ -350,6 +358,7 @@ var DateRangeFieldValue = z7.object({
350
358
  var EmailValue = z7.email();
351
359
  var CheckboxFieldValue = z7.boolean();
352
360
  var NumberFieldValue = z7.number();
361
+ var SignatureFieldValue = FileFieldValue;
353
362
  var ButtonFieldValue = z7.number();
354
363
  var VerificationStatusValue = z7.enum([
355
364
  "verified",
@@ -418,28 +427,20 @@ function schemaPriority(schema) {
418
427
  return idx === -1 ? 9999 : idx;
419
428
  }
420
429
  function safeUnion(schemas) {
430
+ const sortedSchemas = [...schemas].sort(
431
+ (a, b) => schemaPriority(a) - schemaPriority(b)
432
+ );
421
433
  return z7.any().superRefine((val, ctx) => {
422
- const successful = schemas.filter((s) => s.safeParse(val).success);
423
- if (successful.length === 1) {
424
- return;
425
- }
426
- if (successful.length === 0) {
427
- ctx.addIssue({
428
- code: "invalid_type",
429
- expected: "custom",
430
- message: "Value does not match any schema"
431
- });
432
- return;
433
- }
434
- successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
435
- const best = successful[0];
436
- if (!best.safeParse(val).success) {
437
- ctx.addIssue({
438
- expected: "custom",
439
- code: "invalid_type",
440
- message: "Value did not match the best schema"
441
- });
434
+ for (const schema of sortedSchemas) {
435
+ if (schema.safeParse(val).success) {
436
+ return;
437
+ }
442
438
  }
439
+ ctx.addIssue({
440
+ code: "invalid_type",
441
+ expected: "custom",
442
+ message: "Value does not match any schema"
443
+ });
443
444
  }).meta({
444
445
  description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
445
446
  });
@@ -656,6 +657,10 @@ var scopeByEvent = z11.preprocess(
656
657
  (val) => val === void 0 ? void 0 : [val].flat(),
657
658
  z11.array(z11.string()).optional()
658
659
  ).describe("Event type, e.g. birth, death");
660
+ var userRole = z11.preprocess(
661
+ (val) => val === void 0 ? void 0 : [val].flat(),
662
+ z11.array(z11.string()).optional()
663
+ ).describe("User role, e.g. admin, field agent");
659
664
  var scopeOptionsPlaceEvent = z11.object({
660
665
  event: scopeByEvent,
661
666
  placeOfEvent: JurisdictionFilter.optional()
@@ -679,6 +684,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
679
684
  var AccessLevelOptions = z11.object({
680
685
  accessLevel: JurisdictionFilter.optional()
681
686
  });
687
+ var AllUserScopeOptions = AccessLevelOptions.extend({
688
+ role: userRole.optional()
689
+ });
682
690
  var WorkqueueOrDashboardOptions = z11.object({
683
691
  ids: z11.preprocess(
684
692
  (val) => val === void 0 ? void 0 : [val].flat(),
@@ -688,6 +696,7 @@ var WorkqueueOrDashboardOptions = z11.object({
688
696
  var AllScopeOptions = z11.object({
689
697
  ...AllRecordScopeOptions.shape,
690
698
  ...AccessLevelOptions.shape,
699
+ ...AllUserScopeOptions.shape,
691
700
  ...WorkqueueOrDashboardOptions.shape
692
701
  });
693
702
  var ScopeOptionKey = AllScopeOptions.keyof();
@@ -760,6 +769,30 @@ var RecordScopeV2 = z11.discriminatedUnion("type", [
760
769
  ]).describe(
761
770
  "Scopes used to check user's permission to perform actions on a record."
762
771
  );
772
+ var SystemScopeType = z11.enum([
773
+ "organisation.read-locations",
774
+ "user.read",
775
+ "user.create",
776
+ "user.edit",
777
+ "user.search"
778
+ ]);
779
+ var UserScopeType = SystemScopeType.extract([
780
+ "user.read",
781
+ "user.create",
782
+ "user.edit",
783
+ "user.search"
784
+ ]);
785
+ var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
786
+ var UserScopeV2 = z11.discriminatedUnion("type", [
787
+ z11.object({
788
+ type: ScopesWithRoleOption,
789
+ options: AllUserScopeOptions.optional()
790
+ }),
791
+ z11.object({
792
+ type: UserScopeType.extract(["user.read", "user.search"]),
793
+ options: AccessLevelOptions.optional()
794
+ })
795
+ ]);
763
796
  var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
764
797
  z11.object({
765
798
  type: ScopesWithPlaceEventOptions,
@@ -780,16 +813,14 @@ var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
780
813
  }).optional()
781
814
  })
782
815
  ]).describe("Resolved scope with location/user IDs instead of filters.");
783
- var SystemScopeType = z11.enum([
784
- "organisation.read-locations",
785
- "user.read",
786
- "user.create",
787
- "user.edit"
788
- ]);
789
816
  var Scope = z11.discriminatedUnion("type", [
790
817
  z11.object({ type: PlainScopeType }),
791
818
  ...RecordScopeV2.options,
792
- z11.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
819
+ ...UserScopeV2.options,
820
+ z11.object({
821
+ type: z11.literal("organisation.read-locations"),
822
+ options: AccessLevelOptions.optional()
823
+ }),
793
824
  z11.object({
794
825
  type: z11.literal("workqueue"),
795
826
  options: WorkqueueOrDashboardOptions
@@ -809,7 +840,9 @@ var ScopeType = z11.enum([
809
840
  var EncodedScope = z11.string().brand("EncodedScope");
810
841
  var DEFAULT_SCOPE_OPTIONS = {
811
842
  placeOfEvent: JurisdictionFilter.enum.all,
812
- accessLevel: JurisdictionFilter.enum.all
843
+ accessLevel: JurisdictionFilter.enum.all,
844
+ registeredIn: JurisdictionFilter.enum.all,
845
+ declaredIn: JurisdictionFilter.enum.all
813
846
  };
814
847
 
815
848
  // ../commons/src/authentication.ts
@@ -962,8 +995,9 @@ var RequestedCorrectionAction = ActionBase.extend(
962
995
  var ApprovedCorrectionAction = ActionBase.extend(
963
996
  z13.object({
964
997
  type: z13.literal(ActionType.APPROVE_CORRECTION),
965
- requestId: z13.string()
998
+ requestId: z13.string(),
966
999
  // TODO move into 'content' property
1000
+ content: z13.object({ immediateCorrection: z13.boolean().optional() }).optional()
967
1001
  }).shape
968
1002
  );
969
1003
  var RejectedCorrectionAction = ActionBase.extend(
@@ -1055,6 +1089,9 @@ var FlagConfig = z14.object({
1055
1089
  "Indicates if this flag expects an action to be performed to be cleared."
1056
1090
  ),
1057
1091
  label: TranslationConfig.describe("Human readable label of the flag.")
1092
+ }).meta({
1093
+ id: "FlagConfig",
1094
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1058
1095
  });
1059
1096
  var ActionFlagConfig = z14.object({
1060
1097
  id: Flag,
@@ -1062,6 +1099,9 @@ var ActionFlagConfig = z14.object({
1062
1099
  conditional: Conditional.optional().describe(
1063
1100
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1064
1101
  )
1102
+ }).meta({
1103
+ id: "ActionFlagConfig",
1104
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1065
1105
  });
1066
1106
 
1067
1107
  // ../commons/src/events/EventMetadata.ts
@@ -1083,8 +1123,7 @@ var ActionCreationMetadata = z15.object({
1083
1123
  ),
1084
1124
  createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1085
1125
  acceptedAt: z15.iso.datetime().describe("Timestamp when the action request was accepted."),
1086
- createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation."),
1087
- createdBySignature: z15.string().nullish().describe("Signature of the user who created the action request.")
1126
+ createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation.")
1088
1127
  });
1089
1128
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1090
1129
  registrationNumber: z15.string().describe(
@@ -1112,9 +1151,6 @@ var EventMetadata = z15.object({
1112
1151
  createdAtLocation: UUID.nullish().describe(
1113
1152
  "Location of the user who created the event."
1114
1153
  ),
1115
- createdBySignature: DocumentPath.nullish().describe(
1116
- "Signature of the user who created the event."
1117
- ),
1118
1154
  updatedAtLocation: UUID.nullish().describe(
1119
1155
  "Location of the user who last changed the status."
1120
1156
  ),
@@ -1224,7 +1260,8 @@ var Range = import_v4.z.object({
1224
1260
  });
1225
1261
  var ContainsFlags = import_v4.z.object({
1226
1262
  anyOf: import_v4.z.array(Flag).optional(),
1227
- noneOf: import_v4.z.array(Flag).optional()
1263
+ noneOf: import_v4.z.array(Flag).optional(),
1264
+ allOf: import_v4.z.array(Flag).optional()
1228
1265
  }).meta({
1229
1266
  id: "ContainsFlags"
1230
1267
  });
@@ -1378,14 +1415,31 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1378
1415
  }
1379
1416
  }).describe("Unique identifier for the field");
1380
1417
  var FieldReference = import_v43.default.object({
1381
- $$field: FieldId,
1418
+ $$field: FieldId.describe("Id of the field to reference"),
1382
1419
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1383
1420
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1421
+ ),
1422
+ $$code: import_v43.default.string().optional().describe(
1423
+ "Serialised client-side function body. When present the expression is evaluated rather than dereferenced."
1384
1424
  )
1385
- }).describe("Reference to a field by its ID");
1425
+ }).describe(
1426
+ "Reference to a field value, with an optional client-side computation applied."
1427
+ );
1428
+ var ComputedDefaultValue = import_v43.default.object({
1429
+ $$code: import_v43.default.string().describe(
1430
+ "Serialised client-side function body. Receives (undefined, context) where context includes $now, $online, and system variables."
1431
+ )
1432
+ }).describe("A context-only computation used as a field default value.");
1386
1433
  var ValidationConfig = import_v43.default.object({
1387
- validator: Conditional,
1388
- message: TranslationConfig
1434
+ validator: Conditional.describe(
1435
+ "Conditional expression that must hold for the field value to be considered valid."
1436
+ ),
1437
+ message: TranslationConfig.describe(
1438
+ "Error message displayed when the validator does not hold."
1439
+ )
1440
+ }).meta({
1441
+ id: "ValidationConfig",
1442
+ description: "Validation rule applied to a form field. The validator is a conditional expression that must hold for the field value to be considered valid."
1389
1443
  });
1390
1444
  var requiredSchema = import_v43.default.union([
1391
1445
  import_v43.default.boolean(),
@@ -1416,7 +1470,7 @@ var BaseField = import_v43.default.object({
1416
1470
  "Indicates whether the field can be modified during record correction."
1417
1471
  ),
1418
1472
  value: FieldReference.or(import_v43.default.array(FieldReference)).optional().describe(
1419
- "Reference to the source field or fields. When a value is defined, it is copied from the parent field when changed. If multiple references are provided, the first truthy value is used."
1473
+ "Reference to the source field or fields. When a value is defined, it is copied from the parent field when changed. If multiple references are provided, the first truthy value is used. A FieldReference with $$code computes the value via a custom client-side function."
1420
1474
  ),
1421
1475
  analytics: import_v43.default.boolean().default(false).optional().describe(
1422
1476
  "Indicates whether the field is included in analytics. When enabled, its value becomes available in the analytics dashboard."
@@ -1424,30 +1478,40 @@ var BaseField = import_v43.default.object({
1424
1478
  }).describe("Common properties shared across all field types.");
1425
1479
  var Divider = BaseField.extend({
1426
1480
  type: import_v43.default.literal(FieldType.DIVIDER)
1481
+ }).meta({
1482
+ description: "A horizontal line divider",
1483
+ id: "Divider"
1427
1484
  });
1428
1485
  var TextField = BaseField.extend({
1429
1486
  type: import_v43.default.literal(FieldType.TEXT),
1430
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1487
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1431
1488
  configuration: import_v43.default.object({
1432
1489
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1433
1490
  type: import_v43.default.enum(["text", "password"]).optional(),
1434
1491
  prefix: TranslationConfig.optional(),
1435
1492
  postfix: TranslationConfig.optional()
1436
1493
  }).default({ type: "text" }).optional()
1437
- }).describe("Text input");
1494
+ }).meta({
1495
+ description: "A text input field",
1496
+ id: "TextField"
1497
+ });
1438
1498
  var NumberField = BaseField.extend({
1439
1499
  type: import_v43.default.literal(FieldType.NUMBER),
1440
- defaultValue: NumberFieldValue.optional(),
1500
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1441
1501
  configuration: import_v43.default.object({
1442
1502
  min: import_v43.default.number().optional().describe("Minimum value"),
1443
1503
  max: import_v43.default.number().optional().describe("Maximum value"),
1504
+ integer: import_v43.default.boolean().optional().describe("When true, only whole numbers are allowed"),
1444
1505
  prefix: TranslationConfig.optional(),
1445
1506
  postfix: TranslationConfig.optional()
1446
1507
  }).optional()
1447
- }).describe("Number input");
1508
+ }).meta({
1509
+ description: "A number input field",
1510
+ id: "NumberField"
1511
+ });
1448
1512
  var TextAreaField = BaseField.extend({
1449
1513
  type: import_v43.default.literal(FieldType.TEXTAREA),
1450
- defaultValue: NonEmptyTextValue.optional(),
1514
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1451
1515
  configuration: import_v43.default.object({
1452
1516
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1453
1517
  rows: import_v43.default.number().optional().describe("Number of visible text lines"),
@@ -1455,7 +1519,10 @@ var TextAreaField = BaseField.extend({
1455
1519
  prefix: TranslationConfig.optional(),
1456
1520
  postfix: TranslationConfig.optional()
1457
1521
  }).default({ rows: 4 }).optional()
1458
- }).describe("Multiline text input");
1522
+ }).meta({
1523
+ description: "A multiline text input",
1524
+ id: "TextAreaField"
1525
+ });
1459
1526
  var ImageMimeType = import_v43.default.enum([
1460
1527
  "image/png",
1461
1528
  "image/jpg",
@@ -1478,58 +1545,76 @@ var SignatureField = BaseField.extend({
1478
1545
  signaturePromptLabel: TranslationConfig.describe(
1479
1546
  "Title of the signature modal"
1480
1547
  ),
1481
- defaultValue: FieldValue.optional(),
1548
+ defaultValue: SignatureFieldValue.or(ComputedDefaultValue).optional(),
1482
1549
  configuration: import_v43.default.object({
1483
1550
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1484
1551
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature")
1485
1552
  }).default({
1486
1553
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1487
1554
  })
1488
- }).describe("Signature input field");
1555
+ }).meta({
1556
+ description: "A signature input field",
1557
+ id: "SignatureField"
1558
+ });
1489
1559
  var EmailField = BaseField.extend({
1490
1560
  type: import_v43.default.literal(FieldType.EMAIL),
1491
1561
  configuration: import_v43.default.object({
1492
1562
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1493
1563
  }).default({ maxLength: 255 }).optional(),
1494
- defaultValue: NonEmptyTextValue.optional()
1564
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional()
1565
+ }).meta({
1566
+ description: "An email input field",
1567
+ id: "EmailField"
1495
1568
  });
1496
1569
  var DateField = BaseField.extend({
1497
1570
  type: import_v43.default.literal(FieldType.DATE),
1498
- defaultValue: SerializedNowDateTime.or(PlainDate).optional().describe("Default date value(yyyy-MM-dd)"),
1571
+ defaultValue: SerializedNowDateTime.or(PlainDate).or(ComputedDefaultValue).optional().describe("Default date value(yyyy-MM-dd)"),
1499
1572
  configuration: import_v43.default.object({
1500
1573
  notice: TranslationConfig.describe(
1501
1574
  "Text to display above the date input"
1502
1575
  ).optional()
1503
1576
  }).optional()
1504
- }).describe("A single date input (yyyy-MM-dd)");
1577
+ }).meta({
1578
+ description: "A date input (yyyy-MM-dd)",
1579
+ id: "DateField"
1580
+ });
1505
1581
  var AgeField = BaseField.extend({
1506
1582
  type: import_v43.default.literal(FieldType.AGE),
1507
- defaultValue: NumberFieldValue.optional(),
1583
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1508
1584
  configuration: import_v43.default.object({
1509
1585
  asOfDate: FieldReference,
1510
1586
  prefix: TranslationConfig.optional(),
1511
1587
  postfix: TranslationConfig.optional()
1512
1588
  })
1513
- }).describe("An age input field which uses the current date as the asOfDate");
1589
+ }).meta({
1590
+ description: "An age input field which uses the current date as the asOfDate",
1591
+ id: "AgeField"
1592
+ });
1514
1593
  var TimeField = BaseField.extend({
1515
1594
  type: import_v43.default.literal(FieldType.TIME),
1516
- defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
1595
+ defaultValue: SerializedNowDateTime.or(TimeValue).or(ComputedDefaultValue).optional().describe("Default time value (HH-mm)"),
1517
1596
  configuration: import_v43.default.object({
1518
1597
  use12HourFormat: import_v43.default.boolean().optional().describe("Whether to use 12-hour format"),
1519
1598
  notice: TranslationConfig.describe(
1520
1599
  "Text to display above the time input"
1521
1600
  ).optional()
1522
1601
  }).optional()
1523
- }).describe("A single date input (HH-mm)");
1602
+ }).meta({
1603
+ description: "A single time input (HH-mm)",
1604
+ id: "TimeField"
1605
+ });
1524
1606
  var DateRangeField = BaseField.extend({
1525
1607
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1526
- defaultValue: DateRangeFieldValue.optional(),
1608
+ defaultValue: DateRangeFieldValue.or(ComputedDefaultValue).optional(),
1527
1609
  configuration: import_v43.default.object({
1528
1610
  notice: TranslationConfig.describe(
1529
1611
  "Text to display above the date input"
1530
1612
  ).optional()
1531
1613
  }).optional()
1532
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
1614
+ }).meta({
1615
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
1616
+ id: "DateRangeField"
1617
+ });
1533
1618
  var HtmlFontVariant = import_v43.default.enum([
1534
1619
  "reg12",
1535
1620
  "reg14",
@@ -1573,21 +1658,33 @@ var ImageViewField = BaseField.extend({
1573
1658
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1574
1659
  defaultValue: NonEmptyTextValue.optional(),
1575
1660
  configuration: ImageConfiguration
1576
- }).describe("A read-only image component for form pages");
1661
+ }).meta({
1662
+ description: "A read-only image component for form pages",
1663
+ id: "ImageViewField"
1664
+ });
1577
1665
  var Paragraph = BaseField.extend({
1578
1666
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1579
1667
  configuration: ParagraphConfiguration
1580
- }).describe("A read-only HTML <p> paragraph");
1668
+ }).meta({
1669
+ description: "A read-only HTML <p> paragraph",
1670
+ id: "Paragraph"
1671
+ });
1581
1672
  var Heading = BaseField.extend({
1582
1673
  type: import_v43.default.literal(FieldType.HEADING),
1583
1674
  configuration: HeadingConfiguration
1584
- }).describe("A read-only heading component for form pages");
1675
+ }).meta({
1676
+ description: "A read-only heading component for form pages",
1677
+ id: "Heading"
1678
+ });
1585
1679
  var PageHeader = BaseField.extend({
1586
1680
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1587
- }).describe("A read-only header component for form pages");
1681
+ }).meta({
1682
+ description: "A read-only header component for form pages",
1683
+ id: "PageHeader"
1684
+ });
1588
1685
  var File = BaseField.extend({
1589
1686
  type: import_v43.default.literal(FieldType.FILE),
1590
- defaultValue: FileFieldValue.optional(),
1687
+ defaultValue: FileFieldValue.or(ComputedDefaultValue).optional(),
1591
1688
  configuration: import_v43.default.object({
1592
1689
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1593
1690
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature"),
@@ -1603,7 +1700,10 @@ var File = BaseField.extend({
1603
1700
  }).default({
1604
1701
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1605
1702
  })
1606
- }).describe("File upload");
1703
+ }).meta({
1704
+ description: "A file upload field",
1705
+ id: "File"
1706
+ });
1607
1707
  var SelectOption = import_v43.default.object({
1608
1708
  value: import_v43.default.string().describe("The value of the option"),
1609
1709
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1611,7 +1711,7 @@ var SelectOption = import_v43.default.object({
1611
1711
  });
1612
1712
  var NumberWithUnitField = BaseField.extend({
1613
1713
  type: import_v43.default.literal(FieldType.NUMBER_WITH_UNIT),
1614
- defaultValue: NumberWithUnitFieldValue.optional(),
1714
+ defaultValue: NumberWithUnitFieldValue.or(ComputedDefaultValue).optional(),
1615
1715
  options: import_v43.default.array(SelectOption).describe("A list of options for the unit select"),
1616
1716
  configuration: import_v43.default.object({
1617
1717
  min: import_v43.default.number().optional().describe("Minimum value of the number field"),
@@ -1620,17 +1720,23 @@ var NumberWithUnitField = BaseField.extend({
1620
1720
  "Placeholder for the number field"
1621
1721
  )
1622
1722
  }).optional()
1623
- }).describe("Number with unit input");
1723
+ }).meta({
1724
+ description: "A number with unit input field",
1725
+ id: "NumberWithUnitField"
1726
+ });
1624
1727
  var RadioGroup = BaseField.extend({
1625
1728
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1626
- defaultValue: TextValue.optional(),
1729
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1627
1730
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1628
1731
  configuration: import_v43.default.object({
1629
1732
  styles: import_v43.default.object({
1630
1733
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1631
1734
  }).optional()
1632
1735
  }).optional()
1633
- }).describe("Grouped radio options");
1736
+ }).meta({
1737
+ description: "A grouped radio button field",
1738
+ id: "RadioGroup"
1739
+ });
1634
1740
  var BulletList = BaseField.extend({
1635
1741
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1636
1742
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1639,10 +1745,13 @@ var BulletList = BaseField.extend({
1639
1745
  fontVariant: HtmlFontVariant.optional()
1640
1746
  }).optional()
1641
1747
  }).default({})
1642
- }).describe("A list of bullet points");
1748
+ }).meta({
1749
+ description: "A list of bullet points",
1750
+ id: "BulletList"
1751
+ });
1643
1752
  var Select = BaseField.extend({
1644
1753
  type: import_v43.default.literal(FieldType.SELECT),
1645
- defaultValue: TextValue.optional(),
1754
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1646
1755
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1647
1756
  noOptionsMessage: TranslationConfig.optional().describe(
1648
1757
  `
@@ -1654,16 +1763,22 @@ var Select = BaseField.extend({
1654
1763
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1655
1764
  `
1656
1765
  )
1657
- }).describe("Select input");
1766
+ }).meta({
1767
+ description: "A select input field",
1768
+ id: "Select"
1769
+ });
1658
1770
  var SelectDateRangeOption = import_v43.default.object({
1659
1771
  value: SelectDateRangeValue.describe("The value of the option"),
1660
1772
  label: TranslationConfig.describe("The label of the option")
1661
1773
  });
1662
1774
  var SelectDateRangeField = BaseField.extend({
1663
1775
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1664
- defaultValue: SelectDateRangeValue.optional(),
1776
+ defaultValue: SelectDateRangeValue.or(ComputedDefaultValue).optional(),
1665
1777
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1666
- }).describe("Select input with date range options");
1778
+ }).meta({
1779
+ description: "A date range selection field",
1780
+ id: "SelectDateRangeField"
1781
+ });
1667
1782
  var NameConfig = import_v43.default.object({
1668
1783
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1669
1784
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1675,7 +1790,7 @@ var NameField = BaseField.extend({
1675
1790
  firstname: SerializedUserField.or(NonEmptyTextValue).optional(),
1676
1791
  middlename: SerializedUserField.or(NonEmptyTextValue).optional(),
1677
1792
  surname: SerializedUserField.or(NonEmptyTextValue).optional()
1678
- }).optional(),
1793
+ }).or(ComputedDefaultValue).optional(),
1679
1794
  configuration: import_v43.default.object({
1680
1795
  name: NameConfig.default({
1681
1796
  firstname: { required: true },
@@ -1694,26 +1809,41 @@ var NameField = BaseField.extend({
1694
1809
  surname: { required: true }
1695
1810
  }
1696
1811
  }).optional()
1697
- }).describe("Name input field");
1812
+ }).meta({
1813
+ description: "A field for entering a persons name",
1814
+ id: "NameField"
1815
+ });
1698
1816
  var PhoneField = BaseField.extend({
1699
- defaultValue: NonEmptyTextValue.optional(),
1817
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1700
1818
  type: import_v43.default.literal(FieldType.PHONE)
1701
- }).describe("Phone input field");
1819
+ }).meta({
1820
+ description: "A field for entering a phone number",
1821
+ id: "PhoneField"
1822
+ });
1702
1823
  var IdField = BaseField.extend({
1703
- defaultValue: NonEmptyTextValue.optional(),
1824
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1704
1825
  type: import_v43.default.literal(FieldType.ID)
1705
- }).describe("ID input field");
1826
+ }).meta({
1827
+ description: "A field for entering an ID",
1828
+ id: "IdField"
1829
+ });
1706
1830
  var Checkbox = BaseField.extend({
1707
1831
  type: import_v43.default.literal(FieldType.CHECKBOX),
1708
- defaultValue: CheckboxFieldValue.default(false)
1709
- }).describe("Boolean checkbox field");
1832
+ defaultValue: CheckboxFieldValue.or(ComputedDefaultValue).default(false)
1833
+ }).meta({
1834
+ description: "A boolean checkbox field",
1835
+ id: "Checkbox"
1836
+ });
1710
1837
  var Country = BaseField.extend({
1711
1838
  type: import_v43.default.literal(FieldType.COUNTRY),
1712
- defaultValue: NonEmptyTextValue.optional(),
1839
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1713
1840
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1714
1841
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1715
1842
  )
1716
- }).describe("Country select field");
1843
+ }).meta({
1844
+ description: "A field for selecting a country",
1845
+ id: "Country"
1846
+ });
1717
1847
  var AllowedLocations = JurisdictionReference.optional().describe(
1718
1848
  "Limits which location options are selectable depending on user jurisdiction and location."
1719
1849
  );
@@ -1722,28 +1852,33 @@ var AdministrativeAreas = import_v43.default.enum([
1722
1852
  "HEALTH_FACILITY",
1723
1853
  "CRVS_OFFICE"
1724
1854
  ]);
1725
- var AdministrativeAreaConfiguration = import_v43.default.object({
1726
- partOf: FieldReference.optional().describe("Parent location"),
1727
- type: AdministrativeAreas,
1728
- allowedLocations: AllowedLocations
1729
- }).describe("Administrative area options");
1730
1855
  var AdministrativeAreaField = BaseField.extend({
1731
1856
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1732
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1733
- configuration: AdministrativeAreaConfiguration
1734
- }).describe("Administrative area input field e.g. facility, office");
1857
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1858
+ configuration: import_v43.default.object({
1859
+ partOf: FieldReference.optional().describe("Parent location"),
1860
+ type: AdministrativeAreas,
1861
+ allowedLocations: AllowedLocations
1862
+ }).describe("Administrative area options")
1863
+ }).meta({
1864
+ description: "Administrative area input field",
1865
+ id: "AdministrativeAreaField"
1866
+ });
1735
1867
  var LocationInput = BaseField.extend({
1736
1868
  type: import_v43.default.literal(FieldType.LOCATION),
1737
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1869
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1738
1870
  configuration: import_v43.default.object({
1739
1871
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1740
1872
  allowedLocations: AllowedLocations
1741
1873
  }).optional()
1742
- }).describe("Input field for a location");
1874
+ }).meta({
1875
+ description: "A field for selecting a location",
1876
+ id: "LocationInput"
1877
+ });
1743
1878
  var FileUploadWithOptions = BaseField.extend({
1744
1879
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1745
1880
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1746
- defaultValue: FileFieldWithOptionValue.optional(),
1881
+ defaultValue: FileFieldWithOptionValue.or(ComputedDefaultValue).optional(),
1747
1882
  configuration: import_v43.default.object({
1748
1883
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1749
1884
  maxImageSize: import_v43.default.object({
@@ -1753,15 +1888,18 @@ var FileUploadWithOptions = BaseField.extend({
1753
1888
  }).default({
1754
1889
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1755
1890
  })
1891
+ }).meta({
1892
+ description: "A field for uploading files with file type options",
1893
+ id: "FileUploadWithOptions"
1756
1894
  });
1757
1895
  var Facility = BaseField.extend({
1758
1896
  type: import_v43.default.literal(FieldType.FACILITY),
1759
- defaultValue: NonEmptyTextValue.optional(),
1897
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1760
1898
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1761
1899
  }).describe("Input field for a facility");
1762
1900
  var Office = BaseField.extend({
1763
1901
  type: import_v43.default.literal(FieldType.OFFICE),
1764
- defaultValue: NonEmptyTextValue.optional(),
1902
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1765
1903
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1766
1904
  }).describe("Input field for an office");
1767
1905
  var DefaultAddressFieldValue = DomesticAddressFieldValue.extend({
@@ -1797,8 +1935,11 @@ var Address = BaseField.extend({
1797
1935
  ).optional(),
1798
1936
  allowedLocations: AllowedLocations
1799
1937
  }).optional(),
1800
- defaultValue: DefaultAddressFieldValue.optional()
1801
- }).describe("Address input field \u2013 a combination of location and text fields");
1938
+ defaultValue: DefaultAddressFieldValue.or(ComputedDefaultValue).optional()
1939
+ }).meta({
1940
+ description: "Address input field \u2013 a combination of location and text fields",
1941
+ id: "Address"
1942
+ });
1802
1943
  var StaticDataEntry = import_v43.default.object({
1803
1944
  id: import_v43.default.string().describe("ID for the data entry."),
1804
1945
  label: TranslationConfig,
@@ -1813,7 +1954,10 @@ var DataField = BaseField.extend({
1813
1954
  subtitle: TranslationConfig.optional(),
1814
1955
  data: import_v43.default.array(DataEntry)
1815
1956
  })
1816
- }).describe("Data field for displaying read-only data");
1957
+ }).meta({
1958
+ description: "A field for displaying a table of read-only data",
1959
+ id: "DataField"
1960
+ });
1817
1961
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1818
1962
  var ButtonType = import_v43.default.enum([
1819
1963
  "primary",
@@ -1838,13 +1982,19 @@ var ButtonConfiguration = import_v43.default.object({
1838
1982
  });
1839
1983
  var ButtonField = BaseField.extend({
1840
1984
  type: import_v43.default.literal(FieldType.BUTTON),
1841
- defaultValue: ButtonFieldValue.optional(),
1985
+ defaultValue: ButtonFieldValue.or(ComputedDefaultValue).optional(),
1842
1986
  configuration: ButtonConfiguration
1843
- }).describe("Generic button without any built-in functionality");
1987
+ }).meta({
1988
+ description: "A generic button that can be used to trigger an action",
1989
+ id: "ButtonField"
1990
+ });
1844
1991
  var FieldGroup = BaseField.extend({
1845
1992
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1846
1993
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1847
1994
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
1995
+ }).meta({
1996
+ description: "A group of fields that are displayed together",
1997
+ id: "FieldGroup"
1848
1998
  });
1849
1999
  var AlphaPrintButton = BaseField.extend({
1850
2000
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1854,10 +2004,13 @@ var AlphaPrintButton = BaseField.extend({
1854
2004
  "Label for the print button"
1855
2005
  )
1856
2006
  })
1857
- }).describe("Print button field for printing certificates");
2007
+ }).meta({
2008
+ description: "An experimental print button field for printing certificates during the declaration process",
2009
+ id: "AlphaPrintButton"
2010
+ });
1858
2011
  var HttpField = BaseField.extend({
1859
2012
  type: import_v43.default.literal(FieldType.HTTP),
1860
- defaultValue: HttpFieldValue.optional(),
2013
+ defaultValue: HttpFieldValue.or(ComputedDefaultValue).optional(),
1861
2014
  configuration: import_v43.default.object({
1862
2015
  trigger: FieldReference.optional().describe(
1863
2016
  "Reference to the field that triggers the HTTP request when its value changes. If not provided, the HTTP request is triggered once on component mount."
@@ -1870,20 +2023,30 @@ var HttpField = BaseField.extend({
1870
2023
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1871
2024
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1872
2025
  })
1873
- }).describe("HTTP request function triggered by a button click or other event");
2026
+ }).meta({
2027
+ description: "Makes a background HTTP request to an external service and stores the response so other fields can use it. Has no visible UI \u2014 pair with LOADER to show request status.",
2028
+ id: "HttpField"
2029
+ });
1874
2030
  var AutocompleteField = BaseField.extend({
1875
2031
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1876
2032
  configuration: import_v43.default.object({
1877
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2033
+ url: import_v43.default.string().describe(
2034
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2035
+ ).optional(),
1878
2036
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1879
2037
  defaultOptions: import_v43.default.array(
1880
2038
  import_v43.default.object({
1881
2039
  label: import_v43.default.string(),
1882
2040
  value: import_v43.default.string()
1883
2041
  })
1884
- ).optional()
2042
+ ).optional().describe(
2043
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2044
+ )
1885
2045
  })
1886
- }).describe("Autocomplete input field");
2046
+ }).meta({
2047
+ description: "Generic autocomplete component designed for use with large dictionary-based datasets. The component supports dynamic retrieval of options from configurable data sources and is intended for datasets that may contain tens or hundreds of thousands of records.",
2048
+ id: "AutocompleteField"
2049
+ });
1887
2050
  var SearchField = HttpField.extend({
1888
2051
  type: import_v43.default.literal(FieldType.SEARCH),
1889
2052
  configuration: SearchQuery.pick({
@@ -1916,6 +2079,9 @@ var SearchField = HttpField.extend({
1916
2079
  ok: TranslationConfig.optional()
1917
2080
  }).optional()
1918
2081
  })
2082
+ }).meta({
2083
+ description: "A search input field",
2084
+ id: "SearchField"
1919
2085
  });
1920
2086
  var LinkButtonField = BaseField.extend({
1921
2087
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1924,28 +2090,35 @@ var LinkButtonField = BaseField.extend({
1924
2090
  text: TranslationConfig.describe("Text to display on the button"),
1925
2091
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1926
2092
  })
1927
- }).describe("Button that opens a link");
2093
+ }).meta({
2094
+ description: "A button that opens a URL link",
2095
+ id: "LinkButtonField"
2096
+ });
1928
2097
  var VerificationStatus = BaseField.extend({
1929
2098
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1930
- defaultValue: VerificationStatusValue.optional(),
2099
+ defaultValue: VerificationStatusValue.or(ComputedDefaultValue).optional(),
1931
2100
  configuration: import_v43.default.object({
1932
2101
  status: TranslationConfig.describe("Text to display on the status pill."),
1933
2102
  description: TranslationConfig.describe(
1934
2103
  "Explaining text on the banner in form."
1935
2104
  )
1936
2105
  })
2106
+ }).meta({
2107
+ description: "Displays a verification state (e.g. ID verified / pending). Often paired with ID_READER \u2014 it can read its value off an ID_READER rather than holding its own.",
2108
+ id: "VerificationStatus"
1937
2109
  });
1938
2110
  var QueryParamReaderField = BaseField.extend({
1939
2111
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1940
2112
  configuration: import_v43.default.object({
1941
2113
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1942
2114
  })
1943
- }).describe(
1944
- "A field that maps URL query params into form values and clears them afterward"
1945
- );
2115
+ }).meta({
2116
+ description: "A field that maps URL query params into form values and clears them afterward",
2117
+ id: "QueryParamReaderField"
2118
+ });
1946
2119
  var QrReaderField = BaseField.extend({
1947
2120
  type: import_v43.default.literal(FieldType.QR_READER),
1948
- defaultValue: QrReaderFieldValue.optional(),
2121
+ defaultValue: QrReaderFieldValue.or(ComputedDefaultValue).optional(),
1949
2122
  configuration: import_v43.default.object({
1950
2123
  validator: import_v43.default.any().meta({
1951
2124
  description: "JSON Schema to validate the scanned QR code data against before populating the form fields.",
@@ -1953,21 +2126,27 @@ var QrReaderField = BaseField.extend({
1953
2126
  })
1954
2127
  }).optional()
1955
2128
  }).meta({
1956
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2129
+ description: "QR code reader field, including optional JSON Schema validator.",
1957
2130
  id: "QrReaderField"
1958
2131
  });
1959
2132
  var IdReaderField = BaseField.extend({
1960
2133
  type: import_v43.default.literal(FieldType.ID_READER),
1961
- defaultValue: IdReaderFieldValue.optional(),
2134
+ defaultValue: IdReaderFieldValue.or(ComputedDefaultValue).optional(),
1962
2135
  methods: import_v43.default.array(
1963
2136
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1964
2137
  )
2138
+ }).meta({
2139
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2140
+ id: "IdReaderField"
1965
2141
  });
1966
2142
  var CustomField = BaseField.extend({
1967
2143
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1968
2144
  defaultValue: CustomFieldValue.optional(),
1969
2145
  src: import_v43.default.string().describe("Module source path for the custom field component"),
1970
2146
  configuration: import_v43.default.unknown().optional()
2147
+ }).meta({
2148
+ description: "An expiremental custom field that is defined by a module source path",
2149
+ id: "CustomField"
1971
2150
  });
1972
2151
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
1973
2152
  var LoaderField = BaseField.extend({
@@ -1977,22 +2156,25 @@ var LoaderField = BaseField.extend({
1977
2156
  configuration: import_v43.default.object({
1978
2157
  text: TranslationConfig.describe("Display text above the loading spinner")
1979
2158
  })
1980
- }).describe(
1981
- "A non-interactive field that indicates an in progress operation in form"
1982
- );
2159
+ }).meta({
2160
+ description: "A non-interactive field that indicates an in progress operation in form",
2161
+ id: "LoaderField"
2162
+ });
1983
2163
  var HiddenField = BaseField.extend({
1984
2164
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
1985
2165
  required: import_v43.default.boolean().default(false).optional(),
1986
2166
  defaultValue: TextValue.optional()
1987
- }).describe(
1988
- "A non-interactive, hidden field that only hold a value in the form"
1989
- );
2167
+ }).meta({
2168
+ description: "A non-interactive, hidden field that only hold a value in the form",
2169
+ id: "HiddenField"
2170
+ });
1990
2171
  var UserRoleField = BaseField.extend({
1991
2172
  type: import_v43.default.literal(FieldType.USER_ROLE),
1992
2173
  defaultValue: TextValue.optional()
1993
- }).describe(
1994
- "A select dropdown that is automatically populated with available user roles"
1995
- );
2174
+ }).meta({
2175
+ description: "A select dropdown that is automatically populated with available user roles",
2176
+ id: "UserRoleField"
2177
+ });
1996
2178
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
1997
2179
  FieldGroup,
1998
2180
  Address,
@@ -2078,8 +2260,8 @@ var ApplicationConfig = z20.object({
2078
2260
  })
2079
2261
  ),
2080
2262
  PHONE_NUMBER_PATTERN: z20.string().or(z20.instanceof(RegExp)),
2081
- USER_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2082
- INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2263
+ USER_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2264
+ INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2083
2265
  SEARCH_DEFAULT_CRITERIA: SearchCriteria.optional().default("TRACKING_ID"),
2084
2266
  ADDITIONAL_USER_FIELDS: z20.array(FieldConfig).optional().default([])
2085
2267
  });
@@ -2097,8 +2279,8 @@ var BackgroundConfig = z20.object({
2097
2279
  var LoginConfig = z20.object({
2098
2280
  COUNTRY: z20.string(),
2099
2281
  LANGUAGES: z20.array(z20.string()),
2100
- USER_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2101
- INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2282
+ USER_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2283
+ INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2102
2284
  PHONE_NUMBER_PATTERN: z20.string().or(z20.instanceof(RegExp)),
2103
2285
  LOGIN_BACKGROUND: BackgroundConfig,
2104
2286
  SENTRY: z20.string().optional()
@@ -2110,6 +2292,7 @@ var ClientConfig = z20.object({
2110
2292
  COUNTRY: z20.string(),
2111
2293
  LANGUAGES: z20.array(z20.string()),
2112
2294
  SENTRY: z20.string().optional(),
2295
+ LOGIN_URL: z20.string().optional(),
2113
2296
  REGISTER_BACKGROUND: BackgroundConfig,
2114
2297
  DASHBOARDS: z20.array(
2115
2298
  z20.object({