@arcaelas/whatsapp 1.4.0 → 2.0.0

package/build/cjs/Chat.d.ts

@@ -5,331 +5,313 @@
 import type { WhatsApp } from './WhatsApp';
 /**
  * @description Participante de grupo.
+ * Group participant.
  */
 export interface IGroupParticipant {
-    /** JID del participante */
+    /** JID del participante / Participant JID */
     id: string;
-    /** Rol de admin: null, 'admin', 'superadmin' */
+    /** Rol de admin: null, 'admin', 'superadmin' / Admin role */
     admin: string | null;
 }
 /**
  * @description Objeto raw del chat (protocolo).
+ * Raw chat object (protocol).
  */
 export interface IChatRaw {
-    /** JID único del chat */
+    /** JID único del chat / Unique chat JID */
     id: string;
-    /** Nombre del chat o grupo */
+    /** Nombre del chat o grupo / Chat or group name */
     name?: string | null;
-    /** Nombre alternativo para mostrar */
+    /** Nombre alternativo para mostrar / Alternative display name */
     displayName?: string | null;
-    /** Descripción del grupo */
+    /** Descripción del grupo / Group description */
     description?: string | null;
-    /** Cantidad de mensajes no leídos */
+    /** Cantidad de mensajes no leídos / Unread message count */
     unreadCount?: number | null;
-    /** Si el chat es de solo lectura */
+    /** Si el chat es de solo lectura / Whether the chat is read-only */
     readOnly?: boolean | null;
-    /** Si el chat está archivado */
+    /** Si el chat está archivado / Whether the chat is archived */
     archived?: boolean | null;
-    /** Timestamp cuando se fijó el chat */
+    /** Timestamp cuando se fijó el chat / Pin timestamp */
     pinned?: number | null;
-    /** Timestamp cuando expira el silencio */
+    /** Timestamp cuando expira el silencio / Mute end timestamp */
     muteEndTime?: number | null;
-    /** Si fue marcado manualmente como no leído */
+    /** Si fue marcado manualmente como no leído / Whether manually marked as unread */
     markedAsUnread?: boolean | null;
-    /** Lista de participantes del grupo */
+    /** Lista de participantes del grupo / Group participant list */
     participant?: IGroupParticipant[] | null;
-    /** JID del creador del grupo */
+    /** JID del creador del grupo / Group creator JID */
     createdBy?: string | null;
-    /** Timestamp de creación */
+    /** Timestamp de creación / Creation timestamp */
     createdAt?: number | null;
-    /** Duración de mensajes temporales (segundos) */
+    /** Duración de mensajes temporales (segundos) / Ephemeral message duration (seconds) */
     ephemeralExpiration?: number | null;
 }
-/**
- * @description Datos persistidos de un chat.
- */
-export interface IChat {
-    /** JID del chat (ej: 123456@s.whatsapp.net o grupo@g.us) */
-    id: string;
-    /** Tipo de chat: contacto individual o grupo */
-    type: 'contact' | 'group';
-    /** Nombre del chat o contacto */
-    name: string;
-    /** Descripción del chat/grupo */
-    content: string;
-    /** Si está fijado */
-    pined: boolean;
-    /** Si está archivado */
-    archived: boolean;
-    /** Timestamp cuando expira el silencio o false */
-    muted: number | false;
-    /** Si está leído */
-    readed: boolean;
-    /** Si es solo lectura */
-    readonly: boolean;
-    /** Etiquetas del chat */
-    labels: string[];
-    /** Objeto raw del protocolo */
-    raw: IChatRaw;
-}
-/**
- * @description Construye IChat desde raw.
- * @param raw Objeto raw del chat.
- * @returns IChat normalizado.
- */
-export declare function build_chat(raw: IChatRaw): IChat;
 /**
  * @description
  * Clase base para representar una conversación de WhatsApp.
- * Usar Chat.get() para obtener instancias.
+ * Base class representing a WhatsApp conversation.
  */
 export declare class Chat {
     readonly raw: IChatRaw;
-    constructor(data: IChat);
-    /** JID único del chat */
+    constructor(raw: IChatRaw);
+    /** JID único del chat / Unique chat JID */
     get id(): string;
-    /** Tipo de chat */
+    /** Tipo de chat / Chat type */
     get type(): 'contact' | 'group';
-    /** Nombre del chat */
+    /** Nombre del chat / Chat name */
     get name(): string;
-    /** Descripción del chat/grupo */
+    /** Descripción del chat/grupo / Chat/group description */
     get content(): string;
-    /** Si está fijado */
+    /** Si está fijado / Whether it's pinned */
     get pined(): boolean;
-    /** Si está archivado */
+    /** Si está archivado / Whether it's archived */
     get archived(): boolean;
-    /** Timestamp cuando expira el silencio o false */
+    /** Timestamp cuando expira el silencio o false / Mute end timestamp or false */
     get muted(): number | false;
-    /** Si está leído */
+    /** Si está leído / Whether it's read */
     get readed(): boolean;
-    /** Si es solo lectura */
+    /** Si es solo lectura / Whether it's read-only */
     get readonly(): boolean;
 }
 /**
  * @description Factory que retorna la clase Chat enlazada al contexto.
+ * Factory that returns the Chat class bound to context.
  * @param wa Instancia de WhatsApp.
- * @returns Clase _Chat que extiende Chat.
  */
 export declare function chat(wa: WhatsApp): {
-    new (data: IChat): {
+    new (raw: IChatRaw): {
+        /**
+         * @description Actualiza los datos del chat desde WhatsApp.
+         * Refreshes chat data from WhatsApp.
+         */
+        refresh(): Promise</*elided*/ any | null>;
+        /**
+         * @description Elimina el chat con cascade delete.
+         * Deletes the chat with cascade delete.
+         */
+        remove(): Promise<boolean>;
+        /**
+         * @description Fija o desfija el chat.
+         * Pins or unpins the chat.
+         */
+        pin(value: boolean): Promise<boolean>;
+        /**
+         * @description Archiva o desarchiva el chat.
+         * Archives or unarchives the chat.
+         */
+        archive(value: boolean): Promise<boolean>;
+        /**
+         * @description Silencia o quita silencio del chat.
+         * Mutes or unmutes the chat.
+         * @param duration Duración en ms (0 o null para quitar silencio) / Duration in ms (0 or null to unmute).
+         */
+        mute(duration: number | null): Promise<boolean>;
+        /**
+         * @description Marca el chat como leído.
+         * Marks the chat as read.
+         */
+        seen(): Promise<boolean>;
+        /**
+         * @description Obtiene los miembros del chat.
+         * Gets chat members.
+         */
+        members(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Contact>[]>;
         /**
          * @description Obtiene mensajes del chat (paginados).
-         * @param offset Inicio de paginación.
-         * @param limit Cantidad máxima de resultados.
-         * @returns Array de mensajes.
+         * Gets chat messages (paginated).
          */
         messages(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Message>[]>;
         /**
-         * @description Actualiza los datos del chat desde WhatsApp.
-         * @returns this con datos actualizados, o null si falla.
+         * @description Obtiene el contacto asociado al chat (solo chats individuales).
+         * Gets the contact associated with the chat (individual chats only).
          */
-        refresh(): Promise</*elided*/ any | null>;
+        contact(): Promise<InstanceType<typeof wa.Contact> | null>;
         readonly raw: IChatRaw;
-        /** JID único del chat */
+        /** JID único del chat / Unique chat JID */
         get id(): string;
-        /** Tipo de chat */
+        /** Tipo de chat / Chat type */
         get type(): "contact" | "group";
-        /** Nombre del chat */
+        /** Nombre del chat / Chat name */
         get name(): string;
-        /** Descripción del chat/grupo */
+        /** Descripción del chat/grupo / Chat/group description */
         get content(): string;
-        /** Si está fijado */
+        /** Si está fijado / Whether it's pinned */
         get pined(): boolean;
-        /** Si está archivado */
+        /** Si está archivado / Whether it's archived */
         get archived(): boolean;
-        /** Timestamp cuando expira el silencio o false */
+        /** Timestamp cuando expira el silencio o false / Mute end timestamp or false */
         get muted(): number | false;
-        /** Si está leído */
+        /** Si está leído / Whether it's read */
         get readed(): boolean;
-        /** Si es solo lectura */
+        /** Si es solo lectura / Whether it's read-only */
         get readonly(): boolean;
     };
     /**
      * @description Obtiene un chat por su ID.
-     * @param cid ID del chat (JID).
-     * @returns Chat o null si no existe.
+     * Retrieves a chat by its ID.
      */
     get(cid: string): Promise<{
-        /**
-         * @description Obtiene mensajes del chat (paginados).
-         * @param offset Inicio de paginación.
-         * @param limit Cantidad máxima de resultados.
-         * @returns Array de mensajes.
-         */
-        messages(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Message>[]>;
         /**
          * @description Actualiza los datos del chat desde WhatsApp.
-         * @returns this con datos actualizados, o null si falla.
+         * Refreshes chat data from WhatsApp.
          */
         refresh(): Promise</*elided*/ any | null>;
-        readonly raw: IChatRaw;
-        /** JID único del chat */
-        get id(): string;
-        /** Tipo de chat */
-        get type(): "contact" | "group";
-        /** Nombre del chat */
-        get name(): string;
-        /** Descripción del chat/grupo */
-        get content(): string;
-        /** Si está fijado */
-        get pined(): boolean;
-        /** Si está archivado */
-        get archived(): boolean;
-        /** Timestamp cuando expira el silencio o false */
-        get muted(): number | false;
-        /** Si está leído */
-        get readed(): boolean;
-        /** Si es solo lectura */
-        get readonly(): boolean;
-    } | null>;
-    /**
-     * @description Actualiza los datos del chat desde WhatsApp.
-     * @param cid ID del chat.
-     * @returns Chat actualizado o null.
-     */
-    refresh(cid: string): Promise<{
+        /**
+         * @description Elimina el chat con cascade delete.
+         * Deletes the chat with cascade delete.
+         */
+        remove(): Promise<boolean>;
+        /**
+         * @description Fija o desfija el chat.
+         * Pins or unpins the chat.
+         */
+        pin(value: boolean): Promise<boolean>;
+        /**
+         * @description Archiva o desarchiva el chat.
+         * Archives or unarchives the chat.
+         */
+        archive(value: boolean): Promise<boolean>;
+        /**
+         * @description Silencia o quita silencio del chat.
+         * Mutes or unmutes the chat.
+         * @param duration Duración en ms (0 o null para quitar silencio) / Duration in ms (0 or null to unmute).
+         */
+        mute(duration: number | null): Promise<boolean>;
+        /**
+         * @description Marca el chat como leído.
+         * Marks the chat as read.
+         */
+        seen(): Promise<boolean>;
+        /**
+         * @description Obtiene los miembros del chat.
+         * Gets chat members.
+         */
+        members(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Contact>[]>;
         /**
          * @description Obtiene mensajes del chat (paginados).
-         * @param offset Inicio de paginación.
-         * @param limit Cantidad máxima de resultados.
-         * @returns Array de mensajes.
+         * Gets chat messages (paginated).
          */
         messages(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Message>[]>;
         /**
-         * @description Actualiza los datos del chat desde WhatsApp.
-         * @returns this con datos actualizados, o null si falla.
+         * @description Obtiene el contacto asociado al chat (solo chats individuales).
+         * Gets the contact associated with the chat (individual chats only).
          */
-        refresh(): Promise</*elided*/ any | null>;
+        contact(): Promise<InstanceType<typeof wa.Contact> | null>;
         readonly raw: IChatRaw;
-        /** JID único del chat */
+        /** JID único del chat / Unique chat JID */
         get id(): string;
-        /** Tipo de chat */
+        /** Tipo de chat / Chat type */
         get type(): "contact" | "group";
-        /** Nombre del chat */
+        /** Nombre del chat / Chat name */
         get name(): string;
-        /** Descripción del chat/grupo */
+        /** Descripción del chat/grupo / Chat/group description */
         get content(): string;
-        /** Si está fijado */
+        /** Si está fijado / Whether it's pinned */
         get pined(): boolean;
-        /** Si está archivado */
+        /** Si está archivado / Whether it's archived */
         get archived(): boolean;
-        /** Timestamp cuando expira el silencio o false */
+        /** Timestamp cuando expira el silencio o false / Mute end timestamp or false */
         get muted(): number | false;
-        /** Si está leído */
+        /** Si está leído / Whether it's read */
         get readed(): boolean;
-        /** Si es solo lectura */
+        /** Si es solo lectura / Whether it's read-only */
         get readonly(): boolean;
     } | null>;
     /**
      * @description Obtiene chats paginados.
-     * @param offset Inicio de paginación.
-     * @param limit Cantidad máxima de resultados.
-     * @returns Array de chats.
+     * Retrieves paginated chats.
      */
-    paginate(offset?: number, limit?: number): Promise<{
+    list(offset?: number, limit?: number): Promise<{
+        /**
+         * @description Actualiza los datos del chat desde WhatsApp.
+         * Refreshes chat data from WhatsApp.
+         */
+        refresh(): Promise</*elided*/ any | null>;
+        /**
+         * @description Elimina el chat con cascade delete.
+         * Deletes the chat with cascade delete.
+         */
+        remove(): Promise<boolean>;
+        /**
+         * @description Fija o desfija el chat.
+         * Pins or unpins the chat.
+         */
+        pin(value: boolean): Promise<boolean>;
+        /**
+         * @description Archiva o desarchiva el chat.
+         * Archives or unarchives the chat.
+         */
+        archive(value: boolean): Promise<boolean>;
+        /**
+         * @description Silencia o quita silencio del chat.
+         * Mutes or unmutes the chat.
+         * @param duration Duración en ms (0 o null para quitar silencio) / Duration in ms (0 or null to unmute).
+         */
+        mute(duration: number | null): Promise<boolean>;
+        /**
+         * @description Marca el chat como leído.
+         * Marks the chat as read.
+         */
+        seen(): Promise<boolean>;
+        /**
+         * @description Obtiene los miembros del chat.
+         * Gets chat members.
+         */
+        members(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Contact>[]>;
         /**
          * @description Obtiene mensajes del chat (paginados).
-         * @param offset Inicio de paginación.
-         * @param limit Cantidad máxima de resultados.
-         * @returns Array de mensajes.
+         * Gets chat messages (paginated).
          */
         messages(offset?: number, limit?: number): Promise<InstanceType<typeof wa.Message>[]>;
         /**
-         * @description Actualiza los datos del chat desde WhatsApp.
-         * @returns this con datos actualizados, o null si falla.
+         * @description Obtiene el contacto asociado al chat (solo chats individuales).
+         * Gets the contact associated with the chat (individual chats only).
          */
-        refresh(): Promise</*elided*/ any | null>;
+        contact(): Promise<InstanceType<typeof wa.Contact> | null>;
         readonly raw: IChatRaw;
-        /** JID único del chat */
+        /** JID único del chat / Unique chat JID */
         get id(): string;
-        /** Tipo de chat */
+        /** Tipo de chat / Chat type */
         get type(): "contact" | "group";
-        /** Nombre del chat */
+        /** Nombre del chat / Chat name */
         get name(): string;
-        /** Descripción del chat/grupo */
+        /** Descripción del chat/grupo / Chat/group description */
         get content(): string;
-        /** Si está fijado */
+        /** Si está fijado / Whether it's pinned */
         get pined(): boolean;
-        /** Si está archivado */
+        /** Si está archivado / Whether it's archived */
         get archived(): boolean;
-        /** Timestamp cuando expira el silencio o false */
+        /** Timestamp cuando expira el silencio o false / Mute end timestamp or false */
         get muted(): number | false;
-        /** Si está leído */
+        /** Si está leído / Whether it's read */
         get readed(): boolean;
-        /** Si es solo lectura */
+        /** Si es solo lectura / Whether it's read-only */
         get readonly(): boolean;
     }[]>;
     /**
-     * @description Fija o desfija un chat.
-     * @param cid ID del chat.
-     * @param value true para fijar, false para desfijar.
-     * @returns true si se actualizó correctamente.
+     * @description Fija o desfija un chat por su ID.
+     * Pins or unpins a chat by its ID.
      */
     pin(cid: string, value: boolean): Promise<boolean>;
     /**
-     * @description Archiva o desarchiva un chat.
-     * @param cid ID del chat.
-     * @param value true para archivar, false para desarchivar.
-     * @returns true si se actualizó correctamente.
+     * @description Archiva o desarchiva un chat por su ID.
+     * Archives or unarchives a chat by its ID.
      */
     archive(cid: string, value: boolean): Promise<boolean>;
     /**
-     * @description Silencia o quita silencio de un chat.
-     * @param cid ID del chat.
-     * @param duration Duración en milisegundos (0 o null para quitar silencio).
-     * @returns true si se actualizó correctamente.
+     * @description Silencia o quita silencio de un chat por su ID.
+     * Mutes or unmutes a chat by its ID.
      */
     mute(cid: string, duration: number | null): Promise<boolean>;
     /**
-     * @description Marca un chat como leído.
-     * @param cid ID del chat.
-     * @returns true si se marcó correctamente.
+     * @description Marca un chat como leido por su ID.
+     * Marks a chat as read by its ID.
      */
     seen(cid: string): Promise<boolean>;
     /**
-     * @description Limpia todos los datos del chat del storage (cascade delete).
-     * @param cid ID del chat.
-     */
-    cascade_delete(cid: string): Promise<void>;
-    /**
-     * @description Elimina un chat con cascade delete.
-     * @param cid ID del chat.
-     * @returns true si se eliminó correctamente.
+     * @description Elimina un chat por su ID.
+     * Removes a chat by its ID.
      */
     remove(cid: string): Promise<boolean>;
-    /**
-     * @description Agrega un mensaje al índice del chat.
-     * @param cid ID del chat.
-     * @param mid ID del mensaje.
-     * @param timestamp Timestamp de creación.
-     */
-    add_message(cid: string, mid: string, timestamp: number): Promise<void>;
-    /**
-     * @description Elimina un mensaje del índice del chat.
-     * @param cid ID del chat.
-     * @param mid ID del mensaje.
-     */
-    remove_message(cid: string, mid: string): Promise<void>;
-    /**
-     * @description Lista IDs de mensajes del chat (paginado).
-     * @param cid ID del chat.
-     * @param offset Inicio de paginación.
-     * @param limit Cantidad máxima.
-     * @returns Array de IDs de mensajes.
-     */
-    list_messages(cid: string, offset?: number, limit?: number): Promise<string[]>;
-    /**
-     * @description Cuenta mensajes del chat.
-     * @param cid ID del chat.
-     * @returns Cantidad de mensajes.
-     */
-    count_messages(cid: string): Promise<number>;
-    /**
-     * @description Obtiene los miembros de un chat.
-     * @param cid ID del chat.
-     * @param offset Inicio de paginación.
-     * @param limit Cantidad máxima de resultados.
-     * @returns Array de contactos.
-     */
-    members(cid: string, offset?: number, limit?: number): Promise<InstanceType<typeof wa.Contact>[]>;
 };