@nira-opencrvs/toolkit 1.9.11-rc.39d8d68

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

@@ -0,0 +1,512 @@
+import { z } from 'zod';
+import { AddressFieldValue, AddressFieldUpdateValue, FileFieldValue, FileFieldWithOptionValue, NameFieldValue, NameFieldUpdateValue, NumberWithUnitFieldValue, NumberWithUnitFieldUpdateValue, HttpFieldUpdateValue, QueryParamReaderFieldUpdateValue, QrReaderFieldValue, IdReaderFieldValue } from './CompositeFieldValue';
+import { PlainDate, plainDateToLocalDate } from './PlainDate';
+export { PlainDate, plainDateToLocalDate };
+/**
+ * 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 NonEmptyTextValue: z.ZodString;
+export declare const AgeValue: z.ZodObject<{
+    age: z.ZodNumber;
+    asOfDateRef: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    age: number;
+    asOfDateRef: string;
+}, {
+    age: number;
+    asOfDateRef: string;
+}>;
+export type AgeValue = z.infer<typeof AgeValue>;
+export declare const AgeUpdateValue: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+    age: z.ZodNumber;
+    asOfDateRef: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    age: number;
+    asOfDateRef: string;
+}, {
+    age: number;
+    asOfDateRef: string;
+}>>>;
+export declare const TimeValue: z.ZodString;
+export type TimeValue = z.infer<typeof TimeValue>;
+export declare const DatetimeValue: z.ZodString;
+export declare const SelectDateRangeValue: z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>;
+export declare const DateRangeFieldValue: z.ZodUnion<[z.ZodObject<{
+    start: z.ZodBranded<z.ZodString, "PlainDate">;
+    end: z.ZodBranded<z.ZodString, "PlainDate">;
+}, "strip", z.ZodTypeAny, {
+    start: string & z.BRAND<"PlainDate">;
+    end: string & z.BRAND<"PlainDate">;
+}, {
+    start: string;
+    end: string;
+}>, z.ZodBranded<z.ZodString, "PlainDate">]>;
+export type DateRangeFieldValue = z.infer<typeof DateRangeFieldValue>;
+export type SelectDateRangeValue = z.infer<typeof SelectDateRangeValue>;
+export declare const EmailValue: z.ZodString;
+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 SignatureFieldValue: z.ZodString;
+export type SignatureFieldValue = z.infer<typeof SignatureFieldValue>;
+export declare const ButtonFieldValue: z.ZodNumber;
+export type ButtonFieldValue = z.infer<typeof ButtonFieldValue>;
+export declare const VerificationStatusValue: z.ZodEnum<["verified", "authenticated", "failed", "pending"]>;
+export type VerificationStatusValue = z.infer<typeof VerificationStatusValue>;
+declare const FieldValuesWithoutDataField: z.ZodUnion<[z.ZodDiscriminatedUnion<"addressType", [z.ZodObject<z.objectUtil.extendShape<{
+    country: z.ZodString;
+    streetLevelDetails: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, {
+    addressType: z.ZodLiteral<"DOMESTIC">;
+    administrativeArea: z.ZodString;
+}>, "strip", z.ZodTypeAny, {
+    country: string;
+    addressType: "DOMESTIC";
+    administrativeArea: string;
+    streetLevelDetails?: Record<string, string> | undefined;
+}, {
+    country: string;
+    addressType: "DOMESTIC";
+    administrativeArea: string;
+    streetLevelDetails?: Record<string, string> | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    country: z.ZodString;
+    streetLevelDetails: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, {
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
+}>, "strip", z.ZodTypeAny, {
+    country: string;
+    addressType: "INTERNATIONAL";
+    streetLevelDetails?: Record<string, string> | undefined;
+}, {
+    country: string;
+    addressType: "INTERNATIONAL";
+    streetLevelDetails?: Record<string, string> | undefined;
+}>]>, z.ZodString, z.ZodBranded<z.ZodString, "PlainDate">, z.ZodObject<{
+    age: z.ZodNumber;
+    asOfDateRef: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    age: number;
+    asOfDateRef: string;
+}, {
+    age: number;
+    asOfDateRef: string;
+}>, z.ZodString, z.ZodUnion<[z.ZodObject<{
+    start: z.ZodBranded<z.ZodString, "PlainDate">;
+    end: z.ZodBranded<z.ZodString, "PlainDate">;
+}, "strip", z.ZodTypeAny, {
+    start: string & z.BRAND<"PlainDate">;
+    end: string & z.BRAND<"PlainDate">;
+}, {
+    start: string;
+    end: string;
+}>, z.ZodBranded<z.ZodString, "PlainDate">]>, z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    path: string;
+    originalFilename: string;
+}, {
+    type: string;
+    path: string;
+    originalFilename: string;
+}>, z.ZodArray<z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+    option: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    option: string;
+    path: string;
+    originalFilename: string;
+}, {
+    type: string;
+    option: string;
+    path: string;
+    originalFilename: string;
+}>, "many">, z.ZodObject<{
+    firstname: z.ZodString;
+    surname: z.ZodString;
+    middlename: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    firstname: string;
+    surname: string;
+    middlename?: string | undefined;
+}, {
+    firstname: string;
+    surname: string;
+    middlename?: string | undefined;
+}>, z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
+    firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    surname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
+    middlename?: string | null | undefined;
+}, {
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
+    middlename?: string | null | undefined;
+}>, z.ZodNull]>, z.ZodUndefined]>, z.ZodNumber, z.ZodObject<{
+    loading: z.ZodBoolean;
+    error: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        statusCode: z.ZodNumber;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        statusCode: number;
+    }, {
+        message: string;
+        statusCode: number;
+    }>>>;
+    data: z.ZodAny;
+}, "strip", z.ZodTypeAny, {
+    loading: boolean;
+    data?: any;
+    error?: {
+        message: string;
+        statusCode: number;
+    } | null | undefined;
+}, {
+    loading: boolean;
+    data?: any;
+    error?: {
+        message: string;
+        statusCode: number;
+    } | null | undefined;
+}>, z.ZodEnum<["verified", "authenticated", "failed", "pending"]>, z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    data: z.ZodRecord<z.ZodString, z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    data: Record<string, string>;
+}, {
+    data: Record<string, string>;
+}>>>, z.ZodObject<{
+    data: z.ZodAny;
+}, "strip", z.ZodTypeAny, {
+    data?: any;
+}, {
+    data?: any;
+}>, z.ZodObject<{
+    data: z.ZodAny;
+}, "strip", z.ZodTypeAny, {
+    data?: any;
+}, {
+    data?: any;
+}>, z.ZodObject<{
+    numericValue: z.ZodNumber;
+    unit: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    numericValue: number;
+    unit: string;
+}, {
+    numericValue: number;
+    unit: string;
+}>, z.ZodObject<{
+    numericValue: z.ZodOptional<z.ZodNumber>;
+    unit: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    numericValue?: number | undefined;
+    unit?: string | undefined;
+}, {
+    numericValue?: number | undefined;
+    unit?: string | undefined;
+}>]>;
+type FieldValuesWithoutDataField = z.infer<typeof FieldValuesWithoutDataField>;
+export declare const DataFieldValue: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    data: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodDiscriminatedUnion<"addressType", [z.ZodObject<z.objectUtil.extendShape<{
+        country: z.ZodString;
+        streetLevelDetails: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, {
+        addressType: z.ZodLiteral<"DOMESTIC">;
+        administrativeArea: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        country: string;
+        addressType: "DOMESTIC";
+        administrativeArea: string;
+        streetLevelDetails?: Record<string, string> | undefined;
+    }, {
+        country: string;
+        addressType: "DOMESTIC";
+        administrativeArea: string;
+        streetLevelDetails?: Record<string, string> | undefined;
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        country: z.ZodString;
+        streetLevelDetails: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, {
+        addressType: z.ZodLiteral<"INTERNATIONAL">;
+    }>, "strip", z.ZodTypeAny, {
+        country: string;
+        addressType: "INTERNATIONAL";
+        streetLevelDetails?: Record<string, string> | undefined;
+    }, {
+        country: string;
+        addressType: "INTERNATIONAL";
+        streetLevelDetails?: Record<string, string> | undefined;
+    }>]>, z.ZodString, z.ZodBranded<z.ZodString, "PlainDate">, z.ZodObject<{
+        age: z.ZodNumber;
+        asOfDateRef: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        age: number;
+        asOfDateRef: string;
+    }, {
+        age: number;
+        asOfDateRef: string;
+    }>, z.ZodString, z.ZodUnion<[z.ZodObject<{
+        start: z.ZodBranded<z.ZodString, "PlainDate">;
+        end: z.ZodBranded<z.ZodString, "PlainDate">;
+    }, "strip", z.ZodTypeAny, {
+        start: string & z.BRAND<"PlainDate">;
+        end: string & z.BRAND<"PlainDate">;
+    }, {
+        start: string;
+        end: string;
+    }>, z.ZodBranded<z.ZodString, "PlainDate">]>, z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
+        path: z.ZodEffects<z.ZodString, string, string>;
+        originalFilename: z.ZodString;
+        type: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        path: string;
+        originalFilename: string;
+    }, {
+        type: string;
+        path: string;
+        originalFilename: string;
+    }>, z.ZodArray<z.ZodObject<{
+        path: z.ZodEffects<z.ZodString, string, string>;
+        originalFilename: z.ZodString;
+        type: z.ZodString;
+        option: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        option: string;
+        path: string;
+        originalFilename: string;
+    }, {
+        type: string;
+        option: string;
+        path: string;
+        originalFilename: string;
+    }>, "many">, z.ZodObject<{
+        firstname: z.ZodString;
+        surname: z.ZodString;
+        middlename: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    }, {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    }>, z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
+        firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        surname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        firstname?: string | null | undefined;
+        surname?: string | null | undefined;
+        middlename?: string | null | undefined;
+    }, {
+        firstname?: string | null | undefined;
+        surname?: string | null | undefined;
+        middlename?: string | null | undefined;
+    }>, z.ZodNull]>, z.ZodUndefined]>, z.ZodNumber, z.ZodObject<{
+        loading: z.ZodBoolean;
+        error: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            statusCode: z.ZodNumber;
+            message: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            message: string;
+            statusCode: number;
+        }, {
+            message: string;
+            statusCode: number;
+        }>>>;
+        data: z.ZodAny;
+    }, "strip", z.ZodTypeAny, {
+        loading: boolean;
+        data?: any;
+        error?: {
+            message: string;
+            statusCode: number;
+        } | null | undefined;
+    }, {
+        loading: boolean;
+        data?: any;
+        error?: {
+            message: string;
+            statusCode: number;
+        } | null | undefined;
+    }>, z.ZodEnum<["verified", "authenticated", "failed", "pending"]>, z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        data: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        data: Record<string, string>;
+    }, {
+        data: Record<string, string>;
+    }>>>, z.ZodObject<{
+        data: z.ZodAny;
+    }, "strip", z.ZodTypeAny, {
+        data?: any;
+    }, {
+        data?: any;
+    }>, z.ZodObject<{
+        data: z.ZodAny;
+    }, "strip", z.ZodTypeAny, {
+        data?: any;
+    }, {
+        data?: any;
+    }>, z.ZodObject<{
+        numericValue: z.ZodNumber;
+        unit: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        numericValue: number;
+        unit: string;
+    }, {
+        numericValue: number;
+        unit: string;
+    }>, z.ZodObject<{
+        numericValue: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
+    }, {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    data: Record<string, string | number | boolean | {
+        type: string;
+        path: string;
+        originalFilename: string;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | {
+        firstname?: string | null | undefined;
+        surname?: string | null | undefined;
+        middlename?: string | null | undefined;
+    } | {
+        country: string;
+        addressType: "DOMESTIC";
+        administrativeArea: string;
+        streetLevelDetails?: Record<string, string> | undefined;
+    } | {
+        country: string;
+        addressType: "INTERNATIONAL";
+        streetLevelDetails?: Record<string, string> | undefined;
+    } | {
+        type: string;
+        option: string;
+        path: string;
+        originalFilename: string;
+    }[] | {
+        loading: boolean;
+        data?: any;
+        error?: {
+            message: string;
+            statusCode: number;
+        } | null | undefined;
+    } | {
+        data: Record<string, string>;
+    } | {
+        data?: any;
+    } | {
+        numericValue: number;
+        unit: string;
+    } | {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
+    } | (string & z.BRAND<"PlainDate">) | {
+        age: number;
+        asOfDateRef: string;
+    } | {
+        start: string & z.BRAND<"PlainDate">;
+        end: string & z.BRAND<"PlainDate">;
+    } | null | undefined>;
+}, {
+    data: Record<string, string | number | boolean | {
+        type: string;
+        path: string;
+        originalFilename: string;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | {
+        firstname?: string | null | undefined;
+        surname?: string | null | undefined;
+        middlename?: string | null | undefined;
+    } | {
+        country: string;
+        addressType: "DOMESTIC";
+        administrativeArea: string;
+        streetLevelDetails?: Record<string, string> | undefined;
+    } | {
+        country: string;
+        addressType: "INTERNATIONAL";
+        streetLevelDetails?: Record<string, string> | undefined;
+    } | {
+        type: string;
+        option: string;
+        path: string;
+        originalFilename: string;
+    }[] | {
+        loading: boolean;
+        data?: any;
+        error?: {
+            message: string;
+            statusCode: number;
+        } | null | undefined;
+    } | {
+        data: Record<string, string>;
+    } | {
+        data?: any;
+    } | {
+        numericValue: number;
+        unit: string;
+    } | {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
+    } | {
+        age: number;
+        asOfDateRef: string;
+    } | {
+        start: string;
+        end: string;
+    } | null | undefined>;
+}>>>;
+export type DataFieldValue = z.infer<typeof DataFieldValue>;
+export type FieldValue = FieldValuesWithoutDataField | DataFieldValue;
+export declare const FieldValue: z.ZodType<FieldValue, z.ZodTypeDef, unknown>;
+export declare function safeUnion<T extends [z.ZodTypeAny, ...z.ZodTypeAny[]]>(schemas: T): z.ZodType<z.TypeOf<T[number]>, z.ZodTypeDef, z.TypeOf<T[number]>>;
+export type FieldUpdateValue = z.infer<typeof TextValue> | PlainDate | z.infer<typeof TimeValue> | z.infer<typeof AgeUpdateValue> | z.infer<typeof AddressFieldUpdateValue> | z.infer<typeof DateRangeFieldValue> | z.infer<typeof SelectDateRangeValue> | z.infer<typeof CheckboxFieldValue> | z.infer<typeof NumberFieldValue> | z.infer<typeof NumberWithUnitFieldUpdateValue> | z.infer<typeof FileFieldValue> | z.infer<typeof FileFieldWithOptionValue> | z.infer<typeof DataFieldValue> | z.infer<typeof NameFieldUpdateValue> | z.infer<typeof HttpFieldUpdateValue> | z.infer<typeof QueryParamReaderFieldUpdateValue>;
+export declare const FieldUpdateValue: z.ZodType<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 NumberWithUnitFieldValue | typeof DataFieldValue | typeof NameFieldValue | 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 FieldUpdateValueSchema = typeof PlainDate | typeof DateRangeFieldValue | typeof AgeValue | typeof SelectDateRangeValue | typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldUpdateValue | typeof NumberFieldValue | typeof NumberWithUnitFieldValue | typeof NumberWithUnitFieldUpdateValue | typeof DataFieldValue | typeof NameFieldValue | typeof NameFieldUpdateValue | typeof HttpFieldUpdateValue | typeof QueryParamReaderFieldUpdateValue | typeof ButtonFieldValue | typeof QrReaderFieldValue | typeof IdReaderFieldValue | z.ZodString | z.ZodBoolean;
+//# sourceMappingURL=FieldValue.d.ts.map

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

@@ -0,0 +1,4 @@
+import { FullDocumentPath } from '../documents';
+import { EventDocument } from './EventDocument';
+export declare function getFilePathsFromEvent(event: EventDocument): FullDocumentPath[];
+//# sourceMappingURL=FileUtils.d.ts.map