TypeScript
This page contains an overview of all relevant changes made to the TypeScript SDK and the latest version releases
Version 6.32.2 (2024-11-05)
Fixes:
Fixed an issue where the
myReaction
field onPost
andComment
would disappear after updating the post or comment.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.32.1 (2024-11-04)
Fixes:
Updated the
Axios
client within the SDK to exclude cookie-based authorization.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.32.0 (2024-10-25)
New Features:
Introduced the ability to check
CREATE_PRIVILEGED_POST
permission in the community.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.31.1 (2024-10-17)
New Features:
Introduced the fields
targetId
,targetType
,referenceId
, andreferenceType
inAmity.Stream
.Introduced linked objects:
community
,post
, anduser
inAmity.Stream
.Introduced the
prefixDeviceIdKey
option to be passed when creating an SDK client.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.31.0 (2024-10-10)
Fixes:
Fixed an issue where the
readCount
field inAmity.Message
was not updated while observing the live collection of messages.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.30.4 (2024-10-04)
Fixes:
Fixed an issue where users could not report posts and comments using the
createReport
API.Fixed an issue where users could not un-report posts and comments using the
deleteReport
API.Fixed an issue where
isReportedByMe
could not be used to check if the post and comment were reported by the current user.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.30.3 (2024-09-19)
Fixes:
Fixed excessive marker requests triggered on channel actions.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.30.2 (2024-09-19)
Fixes:
Fixed an issue where
matchingOnlyParentPost
in semantic search defaulted totrue
.Fixed multiple callbacks sending double responses for semantic search; it should now only send one.
Fixed missing data in the first response.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.30.1 (2024-09-10)
Fixes:
Fixed an issue where the last created message was lost in the
live collection
after fetching the collection again.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.30.0 (2024-08-30)
New Features:
Introduced the
includeDeleted
parameter forgetMembers
andsearchMembers
methods in theChannelRepository.membership
andCommunityRepository.membership
classes. By default,includeDeleted
is set totrue
.
Fixes:
Fixed an issue with error handling when fetching pinned posts.
Fixed an issue with optimistic updates for comments, posts, and reactions.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.29.2 (2024-08-16)
Fixes:
Fixed an issue where the current user's message remained visible in the live collection after deletion.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.29.1 (2024-07-24)
Fixes:
Fixed an issue where querying channels by partially matching on
displayName
was not functioning correctly.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.29.0 (2024-07-12)
New Features:
Added the capability to monitor SDK network activities - Logging.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.28.2 (2024-07-09)
Fixes:
Fixed the issue where posts were using the same cache despite having different parameters.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.28.0 (2024-07-08)
New Features:
Updated the
FileRepository
to support secure files.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.27.0 (2024-06-21)
New Features:
Introduced Ad analytics. For more information please visit Ads.
Fixes:
Fixed missing creator field from real-time events
getPost()
.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.26.2 (2024-06-11)
Fixes:
Fixed the issue where comments could not be queried.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.26.1 (2024-06-11)
Fixes:
Fixed the issue of undefined data showing after deleting a comment.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.26.0 (2024-06-07)
Fixes:
Fixed story upload issue on the
Android platform
(React Native).Fixed parameters for
registerPushNotification()
(React Native).
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.25.2 (2024-05-30)
Fixes:
Fixed incorrect display of usernames in the web chat room.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.25.1 (2024-05-24)
New Features:
Introduced Livestream Moderation.
Fixes:
Fixed the issue where the live collection for the reaction repository did not update in real-time.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.24.1 (2024-05-15)
New Features:
Implemented
CommunityRepository.searchCommunities
andCommunityRepository.Membership.searchMembers
Fixes:
Resolved an issue where the unread count did not update correctly when a user sent a message.
Corrected the incorrect children count after creating a comment.
Implemented real-time updates for comment counts.
Fixed the issue where a file name changed when uploading a file with a Thai name.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.23.0 (2024-04-26)
New Features:
Introduce a
markAsRead
method in the channel object to mark a channel as read.
Fixes:
Real-time updates for sub-channel unread counts are now implemented.
Corrected an issue where the current user would receive an unread count update when they sent a message.
Deprecate:
Deprecated the
markAsRead
API inChannelRepository
.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.22.0 (2024-04-12)
New Features:
Introduce
secureLogout()
function, enabling revoking of accessToken upon logout.
Fixes:
PostRepository.getPost() creator field is missing when added or removed reaction.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.19.0 (2024-03-06)
Fixes:
Fixed when a channel does not appear in the collection after sending a message if that channel is not currently included in the live collection.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.18.0 (2024-02-24)
New Features:
Implement consistent message unread count for channels & subchannels - for further information please visit - SDK v6.26.0 Unread Count Migration Guide.
New
enableUnreadCount()
method which enables unread count feature for messages -New
syncUnreadCount()
method inClient
- Unread Count.New
subChannelsUnreadCount
property inAmityChannel
New
startMessageReceiptSync()
&stopMessageReceiptSync()
methods inAmitySubChannelRepository
- Observe reading count.New
markRead()
method in AmityMessage - Mark Message as Read.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.17.1 (2024-02-01)
Fixes:
Fixed the issue where unread count doesn't get updated properly in channels.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.17.0 (2024-01-25)
Fixes:
Fixed the issue where removing a child post did not update in the parent post's live collection.
Fixed the issue where
messagePreviewId
becomes null when a user leaves a channel.Updated functionality to add new child comments to an existing parent comment.
Fixed the issue of
myReaction
missing from posts and comments.Improved functionality to search by
commentId
.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.16.0 (2024-01-16)
Fixes:
Fixed isJoined is disappeared after create and delete a post.
Fixed unreadCount is not updated after startReading on subChannel live collection.
Added missing isSeen and hasUnseen flag in Story .
Export social settings functions to the public.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.14.0 (2023-12-01)
New Features:
Enhanced message live collection performance and stablity.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.13.2 (2023-11-23)
Fixes:
Fixed the issue where next page of
getChannels
live collection couldn't be calledFixed the issue where next page of
getUsers
live collection couldn't be called
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.13.1 (2023-11-20)
Fixes:
Fixed the issue where next page of
getComments
live collection couldn't be called
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.13.0 (2023-11-17)
New Features
Added a new feature for SDK to collect and view data of post interaction. For more information, please visit Post Impression.
Fixes
Fixed the issue of isReportedByMe doesn't return a result.
Fixed no response from observe following follower.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.12.0 (2023-11-03)
New Features
Added new feature to preview latest message sent in channel or subchannel. For more information, please visit Message Preview.
Fixes
Fixed the issue of post filtering error.
Fixed the issue to mark channel as read to clear unreadCount.
Fixed the issue of community channel type.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.11.0 (2023-10-20)
Fixes
Fixed the issue where more than 5 comments could not be retrieved.
Fixed the issue of sub-channel pagination.
Fixed the issue where there was no response when flagging a comment.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.10.0 (2023-10-10)
Fixes
Fix various bugs in comments.
Fix channel not re-ordering when got a new message.
Compatibility:
NodeJS >= v12
NPM >= v6
Version 6.9.0 (2023-09-22)
Fixes
Fixed an issue where unread count doesn't get updated in real-time in certain situations.
Improved authentication performance.
Version 6.8.2 (2023-09-19)
Fixes
Fixed an issue in the
MessagesRepository.getMessages
function where the results were incorrectly sorted in certain situations.Fixed an issue in the
MessagesRepository.getMessages
function where results became mixed when using two message live collections simultaneously.Fixed the
CommentRepository.getComments
function, which was always including replied comments at the same level as parent comments.
Version 6.8.1 (2023-09-13)
Fixes
Fixed the issue where deviceId is not unique among SDK session.
Version 6.8.0 (2023-09-08)
New Features
Introduced
hasMentioned
field inAmity.Channel
.Introduced
hasMentioned
field inAmity.SubChannel
.Introduced
userUnread: Amity.UserUnread
property inAmity.Client
toget unreadCount
andhasMentioned
value.Enhanced the Comments API Response to return community users' roles.
Fixes
Fixed the missing 'Read' status on some messages in 1-1 chat.
Fixed the issue where onNextPage() cannot be called on multiple channel live collections.
Fixed the issue where subChannel was not re-ordered after receiving a new message.
Fixed the issue of calling multiple get channel marker requests after creating a new channel.
Fixed the issue where onNextPage() cannot be called on multiple message live collections.
Fixed notification message is empty when sent a messgage from TypeScript SDK.
Fixed the missing 'Read' status on some messages in 1-1 chat.
Prevented excessive unread sync requests in some situations.
Version 6.7.2 (2023-09-04)
Fixes
Fixed missing "read" status on some messages.
Fixed the issue where live collections were unable to call onNextPage on multiple collections.
Version 6.7.0 (2023-08-25)
Fixes
Fixed pagination for sub-channels.
Resolved a message order issue.
Fixed the issue with sub-channel sorting not updating after receiving a message.
Version 6.6.0 (2023-08-10)
Features
Updated the logic for
PostRepository.delete()
to guarantee the cache's permanent removal in the case of a hard delete. Also, limitedPostRepository.getPosts()
to exclude all deleted posts (both soft and hard deletes) not owned by the logged-in user, aligning with this#behavioral-change-announcement.
Fixes
Fixed the issue of missing parameter,
referenceVersion
, in reaction query.
Version 6.5.5 (2023-08-02)
Fixes
Fixed the issue where we could not see the users' reacted list with the message in the topic, and the backend returned '
MessageId
not found.' However, the reaction count showed the correct number of reactions.
Version 6.5.4 (2023-07-27)
Fixes
In version 6.5.2, we fixed a bug related to missing reactions in posts. Despite resolving this in most cases, some specific scenarios were still affected. With this release, we have addressed the remaining issues, ensuring that reactions will be displayed correctly in all situations.
Version 6.5.3 (2023-07-26)
Fixes
Fixed the issue with reactions where users are unable to see who reacted to the message.
Version 6.5.2 (2023-07-24)
Fixes
Fixed the issue where
myReactions
in the post were incorrect. When the user re-initializes a new collection,myReactions
are correct for the firstgetPosts(..)
call. However, they become incorrect again once another user likes the post.
Version 6.5.1 (2023-07-20)
Fixes
Fixed the issue where searching for communities by
displayName
was not working.Fixed the issue where searching for users by
displayName
returned mixed-up and incorrect data.
Version 6.4.6 (2023-07-14)
New Features
Stream Repository
Introduced
StreamRepository.getStream()
Live Object API.Introduced
StreamRepository.getStreams()
Live Collection API.
Community Repository
Introduced
CommunityRepository.getCommunity()
Live Object API.Introduced
CommunityRepository.getCommunities()
Live Collection API.Introduced
CommunityRepository.getTrendingCommunity()
Live Collection API.Introduced
CommunityRepository.getRecommendedCommunities()
Live Collection API.
Channel Repository
Introduced
ChannelRepository.Membership.getMembers()
Live Collection API.
Post Repository
Introduced
PostRepository.getPost()
Live Object API.Introduced
PostRepository.getPosts()
Live Collection API.
Poll Repository
Introduced
PollRepository.getPoll()
Live Object API.
Comment Repository
Introduced
CommentRepository.getComment()
Live Object API.Introduced
CommentRepository.getComments()
Live Collection API.
Fixes
Stream Repository
Made cache key unique per request params in getStreams.
Version 6.4.5 (2023-07-04)
Fixes
Fixed the issue where the unread count does not sync when two devices, both using the same account, are opened simultaneously.
Version 6.4.3 (2023-06-22)
Fixes
Resolved an issue, ensuring that the comment model accurately updates myReaction when adding or removing a reaction.
Resolved an issue, ensuring that the comment model accurately updates myReaction when adding a new reaction and re-querying the comment.
Version 6.4.2 (beta) (2023-06-21)
New Features
Introduce a new feature which now supports unread count on multiple devices. When the user logs in to two devices with the same account and uses the chat feature simultaneously, the user should see the correct update of the unread count.
Fixes
Fixed after subscribing to the real-time comment event, the reaction should reflect in Live Objects and Live Collections correctly, ensuring that it increases and decreases normally.
Version 6.4.0 (2023-06-16)
Fixes
Fixed an issue where the SDK shared the same message result on MessageRepository.getMessages, even with different page sizes.
Rectified inaccurate search results when searching for users and communities.
Version 6.3.2 (2023-06-13)
Fixes
Fix the issue where the latest messages or chat lists are not displayed in real-time. The page needs to be refreshed to see the updates.
Version 6.3.1 (2023-06-01)
Fixes
Fix post live collection does't trigger callback again on re-initialize.
Version 0.0.1 Beta.45 (2023-06-01)
Fixes
Fix post live collection does't trigger callback again on re-initialize.
Version 6.2.0 (2023-05-18)
New features
Introduce ban/unban community member.
Fixes
Fix user objects are not returned when searching with display name.
Fix post is not disappeared in real-time when performing hard delete.
Fix sometimes
ChannelRepository.Membership.getMembers
returns null.
Version 6.1.0 (2023-05-9)
New features
Introduce mute/unmute channel.
Fixes
Remove unused warnings (
runQuery
deprecations).Fix sometimes message and channel collections return empty.
Version 6.0.0-beta01 (2023-05-5)
New features
Introduce message delivered count.
Introduce mark all messages in a channel as read
For further information please visit Unread Count.
Version 6.0.0 (2023-04-27)
New features
Introduce blocking/unblocking user feature.
Breaking Changes
Refer to v6.0.0 Migration Guide for more details.
Version 0.0.1 Beta.43 (2023-04-11)
New Features
Introduce unread count in channels and subchannels.
Version 0.0.1 Beta.42.3 (2023-04-05)
Fixes
Fixed an issue where Live collections including
liveMessage
,liveChannels
,livePosts
, andliveComments
do not get updated immediately once the new item is created in to the collection.
Version 0.0.1 Beta.42.1 (2023-03-28)
New Features
introduced Live Object for
liveGetMyFollowInfo
method.liveGetFollowInfo
now returns more data, including the follow status between the target user and the SDK method caller. You can learn more about this update here.
Fixes
fixed the issue when calling
liveMessages
for the second time and return an empty result.
Version 0.0.1 Beta.41 (2023-03-23)
Fixes
Fixed an issue where creating a message was returning a parameters validation error
Fixed an issue where the authentication token wasn't able to be renewed when it's about to expire or has expired
Version 0.0.1 Beta.40 (2023-03-13)
New Features
Introduced Live Object for the Live Community Objects. With
liveCommunity
, any changes made to the community object are immediately reflected, without the need for the user to manually refresh or update the object.Introduced Live Community Members. Any real-time event data changes to a collection of community members will immediately be reflected in the collection without the need for users to query the server again for the latest data.
Version 0.0.1 Beta.39 (2023-02-24)
New Features
Enhanced liveUsers functionality to query users by query parameters such as
displayName
,lastCreated
andfirstCreated
.
Fixes
Fixed issue where a post was not being added to the review feed when a previously published post was updated.
Fixed issue where the member count was not automatically updated after joining a live channel.
Version 0.0.1 Beta.38 (2023-02-09)
New Features
Enhanced Live Collection with Post, Comments, Community and Community Category collection. Newly created Posts, Comments, Communities, and Community Categories are now automatically reflected in their respective collections, providing real-time updates.
Version 0.0.1 Beta.37 (2023-02-03)
New Features
Introduced Session State Management to describe the authentication status of the client device.
Fixes
Fixed issue where the device status was not changed to '
established
' after the token expired.Fixed issue where the user could not filter the channel by "member" and the removed channel was still shown in the collection after removal.
Fixed issue where the SDK did not subscribe to the global ban event.
Fixed issue where the user adds a new post but it is not linked to the user who created it.
Version 0.0.1 Beta.36 (2023-01-13)
New Features
Introduced Sub Channel functionality. Now users can create sub channels inside a channel.
Breaking Changes
Replaced
channelId
,data
parameters withsubChannelId
,dataType
forcreateMessage
,queryMessages
,liveMessages
before:
starting 0.0.1 Beta.36:
fileId
for file, image, video, audio messages is moved frommessage.fileId
tomessage.data.fileId
Before, messages were sent into the channel. Now, messages are sent into the sub channels of the channel. Each channel has at least one sub channel, the main one, where all old messages were migrated. To keep querying, creating messages in the same space use
channel.defaultSubChannelId
forsubChannelId
parameter forcreateMessage
,queryMessages
,liveMessages
before:
starting 0.0.1 Beta.36:
to receive real time updates for channel of type
broadcast
,live
, it's sub channels and messages (keepliveMessages
working) you need manually to subscribe for them
Version 0.0.1 Beta.35 (2022-12-16)
Fixes
SDK Upgrade
Version 0.0.1 Beta.34 (2022-12-02)
New Features
Introduced ability to query community users and receive "user object".
Introduced the ability to support startReading and stopReading functionalities in a channel.
Fixes
Fixed issue where unread messages did not show the correct number.
Version 0.0.1 Beta.33 (2022-11-18)
New Features
Upgraded the post review feature. When a moderator role is demoted to a user role, post creation must be approved by a moderator.
Version 0.0.1 Beta.32 (2022-11-04)
New Features
Introduced the ability for User roles to create community with “Admin can post only” settings.
Fixes
Fixed issue where the user could not remove reaction from the message.
Version 0.0.1 Beta.31 (2022-10-21)
New Features
Introduced the ability for the channel moderator to promote a user/member to moderator.
Introduced the ability for the channel moderator to demote a moderator to a user/member.
Introduced the ability to query poll type.
Introduced ability to query message by type.
Introduced ability to remove or add a new video in existing post.
Introduced ability to query
liveChannels
usingfilter
query parameters.Introduced
liveMessage
andliveUser
. Now users can monitor the status of a single message, post or user if they are subscribed.
Fixes
Fixed issue where querying the Live channel membership filter after muting was not possible.
Version 0.0.1 Beta.30 (2022-10-07)
New Features
Enhanced Live Collections for Channel Member collections. Any member added to or removed from a channel is automatically included in the query collection.
Introduced ability to create video messgaes in Live, Broadcast, Community and Chat channels.
When creating a poll post, the
closedIn
value is set to 30 days by default if the user does not set any value.
Version 0.0.1 Beta.29 (2022-09-23)
New Features
Introduced ability to manage community post settings via SDK (i.e. 'Only Admins Can Post' or 'Approve Member Posts')
Fixes:
Non-members with the User role can no longer be able to get information about the conversation channel.
Non-members with the User role can no longer query messages within the conversation channel.
Version 0.0.1 Beta.28 (2022-09-09)
New Features
Enhanced LiveCollections for Message collection, Followers/Following collection. Newly created messages and new followers are now automatically reflected in their respective collections.
Enhanced Video on Demand (VOD) configurations. Videos you upload with our SDK can now be transcoded to 4 different resolutions (from 360p to 1080p) with a maximum file size of 1 GB and a duration of up to 2 hours.
Version 0.0.1 Beta.27 (2022-08-26)
New Features
Enhanced LiveCollections for message reactions. Newly created reactions are now automatically added into the collection.
Introduced ability to ban/un-ban channel members. Admins can now ban/un-ban channel members.
Version 0.0.1 Beta.26 (2022-08-11)
New Features
Enhanced LiveCollections for comments collection. Newly added comments are now automatically added into the collection
Fixes
Fixed issue where two different
messageIds
were being returned when attempting to create a new message