@flusys/nestjs-form-builder 7.1.0 → 8.0.0-beta.1

package/cjs/utils/index.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./permission.utils"), exports);
-_export_star(require("./computed-field.utils"), 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/utils/permission.utils.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "validateUserPermissions", {
-    enumerable: true,
-    get: function() {
-        return validateUserPermissions;
-    }
-});
-const _config = require("../config");
-const _common = require("@nestjs/common");
-const CACHE_PREFIX = 'permissions';
-/**
- * Build permission cache key for a user
- * Uses same cache key format as PermissionGuard in nestjs-shared
- */ function buildPermissionCacheKey(user, enableCompanyFeature) {
-    if (enableCompanyFeature && user.companyId) {
-        return `${CACHE_PREFIX}:company:${user.companyId}:branch:${user.branchId || 'null'}:user:${user.id}`;
-    }
-    return `${CACHE_PREFIX}:user:${user.id}`;
-}
-/**
- * Get user permissions from cache
- * Fail-closed: if cache fails, deny access rather than allowing potentially unauthorized access
- */ async function getUserPermissionsFromCache(user, cacheManager, enableCompanyFeature) {
-    const cacheKey = buildPermissionCacheKey(user, enableCompanyFeature);
-    try {
-        const permissions = await cacheManager.get(cacheKey);
-        return permissions ?? [];
-    } catch  {
-        throw new _common.ForbiddenException({
-            message: 'Unable to verify permissions. Please try again.',
-            messageKey: _config.FORM_MESSAGES.PERMISSION_CHECK_FAILED
-        });
-    }
-}
-async function validateUserPermissions(user, requiredPermissions, cacheManager, enableCompanyFeature) {
-    if (!requiredPermissions.length) {
-        return true;
-    }
-    const userPermissions = await getUserPermissionsFromCache(user, cacheManager, enableCompanyFeature);
-    return requiredPermissions.some((perm)=>userPermissions.includes(perm));
-}

package/cjs/utils/permission.utils.spec.js

@@ -1,118 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _common = require("@nestjs/common");
-const _loggedusermock = require("@test-utils/mocks/logged-user.mock");
-const _permissionutils = require("./permission.utils");
-function buildMockCache() {
-    return {
-        get: jest.fn(),
-        set: jest.fn(),
-        del: jest.fn()
-    };
-}
-describe('validateUserPermissions', ()=>{
-    it('returns true immediately without touching the cache when no permissions are required', async ()=>{
-        const cache = buildMockCache();
-        const result = await (0, _permissionutils.validateUserPermissions)((0, _loggedusermock.buildMockUser)(), [], cache, false);
-        expect(result).toBe(true);
-        expect(cache.get).not.toHaveBeenCalled();
-    });
-    it('returns true when the user has at least one of the required permissions', async ()=>{
-        const cache = buildMockCache();
-        cache.get.mockResolvedValue([
-            'hr.survey.submit',
-            'other.permission'
-        ]);
-        const result = await (0, _permissionutils.validateUserPermissions)((0, _loggedusermock.buildMockUser)(), [
-            'hr.survey.submit',
-            'employee.feedback.submit'
-        ], cache, false);
-        expect(result).toBe(true);
-    });
-    it('returns false when the user has none of the required permissions', async ()=>{
-        const cache = buildMockCache();
-        cache.get.mockResolvedValue([
-            'some.other.permission'
-        ]);
-        const result = await (0, _permissionutils.validateUserPermissions)((0, _loggedusermock.buildMockUser)(), [
-            'hr.survey.submit'
-        ], cache, false);
-        expect(result).toBe(false);
-    });
-    it('treats a missing cache entry as no permissions (returns false)', async ()=>{
-        const cache = buildMockCache();
-        cache.get.mockResolvedValue(undefined);
-        const result = await (0, _permissionutils.validateUserPermissions)((0, _loggedusermock.buildMockUser)(), [
-            'hr.survey.submit'
-        ], cache, false);
-        expect(result).toBe(false);
-    });
-    it('fails closed with a ForbiddenException when the cache lookup throws', async ()=>{
-        const cache = buildMockCache();
-        cache.get.mockRejectedValue(new Error('redis down'));
-        await expect((0, _permissionutils.validateUserPermissions)((0, _loggedusermock.buildMockUser)(), [
-            'hr.survey.submit'
-        ], cache, false)).rejects.toMatchObject({
-            response: expect.objectContaining({
-                messageKey: 'form.permission.check.failed'
-            })
-        });
-        await expect((0, _permissionutils.validateUserPermissions)((0, _loggedusermock.buildMockUser)(), [
-            'hr.survey.submit'
-        ], cache, false)).rejects.toBeInstanceOf(_common.ForbiddenException);
-    });
-    describe('cache key construction', ()=>{
-        it('uses a company/branch/user scoped key when the company feature is enabled and both are present', async ()=>{
-            const cache = buildMockCache();
-            cache.get.mockResolvedValue([]);
-            const user = (0, _loggedusermock.buildMockUser)({
-                companyId: 'company-1',
-                branchId: 'branch-1',
-                id: 'user-1'
-            });
-            await (0, _permissionutils.validateUserPermissions)(user, [
-                'perm.read'
-            ], cache, true);
-            expect(cache.get).toHaveBeenCalledWith('permissions:company:company-1:branch:branch-1:user:user-1');
-        });
-        it('uses "null" as the branch placeholder when branchId is missing under the company feature', async ()=>{
-            const cache = buildMockCache();
-            cache.get.mockResolvedValue([]);
-            const user = (0, _loggedusermock.buildMockUser)({
-                companyId: 'company-1',
-                branchId: undefined,
-                id: 'user-1'
-            });
-            await (0, _permissionutils.validateUserPermissions)(user, [
-                'perm.read'
-            ], cache, true);
-            expect(cache.get).toHaveBeenCalledWith('permissions:company:company-1:branch:null:user:user-1');
-        });
-        it('falls back to a plain user-scoped key when the company feature is enabled but companyId is missing', async ()=>{
-            const cache = buildMockCache();
-            cache.get.mockResolvedValue([]);
-            const user = (0, _loggedusermock.buildMockUser)({
-                companyId: undefined,
-                id: 'user-1'
-            });
-            await (0, _permissionutils.validateUserPermissions)(user, [
-                'perm.read'
-            ], cache, true);
-            expect(cache.get).toHaveBeenCalledWith('permissions:user:user-1');
-        });
-        it('uses a plain user-scoped key when the company feature is disabled', async ()=>{
-            const cache = buildMockCache();
-            cache.get.mockResolvedValue([]);
-            const user = (0, _loggedusermock.buildMockUser)({
-                companyId: 'company-1',
-                id: 'user-1'
-            });
-            await (0, _permissionutils.validateUserPermissions)(user, [
-                'perm.read'
-            ], cache, false);
-            expect(cache.get).toHaveBeenCalledWith('permissions:user:user-1');
-        });
-    });
-});

package/fesm/config/event-actions.js

@@ -1,12 +0,0 @@
-/**
- * Domain event actions published by the form builder module, alongside the
- * CRUD lifecycle actions every ApiService emits.
- */ export const FORM_BUILDER_EVENT_ACTIONS = {
-    SUBMITTED: 'submitted',
-    DRAFT_SAVED: 'draft-saved'
-};
-/** Every entity the form builder module publishes under */ export const FORM_BUILDER_EVENT_ENTITIES = {
-    FORM: 'form',
-    FORM_RESULT: 'form_result'
-};
-export const FORM_BUILDER_EVENT_MODULE = 'form-builder';

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

@@ -1,3 +0,0 @@
-/**
- * Form Builder Module Options Token
- */ export const FORM_BUILDER_MODULE_OPTIONS = 'FORM_BUILDER_MODULE_OPTIONS';

package/fesm/config/message-keys.js

@@ -1,20 +0,0 @@
-// ==================== FORM BUILDER MODULE MESSAGE KEYS ====================
-export const FORM_MESSAGES = {
-    NOT_FOUND: 'form.not.found',
-    NOT_PUBLIC: 'form.not.public',
-    AUTH_REQUIRED: 'form.auth.required',
-    ACCESS_DENIED: 'form.access.denied',
-    INVALID_ACCESS_TYPE: 'form.invalid.access.type',
-    PERMISSION_CHECK_FAILED: 'form.permission.check.failed',
-    GET_SUCCESS: 'form.get.success',
-    GET_ACCESS_INFO_SUCCESS: 'form.get.access.info.success'
-};
-export const FORM_RESULT_MESSAGES = {
-    GET_ALL_SUCCESS: 'form.result.get.all.success',
-    NOT_FOUND: 'form.result.not.found',
-    HAS_SUBMITTED_SUCCESS: 'form.result.has.submitted.success',
-    HAS_NOT_SUBMITTED_SUCCESS: 'form.result.has.not.submitted.success',
-    SUBMIT_SUCCESS: 'form.result.submit.success',
-    DRAFT_GET_SUCCESS: 'form.result.draft.get.success',
-    DRAFT_UPDATE_SUCCESS: 'form.result.draft.update.success'
-};

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

@@ -1,271 +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);
-}
-function _ts_param(paramIndex, decorator) {
-    return function(target, key) {
-        decorator(target, key, paramIndex);
-    };
-}
-import { createApiController, FORM_RESULT_PERMISSIONS } from '@flusys/nestjs-shared/classes';
-import { CurrentUser, Public, RequirePermission } from '@flusys/nestjs-shared/decorators';
-import { JwtAuthGuard, PermissionGuard } from '@flusys/nestjs-shared/guards';
-import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
-import { Body, Controller, HttpCode, HttpStatus, Inject, Post, UseGuards } from '@nestjs/common';
-import { ApiBearerAuth, ApiOperation, ApiTags } from '@nestjs/swagger';
-import { FORM_RESULT_MESSAGES } from '../config';
-import { CreateFormResultDto, FormResultResponseDto, GetMyDraftDto, GetResultsByFormDto, SubmitFormDto, UpdateDraftDto, UpdateFormResultDto } from '../dtos';
-import { FormResultService } from '../services/form-result.service';
-export class FormResultController extends createApiController(CreateFormResultDto, UpdateFormResultDto, FormResultResponseDto, {
-    entityName: 'form.result',
-    security: {
-        insert: {
-            level: 'permission',
-            permissions: [
-                FORM_RESULT_PERMISSIONS.CREATE
-            ]
-        },
-        insertMany: {
-            level: 'permission',
-            permissions: [
-                FORM_RESULT_PERMISSIONS.CREATE
-            ]
-        },
-        getById: {
-            level: 'permission',
-            permissions: [
-                FORM_RESULT_PERMISSIONS.READ
-            ]
-        },
-        getAll: {
-            level: 'permission',
-            permissions: [
-                FORM_RESULT_PERMISSIONS.READ
-            ]
-        },
-        update: {
-            level: 'permission',
-            permissions: [
-                FORM_RESULT_PERMISSIONS.UPDATE
-            ]
-        },
-        updateMany: {
-            level: 'permission',
-            permissions: [
-                FORM_RESULT_PERMISSIONS.UPDATE
-            ]
-        },
-        delete: {
-            level: 'permission',
-            permissions: [
-                FORM_RESULT_PERMISSIONS.DELETE
-            ]
-        }
-    }
-}) {
-    // Submit Endpoints
-    /**
-   * Submit form with authentication
-   */ async submitForm(dto, user) {
-        const data = await this.formResultService.submitForm(dto, user, false);
-        return {
-            success: true,
-            message: 'Form submitted successfully',
-            messageKey: FORM_RESULT_MESSAGES.SUBMIT_SUCCESS,
-            data
-        };
-    }
-    async submitPublicForm(dto) {
-        const data = await this.formResultService.submitForm(dto, null, true);
-        return {
-            success: true,
-            message: 'Form submitted successfully',
-            messageKey: FORM_RESULT_MESSAGES.SUBMIT_SUCCESS,
-            data
-        };
-    }
-    // Draft Endpoints
-    async getMyDraft(dto, user) {
-        const data = await this.formResultService.getMyDraft(dto.formId, user);
-        return {
-            success: true,
-            message: 'Draft retrieved',
-            messageKey: FORM_RESULT_MESSAGES.DRAFT_GET_SUCCESS,
-            data
-        };
-    }
-    async updateDraft(dto, user) {
-        const data = await this.formResultService.updateDraft(dto.draftId, dto, user);
-        return {
-            success: true,
-            message: 'Draft updated successfully',
-            messageKey: FORM_RESULT_MESSAGES.DRAFT_UPDATE_SUCCESS,
-            data
-        };
-    }
-    // Query Endpoints
-    /**
-   * Get results by form ID with pagination
-   */ async getByFormId(dto, user) {
-        const page = dto.page ?? 0;
-        const pageSize = dto.pageSize ?? 10;
-        const result = await this.formResultService.getByFormId(dto.formId, user, {
-            page,
-            pageSize
-        });
-        return {
-            success: true,
-            message: 'Form results retrieved successfully',
-            messageKey: FORM_RESULT_MESSAGES.GET_ALL_SUCCESS,
-            data: result.data,
-            meta: {
-                total: result.total,
-                page,
-                pageSize,
-                count: result.data.length
-            }
-        };
-    }
-    /**
-   * Check if current user has already submitted this form (non-draft)
-   * Used for single response mode
-   */ async hasUserSubmitted(dto, user) {
-        const hasSubmitted = await this.formResultService.hasUserSubmitted(dto.formId, user);
-        return {
-            success: true,
-            message: hasSubmitted ? 'User has submitted this form' : 'User has not submitted this form',
-            messageKey: hasSubmitted ? FORM_RESULT_MESSAGES.HAS_SUBMITTED_SUCCESS : FORM_RESULT_MESSAGES.HAS_NOT_SUBMITTED_SUCCESS,
-            data: hasSubmitted
-        };
-    }
-    constructor(formResultService){
-        super(formResultService), _define_property(this, "formResultService", void 0), this.formResultService = formResultService;
-    }
-}
-_ts_decorate([
-    Post('submit'),
-    UseGuards(JwtAuthGuard),
-    ApiBearerAuth(),
-    HttpCode(HttpStatus.CREATED),
-    ApiOperation({
-        summary: 'Submit form result (authenticated)'
-    }),
-    _ts_param(0, Body()),
-    _ts_param(1, CurrentUser()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof SubmitFormDto === "undefined" ? Object : SubmitFormDto,
-        typeof ILoggedUserInfo === "undefined" ? Object : ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormResultController.prototype, "submitForm", null);
-_ts_decorate([
-    Post('submit-public'),
-    Public(),
-    HttpCode(HttpStatus.CREATED),
-    ApiOperation({
-        summary: 'Submit public form (no auth required)'
-    }),
-    _ts_param(0, Body()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof SubmitFormDto === "undefined" ? Object : SubmitFormDto
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormResultController.prototype, "submitPublicForm", null);
-_ts_decorate([
-    Post('my-draft'),
-    UseGuards(JwtAuthGuard),
-    ApiBearerAuth(),
-    HttpCode(HttpStatus.OK),
-    ApiOperation({
-        summary: 'Get my draft for a form'
-    }),
-    _ts_param(0, Body()),
-    _ts_param(1, CurrentUser()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof GetMyDraftDto === "undefined" ? Object : GetMyDraftDto,
-        typeof ILoggedUserInfo === "undefined" ? Object : ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormResultController.prototype, "getMyDraft", null);
-_ts_decorate([
-    Post('update-draft'),
-    UseGuards(JwtAuthGuard),
-    ApiBearerAuth(),
-    HttpCode(HttpStatus.OK),
-    ApiOperation({
-        summary: 'Update existing draft'
-    }),
-    _ts_param(0, Body()),
-    _ts_param(1, CurrentUser()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof UpdateDraftDto === "undefined" ? Object : UpdateDraftDto,
-        typeof ILoggedUserInfo === "undefined" ? Object : ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormResultController.prototype, "updateDraft", null);
-_ts_decorate([
-    Post('by-form'),
-    UseGuards(JwtAuthGuard, PermissionGuard),
-    ApiBearerAuth(),
-    RequirePermission(FORM_RESULT_PERMISSIONS.READ),
-    HttpCode(HttpStatus.OK),
-    ApiOperation({
-        summary: 'Get results by form ID'
-    }),
-    _ts_param(0, Body()),
-    _ts_param(1, CurrentUser()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof GetResultsByFormDto === "undefined" ? Object : GetResultsByFormDto,
-        typeof ILoggedUserInfo === "undefined" ? Object : ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormResultController.prototype, "getByFormId", null);
-_ts_decorate([
-    Post('has-submitted'),
-    UseGuards(JwtAuthGuard),
-    ApiBearerAuth(),
-    HttpCode(HttpStatus.OK),
-    ApiOperation({
-        summary: 'Check if user has submitted form'
-    }),
-    _ts_param(0, Body()),
-    _ts_param(1, CurrentUser()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof GetMyDraftDto === "undefined" ? Object : GetMyDraftDto,
-        typeof ILoggedUserInfo === "undefined" ? Object : ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], FormResultController.prototype, "hasUserSubmitted", null);
-FormResultController = _ts_decorate([
-    ApiTags('Form Builder - Results'),
-    Controller('form-builder/result'),
-    _ts_param(0, Inject(FormResultService)),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof FormResultService === "undefined" ? Object : FormResultService
-    ])
-], FormResultController);