Skip to content

CHANGELOG.md

Latest commit

 

History

History
799 lines (481 loc) · 35.8 KB

CHANGELOG.md

File metadata and controls

799 lines (481 loc) · 35.8 KB

CHANGELOG

July 29, 2021 - 3.13.1

  • Allowing listeners for channel.deleted and notification.channel_deleted before disconnecting the channel from client cc8796e
  • Fixing issue with presence indicator not updating feff028

July 28, 2021 - 3.13.0

Issue fixes

  • Clear channel from client.activeChannels when its deleted on backend #728
  • Remove deleted properties from user objects on client when user-update related events are received #727
  • Remove reference to quoted message, when message gets deleted #726 Please note that channel can't be used once its deleted. You will need to re-create the channel using client.channel(channelType, channelId) call

Features/updates

  • Added following enpoints to client:

    • createSegment
    • getSegment
    • listSegments
    • updateSegment
    • deleteSegment
    • createCampaign
    • getCampaign
    • listCampaigns
    • updateCampaign
    • deleteCampaign
    • scheduleCampaign
    • stopCampaign
    • resumeCampaign
    • testCampaign

  • Removed target user id from payload on client.sendUserCustomEvent function 8bfcca3

  • Added grant field types to AppSettings 991b8118

July 15, 2021 - 3.12.1

Issue fixes

  • Fixed an issue with event (message.updated, message.deleted etc) based updates to message list, which can cause messages to go out of sync than desired state. Please read the PR description for more details - #713

July 13, 2021 - 3.12.0

Features/updates

  • Updates to client.search() and channel.search() endpoint #677

    • supports sorting results
    • returns next and previous parameters to get the next/previous page of results
    • supports pagination using the next parameter

  • Added new channel.assignRoles method for assigning custom roles to the channel members (#692)

  • Updated Permissions API methods (#707, #715)

  • Switched pinMessage and unpinMessage to partial update (#712)

Issue fixes

  • 704 Added missing team property to Event typescript type. #716

June 8, 2021 - 3.11.0

  • Fixed timer throttling issue, which was introduced with recent release of Chrome browser #698
  • Fixed issues with unread count on muted channels #678

May 21, 2021 - 3.10.0

Feature

  • client.partialUpdateMessage() to partially update messages #576
  • client.queryMessageFlags() to query flagged messages #676
  • client.createToken add support to have iat claim while generating tokens #674
  • client.revokeTokens() method to revoke/unrevoke tokens on an application level #674
  • client.revokeUserToken() method to revoke/unrevoke tokens on user level #674
  • client.revokenUsersToken() method to revoke/unrevoke tokens for multiple users at once #674

May 3, 2021 - 3.9.0

Feature

  • New endpoint to send custom user events #664
  • Support Node v16 #671

March 29, 2021 - 3.8.0

  • Better handling of user.deleted and user.updated events 6eddf39
    • When user.deleted event is received, mark messages from corresponding user as deleted.
    • When user.updated event is received, update references of corresponding user in messages.
  • Bug with with ChannelState.clean function 28581fd
  • Allow overriding of https agent on StreamChat f18e397 
      const client = StreamChat.getInstance(apiKey, {
    httpsAgent: new https.Agent({
      keepAlive: true,
      keepAliveMsecs: 6000,
    });
  })
  • Updated following types
    • AppSettingsAPIResponse.enforce_unique_usernames 497220c
    • MessageLabel 7897e23

March 19, 2021 - 3.7.0

  • Receive unsubscribe handler from channel.on 1ae1fca
const eventHandler = (e) => {
  /** handle event here */
};
const { unsubscribe } = channel.on(eventHandler);

// When you want to remove listener:
unsubscribe();

March 17, 2021 - 3.6.2

  • Added extra check in client.updateMessage to make sure we don't send mentions_users as array of user objects. If yes, then convert it to array of userIds (which is what API expects) #647

March 16, 2021 - 3.6.1

  • message.__html type is deprecated in favor of message.html #646
  • message.__html is ignored updateMessage function #645

March 15, 2021 - 3.6.0

  • Add support to set baseURL from options #644
    • StreamChat.getInstance('key', { baseURL })

March 11, 2021 - 3.5.1

Remove call to channel._disconnect from client.closeConnection. For end user this will fix the issue - You can't use a channel after client.disconnect() was called #639

March 10, 2021 - 3.5.0

  • Deprecated client.disconnect. A new method has been introduced as alias - client.disconnectUser

  • Introduced following two methods on client:

    • client.openConnection - establish a ws connection on current client.
    • client.closeConnection - close the ws connection on current client, doesn't remove user

  • Moved call to setHealth(true), (which marks the connection as healthy) to only after you receive first event on websocket. Please check the description of PR #626 for details.

March 9, 2021 - 3.4.0

QueryMembers - Added support for pagination by user_id 0c41232

March 9, 2021 - 3.3.0

Feature

  • Added the Client.getRateLimits function to retrieve rate limit quotas and usage, with the option to filter per platform and endpoint #631
  • Support reactions sync for pinned messages in channel state #629

March 8, 2021 - 3.2.0

Feature

  • Added the Client.queryBannedUsers function to query banned users with optional filters #625

March 5, 2021 - 3.1.4

Fix

  • Clear (set to false) isUpToDate flag, when channel watcher is disconnected #624

March 2, 2021 - 3.1.3

Chore

  • Change stream client header from x-stream-client to X-Stream-Client #622

February 26, 2021 - 3.1.2

Fix

  • Fixed regression introduced in 3.1.0 causing ChannelState.messages not to update on incoming reaction events #621

February 23, 2021 - 3.1.1

Fix

  • Channel state message list mutation #619

February 17, 2021 - 3.1.0

Feature

  • sendMessage accepts a skip_push flag to skip sending push notifications #608

Fix

  • Sync own_reactions in the events #606
  • Missing user_id in channel instantion by members #610

February 11, 2021 - 3.0.1

  • Add back some deprecated functions for convenience #615

February 10, 2021 - 3.0.0

BREAKING CHANGES

  • Removed seamless-immutable library completely for client/channel state management in favor of pure JS objects #602. This will likely require some changes to frontend usage of these states with spread operators for deeply nested data updates

  • Changed channel state messageToImmutable function to formatMessage #602

  • channel.sendReaction(messageID: string, reaction: Reaction, user_id?: string, enforce_unique?: boolean) is changed to channel.sendReaction(messageID: string, reaction: Reaction, options?: { enforce_unique?: boolean }). the removed user_id parameter should be added to reaction.

  • client.setUser() function is removed in favor of client.connectUser() #612

  • client.setAnonymousUser() function is removed in favor of client.connectAnonymousUser() #612

  • client.updateUser() function is removed in favor of client.upsertUser() #612

  • client.updateUsers() function is removed in favor of client.upsertUsers() #612

  • client._userAgent() function is removed in favor of client.getUserAgent() #612

Fix

  • Added types for auto translations #602
  • Added missing options for gdpr endpoints #609

Chore

  • Upgrade Dependencies #613

January 28, 2021 - 2.12.0

Feature

  • New StreamClient.getInstance function to be use instead of new StreamClient() #599
  • Types for file and image upload app configuration #582

Fix

  • Allow consecutive calls with warning to client.connectUser for the same user #600

January 21, 2021 - 2.11.5

Fix

  • Skip sorting channel members while instantiating a channel without id #591

January 20, 2021 - 2.11.4

  • Ensure uniqe channel per cid on client's activeChannel state #586

January 18, 2021 - 2.11.3

  • Added types for query by date parameters - b249e0b
  • Added missing type definitions around channel config - 9c3067f

January 11, 2021 - 2.11.2

  • Add thread_participants to MessageResponse and correct pinned types 8e357a8

January 4, 2021 - 2.11.1

  • Updated/fixed types on event object regarding unread counts. 36e2297

December 31, 2020 - 2.11.0

  • Added support for quoted messages #561
  • Added support for enforce_unique param on send reaction api. When true, previous reaction (if any) from user will be replaced with new reaction. 27ddd4f
  • Added event handler for event reaction.updated 27ddd4f
  • Added new flag on channel state isUpToDate (please check description for details) 588c0e9
  • Fixed types for client.user d855779

December 21, 2020 - 2.10.0

Feature

  • New channel.updatePartial() function can be used to set and unset specific fields when it is necessary to retain additional custom data fields on Channel #550
  • client.testPushSettings() accepts skipDevices boolean attribute which skip config/device checks and sending to real devices #548
  • channel.sendReaction() accepts enforce_unique attribute to overwrite existing reactions if any #527

Fix

  • deprecate setUser and setAnonymousUser in favor of connectUser and connectAnonymousUser #529

  • Update channel read state when a new message is sent #536

  • Removed unused user_details field from query_channels #545

  • MessageResponse type #551

  • AppSettings type #541

December 7, 2020 - 2.9.0

  • Adding recoverStateOnReconnect option - #534
  • Adding UpdatedMessage typescript type

November 27, 2020 - 2.8.4

Fix

  • Reset unreadCount when channel gets truncated #521

November 25, 2020 - 2.8.3

Fix

  • add custom_event to channel types #520

November 25, 2020 - 2.8.2

Fix

  • Replace uuid with simple random generator #518

November 20, 2020 - 2.8.1

Fix

  • Duplicate message from current user #509
  • Sort direction array for queries #501
  • Add enforce_unique_usernames to AppSettingsAPIResponse type #511

November 17, 2020 - 2.8.0

Feature

  • Channel Export #504
  • New event notification.invite_rejected #467
  • Channel stopTyping accepts optional parent_id for typing in threads notification.invite_rejected #505

Fix

  • Mute users no longer counted in channel unread #498
  • AppSettingsAPIResponse type includes image_moderation_enabled #497
  • User ban function signature updated #502: client.banUser('user1', {user_id: 'user2'}) is replaced with client.banUser('user1', {banned_by_id: 'user2'})

November 06, 2020 - 2.7.4

Feature

  • Ban user by ip #485

November 03, 2020 - 2.7.3

Fix

  • Browser file upload incorrect file name #487

October 30, 2020 - 2.7.2

Fix

  • Improve types of sendMessage(), updateMessage(), ChannelFilters and AppSettingsAPIResponse #480 #483

October 26, 2020 - 2.7.1

Feature

  • New functions to shadow ban a user from one or all channels #447
// global shadow ban on all channels
client.shadowBan(target_user_id);
client.removeShadowBan(target_user_id);

// channel speceifc shadow ban
channel.shadowBan(target_user_id);
channel.removeShadowBan(target_user_id);

Fix

  • Ignore shadowed messages in the unread count #475
  • Remove duplicated _initializeState call #473

Chore

  • Upgrade dependencies #477

October 20, 2020 - 2.7.0

Fix

  • channel.addMessageSorted performance has been improved. It now accepts an extra parameter timestampChanged: boolean which needs to be set for updating a message in the state with the same id and different created_at #470

October 12, 2020 - 2.6.0

Feature

  • Typing events for thread #445 #445
  • Hard deleted messages are removed from channel.state.messages #454
  • Simplify and document flag/unflag functions for server side usage #462

Fix

  • BlockList types #455
  • Channel.countUnread() returns correct unread #452
  • type key-value pair added to image uploads to fix React Native Android image upload failures #464

October 1, 2020 - 2.5.0

Feature

  • Add permission for using frozen channels UseFrozenChannel #444
  • SendFile accepts buffer and other types of streams #448

Fix

  • Discard reservered fields from channel.update() #439
  • Custom Command handler in AppSettingsAPIResponse renamed to custom_action_handler_url from custom_command_url #409
  • Regenerate yarn.lock file #449
  • SendFile properly check for File instances #448

September 17, 2020 - 2.4.0

Feature

  • BlockLists #437. Refer to docs on how to use this new feature docs

Fix

  • Channel.keystroke not firing for the first typing event #440

September 17, 2020 - 2.3.1

  • Added backward compatible types and move type definitions for production out of dev dependencies #432

September 16, 2020 - 2.3.0

  • Changed ordering of Typescript generics from usage preference based to alphabetical for consistency throughout the project #425

September 10, 2020 - 2.2.2

  • Fixing possible race condition between warmUp options request and first queryChannels call. 372b22c

September 10, 2020 - 2.2.1

  • Fixing typescript for filters param in queryChannels endpoint 5e840ba

September 10, 2020 - 2.2.0

  • Add warmUp option for StreamChat constructor, to improve the network latency on api calls 74a9121

September 7, 2020 - 2.1.3

  • Move @types dependencies to devDependencies #418

September 4, 2020 - 2.1.2

  • Fix connection recovery of client #414
  • Removed unused recovery option from queryChannels api payload #414

August 31, 2020 - 2.1.1

  • Typescript related fixes 4e538e6
    • Add null checks for tests and correct types to reflect null returns on reactions
    • Change updateMessage to use Message instead of MessageResponse

August 27, 2020 - 2.1.0

  • Added endpoints to enable and disable slow mode 06fe1b2

    • enableSlowMode
    • disableSlowMode

  • Added endpoints for custom commands f79baa3

    • createCommand
    • getCommand
    • updateCommand
    • deleteCommand
    • listCommand

  • Typescript related fixes 5f2ae83

    • added generic type CommandType
    • Fixing backward compatibility related issues

August 26, 2020 - 2.0.0

  • Library has been migrated to full typescript.
  • No breaking changes regarding underlying javascript api.
  • The Event type no longer takes a string generic that maps to the type property of the response. Event now takes multiple high level generics instantiated along with the client and the property type on the response is on of the string union EventTypes.

August 11, 2020 - 1.14.1

  • Add support for channel.visible event 991c87b
  • Added setter for userAgent 5d87550

July 24, 2020 - 1.14.0

  • Added timeout for muteUser client method 6f44677

July 16, 2020 - 1.13.2

  • Removing cross-fetch from rollup externals c7dafb0

July 16, 2020 - 1.13.1

  • Changing ws issue logs to warn level 1836606

July 8, 2020 - 1.13.0

  • Add size comparison action #361
  • Drop cross-fetch and use Axios for uploads, use local instance of Axios #365
  • Drop support for node v11, v13 #372

June 24, 2020 - 1.12.1

  • Fixing typescript for channel.getCommands 52e562a

June 23, 2020 - 1.12.0

  • Adding sync endpoint for offline support eb4793f
  • Fixing typescript for translateMessage endpoint c9aea32

June 16, 2020 - 1.11.4

  • Fixing request retry logic upon token expiry ab20729

June 12, 2020 - 1.11.3

  • Fixing types for setUser function on client 36d04ec
  • Added translateMessage function/endpoint to client c5e1462

June 8, 2020 - 1.11.2

  • Improved channel.config types in typescript file 5524675
  • Added support for user.deleted event b3c328a

May 29, 2020 - 1.11.1

  • Fixing issue with connection recovery and queryChannels api call #340

May 28, 2020 - 1.11.0

  • Introducing queryMembers endpoint #321

May 28, 2020 - 1.10.3

May 19, 2020 - 1.10.2

May 15, 2020 - 1.10.1

  • Reverting uuid version change from 1.10.0 due to incompatibility with react-native issue

May 15, 2020 - 1.10.0

  • Token refresh functionality #327
  • Bump uuid version to 8.0.0 d1957d9
  • Updated typescript for multitenant feature 6160aa6
  • Updated flag function signatures to allow server side flagging/unflagging 05c2281
  • Disabled presence by default for queryUsers endpoint 26616f5

May 13, 2020 - 1.9.0

  • Multi-tenant feature
  • Ws Disconnect improvements - forcefully assume closed after 1 sec
  • Silent message feature

April 29, 2020 - 1.8.0

April 20, 2020 - 1.7.4

  • Fixed types for verifyWebhook function

April 15, 2020 - 1.7.3

  • Adding missing event types in typescript file - 8ed49dd

April 9, 2020 - 1.7.2

  • Fixing typescript for StreamChat, Channel and ChannelState classes 2c78981

April 7, 2020 - 1.7.1

  • Fixing typescript for getConfig function in Channel class 5bf2d7e

April 3, 2020 - 1.7.0

April 7, 2020 - 1.7.1

  • Add types for channel.getConfig()

April 2, 2020 - 1.6.2

  • Adding (missing) following permission constants in typescript file 5b08dec

    • Allow
    • Deny
    • AnyResource
    • AnyRole
    • MaxPriority
    • MinPriority

  • Moving following dependencies from devDependencies to dependencies to avoid ts errors regarding missing types 5b08dec

    • @types/seamless-immutable
    • @types/ws

March 27, 2020 - 1.6.1

  • Reverting c5413c0

    Commit description: Avoid duplication of reaction, by adding check for existing reaction

    Reason:

    1. latest_reactions only contain 10 reactions. So the added check is not sufficient.
    2. It will need handle remove reactions as well.
    3. own_reactions doesn't contain user object always. So that use case will need handling as well.

March 27, 2020 - 1.6.0

  • Deprecating updateUser and updateUsers api from StreamChat client.
  • Introducing alias for updateUser and updateUsers api
    • updateUser --> upsertUser
    • updateUsers --> upsertUsers
  • Fixing typescript for StreamChat constructor 583b528
  • Fixing typescript for event subscribers a0c2ef0
  • Added typescript for getMessage and getMessagesById endpoint a0c2ef0
  • Avoid duplication of reaction, by adding check for existing reaction c5413c0

March 20, 2020 - 1.5.1

  • Fixing removeMessage function in ChannelState to handle thread message - e67a432
  • Fixing typescript file for channel mutes - c7fefa8

March 19, 2020 - 1.5.0

  • Support for channel mutes

March 10, 2020 - 1.4.0

  • Support filtering by messages custom fields - #264

March 3, 2020 - 1.3.4

  • Increment wsID when ws connection is disconnected manually, to ensure any of the callbacks (onclose, onerror etc) are obsolete - 792de5b

February 17, 2020 - 1.3.3

  • Fixing broken browser bundle - fixes #259
  • Allowing .off (event listener removal) on uninitialized channels - 985155f

February 10, 2020 - 1.3.2

  • Fixing client.disconnect and connection.disconnect to always return promise - 600da6c
  • Fixing type definitions for Reaction object - 08c802e
  • Fixing type definitions for channel method on client - f2d99b8

February 5, 2020 - 1.3.1

  • Adding some more logs for ws connection callback handlers such as onclose, onmessage, onerror - b54fa53

January 25, 2020 - 1.3.0

  • Added tests for channels operator $in with custom fields - 1896d98
  • Fixed types (in typescript declaration file) for sendReaction function in channel - e0aa1fa
  • Fixed types (in typescript declaration file) for sendFile and sendImage functions - 346048f
  • Added getMessagesById endpoint for channel - cdc2a8e

January 14, 2020 - 1.2.3

  • Updated devtoken methode (for compatibility with RN). Switching to base64-js - 96c338e
  • Fixed types (in typescript declaration file) for setUser function of client - 6139e4e
  • Fixed and updated types for partialUpdateUser function - 201257d

December 16, 2019 - 1.2.2

  • Handling channel.hidden event

December 3, 2019 - 1.2.1

  • Handling channel.truncated event
  • Support for system message for addMember/removeMember functionality
  • Throw clear errors when trying to build tokens without secret

November 28, 2019 - 1.2.0

November 22, 2019 - 1.1.8

  • Improve client.channel signature, support short-hand with only type and object as well as null or undefined ID (instead of only "")

October 25, 2019 - 1.1.7

  • Add support for member invites after channel creation.

October 15, 2019 - 1.1.6

  • Fixing types for client and connection in typescript declaration file.

October 10, 2019 - 1.1.5

  • Fix for issue #133 - Updating user object in client, when user.updated is received corresponding to user of client
  • Adding types for ChannelData object
  • Fixing tests

October 07, 2019 - 1.1.4

October 07, 2019 - 1.1.3

  • File upload issue fix - Allowing File object as valid uri in sendFile function in client.

September 30, 2019 - 1.1.2

  • Moving @types to devDependencies

September 27, 2019 - 1.1.1

  • Syncing and improving the typescript declaration file

September 23, 2019 - 1.1.0

  • Added channel.hide and channel.show

September 12, 2019 - 1.0.5

  • Improving event handling in js client. Earlier, event listeners on client were executed before channel could handle the event and update the state. This has been fixed by handling event completely on client and channel level first before executing any of the listeners on client or channel.

July 31, 2019 - 1.0.4

  • Added error logs for errors in API calls

July 23, 2019 - 1.0.3

  • Support $exists operator for queryChannels/queryUsers

July 22, 2019 - 1.0.2

  • Support hard delete messages for server side auth

July 19, 2019 - 1.0.1

July 18 2019 - 1.0.0

  • This library is stable and used in production already, bump to 1.0.0

July 18 2019 - 0.13.8

  • Avoid memory leaks server-side when client is created many times

July 11 2019 - 0.13.7

  • Track client version with WS
  • Add configurable logging
  • Bugfix: reconnection and threads' replies are now handled correctly
  • Bugfix: replies pagination now works with both ASC and DESC ordering

June 27 2019 - 0.13.6

  • Improve reconnection mechanism

June 20th 2019 - 0.13.5

  • Added populated channel.data when calling channel.watch()

April 29th 2019 - 0.12.0

  • Improved channel.unreadCount

April 28th 2019 - 0.10.1

  • Improved user presence support. If listening to user presence, channel.state.members and channel.state.watchers are now automatically updated with the user's online/offline presence.

April 27th 2019 - 0.10.0

  • add channel.countUnreadMentions
  • improve client.disconnect
  • add userID param to add reactions server-side

April 24th 2019 - 0.9.1

  • add babel runtime to dependencies

April 24th 2019 - 0.9.0

  • GDPR endpoints: deleteUser, exportUser and deactivateUser

April 24th 2019 - 0.8.0

  • markRead now supports sending a message_id to mark the channel read up to (and including) that specific message
  • added markAllRead client method
  • countUnread can be called without any parameters now client-side and it will default to current user's read state

April 9th 2019 - 0.7.2

  • queryChannels used to return the list of members twice, this has now been resolved. However if you were using the duplicate list of members in channel.members you'll want to update to Object.values(channel.state.members)

April 2nd 2019 - 0.5.0

  • event.own_user renamed to event.me
  • user.status.changed renamed to user.presence.changed
  • connectResponse.unread renamed to connectResponse.unread_count
  • channelState.online renamed to channelState.watcher_count