@suprsend/web-sdk 3.0.0 → 3.0.2

package/README.md

@@ -1,17 +1,15 @@
 # SuprSend Javascript Web SDK
 
-This library is used to integrate SuprSend features like WebPush, Preferences in to your javascript client environments.
+This library is used to integrate SuprSend features like WebPush, Preferences and InApp feed in to your javascript client environments.
 
-> 📘 This is v2 version of @suprsend/web-sdk
+> 📘 Upgrading major version of SDK
 >
-> We have changed the web SDK authentication from workspace key-secret to public key and JWT based authentication. This is done to improve security in frontend applications.
->
-> - Refer the v1 SDK [documentation](https://docs.suprsend.com/v1.2.1/docs/javascript-sdk)
-> - For migrating to v2, follow this [guide](https://docs.suprsend.com/docs/js-migration-from-v1)
+> - Please refer [migration](https://docs.suprsend.com/docs/js-migration-from-v1) guide if you are migrating the major version of SDK.
 
 ## Documentation
 
-Checkout detailed [documentation](https://docs.suprsend.com/docs/javascript-sdk) for this library.
+- Checkout detailed [documentation](https://docs.suprsend.com/docs/javascript-sdk) for this library.
+- Refer type definitions for this library [here](https://github.com/suprsend/suprsend-web-sdk/blob/main/src/interface.ts).
 
 ## Installation
 
@@ -30,7 +28,7 @@ yarn add @suprsend/web-sdk@latest
 Create suprSendClient instance and use same instance to access all the methods of SuprSend library.
 
 ```typescript
-import SuprSend from '@suprsend/web-sdk';
+import {SuprSend} from '@suprsend/web-sdk';
 
 export const suprSendClient = new SuprSend(publicApiKey: string);
 ```
@@ -176,9 +174,115 @@ suprSendClient.emitter.on('preferences_updated', (preferenceDataResp) => void);
 suprSendClient.emitter.on('preferences_error', (errorResp) => void);
 ```
 
+## InApp Feed
+
+### Initialise feed client
+
+```typescript
+const feedClient: Feed = suprSendClient.feed.initialize(options?: IFeedOptions);
+
+interface IFeedOptions {
+  tenantId?: string;
+  pageSize?: number;
+  stores?: IStore[] | null;
+  host?: { socketHost?: string; apiHost?: string };
+}
+```
+
+### Feed Client
+
+#### Get Feed Data
+
+This returns notification store which contains list of notifications and other meta data like page information etc. You can call this anytime to get updated store data.
+
+```typescript
+const feedData: IFeedData = feedClient.data;
+```
+
+#### Initialize socket for realtime update
+
+```typescript
+feedClient.initializeSocketConnection();
+```
+
+#### Fetching notification data
+
+This method will get first page of notifications from SuprSend server and set data in notification store.
+
+```typescript
+feedClient.fetch();
+```
+
+#### Fetch more notifications
+
+This method will get next page of notifications from SuprSend server and set data in notification store.
+
+```typescript
+feedClient.fetchNextPage();
+```
+
+#### Listening for updates to store
+
+Whenever there is update in notification store (ex: on new notification or existing notification state updated) this event is fired by library. You can listen to this event and update your local state so that UI of you application is refreshed.
+
+```typescript
+feedClient.emitter.on('feed.store_update', (updatedStoreData: IFeedData) => {
+  // update your local state to refresh UI
+});
+```
+
+#### Listening for new notification
+
+In case you want to show toast notification on receiving new notification you can use this listener
+
+```typescript
+feedClient.emitter.on(
+  'feed.new_notification',
+  (notificationData: IRemoteNotification) => {
+    // your logic to trigger toast with new notification data
+  }
+);
+```
+
+#### Removing Feed
+
+This will remove feed client data and abort socket connection. Additionally calling `suprSendClient.reset` method during logout will also remove all feedClient instances attached SuprSend client instance.
+
+```typescript
+feedClient.remove();
+```
+
+#### Other methods
+
+```typescript
+// If stores are used, this method will change active store
+feedClient.changeActiveStore(storeId: string)
+
+// mark notification as seen
+await feedClient.markAsSeen(notificationId: string)
+
+// mark notification as read
+await feedClient.markAsRead(notificationId: string)
+
+// mark notification as unread
+await feedClient.markAsUnread(notificationId: string)
+
+// mark notification as archived
+await feedClient.markAsArchived(notificationId: string)
+
+// mark notification as interacted
+await feedClient.markAsInteracted(notificationId: string)
+
+// bulk mark all notifications as read
+await feedClient.markAllAsRead()
+
+// bulk mark given notification id's as seen
+await feedClient.markBulkAsSeen(notificationIds: string[])
+```
+
 ## Response Structure
 
-Almost all methods of this library return `Promise<ApiResponse>`
+Most of the methods in this library return `Promise<ApiResponse>`
 
 ```typescript
 interface ApiResponse {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suprsend/web-sdk",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "The client side javascript library for interacting with SuprSend",
   "author": "SuprSend Developers",
   "type": "module",