@opencrvs/toolkit 1.8.1-rc.b849abb → 1.8.1-rc.b8eea90

package/dist/events/index.js

@@ -60,6 +60,7 @@ __export(events_exports, {
   BIRTH_EVENT: () => BIRTH_EVENT,
   BaseActionInput: () => BaseActionInput,
   BearerTokenByUserType: () => BearerTokenByUserType,
+  ButtonFieldValue: () => ButtonFieldValue,
   CONFIG_GET_ALLOWED_SCOPES: () => CONFIG_GET_ALLOWED_SCOPES,
   CONFIG_SEARCH_ALLOWED_SCOPES: () => CONFIG_SEARCH_ALLOWED_SCOPES,
   CertificateConfig: () => CertificateConfig,
@@ -125,6 +126,7 @@ __export(events_exports, {
   GenericAddressUpdateValue: () => GenericAddressUpdateValue,
   GenericAddressValue: () => GenericAddressValue,
   GeographicalArea: () => GeographicalArea,
+  HttpFieldValue: () => HttpFieldValue,
   ImageMimeType: () => ImageMimeType,
   InherentFlags: () => InherentFlags,
   LanguageConfig: () => LanguageConfig,
@@ -139,6 +141,7 @@ __export(events_exports, {
   PageConfig: () => PageConfig,
   PageTypes: () => PageTypes,
   PrintCertificateActionInput: () => PrintCertificateActionInput,
+  PrintContent: () => PrintContent,
   QueryExpression: () => QueryExpression,
   QueryInput: () => QueryInput,
   QueryType: () => QueryType,
@@ -269,6 +272,7 @@ __export(events_exports, {
   isAddressFieldType: () => isAddressFieldType,
   isAdministrativeAreaFieldType: () => isAdministrativeAreaFieldType,
   isBulletListFieldType: () => isBulletListFieldType,
+  isButtonFieldType: () => isButtonFieldType,
   isCheckboxFieldType: () => isCheckboxFieldType,
   isConditionMet: () => isConditionMet,
   isCountryFieldType: () => isCountryFieldType,
@@ -286,6 +290,7 @@ __export(events_exports, {
   isFieldVisible: () => isFieldVisible,
   isFileFieldType: () => isFileFieldType,
   isFileFieldWithOptionType: () => isFileFieldWithOptionType,
+  isHttpFieldType: () => isHttpFieldType,
   isIdFieldType: () => isIdFieldType,
   isLocationFieldType: () => isLocationFieldType,
   isMetaAction: () => isMetaAction,
@@ -537,7 +542,9 @@ var FieldType = {
   FACILITY: "FACILITY",
   OFFICE: "OFFICE",
   SIGNATURE: "SIGNATURE",
-  DATA: "DATA"
+  DATA: "DATA",
+  BUTTON: "BUTTON",
+  HTTP: "HTTP"
 };
 var fieldTypes = Object.values(FieldType);
 var compositeFieldTypes = [
@@ -606,8 +613,8 @@ var UrbanAddressUpdateValue = AdminStructure.extend({
   zipCode: import_zod5.z.string().nullish()
 });
 var NameFieldValue = import_zod5.z.object({
-  firstname: import_zod5.z.string(),
-  surname: import_zod5.z.string(),
+  firstname: import_zod5.z.string().min(1),
+  surname: import_zod5.z.string().min(1),
   middlename: import_zod5.z.string().optional()
 });
 var NameFieldUpdateValue = import_zod5.z.object({
@@ -677,6 +684,8 @@ var CheckboxFieldValue = import_zod6.z.boolean();
 var NumberFieldValue = import_zod6.z.number();
 var DataFieldValue = import_zod6.z.undefined();
 var SignatureFieldValue = import_zod6.z.string();
+var ButtonFieldValue = import_zod6.z.undefined();
+var HttpFieldValue = import_zod6.z.undefined();
 var FieldValue = import_zod6.z.union([
   TextValue,
   DateValue,
@@ -1004,6 +1013,28 @@ var DataField = BaseField.extend({
     data: import_zod7.z.array(DataEntry)
   })
 }).describe("Data field for displaying read-only data");
+var ButtonField = BaseField.extend({
+  type: import_zod7.z.literal(FieldType.BUTTON),
+  configuration: import_zod7.z.object({
+    onClick: FieldReference,
+    icon: import_zod7.z.string().optional().describe(
+      "Icon for the button. Use icon names from the OpenCRVS UI-Kit."
+    ),
+    shouldHandleLoadingState: import_zod7.z.boolean().default(false).optional(),
+    buttonLabel: TranslationConfig,
+    loadingLabel: TranslationConfig.optional()
+  })
+}).describe("Button for triggering HTTP requests");
+var HttpField = BaseField.extend({
+  type: import_zod7.z.literal(FieldType.HTTP),
+  configuration: import_zod7.z.object({
+    method: import_zod7.z.enum(["GET", "POST", "PUT", "DELETE"]),
+    headers: import_zod7.z.record(import_zod7.z.string()).optional(),
+    body: import_zod7.z.record(import_zod7.z.string()).optional(),
+    params: import_zod7.z.record(import_zod7.z.string()).optional(),
+    url: import_zod7.z.string().describe("URL to send the HTTP request to")
+  })
+}).describe("HTTP request function triggered by a button click");
 var FieldConfig = import_zod7.z.discriminatedUnion("type", [
   Address,
   TextField,
@@ -1032,7 +1063,9 @@ var FieldConfig = import_zod7.z.discriminatedUnion("type", [
   SignatureField,
   EmailField,
   FileUploadWithOptions,
-  DataField
+  DataField,
+  ButtonField,
+  HttpField
 ]).openapi({
   description: "Form field configuration",
   ref: "FieldConfig"
@@ -1340,7 +1373,7 @@ var SummaryConfig = import_zod14.z.object({
 
 // ../commons/src/events/AdvancedSearchConfig.ts
 var import_zod15 = require("zod");
-var MatchType = import_zod15.z.enum(["fuzzy", "exact", "range"]);
+var MatchType = import_zod15.z.enum(["fuzzy", "exact", "range", "within"]);
 var BaseField3 = import_zod15.z.object({
   config: import_zod15.z.object({
     type: MatchType.describe("Determines the type of field")
@@ -1902,11 +1935,15 @@ var ActionBase = import_zod19.z.object({
   originalActionId: UUID.optional().nullable().describe(
     "Reference to the original action that was asynchronously rejected or accepted by 3rd party integration."
   )
+  // 'content' field reserved for additional data
+  // Each action can define its own content specifc to the action
+  // See PrintCertificateAction
 });
 var AssignedAction = ActionBase.merge(
   import_zod19.z.object({
     type: import_zod19.z.literal(ActionType.ASSIGN),
     assignedTo: import_zod19.z.string()
+    // TODO move into 'content' property
   })
 );
 var UnassignedAction = ActionBase.merge(
@@ -1918,6 +1955,7 @@ var RegisterAction = ActionBase.merge(
   import_zod19.z.object({
     type: import_zod19.z.literal(ActionType.REGISTER),
     registrationNumber: import_zod19.z.string().optional()
+    // TODO move into 'content' property
   })
 );
 var DeclareAction = ActionBase.merge(
@@ -1938,6 +1976,7 @@ var RejectAction = ActionBase.merge(
   import_zod19.z.object({
     type: import_zod19.z.literal(ActionType.REJECT),
     reason: RejectionReason
+    // TODO move into 'content' property
   })
 );
 var MarkAsDuplicateAction = ActionBase.merge(
@@ -1949,6 +1988,7 @@ var ArchiveAction = ActionBase.merge(
   import_zod19.z.object({
     type: import_zod19.z.literal(ActionType.ARCHIVE),
     reason: RejectionReason
+    // TODO move into 'content' property
   })
 );
 var CreatedAction = ActionBase.merge(
@@ -1961,9 +2001,13 @@ var NotifiedAction = ActionBase.merge(
     type: import_zod19.z.literal(ActionType.NOTIFY)
   })
 );
+var PrintContent = import_zod19.z.object({
+  templateId: import_zod19.z.string().optional()
+});
 var PrintCertificateAction = ActionBase.merge(
   import_zod19.z.object({
-    type: import_zod19.z.literal(ActionType.PRINT_CERTIFICATE)
+    type: import_zod19.z.literal(ActionType.PRINT_CERTIFICATE),
+    content: PrintContent.optional().nullable()
   })
 );
 var RequestedCorrectionAction = ActionBase.merge(
@@ -1975,12 +2019,14 @@ var ApprovedCorrectionAction = ActionBase.merge(
   import_zod19.z.object({
     type: import_zod19.z.literal(ActionType.APPROVE_CORRECTION),
     requestId: import_zod19.z.string()
+    // TODO move into 'content' property
   })
 );
 var RejectedCorrectionAction = ActionBase.merge(
   import_zod19.z.object({
     type: import_zod19.z.literal(ActionType.REJECT_CORRECTION),
     requestId: import_zod19.z.string(),
+    // TODO move into 'content' property
     reason: RejectionReason
   })
 );
@@ -2094,6 +2140,12 @@ function mapFieldTypeToZod(type, required) {
     case FieldType.NAME:
       schema = required ? NameFieldValue : NameFieldUpdateValue;
       break;
+    case FieldType.BUTTON:
+      schema = ButtonFieldValue;
+      break;
+    case FieldType.HTTP:
+      schema = ButtonFieldValue;
+      break;
   }
   return required ? schema : schema.nullish();
 }
@@ -2127,6 +2179,8 @@ function mapFieldTypeToEmptyValue(field2) {
     case FieldType.DATE_RANGE:
     case FieldType.SELECT_DATE_RANGE:
     case FieldType.DATA:
+    case FieldType.BUTTON:
+    case FieldType.HTTP:
     case FieldType.NAME:
     case FieldType.PHONE:
     case FieldType.ID:
@@ -2240,6 +2294,12 @@ var isOfficeFieldType = (field2) => {
 var isDataFieldType = (field2) => {
   return field2.config.type === FieldType.DATA;
 };
+var isButtonFieldType = (field2) => {
+  return field2.config.type === FieldType.BUTTON;
+};
+var isHttpFieldType = (field2) => {
+  return field2.config.type === FieldType.HTTP;
+};
 var isNonInteractiveFieldType = (field2) => {
   return field2.type === FieldType.DIVIDER || field2.type === FieldType.PAGE_HEADER || field2.type === FieldType.PARAGRAPH || field2.type === FieldType.BULLET_LIST || field2.type === FieldType.DATA;
 };
@@ -3175,6 +3235,19 @@ function createSearchConfig(baseField) {
     fuzzy: () => ({
       ...baseField,
       config: { type: "fuzzy" }
+    }),
+    /**
+     * Creates a configuration for matching locations and the child locations
+     * @returns  An object containing the field ID and a configuration object with a type of 'within'.
+     * @example field('createdAtLocation').within()
+     * // {
+     * //   ...
+     * //   config: { type: 'within' }
+     * // }
+     */
+    within: () => ({
+      ...baseField,
+      config: { type: "within" }
     })
   };
 }
@@ -3524,6 +3597,9 @@ var QueryExpression = import_zod25.z.object({
   createdAt: import_zod25.z.optional(DateCondition),
   updatedAt: import_zod25.z.optional(DateCondition),
   "legalStatuses.REGISTERED.acceptedAt": import_zod25.z.optional(DateCondition),
+  "legalStatuses.DECLARED.createdAtLocation": import_zod25.z.optional(
+    import_zod25.z.union([Within, Exact])
+  ),
   "legalStatuses.REGISTERED.createdAtLocation": import_zod25.z.optional(
     import_zod25.z.union([Within, Exact])
   ),
@@ -3877,7 +3953,8 @@ var DeclareActionInput = BaseActionInput.merge(
 );
 var PrintCertificateActionInput = BaseActionInput.merge(
   import_zod29.z.object({
-    type: import_zod29.z.literal(ActionType.PRINT_CERTIFICATE).default(ActionType.PRINT_CERTIFICATE)
+    type: import_zod29.z.literal(ActionType.PRINT_CERTIFICATE).default(ActionType.PRINT_CERTIFICATE),
+    content: PrintContent.optional()
   })
 );
 var RejectDeclarationActionInput = BaseActionInput.merge(
@@ -6459,6 +6536,8 @@ function mapFieldTypeToMockValue(field2, i, rng) {
     case FieldType.PHONE:
     case FieldType.ID:
     case FieldType.OFFICE:
+    case FieldType.HTTP:
+    case FieldType.BUTTON:
       return `${field2.id}-${field2.type}-${i}`;
     case FieldType.NAME:
       return generateRandomName(rng);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/toolkit",
-  "version": "1.8.1-rc.b849abb",
+  "version": "1.8.1-rc.b8eea90",
   "description": "OpenCRVS toolkit for building country configurations",
   "license": "MPL-2.0",
   "exports": {