@open-wa/wa-automate 4.31.12 → 4.32.1

package/dist/api/Client.d.ts

@@ -689,9 +689,13 @@ export declare class Client {
      */
     getSnapshot(): Promise<DataURL>;
     /**
-     * Returns an array of group ids where the host device is admin
+     * Returns an array of group ids where the host account is admin
      */
     iAmAdmin(): Promise<GroupChatId[]>;
+    /**
+     * Returns an array of group ids where the host account has been kicked
+     */
+    getKickedGroups(): Promise<GroupChatId[]>;
     /**
      * Syncs contacts with phone. This promise does not resolve so it will instantly return true.
      */
@@ -824,10 +828,10 @@ export declare class Client {
     isConnected(): Promise<boolean>;
     /**
      * Logs out from the session.
-     *
+     * @param preserveSessionData skip session.data.json file invalidation
      * Please be careful when using this as it can exit the whole process depending on your config
      */
-    logout(): Promise<boolean>;
+    logout(preserveSessionData?: boolean): Promise<boolean>;
     /**
      * Retrieves Battery Level
      * @returns Number
@@ -1042,6 +1046,24 @@ export declare class Client {
      * @returns message object
      */
     getMyLastMessage(chatId?: ChatId): Promise<Message>;
+    /**
+     * Retrieves the starred messages in a given chat
+     * @param chatId Chat ID to filter starred messages by
+     * @returns message object
+     */
+    getStarredMessages(chatId?: ChatId): Promise<Message[]>;
+    /**
+     * Star a message
+     * @param messageId Message ID of the message you want to star
+     * @returns `true`
+     */
+    starMessage(messageId?: ChatId): Promise<boolean>;
+    /**
+     * Unstar a message
+     * @param messageId Message ID of the message you want to unstar
+     * @returns `true`
+     */
+    unstarMessage(messageId?: ChatId): Promise<boolean>;
     /**
      *
      * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)

package/dist/api/Client.js

@@ -266,6 +266,7 @@ class Client {
                 this.onLogout(() => __awaiter(this, void 0, void 0, function* () {
                     var _k, _l;
                     yield this.waitAllQEmpty();
+                    yield (0, browser_1.invalidateSesssionData)(this._createConfig);
                     if ((_k = this._createConfig) === null || _k === void 0 ? void 0 : _k.deleteSessionDataOnLogout)
                         (0, browser_1.deleteSessionData)(this._createConfig);
                     if ((_l = this._createConfig) === null || _l === void 0 ? void 0 : _l.killClientOnLogout) {
@@ -1664,13 +1665,21 @@ class Client {
         });
     }
     /**
-     * Returns an array of group ids where the host device is admin
+     * Returns an array of group ids where the host account is admin
      */
     iAmAdmin() {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.pup(() => WAPI.iAmAdmin());
         });
     }
+    /**
+     * Returns an array of group ids where the host account has been kicked
+     */
+    getKickedGroups() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.pup(() => WAPI.getKickedGroups());
+        });
+    }
     /**
      * Syncs contacts with phone. This promise does not resolve so it will instantly return true.
      */
@@ -1882,11 +1891,15 @@ class Client {
     }
     /**
      * Logs out from the session.
-     *
+     * @param preserveSessionData skip session.data.json file invalidation
      * Please be careful when using this as it can exit the whole process depending on your config
      */
-    logout() {
+    logout(preserveSessionData = false) {
         return __awaiter(this, void 0, void 0, function* () {
+            if (!preserveSessionData) {
+                logging_1.log.info(`LOGOUT CALLED. INVALIDATING SESSION DATA`);
+                yield (0, browser_1.invalidateSesssionData)(this._createConfig);
+            }
             return yield this.pup(() => WAPI.logout());
         });
     }
@@ -2228,6 +2241,36 @@ class Client {
             return yield this.pup(chatId => WAPI.getMyLastMessage(chatId), chatId);
         });
     }
+    /**
+     * Retrieves the starred messages in a given chat
+     * @param chatId Chat ID to filter starred messages by
+     * @returns message object
+     */
+    getStarredMessages(chatId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.pup(chatId => WAPI.getStarredMessages(chatId), chatId);
+        });
+    }
+    /**
+     * Star a message
+     * @param messageId Message ID of the message you want to star
+     * @returns `true`
+     */
+    starMessage(messageId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.pup(messageId => WAPI.starMessage(messageId), messageId);
+        });
+    }
+    /**
+     * Unstar a message
+     * @param messageId Message ID of the message you want to unstar
+     * @returns `true`
+     */
+    unstarMessage(messageId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.pup(messageId => WAPI.unstarMessage(messageId), messageId);
+        });
+    }
     /**
      *
      * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)

package/dist/controllers/browser.d.ts

@@ -5,7 +5,8 @@ import { QRManager } from './auth';
 export declare let BROWSER_START_TS: number;
 export declare function initPage(sessionId?: string, config?: ConfigObject, qrManager?: QRManager, customUserAgent?: string, spinner?: Spin, _page?: Page, skipAuth?: boolean): Promise<Page>;
 export declare const deleteSessionData: (config: ConfigObject) => boolean;
-export declare const getSessionDataFilePath: (sessionId: string, config: ConfigObject) => string | boolean;
+export declare const invalidateSesssionData: (config: ConfigObject) => boolean;
+export declare const getSessionDataFilePath: (sessionId: string, config: ConfigObject) => string | false;
 export declare const addScript: (page: Page, js: string) => Promise<unknown>;
 export declare function injectPreApiScripts(page: Page, spinner?: Spin): Promise<Page>;
 export declare function injectWapi(page: Page, spinner?: Spin, force?: boolean): Promise<Page>;

package/dist/controllers/browser.js

@@ -31,7 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.kill = exports.injectApi = exports.injectWapi = exports.injectPreApiScripts = exports.addScript = exports.getSessionDataFilePath = exports.deleteSessionData = exports.initPage = exports.BROWSER_START_TS = void 0;
+exports.kill = exports.injectApi = exports.injectWapi = exports.injectPreApiScripts = exports.addScript = exports.getSessionDataFilePath = exports.invalidateSesssionData = exports.deleteSessionData = exports.initPage = exports.BROWSER_START_TS = void 0;
 const path = __importStar(require("path"));
 const fs = __importStar(require("fs"));
 const death_1 = __importDefault(require("death"));
@@ -268,7 +268,7 @@ const getSessionDataFromFile = (sessionId, config, spinner) => {
                 sessionjson = JSON.parse(Buffer.from(s, 'base64').toString('ascii'));
             }
             catch (error) {
-                const msg = "Session data json file is corrupted. Please reauthenticate.";
+                const msg = `${s == "LOGGED OUT" ? "The session was logged out" : "Session data json file is corrupted"}. Please re-scan the QR code.`;
                 if (spinner) {
                     spinner.fail(msg);
                 }
@@ -294,6 +294,22 @@ const deleteSessionData = (config) => {
     return true;
 };
 exports.deleteSessionData = deleteSessionData;
+const invalidateSesssionData = (config) => {
+    const sessionjsonpath = (0, exports.getSessionDataFilePath)((config === null || config === void 0 ? void 0 : config.sessionId) || 'session', config);
+    if (typeof sessionjsonpath == 'string' && fs.existsSync(sessionjsonpath)) {
+        const l = `logout detected, invalidating session data file: ${sessionjsonpath}`;
+        console.log(l);
+        logging_1.log.info(l);
+        fs.writeFile(sessionjsonpath, "LOGGED OUT", (err) => {
+            if (err) {
+                console.error(err);
+                return;
+            }
+        });
+    }
+    return true;
+};
+exports.invalidateSesssionData = invalidateSesssionData;
 const getSessionDataFilePath = (sessionId, config) => {
     var _a, _b;
     const p = ((_a = require === null || require === void 0 ? void 0 : require.main) === null || _a === void 0 ? void 0 : _a.path) || ((_b = process === null || process === void 0 ? void 0 : process.mainModule) === null || _b === void 0 ? void 0 : _b.path);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.31.12",
+  "version": "4.32.1",
   "licenseCheckUrl": "https://funcs.openwa.dev/license-check",
   "brokenMethodReportUrl": "https://funcs.openwa.dev/report-bm",
   "patches": "https://cdn.openwa.dev/patches.json",