web-push-notifications 3.44.6 → 3.44.8

package/src/core/Pushwoosh.types.ts

@@ -1,254 +0,0 @@
-import { type INotificationButton } from '../models/NotificationPayload.types';
-import { type ISubscribePopupConfig } from '../widgets/SubscribePopup/types/subscribe-popup';
-
-export type PushwooshApiResponse = {
-  status_code: number;
-  status_message: string;
-  response?: any;
-};
-
-export type TPWPermission = 'denied' | 'granted' | 'default';
-
-export interface IPWDriverAPIParams {
-  hwid: string;
-  pushToken?: string;
-  publicKey?: string;
-  authToken?: string;
-}
-
-export interface TPWAPIParams extends IPWDriverAPIParams {
-  applicationCode: string;
-  pushwooshApiUrl?: string;
-  deviceType: number;
-  deviceModel: string;
-  language: string;
-  userId?: string;
-}
-
-export interface TPWLastOpenMessage {
-  messageHash?: string;
-  expiry: number;
-  url?: string;
-}
-
-export interface PushManager {
-  permissionState(options: PushSubscriptionOptions): Promise<TPWPermission>;
-}
-
-export interface PushSubscription {
-  unsubscribe(): Promise<boolean>;
-  subscriptionId: string;
-}
-
-export interface IPWDriver {
-  initWorker?(): Promise<any>;
-  getPermission(): Promise<TPWPermission>;
-  isSubscribed(): Promise<boolean>;
-  askSubscribe(eventEmitter?: any): Promise<any>;
-  unsubscribe(): Promise<any>;
-  getAPIParams(): Promise<IPWDriverAPIParams>;
-  onApiReady?(api: any): void;
-  isNeedUnsubscribe?(): Promise<boolean>;
-}
-
-export interface ITooltipText {
-  successSubscribe?: string;
-  needSubscribe?: string;
-  blockSubscribe?: string;
-  alreadySubscribed?: string;
-}
-
-export interface ISubscribeWidget {
-  enable: boolean;
-  position?: string;
-  bgColor?: string;
-  bellColor?: string;
-  shadow?: string;
-  size?: string;
-  indent?: string;
-  zIndex?: string;
-  tooltipText?: ITooltipText;
-  buttonImage?: string;
-  contentImages?: Record<string, string>;
-}
-
-export type IWidgetPosition = 'left' | 'right' | 'top' | 'bottom';
-
-export interface IInboxWidget {
-  enable: boolean;
-  triggerId?: string;
-  position?: IWidgetPosition;
-  appendTo?: string;
-  title?: string;
-  bgColor?: string;
-  textColor?: string;
-  fontFamily?: string;
-  borderRadius?: number;
-  borderColor?: string;
-  badgeBgColor?: string;
-  badgeTextColor?: string;
-  widgetWidth?: number;
-  zIndex?: number;
-  messageTitleColor?: string;
-  timeTextColor?: string;
-  emptyInboxTitle?: string;
-  emptyInboxText?: string;
-  emptyInboxIconUrl?: string;
-  emptyInboxTitleColor?: string;
-  emptyInboxTextColor?: string;
-}
-
-export interface IInitParams {
-  applicationCode: string;
-  apiToken?: string;
-  serviceWorkerUrl?: string | null;
-  safariWebsitePushID?: string;
-  autoSubscribe?: boolean;
-  pushwooshUrl?: string;
-  pushwooshApiUrl?: string;
-  defaultNotificationImage?: string;
-  defaultNotificationTitle?: string;
-  logLevel?: string;
-  userId?: string;
-  email?: string;
-  scope?: string;
-  tags?: { [key: string]: any };
-  driversSettings?: {
-    worker?: {
-      serviceWorkerUrl?: string;
-      applicationServerPublicKey?: string;
-    };
-  };
-  subscribeWidget?: ISubscribeWidget;
-  inboxWidget?: IInboxWidget;
-  subscribePopup?: ISubscribePopupConfig;
-}
-
-export interface IInitParamsWithDefaults extends IInitParams {
-  autoSubscribe: boolean;
-  pushwooshUrl: string;
-  deviceType: number;
-  serviceWorkerUrl: string | null;
-  tags: {
-    Language: string;
-    'Device Model': string;
-    [key: string]: any;
-  };
-  driversSettings: {
-    worker: {
-      serviceWorkerUrl: string;
-      applicationServerPublicKey?: string;
-    };
-  };
-  subscribeWidget: ISubscribeWidget;
-  inboxWidget: IInboxWidget;
-  subscribePopup: ISubscribePopupConfig;
-  hwid: string;
-}
-
-export interface IPWParams extends IInitParamsWithDefaults {
-  applicationCode: string;
-  apiToken?: string;
-  defaultNotificationImage?: string;
-  defaultNotificationTitle?: string;
-  logLevel?: 'error' | 'info' | 'debug';
-  pushwooshApiUrl?: string;
-  safariWebsitePushID?: string;
-  scope?: string;
-  userId?: string;
-  email?: string;
-  pushwooshUrl: string;
-  authToken?: string;
-  hwid: string;
-  publicKey?: string;
-  pushToken?: string;
-}
-
-export interface INotificationOptions extends NotificationOptions {
-  title: string;
-  messageHash: string;
-  openUrl: string;
-  url?: string;
-  inboxId: string;
-
-  image?: string;
-  code?: string;
-  buttons?: INotificationButton[];
-  customData?: { [key: string]: any };
-  metaData?: { [key: string]: any };
-  campaignCode?: string;
-}
-
-export type TPWCanWaitCallback = (f: any) => Promise<any> | any;
-
-export interface IWorkerPushwooshGlobal {
-  push(listener: ['onPush', TPWCanWaitCallback]): void;
-  getListeners(eventName: string): TPWCanWaitCallback[];
-  eventBus: any;
-  api: any;
-  initApi: any;
-}
-
-export interface IPWBroadcastClientsParams {
-  type: string;
-  payload: any;
-}
-
-export type TWriteType = 'error' | 'apirequest' | 'info';
-
-export interface ILogger {
-  setLevel(level: string): void;
-  error(...args: any[]): void;
-  info(...args: any[]): void;
-  debug(...args: any[]): void;
-  write(type: TWriteType, message: any, additional?: any): Promise<void>;
-  isManualLevel(): boolean;
-  [key: string]: any;
-}
-
-export type ListenerFn = (...args: Array<any>) => void | Promise<any>;
-
-export type HandlerFn = (api: any, params?: any) => any;
-
-export type TWorkerDriverParams = {
-  eventEmitter?: any;
-  scope?: string;
-  applicationCode: string;
-  serviceWorkerUrl: string | null;
-  applicationServerPublicKey?: string;
-};
-
-export type TWorkerSafariDriverParams = {
-  eventEmitter?: any;
-  applicationCode: string;
-  webSitePushID: string;
-  pushwooshUrl: string;
-  pushwooshApiUrl?: string;
-};
-
-export type TDoPushwooshMethod = (type: string, params: any, url?: string) => Promise<any>;
-
-export type PWInput = PushOnReadyCallback | PushInitCallback | PushEventCallback;
-export type PushOnReadyCallback = HandlerFn;
-export type PushInitCallback = ['init', IInitParams];
-export type PushEventCallback = [PWEvent, HandlerFn];
-export type PWEvent =
-  | 'onLoad'
-  | 'onReady'
-  | 'onSubscribe'
-  | 'onUnsubscribe'
-  | 'onRegister'
-  | 'onSWInitError'
-  | 'onPermissionPrompt'
-  | 'onPermissionDenied'
-  | 'onPermissionGranted'
-  | 'onNotificationClick'
-  | 'onPushDelivery'
-  | 'onNotificationClose'
-  | 'onChangeCommunicationEnabled'
-  | 'onPutNewMessageToInboxStore'
-  | 'onUpdateInboxMessages'
-  | 'onShowNotificationPermissionDialog'
-  | 'onHideNotificationPermissionDialog'
-  | 'onShowSubscriptionWidget'
-  | 'onHideSubscriptionWidget';

package/src/core/Safari.types.ts

@@ -1,26 +0,0 @@
-interface IPushServiceSafariRequestPayload {
-  application: string;
-  hwid: string;
-}
-
-interface IPushServiceSafariInfo {
-  permission: NotificationPermission;
-  deviceToken?: string;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-interface Window {
-  safari: {
-    pushNotification: {
-      permission(siteId: string): IPushServiceSafariInfo;
-      requestPermission(
-        url: string,
-        id: string,
-        payload: IPushServiceSafariRequestPayload,
-        cb: (permission: IPushServiceSafariInfo) => void): void;
-    };
-  };
-}
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-declare const safari: typeof window.safari;

package/src/core/constants.ts

@@ -1,58 +0,0 @@
-export const DEFAULT_SERVICE_WORKER_URL = '/pushwoosh-service-worker.js';
-export const DEFAULT_API_URL = 'https://cp.pushwoosh.com/json/1.3/';
-
-export const PERIOD_SEND_APP_OPEN = 3600000;
-export const PERIOD_GOAL_EVENT = 86400000;
-
-export const DEFAULT_NOTIFICATION_TITLE = 'Pushwoosh notification';
-export const DEFAULT_NOTIFICATION_IMAGE = 'https://cp.pushwoosh.com/img/logo-medium.png';
-
-// Keys
-export const KEY_SHOW_SUBSCRIBE_WIDGET = 'WIDGET_SHOWED';
-export const KEY_CLICK_SUBSCRIBE_WIDGET = 'WIDGET_CLICKED';
-
-// Local storage keys
-export const KEY_DEVICE_REGISTRATION_STATUS: string = 'deviceRegistrationStatus';
-export const KEY_SAFARI_PREVIOUS_PERMISSION = 'safariPreviousPermission';
-export const MANUAL_SET_LOGGER_LEVEL = 'PW_SET_LOGGER_LEVEL';
-
-// Device registration status
-export const DEVICE_REGISTRATION_STATUS_REGISTERED: string = 'registered';
-export const DEVICE_REGISTRATION_STATUS_UNREGISTERED: string = 'unregistered';
-
-// Permissions
-export const PERMISSION_DENIED = 'denied';
-export const PERMISSION_GRANTED = 'granted';
-export const PERMISSION_PROMPT = 'default';
-
-// Events
-export const LEGACY_EVENT_ON_LOAD = 'onLoad';
-export const LEGACY_EVENT_ON_READY = 'onReady';
-export const LEGACY_EVENT_ON_SUBSCRIBE = 'onSubscribe';
-export const LEGACY_EVENT_ON_UNSUBSCRIBE = 'onUnsubscribe';
-export const LEGACY_EVENT_ON_REGISTER = 'onRegister';
-export const LEGACY_EVENT_ON_PERMISSION_PROMPT = 'onPermissionPrompt';
-export const LEGACY_EVENT_ON_PERMISSION_DENIED = 'onPermissionDenied';
-export const LEGACY_EVENT_ON_PERMISSION_GRANTED = 'onPermissionGranted';
-export const LEGACY_EVENT_ON_SW_INIT_ERROR = 'onSWInitError';
-export const LEGACY_EVENT_ON_PUSH_DELIVERY = 'onPushDelivery';
-export const LEGACY_EVENT_ON_NOTIFICATION_CLICK = 'onNotificationClick';
-export const LEGACY_EVENT_ON_NOTIFICATION_CLOSE = 'onNotificationClose';
-export const LEGACY_EVENT_ON_CHANGE_COMMUNICATION_ENABLED = 'onChangeCommunicationEnabled';
-export const LEGACY_EVENT_ON_PUT_NEW_MESSAGE_TO_INBOX_STORE = 'onPutNewMessageToInboxStore';
-export const LEGACY_EVENT_ON_UPDATE_INBOX_MESSAGES = 'onUpdateInboxMessages';
-export const LEGACY_EVENT_ON_SHOW_NOTIFICATION_PERMISSION_DIALOG = 'onShowNotificationPermissionDialog';
-export const LEGACY_EVENT_ON_HIDE_NOTIFICATION_PERMISSION_DIALOG = 'onHideNotificationPermissionDialog';
-
-export const LEGACY_EVENT_ON_SHOW_SUBSCRIPTION_WIDGET = 'onShowSubscriptionWidget';
-export const LEGACY_EVENT_ON_HIDE_SUBSCRIPTION_WIDGET = 'onHideSubscriptionWidget';
-
-// Post Events
-export const EVENT_SHOW_SUBSCRIBE_BUTTON = 'showSubscribeButton';
-export const EVENT_CLICK_SUBSCRIBE_BUTTON = 'clickSubscribeButton';
-export const EVENT_GDPR_CONSENT = 'GDPRConsent';
-export const EVENT_GDPR_DELETE = 'GDPRDelete';
-export const EVENT_PW_SITE_OPENED = 'PW_SiteOpened'; // for default events
-
-// Page visited
-export const PAGE_VISITED_URL = 'PAGE_VISITED_URL';

package/src/core/events.types.ts

@@ -1,46 +0,0 @@
-export type EventPayload<Parameters extends Record<string, unknown>> = Parameters & Record<'eventId', string>;
-export type EventHandler<Payload extends EventPayload<Record<string, unknown>>> = (payload: Payload) => void | Promise<void>;
-
-export interface EventHandlerMap {
-  /* system events handlers map */
-  ready: EventHandler<EventPayload<Record<string, never>>>;
-  'change-enabled-communication': EventHandler<EventPayload<{ isEnabled: boolean }>>;
-
-  /* device events handlers map */
-  register: EventHandler<EventPayload<Record<string, never>>>;
-  unregister: EventHandler<EventPayload<Record<string, never>>>;
-
-  /* push notification events handlers map */
-  'show-subscription-widget': EventHandler<EventPayload<Record<string, never>>>;
-  'hide-subscription-widget': EventHandler<EventPayload<Record<string, never>>>;
-  'show-notification-permission-dialog': EventHandler<EventPayload<Record<string, never>>>;
-  'hide-notification-permission-dialog': EventHandler<EventPayload<{ permission: NotificationPermission }>>;
-  'permission-default': EventHandler<EventPayload<Record<string, never>>>;
-  'permission-denied': EventHandler<EventPayload<Record<string, never>>>;
-  'permission-granted': EventHandler<EventPayload<Record<string, never>>>;
-  'change-permission': EventHandler<EventPayload<{ permission: NotificationPermission }>>;
-  'initialize-service-worker': EventHandler<EventPayload<Record<string, never>>>;
-  'initialize-service-worker-error': EventHandler<EventPayload<{ error: Error }>>;
-  subscribe: EventHandler<EventPayload<Record<string, never>>>;
-  unsubscribe: EventHandler<EventPayload<Record<string, never>>>;
-  'receive-push': EventHandler<EventPayload<{ notification: unknown }>>;
-  'show-notification': EventHandler<EventPayload<{ notification: unknown }>>;
-  'open-notification': EventHandler<EventPayload<{ notification: unknown }>>;
-  'hide-notification': EventHandler<EventPayload<{ notification: unknown }>>;
-
-  /* inbox events handlers map */
-  'receive-inbox-message': EventHandler<EventPayload<{ message: unknown }>>;
-  'update-inbox-messages': EventHandler<EventPayload<{ messages: unknown }>>;
-
-  /* in-app events handlers map */
-  'receive-in-app-code': EventHandler<EventPayload<{ code: string }>>;
-
-  /* subscribe popup events */
-  'subscribe-popup-ready': EventHandler<EventPayload<Record<string, never>>>;
-  'subscribe-popup-show': EventHandler<EventPayload<Record<string, never>>>;
-  'subscribe-popup-hide': EventHandler<EventPayload<Record<string, never>>>;
-  'subscribe-popup-decline': EventHandler<EventPayload<Record<string, never>>>;
-  'subscribe-popup-accept': EventHandler<EventPayload<Record<string, never>>>;
-}
-
-export type EventName = keyof EventHandlerMap;

package/src/core/functions.ts

@@ -1,33 +0,0 @@
-export function getGlobal() {
-  return globalThis;
-}
-
-declare const __VERSION__: string;
-export function getVersion() {
-  return __VERSION__;
-}
-
-// API bad behavior with demo app notification payload fix
-export function parseSerializedNotificationParams(param: any, defaultValue?: any) {
-  if (typeof param === 'string') {
-    try {
-      return JSON.parse(param);
-    } catch (e) {
-      console.log(e);
-    }
-  }
-  return param === undefined && defaultValue !== undefined ? defaultValue : param;
-}
-
-// Generates a UUID v4 string.
-// This function first tries to use crypto.randomUUID, which is supported in browsers since 2022.
-// If unavailable, it falls back to a manual UUID generation method.
-// In 2027, consider simplifying this function by removing the fallback.
-export function v4() {
-  return crypto.randomUUID?.() || 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (c) => {
-    const r = (Math.random() * 16) | 0;
-    return (c === 'x' ? r : (r & 0x3) | 0x8).toString(16);
-  });
-}
-
-export const isFunction = (value: any): value is ((...args: any[]) => any) => typeof value === 'function';

package/src/core/legacyEventsMap.ts

@@ -1,64 +0,0 @@
-import * as CONSTANTS from './constants';
-import type { EventName } from './events.types';
-
-export const legacyEventsMap: Record<string, { name: EventName; prop?: string }> = {
-  [CONSTANTS.LEGACY_EVENT_ON_REGISTER]: {
-    name: 'register',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_SUBSCRIBE]: {
-    name: 'subscribe',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_UNSUBSCRIBE]: {
-    name: 'unsubscribe',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_SW_INIT_ERROR]: {
-    name: 'initialize-service-worker-error',
-    prop: 'error',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_PUSH_DELIVERY]: {
-    name: 'receive-push',
-    prop: 'notification',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_NOTIFICATION_CLICK]: {
-    name: 'open-notification',
-    prop: 'notification',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_NOTIFICATION_CLOSE]: {
-    name: 'hide-notification',
-    prop: 'notification',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_CHANGE_COMMUNICATION_ENABLED]: {
-    name: 'change-enabled-communication',
-    prop: 'isEnabled',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_PUT_NEW_MESSAGE_TO_INBOX_STORE]: {
-    name: 'receive-inbox-message',
-    prop: 'message',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_UPDATE_INBOX_MESSAGES]: {
-    name: 'update-inbox-messages',
-    prop: 'messages',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_SHOW_NOTIFICATION_PERMISSION_DIALOG]: {
-    name: 'show-notification-permission-dialog',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_HIDE_NOTIFICATION_PERMISSION_DIALOG]: {
-    name: 'hide-notification-permission-dialog',
-    prop: 'permission',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_SHOW_SUBSCRIPTION_WIDGET]: {
-    name: 'show-subscription-widget',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_HIDE_SUBSCRIPTION_WIDGET]: {
-    name: 'hide-subscription-widget',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_PERMISSION_DENIED]: {
-    name: 'permission-denied',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_PERMISSION_PROMPT]: {
-    name: 'permission-default',
-  },
-  [CONSTANTS.LEGACY_EVENT_ON_PERMISSION_GRANTED]: {
-    name: 'permission-granted',
-  },
-};

package/src/core/logger.ts

@@ -1,64 +0,0 @@
-import { log as logStorage } from './storage';
-
-const levels: { [key: string]: number } = {
-  error: 1,
-  info: 2,
-  debug: 3,
-};
-
-let limitLevel = 3;
-
-type TWriteType = 'error' | 'apirequest' | 'info';
-
-interface ILogger {
-  setLevel(level: string): void;
-  error(...args: any[]): void;
-  info(...args: any[]): void;
-  debug(...args: any[]): void;
-  write(type: TWriteType, message: any, additional?: any): Promise<void>;
-  isManualLevel(): boolean;
-  [key: string]: any;
-}
-
-const Logger: ILogger = {
-  setLevel(level) {
-    if (!levels[level]) {
-      level = 'error';
-    }
-    limitLevel = levels[level];
-  },
-  write(type: TWriteType, message: any, additional?: any) {
-    if (type === 'error') {
-      this.error(message);
-    } else {
-      this.info(message);
-    }
-    return logStorage.add(type, message, additional);
-  },
-} as ILogger;
-
-Object.keys(levels).forEach((levelName: string) => {
-  const levelNumber = levels[levelName];
-  Logger[levelName] = (...args: any[]) => {
-    if (levelNumber <= limitLevel) {
-      console.groupCollapsed(levelName);
-      console.info('', ...args);
-      console.trace('trace');
-      console.groupEnd();
-    }
-  };
-});
-
-export function logAndThrowError(error: string) {
-  const logText = new Error(error);
-  Logger.write('error', logText, 'logAndThrowError');
-  throw logText;
-}
-
-export function logAndRejectError(error: string, reject: (e: any) => void) {
-  const logText = new Error(error);
-  Logger.write('error', logText, 'logAndRejectError');
-  reject(logText);
-}
-
-export { Logger };

package/src/core/modules/EventBus/EventBus.ts

@@ -1,66 +0,0 @@
-import { type EventHandlerMap, type EventName } from '../../events.types';
-import { isFunction, v4 } from '../../functions';
-
-type SavedEventHandlersMap = {
-  // TODO: fix me: https://github.com/microsoft/TypeScript/issues/36390
-  // [K in keyof EventHandlerMap]?: Array<EventHandlerMap[K]>
-  [K in keyof EventHandlerMap]?: Array<unknown>
-};
-
-export class EventBus {
-  private readonly handlers: SavedEventHandlersMap;
-
-  constructor() {
-    this.handlers = {};
-  }
-
-  public addEventHandler = <Name extends EventName = EventName>(
-    name: Name,
-    handler: EventHandlerMap[Name],
-  ): void => {
-    let savedEventHandlers = this.handlers[name];
-    if (!savedEventHandlers) {
-      savedEventHandlers = [];
-    }
-
-    savedEventHandlers.push(handler);
-    this.handlers[name] = savedEventHandlers;
-  };
-
-  public removeEventHandler = <Name extends EventName = EventName>(
-    name: Name,
-    handler: EventHandlerMap[Name],
-  ): void => {
-    const savedEventHandlers = this.handlers[name];
-    if (!savedEventHandlers) {
-      return;
-    }
-
-    this.handlers[name] = savedEventHandlers.filter((savedEventHandler) => (
-      savedEventHandler !== handler
-    ));
-  };
-
-  public dispatchEvent = <Name extends EventName = EventName>(
-    name: Name,
-    payload: Omit<Parameters<EventHandlerMap[Name]>[0], 'eventId'> & { eventId?: string },
-  ): string => {
-    const eventId = payload.eventId || v4();
-    const savedEventHandlers = this.handlers[name];
-    if (!savedEventHandlers) {
-      return eventId;
-    }
-
-    savedEventHandlers.forEach((handler) => {
-      if (!isFunction(handler)) {
-        return;
-      }
-
-      setTimeout(() => {
-        handler({ ...payload, eventId });
-      }, 0);
-    });
-
-    return eventId;
-  };
-}