@flusys/nestjs-localization 4.0.0-rc

package/fesm/controllers/translation.controller.js

@@ -0,0 +1,244 @@
+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 { TRANSLATION_MESSAGES } from '../config';
+import { JwtAuthGuard } 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 { BulkUpdateTranslationsDto, CreateTranslationDto, GetTranslationsByLanguageDto, GetTranslationsByModuleDto, 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 getByModule(body) {
+        const data = await this.service.getByModuleAndLanguage(body.module, body.languageCode);
+        return {
+            success: true,
+            message: 'Translations by module retrieved successfully',
+            messageKey: TRANSLATION_MESSAGES.BY_MODULE_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 getMissing(body, _user) {
+        const data = await this.service.getMissingTranslations(body.languageCode);
+        return {
+            success: true,
+            message: 'Missing translations retrieved successfully',
+            messageKey: TRANSLATION_MESSAGES.MISSING_SUCCESS,
+            data,
+            meta: {
+                total: data.length,
+                page: 0,
+                pageSize: data.length,
+                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('get-by-module'),
+    ApiOperation({
+        summary: 'Get translations by module and language'
+    }),
+    ApiResponse({
+        status: 200
+    }),
+    _ts_param(0, Body()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof GetTranslationsByModuleDto === "undefined" ? Object : GetTranslationsByModuleDto
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], TranslationController.prototype, "getByModule", null);
+_ts_decorate([
+    Post('update-many-values'),
+    UseGuards(JwtAuthGuard),
+    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-missing'),
+    UseGuards(JwtAuthGuard),
+    ApiBearerAuth(),
+    RequirePermission(TRANSLATION_PERMISSIONS.READ),
+    ApiOperation({
+        summary: 'Get translation keys missing translations for a language'
+    }),
+    ApiResponse({
+        status: 200
+    }),
+    _ts_param(0, Body()),
+    _ts_param(1, CurrentUser()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof GetTranslationsByLanguageDto === "undefined" ? Object : GetTranslationsByLanguageDto,
+        typeof ILoggedUserInfo === "undefined" ? Object : ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], TranslationController.prototype, "getMissing", null);
+_ts_decorate([
+    Post('get-counts'),
+    UseGuards(JwtAuthGuard),
+    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/dtos/index.js

@@ -0,0 +1,3 @@
+export * from './language.dto';
+export * from './translation-key.dto';
+export * from './translation.dto';

package/fesm/dtos/language.dto.js

@@ -0,0 +1,184 @@
+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, "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([
+    ApiPropertyOptional({
+        example: 1
+    }),
+    Expose(),
+    _ts_metadata("design:type", Object)
+], LanguageResponseDto.prototype, "serial", void 0);
+LanguageResponseDto = _ts_decorate([
+    Exclude()
+], LanguageResponseDto);

package/fesm/dtos/translation-key.dto.js

@@ -0,0 +1,209 @@
+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, OmitType, PartialType } from '@nestjs/swagger';
+import { Exclude, Expose, Transform } from 'class-transformer';
+import { IsArray, IsBoolean, IsNumber, IsOptional, IsString, IsUUID, MaxLength } from 'class-validator';
+export class CreateTranslationKeyDto {
+    constructor(){
+        _define_property(this, "module", void 0);
+        _define_property(this, "key", void 0);
+        _define_property(this, "defaultMessage", void 0);
+        _define_property(this, "description", void 0);
+        _define_property(this, "variables", void 0);
+        _define_property(this, "isActive", void 0);
+        _define_property(this, "isReadonly", void 0);
+        _define_property(this, "serial", void 0);
+    }
+}
+_ts_decorate([
+    IsString(),
+    MaxLength(100),
+    Transform(({ value })=>value?.trim()?.toLowerCase()),
+    ApiProperty({
+        example: 'auth',
+        description: 'Module name'
+    }),
+    _ts_metadata("design:type", String)
+], CreateTranslationKeyDto.prototype, "module", void 0);
+_ts_decorate([
+    IsString(),
+    MaxLength(255),
+    Transform(({ value })=>value?.trim()),
+    ApiProperty({
+        example: 'auth.login.success',
+        description: 'Translation key'
+    }),
+    _ts_metadata("design:type", String)
+], CreateTranslationKeyDto.prototype, "key", void 0);
+_ts_decorate([
+    IsString(),
+    MaxLength(500),
+    Transform(({ value })=>value?.trim()),
+    ApiProperty({
+        example: 'Login successful',
+        description: 'Default English message'
+    }),
+    _ts_metadata("design:type", String)
+], CreateTranslationKeyDto.prototype, "defaultMessage", void 0);
+_ts_decorate([
+    IsOptional(),
+    IsString(),
+    Transform(({ value })=>value?.trim()),
+    ApiPropertyOptional({
+        description: 'Developer notes'
+    }),
+    _ts_metadata("design:type", String)
+], CreateTranslationKeyDto.prototype, "description", void 0);
+_ts_decorate([
+    IsOptional(),
+    IsArray(),
+    IsString({
+        each: true
+    }),
+    ApiPropertyOptional({
+        example: [
+            'name'
+        ],
+        description: 'Variable names used in the message'
+    }),
+    _ts_metadata("design:type", Array)
+], CreateTranslationKeyDto.prototype, "variables", void 0);
+_ts_decorate([
+    IsOptional(),
+    IsBoolean(),
+    ApiPropertyOptional({
+        example: true
+    }),
+    _ts_metadata("design:type", Boolean)
+], CreateTranslationKeyDto.prototype, "isActive", void 0);
+_ts_decorate([
+    IsOptional(),
+    IsBoolean(),
+    ApiPropertyOptional({
+        example: false,
+        description: 'Readonly keys cannot be deleted by users'
+    }),
+    _ts_metadata("design:type", Boolean)
+], CreateTranslationKeyDto.prototype, "isReadonly", void 0);
+_ts_decorate([
+    IsOptional(),
+    IsNumber(),
+    ApiPropertyOptional({
+        example: 1
+    }),
+    _ts_metadata("design:type", Number)
+], CreateTranslationKeyDto.prototype, "serial", void 0);
+export class UpdateTranslationKeyDto extends PartialType(OmitType(CreateTranslationKeyDto, [
+    'isReadonly'
+])) {
+    constructor(...args){
+        super(...args), _define_property(this, "id", void 0);
+    }
+}
+_ts_decorate([
+    IsUUID(),
+    ApiProperty({
+        description: 'Translation key ID'
+    }),
+    _ts_metadata("design:type", String)
+], UpdateTranslationKeyDto.prototype, "id", void 0);
+export class TranslationKeyResponseDto extends IdentityResponseDto {
+    constructor(...args){
+        super(...args), _define_property(this, "module", void 0), _define_property(this, "key", void 0), _define_property(this, "defaultMessage", void 0), _define_property(this, "description", void 0), _define_property(this, "variables", void 0), _define_property(this, "isActive", void 0), _define_property(this, "isReadonly", void 0), _define_property(this, "serial", void 0);
+    }
+}
+_ts_decorate([
+    ApiProperty({
+        example: 'auth'
+    }),
+    Expose(),
+    _ts_metadata("design:type", String)
+], TranslationKeyResponseDto.prototype, "module", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: 'auth.login.success'
+    }),
+    Expose(),
+    _ts_metadata("design:type", String)
+], TranslationKeyResponseDto.prototype, "key", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: 'Login successful'
+    }),
+    Expose(),
+    _ts_metadata("design:type", String)
+], TranslationKeyResponseDto.prototype, "defaultMessage", void 0);
+_ts_decorate([
+    ApiPropertyOptional(),
+    Expose(),
+    _ts_metadata("design:type", Object)
+], TranslationKeyResponseDto.prototype, "description", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: [
+            'name'
+        ]
+    }),
+    Expose(),
+    _ts_metadata("design:type", Object)
+], TranslationKeyResponseDto.prototype, "variables", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: true
+    }),
+    Expose(),
+    _ts_metadata("design:type", Boolean)
+], TranslationKeyResponseDto.prototype, "isActive", void 0);
+_ts_decorate([
+    ApiProperty({
+        example: false
+    }),
+    Expose(),
+    _ts_metadata("design:type", Boolean)
+], TranslationKeyResponseDto.prototype, "isReadonly", void 0);
+_ts_decorate([
+    ApiPropertyOptional({
+        example: 1
+    }),
+    Expose(),
+    _ts_metadata("design:type", Object)
+], TranslationKeyResponseDto.prototype, "serial", void 0);
+TranslationKeyResponseDto = _ts_decorate([
+    Exclude()
+], TranslationKeyResponseDto);
+export class GetByModuleDto {
+    constructor(){
+        _define_property(this, "module", void 0);
+    }
+}
+_ts_decorate([
+    IsString(),
+    MaxLength(100),
+    Transform(({ value })=>value?.trim()?.toLowerCase()),
+    ApiProperty({
+        example: 'auth',
+        description: 'Module name'
+    }),
+    _ts_metadata("design:type", String)
+], GetByModuleDto.prototype, "module", void 0);