generaltranslation 2.0.4 → 2.0.5

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { _getLanguageObject, _isSameLanguage } from './codes/codes';
+import { Content } from './translation/_translate';
 /**
  * Interface representing the constructor parameters for the GT class.
  */
@@ -26,6 +27,16 @@ declare class GT {
      * @param {string} [params.baseURL='https://prod.gtx.dev'] - The base URL for the translation service.
      */
     constructor({ apiKey, defaultLanguage, projectID, baseURL }?: GTConstructorParams);
+    translate({ content, targetLanguage, metadata }: {
+        content: Content;
+        targetLanguage: string;
+        metadata: {
+            [key: string]: any;
+        };
+    }): Promise<{
+        translation: string;
+        error?: Error | unknown;
+    }>;
     /**
     * Translates the content of React children elements.
     *
@@ -42,7 +53,10 @@ declare class GT {
         metadata: {
             [key: string]: any;
         };
-    }): Promise<any>;
+    }): Promise<{
+        translation: any | null;
+        error?: Error | unknown;
+    }>;
 }
 export default GT;
 export declare const getLanguageObject: typeof _getLanguageObject;

package/dist/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isSameLanguage = exports.getLanguageName = exports.getLanguageCode = exports.getLanguageObject = void 0;
 // ----- IMPORTS ----- //
 const codes_1 = require("./codes/codes");
+const _translate_1 = __importDefault(require("./translation/_translate"));
 const _translateReactChildren_1 = __importDefault(require("./translation/_translateReactChildren"));
 // TO DO
 // - Translation API
@@ -48,6 +49,11 @@ class GT {
         this.defaultLanguage = defaultLanguage.toLowerCase();
         this.baseURL = baseURL;
     }
+    translate(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ content, targetLanguage, metadata }) {
+            return yield (0, _translate_1.default)(this, content, targetLanguage, Object.assign({ projectID: this.projectID, defaultLanguage: this.defaultLanguage }, metadata));
+        });
+    }
     /**
     * Translates the content of React children elements.
     *
@@ -60,7 +66,7 @@ class GT {
     */
     translateReactChildren(_a) {
         return __awaiter(this, arguments, void 0, function* ({ content, targetLanguage, metadata }) {
-            return yield _translateReactChildren_1.default.call(this, content, targetLanguage, Object.assign({ projectID: this.projectID, defaultLanguage: this.defaultLanguage }, metadata));
+            return yield (0, _translateReactChildren_1.default)(this, content, targetLanguage, Object.assign({ projectID: this.projectID, defaultLanguage: this.defaultLanguage }, metadata));
         });
     }
 }

package/dist/translation/_translate.d.ts

@@ -0,0 +1,18 @@
+type ContentObject = {
+    text: string;
+    exclude?: boolean;
+    cache?: boolean;
+    label?: string;
+};
+type ContentItem = string | ContentObject;
+export type Content = ContentItem | ContentItem[];
+export default function _translate(gt: {
+    baseURL: string;
+    apiKey: string;
+}, content: Content, targetLanguage: string, metadata: {
+    [key: string]: any;
+}): Promise<{
+    translation: string;
+    error?: Error | unknown;
+}>;
+export {};

package/dist/translation/_translate.js

@@ -0,0 +1,89 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = _translate;
+// also handles errors
+const _combine = (contentArray, redactedArray) => {
+    let result = '';
+    const _handleItem = (contentItem) => {
+        if (typeof contentItem === 'string')
+            result += contentItem;
+        else if ((contentItem === null || contentItem === void 0 ? void 0 : contentItem.text) && typeof contentItem.text === 'string')
+            result += contentItem.text;
+        else if ((contentItem === null || contentItem === void 0 ? void 0 : contentItem.exclude) && redactedArray && redactedArray.length > 0) {
+            const redactedItem = redactedArray.shift();
+            if (redactedItem && (redactedItem === null || redactedItem === void 0 ? void 0 : redactedItem.text)) {
+                result += redactedItem.text;
+            }
+        }
+    };
+    contentArray.forEach(item => _handleItem(item));
+    return result;
+};
+const _redact = (content) => {
+    let contentArray = [];
+    let redactedArray = [];
+    const _handleItem = (contentItem) => {
+        if (typeof contentItem === 'string')
+            contentArray.push({
+                text: contentItem
+            });
+        else {
+            if (contentItem.exclude) {
+                contentArray.push(Object.assign(Object.assign({}, contentItem), { text: '', exclude: true }));
+                redactedArray.push(Object.assign({}, contentItem));
+            }
+            else {
+                contentArray.push(contentItem);
+            }
+        }
+    };
+    if (Array.isArray(content))
+        content.forEach(item => _handleItem(item));
+    else
+        _handleItem(content);
+    return {
+        contentArray, redactedArray
+    };
+};
+function _translate(gt, content, targetLanguage, metadata) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { contentArray, redactedArray } = _redact(content);
+        try {
+            const response = yield fetch(`${gt.baseURL}/text`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    'gtx-api-key': gt.apiKey,
+                },
+                body: JSON.stringify({
+                    content: content,
+                    targetLanguage: targetLanguage,
+                    metadata: metadata
+                })
+            });
+            if (!response.ok) {
+                throw new Error(`${response.status}: ${yield response.text()}`);
+            }
+            const resultArray = yield response.json();
+            return {
+                translation: _combine(resultArray, redactedArray)
+            };
+        }
+        catch (error) {
+            console.error(error);
+            return {
+                translation: _combine(contentArray, redactedArray),
+                error: error
+            };
+        }
+    });
+}

package/dist/translation/_translateReactChildren.d.ts

@@ -1,19 +1,22 @@
 /**
  * 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 {Object} gt - An object containing baseURL and apiKey for the API.
+ * @param {JSON} 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<JSON | null>} - A promise that resolves to the translated content as an object, or null if an error occurs.
+ * @returns {Promise<any | 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: {
+export default function translateReactChildren(gt: {
     baseURL: string;
     apiKey: string;
 }, content: any, targetLanguage: string, metadata: {
     [key: string]: any;
-}): Promise<JSON | null>;
+}): Promise<{
+    translation: any | null;
+    error?: Error | unknown;
+}>;

package/dist/translation/_translateReactChildren.js

@@ -9,28 +9,28 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = _translateReactChildren;
+exports.default = translateReactChildren;
 /**
  * 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 {Object} gt - An object containing baseURL and apiKey for the API.
+ * @param {JSON} 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<JSON | null>} - A promise that resolves to the translated content as an object, or null if an error occurs.
+ * @returns {Promise<any | 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).
  *
 **/
-function _translateReactChildren(content, targetLanguage, metadata) {
+function translateReactChildren(gt, content, targetLanguage, metadata) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const response = yield fetch(`${this.baseURL}`, {
+            const response = yield fetch(`${gt.baseURL}/react`, {
                 method: 'POST',
                 headers: {
                     'Content-Type': 'application/json',
-                    'gtx-api-key': this.apiKey,
+                    'gtx-api-key': gt.apiKey,
                 },
                 body: JSON.stringify({
                     content: content,
@@ -45,7 +45,10 @@ function _translateReactChildren(content, targetLanguage, metadata) {
         }
         catch (error) {
             console.error(error);
-            return null;
+            return {
+                translation: null,
+                error: error
+            };
         }
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "2.0.4",
+  "version": "2.0.5",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.js",
   "scripts": {