Noibu React Native

https://www.npmjs.com/package/noibu-react-native
Admin
Noibu React Native SDK allows developers to easily track checkout errors and monitor user sessions...
Tokens:9,626
Snippets:53
Trust Score:9.6
Update:8 months ago
Show doc for...
Tokens:
Raw
### NoibuJS Setup and Configuration

Source: https://www.npmjs.com/package/noibu-react-native/index_activeTab=code

Demonstrates how to set up and configure the Noibu SDK with various options, including overriding default properties.

```APIDOC
## NoibuJS Setup and Configuration

### Description
This section details the initial setup and configuration of the Noibu SDK for React Native applications. It covers essential parameters and how to override default settings for properties like `blockedElements`, `httpPiiBlockingPatterns`, `fuzzyFieldsToRedact`, and `exactFieldsToRedact`.

### Method
`setupNoibu(options)`

### Parameters
#### Request Body
- **domain** (string) - Required - The domain of your application.
- **enableHttpDataCollection** (boolean) - Optional - Enables or disables HTTP data collection.
- **listOfUrlsToCollectHttpDataFrom** (array of strings) - Optional - A list of URLs from which to collect HTTP data.
- **blockedElements** (array of strings) - Optional - A list of HTML element IDs to block from data collection. Overriding requires including original values.
- **httpPiiBlockingPatterns** (array of RegExp) - Optional - Regular expressions to block Personally Identifiable Information (PII) in HTTP requests. Overriding requires including original values.
- **fuzzyFieldsToRedact** (array of strings) - Optional - Fields to redact based on fuzzy matching. Overriding requires including original values.
- **exactFieldsToRedact** (array of strings) - Optional - Fields to redact based on exact matching. Overriding requires including original values.

### Request Example
```javascript
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'],
  httpPiiBlockingPatterns: [
    // Match credit cards [https://www.regular-expressions.info/creditcard.html]
    // Visa
    /\b4\d{12}(?:\d{3})?\b/g,

    // MasterCard
    /\b(?:5[1-5]\d{2}|222[1-9]|22[3-9]\d|2[3-6]\d{2}|27[01]\d|2720)\d{12}\b/g,

    // Amex
    /\b3[47]\d{13}\b/g,

    // Diners Club
    /\b3(?:0[0-5]|[68]\d)\d{11}\b/g,

    // Discover
    /\b6(?:011|5\d{2})\d{12}\b/g,

    // JCB
    /\b(?:2131|1800|35\d{3})\d{11}\b/g,

    // Emails [https://www.regular-expressions.info/email.html]
    /\b[a-z0-9!#$%&'*+/=?^_‘{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_‘{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\b/g,

    // US SSN with or without dashes
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s12.html]
    /\b(?!000|666)[0-8]\d{2}[-.● ]?(?!00)\d{2}[-.● ]?(?!0000)\d{4}\b/g,

    // Canadian SIN with or without dashes [https://regexpattern.com/social-insurance-number-ca]
    /\b(\d{3}[-.● ]?\d{3}[-.● ]?\d{3})\b/g,

    // International phone numbers
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s03.html]
    /\+(?:\d●?){6,14}\d\b/g,

    // US/Canada phone numbers
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s02.html]
    /(\b|\+)?(1[-.● ]?)?(?(\d{3})\)?[-.● ]?(\d{3})[-.● ]?(\d{4})\b/g,
  ],
  fuzzyFieldsToRedact: [
    'password',
    'address',
    'credit',
    'postal',
    'token',
    'phone',
    'mobile',
    'expiry',
    'account',
    'email',
  ],
  exactFieldsToRedact: [
    'firstname',
    'lastname',
    'street',
    'fullname',
    'creditcard',
    'postcode',
    'zipcode',
    'city',
    'town',
    'county',
    'cc',
    'cardtype',
    'cardnumber',
    'email',
  ],
});
```
```

--------------------------------

### Setup and Error Boundary Usage in React Native

Source: https://www.npmjs.com/package/noibu-react-native/v/0.2

Demonstrates how to set up the Noibu SDK with a domain and wrap the root App component with the ErrorBoundary for error tracking.

```javascript
import React from 'react';
import { View, Text } from 'react-native';
import { ErrorBoundary, setupNoibu } from 'noibu-react-native';

setupNoibu({ domain: 'react-native-app.myshop.com' });

export default function App() {
  return (
    <ErrorBoundary
      fallback={() => (
        <View>
          <Text>Oh no!</Text>
        </View>
      )}>
      <View>
        <Text>Hello world!</Text>
      </View>
    </ErrorBoundary>
  );
}
```

--------------------------------

### Install Noibu React Native SDK

Source: https://www.npmjs.com/package/noibu-react-native/v/0.2

Installs the noibu-react-native package using npm and installs iOS native dependencies using CocoaPods.

```bash
npm install noibu-react-native --save
npx pod-install
```

--------------------------------

### Configure Noibu React Native SDK

Source: https://www.npmjs.com/package/noibu-react-native/v/0.2

Provides an example of configuring the setupNoibu function with various options including domain, HTTP data collection, and blocked elements.

```javascript
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'],
});
```

--------------------------------

### Setup Noibu React Native

Source: https://www.npmjs.com/package/noibu-react-native/index

Configuration options for setting up the Noibu SDK in a React Native application. This includes enabling data collection, defining URL patterns, and specifying fields for redaction.

```APIDOC
## Setup Noibu React Native

### Description
Configure the Noibu SDK with various options to control data collection, PII blocking, and field redaction.

### Method
`setupNoibu(options)`

### Parameters
#### Request Body
- **domain** (string) - Required - The domain of your application.
- **enableHttpDataCollection** (boolean) - Optional - Enables or disables HTTP data collection.
- **listOfUrlsToCollectHttpDataFrom** (array<string>) - Optional - A list of URLs from which to collect HTTP data.
- **blockedElements** (array<string>) - Optional - A list of element identifiers to block.
- **httpPiiBlockingPatterns** (array<RegExp>) - Optional - Regular expressions to block Personally Identifiable Information (PII) in HTTP requests.
- **fuzzyFieldsToRedact** (array<string>) - Optional - Fields to redact based on fuzzy matching.
- **exactFieldsToRedact** (array<string>) - Optional - Fields to redact based on exact matching.

### Request Example
```javascript
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'],
  httpPiiBlockingPatterns: [
    // Match credit cards
    /\b4\d{12}(?:\d{3})?\b/g,
    /\b(?:5[1-5]\d{2}|222[1-9]|22[3-9]\d|2[3-6]\d{2}|27[01]\d|2720)\d{12}\b/g,
    /\b3[47]\d{13}\b/g,
    /\b3(?:0[0-5]|[68]\d)\d{11}\b/g,
    /\b6(?:011|5\d{2})\d{12}\b/g,
    /\b(?:2131|1800|35\d{3})\d{11}\b/g,
    // Emails
    /\b[a-z0-9!#$%&'*+/=?^_‘{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_‘{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\b/g,
    // US SSN
    /\b(?!000|666)[0-8]\d{2}[-.● ]?(?!00)\d{2}[-.● ]?(?!0000)\d{4}\b/g,
    // Canadian SIN
    /\b(\d{3}[-.● ]?\d{3}[-.● ]?\d{3})\b/g,
    // International phone numbers
    /\+(?:\d●?){6,14}\d\b/g,
    // US/Canada phone numbers
    /(\b|\+)?(1[-.● ]?)?(?(\d{3}))?[-.● ]?(\d{3})[-.● ]?(\d{4})\b/g,
  ],
  fuzzyFieldsToRedact: [
    'password',
    'address',
    'credit',
    'postal',
    'token',
    'phone',
    'mobile',
    'expiry',
    'account',
    'email',
  ],
  exactFieldsToRedact: [
    'firstname',
    'lastname',
    'street',
    'fullname',
    'creditcard',
    'postcode',
    'zipcode',
    'city',
    'town',
    'county',
    'cc',
    'cardtype',
    'cardnumber',
    'email',
  ],
});
```
```

--------------------------------

### Configure Noibu with Default and Overridden Properties

Source: https://www.npmjs.com/package/noibu-react-native/index_activeTab=versions

Demonstrates how to initialize the Noibu SDK with custom configurations, including overriding default properties like blockedElements and httpPiiBlockingPatterns. This setup is crucial for tailoring data collection and PII redaction to your application's specific needs.

```javascript
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'],
  httpPiiBlockingPatterns: [
    // Match credit cards [https://www.regular-expressions.info/creditcard.html]
    // Visa
    /\b4\d{12}(?:\d{3})?\b/g,

    // MasterCard
    /\b(?:5[1-5]\d{2}|222[1-9]|22[3-9]\d|2[3-6]\d{2}|27[01]\d|2720)\d{12}\b/g,

    // Amex
    /\b3[47]\d{13}\b/g,

    // Diners Club
    /\b3(?:0[0-5]|[68]\d)\d{11}\b/g,

    // Discover
    /\b6(?:011|5\d{2})\d{12}\b/g,

    // JCB
    /\b(?:2131|1800|35\d{3})\d{11}\b/g,

    // Emails [https://www.regular-expressions.info/email.html]
    /\b[a-z0-9!#$%&'*+/=?^_‘{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_‘{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\b/g,

    // US SSN with or without dashes
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s12.html]
    /\b(?!000|666)[0-8]\d{2}[-.● ]?(?!00)\d{2}[-.● ]?(?!0000)\d{4}\b/g,

    // Canadian SIN with or without dashes [https://regexpattern.com/social-insurance-number-ca]
    /\b(\d{3}[-.● ]?\d{3}[-.● ]?\d{3})\b/g,

    // International phone numbers
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s03.html]
    /\+(?:\d●?){6,14}\d\b/g,

    // US/Canada phone numbers
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s02.html]
    /(\b|\+)?(1[-.● ]?)?\(?(\d{3})\)?[-.● ]?(\d{3})[-.● ]?(\d{4})\b/g,
  ],
  fuzzyFieldsToRedact: [
    'password',
    'address',
    'credit',
    'postal',
    'token',
    'phone',
    'mobile',
    'expiry',
    'account',
    'email',
  ],
  exactFieldsToRedact: [
    'firstname',
    'lastname',
    'street',
    'fullname',
    'creditcard',
    'postcode',
    'zipcode',
    'city',
    'town',
    'county',
    'cc',
    'cardtype',
    'cardnumber',
    'email',
  ],
});
```

--------------------------------

### Configure Noibu SDK with Overridden Properties

Source: https://www.npmjs.com/package/noibu-react-native/index_activeTab=dependents

Demonstrates how to initialize the Noibu SDK in a React Native application, overriding default properties such as blocked elements and PII blocking patterns. This example shows how to pass custom arrays for `blockedElements`, `httpPiiBlockingPatterns`, `fuzzyFieldsToRedact`, and `exactFieldsToRedact` to the `setupNoibu` function.

```javascript
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'],
  httpPiiBlockingPatterns: [
    // Match credit cards [https://www.regular-expressions.info/creditcard.html]
    // Visa
    /\b4\d{12}(?:\d{3})?\b/g,

    // MasterCard
    /\b(?:5[1-5]\d{2}|222[1-9]|22[3-9]\d|2[3-6]\d{2}|27[01]\d|2720)\d{12}\b/g,

    // Amex
    /\b3[47]\d{13}\b/g,

    // Diners Club
    /\b3(?:0[0-5]|[68]\d)\d{11}\b/g,

    // Discover
    /\b6(?:011|5\d{2})\d{12}\b/g,

    // JCB
    /\b(?:2131|1800|35\d{3})\d{11}\b/g,

    // Emails [https://www.regular-expressions.info/email.html]
    /\b[a-z0-9!#$%&'*+/=?^_‘{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_‘{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\b/g,

    // US SSN with or without dashes
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s12.html]
    /\b(?!000|666)[0-8]\d{2}[-.● ]?(?!00)\d{2}[-.● ]?(?!0000)\d{4}\b/g,

    // Canadian SIN with or without dashes [https://regexpattern.com/social-insurance-number-ca]
    /\b(\d{3}[-.● ]?\d{3}[-.● ]?\d{3})\b/g,

    // International phone numbers
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s03.html]
    /\+(?:\d●?){6,14}\d\b/g,

    // US/Canada phone numbers
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s02.html]
    /(\b|\+)?(1[-.● ]?)?(?(\d{3})?)?[-.● ]?(\d{3})[-.● ]?(\d{4})\b/g,
  ],
  fuzzyFieldsToRedact: [
    'password',
    'address',
    'credit',
    'postal',
    'token',
    'phone',
    'mobile',
    'expiry',
    'account',
    'email',
  ],
  exactFieldsToRedact: [
    'firstname',
    'lastname',
    'street',
    'fullname',
    'creditcard',
    'postcode',
    'zipcode',
    'city',
    'town',
    'county',
    'cc',
    'cardtype',
    'cardnumber',
    'email',
  ],
});
```

--------------------------------

### Configure Noibu SDK with Default Overrides

Source: https://www.npmjs.com/package/noibu-react-native/index_activeTab=dependencies

Demonstrates how to set up the Noibu SDK in a React Native application, overriding default properties like blockedElements and httpPiiBlockingPatterns. This example shows how to pass custom regular expressions for PII blocking and lists of elements and fields to redact.

```javascript
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'],
  httpPiiBlockingPatterns: [
    // Match credit cards [https://www.regular-expressions.info/creditcard.html]
    // Visa
    /\b4\d{12}(?:\d{3})?\b/g,

    // MasterCard
    /\b(?:5[1-5]\d{2}|222[1-9]|22[3-9]\d|2[3-6]\d{2}|27[01]\d|2720)\d{12}\b/g,

    // Amex
    /\b3[47]\d{13}\b/g,

    // Diners Club
    /\b3(?:0[0-5]|[68]\d)\d{11}\b/g,

    // Discover
    /\b6(?:011|5\d{2})\d{12}\b/g,

    // JCB
    /\b(?:2131|1800|35\d{3})\d{11}\b/g,

    // Emails [https://www.regular-expressions.info/email.html]
    /\b[a-z0-9!#$%&'*+/=?^_‘{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_‘{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\b/g,

    // US SSN with or without dashes
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s12.html]
    /\b(?!000|666)[0-8]\d{2}[-.● ]?(?!00)\d{2}[-.● ]?(?!0000)\d{4}\b/g,

    // Canadian SIN with or without dashes [https://regexpattern.com/social-insurance-number-ca]
    /\b(\d{3}[-.● ]?\d{3}[-.● ]?\d{3})\b/g,

    // International phone numbers
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s03.html]
    /\+(?:\d●?){6,14}\d\b/g,

    // US/Canada phone numbers
    // [https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s02.html]
    /(\b|\+)?(1[-.● ]?)?(?(\d{3}))?[-.● ]?(\d{3})[-.● ]?(\d{4})\b/g,
  ],
  fuzzyFieldsToRedact: [
    'password',
    'address',
    'credit',
    'postal',
    'token',
    'phone',
    'mobile',
    'expiry',
    'account',
    'email',
  ],
  exactFieldsToRedact: [
    'firstname',
    'lastname',
    'street',
    'fullname',
    'creditcard',
    'postcode',
    'zipcode',
    'city',
    'town',
    'county',
    'cc',
    'cardtype',
    'cardnumber',
    'email',
  ],
});
```

--------------------------------

### Add Custom Attribute to Noibu Session

Source: https://www.npmjs.com/package/noibu-react-native/v/0.2

Shows how to add a custom attribute to the current Noibu session using the `addCustomAttribute` method. It includes examples for successful addition and a case where the attribute name is too long.

```javascript
import { NoibuJS } from 'noibu-react-native';

NoibuJS.addCustomAttribute('myNameIs', 'Jeff'); // Promise<SUCCESS>
NoibuJS.addCustomAttribute('veryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryVeryLong', 'Jeff'); // Promise<NAME_TOO_LONG>
```

--------------------------------

### Request Help Code from Noibu JS API

Source: https://www.npmjs.com/package/noibu-react-native/v/0.2

Demonstrates how to use the `requestHelpCode` method from the `NoibuJS` object to retrieve a help code and display it in an alert.

```javascript
import { NoibuJS } from 'noibu-react-native';
import { useCallback, useState } from 'react';
import { Alert, Text, Pressable, View } from 'react-native';

const AlertHelpCode = () => {
  const triggerHelpCodeAlert = useCallback(async () => {
    const response = await NoibuJS.requestHelpCode();
    if (response) {
      Alert.alert('Help Code delivered:', response);
    }
  }, []);
  return (
    <View>
      <Pressable onPress={triggerHelpCodeAlert}>
        <View>
          <Text>Tap to view Help Code</Text>
        </View>
      </Pressable>
    </View>
  );
};

```

--------------------------------

### NoibuJS API Reference

Source: https://www.npmjs.com/package/noibu-react-native/index_activeTab=code

Details on the available methods within the NoibuJS object, including requesting help codes and adding custom attributes.

```APIDOC
## NoibuJS API Reference

### Description
This section outlines the methods available through the `NoibuJS` object exported by the `noibu-react-native` module.

### `NoibuJS.requestHelpCode()`

#### Description
Requests a help code from the HelpCode instance. Help codes can be used to find a specific user session.

#### Method
`requestHelpCode(): Promise<string>`

#### Returns
- `Promise<string>`: A promise that resolves with the requested help code.

#### Example
```javascript
import { NoibuJS } from 'noibu-react-native';
import { useCallback, useState } from 'react';
import { Alert, Text, Pressable, View } from 'react-native';

const AlertHelpCode = () => {
  const triggerHelpCodeAlert = useCallback(async () => {
    const response = await NoibuJS.requestHelpCode();
    if (response) {
      Alert.alert('Help Code delivered:', response);
    }
  }, []);
  return (
    <View>
      <Pressable onPress={triggerHelpCodeAlert}>
        <View>
          <Text>Tap to view Help Code</Text>
        </View>
      </Pressable>
    </View>
  );
};
```

### `NoibuJS.addCustomAttribute(name: string, value: any)`

#### Description
Adds a custom attribute to the current user session. This is useful for tracking specific user or application states.

#### Method
`addCustomAttribute(name: string, value: any): Promise<string>`

#### Parameters
- **name** (string) - Required - The name of the custom attribute. Maximum length is 50 characters.
- **value** (any) - Required - The value of the custom attribute. Must be a JSON.stringify-able type.

#### Returns
- `Promise<string>`: A promise that resolves with a success message or the reason for validation failure (e.g., `NAME_TOO_LONG`).

#### Recommended Custom Attributes
- `appVersion`: The version of your application.
- `customerId`: The ID of the customer.
- `orderId`: The ID of the order.
- `voC`: The Voice of Customer survey ID.

#### Limitations
Attribute names exceeding 50 characters will result in a `NAME_TOO_LONG` error.

#### Example
```javascript
import { NoibuJS } from 'noibu-react-native';

NoibuJS.addCustomAttribute('stripeApiKey', 'some-api-key'); // Promise<SUCCESS>
NoibuJS.addCustomAttribute('system_configuration_payment_gateway_stripe_api_key_prod', 'some-api-key'); // Promise<NAME_TOO_LONG>
```
```

--------------------------------

### NoibuJS API

Source: https://www.npmjs.com/package/noibu-react-native/index

Methods available on the NoibuJS object for interacting with the Noibu SDK, such as requesting help codes and adding custom attributes.

```APIDOC
## NoibuJS API

### Description
Provides methods for interacting with the Noibu SDK, including requesting help codes and adding custom session attributes.

### `NoibuJS.requestHelpCode()`

#### Description
Requests a help code from the HelpCode instance to identify a specific user session.

#### Method
`requestHelpCode(): Promise<string>`

#### Returns
- `Promise<string>` - A promise that resolves with the requested help code.

#### Example
```javascript
import { NoibuJS } from 'noibu-react-native';
import { useCallback, useState } from 'react';
import { Alert, Text, Pressable, View } from 'react-native';

const AlertHelpCode = () => {
  const triggerHelpCodeAlert = useCallback(async () => {
    const response = await NoibuJS.requestHelpCode();
    if (response) {
      Alert.alert('Help Code delivered:', response);
    }
  }, []);
  return (
    <View>
      <Pressable onPress={triggerHelpCodeAlert}>
        <View>
          <Text>Tap to view Help Code</Text>
        </View>
      </Pressable>
    </View>
  );
};
```

### `NoibuJS.addCustomAttribute(name: string, value: any)`

#### Description
Adds a custom attribute to the current user session. This is useful for tracking application-specific data.

#### Method
`addCustomAttribute(name: string, value: any) => Promise<string>`

#### Parameters
- **name** (string) - Required - The name of the custom attribute. Maximum length is 50 characters.
- **value** (any) - Required - The value of the custom attribute. Must be a JSON.stringify-able type.

#### Returns
- `Promise<string>` - A success message or the reason for validation failure (e.g., 'NAME_TOO_LONG').

#### Recommended Custom Attributes
- `appVersion`: The version of your application.
- `customerId`: The ID of the customer.
- `orderId`: The ID of the order.
- `voC`: The Voice of Customer survey ID.

#### Limitations
- Attribute names exceeding 50 characters will result in a validation failure.

#### Example
```javascript
import { NoibuJS } from 'noibu-react-native';

NoibuJS.addCustomAttribute('stripeApiKey', 'some-api-key'); // Promise<SUCCESS>
NoibuJS.addCustomAttribute('system_configuration_payment_gateway_stripe_api_key_prod', 'some-api-key'); // Promise<NAME_TOO_LONG>
```
```

--------------------------------

### addError

Source: https://www.npmjs.com/package/noibu-react-native/index_activeTab=dependencies

Adds a custom Error object to the current session for reporting. This method is useful for manually logging errors that occur within your application.

```APIDOC
## POST /addError

### Description
Adds a custom Error to the session.

### Method
POST

### Endpoint
/addError

### Parameters
#### Request Body
- **customError** (object) - Required - An Error-like object with `message` and `stack` properties to be reported.

### Request Example
```json
{
  "customError": {
    "message": "My Custom Error",
    "stack": "Error: My Custom Error\n    at foo (bar.js:1:1)"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the error was added.

#### Response Example
```json
{
  "message": "Error added successfully."
}
```
```

--------------------------------

### Add JavaScript SDK Error

Source: https://www.npmjs.com/package/noibu-react-native/index

Adds an error originating from a JavaScript SDK to the session. This method is primarily used internally by the ErrorBoundary component but can be used manually to report errors with a specified source.

```APIDOC
## POST /addJsSdkError

### Description
Adds an error from a JS SDK to the session, allowing specification of the error source.

### Method
POST

### Endpoint
/addJsSdkError

### Parameters
#### Request Body
- **error** (object) - Required - An Error-like object with `message` and `stack` properties.
- **errorSource** (string) - Required - The source or module from which the error originated.

### Request Example
```json
{
  "error": {
    "message": "My JS SDK Error",
    "stack": "Error: My JS SDK Error\n    at baz (qux.js:1:1)"
  },
  "errorSource": "myModule.js"
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the error was added.

#### Response Example
```json
{
  "message": "JS SDK error added successfully."
}
```
```

--------------------------------

### Add Custom Error to Noibu Session

Source: https://www.npmjs.com/package/noibu-react-native/v/0.2

Demonstrates how to manually add a custom error object to the Noibu session using the `addError` method. The error object should have `message` and `stack` properties.

```javascript
import { NoibuJS } from 'noibu-react-native';

NoibuJS.addError(new Error('My Error'));
```

--------------------------------

### Add JS SDK Error to Session with noibu-react-native

Source: https://www.npmjs.com/package/noibu-react-native/v/0.2

The `addJsSdkError` function is used internally by ErrorBoundary to add JavaScript SDK errors to the current session. It accepts an Error-like object and the source of the error. It returns a success message or a validation failure cause.

```javascript
import { NoibuJS } from 'noibu-react-native';

NoibuJS.addJsSdkError(new Error('My Error'), 'myModule.js');
```

--------------------------------

### addJsSdkError

Source: https://www.npmjs.com/package/noibu-react-native/v/0.2

Adds a JavaScript error from the SDK to the current session. This method is primarily used internally by the ErrorBoundary component but can be called manually to report specific JS errors.

```APIDOC
## addJsSdkError

### Description
Adds an error from a JS SDK to the session. This method is used by ErrorBoundary internally and allows setting a cause for the error.

### Method
`addJsSdkError`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **customError** (Error) - Required - An Error-like object to be reported with the session. It should have `message` and `stack` properties.
* **errorSource** (string) - Required - The source of the error, indicating where the error originated.

### Request Example
```javascript
import { NoibuJS } from 'noibu-react-native';

NoibuJS.addJsSdkError(new Error('My Custom Error Message'), 'myModule.js');
```

### Response
#### Success Response
* **string** - A success message indicating the error was added.

#### Response Example
```json
"Error added successfully to session."
```

#### Error Response
* **string** - A message detailing the validation failure cause if the input is invalid.
```
Tokens:
Raw