Open
Conversation
All methods throw NotImplementedError as a starting point for future implementation.
Introduce `createiMessageAdapter` to initialize the adapter using either configuration objects or environment variables (`IMESSAGE_LOCAL`, `IMESSAGE_SERVER_URL`, `IMESSAGE_API_KEY`). Add Photon AI iMessage kit dependencies and rename the class to `iMessageAdapter`.
Remove userName config from iMessage adapter Introduce SDK initialization to the adapter, instantiating `IMessageSDK` for local mode and `AdvancedIMessageKit` for remote mode. Add corresponding mocks and tests for the new dependencies.
Add comprehensive unit tests for the iMessage adapter covering webhook parsing, gateway listener lifecycle, thread ID encode/decode, and initialization. Introduce packages/adapter-imessage/src/types.ts with typed event and payload models. Enforce macOS-only local mode and use parseMarkdown from the chat package; mock external SDKs in tests.
Throws NotImplementedError in local mode; delegates to the SDK's `messages.editMessage` in remote mode with backwards compatibility message included.
Extracts message building logic into a shared `buildMessage` method, allowing `parseMessage` to reuse it for both local and remote payloads instead of throwing `NotImplementedError`.
Maps emoji names to iMessage tapbacks (love, like, dislike, laugh, emphasize, question) and sends them via the remote SDK. Local mode throws NotImplementedError since tapbacks require the remote API.
- Add `iMessageFormatConverter` with plain-text AST rendering (strips bold, italic, strikethrough; preserves lists, blockquotes, code) - Accept `logger` in constructor config instead of deriving it from `chat.getLogger()` during `initialize()` - Replace generic `Error` with `ValidationError` from shared package - Add `sample-messages.md` with real-world webhook payload examples - Add tests for markdown converter and update existing tests for new constructor signature
Add message history support for both local and remote modes. Updates docs to reflect that message history is now supported.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Contributor
|
@underthestars-zhy is attempting to deploy a commit to the Vercel Team on Vercel. A member of the Team first needs to authorize it. |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Adds a new @chat-adapter/imessage package to the monorepo, enabling Chat SDK bots to send/receive iMessage via either a local macOS integration or a remote Photon-backed server, along with documentation updates and build/test configuration.
Changes:
- Introduces
packages/adapter-imessagewith adapter implementation, format converter, types, tests, and package metadata. - Adds documentation pages/navigation entries for the new iMessage adapter and updates overview tables.
- Updates repo configuration (
turbo.json) and dependency lockfile to include new env vars and dependencies.
Reviewed changes
Copilot reviewed 16 out of 17 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| turbo.json | Adds iMessage-related environment variables to Turbo config. |
| pnpm-lock.yaml | Adds dependencies for the new adapter package and transitive deps. |
| packages/adapter-imessage/vitest.config.ts | Adds Vitest configuration for the new package. |
| packages/adapter-imessage/tsup.config.ts | Adds tsup build configuration and externals for Photon SDKs. |
| packages/adapter-imessage/tsconfig.json | Adds TypeScript config for the new package. |
| packages/adapter-imessage/src/types.ts | Adds webhook/gateway payload and normalized message types. |
| packages/adapter-imessage/src/markdown.ts | Adds plain-text format converter for iMessage. |
| packages/adapter-imessage/src/markdown.test.ts | Adds tests for markdown/plain-text conversion behavior. |
| packages/adapter-imessage/src/index.ts | Implements the adapter (local/remote), webhook handling, sending, reactions, typing, and history fetching. |
| packages/adapter-imessage/src/index.test.ts | Adds tests covering adapter behavior across modes and webhook/gateway paths. |
| packages/adapter-imessage/sample-messages.md | Adds example payloads for gateway/native webhooks and message events. |
| packages/adapter-imessage/package.json | Declares the new package, deps, scripts, and publish metadata. |
| packages/adapter-imessage/README.md | Adds package-level installation/usage documentation. |
| apps/docs/content/docs/adapters/meta.json | Adds iMessage to docs navigation. |
| apps/docs/content/docs/adapters/index.mdx | Updates adapter overview matrix to include iMessage. |
| apps/docs/content/docs/adapters/imessage.mdx | Adds full iMessage adapter documentation page. |
| README.md | Adds iMessage to the repo-level supported platforms/packages lists. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+372
to
+374
| encodeThreadId(platformData: iMessageThreadId): string { | ||
| return `imessage:${platformData.chatGuid}`; | ||
| } |
There was a problem hiding this comment.
PR description notes thread IDs follow imessage:{chatId}:{messageId}, but encodeThreadId()/decodeThreadId() only use imessage:{chatGuid}. Either update the implementation to match the documented thread ID format, or adjust the PR description/docs to match the actual format before release to avoid confusing SDK users.
Resolve conflicts in adapters/index.mdx (merge iMessage + Telegram columns into all feature matrix tables) and pnpm-lock.yaml (regenerate from upstream). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Create a dedicated `AdvancedIMessageKit` instance for `startGatewayListener` instead of reusing the shared `this.sdk` singleton. Previously, closing the listener would close the shared instance, breaking other methods that depend on it (e.g., `sendMessage`, `editMessage`).
Simplify the webhook handling to only support native `imessage-kit` pay
Introduce a dedicated `token` config option and `IMESSAGE_GATEWAY_TOKEN` env var for authenticating incoming webhooks via the `x-imessage-gateway-token` header, distinct from the `apiKey` used for remote server authentication.
Replaces the webhook-based message receiving approach with `startGatewayListener()` as the sole supported method. Updates docs to reflect the new serverless cron-based setup pattern using Vercel.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new
@chat-adapter/imessagepackage that enables Chat SDK bots to communicate over iMessage. The adapter supports two modes:Changes
New package:
packages/adapter-imessagesrc/index.tscreateiMessageAdapter()factory, remote/local mode support, message posting, editing, reactions, typing indicators, thread fetching, and message historysrc/types.tssrc/markdown.tssrc/index.test.tssrc/markdown.test.tssample-messages.mdREADME.mdDocumentation
apps/docs/content/docs/adapters/imessage.mdx— Full adapter documentation with setup instructions for both remote and local modes, environment variables, and usage examplesapps/docs/content/docs/adapters/index.mdx— Updated adapters overview to include iMessageapps/docs/content/docs/adapters/meta.json— Added iMessage to docs navigationConfiguration
turbo.json— AddedIMESSAGE_*andPHOTON_*environment variables to the build configREADME.md— Added iMessage to supported platforms table and packages listKey design decisions
IMESSAGE_LOCALenvironment variable but also accepts explicitlocal: true/falsein configimessage-kit(optional peer dependency) for database access and AppleScript sendingimessage:{chatId}:{messageId}Test plan
pnpm --filter @chat-adapter/imessage test)