web-push-notifications 3.40.3 → 3.44.2

package/src/modules/ApiClient/ApiClient.types.ts

@@ -0,0 +1,222 @@
+import { type IInboxMessage } from '../../models/InboxMessages.types';
+
+type TMethodCheckDevice = 'checkDevice';
+type TMethodGetConfig = 'getConfig';
+type TMethodApplicationOpen = 'applicationOpen';
+type TMethodRegisterDevice = 'registerDevice';
+type TMethodUnregisterDevice = 'unregisterDevice';
+type TMethodDeleteDevice = 'deleteDevice';
+type TMethodMessageDeliveryEvent = 'messageDeliveryEvent';
+type TMethodPushStat = 'pushStat';
+type TMethodSetTags = 'setTags';
+type TMethodGetTags = 'getTags';
+type TMethodRegisterUser = 'registerUser';
+type TMethodRegisterEmail = 'registerEmail';
+type TMethodRegisterEmailUser = 'registerEmailUser';
+type TMethodSetEmailTags = 'setEmailTags';
+type TMethodPostEvent = 'postEvent';
+type TMethodGetInboxMessages = 'getInboxMessages';
+type TMethodInboxStatus = 'inboxStatus';
+type TMethodPageVisit = 'pageVisit';
+type TMethodSetPurchase = 'setPurchase';
+
+export interface IRequest {
+  application: string; // Pushwoosh application code.
+  hwid: string; // Unique string to identify the device.
+  userId: string; // The user ID to associate with event.
+  device_type: number; // 10 - safari, 11 - chrome, 12 - firefox.
+  device_model: string; // browser version.
+  timezone: number; // Timezone offset in seconds for the device.
+  language: string; // Language locale of the device. Must be a lowercase two-letter code according to ISO-639-1 standard.
+  v: string; // Web SDK version.
+}
+
+export interface IRequestEmail extends Omit<IRequest, 'hwid' | 'device_type'> {
+  email: string;
+}
+
+interface IRequestGetConfig extends IRequest {
+  features: string[]; // array of features names.
+}
+
+interface IRequestRegisterDevice extends IRequest {
+  push_token: string; // Push token for the device.
+  public_key?: string;
+  auth_token?: string;
+}
+
+interface IRequestRegisterUser extends IRequest {
+  ts_offset: number; // Timezone offset in seconds for the device. (aka timezone).
+}
+
+interface IRequestRegisterEmail extends IRequestEmail {
+  tags?: { [key: string]: any }; // email tags
+  ts_offset: number; // Timezone offset in seconds for the device. (aka timezone).
+}
+
+interface IRequestRegisterEmailUser extends IRequestEmail {
+  ts_offset: number; // Timezone offset in seconds for the device. (aka timezone).
+}
+
+interface IRequestSetEmailTags extends IRequestEmail {
+  tags: { [key: string]: any }; // email tags
+}
+
+interface IRequestPostEvent extends IRequest {
+  event: string; // Event name.
+  attributes?: { [key: string]: any };
+  timestampUTC?: number; // Timestamp in UTC.
+  timestampCurrent?: number; // Timestamp in local time.
+}
+
+interface IRequestMessageDeliveryEvent extends IRequest {
+  hash: string; // message hash,
+  metaData: { [key: string]: any }; // meta data
+}
+
+interface IRequestPushStat extends IRequest {
+  hash: string; // message hash
+  metaData: { [key: string]: any }; // meta data
+}
+
+interface IRequestSetTags extends IRequest {
+  tags: {
+    [key: string]: any;
+  };
+}
+
+interface IRequestGetInboxMessages extends IRequest {
+  userId: string; // use hwid or other custom string if no userId
+  last_code: string; // For pagination purpose. "next" parameter from response. For first request send empty string
+  count?: number; // optional, default messages count on page
+  last_request_time: number; // for update new messages counter. UTC
+}
+
+interface IRequestInboxStatus extends IRequest {
+  userId: string; // use hwid or other custom string if no userId
+  inbox_code: string; // order. Ugly logic for fast development.
+  time: number; // timestamp utc
+  status: number;
+  hash?: string; // ??
+  device_type: number; // platform type from Pushwoosh system
+}
+
+interface IRequestPageVisit extends IRequest {
+  title: string;
+  url_path: string;
+  url: string;
+}
+
+interface IRequestSetPurchase extends IRequest {
+  transactionDate: string;
+  quantity: number;
+  currency: string;
+  productIdentifier: string;
+  price: number;
+}
+
+type IResponse = void;
+
+interface IResponseCheckDevice {
+  exist: boolean; // exist device token
+  push_token_exist: boolean; // exist push token
+}
+
+interface IResponseGetConfig {
+  features: {
+    page_visit?: {
+      entrypoint: string;
+      enabled: boolean;
+    };
+    vapid_key?: string;
+    web_in_apps?: {
+      enabled: boolean;
+    };
+    events?: string[];
+    subscription_prompt?: {
+      useCase: 'not-set' | 'default' | 'not-used';
+    };
+  };
+}
+
+interface IResponseGetTags {
+  result: {
+    [key: string]: any;
+  };
+}
+
+interface IResponsePostEvent {
+  code?: string;
+}
+
+interface IResponseGetInboxMessages {
+  messages: Array<IInboxMessage>;
+  next: string; // pagination code
+  deleted: Array<string>; // array of notifications codes deleted from cp
+  new_inbox: number; // inbox messages created since last request time
+}
+
+export type TMethod =
+  | TMethodCheckDevice
+  | TMethodGetConfig
+  | TMethodApplicationOpen
+  | TMethodRegisterDevice
+  | TMethodUnregisterDevice
+  | TMethodDeleteDevice
+  | TMethodMessageDeliveryEvent
+  | TMethodPushStat
+  | TMethodSetTags
+  | TMethodGetTags
+  | TMethodRegisterUser
+  | TMethodRegisterEmail
+  | TMethodRegisterEmailUser
+  | TMethodSetEmailTags
+  | TMethodPostEvent
+  | TMethodGetInboxMessages
+  | TMethodInboxStatus
+  | TMethodPageVisit
+  | TMethodSetPurchase;
+
+export interface IMapRequest {
+  checkDevice: IRequest;
+  getConfig: IRequestGetConfig;
+  applicationOpen: IRequest;
+  registerDevice: IRequestRegisterDevice;
+  unregisterDevice: IRequest;
+  deleteDevice: IRequest;
+  messageDeliveryEvent: IRequestMessageDeliveryEvent;
+  pushStat: IRequestPushStat;
+  setTags: IRequestSetTags;
+  getTags: IRequest;
+  registerUser: IRequestRegisterUser;
+  registerEmail: IRequestRegisterEmail;
+  registerEmailUser: IRequestRegisterEmailUser;
+  setEmailTags: IRequestSetEmailTags;
+  postEvent: IRequestPostEvent;
+  getInboxMessages: IRequestGetInboxMessages;
+  inboxStatus: IRequestInboxStatus;
+  pageVisit: IRequestPageVisit;
+  setPurchase: IRequestSetPurchase;
+}
+
+export interface IMapResponse {
+  checkDevice: IResponseCheckDevice;
+  getConfig: IResponseGetConfig;
+  applicationOpen: IRequest;
+  registerDevice: IResponse;
+  unregisterDevice: IResponse;
+  deleteDevice: IResponse;
+  messageDeliveryEvent: IResponse;
+  pushStat: IResponse;
+  setTags: IResponse;
+  getTags: IResponseGetTags;
+  registerUser: IResponse;
+  registerEmail: IResponse;
+  registerEmailUser: IResponse;
+  setEmailTags: IResponse;
+  postEvent: IResponsePostEvent;
+  getInboxMessages: IResponseGetInboxMessages;
+  inboxStatus: IResponse;
+  pageVisit: IResponse;
+  setPurchase: IResponse;
+}

package/src/modules/Data/Data.ts

@@ -0,0 +1,345 @@
+import * as CONSTANTS from '../../core/constants';
+import { keyValue } from '../../core/storage';
+
+export class Data {
+  private readonly store: typeof keyValue;
+
+  constructor(store: typeof keyValue = keyValue) {
+    this.store = store;
+  }
+
+  public async clearAll(): Promise<void> {
+    await this.store.set('params.applicationCode', undefined);
+    await this.store.set('params.hwid', undefined);
+    await this.store.set('params.deviceType', undefined);
+    await this.store.set('params.deviceModel', undefined);
+    await this.store.set('params.language', undefined);
+    await this.store.set('params.apiEntrypoint', undefined);
+    await this.store.set('params.tokens', undefined);
+    await this.store.set('params.applicationServerKey', undefined);
+    await this.store.set('params.senderId', undefined);
+    await this.store.set('params.webSitePushId', undefined);
+    await this.store.set('params.defaultNotificationImage', undefined);
+    await this.store.set('params.defaultNotificationTitle', undefined);
+    await this.store.set('params.userId', undefined);
+    await this.store.set('params.email', undefined);
+    await this.store.set('params.userIdWasChanged', undefined);
+
+    await this.store.set('params.isLastPermissionStatus', undefined);
+    await this.store.set('params.isManualUnsubscribed', undefined);
+    await this.store.set('params.isCommunicationDisabled', undefined);
+    await this.store.set('params.isDropAllData', undefined);
+
+    await this.store.set('params.sdkVersion', undefined);
+    await this.store.set('params.serviceWorkerVersion', undefined);
+    await this.store.set('params.serviceWorkerUrl', undefined);
+    await this.store.set('params.serviceWorkerScope', undefined);
+
+    await this.store.set('params.lastOpenMessage', undefined);
+    await this.store.set('params.lastOpenApplicationTime', undefined);
+
+    await this.store.set('params.features', undefined);
+
+    await this.store.set('params.init', undefined);
+  }
+
+  public async setApplicationCode(application: string): Promise<void> {
+    await this.store.set('params.applicationCode', application);
+  }
+
+  public async getApplicationCode(): Promise<string> {
+    return await this.store.get('params.applicationCode');
+  }
+
+  public async setApiToken(token: string): Promise<string> {
+    return await this.store.set('params.apiToken', token);
+  }
+
+  public async getApiToken(): Promise<string> {
+    return await this.store.get('params.apiToken');
+  }
+
+  public async setHwid(hwid: string): Promise<void> {
+    await this.store.set('params.hwid', hwid);
+  }
+
+  public async getHwid(): Promise<string> {
+    return await this.store.get('params.hwid');
+  }
+
+  public async setDeviceType(type: number): Promise<void> {
+    await this.store.set('params.deviceType', type);
+  }
+
+  public async getDeviceType(): Promise<number> {
+    return await this.store.get('params.deviceType');
+  }
+
+  public async setDeviceModel(model: string): Promise<void> {
+    await this.store.set('params.deviceModel', model);
+  }
+
+  public async getDeviceModel(): Promise<string> {
+    return await this.store.get('params.deviceModel');
+  }
+
+  public async setLanguage(language: string): Promise<void> {
+    await this.store.set('params.language', language);
+  }
+
+  public async getLanguage(): Promise<string> {
+    return await this.store.get('params.language', 'en');
+  }
+
+  public async setApiEntrypoint(url: string): Promise<void> {
+    await this.store.set('params.apiEntrypoint', url);
+  }
+
+  public async getApiEntrypoint(): Promise<string> {
+    return await this.store.get('params.apiEntrypoint', CONSTANTS.DEFAULT_API_URL);
+  }
+
+  public async setTokens(tokens: any): Promise<void> {
+    await this.store.set('params.tokens', tokens);
+  }
+
+  public getTokens(): Promise<any> {
+    return this.store.get('params.tokens');
+  }
+
+  public async setApplicationServerKey(key: string): Promise<void> {
+    await this.store.set('params.applicationServerKey', key);
+  }
+
+  public async getApplicationServerKey(): Promise<string | undefined> {
+    return await this.store.get('params.applicationServerKey');
+  }
+
+  public async setIsVapidChanged(status: boolean): Promise<void> {
+    await this.store.set('params.isVapidChanged', status);
+  }
+
+  public async getIsVapidChanged(): Promise<boolean> {
+    return await this.store.get('params.isVapidChanged', false);
+  }
+
+  public async setWebSitePushId(senderId: string): Promise<void> {
+    await this.store.set('params.webSitePushId', senderId);
+  }
+
+  public async getWebSitePushId(): Promise<string> {
+    return await this.store.get('params.webSitePushId');
+  }
+
+  public async setDefaultNotificationImage(url?: string): Promise<void> {
+    await this.store.set('params.defaultNotificationImage', url);
+  }
+
+  public async getDefaultNotificationImage(): Promise<string> {
+    return await this.store.get('params.defaultNotificationImage', CONSTANTS.DEFAULT_NOTIFICATION_IMAGE);
+  }
+
+  public async setDefaultNotificationTitle(text?: string): Promise<void> {
+    await this.store.set('params.defaultNotificationTitle', text);
+  }
+
+  public async getDefaultNotificationTitle(): Promise<string> {
+    return await this.store.get('params.defaultNotificationTitle', CONSTANTS.DEFAULT_NOTIFICATION_TITLE);
+  }
+
+  public async setUserId(userId?: string | number): Promise<void> {
+    if (!userId) {
+      await this.store.set('params.userId', undefined);
+
+      return;
+    }
+
+    await this.store.set('params.userId', userId.toString());
+  }
+
+  public async getUserId(): Promise<string | undefined> {
+    return await this.store.get('params.userId');
+  }
+
+  public async setStatusUserIdWasChanged(status: boolean): Promise<void> {
+    await this.store.set('params.userIdWasChanged', status);
+  }
+
+  public async getStatusUserIdWasChanged(): Promise<boolean> {
+    return await this.store.get('params.userIdWasChanged', false);
+  }
+
+  public async setEmail(email?: string): Promise<void> {
+    if (!email) {
+      await this.store.set('params.email', undefined);
+
+      return;
+    }
+
+    await this.store.set('params.email', email.toString());
+  }
+
+  public async getEmail(): Promise<string | undefined> {
+    return await this.store.get('params.email');
+  }
+
+  public async setStatusEmailWasChanged(status: boolean): Promise<void> {
+    await this.store.set('params.emailWasChanged', status);
+  }
+
+  public async getStatusEmailWasChanged(): Promise<boolean> {
+    return await this.store.get('params.emailWasChanged', false);
+  }
+
+  public async setLastPermissionStatus(status: NotificationPermission): Promise<void> {
+    await this.store.set('params.isLastPermissionStatus', status);
+  }
+
+  public async getLastPermissionStatus(): Promise<NotificationPermission | undefined> {
+    return await this.store.get('params.isLastPermissionStatus');
+  }
+
+  public async setStatusManualUnsubscribed(status: boolean): Promise<void> {
+    await this.store.set('params.isManualUnsubscribed', status);
+  }
+
+  public getStatusManualUnsubscribed(): Promise<boolean> {
+    return this.store.get('params.isManualUnsubscribed', false);
+  }
+
+  public async setStatusCommunicationDisabled(status: boolean): Promise<void> {
+    await this.store.set('params.isCommunicationDisabled', status);
+  }
+
+  public getStatusCommunicationDisabled(): Promise<boolean> {
+    return this.store.get('params.isCommunicationDisabled', false);
+  }
+
+  public async setStatusDropAllData(status: boolean): Promise<void> {
+    await this.store.set('params.isDropAllData', status);
+  }
+
+  public getStatusDropAllData(): Promise<boolean> {
+    return this.store.get('params.isDropAllData', false);
+  }
+
+  public async setSdkVersion(version: string): Promise<void> {
+    await this.store.set('params.sdkVersion', version);
+  }
+
+  public async getSdkVersion(): Promise<string> {
+    return await this.store.get('params.sdkVersion');
+  }
+
+  public async setServiceWorkerVersion(version: string): Promise<void> {
+    await this.store.set('params.serviceWorkerVersion', version);
+  }
+
+  public getServiceWorkerVersion(): Promise<string> {
+    return this.store.get('params.serviceWorkerVersion');
+  }
+
+  public async setServiceWorkerUrl(url?: string | null): Promise<void> {
+    if (!url) {
+      return;
+    }
+
+    await this.store.set('params.serviceWorkerUrl', url);
+  }
+
+  public async getServiceWorkerUrl(): Promise<string> {
+    return await this.store.get('params.serviceWorkerUrl', CONSTANTS.DEFAULT_SERVICE_WORKER_URL);
+  }
+
+  public async setServiceWorkerScope(scope?: string): Promise<void> {
+    if (!scope) {
+      return;
+    }
+
+    await this.store.set('params.serviceWorkerScope', scope);
+  }
+
+  public async getServiceWorkerScope(): Promise<string> {
+    return await this.store.get('params.serviceWorkerScope');
+  }
+
+  public async setLastOpenMessage(message: any): Promise<void> {
+    await this.store.set('params.lastOpenMessage', message);
+  }
+
+  public getLastOpenMessage(): Promise<any> {
+    return this.store.get('params.lastOpenMessage');
+  }
+
+  public async setLastOpenApplicationTime(time: number): Promise<void> {
+    await this.store.set('params.lastOpenApplicationTime', time);
+  }
+
+  public async getLastOpenApplicationTime(): Promise<number> {
+    return await this.store.get('params.lastOpenApplicationTime');
+  }
+
+  public async setFeatures(features: any): Promise<void> {
+    await this.store.set('params.features', features);
+  }
+
+  public async getFeatures(): Promise<any> {
+    return await this.store.get('params.features');
+  }
+
+  public async setInitParams(params: any): Promise<any> {
+    await this.store.set('params.init', params);
+  }
+
+  public async getInitParams(): Promise<any> {
+    return await this.store.get('params.init');
+  }
+
+  public async setInboxLastRequestCode(lastCode: string): Promise<void> {
+    await this.store.set('params.inbox.lastRequestCode', lastCode);
+  }
+
+  public async getInboxLastRequestCode(): Promise<string> {
+    return await this.store.get('params.inbox.lastRequestCode', '');
+  }
+
+  public async setInboxLastRequestTime(lastRequestTime: number): Promise<void> {
+    await this.store.set('params.inbox.lastRequestTime', lastRequestTime);
+  }
+
+  public async getInboxLastRequestTime(): Promise<number> {
+    return this.store.get('params.inbox.lastRequestTime', 0);
+  }
+
+  public async setInboxNewMessagesCount(count: number): Promise<void> {
+    await this.store.set('params.inbox.newMessagesCount', count);
+  }
+
+  public async getInboxNewMessagesCount(): Promise<number> {
+    return this.store.get('params.inbox.newMessagesCount', 0);
+  }
+
+  public async setDelayedEvent(event: any): Promise<void> {
+    await this.store.set('params.delayedEvent', event);
+  }
+
+  public getDelayedEvent(): Promise<any> {
+    return this.store.get('params.delayedEvent');
+  }
+
+  public async setPromptDisplayCount(count: number): Promise<void> {
+    await this.store.set('params.promptDisplayCount', count);
+  }
+
+  public async getPromptDisplayCount(): Promise<number> {
+    return this.store.get('params.promptDisplayCount', 0);
+  }
+
+  public async setPromptLastSeenTime(time: number): Promise<void> {
+    await this.store.set('params.promptLastSeenTime', time);
+  }
+
+  public async getPromptLastSeenTime(): Promise<number> {
+    return this.store.get('params.promptLastSeenTime', 0);
+  }
+}

package/src/modules/DateModule.ts

@@ -0,0 +1,53 @@
+export default class DateModule {
+  private _date: Date;
+
+  constructor(date: Date = new Date()) {
+    this._date = date;
+  }
+
+  set date(date: Date) {
+    this._date = date;
+  }
+
+  get date() {
+    return this._date;
+  }
+
+  /**
+   * Timestamp in UTC without milliseconds
+   */
+  getUtcTimestamp() {
+    return Math.floor((this.date.getTime() + this.date.getTimezoneOffset() * 60 * 1000) / 1000);
+  }
+
+  /**
+   * Current date timestamp without milliseconds
+   */
+  getTimestamp() {
+    return Math.round(this.date.getTime() / 1000);
+  }
+
+  /**
+   * Set date to local timezone
+   */
+  setLocal() {
+    const newDateTimestamp = this._date.getTime() - this.date.getTimezoneOffset() * 60 * 1000;
+    this._date = new Date(newDateTimestamp);
+  }
+
+  /**
+   * Add days to current date
+   * @param days
+   */
+  addDays(days: number) {
+    const newDateTimestamp = this._date.getTime() + days * 24 * 60 * 60 * 1000;
+    this._date = new Date(newDateTimestamp);
+  }
+
+  /**
+   * Get inbox fake order
+   */
+  getInboxFakeOrder(): string {
+    return (this._date.getTime() * 100 + 25 * 60 * 60 * 1000 * 100).toString();
+  }
+}