stream-chat - npm Package Compare versions

Comparing version 0.7.7 to 0.8.0

changelog.md

@@ -0,1 +1,7 @@
+## 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
@@ -2,0 +8,0 @@

package.json

 {
   "name": "stream-chat",
-  "version": "0.7.7",
+  "version": "0.8.0",
   "description": "JS SDK for the Stream Chat API",
@@ -5,0 +5,0 @@ "author": "GetStream",

README.md

@@ -35,5 +35,4 @@ # Stream Chat JS
 
-### Contributing 
+### Contributing
 
 We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our [Contributor License Agreement (CLA)](https://docs.google.com/forms/d/e/1FAIpQLScFKsKkAJI7mhCr7K9rEIOpqIDThrWxuvxnwUq2XkHyG154vQ/viewform) first. See our license file for more details.
-

types/stream-chat/index.d.ts

@@ -19,2 +19,3 @@ // TypeScript Version: 2.2
   attachments?: Attachment[];
+  mentioned_users?: User[];
   [propName: string]: any;
@@ -54,3 +55,3 @@ }
 export class StreamChat {
-  constructor(key: string, secretOrOptions: string, options?: object);
+  constructor(key: string, secretOrOptions?: string, options?: object);
 
@@ -62,3 +63,3 @@ devToken(userID: string): string;
   setBaseURL(baseURL: string): void;
-  setUser(user: User, userToken: string): void;
+  setUser(user: User, userToken: string): Promise<void>;
 
@@ -69,7 +70,7 @@ updateAppSettings(options: object): Promise<object>;
 
-  setAnonymousUser(): void;
+  setAnonymousUser(): Promise<void>;
   setGuestUser(user: User): Promise<void>;
 
-  on(callbackOrString: string, callbackOrNothing: any): void;
-  off(callbackOrString: string, callbackOrNothing: any): void;
+  on(callbackOrString: string, callbackOrNothing?: any): void;
+  off(callbackOrString: string, callbackOrNothing?: any): void;
 
@@ -108,3 +109,3 @@ get(url: string, params: object): Promise<APIResponse>;
 
-  addDevice(device: Device): Promise<APIResponse>;
+  addDevice(id: string, push_provider: string, userID: string): Promise<APIResponse>;
   getDevices(userId: string): Promise<APIResponse>;
@@ -134,2 +135,4 @@ removeDevice(deviceId: string): Promise<APIResponse>;
   deleteMessage(messageID: string): Promise<APIResponse>;
+
+  verifyWebHook(requestBody: object, xSignature: string): boolean;
 }
@@ -189,3 +192,3 @@
   getReactions(message_id: string, options: object): Promise<APIResponse>;
-  countUnread(lastRead: Date): number;
+  countUnread(lastRead?: Date): number;
   create(): Promise<APIResponse>;
@@ -192,0 +195,0 @@ query(options: object): Promise<APIResponse>;

types/stream-chat/test-stream-chat.ts

@@ -17,4 +17,4 @@ import { StreamChat } from 'stream-chat';
 
-client.setUser({ id: 'john', phone: 2 }, devToken); // $ExpectType void
-client.setAnonymousUser(); // $ExpectType void
+client.setUser({ id: 'john', phone: 2 }, devToken); // $ExpectType Promise<void>
+client.setAnonymousUser(); // $ExpectType Promise<void>
 client.setGuestUser({ id: 'steven' }); // $ExpectType Promise<void>
@@ -42,4 +42,4 @@
 client.handleEvent(event); // $ExpectType void
-client.recoverState(); // $ExpectType void
+client.recoverState(); // $ExpectType Promise<void>
 
 const channel = client.channel('messaging', 'channelName', { color: 'green' }); // $ExpectType Channel

No alert changes

Improved metrics

Total package byte prevSize

1481699

increased by1.22%

Lines of code

17312

increased by1.78%

Worsened metrics

Number of lines in readme file

38

decreased by-2.56%

No dependency changes