@digitaldefiance/i18n-lib 1.0.32 → 1.1.0

package/dist/component-registry.js

@@ -0,0 +1,238 @@
+"use strict";
+/**
+ * Component registry for managing internationalization components and their string translations
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentRegistry = void 0;
+const registry_error_1 = require("./registry-error");
+const registry_error_type_1 = require("./registry-error-type");
+const utils_1 = require("./utils");
+/**
+ * Registry for managing components and their translations
+ */
+class ComponentRegistry {
+    constructor(languages, validationConfig) {
+        this.components = new Map();
+        this.componentStrings = new Map();
+        this.registeredLanguages = new Set(languages);
+        this.validationConfig = validationConfig;
+    }
+    /**
+     * Update the set of registered languages (for dynamic language addition)
+     */
+    updateRegisteredLanguages(languages) {
+        this.registeredLanguages.clear();
+        languages.forEach((lang) => this.registeredLanguages.add(lang));
+    }
+    /**
+     * Register a new component with its translations
+     */
+    registerComponent(registration) {
+        const { component, strings } = registration;
+        // Check for duplicate component
+        if (this.components.has(component.id)) {
+            throw registry_error_1.RegistryError.createSimple(registry_error_type_1.RegistryErrorType.DuplicateComponent, `Component '${component.id}' is already registered`, { componentId: component.id });
+        }
+        // Validate the registration
+        const validationResult = this.validateComponentRegistration(registration);
+        if (!validationResult.isValid &&
+            !this.validationConfig.allowPartialRegistration) {
+            throw registry_error_1.RegistryError.createSimple(registry_error_type_1.RegistryErrorType.ValidationFailed, `Component registration validation failed: ${validationResult.errors.join(', ')}`, {
+                componentId: component.id,
+                missingKeys: validationResult.missingKeys,
+                errors: validationResult.errors,
+            });
+        }
+        // Complete missing strings with fallbacks if partial registration is allowed
+        const completeStrings = this.completeStringsWithFallbacks(component, strings);
+        // Register the component
+        this.components.set(component.id, component);
+        this.componentStrings.set(component.id, completeStrings);
+        return validationResult;
+    }
+    /**
+     * Update strings for an existing component
+     */
+    updateComponentStrings(componentId, strings) {
+        const component = this.components.get(componentId);
+        if (!component) {
+            throw registry_error_1.RegistryError.createSimple(registry_error_type_1.RegistryErrorType.ComponentNotFound, `Component with ID '${componentId}' not found`, { componentId });
+        }
+        const registration = {
+            component: component,
+            strings,
+        };
+        const validationResult = this.validateComponentRegistration(registration);
+        if (validationResult.isValid ||
+            this.validationConfig.allowPartialRegistration) {
+            const existingStrings = this.componentStrings.get(componentId) ||
+                {};
+            const updatedStrings = this.mergeStrings(existingStrings, strings);
+            const completeStrings = this.completeStringsWithFallbacks(component, updatedStrings);
+            this.componentStrings.set(componentId, completeStrings);
+        }
+        return validationResult;
+    }
+    /**
+     * Get a translation for a specific component, string key, and language
+     */
+    getTranslation(request) {
+        const { componentId, stringKey, language, variables } = request;
+        // Check if component exists
+        if (!this.components.has(componentId)) {
+            throw registry_error_1.RegistryError.createSimple(registry_error_type_1.RegistryErrorType.ComponentNotFound, `Component '${componentId}' not found`, { componentId });
+        }
+        const componentStrings = this.componentStrings.get(componentId);
+        if (!componentStrings) {
+            throw registry_error_1.RegistryError.createSimple(registry_error_type_1.RegistryErrorType.StringKeyNotFound, `No strings registered for component '${componentId}'`, { componentId });
+        }
+        const targetLanguage = language || this.validationConfig.fallbackLanguageId;
+        let actualLanguage = targetLanguage;
+        let wasFallback = false;
+        // Try to get the string in the requested language
+        let languageStrings = componentStrings[targetLanguage];
+        // If not found and different from fallback, try fallback language
+        if (!languageStrings &&
+            targetLanguage !== this.validationConfig.fallbackLanguageId) {
+            languageStrings =
+                componentStrings[this.validationConfig.fallbackLanguageId];
+            actualLanguage = this.validationConfig.fallbackLanguageId;
+            wasFallback = true;
+        }
+        if (!languageStrings) {
+            throw registry_error_1.RegistryError.createSimple(registry_error_type_1.RegistryErrorType.LanguageNotFound, `No strings found for language '${targetLanguage}' in component '${componentId}'`, { componentId, language: targetLanguage });
+        }
+        const translation = languageStrings[stringKey];
+        if (!translation) {
+            throw registry_error_1.RegistryError.createSimple(registry_error_type_1.RegistryErrorType.StringKeyNotFound, `String key '${stringKey}' not found for component '${componentId}' in language '${actualLanguage}'`, { componentId, stringKey, language: actualLanguage });
+        }
+        // Process variables if the string is a template
+        let processedTranslation = translation;
+        if (variables && (0, utils_1.isTemplate)(translation)) {
+            processedTranslation = (0, utils_1.replaceVariables)(translation, variables);
+        }
+        return {
+            translation: processedTranslation,
+            actualLanguage,
+            wasFallback,
+        };
+    }
+    /**
+     * Get all registered components
+     */
+    getComponents() {
+        return Array.from(this.components.values());
+    }
+    /**
+     * Get a specific component by ID
+     */
+    getComponent(componentId) {
+        return this.components.get(componentId);
+    }
+    /**
+     * Check if a component is registered
+     */
+    hasComponent(componentId) {
+        return this.components.has(componentId);
+    }
+    /**
+     * Get all strings for a component in all languages
+     */
+    getComponentStrings(componentId) {
+        return this.componentStrings.get(componentId);
+    }
+    /**
+     * Validate a component registration
+     */
+    validateComponentRegistration(registration) {
+        const { component, strings } = registration;
+        const missingKeys = [];
+        const errors = [];
+        // Check if all required string keys are provided for each language
+        for (const languageId of this.registeredLanguages) {
+            const languageStrings = strings[languageId];
+            if (!languageStrings) {
+                if (this.validationConfig.requireCompleteStrings) {
+                    errors.push(`Missing all strings for language '${languageId}' in component '${component.id}'`);
+                }
+                // Add all missing keys for this language
+                for (const stringKey of component.stringKeys) {
+                    missingKeys.push({
+                        languageId,
+                        componentId: component.id,
+                        stringKey,
+                    });
+                }
+                continue;
+            }
+            // Check individual string keys
+            for (const stringKey of component.stringKeys) {
+                if (!languageStrings[stringKey]) {
+                    missingKeys.push({
+                        languageId,
+                        componentId: component.id,
+                        stringKey,
+                    });
+                    if (this.validationConfig.requireCompleteStrings) {
+                        errors.push(`Missing string key '${stringKey}' for language '${languageId}' in component '${component.id}'`);
+                    }
+                }
+            }
+        }
+        return {
+            isValid: missingKeys.length === 0,
+            missingKeys,
+            errors,
+        };
+    }
+    /**
+     * Complete missing strings with fallbacks
+     */
+    completeStringsWithFallbacks(component, strings) {
+        const result = {};
+        const fallbackLanguage = this.validationConfig
+            .fallbackLanguageId;
+        const fallbackStrings = strings[fallbackLanguage];
+        // Ensure all languages have all required keys
+        for (const languageId of this.registeredLanguages) {
+            const existingLanguageStrings = strings[languageId] || {};
+            const languageStrings = {};
+            for (const stringKey of component.stringKeys) {
+                if (existingLanguageStrings[stringKey]) {
+                    languageStrings[stringKey] = existingLanguageStrings[stringKey];
+                }
+                else if (fallbackStrings && fallbackStrings[stringKey]) {
+                    // Try to use fallback language
+                    languageStrings[stringKey] = fallbackStrings[stringKey];
+                }
+                else {
+                    // Last resort: use a placeholder
+                    languageStrings[stringKey] = `[${component.id}.${stringKey}]`;
+                }
+            }
+            result[languageId] = languageStrings;
+        }
+        return result;
+    }
+    /**
+     * Merge existing strings with new strings
+     */
+    mergeStrings(existing, updates) {
+        const result = {};
+        // Copy existing strings
+        for (const [languageId, languageStrings] of Object.entries(existing)) {
+            result[languageId] = { ...languageStrings };
+        }
+        // Apply updates
+        for (const [languageId, languageStrings] of Object.entries(updates)) {
+            if (languageStrings) {
+                result[languageId] = {
+                    ...result[languageId],
+                    ...languageStrings,
+                };
+            }
+        }
+        return result;
+    }
+}
+exports.ComponentRegistry = ComponentRegistry;

package/dist/context.d.ts

@@ -1,6 +1,7 @@
 import { CurrencyCode } from './currency-code';
+import { I18nContext } from './i18n-context';
 import { Timezone } from './timezone';
-import { I18nContext, LanguageContext } from './types';
+import { LanguageContext } from './types';
 /**
  * Creates a new I18n context with default values.
  * @param defaultLanguage - The default language for the context

package/dist/core-i18n.d.ts

@@ -0,0 +1,330 @@
+/**
+ * Core I18n component with default languages and system strings
+ */
+import { ComponentDefinition } from './component-definition';
+import { ComponentRegistration } from './component-registration';
+import { CoreLanguage } from './core-language';
+import { CoreStringKey } from './core-string-key';
+import { LanguageDefinition } from './language-definition';
+import { PluginI18nEngine } from './plugin-i18n-engine';
+/**
+ * Create default language definitions
+ */
+export declare function createDefaultLanguages(): LanguageDefinition[];
+/**
+ * Core component definition
+ */
+export declare const CoreComponentDefinition: ComponentDefinition<CoreStringKey>;
+/**
+ * Core component strings for all default languages
+ */
+export declare function createCoreComponentStrings(): {
+    "en-US": {
+        common_yes: string;
+        common_no: string;
+        common_cancel: string;
+        common_ok: string;
+        common_save: string;
+        common_delete: string;
+        common_edit: string;
+        common_create: string;
+        common_update: string;
+        common_loading: string;
+        common_error: string;
+        common_success: string;
+        common_warning: string;
+        common_info: string;
+        error_invalidInput: string;
+        error_networkError: string;
+        error_notFound: string;
+        error_accessDenied: string;
+        error_internalServer: string;
+        error_validationFailed: string;
+        error_requiredField: string;
+        error_componentNotFoundTemplate: string;
+        error_languageNotFoundTemplate: string;
+        error_stringKeyNotFoundTemplate: string;
+        error_incompleteRegistrationTemplate: string;
+        error_duplicateComponentTemplate: string;
+        error_duplicateLanguageTemplate: string;
+        error_validationFailedTemplate: string;
+        system_welcome: string;
+        system_goodbye: string;
+        system_pleaseWait: string;
+        system_processingRequest: string;
+        system_operationComplete: string;
+        system_noDataAvailable: string;
+    };
+    "en-UK": {
+        common_yes: string;
+        common_no: string;
+        common_cancel: string;
+        common_ok: string;
+        common_save: string;
+        common_delete: string;
+        common_edit: string;
+        common_create: string;
+        common_update: string;
+        common_loading: string;
+        common_error: string;
+        common_success: string;
+        common_warning: string;
+        common_info: string;
+        error_invalidInput: string;
+        error_networkError: string;
+        error_notFound: string;
+        error_accessDenied: string;
+        error_internalServer: string;
+        error_validationFailed: string;
+        error_requiredField: string;
+        error_componentNotFoundTemplate: string;
+        error_languageNotFoundTemplate: string;
+        error_stringKeyNotFoundTemplate: string;
+        error_incompleteRegistrationTemplate: string;
+        error_duplicateComponentTemplate: string;
+        error_duplicateLanguageTemplate: string;
+        error_validationFailedTemplate: string;
+        system_welcome: string;
+        system_goodbye: string;
+        system_pleaseWait: string;
+        system_processingRequest: string;
+        system_operationComplete: string;
+        system_noDataAvailable: string;
+    };
+    fr: {
+        common_yes: string;
+        common_no: string;
+        common_cancel: string;
+        common_ok: string;
+        common_save: string;
+        common_delete: string;
+        common_edit: string;
+        common_create: string;
+        common_update: string;
+        common_loading: string;
+        common_error: string;
+        common_success: string;
+        common_warning: string;
+        common_info: string;
+        error_invalidInput: string;
+        error_networkError: string;
+        error_notFound: string;
+        error_accessDenied: string;
+        error_internalServer: string;
+        error_validationFailed: string;
+        error_requiredField: string;
+        error_componentNotFoundTemplate: string;
+        error_languageNotFoundTemplate: string;
+        error_stringKeyNotFoundTemplate: string;
+        error_incompleteRegistrationTemplate: string;
+        error_duplicateComponentTemplate: string;
+        error_duplicateLanguageTemplate: string;
+        error_validationFailedTemplate: string;
+        system_welcome: string;
+        system_goodbye: string;
+        system_pleaseWait: string;
+        system_processingRequest: string;
+        system_operationComplete: string;
+        system_noDataAvailable: string;
+    };
+    es: {
+        common_yes: string;
+        common_no: string;
+        common_cancel: string;
+        common_ok: string;
+        common_save: string;
+        common_delete: string;
+        common_edit: string;
+        common_create: string;
+        common_update: string;
+        common_loading: string;
+        common_error: string;
+        common_success: string;
+        common_warning: string;
+        common_info: string;
+        error_invalidInput: string;
+        error_networkError: string;
+        error_notFound: string;
+        error_accessDenied: string;
+        error_internalServer: string;
+        error_validationFailed: string;
+        error_requiredField: string;
+        error_componentNotFoundTemplate: string;
+        error_languageNotFoundTemplate: string;
+        error_stringKeyNotFoundTemplate: string;
+        error_incompleteRegistrationTemplate: string;
+        error_duplicateComponentTemplate: string;
+        error_duplicateLanguageTemplate: string;
+        error_validationFailedTemplate: string;
+        system_welcome: string;
+        system_goodbye: string;
+        system_pleaseWait: string;
+        system_processingRequest: string;
+        system_operationComplete: string;
+        system_noDataAvailable: string;
+    };
+    de: {
+        common_yes: string;
+        common_no: string;
+        common_cancel: string;
+        common_ok: string;
+        common_save: string;
+        common_delete: string;
+        common_edit: string;
+        common_create: string;
+        common_update: string;
+        common_loading: string;
+        common_error: string;
+        common_success: string;
+        common_warning: string;
+        common_info: string;
+        error_invalidInput: string;
+        error_networkError: string;
+        error_notFound: string;
+        error_accessDenied: string;
+        error_internalServer: string;
+        error_validationFailed: string;
+        error_requiredField: string;
+        error_componentNotFoundTemplate: string;
+        error_languageNotFoundTemplate: string;
+        error_stringKeyNotFoundTemplate: string;
+        error_incompleteRegistrationTemplate: string;
+        error_duplicateComponentTemplate: string;
+        error_duplicateLanguageTemplate: string;
+        error_validationFailedTemplate: string;
+        system_welcome: string;
+        system_goodbye: string;
+        system_pleaseWait: string;
+        system_processingRequest: string;
+        system_operationComplete: string;
+        system_noDataAvailable: string;
+    };
+    "zh-CN": {
+        common_yes: string;
+        common_no: string;
+        common_cancel: string;
+        common_ok: string;
+        common_save: string;
+        common_delete: string;
+        common_edit: string;
+        common_create: string;
+        common_update: string;
+        common_loading: string;
+        common_error: string;
+        common_success: string;
+        common_warning: string;
+        common_info: string;
+        error_invalidInput: string;
+        error_networkError: string;
+        error_notFound: string;
+        error_accessDenied: string;
+        error_internalServer: string;
+        error_validationFailed: string;
+        error_requiredField: string;
+        error_componentNotFoundTemplate: string;
+        error_languageNotFoundTemplate: string;
+        error_stringKeyNotFoundTemplate: string;
+        error_incompleteRegistrationTemplate: string;
+        error_duplicateComponentTemplate: string;
+        error_duplicateLanguageTemplate: string;
+        error_validationFailedTemplate: string;
+        system_welcome: string;
+        system_goodbye: string;
+        system_pleaseWait: string;
+        system_processingRequest: string;
+        system_operationComplete: string;
+        system_noDataAvailable: string;
+    };
+    ja: {
+        common_yes: string;
+        common_no: string;
+        common_cancel: string;
+        common_ok: string;
+        common_save: string;
+        common_delete: string;
+        common_edit: string;
+        common_create: string;
+        common_update: string;
+        common_loading: string;
+        common_error: string;
+        common_success: string;
+        common_warning: string;
+        common_info: string;
+        error_invalidInput: string;
+        error_networkError: string;
+        error_notFound: string;
+        error_accessDenied: string;
+        error_internalServer: string;
+        error_validationFailed: string;
+        error_requiredField: string;
+        error_componentNotFoundTemplate: string;
+        error_languageNotFoundTemplate: string;
+        error_stringKeyNotFoundTemplate: string;
+        error_incompleteRegistrationTemplate: string;
+        error_duplicateComponentTemplate: string;
+        error_duplicateLanguageTemplate: string;
+        error_validationFailedTemplate: string;
+        system_welcome: string;
+        system_goodbye: string;
+        system_pleaseWait: string;
+        system_processingRequest: string;
+        system_operationComplete: string;
+        system_noDataAvailable: string;
+    };
+    uk: {
+        common_yes: string;
+        common_no: string;
+        common_cancel: string;
+        common_ok: string;
+        common_save: string;
+        common_delete: string;
+        common_edit: string;
+        common_create: string;
+        common_update: string;
+        common_loading: string;
+        common_error: string;
+        common_success: string;
+        common_warning: string;
+        common_info: string;
+        error_invalidInput: string;
+        error_networkError: string;
+        error_notFound: string;
+        error_accessDenied: string;
+        error_internalServer: string;
+        error_validationFailed: string;
+        error_requiredField: string;
+        error_componentNotFoundTemplate: string;
+        error_languageNotFoundTemplate: string;
+        error_stringKeyNotFoundTemplate: string;
+        error_incompleteRegistrationTemplate: string;
+        error_duplicateComponentTemplate: string;
+        error_duplicateLanguageTemplate: string;
+        error_validationFailedTemplate: string;
+        system_welcome: string;
+        system_goodbye: string;
+        system_pleaseWait: string;
+        system_processingRequest: string;
+        system_operationComplete: string;
+        system_noDataAvailable: string;
+    };
+};
+/**
+ * Create core component registration
+ */
+export declare function createCoreComponentRegistration(): ComponentRegistration<CoreStringKey, CoreLanguage>;
+/**
+ * Create a pre-configured I18n engine with core components
+ */
+export declare function createCoreI18nEngine(instanceKey?: string): PluginI18nEngine<CoreLanguage>;
+/**
+ * Type alias for easier usage
+ */
+export type CoreI18nEngine = PluginI18nEngine<CoreLanguage>;
+/**
+ * Helper function to get core translation
+ */
+export declare function getCoreTranslation(stringKey: CoreStringKey, variables?: Record<string, string | number>, language?: CoreLanguage, instanceKey?: string): string;
+/**
+ * Helper function to safely get core translation with fallback
+ */
+export declare function safeCoreTranslation(stringKey: CoreStringKey, variables?: Record<string, string | number>, language?: CoreLanguage, instanceKey?: string): string;