@opencrvs/toolkit 2.0.0-rc.5e06f40 → 2.0.0-rc.5f39c86

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 (38) hide show
  1. package/create-countryconfig/index.js +50 -20
  2. package/create-countryconfig/package.json +12 -2
  3. package/dist/application-config/index.js +256 -100
  4. package/dist/cli.js +13 -5
  5. package/dist/commons/api/router.d.ts +109 -21
  6. package/dist/commons/application-config/index.d.ts +1 -0
  7. package/dist/commons/conditionals/conditionals.d.ts +354 -4
  8. package/dist/commons/conditionals/validate.d.ts +51 -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 +42 -36
  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 +2 -3
  15. package/dist/commons/events/EventDocument.d.ts +3 -0
  16. package/dist/commons/events/EventIndex.d.ts +14 -0
  17. package/dist/commons/events/FieldConfig.d.ts +378 -50
  18. package/dist/commons/events/FieldType.d.ts +1 -0
  19. package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
  20. package/dist/commons/events/FieldValue.d.ts +6 -0
  21. package/dist/commons/events/WorkqueueConfig.d.ts +44 -5
  22. package/dist/commons/events/field.d.ts +53 -1
  23. package/dist/commons/events/index.d.ts +2 -0
  24. package/dist/commons/events/state/flags.d.ts +16 -0
  25. package/dist/commons/events/state/utils.d.ts +12 -287
  26. package/dist/commons/events/utils.d.ts +12 -1
  27. package/dist/conditionals/index.js +55 -2
  28. package/dist/events/index.js +1043 -227
  29. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  30. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  31. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -1
  32. package/dist/migrations/v2.0/index.js +13 -5
  33. package/dist/notification/index.js +877 -125
  34. package/dist/scopes/index.d.ts +4 -6
  35. package/dist/scopes/index.js +12 -4
  36. package/opencrvs-toolkit-2.0.0-rc.5f39c86.tgz +0 -0
  37. package/package.json +6 -2
  38. package/opencrvs-toolkit-2.0.0-rc.5e06f40.tgz +0 -0
@@ -76,8 +76,8 @@ var ActionConditional = z.discriminatedUnion("type", [
76
76
  // Action can be shown to the user in the list but as disabled
77
77
  EnableConditional
78
78
  ]).meta({
79
- description: "Action conditional configuration",
80
- id: "ActionConditional"
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
81
  });
82
82
  var DisplayOnReviewConditional = z.object({
83
83
  type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
@@ -93,8 +93,8 @@ var FieldConditional = z.discriminatedUnion("type", [
93
93
  // Field output can be shown / hidden on the review page
94
94
  DisplayOnReviewConditional
95
95
  ]).meta({
96
- description: "Field conditional configuration",
97
- 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."
98
98
  });
99
99
 
100
100
  // ../commons/src/events/TranslationConfig.ts
@@ -206,6 +206,11 @@ var FieldTypesToHideInReview = [
206
206
  FieldType.ALPHA_PRINT_BUTTON,
207
207
  FieldType.ALPHA_HIDDEN
208
208
  ];
209
+ var HiddenFieldTypes = [
210
+ FieldType.HTTP,
211
+ FieldType.QUERY_PARAM_READER,
212
+ FieldType.ALPHA_HIDDEN
213
+ ];
209
214
 
210
215
  // ../commons/src/events/FieldValue.ts
211
216
  var z7 = __toESM(require("zod/v4"));
@@ -324,7 +329,7 @@ var PlainDate = import_zod.z.string().date().brand("PlainDate").describe("Date i
324
329
  // ../commons/src/events/FieldValue.ts
325
330
  var TextValue = z7.string();
326
331
  var HiddenFieldValue = z7.string();
327
- var NonEmptyTextValue = TextValue.min(1);
332
+ var NonEmptyTextValue = z7.string().trim().min(1);
328
333
  var DateValue = z7.iso.date().describe("Date in the format YYYY-MM-DD");
329
334
  var AgeValue = z7.object({
330
335
  age: z7.number(),
@@ -353,6 +358,7 @@ var DateRangeFieldValue = z7.object({
353
358
  var EmailValue = z7.email();
354
359
  var CheckboxFieldValue = z7.boolean();
355
360
  var NumberFieldValue = z7.number();
361
+ var SignatureFieldValue = FileFieldValue;
356
362
  var ButtonFieldValue = z7.number();
357
363
  var VerificationStatusValue = z7.enum([
358
364
  "verified",
@@ -834,7 +840,9 @@ var ScopeType = z11.enum([
834
840
  var EncodedScope = z11.string().brand("EncodedScope");
835
841
  var DEFAULT_SCOPE_OPTIONS = {
836
842
  placeOfEvent: JurisdictionFilter.enum.all,
837
- accessLevel: JurisdictionFilter.enum.all
843
+ accessLevel: JurisdictionFilter.enum.all,
844
+ registeredIn: JurisdictionFilter.enum.all,
845
+ declaredIn: JurisdictionFilter.enum.all
838
846
  };
839
847
 
840
848
  // ../commons/src/authentication.ts
@@ -987,8 +995,9 @@ var RequestedCorrectionAction = ActionBase.extend(
987
995
  var ApprovedCorrectionAction = ActionBase.extend(
988
996
  z13.object({
989
997
  type: z13.literal(ActionType.APPROVE_CORRECTION),
990
- requestId: z13.string()
998
+ requestId: z13.string(),
991
999
  // TODO move into 'content' property
1000
+ content: z13.object({ immediateCorrection: z13.boolean().optional() }).optional()
992
1001
  }).shape
993
1002
  );
994
1003
  var RejectedCorrectionAction = ActionBase.extend(
@@ -1081,8 +1090,8 @@ var FlagConfig = z14.object({
1081
1090
  ),
1082
1091
  label: TranslationConfig.describe("Human readable label of the flag.")
1083
1092
  }).meta({
1084
- description: "Flag configuration",
1085
- id: "FlagConfig"
1093
+ id: "FlagConfig",
1094
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1086
1095
  });
1087
1096
  var ActionFlagConfig = z14.object({
1088
1097
  id: Flag,
@@ -1091,8 +1100,8 @@ var ActionFlagConfig = z14.object({
1091
1100
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1092
1101
  )
1093
1102
  }).meta({
1094
- description: "Action flag configuration",
1095
- id: "ActionFlagConfig"
1103
+ id: "ActionFlagConfig",
1104
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1096
1105
  });
1097
1106
 
1098
1107
  // ../commons/src/events/EventMetadata.ts
@@ -1251,7 +1260,8 @@ var Range = import_v4.z.object({
1251
1260
  });
1252
1261
  var ContainsFlags = import_v4.z.object({
1253
1262
  anyOf: import_v4.z.array(Flag).optional(),
1254
- noneOf: import_v4.z.array(Flag).optional()
1263
+ noneOf: import_v4.z.array(Flag).optional(),
1264
+ allOf: import_v4.z.array(Flag).optional()
1255
1265
  }).meta({
1256
1266
  id: "ContainsFlags"
1257
1267
  });
@@ -1405,14 +1415,31 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1405
1415
  }
1406
1416
  }).describe("Unique identifier for the field");
1407
1417
  var FieldReference = import_v43.default.object({
1408
- $$field: FieldId,
1418
+ $$field: FieldId.describe("Id of the field to reference"),
1409
1419
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1410
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."
1424
+ )
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."
1411
1431
  )
1412
- }).describe("Reference to a field by its ID");
1432
+ }).describe("A context-only computation used as a field default value.");
1413
1433
  var ValidationConfig = import_v43.default.object({
1414
- validator: Conditional,
1415
- 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."
1416
1443
  });
1417
1444
  var requiredSchema = import_v43.default.union([
1418
1445
  import_v43.default.boolean(),
@@ -1443,7 +1470,7 @@ var BaseField = import_v43.default.object({
1443
1470
  "Indicates whether the field can be modified during record correction."
1444
1471
  ),
1445
1472
  value: FieldReference.or(import_v43.default.array(FieldReference)).optional().describe(
1446
- "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."
1447
1474
  ),
1448
1475
  analytics: import_v43.default.boolean().default(false).optional().describe(
1449
1476
  "Indicates whether the field is included in analytics. When enabled, its value becomes available in the analytics dashboard."
@@ -1451,30 +1478,40 @@ var BaseField = import_v43.default.object({
1451
1478
  }).describe("Common properties shared across all field types.");
1452
1479
  var Divider = BaseField.extend({
1453
1480
  type: import_v43.default.literal(FieldType.DIVIDER)
1481
+ }).meta({
1482
+ description: "A horizontal line divider",
1483
+ id: "Divider"
1454
1484
  });
1455
1485
  var TextField = BaseField.extend({
1456
1486
  type: import_v43.default.literal(FieldType.TEXT),
1457
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1487
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1458
1488
  configuration: import_v43.default.object({
1459
1489
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1460
1490
  type: import_v43.default.enum(["text", "password"]).optional(),
1461
1491
  prefix: TranslationConfig.optional(),
1462
1492
  postfix: TranslationConfig.optional()
1463
1493
  }).default({ type: "text" }).optional()
1464
- }).describe("Text input");
1494
+ }).meta({
1495
+ description: "A text input field",
1496
+ id: "TextField"
1497
+ });
1465
1498
  var NumberField = BaseField.extend({
1466
1499
  type: import_v43.default.literal(FieldType.NUMBER),
1467
- defaultValue: NumberFieldValue.optional(),
1500
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1468
1501
  configuration: import_v43.default.object({
1469
1502
  min: import_v43.default.number().optional().describe("Minimum value"),
1470
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"),
1471
1505
  prefix: TranslationConfig.optional(),
1472
1506
  postfix: TranslationConfig.optional()
1473
1507
  }).optional()
1474
- }).describe("Number input");
1508
+ }).meta({
1509
+ description: "A number input field",
1510
+ id: "NumberField"
1511
+ });
1475
1512
  var TextAreaField = BaseField.extend({
1476
1513
  type: import_v43.default.literal(FieldType.TEXTAREA),
1477
- defaultValue: NonEmptyTextValue.optional(),
1514
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1478
1515
  configuration: import_v43.default.object({
1479
1516
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1480
1517
  rows: import_v43.default.number().optional().describe("Number of visible text lines"),
@@ -1482,7 +1519,10 @@ var TextAreaField = BaseField.extend({
1482
1519
  prefix: TranslationConfig.optional(),
1483
1520
  postfix: TranslationConfig.optional()
1484
1521
  }).default({ rows: 4 }).optional()
1485
- }).describe("Multiline text input");
1522
+ }).meta({
1523
+ description: "A multiline text input",
1524
+ id: "TextAreaField"
1525
+ });
1486
1526
  var ImageMimeType = import_v43.default.enum([
1487
1527
  "image/png",
1488
1528
  "image/jpg",
@@ -1505,58 +1545,76 @@ var SignatureField = BaseField.extend({
1505
1545
  signaturePromptLabel: TranslationConfig.describe(
1506
1546
  "Title of the signature modal"
1507
1547
  ),
1508
- defaultValue: FieldValue.optional(),
1548
+ defaultValue: SignatureFieldValue.or(ComputedDefaultValue).optional(),
1509
1549
  configuration: import_v43.default.object({
1510
1550
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1511
1551
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature")
1512
1552
  }).default({
1513
1553
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1514
1554
  })
1515
- }).describe("Signature input field");
1555
+ }).meta({
1556
+ description: "A signature input field",
1557
+ id: "SignatureField"
1558
+ });
1516
1559
  var EmailField = BaseField.extend({
1517
1560
  type: import_v43.default.literal(FieldType.EMAIL),
1518
1561
  configuration: import_v43.default.object({
1519
1562
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1520
1563
  }).default({ maxLength: 255 }).optional(),
1521
- defaultValue: NonEmptyTextValue.optional()
1564
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional()
1565
+ }).meta({
1566
+ description: "An email input field",
1567
+ id: "EmailField"
1522
1568
  });
1523
1569
  var DateField = BaseField.extend({
1524
1570
  type: import_v43.default.literal(FieldType.DATE),
1525
- 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)"),
1526
1572
  configuration: import_v43.default.object({
1527
1573
  notice: TranslationConfig.describe(
1528
1574
  "Text to display above the date input"
1529
1575
  ).optional()
1530
1576
  }).optional()
1531
- }).describe("A single date input (yyyy-MM-dd)");
1577
+ }).meta({
1578
+ description: "A date input (yyyy-MM-dd)",
1579
+ id: "DateField"
1580
+ });
1532
1581
  var AgeField = BaseField.extend({
1533
1582
  type: import_v43.default.literal(FieldType.AGE),
1534
- defaultValue: NumberFieldValue.optional(),
1583
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1535
1584
  configuration: import_v43.default.object({
1536
1585
  asOfDate: FieldReference,
1537
1586
  prefix: TranslationConfig.optional(),
1538
1587
  postfix: TranslationConfig.optional()
1539
1588
  })
1540
- }).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
+ });
1541
1593
  var TimeField = BaseField.extend({
1542
1594
  type: import_v43.default.literal(FieldType.TIME),
1543
- 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)"),
1544
1596
  configuration: import_v43.default.object({
1545
1597
  use12HourFormat: import_v43.default.boolean().optional().describe("Whether to use 12-hour format"),
1546
1598
  notice: TranslationConfig.describe(
1547
1599
  "Text to display above the time input"
1548
1600
  ).optional()
1549
1601
  }).optional()
1550
- }).describe("A single date input (HH-mm)");
1602
+ }).meta({
1603
+ description: "A single time input (HH-mm)",
1604
+ id: "TimeField"
1605
+ });
1551
1606
  var DateRangeField = BaseField.extend({
1552
1607
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1553
- defaultValue: DateRangeFieldValue.optional(),
1608
+ defaultValue: DateRangeFieldValue.or(ComputedDefaultValue).optional(),
1554
1609
  configuration: import_v43.default.object({
1555
1610
  notice: TranslationConfig.describe(
1556
1611
  "Text to display above the date input"
1557
1612
  ).optional()
1558
1613
  }).optional()
1559
- }).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
+ });
1560
1618
  var HtmlFontVariant = import_v43.default.enum([
1561
1619
  "reg12",
1562
1620
  "reg14",
@@ -1600,21 +1658,33 @@ var ImageViewField = BaseField.extend({
1600
1658
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1601
1659
  defaultValue: NonEmptyTextValue.optional(),
1602
1660
  configuration: ImageConfiguration
1603
- }).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
+ });
1604
1665
  var Paragraph = BaseField.extend({
1605
1666
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1606
1667
  configuration: ParagraphConfiguration
1607
- }).describe("A read-only HTML <p> paragraph");
1668
+ }).meta({
1669
+ description: "A read-only HTML <p> paragraph",
1670
+ id: "Paragraph"
1671
+ });
1608
1672
  var Heading = BaseField.extend({
1609
1673
  type: import_v43.default.literal(FieldType.HEADING),
1610
1674
  configuration: HeadingConfiguration
1611
- }).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
+ });
1612
1679
  var PageHeader = BaseField.extend({
1613
1680
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1614
- }).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
+ });
1615
1685
  var File = BaseField.extend({
1616
1686
  type: import_v43.default.literal(FieldType.FILE),
1617
- defaultValue: FileFieldValue.optional(),
1687
+ defaultValue: FileFieldValue.or(ComputedDefaultValue).optional(),
1618
1688
  configuration: import_v43.default.object({
1619
1689
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1620
1690
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature"),
@@ -1630,7 +1700,10 @@ var File = BaseField.extend({
1630
1700
  }).default({
1631
1701
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1632
1702
  })
1633
- }).describe("File upload");
1703
+ }).meta({
1704
+ description: "A file upload field",
1705
+ id: "File"
1706
+ });
1634
1707
  var SelectOption = import_v43.default.object({
1635
1708
  value: import_v43.default.string().describe("The value of the option"),
1636
1709
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1638,7 +1711,7 @@ var SelectOption = import_v43.default.object({
1638
1711
  });
1639
1712
  var NumberWithUnitField = BaseField.extend({
1640
1713
  type: import_v43.default.literal(FieldType.NUMBER_WITH_UNIT),
1641
- defaultValue: NumberWithUnitFieldValue.optional(),
1714
+ defaultValue: NumberWithUnitFieldValue.or(ComputedDefaultValue).optional(),
1642
1715
  options: import_v43.default.array(SelectOption).describe("A list of options for the unit select"),
1643
1716
  configuration: import_v43.default.object({
1644
1717
  min: import_v43.default.number().optional().describe("Minimum value of the number field"),
@@ -1647,17 +1720,23 @@ var NumberWithUnitField = BaseField.extend({
1647
1720
  "Placeholder for the number field"
1648
1721
  )
1649
1722
  }).optional()
1650
- }).describe("Number with unit input");
1723
+ }).meta({
1724
+ description: "A number with unit input field",
1725
+ id: "NumberWithUnitField"
1726
+ });
1651
1727
  var RadioGroup = BaseField.extend({
1652
1728
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1653
- defaultValue: TextValue.optional(),
1729
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1654
1730
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1655
1731
  configuration: import_v43.default.object({
1656
1732
  styles: import_v43.default.object({
1657
1733
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1658
1734
  }).optional()
1659
1735
  }).optional()
1660
- }).describe("Grouped radio options");
1736
+ }).meta({
1737
+ description: "A grouped radio button field",
1738
+ id: "RadioGroup"
1739
+ });
1661
1740
  var BulletList = BaseField.extend({
1662
1741
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1663
1742
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1666,10 +1745,13 @@ var BulletList = BaseField.extend({
1666
1745
  fontVariant: HtmlFontVariant.optional()
1667
1746
  }).optional()
1668
1747
  }).default({})
1669
- }).describe("A list of bullet points");
1748
+ }).meta({
1749
+ description: "A list of bullet points",
1750
+ id: "BulletList"
1751
+ });
1670
1752
  var Select = BaseField.extend({
1671
1753
  type: import_v43.default.literal(FieldType.SELECT),
1672
- defaultValue: TextValue.optional(),
1754
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1673
1755
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1674
1756
  noOptionsMessage: TranslationConfig.optional().describe(
1675
1757
  `
@@ -1681,16 +1763,22 @@ var Select = BaseField.extend({
1681
1763
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1682
1764
  `
1683
1765
  )
1684
- }).describe("Select input");
1766
+ }).meta({
1767
+ description: "A select input field",
1768
+ id: "Select"
1769
+ });
1685
1770
  var SelectDateRangeOption = import_v43.default.object({
1686
1771
  value: SelectDateRangeValue.describe("The value of the option"),
1687
1772
  label: TranslationConfig.describe("The label of the option")
1688
1773
  });
1689
1774
  var SelectDateRangeField = BaseField.extend({
1690
1775
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1691
- defaultValue: SelectDateRangeValue.optional(),
1776
+ defaultValue: SelectDateRangeValue.or(ComputedDefaultValue).optional(),
1692
1777
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1693
- }).describe("Select input with date range options");
1778
+ }).meta({
1779
+ description: "A date range selection field",
1780
+ id: "SelectDateRangeField"
1781
+ });
1694
1782
  var NameConfig = import_v43.default.object({
1695
1783
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1696
1784
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1702,7 +1790,7 @@ var NameField = BaseField.extend({
1702
1790
  firstname: SerializedUserField.or(NonEmptyTextValue).optional(),
1703
1791
  middlename: SerializedUserField.or(NonEmptyTextValue).optional(),
1704
1792
  surname: SerializedUserField.or(NonEmptyTextValue).optional()
1705
- }).optional(),
1793
+ }).or(ComputedDefaultValue).optional(),
1706
1794
  configuration: import_v43.default.object({
1707
1795
  name: NameConfig.default({
1708
1796
  firstname: { required: true },
@@ -1721,26 +1809,41 @@ var NameField = BaseField.extend({
1721
1809
  surname: { required: true }
1722
1810
  }
1723
1811
  }).optional()
1724
- }).describe("Name input field");
1812
+ }).meta({
1813
+ description: "A field for entering a persons name",
1814
+ id: "NameField"
1815
+ });
1725
1816
  var PhoneField = BaseField.extend({
1726
- defaultValue: NonEmptyTextValue.optional(),
1817
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1727
1818
  type: import_v43.default.literal(FieldType.PHONE)
1728
- }).describe("Phone input field");
1819
+ }).meta({
1820
+ description: "A field for entering a phone number",
1821
+ id: "PhoneField"
1822
+ });
1729
1823
  var IdField = BaseField.extend({
1730
- defaultValue: NonEmptyTextValue.optional(),
1824
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1731
1825
  type: import_v43.default.literal(FieldType.ID)
1732
- }).describe("ID input field");
1826
+ }).meta({
1827
+ description: "A field for entering an ID",
1828
+ id: "IdField"
1829
+ });
1733
1830
  var Checkbox = BaseField.extend({
1734
1831
  type: import_v43.default.literal(FieldType.CHECKBOX),
1735
- defaultValue: CheckboxFieldValue.default(false)
1736
- }).describe("Boolean checkbox field");
1832
+ defaultValue: CheckboxFieldValue.or(ComputedDefaultValue).default(false)
1833
+ }).meta({
1834
+ description: "A boolean checkbox field",
1835
+ id: "Checkbox"
1836
+ });
1737
1837
  var Country = BaseField.extend({
1738
1838
  type: import_v43.default.literal(FieldType.COUNTRY),
1739
- defaultValue: NonEmptyTextValue.optional(),
1839
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1740
1840
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1741
1841
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1742
1842
  )
1743
- }).describe("Country select field");
1843
+ }).meta({
1844
+ description: "A field for selecting a country",
1845
+ id: "Country"
1846
+ });
1744
1847
  var AllowedLocations = JurisdictionReference.optional().describe(
1745
1848
  "Limits which location options are selectable depending on user jurisdiction and location."
1746
1849
  );
@@ -1749,28 +1852,33 @@ var AdministrativeAreas = import_v43.default.enum([
1749
1852
  "HEALTH_FACILITY",
1750
1853
  "CRVS_OFFICE"
1751
1854
  ]);
1752
- var AdministrativeAreaConfiguration = import_v43.default.object({
1753
- partOf: FieldReference.optional().describe("Parent location"),
1754
- type: AdministrativeAreas,
1755
- allowedLocations: AllowedLocations
1756
- }).describe("Administrative area options");
1757
1855
  var AdministrativeAreaField = BaseField.extend({
1758
1856
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1759
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1760
- configuration: AdministrativeAreaConfiguration
1761
- }).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
+ });
1762
1867
  var LocationInput = BaseField.extend({
1763
1868
  type: import_v43.default.literal(FieldType.LOCATION),
1764
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1869
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1765
1870
  configuration: import_v43.default.object({
1766
1871
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1767
1872
  allowedLocations: AllowedLocations
1768
1873
  }).optional()
1769
- }).describe("Input field for a location");
1874
+ }).meta({
1875
+ description: "A field for selecting a location",
1876
+ id: "LocationInput"
1877
+ });
1770
1878
  var FileUploadWithOptions = BaseField.extend({
1771
1879
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1772
1880
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1773
- defaultValue: FileFieldWithOptionValue.optional(),
1881
+ defaultValue: FileFieldWithOptionValue.or(ComputedDefaultValue).optional(),
1774
1882
  configuration: import_v43.default.object({
1775
1883
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1776
1884
  maxImageSize: import_v43.default.object({
@@ -1780,15 +1888,18 @@ var FileUploadWithOptions = BaseField.extend({
1780
1888
  }).default({
1781
1889
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1782
1890
  })
1891
+ }).meta({
1892
+ description: "A field for uploading files with file type options",
1893
+ id: "FileUploadWithOptions"
1783
1894
  });
1784
1895
  var Facility = BaseField.extend({
1785
1896
  type: import_v43.default.literal(FieldType.FACILITY),
1786
- defaultValue: NonEmptyTextValue.optional(),
1897
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1787
1898
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1788
1899
  }).describe("Input field for a facility");
1789
1900
  var Office = BaseField.extend({
1790
1901
  type: import_v43.default.literal(FieldType.OFFICE),
1791
- defaultValue: NonEmptyTextValue.optional(),
1902
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1792
1903
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1793
1904
  }).describe("Input field for an office");
1794
1905
  var DefaultAddressFieldValue = DomesticAddressFieldValue.extend({
@@ -1824,8 +1935,11 @@ var Address = BaseField.extend({
1824
1935
  ).optional(),
1825
1936
  allowedLocations: AllowedLocations
1826
1937
  }).optional(),
1827
- defaultValue: DefaultAddressFieldValue.optional()
1828
- }).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
+ });
1829
1943
  var StaticDataEntry = import_v43.default.object({
1830
1944
  id: import_v43.default.string().describe("ID for the data entry."),
1831
1945
  label: TranslationConfig,
@@ -1840,7 +1954,10 @@ var DataField = BaseField.extend({
1840
1954
  subtitle: TranslationConfig.optional(),
1841
1955
  data: import_v43.default.array(DataEntry)
1842
1956
  })
1843
- }).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
+ });
1844
1961
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1845
1962
  var ButtonType = import_v43.default.enum([
1846
1963
  "primary",
@@ -1865,13 +1982,19 @@ var ButtonConfiguration = import_v43.default.object({
1865
1982
  });
1866
1983
  var ButtonField = BaseField.extend({
1867
1984
  type: import_v43.default.literal(FieldType.BUTTON),
1868
- defaultValue: ButtonFieldValue.optional(),
1985
+ defaultValue: ButtonFieldValue.or(ComputedDefaultValue).optional(),
1869
1986
  configuration: ButtonConfiguration
1870
- }).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
+ });
1871
1991
  var FieldGroup = BaseField.extend({
1872
1992
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1873
1993
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1874
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"
1875
1998
  });
1876
1999
  var AlphaPrintButton = BaseField.extend({
1877
2000
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1881,10 +2004,13 @@ var AlphaPrintButton = BaseField.extend({
1881
2004
  "Label for the print button"
1882
2005
  )
1883
2006
  })
1884
- }).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
+ });
1885
2011
  var HttpField = BaseField.extend({
1886
2012
  type: import_v43.default.literal(FieldType.HTTP),
1887
- defaultValue: HttpFieldValue.optional(),
2013
+ defaultValue: HttpFieldValue.or(ComputedDefaultValue).optional(),
1888
2014
  configuration: import_v43.default.object({
1889
2015
  trigger: FieldReference.optional().describe(
1890
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."
@@ -1897,20 +2023,30 @@ var HttpField = BaseField.extend({
1897
2023
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1898
2024
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1899
2025
  })
1900
- }).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
+ });
1901
2030
  var AutocompleteField = BaseField.extend({
1902
2031
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1903
2032
  configuration: import_v43.default.object({
1904
- 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(),
1905
2036
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1906
2037
  defaultOptions: import_v43.default.array(
1907
2038
  import_v43.default.object({
1908
2039
  label: import_v43.default.string(),
1909
2040
  value: import_v43.default.string()
1910
2041
  })
1911
- ).optional()
2042
+ ).optional().describe(
2043
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2044
+ )
1912
2045
  })
1913
- }).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
+ });
1914
2050
  var SearchField = HttpField.extend({
1915
2051
  type: import_v43.default.literal(FieldType.SEARCH),
1916
2052
  configuration: SearchQuery.pick({
@@ -1943,6 +2079,9 @@ var SearchField = HttpField.extend({
1943
2079
  ok: TranslationConfig.optional()
1944
2080
  }).optional()
1945
2081
  })
2082
+ }).meta({
2083
+ description: "A search input field",
2084
+ id: "SearchField"
1946
2085
  });
1947
2086
  var LinkButtonField = BaseField.extend({
1948
2087
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1951,28 +2090,35 @@ var LinkButtonField = BaseField.extend({
1951
2090
  text: TranslationConfig.describe("Text to display on the button"),
1952
2091
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1953
2092
  })
1954
- }).describe("Button that opens a link");
2093
+ }).meta({
2094
+ description: "A button that opens a URL link",
2095
+ id: "LinkButtonField"
2096
+ });
1955
2097
  var VerificationStatus = BaseField.extend({
1956
2098
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1957
- defaultValue: VerificationStatusValue.optional(),
2099
+ defaultValue: VerificationStatusValue.or(ComputedDefaultValue).optional(),
1958
2100
  configuration: import_v43.default.object({
1959
2101
  status: TranslationConfig.describe("Text to display on the status pill."),
1960
2102
  description: TranslationConfig.describe(
1961
2103
  "Explaining text on the banner in form."
1962
2104
  )
1963
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"
1964
2109
  });
1965
2110
  var QueryParamReaderField = BaseField.extend({
1966
2111
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1967
2112
  configuration: import_v43.default.object({
1968
2113
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1969
2114
  })
1970
- }).describe(
1971
- "A field that maps URL query params into form values and clears them afterward"
1972
- );
2115
+ }).meta({
2116
+ description: "A field that maps URL query params into form values and clears them afterward",
2117
+ id: "QueryParamReaderField"
2118
+ });
1973
2119
  var QrReaderField = BaseField.extend({
1974
2120
  type: import_v43.default.literal(FieldType.QR_READER),
1975
- defaultValue: QrReaderFieldValue.optional(),
2121
+ defaultValue: QrReaderFieldValue.or(ComputedDefaultValue).optional(),
1976
2122
  configuration: import_v43.default.object({
1977
2123
  validator: import_v43.default.any().meta({
1978
2124
  description: "JSON Schema to validate the scanned QR code data against before populating the form fields.",
@@ -1980,21 +2126,27 @@ var QrReaderField = BaseField.extend({
1980
2126
  })
1981
2127
  }).optional()
1982
2128
  }).meta({
1983
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2129
+ description: "QR code reader field, including optional JSON Schema validator.",
1984
2130
  id: "QrReaderField"
1985
2131
  });
1986
2132
  var IdReaderField = BaseField.extend({
1987
2133
  type: import_v43.default.literal(FieldType.ID_READER),
1988
- defaultValue: IdReaderFieldValue.optional(),
2134
+ defaultValue: IdReaderFieldValue.or(ComputedDefaultValue).optional(),
1989
2135
  methods: import_v43.default.array(
1990
2136
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1991
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"
1992
2141
  });
1993
2142
  var CustomField = BaseField.extend({
1994
2143
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1995
2144
  defaultValue: CustomFieldValue.optional(),
1996
2145
  src: import_v43.default.string().describe("Module source path for the custom field component"),
1997
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"
1998
2150
  });
1999
2151
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2000
2152
  var LoaderField = BaseField.extend({
@@ -2004,22 +2156,25 @@ var LoaderField = BaseField.extend({
2004
2156
  configuration: import_v43.default.object({
2005
2157
  text: TranslationConfig.describe("Display text above the loading spinner")
2006
2158
  })
2007
- }).describe(
2008
- "A non-interactive field that indicates an in progress operation in form"
2009
- );
2159
+ }).meta({
2160
+ description: "A non-interactive field that indicates an in progress operation in form",
2161
+ id: "LoaderField"
2162
+ });
2010
2163
  var HiddenField = BaseField.extend({
2011
2164
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2012
2165
  required: import_v43.default.boolean().default(false).optional(),
2013
2166
  defaultValue: TextValue.optional()
2014
- }).describe(
2015
- "A non-interactive, hidden field that only hold a value in the form"
2016
- );
2167
+ }).meta({
2168
+ description: "A non-interactive, hidden field that only hold a value in the form",
2169
+ id: "HiddenField"
2170
+ });
2017
2171
  var UserRoleField = BaseField.extend({
2018
2172
  type: import_v43.default.literal(FieldType.USER_ROLE),
2019
2173
  defaultValue: TextValue.optional()
2020
- }).describe(
2021
- "A select dropdown that is automatically populated with available user roles"
2022
- );
2174
+ }).meta({
2175
+ description: "A select dropdown that is automatically populated with available user roles",
2176
+ id: "UserRoleField"
2177
+ });
2023
2178
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2024
2179
  FieldGroup,
2025
2180
  Address,
@@ -2137,6 +2292,7 @@ var ClientConfig = z20.object({
2137
2292
  COUNTRY: z20.string(),
2138
2293
  LANGUAGES: z20.array(z20.string()),
2139
2294
  SENTRY: z20.string().optional(),
2295
+ LOGIN_URL: z20.string().optional(),
2140
2296
  REGISTER_BACKGROUND: BackgroundConfig,
2141
2297
  DASHBOARDS: z20.array(
2142
2298
  z20.object({