@suprsend/web-sdk 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +11 -2
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,7 +2,12 @@
2
2
 
3
3
  This library is used to integrate SuprSend features like WebPush, Preferences in to your javascript client environments.
4
4
 
5
- > 📘 This is v2 version of @suprsend/web-sdk
5
+ > 📘 Migrating to v3 from v2
6
+ >
7
+ > - SuprSend class export has been changed from default export to named export.
8
+ > - Added support for feed.
9
+
10
+ > 📘 Migrating to v2 from v1
6
11
  >
7
12
  > 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.
8
13
  >
@@ -30,7 +35,7 @@ yarn add @suprsend/web-sdk@latest
30
35
  Create suprSendClient instance and use same instance to access all the methods of SuprSend library.
31
36
 
32
37
  ```typescript
33
- import SuprSend from '@suprsend/web-sdk';
38
+ import {SuprSend} from '@suprsend/web-sdk';
34
39
 
35
40
  export const suprSendClient = new SuprSend(publicApiKey: string);
36
41
  ```
@@ -176,6 +181,10 @@ suprSendClient.emitter.on('preferences_updated', (preferenceDataResp) => void);
176
181
  suprSendClient.emitter.on('preferences_error', (errorResp) => void);
177
182
  ```
178
183
 
184
+ ## InApp Feed
185
+
186
+ Documentation is yet to be added.
187
+
179
188
  ## Response Structure
180
189
 
181
190
  Almost all methods of this library return `Promise<ApiResponse>`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@suprsend/web-sdk",
3
- "version": "3.0.0",
3
+ "version": "3.0.1",
4
4
  "description": "The client side javascript library for interacting with SuprSend",
5
5
  "author": "SuprSend Developers",
6
6
  "type": "module",