@digitaldefiance/i18n-lib 1.0.15 → 1.0.17

package/dist/active-context.d.ts

@@ -0,0 +1,29 @@
+import { LanguageContext } from './types';
+import { Timezone } from './timezone';
+import { CurrencyCode } from './currency-code';
+export interface IActiveContext<TLanguage extends string> {
+    /**
+     * The default language for the user facing application
+     */
+    language: TLanguage;
+    /**
+     * The default language for the admin interface
+     */
+    adminLanguage: TLanguage;
+    /**
+     * The default currency code for the user facing application
+     */
+    currencyCode: CurrencyCode;
+    /**
+     * The default language context for the current context
+     */
+    currentContext: LanguageContext;
+    /**
+     * The default timezone for the user facing application
+     */
+    timezone: Timezone;
+    /**
+     * The default timezone for the admin interface
+     */
+    adminTimezone: Timezone;
+}

package/dist/active-context.js

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

package/dist/context.d.ts

@@ -1,5 +1,43 @@
+import { CurrencyCode } from './currency-code';
+import { Timezone } from './timezone';
 import { I18nContext, LanguageContext } from './types';
-export declare function createContext<TLanguage extends string, TContext extends string = LanguageContext>(defaultLanguage: TLanguage, defaultContext: TContext): I18nContext<TLanguage, TContext>;
+/**
+ * Creates a new I18n context with default values.
+ * @param defaultLanguage - The default language for the context
+ * @param defaultContext - The default language context
+ * @param defaultCurrencyCode - The default currency code (defaults to USD)
+ * @param defaultTimezone - The default timezone (defaults to UTC)
+ * @param defaultAdminTimezone - The default admin timezone (defaults to UTC)
+ * @returns A new I18nContext instance
+ */
+export declare function createContext<TLanguage extends string, TContext extends string = LanguageContext>(defaultLanguage: TLanguage, defaultContext: TContext, defaultCurrencyCode?: CurrencyCode, defaultTimezone?: Timezone, defaultAdminTimezone?: Timezone): I18nContext<TLanguage, TContext>;
+/**
+ * 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 = LanguageContext>(context: I18nContext<TLanguage, TContext>, 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 = LanguageContext>(context: I18nContext<TLanguage, TContext>, 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 = LanguageContext>(context: I18nContext<TLanguage, TContext>, languageContext: TContext): 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 = LanguageContext>(context: I18nContext<TLanguage, TContext>, 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 = LanguageContext>(context: I18nContext<TLanguage, TContext>, timezone: Timezone): void;

package/dist/context.js

@@ -4,19 +4,66 @@ exports.createContext = createContext;
 exports.setLanguage = setLanguage;
 exports.setAdminLanguage = setAdminLanguage;
 exports.setContext = setContext;
-function createContext(defaultLanguage, defaultContext) {
+exports.setTimezone = setTimezone;
+exports.setAdminTimezone = setAdminTimezone;
+const currency_code_1 = require("./currency-code");
+const timezone_1 = require("./timezone");
+/**
+ * Creates a new I18n context with default values.
+ * @param defaultLanguage - The default language for the context
+ * @param defaultContext - The default language context
+ * @param defaultCurrencyCode - The default currency code (defaults to USD)
+ * @param defaultTimezone - The default timezone (defaults to UTC)
+ * @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')) {
     return {
         language: defaultLanguage,
         adminLanguage: defaultLanguage,
+        currencyCode: defaultCurrencyCode,
         currentContext: defaultContext,
+        timezone: defaultTimezone,
+        adminTimezone: defaultAdminTimezone,
     };
 }
+/**
+ * Sets the language for the given I18n context.
+ * @param context - The I18n context to modify
+ * @param language - The language to set
+ */
 function setLanguage(context, language) {
     context.language = language;
 }
+/**
+ * Sets the admin language for the given I18n context.
+ * @param context - The I18n context to modify
+ * @param language - The admin language to set
+ */
 function setAdminLanguage(context, language) {
     context.adminLanguage = language;
 }
+/**
+ * Sets the current context for the given I18n context.
+ * @param context - The I18n context to modify
+ * @param languageContext - The language context to set
+ */
 function setContext(context, languageContext) {
     context.currentContext = languageContext;
 }
+/**
+ * Sets the timezone for the given I18n context.
+ * @param context - The I18n context to modify
+ * @param timezone - The timezone to set
+ */
+function setTimezone(context, timezone) {
+    context.timezone = timezone;
+}
+/**
+ * Sets the admin timezone for the given I18n context.
+ * @param context - The I18n context to modify
+ * @param timezone - The admin timezone to set
+ */
+function setAdminTimezone(context, timezone) {
+    context.adminTimezone = timezone;
+}

package/dist/currency-code.d.ts

@@ -0,0 +1,7 @@
+export declare class CurrencyCode {
+    private _value;
+    get value(): string;
+    set value(value: string);
+    static get values(): string[];
+    constructor(value?: string);
+}

package/dist/currency-code.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CurrencyCode = void 0;
+const currency_codes_1 = require("currency-codes");
+const types_1 = require("./types");
+class CurrencyCode {
+    get value() {
+        return this._value;
+    }
+    set value(value) {
+        if (!CurrencyCode.values.includes(value)) {
+            throw new Error('Invalid currency code');
+        }
+        this._value = value;
+    }
+    static get values() {
+        return (0, currency_codes_1.codes)();
+    }
+    constructor(value = types_1.DefaultCurrencyCode) {
+        this._value = types_1.DefaultCurrencyCode;
+        this.value = value;
+    }
+}
+exports.CurrencyCode = CurrencyCode;

package/dist/currency-format.d.ts

@@ -0,0 +1,7 @@
+import { CurrencyPosition } from './types';
+export interface CurrencyFormat {
+    symbol: string;
+    position: CurrencyPosition;
+    groupSeparator: string;
+    decimalSeparator: string;
+}

package/dist/currency-format.js

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

package/dist/currency.d.ts

@@ -1,11 +1,5 @@
 /**
  * Currency formatting utilities
  */
-export type CurrencyPosition = 'prefix' | 'postfix' | 'infix';
-export interface CurrencyFormat {
-    symbol: string;
-    position: CurrencyPosition;
-    groupSeparator: string;
-    decimalSeparator: string;
-}
+import { CurrencyFormat } from './currency-format';
 export declare function getCurrencyFormat(locale: string, currencyCode: string): CurrencyFormat;

package/dist/global-active-context.d.ts

@@ -0,0 +1,22 @@
+import { StringLanguage } from './enumerations/string-language';
+import { IActiveContext } from './interfaces/active-context';
+import { CurrencyCode } from './interfaces/currency-code';
+import { LanguageContext } from './shared-types';
+import { Timezone } from '@digitaldefiance/i18n-lib';
+export declare const GlobalActiveContext: IActiveContext;
+export declare function setUserLanguage(language: StringLanguage): void;
+export declare function setCurrencyCode(code: CurrencyCode): void;
+/**
+ * Sets the admin language for console operations
+ * @param language The language to set for admin operations
+ */
+export declare function setAdminLanguage(language: StringLanguage): void;
+/**
+ * Sets the language context for the current context
+ * @param context The language context to set
+ */
+export declare function setLanguageContext(context: LanguageContext): void;
+export declare function setSystemContext(): void;
+export declare function setApiContext(): void;
+export declare function setUserTimezone(tz: Timezone): void;
+export declare function setAdminTimezone(tz: Timezone): void;

package/dist/global-active-context.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GlobalActiveContext = void 0;
+exports.setUserLanguage = setUserLanguage;
+exports.setCurrencyCode = setCurrencyCode;
+exports.setAdminLanguage = setAdminLanguage;
+exports.setLanguageContext = setLanguageContext;
+exports.setSystemContext = setSystemContext;
+exports.setApiContext = setApiContext;
+exports.setUserTimezone = setUserTimezone;
+exports.setAdminTimezone = setAdminTimezone;
+const currency_code_1 = require("./interfaces/currency-code");
+const shared_types_1 = require("./shared-types");
+const i18n_lib_1 = require("@digitaldefiance/i18n-lib");
+// Create the base context
+const baseContext = {
+    /**
+     * The language to use for translations in the user facing ui
+     */
+    language: shared_types_1.DefaultLanguage,
+    /**
+     * The language to use for console/admin logs
+     */
+    adminLanguage: shared_types_1.DefaultLanguage,
+    currencyCode: new currency_code_1.CurrencyCode(shared_types_1.DefaultCurrencyCode),
+    /**
+     * The current default context for language translations
+     */
+    currentContext: 'user',
+    /**
+     * The timezone for the user facing UI
+     */
+    timezone: new i18n_lib_1.Timezone('UTC'),
+    /**
+     * The timezone for the admin console
+     */
+    adminTimezone: new i18n_lib_1.Timezone('UTC'),
+};
+// Export the context (can be proxied for change detection)
+exports.GlobalActiveContext = baseContext;
+function setUserLanguage(language) {
+    exports.GlobalActiveContext.language = language;
+}
+function setCurrencyCode(code) {
+    exports.GlobalActiveContext.currencyCode = code;
+}
+/**
+ * Sets the admin language for console operations
+ * @param language The language to set for admin operations
+ */
+function setAdminLanguage(language) {
+    exports.GlobalActiveContext.adminLanguage = language;
+}
+/**
+ * Sets the language context for the current context
+ * @param context The language context to set
+ */
+function setLanguageContext(context) {
+    exports.GlobalActiveContext.currentContext = context;
+}
+// Helper functions for new contexts
+function setSystemContext() {
+    setLanguageContext('system');
+}
+function setApiContext() {
+    setLanguageContext('api');
+}
+function setUserTimezone(tz) {
+    exports.GlobalActiveContext.timezone = tz;
+}
+function setAdminTimezone(tz) {
+    exports.GlobalActiveContext.adminTimezone = tz;
+}

package/dist/i18n-engine.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.I18nEngine = void 0;
+const context_1 = require("./context");
 const enum_registry_1 = require("./enum-registry");
 const template_1 = require("./template");
 const utils_1 = require("./utils");
@@ -14,11 +15,7 @@ class I18nEngine {
     constructor(config, key) {
         this.config = config;
         this.enumRegistry = new enum_registry_1.EnumTranslationRegistry();
-        this._context = {
-            language: config.defaultLanguage,
-            adminLanguage: config.defaultLanguage,
-            currentContext: config.defaultContext,
-        };
+        this._context = (0, context_1.createContext)(config.defaultLanguage, config.defaultTranslationContext, config.defaultCurrencyCode, config.timezone, config.adminTimezone);
         const instanceKey = key || I18nEngine.DefaultInstanceKey;
         if (I18nEngine._instances.has(instanceKey)) {
             const existing = I18nEngine._instances.get(instanceKey);

package/dist/index.d.ts

@@ -1,9 +1,13 @@
+export * from './active-context';
 export * from './context';
 export * from './context-manager';
 export * from './currency';
+export * from './currency-code';
+export * from './currency-format';
 export * from './enum-registry';
 export * from './i18n-engine';
 export * from './template';
+export * from './timezone';
 export * from './types';
 export * from './utils';
 export { I18nEngine as I18n } from './i18n-engine';

package/dist/index.js

@@ -15,12 +15,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.I18n = void 0;
+__exportStar(require("./active-context"), exports);
 __exportStar(require("./context"), exports);
 __exportStar(require("./context-manager"), exports);
 __exportStar(require("./currency"), exports);
+__exportStar(require("./currency-code"), exports);
+__exportStar(require("./currency-format"), exports);
 __exportStar(require("./enum-registry"), exports);
 __exportStar(require("./i18n-engine"), exports);
 __exportStar(require("./template"), exports);
+__exportStar(require("./timezone"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./utils"), exports);
 // Re-export for convenience

package/dist/timezone.d.ts

@@ -0,0 +1,5 @@
+export declare class Timezone {
+    private readonly _timezone;
+    constructor(timezone: string);
+    get value(): string;
+}

package/dist/timezone.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Timezone = void 0;
+const utils_1 = require("./utils");
+class Timezone {
+    constructor(timezone) {
+        if (!(0, utils_1.isValidTimezone)(timezone)) {
+            throw new Error(`Invalid timezone: ${timezone}`);
+        }
+        this._timezone = timezone;
+    }
+    get value() {
+        return this._timezone;
+    }
+}
+exports.Timezone = Timezone;

package/dist/types.d.ts

@@ -1,24 +1,34 @@
-export type LanguageContext = 'admin' | 'user';
+import { CurrencyCode } from './currency-code';
+import { Timezone } from './timezone';
+export type LanguageContext = 'admin' | 'user' | 'system' | 'api';
+export declare const DefaultCurrencyCode: string;
+export type CurrencyPosition = 'prefix' | 'postfix' | 'infix';
 export type CustomLanguageContext<T extends string = LanguageContext> = T;
 export type StringsCollection<TStringKey extends string> = Partial<Record<TStringKey, string>>;
 export type MasterStringsCollection<TStringKey extends string, TLanguage extends string> = Partial<Record<TLanguage, StringsCollection<TStringKey>>>;
 export type LanguageCodeCollection<TLanguage extends string> = Partial<Record<TLanguage, string>>;
 export type EnumTranslationMap<TEnum extends string | number, TLanguage extends string> = Partial<Record<TLanguage, Partial<Record<TEnum, string>>>>;
-export interface I18nConfig<TStringKey extends string, TLanguage extends string, TConstants extends Record<string, any> = Record<string, any>, TContext extends string = LanguageContext> {
+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>;
     defaultLanguage: TLanguage;
-    defaultContext: TContext;
+    defaultTranslationContext: TTranslationContext;
+    defaultCurrencyCode: CurrencyCode;
     languageCodes: LanguageCodeCollection<TLanguage>;
     languages: TLanguage[];
     constants?: TConstants;
     enumName?: string;
     enumObj?: Record<string, TStringKey>;
+    timezone: Timezone;
+    adminTimezone: Timezone;
 }
-export interface I18nContext<TLanguage extends string, TContext extends string = LanguageContext> {
+export interface I18nContext<TLanguage extends string, TTranslationContext extends string = LanguageContext> {
     language: TLanguage;
     adminLanguage: TLanguage;
-    currentContext: TContext;
+    currencyCode: CurrencyCode;
+    currentContext: TTranslationContext;
+    timezone: Timezone;
+    adminTimezone: Timezone;
 }
 /**
  * Generic translation type for any enumeration

package/dist/types.js

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

package/dist/utils.d.ts

@@ -1,2 +1,3 @@
 export declare function replaceVariables(str: string, vars?: Record<string, string | number>, constants?: any): string;
 export declare function isTemplate(key: string): boolean;
+export declare function isValidTimezone(timezone: string): boolean;

package/dist/utils.js

@@ -1,7 +1,12 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.replaceVariables = replaceVariables;
 exports.isTemplate = isTemplate;
+exports.isValidTimezone = isValidTimezone;
+const moment_timezone_1 = __importDefault(require("moment-timezone"));
 function replaceVariables(str, vars, constants) {
     const variables = str.match(/\{(.+?)\}/g);
     if (!variables)
@@ -25,3 +30,6 @@ function replaceVariables(str, vars, constants) {
 function isTemplate(key) {
     return key.toLowerCase().endsWith('template');
 }
+function isValidTimezone(timezone) {
+    return moment_timezone_1.default.tz.zone(timezone) !== null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitaldefiance/i18n-lib",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "Generic i18n library with enum translation support",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -43,5 +43,9 @@
   ],
   "author": "Digital Defiance",
   "license": "MIT",
-  "packageManager": "yarn@4.10.3"
+  "packageManager": "yarn@4.10.3",
+  "dependencies": {
+    "moment": "^2.30.1",
+    "moment-timezone": "^0.6.0"
+  }
 }