generaltranslation 1.1.25 → 1.1.27

package/README.md

@@ -14,18 +14,18 @@ Full documentation coming soon!
 npm i generaltranslation
 ```
 
-<b>In your code:</b>
+<b>In your code, import functions directly</b>
 
 ```
-import GT from 'generaltranslation'
-
-const gt = new GT()
+import { getLanguageName } from 'generaltranslation'
 ```
 
-or, import functions directly:
+or, to initialize a GT API client:
 
 ```
-import { getLanguageName } from 'generaltranslation'
+import GT from 'generaltranslation'
+
+const gt = new GT()
 ```
 
 ## Convert between languages and ISO-639 codes
@@ -35,10 +35,10 @@ import { getLanguageName } from 'generaltranslation'
 Returns a language name from a two or three-letter ISO-639 language code, or an array of codes.
 
 ```
-const language = gt.getLanguageName('en');
+const language = getLanguageName('en');
 console.log(language) // 'English'
 
-const languages = gt.getLanguageName(['fr', 'es'])
+const languages = getLanguageName(['fr', 'es'])
 console.log(languages) // ['French', 'Spanish']
 ```
 
@@ -47,10 +47,10 @@ console.log(languages) // ['French', 'Spanish']
 Returns an ISO-639 code from a language name or an array of language names.
 
 ```
-const code = gt.getLanguageCode('English');
+const code = getLanguageCode('English');
 console.log(language) // 'en'
 
-const codes = gt.getLanguageCodes(['French', 'Spanish'])
+const codes = getLanguageCodes(['French', 'Spanish'])
 console.log(codes) // ['fr', 'es']
 ```
 
@@ -58,25 +58,13 @@ console.log(codes) // ['fr', 'es']
 
 ### getUserLanguage() 
 
-Returns a user's default browser language. Meant for use in a web browser.
+Returns a user's default browser language. Meant for use in a web browser (i.e. on the client side).
 
 ```
 const userLanguage = getUserLanguage();
 console.log(userLanguage) // 'en'
 ```
 
-If invoked on an instance of the GT class, this function will return the default language of that instance, similar to accessing the `defaultLanguage` property.
-
-```
-import GT from 'generaltranslation'
-
-const gt = new GT({
-    defaultLanguage: 'en'
-});
-
-console.log(gt.getUserLanguage()) // same as gt.defaultLanguage
-```
-
 ## Prompt Internationalization API
 
 For this function, you need to sign up for an API key at <a href='https://generaltranslation.com' target='_blank'>generaltranslation.com</a>.
@@ -152,7 +140,7 @@ We continually benchmark AI models and add new models as they are released. That
 Get the latest list of models for which there is data. Returns an array of model names.
 
 ```
-const models = await gt.getModelList();
+const models = await getModelList();
 console.log(models) // ['gpt-4', ... ]
 ```
 
@@ -161,7 +149,7 @@ console.log(models) // ['gpt-4', ... ]
 Get all languages known to be compatible with a given AI model. Returns an array of languages codes, or null if the model is unknown.
 
 ```
-const languages = await gt.getModelLanguages('mixtral-8x7b')
+const languages = await getModelLanguages('mixtral-8x7b')
 console.log(languages) // ['en', 'fr', 'de', 'es', 'it']
 ```
 
@@ -170,6 +158,6 @@ console.log(languages) // ['en', 'fr', 'de', 'es', 'it']
 Returns true if a model is known to be compatible with a given language, represented by an ISO-639 language code. Returns false otherwise.
 
 ```
-const supported = await gt.isSupportedLanguage('gpt-4', 'fr')
+const supported = await isSupportedLanguage('gpt-4', 'fr')
 console.log(supported) // true
 ```

package/client/getUserLanguage.js

@@ -2,7 +2,7 @@
 // e.g. 'en-US', not necessarily 'en'
 // generaltranslation handles this well, but other libraries may not
 // (it's a skill issue I'm afraid) 
-export default function _getUserLanguage({defaultLanguage = ''} = {}) {
+export default function _getUserLanguage({ defaultLanguage = '' } = {}) {
     if (typeof window !== 'undefined' && window?.navigator) {
         return navigator?.language || navigator?.userLanguage || defaultLanguage || '';
     } else if (defaultLanguage) {

package/codes/codes.js

@@ -11,14 +11,14 @@ import LanguageToCodeTriletter from './639-3/LanguageToCodeTriletter.js'
 
 // Returns the name of a language from an ISO 639 code or an array of codes
 const _mapCodeToLanguage = code => {
-    if (code.length === 2) {
+    if (code?.length === 2) {
         return CodeToLanguage[code]
     } 
-    if (code.length === 3) {
+    if (code?.length === 3) {
         CodeToLanguageTriletter[code]
     }
     else {
-        return CodeToLanguage[code.slice(0, 2)] || '';
+        return CodeToLanguage[code?.slice(0, 2)] || '';
     }
 }
 export const _getLanguageName = codes => {
@@ -28,7 +28,7 @@ export const _getLanguageName = codes => {
 // Returns an ISO 639 code from a language name or an array of language names
 // Preferentially returns two-letter codes
 const _mapLanguageToCode = language => {
-    const lowerCaseLanguage = language.toLowerCase();
+    const lowerCaseLanguage = language?.toLowerCase();
     return LanguageToCode[lowerCaseLanguage] || LanguageToCodeTriletter[lowerCaseLanguage] || '';
 }
 export const _getLanguageCode = languages => {

package/index.js

@@ -6,7 +6,8 @@
 import _getUserLanguage from "./client/getUserLanguage.js";
 import { _getLanguageCode, _getLanguageName } from "./codes/codes.js"
 import { _getModelInfo, _getModelList, _getModelLanguages, _isLanguageSupported, _getModelsByDeveloper, _getModelsByLanguage } from "./models/models.js"
-import _translatePrompt from "./prompts/translate.js"
+import _translatePrompt from "./translate/prompt.js"
+import _createI18N from "./translate/site.js";
 
 // ----- CORE CLASS ----- // 
 
@@ -22,29 +23,22 @@ export default class GT {
         this.baseURL = baseURL;
     }
 
-    // Language code functions
-    getLanguageName = _getLanguageName; // e.g. 'en' => 'English'
-    getLanguageCode = _getLanguageCode; // e.g. 'English' => 'en'
-
-    // Model information functions
-    getModelList = _getModelList; // returns array of supported model names
-    getModelInfo = _getModelInfo; // returns model object
-    getModelLanguages = _getModelLanguages; // e.g. 'mistral-7b' => ['en']
-    isLanguageSupported = _isLanguageSupported; // e.g. ('mistral-7b', 'en') => true
-    getModelsByLanguage = _getModelsByLanguage; // returns array of model names
-    getModelsByDeveloper = _getModelsByDeveloper; // returns array of model names
-
-    // Get a user's browser language
-    getUserLanguage = () => {
-        return _getUserLanguage({
-            defaultLanguage: this.defaultLanguage
-        });
-    }
-
     // Prompt I18N
     translatePrompt = async (prompt, language) => {
         return await _translatePrompt({
-            content: prompt, language: language, context: this
+            content: prompt, language: language, config: this
+        });
+    }
+
+    // Site I18N
+    createI18N = async ({ projectID, html, strings, defaultLanguage, userLanguage }) => {
+        return await _createI18N({
+           projectID: projectID,
+           html: html,
+           strings: strings,
+           defaultLanguage: defaultLanguage,
+           userLanguage: userLanguage,
+           config: this
         });
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "1.1.25",
+  "version": "1.1.27",
   "description": "A language toolkit for AI developers",
   "main": "index.js",
   "type": "module",

package/{prompts/translate.js → translate/prompt.js}

@@ -65,15 +65,15 @@ const _constructPrompt = ({ content, untranslated = null}) => {
 // Get a translation via General Translation API
 // Returns string
 const _translatePrompt = async ({
-    content, language, context
+    content, language, config
 }) => {
     
-    const apiKey = context?.apiKey;
+    const apiKey = config?.apiKey;
     if (!apiKey) {
         throw new Error('Missing API Key!')
     };
 
-    const defaultLanguage = context?.defaultLanguage;
+    const defaultLanguage = config?.defaultLanguage;
     if (language === defaultLanguage) {
         return _constructPrompt({ content: content });
     };
@@ -81,7 +81,7 @@ const _translatePrompt = async ({
     const { processed, untranslated } = _processPrompt({ content });
     
     try {
-        const response = await fetch(`${context?.baseURL}/prompt`, {
+        const response = await fetch(`${config?.baseURL}/prompt`, {
             method: 'POST',
             headers: {
                 'Content-Type': 'application/json',

package/translate/site.js

@@ -0,0 +1,47 @@
+const _createI18N = async ({
+    projectID,
+    defaultLanguage,
+    userLanguage,
+    content,
+    metadata,
+    config
+}) => {
+
+    const apiKey = config?.apiKey;
+    if (!apiKey) {
+        throw new Error('Missing API Key!')
+    };
+
+    if (!projectID) {
+        throw new Error('Missing project ID!')
+    };
+
+    try {
+        const response = await fetch(`${config?.baseURL}/site`, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'gtx-api-key': apiKey
+            },
+            body: JSON.stringify({
+                projectID: projectID,
+                content: content,
+                defaultLanguage: defaultLanguage,
+                userLanguage: userLanguage,
+                metadata: metadata
+            })
+        })
+        if (!response.ok) {
+            const result = await response.text();
+            throw new Error(`${result || response.status}`);
+        } else {
+            const result = await response.json();
+            return result;
+        }
+    } catch (error) {
+        console.error(error)
+        return content;
+    }
+    
+}
+export default _createI18N;