generaltranslation 2.0.9 → 2.0.11

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { _getLanguageObject, _isSameLanguage } from './codes/codes';
-import { Content } from './translation/_translate';
 /**
  * Type representing the constructor parameters for the GT class.
  */
@@ -28,27 +27,30 @@ declare class GT {
      */
     constructor({ apiKey, defaultLanguage, projectID, baseURL }?: GTConstructorParams);
     /**
-    * Translates a string, caching it for re-use.
-    * @param {Content} content - The content to translate.
+    * Translates a string into a target language.
+    * @param {string} content - A string to translate.
     * @param {string} targetLanguage - The target language for the translation.
-    * @param {{ [key: string]: any }} metadata - Additional metadata for the translation request.
+    * @param {{ notes?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
     * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
     */
-    translate(content: Content, targetLanguage: string, metadata?: {
+    translate(content: string, targetLanguage: string, metadata?: {
+        notes?: string;
         [key: string]: any;
     }): Promise<{
         translation: string;
         error?: Error | unknown;
     }>;
     /**
-    * Translates a single piece of content and caches for use in a public project.
-    * @param {Content} content - The content to translate.
+    * Translates a string and caches for use in a public project.
+    * @param {string} content - A string to translate.
     * @param {string} targetLanguage - The target language for the translation.
-    * @param {string} projectID - The ID of the project
-    * @param {{ [key: string]: any }} metadata - Additional metadata for the translation request.
+    * @param {string} projectID - The ID of the project.
+    * @param {{ page?: string, notes?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
     * @returns {Promise<{ translation: string, error?: Error | unknown }>} The translated content with optional error information.
     */
-    intl(content: Content, targetLanguage: string, projectID?: string, metadata?: {
+    intl(content: string, targetLanguage: string, projectID?: string, metadata?: {
+        page?: string;
+        notes?: string;
         [key: string]: any;
     }): Promise<{
         translation: string;

package/dist/index.js

@@ -51,10 +51,10 @@ class GT {
         this.baseURL = baseURL;
     }
     /**
-    * Translates a string, caching it for re-use.
-    * @param {Content} content - The content to translate.
+    * Translates a string into a target language.
+    * @param {string} content - A string to translate.
     * @param {string} targetLanguage - The target language for the translation.
-    * @param {{ [key: string]: any }} metadata - Additional metadata for the translation request.
+    * @param {{ notes?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
     * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
     */
     translate(content, targetLanguage, metadata) {
@@ -63,11 +63,11 @@ class GT {
         });
     }
     /**
-    * Translates a single piece of content and caches for use in a public project.
-    * @param {Content} content - The content to translate.
+    * Translates a string and caches for use in a public project.
+    * @param {string} content - A string to translate.
     * @param {string} targetLanguage - The target language for the translation.
-    * @param {string} projectID - The ID of the project
-    * @param {{ [key: string]: any }} metadata - Additional metadata for the translation request.
+    * @param {string} projectID - The ID of the project.
+    * @param {{ page?: string, notes?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
     * @returns {Promise<{ translation: string, error?: Error | unknown }>} The translated content with optional error information.
     */
     intl(content, targetLanguage, projectID, metadata) {

package/dist/translation/_bundleRequests.js

@@ -10,55 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = _bundleRequests;
-const _translate_1 = require("./_translate");
-/**
- * Preprocesses the request based on its type.
- * For 'intl' and 'translate' types, it processes the content and extracts arrays for further use.
- * @param request - The request to be processed.
- * @returns An object containing the processed request and any additional data.
- */
-const _preprocess = (request) => {
-    const { type, data } = request;
-    let processedData = data;
-    let additional = {};
-    if (type === 'intl' || type === 'translate') {
-        const { array, excludedArray } = (0, _translate_1._process)(data.content);
-        processedData.content = array;
-        additional.excludedArray = excludedArray;
-        additional.type = type;
-    }
-    if (Object.keys(additional).length > 0) {
-        return {
-            processed: {
-                type: type,
-                data: processedData
-            },
-            additional: additional
-        };
-    }
-    return { processed: { type: type, data: processedData } };
-};
-/**
- * Postprocesses the result based on additional data.
- * If the type is 'translate' or 'intl', it recombines the excluded array with the translation.
- * If there is an error, it attaches the error to the result.
- * @param result - The result to be postprocessed.
- * @param additional - Additional data from preprocessing.
- * @returns The postprocessed result.
- */
-const _postprocess = (result, additional) => {
-    if ((additional === null || additional === void 0 ? void 0 : additional.type) === "translate" || (additional === null || additional === void 0 ? void 0 : additional.type) === "intl") {
-        if (additional === null || additional === void 0 ? void 0 : additional.excludedArray) {
-            result.translation = (0, _translate_1._recombine)(result.translation, additional.excludedArray);
-        }
-    }
-    if (additional === null || additional === void 0 ? void 0 : additional.error) {
-        if (!additional)
-            return null;
-        result.error = additional.error;
-    }
-    return result;
-};
 /**
  * Bundles multiple requests and sends them to the server.
  * @param gt - Contains the baseURL and apiKey for the server request.
@@ -67,14 +18,6 @@ const _postprocess = (result, additional) => {
  */
 function _bundleRequests(gt, requests) {
     return __awaiter(this, void 0, void 0, function* () {
-        let processedArray = [];
-        let additionalArray = [];
-        // Preprocess each request and store the processed request and additional data.
-        requests.forEach(request => {
-            const { processed, additional } = _preprocess(request);
-            processedArray.push(processed);
-            additionalArray.push(additional || {});
-        });
         try {
             // Send the processed requests to the server as a bundled request.
             const response = yield fetch(`${gt.baseURL}/bundle`, {
@@ -83,20 +26,18 @@ function _bundleRequests(gt, requests) {
                     'Content-Type': 'application/json',
                     'gtx-api-key': gt.apiKey,
                 },
-                body: JSON.stringify(processedArray)
+                body: JSON.stringify(requests)
             });
             // Check for response errors.
             if (!response.ok) {
                 throw new Error(`${response.status}: ${yield response.text()}`);
             }
-            // Parse the response and postprocess each result.
             const resultArray = yield response.json();
-            return resultArray.map((item, index) => _postprocess(item, additionalArray[index]));
+            return resultArray;
         }
         catch (error) {
             console.error(error);
-            // If there is an error, postprocess each request with the error information.
-            return processedArray.map((item, index) => _postprocess(item, Object.assign({ error: error }, additionalArray[index])));
+            return Array.from(requests, () => ({ translation: null, error: error }));
         }
     });
 }

package/dist/translation/_intl.d.ts

@@ -1,17 +1,18 @@
-import { Content } from "./_translate";
 /**
    * Translates a single piece of content and caches for use in a public project.
    * @param {{ baseURL: string, apiKey: string }} gt - The translation service configuration.
-   * @param {Content} content - The content to translate.
+   * @param {string} content - The content to translate.
    * @param {string} targetLanguage - The target language for the translation.
    * @param {string} projectID - The ID of the project
-   * @param {{ [key: string]: any }} metadata - Additional metadata for the translation request.
+   * @param {{ page?: string, notes?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
    * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
 */
-export default function _intl(gt: {
+export default function _translate(gt: {
     baseURL: string;
     apiKey: string;
-}, content: Content, targetLanguage: string, projectID: string, metadata: {
+}, content: string, targetLanguage: string, projectID: string, metadata: {
+    page?: string;
+    notes?: string;
     [key: string]: any;
 }): Promise<{
     translation: string;

package/dist/translation/_intl.js

@@ -9,39 +9,41 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = _intl;
-const _translate_1 = require("./_translate");
+exports.default = _translate;
 /**
    * Translates a single piece of content and caches for use in a public project.
    * @param {{ baseURL: string, apiKey: string }} gt - The translation service configuration.
-   * @param {Content} content - The content to translate.
+   * @param {string} content - The content to translate.
    * @param {string} targetLanguage - The target language for the translation.
    * @param {string} projectID - The ID of the project
-   * @param {{ [key: string]: any }} metadata - Additional metadata for the translation request.
+   * @param {{ page?: string, notes?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
    * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
 */
-function _intl(gt, content, targetLanguage, projectID, metadata) {
+function _translate(gt, content, targetLanguage, projectID, metadata) {
     return __awaiter(this, void 0, void 0, function* () {
-        const f = (array) => __awaiter(this, void 0, void 0, function* () {
-            const response = yield fetch(`${gt.baseURL}/intl`, {
+        try {
+            const response = yield fetch(`${gt.baseURL}/translate`, {
                 method: 'POST',
                 headers: {
                     'Content-Type': 'application/json',
                     'gtx-api-key': gt.apiKey,
                 },
                 body: JSON.stringify({
-                    content: array,
-                    targetLanguage: targetLanguage,
-                    projectID: projectID,
-                    metadata: metadata
+                    content, targetLanguage, projectID, metadata
                 })
             });
             if (!response.ok) {
                 throw new Error(`${response.status}: ${yield response.text()}`);
             }
             const result = yield response.json();
-            return result.translation;
-        });
-        return (0, _translate_1._createTranslation)(content, f);
+            return result;
+        }
+        catch (error) {
+            console.error(error);
+            return {
+                translation: content,
+                error: error
+            };
+        }
     });
 }

package/dist/translation/_translate.d.ts

@@ -1,37 +1,18 @@
-export type ContentObject = {
-    text: string;
-    exclude?: boolean;
-    cache?: boolean;
-};
-type ContentItem = ContentObject | string;
-export type Content = ContentItem | ContentItem[];
-export declare const _process: (content: Content) => {
-    array: ContentObject[];
-    excludedArray: string[];
-};
-export declare const _recombine: (translatedContent: ContentObject[], excludedArray: string[]) => string;
-export declare const _createTranslation: (content: Content, f: Function) => Promise<{
-    translation: string;
-    error?: undefined;
-} | {
-    translation: string;
-    error: unknown;
-}>;
 /**
- * Translates a single piece of content.
+ * Translates a string.
  * @param {{ baseURL: string, apiKey: string }} gt - The translation service configuration.
- * @param {Content} content - The content to translate.
+ * @param {string} content - The content to translate.
  * @param {string} targetLanguage - The target language for the translation.
- * @param {{ [key: string]: any }} metadata - Additional metadata for the translation request.
+ * @param {{ notes?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
  * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
  */
 export default function _translate(gt: {
     baseURL: string;
     apiKey: string;
-}, content: Content, targetLanguage: string, metadata: {
+}, content: string, targetLanguage: string, metadata: {
+    notes?: string;
     [key: string]: any;
 }): Promise<{
     translation: string;
     error?: Error | unknown;
 }>;
-export {};

package/dist/translation/_translate.js

@@ -1,5 +1,4 @@
 "use strict";
-// TYPE DEFINITIONS
 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) {
@@ -10,91 +9,40 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._createTranslation = exports._recombine = exports._process = void 0;
 exports.default = _translate;
-// PROCESSING
-const _process = (content) => {
-    let array = [];
-    let excludedArray = [];
-    const handleSingleItem = (contentItem) => {
-        if (typeof contentItem === 'string') {
-            array.push({ text: contentItem });
-        }
-        else if (typeof contentItem === 'object' && contentItem.exclude) {
-            array.push(Object.assign(Object.assign({}, contentItem), { text: '' }));
-            excludedArray.push(contentItem.text);
-        }
-        else if (typeof contentItem === 'object' && contentItem.text) {
-            array.push(contentItem);
-        }
-    };
-    if (Array.isArray(content))
-        content.map(handleSingleItem);
-    else
-        handleSingleItem(content);
-    return { array, excludedArray };
-};
-exports._process = _process;
-const _recombine = (translatedContent, excludedArray) => {
-    let result = '';
-    for (const object of translatedContent) {
-        if (object.exclude && excludedArray.length < 0) {
-            result += excludedArray.shift();
-        }
-        else if (object.text) {
-            result += object.text;
-        }
-    }
-    return result;
-};
-exports._recombine = _recombine;
-// REQUEST
-const _createTranslation = (content, f) => __awaiter(void 0, void 0, void 0, function* () {
-    const { array, excludedArray } = (0, exports._process)(content);
-    try {
-        const result = yield f(content);
-        return {
-            translation: (0, exports._recombine)(result, excludedArray)
-        };
-    }
-    catch (error) {
-        console.error(error);
-        return {
-            translation: (0, exports._recombine)(array, excludedArray),
-            error: error
-        };
-    }
-});
-exports._createTranslation = _createTranslation;
 /**
- * Translates a single piece of content.
+ * Translates a string.
  * @param {{ baseURL: string, apiKey: string }} gt - The translation service configuration.
- * @param {Content} content - The content to translate.
+ * @param {string} content - The content to translate.
  * @param {string} targetLanguage - The target language for the translation.
- * @param {{ [key: string]: any }} metadata - Additional metadata for the translation request.
+ * @param {{ notes?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
  * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
  */
 function _translate(gt, content, targetLanguage, metadata) {
     return __awaiter(this, void 0, void 0, function* () {
-        const f = (array) => __awaiter(this, void 0, void 0, function* () {
-            const response = yield fetch(`${gt.baseURL}/text`, {
+        try {
+            const response = yield fetch(`${gt.baseURL}/translate`, {
                 method: 'POST',
                 headers: {
                     'Content-Type': 'application/json',
                     'gtx-api-key': gt.apiKey,
                 },
                 body: JSON.stringify({
-                    content: array,
-                    targetLanguage: targetLanguage,
-                    metadata: metadata
+                    content, targetLanguage, metadata
                 })
             });
             if (!response.ok) {
                 throw new Error(`${response.status}: ${yield response.text()}`);
             }
             const result = yield response.json();
-            return result.translation;
-        });
-        return (0, exports._createTranslation)(content, f);
+            return result;
+        }
+        catch (error) {
+            console.error(error);
+            return {
+                translation: content,
+                error: error
+            };
+        }
     });
 }

package/package.json

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