@flusys/nestjs-form-builder 1.0.0-rc → 2.0.0

package/README.md

@@ -9,6 +9,7 @@ This guide covers the NestJS form builder package - dynamic form creation, submi
 
 - [Overview](#overview)
 - [Installation](#installation)
+- [Constants](#constants)
 - [Package Architecture](#package-architecture)
 - [Module Setup](#module-setup)
 - [Entities](#entities)
@@ -55,6 +56,15 @@ npm install @flusys/nestjs-form-builder @flusys/nestjs-shared @flusys/nestjs-cor
 
 ---
 
+## Constants
+
+```typescript
+// Injection Token
+export const FORM_BUILDER_MODULE_OPTIONS = 'FORM_BUILDER_MODULE_OPTIONS';
+```
+
+---
+
 ## Package Architecture
 
 ```
@@ -68,9 +78,8 @@ nestjs-form-builder/
 │   │   └── index.ts
 │   │
 │   ├── entities/
-│   │   ├── form-base.entity.ts       # Abstract base
-│   │   ├── form.entity.ts            # Without company
-│   │   ├── form-with-company.entity.ts  # With company
+│   │   ├── form.entity.ts            # Main form entity
+│   │   ├── form-with-company.entity.ts  # Extends Form with company
 │   │   ├── form-result.entity.ts     # Submissions
 │   │   └── index.ts
 │   │
@@ -196,9 +205,27 @@ function getEntitiesForTenant(tenantConfig?: ITenantDatabaseConfig): any[] {
 
 ## Entities
 
-### FormBase (Abstract)
+### Entity Groups
+
+```typescript
+// Core entities (no company feature)
+export const FormCoreEntities = [Form, FormResult];
+
+// Company-specific entities
+export const FormCompanyEntities = [FormWithCompany, FormResult];
+
+// Helper function
+export function getFormBuilderEntitiesByConfig(enableCompanyFeature: boolean): any[] {
+  return enableCompanyFeature ? FormCompanyEntities : FormCoreEntities;
+}
+
+// Base type alias for backwards compatibility
+export { Form as FormBase } from './form.entity';
+```
+
+### Form
 
-Base entity with common form fields:
+Main form entity with all form fields:
 
 | Column | Type | Description |
 |--------|------|-------------|
@@ -215,7 +242,7 @@ Base entity with common form fields:
 ### Form vs FormWithCompany
 
 - **Form** - Used when `enableCompanyFeature: false`
-- **FormWithCompany** - Adds `companyId` column for tenant isolation
+- **FormWithCompany** - Extends Form, adds `companyId` column for tenant isolation
 
 ### FormResult
 
@@ -596,7 +623,7 @@ The `FormResultService` automatically calculates computed fields on submission v
 // Private method in FormResultService
 private applyComputedFields(
   data: Record<string, unknown>,
-  form: FormBase,
+  form: Form,
   isDraft: boolean,
 ): Record<string, unknown> {
   if (isDraft) return data;
@@ -692,4 +719,4 @@ async hasUserSubmitted(
 
 ---
 
-**Last Updated:** 2026-02-18
+**Last Updated:** 2026-02-21

package/cjs/controllers/form-result.controller.js

@@ -48,43 +48,43 @@ let FormResultController = class FormResultController extends (0, _classes.creat
         insert: {
             level: 'permission',
             permissions: [
-                'form-result.create'
+                _classes.FORM_RESULT_PERMISSIONS.CREATE
             ]
         },
         insertMany: {
             level: 'permission',
             permissions: [
-                'form-result.create'
+                _classes.FORM_RESULT_PERMISSIONS.CREATE
             ]
         },
         getById: {
             level: 'permission',
             permissions: [
-                'form-result.read'
+                _classes.FORM_RESULT_PERMISSIONS.READ
             ]
         },
         getAll: {
             level: 'permission',
             permissions: [
-                'form-result.read'
+                _classes.FORM_RESULT_PERMISSIONS.READ
             ]
         },
         update: {
             level: 'permission',
             permissions: [
-                'form-result.update'
+                _classes.FORM_RESULT_PERMISSIONS.UPDATE
             ]
         },
         updateMany: {
             level: 'permission',
             permissions: [
-                'form-result.update'
+                _classes.FORM_RESULT_PERMISSIONS.UPDATE
             ]
         },
         delete: {
             level: 'permission',
             permissions: [
-                'form-result.delete'
+                _classes.FORM_RESULT_PERMISSIONS.DELETE
             ]
         }
     }
@@ -218,7 +218,7 @@ _ts_decorate([
     (0, _common.Post)('by-form'),
     (0, _common.UseGuards)(_guards.JwtAuthGuard),
     (0, _swagger.ApiBearerAuth)(),
-    (0, _decorators.RequirePermission)('form-result.read'),
+    (0, _decorators.RequirePermission)(_classes.FORM_RESULT_PERMISSIONS.READ),
     (0, _common.HttpCode)(_common.HttpStatus.OK),
     (0, _swagger.ApiOperation)({
         summary: 'Get results by form ID'

package/cjs/docs/form-builder-swagger.config.js

@@ -38,7 +38,7 @@ function formBuilderSwaggerConfig(bootstrapConfig) {
     const enableCompanyFeature = bootstrapConfig?.enableCompanyFeature ?? true;
     return {
         title: 'Form Builder API',
-        description: enableCompanyFeature ? `
+        description: `
 # Form Builder API
 
 Dynamic form builder with schema versioning, conditional logic, and access control.
@@ -48,8 +48,7 @@ Dynamic form builder with schema versioning, conditional logic, and access contr
 ### 📋 Form Management
 - Create and manage dynamic forms
 - Schema versioning for form updates
-- Slug-based URLs for sharing
-- **Company isolation**
+- Slug-based URLs for sharing${enableCompanyFeature ? '\n- **Company isolation**' : ''}
 
 ### 🔒 Access Control
 - **Public**: No authentication required
@@ -59,114 +58,21 @@ Dynamic form builder with schema versioning, conditional logic, and access contr
 ### 📊 Form Results
 - Submit and track form responses
 - Draft support for partial submissions
-- Schema snapshot preservation
-- **Company-level permissions**
+- Schema snapshot preservation${enableCompanyFeature ? '\n- **Company-level permissions**' : ''}
 
 ### 🔀 Conditional Logic
 - Show/hide fields based on values
 - Show/hide sections dynamically
 - Jump to sections based on conditions
 - Conditional required validation
-
+${enableCompanyFeature ? `
 ## Multi-Tenant Support
 
 Forms and results are automatically isolated by:
 - **Company ID**: Company-level data isolation
 
 All queries automatically filter by current user's company context.
-
-## Form Access Types
-
-### Public Forms
-- No authentication required
-- Anyone can view and submit
-- Use \`/form-builder/form/public/:id\` to get form
-- Use \`/form-builder/result/submit-public\` to submit
-
-### Authenticated Forms
-- JWT authentication required
-- User must be logged in
-- Use \`/form-builder/form/authenticated/:id\` to get form
-- Use \`/form-builder/result/submit\` to submit
-
-### Action Group Forms
-- Permission-based access via IAM
-- User must have specific permissions
-- Use \`/form-builder/form/authenticated/:id\` to get form
-- Use \`/form-builder/result/submit\` to submit
-
-## Draft Support
-
-Save form progress and complete later:
-1. Submit with \`isDraft: true\` to save draft
-2. Get draft with \`/form-builder/result/my-draft\`
-3. Update draft with \`/form-builder/result/update-draft\`
-4. Finalize by setting \`isDraft: false\`
-
-## Response Format
-
-All endpoints return standardized responses with success status, data, message, and timestamp.
-
-## Error Handling
-
-Errors return structured responses with success false, error message, error code, and timestamp.
-
-## Common Error Codes
-
-- **400 Bad Request**: Invalid input data
-- **401 Unauthorized**: Missing or invalid authentication
-- **403 Forbidden**: Insufficient permissions or wrong access type
-- **404 Not Found**: Form or result not found
-- **500 Internal Server Error**: Server error
-
-## API Endpoints
-
-All form builder endpoints are prefixed with \`/form-builder\`:
-- \`/form-builder/form/*\` - Form management
-- \`/form-builder/result/*\` - Form result/submission management
-
-## Examples
-
-### Get Form Access Info
-
-POST /form-builder/form/access-info/:id
-Returns access type and requirements (no auth required)
-
-### Submit Public Form
-
-POST /form-builder/result/submit-public with JSON body containing formId and formData
-
-### Submit Authenticated Form
-
-POST /form-builder/result/submit with JWT token and JSON body containing formId and formData
-      ` : `
-# Form Builder API
-
-Dynamic form builder with schema versioning, conditional logic, and access control.
-
-## Features
-
-### 📋 Form Management
-- Create and manage dynamic forms
-- Schema versioning for form updates
-- Slug-based URLs for sharing
-
-### 🔒 Access Control
-- **Public**: No authentication required
-- **Authenticated**: JWT authentication required
-- **Action Group**: Permission-based access via IAM
-
-### 📊 Form Results
-- Submit and track form responses
-- Draft support for partial submissions
-- Schema snapshot preservation
-
-### 🔀 Conditional Logic
-- Show/hide fields based on values
-- Show/hide sections dynamically
-- Jump to sections based on conditions
-- Conditional required validation
-
+` : ''}
 ## Form Access Types
 
 ### Public Forms
@@ -231,7 +137,7 @@ POST /form-builder/result/submit-public with JSON body containing formId and for
 ### Submit Authenticated Form
 
 POST /form-builder/result/submit with JWT token and JSON body containing formId and formData
-      `,
+    `,
         version: '1.0',
         path: 'api/docs/form-builder',
         bearerAuth: true,

package/cjs/dtos/form-result.dto.js

@@ -33,6 +33,7 @@ _export(exports, {
 });
 const _swagger = require("@nestjs/swagger");
 const _classvalidator = require("class-validator");
+const _dtos = require("@flusys/nestjs-shared/dtos");
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -99,6 +100,7 @@ _ts_decorate([
         description: 'Additional metadata',
         required: false
     }),
+    (0, _classvalidator.IsObject)(),
     (0, _classvalidator.IsOptional)(),
     _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
 ], SubmitFormDto.prototype, "metadata", void 0);
@@ -213,29 +215,11 @@ _ts_decorate([
     (0, _classvalidator.IsOptional)(),
     _ts_metadata("design:type", Number)
 ], GetResultsByFormDto.prototype, "pageSize", void 0);
-let FormResultResponseDto = class FormResultResponseDto {
-    constructor(){
-        _define_property(this, "id", void 0);
-        _define_property(this, "formId", void 0);
-        _define_property(this, "schemaVersionSnapshot", void 0);
-        _define_property(this, "schemaVersion", void 0);
-        _define_property(this, "data", void 0);
-        _define_property(this, "submittedById", void 0);
-        _define_property(this, "submittedAt", void 0);
-        _define_property(this, "isDraft", void 0);
-        _define_property(this, "metadata", void 0);
-        _define_property(this, "createdAt", void 0);
-        _define_property(this, "updatedAt", void 0);
-        _define_property(this, "deletedAt", void 0);
-        _define_property(this, "createdById", void 0);
-        _define_property(this, "updatedById", void 0);
-        _define_property(this, "deletedById", void 0);
+let FormResultResponseDto = class FormResultResponseDto extends _dtos.IdentityResponseDto {
+    constructor(...args){
+        super(...args), _define_property(this, "formId", void 0), _define_property(this, "schemaVersionSnapshot", void 0), _define_property(this, "schemaVersion", void 0), _define_property(this, "data", void 0), _define_property(this, "submittedById", void 0), _define_property(this, "submittedAt", void 0), _define_property(this, "isDraft", void 0), _define_property(this, "metadata", void 0);
     }
 };
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", String)
-], FormResultResponseDto.prototype, "id", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)(),
     _ts_metadata("design:type", String)
@@ -270,35 +254,3 @@ _ts_decorate([
     }),
     _ts_metadata("design:type", Object)
 ], FormResultResponseDto.prototype, "metadata", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", typeof Date === "undefined" ? Object : Date)
-], FormResultResponseDto.prototype, "createdAt", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", typeof Date === "undefined" ? Object : Date)
-], FormResultResponseDto.prototype, "updatedAt", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        required: false
-    }),
-    _ts_metadata("design:type", Object)
-], FormResultResponseDto.prototype, "deletedAt", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        required: false
-    }),
-    _ts_metadata("design:type", Object)
-], FormResultResponseDto.prototype, "createdById", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        required: false
-    }),
-    _ts_metadata("design:type", Object)
-], FormResultResponseDto.prototype, "updatedById", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        required: false
-    }),
-    _ts_metadata("design:type", Object)
-], FormResultResponseDto.prototype, "deletedById", void 0);

package/cjs/dtos/form.dto.js

@@ -28,6 +28,7 @@ _export(exports, {
 const _swagger = require("@nestjs/swagger");
 const _classvalidator = require("class-validator");
 const _formaccesstypeenum = require("../enums/form-access-type.enum");
+const _dtos = require("@flusys/nestjs-shared/dtos");
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -159,6 +160,7 @@ _ts_decorate([
         description: 'Additional metadata',
         required: false
     }),
+    (0, _classvalidator.IsObject)(),
     (0, _classvalidator.IsOptional)(),
     _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
 ], CreateFormDto.prototype, "metadata", void 0);
@@ -184,31 +186,11 @@ _ts_decorate([
     (0, _classvalidator.IsOptional)(),
     _ts_metadata("design:type", Number)
 ], UpdateFormDto.prototype, "schemaVersion", void 0);
-let FormResponseDto = class FormResponseDto {
-    constructor(){
-        _define_property(this, "id", void 0);
-        _define_property(this, "name", void 0);
-        _define_property(this, "description", void 0);
-        _define_property(this, "slug", void 0);
-        _define_property(this, "schema", void 0);
-        _define_property(this, "schemaVersion", void 0);
-        _define_property(this, "accessType", void 0);
-        _define_property(this, "actionGroups", void 0);
-        _define_property(this, "companyId", void 0);
-        _define_property(this, "isActive", void 0);
-        _define_property(this, "metadata", void 0);
-        _define_property(this, "createdAt", void 0);
-        _define_property(this, "updatedAt", void 0);
-        _define_property(this, "deletedAt", void 0);
-        _define_property(this, "createdById", void 0);
-        _define_property(this, "updatedById", void 0);
-        _define_property(this, "deletedById", void 0);
+let FormResponseDto = class FormResponseDto extends _dtos.IdentityResponseDto {
+    constructor(...args){
+        super(...args), _define_property(this, "name", void 0), _define_property(this, "description", void 0), _define_property(this, "slug", void 0), _define_property(this, "schema", void 0), _define_property(this, "schemaVersion", void 0), _define_property(this, "accessType", void 0), _define_property(this, "actionGroups", void 0), _define_property(this, "companyId", void 0), _define_property(this, "isActive", void 0), _define_property(this, "metadata", void 0);
     }
 };
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", String)
-], FormResponseDto.prototype, "id", void 0);
 _ts_decorate([
     (0, _swagger.ApiProperty)(),
     _ts_metadata("design:type", String)
@@ -253,105 +235,20 @@ _ts_decorate([
     }),
     _ts_metadata("design:type", Object)
 ], FormResponseDto.prototype, "metadata", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", typeof Date === "undefined" ? Object : Date)
-], FormResponseDto.prototype, "createdAt", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", typeof Date === "undefined" ? Object : Date)
-], FormResponseDto.prototype, "updatedAt", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        required: false
-    }),
-    _ts_metadata("design:type", Object)
-], FormResponseDto.prototype, "deletedAt", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        required: false
-    }),
-    _ts_metadata("design:type", Object)
-], FormResponseDto.prototype, "createdById", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        required: false
-    }),
-    _ts_metadata("design:type", Object)
-], FormResponseDto.prototype, "updatedById", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        required: false
-    }),
-    _ts_metadata("design:type", Object)
-], FormResponseDto.prototype, "deletedById", void 0);
-let PublicFormResponseDto = class PublicFormResponseDto {
-    constructor(){
-        _define_property(this, "id", void 0);
-        _define_property(this, "name", void 0);
-        _define_property(this, "description", void 0);
-        _define_property(this, "schema", void 0);
-        _define_property(this, "schemaVersion", void 0);
-    }
+let PublicFormResponseDto = class PublicFormResponseDto extends (0, _swagger.PickType)(FormResponseDto, [
+    'id',
+    'name',
+    'description',
+    'schema',
+    'schemaVersion'
+]) {
 };
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", String)
-], PublicFormResponseDto.prototype, "id", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", String)
-], PublicFormResponseDto.prototype, "name", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", Object)
-], PublicFormResponseDto.prototype, "description", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], PublicFormResponseDto.prototype, "schema", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", Number)
-], PublicFormResponseDto.prototype, "schemaVersion", void 0);
-let FormAccessInfoResponseDto = class FormAccessInfoResponseDto {
-    constructor(){
-        _define_property(this, "id", void 0);
-        _define_property(this, "name", void 0);
-        _define_property(this, "description", void 0);
-        _define_property(this, "accessType", void 0);
-        _define_property(this, "actionGroups", void 0);
-        _define_property(this, "isActive", void 0);
-    }
+let FormAccessInfoResponseDto = class FormAccessInfoResponseDto extends (0, _swagger.PickType)(FormResponseDto, [
+    'id',
+    'name',
+    'description',
+    'accessType',
+    'actionGroups',
+    'isActive'
+]) {
 };
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", String)
-], FormAccessInfoResponseDto.prototype, "id", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", String)
-], FormAccessInfoResponseDto.prototype, "name", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", Object)
-], FormAccessInfoResponseDto.prototype, "description", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        enum: _formaccesstypeenum.FormAccessType
-    }),
-    _ts_metadata("design:type", typeof _formaccesstypeenum.FormAccessType === "undefined" ? Object : _formaccesstypeenum.FormAccessType)
-], FormAccessInfoResponseDto.prototype, "accessType", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)({
-        type: [
-            String
-        ],
-        required: false
-    }),
-    _ts_metadata("design:type", Object)
-], FormAccessInfoResponseDto.prototype, "actionGroups", void 0);
-_ts_decorate([
-    (0, _swagger.ApiProperty)(),
-    _ts_metadata("design:type", Boolean)
-], FormAccessInfoResponseDto.prototype, "isActive", void 0);

package/cjs/entities/form-with-company.entity.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "FormWithCompany", {
     }
 });
 const _typeorm = require("typeorm");
-const _formbaseentity = require("./form-base.entity");
+const _formentity = require("./form.entity");
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -32,7 +32,7 @@ function _ts_decorate(decorators, target, key, desc) {
 function _ts_metadata(k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
-let FormWithCompany = class FormWithCompany extends _formbaseentity.FormBase {
+let FormWithCompany = class FormWithCompany extends _formentity.Form {
     constructor(...args){
         super(...args), _define_property(this, "companyId", void 0);
     }
@@ -51,5 +51,15 @@ FormWithCompany = _ts_decorate([
     }),
     (0, _typeorm.Index)([
         'companyId'
+    ]),
+    (0, _typeorm.Index)([
+        'companyId',
+        'slug'
+    ], {
+        unique: true
+    }),
+    (0, _typeorm.Index)([
+        'companyId',
+        'isActive'
     ])
 ], FormWithCompany);