i18n-keyless-core 1.10.5 → 1.10.6

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export type { I18nConfig, Lang, PrimaryLang, Translations, TranslationStore, TranslationStoreState, MinimalTranslationStore, OmitCurrentLanguageTranslationStore, NodeConfig, I18nKeylessRequestBody, I18nKeylessResponse, I18nKeylessAllTranslationsResponse, TranslationOptions, } from "./types";
-export { getTranslationCore, getAllTranslationsFromLanguage, getAllTranslationsForAllLanguages, validateLanguage, queue, } from "./service";
+export type { Lang, PrimaryLang, Translations, HandleTranslateFunction, GetAllTranslationsFunction, GetAllTranslationsForAllLanguagesFunction, LanguagesConfig, LastRefresh, UniqueId, I18nKeylessRequestBody, I18nKeylessResponse, I18nKeylessAllTranslationsResponse, FetchTranslationParams, TranslationOptions, } from "./types";
+export { getTranslationCore, getAllTranslationsFromLanguage, queue } from "./service";

package/dist/index.js

@@ -1 +1 @@
-export { getTranslationCore, getAllTranslationsFromLanguage, getAllTranslationsForAllLanguages, validateLanguage, queue, } from "./service";
+export { getTranslationCore, getAllTranslationsFromLanguage, queue } from "./service";

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "i18n-keyless-core",
     "private": false,
-    "version": "1.10.5",
+    "version": "1.10.6",
     "type": "module",
     "main": "./dist/index.js",
     "module": "./dist/index.js",
@@ -11,7 +11,8 @@
     ],
     "scripts": {
         "prepublishOnly": "rm -rf ./dist && tsc --project tsconfig.json && npm pack",
-        "test": "echo 'no test for core'"
+        "test": "echo 'no test for core'",
+        "postpublish": "rm -rf ./dist && rm *.tgz"
     },
     "devDependencies": {
         "@types/node": "^22.5.5",

package/dist/service.d.ts

@@ -1,14 +1,6 @@
-import type { I18nConfig, Lang, OmitCurrentLanguageTranslationStore, MinimalTranslationStore, TranslationOptions, I18nKeylessResponse } from "./types";
+import type { Lang, TranslationOptions, I18nKeylessResponse, FetchTranslationParams } from "./types";
 import MyPQueue from "./my-pqueue";
 export declare const queue: MyPQueue;
-/**
- * Validates the language against the supported languages
- * @param lang - The language to validate
- * @param config - The configuration object
- * @returns The validated language or the fallback language if not supported
- * @throws Error if config is not initialized
- */
-export declare function validateLanguage(lang: I18nConfig["languages"]["supported"][number], config: I18nConfig): Lang | undefined;
 /**
  * Gets a translation for the specified key from the store
  * @param key - The translation key (text in primary language)
@@ -17,7 +9,7 @@ export declare function validateLanguage(lang: I18nConfig["languages"]["supporte
  * @returns The translated text or the original key if not found
  * @throws Error if config is not initialized
  */
-export declare function getTranslationCore(key: string, store: MinimalTranslationStore, options?: TranslationOptions): string;
+export declare function getTranslationCore(key: string, store: FetchTranslationParams, options?: TranslationOptions): string;
 /**
  * Queues a key for translation if not already translated
  * @param key - The text to translate
@@ -25,18 +17,11 @@ export declare function getTranslationCore(key: string, store: MinimalTranslatio
  * @param options - Optional parameters for the translation process
  * @throws Error if config is not initialized
  */
-export declare function translateKey(key: string, store: MinimalTranslationStore, options?: TranslationOptions): void;
-/**
- * Fetches all translations for a target language
- * @param targetLanguage - The language code to fetch translations for
- * @param store - The translation store
- * @returns Promise resolving to the translation response or void if failed
- */
-export declare function getAllTranslationsFromLanguage(targetLanguage: Lang, store: MinimalTranslationStore): Promise<I18nKeylessResponse | void>;
+export declare function translateKey(key: string, store: FetchTranslationParams, options?: TranslationOptions): void;
 /**
  * Fetches all translations for a target language
  * @param targetLanguage - The language code to fetch translations for
  * @param store - The translation store
  * @returns Promise resolving to the translation response or void if failed
  */
-export declare function getAllTranslationsForAllLanguages(store: OmitCurrentLanguageTranslationStore): Promise<I18nKeylessResponse | void>;
+export declare function getAllTranslationsFromLanguage(targetLanguage: Lang, store: FetchTranslationParams): Promise<I18nKeylessResponse | void>;

package/dist/service.js

@@ -2,22 +2,6 @@ import MyPQueue from "./my-pqueue";
 import packageJson from "./package.json";
 import { api } from "./api";
 export const queue = new MyPQueue({ concurrency: 5 });
-/**
- * Validates the language against the supported languages
- * @param lang - The language to validate
- * @param config - The configuration object
- * @returns The validated language or the fallback language if not supported
- * @throws Error if config is not initialized
- */
-export function validateLanguage(lang, config) {
-    if (!config) {
-        throw new Error(`i18n-keyless: config is not initialized validating language`);
-    }
-    if (!config.languages.supported.includes(lang)) {
-        return config.languages.fallback;
-    }
-    return lang;
-}
 /**
  * Gets a translation for the specified key from the store
  * @param key - The translation key (text in primary language)
@@ -30,7 +14,7 @@ export function getTranslationCore(key, store, options) {
     const currentLanguage = store.currentLanguage;
     const config = store.config;
     const translations = store.translations;
-    if (!config) {
+    if (!config.API_KEY) {
         throw new Error("i18n-keyless: config is not initialized");
     }
     if (currentLanguage === config.languages.primary) {
@@ -59,7 +43,7 @@ export function translateKey(key, store, options) {
     const config = store.config;
     const translations = store.translations;
     const uniqueId = store.uniqueId;
-    if (!config) {
+    if (!config.API_KEY) {
         throw new Error("i18n-keyless: config is not initialized");
     }
     const context = options?.context;
@@ -144,7 +128,7 @@ export async function getAllTranslationsFromLanguage(targetLanguage, store) {
     const config = store.config;
     const lastRefresh = store.lastRefresh;
     const uniqueId = store.uniqueId;
-    if (!config) {
+    if (!config.API_KEY) {
         console.error("i18n-keyless: No config found");
         return;
     }
@@ -177,46 +161,3 @@ export async function getAllTranslationsFromLanguage(targetLanguage, store) {
         console.error("i18n-keyless: fetch all translations error:", error);
     }
 }
-/**
- * Fetches all translations for a target language
- * @param targetLanguage - The language code to fetch translations for
- * @param store - The translation store
- * @returns Promise resolving to the translation response or void if failed
- */
-export async function getAllTranslationsForAllLanguages(store) {
-    const config = store.config;
-    const lastRefresh = store.lastRefresh;
-    const uniqueId = store.uniqueId;
-    if (!config) {
-        console.error("i18n-keyless: No config found");
-        return;
-    }
-    // if (config.languages.primary === targetLanguage) {
-    //   return;
-    // }
-    try {
-        const response = config.getAllTranslations
-            ? await config.getAllTranslations()
-            : await api
-                .fetchAllTranslationsForAllLanguages(`${config.API_URL || "https://api.i18n-keyless.com"}/translate/?last_refresh=${lastRefresh}`, {
-                method: "GET",
-                headers: {
-                    "Content-Type": "application/json",
-                    Authorization: `Bearer ${config.API_KEY}`,
-                    Version: packageJson.version,
-                    unique_id: uniqueId || "",
-                },
-            })
-                .then((res) => res);
-        if (!response.ok) {
-            throw new Error(response.error);
-        }
-        if (response.message) {
-            console.warn("i18n-keyless: ", response.message);
-        }
-        return response;
-    }
-    catch (error) {
-        console.error("i18n-keyless: fetch all translations error:", error);
-    }
-}

package/dist/types.d.ts

@@ -1,169 +1,36 @@
 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>;
-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>;
-type ClearStorageFunction = () => void | Promise<void>;
-export interface I18nConfig {
-    /**
-     * The API key for the i18n-keyless API
-     *
-     * contact @ambroselli_io on X/Twitter or by mail at arnaud.ambroselli.io@gmail.com for getting one
-     */
-    API_KEY: string;
-    /**
-     * Your own API URL for the i18n-keyless API
-     *
-     * You'll need to implement two routes on your server
-     * - GET /translate/:lang
-     * - POST /translate -- with a body of { key: string }
-     */
-    API_URL?: string;
-    /**
-     * The languages config
-     *
-     * primary: the language used by the developer
-     * supported: the languages supported for the user
-     * fallback: if the user's langauge is not supported, the fallback language will be used
-     * initWithDefault: the language to use when the app is initialized for the first time
-     */
-    languages: {
-        /**
-         * the language used by the developer
-         */
-        primary: PrimaryLang;
-        /**
-         * the languages supported for the user.
-         * For now we support:
-         * fr, nl, it, de, es, pl, pt, ro, sv, tr, ja, cn, ru, ko, ar
-         *
-         * If you need more, please reach out to @ambroselli_io on X/Twitter or by mail at arnaud.ambroselli.io@gmail.com
-         */
-        supported: Lang[];
-        /**
-         * if the user's langauge is not supported, the fallback language will be used
-         */
-        fallback?: Lang;
-        /**
-         * the language to use when the app is initialized
-         */
-        initWithDefault?: Lang;
-    };
-    /**
-     * if true, everytime a primary key is not found
-     * there will be a call to POST /translate -- with a body of { key: string }
-     * which should handle adding the key to the translations and, if needed,
-     * translate the key to all the languages supported by the user
-     *
-     * Two scenarios
-     * 1. Enable it in dev mode only: you'll may add some useless key, but you are 100% sure all the translations are up to date
-     * 2. Enable it in prod mode only: you take a risk taht the translations is not available when required for the first user demanding
-     * Best take: enable it all the time
-     */
-    addMissingTranslations?: boolean;
-    /**
-     * called right after the store is initialized, maybe to hide screensplash. or init specific default langauge for dayjs, or whatever
-     */
-    onInit?: (lang: Lang) => void;
-    /**
-     * if true, all the logs will be displayed in the console
-     */
-    debug?: boolean;
-    /**
-     * called everytime the language is set, maybe to set also the locale to dayjs or whatever
-     */
-    onSetLanguage?: (lang: Lang) => void;
-    /**
-     * 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 would need either to
-     * - use this `handleTranslate` function to handle the translation with your own API
-     * - not use this `handleTranslate` function, and use the built in API call with API_KEY filled
-     * - not use this `handleTranslate` function nor API_KEY key, and provide your own API_URL
-     */
-    handleTranslate?: (key: string) => Promise<{
-        ok: boolean;
-        message: string;
-    }>;
-    /**
-     * 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 `getAllTranslations` function to handle the translation with your own API
-     * - not use this `getAllTranslations` function, and use the built in API call with the API_KEY filled
-     * - not use this `getAllTranslations` function nor API_KEY key, and provide your own API_URL
-     */
-    getAllTranslations?: () => Promise<I18nKeylessResponse>;
+export type HandleTranslateFunction = (key: string) => Promise<{
+    ok: boolean;
+    message: string;
+}>;
+export type GetAllTranslationsFunction = () => Promise<I18nKeylessResponse>;
+export type GetAllTranslationsForAllLanguagesFunction = () => Promise<I18nKeylessAllTranslationsResponse>;
+export type LastRefresh = string | null;
+export type UniqueId = string | null;
+export type LanguagesConfig = {
     /**
-     * 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 `getAllTranslationsForAllLanguages` function to handle the translation with your own API
-     * - not use this `getAllTranslationsForAllLanguages` function, and use the built in API call with the API_KEY filled
-     * - not use this `getAllTranslationsForAllLanguages` function nor API_KEY key, and provide your own API_URL
+     * the language used by the developer
      */
-    getAllTranslationsForAllLanguages?: () => Promise<I18nKeylessAllTranslationsResponse>;
+    primary: PrimaryLang;
     /**
-     * the storage to use for the translations
+     * the languages supported for the user.
+     * For now we support:
+     * fr, nl, it, de, es, pl, pt, ro, sv, tr, ja, cn, ru, ko, ar
      *
-     * you can use react-native-mmkv, @react-native-async-storage/async-storage, or window.localStorage, or idb-keyval for IndexedDB, or any storage that has a getItem, setItem, removeItem, or get, set, and remove method
+     * If you need more, please reach out to @ambroselli_io on X/Twitter or by mail at arnaud.ambroselli.io@gmail.com
      */
-    storage: {
-        getItem?: GetStorageFunction;
-        get?: GetStorageFunction;
-        getString?: GetStorageFunction;
-        setItem?: SetStorageFunction;
-        set?: SetStorageFunction;
-        removeItem?: RemoveStorageFunction;
-        remove?: RemoveStorageFunction;
-        delete?: RemoveStorageFunction;
-        del?: RemoveStorageFunction;
-        clear?: ClearStorageFunction;
-        clearAll?: ClearStorageFunction;
-    } & {
-        getString?: GetStorageFunction;
-        get?: GetStorageFunction;
-        getItem?: GetStorageFunction;
-    } & {
-        setItem?: SetStorageFunction;
-        set?: SetStorageFunction;
-    } & {
-        removeItem?: RemoveStorageFunction;
-        remove?: RemoveStorageFunction;
-        delete?: RemoveStorageFunction;
-        del?: RemoveStorageFunction;
-    } & ({
-        clear: ClearStorageFunction;
-        clearAll?: never;
-    } | {
-        clearAll: ClearStorageFunction;
-        clear?: never;
-    });
-}
-export type NodeConfig = Omit<I18nConfig, "storage">;
-export interface TranslationStoreState {
+    supported: Lang[];
     /**
-     * the unique id of the consumer of i18n-keyless API, to help identify the usage API side
+     * if the user's langauge is not supported, the fallback language will be used
      */
-    uniqueId: string | null;
+    fallback?: Lang;
     /**
-     * the last refresh of the translations, to only fetch the new ones if any
+     * the language to use when the app is initialized
      */
-    lastRefresh: string | null;
-    /**
-     * the translations fetched from i18n-keyless' API
-     */
-    translations: Translations;
-    /**
-     * the current language of the user
-     */
-    currentLanguage: Lang;
-    /**
-     * i18n-keyless' config
-     */
-    config: I18nConfig | null;
-}
+    initWithDefault?: Lang;
+};
 export type TranslationOptions = {
     /**
      * The context of the translation.
@@ -182,28 +49,19 @@ export type TranslationOptions = {
      */
     forceTemporary?: Partial<Record<Lang, string>>;
 };
-interface TranslationStoreActions {
-    setTranslations: (translations: I18nKeylessResponse | void) => void;
-    setLanguage: (lang: Lang) => void;
-}
-export type TranslationStore = TranslationStoreState & TranslationStoreActions;
-export interface MinimalTranslationStore extends Omit<TranslationStore, "setLanguage" | "storage" | "config"> {
-    config: NodeConfig | null;
-}
-export type OmitCurrentLanguageTranslationStore = Omit<MinimalTranslationStore, "currentLanguage">;
 export interface I18nKeylessRequestBody {
     key: string;
     context?: string;
     forceTemporary?: TranslationOptions["forceTemporary"];
-    languages: I18nConfig["languages"]["supported"];
-    primaryLanguage: I18nConfig["languages"]["primary"];
+    languages: LanguagesConfig["supported"];
+    primaryLanguage: LanguagesConfig["primary"];
 }
 export interface I18nKeylessResponse {
     ok: boolean;
     data: {
         translations: Translations;
-        uniqueId: string | null;
-        lastRefresh: string | null;
+        uniqueId: UniqueId;
+        lastRefresh: LastRefresh;
     };
     error: string;
     message: string;
@@ -212,10 +70,25 @@ export interface I18nKeylessAllTranslationsResponse {
     ok: boolean;
     data: {
         translations: Record<Lang, Translations>;
-        uniqueId: string | null;
-        lastRefresh: string | null;
+        uniqueId: UniqueId;
+        lastRefresh: LastRefresh;
     };
     error: string;
     message: string;
 }
-export {};
+export type FetchTranslationParams = {
+    uniqueId: UniqueId;
+    lastRefresh: LastRefresh;
+    currentLanguage: Lang;
+    config: {
+        API_KEY: string;
+        API_URL?: string;
+        languages: LanguagesConfig;
+        addMissingTranslations?: boolean;
+        debug?: boolean;
+        handleTranslate?: HandleTranslateFunction;
+        getAllTranslations?: GetAllTranslationsFunction;
+        getAllTranslationsForAllLanguages?: GetAllTranslationsForAllLanguagesFunction;
+    };
+    translations: Translations;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "i18n-keyless-core",
   "private": false,
-  "version": "1.10.5",
+  "version": "1.10.6",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -11,7 +11,8 @@
   ],
   "scripts": {
     "prepublishOnly": "rm -rf ./dist && tsc --project tsconfig.json && npm pack",
-    "test": "echo 'no test for core'"
+    "test": "echo 'no test for core'",
+    "postpublish": "rm -rf ./dist && rm *.tgz"
   },
   "devDependencies": {
     "@types/node": "^22.5.5",