@flusys/nestjs-shared 7.1.0 → 8.0.0-beta.1

package/cjs/utils/event-pattern.util.spec.js

@@ -1,251 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _eventpatternutil = require("./event-pattern.util");
-describe('matchEventPattern', ()=>{
-    it('should match an exact event name', ()=>{
-        expect((0, _eventpatternutil.matchEventPattern)('storage.folder.created', 'storage.folder.created')).toBe(true);
-    });
-    it('should not match a different event name', ()=>{
-        expect((0, _eventpatternutil.matchEventPattern)('storage.folder.created', 'storage.folder.updated')).toBe(false);
-    });
-    it('should treat * as exactly one segment', ()=>{
-        expect((0, _eventpatternutil.matchEventPattern)('storage.*.created', 'storage.folder.created')).toBe(true);
-        expect((0, _eventpatternutil.matchEventPattern)('storage.*', 'storage.folder.created')).toBe(false);
-    });
-    it('should treat # and ** as any number of segments', ()=>{
-        expect((0, _eventpatternutil.matchEventPattern)('storage.#', 'storage.folder.created')).toBe(true);
-        expect((0, _eventpatternutil.matchEventPattern)('**', 'auth.appuser.deleted')).toBe(true);
-        expect((0, _eventpatternutil.matchEventPattern)('storage.**', 'storage.folder.created')).toBe(true);
-    });
-    it('should let a multi wildcard match zero segments', ()=>{
-        expect((0, _eventpatternutil.matchEventPattern)('storage.folder.created.#', 'storage.folder.created')).toBe(true);
-    });
-    it('should not match across a different module', ()=>{
-        expect((0, _eventpatternutil.matchEventPattern)('storage.#', 'auth.appuser.created')).toBe(false);
-    });
-});
-describe('isMultiWildcard', ()=>{
-    it.each([
-        [
-            '#',
-            true
-        ],
-        [
-            '**',
-            true
-        ],
-        [
-            '*',
-            false
-        ],
-        [
-            'folder',
-            false
-        ]
-    ])('should classify %s as %s', (segment, expected)=>{
-        expect((0, _eventpatternutil.isMultiWildcard)(segment)).toBe(expected);
-    });
-});
-describe('sanitizeEventPayload', ()=>{
-    it('should redact credential-like fields', ()=>{
-        const result = (0, _eventpatternutil.sanitizeEventPayload)({
-            id: '1',
-            password: 'secret',
-            apiKey: 'k'
-        });
-        expect(result).toEqual({
-            id: '1',
-            password: '[REDACTED]',
-            apiKey: '[REDACTED]'
-        });
-    });
-    it('should redact the whole provider settings blob of a storage or email config row', ()=>{
-        const result = (0, _eventpatternutil.sanitizeEventPayload)({
-            name: 'primary-s3',
-            provider: 's3',
-            isActive: true,
-            config: {
-                region: 'us-east-1',
-                bucket: 'assets',
-                accessKeyId: 'AKIA...',
-                secretAccessKey: 's3cr3t'
-            }
-        });
-        expect(result).toEqual({
-            name: 'primary-s3',
-            provider: 's3',
-            isActive: true,
-            config: '[REDACTED]'
-        });
-    });
-    it('should redact the credential keys used by the storage and email providers', ()=>{
-        const result = (0, _eventpatternutil.sanitizeEventPayload)({
-            settings: {
-                region: 'us-east-1',
-                bucket: 'assets',
-                accessKeyId: 'AKIA...',
-                secretAccessKey: 's3cr3t',
-                accountKey: 'azure-key',
-                privateKey: '-----BEGIN...',
-                connectionString: 'DefaultEndpointsProtocol=...;AccountKey=abc',
-                auth: {
-                    user: 'mailer',
-                    pass: 'hunter2'
-                }
-            }
-        });
-        expect(result).toEqual({
-            settings: {
-                region: 'us-east-1',
-                bucket: 'assets',
-                accessKeyId: '[REDACTED]',
-                secretAccessKey: '[REDACTED]',
-                accountKey: '[REDACTED]',
-                privateKey: '[REDACTED]',
-                connectionString: '[REDACTED]',
-                auth: {
-                    user: 'mailer',
-                    pass: '[REDACTED]'
-                }
-            }
-        });
-    });
-    it('should not over-redact keys that merely contain a credential word', ()=>{
-        const result = (0, _eventpatternutil.sanitizeEventPayload)({
-            key: 'uploads/2026/report.pdf',
-            bypassCache: true,
-            passengerCount: 4
-        });
-        expect(result).toEqual({
-            key: 'uploads/2026/report.pdf',
-            bypassCache: true,
-            passengerCount: 4
-        });
-    });
-    it('should redact nested fields', ()=>{
-        const result = (0, _eventpatternutil.sanitizeEventPayload)({
-            user: {
-                name: 'Ada',
-                passwordHash: 'x'
-            }
-        });
-        expect(result).toEqual({
-            user: {
-                name: 'Ada',
-                passwordHash: '[REDACTED]'
-            }
-        });
-    });
-    it('should map over arrays', ()=>{
-        const result = (0, _eventpatternutil.sanitizeEventPayload)([
-            {
-                token: 't'
-            },
-            {
-                token: 'u'
-            }
-        ]);
-        expect(result).toEqual([
-            {
-                token: '[REDACTED]'
-            },
-            {
-                token: '[REDACTED]'
-            }
-        ]);
-    });
-    it('should leave dates and primitives untouched', ()=>{
-        const date = new Date('2026-01-01T00:00:00.000Z');
-        expect((0, _eventpatternutil.sanitizeEventPayload)({
-            createdAt: date,
-            count: 3
-        })).toEqual({
-            createdAt: date,
-            count: 3
-        });
-    });
-    it('should mark a circular relation instead of recursing forever', ()=>{
-        const folder = {
-            id: 'folder-1',
-            name: 'Docs'
-        };
-        const file = {
-            id: 'file-1',
-            folder
-        };
-        folder.files = [
-            file
-        ];
-        expect((0, _eventpatternutil.sanitizeEventPayload)(folder)).toEqual({
-            id: 'folder-1',
-            name: 'Docs',
-            files: [
-                {
-                    id: 'file-1',
-                    folder: '[CIRCULAR]'
-                }
-            ]
-        });
-    });
-    it('should survive a self referencing row', ()=>{
-        const row = {
-            id: '1'
-        };
-        row.self = row;
-        expect(()=>(0, _eventpatternutil.sanitizeEventPayload)(row)).not.toThrow();
-        expect((0, _eventpatternutil.sanitizeEventPayload)(row)).toEqual({
-            id: '1',
-            self: '[CIRCULAR]'
-        });
-    });
-    it('should repeat a shared row rather than calling the second one circular', ()=>{
-        const shared = {
-            id: 'shared'
-        };
-        expect((0, _eventpatternutil.sanitizeEventPayload)([
-            {
-                a: shared
-            },
-            {
-                b: shared
-            }
-        ])).toEqual([
-            {
-                a: {
-                    id: 'shared'
-                }
-            },
-            {
-                b: {
-                    id: 'shared'
-                }
-            }
-        ]);
-    });
-    it('should truncate a graph deeper than the depth cap', ()=>{
-        const deep = {};
-        let cursor = deep;
-        for(let level = 0; level < 12; level++){
-            const next = {};
-            cursor.child = next;
-            cursor = next;
-        }
-        let result = (0, _eventpatternutil.sanitizeEventPayload)(deep);
-        for(let level = 0; level < 7; level++){
-            result = result.child;
-        }
-        expect(result.child).toBe('[TRUNCATED]');
-    });
-    it('should replace a buffer with a marker instead of exploding it into indexes', ()=>{
-        const result = (0, _eventpatternutil.sanitizeEventPayload)({
-            id: '1',
-            content: Buffer.from('hello')
-        });
-        expect(result).toEqual({
-            id: '1',
-            content: '[BINARY]'
-        });
-    });
-});

package/cjs/utils/html-sanitizer.util.js

@@ -1,64 +0,0 @@
-"use strict";
-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 escapeHtml () {
-        return escapeHtml;
-    },
-    get escapeHtmlVariables () {
-        return escapeHtmlVariables;
-    }
-});
-/**
- * HTML Sanitizer Utilities
- *
- * Provides functions for escaping HTML content to prevent XSS attacks.
- * Use these utilities when interpolating user-provided variables into HTML content.
- */ /**
- * HTML entity mapping for escaping special characters
- */ const HTML_ESCAPE_MAP = {
-    '&': '&',
-    '<': '&lt;',
-    '>': '&gt;',
-    '"': '&quot;',
-    "'": '&#x27;',
-    '/': '&#x2F;',
-    '`': '&#x60;',
-    '=': '&#x3D;'
-};
-/**
- * Regex pattern matching characters that need HTML escaping
- */ const HTML_ESCAPE_REGEX = /[&<>"'`=/]/g;
-function escapeHtml(str) {
-    if (!str || typeof str !== 'string') {
-        return str ?? '';
-    }
-    return str.replace(HTML_ESCAPE_REGEX, (char)=>HTML_ESCAPE_MAP[char]);
-}
-function escapeHtmlVariables(variables) {
-    if (!variables || typeof variables !== 'object') {
-        return {};
-    }
-    const escaped = {};
-    for (const [key, value] of Object.entries(variables)){
-        if (value === null || value === undefined) {
-            escaped[key] = '';
-        } else if (typeof value === 'string') {
-            escaped[key] = escapeHtml(value);
-        } else if (typeof value === 'object') {
-            // For objects/arrays, stringify and escape
-            escaped[key] = escapeHtml(JSON.stringify(value));
-        } else {
-            // For numbers, booleans, etc., convert to string (no escaping needed)
-            escaped[key] = String(value);
-        }
-    }
-    return escaped;
-}

package/cjs/utils/html-sanitizer.util.spec.js

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _htmlsanitizerutil = require("./html-sanitizer.util");
-describe('html-sanitizer.util', ()=>{
-    describe('escapeHtml', ()=>{
-        it('should escape all special HTML characters', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtml)('<script>alert("xss")</script>')).toBe('&lt;script&gt;alert(&quot;xss&quot;)&lt;&#x2F;script&gt;');
-        });
-        it('should escape ampersands', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtml)('a & b')).toBe('a &amp; b');
-        });
-        it('should escape single quotes, backticks, and equals signs', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtml)(`a='b' c=\`d\``)).toBe('a&#x3D;&#x27;b&#x27; c&#x3D;&#x60;d&#x60;');
-        });
-        it('should return an empty string for empty input', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtml)('')).toBe('');
-        });
-        it('should return input unchanged when it has no special characters', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtml)('Hello World 123')).toBe('Hello World 123');
-        });
-        it('should return non-string input coerced via nullish fallback', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtml)(null)).toBe('');
-            expect((0, _htmlsanitizerutil.escapeHtml)(undefined)).toBe('');
-        });
-        it('should return non-string, truthy input unchanged (not throw)', ()=>{
-            // e.g. a number passed at runtime despite the TS signature
-            expect((0, _htmlsanitizerutil.escapeHtml)(42)).toBe(42);
-        });
-    });
-    describe('escapeHtmlVariables', ()=>{
-        it('should escape string values', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtmlVariables)({
-                name: '<b>bold</b>'
-            })).toEqual({
-                name: '&lt;b&gt;bold&lt;&#x2F;b&gt;'
-            });
-        });
-        it('should convert numbers and booleans to strings without escaping', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtmlVariables)({
-                count: 5,
-                active: true
-            })).toEqual({
-                count: '5',
-                active: 'true'
-            });
-        });
-        it('should stringify and escape object/array values', ()=>{
-            const result = (0, _htmlsanitizerutil.escapeHtmlVariables)({
-                meta: {
-                    a: '<x>'
-                }
-            });
-            expect(result.meta).toBe((0, _htmlsanitizerutil.escapeHtml)(JSON.stringify({
-                a: '<x>'
-            })));
-        });
-        it('should convert null/undefined values to empty string', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtmlVariables)({
-                a: null,
-                b: undefined
-            })).toEqual({
-                a: '',
-                b: ''
-            });
-        });
-        it('should return an empty object for null/non-object input', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtmlVariables)(null)).toEqual({});
-            expect((0, _htmlsanitizerutil.escapeHtmlVariables)(undefined)).toEqual({});
-        });
-        it('should return an empty object for an empty input object', ()=>{
-            expect((0, _htmlsanitizerutil.escapeHtmlVariables)({})).toEqual({});
-        });
-    });
-});

package/cjs/utils/index.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./date-time.util"), exports);
-_export_star(require("./event-pattern.util"), exports);
-_export_star(require("./html-sanitizer.util"), exports);
-_export_star(require("./optional-module.util"), exports);
-_export_star(require("./permission-cache-key.util"), exports);
-_export_star(require("./query-helpers.util"), exports);
-_export_star(require("./request.util"), exports);
-_export_star(require("./string.util"), 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/optional-module.util.js

@@ -1,35 +0,0 @@
-/**
- * Loads an optional peer dependency at runtime.
- *
- * The specifier has to stay invisible to the bundler. A plain `import(name)`
- * looks dynamic in source but webpack rewrites it into a context module rooted
- * at this directory - one that can only ever resolve files sitting next to this
- * one - so `amqplib` and `kafkajs` fail to load in the bundled app no matter how
- * correctly they are installed. Both lookups below are assembled at runtime,
- * where no bundler can rewrite them.
- *
- * `require` is used first because it is what the CommonJS builds actually run
- * on; native ESM has no `require`, and there `import()` is the only way in.
- */ "use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "loadOptionalModule", {
-    enumerable: true,
-    get: function() {
-        return loadOptionalModule;
-    }
-});
-async function loadOptionalModule(name) {
-    const runtimeRequire = resolveRuntimeRequire();
-    if (runtimeRequire) return runtimeRequire(name);
-    const runtimeImport = new Function('specifier', 'return import(specifier);');
-    return runtimeImport(name);
-}
-/** Undefined under native ESM and inside a bundle that shadows nothing back */ function resolveRuntimeRequire() {
-    try {
-        return eval('typeof require === "function" ? require : undefined');
-    } catch  {
-        return undefined;
-    }
-}

package/cjs/utils/optional-module.util.spec.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _optionalmoduleutil = require("./optional-module.util");
-describe('loadOptionalModule', ()=>{
-    it('should resolve an installed module', async ()=>{
-        const events = await (0, _optionalmoduleutil.loadOptionalModule)('events');
-        expect(typeof events.EventEmitter).toBe('function');
-    });
-    it('should reject for a module that is not installed', async ()=>{
-        await expect((0, _optionalmoduleutil.loadOptionalModule)('definitely-not-installed-pkg')).rejects.toThrow();
-    });
-});

package/cjs/utils/permission-cache-key.util.js

@@ -1,31 +0,0 @@
-"use strict";
-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 DEFAULT_COMPANY_PERMISSION_KEY_FORMAT () {
-        return DEFAULT_COMPANY_PERMISSION_KEY_FORMAT;
-    },
-    get DEFAULT_USER_PERMISSION_KEY_FORMAT () {
-        return DEFAULT_USER_PERMISSION_KEY_FORMAT;
-    },
-    get buildPermissionCacheKey () {
-        return buildPermissionCacheKey;
-    }
-});
-const _constants = require("../constants");
-const DEFAULT_USER_PERMISSION_KEY_FORMAT = `${_constants.PERMISSIONS_CACHE_PREFIX}:user:{userId}`;
-const DEFAULT_COMPANY_PERMISSION_KEY_FORMAT = `${_constants.PERMISSIONS_CACHE_PREFIX}:company:{companyId}:branch:{branchId}:user:{userId}`;
-function buildPermissionCacheKey(options, config) {
-    const isCompanyScope = Boolean(config?.enableCompanyFeature && options.companyId);
-    if (isCompanyScope) {
-        return (config?.companyPermissionKeyFormat || DEFAULT_COMPANY_PERMISSION_KEY_FORMAT).replace('{userId}', options.userId).replace('{companyId}', options.companyId).replace('{branchId}', options.branchId || 'null');
-    }
-    return (config?.userPermissionKeyFormat || DEFAULT_USER_PERMISSION_KEY_FORMAT).replace('{userId}', options.userId);
-}

package/cjs/utils/permission-cache-key.util.spec.js

@@ -1,88 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _permissioncachekeyutil = require("./permission-cache-key.util");
-describe('permission-cache-key.util', ()=>{
-    describe('buildPermissionCacheKey', ()=>{
-        it('should build a user-scoped key when no config is provided', ()=>{
-            const key = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
-                userId: 'user-1'
-            });
-            expect(key).toBe(_permissioncachekeyutil.DEFAULT_USER_PERMISSION_KEY_FORMAT.replace('{userId}', 'user-1'));
-        });
-        it('should build a user-scoped key when company feature is disabled', ()=>{
-            const key = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
-                userId: 'user-1',
-                companyId: 'company-1'
-            }, {
-                enableCompanyFeature: false
-            });
-            expect(key).toBe(_permissioncachekeyutil.DEFAULT_USER_PERMISSION_KEY_FORMAT.replace('{userId}', 'user-1'));
-        });
-        it('should build a user-scoped key when company feature enabled but no companyId given', ()=>{
-            const key = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
-                userId: 'user-1'
-            }, {
-                enableCompanyFeature: true
-            });
-            expect(key).toBe(_permissioncachekeyutil.DEFAULT_USER_PERMISSION_KEY_FORMAT.replace('{userId}', 'user-1'));
-        });
-        it('should build a company-scoped key when company feature is enabled and companyId is present', ()=>{
-            const key = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
-                userId: 'user-1',
-                companyId: 'company-1',
-                branchId: 'branch-1'
-            }, {
-                enableCompanyFeature: true
-            });
-            expect(key).toBe(_permissioncachekeyutil.DEFAULT_COMPANY_PERMISSION_KEY_FORMAT.replace('{userId}', 'user-1').replace('{companyId}', 'company-1').replace('{branchId}', 'branch-1'));
-        });
-        it('should default branchId placeholder to "null" when branchId is missing', ()=>{
-            const key = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
-                userId: 'user-1',
-                companyId: 'company-1'
-            }, {
-                enableCompanyFeature: true
-            });
-            expect(key).toContain(':branch:null:');
-        });
-        it('should default branchId placeholder to "null" when branchId is explicitly null', ()=>{
-            const key = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
-                userId: 'user-1',
-                companyId: 'company-1',
-                branchId: null
-            }, {
-                enableCompanyFeature: true
-            });
-            expect(key).toContain(':branch:null:');
-        });
-        it('should use a custom userPermissionKeyFormat when provided', ()=>{
-            const key = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
-                userId: 'user-1'
-            }, {
-                userPermissionKeyFormat: 'custom:{userId}'
-            });
-            expect(key).toBe('custom:user-1');
-        });
-        it('should use a custom companyPermissionKeyFormat when provided', ()=>{
-            const key = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
-                userId: 'user-1',
-                companyId: 'company-1'
-            }, {
-                enableCompanyFeature: true,
-                companyPermissionKeyFormat: 'custom:{companyId}:{userId}:{branchId}'
-            });
-            expect(key).toBe('custom:company-1:user-1:null');
-        });
-        it('should treat an empty-string companyId as no company scope', ()=>{
-            const key = (0, _permissioncachekeyutil.buildPermissionCacheKey)({
-                userId: 'user-1',
-                companyId: ''
-            }, {
-                enableCompanyFeature: true
-            });
-            expect(key).toBe(_permissioncachekeyutil.DEFAULT_USER_PERMISSION_KEY_FORMAT.replace('{userId}', 'user-1'));
-        });
-    });
-});

package/cjs/utils/query-helpers.util.js

@@ -1,60 +0,0 @@
-"use strict";
-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 applyCompanyFilter () {
-        return applyCompanyFilter;
-    },
-    get buildCompanyWhereCondition () {
-        return buildCompanyWhereCondition;
-    },
-    get hasCompanyId () {
-        return hasCompanyId;
-    },
-    get validateCompanyOwnership () {
-        return validateCompanyOwnership;
-    }
-});
-const _common = require("@nestjs/common");
-const _constants = require("../constants");
-function applyCompanyFilter(query, config, user) {
-    const columnName = config.columnName ?? 'companyId';
-    if (config.isCompanyFeatureEnabled && user?.companyId) {
-        query.andWhere(`${config.entityAlias}.${columnName} = :companyId`, {
-            companyId: user.companyId
-        });
-    }
-    return query;
-}
-function buildCompanyWhereCondition(baseWhere, isCompanyFeatureEnabled, user) {
-    if (isCompanyFeatureEnabled && user?.companyId) {
-        return {
-            ...baseWhere,
-            companyId: user.companyId
-        };
-    }
-    return baseWhere;
-}
-function hasCompanyId(entity) {
-    return entity !== null && typeof entity === 'object' && 'companyId' in entity;
-}
-function validateCompanyOwnership(entity, user, isCompanyFeatureEnabled, entityName) {
-    if (isCompanyFeatureEnabled && user?.companyId && hasCompanyId(entity)) {
-        if (entity.companyId && entity.companyId !== user.companyId) {
-            throw new _common.BadRequestException({
-                message: `${entityName} belongs to another company`,
-                messageKey: _constants.AUTH_MESSAGES.ENTITY_BELOG_ANOTHER_COMPANY,
-                messageVariables: {
-                    entity: entityName
-                }
-            });
-        }
-    }
-}