@digitaldefiance/i18n-lib 1.2.1 → 1.2.3

package/README.md

@@ -1059,6 +1059,27 @@ Part of the DigitalBurnbag project - a secure file sharing and automated protoco
 
 ## ChangeLog
 
+### Version 1.2.3
+
+- Thu Oct 23 2025 18:50:00 GMT-0700 (Pacific Daylight Time)
+  - Minor update to fix safeTranslate being private
+
+### Version 1.2.2
+
+- Thu Oct 23 2025 18:40:00 GMT-0700 (Pacific Daylight Time)
+
+**i18n Library - TranslationEngine Interface Refactoring**
+
+- Made `TranslationEngine` interface generic with `TStringKey` type parameter for improved type safety
+- Changed `translate` and `safeTranslate` methods from optional to required in `TranslationEngine` interface
+- Exported `TranslationEngine` from `typed-error.ts` for consistent usage across packages
+- Updated `TypedHandleableError` in ecies-lib to use generic `TranslationEngine<TStringKey>` instead of inline interface types
+- Updated test mocks to implement both required `translate` and `safeTranslate` methods
+
+**Breaking Changes:**
+- Any code implementing `TranslationEngine` must now provide both `translate` and `safeTranslate` methods (previously optional)
+- `TranslationEngine` now requires explicit type parameter when used (e.g., `TranslationEngine<EciesStringKey>`)
+
 ### Version 1.2.1
 
 - Thu Oct 23 2025 15:10:00 GMT-0700 (Pacific Daylight Time)

package/dist/i18n-engine.d.ts

@@ -112,7 +112,7 @@ export declare class I18nEngine<TStringKey extends string, TLanguage extends str
      * @param language The language to translate to
      * @returns The translated string or the key if translation fails
      */
-    private safeTranslate;
+    safeTranslate(key: TStringKey, vars?: Record<string, string | number>, language?: TLanguage): string;
     /**
      * Retrieves the string for the given language and key, throwing an error if not found.
      * @param language The language to get the string for

package/dist/index.d.ts

@@ -32,6 +32,7 @@ export * from './plugin-i18n-engine';
 export * from './registry-config';
 export * from './registry-error';
 export * from './registry-error-type';
+export * from './translation-engine';
 export * from './translation-request';
 export * from './translation-response';
 export { createCoreI18nEngine as createCoreI18n } from './core-i18n';

package/dist/index.js

@@ -51,6 +51,7 @@ __exportStar(require("./plugin-i18n-engine"), exports);
 __exportStar(require("./registry-config"), exports);
 __exportStar(require("./registry-error"), exports);
 __exportStar(require("./registry-error-type"), exports);
+__exportStar(require("./translation-engine"), exports);
 __exportStar(require("./translation-request"), exports);
 __exportStar(require("./translation-response"), exports);
 // Re-export for convenience

package/dist/translation-engine.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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/typed-error.d.ts

@@ -3,12 +3,8 @@ import { I18nEngine } from './i18n-engine';
 import { CoreLanguageCode } from './core-i18n';
 import { CoreStringKey } from './core-string-key';
 import { PluginI18nEngine } from './plugin-i18n-engine';
-/**
- * Interface for engines that can translate strings (unified interface)
- */
-export interface TranslationEngine {
-    safeTranslate(componentId: string, stringKey: string, variables?: Record<string, string | number>, language?: string): string;
-}
+import { TranslationEngine } from './translation-engine';
+export { TranslationEngine };
 /**
  * Type constraint to ensure reasonMap has entries for all enum values
  */

package/dist/typed-error.js

@@ -32,7 +32,7 @@ class BaseTypedError extends Error {
         let message;
         if (key && engine) {
             // Try to translate the error message using the engine
-            message = engine.safeTranslate(componentId, key, variables, language);
+            message = engine.safeTranslate(key, variables, language);
         }
         else {
             // Fallback to a basic English message
@@ -141,7 +141,7 @@ function createTranslatedError(engine, componentId, type, reasonMap, variables,
     if (key && engine) {
         try {
             // Try to translate the error message using the engine
-            message = engine.safeTranslate(componentId, key, variables, language);
+            message = engine.safeTranslate(key, variables, language);
         }
         catch (translationError) {
             // Fallback if translation fails

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitaldefiance/i18n-lib",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Generic i18n library with enum translation support",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/core-language.d.ts

@@ -1,13 +0,0 @@
-/**
- * Default languages supported by the core I18n system
- */
-export declare enum CoreLanguage {
-    EnglishUS = "en-US",
-    EnglishUK = "en-UK",
-    French = "fr",
-    Spanish = "es",
-    German = "de",
-    MandarinChinese = "zh-CN",
-    Japanese = "ja",
-    Ukrainian = "uk"
-}

package/dist/core-language.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoreLanguage = void 0;
-/**
- * Default languages supported by the core I18n system
- */
-var CoreLanguage;
-(function (CoreLanguage) {
-    CoreLanguage["EnglishUS"] = "en-US";
-    CoreLanguage["EnglishUK"] = "en-UK";
-    CoreLanguage["French"] = "fr";
-    CoreLanguage["Spanish"] = "es";
-    CoreLanguage["German"] = "de";
-    CoreLanguage["MandarinChinese"] = "zh-CN";
-    CoreLanguage["Japanese"] = "ja";
-    CoreLanguage["Ukrainian"] = "uk";
-})(CoreLanguage || (exports.CoreLanguage = CoreLanguage = {}));

package/dist/package.json

@@ -1,52 +0,0 @@
-{
-  "name": "@digitaldefiance/i18n-lib",
-  "version": "1.0.23",
-  "description": "Generic i18n library with enum translation support",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "yarn tsc",
-    "test": "yarn jest --detectOpenHandles",
-    "lint": "eslint src/**/*.ts tests/**/*.ts",
-    "lint:fix": "eslint src/**/*.ts tests/**/*.ts --fix",
-    "prettier:check": "prettier --check 'src/**/*.{ts,tsx}' 'tests/**/*.{ts,tsx}'",
-    "prettier:fix": "prettier --write 'src/**/*.{ts,tsx}' 'tests/**/*.{ts,tsx}'",
-    "format": "yarn prettier:fix && yarn lint:fix",
-    "prepublishOnly": "yarn build",
-    "publish:public": "npm publish --access public"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.31.1",
-    "@typescript-eslint/parser": "^8.31.1",
-    "eslint": "^9.8.0",
-    "eslint-config-prettier": "^10.1.2",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-prettier": "^5.3.1",
-    "jest": "^29.0.0",
-    "jest-util": "^30.0.5",
-    "prettier": "^2.6.2",
-    "prettier-plugin-organize-imports": "^4.1.0",
-    "ts-jest": "^29.0.0",
-    "typescript": "^5.9.2"
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "keywords": [
-    "i18n",
-    "internationalization",
-    "typescript",
-    "enum",
-    "translation"
-  ],
-  "author": "Digital Defiance",
-  "license": "MIT",
-  "packageManager": "yarn@4.10.3",
-  "dependencies": {
-    "moment": "^2.30.1",
-    "moment-timezone": "^0.6.0"
-  },
-  "type": "commonjs"
-}

package/dist/registry-context.d.ts

@@ -1,12 +0,0 @@
-import { CurrencyCode } from './currency-code';
-import { Timezone } from './timezone';
-/**
- * Translation context similar to existing I18nContext
- */
-export interface RegistryContext<TLanguages extends string> {
-    currentLanguage: TLanguages;
-    fallbackLanguage: TLanguages;
-    currencyCode: CurrencyCode;
-    timezone: Timezone;
-    adminTimezone: Timezone;
-}

package/dist/src/active-context.d.ts

@@ -1,29 +0,0 @@
-import { LanguageContext } from './types';
-import { Timezone } from './timezone';
-import { CurrencyCode } from './currency-code';
-export interface IActiveContext<TLanguage extends string> {
-    /**
-     * The default language for the user facing application
-     */
-    language: TLanguage;
-    /**
-     * The default language for the admin interface
-     */
-    adminLanguage: TLanguage;
-    /**
-     * The default currency code for the user facing application
-     */
-    currencyCode: CurrencyCode;
-    /**
-     * The default language context for the current context
-     */
-    currentContext: LanguageContext;
-    /**
-     * The default timezone for the user facing application
-     */
-    timezone: Timezone;
-    /**
-     * The default timezone for the admin interface
-     */
-    adminTimezone: Timezone;
-}

package/dist/src/active-context.js

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

package/dist/src/context-manager.d.ts

@@ -1,33 +0,0 @@
-/**
- * Context change management for i18n systems
- */
-export type ContextChangeListener<T = any> = (property: string, oldValue: T, newValue: T) => void;
-/**
- * Manages context changes and notifies listeners.
- */
-export declare class ContextManager<TContext extends Record<string, any>> {
-    protected listeners: ContextChangeListener[];
-    /**
-     * Adds a listener to be notified of context changes.
-     * @param listener - The listener function to add
-     */
-    addListener(listener: ContextChangeListener): void;
-    /**
-     * Removes a listener from the notification list.
-     * @param listener - The listener function to remove
-     */
-    removeListener(listener: ContextChangeListener): void;
-    /**
-     * Notifies all listeners of a context change.
-     * @param property - The property that changed
-     * @param oldValue - The old value of the property
-     * @param newValue - The new value of the property
-     */
-    notifyChange<K extends keyof TContext>(property: K, oldValue: TContext[K], newValue: TContext[K]): void;
-    /**
-     * Creates a proxy for the given context to automatically notify listeners on changes.
-     * @param context - The context object to proxy
-     * @returns A proxied version of the context object
-     */
-    createProxy(context: TContext): TContext;
-}

package/dist/src/context-manager.js

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContextManager = void 0;
-/**
- * Manages context changes and notifies listeners.
- */
-class ContextManager {
-    constructor() {
-        this.listeners = [];
-    }
-    /**
-     * Adds a listener to be notified of context changes.
-     * @param listener - The listener function to add
-     */
-    addListener(listener) {
-        this.listeners.push(listener);
-    }
-    /**
-     * Removes a listener from the notification list.
-     * @param listener - The listener function to remove
-     */
-    removeListener(listener) {
-        const index = this.listeners.indexOf(listener);
-        if (index > -1) {
-            this.listeners.splice(index, 1);
-        }
-    }
-    /**
-     * Notifies all listeners of a context change.
-     * @param property - The property that changed
-     * @param oldValue - The old value of the property
-     * @param newValue - The new value of the property
-     */
-    notifyChange(property, oldValue, newValue) {
-        this.listeners.forEach((listener) => {
-            try {
-                listener(property, oldValue, newValue);
-            }
-            catch (error) {
-                console.error('Error in context change listener:', error);
-            }
-        });
-    }
-    /**
-     * Creates a proxy for the given context to automatically notify listeners on changes.
-     * @param context - The context object to proxy
-     * @returns A proxied version of the context object
-     */
-    createProxy(context) {
-        const manager = this;
-        return new Proxy(context, {
-            set(target, property, value) {
-                const oldValue = target[property];
-                target[property] = value;
-                manager.notifyChange(property, oldValue, value);
-                return true;
-            },
-        });
-    }
-}
-exports.ContextManager = ContextManager;

package/dist/src/context.d.ts

@@ -1,43 +0,0 @@
-import { CurrencyCode } from './currency-code';
-import { Timezone } from './timezone';
-import { I18nContext, LanguageContext } from './types';
-/**
- * Creates a new I18n context with default values.
- * @param defaultLanguage - The default language for the context
- * @param defaultContext - The default language context
- * @param defaultCurrencyCode - The default currency code (defaults to USD)
- * @param defaultTimezone - The default timezone (defaults to UTC)
- * @param defaultAdminTimezone - The default admin timezone (defaults to UTC)
- * @returns A new I18nContext instance
- */
-export declare function createContext<TLanguage extends string, TTranslationContext extends string = LanguageContext, TContext extends I18nContext<TLanguage, TTranslationContext> = I18nContext<TLanguage, TTranslationContext>>(defaultLanguage: TLanguage, defaultContext: TTranslationContext, defaultCurrencyCode?: CurrencyCode, defaultTimezone?: Timezone, defaultAdminTimezone?: Timezone): TContext;
-/**
- * Sets the language for the given I18n context.
- * @param context - The I18n context to modify
- * @param language - The language to set
- */
-export declare function setLanguage<TLanguage extends string, TContext extends string = LanguageContext>(context: I18nContext<TLanguage, TContext>, language: TLanguage): void;
-/**
- * Sets the admin language for the given I18n context.
- * @param context - The I18n context to modify
- * @param language - The admin language to set
- */
-export declare function setAdminLanguage<TLanguage extends string, TContext extends string = LanguageContext>(context: I18nContext<TLanguage, TContext>, language: TLanguage): void;
-/**
- * Sets the current context for the given I18n context.
- * @param context - The I18n context to modify
- * @param languageContext - The language context to set
- */
-export declare function setContext<TLanguage extends string, TContext extends string = LanguageContext>(context: I18nContext<TLanguage, TContext>, languageContext: TContext): void;
-/**
- * Sets the timezone for the given I18n context.
- * @param context - The I18n context to modify
- * @param timezone - The timezone to set
- */
-export declare function setTimezone<TLanguage extends string, TContext extends string = LanguageContext>(context: I18nContext<TLanguage, TContext>, timezone: Timezone): void;
-/**
- * Sets the admin timezone for the given I18n context.
- * @param context - The I18n context to modify
- * @param timezone - The admin timezone to set
- */
-export declare function setAdminTimezone<TLanguage extends string, TContext extends string = LanguageContext>(context: I18nContext<TLanguage, TContext>, timezone: Timezone): void;

package/dist/src/context.js

@@ -1,69 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createContext = createContext;
-exports.setLanguage = setLanguage;
-exports.setAdminLanguage = setAdminLanguage;
-exports.setContext = setContext;
-exports.setTimezone = setTimezone;
-exports.setAdminTimezone = setAdminTimezone;
-const currency_code_1 = require("./currency-code");
-const timezone_1 = require("./timezone");
-/**
- * Creates a new I18n context with default values.
- * @param defaultLanguage - The default language for the context
- * @param defaultContext - The default language context
- * @param defaultCurrencyCode - The default currency code (defaults to USD)
- * @param defaultTimezone - The default timezone (defaults to UTC)
- * @param defaultAdminTimezone - The default admin timezone (defaults to UTC)
- * @returns A new I18nContext instance
- */
-function createContext(defaultLanguage, defaultContext, defaultCurrencyCode = new currency_code_1.CurrencyCode('USD'), defaultTimezone = new timezone_1.Timezone('UTC'), defaultAdminTimezone = new timezone_1.Timezone('UTC')) {
-    return {
-        language: defaultLanguage,
-        adminLanguage: defaultLanguage,
-        currencyCode: defaultCurrencyCode,
-        currentContext: defaultContext,
-        timezone: defaultTimezone,
-        adminTimezone: defaultAdminTimezone,
-    };
-}
-/**
- * Sets the language for the given I18n context.
- * @param context - The I18n context to modify
- * @param language - The language to set
- */
-function setLanguage(context, language) {
-    context.language = language;
-}
-/**
- * Sets the admin language for the given I18n context.
- * @param context - The I18n context to modify
- * @param language - The admin language to set
- */
-function setAdminLanguage(context, language) {
-    context.adminLanguage = language;
-}
-/**
- * Sets the current context for the given I18n context.
- * @param context - The I18n context to modify
- * @param languageContext - The language context to set
- */
-function setContext(context, languageContext) {
-    context.currentContext = languageContext;
-}
-/**
- * Sets the timezone for the given I18n context.
- * @param context - The I18n context to modify
- * @param timezone - The timezone to set
- */
-function setTimezone(context, timezone) {
-    context.timezone = timezone;
-}
-/**
- * Sets the admin timezone for the given I18n context.
- * @param context - The I18n context to modify
- * @param timezone - The admin timezone to set
- */
-function setAdminTimezone(context, timezone) {
-    context.adminTimezone = timezone;
-}

package/dist/src/currency-code.d.ts

@@ -1,19 +0,0 @@
-/**
- * Class representing a validated currency code.
- */
-export declare class CurrencyCode {
-    private _value;
-    /**
-     * Gets the currency code value.
-     */
-    get value(): string;
-    /**
-     * Sets the currency code value after validating it.
-     */
-    set value(value: string);
-    /**
-     * Gets the list of all valid currency codes.
-     */
-    static get values(): string[];
-    constructor(value?: string);
-}

package/dist/src/currency-code.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CurrencyCode = void 0;
-const currency_codes_1 = require("currency-codes");
-const types_1 = require("./types");
-/**
- * Class representing a validated currency code.
- */
-class CurrencyCode {
-    /**
-     * Gets the currency code value.
-     */
-    get value() {
-        return this._value;
-    }
-    /**
-     * Sets the currency code value after validating it.
-     */
-    set value(value) {
-        if (!CurrencyCode.values.includes(value)) {
-            throw new Error('Invalid currency code');
-        }
-        this._value = value;
-    }
-    /**
-     * Gets the list of all valid currency codes.
-     */
-    static get values() {
-        return (0, currency_codes_1.codes)();
-    }
-    constructor(value = types_1.DefaultCurrencyCode) {
-        this._value = types_1.DefaultCurrencyCode;
-        this.value = value;
-    }
-}
-exports.CurrencyCode = CurrencyCode;

package/dist/src/currency-format.d.ts

@@ -1,10 +0,0 @@
-import { CurrencyPosition } from './types';
-/**
- * Represents the format details for a specific currency in a given locale.
- */
-export interface CurrencyFormat {
-    symbol: string;
-    position: CurrencyPosition;
-    groupSeparator: string;
-    decimalSeparator: string;
-}

package/dist/src/currency-format.js

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

package/dist/src/currency.d.ts

@@ -1,11 +0,0 @@
-/**
- * Currency formatting utilities
- */
-import { CurrencyFormat } from './currency-format';
-/**
- * Get currency format details for a given locale and currency code.
- * @param locale The locale string (e.g., 'en-US')
- * @param currencyCode The ISO 4217 currency code (e.g., 'USD')
- * @returns The currency format details
- */
-export declare function getCurrencyFormat(locale: string, currencyCode: string): CurrencyFormat;

package/dist/src/currency.js

@@ -1,48 +0,0 @@
-"use strict";
-/**
- * Currency formatting utilities
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCurrencyFormat = getCurrencyFormat;
-/**
- * Get currency format details for a given locale and currency code.
- * @param locale The locale string (e.g., 'en-US')
- * @param currencyCode The ISO 4217 currency code (e.g., 'USD')
- * @returns The currency format details
- */
-function getCurrencyFormat(locale, currencyCode) {
-    const formatter = new Intl.NumberFormat(locale, {
-        style: 'currency',
-        currency: currencyCode,
-    });
-    const parts = formatter.formatToParts(1234567.89);
-    const symbol = parts.find((part) => part.type === 'currency')?.value || '';
-    const symbolIndex = parts.findIndex((part) => part.type === 'currency');
-    const decimalIndex = parts.findIndex((part) => part.type === 'decimal');
-    const integerIndex = parts.findIndex((part) => part.type === 'integer');
-    let position;
-    if (decimalIndex === -1) {
-        // No decimal separator
-        if (symbolIndex < integerIndex) {
-            position = 'prefix';
-        }
-        else {
-            position = 'postfix';
-        }
-    }
-    else if (symbolIndex < decimalIndex && symbolIndex < integerIndex) {
-        position = 'prefix';
-    }
-    else if (symbolIndex > decimalIndex) {
-        position = 'postfix';
-    }
-    else {
-        position = 'infix';
-    }
-    return {
-        symbol,
-        position,
-        groupSeparator: parts.find((part) => part.type === 'group')?.value || ',',
-        decimalSeparator: parts.find((part) => part.type === 'decimal')?.value || '.',
-    };
-}

package/dist/src/enum-registry.d.ts

@@ -1,35 +0,0 @@
-import { EnumLanguageTranslation } from './types';
-/**
- * Registry for managing enum translations across multiple languages.
- */
-export declare class EnumTranslationRegistry<TLanguage extends string> {
-    protected translations: Map<any, Partial<{ [L in TLanguage]: import("./types").EnumTranslation<any>; }>>;
-    protected enumNames: WeakMap<any, string>;
-    /**
-     * Registers an enumeration with its translations and a name.
-     * @param enumObj The enumeration object
-     * @param translations The translations for the enumeration
-     * @param enumName The name of the enumeration
-     */
-    register<TEnum extends string | number>(enumObj: Record<string, TEnum>, translations: EnumLanguageTranslation<TEnum, TLanguage>, enumName: string): void;
-    /**
-     * Translates a value from the given enumeration to the specified language.
-     * @param enumObj The enumeration object
-     * @param value The value to translate
-     * @param language The target language for translation
-     * @returns The translated string
-     */
-    translate<TEnum extends string | number>(enumObj: Record<string, TEnum>, value: TEnum, language: TLanguage): string;
-    /**
-     * Gets the name of the enumeration.
-     * @param enumObj The enumeration object
-     * @returns The name of the enumeration
-     */
-    private getEnumName;
-    /**
-     * Checks if the registry has translations for the given enumeration.
-     * @param enumObj The enumeration object
-     * @returns True if translations exist, false otherwise
-     */
-    has(enumObj: any): boolean;
-}