web-push-notifications 3.40.3 → 3.44.2

package/src/helpers/unescape.ts

@@ -0,0 +1,36 @@
+/** Used to map HTML entities to characters. */
+const htmlUnescapes: { [key: string]: string } = {
+  '&': '&',
+  '&lt;': '<',
+  '&gt;': '>',
+  '&quot;': '"',
+  '&#39;': '\'',
+};
+
+/** Used to match HTML entities and HTML characters. */
+const reEscapedHtml = /&(?:amp|lt|gt|quot|#39);/g;
+const reHasEscapedHtml = RegExp(reEscapedHtml.source);
+
+/**
+ * The inverse of `escape`this method converts the HTML entities
+ * `&amp;`, `&lt;`, `&gt;`, `&quot;` and `&#39;` in `string` to
+ * their corresponding characters.
+ *
+ * **Note:** No other HTML entities are unescaped. To unescape additional
+ * HTML entities use a third-party library like [_he_](https://mths.be/he).
+ *
+ * @since 0.6.0
+ * @category String
+ * @param {string} [string=''] The string to unescape.
+ * @returns {string} Returns the unescaped string.
+ * @see escape, escapeRegExp
+ * @example
+ *
+ * unescape('fred, barney, &amp; pebbles')
+ * // => 'fred, barney, & pebbles'
+ */
+export function unescape(string: string) {
+  return (string && reHasEscapedHtml.test(string))
+    ? string.replace(reEscapedHtml, (entity) => htmlUnescapes[entity])
+    : string;
+}

package/src/models/InboxMessages.ts

@@ -0,0 +1,202 @@
+import {
+  type IGetInboxMessagesResponse, type IInboxMessage, type TInboxMessagesIDBStatusIndex,
+  type TInboxMessageStatusDelivered, type TInboxMessageStatusOpen,
+  type TInboxMessageStatusRead, type TReadInboxMessagesStatusRange,
+} from './InboxMessages.types';
+import { type EventBus } from '../core/modules/EventBus';
+import { type Api } from '../modules/Api/Api';
+import { type Data } from '../modules/Data/Data';
+import DateModule from '../modules/DateModule';
+import InboxMessagesPublic from '../modules/InboxMessagesPublic';
+import Storage from '../modules/storage/Storage';
+import { type TInboxMessagesStoreName } from '../modules/storage/Storage.types';
+
+export default class InboxMessages {
+  eventBus: EventBus;
+  data: Data;
+  api: Api;
+  storage: Storage;
+  storeName: TInboxMessagesStoreName;
+  dateModule: DateModule;
+
+  constructor(
+    eventBus: EventBus,
+    data: Data,
+    api: Api,
+    storage: Storage = new Storage(),
+    dateModule: DateModule = new DateModule(),
+  ) {
+    this.eventBus = eventBus;
+    this.data = data;
+    this.api = api;
+
+    this.storage = storage;
+    this.storeName = 'inboxMessages';
+    this.dateModule = dateModule;
+  }
+
+  /**
+   * Get inbox messages by api
+   */
+  private async getInboxMessages(): Promise<IGetInboxMessagesResponse> {
+    // get inbox messages
+    const response: IGetInboxMessagesResponse = await this.api.getInboxMessages();
+    await this.storeGetInboxMessagesRequestParams(response.next, response.new_inbox);
+
+    return response;
+  }
+
+  /**
+   * Store parameters for next getInboxMessages request
+   * @param next
+   * @param newMessagesCount
+   */
+  private async storeGetInboxMessagesRequestParams(next: string, newMessagesCount: number): Promise<void> {
+    this.dateModule.date = new Date();
+    await this.data.setInboxLastRequestTime(this.dateModule.getUtcTimestamp());
+
+    await this.data.setInboxLastRequestCode(next);
+    await this.data.setInboxNewMessagesCount(newMessagesCount);
+  }
+
+  /**
+   * Put loaded messages. Add delete status to loaded messages if this status set locally.
+   * @param messages
+   */
+  private async putServerMessages(messages: Array<IInboxMessage>): Promise<Array<string>> {
+    const putTransactions = messages.map(async (message: IInboxMessage) => {
+      const localMessage = await this.storage.get<IInboxMessage, object>(this.storeName, message.inbox_id, {});
+      if ('status' in localMessage) {
+        message.status = localMessage.status;
+      }
+      return this.putMessage(message);
+    });
+
+    return Promise.all(putTransactions);
+  }
+
+  /**
+   * Create or update inbox message
+   */
+  putMessage(message: IInboxMessage): Promise<string> {
+    return <Promise<string>> this.storage.put(this.storeName, message);
+  }
+
+  /**
+   * Create or update messages pack
+   * @param messages
+   */
+  putBulkMessages(messages: Array<IInboxMessage>): Promise<Array<string>> {
+    const putTransactions = messages.map((message) => this.putMessage(message));
+    return Promise.all(putTransactions);
+  }
+
+  /**
+   * Delete messages by codes
+   * @param codes
+   */
+  deleteMessages(codes: Array<string>): Promise<Array<void>> {
+    const deleteTransactions = codes.map((code) => this.storage.delete(this.storeName, code));
+    return Promise.all(deleteTransactions);
+  }
+
+  /**
+   * Delete expired by removal time messages
+   */
+  async deleteExpiredMessages(): Promise<Array<void>> {
+    this.dateModule.date = new Date();
+    const upperBound = this.dateModule.getTimestamp().toString();
+    const allMessages = await this.storage
+      .getAll<IInboxMessage>(this.storeName);
+    const codesToDelete = allMessages
+      .filter((msg: IInboxMessage) => msg.rt < upperBound)
+      .map((msg) => msg.inbox_id);
+    return this.deleteMessages(codesToDelete);
+  }
+
+  /**
+   * Get message by code
+   * @param code - inbox_id
+   */
+  getMessage(code: string): Promise<IInboxMessage> {
+    return this.storage.get<IInboxMessage, IInboxMessage>(this.storeName, code);
+  }
+
+  /**
+   * Get all read messages
+   */
+  async getReadOpenMessages(): Promise<Array<IInboxMessage>> {
+    const allMessages = await this.storage
+      .getAll<IInboxMessage>(this.storeName);
+    return allMessages
+      .filter((msg: IInboxMessage) => <TInboxMessageStatusRead>msg.status === 2 || <TInboxMessageStatusOpen>msg.status === 3);
+  }
+
+  /**
+   * Get all unread messages
+   */
+  async getDeliveredMessages(): Promise<Array<IInboxMessage>> {
+    const allMessages = await this.storage
+      .getAll<IInboxMessage>(this.storeName);
+    return allMessages
+      .filter((msg: IInboxMessage) => <TInboxMessageStatusDelivered>msg.status === 1);
+  }
+
+  /**
+   * All messages count
+   */
+  async messagesCount(): Promise<number> {
+    return this.storage.count(this.storeName);
+  }
+
+  /**
+   * Get count of messages with status "Delivered"
+   */
+  async getDeliveredMessagesCount(): Promise<number> {
+    const deliveredStatus: TInboxMessageStatusDelivered = 1;
+    const statusIndexName: TInboxMessagesIDBStatusIndex = 'status';
+    return this.storage
+      .countByIndex(this.storeName, statusIndexName, deliveredStatus);
+  }
+
+  /**
+   * Get count of messages with status "Read"
+   */
+  async getReadMessagesCount(): Promise<number> {
+    const readStatus: TInboxMessageStatusRead = 2;
+    const statusIndexName: TInboxMessagesIDBStatusIndex = 'status';
+    return this.storage
+      .countByIndex(this.storeName, statusIndexName, readStatus);
+  }
+
+  /**
+   * Get count of messages with status "Delivered" and "Read"
+   */
+  async getDeliveredReadMessagesCount(): Promise<number> {
+    const [readStatus, openStatus]: TReadInboxMessagesStatusRange = [2, 3];
+    const keyRange = IDBKeyRange.bound(readStatus, openStatus);
+    const statusIndexName: TInboxMessagesIDBStatusIndex = 'status';
+
+    return this.storage.countByIndex(this.storeName, statusIndexName, keyRange);
+  }
+
+  /**
+   * Load messages and sync with locally
+   */
+  async updateMessages(): Promise<void> {
+    const response = await this.getInboxMessages();
+    await this.deleteExpiredMessages();
+    if (response.deleted) {
+      await this.deleteMessages(response.deleted); // deleted from cp
+    }
+    await this.putServerMessages(response.messages);
+
+    this.eventBus.dispatchEvent('update-inbox-messages', {
+      messages: new InboxMessagesPublic(
+        this.data,
+        this.api,
+        this,
+      ),
+    });
+  }
+}

package/src/models/InboxMessages.types.ts

@@ -0,0 +1,111 @@
+// Action types
+export type TInboxActionLink = 1;
+export type TInboxActionRichMedia = 2;
+export type TInboxActionType = TInboxActionLink | TInboxActionRichMedia; // https://docs.pushwoosh.com/platform-docs/api-reference/message-inbox#getinboxmessages
+
+// Statuses
+export type TInboxMessageStatusDelivered = 1;
+export type TInboxMessageStatusRead = 2; // set on message in viewport
+export type TInboxMessageStatusOpen = 3; // set on message click
+export type TInboxMessageStatusDeleted = 4; // set on message delete or expiry removal time
+export type TInboxMessageStatus =
+  | TInboxMessageStatusDelivered
+  | TInboxMessageStatusRead
+  | TInboxMessageStatusOpen
+  | TInboxMessageStatusDeleted;
+export type TReadInboxMessagesStatusRange = [TInboxMessageStatusRead, TInboxMessageStatusOpen]; // all inbox read messages
+
+// Message
+export interface IInboxMessageActionParams {
+  l?: string | null;
+  rm?: string;
+  h?: string;
+  r?: string;
+}
+
+export interface IInboxMessage {
+  inbox_id: string; // inbox message id
+  order: string; // id for ordering in inbox
+  rt: string; // timestamp. Remove date. UTC
+  send_date: string; // timestamp. UTC
+  title: string;
+  image: string;
+  text: string;
+  action_type: TInboxActionType;
+  action_params: string; // json string with IInboxMessageActionParams
+  status: TInboxMessageStatus;
+}
+
+// Inbox API types
+export interface IGetInboxMessagesRequest {
+  application: string; // application code
+  userId: string; // use hwid or other custom string if no userId
+  hwid: string;
+  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
+}
+
+export interface IGetInboxMessagesResponse {
+  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 interface IInboxStatusRequest {
+  userId: string; // use hwid or other custom string if no userId
+  hwid: string; // hwid
+  application: string; // app code
+  inbox_code: string; // order. Ugly logic for fast development.
+  time: number; // timestamp utc
+  status: TInboxMessageStatus;
+  hash?: string; // ??
+  device_type: number; // platform type from Pushwoosh system
+}
+
+export type TGetInboxMessagesMethod = 'getInboxMessages';
+export type TInboxStatusMethod = 'inboxStatus';
+
+// IndexedDB keys/indexes
+export type TInboxMessagesIDBKeyPath = 'inbox_id';
+export type TInboxMessagesIDBStatusIndex = 'status';
+export type TInboxMessagesIDBRemovalTimeIndex = 'rt';
+
+// Public Interface
+
+export type TInboxMessageTypePlain = 0;
+export type TInboxMessageTypeRichmedia = 1;
+export type TInboxMessageTypeURL = 2;
+export type TInboxMessageTypeDeeplink = 3;
+export type TInboxMessageType = // depend from action_params
+  | TInboxMessageTypePlain
+  | TInboxMessageTypeRichmedia
+  | TInboxMessageTypeURL
+  | TInboxMessageTypeDeeplink;
+
+export type TInboxDefaultLink = '/';
+
+export interface IInboxMessagePublic {
+  code: string; // inbox_id
+  title: string; // title
+  message: string; // body
+  imageUrl: string; // image
+  sendDate: string; // send_date
+  type: TInboxMessageType; // depend from action_params
+  link: string | TInboxDefaultLink; // url or deeplink.
+  isRead: boolean; // true if status read or open
+  isActionPerformed: boolean; // true if status open
+}
+
+export interface IInboxMessages {
+  messagesWithNoActionPerformedCount(): Promise<number>; // opened messages count
+  unreadMessagesCount(): Promise<number>; // read messages count
+  messagesCount(): Promise<number>; // all messages count
+  loadMessages(): Promise<Array<IInboxMessagePublic>>; // all messages
+  readMessagesWithCodes(codes: Array<string>): Promise<void>; // set read status to messages by code
+  performActionForMessageWithCode(code: string): Promise<void>; // call message action. Set open status to messages
+  deleteMessagesWithCodes(codes: Array<string>): Promise<void>; // Set delete status to messages by code
+
+  publicMessageBuilder(message: IInboxMessage): Promise<IInboxMessagePublic>; // build public inbox message from base inbox message
+}

package/src/models/NotificationPayload.ts

@@ -0,0 +1,216 @@
+import { type IInboxMessage, type TInboxActionLink, type TInboxMessageStatusDelivered } from './InboxMessages.types';
+import {
+  type IChromeNotificationPayload,
+  type INotificationButton,
+  type INotificationOptionsPayload,
+  type INotificationPayload,
+  type INotificationPayloadInboxParams,
+  type IShowNotificationOptions,
+} from './NotificationPayload.types';
+import { parseSerializedNotificationParams } from '../core/functions';
+import { unescape } from '../helpers/unescape';
+import { Data } from '../modules/Data/Data';
+import DateModule from '../modules/DateModule';
+
+/**
+ * Build notification payload for different usage (show notification, use in sdk, inbox messages)
+ */
+export default class NotificationPayload {
+  payload: INotificationPayload;
+  data: Data;
+  code: string;
+  dateModule: DateModule;
+
+  constructor(
+    payload: INotificationPayload | IChromeNotificationPayload,
+    data: Data = new Data(),
+    dateModule: DateModule = new DateModule(),
+  ) {
+    // Set payload
+    if ('data' in payload) {
+      const chromePayload = <IChromeNotificationPayload>payload;
+      this.payload = chromePayload.data;
+    } else {
+      this.payload = <INotificationPayload>payload;
+    }
+
+    this.data = data;
+    this.code = `notificationCode-${Date.now()}-${Math.random().toString(16).slice(2, 10)}`;
+    this.dateModule = dateModule;
+  }
+
+  async getIcon(): Promise<string> {
+    return this.payload.i || await this.data.getDefaultNotificationImage();
+  }
+
+  async getTitle(): Promise<string> {
+    return this.payload.header || await this.data.getDefaultNotificationTitle();
+  }
+
+  get silent(): boolean {
+    return Boolean(this.payload.silent);
+  }
+
+  get body(): string {
+    return this.payload.body;
+  }
+
+  get messageHash(): string {
+    return this.payload.p || '';
+  }
+
+  get metaData(): { [key: string]: any } {
+    return this.payload.md
+      ? parseSerializedNotificationParams(this.payload.md)
+      : {};
+  }
+
+  get image(): string {
+    return this.payload.image || '';
+  }
+
+  get buttons(): Array<INotificationButton> {
+    return this.payload.buttons
+      ? parseSerializedNotificationParams(this.payload.buttons)
+      : [];
+  }
+
+  get customData(): { [key: string]: any } {
+    return this.payload.u
+      ? parseSerializedNotificationParams(this.payload.u)
+      : {};
+  }
+
+  get campaignCode(): string {
+    return this.payload.pwcid || '';
+  }
+
+  get link(): string {
+    return this.payload.l ? unescape(this.payload.l) : '/';
+  }
+
+  get inboxId(): string {
+    return this.payload.pw_inbox || '';
+  }
+
+  get inboxParams(): INotificationPayloadInboxParams {
+    // Parse inbox params
+    if (this.payload.inbox_params) {
+      return parseSerializedNotificationParams(this.payload.inbox_params);
+    }
+
+    return {};
+  }
+
+  get inboxRemovalTime(): string {
+    if (this.inboxParams && this.inboxParams.rt) {
+      return this.inboxParams.rt;
+    }
+
+    this.dateModule.date = new Date();
+    this.dateModule.addDays(1); // one day removal time
+    return this.dateModule.getUtcTimestamp().toString();
+  }
+
+  async getInboxImage(): Promise<string> {
+    if (this.inboxParams && this.inboxParams.image) {
+      return this.inboxParams.image;
+    }
+
+    return '';
+  }
+
+  get rootParams(): { [key: string]: any } {
+    const {
+      body: _body,
+      p: _p,
+      header: _header,
+      i: _i,
+      u: _u,
+      l: _l,
+      pwcid: _pwcid,
+      image: _image,
+      buttons: _buttons,
+      pw_inbox: _pw_inbox,
+      inbox_params: _inbox_params,
+      ...rootParams
+    } = this.payload;
+    return rootParams;
+  }
+
+  async getNotificationOptionsPayload(): Promise<INotificationOptionsPayload> {
+    const title = await this.getTitle();
+    const icon = await this.getIcon();
+
+    return {
+      ...this.rootParams,
+      body: this.body,
+      title,
+      icon,
+      image: this.image,
+      buttons: this.buttons,
+      customData: this.customData,
+      metaData: this.metaData,
+      campaignCode: this.campaignCode,
+      openUrl: this.link,
+      messageHash: this.messageHash,
+    };
+  }
+
+  async getShowNotificationOptions(): Promise<IShowNotificationOptions> {
+    const icon = await this.getIcon();
+
+    const buttons = this.buttons.map((button: INotificationButton, key: number) => {
+      button.action = `action-${key}`;
+      return button;
+    });
+
+    return {
+      renotify: true,
+      ...this.rootParams,
+      body: this.body,
+      icon,
+      tag: JSON.stringify({
+        url: this.link,
+        messageHash: this.messageHash,
+        customData: this.customData,
+        metaData: this.metaData,
+      }),
+      data: {
+        code: this.code,
+        buttons,
+        image: this.image,
+        campaignCode: this.campaignCode,
+        inboxId: this.inboxId,
+      },
+      silent: this.silent,
+      actions: buttons,
+      image: this.image,
+      buttons, // old notification api artifact
+    };
+  }
+
+  async getInboxMessage(): Promise<IInboxMessage> {
+    this.dateModule.date = new Date();
+    const sendDate = this.dateModule.getTimestamp().toString();
+    const title = this.payload.header || '';
+    const image = await this.getInboxImage();
+    const actionType: TInboxActionLink = 1;
+    const status: TInboxMessageStatusDelivered = 1;
+
+    return {
+      title,
+      image,
+      status,
+      order: this.dateModule.getInboxFakeOrder(),
+      inbox_id: this.inboxId,
+      send_date: sendDate,
+      rt: this.inboxRemovalTime,
+      text: this.body,
+      action_type: actionType,
+      action_params: JSON.stringify({
+        l: this.link,
+      }),
+    };
+  }
+}

package/src/models/NotificationPayload.types.ts

@@ -0,0 +1,65 @@
+export interface INotificationPayloadInboxParams {
+  image?: string; // custom icon for inbox message
+  rt?: string; // removal time. YYYY-MM-DD HH:mm
+}
+
+export interface INotificationPayload {
+  body: string; // message text
+  p?: string; // message hash. Not required for send message on concrete device.
+  silent?: string; // is it silent push notifications (no need to show it to user PUSH-19207)
+  header?: string; // message title
+  i?: string; // icon
+  u?: string; // custom data json string
+  md?: string; // meta data json string
+  l?: string; // deep link or URL
+  pwcid?: string; // campaign id
+  image?: string; // chrome big image
+  buttons?: string; // button json string. XMPP Chrome Sender payload contains buttons as string
+  pw_inbox?: string; // inbox code
+  inbox_params?: string; // inbox params json INotificationPayloadInboxParams
+  [key: string]: any; // root params
+}
+
+export interface IChromeNotificationPayload {
+  data: INotificationPayload;
+  from: string; // ??
+}
+
+export interface INotificationButton {
+  title: string;
+  action?: string;
+  url?: string;
+}
+
+export interface INotificationOptionsPayload {
+  body: string;
+  title: string;
+  icon: string;
+  image: string;
+  buttons: Array<INotificationButton>;
+  customData: { [key: string]: any };
+  metaData: { [key: string]: any };
+  campaignCode: string;
+  openUrl: string;
+  [key: string]: any;
+}
+
+export interface IShowNotificationOptionsData {
+  code: string; // message code
+  buttons: Array<INotificationButton>;
+  image: string;
+  campaignCode: string;
+  inboxId: string;
+}
+
+export interface IShowNotificationOptions {
+  body: string;
+  icon: string;
+  tag: string;
+  data: IShowNotificationOptionsData;
+  actions: Array<INotificationButton>;
+  image: string;
+  badge?: string; // android chrome badge icon,
+  silent?: boolean; // is it silent push notifications (no need to show it to user PUSH-19207)
+  [key: string]: any;
+}