i18n-keyless-node 1.12.8 → 1.14.0

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { init, getAllTranslationsForAllLanguages, awaitForTranslation } from "./service";
+export { init, getAllTranslationsForAllLanguages, getSupportedLanguages, awaitForTranslation } from "./service";
 export type { Translations, I18nKeylessNodeConfig, I18nKeylessNodeStore, TranslationOptions, I18nKeylessRequestBody, I18nKeylessAllTranslationsResponse, } from "./types";
 export { type Lang, type PrimaryLang, type I18nKeylessResponse, queue } from "i18n-keyless-core";

package/dist/index.js

@@ -1,2 +1,2 @@
-export { init, getAllTranslationsForAllLanguages, awaitForTranslation } from "./service";
+export { init, getAllTranslationsForAllLanguages, getSupportedLanguages, awaitForTranslation } from "./service";
 export { queue } from "i18n-keyless-core";

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "i18n-keyless-node",
     "private": false,
-    "version": "1.12.8",
+    "version": "1.14.0",
     "type": "module",
     "main": "./dist/index.js",
     "module": "./dist/index.js",
@@ -15,7 +15,7 @@
         "postpublish": "rm -rf ./dist && rm *.tgz"
     },
     "dependencies": {
-        "i18n-keyless-core": "1.12.8"
+        "i18n-keyless-core": "1.14.0"
     },
     "devDependencies": {
         "@eslint/js": "^9.9.0",

package/dist/service.d.ts

@@ -6,6 +6,22 @@ import { I18nKeylessNodeConfig } from "types";
  * @returns Promise resolving to the translation response or void if failed
  */
 export declare function getAllTranslationsForAllLanguages(): Promise<I18nKeylessAllTranslationsResponse | void>;
+/**
+ * Send the last used translations to i18n-keyless API
+ *
+ * This is used to clean up the translations database
+ * and to avoid paying for translations that are not used anymore
+ *
+ * It's called on lib initialization
+ * and everytime the language is set
+ * @param lastUsedTranslation - The last used translations
+ * @param store - The translation store
+ * @returns Promise resolving to the translation response or void if failed
+ */
+export declare function sendTranslationsUsageToI18nKeyless(): Promise<{
+    ok: boolean;
+    message: string;
+} | void>;
 export declare function init(newConfig: I18nKeylessNodeConfig): Promise<I18nKeylessNodeConfig>;
 /**
  * Core logic for fetching/retrieving a translation asynchronously.
@@ -34,4 +50,5 @@ declare function awaitForTranslationFn(key: string, currentLanguage: Lang, optio
  * @throws Re-throws any internal error if the promise rejection is not handled by the caller.
  */
 export declare const awaitForTranslation: typeof awaitForTranslationFn;
+export declare function getSupportedLanguages(): Lang[];
 export {};

package/dist/service.js

@@ -19,6 +19,7 @@ const store = {
         ko: {},
         ar: {},
     },
+    lastUsedTranslation: {},
     uniqueId: "",
     lastRefresh: "",
     config: {
@@ -71,6 +72,54 @@ export async function getAllTranslationsForAllLanguages() {
         console.error("i18n-keyless: fetch all translations error:", error);
     }
 }
+/**
+ * Send the last used translations to i18n-keyless API
+ *
+ * This is used to clean up the translations database
+ * and to avoid paying for translations that are not used anymore
+ *
+ * It's called on lib initialization
+ * and everytime the language is set
+ * @param lastUsedTranslation - The last used translations
+ * @param store - The translation store
+ * @returns Promise resolving to the translation response or void if failed
+ */
+export async function sendTranslationsUsageToI18nKeyless() {
+    const config = store.config;
+    if (!config.API_KEY) {
+        console.error("i18n-keyless: No config found");
+        return;
+    }
+    const lastUsedTranslation = store.lastUsedTranslation;
+    if (Object.keys(lastUsedTranslation).length === 0) {
+        return;
+    }
+    try {
+        const response = config.sendTranslationsUsage
+            ? await config.sendTranslationsUsage(lastUsedTranslation)
+            : await api
+                .postLastUsedTranslations(`${config.API_URL || "https://api.i18n-keyless.com"}/translate/last-used-translations`, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${config.API_KEY}`,
+                    Version: packageJson.version,
+                },
+                body: JSON.stringify({
+                    primaryLanguage: config.languages.primary,
+                    lastUsedTranslation,
+                }),
+            })
+                .then((res) => res);
+        if (response.message) {
+            console.warn("i18n-keyless: ", response.message);
+        }
+        return response;
+    }
+    catch (error) {
+        console.error("i18n-keyless: send last used translation error:", error);
+    }
+}
 queue.on("empty", () => {
     // when each word is translated, fetch the translations for the current language
     getAllTranslationsForAllLanguages().then((res) => {
@@ -251,3 +300,6 @@ export const awaitForTranslation = new Proxy(awaitForTranslationFn, // Target th
         return promise;
     },
 });
+export function getSupportedLanguages() {
+    return store.config.languages.supported;
+}

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { HandleTranslateFunction, Lang, PrimaryLang } from "i18n-keyless-core";
+import { HandleTranslateFunction, Lang, LastUsedTranslation, PrimaryLang, SendTranslationsUsageFunction } from "i18n-keyless-core";
 export type Translations = Record<string, string>;
 export interface I18nKeylessNodeConfig {
     /**
@@ -64,6 +64,15 @@ export interface I18nKeylessNodeConfig {
      * - not use this `getAllTranslationsForAllLanguages` function nor API_KEY key, and provide your own API_URL
      */
     getAllTranslationsForAllLanguages?: () => Promise<I18nKeylessAllTranslationsResponse>;
+    /**
+     * 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, with the API_KEY
+     * 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;
 }
 export interface I18nKeylessNodeStore {
     /**
@@ -78,6 +87,10 @@ export interface I18nKeylessNodeStore {
      * the translations fetched from i18n-keyless' API
      */
     translations: Record<Lang, Translations>;
+    /**
+     * the last used translations
+     */
+    lastUsedTranslation: LastUsedTranslation;
     /**
      * i18n-keyless' config
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "i18n-keyless-node",
   "private": false,
-  "version": "1.12.8",
+  "version": "1.14.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -15,7 +15,7 @@
     "postpublish": "rm -rf ./dist && rm *.tgz"
   },
   "dependencies": {
-    "i18n-keyless-core": "1.12.8"
+    "i18n-keyless-core": "1.14.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.9.0",