@yxw007/translate 0.0.19 → 0.1.0

package/dist/index.d.ts

@@ -23,12 +23,21 @@ interface BaiduEngineOption extends BaseEngineOption {
 }
 declare function baidu(options: BaiduEngineOption): Engine;
 
+interface DeeplEngineOption {
+    key: string;
+}
+declare function deepl(options: DeeplEngineOption): {
+    name: string;
+    translate<T extends Engines>(text: string | string[], opts: EngineTranslateOptions<T>): Promise<string[]>;
+};
+
 declare const engines: {
     readonly google: typeof google;
     readonly azure: typeof azure;
     readonly amazon: typeof amazon;
     readonly baidu: typeof baidu;
     readonly deepl: typeof deepl;
+    readonly openai: typeof openai;
 };
 
 declare const _default$6: {
@@ -748,6 +757,7 @@ type originLanguageMapNames = {
     google: keyof typeof _default$5;
     baidu: keyof typeof _default$4;
     deepl: keyof typeof _default$3;
+    openai: keyof typeof _default$5;
 };
 type originLanguageMapValues = {
     amazon: ValuesOf<typeof _default$2>;
@@ -755,6 +765,7 @@ type originLanguageMapValues = {
     google: ValuesOf<typeof _default$5>;
     baidu: ValuesOf<typeof _default$4>;
     deepl: ValuesOf<typeof _default$3>;
+    openai: ValuesOf<typeof _default$5>;
 };
 
 declare const _default$1: {
@@ -817,6 +828,7 @@ type targetLanguageMapNames = {
     google: keyof typeof _default$5;
     baidu: keyof typeof _default$4;
     deepl: keyof typeof _default$1;
+    openai: keyof typeof _default$5;
 };
 type targetLanguageMapValues = {
     amazon: ValuesOf<typeof _default$2>;
@@ -824,6 +836,7 @@ type targetLanguageMapValues = {
     google: ValuesOf<typeof _default$5>;
     baidu: ValuesOf<typeof _default$4>;
     deepl: ValuesOf<typeof _default$1>;
+    openai: ValuesOf<typeof _default$5>;
 };
 
 type KeysOfTarget<T extends keyof targetLanguageMapNames> = targetLanguageMapNames[T];
@@ -2267,19 +2280,27 @@ declare class TranslationError extends Error {
     constructor(region: string, message: string);
 }
 
-interface DeeplEngineOption {
-    key: string;
+declare const OPEN_AI_MODELS: readonly ["o1-preview", "o1-preview-2024-09-12", "o1-mini-2024-09-12", "o1-mini", "dall-e-2", "gpt-3.5-turbo", "gpt-3.5-turbo-0125", "babbage-002", "davinci-002", "dall-e-3", "text-embedding-3-large", "gpt-3.5-turbo-16k", "tts-1-hd-1106", "text-embedding-ada-002", "text-embedding-3-small", "tts-1-hd", "whisper-1", "gpt-3.5-turbo-1106", "gpt-3.5-turbo-instruct", "gpt-4o-mini-2024-07-18", "gpt-4o-mini", "tts-1", "tts-1-1106", "gpt-3.5-turbo-instruct-0914"];
+type OpenAIModel = (typeof OPEN_AI_MODELS)[number];
+
+interface OpenAIEngineOption extends BaseEngineOption {
+    apiKey: string;
+    model: OpenAIModel;
 }
-declare function deepl(options: DeeplEngineOption): {
-    name: string;
-    translate<T extends Engines>(text: string | string[], opts: EngineTranslateOptions<T>): Promise<string[]>;
-};
+declare function openai(options: OpenAIEngineOption): Engine;
 
 declare class Translator {
     private engines;
     private cache_time;
     constructor(cache_time?: number);
+    /**
+     * This method is obsolete, please use the addEngine method
+     * @param engine {@link Engine}  instance
+     * @deprecated Use {@link addEngine} instead.
+     */
     use(engine: Engine): void;
+    addEngine(engine: Engine): void;
+    removeEngine(engineName: string): false | undefined;
     translate<T extends Engines>(text: string | string[], options: TranslateOptions<T>): Promise<string[]>;
 }
 declare const translator: Translator;
@@ -2290,6 +2311,7 @@ declare const _default: {
         readonly amazon: typeof amazon;
         readonly baidu: typeof baidu;
         readonly deepl: typeof deepl;
+        readonly openai: typeof openai;
     };
     translator: Translator;
     Translator: typeof Translator;
@@ -2297,5 +2319,5 @@ declare const _default: {
     getLanguage: typeof getLanguage;
 };
 
-export { type BaseEngineOption, Cache, type CacheRecord, type Engine, type EngineTranslateOptions, type Engines, type FromLanguage, type ToLanguage, type TranslateOptions, TranslationError, Translator, type ValuesOf, _default as default, engines, getLanguage, translator };
+export { type BaseEngineOption, Cache, type CacheRecord, type Engine, type EngineTranslateOptions, type Engines, type FromLanguage, OPEN_AI_MODELS, type OpenAIModel, type ToLanguage, type TranslateOptions, TranslationError, Translator, type ValuesOf, _default as default, engines, getLanguage, translator };
 //# sourceMappingURL=index.d.ts.map

package/dist/node/index.cjs

@@ -1,4 +1,4 @@
-// translate v0.0.19 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
+// translate v0.1.0 Copyright (c) 2024 Potter<aa4790139@gmail.com> and contributors
 'use strict';
 
 Object.defineProperty(exports, '__esModule', { value: true });
@@ -13,8 +13,34 @@ class TranslationError extends Error {
         Error.captureStackTrace(this, this.constructor);
     }
 }
-
-function google$1(options) {
+const OPEN_AI_MODELS = [
+    "o1-preview",
+    "o1-preview-2024-09-12",
+    "o1-mini-2024-09-12",
+    "o1-mini",
+    "dall-e-2",
+    "gpt-3.5-turbo",
+    "gpt-3.5-turbo-0125",
+    "babbage-002",
+    "davinci-002",
+    "dall-e-3",
+    "text-embedding-3-large",
+    "gpt-3.5-turbo-16k",
+    "tts-1-hd-1106",
+    "text-embedding-ada-002",
+    "text-embedding-3-small",
+    "tts-1-hd",
+    "whisper-1",
+    "gpt-3.5-turbo-1106",
+    "gpt-3.5-turbo-instruct",
+    "gpt-4o-mini-2024-07-18",
+    "gpt-4o-mini",
+    "tts-1",
+    "tts-1-1106",
+    "gpt-3.5-turbo-instruct-0914",
+];
+
+function google(options) {
     const base = "https://translate.googleapis.com/translate_a/single";
     return {
         name: "google",
@@ -1315,12 +1341,76 @@ function deepl$2(options) {
     };
 }
 
+function openai$1(options) {
+    const { apiKey, model } = options;
+    const name = "openai";
+    const checkOptions = () => {
+        if (!apiKey) {
+            throw new TranslationError(name, `${name} apiKey is required`);
+        }
+        if (!OPEN_AI_MODELS.includes(model)) {
+            throw new TranslationError(name, `${name} model=${model} is invalid`);
+        }
+    };
+    checkOptions();
+    const base = "https://api.openai.com/v1/chat/completions";
+    return {
+        name,
+        async translate(text, opts) {
+            checkOptions();
+            const { from, to } = opts;
+            const url = `${base}`;
+            if (!Array.isArray(text)) {
+                text = [text];
+            }
+            const prompt = {
+                role: "user",
+                content: `Translate the following texts from ${from} to ${to}: 
+          -$s$-
+          ${text.join("\n")} 
+          -$e$-
+          Translated content is between the start marker -$s$- and the end marker -$e$-, do not return the start and end markers, only the translated text is returned.
+          Connect multiple text with newline character, keep the original order when return. 
+          `,
+            };
+            console.log("prompt:", prompt.content);
+            const res = await fetch(url, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${apiKey}`,
+                },
+                body: JSON.stringify({
+                    model,
+                    messages: [{ role: "system", content: "You are a professional IT translator" }, prompt],
+                    max_tokens: 2000,
+                }),
+            });
+            const bodyRes = await res.json();
+            if (bodyRes.error) {
+                throw new TranslationError(this.name, `Translate fail! message: ${bodyRes.error.message}`);
+            }
+            if (!bodyRes || !bodyRes.choices || bodyRes.choices.length === 0 || !bodyRes.choices[0]?.message?.content) {
+                throw new TranslationError(this.name, "Translate fail ! translate's result is null or empty");
+            }
+            const content = bodyRes.choices[0].message.content;
+            const translations = content
+                .trim()
+                .split("\n")
+                .map((item) => item.trim());
+            console.log("translations:", translations);
+            return translations;
+        },
+    };
+}
+
 const engines = {
-    google: google$1,
+    google,
     azure: azure$1,
     amazon: amazon$1,
     baidu: baidu$1,
     deepl: deepl$2,
+    openai: openai$1,
 };
 
 class Cache {
@@ -1405,7 +1495,7 @@ function getGapLine() {
 }
 function getErrorMessages(e, prefix = "Translate fail ! ") {
     if (e instanceof TypeError) {
-        return prefix + (e.cause.message ?? e.message);
+        return prefix + (e.cause?.message ?? e.message);
     }
     return prefix + e.message;
 }
@@ -1548,7 +1638,7 @@ var azure = {
     Zulu: "zu",
 };
 
-var google = {
+var openai = {
     Abkhazian: "ab",
     Acehnese: "ace",
     "Acholi language": "ach",
@@ -2121,10 +2211,11 @@ var amazon = {
 
 const originLanguages = {
     azure: azure,
-    google: google,
+    google: openai,
     baidu: baidu,
     deepl: deepl$1,
     amazon: amazon,
+    openai: openai,
 };
 
 var deepl = {
@@ -2168,10 +2259,11 @@ var deepl = {
 
 const targetLanguages = {
     azure: azure,
-    google: google,
+    google: openai,
     baidu: baidu,
     deepl: deepl,
     amazon: amazon,
+    openai: openai,
 };
 
 function normalFromLanguage(from, engine) {
@@ -2225,13 +2317,28 @@ class Translator {
         this.engines = new Map();
         this.cache_time = cache_time;
     }
+    /**
+     * This method is obsolete, please use the addEngine method
+     * @param engine {@link Engine}  instance
+     * @deprecated Use {@link addEngine} instead.
+     */
     use(engine) {
+        this.addEngine(engine);
+    }
+    addEngine(engine) {
         if (this.engines.has(engine.name)) {
             logger.warn("Engine already exists");
             return;
         }
         this.engines.set(engine.name, engine);
     }
+    removeEngine(engineName) {
+        if (!engineName || !this.engines.has(engineName)) {
+            logger.warn("Engine name is required or not found");
+            return false;
+        }
+        this.engines.delete(engineName);
+    }
     async translate(text, options) {
         const { engine = "google", cache_time = 60 * 1000 } = options;
         let { from = "auto", to } = options;
@@ -2283,6 +2390,7 @@ var index = {
 };
 
 exports.Cache = Cache;
+exports.OPEN_AI_MODELS = OPEN_AI_MODELS;
 exports.TranslationError = TranslationError;
 exports.Translator = Translator;
 exports.default = index;