@arcaelas/whatsapp 1.2.3 → 2.0.0

package/build/Chat.d.ts

@@ -1,335 +0,0 @@
-/**
- * @file Chat.ts
- * @description Clase Chat para gestión de conversaciones de WhatsApp
- */
-import type { WhatsApp } from './WhatsApp';
-/**
- * @description Participante de grupo.
- */
-export interface IGroupParticipant {
-    /** JID del participante */
-    id: string;
-    /** Rol de admin: null, 'admin', 'superadmin' */
-    admin: string | null;
-}
-/**
- * @description Objeto raw del chat (protocolo).
- */
-export interface IChatRaw {
-    /** JID único del chat */
-    id: string;
-    /** Nombre del chat o grupo */
-    name?: string | null;
-    /** Nombre alternativo para mostrar */
-    displayName?: string | null;
-    /** Descripción del grupo */
-    description?: string | null;
-    /** Cantidad de mensajes no leídos */
-    unreadCount?: number | null;
-    /** Si el chat es de solo lectura */
-    readOnly?: boolean | null;
-    /** Si el chat está archivado */
-    archived?: boolean | null;
-    /** Timestamp cuando se fijó el chat */
-    pinned?: number | null;
-    /** Timestamp cuando expira el silencio */
-    muteEndTime?: number | null;
-    /** Si fue marcado manualmente como no leído */
-    markedAsUnread?: boolean | null;
-    /** Lista de participantes del grupo */
-    participant?: IGroupParticipant[] | null;
-    /** JID del creador del grupo */
-    createdBy?: string | null;
-    /** Timestamp de creación */
-    createdAt?: number | null;
-    /** Duración de mensajes temporales (segundos) */
-    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.
- */
-export declare class Chat {
-    readonly raw: IChatRaw;
-    constructor(data: IChat);
-    /** 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;
-}
-/**
- * @description Factory que retorna la clase Chat enlazada al contexto.
- * @param wa Instancia de WhatsApp.
- * @returns Clase _Chat que extiende Chat.
- */
-export declare function chat(wa: WhatsApp): {
-    new (data: IChat): {
-        /**
-         * @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.
-         */
-        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;
-    };
-    /**
-     * @description Obtiene un chat por su ID.
-     * @param cid ID del chat (JID).
-     * @returns Chat o null si no existe.
-     */
-    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.
-         */
-        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 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.
-         */
-        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 Obtiene chats paginados.
-     * @param offset Inicio de paginación.
-     * @param limit Cantidad máxima de resultados.
-     * @returns Array de chats.
-     */
-    paginate(offset?: number, limit?: number): 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.
-         */
-        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;
-    }[]>;
-    /**
-     * @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.
-     */
-    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.
-     */
-    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.
-     */
-    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.
-     */
-    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.
-     */
-    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>[]>;
-};