@digitaldefiance/i18n-lib 3.6.1 → 3.6.3

package/src/types/plural-types.d.ts

@@ -3,15 +3,22 @@
  */
 import { PluralCategory } from '../pluralization/plural-categories';
 /**
- * A string value that can be either a simple string or an object with plural forms
+ * A string value that can be either a simple string or an object with plural forms.
+ * When using plural forms, the object should have keys matching PluralCategory values.
  */
 export type PluralString = string | Partial<Record<PluralCategory, string>>;
 /**
- * Check if a value is a plural string object (not a simple string)
+ * Check if a value is a plural string object (not a simple string).
+ * @param value - The value to check
+ * @returns True if the value is a plural string object, false if it's a simple string
  */
 export declare function isPluralString(value: any): value is Record<PluralCategory, string>;
 /**
- * Get the appropriate plural form from a PluralString
+ * Get the appropriate plural form from a PluralString based on the category.
+ * Falls back to 'other' if the exact category is not found, then to the first available form.
+ * @param value - The PluralString to resolve (either a string or plural forms object)
+ * @param category - The plural category to retrieve
+ * @returns The resolved string, or undefined if no suitable form is found
  */
 export declare function resolvePluralString(value: PluralString, category: PluralCategory): string | undefined;
 //# sourceMappingURL=plural-types.d.ts.map

package/src/types/plural-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plural-types.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/types/plural-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;AAE5E;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAElF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,cAAc,GACvB,MAAM,GAAG,SAAS,CAkBpB"}
+{"version":3,"file":"plural-types.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/types/plural-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;AAE5E;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAElF;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,YAAY,EACnB,QAAQ,EAAE,cAAc,GACvB,MAAM,GAAG,SAAS,CAkBpB"}

package/src/types/plural-types.js

@@ -6,13 +6,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPluralString = isPluralString;
 exports.resolvePluralString = resolvePluralString;
 /**
- * Check if a value is a plural string object (not a simple string)
+ * Check if a value is a plural string object (not a simple string).
+ * @param value - The value to check
+ * @returns True if the value is a plural string object, false if it's a simple string
  */
 function isPluralString(value) {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
 /**
- * Get the appropriate plural form from a PluralString
+ * Get the appropriate plural form from a PluralString based on the category.
+ * Falls back to 'other' if the exact category is not found, then to the first available form.
+ * @param value - The PluralString to resolve (either a string or plural forms object)
+ * @param category - The plural category to retrieve
+ * @returns The resolved string, or undefined if no suitable form is found
  */
 function resolvePluralString(value, category) {
     if (typeof value === 'string') {

package/src/types/plural-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"plural-types.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/types/plural-types.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAYH,wCAEC;AAKD,kDAqBC;AA/BD;;GAEG;AACH,SAAgB,cAAc,CAAC,KAAU;IACvC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CACjC,KAAmB,EACnB,QAAwB;IAExB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wBAAwB;IACxB,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;IAED,sBAAsB;IACtB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;IAED,mCAAmC;IACnC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACjD,CAAC"}
+{"version":3,"file":"plural-types.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/types/plural-types.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAeH,wCAEC;AASD,kDAqBC;AArCD;;;;GAIG;AACH,SAAgB,cAAc,CAAC,KAAU;IACvC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,KAAmB,EACnB,QAAwB;IAExB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wBAAwB;IACxB,IAAI,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpB,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;IAED,sBAAsB;IACtB,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAChB,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;IAED,mCAAmC;IACnC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACnC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACjD,CAAC"}

package/src/utils/currency.d.ts

@@ -1,28 +1,81 @@
 /**
  * Currency utilities (v2)
  */
+/**
+ * Position of the currency symbol relative to the amount.
+ */
 export type CurrencyPosition = 'prefix' | 'postfix' | 'infix';
+/**
+ * Configuration for formatting currency values in a specific locale.
+ */
 export interface CurrencyFormat {
+    /** The currency symbol (e.g., "$", "€") */
     symbol: string;
+    /** Position of the symbol relative to the amount */
     position: CurrencyPosition;
+    /** Character used to separate thousands (e.g., ",") */
     groupSeparator: string;
+    /** Character used to separate decimal places (e.g., ".") */
     decimalSeparator: string;
 }
+/**
+ * Detailed information about a currency.
+ */
 export interface CurrencyData {
+    /** ISO 4217 currency code (e.g., "USD") */
     code: string;
+    /** Numeric currency code */
     number: string;
+    /** Number of decimal digits */
     digits: number;
+    /** Currency name */
     currency: string;
+    /** Countries using this currency */
     countries: string[];
 }
+/**
+ * Represents a valid ISO 4217 currency code with validation.
+ */
 export declare class CurrencyCode {
     private _value;
+    /**
+     * Creates a new CurrencyCode instance.
+     * @param value - The ISO 4217 currency code (defaults to 'USD')
+     * @throws {TranslatableError} If the currency code is invalid
+     */
     constructor(value?: string);
+    /**
+     * Gets the currency code value.
+     * @returns The ISO 4217 currency code
+     */
     get value(): string;
+    /**
+     * Gets the currency code (alias for value).
+     * @returns The ISO 4217 currency code
+     */
     get code(): string;
+    /**
+     * Checks if a currency code is valid according to ISO 4217.
+     * @param code - The currency code to validate
+     * @returns True if the code is valid, false otherwise
+     */
     static isValid(code: string): boolean;
+    /**
+     * Gets all valid ISO 4217 currency codes.
+     * @returns Array of currency codes
+     */
     static getAll(): string[];
+    /**
+     * Gets detailed information for all currencies.
+     * @returns Array of currency data objects
+     */
     static getAllData(): CurrencyData[];
 }
+/**
+ * Gets the currency formatting rules for a specific locale and currency.
+ * @param locale - The locale code (e.g., 'en-US', 'fr-FR')
+ * @param currencyCode - The ISO 4217 currency code
+ * @returns Currency format configuration including symbol, position, and separators
+ */
 export declare function getCurrencyFormat(locale: string, currencyCode: string): CurrencyFormat;
 //# sourceMappingURL=currency.d.ts.map

package/src/utils/currency.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/currency.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC;AAE9D,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAS;gBAEX,KAAK,GAAE,MAAc;IAWjC,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIrC,MAAM,CAAC,MAAM,IAAI,MAAM,EAAE;IAIzB,MAAM,CAAC,UAAU,IAAI,YAAY,EAAE;CAGpC;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,cAAc,CA6BtF"}
+{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/currency.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,uDAAuD;IACvD,cAAc,EAAE,MAAM,CAAC;IACvB,4DAA4D;IAC5D,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,KAAK,GAAE,MAAc;IAWjC;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIrC;;;OAGG;IACH,MAAM,CAAC,MAAM,IAAI,MAAM,EAAE;IAIzB;;;OAGG;IACH,MAAM,CAAC,UAAU,IAAI,YAAY,EAAE;CAGpC;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,cAAc,CA6BtF"}

package/src/utils/currency.js

@@ -8,31 +8,66 @@ exports.getCurrencyFormat = getCurrencyFormat;
 const currency_codes_1 = require("currency-codes");
 const translatable_1 = require("../errors/translatable");
 const core_string_key_1 = require("../core-string-key");
+/**
+ * Represents a valid ISO 4217 currency code with validation.
+ */
 class CurrencyCode {
     _value;
+    /**
+     * Creates a new CurrencyCode instance.
+     * @param value - The ISO 4217 currency code (defaults to 'USD')
+     * @throws {TranslatableError} If the currency code is invalid
+     */
     constructor(value = 'USD') {
         if (!CurrencyCode.isValid(value)) {
             throw new translatable_1.TranslatableError('core', core_string_key_1.CoreStringKey.Error_InvalidCurrencyCodeTemplate, { value });
         }
         this._value = value;
     }
+    /**
+     * Gets the currency code value.
+     * @returns The ISO 4217 currency code
+     */
     get value() {
         return this._value;
     }
+    /**
+     * Gets the currency code (alias for value).
+     * @returns The ISO 4217 currency code
+     */
     get code() {
         return this._value;
     }
+    /**
+     * Checks if a currency code is valid according to ISO 4217.
+     * @param code - The currency code to validate
+     * @returns True if the code is valid, false otherwise
+     */
     static isValid(code) {
         return (0, currency_codes_1.codes)().includes(code);
     }
+    /**
+     * Gets all valid ISO 4217 currency codes.
+     * @returns Array of currency codes
+     */
     static getAll() {
         return (0, currency_codes_1.codes)();
     }
+    /**
+     * Gets detailed information for all currencies.
+     * @returns Array of currency data objects
+     */
     static getAllData() {
         return currency_codes_1.data;
     }
 }
 exports.CurrencyCode = CurrencyCode;
+/**
+ * Gets the currency formatting rules for a specific locale and currency.
+ * @param locale - The locale code (e.g., 'en-US', 'fr-FR')
+ * @param currencyCode - The ISO 4217 currency code
+ * @returns Currency format configuration including symbol, position, and separators
+ */
 function getCurrencyFormat(locale, currencyCode) {
     const formatter = new Intl.NumberFormat(locale, {
         style: 'currency',

package/src/utils/currency.js.map

@@ -1 +1 @@
-{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/currency.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA0DH,8CA6BC;AArFD,mDAA6C;AAC7C,yDAA2D;AAC3D,wDAAmD;AAmBnD,MAAa,YAAY;IACf,MAAM,CAAS;IAEvB,YAAY,QAAgB,KAAK;QAC/B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,gCAAiB,CACzB,MAAM,EACN,+BAAa,CAAC,iCAAiC,EAC/C,EAAE,KAAK,EAAE,CACV,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,IAAY;QACzB,OAAO,IAAA,sBAAK,GAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,MAAM;QACX,OAAO,IAAA,sBAAK,GAAE,CAAC;IACjB,CAAC;IAED,MAAM,CAAC,UAAU;QACf,OAAO,qBAAsB,CAAC;IAChC,CAAC;CACF;AAjCD,oCAiCC;AAED,SAAgB,iBAAiB,CAAC,MAAc,EAAE,YAAoB;IACpE,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;QAC9C,KAAK,EAAE,UAAU;QACjB,QAAQ,EAAE,YAAY;KACvB,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;IAC3E,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IACxE,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IACxE,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAExE,IAAI,QAA0B,CAAC;IAC/B,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;QACxB,QAAQ,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;SAAM,IAAI,WAAW,GAAG,YAAY,IAAI,WAAW,GAAG,YAAY,EAAE,CAAC;QACpE,QAAQ,GAAG,QAAQ,CAAC;IACtB,CAAC;SAAM,IAAI,WAAW,GAAG,YAAY,EAAE,CAAC;QACtC,QAAQ,GAAG,SAAS,CAAC;IACvB,CAAC;SAAM,CAAC;QACN,QAAQ,GAAG,OAAO,CAAC;IACrB,CAAC;IAED,OAAO;QACL,MAAM;QACN,QAAQ;QACR,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,KAAK,IAAI,GAAG;QACzE,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,KAAK,IAAI,GAAG;KAC9E,CAAC;AACJ,CAAC"}
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/currency.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA+GH,8CA6BC;AA1ID,mDAA6C;AAC7C,yDAA2D;AAC3D,wDAAmD;AAqCnD;;GAEG;AACH,MAAa,YAAY;IACf,MAAM,CAAS;IAEvB;;;;OAIG;IACH,YAAY,QAAgB,KAAK;QAC/B,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,gCAAiB,CACzB,MAAM,EACN,+BAAa,CAAC,iCAAiC,EAC/C,EAAE,KAAK,EAAE,CACV,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,OAAO,CAAC,IAAY;QACzB,OAAO,IAAA,sBAAK,GAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAM;QACX,OAAO,IAAA,sBAAK,GAAE,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,UAAU;QACf,OAAO,qBAAsB,CAAC;IAChC,CAAC;CACF;AA3DD,oCA2DC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,MAAc,EAAE,YAAoB;IACpE,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;QAC9C,KAAK,EAAE,UAAU;QACjB,QAAQ,EAAE,YAAY;KACvB,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;IAC3E,MAAM,WAAW,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IACxE,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IACxE,MAAM,YAAY,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAExE,IAAI,QAA0B,CAAC;IAC/B,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;QACxB,QAAQ,GAAG,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;SAAM,IAAI,WAAW,GAAG,YAAY,IAAI,WAAW,GAAG,YAAY,EAAE,CAAC;QACpE,QAAQ,GAAG,QAAQ,CAAC;IACtB,CAAC;SAAM,IAAI,WAAW,GAAG,YAAY,EAAE,CAAC;QACtC,QAAQ,GAAG,SAAS,CAAC;IACvB,CAAC;SAAM,CAAC;QACN,QAAQ,GAAG,OAAO,CAAC;IACrB,CAAC;IAED,OAAO;QACL,MAAM;QACN,QAAQ;QACR,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,KAAK,IAAI,GAAG;QACzE,gBAAgB,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,KAAK,IAAI,GAAG;KAC9E,CAAC;AACJ,CAAC"}

package/src/utils/html-escape.d.ts

@@ -1,7 +1,21 @@
 /**
  * HTML escaping utilities for XSS prevention
  */
+/**
+ * Escapes HTML special characters to prevent XSS attacks.
+ * @param str - The string to escape
+ * @returns The escaped string
+ */
 export declare function escapeHtml(str: string): string;
+/**
+ * Safely converts a value to a string, optionally escaping HTML.
+ * Rejects objects to prevent toString exploits.
+ * @param value - The value to stringify
+ * @param options - Options including whether to escape HTML
+ * @param options.escapeHtml - If true, HTML-escapes the result
+ * @returns The stringified value
+ * @throws {Error} If the value is an object (to prevent exploits)
+ */
 export declare function safeStringify(value: any, options?: {
     escapeHtml?: boolean;
 }): string;

package/src/utils/html-escape.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"html-escape.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/html-escape.ts"],"names":[],"mappings":"AAAA;;GAEG;AAaH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAepF"}
+{"version":3,"file":"html-escape.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/html-escape.ts"],"names":[],"mappings":"AAAA;;GAEG;AAmBH;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE;IAAE,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAepF"}

package/src/utils/html-escape.js

@@ -5,6 +5,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.escapeHtml = escapeHtml;
 exports.safeStringify = safeStringify;
+/**
+ * Map of HTML characters to their escaped equivalents.
+ */
 const HTML_ESCAPES = {
     '&': '&',
     '<': '&lt;',
@@ -13,10 +16,27 @@ const HTML_ESCAPES = {
     "'": '&#x27;',
     '/': '&#x2F;',
 };
+/**
+ * Regular expression to match characters that need HTML escaping.
+ */
 const HTML_ESCAPE_REGEX = /[&<>"'/]/g;
+/**
+ * Escapes HTML special characters to prevent XSS attacks.
+ * @param str - The string to escape
+ * @returns The escaped string
+ */
 function escapeHtml(str) {
     return str.replace(HTML_ESCAPE_REGEX, char => HTML_ESCAPES[char]);
 }
+/**
+ * Safely converts a value to a string, optionally escaping HTML.
+ * Rejects objects to prevent toString exploits.
+ * @param value - The value to stringify
+ * @param options - Options including whether to escape HTML
+ * @param options.escapeHtml - If true, HTML-escapes the result
+ * @returns The stringified value
+ * @throws {Error} If the value is an object (to prevent exploits)
+ */
 function safeStringify(value, options) {
     if (value === null || value === undefined) {
         return '';

package/src/utils/html-escape.js.map

@@ -1 +1 @@
-{"version":3,"file":"html-escape.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/html-escape.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAaH,gCAEC;AAED,sCAeC;AA9BD,MAAM,YAAY,GAA2B;IAC3C,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,QAAQ;IACb,GAAG,EAAE,QAAQ;IACb,GAAG,EAAE,QAAQ;CACd,CAAC;AAEF,MAAM,iBAAiB,GAAG,WAAW,CAAC;AAEtC,SAAgB,UAAU,CAAC,GAAW;IACpC,OAAO,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;AACpE,CAAC;AAED,SAAgB,aAAa,CAAC,KAAU,EAAE,OAAkC;IAC1E,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACzD,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC5D,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,8CAA8C;IAC9C,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;AAC5D,CAAC"}
+{"version":3,"file":"html-escape.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/html-escape.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAwBH,gCAEC;AAWD,sCAeC;AAlDD;;GAEG;AACH,MAAM,YAAY,GAA2B;IAC3C,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,QAAQ;IACb,GAAG,EAAE,QAAQ;IACb,GAAG,EAAE,QAAQ;CACd,CAAC;AAEF;;GAEG;AACH,MAAM,iBAAiB,GAAG,WAAW,CAAC;AAEtC;;;;GAIG;AACH,SAAgB,UAAU,CAAC,GAAW;IACpC,OAAO,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;AACpE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAAC,KAAU,EAAE,OAAkC;IAC1E,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACzD,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC5D,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,8CAA8C;IAC9C,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;AAC5D,CAAC"}

package/src/utils/lru-cache.d.ts

@@ -1,13 +1,42 @@
 /**
  * Simple LRU Cache implementation for security
  */
+/**
+ * Least Recently Used (LRU) cache implementation.
+ * Automatically evicts the oldest entries when the cache reaches maximum size.
+ * @template K - The type of cache keys
+ * @template V - The type of cached values
+ */
 export declare class LRUCache<K, V> {
     private cache;
     private readonly maxSize;
+    /**
+     * Creates a new LRUCache instance.
+     * @param maxSize - Maximum number of entries to store (default: 1000)
+     */
     constructor(maxSize?: number);
+    /**
+     * Retrieves a value from the cache by key.
+     * Accessing an item moves it to the end (marks it as most recently used).
+     * @param key - The key to look up
+     * @returns The cached value, or undefined if not found
+     */
     get(key: K): V | undefined;
+    /**
+     * Adds or updates a value in the cache.
+     * If the cache is at capacity, the oldest entry is removed.
+     * @param key - The key to store
+     * @param value - The value to cache
+     */
     set(key: K, value: V): void;
+    /**
+     * Removes all entries from the cache.
+     */
     clear(): void;
+    /**
+     * Gets the current number of entries in the cache.
+     * @returns The number of cached entries
+     */
     size(): number;
 }
 //# sourceMappingURL=lru-cache.d.ts.map

package/src/utils/lru-cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lru-cache.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/lru-cache.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,qBAAa,QAAQ,CAAC,CAAC,EAAE,CAAC;IACxB,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,OAAO,GAAE,MAAa;IAIlC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAU1B,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAiB3B,KAAK,IAAI,IAAI;IAIb,IAAI,IAAI,MAAM;CAGf"}
+{"version":3,"file":"lru-cache.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/lru-cache.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;GAKG;AACH,qBAAa,QAAQ,CAAC,CAAC,EAAE,CAAC;IACxB,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;;OAGG;gBACS,OAAO,GAAE,MAAa;IAIlC;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAU1B;;;;;OAKG;IACH,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAiB3B;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;;OAGG;IACH,IAAI,IAAI,MAAM;CAGf"}

package/src/utils/lru-cache.js

@@ -4,12 +4,28 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LRUCache = void 0;
+/**
+ * Least Recently Used (LRU) cache implementation.
+ * Automatically evicts the oldest entries when the cache reaches maximum size.
+ * @template K - The type of cache keys
+ * @template V - The type of cached values
+ */
 class LRUCache {
     cache = new Map();
     maxSize;
+    /**
+     * Creates a new LRUCache instance.
+     * @param maxSize - Maximum number of entries to store (default: 1000)
+     */
     constructor(maxSize = 1000) {
         this.maxSize = maxSize;
     }
+    /**
+     * Retrieves a value from the cache by key.
+     * Accessing an item moves it to the end (marks it as most recently used).
+     * @param key - The key to look up
+     * @returns The cached value, or undefined if not found
+     */
     get(key) {
         const value = this.cache.get(key);
         if (value !== undefined) {
@@ -19,6 +35,12 @@ class LRUCache {
         }
         return value;
     }
+    /**
+     * Adds or updates a value in the cache.
+     * If the cache is at capacity, the oldest entry is removed.
+     * @param key - The key to store
+     * @param value - The value to cache
+     */
     set(key, value) {
         // Remove if exists to update position
         if (this.cache.has(key)) {
@@ -33,9 +55,16 @@ class LRUCache {
         }
         this.cache.set(key, value);
     }
+    /**
+     * Removes all entries from the cache.
+     */
     clear() {
         this.cache.clear();
     }
+    /**
+     * Gets the current number of entries in the cache.
+     * @returns The number of cached entries
+     */
     size() {
         return this.cache.size;
     }

package/src/utils/lru-cache.js.map

@@ -1 +1 @@
-{"version":3,"file":"lru-cache.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/lru-cache.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,MAAa,QAAQ;IACX,KAAK,GAAG,IAAI,GAAG,EAAQ,CAAC;IACf,OAAO,CAAS;IAEjC,YAAY,UAAkB,IAAI;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,GAAG,CAAC,GAAM;QACR,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,mCAAmC;YACnC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,GAAG,CAAC,GAAM,EAAE,KAAQ;QAClB,sCAAsC;QACtC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QAED,+BAA+B;QAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;YAChD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;CACF;AA1CD,4BA0CC"}
+{"version":3,"file":"lru-cache.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/lru-cache.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH;;;;;GAKG;AACH,MAAa,QAAQ;IACX,KAAK,GAAG,IAAI,GAAG,EAAQ,CAAC;IACf,OAAO,CAAS;IAEjC;;;OAGG;IACH,YAAY,UAAkB,IAAI;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,GAAM;QACR,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,mCAAmC;YACnC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,GAAM,EAAE,KAAQ;QAClB,sCAAsC;QACtC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;QAED,+BAA+B;QAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;YAChD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;CACF;AAjED,4BAiEC"}

package/src/utils/plural-helpers.d.ts

@@ -4,7 +4,23 @@
 import { PluralCategory } from '../pluralization/plural-categories';
 import { PluralString } from '../types/plural-types';
 import { GenderCategory, GenderedString } from '../gender/gender-categories';
+/**
+ * Creates a PluralString from a partial record of plural forms.
+ * @param forms - Object mapping plural categories to their string forms
+ * @returns A PluralString that can be used in translations
+ */
 export declare function createPluralString(forms: Partial<Record<PluralCategory, string>>): PluralString;
+/**
+ * Creates a GenderedString from a partial record of gender forms.
+ * @param forms - Object mapping gender categories to their string forms
+ * @returns A GenderedString that can be used in translations
+ */
 export declare function createGenderedString(forms: Partial<Record<GenderCategory, string>>): GenderedString;
+/**
+ * Gets the required plural forms for a given language.
+ * Different languages have different plural rules and require different forms.
+ * @param language - The language code
+ * @returns Array of plural categories required for the language
+ */
 export declare function getRequiredPluralForms(language: string): PluralCategory[];
 //# sourceMappingURL=plural-helpers.d.ts.map

package/src/utils/plural-helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plural-helpers.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/plural-helpers.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAG7E,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,GAAG,YAAY,CAE/F;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,GAAG,cAAc,CAEnG;AAED,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,EAAE,CAEzE"}
+{"version":3,"file":"plural-helpers.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/plural-helpers.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAG7E;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,GAAG,YAAY,CAE/F;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,GAAG,cAAc,CAEnG;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,EAAE,CAEzE"}

package/src/utils/plural-helpers.js

@@ -7,12 +7,28 @@ exports.createPluralString = createPluralString;
 exports.createGenderedString = createGenderedString;
 exports.getRequiredPluralForms = getRequiredPluralForms;
 const language_plural_map_1 = require("../pluralization/language-plural-map");
+/**
+ * Creates a PluralString from a partial record of plural forms.
+ * @param forms - Object mapping plural categories to their string forms
+ * @returns A PluralString that can be used in translations
+ */
 function createPluralString(forms) {
     return forms;
 }
+/**
+ * Creates a GenderedString from a partial record of gender forms.
+ * @param forms - Object mapping gender categories to their string forms
+ * @returns A GenderedString that can be used in translations
+ */
 function createGenderedString(forms) {
     return forms;
 }
+/**
+ * Gets the required plural forms for a given language.
+ * Different languages have different plural rules and require different forms.
+ * @param language - The language code
+ * @returns Array of plural categories required for the language
+ */
 function getRequiredPluralForms(language) {
     return (0, language_plural_map_1.getRequiredPluralForms)(language);
 }

package/src/utils/plural-helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"plural-helpers.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/plural-helpers.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAOH,gDAEC;AAED,oDAEC;AAED,wDAEC;AAZD,8EAAyG;AAEzG,SAAgB,kBAAkB,CAAC,KAA8C;IAC/E,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAgB,oBAAoB,CAAC,KAA8C;IACjF,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAgB,sBAAsB,CAAC,QAAgB;IACrD,OAAO,IAAA,4CAAuB,EAAC,QAAQ,CAAqB,CAAC;AAC/D,CAAC"}
+{"version":3,"file":"plural-helpers.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/plural-helpers.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAYH,gDAEC;AAOD,oDAEC;AAQD,wDAEC;AA5BD,8EAAyG;AAEzG;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,KAA8C;IAC/E,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,KAA8C;IACjF,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,QAAgB;IACrD,OAAO,IAAA,4CAAuB,EAAC,QAAQ,CAAqB,CAAC;AAC/D,CAAC"}

package/src/utils/safe-object.d.ts

@@ -1,9 +1,39 @@
 /**
  * Safe object utilities to prevent prototype pollution
  */
+/**
+ * Creates a safe object without a prototype chain.
+ * This prevents prototype pollution attacks.
+ * @template T - The type of values in the object
+ * @returns A new object without a prototype
+ */
 export declare function createSafeObject<T = any>(): Record<string, T>;
+/**
+ * Checks if a key is in the list of dangerous keys that could enable prototype pollution.
+ * @param key - The key to check
+ * @returns True if the key is dangerous, false otherwise
+ */
 export declare function isDangerousKey(key: string): boolean;
+/**
+ * Safely assigns properties from source objects to a target object.
+ * Filters out dangerous keys to prevent prototype pollution.
+ * @template T - The type of the target object
+ * @param target - The target object to assign to
+ * @param sources - One or more source objects to copy properties from
+ * @returns The target object with properties assigned
+ */
 export declare function safeAssign<T extends Record<string, any>>(target: T, ...sources: Array<Record<string, any> | undefined>): T;
+/**
+ * Gets key-value pairs from an object, filtering out dangerous keys.
+ * @template T - The type of values in the object
+ * @param obj - The object to get entries from
+ * @returns Array of [key, value] pairs, excluding dangerous keys
+ */
 export declare function safeObjectEntries<T>(obj: Record<string, T>): Array<[string, T]>;
+/**
+ * Validates that an object does not contain dangerous keys.
+ * @param obj - The object to validate
+ * @throws {Error} If a dangerous key is detected
+ */
 export declare function validateObjectKeys(obj: Record<string, any>): void;
 //# sourceMappingURL=safe-object.d.ts.map

package/src/utils/safe-object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"safe-object.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/safe-object.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,wBAAgB,gBAAgB,CAAC,CAAC,GAAG,GAAG,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAE7D;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACtD,MAAM,EAAE,CAAC,EACT,GAAG,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,GACjD,CAAC,CAWH;AAED,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAE/E;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAUjE"}
+{"version":3,"file":"safe-object.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/safe-object.ts"],"names":[],"mappings":"AAAA;;GAEG;AAOH;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,GAAG,GAAG,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAE7D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEnD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACtD,MAAM,EAAE,CAAC,EACT,GAAG,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,GACjD,CAAC,CAWH;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAE/E;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAUjE"}

package/src/utils/safe-object.js

@@ -8,13 +8,35 @@ exports.isDangerousKey = isDangerousKey;
 exports.safeAssign = safeAssign;
 exports.safeObjectEntries = safeObjectEntries;
 exports.validateObjectKeys = validateObjectKeys;
+/**
+ * List of dangerous keys that should never be set on objects to prevent prototype pollution.
+ */
 const DANGEROUS_KEYS = ['__proto__', 'constructor', 'prototype'];
+/**
+ * Creates a safe object without a prototype chain.
+ * This prevents prototype pollution attacks.
+ * @template T - The type of values in the object
+ * @returns A new object without a prototype
+ */
 function createSafeObject() {
     return Object.create(null);
 }
+/**
+ * Checks if a key is in the list of dangerous keys that could enable prototype pollution.
+ * @param key - The key to check
+ * @returns True if the key is dangerous, false otherwise
+ */
 function isDangerousKey(key) {
     return DANGEROUS_KEYS.includes(key);
 }
+/**
+ * Safely assigns properties from source objects to a target object.
+ * Filters out dangerous keys to prevent prototype pollution.
+ * @template T - The type of the target object
+ * @param target - The target object to assign to
+ * @param sources - One or more source objects to copy properties from
+ * @returns The target object with properties assigned
+ */
 function safeAssign(target, ...sources) {
     for (const source of sources) {
         if (!source)
@@ -27,9 +49,20 @@ function safeAssign(target, ...sources) {
     }
     return target;
 }
+/**
+ * Gets key-value pairs from an object, filtering out dangerous keys.
+ * @template T - The type of values in the object
+ * @param obj - The object to get entries from
+ * @returns Array of [key, value] pairs, excluding dangerous keys
+ */
 function safeObjectEntries(obj) {
     return Object.entries(obj).filter(([key]) => !isDangerousKey(key));
 }
+/**
+ * Validates that an object does not contain dangerous keys.
+ * @param obj - The object to validate
+ * @throws {Error} If a dangerous key is detected
+ */
 function validateObjectKeys(obj) {
     if (!obj || typeof obj !== 'object')
         return;

package/src/utils/safe-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"safe-object.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/safe-object.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAIH,4CAEC;AAED,wCAEC;AAED,gCAcC;AAED,8CAEC;AAED,gDAUC;AAxCD,MAAM,cAAc,GAAG,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;AAEjE,SAAgB,gBAAgB;IAC9B,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC;AAED,SAAgB,cAAc,CAAC,GAAW;IACxC,OAAO,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACtC,CAAC;AAED,SAAgB,UAAU,CACxB,MAAS,EACT,GAAG,OAA+C;IAElD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,MAAM;YAAE,SAAS;QAEtB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAc,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAgB,iBAAiB,CAAI,GAAsB;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,SAAgB,kBAAkB,CAAC,GAAwB;IACzD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO;IAE5C,kEAAkE;IAClE,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1E,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"safe-object.js","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/safe-object.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAaH,4CAEC;AAOD,wCAEC;AAUD,gCAcC;AAQD,8CAEC;AAOD,gDAUC;AAzED;;GAEG;AACH,MAAM,cAAc,GAAG,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;AAEjE;;;;;GAKG;AACH,SAAgB,gBAAgB;IAC9B,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC7B,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,GAAW;IACxC,OAAO,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,UAAU,CACxB,MAAS,EACT,GAAG,OAA+C;IAElD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,MAAM;YAAE,SAAS;QAEtB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAc,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAI,GAAsB;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,GAAwB;IACzD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO;IAE5C,kEAAkE;IAClE,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1E,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;AACH,CAAC"}

package/src/utils/string-utils.d.ts

@@ -1,9 +1,28 @@
 /**
  * String utility functions
  */
+/**
+ * Options for the replaceVariables function.
+ */
 export interface ReplaceVariablesOptions {
+    /** If true, HTML-escapes the replaced values */
     escapeHtml?: boolean;
 }
+/**
+ * Replaces variables in a string template with values from vars or constants.
+ * Variables are denoted by {variableName} in the template string.
+ * @param str - The template string containing variables
+ * @param vars - Optional object mapping variable names to values
+ * @param constants - Optional object containing constant values
+ * @param options - Optional configuration including HTML escaping
+ * @returns The string with variables replaced
+ */
 export declare function replaceVariables(str: string, vars?: Record<string, any>, constants?: Record<string, any>, options?: ReplaceVariablesOptions): string;
+/**
+ * Checks if a string key indicates a template that expects variable replacement.
+ * Template keys end with 'template' (case-insensitive).
+ * @param key - The key to check
+ * @returns True if the key indicates a template, false otherwise
+ */
 export declare function isTemplate(key: string): boolean;
 //# sourceMappingURL=string-utils.d.ts.map

package/src/utils/string-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string-utils.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/string-utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAeH,MAAM,WAAW,uBAAuB;IACtC,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC/B,OAAO,CAAC,EAAE,uBAAuB,GAChC,MAAM,CAyBR;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE/C"}
+{"version":3,"file":"string-utils.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-i18n-lib/src/utils/string-utils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAiBH;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,gDAAgD;IAChD,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC/B,OAAO,CAAC,EAAE,uBAAuB,GAChC,MAAM,CAyBR;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE/C"}