@opencrvs/toolkit 1.8.0-rc.fc43738 → 1.8.0-rc.fd6feaa

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

@@ -1,9 +1,26 @@
 import { z } from 'zod';
+import { AddressFieldValue, AddressFieldUpdateValue, FileFieldValue, FileFieldWithOptionValue } from './CompositeFieldValue';
+/**
+ * FieldValues defined in this file are primitive field values.
+ * FieldValues defined in CompositeFieldValue.ts are composed of multiple primitive field values (Address, File etc).
+ *
+ * FieldValue is a union of primitive and composite field values.
+ * FieldValue can never be null.
+ *
+ * FieldUpdateValue accepts null values for primitive field values when they are optional.
+ * API is build assuming partial (PATCH) updates. In order to edit and remove optional value, we need to accept null values.
+ * Omitting a field value in partial updates leaves it untouched.
+ *
+ */
 export declare const TextValue: z.ZodString;
 export declare const RequiredTextValue: z.ZodString;
 export declare const DateValue: z.ZodString;
 export declare const EmailValue: z.ZodString;
-export declare const FileFieldValue: z.ZodObject<{
+export declare const CheckboxFieldValue: z.ZodBoolean;
+export type CheckboxFieldValue = z.infer<typeof CheckboxFieldValue>;
+export declare const NumberFieldValue: z.ZodNumber;
+export type NumberFieldValue = z.infer<typeof NumberFieldValue>;
+export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
     filename: z.ZodString;
     originalFilename: z.ZodString;
     type: z.ZodString;
@@ -15,10 +32,23 @@ export declare const FileFieldValue: z.ZodObject<{
     type: string;
     filename: string;
     originalFilename: string;
-}>;
-export type FileFieldValue = z.infer<typeof FileFieldValue>;
-export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodString;
+}>, z.ZodArray<z.ZodObject<{
+    filename: z.ZodString;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+    option: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    option: string;
+    filename: string;
+    originalFilename: string;
+}, {
+    type: string;
+    option: string;
+    filename: string;
+    originalFilename: string;
+}>, "many">, z.ZodObject<z.objectUtil.extendShape<{
+    country: z.ZodLiteral<string>;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -49,7 +79,7 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
     street?: string | undefined;
     zipCode?: string | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodString;
+    country: z.ZodLiteral<string>;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -67,47 +97,36 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
     province: string;
     urbanOrRural: "RURAL";
     village?: string | undefined;
-}>]>;
-export type AddressFieldValue = z.infer<typeof AddressFieldValue>;
-export declare const FileFieldValueWithOption: z.ZodObject<{
-    filename: z.ZodString;
-    originalFilename: z.ZodString;
-    type: z.ZodString;
-    option: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: string;
-    option: string;
-    filename: string;
-    originalFilename: string;
-}, {
-    type: string;
-    option: string;
-    filename: string;
-    originalFilename: string;
-}>;
-export type FileFieldValueWithOption = z.infer<typeof FileFieldValueWithOption>;
-export declare const FileFieldWithOptionValue: z.ZodArray<z.ZodObject<{
-    filename: z.ZodString;
-    originalFilename: z.ZodString;
-    type: z.ZodString;
-    option: z.ZodString;
+}>, z.ZodObject<{
+    country: z.ZodEffects<z.ZodString, string, string>;
+    state: z.ZodString;
+    district2: z.ZodString;
+    cityOrTown: z.ZodOptional<z.ZodString>;
+    addressLine1: z.ZodOptional<z.ZodString>;
+    addressLine2: z.ZodOptional<z.ZodString>;
+    addressLine3: z.ZodOptional<z.ZodString>;
+    postcodeOrZip: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    type: string;
-    option: string;
-    filename: string;
-    originalFilename: string;
+    country: string;
+    state: string;
+    district2: string;
+    cityOrTown?: string | undefined;
+    addressLine1?: string | undefined;
+    addressLine2?: string | undefined;
+    addressLine3?: string | undefined;
+    postcodeOrZip?: string | undefined;
 }, {
-    type: string;
-    option: string;
-    filename: string;
-    originalFilename: string;
-}>, "many">;
-export type FileFieldWithOptionValue = z.infer<typeof FileFieldWithOptionValue>;
-export declare const CheckboxFieldValue: z.ZodBoolean;
-export type CheckboxFieldValue = z.infer<typeof CheckboxFieldValue>;
-export declare const NumberFieldValue: z.ZodNumber;
-export type NumberFieldValue = z.infer<typeof NumberFieldValue>;
-export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodObject<{
+    country: string;
+    state: string;
+    district2: string;
+    cityOrTown?: string | undefined;
+    addressLine1?: string | undefined;
+    addressLine2?: string | undefined;
+    addressLine3?: string | undefined;
+    postcodeOrZip?: string | undefined;
+}>]>;
+export type FieldValue = z.infer<typeof FieldValue>;
+export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
     filename: z.ZodString;
     originalFilename: z.ZodString;
     type: z.ZodString;
@@ -134,61 +153,93 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodObje
     option: string;
     filename: string;
     originalFilename: string;
-}>, "many">, z.ZodBoolean, z.ZodNumber, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodString;
+}>, "many">, z.ZodObject<z.objectUtil.extendShape<{
+    country: z.ZodLiteral<string>;
     province: z.ZodString;
     district: z.ZodString;
 }, {
     urbanOrRural: z.ZodLiteral<"URBAN">;
-    town: z.ZodOptional<z.ZodString>;
-    residentialArea: z.ZodOptional<z.ZodString>;
-    street: z.ZodOptional<z.ZodString>;
-    number: z.ZodOptional<z.ZodString>;
-    zipCode: z.ZodOptional<z.ZodString>;
+    town: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    residentialArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    street: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    number: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    zipCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
     province: string;
     urbanOrRural: "URBAN";
-    number?: string | undefined;
-    town?: string | undefined;
-    residentialArea?: string | undefined;
-    street?: string | undefined;
-    zipCode?: string | undefined;
+    number?: string | null | undefined;
+    town?: string | null | undefined;
+    residentialArea?: string | null | undefined;
+    street?: string | null | undefined;
+    zipCode?: string | null | undefined;
 }, {
     country: string;
     district: string;
     province: string;
     urbanOrRural: "URBAN";
-    number?: string | undefined;
-    town?: string | undefined;
-    residentialArea?: string | undefined;
-    street?: string | undefined;
-    zipCode?: string | undefined;
+    number?: string | null | undefined;
+    town?: string | null | undefined;
+    residentialArea?: string | null | undefined;
+    street?: string | null | undefined;
+    zipCode?: string | null | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodString;
+    country: z.ZodLiteral<string>;
     province: z.ZodString;
     district: z.ZodString;
 }, {
     urbanOrRural: z.ZodLiteral<"RURAL">;
-    village: z.ZodOptional<z.ZodString>;
+    village: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
     province: string;
     urbanOrRural: "RURAL";
-    village?: string | undefined;
+    village?: string | null | undefined;
 }, {
     country: string;
     district: string;
     province: string;
     urbanOrRural: "RURAL";
-    village?: string | undefined;
+    village?: string | null | undefined;
+}>, z.ZodObject<{
+    country: z.ZodEffects<z.ZodString, string, string>;
+    state: z.ZodString;
+    district2: z.ZodString;
+    cityOrTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine3: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    postcodeOrZip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country: string;
+    state: string;
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
+}, {
+    country: string;
+    state: string;
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
 }>]>;
-export type FieldValue = z.infer<typeof FieldValue>;
+export type FieldUpdateValue = z.infer<typeof FieldUpdateValue>;
 /**
  * NOTE: This is an exception. We need schema as a type in order to generate schema dynamically.
  * */
 export type FieldValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldValue | typeof NumberFieldValue | z.ZodString | z.ZodBoolean;
-export type OptionalFieldValueSchema = z.ZodOptional<FieldValueSchema>;
+/**
+ * NOTE: This is an exception. We need schema as a type in order to generate schema dynamically.
+ *
+ * FieldValueInputSchema uses Input types which have set optional values as nullish
+ * */
+export type FieldUpdateValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldUpdateValue | typeof NumberFieldValue | z.ZodString | z.ZodBoolean;
 //# sourceMappingURL=FieldValue.d.ts.map

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

@@ -0,0 +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';
+/**
+ * Available system variables for configuration.
+ */
+export interface MetaFields {
+    $user: {
+        province: string;
+        district: 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 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

@@ -63,7 +63,6 @@ export declare const defineConfig: (config: EventConfigInput) => {
         draft?: boolean | undefined;
     } | {
         type: "REJECT";
-        comment: string;
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -89,11 +88,9 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
     } | {
         type: "MARKED_AS_DUPLICATE";
-        comment: string;
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -119,11 +116,9 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        duplicates: string[];
         draft?: boolean | undefined;
     } | {
-        type: "ARCHIVED";
-        comment: string;
+        type: "ARCHIVE";
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -149,7 +144,6 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
     } | {
         type: "REGISTER";

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

@@ -15,6 +15,7 @@ export * from './ActionDocument';
 export * from './EventIndex';
 export * from './TranslationConfig';
 export * from './FieldValue';
+export * from './CompositeFieldValue';
 export * from './state';
 export * from './utils';
 export * from './defineConfig';
@@ -27,6 +28,7 @@ export * from './FieldTypeMapping';
 export * from './Conditional';
 export * from './AdvancedSearchConfig';
 export * from './test.utils';
+export * from './TemplateConfig';
 export * from '../conditionals/conditionals';
 export * from '../conditionals/validate';
 //# sourceMappingURL=index.d.ts.map