i18n-keyless-react 1.13.0 → 1.14.2

package/dist/__tests__/__mocks__/store.js

@@ -10,6 +10,7 @@ export const store = {
     },
     currentLanguage: "fr",
     translations: {},
+    lastUsedTranslation: {},
     uniqueId: null,
     lastRefresh: null,
     setTranslations: vi.fn(),
@@ -17,6 +18,7 @@ export const store = {
         const validated = validateLanguage(lang, store.config);
         store.currentLanguage = validated;
     }),
+    sendTranslationsUsage: vi.fn(),
 };
 // Create a function that supports the selector pattern
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "i18n-keyless-react",
     "private": false,
-    "version": "1.13.0",
+    "version": "1.14.2",
     "type": "module",
     "main": "./dist/index.js",
     "module": "./dist/index.js",
@@ -17,7 +17,7 @@
         "postpublish": "rm -rf ./dist && rm *.tgz"
     },
     "dependencies": {
-        "i18n-keyless-core": "1.13.0",
+        "i18n-keyless-core": "1.14.2",
         "zustand": "^5.0.3"
     },
     "peerDependencies": {

package/dist/store.js

@@ -1,6 +1,7 @@
 import { queue, getAllTranslationsFromLanguage, getTranslationCore, } from "i18n-keyless-core";
 import { create } from "zustand";
 import { storeKeys, setItem, getItem, clearI18nKeylessStorage, validateLanguage } from "./utils";
+import { sendTranslationsUsageToI18nKeyless } from "i18n-keyless-core/service";
 queue.on("empty", () => {
     // when each word is translated, fetch the translations for the current language
     const store = useI18nKeyless.getState();
@@ -12,6 +13,7 @@ export const useI18nKeyless = create((set, get) => ({
     uniqueId: null,
     lastRefresh: null,
     translations: {},
+    lastUsedTranslation: {},
     currentLanguage: "fr",
     config: {
         API_KEY: "",
@@ -46,6 +48,24 @@ export const useI18nKeyless = create((set, get) => ({
             setItem(storeKeys.lastRefresh, response.data.lastRefresh, storage);
         }
     },
+    sendTranslationsUsage: async () => {
+        const store = get();
+        if (!store.config) {
+            throw new Error(`i18n-keyless: config is not initialized sending last used translation`);
+        }
+        const storage = store.config.storage;
+        const lastUsedTranslation = store.lastUsedTranslation;
+        if (Object.keys(lastUsedTranslation).length === 0) {
+            return;
+        }
+        const response = await sendTranslationsUsageToI18nKeyless(lastUsedTranslation, store);
+        if (response?.ok) {
+            set({ lastUsedTranslation: {} });
+            if (storage) {
+                setItem(storeKeys.lastUsedTranslation, "", storage);
+            }
+        }
+    },
     setLanguage: async (lang) => {
         const store = get();
         if (!store.config) {
@@ -93,6 +113,16 @@ async function hydrate() {
         if (debug)
             console.log("i18n-keyless: _hydrate: no translations");
     }
+    const lastUsedTranslation = await getItem(storeKeys.lastUsedTranslation, storage, JSON.parse);
+    if (lastUsedTranslation) {
+        if (debug)
+            console.log("i18n-keyless: _hydrate: last used translation", lastUsedTranslation);
+        useI18nKeyless.setState({ lastUsedTranslation: lastUsedTranslation });
+    }
+    else {
+        if (debug)
+            console.log("i18n-keyless: _hydrate: no last used translation");
+    }
     const currentLanguage = await getItem(storeKeys.currentLanguage, storage);
     if (currentLanguage) {
         if (debug)
@@ -159,6 +189,7 @@ export async function init(newConfig) {
     newConfig.onInit?.(currentLanguage);
     // initialize the language to fetch all the translations
     useI18nKeyless.getState().setLanguage(currentLanguage);
+    useI18nKeyless.getState().sendTranslationsUsage();
 }
 export function useCurrentLanguage() {
     const currentLanguage = useI18nKeyless((state) => state.currentLanguage);

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { I18nKeylessResponse, Lang, Translations, HandleTranslateFunction, GetAllTranslationsFunction, UniqueId, LastRefresh, LanguagesConfig } from "i18n-keyless-core";
+import type { I18nKeylessResponse, Lang, Translations, LastUsedTranslation, HandleTranslateFunction, GetAllTranslationsFunction, SendTranslationsUsageFunction, UniqueId, LastRefresh, LanguagesConfig } from "i18n-keyless-core";
 type GetStorageFunction = (key: string) => string | null | undefined | Promise<string | null | undefined>;
 type SetStorageFunction = (key: string, value: string) => void | Promise<void>;
 type RemoveStorageFunction = (key: string) => void | Promise<void>;
@@ -69,6 +69,15 @@ export interface I18nConfig {
      * - not use this `getAllTranslations` function nor API_KEY key, and provide your own API_URL
      */
     getAllTranslations?: GetAllTranslationsFunction;
+    /**
+     * if this function exists, it will be called instead of the API call
+     * if this function doesn't exist, the default behavior is to call the API
+     * therefore you need either to
+     * - use this `sendTranslationsUsage` function to handle the translation with your own API
+     * - not use this `sendTranslationsUsage` function, and use the built in API call with the API_KEY filled
+     * - not use this `sendTranslationsUsage` function nor API_KEY key, and provide your own API_URL
+     */
+    sendTranslationsUsage?: SendTranslationsUsageFunction;
     /**
      * the storage to use for the translations
      *
@@ -119,6 +128,13 @@ export interface TranslationStoreState {
      * the translations fetched from i18n-keyless' API
      */
     translations: Translations;
+    /**
+     * save the date in format YYYY-MM-DD when a key is used
+     * this information is sent to i18n-keyless' API on lib initialization
+     * it's used to clean up the translations database
+     * and to avoid paying for translations that are not used anymore
+     */
+    lastUsedTranslation: LastUsedTranslation;
     /**
      * the current language of the user
      */
@@ -149,6 +165,7 @@ export type TranslationOptions = {
 interface TranslationStoreActions {
     setTranslations: (translations: I18nKeylessResponse | void) => void;
     setLanguage: (lang: Lang) => void;
+    sendTranslationsUsage: () => Promise<void>;
 }
 export type TranslationStore = TranslationStoreState & TranslationStoreActions;
 export {};

package/dist/utils.d.ts

@@ -7,6 +7,7 @@ export declare const storeKeys: {
     lastRefresh: "i18n-keyless-last-refresh";
     translations: "i18n-keyless-translations";
     currentLanguage: "i18n-keyless-current-language";
+    lastUsedTranslation: "i18n-keyless-last-used-translation";
 };
 /**
  * Retrieves an item from storage using various storage API patterns

package/dist/utils.js

@@ -6,6 +6,7 @@ export const storeKeys = {
     lastRefresh: "i18n-keyless-last-refresh",
     translations: "i18n-keyless-translations",
     currentLanguage: "i18n-keyless-current-language",
+    lastUsedTranslation: "i18n-keyless-last-used-translation",
 };
 /**
  * Retrieves an item from storage using various storage API patterns

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "i18n-keyless-react",
   "private": false,
-  "version": "1.13.0",
+  "version": "1.14.2",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -17,7 +17,7 @@
     "postpublish": "rm -rf ./dist && rm *.tgz"
   },
   "dependencies": {
-    "i18n-keyless-core": "1.13.0",
+    "i18n-keyless-core": "1.14.2",
     "zustand": "^5.0.3"
   },
   "peerDependencies": {