@digitaldefiance/i18n-lib 1.2.4 → 1.2.5

package/README.md

@@ -1059,6 +1059,28 @@ Part of the DigitalBurnbag project - a secure file sharing and automated protoco
 
 ## ChangeLog
 
+### Version 1.2.5
+
+- Sat Oct 25 2025 15:0100 GMT-0700 (Pacific Daylight Time)
+
+#### Added
+- **`createTranslationAdapter`** - Generic utility function to adapt `PluginI18nEngine` instances to the `TranslationEngine` interface, enabling seamless integration with error classes and other components expecting the simpler interface
+  - Maintains full type safety with generic string key and language types
+  - Provides graceful error handling with fallback to key strings
+  - Zero overhead - direct delegation to underlying `PluginI18nEngine`
+  - Comprehensive test coverage (19 tests)
+
+#### Benefits
+- Eliminates need for custom adapter implementations in consuming packages
+- Standardizes translation engine integration across the monorepo
+- Simplifies error class constructors that require translation engines
+
+#### Migration
+Packages using custom translation adapters can now replace them with:
+```typescript
+import { createTranslationAdapter } from '@digitaldefiance/i18n-lib';
+const adapter = createTranslationAdapter(pluginEngine, 'component-id');
+ 
 ### Version 1.2.4
 
 - Sat Oct 25 2025 14:29:00 GMT-0700 (Pacific Daylight Time)

package/dist/create-translation-adapter.d.ts

@@ -0,0 +1,20 @@
+import { PluginI18nEngine } from './plugin-i18n-engine';
+import { TranslationEngine } from './translation-engine';
+/**
+ * Creates a TranslationEngine adapter from a PluginI18nEngine for a specific component.
+ * This allows PluginI18nEngine to be used where TranslationEngine interface is expected.
+ *
+ * @param pluginEngine - The PluginI18nEngine instance to wrap
+ * @param componentId - The component ID to use for translations
+ * @returns A TranslationEngine that delegates to the PluginI18nEngine
+ *
+ * @example
+ * ```typescript
+ * const pluginEngine = getMyPluginI18nEngine();
+ * const adapter = createTranslationAdapter(pluginEngine, 'my-component');
+ *
+ * // Now can be used where TranslationEngine is expected
+ * const error = new MyError(errorType, adapter);
+ * ```
+ */
+export declare function createTranslationAdapter<TStringKey extends string, TLanguage extends string>(pluginEngine: PluginI18nEngine<TLanguage>, componentId: string): TranslationEngine<TStringKey>;

package/dist/create-translation-adapter.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTranslationAdapter = createTranslationAdapter;
+/**
+ * Creates a TranslationEngine adapter from a PluginI18nEngine for a specific component.
+ * This allows PluginI18nEngine to be used where TranslationEngine interface is expected.
+ *
+ * @param pluginEngine - The PluginI18nEngine instance to wrap
+ * @param componentId - The component ID to use for translations
+ * @returns A TranslationEngine that delegates to the PluginI18nEngine
+ *
+ * @example
+ * ```typescript
+ * const pluginEngine = getMyPluginI18nEngine();
+ * const adapter = createTranslationAdapter(pluginEngine, 'my-component');
+ *
+ * // Now can be used where TranslationEngine is expected
+ * const error = new MyError(errorType, adapter);
+ * ```
+ */
+function createTranslationAdapter(pluginEngine, componentId) {
+    return {
+        translate: (key, vars, lang) => {
+            try {
+                return pluginEngine.translate(componentId, key, vars, lang);
+            }
+            catch (error) {
+                // Fallback to key if translation fails
+                return String(key);
+            }
+        },
+        safeTranslate: (key, vars, lang) => {
+            return pluginEngine.safeTranslate(componentId, key, vars, lang);
+        },
+    };
+}

package/dist/index.d.ts

@@ -35,6 +35,7 @@ export * from './registry-error-type';
 export * from './translation-engine';
 export * from './translation-request';
 export * from './translation-response';
+export * from './create-translation-adapter';
 export { createCoreI18nEngine as createCoreI18n } from './core-i18n';
 export { I18nEngine as I18n } from './i18n-engine';
 export { PluginI18nEngine as PluginI18n } from './plugin-i18n-engine';

package/dist/index.js

@@ -54,6 +54,7 @@ __exportStar(require("./registry-error-type"), exports);
 __exportStar(require("./translation-engine"), exports);
 __exportStar(require("./translation-request"), exports);
 __exportStar(require("./translation-response"), exports);
+__exportStar(require("./create-translation-adapter"), exports);
 // Re-export for convenience
 var core_i18n_1 = require("./core-i18n");
 Object.defineProperty(exports, "createCoreI18n", { enumerable: true, get: function () { return core_i18n_1.createCoreI18nEngine; } });

package/package.json

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