generaltranslation 2.0.64 → 2.0.66

package/dist/codes/determineLanguage.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = _determineLanguage;
+var codes_1 = require("./codes");
+/**
+ * Given a list of language and a list of approved language, sorted in preference order
+ * Determines which language of the given languages is the best match in the approvedLanguages, prioritizing exact matches and falling back to dialects of the same language
+* @internal
+*/
+function _determineLanguage(languages, approvedLanguages) {
+    if (typeof languages === 'string')
+        languages = [languages];
+    if (!approvedLanguages)
+        return languages[0];
+    var _loop_1 = function (language) {
+        var exactMatch = approvedLanguages.find(function (approvedLanguage) { return approvedLanguage === language; });
+        if (exactMatch)
+            return { value: exactMatch };
+        var sameLanguage = approvedLanguages.find(function (approvedLanguage) { return (0, codes_1._isSameLanguage)(approvedLanguage, language); });
+        if (sameLanguage)
+            return { value: sameLanguage };
+    };
+    for (var _i = 0, languages_1 = languages; _i < languages_1.length; _i++) {
+        var language = languages_1[_i];
+        var state_1 = _loop_1(language);
+        if (typeof state_1 === "object")
+            return state_1.value;
+    }
+    return undefined;
+}

package/dist/formatting/_format.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/formatting/_string_content.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/formatting/_string_content.js

@@ -0,0 +1,104 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._splitStringToContent = _splitStringToContent;
+exports._renderContentToString = _renderContentToString;
+var _format_1 = require("./_format");
+// Variable types mapping
+var variableTypeMap = {
+    var: "variable",
+    num: "number",
+    datetime: "datetime",
+    currency: "currency"
+};
+/**
+* @internal
+*/
+/**
+ * @internal
+ */
+function _splitStringToContent(string) {
+    var result = [];
+    var regex = /{([^}]+)}/g;
+    var lastIndex = 0;
+    var match;
+    while ((match = regex.exec(string)) !== null) {
+        var fullMatch = match[0], content = match[1];
+        var startIndex = match.index;
+        // Check for escaped braces with '^' right before the opening brace
+        if (string[startIndex - 1] === "^") {
+            // Add text before the escape sequence
+            if (startIndex - 1 > lastIndex) {
+                result.push(string.slice(lastIndex, startIndex - 1));
+            }
+            // Add the escaped content as literal text
+            result.push(fullMatch);
+            lastIndex = startIndex + fullMatch.length;
+            continue;
+        }
+        // Add text before the match
+        if (startIndex > lastIndex) {
+            result.push(string.slice(lastIndex, startIndex));
+        }
+        // Handle the variable substitution inside the braces
+        var parts = content.split(",").map(function (part) { return part.trim(); });
+        var key = parts[0];
+        var variableType = parts[1] ? variableTypeMap[parts[1]] : undefined;
+        var variableObject = __assign({ key: key }, (variableType && { variable: variableType }));
+        result.push(variableObject);
+        lastIndex = startIndex + fullMatch.length;
+    }
+    // Add the remaining part of the string after the last match
+    if (lastIndex < string.length) {
+        result.push(string.slice(lastIndex));
+    }
+    return result;
+}
+/**
+* @internal
+*/
+function _renderContentToString(content, languages, variables, variableOptions) {
+    if (languages === void 0) { languages = 'en'; }
+    if (variables === void 0) { variables = {}; }
+    if (variableOptions === void 0) { variableOptions = {}; }
+    if (typeof content === 'string') {
+        content = _splitStringToContent(content);
+    }
+    if (typeof content === 'string') {
+        return content;
+    }
+    return content.map(function (item) {
+        var _a;
+        if (typeof item === 'string')
+            return item;
+        if (typeof item === 'object') {
+            var value = variables[item.key];
+            if (!item.variable)
+                return value;
+            if (item.variable === "number") {
+                return (0, _format_1._formatNum)({
+                    value: value,
+                    languages: languages,
+                    options: variableOptions[item.key]
+                });
+            }
+            if (item.variable === "currency") {
+                return (0, _format_1._formatCurrency)(__assign(__assign({ value: value, languages: languages }, (variableOptions[item.key] && { options: variableOptions[item.key] })), (((_a = variableOptions[item.key]) === null || _a === void 0 ? void 0 : _a.currency) && { currency: variableOptions[item.key].currency })));
+            }
+            if (item.variable === "datetime") {
+                return (0, _format_1._formatDateTime)(__assign({ value: value, languages: languages }, (variableOptions[item.key] && { options: variableOptions[item.key] })));
+            }
+            return value;
+        }
+    }).join('');
+}

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import { LanguageObject } from './codes/codes';
-import { StringWithVariables } from './translation/strings/_translate';
-import { Content, Update, Request } from './types/types';
+import { Content, Update, Request, ReactChildrenAsObject, ReactTranslationResult, ContentTranslationResult } from './types/types';
 /**
  * Type representing the constructor parameters for the GT class.
  */
@@ -30,48 +29,45 @@ declare class GT {
     constructor({ apiKey, defaultLanguage, projectID, baseURL }?: GTConstructorParams);
     /**
      * Translates a string or an array of strings/variables into a target language.
-     * If `metadata.store` is provided, the translation is cached for use in a public project.
+     * If `metadata.save` is provided, the translation is cached for use in a public project.
      *
      * @param {Content} content - The string or array of strings/variables to be translated.
      * @param {string} targetLanguage - The target language code (e.g., 'en', 'fr') for the translation.
-     * @param {{ context?: string, store?: boolean, [key: string]: any }} [metadata] - Additional metadata for the translation request.
+     * @param {{ context?: string, save?: boolean, [key: string]: any }} [metadata] - Additional metadata for the translation request.
      * @param {string} [metadata.context] - Contextual information to assist with the translation.
-     * @param {boolean} [metadata.store] - Whether to cache the translation for use in a public project.
+     * @param {boolean} [metadata.save] - Whether to cache the translation for use in a public project.
      *
-     * @returns {Promise<{ translation: string, error?: Error | unknown }>} A promise that resolves to the translated content, or an error if the translation fails.
+     * @returns {Promise<ContentTranslationResult>} A promise that resolves to the translated content, or an error if the translation fails.
      */
     translate(content: Content, targetLanguage: string, metadata?: {
         context?: string;
-        store?: boolean;
+        save?: boolean;
         [key: string]: any;
     }): Promise<{
-        translation: StringWithVariables | [];
-        error?: Error | unknown;
+        translation: Content;
+        language: string;
     }>;
     /**
     * Translates the content of React children elements.
     *
     * @param {Object} params - The parameters for the translation.
-    * @param {any} params.children - The React children content to be translated.
+    * @param {ReactChildrenAsObject} params.children - 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.
+    * @returns {Promise<ReactTranslationResult>} - A promise that resolves to the translated content.
     */
-    translateReact(children: any, targetLanguage: string, metadata?: {
+    translateReact(children: ReactChildrenAsObject, targetLanguage: string, metadata?: {
         context?: string;
-        store?: boolean;
+        save?: boolean;
         [key: string]: any;
-    }): Promise<{
-        translation: any | null;
-        error?: Error | unknown;
-    }>;
+    }): Promise<ReactTranslationResult>;
     /**
     * Bundles multiple translation requests and sends them to the server.
     * @param requests - Array of requests to be processed and sent.
     * @returns A promise that resolves to an array of processed results.
     */
-    translateBundle(requests: Request[]): Promise<Array<any | null>>;
+    translateBundle(requests: Request[]): Promise<Array<ReactTranslationResult | ContentTranslationResult>>;
     /**
     * Pushes updates to a remotely cached translation dictionary.
     * @param {Update[]} updates - Array of updates with optional targetLanguage.
@@ -184,3 +180,42 @@ export declare function formatCurrency({ value, languages, currency, options }:
     currency?: string;
     options?: Intl.NumberFormatOptions;
 }): string;
+/**
+ * Splits a string into an array of text and variable objects.
+ *
+ * @param {string} string - The input string to split.
+ * @returns {Content} - An array containing strings and VariableObjects.
+ */
+export declare function splitStringToContent(string: string): Content;
+/**
+ * Renders content to a string by replacing variables with their formatted values.
+ *
+ * @param {Content} content - The content to render, which can be a string or an array of strings and VariableObjects.
+ * @param {string | string[]} [languages='en'] - The language(s) to use for formatting.
+ * @param {Record<string, any>} [variables={}] - An object containing variable values keyed by variable names.
+ * @param {Record<string, any>} [variableOptions={}] - An object containing options for formatting variables, keyed by variable names.
+ * @returns {string} - The rendered string with variables replaced by their formatted values.
+ *
+*/
+export declare function renderContentToString<V extends Record<string, any>>(content: Content, languages?: string | string[], variables?: V, variableOptions?: {
+    [key in keyof V]?: Intl.NumberFormatOptions | Intl.DateTimeFormatOptions;
+}): string;
+/**
+ * Determines the best matching language from the approved languages list based on a provided
+ * list of preferred languages. The function prioritizes exact matches, but will also consider
+ * dialects of the same language if an exact match is not available.
+ *
+ * It also respects the order of preference in both the provided languages list and the
+ * approved languages list. A dialect match of a higher-preference language is considered better
+ * than an exact match of a lower-preference language.
+ *
+ * For example, if the `languages` list is ['en', 'fr'], and the `approvedLanguages` list is
+ * ['fr', 'en-GB'], it will prefer 'en-GB' over 'fr', even though 'fr' has an exact
+ * dialect match, because 'en' appears earlier in the `languages` list.
+ *
+ * @param {string | string[]} languages - A single language or an array of languages sorted in preference order.
+ * @param {string[]} approvedLanguages - An array of approved languages, also sorted by preference.
+ *
+ * @returns {string | undefined} - The best matching language from the approvedLanguages list, or undefined if no match is found.
+ */
+export declare function determineLanguage(languages: string | string[], approvedLanguages: string[]): string | undefined;

package/dist/index.js

@@ -60,6 +60,9 @@ exports.isSameLanguage = isSameLanguage;
 exports.formatNum = formatNum;
 exports.formatDateTime = formatDateTime;
 exports.formatCurrency = formatCurrency;
+exports.splitStringToContent = splitStringToContent;
+exports.renderContentToString = renderContentToString;
+exports.determineLanguage = determineLanguage;
 // ----- IMPORTS ----- //
 var codes_1 = require("./codes/codes");
 var getLanguageDirection_1 = __importDefault(require("./codes/getLanguageDirection"));
@@ -67,7 +70,9 @@ var _translateBundle_1 = __importDefault(require("./translation/dictionaries/_tr
 var _translate_1 = __importDefault(require("./translation/strings/_translate"));
 var _translateReact_1 = __importDefault(require("./translation/react/_translateReact"));
 var _updateProjectDictionary_1 = __importDefault(require("./translation/dictionaries/_updateProjectDictionary"));
-var _format_1 = require("./format/_format");
+var _format_1 = require("./formatting/_format");
+var _string_content_1 = require("./formatting/_string_content");
+var determineLanguage_1 = __importDefault(require("./codes/determineLanguage"));
 // ----- CORE CLASS ----- // 
 var getDefaultFromEnv = function (VARIABLE) {
     if (typeof process !== 'undefined' && process.env) {
@@ -97,15 +102,15 @@ var GT = /** @class */ (function () {
     }
     /**
      * Translates a string or an array of strings/variables into a target language.
-     * If `metadata.store` is provided, the translation is cached for use in a public project.
+     * If `metadata.save` is provided, the translation is cached for use in a public project.
      *
      * @param {Content} content - The string or array of strings/variables to be translated.
      * @param {string} targetLanguage - The target language code (e.g., 'en', 'fr') for the translation.
-     * @param {{ context?: string, store?: boolean, [key: string]: any }} [metadata] - Additional metadata for the translation request.
+     * @param {{ context?: string, save?: boolean, [key: string]: any }} [metadata] - Additional metadata for the translation request.
      * @param {string} [metadata.context] - Contextual information to assist with the translation.
-     * @param {boolean} [metadata.store] - Whether to cache the translation for use in a public project.
+     * @param {boolean} [metadata.save] - Whether to cache the translation for use in a public project.
      *
-     * @returns {Promise<{ translation: string, error?: Error | unknown }>} A promise that resolves to the translated content, or an error if the translation fails.
+     * @returns {Promise<ContentTranslationResult>} A promise that resolves to the translated content, or an error if the translation fails.
      */
     GT.prototype.translate = function (content, targetLanguage, metadata) {
         return __awaiter(this, void 0, void 0, function () {
@@ -121,11 +126,11 @@ var GT = /** @class */ (function () {
     * Translates the content of React children elements.
     *
     * @param {Object} params - The parameters for the translation.
-    * @param {any} params.children - The React children content to be translated.
+    * @param {ReactChildrenAsObject} params.children - 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.
+    * @returns {Promise<ReactTranslationResult>} - A promise that resolves to the translated content.
     */
     GT.prototype.translateReact = function (children, targetLanguage, metadata) {
         return __awaiter(this, void 0, void 0, function () {
@@ -253,3 +258,46 @@ function formatCurrency(_a) {
     var value = _a.value, languages = _a.languages, currency = _a.currency, options = _a.options;
     return (0, _format_1._formatCurrency)({ value: value, languages: languages, currency: currency, options: options });
 }
+/**
+ * Splits a string into an array of text and variable objects.
+ *
+ * @param {string} string - The input string to split.
+ * @returns {Content} - An array containing strings and VariableObjects.
+ */
+function splitStringToContent(string) {
+    return (0, _string_content_1._splitStringToContent)(string);
+}
+/**
+ * Renders content to a string by replacing variables with their formatted values.
+ *
+ * @param {Content} content - The content to render, which can be a string or an array of strings and VariableObjects.
+ * @param {string | string[]} [languages='en'] - The language(s) to use for formatting.
+ * @param {Record<string, any>} [variables={}] - An object containing variable values keyed by variable names.
+ * @param {Record<string, any>} [variableOptions={}] - An object containing options for formatting variables, keyed by variable names.
+ * @returns {string} - The rendered string with variables replaced by their formatted values.
+ *
+*/
+function renderContentToString(content, languages, variables, variableOptions) {
+    return (0, _string_content_1._renderContentToString)(content, languages, variables, variableOptions);
+}
+/**
+ * Determines the best matching language from the approved languages list based on a provided
+ * list of preferred languages. The function prioritizes exact matches, but will also consider
+ * dialects of the same language if an exact match is not available.
+ *
+ * It also respects the order of preference in both the provided languages list and the
+ * approved languages list. A dialect match of a higher-preference language is considered better
+ * than an exact match of a lower-preference language.
+ *
+ * For example, if the `languages` list is ['en', 'fr'], and the `approvedLanguages` list is
+ * ['fr', 'en-GB'], it will prefer 'en-GB' over 'fr', even though 'fr' has an exact
+ * dialect match, because 'en' appears earlier in the `languages` list.
+ *
+ * @param {string | string[]} languages - A single language or an array of languages sorted in preference order.
+ * @param {string[]} approvedLanguages - An array of approved languages, also sorted by preference.
+ *
+ * @returns {string | undefined} - The best matching language from the approvedLanguages list, or undefined if no match is found.
+ */
+function determineLanguage(languages, approvedLanguages) {
+    return (0, determineLanguage_1.default)(languages, approvedLanguages);
+}

package/dist/translation/dictionaries/_translateBundle.js

@@ -38,16 +38,11 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = _translateBundle;
 /**
- * Bundles multiple requests and sends them to the server.
- * @param {{ baseURL: string, apiKey: string }} gt - Contains the baseURL and apiKey for the server request.
- * @param {Request[]} requests - Array of requests to be processed and sent.
- * @param {{ timeout?: number }} options - Additional options for the request, including timeout.
- * @returns {Promise<Array<any | null>>} A promise that resolves to an array of processed results.
  * @internal
  */
 function _translateBundle(gt, requests) {
     return __awaiter(this, void 0, void 0, function () {
-        var controller, signal, response, _a, _b, _c, resultArray, error_1;
+        var controller, signal, response, _a, _b, _c, resultArray;
         var _d, _e, _f;
         return __generator(this, function (_g) {
             switch (_g.label) {
@@ -57,9 +52,6 @@ function _translateBundle(gt, requests) {
                     if ((_f = (_e = (_d = requests[0]) === null || _d === void 0 ? void 0 : _d.data) === null || _e === void 0 ? void 0 : _e.metadata) === null || _f === void 0 ? void 0 : _f.timeout) {
                         setTimeout(function () { return controller.abort(); }, requests[0].data.metadata.timeout);
                     }
-                    _g.label = 1;
-                case 1:
-                    _g.trys.push([1, 6, , 7]);
                     return [4 /*yield*/, fetch("".concat(gt.baseURL, "/bundle"), {
                             method: 'POST',
                             headers: {
@@ -69,24 +61,17 @@ function _translateBundle(gt, requests) {
                             body: JSON.stringify(requests),
                             signal: signal
                         })];
-                case 2:
+                case 1:
                     response = _g.sent();
-                    if (!!response.ok) return [3 /*break*/, 4];
+                    if (!!response.ok) return [3 /*break*/, 3];
                     _a = Error.bind;
                     _c = (_b = "".concat(response.status, ": ")).concat;
                     return [4 /*yield*/, response.text()];
-                case 3: throw new (_a.apply(Error, [void 0, _c.apply(_b, [_g.sent()])]))();
-                case 4: return [4 /*yield*/, response.json()];
-                case 5:
+                case 2: throw new (_a.apply(Error, [void 0, _c.apply(_b, [_g.sent()])]))();
+                case 3: return [4 /*yield*/, response.json()];
+                case 4:
                     resultArray = _g.sent();
                     return [2 /*return*/, resultArray];
-                case 6:
-                    error_1 = _g.sent();
-                    if (error_1 instanceof Error && error_1.name === 'AbortError') {
-                        throw new Error('Error: Request timed out.');
-                    }
-                    throw new Error("".concat(error_1));
-                case 7: return [2 /*return*/];
             }
         });
     });

package/dist/translation/dictionaries/_updateProjectDictionary.js

@@ -42,24 +42,22 @@ exports.default = _updateProjectDictionary;
  */
 function _updateProjectDictionary(gt, updates, languages, projectID, replace) {
     return __awaiter(this, void 0, void 0, function () {
-        var response, _a, _b, _c, result, error_1;
+        var response, _a, _b, _c, result;
         return __generator(this, function (_d) {
             switch (_d.label) {
-                case 0:
-                    _d.trys.push([0, 5, , 6]);
-                    return [4 /*yield*/, fetch("".concat(gt.baseURL, "/update"), {
-                            method: 'POST',
-                            headers: {
-                                'Content-Type': 'application/json',
-                                'gtx-api-key': gt.apiKey,
-                            },
-                            body: JSON.stringify({
-                                updates: updates,
-                                languages: languages,
-                                projectID: projectID,
-                                replace: replace
-                            })
-                        })];
+                case 0: return [4 /*yield*/, fetch("".concat(gt.baseURL, "/update"), {
+                        method: 'POST',
+                        headers: {
+                            'Content-Type': 'application/json',
+                            'gtx-api-key': gt.apiKey,
+                        },
+                        body: JSON.stringify({
+                            updates: updates,
+                            languages: languages,
+                            projectID: projectID,
+                            replace: replace
+                        })
+                    })];
                 case 1:
                     response = _d.sent();
                     if (!!response.ok) return [3 /*break*/, 3];
@@ -71,13 +69,6 @@ function _updateProjectDictionary(gt, updates, languages, projectID, replace) {
                 case 4:
                     result = _d.sent();
                     return [2 /*return*/, result.languages];
-                case 5:
-                    error_1 = _d.sent();
-                    if (error_1 instanceof Error && error_1.name === 'AbortError') {
-                        throw new Error('Error: Request timed out.');
-                    }
-                    throw new Error("".concat(error_1));
-                case 6: return [2 /*return*/];
             }
         });
     });

package/dist/translation/react/_translateReact.js

@@ -38,21 +38,11 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = _translateReact;
 /**
- * Translates the given React children into the target language using a specified API.
- *
- * @param {{ baseURL: string, apiKey: string }} gt - An object containing baseURL and apiKey for the API.
- * @param {any} children - The React children to be translated.
- * @param {string} targetLanguage - The target language code (e.g., 'en', 'fr') for the translation.
- * @param {{ [key: string]: any }} metadata - Additional metadata to be sent with the translation request.
- *
- * @returns {Promise<{ translation: any | null, error?: Error | unknown }>} - 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).
  * @internal
 **/
 function _translateReact(gt, content, targetLanguage, metadata) {
     return __awaiter(this, void 0, void 0, function () {
-        var controller, signal, response, _a, _b, _c, error_1;
+        var controller, signal, response, _a, _b, _c;
         return __generator(this, function (_d) {
             switch (_d.label) {
                 case 0:
@@ -61,9 +51,6 @@ function _translateReact(gt, content, targetLanguage, metadata) {
                     if (metadata.timeout) {
                         setTimeout(function () { return controller.abort(); }, metadata.timeout);
                     }
-                    _d.label = 1;
-                case 1:
-                    _d.trys.push([1, 6, , 7]);
                     return [4 /*yield*/, fetch("".concat(gt.baseURL, "/react"), {
                             method: 'POST',
                             headers: {
@@ -77,22 +64,15 @@ function _translateReact(gt, content, targetLanguage, metadata) {
                             }),
                             signal: signal
                         })];
-                case 2:
+                case 1:
                     response = _d.sent();
-                    if (!!response.ok) return [3 /*break*/, 4];
+                    if (!!response.ok) return [3 /*break*/, 3];
                     _a = Error.bind;
                     _c = (_b = "".concat(response.status, ": ")).concat;
                     return [4 /*yield*/, response.text()];
-                case 3: throw new (_a.apply(Error, [void 0, _c.apply(_b, [_d.sent()])]))();
-                case 4: return [4 /*yield*/, response.json()];
-                case 5: return [2 /*return*/, _d.sent()];
-                case 6:
-                    error_1 = _d.sent();
-                    if (error_1 instanceof Error && error_1.name === 'AbortError') {
-                        throw new Error('Error: Request timed out.');
-                    }
-                    throw new Error("".concat(error_1));
-                case 7: return [2 /*return*/];
+                case 2: throw new (_a.apply(Error, [void 0, _c.apply(_b, [_d.sent()])]))();
+                case 3: return [4 /*yield*/, response.json()];
+                case 4: return [2 /*return*/, _d.sent()];
             }
         });
     });

package/dist/translation/strings/_translate.d.ts

@@ -1,7 +1 @@
-export type StringWithVariables = string | {
-    variable?: string;
-    key: string;
-} | Array<string | {
-    variable?: string;
-    key: string;
-}>;
+export {};

package/dist/translation/strings/_translate.js

@@ -38,21 +38,11 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = _translate;
 /**
- * Translates the given string into the target language using a specified API.
- *
- * @param {{ baseURL: string, apiKey: string }} gt - An object containing baseURL and apiKey for the API.
- * @param {any} content - The string to be translated.
- * @param {string} targetLanguage - The target language code (e.g., 'en', 'fr') for the translation.
- * @param {{ [key: string]: any }} metadata - Additional metadata to be sent with the translation request.
- *
- * @returns {Promise<{ translation: any | null, error?: Error | unknown }>} - 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).
  * @internal
 **/
 function _translate(gt, content, targetLanguage, metadata) {
     return __awaiter(this, void 0, void 0, function () {
-        var controller, signal, response, _a, _b, _c, result, error_1;
+        var controller, signal, response, _a, _b, _c, result;
         return __generator(this, function (_d) {
             switch (_d.label) {
                 case 0:
@@ -61,9 +51,6 @@ function _translate(gt, content, targetLanguage, metadata) {
                     if (metadata.timeout) {
                         setTimeout(function () { return controller.abort(); }, metadata.timeout);
                     }
-                    _d.label = 1;
-                case 1:
-                    _d.trys.push([1, 6, , 7]);
                     return [4 /*yield*/, fetch("".concat(gt.baseURL, "/translate"), {
                             method: 'POST',
                             headers: {
@@ -77,24 +64,17 @@ function _translate(gt, content, targetLanguage, metadata) {
                             }),
                             signal: signal
                         })];
-                case 2:
+                case 1:
                     response = _d.sent();
-                    if (!!response.ok) return [3 /*break*/, 4];
+                    if (!!response.ok) return [3 /*break*/, 3];
                     _a = Error.bind;
                     _c = (_b = "".concat(response.status, ": ")).concat;
                     return [4 /*yield*/, response.text()];
-                case 3: throw new (_a.apply(Error, [void 0, _c.apply(_b, [_d.sent()])]))();
-                case 4: return [4 /*yield*/, response.json()];
-                case 5:
+                case 2: throw new (_a.apply(Error, [void 0, _c.apply(_b, [_d.sent()])]))();
+                case 3: return [4 /*yield*/, response.json()];
+                case 4:
                     result = _d.sent();
                     return [2 /*return*/, result];
-                case 6:
-                    error_1 = _d.sent();
-                    if (error_1 instanceof Error && error_1.name === 'AbortError') {
-                        throw new Error('Error: Request timed out.');
-                    }
-                    throw new Error("".concat(error_1));
-                case 7: return [2 /*return*/];
             }
         });
     });

package/dist/types/types.d.ts

@@ -1,8 +1,21 @@
-export type Variable = {
+export type VariableObject = {
     variable?: string;
     key: string;
 };
-export type Content = string | Array<string | Variable>;
+export type Content = string | Array<string | VariableObject>;
+export type ElementAsObject = {
+    type: string;
+    props: {
+        'data-generaltranslation'?: {
+            id: number;
+            [key: string]: any;
+        };
+        children?: ReactChildrenAsObject;
+        [key: string]: any;
+    };
+};
+export type ReactChildAsObject = string | ElementAsObject | VariableObject;
+export type ReactChildrenAsObject = ReactChildAsObject | ReactChildAsObject[];
 export type Update = {
     type: 'react';
     data: {
@@ -31,3 +44,21 @@ export type Request = {
         metadata: Record<string, any>;
     };
 };
+export type ContentTranslationResult = {
+    translation: Content;
+    language: string;
+    reference?: {
+        id: string;
+        key: string;
+        dictionaryName: string;
+    };
+};
+export type ReactTranslationResult = {
+    translation: Content;
+    language: string;
+    reference?: {
+        id: string;
+        key: string;
+        dictionaryName: string;
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "2.0.64",
+  "version": "2.0.66",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",