Class AIRich

constructor

• new AIRich(client: any): AIRich

  Parameters

  • client: any

  Returns AIRich

StaticEXPERIMENTAL_METHODS

StaticSTABLE_METHODS

addBloks

• addBloks(
      data: {
          data?: string;
          initial_response?: any;
          textFallback?: boolean;
          type: string;
          uuid?: string;
          versioning_id?: string;
      },
  ): this

  FOABloksPrimitive — raw Bloks payload; most experimental primitive, fields passed through as-is.

  Parameters

  • data: {
        data?: string;
        initial_response?: any;
        textFallback?: boolean;
        type: string;
        uuid?: string;
        versioning_id?: string;
    }

  Returns this

addChecklist

• addChecklist(items: (string | { done?: boolean; text: string })[]): this

  Markdown checklist block.

  Parameters

  • items: (string | { done?: boolean; text: string })[]

  Returns this

addCode

• addCode(language: string, code: string): this

  Parameters

  • language: string
  • code: string

  Returns this

addCompact

• addCompact(
      data?: {
          action_type?: string;
          entity_id?: string;
          entity_type?: string;
          entity_url?: string;
          image?: string;
          image_url?: string;
          is_verified?: boolean;
          picture_url?: string;
          secondary_subtitle?: string;
          subtitle?: string;
          title: string;
          url?: string;
          verified?: boolean;
      },
      options?: { resolveUrl?: boolean },
  ): this

  Add a compact header card (avatar + title + verified + subtitle, tappable). EXPERIMENTAL.

  Parameters

  • Optionaldata: {
        action_type?: string;
        entity_id?: string;
        entity_type?: string;
        entity_url?: string;
        image?: string;
        image_url?: string;
        is_verified?: boolean;
        picture_url?: string;
        secondary_subtitle?: string;
        subtitle?: string;
        title: string;
        url?: string;
        verified?: boolean;
    }
  • Optionaloptions: { resolveUrl?: boolean }

  Returns this

addContentItems

• addContentItems(items?: Record<string, any>[]): this

  Parameters

  • Optionalitems: Record<string, any>[]

  Returns this

addDivider

• addDivider(): this

  GenAIDividerPrimitive — plain horizontal line, no content.

  Returns this

addFooterAction

• addFooterAction(
      actions:
          | { text: string; type?: string; url: string }
          | { text: string; type?: string; url: string }[],
  ): this

  GenAIFooterActionPrimitive — footer action link chips (e.g. "Join our Group").

  Parameters

  • actions:
        | { text: string; type?: string; url: string }
        | { text: string; type?: string; url: string }[]

  Returns this

addGenerating

• addGenerating(
      options?: {
          estimated_completion_time?: number;
          imagine_type?: "IMAGE" | "ANIMATE";
          textFallback?: boolean;
      },
  ): this

  GenAIImaginePrimitive with status GENERATING — pending-generation placeholder, distinct from addImage()/addVideo()'s READY status.

  Parameters

  • Optionaloptions: {
        estimated_completion_time?: number;
        imagine_type?: "IMAGE" | "ANIMATE";
        textFallback?: boolean;
    }

  Returns this

addHeading

• addHeading(text: string): this

  FOATextPrimitive — large heading text, distinct from addText()'s paragraph text.

  Parameters

  • text: string

  Returns this

addHStack

• addHStack(items?: (string | AIRichStackItem)[]): this

  Parameters

  • Optionalitems: (string | AIRichStackItem)[]

  Returns this

addImage

• addImage(
      imageUrl: string,
      options?: { instant?: boolean; resolveUrl?: boolean },
  ): this

  Parameters

  • imageUrl: string
  • Optionaloptions: { instant?: boolean; resolveUrl?: boolean }

  Returns this

addInlineImage

• addInlineImage(imageUrl: string, options?: AddInlineImageOptions): this

  Parameters

  • imageUrl: string
  • Optionaloptions: AddInlineImageOptions

  Returns this

addInlineVideo

• addInlineVideo(): this

  Returns this

addKeyValue

• addKeyValue(
      data: [string, unknown][] | Record<string, unknown>,
      options?: { header?: [string, string] },
  ): this

  Two-column key/value table from an object or entries.

  Parameters

  • data: [string, unknown][] | Record<string, unknown>
  • Optionaloptions: { header?: [string, string] }

  Returns this

addLatex

• addLatex(expression: string): this

  GenAILatexUXPrimitive — has a real AI_RICH_RESPONSE_LATEX submessage (unlike most primitives here).

  Parameters

  • expression: string

  Returns this

addLinks

• addLinks(links?: Record<string, any>[]): this

  Parameters

  • Optionallinks: Record<string, any>[]

  Returns this

addMarkdown

• addMarkdown(md: string): this

  Build a whole card from markdown (headings/code/tables/paragraphs).

  Parameters

  • md: string

  Returns this

addMetadata

• addMetadata(text: string): this

  Parameters

  • text: string

  Returns this

addPost

• addPost(data?: Record<string, any>, options?: { resolveUrl?: boolean }): this

  Parameters

  • Optionaldata: Record<string, any>
  • Optionaloptions: { resolveUrl?: boolean }

  Returns this

addProduct

• addProduct(data?: Record<string, any>, options?: { resolveUrl?: boolean }): this

  Parameters

  • Optionaldata: Record<string, any>
  • Optionaloptions: { resolveUrl?: boolean }

  Returns this

addProfileCard

• addProfileCard(
      profile?: {
          action_url?: string;
          entity_full_name?: string;
          entity_id?: string;
          entity_name?: string;
          entity_type?: string;
          entity_url?: string;
          full_name?: string;
          image?: string;
          is_verified?: boolean;
          label?: string;
          picture_url?: string;
          subtitle?: string;
          title?: string;
          type?: string;
          url?: string;
          username: string;
          verified?: boolean;
      },
      options?: { divider?: boolean; resolveUrl?: boolean },
  ): this

  One-call profile card (compact header + divider + social-entity embed) — the igstalk pattern. EXPERIMENTAL.

  Parameters

  • Optionalprofile: {
        action_url?: string;
        entity_full_name?: string;
        entity_id?: string;
        entity_name?: string;
        entity_type?: string;
        entity_url?: string;
        full_name?: string;
        image?: string;
        is_verified?: boolean;
        label?: string;
        picture_url?: string;
        subtitle?: string;
        title?: string;
        type?: string;
        url?: string;
        username: string;
        verified?: boolean;
    }
  • Optionaloptions: { divider?: boolean; resolveUrl?: boolean }

  Returns this

addProgressBar

• addProgressBar(
      label: string,
      value: number,
      max?: number,
      options?: { size?: number },
  ): this

  Labelled text progress bar block.

  Parameters

  • label: string
  • value: number
  • Optionalmax: number
  • Optionaloptions: { size?: number }

  Returns this

addProgressStatus

• addProgressStatus(
      title: string,
      options?: {
          icon?: string;
          is_in_progress?: boolean;
          target_secondary_screen_id?: string;
          target_secondary_screen_tab_id?: string;
      },
  ): this

  GenAIBotProgressStatusPrimitive — one-shot "searching/working" status chip.

  Parameters

  • title: string
  • Optionaloptions: {
        icon?: string;
        is_in_progress?: boolean;
        target_secondary_screen_id?: string;
        target_secondary_screen_tab_id?: string;
    }

  Returns this

addQuotaUpsell

• addQuotaUpsell(
      data: {
          body?: string;
          body_line1?: string;
          body_line2?: string;
          buttons?: { action?: string; deeplink?: string; label: string }[];
          title: string;
      },
  ): this

  GenAIMetaSubsQuotaUpsellPrimitive — subscription-quota-limit upsell card.

  Parameters

  • data: {
        body?: string;
        body_line1?: string;
        body_line2?: string;
        buttons?: { action?: string; deeplink?: string; label: string }[];
        title: string;
    }

  Returns this

addRawPrimitive

• addRawPrimitive(
      typename: string,
      props?: Record<string, any>,
      opts?: AIRichViewModelOptions,
  ): this

  Push a single raw primitive wrapped in a SingleLayoutViewModel — quickest custom-primitive escape hatch.

  Parameters

  • typename: string
  • Optionalprops: Record<string, any>
  • Optionalopts: AIRichViewModelOptions

  Returns this

addReels

• addReels(
      reelsItems?: Record<string, any>[],
      options?: { resolveUrl?: boolean },
  ): this

  Parameters

  • OptionalreelsItems: Record<string, any>[]
  • Optionaloptions: { resolveUrl?: boolean }

  Returns this

addSection

• addSection(section: Record<string, any>): this

  Parameters

  • section: Record<string, any>

  Returns this

addSocialEntity

• addSocialEntity(
      data?: {
          entity_full_name?: string;
          entity_id?: string;
          entity_name?: string;
          entity_picture_url?: string;
          entity_type?: string;
          entity_url?: string;
          full_name?: string;
          heading?: boolean;
          image?: string;
          is_verified?: boolean;
          key?: string;
          label?: string;
          picture_url?: string;
          type?: string;
          url?: string;
          username?: string;
          verified?: boolean;
      },
      options?: { resolveUrl?: boolean },
  ): this

  Add a tappable social-entity embed (IG/FB/etc. profile card). EXPERIMENTAL.

  Parameters

  • Optionaldata: {
        entity_full_name?: string;
        entity_id?: string;
        entity_name?: string;
        entity_picture_url?: string;
        entity_type?: string;
        entity_url?: string;
        full_name?: string;
        heading?: boolean;
        image?: string;
        is_verified?: boolean;
        key?: string;
        label?: string;
        picture_url?: string;
        type?: string;
        url?: string;
        username?: string;
        verified?: boolean;
    }
  • Optionaloptions: { resolveUrl?: boolean }

  Returns this

addSource

• addSource(
      sources?: Record<string, any>[],
      options?: { resolveUrl?: boolean },
  ): this

  Parameters

  • Optionalsources: Record<string, any>[]
  • Optionaloptions: { resolveUrl?: boolean }

  Returns this

addSpacer

• addSpacer(spacing?: number): this

  GenAISpacerPrimitive — blank vertical spacing.

  Parameters

  • Optionalspacing: number

  Returns this

addSubmessage

• addSubmessage(submessage: Record<string, any>): this

  Parameters

  • submessage: Record<string, any>

  Returns this

addSuggest

• addSuggest(
      suggestion: Record<string, any>,
      options?: { layout?: string; scroll?: boolean },
  ): this

  Parameters

  • suggestion: Record<string, any>
  • Optionaloptions: { layout?: string; scroll?: boolean }

  Returns this

addTable

• addTable(table: string[][], options?: AddTextOptions): this

  Parameters

  • table: string[][]
  • Optionaloptions: AddTextOptions

  Returns this

addTask

• addTask(
      data: {
          status?: string;
          subtitle?: string;
          task_id?: string;
          textFallback?: boolean;
          title: string;
      },
  ): this

  GenAITaskPrimitive — task/checklist card.

  Parameters

  • data: {
        status?: string;
        subtitle?: string;
        task_id?: string;
        textFallback?: boolean;
        title: string;
    }

  Returns this

addText

• addText(text: string, options?: AddTextOptions): this

  Parameters

  • text: string
  • Optionaloptions: AddTextOptions

  Returns this

addThinkingStatus

• addThinkingStatus(
      title: string,
      options?: {
          icon?: string;
          is_in_progress?: boolean;
          target_secondary_screen_id?: string;
          target_secondary_screen_tab_id?: string;
          textFallback?: boolean;
      },
  ): this

  GenAIBotThinkingStatusPrimitive — one-shot "thinking" status chip.

  Parameters

  • title: string
  • Optionaloptions: {
        icon?: string;
        is_in_progress?: boolean;
        target_secondary_screen_id?: string;
        target_secondary_screen_tab_id?: string;
        textFallback?: boolean;
    }

  Returns this

addTip

• addTip(text: string): this

  Parameters

  • text: string

  Returns this

addVideo

• addVideo(
      videoUrl: string,
      options?: { autoFill?: boolean; resolveUrl?: boolean },
  ): this

  Parameters

  • videoUrl: string
  • Optionaloptions: { autoFill?: boolean; resolveUrl?: boolean }

  Returns this

addViewModel

• addViewModel(
      typename: string,
      primitives: AIRichPrimitiveSpec | AIRichPrimitiveSpec[],
      opts?: AIRichViewModelOptions,
  ): this

  Push a raw custom view_model section by typename (bare or fully-qualified), with one primitive or an array.

  Parameters

  • typename: string
  • primitives: AIRichPrimitiveSpec | AIRichPrimitiveSpec[]
  • Optionalopts: AIRichViewModelOptions

  Returns this

addVStack

• addVStack(items?: (string | AIRichStackItem)[]): this

  Parameters

  • Optionalitems: (string | AIRichStackItem)[]

  Returns this

addWidget

• addWidget(
      data: Record<string, any> | Record<string, any>[],
      options?: { layout?: string },
  ): this

  GenAI3PExtWidgetPrimitive — experimental, reverse-engineered; see JSDoc in the .js file for caveats.

  Parameters

  • data: Record<string, any> | Record<string, any>[]
  • Optionaloptions: { layout?: string }

  Returns this

build

• build(options?: AIRichBuildOptions): Promise<Record<string, any>>

  Parameters

  • Optionaloptions: AIRichBuildOptions

  Returns Promise<Record<string, any>>

buildEdit

• buildEdit(
      targetJid: string,
      targetId: string,
      options?: AIRichEditOptions,
  ): Promise<any>

  Parameters

  • targetJid: string
  • targetId: string
  • Optionaloptions: AIRichEditOptions

  Returns Promise<any>

delete

• delete(id: string): this

  Parameters

  • id: string

  Returns this

getIds

• getIds(): string[]

  Returns string[]

hasId

• hasId(id: string): boolean

  Parameters

  • id: string

  Returns boolean

peek

• peek(id: string): { id: string; sections: any[]; submessages: any[] } | null

  Parameters

  • id: string

  Returns { id: string; sections: any[]; submessages: any[] } | null

refreshBotResponseId

• refreshBotResponseId(): this

  Returns this

refreshResponseId

• refreshResponseId(): this

  Returns this

send

• send(jid: string, options?: AIRichSendOptions): Promise<any>

  Parameters

  • jid: string
  • Optionaloptions: AIRichSendOptions

  Returns Promise<any>

sendEdit

• sendEdit(jid: string, id: string, options?: AIRichEditOptions): Promise<any>

  Parameters

  • jid: string
  • id: string
  • Optionaloptions: AIRichEditOptions

  Returns Promise<any>

setBotResponseId

• setBotResponseId(id: string): this

  Parameters

  • id: string

  Returns this

setResponseId

• setResponseId(id: string): this

  Parameters

  • id: string

  Returns this

streamText

• streamText(
      jid: string,
      text: string | string[],
      options?: {
          chunkSize?: number;
          cursor?: string;
          intervalMs?: number;
          [key: string]: any;
      },
  ): Promise<{ edits: number; key: any; text: string }>

  Progressive text reveal ("AI typing" effect): sends once, then patches the same bubble via EDIT protocolMessages until the full text is out. Accepts a plain string (split at word boundaries every ~chunkSize chars) or a pre-split array of chunks. intervalMs (min 300) paces the edits; cursor is shown after partial text while streaming ('' disables).

  Parameters

  • jid: string
  • text: string | string[]
  • Optionaloptions: { chunkSize?: number; cursor?: string; intervalMs?: number; [key: string]: any }

  Returns Promise<{ edits: number; key: any; text: string }>

StaticfromMarkdown

• fromMarkdown(md: string, client: any): AIRich

  new AIRich(client).addMarkdown(md) in one call.

  Parameters

  • md: string
  • client: any

  Returns AIRich

StaticisExperimental

• isExperimental(name: string): boolean

  True when name is a reverse-engineered primitive with no public schema backing.

  Parameters

  • name: string

  Returns boolean

StaticnewLayout

• newLayout(
      name: string,
      data: Record<string, any> | Record<string, any>[],
      extra?: Record<string, any>,
  ): Record<string, any>

  Parameters

  • name: string
  • data: Record<string, any> | Record<string, any>[]
  • Optionalextra: Record<string, any>

  Returns Record<string, any>

Staticprimitive

• primitive(spec: AIRichPrimitiveSpec): Record<string, any> | null

  Normalize a primitive spec into a { __typename, ... } object (Meta prefix added to bare names).

  Parameters

  • spec: AIRichPrimitiveSpec

  Returns Record<string, any> | null

StaticsendPairedMedia

• sendPairedMedia(
      client: any,
      jid: string,
      media: {
          image: string | Buffer<ArrayBufferLike>;
          video: string | Buffer<ArrayBufferLike>;
      },
  ): Promise<any>

  Send an image + video as one paired-media unit (messageAssociation).

  Parameters

  • client: any
  • jid: string
  • media: {
        image: string | Buffer<ArrayBufferLike>;
        video: string | Buffer<ArrayBufferLike>;
    }

  Returns Promise<any>

StaticsendSupportPayload

• sendSupportPayload(
      client: any,
      jid: string,
      text: string,
      options?: {
          isAiMessage?: boolean;
          shouldShowSystemMessage?: boolean;
          ticketId?: string;
          version?: number;
      },
  ): Promise<any>

  Send a support-ticket marker message (messageContextInfo.supportPayload).

  Parameters

  • client: any
  • jid: string
  • text: string
  • Optionaloptions: {
        isAiMessage?: boolean;
        shouldShowSystemMessage?: boolean;
        ticketId?: string;
        version?: number;
    }

  Returns Promise<any>

Statictokenizer

• tokenizer(code: string, lang?: string): Record<string, any>

  Parameters

  • code: string
  • Optionallang: string

  Returns Record<string, any>

StatictoTableMetadata

• toTableMetadata(arr: string[][], options?: AddTextOptions): Record<string, any>

  Parameters

  • arr: string[][]
  • Optionaloptions: AddTextOptions

  Returns Record<string, any>