centrifuge 4.0.0 → 4.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Centrifugal
+Copyright (c) 2023 Centrifugal Labs LTD
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -305,6 +305,10 @@ centrifuge.presenceStats("channel").then(function(resp) {
 
 Returns a Promise which will be resolved upon connection establishement (i.e. when Client goes to `connected` state).
 
+#### setToken method
+
+`setToken` may be useful to dynamically change the connection token. For example when you need to implement login/logout workflow. See an example in [blog post](https://centrifugal.dev/blog/2023/06/29/centrifugo-v5-released#token-behaviour-adjustments-in-sdks).
+
 #### error event
 
 To listen asynchronous error happening internally while Centrifuge client works you can set an `error` handler:
@@ -333,7 +337,7 @@ In case of Centrifugo on a server side this may be a JSON Web Token - see [authe
 
 **Connection token must come to the frontend from application backend - i.e. must be generated on the backend side**. The way to deliver token to the application frontend is up to the developer. Usually you can pass it in template rendering context or issue a separate call to request a connection token from the backend.
 
-If the token sets connection expiration then the client SDK will keep the token refreshed. It does this by calling a special callback function. This callback must return a new token. If a new token with updated connection expiration is returned from callback then it's sent to Centrifugo. If your callback returns an empty string – this means the user has no permission to connect to Centrifugo and the Client will move to a disconnected state. In case of error returned by your callback SDK will retry the operation after some jittered time.
+If the token sets connection expiration then the client SDK will keep the token refreshed. It does this by calling a special callback function. This callback must return a new token. If a new token with updated connection expiration is returned from callback then it's sent to Centrifugo. In case of error returned by your callback SDK will retry the operation after some jittered time. You can throw a special error (`throw new Centrifuge.UnauthorizedError();`) from `getToken` function to move the client into disconnected state (for example, when there is no permission to connect anymore).
 
 An example of possible `getToken` function implementation:
 

package/build/types.d.ts

@@ -148,7 +148,7 @@ export interface PublicationContext {
     data: any;
     info?: ClientInfo;
     offset?: number;
-    tags?: Map<string, string>;
+    tags?: Record<string, string>;
 }
 export interface ClientInfo {
     client: string;
@@ -209,7 +209,7 @@ export interface ServerPublicationContext {
     data: any;
     info?: ClientInfo;
     offset?: number;
-    tags?: Map<string, string>;
+    tags?: Record<string, string>;
 }
 export interface ServerJoinContext {
     channel: string;
@@ -244,7 +244,7 @@ export interface RpcResult {
     data: any;
 }
 export interface PresenceResult {
-    clients: Map<string, ClientInfo>;
+    clients: Record<string, ClientInfo>;
 }
 export interface PresenceStatsResult {
     numClients: number;