@digitaldefiance/i18n-lib 1.3.11 → 1.3.13

package/dist/registry-error.js

@@ -1,45 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegistryError = void 0;
-// CoreLanguageCode is deprecated - using string
-const core_string_key_1 = require("./core-string-key");
-const registry_error_type_1 = require("./registry-error-type");
-const typed_error_1 = require("./typed-error");
-/**
- * Reason map for registry errors
- */
-const REGISTRY_ERROR_REASON_MAP = {
-    [registry_error_type_1.RegistryErrorType.ComponentNotFound]: core_string_key_1.CoreStringKey.Error_ComponentNotFoundTemplate,
-    [registry_error_type_1.RegistryErrorType.DuplicateComponent]: core_string_key_1.CoreStringKey.Error_DuplicateComponentTemplate,
-    [registry_error_type_1.RegistryErrorType.DuplicateLanguage]: core_string_key_1.CoreStringKey.Error_DuplicateLanguageTemplate,
-    [registry_error_type_1.RegistryErrorType.IncompleteRegistration]: core_string_key_1.CoreStringKey.Error_IncompleteRegistrationTemplate,
-    [registry_error_type_1.RegistryErrorType.LanguageNotFound]: core_string_key_1.CoreStringKey.Error_LanguageNotFoundTemplate,
-    [registry_error_type_1.RegistryErrorType.StringKeyNotFound]: core_string_key_1.CoreStringKey.Error_StringKeyNotFoundTemplate,
-    [registry_error_type_1.RegistryErrorType.ValidationFailed]: core_string_key_1.CoreStringKey.Error_ValidationFailedTemplate,
-};
-/**
- * Registry error class that can work with plugin engines
- */
-class RegistryError extends Error {
-    constructor(type, message, metadata) {
-        super(message);
-        this.type = type;
-        this.metadata = metadata;
-        this.name = 'RegistryError';
-    }
-    /**
-     * Create a registry error with translation support
-     */
-    static createWithEngine(engine, type, variables, language, metadata) {
-        const error = (0, typed_error_1.createTranslatedError)(engine, 'core', type, REGISTRY_ERROR_REASON_MAP, variables, language, metadata, 'RegistryError');
-        // Convert to RegistryError instance
-        return new RegistryError(type, error.message, metadata);
-    }
-    /**
-     * Create a simple RegistryError without engine dependency
-     */
-    static createSimple(type, message, metadata) {
-        return new RegistryError(type, message, metadata);
-    }
-}
-exports.RegistryError = RegistryError;

package/dist/strict-types.d.ts

@@ -1,18 +0,0 @@
-/**
- * Enforces that for each language L, all string keys K are present.
- */
-export type CompleteLanguageStrings<TStringKey extends string> = {
-    [K in TStringKey]: string;
-};
-export type CompleteComponentLanguageStrings<TStringKey extends string, TLanguages extends string> = {
-    [L in TLanguages]: CompleteLanguageStrings<TStringKey>;
-};
-/**
- * Helper to assert at compile-time that an object is a complete component language map.
- * Returns the object unchanged at runtime.
- */
-export declare function createCompleteComponentStrings<TStringKey extends string, TLanguages extends string>(obj: CompleteComponentLanguageStrings<TStringKey, TLanguages>): CompleteComponentLanguageStrings<TStringKey, TLanguages>;
-/**
- * Utility to extract missing keys at compile time (identity, purely for readability)
- */
-export declare function defineLanguageStrings<TStringKey extends string>(strings: CompleteLanguageStrings<TStringKey>): CompleteLanguageStrings<TStringKey>;

package/dist/strict-types.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCompleteComponentStrings = createCompleteComponentStrings;
-exports.defineLanguageStrings = defineLanguageStrings;
-/**
- * Helper to assert at compile-time that an object is a complete component language map.
- * Returns the object unchanged at runtime.
- */
-function createCompleteComponentStrings(obj) {
-    return obj;
-}
-/**
- * Utility to extract missing keys at compile time (identity, purely for readability)
- */
-function defineLanguageStrings(strings) {
-    return strings;
-}

package/dist/template.d.ts

@@ -1,12 +0,0 @@
-/**
- * Template processing utilities for i18n
- */
-export type EnumKeys<T> = keyof T;
-/**
- * Recursive type to validate that all enum keys in the template string exist in the provided enum type
- */
-export type IsValidEnumTemplate<T extends string, TEnum> = T extends `${string}{{${string}.${infer Key}}}${infer Rest}` ? Key extends EnumKeys<TEnum> ? IsValidEnumTemplate<Rest, TEnum> : false : true;
-/**
- * Template function that processes {{EnumName.EnumKey}} patterns
- */
-export declare function createTemplateProcessor<TEnum extends Record<string, string>, TLanguage extends string>(enumObj: TEnum, translateFn: (key: TEnum[keyof TEnum], vars?: Record<string, string | number>, language?: TLanguage) => string, enumName: string): <T extends string>(str: IsValidEnumTemplate<T, TEnum> extends true ? T : never, language?: TLanguage, ...otherVars: Record<string, string | number>[]) => string;

package/dist/template.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTemplateProcessor = createTemplateProcessor;
-/**
- * Template function that processes {{EnumName.EnumKey}} patterns
- */
-function createTemplateProcessor(enumObj, translateFn, enumName) {
-    return function t(str, language, ...otherVars) {
-        let varIndex = 0;
-        const pattern = new RegExp(`\\{\\{${enumName}\\.(\\w+)\\}\\}`, 'g');
-        // First replace enum patterns
-        let result = str.replace(pattern, (match, enumKey) => {
-            const enumValue = enumObj[enumKey];
-            if (!enumValue) {
-                return match; // Return original if enum key not found
-            }
-            const needsVars = enumValue
-                .toLowerCase()
-                .endsWith('template');
-            const vars = needsVars ? otherVars[varIndex++] ?? {} : {};
-            return translateFn(enumValue, vars, language);
-        });
-        // Then replace any remaining variables from all otherVars
-        const allVars = otherVars.reduce((acc, vars) => ({ ...acc, ...vars }), {});
-        result = result.replace(/\{(\w+)\}/g, (match, varName) => {
-            return allVars[varName] !== undefined ? String(allVars[varName]) : match;
-        });
-        return result;
-    };
-}

package/dist/timezone.d.ts

@@ -1,11 +0,0 @@
-/**
- * Class representing a validated timezone.
- */
-export declare class Timezone {
-    private readonly _timezone;
-    constructor(timezone: string);
-    /**
-     * Gets the timezone value.
-     */
-    get value(): string;
-}

package/dist/timezone.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Timezone = void 0;
-const utils_1 = require("./utils");
-/**
- * Class representing a validated timezone.
- */
-class Timezone {
-    constructor(timezone) {
-        if (!(0, utils_1.isValidTimezone)(timezone)) {
-            throw new Error(`Invalid timezone: ${timezone}`);
-        }
-        this._timezone = timezone;
-    }
-    /**
-     * Gets the timezone value.
-     */
-    get value() {
-        return this._timezone;
-    }
-}
-exports.Timezone = Timezone;

package/dist/translatable-generic-error.d.ts

@@ -1,29 +0,0 @@
-import { PluginI18nEngine } from './plugin-i18n-engine';
-/**
- * Generic translatable error that works with any plugin engine and component
- */
-export declare class TranslatableGenericError<TStringKey extends string = string, TLanguage extends string = string> extends Error {
-    readonly stringKey: TStringKey;
-    readonly componentId: string;
-    readonly language?: TLanguage;
-    readonly variables?: Record<string, string | number>;
-    readonly metadata?: Record<string, any>;
-    /**
-     * Create a translatable error
-     * @param componentId - The component ID to translate from
-     * @param stringKey - The translation key
-     * @param variables - Variables for interpolation
-     * @param language - Optional language override
-     * @param metadata - Additional error metadata
-     * @param instanceKey - Optional engine instance key
-     */
-    constructor(componentId: string, stringKey: TStringKey, variables?: Record<string, string | number>, language?: TLanguage, metadata?: Record<string, any>, instanceKey?: string);
-    /**
-     * Create error with explicit engine instance
-     */
-    static withEngine<TStringKey extends string, TLanguage extends string>(engine: PluginI18nEngine<TLanguage>, componentId: string, stringKey: TStringKey, variables?: Record<string, string | number>, language?: TLanguage, metadata?: Record<string, any>): TranslatableGenericError<TStringKey, TLanguage>;
-    /**
-     * Retranslate the error message in a different language
-     */
-    retranslate(language: TLanguage, instanceKey?: string): string;
-}

package/dist/translatable-generic-error.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TranslatableGenericError = void 0;
-const plugin_i18n_engine_1 = require("./plugin-i18n-engine");
-/**
- * Generic translatable error that works with any plugin engine and component
- */
-class TranslatableGenericError extends Error {
-    /**
-     * Create a translatable error
-     * @param componentId - The component ID to translate from
-     * @param stringKey - The translation key
-     * @param variables - Variables for interpolation
-     * @param language - Optional language override
-     * @param metadata - Additional error metadata
-     * @param instanceKey - Optional engine instance key
-     */
-    constructor(componentId, stringKey, variables, language, metadata, instanceKey) {
-        let translatedMessage;
-        try {
-            const engine = plugin_i18n_engine_1.PluginI18nEngine.getInstance(instanceKey);
-            translatedMessage = engine.safeTranslate(componentId, stringKey, variables, language);
-        }
-        catch (error) {
-            // If engine not found or translation fails, use fallback format
-            translatedMessage = `[${componentId}.${stringKey}]`;
-        }
-        super(translatedMessage);
-        this.name = 'TranslatableGenericError';
-        this.stringKey = stringKey;
-        this.componentId = componentId;
-        this.language = language;
-        this.variables = variables;
-        this.metadata = metadata;
-        // Ensure proper prototype chain for instanceof checks across transpiled targets
-    }
-    /**
-     * Create error with explicit engine instance
-     */
-    static withEngine(engine, componentId, stringKey, variables, language, metadata) {
-        const translatedMessage = engine.safeTranslate(componentId, stringKey, variables, language);
-        const error = Object.create(TranslatableGenericError.prototype);
-        Error.call(error, translatedMessage);
-        error.name = 'TranslatableGenericError';
-        error.stringKey = stringKey;
-        error.componentId = componentId;
-        error.language = language;
-        error.variables = variables;
-        error.metadata = metadata;
-        error.message = translatedMessage;
-        return error;
-    }
-    /**
-     * Retranslate the error message in a different language
-     */
-    retranslate(language, instanceKey) {
-        try {
-            const engine = plugin_i18n_engine_1.PluginI18nEngine.getInstance(instanceKey);
-            return engine.safeTranslate(this.componentId, this.stringKey, this.variables, language);
-        }
-        catch (error) {
-            return `[${this.componentId}.${this.stringKey}]`;
-        }
-    }
-}
-exports.TranslatableGenericError = TranslatableGenericError;

package/dist/translatable-handleable-generic.d.ts

@@ -1,28 +0,0 @@
-import { IHandleable } from './i-handleable';
-import { TranslatableGenericError } from './translatable-generic-error';
-/**
- * Generic translatable error that works with any plugin engine and component
- */
-export declare class TranslatableHandleableGenericError<TStringKey extends string = string, TLanguage extends string = string> extends TranslatableGenericError<TStringKey, TLanguage> implements IHandleable {
-    private _handled;
-    readonly cause?: Error;
-    readonly statusCode: number;
-    readonly sourceData?: unknown;
-    /**
-     * Create a translatable error
-     * @param componentId - The component ID to translate from
-     * @param stringKey - The translation key
-     * @param variables - Variables for interpolation
-     * @param language - Optional language override
-     * @param metadata - Additional error metadata
-     * @param instanceKey - Optional engine instance key
-     */
-    constructor(componentId: string, stringKey: TStringKey, variables?: Record<string, string | number>, language?: TLanguage, metadata?: Record<string, any>, instanceKey?: string, handleableOptions?: {
-        statusCode?: number;
-        cause?: Error;
-        sourceData?: unknown;
-    });
-    get handled(): boolean;
-    set handled(value: boolean);
-    toJSON(): Record<string, unknown>;
-}

package/dist/translatable-handleable-generic.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TranslatableHandleableGenericError = void 0;
-const translatable_generic_error_1 = require("./translatable-generic-error");
-/**
- * Generic translatable error that works with any plugin engine and component
- */
-class TranslatableHandleableGenericError extends translatable_generic_error_1.TranslatableGenericError {
-    /**
-     * Create a translatable error
-     * @param componentId - The component ID to translate from
-     * @param stringKey - The translation key
-     * @param variables - Variables for interpolation
-     * @param language - Optional language override
-     * @param metadata - Additional error metadata
-     * @param instanceKey - Optional engine instance key
-     */
-    constructor(componentId, stringKey, variables, language, metadata, instanceKey, handleableOptions) {
-        super(componentId, stringKey, variables, language, metadata, instanceKey);
-        this._handled = false;
-        this.statusCode = handleableOptions?.statusCode ?? 500;
-        this.cause = handleableOptions?.cause;
-        this.sourceData = handleableOptions?.sourceData;
-    }
-    get handled() {
-        return this._handled;
-    }
-    set handled(value) {
-        this._handled = value;
-    }
-    toJSON() {
-        return {
-            statusCode: this.statusCode,
-            message: this.message,
-            cause: this.cause,
-            sourceData: this.sourceData,
-        };
-    }
-}
-exports.TranslatableHandleableGenericError = TranslatableHandleableGenericError;

package/dist/translatable.d.ts

@@ -1,5 +0,0 @@
-import { I18nEngine } from './i18n-engine';
-import { Language } from './default-config';
-export declare class TranslatableError<TStringKey extends string> extends Error {
-    constructor(engine: I18nEngine<TStringKey, Language, any, any>, string: TStringKey, otherVars?: Record<string, string | number>, language?: Language);
-}

package/dist/translatable.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TranslatableError = void 0;
-class TranslatableError extends Error {
-    constructor(engine, string, otherVars, language) {
-        super(engine.translate(string, otherVars, language));
-        this.name = 'TranslatableError';
-        Object.setPrototypeOf(this, TranslatableError.prototype);
-    }
-}
-exports.TranslatableError = TranslatableError;

package/dist/translation-engine.d.ts

@@ -1,8 +0,0 @@
-/**
- * Minimal interface for translation engines
- * Allows flexibility in what can be used as a translation engine
- */
-export interface TranslationEngine<TStringKey extends string = string> {
-    translate: (key: TStringKey, vars?: Record<string, string | number>, lang?: any) => string;
-    safeTranslate: (key: TStringKey, vars?: Record<string, string | number>, lang?: any) => string;
-}

package/dist/translation-engine.js

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

package/dist/translation-request.d.ts

@@ -1,9 +0,0 @@
-/**
- * Translation request interface
- */
-export interface TranslationRequest<TStringKeys extends string, TLanguages extends string> {
-    readonly componentId: string;
-    readonly stringKey: TStringKeys;
-    readonly language?: TLanguages;
-    readonly variables?: Record<string, string | number>;
-}

package/dist/translation-request.js

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

package/dist/translation-response.d.ts

@@ -1,8 +0,0 @@
-/**
- * Translation response interface
- */
-export interface TranslationResponse {
-    readonly translation: string;
-    readonly actualLanguage: string;
-    readonly wasFallback: boolean;
-}

package/dist/translation-response.js

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

package/dist/typed-error.d.ts

@@ -1,72 +0,0 @@
-import { Language, StringKey } from './default-config';
-import { I18nEngine } from './i18n-engine';
-import { CoreStringKey } from './core-string-key';
-import { PluginI18nEngine } from './plugin-i18n-engine';
-import { TranslationEngine } from './translation-engine';
-export { TranslationEngine };
-/**
- * Type constraint to ensure reasonMap has entries for all enum values
- */
-export type CompleteReasonMap<TEnum extends Record<string, string | number>, TStringKey extends string> = Record<TEnum[keyof TEnum], TStringKey>;
-/**
- * Base typed error class with common patterns
- */
-export declare abstract class BaseTypedError<TEnum extends Record<string, string>, TStringKey extends string> extends Error {
-    readonly type: TEnum[keyof TEnum];
-    readonly metadata?: Record<string, any> | undefined;
-    constructor(type: TEnum[keyof TEnum], message: string, metadata?: Record<string, any> | undefined);
-    /**
-     * Create a simple typed error without engine dependency
-     */
-    static createSimple<TEnum extends Record<string, string>, TStringKey extends string, TError extends BaseTypedError<TEnum, TStringKey>>(this: new (type: TEnum[keyof TEnum], message: string, metadata?: Record<string, any>) => TError, type: TEnum[keyof TEnum], message: string, metadata?: Record<string, any>): TError;
-    /**
-     * Create a typed error with translation support
-     */
-    static createTranslated<TEnum extends Record<string, string>, TStringKey extends string, TError extends BaseTypedError<TEnum, TStringKey>>(this: new (type: TEnum[keyof TEnum], message: string, metadata?: Record<string, any>) => TError, engine: TranslationEngine, componentId: string, type: TEnum[keyof TEnum], reasonMap: CompleteReasonMap<TEnum, TStringKey>, variables?: Record<string, string | number>, language?: string, metadata?: Record<string, any>): TError;
-}
-/**
- * Legacy TypedError that ensures complete enum coverage (for backward compatibility)
- */
-export declare abstract class TypedError<TEnum extends Record<string, string>, TStringKey extends string = StringKey> extends Error {
-    readonly type: TEnum[keyof TEnum];
-    readonly reasonMap: CompleteReasonMap<TEnum, TStringKey>;
-    readonly language?: Language | undefined;
-    readonly otherVars?: Record<string, string | number> | undefined;
-    constructor(engine: I18nEngine<TStringKey, Language, Record<string, any>>, type: TEnum[keyof TEnum], reasonMap: CompleteReasonMap<TEnum, TStringKey>, language?: Language | undefined, otherVars?: Record<string, string | number> | undefined);
-}
-/**
- * Plugin-based TypedError that works with the new component registration system
- */
-export declare abstract class PluginTypedError<TEnum extends Record<string, string>, TStringKey extends string, TLanguages extends string = string> extends Error {
-    readonly componentId: string;
-    readonly type: TEnum[keyof TEnum];
-    readonly reasonMap: CompleteReasonMap<TEnum, TStringKey>;
-    readonly language?: TLanguages | undefined;
-    readonly otherVars?: Record<string, string | number> | undefined;
-    constructor(engine: PluginI18nEngine<TLanguages>, componentId: string, type: TEnum[keyof TEnum], reasonMap: CompleteReasonMap<TEnum, TStringKey>, language?: TLanguages | undefined, otherVars?: Record<string, string | number> | undefined);
-}
-/**
- * Core system TypedError using the core component strings
- */
-export declare abstract class CoreTypedError<TEnum extends Record<string, string>> extends Error {
-    readonly type: TEnum[keyof TEnum];
-    readonly reasonMap: CompleteReasonMap<TEnum, CoreStringKey>;
-    readonly language?: string | undefined;
-    readonly otherVars?: Record<string, string | number> | undefined;
-    constructor(engine: PluginI18nEngine<string>, type: TEnum[keyof TEnum], reasonMap: CompleteReasonMap<TEnum, CoreStringKey>, language?: string | undefined, otherVars?: Record<string, string | number> | undefined);
-}
-/**
- * Helper function to create a plugin-based TypedError with automatic engine detection
- */
-export declare function createPluginTypedError<TEnum extends Record<string, string>, TStringKey extends string, TLanguages extends string = string>(componentId: string, type: TEnum[keyof TEnum], reasonMap: CompleteReasonMap<TEnum, TStringKey>, otherVars?: Record<string, string | number>, language?: TLanguages, instanceKey?: string): Error;
-/**
- * Helper function to create a core system TypedError with automatic engine detection
- */
-export declare function createCoreTypedError<TEnum extends Record<string, string>>(type: TEnum[keyof TEnum], reasonMap: CompleteReasonMap<TEnum, CoreStringKey>, otherVars?: Record<string, string | number>, language?: string, instanceKey?: string): Error;
-/**
- * Create a simple error with translation support (generalized pattern from RegistryError)
- */
-export declare function createTranslatedError<TEnum extends Record<string, string>, TStringKey extends string>(engine: TranslationEngine, componentId: string, type: TEnum[keyof TEnum], reasonMap: Record<TEnum[keyof TEnum], TStringKey>, variables?: Record<string, string | number>, language?: string, metadata?: Record<string, any>, errorName?: string): Error;
-/**
- * Example usage of the new plugin-based TypedError system
- */