generaltranslation 2.0.43 → 2.0.44

package/README.md

@@ -186,7 +186,7 @@ console.log(result.translation); // { "type": "div", "props": { "children": "Hol
 
 - A promise that resolves to an object containing the translated content and optional error information.
 
-#### `bundleRequests(requests: any[]): Promise<Array<any | null>>`
+#### `bundleTranslation(requests: any[]): Promise<Array<any | null>>`
 
 Bundles multiple requests and sends them to the server.
 
@@ -206,7 +206,7 @@ const requests = [
     }
     
 ];
-const results = await gt.bundleRequests(requests);
+const results = await gt.bundleTranslation(requests);
 console.log(results); // ['Hola', 'Hallo']
 ```
 

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 import { LanguageObject } from './codes/codes';
+import { Request } from './translation/_bundleTranslation';
+import { Update } from './translation/_updateRemoteDictionary';
 /**
  * Type representing the constructor parameters for the GT class.
  */
@@ -73,11 +75,17 @@ declare class GT {
         error?: Error | unknown;
     }>;
     /**
-    * Bundles multiple requests and sends them to the server.
+    * 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.
     */
-    bundleRequests(requests: any[]): Promise<Array<any | null>>;
+    bundleTranslation(requests: Request[]): Promise<Array<any | null>>;
+    /**
+    *Pushes updates to a remotely cached translation dictionary.
+    * @param updates - Array of updates with optional targetLanguage.
+    * @returns A promise that resolves to a boolean indicating success or failure.
+    */
+    updateRemoteDictionary(updates: Update[]): Promise<boolean>;
 }
 export default GT;
 /**

package/dist/index.js

@@ -22,10 +22,11 @@ exports.isSameLanguage = isSameLanguage;
 // ----- IMPORTS ----- //
 const codes_1 = require("./codes/codes");
 const getLanguageDirection_1 = __importDefault(require("./codes/getLanguageDirection"));
-const _bundleRequests_1 = __importDefault(require("./translation/_bundleRequests"));
+const _bundleTranslation_1 = __importDefault(require("./translation/_bundleTranslation"));
 const _intl_1 = __importDefault(require("./translation/_intl"));
 const _translate_1 = __importDefault(require("./translation/_translate"));
 const _translateReactChildren_1 = __importDefault(require("./translation/_translateReactChildren"));
+const _updateRemoteDictionary_1 = __importDefault(require("./translation/_updateRemoteDictionary"));
 // ----- CORE CLASS ----- // 
 const getDefaultFromEnv = (VARIABLE) => {
     if (typeof process !== 'undefined' && process.env) {
@@ -93,13 +94,23 @@ class GT {
         });
     }
     /**
-    * Bundles multiple requests and sends them to the server.
+    * 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.
     */
-    bundleRequests(requests) {
+    bundleTranslation(requests) {
         return __awaiter(this, void 0, void 0, function* () {
-            return (0, _bundleRequests_1.default)(this, requests);
+            return (0, _bundleTranslation_1.default)(this, requests);
+        });
+    }
+    /**
+    *Pushes updates to a remotely cached translation dictionary.
+    * @param updates - Array of updates with optional targetLanguage.
+    * @returns A promise that resolves to a boolean indicating success or failure.
+    */
+    updateRemoteDictionary(updates) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, _updateRemoteDictionary_1.default)(this, updates);
         });
     }
 }

package/dist/translation/_bundleTranslation.d.ts

@@ -0,0 +1,22 @@
+export type Request = {
+    type: 'translate';
+    data: {
+        content: string;
+        targetLanguage: string;
+        metadata: Record<string, any>;
+    };
+} | {
+    type: 'intl';
+    data: {
+        content: string;
+        targetLanguage: string;
+        metadata: Record<string, any>;
+    };
+} | {
+    type: 'intl';
+    data: {
+        children: object | string;
+        targetLanguage: string;
+        metadata: Record<string, any>;
+    };
+};

package/dist/translation/{_bundleRequests.js → _bundleTranslation.js}

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = _bundleRequests;
+exports.default = _bundleTranslation;
 /**
  * Bundles multiple requests and sends them to the server.
  * @param {{ baseURL: string, apiKey: string }} gt - Contains the baseURL and apiKey for the server request.
@@ -18,12 +18,13 @@ exports.default = _bundleRequests;
  * @returns {Promise<Array<any | null>>} A promise that resolves to an array of processed results.
  * @internal
  */
-function _bundleRequests(gt_1, requests_1) {
-    return __awaiter(this, arguments, void 0, function* (gt, requests, options = {}) {
+function _bundleTranslation(gt, requests) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c;
         const controller = new AbortController();
         const signal = controller.signal;
-        if (options.timeout) {
-            setTimeout(() => controller.abort(), options.timeout);
+        if ((_c = (_b = (_a = requests[0]) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.metadata) === null || _c === void 0 ? void 0 : _c.timeout) {
+            setTimeout(() => controller.abort(), requests[0].data.metadata.timeout);
         }
         try {
             const response = yield fetch(`${gt.baseURL}/bundle`, {

package/dist/translation/_updateRemoteDictionary.d.ts

@@ -0,0 +1,15 @@
+export type Update = {
+    type: 'react';
+    data: {
+        children: object | string;
+        targetLanguage?: string;
+        metadata: Record<string, any>;
+    };
+} | {
+    type: 'intl';
+    data: {
+        content: string;
+        targetLanguage?: string;
+        metadata: Record<string, any>;
+    };
+};

package/dist/translation/_updateRemoteDictionary.js

@@ -0,0 +1,46 @@
+"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 = _updateRemoteDictionary;
+/**
+ * Pushes updates to a remotely cached translation dictionary.
+ * @param {{ baseURL: string, apiKey: string }} gt - Contains the baseURL and apiKey for the server request.
+ * @param {Update[]} updates - Array of requests to be processed and sent.
+ * @returns {Promise<boolean>} A promise that resolves to an array of processed results.
+ * @internal
+ */
+function _updateRemoteDictionary(gt, updates) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const response = yield fetch(`${gt.baseURL}/update`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    'gtx-api-key': gt.apiKey,
+                },
+                body: JSON.stringify(updates)
+            });
+            if (!response.ok) {
+                throw new Error(`${response.status}: ${yield response.text()}`);
+            }
+            const result = yield response.json();
+            return result.success;
+        }
+        catch (error) {
+            if (error instanceof Error && error.name === 'AbortError') {
+                console.error('Request timed out');
+                return false;
+            }
+            console.error(error);
+            return false;
+        }
+    });
+}

package/package.json

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

package/dist/translation/_bundleRequests.d.ts

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