noibu-react-native 0.2.6 → 0.2.8

package/README.md

@@ -27,7 +27,8 @@ Install using favourite node package manager (npm, yarn, etc.):
 npm install noibu-react-native --save
 ```
 
-Additionally, for iOS target do: 
+Additionally, for iOS target do:
+
 ```bash
 npx pod-install
 ```
@@ -65,22 +66,21 @@ 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: 
+- `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']
+  domain: 'react-native-app.myshop.com',
+  enableHttpDataCollection: true,
+  listOfUrlsToCollectHttpDataFrom: ['https://react-native-app.myshop.com/backend', 'https://example.com/some-path/'],
+  blockedElements: ['sensitive-info'],
 });
 ```
 
@@ -101,7 +101,7 @@ Requests a help code from the HelpCode instance. To read more about help codes,
 ```jsx
 import { NoibuJS } from 'noibu-react-native';
 import { useCallback, useState } from 'react';
-import { Alert, Text, Pressable, View} from 'react-native';
+import { Alert, Text, Pressable, View } from 'react-native';
 
 const AlertHelpCode = () => {
   const triggerHelpCodeAlert = useCallback(async () => {

package/android/build.gradle

@@ -67,7 +67,7 @@ def kotlin_version = getExtOrDefault("kotlinVersion")
 dependencies {
   implementation "com.facebook.react:react-native:+"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-  implementation "com.noibu:sessionreplay-recorder:0.2.0"
+  implementation "com.noibu:sessionreplay-recorder:0.2.1"
 }
 
 if (isNewArchitectureEnabled()) {

package/dist/{src/api/clientConfig.d.ts → api/ClientConfig.d.ts}

@@ -1,5 +1,4 @@
-import { SEVERITY } from '../constants';
-import { CustomerConfig, StoredConfig } from '../../types/Config';
+import { ErrorMessage, Severity } from '@noibu/metroplex-ts-bindings';
 import { Singleton } from '../monitors/BaseMonitor';
 /**
  * Singleton class to manage the client configuration
@@ -11,34 +10,33 @@ export default class ClientConfig extends Singleton {
     readonly pageVisitId: string;
     browserId: StoredConfig['BrowserId'];
     private pageVisitSeq;
-    lastActiveTime: Date;
+    private lastActiveTime;
     private readonly noibuErrorURL;
     private cltErrorPostCounter;
     private readonly maxSocketInactiveTime;
     private locationBreadcrumbs;
-    customerDomain: string;
+    private readonly customerDomain;
     isClientDisabled: boolean;
     configurationPromise: Promise<void>;
     readonly listOfUrlsToCollectHttpDataFrom: CustomerConfig['listOfUrlsToCollectHttpDataFrom'];
     readonly enableHttpDataCollection: CustomerConfig['enableHttpDataCollection'];
     readonly blockedElements: CustomerConfig['blockedElements'];
-    /**
-     * Creates a ClientConfig singleton instance
-     */
+    private alreadyPostingError;
+    /**  Error handling for constructor */
+    handleConstructorError(noibuErrorURL?: string, customerConfig?: CustomerConfig): void;
+    /** Creates a ClientConfig singleton instance */
     constructor(noibuErrorURL?: string, customerConfig?: CustomerConfig);
-    /**
-     * Convenience method to check correct setup
-     */
+    /** 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>;
+    lockClient(duration: number, msg: ErrorMessage): Promise<void>;
     /** Locks the client until the next page loads */
-    lockClientUntilNextPage(msg: string): Promise<void>;
+    lockClientUntilNextPage(msg: ErrorMessage): 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>;
+    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
@@ -52,9 +50,7 @@ export default class ClientConfig extends Singleton {
      * }
      */
     _getLsObject(): Promise<StoredConfig>;
-    /**
-     * Check if we have surpassed the last active time and the page visit seq number needs resetting
-     */
+    /** 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
@@ -88,13 +84,16 @@ export default class ClientConfig extends Singleton {
     /** gets current global url */
     get globalUrl(): string;
     /**
-     * postNoibuErrorAndOptionallyDisableClient will post errors that were thrown by collect
+     * postInternalError 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>;
+    postInternalError(errorMsg: ErrorMessage, disableClient?: boolean, severity?: Severity, keepAlive?: boolean): Promise<void>;
+    /** Returns true if the page visit is considered to be inactive */
+    isInactive(): boolean;
     /**
-     * Returns true if the page visit is considered to be inactive
+     * Wraps a function in a try catch block and posts the error if one is thrown
+     * explanation will be inserted into the error message as 'Error in {explanation}'
      */
-    isInactive(): boolean;
+    wrapInternal(explanation: string, fun: () => void): void;
 }

package/dist/api/{clientConfig.js → ClientConfig.js}

@@ -1,12 +1,24 @@
 import { __awaiter } from 'tslib';
 import uuid from 'react-native-uuid';
-import { MAX_METROPLEX_SOCKET_INNACTIVE_TIME, SEVERITY, NOIBU_BROWSER_ID_KYWRD, PV_SEQ_NUM_RESET_TIME_MINUTES, JS_ENV, MAX_PAGEVISIT_VISITED, CLIENT_LOCK_TIME_MINUTES, GET_SCRIPT_ID, GET_DEVICE_ENV, MAX_COLLECT_ERROR_LOG } from '../constants.js';
-import { stringifyJSON, getMaxSubstringAllowed, getUserAgent, makeRequest } from '../utils/function.js';
-import Storage from '../storage/storage.js';
+import '../node_modules/@noibu/metroplex-ts-bindings/dist/index.js';
+import { MAX_METROPLEX_SOCKET_INNACTIVE_TIME, GET_SCRIPT_ID, GET_DEVICE_ENV } from '../constants.js';
+import { stringifyJSON, getMaxSubstringAllowed, getUserAgent, postRequest } from '../utils/function.js';
+import Storage from '../storage/Storage.js';
 import { noibuLog } from '../utils/log.js';
 import { unwrapNoibuWrapped } from '../utils/object.js';
 import { Singleton } from '../monitors/BaseMonitor.js';
+import { Severity } from '../node_modules/@noibu/metroplex-ts-bindings/dist/Severity.js';
 
+// maximum number of page visits assigned to a single browser id
+const MAX_PAGEVISIT_VISITED = 300;
+// The amount of time to lock the client for if they have exceeded things
+// like the maximum number of pagevisits
+const CLIENT_LOCK_TIME_MINUTES = 45;
+// The amount of inactive time required for us to reset the page visit sequence numbers
+const PV_SEQ_NUM_RESET_TIME_MINUTES = 45;
+// number of errors that collect can send to metroplex before shutting himself off.
+const MAX_COLLECT_ERROR_LOG = 50;
+const NOIBU_BROWSER_ID_KYWRD = 'n_browser_data';
 /**
  * Singleton class to manage the client configuration
  * this class will be responsible for controlling the disabled
@@ -14,9 +26,18 @@ import { Singleton } from '../monitors/BaseMonitor.js';
  * storing and retrieval.
  */
 class ClientConfig extends Singleton {
-    /**
-     * Creates a ClientConfig singleton instance
-     */
+    /**  Error handling for constructor */
+    handleConstructorError(noibuErrorURL, customerConfig) {
+        const reason = {
+            msg: 'ClientConfig was not properly configured',
+            noibuErrorURL,
+            customerConfig,
+            globalUrl: this.globalUrl,
+        };
+        void this.postInternalError(reason, true, Severity.ERROR);
+        this.configurationPromise = Promise.reject(reason);
+    }
+    /** Creates a ClientConfig singleton instance */
     constructor(noibuErrorURL, customerConfig) {
         super();
         this.pageVisitId = uuid.v4();
@@ -33,26 +54,26 @@ class ClientConfig extends Singleton {
         this.maxSocketInactiveTime = MAX_METROPLEX_SOCKET_INNACTIVE_TIME;
         this.locationBreadcrumbs = [];
         this.isClientDisabled = false;
+        this.alreadyPostingError = false;
+        if (!noibuErrorURL || !customerConfig) {
+            this.handleConstructorError(noibuErrorURL, customerConfig);
+            return;
+        }
         this.noibuErrorURL = noibuErrorURL;
         this.customerDomain = customerConfig.domain;
-        this.listOfUrlsToCollectHttpDataFrom =
-            customerConfig.listOfUrlsToCollectHttpDataFrom;
-        this.enableHttpDataCollection = customerConfig.enableHttpDataCollection;
-        this.blockedElements = customerConfig.blockedElements;
-        if (!noibuErrorURL || !this.hasAllNecessaryArgs()) {
-            const reason = Object.assign({ msg: 'ClientConfig was not properly configured' }, customerConfig);
-            void this.postNoibuErrorAndOptionallyDisableClient(reason, true, SEVERITY.error);
-            this.configurationPromise = Promise.reject(reason);
+        if (!this.hasAllNecessaryArgs(customerConfig)) {
+            this.handleConstructorError(noibuErrorURL, customerConfig);
             return;
         }
+        this.listOfUrlsToCollectHttpDataFrom = customerConfig.listOfUrlsToCollectHttpDataFrom;
+        this.enableHttpDataCollection = customerConfig.enableHttpDataCollection;
+        this.blockedElements = customerConfig.blockedElements;
         // sets up this.browserId, this.isClientDisabled, this.pageVisitSeq
         this.configurationPromise = this._setupStorageVars();
     }
-    /**
-     * Convenience method to check correct setup
-     */
-    hasAllNecessaryArgs() {
-        return (!!this.customerDomain && this.globalUrl.includes(this.customerDomain));
+    /** Convenience method to check correct setup */
+    hasAllNecessaryArgs(customerConfig) {
+        return !!customerConfig.domain && this.globalUrl.includes(customerConfig.domain);
     }
     /** lockClient will disable the client script for a single pagevisit for
      * duration given in minuntes */
@@ -64,12 +85,12 @@ class ClientConfig extends Singleton {
             noibuLSObject.DisabledStatus = true;
             noibuLSObject.ClientUnlockTime = expiryTime;
             yield this._storeBrowserData(noibuLSObject);
-            yield this.postNoibuErrorAndOptionallyDisableClient(msg, true, SEVERITY.warn);
+            yield this.postInternalError(msg, true, Severity.WARN);
         });
     }
     /** Locks the client until the next page loads */
     lockClientUntilNextPage(msg) {
-        return this.postNoibuErrorAndOptionallyDisableClient(msg, true, SEVERITY.warn);
+        return this.postInternalError(msg, true, Severity.WARN);
     }
     /**  Updates the config object to store the given last active time */
     updateLastActiveTime(lastActiveTime) {
@@ -133,9 +154,7 @@ class ClientConfig extends Singleton {
             return parsedConfig;
         });
     }
-    /**
-     * Check if we have surpassed the last active time and the page visit seq number needs resetting
-     */
+    /** Check if we have surpassed the last active time and the page visit seq number needs resetting */
     _pageVisitSeqNeedsReset() {
         return __awaiter(this, void 0, void 0, function* () {
             const noibuLSObject = yield this._getClientState();
@@ -155,7 +174,7 @@ class ClientConfig extends Singleton {
         return __awaiter(this, void 0, void 0, function* () {
             const storage = Storage.getInstance();
             if (!(yield storage.isAvailable())) {
-                void this.postNoibuErrorAndOptionallyDisableClient(`Storage is unavailable, disabling client. ${yield storage.getDiagnoseInfo()}`, true, SEVERITY.error);
+                void this.postInternalError({ msg: `Storage is unavailable, disabling client.`, diagnosis: yield storage.getDiagnoseInfo() }, true, Severity.ERROR);
                 return;
             }
             // getting the current content of the storage
@@ -175,11 +194,6 @@ class ClientConfig extends Singleton {
             // Update the LS object values before storing it for the next page visit
             noibuLSObject.CurrentPageVisitCount += 1;
             noibuLSObject.LastActive = new Date();
-            // Expose page visit ID in storage for use by Trailbreaker video tests
-            // This will be done for the testvideo and lambdavideo bundles used by Trailbreaker
-            if (JS_ENV().includes('video')) {
-                noibuLSObject.pvId = this.pageVisitId;
-            }
             // if we have reached the max page visits for a browser id then
             // we disabled collect for 45 minutes
             if (noibuLSObject.CurrentPageVisitCount >= MAX_PAGEVISIT_VISITED) {
@@ -190,7 +204,7 @@ class ClientConfig extends Singleton {
                 // setting the lock time
                 noibuLSObject.ClientUnlockTime = expiryTime;
                 noibuLSObject.DisabledStatus = true;
-                yield this.postNoibuErrorAndOptionallyDisableClient(`Hit max page visits, disabling client for ${CLIENT_LOCK_TIME_MINUTES}mins`, true, SEVERITY.error);
+                yield this.postInternalError({ msg: `Hit max page visits, disabling client for ${CLIENT_LOCK_TIME_MINUTES}mins` }, true, Severity.ERROR);
             }
             // we now check if we successfully saved the data
             const savedData = yield this._storeBrowserData(noibuLSObject);
@@ -198,7 +212,7 @@ class ClientConfig extends Singleton {
             // error happened, thus we disable collect.
             if (!savedData.BrowserId) {
                 // we do not set a lock expiry date here since we cannot store to storage
-                void this.postNoibuErrorAndOptionallyDisableClient(`Null browser in storage, disabling client`, true, SEVERITY.error);
+                void this.postInternalError({ msg: `Null browser in storage, disabling client` }, true, Severity.ERROR);
                 this.browserId = '';
             }
         });
@@ -213,8 +227,7 @@ class ClientConfig extends Singleton {
         return __awaiter(this, void 0, void 0, function* () {
             const newConfigData = yield this._getLsObject();
             // if the lock expired, we remove the lock period and enable the client
-            if (newConfigData.ClientUnlockTime &&
-                new Date(newConfigData.ClientUnlockTime) <= new Date()) {
+            if (newConfigData.ClientUnlockTime && new Date(newConfigData.ClientUnlockTime) <= new Date()) {
                 newConfigData.ClientUnlockTime = undefined;
                 newConfigData.DisabledStatus = false;
                 yield this._storeBrowserData(newConfigData);
@@ -237,18 +250,12 @@ class ClientConfig extends Singleton {
      *   and persisted throughout a session
      */
     _generateNewBrowserData() {
-        const noibuBrowserData = {
+        return {
             DisabledStatus: false,
             BrowserId: uuid.v4(),
             CurrentPageVisitCount: 0,
             LastActive: new Date(),
         };
-        // Expose page visit ID in storage for use by Trailbreaker video tests
-        // This will be done for the testvideo and lambdavideo bundles used by Trailbreaker
-        if (JS_ENV().includes('video')) {
-            noibuBrowserData.pvId = this.pageVisitId;
-        }
-        return noibuBrowserData;
     }
     /**
      * _storeBrowserData will store the passed object in storage.
@@ -262,7 +269,10 @@ class ClientConfig extends Singleton {
                 return data;
             }
             catch (e) {
-                yield this.postNoibuErrorAndOptionallyDisableClient(`Error writing browser data to storage, disabling client: ${e.message}, ${yield storage.getDiagnoseInfo()}`, true, SEVERITY.error);
+                yield this.postInternalError({
+                    msg: 'Error writing browser data to storage, disabling client: ' + e.message,
+                    diagnosis: yield storage.getDiagnoseInfo(),
+                }, true, Severity.ERROR);
                 // sending empty fields if we encountered errors while storing in the LS
                 return this._generateNewBrowserData();
             }
@@ -285,35 +295,33 @@ class ClientConfig extends Singleton {
         return getMaxSubstringAllowed(globalUrl.toString());
     }
     /**
-     * postNoibuErrorAndOptionallyDisableClient will post errors that were thrown by collect
+     * postInternalError 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_1) {
-        return __awaiter(this, arguments, void 0, function* (errorMsg, disableClient = false, severity = SEVERITY.error, keepAlive = false) {
-            noibuLog('postNoibuErrorAndOptionallyDisableClient', {
-                errorMsg,
-                disableClient,
-                severity,
-                keepAlive,
-            });
-            if (this.isClientDisabled) {
+    postInternalError(errorMsg_1) {
+        return __awaiter(this, arguments, void 0, function* (errorMsg, disableClient = false, severity = Severity.ERROR, keepAlive = false) {
+            if (this.alreadyPostingError || this.isClientDisabled || severity === Severity.WARN) {
                 return;
             }
             if (disableClient) {
                 this.isClientDisabled = true;
             }
-            if (severity === SEVERITY.warn) {
-                // don't log warning messages by default, as a cost savings
-                return;
-            }
+            this.alreadyPostingError = true;
+            /** Don't use noibuErr here since we end up in recursion due to RN log intercept in debug mode */
+            noibuLog('postInternalError', {
+                errorMsg,
+                disableClient,
+                severity,
+                keepAlive,
+            });
             const collectError = {
                 browserId: this.browserId || '',
                 pageVisitId: this.pageVisitId,
                 scriptId: GET_SCRIPT_ID(),
                 ua: yield getUserAgent(),
                 deviceEnv: GET_DEVICE_ENV(),
-                error: stringifyJSON(errorMsg),
+                msg: stringifyJSON(errorMsg),
             };
             // if the page visits sends more errors than the
             // allowed threshold we disable the client
@@ -329,7 +337,7 @@ class ClientConfig extends Singleton {
                 this.isClientDisabled = true;
                 // end of lock
                 // overriding the message to be an alert that we are shutting collect off.
-                collectError.error = `Shutting collect off, we reached the maximum limit of collect errors sent.`;
+                collectError.msg = `Shutting collect off, we reached the maximum limit of collect errors sent.`;
             }
             const errorContent = {
                 url: this.globalUrl,
@@ -340,7 +348,7 @@ class ClientConfig extends Singleton {
                 'content-type': 'application/json',
             };
             if (!keepAlive) {
-                makeRequest('POST', this.noibuErrorURL, errorContent, headers, 2000, false).catch(() => {
+                postRequest(this.noibuErrorURL, errorContent, headers, false, 2000).catch(() => {
                     // we do nothing and let this error silently fail
                 });
             }
@@ -354,19 +362,30 @@ class ClientConfig extends Singleton {
                 });
             }
             // only increment if this was an actual error, not a warning or otherwise
-            if (severity === SEVERITY.error) {
+            if (severity === Severity.ERROR) {
                 this.cltErrorPostCounter += 1;
             }
+            this.alreadyPostingError = false;
         });
     }
-    /**
-     * Returns true if the page visit is considered to be inactive
-     */
+    /** Returns true if the page visit is considered to be inactive */
     isInactive() {
         const someTimeAgo = new Date();
         someTimeAgo.setSeconds(someTimeAgo.getSeconds() - this.maxSocketInactiveTime);
         return this.lastActiveTime < someTimeAgo;
     }
+    /**
+     * Wraps a function in a try catch block and posts the error if one is thrown
+     * explanation will be inserted into the error message as 'Error in {explanation}'
+     */
+    wrapInternal(explanation, fun) {
+        try {
+            fun();
+        }
+        catch (error) {
+            this.postInternalError({ msg: `Error in ${explanation}`, error }, false, Severity.ERROR);
+        }
+    }
 }
 
 export { ClientConfig as default };

package/dist/{src/api/helpCode.d.ts → api/HelpCode.d.ts}

@@ -4,20 +4,13 @@ import { Singleton } from '../monitors/BaseMonitor';
  */
 export default class HelpCode extends Singleton {
     private requestContext;
-    /**
-     * Constructs instance and sets up event listeners
-     */
+    /** 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.
      */
+    requestHelpCode(): Promise<string | null>;
+    /** Handles the received help code event. */
     receiveHelpCode(event: CustomEvent<string>): void;
 }

package/dist/api/{helpCode.js → HelpCode.js}

@@ -1,16 +1,15 @@
 import { __awaiter } from 'tslib';
-import MetroplexSocket from './metroplexSocket.js';
-import { SEVERITY } from '../constants.js';
-import ClientConfig from './clientConfig.js';
+import MetroplexSocket from './MetroplexSocket.js';
+import ClientConfig from './ClientConfig.js';
 import { Singleton } from '../monitors/BaseMonitor.js';
+import '../node_modules/@noibu/metroplex-ts-bindings/dist/index.js';
+import { Severity } from '../node_modules/@noibu/metroplex-ts-bindings/dist/Severity.js';
 
 /**
  * HelpCode class is responsible for help code feature related functionality
  */
 class HelpCode extends Singleton {
-    /**
-     * Constructs instance and sets up event listeners
-     */
+    /** Constructs instance and sets up event listeners */
     constructor() {
         super();
         this.requestContext = null;
@@ -19,9 +18,6 @@ class HelpCode extends Singleton {
     /**
      * 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() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -46,16 +42,14 @@ class HelpCode extends Singleton {
             return this.requestContext.promise;
         });
     }
-    /**
-     * Handles the received help code event.
-     */
+    /** Handles the received help code event. */
     receiveHelpCode(event) {
         var _a, _b;
         if (this.requestContext === null) {
             const { success, data } = event.detail;
             if (!success) {
-                const message = `Noibu help code is not available due to ${data}`;
-                ClientConfig.getInstance().postNoibuErrorAndOptionallyDisableClient(message, false, SEVERITY.error);
+                const msg = `Noibu help code is not available due to ${data}`;
+                ClientConfig.getInstance().postInternalError({ msg }, false, Severity.ERROR);
             }
             return;
         }

package/dist/api/InputManager.d.ts

@@ -0,0 +1,39 @@
+import { Singleton } from '../monitors/BaseMonitor';
+declare const NOIBUJS_SDK_REQUEST_HELP_CODE = "requestHelpCode";
+declare const NOIBUJS_SDK_ADD_ID_FUNCTION = "addCustomAttribute";
+declare const NOIBUJS_SDK_ADD_ERROR_FUNCTION = "addError";
+declare const NOIBUJS_SDK_ADD_ERROR_FROM_JS_FMW_FUNCTION = "addJsSdkError";
+/** this class controls the input that customers can inject into
+ * our script via the NoibuJS SDK
+ */
+export default class InputManager extends Singleton {
+    private readonly customIDs;
+    private customErrorsCount;
+    /** exposes functions to the window of the browser for the clients
+     * to interact with on their end
+     */
+    exposeFunctions(): {
+        [NOIBUJS_SDK_REQUEST_HELP_CODE]: () => Promise<string | null>;
+        [NOIBUJS_SDK_ADD_ID_FUNCTION]: (name: string, value: string) => Promise<string>;
+        [NOIBUJS_SDK_ADD_ERROR_FUNCTION]: (customError: unknown) => string;
+        [NOIBUJS_SDK_ADD_ERROR_FROM_JS_FMW_FUNCTION]: (customError: unknown, errorSource: unknown) => string;
+    };
+    /** validates the custom error that was passed */
+    getErrorValidationError(customError: any): "SUCCESS" | "ERROR_HAS_NO_MSG" | "ERROR_HAS_NO_STACK" | "NULL_CUSTOM_ERROR";
+    /** Validates and sets the custom error to our internal trackers */
+    _validateAndSetCustomError(customError: unknown): "SUCCESS" | "ERROR_HAS_NO_MSG" | "ERROR_HAS_NO_STACK" | "NULL_CUSTOM_ERROR" | "TOO_MANY_ERRORS_RECEIVED_PER_PAGEVISIT";
+    /** adds an error from a JS Sdk to the session */
+    _addErrorFromJSSdk(customError: unknown, errorSource: unknown): "SUCCESS" | "ERROR_HAS_NO_MSG" | "ERROR_HAS_NO_STACK" | "NULL_CUSTOM_ERROR" | "TOO_MANY_ERRORS_RECEIVED_PER_PAGEVISIT";
+    /** adds a custom Error to the session */
+    _addCustomError(customError: unknown): "SUCCESS" | "ERROR_HAS_NO_MSG" | "ERROR_HAS_NO_STACK" | "NULL_CUSTOM_ERROR" | "TOO_MANY_ERRORS_RECEIVED_PER_PAGEVISIT";
+    /**
+     * adds a custom id to the session
+     * todo wrong param types, should be unknown
+     */
+    _addCustomAttribute(name: string, value: string): Promise<"TOO_MANY_IDS_ADDED" | "ID_NAME_ALREADY_ADDED" | "NAME_TOO_LONG" | "VALUE_TOO_LONG" | "INVALID_NAME_TYPE" | "INVALID_VALUE_TYPE" | "NAME_HAS_NO_LENGTH" | "VALUE_HAS_NO_LENGTH" | "SUCCESS">;
+    /** validation function for customer input */
+    getValidationError(name: unknown, value: unknown): "NAME_TOO_LONG" | "VALUE_TOO_LONG" | "INVALID_NAME_TYPE" | "INVALID_VALUE_TYPE" | "NAME_HAS_NO_LENGTH" | "VALUE_HAS_NO_LENGTH" | "SUCCESS";
+    /** Requests a help code from the HelpCode instance. */
+    _requestHelpCode(): Promise<string | null>;
+}
+export {};