generaltranslation 2.0.53 → 2.0.55

package/dist/mjs/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: 'react';
+    data: {
+        children: object | string;
+        targetLanguage: string;
+        metadata: Record<string, any>;
+    };
+};

package/dist/mjs/translation/_bundleTranslation.js

@@ -0,0 +1,39 @@
+/**
+ * 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
+ */
+export default async function _bundleTranslation(gt, requests) {
+    const controller = new AbortController();
+    const signal = controller.signal;
+    if (requests[0]?.data?.metadata?.timeout) {
+        setTimeout(() => controller.abort(), requests[0].data.metadata.timeout);
+    }
+    try {
+        const response = await fetch(`${gt.baseURL}/bundle`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'gtx-api-key': gt.apiKey,
+            },
+            body: JSON.stringify(requests),
+            signal
+        });
+        if (!response.ok) {
+            throw new Error(`${response.status}: ${await response.text()}`);
+        }
+        const resultArray = await response.json();
+        return resultArray;
+    }
+    catch (error) {
+        if (error instanceof Error && error.name === 'AbortError') {
+            console.error('Request timed out');
+            return Array.from(requests, () => ({ translation: null, error: 'Request timed out' }));
+        }
+        console.error(error);
+        return Array.from(requests, () => ({ translation: null, error: error }));
+    }
+}

package/dist/mjs/translation/_intl.d.ts

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

package/dist/mjs/translation/_intl.js

@@ -0,0 +1,49 @@
+/**
+    * 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 {string} content - The content to translate.
+    * @param {string} targetLanguage - The target language for the translation.
+    * @param {string} projectID - The ID of the project
+    * @param {{ dictionaryName?: string, notes?: string, timeout?: number, [key: string]: any }} metadata - Additional metadata for the translation request.
+    * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
+    * @internal
+*/
+export default async function _translate(gt, content, targetLanguage, projectID, metadata) {
+    const controller = new AbortController();
+    const signal = controller.signal;
+    if (metadata.timeout) {
+        setTimeout(() => controller.abort(), metadata.timeout);
+    }
+    try {
+        const response = await fetch(`${gt.baseURL}/translate`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'gtx-api-key': gt.apiKey,
+            },
+            body: JSON.stringify({
+                content, targetLanguage, projectID, metadata
+            }),
+            signal
+        });
+        if (!response.ok) {
+            throw new Error(`${response.status}: ${await response.text()}`);
+        }
+        const result = await response.json();
+        return result;
+    }
+    catch (error) {
+        if (error instanceof Error && error.name === 'AbortError') {
+            console.error('Request timed out');
+            return {
+                translation: content,
+                error: 'Request timed out'
+            };
+        }
+        console.error(error);
+        return {
+            translation: content,
+            error: error
+        };
+    }
+}

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

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

package/dist/mjs/translation/_translate.js

@@ -0,0 +1,48 @@
+/**
+ * Translates a string.
+ * @param {{ baseURL: string, apiKey: string }} gt - The translation service configuration.
+ * @param {string} content - The content to translate.
+ * @param {string} targetLanguage - The target language for the translation.
+ * @param {{ notes?: string, timeout?: number, [key: string]: any }} metadata - Additional metadata for the translation request.
+ * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
+ * @internal
+ */
+export default async function _translate(gt, content, targetLanguage, metadata) {
+    const controller = new AbortController();
+    const signal = controller.signal;
+    if (metadata.timeout) {
+        setTimeout(() => controller.abort(), metadata.timeout);
+    }
+    try {
+        const response = await fetch(`${gt.baseURL}/translate`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'gtx-api-key': gt.apiKey,
+            },
+            body: JSON.stringify({
+                content, targetLanguage, metadata
+            }),
+            signal
+        });
+        if (!response.ok) {
+            throw new Error(`${response.status}: ${await response.text()}`);
+        }
+        const result = await response.json();
+        return result;
+    }
+    catch (error) {
+        if (error instanceof Error && error.name === 'AbortError') {
+            console.error('Request timed out');
+            return {
+                translation: content,
+                error: 'Request timed out'
+            };
+        }
+        console.error(error);
+        return {
+            translation: content,
+            error: error
+        };
+    }
+}

package/dist/mjs/translation/_translateReactChildren.d.ts

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

package/dist/mjs/translation/_translateReactChildren.js

@@ -0,0 +1,53 @@
+/**
+ * Translates the given content 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 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 {{ [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
+**/
+export default async function _translateReactChildren(gt, content, targetLanguage, metadata) {
+    const controller = new AbortController();
+    const signal = controller.signal;
+    if (metadata.timeout) {
+        setTimeout(() => controller.abort(), metadata.timeout);
+    }
+    try {
+        const response = await fetch(`${gt.baseURL}/react`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'gtx-api-key': gt.apiKey,
+            },
+            body: JSON.stringify({
+                content: content,
+                targetLanguage: targetLanguage,
+                metadata: metadata
+            }),
+            signal
+        });
+        if (!response.ok) {
+            throw new Error(`${response.status}: ${await response.text()}`);
+        }
+        return await response.json();
+    }
+    catch (error) {
+        if (error instanceof Error && error.name === 'AbortError') {
+            console.error('Request timed out');
+            return {
+                translation: null,
+                error: 'Request timed out'
+            };
+        }
+        console.error(error);
+        return {
+            translation: null,
+            error: error
+        };
+    }
+}

package/dist/mjs/translation/_updateRemoteDictionary.d.ts

@@ -0,0 +1,17 @@
+export type Update = {
+    type: 'react';
+    data: {
+        children: object | string;
+        metadata: Record<string, any>;
+    };
+} | {
+    type: 'intl';
+    data: {
+        content: string;
+        metadata: Record<string, any>;
+    };
+};
+export default function _updateRemoteDictionary(gt: {
+    baseURL: string;
+    apiKey: string;
+}, updates: Update[], languages: string[], projectID: string, replace: boolean): Promise<string[]>;

package/dist/mjs/translation/_updateRemoteDictionary.js

@@ -0,0 +1,27 @@
+export default async function _updateRemoteDictionary(gt, updates, languages, projectID, replace) {
+    try {
+        const response = await fetch(`${gt.baseURL}/update`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'gtx-api-key': gt.apiKey,
+            },
+            body: JSON.stringify({
+                updates, languages, projectID, replace
+            })
+        });
+        if (!response.ok) {
+            throw new Error(`${response.status}: ${await response.text()}`);
+        }
+        const result = await response.json();
+        return result.languages;
+    }
+    catch (error) {
+        if (error instanceof Error && error.name === 'AbortError') {
+            console.error('Request timed out');
+            return [];
+        }
+        console.error(error);
+        return [];
+    }
+}

package/package.json

@@ -1,15 +1,22 @@
 {
   "name": "generaltranslation",
-  "version": "2.0.53",
+  "version": "2.0.55",
   "description": "A language toolkit for AI developers",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "types": "dist/cjs/index.d.ts",
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsc",
-    "prepublishOnly": "npm run build"
+    "transpile": "rm -r -f dist; tsc; tsc --project tsconfig.cjs.json;",
+    "prepublishOnly": "npm run transpile"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/cjs/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/mjs/index.d.ts"
+    }
   },
   "repository": {
     "type": "git",

package/dist/translation/_bundleTranslation.js

@@ -1,54 +0,0 @@
-"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 = _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.
- * @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 _bundleTranslation(gt, requests) {
-    return __awaiter(this, void 0, void 0, function* () {
-        var _a, _b, _c;
-        const controller = new AbortController();
-        const signal = controller.signal;
-        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`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json',
-                    'gtx-api-key': gt.apiKey,
-                },
-                body: JSON.stringify(requests),
-                signal
-            });
-            if (!response.ok) {
-                throw new Error(`${response.status}: ${yield response.text()}`);
-            }
-            const resultArray = yield response.json();
-            return resultArray;
-        }
-        catch (error) {
-            if (error instanceof Error && error.name === 'AbortError') {
-                console.error('Request timed out');
-                return Array.from(requests, () => ({ translation: null, error: 'Request timed out' }));
-            }
-            console.error(error);
-            return Array.from(requests, () => ({ translation: null, error: error }));
-        }
-    });
-}

package/dist/translation/_intl.js

@@ -1,63 +0,0 @@
-"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;
-/**
-    * 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 {string} content - The content to translate.
-    * @param {string} targetLanguage - The target language for the translation.
-    * @param {string} projectID - The ID of the project
-    * @param {{ dictionaryName?: string, notes?: string, timeout?: number, [key: string]: any }} metadata - Additional metadata for the translation request.
-    * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
-    * @internal
-*/
-function _translate(gt, content, targetLanguage, projectID, metadata) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const controller = new AbortController();
-        const signal = controller.signal;
-        if (metadata.timeout) {
-            setTimeout(() => controller.abort(), metadata.timeout);
-        }
-        try {
-            const response = yield fetch(`${gt.baseURL}/translate`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json',
-                    'gtx-api-key': gt.apiKey,
-                },
-                body: JSON.stringify({
-                    content, targetLanguage, projectID, metadata
-                }),
-                signal
-            });
-            if (!response.ok) {
-                throw new Error(`${response.status}: ${yield response.text()}`);
-            }
-            const result = yield response.json();
-            return result;
-        }
-        catch (error) {
-            if (error instanceof Error && error.name === 'AbortError') {
-                console.error('Request timed out');
-                return {
-                    translation: content,
-                    error: 'Request timed out'
-                };
-            }
-            console.error(error);
-            return {
-                translation: content,
-                error: error
-            };
-        }
-    });
-}

package/dist/translation/_translate.js

@@ -1,62 +0,0 @@
-"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;
-/**
- * Translates a string.
- * @param {{ baseURL: string, apiKey: string }} gt - The translation service configuration.
- * @param {string} content - The content to translate.
- * @param {string} targetLanguage - The target language for the translation.
- * @param {{ notes?: string, timeout?: number, [key: string]: any }} metadata - Additional metadata for the translation request.
- * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
- * @internal
- */
-function _translate(gt, content, targetLanguage, metadata) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const controller = new AbortController();
-        const signal = controller.signal;
-        if (metadata.timeout) {
-            setTimeout(() => controller.abort(), metadata.timeout);
-        }
-        try {
-            const response = yield fetch(`${gt.baseURL}/translate`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json',
-                    'gtx-api-key': gt.apiKey,
-                },
-                body: JSON.stringify({
-                    content, targetLanguage, metadata
-                }),
-                signal
-            });
-            if (!response.ok) {
-                throw new Error(`${response.status}: ${yield response.text()}`);
-            }
-            const result = yield response.json();
-            return result;
-        }
-        catch (error) {
-            if (error instanceof Error && error.name === 'AbortError') {
-                console.error('Request timed out');
-                return {
-                    translation: content,
-                    error: 'Request timed out'
-                };
-            }
-            console.error(error);
-            return {
-                translation: content,
-                error: error
-            };
-        }
-    });
-}

package/dist/translation/_translateReactChildren.js

@@ -1,67 +0,0 @@
-"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 = _translateReactChildren;
-/**
- * Translates the given content 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 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 {{ [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 _translateReactChildren(gt, content, targetLanguage, metadata) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const controller = new AbortController();
-        const signal = controller.signal;
-        if (metadata.timeout) {
-            setTimeout(() => controller.abort(), metadata.timeout);
-        }
-        try {
-            const response = yield fetch(`${gt.baseURL}/react`, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json',
-                    'gtx-api-key': gt.apiKey,
-                },
-                body: JSON.stringify({
-                    content: content,
-                    targetLanguage: targetLanguage,
-                    metadata: metadata
-                }),
-                signal
-            });
-            if (!response.ok) {
-                throw new Error(`${response.status}: ${yield response.text()}`);
-            }
-            return yield response.json();
-        }
-        catch (error) {
-            if (error instanceof Error && error.name === 'AbortError') {
-                console.error('Request timed out');
-                return {
-                    translation: null,
-                    error: 'Request timed out'
-                };
-            }
-            console.error(error);
-            return {
-                translation: null,
-                error: error
-            };
-        }
-    });
-}

package/dist/translation/_updateRemoteDictionary.js

@@ -1,41 +0,0 @@
-"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;
-function _updateRemoteDictionary(gt, updates, languages, projectID, replace) {
-    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, languages, projectID, replace
-                })
-            });
-            if (!response.ok) {
-                throw new Error(`${response.status}: ${yield response.text()}`);
-            }
-            const result = yield response.json();
-            return result.languages;
-        }
-        catch (error) {
-            if (error instanceof Error && error.name === 'AbortError') {
-                console.error('Request timed out');
-                return [];
-            }
-            console.error(error);
-            return [];
-        }
-    });
-}