@tonzxz/government-forms 0.1.0

package/dist/definitions.d.ts

@@ -0,0 +1,1147 @@
+import { newReportConfigs } from './gam/config/new-report-config.js';
+import type { GamField, GamTableField } from './gam/components/gam-report-workbench.js';
+export type FormField = GamField;
+export type TableField = GamTableField;
+export type FormDefinition = {
+    title: string;
+    description: string;
+    reportCode: string;
+    fields: FormField[];
+    tableFields?: TableField[];
+};
+export type FormValues = {
+    values: Record<string, string>;
+    rows: Record<string, string>[];
+};
+export type FormErrors = Record<string, string>;
+export declare const formDefinitions: {
+    rsmp: {
+        title: string;
+        description: string;
+        reportCode: string;
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "select";
+            options: string[];
+        })[];
+    };
+    pr: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    ris: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            placeholder: string;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "select";
+            required: true;
+            options: string[];
+            placeholder: string;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+            placeholder: string;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            placeholder?: undefined;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            placeholder?: undefined;
+            options?: undefined;
+        })[];
+        tableFields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            placeholder: string;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+            placeholder: string;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: false;
+            placeholder: string;
+        })[];
+        initialRows: never[];
+    };
+    "stock-card": {
+        title: string;
+        description: string;
+        reportCode: string;
+        moduleKey: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    "property-card": {
+        title: string;
+        description: string;
+        reportCode: string;
+        moduleKey: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        }[];
+        tableFields: ({
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            numberType?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            numberType?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            numberType: "int";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            numberType: "float";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+            numberType?: undefined;
+        })[];
+        initialRows: {
+            values: {
+                entityName: string;
+                fundCluster: string;
+                propertyPlantEquipment: string;
+                description: string;
+                propertyNumber: string;
+            };
+            tableRows: {
+                entryDate: string;
+                referenceParNo: string;
+                receiptQty: string;
+                issueTransferDisposalQty: string;
+                issueTransferDisposalOfficeOfficer: string;
+                balanceQty: string;
+                amount: string;
+                remarks: string;
+            }[];
+            status: string;
+        }[];
+    };
+    iar: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            autoGenerate: true;
+            readonly: true;
+            options?: undefined;
+            placeholder?: undefined;
+            searchable?: undefined;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "select";
+            required: true;
+            options: string[];
+            autoGenerate?: undefined;
+            readonly?: undefined;
+            placeholder?: undefined;
+            searchable?: undefined;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "select";
+            required: false;
+            placeholder: string;
+            options: never[];
+            searchable: true;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+            readonly: true;
+            placeholder: string;
+            autoGenerate?: undefined;
+            options?: undefined;
+            searchable?: undefined;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: false;
+            defaultToday: true;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+            options?: undefined;
+            placeholder?: undefined;
+            searchable?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: false;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+            options?: undefined;
+            placeholder?: undefined;
+            searchable?: undefined;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+            options?: undefined;
+            placeholder?: undefined;
+            searchable?: undefined;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+            options?: undefined;
+            placeholder?: undefined;
+            searchable?: undefined;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+            options?: undefined;
+            placeholder?: undefined;
+            searchable?: undefined;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: false;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+            options?: undefined;
+            placeholder?: undefined;
+            searchable?: undefined;
+            defaultToday?: undefined;
+        })[];
+        tableFields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+            readonly: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "select";
+            required: true;
+            options: string[];
+            readonly: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            readonly: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+            readonly: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: false;
+            readonly?: undefined;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: false;
+            readonly: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: false;
+            readonly: true;
+            options?: undefined;
+        })[];
+        initialRows: never[];
+    };
+    rsmi: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    wmr: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    ptr: {
+        title: string;
+        description: string;
+        reportCode: string;
+        moduleKey: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: false;
+        })[];
+        tableFields: ({
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    iirup: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            defaultToday: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: false;
+            defaultToday?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+            defaultToday?: undefined;
+        })[];
+        initialRows: never[];
+    };
+    ppelc: {
+        title: string;
+        description: string;
+        reportCode: string;
+        moduleKey: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        }[];
+        tableFields: ({
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    spc: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    splc: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        })[];
+        tableFields: ({
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            numberType?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            numberType?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            numberType: "float";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    regspi: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    itr: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "select";
+            required: true;
+            options: string[];
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+            options?: undefined;
+        })[];
+        initialRows: never[];
+    };
+    rrsp: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    rspi: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    rpcsp: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    rlsddsp: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "select";
+            required: true;
+            options: string[];
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+            options?: undefined;
+        })[];
+        initialRows: never[];
+    };
+    iirusp: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    par: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+            options?: undefined;
+            placeholder?: undefined;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "select";
+            required: true;
+            options: string[];
+            placeholder: string;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            options?: undefined;
+            placeholder?: undefined;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            autoGenerate: true;
+            readonly: true;
+            options?: undefined;
+            placeholder?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+            options?: undefined;
+            placeholder?: undefined;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+            options?: undefined;
+            placeholder?: undefined;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            options?: undefined;
+            placeholder?: undefined;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: false;
+            options?: undefined;
+            placeholder?: undefined;
+            autoGenerate?: undefined;
+            readonly?: undefined;
+        })[];
+        initialRows: never[];
+    };
+    ics: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: false;
+        })[];
+        tableFields: ({
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: false;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    rlsddp: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "select";
+            required: true;
+            options: string[];
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: false;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: false;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+            options?: undefined;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+            options?: undefined;
+        })[];
+        initialRows: never[];
+    };
+    rpci: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+    rpcppe: {
+        title: string;
+        description: string;
+        reportCode: string;
+        regulatoryBasis: string;
+        story: string;
+        acceptanceChecks: string[];
+        fields: ({
+            id: string;
+            label: string;
+            type: "text";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "date";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "textarea";
+            required: true;
+        } | {
+            id: string;
+            label: string;
+            type: "number";
+            required: true;
+        })[];
+        initialRows: never[];
+    };
+};
+export type FormCode = keyof typeof formDefinitions;
+export declare const formCodes: FormCode[];
+export { newReportConfigs };
+/** Local calendar date, without shifting the date through UTC. Supply today for deterministic initialization. */
+export declare function createFormValues(definition: FormDefinition, today?: Date): FormValues;
+/** UI validation only. The receiving server must enforce authorization and business rules. */
+export declare function validateFormValues(definition: FormDefinition, data: FormValues): FormErrors;