AGENT SKILL

cometchat-ios-migration

Upgrade an existing CometChat iOS integration from UI Kit v4 to v5 — composite components removed, theming replaced, properties renamed. Triggers: 'upgrade cometchat ios to v5', 'migrate from v4 uikit ios', 'CometChatConversationsWithMessages not found'.

License 许可
MIT
最近更新
2026-11-14
Stars
★ 1.6k
Forks
491

01 前言 Front Matter

name
cometchat-ios-migration
license
MIT
metadata
{ "tags": "cometchat ios migration upgrade v4 v5 swift", "author": "CometChat", "version": "1.0.0" }
description
Upgrade an existing CometChat iOS integration from UI Kit v4 to v5 — composite components removed, theming replaced, properties renamed. Triggers: 'upgrade cometchat ios to v5', 'migrate from v4 uikit ios', 'CometChatConversationsWithMessages not found'.
compatibility
from CometChatUIKitSwift v4 → 5.2.3+ · iOS 15.1+

03 SKILL.md 正文

Companion skills (read first)

  • cometchat-ios-core describes the v5 target state. This skill is the RECONCILIATION path to it. Build from the official guide — fetch /ui-kit/ios/upgrading-from-v4 via cometchat-ios-core/references/docs-map.md — then apply the deltas below.

Use this skill when

An existing v4 integration must move to v5, or a build breaks with cannot find 'CometChatConversationsWithMessages' in scope after an upgrade.

The one change that dominates the migration

v4's composite components are gone. CometChatMessages, CometChatUsersWithMessages, CometChatGroupsWithMessages, CometChatConversationsWithMessages do not exist in v5, and neither do the configuration objects that fed them (MessageHeaderConfiguration, MessageListConfiguration, MessageComposerConfiguration).

That is not a rename — it is an inversion of ownership. v4 gave you one screen that did everything; v5 gives you three components and expects you to own the screen and the navigation. Every place the old code pushed a composite becomes a view controller you write, composed per cometchat-ios-core's golden path, with its five layout rules applied.

Budget for this honestly: it is the bulk of the work, and it is a design change in the host app, not a search-and-replace.

Then the mechanical deltas

  • Theming was replaced. v4's theme objects give way to CometChatTheme's static colours plus per-component style objects. Re-derive the brand from the theme rather than porting v4 style code — cometchat-ios-customization.
  • Setter vs property split. Several v4 setters are v5 properties: styles (avatarStyle, badgeStyle, receiptStyle, statusIndicatorStyle, typingIndicatorStyle), onSearchClick, onSelectedItemProceed, the call-button click handlers.
  • Renames to expect: set(usersRequestBuilder:) → set(userRequestBuilder:) · set(subtitleView:) → set(subtitle:) and set(trailView:) → set(trailingView:) on Users/Groups only (Conversations and GroupMembers keep the old spelling) · set(sessionID:) → set(sessionId:) · set(callSettingBuilder:) → set(callSettingsBuilder:) · set(onDeclineClick:) → set(onCancelClick:) · set(parentMessage:) → set(parentMessageId:) on the list and composer, though the thread header still takes set(parentMessage:).
  • Dependencies. v5 is SPM-only (CocoaPods is winding down). Add CometChatUIKitSwift alone, Up to Next Major from 5.2.3: it resolves CometChatSDK (4.1.10+) itself, so remove any hand-added Chat SDK pin. Add CometChatCallsSDK (from 5.0.4) only if the app calls.

Method

Upgrade the dependency first and let the compiler enumerate the work — the errors are the migration checklist. Fix composites first (they cascade), then styling, then the renames. Do it additively: the host app's navigation, auth and design system stay theirs.

Gotchas

  • Never mix majors. A half-migrated project with both v4 and v5 symbols will not build.
  • Check every symbol against catalogs/ios-v5.json before porting it — if it is absent, it is gone, and a v5 doc page mentioning it is not evidence it exists.

Verify it works

The project builds with no v4 symbols remaining; every screen that was a composite is now a composed screen that renders full-size, keyboard-avoids and navigates back; theming looks intentional rather than half-ported.

04 同仓库更多 Skills

hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-review-with-annotations

Create, inspect, reply to, update, or resolve situated Worktable annotations. Use when feedback belongs to a Doc section, block, text range, or HTML Doc, or when the user asks to address existing review feedback and coordinate a requested artifact edit.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-find-and-synthesize-context

Find, assess, and synthesize context from Worktable Docs and Records. Use when the user asks what a workspace contains, wants workspace-backed research, needs current facts reconciled across artifacts, or requests a cited synthesis without changing workspace state.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-update-docs

Create, edit, rename, or maintain narrative Worktable Docs. Use for plans, decisions, briefs, notes, research syntheses, and other durable prose when the user requests a new artifact or a safe update to an existing one.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-records

Organize repeated structured information as durable Worktable Records. Use for research datasets, inventories, directories, pipelines, trackers, and other collections whose items need identity, fields, filtering, links, validation, or individual updates.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-create-or-manage-interactive-html

Create or improve durable visual and interactive artifacts in Worktable. Use for dashboards, trackers, calculators, mini apps, slide presentations, and other requests that benefit from a polished HTML Doc.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

worktable-collaborate-threads

Read, answer, and hand off messages through durable Worktable threads with users or other authenticated participants. Use when the user asks to check addressed messages, reply to a participant, continue a thread, request another agent's help, wait briefly for a response, or watch for comments and messages sent to the agent.

★ 1.6k