generaltranslation 2.0.14 → 2.0.16

package/README.md

@@ -4,7 +4,7 @@
 
 A language toolkit for AI developers. Used in `gt-react`.
 
-Full documentation coming soon!
+Full documentation: <a href='https://docs.generaltranslation.com'>docs.generaltranslation.com</a>.
 
 ## Getting Started
 
@@ -76,4 +76,133 @@ Checks if a given set of codes are all equivalent to the same language. Returns
 ```
 const same = isSameLanguage('en', 'en-US', 'en-GB');
 console.log(same) // true
-```
+```
+
+### getLanguageDirection(code)
+
+Returns the text direction ('rtl' for right-to-left or 'ltr' for left-to-right) for a given language code.
+
+```
+const direction = getLanguageDirection('ar');
+console.log(direction) // 'rtl'
+
+const direction = getLanguageDirection('en');
+console.log(direction) // 'ltr'
+```
+
+### isValidLanguageCode(code)
+
+Checks if a given language-country-script code is valid. Returns a boolean indicating validity.
+
+```javascript
+const isValid = isValidLanguageCode('en-US');
+console.log(isValid) // true
+
+const isValid = isValidLanguageCode('invalid-code');
+console.log(isValid) // false
+```
+
+## `GT` Class
+
+The `GT` class is the core driver for the General Translation library. It provides various methods for translating content, handling internationalization, and managing translation requests.
+
+### Constructor
+
+The `GT` class constructor initializes an instance of the GT class with optional parameters.
+
+```javascript
+const gt = new GT({
+    apiKey: 'your-api-key',
+    defaultLanguage: 'en',
+    projectID: 'your-project-id',
+    baseURL: 'https://prod.gtx.dev'
+});
+```
+
+#### Parameters
+
+- `apiKey` (string): The API key for accessing the translation service. Defaults to an empty string.
+- `defaultLanguage` (string): The default language for translations. Defaults to 'en'.
+- `projectID` (string): The project ID for the translation service. Defaults to an empty string.
+- `baseURL` (string): The base URL for the translation service. Defaults to 'https://prod.gtx.dev'.
+
+### Methods
+
+#### `translate(content: string, targetLanguage: string, metadata?: { notes?: string, [key: string]: any }): Promise<{ translation: string, error?: Error | unknown }>`
+
+Translates a string into a target language.
+
+```javascript
+const result = await gt.translate('Hello', 'es');
+console.log(result.translation); // 'Hola'
+```
+
+#### Parameters
+
+- `content` (string): The string to translate.
+- `targetLanguage` (string): The target language for the translation.
+- `metadata` (object): Additional metadata for the translation request.
+
+#### Returns
+
+- A promise that resolves to an object containing the translated content and optional error information.
+
+#### `intl(content: string, targetLanguage: string, projectID?: string, metadata?: { page?: string, notes?: string, [key: string]: any }): Promise<{ translation: string, error?: Error | unknown }>`
+
+Translates a string and caches it for use in a public project.
+
+```javascript
+const result = await gt.intl('Hello', 'es', 'your-project-id');
+console.log(result.translation); // 'Hola'
+```
+
+#### Parameters
+
+- `content` (string): The string to translate.
+- `targetLanguage` (string): The target language for the translation.
+- `projectID` (string): The ID of the project. Defaults to the instance's projectID.
+- `metadata` (object): Additional metadata for the translation request.
+
+#### Returns
+
+- A promise that resolves to an object containing the translated content and optional error information.
+
+#### `translateReactChildren(content: any, targetLanguage: string, metadata?: { [key: string]: any }): Promise<{ translation: any | null, error?: Error | unknown }>`
+
+Translates the content of React children elements.
+
+```javascript
+const result = await gt.translateReactChildren(<div>Hello</div>, 'es');
+console.log(result.translation); // <div>Hola</div>
+```
+
+#### Parameters
+
+- `content` (any): The React children content to be translated.
+- `targetLanguage` (string): The target language for the translation.
+- `metadata` (object): Additional metadata for the translation process.
+
+#### Returns
+
+- A promise that resolves to an object containing the translated content and optional error information.
+
+#### `bundleRequests(requests: any[]): Promise<Array<any | null>>`
+
+Bundles multiple requests and sends them to the server.
+
+```javascript
+const requests = [
+    { content: 'Hello', targetLanguage: 'es' },
+    { content: 'World', targetLanguage: 'fr' }
+];
+const results = await gt.bundleRequests(requests);
+console.log(results); // ['Hola', 'Monde']
+```
+
+#### Parameters
+
+- `requests` (array): Array of requests to be processed and sent.
+
+#### Returns
+
+- A promise that resolves to an array of processed results.

package/dist/codes/codes.js

@@ -38,9 +38,11 @@ const Predefined = Predefined_json_1.default;
  * @returns {boolean} - Returns true if valid, false otherwise.
  */
 function _isValidLanguageCode(code) {
-    if (!code)
+    if (!code || typeof code !== 'string')
         return false;
     try {
+        if (!_mapCodeToLanguage(code.split('-')[0]))
+            return false;
         const locale = new Intl.Locale(code);
         const { language, script, region } = locale;
         const constructedCode = `${language}${script ? '-' + script : ''}${region ? '-' + region : ''}`;

package/dist/codes/getLanguageDirection.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get the text direction for a given language code.
+ *
+ * @param {string} code - The language code to check.
+ * @returns {string} - 'rtl' if the language is right-to-left, otherwise 'ltr'.
+ */
+export default function _getLanguageDirection(code: string): string;

package/dist/codes/getLanguageDirection.js

@@ -0,0 +1,70 @@
+"use strict";
+/* ----- BEGIN YAHOO COPYRIGHT ----- */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = _getLanguageDirection;
+/*
+
+Copyright 2015 Yahoo Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+* Neither the name of the Yahoo Inc. nor the
+  names of its contributors may be used to endorse or promote products
+  derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL YAHOO! INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+*/
+/**
+ * List of languages that are written from right to left.
+ * Each entry contains the language code and the language name.
+ *
+ * @type {string[]}
+ */
+const rtlLanguages = [
+    'ae', /* Avestan */
+    'ar', /* 'العربية', Arabic */
+    'arc', /* Aramaic */
+    'bcc', /* 'بلوچی مکرانی', Southern Balochi */
+    'bqi', /* 'بختياري', Bakthiari */
+    'ckb', /* 'Soranî / کوردی', Sorani */
+    'dv', /* Dhivehi */
+    'fa', /* 'فارسی', Persian */
+    'glk', /* 'گیلکی', Gilaki */
+    'he', /* 'עברית', Hebrew */
+    'ku', /* 'Kurdî / كوردی', Kurdish */
+    'mzn', /* 'مازِرونی', Mazanderani */
+    'nqo', /* N'Ko */
+    'pnb', /* 'پنجابی', Western Punjabi */
+    'prs', /* 'دری', Darī */
+    'ps', /* 'پښتو', Pashto, */
+    'sd', /* 'سنڌي', Sindhi */
+    'ug', /* 'Uyghurche / ئۇيغۇرچە', Uyghur */
+    'ur', /* 'اردو', Urdu */
+    'yi' /* 'ייִדיש', Yiddish */
+];
+/* ----- END YAHOO COPYRIGHT ----- */
+const codes_1 = require("./codes");
+/**
+ * Get the text direction for a given language code.
+ *
+ * @param {string} code - The language code to check.
+ * @returns {string} - 'rtl' if the language is right-to-left, otherwise 'ltr'.
+ */
+function _getLanguageDirection(code) {
+    return rtlLanguages.some(language => {
+        const lo = (0, codes_1._getLanguageObject)(language);
+        const clo = (0, codes_1._getLanguageObject)(code);
+        if (!lo || !clo)
+            return false;
+        if (lo.script && clo.script && lo.script !== clo.script)
+            return false;
+        return (0, codes_1._isSameLanguage)(code, language);
+    }) ? 'rtl' : 'ltr';
+}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { _isValidLanguageCode, _getLanguageObject, _isSameLanguage } from './codes/codes';
+import _getLanguageDirection from './codes/getLanguageDirection';
 /**
  * Type representing the constructor parameters for the GT class.
  */
@@ -80,6 +81,7 @@ declare class GT {
     bundleRequests(requests: any[]): Promise<Array<any | null>>;
 }
 export default GT;
+export declare const getLanguageDirection: typeof _getLanguageDirection;
 export declare const isValidLanguageCode: typeof _isValidLanguageCode;
 export declare const getLanguageObject: typeof _getLanguageObject;
 export declare const getLanguageCode: (languages: string | string[]) => string | string[];

package/dist/index.js

@@ -14,9 +14,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSameLanguage = exports.getLanguageName = exports.getLanguageCode = exports.getLanguageObject = exports.isValidLanguageCode = void 0;
+exports.isSameLanguage = exports.getLanguageName = exports.getLanguageCode = exports.getLanguageObject = exports.isValidLanguageCode = exports.getLanguageDirection = void 0;
 // ----- IMPORTS ----- //
 const codes_1 = require("./codes/codes");
+const getLanguageDirection_1 = __importDefault(require("./codes/getLanguageDirection"));
 const _bundleRequests_1 = __importDefault(require("./translation/_bundleRequests"));
 const _intl_1 = __importDefault(require("./translation/_intl"));
 const _translate_1 = __importDefault(require("./translation/_translate"));
@@ -105,6 +106,7 @@ class GT {
 // Export the class
 exports.default = GT;
 // Export the functions 
+exports.getLanguageDirection = getLanguageDirection_1.default;
 exports.isValidLanguageCode = codes_1._isValidLanguageCode;
 exports.getLanguageObject = codes_1._getLanguageObject;
 exports.getLanguageCode = codes_1._getLanguageCode;

package/package.json

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