@ayinza_dev/i18n-config 1.3.0

package/dist/types.d.ts

@@ -0,0 +1,123 @@
+export interface LocaleMapping {
+    [key: string]: string;
+}
+export interface CurrencyConfig {
+    defaultCurrency?: string;
+    localeMapping?: LocaleMapping;
+}
+export interface NumberConfig {
+    localeMapping?: LocaleMapping;
+}
+export interface DateConfig {
+    localeMapping?: LocaleMapping;
+    defaultFormat?: Intl.DateTimeFormatOptions;
+}
+export interface FormattersConfig {
+    /** Currency-specific defaults (default currency, locale mapping). */
+    currency?: CurrencyConfig;
+    /** Number formatting locale overrides. */
+    number?: NumberConfig;
+    /** Date/time formatting defaults including locale mapping. */
+    date?: DateConfig;
+    /** Locale to fall back to when a language code is missing from mappings. */
+    fallbackLocale?: string;
+}
+export interface ReactConfig {
+    useSuspense?: boolean;
+    bindI18n?: string;
+    bindI18nStore?: string;
+}
+/**
+ * Ayinza localization-service integration. When `baseUrl` is set, the library
+ * fetches the shared translation catalog for each active language and overlays
+ * it (deep-merge, remote wins) on top of the bundled base loaded via
+ * `backend.loadPath`. The Ayinza response envelope `{ data: { translations } }`
+ * is unwrapped automatically. Loading is lazy (a language's catalog is fetched
+ * on first use) and never throws — on failure the bundled base is kept.
+ */
+export interface LocalizationConfig {
+    /** localization-service base URL, e.g. `https://localization.example/api/v1`. */
+    baseUrl: string;
+    /** Path appended to `baseUrl`; `{{lng}}` is substituted. Default `/l10n/translations/{{lng}}`. */
+    path?: string;
+    /** Optional `?category=` filter. notification-service scopes by project; UIs usually omit it. */
+    category?: string;
+    /** Extra request headers. */
+    headers?: Record<string, string>;
+}
+export interface I18nConfig {
+    /** i18next backend options (e.g., load paths, custom headers). */
+    backend?: {
+        loadPath?: string;
+        addPath?: string;
+        customHeaders?: Record<string, string>;
+        /**
+         * Transform the raw HTTP response before i18next consumes it (passed through
+         * to `i18next-http-backend`'s `parse`). Useful when a backend wraps the map
+         * in an envelope.
+         */
+        parse?: (data: string, languages?: string | string[], namespaces?: string | string[]) => Record<string, unknown>;
+    };
+    /** Ayinza localization-service integration (see {@link LocalizationConfig}). */
+    localization?: LocalizationConfig;
+    /** Browser language detection configuration. */
+    detection?: {
+        order?: string[];
+        caches?: string[];
+        lookupQuerystring?: string;
+        lookupCookie?: string;
+        lookupLocalStorage?: string;
+        lookupSessionStorage?: string;
+    };
+    /** Fallback language (or list) used when detection fails. */
+    fallbackLng?: string | string[];
+    /** Explicit list of supported languages to keep bundles constrained. */
+    supportedLngs?: string[];
+    /** Default namespace used by i18next. */
+    defaultNS?: string;
+    /** Namespace list to preload. */
+    ns?: string | string[];
+    /** Enable extra i18next debug logging. */
+    debug?: boolean;
+    /** Customize interpolation behavior (e.g., escapeValue). */
+    interpolation?: {
+        escapeValue?: boolean;
+    };
+    /** Formatter configuration shared by hooks and interpolation helpers. */
+    formatters?: FormattersConfig;
+    /** Optional portal identifier used for logging. */
+    portalName?: string;
+    /** React-i18next specific options (useSuspense, bindI18n, etc.). */
+    react?: ReactConfig;
+}
+export interface I18nInitOptions {
+    config?: Partial<I18nConfig>;
+    onInitialized?: () => void;
+    onError?: (error: Error) => void;
+}
+export type FetchLike = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
+export interface ParserPushConfig {
+    /** Friendly label for logs so multiple portals can be distinguished. */
+    portalName: string;
+    /** Optional URL to send detected keys to. When omitted the helper only logs the payload. */
+    pushUrl?: string;
+    /** Skips remote push and only logs keys. Useful for CI dry-runs. */
+    dryRun?: boolean;
+    /** Optional bearer token appended as an Authorization header. */
+    authorizationToken?: string;
+    /** Additional headers merged into the push request. */
+    headers?: Record<string, string>;
+    /** Custom fetch implementation when globalThis.fetch is unavailable. */
+    fetchImpl?: FetchLike;
+}
+export interface NewKeyPayload {
+    key: string;
+    namespace: string;
+    defaultValue: string;
+    locale: string;
+    filePaths?: string[];
+}
+export interface TranslationSnapshot {
+    locale: string;
+    namespaces: Record<string, Record<string, string>>;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/jest.config.cjs

@@ -0,0 +1,19 @@
+const config = {
+  preset: "ts-jest",
+  testEnvironment: "jsdom",
+  moduleFileExtensions: ["ts", "tsx", "js"],
+  roots: ["<rootDir>/src"],
+  moduleNameMapper: {
+    "^(\\.{1,2}/.*)\\.js$": "$1",
+  },
+  transform: {
+    "^.+\\.(ts|tsx)$": [
+      "ts-jest",
+      {
+        tsconfig: "tsconfig.test.json",
+      },
+    ],
+  },
+};
+
+module.exports = config;

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@ayinza_dev/i18n-config",
+  "version": "1.3.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "keywords": [],
+  "author": "ayinza",
+  "license": "MIT",
+  "description": "Shared i18next configuration for multiple portals",
+  "peerDependencies": {
+    "react": "^19.1.1",
+    "react-i18next": "^16.2.4"
+  },
+  "dependencies": {
+    "i18next": "^25.6.1",
+    "i18next-browser-languagedetector": "^8.2.0",
+    "i18next-http-backend": "^3.0.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.10.0",
+    "@types/react": "^19.2.2",
+    "@types/react-dom": "^19.2.2",
+    "i18next-parser": "^9.0.2",
+    "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
+    "ts-jest": "^29.4.5",
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sseris/ayinza-i18n-config.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sseris/ayinza-i18n-config/issues"
+  },
+  "homepage": "https://github.com/sseris/ayinza-i18n-config#readme"
+}

package/tsconfig.test.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "isolatedModules": false,
+    "types": ["node", "jest"]
+  }
+}