@kudoai/chatgpt.js 3.6.2 → 3.7.0

package/docs/USERGUIDE.md

@@ -25,6 +25,7 @@
     - [getUserLanguage](#getuserlanguage)
     - [isFullScreen](#isfullscreen)
     - [isLoaded `async`](#isloaded-async)
+    - [isTempChat](#istempchat)
     - [printAllFunctions](#printallfunctions)
     - [randomFloat](#randomfloat)
     - [renderHTML](#renderhtml)
@@ -45,6 +46,7 @@
   - [User session](#user-session)
     - [getAccessToken `async`](#getaccesstoken-async)
     - [getAccountDetails `async`](#getaccountdetails-async)
+    - [login](#login)
     - [logout](#logout)
   - [Chats](#chats)
     - [askAndGetReply `async`](#askandgetreply-async)
@@ -52,6 +54,7 @@
     - [exportChat `async`](#exportchat-async)
     - [getChatData `async`](#getchatdata-async)
     - [getChatInput](#getchatinput)
+    - [getErrorMsg](#geterrormsg)
     - [getLastPrompt `async`](#getlastprompt-async)
     - [getLastResponse `async`](#getlastresponse-async)
     - [getResponse](#getresponse)
@@ -74,12 +77,14 @@
     - [getContinueButton](#getContinueButton)
     - [getFooterDiv](#getfooterdiv)
     - [getHeaderDiv](#getheaderdiv)
+    - [getLoginButton](#getloginbutton)
     - [getNewChatButton](#getnewchatbutton)
     - [getNewChatLink](#getnewchatlink)
     - [getRegenerateButton](#getregeneratebutton)
     - [getScrollToBottomButton](#getscrolltobottombutton)
     - [getSendButton](#getsendbutton)
     - [getStopGeneratingButton](#getstopgeneratingbutton)
+    - [getVoiceButton](#getVoiceButton)
     - [hideFooter](#hidefooter)
     - [hideHeader](#hideheader)
     - [showFooter](#showfooter)
@@ -160,7 +165,7 @@
 
 ```js
 (async () => {
-    await import('https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.6.2/dist/chatgpt.min.js');
+    await import('https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.7.0/dist/chatgpt.min.js');
     // Your code here...
 })();
 ```
@@ -169,7 +174,7 @@
 
 ```js
 var xhr = new XMLHttpRequest();
-xhr.open('GET', 'https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.6.2/dist/chatgpt.min.js');
+xhr.open('GET', 'https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.7.0/dist/chatgpt.min.js');
 xhr.onload = function () {
     if (xhr.status === 200) {
         var chatgptJS = document.createElement('script');
@@ -191,7 +196,7 @@ function yourCode() {
 
 ```js
 ...
-// @require https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.6.2/dist/chatgpt.min.js
+// @require https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.7.0/dist/chatgpt.min.js
 // ==/UserScript==
 
 // Your code here...
@@ -329,6 +334,18 @@ Example code:
 })();
 ```
 
+### isTempChat
+
+Returns a boolean value. `true` if the website is in Temporary Chat mode and `false` otherwise.
+
+Example code:
+
+```js
+if (chatgpt.isTempChat()) {
+    // Do something
+}
+```
+
 ### printAllFunctions
 
 Prints all the library functions to the console.
@@ -621,6 +638,16 @@ Can be the following: `email`, `id`, `image`, `name`, `picture`. If a single det
 })();
 ```
 
+### login
+
+Navs to login page.
+
+Example code:
+
+```js
+chatgpt.login();
+```
+
 ### logout
 
 Logs out the user from the website.
@@ -846,6 +873,17 @@ const chatInput = chatgpt.getChatInput();
 chatgpt.alert(chatInput); // Example output: 'Hello from chatgpt.js!'
 ```
 
+### getErrorMsg
+
+Returns the error message (if any) of the last generation as a string.
+
+Example code:
+
+```js
+const chatErrorMsg = chatgpt.getErrorMsg();
+chatgpt.alert(chatErrorMsg); // Example output: 'Conversation not found'
+```
+
 ### getLastPrompt `async`
 
 Returns the last message sent by the user as a string.
@@ -1122,6 +1160,17 @@ const headerDiv = chatgpt.getHeaderDiv();
 headerDiv.style.display = none; // hide the header
 ```
 
+### getLoginButton
+
+Returns the login button as an HTML element.
+
+Example code:
+
+```js
+const loginBtn = chatgpt.getLoginButton();
+loginBtn.click(); // navs to login page
+```
+
 ### getNewChatButton
 
 Returns the sidebar button (w/ icon) that creates a new chat as an HTML element.
@@ -1188,6 +1237,17 @@ const stopBtn = chatgpt.getStopGeneratingButton();
 stopBtn.click();
 ```
 
+### getVoiceButton
+
+Returns the chatbar button that activates Voice mode as an HTML element.
+
+Example code:
+
+```js
+const voiceBtn = chatgpt.getVoiceButton();
+getVoiceButton.click(); // activates Voice mode
+```
+
 ### hideFooter
 
 Hides the footer div.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kudoai/chatgpt.js",
-  "version": "3.6.2",
+  "version": "3.7.0",
   "description": "Client-side JavaScript library for ChatGPT",
   "author": {
     "name": "KudoAI & contributors",
@@ -67,18 +67,18 @@
   "bugs": "https://github.com/KudoAI/chatgpt.js/issues",
   "devDependencies": {
     "@adamlui/minify.js": "^1.8.5",
-    "@adamlui/scss-to-css": "^1.10.25",
-    "@eslint/css": "^0.2.0",
+    "@adamlui/scss-to-css": "^1.10.26",
+    "@eslint/css": "^0.3.0",
     "@eslint/json": "^0.10.0",
     "@eslint/markdown": "^6.2.2",
-    "@html-eslint/eslint-plugin": "^0.34.0",
-    "@html-eslint/parser": "^0.34.0",
-    "@stylistic/eslint-plugin-js": "^3.1.0",
+    "@html-eslint/eslint-plugin": "^0.35.0",
+    "@html-eslint/parser": "^0.35.0",
+    "@stylistic/eslint-plugin-js": "^4.0.1",
     "docsify-cli": "^4.4.4",
-    "eslint": "^9.20.0",
+    "eslint": "^9.20.1",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-regexp": "^2.7.0",
-    "eslint-plugin-yml": "^1.16.0",
+    "eslint-plugin-yml": "^1.17.0",
     "get-port": "^7.1.0",
     "husky": "^9.1.7"
   }

package/starters/chrome/extension/components/icons.js

@@ -3,7 +3,7 @@
 window.icons = {
     import(deps) { Object.assign(this.imports = this.imports || {}, deps) },
 
-    create({ name, size = 16, width, height, ...additionalAttrs }) {
+    create(name, { size = 16, width, height, ...additionalAttrs } = {}) {
         const iconData = icons[name],
               iconAttrs = { width: width || size, height: height || size, ...additionalAttrs }
         if (iconData.type == 'svg') {

package/starters/chrome/extension/components/modals.js

@@ -9,16 +9,19 @@ window.modals = {
     about() {
 
         // Show modal
+        const labelStyles = 'text-transform: uppercase ; font-size: 17px ; font-weight: bold ;'
+                          + `color: ${ this.imports.env.ui.scheme == 'dark' ? 'white' : '#494141' }`
         const aboutModal = this.alert(
             `${this.imports.app.symbol} ${chrome.runtime.getManifest().name}`, // title
-            '🧠 Author: ' // msg
-                + `<a href="${this.imports.app.author.url}">${this.imports.app.author.name}</a> `
+            `<span style="${labelStyles}">🧠 Author:</span> `
+            + `<a href="${this.imports.app.author.url}">${this.imports.app.author.name}</a> `
                     + `& <a href="${this.imports.app.urls.contributors}">contributors</a>\n`
-            + `🏷️ Version: <span class="about-em">${this.imports.app.version}</span>\n`
-            + '📜 Open source code: '
+            + `<span style="${labelStyles}">🏷️ Version:</span> `
+                    + `<span class="about-em">${this.imports.app.version}</span>\n`
+            + `<span style="${labelStyles}">📜 Open source code:</span> `
                 + `<a href="${this.imports.app.urls.gitHub}" target="_blank" rel="nopener">`
                     + this.imports.app.urls.gitHub + '</a>\n'
-            + '⚡ Powered by: '
+            + `<span style="${labelStyles}">⚡ Powered by:</span> `
                 + `<a href="${this.imports.app.urls.chatgptJS}" target="_blank" rel="noopener">chatgpt.js</a>`,
             [ function getSupport(){}, function rateUs(){}, function moreAiExtensions(){} ], // button labels
             '', 656 // modal width

package/starters/chrome/extension/content.js

@@ -12,7 +12,7 @@
     env.browser.isPortrait = env.browser.isMobile && (window.innerWidth < window.innerHeight)
 
     // Import APP data
-    const { app } = await chrome.storage.sync.get('app')
+    const { app } = await chrome.storage.local.get('app')
 
     // Export DEPENDENCIES to imported resources
     dom.import({ env }) // for env.ui.scheme
@@ -24,12 +24,14 @@
             notify(...['msg', 'pos', 'notifDuration', 'shadow'].map(arg => req.options[arg]))
         else if (req.action == 'alert')
             modals.alert(...['title', 'msg', 'btns', 'checkbox', 'width'].map(arg => req.options[arg]))
-        else if (req.action == 'showAbout') chatgpt.isLoaded().then(() => { modals.open('about') })
-        else if (req.action == 'syncConfigToUI') syncConfigToUI(req.options)
+        else if (req.action == 'showAbout') {
+            config.skipAlert = true ; chatgpt.isLoaded().then(() => modals.open('about'))
+        } else if (req.action == 'syncConfigToUI') syncConfigToUI(req.options)
     })
 
     // Init SETTINGS
-    await settings.load(Object.keys(settings.controls), 'skipAlert')
+    await settings.load(Object.keys(settings.controls))
+    if (!config.skipAlert) await settings.load('skipAlert') // only if not showing About modal
 
     // Define FUNCTIONS
 
@@ -48,7 +50,7 @@
             const stateStyles = {
                 on: {
                     light: 'color: #5cef48 ; text-shadow: rgba(255,250,169,0.38) 2px 1px 5px',
-                    dark:  'color: #5cef48 ; text-shadow: rgb(55, 255, 0) 3px 0 10px'
+                    dark:  'color: #5cef48 ; text-shadow: rgb(55,255,0) 3px 0 10px'
                 },
                 off: {
                     light: 'color: #ef4848 ; text-shadow: rgba(255,169,225,0.44) 2px 1px 5px',
@@ -99,7 +101,7 @@
         modals.alert('≫ ChatGPT extension loaded! 🚀', // title
             'Success! Press Ctrl+Shift+J to view all chatgpt.js methods.', // msg
             function getHelp() { // button
-                chrome.tabs.create({ url: `${app.urls.gitHub}/issues` }) },
+                open(`${app.urls.gitHub}/issues`) },
             function dontShowAgain() { // checkbox
                 settings.save('skipAlert', !config.skipAlert) }
         )