@flusys/nestjs-localization 4.0.0-rc

package/cjs/config/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./localization.constants"), exports);
+_export_star(require("./message-keys"), 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/config/localization.constants.js

@@ -0,0 +1,20 @@
+"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_LANGUAGE_CODE () {
+        return DEFAULT_LANGUAGE_CODE;
+    },
+    get LOCALIZATION_MODULE_OPTIONS () {
+        return LOCALIZATION_MODULE_OPTIONS;
+    }
+});
+const LOCALIZATION_MODULE_OPTIONS = 'LOCALIZATION_MODULE_OPTIONS';
+const DEFAULT_LANGUAGE_CODE = 'en';

package/cjs/config/message-keys.js

@@ -0,0 +1,77 @@
+// ==================== LOCALIZATION MODULE MESSAGE KEYS ====================
+"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 LANGUAGE_MESSAGES () {
+        return LANGUAGE_MESSAGES;
+    },
+    get LOCALIZATION_MODULE_MESSAGES () {
+        return LOCALIZATION_MODULE_MESSAGES;
+    },
+    get TRANSLATION_KEY_MESSAGES () {
+        return TRANSLATION_KEY_MESSAGES;
+    },
+    get TRANSLATION_MESSAGES () {
+        return TRANSLATION_MESSAGES;
+    }
+});
+const LANGUAGE_MESSAGES = {
+    CREATE_SUCCESS: 'language.create.success',
+    CREATE_MANY_SUCCESS: 'language.create.many.success',
+    GET_SUCCESS: 'language.get.success',
+    GET_ALL_SUCCESS: 'language.get.all.success',
+    UPDATE_SUCCESS: 'language.update.success',
+    UPDATE_MANY_SUCCESS: 'language.update.many.success',
+    DELETE_SUCCESS: 'language.delete.success',
+    RESTORE_SUCCESS: 'language.restore.success',
+    NOT_FOUND: 'language.not.found',
+    ACTIVE_SUCCESS: 'language.active.success',
+    SET_DEFAULT_SUCCESS: 'language.set.default.success',
+    GET_DEFAULT_SUCCESS: 'language.get.default.success'
+};
+const TRANSLATION_KEY_MESSAGES = {
+    CREATE_SUCCESS: 'translation.key.create.success',
+    CREATE_MANY_SUCCESS: 'translation.key.create.many.success',
+    GET_SUCCESS: 'translation.key.get.success',
+    GET_ALL_SUCCESS: 'translation.key.get.all.success',
+    UPDATE_SUCCESS: 'translation.key.update.success',
+    UPDATE_MANY_SUCCESS: 'translation.key.update.many.success',
+    DELETE_SUCCESS: 'translation.key.delete.success',
+    RESTORE_SUCCESS: 'translation.key.restore.success',
+    NOT_FOUND: 'translation.key.not.found',
+    IMPORT_SUCCESS: 'translation.key.import.success',
+    EXPORT_SUCCESS: 'translation.key.export.success',
+    MODULES_SUCCESS: 'translation.key.modules.success',
+    READONLY_DELETE_FORBIDDEN: 'translation.key.readonly.delete.forbidden',
+    READONLY_UPDATE_FORBIDDEN: 'translation.key.readonly.update.forbidden',
+    DUPLICATE_KEY_IN_MODULE: 'translation.key.duplicate.key.in.module'
+};
+const TRANSLATION_MESSAGES = {
+    CREATE_SUCCESS: 'translation.create.success',
+    CREATE_MANY_SUCCESS: 'translation.create.many.success',
+    GET_SUCCESS: 'translation.get.success',
+    GET_ALL_SUCCESS: 'translation.get.all.success',
+    UPDATE_SUCCESS: 'translation.update.success',
+    UPDATE_MANY_SUCCESS: 'translation.update.many.success',
+    DELETE_SUCCESS: 'translation.delete.success',
+    RESTORE_SUCCESS: 'translation.restore.success',
+    NOT_FOUND: 'translation.not.found',
+    BY_LANGUAGE_SUCCESS: 'translation.by.language.success',
+    BY_MODULE_SUCCESS: 'translation.by.module.success',
+    MISSING_SUCCESS: 'translation.missing.success',
+    SYNC_SUCCESS: 'translation.sync.success',
+    UPDATE_VALUES_SUCCESS: 'translation.update.values.success'
+};
+const LOCALIZATION_MODULE_MESSAGES = {
+    LANGUAGE: LANGUAGE_MESSAGES,
+    TRANSLATION_KEY: TRANSLATION_KEY_MESSAGES,
+    TRANSLATION: TRANSLATION_MESSAGES
+};

package/cjs/controllers/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./language.controller"), exports);
+_export_star(require("./translation-key.controller"), exports);
+_export_star(require("./translation.controller"), 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/controllers/language.controller.js

@@ -0,0 +1,188 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "LanguageController", {
+    enumerable: true,
+    get: function() {
+        return LanguageController;
+    }
+});
+const _classes = require("@flusys/nestjs-shared/classes");
+const _decorators = require("@flusys/nestjs-shared/decorators");
+const _config = require("../config");
+const _guards = require("@flusys/nestjs-shared/guards");
+const _interfaces = require("@flusys/nestjs-shared/interfaces");
+const _common = require("@nestjs/common");
+const _swagger = require("@nestjs/swagger");
+const _dtos = require("../dtos");
+const _services = require("../services");
+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);
+    };
+}
+let LanguageController = class LanguageController extends (0, _classes.createApiController)(_dtos.CreateLanguageDto, _dtos.UpdateLanguageDto, _dtos.LanguageResponseDto, {
+    entityName: 'language',
+    security: {
+        insert: {
+            level: 'permission',
+            permissions: [
+                _classes.LANGUAGE_PERMISSIONS.CREATE
+            ]
+        },
+        insertMany: {
+            level: 'permission',
+            permissions: [
+                _classes.LANGUAGE_PERMISSIONS.CREATE
+            ]
+        },
+        getById: {
+            level: 'permission',
+            permissions: [
+                _classes.LANGUAGE_PERMISSIONS.READ
+            ]
+        },
+        getAll: {
+            level: 'permission',
+            permissions: [
+                _classes.LANGUAGE_PERMISSIONS.READ
+            ]
+        },
+        update: {
+            level: 'permission',
+            permissions: [
+                _classes.LANGUAGE_PERMISSIONS.UPDATE
+            ]
+        },
+        updateMany: {
+            level: 'permission',
+            permissions: [
+                _classes.LANGUAGE_PERMISSIONS.UPDATE
+            ]
+        },
+        delete: {
+            level: 'permission',
+            permissions: [
+                _classes.LANGUAGE_PERMISSIONS.DELETE
+            ]
+        }
+    }
+}) {
+    async getActive() {
+        const data = await this.service.getActiveLanguages();
+        return {
+            success: true,
+            message: 'Active languages retrieved successfully',
+            messageKey: _config.LANGUAGE_MESSAGES.ACTIVE_SUCCESS,
+            data,
+            meta: {
+                total: data.length,
+                page: 0,
+                pageSize: data.length,
+                count: data.length
+            }
+        };
+    }
+    async getDefault() {
+        const data = await this.service.getDefaultLanguage();
+        return {
+            success: true,
+            message: 'Default language retrieved successfully',
+            messageKey: _config.LANGUAGE_MESSAGES.GET_DEFAULT_SUCCESS,
+            data: data ?? undefined
+        };
+    }
+    async setDefault(body, _user) {
+        const data = await this.service.setAsDefault(body.id);
+        return {
+            success: true,
+            message: 'Default language updated successfully',
+            messageKey: _config.LANGUAGE_MESSAGES.SET_DEFAULT_SUCCESS,
+            data: data ?? undefined
+        };
+    }
+    constructor(service){
+        super(service), _define_property(this, "service", void 0), this.service = service;
+    }
+};
+_ts_decorate([
+    (0, _common.Post)('get-active'),
+    (0, _swagger.ApiOperation)({
+        summary: 'Get all active languages'
+    }),
+    (0, _swagger.ApiResponse)({
+        status: 200,
+        type: [
+            _dtos.LanguageResponseDto
+        ]
+    }),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", []),
+    _ts_metadata("design:returntype", Promise)
+], LanguageController.prototype, "getActive", null);
+_ts_decorate([
+    (0, _common.Post)('get-default'),
+    (0, _swagger.ApiOperation)({
+        summary: 'Get default language'
+    }),
+    (0, _swagger.ApiResponse)({
+        status: 200,
+        type: _dtos.LanguageResponseDto
+    }),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", []),
+    _ts_metadata("design:returntype", Promise)
+], LanguageController.prototype, "getDefault", null);
+_ts_decorate([
+    (0, _common.Post)('set-default'),
+    (0, _common.UseGuards)(_guards.JwtAuthGuard),
+    (0, _swagger.ApiBearerAuth)(),
+    (0, _decorators.RequirePermission)(_classes.LANGUAGE_PERMISSIONS.UPDATE),
+    (0, _swagger.ApiOperation)({
+        summary: 'Set a language as default'
+    }),
+    (0, _swagger.ApiResponse)({
+        status: 200,
+        type: _dtos.LanguageResponseDto
+    }),
+    _ts_param(0, (0, _common.Body)()),
+    _ts_param(1, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        Object,
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], LanguageController.prototype, "setDefault", null);
+LanguageController = _ts_decorate([
+    (0, _swagger.ApiTags)('Localization - Language'),
+    (0, _common.Controller)('localization/language'),
+    _ts_param(0, (0, _common.Inject)(_services.LanguageService)),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _services.LanguageService === "undefined" ? Object : _services.LanguageService
+    ])
+], LanguageController);

package/cjs/controllers/translation-key.controller.js

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "TranslationKeyController", {
+    enumerable: true,
+    get: function() {
+        return TranslationKeyController;
+    }
+});
+const _classes = require("@flusys/nestjs-shared/classes");
+const _decorators = require("@flusys/nestjs-shared/decorators");
+const _config = require("../config");
+const _guards = require("@flusys/nestjs-shared/guards");
+const _interfaces = require("@flusys/nestjs-shared/interfaces");
+const _common = require("@nestjs/common");
+const _swagger = require("@nestjs/swagger");
+const _dtos = require("../dtos");
+const _services = require("../services");
+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);
+    };
+}
+let TranslationKeyController = class TranslationKeyController extends (0, _classes.createApiController)(_dtos.CreateTranslationKeyDto, _dtos.UpdateTranslationKeyDto, _dtos.TranslationKeyResponseDto, {
+    entityName: 'translationKey',
+    security: {
+        insert: {
+            level: 'permission',
+            permissions: [
+                _classes.TRANSLATION_KEY_PERMISSIONS.CREATE
+            ]
+        },
+        insertMany: {
+            level: 'permission',
+            permissions: [
+                _classes.TRANSLATION_KEY_PERMISSIONS.CREATE
+            ]
+        },
+        getById: {
+            level: 'permission',
+            permissions: [
+                _classes.TRANSLATION_KEY_PERMISSIONS.READ
+            ]
+        },
+        getAll: {
+            level: 'permission',
+            permissions: [
+                _classes.TRANSLATION_KEY_PERMISSIONS.READ
+            ]
+        },
+        update: {
+            level: 'permission',
+            permissions: [
+                _classes.TRANSLATION_KEY_PERMISSIONS.UPDATE
+            ]
+        },
+        updateMany: {
+            level: 'permission',
+            permissions: [
+                _classes.TRANSLATION_KEY_PERMISSIONS.UPDATE
+            ]
+        },
+        delete: {
+            level: 'permission',
+            permissions: [
+                _classes.TRANSLATION_KEY_PERMISSIONS.DELETE
+            ]
+        }
+    }
+}) {
+    async getModules(_user) {
+        const data = await this.service.getModules();
+        return {
+            success: true,
+            message: 'Modules retrieved successfully',
+            messageKey: _config.TRANSLATION_KEY_MESSAGES.MODULES_SUCCESS,
+            data
+        };
+    }
+    async getByModule(body, _user) {
+        const data = await this.service.findByModule(body.module);
+        return {
+            success: true,
+            message: 'Translation keys retrieved successfully',
+            messageKey: _config.TRANSLATION_KEY_MESSAGES.GET_ALL_SUCCESS,
+            data,
+            meta: {
+                total: data.length,
+                page: 0,
+                pageSize: data.length,
+                count: data.length
+            }
+        };
+    }
+    constructor(service){
+        super(service), _define_property(this, "service", void 0), this.service = service;
+    }
+};
+_ts_decorate([
+    (0, _common.Post)('get-modules'),
+    (0, _common.UseGuards)(_guards.JwtAuthGuard),
+    (0, _swagger.ApiBearerAuth)(),
+    (0, _decorators.RequirePermission)(_classes.TRANSLATION_KEY_PERMISSIONS.READ),
+    (0, _swagger.ApiOperation)({
+        summary: 'Get all distinct module names'
+    }),
+    (0, _swagger.ApiResponse)({
+        status: 200,
+        type: [
+            String
+        ]
+    }),
+    _ts_param(0, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], TranslationKeyController.prototype, "getModules", null);
+_ts_decorate([
+    (0, _common.Post)('get-by-module'),
+    (0, _common.UseGuards)(_guards.JwtAuthGuard),
+    (0, _swagger.ApiBearerAuth)(),
+    (0, _decorators.RequirePermission)(_classes.TRANSLATION_KEY_PERMISSIONS.READ),
+    (0, _swagger.ApiOperation)({
+        summary: 'Get translation keys by module'
+    }),
+    (0, _swagger.ApiResponse)({
+        status: 200,
+        type: [
+            _dtos.TranslationKeyResponseDto
+        ]
+    }),
+    _ts_param(0, (0, _common.Body)()),
+    _ts_param(1, (0, _decorators.CurrentUser)()),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _dtos.GetByModuleDto === "undefined" ? Object : _dtos.GetByModuleDto,
+        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
+    ]),
+    _ts_metadata("design:returntype", Promise)
+], TranslationKeyController.prototype, "getByModule", null);
+TranslationKeyController = _ts_decorate([
+    (0, _swagger.ApiTags)('Localization - Translation Key'),
+    (0, _common.Controller)('localization/translation-key'),
+    _ts_param(0, (0, _common.Inject)(_services.TranslationKeyService)),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _services.TranslationKeyService === "undefined" ? Object : _services.TranslationKeyService
+    ])
+], TranslationKeyController);