@open-wa/wa-automate-types-only 4.47.6 → 4.48.1

package/dist/api/Client.d.ts

@@ -208,7 +208,8 @@ export declare class Client {
      */
     onPlugged(fn: (plugged: boolean) => void): Promise<Listener | boolean>;
     /**
-     * Requires a Story License Key
+     * {@license:restricted@}
+     *
      * Listens to when a contact posts a new story.
      * @event
      *
@@ -1693,30 +1694,55 @@ export declare class Client {
      */
     postVideoStatus(data: DataURL, caption: Content): Promise<MessageId | string | boolean>;
     /**
-     * Consumes a list of id strings of statuses to delete.
-     * @param statusesToDelete string [] | stringan array of ids of statuses to delete.
+     * {@license:restricted@}
+     *
+     * Consumes a list of id strings of stories to delete.
+     *
+     * @param statusesToDelete string [] | string an array of ids of stories to delete.
      * @returns boolean. True if it worked.
      */
-    deleteStatus(statusesToDelete: string | string[]): Promise<boolean>;
+    deleteStory(statusesToDelete: string | string[]): Promise<boolean>;
+    /**
+     * @deprecated
+     * Alias for deleteStory
+     */
+    deleteStatus: (statusesToDelete: string | string[]) => Promise<boolean>;
     /**
-     * Deletes all your existing statuses.
+     * {@license:restricted@}
+     *
+     * Deletes all your existing stories.
      * @returns boolean. True if it worked.
      */
-    deleteAllStatus(): Promise<boolean>;
+    deleteAllStories(): Promise<boolean>;
+    /**
+     * @deprecated
+     * Alias for deleteStory
+     */
+    deleteAllStatus: () => Promise<boolean>;
     /**
-     * retrieves all existing statuses.
+     * {@license:restricted@}
+     *
+     * Retrieves all existing stories.
      *
      * Only works with a Story License Key
      */
-    getMyStatusArray(): Promise<Message[]>;
+    getMyStoryArray(): Promise<Message[]>;
+    /**
+     * @deprecated
+     * Alias for deleteStory
+     */
+    getMyStatusArray: () => Promise<Message[]>;
     /**
-       * Retrieves an array of user ids that have 'read' your story.
-       *
-       * @param id string The id of the story
-       *
-       * Only works with a Story License Key
-       */
-    getStoryViewers(id: string): Promise<ContactId[]>;
+     * {@license:restricted@}
+     *
+     * Retrieves an array of user ids that have 'read' your story.
+     *
+     * @param id string The id of the story
+     *
+     */
+    getStoryViewers(id?: string): Promise<ContactId[] | {
+        [k: MessageId]: ContactId[];
+    }>;
     /**
      * Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots.
      *

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

@@ -1,5 +1,4 @@
 import { AxiosRequestConfig } from 'axios';
-import { PREPROCESSORS } from '../../structures/preProcessors';
 import { ConfigLogTransport } from '../../logging/logging';
 import { Base64 } from "./aliases";
 import { SimpleListener } from './events';
@@ -636,12 +635,12 @@ export interface ConfigObject {
      */
     pQueueDefault?: any;
     /**
-     * Set a preprocessor for messages. See [[PREPROCESSORS]] for more info.
+     * Set a preprocessor, or multiple chained preprocessors, for messages. See [MPConfigType](/) for more info.
      *
      * options: `SCRUB`, `BODY_ONLY`, `AUTO_DECRYPT`, `AUTO_DECRYPT_SAVE`, `UPLOAD_CLOUD`.
      * @default `undefined`
      */
-    messagePreprocessor?: PREPROCESSORS;
+    messagePreprocessor?: any;
     /**
      * Set an array filter to be used with messagePreprocessor to limit which messages are preprocessed.
      *

package/dist/structures/preProcessors.d.ts

@@ -1,6 +1,6 @@
 import { Client } from "../api/Client";
 import { Message } from "../api/model/message";
-declare type MessagePreProcessor = (message: Message, client?: Client) => Promise<Message>;
+export declare type MessagePreProcessor = (message: Message, client?: Client) => Promise<Message>;
 /**
  * An object that contains all available [[PREPROCESSORS]].
  *
@@ -44,4 +44,7 @@ export declare enum PREPROCESSORS {
      */
     UPLOAD_CLOUD = "UPLOAD_CLOUD"
 }
-export {};
+/**
+ * The actual type for [config.messagePreprocessor](/docs/api/interfaces/api_model_config.ConfigObject#messagepreprocessor)
+ */
+export declare type MPConfigType = PREPROCESSORS | MessagePreProcessor | (PREPROCESSORS | MessagePreProcessor)[];

package/package.json

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