@dalmore/api-contracts 0.0.0-dev.9d42e16 → 0.0.0-dev.9f40653

package/common/types/subdoc-preview.types.d.ts

@@ -0,0 +1,379 @@
+import { z } from 'zod';
+import { SignatureStatus } from './common.types';
+export declare const ISubDocPreview: z.ZodObject<{
+    id: z.ZodString;
+    __entity: z.ZodOptional<z.ZodString>;
+    createdAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+    updatedAt: z.ZodUnion<[z.ZodString, z.ZodDate]>;
+    deletedAt: z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
+} & {
+    templateId: z.ZodString;
+    signers: z.ZodNullable<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+        signerType: z.ZodLiteral<"Signer">;
+        signerRole: z.ZodString;
+    } & {
+        roleIndex: z.ZodNumber;
+        signerName: z.ZodString;
+        signerEmail: z.ZodOptional<z.ZodString>;
+        signerOrder: z.ZodOptional<z.ZodNumber>;
+        existingFormFields: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            value: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodNull]>>;
+            name: z.ZodOptional<z.ZodString>;
+            fieldType: z.ZodOptional<z.ZodString>;
+            pageNumber: z.ZodOptional<z.ZodNumber>;
+            bounds: z.ZodOptional<z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            }, {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            }>>;
+            isRequired: z.ZodOptional<z.ZodBoolean>;
+            editableDateFieldSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            validationType: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }, {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        signerName: string;
+        signerRole: string;
+        signerType: "Signer";
+        roleIndex: number;
+        existingFormFields: {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }[];
+        signerEmail?: string | undefined;
+        signerOrder?: number | undefined;
+    }, {
+        signerName: string;
+        signerRole: string;
+        signerType: "Signer";
+        roleIndex: number;
+        existingFormFields: {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }[];
+        signerEmail?: string | undefined;
+        signerOrder?: number | undefined;
+    }>, z.ZodObject<{
+        signerType: z.ZodLiteral<"Signer">;
+        signerRole: z.ZodString;
+    } & {
+        name: z.ZodString;
+        emailAddress: z.ZodOptional<z.ZodString>;
+        formFields: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            value: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodNull]>>;
+            name: z.ZodOptional<z.ZodString>;
+            fieldType: z.ZodOptional<z.ZodString>;
+            pageNumber: z.ZodOptional<z.ZodNumber>;
+            bounds: z.ZodOptional<z.ZodObject<{
+                x: z.ZodNumber;
+                y: z.ZodNumber;
+                width: z.ZodNumber;
+                height: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            }, {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            }>>;
+            isRequired: z.ZodOptional<z.ZodBoolean>;
+            editableDateFieldSettings: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+            validationType: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }, {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        signerRole: string;
+        formFields: {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }[];
+        signerType: "Signer";
+        emailAddress?: string | undefined;
+    }, {
+        name: string;
+        signerRole: string;
+        formFields: {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }[];
+        signerType: "Signer";
+        emailAddress?: string | undefined;
+    }>]>, "many">>;
+    documentId: z.ZodNullable<z.ZodString>;
+    signatureUrl: z.ZodNullable<z.ZodString>;
+    errors: z.ZodNullable<z.ZodString>;
+    status: z.ZodNativeEnum<typeof SignatureStatus>;
+    jointStatus: z.ZodNativeEnum<typeof SignatureStatus>;
+}, "strip", z.ZodTypeAny, {
+    status: SignatureStatus;
+    id: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date | null;
+    errors: string | null;
+    documentId: string | null;
+    signatureUrl: string | null;
+    templateId: string;
+    signers: ({
+        signerName: string;
+        signerRole: string;
+        signerType: "Signer";
+        roleIndex: number;
+        existingFormFields: {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }[];
+        signerEmail?: string | undefined;
+        signerOrder?: number | undefined;
+    } | {
+        name: string;
+        signerRole: string;
+        formFields: {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }[];
+        signerType: "Signer";
+        emailAddress?: string | undefined;
+    })[] | null;
+    jointStatus: SignatureStatus;
+    __entity?: string | undefined;
+}, {
+    status: SignatureStatus;
+    id: string;
+    createdAt: string | Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date | null;
+    errors: string | null;
+    documentId: string | null;
+    signatureUrl: string | null;
+    templateId: string;
+    signers: ({
+        signerName: string;
+        signerRole: string;
+        signerType: "Signer";
+        roleIndex: number;
+        existingFormFields: {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }[];
+        signerEmail?: string | undefined;
+        signerOrder?: number | undefined;
+    } | {
+        name: string;
+        signerRole: string;
+        formFields: {
+            id: string;
+            value?: string | number | null | undefined;
+            name?: string | undefined;
+            fieldType?: string | undefined;
+            isRequired?: boolean | undefined;
+            pageNumber?: number | undefined;
+            bounds?: {
+                height: number;
+                x: number;
+                y: number;
+                width: number;
+            } | undefined;
+            editableDateFieldSettings?: Record<string, string> | undefined;
+            validationType?: string | undefined;
+        }[];
+        signerType: "Signer";
+        emailAddress?: string | undefined;
+    })[] | null;
+    jointStatus: SignatureStatus;
+    __entity?: string | undefined;
+}>;
+export type ISubDocPreview = z.infer<typeof ISubDocPreview>;
+export declare const CreateSubDocPreview: z.ZodObject<{
+    templateId: z.ZodString;
+    subDocPreviewData: z.ZodRecord<z.ZodString, z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    templateId: string;
+    subDocPreviewData: Record<string, string>;
+}, {
+    templateId: string;
+    subDocPreviewData: Record<string, string>;
+}>;
+export type CreateSubDocPreview = z.infer<typeof CreateSubDocPreview>;
+export declare const CreateSubDocPreviewResponse: z.ZodObject<{
+    documentId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    documentId: string;
+}, {
+    documentId: string;
+}>;
+export type CreateSubDocPreviewResponse = z.infer<typeof CreateSubDocPreviewResponse>;
+export declare const SubDocPreviewFormFields: z.ZodArray<z.ZodObject<{
+    id: z.ZodString;
+    type: z.ZodString;
+    options: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    id: string;
+    options?: string[] | undefined;
+}, {
+    type: string;
+    id: string;
+    options?: string[] | undefined;
+}>, "many">;
+export type SubDocPreviewFormFields = z.infer<typeof SubDocPreviewFormFields>;

package/common/types/subdoc-preview.types.js

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+import { IBaseEntity } from './entity.types.js';
+import { SignatureStatus } from './common.types.js';
+import { SignerDataSchema } from './signer.types.js';
+export const ISubDocPreview = IBaseEntity.extend({
+    templateId: z.string().min(1).max(36),
+    signers: z.array(SignerDataSchema).nullable(),
+    documentId: z.string().min(1).max(36).nullable(),
+    signatureUrl: z.string().min(1).max(255).nullable(),
+    errors: z.string().nullable(),
+    status: z.nativeEnum(SignatureStatus),
+    jointStatus: z.nativeEnum(SignatureStatus),
+});
+export const CreateSubDocPreview = z.object({
+    templateId: z.string().min(1).max(36),
+    subDocPreviewData: z.record(z.string()),
+});
+export const CreateSubDocPreviewResponse = z.object({ documentId: z.string() });
+export const SubDocPreviewFormFields = z.array(z.object({
+    id: z.string().min(1).max(255),
+    type: z.string().min(1).max(255),
+    options: z.array(z.string()).optional(),
+}));
+//# sourceMappingURL=subdoc-preview.types.js.map

package/common/types/subdoc-preview.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subdoc-preview.types.js","sourceRoot":"","sources":["subdoc-preview.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC,MAAM,CAAC;IAC/C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;IAC7C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAChD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IACnD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC;IACrC,WAAW,EAAE,CAAC,CAAC,UAAU,CAAC,eAAe,CAAC;CAC3C,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;CACxC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAKhF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC5C,CAAC,CAAC,MAAM,CAAC;IACP,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAChC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CACH,CAAC"}