wuzapi 1.0.1 → 1.2.0

package/dist/types/events.d.ts

@@ -0,0 +1,557 @@
+import { Message } from './message.js';
+export interface WaBinaryNode {
+    Tag: string;
+    Attrs: Record<string, string>;
+    Content: unknown;
+}
+export interface SyncAction {
+    timestamp: Date;
+    action: unknown;
+}
+export interface StarAction extends SyncAction {
+    starred: boolean;
+}
+export interface ArchiveAction extends SyncAction {
+    archived: boolean;
+}
+export interface ClearChatAction extends SyncAction {
+    messageRange?: {
+        lastMessageTimestamp?: Date;
+        lastSystemMessageTimestamp?: Date;
+    };
+}
+export interface DeleteChatAction extends SyncAction {
+}
+export interface DeleteMessageForMeAction extends SyncAction {
+}
+export interface MarkChatAsReadAction extends SyncAction {
+    read: boolean;
+    messageRange?: {
+        lastMessageTimestamp?: Date;
+        lastSystemMessageTimestamp?: Date;
+    };
+}
+export interface MuteAction extends SyncAction {
+    muted: boolean;
+    muteEndTimestamp?: Date;
+}
+export interface PinAction extends SyncAction {
+    pinned: boolean;
+}
+export interface PushNameSettingAction extends SyncAction {
+    name: string;
+}
+export interface UnarchiveChatsSettingAction extends SyncAction {
+    unarchiveChats: boolean;
+}
+export interface LabelAssociationAction extends SyncAction {
+    labeled: boolean;
+}
+export interface LabelEditAction extends SyncAction {
+    name: string;
+    color: number;
+    predefinedId?: string;
+    deleted: boolean;
+}
+export interface BusinessNameAction extends SyncAction {
+    businessName: string;
+    verified: number;
+}
+export interface UserStatusMuteAction extends SyncAction {
+    muted: boolean;
+}
+export interface Armadillo {
+    payload?: unknown;
+}
+export interface ConsumerApplication {
+    metadata?: unknown;
+}
+export interface BasicCallMeta {
+    from: JID;
+    timestamp: Date;
+    callId: string;
+    callCreator: JID;
+}
+export interface CallRemoteMeta {
+    remoteJid: JID;
+    fromMe: boolean;
+}
+export interface EventGroupParticipant {
+    JID: JID;
+    IsAdmin: boolean;
+    IsSuperAdmin: boolean;
+}
+export interface HistorySyncData {
+    conversations?: unknown[];
+    messages?: unknown[];
+}
+export interface JID {
+    User: string;
+    Agent: number;
+    Device: number;
+    Integrator: number;
+    Server: string;
+    AD: boolean;
+}
+export interface MessageInfo {
+    ID: string;
+    Type: string;
+    PushName: string;
+    Timestamp: Date;
+    Source: MessageSource;
+    DeviceSentMeta?: DeviceSentMeta;
+    ServerID?: number;
+    Status?: MessageStatus;
+}
+export interface MessageSource {
+    Chat: JID;
+    Sender: JID;
+    IsFromMe: boolean;
+    IsGroup: boolean;
+    BroadcastListOwner?: JID;
+}
+export interface DeviceSentMeta {
+    DestinationJID: string;
+    Phash: string;
+}
+export declare enum MessageStatus {
+    ERROR = "ERROR",
+    PENDING = "PENDING",
+    SERVER_ACK = "SERVER_ACK",
+    DELIVERY_ACK = "DELIVERY_ACK",
+    READ = "READ",
+    PLAYED = "PLAYED"
+}
+export declare enum ReceiptType {
+    UNKNOWN = "",
+    DELIVERY = "delivery",
+    READ = "read",
+    READ_SELF = "read-self",
+    PLAYED = "played",
+    SENDER = "sender",
+    INACTIVE = "inactive",
+    PEER_MSG = "peer_msg"
+}
+export declare enum DecryptFailMode {
+    UNAVAILABLE = "unavailable",
+    DECRYPT_FAIL = "decrypt_fail"
+}
+export declare enum UnavailableType {
+    UNKNOWN = "",
+    VIEW_ONCE = "view_once"
+}
+export declare enum ConnectFailureReason {
+    SOCKET_OPEN_TIMEOUT = 4001,
+    SOCKET_PING_TIMEOUT = 4002,
+    SOCKET_PONG_TIMEOUT = 4003,
+    UNKNOWN_LOGOUT = 4004,
+    BAD_MAC = 4005,
+    INIT_TIMEOUT = 4006,
+    MULTI_DEVICE_MISMATCH = 4007,
+    MULTI_DEVICE_DISABLED = 4008,
+    TEMP_BANNED = 4009,
+    CLIENT_OUTDATED = 4010,
+    STREAM_ERROR = 4011,
+    DEVICE_GONE = 4012,
+    IDENTITY_MISSING = 4013,
+    RATE_LIMIT_HIT = 4014,
+    MAIN_DEVICE_GONE = 4015
+}
+export declare enum TempBanReason {
+    SENT_TO_TOO_MANY_PEOPLE = 101,
+    BLOCKED_BY_USERS = 102,
+    CREATED_TOO_MANY_GROUPS = 103,
+    SENT_TOO_MANY_SAME_MESSAGE = 104,
+    BROADCAST_LIST = 106
+}
+export interface AppState {
+    name: string;
+    version: number;
+    hash: string[];
+}
+export interface AppStateSyncComplete {
+    name: string;
+}
+export interface Archive {
+    JID: JID;
+    Timestamp: Date;
+    Action: ArchiveAction;
+    FromFullSync: boolean;
+}
+export interface Blocklist {
+    JID: JID;
+    action: string;
+    dhash: string;
+}
+export interface BlocklistAction {
+    action: string;
+}
+export interface BlocklistChange {
+    JID: JID;
+    action: BlocklistChangeAction;
+}
+export interface BlocklistChangeAction {
+    action: string;
+}
+export interface BusinessName {
+    BusinessJID: JID;
+    PushName: string;
+    VerifiedName: string;
+    VerifiedLevel: string;
+    Action: BusinessNameAction;
+    FromFullSync: boolean;
+}
+export interface CATRefreshError {
+    code: string;
+    text: string;
+}
+export interface CallAccept {
+    BasicCallMeta: BasicCallMeta;
+}
+export interface CallOffer {
+    BasicCallMeta: BasicCallMeta;
+    CallRemoteMeta: CallRemoteMeta;
+    Data: string;
+}
+export interface CallOfferNotice {
+    BasicCallMeta: BasicCallMeta;
+    Media: string;
+    Type: string;
+    Data: string;
+}
+export interface CallPreAccept {
+    BasicCallMeta: BasicCallMeta;
+    CallRemoteMeta: CallRemoteMeta;
+}
+export interface CallReject {
+    BasicCallMeta: BasicCallMeta;
+}
+export interface CallRelayLatency {
+    BasicCallMeta: BasicCallMeta;
+    Latency: number;
+}
+export interface CallTerminate {
+    BasicCallMeta: BasicCallMeta;
+    Reason: string;
+}
+export interface CallTransport {
+    BasicCallMeta: BasicCallMeta;
+}
+export interface ChatPresence {
+    MessageSource: MessageSource;
+    State: string;
+    Media: string;
+}
+export interface ClearChat {
+    ChatJID: JID;
+    Timestamp: Date;
+    Action: ClearChatAction;
+    FromFullSync: boolean;
+}
+export interface ClientOutdated {
+}
+export interface ConnectFailure {
+    Reason: ConnectFailureReason;
+    Raw: WaBinaryNode;
+}
+export interface Connected {
+}
+export interface EventContact {
+    JID: JID;
+    Found: boolean;
+    FirstName: string;
+    FullName: string;
+    PushName: string;
+    BusinessName: string;
+}
+export interface DeleteChat {
+    ChatJID: JID;
+    Timestamp: Date;
+    Action: DeleteChatAction;
+    FromFullSync: boolean;
+}
+export interface DeleteForMe {
+    ChatJID: JID;
+    SenderJID: JID;
+    IsFromMe: boolean;
+    MessageID: string;
+    Timestamp: Date;
+    Action: DeleteMessageForMeAction;
+    FromFullSync: boolean;
+}
+export interface Disconnected {
+}
+export interface FBMessage {
+    Info: MessageInfo;
+    IsEphemeral: boolean;
+    IsViewOnce: boolean;
+    IsDocumentWithCaption: boolean;
+    IsEdit: boolean;
+    Message: Armadillo;
+}
+export interface EventGroupInfo {
+    JID: JID;
+    GroupName: string;
+    GroupTopic: string;
+    GroupLocked: boolean;
+    GroupAnnounce: boolean;
+    GroupEphemeral: boolean;
+    GroupParent?: JID;
+    GroupLinkedParent?: JID;
+    GroupIsDefaultSub: boolean;
+    GroupCreated: Date;
+    ParticipantVersionID: string;
+    Participants: EventGroupParticipant[];
+    PendingParticipants: EventGroupParticipant[];
+    JoinedAt: Date;
+    CreateKey: string;
+    Sender: JID;
+    Timestamp: Date;
+}
+export interface HistorySync {
+    Data: HistorySyncData;
+}
+export interface IdentityChange {
+    JID: JID;
+    Timestamp: Date;
+    Implicit: boolean;
+}
+export interface JoinedGroup {
+    Reason: string;
+    Type: string;
+    CreateKey: string;
+    Participants: EventGroupParticipant[];
+}
+export interface KeepAliveRestored {
+}
+export interface KeepAliveTimeout {
+}
+export interface LabelAssociationChat {
+    ChatJID: JID;
+    LabelID: string;
+    Labeled: boolean;
+    Timestamp: Date;
+    Action: LabelAssociationAction;
+    FromFullSync: boolean;
+}
+export interface LabelAssociationMessage {
+    ChatJID: JID;
+    SenderJID: JID;
+    IsFromMe: boolean;
+    MessageID: string;
+    LabelID: string;
+    Labeled: boolean;
+    Timestamp: Date;
+    Action: LabelAssociationAction;
+    FromFullSync: boolean;
+}
+export interface LabelEdit {
+    ID: string;
+    Name: string;
+    Color: number;
+    Deleted: boolean;
+    Timestamp: Date;
+    Action: LabelEditAction;
+    FromFullSync: boolean;
+}
+export interface LoggedOut {
+    OnConnect: boolean;
+    Reason: string;
+}
+export interface ManualLoginReconnect {
+}
+export interface MarkChatAsRead {
+    ChatJID: JID;
+    Timestamp: Date;
+    Action: MarkChatAsReadAction;
+    FromFullSync: boolean;
+}
+export interface MediaRetry {
+    MessageID: string;
+    ChatJID: JID;
+    SenderJID: JID;
+    IsFromMe: boolean;
+    Timestamp: Date;
+}
+export interface MediaRetryError {
+    MessageID: string;
+    ChatJID: JID;
+    SenderJID: JID;
+    IsFromMe: boolean;
+    Timestamp: Date;
+    Error: string;
+}
+export interface MessageEvent {
+    Info: MessageInfo;
+    Message: Message;
+    IsEphemeral: boolean;
+    IsViewOnce: boolean;
+    IsDocumentWithCaption: boolean;
+    IsEdit: boolean;
+    RawMessage: WaBinaryNode;
+}
+export interface Mute {
+    ChatJID: JID;
+    Timestamp: Date;
+    Action: MuteAction;
+    FromFullSync: boolean;
+}
+export interface NewsletterJoin {
+    ID: JID;
+    NewsletterMeta: {
+        name: string;
+        description?: string;
+        invite?: string;
+        creationTime?: Date;
+    };
+}
+export interface NewsletterLeave {
+    ID: JID;
+}
+export interface NewsletterLiveUpdate {
+    ID: JID;
+    Time: Date;
+    Messages: unknown[];
+}
+export interface NewsletterMessageMeta {
+    ID: JID;
+    MessageServerID: number;
+    MessageID: string;
+    ReactionCounts: Record<string, number>;
+    Views: number;
+}
+export interface NewsletterMuteChange {
+    ID: JID;
+    Mute: string;
+}
+export interface OfflineSyncCompleted {
+    Count: number;
+}
+export interface OfflineSyncPreview {
+    Messages: unknown[];
+    IsLatest: boolean;
+}
+export interface PairError {
+    ID: string;
+    Error: string;
+}
+export interface PairSuccess {
+    ID: string;
+    BusinessName: string;
+    Platform: string;
+}
+export interface PermanentDisconnect {
+}
+export interface Picture {
+    JID: JID;
+    Author: JID;
+    Timestamp: Date;
+    Remove: boolean;
+    NewPicture?: {
+        id: string;
+        type: string;
+        directPath: string;
+    };
+    OldPicture?: {
+        id: string;
+        type: string;
+        directPath: string;
+    };
+}
+export interface Pin {
+    ChatJID: JID;
+    SenderJID: JID;
+    IsFromMe: boolean;
+    MessageID: string;
+    Timestamp: Date;
+    Action: PinAction;
+    FromFullSync: boolean;
+}
+export interface Presence {
+    From: JID;
+    Unavailable: boolean;
+    LastSeen: Date;
+}
+export interface PrivacySettings {
+    GroupAddChanged: boolean;
+    LastSeenChanged: boolean;
+    StatusChanged: boolean;
+    ProfileChanged: boolean;
+    ReadReceiptsChanged: boolean;
+    OnlineChanged: boolean;
+    CallAddChanged: boolean;
+}
+export interface PushName {
+    JID: JID;
+    Message: MessageInfo;
+    OldPushName: string;
+    NewPushName: string;
+}
+export interface PushNameSetting {
+    Timestamp: Date;
+    Action: PushNameSettingAction;
+    FromFullSync: boolean;
+}
+export interface QR {
+    Codes: string[];
+}
+export interface QRScannedWithoutMultidevice {
+}
+export interface Receipt {
+    MessageSource: MessageSource;
+    MessageIDs: string[];
+    Timestamp: Date;
+    Type: ReceiptType;
+    MessageSender: JID;
+}
+export interface Star {
+    ChatJID: JID;
+    SenderJID: JID;
+    IsFromMe: boolean;
+    MessageID: string;
+    Timestamp: Date;
+    Action: StarAction;
+    FromFullSync: boolean;
+}
+export interface StreamError {
+    Code: string;
+    Raw: WaBinaryNode;
+}
+export interface StreamReplaced {
+}
+export interface TemporaryBan {
+    Code: TempBanReason;
+    Expire: number;
+}
+export interface UnarchiveChatsSetting {
+    Timestamp: Date;
+    Action: UnarchiveChatsSettingAction;
+    FromFullSync: boolean;
+}
+export interface UndecryptableMessage {
+    Info: MessageInfo;
+    IsUnavailable: boolean;
+    UnavailableType: UnavailableType;
+    DecryptFailMode: DecryptFailMode;
+}
+export interface UnknownCallEvent {
+    Node: WaBinaryNode;
+}
+export interface UserAbout {
+    JID: JID;
+    Status: string;
+    Timestamp: Date;
+}
+export interface UserStatusMute {
+    JID: JID;
+    Timestamp: Date;
+    Action: UserStatusMuteAction;
+    FromFullSync: boolean;
+}
+export type WhatsAppEvent = AppState | AppStateSyncComplete | Archive | Blocklist | BlocklistAction | BlocklistChange | BusinessName | CATRefreshError | CallAccept | CallOffer | CallOfferNotice | CallPreAccept | CallReject | CallRelayLatency | CallTerminate | CallTransport | ChatPresence | ClearChat | ClientOutdated | ConnectFailure | Connected | EventContact | DeleteChat | DeleteForMe | Disconnected | FBMessage | EventGroupInfo | HistorySync | IdentityChange | JoinedGroup | KeepAliveRestored | KeepAliveTimeout | LabelAssociationChat | LabelAssociationMessage | LabelEdit | LoggedOut | ManualLoginReconnect | MarkChatAsRead | MediaRetry | MediaRetryError | MessageEvent | Mute | NewsletterJoin | NewsletterLeave | NewsletterLiveUpdate | NewsletterMessageMeta | NewsletterMuteChange | OfflineSyncCompleted | OfflineSyncPreview | PairError | PairSuccess | PermanentDisconnect | Picture | Pin | Presence | PrivacySettings | PushName | PushNameSetting | QR | QRScannedWithoutMultidevice | Receipt | Star | StreamError | StreamReplaced | TemporaryBan | UnarchiveChatsSetting | UndecryptableMessage | UnknownCallEvent | UserAbout | UserStatusMute;
+export type EventHandler<T extends WhatsAppEvent = WhatsAppEvent> = (event: T) => void | Promise<void>;
+export interface EventEmitter {
+    on<T extends WhatsAppEvent>(eventType: string, handler: EventHandler<T>): void;
+    off<T extends WhatsAppEvent>(eventType: string, handler: EventHandler<T>): void;
+    emit<T extends WhatsAppEvent>(eventType: string, event: T): void;
+}

package/dist/types/group.d.ts

@@ -0,0 +1,76 @@
+export interface GroupParticipant {
+    IsAdmin: boolean;
+    IsSuperAdmin: boolean;
+    JID: string;
+}
+export interface GroupInfo {
+    AnnounceVersionID: string;
+    DisappearingTimer: number;
+    GroupCreated: string;
+    IsAnnounce: boolean;
+    IsEphemeral: boolean;
+    IsLocked: boolean;
+    JID: string;
+    Name: string;
+    NameSetAt: string;
+    NameSetBy: string;
+    OwnerJID: string;
+    ParticipantVersionID: string;
+    Participants: GroupParticipant[];
+    Topic: string;
+    TopicID: string;
+    TopicSetAt: string;
+    TopicSetBy: string;
+}
+export interface GroupListResponse {
+    Groups: GroupInfo[];
+}
+export interface GroupInviteLinkRequest {
+    GroupJID: string;
+}
+export interface GroupInviteLinkResponse {
+    InviteLink: string;
+}
+export interface GroupInfoRequest {
+    GroupJID: string;
+}
+export interface GroupPhotoRequest {
+    GroupJID: string;
+    Image: string;
+}
+export interface GroupPhotoResponse {
+    Details: string;
+    PictureID: string;
+}
+export interface GroupNameRequest {
+    GroupJID: string;
+    Name: string;
+}
+export interface GroupNameResponse {
+    Details: string;
+}
+export interface GroupCreateRequest {
+    name: string;
+    participants: string[];
+}
+export type GroupCreateResponse = GroupInfo;
+export interface GroupLockedRequest {
+    groupjid: string;
+    locked: boolean;
+}
+export interface GroupLockedResponse {
+    Details: string;
+}
+export interface GroupEphemeralRequest {
+    groupjid: string;
+    duration: "24h" | "7d" | "90d" | "off";
+}
+export interface GroupEphemeralResponse {
+    Details: string;
+}
+export interface GroupPhotoRemoveRequest {
+    groupjid: string;
+}
+export interface GroupPhotoRemoveResponse {
+    Details: string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from './common.js';
+export * from './admin.js';
+export * from './session.js';
+export * from './user.js';
+export * from './chat.js';
+export * from './group.js';
+export * from './webhook.js';
+export * from './message.js';
+export * from './events.js';