@open-wa/wa-automate 4.23.12 → 4.23.16

package/README.md

@@ -36,24 +36,17 @@
 Use this command to install the library for the first time and to keep the library up to date.
 
 ```bash
-> npm i --save @open-wa/wa-automate@latest --multi-device
+> npm i --save @open-wa/wa-automate@latest
 ```
 
 ## Usage
 
-```javascript
-// import { create, Client } from '@open-wa/wa-automate';
-const wa = require('@open-wa/wa-automate');
+## CLI
 
-wa.create().then(client => start(client));
+Want to convert your WA account to an API instantly? You can now with the CLI. For more details see [Easy API](https://docs.openwa.dev/pages/Getting%20Started/quick-run.html)
 
-function start(client) {
-  client.onMessage(async message => {
-    if (message.body === 'Hi') {
-      await client.sendText(message.from, '👋 Hello!');
-    }
-  });
-}
+```bash
+> npx @open-wa/wa-automate --help
 ```
 
 ## Custom Setup
@@ -90,13 +83,6 @@ function start(client) {
 
 ###### @open-wa/wa-automate will remember the session so there is no need to authenticate every time
 
-## CLI
-
-Want to convert your WA account to an API instantly? You can now with the CLI. For more details see [Easy API](https://docs.openwa.dev/pages/Getting%20Started/quick-run.html)
-
-```bash
-> npx @open-wa/wa-automate --help
-```
 
 ## Multi Device Support
 

package/dist/api/Client.d.ts

@@ -1198,6 +1198,12 @@ export declare class Client {
      * @returns list of messages
      */
     getIndicatedNewMessages(): Promise<Message[]>;
+    /**
+     * Fires all unread messages to the onMessage listener.
+     * Make sure to call this AFTER setting your listeners.
+     * @returns array of message IDs
+     */
+    emitUnreadMessages(): Promise<MessageId[]>;
     /**
      * Retrieves all Messages in a chat that have been loaded within the WA web instance.
      *

package/dist/api/Client.js

@@ -2410,6 +2410,16 @@ class Client {
             return JSON.parse(yield this.pup(() => WAPI.getIndicatedNewMessages()));
         });
     }
+    /**
+     * Fires all unread messages to the onMessage listener.
+     * Make sure to call this AFTER setting your listeners.
+     * @returns array of message IDs
+     */
+    emitUnreadMessages() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.pup(() => WAPI.emitUnreadMessages());
+        });
+    }
     /**
      * Retrieves all Messages in a chat that have been loaded within the WA web instance.
      *

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

@@ -5,26 +5,83 @@ export interface Chat {
     archive: boolean;
     changeNumberNewJid: any;
     changeNumberOldJid: any;
+    /**
+     * The contact related to this chat
+     */
     contact: Contact;
+    /**
+     * Group metadata for this chat
+     */
     groupMetadata: GroupMetadata;
+    /**
+     * The id of the chat
+     */
     id: ChatId;
+    /**
+     * If the chat is a group chat is restricted
+     */
     isAnnounceGrpRestrict: any;
+    /**
+     * The title of the chat
+     */
     formattedTitle?: string;
+    /**
+     * Whether your host account is able to send messages to this chat
+     */
     canSend?: boolean;
+    /**
+     * Whether the chat is a group chat
+     */
     isGroup: boolean;
+    /**
+     * Whether the chat is a group chat and the group is restricted
+     */
     isReadOnly: boolean;
     kind: string;
+    /**
+     * The labels attached to this chat.
+     */
     labels: any;
+    /**
+     * The ID of the last message received in this chat
+     */
     lastReceivedKey: any;
     modifyTag: number;
+    /**
+     * The messages in the chat
+     */
     msgs: any;
+    /**
+     * The expiration timestamp of the chat mute
+     */
     muteExpiration: number;
+    /**
+     * The name of the chat
+     */
     name: string;
+    /**
+     * Whether the chat is marked as spam
+     */
     notSpam: boolean;
+    /**
+     * Messages that are pending to be sent
+     */
     pendingMsgs: boolean;
+    /**
+     * Whether the chat is pinned
+     */
     pin: number;
+    /**
+     * The presence state of the chat participant
+     */
     presence: any;
+    /**
+     * The timestamp of the last interaction in the chat
+     */
     t: number;
+    /**
+     * The number of undread messages in this chat
+     */
     unreadCount: number;
     ack?: any;
     /**

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

@@ -97,6 +97,10 @@ export declare enum STATE {
      */
     DISCONNECTED = "DISCONNECTED"
 }
+export declare type EasyApiResponse = {
+    success: boolean;
+    response: any;
+};
 export * from './config';
 export * from './media';
 export * from './aliases';

package/dist/api/model/index.js

@@ -115,7 +115,6 @@ var STATE;
      */
     STATE["DISCONNECTED"] = "DISCONNECTED";
 })(STATE = exports.STATE || (exports.STATE = {}));
-;
 __exportStar(require("./config"), exports);
 __exportStar(require("./media"), exports);
 __exportStar(require("./aliases"), exports);

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

@@ -44,6 +44,14 @@ export declare type StickerMetadata = {
      * @default `attention`
      */
     cropPosition?: 'top' | 'right top' | 'right' | 'right bottom' | 'bottom' | 'left bottom' | 'left' | 'left top' | 'north' | 'northeast' | 'east' | 'southeast' | 'south' | 'southwest' | 'west' | 'northwest' | 'center' | 'centre' | 'entropy' | 'attention';
+    /**
+     * The corner radius of the sticker when `stickerMetadata.circle` is set to true.
+     * @default `100`
+     * @minimum `1`
+     * @maximum `100`
+     * @multipleOf `1`
+     */
+    cornerRadius?: number;
 };
 export declare type Mp4StickerConversionProcessOptions = {
     /**

package/dist/cli/collections.d.ts

@@ -1,2 +1,3 @@
 export declare const collections: {};
 export declare const generateCollections: any;
+export declare const getTypeSchemas: any;

package/dist/cli/collections.js

@@ -1,4 +1,23 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -12,14 +31,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateCollections = exports.collections = void 0;
+exports.getTypeSchemas = exports.generateCollections = exports.collections = void 0;
 const __1 = require("..");
 const postman_2_swagger_1 = __importDefault(require("postman-2-swagger"));
 const fs_extra_1 = require("fs-extra");
+const typeconv_1 = require("typeconv");
+const fs = __importStar(require("fs"));
+const glob_promise_1 = __importDefault(require("glob-promise"));
 exports.collections = {};
 const generateCollections = (config, spinner) => __awaiter(void 0, void 0, void 0, function* () {
     let swCol = null;
     let pmCol = null;
+    const _types = yield exports.getTypeSchemas();
     spinner.info('Generating Swagger Spec');
     pmCol = yield __1.generatePostmanJson(config);
     spinner.succeed(`Postman collection generated: open-wa-${config.sessionId}.postman_collection.json`);
@@ -40,6 +63,9 @@ const generateCollections = (config, spinner) => __awaiter(void 0, void 0, void
             "description": "Documentation",
             "url": swCol.paths[p].post.documentationUrl
         };
+        swCol.paths[p].post.responses['200'].schema = {
+            "$ref": "#/components/schemas/EasyApiResponse"
+        };
         swCol.paths[p].post.requestBody = {
             "description": path.summary,
             "content": {
@@ -55,20 +81,20 @@ const generateCollections = (config, spinner) => __awaiter(void 0, void 0, void
     });
     delete swCol.swagger;
     swCol.openapi = "3.0.3";
+    swCol.components = {};
+    swCol.components.schemas = _types;
     swCol.externalDocs = {
         "description": "Find more info here",
         "url": "https://openwa.dev/"
     };
     if (config.key) {
-        swCol.components = {
-            "securitySchemes": {
+        swCol.components = Object.assign(Object.assign({}, swCol.components), { "securitySchemes": {
                 "api_key": {
                     "type": "apiKey",
                     "name": "api_key",
                     "in": "header"
                 }
-            }
-        };
+            } });
         swCol.security = [
             {
                 "api_key": []
@@ -86,3 +112,22 @@ const generateCollections = (config, spinner) => __awaiter(void 0, void 0, void
     return;
 });
 exports.generateCollections = generateCollections;
+const getTypeSchemas = () => __awaiter(void 0, void 0, void 0, function* () {
+    const reader = typeconv_1.getTypeScriptReader();
+    const writer = typeconv_1.getOpenApiWriter({ format: 'json', title: 'My API', version: 'v3.0.3' });
+    const { convert } = typeconv_1.makeConverter(reader, writer, {
+        simplify: true
+    });
+    const s = (yield Promise.all([...(yield glob_promise_1.default('../**/*.d.ts')), ...(yield glob_promise_1.default('../**/message.js')), ...(yield glob_promise_1.default('../**/chat.js'))])).filter(f => !f.includes('node_modules'));
+    const res = {};
+    yield Promise.all(s.map((x) => __awaiter(void 0, void 0, void 0, function* () {
+        var _a, _b;
+        const { data } = yield convert({ data: fs.readFileSync(x, 'utf8') });
+        const schemas = (_b = (_a = JSON.parse(data)) === null || _a === void 0 ? void 0 : _a.components) === null || _b === void 0 ? void 0 : _b.schemas;
+        Object.keys(schemas).forEach(k => {
+            res[k] = schemas[k];
+        });
+    })));
+    return res;
+});
+exports.getTypeSchemas = getTypeSchemas;

package/dist/cli/index.js

@@ -188,6 +188,9 @@ function start() {
             }
             else
                 ready(Object.assign(Object.assign(Object.assign(Object.assign({}, cliConfig), createConfig), client.getSessionInfo()), { hostAccountNumber: yield client.getHostNumber() }));
+            if (cliConfig.emitUnread) {
+                yield client.emitUnreadMessages();
+            }
         }
         catch (e) {
             spinner.fail(`Error ${e.message} ${e}`);

package/dist/cli/setup.js

@@ -240,6 +240,12 @@ const optionList = [{
         type: Boolean,
         description: "Automatically reject incoming phone and video calls to the host account."
     },
+    {
+        name: 'emit-unread',
+        type: Boolean,
+        description: "Emit all unread messages via onMessage webhooks on launch.",
+        default: false
+    },
     {
         name: 'skip-url-check',
         type: Boolean,

package/dist/controllers/browser.js

@@ -305,14 +305,15 @@ function initBrowser(sessionId, config = {}) {
         let args = [...puppeteer_config_1.puppeteerConfig.chromiumArgs, ...((config === null || config === void 0 ? void 0 : config.chromiumArgs) || [])];
         if (config === null || config === void 0 ? void 0 : config.multiDevice) {
             args = args.filter(x => x != '--incognito');
-            config["userDataDir"] = `./_IGNORE_${(config === null || config === void 0 ? void 0 : config.sessionId) || 'session'}`;
+            config["userDataDir"] = config["userDataDir"] || `${(config === null || config === void 0 ? void 0 : config.inDocker) ? '/sessions' : (config === null || config === void 0 ? void 0 : config.sessionDataPath) || '.'}/_IGNORE_${(config === null || config === void 0 ? void 0 : config.sessionId) || 'session'}`;
         }
         if (config === null || config === void 0 ? void 0 : config.corsFix)
             args.push('--disable-web-security');
         const browser = (config === null || config === void 0 ? void 0 : config.browserWSEndpoint) ? yield puppeteer.connect(Object.assign({}, config)) : yield puppeteer.launch(Object.assign(Object.assign({ headless: true, args }, config), { devtools: false }));
         //devtools
         if (config === null || config === void 0 ? void 0 : config.devtools) {
-            const devtools = (yield Promise.resolve().then(() => __importStar(require('puppeteer-extra-plugin-devtools'))))();
+            const _dt = yield Promise.resolve().then(() => __importStar(require('puppeteer-extra-plugin-devtools')));
+            const devtools = _dt.default();
             if (config.devtools !== 'local' && !((_b = config === null || config === void 0 ? void 0 : config.devtools) === null || _b === void 0 ? void 0 : _b.user) && !((_c = config === null || config === void 0 ? void 0 : config.devtools) === null || _c === void 0 ? void 0 : _c.pass)) {
                 config.devtools = {};
                 config.devtools.user = 'dev';
@@ -322,6 +323,7 @@ function initBrowser(sessionId, config = {}) {
             if (config.devtools.user && config.devtools.pass) {
                 devtools.setAuthCredentials(config.devtools.user, config.devtools.pass);
             }
+            puppeteer.use(devtools);
             try {
                 // const tunnel = await devtools.createTunnel(browser);
                 const tunnel = config.devtools == 'local' ? devtools.getLocalDevToolsUrl(browser) : (yield devtools.createTunnel(browser)).url;

package/dist/controllers/initializer.js

@@ -157,7 +157,8 @@ function create(config = {}) {
             /**
              * Check if the IGNORE folder exists, therefore, assume that the session is MD.
              */
-            if (fs.existsSync(`./_IGNORE_${(config === null || config === void 0 ? void 0 : config.sessionId) || 'session'}`) && !(config === null || config === void 0 ? void 0 : config.multiDevice)) {
+            const mdDir = config["userDataDir"] || `${(config === null || config === void 0 ? void 0 : config.inDocker) ? '/sessions' : (config === null || config === void 0 ? void 0 : config.sessionDataPath) || '.'}/_IGNORE_${(config === null || config === void 0 ? void 0 : config.sessionId) || 'session'}`;
+            if (fs.existsSync(mdDir) && !(config === null || config === void 0 ? void 0 : config.multiDevice)) {
                 spinner.info(`Multi-Device directory detected. multiDevice set to true.`);
                 config.multiDevice = true;
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.23.12",
+  "version": "4.23.16",
   "licenseCheckUrl": "https://openwa.dev/license-check",
   "brokenMethodReportUrl": "https://openwa.dev/report-bm",
   "patches": "https://cdn.openwa.dev/patches.json",
@@ -120,6 +120,7 @@
     "find-up": "^5.0.0",
     "fs-extra": "^10.0.0",
     "get-port": "^5.1.1",
+    "glob-promise": "^4.2.2",
     "hasha": "^5.2.0",
     "image-type": "^4.1.0",
     "is-url-superb": "^5.0.0",
@@ -139,7 +140,7 @@
     "puppeteer": "10.4.0",
     "puppeteer-extra": "^3.1.9",
     "puppeteer-extra-plugin-block-resources": "^2.2.7",
-    "puppeteer-extra-plugin-devtools": "^2.2.8",
+    "puppeteer-extra-plugin-devtools": "^2.3.3",
     "puppeteer-extra-plugin-stealth": "^2.4.9",
     "puppeteer-page-proxy": "^1.2.8",
     "qrcode-terminal": "^0.12.0",
@@ -157,6 +158,7 @@
     "ts-json-schema-generator": "^0.95.0",
     "ts-morph": "^12.0.0",
     "type-fest": "^1.1.1",
+    "typeconv": "^1.7.0",
     "update-notifier": "^5.0.0",
     "uuid": "^8.3.2",
     "uuid-apikey": "^1.4.6",