From 511f461ab10af7768451827ede78d5e3976d151c Mon Sep 17 00:00:00 2001 From: "Ketan (CometChat)" Date: Tue, 4 Aug 2026 23:23:19 +0530 Subject: [PATCH 1/3] docs(ui-kit/ios): document UIKit<->Chat SDK exact-version pinning MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The iOS UI Kit ships as a prebuilt binary compiled against one exact CometChatSDK version. Overriding the SDK version (e.g. via an SPM "Up to Exact Version" mismatch) is unsupported and causes build/runtime failures. Add a Warning to Getting Started spelling out the pinning contract for both CocoaPods and SPM, and link the canonical GitHub releases list. Note: the chat-sdk-ios changelog itself is current on GitHub (4.0.69-73 are published) — the staleness in the source ticket was in the AgentBuddy KB index, not this docs repo. This change adds the missing pinning guidance (recommendation #2 of the ticket). Refs ENG-37953 Co-Authored-By: Claude Opus 4.8 --- ui-kit/ios/getting-started.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/ui-kit/ios/getting-started.mdx b/ui-kit/ios/getting-started.mdx index 5c2a909f0..3a6353c5c 100644 --- a/ui-kit/ios/getting-started.mdx +++ b/ui-kit/ios/getting-started.mdx @@ -148,6 +148,15 @@ https://github.com/cometchat/chat-sdk-ios + +**Pin the Chat SDK to the exact version the UI Kit requires.** `CometChatUIKitSwift` ships as a prebuilt binary compiled against one specific `CometChatSDK` version — for UI Kit `5.1.9` that is `CometChatSDK 4.1.0` (see the version table at the top of this page). + +- **CocoaPods** installs the matching `CometChatSDK` automatically when you run `pod install`. Don't add your own `CometChatSDK` pod pinned to a different version. +- **Swift Package Manager** does not resolve it for you — add `chat-sdk-ios` with **Up to Exact Version** set to the version the UI Kit depends on. Forcing a newer or older Chat SDK (an SPM override) is unsupported and typically fails to build or crashes at runtime. + +To adopt a newer Chat SDK release, upgrade to a UI Kit version that depends on it rather than overriding the SDK version directly. The full list of Chat SDK releases is on [GitHub](https://github.com/cometchat/chat-sdk-ios/releases). + + --- ## Step 3 — Configure Permissions From 3e3dffe184d56be289f88fdb81d3e75d095607e5 Mon Sep 17 00:00:00 2001 From: "Ketan (CometChat)" Date: Thu, 6 Aug 2026 18:52:06 +0530 Subject: [PATCH 2/3] docs(ui-kit/ios): bump versions to latest (UIKit 5.1.18, Chat SDK 4.1.7) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Per reviewer feedback on PR #450. Verified: CometChatUIKitSwift 5.1.18 is the latest release and is published on CocoaPods; it depends on CometChatSDK ~> 4.1, whose latest is 4.1.7. Updated consistently across the version table, CocoaPods snippet, SPM steps, and the pinning Warning. (CometChatCallsSDK left at 4.2.2 — not part of the review request.) Refs ENG-37953 Co-Authored-By: Claude Opus 4.8 --- .claude/launch.json | 11 +++++++++++ ui-kit/ios/getting-started.mdx | 12 ++++++------ 2 files changed, 17 insertions(+), 6 deletions(-) create mode 100644 .claude/launch.json diff --git a/.claude/launch.json b/.claude/launch.json new file mode 100644 index 000000000..9fd911347 --- /dev/null +++ b/.claude/launch.json @@ -0,0 +1,11 @@ +{ + "version": "0.0.1", + "configurations": [ + { + "name": "mintlify-docs", + "runtimeExecutable": "mint", + "runtimeArgs": ["dev", "--port", "3333"], + "port": 3333 + } + ] +} diff --git a/ui-kit/ios/getting-started.mdx b/ui-kit/ios/getting-started.mdx index 3a6353c5c..b888350b1 100644 --- a/ui-kit/ios/getting-started.mdx +++ b/ui-kit/ios/getting-started.mdx @@ -9,14 +9,14 @@ description: "Integrate CometChat iOS UI Kit with project setup, package install | Field | Value | | --- | --- | | Package | `CometChatUIKitSwift` | -| Version | `5.1.9` | +| Version | `5.1.18` | | Requirements | Xcode 16+, iOS 13.0+, Swift 5.0+ | | Init | `CometChatUIKit.init(uiKitSettings:)` — must complete before `login()` | | Login | `CometChatUIKit.login(uid:)` — must complete before rendering components | | Order | `init()` → `login()` → render. Breaking this order = blank screen | | Auth Key | Dev/testing only. Use Auth Token in production | | Calling | Optional. Install `CometChatCallsSDK 4.2.2` to enable | -| Dependencies | `CometChatSDK 4.1.0` (installed automatically) | +| Dependencies | `CometChatSDK 4.1.7` (installed automatically) | | AI Skills | `npx @cometchat/skills add` — [GitHub](https://github.com/cometchat/cometchat-skills) | @@ -103,7 +103,7 @@ platform :ios, '13.0' use_frameworks! target 'YourApp' do - pod 'CometChatUIKitSwift', '5.1.9' + pod 'CometChatUIKitSwift', '5.1.18' # Optional: Voice/Video Calling pod 'CometChatCallsSDK', '4.2.2' @@ -135,7 +135,7 @@ https://github.com/cometchat/cometchat-uikit-ios 3. Select **Up to Exact Version** and enter: ``` -5.1.9 +5.1.18 ``` 4. Add the Chat SDK separately using: @@ -144,12 +144,12 @@ https://github.com/cometchat/cometchat-uikit-ios https://github.com/cometchat/chat-sdk-ios ``` - Exact Version: `4.1.0` + Exact Version: `4.1.7` -**Pin the Chat SDK to the exact version the UI Kit requires.** `CometChatUIKitSwift` ships as a prebuilt binary compiled against one specific `CometChatSDK` version — for UI Kit `5.1.9` that is `CometChatSDK 4.1.0` (see the version table at the top of this page). +**Pin the Chat SDK to the exact version the UI Kit requires.** `CometChatUIKitSwift` ships as a prebuilt binary compiled against one specific `CometChatSDK` version — for UI Kit `5.1.18` that is `CometChatSDK 4.1.7` (see the version table at the top of this page). - **CocoaPods** installs the matching `CometChatSDK` automatically when you run `pod install`. Don't add your own `CometChatSDK` pod pinned to a different version. - **Swift Package Manager** does not resolve it for you — add `chat-sdk-ios` with **Up to Exact Version** set to the version the UI Kit depends on. Forcing a newer or older Chat SDK (an SPM override) is unsupported and typically fails to build or crashes at runtime. From 08d5a2254c0da36fe501982f07ed7143fe849ed0 Mon Sep 17 00:00:00 2001 From: "Ketan (CometChat)" Date: Thu, 6 Aug 2026 19:16:31 +0530 Subject: [PATCH 3/3] docs(ui-kit/ios): bump CometChatCallsSDK 4.2.2 -> 4.2.3 Latest release compatible with the page's iOS 13.0 baseline (4.2.3 targets iOS 12.0). Not bumping to 5.0.2 here: that release requires iOS 15.1, which would contradict this page's documented iOS 13.0+ minimum without a broader baseline change. Refs ENG-37953 Co-Authored-By: Claude Opus 4.8 --- ui-kit/ios/getting-started.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/ui-kit/ios/getting-started.mdx b/ui-kit/ios/getting-started.mdx index b888350b1..969c5207f 100644 --- a/ui-kit/ios/getting-started.mdx +++ b/ui-kit/ios/getting-started.mdx @@ -15,7 +15,7 @@ description: "Integrate CometChat iOS UI Kit with project setup, package install | Login | `CometChatUIKit.login(uid:)` — must complete before rendering components | | Order | `init()` → `login()` → render. Breaking this order = blank screen | | Auth Key | Dev/testing only. Use Auth Token in production | -| Calling | Optional. Install `CometChatCallsSDK 4.2.2` to enable | +| Calling | Optional. Install `CometChatCallsSDK 4.2.3` to enable | | Dependencies | `CometChatSDK 4.1.7` (installed automatically) | | AI Skills | `npx @cometchat/skills add` — [GitHub](https://github.com/cometchat/cometchat-skills) | @@ -106,7 +106,7 @@ target 'YourApp' do pod 'CometChatUIKitSwift', '5.1.18' # Optional: Voice/Video Calling - pod 'CometChatCallsSDK', '4.2.2' + pod 'CometChatCallsSDK', '4.2.3' end ```