@opencrvs/toolkit 2.0.0-rc.eac601e → 2.0.0-rc.eade8c4

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 (97) 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 +259 -96
  4. package/dist/cli.js +1952 -347
  5. package/dist/commons/api/router.d.ts +3366 -300
  6. package/dist/commons/application-config/index.d.ts +16 -4
  7. package/dist/commons/conditionals/conditionals.d.ts +6 -6
  8. package/dist/commons/conditionals/validate.d.ts +1 -0
  9. package/dist/commons/events/ActionInput.d.ts +108 -0
  10. package/dist/commons/events/Draft.d.ts +4 -2
  11. package/dist/commons/events/EventIndex.d.ts +0 -3
  12. package/dist/commons/events/EventMetadata.d.ts +0 -7
  13. package/dist/commons/events/FieldConfig.d.ts +10 -0
  14. package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
  15. package/dist/commons/events/index.d.ts +1 -0
  16. package/dist/commons/events/locations.d.ts +38 -1
  17. package/dist/commons/events/mocks.test.utils.d.ts +19 -0
  18. package/dist/commons/events/scopes.d.ts +24 -1
  19. package/dist/commons/events/state/index.d.ts +0 -4
  20. package/dist/commons/events/state/utils.d.ts +0 -2
  21. package/dist/commons/events/utils.d.ts +1 -1
  22. package/dist/conditionals/index.js +40 -8
  23. package/dist/events/index.js +799 -154
  24. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
  25. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +63 -39
  26. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts +3 -0
  27. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts.map +1 -0
  28. package/dist/migrations/v2.0/add-resend-invite-notification.js +373 -0
  29. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +19 -0
  30. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  31. package/dist/migrations/v2.0/checkout-upstream-files.js +17 -14
  32. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts.map +1 -1
  33. package/dist/migrations/v2.0/convert-config-files-to-ts.js +4 -5
  34. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts.map +1 -1
  35. package/dist/migrations/v2.0/convert-paragraph-to-heading.js +4 -5
  36. package/dist/migrations/v2.0/create-events-index.d.ts.map +1 -1
  37. package/dist/migrations/v2.0/create-events-index.js +1 -2
  38. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +11 -0
  39. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -0
  40. package/dist/migrations/v2.0/delete-infrastructure-directory.js +123 -0
  41. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  42. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  43. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  44. package/dist/migrations/v2.0/index.d.ts +10 -4
  45. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  46. package/dist/migrations/v2.0/index.js +1920 -344
  47. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
  48. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +95 -7
  49. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +13 -0
  50. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -0
  51. package/dist/migrations/v2.0/merge-infrastructure-directory.js +222 -0
  52. package/dist/migrations/v2.0/migrate-application-config-url.d.ts +3 -0
  53. package/dist/migrations/v2.0/migrate-application-config-url.d.ts.map +1 -0
  54. package/dist/migrations/v2.0/migrate-application-config-url.js +342 -0
  55. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  56. package/dist/migrations/v2.0/migrate-scopes.js +55 -32
  57. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts.map +1 -1
  58. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.js +3 -4
  59. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  60. package/dist/migrations/v2.0/migrate-workqueue-configs.js +143 -63
  61. package/dist/migrations/v2.0/remove-delete-actions.d.ts.map +1 -1
  62. package/dist/migrations/v2.0/remove-delete-actions.js +3 -4
  63. package/dist/migrations/v2.0/remove-demo-scope.d.ts.map +1 -1
  64. package/dist/migrations/v2.0/remove-demo-scope.js +2 -3
  65. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts.map +1 -1
  66. package/dist/migrations/v2.0/remove-deprecated-imports.js +3 -4
  67. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts +3 -0
  68. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts.map +1 -0
  69. package/dist/migrations/v2.0/remove-fhir-url-helpers.js +163 -0
  70. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts.map +1 -1
  71. package/dist/migrations/v2.0/remove-hearth-migrations.js +1 -2
  72. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts +3 -0
  73. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts.map +1 -0
  74. package/dist/migrations/v2.0/remove-old-statistics-service.js +356 -0
  75. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts.map +1 -1
  76. package/dist/migrations/v2.0/remove-pending-certification-flag.js +3 -4
  77. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts.map +1 -1
  78. package/dist/migrations/v2.0/remove-review-from-register-action.js +3 -4
  79. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts +3 -0
  80. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts.map +1 -0
  81. package/dist/migrations/v2.0/remove-unused-environment-variables.js +186 -0
  82. package/dist/migrations/v2.0/rename-api-paths.d.ts.map +1 -1
  83. package/dist/migrations/v2.0/rename-api-paths.js +3 -4
  84. package/dist/migrations/v2.0/rename-location-parent-id.d.ts.map +1 -1
  85. package/dist/migrations/v2.0/rename-location-parent-id.js +3 -4
  86. package/dist/migrations/v2.0/simplify-analytics-precalculations.d.ts.map +1 -1
  87. package/dist/migrations/v2.0/simplify-analytics-precalculations.js +1 -2
  88. package/dist/migrations/v2.0/update-package-json.d.ts +3 -0
  89. package/dist/migrations/v2.0/update-package-json.d.ts.map +1 -0
  90. package/dist/migrations/v2.0/update-package-json.js +105 -0
  91. package/dist/notification/index.js +689 -124
  92. package/dist/scopes/index.d.ts +87 -10
  93. package/dist/scopes/index.js +46 -9
  94. package/opencrvs-toolkit-2.0.0-rc.eade8c4.tgz +0 -0
  95. package/package.json +6 -2
  96. package/tsconfig.tsbuildinfo +1 -1
  97. package/opencrvs-toolkit-2.0.0-rc.eac601e.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
@@ -418,28 +421,20 @@ function schemaPriority(schema) {
418
421
  return idx === -1 ? 9999 : idx;
419
422
  }
420
423
  function safeUnion(schemas) {
424
+ const sortedSchemas = [...schemas].sort(
425
+ (a, b) => schemaPriority(a) - schemaPriority(b)
426
+ );
421
427
  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
- });
428
+ for (const schema of sortedSchemas) {
429
+ if (schema.safeParse(val).success) {
430
+ return;
431
+ }
442
432
  }
433
+ ctx.addIssue({
434
+ code: "invalid_type",
435
+ expected: "custom",
436
+ message: "Value does not match any schema"
437
+ });
443
438
  }).meta({
444
439
  description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
445
440
  });
@@ -656,6 +651,10 @@ var scopeByEvent = z11.preprocess(
656
651
  (val) => val === void 0 ? void 0 : [val].flat(),
657
652
  z11.array(z11.string()).optional()
658
653
  ).describe("Event type, e.g. birth, death");
654
+ var userRole = z11.preprocess(
655
+ (val) => val === void 0 ? void 0 : [val].flat(),
656
+ z11.array(z11.string()).optional()
657
+ ).describe("User role, e.g. admin, field agent");
659
658
  var scopeOptionsPlaceEvent = z11.object({
660
659
  event: scopeByEvent,
661
660
  placeOfEvent: JurisdictionFilter.optional()
@@ -679,6 +678,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
679
678
  var AccessLevelOptions = z11.object({
680
679
  accessLevel: JurisdictionFilter.optional()
681
680
  });
681
+ var AllUserScopeOptions = AccessLevelOptions.extend({
682
+ role: userRole.optional()
683
+ });
682
684
  var WorkqueueOrDashboardOptions = z11.object({
683
685
  ids: z11.preprocess(
684
686
  (val) => val === void 0 ? void 0 : [val].flat(),
@@ -688,6 +690,7 @@ var WorkqueueOrDashboardOptions = z11.object({
688
690
  var AllScopeOptions = z11.object({
689
691
  ...AllRecordScopeOptions.shape,
690
692
  ...AccessLevelOptions.shape,
693
+ ...AllUserScopeOptions.shape,
691
694
  ...WorkqueueOrDashboardOptions.shape
692
695
  });
693
696
  var ScopeOptionKey = AllScopeOptions.keyof();
@@ -760,6 +763,30 @@ var RecordScopeV2 = z11.discriminatedUnion("type", [
760
763
  ]).describe(
761
764
  "Scopes used to check user's permission to perform actions on a record."
762
765
  );
766
+ var SystemScopeType = z11.enum([
767
+ "organisation.read-locations",
768
+ "user.read",
769
+ "user.create",
770
+ "user.edit",
771
+ "user.search"
772
+ ]);
773
+ var UserScopeType = SystemScopeType.extract([
774
+ "user.read",
775
+ "user.create",
776
+ "user.edit",
777
+ "user.search"
778
+ ]);
779
+ var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
780
+ var UserScopeV2 = z11.discriminatedUnion("type", [
781
+ z11.object({
782
+ type: ScopesWithRoleOption,
783
+ options: AllUserScopeOptions.optional()
784
+ }),
785
+ z11.object({
786
+ type: UserScopeType.extract(["user.read", "user.search"]),
787
+ options: AccessLevelOptions.optional()
788
+ })
789
+ ]);
763
790
  var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
764
791
  z11.object({
765
792
  type: ScopesWithPlaceEventOptions,
@@ -780,16 +807,14 @@ var ResolvedRecordScopeV2 = z11.discriminatedUnion("type", [
780
807
  }).optional()
781
808
  })
782
809
  ]).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
810
  var Scope = z11.discriminatedUnion("type", [
790
811
  z11.object({ type: PlainScopeType }),
791
812
  ...RecordScopeV2.options,
792
- z11.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
813
+ ...UserScopeV2.options,
814
+ z11.object({
815
+ type: z11.literal("organisation.read-locations"),
816
+ options: AccessLevelOptions.optional()
817
+ }),
793
818
  z11.object({
794
819
  type: z11.literal("workqueue"),
795
820
  options: WorkqueueOrDashboardOptions
@@ -809,7 +834,9 @@ var ScopeType = z11.enum([
809
834
  var EncodedScope = z11.string().brand("EncodedScope");
810
835
  var DEFAULT_SCOPE_OPTIONS = {
811
836
  placeOfEvent: JurisdictionFilter.enum.all,
812
- accessLevel: JurisdictionFilter.enum.all
837
+ accessLevel: JurisdictionFilter.enum.all,
838
+ registeredIn: JurisdictionFilter.enum.all,
839
+ declaredIn: JurisdictionFilter.enum.all
813
840
  };
814
841
 
815
842
  // ../commons/src/authentication.ts
@@ -1055,6 +1082,9 @@ var FlagConfig = z14.object({
1055
1082
  "Indicates if this flag expects an action to be performed to be cleared."
1056
1083
  ),
1057
1084
  label: TranslationConfig.describe("Human readable label of the flag.")
1085
+ }).meta({
1086
+ id: "FlagConfig",
1087
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1058
1088
  });
1059
1089
  var ActionFlagConfig = z14.object({
1060
1090
  id: Flag,
@@ -1062,6 +1092,9 @@ var ActionFlagConfig = z14.object({
1062
1092
  conditional: Conditional.optional().describe(
1063
1093
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1064
1094
  )
1095
+ }).meta({
1096
+ id: "ActionFlagConfig",
1097
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1065
1098
  });
1066
1099
 
1067
1100
  // ../commons/src/events/EventMetadata.ts
@@ -1083,8 +1116,7 @@ var ActionCreationMetadata = z15.object({
1083
1116
  ),
1084
1117
  createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1085
1118
  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.")
1119
+ createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation.")
1088
1120
  });
1089
1121
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1090
1122
  registrationNumber: z15.string().describe(
@@ -1112,9 +1144,6 @@ var EventMetadata = z15.object({
1112
1144
  createdAtLocation: UUID.nullish().describe(
1113
1145
  "Location of the user who created the event."
1114
1146
  ),
1115
- createdBySignature: DocumentPath.nullish().describe(
1116
- "Signature of the user who created the event."
1117
- ),
1118
1147
  updatedAtLocation: UUID.nullish().describe(
1119
1148
  "Location of the user who last changed the status."
1120
1149
  ),
@@ -1378,14 +1407,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1378
1407
  }
1379
1408
  }).describe("Unique identifier for the field");
1380
1409
  var FieldReference = import_v43.default.object({
1381
- $$field: FieldId,
1410
+ $$field: FieldId.describe("Id of the field to reference"),
1382
1411
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1383
1412
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1384
1413
  )
1385
1414
  }).describe("Reference to a field by its ID");
1386
1415
  var ValidationConfig = import_v43.default.object({
1387
- validator: Conditional,
1388
- message: TranslationConfig
1416
+ validator: Conditional.describe(
1417
+ "Conditional expression that must hold for the field value to be considered valid."
1418
+ ),
1419
+ message: TranslationConfig.describe(
1420
+ "Error message displayed when the validator does not hold."
1421
+ )
1422
+ }).meta({
1423
+ id: "ValidationConfig",
1424
+ 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
1425
  });
1390
1426
  var requiredSchema = import_v43.default.union([
1391
1427
  import_v43.default.boolean(),
@@ -1424,6 +1460,9 @@ var BaseField = import_v43.default.object({
1424
1460
  }).describe("Common properties shared across all field types.");
1425
1461
  var Divider = BaseField.extend({
1426
1462
  type: import_v43.default.literal(FieldType.DIVIDER)
1463
+ }).meta({
1464
+ description: "A horizontal line divider",
1465
+ id: "Divider"
1427
1466
  });
1428
1467
  var TextField = BaseField.extend({
1429
1468
  type: import_v43.default.literal(FieldType.TEXT),
@@ -1434,7 +1473,10 @@ var TextField = BaseField.extend({
1434
1473
  prefix: TranslationConfig.optional(),
1435
1474
  postfix: TranslationConfig.optional()
1436
1475
  }).default({ type: "text" }).optional()
1437
- }).describe("Text input");
1476
+ }).meta({
1477
+ description: "A text input field",
1478
+ id: "TextField"
1479
+ });
1438
1480
  var NumberField = BaseField.extend({
1439
1481
  type: import_v43.default.literal(FieldType.NUMBER),
1440
1482
  defaultValue: NumberFieldValue.optional(),
@@ -1444,7 +1486,10 @@ var NumberField = BaseField.extend({
1444
1486
  prefix: TranslationConfig.optional(),
1445
1487
  postfix: TranslationConfig.optional()
1446
1488
  }).optional()
1447
- }).describe("Number input");
1489
+ }).meta({
1490
+ description: "A number input field",
1491
+ id: "NumberField"
1492
+ });
1448
1493
  var TextAreaField = BaseField.extend({
1449
1494
  type: import_v43.default.literal(FieldType.TEXTAREA),
1450
1495
  defaultValue: NonEmptyTextValue.optional(),
@@ -1455,7 +1500,10 @@ var TextAreaField = BaseField.extend({
1455
1500
  prefix: TranslationConfig.optional(),
1456
1501
  postfix: TranslationConfig.optional()
1457
1502
  }).default({ rows: 4 }).optional()
1458
- }).describe("Multiline text input");
1503
+ }).meta({
1504
+ description: "A multiline text input",
1505
+ id: "TextAreaField"
1506
+ });
1459
1507
  var ImageMimeType = import_v43.default.enum([
1460
1508
  "image/png",
1461
1509
  "image/jpg",
@@ -1485,13 +1533,19 @@ var SignatureField = BaseField.extend({
1485
1533
  }).default({
1486
1534
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1487
1535
  })
1488
- }).describe("Signature input field");
1536
+ }).meta({
1537
+ description: "A signature input field",
1538
+ id: "SignatureField"
1539
+ });
1489
1540
  var EmailField = BaseField.extend({
1490
1541
  type: import_v43.default.literal(FieldType.EMAIL),
1491
1542
  configuration: import_v43.default.object({
1492
1543
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1493
1544
  }).default({ maxLength: 255 }).optional(),
1494
1545
  defaultValue: NonEmptyTextValue.optional()
1546
+ }).meta({
1547
+ description: "An email input field",
1548
+ id: "EmailField"
1495
1549
  });
1496
1550
  var DateField = BaseField.extend({
1497
1551
  type: import_v43.default.literal(FieldType.DATE),
@@ -1501,7 +1555,10 @@ var DateField = BaseField.extend({
1501
1555
  "Text to display above the date input"
1502
1556
  ).optional()
1503
1557
  }).optional()
1504
- }).describe("A single date input (yyyy-MM-dd)");
1558
+ }).meta({
1559
+ description: "A date input (yyyy-MM-dd)",
1560
+ id: "DateField"
1561
+ });
1505
1562
  var AgeField = BaseField.extend({
1506
1563
  type: import_v43.default.literal(FieldType.AGE),
1507
1564
  defaultValue: NumberFieldValue.optional(),
@@ -1510,7 +1567,10 @@ var AgeField = BaseField.extend({
1510
1567
  prefix: TranslationConfig.optional(),
1511
1568
  postfix: TranslationConfig.optional()
1512
1569
  })
1513
- }).describe("An age input field which uses the current date as the asOfDate");
1570
+ }).meta({
1571
+ description: "An age input field which uses the current date as the asOfDate",
1572
+ id: "AgeField"
1573
+ });
1514
1574
  var TimeField = BaseField.extend({
1515
1575
  type: import_v43.default.literal(FieldType.TIME),
1516
1576
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -1520,7 +1580,10 @@ var TimeField = BaseField.extend({
1520
1580
  "Text to display above the time input"
1521
1581
  ).optional()
1522
1582
  }).optional()
1523
- }).describe("A single date input (HH-mm)");
1583
+ }).meta({
1584
+ description: "A single time input (HH-mm)",
1585
+ id: "TimeField"
1586
+ });
1524
1587
  var DateRangeField = BaseField.extend({
1525
1588
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1526
1589
  defaultValue: DateRangeFieldValue.optional(),
@@ -1529,7 +1592,10 @@ var DateRangeField = BaseField.extend({
1529
1592
  "Text to display above the date input"
1530
1593
  ).optional()
1531
1594
  }).optional()
1532
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
1595
+ }).meta({
1596
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
1597
+ id: "DateRangeField"
1598
+ });
1533
1599
  var HtmlFontVariant = import_v43.default.enum([
1534
1600
  "reg12",
1535
1601
  "reg14",
@@ -1573,18 +1639,30 @@ var ImageViewField = BaseField.extend({
1573
1639
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1574
1640
  defaultValue: NonEmptyTextValue.optional(),
1575
1641
  configuration: ImageConfiguration
1576
- }).describe("A read-only image component for form pages");
1642
+ }).meta({
1643
+ description: "A read-only image component for form pages",
1644
+ id: "ImageViewField"
1645
+ });
1577
1646
  var Paragraph = BaseField.extend({
1578
1647
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1579
1648
  configuration: ParagraphConfiguration
1580
- }).describe("A read-only HTML <p> paragraph");
1649
+ }).meta({
1650
+ description: "A read-only HTML <p> paragraph",
1651
+ id: "Paragraph"
1652
+ });
1581
1653
  var Heading = BaseField.extend({
1582
1654
  type: import_v43.default.literal(FieldType.HEADING),
1583
1655
  configuration: HeadingConfiguration
1584
- }).describe("A read-only heading component for form pages");
1656
+ }).meta({
1657
+ description: "A read-only heading component for form pages",
1658
+ id: "Heading"
1659
+ });
1585
1660
  var PageHeader = BaseField.extend({
1586
1661
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1587
- }).describe("A read-only header component for form pages");
1662
+ }).meta({
1663
+ description: "A read-only header component for form pages",
1664
+ id: "PageHeader"
1665
+ });
1588
1666
  var File = BaseField.extend({
1589
1667
  type: import_v43.default.literal(FieldType.FILE),
1590
1668
  defaultValue: FileFieldValue.optional(),
@@ -1603,7 +1681,10 @@ var File = BaseField.extend({
1603
1681
  }).default({
1604
1682
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1605
1683
  })
1606
- }).describe("File upload");
1684
+ }).meta({
1685
+ description: "A file upload field",
1686
+ id: "File"
1687
+ });
1607
1688
  var SelectOption = import_v43.default.object({
1608
1689
  value: import_v43.default.string().describe("The value of the option"),
1609
1690
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1620,7 +1701,10 @@ var NumberWithUnitField = BaseField.extend({
1620
1701
  "Placeholder for the number field"
1621
1702
  )
1622
1703
  }).optional()
1623
- }).describe("Number with unit input");
1704
+ }).meta({
1705
+ description: "A number with unit input field",
1706
+ id: "NumberWithUnitField"
1707
+ });
1624
1708
  var RadioGroup = BaseField.extend({
1625
1709
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1626
1710
  defaultValue: TextValue.optional(),
@@ -1630,7 +1714,10 @@ var RadioGroup = BaseField.extend({
1630
1714
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1631
1715
  }).optional()
1632
1716
  }).optional()
1633
- }).describe("Grouped radio options");
1717
+ }).meta({
1718
+ description: "A grouped radio button field",
1719
+ id: "RadioGroup"
1720
+ });
1634
1721
  var BulletList = BaseField.extend({
1635
1722
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1636
1723
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1639,7 +1726,10 @@ var BulletList = BaseField.extend({
1639
1726
  fontVariant: HtmlFontVariant.optional()
1640
1727
  }).optional()
1641
1728
  }).default({})
1642
- }).describe("A list of bullet points");
1729
+ }).meta({
1730
+ description: "A list of bullet points",
1731
+ id: "BulletList"
1732
+ });
1643
1733
  var Select = BaseField.extend({
1644
1734
  type: import_v43.default.literal(FieldType.SELECT),
1645
1735
  defaultValue: TextValue.optional(),
@@ -1654,7 +1744,10 @@ var Select = BaseField.extend({
1654
1744
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1655
1745
  `
1656
1746
  )
1657
- }).describe("Select input");
1747
+ }).meta({
1748
+ description: "A select input field",
1749
+ id: "Select"
1750
+ });
1658
1751
  var SelectDateRangeOption = import_v43.default.object({
1659
1752
  value: SelectDateRangeValue.describe("The value of the option"),
1660
1753
  label: TranslationConfig.describe("The label of the option")
@@ -1663,7 +1756,10 @@ var SelectDateRangeField = BaseField.extend({
1663
1756
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1664
1757
  defaultValue: SelectDateRangeValue.optional(),
1665
1758
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1666
- }).describe("Select input with date range options");
1759
+ }).meta({
1760
+ description: "A date range selection field",
1761
+ id: "SelectDateRangeField"
1762
+ });
1667
1763
  var NameConfig = import_v43.default.object({
1668
1764
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1669
1765
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1694,26 +1790,41 @@ var NameField = BaseField.extend({
1694
1790
  surname: { required: true }
1695
1791
  }
1696
1792
  }).optional()
1697
- }).describe("Name input field");
1793
+ }).meta({
1794
+ description: "A field for entering a persons name",
1795
+ id: "NameField"
1796
+ });
1698
1797
  var PhoneField = BaseField.extend({
1699
1798
  defaultValue: NonEmptyTextValue.optional(),
1700
1799
  type: import_v43.default.literal(FieldType.PHONE)
1701
- }).describe("Phone input field");
1800
+ }).meta({
1801
+ description: "A field for entering a phone number",
1802
+ id: "PhoneField"
1803
+ });
1702
1804
  var IdField = BaseField.extend({
1703
1805
  defaultValue: NonEmptyTextValue.optional(),
1704
1806
  type: import_v43.default.literal(FieldType.ID)
1705
- }).describe("ID input field");
1807
+ }).meta({
1808
+ description: "A field for entering an ID",
1809
+ id: "IdField"
1810
+ });
1706
1811
  var Checkbox = BaseField.extend({
1707
1812
  type: import_v43.default.literal(FieldType.CHECKBOX),
1708
1813
  defaultValue: CheckboxFieldValue.default(false)
1709
- }).describe("Boolean checkbox field");
1814
+ }).meta({
1815
+ description: "A boolean checkbox field",
1816
+ id: "Checkbox"
1817
+ });
1710
1818
  var Country = BaseField.extend({
1711
1819
  type: import_v43.default.literal(FieldType.COUNTRY),
1712
1820
  defaultValue: NonEmptyTextValue.optional(),
1713
1821
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1714
1822
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1715
1823
  )
1716
- }).describe("Country select field");
1824
+ }).meta({
1825
+ description: "A field for selecting a country",
1826
+ id: "Country"
1827
+ });
1717
1828
  var AllowedLocations = JurisdictionReference.optional().describe(
1718
1829
  "Limits which location options are selectable depending on user jurisdiction and location."
1719
1830
  );
@@ -1722,16 +1833,18 @@ var AdministrativeAreas = import_v43.default.enum([
1722
1833
  "HEALTH_FACILITY",
1723
1834
  "CRVS_OFFICE"
1724
1835
  ]);
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
1836
  var AdministrativeAreaField = BaseField.extend({
1731
1837
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1732
1838
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1733
- configuration: AdministrativeAreaConfiguration
1734
- }).describe("Administrative area input field e.g. facility, office");
1839
+ configuration: import_v43.default.object({
1840
+ partOf: FieldReference.optional().describe("Parent location"),
1841
+ type: AdministrativeAreas,
1842
+ allowedLocations: AllowedLocations
1843
+ }).describe("Administrative area options")
1844
+ }).meta({
1845
+ description: "Administrative area input field",
1846
+ id: "AdministrativeAreaField"
1847
+ });
1735
1848
  var LocationInput = BaseField.extend({
1736
1849
  type: import_v43.default.literal(FieldType.LOCATION),
1737
1850
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -1739,7 +1852,10 @@ var LocationInput = BaseField.extend({
1739
1852
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1740
1853
  allowedLocations: AllowedLocations
1741
1854
  }).optional()
1742
- }).describe("Input field for a location");
1855
+ }).meta({
1856
+ description: "A field for selecting a location",
1857
+ id: "LocationInput"
1858
+ });
1743
1859
  var FileUploadWithOptions = BaseField.extend({
1744
1860
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1745
1861
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -1753,6 +1869,9 @@ var FileUploadWithOptions = BaseField.extend({
1753
1869
  }).default({
1754
1870
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1755
1871
  })
1872
+ }).meta({
1873
+ description: "A field for uploading files with file type options",
1874
+ id: "FileUploadWithOptions"
1756
1875
  });
1757
1876
  var Facility = BaseField.extend({
1758
1877
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -1798,7 +1917,10 @@ var Address = BaseField.extend({
1798
1917
  allowedLocations: AllowedLocations
1799
1918
  }).optional(),
1800
1919
  defaultValue: DefaultAddressFieldValue.optional()
1801
- }).describe("Address input field \u2013 a combination of location and text fields");
1920
+ }).meta({
1921
+ description: "Address input field \u2013 a combination of location and text fields",
1922
+ id: "Address"
1923
+ });
1802
1924
  var StaticDataEntry = import_v43.default.object({
1803
1925
  id: import_v43.default.string().describe("ID for the data entry."),
1804
1926
  label: TranslationConfig,
@@ -1813,7 +1935,10 @@ var DataField = BaseField.extend({
1813
1935
  subtitle: TranslationConfig.optional(),
1814
1936
  data: import_v43.default.array(DataEntry)
1815
1937
  })
1816
- }).describe("Data field for displaying read-only data");
1938
+ }).meta({
1939
+ description: "A field for displaying a table of read-only data",
1940
+ id: "DataField"
1941
+ });
1817
1942
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1818
1943
  var ButtonType = import_v43.default.enum([
1819
1944
  "primary",
@@ -1840,11 +1965,17 @@ var ButtonField = BaseField.extend({
1840
1965
  type: import_v43.default.literal(FieldType.BUTTON),
1841
1966
  defaultValue: ButtonFieldValue.optional(),
1842
1967
  configuration: ButtonConfiguration
1843
- }).describe("Generic button without any built-in functionality");
1968
+ }).meta({
1969
+ description: "A generic button that can be used to trigger an action",
1970
+ id: "ButtonField"
1971
+ });
1844
1972
  var FieldGroup = BaseField.extend({
1845
1973
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1846
1974
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1847
1975
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
1976
+ }).meta({
1977
+ description: "A group of fields that are displayed together",
1978
+ id: "FieldGroup"
1848
1979
  });
1849
1980
  var AlphaPrintButton = BaseField.extend({
1850
1981
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1854,7 +1985,10 @@ var AlphaPrintButton = BaseField.extend({
1854
1985
  "Label for the print button"
1855
1986
  )
1856
1987
  })
1857
- }).describe("Print button field for printing certificates");
1988
+ }).meta({
1989
+ description: "An experimental print button field for printing certificates during the declaration process",
1990
+ id: "AlphaPrintButton"
1991
+ });
1858
1992
  var HttpField = BaseField.extend({
1859
1993
  type: import_v43.default.literal(FieldType.HTTP),
1860
1994
  defaultValue: HttpFieldValue.optional(),
@@ -1870,20 +2004,30 @@ var HttpField = BaseField.extend({
1870
2004
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1871
2005
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1872
2006
  })
1873
- }).describe("HTTP request function triggered by a button click or other event");
2007
+ }).meta({
2008
+ 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.",
2009
+ id: "HttpField"
2010
+ });
1874
2011
  var AutocompleteField = BaseField.extend({
1875
2012
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1876
2013
  configuration: import_v43.default.object({
1877
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2014
+ url: import_v43.default.string().describe(
2015
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2016
+ ).optional(),
1878
2017
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1879
2018
  defaultOptions: import_v43.default.array(
1880
2019
  import_v43.default.object({
1881
2020
  label: import_v43.default.string(),
1882
2021
  value: import_v43.default.string()
1883
2022
  })
1884
- ).optional()
2023
+ ).optional().describe(
2024
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2025
+ )
1885
2026
  })
1886
- }).describe("Autocomplete input field");
2027
+ }).meta({
2028
+ 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.",
2029
+ id: "AutocompleteField"
2030
+ });
1887
2031
  var SearchField = HttpField.extend({
1888
2032
  type: import_v43.default.literal(FieldType.SEARCH),
1889
2033
  configuration: SearchQuery.pick({
@@ -1916,6 +2060,9 @@ var SearchField = HttpField.extend({
1916
2060
  ok: TranslationConfig.optional()
1917
2061
  }).optional()
1918
2062
  })
2063
+ }).meta({
2064
+ description: "A search input field",
2065
+ id: "SearchField"
1919
2066
  });
1920
2067
  var LinkButtonField = BaseField.extend({
1921
2068
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1924,7 +2071,10 @@ var LinkButtonField = BaseField.extend({
1924
2071
  text: TranslationConfig.describe("Text to display on the button"),
1925
2072
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1926
2073
  })
1927
- }).describe("Button that opens a link");
2074
+ }).meta({
2075
+ description: "A button that opens a URL link",
2076
+ id: "LinkButtonField"
2077
+ });
1928
2078
  var VerificationStatus = BaseField.extend({
1929
2079
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1930
2080
  defaultValue: VerificationStatusValue.optional(),
@@ -1934,15 +2084,19 @@ var VerificationStatus = BaseField.extend({
1934
2084
  "Explaining text on the banner in form."
1935
2085
  )
1936
2086
  })
2087
+ }).meta({
2088
+ 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.",
2089
+ id: "VerificationStatus"
1937
2090
  });
1938
2091
  var QueryParamReaderField = BaseField.extend({
1939
2092
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1940
2093
  configuration: import_v43.default.object({
1941
2094
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1942
2095
  })
1943
- }).describe(
1944
- "A field that maps URL query params into form values and clears them afterward"
1945
- );
2096
+ }).meta({
2097
+ description: "A field that maps URL query params into form values and clears them afterward",
2098
+ id: "QueryParamReaderField"
2099
+ });
1946
2100
  var QrReaderField = BaseField.extend({
1947
2101
  type: import_v43.default.literal(FieldType.QR_READER),
1948
2102
  defaultValue: QrReaderFieldValue.optional(),
@@ -1953,7 +2107,7 @@ var QrReaderField = BaseField.extend({
1953
2107
  })
1954
2108
  }).optional()
1955
2109
  }).meta({
1956
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2110
+ description: "QR code reader field, including optional JSON Schema validator.",
1957
2111
  id: "QrReaderField"
1958
2112
  });
1959
2113
  var IdReaderField = BaseField.extend({
@@ -1962,12 +2116,18 @@ var IdReaderField = BaseField.extend({
1962
2116
  methods: import_v43.default.array(
1963
2117
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1964
2118
  )
2119
+ }).meta({
2120
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2121
+ id: "IdReaderField"
1965
2122
  });
1966
2123
  var CustomField = BaseField.extend({
1967
2124
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1968
2125
  defaultValue: CustomFieldValue.optional(),
1969
2126
  src: import_v43.default.string().describe("Module source path for the custom field component"),
1970
2127
  configuration: import_v43.default.unknown().optional()
2128
+ }).meta({
2129
+ description: "An expiremental custom field that is defined by a module source path",
2130
+ id: "CustomField"
1971
2131
  });
1972
2132
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
1973
2133
  var LoaderField = BaseField.extend({
@@ -1977,22 +2137,25 @@ var LoaderField = BaseField.extend({
1977
2137
  configuration: import_v43.default.object({
1978
2138
  text: TranslationConfig.describe("Display text above the loading spinner")
1979
2139
  })
1980
- }).describe(
1981
- "A non-interactive field that indicates an in progress operation in form"
1982
- );
2140
+ }).meta({
2141
+ description: "A non-interactive field that indicates an in progress operation in form",
2142
+ id: "LoaderField"
2143
+ });
1983
2144
  var HiddenField = BaseField.extend({
1984
2145
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
1985
2146
  required: import_v43.default.boolean().default(false).optional(),
1986
2147
  defaultValue: TextValue.optional()
1987
- }).describe(
1988
- "A non-interactive, hidden field that only hold a value in the form"
1989
- );
2148
+ }).meta({
2149
+ description: "A non-interactive, hidden field that only hold a value in the form",
2150
+ id: "HiddenField"
2151
+ });
1990
2152
  var UserRoleField = BaseField.extend({
1991
2153
  type: import_v43.default.literal(FieldType.USER_ROLE),
1992
2154
  defaultValue: TextValue.optional()
1993
- }).describe(
1994
- "A select dropdown that is automatically populated with available user roles"
1995
- );
2155
+ }).meta({
2156
+ description: "A select dropdown that is automatically populated with available user roles",
2157
+ id: "UserRoleField"
2158
+ });
1996
2159
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
1997
2160
  FieldGroup,
1998
2161
  Address,
@@ -2078,8 +2241,8 @@ var ApplicationConfig = z20.object({
2078
2241
  })
2079
2242
  ),
2080
2243
  PHONE_NUMBER_PATTERN: z20.string().or(z20.instanceof(RegExp)),
2081
- USER_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2082
- INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2244
+ USER_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2245
+ INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2083
2246
  SEARCH_DEFAULT_CRITERIA: SearchCriteria.optional().default("TRACKING_ID"),
2084
2247
  ADDITIONAL_USER_FIELDS: z20.array(FieldConfig).optional().default([])
2085
2248
  });
@@ -2097,8 +2260,8 @@ var BackgroundConfig = z20.object({
2097
2260
  var LoginConfig = z20.object({
2098
2261
  COUNTRY: z20.string(),
2099
2262
  LANGUAGES: z20.array(z20.string()),
2100
- USER_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2101
- INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.string(),
2263
+ USER_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2264
+ INFORMANT_NOTIFICATION_DELIVERY_METHOD: z20.enum(["email", "sms"]),
2102
2265
  PHONE_NUMBER_PATTERN: z20.string().or(z20.instanceof(RegExp)),
2103
2266
  LOGIN_BACKGROUND: BackgroundConfig,
2104
2267
  SENTRY: z20.string().optional()