@digitaldefiance/i18n-lib 1.0.27 → 1.0.29

package/dist/typed-error.d.ts

@@ -1,9 +1,17 @@
 import { Language, StringKey } from './default-config';
 import { I18nEngine } from './i18n-engine';
-export declare abstract class TypedError<T extends string | number> extends Error {
-    readonly type: T;
-    readonly reasonMap: Record<T, StringKey>;
+/**
+ * Type constraint to ensure reasonMap has entries for all enum values
+ */
+type CompleteReasonMap<TEnum extends Record<string, string | number>, TStringKey extends string> = Record<TEnum[keyof TEnum], TStringKey>;
+/**
+ * Type-safe TypedError that ensures complete enum coverage
+ */
+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<StringKey, Language, Record<string, any>, string>, type: T, reasonMap: Record<T, StringKey>, language?: Language | undefined, otherVars?: Record<string, string | number> | undefined);
+    constructor(engine: I18nEngine<TStringKey, Language, Record<string, any>, string>, type: TEnum[keyof TEnum], reasonMap: CompleteReasonMap<TEnum, TStringKey>, language?: Language | undefined, otherVars?: Record<string, string | number> | undefined);
 }
+export type { CompleteReasonMap };

package/dist/typed-error.js

@@ -2,6 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TypedError = void 0;
 const default_config_1 = require("./default-config");
+/**
+ * Type-safe TypedError that ensures complete enum coverage
+ */
 class TypedError extends Error {
     constructor(engine, type, reasonMap, language, otherVars) {
         const key = reasonMap[type];

package/dist/utils.d.ts

@@ -31,6 +31,16 @@ export declare function toStringKey<TStringKey extends string>(...parts: (string
  * @returns The constructed string key
  */
 export declare function toStringKeyFromEnum<TStringKey extends string>(value: string, ...parts: string[]): TStringKey;
+/**
+ * Type that constructs string keys from enum values with prefixes and optional template suffix
+ */
+type BuildStringKey<TEnumValue extends string, TPrefixes extends readonly string[], TIsTemplate extends boolean = false> = TPrefixes extends readonly [] ? `${TEnumValue}${TIsTemplate extends true ? 'Template' : ''}` : TPrefixes extends readonly [infer First, ...infer Rest] ? First extends string ? Rest extends readonly string[] ? `${First}_${BuildStringKey<TEnumValue, Rest, TIsTemplate>}` : never : never : never;
+/**
+ * Type that maps all enum values to their corresponding string keys
+ */
+type ReasonMapFromEnum<TEnum extends Record<string, string>, TStringKey extends string, TPrefixes extends readonly string[] = [], TTemplateKeys extends Set<TEnum[keyof TEnum]> = never> = {
+    [K in TEnum[keyof TEnum]]: BuildStringKey<K, TPrefixes, TTemplateKeys extends Set<K> ? true : false> extends TStringKey ? BuildStringKey<K, TPrefixes, TTemplateKeys extends Set<K> ? true : false> : never;
+};
 /**
  * Builds a reason map from an enum object, mapping each enum value to a string key.
  * @param enumObj - The enum object
@@ -39,3 +49,16 @@ export declare function toStringKeyFromEnum<TStringKey extends string>(value: st
  * @returns The constructed reason map
  */
 export declare function buildReasonMap<TEnum extends Record<string, string>, TStringKey extends string>(enumObj: TEnum, prefixes?: string[], templateKeys?: Set<TEnum[keyof TEnum]>): Record<TEnum[keyof TEnum], TStringKey>;
+/**
+ * Type-safe version of buildReasonMap that ensures all enum values are mapped and all string keys exist
+ */
+export declare function buildTypeSafeReasonMap<TEnum extends Record<string, string>, TStringKey extends string, TPrefixes extends readonly string[] = [], TTemplateKeys extends Set<TEnum[keyof TEnum]> = never>(enumObj: TEnum, prefixes: TPrefixes, templateKeys?: TTemplateKeys): ReasonMapFromEnum<TEnum, TStringKey, TPrefixes, TTemplateKeys>;
+/**
+ * Validates that a reason map has entries for all enum values
+ */
+export declare function validateReasonMap<TEnum extends Record<string, string>, TStringKey extends string>(enumObj: TEnum, reasonMap: Partial<Record<TEnum[keyof TEnum], TStringKey>>): reasonMap is Record<TEnum[keyof TEnum], TStringKey>;
+/**
+ * Creates a complete reason map ensuring all enum values are covered
+ */
+export declare function createCompleteReasonMap<TEnum extends Record<string, string>, TStringKey extends string>(enumObj: TEnum, prefixes?: readonly string[], templateKeys?: Set<TEnum[keyof TEnum]>): Record<TEnum[keyof TEnum], TStringKey>;
+export {};

package/dist/utils.js

@@ -9,6 +9,9 @@ exports.isValidTimezone = isValidTimezone;
 exports.toStringKey = toStringKey;
 exports.toStringKeyFromEnum = toStringKeyFromEnum;
 exports.buildReasonMap = buildReasonMap;
+exports.buildTypeSafeReasonMap = buildTypeSafeReasonMap;
+exports.validateReasonMap = validateReasonMap;
+exports.createCompleteReasonMap = createCompleteReasonMap;
 const moment_timezone_1 = __importDefault(require("moment-timezone"));
 /**
  * Replaces variables in a string with their corresponding values from vars or constants.
@@ -87,3 +90,32 @@ function buildReasonMap(enumObj, prefixes = [], templateKeys) {
     });
     return map;
 }
+/**
+ * Type-safe version of buildReasonMap that ensures all enum values are mapped and all string keys exist
+ */
+function buildTypeSafeReasonMap(enumObj, prefixes, templateKeys) {
+    const map = {};
+    Object.values(enumObj).forEach(value => {
+        const baseKey = [...prefixes, value].join('_');
+        const finalKey = templateKeys?.has(value) ? baseKey + 'Template' : baseKey;
+        map[value] = finalKey;
+    });
+    return map;
+}
+/**
+ * Validates that a reason map has entries for all enum values
+ */
+function validateReasonMap(enumObj, reasonMap) {
+    return Object.values(enumObj).every(value => value in reasonMap && reasonMap[value] !== undefined);
+}
+/**
+ * Creates a complete reason map ensuring all enum values are covered
+ */
+function createCompleteReasonMap(enumObj, prefixes = [], templateKeys) {
+    const map = buildReasonMap(enumObj, [...prefixes], templateKeys);
+    if (!validateReasonMap(enumObj, map)) {
+        const missing = Object.values(enumObj).filter(value => !(value in map));
+        throw new Error(`Missing reason map entries for: ${missing.join(', ')}`);
+    }
+    return map;
+}

package/package.json

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