Merge pull request #42 from FleekHQ/feature/ch17482/notification-subs…

…cribe

ch17482/notificationSubscribe added to client

README.md

@@ -529,6 +529,18 @@ Get the current public key generated by the daemon.
   };
 ```
 
+#### .notificationSubscribe()
+Returns a ReadableStream that notifies about new notifications.
+Notifications are triggered upon another member's interaction with a shared file or bucket, for example if he attempts to add a new file to a shared bucket.
+
+```js
+  const notificationStream = client.notificationSubscribe();
+
+  notificationStream.on('data', (res) => {
+    const notification = res.getNotification();
+    console.log(notification);
+  });
+```
 
 ## Example
 You can check the example included in the `example` folder.

example/client.js

@@ -5,6 +5,12 @@ const client = new SpaceClient({
 });
 
 
+const notificationStream = client.notificationSubscribe();
+
+notificationStream.on('data', (res) => {
+  console.log(`new notification: ${res.getNotification()}`);
+});
+
 const txlStream = client.txlSubscribe();
 
 txlStream.on('data', (res) => {

src/__tests__/client-calls.ts

@@ -27,6 +27,7 @@ client.instance = {
   shareBucket: jest.fn(),
   joinBucket: jest.fn(),
   shareItemsToSelectGroup: jest.fn(),
+  notificationSubscribe: jest.fn(),
 };
 
 it('listDirectory makes the right requests', async () => {
@@ -211,3 +212,9 @@ it('should call shareItemsToSelectGroup', async () => {
 
   expect(client.instance.shareItemsToSelectGroup).toHaveBeenCalledTimes(1);
 });
+
+it('notificationSubscribe makes the right requests', async () => {
+  client.notificationSubscribe({});
+
+  expect(client.instance.notificationSubscribe).toHaveBeenCalledTimes(1);
+});

src/client.ts

@@ -47,6 +47,7 @@ import {
   ThreadInfo,
   GetPublicKeyRequest,
   GetPublicKeyResponse,
+  NotificationEventResponse,
 } from './definitions/space_pb';
 
 export interface SpaceClientOpts {
@@ -453,6 +454,14 @@ class SpaceClient {
       );
     });
   }
+
+  notificationSubscribe(
+    metadata: grpcWeb.Metadata = {},
+  ): grpcWeb.ClientReadableStream<NotificationEventResponse> {
+    const request = new Empty();
+
+    return this.instance.notificationSubscribe(request, metadata);
+  }
 }
 
 export default SpaceClient;