@xivdyetools/bot-i18n 1.0.0

package/dist/translator.d.ts

@@ -0,0 +1,45 @@
+import type { LocaleCode, LocaleData, TranslatorLogger } from './types.js';
+/**
+ * Translator for a specific locale.
+ * Falls back to English for missing keys.
+ */
+export declare class Translator {
+    private locale;
+    private data;
+    private fallbackData;
+    private logger?;
+    constructor(locale: LocaleCode, logger?: TranslatorLogger);
+    /**
+     * Get a translated string by dot-notation key.
+     * Falls back to English if the key is missing in the current locale.
+     * Returns the raw key if not found in any locale.
+     *
+     * @example
+     * t.t('errors.dyeNotFound', { name: 'Snow White' })
+     * // → 'Could not find a dye named "Snow White".'
+     */
+    t(key: string, variables?: Record<string, string | number>): string;
+    /** Get the current locale code. */
+    getLocale(): LocaleCode;
+    /** Get locale metadata (name, nativeName, flag). */
+    getMeta(): LocaleData['meta'];
+}
+/**
+ * Create a translator for a specific locale.
+ * Locale data is bundled — no I/O required.
+ */
+export declare function createTranslator(locale: LocaleCode, logger?: TranslatorLogger): Translator;
+/**
+ * Quick one-off translation helper.
+ */
+export declare function translate(locale: LocaleCode, key: string, variables?: Record<string, string | number>, logger?: TranslatorLogger): string;
+/**
+ * Get all available locales with metadata.
+ * Used by language selection commands to show available options.
+ */
+export declare function getAvailableLocales(): Array<LocaleData['meta']>;
+/**
+ * Type guard: check if a string is a supported locale code.
+ */
+export declare function isLocaleSupported(locale: string): locale is LocaleCode;
+//# sourceMappingURL=translator.d.ts.map

package/dist/translator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translator.d.ts","sourceRoot":"","sources":["../src/translator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AA8C3E;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,IAAI,CAAa;IACzB,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,MAAM,CAAC,CAAmB;gBAEtB,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,gBAAgB;IAOzD;;;;;;;;OAQG;IACH,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAAG,MAAM;IAenE,mCAAmC;IACnC,SAAS,IAAI,UAAU;IAIvB,oDAAoD;IACpD,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC;CAG9B;AAMD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,UAAU,CAE1F;AAED;;GAEG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,EAC3C,MAAM,CAAC,EAAE,gBAAgB,GACxB,MAAM,CAER;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAE/D;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,UAAU,CAEtE"}

package/dist/translator.js

@@ -0,0 +1,112 @@
+// Bundled locale data (static imports work in both CF Workers and Node.js)
+import enLocale from './locales/en.json';
+import jaLocale from './locales/ja.json';
+import deLocale from './locales/de.json';
+import frLocale from './locales/fr.json';
+import koLocale from './locales/ko.json';
+import zhLocale from './locales/zh.json';
+const locales = {
+    en: enLocale,
+    ja: jaLocale,
+    de: deLocale,
+    fr: frLocale,
+    ko: koLocale,
+    zh: zhLocale,
+};
+// ============================================================================
+// Internal helpers
+// ============================================================================
+function getNestedValue(obj, path) {
+    const keys = path.split('.');
+    let current = obj;
+    for (const key of keys) {
+        if (current === null || current === undefined)
+            return undefined;
+        if (typeof current !== 'object')
+            return undefined;
+        current = current[key];
+    }
+    return current;
+}
+function interpolate(template, variables) {
+    return template.replace(/\{(\w+)\}/g, (match, key) => {
+        return variables[key]?.toString() ?? match;
+    });
+}
+// ============================================================================
+// Translator class
+// ============================================================================
+/**
+ * Translator for a specific locale.
+ * Falls back to English for missing keys.
+ */
+export class Translator {
+    locale;
+    data;
+    fallbackData;
+    logger;
+    constructor(locale, logger) {
+        this.locale = locale;
+        this.data = locales[locale] || locales.en;
+        this.fallbackData = locales.en;
+        this.logger = logger;
+    }
+    /**
+     * Get a translated string by dot-notation key.
+     * Falls back to English if the key is missing in the current locale.
+     * Returns the raw key if not found in any locale.
+     *
+     * @example
+     * t.t('errors.dyeNotFound', { name: 'Snow White' })
+     * // → 'Could not find a dye named "Snow White".'
+     */
+    t(key, variables) {
+        let value = getNestedValue(this.data, key);
+        if (value === undefined && this.locale !== 'en') {
+            value = getNestedValue(this.fallbackData, key);
+        }
+        if (value === undefined || typeof value !== 'string') {
+            this.logger?.warn(`Missing translation: ${key} for locale ${this.locale}`);
+            return key;
+        }
+        return variables ? interpolate(value, variables) : value;
+    }
+    /** Get the current locale code. */
+    getLocale() {
+        return this.locale;
+    }
+    /** Get locale metadata (name, nativeName, flag). */
+    getMeta() {
+        return this.data.meta;
+    }
+}
+// ============================================================================
+// Factory functions
+// ============================================================================
+/**
+ * Create a translator for a specific locale.
+ * Locale data is bundled — no I/O required.
+ */
+export function createTranslator(locale, logger) {
+    return new Translator(locale, logger);
+}
+/**
+ * Quick one-off translation helper.
+ */
+export function translate(locale, key, variables, logger) {
+    return new Translator(locale, logger).t(key, variables);
+}
+/**
+ * Get all available locales with metadata.
+ * Used by language selection commands to show available options.
+ */
+export function getAvailableLocales() {
+    return Object.values(locales).map((data) => data.meta);
+}
+/**
+ * Type guard: check if a string is a supported locale code.
+ */
+export function isLocaleSupported(locale) {
+    return locale in locales;
+}
+//# sourceMappingURL=translator.js.map

package/dist/translator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"translator.js","sourceRoot":"","sources":["../src/translator.ts"],"names":[],"mappings":"AAEA,2EAA2E;AAC3E,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AACzC,OAAO,QAAQ,MAAM,mBAAmB,CAAC;AAEzC,MAAM,OAAO,GAAmC;IAC9C,EAAE,EAAE,QAAsB;IAC1B,EAAE,EAAE,QAAsB;IAC1B,EAAE,EAAE,QAAsB;IAC1B,EAAE,EAAE,QAAsB;IAC1B,EAAE,EAAE,QAAsB;IAC1B,EAAE,EAAE,QAAsB;CAC3B,CAAC;AAEF,+EAA+E;AAC/E,mBAAmB;AACnB,+EAA+E;AAE/E,SAAS,cAAc,CAAC,GAA4B,EAAE,IAAY;IAChE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,OAAO,GAAY,GAAG,CAAC;IAE3B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,SAAS,CAAC;QAChE,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QAClD,OAAO,GAAI,OAAmC,CAAC,GAAG,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,WAAW,CAAC,QAAgB,EAAE,SAA0C;IAC/E,OAAO,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACnD,OAAO,SAAS,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,IAAI,KAAK,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC;AAED,+EAA+E;AAC/E,mBAAmB;AACnB,+EAA+E;AAE/E;;;GAGG;AACH,MAAM,OAAO,UAAU;IACb,MAAM,CAAa;IACnB,IAAI,CAAa;IACjB,YAAY,CAAa;IACzB,MAAM,CAAoB;IAElC,YAAY,MAAkB,EAAE,MAAyB;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC;QAC1C,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;;;;OAQG;IACH,CAAC,CAAC,GAAW,EAAE,SAA2C;QACxD,IAAI,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,IAA+B,EAAE,GAAG,CAAC,CAAC;QAEtE,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAChD,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,YAAuC,EAAE,GAAG,CAAC,CAAC;QAC5E,CAAC;QAED,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrD,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,wBAAwB,GAAG,eAAe,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;YAC3E,OAAO,GAAG,CAAC;QACb,CAAC;QAED,OAAO,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC3D,CAAC;IAED,mCAAmC;IACnC,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,oDAAoD;IACpD,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACxB,CAAC;CACF;AAED,+EAA+E;AAC/E,oBAAoB;AACpB,+EAA+E;AAE/E;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAkB,EAAE,MAAyB;IAC5E,OAAO,IAAI,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,SAAS,CACvB,MAAkB,EAClB,GAAW,EACX,SAA2C,EAC3C,MAAyB;IAEzB,OAAO,IAAI,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;AAC1D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB;IACjC,OAAO,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO,MAAM,IAAI,OAAO,CAAC;AAC3B,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Supported locale codes.
+ * Matches XIVAPI languages plus Korean and Chinese (from manual data).
+ */
+export type LocaleCode = 'en' | 'ja' | 'de' | 'fr' | 'ko' | 'zh';
+/**
+ * Structure of a locale JSON file.
+ */
+export interface LocaleData {
+    meta: {
+        locale: string;
+        name: string;
+        nativeName: string;
+        flag: string;
+    };
+    [key: string]: unknown;
+}
+/**
+ * Minimal logger interface accepted by Translator.
+ * Compatible with @xivdyetools/logger's ExtendedLogger.
+ */
+export interface TranslatorLogger {
+    warn: (msg: string) => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE;QACJ,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAC7B"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@xivdyetools/bot-i18n",
+  "version": "1.0.0",
+  "description": "Platform-agnostic translation engine for bot UI strings — error messages, help text, command descriptions, and status messages",
+  "author": "XIV Dye Tools",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.0.18",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "xivdyetools",
+    "i18n",
+    "localization",
+    "translation",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FlashGalatine/xivdyetools.git",
+    "directory": "packages/bot-i18n"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "type-check": "tsc --noEmit",
+    "clean": "rimraf dist coverage",
+    "lint": "eslint src",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }
+}