@arcaelas/whatsapp 6.2.0 → 7.0.0

package/build/cjs/lib/chat/index.d.ts

@@ -3,13 +3,16 @@
  * @description Entidad Chat — conversaciones individuales y grupales.
  * Chat entity — individual and group conversations.
  */
-import { Message } from '../../lib/message';
-import type { WhatsApp } from '../../lib/whatsapp';
+import type { WASocket } from 'baileys';
+import type Contact from '../../lib/contact';
+import type Message from '../../lib/message';
+import { type Engine } from '../../lib/store';
+import type WhatsApp from '../../lib/whatsapp';
 /**
- * Clase base del chat: recibe el raw y deriva todo con getters.
- * Base Chat class: receives the raw and derives everything via getters.
+ * Chat: recibe el raw y deriva todo con getters.
+ * Chat: receives the raw and derives everything via getters.
  */
-export declare class Chat {
+export default class Chat {
     readonly _raw: {
         id: string;
         name?: string | null;
@@ -21,10 +24,10 @@ export declare class Chat {
         activity?: number | null;
     };
     /**
-     * @internal Documento crudo del chat. `id` es el identificador del engine (JID, LID o
-     * `@g.us`); `pinned` y `mute_end_time` son epoch ms.
-     * Raw chat document. `id` is the engine identifier (JID, LID or `@g.us`); `pinned` and
-     * `mute_end_time` are epoch ms.
+     * @internal Documento crudo. `id` es el identificador del engine (JID, LID o `@g.us`);
+     * `pinned`, `mute_end_time` y `activity` son epoch ms.
+     * Raw document. `id` is the engine identifier (JID, LID or `@g.us`); `pinned`,
+     * `mute_end_time` and `activity` are epoch ms.
      */
     constructor(_raw: {
         id: string;
@@ -52,12 +55,19 @@ export declare class Chat {
     get muted(): string | null;
 }
 /**
- * Factoría de Chat ligada al contexto WhatsApp.
- * Context-bound Chat factory.
+ * Chat ligado a la sesión viva: el socket y el engine llegan resueltos, así que sus métodos
+ * no vuelven a comprobarlos.
+ * Chat bound to the live session: socket and engine arrive resolved, so its methods do not
+ * check them again.
  *
- * @param wa - Instancia principal / Main WhatsApp instance
+ * @param init - Sesión activa: cliente, motor y socket / Active session: client, engine and socket
+ * @returns Clase `Chat` con acceso a la sesión / `Chat` class with session access
  */
-export declare function chat(wa: WhatsApp): {
+export declare function chat(init: {
+    wa: WhatsApp;
+    engine: Engine;
+    socket: WASocket;
+}): {
     new (_raw: {
         id: string;
         name?: string | null;
@@ -69,26 +79,26 @@ export declare function chat(wa: WhatsApp): {
         activity?: number | null;
     }): {
         /**
-         * Participantes del chat: los integrantes en grupos, el contacto y yo en 1:1.
-         * Chat participants: members for groups, the contact and myself for 1:1.
+         * Participantes: los integrantes en grupos, el contacto y yo en 1:1.
+         * Participants: members for groups, the contact and myself for 1:1.
          *
          * @param offset - Desplazamiento / Offset
          * @param limit - Tamaño de página / Page size
          * @returns Página de contactos / Contact page
          */
-        members(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Contact>[]>;
+        members(offset?: number, limit?: number): Promise<Contact[]>;
         /**
-         * Descripción del chat: el asunto del grupo o, en un 1:1, la bio del contacto.
-         * Es asíncrono porque ninguno de los dos vive en el documento del chat.
-         * Chat description: the group's subject or, on a 1:1, the contact's bio. It is async
-         * because neither of them lives in the chat document.
+         * Descripción: el asunto del grupo o, en un 1:1, la bio del contacto. Es asíncrono
+         * porque ninguna de las dos vive en el documento del chat.
+         * Description: the group's subject or, on a 1:1, the contact's bio. It is async because
+         * neither of them lives in the chat document.
          *
-         * @returns Descripción, o cadena vacía si no hay / Description, or an empty string when absent
+         * @returns Descripción, o cadena vacía / Description, or an empty string
          */
         content(): Promise<string>;
         /**
-         * Mensajes del chat paginados desde el más reciente.
-         * Chat messages paginated from the most recent one.
+         * Mensajes del chat, del más reciente al más antiguo.
+         * Chat messages, from the most recent to the oldest.
          *
          * @param offset - Desplazamiento / Offset
          * @param limit - Tamaño de página / Page size
@@ -96,68 +106,58 @@ export declare function chat(wa: WhatsApp): {
          */
         messages(offset?: number, limit?: number): Promise<Message[]>;
         /**
-         * Activa o desactiva el indicador «escribiendo…».
-         * Toggles the "typing…" indicator.
+         * Publica el indicador «escribiendo…».
+         * Publishes the "typing…" indicator.
          *
-         * @param value - true activa, false vuelve a pausa / true enables, false returns to paused
-         * @returns true si el socket estaba disponible / true when the socket was available
+         * @param value - true escribe, false vuelve a pausa / true types, false returns to paused
          */
         typing(value: boolean): Promise<boolean>;
         /**
-         * Activa o desactiva el indicador «grabando audio…».
-         * Toggles the "recording audio…" indicator.
+         * Publica el indicador «grabando audio…».
+         * Publishes the "recording audio…" indicator.
          *
-         * @param value - true activa, false vuelve a pausa / true enables, false returns to paused
-         * @returns true si el socket estaba disponible / true when the socket was available
+         * @param value - true graba, false vuelve a pausa / true records, false returns to paused
          */
         recording(value: boolean): Promise<boolean>;
         /**
-         * Archiva o desarchiva el chat en la cuenta de WhatsApp.
-         * Archives or unarchives the chat on the WhatsApp account.
+         * Archiva o desarchiva el chat en la cuenta.
+         * Archives or unarchives the chat on the account.
          *
          * @param value - true archiva, false desarchiva / true archives, false unarchives
-         * @returns true si la acción se envió / true when the action was sent
          */
         archive(value: boolean): Promise<boolean>;
         /**
-         * Fija o desfija el chat en la cuenta de WhatsApp. WhatsApp acepta hasta 3 chats
-         * fijados y descarta el cuarto sin avisar, así que el límite se verifica antes.
-         * Pins or unpins the chat on the WhatsApp account. WhatsApp accepts up to 3 pinned
-         * chats and silently drops the fourth, so the limit is checked beforehand.
+         * Fija o desfija el chat. Al fijar comprueba el límite, porque WhatsApp descarta el
+         * cuarto chat fijado sin avisar.
+         * Pins or unpins the chat. When pinning it checks the limit, since WhatsApp silently
+         * drops the fourth pinned chat.
          *
          * @param value - true fija, false desfija / true pins, false unpins
-         * @returns false si el socket está caído o ya hay 3 chats fijados / false when the socket is down or 3 chats are already pinned
+         * @returns false si ya hay 3 chats fijados / false when 3 chats are already pinned
          */
         pin(value: boolean): Promise<boolean>;
         /**
-         * Silencia el chat hasta la fecha indicada. `false` o una fecha pasada lo des-silencian.
-         * Mutes the chat until the given date. `false` or a past date unmutes it.
+         * Silencia el chat hasta la fecha indicada; `false` o una fecha pasada lo reactivan.
+         * Mutes the chat until the given date; `false` or a past date unmutes it.
          *
-         * @param until - Fecha límite (ISO, epoch ms o Date) o false / Deadline (ISO, epoch ms or Date) or false
-         * @returns true si la acción se envió / true when the action was sent
+         * @param until - Fecha límite (ISO, epoch ms o Date), o false / Deadline (ISO, epoch ms or Date), or false
          */
         mute(until: string | number | Date | false): Promise<boolean>;
         /**
-         * Marca el chat completo como leído en la cuenta de WhatsApp.
-         * Marks the whole chat as read on the WhatsApp account.
-         *
-         * @returns true si la acción se envió / true when the action was sent
+         * Marca el chat completo como leído en la cuenta.
+         * Marks the whole chat as read on the account.
          */
         seen(): Promise<boolean>;
         /**
-         * Vacía los mensajes del chat en la cuenta de WhatsApp y en el engine, conservando el chat.
-         * Clears the chat messages on the WhatsApp account and in the engine, keeping the chat.
-         *
-         * @returns true siempre; la limpieza local es idempotente / always true; local cleanup is idempotent
+         * Vacía los mensajes del chat en la cuenta y en el engine, conservando el chat.
+         * Clears the chat messages on the account and in the engine, keeping the chat.
          */
         clear(): Promise<boolean>;
         /**
-         * Elimina el chat y sus mensajes en la cuenta de WhatsApp y en el engine; en grupos
-         * abandona el grupo.
-         * Deletes the chat and its messages on the WhatsApp account and in the engine; for
-         * groups it leaves the group.
-         *
-         * @returns true siempre; la limpieza local es idempotente / always true; local cleanup is idempotent
+         * Elimina el chat y sus mensajes en la cuenta y en el engine; en grupos, además sale
+         * del grupo.
+         * Deletes the chat and its messages on the account and in the engine; for groups it
+         * also leaves the group.
          */
         delete(): Promise<boolean>;
         readonly _raw: {
@@ -186,36 +186,36 @@ export declare function chat(wa: WhatsApp): {
         get muted(): string | null;
     };
     /**
-     * Carga un chat por teléfono, JID, LID o id de grupo: el persistido en el engine o,
-     * si todavía no existe, una instancia mínima lista para usar (no se persiste).
-     * Loads a chat by phone, JID, LID or group id: the engine-persisted one or, when it
-     * does not exist yet, a minimal ready-to-use instance (not persisted).
+     * Chat por teléfono, JID, LID o id de grupo: el persistido o, si no existe todavía,
+     * una instancia mínima lista para usar que no se persiste.
+     * Chat by phone, JID, LID or group id: the persisted one or, when it does not exist
+     * yet, a minimal ready-to-use instance that is not persisted.
      *
      * @param cid - Teléfono, JID, LID o id de grupo / Phone, JID, LID or group id
-     * @returns Chat o null si el identificador es irresoluble / Chat or null when the identifier cannot be resolved
+     * @returns Chat, o null si el identificador es irresoluble / Chat, or null when the identifier cannot be resolved
      */
     get(cid: string | number): Promise<{
         /**
-         * Participantes del chat: los integrantes en grupos, el contacto y yo en 1:1.
-         * Chat participants: members for groups, the contact and myself for 1:1.
+         * Participantes: los integrantes en grupos, el contacto y yo en 1:1.
+         * Participants: members for groups, the contact and myself for 1:1.
          *
          * @param offset - Desplazamiento / Offset
          * @param limit - Tamaño de página / Page size
          * @returns Página de contactos / Contact page
          */
-        members(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Contact>[]>;
+        members(offset?: number, limit?: number): Promise<Contact[]>;
         /**
-         * Descripción del chat: el asunto del grupo o, en un 1:1, la bio del contacto.
-         * Es asíncrono porque ninguno de los dos vive en el documento del chat.
-         * Chat description: the group's subject or, on a 1:1, the contact's bio. It is async
-         * because neither of them lives in the chat document.
+         * Descripción: el asunto del grupo o, en un 1:1, la bio del contacto. Es asíncrono
+         * porque ninguna de las dos vive en el documento del chat.
+         * Description: the group's subject or, on a 1:1, the contact's bio. It is async because
+         * neither of them lives in the chat document.
          *
-         * @returns Descripción, o cadena vacía si no hay / Description, or an empty string when absent
+         * @returns Descripción, o cadena vacía / Description, or an empty string
          */
         content(): Promise<string>;
         /**
-         * Mensajes del chat paginados desde el más reciente.
-         * Chat messages paginated from the most recent one.
+         * Mensajes del chat, del más reciente al más antiguo.
+         * Chat messages, from the most recent to the oldest.
          *
          * @param offset - Desplazamiento / Offset
          * @param limit - Tamaño de página / Page size
@@ -223,68 +223,58 @@ export declare function chat(wa: WhatsApp): {
          */
         messages(offset?: number, limit?: number): Promise<Message[]>;
         /**
-         * Activa o desactiva el indicador «escribiendo…».
-         * Toggles the "typing…" indicator.
+         * Publica el indicador «escribiendo…».
+         * Publishes the "typing…" indicator.
          *
-         * @param value - true activa, false vuelve a pausa / true enables, false returns to paused
-         * @returns true si el socket estaba disponible / true when the socket was available
+         * @param value - true escribe, false vuelve a pausa / true types, false returns to paused
          */
         typing(value: boolean): Promise<boolean>;
         /**
-         * Activa o desactiva el indicador «grabando audio…».
-         * Toggles the "recording audio…" indicator.
+         * Publica el indicador «grabando audio…».
+         * Publishes the "recording audio…" indicator.
          *
-         * @param value - true activa, false vuelve a pausa / true enables, false returns to paused
-         * @returns true si el socket estaba disponible / true when the socket was available
+         * @param value - true graba, false vuelve a pausa / true records, false returns to paused
          */
         recording(value: boolean): Promise<boolean>;
         /**
-         * Archiva o desarchiva el chat en la cuenta de WhatsApp.
-         * Archives or unarchives the chat on the WhatsApp account.
+         * Archiva o desarchiva el chat en la cuenta.
+         * Archives or unarchives the chat on the account.
          *
          * @param value - true archiva, false desarchiva / true archives, false unarchives
-         * @returns true si la acción se envió / true when the action was sent
          */
         archive(value: boolean): Promise<boolean>;
         /**
-         * Fija o desfija el chat en la cuenta de WhatsApp. WhatsApp acepta hasta 3 chats
-         * fijados y descarta el cuarto sin avisar, así que el límite se verifica antes.
-         * Pins or unpins the chat on the WhatsApp account. WhatsApp accepts up to 3 pinned
-         * chats and silently drops the fourth, so the limit is checked beforehand.
+         * Fija o desfija el chat. Al fijar comprueba el límite, porque WhatsApp descarta el
+         * cuarto chat fijado sin avisar.
+         * Pins or unpins the chat. When pinning it checks the limit, since WhatsApp silently
+         * drops the fourth pinned chat.
          *
          * @param value - true fija, false desfija / true pins, false unpins
-         * @returns false si el socket está caído o ya hay 3 chats fijados / false when the socket is down or 3 chats are already pinned
+         * @returns false si ya hay 3 chats fijados / false when 3 chats are already pinned
          */
         pin(value: boolean): Promise<boolean>;
         /**
-         * Silencia el chat hasta la fecha indicada. `false` o una fecha pasada lo des-silencian.
-         * Mutes the chat until the given date. `false` or a past date unmutes it.
+         * Silencia el chat hasta la fecha indicada; `false` o una fecha pasada lo reactivan.
+         * Mutes the chat until the given date; `false` or a past date unmutes it.
          *
-         * @param until - Fecha límite (ISO, epoch ms o Date) o false / Deadline (ISO, epoch ms or Date) or false
-         * @returns true si la acción se envió / true when the action was sent
+         * @param until - Fecha límite (ISO, epoch ms o Date), o false / Deadline (ISO, epoch ms or Date), or false
          */
         mute(until: string | number | Date | false): Promise<boolean>;
         /**
-         * Marca el chat completo como leído en la cuenta de WhatsApp.
-         * Marks the whole chat as read on the WhatsApp account.
-         *
-         * @returns true si la acción se envió / true when the action was sent
+         * Marca el chat completo como leído en la cuenta.
+         * Marks the whole chat as read on the account.
          */
         seen(): Promise<boolean>;
         /**
-         * Vacía los mensajes del chat en la cuenta de WhatsApp y en el engine, conservando el chat.
-         * Clears the chat messages on the WhatsApp account and in the engine, keeping the chat.
-         *
-         * @returns true siempre; la limpieza local es idempotente / always true; local cleanup is idempotent
+         * Vacía los mensajes del chat en la cuenta y en el engine, conservando el chat.
+         * Clears the chat messages on the account and in the engine, keeping the chat.
          */
         clear(): Promise<boolean>;
         /**
-         * Elimina el chat y sus mensajes en la cuenta de WhatsApp y en el engine; en grupos
-         * abandona el grupo.
-         * Deletes the chat and its messages on the WhatsApp account and in the engine; for
-         * groups it leaves the group.
-         *
-         * @returns true siempre; la limpieza local es idempotente / always true; local cleanup is idempotent
+         * Elimina el chat y sus mensajes en la cuenta y en el engine; en grupos, además sale
+         * del grupo.
+         * Deletes the chat and its messages on the account and in the engine; for groups it
+         * also leaves the group.
          */
         delete(): Promise<boolean>;
         readonly _raw: {
@@ -313,8 +303,8 @@ export declare function chat(wa: WhatsApp): {
         get muted(): string | null;
     } | null>;
     /**
-     * Pagina los chats persistidos, del más reciente al más antiguo.
-     * Paginates persisted chats, from the most recent to the oldest.
+     * Pagina los chats persistidos, del más activo al más antiguo.
+     * Paginates persisted chats, from the most active to the oldest.
      *
      * @param offset - Desplazamiento / Offset
      * @param limit - Tamaño de página / Page size
@@ -322,26 +312,26 @@ export declare function chat(wa: WhatsApp): {
      */
     list(offset?: number, limit?: number): Promise<{
         /**
-         * Participantes del chat: los integrantes en grupos, el contacto y yo en 1:1.
-         * Chat participants: members for groups, the contact and myself for 1:1.
+         * Participantes: los integrantes en grupos, el contacto y yo en 1:1.
+         * Participants: members for groups, the contact and myself for 1:1.
          *
          * @param offset - Desplazamiento / Offset
          * @param limit - Tamaño de página / Page size
          * @returns Página de contactos / Contact page
          */
-        members(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Contact>[]>;
+        members(offset?: number, limit?: number): Promise<Contact[]>;
         /**
-         * Descripción del chat: el asunto del grupo o, en un 1:1, la bio del contacto.
-         * Es asíncrono porque ninguno de los dos vive en el documento del chat.
-         * Chat description: the group's subject or, on a 1:1, the contact's bio. It is async
-         * because neither of them lives in the chat document.
+         * Descripción: el asunto del grupo o, en un 1:1, la bio del contacto. Es asíncrono
+         * porque ninguna de las dos vive en el documento del chat.
+         * Description: the group's subject or, on a 1:1, the contact's bio. It is async because
+         * neither of them lives in the chat document.
          *
-         * @returns Descripción, o cadena vacía si no hay / Description, or an empty string when absent
+         * @returns Descripción, o cadena vacía / Description, or an empty string
          */
         content(): Promise<string>;
         /**
-         * Mensajes del chat paginados desde el más reciente.
-         * Chat messages paginated from the most recent one.
+         * Mensajes del chat, del más reciente al más antiguo.
+         * Chat messages, from the most recent to the oldest.
          *
          * @param offset - Desplazamiento / Offset
          * @param limit - Tamaño de página / Page size
@@ -349,68 +339,58 @@ export declare function chat(wa: WhatsApp): {
          */
         messages(offset?: number, limit?: number): Promise<Message[]>;
         /**
-         * Activa o desactiva el indicador «escribiendo…».
-         * Toggles the "typing…" indicator.
+         * Publica el indicador «escribiendo…».
+         * Publishes the "typing…" indicator.
          *
-         * @param value - true activa, false vuelve a pausa / true enables, false returns to paused
-         * @returns true si el socket estaba disponible / true when the socket was available
+         * @param value - true escribe, false vuelve a pausa / true types, false returns to paused
          */
         typing(value: boolean): Promise<boolean>;
         /**
-         * Activa o desactiva el indicador «grabando audio…».
-         * Toggles the "recording audio…" indicator.
+         * Publica el indicador «grabando audio…».
+         * Publishes the "recording audio…" indicator.
          *
-         * @param value - true activa, false vuelve a pausa / true enables, false returns to paused
-         * @returns true si el socket estaba disponible / true when the socket was available
+         * @param value - true graba, false vuelve a pausa / true records, false returns to paused
          */
         recording(value: boolean): Promise<boolean>;
         /**
-         * Archiva o desarchiva el chat en la cuenta de WhatsApp.
-         * Archives or unarchives the chat on the WhatsApp account.
+         * Archiva o desarchiva el chat en la cuenta.
+         * Archives or unarchives the chat on the account.
          *
          * @param value - true archiva, false desarchiva / true archives, false unarchives
-         * @returns true si la acción se envió / true when the action was sent
          */
         archive(value: boolean): Promise<boolean>;
         /**
-         * Fija o desfija el chat en la cuenta de WhatsApp. WhatsApp acepta hasta 3 chats
-         * fijados y descarta el cuarto sin avisar, así que el límite se verifica antes.
-         * Pins or unpins the chat on the WhatsApp account. WhatsApp accepts up to 3 pinned
-         * chats and silently drops the fourth, so the limit is checked beforehand.
+         * Fija o desfija el chat. Al fijar comprueba el límite, porque WhatsApp descarta el
+         * cuarto chat fijado sin avisar.
+         * Pins or unpins the chat. When pinning it checks the limit, since WhatsApp silently
+         * drops the fourth pinned chat.
          *
          * @param value - true fija, false desfija / true pins, false unpins
-         * @returns false si el socket está caído o ya hay 3 chats fijados / false when the socket is down or 3 chats are already pinned
+         * @returns false si ya hay 3 chats fijados / false when 3 chats are already pinned
          */
         pin(value: boolean): Promise<boolean>;
         /**
-         * Silencia el chat hasta la fecha indicada. `false` o una fecha pasada lo des-silencian.
-         * Mutes the chat until the given date. `false` or a past date unmutes it.
+         * Silencia el chat hasta la fecha indicada; `false` o una fecha pasada lo reactivan.
+         * Mutes the chat until the given date; `false` or a past date unmutes it.
          *
-         * @param until - Fecha límite (ISO, epoch ms o Date) o false / Deadline (ISO, epoch ms or Date) or false
-         * @returns true si la acción se envió / true when the action was sent
+         * @param until - Fecha límite (ISO, epoch ms o Date), o false / Deadline (ISO, epoch ms or Date), or false
          */
         mute(until: string | number | Date | false): Promise<boolean>;
         /**
-         * Marca el chat completo como leído en la cuenta de WhatsApp.
-         * Marks the whole chat as read on the WhatsApp account.
-         *
-         * @returns true si la acción se envió / true when the action was sent
+         * Marca el chat completo como leído en la cuenta.
+         * Marks the whole chat as read on the account.
          */
         seen(): Promise<boolean>;
         /**
-         * Vacía los mensajes del chat en la cuenta de WhatsApp y en el engine, conservando el chat.
-         * Clears the chat messages on the WhatsApp account and in the engine, keeping the chat.
-         *
-         * @returns true siempre; la limpieza local es idempotente / always true; local cleanup is idempotent
+         * Vacía los mensajes del chat en la cuenta y en el engine, conservando el chat.
+         * Clears the chat messages on the account and in the engine, keeping the chat.
          */
         clear(): Promise<boolean>;
         /**
-         * Elimina el chat y sus mensajes en la cuenta de WhatsApp y en el engine; en grupos
-         * abandona el grupo.
-         * Deletes the chat and its messages on the WhatsApp account and in the engine; for
-         * groups it leaves the group.
-         *
-         * @returns true siempre; la limpieza local es idempotente / always true; local cleanup is idempotent
+         * Elimina el chat y sus mensajes en la cuenta y en el engine; en grupos, además sale
+         * del grupo.
+         * Deletes the chat and its messages on the account and in the engine; for groups it
+         * also leaves the group.
          */
         delete(): Promise<boolean>;
         readonly _raw: {