@digitaldefiance/i18n-lib 1.0.17 → 1.0.19

package/dist/context-manager.d.ts

@@ -2,10 +2,32 @@
  * 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>> {
-    private listeners;
+    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/context-manager.js

@@ -1,22 +1,36 @@
 "use strict";
-/**
- * Context change management for i18n systems
- */
 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 {
@@ -27,6 +41,11 @@ class ContextManager {
             }
         });
     }
+    /**
+     * 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, {

package/dist/currency-code.d.ts

@@ -1,7 +1,19 @@
+/**
+ * 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/currency-code.js

@@ -3,16 +3,28 @@ 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)();
     }

package/dist/currency-format.d.ts

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

package/dist/currency.d.ts

@@ -2,4 +2,10 @@
  * 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/currency.js

@@ -4,6 +4,12 @@
  */
 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',

package/dist/enum-registry.d.ts

@@ -1,9 +1,35 @@
 import { EnumLanguageTranslation } from './types';
+/**
+ * Registry for managing enum translations across multiple languages.
+ */
 export declare class EnumTranslationRegistry<TLanguage extends string> {
-    private translations;
-    private enumNames;
+    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;
 }

package/dist/enum-registry.js

@@ -1,15 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EnumTranslationRegistry = void 0;
+/**
+ * Registry for managing enum translations across multiple languages.
+ */
 class EnumTranslationRegistry {
     constructor() {
         this.translations = new Map();
         this.enumNames = new WeakMap();
     }
+    /**
+     * 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(enumObj, translations, enumName) {
         this.translations.set(enumObj, translations);
         this.enumNames.set(enumObj, enumName);
     }
+    /**
+     * 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(enumObj, value, language) {
         const translations = this.translations.get(enumObj);
         if (!translations) {
@@ -31,9 +47,19 @@ class EnumTranslationRegistry {
         }
         return result;
     }
+    /**
+     * Gets the name of the enumeration.
+     * @param enumObj The enumeration object
+     * @returns The name of the enumeration
+     */
     getEnumName(enumObj) {
         return this.enumNames.get(enumObj) || 'UnknownEnum';
     }
+    /**
+     * Checks if the registry has translations for the given enumeration.
+     * @param enumObj The enumeration object
+     * @returns True if translations exist, false otherwise
+     */
     has(enumObj) {
         return this.translations.has(enumObj);
     }

package/dist/i18n-engine.d.ts

@@ -1,5 +1,8 @@
 import { EnumTranslationRegistry } from './enum-registry';
 import { EnumLanguageTranslation, I18nConfig, I18nContext } from './types';
+/**
+ * Internationalization engine class
+ */
 export declare class I18nEngine<TStringKey extends string, TLanguage extends string, TConstants extends Record<string, any> = Record<string, any>, TContext extends string = string> {
     /**
      * Registry for enum translations

package/dist/i18n-engine.js

@@ -5,6 +5,9 @@ const context_1 = require("./context");
 const enum_registry_1 = require("./enum-registry");
 const template_1 = require("./template");
 const utils_1 = require("./utils");
+/**
+ * Internationalization engine class
+ */
 class I18nEngine {
     /**
      * Creates a new I18nEngine instance

package/dist/template.d.ts

@@ -2,6 +2,9 @@
  * 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

package/dist/template.js

@@ -1,7 +1,4 @@
 "use strict";
-/**
- * Template processing utilities for i18n
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createTemplateProcessor = createTemplateProcessor;
 /**

package/dist/timezone.d.ts

@@ -1,5 +1,11 @@
+/**
+ * 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

@@ -2,6 +2,9 @@
 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)) {
@@ -9,6 +12,9 @@ class Timezone {
         }
         this._timezone = timezone;
     }
+    /**
+     * Gets the timezone value.
+     */
     get value() {
         return this._timezone;
     }

package/dist/types.d.ts

@@ -1,13 +1,40 @@
 import { CurrencyCode } from './currency-code';
 import { Timezone } from './timezone';
+/**
+ * Standard language contexts
+ */
 export type LanguageContext = 'admin' | 'user' | 'system' | 'api';
+/**
+ * Default currency code
+ */
 export declare const DefaultCurrencyCode: string;
+/**
+ * Currency position type
+ */
 export type CurrencyPosition = 'prefix' | 'postfix' | 'infix';
+/**
+ * Custom language context type
+ */
 export type CustomLanguageContext<T extends string = LanguageContext> = T;
+/**
+ * Collection of localized strings for a specific language
+ */
 export type StringsCollection<TStringKey extends string> = Partial<Record<TStringKey, string>>;
+/**
+ * Mapping of languages to their respective string collections
+ */
 export type MasterStringsCollection<TStringKey extends string, TLanguage extends string> = Partial<Record<TLanguage, StringsCollection<TStringKey>>>;
+/**
+ * Mapping of language codes to their respective languages
+ */
 export type LanguageCodeCollection<TLanguage extends string> = Partial<Record<TLanguage, string>>;
+/**
+ * Mapping of enumeration values to their translations in multiple languages
+ */
 export type EnumTranslationMap<TEnum extends string | number, TLanguage extends string> = Partial<Record<TLanguage, Partial<Record<TEnum, string>>>>;
+/**
+ * I18n configuration interface
+ */
 export interface I18nConfig<TStringKey extends string, TLanguage extends string, TConstants extends Record<string, any> = Record<string, any>, TTranslationContext extends string = LanguageContext> {
     stringNames: TStringKey[];
     strings: MasterStringsCollection<TStringKey, TLanguage>;
@@ -22,6 +49,9 @@ export interface I18nConfig<TStringKey extends string, TLanguage extends string,
     timezone: Timezone;
     adminTimezone: Timezone;
 }
+/**
+ * I18n context interface
+ */
 export interface I18nContext<TLanguage extends string, TTranslationContext extends string = LanguageContext> {
     language: TLanguage;
     adminLanguage: TLanguage;

package/dist/types.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultCurrencyCode = void 0;
 exports.createTranslations = createTranslations;
+/**
+ * Default currency code
+ */
 exports.DefaultCurrencyCode = 'USD';
 /**
  * Helper function to create typed translations for an enumeration

package/dist/utils.d.ts

@@ -1,3 +1,34 @@
+/**
+ * Replaces variables in a string with their corresponding values from vars or constants.
+ * @param str - The string containing variables to replace
+ * @param vars - An object mapping variable names to their replacement values
+ * @param constants - An object containing constant values for replacement
+ * @returns The string with variables replaced
+ */
 export declare function replaceVariables(str: string, vars?: Record<string, string | number>, constants?: any): string;
+/**
+ * Checks if a given key indicates a template string.
+ * @param key - The key to check
+ * @returns True if the key indicates a template, false otherwise
+ */
 export declare function isTemplate(key: string): boolean;
+/**
+ * Checks if a given timezone string is valid.
+ * @param timezone - The timezone string to validate
+ * @returns
+ */
 export declare function isValidTimezone(timezone: string): boolean;
+/**
+ * Converts parts to a single string key, joining with underscores.
+ * @param parts - The parts to join
+ * @returns The joined string key
+ */
+export declare function toStringKey<TStringKey extends string>(...parts: (string)[]): TStringKey;
+/**
+ * Converts an enum value to a string key by joining parts with underscores and appending the enum value.
+ * @param enumObj - The enum object
+ * @param value - The enum value
+ * @param parts - Additional parts to join
+ * @returns The constructed string key
+ */
+export declare function toStringKeyFromEnum<TStringKey extends string, TEnum>(enumObj: TEnum, value: TEnum[keyof TEnum], ...parts: (string)[]): TStringKey;

package/dist/utils.js

@@ -6,7 +6,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.replaceVariables = replaceVariables;
 exports.isTemplate = isTemplate;
 exports.isValidTimezone = isValidTimezone;
+exports.toStringKey = toStringKey;
+exports.toStringKeyFromEnum = toStringKeyFromEnum;
 const moment_timezone_1 = __importDefault(require("moment-timezone"));
+/**
+ * Replaces variables in a string with their corresponding values from vars or constants.
+ * @param str - The string containing variables to replace
+ * @param vars - An object mapping variable names to their replacement values
+ * @param constants - An object containing constant values for replacement
+ * @returns The string with variables replaced
+ */
 function replaceVariables(str, vars, constants) {
     const variables = str.match(/\{(.+?)\}/g);
     if (!variables)
@@ -27,9 +36,37 @@ function replaceVariables(str, vars, constants) {
     }
     return result;
 }
+/**
+ * Checks if a given key indicates a template string.
+ * @param key - The key to check
+ * @returns True if the key indicates a template, false otherwise
+ */
 function isTemplate(key) {
-    return key.toLowerCase().endsWith('template');
+    return key.trim().toLowerCase().endsWith('template');
 }
+/**
+ * Checks if a given timezone string is valid.
+ * @param timezone - The timezone string to validate
+ * @returns
+ */
 function isValidTimezone(timezone) {
     return moment_timezone_1.default.tz.zone(timezone) !== null;
 }
+/**
+ * Converts parts to a single string key, joining with underscores.
+ * @param parts - The parts to join
+ * @returns The joined string key
+ */
+function toStringKey(...parts) {
+    return parts.join('_');
+}
+/**
+ * Converts an enum value to a string key by joining parts with underscores and appending the enum value.
+ * @param enumObj - The enum object
+ * @param value - The enum value
+ * @param parts - Additional parts to join
+ * @returns The constructed string key
+ */
+function toStringKeyFromEnum(enumObj, value, ...parts) {
+    return parts.join('_') + '_' + String(value);
+}

package/package.json

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