noibu-react-native 0.2.5 → 0.2.7

package/dist/src/monitors/http-tools/HTTPDataBundler.d.ts

@@ -1,112 +0,0 @@
-import { WrappedXMLHttpRequest } from '../../../types/WrappedObjects';
-import { HTTPDataBundle } from '../../../types/PageVisitEvents.types';
-import { Singleton } from '../BaseMonitor';
-/** Bundles HTTP payloads and headers */
-export declare class HTTPDataBundler extends Singleton {
-    contentTypeReadableRegex: RegExp;
-    hostname: string;
-    initialURLPartsReversed: string[];
-    httpDataCollectionEnabled: boolean;
-    httpDataAllowedRelativeRegex: RegExp | null;
-    httpDataAllowedAbsoluteRegex: RegExp | null;
-    /**
-     * Creates an instance of the ClickMonitor instance
-     */
-    constructor();
-    /**
-     * Builds the HTTP payload allowed regexes for full and relative URLs
-     * @param allowedURLs A list of allowed URLs
-     * @param absolute Use only absolute URLs if true, use only relative URL if false
-     * @returns a regex of allowed URLs
-     */
-    private static buildAllowedRegex;
-    /**
-     * Takes an iterator and returns a map of strings representing headers.
-     * param {object} headersIterable any iterable object
-     * returns a map of strings (as expected by metroplex) representing HTTP
-     * request or response headers
-     */
-    static headersMapFromIterable(headersIterable: Iterable<any[]>): Map<any, any>;
-    /**
-     * Takes a string of headers with 'name: value' and returns
-     * a map of strings representing headers.
-     * headersString is all the headers in one string
-     * returns a map of strings (as expected by metroplex) representing HTTP
-     * request or response headers
-     */
-    static headersMapFromString(headersString: unknown): Map<string, string>;
-    /**
-     * For an XHR object, checks the responseType property and handles the response or
-     * responseText property accordingly to return a string representation of the response.
-     * @returns a string representation of the response, or null if this fails.
-     */
-    static getResponseStringFromXHR(xhr: WrappedXMLHttpRequest): Promise<any>;
-    /**
-     * Builds an HTTP Data bundle
-     */
-    bundleHTTPData(url: string, requestHeaders: Map<string, string> | undefined, rawRequestPayload: any, responseHeaders: Map<string, string>, rawResponsePayload: any, method: string, isError: boolean): HTTPDataBundle | null;
-    /**
-     * Validates a request based on the URL and method. When enabled, will handle
-     * de-duping the requests
-     */
-    isValidRequest(method: unknown): boolean;
-    /**
-     * Checks two things: that the URL is either on the same domain (or an address relative to the
-     * current domain), and also checks that the config http_data_collection flag is enabled.
-     * @param {string} url
-     * @returns boolean indicating whether the URL passed is either relative (in which case it is
-     * inherently on the current domain) or matches the current domain.
-     */
-    shouldContinueForURL(url: any): boolean;
-    /**
-     * Determines if the URL is absolute or relative
-     * returns boolean indicating whether the URL passed is either absolute or relative
-     */
-    static isAbsoluteURL(url: unknown): boolean;
-    /**
-     * Checks whether HTTP payloads can be collected on this URL
-     * returns boolean indicating whether HTTP payloads can be collected on this URL
-     */
-    shouldCollectPayloadForURL(url: any): boolean;
-    /**
-     * Double checks content length if we couldn't read the headers, and redacts PII
-     * returns the restricted payload
-     */
-    restrictPayload(payload: string, url: string, isError: boolean): string;
-    /**
-     * Returns true if the content-length header is of acceptable size.
-     * Too big gets rejected
-     * If the headers are not found, check actual content for length
-     * @param  {Headers} headers
-     * @returns boolean true if acceptable to collect
-     */
-    contentLengthAcceptable(headers: Map<string, string>, isError: boolean): boolean;
-    /**
-     * Returns true if the content type according to the headers is valid for collection.
-     * Also returns assumed true if content type is not stated in headers.
-     * @param {Map} headersMap
-     * @returns boolean true if acceptable to collect
-     */
-    private contentTypeAcceptable;
-    /**
-     * Returns a descriptive string if we have to drop payload based on the length
-     * or type listed in the headers passed. Returns an empty string otherwise.
-     */
-    getReasonPayloadIsDropped(headers: any, isError: boolean): string;
-    /**
-     * Returns content length from the headers, if available.
-     * If headers are not found or length is not a number, return -1
-     */
-    contentLength(headersObject: any): number;
-    /**
-     * Accepts a value that could be any type used as a request payload,
-     * and returns a string representation, or null if this fails.
-     */
-    stringFromRequestBody(value: any, requestHeaders?: Map<string, string>): any;
-    /**
-     * Removes possible PII from headers.
-     * @param {Map} dirtyHeaders a Map of HTTP response or request headers
-     * @returns {Map|null} a map of headers with PII redacted
-     */
-    removePIIHeaders(dirtyHeaders: Map<string, string> | undefined): typeof dirtyHeaders | null;
-}

package/dist/src/monitors/integrations/react-native-navigation-integration.d.ts

@@ -1,20 +0,0 @@
-import { NavigationIntegration } from '../../../types/NavigationIntegration';
-import { NavigationRoot } from 'react-native-navigation/lib/dist/src/Navigation';
-/**
- * react-native-navigation adapter
- */
-export declare class ReactNativeNavigationIntegration implements NavigationIntegration {
-    private stack;
-    private stackPointers;
-    /**
-     * attaches provided listeners to the integration
-     */
-    register(navigation: NavigationRoot, onNavigation: (breadcrumbs: string[]) => void): void;
-    /**
-     * Listens to ComponentWillAppear events, keeps track of visited screens and
-     * pops them if the same page is visited to prevent cycles
-     * @param onNavigation
-     * @private
-     */
-    private getListener;
-}

package/dist/src/pageVisit/EventDebouncer.d.ts

@@ -1,24 +0,0 @@
-import { Singleton } from '../monitors/BaseMonitor';
-/**
- * Singleton class responsible for debouncing all events
- * that are registered
- */
-export declare class EventDebouncer extends Singleton {
-    private readonly eventsToDebounce;
-    /**
-     * Creates an instance of EventDebouncer
-     */
-    constructor();
-    /**
-     * Creates an event object with the event and the time it was added then pushes
-     * that event object to the queue of events waiting to be debounced.
-     */
-    addEvent(event: any, type: keyof typeof this.eventsToDebounce, occurredAt?: number): void;
-    /**
-     * Adds the events from the object to the page visit and sets up a timer
-     * to send the events if no more are received without the timeout
-     */
-    _debouncePvEvents(type: string): void;
-    /** Sets up the page hide handler to try to push remaining events in the queues */
-    _setupUnloadHandler(): void;
-}

package/dist/src/pageVisit/pageVisit.d.ts

@@ -1,52 +0,0 @@
-/**
- * Singleton class to hold all the information
- * about the gathered errors throught the session
- */
-export class PageVisit {
-    /**
-     * creates a PV object
-     */
-    static configureInstance(): void;
-    /** gets the singleton instance
-     * @returns {PageVisit}
-     */
-    static getInstance(): PageVisit;
-    /**
-     * Creates a page visit frag from an events array and part counter. Appends
-     * the end time field and returns the frag
-     * @param  {} pvEvents
-     * @param  {} partCounter
-     */
-    static makePageVisitFrag(pvEvents: any, partCounter: any): import("../../types/Metroplex.types").PageVisitFrag | import("../../types/Metroplex.types").VideoFrag;
-    partCounter: number;
-    pvMap: {};
-    pvEventLength: number;
-    visibilityChangedCounter: number;
-    totalPvEventLength: number;
-    inDebounceHandle: number;
-    isInAcceleratedPvPostMode: boolean;
-    /** adds page visit events into the current page visit map and then sends a page visit message
-     * @param  {} eventObjects
-     * @param  {} type
-     */
-    addPageVisitEvents(eventObjects: any, type: any): void;
-    /**
-     * adds the page visit event into the current page visit map and then sends a page visit message
-     * returns the the key to access this event in the map
-     * @param  {} eventObj
-     * @param  {} type
-     */
-    addPageVisitEvent(eventObj: any, type: any): string | number[];
-    /**
-     * adds a new page visit event into the current page visit map and returns the
-     * the key to access this event in the map
-     * @param  {} eventObj
-     * @param  {} type
-     */
-    _addPageVisitEvent(eventObj: any, type: any): string | number[];
-    /**
-     * _sendPageVisitMessage will reset the buffer and post the current
-     * content to metroplex
-     */
-    _sendPageVisitMessage(): void;
-}

package/dist/src/pageVisit/pageVisitEventError.d.ts

@@ -1,15 +0,0 @@
-/**
- * gets the onURL of a string, defaulting to the location of the webpage
- */
-export function getOnURL(realOnURL: any): string;
-/**
- * determines if an error is a collect error
- * @param  {} pvError
- */
-export function isErrorCollectedByNoibu(pvError: any): boolean;
-/** Saves the error to the ErrorQueue
- * @param  {} type
- * @param  {} payload
- * @param  {} [httpDataSeqNum]
- */
-export function saveErrorToPagevisit(type: any, payload: any, httpDataSeqNum?: any): void;

package/dist/src/pageVisit/pageVisitEventHTTP.d.ts

@@ -1,25 +0,0 @@
-import { HTTPDataBundle, PVEventHTTPPayload } from '../../types/PageVisitEvents.types';
-/**
- * Determines if a response is a failure
- */
-export declare function isHttpCodeFailure(code: unknown): boolean;
-/** Class representing a PageVisitEventHTTP */
-export declare class PageVisitEventHTTP {
-    httpEvent: PVEventHTTPPayload;
-    httpData: HTTPDataBundle | null;
-    isGqlError: boolean;
-    /**
-     * Creates an instance of the http event for the pv
-     */
-    constructor(httpEvent: Partial<PVEventHTTPPayload>, httpData: HTTPDataBundle | null, isGqlError?: boolean);
-    /** Saves the HTTP event to the pageVisit Queue */
-    saveHTTPEvent(): void;
-    /**
-     * Checks if sending data is allowed based on the HTTP status code and count.
-     * status - The HTTP status code to evaluate.
-     * count - The count of events to consider.
-     * isGqlError - Whether the context is considered as a GQL error.
-     * Returns `true` if sending data is allowed, `false` otherwise.
-     */
-    static isSendAllowed(status: number, count: number, isGqlError?: boolean): boolean;
-}

package/dist/src/pageVisit/userStep.d.ts

@@ -1,5 +0,0 @@
-/**
- * updates the payload of a user step in order to stringify the css class
- * @param  {} payload
- */
-export function updatePayload(payload: any): any;

package/dist/src/react/ErrorBoundary.d.ts

@@ -1,72 +0,0 @@
-import * as React from 'react';
-export declare const UNKNOWN_COMPONENT = "unknown";
-export type FallbackRender = (errorData: {
-    error: Error;
-    componentStack: string | null;
-    eventId: string | null;
-    resetError(): void;
-}) => React.ReactElement;
-export type ErrorBoundaryProps = {
-    children?: React.ReactNode | (() => React.ReactNode);
-    /**
-     * A fallback component that gets rendered when the error boundary encounters an error.
-     *
-     * Can either provide a React Component, or a function that returns React Component as
-     * a valid fallback prop. If a function is provided, the function will be called with
-     * the error, the component stack, and a function that resets the error boundary on error.
-     *
-     */
-    fallback?: React.ReactElement | FallbackRender;
-    /** Called when the error boundary encounters an error */
-    onError?(error: Error, componentStack: string, eventId: string): void;
-    /** Called on componentDidMount() */
-    onMount?(): void;
-    /** Called if resetError() is called from the fallback render props function  */
-    onReset?(error: Error | null, componentStack: string | null, eventId: string | null): void;
-    /** Called on componentWillUnmount() */
-    onUnmount?(error: Error | null, componentStack: string | null, eventId: string | null): void;
-};
-export type ErrorBoundaryState = {
-    componentStack: React.ErrorInfo['componentStack'] | null;
-    error: Error | null;
-    eventId: string | null;
-};
-/**
- * @description A ErrorBoundary component that logs errors to Noibu. Requires React >= 16.
- * @extends {Component<ErrorBoundaryProps, ErrorBoundaryState>}
- */
-declare class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundaryState> {
-    state: ErrorBoundaryState;
-    /**
-     * Lifecycle hook on mount
-     * @returns void
-     */
-    componentDidMount(): void;
-    /**
-     *
-     * Handler for all errors that happen in a wrapped component
-     * @param  {Error&{cause?:Error}} error
-     * @param  {React.ErrorInfo} {componentStack}
-     * @returns void
-     */
-    componentDidCatch(error: Error & {
-        cause?: Error;
-    }, { componentStack }: React.ErrorInfo): void;
-    /**
-     *  * Lifecycle hook on unmount
-     * @returns void
-     */
-    componentWillUnmount(): void;
-    /**
-     * Callback from fallback to reset the error boundary
-     * @param  {} =>void=(
-     */
-    resetErrorBoundary: () => void;
-    /**
-     *
-     * Renders the fallback ui
-     * @returns {React.ReactNode}
-     */
-    render(): React.ReactNode;
-}
-export { ErrorBoundary };

package/dist/src/sessionRecorder/nativeSessionRecorderSubscription.d.ts

@@ -1,79 +0,0 @@
-/**
- * The level of logging to show in the device logcat stream.
- */
-export declare enum LogLevel {
-    Verbose = "Verbose",
-    Debug = "Debug",
-    Info = "Info",
-    Warning = "Warning",
-    Error = "Error",
-    None = "None"
-}
-/**
- * The configuration that will be used to customize the session recording behaviour.
- *
- * @param userId        [OPTIONAL default = null] A custom identifier for the current user. If passed as null, the user id
- *                      will be auto generated. The user id in general is sticky across sessions.
- *                      The provided user id must follow these conditions:
- *                          1. Cannot be an empty string.
- *                          2. Should be base36 and smaller than "1Z141Z4".
- * @param logLevel      [OPTIONAL default = LogLevel.None] The level of logging to show in the device logcat stream.
- * @param allowMeteredNetworkUsage  [OPTIONAL default = false] Allows uploading session data to the servers on device metered network.
- * @param enableWebViewCapture    [OPTIONAL default = true] Allows Noibu - Session recorder to capture the web views DOM content.
- * @param allowedDomains    [OPTIONAL default = ["*"]] The whitelisted domains to allow Noibu - Session recorder to capture their DOM content.
- *                          If it contains "*" as an element, all domains will be captured.
- * @param disableOnLowEndDevices [OPTIONAL default = false] Disable Noibu - Session recorder on low-end devices.
- * @param maximumDailyNetworkUsageInMB [OPTIONAL default = null] Maximum daily network usage for Noibu - Session recorder (null = No limit). When the limit is reached, Noibu - Session recorder will turn on lean mode.
- */
-export interface SessionRecorderConfig {
-    userId?: string | null;
-    logLevel?: LogLevel;
-    allowMeteredNetworkUsage?: boolean;
-    enableWebViewCapture?: boolean;
-    allowedDomains?: string[];
-    disableOnLowEndDevices?: boolean;
-    maximumDailyNetworkUsageInMB?: number;
-}
-/**
- * Initializes the Noibu - Session recording SDK if the API level is supported.
- * param projectId     [REQUIRED] The session recording project id to send data to.
- * param config   [OPTIONAL] The sessionreplay config, if not provided default values are used.
- */
-export declare function initialize(projectId: string, config?: SessionRecorderConfig): void;
-/**
- * Sets a custom user id that can be used to identify the user. It has less
- * restrictions than the userId parameter. You can pass any string and
- * you can filter on it on the dashboard side. If you need the most efficient
- * filtering on the dashboard, use the userId parameter if possible.
- * <p>
- * Note: custom user id cannot be null or empty, or consists only of whitespaces.
- * </p>
- * @param customUserId   The custom user id to set.
- */
-export declare function setCustomUserId(customUserId: string): void;
-/**
- * Sets a custom session id that can be used to identify the session.
- * <p>
- * Note: custom session id cannot be null or empty, or consists only of whitespaces.
- * </p>
- * @param customSessionId   The custom session id to set.
- */
-export declare function setCustomSessionId(customSessionId: string): void;
-export type RecorderEvent = import('./types').RecorderEvent;
-export type UnsubscribeFn = import('./types').UnsubscribeFn;
-/**
- * Subscribes to a native event emitted by the Noibu Session Recorder.
- *
- * This function listens for the `noibuRecordingEvent` emitted from the native layer (only on Android)
- * and invokes the provided callback whenever the event occurs. If the platform is not Android,
- * the function will do nothing and return a no-op unsubscribe function.
- *
- * @param {function(RecorderEvent): void} callback - A callback function that will be invoked with
- * the event data whenever the `noibuRecordingEvent` is emitted.
- *
- * @returns {UnsubscribeFn} A function to unsubscribe from the event. On Android, this will remove
- * the event listener. On other platforms, it will be a no-op.
- *
- * @throws {Error} If the Noibu Session Recorder is not initialized before calling this function.
- */
-export declare function subscribeToNativeEvent(callback: (event: RecorderEvent) => void): UnsubscribeFn;

package/dist/src/sessionRecorder/sessionRecorder.d.ts

@@ -1,60 +0,0 @@
-import { RecorderEvent } from './nativeSessionRecorderSubscription';
-/** Singleton class to record user sessions */
-export default class SessionRecorder {
-    private static instance;
-    private eventBuffer;
-    private vfCounter;
-    private didSetupRecorder;
-    private isVideoLengthNegativeInvalid;
-    private lastFragPostTimestamp;
-    private pauseTimeout;
-    private lastRecordedTimestamp;
-    private firstRecordedTimestamp;
-    private recordStopper;
-    private freezingEvents;
-    /**
-     * Creates an instance of the session recorder
-     */
-    constructor();
-    /**
-     * Setups the SessionRecorder instance for usage
-     */
-    static getInstance(): SessionRecorder;
-    /** Sets up the page hide handler to try to push remaining video events */
-    setupUnloadHandler(): void;
-    /** Sets up the post metrics handler to potentially log a debug message */
-    setupPostMetricsHandler(): void;
-    /**
-     * Starts recording the user session
-     */
-    recordUserSession(): Promise<void>;
-    /**
-     * handleNewRRwebEvent will process each upcoming.
-     * rrweb event. It will make sure that the current buffer
-     * is updated with the latest events and post the contents
-     * of the buffer if it exceeds max size
-     */
-    handleRecorderEvent(recorderEvent: RecorderEvent): Promise<void>;
-    /**
-     * Compress event
-     */
-    private pack;
-    private static compress;
-    /** builds a log message with debug info
-     */
-    buildDebugMessage(eventName: string, totalVideoTime: number, sessionLength: number): string;
-    /**
-     * handleFragPost communicates with the Metroplex socket
-     * to post video fragments when needed. It also handles
-     * necessary management of the buffer and it's related
-     * variables
-     */
-    handleFragPost(): Promise<void>;
-    /**
-     * unfreeze forcefully resumes recording events in case it was frozen
-     * waiting for user events
-     */
-    unfreeze(): Promise<void>;
-    /** stops recording */
-    private freeze;
-}

package/dist/src/sessionRecorder/types.d.ts

@@ -1,91 +0,0 @@
-type Color = {
-    a: number;
-    b: number;
-    r: number;
-    g: number;
-};
-type Paint = {
-    strokeJoin: number;
-    strokeWidth: number;
-    strokeCap: number;
-    color: Color;
-    dither: boolean;
-    blendMode: number;
-    style: number;
-    antiAlias: boolean;
-    strokeMiter: number;
-};
-type Rect = {
-    top: number;
-    left: number;
-    bottom: number;
-    right: number;
-};
-type Command = {
-    name?: string;
-    id?: number;
-    type: string;
-    isClipRectSource?: boolean;
-    rect?: Rect;
-    paintIndex?: number;
-    op?: number;
-    antiAlias?: boolean;
-    matrix?: number[];
-};
-type ViewNode = {
-    viewX: number;
-    visible: boolean;
-    processedText$delegate: {
-        _value: any;
-        initializer: any;
-    };
-    viewY: number;
-    viewWidth: number;
-    clickable: boolean;
-    viewHeight: number;
-    isMasked: boolean;
-    type: string;
-    renderNodeId: number;
-    isWebView: boolean;
-    ignoreClicks: boolean;
-    children: ViewNode[];
-    width: number;
-    x: number;
-    y: number;
-    id: number;
-    text: string;
-    height: number;
-    backgroundColor?: number;
-};
-type ViewHierarchy = {
-    root: ViewNode;
-    visibleFragments: any[];
-    timestamp: number;
-};
-type SubPicture = {
-    subPictures: any[];
-    images: any[];
-    screenWidth: number;
-    textBlobs: any[];
-    density: number;
-    vertices: any[];
-    screenHeight: number;
-    activityName: string;
-    paints: Paint[];
-    typefaces: any[];
-    viewHierarchy: ViewHierarchy;
-    paths: any[];
-    activityHashCode: number;
-    commands: Command[];
-    timestamp: number;
-};
-export type RecorderEvent = {
-    message: NativeFrames;
-};
-export type NativeFrames = {
-    p: (number | boolean | SubPicture)[][];
-    a: (number[] | (number | string | string[])[])[];
-    e: (string | number)[];
-};
-export type UnsubscribeFn = () => void;
-export {};

package/dist/src/storage/rnStorageProvider.d.ts

@@ -1,23 +0,0 @@
-import StorageProvider from './storageProvider';
-/**
- * React native storage provider implementation
- */
-export default class RNStorageProvider extends StorageProvider {
-    /**
-     * Creates new instance
-     */
-    constructor();
-    /**
-     * Checks if storage is available
-     * @returns {Object}
-     */
-    static isAvailable(): Promise<{
-        result: boolean;
-        error: Error;
-    }>;
-    /**
-     * Calculates used scape
-     * @returns {Number}
-     */
-    calculateUsedSize(): Promise<number>;
-}

package/dist/src/storage/storage.d.ts

@@ -1,39 +0,0 @@
-import { IStorage, StorageValue } from '../../types/Storage';
-/**
- * Encapsulates storage api
- */
-export default class Storage implements IStorage {
-    private readonly _isRNStorageAvailable;
-    private readonly _rnStorageError;
-    private static _instance;
-    private readonly _provider;
-    private readonly _type;
-    /**
-     * Creates new instance assessing available options
-     */
-    constructor();
-    /**
-     * Singleton
-     * @returns {Storage}
-     */
-    static getInstance(): Storage;
-    /** Checks if storage is available */
-    isAvailable(): Promise<boolean>;
-    /** Loads value from storage */
-    load(key: string): Promise<string | null>;
-    /** Saves value to storage */
-    save(key: string, value: StorageValue): Promise<void>;
-    /**
-     * Removes value from storage
-     * @param {String} key
-     */
-    remove(key: string): Promise<void>;
-    /** Calculates used scape */
-    calculateUsedSize(): Promise<number>;
-    /**
-     * Returns string indicating current provider type
-     * and availability for other storage types
-     * @returns {String}
-     */
-    getDiagnoseInfo(): Promise<string>;
-}

package/dist/src/storage/storageProvider.d.ts

@@ -1,26 +0,0 @@
-import { Provider, StorageValue } from '../../types/Storage';
-/**
- * Base implementation for LocalStorage and SessionStorage
- */
-export default abstract class StorageProvider {
-    _provider: Provider;
-    /** Creates new instance based on provided provider type */
-    constructor(provider: Provider);
-    /** Checks if provider is available */
-    static isAvailable<T extends Provider>(resolver: () => T): Promise<{
-        result: boolean;
-        error: Error;
-    }>;
-    /**
-     * Loads value from storage
-     */
-    load<R = StorageValue>(key: string): Promise<string | R>;
-    /** Saves value to storage */
-    save(key: string, value: StorageValue): Promise<void>;
-    /**
-     * Removes value from storage
-     * @param {String} key
-     */
-    remove(key: string): Promise<void>;
-    abstract calculateUsedSize(): Promise<number>;
-}

package/dist/src/utils/date.d.ts

@@ -1,6 +0,0 @@
-/** Checks to see if the necessary Date functions that we use have been overwritten */
-export function isDateOverwritten(): boolean;
-/** Timestamp wrapper to properly handle timestamps
- * @param  {} timestamp
- */
-export function timestampWrapper(timestamp: any): any;

package/dist/src/utils/eventlistener.d.ts

@@ -1,8 +0,0 @@
-/** addSafeEventListener will add an event listener for the specified event
- * but will catch and log any errors encountered
- * @param  {} object to attach the listener to
- * @param  {} event to listen to
- * @param  {} callback function to call
- * @param  {} [capture] additional arguments
- */
-export function addSafeEventListener(object: any, event: any, callback: any, capture?: any): void;