@open-wa/wa-automate-types-only 4.24.1 → 4.26.0

package/dist/api/Client.d.ts

@@ -39,6 +39,8 @@ export declare class Client {
     private _refreshing;
     private _l;
     private _prio;
+    private _pageListeners;
+    private _registeredPageListeners;
     private _queues;
     /**
      * This is used to track if a listener is already used via webhook. Before, webhooks used to be set once per listener. Now a listener can be set via multiple webhooks, or revoked from a specific webhook.
@@ -104,6 +106,7 @@ export declare class Client {
      *
      */
     private registerListener;
+    private registerPageEventListener;
     /**
      * Listens to a log out event
      *
@@ -111,7 +114,11 @@ export declare class Client {
      * @param fn callback
      * @fires `true`
      */
-    onLogout(fn: (loggedOut?: boolean) => any): Promise<boolean>;
+    onLogout(fn: (loggedOut?: boolean) => any, priority?: number): Promise<boolean>;
+    /**
+     * Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process.
+     */
+    waitWhQIdle(): Promise<any>;
     /**
      * If you have set `onAnyMessage` or `onMessage` with the second parameter (PQueue options) then you may want to inspect their respective PQueue's.
      */

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

@@ -552,6 +552,11 @@ export interface ConfigObject {
      * This will force the library to use the default cached raw github link for patches to shave a few hundred milliseconds from your launch time. If you use this option, you will need to wait about 5 minutes before trying out new patches.
      * @default `false`
      */
+    ghPatch?: boolean;
+    /**
+     * Setting this to `true` will save a local copy of the patches.json file (as patches.ignore.data.json) which will be used in subsequent instantiations of the session. While the rest of the launch procedure is running, the library will fetch and save a recent version of the patches to ensure your patches don't go stale. This will be ignored if the cached patches are more than a day old.
+     * @default `false`
+     */
     cachedPatch?: boolean;
     /**
      * Setting `this` to true will replace the `console.table` with a stringified logging of the debug info object instead. This would be useful to set for smaller terminal windows. If `disableSpins` is `true` then this will also be `true`.

package/dist/cli/integrations/chatwoot.d.ts

@@ -0,0 +1,6 @@
+import { Client } from '../..';
+import { cliFlags } from '../server';
+import { Request, Response } from "express";
+export declare type expressMiddleware = (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
+export declare const chatwootMiddleware: (cliConfig: cliFlags, client: Client) => expressMiddleware;
+export declare const setupChatwootOutgoingMessageHandler: (cliConfig: cliFlags, client: Client) => Promise<void>;

package/dist/cli/server.d.ts

@@ -16,5 +16,6 @@ export declare const getCommands: () => any;
 export declare const listListeners: () => string[];
 export declare const setupMediaMiddleware: () => void;
 export declare const setupTwilioCompatibleWebhook: (cliConfig: cliFlags, client: Client) => void;
+export declare const setupChatwoot: (cliConfig: cliFlags, client: Client) => void;
 export declare const setupBotPressHandler: (cliConfig: cliFlags, client: Client) => void;
 export declare const setupSocketServer: (cliConfig: any, client: Client) => Promise<void>;

package/dist/controllers/initializer.d.ts

@@ -1,8 +1,6 @@
 import { Client } from '../api/Client';
 import { ConfigObject } from '../api/model/index';
-import { Spin } from './events';
-import { SessionInfo } from '../api/model/sessionInfo';
-import { Page } from 'puppeteer';
+export declare const pkg: any, configWithCases: any, timeout: (ms: number) => Promise<unknown>;
 export declare let screenshot: any;
 /**
  * Used to initialize the client session.
@@ -22,36 +20,3 @@ export declare let screenshot: any;
  * @param config ConfigObject] The extended custom configuration
  */
 export declare function create(config?: ConfigObject): Promise<Client>;
-/**
- * @private
- */
-export declare function getPatch(config: ConfigObject, spinner?: Spin, sessionInfo?: SessionInfo): Promise<{
-    data: any;
-    tag: string;
-}>;
-/**
- * @private
- * @param page
- * @param spinner
- */
-export declare function injectLivePatch(page: Page, patch: {
-    data: any;
-    tag: string;
-}, spinner?: Spin): Promise<void>;
-/**
- * @private
- */
-export declare function getAndInjectLivePatch(page: Page, spinner?: Spin, preloadedPatch?: {
-    data: any;
-    tag: string;
-}, config?: ConfigObject, sessionInfo?: SessionInfo): Promise<void>;
-/**
- * @private
- */
-export declare function getLicense(config: ConfigObject, me: {
-    _serialized: string;
-}, debugInfo: SessionInfo, spinner?: Spin): Promise<string | false>;
-export declare function earlyInjectionCheck(page: Page): Promise<(page: Page) => boolean>;
-export declare function getAndInjectLicense(page: Page, config: ConfigObject, me: {
-    _serialized: string;
-}, debugInfo: SessionInfo, spinner?: Spin, preloadedLicense?: string | false): Promise<boolean>;

package/dist/controllers/patch_manager.d.ts

@@ -0,0 +1,37 @@
+import { ConfigObject } from '../api/model/index';
+import { Spin } from './events';
+import { SessionInfo } from '../api/model/sessionInfo';
+import { Page } from 'puppeteer';
+/**
+ * @private
+ */
+export declare function getPatch(config: ConfigObject, spinner?: Spin, sessionInfo?: SessionInfo): Promise<{
+    data: any;
+    tag: string;
+}>;
+/**
+ * @private
+ * @param page
+ * @param spinner
+ */
+export declare function injectLivePatch(page: Page, patch: {
+    data: any;
+    tag: string;
+}, spinner?: Spin): Promise<void>;
+/**
+ * @private
+ */
+export declare function getAndInjectLivePatch(page: Page, spinner?: Spin, preloadedPatch?: {
+    data: any;
+    tag: string;
+}, config?: ConfigObject, sessionInfo?: SessionInfo): Promise<void>;
+/**
+ * @private
+ */
+export declare function getLicense(config: ConfigObject, me: {
+    _serialized: string;
+}, debugInfo: SessionInfo, spinner?: Spin): Promise<string | false>;
+export declare function earlyInjectionCheck(page: Page): Promise<(page: Page) => boolean>;
+export declare function getAndInjectLicense(page: Page, config: ConfigObject, me: {
+    _serialized: string;
+}, debugInfo: SessionInfo, spinner?: Spin, preloadedLicense?: string | false): Promise<boolean>;

package/dist/structures/Dialog.d.ts

@@ -0,0 +1,55 @@
+import { Message } from "..";
+export interface CurrentDialogProps {
+    [k: string]: any;
+}
+export interface DialogState {
+    currentStep: number;
+    currentProps: any;
+    lastInput: any;
+    isComplete: boolean;
+    isError: boolean;
+    errorMessage: string;
+}
+export interface DialogTemplate {
+    "dialogId": string;
+    "privateOnly": boolean;
+    "identifier": string;
+    "successMessage": string;
+    "startMessage": string;
+    "properties": {
+        [key: string]: DialogProperty;
+    };
+}
+export declare type CheckFunction = (lastReceivedMessage: Message, currentProps: CurrentDialogProps) => boolean;
+export interface DialogProperty {
+    "order": number;
+    "key": string;
+    "prompt": string;
+    "type": string;
+    "skipCondition"?: CheckFunction;
+    "options"?: DialogButtons[] | DialogListMessageSection[];
+    "validation": DialogValidation[];
+}
+export interface DialogButtons {
+    label: string;
+    value: string;
+}
+export interface DialogListMessageSection {
+    title: string;
+    rows: DialogListMessageRow[];
+}
+export interface DialogListMessageRow {
+    title: string;
+    description: string;
+    value: string;
+}
+export interface DialogValidation {
+    "type": ValidationType;
+    "value": string | CheckFunction;
+    "errorMessage": string;
+}
+export declare enum ValidationType {
+    REGEX = "regex",
+    LENGTH = "length",
+    CHECK = "check"
+}

package/dist/utils/tools.d.ts

@@ -24,3 +24,4 @@ export declare const getDUrl: (url: string, optionsOverride?: AxiosRequestConfig
  * Use this to extract the mime type from a [[DataURL]]
  */
 export declare const base64MimeType: (dUrl: DataURL) => string;
+export declare const processSend: (message: string) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-wa/wa-automate-types-only",
-    "version": "4.24.1",
+    "version": "4.26.0",
     "description": "Types generated from the @open-wa/wa-automate package",
     "scripts": {
         "build": "tsc",