sauruspro-bail 0.0.0-stage → 5.0.1

package/lib/Utils/native-flow.js

@@ -0,0 +1,118 @@
+
+const NATIVE_FLOW_NAMES = Object.freeze([
+    'booking_confirmation',
+    'order_details',
+    'order_status',
+    'payment_status',
+    'payment_method',
+    'payment_reminder',
+    'message_with_link',
+    'message_with_link_status',
+    'quick_reply',
+    'cta_call',
+    'cta_url',
+    'cta_catalog',
+    'catalog_message',
+    'payment_info',
+    'cta_copy',
+    'mixed',
+    'galaxy_message',
+    'cta_app',
+    'call_permission_request',
+    'payment_request',
+    'api_signup',
+    'inapp_signup',
+    'form_message',
+    'menu_options',
+    'a2ui_reply_action',
+    'address_message',
+    'mpm'
+]);
+
+const BUTTON_NAME_TO_FLOW = Object.freeze({
+    review_and_pay: 'order_details',
+    payment_info: 'payment_info',
+    review_order: 'order_status',
+    order_status: 'order_status',
+    payment_status: 'payment_status',
+    payment_method: 'payment_method',
+    open_webview: 'message_with_link',
+    message_with_link_status: 'message_with_link_status',
+    cta_url: 'cta_url',
+    cta_call: 'cta_call',
+    quick_reply: 'quick_reply',
+    catalog_message: 'catalog_message',
+    cta_catalog: 'cta_catalog',
+    cta_copy: 'cta_copy',
+    galaxy_message: 'galaxy_message',
+    payment_reminder: 'payment_reminder',
+    booking_confirmation: 'booking_confirmation',
+    call_permission_request: 'call_permission_request',
+    payment_request: 'payment_request',
+    api_signup: 'api_signup',
+    inapp_signup: 'inapp_signup',
+    cta_app: 'cta_app',
+    form_message: 'form_message',
+    address_message: 'address_message',
+    mpm: 'mpm'
+});
+
+const WEB_SUPPORTED_INTERACTIVE_FLOWS = Object.freeze([
+    'quick_reply',
+    'cta_call',
+    'cta_url',
+    'cta_catalog',
+    'catalog_message',
+    'cta_copy',
+    'galaxy_message',
+    'order_status',
+    'payment_reminder',
+    'booking_confirmation',
+    'payment_request',
+    'api_signup',
+    'inapp_signup',
+    'cta_app',
+    'form_message'
+]);
+
+const NATIVE_FLOW_BUTTON_LIMIT = Object.freeze({
+    quickReply: 10,
+    other: 3
+});
+
+const getNativeFlowNameByButtonName = (name) => BUTTON_NAME_TO_FLOW[name];
+
+const isWebSupportedButtonName = (name) => {
+    const flow = getNativeFlowNameByButtonName(name);
+    return flow !== undefined && WEB_SUPPORTED_INTERACTIVE_FLOWS.includes(flow);
+};
+
+const checkNativeFlowButtons = (buttons) => {
+    const list = (Array.isArray(buttons) ? buttons : []).map(button => (typeof button === 'string' ? { name: button } : button));
+    const problems = [];
+
+    if (!list.length) {
+        return { ok: true, limit: NATIVE_FLOW_BUTTON_LIMIT.other, problems, unsupported: [] };
+    }
+
+    const firstIsQuickReply = list[0]?.name === 'quick_reply';
+    const limit = firstIsQuickReply ? NATIVE_FLOW_BUTTON_LIMIT.quickReply : NATIVE_FLOW_BUTTON_LIMIT.other;
+
+    if (list.length > limit) {
+        problems.push(`WhatsApp Web renders at most ${limit} buttons when the first one is ${firstIsQuickReply ? 'quick_reply' : 'not quick_reply'}, got ${list.length}`);
+    }
+
+    const unsupported = [...new Set(list.map(button => button?.name).filter(name => !isWebSupportedButtonName(name)))];
+    for (const name of unsupported) {
+        problems.push(`"${name}" is not a native flow WhatsApp Web or iOS can render, only Android shows it`);
+    }
+
+    const mixesKinds = list.slice(1).some(button => (button?.name === 'quick_reply') !== firstIsQuickReply);
+    if (mixesKinds) {
+        problems.push('quick_reply buttons cannot be mixed with other button types in one message');
+    }
+
+    return { ok: problems.length === 0, limit, problems, unsupported };
+};
+
+export { NATIVE_FLOW_NAMES, WEB_SUPPORTED_INTERACTIVE_FLOWS, NATIVE_FLOW_BUTTON_LIMIT, getNativeFlowNameByButtonName, isWebSupportedButtonName, checkNativeFlowButtons };

package/lib/Utils/newsletter-status.d.ts

@@ -0,0 +1,163 @@
+import { proto } from '../../WAProto/index.js'
+
+export type NewsletterStatusMediaType = 'audio' | 'gif' | 'image' | 'video'
+export type NewsletterStatusInteractionType = 'question' | 'question_response' | 'question_reshare'
+export type NewsletterStatusContentType = 'text' | 'media' | 'reaction'
+
+export interface NewsletterStatusSendOptions {
+    messageId?: string
+    mediaHandle?: string | number
+    mediaId?: string | number
+    parentServerId?: string | number
+    responseServerId?: string | number
+    interactionType?: NewsletterStatusInteractionType
+    aiContent?: boolean
+    statusAttribution?: boolean
+    ackTimeoutMs?: number
+    resolveServerId?: boolean
+    serverIdTimeoutMs?: number
+    transport?: string
+    [key: string]: any
+}
+
+export interface NewsletterStatusNodeInput {
+    jid: string
+    message?: proto.IMessage
+    payload?: Uint8Array
+    messageId: string
+    mediaType?: NewsletterStatusMediaType
+    mediaHandle?: string | number
+    mediaId?: string | number
+    parentServerId?: string | number
+    responseServerId?: string | number
+    interactionType?: NewsletterStatusInteractionType
+    aiContent?: boolean
+}
+
+export interface NewsletterStatusReactionNodeInput {
+    jid: string
+    messageId: string
+    parentServerId: string | number
+    reaction: string
+}
+
+export interface NewsletterStatusRevokeNodeInput {
+    jid: string
+    statusId: string
+}
+
+export interface NewsletterStatusAck {
+    class?: string
+    from?: string
+    id?: string
+    t?: number
+    serverId?: number
+    edit?: string
+    error?: string
+    applicationError?: number
+    backoff?: number
+    node: any
+}
+
+export interface NewsletterStatusFetchOptions {
+    count?: number
+    before?: string | number
+    after?: string | number
+    viewRole?: string
+}
+
+export interface NewsletterStatusEntry {
+    id?: string
+    serverId?: number
+    t?: number
+    isSender: boolean
+    type?: string
+    edit?: string
+    mediaType?: NewsletterStatusMediaType
+    interactionType?: NewsletterStatusInteractionType
+    reaction?: string
+    adminProfile?: NewsletterAdminProfileInfo
+    paidPartnership: boolean
+    aiContent: boolean
+    editTimestamp?: number
+    originalTimestamp?: number
+    reactionCounts?: { code?: string, count?: number }[]
+    viewsCount?: number
+    responsesCount?: number
+    message?: proto.Message
+    node: any
+}
+
+export interface NewsletterAdminProfileInfo {
+    id?: string
+    name?: string
+    pictureId?: string
+    pictureDirectPath?: string
+}
+
+export interface NewsletterStatusUpdatesFetchOptions {
+    count?: number
+    since?: number
+    before?: string | number
+    after?: string | number
+}
+
+export interface NewsletterStatusList {
+    jid?: string
+    t?: number
+    statuses: NewsletterStatusEntry[]
+}
+
+export type NewsletterStatusSendResult = proto.WebMessageInfo & {
+    newsletterStatusServerId?: number
+    newsletterStatusAck?: NewsletterStatusAck
+    newsletterStatusResponse?: any
+    newsletterStatusDelivered?: any
+}
+
+export const NEWSLETTER_SERVER_ID_MIN: number
+export const NEWSLETTER_SERVER_ID_MAX: number
+
+export function toNewsletterServerId(value: string | number, label?: string): string
+
+export function waitForNewsletterStatusServerId(sock: any, options: {
+    jid?: string
+    messageId?: string
+    timeoutMs?: number
+}): Promise<{ serverId: number, node: any } | undefined> & { cancel(): void }
+
+export interface NewsletterStatusStanzaResult {
+    key: {
+        remoteJid: string
+        fromMe: true
+        id: string
+    }
+    status: number
+    newsletterStatusServerId?: number
+    newsletterStatusAck?: NewsletterStatusAck
+    newsletterStatusResponse?: any
+}
+
+export function getNewsletterStatusMediaType(message: proto.IMessage): NewsletterStatusMediaType | undefined
+export function withNewsletterStatusAttribution<T extends Record<string, any>>(content: T): T
+export function parseNewsletterStatusAck(node: any, reference?: { jid?: string, messageId?: string }): NewsletterStatusAck
+export function buildNewsletterAdminProfileStatusMessage(message: proto.IMessage): proto.Message
+export function buildNewsletterStatusNode(input: NewsletterStatusNodeInput): any
+export function buildNewsletterStatusReactionNode(input: NewsletterStatusReactionNodeInput): any
+export function buildNewsletterStatusRevokeNode(input: NewsletterStatusRevokeNodeInput): any
+export function makeNewsletterStatusSender(sock: any, config: any): (jid: string, content: any, options?: NewsletterStatusSendOptions) => Promise<NewsletterStatusSendResult>
+export function makeNewsletterStatusReactionSender(sock: any): (jid: string, parentServerId: string | number, reaction: string, options?: Pick<NewsletterStatusSendOptions, 'messageId' | 'ackTimeoutMs'>) => Promise<NewsletterStatusStanzaResult>
+export function makeNewsletterStatusRevokeSender(sock: any): (jid: string, statusId: string, options?: Pick<NewsletterStatusSendOptions, 'ackTimeoutMs'>) => Promise<NewsletterStatusStanzaResult>
+export function makeNewsletterStatusFetcher(sock: any): (jid: string, options?: NewsletterStatusFetchOptions) => Promise<NewsletterStatusList>
+export function parseNewsletterStatusesResponse(node: any): NewsletterStatusList
+export function parseNewsletterStatusUpdatesResponse(node: any): NewsletterStatusList
+export function makeNewsletterStatusUpdatesFetcher(sock: any): (jid: string, options?: NewsletterStatusUpdatesFetchOptions) => Promise<NewsletterStatusList>
+export function sendNewsletterStatus(sock: any, inputOrJid: any, content?: any, options?: NewsletterStatusSendOptions): Promise<NewsletterStatusSendResult>
+export function sendNewsletterStatusReaction(sock: any, jid: string, parentServerId: string | number, reaction: string, options?: Pick<NewsletterStatusSendOptions, 'messageId' | 'ackTimeoutMs'>): Promise<NewsletterStatusStanzaResult>
+export function revokeNewsletterStatus(sock: any, jid: string, serverId: string, options?: Pick<NewsletterStatusSendOptions, 'ackTimeoutMs'>): Promise<NewsletterStatusStanzaResult>
+export function getNewsletterStatuses(sock: any, jid: string, options?: NewsletterStatusFetchOptions): Promise<NewsletterStatusList>
+export function getNewsletterStatusUpdates(sock: any, jid: string, options?: NewsletterStatusUpdatesFetchOptions): Promise<NewsletterStatusList>
+
+export const NEWSLETTER_STATUS_CONTENT_TYPES: Set<NewsletterStatusContentType>
+export const NEWSLETTER_STATUS_MEDIA_TYPES: Set<NewsletterStatusMediaType>
+export const NEWSLETTER_STATUS_WEB_MEDIA_TYPES: Set<NewsletterStatusMediaType>