libzapitu 1.0.0-alpha.3

package/lib/Types/LabelAssociation.d.ts

@@ -0,0 +1,29 @@
+/** Association type */
+export declare enum LabelAssociationType {
+    Chat = "label_jid",
+    Message = "label_message"
+}
+export type LabelAssociationTypes = `${LabelAssociationType}`;
+/** Association for chat */
+export interface ChatLabelAssociation {
+    type: LabelAssociationType.Chat;
+    chatId: string;
+    labelId: string;
+}
+/** Association for message */
+export interface MessageLabelAssociation {
+    type: LabelAssociationType.Message;
+    chatId: string;
+    messageId: string;
+    labelId: string;
+}
+export type LabelAssociation = ChatLabelAssociation | MessageLabelAssociation;
+/** Body for add/remove chat label association action */
+export interface ChatLabelAssociationActionBody {
+    labelId: string;
+}
+/** body for add/remove message label association action */
+export interface MessageLabelAssociationActionBody {
+    labelId: string;
+    messageId: string;
+}

package/lib/Types/LabelAssociation.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LabelAssociationType = void 0;
+/** Association type */
+var LabelAssociationType;
+(function (LabelAssociationType) {
+    LabelAssociationType["Chat"] = "label_jid";
+    LabelAssociationType["Message"] = "label_message";
+})(LabelAssociationType || (exports.LabelAssociationType = LabelAssociationType = {}));

package/lib/Types/Message.d.ts

@@ -0,0 +1,279 @@
+import { AxiosRequestConfig } from 'axios';
+import type { Readable } from 'stream';
+import type { URL } from 'url';
+import { proto } from '../../WAProto';
+import { MEDIA_HKDF_KEY_MAPPING } from '../Defaults';
+import { BinaryNode } from '../WABinary';
+import type { GroupMetadata } from './GroupMetadata';
+import { CacheStore } from './Socket';
+export { proto as WAProto };
+export type WAMessage = proto.IWebMessageInfo & {
+    key: WAMessageKey;
+};
+export type WAMessageContent = proto.IMessage;
+export type WAContactMessage = proto.Message.IContactMessage;
+export type WAContactsArrayMessage = proto.Message.IContactsArrayMessage;
+export type WAMessageKey = proto.IMessageKey & {
+    sender_lid?: string;
+    server_id?: string;
+    sender_pn?: string;
+    peer_recipient_pn?: string;
+    participant_lid?: string;
+    participant_pn?: string;
+    isViewOnce?: boolean;
+};
+export type WATextMessage = proto.Message.IExtendedTextMessage;
+export type WAContextInfo = proto.IContextInfo;
+export type WALocationMessage = proto.Message.ILocationMessage;
+export type WAGenericMediaMessage = proto.Message.IVideoMessage | proto.Message.IImageMessage | proto.Message.IAudioMessage | proto.Message.IDocumentMessage | proto.Message.IStickerMessage;
+export declare const WAMessageStubType: typeof proto.WebMessageInfo.StubType;
+export declare const WAMessageStatus: typeof proto.WebMessageInfo.Status;
+import { ILogger } from '../Utils/logger';
+export type WAMediaPayloadURL = {
+    url: URL | string;
+};
+export type WAMediaPayloadStream = {
+    stream: Readable;
+};
+export type WAMediaUpload = Buffer | WAMediaPayloadStream | WAMediaPayloadURL;
+/** Set of message types that are supported by the library */
+export type MessageType = keyof proto.Message;
+export type DownloadableMessage = {
+    mediaKey?: Uint8Array | null;
+    directPath?: string | null;
+    url?: string | null;
+};
+export type MessageReceiptType = 'read' | 'read-self' | 'hist_sync' | 'peer_msg' | 'sender' | 'inactive' | 'played' | undefined;
+export type MediaConnInfo = {
+    auth: string;
+    ttl: number;
+    hosts: {
+        hostname: string;
+        maxContentLengthBytes: number;
+    }[];
+    fetchDate: Date;
+};
+export interface WAUrlInfo {
+    'canonical-url': string;
+    'matched-text': string;
+    title: string;
+    description?: string;
+    jpegThumbnail?: Buffer;
+    highQualityThumbnail?: proto.Message.IImageMessage;
+    originalThumbnailUrl?: string;
+}
+type Mentionable = {
+    /** list of jids that are mentioned in the accompanying text */
+    mentions?: string[];
+};
+type Contextable = {
+    /** add contextInfo to the message */
+    contextInfo?: proto.IContextInfo;
+};
+type ViewOnce = {
+    viewOnce?: boolean;
+};
+type Editable = {
+    edit?: WAMessageKey;
+};
+type WithDimensions = {
+    width?: number;
+    height?: number;
+};
+export type PollMessageOptions = {
+    name: string;
+    selectableCount?: number;
+    values: string[];
+    /** 32 byte message secret to encrypt poll selections */
+    messageSecret?: Uint8Array;
+    toAnnouncementGroup?: boolean;
+};
+type SharePhoneNumber = {
+    sharePhoneNumber: boolean;
+};
+type RequestPhoneNumber = {
+    requestPhoneNumber: boolean;
+};
+export type MediaType = keyof typeof MEDIA_HKDF_KEY_MAPPING;
+export type AnyMediaMessageContent = (({
+    image: WAMediaUpload;
+    caption?: string;
+    jpegThumbnail?: string;
+} & Mentionable & Contextable & WithDimensions) | ({
+    video: WAMediaUpload;
+    caption?: string;
+    gifPlayback?: boolean;
+    jpegThumbnail?: string;
+    /** if set to true, will send as a `video note` */
+    ptv?: boolean;
+} & Mentionable & Contextable & WithDimensions) | {
+    audio: WAMediaUpload;
+    /** if set to true, will send as a `voice note` */
+    ptt?: boolean;
+    /** optionally tell the duration of the audio */
+    seconds?: number;
+} | ({
+    sticker: WAMediaUpload;
+    isAnimated?: boolean;
+} & WithDimensions) | ({
+    document: WAMediaUpload;
+    mimetype: string;
+    fileName?: string;
+    caption?: string;
+} & Contextable)) & {
+    mimetype?: string;
+} & Editable;
+export type ButtonReplyInfo = {
+    displayText: string;
+    id: string;
+    index: number;
+};
+export type GroupInviteInfo = {
+    inviteCode: string;
+    inviteExpiration: number;
+    text: string;
+    jid: string;
+    subject: string;
+};
+export type WASendableProduct = Omit<proto.Message.ProductMessage.IProductSnapshot, 'productImage'> & {
+    productImage: WAMediaUpload;
+};
+export type AnyRegularMessageContent = (({
+    text: string;
+    linkPreview?: WAUrlInfo | null;
+} & Mentionable & Contextable & Editable) | AnyMediaMessageContent | ({
+    poll: PollMessageOptions;
+} & Mentionable & Contextable & Editable) | {
+    contacts: {
+        displayName?: string;
+        contacts: proto.Message.IContactMessage[];
+    };
+} | {
+    location: WALocationMessage;
+} | {
+    react: proto.Message.IReactionMessage;
+} | {
+    buttonReply: ButtonReplyInfo;
+    type: 'template' | 'plain';
+} | {
+    groupInvite: GroupInviteInfo;
+} | {
+    listReply: Omit<proto.Message.IListResponseMessage, 'contextInfo'>;
+} | {
+    pin: WAMessageKey;
+    type: proto.PinInChat.Type;
+    /**
+     * 24 hours, 7 days, 30 days
+     */
+    time?: 86400 | 604800 | 2592000;
+} | {
+    product: WASendableProduct;
+    businessOwnerJid?: string;
+    body?: string;
+    footer?: string;
+} | SharePhoneNumber | RequestPhoneNumber) & ViewOnce;
+export type AnyMessageContent = AnyRegularMessageContent | {
+    forward: WAMessage;
+    force?: boolean;
+} | {
+    /** Delete your message or anyone's message in a group (admin required) */
+    delete: WAMessageKey;
+} | {
+    disappearingMessagesInChat: boolean | number;
+};
+export type GroupMetadataParticipants = Pick<GroupMetadata, 'participants'>;
+type MinimalRelayOptions = {
+    /** override the message ID with a custom provided string */
+    messageId?: string;
+    /** should we use group metadata cache, or fetch afresh from the server; default assumed to be "true" */
+    useCachedGroupMetadata?: boolean;
+};
+export type MessageRelayOptions = MinimalRelayOptions & {
+    /** only send to a specific participant; used when a message decryption fails for a single user */
+    participant?: {
+        jid: string;
+        count: number;
+    };
+    /** additional attributes to add to the WA binary node */
+    additionalAttributes?: {
+        [_: string]: string;
+    };
+    additionalNodes?: BinaryNode[];
+    /** should we use the devices cache, or fetch afresh from the server; default assumed to be "true" */
+    useUserDevicesCache?: boolean;
+    /** jid list of participants for status@broadcast */
+    statusJidList?: string[];
+    isretry?: boolean;
+};
+export type MiscMessageGenerationOptions = MinimalRelayOptions & {
+    /** optional, if you want to manually set the timestamp of the message */
+    timestamp?: Date;
+    /** the message you want to quote */
+    quoted?: WAMessage;
+    /** disappearing messages settings */
+    ephemeralExpiration?: number | string;
+    /** timeout for media upload to WA server */
+    mediaUploadTimeoutMs?: number;
+    /** jid list of participants for status@broadcast */
+    statusJidList?: string[];
+    /** backgroundcolor for status */
+    backgroundColor?: string;
+    /** font type for status */
+    font?: number;
+    /** if it is broadcast */
+    broadcast?: boolean;
+};
+export type MessageGenerationOptionsFromContent = MiscMessageGenerationOptions & {
+    userJid: string;
+};
+export type WAMediaUploadFunction = (encFilePath: string, opts: {
+    fileEncSha256B64: string;
+    mediaType: MediaType;
+    timeoutMs?: number;
+}) => Promise<{
+    mediaUrl: string;
+    directPath: string;
+}>;
+export type MediaGenerationOptions = {
+    logger?: ILogger;
+    mediaTypeOverride?: MediaType;
+    upload: WAMediaUploadFunction;
+    /** cache media so it does not have to be uploaded again */
+    mediaCache?: CacheStore;
+    mediaUploadTimeoutMs?: number;
+    options?: AxiosRequestConfig;
+    backgroundColor?: string;
+    font?: number;
+};
+export type MessageContentGenerationOptions = MediaGenerationOptions & {
+    getUrlInfo?: (text: string) => Promise<WAUrlInfo | undefined>;
+    getProfilePicUrl?: (jid: string, type: 'image' | 'preview') => Promise<string | undefined>;
+    jid?: string;
+};
+export type MessageGenerationOptions = MessageContentGenerationOptions & MessageGenerationOptionsFromContent;
+/**
+ * Type of message upsert
+ * 1. notify => notify the user, this message was just received
+ * 2. append => append the message to the chat history, no notification required
+ */
+export type MessageUpsertType = 'append' | 'notify';
+export type MessageUserReceipt = proto.IUserReceipt;
+export type WAMessageUpdate = {
+    update: Partial<WAMessage>;
+    key: proto.IMessageKey;
+};
+export type WAMessageCursor = {
+    before: WAMessageKey | undefined;
+} | {
+    after: WAMessageKey | undefined;
+};
+export type MessageUserReceiptUpdate = {
+    key: proto.IMessageKey;
+    receipt: MessageUserReceipt;
+};
+export type MediaDecryptionKeyInfo = {
+    iv: Buffer;
+    cipherKey: Buffer;
+    macKey?: Buffer;
+};
+export type MinimalMessage = Pick<proto.IWebMessageInfo, 'key' | 'messageTimestamp'>;

package/lib/Types/Message.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WAMessageStatus = exports.WAMessageStubType = exports.WAProto = void 0;
+const WAProto_1 = require("../../WAProto");
+Object.defineProperty(exports, "WAProto", { enumerable: true, get: function () { return WAProto_1.proto; } });
+exports.WAMessageStubType = WAProto_1.proto.WebMessageInfo.StubType;
+exports.WAMessageStatus = WAProto_1.proto.WebMessageInfo.Status;

package/lib/Types/Newsletter.d.ts

@@ -0,0 +1,134 @@
+export declare enum XWAPaths {
+    xwa2_newsletter_create = "xwa2_newsletter_create",
+    xwa2_newsletter_subscribers = "xwa2_newsletter_subscribers",
+    xwa2_newsletter_view = "xwa2_newsletter_view",
+    xwa2_newsletter_metadata = "xwa2_newsletter",
+    xwa2_newsletter_admin_count = "xwa2_newsletter_admin",
+    xwa2_newsletter_mute_v2 = "xwa2_newsletter_mute_v2",
+    xwa2_newsletter_unmute_v2 = "xwa2_newsletter_unmute_v2",
+    xwa2_newsletter_follow = "xwa2_newsletter_follow",
+    xwa2_newsletter_unfollow = "xwa2_newsletter_unfollow",
+    xwa2_newsletter_change_owner = "xwa2_newsletter_change_owner",
+    xwa2_newsletter_demote = "xwa2_newsletter_demote",
+    xwa2_newsletter_delete_v2 = "xwa2_newsletter_delete_v2"
+}
+export declare enum QueryIds {
+    CREATE = "8823471724422422",
+    UPDATE_METADATA = "24250201037901610",
+    METADATA = "6563316087068696",
+    SUBSCRIBERS = "9783111038412085",
+    FOLLOW = "7871414976211147",
+    UNFOLLOW = "7238632346214362",
+    MUTE = "29766401636284406",
+    UNMUTE = "9864994326891137",
+    ADMIN_COUNT = "7130823597031706",
+    CHANGE_OWNER = "7341777602580933",
+    DEMOTE = "6551828931592903",
+    DELETE = "30062808666639665"
+}
+export type NewsletterUpdate = {
+    name?: string;
+    description?: string;
+    picture?: string;
+};
+export interface NewsletterCreateResponse {
+    id: string;
+    state: {
+        type: string;
+    };
+    thread_metadata: {
+        creation_time: string;
+        description: {
+            id: string;
+            text: string;
+            update_time: string;
+        };
+        handle: string | null;
+        invite: string;
+        name: {
+            id: string;
+            text: string;
+            update_time: string;
+        };
+        picture: {
+            direct_path: string;
+            id: string;
+            type: string;
+        };
+        preview: {
+            direct_path: string;
+            id: string;
+            type: string;
+        };
+        subscribers_count: string;
+        verification: 'VERIFIED' | 'UNVERIFIED';
+    };
+    viewer_metadata: {
+        mute: 'ON' | 'OFF';
+        role: NewsletterViewRole;
+    };
+}
+export interface NewsletterCreateResponse {
+    id: string;
+    state: {
+        type: string;
+    };
+    thread_metadata: {
+        creation_time: string;
+        description: {
+            id: string;
+            text: string;
+            update_time: string;
+        };
+        handle: string | null;
+        invite: string;
+        name: {
+            id: string;
+            text: string;
+            update_time: string;
+        };
+        picture: {
+            direct_path: string;
+            id: string;
+            type: string;
+        };
+        preview: {
+            direct_path: string;
+            id: string;
+            type: string;
+        };
+        subscribers_count: string;
+        verification: 'VERIFIED' | 'UNVERIFIED';
+    };
+    viewer_metadata: {
+        mute: 'ON' | 'OFF';
+        role: NewsletterViewRole;
+    };
+}
+export type NewsletterViewRole = 'ADMIN' | 'GUEST' | 'OWNER' | 'SUBSCRIBER';
+export interface NewsletterMetadata {
+    id: string;
+    owner?: string;
+    name: string;
+    description?: string;
+    invite?: string;
+    creation_time?: number;
+    subscribers?: number;
+    picture?: {
+        url?: string;
+        directPath?: string;
+        mediaKey?: string;
+        id?: string;
+    };
+    verification?: 'VERIFIED' | 'UNVERIFIED';
+    reaction_codes?: {
+        code: string;
+        count: number;
+    }[];
+    mute_state?: 'ON' | 'OFF';
+    thread_metadata?: {
+        creation_time?: number;
+        name?: string;
+        description?: string;
+    };
+}

package/lib/Types/Newsletter.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryIds = exports.XWAPaths = void 0;
+var XWAPaths;
+(function (XWAPaths) {
+    XWAPaths["xwa2_newsletter_create"] = "xwa2_newsletter_create";
+    XWAPaths["xwa2_newsletter_subscribers"] = "xwa2_newsletter_subscribers";
+    XWAPaths["xwa2_newsletter_view"] = "xwa2_newsletter_view";
+    XWAPaths["xwa2_newsletter_metadata"] = "xwa2_newsletter";
+    XWAPaths["xwa2_newsletter_admin_count"] = "xwa2_newsletter_admin";
+    XWAPaths["xwa2_newsletter_mute_v2"] = "xwa2_newsletter_mute_v2";
+    XWAPaths["xwa2_newsletter_unmute_v2"] = "xwa2_newsletter_unmute_v2";
+    XWAPaths["xwa2_newsletter_follow"] = "xwa2_newsletter_follow";
+    XWAPaths["xwa2_newsletter_unfollow"] = "xwa2_newsletter_unfollow";
+    XWAPaths["xwa2_newsletter_change_owner"] = "xwa2_newsletter_change_owner";
+    XWAPaths["xwa2_newsletter_demote"] = "xwa2_newsletter_demote";
+    XWAPaths["xwa2_newsletter_delete_v2"] = "xwa2_newsletter_delete_v2";
+})(XWAPaths || (exports.XWAPaths = XWAPaths = {}));
+var QueryIds;
+(function (QueryIds) {
+    QueryIds["CREATE"] = "8823471724422422";
+    QueryIds["UPDATE_METADATA"] = "24250201037901610";
+    QueryIds["METADATA"] = "6563316087068696";
+    QueryIds["SUBSCRIBERS"] = "9783111038412085";
+    QueryIds["FOLLOW"] = "7871414976211147";
+    QueryIds["UNFOLLOW"] = "7238632346214362";
+    QueryIds["MUTE"] = "29766401636284406";
+    QueryIds["UNMUTE"] = "9864994326891137";
+    QueryIds["ADMIN_COUNT"] = "7130823597031706";
+    QueryIds["CHANGE_OWNER"] = "7341777602580933";
+    QueryIds["DEMOTE"] = "6551828931592903";
+    QueryIds["DELETE"] = "30062808666639665";
+})(QueryIds || (exports.QueryIds = QueryIds = {}));

package/lib/Types/Product.d.ts

@@ -0,0 +1,78 @@
+import { WAMediaUpload } from './Message';
+export type CatalogResult = {
+    data: {
+        paging: {
+            cursors: {
+                before: string;
+                after: string;
+            };
+        };
+        data: any[];
+    };
+};
+export type ProductCreateResult = {
+    data: {
+        product: {};
+    };
+};
+export type CatalogStatus = {
+    status: string;
+    canAppeal: boolean;
+};
+export type CatalogCollection = {
+    id: string;
+    name: string;
+    products: Product[];
+    status: CatalogStatus;
+};
+export type ProductAvailability = 'in stock';
+export type ProductBase = {
+    name: string;
+    retailerId?: string;
+    url?: string;
+    description: string;
+    price: number;
+    currency: string;
+    isHidden?: boolean;
+};
+export type ProductCreate = ProductBase & {
+    /** ISO country code for product origin. Set to undefined for no country */
+    originCountryCode: string | undefined;
+    /** images of the product */
+    images: WAMediaUpload[];
+};
+export type ProductUpdate = Omit<ProductCreate, 'originCountryCode'>;
+export type Product = ProductBase & {
+    id: string;
+    imageUrls: {
+        [_: string]: string;
+    };
+    reviewStatus: {
+        [_: string]: string;
+    };
+    availability: ProductAvailability;
+};
+export type OrderPrice = {
+    currency: string;
+    total: number;
+};
+export type OrderProduct = {
+    id: string;
+    imageUrl: string;
+    name: string;
+    quantity: number;
+    currency: string;
+    price: number;
+};
+export type OrderDetails = {
+    price: OrderPrice;
+    products: OrderProduct[];
+};
+export type CatalogCursor = string;
+export type GetCatalogOptions = {
+    /** cursor to start from */
+    cursor?: CatalogCursor;
+    /** number of products to fetch */
+    limit?: number;
+    jid?: string;
+};

package/lib/Types/Product.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Types/Signal.d.ts

@@ -0,0 +1,57 @@
+import { proto } from '../../WAProto';
+type DecryptGroupSignalOpts = {
+    group: string;
+    authorJid: string;
+    msg: Uint8Array;
+};
+type ProcessSenderKeyDistributionMessageOpts = {
+    item: proto.Message.ISenderKeyDistributionMessage;
+    authorJid: string;
+};
+type DecryptSignalProtoOpts = {
+    jid: string;
+    type: 'pkmsg' | 'msg';
+    ciphertext: Uint8Array;
+};
+type EncryptMessageOpts = {
+    jid: string;
+    data: Uint8Array;
+};
+type EncryptGroupMessageOpts = {
+    group: string;
+    data: Uint8Array;
+    meId: string;
+};
+type PreKey = {
+    keyId: number;
+    publicKey: Uint8Array;
+};
+type SignedPreKey = PreKey & {
+    signature: Uint8Array;
+};
+type E2ESession = {
+    registrationId: number;
+    identityKey: Uint8Array;
+    signedPreKey: SignedPreKey;
+    preKey: PreKey;
+};
+type E2ESessionOpts = {
+    jid: string;
+    session: E2ESession;
+};
+export type SignalRepository = {
+    decryptGroupMessage(opts: DecryptGroupSignalOpts): Promise<Uint8Array>;
+    processSenderKeyDistributionMessage(opts: ProcessSenderKeyDistributionMessageOpts): Promise<void>;
+    decryptMessage(opts: DecryptSignalProtoOpts): Promise<Uint8Array>;
+    encryptMessage(opts: EncryptMessageOpts): Promise<{
+        type: 'pkmsg' | 'msg';
+        ciphertext: Uint8Array;
+    }>;
+    encryptGroupMessage(opts: EncryptGroupMessageOpts): Promise<{
+        senderKeyDistributionMessage: Uint8Array;
+        ciphertext: Uint8Array;
+    }>;
+    injectE2ESession(opts: E2ESessionOpts): Promise<void>;
+    jidToSignalProtocolAddress(jid: string): string;
+};
+export {};

package/lib/Types/Signal.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });