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

package/fesm/config/index.js

@@ -1,3 +1,101 @@
-export * from './event-actions';
-export * from './localization.constants';
-export * from './message-keys';
+export const __rspack_esm_id = 565;
+export const __rspack_esm_ids = [565];
+export const __webpack_modules__ = {
+102(__unused_rspack_module, __webpack_exports__, __webpack_require__) {
+/**
+ * Domain event actions published by the localization module, alongside the CRUD
+ * lifecycle actions every ApiService emits.
+ */ const LOCALIZATION_EVENT_ACTIONS = {
+    BULK_UPDATED: 'bulk-updated'
+};
+/** Every entity the localization module publishes under */ const LOCALIZATION_EVENT_ENTITIES = {
+    LANGUAGE: 'language',
+    TRANSLATION_KEY: 'translationKey',
+    TRANSLATION: 'translation'
+};
+const LOCALIZATION_EVENT_MODULE = 'localization';
+
+__webpack_require__.d(__webpack_exports__, {
+}, {
+  JX: LOCALIZATION_EVENT_ENTITIES,
+  ec: LOCALIZATION_EVENT_MODULE,
+  f_: LOCALIZATION_EVENT_ACTIONS
+});
+
+
+},
+992(__unused_rspack_module, __webpack_exports__, __webpack_require__) {
+/* import */ var _event_actions_js__rspack_import_0 = __webpack_require__(102);
+/* import */ var _localization_constants_js__rspack_import_1 = __webpack_require__(88);
+/* import */ var _message_keys_js__rspack_import_2 = __webpack_require__(68);
+
+
+
+
+__webpack_require__.d(__webpack_exports__, {
+  A5: () => (/* reexport safe */ _localization_constants_js__rspack_import_1.A),
+  Bc: () => (/* reexport safe */ _message_keys_js__rspack_import_2.Bc),
+  JX: () => (/* reexport safe */ _event_actions_js__rspack_import_0.JX),
+  Ju: () => (/* reexport safe */ _message_keys_js__rspack_import_2.Ju),
+  ec: () => (/* reexport safe */ _event_actions_js__rspack_import_0.ec),
+  ew: () => (/* reexport safe */ _message_keys_js__rspack_import_2.ew),
+  f_: () => (/* reexport safe */ _event_actions_js__rspack_import_0.f_)
+});
+
+
+},
+88(__unused_rspack_module, __webpack_exports__, __webpack_require__) {
+const LOCALIZATION_MODULE_OPTIONS = 'LOCALIZATION_MODULE_OPTIONS';
+
+__webpack_require__.d(__webpack_exports__, {
+}, {
+  A: LOCALIZATION_MODULE_OPTIONS
+});
+
+
+},
+68(__unused_rspack_module, __webpack_exports__, __webpack_require__) {
+// ==================== LOCALIZATION MODULE MESSAGE KEYS ====================
+const LANGUAGE_MESSAGES = {
+    ACTIVE_SUCCESS: 'language.active.success',
+    SET_DEFAULT_SUCCESS: 'language.set.default.success',
+    GET_DEFAULT_SUCCESS: 'language.get.default.success',
+    READONLY_UPDATE_FORBIDDEN: 'language.readonly.update.forbidden',
+    READONLY_DELETE_FORBIDDEN: 'language.readonly.delete.forbidden',
+    DEFAULT_DELETE_FORBIDDEN: 'language.default.delete.forbidden'
+};
+const TRANSLATION_KEY_MESSAGES = {
+    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 = {
+    GET_ALL_SUCCESS: 'translation.get.all.success',
+    UPDATE_MANY_SUCCESS: 'translation.update.many.success',
+    BY_LANGUAGE_SUCCESS: 'translation.by.language.success'
+};
+
+__webpack_require__.d(__webpack_exports__, {
+}, {
+  Bc: TRANSLATION_KEY_MESSAGES,
+  Ju: TRANSLATION_MESSAGES,
+  ew: LANGUAGE_MESSAGES
+});
+
+
+},
+
+};
+import { __webpack_require__ } from '../runtime.js';
+var __webpack_exec__ = function(moduleId) { return __webpack_require__(__webpack_require__.s = moduleId); }
+import * as __rspack_chunk_1 from './index.js';
+__webpack_require__.C(__rspack_chunk_1);
+var __webpack_exports__ = __webpack_exec__(992);var __webpack_exports__LANGUAGE_MESSAGES = __webpack_exports__.ew;
+var __webpack_exports__LOCALIZATION_EVENT_ACTIONS = __webpack_exports__.f_;
+var __webpack_exports__LOCALIZATION_EVENT_ENTITIES = __webpack_exports__.JX;
+var __webpack_exports__LOCALIZATION_EVENT_MODULE = __webpack_exports__.ec;
+var __webpack_exports__LOCALIZATION_MODULE_OPTIONS = __webpack_exports__.A5;
+var __webpack_exports__TRANSLATION_KEY_MESSAGES = __webpack_exports__.Bc;
+var __webpack_exports__TRANSLATION_MESSAGES = __webpack_exports__.Ju;
+export { __webpack_exports__LANGUAGE_MESSAGES as LANGUAGE_MESSAGES, __webpack_exports__LOCALIZATION_EVENT_ACTIONS as LOCALIZATION_EVENT_ACTIONS, __webpack_exports__LOCALIZATION_EVENT_ENTITIES as LOCALIZATION_EVENT_ENTITIES, __webpack_exports__LOCALIZATION_EVENT_MODULE as LOCALIZATION_EVENT_MODULE, __webpack_exports__LOCALIZATION_MODULE_OPTIONS as LOCALIZATION_MODULE_OPTIONS, __webpack_exports__TRANSLATION_KEY_MESSAGES as TRANSLATION_KEY_MESSAGES, __webpack_exports__TRANSLATION_MESSAGES as TRANSLATION_MESSAGES };

package/fesm/controllers/index.js

@@ -1,3 +1,15 @@
-export * from './language.controller';
-export * from './translation-key.controller';
-export * from './translation.controller';
+export const __rspack_esm_id = 24;
+export const __rspack_esm_ids = [24];
+export const __webpack_modules__ = {};
+import { __webpack_require__ } from '../runtime.js';
+var __webpack_exec__ = function(moduleId) { return __webpack_require__(__webpack_require__.s = moduleId); }
+import * as __rspack_chunk_1 from '../692.js';
+__webpack_require__.C(__rspack_chunk_1);
+import * as __rspack_chunk_2 from '../349.js';
+__webpack_require__.C(__rspack_chunk_2);
+import * as __rspack_chunk_3 from './index.js';
+__webpack_require__.C(__rspack_chunk_3);
+var __webpack_exports__ = __webpack_exec__(212);var __webpack_exports__LanguageController = __webpack_exports__.t7;
+var __webpack_exports__TranslationController = __webpack_exports__.Ap;
+var __webpack_exports__TranslationKeyController = __webpack_exports__.$4;
+export { __webpack_exports__LanguageController as LanguageController, __webpack_exports__TranslationController as TranslationController, __webpack_exports__TranslationKeyController as TranslationKeyController };

package/fesm/docs/index.js

@@ -1 +1,126 @@
-export { localizationSwaggerConfig } from './localization-swagger.config';
+export const __rspack_esm_id = 428;
+export const __rspack_esm_ids = [428];
+export const __webpack_modules__ = {
+921(__unused_rspack_module, __webpack_exports__, __webpack_require__) {
+
+// EXPORTS
+__webpack_require__.d(__webpack_exports__, {
+  a: () => (/* reexport */ localizationSwaggerConfig)
+});
+
+;// CONCATENATED MODULE: ./projects/nestjs-localization/src/docs/localization-swagger.config.ts
+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
+    };
+}
+
+;// CONCATENATED MODULE: ./projects/nestjs-localization/src/docs/index.ts
+
+
+
+},
+
+};
+import { __webpack_require__ } from '../runtime.js';
+var __webpack_exec__ = function(moduleId) { return __webpack_require__(__webpack_require__.s = moduleId); }
+import * as __rspack_chunk_1 from './index.js';
+__webpack_require__.C(__rspack_chunk_1);
+var __webpack_exports__ = __webpack_exec__(921);var __webpack_exports__localizationSwaggerConfig = __webpack_exports__.a;
+export { __webpack_exports__localizationSwaggerConfig as localizationSwaggerConfig };