@opencrvs/toolkit 1.8.0-rc.feaeeb7 → 1.8.0-rc.ff73871

package/dist/commons/events/EventDocument.d.ts

@@ -1282,9 +1282,9 @@ export declare const EventDocument: z.ZodObject<{
         }>]>>>;
         createdAtLocation: z.ZodString;
     }, {
-        type: z.ZodLiteral<"ARCHIVED">;
+        type: z.ZodLiteral<"ARCHIVE">;
     }>, "strip", z.ZodTypeAny, {
-        type: "ARCHIVED";
+        type: "ARCHIVE";
         id: string;
         data: Record<string, string | number | boolean | {
             type: string;
@@ -1342,7 +1342,7 @@ export declare const EventDocument: z.ZodObject<{
             originalFilename: string;
         }[]> | undefined;
     }, {
-        type: "ARCHIVED";
+        type: "ARCHIVE";
         id: string;
         data: Record<string, string | number | boolean | {
             type: string;
@@ -4636,7 +4636,7 @@ export declare const EventDocument: z.ZodObject<{
             originalFilename: string;
         }[]> | undefined;
     } | {
-        type: "ARCHIVED";
+        type: "ARCHIVE";
         id: string;
         data: Record<string, string | number | boolean | {
             type: string;
@@ -5520,7 +5520,7 @@ export declare const EventDocument: z.ZodObject<{
             originalFilename: string;
         }[]> | undefined;
     } | {
-        type: "ARCHIVED";
+        type: "ARCHIVE";
         id: string;
         data: Record<string, string | number | boolean | {
             type: string;

package/dist/commons/events/FieldConfig.d.ts

@@ -2319,6 +2319,7 @@ declare const Country: z.ZodObject<z.objectUtil.extendShape<{
     hideLabel?: boolean | undefined;
 }>;
 export type Country = z.infer<typeof Country>;
+export declare const AdministrativeAreas: z.ZodEnum<["ADMIN_STRUCTURE", "HEALTH_FACILITY", "CRVS_OFFICE"]>;
 declare const AdministrativeAreaConfiguration: z.ZodObject<{
     partOf: z.ZodOptional<z.ZodObject<{
         $data: z.ZodString;

package/dist/commons/events/FieldType.d.ts

@@ -24,4 +24,8 @@ export declare const FieldType: {
 };
 export declare const fieldTypes: ("ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "HIDDEN" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE")[];
 export type FieldType = (typeof fieldTypes)[number];
+/**
+ * Composite field types are field types that consist of multiple field values.
+ */
+export declare const compositeFieldTypes: ("ADDRESS" | "FILE" | "FILE_WITH_OPTIONS")[];
 //# sourceMappingURL=FieldType.d.ts.map

package/dist/commons/events/FieldTypeMapping.d.ts

@@ -258,6 +258,36 @@ export declare function mapFieldTypeToMockValue(field: FieldConfig, i: number):
     number?: undefined;
     zipCode?: undefined;
 } | null;
+/**
+ * Maps complex or nested field types, such as Address fields, to their corresponding empty values.
+ */
+export declare function mapFieldTypeToEmptyValue(field: FieldConfig): never[] | {
+    country: null;
+    province: null;
+    district: null;
+    urbanOrRural: string;
+    town: null;
+    residentialArea: null;
+    street: null;
+    number: null;
+    zipCode: null;
+    filename?: undefined;
+    originalFilename?: undefined;
+    type?: undefined;
+} | {
+    filename: string;
+    originalFilename: string;
+    type: string;
+    country?: undefined;
+    province?: undefined;
+    district?: undefined;
+    urbanOrRural?: undefined;
+    town?: undefined;
+    residentialArea?: undefined;
+    street?: undefined;
+    number?: undefined;
+    zipCode?: undefined;
+} | null;
 export declare const isParagraphFieldType: (field: {
     config: FieldConfig;
     value: FieldValue;

package/dist/commons/events/TemplateConfig.d.ts

@@ -1,18 +1,38 @@
+/**
+ * TemplateConfig defines configuration rules for system-based variables (e.g. $user.province).
+ * They are currently used for providing default values in FieldConfig.
+ */
 import { FieldValue } from './FieldValue';
-export type DefaultValue = FieldValue | MetaFieldsDotted | Record<string, MetaFieldsDotted | FieldValue>;
-export declare function isTemplateVariable(value: DefaultValue): value is MetaFieldsDotted;
-export declare function isFieldValue(value: DefaultValue): value is FieldValue;
-export declare function isFieldValueWithoutTemplates(value: DefaultValue): value is FieldValue;
-export declare function isDefaultValue(value: any): value is DefaultValue;
+/**
+ * Available system variables for configuration.
+ */
 export interface MetaFields {
     $user: {
         province: string;
         district: string;
     };
 }
-type DottedKeys<T, Prefix extends string = ''> = {
-    [K in keyof T]: T[K] extends Record<string, string> ? DottedKeys<T[K], `${Prefix}${K & string}.`> : `${Prefix}${K & string}`;
+/**
+ * Recursively flatten the keys of an object. Used to limit types when configuring default values in country config.
+ * @example
+ * type Test = FlattenedKeyStrings<{ a: { b: string, c: { d: string } } }>
+ * // 'a.b' | 'a.c.d' but not 'a' or 'a.c'
+ */
+type FlattenedKeyStrings<T, Prefix extends string = ''> = {
+    [K in keyof T]: T[K] extends Record<string, any> ? FlattenedKeyStrings<T[K], `${Prefix}${K & string}.`> : `${Prefix}${K & string}`;
 }[keyof T];
-export type MetaFieldsDotted = DottedKeys<MetaFields>;
+export type FlattenedMetaFields = FlattenedKeyStrings<MetaFields>;
+/**
+ * Default value for a field when configuring a form.
+ */
+export type FieldConfigDefaultValue = FieldValue | FlattenedMetaFields | Record<string, FlattenedMetaFields | FieldValue>;
+export declare function isTemplateVariable(value: FieldConfigDefaultValue): value is FlattenedMetaFields;
+export declare function isFieldValue(value: FieldConfigDefaultValue): value is FieldValue;
+/**
+ * Checks if given value is valid for a field, and known template variables are already resolved.
+ * @todo: Extend functionality to arbitrary depth objects. Currently only checks first level since our compoosite fields are only 1 level deep.
+ */
+export declare function isFieldValueWithoutTemplates(value: FieldConfigDefaultValue): value is FieldValue;
+export declare function isFieldConfigDefaultValue(value: any): value is FieldConfigDefaultValue;
 export {};
 //# sourceMappingURL=TemplateConfig.d.ts.map

package/dist/commons/events/defineConfig.d.ts

@@ -122,7 +122,7 @@ export declare const defineConfig: (config: EventConfigInput) => {
         duplicates: string[];
         draft?: boolean | undefined;
     } | {
-        type: "ARCHIVED";
+        type: "ARCHIVE";
         comment: string;
         conditionals: ({
             type: "SHOW";

package/dist/commons/events/test.utils.d.ts

@@ -1,5 +1,5 @@
 import { ActionDocument } from './ActionDocument';
-import { ArchivedActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
+import { ArchiveActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
 import { ActionType } from './ActionType';
 import { Draft } from './Draft';
 import { EventConfig } from './EventConfig';
@@ -192,8 +192,8 @@ export declare const eventPayloadGenerator: {
             duplicates: never[];
             eventId: string;
         };
-        archive: (eventId: string, input?: Partial<Pick<ArchivedActionInput, "transactionId" | "data">>, isDuplicate?: boolean) => {
-            type: "ARCHIVED";
+        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "data">>, isDuplicate?: boolean) => {
+            type: "ARCHIVE";
             transactionId: string;
             data: Record<string, string | number | boolean | {
                 type: string;

package/dist/commons/events/utils.d.ts

@@ -75,6 +75,11 @@ export declare const findActiveActionFormFields: (configuration: EventConfig, ac
  * Returns all fields for the action type, including review fields, if any.
  */
 export declare const findActiveActionFields: (configuration: EventConfig, action: ActionType) => FieldConfig[] | undefined;
+export declare const getActiveActionFormPages: (configuration: EventConfig, action: ActionType) => {
+    id: string;
+    title: TranslationConfig;
+    fields: import("./FieldConfig").Inferred[];
+}[];
 /**
  * Returns all fields for the action type, including review fields, or throws
  */

package/dist/events/index.js

@@ -40,9 +40,10 @@ __export(events_exports, {
   ActionUpdate: () => ActionUpdate,
   AddressFieldUpdateValue: () => AddressFieldUpdateValue,
   AddressFieldValue: () => AddressFieldValue,
+  AdministrativeAreas: () => AdministrativeAreas,
   AdvancedSearchConfig: () => AdvancedSearchConfig,
   ApproveCorrectionActionInput: () => ApproveCorrectionActionInput,
-  ArchivedActionInput: () => ArchivedActionInput,
+  ArchiveActionInput: () => ArchiveActionInput,
   BaseActionInput: () => BaseActionInput,
   CertificateConfig: () => CertificateConfig,
   CertificateTemplateConfig: () => CertificateTemplateConfig,
@@ -100,6 +101,7 @@ __export(events_exports, {
   alwaysTrue: () => alwaysTrue,
   and: () => and,
   applyDraftsToEventIndex: () => applyDraftsToEventIndex,
+  compositeFieldTypes: () => compositeFieldTypes,
   createValidationSchema: () => createValidationSchema,
   deepDropNulls: () => deepDropNulls,
   defineConditional: () => defineConditional,
@@ -125,6 +127,7 @@ __export(events_exports, {
   generateEventDraftDocument: () => generateEventDraftDocument,
   generateTransactionId: () => generateTransactionId,
   getActiveActionFields: () => getActiveActionFields,
+  getActiveActionFormPages: () => getActiveActionFormPages,
   getAllFields: () => getAllFields,
   getAllPages: () => getAllPages,
   getCurrentEventState: () => getCurrentEventState,
@@ -139,10 +142,10 @@ __export(events_exports, {
   isCheckboxFieldType: () => isCheckboxFieldType,
   isCountryFieldType: () => isCountryFieldType,
   isDateFieldType: () => isDateFieldType,
-  isDefaultValue: () => isDefaultValue,
   isDividerFieldType: () => isDividerFieldType,
   isEmailFieldType: () => isEmailFieldType,
   isFacilityFieldType: () => isFacilityFieldType,
+  isFieldConfigDefaultValue: () => isFieldConfigDefaultValue,
   isFieldEnabled: () => isFieldEnabled,
   isFieldValue: () => isFieldValue,
   isFieldValueWithoutTemplates: () => isFieldValueWithoutTemplates,
@@ -161,6 +164,7 @@ __export(events_exports, {
   isTextAreaFieldType: () => isTextAreaFieldType,
   isTextFieldType: () => isTextFieldType,
   isUndeclaredDraft: () => isUndeclaredDraft,
+  mapFieldTypeToEmptyValue: () => mapFieldTypeToEmptyValue,
   mapFieldTypeToMockValue: () => mapFieldTypeToMockValue,
   mapFieldTypeToZod: () => mapFieldTypeToZod,
   not: () => not,
@@ -247,6 +251,11 @@ var FieldType = {
   SIGNATURE: "SIGNATURE"
 };
 var fieldTypes = Object.values(FieldType);
+var compositeFieldTypes = [
+  FieldType.ADDRESS,
+  FieldType.FILE_WITH_OPTIONS,
+  FieldType.FILE
+];
 
 // ../commons/src/events/FieldValue.ts
 var import_zod4 = require("zod");
@@ -499,11 +508,16 @@ var Country = BaseField.extend({
   type: import_zod5.z.literal(FieldType.COUNTRY),
   defaultValue: import_zod5.z.union([RequiredTextValue, DependencyExpression]).optional()
 }).describe("Country select field");
+var AdministrativeAreas = import_zod5.z.enum([
+  "ADMIN_STRUCTURE",
+  "HEALTH_FACILITY",
+  "CRVS_OFFICE"
+]);
 var AdministrativeAreaConfiguration = import_zod5.z.object({
   partOf: import_zod5.z.object({
     $data: import_zod5.z.string()
   }).optional().describe("Parent location"),
-  type: import_zod5.z.enum(["ADMIN_STRUCTURE", "HEALTH_FACILITY", "CRVS_OFFICE"])
+  type: AdministrativeAreas
 }).describe("Administrative area options");
 var AdministrativeArea = BaseField.extend({
   type: import_zod5.z.literal(FieldType.ADMINISTRATIVE_AREA),
@@ -598,7 +612,7 @@ var ActionType = {
   CUSTOM: "CUSTOM",
   REJECT: "REJECT",
   MARKED_AS_DUPLICATE: "MARKED_AS_DUPLICATE",
-  ARCHIVED: "ARCHIVED"
+  ARCHIVE: "ARCHIVE"
 };
 
 // ../commons/src/events/ActionConfig.ts
@@ -638,9 +652,9 @@ var MarkedAsDuplicateConfig = ActionConfigBase.merge(
     duplicates: import_zod7.z.array(import_zod7.z.string()).describe("UUIDs of duplicate records")
   })
 );
-var ArchivedConfig = ActionConfigBase.merge(
+var ArchiveConfig = ActionConfigBase.merge(
   import_zod7.z.object({
-    type: import_zod7.z.literal(ActionType.ARCHIVED),
+    type: import_zod7.z.literal(ActionType.ARCHIVE),
     comment: import_zod7.z.string(),
     isDuplicate: import_zod7.z.boolean()
   })
@@ -687,7 +701,7 @@ var ActionConfig = import_zod7.z.discriminatedUnion("type", [
   ValidateConfig,
   RejectDeclarationConfig,
   MarkedAsDuplicateConfig,
-  ArchivedConfig,
+  ArchiveConfig,
   RegisterConfig,
   DeleteConfig,
   PrintCertificateActionConfig,
@@ -1163,6 +1177,50 @@ function mapFieldTypeToMockValue(field2, i) {
       return null;
   }
 }
+function mapFieldTypeToEmptyValue(field2) {
+  switch (field2.type) {
+    case FieldType.DIVIDER:
+    case FieldType.TEXT:
+    case FieldType.TEXTAREA:
+    case FieldType.BULLET_LIST:
+    case FieldType.PAGE_HEADER:
+    case FieldType.LOCATION:
+    case FieldType.SELECT:
+    case FieldType.COUNTRY:
+    case FieldType.RADIO_GROUP:
+    case FieldType.SIGNATURE:
+    case FieldType.PARAGRAPH:
+    case FieldType.ADMINISTRATIVE_AREA:
+    case FieldType.FACILITY:
+    case FieldType.OFFICE:
+    case FieldType.NUMBER:
+    case FieldType.EMAIL:
+    case FieldType.DATE:
+    case FieldType.CHECKBOX:
+      return null;
+    case FieldType.ADDRESS:
+      return {
+        country: null,
+        province: null,
+        district: null,
+        urbanOrRural: "URBAN",
+        // Default to urban needed for validation
+        town: null,
+        residentialArea: null,
+        street: null,
+        number: null,
+        zipCode: null
+      };
+    case FieldType.FILE:
+      return {
+        filename: "",
+        originalFilename: "",
+        type: ""
+      };
+    case FieldType.FILE_WITH_OPTIONS:
+      return [];
+  }
+}
 var isParagraphFieldType = (field2) => {
   return field2.config.type === FieldType.PARAGRAPH;
 };
@@ -1367,6 +1425,14 @@ function validateFieldInput({
   return rawError.error?.issues.map((issue) => issue.message) ?? [];
 }
 
+// ../commons/src/utils.ts
+function getOrThrow(x, message) {
+  if (x === void 0 || x === null) {
+    throw new Error(message);
+  }
+  return x;
+}
+
 // ../commons/src/events/utils.ts
 function isMetadataField(field2) {
   return field2 in eventMetadataLabelMap;
@@ -1463,6 +1529,12 @@ var findActiveActionFields = (configuration, action) => {
   const allFields = formFields ? formFields.concat(reviewFields ?? []) : reviewFields;
   return allFields;
 };
+var getActiveActionFormPages = (configuration, action) => {
+  return getOrThrow(
+    findActiveActionForm(configuration, action)?.pages,
+    "Form configuration not found for type: " + configuration.id
+  );
+};
 function getActiveActionFields(configuration, action) {
   const fields = findActiveActionFields(configuration, action);
   if (!fields) {
@@ -1592,9 +1664,9 @@ var MarkAsDuplicateAction = ActionBase.merge(
     type: import_zod19.z.literal(ActionType.MARKED_AS_DUPLICATE)
   })
 );
-var ArchivedAction = ActionBase.merge(
+var ArchiveAction = ActionBase.merge(
   import_zod19.z.object({
-    type: import_zod19.z.literal(ActionType.ARCHIVED)
+    type: import_zod19.z.literal(ActionType.ARCHIVE)
   })
 );
 var CreatedAction = ActionBase.merge(
@@ -1639,7 +1711,7 @@ var ActionDocument = import_zod19.z.discriminatedUnion("type", [
   ValidateAction,
   RejectAction,
   MarkAsDuplicateAction,
-  ArchivedAction,
+  ArchiveAction,
   NotifiedAction,
   RegisterAction,
   DeclareAction,
@@ -1668,7 +1740,6 @@ var import_zod20 = require("zod");
 var BaseActionInput = import_zod20.z.object({
   eventId: import_zod20.z.string(),
   transactionId: import_zod20.z.string(),
-  incomplete: import_zod20.z.boolean().optional().default(false).describe("Allows action with partial data to be saved"),
   data: ActionUpdate,
   metadata: ActionUpdate.optional()
 });
@@ -1695,8 +1766,7 @@ var ValidateActionInput = BaseActionInput.merge(
 );
 var NotifyActionInput = BaseActionInput.merge(
   import_zod20.z.object({
-    type: import_zod20.z.literal(ActionType.NOTIFY).default(ActionType.NOTIFY),
-    createdAtLocation: import_zod20.z.string()
+    type: import_zod20.z.literal(ActionType.NOTIFY).default(ActionType.NOTIFY)
   })
 );
 var DeclareActionInput = BaseActionInput.merge(
@@ -1719,9 +1789,9 @@ var MarkedAsDuplicateActionInput = BaseActionInput.merge(
     type: import_zod20.z.literal(ActionType.MARKED_AS_DUPLICATE).default(ActionType.MARKED_AS_DUPLICATE)
   })
 );
-var ArchivedActionInput = BaseActionInput.merge(
+var ArchiveActionInput = BaseActionInput.merge(
   import_zod20.z.object({
-    type: import_zod20.z.literal(ActionType.ARCHIVED).default(ActionType.ARCHIVED)
+    type: import_zod20.z.literal(ActionType.ARCHIVE).default(ActionType.ARCHIVE)
   })
 );
 var AssignActionInput = BaseActionInput.merge(
@@ -1760,7 +1830,7 @@ var ActionInput = import_zod20.z.discriminatedUnion("type", [
   DeclareActionInput,
   RejectDeclarationActionInput,
   MarkedAsDuplicateActionInput,
-  ArchivedActionInput,
+  ArchiveActionInput,
   AssignActionInput,
   UnassignActionInput,
   PrintCertificateActionInput,
@@ -1832,9 +1902,12 @@ function getStatusFromActions(actions) {
     if (action.type === ActionType.REJECT) {
       return EventStatus.REJECTED;
     }
-    if (action.type === ActionType.ARCHIVED) {
+    if (action.type === ActionType.ARCHIVE) {
       return EventStatus.ARCHIVED;
     }
+    if (action.type === ActionType.NOTIFY) {
+      return EventStatus.NOTIFIED;
+    }
     return status;
   }, EventStatus.CREATED);
 }
@@ -1901,8 +1974,8 @@ function deepMerge(currentDocument, actionDocument) {
     }
   );
 }
-function isUndeclaredDraft(event2) {
-  return event2.actions.every(({ type }) => type === ActionType.CREATE);
+function isUndeclaredDraft(status) {
+  return status === EventStatus.CREATED;
 }
 function getCurrentEventState(event2) {
   const creationAction = event2.actions.find(
@@ -3495,7 +3568,7 @@ var eventPayloadGenerator = {
       eventId
     }),
     archive: (eventId, input = {}, isDuplicate) => ({
-      type: ActionType.ARCHIVED,
+      type: ActionType.ARCHIVE,
       transactionId: input.transactionId ?? getUUID(),
       data: input.data ?? {},
       metadata: { isDuplicate: isDuplicate ?? false },
@@ -3581,7 +3654,7 @@ function generateActionDocument({
       return { ...actionBase, assignedTo: getUUID(), type: action };
     case ActionType.VALIDATE:
       return { ...actionBase, type: action };
-    case ActionType.ARCHIVED:
+    case ActionType.ARCHIVE:
       return { ...actionBase, type: action };
     case ActionType.REJECT:
       return { ...actionBase, type: action };
@@ -3678,7 +3751,7 @@ function isFieldValueWithoutTemplates(value) {
   }
   return true;
 }
-function isDefaultValue(value) {
+function isFieldConfigDefaultValue(value) {
   if (!value) return false;
   if (isFieldValue(value)) {
     return true;
@@ -3687,7 +3760,7 @@ function isDefaultValue(value) {
     return true;
   }
   if (typeof value === "object" && Object.values(value).every((v) => typeof v === "object" && v !== null)) {
-    return Object.values(value).every((v) => isDefaultValue(v));
+    return Object.values(value).every((v) => isFieldConfigDefaultValue(v));
   }
   return false;
 }

package/package.json

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