expo-callkit-telecom 0.2.2 → 0.2.4

package/CHANGELOG.md

@@ -0,0 +1,60 @@
+# Changelog
+
+All notable changes to `expo-callkit-telecom` are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.4] — 2026-05-16
+
+### Added
+- Documentation site at https://mfairley.github.io/expo-callkit-telecom/ — VitePress with auto-generated typedoc API reference, deployed via a GitHub Actions workflow on push to `main`.
+- "Verified against" matrix in the README and docs site, listing the iOS / Android / Expo SDK / React Native / New Architecture / media-transport versions exercised end-to-end on real devices in each release.
+- `docs:dev` / `docs:build` / `docs:preview` / `docs:api` scripts.
+
+### Changed
+- Reframed the `react-native-callkeep` comparison around architectural choices (Jetpack `androidx.core:core-telecom`, Swift + Kotlin, Expo Modules API, `RTCAudioSession` manual-audio coordination, native VoIP push parsing) — framing tied to platform recommendations rather than to any other library's release cadence.
+- `docs/` and `marketing/` excluded from the npm tarball.
+
+## [0.2.3] — 2026-05-16
+
+### Added
+- `CHANGELOG.md`.
+- `docs/vs-callkeep.md` — standalone migration / comparison guide.
+
+### Changed
+- Tightened the npm description and expanded keywords for discoverability.
+- Trimmed the README callkeep comparison; full side-by-side now lives at [`docs/vs-callkeep.md`](docs/vs-callkeep.md).
+
+## [0.2.2] — 2026-05-16
+
+### Changed
+- Moved README badges below the intro for consistency with sibling repo.
+
+## [0.2.1] — 2026-05-16
+
+### Fixed
+- Dropped `.svg` suffix from the license badge URL.
+
+### Changed
+- Auto-create a GitHub release on publish; README polish.
+- Applied `swift-format` and `ktfmt` across the native sources.
+
+## [0.2.0] — 2026-05-15
+
+### Added
+- Initial public implementation:
+  - CallKit (iOS) + Jetpack `androidx.core:core-telecom` (Android) with a single typed `CallSession` and parity API (`request` / `report` / `fulfill`).
+  - Native VoIP push parsing: APNs VoIP (PushKit) on iOS, FCM data messages on Android — calls can be reported from a terminated state.
+  - System ringtone for incoming calls and looped dialtone (with fade-in) for outgoing calls; both configurable via the config plugin.
+  - Cross-platform audio session management with typed port types and live route-change events; integrates with WebRTC's `RTCAudioSession` for manual-audio stacks (LiveKit, plain WebRTC).
+  - Mute / hold / video / DTMF, both `app → system` and `system → app`.
+  - iOS call intents: Recents list and Siri ("call Jane").
+  - Config plugin: entitlements, background modes, microphone permission, ringtone/dialtone bundling, FCM service registration.
+- CI: trusted publishing on Node 24 / npm 11.
+
+[0.2.4]: https://github.com/mfairley/expo-callkit-telecom/releases/tag/v0.2.4
+[0.2.3]: https://github.com/mfairley/expo-callkit-telecom/releases/tag/v0.2.3
+[0.2.2]: https://github.com/mfairley/expo-callkit-telecom/releases/tag/v0.2.2
+[0.2.1]: https://github.com/mfairley/expo-callkit-telecom/releases/tag/v0.2.1
+[0.2.0]: https://github.com/mfairley/expo-callkit-telecom/releases/tag/v0.2.0

package/README.md

@@ -23,6 +23,21 @@ The module is opinionated about *system integration* and unopinionated about *me
 - 🗣️ **Call intents on iOS** — Recents list, Siri ("call Jane")
 - 🧩 **Typed TypeScript API** with a single `CallSession` object that tracks state across the call lifecycle
 
+## 🧪 Verified against
+
+This release is exercised end-to-end on real devices via the runnable `example/` app.
+
+| | Tested against |
+| --- | --- |
+| iOS | 26 (minimum 15.1) |
+| Android | 15 (minimum API 26) |
+| Expo SDK | 55 |
+| React Native | 0.83 |
+| New Architecture | Yes |
+| Media transport | LiveKit RN SDK |
+
+Each release updates this table — so the recency signal is the version number on npm, not a promise in prose.
+
 ## 📦 Install
 
 ```sh
@@ -196,13 +211,7 @@ This module hands the OS a CallKit/Telecom call, which keeps the *process* alive
 
 ## 🆚 Comparison with `react-native-callkeep`
 
-[`react-native-callkeep`](https://github.com/react-native-webrtc/react-native-callkeep) is the long-standing option in this space. Here are some differences with this package:
+[`react-native-callkeep`](https://github.com/react-native-webrtc/react-native-callkeep) is the long-standing React Native library in this space. `expo-callkit-telecom` solves the same problem but is built on the current generation of platform APIs: Jetpack `androidx.core:core-telecom` on Android, Swift + Kotlin, the Expo Modules API with a config plugin, and `RTCAudioSession` coordination for manual-audio WebRTC stacks like LiveKit. It also parses APNs VoIP and FCM data payloads natively, so the cold-start incoming-call case works without app-side glue.
 
-- **Android backend.** callkeep uses the classic `android.telecom.ConnectionService` (`minSdk 23`). This module uses Jetpack `androidx.core:core-telecom` (`minSdk 26`), the Google-recommended path going forward — it owns the foreground service, the incoming-call notification, and the full-screen intent, so you don't wire any of that up.
-- **Native language.** callkeep is Objective-C + Java. This module is Swift + Kotlin.
-- **VoIP push parsing.** callkeep doesn't parse pushes — you wire up `pushRegistry:didReceiveIncomingPushWithPayload:` (or `react-native-voip-push-notification`) and FCM data handling yourself. This module parses APNs VoIP and FCM payloads natively, before JS is running, so calls report correctly from a terminated state without app-side glue.
-- **Audio session.** callkeep manipulates `AVAudioSession` directly, leaving WebRTC's `RTCAudioSession` to be coordinated by the app. This module integrates with `RTCAudioSession` so manual-audio WebRTC stacks (LiveKit, plain WebRTC) work without extra wiring.
-- **API shape.** callkeep's options are split into `{ ios: {...}, android: {...} }` and several methods are platform-only. This module exposes one typed `CallSession` object and one set of verbs (`request` / `report` / `fulfill`) that work the same on both platforms.
-- **Expo support.** This module is an Expo Module with a config plugin that handles entitlements, background modes, permissions, ringtone bundling, and FCM service registration.
-- **Tested with.** iOS 26 / Android 15, on real devices, with LiveKit as the media transport.
+Full side-by-side, compatibility matrix, and migration notes: **[docs/vs-callkeep.md](docs/vs-callkeep.md)**.
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "expo-callkit-telecom",
-  "version": "0.2.2",
-  "description": "Expo module wrapping CallKit (iOS) and Jetpack Core-Telecom (Android) with API parity",
+  "version": "0.2.4",
+  "description": "CallKit + Jetpack Core-Telecom for Expo / React Native — native call UI, VoIP push, LiveKit-friendly audio. A modern react-native-callkeep alternative.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -14,16 +14,30 @@
     "prepublishOnly": "expo-module prepublishOnly",
     "expo-module": "expo-module",
     "open:ios": "xed example/client/ios",
-    "open:android": "open -a \"Android Studio\" example/client/android"
+    "open:android": "open -a \"Android Studio\" example/client/android",
+    "docs:api": "typedoc",
+    "docs:dev": "bun run docs:api && vitepress dev docs",
+    "docs:build": "bun run docs:api && vitepress build docs",
+    "docs:preview": "vitepress preview docs"
   },
   "keywords": [
     "react-native",
     "expo",
+    "expo-module",
     "callkit",
+    "callkeep",
     "telecom",
+    "core-telecom",
+    "jetpack",
     "voip",
     "calling",
-    "webrtc"
+    "incoming-call",
+    "webrtc",
+    "livekit",
+    "pushkit",
+    "apns",
+    "fcm",
+    "push-notifications"
   ],
   "repository": {
     "type": "git",
@@ -41,10 +55,13 @@
   "dependencies": {},
   "devDependencies": {
     "@types/react": "~19.2.14",
-    "expo-module-scripts": "^55.0.2",
     "expo": "^55.0.24",
+    "expo-module-scripts": "^55.0.2",
     "react": "19.2.0",
-    "react-native": "0.83.6"
+    "react-native": "0.83.6",
+    "typedoc": "^0.28.19",
+    "typedoc-plugin-markdown": "^4.11.0",
+    "vitepress": "^1.6.4"
   },
   "peerDependencies": {
     "expo": "*",

package/typedoc.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://typedoc-plugin-markdown.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "out": "docs/api",
+  "plugin": ["typedoc-plugin-markdown"],
+  "readme": "none",
+  "githubPages": false,
+  "skipErrorChecking": true,
+  "excludePrivate": true,
+  "excludeInternal": true,
+  "hideBreadcrumbs": true,
+  "hidePageHeader": true,
+  "useCodeBlocks": true,
+  "expandObjects": true,
+  "parametersFormat": "table",
+  "indexFormat": "table",
+  "entryFileName": "index.md",
+  "fileExtension": ".md"
+}