generaltranslation 2.0.0 → 2.0.2

package/dist/codes/codes.d.ts

@@ -0,0 +1,34 @@
+interface LanguageObject {
+    language: string;
+    script: string;
+    region: string;
+}
+/**
+ * Returns a language object from an array of codes or a single code.
+ * Returns null if there's no matching language.
+ * @param {string|string[]} codes - The code or array of codes.
+ * @returns {(LanguageObject|null) | (LanguageObject|null)[]} The language object(s).
+ */
+declare function _getLanguageObject(codes: string): LanguageObject | null;
+declare function _getLanguageObject(codes: string[]): (LanguageObject | null)[];
+/**
+ * Returns the language name(s) from an array of codes or a single code.
+ * @param {string|string[]} codes - The code or array of codes.
+ * @returns {string|string[]} The language name(s).
+ */
+declare const _getLanguageName: (codes: string | string[]) => string | string[];
+/**
+ * Returns the language code(s) from an array of language names or a single name.
+ * @param {string|string[]} languages - The language name or array of language names.
+ * @returns {string|string[]} The language code(s).
+ */
+declare const _getLanguageCode: (languages: string | string[]) => string | string[];
+/**
+ * Determines if all provided language codes represent the same language.
+ * Can take either an array of codes or a plain set of parameters.
+ * @param codes - The language codes, either as separate arguments or as an array.
+ * @returns {boolean} True if all codes represent the same language, false otherwise.
+ */
+declare function _isSameLanguage(...codes: string[]): boolean;
+declare function _isSameLanguage(codes: string[]): boolean;
+export { _getLanguageObject, _getLanguageName, _getLanguageCode, _isSameLanguage };

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import { _getLanguageObject, _isSameLanguage } from './codes/codes';
+/**
+ * Interface representing the constructor parameters for the GT class.
+ */
+type GTConstructorParams = {
+    apiKey?: string;
+    defaultLanguage?: string;
+    projectID?: string;
+    baseURL?: string;
+};
+/**
+ * GT is the core driver for the General Translation library.
+ */
+declare class GT {
+    apiKey: string;
+    defaultLanguage: string;
+    projectID: string;
+    baseURL: string;
+    /**
+     * Constructs an instance of the GT class.
+     *
+     * @param {GTConstructorParams} [params] - The parameters for initializing the GT instance.
+     * @param {string} [params.apiKey=''] - The API key for accessing the translation service.
+     * @param {string} [params.defaultLanguage='en'] - The default language for translations.
+     * @param {string} [params.projectID=''] - The project ID for the translation service.
+     * @param {string} [params.baseURL='https://prod.gtx.dev'] - The base URL for the translation service.
+     */
+    constructor({ apiKey, defaultLanguage, projectID, baseURL }?: GTConstructorParams);
+    /**
+    * Translates the content of React children elements.
+    *
+    * @param {Object} params - The parameters for the translation.
+    * @param {any} params.content - The React children content to be translated.
+    * @param {string} params.targetLanguage - The target language for the translation.
+    * @param {Object} params.metadata - Additional metadata for the translation process.
+    *
+    * @returns {Promise<any>} - A promise that resolves to the translated content.
+    */
+    translateReactChildren({ content, targetLanguage, ...metadata }: {
+        content: any;
+        targetLanguage: string;
+        metadata: {
+            [key: string]: any;
+        };
+    }): Promise<any>;
+}
+export default GT;
+export declare const getLanguageObject: typeof _getLanguageObject;
+export declare const getLanguageCode: (languages: string | string[]) => string | string[];
+export declare const getLanguageName: (codes: string | string[]) => string | string[];
+export declare const isSameLanguage: typeof _isSameLanguage;

package/dist/index.js

@@ -10,6 +10,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -59,7 +70,8 @@ class GT {
     * @returns {Promise<any>} - A promise that resolves to the translated content.
     */
     translateReactChildren(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ content, targetLanguage, metadata = {} }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var { content, targetLanguage } = _a, metadata = __rest(_a, ["content", "targetLanguage"]);
             return yield _translateReactChildren_1.default.call(this, content, targetLanguage, metadata);
         });
     }

package/dist/translation/_translateReactChildren.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Translates the given content into the target language using a specified API.
+ *
+ * @param {Object} this - An object containing baseURL and apiKey for the API.
+ * @param {any} content - The content to be translated. This can be of any type.
+ * @param {string} targetLanguage - The target language code (e.g., 'en', 'fr') for the translation.
+ * @param {Object} metadata - Additional metadata to be sent with the translation request.
+ *
+ * @returns {Promise<Object | null>} - A promise that resolves to the translated content as an object, or null if an error occurs.
+ *
+ * @throws {Error} - Throws an error if the response from the API is not ok (status code not in the range 200-299).
+ *
+**/
+export default function _translateReactChildren(this: {
+    baseURL: string;
+    apiKey: string;
+}, content: any, targetLanguage: string, metadata: {
+    [key: string]: any;
+}): Promise<Object | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.js",
   "scripts": {
@@ -9,7 +9,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/General-Translation/js-toolkit.git"
+    "url": "git+https://github.com/General-Translation/generaltranslation.git"
   },
   "keywords": [
     "LLM",
@@ -21,9 +21,9 @@
   "author": "General Translation, Inc.",
   "license": "ISC",
   "bugs": {
-    "url": "https://github.com/General-Translation/js-toolkit/issues"
+    "url": "https://github.com/General-Translation/generaltranslation/issues"
   },
-  "homepage": "https://github.com/General-Translation/js-toolkit#readme",
+  "homepage": "https://github.com/General-Translation/generaltranslation#readme",
   "devDependencies": {
     "@types/node": "^20.14.9",
     "typescript": "^5.5.2"