@flusys/nestjs-localization 7.1.0 → 8.0.0

package/fesm/entities/translation.entity.js

@@ -1,110 +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 { Identity } from '@flusys/nestjs-shared/entities';
-import { Column, Entity, Index, JoinColumn, ManyToOne } from 'typeorm';
-import { Language } from './language.entity';
-import { TranslationKey } from './translation-key.entity';
-export class Translation extends 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([
-    Column({
-        type: 'uuid',
-        name: 'language_id',
-        nullable: false
-    }),
-    _ts_metadata("design:type", String)
-], Translation.prototype, "languageId", void 0);
-_ts_decorate([
-    Column({
-        type: 'uuid',
-        name: 'translation_key_id',
-        nullable: false
-    }),
-    _ts_metadata("design:type", String)
-], Translation.prototype, "translationKeyId", void 0);
-_ts_decorate([
-    Column({
-        type: 'text',
-        nullable: false
-    }),
-    _ts_metadata("design:type", String)
-], Translation.prototype, "value", void 0);
-_ts_decorate([
-    Column({
-        type: 'boolean',
-        default: false,
-        name: 'is_verified'
-    }),
-    _ts_metadata("design:type", Boolean)
-], Translation.prototype, "isVerified", void 0);
-_ts_decorate([
-    Column({
-        type: 'boolean',
-        default: true,
-        name: 'is_active'
-    }),
-    _ts_metadata("design:type", Boolean)
-], Translation.prototype, "isActive", void 0);
-_ts_decorate([
-    ManyToOne(()=>Language, {
-        nullable: false,
-        onDelete: 'CASCADE'
-    }),
-    JoinColumn({
-        name: 'language_id'
-    }),
-    _ts_metadata("design:type", typeof Language === "undefined" ? Object : Language)
-], Translation.prototype, "language", void 0);
-_ts_decorate([
-    ManyToOne(()=>TranslationKey, {
-        nullable: false,
-        onDelete: 'CASCADE'
-    }),
-    JoinColumn({
-        name: 'translation_key_id'
-    }),
-    _ts_metadata("design:type", typeof TranslationKey === "undefined" ? Object : TranslationKey)
-], Translation.prototype, "translationKey", void 0);
-Translation = _ts_decorate([
-    Entity({
-        name: 'translation'
-    }),
-    Index([
-        'languageId',
-        'translationKeyId'
-    ], {
-        unique: true
-    }),
-    Index([
-        'languageId'
-    ]),
-    Index([
-        'translationKeyId'
-    ]),
-    Index([
-        'isActive'
-    ])
-], Translation);

package/fesm/interfaces/language.interface.js

@@ -1 +0,0 @@
-export { };

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

@@ -1 +0,0 @@
-export { };

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

@@ -1 +0,0 @@
-export { };

package/fesm/interfaces/translation.interface.js

@@ -1 +0,0 @@
-export { };

package/fesm/modules/localization.module.js

@@ -1,106 +0,0 @@
-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;
-}
-import { CacheModule, UtilsModule, createModuleEventsProvider } from '@flusys/nestjs-shared/modules';
-import { Module } from '@nestjs/common';
-import { LOCALIZATION_MODULE_OPTIONS } from '../config/localization.constants';
-import { LanguageController, TranslationKeyController, TranslationController } from '../controllers';
-import { LanguageService, LocalizationConfigService, LocalizationDataSourceProvider, TranslationKeyService, TranslationService } from '../services';
-const CONTROLLERS = [
-    LanguageController,
-    TranslationKeyController,
-    TranslationController
-];
-const EXPORTED_SERVICES = [
-    LocalizationConfigService,
-    LocalizationDataSourceProvider,
-    LanguageService,
-    TranslationKeyService,
-    TranslationService
-];
-export class LocalizationModule {
-    static forRoot(options) {
-        return {
-            module: LocalizationModule,
-            global: options.global ?? false,
-            imports: [
-                CacheModule,
-                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 || [],
-                CacheModule,
-                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: LOCALIZATION_MODULE_OPTIONS,
-                useValue: options
-            });
-        }
-        providers.push(createModuleEventsProvider('localization', LOCALIZATION_MODULE_OPTIONS));
-        return providers;
-    }
-    static createAsyncProviders(options) {
-        if (options.useFactory) {
-            return [
-                {
-                    provide: 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: 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([
-    Module({})
-], LocalizationModule);

package/fesm/modules/localization.module.spec.js

@@ -1,128 +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;
-}
-import { LocalizationModule } from './localization.module';
-import { LOCALIZATION_MODULE_OPTIONS } from '../config/localization.constants';
-import { LanguageController, TranslationKeyController, TranslationController } from '../controllers';
-function providerTokens(providers) {
-    return providers.map((p)=>typeof p === 'function' ? p : p.provide);
-}
-describe('LocalizationModule', ()=>{
-    describe('forRoot', ()=>{
-        it('should default to a non-global module with all controllers registered', ()=>{
-            const dynamicModule = LocalizationModule.forRoot({});
-            expect(dynamicModule.module).toBe(LocalizationModule);
-            expect(dynamicModule.global).toBe(false);
-            expect(dynamicModule.controllers).toEqual([
-                LanguageController,
-                TranslationKeyController,
-                TranslationController
-            ]);
-        });
-        it('should respect global: true', ()=>{
-            expect(LocalizationModule.forRoot({
-                global: true
-            }).global).toBe(true);
-        });
-        it('should register no controllers when includeController is false', ()=>{
-            expect(LocalizationModule.forRoot({
-                includeController: false
-            }).controllers).toEqual([]);
-        });
-        it('should register a LOCALIZATION_MODULE_OPTIONS provider carrying the given options', ()=>{
-            const options = {
-                bootstrapAppConfig: {}
-            };
-            const dynamicModule = LocalizationModule.forRoot(options);
-            const provider = dynamicModule.providers.find((p)=>p.provide === LOCALIZATION_MODULE_OPTIONS);
-            expect(provider.useValue).toBe(options);
-        });
-        it('should always export the same fixed set of services', ()=>{
-            expect(LocalizationModule.forRoot({}).exports).toHaveLength(5);
-        });
-    });
-    describe('forRootAsync', ()=>{
-        it('should forward external imports alongside CacheModule/UtilsModule', ()=>{
-            let FakeImportedModule = class FakeImportedModule {
-            };
-            const dynamicModule = LocalizationModule.forRootAsync({
-                imports: [
-                    FakeImportedModule
-                ]
-            });
-            expect(dynamicModule.imports).toEqual(expect.arrayContaining([
-                FakeImportedModule
-            ]));
-        });
-        it('useFactory: builds a LOCALIZATION_MODULE_OPTIONS provider merging resolved config', async ()=>{
-            const useFactory = jest.fn().mockResolvedValue({
-                foo: 'bar'
-            });
-            const dynamicModule = LocalizationModule.forRootAsync({
-                useFactory,
-                inject: [
-                    'SOME_TOKEN'
-                ]
-            });
-            const provider = dynamicModule.providers.find((p)=>p.provide === LOCALIZATION_MODULE_OPTIONS);
-            expect(provider.inject).toEqual([
-                'SOME_TOKEN'
-            ]);
-            const resolved = await provider.useFactory('injected');
-            expect(useFactory).toHaveBeenCalledWith('injected');
-            expect(resolved.config).toEqual({
-                foo: 'bar'
-            });
-        });
-        it('useClass: registers both the class provider and an options provider calling createLocalizationOptions()', async ()=>{
-            let MyOptionsFactory = class MyOptionsFactory {
-                constructor(){
-                    _define_property(this, "createLocalizationOptions", jest.fn().mockResolvedValue({
-                        foo: 'from-class'
-                    }));
-                }
-            };
-            const dynamicModule = LocalizationModule.forRootAsync({
-                useClass: MyOptionsFactory
-            });
-            const classProvider = dynamicModule.providers.find((p)=>p.provide === MyOptionsFactory);
-            expect(classProvider.useClass).toBe(MyOptionsFactory);
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === LOCALIZATION_MODULE_OPTIONS);
-            const instance = new MyOptionsFactory();
-            const resolved = await optionsProvider.useFactory(instance);
-            expect(instance.createLocalizationOptions).toHaveBeenCalled();
-            expect(resolved.config).toEqual({
-                foo: 'from-class'
-            });
-        });
-        it('useExisting: registers a single options provider without a duplicate class registration', ()=>{
-            let MyOptionsFactory = class MyOptionsFactory {
-                constructor(){
-                    _define_property(this, "createLocalizationOptions", jest.fn());
-                }
-            };
-            const dynamicModule = LocalizationModule.forRootAsync({
-                useExisting: MyOptionsFactory
-            });
-            expect(dynamicModule.providers.filter((p)=>p.provide === MyOptionsFactory)).toHaveLength(0);
-            const optionsProvider = dynamicModule.providers.find((p)=>p.provide === LOCALIZATION_MODULE_OPTIONS);
-            expect(optionsProvider.inject).toEqual([
-                MyOptionsFactory
-            ]);
-        });
-        it('should register no LOCALIZATION_MODULE_OPTIONS provider when neither useFactory, useClass, nor useExisting is given', ()=>{
-            const dynamicModule = LocalizationModule.forRootAsync({});
-            expect(providerTokens(dynamicModule.providers)).not.toContain(LOCALIZATION_MODULE_OPTIONS);
-        });
-    });
-});

package/fesm/services/language.service.js

@@ -1,171 +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 { HybridCache, ApiService } from '@flusys/nestjs-shared/classes';
-import { UtilsService } from '@flusys/nestjs-shared/modules';
-import { ForbiddenException, Inject, Injectable, Scope } from '@nestjs/common';
-import { In, IsNull } from 'typeorm';
-import { LANGUAGE_MESSAGES, LOCALIZATION_EVENT_ENTITIES, LOCALIZATION_EVENT_MODULE } from '../config';
-import { Language } from '../entities';
-import { LocalizationDataSourceProvider } from './localization-datasource.provider';
-export class LanguageService extends ApiService {
-    async beforeUpdateOperation(dto, _user, _queryRunner) {
-        const dtos = Array.isArray(dto) ? dto : [
-            dto
-        ];
-        const ids = dtos.map((d)=>d.id);
-        await this.ensureDataSourceRepository();
-        const existingLanguages = await this.repository.find({
-            where: {
-                id: In(ids),
-                deletedAt: IsNull()
-            }
-        });
-        for (const d of dtos){
-            const existing = existingLanguages.find((e)=>e.id === d.id);
-            if (!existing) {
-                continue;
-            }
-            const changesIdentity = d.code !== undefined && d.code !== existing.code || d.name !== undefined && d.name !== existing.name || d.nativeName !== undefined && d.nativeName !== (existing.nativeName ?? undefined) || d.direction !== undefined && d.direction !== existing.direction;
-            if (existing.isReadonly && changesIdentity) {
-                throw new ForbiddenException({
-                    message: `Cannot modify code/name of readonly language "${existing.name}"`,
-                    messageKey: LANGUAGE_MESSAGES.READONLY_UPDATE_FORBIDDEN,
-                    messageVariables: {
-                        name: existing.name
-                    }
-                });
-            }
-        }
-    }
-    async beforeDeleteOperation(dto, _user, _queryRunner) {
-        const ids = Array.isArray(dto.id) ? dto.id : [
-            dto.id
-        ];
-        await this.ensureDataSourceRepository();
-        const languages = await this.repository.find({
-            where: {
-                id: In(ids),
-                deletedAt: IsNull()
-            }
-        });
-        const readonlyLanguages = languages.filter((l)=>l.isReadonly);
-        if (readonlyLanguages.length > 0) {
-            const names = readonlyLanguages.map((l)=>l.name).join(', ');
-            throw new ForbiddenException({
-                message: `Cannot delete readonly language(s): ${names}`,
-                messageKey: LANGUAGE_MESSAGES.READONLY_DELETE_FORBIDDEN,
-                messageVariables: {
-                    names
-                }
-            });
-        }
-        const defaultLanguages = languages.filter((l)=>l.isDefault);
-        if (defaultLanguages.length > 0) {
-            const names = defaultLanguages.map((l)=>l.name).join(', ');
-            throw new ForbiddenException({
-                message: `Cannot delete the default language(s): ${names}. Set another language as default first.`,
-                messageKey: LANGUAGE_MESSAGES.DEFAULT_DELETE_FORBIDDEN,
-                messageVariables: {
-                    names
-                }
-            });
-        }
-    }
-    async getDefaultLanguage() {
-        await this.ensureDataSourceRepository();
-        return this.repository.findOne({
-            where: {
-                isDefault: true,
-                deletedAt: IsNull()
-            }
-        });
-    }
-    async getActiveLanguages() {
-        await this.ensureDataSourceRepository();
-        return this.repository.find({
-            where: {
-                isActive: true,
-                deletedAt: IsNull()
-            },
-            order: {
-                serial: 'ASC',
-                name: 'ASC'
-            }
-        });
-    }
-    async setAsDefault(id) {
-        await this.ensureDataSourceRepository();
-        const previousDefaults = await this.repository.find({
-            where: {
-                isDefault: true
-            }
-        });
-        await this.repository.update({
-            isDefault: true
-        }, {
-            isDefault: false
-        });
-        await this.repository.update({
-            id
-        }, {
-            isDefault: true
-        });
-        const language = await this.repository.findOne({
-            where: {
-                id
-            }
-        });
-        await Promise.all([
-            this.clearCacheForAll(),
-            this.clearCacheForId([
-                ...previousDefaults,
-                {
-                    id
-                }
-            ])
-        ]);
-        return language;
-    }
-    constructor(cacheManager, utilsService, dataSourceProvider){
-        super(LOCALIZATION_EVENT_ENTITIES.LANGUAGE, cacheManager, utilsService, LanguageService.name, true, LOCALIZATION_EVENT_MODULE, dataSourceProvider, Language), _define_property(this, "cacheManager", void 0), _define_property(this, "utilsService", void 0), this.cacheManager = cacheManager, this.utilsService = utilsService;
-    }
-}
-LanguageService = _ts_decorate([
-    Injectable({
-        scope: Scope.REQUEST
-    }),
-    _ts_param(0, Inject('CACHE_INSTANCE')),
-    _ts_param(1, Inject(UtilsService)),
-    _ts_param(2, Inject(LocalizationDataSourceProvider)),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof HybridCache === "undefined" ? Object : HybridCache,
-        typeof UtilsService === "undefined" ? Object : UtilsService,
-        typeof LocalizationDataSourceProvider === "undefined" ? Object : LocalizationDataSourceProvider
-    ])
-], LanguageService);