@open-wa/wa-automate 4.42.0 → 4.42.3

package/dist/api/Client.d.ts

@@ -570,8 +570,10 @@ export declare class Client {
      * @param to chat id: `xxxxx@c.us`
      * @param content text message
      * @param replyMessageId id of message to reply to
+     * @param hideTags Removes all tags within the message
+     * @param mentions You can optionally add an array of contact IDs to tag only specific people
      */
-    sendReplyWithMentions(to: ChatId, content: Content, replyMessageId: MessageId): Promise<boolean | MessageId>;
+    sendReplyWithMentions(to: ChatId, content: Content, replyMessageId: MessageId, hideTags?: boolean, mentions?: ContactId[]): Promise<boolean | MessageId>;
     /**
      * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
      *

package/dist/api/Client.js

@@ -1454,15 +1454,17 @@ class Client {
      * @param to chat id: `xxxxx@c.us`
      * @param content text message
      * @param replyMessageId id of message to reply to
+     * @param hideTags Removes all tags within the message
+     * @param mentions You can optionally add an array of contact IDs to tag only specific people
      */
-    sendReplyWithMentions(to, content, replyMessageId) {
+    sendReplyWithMentions(to, content, replyMessageId, hideTags, mentions) {
         return __awaiter(this, void 0, void 0, function* () {
             //remove all @c.us from the content
             content = content.replace(/@c.us/, "");
-            return yield this.pup(({ to, content, replyMessageId }) => {
+            return yield this.pup(({ to, content, replyMessageId, hideTags, mentions }) => {
                 WAPI.sendSeen(to);
-                return WAPI.sendReplyWithMentions(to, content, replyMessageId);
-            }, { to, content, replyMessageId });
+                return WAPI.sendReplyWithMentions(to, content, replyMessageId, hideTags, mentions);
+            }, { to, content, replyMessageId, hideTags, mentions });
         });
     }
     /**

package/dist/cli/collections.js

@@ -46,6 +46,24 @@ const generateCollections = (config, spinner) => __awaiter(void 0, void 0, void
     pmCol = yield (0, __1.generatePostmanJson)(config);
     spinner.succeed(`Postman collection generated: open-wa-${config.sessionId}.postman_collection.json`);
     swCol = (0, postman_2_swagger_1.default)(pmCol);
+    swCol.tags = [
+        {
+            "name": "default",
+            "description": "All methods from the Client",
+            "externalDocs": {
+                "description": "Find out more",
+                "url": "https://docs.openwa.dev/classes/api_Client.Client.html"
+            }
+        },
+        {
+            "name": "meta",
+            "description": "Operations related to generating SDKs for this specific API"
+        },
+        {
+            "name": "media",
+            "description": "Access files in the /media folder when messagePreProcessor is set to AUTO_DECRYPT_SAVE"
+        }
+    ];
     /**
      * Fix swagger docs by removing the content type as a required paramater
      */
@@ -57,7 +75,7 @@ const generateCollections = (config, spinner) => __awaiter(void 0, void 0, void
                     "api_key": []
                 }
             ];
-        swCol.paths[p].nickname = p.replace("/", "");
+        swCol.paths[p].operationId = swCol.paths[p].nickname = p.replace("/", "");
         swCol.paths[p].post.externalDocs = {
             "description": "Documentation",
             "url": swCol.paths[p].post.documentationUrl
@@ -78,6 +96,121 @@ const generateCollections = (config, spinner) => __awaiter(void 0, void 0, void
         };
         delete path.parameters;
     });
+    const metaPaths = {
+        "/media/{fileName}": {
+            "get": {
+                "summary": "Get a file from the /media folder",
+                "description": "Make sure to set messagePreProcessor to AUTO_DECRYPT_SAVE in order to decrypt and save media within the /media folder",
+                tags: ["media"],
+                "produces": [
+                    "application/pdf",
+                    "image/jpeg",
+                    "image/jpg",
+                    "image/png",
+                    "image/webp",
+                    "audio/mpeg",
+                    "audio/ogg",
+                    "audio/vorbis",
+                    "video/mp4",
+                ],
+                "parameters": [
+                    {
+                        "name": "fileName",
+                        "in": "path",
+                        "description": "The filename, e.g: 2B8A12C1DAF21D8CA34105560D5B1864.jpeg",
+                        "required": true,
+                        "type": "string",
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Downloaded file"
+                    },
+                    "404": {
+                        "description": "File not found"
+                    },
+                }
+            }
+        },
+        "/meta/swagger.json": {
+            "get": {
+                "description": "Get a swagger/OAS collection json",
+                tags: ["meta"],
+                "produces": [
+                    "application/json",
+                ],
+                "responses": {
+                    "200": {
+                        "description": "successful request"
+                    },
+                }
+            }
+        },
+        "/meta/postman.json": {
+            "get": {
+                "description": "Get a postman collection json",
+                tags: ["meta"],
+                "produces": [
+                    "application/json",
+                ],
+                "responses": {
+                    "200": {
+                        "description": "successful request"
+                    },
+                }
+            }
+        },
+        "/meta/basic/commands": {
+            get: {
+                "description": "Get a list of possible client methods/commands",
+                tags: ["meta"],
+                "produces": [
+                    "application/json",
+                ],
+                "responses": {
+                    "200": {
+                        "description": "successful request"
+                    },
+                }
+            }
+        },
+        "/meta/basic/listeners": {
+            get: {
+                "description": "Get a list of possible listeners",
+                tags: ["meta"],
+                "produces": [
+                    "application/json",
+                ],
+                "responses": {
+                    "200": {
+                        "description": "successful request"
+                    },
+                }
+            }
+        },
+        "/meta/codegen/{language}": {
+            post: {
+                "summary": "Generate SDK",
+                "description": "Generate a SDK for this specific API - see https://codegen.openwa.dev/api/gen/clients for list of possible languages",
+                tags: ["meta"],
+                "parameters": [
+                    {
+                        "name": "language",
+                        "in": "path",
+                        "description": "The language to generate the SDK for. ",
+                        "required": true,
+                        "type": "string",
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "successful request"
+                    },
+                }
+            }
+        }
+    };
+    swCol.paths = Object.assign(Object.assign({}, swCol.paths), metaPaths);
     delete swCol.swagger;
     swCol.openapi = "3.0.3";
     swCol.components = {};

package/dist/cli/server.js

@@ -103,6 +103,10 @@ const setupApiDocs = (cliConfig) => {
             return res.redirect('api-docs/');
         next();
     }, swagger_ui_express_1.default.serve, swagger_ui_express_1.default.setup(collections_1.collections["swagger"], swOptions));
+    /**
+     * Redirect to api docs if no path is specified
+     */
+    exports.app.use('/', (req, res) => res.redirect('/api-docs'));
 };
 exports.setupApiDocs = setupApiDocs;
 const setupSwaggerStatsMiddleware = (cliConfig) => __awaiter(void 0, void 0, void 0, function* () {

package/dist/connect/socket.d.ts

@@ -67,7 +67,7 @@ export declare class SocketClient {
         };
     };
     /**
-     * The main way to create the socket baed client.
+     * The main way to create the socket based client.
      * @param url URL of the socket server (i.e the EASY API instance address)
      * @param apiKey optional api key if set
      * @returns SocketClient

package/dist/connect/socket.js

@@ -113,7 +113,7 @@ class SocketClient {
         });
     }
     /**
-     * The main way to create the socket baed client.
+     * The main way to create the socket based client.
      * @param url URL of the socket server (i.e the EASY API instance address)
      * @param apiKey optional api key if set
      * @returns SocketClient

package/package.json

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