@flusys/nestjs-form-builder 7.1.0 → 8.0.0

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

@@ -1,146 +0,0 @@
-/** 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'
-        ]
-    }
-];
-/**
- * Form Builder Module Swagger Configuration
- * Use this with setupSwaggerDocs() from @flusys/nestjs-core
- *
- * @param bootstrapConfig - Bootstrap configuration to determine feature visibility
- * @returns Swagger configuration with appropriate excludeSchemaProperties based on enableCompanyFeature
- */ export 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/fesm/docs/form-builder-swagger.config.spec.js

@@ -1,71 +0,0 @@
-import { formBuilderSwaggerConfig } from './form-builder-swagger.config';
-describe('formBuilderSwaggerConfig', ()=>{
-    it('should default to company feature enabled and single-database mode when no config is given', ()=>{
-        const config = 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 = 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 = 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 = formBuilderSwaggerConfig({
-            enableCompanyFeature: true
-        });
-        const withoutCompany = 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 = formBuilderSwaggerConfig({
-            databaseMode: 'multi-tenant'
-        });
-        const single = formBuilderSwaggerConfig({
-            databaseMode: 'single'
-        });
-        expect(multiTenant.description).toContain('Multi-Tenant Mode');
-        expect(single.description).not.toContain('Multi-Tenant Mode');
-    });
-});

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

@@ -1,215 +0,0 @@
-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);
-}
-import { IdentityResponseDto } from '@flusys/nestjs-shared/dtos';
-import { ApiProperty, PartialType } from '@nestjs/swagger';
-import { Expose } from 'class-transformer';
-import { IsBoolean, IsInt, IsNotEmpty, IsObject, IsOptional, IsUUID, Min } from 'class-validator';
-export class SubmitFormDto {
-    constructor(){
-        _define_property(this, "formId", void 0);
-        _define_property(this, "data", void 0);
-        _define_property(this, "isDraft", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Form ID to submit',
-        example: '123e4567-e89b-12d3-a456-426614174000'
-    }),
-    IsUUID(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], SubmitFormDto.prototype, "formId", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Submitted form data (field values)',
-        example: {
-            field1: 'value1',
-            field2: 123
-        }
-    }),
-    IsObject(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], SubmitFormDto.prototype, "data", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Save as draft instead of final submission',
-        default: false,
-        required: false
-    }),
-    IsBoolean(),
-    IsOptional(),
-    _ts_metadata("design:type", Boolean)
-], SubmitFormDto.prototype, "isDraft", void 0);
-export class CreateFormResultDto extends SubmitFormDto {
-    constructor(...args){
-        super(...args), _define_property(this, "schemaVersionSnapshot", void 0), _define_property(this, "schemaVersion", void 0), _define_property(this, "submittedById", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Schema snapshot at submission time',
-        required: false
-    }),
-    IsObject(),
-    IsOptional(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], CreateFormResultDto.prototype, "schemaVersionSnapshot", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Schema version at submission time',
-        required: false
-    }),
-    IsOptional(),
-    _ts_metadata("design:type", Number)
-], CreateFormResultDto.prototype, "schemaVersion", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'User who submitted (null for public)',
-        required: false
-    }),
-    IsUUID(),
-    IsOptional(),
-    _ts_metadata("design:type", Object)
-], CreateFormResultDto.prototype, "submittedById", void 0);
-export class UpdateFormResultDto extends PartialType(CreateFormResultDto) {
-    constructor(...args){
-        super(...args), _define_property(this, "id", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Form Result ID',
-        example: '123e4567-e89b-12d3-a456-426614174000'
-    }),
-    IsUUID(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], UpdateFormResultDto.prototype, "id", void 0);
-export class GetMyDraftDto {
-    constructor(){
-        _define_property(this, "formId", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Form ID to get draft for',
-        example: '123e4567-e89b-12d3-a456-426614174000'
-    }),
-    IsUUID(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], GetMyDraftDto.prototype, "formId", void 0);
-export class UpdateDraftDto extends SubmitFormDto {
-    constructor(...args){
-        super(...args), _define_property(this, "draftId", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Draft ID to update',
-        example: '123e4567-e89b-12d3-a456-426614174000'
-    }),
-    IsUUID(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], UpdateDraftDto.prototype, "draftId", void 0);
-export class GetResultsByFormDto {
-    constructor(){
-        _define_property(this, "formId", void 0);
-        _define_property(this, "page", void 0);
-        _define_property(this, "pageSize", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Form ID to filter results',
-        example: '123e4567-e89b-12d3-a456-426614174000'
-    }),
-    IsUUID(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], GetResultsByFormDto.prototype, "formId", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Page number (0-based)',
-        default: 0,
-        required: false
-    }),
-    IsInt(),
-    Min(0),
-    IsOptional(),
-    _ts_metadata("design:type", Number)
-], GetResultsByFormDto.prototype, "page", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Page size',
-        default: 10,
-        required: false
-    }),
-    IsInt(),
-    Min(1),
-    IsOptional(),
-    _ts_metadata("design:type", Number)
-], GetResultsByFormDto.prototype, "pageSize", void 0);
-export class FormResultResponseDto extends 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);
-    }
-}
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", String)
-], FormResultResponseDto.prototype, "formId", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], FormResultResponseDto.prototype, "schemaVersionSnapshot", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Number)
-], FormResultResponseDto.prototype, "schemaVersion", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], FormResultResponseDto.prototype, "data", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Object)
-], FormResultResponseDto.prototype, "submittedById", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", typeof Date === "undefined" ? Object : Date)
-], FormResultResponseDto.prototype, "submittedAt", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Boolean)
-], FormResultResponseDto.prototype, "isDraft", void 0);

package/fesm/dtos/form.dto.js

@@ -1,243 +0,0 @@
-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);
-}
-import { IdentityResponseDto } from '@flusys/nestjs-shared/dtos';
-import { ApiProperty, PartialType, PickType } from '@nestjs/swagger';
-import { Expose } from 'class-transformer';
-import { IsArray, IsBoolean, IsEnum, IsNotEmpty, IsObject, IsOptional, IsString, IsUUID, MaxLength } from 'class-validator';
-import { FormAccessType } from '../enums/form-access-type.enum';
-export class CreateFormDto {
-    constructor(){
-        _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, "accessType", void 0);
-        _define_property(this, "actionGroups", void 0);
-        _define_property(this, "tags", void 0);
-        _define_property(this, "companyId", void 0);
-        _define_property(this, "isActive", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Form name',
-        example: 'Customer Feedback Survey'
-    }),
-    IsString(),
-    IsNotEmpty(),
-    MaxLength(255),
-    _ts_metadata("design:type", String)
-], CreateFormDto.prototype, "name", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Form description',
-        example: 'A survey to collect customer feedback',
-        required: false
-    }),
-    IsString(),
-    IsOptional(),
-    MaxLength(500),
-    _ts_metadata("design:type", String)
-], CreateFormDto.prototype, "description", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'URL-friendly slug for public links',
-        example: 'customer-feedback',
-        required: false
-    }),
-    IsString(),
-    IsOptional(),
-    MaxLength(255),
-    _ts_metadata("design:type", String)
-], CreateFormDto.prototype, "slug", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Form schema (JSON structure)',
-        example: {
-            sections: [],
-            settings: {}
-        }
-    }),
-    IsObject(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], CreateFormDto.prototype, "schema", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Access type for the form',
-        enum: FormAccessType,
-        default: FormAccessType.AUTHENTICATED,
-        required: false
-    }),
-    IsEnum(FormAccessType),
-    IsOptional(),
-    _ts_metadata("design:type", typeof FormAccessType === "undefined" ? Object : FormAccessType)
-], CreateFormDto.prototype, "accessType", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Action groups for permission-based access (only used when accessType is action_group)',
-        example: [
-            'hr.survey.submit',
-            'employee.feedback.submit'
-        ],
-        required: false
-    }),
-    IsArray(),
-    IsString({
-        each: true
-    }),
-    IsOptional(),
-    _ts_metadata("design:type", Array)
-], CreateFormDto.prototype, "actionGroups", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Tags used by consuming modules to fetch this form (e.g. survey, review)',
-        example: [
-            'survey',
-            'review'
-        ],
-        required: false
-    }),
-    IsArray(),
-    IsString({
-        each: true
-    }),
-    IsOptional(),
-    _ts_metadata("design:type", Array)
-], CreateFormDto.prototype, "tags", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Company ID - Only available when company feature is enabled',
-        example: '123e4567-e89b-12d3-a456-426614174000',
-        required: false
-    }),
-    IsUUID(),
-    IsOptional(),
-    _ts_metadata("design:type", String)
-], CreateFormDto.prototype, "companyId", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Active status',
-        default: true,
-        required: false
-    }),
-    IsBoolean(),
-    IsOptional(),
-    _ts_metadata("design:type", Boolean)
-], CreateFormDto.prototype, "isActive", void 0);
-export class UpdateFormDto extends PartialType(CreateFormDto) {
-    constructor(...args){
-        super(...args), _define_property(this, "id", void 0), _define_property(this, "schemaVersion", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        description: 'Form ID',
-        example: '123e4567-e89b-12d3-a456-426614174000'
-    }),
-    IsUUID(),
-    IsNotEmpty(),
-    _ts_metadata("design:type", String)
-], UpdateFormDto.prototype, "id", void 0);
-_ts_decorate([
-    ApiProperty({
-        description: 'Schema version (auto-incremented when schema changes)',
-        required: false
-    }),
-    IsOptional(),
-    _ts_metadata("design:type", Number)
-], UpdateFormDto.prototype, "schemaVersion", void 0);
-export class FormResponseDto extends 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, "tags", void 0), _define_property(this, "companyId", void 0), _define_property(this, "isActive", void 0);
-    }
-}
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", String)
-], FormResponseDto.prototype, "name", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Object)
-], FormResponseDto.prototype, "description", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Object)
-], FormResponseDto.prototype, "slug", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", typeof Record === "undefined" ? Object : Record)
-], FormResponseDto.prototype, "schema", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Number)
-], FormResponseDto.prototype, "schemaVersion", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty({
-        enum: FormAccessType
-    }),
-    _ts_metadata("design:type", typeof FormAccessType === "undefined" ? Object : FormAccessType)
-], FormResponseDto.prototype, "accessType", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Object)
-], FormResponseDto.prototype, "actionGroups", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Object)
-], FormResponseDto.prototype, "tags", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Object)
-], FormResponseDto.prototype, "companyId", void 0);
-_ts_decorate([
-    Expose(),
-    ApiProperty(),
-    _ts_metadata("design:type", Boolean)
-], FormResponseDto.prototype, "isActive", void 0);
-export class PublicFormResponseDto extends PickType(FormResponseDto, [
-    'id',
-    'name',
-    'description',
-    'schema',
-    'schemaVersion'
-]) {
-}
-export class FormAccessInfoResponseDto extends PickType(FormResponseDto, [
-    'id',
-    'name',
-    'description',
-    'accessType',
-    'actionGroups',
-    'isActive'
-]) {
-}