Skip to content

📦 Update XMTP-JS SDK docs for @xmtp/agent-sdk@2.3.0 - #725

Open
neekolas wants to merge 1 commit into
mainfrom
auto-update-js-docs-@xmtp/agent-sdk@2.3.0
Open

neekolas wants to merge 1 commit into
mainfrom
auto-update-js-docs-@xmtp/agent-sdk@2.3.0

Conversation

@neekolas

@neekolas neekolas commented Mar 14, 2026 •

Copy link
Copy Markdown
Contributor

🤖 Automated XMTP-JS SDK Documentation Update

This PR updates the documentation to align with XMTP-JS SDK release @xmtp/agent-sdk@2.3.0.

Changes Made

  • Updated Node.js and Browser SDK code samples to match current APIs
  • Verified JavaScript/TypeScript integration examples
  • Updated version references and installation instructions
  • Addressed any breaking changes or deprecations
  • Updated content type usage examples
  • Verified Client, Conversation, and Message API patterns
  • Validated code samples using repository linting tools
  • Updated TypeScript definitions and examples

SDK Areas Covered

  • 🌐 Browser SDK: WorkerClient, Web Worker patterns, browser-specific APIs
  • 🖥️ Node SDK: Direct client usage, Node.js utilities and scripts
  • 📦 Content Types: Text, reactions, attachments, replies, custom types
  • 🔧 Core APIs: Client creation, conversations, messaging, streaming
  • 🛡️ Authentication: Signer setup, inbox management, user consent

Analysis Summary

Documentation analysis and updates completed using Claude Code Actions with comprehensive diff analysis between @xmtp/agent-sdk@2.2.1 and @xmtp/agent-sdk@2.3.0.

Verification Needed

  • Review all JavaScript/TypeScript code samples for accuracy
  • Test integration examples with current SDK version
  • Verify version compatibility information across packages
  • Check TypeScript definitions and type examples
  • Validate Browser vs Node SDK usage patterns
  • Check content type integration examples
  • Verify client initialization and configuration examples
  • Check for any missed documentation updates

This PR was automatically generated by Claude Code Actions

Note

Update history-sync docs for @xmtp/agent-sdk@2.3.0 API changes

Updates history-sync.mdx to reflect breaking API changes in @xmtp/agent-sdk@2.3.0.

  • Renames the archiveElements option to elements and updates its type to use BackupElementSelectionOption enum values (e.g. BackupElementSelectionOption.Consent) in sendSyncRequest and sendSyncArchive examples.
  • Changes listAvailableArchives call from BigInt(30) to plain 30 in both Browser and Node examples.
  • Behavioral Change: code copied from the old docs will break against SDK 2.3.0 — the archiveElements param and BigInt argument are no longer valid.

Macroscope summarized 363f0b9.

  Automated update based on changes in xmtp-js @xmtp/agent-sdk@2.3.0

  Changes analyzed:
  - Browser SDK and Node SDK API modifications
  - Content types updates and new features
  - Code sample accuracy and syntax validation
  - Version compatibility and installation instructions
  - Breaking changes documentation
  - TypeScript type definitions and examples

  Generated by Claude Code Actions
@neekolas
neekolas requested a review from a team as a code owner March 14, 2026 08:42
@vercel

vercel Bot commented Mar 14, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-xmtp-org Ready Ready Preview, Comment Mar 14, 2026 8:43am

Request Review

@macroscopeapp

macroscopeapp Bot commented Mar 14, 2026

Copy link
Copy Markdown

Approvability

Verdict: Approved

Documentation-only changes updating code examples to reflect the @xmtp/agent-sdk v2.3.0 API (parameter renames, enum values, simplified types). No runtime impact.

You can customize Macroscope's approvability policy. Learn more.

This branch was successfully deployed

1 active deployment
Preview — 363f0b96 Deployed Mar 14, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant