noibu-react-native 0.0.4 → 0.0.6

package/README.md

@@ -41,7 +41,7 @@ import React from 'react';
 import { View, Text } from 'react-native';
 import { ErrorBoundary, setupNoibu } from 'noibu-react-native';
 
-setupNoibu({ domain: 'react-native-app.myshop.com' })
+setupNoibu({ domain: 'react-native-app.myshop.com' });
 
 export default function App() {
   return (
@@ -64,6 +64,26 @@ That's it! First time the module is set up, it runs an init and starts listening
 
 ## Configuration
 
+`setupNoibu(config): void` method accepts following parameters:
+ - `config` which consists of
+   - `@property domain {string}` - indicates which Noibu dashboard session recordings should go to ([learn more about domains](https://help.noibu.com/hc/en-us/articles/4846518088845-Domains-Overview))
+   - `@property [blockedElements] {string[]}` - lets you specify component ids to be ignored by SDK when collecting error information
+   - `@property [enableHttpDataCollection] {boolean}` - indicates whether SDK should collect HTTP information like headers or body from requests
+   - `@property [listOfUrlsToCollectHttpDataFrom] {string[]}` - is an allow list of URLs to allow HTTP data collection from, works best with `enableHttpDataCollection` enabled
+
+Example: 
+```js
+setupNoibu({
+   domain: 'react-native-app.myshop.com',
+   enableHttpDataCollection: true,
+   listOfUrlsToCollectHttpDataFrom: [
+      'https://react-native-app.myshop.com/backend',
+      'https://example.com/some-path/',
+   ],
+   blockedElements: ['sensitive-info']
+});
+```
+
 ErrorBoundary component has a few useful properties described here https://help.noibu.com/hc/en-us/articles/9562254753677-Noibu-React-SDK under the section _ErrorBoundary Class -> Props_.
 
 ## API Reference
@@ -72,7 +92,7 @@ Apart from exporting ErrorBoundary component, noibu-react-native module has Noib
 
 ### `NoibuJS`
 
-#### `requestHelpCode(alert?: boolean): Promise<string>`
+#### `requestHelpCode(): Promise<string>`
 
 Requests a help code from the HelpCode instance. To read more about help codes, refer to the page: https://help.noibu.com/hc/en-us/articles/14051818012813-How-to-Find-a-Session-with-Help-Code
 
@@ -144,11 +164,6 @@ import { NoibuJS } from 'noibu-react-native';
 NoibuJS.addJsSdkError(new Error('My Error'), 'myModule.js');
 ```
 
-## Publishing
-
-Ci has a job to publish a new version of the SDK, but has to be manually triggered. 
-Docker image used for publishing is noibujssdkci:0.2
-
 ## Contributing
 
 You can contribute by checking out the project page and open issues. https://linear.app/noibu/project/react-native-sdk-5ccd19a3343a

package/dist/api/clientConfig.d.ts

@@ -0,0 +1,101 @@
+import { SEVERITY } from '../constants';
+import { CustomerConfig, StoredConfig } from '../types/Config';
+/**
+ * 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 {
+    private readonly pageVisitId;
+    private browserId;
+    private pageVisitSeq;
+    private lastActiveTime;
+    private noibuErrorURL;
+    private cltErrorPostCounter;
+    private readonly maxSocketInactiveTime;
+    private static instance;
+    private static noibuErrorURL;
+    customerDomain: string;
+    isClientDisabled: boolean;
+    readonly listOfUrlsToCollectHttpDataFrom: CustomerConfig['listOfUrlsToCollectHttpDataFrom'];
+    readonly enableHttpDataCollection: CustomerConfig['enableHttpDataCollection'];
+    readonly blockedElements: CustomerConfig['blockedElements'];
+    /**
+     * Creates a ClientConfig singleton instance
+     */
+    constructor(noibuErrorURL: string, customerConfig: CustomerConfig);
+    /** Configures the singleton instance */
+    static configureInstance({ noibuErrorURL, customerConfig, }: {
+        noibuErrorURL: string;
+        customerConfig: CustomerConfig;
+    }): void;
+    /**
+     * gets the singleton instance
+     * @returns {ClientConfig}
+     */
+    static getInstance(): ClientConfig;
+    /** 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): 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 | null>;
+    /**
+     *  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>;
+    /**
+     * 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: string, 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;
+}