@opencrvs/toolkit 2.0.0-rc.fdc585a → 2.0.0-rc.fe94e41

package/dist/application-config/index.js

@@ -75,7 +75,10 @@ var ActionConditional = z.discriminatedUnion("type", [
   ShowConditional,
   // Action can be shown to the user in the list but as disabled
   EnableConditional
-]);
+]).meta({
+  id: "ActionConditional",
+  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."
+});
 var DisplayOnReviewConditional = z.object({
   type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
   conditional: Conditional
@@ -90,8 +93,8 @@ var FieldConditional = z.discriminatedUnion("type", [
   // Field output can be shown / hidden on the review page
   DisplayOnReviewConditional
 ]).meta({
-  description: "Field conditional configuration",
-  id: "FieldConditional"
+  id: "FieldConditional",
+  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."
 });
 
 // ../commons/src/events/TranslationConfig.ts
@@ -418,28 +421,20 @@ function schemaPriority(schema) {
   return idx === -1 ? 9999 : idx;
 }
 function safeUnion(schemas) {
+  const sortedSchemas = [...schemas].sort(
+    (a, b) => schemaPriority(a) - schemaPriority(b)
+  );
   return z7.any().superRefine((val, ctx) => {
-    const successful = schemas.filter((s) => s.safeParse(val).success);
-    if (successful.length === 1) {
-      return;
-    }
-    if (successful.length === 0) {
-      ctx.addIssue({
-        code: "invalid_type",
-        expected: "custom",
-        message: "Value does not match any schema"
-      });
-      return;
-    }
-    successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
-    const best = successful[0];
-    if (!best.safeParse(val).success) {
-      ctx.addIssue({
-        expected: "custom",
-        code: "invalid_type",
-        message: "Value did not match the best schema"
-      });
+    for (const schema of sortedSchemas) {
+      if (schema.safeParse(val).success) {
+        return;
+      }
     }
+    ctx.addIssue({
+      code: "invalid_type",
+      expected: "custom",
+      message: "Value does not match any schema"
+    });
   }).meta({
     description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
   });
@@ -839,7 +834,9 @@ var ScopeType = z11.enum([
 var EncodedScope = z11.string().brand("EncodedScope");
 var DEFAULT_SCOPE_OPTIONS = {
   placeOfEvent: JurisdictionFilter.enum.all,
-  accessLevel: JurisdictionFilter.enum.all
+  accessLevel: JurisdictionFilter.enum.all,
+  registeredIn: JurisdictionFilter.enum.all,
+  declaredIn: JurisdictionFilter.enum.all
 };
 
 // ../commons/src/authentication.ts
@@ -992,8 +989,9 @@ var RequestedCorrectionAction = ActionBase.extend(
 var ApprovedCorrectionAction = ActionBase.extend(
   z13.object({
     type: z13.literal(ActionType.APPROVE_CORRECTION),
-    requestId: z13.string()
+    requestId: z13.string(),
     // TODO move into 'content' property
+    content: z13.object({ immediateCorrection: z13.boolean().optional() }).optional()
   }).shape
 );
 var RejectedCorrectionAction = ActionBase.extend(
@@ -1085,6 +1083,9 @@ var FlagConfig = z14.object({
     "Indicates if this flag expects an action to be performed to be cleared."
   ),
   label: TranslationConfig.describe("Human readable label of the flag.")
+}).meta({
+  id: "FlagConfig",
+  description: "Configuration for a custom flag that can be added to or removed from records by event actions."
 });
 var ActionFlagConfig = z14.object({
   id: Flag,
@@ -1092,6 +1093,9 @@ var ActionFlagConfig = z14.object({
   conditional: Conditional.optional().describe(
     "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
   )
+}).meta({
+  id: "ActionFlagConfig",
+  description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
 });
 
 // ../commons/src/events/EventMetadata.ts
@@ -1113,8 +1117,7 @@ var ActionCreationMetadata = z15.object({
   ),
   createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
   acceptedAt: z15.iso.datetime().describe("Timestamp when the action request was accepted."),
-  createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation."),
-  createdBySignature: z15.string().nullish().describe("Signature of the user who created the action request.")
+  createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation.")
 });
 var RegistrationCreationMetadata = ActionCreationMetadata.extend({
   registrationNumber: z15.string().describe(
@@ -1142,9 +1145,6 @@ var EventMetadata = z15.object({
   createdAtLocation: UUID.nullish().describe(
     "Location of the user who created the event."
   ),
-  createdBySignature: DocumentPath.nullish().describe(
-    "Signature of the user who created the event."
-  ),
   updatedAtLocation: UUID.nullish().describe(
     "Location of the user who last changed the status."
   ),
@@ -1408,14 +1408,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
   }
 }).describe("Unique identifier for the field");
 var FieldReference = import_v43.default.object({
-  $$field: FieldId,
+  $$field: FieldId.describe("Id of the field to reference"),
   $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
     'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
   )
 }).describe("Reference to a field by its ID");
 var ValidationConfig = import_v43.default.object({
-  validator: Conditional,
-  message: TranslationConfig
+  validator: Conditional.describe(
+    "Conditional expression that must hold for the field value to be considered valid."
+  ),
+  message: TranslationConfig.describe(
+    "Error message displayed when the validator does not hold."
+  )
+}).meta({
+  id: "ValidationConfig",
+  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."
 });
 var requiredSchema = import_v43.default.union([
   import_v43.default.boolean(),
@@ -1454,6 +1461,9 @@ var BaseField = import_v43.default.object({
 }).describe("Common properties shared across all field types.");
 var Divider = BaseField.extend({
   type: import_v43.default.literal(FieldType.DIVIDER)
+}).meta({
+  description: "A horizontal line divider",
+  id: "Divider"
 });
 var TextField = BaseField.extend({
   type: import_v43.default.literal(FieldType.TEXT),
@@ -1464,7 +1474,10 @@ var TextField = BaseField.extend({
     prefix: TranslationConfig.optional(),
     postfix: TranslationConfig.optional()
   }).default({ type: "text" }).optional()
-}).describe("Text input");
+}).meta({
+  description: "A text input field",
+  id: "TextField"
+});
 var NumberField = BaseField.extend({
   type: import_v43.default.literal(FieldType.NUMBER),
   defaultValue: NumberFieldValue.optional(),
@@ -1474,7 +1487,10 @@ var NumberField = BaseField.extend({
     prefix: TranslationConfig.optional(),
     postfix: TranslationConfig.optional()
   }).optional()
-}).describe("Number input");
+}).meta({
+  description: "A number input field",
+  id: "NumberField"
+});
 var TextAreaField = BaseField.extend({
   type: import_v43.default.literal(FieldType.TEXTAREA),
   defaultValue: NonEmptyTextValue.optional(),
@@ -1485,7 +1501,10 @@ var TextAreaField = BaseField.extend({
     prefix: TranslationConfig.optional(),
     postfix: TranslationConfig.optional()
   }).default({ rows: 4 }).optional()
-}).describe("Multiline text input");
+}).meta({
+  description: "A multiline text input",
+  id: "TextAreaField"
+});
 var ImageMimeType = import_v43.default.enum([
   "image/png",
   "image/jpg",
@@ -1515,13 +1534,19 @@ var SignatureField = BaseField.extend({
   }).default({
     maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
   })
-}).describe("Signature input field");
+}).meta({
+  description: "A signature input field",
+  id: "SignatureField"
+});
 var EmailField = BaseField.extend({
   type: import_v43.default.literal(FieldType.EMAIL),
   configuration: import_v43.default.object({
     maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
   }).default({ maxLength: 255 }).optional(),
   defaultValue: NonEmptyTextValue.optional()
+}).meta({
+  description: "An email input field",
+  id: "EmailField"
 });
 var DateField = BaseField.extend({
   type: import_v43.default.literal(FieldType.DATE),
@@ -1531,7 +1556,10 @@ var DateField = BaseField.extend({
       "Text to display above the date input"
     ).optional()
   }).optional()
-}).describe("A single date input (yyyy-MM-dd)");
+}).meta({
+  description: "A date input (yyyy-MM-dd)",
+  id: "DateField"
+});
 var AgeField = BaseField.extend({
   type: import_v43.default.literal(FieldType.AGE),
   defaultValue: NumberFieldValue.optional(),
@@ -1540,7 +1568,10 @@ var AgeField = BaseField.extend({
     prefix: TranslationConfig.optional(),
     postfix: TranslationConfig.optional()
   })
-}).describe("An age input field which uses the current date as the asOfDate");
+}).meta({
+  description: "An age input field which uses the current date as the asOfDate",
+  id: "AgeField"
+});
 var TimeField = BaseField.extend({
   type: import_v43.default.literal(FieldType.TIME),
   defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -1550,7 +1581,10 @@ var TimeField = BaseField.extend({
       "Text to display above the time input"
     ).optional()
   }).optional()
-}).describe("A single date input (HH-mm)");
+}).meta({
+  description: "A single time input (HH-mm)",
+  id: "TimeField"
+});
 var DateRangeField = BaseField.extend({
   type: import_v43.default.literal(FieldType.DATE_RANGE),
   defaultValue: DateRangeFieldValue.optional(),
@@ -1559,7 +1593,10 @@ var DateRangeField = BaseField.extend({
       "Text to display above the date input"
     ).optional()
   }).optional()
-}).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
+}).meta({
+  description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
+  id: "DateRangeField"
+});
 var HtmlFontVariant = import_v43.default.enum([
   "reg12",
   "reg14",
@@ -1603,18 +1640,30 @@ var ImageViewField = BaseField.extend({
   type: import_v43.default.literal(FieldType.IMAGE_VIEW),
   defaultValue: NonEmptyTextValue.optional(),
   configuration: ImageConfiguration
-}).describe("A read-only image component for form pages");
+}).meta({
+  description: "A read-only image component for form pages",
+  id: "ImageViewField"
+});
 var Paragraph = BaseField.extend({
   type: import_v43.default.literal(FieldType.PARAGRAPH),
   configuration: ParagraphConfiguration
-}).describe("A read-only HTML <p> paragraph");
+}).meta({
+  description: "A read-only HTML <p> paragraph",
+  id: "Paragraph"
+});
 var Heading = BaseField.extend({
   type: import_v43.default.literal(FieldType.HEADING),
   configuration: HeadingConfiguration
-}).describe("A read-only heading component for form pages");
+}).meta({
+  description: "A read-only heading component for form pages",
+  id: "Heading"
+});
 var PageHeader = BaseField.extend({
   type: import_v43.default.literal(FieldType.PAGE_HEADER)
-}).describe("A read-only header component for form pages");
+}).meta({
+  description: "A read-only header component for form pages",
+  id: "PageHeader"
+});
 var File = BaseField.extend({
   type: import_v43.default.literal(FieldType.FILE),
   defaultValue: FileFieldValue.optional(),
@@ -1633,7 +1682,10 @@ var File = BaseField.extend({
   }).default({
     maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
   })
-}).describe("File upload");
+}).meta({
+  description: "A file upload field",
+  id: "File"
+});
 var SelectOption = import_v43.default.object({
   value: import_v43.default.string().describe("The value of the option"),
   label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1650,7 +1702,10 @@ var NumberWithUnitField = BaseField.extend({
       "Placeholder for the number field"
     )
   }).optional()
-}).describe("Number with unit input");
+}).meta({
+  description: "A number with unit input field",
+  id: "NumberWithUnitField"
+});
 var RadioGroup = BaseField.extend({
   type: import_v43.default.literal(FieldType.RADIO_GROUP),
   defaultValue: TextValue.optional(),
@@ -1660,7 +1715,10 @@ var RadioGroup = BaseField.extend({
       size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
     }).optional()
   }).optional()
-}).describe("Grouped radio options");
+}).meta({
+  description: "A grouped radio button field",
+  id: "RadioGroup"
+});
 var BulletList = BaseField.extend({
   type: import_v43.default.literal(FieldType.BULLET_LIST),
   items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1669,7 +1727,10 @@ var BulletList = BaseField.extend({
       fontVariant: HtmlFontVariant.optional()
     }).optional()
   }).default({})
-}).describe("A list of bullet points");
+}).meta({
+  description: "A list of bullet points",
+  id: "BulletList"
+});
 var Select = BaseField.extend({
   type: import_v43.default.literal(FieldType.SELECT),
   defaultValue: TextValue.optional(),
@@ -1684,7 +1745,10 @@ var Select = BaseField.extend({
     { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
   `
   )
-}).describe("Select input");
+}).meta({
+  description: "A select input field",
+  id: "Select"
+});
 var SelectDateRangeOption = import_v43.default.object({
   value: SelectDateRangeValue.describe("The value of the option"),
   label: TranslationConfig.describe("The label of the option")
@@ -1693,7 +1757,10 @@ var SelectDateRangeField = BaseField.extend({
   type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
   defaultValue: SelectDateRangeValue.optional(),
   options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
-}).describe("Select input with date range options");
+}).meta({
+  description: "A date range selection field",
+  id: "SelectDateRangeField"
+});
 var NameConfig = import_v43.default.object({
   firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
   middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1724,26 +1791,41 @@ var NameField = BaseField.extend({
       surname: { required: true }
     }
   }).optional()
-}).describe("Name input field");
+}).meta({
+  description: "A field for entering a persons name",
+  id: "NameField"
+});
 var PhoneField = BaseField.extend({
   defaultValue: NonEmptyTextValue.optional(),
   type: import_v43.default.literal(FieldType.PHONE)
-}).describe("Phone input field");
+}).meta({
+  description: "A field for entering a phone number",
+  id: "PhoneField"
+});
 var IdField = BaseField.extend({
   defaultValue: NonEmptyTextValue.optional(),
   type: import_v43.default.literal(FieldType.ID)
-}).describe("ID input field");
+}).meta({
+  description: "A field for entering an ID",
+  id: "IdField"
+});
 var Checkbox = BaseField.extend({
   type: import_v43.default.literal(FieldType.CHECKBOX),
   defaultValue: CheckboxFieldValue.default(false)
-}).describe("Boolean checkbox field");
+}).meta({
+  description: "A boolean checkbox field",
+  id: "Checkbox"
+});
 var Country = BaseField.extend({
   type: import_v43.default.literal(FieldType.COUNTRY),
   defaultValue: NonEmptyTextValue.optional(),
   optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
     "Conditionals for specific countries. Countries not listed are always shown and enabled."
   )
-}).describe("Country select field");
+}).meta({
+  description: "A field for selecting a country",
+  id: "Country"
+});
 var AllowedLocations = JurisdictionReference.optional().describe(
   "Limits which location options are selectable depending on user jurisdiction and location."
 );
@@ -1752,16 +1834,18 @@ var AdministrativeAreas = import_v43.default.enum([
   "HEALTH_FACILITY",
   "CRVS_OFFICE"
 ]);
-var AdministrativeAreaConfiguration = import_v43.default.object({
-  partOf: FieldReference.optional().describe("Parent location"),
-  type: AdministrativeAreas,
-  allowedLocations: AllowedLocations
-}).describe("Administrative area options");
 var AdministrativeAreaField = BaseField.extend({
   type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
   defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
-  configuration: AdministrativeAreaConfiguration
-}).describe("Administrative area input field e.g. facility, office");
+  configuration: import_v43.default.object({
+    partOf: FieldReference.optional().describe("Parent location"),
+    type: AdministrativeAreas,
+    allowedLocations: AllowedLocations
+  }).describe("Administrative area options")
+}).meta({
+  description: "Administrative area input field",
+  id: "AdministrativeAreaField"
+});
 var LocationInput = BaseField.extend({
   type: import_v43.default.literal(FieldType.LOCATION),
   defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -1769,7 +1853,10 @@ var LocationInput = BaseField.extend({
     locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
     allowedLocations: AllowedLocations
   }).optional()
-}).describe("Input field for a location");
+}).meta({
+  description: "A field for selecting a location",
+  id: "LocationInput"
+});
 var FileUploadWithOptions = BaseField.extend({
   type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
   options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -1783,6 +1870,9 @@ var FileUploadWithOptions = BaseField.extend({
   }).default({
     maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
   })
+}).meta({
+  description: "A field for uploading files with file type options",
+  id: "FileUploadWithOptions"
 });
 var Facility = BaseField.extend({
   type: import_v43.default.literal(FieldType.FACILITY),
@@ -1828,7 +1918,10 @@ var Address = BaseField.extend({
     allowedLocations: AllowedLocations
   }).optional(),
   defaultValue: DefaultAddressFieldValue.optional()
-}).describe("Address input field \u2013 a combination of location and text fields");
+}).meta({
+  description: "Address input field \u2013 a combination of location and text fields",
+  id: "Address"
+});
 var StaticDataEntry = import_v43.default.object({
   id: import_v43.default.string().describe("ID for the data entry."),
   label: TranslationConfig,
@@ -1843,7 +1936,10 @@ var DataField = BaseField.extend({
     subtitle: TranslationConfig.optional(),
     data: import_v43.default.array(DataEntry)
   })
-}).describe("Data field for displaying read-only data");
+}).meta({
+  description: "A field for displaying a table of read-only data",
+  id: "DataField"
+});
 var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
 var ButtonType = import_v43.default.enum([
   "primary",
@@ -1870,11 +1966,17 @@ var ButtonField = BaseField.extend({
   type: import_v43.default.literal(FieldType.BUTTON),
   defaultValue: ButtonFieldValue.optional(),
   configuration: ButtonConfiguration
-}).describe("Generic button without any built-in functionality");
+}).meta({
+  description: "A generic button that can be used to trigger an action",
+  id: "ButtonField"
+});
 var FieldGroup = BaseField.extend({
   type: import_v43.default.literal(FieldType.FIELD_GROUP),
   // eslint-disable-next-line @typescript-eslint/no-use-before-define
   fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
+}).meta({
+  description: "A group of fields that are displayed together",
+  id: "FieldGroup"
 });
 var AlphaPrintButton = BaseField.extend({
   type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1884,7 +1986,10 @@ var AlphaPrintButton = BaseField.extend({
       "Label for the print button"
     )
   })
-}).describe("Print button field for printing certificates");
+}).meta({
+  description: "An experimental print button field for printing certificates during the declaration process",
+  id: "AlphaPrintButton"
+});
 var HttpField = BaseField.extend({
   type: import_v43.default.literal(FieldType.HTTP),
   defaultValue: HttpFieldValue.optional(),
@@ -1900,20 +2005,30 @@ var HttpField = BaseField.extend({
     params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
     timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
   })
-}).describe("HTTP request function triggered by a button click or other event");
+}).meta({
+  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.",
+  id: "HttpField"
+});
 var AutocompleteField = BaseField.extend({
   type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
   configuration: import_v43.default.object({
-    url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
+    url: import_v43.default.string().describe(
+      "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
+    ).optional(),
     method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
     defaultOptions: import_v43.default.array(
       import_v43.default.object({
         label: import_v43.default.string(),
         value: import_v43.default.string()
       })
-    ).optional()
+    ).optional().describe(
+      "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
+    )
   })
-}).describe("Autocomplete input field");
+}).meta({
+  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.",
+  id: "AutocompleteField"
+});
 var SearchField = HttpField.extend({
   type: import_v43.default.literal(FieldType.SEARCH),
   configuration: SearchQuery.pick({
@@ -1946,6 +2061,9 @@ var SearchField = HttpField.extend({
       ok: TranslationConfig.optional()
     }).optional()
   })
+}).meta({
+  description: "A search input field",
+  id: "SearchField"
 });
 var LinkButtonField = BaseField.extend({
   type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1954,7 +2072,10 @@ var LinkButtonField = BaseField.extend({
     text: TranslationConfig.describe("Text to display on the button"),
     icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
   })
-}).describe("Button that opens a link");
+}).meta({
+  description: "A button that opens a URL link",
+  id: "LinkButtonField"
+});
 var VerificationStatus = BaseField.extend({
   type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
   defaultValue: VerificationStatusValue.optional(),
@@ -1964,15 +2085,19 @@ var VerificationStatus = BaseField.extend({
       "Explaining text on the banner in form."
     )
   })
+}).meta({
+  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.",
+  id: "VerificationStatus"
 });
 var QueryParamReaderField = BaseField.extend({
   type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
   configuration: import_v43.default.object({
     pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
   })
-}).describe(
-  "A field that maps URL query params into form values and clears them afterward"
-);
+}).meta({
+  description: "A field that maps URL query params into form values and clears them afterward",
+  id: "QueryParamReaderField"
+});
 var QrReaderField = BaseField.extend({
   type: import_v43.default.literal(FieldType.QR_READER),
   defaultValue: QrReaderFieldValue.optional(),
@@ -1983,7 +2108,7 @@ var QrReaderField = BaseField.extend({
     })
   }).optional()
 }).meta({
-  description: "Configuration for QR code reader field, including optional JSON Schema validator.",
+  description: "QR code reader field, including optional JSON Schema validator.",
   id: "QrReaderField"
 });
 var IdReaderField = BaseField.extend({
@@ -1992,12 +2117,18 @@ var IdReaderField = BaseField.extend({
   methods: import_v43.default.array(
     import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
   )
+}).meta({
+  description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
+  id: "IdReaderField"
 });
 var CustomField = BaseField.extend({
   type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
   defaultValue: CustomFieldValue.optional(),
   src: import_v43.default.string().describe("Module source path for the custom field component"),
   configuration: import_v43.default.unknown().optional()
+}).meta({
+  description: "An expiremental custom field that is defined by a module source path",
+  id: "CustomField"
 });
 var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
 var LoaderField = BaseField.extend({
@@ -2007,22 +2138,25 @@ var LoaderField = BaseField.extend({
   configuration: import_v43.default.object({
     text: TranslationConfig.describe("Display text above the loading spinner")
   })
-}).describe(
-  "A non-interactive field that indicates an in progress operation in form"
-);
+}).meta({
+  description: "A non-interactive field that indicates an in progress operation in form",
+  id: "LoaderField"
+});
 var HiddenField = BaseField.extend({
   type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
   required: import_v43.default.boolean().default(false).optional(),
   defaultValue: TextValue.optional()
-}).describe(
-  "A non-interactive, hidden field that only hold a value in the form"
-);
+}).meta({
+  description: "A non-interactive, hidden field that only hold a value in the form",
+  id: "HiddenField"
+});
 var UserRoleField = BaseField.extend({
   type: import_v43.default.literal(FieldType.USER_ROLE),
   defaultValue: TextValue.optional()
-}).describe(
-  "A select dropdown that is automatically populated with available user roles"
-);
+}).meta({
+  description: "A select dropdown that is automatically populated with available user roles",
+  id: "UserRoleField"
+});
 var FieldConfig = import_v43.default.discriminatedUnion("type", [
   FieldGroup,
   Address,