@flusys/nestjs-form-builder 0.1.0-beta.3 → 1.1.0-beta

package/cjs/config/form-builder.constants.js

@@ -4,19 +4,10 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get FORM_BUILDER_DATA_SOURCE_PROVIDER () {
-        return FORM_BUILDER_DATA_SOURCE_PROVIDER;
-    },
-    get FORM_BUILDER_MODULE_OPTIONS () {
+Object.defineProperty(exports, "FORM_BUILDER_MODULE_OPTIONS", {
+    enumerable: true,
+    get: function() {
         return FORM_BUILDER_MODULE_OPTIONS;
     }
 });
 const FORM_BUILDER_MODULE_OPTIONS = 'FORM_BUILDER_MODULE_OPTIONS';
-const FORM_BUILDER_DATA_SOURCE_PROVIDER = 'FORM_BUILDER_DATA_SOURCE_PROVIDER';

package/cjs/config/index.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 _export_star(require("./form-builder.constants"), exports);
-_export_star(require("./form-builder-config.service"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

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

@@ -46,10 +46,9 @@ function _ts_param(paramIndex, decorator) {
 let FormResultController = class FormResultController extends (0, _classes.createApiController)(_dtos.CreateFormResultDto, _dtos.UpdateFormResultDto, _dtos.FormResultResponseDto, {
     security: 'jwt'
 }) {
-    // ==================== Submit Endpoints ====================
+    // Submit Endpoints
     /**
    * Submit form with authentication
-   * Supports authenticated and action_group access types
    */ async submitForm(dto, user) {
         return this.formResultService.submitForm(dto, user, false);
     }
@@ -59,15 +58,32 @@ let FormResultController = class FormResultController extends (0, _classes.creat
    */ async submitPublicForm(dto) {
         return this.formResultService.submitForm(dto, null, true);
     }
-    // ==================== Query Endpoints ====================
+    // Draft Endpoints
     /**
-   * Get results by form ID with pagination (POST-only RPC)
+   * Get current user's draft for a form
+   */ async getMyDraft(dto, user) {
+        return this.formResultService.getMyDraft(dto.formId, user);
+    }
+    /**
+   * Update existing draft or convert to final submission
+   */ async updateDraft(dto, user) {
+        return this.formResultService.updateDraft(dto.draftId, dto, user);
+    }
+    // Query Endpoints
+    /**
+   * Get results by form ID with pagination
    */ async getByFormId(dto, user) {
         return this.formResultService.getByFormId(dto.formId, user, {
             page: dto.page ?? 0,
             pageSize: dto.pageSize ?? 10
         });
     }
+    /**
+   * Check if current user has already submitted this form (non-draft)
+   * Used for single response mode
+   */ async hasUserSubmitted(dto, user) {
+        return this.formResultService.hasUserSubmitted(dto.formId, user);
+    }
     constructor(formResultService){
         super(formResultService), _define_property(this, "formResultService", void 0), this.formResultService = formResultService;
     }
@@ -103,6 +119,40 @@ _ts_decorate([
     ]),
     _ts_metadata("design:returntype", Promise)
 ], FormResultController.prototype, "submitPublicForm", null);
+_ts_decorate([
+    (0, _common.Post)('my-draft'),
+    (0, _common.UseGuards)(_guards.JwtAuthGuard),
+    (0, _swagger.ApiBearerAuth)(),
+    (0, _common.HttpCode)(_common.HttpStatus.OK),
+    (0, _swagger.ApiOperation)({
+        summary: 'Get my draft for a form'
+    }),
+    _ts_param(0, (0, _common.Body)()),
+    _ts_param(1, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _dtos.GetMyDraftDto === "undefined" ? Object : _dtos.GetMyDraftDto,
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], FormResultController.prototype, "getMyDraft", null);
+_ts_decorate([
+    (0, _common.Post)('update-draft'),
+    (0, _common.UseGuards)(_guards.JwtAuthGuard),
+    (0, _swagger.ApiBearerAuth)(),
+    (0, _common.HttpCode)(_common.HttpStatus.OK),
+    (0, _swagger.ApiOperation)({
+        summary: 'Update existing draft'
+    }),
+    _ts_param(0, (0, _common.Body)()),
+    _ts_param(1, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _dtos.UpdateDraftDto === "undefined" ? Object : _dtos.UpdateDraftDto,
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], FormResultController.prototype, "updateDraft", null);
 _ts_decorate([
     (0, _common.Post)('by-form'),
     (0, _common.UseGuards)(_guards.JwtAuthGuard),
@@ -120,6 +170,23 @@ _ts_decorate([
     ]),
     _ts_metadata("design:returntype", Promise)
 ], FormResultController.prototype, "getByFormId", null);
+_ts_decorate([
+    (0, _common.Post)('has-submitted'),
+    (0, _common.UseGuards)(_guards.JwtAuthGuard),
+    (0, _swagger.ApiBearerAuth)(),
+    (0, _common.HttpCode)(_common.HttpStatus.OK),
+    (0, _swagger.ApiOperation)({
+        summary: 'Check if user has submitted form'
+    }),
+    _ts_param(0, (0, _common.Body)()),
+    _ts_param(1, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _dtos.GetMyDraftDto === "undefined" ? Object : _dtos.GetMyDraftDto,
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], FormResultController.prototype, "hasUserSubmitted", null);
 FormResultController = _ts_decorate([
     (0, _swagger.ApiTags)('Form Builder - Results'),
     (0, _common.Controller)('form-builder/result'),

package/cjs/controllers/form.controller.js

@@ -47,10 +47,9 @@ function _ts_param(paramIndex, decorator) {
 let FormController = class FormController extends (0, _classes.createApiController)(_dtos.CreateFormDto, _dtos.UpdateFormDto, _dtos.FormResponseDto, {
     security: 'jwt'
 }) {
-    // ==================== Public Endpoints ====================
+    // Public Endpoints
     /**
    * Get form access info (no authentication required)
-   * Returns access type and requirements for the form
    */ async getFormAccessInfo(id) {
         return this.formService.getFormAccessInfo(id);
     }

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

@@ -0,0 +1,241 @@
+"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;
+    return {
+        title: 'Form Builder API',
+        description: enableCompanyFeature ? `
+# 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
+- **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
+- **Company-level permissions**
+
+### 🔀 Conditional Logic
+- Show/hide fields based on values
+- Show/hide sections dynamically
+- Jump to sections based on conditions
+- Conditional required validation
+
+## 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
+- 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/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "formBuilderSwaggerConfig", {
+    enumerable: true,
+    get: function() {
+        return _formbuilderswaggerconfig.formBuilderSwaggerConfig;
+    }
+});
+const _formbuilderswaggerconfig = require("./form-builder-swagger.config");

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

@@ -18,12 +18,18 @@ _export(exports, {
     get FormResultResponseDto () {
         return FormResultResponseDto;
     },
+    get GetMyDraftDto () {
+        return GetMyDraftDto;
+    },
     get GetResultsByFormDto () {
         return GetResultsByFormDto;
     },
     get SubmitFormDto () {
         return SubmitFormDto;
     },
+    get UpdateDraftDto () {
+        return UpdateDraftDto;
+    },
     get UpdateFormResultDto () {
         return UpdateFormResultDto;
     }
@@ -180,6 +186,34 @@ _ts_decorate([
     (0, _classvalidator.IsOptional)(),
     _ts_metadata("design:type", String)
 ], FormResultQueryDto.prototype, "submittedById", void 0);
+let GetMyDraftDto = class GetMyDraftDto {
+    constructor(){
+        _define_property(this, "formId", void 0);
+    }
+};
+_ts_decorate([
+    (0, _swagger.ApiProperty)({
+        description: 'Form ID to get draft for',
+        example: '123e4567-e89b-12d3-a456-426614174000'
+    }),
+    (0, _classvalidator.IsUUID)(),
+    (0, _classvalidator.IsNotEmpty)(),
+    _ts_metadata("design:type", String)
+], GetMyDraftDto.prototype, "formId", void 0);
+let UpdateDraftDto = class UpdateDraftDto extends SubmitFormDto {
+    constructor(...args){
+        super(...args), _define_property(this, "draftId", void 0);
+    }
+};
+_ts_decorate([
+    (0, _swagger.ApiProperty)({
+        description: 'Draft ID to update',
+        example: '123e4567-e89b-12d3-a456-426614174000'
+    }),
+    (0, _classvalidator.IsUUID)(),
+    (0, _classvalidator.IsNotEmpty)(),
+    _ts_metadata("design:type", String)
+], UpdateDraftDto.prototype, "draftId", void 0);
 let GetResultsByFormDto = class GetResultsByFormDto {
     constructor(){
         _define_property(this, "formId", void 0);

package/cjs/index.js

@@ -11,6 +11,7 @@ _export_star(require("./enums/index"), exports);
 _export_star(require("./interfaces/index"), exports);
 _export_star(require("./modules/index"), exports);
 _export_star(require("./services/index"), exports);
+_export_star(require("./utils/index"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/cjs/modules/form-builder.module.js

@@ -10,7 +10,6 @@ Object.defineProperty(exports, "FormBuilderModule", {
 });
 const _modules = require("@flusys/nestjs-shared/modules");
 const _common = require("@nestjs/common");
-const _formbuilderconfigservice = require("../config/form-builder-config.service");
 const _formbuilderconstants = require("../config/form-builder.constants");
 const _controllers = require("../controllers");
 const _services = require("../services");
@@ -36,7 +35,7 @@ let FormBuilderModule = class FormBuilderModule {
             controllers: options.includeController !== false ? controllers : [],
             providers,
             exports: [
-                _formbuilderconfigservice.FormBuilderConfigService,
+                _services.FormBuilderConfigService,
                 _services.FormBuilderDataSourceProvider,
                 _services.FormService,
                 _services.FormResultService
@@ -62,14 +61,14 @@ let FormBuilderModule = class FormBuilderModule {
                 ...this.getProviders(options, false)
             ],
             exports: [
-                _formbuilderconfigservice.FormBuilderConfigService,
+                _services.FormBuilderConfigService,
                 _services.FormBuilderDataSourceProvider,
                 _services.FormService,
                 _services.FormResultService
             ]
         };
     }
-    // ==================== Private Helper Methods ====================
+    // Private Helper Methods
     /**
    * Get controllers
    */ static getControllers(options) {
@@ -84,7 +83,7 @@ let FormBuilderModule = class FormBuilderModule {
    * @param includeOptionsProvider Whether to include the FORM_BUILDER_MODULE_OPTIONS provider
    */ static getProviders(options, includeOptionsProvider = true) {
         const providers = [
-            _formbuilderconfigservice.FormBuilderConfigService,
+            _services.FormBuilderConfigService,
             _services.FormBuilderDataSourceProvider,
             _services.FormService,
             _services.FormResultService

package/cjs/{config → services}/form-builder-config.service.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "FormBuilderConfigService", {
     }
 });
 const _common = require("@nestjs/common");
-const _formbuilderconstants = require("./form-builder.constants");
+const _formbuilderconstants = require("../config/form-builder.constants");
 const _formbuildermoduleinterface = require("../interfaces/form-builder-module.interface");
 function _define_property(obj, key, value) {
     if (key in obj) {

package/cjs/services/form-builder-datasource.provider.js

@@ -83,7 +83,7 @@ function _ts_param(paramIndex, decorator) {
     };
 }
 let FormBuilderDataSourceProvider = class FormBuilderDataSourceProvider extends _modules.MultiTenantDataSourceService {
-    // ==================== Factory Methods ====================
+    // Factory Methods
     /**
    * Build parent options from FormBuilderModuleOptions
    */ static buildParentOptions(options) {
@@ -92,7 +92,7 @@ let FormBuilderDataSourceProvider = class FormBuilderDataSourceProvider extends
             defaultDatabaseConfig: options.config?.defaultDatabaseConfig
         };
     }
-    // ==================== Feature Flags ====================
+    // Feature Flags
     /**
    * Get global enable company feature flag
    */ getEnableCompanyFeature() {
@@ -109,10 +109,9 @@ let FormBuilderDataSourceProvider = class FormBuilderDataSourceProvider extends
    */ getEnableCompanyFeatureForCurrentTenant() {
         return this.getEnableCompanyFeatureForTenant(this.getCurrentTenant() ?? undefined);
     }
-    // ==================== Entity Management ====================
+    // Entity Management
     /**
    * Get form builder entities based on company feature flag
-   * Note: FormResult is always the same - company context derived from Form via formId
    */ async getFormBuilderEntities(enableCompanyFeature) {
         const enable = enableCompanyFeature ?? this.getEnableCompanyFeature();
         const { Form, FormResult, FormWithCompany } = await Promise.resolve().then(()=>/*#__PURE__*/ _interop_require_wildcard(require("../entities")));
@@ -127,7 +126,7 @@ let FormBuilderDataSourceProvider = class FormBuilderDataSourceProvider extends
             FormResult
         ];
     }
-    // ==================== Overrides ====================
+    // Overrides
     /**
    * Override to dynamically set entities based on tenant config
    */ async createDataSourceFromConfig(config) {