@digitaldefiance/i18n-lib 1.3.5 → 1.3.7

package/README.md

@@ -2274,6 +2274,16 @@ For issues, questions, or contributions:
 
 ## ChangeLog
 
+### Version 1.3.7
+
+- Add handleable at i18n level
+- Add TranslatableGenericHandleable at i18n level
+
+### Version 1.3.6
+
+- Simplify LanguageContextSpace and generics related to it
+- Make plugin engine respect admin context
+
 ### Version 1.3.5
 
 - CommonJS

package/dist/context.d.ts

@@ -11,34 +11,34 @@ import { LanguageContextSpace } from './types';
  * @param defaultAdminTimezone - The default admin timezone (defaults to UTC)
  * @returns A new I18nContext instance
  */
-export declare function createContext<TLanguage extends string, TTranslationContext extends string = LanguageContextSpace, TContext extends I18nContext<TLanguage, TTranslationContext> = I18nContext<TLanguage, TTranslationContext>>(defaultLanguage: TLanguage, defaultContext: TTranslationContext, defaultCurrencyCode?: CurrencyCode, defaultTimezone?: Timezone, defaultAdminTimezone?: Timezone): TContext;
+export declare function createContext<TLanguage extends string>(defaultLanguage: TLanguage, defaultContext?: LanguageContextSpace, defaultCurrencyCode?: CurrencyCode, defaultTimezone?: Timezone, defaultAdminTimezone?: Timezone): I18nContext<TLanguage>;
 /**
  * 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 = LanguageContextSpace>(context: I18nContext<TLanguage, TContext>, language: TLanguage): void;
+export declare function setLanguage<TLanguage extends string>(context: I18nContext<TLanguage>, 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 = LanguageContextSpace>(context: I18nContext<TLanguage, TContext>, language: TLanguage): void;
+export declare function setAdminLanguage<TLanguage extends string>(context: I18nContext<TLanguage>, 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 = LanguageContextSpace>(context: I18nContext<TLanguage, TContext>, languageContext: TContext): void;
+export declare function setContext<TLanguage extends string>(context: I18nContext<TLanguage>, languageContext: LanguageContextSpace): 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 = LanguageContextSpace>(context: I18nContext<TLanguage, TContext>, timezone: Timezone): void;
+export declare function setTimezone<TLanguage extends string>(context: I18nContext<TLanguage>, 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 = LanguageContextSpace>(context: I18nContext<TLanguage, TContext>, timezone: Timezone): void;
+export declare function setAdminTimezone<TLanguage extends string>(context: I18nContext<TLanguage>, timezone: Timezone): void;

package/dist/context.js

@@ -17,7 +17,7 @@ const timezone_1 = require("./timezone");
  * @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')) {
+function createContext(defaultLanguage, defaultContext = 'admin', defaultCurrencyCode = new currency_code_1.CurrencyCode('USD'), defaultTimezone = new timezone_1.Timezone('UTC'), defaultAdminTimezone = new timezone_1.Timezone('UTC')) {
     return {
         language: defaultLanguage,
         adminLanguage: defaultLanguage,

package/dist/default-config.d.ts

@@ -20,7 +20,7 @@ declare global {
             StringKey: DefaultStringKey;
             Language: DefaultLanguageCode;
             LanguageCodes: LanguageCodeCollection<DefaultLanguageCode>;
-            engine: I18nEngine<I18n.Config['StringKey'], I18n.Config['Language'], Record<any, any>, string>;
+            engine: I18nEngine<I18n.Config['StringKey'], I18n.Config['Language'], Record<any, any>>;
         }
     }
 }
@@ -29,4 +29,4 @@ export type Language = I18n.Config['Language'];
 export type Engine = I18n.Config['engine'];
 export type DefaultLanguageCodesType = I18n.Config['LanguageCodes'];
 export declare const getI18nEngine: () => Engine;
-export declare const getDefaultI18nEngine: <TConstants extends Record<string, any>, TTranslationContext extends string, TContext extends I18nContext<DefaultLanguageCode, TTranslationContext>>(constants: TConstants, timezone?: Timezone, adminTimezone?: Timezone) => I18nEngine<DefaultStringKey, DefaultLanguageCode, TConstants, TTranslationContext, TContext>;
+export declare const getDefaultI18nEngine: <TConstants extends Record<string, any>, TContext extends I18nContext<DefaultLanguageCode>>(constants: TConstants, timezone?: Timezone, adminTimezone?: Timezone) => I18nEngine<DefaultStringKey, DefaultLanguageCode, TConstants, TContext>;

package/dist/handleable.d.ts

@@ -0,0 +1,13 @@
+import { HandleableErrorOptions } from './i-handleable-error-options';
+import { IHandleable } from './i-handleable';
+export declare class HandleableError extends Error implements IHandleable {
+    readonly cause?: Error;
+    readonly statusCode: number;
+    readonly sourceData?: unknown;
+    private _handled;
+    constructor(source: Error, options?: HandleableErrorOptions);
+    get handled(): boolean;
+    set handled(value: boolean);
+    private serializeValue;
+    toJSON(): Record<string, unknown>;
+}

package/dist/handleable.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HandleableError = void 0;
+class HandleableError extends Error {
+    constructor(source, options) {
+        super(source.message);
+        this.name = this.constructor.name;
+        this.cause = options?.cause ?? source;
+        this.statusCode = options?.statusCode ?? 500;
+        this._handled = options?.handled ?? false;
+        this.sourceData = options?.sourceData;
+        // Capture stack trace - prioritize source stack, then capture new one
+        if (source.stack) {
+            this.stack = source.stack;
+        }
+        else if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        else {
+            this.stack = new Error().stack;
+        }
+    }
+    get handled() {
+        return this._handled;
+    }
+    set handled(value) {
+        this._handled = value;
+    }
+    serializeValue(value) {
+        if (value && typeof value === 'object' && 'toJSON' in value && typeof value.toJSON === 'function') {
+            return value.toJSON();
+        }
+        if (value instanceof Error) {
+            return value.message;
+        }
+        if (Array.isArray(value)) {
+            return value.map(item => this.serializeValue(item));
+        }
+        if (value && typeof value === 'object') {
+            return Object.fromEntries(Object.entries(value).map(([k, v]) => [k, this.serializeValue(v)]));
+        }
+        return value;
+    }
+    toJSON() {
+        return {
+            name: this.name,
+            message: this.message,
+            statusCode: this.statusCode,
+            handled: this.handled,
+            stack: this.stack,
+            cause: this.serializeValue(this.cause),
+            ...(this.sourceData ? { sourceData: this.serializeValue(this.sourceData) } : {}),
+        };
+    }
+}
+exports.HandleableError = HandleableError;

package/dist/i-handleable-error-options.d.ts

@@ -0,0 +1,6 @@
+export interface HandleableErrorOptions {
+    cause?: Error;
+    handled?: boolean;
+    statusCode?: number;
+    sourceData?: unknown;
+}

package/dist/i-handleable-error-options.js

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

package/dist/i-handleable.d.ts

@@ -0,0 +1,5 @@
+export interface IHandleable {
+    toJSON(): Record<string, unknown>;
+    get handled(): boolean;
+    set handled(value: boolean);
+}

package/dist/i-handleable.js

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

package/dist/i18n-config.d.ts

@@ -4,11 +4,11 @@ import { LanguageCodeCollection, LanguageContextSpace, MasterStringsCollection }
 /**
  * I18n configuration interface
  */
-export interface I18nConfig<TStringKey extends string, TLanguage extends string, TConstants extends Record<string, any> = Record<string, any>, TTranslationContext extends string = LanguageContextSpace> {
+export interface I18nConfig<TStringKey extends string, TLanguage extends string, TConstants extends Record<string, any> = Record<string, any>> {
     stringNames: TStringKey[];
     strings: MasterStringsCollection<TStringKey, TLanguage>;
     defaultLanguage: TLanguage;
-    defaultTranslationContext: TTranslationContext;
+    defaultTranslationContext: LanguageContextSpace;
     defaultCurrencyCode: CurrencyCode;
     languageCodes: LanguageCodeCollection<TLanguage>;
     languages: TLanguage[];

package/dist/i18n-context.d.ts

@@ -4,11 +4,11 @@ import { LanguageContextSpace } from './types';
 /**
  * I18n context interface
  */
-export interface I18nContext<TLanguage extends string, TTranslationContext extends string = LanguageContextSpace> {
+export interface I18nContext<TLanguage extends string> {
     language: TLanguage;
     adminLanguage: TLanguage;
     currencyCode: CurrencyCode;
-    currentContext: TTranslationContext;
+    currentContext: LanguageContextSpace;
     timezone: Timezone;
     adminTimezone: Timezone;
 }

package/dist/i18n-engine.d.ts

@@ -5,7 +5,7 @@ import { EnumLanguageTranslation } from './types';
 /**
  * Internationalization engine class
  */
-export declare class I18nEngine<TStringKey extends string, TLanguage extends string, TConstants extends Record<string, any> = Record<string, any>, TTranslationContext extends string = string, TContext extends I18nContext<TLanguage, TTranslationContext> = I18nContext<TLanguage, TTranslationContext>> {
+export declare class I18nEngine<TStringKey extends string, TLanguage extends string, TConstants extends Record<string, any> = Record<string, any>, TContext extends I18nContext<TLanguage> = I18nContext<TLanguage>> {
     /**
      * Registry for enum translations
      */
@@ -13,7 +13,7 @@ export declare class I18nEngine<TStringKey extends string, TLanguage extends str
     /**
      * Configuration for the i18n engine
      */
-    readonly config: I18nConfig<TStringKey, TLanguage, TConstants, TTranslationContext>;
+    readonly config: I18nConfig<TStringKey, TLanguage, TConstants>;
     /**
      * Static instances for semi-singleton pattern
      */
@@ -40,7 +40,7 @@ export declare class I18nEngine<TStringKey extends string, TLanguage extends str
      * @param key Optional instance key for the semi-singleton pattern
      * @throws Error if an instance with the same key already exists
      */
-    constructor(config: I18nConfig<TStringKey, TLanguage, TConstants, TTranslationContext>, key?: string, newContext?: () => TContext);
+    constructor(config: I18nConfig<TStringKey, TLanguage, TConstants>, key?: string, newContext?: () => TContext);
     /**
      * Gets an instance of the I18nEngine by key. If no key is provided, the default instance is returned.
      * @param key The key of the instance to retrieve

package/dist/index.d.ts

@@ -12,6 +12,9 @@ export * from './currency-format';
 export * from './default-config';
 export * from './enum-registry';
 export * from './global-active-context';
+export * from './handleable';
+export * from './i-handleable';
+export * from './i-handleable-error-options';
 export * from './i-global-active-context';
 export * from './i18n-context';
 export * from './i18n-engine';

package/dist/index.js

@@ -31,6 +31,9 @@ __exportStar(require("./currency-format"), exports);
 __exportStar(require("./default-config"), exports);
 __exportStar(require("./enum-registry"), exports);
 __exportStar(require("./global-active-context"), exports);
+__exportStar(require("./handleable"), exports);
+__exportStar(require("./i-handleable"), exports);
+__exportStar(require("./i-handleable-error-options"), exports);
 __exportStar(require("./i-global-active-context"), exports);
 __exportStar(require("./i18n-context"), exports);
 __exportStar(require("./i18n-engine"), exports);

package/dist/plugin-i18n-engine.d.ts

@@ -83,6 +83,7 @@ export declare class PluginI18nEngine<TLanguages extends string> {
     updateContext(updates: Partial<IActiveContext<TLanguages>>): void;
     /**
      * Get current language from global context
+     * Respects language context space (admin vs user)
      */
     private getCurrentLanguage;
     /**

package/dist/plugin-i18n-engine.js

@@ -220,10 +220,12 @@ class PluginI18nEngine {
     }
     /**
      * Get current language from global context
+     * Respects language context space (admin vs user)
      */
     getCurrentLanguage() {
         const globalContext = global_active_context_1.GlobalActiveContext.getInstance();
-        return globalContext.getContext(this.contextKey).language;
+        const context = globalContext.getContext(this.contextKey);
+        return context.currentContext === 'admin' ? context.adminLanguage : context.language;
     }
     /**
      * Set current language

package/dist/translatable-handleable-generic.d.ts

@@ -0,0 +1,28 @@
+import { IHandleable } from './i-handleable';
+import { TranslatableGenericError } from './translatable-generic-error';
+/**
+ * Generic translatable error that works with any plugin engine and component
+ */
+export declare class TranslatableHandleableGenericError<TStringKey extends string = string, TLanguage extends string = string> extends TranslatableGenericError<TStringKey, TLanguage> implements IHandleable {
+    private _handled;
+    readonly cause?: Error;
+    readonly statusCode: number;
+    readonly sourceData?: unknown;
+    /**
+     * Create a translatable error
+     * @param componentId - The component ID to translate from
+     * @param stringKey - The translation key
+     * @param variables - Variables for interpolation
+     * @param language - Optional language override
+     * @param metadata - Additional error metadata
+     * @param instanceKey - Optional engine instance key
+     */
+    constructor(componentId: string, stringKey: TStringKey, variables?: Record<string, string | number>, language?: TLanguage, metadata?: Record<string, any>, instanceKey?: string, handleableOptions?: {
+        statusCode?: number;
+        cause?: Error;
+        sourceData?: unknown;
+    });
+    get handled(): boolean;
+    set handled(value: boolean);
+    toJSON(): Record<string, unknown>;
+}

package/dist/translatable-handleable-generic.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TranslatableHandleableGenericError = void 0;
+const translatable_generic_error_1 = require("./translatable-generic-error");
+/**
+ * Generic translatable error that works with any plugin engine and component
+ */
+class TranslatableHandleableGenericError extends translatable_generic_error_1.TranslatableGenericError {
+    /**
+     * Create a translatable error
+     * @param componentId - The component ID to translate from
+     * @param stringKey - The translation key
+     * @param variables - Variables for interpolation
+     * @param language - Optional language override
+     * @param metadata - Additional error metadata
+     * @param instanceKey - Optional engine instance key
+     */
+    constructor(componentId, stringKey, variables, language, metadata, instanceKey, handleableOptions) {
+        super(componentId, stringKey, variables, language, metadata, instanceKey);
+        this._handled = false;
+        this.statusCode = handleableOptions?.statusCode ?? 500;
+        this.cause = handleableOptions?.cause;
+        this.sourceData = handleableOptions?.sourceData;
+    }
+    get handled() {
+        return this._handled;
+    }
+    set handled(value) {
+        this._handled = value;
+    }
+    toJSON() {
+        return {
+            statusCode: this.statusCode,
+            message: this.message,
+            cause: this.cause,
+            sourceData: this.sourceData,
+        };
+    }
+}
+exports.TranslatableHandleableGenericError = TranslatableHandleableGenericError;

package/dist/typed-error.d.ts

@@ -32,7 +32,7 @@ export declare abstract class TypedError<TEnum extends Record<string, string>, T
     readonly reasonMap: CompleteReasonMap<TEnum, TStringKey>;
     readonly language?: Language | undefined;
     readonly 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);
+    constructor(engine: I18nEngine<TStringKey, Language, Record<string, any>>, type: TEnum[keyof TEnum], reasonMap: CompleteReasonMap<TEnum, TStringKey>, language?: Language | undefined, otherVars?: Record<string, string | number> | undefined);
 }
 /**
  * Plugin-based TypedError that works with the new component registration system

package/dist/types.d.ts

@@ -4,7 +4,7 @@ import { LanguageDefinition } from './language-definition';
 /**
  * Standard language context spaces
  */
-export type LanguageContextSpace = 'admin' | 'user' | 'system' | 'api';
+export type LanguageContextSpace = 'admin' | 'user';
 /**
  * Default currency code
  */
@@ -17,10 +17,6 @@ export declare const DefaultTimezone: string;
  * Currency position type
  */
 export type CurrencyPosition = 'prefix' | 'postfix' | 'infix';
-/**
- * Custom language context type
- */
-export type CustomLanguageContext<T extends string = LanguageContextSpace> = T;
 /**
  * Collection of localized strings for a specific language
  */

package/package.json

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