@finsys/core 1.0.1 → 1.2.0

package/dist/utils.js

@@ -1,56 +0,0 @@
-/*
- * Copyright 2025 Sisters Inspire Sdn Bhd
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-/**
- * Utility functions for @finsys/core
- */
-export function getPastMonthLabel(monthsAgo) {
-    const date = new Date();
-    date.setMonth(date.getMonth() - monthsAgo);
-    return date.toLocaleString('default', { month: 'long' });
-}
-export function getPastYearLabel(yearsAgo) {
-    const date = new Date();
-    return (date.getFullYear() - yearsAgo).toString();
-}
-/**
- * Evaluate a SurveyJS-style expression against a data object.
- * e.g. "{totalFinancing} > 50000"
- *
- * NOTE: This is a simplified evaluator that replaces {key} with data[key] access.
- * It does not support complex SurveyJS functions like age() or complicated nested paths unless handled by JS.
- */
-export function evaluateExpression(expression, data) {
-    if (!expression)
-        return true;
-    try {
-        // 1. Replace {variable} with this['variable'] safely
-        let jsExpression = expression.replace(/\{([^}]+)\}/g, (_, key) => {
-            // Clean key if needed (trim)
-            return `this['${key.trim()}']`;
-        });
-        // 2. Map SurveyJS operators to JS operators
-        // Replace single '=' with '==' if it's not already '==' or '!=' or '>=' or '<='
-        // Simplistic approach: look for '=' that are not preceded or followed by other operator chars
-        jsExpression = jsExpression.replace(/(?<![<>!=])=(?![=])/g, '==');
-        // 3. Execute with Function, binding 'data' as 'this'
-        const func = new Function(`return ${jsExpression};`);
-        return !!func.call(data || {});
-    }
-    catch (e) {
-        // console.warn(`Failed to evaluate expression: "${expression}"`, e);
-        return false;
-    }
-}

package/dist/utils.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils.test.js

@@ -1,131 +0,0 @@
-/*
- * Copyright 2025 Sisters Inspire Sdn Bhd
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { describe, it, expect } from 'vitest';
-import { getPastMonthLabel, getPastYearLabel, evaluateExpression } from './utils.js';
-describe('getPastMonthLabel', () => {
-    it('should return a month name string', () => {
-        const label = getPastMonthLabel(1);
-        expect(typeof label).toBe('string');
-        expect(label.length).toBeGreaterThan(0);
-    });
-    it('should return a different month for different offsets', () => {
-        const month1 = getPastMonthLabel(1);
-        const month2 = getPastMonthLabel(2);
-        // These could theoretically collide if run at exact month boundary, but
-        // for offsets 1 and 2 they should always differ
-        expect(month1).not.toBe(month2);
-    });
-    it('should handle offset of 0 (current month)', () => {
-        const label = getPastMonthLabel(0);
-        const expected = new Date().toLocaleString('default', { month: 'long' });
-        expect(label).toBe(expected);
-    });
-    it('should wrap around years correctly (e.g., 12 months ago)', () => {
-        const label = getPastMonthLabel(12);
-        // 12 months ago should be the same month name as now
-        const expected = new Date().toLocaleString('default', { month: 'long' });
-        expect(label).toBe(expected);
-    });
-});
-describe('getPastYearLabel', () => {
-    it('should return the current year for offset 0', () => {
-        const label = getPastYearLabel(0);
-        expect(label).toBe(new Date().getFullYear().toString());
-    });
-    it('should return last year for offset 1', () => {
-        const label = getPastYearLabel(1);
-        expect(label).toBe((new Date().getFullYear() - 1).toString());
-    });
-    it('should return a year string for any offset', () => {
-        const label = getPastYearLabel(5);
-        expect(label).toBe((new Date().getFullYear() - 5).toString());
-    });
-});
-describe('evaluateExpression', () => {
-    it('should return true for empty/falsy expression', () => {
-        expect(evaluateExpression('', {})).toBe(true);
-        expect(evaluateExpression(null, {})).toBe(true);
-        expect(evaluateExpression(undefined, {})).toBe(true);
-    });
-    describe('variable substitution', () => {
-        it('should resolve {variable} references from data', () => {
-            expect(evaluateExpression('{age} > 18', { age: 25 })).toBe(true);
-            expect(evaluateExpression('{age} > 18', { age: 10 })).toBe(false);
-        });
-        it('should handle string comparisons', () => {
-            expect(evaluateExpression("{status} == 'active'", { status: 'active' })).toBe(true);
-            expect(evaluateExpression("{status} == 'active'", { status: 'inactive' })).toBe(false);
-        });
-        it('should handle undefined variables gracefully', () => {
-            // Undefined variables should not throw, expression evaluates to false
-            expect(evaluateExpression('{missing} > 0', {})).toBe(false);
-        });
-    });
-    describe('SurveyJS operator mapping', () => {
-        it('should convert single = to == for equality checks', () => {
-            expect(evaluateExpression('{value} = 5', { value: 5 })).toBe(true);
-            expect(evaluateExpression('{value} = 5', { value: 10 })).toBe(false);
-        });
-        it('should preserve != operator', () => {
-            expect(evaluateExpression('{value} != 5', { value: 10 })).toBe(true);
-            expect(evaluateExpression('{value} != 5', { value: 5 })).toBe(false);
-        });
-        it('should preserve >= operator', () => {
-            expect(evaluateExpression('{value} >= 10', { value: 10 })).toBe(true);
-            expect(evaluateExpression('{value} >= 10', { value: 5 })).toBe(false);
-        });
-        it('should preserve <= operator', () => {
-            expect(evaluateExpression('{value} <= 10', { value: 10 })).toBe(true);
-            expect(evaluateExpression('{value} <= 10', { value: 15 })).toBe(false);
-        });
-        it('should preserve == operator', () => {
-            expect(evaluateExpression('{value} == 10', { value: 10 })).toBe(true);
-        });
-    });
-    describe('boolean expressions', () => {
-        it('should evaluate boolean true/false values', () => {
-            expect(evaluateExpression('{flag} = true', { flag: true })).toBe(true);
-            expect(evaluateExpression('{flag} = true', { flag: false })).toBe(false);
-        });
-        it('should handle truthy/falsy coercion', () => {
-            expect(evaluateExpression('{value} > 0', { value: 1 })).toBe(true);
-            expect(evaluateExpression('{value} > 0', { value: 0 })).toBe(false);
-        });
-    });
-    describe('comparison operators', () => {
-        it('should handle > operator', () => {
-            expect(evaluateExpression('{totalFinancing} > 50000', { totalFinancing: 100000 })).toBe(true);
-            expect(evaluateExpression('{totalFinancing} > 50000', { totalFinancing: 30000 })).toBe(false);
-        });
-        it('should handle < operator', () => {
-            expect(evaluateExpression('{amount} < 100', { amount: 50 })).toBe(true);
-            expect(evaluateExpression('{amount} < 100', { amount: 200 })).toBe(false);
-        });
-    });
-    describe('edge cases', () => {
-        it('should handle null data', () => {
-            // Should not throw, returns false
-            expect(evaluateExpression('{x} > 0', null)).toBe(false);
-        });
-        it('should handle malformed expressions gracefully', () => {
-            expect(evaluateExpression('{{invalid', {})).toBe(false);
-            expect(evaluateExpression('not a valid expression !!!', {})).toBe(false);
-        });
-        it('should handle keys with spaces', () => {
-            expect(evaluateExpression('{my field} = 5', { 'my field': 5 })).toBe(true);
-        });
-    });
-});

package/dist/validator.d.ts

@@ -1,14 +0,0 @@
-import { ErrorObject } from "ajv";
-export interface ValidationResult {
-    valid: boolean;
-    errors?: ErrorObject[];
-    message?: string;
-}
-/**
- * Validates a unified form-config.json object against its schema
- */
-export declare function validateFormConfig(data: unknown): ValidationResult;
-/** @deprecated Use validateFormConfig instead */
-export declare function validateFormSpec(data: unknown): ValidationResult;
-/** @deprecated Use validateFormConfig instead */
-export declare function validatePagesConfig(data: unknown): ValidationResult;

package/dist/validator.js

@@ -1,49 +0,0 @@
-/*
- * Copyright 2025 Sisters Inspire Sdn Bhd
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import AjvModule from "ajv";
-import addFormats from "ajv-formats";
-import unifiedFormSchema from "./schema/unified-form.schema.json" with { type: "json" };
-// Interop for Ajv which can be exported differently in ESM/CJS
-const Ajv = AjvModule.default || AjvModule;
-const ajv = new Ajv({ allErrors: true, strict: false });
-// Interop for ajv-formats
-const addFormatsFn = addFormats.default || addFormats;
-addFormatsFn(ajv);
-// Register the unified schema
-ajv.addSchema(unifiedFormSchema, "unified-form.schema.json");
-/**
- * Validates a unified form-config.json object against its schema
- */
-export function validateFormConfig(data) {
-    const validate = ajv.getSchema("unified-form.schema.json");
-    if (!validate) {
-        return { valid: false, message: "Could not load unified form schema" };
-    }
-    const valid = validate(data);
-    return {
-        valid: !!valid,
-        errors: validate.errors || undefined,
-    };
-}
-// Legacy exports - these now just call validateFormConfig
-/** @deprecated Use validateFormConfig instead */
-export function validateFormSpec(data) {
-    return validateFormConfig(data);
-}
-/** @deprecated Use validateFormConfig instead */
-export function validatePagesConfig(data) {
-    return validateFormConfig(data);
-}

package/dist/validator.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/validator.test.js

@@ -1,142 +0,0 @@
-/*
- * Copyright 2025 Sisters Inspire Sdn Bhd
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { describe, it, expect } from 'vitest';
-import { validateFormConfig, validateFormSpec, validatePagesConfig } from './validator.js';
-describe('validateFormConfig', () => {
-    const validConfig = {
-        categories: [{ id: 'general', name: 'General' }],
-        fields: {
-            fullName: {
-                type: 'text',
-                displayName: 'Full Name',
-                category: 'general'
-            }
-        },
-        pages: [
-            {
-                id: 'page1',
-                fields: ['fullName']
-            }
-        ]
-    };
-    it('should validate a correct form config', () => {
-        const result = validateFormConfig(validConfig);
-        expect(result.valid).toBe(true);
-        expect(result.errors).toBeUndefined();
-    });
-    it('should reject config missing required "categories"', () => {
-        const result = validateFormConfig({
-            fields: { name: { type: 'text' } },
-            pages: [{ id: 'p1', fields: ['name'] }]
-        });
-        expect(result.valid).toBe(false);
-        expect(result.errors).toBeDefined();
-        expect(result.errors.some(e => e.instancePath === '' || e.params?.missingProperty === 'categories')).toBe(true);
-    });
-    it('should reject config missing required "fields"', () => {
-        const result = validateFormConfig({
-            categories: [{ id: 'general', name: 'General' }],
-            pages: [{ id: 'p1', fields: [] }]
-        });
-        expect(result.valid).toBe(false);
-        expect(result.errors).toBeDefined();
-    });
-    it('should reject config missing required "pages"', () => {
-        const result = validateFormConfig({
-            categories: [{ id: 'general', name: 'General' }],
-            fields: { name: { type: 'text' } }
-        });
-        expect(result.valid).toBe(false);
-    });
-    it('should accept config with optional properties', () => {
-        const result = validateFormConfig({
-            ...validConfig,
-            $schema: './schema/unified-form.schema.json',
-            schemaVersion: 'v2.0.0',
-            displayName: 'Test Form',
-            templateIcon: 'loan-icon'
-        });
-        expect(result.valid).toBe(true);
-    });
-    it('should validate field types against allowed enum', () => {
-        const result = validateFormConfig({
-            categories: [{ id: 'general', name: 'General' }],
-            fields: {
-                name: { type: 'invalid_type' }
-            },
-            pages: [{ id: 'p1', fields: ['name'] }]
-        });
-        expect(result.valid).toBe(false);
-    });
-    it('should accept complex field definitions', () => {
-        const result = validateFormConfig({
-            categories: [{ id: 'general', name: 'General' }],
-            fields: {
-                amount: {
-                    type: 'number',
-                    displayName: 'Loan Amount',
-                    min: 1000,
-                    max: 500000,
-                    required: true,
-                    visibleIf: '{employmentType} = "employed"',
-                    validators: [
-                        { type: 'numeric', minValue: 1000, maxValue: 500000, text: 'Must be between 1000 and 500000' }
-                    ]
-                }
-            },
-            pages: [{ id: 'p1', fields: ['amount'] }]
-        });
-        expect(result.valid).toBe(true);
-    });
-    it('should reject a completely invalid input', () => {
-        const result = validateFormConfig('not an object');
-        expect(result.valid).toBe(false);
-    });
-    it('should reject null input', () => {
-        const result = validateFormConfig(null);
-        expect(result.valid).toBe(false);
-    });
-    it('should provide errors array on validation failure', () => {
-        const result = validateFormConfig({});
-        expect(result.valid).toBe(false);
-        expect(result.errors).toBeDefined();
-        expect(Array.isArray(result.errors)).toBe(true);
-        expect(result.errors.length).toBeGreaterThan(0);
-    });
-});
-describe('deprecated aliases', () => {
-    const validConfig = {
-        categories: [{ id: 'general', name: 'General' }],
-        fields: { name: { type: 'text' } },
-        pages: [{ id: 'p1', fields: ['name'] }]
-    };
-    it('validateFormSpec should delegate to validateFormConfig', () => {
-        const result = validateFormSpec(validConfig);
-        expect(result.valid).toBe(true);
-    });
-    it('validatePagesConfig should delegate to validateFormConfig', () => {
-        const result = validatePagesConfig(validConfig);
-        expect(result.valid).toBe(true);
-    });
-    it('deprecated aliases should return same errors as validateFormConfig', () => {
-        const invalid = {};
-        const base = validateFormConfig(invalid);
-        const spec = validateFormSpec(invalid);
-        const pages = validatePagesConfig(invalid);
-        expect(spec.valid).toBe(base.valid);
-        expect(pages.valid).toBe(base.valid);
-    });
-});