From d3f133db7a2146ce59eb178ebd9772d6ace16e1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Misi=C5=82o?= Date: Wed, 15 Jul 2026 18:20:38 +0200 Subject: [PATCH] chore: prepare chat adapter stable release --- .changeset/chat-adapter-stable.md | 6 ++++++ .changeset/config.json | 1 - AGENTS.md | 9 +++++---- README.md | 6 +++--- RELEASING.md | 19 +++++++++++-------- packages/chat-adapter/README.md | 6 ++---- 6 files changed, 27 insertions(+), 20 deletions(-) create mode 100644 .changeset/chat-adapter-stable.md diff --git a/.changeset/chat-adapter-stable.md b/.changeset/chat-adapter-stable.md new file mode 100644 index 0000000..ac1e24d --- /dev/null +++ b/.changeset/chat-adapter-stable.md @@ -0,0 +1,6 @@ +--- +'@imessage-sdk/chat-adapter': patch +--- + +Promote the provider-neutral Chat SDK adapter to its first stable release, with direct messages, +attachments, signed webhooks, reactions, typing indicators, read state, and provider-aware typing. diff --git a/.changeset/config.json b/.changeset/config.json index 4e0c9c6..7d76e2b 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -8,7 +8,6 @@ "baseBranch": "main", "updateInternalDependencies": "patch", "bumpVersionsWithWorkspaceProtocolOnly": true, - "ignore": ["@imessage-sdk/chat-adapter"], "privatePackages": { "version": false, "tag": false diff --git a/AGENTS.md b/AGENTS.md index 4d35b98..96b69c1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -35,7 +35,7 @@ depend on the public `imessage-sdk` interface rather than provider internals. | `packages/imessage-sdk` | Provider-neutral core package (`imessage-sdk`) | | `packages/providers/` | Independently published provider package | | `packages/providers/README.md` | Cross-provider feature support matrix | -| `packages/chat-adapter` | Beta Chat SDK integration (`@imessage-sdk/chat-adapter`) | +| `packages/chat-adapter` | Chat SDK integration (`@imessage-sdk/chat-adapter`) | | `packages/eve-channel` | Private placeholder for `@imessage-sdk/eve-channel` | | `packages/cli` | Private placeholder for `@imessage-sdk/cli` | | `examples/basic-blooio` | Opt-in live example using only published Blooio and core APIs | @@ -324,9 +324,10 @@ Use conventional SemVer: - `minor`: backward-compatible features - `major`: breaking changes -During the current beta, Changesets converts these into the appropriate prerelease version. Select -only public packages actually affected. Tests, internal refactors, documentation-only changes, and -private placeholder packages do not need a changeset unless they alter a published artifact. +Select only public packages actually affected. Tests, internal refactors, documentation-only +changes, and private placeholder packages do not need a changeset unless they alter a published +artifact. When Changesets prerelease mode is active, eligible releases receive the configured +prerelease suffix. Do not manually edit package versions or generated package changelogs during the regular release flow. The Version Packages pull request performs those updates. Do not publish from an agent session diff --git a/README.md b/README.md index f5d5f49..9f8f0a4 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ A provider-neutral TypeScript conversation layer for iMessage infrastructure. The repository contains the provider-neutral [`imessage-sdk`](./packages/imessage-sdk) -core, independently installable providers, and a beta +core, independently installable providers, and the [`@imessage-sdk/chat-adapter`](./packages/chat-adapter) for [Chat SDK](https://chat-sdk.dev). The core also exposes a public contract for custom providers. @@ -59,7 +59,7 @@ packages/ ├── providers/ │ ├── blooio/ @imessage-sdk/blooio │ └── photon/ @imessage-sdk/photon -├── chat-adapter/ @imessage-sdk/chat-adapter (beta) +├── chat-adapter/ @imessage-sdk/chat-adapter ├── eve-channel/ Private placeholder for @imessage-sdk/eve-channel └── cli/ Private placeholder for @imessage-sdk/cli examples/ @@ -72,7 +72,7 @@ root and remaining future package placeholders are private. ## Chat SDK ```bash -pnpm add @imessage-sdk/chat-adapter@beta chat +pnpm add @imessage-sdk/chat-adapter chat ``` ```ts diff --git a/RELEASING.md b/RELEASING.md index a5a44e8..501323e 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -10,7 +10,7 @@ requests, npm trusted publishing, and package-specific GitHub Releases. | `packages/imessage-sdk` | `imessage-sdk` | Public | | `packages/providers/blooio` | `@imessage-sdk/blooio` | Public | | `packages/providers/photon` | `@imessage-sdk/photon` | Public | -| `packages/chat-adapter` | `@imessage-sdk/chat-adapter` | Private placeholder | +| `packages/chat-adapter` | `@imessage-sdk/chat-adapter` | Public | | `packages/eve-channel` | `@imessage-sdk/eve-channel` | Private placeholder | | `packages/cli` | `@imessage-sdk/cli` | Private placeholder | @@ -101,7 +101,7 @@ changelogs. ## Trusted publishing on npm Configure trusted publishing separately in the settings for `imessage-sdk`, -`@imessage-sdk/blooio`, and `@imessage-sdk/photon`: +`@imessage-sdk/blooio`, `@imessage-sdk/photon`, and `@imessage-sdk/chat-adapter`: ```text Provider: GitHub Actions @@ -282,18 +282,21 @@ pnpm package:check pnpm changeset status ``` -## Leaving beta +## Promoting a bootstrapped beta to stable -When the public API is ready for a stable release: +If a package was initially published with a prerelease version without entering +Changesets prerelease mode, add a normal patch Changeset for that package. For +example, a patch release from `0.1.0-beta.3` resolves to stable `0.1.0`. Review +that target in the Version Packages pull request before merging it. Stable +publication moves the package to npm’s `latest` tag. + +If `.changeset/pre.json` exists because the repository is in Changesets +prerelease mode, leave that mode instead: ```bash pnpm changeset pre exit ``` -Commit the changed `.changeset/pre.json` in a normal pull request. Review the -resulting stable versions in the Version Packages pull request before merging -it. Stable publication moves packages to npm’s `latest` tag. - ## After the first stable release Betas are optional. Ordinary fixes and backward-compatible features use the diff --git a/packages/chat-adapter/README.md b/packages/chat-adapter/README.md index 29a04ec..6d83b53 100644 --- a/packages/chat-adapter/README.md +++ b/packages/chat-adapter/README.md @@ -3,14 +3,12 @@ Provider-neutral iMessage adapter for [Chat SDK](https://chat-sdk.dev), powered by [`imessage-sdk`](https://www.npmjs.com/package/imessage-sdk). -> This package is currently in beta and its adapter API may change before a stable release. - ## Install Install the adapter, Chat SDK, core SDK, state backend, and one provider: ```bash -pnpm add @imessage-sdk/chat-adapter@beta @imessage-sdk/blooio imessage-sdk chat @chat-adapter/state-pg +pnpm add @imessage-sdk/chat-adapter @imessage-sdk/blooio imessage-sdk chat @chat-adapter/state-pg ``` ## Usage @@ -157,7 +155,7 @@ Set `persistThreadHistory = true` so Chat SDK stores conversation history in its The adapter's direct `fetchMessages()` method maintains only a bounded in-process cache because `imessage-sdk` does not yet expose provider-neutral message-history pagination. -## v0.1 beta scope +## v0.1 scope Supported: