@kudoai/chatgpt.js 2.9.3 → 3.0.1

package/docs/USERGUIDE.md

@@ -23,11 +23,8 @@
     - [generateRandomIP](#generaterandomip)
     - [get](#get)
     - [getUserLanguage](#getuserlanguage)
-    - [isChromium](#ischromium)
-    - [isFirefox](#isfirefox)
     - [isFullScreen](#isfullscreen)
     - [isLoaded `async`](#isloaded-async)
-    - [isMobileDevice](#ismobiledevice)
     - [printAllFunctions](#printallfunctions)
     - [randomFloat](#randomfloat)
     - [renderHTML](#renderhtml)
@@ -71,6 +68,7 @@
     - [startNewChat](#startnewchat)
     - [stop](#stop)
   - [DOM related](#dom-related)
+    - [focusChatbar](#focuschatbar)
     - [getChatBox](#getchatbox)
     - [getContinueGeneratingButton](#getcontinuegeneratingbutton)
     - [getFooterDiv](#getfooterdiv)
@@ -93,14 +91,18 @@
   - [browser `api`](#browser-api)
       - [isLightMode](#islightmode-1)
       - [isDarkMode](#isdarkmode-1)
-      - [isChromium](#ischromium-1)
-      - [isFirefox](#isfirefox-1)
+      - [isChromium](#ischromium)
+      - [isChrome](#ischrome)
+      - [isEdge](#isedge)
+      - [isBrave](#isbrave)
+      - [isFirefox](#isfirefox)
       - [isFullScreen](#isfullscreen-1)
       - [isMobile](#ismobile)
   - [code `api`](#code-api)
     - [minify `async`](#minify-async)
     - [execute `async`](#execute-async)
     - [extract](#extract)
+    - [isIdle `async`](#isidle-async-1)
     - [obfuscate `async`](#obfuscate-async)
     - [refactor `async`](#refactor-async)
     - [review `async`](#review-async)
@@ -148,7 +150,7 @@
 
 ```js
 (async () => {
-    await import('https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@2.9.3/dist/chatgpt.min.js');
+    await import('https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.0.1/dist/chatgpt.min.js');
     // Your code here...
 })();
 ```
@@ -157,7 +159,7 @@
 
 ```js
 var xhr = new XMLHttpRequest();
-xhr.open('GET', 'https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@2.9.3/dist/chatgpt.min.js');
+xhr.open('GET', 'https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.0.1/dist/chatgpt.min.js');
 xhr.onload = function () {
     if (xhr.status === 200) {
         var chatgptJS = document.createElement('script');
@@ -179,7 +181,7 @@ function yourCode() {
 
 ```js
 ...
-// @require https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@2.9.3/dist/chatgpt.min.js
+// @require https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.0.1/dist/chatgpt.min.js
 // ==/UserScript==
 
 // Your code here...
@@ -288,30 +290,6 @@ const userLanguage = chatgpt.getUserLanguage();
 console.log(userLanguage); // Example output: 'en-US'
 ```
 
-### isChromium
-
-Returns a boolean value. `true` if the browser is Chromium and `false` otherwise.
-
-Example code:
-
-```js
-if (chatgpt.isChromium()) {
-    // Do something
-}
-```
-
-### isFirefox
-
-Returns a boolean value. `true` if the browser is Firefox and `false` otherwise.
-
-Example code:
-
-```js
-if (chatgpt.isFirefox()) {
-    // Do something
-}
-```
-
 ### isFullScreen
 
 Returns a boolean value. `true` if the website is fullscreen and `false` otherwise.
@@ -337,18 +315,6 @@ Example code:
 })();
 ```
 
-### isMobileDevice
-
-Returns a boolean value. `true` if the user device is mobile and `false` otherwise.
-
-Example code:
-
-```js
-if (chatgpt.isMobileDevice()) {
-    // Do something
-}
-```
-
 ### printAllFunctions
 
 Prints all the library functions to the console.
@@ -668,11 +634,13 @@ Example code:
 
 ### clearChats `async`
 
-**Parameters**:
+Clears chat history.
 
-`method` (optional): The string `'api'` or `'dom'` representing the method to use.
+Example code:
 
-> **Note** _The API method does not update DOM chat list (until session refresh)_
+```js
+chatgpt.clearChats().then(() => console.log('Chat history cleared!'));
+```
 
 ### exportChat `async`
 
@@ -933,15 +901,14 @@ console.log(fifthResp); // Example output: 'Hello from ChatGPT!'
 
 ### isIdle `async`
 
-Returns a boolean value. `true` if ChatGPT has finished generating a response, `false` otherwise.
+Resolves a promise when ChatGPT has finished generating a response.
 
 Example code:
 
 ```js
 (async () => {
-    if (await chatgpt.isIdle()) {
-        // Do something
-    }
+    await chatgpt.code.isIdle();
+    console.log('ChatGPT is idle');
 })();
 ```
 
@@ -1070,6 +1037,16 @@ chatgpt.stop();
 
 ## DOM related
 
+### focusChatbar
+
+Focuses the chatbar.
+
+Example code:
+
+```js
+chatgpt.focusChatbar();
+```
+
 ### getChatBox
 
 Returns the chat input as an HTML element.
@@ -1122,7 +1099,7 @@ Example code:
 
 ```js
 const newChatBtn = chatgpt.getNewChatButton();
-newChatBtn.click();
+newChatBtn.style.display = 'none'; // hide New Chat button
 ```
 
 ### getNewChatLink
@@ -1133,7 +1110,7 @@ Example code:
 
 ```js
 const newChatLink = chatgpt.getNewChatLink();
-newChatLink.click();
+newChatLink.style.display = 'none'; // hide New Chat link
 ```
 
 ### getRegenerateButton
@@ -1295,6 +1272,42 @@ if (chatgpt.browser.isChromium()) {
 }
 ```
 
+### isChrome
+
+Returns a boolean value. `true` if the browser is Chrome and `false` otherwise.
+
+Example code:
+
+```js
+if (chatgpt.browser.isChrome()) {
+    // Do something
+}
+```
+
+### isEdge
+
+Returns a boolean value. `true` if the browser is Edge and `false` otherwise.
+
+Example code:
+
+```js
+if (chatgpt.browser.isEdge()) {
+    // Do something
+}
+```
+
+### isBrave
+
+Returns a boolean value. `true` if the browser is Brave and `false` otherwise.
+
+Example code:
+
+```js
+if (chatgpt.browser.isBrave()) {
+    // Do something
+}
+```
+
 ### isFirefox
 
 Returns a boolean value. `true` if the browser is Firefox and `false` otherwise.
@@ -1414,6 +1427,20 @@ Example code:
 })();
 ```
 
+### isIdle `async`
+
+Resolves a promise when code has finished generating.
+
+Example code:
+
+```js
+(async () => {
+    chatgpt.send('Type me a short code block');
+    await chatgpt.code.isIdle();
+    console.log('Code finished generating'); // non-code may still be generating
+})();
+```
+
 ### obfuscate `async`
 
 Asks ChatGPT to obfuscate the given code.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kudoai/chatgpt.js",
-  "version": "2.9.3",
+  "version": "3.0.1",
   "description": "Client-side JavaScript library for ChatGPT",
   "author": {
     "name": "KudoAI & contributors",
@@ -64,11 +64,11 @@
     "url": "https://github.com/sponsors/KudoAI"
   },
   "devDependencies": {
-    "@adamlui/minify.js": "^1.7.0",
-    "@adamlui/scss-to-css": "^1.10.0",
+    "@adamlui/minify.js": "^1.8.1",
+    "@adamlui/scss-to-css": "^1.10.3",
     "docsify-cli": "^4.4.4",
-    "eslint": "^9.3.0",
-    "eslint-plugin-json-schema-validator": "^5.1.0",
-    "husky": "^9.0.11"
+    "eslint": "^9.5.0",
+    "eslint-plugin-json": "^4.0.0",
+    "husky": "^9.1.0"
   }
 }

package/starters/chrome/LICENSE.md

@@ -1,8 +1,8 @@
 <div align="center">
     <h6>
         <picture>
-            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://media.chatgptjs.org/images/icons/earth-americas-white-icon32.svg">
-            <img height=14 src="https://media.chatgptjs.org/images/icons/earth-americas-icon32.svg">
+            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://media.chatgptjs.org/images/icons/earth-americas-white-icon32.svg?main">
+            <img height=14 src="https://media.chatgptjs.org/images/icons/earth-americas-icon32.svg?main">
         </picture>
         &nbsp;English |
         <a href="docs/zh-cn/LICENSE.md">简体中文</a> |

package/starters/chrome/docs/README.md

@@ -1,8 +1,8 @@
 <div align="center">
     <h6>
         <picture>
-            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://media.chatgptjs.org/images/icons/earth-americas-white-icon32.svg">
-            <img height=14 src="https://media.chatgptjs.org/images/icons/earth-americas-icon32.svg">
+            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://media.chatgptjs.org/images/icons/earth-americas-white-icon32.svg?main">
+            <img height=14 src="https://media.chatgptjs.org/images/icons/earth-americas-icon32.svg?main">
         </picture>
         &nbsp;English |
         <a href="zh-cn#readme">简体中文</a> |

package/starters/chrome/docs/SECURITY.md

@@ -1,8 +1,8 @@
 <div align="right">
     <h6>
         <picture>
-            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://media.chatgptjs.org/images/icons/earth-americas-white-icon32.svg">
-            <img height=14 src="https://media.chatgptjs.org/images/icons/earth-americas-icon32.svg">
+            <source type="image/svg+xml" media="(prefers-color-scheme: dark)" srcset="https://media.chatgptjs.org/images/icons/earth-americas-white-icon32.svg?main">
+            <img height=14 src="https://media.chatgptjs.org/images/icons/earth-americas-icon32.svg?main">
         </picture>
         &nbsp;English |
         <a href="https://github.com/KudoAI/chatgpt.js-chrome-starter/blob/main/docs/zh-cn/SECURITY.md">简体中文</a> |