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

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

@@ -1,9 +1,28 @@
 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 DataFieldValue: z.ZodUndefined;
+export type DataFieldValue = z.infer<typeof DataFieldValue>;
+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 +34,24 @@ 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<{
+}>, 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.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -31,6 +64,7 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -41,6 +75,7 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -50,6 +85,7 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
     zipCode?: string | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -58,56 +94,50 @@ export declare const AddressFieldValue: z.ZodDiscriminatedUnion<"urbanOrRural",
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | undefined;
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     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.ZodUndefined, z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
+    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;
+    addressType: "INTERNATIONAL";
+    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;
+    addressType: "INTERNATIONAL";
+    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 +164,102 @@ 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<{
+}>, "many">, z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     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;
+    addressType: "DOMESTIC";
     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;
+    addressType: "DOMESTIC";
     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;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     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;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
-    village?: string | undefined;
+    village?: string | null | undefined;
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
-    village?: string | undefined;
+    village?: string | null | undefined;
+}>, z.ZodUndefined, z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
+    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;
+    addressType: "INTERNATIONAL";
+    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;
+    addressType: "INTERNATIONAL";
+    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 | typeof DataFieldValue | z.ZodString | z.ZodBoolean;
 /**
  * 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 FieldValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldValue | typeof NumberFieldValue | z.ZodString | z.ZodBoolean;
-export type OptionalFieldValueSchema = z.ZodOptional<FieldValueSchema>;
+export type FieldUpdateValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldUpdateValue | typeof NumberFieldValue | typeof DataFieldValue | z.ZodString | z.ZodBoolean;
 //# sourceMappingURL=FieldValue.d.ts.map