@betterinternship/core 1.4.0 → 1.4.3

package/dist/lib/forms/form-metadata.js

@@ -1,346 +1,347 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DUMMY_FORM_METADATA = exports.FormMetadata = exports.FORM_SOURCE = exports.ALIGN_V = exports.ALIGN_H = exports.BLOCK_TYPES = exports.FIELD_TYPES = exports.SOURCES = exports.SCHEMA_VERSION = void 0;
-const zod_1 = require("zod");
-const fields_client_1 = require("./fields.client");
-exports.SCHEMA_VERSION = 1;
-exports.SOURCES = ['auto', 'prefill', 'derived', 'manual'];
-exports.FIELD_TYPES = ['text', 'signature'];
-exports.BLOCK_TYPES = [
-    'header',
-    'paragraph',
-    'form_field',
-    'form_phantom_field',
-    'divider',
-    'image',
-];
-exports.ALIGN_H = ['left', 'center', 'right'];
-exports.ALIGN_V = ['top', 'middle', 'bottom'];
-exports.FORM_SOURCE = ['auto', 'prefill', 'derived', 'manual'];
-class FormMetadata {
-    formMetadata;
-    blocks;
-    constructor(formMetadata) {
-        this.formMetadata = formMetadata;
-        this.blocks = formMetadata.schema.blocks;
-    }
-    getAllBlocks() {
-        return this.blocks;
-    }
-    getBlocksByType(blockType) {
-        return this.blocks.filter((block) => block.block_type === blockType);
-    }
-    getBlocksByPartyId(partyId) {
-        return this.blocks.filter((block) => block.party_id === partyId);
-    }
-    getFields() {
-        return this.blocks
-            .filter((block) => block.block_type === 'form_field')
-            .map((block) => block.content);
-    }
-    getField(index) {
-        const fields = this.getFields();
-        return fields[index];
-    }
-    getPhantomFields() {
-        return this.blocks
-            .filter((block) => block.block_type === 'form_phantom_field')
-            .map((block) => block.content);
-    }
-    encodeAsJSON() {
-        return JSON.stringify(this.formMetadata);
-    }
-    static decodeFromJSON(json) {
-        return JSON.parse(json);
-    }
-    getLabel() {
-        return this.formMetadata.label;
-    }
-    getFieldForClient(index, sourceDomains, derivationBase) {
-        const field = this.getField(index);
-        if (!field)
-            throw new Error('Field does not exist');
-        const finalParams = {
-            ...derivationBase,
-            ...sourceDomains,
-        };
-        const validator = this.parseValidator(field.field, finalParams);
-        const prefiller = this.parsePrefiller(field.field, finalParams);
-        const section = field.field.split('.')[0];
-        let options = undefined;
-        if (validator?.type === 'enum')
-            options = validator.options;
-        if (validator?.type === 'array') {
-            const element = validator.element;
-            if (element?.options)
-                options = element.options;
-        }
-        const type = field.type === 'signature'
-            ? 'signature'
-            : validator
-                ? (0, fields_client_1.getSchemaClientType)(validator)
-                : 'text';
-        const coerce = (value) => {
-            switch (type) {
-                case 'number': {
-                    const n = parseInt(value);
-                    return isNaN(n) ? 0 : n;
-                }
-                case 'date': {
-                    const n = parseInt(value);
-                    return isNaN(n) ? new Date() : new Date(n);
-                }
-                case 'checkbox': {
-                    return !!value?.trim();
-                }
-                case 'multiselect': {
-                    return value?.split('\n');
-                }
-                default:
-                    return value;
-            }
-        };
-        return {
-            field: field.field,
-            shared: field.shared,
-            label: field.label,
-            source: field.source,
-            tooltip_label: field.tooltip_label,
-            coerce,
-            type,
-            section,
-            validator,
-            prefiller,
-            options,
-        };
-    }
-    getFieldsForClientService(sourceDomains, derivationBase) {
-        const fields = this.getFields();
-        return fields
-            .map((field, i) => this.getFieldForClient(i, sourceDomains, derivationBase))
-            .filter((field) => field !== null);
-    }
-    getFieldsForSigningService() {
-        const fields = this.getFields();
-        return fields
-            .filter((field) => field.type !== 'image')
-            .map((field) => ({
-            field: field.field,
-            type: field.type,
-            x: field.x,
-            y: field.y,
-            w: field.w,
-            h: field.h,
-            align_h: (field.align_h ?? 'left'),
-            align_v: (field.align_v ?? 'top'),
-            page: field.page,
-        }))
-            .filter((field) => field !== null);
-    }
-    inferParams() {
-        const inferenceRegex = /params\[\s*(['"])(.*?)\1\s*\]/g;
-        const params = [];
-        let match;
-        for (const field of this.getFields()) {
-            const validatorStr = typeof field.validator === 'string' ? field.validator : '';
-            while ((match = inferenceRegex.exec(validatorStr)) !== null)
-                if (!params.includes(match[2]))
-                    params.push(match[2]);
-        }
-        for (const field of this.getPhantomFields()) {
-            const validatorStr = typeof field.validator === 'string' ? field.validator : '';
-            while ((match = inferenceRegex.exec(validatorStr)) !== null)
-                if (!params.includes(match[2]))
-                    params.push(match[2]);
-        }
-        return params;
-    }
-    parseValidator(fieldname, params = {}) {
-        const field = this.getFields().find((f) => f.field === fieldname);
-        if (!field)
-            return null;
-        const d = new Date();
-        const defaults = {
-            currentDate: d,
-            currentDateTimestamp: d.getTime(),
-        };
-        const validatorStr = typeof field.validator === 'string' ? field.validator : '';
-        const validator = this.populateParams(validatorStr, params);
-        const ret = `return ${validator}`;
-        const evaluator = new Function('z', 'params', ret);
-        return evaluator(zod_1.default, { ...params, ...defaults });
-    }
-    parsePrefiller(fieldname, _params = {}) {
-        const field = this.getFields().find((f) => f.field === fieldname);
-        if (!field || !field.default_value)
-            return null;
-        try {
-            const fn = eval(field.default_value);
-            return typeof fn === 'function' ? fn : null;
-        }
-        catch (e) {
-            console.error(`Failed to parse prefiller for field ${fieldname}`, e);
-            return null;
-        }
-    }
-    enumerateParams(s) {
-        const detectedParams = s.match(/#\{[^}]*\}/g) ?? [];
-        const params = detectedParams.map((dp) => {
-            const [fieldName, propertyTree] = dp
-                .replaceAll('#{', '')
-                .replaceAll('}', '')
-                .replaceAll(')', '')
-                .split('(');
-            const properties = propertyTree?.split('.') ?? [];
-            return [fieldName, ...properties];
-        });
-        return params?.reduce((acc, cur, i) => ((acc[detectedParams[i]] = cur), acc), {});
-    }
-    populateParams(s, params) {
-        const paramsReflection = this.enumerateParams(s);
-        const paramsValues = {};
-        for (const match in paramsReflection) {
-            const path = paramsReflection[match];
-            paramsValues[match] =
-                path.reduce((acc, cur) => acc?.[cur], params) ?? '';
-        }
-        let out = s;
-        for (const match in paramsValues) {
-            const replacement = JSON.stringify(paramsValues[match]);
-            out = out.replaceAll(match, replacement);
-        }
-        return out;
-    }
-    getSignatories() {
-        return this.formMetadata.subscribers;
-    }
-    getSubscribers() {
-        return this.formMetadata.subscribers;
-    }
-    getRequiredParties() {
-        return this.formMetadata.parties;
-    }
-}
-exports.FormMetadata = FormMetadata;
-exports.DUMMY_FORM_METADATA = {
-    name: 'test-form',
-    label: 'Test Form',
-    schema_version: exports.SCHEMA_VERSION,
-    schema: {
-        blocks: [
-            {
-                block_type: 'header',
-                order: 0,
-                content: 'Student Information Form',
-                party_id: 'party-1',
-            },
-            {
-                block_type: 'paragraph',
-                order: 1,
-                content: 'Please fill in your personal details below.',
-                party_id: 'party-1',
-            },
-            {
-                block_type: 'form_field',
-                order: 2,
-                content: {
-                    field: 'student.full_name',
-                    type: 'text',
-                    x: 100,
-                    y: 100,
-                    w: 200,
-                    h: 20,
-                    page: 1,
-                    align_h: 'left',
-                    align_v: 'top',
-                    label: 'Full Name',
-                    tooltip_label: 'Enter your full name',
-                    shared: true,
-                    source: 'manual',
-                    default_value: '({ user }) => `${user?.first_name ?? ""} ${user?.last_name ?? ""}`',
-                    validator: 'z.string().min(1, "Name is required")',
-                },
-                party_id: 'party-1',
-            },
-            {
-                block_type: 'form_field',
-                order: 3,
-                content: {
-                    field: 'student.email',
-                    type: 'text',
-                    x: 100,
-                    y: 130,
-                    w: 200,
-                    h: 20,
-                    page: 1,
-                    align_h: 'left',
-                    align_v: 'top',
-                    label: 'Email',
-                    tooltip_label: 'Enter your email address',
-                    shared: true,
-                    source: 'prefill',
-                    default_value: '({ user }) => user?.email ?? ""',
-                    validator: 'z.string().email("Invalid email")',
-                },
-                party_id: 'party-1',
-            },
-            {
-                block_type: 'form_field',
-                order: 4,
-                content: {
-                    field: 'student.signature',
-                    type: 'signature',
-                    x: 100,
-                    y: 160,
-                    w: 150,
-                    h: 50,
-                    page: 1,
-                    align_h: 'left',
-                    align_v: 'top',
-                    label: 'Signature',
-                    tooltip_label: 'Please sign here',
-                    shared: true,
-                    source: 'manual',
-                    validator: 'z.string().min(1, "Signature is required")',
-                },
-                party_id: 'party-1',
-            },
-            {
-                block_type: 'form_phantom_field',
-                order: 5,
-                content: {
-                    field: 'student.phone',
-                    type: 'text',
-                    label: 'Phone Number',
-                    tooltip_label: 'Optional contact number',
-                    shared: true,
-                    source: 'manual',
-                    validator: 'z.string().optional()',
-                },
-                party_id: 'party-1',
-            },
-        ],
-    },
-    parties: [
-        {
-            _id: 'party-1',
-            order: 1,
-            signatory_account: {
-                account_id: 'user-1',
-                name: 'John Doe',
-                email: 'john@example.com',
-                title: 'Student',
-            },
-            signed: false,
-        },
-    ],
-    subscribers: [
-        {
-            account_id: 'user-2',
-            name: 'Jane Smith',
-            email: 'jane@example.com',
-            title: 'Administrator',
-        },
-    ],
-};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DUMMY_FORM_METADATA = exports.FormMetadata = exports.SOURCES = exports.ALIGN_V = exports.ALIGN_H = exports.BLOCK_TYPES = exports.FIELD_TYPES = exports.SCHEMA_VERSION = void 0;
+const zod_1 = require("zod");
+const fields_client_1 = require("./fields.client");
+exports.SCHEMA_VERSION = 1;
+exports.FIELD_TYPES = ['text', 'signature'];
+exports.BLOCK_TYPES = [
+    'header',
+    'paragraph',
+    'form_field',
+    'form_phantom_field',
+    'divider',
+    'image',
+];
+exports.ALIGN_H = ['left', 'center', 'right'];
+exports.ALIGN_V = ['top', 'middle', 'bottom'];
+exports.SOURCES = ['auto', 'prefill', 'derived', 'manual'];
+class FormMetadata {
+    formMetadata;
+    blocks;
+    constructor(formMetadata) {
+        this.formMetadata = formMetadata;
+        this.blocks = formMetadata.schema.blocks;
+    }
+    getAllBlocks() {
+        return this.blocks;
+    }
+    getBlocksByType(blockType) {
+        return this.blocks.filter((block) => block.block_type === blockType);
+    }
+    getBlocksByPartyId(partyId) {
+        return this.blocks.filter((block) => block.party_id === partyId);
+    }
+    getFields() {
+        return this.blocks
+            .filter((block) => block.block_type === 'form_field')
+            .map((block) => block.content);
+    }
+    getField(index) {
+        const fields = this.getFields();
+        return fields[index];
+    }
+    getPhantomFields() {
+        return this.blocks
+            .filter((block) => block.block_type === 'form_phantom_field')
+            .map((block) => block.content);
+    }
+    encodeAsJSON() {
+        return JSON.stringify(this.formMetadata);
+    }
+    static decodeFromJSON(json) {
+        const parsed = JSON.parse(json);
+        return new FormMetadata(parsed);
+    }
+    getLabel() {
+        return this.formMetadata.label;
+    }
+    getFieldForClient(index, sourceDomains, derivationBase) {
+        const field = this.getField(index);
+        if (!field)
+            throw new Error('Field does not exist');
+        const finalParams = {
+            ...derivationBase,
+            ...sourceDomains,
+        };
+        const validator = this.parseValidator(field.field, finalParams);
+        const prefiller = this.parsePrefiller(field.field, finalParams);
+        const section = field.field.split('.')[0];
+        let options = undefined;
+        if (validator?.type === 'enum')
+            options = validator.options;
+        if (validator?.type === 'array') {
+            const element = validator.element;
+            if (element?.options)
+                options = element.options;
+        }
+        const type = field.type === 'signature'
+            ? 'signature'
+            : validator
+                ? (0, fields_client_1.getSchemaClientType)(validator)
+                : 'text';
+        const coerce = (value) => {
+            switch (type) {
+                case 'number': {
+                    const n = parseInt(value);
+                    return isNaN(n) ? 0 : n;
+                }
+                case 'date': {
+                    const n = parseInt(value);
+                    return isNaN(n) ? new Date() : new Date(n);
+                }
+                case 'checkbox': {
+                    return !!value?.trim();
+                }
+                case 'multiselect': {
+                    return value?.split('\n');
+                }
+                default:
+                    return value;
+            }
+        };
+        return {
+            field: field.field,
+            shared: field.shared,
+            label: field.label,
+            source: field.source,
+            tooltip_label: field.tooltip_label,
+            signing_party_id: field.signing_party_id,
+            coerce,
+            type,
+            section,
+            validator,
+            prefiller,
+            options,
+        };
+    }
+    getFieldsForClientService(sourceDomains, derivationBase) {
+        const fields = this.getFields();
+        return fields
+            .map((field, i) => this.getFieldForClient(i, sourceDomains, derivationBase))
+            .filter((field) => field !== null);
+    }
+    getFieldsForSigningService() {
+        const fields = this.getFields();
+        return fields
+            .filter((field) => field.type !== 'image')
+            .map((field) => ({
+            field: field.field,
+            type: field.type,
+            x: field.x,
+            y: field.y,
+            w: field.w,
+            h: field.h,
+            align_h: (field.align_h ?? 'left'),
+            align_v: (field.align_v ?? 'top'),
+            page: field.page,
+        }))
+            .filter((field) => field !== null);
+    }
+    inferParams() {
+        const inferenceRegex = /params\[\s*(['"])(.*?)\1\s*\]/g;
+        const params = [];
+        let match;
+        for (const field of this.getFields()) {
+            const validatorStr = typeof field.validator === 'string' ? field.validator : '';
+            while ((match = inferenceRegex.exec(validatorStr)) !== null)
+                if (!params.includes(match[2]))
+                    params.push(match[2]);
+        }
+        for (const field of this.getPhantomFields()) {
+            const validatorStr = typeof field.validator === 'string' ? field.validator : '';
+            while ((match = inferenceRegex.exec(validatorStr)) !== null)
+                if (!params.includes(match[2]))
+                    params.push(match[2]);
+        }
+        return params;
+    }
+    parseValidator(fieldname, params = {}) {
+        const field = this.getFields().find((f) => f.field === fieldname);
+        if (!field)
+            return null;
+        const d = new Date();
+        const defaults = {
+            currentDate: d,
+            currentDateTimestamp: d.getTime(),
+        };
+        const validatorStr = typeof field.validator === 'string' ? field.validator : '';
+        const validator = this.populateParams(validatorStr, params);
+        const ret = `return ${validator}`;
+        const evaluator = new Function('z', 'params', ret);
+        return evaluator(zod_1.default, { ...params, ...defaults });
+    }
+    parsePrefiller(fieldname, _params = {}) {
+        const field = this.getFields().find((f) => f.field === fieldname);
+        if (!field || !field.default_value)
+            return null;
+        try {
+            const fn = eval(field.default_value);
+            return typeof fn === 'function' ? fn : null;
+        }
+        catch (e) {
+            console.error(`Failed to parse prefiller for field ${fieldname}`, e);
+            return null;
+        }
+    }
+    enumerateParams(s) {
+        const detectedParams = s.match(/#\{[^}]*\}/g) ?? [];
+        const params = detectedParams.map((dp) => {
+            const [fieldName, propertyTree] = dp
+                .replaceAll('#{', '')
+                .replaceAll('}', '')
+                .replaceAll(')', '')
+                .split('(');
+            const properties = propertyTree?.split('.') ?? [];
+            return [fieldName, ...properties];
+        });
+        return params?.reduce((acc, cur, i) => ((acc[detectedParams[i]] = cur), acc), {});
+    }
+    populateParams(s, params) {
+        const paramsReflection = this.enumerateParams(s);
+        const paramsValues = {};
+        for (const match in paramsReflection) {
+            const path = paramsReflection[match];
+            paramsValues[match] =
+                path.reduce((acc, cur) => acc?.[cur], params) ?? '';
+        }
+        let out = s;
+        for (const match in paramsValues) {
+            const replacement = JSON.stringify(paramsValues[match]);
+            out = out.replaceAll(match, replacement);
+        }
+        return out;
+    }
+    getSignatories() {
+        return this.formMetadata.subscribers;
+    }
+    getSubscribers() {
+        return this.formMetadata.subscribers;
+    }
+    getRequiredParties() {
+        return this.formMetadata.parties;
+    }
+}
+exports.FormMetadata = FormMetadata;
+exports.DUMMY_FORM_METADATA = {
+    name: 'test-form',
+    label: 'Test Form',
+    schema_version: exports.SCHEMA_VERSION,
+    schema: {
+        blocks: [
+            {
+                block_type: 'header',
+                order: 0,
+                content: 'Student Information Form',
+                party_id: 'party-1',
+            },
+            {
+                block_type: 'paragraph',
+                order: 1,
+                content: 'Please fill in your personal details below.',
+                party_id: 'party-1',
+            },
+            {
+                block_type: 'form_field',
+                order: 2,
+                content: {
+                    field: 'student.full_name',
+                    type: 'text',
+                    x: 100,
+                    y: 100,
+                    w: 200,
+                    h: 20,
+                    page: 1,
+                    align_h: 'left',
+                    align_v: 'top',
+                    label: 'Full Name',
+                    tooltip_label: 'Enter your full name',
+                    shared: true,
+                    source: 'manual',
+                    default_value: '({ user }) => `${user?.first_name ?? ""} ${user?.last_name ?? ""}`',
+                    validator: 'z.string().min(1, "Name is required")',
+                },
+                party_id: 'party-1',
+            },
+            {
+                block_type: 'form_field',
+                order: 3,
+                content: {
+                    field: 'student.email',
+                    type: 'text',
+                    x: 100,
+                    y: 130,
+                    w: 200,
+                    h: 20,
+                    page: 1,
+                    align_h: 'left',
+                    align_v: 'top',
+                    label: 'Email',
+                    tooltip_label: 'Enter your email address',
+                    shared: true,
+                    source: 'prefill',
+                    default_value: '({ user }) => user?.email ?? ""',
+                    validator: 'z.string().email("Invalid email")',
+                },
+                party_id: 'party-1',
+            },
+            {
+                block_type: 'form_field',
+                order: 4,
+                content: {
+                    field: 'student.signature',
+                    type: 'signature',
+                    x: 100,
+                    y: 160,
+                    w: 150,
+                    h: 50,
+                    page: 1,
+                    align_h: 'left',
+                    align_v: 'top',
+                    label: 'Signature',
+                    tooltip_label: 'Please sign here',
+                    shared: true,
+                    source: 'manual',
+                    validator: 'z.string().min(1, "Signature is required")',
+                },
+                party_id: 'party-1',
+            },
+            {
+                block_type: 'form_phantom_field',
+                order: 5,
+                content: {
+                    field: 'student.phone',
+                    type: 'text',
+                    label: 'Phone Number',
+                    tooltip_label: 'Optional contact number',
+                    shared: true,
+                    source: 'manual',
+                    validator: 'z.string().optional()',
+                },
+                party_id: 'party-1',
+            },
+        ],
+    },
+    parties: [
+        {
+            _id: 'party-1',
+            order: 1,
+            signatory_account: {
+                account_id: 'user-1',
+                name: 'John Doe',
+                email: 'john@example.com',
+                title: 'Student',
+            },
+            signed: false,
+        },
+    ],
+    subscribers: [
+        {
+            account_id: 'user-2',
+            name: 'Jane Smith',
+            email: 'jane@example.com',
+            title: 'Administrator',
+        },
+    ],
+};
 //# sourceMappingURL=form-metadata.js.map