@opencrvs/toolkit 2.0.0-rc.18f6ed6 → 2.0.0-rc.198e4b0

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.
@@ -1080,8 +1080,8 @@ var ActionConditional = z7.discriminatedUnion("type", [
1080
1080
  // Action can be shown to the user in the list but as disabled
1081
1081
  EnableConditional
1082
1082
  ]).meta({
1083
- description: "Action conditional configuration",
1084
- id: "ActionConditional"
1083
+ id: "ActionConditional",
1084
+ 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."
1085
1085
  });
1086
1086
  var DisplayOnReviewConditional = z7.object({
1087
1087
  type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
@@ -1097,8 +1097,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
1097
1097
  // Field output can be shown / hidden on the review page
1098
1098
  DisplayOnReviewConditional
1099
1099
  ]).meta({
1100
- description: "Field conditional configuration",
1101
- id: "FieldConditional"
1100
+ id: "FieldConditional",
1101
+ 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."
1102
1102
  });
1103
1103
 
1104
1104
  // ../commons/src/events/FieldType.ts
@@ -1648,9 +1648,8 @@ var RequestedCorrectionAction = ActionBase.extend(
1648
1648
  var ApprovedCorrectionAction = ActionBase.extend(
1649
1649
  z14.object({
1650
1650
  type: z14.literal(ActionType.APPROVE_CORRECTION),
1651
- requestId: z14.string(),
1651
+ requestId: z14.string()
1652
1652
  // TODO move into 'content' property
1653
- content: z14.object({ immediateCorrection: z14.boolean().optional() }).optional()
1654
1653
  }).shape
1655
1654
  );
1656
1655
  var RejectedCorrectionAction = ActionBase.extend(
@@ -1743,8 +1742,8 @@ var FlagConfig = z15.object({
1743
1742
  ),
1744
1743
  label: TranslationConfig.describe("Human readable label of the flag.")
1745
1744
  }).meta({
1746
- description: "Flag configuration",
1747
- id: "FlagConfig"
1745
+ id: "FlagConfig",
1746
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1748
1747
  });
1749
1748
  var ActionFlagConfig = z15.object({
1750
1749
  id: Flag,
@@ -1753,8 +1752,8 @@ var ActionFlagConfig = z15.object({
1753
1752
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1754
1753
  )
1755
1754
  }).meta({
1756
- description: "Action flag configuration",
1757
- id: "ActionFlagConfig"
1755
+ id: "ActionFlagConfig",
1756
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1758
1757
  });
1759
1758
 
1760
1759
  // ../commons/src/events/EventMetadata.ts
@@ -2184,8 +2183,15 @@ var FieldReference = import_v43.default.object({
2184
2183
  )
2185
2184
  }).describe("Reference to a field by its ID");
2186
2185
  var ValidationConfig = import_v43.default.object({
2187
- validator: Conditional,
2188
- message: TranslationConfig
2186
+ validator: Conditional.describe(
2187
+ "Conditional expression that must hold for the field value to be considered valid."
2188
+ ),
2189
+ message: TranslationConfig.describe(
2190
+ "Error message displayed when the validator does not hold."
2191
+ )
2192
+ }).meta({
2193
+ id: "ValidationConfig",
2194
+ 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."
2189
2195
  });
2190
2196
  var requiredSchema = import_v43.default.union([
2191
2197
  import_v43.default.boolean(),
@@ -2224,6 +2230,9 @@ var BaseField = import_v43.default.object({
2224
2230
  }).describe("Common properties shared across all field types.");
2225
2231
  var Divider = BaseField.extend({
2226
2232
  type: import_v43.default.literal(FieldType.DIVIDER)
2233
+ }).meta({
2234
+ description: "A horizontal line divider",
2235
+ id: "Divider"
2227
2236
  });
2228
2237
  var TextField = BaseField.extend({
2229
2238
  type: import_v43.default.literal(FieldType.TEXT),
@@ -2234,7 +2243,10 @@ var TextField = BaseField.extend({
2234
2243
  prefix: TranslationConfig.optional(),
2235
2244
  postfix: TranslationConfig.optional()
2236
2245
  }).default({ type: "text" }).optional()
2237
- }).describe("Text input");
2246
+ }).meta({
2247
+ description: "A text input field",
2248
+ id: "TextField"
2249
+ });
2238
2250
  var NumberField = BaseField.extend({
2239
2251
  type: import_v43.default.literal(FieldType.NUMBER),
2240
2252
  defaultValue: NumberFieldValue.optional(),
@@ -2244,7 +2256,10 @@ var NumberField = BaseField.extend({
2244
2256
  prefix: TranslationConfig.optional(),
2245
2257
  postfix: TranslationConfig.optional()
2246
2258
  }).optional()
2247
- }).describe("Number input");
2259
+ }).meta({
2260
+ description: "A number input field",
2261
+ id: "NumberField"
2262
+ });
2248
2263
  var TextAreaField = BaseField.extend({
2249
2264
  type: import_v43.default.literal(FieldType.TEXTAREA),
2250
2265
  defaultValue: NonEmptyTextValue.optional(),
@@ -2255,7 +2270,10 @@ var TextAreaField = BaseField.extend({
2255
2270
  prefix: TranslationConfig.optional(),
2256
2271
  postfix: TranslationConfig.optional()
2257
2272
  }).default({ rows: 4 }).optional()
2258
- }).describe("Multiline text input");
2273
+ }).meta({
2274
+ description: "A multiline text input",
2275
+ id: "TextAreaField"
2276
+ });
2259
2277
  var ImageMimeType = import_v43.default.enum([
2260
2278
  "image/png",
2261
2279
  "image/jpg",
@@ -2285,13 +2303,19 @@ var SignatureField = BaseField.extend({
2285
2303
  }).default({
2286
2304
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2287
2305
  })
2288
- }).describe("Signature input field");
2306
+ }).meta({
2307
+ description: "A signature input field",
2308
+ id: "SignatureField"
2309
+ });
2289
2310
  var EmailField = BaseField.extend({
2290
2311
  type: import_v43.default.literal(FieldType.EMAIL),
2291
2312
  configuration: import_v43.default.object({
2292
2313
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
2293
2314
  }).default({ maxLength: 255 }).optional(),
2294
2315
  defaultValue: NonEmptyTextValue.optional()
2316
+ }).meta({
2317
+ description: "An email input field",
2318
+ id: "EmailField"
2295
2319
  });
2296
2320
  var DateField = BaseField.extend({
2297
2321
  type: import_v43.default.literal(FieldType.DATE),
@@ -2301,7 +2325,10 @@ var DateField = BaseField.extend({
2301
2325
  "Text to display above the date input"
2302
2326
  ).optional()
2303
2327
  }).optional()
2304
- }).describe("A single date input (yyyy-MM-dd)");
2328
+ }).meta({
2329
+ description: "A date input (yyyy-MM-dd)",
2330
+ id: "DateField"
2331
+ });
2305
2332
  var AgeField = BaseField.extend({
2306
2333
  type: import_v43.default.literal(FieldType.AGE),
2307
2334
  defaultValue: NumberFieldValue.optional(),
@@ -2310,7 +2337,10 @@ var AgeField = BaseField.extend({
2310
2337
  prefix: TranslationConfig.optional(),
2311
2338
  postfix: TranslationConfig.optional()
2312
2339
  })
2313
- }).describe("An age input field which uses the current date as the asOfDate");
2340
+ }).meta({
2341
+ description: "An age input field which uses the current date as the asOfDate",
2342
+ id: "AgeField"
2343
+ });
2314
2344
  var TimeField = BaseField.extend({
2315
2345
  type: import_v43.default.literal(FieldType.TIME),
2316
2346
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -2320,7 +2350,10 @@ var TimeField = BaseField.extend({
2320
2350
  "Text to display above the time input"
2321
2351
  ).optional()
2322
2352
  }).optional()
2323
- }).describe("A single date input (HH-mm)");
2353
+ }).meta({
2354
+ description: "A single time input (HH-mm)",
2355
+ id: "TimeField"
2356
+ });
2324
2357
  var DateRangeField = BaseField.extend({
2325
2358
  type: import_v43.default.literal(FieldType.DATE_RANGE),
2326
2359
  defaultValue: DateRangeFieldValue.optional(),
@@ -2329,7 +2362,10 @@ var DateRangeField = BaseField.extend({
2329
2362
  "Text to display above the date input"
2330
2363
  ).optional()
2331
2364
  }).optional()
2332
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
2365
+ }).meta({
2366
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
2367
+ id: "DateRangeField"
2368
+ });
2333
2369
  var HtmlFontVariant = import_v43.default.enum([
2334
2370
  "reg12",
2335
2371
  "reg14",
@@ -2373,18 +2409,30 @@ var ImageViewField = BaseField.extend({
2373
2409
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
2374
2410
  defaultValue: NonEmptyTextValue.optional(),
2375
2411
  configuration: ImageConfiguration
2376
- }).describe("A read-only image component for form pages");
2412
+ }).meta({
2413
+ description: "A read-only image component for form pages",
2414
+ id: "ImageViewField"
2415
+ });
2377
2416
  var Paragraph = BaseField.extend({
2378
2417
  type: import_v43.default.literal(FieldType.PARAGRAPH),
2379
2418
  configuration: ParagraphConfiguration
2380
- }).describe("A read-only HTML <p> paragraph");
2419
+ }).meta({
2420
+ description: "A read-only HTML <p> paragraph",
2421
+ id: "Paragraph"
2422
+ });
2381
2423
  var Heading = BaseField.extend({
2382
2424
  type: import_v43.default.literal(FieldType.HEADING),
2383
2425
  configuration: HeadingConfiguration
2384
- }).describe("A read-only heading component for form pages");
2426
+ }).meta({
2427
+ description: "A read-only heading component for form pages",
2428
+ id: "Heading"
2429
+ });
2385
2430
  var PageHeader = BaseField.extend({
2386
2431
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
2387
- }).describe("A read-only header component for form pages");
2432
+ }).meta({
2433
+ description: "A read-only header component for form pages",
2434
+ id: "PageHeader"
2435
+ });
2388
2436
  var File = BaseField.extend({
2389
2437
  type: import_v43.default.literal(FieldType.FILE),
2390
2438
  defaultValue: FileFieldValue.optional(),
@@ -2403,7 +2451,10 @@ var File = BaseField.extend({
2403
2451
  }).default({
2404
2452
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2405
2453
  })
2406
- }).describe("File upload");
2454
+ }).meta({
2455
+ description: "A file upload field",
2456
+ id: "File"
2457
+ });
2407
2458
  var SelectOption = import_v43.default.object({
2408
2459
  value: import_v43.default.string().describe("The value of the option"),
2409
2460
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -2420,7 +2471,10 @@ var NumberWithUnitField = BaseField.extend({
2420
2471
  "Placeholder for the number field"
2421
2472
  )
2422
2473
  }).optional()
2423
- }).describe("Number with unit input");
2474
+ }).meta({
2475
+ description: "A number with unit input field",
2476
+ id: "NumberWithUnitField"
2477
+ });
2424
2478
  var RadioGroup = BaseField.extend({
2425
2479
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
2426
2480
  defaultValue: TextValue.optional(),
@@ -2430,7 +2484,10 @@ var RadioGroup = BaseField.extend({
2430
2484
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
2431
2485
  }).optional()
2432
2486
  }).optional()
2433
- }).describe("Grouped radio options");
2487
+ }).meta({
2488
+ description: "A grouped radio button field",
2489
+ id: "RadioGroup"
2490
+ });
2434
2491
  var BulletList = BaseField.extend({
2435
2492
  type: import_v43.default.literal(FieldType.BULLET_LIST),
2436
2493
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -2439,7 +2496,10 @@ var BulletList = BaseField.extend({
2439
2496
  fontVariant: HtmlFontVariant.optional()
2440
2497
  }).optional()
2441
2498
  }).default({})
2442
- }).describe("A list of bullet points");
2499
+ }).meta({
2500
+ description: "A list of bullet points",
2501
+ id: "BulletList"
2502
+ });
2443
2503
  var Select = BaseField.extend({
2444
2504
  type: import_v43.default.literal(FieldType.SELECT),
2445
2505
  defaultValue: TextValue.optional(),
@@ -2454,7 +2514,10 @@ var Select = BaseField.extend({
2454
2514
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
2455
2515
  `
2456
2516
  )
2457
- }).describe("Select input");
2517
+ }).meta({
2518
+ description: "A select input field",
2519
+ id: "Select"
2520
+ });
2458
2521
  var SelectDateRangeOption = import_v43.default.object({
2459
2522
  value: SelectDateRangeValue.describe("The value of the option"),
2460
2523
  label: TranslationConfig.describe("The label of the option")
@@ -2463,7 +2526,10 @@ var SelectDateRangeField = BaseField.extend({
2463
2526
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
2464
2527
  defaultValue: SelectDateRangeValue.optional(),
2465
2528
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
2466
- }).describe("Select input with date range options");
2529
+ }).meta({
2530
+ description: "A date range selection field",
2531
+ id: "SelectDateRangeField"
2532
+ });
2467
2533
  var NameConfig = import_v43.default.object({
2468
2534
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
2469
2535
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -2494,26 +2560,41 @@ var NameField = BaseField.extend({
2494
2560
  surname: { required: true }
2495
2561
  }
2496
2562
  }).optional()
2497
- }).describe("Name input field");
2563
+ }).meta({
2564
+ description: "A field for entering a persons name",
2565
+ id: "NameField"
2566
+ });
2498
2567
  var PhoneField = BaseField.extend({
2499
2568
  defaultValue: NonEmptyTextValue.optional(),
2500
2569
  type: import_v43.default.literal(FieldType.PHONE)
2501
- }).describe("Phone input field");
2570
+ }).meta({
2571
+ description: "A field for entering a phone number",
2572
+ id: "PhoneField"
2573
+ });
2502
2574
  var IdField = BaseField.extend({
2503
2575
  defaultValue: NonEmptyTextValue.optional(),
2504
2576
  type: import_v43.default.literal(FieldType.ID)
2505
- }).describe("ID input field");
2577
+ }).meta({
2578
+ description: "A field for entering an ID",
2579
+ id: "IdField"
2580
+ });
2506
2581
  var Checkbox = BaseField.extend({
2507
2582
  type: import_v43.default.literal(FieldType.CHECKBOX),
2508
2583
  defaultValue: CheckboxFieldValue.default(false)
2509
- }).describe("Boolean checkbox field");
2584
+ }).meta({
2585
+ description: "A boolean checkbox field",
2586
+ id: "Checkbox"
2587
+ });
2510
2588
  var Country = BaseField.extend({
2511
2589
  type: import_v43.default.literal(FieldType.COUNTRY),
2512
2590
  defaultValue: NonEmptyTextValue.optional(),
2513
2591
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
2514
2592
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
2515
2593
  )
2516
- }).describe("Country select field");
2594
+ }).meta({
2595
+ description: "A field for selecting a country",
2596
+ id: "Country"
2597
+ });
2517
2598
  var AllowedLocations = JurisdictionReference.optional().describe(
2518
2599
  "Limits which location options are selectable depending on user jurisdiction and location."
2519
2600
  );
@@ -2522,16 +2603,18 @@ var AdministrativeAreas = import_v43.default.enum([
2522
2603
  "HEALTH_FACILITY",
2523
2604
  "CRVS_OFFICE"
2524
2605
  ]);
2525
- var AdministrativeAreaConfiguration = import_v43.default.object({
2526
- partOf: FieldReference.optional().describe("Parent location"),
2527
- type: AdministrativeAreas,
2528
- allowedLocations: AllowedLocations
2529
- }).describe("Administrative area options");
2530
2606
  var AdministrativeAreaField = BaseField.extend({
2531
2607
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
2532
2608
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
2533
- configuration: AdministrativeAreaConfiguration
2534
- }).describe("Administrative area input field e.g. facility, office");
2609
+ configuration: import_v43.default.object({
2610
+ partOf: FieldReference.optional().describe("Parent location"),
2611
+ type: AdministrativeAreas,
2612
+ allowedLocations: AllowedLocations
2613
+ }).describe("Administrative area options")
2614
+ }).meta({
2615
+ description: "Administrative area input field",
2616
+ id: "AdministrativeAreaField"
2617
+ });
2535
2618
  var LocationInput = BaseField.extend({
2536
2619
  type: import_v43.default.literal(FieldType.LOCATION),
2537
2620
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -2539,7 +2622,10 @@ var LocationInput = BaseField.extend({
2539
2622
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
2540
2623
  allowedLocations: AllowedLocations
2541
2624
  }).optional()
2542
- }).describe("Input field for a location");
2625
+ }).meta({
2626
+ description: "A field for selecting a location",
2627
+ id: "LocationInput"
2628
+ });
2543
2629
  var FileUploadWithOptions = BaseField.extend({
2544
2630
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
2545
2631
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -2553,6 +2639,9 @@ var FileUploadWithOptions = BaseField.extend({
2553
2639
  }).default({
2554
2640
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2555
2641
  })
2642
+ }).meta({
2643
+ description: "A field for uploading files with file type options",
2644
+ id: "FileUploadWithOptions"
2556
2645
  });
2557
2646
  var Facility = BaseField.extend({
2558
2647
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -2598,7 +2687,10 @@ var Address = BaseField.extend({
2598
2687
  allowedLocations: AllowedLocations
2599
2688
  }).optional(),
2600
2689
  defaultValue: DefaultAddressFieldValue.optional()
2601
- }).describe("Address input field \u2013 a combination of location and text fields");
2690
+ }).meta({
2691
+ description: "Address input field \u2013 a combination of location and text fields",
2692
+ id: "Address"
2693
+ });
2602
2694
  var StaticDataEntry = import_v43.default.object({
2603
2695
  id: import_v43.default.string().describe("ID for the data entry."),
2604
2696
  label: TranslationConfig,
@@ -2613,7 +2705,10 @@ var DataField = BaseField.extend({
2613
2705
  subtitle: TranslationConfig.optional(),
2614
2706
  data: import_v43.default.array(DataEntry)
2615
2707
  })
2616
- }).describe("Data field for displaying read-only data");
2708
+ }).meta({
2709
+ description: "A field for displaying a table of read-only data",
2710
+ id: "DataField"
2711
+ });
2617
2712
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
2618
2713
  var ButtonType = import_v43.default.enum([
2619
2714
  "primary",
@@ -2640,11 +2735,17 @@ var ButtonField = BaseField.extend({
2640
2735
  type: import_v43.default.literal(FieldType.BUTTON),
2641
2736
  defaultValue: ButtonFieldValue.optional(),
2642
2737
  configuration: ButtonConfiguration
2643
- }).describe("Generic button without any built-in functionality");
2738
+ }).meta({
2739
+ description: "A generic button that can be used to trigger an action",
2740
+ id: "ButtonField"
2741
+ });
2644
2742
  var FieldGroup = BaseField.extend({
2645
2743
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
2646
2744
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
2647
2745
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
2746
+ }).meta({
2747
+ description: "A group of fields that are displayed together",
2748
+ id: "FieldGroup"
2648
2749
  });
2649
2750
  var AlphaPrintButton = BaseField.extend({
2650
2751
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -2654,7 +2755,10 @@ var AlphaPrintButton = BaseField.extend({
2654
2755
  "Label for the print button"
2655
2756
  )
2656
2757
  })
2657
- }).describe("Print button field for printing certificates");
2758
+ }).meta({
2759
+ description: "An experimental print button field for printing certificates during the declaration process",
2760
+ id: "AlphaPrintButton"
2761
+ });
2658
2762
  var HttpField = BaseField.extend({
2659
2763
  type: import_v43.default.literal(FieldType.HTTP),
2660
2764
  defaultValue: HttpFieldValue.optional(),
@@ -2670,20 +2774,30 @@ var HttpField = BaseField.extend({
2670
2774
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
2671
2775
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
2672
2776
  })
2673
- }).describe("HTTP request function triggered by a button click or other event");
2777
+ }).meta({
2778
+ 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.",
2779
+ id: "HttpField"
2780
+ });
2674
2781
  var AutocompleteField = BaseField.extend({
2675
2782
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
2676
2783
  configuration: import_v43.default.object({
2677
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2784
+ url: import_v43.default.string().describe(
2785
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2786
+ ).optional(),
2678
2787
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
2679
2788
  defaultOptions: import_v43.default.array(
2680
2789
  import_v43.default.object({
2681
2790
  label: import_v43.default.string(),
2682
2791
  value: import_v43.default.string()
2683
2792
  })
2684
- ).optional()
2793
+ ).optional().describe(
2794
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2795
+ )
2685
2796
  })
2686
- }).describe("Autocomplete input field");
2797
+ }).meta({
2798
+ 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.",
2799
+ id: "AutocompleteField"
2800
+ });
2687
2801
  var SearchField = HttpField.extend({
2688
2802
  type: import_v43.default.literal(FieldType.SEARCH),
2689
2803
  configuration: SearchQuery.pick({
@@ -2716,6 +2830,9 @@ var SearchField = HttpField.extend({
2716
2830
  ok: TranslationConfig.optional()
2717
2831
  }).optional()
2718
2832
  })
2833
+ }).meta({
2834
+ description: "A search input field",
2835
+ id: "SearchField"
2719
2836
  });
2720
2837
  var LinkButtonField = BaseField.extend({
2721
2838
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -2724,7 +2841,10 @@ var LinkButtonField = BaseField.extend({
2724
2841
  text: TranslationConfig.describe("Text to display on the button"),
2725
2842
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
2726
2843
  })
2727
- }).describe("Button that opens a link");
2844
+ }).meta({
2845
+ description: "A button that opens a URL link",
2846
+ id: "LinkButtonField"
2847
+ });
2728
2848
  var VerificationStatus = BaseField.extend({
2729
2849
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
2730
2850
  defaultValue: VerificationStatusValue.optional(),
@@ -2734,15 +2854,19 @@ var VerificationStatus = BaseField.extend({
2734
2854
  "Explaining text on the banner in form."
2735
2855
  )
2736
2856
  })
2857
+ }).meta({
2858
+ 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.",
2859
+ id: "VerificationStatus"
2737
2860
  });
2738
2861
  var QueryParamReaderField = BaseField.extend({
2739
2862
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
2740
2863
  configuration: import_v43.default.object({
2741
2864
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
2742
2865
  })
2743
- }).describe(
2744
- "A field that maps URL query params into form values and clears them afterward"
2745
- );
2866
+ }).meta({
2867
+ description: "A field that maps URL query params into form values and clears them afterward",
2868
+ id: "QueryParamReaderField"
2869
+ });
2746
2870
  var QrReaderField = BaseField.extend({
2747
2871
  type: import_v43.default.literal(FieldType.QR_READER),
2748
2872
  defaultValue: QrReaderFieldValue.optional(),
@@ -2753,7 +2877,7 @@ var QrReaderField = BaseField.extend({
2753
2877
  })
2754
2878
  }).optional()
2755
2879
  }).meta({
2756
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2880
+ description: "QR code reader field, including optional JSON Schema validator.",
2757
2881
  id: "QrReaderField"
2758
2882
  });
2759
2883
  var IdReaderField = BaseField.extend({
@@ -2762,12 +2886,18 @@ var IdReaderField = BaseField.extend({
2762
2886
  methods: import_v43.default.array(
2763
2887
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
2764
2888
  )
2889
+ }).meta({
2890
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2891
+ id: "IdReaderField"
2765
2892
  });
2766
2893
  var CustomField = BaseField.extend({
2767
2894
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
2768
2895
  defaultValue: CustomFieldValue.optional(),
2769
2896
  src: import_v43.default.string().describe("Module source path for the custom field component"),
2770
2897
  configuration: import_v43.default.unknown().optional()
2898
+ }).meta({
2899
+ description: "An expiremental custom field that is defined by a module source path",
2900
+ id: "CustomField"
2771
2901
  });
2772
2902
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2773
2903
  var LoaderField = BaseField.extend({
@@ -2777,22 +2907,25 @@ var LoaderField = BaseField.extend({
2777
2907
  configuration: import_v43.default.object({
2778
2908
  text: TranslationConfig.describe("Display text above the loading spinner")
2779
2909
  })
2780
- }).describe(
2781
- "A non-interactive field that indicates an in progress operation in form"
2782
- );
2910
+ }).meta({
2911
+ description: "A non-interactive field that indicates an in progress operation in form",
2912
+ id: "LoaderField"
2913
+ });
2783
2914
  var HiddenField = BaseField.extend({
2784
2915
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2785
2916
  required: import_v43.default.boolean().default(false).optional(),
2786
2917
  defaultValue: TextValue.optional()
2787
- }).describe(
2788
- "A non-interactive, hidden field that only hold a value in the form"
2789
- );
2918
+ }).meta({
2919
+ description: "A non-interactive, hidden field that only hold a value in the form",
2920
+ id: "HiddenField"
2921
+ });
2790
2922
  var UserRoleField = BaseField.extend({
2791
2923
  type: import_v43.default.literal(FieldType.USER_ROLE),
2792
2924
  defaultValue: TextValue.optional()
2793
- }).describe(
2794
- "A select dropdown that is automatically populated with available user roles"
2795
- );
2925
+ }).meta({
2926
+ description: "A select dropdown that is automatically populated with available user roles",
2927
+ id: "UserRoleField"
2928
+ });
2796
2929
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2797
2930
  FieldGroup,
2798
2931
  Address,
@@ -2892,15 +3025,18 @@ var VerificationPageConfig = FormPageConfig.extend({
2892
3025
  actions: VerificationActionConfig
2893
3026
  });
2894
3027
  var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
2895
- description: "Page configuration",
2896
- id: "PageConfig"
3028
+ id: "PageConfig",
3029
+ description: "Configuration for a single page in a form. Either a form page with fields and a continue button, or a verification page with verify/cancel options."
2897
3030
  });
2898
3031
 
2899
3032
  // ../commons/src/events/FormConfig.ts
2900
3033
  var DeclarationFormConfig = z22.object({
2901
3034
  label: TranslationConfig.describe("Human readable description of the form"),
2902
3035
  pages: z22.array(FormPageConfig)
2903
- }).describe("Configuration of the declaration form.");
3036
+ }).meta({
3037
+ id: "DeclarationFormConfig",
3038
+ description: "Configuration of the declaration form."
3039
+ });
2904
3040
  var ActionFormConfig = z22.object({
2905
3041
  label: TranslationConfig.describe("Human readable description of the form"),
2906
3042
  pages: z22.array(PageConfig)
@@ -3000,6 +3136,9 @@ var DeduplicationConfig = z23.object({
3000
3136
  id: z23.string(),
3001
3137
  label: TranslationConfig,
3002
3138
  query: Clause
3139
+ }).meta({
3140
+ id: "DeduplicationConfig",
3141
+ description: "Configuration for duplicate detection on a declare or register action. The query is built from fuzzy / strict / date-range matchers combined with and/or/not."
3003
3142
  });
3004
3143
 
3005
3144
  // ../commons/src/events/ActionConfig.ts
@@ -3117,17 +3256,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
3117
3256
  * OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
3118
3257
  * and treat them as "models" instead of duplicating the data structure in each endpoint.
3119
3258
  */
3120
- ReadActionConfig.meta({ id: "ReadActionConfig" }),
3121
- DeclareConfig.meta({ id: "DeclareActionConfig" }),
3122
- RejectConfig.meta({ id: "RejectActionConfig" }),
3123
- RegisterConfig.meta({ id: "RegisterActionConfig" }),
3259
+ ReadActionConfig.meta({
3260
+ id: "ReadActionConfig",
3261
+ description: "Configuration for the read action \u2014 defines the record-tab content displayed on the event overview page."
3262
+ }),
3263
+ DeclareConfig.meta({
3264
+ id: "DeclareActionConfig",
3265
+ description: "Configuration for the declare action. Includes review-page fields. Shared with the notify action (ActionType.NOTIFY)."
3266
+ }),
3267
+ RejectConfig.meta({
3268
+ id: "RejectActionConfig",
3269
+ description: "Configuration for rejecting a record before registration."
3270
+ }),
3271
+ RegisterConfig.meta({
3272
+ id: "RegisterActionConfig",
3273
+ description: "Configuration for registering a record."
3274
+ }),
3124
3275
  PrintCertificateActionConfig.meta({
3125
- id: "PrintCertificateActionConfig"
3276
+ id: "PrintCertificateActionConfig",
3277
+ description: "Configuration for printing a certificate of a registered record."
3278
+ }),
3279
+ RequestCorrectionConfig.meta({
3280
+ id: "RequestCorrectionActionConfig",
3281
+ description: "Configuration for requesting a correction on a registered record."
3282
+ }),
3283
+ EditActionConfig.meta({
3284
+ id: "EditActionConfig",
3285
+ description: "Configuration for editing a record before registration."
3286
+ }),
3287
+ ArchiveConfig.meta({
3288
+ id: "ArchiveActionConfig",
3289
+ description: "Configuration for archiving a record."
3126
3290
  }),
3127
- RequestCorrectionConfig.meta({ id: "RequestCorrectionActionConfig" }),
3128
- EditActionConfig.meta({ id: "EditActionConfig" }),
3129
- ArchiveConfig.meta({ id: "ArchiveActionConfig" }),
3130
- CustomActionConfig.meta({ id: "CustomActionConfig" })
3291
+ CustomActionConfig.meta({
3292
+ id: "CustomActionConfig",
3293
+ description: "Configuration for a country-defined custom action. An event may include any number of these."
3294
+ })
3131
3295
  ]).describe(
3132
3296
  "Configuration of an action available for an event. Data collected depends on the action type and is accessible through the annotation property in ActionDocument."
3133
3297
  ).meta({ id: "ActionConfig" });
@@ -3203,7 +3367,10 @@ var Field = BaseField2.extend({
3203
3367
  }).describe("Custom field defined for the summary view.");
3204
3368
  var SummaryConfig = z27.object({
3205
3369
  fields: z27.array(z27.union([Field, ReferenceField])).describe("Fields displayed in the event summary view.")
3206
- }).describe("Configuration of the event summary section.");
3370
+ }).meta({
3371
+ id: "SummaryConfig",
3372
+ description: "Configuration of the event overview page. Defines which declaration fields appear in the record summary, optionally with custom labels, empty-value messages, and templated values."
3373
+ });
3207
3374
 
3208
3375
  // ../commons/src/events/AdvancedSearchConfig.ts
3209
3376
  var z28 = __toESM(require("zod/v4"));
@@ -3327,6 +3494,9 @@ var AdvancedSearchField = z28.discriminatedUnion("fieldType", [FieldConfigSchema
3327
3494
  var AdvancedSearchConfig = z28.object({
3328
3495
  title: TranslationConfig.describe("Advanced search tab title"),
3329
3496
  fields: z28.array(AdvancedSearchField).describe("Advanced search fields within the tab.")
3497
+ }).meta({
3498
+ id: "AdvancedSearchConfig",
3499
+ description: "Configuration of one advanced search tab. Each tab has a title and a list of searchable fields \u2014 either declaration fields (via `field()`) or event metadata (via `event()`)."
3330
3500
  });
3331
3501
 
3332
3502
  // ../commons/src/events/utils.ts
@@ -5400,8 +5570,9 @@ var EventConfig = _EventConfigBase.superRefine((event2, ctx) => {
5400
5570
  validateActionFlags(event2, ctx);
5401
5571
  validateActionOrder(event2, ctx);
5402
5572
  }).meta({
5403
- id: "EventConfig"
5404
- }).describe("Configuration defining an event type.");
5573
+ id: "EventConfig",
5574
+ description: "Configuration defining an event type registered in OpenCRVS (for example birth or death)."
5575
+ });
5405
5576
 
5406
5577
  // ../commons/src/events/EventConfigInput.ts
5407
5578
  var defineDeclarationForm = (form) => DeclarationFormConfig.parse(form);
@@ -5624,6 +5795,9 @@ var WorkqueueColumnValue = z34.object({
5624
5795
  var WorkqueueColumn = z34.object({
5625
5796
  label: TranslationConfig,
5626
5797
  value: WorkqueueColumnValue
5798
+ }).meta({
5799
+ id: "WorkqueueColumn",
5800
+ description: "Configuration for a single workqueue column. The value references an event metadata key (e.g. `dateOfEvent`, `status`, `trackingId`)."
5627
5801
  });
5628
5802
  function defineWorkqueuesColumns(workqueueColumns) {
5629
5803
  return workqueueColumns.map(
@@ -5829,8 +6003,8 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
5829
6003
  var WorkqueueConfigInput = WorkqueueConfig.extend({
5830
6004
  query: CountryConfigQueryInputType
5831
6005
  }).meta({
5832
- description: "Workqueue configuration",
5833
- id: "WorkqueueConfig"
6006
+ id: "WorkqueueConfig",
6007
+ description: "Configuration for a single workqueue. Defines the filter applied to the event index, the quick-action button, the columns shown on each row, and the message rendered when the queue is empty."
5834
6008
  });
5835
6009
  function defineWorkqueue(workqueueInput) {
5836
6010
  const queryInput = workqueueInput.query;
@@ -5893,7 +6067,9 @@ var BaseActionInput = z38.object({
5893
6067
  keepAssignment: z38.boolean().optional(),
5894
6068
  keepAssignmentIfAccepted: z38.boolean().optional(),
5895
6069
  keepAssignmentIfRejected: z38.boolean().optional(),
5896
- waitFor: z38.boolean().optional(),
6070
+ waitFor: z38.boolean().default(true).describe(
6071
+ "Whether action waits for the indexing before returning. Defaults to true. Setting this to to false completes faster but might lead to stale data in the client if the client tries to read the event immediately after performing the action. Use with care."
6072
+ ),
5897
6073
  // For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
5898
6074
  // @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
5899
6075
  createdAtLocation: UUID.nullish().describe(
@@ -6011,8 +6187,7 @@ var RejectCorrectionActionInput = BaseActionInput.extend(
6011
6187
  var ApproveCorrectionActionInput = BaseActionInput.extend(
6012
6188
  z38.object({
6013
6189
  requestId: z38.string(),
6014
- type: z38.literal(ActionType.APPROVE_CORRECTION).default(ActionType.APPROVE_CORRECTION),
6015
- content: z38.object({ immediateCorrection: z38.boolean().optional() }).optional()
6190
+ type: z38.literal(ActionType.APPROVE_CORRECTION).default(ActionType.APPROVE_CORRECTION)
6016
6191
  }).shape
6017
6192
  );
6018
6193
  var ReadActionInput = BaseActionInput.extend(
@@ -6074,7 +6249,7 @@ var Draft = z39.object({
6074
6249
  }).describe(
6075
6250
  "A temporary storage for an action. Stored with details of the event, creator and creation time."
6076
6251
  );
6077
- var DraftInput = BaseActionInput.extend({
6252
+ var DraftInput = BaseActionInput.omit({ waitFor: true }).extend({
6078
6253
  type: ActionTypes.exclude([ActionTypes.enum.DELETE]),
6079
6254
  status: z39.enum([
6080
6255
  ActionStatus.Requested,