generaltranslation 1.1.24 → 1.1.26

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,42 +47,22 @@ 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']
 ```
 
-## Which languages do AI models understand?
-
-We continually benchmark AI models and add new models as they are released. That means these functions have to be <code>async</code>. This information is provided as a public service. It's completely free and requires no API key.
-
-### async getModelList()
-
-Get the latest list of models for which there is data. Returns an array of model names.
-
-```
-const models = await gt.getModelList();
-console.log(models) // ['gpt-4', ... ]
-```
-
-### async getModelLanguages(model)
+## Get a user's language
 
-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.
+### getUserLanguage() 
 
-```
-const languages = await gt.getModelLanguages('mixtral-8x7b')
-console.log(languages) // ['en', 'fr', 'de', 'es', 'it']
-```
-
-### async isSupportedLanguage(model, code)
-
-Returns true if a model is known to be compatible with a given language, represented by an ISO-639 language code. Returns false otherwise.
+Returns a user's default browser language. Meant for use in a web browser (i.e. on the client side).
 
 ```
-const supported = await gt.isSupportedLanguage('gpt-4', 'fr')
-console.log(supported) // true
+const userLanguage = getUserLanguage();
+console.log(userLanguage) // 'en'
 ```
 
 ## Prompt Internationalization API
@@ -149,4 +129,35 @@ This also works:
 
 ```
 const translatedPrompt = await gt.translatePrompt({ text: 'Tell me a story' }, 'es');
-```
+```
+
+## Which languages do AI models understand?
+
+We continually benchmark AI models and add new models as they are released. That means these functions have to be <code>async</code>. This information is provided as a public service. It's completely free and requires no API key.
+
+### async getModelList()
+
+Get the latest list of models for which there is data. Returns an array of model names.
+
+```
+const models = await getModelList();
+console.log(models) // ['gpt-4', ... ]
+```
+
+### async getModelLanguages(model)
+
+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 getModelLanguages('mixtral-8x7b')
+console.log(languages) // ['en', 'fr', 'de', 'es', 'it']
+```
+
+### async isSupportedLanguage(model, code)
+
+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 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/index.js

@@ -17,28 +17,11 @@ export default class GT {
         defaultLanguage = 'en',
         baseURL = 'https://translate.gtx.dev'
     } = {}) {
-        this.apiKey = apiKey;
+        this.apiKey = apiKey || (typeof process !== 'undefined' ? process.env.GT_API_KEY : '');
         this.defaultLanguage = defaultLanguage;
         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(this.defaultLanguage);
-    }
-
     // Prompt I18N
     translatePrompt = async (prompt, language) => {
         return await _translatePrompt({

package/package.json

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