@flusys/nestjs-localization 4.0.0-rc

package/cjs/entities/translation-key.entity.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "TranslationKey", {
+    enumerable: true,
+    get: function() {
+        return TranslationKey;
+    }
+});
+const _entities = require("@flusys/nestjs-shared/entities");
+const _typeorm = require("typeorm");
+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);
+}
+let TranslationKey = class TranslationKey extends _entities.Identity {
+    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), _define_property(this, "translations", void 0);
+    }
+};
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'varchar',
+        length: 100,
+        nullable: false
+    }),
+    _ts_metadata("design:type", String)
+], TranslationKey.prototype, "module", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'varchar',
+        length: 255,
+        nullable: false
+    }),
+    _ts_metadata("design:type", String)
+], TranslationKey.prototype, "key", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'varchar',
+        length: 500,
+        nullable: false,
+        name: 'default_message'
+    }),
+    _ts_metadata("design:type", String)
+], TranslationKey.prototype, "defaultMessage", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'text',
+        nullable: true
+    }),
+    _ts_metadata("design:type", Object)
+], TranslationKey.prototype, "description", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'simple-array',
+        nullable: true
+    }),
+    _ts_metadata("design:type", Object)
+], TranslationKey.prototype, "variables", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'boolean',
+        default: true,
+        name: 'is_active'
+    }),
+    _ts_metadata("design:type", Boolean)
+], TranslationKey.prototype, "isActive", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'boolean',
+        default: false,
+        name: 'is_readonly'
+    }),
+    _ts_metadata("design:type", Boolean)
+], TranslationKey.prototype, "isReadonly", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'int',
+        nullable: true
+    }),
+    _ts_metadata("design:type", Object)
+], TranslationKey.prototype, "serial", void 0);
+_ts_decorate([
+    (0, _typeorm.OneToMany)('Translation', 'translationKey'),
+    _ts_metadata("design:type", Array)
+], TranslationKey.prototype, "translations", void 0);
+TranslationKey = _ts_decorate([
+    (0, _typeorm.Entity)({
+        name: 'translation_key'
+    }),
+    (0, _typeorm.Index)([
+        'module'
+    ]),
+    (0, _typeorm.Index)([
+        'module',
+        'key'
+    ], {
+        unique: true
+    }),
+    (0, _typeorm.Index)([
+        'isActive'
+    ]),
+    (0, _typeorm.Index)([
+        'isReadonly'
+    ])
+], TranslationKey);

package/cjs/entities/translation.entity.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "Translation", {
+    enumerable: true,
+    get: function() {
+        return Translation;
+    }
+});
+const _entities = require("@flusys/nestjs-shared/entities");
+const _typeorm = require("typeorm");
+const _languageentity = require("./language.entity");
+const _translationkeyentity = require("./translation-key.entity");
+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);
+}
+let Translation = class Translation extends _entities.Identity {
+    constructor(...args){
+        super(...args), _define_property(this, "languageId", void 0), _define_property(this, "translationKeyId", void 0), _define_property(this, "value", void 0), _define_property(this, "isVerified", void 0), _define_property(this, "isActive", void 0), _define_property(this, "language", void 0), _define_property(this, "translationKey", void 0);
+    }
+};
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'uuid',
+        name: 'language_id',
+        nullable: false
+    }),
+    _ts_metadata("design:type", String)
+], Translation.prototype, "languageId", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'uuid',
+        name: 'translation_key_id',
+        nullable: false
+    }),
+    _ts_metadata("design:type", String)
+], Translation.prototype, "translationKeyId", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'text',
+        nullable: false
+    }),
+    _ts_metadata("design:type", String)
+], Translation.prototype, "value", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'boolean',
+        default: false,
+        name: 'is_verified'
+    }),
+    _ts_metadata("design:type", Boolean)
+], Translation.prototype, "isVerified", void 0);
+_ts_decorate([
+    (0, _typeorm.Column)({
+        type: 'boolean',
+        default: true,
+        name: 'is_active'
+    }),
+    _ts_metadata("design:type", Boolean)
+], Translation.prototype, "isActive", void 0);
+_ts_decorate([
+    (0, _typeorm.ManyToOne)(()=>_languageentity.Language, {
+        nullable: false,
+        onDelete: 'CASCADE'
+    }),
+    (0, _typeorm.JoinColumn)({
+        name: 'language_id'
+    }),
+    _ts_metadata("design:type", typeof _languageentity.Language === "undefined" ? Object : _languageentity.Language)
+], Translation.prototype, "language", void 0);
+_ts_decorate([
+    (0, _typeorm.ManyToOne)(()=>_translationkeyentity.TranslationKey, {
+        nullable: false,
+        onDelete: 'CASCADE'
+    }),
+    (0, _typeorm.JoinColumn)({
+        name: 'translation_key_id'
+    }),
+    _ts_metadata("design:type", typeof _translationkeyentity.TranslationKey === "undefined" ? Object : _translationkeyentity.TranslationKey)
+], Translation.prototype, "translationKey", void 0);
+Translation = _ts_decorate([
+    (0, _typeorm.Entity)({
+        name: 'translation'
+    }),
+    (0, _typeorm.Index)([
+        'languageId',
+        'translationKeyId'
+    ], {
+        unique: true
+    }),
+    (0, _typeorm.Index)([
+        'languageId'
+    ]),
+    (0, _typeorm.Index)([
+        'translationKeyId'
+    ]),
+    (0, _typeorm.Index)([
+        'isActive'
+    ])
+], Translation);

package/cjs/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./config"), exports);
+_export_star(require("./controllers"), exports);
+_export_star(require("./dtos"), exports);
+_export_star(require("./entities"), exports);
+_export_star(require("./interfaces"), exports);
+_export_star(require("./modules"), exports);
+_export_star(require("./services"), 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/interfaces/index.js

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

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/cjs/interfaces/localization-module-options.interface.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/cjs/interfaces/translation-key.interface.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/cjs/interfaces/translation.interface.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/cjs/modules/index.js

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

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "LocalizationModule", {
+    enumerable: true,
+    get: function() {
+        return LocalizationModule;
+    }
+});
+const _modules = require("@flusys/nestjs-shared/modules");
+const _common = require("@nestjs/common");
+const _localizationconstants = require("../config/localization.constants");
+const _controllers = require("../controllers");
+const _services = require("../services");
+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;
+}
+const CONTROLLERS = [
+    _controllers.LanguageController,
+    _controllers.TranslationKeyController,
+    _controllers.TranslationController
+];
+const EXPORTED_SERVICES = [
+    _services.LocalizationConfigService,
+    _services.LocalizationDataSourceProvider,
+    _services.LanguageService,
+    _services.TranslationKeyService,
+    _services.TranslationService
+];
+let LocalizationModule = class LocalizationModule {
+    static forRoot(options) {
+        return {
+            module: LocalizationModule,
+            global: options.global ?? false,
+            imports: [
+                _modules.CacheModule,
+                _modules.UtilsModule
+            ],
+            controllers: options.includeController !== false ? CONTROLLERS : [],
+            providers: this.buildProviders(options),
+            exports: EXPORTED_SERVICES
+        };
+    }
+    static forRootAsync(options) {
+        return {
+            module: LocalizationModule,
+            global: options.global ?? false,
+            imports: [
+                ...options.imports || [],
+                _modules.CacheModule,
+                _modules.UtilsModule
+            ],
+            controllers: options.includeController !== false ? CONTROLLERS : [],
+            providers: [
+                ...this.createAsyncProviders(options),
+                ...this.buildProviders()
+            ],
+            exports: EXPORTED_SERVICES
+        };
+    }
+    static buildProviders(options) {
+        const providers = [
+            ...EXPORTED_SERVICES
+        ];
+        if (options) {
+            providers.unshift({
+                provide: _localizationconstants.LOCALIZATION_MODULE_OPTIONS,
+                useValue: options
+            });
+        }
+        return providers;
+    }
+    static createAsyncProviders(options) {
+        if (options.useFactory) {
+            return [
+                {
+                    provide: _localizationconstants.LOCALIZATION_MODULE_OPTIONS,
+                    useFactory: async (...args)=>({
+                            ...options,
+                            config: await options.useFactory(...args)
+                        }),
+                    inject: options.inject || []
+                }
+            ];
+        }
+        const factoryClass = options.useClass || options.useExisting;
+        if (!factoryClass) return [];
+        const providers = [
+            {
+                provide: _localizationconstants.LOCALIZATION_MODULE_OPTIONS,
+                useFactory: async (factory)=>({
+                        ...options,
+                        config: await factory.createLocalizationOptions()
+                    }),
+                inject: [
+                    factoryClass
+                ]
+            }
+        ];
+        if (options.useClass) {
+            providers.push({
+                provide: options.useClass,
+                useClass: options.useClass
+            });
+        }
+        return providers;
+    }
+};
+LocalizationModule = _ts_decorate([
+    (0, _common.Module)({})
+], LocalizationModule);

package/cjs/services/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./localization-config.service"), exports);
+_export_star(require("./localization-datasource.provider"), exports);
+_export_star(require("./language.service"), exports);
+_export_star(require("./translation-key.service"), exports);
+_export_star(require("./translation.service"), 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/services/language.service.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "LanguageService", {
+    enumerable: true,
+    get: function() {
+        return LanguageService;
+    }
+});
+const _classes = require("@flusys/nestjs-shared/classes");
+const _modules = require("@flusys/nestjs-shared/modules");
+const _common = require("@nestjs/common");
+const _typeorm = require("typeorm");
+const _entities = require("../entities");
+const _localizationdatasourceprovider = require("./localization-datasource.provider");
+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 LanguageService = class LanguageService extends _classes.RequestScopedApiService {
+    resolveEntity() {
+        return _entities.Language;
+    }
+    getDataSourceProvider() {
+        return this.dataSourceProvider;
+    }
+    async getDefaultLanguage() {
+        await this.ensureRepositoryInitialized();
+        return this.repository.findOne({
+            where: {
+                isDefault: true,
+                deletedAt: (0, _typeorm.IsNull)()
+            }
+        });
+    }
+    async getActiveLanguages() {
+        await this.ensureRepositoryInitialized();
+        return this.repository.find({
+            where: {
+                isActive: true,
+                deletedAt: (0, _typeorm.IsNull)()
+            },
+            order: {
+                serial: 'ASC',
+                name: 'ASC'
+            }
+        });
+    }
+    async setAsDefault(id) {
+        await this.ensureRepositoryInitialized();
+        await this.repository.update({
+            isDefault: true
+        }, {
+            isDefault: false
+        });
+        await this.repository.update({
+            id
+        }, {
+            isDefault: true
+        });
+        return this.repository.findOne({
+            where: {
+                id
+            }
+        });
+    }
+    constructor(cacheManager, utilsService, dataSourceProvider){
+        super('language', null, cacheManager, utilsService, LanguageService.name, true, 'localization'), _define_property(this, "cacheManager", void 0), _define_property(this, "utilsService", void 0), _define_property(this, "dataSourceProvider", void 0), this.cacheManager = cacheManager, this.utilsService = utilsService, this.dataSourceProvider = dataSourceProvider;
+    }
+};
+LanguageService = _ts_decorate([
+    (0, _common.Injectable)({
+        scope: _common.Scope.REQUEST
+    }),
+    _ts_param(0, (0, _common.Inject)('CACHE_INSTANCE')),
+    _ts_param(1, (0, _common.Inject)(_modules.UtilsService)),
+    _ts_param(2, (0, _common.Inject)(_localizationdatasourceprovider.LocalizationDataSourceProvider)),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _classes.HybridCache === "undefined" ? Object : _classes.HybridCache,
+        typeof _modules.UtilsService === "undefined" ? Object : _modules.UtilsService,
+        typeof _localizationdatasourceprovider.LocalizationDataSourceProvider === "undefined" ? Object : _localizationdatasourceprovider.LocalizationDataSourceProvider
+    ])
+], LanguageService);

package/cjs/services/localization-config.service.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "LocalizationConfigService", {
+    enumerable: true,
+    get: function() {
+        return LocalizationConfigService;
+    }
+});
+const _common = require("@nestjs/common");
+const _localizationconstants = require("../config/localization.constants");
+const _interfaces = require("../interfaces");
+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 LocalizationConfigService = class LocalizationConfigService {
+    isCompanyFeatureEnabled() {
+        return false;
+    }
+    getDatabaseMode() {
+        return this.options.bootstrapAppConfig?.databaseMode ?? 'single';
+    }
+    isMultiTenant() {
+        return this.getDatabaseMode() === 'multi-tenant';
+    }
+    getOptions() {
+        return this.options;
+    }
+    constructor(options){
+        _define_property(this, "options", void 0);
+        this.options = options;
+    }
+};
+LocalizationConfigService = _ts_decorate([
+    (0, _common.Injectable)(),
+    _ts_param(0, (0, _common.Inject)(_localizationconstants.LOCALIZATION_MODULE_OPTIONS)),
+    _ts_metadata("design:type", Function),
+    _ts_metadata("design:paramtypes", [
+        typeof _interfaces.LocalizationModuleOptions === "undefined" ? Object : _interfaces.LocalizationModuleOptions
+    ])
+], LocalizationConfigService);