inline-i18n-multi 0.16.0 → 0.18.0

package/README.md

@@ -87,6 +87,8 @@ See "Hello" in your app? Just search for "Hello" in your codebase. **Done.**
 - **Raw Template Access** -- `tRaw(key, locale?)` returns raw template string without interpolation (v0.14.0)
 - **Batch Translation** -- `tBatch(keys, vars?, locale?)` translates multiple keys at once (v0.15.0)
 - **Missing Locales Detection** -- `getMissingLocales(key)` returns locales where a key is absent (v0.16.0)
+- **Translation Completeness Ratio** -- `getCompletenessRatio(locale, baseLocale?, namespace?)` returns the fraction of base-locale keys present in a target locale (v0.17.0)
+- **Missing Key Listener** -- `onMissingKey(callback)` subscribes to missing translation events with `(key, locale)` (v0.18.0)
 
 ---
 
@@ -1027,6 +1029,8 @@ Available helpers:
 | `tRaw(key, locale?)` | Get raw template string without interpolation |
 | `tBatch(keys, vars?, locale?)` | Translate multiple keys at once |
 | `getMissingLocales(key)` | List locales missing a translation key |
+| `getCompletenessRatio(locale, baseLocale?, namespace?)` | Get translation completeness ratio (0-1) |
+| `onMissingKey(callback)` | Subscribe to missing translation key events |
 
 ### Custom Formatters
 

package/dist/index.d.mts

@@ -279,6 +279,22 @@ declare function getDictionary(locale: Locale, namespace?: string): Dictionary |
  * Get all loaded namespaces
  */
 declare function getLoadedNamespaces(): string[];
+/**
+ * Get translation completeness ratio of a locale relative to a base locale (v0.17.0)
+ * Returns a value between 0 and 1 representing the fraction of base locale keys
+ * that exist in the target locale.
+ *
+ * @param locale - Target locale to measure
+ * @param baseLocale - Reference locale (defaults to config.defaultLocale)
+ * @param namespace - Optional namespace to scope the comparison
+ * @returns Ratio in [0, 1]; 1 if base has no keys or locale === base
+ *
+ * @example
+ * loadDictionaries({ en: { a: '1', b: '2', c: '3' }, ko: { a: '가' } })
+ * getCompletenessRatio('ko')        // → 0.333... (1 of 3 keys translated)
+ * getCompletenessRatio('en')        // → 1 (same as base)
+ */
+declare function getCompletenessRatio(locale: Locale, baseLocale?: Locale, namespace?: string): number;
 /**
  * Get the display name of a locale using Intl.DisplayNames (v0.11.0)
  * @param locale - Locale code to get display name for (e.g., 'ko', 'ja', 'en-US')
@@ -302,6 +318,27 @@ declare function getLocaleDisplayName(locale: Locale, displayLocale?: Locale): s
  * getTranslationKeys('en', 'common')   // → ['hello', 'goodbye']
  */
 declare function getTranslationKeys(locale?: Locale, namespace?: string): string[];
+type MissingKeyCallback = (key: string, locale: Locale) => void;
+/**
+ * Subscribe to missing translation key events (v0.18.0)
+ * Callback fires every time `t()` encounters a key with no translation
+ * (independent of `trackMissingKeys`).
+ *
+ * @param callback - Receives `(key, requestedLocale)` for each missing key
+ * @returns Unsubscribe function
+ *
+ * @example
+ * const off = onMissingKey((key, locale) => {
+ *   reportToMonitoring({ key, locale })
+ * })
+ * t('missing.key')   // callback fires with ('missing.key', 'en')
+ * off()              // stop listening
+ */
+declare function onMissingKey(callback: MissingKeyCallback): () => void;
+/**
+ * Remove all missing-key listeners (for testing) (v0.18.0)
+ */
+declare function clearMissingKeyListeners(): void;
 /**
  * Enable or disable missing translation tracking (v0.11.0)
  * When enabled, all missing translation keys encountered via t() are recorded.
@@ -460,4 +497,4 @@ interface RichTextSegment {
  */
 declare function parseRichText(template: string, componentNames: string[]): RichTextSegment[];
 
-export { type Config, type CustomFormatter, type DebugModeOptions, type DetectLocaleOptions, type DetectSource, type Dictionaries, type Dictionary, type Locale, type PluralRules, type RichTextSegment, type TranslationVars, type TranslationWarning, type Translations, type WarningHandler, __i18n_lookup, clearDictionaries, clearFormatters, clearICUCache, clearLocaleListeners, clearMissingKeys, configure, createScope, detectLocale, en_de, en_es, en_fr, en_ja, en_zh, formatDate, formatList, formatNumber, getConfig, getDictionary, getLoadedLocales, getLoadedNamespaces, getLocale, getLocaleDisplayName, getMissingKeys, getMissingLocales, getTranslationKeys, hasTranslation, isLoaded, it, it_de, it_es, it_fr, it_ja, it_zh, ja_es, ja_zh, loadAsync, loadDictionaries, loadDictionary, onLocaleChange, parseRichText, registerFormatter, resetConfig, restoreLocale, setLocale, t, tBatch, tRaw, trackMissingKeys, zh_es };
+export { type Config, type CustomFormatter, type DebugModeOptions, type DetectLocaleOptions, type DetectSource, type Dictionaries, type Dictionary, type Locale, type PluralRules, type RichTextSegment, type TranslationVars, type TranslationWarning, type Translations, type WarningHandler, __i18n_lookup, clearDictionaries, clearFormatters, clearICUCache, clearLocaleListeners, clearMissingKeyListeners, clearMissingKeys, configure, createScope, detectLocale, en_de, en_es, en_fr, en_ja, en_zh, formatDate, formatList, formatNumber, getCompletenessRatio, getConfig, getDictionary, getLoadedLocales, getLoadedNamespaces, getLocale, getLocaleDisplayName, getMissingKeys, getMissingLocales, getTranslationKeys, hasTranslation, isLoaded, it, it_de, it_es, it_fr, it_ja, it_zh, ja_es, ja_zh, loadAsync, loadDictionaries, loadDictionary, onLocaleChange, onMissingKey, parseRichText, registerFormatter, resetConfig, restoreLocale, setLocale, t, tBatch, tRaw, trackMissingKeys, zh_es };

package/dist/index.d.ts

@@ -279,6 +279,22 @@ declare function getDictionary(locale: Locale, namespace?: string): Dictionary |
  * Get all loaded namespaces
  */
 declare function getLoadedNamespaces(): string[];
+/**
+ * Get translation completeness ratio of a locale relative to a base locale (v0.17.0)
+ * Returns a value between 0 and 1 representing the fraction of base locale keys
+ * that exist in the target locale.
+ *
+ * @param locale - Target locale to measure
+ * @param baseLocale - Reference locale (defaults to config.defaultLocale)
+ * @param namespace - Optional namespace to scope the comparison
+ * @returns Ratio in [0, 1]; 1 if base has no keys or locale === base
+ *
+ * @example
+ * loadDictionaries({ en: { a: '1', b: '2', c: '3' }, ko: { a: '가' } })
+ * getCompletenessRatio('ko')        // → 0.333... (1 of 3 keys translated)
+ * getCompletenessRatio('en')        // → 1 (same as base)
+ */
+declare function getCompletenessRatio(locale: Locale, baseLocale?: Locale, namespace?: string): number;
 /**
  * Get the display name of a locale using Intl.DisplayNames (v0.11.0)
  * @param locale - Locale code to get display name for (e.g., 'ko', 'ja', 'en-US')
@@ -302,6 +318,27 @@ declare function getLocaleDisplayName(locale: Locale, displayLocale?: Locale): s
  * getTranslationKeys('en', 'common')   // → ['hello', 'goodbye']
  */
 declare function getTranslationKeys(locale?: Locale, namespace?: string): string[];
+type MissingKeyCallback = (key: string, locale: Locale) => void;
+/**
+ * Subscribe to missing translation key events (v0.18.0)
+ * Callback fires every time `t()` encounters a key with no translation
+ * (independent of `trackMissingKeys`).
+ *
+ * @param callback - Receives `(key, requestedLocale)` for each missing key
+ * @returns Unsubscribe function
+ *
+ * @example
+ * const off = onMissingKey((key, locale) => {
+ *   reportToMonitoring({ key, locale })
+ * })
+ * t('missing.key')   // callback fires with ('missing.key', 'en')
+ * off()              // stop listening
+ */
+declare function onMissingKey(callback: MissingKeyCallback): () => void;
+/**
+ * Remove all missing-key listeners (for testing) (v0.18.0)
+ */
+declare function clearMissingKeyListeners(): void;
 /**
  * Enable or disable missing translation tracking (v0.11.0)
  * When enabled, all missing translation keys encountered via t() are recorded.
@@ -460,4 +497,4 @@ interface RichTextSegment {
  */
 declare function parseRichText(template: string, componentNames: string[]): RichTextSegment[];
 
-export { type Config, type CustomFormatter, type DebugModeOptions, type DetectLocaleOptions, type DetectSource, type Dictionaries, type Dictionary, type Locale, type PluralRules, type RichTextSegment, type TranslationVars, type TranslationWarning, type Translations, type WarningHandler, __i18n_lookup, clearDictionaries, clearFormatters, clearICUCache, clearLocaleListeners, clearMissingKeys, configure, createScope, detectLocale, en_de, en_es, en_fr, en_ja, en_zh, formatDate, formatList, formatNumber, getConfig, getDictionary, getLoadedLocales, getLoadedNamespaces, getLocale, getLocaleDisplayName, getMissingKeys, getMissingLocales, getTranslationKeys, hasTranslation, isLoaded, it, it_de, it_es, it_fr, it_ja, it_zh, ja_es, ja_zh, loadAsync, loadDictionaries, loadDictionary, onLocaleChange, parseRichText, registerFormatter, resetConfig, restoreLocale, setLocale, t, tBatch, tRaw, trackMissingKeys, zh_es };
+export { type Config, type CustomFormatter, type DebugModeOptions, type DetectLocaleOptions, type DetectSource, type Dictionaries, type Dictionary, type Locale, type PluralRules, type RichTextSegment, type TranslationVars, type TranslationWarning, type Translations, type WarningHandler, __i18n_lookup, clearDictionaries, clearFormatters, clearICUCache, clearLocaleListeners, clearMissingKeyListeners, clearMissingKeys, configure, createScope, detectLocale, en_de, en_es, en_fr, en_ja, en_zh, formatDate, formatList, formatNumber, getCompletenessRatio, getConfig, getDictionary, getLoadedLocales, getLoadedNamespaces, getLocale, getLocaleDisplayName, getMissingKeys, getMissingLocales, getTranslationKeys, hasTranslation, isLoaded, it, it_de, it_es, it_fr, it_ja, it_zh, ja_es, ja_zh, loadAsync, loadDictionaries, loadDictionary, onLocaleChange, onMissingKey, parseRichText, registerFormatter, resetConfig, restoreLocale, setLocale, t, tBatch, tRaw, trackMissingKeys, zh_es };

package/dist/index.js

@@ -938,7 +938,7 @@ function t(key, vars, locale) {
     }
   }
   if (!template) {
-    recordMissingKey(key);
+    recordMissingKey(key, currentLocale2);
     emitWarning({
       type: "missing_translation",
       key,
@@ -1039,6 +1039,18 @@ function getDictionary(locale, namespace) {
 function getLoadedNamespaces() {
   return Object.keys(namespacedDictionaries);
 }
+function getCompletenessRatio(locale, baseLocale, namespace) {
+  const base = baseLocale ?? getConfig().defaultLocale;
+  if (locale === base) return 1;
+  const baseKeys = getTranslationKeys(base, namespace);
+  if (baseKeys.length === 0) return 1;
+  const localeKeys = new Set(getTranslationKeys(locale, namespace));
+  let matched = 0;
+  for (const k of baseKeys) {
+    if (localeKeys.has(k)) matched++;
+  }
+  return matched / baseKeys.length;
+}
 function getLocaleDisplayName(locale, displayLocale) {
   const dl = displayLocale ?? getLocale();
   try {
@@ -1077,6 +1089,16 @@ function getTranslationKeys(locale, namespace) {
 }
 var missingKeys = /* @__PURE__ */ new Set();
 var trackMissing = false;
+var missingKeyListeners = /* @__PURE__ */ new Set();
+function onMissingKey(callback) {
+  missingKeyListeners.add(callback);
+  return () => {
+    missingKeyListeners.delete(callback);
+  };
+}
+function clearMissingKeyListeners() {
+  missingKeyListeners.clear();
+}
 function trackMissingKeys(enabled) {
   trackMissing = enabled;
   if (!enabled) {
@@ -1089,10 +1111,16 @@ function getMissingKeys() {
 function clearMissingKeys() {
   missingKeys = /* @__PURE__ */ new Set();
 }
-function recordMissingKey(key) {
+function recordMissingKey(key, locale) {
   if (trackMissing) {
     missingKeys.add(key);
   }
+  if (missingKeyListeners.size > 0) {
+    const loc = locale ?? getLocale();
+    for (const cb of missingKeyListeners) {
+      cb(key, loc);
+    }
+  }
 }
 
 // src/detect.ts
@@ -1241,6 +1269,7 @@ exports.clearDictionaries = clearDictionaries;
 exports.clearFormatters = clearFormatters;
 exports.clearICUCache = clearICUCache;
 exports.clearLocaleListeners = clearLocaleListeners;
+exports.clearMissingKeyListeners = clearMissingKeyListeners;
 exports.clearMissingKeys = clearMissingKeys;
 exports.configure = configure;
 exports.createScope = createScope;
@@ -1253,6 +1282,7 @@ exports.en_zh = en_zh;
 exports.formatDate = formatDate;
 exports.formatList = formatList;
 exports.formatNumber = formatNumber;
+exports.getCompletenessRatio = getCompletenessRatio;
 exports.getConfig = getConfig;
 exports.getDictionary = getDictionary;
 exports.getLoadedLocales = getLoadedLocales;
@@ -1276,6 +1306,7 @@ exports.loadAsync = loadAsync;
 exports.loadDictionaries = loadDictionaries;
 exports.loadDictionary = loadDictionary;
 exports.onLocaleChange = onLocaleChange;
+exports.onMissingKey = onMissingKey;
 exports.parseRichText = parseRichText;
 exports.registerFormatter = registerFormatter;
 exports.resetConfig = resetConfig;