@open-wa/wa-automate 4.71.14 → 4.72.0

package/dist/api/Client.d.ts

@@ -701,7 +701,7 @@ export declare class Client {
      * @param text The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically.
      * @param chatId The chat you want to send this message to.
      * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
+     * @param customSize [INSIDERS] Anchor the size of the thumbnail
      */
     sendMessageWithThumb(thumb: string, url: string, title: string, description: string, text: Content, chatId: ChatId, quotedMsgId?: MessageId, customSize?: {
         height: number;
@@ -748,7 +748,7 @@ export declare class Client {
      * @param text string Custom text as body of the message, this needs to include the link or it will be appended after the link.
      * @param thumbnail string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
      * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
+     * @param customSize [INSIDERS] Anchor the size of the thumbnail
      */
     sendYoutubeLink(to: ChatId, url: string, text?: Content, thumbnail?: Base64, quotedMsgId?: MessageId, customSize?: {
         height: number;
@@ -761,7 +761,7 @@ export declare class Client {
      * @param text string Custom text as body of the message, this needs to include the link or it will be appended after the link.
      * @param thumbnail Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
      * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
+     * @param customSize [INSIDERS] Anchor the size of the thumbnail
      */
     sendLinkWithAutoPreview(to: ChatId, url: string, text?: Content, thumbnail?: Base64, quotedMsgId?: MessageId, customSize?: {
         height: number;
@@ -1400,10 +1400,6 @@ export declare class Client {
      *
      * Retrieves the groups that you have in common with a contact
      * @param contactId
-     * @returns Promise returning an array of common groups {
-     * id:string,
-     * title:string
-     * }
      */
     getCommonGroups(contactId: ContactId): Promise<{
         id: string;
@@ -1455,8 +1451,7 @@ export declare class Client {
     loadEarlierMessages(contactId: ContactId): Promise<Message[]>;
     /**
      * Get the status of a contact
-     * @param contactId {string} to '000000000000@c.us'
-     * returns: {id: string,status: string}
+     * @param contactId to '000000000000@c.us'
      */
     getStatus(contactId: ContactId): Promise<{
         id: string;
@@ -1474,8 +1469,18 @@ export declare class Client {
      *
      * Use a raw payload within your open-wa session
      *
+     * @example
+     * If there is a code block, then both TypeDoc and VSCode will treat
+     * text outside of the code block as regular text.
+     *
+     * ```ts
+     * await B('44123456789@c.us', {
+     *  test: 1
+     * })
+     * ```
+     * {@link loadAllEarlierMessages}
      * @param chatId
-     * @param payload {any}
+     * @param payload
      * returns: MessageId
      */
     B(chatId: ChatId, payload: {
@@ -1853,7 +1858,7 @@ export declare class Client {
      *
      * @param to ChatId The chat id you want to send the webp sticker to
      * @param file [[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the mp4 file
-     * @param messageId message id of the message you want this sticker to reply to. {@license:insiders@}
+     * @param messageId message id of the message you want this sticker to reply to. @license:insiders@
      */
     sendMp4AsSticker(to: ChatId, file: DataURL | Buffer | Base64 | string, processOptions?: Mp4StickerConversionProcessOptions, stickerMetadata?: StickerMetadata, messageId?: MessageId): Promise<MessageId | string | boolean>;
     /**
@@ -1861,7 +1866,7 @@ export declare class Client {
      *
      * @param to ChatId The chat id you want to send the webp sticker to
      * @param emojiId The discord emoji id without indentifying chars. In discord you would write `:who:`, here use `who`
-     * @param messageId message id of the message you want this sticker to reply to. {@license:insiders@}
+     * @param messageId message id of the message you want this sticker to reply to. @license:insiders@
      */
     sendEmoji(to: ChatId, emojiId: string, messageId?: MessageId): Promise<MessageId | boolean | string>;
     /**

package/dist/api/Client.js

@@ -1713,7 +1713,7 @@ class Client {
      * @param text The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically.
      * @param chatId The chat you want to send this message to.
      * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
+     * @param customSize [INSIDERS] Anchor the size of the thumbnail
      */
     sendMessageWithThumb(thumb, url, title, description, text, chatId, quotedMsgId, customSize) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1841,7 +1841,7 @@ class Client {
      * @param text string Custom text as body of the message, this needs to include the link or it will be appended after the link.
      * @param thumbnail string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
      * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
+     * @param customSize [INSIDERS] Anchor the size of the thumbnail
      */
     sendYoutubeLink(to, url, text = '', thumbnail, quotedMsgId, customSize) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1855,7 +1855,7 @@ class Client {
      * @param text string Custom text as body of the message, this needs to include the link or it will be appended after the link.
      * @param thumbnail Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
      * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
+     * @param customSize [INSIDERS] Anchor the size of the thumbnail
      */
     sendLinkWithAutoPreview(to, url, text, thumbnail, quotedMsgId, customSize) {
         var _a;
@@ -2900,10 +2900,6 @@ class Client {
      *
      * Retrieves the groups that you have in common with a contact
      * @param contactId
-     * @returns Promise returning an array of common groups {
-     * id:string,
-     * title:string
-     * }
      */
     getCommonGroups(contactId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -2984,8 +2980,7 @@ class Client {
     }
     /**
      * Get the status of a contact
-     * @param contactId {string} to '000000000000@c.us'
-     * returns: {id: string,status: string}
+     * @param contactId to '000000000000@c.us'
      */
     getStatus(contactId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -3004,8 +2999,18 @@ class Client {
      *
      * Use a raw payload within your open-wa session
      *
+     * @example
+     * If there is a code block, then both TypeDoc and VSCode will treat
+     * text outside of the code block as regular text.
+     *
+     * ```ts
+     * await B('44123456789@c.us', {
+     *  test: 1
+     * })
+     * ```
+     * {@link loadAllEarlierMessages}
      * @param chatId
-     * @param payload {any}
+     * @param payload
      * returns: MessageId
      */
     B(chatId, payload) {
@@ -3697,7 +3702,7 @@ class Client {
      *
      * @param to ChatId The chat id you want to send the webp sticker to
      * @param file [[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the mp4 file
-     * @param messageId message id of the message you want this sticker to reply to. {@license:insiders@}
+     * @param messageId message id of the message you want this sticker to reply to. @license:insiders@
      */
     sendMp4AsSticker(to, file, processOptions = media_1.defaultProcessOptions, stickerMetadata, messageId) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -3744,7 +3749,7 @@ class Client {
      *
      * @param to ChatId The chat id you want to send the webp sticker to
      * @param emojiId The discord emoji id without indentifying chars. In discord you would write `:who:`, here use `who`
-     * @param messageId message id of the message you want this sticker to reply to. {@license:insiders@}
+     * @param messageId message id of the message you want this sticker to reply to. @license:insiders@
      */
     sendEmoji(to, emojiId, messageId) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/api/model/config.d.ts

@@ -191,6 +191,7 @@ export interface ProxyServerCredentials {
 }
 export interface ConfigObject {
     /**
+     * @deprecated
      * The authentication object (as a JSON object or a base64 encoded string) that is required to migrate a session from one instance to another or to just restart an existing instance.
      * This sessionData is provided in a generated JSON file (it's a json file but contains the JSON data as a base64 encoded string) upon QR scan or an event.
      *
@@ -223,6 +224,15 @@ export interface ConfigObject {
      * Setting the sessionData in the environmental variable will override the sessionData object in the config.
      */
     sessionData?: SessionData | Base64;
+    /**
+     * There is a new way to login to your host account by entering a link code after a confirmation step from the host account device. In order to use this feature you MUST set the host account number as a string or number beforehand as a property of the config object.
+     *
+     * e.g
+     * ```
+     * linkCode: '1234567890'
+     * ```
+     */
+    linkCode?: string;
     /**
      * ALPHA EXPERIMENTAL FEATURE! DO NOT USE IN PRODUCTION, REQUIRES TESTING.
      *

package/dist/build/build-postman.js

@@ -187,8 +187,8 @@ const postmanRequestGeneratorGenerator = setup => method => {
             }
         },
         url,
-        "documentationUrl": `https://docs.openwa.dev/classes/api_Client.Client.html#${method.name}`,
-        "description": `${method.text}\n[External Documentation](https://docs.openwa.dev/classes/api_Client.Client.html#${method.name})`
+        "documentationUrl": `https://docs.openwa.dev/docs/reference/api/Client/classes/Client#${(method.name || "").toLowerCase()}`,
+        "description": `${method.text}\n[External Documentation](https://docs.openwa.dev/docs/reference/api/Client/classes/Client#${(method.name || "").toLowerCase()})`
     };
     if (!(setup === null || setup === void 0 ? void 0 : setup.key))
         delete request.auth;

package/dist/cli/collections.js

@@ -56,7 +56,7 @@ const generateCollections = (config, spinner) => __awaiter(void 0, void 0, void
             "description": "All methods from the Client",
             "externalDocs": {
                 "description": "Find out more",
-                "url": "https://docs.openwa.dev/classes/api_Client.Client.html"
+                "url": "https://docs.openwa.dev/docs/reference/api/Client/classes/Client"
             }
         },
         {

package/dist/cli/setup.js

@@ -116,7 +116,7 @@ exports.helptext = (0, command_line_usage_1.default)([{
         ]
     },
     {
-        content: `Please check here for more information on some of the above mentioned parameters: {underline https://docs.openwa.dev/interfaces/api_model_config.configobject}`
+        content: `Please check here for more information on some of the above mentioned parameters: {underline https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject}`
     },
     {
         content: 'Project home: {underline https://github.com/open-wa/wa-automate-nodejs}'

package/dist/controllers/auth.d.ts

@@ -25,6 +25,7 @@ export declare class QRManager {
     setConfig(config: any): void;
     qrEvF(config?: ConfigObject): any;
     grabAndEmit(qrData: any, waPage: Page, config: ConfigObject, spinner: Spin): Promise<void>;
+    linkCode(waPage: Page, config?: ConfigObject, spinner?: Spin): Promise<boolean | void | string>;
     smartQr(waPage: Page, config?: ConfigObject, spinner?: Spin): Promise<boolean | void | string>;
     emitFirst(waPage: Page, config?: ConfigObject, spinner?: Spin): Promise<void>;
     /**

package/dist/controllers/auth.js

@@ -145,6 +145,7 @@ class QRManager {
     }
     grabAndEmit(qrData, waPage, config, spinner) {
         return __awaiter(this, void 0, void 0, function* () {
+            const isLinkCode = qrData.length === 9;
             this.qrNum++;
             if (config.qrMax && this.qrNum > config.qrMax) {
                 spinner.info('QR Code limit reached, exiting...');
@@ -156,9 +157,14 @@ class QRManager {
             if (qrData) {
                 qrEv.emit(qrData, `qrData`);
                 if (!config.qrLogSkip) {
-                    qrcode.generate(qrData, { small: true }, terminalQrCode => {
-                        console.log((0, boxen_1.default)(terminalQrCode, { title: config.sessionId, padding: 1, titleAlignment: 'center' }));
-                    });
+                    if (isLinkCode) {
+                        console.log((0, boxen_1.default)(qrData, { title: `ENTER THIS CODE ON THE HOST ACCOUNT DEVICE: ${config.sessionId}`, padding: 1, titleAlignment: 'center' }));
+                    }
+                    else {
+                        qrcode.generate(qrData, { small: true }, terminalQrCode => {
+                            console.log((0, boxen_1.default)(terminalQrCode, { title: config.sessionId, padding: 1, titleAlignment: 'center' }));
+                        });
+                    }
                 }
                 else {
                     console.log(`New QR Code generated. Not printing in console because qrLogSkip is set to true`);
@@ -172,7 +178,7 @@ class QRManager {
                 this._internalQrPngLoaded = true;
             }
             try {
-                const qrPng = yield waPage.evaluate(`window.getQrPng()`);
+                const qrPng = isLinkCode ? qrData : yield waPage.evaluate(`window.getQrPng()`);
                 if (qrPng) {
                     qrEv.emit(qrPng);
                     (0, tools_1.processSend)('ready');
@@ -208,6 +214,30 @@ class QRManager {
             }
         });
     }
+    linkCode(waPage, config, spinner) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const evalResult = yield waPage.evaluate("window.Store && window.Store.State");
+            if (evalResult === false) {
+                console.log('Seems as though you have been TOS_BLOCKed, unable to refresh QR Code. Please see https://github.com/open-wa/wa-automate-nodejs#best-practice for information on how to prevent this from happeing. You will most likely not get a QR Code');
+                logging_1.log.warn('Seems as though you have been TOS_BLOCKed, unable to refresh QR Code. Please see https://github.com/open-wa/wa-automate-nodejs#best-practice for information on how to prevent this from happeing. You will most likely not get a QR Code');
+                if (config.throwErrorOnTosBlock)
+                    throw new Error('TOSBLOCK');
+            }
+            const isAuthed = yield (0, exports.isAuthenticated)(waPage);
+            if (isAuthed)
+                return true;
+            const _hasDefaultStateYet = yield waPage.evaluate("!!(window.Store &&  window.Store.State && window.Store.State.Socket)");
+            if (!_hasDefaultStateYet) {
+                //expecting issue, take a screenshot then wait a few seconds before continuing
+                yield (0, tools_1.timeout)(2000);
+            }
+            spinner.info('Link Code requested, please use the link code to login from your host account device');
+            const linkCode = yield waPage.evaluate((number) => window['linkCode'](number), config === null || config === void 0 ? void 0 : config.linkCode);
+            spinner === null || spinner === void 0 ? void 0 : spinner.succeed(`Link Code please use this to login from your host account device: ${linkCode}`);
+            yield this.grabAndEmit(linkCode, waPage, config, spinner);
+            return yield isInsideChat(waPage).toPromise();
+        });
+    }
     smartQr(waPage, config, spinner) {
         return __awaiter(this, void 0, void 0, function* () {
             const evalResult = yield waPage.evaluate("window.Store && window.Store.State");
@@ -272,6 +302,9 @@ class QRManager {
      */
     waitFirstQr(waPage, config, spinner) {
         return __awaiter(this, void 0, void 0, function* () {
+            /**
+             * Check if session is authed already
+             */
             const fqr = yield waPage.waitForFunction(`!!(${this.qrCheck})`, {
                 polling: 500,
                 timeout: 10000

package/dist/controllers/initializer.js

@@ -298,7 +298,11 @@ function create(config = {}) {
             else {
                 spinner.info('Authenticate to continue');
                 const race = [];
-                race.push(qrManager.smartQr(waPage, config, spinner));
+                if (config === null || config === void 0 ? void 0 : config.linkCode) {
+                    race.push(qrManager.linkCode(waPage, config, spinner));
+                }
+                else
+                    race.push(qrManager.smartQr(waPage, config, spinner));
                 if ((config === null || config === void 0 ? void 0 : config.qrTimeout) !== 0) {
                     let to = ((config === null || config === void 0 ? void 0 : config.qrTimeout) || 60) * 1000;
                     if (config === null || config === void 0 ? void 0 : config.multiDevice)
@@ -438,7 +442,7 @@ function create(config = {}) {
                 spinner.emit(debugInfo, "DebugInfo");
                 //@ts-ignore
                 const metrics = yield waPage.evaluate(({ config }) => WAPI.launchMetrics(config), { config });
-                const purgedMessage = (metrics === null || metrics === void 0 ? void 0 : metrics.purged) ? Object.entries(metrics.purged).filter(([, e]) => e > 0).map(([k, e]) => `${e} ${k}`).join(" and ") : "";
+                const purgedMessage = (metrics === null || metrics === void 0 ? void 0 : metrics.purged) ? Object.entries(metrics.purged).filter(([, e]) => Number(e) > 0).map(([k, e]) => `${e} ${k}`).join(" and ") : "";
                 if (metrics.isMd && !(config === null || config === void 0 ? void 0 : config.multiDevice))
                     spinner.info("!!!Please set multiDevice: true in the config or use the --mutli-Device flag!!!");
                 spinner.succeed(`Client loaded for ${metrics.isBiz ? "business" : "normal"} account ${metrics.isMd && "[MD] " || ''}with ${metrics.contacts} contacts, ${metrics.chats} chats & ${metrics.messages} messages ${purgedMessage ? `+ purged ${purgedMessage} ` : ``}in ${LAUNCH_TIME_MS / 1000}s`);