@opencrvs/toolkit 2.0.0-rc.adf3f22 → 2.0.0-rc.af7ea0b

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