@opencrvs/toolkit 2.0.0-rc.f3bc98a → 2.0.0-rc.f4d17ba

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 (53) 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 +223 -88
  4. package/dist/cli.js +507 -171
  5. package/dist/commons/api/router.d.ts +3331 -266
  6. package/dist/commons/conditionals/conditionals.d.ts +9 -3
  7. package/dist/commons/conditionals/validate.d.ts +1 -0
  8. package/dist/commons/events/ActionInput.d.ts +108 -0
  9. package/dist/commons/events/Draft.d.ts +4 -2
  10. package/dist/commons/events/EventIndex.d.ts +0 -3
  11. package/dist/commons/events/EventMetadata.d.ts +0 -7
  12. package/dist/commons/events/FieldConfig.d.ts +5 -0
  13. package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
  14. package/dist/commons/events/index.d.ts +1 -0
  15. package/dist/commons/events/locations.d.ts +21 -0
  16. package/dist/commons/events/mocks.test.utils.d.ts +19 -0
  17. package/dist/commons/events/scopes.d.ts +24 -1
  18. package/dist/commons/events/state/flags.d.ts +15 -0
  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 +12 -4
  23. package/dist/events/index.js +788 -175
  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 +60 -35
  26. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  27. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  28. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -2
  29. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +9 -1
  30. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -1
  31. package/dist/migrations/v2.0/delete-infrastructure-directory.js +66 -20
  32. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  33. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  34. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  35. package/dist/migrations/v2.0/index.d.ts +5 -3
  36. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  37. package/dist/migrations/v2.0/index.js +505 -169
  38. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
  39. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +90 -1
  40. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +11 -1
  41. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -1
  42. package/dist/migrations/v2.0/merge-infrastructure-directory.js +17 -16
  43. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  44. package/dist/migrations/v2.0/migrate-scopes.js +54 -30
  45. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  46. package/dist/migrations/v2.0/migrate-workqueue-configs.js +140 -59
  47. package/dist/notification/index.js +657 -120
  48. package/dist/scopes/index.d.ts +6 -1
  49. package/dist/scopes/index.js +8 -4
  50. package/opencrvs-toolkit-2.0.0-rc.f4d17ba.tgz +0 -0
  51. package/package.json +6 -2
  52. package/tsconfig.tsbuildinfo +1 -1
  53. package/opencrvs-toolkit-2.0.0-rc.f3bc98a.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
  });
@@ -772,12 +767,14 @@ var SystemScopeType = z11.enum([
772
767
  "organisation.read-locations",
773
768
  "user.read",
774
769
  "user.create",
775
- "user.edit"
770
+ "user.edit",
771
+ "user.search"
776
772
  ]);
777
773
  var UserScopeType = SystemScopeType.extract([
778
774
  "user.read",
779
775
  "user.create",
780
- "user.edit"
776
+ "user.edit",
777
+ "user.search"
781
778
  ]);
782
779
  var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
783
780
  var UserScopeV2 = z11.discriminatedUnion("type", [
@@ -786,7 +783,7 @@ var UserScopeV2 = z11.discriminatedUnion("type", [
786
783
  options: AllUserScopeOptions.optional()
787
784
  }),
788
785
  z11.object({
789
- type: UserScopeType.extract(["user.read"]),
786
+ type: UserScopeType.extract(["user.read", "user.search"]),
790
787
  options: AccessLevelOptions.optional()
791
788
  })
792
789
  ]);
@@ -837,7 +834,9 @@ var ScopeType = z11.enum([
837
834
  var EncodedScope = z11.string().brand("EncodedScope");
838
835
  var DEFAULT_SCOPE_OPTIONS = {
839
836
  placeOfEvent: JurisdictionFilter.enum.all,
840
- accessLevel: JurisdictionFilter.enum.all
837
+ accessLevel: JurisdictionFilter.enum.all,
838
+ registeredIn: JurisdictionFilter.enum.all,
839
+ declaredIn: JurisdictionFilter.enum.all
841
840
  };
842
841
 
843
842
  // ../commons/src/authentication.ts
@@ -1083,6 +1082,9 @@ var FlagConfig = z14.object({
1083
1082
  "Indicates if this flag expects an action to be performed to be cleared."
1084
1083
  ),
1085
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."
1086
1088
  });
1087
1089
  var ActionFlagConfig = z14.object({
1088
1090
  id: Flag,
@@ -1090,6 +1092,9 @@ var ActionFlagConfig = z14.object({
1090
1092
  conditional: Conditional.optional().describe(
1091
1093
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1092
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."
1093
1098
  });
1094
1099
 
1095
1100
  // ../commons/src/events/EventMetadata.ts
@@ -1111,8 +1116,7 @@ var ActionCreationMetadata = z15.object({
1111
1116
  ),
1112
1117
  createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1113
1118
  acceptedAt: z15.iso.datetime().describe("Timestamp when the action request was accepted."),
1114
- createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation."),
1115
- 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.")
1116
1120
  });
1117
1121
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1118
1122
  registrationNumber: z15.string().describe(
@@ -1140,9 +1144,6 @@ var EventMetadata = z15.object({
1140
1144
  createdAtLocation: UUID.nullish().describe(
1141
1145
  "Location of the user who created the event."
1142
1146
  ),
1143
- createdBySignature: DocumentPath.nullish().describe(
1144
- "Signature of the user who created the event."
1145
- ),
1146
1147
  updatedAtLocation: UUID.nullish().describe(
1147
1148
  "Location of the user who last changed the status."
1148
1149
  ),
@@ -1406,14 +1407,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1406
1407
  }
1407
1408
  }).describe("Unique identifier for the field");
1408
1409
  var FieldReference = import_v43.default.object({
1409
- $$field: FieldId,
1410
+ $$field: FieldId.describe("Id of the field to reference"),
1410
1411
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1411
1412
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1412
1413
  )
1413
1414
  }).describe("Reference to a field by its ID");
1414
1415
  var ValidationConfig = import_v43.default.object({
1415
- validator: Conditional,
1416
- 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."
1417
1425
  });
1418
1426
  var requiredSchema = import_v43.default.union([
1419
1427
  import_v43.default.boolean(),
@@ -1452,6 +1460,9 @@ var BaseField = import_v43.default.object({
1452
1460
  }).describe("Common properties shared across all field types.");
1453
1461
  var Divider = BaseField.extend({
1454
1462
  type: import_v43.default.literal(FieldType.DIVIDER)
1463
+ }).meta({
1464
+ description: "A horizontal line divider",
1465
+ id: "Divider"
1455
1466
  });
1456
1467
  var TextField = BaseField.extend({
1457
1468
  type: import_v43.default.literal(FieldType.TEXT),
@@ -1462,7 +1473,10 @@ var TextField = BaseField.extend({
1462
1473
  prefix: TranslationConfig.optional(),
1463
1474
  postfix: TranslationConfig.optional()
1464
1475
  }).default({ type: "text" }).optional()
1465
- }).describe("Text input");
1476
+ }).meta({
1477
+ description: "A text input field",
1478
+ id: "TextField"
1479
+ });
1466
1480
  var NumberField = BaseField.extend({
1467
1481
  type: import_v43.default.literal(FieldType.NUMBER),
1468
1482
  defaultValue: NumberFieldValue.optional(),
@@ -1472,7 +1486,10 @@ var NumberField = BaseField.extend({
1472
1486
  prefix: TranslationConfig.optional(),
1473
1487
  postfix: TranslationConfig.optional()
1474
1488
  }).optional()
1475
- }).describe("Number input");
1489
+ }).meta({
1490
+ description: "A number input field",
1491
+ id: "NumberField"
1492
+ });
1476
1493
  var TextAreaField = BaseField.extend({
1477
1494
  type: import_v43.default.literal(FieldType.TEXTAREA),
1478
1495
  defaultValue: NonEmptyTextValue.optional(),
@@ -1483,7 +1500,10 @@ var TextAreaField = BaseField.extend({
1483
1500
  prefix: TranslationConfig.optional(),
1484
1501
  postfix: TranslationConfig.optional()
1485
1502
  }).default({ rows: 4 }).optional()
1486
- }).describe("Multiline text input");
1503
+ }).meta({
1504
+ description: "A multiline text input",
1505
+ id: "TextAreaField"
1506
+ });
1487
1507
  var ImageMimeType = import_v43.default.enum([
1488
1508
  "image/png",
1489
1509
  "image/jpg",
@@ -1513,13 +1533,19 @@ var SignatureField = BaseField.extend({
1513
1533
  }).default({
1514
1534
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1515
1535
  })
1516
- }).describe("Signature input field");
1536
+ }).meta({
1537
+ description: "A signature input field",
1538
+ id: "SignatureField"
1539
+ });
1517
1540
  var EmailField = BaseField.extend({
1518
1541
  type: import_v43.default.literal(FieldType.EMAIL),
1519
1542
  configuration: import_v43.default.object({
1520
1543
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1521
1544
  }).default({ maxLength: 255 }).optional(),
1522
1545
  defaultValue: NonEmptyTextValue.optional()
1546
+ }).meta({
1547
+ description: "An email input field",
1548
+ id: "EmailField"
1523
1549
  });
1524
1550
  var DateField = BaseField.extend({
1525
1551
  type: import_v43.default.literal(FieldType.DATE),
@@ -1529,7 +1555,10 @@ var DateField = BaseField.extend({
1529
1555
  "Text to display above the date input"
1530
1556
  ).optional()
1531
1557
  }).optional()
1532
- }).describe("A single date input (yyyy-MM-dd)");
1558
+ }).meta({
1559
+ description: "A date input (yyyy-MM-dd)",
1560
+ id: "DateField"
1561
+ });
1533
1562
  var AgeField = BaseField.extend({
1534
1563
  type: import_v43.default.literal(FieldType.AGE),
1535
1564
  defaultValue: NumberFieldValue.optional(),
@@ -1538,7 +1567,10 @@ var AgeField = BaseField.extend({
1538
1567
  prefix: TranslationConfig.optional(),
1539
1568
  postfix: TranslationConfig.optional()
1540
1569
  })
1541
- }).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
+ });
1542
1574
  var TimeField = BaseField.extend({
1543
1575
  type: import_v43.default.literal(FieldType.TIME),
1544
1576
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -1548,7 +1580,10 @@ var TimeField = BaseField.extend({
1548
1580
  "Text to display above the time input"
1549
1581
  ).optional()
1550
1582
  }).optional()
1551
- }).describe("A single date input (HH-mm)");
1583
+ }).meta({
1584
+ description: "A single time input (HH-mm)",
1585
+ id: "TimeField"
1586
+ });
1552
1587
  var DateRangeField = BaseField.extend({
1553
1588
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1554
1589
  defaultValue: DateRangeFieldValue.optional(),
@@ -1557,7 +1592,10 @@ var DateRangeField = BaseField.extend({
1557
1592
  "Text to display above the date input"
1558
1593
  ).optional()
1559
1594
  }).optional()
1560
- }).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
+ });
1561
1599
  var HtmlFontVariant = import_v43.default.enum([
1562
1600
  "reg12",
1563
1601
  "reg14",
@@ -1601,18 +1639,30 @@ var ImageViewField = BaseField.extend({
1601
1639
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1602
1640
  defaultValue: NonEmptyTextValue.optional(),
1603
1641
  configuration: ImageConfiguration
1604
- }).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
+ });
1605
1646
  var Paragraph = BaseField.extend({
1606
1647
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1607
1648
  configuration: ParagraphConfiguration
1608
- }).describe("A read-only HTML <p> paragraph");
1649
+ }).meta({
1650
+ description: "A read-only HTML <p> paragraph",
1651
+ id: "Paragraph"
1652
+ });
1609
1653
  var Heading = BaseField.extend({
1610
1654
  type: import_v43.default.literal(FieldType.HEADING),
1611
1655
  configuration: HeadingConfiguration
1612
- }).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
+ });
1613
1660
  var PageHeader = BaseField.extend({
1614
1661
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1615
- }).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
+ });
1616
1666
  var File = BaseField.extend({
1617
1667
  type: import_v43.default.literal(FieldType.FILE),
1618
1668
  defaultValue: FileFieldValue.optional(),
@@ -1631,7 +1681,10 @@ var File = BaseField.extend({
1631
1681
  }).default({
1632
1682
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1633
1683
  })
1634
- }).describe("File upload");
1684
+ }).meta({
1685
+ description: "A file upload field",
1686
+ id: "File"
1687
+ });
1635
1688
  var SelectOption = import_v43.default.object({
1636
1689
  value: import_v43.default.string().describe("The value of the option"),
1637
1690
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1648,7 +1701,10 @@ var NumberWithUnitField = BaseField.extend({
1648
1701
  "Placeholder for the number field"
1649
1702
  )
1650
1703
  }).optional()
1651
- }).describe("Number with unit input");
1704
+ }).meta({
1705
+ description: "A number with unit input field",
1706
+ id: "NumberWithUnitField"
1707
+ });
1652
1708
  var RadioGroup = BaseField.extend({
1653
1709
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1654
1710
  defaultValue: TextValue.optional(),
@@ -1658,7 +1714,10 @@ var RadioGroup = BaseField.extend({
1658
1714
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1659
1715
  }).optional()
1660
1716
  }).optional()
1661
- }).describe("Grouped radio options");
1717
+ }).meta({
1718
+ description: "A grouped radio button field",
1719
+ id: "RadioGroup"
1720
+ });
1662
1721
  var BulletList = BaseField.extend({
1663
1722
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1664
1723
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1667,7 +1726,10 @@ var BulletList = BaseField.extend({
1667
1726
  fontVariant: HtmlFontVariant.optional()
1668
1727
  }).optional()
1669
1728
  }).default({})
1670
- }).describe("A list of bullet points");
1729
+ }).meta({
1730
+ description: "A list of bullet points",
1731
+ id: "BulletList"
1732
+ });
1671
1733
  var Select = BaseField.extend({
1672
1734
  type: import_v43.default.literal(FieldType.SELECT),
1673
1735
  defaultValue: TextValue.optional(),
@@ -1682,7 +1744,10 @@ var Select = BaseField.extend({
1682
1744
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1683
1745
  `
1684
1746
  )
1685
- }).describe("Select input");
1747
+ }).meta({
1748
+ description: "A select input field",
1749
+ id: "Select"
1750
+ });
1686
1751
  var SelectDateRangeOption = import_v43.default.object({
1687
1752
  value: SelectDateRangeValue.describe("The value of the option"),
1688
1753
  label: TranslationConfig.describe("The label of the option")
@@ -1691,7 +1756,10 @@ var SelectDateRangeField = BaseField.extend({
1691
1756
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1692
1757
  defaultValue: SelectDateRangeValue.optional(),
1693
1758
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1694
- }).describe("Select input with date range options");
1759
+ }).meta({
1760
+ description: "A date range selection field",
1761
+ id: "SelectDateRangeField"
1762
+ });
1695
1763
  var NameConfig = import_v43.default.object({
1696
1764
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1697
1765
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1722,26 +1790,41 @@ var NameField = BaseField.extend({
1722
1790
  surname: { required: true }
1723
1791
  }
1724
1792
  }).optional()
1725
- }).describe("Name input field");
1793
+ }).meta({
1794
+ description: "A field for entering a persons name",
1795
+ id: "NameField"
1796
+ });
1726
1797
  var PhoneField = BaseField.extend({
1727
1798
  defaultValue: NonEmptyTextValue.optional(),
1728
1799
  type: import_v43.default.literal(FieldType.PHONE)
1729
- }).describe("Phone input field");
1800
+ }).meta({
1801
+ description: "A field for entering a phone number",
1802
+ id: "PhoneField"
1803
+ });
1730
1804
  var IdField = BaseField.extend({
1731
1805
  defaultValue: NonEmptyTextValue.optional(),
1732
1806
  type: import_v43.default.literal(FieldType.ID)
1733
- }).describe("ID input field");
1807
+ }).meta({
1808
+ description: "A field for entering an ID",
1809
+ id: "IdField"
1810
+ });
1734
1811
  var Checkbox = BaseField.extend({
1735
1812
  type: import_v43.default.literal(FieldType.CHECKBOX),
1736
1813
  defaultValue: CheckboxFieldValue.default(false)
1737
- }).describe("Boolean checkbox field");
1814
+ }).meta({
1815
+ description: "A boolean checkbox field",
1816
+ id: "Checkbox"
1817
+ });
1738
1818
  var Country = BaseField.extend({
1739
1819
  type: import_v43.default.literal(FieldType.COUNTRY),
1740
1820
  defaultValue: NonEmptyTextValue.optional(),
1741
1821
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1742
1822
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1743
1823
  )
1744
- }).describe("Country select field");
1824
+ }).meta({
1825
+ description: "A field for selecting a country",
1826
+ id: "Country"
1827
+ });
1745
1828
  var AllowedLocations = JurisdictionReference.optional().describe(
1746
1829
  "Limits which location options are selectable depending on user jurisdiction and location."
1747
1830
  );
@@ -1750,16 +1833,18 @@ var AdministrativeAreas = import_v43.default.enum([
1750
1833
  "HEALTH_FACILITY",
1751
1834
  "CRVS_OFFICE"
1752
1835
  ]);
1753
- var AdministrativeAreaConfiguration = import_v43.default.object({
1754
- partOf: FieldReference.optional().describe("Parent location"),
1755
- type: AdministrativeAreas,
1756
- allowedLocations: AllowedLocations
1757
- }).describe("Administrative area options");
1758
1836
  var AdministrativeAreaField = BaseField.extend({
1759
1837
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1760
1838
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1761
- configuration: AdministrativeAreaConfiguration
1762
- }).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
+ });
1763
1848
  var LocationInput = BaseField.extend({
1764
1849
  type: import_v43.default.literal(FieldType.LOCATION),
1765
1850
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -1767,7 +1852,10 @@ var LocationInput = BaseField.extend({
1767
1852
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1768
1853
  allowedLocations: AllowedLocations
1769
1854
  }).optional()
1770
- }).describe("Input field for a location");
1855
+ }).meta({
1856
+ description: "A field for selecting a location",
1857
+ id: "LocationInput"
1858
+ });
1771
1859
  var FileUploadWithOptions = BaseField.extend({
1772
1860
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1773
1861
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -1781,6 +1869,9 @@ var FileUploadWithOptions = BaseField.extend({
1781
1869
  }).default({
1782
1870
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1783
1871
  })
1872
+ }).meta({
1873
+ description: "A field for uploading files with file type options",
1874
+ id: "FileUploadWithOptions"
1784
1875
  });
1785
1876
  var Facility = BaseField.extend({
1786
1877
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -1826,7 +1917,10 @@ var Address = BaseField.extend({
1826
1917
  allowedLocations: AllowedLocations
1827
1918
  }).optional(),
1828
1919
  defaultValue: DefaultAddressFieldValue.optional()
1829
- }).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
+ });
1830
1924
  var StaticDataEntry = import_v43.default.object({
1831
1925
  id: import_v43.default.string().describe("ID for the data entry."),
1832
1926
  label: TranslationConfig,
@@ -1841,7 +1935,10 @@ var DataField = BaseField.extend({
1841
1935
  subtitle: TranslationConfig.optional(),
1842
1936
  data: import_v43.default.array(DataEntry)
1843
1937
  })
1844
- }).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
+ });
1845
1942
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1846
1943
  var ButtonType = import_v43.default.enum([
1847
1944
  "primary",
@@ -1868,11 +1965,17 @@ var ButtonField = BaseField.extend({
1868
1965
  type: import_v43.default.literal(FieldType.BUTTON),
1869
1966
  defaultValue: ButtonFieldValue.optional(),
1870
1967
  configuration: ButtonConfiguration
1871
- }).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
+ });
1872
1972
  var FieldGroup = BaseField.extend({
1873
1973
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1874
1974
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1875
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"
1876
1979
  });
1877
1980
  var AlphaPrintButton = BaseField.extend({
1878
1981
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1882,7 +1985,10 @@ var AlphaPrintButton = BaseField.extend({
1882
1985
  "Label for the print button"
1883
1986
  )
1884
1987
  })
1885
- }).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
+ });
1886
1992
  var HttpField = BaseField.extend({
1887
1993
  type: import_v43.default.literal(FieldType.HTTP),
1888
1994
  defaultValue: HttpFieldValue.optional(),
@@ -1898,20 +2004,30 @@ var HttpField = BaseField.extend({
1898
2004
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1899
2005
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1900
2006
  })
1901
- }).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
+ });
1902
2011
  var AutocompleteField = BaseField.extend({
1903
2012
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1904
2013
  configuration: import_v43.default.object({
1905
- 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(),
1906
2017
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1907
2018
  defaultOptions: import_v43.default.array(
1908
2019
  import_v43.default.object({
1909
2020
  label: import_v43.default.string(),
1910
2021
  value: import_v43.default.string()
1911
2022
  })
1912
- ).optional()
2023
+ ).optional().describe(
2024
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2025
+ )
1913
2026
  })
1914
- }).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
+ });
1915
2031
  var SearchField = HttpField.extend({
1916
2032
  type: import_v43.default.literal(FieldType.SEARCH),
1917
2033
  configuration: SearchQuery.pick({
@@ -1944,6 +2060,9 @@ var SearchField = HttpField.extend({
1944
2060
  ok: TranslationConfig.optional()
1945
2061
  }).optional()
1946
2062
  })
2063
+ }).meta({
2064
+ description: "A search input field",
2065
+ id: "SearchField"
1947
2066
  });
1948
2067
  var LinkButtonField = BaseField.extend({
1949
2068
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1952,7 +2071,10 @@ var LinkButtonField = BaseField.extend({
1952
2071
  text: TranslationConfig.describe("Text to display on the button"),
1953
2072
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1954
2073
  })
1955
- }).describe("Button that opens a link");
2074
+ }).meta({
2075
+ description: "A button that opens a URL link",
2076
+ id: "LinkButtonField"
2077
+ });
1956
2078
  var VerificationStatus = BaseField.extend({
1957
2079
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1958
2080
  defaultValue: VerificationStatusValue.optional(),
@@ -1962,15 +2084,19 @@ var VerificationStatus = BaseField.extend({
1962
2084
  "Explaining text on the banner in form."
1963
2085
  )
1964
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"
1965
2090
  });
1966
2091
  var QueryParamReaderField = BaseField.extend({
1967
2092
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1968
2093
  configuration: import_v43.default.object({
1969
2094
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1970
2095
  })
1971
- }).describe(
1972
- "A field that maps URL query params into form values and clears them afterward"
1973
- );
2096
+ }).meta({
2097
+ description: "A field that maps URL query params into form values and clears them afterward",
2098
+ id: "QueryParamReaderField"
2099
+ });
1974
2100
  var QrReaderField = BaseField.extend({
1975
2101
  type: import_v43.default.literal(FieldType.QR_READER),
1976
2102
  defaultValue: QrReaderFieldValue.optional(),
@@ -1981,7 +2107,7 @@ var QrReaderField = BaseField.extend({
1981
2107
  })
1982
2108
  }).optional()
1983
2109
  }).meta({
1984
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2110
+ description: "QR code reader field, including optional JSON Schema validator.",
1985
2111
  id: "QrReaderField"
1986
2112
  });
1987
2113
  var IdReaderField = BaseField.extend({
@@ -1990,12 +2116,18 @@ var IdReaderField = BaseField.extend({
1990
2116
  methods: import_v43.default.array(
1991
2117
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1992
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"
1993
2122
  });
1994
2123
  var CustomField = BaseField.extend({
1995
2124
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1996
2125
  defaultValue: CustomFieldValue.optional(),
1997
2126
  src: import_v43.default.string().describe("Module source path for the custom field component"),
1998
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"
1999
2131
  });
2000
2132
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2001
2133
  var LoaderField = BaseField.extend({
@@ -2005,22 +2137,25 @@ var LoaderField = BaseField.extend({
2005
2137
  configuration: import_v43.default.object({
2006
2138
  text: TranslationConfig.describe("Display text above the loading spinner")
2007
2139
  })
2008
- }).describe(
2009
- "A non-interactive field that indicates an in progress operation in form"
2010
- );
2140
+ }).meta({
2141
+ description: "A non-interactive field that indicates an in progress operation in form",
2142
+ id: "LoaderField"
2143
+ });
2011
2144
  var HiddenField = BaseField.extend({
2012
2145
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2013
2146
  required: import_v43.default.boolean().default(false).optional(),
2014
2147
  defaultValue: TextValue.optional()
2015
- }).describe(
2016
- "A non-interactive, hidden field that only hold a value in the form"
2017
- );
2148
+ }).meta({
2149
+ description: "A non-interactive, hidden field that only hold a value in the form",
2150
+ id: "HiddenField"
2151
+ });
2018
2152
  var UserRoleField = BaseField.extend({
2019
2153
  type: import_v43.default.literal(FieldType.USER_ROLE),
2020
2154
  defaultValue: TextValue.optional()
2021
- }).describe(
2022
- "A select dropdown that is automatically populated with available user roles"
2023
- );
2155
+ }).meta({
2156
+ description: "A select dropdown that is automatically populated with available user roles",
2157
+ id: "UserRoleField"
2158
+ });
2024
2159
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2025
2160
  FieldGroup,
2026
2161
  Address,