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 5c2a909f0..969c5207f 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) | +| 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) | @@ -103,10 +103,10 @@ 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' + pod 'CometChatCallsSDK', '4.2.3' end ``` @@ -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,10 +144,19 @@ 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.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. + +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