web-push-notifications 3.44.7 → 3.44.9

package/helpers/pwlogger/Logger.types.d.ts

@@ -0,0 +1,44 @@
+export type TLoggerLevelSilent = 'silent';
+export type TLoggerLevelFatal = 'fatal';
+export type TLoggerLevelError = 'error';
+export type TLoggerLevelWarn = 'warn';
+export type TLoggerLevelInfo = 'info';
+export type TLoggerLevelDebug = 'debug';
+export type TLoggerFromSDK = 'sdk';
+export type TLoggerFromCP = 'cp';
+export type TLoggerApplicationType = TLoggerFromSDK | TLoggerFromCP;
+export type TLoggerOutputLevels = TLoggerLevelFatal | TLoggerLevelError | TLoggerLevelWarn | TLoggerLevelInfo | TLoggerLevelDebug;
+export type TLoggerLevels = TLoggerLevelSilent | TLoggerOutputLevels;
+export interface ILoggerLogOptions {
+    handler?: TLoggerHandler;
+    [key: string]: any;
+}
+export interface ILoggerLogParams {
+    type: TLoggerOutputLevels;
+    text: string;
+    code?: string | number;
+    options?: ILoggerLogOptions;
+}
+export type TLoggerHandler = (message: ILoggerMessage) => void | Promise<void>;
+export interface ILoggerSubscriber {
+    handler: TLoggerHandler;
+    level: TLoggerOutputLevels;
+}
+export interface ILoggerMessage {
+    type: TLoggerOutputLevels;
+    text: string;
+    applicationType: TLoggerApplicationType;
+    code?: string | number;
+    applicationCode?: string;
+    domain?: string;
+    deviceInfo?: {
+        [key: string]: any;
+    };
+    [key: string]: any;
+}
+export interface ILoggerConfig {
+    level?: TLoggerLevels;
+    applicationType?: TLoggerApplicationType;
+    subscribers?: ILoggerSubscriber[];
+}
+export type TReject = (reason: Error) => void;

package/helpers/pwlogger/handlers/handler-console/handler-console.d.ts

@@ -0,0 +1,2 @@
+import { type ILoggerMessage } from './../../Logger';
+export declare function handlerConsole(message: ILoggerMessage): void;

package/{src/helpers/unescape.ts → helpers/unescape.d.ts}

@@ -1,16 +1,3 @@
-/** 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
@@ -29,8 +16,4 @@ const reHasEscapedHtml = RegExp(reEscapedHtml.source);
  * 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;
-}
+export declare function unescape(string: string): string;

package/models/InboxMessages.d.ts

@@ -0,0 +1,82 @@
+import { type IInboxMessage } 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 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, dateModule?: DateModule);
+    /**
+     * Get inbox messages by api
+     */
+    private getInboxMessages;
+    /**
+     * Store parameters for next getInboxMessages request
+     * @param next
+     * @param newMessagesCount
+     */
+    private storeGetInboxMessagesRequestParams;
+    /**
+     * Put loaded messages. Add delete status to loaded messages if this status set locally.
+     * @param messages
+     */
+    private putServerMessages;
+    /**
+     * Create or update inbox message
+     */
+    putMessage(message: IInboxMessage): Promise<string>;
+    /**
+     * Create or update messages pack
+     * @param messages
+     */
+    putBulkMessages(messages: Array<IInboxMessage>): Promise<Array<string>>;
+    /**
+     * Delete messages by codes
+     * @param codes
+     */
+    deleteMessages(codes: Array<string>): Promise<Array<void>>;
+    /**
+     * Delete expired by removal time messages
+     */
+    deleteExpiredMessages(): Promise<Array<void>>;
+    /**
+     * Get message by code
+     * @param code - inbox_id
+     */
+    getMessage(code: string): Promise<IInboxMessage>;
+    /**
+     * Get all read messages
+     */
+    getReadOpenMessages(): Promise<Array<IInboxMessage>>;
+    /**
+     * Get all unread messages
+     */
+    getDeliveredMessages(): Promise<Array<IInboxMessage>>;
+    /**
+     * All messages count
+     */
+    messagesCount(): Promise<number>;
+    /**
+     * Get count of messages with status "Delivered"
+     */
+    getDeliveredMessagesCount(): Promise<number>;
+    /**
+     * Get count of messages with status "Read"
+     */
+    getReadMessagesCount(): Promise<number>;
+    /**
+     * Get count of messages with status "Delivered" and "Read"
+     */
+    getDeliveredReadMessagesCount(): Promise<number>;
+    /**
+     * Load messages and sync with locally
+     */
+    updateMessages(): Promise<void>;
+}

package/models/InboxMessages.types.d.ts

@@ -0,0 +1,83 @@
+export type TInboxActionLink = 1;
+export type TInboxActionRichMedia = 2;
+export type TInboxActionType = TInboxActionLink | TInboxActionRichMedia;
+export type TInboxMessageStatusDelivered = 1;
+export type TInboxMessageStatusRead = 2;
+export type TInboxMessageStatusOpen = 3;
+export type TInboxMessageStatusDeleted = 4;
+export type TInboxMessageStatus = TInboxMessageStatusDelivered | TInboxMessageStatusRead | TInboxMessageStatusOpen | TInboxMessageStatusDeleted;
+export type TReadInboxMessagesStatusRange = [TInboxMessageStatusRead, TInboxMessageStatusOpen];
+export interface IInboxMessageActionParams {
+    l?: string | null;
+    rm?: string;
+    h?: string;
+    r?: string;
+}
+export interface IInboxMessage {
+    inbox_id: string;
+    order: string;
+    rt: string;
+    send_date: string;
+    title: string;
+    image: string;
+    text: string;
+    action_type: TInboxActionType;
+    action_params: string;
+    status: TInboxMessageStatus;
+}
+export interface IGetInboxMessagesRequest {
+    application: string;
+    userId: string;
+    hwid: string;
+    last_code: string;
+    count?: number;
+    last_request_time: number;
+}
+export interface IGetInboxMessagesResponse {
+    messages: Array<IInboxMessage>;
+    next: string;
+    deleted: Array<string>;
+    new_inbox: number;
+}
+export interface IInboxStatusRequest {
+    userId: string;
+    hwid: string;
+    application: string;
+    inbox_code: string;
+    time: number;
+    status: TInboxMessageStatus;
+    hash?: string;
+    device_type: number;
+}
+export type TGetInboxMessagesMethod = 'getInboxMessages';
+export type TInboxStatusMethod = 'inboxStatus';
+export type TInboxMessagesIDBKeyPath = 'inbox_id';
+export type TInboxMessagesIDBStatusIndex = 'status';
+export type TInboxMessagesIDBRemovalTimeIndex = 'rt';
+export type TInboxMessageTypePlain = 0;
+export type TInboxMessageTypeRichmedia = 1;
+export type TInboxMessageTypeURL = 2;
+export type TInboxMessageTypeDeeplink = 3;
+export type TInboxMessageType = TInboxMessageTypePlain | TInboxMessageTypeRichmedia | TInboxMessageTypeURL | TInboxMessageTypeDeeplink;
+export type TInboxDefaultLink = '/';
+export interface IInboxMessagePublic {
+    code: string;
+    title: string;
+    message: string;
+    imageUrl: string;
+    sendDate: string;
+    type: TInboxMessageType;
+    link: string | TInboxDefaultLink;
+    isRead: boolean;
+    isActionPerformed: boolean;
+}
+export interface IInboxMessages {
+    messagesWithNoActionPerformedCount(): Promise<number>;
+    unreadMessagesCount(): Promise<number>;
+    messagesCount(): Promise<number>;
+    loadMessages(): Promise<Array<IInboxMessagePublic>>;
+    readMessagesWithCodes(codes: Array<string>): Promise<void>;
+    performActionForMessageWithCode(code: string): Promise<void>;
+    deleteMessagesWithCodes(codes: Array<string>): Promise<void>;
+    publicMessageBuilder(message: IInboxMessage): Promise<IInboxMessagePublic>;
+}

package/models/NotificationPayload.d.ts

@@ -0,0 +1,39 @@
+import { type IInboxMessage } from './InboxMessages.types';
+import { type IChromeNotificationPayload, type INotificationButton, type INotificationOptionsPayload, type INotificationPayload, type INotificationPayloadInboxParams, type IShowNotificationOptions } from './NotificationPayload.types';
+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, dateModule?: DateModule);
+    getIcon(): Promise<string>;
+    getTitle(): Promise<string>;
+    get silent(): boolean;
+    get body(): string;
+    get messageHash(): string;
+    get metaData(): {
+        [key: string]: any;
+    };
+    get image(): string;
+    get buttons(): Array<INotificationButton>;
+    get customData(): {
+        [key: string]: any;
+    };
+    get campaignCode(): string;
+    get link(): string;
+    get inboxId(): string;
+    get inboxParams(): INotificationPayloadInboxParams;
+    get inboxRemovalTime(): string;
+    getInboxImage(): Promise<string>;
+    get rootParams(): {
+        [key: string]: any;
+    };
+    getNotificationOptionsPayload(): Promise<INotificationOptionsPayload>;
+    getShowNotificationOptions(): Promise<IShowNotificationOptions>;
+    getInboxMessage(): Promise<IInboxMessage>;
+}

package/models/NotificationPayload.types.d.ts

@@ -0,0 +1,63 @@
+export interface INotificationPayloadInboxParams {
+    image?: string;
+    rt?: string;
+}
+export interface INotificationPayload {
+    body: string;
+    p?: string;
+    silent?: string;
+    header?: string;
+    i?: string;
+    u?: string;
+    md?: string;
+    l?: string;
+    pwcid?: string;
+    image?: string;
+    buttons?: string;
+    pw_inbox?: string;
+    inbox_params?: string;
+    [key: string]: any;
+}
+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;
+    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;
+    silent?: boolean;
+    [key: string]: any;
+}

package/modules/Api/Api.d.ts

@@ -0,0 +1,45 @@
+import { type SetPurchaseAttributes } from './Api.types';
+import { type EventBus } from '../../core/modules/EventBus';
+import { ApiClient } from '../ApiClient/ApiClient';
+import { type IMapRequest, type IMapResponse } from '../ApiClient/ApiClient.types';
+import { Data } from '../Data/Data';
+export declare class Api {
+    private readonly data;
+    private readonly apiClient;
+    private readonly eventBus;
+    constructor(eventBus: EventBus, data?: Data, apiClient?: ApiClient);
+    checkDevice(): Promise<IMapResponse['checkDevice']>;
+    checkDeviceSubscribeForPushNotifications(useCache?: boolean): Promise<boolean>;
+    getConfig(features: string[]): Promise<IMapResponse['getConfig']>;
+    applicationOpen(): Promise<IMapResponse['applicationOpen']>;
+    registerDevice(): Promise<IMapResponse['registerDevice']>;
+    unregisterDevice(): Promise<IMapResponse['unregisterDevice']>;
+    deleteDevice(): Promise<IMapResponse['deleteDevice']>;
+    messageDeliveryEvent(hash: string, isTrackingLogOnFailure?: boolean, metaData?: {
+        [key: string]: any;
+    }): Promise<IMapResponse['messageDeliveryEvent']>;
+    pushStat(hash: string, isTrackingLogOnFailure?: boolean, metaData?: {
+        [key: string]: any;
+    }): Promise<IMapResponse['pushStat']>;
+    setTags(tags: {
+        [key: string]: any;
+    }): Promise<IMapResponse['setTags']>;
+    getTags(): Promise<IMapResponse['getTags']>;
+    registerUser(userId: string | number): Promise<IMapResponse['registerUser']>;
+    registerEmail(email: string, params?: IMapRequest['registerEmail']): Promise<IMapResponse['registerEmail']>;
+    postEvent(event: string, attributes: {
+        [key: string]: any;
+    }): Promise<IMapResponse['postEvent']>;
+    getInboxMessages(count?: number): Promise<IMapResponse['getInboxMessages']>;
+    inboxStatus(order: string, status: number): Promise<IMapResponse['inboxStatus']>;
+    triggerEvent(): Promise<void>;
+    pageVisit(config: {
+        title: string;
+        url_path: string;
+        url: string;
+    }): Promise<IMapResponse['pageVisit']>;
+    setPurchase(attributes: SetPurchaseAttributes): Promise<IMapResponse['setPurchase']>;
+    getParams(): Promise<any>;
+    get params(): void;
+    private getRequestParams;
+}

package/modules/Api/Api.types.d.ts

@@ -0,0 +1,7 @@
+export interface SetPurchaseAttributes {
+    transactionDate: string;
+    quantity: number;
+    currency: string;
+    productIdentifier: string;
+    price: number;
+}

package/modules/ApiClient/ApiClient.d.ts

@@ -0,0 +1,29 @@
+import { type IMapRequest, type IMapResponse } from './ApiClient.types';
+import { Logger } from '../../core/logger';
+import { Data } from '../Data/Data';
+export declare class ApiClient {
+    private readonly data;
+    private readonly logger;
+    constructor(data?: Data, logger?: typeof Logger);
+    checkDevice(options: IMapRequest['checkDevice']): Promise<IMapResponse['checkDevice']>;
+    getConfig(options: IMapRequest['getConfig']): Promise<IMapResponse['getConfig']>;
+    applicationOpen(options: IMapRequest['applicationOpen']): Promise<IMapResponse['applicationOpen']>;
+    registerDevice(options: IMapRequest['registerDevice']): Promise<IMapResponse['registerDevice']>;
+    unregisterDevice(options: IMapRequest['unregisterDevice']): Promise<IMapResponse['unregisterDevice']>;
+    deleteDevice(options: IMapRequest['deleteDevice']): Promise<IMapResponse['deleteDevice']>;
+    messageDeliveryEvent(options: IMapRequest['messageDeliveryEvent']): Promise<IMapResponse['messageDeliveryEvent']>;
+    pushStat(options: IMapRequest['pushStat']): Promise<IMapResponse['pushStat']>;
+    setTags(options: IMapRequest['setTags']): Promise<IMapResponse['setTags']>;
+    getTags(options: IMapRequest['getTags']): Promise<IMapResponse['getTags']>;
+    registerUser(options: IMapRequest['registerUser']): Promise<IMapResponse['registerUser']>;
+    registerEmail(options: IMapRequest['registerEmail']): Promise<IMapResponse['registerEmail']>;
+    registerEmailUser(options: IMapRequest['registerEmailUser']): Promise<IMapResponse['registerEmailUser']>;
+    setEmailTags(options: IMapRequest['setEmailTags']): Promise<IMapResponse['setEmailTags']>;
+    postEvent(options: IMapRequest['postEvent']): Promise<IMapResponse['postEvent']>;
+    getInboxMessages(options: IMapRequest['getInboxMessages']): Promise<IMapResponse['getInboxMessages']>;
+    inboxStatus(options: IMapRequest['inboxStatus']): Promise<IMapResponse['inboxStatus']>;
+    pageVisit(options: IMapRequest['pageVisit'], url: string): Promise<IMapResponse['pageVisit']>;
+    setPurchase(options: IMapRequest['setPurchase']): Promise<IMapResponse['setPurchase']>;
+    private createRequest;
+    private checkResponse;
+}

package/modules/ApiClient/ApiClient.types.d.ts

@@ -0,0 +1,188 @@
+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;
+    hwid: string;
+    userId: string;
+    device_type: number;
+    device_model: string;
+    timezone: number;
+    language: string;
+    v: string;
+}
+export interface IRequestEmail extends Omit<IRequest, 'hwid' | 'device_type'> {
+    email: string;
+}
+interface IRequestGetConfig extends IRequest {
+    features: string[];
+}
+interface IRequestRegisterDevice extends IRequest {
+    push_token: string;
+    public_key?: string;
+    auth_token?: string;
+}
+interface IRequestRegisterUser extends IRequest {
+    ts_offset: number;
+}
+interface IRequestRegisterEmail extends IRequestEmail {
+    tags?: {
+        [key: string]: any;
+    };
+    ts_offset: number;
+}
+interface IRequestRegisterEmailUser extends IRequestEmail {
+    ts_offset: number;
+}
+interface IRequestSetEmailTags extends IRequestEmail {
+    tags: {
+        [key: string]: any;
+    };
+}
+interface IRequestPostEvent extends IRequest {
+    event: string;
+    attributes?: {
+        [key: string]: any;
+    };
+    timestampUTC?: number;
+    timestampCurrent?: number;
+}
+interface IRequestMessageDeliveryEvent extends IRequest {
+    hash: string;
+    metaData: {
+        [key: string]: any;
+    };
+}
+interface IRequestPushStat extends IRequest {
+    hash: string;
+    metaData: {
+        [key: string]: any;
+    };
+}
+interface IRequestSetTags extends IRequest {
+    tags: {
+        [key: string]: any;
+    };
+}
+interface IRequestGetInboxMessages extends IRequest {
+    userId: string;
+    last_code: string;
+    count?: number;
+    last_request_time: number;
+}
+interface IRequestInboxStatus extends IRequest {
+    userId: string;
+    inbox_code: string;
+    time: number;
+    status: number;
+    hash?: string;
+    device_type: number;
+}
+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;
+    push_token_exist: boolean;
+}
+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;
+    deleted: Array<string>;
+    new_inbox: number;
+}
+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;
+}
+export {};