i18n-keyless-core 1.12.8 → 1.14.0

package/dist/api.d.ts

@@ -2,4 +2,5 @@ export declare const api: {
     fetchTranslation: (url: string, options: RequestInit) => Promise<any>;
     fetchTranslationsForOneLanguage: (url: string, options: RequestInit) => Promise<any>;
     fetchAllTranslationsForAllLanguages: (url: string, options: RequestInit) => Promise<any>;
+    postLastUsedTranslations: (url: string, options: RequestInit) => Promise<any>;
 };

package/dist/api.js

@@ -20,4 +20,11 @@ export const api = {
             return { ok: false, error: err.message };
         });
     },
+    postLastUsedTranslations: async (url, options) => {
+        return fetch(url, options)
+            .then((res) => (res.status === 200 ? res.json() : { ok: false, error: res.statusText }))
+            .catch((err) => {
+            return { ok: false, error: err.message };
+        });
+    },
 };

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export type { Lang, PrimaryLang, Translations, HandleTranslateFunction, GetAllTranslationsFunction, GetAllTranslationsForAllLanguagesFunction, LanguagesConfig, LastRefresh, UniqueId, I18nKeylessRequestBody, I18nKeylessResponse, I18nKeylessAllTranslationsResponse, FetchTranslationParams, TranslationOptions, } from "./types";
+export type { Lang, PrimaryLang, Translations, LastUsedTranslation, HandleTranslateFunction, GetAllTranslationsFunction, SendTranslationsUsageFunction, GetAllTranslationsForAllLanguagesFunction, LanguagesConfig, LastRefresh, UniqueId, I18nKeylessRequestBody, I18nKeylessResponse, I18nKeylessAllTranslationsResponse, FetchTranslationParams, TranslationOptions, } from "./types";
 export { getTranslationCore, getAllTranslationsFromLanguage, queue } from "./service";
 export { api } from "./api";

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "i18n-keyless-core",
     "private": false,
-    "version": "1.12.8",
+    "version": "1.14.0",
     "type": "module",
     "main": "./dist/index.js",
     "module": "./dist/index.js",

package/dist/service.d.ts

@@ -1,4 +1,4 @@
-import type { Lang, TranslationOptions, I18nKeylessResponse, FetchTranslationParams } from "./types";
+import type { Lang, TranslationOptions, I18nKeylessResponse, FetchTranslationParams, LastUsedTranslation } from "./types";
 import MyPQueue from "./my-pqueue";
 export declare const queue: MyPQueue;
 /**
@@ -25,3 +25,19 @@ export declare function translateKey(key: string, store: FetchTranslationParams,
  * @returns Promise resolving to the translation response or void if failed
  */
 export declare function getAllTranslationsFromLanguage(targetLanguage: Lang, store: FetchTranslationParams): Promise<I18nKeylessResponse | 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(lastUsedTranslation: LastUsedTranslation, store: FetchTranslationParams): Promise<{
+    ok: boolean;
+    message: string;
+} | void>;

package/dist/service.js

@@ -161,3 +161,50 @@ export async function getAllTranslationsFromLanguage(targetLanguage, store) {
         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(lastUsedTranslation, store) {
+    const config = store.config;
+    if (!config.API_KEY) {
+        console.error("i18n-keyless: No config found");
+        return;
+    }
+    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);
+    }
+}

package/dist/types.d.ts

@@ -1,6 +1,12 @@
 export type PrimaryLang = "fr" | "en";
 export type Lang = "fr" | "en" | "nl" | "it" | "de" | "es" | "pl" | "pt" | "ro" | "sv" | "tr" | "ja" | "cn" | "ru" | "ko" | "ar";
 export type Translations = Record<string, string>;
+/**
+ * The last used translation for a key
+ * Useful to clean up the translations database and to avoid paying for translations that are not used anymore
+ * Record<string, YYYY-MM-DD>;
+ */
+export type LastUsedTranslation = Record<string, string>;
 export type HandleTranslateFunction = (key: string) => Promise<{
     ok: boolean;
     message: string;
@@ -10,6 +16,10 @@ export type HandleTranslateFunction = (key: string) => Promise<{
 }>;
 export type GetAllTranslationsFunction = () => Promise<I18nKeylessResponse>;
 export type GetAllTranslationsForAllLanguagesFunction = () => Promise<I18nKeylessAllTranslationsResponse>;
+export type SendTranslationsUsageFunction = (lastUsedTranslation: LastUsedTranslation) => Promise<{
+    ok: boolean;
+    message: string;
+}>;
 export type LastRefresh = string | null;
 export type UniqueId = string | null;
 export type LanguagesConfig = {
@@ -59,6 +69,10 @@ export interface I18nKeylessRequestBody {
     languages: LanguagesConfig["supported"];
     primaryLanguage: LanguagesConfig["primary"];
 }
+export interface I18nKeylessTranslationsUsageRequestBody {
+    primaryLanguage: LanguagesConfig["primary"];
+    lastUsedTranslation: LastUsedTranslation;
+}
 export interface I18nKeylessResponse {
     ok: boolean;
     data: {
@@ -92,6 +106,7 @@ export type FetchTranslationParams = {
         handleTranslate?: HandleTranslateFunction;
         getAllTranslations?: GetAllTranslationsFunction;
         getAllTranslationsForAllLanguages?: GetAllTranslationsForAllLanguagesFunction;
+        sendTranslationsUsage?: SendTranslationsUsageFunction;
     };
     translations: Translations;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "i18n-keyless-core",
   "private": false,
-  "version": "1.12.8",
+  "version": "1.14.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",