This page contains an overview of all relevant changes made to the JavaScript SDK and the latest version releases
Version 5.37.4 (2023-11-9)
Fixes
Improved LiveStreamPlayer 's stability and reliability when playing a recorded live-streaming videos.
Compatibility:
NodeJS >= v14.21.3
NPM >= v6.14.18
Version 5.37.3 (2023-10-06)
New Features
Introduced LiveStreamPlayer for enhanced livestream playback for an improved video-watching experience. For more information, please visit View & Play Live Stream.
Compatibility:
NodeJS >= v14.21.3
NPM >= v6.14.18
Version 5.37.2 (2023-9-21)
Fixes
Fixed the issue where AmityUser can't be flagged in certain situations.
Version 5.37.1 (2023-09-08)
Fixes
Fixed the issue where the watch minutes API in video live stream got denied by the backend.
Version 5.37.0 (2023-08-11)
New Features
Introduced LiveStreamPlayer.getPlayer(), a new API that provides a player for live stream video playback, along with watch time tracking capability.
Version 5.36.0 (2023-06-01)
Fixes
Fixed the following user collection pagination issue.
Version 5.35.0 (2023-03-13)
New Features
Introduced Session State functionality to describe the authentication status of the client device.
Add session v3 and sessionHandler into the option for createClient.
Fixes
Fixed issue where user access token cannot be renewed after the token is expired.
Version 5.34.0 (2023-02-09)
Fixes
Fixed issue where error message is not displayed when logging in with deleted user_id.
Version 5.33.0 (2023-01-13)
Fixes
SDK Upgrade
Version 5.32.0 (2022-12-16)
Fixes
Fixed issue where the Community pending screen is not getting updated when the post is declined.
Version 5.31.0 (2022-12-02)
New Features
Introduced the ability to query community users and receive "user object".
Fixes
Fixed issue where user cannot update comment.
Version 5.30.0 (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.
Fixes
Fixed issue where a user who has not joined a public community can see posts in the global feed.
Version 5.29.0 (2022-11-04)
New Features
Introduced the ability for User roles to create community with “Admin can post only” settings.
Fixes
Fixed issue where tags were not returned in the response when a community was created with tags.
Fixed issue where version 5.24.0 JS SDK does not work on Nextjs.
Version 5.28.0 (2022-10-21)
New Features
Introduced the ability to query poll type.
Introduced the ability for the channel moderator to demote a moderator to a user/member.
Introduced the ability for the channel moderator to promote a user/member to moderator.
Fixes
Fixed issue where a community with metadata could not be created.
Version 5.27.0 (2022-10-07)
New Features
When creating a poll post, the closedIn value is set to 30 days by default if the user does not set any value.
Add moderatorMemberCount to the channel model.
Fixes
Fixed issue where users occasionally cannot send messages in the channel.
Version 5.26.0 (2022-09-23)
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 5.25.0 (2022-09-09)
New Features
Community query is now case-insensitive! You no longer have to match the case sensitivity of the community’s display name when querying for a community
System now displays an error message while uploading HDR video format
Version 5.24.0 (2022-08-26)
New Features
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.
New method createVideo(file:File, feedType:ContentFeedType, onProgress:OnProgressCallback)is added in AmityFileRepository to specify the content type of the video.
Fixes
Fixed issue where user could not create image/file message
Fixed issue where user could not query a channel
Fixed issue where user could not view the text on content column in video/image post
Deprecation
Deprecated createVideo(file:File, onProgress:OnProgressCallback). Please use createVideo(file:File, feedType:ContentFeedType, onProgress:OnProgressCallback)instead.
Version 5.23.1 (2022-08-11)
Fixes
Fixed issue where user could not query on a deleted post
Fixed issue where user could not search community member using displayName
Fixed issue where SDK updates postSettings for community when user updates community but does not pass postSettings values
Version 5.23.0 (2022-07-29)
Fix
SDK Upgrade
Version 5.22.0 (2022-07-15)
Fixes
Fixed issue where error message is displayed while creating a reply to a comment
Introduced real-time event for channel deletion
Version 5.21.0 (2022-07-04)
New Feature
Introduced ability to manage community post settings via SDK (i.e. 'Only Admins Can Post' or 'Approve Member Posts')
Fixes
Fixed issue where the replies were not updated in the comment
Breaking Changes
Add new flag for postSetting to community to define minimum post requirements such as being an admin or requiring approval. This is applicable to post and create.
Change of parameter name from needApprovalOnPostCreation to postSetting
Previous Version:
New Version:
Version 5.20.0 (2022-06-17)
Fixes
Made channelId optional when creating new channels
Breaking Changes
ChannelId parameter in createChannel is now optional.
import { CommunityRepository } from '@amityco/js-sdk';
CommunityRepository.createCommunity({
displayName: string,
description?: string,
avatarFileId?: string,
categoryIds?: string[],
tags?: string[],
metadata?: Object,
isPublic?: boolean,
userIds?: string[],
postSetting?: string,
isOfficial?: boolean,
});
// Available value for postSettings
[
ONLY_ADMIN_CAN_POST,
ADMIN_REVIEW_POST_REQUIRED,
ANYONE_CAN_POST,
]
import { ChannelRepository } from '@amityco/js-sdk';
/**
* Previous version
* *** channelId is mandatory field ***
* *** type: ['standard', 'private', 'live', 'community', 'conversation', 'broadcast'] ***
*/
ChannelRepository.createChannel({ channelId, type, displayName, avatarFileId, userIds, tags, metadata })
import { ChannelRepository } from '@amityco/js-sdk';
/**
* New version
* *** channelId is now optional ***
* *** type: ['live', 'community', 'conversation', 'broadcast'] ***
*/
ChannelRepository.createChannel({ channelId?, type, displayName, avatarFileId, userIds, tags, metadata })
import { ChannelRepository } from '@amityco/js-sdk';
const result = await ChannelRepository.joinChannel({ channelId: string, type: string });
import { ChannelRepository } from '@amityco/js-sdk';
// “type” is no need anymore
const result = await ChannelRepository.joinChannel({ channelId: string });
import Client from '@amityco/js-sdk';
Client.create({ apiKey, apiEndpoint });
import Client from '@amityco/js-sdk';
Client.create({ apiKey, apiRegion })
// OR
Client.create({ apiKey, apiEndpoint, mqttEndpoint });
import { CommunityRepository } from '@amityco/js-sdk'
// Previous version [deprecated]
CommunityRepository.assignRoleToUsers({ communityId: string, userIds: string[] });
// New version
CommunityRepository.assignRoleToUsers({ communityId: string, roles: string[], userIds: string[] });
import { CommunityRepository } from '@amityco/js-sdk'
// Previous version [deprecated]
CommunityRepository.removeRoleToUsers({ communityId: string, userIds: string[] });
// New version
CommunityRepository.removeRoleToUsers({ communityId: string, roles: string[], userIds: string[] });
