generaltranslation 2.0.55 → 2.0.57

package/dist/translation/_updateProjectDictionary.js

@@ -0,0 +1,83 @@
+"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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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;
+        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 1:
+                    response = _d.sent();
+                    if (!!response.ok) return [3 /*break*/, 3];
+                    _a = Error.bind;
+                    _c = (_b = "".concat(response.status, ": ")).concat;
+                    return [4 /*yield*/, response.text()];
+                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.languages];
+                case 5:
+                    error_1 = _d.sent();
+                    if (error_1 instanceof Error && error_1.name === 'AbortError') {
+                        console.error('Request timed out');
+                        return [2 /*return*/, []];
+                    }
+                    console.error(error_1);
+                    return [2 /*return*/, []];
+                case 6: return [2 /*return*/];
+            }
+        });
+    });
+}

package/package.json

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

package/dist/cjs/index.js

@@ -1,143 +0,0 @@
-"use strict";
-// `generaltranslation` language toolkit
-// © 2024, General Translation, Inc.
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.standardizeLanguageCode = exports.isValidLanguageCode = exports.getLanguageDirection = void 0;
-exports.getLanguageObject = getLanguageObject;
-exports.getLanguageCode = getLanguageCode;
-exports.getLanguageName = getLanguageName;
-exports.isSameLanguage = isSameLanguage;
-// ----- IMPORTS ----- //
-const codes_1 = require("./codes/codes");
-const getLanguageDirection_1 = __importDefault(require("./codes/getLanguageDirection"));
-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) {
-        return process.env[VARIABLE] || '';
-    }
-    return '';
-};
-/**
- * GT is the core driver for the General Translation library.
- */
-class GT {
-    /**
-     * Constructs an instance of the GT class.
-     *
-     * @param {GTConstructorParams} [params] - The parameters for initializing the GT instance.
-     * @param {string} [params.apiKey=''] - The API key for accessing the translation service.
-     * @param {string} [params.defaultLanguage='en'] - The default language for translations.
-     * @param {string} [params.projectID=''] - The project ID for the translation service.
-     * @param {string} [params.baseURL='https://prod.gtx.dev'] - The base URL for the translation service.
-     */
-    constructor({ apiKey = '', defaultLanguage = 'en', projectID = '', baseURL = 'https://prod.gtx.dev' } = {}) {
-        this.apiKey = apiKey || getDefaultFromEnv('GT_API_KEY');
-        this.projectID = projectID || getDefaultFromEnv('GT_PROJECT_ID');
-        this.defaultLanguage = defaultLanguage.toLowerCase();
-        this.baseURL = baseURL;
-    }
-    /**
-    * Translates a string into a target language.
-    * @param {string} content - A string to translate.
-    * @param {string} targetLanguage - The target language for the translation.
-    * @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.
-    */
-    async translate(content, targetLanguage, metadata) {
-        return await (0, _translate_1.default)(this, content, targetLanguage, { projectID: this.projectID, defaultLanguage: this.defaultLanguage, ...metadata });
-    }
-    /**
-    * 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 {dictionaryName?: string, context?: 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.
-    */
-    async intl(content, targetLanguage, projectID, metadata) {
-        return await (0, _intl_1.default)(this, content, targetLanguage, projectID || this.projectID, { projectID: projectID || this.projectID, defaultLanguage: this.defaultLanguage, ...metadata });
-    }
-    /**
-    * Translates the content of React children elements.
-    *
-    * @param {Object} params - The parameters for the translation.
-    * @param {any} params.content - 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.
-    */
-    async translateReactChildren(content, targetLanguage, metadata) {
-        return await (0, _translateReactChildren_1.default)(this, content, targetLanguage, { projectID: this.projectID, defaultLanguage: this.defaultLanguage, ...metadata });
-    }
-    /**
-    * 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.
-    */
-    async bundleTranslation(requests) {
-        return (0, _bundleTranslation_1.default)(this, requests);
-    }
-    /**
-    * Pushes updates to a remotely cached translation dictionary.
-    * @param {Update[]} updates - Array of updates with optional targetLanguage.
-    * @param {string[]} [languages] - Array of languages to be updated.
-    * @param {string} [projectID=this.projectID] - The ID of the project. Defaults to the instance's projectID.
-    * @param {boolean} [replace=false] - Whether to replace the existing dictionary. Defaults to false.
-    * @returns {Promise<string[]>} A promise that resolves to an array of strings indicating the languages which have been updated.
-    */
-    async updateRemoteDictionary(updates, languages = [], projectID = this.projectID, replace = false) {
-        return (0, _updateRemoteDictionary_1.default)(this, updates, languages, projectID, replace);
-    }
-}
-// ----- EXPORTS ----- //
-// Export the class
-exports.default = GT;
-// Export the functions 
-/**
- * Gets the writing direction for a given BCP 47 language code.
- * @param {string} code - The BCP 47 language code to check.
- * @returns {string} The language direction ('ltr' for left-to-right or 'rtl' for right-to-left).
- */
-const getLanguageDirection = (code) => (0, getLanguageDirection_1.default)(code);
-exports.getLanguageDirection = getLanguageDirection;
-/**
- * Checks if a given BCP 47 language code is valid.
- * @param {string} code - The BCP 47 language code to validate.
- * @returns {boolean} True if the BCP 47 code is valid, false otherwise.
- */
-const isValidLanguageCode = (code) => (0, codes_1._isValidLanguageCode)(code);
-exports.isValidLanguageCode = isValidLanguageCode;
-/**
- * Standardizes a BCP 47 language code to ensure correct formatting.
- * @param {string} code - The BCP 47 language code to standardize.
- * @returns {string} The standardized BCP 47 language code.
- */
-const standardizeLanguageCode = (code) => (0, codes_1._standardizeLanguageCode)(code);
-exports.standardizeLanguageCode = standardizeLanguageCode;
-function getLanguageObject(codes) {
-    return Array.isArray(codes) ? (0, codes_1._getLanguageObject)(codes) : (0, codes_1._getLanguageObject)(codes);
-}
-function getLanguageCode(languages) {
-    return (0, codes_1._getLanguageCode)(languages);
-}
-function getLanguageName(codes) {
-    return (0, codes_1._getLanguageName)(codes);
-}
-/**
- * Checks if multiple BCP 47 language codes represent the same language.
- * @param {string[]} codes - The BCP 47 language codes to compare.
- * @returns {boolean} True if all BCP 47 codes represent the same language, false otherwise.
- */
-function isSameLanguage(...codes) {
-    return (0, codes_1._isSameLanguage)(...codes);
-}
-;

package/dist/cjs/translation/_bundleTranslation.d.ts

@@ -1,22 +0,0 @@
-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/cjs/translation/_bundleTranslation.js

@@ -1,42 +0,0 @@
-"use strict";
-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
- */
-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/cjs/translation/_intl.js

@@ -1,52 +0,0 @@
-"use strict";
-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
-*/
-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/cjs/translation/_translate.js

@@ -1,51 +0,0 @@
-"use strict";
-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
- */
-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/cjs/translation/_translateReactChildren.js

@@ -1,56 +0,0 @@
-"use strict";
-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
-**/
-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/cjs/translation/_updateRemoteDictionary.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = _updateRemoteDictionary;
-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 [];
-    }
-}