@opencrvs/toolkit 2.0.0-rc.9fb7bf7 → 2.0.0-rc.a0fc425

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 (36) 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 +262 -117
  4. package/dist/cli.js +206 -36
  5. package/dist/commons/api/router.d.ts +3311 -246
  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 +52 -2
  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 +377 -50
  14. package/dist/commons/events/FieldValue.d.ts +6 -0
  15. package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
  16. package/dist/commons/events/field.d.ts +47 -1
  17. package/dist/commons/events/index.d.ts +2 -0
  18. package/dist/commons/events/state/flags.d.ts +16 -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 +2 -2
  22. package/dist/conditionals/index.js +55 -2
  23. package/dist/events/index.js +916 -246
  24. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  25. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  26. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  27. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  28. package/dist/migrations/v2.0/index.js +204 -34
  29. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  30. package/dist/migrations/v2.0/migrate-scopes.js +54 -30
  31. package/dist/notification/index.js +797 -151
  32. package/dist/scopes/index.js +3 -1
  33. package/opencrvs-toolkit-2.0.0-rc.a0fc425.tgz +0 -0
  34. package/package.json +6 -2
  35. package/tsconfig.tsbuildinfo +1 -1
  36. package/opencrvs-toolkit-2.0.0-rc.9fb7bf7.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
@@ -350,6 +353,7 @@ var DateRangeFieldValue = z7.object({
350
353
  var EmailValue = z7.email();
351
354
  var CheckboxFieldValue = z7.boolean();
352
355
  var NumberFieldValue = z7.number();
356
+ var SignatureFieldValue = FileFieldValue;
353
357
  var ButtonFieldValue = z7.number();
354
358
  var VerificationStatusValue = z7.enum([
355
359
  "verified",
@@ -418,28 +422,20 @@ function schemaPriority(schema) {
418
422
  return idx === -1 ? 9999 : idx;
419
423
  }
420
424
  function safeUnion(schemas) {
425
+ const sortedSchemas = [...schemas].sort(
426
+ (a, b) => schemaPriority(a) - schemaPriority(b)
427
+ );
421
428
  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
- });
429
+ for (const schema of sortedSchemas) {
430
+ if (schema.safeParse(val).success) {
431
+ return;
432
+ }
442
433
  }
434
+ ctx.addIssue({
435
+ code: "invalid_type",
436
+ expected: "custom",
437
+ message: "Value does not match any schema"
438
+ });
443
439
  }).meta({
444
440
  description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
445
441
  });
@@ -839,7 +835,9 @@ var ScopeType = z11.enum([
839
835
  var EncodedScope = z11.string().brand("EncodedScope");
840
836
  var DEFAULT_SCOPE_OPTIONS = {
841
837
  placeOfEvent: JurisdictionFilter.enum.all,
842
- accessLevel: JurisdictionFilter.enum.all
838
+ accessLevel: JurisdictionFilter.enum.all,
839
+ registeredIn: JurisdictionFilter.enum.all,
840
+ declaredIn: JurisdictionFilter.enum.all
843
841
  };
844
842
 
845
843
  // ../commons/src/authentication.ts
@@ -1085,6 +1083,9 @@ var FlagConfig = z14.object({
1085
1083
  "Indicates if this flag expects an action to be performed to be cleared."
1086
1084
  ),
1087
1085
  label: TranslationConfig.describe("Human readable label of the flag.")
1086
+ }).meta({
1087
+ id: "FlagConfig",
1088
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1088
1089
  });
1089
1090
  var ActionFlagConfig = z14.object({
1090
1091
  id: Flag,
@@ -1092,6 +1093,9 @@ var ActionFlagConfig = z14.object({
1092
1093
  conditional: Conditional.optional().describe(
1093
1094
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1094
1095
  )
1096
+ }).meta({
1097
+ id: "ActionFlagConfig",
1098
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1095
1099
  });
1096
1100
 
1097
1101
  // ../commons/src/events/EventMetadata.ts
@@ -1113,8 +1117,7 @@ var ActionCreationMetadata = z15.object({
1113
1117
  ),
1114
1118
  createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1115
1119
  acceptedAt: z15.iso.datetime().describe("Timestamp when the action request was accepted."),
1116
- createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation."),
1117
- createdBySignature: z15.string().nullish().describe("Signature of the user who created the action request.")
1120
+ createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation.")
1118
1121
  });
1119
1122
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1120
1123
  registrationNumber: z15.string().describe(
@@ -1142,9 +1145,6 @@ var EventMetadata = z15.object({
1142
1145
  createdAtLocation: UUID.nullish().describe(
1143
1146
  "Location of the user who created the event."
1144
1147
  ),
1145
- createdBySignature: DocumentPath.nullish().describe(
1146
- "Signature of the user who created the event."
1147
- ),
1148
1148
  updatedAtLocation: UUID.nullish().describe(
1149
1149
  "Location of the user who last changed the status."
1150
1150
  ),
@@ -1408,14 +1408,31 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1408
1408
  }
1409
1409
  }).describe("Unique identifier for the field");
1410
1410
  var FieldReference = import_v43.default.object({
1411
- $$field: FieldId,
1411
+ $$field: FieldId.describe("Id of the field to reference"),
1412
1412
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1413
1413
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1414
+ ),
1415
+ $$code: import_v43.default.string().optional().describe(
1416
+ "Serialised client-side function body. When present the expression is evaluated rather than dereferenced."
1417
+ )
1418
+ }).describe(
1419
+ "Reference to a field value, with an optional client-side computation applied."
1420
+ );
1421
+ var ComputedDefaultValue = import_v43.default.object({
1422
+ $$code: import_v43.default.string().describe(
1423
+ "Serialised client-side function body. Receives (undefined, context) where context includes $now, $online, and system variables."
1414
1424
  )
1415
- }).describe("Reference to a field by its ID");
1425
+ }).describe("A context-only computation used as a field default value.");
1416
1426
  var ValidationConfig = import_v43.default.object({
1417
- validator: Conditional,
1418
- message: TranslationConfig
1427
+ validator: Conditional.describe(
1428
+ "Conditional expression that must hold for the field value to be considered valid."
1429
+ ),
1430
+ message: TranslationConfig.describe(
1431
+ "Error message displayed when the validator does not hold."
1432
+ )
1433
+ }).meta({
1434
+ id: "ValidationConfig",
1435
+ 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."
1419
1436
  });
1420
1437
  var requiredSchema = import_v43.default.union([
1421
1438
  import_v43.default.boolean(),
@@ -1446,7 +1463,7 @@ var BaseField = import_v43.default.object({
1446
1463
  "Indicates whether the field can be modified during record correction."
1447
1464
  ),
1448
1465
  value: FieldReference.or(import_v43.default.array(FieldReference)).optional().describe(
1449
- "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."
1466
+ "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."
1450
1467
  ),
1451
1468
  analytics: import_v43.default.boolean().default(false).optional().describe(
1452
1469
  "Indicates whether the field is included in analytics. When enabled, its value becomes available in the analytics dashboard."
@@ -1454,30 +1471,39 @@ var BaseField = import_v43.default.object({
1454
1471
  }).describe("Common properties shared across all field types.");
1455
1472
  var Divider = BaseField.extend({
1456
1473
  type: import_v43.default.literal(FieldType.DIVIDER)
1474
+ }).meta({
1475
+ description: "A horizontal line divider",
1476
+ id: "Divider"
1457
1477
  });
1458
1478
  var TextField = BaseField.extend({
1459
1479
  type: import_v43.default.literal(FieldType.TEXT),
1460
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1480
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1461
1481
  configuration: import_v43.default.object({
1462
1482
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1463
1483
  type: import_v43.default.enum(["text", "password"]).optional(),
1464
1484
  prefix: TranslationConfig.optional(),
1465
1485
  postfix: TranslationConfig.optional()
1466
1486
  }).default({ type: "text" }).optional()
1467
- }).describe("Text input");
1487
+ }).meta({
1488
+ description: "A text input field",
1489
+ id: "TextField"
1490
+ });
1468
1491
  var NumberField = BaseField.extend({
1469
1492
  type: import_v43.default.literal(FieldType.NUMBER),
1470
- defaultValue: NumberFieldValue.optional(),
1493
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1471
1494
  configuration: import_v43.default.object({
1472
1495
  min: import_v43.default.number().optional().describe("Minimum value"),
1473
1496
  max: import_v43.default.number().optional().describe("Maximum value"),
1474
1497
  prefix: TranslationConfig.optional(),
1475
1498
  postfix: TranslationConfig.optional()
1476
1499
  }).optional()
1477
- }).describe("Number input");
1500
+ }).meta({
1501
+ description: "A number input field",
1502
+ id: "NumberField"
1503
+ });
1478
1504
  var TextAreaField = BaseField.extend({
1479
1505
  type: import_v43.default.literal(FieldType.TEXTAREA),
1480
- defaultValue: NonEmptyTextValue.optional(),
1506
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1481
1507
  configuration: import_v43.default.object({
1482
1508
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1483
1509
  rows: import_v43.default.number().optional().describe("Number of visible text lines"),
@@ -1485,7 +1511,10 @@ var TextAreaField = BaseField.extend({
1485
1511
  prefix: TranslationConfig.optional(),
1486
1512
  postfix: TranslationConfig.optional()
1487
1513
  }).default({ rows: 4 }).optional()
1488
- }).describe("Multiline text input");
1514
+ }).meta({
1515
+ description: "A multiline text input",
1516
+ id: "TextAreaField"
1517
+ });
1489
1518
  var ImageMimeType = import_v43.default.enum([
1490
1519
  "image/png",
1491
1520
  "image/jpg",
@@ -1508,58 +1537,76 @@ var SignatureField = BaseField.extend({
1508
1537
  signaturePromptLabel: TranslationConfig.describe(
1509
1538
  "Title of the signature modal"
1510
1539
  ),
1511
- defaultValue: FieldValue.optional(),
1540
+ defaultValue: SignatureFieldValue.or(ComputedDefaultValue).optional(),
1512
1541
  configuration: import_v43.default.object({
1513
1542
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1514
1543
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature")
1515
1544
  }).default({
1516
1545
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1517
1546
  })
1518
- }).describe("Signature input field");
1547
+ }).meta({
1548
+ description: "A signature input field",
1549
+ id: "SignatureField"
1550
+ });
1519
1551
  var EmailField = BaseField.extend({
1520
1552
  type: import_v43.default.literal(FieldType.EMAIL),
1521
1553
  configuration: import_v43.default.object({
1522
1554
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1523
1555
  }).default({ maxLength: 255 }).optional(),
1524
- defaultValue: NonEmptyTextValue.optional()
1556
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional()
1557
+ }).meta({
1558
+ description: "An email input field",
1559
+ id: "EmailField"
1525
1560
  });
1526
1561
  var DateField = BaseField.extend({
1527
1562
  type: import_v43.default.literal(FieldType.DATE),
1528
- defaultValue: SerializedNowDateTime.or(PlainDate).optional().describe("Default date value(yyyy-MM-dd)"),
1563
+ defaultValue: SerializedNowDateTime.or(PlainDate).or(ComputedDefaultValue).optional().describe("Default date value(yyyy-MM-dd)"),
1529
1564
  configuration: import_v43.default.object({
1530
1565
  notice: TranslationConfig.describe(
1531
1566
  "Text to display above the date input"
1532
1567
  ).optional()
1533
1568
  }).optional()
1534
- }).describe("A single date input (yyyy-MM-dd)");
1569
+ }).meta({
1570
+ description: "A date input (yyyy-MM-dd)",
1571
+ id: "DateField"
1572
+ });
1535
1573
  var AgeField = BaseField.extend({
1536
1574
  type: import_v43.default.literal(FieldType.AGE),
1537
- defaultValue: NumberFieldValue.optional(),
1575
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1538
1576
  configuration: import_v43.default.object({
1539
1577
  asOfDate: FieldReference,
1540
1578
  prefix: TranslationConfig.optional(),
1541
1579
  postfix: TranslationConfig.optional()
1542
1580
  })
1543
- }).describe("An age input field which uses the current date as the asOfDate");
1581
+ }).meta({
1582
+ description: "An age input field which uses the current date as the asOfDate",
1583
+ id: "AgeField"
1584
+ });
1544
1585
  var TimeField = BaseField.extend({
1545
1586
  type: import_v43.default.literal(FieldType.TIME),
1546
- defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
1587
+ defaultValue: SerializedNowDateTime.or(TimeValue).or(ComputedDefaultValue).optional().describe("Default time value (HH-mm)"),
1547
1588
  configuration: import_v43.default.object({
1548
1589
  use12HourFormat: import_v43.default.boolean().optional().describe("Whether to use 12-hour format"),
1549
1590
  notice: TranslationConfig.describe(
1550
1591
  "Text to display above the time input"
1551
1592
  ).optional()
1552
1593
  }).optional()
1553
- }).describe("A single date input (HH-mm)");
1594
+ }).meta({
1595
+ description: "A single time input (HH-mm)",
1596
+ id: "TimeField"
1597
+ });
1554
1598
  var DateRangeField = BaseField.extend({
1555
1599
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1556
- defaultValue: DateRangeFieldValue.optional(),
1600
+ defaultValue: DateRangeFieldValue.or(ComputedDefaultValue).optional(),
1557
1601
  configuration: import_v43.default.object({
1558
1602
  notice: TranslationConfig.describe(
1559
1603
  "Text to display above the date input"
1560
1604
  ).optional()
1561
1605
  }).optional()
1562
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
1606
+ }).meta({
1607
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
1608
+ id: "DateRangeField"
1609
+ });
1563
1610
  var HtmlFontVariant = import_v43.default.enum([
1564
1611
  "reg12",
1565
1612
  "reg14",
@@ -1603,21 +1650,33 @@ var ImageViewField = BaseField.extend({
1603
1650
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1604
1651
  defaultValue: NonEmptyTextValue.optional(),
1605
1652
  configuration: ImageConfiguration
1606
- }).describe("A read-only image component for form pages");
1653
+ }).meta({
1654
+ description: "A read-only image component for form pages",
1655
+ id: "ImageViewField"
1656
+ });
1607
1657
  var Paragraph = BaseField.extend({
1608
1658
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1609
1659
  configuration: ParagraphConfiguration
1610
- }).describe("A read-only HTML <p> paragraph");
1660
+ }).meta({
1661
+ description: "A read-only HTML <p> paragraph",
1662
+ id: "Paragraph"
1663
+ });
1611
1664
  var Heading = BaseField.extend({
1612
1665
  type: import_v43.default.literal(FieldType.HEADING),
1613
1666
  configuration: HeadingConfiguration
1614
- }).describe("A read-only heading component for form pages");
1667
+ }).meta({
1668
+ description: "A read-only heading component for form pages",
1669
+ id: "Heading"
1670
+ });
1615
1671
  var PageHeader = BaseField.extend({
1616
1672
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1617
- }).describe("A read-only header component for form pages");
1673
+ }).meta({
1674
+ description: "A read-only header component for form pages",
1675
+ id: "PageHeader"
1676
+ });
1618
1677
  var File = BaseField.extend({
1619
1678
  type: import_v43.default.literal(FieldType.FILE),
1620
- defaultValue: FileFieldValue.optional(),
1679
+ defaultValue: FileFieldValue.or(ComputedDefaultValue).optional(),
1621
1680
  configuration: import_v43.default.object({
1622
1681
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1623
1682
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature"),
@@ -1633,7 +1692,10 @@ var File = BaseField.extend({
1633
1692
  }).default({
1634
1693
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1635
1694
  })
1636
- }).describe("File upload");
1695
+ }).meta({
1696
+ description: "A file upload field",
1697
+ id: "File"
1698
+ });
1637
1699
  var SelectOption = import_v43.default.object({
1638
1700
  value: import_v43.default.string().describe("The value of the option"),
1639
1701
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1641,7 +1703,7 @@ var SelectOption = import_v43.default.object({
1641
1703
  });
1642
1704
  var NumberWithUnitField = BaseField.extend({
1643
1705
  type: import_v43.default.literal(FieldType.NUMBER_WITH_UNIT),
1644
- defaultValue: NumberWithUnitFieldValue.optional(),
1706
+ defaultValue: NumberWithUnitFieldValue.or(ComputedDefaultValue).optional(),
1645
1707
  options: import_v43.default.array(SelectOption).describe("A list of options for the unit select"),
1646
1708
  configuration: import_v43.default.object({
1647
1709
  min: import_v43.default.number().optional().describe("Minimum value of the number field"),
@@ -1650,17 +1712,23 @@ var NumberWithUnitField = BaseField.extend({
1650
1712
  "Placeholder for the number field"
1651
1713
  )
1652
1714
  }).optional()
1653
- }).describe("Number with unit input");
1715
+ }).meta({
1716
+ description: "A number with unit input field",
1717
+ id: "NumberWithUnitField"
1718
+ });
1654
1719
  var RadioGroup = BaseField.extend({
1655
1720
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1656
- defaultValue: TextValue.optional(),
1721
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1657
1722
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1658
1723
  configuration: import_v43.default.object({
1659
1724
  styles: import_v43.default.object({
1660
1725
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1661
1726
  }).optional()
1662
1727
  }).optional()
1663
- }).describe("Grouped radio options");
1728
+ }).meta({
1729
+ description: "A grouped radio button field",
1730
+ id: "RadioGroup"
1731
+ });
1664
1732
  var BulletList = BaseField.extend({
1665
1733
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1666
1734
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1669,10 +1737,13 @@ var BulletList = BaseField.extend({
1669
1737
  fontVariant: HtmlFontVariant.optional()
1670
1738
  }).optional()
1671
1739
  }).default({})
1672
- }).describe("A list of bullet points");
1740
+ }).meta({
1741
+ description: "A list of bullet points",
1742
+ id: "BulletList"
1743
+ });
1673
1744
  var Select = BaseField.extend({
1674
1745
  type: import_v43.default.literal(FieldType.SELECT),
1675
- defaultValue: TextValue.optional(),
1746
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1676
1747
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1677
1748
  noOptionsMessage: TranslationConfig.optional().describe(
1678
1749
  `
@@ -1684,16 +1755,22 @@ var Select = BaseField.extend({
1684
1755
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1685
1756
  `
1686
1757
  )
1687
- }).describe("Select input");
1758
+ }).meta({
1759
+ description: "A select input field",
1760
+ id: "Select"
1761
+ });
1688
1762
  var SelectDateRangeOption = import_v43.default.object({
1689
1763
  value: SelectDateRangeValue.describe("The value of the option"),
1690
1764
  label: TranslationConfig.describe("The label of the option")
1691
1765
  });
1692
1766
  var SelectDateRangeField = BaseField.extend({
1693
1767
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1694
- defaultValue: SelectDateRangeValue.optional(),
1768
+ defaultValue: SelectDateRangeValue.or(ComputedDefaultValue).optional(),
1695
1769
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1696
- }).describe("Select input with date range options");
1770
+ }).meta({
1771
+ description: "A date range selection field",
1772
+ id: "SelectDateRangeField"
1773
+ });
1697
1774
  var NameConfig = import_v43.default.object({
1698
1775
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1699
1776
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1705,7 +1782,7 @@ var NameField = BaseField.extend({
1705
1782
  firstname: SerializedUserField.or(NonEmptyTextValue).optional(),
1706
1783
  middlename: SerializedUserField.or(NonEmptyTextValue).optional(),
1707
1784
  surname: SerializedUserField.or(NonEmptyTextValue).optional()
1708
- }).optional(),
1785
+ }).or(ComputedDefaultValue).optional(),
1709
1786
  configuration: import_v43.default.object({
1710
1787
  name: NameConfig.default({
1711
1788
  firstname: { required: true },
@@ -1724,26 +1801,41 @@ var NameField = BaseField.extend({
1724
1801
  surname: { required: true }
1725
1802
  }
1726
1803
  }).optional()
1727
- }).describe("Name input field");
1804
+ }).meta({
1805
+ description: "A field for entering a persons name",
1806
+ id: "NameField"
1807
+ });
1728
1808
  var PhoneField = BaseField.extend({
1729
- defaultValue: NonEmptyTextValue.optional(),
1809
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1730
1810
  type: import_v43.default.literal(FieldType.PHONE)
1731
- }).describe("Phone input field");
1811
+ }).meta({
1812
+ description: "A field for entering a phone number",
1813
+ id: "PhoneField"
1814
+ });
1732
1815
  var IdField = BaseField.extend({
1733
- defaultValue: NonEmptyTextValue.optional(),
1816
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1734
1817
  type: import_v43.default.literal(FieldType.ID)
1735
- }).describe("ID input field");
1818
+ }).meta({
1819
+ description: "A field for entering an ID",
1820
+ id: "IdField"
1821
+ });
1736
1822
  var Checkbox = BaseField.extend({
1737
1823
  type: import_v43.default.literal(FieldType.CHECKBOX),
1738
- defaultValue: CheckboxFieldValue.default(false)
1739
- }).describe("Boolean checkbox field");
1824
+ defaultValue: CheckboxFieldValue.or(ComputedDefaultValue).default(false)
1825
+ }).meta({
1826
+ description: "A boolean checkbox field",
1827
+ id: "Checkbox"
1828
+ });
1740
1829
  var Country = BaseField.extend({
1741
1830
  type: import_v43.default.literal(FieldType.COUNTRY),
1742
- defaultValue: NonEmptyTextValue.optional(),
1831
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1743
1832
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1744
1833
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1745
1834
  )
1746
- }).describe("Country select field");
1835
+ }).meta({
1836
+ description: "A field for selecting a country",
1837
+ id: "Country"
1838
+ });
1747
1839
  var AllowedLocations = JurisdictionReference.optional().describe(
1748
1840
  "Limits which location options are selectable depending on user jurisdiction and location."
1749
1841
  );
@@ -1752,28 +1844,33 @@ var AdministrativeAreas = import_v43.default.enum([
1752
1844
  "HEALTH_FACILITY",
1753
1845
  "CRVS_OFFICE"
1754
1846
  ]);
1755
- var AdministrativeAreaConfiguration = import_v43.default.object({
1756
- partOf: FieldReference.optional().describe("Parent location"),
1757
- type: AdministrativeAreas,
1758
- allowedLocations: AllowedLocations
1759
- }).describe("Administrative area options");
1760
1847
  var AdministrativeAreaField = BaseField.extend({
1761
1848
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1762
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1763
- configuration: AdministrativeAreaConfiguration
1764
- }).describe("Administrative area input field e.g. facility, office");
1849
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1850
+ configuration: import_v43.default.object({
1851
+ partOf: FieldReference.optional().describe("Parent location"),
1852
+ type: AdministrativeAreas,
1853
+ allowedLocations: AllowedLocations
1854
+ }).describe("Administrative area options")
1855
+ }).meta({
1856
+ description: "Administrative area input field",
1857
+ id: "AdministrativeAreaField"
1858
+ });
1765
1859
  var LocationInput = BaseField.extend({
1766
1860
  type: import_v43.default.literal(FieldType.LOCATION),
1767
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1861
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1768
1862
  configuration: import_v43.default.object({
1769
1863
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1770
1864
  allowedLocations: AllowedLocations
1771
1865
  }).optional()
1772
- }).describe("Input field for a location");
1866
+ }).meta({
1867
+ description: "A field for selecting a location",
1868
+ id: "LocationInput"
1869
+ });
1773
1870
  var FileUploadWithOptions = BaseField.extend({
1774
1871
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1775
1872
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1776
- defaultValue: FileFieldWithOptionValue.optional(),
1873
+ defaultValue: FileFieldWithOptionValue.or(ComputedDefaultValue).optional(),
1777
1874
  configuration: import_v43.default.object({
1778
1875
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1779
1876
  maxImageSize: import_v43.default.object({
@@ -1783,15 +1880,18 @@ var FileUploadWithOptions = BaseField.extend({
1783
1880
  }).default({
1784
1881
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1785
1882
  })
1883
+ }).meta({
1884
+ description: "A field for uploading files with file type options",
1885
+ id: "FileUploadWithOptions"
1786
1886
  });
1787
1887
  var Facility = BaseField.extend({
1788
1888
  type: import_v43.default.literal(FieldType.FACILITY),
1789
- defaultValue: NonEmptyTextValue.optional(),
1889
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1790
1890
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1791
1891
  }).describe("Input field for a facility");
1792
1892
  var Office = BaseField.extend({
1793
1893
  type: import_v43.default.literal(FieldType.OFFICE),
1794
- defaultValue: NonEmptyTextValue.optional(),
1894
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1795
1895
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1796
1896
  }).describe("Input field for an office");
1797
1897
  var DefaultAddressFieldValue = DomesticAddressFieldValue.extend({
@@ -1827,8 +1927,11 @@ var Address = BaseField.extend({
1827
1927
  ).optional(),
1828
1928
  allowedLocations: AllowedLocations
1829
1929
  }).optional(),
1830
- defaultValue: DefaultAddressFieldValue.optional()
1831
- }).describe("Address input field \u2013 a combination of location and text fields");
1930
+ defaultValue: DefaultAddressFieldValue.or(ComputedDefaultValue).optional()
1931
+ }).meta({
1932
+ description: "Address input field \u2013 a combination of location and text fields",
1933
+ id: "Address"
1934
+ });
1832
1935
  var StaticDataEntry = import_v43.default.object({
1833
1936
  id: import_v43.default.string().describe("ID for the data entry."),
1834
1937
  label: TranslationConfig,
@@ -1843,7 +1946,10 @@ var DataField = BaseField.extend({
1843
1946
  subtitle: TranslationConfig.optional(),
1844
1947
  data: import_v43.default.array(DataEntry)
1845
1948
  })
1846
- }).describe("Data field for displaying read-only data");
1949
+ }).meta({
1950
+ description: "A field for displaying a table of read-only data",
1951
+ id: "DataField"
1952
+ });
1847
1953
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1848
1954
  var ButtonType = import_v43.default.enum([
1849
1955
  "primary",
@@ -1868,13 +1974,19 @@ var ButtonConfiguration = import_v43.default.object({
1868
1974
  });
1869
1975
  var ButtonField = BaseField.extend({
1870
1976
  type: import_v43.default.literal(FieldType.BUTTON),
1871
- defaultValue: ButtonFieldValue.optional(),
1977
+ defaultValue: ButtonFieldValue.or(ComputedDefaultValue).optional(),
1872
1978
  configuration: ButtonConfiguration
1873
- }).describe("Generic button without any built-in functionality");
1979
+ }).meta({
1980
+ description: "A generic button that can be used to trigger an action",
1981
+ id: "ButtonField"
1982
+ });
1874
1983
  var FieldGroup = BaseField.extend({
1875
1984
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1876
1985
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1877
1986
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
1987
+ }).meta({
1988
+ description: "A group of fields that are displayed together",
1989
+ id: "FieldGroup"
1878
1990
  });
1879
1991
  var AlphaPrintButton = BaseField.extend({
1880
1992
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1884,10 +1996,13 @@ var AlphaPrintButton = BaseField.extend({
1884
1996
  "Label for the print button"
1885
1997
  )
1886
1998
  })
1887
- }).describe("Print button field for printing certificates");
1999
+ }).meta({
2000
+ description: "An experimental print button field for printing certificates during the declaration process",
2001
+ id: "AlphaPrintButton"
2002
+ });
1888
2003
  var HttpField = BaseField.extend({
1889
2004
  type: import_v43.default.literal(FieldType.HTTP),
1890
- defaultValue: HttpFieldValue.optional(),
2005
+ defaultValue: HttpFieldValue.or(ComputedDefaultValue).optional(),
1891
2006
  configuration: import_v43.default.object({
1892
2007
  trigger: FieldReference.optional().describe(
1893
2008
  "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."
@@ -1900,20 +2015,30 @@ var HttpField = BaseField.extend({
1900
2015
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1901
2016
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1902
2017
  })
1903
- }).describe("HTTP request function triggered by a button click or other event");
2018
+ }).meta({
2019
+ 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.",
2020
+ id: "HttpField"
2021
+ });
1904
2022
  var AutocompleteField = BaseField.extend({
1905
2023
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1906
2024
  configuration: import_v43.default.object({
1907
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2025
+ url: import_v43.default.string().describe(
2026
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2027
+ ).optional(),
1908
2028
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1909
2029
  defaultOptions: import_v43.default.array(
1910
2030
  import_v43.default.object({
1911
2031
  label: import_v43.default.string(),
1912
2032
  value: import_v43.default.string()
1913
2033
  })
1914
- ).optional()
2034
+ ).optional().describe(
2035
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2036
+ )
1915
2037
  })
1916
- }).describe("Autocomplete input field");
2038
+ }).meta({
2039
+ 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.",
2040
+ id: "AutocompleteField"
2041
+ });
1917
2042
  var SearchField = HttpField.extend({
1918
2043
  type: import_v43.default.literal(FieldType.SEARCH),
1919
2044
  configuration: SearchQuery.pick({
@@ -1946,6 +2071,9 @@ var SearchField = HttpField.extend({
1946
2071
  ok: TranslationConfig.optional()
1947
2072
  }).optional()
1948
2073
  })
2074
+ }).meta({
2075
+ description: "A search input field",
2076
+ id: "SearchField"
1949
2077
  });
1950
2078
  var LinkButtonField = BaseField.extend({
1951
2079
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1954,28 +2082,35 @@ var LinkButtonField = BaseField.extend({
1954
2082
  text: TranslationConfig.describe("Text to display on the button"),
1955
2083
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1956
2084
  })
1957
- }).describe("Button that opens a link");
2085
+ }).meta({
2086
+ description: "A button that opens a URL link",
2087
+ id: "LinkButtonField"
2088
+ });
1958
2089
  var VerificationStatus = BaseField.extend({
1959
2090
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1960
- defaultValue: VerificationStatusValue.optional(),
2091
+ defaultValue: VerificationStatusValue.or(ComputedDefaultValue).optional(),
1961
2092
  configuration: import_v43.default.object({
1962
2093
  status: TranslationConfig.describe("Text to display on the status pill."),
1963
2094
  description: TranslationConfig.describe(
1964
2095
  "Explaining text on the banner in form."
1965
2096
  )
1966
2097
  })
2098
+ }).meta({
2099
+ 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.",
2100
+ id: "VerificationStatus"
1967
2101
  });
1968
2102
  var QueryParamReaderField = BaseField.extend({
1969
2103
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1970
2104
  configuration: import_v43.default.object({
1971
2105
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1972
2106
  })
1973
- }).describe(
1974
- "A field that maps URL query params into form values and clears them afterward"
1975
- );
2107
+ }).meta({
2108
+ description: "A field that maps URL query params into form values and clears them afterward",
2109
+ id: "QueryParamReaderField"
2110
+ });
1976
2111
  var QrReaderField = BaseField.extend({
1977
2112
  type: import_v43.default.literal(FieldType.QR_READER),
1978
- defaultValue: QrReaderFieldValue.optional(),
2113
+ defaultValue: QrReaderFieldValue.or(ComputedDefaultValue).optional(),
1979
2114
  configuration: import_v43.default.object({
1980
2115
  validator: import_v43.default.any().meta({
1981
2116
  description: "JSON Schema to validate the scanned QR code data against before populating the form fields.",
@@ -1983,21 +2118,27 @@ var QrReaderField = BaseField.extend({
1983
2118
  })
1984
2119
  }).optional()
1985
2120
  }).meta({
1986
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2121
+ description: "QR code reader field, including optional JSON Schema validator.",
1987
2122
  id: "QrReaderField"
1988
2123
  });
1989
2124
  var IdReaderField = BaseField.extend({
1990
2125
  type: import_v43.default.literal(FieldType.ID_READER),
1991
- defaultValue: IdReaderFieldValue.optional(),
2126
+ defaultValue: IdReaderFieldValue.or(ComputedDefaultValue).optional(),
1992
2127
  methods: import_v43.default.array(
1993
2128
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1994
2129
  )
2130
+ }).meta({
2131
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2132
+ id: "IdReaderField"
1995
2133
  });
1996
2134
  var CustomField = BaseField.extend({
1997
2135
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1998
2136
  defaultValue: CustomFieldValue.optional(),
1999
2137
  src: import_v43.default.string().describe("Module source path for the custom field component"),
2000
2138
  configuration: import_v43.default.unknown().optional()
2139
+ }).meta({
2140
+ description: "An expiremental custom field that is defined by a module source path",
2141
+ id: "CustomField"
2001
2142
  });
2002
2143
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2003
2144
  var LoaderField = BaseField.extend({
@@ -2007,22 +2148,25 @@ var LoaderField = BaseField.extend({
2007
2148
  configuration: import_v43.default.object({
2008
2149
  text: TranslationConfig.describe("Display text above the loading spinner")
2009
2150
  })
2010
- }).describe(
2011
- "A non-interactive field that indicates an in progress operation in form"
2012
- );
2151
+ }).meta({
2152
+ description: "A non-interactive field that indicates an in progress operation in form",
2153
+ id: "LoaderField"
2154
+ });
2013
2155
  var HiddenField = BaseField.extend({
2014
2156
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2015
2157
  required: import_v43.default.boolean().default(false).optional(),
2016
2158
  defaultValue: TextValue.optional()
2017
- }).describe(
2018
- "A non-interactive, hidden field that only hold a value in the form"
2019
- );
2159
+ }).meta({
2160
+ description: "A non-interactive, hidden field that only hold a value in the form",
2161
+ id: "HiddenField"
2162
+ });
2020
2163
  var UserRoleField = BaseField.extend({
2021
2164
  type: import_v43.default.literal(FieldType.USER_ROLE),
2022
2165
  defaultValue: TextValue.optional()
2023
- }).describe(
2024
- "A select dropdown that is automatically populated with available user roles"
2025
- );
2166
+ }).meta({
2167
+ description: "A select dropdown that is automatically populated with available user roles",
2168
+ id: "UserRoleField"
2169
+ });
2026
2170
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2027
2171
  FieldGroup,
2028
2172
  Address,
@@ -2140,6 +2284,7 @@ var ClientConfig = z20.object({
2140
2284
  COUNTRY: z20.string(),
2141
2285
  LANGUAGES: z20.array(z20.string()),
2142
2286
  SENTRY: z20.string().optional(),
2287
+ LOGIN_URL: z20.string().optional(),
2143
2288
  REGISTER_BACKGROUND: BackgroundConfig,
2144
2289
  DASHBOARDS: z20.array(
2145
2290
  z20.object({