@open-wa/wa-automate 4.76.0 → 5.0.0-alpha.2

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

@@ -1,77 +0,0 @@
-import { STATE } from '.';
-export interface SessionInfo {
-    WA_VERSION: string;
-    PAGE_UA: string;
-    WA_AUTOMATE_VERSION: string;
-    BROWSER_VERSION: string;
-    LAUNCH_TIME_MS?: number;
-    NUM?: string;
-    OS?: string;
-    START_TS?: number;
-    PHONE_VERSION?: string;
-    NUM_HASH?: string;
-    PATCH_HASH?: string;
-    OW_KEY?: string;
-    INSTANCE_ID?: string;
-    RAM_INFO?: string;
-    PPTR_VERSION?: string;
-    LATEST_VERSION?: boolean;
-    CLI?: boolean;
-    ACC_TYPE?: 'PERSONAL' | 'BUSINESS';
-}
-export interface HealthCheck {
-    /**
-     * The number of messages queued up in the browser. Messages can start being queued up due to the web app awaiting a connection with the host device.
-     *
-     * Healthy: 0
-     */
-    queuedMessages?: number;
-    /**
-     * The state of the web app.
-     *
-     * Healthy: 'CONNECTED'
-     */
-    state?: STATE;
-    /**
-     * Whether or not the "Phone is disconnected" message is showing within the web app.
-     *
-     * Healthy: `false`
-     */
-    isPhoneDisconnected?: boolean;
-    /**
-     * Returns `true` if "Use Here" button is not detected
-     *
-     * Healthy: `true`
-     */
-    isHere?: boolean;
-    /**
-     * Returns `true` if the `WAPI` object is detected.
-     *
-     * Healthy: `true`
-     */
-    wapiInjected?: boolean;
-    /**
-     * Result of `window.navigator.onLine`
-     *
-     * Healthy: `true`
-     */
-    online?: boolean;
-    /**
-     * Returns `true` if "trying to reach phone" dialog is detected
-     *
-     * Healthy: `false`
-     */
-    tryingToReachPhone?: boolean;
-    /**
-     * Returns the number of seconds the "Retrying in ..." dialog is indicating. If the dialog is not showing, it will return `0`.
-     *
-     * Healthy: `0`
-     */
-    retryingIn?: number;
-    /**
-     * Returns `true` if "Phone battery low" message is detected
-     *
-     * Healthy: `false`
-     */
-    batteryLow?: boolean;
-}

package/dist/api/model/sessionInfo.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/build/build-postman.d.ts

@@ -1 +0,0 @@
-export declare const generatePostmanJson: (setup?: any) => Promise<any>;

package/dist/build/build-postman.js

@@ -1,262 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generatePostmanJson = void 0;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const parse_url_1 = __importDefault(require("parse-url"));
-let noCase;
-const format = (s) => s === null || s === void 0 ? void 0 : s.replace(/[[/g,'').replace(/]]/g, '').replace(/@param/g, 'Parameter:');
-const ignoredMethods = [
-    'pup',
-    'loaded',
-    'createMessageCollector',
-    'awaitMessages',
-    "logger"
-];
-const aliasExamples = {
-    "ChatId": "00000000000@c.us or 00000000000-111111111@g.us",
-    "GroupChatId": "00000000000-111111111@g.us",
-    "Content": 'Hello World!',
-    "DataURL": 'data:[<mediatype>][;base64],<data>',
-    "Base64": "Learn more here: https://developer.mozilla.org/en-US/docs/Glossary/Base64",
-    "MessageId": "false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",
-    "ContactId": "00000000000@c.us"
-};
-const paramNameExamples = {
-    "ChatId": "00000000000@c.us  or 00000000000-111111111@g.us",
-};
-const primatives = [
-    'number',
-    'string',
-    'boolean'
-];
-function getMethodsWithDocs() {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        const { Project } = yield Promise.resolve().then(() => __importStar(require("ts-morph")));
-        const project = new Project({
-            compilerOptions: {
-                target: 99,
-            },
-        });
-        const res = [];
-        const fp = fs.existsSync(path.resolve(__dirname, '../api/Client.d.ts')) ? '../api/Client.d.ts' : '../api/Client.ts';
-        const sourceFile = project.addSourceFileAtPath(path.resolve(__dirname, fp));
-        for (const method of sourceFile.getClass('Client').getMethods()) {
-            if (!method.hasModifier(120)) {
-                res.push({
-                    name: method.getName(),
-                    parameters: method.getParameters().map(param => {
-                        var _a, _b, _c, _d;
-                        return {
-                            name: param.getName(),
-                            type: ((_a = param.getTypeNode()) === null || _a === void 0 ? void 0 : _a.getText()) || ((_d = (((_b = param.getType()) === null || _b === void 0 ? void 0 : _b.getAliasSymbol()) || ((_c = param.getType()) === null || _c === void 0 ? void 0 : _c.getSymbol()))) === null || _d === void 0 ? void 0 : _d.getEscapedName()),
-                            isOptional: param.isOptional(),
-                        };
-                    }),
-                    text: format((_a = method.getJsDocs()[0]) === null || _a === void 0 ? void 0 : _a.getInnerText())
-                });
-            }
-        }
-        return res;
-    });
-}
-const generatePostmanJson = (setup = {}) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!noCase)
-        noCase = (yield Promise.resolve().then(() => __importStar(require("change-case")))).noCase;
-    if (setup === null || setup === void 0 ? void 0 : setup.apiHost) {
-        if (setup.apiHost.includes(setup.sessionId)) {
-            const parsed = (0, parse_url_1.default)(setup.apiHost);
-            setup.host = parsed.resource;
-            setup.port = parsed.port;
-        }
-    }
-    const s = yield getMethodsWithDocs();
-    const x = s.filter(({ visibility }) => visibility == 2 || visibility == undefined).filter(({ name }) => !name.startsWith('on')).filter(({ name }) => !ignoredMethods.includes(name)).map(method => (Object.assign({ text: s[method.name] || '' }, method)));
-    const postmanGen = postmanRequestGeneratorGenerator(setup);
-    const pm = x.map(postmanGen);
-    const postmanWrap = postmanWrapGen(setup);
-    const res = postmanWrap(pm);
-    if (!(setup === null || setup === void 0 ? void 0 : setup.skipSavePostmanCollection))
-        fs.writeFileSync(`./open-wa-${setup.sessionId}.postman_collection.json`, JSON.stringify(res));
-    return res;
-});
-exports.generatePostmanJson = generatePostmanJson;
-function escape(key, val) {
-    if (typeof (val) != "string")
-        return val;
-    return val
-        .replace(/["]/g, '\\"')
-        .replace(/[\\]/g, '\\\\')
-        .replace(/[/]/g, '\\/')
-        .replace(/[\b]/g, '\\b')
-        .replace(/[\f]/g, '\\f')
-        .replace(/[\n]/g, '\\n')
-        .replace(/[\r]/g, '\\r')
-        .replace(/[\t]/g, '\\t');
-}
-const postmanRequestGeneratorGenerator = setup => method => {
-    // if(!noCase) noCase = await import("change-case");
-    const args = {};
-    method.parameters.forEach(function (param) {
-        args[param.name] = aliasExamples[param.type] ? aliasExamples[param.type] : paramNameExamples[param.name] ? paramNameExamples[param.name] : primatives.includes(param.type) ? param.type : 'Check documentation in description';
-    });
-    const hostpath = setup.apiHost ? (0, parse_url_1.default)(setup.apiHost).pathname.substring(1) : false;
-    const url = {
-        "raw": setup.apiHost ? `{{address}}:{{port}}${hostpath ? `/${hostpath}` : ''}/${method.name}` : (setup === null || setup === void 0 ? void 0 : setup.useSessionIdInPath) ? "{{address}}:{{port}}/{{sessionId}}/" + method.name : "{{address}}:{{port}}/" + method.name,
-        "host": [
-            "{{address}}"
-        ],
-        "port": "{{port}}",
-        "path": (setup === null || setup === void 0 ? void 0 : setup.apiHost) ? [
-            (0, parse_url_1.default)(setup.apiHost).pathname.substring(1),
-            "" + method.name
-        ].filter(x => x) : (setup === null || setup === void 0 ? void 0 : setup.useSessionIdInPath) ? [
-            "{{sessionId}}",
-            "" + method.name
-        ] : ["" + method.name]
-    };
-    const name = noCase(method.name).replace(/\b[a-z]|['_][a-z]|\B[A-Z]/g, function (x) { return x[0] === "'" || x[0] === "_" ? x : String.fromCharCode(x.charCodeAt(0) ^ 32); });
-    const request = {
-        "auth": {
-            "type": "apikey",
-            "apikey": [
-                {
-                    "key": "value",
-                    "value": setup === null || setup === void 0 ? void 0 : setup.preAuthDocs && setup.key,
-                    "type": "string"
-                },
-                {
-                    "key": "key",
-                    "value": "key",
-                    "type": "string"
-                }
-            ]
-        },
-        "method": "POST",
-        "header": [
-            {
-                "key": "Content-Type",
-                "name": "Content-Type",
-                "type": "text",
-                "value": "application/json"
-            }
-        ],
-        "body": {
-            "mode": "raw",
-            "raw": JSON.stringify({ args: args }, escape, 4),
-            "options": {
-                "raw": {
-                    "language": "json"
-                }
-            }
-        },
-        url,
-        "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;
-    if (method.parameters.length === 0) {
-        request.body.raw = "{}";
-        // delete request.body;
-    }
-    const resp = {
-        name,
-        "originalRequest": request,
-        "code": 200,
-        "_postman_previewlanguage": "json",
-        "header": request.header,
-        "cookie": [],
-        "body": "{\n    \"success\": true\n}"
-    };
-    return {
-        name,
-        request,
-        "response": [resp]
-    };
-};
-const postmanWrapGen = setup => item => ({
-    "info": {
-        "_postman_id": "0df31aa3-b3ce-4f20-b042-0882db0fd3a2",
-        "name": `@open-wa - ${setup.sessionId}`,
-        "description": "Requests for use with open-wa",
-        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
-    },
-    item,
-    "event": [
-        {
-            "listen": "prerequest",
-            "script": {
-                "id": "d1f29ae1-7df9-46d0-8f67-4f53f562ad7e",
-                "type": "text/javascript",
-                "exec": [
-                    ""
-                ]
-            }
-        },
-        {
-            "listen": "test",
-            "script": {
-                "id": "370a2b6c-41d3-418f-ad9b-0404865429ce",
-                "type": "text/javascript",
-                "exec": [
-                    ""
-                ]
-            }
-        }
-    ],
-    "variable": [
-        {
-            "id": "43c133cc-7b9f-4dbe-a513-8832b664adb4",
-            "key": "address",
-            "value": (setup === null || setup === void 0 ? void 0 : setup.host) || "localhost"
-        },
-        {
-            "id": "fda078e5-712a-41bf-9da0-468fe3586d18",
-            "key": "port",
-            "value": (setup === null || setup === void 0 ? void 0 : setup.port) || "8008"
-        },
-        {
-            "id": "c1573a97-c016-4cf4-8b29-938c45146d04",
-            "key": "sessionId",
-            "value": (setup === null || setup === void 0 ? void 0 : setup.sessionId) || "session"
-        }
-    ],
-    "protocolProfileBehavior": {}
-});

package/dist/cli/cli-options.d.ts

@@ -1,9 +0,0 @@
-import { AnyFlag } from "meow";
-import { Merge } from "type-fest";
-export declare const optionList: Merge<Merge<{
-    name?: string;
-    description?: string;
-    typeLabel?: string;
-}, AnyFlag>, {
-    type?: typeof Boolean | typeof Number | typeof String;
-}>[];

package/dist/cli/cli-options.js

@@ -1,289 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.optionList = void 0;
-exports.optionList = [{
-        name: 'no-api',
-        default: false,
-        alias: 'n',
-        type: Boolean,
-        description: "Don't expose the api. This may be useful if you just want to set the webhooks."
-    }, {
-        name: 'bot-press-url',
-        alias: 'b',
-        type: String,
-        typeLabel: '{blue {underline http://localhost:3000/api/v1/bots/cool-bot}}',
-        description: "The Botpress URL that ends with your bot id."
-    }, {
-        name: 'twilio-webhook',
-        alias: 't',
-        type: String,
-        typeLabel: '{blue {underline http://localhost:5555/incoming}}',
-        description: "Send twillio payloads to this URL. EASY API will also parse and processes twillio response message payloads."
-    }, {
-        name: 'chatwoot-url',
-        type: String,
-        typeLabel: '{blue {underline http://localhost:3000/api/v1/accounts/3/inboxes/1}}',
-        description: "The URL of the specific Chatwoot inbox you set up for this session"
-    }, {
-        name: 'chatwoot-api-access-token',
-        type: String,
-        typeLabel: '{blue {underline mEEwUGEEML2ZThMm252rLg1M}}',
-        description: "The access token of the specific Chatwoot inbox you set up for this session"
-    }, {
-        name: 'force-update-cw-webhook',
-        type: Boolean,
-        default: false,
-        description: "Updates the chatwoot inbox webhook with the --api-host value on every launch"
-    },
-    {
-        name: 'port',
-        alias: 'p',
-        default: 8002,
-        type: Number,
-        typeLabel: '{blue {underline 8080}}',
-        description: "Set the port for the api. Default to 8002."
-    },
-    {
-        name: 'forcePort',
-        type: Number,
-        description: "Sometimes --port is overridden by environmental variables or the config file. Use this flag to force the port to be used."
-    },
-    {
-        name: 'api-host',
-        type: String,
-        typeLabel: '{yellow {underline localhost}}',
-        description: "The easy API may be sitting behind a reverse proxy. In this case set --api-host in order to make sure the api docs and api explorer are working properly. You will need to include the protocol as well."
-    },
-    {
-        name: 'host',
-        alias: 'h',
-        default: 'localhost',
-        type: String,
-        typeLabel: '{red {underline localhost}}',
-        description: "Set the hostname for the api documantation and statistics. Overrides --api-host. Default: localhost."
-    },
-    {
-        name: 'webhook',
-        alias: 'w',
-        type: String,
-        typeLabel: '{yellow {underline https://webhook.site/....}}',
-        description: "Webhook to use for the listeners."
-    },
-    {
-        name: 'verbose',
-        alias: 'v',
-        default: false,
-        type: Boolean,
-        description: "Enable console transport for internal logger."
-    },
-    {
-        name: 'ev',
-        alias: 'e',
-        type: String,
-        typeLabel: '{green {underline https://webhook.site/....}}',
-        description: "Send launch events to this URL."
-    },
-    {
-        name: 'ef',
-        type: String,
-        //@ts-ignore
-        default: ["qr", "STARTUP", "MD_DETECT", "qrUrl"],
-        isMultiple: true,
-        typeLabel: '{blueBright {underline qr,STARTUP}}',
-        description: "Filters which namespaces trigger the webhook set in -e/--ev."
-    },
-    {
-        name: 'allow-session-data-wh',
-        alias: 'x',
-        default: false,
-        type: Boolean,
-        description: "By default, if you set -e flag, the session data is not transferred to the webhook as it is extremely sensitive data. In order to bypass this security measure, use this flag."
-    },
-    {
-        name: 'key',
-        alias: 'k',
-        type: String,
-        typeLabel: '{redBright {underline apikey}}',
-        description: "Specify an api key to use as a check for all requests. If you add -k by itself, a key will be autogenerated for you."
-    },
-    {
-        name: 'config',
-        alias: 'c',
-        type: String,
-        typeLabel: '{yellowBright {underline ./cli.config.json}}',
-        description: "The relative json file that contains the config. By default the system will look for cli.config.json which will override any config variables set. Default: './cli.config.json'."
-    },
-    {
-        name: 'session',
-        alias: 's',
-        type: String,
-        typeLabel: '{magentaBright {underline BASE64}}',
-        description: "A base64 string representing the session data."
-    },
-    {
-        name: 'keep-alive',
-        alias: 'a',
-        type: Boolean,
-        description: "If true, the system will force the session to refocus in this process. This will prevent you from opening a session elsewhere."
-    },
-    {
-        name: 'use-session-id-in-path',
-        alias: 'i',
-        type: Boolean,
-        description: "If true, all API paths will include the session id. default to false and the default session Id is 'session'."
-    },
-    {
-        name: 'generate-api-docs',
-        alias: 'd',
-        type: Boolean,
-        default: true,
-        description: "Generate postman collection and expose api docs to open in browser."
-    },
-    {
-        name: 'session-data-only',
-        alias: 'o',
-        type: Boolean,
-        description: "Kill the process when the session data is saved.",
-        default: false
-    },
-    {
-        name: 'skip-save-postman-collection',
-        type: Boolean,
-        description: "Don't save the postman collection.",
-        default: false
-    },
-    {
-        name: 'headful',
-        type: Boolean,
-        description: "Show the browser window on your machine.",
-        default: false
-    },
-    {
-        name: 'pre-auth-docs',
-        type: Boolean,
-        description: "Pre authenticate documentation site [High security risk]."
-    },
-    {
-        name: 'stats',
-        type: Boolean,
-        description: "Exposes API swagger-statistics.",
-        default: false
-    },
-    {
-        name: 'pre-auth-docs',
-        type: Boolean,
-        description: "Grab config options from the environment variables.",
-        default: false
-    },
-    {
-        name: 'no-kill-on-logout',
-        type: Boolean,
-        description: "Keeps the process alive when host account logs out of session. default is false",
-        default: false
-    },
-    {
-        name: 'debug',
-        type: Boolean,
-        description: "Print out the CLI flag values and the WA_* env vars. default is false",
-        default: false
-    },
-    {
-        name: 'cors',
-        type: Boolean,
-        description: "Enable all cors requests",
-        default: false
-    },
-    {
-        name: 'socket',
-        type: Boolean,
-        description: "Expose a socket.io middleware on the server.",
-        default: false
-    },
-    {
-        name: 'license-key',
-        alias: 'l',
-        type: String,
-        typeLabel: '{yellowBright {underline B2BJ4JFB-2UN2J3ND-2J5I.....}}',
-        description: "The license key you want to use for this server. License keys are used to unlock features. Learn more here https://github.com/open-wa/wa-automate-nodejs#license-key"
-    },
-    {
-        name: 'ready-webhook',
-        type: String,
-        typeLabel: '{yellow {underline https://webhook.site/....}}',
-        description: "Webhook that fires when the EASY API is completely ready"
-    },
-    {
-        name: 'on-call',
-        type: String,
-        typeLabel: '{yellow {underline "Please do not call this number"}}',
-        description: "A default message to send to any number that is trying to call the host account"
-    },
-    {
-        name: 'auto-reject',
-        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,
-        description: "Don't validate webhook URLs. Enables use of non-FQDNs."
-    },
-    {
-        name: 'tunnel',
-        type: Boolean,
-        description: "Expose a tunnel to your EASY API session - this is for testing and it is unsecured. By default it will use a random cloudflare tunnel URL. Make sure you have cloudflared installed and running."
-    },
-    {
-        name: 'cf-tunnel-host-domain',
-        type: String,
-        typeLabel: '{yellow {underline "mycool.site"}}',
-        description: "If you have a domain set up in a cloudflare account and have run cloudflared login on your machine, you can use this to expose the tunnel on your own domain. For example, if you set --cf-tunnel-host-domain mycool.site, the tunnel will be exposed on https://session_id_owa.mycool.site"
-    },
-    {
-        name: 'cf-tunnel-namespace',
-        type: String,
-        typeLabel: '{yellow {underline "owa"}}',
-        description: "You can set a sub-subdomain namespace on which the tunnel will be exposed. Needs to be set in conjunction with --tunnel & --cf-tunnel-host-domain. For example, if you set --cf-tunnel-namespace owa, the tunnel will be exposed on https://session_id.owa.mycool.site"
-    },
-    {
-        name: 'pm2',
-        type: Boolean,
-        typeLabel: '{yellow {underline "--max-memory-restart 300M"}}',
-        description: "Offload the EASY API to local instance of pm2. You can add pm2 specific arguments also if you want."
-    },
-    {
-        name: 'privkey',
-        type: String,
-        typeLabel: '{yellow {underline "./privatekey.pem"}}',
-        description: "The private key to use for the TLS connection. --cert is also required"
-    },
-    {
-        name: 'cert',
-        type: String,
-        typeLabel: '{yellow {underline "./certificate.pem"}}',
-        description: "The certificate to use for the TLS connection. --privkey is also required"
-    },
-    {
-        name: 'helmet',
-        type: Boolean,
-        description: "Enable helmet middleware for security.",
-    },
-    {
-        name: 'allow-ips',
-        type: String,
-        //@ts-ignore
-        isMultiple: true,
-        typeLabel: '{blueBright {underline 192.168.0.1,192.168.0.2}}',
-        description: "Allow only these IPs to connect to the EASY API. By default, all IPs are allowed."
-    },
-    {
-        name: 'help',
-        description: 'Print this usage guide.'
-    }
-];

package/dist/cli/collections.d.ts

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