@flusys/nestjs-form-builder 7.1.0 → 8.0.0

package/cjs/controllers/form.controller.js

@@ -1,231 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "FormController", {
-    enumerable: true,
-    get: function() {
-        return FormController;
-    }
-});
-const _classes = require("@flusys/nestjs-shared/classes");
-const _decorators = require("@flusys/nestjs-shared/decorators");
-const _guards = require("@flusys/nestjs-shared/guards");
-const _interfaces = require("@flusys/nestjs-shared/interfaces");
-const _common = require("@nestjs/common");
-const _swagger = require("@nestjs/swagger");
-const _config = require("../config");
-const _dtos = require("../dtos");
-const _formservice = require("../services/form.service");
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-function _ts_decorate(decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-function _ts_metadata(k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-function _ts_param(paramIndex, decorator) {
-    return function(target, key) {
-        decorator(target, key, paramIndex);
-    };
-}
-let FormController = class FormController extends (0, _classes.createApiController)(_dtos.CreateFormDto, _dtos.UpdateFormDto, _dtos.FormResponseDto, {
-    entityName: 'form',
-    security: {
-        insert: {
-            level: 'permission',
-            permissions: [
-                _classes.FORM_PERMISSIONS.CREATE
-            ]
-        },
-        insertMany: {
-            level: 'permission',
-            permissions: [
-                _classes.FORM_PERMISSIONS.CREATE
-            ]
-        },
-        getById: {
-            level: 'permission',
-            permissions: [
-                _classes.FORM_PERMISSIONS.READ
-            ]
-        },
-        getAll: {
-            level: 'permission',
-            permissions: [
-                _classes.FORM_PERMISSIONS.READ
-            ]
-        },
-        update: {
-            level: 'permission',
-            permissions: [
-                _classes.FORM_PERMISSIONS.UPDATE
-            ]
-        },
-        updateMany: {
-            level: 'permission',
-            permissions: [
-                _classes.FORM_PERMISSIONS.UPDATE
-            ]
-        },
-        delete: {
-            level: 'permission',
-            permissions: [
-                _classes.FORM_PERMISSIONS.DELETE
-            ]
-        }
-    }
-}) {
-    // Public Endpoints
-    /**
-   * Get form access info (no authentication required)
-   */ async getFormAccessInfo(id) {
-        const data = await this.formService.getFormAccessInfo(id);
-        return {
-            success: true,
-            message: 'Form access info retrieved',
-            messageKey: _config.FORM_MESSAGES.GET_ACCESS_INFO_SUCCESS,
-            data
-        };
-    }
-    async getPublicForm(id) {
-        const data = await this.formService.getPublicForm(id);
-        return {
-            success: true,
-            message: 'Form retrieved',
-            messageKey: _config.FORM_MESSAGES.GET_SUCCESS,
-            data
-        };
-    }
-    async getAuthenticatedForm(id, user) {
-        const data = await this.formService.getAuthenticatedForm(id, user);
-        return {
-            success: true,
-            message: 'Form retrieved',
-            messageKey: _config.FORM_MESSAGES.GET_SUCCESS,
-            data
-        };
-    }
-    async getBySlug(slug, _user) {
-        const data = await this.formService.getBySlug(slug);
-        return {
-            success: true,
-            message: 'Form retrieved',
-            messageKey: _config.FORM_MESSAGES.GET_SUCCESS,
-            data
-        };
-    }
-    async getPublicFormBySlug(slug) {
-        const data = await this.formService.getPublicFormBySlug(slug);
-        return {
-            success: true,
-            message: 'Form retrieved',
-            messageKey: _config.FORM_MESSAGES.GET_SUCCESS,
-            data
-        };
-    }
-    constructor(formService){
-        super(formService), _define_property(this, "formService", void 0), this.formService = formService;
-    }
-};
-_ts_decorate([
-    (0, _common.Post)('access-info/:id'),
-    (0, _decorators.Public)(),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _swagger.ApiOperation)({
-        summary: 'Get form access info (no auth required)'
-    }),
-    _ts_param(0, (0, _common.Param)('id')),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        String
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormController.prototype, "getFormAccessInfo", null);
-_ts_decorate([
-    (0, _common.Post)('public/:id'),
-    (0, _decorators.Public)(),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _swagger.ApiOperation)({
-        summary: 'Get public form for submission (no auth required)'
-    }),
-    _ts_param(0, (0, _common.Param)('id')),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        String
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormController.prototype, "getPublicForm", null);
-_ts_decorate([
-    (0, _common.Post)('authenticated/:id'),
-    (0, _common.UseGuards)(_guards.JwtAuthGuard),
-    (0, _swagger.ApiBearerAuth)(),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _swagger.ApiOperation)({
-        summary: 'Get form for authenticated submission'
-    }),
-    _ts_param(0, (0, _common.Param)('id')),
-    _ts_param(1, (0, _decorators.CurrentUser)()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        String,
-        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormController.prototype, "getAuthenticatedForm", null);
-_ts_decorate([
-    (0, _common.Post)('by-slug/:slug'),
-    (0, _common.UseGuards)(_guards.JwtAuthGuard, _guards.PermissionGuard),
-    (0, _swagger.ApiBearerAuth)(),
-    (0, _decorators.RequirePermission)(_classes.FORM_PERMISSIONS.READ),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _swagger.ApiOperation)({
-        summary: 'Get form by slug'
-    }),
-    _ts_param(0, (0, _common.Param)('slug')),
-    _ts_param(1, (0, _decorators.CurrentUser)()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        String,
-        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormController.prototype, "getBySlug", null);
-_ts_decorate([
-    (0, _common.Post)('public/by-slug/:slug'),
-    (0, _decorators.Public)(),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _swagger.ApiOperation)({
-        summary: 'Get public form by slug (no auth required)'
-    }),
-    _ts_param(0, (0, _common.Param)('slug')),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        String
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormController.prototype, "getPublicFormBySlug", null);
-FormController = _ts_decorate([
-    (0, _swagger.ApiTags)('Form Builder - Forms'),
-    (0, _common.Controller)('form-builder/form'),
-    _ts_param(0, (0, _common.Inject)(_formservice.FormService)),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof _formservice.FormService === "undefined" ? Object : _formservice.FormService
-    ])
-], FormController);

package/cjs/controllers/form.controller.spec.js

@@ -1,212 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _testing = require("@nestjs/testing");
-const _modules = require("@flusys/nestjs-shared/modules");
-const _loggedusermock = require("@test-utils/mocks/logged-user.mock");
-const _formaccesstypeenum = require("../enums/form-access-type.enum");
-const _formcontroller = require("./form.controller");
-const _formservice = require("../services/form.service");
-describe('FormController', ()=>{
-    let controller;
-    let mockService;
-    beforeEach(async ()=>{
-        mockService = {
-            insert: jest.fn(),
-            insertMany: jest.fn(),
-            findById: jest.fn(),
-            findByIds: jest.fn(),
-            getAll: jest.fn(),
-            update: jest.fn(),
-            updateMany: jest.fn(),
-            delete: jest.fn(),
-            getFormAccessInfo: jest.fn(),
-            getPublicForm: jest.fn(),
-            getAuthenticatedForm: jest.fn(),
-            getBySlug: jest.fn(),
-            getPublicFormBySlug: jest.fn()
-        };
-        const module = await _testing.Test.createTestingModule({
-            controllers: [
-                _formcontroller.FormController
-            ],
-            // UtilsService is a real (dependency-free) provider — required to satisfy the
-            // Slug interceptor applied by the inherited insert/update endpoints.
-            providers: [
-                {
-                    provide: _formservice.FormService,
-                    useValue: mockService
-                },
-                _modules.UtilsService
-            ]
-        }).compile();
-        controller = module.get(_formcontroller.FormController);
-    });
-    afterEach(()=>{
-        jest.clearAllMocks();
-    });
-    describe('getFormAccessInfo', ()=>{
-        it('returns access info without requiring authentication', async ()=>{
-            mockService.getFormAccessInfo.mockResolvedValue({
-                id: 'form-1',
-                name: 'Survey',
-                description: null,
-                accessType: _formaccesstypeenum.FormAccessType.PUBLIC,
-                actionGroups: null,
-                isActive: true
-            });
-            const result = await controller.getFormAccessInfo('form-1');
-            expect(result).toEqual({
-                success: true,
-                message: 'Form access info retrieved',
-                messageKey: 'form.get.access.info.success',
-                data: expect.objectContaining({
-                    id: 'form-1',
-                    accessType: _formaccesstypeenum.FormAccessType.PUBLIC
-                })
-            });
-            expect(mockService.getFormAccessInfo).toHaveBeenCalledWith('form-1');
-        });
-        it('propagates NotFoundException raised by the service', async ()=>{
-            mockService.getFormAccessInfo.mockRejectedValue(Object.assign(new Error('not found'), {
-                messageKey: 'form.not.found'
-            }));
-            await expect(controller.getFormAccessInfo('missing')).rejects.toThrow();
-        });
-    });
-    describe('getPublicForm', ()=>{
-        it('returns the public form projection', async ()=>{
-            mockService.getPublicForm.mockResolvedValue({
-                id: 'form-1',
-                name: 'Survey',
-                description: null,
-                schema: {
-                    sections: []
-                },
-                schemaVersion: 1
-            });
-            const result = await controller.getPublicForm('form-1');
-            expect(result.success).toBe(true);
-            expect(result.messageKey).toBe('form.get.success');
-            expect(result.data.id).toBe('form-1');
-        });
-    });
-    describe('getAuthenticatedForm', ()=>{
-        it('forwards the current user to the service and returns the form', async ()=>{
-            const user = (0, _loggedusermock.buildMockUser)();
-            mockService.getAuthenticatedForm.mockResolvedValue({
-                id: 'form-1',
-                name: 'Survey',
-                description: null,
-                schema: {},
-                schemaVersion: 1
-            });
-            const result = await controller.getAuthenticatedForm('form-1', user);
-            expect(mockService.getAuthenticatedForm).toHaveBeenCalledWith('form-1', user);
-            expect(result.data.id).toBe('form-1');
-        });
-    });
-    describe('getBySlug', ()=>{
-        it('returns the form when found by slug', async ()=>{
-            mockService.getBySlug.mockResolvedValue({
-                id: 'form-1',
-                name: 'Survey',
-                description: null,
-                slug: 'survey',
-                schema: {},
-                schemaVersion: 1,
-                accessType: _formaccesstypeenum.FormAccessType.AUTHENTICATED,
-                actionGroups: null,
-                tags: null,
-                companyId: null,
-                isActive: true,
-                createdAt: new Date(),
-                updatedAt: new Date(),
-                deletedAt: null,
-                createdById: null,
-                updatedById: null,
-                deletedById: null
-            });
-            const result = await controller.getBySlug('survey', (0, _loggedusermock.buildMockUser)());
-            expect(result.data?.slug).toBe('survey');
-        });
-        it('returns null data when no form matches the slug', async ()=>{
-            mockService.getBySlug.mockResolvedValue(null);
-            const result = await controller.getBySlug('missing', (0, _loggedusermock.buildMockUser)());
-            expect(result.data).toBeNull();
-        });
-    });
-    describe('getPublicFormBySlug', ()=>{
-        it('returns the public form projection when found', async ()=>{
-            mockService.getPublicFormBySlug.mockResolvedValue({
-                id: 'form-1',
-                name: 'Survey',
-                description: null,
-                schema: {},
-                schemaVersion: 1
-            });
-            const result = await controller.getPublicFormBySlug('survey');
-            expect(result.data?.id).toBe('form-1');
-        });
-        it('returns null data when no public form matches the slug', async ()=>{
-            mockService.getPublicFormBySlug.mockResolvedValue(null);
-            const result = await controller.getPublicFormBySlug('missing');
-            expect(result.data).toBeNull();
-        });
-    });
-    // ==========================================================================
-    // Inherited base CRUD wiring (createApiController)
-    // ==========================================================================
-    describe('inherited CRUD endpoints', ()=>{
-        it('insert delegates to FormService.insert and wraps the result', async ()=>{
-            mockService.insert.mockResolvedValue({
-                id: 'form-1',
-                name: 'Survey',
-                description: null,
-                slug: null,
-                schema: {},
-                schemaVersion: 1,
-                accessType: _formaccesstypeenum.FormAccessType.AUTHENTICATED,
-                actionGroups: null,
-                tags: null,
-                companyId: null,
-                isActive: true,
-                createdAt: new Date(),
-                updatedAt: new Date(),
-                deletedAt: null,
-                createdById: null,
-                updatedById: null,
-                deletedById: null
-            });
-            const user = (0, _loggedusermock.buildMockUser)();
-            const result = await controller.insert({
-                name: 'Survey',
-                schema: {}
-            }, user);
-            expect(mockService.insert).toHaveBeenCalledWith({
-                name: 'Survey',
-                schema: {}
-            }, user);
-            expect(result.success).toBe(true);
-            expect(result.data.name).toBe('Survey');
-        });
-        it('delete delegates to FormService.delete', async ()=>{
-            mockService.delete.mockResolvedValue(null);
-            const user = (0, _loggedusermock.buildMockUser)();
-            const result = await controller.delete({
-                id: [
-                    'form-1'
-                ],
-                type: 'delete'
-            }, user);
-            expect(mockService.delete).toHaveBeenCalledWith({
-                id: [
-                    'form-1'
-                ],
-                type: 'delete'
-            }, user);
-            expect(result.success).toBe(true);
-        });
-    });
-});

package/cjs/controllers/index.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./form.controller"), exports);
-_export_star(require("./form-result.controller"), exports);
-function _export_star(from, to) {
-    Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}

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

@@ -1,150 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "formBuilderSwaggerConfig", {
-    enumerable: true,
-    get: function() {
-        return formBuilderSwaggerConfig;
-    }
-});
-/** Schema properties to exclude when company feature is disabled */ const COMPANY_SCHEMA_EXCLUSIONS = [
-    {
-        schemaName: 'CreateFormDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'UpdateFormDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'FormQueryDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'FormResponseDto',
-        properties: [
-            'companyId'
-        ]
-    }
-];
-function formBuilderSwaggerConfig(bootstrapConfig) {
-    const enableCompanyFeature = bootstrapConfig?.enableCompanyFeature ?? true;
-    const isMultiTenant = bootstrapConfig?.databaseMode === 'multi-tenant';
-    const multiTenantNote = isMultiTenant ? `\n> **Multi-Tenant Mode**: Include \`x-tenant-id\` header to target a specific tenant database.\n` : '';
-    return {
-        title: 'Form Builder API',
-        description: `
-# Form Builder API
-${multiTenantNote}
-
-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${enableCompanyFeature ? '\n- **Company isolation**' : ''}
-
-### 🔒 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${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
-    `,
-        version: '1.0',
-        path: 'api/docs/form-builder',
-        bearerAuth: true,
-        excludeTags: [],
-        excludeSchemaProperties: enableCompanyFeature ? undefined : COMPANY_SCHEMA_EXCLUSIONS
-    };
-}

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

@@ -1,75 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _formbuilderswaggerconfig = require("./form-builder-swagger.config");
-describe('formBuilderSwaggerConfig', ()=>{
-    it('should default to company feature enabled and single-database mode when no config is given', ()=>{
-        const config = (0, _formbuilderswaggerconfig.formBuilderSwaggerConfig)();
-        expect(config.title).toBe('Form Builder API');
-        expect(config.path).toBe('api/docs/form-builder');
-        expect(config.bearerAuth).toBe(true);
-        expect(config.excludeTags).toEqual([]);
-        expect(config.excludeSchemaProperties).toBeUndefined();
-        expect(config.description).not.toContain('Multi-Tenant Mode');
-    });
-    it('should exclude companyId schema properties when the company feature is disabled', ()=>{
-        const config = (0, _formbuilderswaggerconfig.formBuilderSwaggerConfig)({
-            enableCompanyFeature: false
-        });
-        expect(config.excludeSchemaProperties).toEqual([
-            {
-                schemaName: 'CreateFormDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'UpdateFormDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'FormQueryDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'FormResponseDto',
-                properties: [
-                    'companyId'
-                ]
-            }
-        ]);
-    });
-    it('should not exclude any schema properties when the company feature is enabled', ()=>{
-        const config = (0, _formbuilderswaggerconfig.formBuilderSwaggerConfig)({
-            enableCompanyFeature: true
-        });
-        expect(config.excludeSchemaProperties).toBeUndefined();
-    });
-    it('should describe company isolation and multi-tenant support only when the company feature is enabled', ()=>{
-        const withCompany = (0, _formbuilderswaggerconfig.formBuilderSwaggerConfig)({
-            enableCompanyFeature: true
-        });
-        const withoutCompany = (0, _formbuilderswaggerconfig.formBuilderSwaggerConfig)({
-            enableCompanyFeature: false
-        });
-        expect(withCompany.description).toContain('Company isolation');
-        expect(withCompany.description).toContain('## Multi-Tenant Support');
-        expect(withoutCompany.description).not.toContain('Company isolation');
-        expect(withoutCompany.description).not.toContain('## Multi-Tenant Support');
-    });
-    it('should mention multi-tenant mode in the description only for multi-tenant database mode', ()=>{
-        const multiTenant = (0, _formbuilderswaggerconfig.formBuilderSwaggerConfig)({
-            databaseMode: 'multi-tenant'
-        });
-        const single = (0, _formbuilderswaggerconfig.formBuilderSwaggerConfig)({
-            databaseMode: 'single'
-        });
-        expect(multiTenant.description).toContain('Multi-Tenant Mode');
-        expect(single.description).not.toContain('Multi-Tenant Mode');
-    });
-});