@suprsend/web-sdk 2.0.0 → 3.0.0

package/dist/types/index.d.ts

@@ -1,45 +1,3 @@
-import { SuprSendOptions, Dictionary, EmitterEvents, AuthenticateOptions } from './interface';
-import { default as ApiClient } from './api';
-import { default as User } from './user';
-import { default as WebPush } from './webpush';
-import { Emitter } from 'mitt';
-
-export declare class SuprSend {
-    host: string;
-    publicApiKey: string;
-    distinctId: unknown;
-    userToken?: string;
-    vapidKey: string;
-    swFileName: string;
-    private apiClient;
-    private userTokenExpirationTimer;
-    authenticateOptions?: AuthenticateOptions;
-    readonly user: User;
-    readonly webpush: WebPush;
-    readonly emitter: Emitter<EmitterEvents>;
-    constructor(publicApiKey: string, options?: SuprSendOptions);
-    private handleRefreshUserToken;
-    client(): ApiClient;
-    eventApi(payload: Dictionary): Promise<import('./interface').ApiResponse>;
-    /**
-     *  Used to authenticate user. Usually called just after successful login and on reload of loggedin route to re-authenticate loggedin user.
-     *  In production env's userToken is mandatory for security purposes.
-     */
-    identify(distinctId: unknown, userToken?: string, options?: AuthenticateOptions): Promise<import('./interface').ApiResponse>;
-    /**
-     * Check's if SuprSend instance is authenticated. To check if userToken is also present pass true.
-     */
-    isIdentified(checkUserToken?: boolean): boolean;
-    /**
-     *  Used to trigger events to suprsend.
-     */
-    track(event: string, properties?: Dictionary): Promise<import('./interface').ApiResponse>;
-    /**
-     * Clears user related data attached to SuprSend instance. Usually called during logout.
-     */
-    reset(options?: {
-        unsubscribePush?: boolean;
-    }): Promise<import('./interface').ApiResponse>;
-}
-export default SuprSend;
+export { default as SuprSend } from './main';
+export { Feed } from './feed';
 export * from './interface';

package/dist/types/interface.d.ts

@@ -6,7 +6,7 @@ export interface SuprSendOptions {
 }
 export type RefreshTokenCallback = (oldUserToken: string, tokenPayload: Dictionary) => Promise<string>;
 export interface AuthenticateOptions {
-    refreshUserToken: RefreshTokenCallback;
+    refreshUserToken?: RefreshTokenCallback;
 }
 export interface ResponseOptions {
     status: RESPONSE_STATUS.ERROR | RESPONSE_STATUS.SUCCESS;
@@ -66,9 +66,14 @@ export type EmitterEvents = {
     preferences_updated: PreferenceApiResponse;
     preferences_error: ApiResponse;
 };
+export type InboxEmitterEvents = {
+    'feed.new_notification': IRemoteNotification;
+    'feed.store_update': IFeedData;
+    '*': undefined;
+};
 export interface HandleRequest {
     type: 'get' | 'post' | 'patch';
-    path: string;
+    url: string;
     payload?: Dictionary;
 }
 export interface ValidatedDataOptions {
@@ -80,10 +85,96 @@ export declare enum ERROR_TYPE {
     NETWORK_ERROR = "NETWORK_ERROR",
     UNKNOWN_ERROR = "UNKNOWN_ERROR",
     PERMISSION_DENIED = "PERMISSION_DENIED",
-    UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION"
+    UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION",
+    NOT_FOUND = "NOT_FOUND"
 }
 export declare enum RESPONSE_STATUS {
     SUCCESS = "success",
     ERROR = "error"
 }
+export interface IStore {
+    storeId: string;
+    label: string;
+    query?: {
+        tags?: string | string[];
+        categories?: string | string[];
+        read?: boolean;
+        archived?: boolean;
+    };
+}
+export declare enum ApiResponseStatus {
+    INITIAL = "INITIAL",//  Before any request is made (or after a reset).
+    LOADING = "LOADING",// The initial API call is in progress
+    SUCCESS = "SUCCESS",// The API call was successful, and data has been received
+    ERROR = "ERROR",// The API call failed (network issue, server issue, etc.)
+    FETCHING_MORE = "FETCHING_MORE"
+}
+export interface IActionObject {
+    name: string;
+    url: string;
+    open_in_new_tab?: boolean;
+}
+export interface IAvatarObject {
+    action_url?: string;
+    avatar_url: string;
+}
+export interface ISubTextObject {
+    action_url?: string;
+    text: string;
+}
+export interface IRemoteNotificationMessage {
+    header?: string;
+    schema: string;
+    text: string;
+    url?: string;
+    open_in_new_tab?: boolean;
+    extra_data?: string;
+    actions?: IActionObject[];
+    avatar?: IAvatarObject;
+    subtext?: ISubTextObject;
+}
+export interface IRemoteNotification {
+    n_id: string;
+    n_category: string;
+    created_on: number;
+    seen_on?: number;
+    read_on?: number | null;
+    interacted_on?: number;
+    archived?: boolean;
+    tags?: string[];
+    expiry?: number;
+    is_expiry_visible: boolean;
+    is_pinned: boolean;
+    can_user_unpin?: boolean;
+    message: IRemoteNotificationMessage;
+}
+export interface IFeedOptions {
+    tenantId?: string;
+    pageSize?: number;
+    stores?: IStore[] | null;
+    host?: {
+        socketHost?: string;
+        apiHost?: string;
+    };
+}
+export interface INotificationStore {
+    notifications: IRemoteNotification[];
+    store: IStore;
+    pageInfo: {
+        total: number;
+        currentPage: number;
+        totalPages: number;
+        pageSize: number;
+    };
+    meta: Record<string, number>;
+    apiStatus: ApiResponseStatus;
+    _firstFetchedTimeStamp: number | null;
+}
+export interface IFeedData extends Omit<INotificationStore, '_firstFetchedTimeStamp'> {
+}
+export interface IInboxFetchOptions {
+    page?: number;
+    pageSize?: number;
+    storeId?: IStore;
+}
 export {};

package/dist/types/main.d.ts

@@ -0,0 +1,45 @@
+import { Emitter } from 'mitt';
+import { SuprSendOptions, Dictionary, EmitterEvents, AuthenticateOptions } from './interface';
+import { default as ApiClient } from './api';
+import { default as User } from './user';
+import { default as WebPush } from './webpush';
+import { default as FeedsFactory } from './feed';
+
+export default class SuprSend {
+    host: string;
+    publicApiKey: string;
+    distinctId: unknown;
+    userToken?: string;
+    vapidKey: string;
+    swFileName: string;
+    private apiClient;
+    private userTokenExpirationTimer;
+    authenticateOptions?: AuthenticateOptions;
+    readonly user: User;
+    readonly webpush: WebPush;
+    readonly feeds: FeedsFactory;
+    readonly emitter: Emitter<EmitterEvents>;
+    constructor(publicApiKey: string, options?: SuprSendOptions);
+    private handleRefreshUserToken;
+    client(): ApiClient;
+    eventApi(payload: Dictionary): Promise<import('./interface').ApiResponse>;
+    /**
+     *  Used to authenticate user. Usually called just after successful login and on reload of loggedin route to re-authenticate loggedin user.
+     *  In production env's userToken is mandatory for security purposes.
+     */
+    identify(distinctId: unknown, userToken?: string, options?: AuthenticateOptions): Promise<import('./interface').ApiResponse>;
+    /**
+     * Check's if SuprSend instance is authenticated. To check if userToken is also present pass true.
+     */
+    isIdentified(checkUserToken?: boolean): boolean;
+    /**
+     *  Used to trigger events to suprsend.
+     */
+    track(event: string, properties?: Dictionary): Promise<import('./interface').ApiResponse>;
+    /**
+     * Clears user related data attached to SuprSend instance. Usually called during logout.
+     */
+    reset(options?: {
+        unsubscribePush?: boolean;
+    }): Promise<import('./interface').ApiResponse>;
+}

package/dist/types/preferences.d.ts

@@ -1,4 +1,4 @@
-import { SuprSend } from './index';
+import { default as SuprSend } from './main';
 import { Dictionary, PreferenceData, PreferenceOptions, ChannelLevelPreferenceOptions } from './interface';
 
 export default class Preferences {
@@ -12,7 +12,7 @@ export default class Preferences {
     private validateQueryParams;
     set data(value: PreferenceData);
     get data(): PreferenceData;
-    getUrlPath(path: string, qp?: Dictionary): string;
+    getUrl(path: string, qp?: Dictionary): string;
     /**
      * Used to get user's whole preferences data.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suprsend/web-sdk",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "The client side javascript library for interacting with SuprSend",
   "author": "SuprSend Developers",
   "type": "module",
@@ -53,6 +53,8 @@
   },
   "dependencies": {
     "jwt-decode": "3.1.2",
-    "mitt": "^3.0.1"
+    "mitt": "^3.0.1",
+    "socket.io-client": "^4.8.1",
+    "zustand": "^5.0.1"
   }
 }