@suprsend/web-sdk 4.1.2 → 4.2.0

package/dist/types/interface.d.ts

@@ -1,12 +1,32 @@
 export type Dictionary = Record<string, unknown>;
+export interface AppInfo {
+    name?: string;
+    version?: string;
+}
+export interface ClientUserAgentConfig {
+    sdk?: string;
+    sdk_version?: string;
+    lang?: string;
+    platform?: string;
+    environment?: string;
+    os?: string;
+    os_version?: string;
+    app_info?: AppInfo;
+    browser?: string;
+    browser_version?: string;
+    device_model?: string;
+}
 export interface SuprSendOptions {
     host?: string;
     vapidKey?: string;
     swFileName?: string;
+    appInfo?: AppInfo;
+    clientUserAgent?: ClientUserAgentConfig;
 }
 export type RefreshTokenCallback = (oldUserToken: string, tokenPayload: Dictionary) => Promise<string>;
 export interface AuthenticateOptions {
     refreshUserToken?: RefreshTokenCallback;
+    createUser?: boolean;
 }
 export interface ResponseOptions {
     status: RESPONSE_STATUS.ERROR | RESPONSE_STATUS.SUCCESS;

package/dist/types/main.d.ts

@@ -1,5 +1,5 @@
 import { Emitter } from 'mitt';
-import { SuprSendOptions, Dictionary, EmitterEvents, AuthenticateOptions } from './interface';
+import { SuprSendOptions, Dictionary, EmitterEvents, AuthenticateOptions, ApiResponse, ClientUserAgentConfig } from './interface';
 import { default as ApiClient } from './api';
 import { default as User } from './user';
 import { default as WebPush } from './webpush';
@@ -12,6 +12,8 @@ export default class SuprSend {
     userToken?: string;
     vapidKey: string;
     swFileName: string;
+    clientUserAgent: ClientUserAgentConfig;
+    userAgent: string;
     private apiClient;
     private userTokenExpirationTimer;
     authenticateOptions?: AuthenticateOptions;
@@ -22,12 +24,12 @@ export default class SuprSend {
     constructor(publicApiKey: string, options?: SuprSendOptions);
     private handleRefreshUserToken;
     client(): ApiClient;
-    eventApi(payload: Dictionary): Promise<import('./interface').ApiResponse>;
+    eventApi(payload: Dictionary): Promise<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>;
+    identify(distinctId: unknown, userToken?: string, options?: AuthenticateOptions): Promise<ApiResponse>;
     /**
      * Check's if SuprSend instance is authenticated. To check if userToken is also present pass true.
      */
@@ -35,11 +37,11 @@ export default class SuprSend {
     /**
      *  Used to trigger events to suprsend.
      */
-    track(event: string, properties?: Dictionary): Promise<import('./interface').ApiResponse>;
+    track(event: string, properties?: Dictionary): Promise<ApiResponse>;
     /**
      * Clears user related data attached to SuprSend instance. Usually called during logout.
      */
     reset(options?: {
         unsubscribePush?: boolean;
-    }): Promise<import('./interface').ApiResponse>;
+    }): Promise<ApiResponse>;
 }

package/dist/types/utils.d.ts

@@ -1,4 +1,4 @@
-import { ApiResponse, Dictionary, ResponseOptions } from './interface';
+import { ApiResponse, AppInfo, ClientUserAgentConfig, Dictionary, ResponseOptions } from './interface';
 
 export declare function uuid(): string;
 export declare function epochMs(): number;
@@ -9,7 +9,19 @@ export declare function debounce<T extends unknown[], U>(callback: (...args: T)
 export declare function debounceByType(func: any, wait: any): (...args: any[]) => any;
 export declare function getResponsePayload(options: ResponseOptions): ApiResponse;
 export declare function windowSupport(): boolean;
+export declare function localStorageSupport(): boolean;
 export declare function setLocalStorageData(key: string, value: string): void;
 export declare function getLocalStorageData(key: string): any;
 export declare function removeLocalStorageData(key: string): void;
+export declare function detectOS(ua?: string): {
+    os: string;
+    os_version: string;
+};
+export declare function detectBrowser(ua?: string): {
+    browser: string;
+    browser_version: string;
+};
+export declare function detectEnvironment(ua?: string): string;
+export declare function buildClientUserAgent(appInfo?: AppInfo, override?: ClientUserAgentConfig): ClientUserAgentConfig;
+export declare function buildUserAgent(config: ClientUserAgentConfig): string;
 export declare function sha256Hash(input: string): Promise<string>;

package/package.json

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