noibu-react-native 0.2.6 → 0.2.7

package/dist/pageVisit/userStep.js

@@ -1,20 +0,0 @@
-import { asString } from '../utils/function.js';
-import { CSS_CLASS_ATT_NAME } from '../constants.js';
-
-/** @module UserStep */
-/**
- * updates the payload of a user step in order to stringify the css class
- * @param  {} payload
- */
-function updatePayload(payload) {
-  // In certain cases the class returned by the attribute will be an
-  // object. This will break the metroplex validation and thus needs to be
-  // stringified
-  const updatedPayload = payload;
-  updatedPayload[CSS_CLASS_ATT_NAME] = asString(
-    updatedPayload[CSS_CLASS_ATT_NAME],
-  );
-  return updatedPayload;
-}
-
-export { updatePayload };

package/dist/src/api/clientConfig.d.ts

@@ -1,100 +0,0 @@
-import { SEVERITY } from '../constants';
-import { CustomerConfig, StoredConfig } from '../../types/Config';
-import { Singleton } from '../monitors/BaseMonitor';
-/**
- * Singleton class to manage the client configuration
- * this class will be responsible for controlling the disabled
- * status of the client script as well as managing all storage
- * storing and retrieval.
- */
-export default class ClientConfig extends Singleton {
-    readonly pageVisitId: string;
-    browserId: StoredConfig['BrowserId'];
-    private pageVisitSeq;
-    lastActiveTime: Date;
-    private readonly noibuErrorURL;
-    private cltErrorPostCounter;
-    private readonly maxSocketInactiveTime;
-    private locationBreadcrumbs;
-    customerDomain: string;
-    isClientDisabled: boolean;
-    configurationPromise: Promise<void>;
-    readonly listOfUrlsToCollectHttpDataFrom: CustomerConfig['listOfUrlsToCollectHttpDataFrom'];
-    readonly enableHttpDataCollection: CustomerConfig['enableHttpDataCollection'];
-    readonly blockedElements: CustomerConfig['blockedElements'];
-    /**
-     * Creates a ClientConfig singleton instance
-     */
-    constructor(noibuErrorURL?: string, customerConfig?: CustomerConfig);
-    /**
-     * Convenience method to check correct setup
-     */
-    private hasAllNecessaryArgs;
-    /** lockClient will disable the client script for a single pagevisit for
-     * duration given in minuntes */
-    lockClient(duration: number, msg: string): Promise<void>;
-    /** Locks the client until the next page loads */
-    lockClientUntilNextPage(msg: string): Promise<void>;
-    /**  Updates the config object to store the given last active time */
-    updateLastActiveTime(lastActiveTime: Date): Promise<void>;
-    /**  Gets the current page visit sequence number that should be used */
-    getPageVisitSeq(): Promise<number>;
-    /**
-     *  Returns the client config object from storage or generates a new one
-     * What is stored in storage will look like this
-     *   {
-     * BrowserId: UUIDV4
-     * ExpiryTime: DATE OBJ
-     * DisabledStatus: BOOL
-     * CurrentPageVisitCount: INT
-     * ClientUnlockTime: DATE OBJ
-     * LastActiveTime: DATE OBJ
-     * }
-     */
-    _getLsObject(): Promise<StoredConfig>;
-    /**
-     * Check if we have surpassed the last active time and the page visit seq number needs resetting
-     */
-    _pageVisitSeqNeedsReset(): Promise<boolean>;
-    /**
-     * _setupStorageVars will set all class variables that depend
-     * on the storage's value.
-     */
-    _setupStorageVars(): Promise<void>;
-    /**
-     *   Function will get the Noibu Storage Object
-     * 1. Generate a brand new one
-     * Get it from storage if the expiry date is not in the past
-     * Generate a brand new one if the expiry date is in the past
-     */
-    _getClientState(): Promise<StoredConfig>;
-    /**
-     * _generateAndStoreData generates brand new data and then proceeds to store
-     * it.
-     */
-    _generateAndStoreData(): Promise<StoredConfig>;
-    /**
-     * _generateNewBrowserData will create new data to be stored in storage
-     *   and persisted throughout a session
-     */
-    _generateNewBrowserData(): StoredConfig;
-    /**
-     * _storeBrowserData will store the passed object in storage.
-     * @param  {} data the data to be stored
-     */
-    _storeBrowserData(data: StoredConfig): Promise<StoredConfig>;
-    /** sets current breadcrumbs to be reconstructed into global url */
-    set currentLocationBreadcrumbs(newValue: typeof this.locationBreadcrumbs);
-    /** gets current global url */
-    get globalUrl(): string;
-    /**
-     * postNoibuErrorAndOptionallyDisableClient will post errors that were thrown by collect
-     * and disable the client if required
-     * severity expects one of the SEVERITY_x level constants, or else error will be used
-     */
-    postNoibuErrorAndOptionallyDisableClient(errorMsg: any, disableClient?: boolean, severity?: (typeof SEVERITY)[keyof typeof SEVERITY], keepAlive?: boolean): Promise<void>;
-    /**
-     * Returns true if the page visit is considered to be inactive
-     */
-    isInactive(): boolean;
-}

package/dist/src/api/clientConfig.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/api/helpCode.d.ts

@@ -1,23 +0,0 @@
-import { Singleton } from '../monitors/BaseMonitor';
-/**
- * HelpCode class is responsible for help code feature related functionality
- */
-export default class HelpCode extends Singleton {
-    private requestContext;
-    /**
-     * Constructs instance and sets up event listeners
-     */
-    constructor();
-    /**
-     * Requests a help code and returns a Promise that resolves when the help code is obtained
-     * or rejects if the noibu connection is unavailable.
-  
-     * @returns {Promise<string>} Promise object representing the help code request.
-     * @throws {string} Throws an error if the noibu connection is unavailable.
-     */
-    requestHelpCode(): Promise<unknown>;
-    /**
-     * Handles the received help code event.
-     */
-    receiveHelpCode(event: CustomEvent<string>): void;
-}

package/dist/src/api/inputManager.d.ts

@@ -1,87 +0,0 @@
-/** this class controls the input that customers can inject into
- * our script via the NoibuJS SDK
- */
-export default class InputManager {
-    /** gets the singleton instance */
-    static getInstance(): InputManager;
-    customIDs: {};
-    customErrorsCount: number;
-    TOO_MANY_IDS_ADDED_MSG: string;
-    ID_NAME_ALREADY_ADDED_MSG: string;
-    NAME_TOO_LONG_MSG: string;
-    VALUE_TOO_LONG_MSG: string;
-    INVALID_NAME_TYPE_MSG: string;
-    INVALID_VALUE_TYPE_MSG: string;
-    NAME_HAS_NO_LENGTH_MSG: string;
-    VALUE_HAS_NO_LENGTH_MSG: string;
-    SUCCESS_MSG: string;
-    ERROR_HAS_NO_MSG_MSG: string;
-    ERROR_HAS_NO_STACK_MSG: string;
-    NULL_CUSTOM_ERR_MSG: string;
-    ERROR_ALREADY_RECEIVED_MSG: string;
-    INVALID_ERROR_SOURCE_MSG: string;
-    TOO_MANY_ERRORS_RECEIVED_PER_PAGEVISIT_MSG: string;
-    /** exposes functions to the window of the browser for the clients
-     * to interact with on their end
-     */
-    exposeFunctions(): {
-        requestHelpCode: (alert?: boolean) => Promise<string>;
-        addCustomAttribute: (name: string, value: string) => Promise<string>;
-        addError: (customError: Error) => string;
-        addJsSdkError: (customError: string, errorSource: string) => string;
-    };
-    /**
-     * gets the sdk object that will be assigned to a window variable
-     * @returns {{
-     *    requestHelpCode: (alert?: boolean) => Promise<string>,
-     *    addCustomAttribute: (name: string, value: string) => Promise<string>,
-     *    addError: (customError: Error) => string,
-     *    addJsSdkError: (customError: string, errorSource: string) => string
-     * }}
-     */
-    _getSDKWindowObject(): {
-        requestHelpCode: (alert?: boolean) => Promise<string>;
-        addCustomAttribute: (name: string, value: string) => Promise<string>;
-        addError: (customError: Error) => string;
-        addJsSdkError: (customError: string, errorSource: string) => string;
-    };
-    /**
-     * validates the custom error that was passed
-     * @param  {} customError
-     */
-    _validateCustomError(customError: any): string;
-    /**
-     * Validates and sets the custom error to our internal trackers
-     * @param  {} customError
-     */
-    _validateAndSetCustomError(customError: any): string;
-    /**
-     * adds an error from a JS Sdk to the session
-     * @param  {} customError
-     * @param {string} errorSource
-     */
-    _addErrorFromJSSdk(customError: any, errorSource: string): string;
-    /**
-     * adds a custom Error to the session
-     * @param  {} customError
-     */
-    _addCustomError(customError: any): string;
-    /**
-     * adds a custom id to the session
-     * @param  {} name
-     * @param  {} value
-     */
-    _addCustomAttribute(name: any, value: any): Promise<string>;
-    /**
-     * validation function for customer input
-     * @param  {} name
-     * @param  {} value
-     */
-    _validateCustomIDInput(name: any, value: any): string;
-    /**
-     * Requests a help code from the HelpCode instance.
-     * @param {boolean} [alertUser=true] - Whether to alert the user about the help code request.
-     * @returns {Promise<string>} A promise that resolves with the requested help code.
-     */
-    _requestHelpCode(): Promise<string>;
-}

package/dist/src/api/metroplexSocket.d.ts

@@ -1,137 +0,0 @@
-import { PAGE_VISIT_PART_ATT_NAME, PAGE_VISIT_VID_FRAG_ATT_NAME } from '../constants';
-import { CompletePageVisit, InboundMessageType, OutboundMessageType, OutboundMessageTypeMap, PageVisitFrag, PageVisitInfo, SlidingMessage, VideoFrag } from '../../types/Metroplex.types';
-import { PVEventMessage } from '../../types/PageVisitEvents.types';
-import { Singleton } from '../monitors/BaseMonitor';
-/**
- * Implements rolling window of specified size,
- * but only makes a cut once array length exceeds 150%.
- * During downsize deletes oldest (lowest indexes) elements.
- */
-export declare function createSlidingArrayOfSize<T>(size: number, arraySource?: T[], downsizeThreshold?: number, downsizeFactor?: number): T[];
-/** Manages the socket to Metroplex */
-export default class MetroplexSocket extends Singleton {
-    forceClosed: boolean;
-    socket: WebSocket | null;
-    socketInstanceId: string | null;
-    previousMessageType: string;
-    currentConnectionAttempts: number;
-    connectionCount: number;
-    sessionStartTime: any;
-    connectionPromise: Promise<void> | null;
-    pageVisitInfoSent: boolean;
-    connectionURL: string;
-    postURL: string;
-    messageSequenceNum: number;
-    latestReceivedSeqNumber: number;
-    isRetryLoopDisabled: boolean;
-    /** messages that need to be resent to metroplex since they are lacking confirmation */
-    retryMessageQueue: SlidingMessage<keyof OutboundMessageTypeMap>[];
-    metroplexTypeLock: Record<OutboundMessageType, boolean>;
-    initialURL: string;
-    initialReferringURL: string;
-    sessionTimestamp: Date;
-    latestReceivedSeqNumStoredTime: Date;
-    instanceId: string;
-    scriptInstanceId?: string;
-    sessionLength: number;
-    socketCloseCodes: string[];
-    socketOpens: string[];
-    ackedOnce: boolean;
-    metroRetryFrequencyMS: 30000;
-    retryMetroplexInterval: ReturnType<typeof setTimeout> | null;
-    private helpCodeCb;
-    /**
-     * Creates an instance of metroplex
-     * id of script, to make sure only a single socket is open
-     */
-    constructor(scriptInstanceId?: string);
-    private static readonly typeToPayloadPropMap;
-    /**
-     * Adds the seq num field to the given payload depending on whether its
-     * a page visit part or video frag
-     */
-    _addSeqNumToPayload<T>(type: OutboundMessageType, payload: T): T;
-    /** requests help code and saves a callback to be called on response */
-    requestHelpCode(cb: typeof this.helpCodeCb): Promise<boolean>;
-    /**
-     * Immediately sends a message to Metroplex over the web socket
-     * Queues the message if the connection isn't open yet.
-     * returns true if message was sent succefully, false otherwise
-     */
-    sendMessage<T extends OutboundMessageType>(type: T, payload: OutboundMessageTypeMap[T]): Promise<boolean>;
-    /** Updates the latest pv message sent timestamp if events contain any user steps
-     */
-    _updateLatestPvTimestamp(events: PVEventMessage[]): Promise<void>;
-    /** returns true if the socket is either connecting or connected to metroplex */
-    isConnected(): boolean;
-    /** returns true if we are connecting to the socket */
-    isConnecting(): boolean;
-    /** close will close the socket opened for video frag transmission */
-    close(): void;
-    /** Connects the web socket to metroplex and calls callback upon successfully connecting
-     */
-    handleConnect(forceOpen: boolean): Promise<void>;
-    /**
-     * connectSocket will establish a websocket connection to the metroplex
-     * service
-     */
-    connectSocket(): Promise<void>;
-    /** Calculates and sets the end_at field of the payload
-     * @param  {} payload
-     * @param  {} isPageVisit
-     */
-    addEndTimeToPayload<T extends VideoFrag | PageVisitFrag>(payload: T, isPageVisit: boolean): T;
-    /** open handler for socket */
-    _onSocketOpen(): Promise<void>;
-    /** message handler for socket
-     * @param  {} event
-     */
-    _onSocketMessage(event: InboundMessageType): Promise<void>;
-    /**
-     * Returns true if the message's payload has the payload type given and has a sequence
-     * number higher than seqNum
-     */
-    _messagePayloadHasLargerSeqNum(message: SlidingMessage, payloadType: typeof PAGE_VISIT_PART_ATT_NAME | typeof PAGE_VISIT_VID_FRAG_ATT_NAME, seqNum: number): boolean;
-    /**
-     * removes messages from the retry queue that are smaller than the
-     * latest stored message in metroplex
-     */
-    _clearRetryQueue(seqNum: number): void;
-    /** will resend everything that is in the retry queue */
-    _sendUnconfirmedMessages(socketWasAlreadyOpen: boolean): Promise<void>;
-    /** sets up the interval to empty the queue as we receive confirmation messages from metroplex */
-    setupRetryMechanism(): void;
-    /** sets up events that will trigger the event queue to be emptied */
-    _setupOffloadEvents(): void;
-    /**
-     * will handle the final moments of a page being active. It
-     * will try to empty both the queues with beacons.
-     */
-    _handleUnload(): Promise<void>;
-    /**
-     * will post full page visit to metroplex. It
-     * will try to empty both the queues with beacons.
-     */
-    postFullPageVisit(maxMessageSize: number): Promise<void>;
-    /**
-     * will send a message to metroplex via a post request that will outlive the current page
-     */
-    postMessage(msg: CompletePageVisit): Promise<void>;
-    /**
-     * Stringifies the payload into JSON, sends it to the back end if the session
-     * is active and returns true. If inactive the session and socket are closed
-     * and this method returns false.
-     */
-    _sendSocketMessage<T extends ValueOf<OutboundMessageTypeMap>>(payload: T): Promise<void>;
-    /**
-     * Closes the socket connection if the session is inactive. Returns true if the
-     * session is inactive
-     */
-    closeIfInactive(): Promise<boolean>;
-    /** will get page information, calling this will increase the connection count */
-    getPageInformation(): Promise<PageVisitInfo>;
-    /**
-     * Try to parse help code response and fire custom event
-     */
-    _tryProcessHelpCodeResponse(response: unknown): boolean;
-}

package/dist/src/api/storedMetrics.d.ts

@@ -1,73 +0,0 @@
-/**
- * This class holds the final page visit and video frag metrics. It flushes
- * them to storage and then finally sends them to Metroplex via the post
- * route when the next page is loaded
- */
-export default class StoredMetrics {
-    /**
-     * gets the singleton instance
-     * @returns {StoredMetrics}
-     */
-    static getInstance(): StoredMetrics;
-    expectedVideoLength: number;
-    expectedVfSeq: number;
-    httpSequenceNumber: number;
-    httpOverLimitCount: number;
-    httpDroppedPayloadByTypeCount: number;
-    httpDroppedPayloadByLengthCount: number;
-    httpPayloadCount: number;
-    expectedPvPart: number;
-    videoClicks: number;
-    pvClicks: number;
-    errCount: number;
-    httpCount: number;
-    didCutPv: boolean;
-    didCutVideo: boolean;
-    writeTimeout: any;
-    didStartVideo: boolean;
-    /** Add video frag payload data to the stored metrics
-     * @param  {} expectedVfSeq
-     * @param  {} expectedVideoLength
-     */
-    addVideoFragData(expectedVfSeq: any, expectedVideoLength: any): void;
-    /** Set the amount of page visit parts
-     * @param  {} expectedPvPart
-     */
-    setPvPart(expectedPvPart: any): void;
-    /** Increase the amount of video clicks seen in the session */
-    addVideoClick(): void;
-    /** Increase the amount of page visit clicks */
-    addPvClick(): void;
-    /** Increments the error count by 1 */
-    addError(): void;
-    /** Increments the http count by 1 */
-    addHttpEvent(): void;
-    /** Increments the http data sequence count by 1 */
-    addHttpData(): void;
-    /** Increments the http data over limit count by 1 */
-    addHttpDataOverLimit(): void;
-    /** Increments the http data drop count by content type */
-    addHttpDataDropByType(): void;
-    /** Increments the http data drop count by content length */
-    addHttpDataDropByLength(): void;
-    /** Increments the http data payload collected count */
-    addHttpDataPayloadCount(): void;
-    /** Set that the video was cut/blocked due to size constraints */
-    setDidCutVideo(): void;
-    /** Set that the video was started */
-    setDidStartVideo(): void;
-    /** Set that the page visit was cut/blocked due to size constraints */
-    setDidCutPv(): void;
-    /**
-     * Sets up all the listeners that noibujs should listen to before storing
-     * our metrics to localstorage
-     */
-    _setupListeners(): void;
-    /** posts the metrics to metroplex if client is active
-     * @param  {} eventName
-     */
-    _postMetricsIfActive(eventName: any): void;
-    /** posts the metrics to metroplex using the beacon API
-     */
-    postMetrics(): Promise<void>;
-}

package/dist/src/api/storedPageVisit.d.ts

@@ -1,40 +0,0 @@
-import { CompletePageVisit, PageVisitFrag, PageVisitInfo, SlidingMessage } from '../../types/Metroplex.types';
-import { Singleton } from '../monitors/BaseMonitor';
-/**
- * This class holds the final page visit. It flushes it to storage and then
- * finally sends it to Metroplex via the post route when the next page is loaded
- */
-export default class StoredPageVisit extends Singleton {
-    /**
-     * Creates a new instance of StoredPageVisit
-     */
-    constructor();
-    /**
-     * Check if the events contain a click or location change. If they do then write the retry
-     * queue (which contains the metroplex msg sent above) to storage
-     */
-    checkAndStoreRetryQueue(retryMessageQueue: SlidingMessage[], pvInfo: PageVisitInfo): void;
-    /** Writes the page visit frags in the retry queue to storage
-     */
-    writePageVisitsFromRetryQueue(retryMessageQueue: SlidingMessage[], pvInfo: PageVisitInfo): void;
-    /** Write the given page visit frags to storage
-     */
-    _writePageVisitFrags(pageVisitFrags: PageVisitFrag[], pvInfo: PageVisitInfo): Promise<void>;
-    /**
-     * Read the stored page visit from storage, create a complete page visit object
-     * and then post that to Metroplex
-     */
-    _getPostData(): Promise<CompletePageVisit>;
-    /**
-     * Creates and tries to resolve a promise that posts the previous page visit
-     * to Metroplex from storage
-     */
-    _postPreviousPageVisit(): void;
-    /**
-     * Remove the storage item and set flushed to true after they have
-     * been posted to metroplex
-     */
-    _updateStorageFlushed(): void;
-    /** Returns a promise that resolves to post the page visit in storage to Metroplex */
-    _getPostPageVisitPromise(): Promise<void>;
-}

package/dist/src/const_matchers.d.ts

@@ -1 +0,0 @@
-export function WHITELIST_TEXT_REGEX_STRING(): string;