@finsys/core 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of exercising or using the permissions granted under
+      this License and assume any risks associated with Your exercise of
+      permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   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.

package/README.md

@@ -0,0 +1,220 @@
+# @finsys/core
+
+Convert unified form configurations into Zod schemas, React Hook Form defaults, and SurveyJS JSON.
+
+## Features
+
+- **Unified Form Configuration** — Single JSON format for defining form fields and multi-step page layouts
+- **React Hook Form Generator** — Generate Zod schemas, default values, and step configurations from a form config
+- **SurveyJS Generator** — Generate SurveyJS-compatible JSON from the same config
+- **Schema Validation** — Validate form configurations against a strict JSON Schema (AJV)
+- **Visibility-Aware Validation** — Conditional fields are only validated when visible (`visibleIf` expressions)
+- **TypeScript-First** — Full type exports for all config types and generator outputs
+
+## Installation
+
+```bash
+npm install @finsys/core
+```
+
+If you use the SurveyJS generator, install the peer dependency:
+
+```bash
+npm install survey-core
+```
+
+## Quick Start
+
+### React Hook Form
+
+```typescript
+import { generateRHFSchema } from '@finsys/core';
+import formConfig from './form-config.json';
+
+const { zodSchema, defaultValues, steps, groupedFields } = generateRHFSchema(formConfig);
+
+// Use with React Hook Form + zodResolver
+// zodSchema     — Zod schema for the entire form
+// defaultValues — Default values for all fields
+// steps         — Array of step metadata (title, description, field names)
+// groupedFields — Fields grouped by category per step
+```
+
+### SurveyJS
+
+```typescript
+import { generateSurveyJson } from '@finsys/core';
+import formConfig from './form-config.json';
+
+const surveyJson = generateSurveyJson(formConfig);
+// Pass surveyJson to SurveyJS Model
+```
+
+### Config Validation
+
+```typescript
+import { validateFormConfig } from '@finsys/core';
+import formConfig from './form-config.json';
+
+const result = validateFormConfig(formConfig);
+if (!result.valid) {
+  console.error('Validation errors:', result.errors);
+}
+```
+
+### Expression Evaluation
+
+```typescript
+import { evaluateExpression } from '@finsys/core';
+
+// Evaluate SurveyJS-style visibility expressions
+const visible = evaluateExpression('{totalFinancing} > 50000', { totalFinancing: 75000 });
+// true
+```
+
+## Form Configuration Schema
+
+A form config JSON has three required top-level keys: `categories`, `fields`, and `pages`.
+
+```json
+{
+  "$schema": "node_modules/@finsys/core/dist/schema/unified-form.schema.json",
+  "schemaVersion": "2.0",
+  "displayName": "My Application Form",
+  "categories": [
+    { "id": "contact", "name": "Contact Information" },
+    { "id": "business", "name": "Business Details" }
+  ],
+  "fields": {
+    "fullName": {
+      "type": "text",
+      "displayName": "Full Name",
+      "category": "contact",
+      "required": true
+    },
+    "email": {
+      "type": "text",
+      "inputType": "email",
+      "displayName": "Email Address",
+      "category": "contact",
+      "validators": [{ "type": "email", "text": "Please enter a valid email" }]
+    },
+    "companyName": {
+      "type": "text",
+      "displayName": "Company Name",
+      "category": "business"
+    }
+  },
+  "pages": [
+    {
+      "id": "step1",
+      "title": "Your Information",
+      "fields": ["fullName", "email"]
+    },
+    {
+      "id": "step2",
+      "title": "Business Details",
+      "fields": [
+        "companyName",
+        { "ref": "email", "displayName": "Business Email", "readOnly": true }
+      ]
+    }
+  ]
+}
+```
+
+### Field References
+
+Pages reference fields in three ways:
+
+| Format | Example | Description |
+|--------|---------|-------------|
+| String | `"fullName"` | Simple reference to a field in `fields` |
+| Ref with overrides | `{ "ref": "email", "displayName": "Work Email" }` | Reference with per-page property overrides |
+| Inline definition | `{ "definition": { "name": "note", "type": "html", "html": "..." } }` | Page-specific field not in master `fields` |
+
+### Supported Field Types
+
+`text`, `number`, `email`, `file`, `dropdown`, `checkbox`, `boolean`, `comment`, `radiogroup`, `range`, `html`, `slider`
+
+### Validator Types
+
+`regex`, `email`, `numeric`, `text`, `expression`, `answercount`, `custom`
+
+## API Reference
+
+### `generateRHFSchema(config: UnifiedFormConfig): RHFSchemaOutput`
+
+Converts a form config into Zod schemas and React Hook Form metadata.
+
+Returns `{ zodSchema, baseSchema, defaultValues, fields, groupedFields, steps, displayName, categories, templateIcon }`
+
+### `getStepSchema(step: RHFStep, fullSchema: ZodObject): ZodTypeAny`
+
+Extracts the Zod schema for a specific form step.
+
+### `getStepDefaultValues(step: RHFStep, allDefaults: Record<string, any>): Record<string, any>`
+
+Extracts default values for a specific form step.
+
+### `generateSurveyJson(config: UnifiedFormConfig): SurveyJSON`
+
+Converts a form config into SurveyJS-compatible JSON. Requires `survey-core` peer dependency.
+
+### `validateFormConfig(data: unknown): ValidationResult`
+
+Validates a form config object against the unified form JSON schema. Returns `{ valid, errors, message? }`.
+
+### `evaluateExpression(expression: string, data: any): boolean`
+
+Evaluates a SurveyJS-style expression (e.g., `{fieldName} > 100`) against a data object.
+
+### `resolvePageFields(page: PageConfig, fields: Record<string, FieldData>): ResolvedField[]`
+
+Resolves all field references in a page to full field definitions.
+
+### `groupFieldsByCategory(fields: ResolvedField[], categories: Category[]): FieldGroup[]`
+
+Groups resolved fields by their category, maintaining order.
+
+### `applyDynamicTitles(field: ResolvedField): ResolvedField`
+
+Applies dynamic display names for known naming patterns (e.g., `bank_statement_t1` gets a month label).
+
+### Utility Functions
+
+- `getPastMonthLabel(monthsAgo: number): string` — Returns the month name N months ago
+- `getPastYearLabel(yearsAgo: number): string` — Returns the year N years ago
+- `getCategoryName(categoryId: string | undefined, categories: Category[]): string` — Looks up category display name
+
+## Exported Types
+
+```typescript
+// Config types
+UnifiedFormConfig, FieldData, FieldReference, PageConfig, Category, Choice, Validator
+
+// Output types
+ResolvedField, FieldGroup, RHFStep, RHFSchemaOutput
+SurveyElementJSON, SurveyPageJSON, SurveyJSON
+
+// Re-exported from survey-core
+IQuestion, IPage, ISurvey, IPanel, IElement
+```
+
+## Development
+
+```bash
+npm install
+npm run build    # Compile TypeScript + copy schema
+npm run dev      # Watch mode
+npm test         # Run tests (Vitest)
+npm run lint     # Type-check without emitting
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+## License
+
+[Apache-2.0](./LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @finsys/core
+ * Convert unified form configurations into Zod schemas, React Hook Form defaults, and SurveyJS JSON
+ */
+export { generateSurveyJson, resolvePageFields, getCategoryName, groupFieldsByCategory, applyDynamicTitles } from "./survey-generator.js";
+export { getPastMonthLabel, getPastYearLabel, evaluateExpression } from "./utils.js";
+export { generateRHFSchema, getStepSchema, getStepDefaultValues } from "./rhf-generator.js";
+export { validateFormConfig, validateFormSpec, validatePagesConfig } from "./validator.js";
+export type { Category, Choice, Validator, FieldData, FieldReference, PageConfig, UnifiedFormConfig, ResolvedField, FieldGroup, } from "./survey-generator.js";
+export type { SurveyElementJSON, SurveyPageJSON, SurveyJSON } from "./survey-generator.js";
+export type { RHFStep, RHFSchemaOutput } from "./rhf-generator.js";
+export type { IQuestion, IPage, ISurvey, IPanel, IElement } from "./survey-generator.js";

package/dist/index.js

@@ -0,0 +1,9 @@
+/**
+ * @finsys/core
+ * Convert unified form configurations into Zod schemas, React Hook Form defaults, and SurveyJS JSON
+ */
+// Functions
+export { generateSurveyJson, resolvePageFields, getCategoryName, groupFieldsByCategory, applyDynamicTitles } from "./survey-generator.js";
+export { getPastMonthLabel, getPastYearLabel, evaluateExpression } from "./utils.js";
+export { generateRHFSchema, getStepSchema, getStepDefaultValues } from "./rhf-generator.js";
+export { validateFormConfig, validateFormSpec, validatePagesConfig } from "./validator.js";

package/dist/rhf-generator.d.ts

@@ -0,0 +1,30 @@
+import { z } from "zod";
+import { type UnifiedFormConfig, type ResolvedField, type Category, type FieldGroup } from "./survey-generator.js";
+export interface RHFStep {
+    id: number;
+    title: string;
+    description?: string;
+    fields: ResolvedField[];
+    showCategoryHeadings: boolean;
+    layout?: "default" | "grid" | "vertical";
+}
+export interface RHFSchemaOutput {
+    zodSchema: z.ZodTypeAny;
+    baseSchema: z.ZodObject<any>;
+    defaultValues: Record<string, any>;
+    fields: ResolvedField[];
+    groupedFields: FieldGroup[];
+    steps: RHFStep[];
+    displayName: string;
+    categories: Category[];
+    templateIcon?: string;
+}
+export declare function generateRHFSchema(config: UnifiedFormConfig): RHFSchemaOutput;
+/**
+ * Get Zod schema for a specific step
+ */
+export declare function getStepSchema(step: RHFStep, fullSchema: any): z.ZodTypeAny;
+/**
+ * Extract default values for a specific step
+ */
+export declare function getStepDefaultValues(step: RHFStep, allDefaults: Record<string, any>): Record<string, any>;