Skip to content

ccs-chat-client changelog

Versions follow semver. For the package itself see ccs-chat-client. The reference is at /sdks/ccs-chat-client/reference/.

Breaking. snake_case types and Identity Server scope names.

3.0.0 follows the conventions of @central-code-station/ccs-identity-client: request and response objects use the Chat API’s own snake_case field names, and the granular scopes are the ones the Identity Server defines on chat-api.

2.x 3.0.0
conversations.create({ type, memberUserIds, actorUserId }) conversations.create({ type, member_user_ids, actor_user_id })
conversations.addMember(id, { userId, displayName, email }) conversations.addMember(id, { user_id, display_name, email })
messages.send(id, { body, actorUserId, messageType, replyToMessageId, mentionedUserIds, attachments: [{ fileId, mimeType, ... }] }) messages.send(id, { body, actor_user_id, message_type, reply_to_message_id, mentioned_user_ids, attachments: [{ file_id, mime_type, ... }] })
Conversation (id, memberCount, …) ChatConversation (conversation_id, member_count, …) — the API response, unchanged
ChatMessage (id, senderUserId, …) ChatMessage (message_id, sender_user_id, …)
Member, UserRef ChatMember, ChatUserRef; users.lookup returns ChatUserProfile[]
Page { items, nextCursor } Page { items, next_cursor }
scopes chat:conversation:create / chat:conversation:read chat:conversations.manage / chat:conversations.read (+ chat:groups.manage, chat:channels.manage, chat:messages.send, chat:users.lookup)
scope?: string scope?: ChatMachineScope | ChatMachineScope[] | string
— conversations.archive(id) / conversations.reactivate(id); DIRECT conversations accept a status change from a machine client
— ChatRateLimitedError (429) with retryAfterSeconds

Constructor options are unchanged (camelCase), as in ccs-identity-client.

First release for the Chat API with tenant and application contexts. Earlier release notes are not kept.