@kudoai/chatgpt.js 3.2.1 → 3.3.1

package/docs/USERGUIDE.md

@@ -70,7 +70,7 @@
   - [DOM related](#dom-related)
     - [focusChatbar](#focuschatbar)
     - [getChatBox](#getchatbox)
-    - [getContinueGeneratingButton](#getcontinuegeneratingbutton)
+    - [getContinueButton](#getContinueButton)
     - [getFooterDiv](#getfooterdiv)
     - [getHeaderDiv](#getheaderdiv)
     - [getNewChatButton](#getnewchatbutton)
@@ -108,6 +108,14 @@
     - [review `async`](#review-async)
     - [unminify `async`](#unminify-async)
     - [write `async`](#write-async)
+  - [footer `api`](#footer-api)
+    - [get](#get)
+    - [hide](#hide)
+    - [show](#show)
+  - [header `api`](#header-api)
+    - [get](#get-1)
+    - [hide](#hide-1)
+    - [show](#show-1)
   - [history `api`](#history-api)
     - [isLoaded](#isloaded-async-1)
   - [instructions `api`](#instructions-api)
@@ -121,7 +129,7 @@
     - [close](#close)
   - [response `api`](#response-api)
     - [continue](#continue)
-    - [get](#get-1)
+    - [get](#get-2)
     - [getFromAPI `async`](#getfromapi-async)
     - [getFromDOM](#getfromdom)
     - [getLast `async`](#getlast-async)
@@ -135,11 +143,12 @@
       - [toggle](#toggle-1)
   - [sidebar `api`](#sidebar-api)
     - [append](#append)
-    - [isOn](#ison-1)
-    - [isOff](#isoff-1)
-    - [hide](#hide)
-    - [show](#show)
-    - [toggle](#toggle-2)
+    - [exists](#exists)
+    - [isOn](#ison)
+    - [isOff](#isoff)
+    - [hide](#hide-2)
+    - [show](#show-2)
+    - [toggle](#toggle-1)
     - [isLoaded](#isloaded-async-2)
 
 # Importing the library
@@ -150,7 +159,7 @@
 
 ```js
 (async () => {
-    await import('https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.2.1/dist/chatgpt.min.js');
+    await import('https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.3.1/dist/chatgpt.min.js');
     // Your code here...
 })();
 ```
@@ -159,7 +168,7 @@
 
 ```js
 var xhr = new XMLHttpRequest();
-xhr.open('GET', 'https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.2.1/dist/chatgpt.min.js');
+xhr.open('GET', 'https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.3.1/dist/chatgpt.min.js');
 xhr.onload = function () {
     if (xhr.status === 200) {
         var chatgptJS = document.createElement('script');
@@ -181,7 +190,7 @@ function yourCode() {
 
 ```js
 ...
-// @require https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.2.1/dist/chatgpt.min.js
+// @require https://cdn.jsdelivr.net/npm/@kudoai/chatgpt.js@3.3.1/dist/chatgpt.min.js
 // ==/UserScript==
 
 // Your code here...
@@ -234,8 +243,8 @@ Example code:
 ```js
 (async () => {
     const language = await chatgpt.detectLanguage('我是一個大男孩');
-    console.log(language);
-    /* Logs:
+    chatgpt.alert(language);
+    /* Alerts:
     Chinese (Traditional) */
 })();
 ```
@@ -252,7 +261,7 @@ Example code:
 
 ```js
 (async () => {
-    console.log(await chatgpt.executeCode('return 6 + 5')); // logs '11'
+    chatgpt.alert(await chatgpt.executeCode('return 6 + 5')); // logs '11'
 })();
 ```
 
@@ -264,7 +273,7 @@ Example code:
 
 ```js
 const randomIP = chatgpt.generateRandomIP();
-console.log(randomIP); // Example output: '161.192.110.125'
+chatgpt.alert(randomIP); // Example output: '161.192.110.125'
 ```
 
 ### get
@@ -287,7 +296,7 @@ Example code:
 
 ```js
 const userLanguage = chatgpt.getUserLanguage();
-console.log(userLanguage); // Example output: 'en-US'
+chatgpt.alert(userLanguage); // Example output: 'en-US'
 ```
 
 ### isFullScreen
@@ -306,12 +315,16 @@ if (chatgpt.isFullScreen()) {
 
 Resolves a promise when ChatGPT has finished loading.
 
+**Parameters**:
+
+`timeout` (optional): An integer specifying the number of milliseconds to wait before resolving with `false`. If not provided, waits indefinitely until ChatGPT finishes loading.
+
 Example code:
 
 ```js
 (async () => {
     await chatgpt.isLoaded();
-    console.log('ChatGPT has finished loading.');
+    chatgpt.alert('ChatGPT has finished loading.');
 })();
 ```
 
@@ -333,7 +346,7 @@ Example code:
 
 ```js
 const randomNumber = chatgpt.randomFloat();
-console.log(randomNumber); // Example output: 0.9472113021060851
+chatgpt.alert(randomNumber); // Example output: 0.9472113021060851
 ```
 
 ### renderHTML
@@ -368,7 +381,7 @@ Example code:
 (async () => {
     const text = 'Are you an #OSS supporter? Do you love JavaScript? Then why not contribute to the future of #AI app development? https://chatgpt.js.org (a #100Builders project) is seeking collabs for exactly this! @withBackdrop';
     const sentiment = await chatgpt.sentiment(text, '100 Builders');
-    console.log(sentiment);
+    chatgpt.alert(sentiment);
 
     /* Example output:
     The sentiment of the text towards the entity "100 Builders" is strongly positive. The text encourages
@@ -394,7 +407,7 @@ Example code:
 ```js
 (async () => {
     const suggestions = await chatgpt.suggest('names', 'baby boy');
-    console.log(suggestions);
+    chatgpt.alert(suggestions);
 
     /* Example output:
     1. Liam
@@ -433,7 +446,7 @@ Example code:
 ```js
 (async () => {
     const summary = await chatgpt.summarize('A very long text...');
-    console.log(summary); // Example output: 'A very short text...'
+    chatgpt.alert(summary); // Example output: 'A very short text...'
 })();
 ```
 
@@ -452,7 +465,7 @@ Example code:
 ```js
 (async () => {
     const translation = await chatgpt.translate('Hello, how are you?', 'spanish');
-    console.log(translation); // Logs: 'Hola, ¿cómo estás?'
+    chatgpt.alert(translation); // Alerts: 'Hola, ¿cómo estás?'
 })();
 ```
 
@@ -462,7 +475,7 @@ Example code:
 
 ```js
 const randomID = chatgpt.uuidv4();
-console.log(randomID); // Example output: '239067d1-bcb8-4fd7-91eb-9ab94619b7b3'
+chatgpt.alert(randomID); // Example output: '239067d1-bcb8-4fd7-91eb-9ab94619b7b3'
 ```
 
 ## Page theme
@@ -494,7 +507,7 @@ Returns a boolean value. `true` if the theme is dark mode, `false` otherwise.
 Example code:
 
 ```js
-console.log(chatgpt.settings.scheme.isDark()); // logs `true` or `false`
+chatgpt.alert(chatgpt.settings.scheme.isDark()); // logs `true` or `false`
 ```
 
 ### isLightMode
@@ -504,7 +517,7 @@ Returns a boolean value. `true` if the theme is light mode, `false` otherwise.
 Example code:
 
 ```js
-console.log(chatgpt.settings.scheme.isDark()); // logs `true` or `false`
+chatgpt.alert(chatgpt.settings.scheme.isDark()); // logs `true` or `false`
 ```
 
 ### toggleScheme
@@ -542,10 +555,10 @@ function doSomething() { /* Your code */ }
 
 function doSomethingElse() { /* Your code */ }
 
-function sayHello() { console.log('Hello!'); }
+function sayHello() { chatgpt.alert('Hello!'); }
 
 const alertID = chatgpt.alert('Hello, world!', 'The sky is blue.', [doSomething, doSomethingElse], sayHello, 200);
-console.log(alertID); // Example output: '1693237957878'
+chatgpt.alert(alertID); // Example output: '1693237957878'
 ```
 
 ### notify
@@ -577,7 +590,7 @@ Returns an account access token as a string.
 ```js
 (async () => {
     const token = await chatgpt.getAccessToken();
-    console.log(token); // Example output: 'abcdef[...]'
+    chatgpt.alert(token); // Example output: 'abcdef[...]'
 })();
 ```
 
@@ -594,10 +607,10 @@ Can be the following: `email`, `id`, `image`, `name`, `picture`. If a single det
 ```js
 (async () => {
     const accountName = await chatgpt.getAccountDetails('name');
-    console.log(accountName); // Example output: 'chatgpt.js'
+    chatgpt.alert(accountName); // Example output: 'chatgpt.js'
 
     const accountData = await chatgpt.getAccountDetails('name', 'email');
-    console.log(accountData);
+    chatgpt.alert(accountData);
     /* Example output:
     {
         name: 'chatgpt.js',
@@ -628,7 +641,7 @@ Example code:
 ```js
 (async () => {
     const response = await chatgpt.askAndGetReply('Hello, ChatGPT');
-    console.log(response); // Example output: 'Hello user, I'm ChatGPT!'
+    chatgpt.alert(response); // Example output: 'Hello user, I'm ChatGPT!'
 })();
 ```
 
@@ -639,7 +652,7 @@ Clears chat history.
 Example code:
 
 ```js
-chatgpt.clearChats().then(() => console.log('Chat history cleared!'));
+chatgpt.clearChats().then(() => chatgpt.alert('Chat history cleared!'));
 ```
 
 ### exportChat `async`
@@ -829,7 +842,7 @@ Example code:
 
 ```js
 const chatInput = chatgpt.getChatInput();
-console.log(chatInput); // Example output: 'Hello from chatgpt.js!'
+chatgpt.alert(chatInput); // Example output: 'Hello from chatgpt.js!'
 ```
 
 ### getLastPrompt `async`
@@ -839,7 +852,7 @@ Returns the last message sent by the user as a string.
 ```js
 (async () => {
     const message = await chatgpt.getLastPrompt();
-    console.log(message); // Example output: 'Hello from chatgpt.js!'
+    chatgpt.alert(message); // Example output: 'Hello from chatgpt.js!'
 })();
 ```
 
@@ -850,15 +863,15 @@ Returns the last ChatGPT response as a string.
 ```js
 (async () => {
     const response = await chatgpt.getLastResponse();
-    console.log(response); // Example output: 'I am ChatGPT!'
+    chatgpt.alert(response); // Example output: 'I am ChatGPT!'
 })();
 ```
 
 ### getResponse
 
-If it's a previously created chat, read [chatgpt.getResponseFromDOM](#getresponsefromdom)
+If it's a previously created chat, see [chatgpt.getResponseFromDOM](#getresponsefromdom)
 
-If it's a new chat, read [chatgpt.getResponseFromAPI](#getresponsefromapi-async)
+If it's a new chat, see [chatgpt.getResponseFromAPI](#getresponsefromapi-async)
 
 ### getResponseFromAPI `async`
 
@@ -875,7 +888,7 @@ Example code:
 ```js
 (async () => {
     const response = chatgpt.getResponseFromAPI();
-    console.log(response); // Example output: 'Hello from ChatGPT!'
+    chatgpt.alert(response); // Example output: 'Hello from ChatGPT!'
 })();
 ```
 
@@ -896,19 +909,23 @@ fifthResp = chatgpt.getResponseFromDOM(5); // Returns the 5th response
 fifthResp = chatgpt.getResponseFromDOM('fifth'); // Also returns the 5th response
 fifthResp = chatgpt.getResponseFromDOM('five'); // Returns the 5th response too
 
-console.log(fifthResp); // Example output: 'Hello from ChatGPT!'
+chatgpt.alert(fifthResp); // Example output: 'Hello from ChatGPT!'
 ```
 
 ### isIdle `async`
 
 Resolves a promise when ChatGPT has finished generating a response.
 
+**Parameters**:
+
+`timeout` (optional): An integer specifying the number of milliseconds to wait before resolving with `false`. If not provided, waits indefinitely until response generation finishes.
+
 Example code:
 
 ```js
 (async () => {
     await chatgpt.code.isIdle();
-    console.log('ChatGPT is idle');
+    chatgpt.alert('ChatGPT is idle');
 })();
 ```
 
@@ -1055,17 +1072,17 @@ Example code:
 
 ```js
 const chatbox = chatgpt.getChatBox();
-console.log(chatbox.value); // Example output: 'Hello from chatgpt.js!'
+chatgpt.alert(chatbox.value); // Example output: 'Hello from chatgpt.js!'
 ```
 
-### getContinueGeneratingButton
+### getContinueButton
 
 Returns the 'Continue generating' button as an HTML element.
 
 Example code:
 
 ```js
-const continueBtn = chatgpt.getContinueGeneratingButton();
+const continueBtn = chatgpt.getContinueButton();
 continueBtn.click();
 ```
 
@@ -1235,7 +1252,7 @@ Example code:
 
 ```js
 const timeStamp = chatgpt.autoRefresh.nowTimeStamp();
-console.log(timeStamp); // Example output: '1:56:25 PM'
+chatgpt.alert(timeStamp); // Example output: '1:56:25 PM'
 ```
 
 ## browser `api`
@@ -1247,7 +1264,7 @@ Returns a boolean value. `true` if system/browser scheme preference is set to li
 Example code:
 
 ```js
-console.log(chatgpt.browser.isLightMode()); // logs `true` or `false`
+chatgpt.alert(chatgpt.browser.isLightMode()); // logs `true` or `false`
 ```
 
 ### isDarkMode
@@ -1257,7 +1274,7 @@ Returns a boolean value. `true` if system/browser scheme preference is set to da
 Example code:
 
 ```js
-console.log(chatgpt.browser.isDarkMode()); // logs `true` or `false`
+chatgpt.alert(chatgpt.browser.isDarkMode()); // logs `true` or `false`
 ```
 
 ### isChromium
@@ -1369,9 +1386,9 @@ Example code:
             replyBox.style.height = replyBox.scrollHeight + 'px'
             prevLength = newLength
         }`);
-    console.log(minifiedCode);
+    chatgpt.alert(minifiedCode);
 
-    /* Logs:
+    /* Alerts:
     'function autosizeBox(){const n=replyBox.value.length;if(n<prevLength){replyBox.style.height='auto';if(parseInt(getComputedStyle(replyBox).height)<55){replyBox.style.height='2.15rem'}}replyBox.style.height=replyBox.scrollHeight+'px';prevLength=n}' */
 })();
 ```
@@ -1388,7 +1405,7 @@ Example code:
 
 ```js
 (async () => {
-    console.log(await chatgpt.code.execute('return 6 + 5')); // logs '11'
+    chatgpt.alert(await chatgpt.code.execute('return 6 + 5')); // logs '11'
 })();
 ```
 
@@ -1408,9 +1425,9 @@ Example code:
     await chatgpt.isIdle();
     const response = await chatgpt.getChatData('active', 'msg', 'chatgpt', 'latest'),
           scriptCode = chatgpt.code.extract(response);
-    console.log(scriptCode);
+    chatgpt.alert(scriptCode);
 
-    /* Logs:    
+    /* Alerts:    
     const fs = require('fs');
 
     // Specify the path of the file(s) you want to delete
@@ -1421,7 +1438,7 @@ Example code:
         if (err) {
             console.error('Error deleting file:', err);
         } else {
-            console.log('File deleted successfully');
+            chatgpt.alert('File deleted successfully');
         }
     }); */
 })();
@@ -1431,13 +1448,17 @@ Example code:
 
 Resolves a promise when code has finished generating.
 
+**Parameters**:
+
+`timeout` (optional): An integer specifying the number of milliseconds to wait before resolving with `false`. If not provided, waits indefinitely until code generation finishes.
+
 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
+    chatgpt.alert('Code finished generating'); // non-code may still be generating
 })();
 ```
 
@@ -1455,9 +1476,9 @@ Example code:
 (async () => {
     const code = `window[elem].addEventListener('mouseover', toggleTooltip)`
     const obfuscatedCode = await chatgpt.code.obfuscate(code);
-    console.log(obfuscatedCode);
+    chatgpt.alert(obfuscatedCode);
 
-    /* Logs:
+    /* Alerts:
     '(window[elem])[btoa('YWxlcnRWaWV3')](btoa('bW91c2VyYm94ZXJOYW1l'), btoa('dG9nZ2VkT3V0d2FsbA==')); */
 })();
 ```
@@ -1483,9 +1504,9 @@ Example code:
             return false;
         }`;
     const refactoredCode = await chatgpt.code.refactor(code, 'brevity');
-    console.log(refactoredCode);
+    chatgpt.alert(refactoredCode);
 
-    /* Logs:
+    /* Alerts:
     return 6 > 5; */
 })();
 ```
@@ -1502,7 +1523,7 @@ Example code:
 
 ```js
 (async () => {
-    console.log(await chatgpt.code.review('btoa("Hello World")'));
+    chatgpt.alert(await chatgpt.code.review('btoa("Hello World")'));
 
     /* Example output:
     The code appears to be correct. It uses the `btoa` function to encode the string "Hello World" in base64. */
@@ -1524,9 +1545,9 @@ Example code:
     const code = `function autosizeBox(){const n=replyBox.value.length;if(n<prevLength){replyBox.style.height='auto';if(parseInt(getComputedStyle(replyBox).height)<55){replyBox.style.height='2.15rem'}}replyBox.style.height=replyBox.scrollHeight+'px';prevLength=n}`;
 
     const minifiedCode = await chatgpt.code.unminify(code);
-    console.log(minifiedCode);
+    chatgpt.alert(minifiedCode);
 
-    /* Logs:
+    /* Alerts:
     function autosizeBox() {
         const newLength = replyBox.value.length
         if (newLength < prevLength) { // if deleting txt
@@ -1555,15 +1576,85 @@ Example code:
 ```js
 (async () => {
     const code = await chatgpt.code.write('Repeat a task every 10 seconds', 'javascript');
-    console.log(code);
+    chatgpt.alert(code);
 
-    /* Logs:
+    /* Alerts:
     setInterval(function() {
         // Your task code here
     }, 10000); */
 })();
 ```
 
+## footer `api`
+
+API related to the footer.
+
+### get
+
+Returns the footer div as an HTML element.
+
+Example code:
+
+```js
+const footerDiv = chatgpt.footer.get();
+footerDiv.style.padding = '15px'; // make the footer taller
+```
+
+### hide
+
+Hides the footer div.
+
+Example code:
+
+```js
+chatgpt.footer.hide()
+```
+
+### show
+
+Shows the footer div if hidden.
+
+Example code:
+
+```js
+chatgpt.footer.show()
+```
+
+## header `api`
+
+API related to the header.
+
+### get
+
+Returns the header div as an HTML element.
+
+Example code:
+
+```js
+const headerDiv = chatgpt.header.get();
+headerDiv.style.display = none; // hide the header
+```
+
+### hide
+
+Hides the header div.
+
+Example code:
+
+```js
+chatgpt.header.hide()
+```
+
+### show
+
+Shows the header div if hidden.
+
+Example code:
+
+```js
+chatgpt.header.show()
+```
+
 ## history `api`
 
 API related to the chat history.
@@ -1572,12 +1663,16 @@ API related to the chat history.
 
 Resolves a promise when chat history has finished loading.
 
+**Parameters**:
+
+`timeout` (optional): An integer specifying the number of milliseconds to wait before resolving with `false`. If not provided, waits indefinitely until chat history finishes loading.
+
 Example code:
 
 ```js
 (async () => {
     await chatgpt.history.isLoaded();
-    console.log('ChatGPT history has finished loading.');
+    chatgpt.alert('ChatGPT history has finished loading.');
 })();
 ```
 
@@ -1693,29 +1788,29 @@ chatgpt.response.continue();
 
 ### get
 
-If it's a previously created chat, read [chatgpt.getResponseFromDOM](#getresponsefromdom)
+If it's a previously created chat, see [chatgpt.getResponseFromDOM](#getresponsefromdom)
 
-If it's a new chat, read [chatgpt.getResponseFromAPI](#getresponsefromapi-async)
+If it's a new chat, see [chatgpt.getResponseFromAPI](#getresponsefromapi-async)
 
 ### getFromAPI `async`
 
-Read [chatgpt.getResponseFromAPI](#getresponsefromapi-async)
+See [chatgpt.getResponseFromAPI](#getresponsefromapi-async)
 
 ### getFromDOM
 
-Read [chatgpt.getResponseFromDOM](#getresponsefromdom)
+See [chatgpt.getResponseFromDOM](#getresponsefromdom)
 
 ### getLast `async`
 
-Read [chatgpt.getLastResponse](#getlastresponse-async)
+See [chatgpt.getLastResponse](#getlastresponse-async)
 
 ### regenerate
 
-Read [chatgpt.regenerate](#regenerate)
+See [chatgpt.regenerate](#regenerate)
 
 ### stopGenerating
 
-Read [chatgpt.stop](#stop)
+See [chatgpt.stop](#stop)
 
 ## settings `api`
 
@@ -1730,7 +1825,7 @@ Returns a boolean value. `true` if the theme is dark mode, `false` otherwise.
 Example code:
 
 ```js
-console.log(chatgpt.settings.scheme.isDark()); // logs `true` or `false`
+chatgpt.alert(chatgpt.settings.scheme.isDark()); // logs `true` or `false`
 ````
 
 #### isLight
@@ -1740,7 +1835,7 @@ Returns a boolean value. `true` if the theme is light mode, `false` otherwise.
 Example code:
 
 ```js
-console.log(chatgpt.settings.scheme.isLight()); // logs `true` or `false`
+chatgpt.alert(chatgpt.settings.scheme.isLight()); // logs `true` or `false`
 ````
 
 #### set
@@ -1811,10 +1906,10 @@ const buttonId = chatgpt.sidebar.append('button', {
     label: 'I am a button!',
     icon: 'https://chat.openai.com/favicon-32x32.png',
     onclick: function() {
-        console.log('Clicked!');
+        chatgpt.alert('Clicked!');
     }
 });
-console.log(buttonId); // Example output: 1693295258727
+chatgpt.alert(buttonId); // Example output: 1693295258727
 
 const dropdownId = chatgpt.sidebar.append('dropdown', {
     items: [
@@ -1822,7 +1917,18 @@ const dropdownId = chatgpt.sidebar.append('dropdown', {
         { text: 'Hello there', value: 'hellothere' }
     ]
 });
-console.log(dropdownId); // Example output: 1693294795240
+chatgpt.alert(dropdownId); // Example output: 1693294795240
+```
+
+### exists
+
+Returns a boolean value. `true` if the sidebar exists , `false` otherwise (e.g. logged out UI).
+
+Example code:
+
+```js
+if (!chatgpt.sidebar.exists())
+    chatgpt.alert('Sidebar is missing!')
 ```
 
 ### isOn
@@ -1881,14 +1987,18 @@ chatgpt.sidebar.toggle();
 
 ### isLoaded `async`
 
-Resolves a promise when the ChatGPT sidebar has finished loading. (Times out 5s after New Chat button loads, since New Chat link does not always appear.)
+Resolves a promise when the ChatGPT sidebar has finished loading.
+
+**Parameters**:
+
+`timeout` (optional): An integer specifying the number of milliseconds to wait before resolving with `false`. If not provided, waits 5s or until New Chat link appears (since it is not always present).
 
 Example code:
 
 ```js
 (async () => {
     await chatgpt.sidebar.isLoaded();
-    console.log('ChatGPT sidebar has finished loading.');
+    chatgpt.alert('ChatGPT sidebar has finished loading.');
 })();
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kudoai/chatgpt.js",
-  "version": "3.2.1",
+  "version": "3.3.1",
   "description": "Client-side JavaScript library for ChatGPT",
   "author": {
     "name": "KudoAI & contributors",
@@ -69,6 +69,6 @@
     "docsify-cli": "^4.4.4",
     "eslint": "^9.10.0",
     "eslint-plugin-json": "^4.0.1",
-    "husky": "^9.1.5"
+    "husky": "^9.1.6"
   }
 }