@yxw007/translate 0.5.0 → 1.0.0

package/dist/package.json

@@ -1,122 +1,113 @@
-{
-  "name": "@yxw007/translate",
-  "version": "0.5.0",
-  "description": "A simple library that supports multiple translation engines",
-  "author": "Potter<aa4790139@gmail.com>",
-  "homepage": "https://github.com/yxw007/translate",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/yxw007/translate.git"
-  },
-  "bugs": {
-    "url": "https://github.com/yxw007/translate/issues"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "lint": "eslint . && prettier -c src",
-    "lint:fix": "eslint . --fix && prettier -w src",
-    "build": "pnpm clean && tsx script/build.ts",
-    "build:dev": "pnpm clean && tsx script/build.ts --dev",
-    "clean": "rm -rf dist",
-    "test": "vitest --run",
-    "test:coverage": "vitest --coverage --run",
-    "release": "pnpm changelogen --release -i",
-    "prepare": "husky"
-  },
-  "type": "module",
-  "main": "./dist/node/index.cjs",
-  "module": "./dist/node/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "browser": {
-        "require": "./dist/browser/index.cjs",
-        "default": "./dist/browser/index.esm.js",
-        "types": "./dist/index.d.ts"
-      },
-      "default": {
-        "require": "./dist/node/index.cjs",
-        "default": "./dist/node/index.js",
-        "types": "./dist/index.d.ts"
-      }
-    }
-  },
-  "files": [
-    "dist",
-    "README_zh-CN.md",
-    "README.md",
-    "package.json"
-  ],
-  "keywords": [
-    "typescript",
-    "node",
-    "browser",
-    "translate",
-    "translation",
-    "google",
-    "i18n",
-    "l10n",
-    "localization",
-    "internationalization",
-    "azure",
-    "amazon",
-    "baidu",
-    "yandex",
-    "ai",
-    "deepl",
-    "tencent"
-  ],
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
-  "lint-staged": {
-    "**/*.{ts}": [
-      "pnpm lint:fix"
-    ]
-  },
-  "license": "MIT",
-  "devDependencies": {
-    "@commitlint/config-conventional": "^19.2.2",
-    "@eslint/js": "^8.57.0",
-    "@rollup/plugin-alias": "^5.1.0",
-    "@rollup/plugin-commonjs": "^26.0.1",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@types/crypto-js": "^4.2.2",
-    "@types/eslint__js": "^8.42.3",
-    "@types/node": "^22.5.0",
-    "@vitest/coverage-v8": "^2.0.5",
-    "chalk": "^5.3.0",
-    "changelogen": "^0.5.5",
-    "commitlint": "^19.4.0",
-    "dotenv": "^16.4.5",
-    "eslint": "^8.57.0",
-    "globals": "^15.9.0",
-    "husky": "^9.1.5",
-    "lint-staged": "^15.2.9",
-    "maxmin": "^4.1.0",
-    "prettier": "^3.3.3",
-    "rollup": "^4.21.1",
-    "rollup-plugin-dts": "^6.1.1",
-    "tslib": "^2.7.0",
-    "tsx": "^4.19.2",
-    "typescript": "^5.5.4",
-    "typescript-eslint": "^8.3.0",
-    "vitest": "^2.0.5",
-    "yargs": "^18.0.0"
-  },
-  "volta": {
-    "node": "22.3.0"
-  },
-  "peerDependencies": {
-    "@aws-sdk/client-translate": "^3.637.0",
-    "@smithy/smithy-client": "^3.2.0",
-    "crypto-js": "^4.2.0"
-  }
-}
+{
+  "name": "@yxw007/translate",
+  "version": "1.0.0",
+  "description": "A simple library that supports multiple translation engines",
+  "author": "Potter<aa4790139@gmail.com>",
+  "homepage": "https://github.com/yxw007/translate",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yxw007/translate.git"
+  },
+  "bugs": {
+    "url": "https://github.com/yxw007/translate/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "oxlint . && oxfmt --check .",
+    "lint:fix": "oxlint . --fix && oxfmt .",
+    "format": "oxfmt .",
+    "format:check": "oxfmt --check .",
+    "build": "pnpm clean && tsx script/build.ts",
+    "build:dev": "pnpm clean && tsx script/build.ts --dev",
+    "clean": "rm -rf dist",
+    "test": "vitest --run",
+    "test:coverage": "vitest --coverage --run",
+    "release": "pnpm changelogen --release -i",
+    "prepare": "husky"
+  },
+  "type": "module",
+  "main": "./dist/node/index.cjs",
+  "module": "./dist/node/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": {
+        "require": "./dist/browser/index.cjs",
+        "default": "./dist/browser/index.esm.js",
+        "types": "./dist/index.d.ts"
+      },
+      "default": {
+        "require": "./dist/node/index.cjs",
+        "default": "./dist/node/index.js",
+        "types": "./dist/index.d.ts"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README_zh-CN.md",
+    "README.md",
+    "package.json"
+  ],
+  "keywords": [
+    "typescript",
+    "node",
+    "browser",
+    "translate",
+    "translation",
+    "google",
+    "i18n",
+    "l10n",
+    "localization",
+    "internationalization",
+    "azure",
+    "amazon",
+    "baidu",
+    "yandex",
+    "ai",
+    "deepl",
+    "tencent"
+  ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "**/*.{ts}": [
+      "pnpm lint:fix"
+    ]
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.2.2",
+    "@types/crypto-js": "^4.2.2",
+    "@types/node": "^22.5.0",
+    "@vitest/coverage-v8": "^4.1.2",
+    "chalk": "^5.3.0",
+    "changelogen": "^0.6.2",
+    "commitlint": "^19.4.0",
+    "dotenv": "^16.4.5",
+    "husky": "^9.1.5",
+    "lint-staged": "^16.4.0",
+    "maxmin": "^4.1.0",
+    "oxfmt": "^0.42.0",
+    "oxlint": "^1.57.0",
+    "rolldown": "1.0.0-rc.12",
+    "tslib": "^2.7.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.5.4",
+    "vite": "^8.0.3",
+    "vitest": "^4.1.2"
+  },
+  "volta": {
+    "node": "22.3.0"
+  },
+  "peerDependencies": {
+    "@aws-sdk/client-translate": "^3.637.0",
+    "@smithy/smithy-client": "^3.2.0",
+    "crypto-js": "^4.2.0"
+  }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,56 @@
+import type { BuiltinEngineLanguageMap, BuiltinFromLanguageMap, BuiltinToLanguageMap } from "../language/engines";
+export * from "./typescript";
+export type Engines = keyof BuiltinEngineLanguageMap;
+export type LanguageMap = Readonly<Record<string, string>>;
+export type LanguageName<T extends LanguageMap = LanguageMap> = Extract<keyof T, string>;
+export type LanguageCode<T extends LanguageMap = LanguageMap> = T[LanguageName<T>];
+export type FromLanguage<T extends string = Engines> = T extends Engines ? BuiltinFromLanguageMap[T] : string;
+export type ToLanguage<T extends string = Engines> = T extends Engines ? BuiltinToLanguageMap[T] : string;
+export type TranslateOptions<T extends string = Engines> = {
+    from?: FromLanguage<T>;
+    to: ToLanguage<T>;
+    engine?: T;
+    /**
+     * Cache time in milliseconds
+     */
+    cache_time?: number | undefined;
+    /**
+     * Domain to use for translation
+     */
+    domain?: string | undefined;
+    /**
+     * Maximum number of characters
+     * default: 1000, -1 means no limit
+     */
+    max_character_num?: number | undefined;
+};
+export type CheckLanguageOptions<T extends string = Engines> = Pick<TranslateOptions<T>, "max_character_num" | "engine">;
+export interface BaseEngineOption {
+    fromLanguages?: LanguageMap;
+    toLanguages?: LanguageMap;
+}
+export type EngineTranslateOptions<T extends string = string> = Omit<TranslateOptions<T>, "engine">;
+export type Engine = {
+    name: string;
+    getFromLanguages: () => LanguageMap;
+    getToLanguages: () => LanguageMap;
+    normalFromLanguage: (language?: string) => string;
+    normalToLanguage: (language?: string) => string;
+    checkLanguage?: (text: string) => Promise<string>;
+    translate: (text: string | string[], opts: EngineTranslateOptions) => Promise<string[]>;
+};
+export interface CacheRecord {
+    value: unknown;
+    timeout?: number;
+    expire: number;
+}
+export declare class TranslationError extends Error {
+    region: string;
+    constructor(region: string, message: string);
+}
+export declare class CheckLanguageError extends Error {
+    region: string;
+    constructor(region: string, message: string);
+}
+export 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"];
+export type OpenAIModel = (typeof OPEN_AI_MODELS)[number];

package/dist/types/typescript.d.ts

@@ -0,0 +1 @@
+export type ValuesOf<T> = T[keyof T];

package/dist/utils/cache.d.ts

@@ -0,0 +1,15 @@
+import { CacheRecord } from "../types";
+export declare class Cache {
+    private cache;
+    constructor();
+    /**
+     * @param key
+     * @param value
+     * @param time millisecond
+     */
+    set(key: string, value: any, time: number): void;
+    get(key: string): CacheRecord | undefined;
+    delete(key: string): boolean;
+    private del;
+    clear(): void;
+}

package/dist/utils/check.d.ts

@@ -0,0 +1,2 @@
+export declare function isString(val: any): val is string;
+export declare function isFunction(val: any): boolean;

package/dist/utils/constant.d.ts

@@ -0,0 +1,2 @@
+export declare const appName: string;
+export declare const defaultMaxCharacterNum = 1000;

package/dist/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./cache";
+export * from "./logger";
+export * from "./path";
+export * from "./check";
+export * from "../types/typescript";
+export * from "./utils";

package/dist/utils/logger.d.ts

@@ -0,0 +1,6 @@
+export declare function useLogger(name?: string): {
+    log(...args: any): void;
+    info(...args: any): void;
+    error(...args: any): void;
+    warn(...args: any): void;
+};

package/dist/utils/node.d.ts

@@ -0,0 +1,2 @@
+export declare function cleanDir(dir: string): Promise<void>;
+export declare function copyDir(src: string, dest: string): Promise<void>;

package/dist/utils/path.d.ts

@@ -0,0 +1 @@
+export declare function normalizedPath(filePath: string): string;

package/dist/utils/utils.d.ts

@@ -0,0 +1,7 @@
+import { TranslationError } from "..";
+export declare function sleep(ms: number): Promise<unknown>;
+export declare function getGapLine(): string;
+export declare function getErrorMessages<T extends Error>(e: T, prefix?: string): string;
+export declare function throwResponseError(name: string, res: any): Promise<TranslationError>;
+export declare function splitText(text: string, maxCharacterNum: number): string[];
+export declare function isOverMaxCharacterNum(text: string[] | undefined | null, max_character_num: number): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yxw007/translate",
-  "version": "0.5.0",
+  "version": "1.0.0",
   "description": "A simple library that supports multiple translation engines",
   "author": "Potter<aa4790139@gmail.com>",
   "homepage": "https://github.com/yxw007/translate",
@@ -70,35 +70,24 @@
   "license": "MIT",
   "devDependencies": {
     "@commitlint/config-conventional": "^19.2.2",
-    "@eslint/js": "^8.57.0",
-    "@rollup/plugin-alias": "^5.1.0",
-    "@rollup/plugin-commonjs": "^26.0.1",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.6",
     "@types/crypto-js": "^4.2.2",
-    "@types/eslint__js": "^8.42.3",
     "@types/node": "^22.5.0",
-    "@vitest/coverage-v8": "^2.0.5",
+    "@vitest/coverage-v8": "^4.1.2",
     "chalk": "^5.3.0",
-    "changelogen": "^0.5.5",
+    "changelogen": "^0.6.2",
     "commitlint": "^19.4.0",
     "dotenv": "^16.4.5",
-    "eslint": "^8.57.0",
-    "globals": "^15.9.0",
     "husky": "^9.1.5",
-    "lint-staged": "^15.2.9",
+    "lint-staged": "^16.4.0",
     "maxmin": "^4.1.0",
-    "prettier": "^3.3.3",
-    "rollup": "^4.21.1",
-    "rollup-plugin-dts": "^6.1.1",
+    "oxfmt": "^0.42.0",
+    "oxlint": "^1.57.0",
+    "rolldown": "1.0.0-rc.12",
     "tslib": "^2.7.0",
-    "tsx": "^4.19.2",
+    "tsx": "^4.21.0",
     "typescript": "^5.5.4",
-    "typescript-eslint": "^8.3.0",
-    "vitest": "^2.0.5",
-    "yargs": "^18.0.0"
+    "vite": "^8.0.3",
+    "vitest": "^4.1.2"
   },
   "volta": {
     "node": "22.3.0"
@@ -109,8 +98,10 @@
     "crypto-js": "^4.2.0"
   },
   "scripts": {
-    "lint": "eslint . && prettier -c src",
-    "lint:fix": "eslint . --fix && prettier -w src",
+    "lint": "oxlint . && oxfmt --check .",
+    "lint:fix": "oxlint . --fix && oxfmt .",
+    "format": "oxfmt .",
+    "format:check": "oxfmt --check .",
     "build": "pnpm clean && tsx script/build.ts",
     "build:dev": "pnpm clean && tsx script/build.ts --dev",
     "clean": "rm -rf dist",