@flusys/nestjs-localization 7.0.2 → 8.0.0-beta.1

package/fesm/controllers/translation.controller.js

@@ -1,185 +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, TRANSLATION_PERMISSIONS } from '@flusys/nestjs-shared/classes';
-import { CurrentUser, RequirePermission } from '@flusys/nestjs-shared/decorators';
-import { JwtAuthGuard, PermissionGuard } from '@flusys/nestjs-shared/guards';
-import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
-import { Body, Controller, Inject, Post, UseGuards } from '@nestjs/common';
-import { ApiBearerAuth, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
-import { TRANSLATION_MESSAGES } from '../config';
-import { BulkUpdateTranslationsDto, CreateTranslationDto, GetTranslationsByLanguageDto, TranslationResponseDto, UpdateTranslationDto } from '../dtos';
-import { TranslationService } from '../services';
-export class TranslationController extends createApiController(CreateTranslationDto, UpdateTranslationDto, TranslationResponseDto, {
-    entityName: 'translation',
-    security: {
-        insert: {
-            level: 'permission',
-            permissions: [
-                TRANSLATION_PERMISSIONS.CREATE
-            ]
-        },
-        insertMany: {
-            level: 'permission',
-            permissions: [
-                TRANSLATION_PERMISSIONS.CREATE
-            ]
-        },
-        getById: {
-            level: 'permission',
-            permissions: [
-                TRANSLATION_PERMISSIONS.READ
-            ]
-        },
-        getAll: {
-            level: 'permission',
-            permissions: [
-                TRANSLATION_PERMISSIONS.READ
-            ]
-        },
-        update: {
-            level: 'permission',
-            permissions: [
-                TRANSLATION_PERMISSIONS.UPDATE
-            ]
-        },
-        updateMany: {
-            level: 'permission',
-            permissions: [
-                TRANSLATION_PERMISSIONS.UPDATE
-            ]
-        },
-        delete: {
-            level: 'permission',
-            permissions: [
-                TRANSLATION_PERMISSIONS.DELETE
-            ]
-        }
-    }
-}) {
-    async getByLanguage(body) {
-        const data = await this.service.getByLanguageCode(body.languageCode, body.modules);
-        return {
-            success: true,
-            message: 'Translations retrieved successfully',
-            messageKey: TRANSLATION_MESSAGES.BY_LANGUAGE_SUCCESS,
-            data
-        };
-    }
-    async updateManyValues(body, _user) {
-        const data = await this.service.bulkUpdate(body.translations);
-        return {
-            success: true,
-            message: `${data.length} translations updated`,
-            messageKey: TRANSLATION_MESSAGES.UPDATE_MANY_SUCCESS,
-            messageVariables: {
-                count: data.length
-            },
-            data,
-            meta: {
-                count: data.length
-            }
-        };
-    }
-    async getCounts(_user) {
-        const data = await this.service.getTranslationCounts();
-        return {
-            success: true,
-            message: 'Translation counts retrieved successfully',
-            messageKey: TRANSLATION_MESSAGES.GET_ALL_SUCCESS,
-            data
-        };
-    }
-    constructor(service){
-        super(service), _define_property(this, "service", void 0), this.service = service;
-    }
-}
-_ts_decorate([
-    Post('get-by-language'),
-    ApiOperation({
-        summary: 'Get translations for a language (optionally filtered by modules)'
-    }),
-    ApiResponse({
-        status: 200
-    }),
-    _ts_param(0, Body()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof GetTranslationsByLanguageDto === "undefined" ? Object : GetTranslationsByLanguageDto
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], TranslationController.prototype, "getByLanguage", null);
-_ts_decorate([
-    Post('update-many-values'),
-    UseGuards(JwtAuthGuard, PermissionGuard),
-    ApiBearerAuth(),
-    RequirePermission(TRANSLATION_PERMISSIONS.UPDATE),
-    ApiOperation({
-        summary: 'Bulk update translation values'
-    }),
-    ApiResponse({
-        status: 200,
-        type: [
-            TranslationResponseDto
-        ]
-    }),
-    _ts_param(0, Body()),
-    _ts_param(1, CurrentUser()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof BulkUpdateTranslationsDto === "undefined" ? Object : BulkUpdateTranslationsDto,
-        typeof ILoggedUserInfo === "undefined" ? Object : ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], TranslationController.prototype, "updateManyValues", null);
-_ts_decorate([
-    Post('get-counts'),
-    UseGuards(JwtAuthGuard, PermissionGuard),
-    ApiBearerAuth(),
-    RequirePermission(TRANSLATION_PERMISSIONS.READ),
-    ApiOperation({
-        summary: 'Get translation counts per translation key'
-    }),
-    ApiResponse({
-        status: 200
-    }),
-    _ts_param(0, CurrentUser()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof ILoggedUserInfo === "undefined" ? Object : ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], TranslationController.prototype, "getCounts", null);
-TranslationController = _ts_decorate([
-    ApiTags('Localization - Translation'),
-    Controller('localization/translation'),
-    _ts_param(0, Inject(TranslationService)),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof TranslationService === "undefined" ? Object : TranslationService
-    ])
-], TranslationController);

package/fesm/controllers/translation.controller.spec.js

@@ -1,165 +0,0 @@
-import { Test } from '@nestjs/testing';
-import { UtilsService } from '@flusys/nestjs-shared/modules';
-import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
-import { TranslationController } from './translation.controller';
-import { TranslationService } from '../services';
-function buildTranslation(overrides = {}) {
-    return {
-        id: 'translation-1',
-        languageId: 'lang-en',
-        translationKeyId: 'tkey-1',
-        value: 'Login successful',
-        isVerified: false,
-        isActive: true,
-        createdAt: new Date(),
-        updatedAt: new Date(),
-        deletedAt: null,
-        createdById: null,
-        updatedById: null,
-        deletedById: null,
-        ...overrides
-    };
-}
-describe('TranslationController', ()=>{
-    let controller;
-    let mockService;
-    beforeEach(async ()=>{
-        mockService = {
-            insert: jest.fn(),
-            findById: jest.fn(),
-            getAll: jest.fn(),
-            update: jest.fn(),
-            delete: jest.fn(),
-            getByLanguageCode: jest.fn(),
-            bulkUpdate: jest.fn(),
-            getTranslationCounts: jest.fn()
-        };
-        const module = await Test.createTestingModule({
-            controllers: [
-                TranslationController
-            ],
-            providers: [
-                {
-                    provide: TranslationService,
-                    useValue: mockService
-                },
-                {
-                    provide: UtilsService,
-                    useValue: {}
-                }
-            ]
-        }).compile();
-        controller = module.get(TranslationController);
-    });
-    describe('getByLanguage', ()=>{
-        it('returns the translations map for the requested language and modules', async ()=>{
-            mockService.getByLanguageCode.mockResolvedValue({
-                'auth.login.success': 'Login successful'
-            });
-            const result = await controller.getByLanguage({
-                languageCode: 'en',
-                modules: [
-                    'auth'
-                ]
-            });
-            expect(mockService.getByLanguageCode).toHaveBeenCalledWith('en', [
-                'auth'
-            ]);
-            expect(result).toEqual({
-                success: true,
-                message: 'Translations retrieved successfully',
-                messageKey: 'translation.by.language.success',
-                data: {
-                    'auth.login.success': 'Login successful'
-                }
-            });
-        });
-        it('returns an empty map (fallback) for an unknown language code without throwing', async ()=>{
-            mockService.getByLanguageCode.mockResolvedValue({});
-            const result = await controller.getByLanguage({
-                languageCode: 'xx'
-            });
-            expect(result.success).toBe(true);
-            expect(result.data).toEqual({});
-        });
-        it('requests translations for all modules when modules is omitted', async ()=>{
-            mockService.getByLanguageCode.mockResolvedValue({});
-            await controller.getByLanguage({
-                languageCode: 'en'
-            });
-            expect(mockService.getByLanguageCode).toHaveBeenCalledWith('en', undefined);
-        });
-    });
-    describe('updateManyValues', ()=>{
-        it('bulk updates translations and reports the updated count', async ()=>{
-            const updated = [
-                buildTranslation(),
-                buildTranslation({
-                    id: 'translation-2'
-                })
-            ];
-            mockService.bulkUpdate.mockResolvedValue(updated);
-            const result = await controller.updateManyValues({
-                translations: [
-                    {
-                        languageId: 'lang-en',
-                        translationKeyId: 'tkey-1',
-                        value: 'Login successful'
-                    }
-                ]
-            }, buildMockUser());
-            expect(result).toEqual({
-                success: true,
-                message: '2 translations updated',
-                messageKey: 'translation.update.many.success',
-                messageVariables: {
-                    count: 2
-                },
-                data: updated,
-                meta: {
-                    count: 2
-                }
-            });
-        });
-        it('reports zero updates for an empty batch without calling the service twice', async ()=>{
-            mockService.bulkUpdate.mockResolvedValue([]);
-            const result = await controller.updateManyValues({
-                translations: []
-            }, buildMockUser());
-            expect(mockService.bulkUpdate).toHaveBeenCalledTimes(1);
-            expect(result.meta).toEqual({
-                count: 0
-            });
-            expect(result.message).toBe('0 translations updated');
-        });
-        it('propagates errors raised during the bulk transaction (e.g. rollback surfaced as a rejection)', async ()=>{
-            mockService.bulkUpdate.mockRejectedValue(new Error('transaction rolled back'));
-            await expect(controller.updateManyValues({
-                translations: []
-            }, buildMockUser())).rejects.toThrow('transaction rolled back');
-        });
-    });
-    describe('getCounts', ()=>{
-        it('returns translation counts keyed by translation key id', async ()=>{
-            mockService.getTranslationCounts.mockResolvedValue({
-                'tkey-1': 3,
-                'tkey-2': 1
-            });
-            const result = await controller.getCounts(buildMockUser());
-            expect(result).toEqual({
-                success: true,
-                message: 'Translation counts retrieved successfully',
-                messageKey: 'translation.get.all.success',
-                data: {
-                    'tkey-1': 3,
-                    'tkey-2': 1
-                }
-            });
-        });
-        it('returns an empty object when there are no translations yet', async ()=>{
-            mockService.getTranslationCounts.mockResolvedValue({});
-            const result = await controller.getCounts(buildMockUser());
-            expect(result.data).toEqual({});
-        });
-    });
-});

package/fesm/docs/localization-swagger.config.js

@@ -1,101 +0,0 @@
-export function localizationSwaggerConfig(bootstrapConfig) {
-    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: 'Localization API',
-        description: `
-## Localization API
-${multiTenantNote}
-
-Database-driven internationalization system. Manage languages, translation keys, and translations — all stored in the database and served via API.
-
-## Features
-
-### 🌐 Language Management
-- Create and manage languages with LTR/RTL direction support
-- Set a default language
-- Mark languages as readonly to protect seeded entries
-
-### 🔑 Translation Keys
-- Organize keys by module for lazy loading (e.g. \`auth\`, \`iam\`, \`common\`)
-- Dot-case naming convention: \`auth.login.title\`, \`common.button.save\`
-- Support for interpolation variables: \`['count', 'name']\`
-- Readonly protection — system keys cannot be deleted or have their key/module changed
-
-### 📝 Translations
-- Store translated values per language per key
-- Mark translations as verified
-- Bulk upsert in a single transaction — create or update in one call
-- Detect missing translations for a given language
-- Track translation counts per key
-
-### 🚀 Angular Lazy Loading
-- Public endpoints return flat key-value maps: \`{ "auth.login.title": "Sign In" }\`
-- Filter by one or multiple modules to load only what is needed
-- No authentication required for translation retrieval endpoints
-
-## Key Naming Convention
-
-Translation keys use dot-case and must be unique per module:
-
-\`\`\`
-auth.login.title
-auth.login.submit
-auth.register.email.placeholder
-common.button.save
-common.button.cancel
-iam.role.create.success
-\`\`\`
-
-## Module-Based Lazy Loading
-
-Keys are grouped by \`module\` so the frontend loads translations on demand:
-
-| Module | Purpose |
-|--------|---------|
-| auth | Login, register, profile pages |
-| iam | Roles, permissions management |
-| storage | Files and folders |
-| event-manager | Calendar events |
-| form-builder | Dynamic form fields |
-| notification | Notification titles and messages |
-| email | Email template content |
-| common | Shared labels used across modules |
-
-## Public vs Authenticated Endpoints
-
-**Public** (no auth required — used by Angular to load translations):
-- POST /localization/language/get-active
-- POST /localization/language/get-default
-- POST /localization/translation/get-by-language
-- POST /localization/translation/get-by-module
-
-**Authenticated** (require JWT + permission):
-- All create, update, delete operations
-- get-missing, get-counts, update-many-values
-
-## Bulk Update
-
-POST /localization/translation/update-many-values accepts an array of translation objects. Each item is either an upsert (provide **id** to update, omit to create). The entire batch runs in a single database transaction.
-
-## Readonly Protection
-
-Languages and translation keys with \`isReadonly: true\` are protected at the service layer:
-- Cannot be deleted
-- Key and module fields cannot be modified
-
-Use \`isReadonly\` to protect entries that are seeded at startup and should not be changed by users.
-
-## Getting Started
-
-1. **Authenticate**: Obtain JWT token from POST /auth/login
-2. **Create languages**: Add languages via POST /localization/language/insert
-3. **Seed translation keys**: Bulk insert keys via POST /localization/translation-key/insert-many
-4. **Add translations**: Use POST /localization/translation/update-many-values for bulk upsert
-5. **Load in Angular**: Call POST /localization/translation/get-by-language with { languageCode: "en", modules: ["auth"] }
-    `,
-        version: '1.0',
-        path: 'api/docs/localization',
-        bearerAuth: true
-    };
-}

package/fesm/docs/localization-swagger.config.spec.js

@@ -1,26 +0,0 @@
-import { localizationSwaggerConfig } from './localization-swagger.config';
-describe('localizationSwaggerConfig', ()=>{
-    it('should build a static config with no multi-tenant note by default', ()=>{
-        const config = localizationSwaggerConfig();
-        expect(config.title).toBe('Localization API');
-        expect(config.path).toBe('api/docs/localization');
-        expect(config.bearerAuth).toBe(true);
-        expect(config.description).not.toContain('Multi-Tenant Mode');
-    });
-    it('should include the multi-tenant note only for multi-tenant database mode', ()=>{
-        const multiTenant = localizationSwaggerConfig({
-            databaseMode: 'multi-tenant'
-        });
-        const single = localizationSwaggerConfig({
-            databaseMode: 'single'
-        });
-        expect(multiTenant.description).toContain('Multi-Tenant Mode');
-        expect(single.description).not.toContain('Multi-Tenant Mode');
-    });
-    it('should treat any non-"multi-tenant" value as single-database mode', ()=>{
-        const config = localizationSwaggerConfig({
-            databaseMode: 'unexpected-value'
-        });
-        expect(config.description).not.toContain('Multi-Tenant Mode');
-    });
-});

package/fesm/dtos/language.dto.js

@@ -1,192 +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, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
-import { Exclude, Expose, Transform } from 'class-transformer';
-import { IsBoolean, IsIn, IsNumber, IsOptional, IsString, IsUUID, MaxLength } from 'class-validator';
-export class CreateLanguageDto {
-    constructor(){
-        _define_property(this, "code", void 0);
-        _define_property(this, "name", void 0);
-        _define_property(this, "nativeName", void 0);
-        _define_property(this, "direction", void 0);
-        _define_property(this, "isActive", void 0);
-        _define_property(this, "isDefault", void 0);
-        _define_property(this, "serial", void 0);
-    }
-}
-_ts_decorate([
-    IsString(),
-    MaxLength(10),
-    Transform(({ value })=>value?.trim()?.toLowerCase()),
-    ApiProperty({
-        example: 'en',
-        description: 'Language code (ISO 639-1)'
-    }),
-    _ts_metadata("design:type", String)
-], CreateLanguageDto.prototype, "code", void 0);
-_ts_decorate([
-    IsString(),
-    MaxLength(100),
-    Transform(({ value })=>value?.trim()),
-    ApiProperty({
-        example: 'English',
-        description: 'Language name'
-    }),
-    _ts_metadata("design:type", String)
-], CreateLanguageDto.prototype, "name", void 0);
-_ts_decorate([
-    IsOptional(),
-    IsString(),
-    MaxLength(100),
-    Transform(({ value })=>value?.trim()),
-    ApiPropertyOptional({
-        example: 'English',
-        description: 'Native name of the language'
-    }),
-    _ts_metadata("design:type", String)
-], CreateLanguageDto.prototype, "nativeName", void 0);
-_ts_decorate([
-    IsOptional(),
-    IsIn([
-        'ltr',
-        'rtl'
-    ]),
-    ApiPropertyOptional({
-        example: 'ltr',
-        enum: [
-            'ltr',
-            'rtl'
-        ],
-        description: 'Text direction'
-    }),
-    _ts_metadata("design:type", String)
-], CreateLanguageDto.prototype, "direction", void 0);
-_ts_decorate([
-    IsOptional(),
-    IsBoolean(),
-    ApiPropertyOptional({
-        example: true,
-        description: 'Whether the language is active'
-    }),
-    _ts_metadata("design:type", Boolean)
-], CreateLanguageDto.prototype, "isActive", void 0);
-_ts_decorate([
-    IsOptional(),
-    IsBoolean(),
-    ApiPropertyOptional({
-        example: false,
-        description: 'Whether this is the default language'
-    }),
-    _ts_metadata("design:type", Boolean)
-], CreateLanguageDto.prototype, "isDefault", void 0);
-_ts_decorate([
-    IsOptional(),
-    IsNumber(),
-    ApiPropertyOptional({
-        example: 1,
-        description: 'Display order'
-    }),
-    _ts_metadata("design:type", Number)
-], CreateLanguageDto.prototype, "serial", void 0);
-export class UpdateLanguageDto extends PartialType(CreateLanguageDto) {
-    constructor(...args){
-        super(...args), _define_property(this, "id", void 0);
-    }
-}
-_ts_decorate([
-    IsUUID(),
-    ApiProperty({
-        description: 'Language ID'
-    }),
-    _ts_metadata("design:type", String)
-], UpdateLanguageDto.prototype, "id", void 0);
-export class LanguageResponseDto extends IdentityResponseDto {
-    constructor(...args){
-        super(...args), _define_property(this, "code", void 0), _define_property(this, "name", void 0), _define_property(this, "nativeName", void 0), _define_property(this, "direction", void 0), _define_property(this, "isActive", void 0), _define_property(this, "isDefault", void 0), _define_property(this, "isReadonly", void 0), _define_property(this, "serial", void 0);
-    }
-}
-_ts_decorate([
-    ApiProperty({
-        example: 'en'
-    }),
-    Expose(),
-    _ts_metadata("design:type", String)
-], LanguageResponseDto.prototype, "code", void 0);
-_ts_decorate([
-    ApiProperty({
-        example: 'English'
-    }),
-    Expose(),
-    _ts_metadata("design:type", String)
-], LanguageResponseDto.prototype, "name", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'English'
-    }),
-    Expose(),
-    _ts_metadata("design:type", Object)
-], LanguageResponseDto.prototype, "nativeName", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 'ltr',
-        enum: [
-            'ltr',
-            'rtl'
-        ]
-    }),
-    Expose(),
-    _ts_metadata("design:type", Object)
-], LanguageResponseDto.prototype, "direction", void 0);
-_ts_decorate([
-    ApiProperty({
-        example: true
-    }),
-    Expose(),
-    _ts_metadata("design:type", Boolean)
-], LanguageResponseDto.prototype, "isActive", void 0);
-_ts_decorate([
-    ApiProperty({
-        example: false
-    }),
-    Expose(),
-    _ts_metadata("design:type", Boolean)
-], LanguageResponseDto.prototype, "isDefault", void 0);
-_ts_decorate([
-    ApiProperty({
-        example: false,
-        description: 'System language: cannot be renamed or deleted'
-    }),
-    Expose(),
-    _ts_metadata("design:type", Boolean)
-], LanguageResponseDto.prototype, "isReadonly", void 0);
-_ts_decorate([
-    ApiPropertyOptional({
-        example: 1
-    }),
-    Expose(),
-    _ts_metadata("design:type", Object)
-], LanguageResponseDto.prototype, "serial", void 0);
-LanguageResponseDto = _ts_decorate([
-    Exclude()
-], LanguageResponseDto);