@opencrvs/toolkit 2.0.0-rc.d1ea58b → 2.0.0-rc.d23bb0b

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