From c1634b0537f163711e89815a6d463aa73606b36f Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Mon, 12 Dec 2022 10:37:44 -0600 Subject: [PATCH 1/8] feat: add additional options to better control debugging; add some inline docs --- src/chatgpt-api.ts | 64 ++++++++++++++++++++++++++++++++++------------ src/types.ts | 3 +++ 2 files changed, 50 insertions(+), 17 deletions(-) diff --git a/src/chatgpt-api.ts b/src/chatgpt-api.ts index 8a4bf3e6..8022b4f0 100644 --- a/src/chatgpt-api.ts +++ b/src/chatgpt-api.ts @@ -16,27 +16,32 @@ export class ChatGPTAPI { protected _sessionToken: string protected _clearanceToken: string protected _markdown: boolean + protected _debug: boolean protected _apiBaseUrl: string protected _backendApiBaseUrl: string protected _userAgent: string protected _headers: Record + protected _user: types.User | null = null // Stores access tokens for `accessTokenTTL` milliseconds before needing to refresh protected _accessTokenCache: ExpiryMap - protected _user: types.User | null = null - /** * Creates a new client wrapper around the unofficial ChatGPT REST API. * * @param opts.sessionToken = **Required** OpenAI session token which can be found in a valid session's cookies (see readme for instructions) + * @param opts.clearanceToken = **Required** Cloudflare `cf_clearance` cookie value (see readme for instructions) * @param apiBaseUrl - Optional override; the base URL for ChatGPT webapp's API (`/api`) * @param backendApiBaseUrl - Optional override; the base URL for the ChatGPT backend API (`/backend-api`) * @param userAgent - Optional override; the `user-agent` header to use with ChatGPT requests * @param accessTokenTTL - Optional override; how long in milliseconds access tokens should last before being forcefully refreshed + * @param accessToken - Optional default access token if you already have a valid one generated + * @param heaaders - Optional additional HTTP headers to be added to each `fetch` request + * @param debug - Optional enables logging debugging into to stdout */ constructor(opts: { sessionToken: string + clearanceToken: string /** @defaultValue `true` **/ @@ -48,15 +53,20 @@ export class ChatGPTAPI { /** @defaultValue `'https://chat.openai.com/backend-api'` **/ backendApiBaseUrl?: string - /** @defaultValue `'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36'` **/ + /** @defaultValue `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36'` **/ userAgent?: string - /** @defaultValue 1 hour */ + /** @defaultValue 1 hour **/ accessTokenTTL?: number + /** @defaultValue `undefined` **/ accessToken?: string + /** @defaultValue `undefined` **/ headers?: Record + + /** @defaultValue `false` **/ + debug?: boolean }) { const { sessionToken, @@ -67,12 +77,14 @@ export class ChatGPTAPI { userAgent = USER_AGENT, accessTokenTTL = 60 * 60000, // 1 hour accessToken, - headers + headers, + debug = false } = opts this._sessionToken = sessionToken this._clearanceToken = clearanceToken this._markdown = !!markdown + this._debug = !!debug this._apiBaseUrl = apiBaseUrl this._backendApiBaseUrl = backendApiBaseUrl this._userAgent = userAgent @@ -124,6 +136,8 @@ export class ChatGPTAPI { * @param message - The prompt message to send * @param opts.conversationId - Optional ID of a conversation to continue * @param opts.parentMessageId - Optional ID of the previous message in the conversation + * @param opts.messageId - Optional ID of the message to send (defaults to a random UUID) + * @param opts.action - Optional ChatGPT `action` (either `next` or `variant`) * @param opts.timeoutMs - Optional timeout in milliseconds (defaults to no timeout) * @param opts.onProgress - Optional callback which will be invoked every time the partial response is updated * @param opts.onConversationResponse - Optional callback which will be invoked every time the partial response is updated with the full conversation response @@ -138,6 +152,8 @@ export class ChatGPTAPI { const { conversationId, parentMessageId = uuidv4(), + messageId = uuidv4(), + action = 'next', timeoutMs, onProgress, onConversationResponse @@ -154,10 +170,10 @@ export class ChatGPTAPI { const accessToken = await this.refreshAccessToken() const body: types.ConversationJSONBody = { - action: 'next', + action, messages: [ { - id: uuidv4(), + id: messageId, role: 'user', content: { content_type: 'text', @@ -173,19 +189,25 @@ export class ChatGPTAPI { body.conversation_id = conversationId } - const url = `${this._backendApiBaseUrl}/conversation` let response = '' const responseP = new Promise((resolve, reject) => { + const url = `${this._backendApiBaseUrl}/conversation` + const headers = { + ...this._headers, + Authorization: `Bearer ${accessToken}`, + Accept: 'text/event-stream', + 'Content-Type': 'application/json', + Cookie: `cf_clearance=${this._clearanceToken}` + } + + if (this._debug) { + console.log('POST', url, { body, headers }) + } + fetchSSE(url, { method: 'POST', - headers: { - ...this._headers, - Authorization: `Bearer ${accessToken}`, - Accept: 'text/event-stream', - 'Content-Type': 'application/json', - Cookie: `cf_clearance=${this._clearanceToken}` - }, + headers, body: JSON.stringify(body), signal: abortSignal, onMessage: (data: string) => { @@ -282,14 +304,18 @@ export class ChatGPTAPI { let response: Response try { + const url = `${this._apiBaseUrl}/auth/session` const headers = { ...this._headers, cookie: `cf_clearance=${this._clearanceToken}; __Secure-next-auth.session-token=${this._sessionToken}`, accept: '*/*' } - console.log(`${this._apiBaseUrl}/auth/session`, headers) - const res = await fetch(`${this._apiBaseUrl}/auth/session`, { + if (this._debug) { + console.log('GET', url, headers) + } + + const res = await fetch(url, { headers }).then((r) => { response = r @@ -339,6 +365,10 @@ export class ChatGPTAPI { this._accessTokenCache.set(KEY_ACCESS_TOKEN, accessToken) return accessToken } catch (err: any) { + if (this._debug) { + console.error(err) + } + const error = new types.ChatGPTError( `ChatGPT failed to refresh auth token. ${err.toString()}` ) diff --git a/src/types.ts b/src/types.ts index 61023e74..920f073f 100644 --- a/src/types.ts +++ b/src/types.ts @@ -273,10 +273,13 @@ export type MessageContent = { } export type MessageMetadata = any +export type MessageActionType = 'next' | 'variant' export type SendMessageOptions = { conversationId?: string parentMessageId?: string + messageId?: string + action?: MessageActionType timeoutMs?: number onProgress?: (partialResponse: string) => void onConversationResponse?: (response: ConversationResponseEvent) => void From 1d621d0c3c2e7f57e21422d94c726e2555d4a9f0 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Mon, 12 Dec 2022 11:23:03 -0600 Subject: [PATCH 2/8] feat: move puppeteer automation into main lib; update docs --- demos/demo-conversation.ts | 5 +- demos/demo.ts | 5 +- package.json | 15 ++- readme.md | 95 ++++++++----------- src/chatgpt-api.ts | 36 ++++++- src/fetch.ts | 27 ++---- src/index.ts | 1 + .../openai-auth.ts | 48 +++++++--- 8 files changed, 129 insertions(+), 103 deletions(-) rename demos/openai-auth-puppeteer.ts => src/openai-auth.ts (66%) diff --git a/demos/demo-conversation.ts b/demos/demo-conversation.ts index 35967f9b..2f61706c 100644 --- a/demos/demo-conversation.ts +++ b/demos/demo-conversation.ts @@ -1,8 +1,7 @@ import dotenv from 'dotenv-safe' import { oraPromise } from 'ora' -import { ChatGPTAPI } from '../src' -import { getOpenAIAuthInfo } from './openai-auth-puppeteer' +import { ChatGPTAPI, getOpenAIAuth } from '../src' dotenv.config() @@ -17,7 +16,7 @@ async function main() { const email = process.env.EMAIL const password = process.env.PASSWORD - const authInfo = await getOpenAIAuthInfo({ + const authInfo = await getOpenAIAuth({ email, password }) diff --git a/demos/demo.ts b/demos/demo.ts index 10568ca5..e1dfab4d 100644 --- a/demos/demo.ts +++ b/demos/demo.ts @@ -1,8 +1,7 @@ import dotenv from 'dotenv-safe' import { oraPromise } from 'ora' -import { ChatGPTAPI } from '../src' -import { getOpenAIAuthInfo } from './openai-auth-puppeteer' +import { ChatGPTAPI, getOpenAIAuth } from '../src' dotenv.config() @@ -17,7 +16,7 @@ async function main() { const email = process.env.EMAIL const password = process.env.PASSWORD - const authInfo = await getOpenAIAuthInfo({ + const authInfo = await getOpenAIAuth({ email, password }) diff --git a/package.json b/package.json index 14914455..ea3d6568 100644 --- a/package.json +++ b/package.json @@ -20,14 +20,13 @@ "build" ], "engines": { - "node": ">=16.8" + "node": ">=18" }, "scripts": { "build": "tsup", "dev": "tsup --watch", "clean": "del build", "prebuild": "run-s clean", - "postbuild": "[ -n CI ] && sed -i '' 's/await import(\"undici\")/null/' build/browser/index.js || echo 'skipping postbuild on CI'", "predev": "run-s clean", "pretest": "run-s build", "docs": "typedoc", @@ -42,7 +41,10 @@ "p-timeout": "^6.0.0", "remark": "^14.0.2", "strip-markdown": "^5.0.0", - "uuid": "^9.0.0" + "delay": "^5.0.0", + "uuid": "^9.0.0", + "puppeteer-extra": "^3.3.4", + "puppeteer-extra-plugin-stealth": "^2.11.1" }, "devDependencies": { "@trivago/prettier-plugin-sort-imports": "^4.0.0", @@ -50,7 +52,6 @@ "@types/uuid": "^9.0.0", "ava": "^5.1.0", "del-cli": "^5.0.0", - "delay": "^5.0.0", "dotenv-safe": "^8.2.0", "husky": "^8.0.2", "lint-staged": "^13.0.3", @@ -58,16 +59,14 @@ "ora": "^6.1.2", "prettier": "^2.8.0", "puppeteer": "^19.4.0", - "puppeteer-extra": "^3.3.4", - "puppeteer-extra-plugin-stealth": "^2.11.1", "tsup": "^6.5.0", "tsx": "^3.12.1", "typedoc": "^0.23.21", "typedoc-plugin-markdown": "^3.13.6", "typescript": "^4.9.3" }, - "optionalDependencies": { - "undici": "^5.13.0" + "peerDependencies": { + "puppeteer": "*" }, "lint-staged": { "*.{ts,tsx}": [ diff --git a/readme.md b/readme.md index 90631e7f..86f3fce3 100644 --- a/readme.md +++ b/readme.md @@ -4,28 +4,9 @@ Yesterday, OpenAI added additional Cloudflare protections that make it more diff The demos have been updated to use Puppeteer to log in to ChatGPT and extract the Cloudflare `cf_clearance` cookie and OpenAI session token. 🔥 -To use the updated version, first make sure you're using the latest version of this package and Node.js >= 18: +To use the updated version, make sure you're using the latest version of this package and Node.js >= 18. Then update your code to use the examples below, paying special attention to the sections on [Authentication](#authentication) and [Restrictions](#restrictions). -```ts -const api = new ChatGPTAPI({ - sessionToken: process.env.SESSION_TOKEN, - clearanceToken: process.env.CLEARANCE_TOKEN, - userAgent: '' // needs to match your browser's user agent -}) - -await api.ensureAuth() -``` - -Restrictions on this method: - -- Cloudflare `cf_clearance` **tokens expire after 2 hours**, so right now we recommend that you refresh your `cf_clearance` token every ~45 minutes or so. -- Your `user-agent` and `IP address` **must match** from the real browser window you're logged in with to the one you're using for `ChatGPTAPI`. - - This means that you currently can't log in with your laptop and then run the bot on a server or proxy somewhere. -- Cloudflare will still sometimes ask you to complete a CAPTCHA, so you may need to keep an eye on it and manually resolve the CAPTCHA. Automated CAPTCHA bypass is a WIP. -- You must use `node >= 18`. I'm using `v19.2.0` in my testing, but for some reason, all `fetch` requests using Node.js `v16` and `v17` fail at the moment (these use `undici` under the hood, whereas Node.js v18 and above use a built-in `fetch` based on `undici`). -- You should not be using this account while the bot is using it, because that browser window may refresh one of your tokens and invalidate the bot's session. - -We're working hard in [this issue](https://github.com/transitive-bullshit/chatgpt-api/issues/96) to make this process easier and more automated. +We're working hard in [this issue](https://github.com/transitive-bullshit/chatgpt-api/issues/96) to improve this process. Keep in mind that this package will be updated to use the official API as soon as it's released. 💪 Cheers, Travis @@ -48,7 +29,8 @@ Travis - [Usage](#usage) - [Docs](#docs) - [Demos](#demos) - - [Session Tokens](#session-tokens) + - [Authentication](#authentication) + - [Restrictions](#restrictions) - [Projects](#projects) - [Compatibility](#compatibility) - [Credits](#credits) @@ -69,15 +51,17 @@ npm install chatgpt ## Usage ```ts -import { ChatGPTAPI } from 'chatgpt' +import { ChatGPTAPI, getOpenAIAuth } from 'chatgpt' async function example() { - const api = new ChatGPTAPI({ - sessionToken: process.env.SESSION_TOKEN, - clearanceToken: process.env.CLEARANCE_TOKEN, - userAgent: 'TODO' + // uses puppeteer to bypass cloudflare (headful because you may have to solve + // a captcha) + const openAIAuth = await getOpenAIAuth({ + email: process.env.EMAIL, + password: process.env.EMAIL }) + const api = new ChatGPTAPI({ ...openAIAuth }) await api.ensureAuth() // send a message and wait for the response @@ -93,32 +77,23 @@ async function example() { ChatGPT responses are formatted as markdown by default. If you want to work with plaintext instead, you can use: ```ts -const api = new ChatGPTAPI({ - sessionToken: process.env.SESSION_TOKEN, - clearanceToken: process.env.CLEARANCE_TOKEN, - userAgent: 'TODO', - markdown: false -}) +const api = new ChatGPTAPI({ ...openAIAuth, markdown: false }) ``` If you want to automatically track the conversation, you can use `ChatGPTAPI.getConversation()`: ```ts -const api = new ChatGPTAPI({ - sessionToken: process.env.SESSION_TOKEN, - clearanceToken: process.env.CLEARANCE_TOKEN, - userAgent: 'TODO' -}) +const api = new ChatGPTAPI({ ...openAIAuth, markdown: false }) const conversation = api.getConversation() // send a message and wait for the response const response0 = await conversation.sendMessage('What is OpenAI?') -// send a follow-up prompt to the previous message and wait for the response +// send a follow-up const response1 = await conversation.sendMessage('Can you expand on that?') -// send another follow-up to the same conversation +// send another follow-up const response2 = await conversation.sendMessage('Oh cool; thank you') ``` @@ -141,13 +116,14 @@ You can stream responses using the `onProgress` or `onConversationResponse` call ```js async function example() { // To use ESM in CommonJS, you can use a dynamic import - const { ChatGPTAPI } = await import('chatgpt') + const { ChatGPTAPI, getOpenAIAuth } = await import('chatgpt') - const api = new ChatGPTAPI({ - sessionToken: process.env.SESSION_TOKEN, - clearanceToken: process.env.CLEARANCE_TOKEN, - userAgent: 'TODO' + const openAIAuth = await getOpenAIAuth({ + email: process.env.EMAIL, + password: process.env.EMAIL }) + + const api = new ChatGPTAPI({ ...openAIAuth }) await api.ensureAuth() const response = await api.sendMessage('Hello World!') @@ -181,13 +157,21 @@ A [conversation demo](./demos/demo-conversation.ts) is also included: npx tsx src/demo-conversation.ts ``` -### Session Tokens +### Authentication -**This package requires a valid session token from ChatGPT to access it's unofficial REST API.** +#### Restrictions -As of December 11, 2021, it also requires a valid Cloudflare clearance token. +**Please read carefully** -There are two options to get these; either manually, or automated. For the automated way, see the `demos/` folder using Puppeteer. +- You must use `node >= 18`. I'm using `v19.2.0` in my testing, but for some reason, all `fetch` requests using Node.js `v16` and `v17` fail at the moment (these use `undici` under the hood, whereas Node.js v18 and above use a built-in `fetch` based on `undici`). +- Cloudflare `cf_clearance` **tokens expire after 2 hours**, so right now we recommend that you refresh your `cf_clearance` token every hour or so. +- Your `user-agent` and `IP address` **must match** from the real browser window you're logged in with to the one you're using for `ChatGPTAPI`. + - This means that you currently can't log in with your laptop and then run the bot on a server or proxy somewhere. +- Cloudflare will still sometimes ask you to complete a CAPTCHA, so you may need to keep an eye on it and manually resolve the CAPTCHA. Automated CAPTCHA bypass is coming soon. +- You should not be using this account while the bot is using it, because that browser window may refresh one of your tokens and invalidate the bot's session. + +
+Getting tokens manually To get a session token manually: @@ -195,8 +179,10 @@ To get a session token manually: 2. Open dev tools. 3. Open `Application` > `Cookies`. ![ChatGPT cookies](./media/session-token.png) -4. Copy the value for `__Secure-next-auth.session-token` and save it to your environment. -5. Copy the value for `cf_clearance` and save it to your environment. +4. Copy the value for `__Secure-next-auth.session-token` and save it to your environment. This will be your `sessionToken`. +5. Copy the value for `cf_clearance` and save it to your environment. This will be your `clearanceToken`. + +
> **Note** > This package will switch to using the official API once it's released. @@ -255,11 +241,8 @@ If you create a cool integration, feel free to open a PR and add it to the list. This package is ESM-only. It supports: -- Node.js >= 16.8 - - If you need Node.js 14 support, use [`v1.4.0`](https://github.com/transitive-bullshit/chatgpt-api/releases/tag/v1.4.0) -- Edge runtimes like CF workers and Vercel edge functions -- Modern browsers - - Mainly meant for chrome extensions where your code is protected to a degree +- Node.js >= 18 + - Node.js 17, 16, and 14 were supported in earlier versions, but OpenAI's Cloudflare update caused a bug with `undici` on v17 and v16 that we need to debug. So for now, use `node >= 18` - We recommend against using `chatgpt` from client-side browser code because it would expose your private session token - If you want to build a website using `chatgpt`, we recommend using it only from your backend API diff --git a/src/chatgpt-api.ts b/src/chatgpt-api.ts index 8022b4f0..fea5af68 100644 --- a/src/chatgpt-api.ts +++ b/src/chatgpt-api.ts @@ -29,6 +29,9 @@ export class ChatGPTAPI { /** * Creates a new client wrapper around the unofficial ChatGPT REST API. * + * Note that your IP address and `userAgent` must match the same values that you used + * to obtain your `clearanceToken`. + * * @param opts.sessionToken = **Required** OpenAI session token which can be found in a valid session's cookies (see readme for instructions) * @param opts.clearanceToken = **Required** Cloudflare `cf_clearance` cookie value (see readme for instructions) * @param apiBaseUrl - Optional override; the base URL for ChatGPT webapp's API (`/api`) @@ -124,6 +127,21 @@ export class ChatGPTAPI { return this._user } + /** Gets the current session token. */ + get sessionToken() { + return this._sessionToken + } + + /** Gets the current Cloudflare clearance token (`cf_clearance` cookie value). */ + get clearanceToken() { + return this._clearanceToken + } + + /** Gets the current user agent. */ + get userAgent() { + return this._userAgent + } + /** * Sends a message to ChatGPT, waits for the response to resolve, and returns * the response. @@ -244,7 +262,23 @@ export class ChatGPTAPI { reject(err) } } - }).catch(reject) + }).catch((err) => { + const errMessageL = err.toString().toLowerCase() + + if ( + response && + (errMessageL === 'error: typeerror: terminated' || + errMessageL === 'typeerror: terminated') + ) { + // OpenAI sometimes forcefully terminates the socket from their end before + // the HTTP request has resolved cleanly. In my testing, these cases tend to + // happen when OpenAI has already send the last `response`, so we can ignore + // the `fetch` error in this case. + return resolve(response) + } else { + return reject(err) + } + }) }) if (timeoutMs) { diff --git a/src/fetch.ts b/src/fetch.ts index cb637869..6722f4f4 100644 --- a/src/fetch.ts +++ b/src/fetch.ts @@ -1,28 +1,13 @@ /// -let _undici: any - -// Use `undici` for node.js 16 and 17 // Use `fetch` for node.js >= 18 // Use `fetch` for all other environments, including browsers -// NOTE: The top-level await is removed in a `postbuild` npm script for the -// browser build -const fetch = - globalThis.fetch ?? - async function undiciFetchWrapper( - ...args: Parameters - ): Promise { - if (!_undici) { - _undici = await import('undici') - } +const fetch = globalThis.fetch - if (typeof _undici?.fetch !== 'function') { - throw new Error( - 'Invalid undici installation; please make sure undici is installed correctly in your node_modules. Note that this package requires Node.js >= 16.8' - ) - } - - return _undici.fetch(...args) - } +if (typeof fetch !== 'function') { + throw new Error( + 'Invalid environment: global fetch not defined; `chatgpt` requires Node.js >= 18 at the moment due to Cloudflare protections' + ) +} export { fetch } diff --git a/src/index.ts b/src/index.ts index ed6a4b55..976d160a 100644 --- a/src/index.ts +++ b/src/index.ts @@ -2,3 +2,4 @@ export * from './chatgpt-api' export * from './chatgpt-conversation' export * from './types' export * from './utils' +export * from './openai-auth' diff --git a/demos/openai-auth-puppeteer.ts b/src/openai-auth.ts similarity index 66% rename from demos/openai-auth-puppeteer.ts rename to src/openai-auth.ts index 55f9255b..74a21515 100644 --- a/demos/openai-auth-puppeteer.ts +++ b/src/openai-auth.ts @@ -10,7 +10,11 @@ import StealthPlugin from 'puppeteer-extra-plugin-stealth' puppeteer.use(StealthPlugin()) -export type OpenAIAuthInfo = { +/** + * Represents everything that's required to pass into `ChatGPTAPI` in order + * to authenticate with the unofficial ChatGPT API. + */ +export type OpenAIAuth = { userAgent: string clearanceToken: string sessionToken: string @@ -20,18 +24,29 @@ export type OpenAIAuthInfo = { /** * Bypasses OpenAI's use of Cloudflare to get the cookies required to use * ChatGPT. Uses Puppeteer with a stealth plugin under the hood. + * + * If you pass `email` and `password`, then it will log into the account and + * include a `sessionToken` in the response. + * + * If you don't pass `email` and `password`, then it will just return a valid + * `clearanceToken`. + * + * This can be useful because `clearanceToken` expires after ~2 hours, whereas + * `sessionToken` generally lasts much longer. We recommend renewing your + * `clearanceToken` every hour or so and creating a new instance of `ChatGPTAPI` + * with your updated credentials. */ -export async function getOpenAIAuthInfo({ +export async function getOpenAIAuth({ email, password, - timeout = 2 * 60 * 1000, + timeoutMs = 2 * 60 * 1000, browser }: { - email: string - password: string - timeout?: number + email?: string + password?: string + timeoutMs?: number browser?: Browser -}): Promise { +}): Promise { let page: Page let origBrowser = browser @@ -42,12 +57,18 @@ export async function getOpenAIAuthInfo({ const userAgent = await browser.userAgent() page = (await browser.pages())[0] || (await browser.newPage()) - page.setDefaultTimeout(timeout) + page.setDefaultTimeout(timeoutMs) await page.goto('https://chat.openai.com/auth/login') - await page.waitForSelector('#__next .btn-primary', { timeout }) + + // NOTE: this is where you may encounter a CAPTCHA + + await page.waitForSelector('#__next .btn-primary', { timeout: timeoutMs }) + + // once we get to this point, the Cloudflare cookies are available await delay(1000) + // login as well (optional) if (email && password) { await Promise.all([ page.click('#__next .btn-primary'), @@ -73,7 +94,7 @@ export async function getOpenAIAuthInfo({ {} ) - const authInfo: OpenAIAuthInfo = { + const authInfo: OpenAIAuth = { userAgent, clearanceToken: cookies['cf_clearance']?.value, sessionToken: cookies['__Secure-next-auth.session-token']?.value, @@ -83,7 +104,7 @@ export async function getOpenAIAuthInfo({ return authInfo } catch (err) { console.error(err) - throw null + throw err } finally { if (origBrowser) { if (page) { @@ -98,6 +119,11 @@ export async function getOpenAIAuthInfo({ } } +/** + * Launches a non-puppeteer instance of Chrome. Note that in my testing, I wasn't + * able to use the built-in `puppeteer` version of Chromium because Cloudflare + * recognizes it and blocks access. + */ export async function getBrowser(launchOptions?: PuppeteerLaunchOptions) { const macChromePath = '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome' From efadd9ec53d1514976ba36eb22a078d4ebf48769 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Mon, 12 Dec 2022 11:23:19 -0600 Subject: [PATCH 3/8] chore: update auto-generated docs --- docs/classes/ChatGPTAPI.md | 78 ++++++++++++--- docs/classes/ChatGPTConversation.md | 10 +- docs/classes/ChatGPTError.md | 8 +- docs/modules.md | 146 +++++++++++++++++++++++----- docs/readme.md | 123 +++++++++++++---------- 5 files changed, 273 insertions(+), 92 deletions(-) diff --git a/docs/classes/ChatGPTAPI.md b/docs/classes/ChatGPTAPI.md index 78072d94..84fb046b 100644 --- a/docs/classes/ChatGPTAPI.md +++ b/docs/classes/ChatGPTAPI.md @@ -10,7 +10,10 @@ ### Accessors +- [clearanceToken](ChatGPTAPI.md#clearancetoken) +- [sessionToken](ChatGPTAPI.md#sessiontoken) - [user](ChatGPTAPI.md#user) +- [userAgent](ChatGPTAPI.md#useragent) ### Methods @@ -28,26 +31,63 @@ Creates a new client wrapper around the unofficial ChatGPT REST API. +Note that your IP address and `userAgent` must match the same values that you used +to obtain your `clearanceToken`. + #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `opts` | `Object` | - | -| `opts.accessToken?` | `string` | - | -| `opts.accessTokenTTL?` | `number` | **`Default Value`** 60000 (60 seconds) | +| `opts.accessToken?` | `string` | **`Default Value`** `undefined` * | +| `opts.accessTokenTTL?` | `number` | **`Default Value`** 1 hour * | | `opts.apiBaseUrl?` | `string` | **`Default Value`** `'https://chat.openai.com/api'` * | | `opts.backendApiBaseUrl?` | `string` | **`Default Value`** `'https://chat.openai.com/backend-api'` * | -| `opts.clearanceToken` | `string` | - | +| `opts.clearanceToken` | `string` | = **Required** Cloudflare `cf_clearance` cookie value (see readme for instructions) | +| `opts.debug?` | `boolean` | **`Default Value`** `false` * | +| `opts.headers?` | `Record`<`string`, `string`\> | **`Default Value`** `undefined` * | | `opts.markdown?` | `boolean` | **`Default Value`** `true` * | | `opts.sessionToken` | `string` | = **Required** OpenAI session token which can be found in a valid session's cookies (see readme for instructions) | -| `opts.userAgent?` | `string` | **`Default Value`** `'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36'` * | +| `opts.userAgent?` | `string` | **`Default Value`** `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36'` * | #### Defined in -[src/chatgpt-api.ts:39](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L39) +[src/chatgpt-api.ts:45](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L45) ## Accessors +### clearanceToken + +• `get` **clearanceToken**(): `string` + +Gets the current Cloudflare clearance token (`cf_clearance` cookie value). + +#### Returns + +`string` + +#### Defined in + +[src/chatgpt-api.ts:136](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L136) + +___ + +### sessionToken + +• `get` **sessionToken**(): `string` + +Gets the current session token. + +#### Returns + +`string` + +#### Defined in + +[src/chatgpt-api.ts:131](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L131) + +___ + ### user • `get` **user**(): [`User`](../modules.md#user) @@ -60,7 +100,23 @@ Gets the currently signed-in user, if authenticated, `null` otherwise. #### Defined in -[src/chatgpt-api.ts:98](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L98) +[src/chatgpt-api.ts:126](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L126) + +___ + +### userAgent + +• `get` **userAgent**(): `string` + +Gets the current user agent. + +#### Returns + +`string` + +#### Defined in + +[src/chatgpt-api.ts:141](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L141) ## Methods @@ -77,7 +133,7 @@ is still valid. #### Defined in -[src/chatgpt-api.ts:250](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L250) +[src/chatgpt-api.ts:319](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L319) ___ @@ -104,7 +160,7 @@ The new conversation instance #### Defined in -[src/chatgpt-api.ts:344](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L344) +[src/chatgpt-api.ts:425](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L425) ___ @@ -121,7 +177,7 @@ the token fails. #### Defined in -[src/chatgpt-api.ts:237](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L237) +[src/chatgpt-api.ts:306](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L306) ___ @@ -147,7 +203,7 @@ A valid access token #### Defined in -[src/chatgpt-api.ts:264](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L264) +[src/chatgpt-api.ts:333](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L333) ___ @@ -178,4 +234,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-api.ts:121](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-api.ts#L121) +[src/chatgpt-api.ts:166](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L166) diff --git a/docs/classes/ChatGPTConversation.md b/docs/classes/ChatGPTConversation.md index 61b8fa7c..f1fd62b0 100644 --- a/docs/classes/ChatGPTConversation.md +++ b/docs/classes/ChatGPTConversation.md @@ -41,7 +41,7 @@ Creates a new conversation wrapper around the ChatGPT API. #### Defined in -[src/chatgpt-conversation.ts:21](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-conversation.ts#L21) +[src/chatgpt-conversation.ts:21](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L21) ## Properties @@ -51,7 +51,7 @@ Creates a new conversation wrapper around the ChatGPT API. #### Defined in -[src/chatgpt-conversation.ts:10](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-conversation.ts#L10) +[src/chatgpt-conversation.ts:10](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L10) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[src/chatgpt-conversation.ts:11](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-conversation.ts#L11) +[src/chatgpt-conversation.ts:11](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L11) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[src/chatgpt-conversation.ts:12](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-conversation.ts#L12) +[src/chatgpt-conversation.ts:12](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L12) ## Methods @@ -104,4 +104,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-conversation.ts:48](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/chatgpt-conversation.ts#L48) +[src/chatgpt-conversation.ts:48](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L48) diff --git a/docs/classes/ChatGPTError.md b/docs/classes/ChatGPTError.md index b80b8c86..776f060b 100644 --- a/docs/classes/ChatGPTError.md +++ b/docs/classes/ChatGPTError.md @@ -66,7 +66,7 @@ node_modules/.pnpm/typescript@4.9.3/node_modules/typescript/lib/lib.es2022.error #### Defined in -[src/types.ts:295](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L295) +[src/types.ts:298](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L298) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/types.ts:294](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L294) +[src/types.ts:297](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L297) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[src/types.ts:292](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L292) +[src/types.ts:295](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L295) ___ @@ -96,4 +96,4 @@ ___ #### Defined in -[src/types.ts:293](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L293) +[src/types.ts:296](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L296) diff --git a/docs/modules.md b/docs/modules.md index 85ca3654..0ea1073c 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -17,6 +17,7 @@ - [ConversationJSONBody](modules.md#conversationjsonbody) - [ConversationResponseEvent](modules.md#conversationresponseevent) - [Message](modules.md#message) +- [MessageActionType](modules.md#messageactiontype) - [MessageContent](modules.md#messagecontent) - [MessageFeedbackJSONBody](modules.md#messagefeedbackjsonbody) - [MessageFeedbackRating](modules.md#messagefeedbackrating) @@ -27,6 +28,7 @@ - [ModelsResult](modules.md#modelsresult) - [ModerationsJSONBody](modules.md#moderationsjsonbody) - [ModerationsJSONResult](modules.md#moderationsjsonresult) +- [OpenAIAuth](modules.md#openaiauth) - [Prompt](modules.md#prompt) - [PromptContent](modules.md#promptcontent) - [Role](modules.md#role) @@ -37,6 +39,8 @@ ### Functions +- [getBrowser](modules.md#getbrowser) +- [getOpenAIAuth](modules.md#getopenaiauth) - [markdownToText](modules.md#markdowntotext) ## Type Aliases @@ -47,7 +51,7 @@ #### Defined in -[src/types.ts:109](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L109) +[src/types.ts:109](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L109) ___ @@ -57,7 +61,7 @@ ___ #### Defined in -[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L1) +[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L1) ___ @@ -79,7 +83,7 @@ https://chat.openapi.com/backend-api/conversation #### Defined in -[src/types.ts:134](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L134) +[src/types.ts:134](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L134) ___ @@ -97,7 +101,7 @@ ___ #### Defined in -[src/types.ts:251](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L251) +[src/types.ts:251](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L251) ___ @@ -122,7 +126,17 @@ ___ #### Defined in -[src/types.ts:257](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L257) +[src/types.ts:257](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L257) + +___ + +### MessageActionType + +Ƭ **MessageActionType**: ``"next"`` \| ``"variant"`` + +#### Defined in + +[src/types.ts:276](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L276) ___ @@ -139,7 +153,7 @@ ___ #### Defined in -[src/types.ts:270](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L270) +[src/types.ts:270](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L270) ___ @@ -161,7 +175,7 @@ https://chat.openapi.com/backend-api/conversation/message_feedback #### Defined in -[src/types.ts:193](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L193) +[src/types.ts:193](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L193) ___ @@ -171,7 +185,7 @@ ___ #### Defined in -[src/types.ts:249](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L249) +[src/types.ts:249](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L249) ___ @@ -191,7 +205,7 @@ ___ #### Defined in -[src/types.ts:222](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L222) +[src/types.ts:222](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L222) ___ @@ -201,7 +215,7 @@ ___ #### Defined in -[src/types.ts:220](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L220) +[src/types.ts:220](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L220) ___ @@ -211,7 +225,7 @@ ___ #### Defined in -[src/types.ts:275](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L275) +[src/types.ts:275](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L275) ___ @@ -229,7 +243,7 @@ ___ #### Defined in -[src/types.ts:77](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L77) +[src/types.ts:77](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L77) ___ @@ -247,7 +261,7 @@ https://chat.openapi.com/backend-api/models #### Defined in -[src/types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L70) +[src/types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L70) ___ @@ -266,7 +280,7 @@ https://chat.openapi.com/backend-api/moderations #### Defined in -[src/types.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L97) +[src/types.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L97) ___ @@ -286,7 +300,29 @@ https://chat.openapi.com/backend-api/moderations #### Defined in -[src/types.ts:114](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L114) +[src/types.ts:114](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L114) + +___ + +### OpenAIAuth + +Ƭ **OpenAIAuth**: `Object` + +Represents everything that's required to pass into `ChatGPTAPI` in order +to authenticate with the unofficial ChatGPT API. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `clearanceToken` | `string` | +| `cookies?` | `Record`<`string`, `Protocol.Network.Cookie`\> | +| `sessionToken` | `string` | +| `userAgent` | `string` | + +#### Defined in + +[src/openai-auth.ts:17](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/openai-auth.ts#L17) ___ @@ -304,7 +340,7 @@ ___ #### Defined in -[src/types.ts:161](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L161) +[src/types.ts:161](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L161) ___ @@ -321,7 +357,7 @@ ___ #### Defined in -[src/types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L178) +[src/types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L178) ___ @@ -331,7 +367,7 @@ ___ #### Defined in -[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L3) +[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L3) ___ @@ -341,7 +377,7 @@ ___ #### Defined in -[src/types.ts:286](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L286) +[src/types.ts:289](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L289) ___ @@ -354,7 +390,9 @@ ___ | Name | Type | | :------ | :------ | | `abortSignal?` | `AbortSignal` | +| `action?` | [`MessageActionType`](modules.md#messageactiontype) | | `conversationId?` | `string` | +| `messageId?` | `string` | | `onConversationResponse?` | (`response`: [`ConversationResponseEvent`](modules.md#conversationresponseevent)) => `void` | | `onProgress?` | (`partialResponse`: `string`) => `void` | | `parentMessageId?` | `string` | @@ -362,7 +400,7 @@ ___ #### Defined in -[src/types.ts:277](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L277) +[src/types.ts:278](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L278) ___ @@ -383,7 +421,7 @@ https://chat.openapi.com/api/auth/session #### Defined in -[src/types.ts:8](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L8) +[src/types.ts:8](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L8) ___ @@ -405,10 +443,72 @@ ___ #### Defined in -[src/types.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/types.ts#L30) +[src/types.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L30) ## Functions +### getBrowser + +▸ **getBrowser**(`launchOptions?`): `Promise`<`Browser`\> + +Launches a non-puppeteer instance of Chrome. Note that in my testing, I wasn't +able to use the built-in `puppeteer` version of Chromium because Cloudflare +recognizes it and blocks access. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `launchOptions?` | `PuppeteerLaunchOptions` | + +#### Returns + +`Promise`<`Browser`\> + +#### Defined in + +[src/openai-auth.ts:127](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/openai-auth.ts#L127) + +___ + +### getOpenAIAuth + +▸ **getOpenAIAuth**(`__namedParameters`): `Promise`<[`OpenAIAuth`](modules.md#openaiauth)\> + +Bypasses OpenAI's use of Cloudflare to get the cookies required to use +ChatGPT. Uses Puppeteer with a stealth plugin under the hood. + +If you pass `email` and `password`, then it will log into the account and +include a `sessionToken` in the response. + +If you don't pass `email` and `password`, then it will just return a valid +`clearanceToken`. + +This can be useful because `clearanceToken` expires after ~2 hours, whereas +`sessionToken` generally lasts much longer. We recommend renewing your +`clearanceToken` every hour or so and creating a new instance of `ChatGPTAPI` +with your updated credentials. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `__namedParameters` | `Object` | +| `__namedParameters.browser?` | `Browser` | +| `__namedParameters.email?` | `string` | +| `__namedParameters.password?` | `string` | +| `__namedParameters.timeoutMs?` | `number` | + +#### Returns + +`Promise`<[`OpenAIAuth`](modules.md#openaiauth)\> + +#### Defined in + +[src/openai-auth.ts:39](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/openai-auth.ts#L39) + +___ + ### markdownToText ▸ **markdownToText**(`markdown?`): `string` @@ -425,4 +525,4 @@ ___ #### Defined in -[src/utils.ts:4](https://github.com/transitive-bullshit/chatgpt-api/blob/8e1cde4/src/utils.ts#L4) +[src/utils.ts:4](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/utils.ts#L4) diff --git a/docs/readme.md b/docs/readme.md index 3ef7fc60..7ed32846 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,7 +1,19 @@ chatgpt / [Exports](modules.md) -> **Note** -> As of December 11, 2022 ~2pm CST, OpenAI has enabled additional Cloudflare restrictions that are currently preventing us from refreshing access tokens. This is affecting _all_ ChatGPT API wrappers at the moment, including the Python ones. See [this issue](https://github.com/transitive-bullshit/chatgpt-api/issues/96) for an ongoing discussion until I release a viable workaround. +# Update December 12, 2022 + +Yesterday, OpenAI added additional Cloudflare protections that make it more difficult to access the unofficial API. + +The demos have been updated to use Puppeteer to log in to ChatGPT and extract the Cloudflare `cf_clearance` cookie and OpenAI session token. 🔥 + +To use the updated version, make sure you're using the latest version of this package and Node.js >= 18. Then update your code to use the examples below, paying special attention to the sections on [Authentication](#authentication) and [Restrictions](#restrictions). + +We're working hard in [this issue](https://github.com/transitive-bullshit/chatgpt-api/issues/96) to improve this process. Keep in mind that this package will be updated to use the official API as soon as it's released. 💪 + +Cheers, +Travis + +---

Example usage @@ -13,16 +25,18 @@ chatgpt / [Exports](modules.md) [![NPM](https://img.shields.io/npm/v/chatgpt.svg)](https://www.npmjs.com/package/chatgpt) [![Build Status](https://github.com/transitive-bullshit/chatgpt-api/actions/workflows/test.yml/badge.svg)](https://github.com/transitive-bullshit/chatgpt-api/actions/workflows/test.yml) [![MIT License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/transitive-bullshit/chatgpt-api/blob/main/license) [![Prettier Code Formatting](https://img.shields.io/badge/code_style-prettier-brightgreen.svg)](https://prettier.io) -- [Intro](#intro) -- [Install](#install) -- [Usage](#usage) - - [Docs](#docs) - - [Demos](#demos) - - [Session Tokens](#session-tokens) -- [Projects](#projects) -- [Compatibility](#compatibility) -- [Credits](#credits) -- [License](#license) +- [Update December 12, 2022](#update-december-12-2022) + - [Intro](#intro) + - [Install](#install) + - [Usage](#usage) + - [Docs](#docs) + - [Demos](#demos) + - [Authentication](#authentication) + - [Restrictions](#restrictions) + - [Projects](#projects) + - [Compatibility](#compatibility) + - [Credits](#credits) + - [License](#license) ## Intro @@ -39,15 +53,17 @@ npm install chatgpt ## Usage ```ts -import { ChatGPTAPI } from 'chatgpt' +import { ChatGPTAPI, getOpenAIAuth } from 'chatgpt' async function example() { - // sessionToken is required; see below for details - const api = new ChatGPTAPI({ - sessionToken: process.env.SESSION_TOKEN + // uses puppeteer to bypass cloudflare (headful because you may have to solve + // a captcha) + const openAIAuth = await getOpenAIAuth({ + email: process.env.EMAIL, + password: process.env.EMAIL }) - // ensure the API is properly authenticated + const api = new ChatGPTAPI({ ...openAIAuth }) await api.ensureAuth() // send a message and wait for the response @@ -63,28 +79,23 @@ async function example() { ChatGPT responses are formatted as markdown by default. If you want to work with plaintext instead, you can use: ```ts -const api = new ChatGPTAPI({ - sessionToken: process.env.SESSION_TOKEN, - markdown: false -}) +const api = new ChatGPTAPI({ ...openAIAuth, markdown: false }) ``` If you want to automatically track the conversation, you can use `ChatGPTAPI.getConversation()`: ```ts -const api = new ChatGPTAPI({ - sessionToken: process.env.SESSION_TOKEN -}) +const api = new ChatGPTAPI({ ...openAIAuth, markdown: false }) const conversation = api.getConversation() // send a message and wait for the response const response0 = await conversation.sendMessage('What is OpenAI?') -// send a follow-up prompt to the previous message and wait for the response +// send a follow-up const response1 = await conversation.sendMessage('Can you expand on that?') -// send another follow-up to the same conversation +// send another follow-up const response2 = await conversation.sendMessage('Oh cool; thank you') ``` @@ -107,11 +118,14 @@ You can stream responses using the `onProgress` or `onConversationResponse` call ```js async function example() { // To use ESM in CommonJS, you can use a dynamic import - const { ChatGPTAPI } = await import('chatgpt') + const { ChatGPTAPI, getOpenAIAuth } = await import('chatgpt') - const api = new ChatGPTAPI({ - sessionToken: process.env.SESSION_TOKEN + const openAIAuth = await getOpenAIAuth({ + email: process.env.EMAIL, + password: process.env.EMAIL }) + + const api = new ChatGPTAPI({ ...openAIAuth }) await api.ensureAuth() const response = await api.sendMessage('Hello World!') @@ -127,39 +141,50 @@ See the [auto-generated docs](./docs/classes/ChatGPTAPI.md) for more info on met ### Demos -A [basic demo](./src/demo.ts) is included for testing purposes: +To run the included demos: + +1. clone repo +2. install node deps +3. set `EMAIL` and `PASSWORD` in .env + +A [basic demo](./demos/demo.ts) is included for testing purposes: ```bash -# 1. clone repo -# 2. install node deps -# 3. set `SESSION_TOKEN` in .env -# 4. run: npx tsx src/demo.ts ``` -A [conversation demo](./src/demo-conversation.ts) is also included: +A [conversation demo](./demos/demo-conversation.ts) is also included: ```bash -# 1. clone repo -# 2. install node deps -# 3. set `SESSION_TOKEN` in .env -# 4. run: npx tsx src/demo-conversation.ts ``` -### Session Tokens +### Authentication -**This package requires a valid session token from ChatGPT to access it's unofficial REST API.** +#### Restrictions -To get a session token: +**Please read carefully** + +- You must use `node >= 18`. I'm using `v19.2.0` in my testing, but for some reason, all `fetch` requests using Node.js `v16` and `v17` fail at the moment (these use `undici` under the hood, whereas Node.js v18 and above use a built-in `fetch` based on `undici`). +- Cloudflare `cf_clearance` **tokens expire after 2 hours**, so right now we recommend that you refresh your `cf_clearance` token every hour or so. +- Your `user-agent` and `IP address` **must match** from the real browser window you're logged in with to the one you're using for `ChatGPTAPI`. + - This means that you currently can't log in with your laptop and then run the bot on a server or proxy somewhere. +- Cloudflare will still sometimes ask you to complete a CAPTCHA, so you may need to keep an eye on it and manually resolve the CAPTCHA. Automated CAPTCHA bypass is coming soon. +- You should not be using this account while the bot is using it, because that browser window may refresh one of your tokens and invalidate the bot's session. + +

+Getting tokens manually + +To get a session token manually: 1. Go to https://chat.openai.com/chat and log in or sign up. 2. Open dev tools. 3. Open `Application` > `Cookies`. ![ChatGPT cookies](./media/session-token.png) -4. Copy the value for `__Secure-next-auth.session-token` and save it to your environment. +4. Copy the value for `__Secure-next-auth.session-token` and save it to your environment. This will be your `sessionToken`. +5. Copy the value for `cf_clearance` and save it to your environment. This will be your `clearanceToken`. -If you want to run the built-in demo, store this value as `SESSION_TOKEN` in a local `.env` file. +
> **Note** > This package will switch to using the official API once it's released. @@ -197,6 +222,7 @@ All of these awesome projects are built using the `chatgpt` package. 🤯 - [QQ Bot (plugin for KiviBot)](https://github.com/KiviBotLab/kivibot-plugin-chatgpt) - [QQ Bot (oicq)](https://github.com/easydu2002/chat_gpt_oicq) - [QQ Bot (oicq + RabbitMQ)](https://github.com/linsyking/ChatGPT-QQBot) +- [QQ Bot (go-cqhttp)](https://github.com/PairZhu/ChatGPT-QQRobot) - [Lovelines.xyz](https://lovelines.xyz) - [EXM smart contracts](https://github.com/decentldotland/molecule) - [Flutter ChatGPT API](https://github.com/coskuncay/flutter_chatgpt_api) @@ -204,10 +230,12 @@ All of these awesome projects are built using the `chatgpt` package. 🤯 - [Github Action for reviewing PRs](https://github.com/kxxt/chatgpt-action/) - [WhatsApp Bot #1](https://github.com/pascalroget/whatsgpt) (multi-user support) - [WhatsApp Bot #2](https://github.com/amosayomide05/chatgpt-whatsapp-bot) +- [WhatsApp Bot #3](https://github.com/navopw/whatsapp-chatgpt) - [Matrix Bot](https://github.com/jakecoppinger/matrix-chatgpt-bot) - [Rental Cover Letter Generator](https://sharehouse.app/ai) - [Assistant CLI](https://github.com/diciaup/assistant-cli) - [Teams Bot](https://github.com/formulahendry/chatgpt-teams-bot) +- [Askai](https://github.com/yudax42/askai) If you create a cool integration, feel free to open a PR and add it to the list. @@ -215,11 +243,8 @@ If you create a cool integration, feel free to open a PR and add it to the list. This package is ESM-only. It supports: -- Node.js >= 16.8 - - If you need Node.js 14 support, use [`v1.4.0`](https://github.com/transitive-bullshit/chatgpt-api/releases/tag/v1.4.0) -- Edge runtimes like CF workers and Vercel edge functions -- Modern browsers - - Mainly meant for chrome extensions where your code is protected to a degree +- Node.js >= 18 + - Node.js 17, 16, and 14 were supported in earlier versions, but OpenAI's Cloudflare update caused a bug with `undici` on v17 and v16 that we need to debug. So for now, use `node >= 18` - We recommend against using `chatgpt` from client-side browser code because it would expose your private session token - If you want to build a website using `chatgpt`, we recommend using it only from your backend API From a48c177a2a238ae5bf34883b54216ef84ed92308 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Mon, 12 Dec 2022 11:35:28 -0600 Subject: [PATCH 4/8] docs: update readme instructions --- readme.md | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/readme.md b/readme.md index 86f3fce3..fb47784c 100644 --- a/readme.md +++ b/readme.md @@ -2,13 +2,15 @@ Yesterday, OpenAI added additional Cloudflare protections that make it more difficult to access the unofficial API. -The demos have been updated to use Puppeteer to log in to ChatGPT and extract the Cloudflare `cf_clearance` cookie and OpenAI session token. 🔥 +This package has been updated to use Puppeteer to automatically log in to ChatGPT and extract the necessary auth credentials. 🔥 -To use the updated version, make sure you're using the latest version of this package and Node.js >= 18. Then update your code to use the examples below, paying special attention to the sections on [Authentication](#authentication) and [Restrictions](#restrictions). +To use the updated version, **make sure you're using the latest version of this package and Node.js >= 18**. Then update your code following the examples below, paying special attention to the sections on [Authentication](#authentication) and [Restrictions](#restrictions). -We're working hard in [this issue](https://github.com/transitive-bullshit/chatgpt-api/issues/96) to improve this process. Keep in mind that this package will be updated to use the official API as soon as it's released. 💪 +We're working hard to improve this process (especially CAPTCHA automation). Keep in mind that this package will be updated to use the official API as soon as it's released, so things should get much easier over time. 💪 -Cheers, +Lastly, please star this repo and follow me on twitter twitter to help support the project. + +Thanks && cheers, Travis --- @@ -45,9 +47,11 @@ You can use it to start building projects powered by ChatGPT like chatbots, webs ## Install ```bash -npm install chatgpt +npm install chatgpt puppeteer ``` +`puppeteer` is an optional peer dependency used to automate bypassing the Cloudflare protections via `getOpenAIAuth`. The main API wrapper uses `fetch` directly. + ## Usage ```ts @@ -159,16 +163,13 @@ npx tsx src/demo-conversation.ts ### Authentication -#### Restrictions +On December 11, 2022, OpenAI added some additional Cloudflare protections which make it more difficult to access the unofficial API. -**Please read carefully** +You'll need a valid OpenAI "session token" and Cloudflare "clearance token" in order to use the API. -- You must use `node >= 18`. I'm using `v19.2.0` in my testing, but for some reason, all `fetch` requests using Node.js `v16` and `v17` fail at the moment (these use `undici` under the hood, whereas Node.js v18 and above use a built-in `fetch` based on `undici`). -- Cloudflare `cf_clearance` **tokens expire after 2 hours**, so right now we recommend that you refresh your `cf_clearance` token every hour or so. -- Your `user-agent` and `IP address` **must match** from the real browser window you're logged in with to the one you're using for `ChatGPTAPI`. - - This means that you currently can't log in with your laptop and then run the bot on a server or proxy somewhere. -- Cloudflare will still sometimes ask you to complete a CAPTCHA, so you may need to keep an eye on it and manually resolve the CAPTCHA. Automated CAPTCHA bypass is coming soon. -- You should not be using this account while the bot is using it, because that browser window may refresh one of your tokens and invalidate the bot's session. +We've provided an automated, Puppeteer-based solution `getOpenAIAuth` to fetch these for you, but you may still run into cases where you have to manually pass the CAPTCHA. We're working on a solution to automate this further. + +You can also get these tokens manually, but keep in mind that the `clearanceToken` only lasts for max 2 hours.
Getting tokens manually @@ -187,6 +188,17 @@ To get a session token manually: > **Note** > This package will switch to using the official API once it's released. +#### Restrictions + +**Please read these carefully** + +- You must use `node >= 18` at the moment. I'm using `v19.2.0` in my testing. +- Cloudflare `cf_clearance` **tokens expire after 2 hours**, so right now we recommend that you refresh your `cf_clearance` token every hour or so. +- Your `user-agent` and `IP address` **must match** from the real browser window you're logged in with to the one you're using for `ChatGPTAPI`. + - This means that you currently can't log in with your laptop and then run the bot on a server or proxy somewhere. +- Cloudflare will still sometimes ask you to complete a CAPTCHA, so you may need to keep an eye on it and manually resolve the CAPTCHA. Automated CAPTCHA bypass is coming soon. +- You should not be using this account while the bot is using it, because that browser window may refresh one of your tokens and invalidate the bot's session. + > **Note** > Prior to v1.0.0, this package used a headless browser via [Playwright](https://playwright.dev/) to automate the web UI. Here are the [docs for the initial browser version](https://github.com/transitive-bullshit/chatgpt-api/tree/v0.4.2). From a4ed68b18b7325287d9958cff6872bf43553503a Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Mon, 12 Dec 2022 11:35:40 -0600 Subject: [PATCH 5/8] chore: update auto-generated docs --- docs/classes/ChatGPTAPI.md | 20 +++++------ docs/classes/ChatGPTConversation.md | 10 +++--- docs/classes/ChatGPTError.md | 8 ++--- docs/modules.md | 54 ++++++++++++++--------------- docs/readme.md | 38 +++++++++++++------- 5 files changed, 71 insertions(+), 59 deletions(-) diff --git a/docs/classes/ChatGPTAPI.md b/docs/classes/ChatGPTAPI.md index 84fb046b..e3e1ae8e 100644 --- a/docs/classes/ChatGPTAPI.md +++ b/docs/classes/ChatGPTAPI.md @@ -52,7 +52,7 @@ to obtain your `clearanceToken`. #### Defined in -[src/chatgpt-api.ts:45](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L45) +[src/chatgpt-api.ts:45](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L45) ## Accessors @@ -68,7 +68,7 @@ Gets the current Cloudflare clearance token (`cf_clearance` cookie value). #### Defined in -[src/chatgpt-api.ts:136](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L136) +[src/chatgpt-api.ts:136](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L136) ___ @@ -84,7 +84,7 @@ Gets the current session token. #### Defined in -[src/chatgpt-api.ts:131](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L131) +[src/chatgpt-api.ts:131](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L131) ___ @@ -100,7 +100,7 @@ Gets the currently signed-in user, if authenticated, `null` otherwise. #### Defined in -[src/chatgpt-api.ts:126](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L126) +[src/chatgpt-api.ts:126](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L126) ___ @@ -116,7 +116,7 @@ Gets the current user agent. #### Defined in -[src/chatgpt-api.ts:141](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L141) +[src/chatgpt-api.ts:141](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L141) ## Methods @@ -133,7 +133,7 @@ is still valid. #### Defined in -[src/chatgpt-api.ts:319](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L319) +[src/chatgpt-api.ts:319](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L319) ___ @@ -160,7 +160,7 @@ The new conversation instance #### Defined in -[src/chatgpt-api.ts:425](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L425) +[src/chatgpt-api.ts:425](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L425) ___ @@ -177,7 +177,7 @@ the token fails. #### Defined in -[src/chatgpt-api.ts:306](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L306) +[src/chatgpt-api.ts:306](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L306) ___ @@ -203,7 +203,7 @@ A valid access token #### Defined in -[src/chatgpt-api.ts:333](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L333) +[src/chatgpt-api.ts:333](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L333) ___ @@ -234,4 +234,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-api.ts:166](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-api.ts#L166) +[src/chatgpt-api.ts:166](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-api.ts#L166) diff --git a/docs/classes/ChatGPTConversation.md b/docs/classes/ChatGPTConversation.md index f1fd62b0..d68c246f 100644 --- a/docs/classes/ChatGPTConversation.md +++ b/docs/classes/ChatGPTConversation.md @@ -41,7 +41,7 @@ Creates a new conversation wrapper around the ChatGPT API. #### Defined in -[src/chatgpt-conversation.ts:21](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L21) +[src/chatgpt-conversation.ts:21](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-conversation.ts#L21) ## Properties @@ -51,7 +51,7 @@ Creates a new conversation wrapper around the ChatGPT API. #### Defined in -[src/chatgpt-conversation.ts:10](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L10) +[src/chatgpt-conversation.ts:10](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-conversation.ts#L10) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[src/chatgpt-conversation.ts:11](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L11) +[src/chatgpt-conversation.ts:11](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-conversation.ts#L11) ___ @@ -71,7 +71,7 @@ ___ #### Defined in -[src/chatgpt-conversation.ts:12](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L12) +[src/chatgpt-conversation.ts:12](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-conversation.ts#L12) ## Methods @@ -104,4 +104,4 @@ The response from ChatGPT #### Defined in -[src/chatgpt-conversation.ts:48](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/chatgpt-conversation.ts#L48) +[src/chatgpt-conversation.ts:48](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/chatgpt-conversation.ts#L48) diff --git a/docs/classes/ChatGPTError.md b/docs/classes/ChatGPTError.md index 776f060b..07310928 100644 --- a/docs/classes/ChatGPTError.md +++ b/docs/classes/ChatGPTError.md @@ -66,7 +66,7 @@ node_modules/.pnpm/typescript@4.9.3/node_modules/typescript/lib/lib.es2022.error #### Defined in -[src/types.ts:298](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L298) +[src/types.ts:298](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L298) ___ @@ -76,7 +76,7 @@ ___ #### Defined in -[src/types.ts:297](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L297) +[src/types.ts:297](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L297) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[src/types.ts:295](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L295) +[src/types.ts:295](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L295) ___ @@ -96,4 +96,4 @@ ___ #### Defined in -[src/types.ts:296](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L296) +[src/types.ts:296](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L296) diff --git a/docs/modules.md b/docs/modules.md index 0ea1073c..f9504e9e 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -51,7 +51,7 @@ #### Defined in -[src/types.ts:109](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L109) +[src/types.ts:109](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L109) ___ @@ -61,7 +61,7 @@ ___ #### Defined in -[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L1) +[src/types.ts:1](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L1) ___ @@ -83,7 +83,7 @@ https://chat.openapi.com/backend-api/conversation #### Defined in -[src/types.ts:134](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L134) +[src/types.ts:134](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L134) ___ @@ -101,7 +101,7 @@ ___ #### Defined in -[src/types.ts:251](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L251) +[src/types.ts:251](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L251) ___ @@ -126,7 +126,7 @@ ___ #### Defined in -[src/types.ts:257](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L257) +[src/types.ts:257](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L257) ___ @@ -136,7 +136,7 @@ ___ #### Defined in -[src/types.ts:276](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L276) +[src/types.ts:276](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L276) ___ @@ -153,7 +153,7 @@ ___ #### Defined in -[src/types.ts:270](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L270) +[src/types.ts:270](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L270) ___ @@ -175,7 +175,7 @@ https://chat.openapi.com/backend-api/conversation/message_feedback #### Defined in -[src/types.ts:193](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L193) +[src/types.ts:193](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L193) ___ @@ -185,7 +185,7 @@ ___ #### Defined in -[src/types.ts:249](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L249) +[src/types.ts:249](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L249) ___ @@ -205,7 +205,7 @@ ___ #### Defined in -[src/types.ts:222](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L222) +[src/types.ts:222](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L222) ___ @@ -215,7 +215,7 @@ ___ #### Defined in -[src/types.ts:220](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L220) +[src/types.ts:220](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L220) ___ @@ -225,7 +225,7 @@ ___ #### Defined in -[src/types.ts:275](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L275) +[src/types.ts:275](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L275) ___ @@ -243,7 +243,7 @@ ___ #### Defined in -[src/types.ts:77](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L77) +[src/types.ts:77](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L77) ___ @@ -261,7 +261,7 @@ https://chat.openapi.com/backend-api/models #### Defined in -[src/types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L70) +[src/types.ts:70](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L70) ___ @@ -280,7 +280,7 @@ https://chat.openapi.com/backend-api/moderations #### Defined in -[src/types.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L97) +[src/types.ts:97](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L97) ___ @@ -300,7 +300,7 @@ https://chat.openapi.com/backend-api/moderations #### Defined in -[src/types.ts:114](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L114) +[src/types.ts:114](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L114) ___ @@ -322,7 +322,7 @@ to authenticate with the unofficial ChatGPT API. #### Defined in -[src/openai-auth.ts:17](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/openai-auth.ts#L17) +[src/openai-auth.ts:17](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/openai-auth.ts#L17) ___ @@ -340,7 +340,7 @@ ___ #### Defined in -[src/types.ts:161](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L161) +[src/types.ts:161](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L161) ___ @@ -357,7 +357,7 @@ ___ #### Defined in -[src/types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L178) +[src/types.ts:178](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L178) ___ @@ -367,7 +367,7 @@ ___ #### Defined in -[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L3) +[src/types.ts:3](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L3) ___ @@ -377,7 +377,7 @@ ___ #### Defined in -[src/types.ts:289](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L289) +[src/types.ts:289](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L289) ___ @@ -400,7 +400,7 @@ ___ #### Defined in -[src/types.ts:278](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L278) +[src/types.ts:278](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L278) ___ @@ -421,7 +421,7 @@ https://chat.openapi.com/api/auth/session #### Defined in -[src/types.ts:8](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L8) +[src/types.ts:8](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L8) ___ @@ -443,7 +443,7 @@ ___ #### Defined in -[src/types.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/types.ts#L30) +[src/types.ts:30](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/types.ts#L30) ## Functions @@ -467,7 +467,7 @@ recognizes it and blocks access. #### Defined in -[src/openai-auth.ts:127](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/openai-auth.ts#L127) +[src/openai-auth.ts:127](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/openai-auth.ts#L127) ___ @@ -505,7 +505,7 @@ with your updated credentials. #### Defined in -[src/openai-auth.ts:39](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/openai-auth.ts#L39) +[src/openai-auth.ts:39](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/openai-auth.ts#L39) ___ @@ -525,4 +525,4 @@ ___ #### Defined in -[src/utils.ts:4](https://github.com/transitive-bullshit/chatgpt-api/blob/1d621d0/src/utils.ts#L4) +[src/utils.ts:4](https://github.com/transitive-bullshit/chatgpt-api/blob/a48c177/src/utils.ts#L4) diff --git a/docs/readme.md b/docs/readme.md index 7ed32846..b6c80936 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -4,13 +4,15 @@ chatgpt / [Exports](modules.md) Yesterday, OpenAI added additional Cloudflare protections that make it more difficult to access the unofficial API. -The demos have been updated to use Puppeteer to log in to ChatGPT and extract the Cloudflare `cf_clearance` cookie and OpenAI session token. 🔥 +This package has been updated to use Puppeteer to automatically log in to ChatGPT and extract the necessary auth credentials. 🔥 -To use the updated version, make sure you're using the latest version of this package and Node.js >= 18. Then update your code to use the examples below, paying special attention to the sections on [Authentication](#authentication) and [Restrictions](#restrictions). +To use the updated version, **make sure you're using the latest version of this package and Node.js >= 18**. Then update your code following the examples below, paying special attention to the sections on [Authentication](#authentication) and [Restrictions](#restrictions). -We're working hard in [this issue](https://github.com/transitive-bullshit/chatgpt-api/issues/96) to improve this process. Keep in mind that this package will be updated to use the official API as soon as it's released. 💪 +We're working hard to improve this process (especially CAPTCHA automation). Keep in mind that this package will be updated to use the official API as soon as it's released, so things should get much easier over time. 💪 -Cheers, +Lastly, please star this repo and follow me on twitter twitter to help support the project. + +Thanks && cheers, Travis --- @@ -47,9 +49,11 @@ You can use it to start building projects powered by ChatGPT like chatbots, webs ## Install ```bash -npm install chatgpt +npm install chatgpt puppeteer ``` +`puppeteer` is an optional peer dependency used to automate bypassing the Cloudflare protections via `getOpenAIAuth`. The main API wrapper uses `fetch` directly. + ## Usage ```ts @@ -161,16 +165,13 @@ npx tsx src/demo-conversation.ts ### Authentication -#### Restrictions +On December 11, 2022, OpenAI added some additional Cloudflare protections which make it more difficult to access the unofficial API. -**Please read carefully** +You'll need a valid OpenAI "session token" and Cloudflare "clearance token" in order to use the API. -- You must use `node >= 18`. I'm using `v19.2.0` in my testing, but for some reason, all `fetch` requests using Node.js `v16` and `v17` fail at the moment (these use `undici` under the hood, whereas Node.js v18 and above use a built-in `fetch` based on `undici`). -- Cloudflare `cf_clearance` **tokens expire after 2 hours**, so right now we recommend that you refresh your `cf_clearance` token every hour or so. -- Your `user-agent` and `IP address` **must match** from the real browser window you're logged in with to the one you're using for `ChatGPTAPI`. - - This means that you currently can't log in with your laptop and then run the bot on a server or proxy somewhere. -- Cloudflare will still sometimes ask you to complete a CAPTCHA, so you may need to keep an eye on it and manually resolve the CAPTCHA. Automated CAPTCHA bypass is coming soon. -- You should not be using this account while the bot is using it, because that browser window may refresh one of your tokens and invalidate the bot's session. +We've provided an automated, Puppeteer-based solution `getOpenAIAuth` to fetch these for you, but you may still run into cases where you have to manually pass the CAPTCHA. We're working on a solution to automate this further. + +You can also get these tokens manually, but keep in mind that the `clearanceToken` only lasts for max 2 hours.
Getting tokens manually @@ -189,6 +190,17 @@ To get a session token manually: > **Note** > This package will switch to using the official API once it's released. +#### Restrictions + +**Please read these carefully** + +- You must use `node >= 18` at the moment. I'm using `v19.2.0` in my testing. +- Cloudflare `cf_clearance` **tokens expire after 2 hours**, so right now we recommend that you refresh your `cf_clearance` token every hour or so. +- Your `user-agent` and `IP address` **must match** from the real browser window you're logged in with to the one you're using for `ChatGPTAPI`. + - This means that you currently can't log in with your laptop and then run the bot on a server or proxy somewhere. +- Cloudflare will still sometimes ask you to complete a CAPTCHA, so you may need to keep an eye on it and manually resolve the CAPTCHA. Automated CAPTCHA bypass is coming soon. +- You should not be using this account while the bot is using it, because that browser window may refresh one of your tokens and invalidate the bot's session. + > **Note** > Prior to v1.0.0, this package used a headless browser via [Playwright](https://playwright.dev/) to automate the web UI. Here are the [docs for the initial browser version](https://github.com/transitive-bullshit/chatgpt-api/tree/v0.4.2). From 0b605c0786c89756cc56149c838d44b5599fe554 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Mon, 12 Dec 2022 11:41:26 -0600 Subject: [PATCH 6/8] docs: update readme instructions --- readme.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index fb47784c..a9b12d42 100644 --- a/readme.md +++ b/readme.md @@ -58,8 +58,7 @@ npm install chatgpt puppeteer import { ChatGPTAPI, getOpenAIAuth } from 'chatgpt' async function example() { - // uses puppeteer to bypass cloudflare (headful because you may have to solve - // a captcha) + // use puppeteer to bypass cloudflare (headful because of captchas) const openAIAuth = await getOpenAIAuth({ email: process.env.EMAIL, password: process.env.EMAIL @@ -174,7 +173,7 @@ You can also get these tokens manually, but keep in mind that the `clearanceToke
Getting tokens manually -To get a session token manually: +To get session token manually: 1. Go to https://chat.openai.com/chat and log in or sign up. 2. Open dev tools. @@ -182,11 +181,14 @@ To get a session token manually: ![ChatGPT cookies](./media/session-token.png) 4. Copy the value for `__Secure-next-auth.session-token` and save it to your environment. This will be your `sessionToken`. 5. Copy the value for `cf_clearance` and save it to your environment. This will be your `clearanceToken`. +6. Copy the value of the `user-agent` header from any request in your `Network` tab. This will be your `userAgent`. + +Pass `sessionToken`, `clearanceToken`, and `userAgent` to the `ChatGPTAPI` constructor.
> **Note** -> This package will switch to using the official API once it's released. +> This package will switch to using the official API once it's released, which will make this process much simpler. #### Restrictions @@ -254,15 +256,14 @@ If you create a cool integration, feel free to open a PR and add it to the list. This package is ESM-only. It supports: - Node.js >= 18 - - Node.js 17, 16, and 14 were supported in earlier versions, but OpenAI's Cloudflare update caused a bug with `undici` on v17 and v16 that we need to debug. So for now, use `node >= 18` - - We recommend against using `chatgpt` from client-side browser code because it would expose your private session token - - If you want to build a website using `chatgpt`, we recommend using it only from your backend API + - Node.js 17, 16, and 14 were supported in earlier versions, but OpenAI's Cloudflare update caused a bug with `undici` on v17 and v16 that needs investigation. So for now, use `node >= 18` +- We recommend against using `chatgpt` from client-side browser code because it would expose your private session token +- If you want to build a website using `chatgpt`, we recommend using it only from your backend API ## Credits -- Huge thanks to [@simon300000](https://github.com/simon300000), [@RomanHotsiy](https://github.com/RomanHotsiy), [@ElijahPepe](https://github.com/ElijahPepe), and all the other contributors 💪 +- Huge thanks to [@wong2](https://github.com/wong2), [@simon300000](https://github.com/simon300000), [@RomanHotsiy](https://github.com/RomanHotsiy), [@ElijahPepe](https://github.com/ElijahPepe), and all the other contributors 💪 - The original browser version was inspired by this [Go module](https://github.com/danielgross/whatsapp-gpt) by [Daniel Gross](https://github.com/danielgross) -- The original REST version was inspired by [chat-gpt-google-extension](https://github.com/wong2/chat-gpt-google-extension) by [@wong2](https://github.com/wong2) - [OpenAI](https://openai.com) for creating [ChatGPT](https://openai.com/blog/chatgpt/) 🔥 ## License From 285e10c0780896aa4c3008e0158667a9e650bcdc Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Mon, 12 Dec 2022 12:33:29 -0600 Subject: [PATCH 7/8] feat: update deps lockfile --- pnpm-lock.yaml | 145 +++++-------------------------------------------- 1 file changed, 14 insertions(+), 131 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 02b5c3d9..1ef0f69b 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -26,27 +26,25 @@ specifiers: typedoc: ^0.23.21 typedoc-plugin-markdown: ^3.13.6 typescript: ^4.9.3 - undici: ^5.13.0 uuid: ^9.0.0 dependencies: + delay: 5.0.0 eventsource-parser: 0.0.5 expiry-map: 2.0.0 p-timeout: 6.0.0 + puppeteer-extra: 3.3.4_puppeteer@19.4.0 + puppeteer-extra-plugin-stealth: 2.11.1_puppeteer-extra@3.3.4 remark: 14.0.2 strip-markdown: 5.0.0 uuid: 9.0.0 -optionalDependencies: - undici: 5.13.0 - devDependencies: '@trivago/prettier-plugin-sort-imports': 4.0.0_prettier@2.8.0 '@types/node': 18.11.10 '@types/uuid': 9.0.0 ava: 5.1.0 del-cli: 5.0.0 - delay: 5.0.0 dotenv-safe: 8.2.0 husky: 8.0.2 lint-staged: 13.0.4 @@ -54,8 +52,6 @@ devDependencies: ora: 6.1.2 prettier: 2.8.0 puppeteer: 19.4.0 - puppeteer-extra: 3.3.4_puppeteer@19.4.0 - puppeteer-extra-plugin-stealth: 2.11.1_puppeteer-extra@3.3.4 tsup: 6.5.0_typescript@4.9.3 tsx: 3.12.1 typedoc: 0.23.21_typescript@4.9.3 @@ -77,7 +73,6 @@ packages: engines: {node: '>=6.9.0'} dependencies: '@babel/highlight': 7.18.6 - dev: true /@babel/compat-data/7.20.5: resolution: {integrity: sha512-KZXo2t10+/jxmkhNXc7pZTqRvSOIvVv/+lJwHS+B2rErwOyjuVRh60yVpb7liQ1U5t7lLJ1bz+t8tSypUZdm0g==} @@ -203,7 +198,6 @@ packages: /@babel/helper-validator-identifier/7.19.1: resolution: {integrity: sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w==} engines: {node: '>=6.9.0'} - dev: true /@babel/helper-validator-option/7.18.6: resolution: {integrity: sha512-XO7gESt5ouv/LRJdrVjkShckw6STTaB7l9BrpBaAHDeF5YZT+01PCwmR0SJHnkW6i8OwW/EVWRShfi4j2x+KQw==} @@ -228,7 +222,6 @@ packages: '@babel/helper-validator-identifier': 7.19.1 chalk: 2.4.2 js-tokens: 4.0.0 - dev: true /@babel/parser/7.18.9: resolution: {integrity: sha512-9uJveS9eY9DJ0t64YbIBZICtJy8a5QrDEVdiLCG97fVLpDTpGX7t8mMSb6OWw6Lrnjqj4O8zwjELX3dhoMgiBg==} @@ -428,6 +421,7 @@ packages: resolution: {integrity: sha512-9AonUzyTjXXhEOa0DnqpzZi6VHlqKMswga9EXjpXnnqxwLtdvPPtlO8evrI5D9S6asFRCQ6v+wpiUKbw+vKqyg==} dependencies: '@types/ms': 0.7.31 + dev: false /@types/mdast/3.0.10: resolution: {integrity: sha512-W864tg/Osz1+9f4lrGTZpCSO5/z4608eUp19tbozkq2HJK6i3z1kT0H9tlADXuYIb1YYOBByU4Jsqkk75q48qA==} @@ -441,10 +435,10 @@ packages: /@types/ms/0.7.31: resolution: {integrity: sha512-iiUgKzV9AuaEkZqkOLDIvlQiL6ltuZd9tGcW3gwpnX8JbuiuhFlEGmmFXEXkN50Cvq7Os88IY2v0dkDqXYWVgA==} + dev: false /@types/node/18.11.10: resolution: {integrity: sha512-juG3RWMBOqcOuXC643OAdSA525V44cVgGV6dUDuiFtss+8Fk5x1hI93Rsld43VeJVIeqlP9I7Fn9/qaVqoEAuQ==} - dev: true /@types/normalize-package-data/2.4.1: resolution: {integrity: sha512-Gj7cI7z+98M282Tqmp2K5EIsoouUEzbBJhQQzDE3jSIRk6r9gsz0oUokqIUR4u1R3dMHo0pDHM7sNOHyhulypw==} @@ -463,7 +457,6 @@ packages: requiresBuild: true dependencies: '@types/node': 18.11.10 - dev: true optional: true /acorn-walk/8.2.0: @@ -484,7 +477,6 @@ packages: debug: 4.3.4 transitivePeerDependencies: - supports-color - dev: true /aggregate-error/3.1.0: resolution: {integrity: sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==} @@ -524,7 +516,6 @@ packages: engines: {node: '>=4'} dependencies: color-convert: 1.9.3 - dev: true /ansi-styles/4.3.0: resolution: {integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==} @@ -558,12 +549,10 @@ packages: /argparse/2.0.1: resolution: {integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==} - dev: true /arr-union/3.1.0: resolution: {integrity: sha512-sKpyeERZ02v1FeCZT8lrfJq5u6goHCtpTAzPwJYe7c8SPFOboNjNg1vz2L4VTn9T4PQxEx13TbXLmYUcS6Ug7Q==} engines: {node: '>=0.10.0'} - dev: true /array-find-index/1.0.2: resolution: {integrity: sha512-M1HQyIXcBGtVywBt8WVdim+lrNaK7VHp99Qt5pSNziXznKHViIBbXWtfRTpEFpF/c4FdfxNAsCCwPp5phBYJtw==} @@ -660,11 +649,9 @@ packages: /balanced-match/1.0.2: resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} - dev: true /base64-js/1.5.1: resolution: {integrity: sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==} - dev: true /binary-extensions/2.2.0: resolution: {integrity: sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==} @@ -677,7 +664,6 @@ packages: buffer: 5.7.1 inherits: 2.0.4 readable-stream: 3.6.0 - dev: true /bl/5.1.0: resolution: {integrity: sha512-tv1ZJHLfTDnXE6tMHv73YgSJaWR2AFuPwMntBe7XL/GBFHnT0CLnsHMogfk5+GzCDC5ZWarSCYaIGATZt9dNsQ==} @@ -696,7 +682,6 @@ packages: dependencies: balanced-match: 1.0.2 concat-map: 0.0.1 - dev: true /brace-expansion/2.0.1: resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==} @@ -724,7 +709,6 @@ packages: /buffer-crc32/0.2.13: resolution: {integrity: sha512-VO9Ht/+p3SN7SKWqcrgEzjGbRSJYTx+Q1pTQC0wrWqHx0vpJraQ6GtHx8tvcg1rlK1byhU5gccxgOgj7B0TDkQ==} - dev: true /buffer-from/1.1.2: resolution: {integrity: sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==} @@ -735,7 +719,6 @@ packages: dependencies: base64-js: 1.5.1 ieee754: 1.2.1 - dev: true /buffer/6.0.3: resolution: {integrity: sha512-FTiCpNxtwiZZHEZbcbTIcZjERVICn9yq/pDFkTl95/AxzD1naBctN7YO68riM/gLSDY7sdrMby8hofADYuuqOA==} @@ -754,14 +737,6 @@ packages: load-tsconfig: 0.2.3 dev: true - /busboy/1.6.0: - resolution: {integrity: sha512-8SFQbg/0hQ9xy3UNTB0YEnsNBbWfhf7RtnzpL7TkBiTBRfrQ9Fxcnz7VJsleJpyp6rVLvXiuORqjlHi5q+PYuA==} - engines: {node: '>=10.16.0'} - dependencies: - streamsearch: 1.1.0 - dev: false - optional: true - /cac/6.7.14: resolution: {integrity: sha512-b6Ilus+c3RrdDk+JhLKUAQfzzgLEPy6wcXqS7f/xe1EETvsDP6GORG7SFuOs6cID5YkqchW/LXZbX5bc8j7ZcQ==} engines: {node: '>=8'} @@ -777,7 +752,6 @@ packages: /callsites/3.1.0: resolution: {integrity: sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==} engines: {node: '>=6'} - dev: true /callsites/4.0.0: resolution: {integrity: sha512-y3jRROutgpKdz5vzEhWM34TidDU8vkJppF8dszITeb1PQmSqV3DTxyV8G/lyO/DNvtE1YTedehmw9MPZsCBHxQ==} @@ -817,7 +791,6 @@ packages: ansi-styles: 3.2.1 escape-string-regexp: 1.0.5 supports-color: 5.5.0 - dev: true /chalk/5.1.2: resolution: {integrity: sha512-E5CkT4jWURs1Vy5qGJye+XwCkNj7Od3Af7CP6SujMetSMkLs8Do2RWJK5yx1wamHV/op8Rz+9rltjaTQWDnEFQ==} @@ -845,7 +818,6 @@ packages: /chownr/1.1.4: resolution: {integrity: sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==} - dev: true /chunkd/2.0.1: resolution: {integrity: sha512-7d58XsFmOq0j6el67Ug9mHf9ELUXsQXYJBkyxhH/k+6Ke0qXRnv0kbemx+Twc6fRJ07C49lcbdgm9FL1Ei/6SQ==} @@ -930,7 +902,6 @@ packages: kind-of: 3.2.2 lazy-cache: 1.0.4 shallow-clone: 0.1.2 - dev: true /clone/1.0.4: resolution: {integrity: sha512-JQHZ2QMW6l3aH/j6xCqQThY/9OH4D/9ls34cgkUBiEeocRTU04tHfKPBsUK1PqZCUQM7GiA0IIXJSuXHI64Kbg==} @@ -948,7 +919,6 @@ packages: resolution: {integrity: sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==} dependencies: color-name: 1.1.3 - dev: true /color-convert/2.0.1: resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==} @@ -959,7 +929,6 @@ packages: /color-name/1.1.3: resolution: {integrity: sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==} - dev: true /color-name/1.1.4: resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==} @@ -985,7 +954,6 @@ packages: /concat-map/0.0.1: resolution: {integrity: sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==} - dev: true /concordance/5.0.4: resolution: {integrity: sha512-OAcsnTEYu1ARJqWVGwf4zh4JDfHZEaSNlNccFmt8YjB2l/n19/PF2viLINHc57vO4FKIAFl2FWASIGZZWZ2Kxw==} @@ -1018,7 +986,6 @@ packages: js-yaml: 4.1.0 parse-json: 5.2.0 path-type: 4.0.0 - dev: true /cross-fetch/3.1.5: resolution: {integrity: sha512-lvb1SBsI0Z7GDwmuid+mU3kWVBwTVUbe7S0H52yaaAdQOXq2YktTCZdlAcNKFzE6QtRz0snpw9bNiPeOIkkQvw==} @@ -1026,7 +993,6 @@ packages: node-fetch: 2.6.7 transitivePeerDependencies: - encoding - dev: true /cross-spawn/6.0.5: resolution: {integrity: sha512-eTVLrBSt7fjbDygz805pMnstIs2VTBNkRm0qxZd+M7A5XDdxVRWO5MxGBXZhjY4cqLYLdtrGqRf8mBPmzwSpWQ==} @@ -1100,7 +1066,7 @@ packages: /deepmerge/4.2.2: resolution: {integrity: sha512-FJ3UgI4gIl+PHZm53knsuSFpE+nESMr7M4v9QcgB7S63Kj/6WqMiFQJpBBYz1Pt+66bZpP3Q7Lye0Oo9MPKEdg==} engines: {node: '>=0.10.0'} - dev: true + dev: false /defaults/1.0.4: resolution: {integrity: sha512-eFuaLoy/Rxalv2kr+lqMlUnrDWV+3j4pljOIJgLIhI058IQfWJ7vXhyEIHu+HtC738klGALYxOKDO0bQP3tg8A==} @@ -1142,7 +1108,7 @@ packages: /delay/5.0.0: resolution: {integrity: sha512-ReEBKkIfe4ya47wlPYf/gu5ib6yUG0/Aez0JQZQz94kiWtRQvZIQbTiehsnwHvLSWJnQdhVeqYue7Id1dKr0qw==} engines: {node: '>=10'} - dev: true + dev: false /dequal/2.0.3: resolution: {integrity: sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==} @@ -1151,7 +1117,6 @@ packages: /devtools-protocol/0.0.1068969: resolution: {integrity: sha512-ATFTrPbY1dKYhPPvpjtwWKSK2mIwGmRwX54UASn9THEuIZCe2n9k3vVuMmt6jWeL+e5QaaguEv/pMyR+JQB7VQ==} - dev: true /diff/5.1.0: resolution: {integrity: sha512-D+mk+qE8VC/PAUrlAU34N+VfXev0ghe5ywmpqrawphmVZc1bEfn56uo9qpyGp1p4xpzOHkSW4ztBd6L7Xx4ACw==} @@ -1201,13 +1166,11 @@ packages: resolution: {integrity: sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==} dependencies: once: 1.4.0 - dev: true /error-ex/1.3.2: resolution: {integrity: sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==} dependencies: is-arrayish: 0.2.1 - dev: true /es-abstract/1.20.4: resolution: {integrity: sha512-0UtvRN79eMe2L+UNEF1BwRe364sj/DXhQ/k5FmivgoSdpM90b8Jc0mDzKMGo7QS0BVbOP/bTwBKNnDc9rNzaPA==} @@ -1466,7 +1429,6 @@ packages: /escape-string-regexp/1.0.5: resolution: {integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==} engines: {node: '>=0.8.0'} - dev: true /escape-string-regexp/2.0.0: resolution: {integrity: sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==} @@ -1547,7 +1509,6 @@ packages: '@types/yauzl': 2.10.0 transitivePeerDependencies: - supports-color - dev: true /fast-diff/1.2.0: resolution: {integrity: sha512-xJuoT5+L99XlZ8twedaRf6Ax2TgQVxvgZOYoPKqZufmJib0tL2tegPBOZb1pVNgIhlqDlA0eO0c3wBvQcmzx4w==} @@ -1574,7 +1535,6 @@ packages: resolution: {integrity: sha512-cE1qsB/VwyQozZ+q1dGxR8LBYNZeofhEdUNGSMbQD3Gw2lAzX9Zb3uIU6Ebc/Fmyjo9AWWfnn0AUCHqtevs/8g==} dependencies: pend: 1.2.0 - dev: true /figures/5.0.0: resolution: {integrity: sha512-ej8ksPF4x6e5wvK9yevct0UCXh8TTFlWGVLlgjZuoBH1HwjIfKE/IdL5mq89sFA7zELi1VhKpmtDnrs7zWyeyg==} @@ -1610,23 +1570,19 @@ packages: /for-in/0.1.8: resolution: {integrity: sha512-F0to7vbBSHP8E3l6dCjxNOLuSFAACIxFy3UehTUlG7svlXi37HHsDkyVcHo0Pq8QwrE+pXvWSVX3ZT1T9wAZ9g==} engines: {node: '>=0.10.0'} - dev: true /for-in/1.0.2: resolution: {integrity: sha512-7EwmXrOjyL+ChxMhmG5lnW9MPt1aIeZEwKhQzoBUdTV0N3zuwWDZYVJatDvZ2OyzPUvdIAZDsCetk3coyMfcnQ==} engines: {node: '>=0.10.0'} - dev: true /for-own/0.1.5: resolution: {integrity: sha512-SKmowqGTJoPzLO1T0BBJpkfp3EMacCMOuH40hOUbrbzElVktk4DioXVM99QkLCyKoiuOmyjgcWMpVz2xjE7LZw==} engines: {node: '>=0.10.0'} dependencies: for-in: 1.0.2 - dev: true /fs-constants/1.0.0: resolution: {integrity: sha512-y6OAwoSIf7FyjMIv94u+b5rdheZEjzR63GTyZJm5qh4Bi+2YgwLCcI/fPFZkL5PSixOt6ZNKm+w+Hfp/Bciwow==} - dev: true /fs-extra/10.1.0: resolution: {integrity: sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==} @@ -1635,11 +1591,10 @@ packages: graceful-fs: 4.2.10 jsonfile: 6.1.0 universalify: 2.0.0 - dev: true + dev: false /fs.realpath/1.0.0: resolution: {integrity: sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==} - dev: true /fsevents/2.3.2: resolution: {integrity: sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==} @@ -1690,7 +1645,6 @@ packages: engines: {node: '>=8'} dependencies: pump: 3.0.0 - dev: true /get-stream/6.0.1: resolution: {integrity: sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==} @@ -1736,7 +1690,6 @@ packages: minimatch: 3.1.2 once: 1.4.0 path-is-absolute: 1.0.1 - dev: true /globals/11.12.0: resolution: {integrity: sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==} @@ -1768,7 +1721,6 @@ packages: /graceful-fs/4.2.10: resolution: {integrity: sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA==} - dev: true /handlebars/4.7.7: resolution: {integrity: sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==} @@ -1795,7 +1747,6 @@ packages: /has-flag/3.0.0: resolution: {integrity: sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==} engines: {node: '>=4'} - dev: true /has-property-descriptors/1.0.0: resolution: {integrity: sha512-62DVLZGoiEBDHQyqG4w9xCuZ7eJEwNmJRWw2VY84Oedb7WFcA27fiEVe8oUQx9hAUJ4ekurquucTGwsyO1XGdQ==} @@ -1841,7 +1792,6 @@ packages: debug: 4.3.4 transitivePeerDependencies: - supports-color - dev: true /human-signals/2.1.0: resolution: {integrity: sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==} @@ -1861,7 +1811,6 @@ packages: /ieee754/1.2.1: resolution: {integrity: sha512-dcyqhDvX1C46lXZcVqCpK+FtMRQVdIMN6/Df5js2zouUsqG7I6sFxitIC+7KYK29KdXOLHdu9zL4sFnoVQnqaA==} - dev: true /ignore-by-default/2.1.0: resolution: {integrity: sha512-yiWd4GVmJp0Q6ghmM2B/V3oZGRmjrKLXvHR3TE1nfoXsmoggllfZUQe74EN0fJdPFZu2NIvNdrMMLm3OsV7Ohw==} @@ -1879,7 +1828,6 @@ packages: dependencies: parent-module: 1.0.1 resolve-from: 4.0.0 - dev: true /imurmurhash/0.1.4: resolution: {integrity: sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==} @@ -1901,11 +1849,9 @@ packages: dependencies: once: 1.4.0 wrappy: 1.0.2 - dev: true /inherits/2.0.4: resolution: {integrity: sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==} - dev: true /internal-slot/1.0.3: resolution: {integrity: sha512-O0DB1JC/sPyZl7cIo78n5dR7eUSwwpYPiXRhTzNxZVAMUuB8vlnRFyLxdrVToks6XPLVnFfbzaVd5WLjhgg+vA==} @@ -1923,7 +1869,6 @@ packages: /is-arrayish/0.2.1: resolution: {integrity: sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==} - dev: true /is-bigint/1.0.4: resolution: {integrity: sha512-zB9CruMamjym81i2JZ3UMn54PKGsQzsJeo6xvN3HJJ4CAsQNB6iRutp2To77OfCNuoxspsIhzaPoO1zyCEhFOg==} @@ -1948,7 +1893,6 @@ packages: /is-buffer/1.1.6: resolution: {integrity: sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==} - dev: true /is-buffer/2.0.5: resolution: {integrity: sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ==} @@ -1980,7 +1924,6 @@ packages: /is-extendable/0.1.1: resolution: {integrity: sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==} engines: {node: '>=0.10.0'} - dev: true /is-extglob/2.1.1: resolution: {integrity: sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==} @@ -2051,7 +1994,6 @@ packages: engines: {node: '>=0.10.0'} dependencies: isobject: 3.0.1 - dev: true /is-plain-object/5.0.0: resolution: {integrity: sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q==} @@ -2118,7 +2060,6 @@ packages: /isobject/3.0.1: resolution: {integrity: sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==} engines: {node: '>=0.10.0'} - dev: true /javascript-natural-sort/0.7.1: resolution: {integrity: sha512-nO6jcEfZWQXDhOiBtG2KvKyEptz7RVbpGP4vTD2hLBdmNQSsCiicO2Ioinv6UI4y9ukqnBpy+XZ9H6uLNgJTlw==} @@ -2136,7 +2077,6 @@ packages: /js-tokens/4.0.0: resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==} - dev: true /js-yaml/3.14.1: resolution: {integrity: sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==} @@ -2151,7 +2091,6 @@ packages: hasBin: true dependencies: argparse: 2.0.1 - dev: true /jsesc/2.5.2: resolution: {integrity: sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==} @@ -2165,7 +2104,6 @@ packages: /json-parse-even-better-errors/2.3.1: resolution: {integrity: sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==} - dev: true /json5/2.2.1: resolution: {integrity: sha512-1hqLFMSrGHRHxav9q9gNjJ5EXznIxGVO09xQRrwplcS8qs28pZ8s8hupZAmqDwZUmVZ2Qb2jnyPOWcDH8m8dlA==} @@ -2183,21 +2121,18 @@ packages: universalify: 2.0.0 optionalDependencies: graceful-fs: 4.2.10 - dev: true /kind-of/2.0.1: resolution: {integrity: sha512-0u8i1NZ/mg0b+W3MGGw5I7+6Eib2nx72S/QvXa0hYjEkjTknYmEYQJwGu3mLC0BrhtJjtQafTkyRUQ75Kx0LVg==} engines: {node: '>=0.10.0'} dependencies: is-buffer: 1.1.6 - dev: true /kind-of/3.2.2: resolution: {integrity: sha512-NOW9QQXMoZGg/oqnVNoNTTIFEIid1627WCffUBJEdMxYApq7mNE7CpzucIPc+ZQg25Phej7IJSmX3hO+oblOtQ==} engines: {node: '>=0.10.0'} dependencies: is-buffer: 1.1.6 - dev: true /kind-of/6.0.3: resolution: {integrity: sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==} @@ -2212,12 +2147,10 @@ packages: /lazy-cache/0.2.7: resolution: {integrity: sha512-gkX52wvU/R8DVMMt78ATVPFMJqfW8FPz1GZ1sVHBVQHmu/WvhIWE4cE1GBzhJNFicDeYhnwp6Rl35BcAIM3YOQ==} engines: {node: '>=0.10.0'} - dev: true /lazy-cache/1.0.4: resolution: {integrity: sha512-RE2g0b5VGZsOCFOCgP7omTRYFqydmZkBwl5oNnQ1lDYC57uyO9KqNnNVxT7COSHTxrRCWVcAVOcbjk+tvh/rgQ==} engines: {node: '>=0.10.0'} - dev: true /lilconfig/2.0.6: resolution: {integrity: sha512-9JROoBW7pobfsx+Sq2JsASvCo6Pfo6WWoUW79HuB1BCoBXD4PLWJPqDF6fNj67pqBYTbAHkE57M1kS/+L1neOg==} @@ -2226,7 +2159,6 @@ packages: /lines-and-columns/1.2.4: resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} - dev: true /lint-staged/13.0.4: resolution: {integrity: sha512-HxlHCXoYRsq9QCby5wFozmZW00hMs/9e3l+/dz6Qr8Kle4UH0kJTdABAbqhzG+3pcG6QjL9kz7NgGBfph+a5dw==} @@ -2462,7 +2394,7 @@ packages: arr-union: 3.1.0 clone-deep: 0.2.4 kind-of: 3.2.2 - dev: true + dev: false /merge-stream/2.0.0: resolution: {integrity: sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==} @@ -2676,7 +2608,6 @@ packages: resolution: {integrity: sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==} dependencies: brace-expansion: 1.1.11 - dev: true /minimatch/5.1.1: resolution: {integrity: sha512-362NP+zlprccbEt/SkxKfRMHnNY85V74mVnpUpNyr3F35covl09Kec7/sEFLt3RA4oXmewtoaanoIf67SE5Y5g==} @@ -2704,11 +2635,9 @@ packages: dependencies: for-in: 0.1.8 is-extendable: 0.1.1 - dev: true /mkdirp-classic/0.5.3: resolution: {integrity: sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==} - dev: true /mri/1.2.0: resolution: {integrity: sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA==} @@ -2748,7 +2677,6 @@ packages: optional: true dependencies: whatwg-url: 5.0.0 - dev: true /node-releases/2.0.6: resolution: {integrity: sha512-PiVXnNuFm5+iYkLBNeq5211hvO38y63T0i2KKh2KnUs3RpzJ+JtODFjkD8yjLwnDkTYF1eKXheUwdssR+NRZdg==} @@ -2841,7 +2769,6 @@ packages: resolution: {integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==} dependencies: wrappy: 1.0.2 - dev: true /onetime/5.1.2: resolution: {integrity: sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==} @@ -2940,7 +2867,6 @@ packages: engines: {node: '>=6'} dependencies: callsites: 3.1.0 - dev: true /parse-json/4.0.0: resolution: {integrity: sha512-aOIos8bujGN93/8Ox/jPLh7RwVnPEysynVFE+fQZyg6jKELEHwzgKdLRFHUgXJL6kylijVSBC4BvN9OmsB48Rw==} @@ -2958,7 +2884,6 @@ packages: error-ex: 1.3.2 json-parse-even-better-errors: 2.3.1 lines-and-columns: 1.2.4 - dev: true /parse-ms/3.0.0: resolution: {integrity: sha512-Tpb8Z7r7XbbtBTrM9UhpkzzaMrqA2VXMT3YChzYltwV3P3pM6t8wl7TvpMnSTosz1aQAdVib7kdoys7vYOPerw==} @@ -2978,7 +2903,6 @@ packages: /path-is-absolute/1.0.1: resolution: {integrity: sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==} engines: {node: '>=0.10.0'} - dev: true /path-key/2.0.1: resolution: {integrity: sha512-fEHGKCSmUSDPv4uoj8AlD+joPlq3peND+HRYyxFz4KPw4z926S/b8rIuFs2FYJg3BwsxJf6A9/3eIdLaYC+9Dw==} @@ -3009,11 +2933,9 @@ packages: /path-type/4.0.0: resolution: {integrity: sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==} engines: {node: '>=8'} - dev: true /pend/1.2.0: resolution: {integrity: sha512-F3asv42UuXchdzt+xXqfW1OGlVBe+mxa2mqI0pg5yAHZPvFmY3Y6drSf/GQ1A86WgWEN9Kzh/WrgKa6iGcHXLg==} - dev: true /picocolors/1.0.0: resolution: {integrity: sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==} @@ -3093,18 +3015,15 @@ packages: /progress/2.0.3: resolution: {integrity: sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==} engines: {node: '>=0.4.0'} - dev: true /proxy-from-env/1.1.0: resolution: {integrity: sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==} - dev: true /pump/3.0.0: resolution: {integrity: sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==} dependencies: end-of-stream: 1.4.4 once: 1.4.0 - dev: true /punycode/2.1.1: resolution: {integrity: sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==} @@ -3130,7 +3049,6 @@ packages: - encoding - supports-color - utf-8-validate - dev: true /puppeteer-extra-plugin-stealth/2.11.1_puppeteer-extra@3.3.4: resolution: {integrity: sha512-n0wdC0Ilc9tk5L6FWLyd0P2gT8b2fp+2NuB+KB0oTSw3wXaZ0D6WNakjJsayJ4waGzIJFCUHkmK9zgx5NKMoFw==} @@ -3150,7 +3068,7 @@ packages: puppeteer-extra-plugin-user-preferences: 2.4.0_puppeteer-extra@3.3.4 transitivePeerDependencies: - supports-color - dev: true + dev: false /puppeteer-extra-plugin-user-data-dir/2.4.0_puppeteer-extra@3.3.4: resolution: {integrity: sha512-qrhYPTGIqzL2hpeJ5DXjf8xMy5rt1UvcqSgpGTTOUOjIMz1ROWnKHjBoE9fNBJ4+ToRZbP8MzIDXWlEk/e1zJA==} @@ -3171,7 +3089,7 @@ packages: rimraf: 3.0.2 transitivePeerDependencies: - supports-color - dev: true + dev: false /puppeteer-extra-plugin-user-preferences/2.4.0_puppeteer-extra@3.3.4: resolution: {integrity: sha512-4XxMhMkJ+qqLsPY9ULF90qS9Bj1Qrwwgp1TY9zTdp1dJuy7QSgYE7xlyamq3cKrRuzg3QUOqygJo52sVeXSg5A==} @@ -3192,7 +3110,7 @@ packages: puppeteer-extra-plugin-user-data-dir: 2.4.0_puppeteer-extra@3.3.4 transitivePeerDependencies: - supports-color - dev: true + dev: false /puppeteer-extra-plugin/3.2.2_puppeteer-extra@3.3.4: resolution: {integrity: sha512-0uatQxzuVn8yegbrEwSk03wvwpMB5jNs7uTTnermylLZzoT+1rmAQaJXwlS3+vADUbw6ELNgNEHC7Skm0RqHbQ==} @@ -3212,7 +3130,7 @@ packages: puppeteer-extra: 3.3.4_puppeteer@19.4.0 transitivePeerDependencies: - supports-color - dev: true + dev: false /puppeteer-extra/3.3.4_puppeteer@19.4.0: resolution: {integrity: sha512-fN5pHvSMJ8d1o7Z8wLLTQOUBpORD2BcFn+KDs7QnkGZs9SV69hcUcce67vX4L4bNSEG3A0P6Osrv+vWNhhdm8w==} @@ -3235,7 +3153,7 @@ packages: puppeteer: 19.4.0 transitivePeerDependencies: - supports-color - dev: true + dev: false /puppeteer/19.4.0: resolution: {integrity: sha512-sRzWEfFSZCCcFUJflGtYI2V7A6qK4Jht+2JiI2LZgn+Nv/LOZZsBDEaGl98ZrS8oEcUA5on4p2yJbE0nzHNzIg==} @@ -3253,7 +3171,6 @@ packages: - encoding - supports-color - utf-8-validate - dev: true /queue-microtask/1.2.3: resolution: {integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==} @@ -3299,7 +3216,6 @@ packages: inherits: 2.0.4 string_decoder: 1.3.0 util-deprecate: 1.0.2 - dev: true /readdirp/3.6.0: resolution: {integrity: sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==} @@ -3369,7 +3285,6 @@ packages: /resolve-from/4.0.0: resolution: {integrity: sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==} engines: {node: '>=4'} - dev: true /resolve-from/5.0.0: resolution: {integrity: sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==} @@ -3415,7 +3330,6 @@ packages: hasBin: true dependencies: glob: 7.2.3 - dev: true /rollup/3.5.1: resolution: {integrity: sha512-hdQWTvPeiAbM6SUkxV70HdGUVxsgsc+CLy5fuh4KdgUBJ0SowXiix8gANgXoG3wEuLwfoJhCT2V+WwxfWq9Ikw==} @@ -3446,7 +3360,6 @@ packages: /safe-buffer/5.2.1: resolution: {integrity: sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==} - dev: true /safe-regex-test/1.0.0: resolution: {integrity: sha512-JBUUzyOgEwXQY1NuPtvcj/qcBDbDmEvWufhlnXZIm75DEHp+afM1r1ujJpJsV/gSM4t59tpDyPi1sd6ZaPFfsA==} @@ -3489,7 +3402,6 @@ packages: kind-of: 2.0.1 lazy-cache: 0.2.7 mixin-object: 2.0.1 - dev: true /shebang-command/1.2.0: resolution: {integrity: sha512-EV3L1+UQWGor21OmnvojK36mhg+TyIKDh3iFBKBohr5xeXIhNBcx8oWdgkTEEQ+BEFFYdLRuqMfd5L84N1V5Vg==} @@ -3632,12 +3544,6 @@ packages: escape-string-regexp: 2.0.0 dev: true - /streamsearch/1.1.0: - resolution: {integrity: sha512-Mcc5wHehp9aXz1ax6bZUyY5afg9u2rv5cqQI3mRrYkGC8rW2hM02jWuwjtL++LS5qinSyhj2QfLyNsuc+VsExg==} - engines: {node: '>=10.0.0'} - dev: false - optional: true - /string-argv/0.3.1: resolution: {integrity: sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==} engines: {node: '>=0.6.19'} @@ -3690,7 +3596,6 @@ packages: resolution: {integrity: sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==} dependencies: safe-buffer: 5.2.1 - dev: true /strip-ansi/6.0.1: resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==} @@ -3764,7 +3669,6 @@ packages: engines: {node: '>=4'} dependencies: has-flag: 3.0.0 - dev: true /supports-preserve-symlinks-flag/1.0.0: resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==} @@ -3778,7 +3682,6 @@ packages: mkdirp-classic: 0.5.3 pump: 3.0.0 tar-stream: 2.2.0 - dev: true /tar-stream/2.2.0: resolution: {integrity: sha512-ujeqbceABgwMZxEJnk2HDY2DlnUZ+9oEcb1KzTVfYHio0UE6dG71n60d8D2I4qNvleWrrXpmjpt7vZeF1LnMZQ==} @@ -3789,7 +3692,6 @@ packages: fs-constants: 1.0.0 inherits: 2.0.4 readable-stream: 3.6.0 - dev: true /temp-dir/3.0.0: resolution: {integrity: sha512-nHc6S/bwIilKHNRgK/3jlhDoIHcp45YgyiwcAk46Tr0LfEqGBVpmiAyuiuxeVE44m3mXnEeVhaipLOEWmH+Njw==} @@ -3811,7 +3713,6 @@ packages: /through/2.3.8: resolution: {integrity: sha512-w89qg7PI8wAdvX60bMDP+bFoD5Dvhm9oLheFp5O4a2QF0cSBGsBX4qZmadPMvVqlLJBBci+WqGGOAPvcDeNSVg==} - dev: true /time-zone/1.0.0: resolution: {integrity: sha512-TIsDdtKo6+XrPtiTm1ssmMngN1sAhyKnTO2kunQWqNPWIVvCm15Wmw4SWInwTVgJ5u/Tr04+8Ei9TNcw4x4ONA==} @@ -3832,7 +3733,6 @@ packages: /tr46/0.0.3: resolution: {integrity: sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==} - dev: true /tr46/1.0.1: resolution: {integrity: sha512-dTpowEjclQ7Kgx5SdBkqRzVhERQXov8/l9Ft9dVM9fmg0W0KQSVaXX9T4i6twCPNtYiZM53lpSSUAwJbFPOHxA==} @@ -3975,16 +3875,6 @@ packages: dependencies: buffer: 5.7.1 through: 2.3.8 - dev: true - - /undici/5.13.0: - resolution: {integrity: sha512-UDZKtwb2k7KRsK4SdXWG7ErXiL7yTGgLWvk2AXO1JMjgjh404nFo6tWSCM2xMpJwMPx3J8i/vfqEh1zOqvj82Q==} - engines: {node: '>=12.18'} - requiresBuild: true - dependencies: - busboy: 1.6.0 - dev: false - optional: true /unified/10.1.2: resolution: {integrity: sha512-pUSWAi/RAnVy1Pif2kAoeWNBa3JVrx0MId2LASj8G+7AiHWoKZNTomq6LG326T68U7/e263X6fTdcXIy7XnF7Q==} @@ -4026,7 +3916,6 @@ packages: /universalify/2.0.0: resolution: {integrity: sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==} engines: {node: '>= 10.0.0'} - dev: true /update-browserslist-db/1.0.10_browserslist@4.21.4: resolution: {integrity: sha512-OztqDenkfFkbSG+tRxBeAnCVPckDBcvibKd35yDONx6OU8N7sqgwc7rCbkJ/WcYtVRZ4ba68d6byhC21GFh7sQ==} @@ -4041,7 +3930,6 @@ packages: /util-deprecate/1.0.2: resolution: {integrity: sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==} - dev: true /uuid/9.0.0: resolution: {integrity: sha512-MXcSTerfPa4uqyzStbRoTgt5XIe3x5+42+q1sDuy3R5MDk66URdLMOZe5aPX/SQd+kuYAh0FdP/pO28IkQyTeg==} @@ -4098,7 +3986,6 @@ packages: /webidl-conversions/3.0.1: resolution: {integrity: sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==} - dev: true /webidl-conversions/4.0.2: resolution: {integrity: sha512-YQ+BmxuTgd6UXZW3+ICGfyqRyHXVlD5GtQr5+qjiNW7bF0cqrzX500HVXPBOvgXb5YnzDd+h0zqyv61KUD7+Sg==} @@ -4114,7 +4001,6 @@ packages: dependencies: tr46: 0.0.3 webidl-conversions: 3.0.1 - dev: true /whatwg-url/7.1.0: resolution: {integrity: sha512-WUu7Rg1DroM7oQvGWfOiAK21n74Gg+T4elXEQYkOhtyLeWiJFoOGLXPKI/9gzIie9CtwVLm8wtw6YJdKyxSjeg==} @@ -4173,7 +4059,6 @@ packages: /wrappy/1.0.2: resolution: {integrity: sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==} - dev: true /write-file-atomic/5.0.0: resolution: {integrity: sha512-R7NYMnHSlV42K54lwY9lvW6MnSm1HSJqZL3xiSgi9E7//FYaI74r2G0rd+/X6VAMkHEdzxQaU5HUOXWUz5kA/w==} @@ -4194,7 +4079,6 @@ packages: optional: true utf-8-validate: optional: true - dev: true /y18n/5.0.8: resolution: {integrity: sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==} @@ -4243,7 +4127,6 @@ packages: dependencies: buffer-crc32: 0.2.13 fd-slicer: 1.1.0 - dev: true /yocto-queue/0.1.0: resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==} From 6cf9396c4684a13bdcef619021550c9fcfab1de1 Mon Sep 17 00:00:00 2001 From: Travis Fischer Date: Mon, 12 Dec 2022 12:41:19 -0600 Subject: [PATCH 8/8] docs: update readme status --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index a9b12d42..f77aee65 100644 --- a/readme.md +++ b/readme.md @@ -8,7 +8,7 @@ To use the updated version, **make sure you're using the latest version of this We're working hard to improve this process (especially CAPTCHA automation). Keep in mind that this package will be updated to use the official API as soon as it's released, so things should get much easier over time. 💪 -Lastly, please star this repo and follow me on twitter twitter to help support the project. +Lastly, please consider starring this repo and following me on twitter twitter to help support the project. Thanks && cheers, Travis