@betterinternship/core 1.3.4 → 1.4.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export * from './lib/chat';
-export * from './lib/env';
-export * from './lib/notice';
-export * from './lib/email';
-export * from './lib/forms';
+export * from './lib/chat';
+export * from './lib/env';
+export * from './lib/notice';
+export * from './lib/email';
+export * from './lib/forms';

package/dist/lib/email/email.d.ts

@@ -1,6 +1,6 @@
-export declare const sendSingleEmail: ({ sender, subject, recipient, content, }: {
-    sender?: string;
-    subject: string;
-    recipient: string;
-    content: string;
-}) => void;
+export declare const sendSingleEmail: ({ sender, subject, recipient, content, }: {
+    sender?: string;
+    subject: string;
+    recipient: string;
+    content: string;
+}) => void;

package/dist/lib/email/email.js

@@ -1,40 +1,40 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendSingleEmail = void 0;
-const nodemailer = require("nodemailer");
-const uuid_1 = require("uuid");
-const env_1 = require("../env");
-const SMTP_EMAIL = env_1.ENV.SMTP_EMAIL;
-const SMTP_PASSWORD = env_1.ENV.SMTP_PASSWORD;
-if (!SMTP_EMAIL || !SMTP_PASSWORD)
-    throw Error('[ERROR:ENV]: Missing SMTP setup.');
-const transporter = nodemailer.createTransport({
-    service: 'Gmail',
-    host: 'smtp.gmail.com',
-    port: 465,
-    secure: true,
-    auth: {
-        user: SMTP_EMAIL,
-        pass: SMTP_PASSWORD,
-    },
-    messageId: `${(0, uuid_1.v4)()}${SMTP_EMAIL}`,
-});
-const sendSingleEmail = ({ sender, subject, recipient, content, }) => {
-    transporter.sendMail({
-        from: `"${sender ?? 'BetterInternship'}" <${SMTP_EMAIL}>`,
-        to: recipient,
-        subject,
-        html: content,
-    }, (error, info) => {
-        if (error) {
-            console.error('[ERROR] Could not send email.');
-            console.error('[-----] ' + error.message);
-        }
-        else {
-            console.warn('[LOG] Email sent to ' + recipient);
-        }
-    });
-    return;
-};
-exports.sendSingleEmail = sendSingleEmail;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendSingleEmail = void 0;
+const nodemailer = require("nodemailer");
+const uuid_1 = require("uuid");
+const env_1 = require("../env");
+const SMTP_EMAIL = env_1.ENV.SMTP_EMAIL;
+const SMTP_PASSWORD = env_1.ENV.SMTP_PASSWORD;
+if (!SMTP_EMAIL || !SMTP_PASSWORD)
+    throw Error('[ERROR:ENV]: Missing SMTP setup.');
+const transporter = nodemailer.createTransport({
+    service: 'Gmail',
+    host: 'smtp.gmail.com',
+    port: 465,
+    secure: true,
+    auth: {
+        user: SMTP_EMAIL,
+        pass: SMTP_PASSWORD,
+    },
+    messageId: `${(0, uuid_1.v4)()}${SMTP_EMAIL}`,
+});
+const sendSingleEmail = ({ sender, subject, recipient, content, }) => {
+    transporter.sendMail({
+        from: `"${sender ?? 'BetterInternship'}" <${SMTP_EMAIL}>`,
+        to: recipient,
+        subject,
+        html: content,
+    }, (error, info) => {
+        if (error) {
+            console.error('[ERROR] Could not send email.');
+            console.error('[-----] ' + error.message);
+        }
+        else {
+            console.warn('[LOG] Email sent to ' + recipient);
+        }
+    });
+    return;
+};
+exports.sendSingleEmail = sendSingleEmail;
 //# sourceMappingURL=email.js.map

package/dist/lib/forms/fields.client.d.ts

@@ -1,14 +1,14 @@
-import { ZodType } from 'zod';
-import { IFormField, IFormFieldPrefiller, IFormFieldValidator } from './form-metadata';
-import { EnumValue } from 'zod/v4/core/util.cjs';
-export declare const getSchemaClientType: (s: ZodType) => ClientFieldType;
-export type ClientFieldType = 'text' | 'number' | 'date' | 'dropdown' | 'checkbox' | 'textarea' | 'multiselect' | 'time' | 'signature';
-export type ClientFieldSection = 'student' | 'internship' | 'entity' | 'university' | 'report' | 'feedback';
-export type ClientField<SourceDomains extends any[]> = Omit<IFormField, 'x' | 'y' | 'w' | 'h' | 'page' | 'type' | 'validator' | 'prefiller' | 'align_h' | 'align_v'> & {
-    type: ClientFieldType;
-    validator: IFormFieldValidator | null;
-    prefiller: IFormFieldPrefiller<SourceDomains> | null;
-    section: ClientFieldSection;
-    options?: EnumValue[];
-    coerce: (s: string) => string | number | boolean | Date | Array<string>;
-};
+import { ZodType } from 'zod';
+import { IFormField, IFormFieldPrefiller, IFormFieldValidator } from './form-metadata';
+import { EnumValue } from 'zod/v4/core/util.cjs';
+export declare const getSchemaClientType: (s: ZodType) => ClientFieldType;
+export type ClientFieldType = 'text' | 'number' | 'date' | 'dropdown' | 'checkbox' | 'textarea' | 'multiselect' | 'time' | 'signature';
+export type ClientFieldSection = 'student' | 'internship' | 'entity' | 'university' | 'report' | 'feedback';
+export type ClientField<SourceDomains extends any[]> = Omit<IFormField, 'x' | 'y' | 'w' | 'h' | 'page' | 'type' | 'validator' | 'prefiller' | 'align_h' | 'align_v'> & {
+    type: ClientFieldType;
+    validator: IFormFieldValidator | null;
+    prefiller: IFormFieldPrefiller<SourceDomains> | null;
+    section: ClientFieldSection;
+    options?: EnumValue[];
+    coerce: (s: string) => string | number | boolean | Date | Array<string>;
+};

package/dist/lib/forms/fields.client.js

@@ -1,25 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSchemaClientType = void 0;
-const zod_1 = require("zod");
-const getSchemaClientType = (s) => {
-    const infer = s.type;
-    const desc = s.description;
-    if (infer === 'date' || desc === 'date')
-        return 'date';
-    if (infer === 'number' || desc === 'number')
-        return 'number';
-    if (infer === 'enum' || desc === 'dropdown')
-        return 'dropdown';
-    if (infer === 'boolean' || desc === 'checkbox')
-        return 'checkbox';
-    if (s instanceof zod_1.default.ZodArray && desc === 'multiselect')
-        return 'multiselect';
-    if (desc === 'textarea')
-        return 'textarea';
-    if (desc === 'time')
-        return 'time';
-    return 'text';
-};
-exports.getSchemaClientType = getSchemaClientType;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSchemaClientType = void 0;
+const zod_1 = require("zod");
+const getSchemaClientType = (s) => {
+    const infer = s.type;
+    const desc = s.description;
+    if (infer === 'date' || desc === 'date')
+        return 'date';
+    if (infer === 'number' || desc === 'number')
+        return 'number';
+    if (infer === 'enum' || desc === 'dropdown')
+        return 'dropdown';
+    if (infer === 'boolean' || desc === 'checkbox')
+        return 'checkbox';
+    if (s instanceof zod_1.default.ZodArray && desc === 'multiselect')
+        return 'multiselect';
+    if (desc === 'textarea')
+        return 'textarea';
+    if (desc === 'time')
+        return 'time';
+    return 'text';
+};
+exports.getSchemaClientType = getSchemaClientType;
 //# sourceMappingURL=fields.client.js.map

package/dist/lib/forms/form-metadata.d.ts

@@ -1,93 +1,103 @@
 import { ZodType } from 'zod';
 import { ClientField } from './fields.client';
 import { ServerField } from './fields.server';
-export declare const SCHEMA_VERSION = 0;
-export declare const PARTIES: string[];
+export declare const SCHEMA_VERSION = 1;
 export declare const SOURCES: string[];
 export declare const FIELD_TYPES: string[];
+export declare const BLOCK_TYPES: string[];
+export declare const ALIGN_H: string[];
+export declare const ALIGN_V: string[];
+export declare const FORM_SOURCE: string[];
 export interface IFormMetadata {
     name: string;
     label: string;
     schema_version: number;
-    schema: IFormField[];
-    schema_phantoms?: IFormPhantomField[];
+    schema: IForm;
+    parties: IFormSigningParty[];
     subscribers: IFormSubscriber[];
-    signatories: IFormSignatory[];
-    required_parties: IFormPendingParties[];
-    params?: IFormParams;
 }
-export interface IFormParams {
-    [key: string]: string | IFormParams;
-}
-interface IFormContact {
+export interface IUserAccount {
+    account_id: string;
     name: string;
-    honorific: string;
-    title: string;
     email: string;
 }
-export type IFormSubscriber = IFormContact;
-export interface IFormSignatory extends IFormContact {
-    field: string;
+export type IFormSubscriber = IFormSignatory;
+export interface IFormSignatory extends IUserAccount {
+    title?: string;
+    honorific?: string;
 }
-export type IFormPendingParties = {
-    party: string;
+export interface IFormSigningParty {
+    _id: string;
     order: number;
-};
+    signatory_account?: IFormSignatory;
+    signatory_source?: string;
+    signed?: boolean;
+}
+export interface IForm {
+    blocks: IFormBlock[];
+}
+export interface IFormBlock {
+    block_type: (typeof BLOCK_TYPES)[number];
+    order: number;
+    content: string | IFormField | IFormPhantomField;
+    party_id: IFormSigningParty['_id'];
+}
 export interface IFormField {
     field: string;
-    type: 'text' | 'signature';
+    type: 'text' | 'signature' | 'image';
     x: number;
     y: number;
     w: number;
     h: number;
     page: number;
-    align_h?: 'left' | 'center' | 'right';
-    align_v?: 'top' | 'middle' | 'bottom';
+    align_h?: (typeof ALIGN_H)[number];
+    align_v?: (typeof ALIGN_V)[number];
     label: string;
-    source: 'auto' | 'prefill' | 'derived' | 'manual';
-    party: 'university' | 'entity' | 'student' | 'student-guardian';
-    shared: boolean;
-    descriptor?: boolean;
     tooltip_label: string;
-    validator: string;
-    prefiller: string;
+    shared: boolean;
+    source: (typeof FORM_SOURCE)[number];
+    default_value?: string | IFormParameter;
+    validator?: string | IFormParameter;
 }
 export interface IFormPhantomField {
     field: string;
+    type: 'text' | 'signature' | 'image';
     label: string;
-    type: 'email' | 'param';
-    source: 'auto' | 'prefill' | 'derived' | 'manual';
-    party: 'university' | 'entity' | 'student' | 'student-guardian';
-    shared: boolean;
-    descriptor?: boolean;
     tooltip_label: string;
-    validator: string;
-    prefiller: string;
+    shared: boolean;
+    source: (typeof FORM_SOURCE)[number];
+    default_value?: string | IFormParameter;
+    validator?: string | IFormParameter;
+}
+export interface IFormParameter {
+    [key: string]: string | ZodType;
 }
 export type IFormSourceDomains<SourceDomains extends any[]> = Record<string, SourceDomains[number]>;
 export type IFormFieldValidator = ZodType;
 export type IFormFieldPrefiller<SourceDomains extends any[]> = (sourceDomains: IFormSourceDomains<SourceDomains>) => string;
 export declare class FormMetadata<SourceDomains extends any[]> {
     private readonly formMetadata;
-    private readonly fields;
+    private readonly blocks;
     constructor(formMetadata: IFormMetadata);
+    getAllBlocks(): IFormBlock[];
+    getBlocksByType<T extends (typeof BLOCK_TYPES)[number]>(blockType: T): IFormBlock[];
+    getBlocksByPartyId(partyId: string): IFormBlock[];
+    getFields(): IFormField[];
+    getField(index: number): IFormField | undefined;
+    getPhantomFields(): IFormPhantomField[];
     encodeAsJSON(): string;
     static decodeFromJSON<SourceDomains extends any[]>(json: string): FormMetadata<SourceDomains>;
     getLabel(): string;
-    getFieldForClient(index: number, sourceDomains?: IFormSourceDomains<SourceDomains>, derivationBase?: IFormParams): ClientField<SourceDomains>;
-    getFieldsForClient(sourceDomains?: IFormSourceDomains<SourceDomains>, derivationBase?: IFormParams): ClientField<SourceDomains>[];
-    getFieldsForServer(): ServerField[];
-    getPhantomFields(): IFormPhantomField[];
+    getFieldForClient(index: number, sourceDomains?: IFormSourceDomains<SourceDomains>, derivationBase?: IFormParameter): ClientField<SourceDomains>;
+    getFieldsForClientService(sourceDomains?: IFormSourceDomains<SourceDomains>, derivationBase?: IFormParameter): ClientField<SourceDomains>[];
+    getFieldsForSigningService(): ServerField[];
     inferParams(): string[];
-    getParams(): IFormParams;
-    getDescriptors(): IFormField[];
-    getSignatoryAsValues(): Record<string, string>;
     private parseValidator;
     private parsePrefiller;
     private enumerateParams;
     private populateParams;
-    getSignatories(): IFormContact[];
-    getSubscribers(): IFormContact[];
-    getRequiredParties(): IFormPendingParties[];
+    getSignatories(): IFormSignatory[];
+    getSubscribers(): IFormSignatory[];
+    getRequiredParties(): IFormSigningParty[];
 }
-export {};
+export declare const DUMMY_FORM_METADATA: IFormMetadata;