@yxw007/translate 0.0.19 → 0.1.0

package/README.md

@@ -19,11 +19,13 @@ English | [简体中文](./README_zh-CN.md)
 ## ✨ Features
 - 🌐 **Multi-environment support**: Node environment, browser environment
 - ✨ **Easy to use**: provides a concise API, you can easily help you to translate
-- 🌍 **Multi-translation engine support**: Google, Azure Translate, etc. (will expand more in the future)
+- 🌍 **Multi-translation engine support**: Google, Azure Translate, Amazon Translate, Deepl, Baidu, OpenAI, etc. (will expand more in the future)
 - 🛠️ **typescript**: friendlier code hints and quality assurance
 - 📦 **Batch translation**: one api request, translate more content, reduce http requests to improve translation efficiency
 - 🔓 **completely open source**.
 
+> **Special reminder: although the library has supported the use of the browser environment, but please only use the google engine translation (google does not need key), the use of other translation engine need to configure the key, the use of the front-end will lead to key leakage, do not do it**
+
 ## 💻Translation engines, integration cases
 
 | Name             | Support | Description                                                                                                                                               |
@@ -33,6 +35,7 @@ English | [简体中文](./README_zh-CN.md)
 | amazon translate | √       | Commissioned and ready for use                                                                                                                            |
 | baidu            | √       | Commissioned and ready for use                                                                                                                            |
 | deepl            | √       | Commissioned and ready for use                                                                                                                            |
+| openai           | √       | Commissioned and ready for use                                                                                                                            |
 | yandex           |         | I have not tuned in as I do not have a bank account supported by the platform (help from those who are in a position to do so is welcome and appreciated) |
 
 ## 🚀 Install
@@ -71,7 +74,7 @@ English | [简体中文](./README_zh-CN.md)
 
 - example
   ```typescript
-  translator.use(engines.google());
+  translator.addEngine(engines.google());
   const res1 = await translator.translate("hello", { from: "en", to: "zh" });
   console.log(res1);
 
@@ -115,7 +118,7 @@ use jsDelivr CDN
     <script>
       (async () => {
         const { engines, translator } = translate;
-        translator.use(engines.google());
+        translator.addEngine(engines.google());
         const res = await translator.translate("hello", { from: "en", to: "zh" });
         console.log(res);
       })();
@@ -137,7 +140,18 @@ class Translator {
   constructor() {
     this.engines = new Map<string, Engine>();
   }
+  /**
+   * This method is obsolete, please use the addEngine method
+   * @param engine {@link Engine}  instance
+   * @deprecated Use {@link addEngine} instead.
+   */
   use(engine: Engine) {
+    this.addEngine(engine);
+  }
+  addEngine(engine: Engine) {
+   ...
+  }
+  removeEngine(engineName: string) {
    ...
   }
   translate<T extends Engines>(text: string | string[], options: TranslateOptions<T>) {
@@ -250,6 +264,48 @@ export interface DeeplEngineOption {
 
 - Related document：https://www.deepl.com/en/your-account/keys
 
+#### OpenAIEngineOption
+
+```typescript
+export interface OpenAIEngineOption {
+  apiKey: string;
+  model: OpenAIModel;
+}
+
+export 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",
+] as const;
+
+export type OpenAIModel = (typeof OPEN_AI_MODELS)[number];
+```
+
+> Description：option param Please get it from the corresponding platform.
+
+- Related document：https://platform.openai.com/settings/organization/api-keys
+
 ## 🤝 Contribute
 
 > Special attention: Please create a new branch based on the master, develop on the new branch, and create PR to Master after development.
@@ -301,6 +357,7 @@ export interface DeeplEngineOption {
       amazon,
       baidu,
       deepl,
+      openai,
       xx
     } as const;
     ```

package/README_zh-CN.md

@@ -21,11 +21,13 @@ Translate 是一个支持多翻译引擎的翻译工具库，它提供了一套
 ## ✨ 特点
 - 🌐 **多环境支持**：Node环境、浏览器环境
 - ✨ **简单易用**：提供了简洁的API，就可以轻松帮你翻译
-- 🌍 **支持多翻译引擎**：Google、Azure Translate等（未来将拓展更多）
+- 🌍 **支持多翻译引擎**：Google、Azure Translate、Amazon Translate、Deepl、Baidu、OpenAI等（未来将拓展更多）
 - 🛠️ **typescript**: 更友好的代码提示和质量保障
 - 📦 **批量翻译**：一次api请求，翻译更多内容，减少http请求提高翻译效率
 - 🔓 **完全开源**
 
+> **特别提醒：虽然库已支持浏览器环境使用，但是请仅使用google engine翻译(google不需要key)，使用其他翻译engine 需要配置key，在前端使用会导致key泄露，千万不要这么做**
+
 ## 💻翻译引擎，集成情况
 
 | name             | 支持 | 描述                                                                       |
@@ -35,6 +37,7 @@ Translate 是一个支持多翻译引擎的翻译工具库，它提供了一套
 | amazon translate | √    | 已投产，可以正常使用                                                       |
 | baidu            | √    | 已投产，可以正常使用                                                       |
 | deepl            | √    | 已投产，可以正常使用                                                       |
+| openai           | √    | 已投产，可以正常使用                                                       |
 | yandex           |      | 由于我没有平台支持的银行账号，所以未调通（欢迎有条件的朋友帮忙调通，感谢） |
 
 
@@ -74,7 +77,7 @@ Translate 是一个支持多翻译引擎的翻译工具库，它提供了一套
 
 - example
   ```typescript
-  translator.use(engines.google());
+  translator.addEngine(engines.google());
   const res1 = await translator.translate("hello", { from: "en", to: "zh" });
   console.log(res1);
 
@@ -118,7 +121,7 @@ Translate 是一个支持多翻译引擎的翻译工具库，它提供了一套
     <script>
       (async () => {
         const { engines, translator } = translate;
-        translator.use(engines.google());
+        translator.addEngine(engines.google());
         const res = await translator.translate("hello", { from: "en", to: "zh" });
         console.log(res);
       })();
@@ -139,7 +142,18 @@ class Translator {
   constructor() {
     this.engines = new Map<string, Engine>();
   }
+  /**
+   * This method is obsolete, please use the addEngine method
+   * @param engine {@link Engine}  instance
+   * @deprecated Use {@link addEngine} instead.
+   */
   use(engine: Engine) {
+    this.addEngine(engine);
+  }
+  addEngine(engine: Engine) {
+   ...
+  }
+  removeEngine(engineName: string) {
    ...
   }
   translate<T extends Engines>(text: string | string[], options: TranslateOptions<T>) {
@@ -252,6 +266,48 @@ export interface DeeplEngineOption {
 
 - 相关文档：https://www.deepl.com/en/your-account/keys
 
+#### OpenAIEngineOption
+
+```typescript
+export interface OpenAIEngineOption {
+  apiKey: string;
+  model: OpenAIModel;
+}
+
+export 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",
+] as const;
+
+export type OpenAIModel = (typeof OPEN_AI_MODELS)[number];
+```
+
+> 说明：option param 请从对应平台获取
+
+- 相关文档：https://platform.openai.com/settings/organization/api-keys
+
 ## 🤝 贡献
 
 > 特别注意：请基于master创建一个新分支，在新分支上开发，开发完后创建PR至master
@@ -303,6 +359,7 @@ export interface DeeplEngineOption {
       amazon,
       baidu,
       deepl,
+      openai,
       xxx
     } as const;
     ```
@@ -360,9 +417,8 @@ export interface DeeplEngineOption {
       ...
       xxx: ValuesOf<typeof xxx>;
     };
-
   ```
-
+  
 - 打包
   ```bash
   pnpm build

package/dist/browser/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",
@@ -1349,12 +1375,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 {
@@ -1439,7 +1529,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;
 }
@@ -1582,7 +1672,7 @@ var azure = {
     Zulu: "zu",
 };
 
-var google = {
+var openai = {
     Abkhazian: "ab",
     Acehnese: "ace",
     "Acholi language": "ach",
@@ -2155,10 +2245,11 @@ var amazon = {
 
 const originLanguages = {
     azure: azure,
-    google: google,
+    google: openai,
     baidu: baidu,
     deepl: deepl$1,
     amazon: amazon,
+    openai: openai,
 };
 
 var deepl = {
@@ -2202,10 +2293,11 @@ var deepl = {
 
 const targetLanguages = {
     azure: azure,
-    google: google,
+    google: openai,
     baidu: baidu,
     deepl: deepl,
     amazon: amazon,
+    openai: openai,
 };
 
 function normalFromLanguage(from, engine) {
@@ -2259,13 +2351,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;
@@ -2317,6 +2424,7 @@ var index = {
 };
 
 exports.Cache = Cache;
+exports.OPEN_AI_MODELS = OPEN_AI_MODELS;
 exports.TranslationError = TranslationError;
 exports.Translator = Translator;
 exports.default = index;