maskdata

https://www.npmjs.com/package/maskdata
Admin
maskdata is a Node.js module for masking sensitive data such as phone numbers, emails, passwords,...
Tokens:26,197
Snippets:133
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install maskdata using npm

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Install the maskdata module using npm. This command downloads and installs the package into your project.

```bash
npm i maskdata
```

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

### Mask Password with Meta Info

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Mask a secret key while preserving specific start and end segments as meta information.

```javascript
const MaskData = require('./maskdata');

const maskPasswordOptions = {
  maskWith: "X",
  maxMaskedCharacters: 20, // To limit the output String length to 20.
  unmaskedStartCharacters: 4,
  unmaskedEndCharacters: 9, // As the last 9 characters of the secret key is meta info which can be printed for debugging or other purposes
  fixedOutputLength: undefined
};

const password = "TEST:U2VjcmV0S2V5MQ==:CLIENT-A";

const maskedPassword = MaskData.maskPassword(password, maskPasswordOptions);
//Output: TESTXXXXXXX:CLIENT-A

maskPasswordOptions.unmaskedStartCharacters = 0;

const maskedPassword = MaskData.maskPassword(password, maskPasswordOptions);
//Output: XXXXXXXXXXX:CLIENT-A
```

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

### Get Nested JSON Property

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=dependents

Retrieves the value of a nested JSON property using a dot-notation path. Returns `undefined` if the property does not exist.

```APIDOC
## Get Nested JSON Property

### Description
Returns the value of the nested JSON property if it exists. Otherwise, it returns `undefined`.

### Method
`getInnerProperty(object, field)`

### Parameters
- `object` (object) - The JSON object to search within.
- `field` (string) - The dot-notation path to the nested property (e.g., 'level1.level2.field2', 'level1.level2.field4[0].Hello').

### Request Example
```javascript
const MaskData = require('./maskdata');

const nestedObject = {
  level1: {
    field1: "field1",
    level2: {
      field2: "field2",
      level3: {
        field3: "field3",
        field4: [ { Hello: "world" }, { Hello: "Newworld" }, "Just a String" ]
      }
    }
  },
  value1: "value"
};

const innerPropety = MaskData.getInnerProperty(nestedObject, 'level1.level2.level3.field4[0].Hello');
// innerPropety will be 'world'

const nonExistentProperty = MaskData.getInnerProperty(nestedObject, 'level1.nonExistent.field');
// nonExistentProperty will be undefined
```
```

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

### Get Nested JSON Property

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Retrieves the value of a nested JSON property using a dot-notation path. Returns undefined if the property does not exist.

```javascript
const MaskData = require('./maskdata');

const innerPropety = Maskdata.getInnerProperty(object, field);

Example: 

const nestedObject = {
  level1: {
    field1: "field1",
    level2: {
      field2: "field2",
      level3: {
        field3: "field3",
        field4: [ { Hello: "world" }, { Hello: "Newworld" }, "Just a String" ]
      }
    }
  },
  value1: "value"
};

const innerPropety = Maskdata.getInnerProperty(nestedObject, 'level1.level2.level3.field4[0].Hello');
```

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

### Mask Credit Card Number with Options

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Masks a credit card number, allowing configuration for the masking character, and the number of digits to keep visible at the start and end. Ensure the input is a string representing a card number.

```javascript
const MaskData = require('./maskdata');

const maskCardOptions = {
  // Character to mask the data. The default value is '*'
  maskWith: "*",

  // Should be positive Integer
  // If the starting 'n' digits need to be visible/unmasked
  // Default value is 4
  unmaskedStartDigits: 4,

  // Should be positive Integer
  // If the ending 'n' digits need to be visible/unmasked
  // Default value is 1. 
  unmaskedEndDigits: 1 
};

const cardNumber = "1234-5678-1234-5678";

const cardAfterMasking = MaskData.maskCard(cardNumber, maskCardOptions);

//Output: 1234-****-****-***8
```

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

### Masking Passwords with Custom and Default Options

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=dependencies

Demonstrates how to mask passwords using specific configuration objects or default settings.

```javascript
const MaskData = require('./maskdata');

const maskPasswordOptions = {
  // Character to mask the data
  // default value is '*'
  maskWith: "*",

  // To limit the *s in the response when the password length is more
  // Default value is 16
  maxMaskedCharacters: 16,

  // To fix the length of output irrespective of the length of the input. This comes in handy when the input length < maxMaskedCharacters but we want a fixed output length.
  // Default value is undefined. If this value is set, then maxMaskedCharacters will not be considered and the output length will always be equal to fixedOutputLength characters.
  fixedOutputLength: undefined,

  // To show(not mask) first 'n' characters in the password/secret key. 
  // Default value is 0. 
  unmaskedStartCharacters: 0,

  // To show(not mask) last 'n' characters in the password/secret key. 
  // Default value is 0. 
  unmaskedEndCharacters: 0
};

const password = "Password1$";

const maskedPassword = MaskData.maskPassword(password, maskPasswordOptions);

//Output: **********
```

```javascript
const MaskData = require('./maskdata');

  /** Default Options
    maskWith: "*"
    maxMaskedCharacters: 16,
    unmaskedStartCharacters: 0,
    fixedOutputLength: undefined,
    unmaskedEndCharacters: 0
  **/

const password = "Password1$";

const maskedPassword = MaskData.maskPassword(password)
```

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

### MaskData.maskPhone

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=dependencies

Masks a phone number string while preserving a specified number of start and end digits.

```APIDOC
## MaskData.maskPhone

### Description
Masks a phone number string. Allows configuration for mask character and the number of unmasked digits at the start and end.

### Parameters
#### Request Body
- **phoneNumber** (string) - Required - The phone number to mask.
- **options** (object) - Optional - Configuration object:
  - **maskWith** (string) - Optional - Character to mask with (default: '*').
  - **unmaskedStartDigits** (number) - Optional - Number of digits to show at the start (default: 4).
  - **unmaskedEndDigits** (number) - Optional - Number of digits to show at the end (default: 1).

### Response
- **maskedPhoneNumber** (string) - The resulting masked phone number.
```

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

### Masking Phone Numbers

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=dependencies

Configures masking for phone numbers by specifying unmasked start and end digits.

```javascript
const MaskData = require('./maskdata');

const maskPhoneOptions = {
  // Character to mask the data
  // default value is '*'
  maskWith: "*",

  //Should be positive Integer
  // If the starting 'n' digits need to be unmasked
  // Default value is 4
  unmaskedStartDigits: 5, 

  // Should be positive Integer
  //If the ending 'n' digits need to be unmasked
  // Default value is 1
  unmaskedEndDigits: 1 
};

const phoneNumber = "+911234567890";

const maskedPhoneNumber = MaskData.maskPhone(phoneNumber, maskPhoneOptions);
//Output: +9112*******0
```

```javascript
const MaskData = require('./maskdata');

/** Default Options
  maskWith: "*"
  unmaskedStartDigits: 4
  unmaskedEndDigits: 1 
**/
const phoneNumber = "+111234567890";

const maskedPhoneNumber = MaskData.maskPhone(phoneNumber);

//Output: +911********0
```

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

### Basic JSON Masking with Default Configurations

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=code

Demonstrates masking common sensitive fields like credit cards, emails, and phone numbers using default masking rules. Ensure the maskData library is imported.

```javascript
const jsonInput = {
  'credit': '1234-5678-8765-1234', 
  'debit': '0000-1111-2222-3333',
  'primaryEmail': 'primary@Email.com', 
  'secondaryEmail': 'secondary@Email.com',
  'password': 'dummyPassword',
  'homePhone': "+1 1234567890",
  'workPhone': "+1 9876543210",
  'addressLine1': "This is my addressline 1. This is my home",
  'addressLine2': "AddressLine 2",
  'uuid1': '123e4567-e89b-12d3-a456-426614174000',
  'randomStrings': {
    'row1': 'This is row 1 random string',
    'row2': ['Entry1', 'Entry2', 'Entry3'],
    'row3': {
      'key1': 'Row3 Object 1',
      'key2': 'Row3 Object 2',
      'key3': ['Entry1', 'Entry2', 'Entry3']
    }
  }
};

const jsonMaskConfig = {
    cardFields: ['credit', 'debit'],
    emailFields: ['primaryEmail', 'secondaryEmail'],
    passwordFields: ['password'],
    phoneFields: ['homePhone', 'workPhone'],
    stringMaskOptions:  {
      maskWith: "*",
      maskOnlyFirstOccurance: false,
      values: ["This"]
    },
    stringFields: ['addressLine1', 'addressLine2'],
    uuidFields: ['uuid1'],
    genericStrings: [
        {
          fields: ['randomStrings.row1'],
          config: {
            maskWith: '*', 
            unmaskedStartCharacters: 2,
            unmaskedEndCharacters: 3,
            maxMaskedCharacters: 8
          }
        },
        { fields: ['randomStrings.row2.*'], config: { maskWith: 'X', unmaskedEndCharacters: 1 } },
        { fields: ['randomStrings.row3.key1'] },
        {
          fields: ['randomStrings.row3.key3.*'],
          config: { maskWith: '@', unmaskedEndCharacters: 1 }
        }
    ]
};

const maskedJsonOutput = maskData.maskJSON2(jsonInput, jsonMaskConfig);
```

```json
{
  credit: '1234-****-****-***4',
  debit: '0000-****-****-***3',
  primaryEmail: 'pri****@*******om',
  secondaryEmail: 'sec******@*******om',
  password: '*************',
  homePhone: '+1 1********0',
  workPhone: '+1 9********0',
  addressLine1: '**** is my addressline 1. **** is my home',
  addressLine2: 'AddressLine 2',
  uuid1: '********-****-****-****-************',
  randomStrings: {
    row1: 'Th***ing',
    row2: ['XXXXX1', 'XXXXX2', 'XXXXX3'],
    row3: {
      key1: '*************',
      key2: 'Row3 Object 2',
      key3: ['@@@@@1', '@@@@@2', '@@@@@3']
    }
  }
}
```

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

### Mask JSON with Custom Field Configurations

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=readme

Shows how to apply specific masking options for different data types like cards, emails, and passwords.

```javascript
const jsonInput2 = {
  'credit': '1234-5678-8765-1234', 
  'debit': '0000-1111-2222-3333', 
  'primaryEmail': 'primary@Email.com', 
  'secondaryEmail': 'secondary@Email.com',
  'password': 'dummyPasswordANDdummyPassword',
  'homePhone': "+1 1234567890",
  'workPhone': "+1 9876543210",
  'addressLine1': "This is my addressline 1. This is my home",
  'addressLine2': "AddressLine 2",
  'uuid1': '123e4567-e89b-12d3-a456-426614174000'
};

const jsonMaskConfig2 = {
    // Card
    cardMaskOptions: { maskWith: "X", unmaskedStartDigits: 2,unmaskedEndDigits: 4 },
    cardFields: ['credit', 'debit'],

    // Email
    emailMaskOptions: { maskWith: "*", unmaskedStartCharactersBeforeAt: 2, unmaskedEndCharactersAfterAt: 2, maskAtTheRate: false },
    emailFields: ['primaryEmail', 'secondaryEmail'],

    // Password
    passwordMaskOptions: { maskWith: "*", maxMaskedCharacters: 10, unmaskedStartCharacters: 0, unmaskedEndCharacters: 0 },
    passwordFields: ['password'],

    // Phone
    phoneMaskOptions: { maskWith: "*", unmaskedStartDigits: 2, unmaskedEndDigits: 1 },
    phoneFields: ['homePhone', 'workPhone'],

    // String
    stringMaskOptions: { maskWith: "*", maskOnlyFirstOccurance: false, values: [], maskAll: true, maskSpace: false },
    stringFields: ['addressLine1', 'addressLine2'],

    // UUID
    uuidMaskOptions: { maskWith: "*", unmaskedStartCharacters: 4, unmaskedEndCharacters: 2 },
    uuidFields: ['uuid1']
};

const maskedJsonOutput2 = maskData.maskJSON2(jsonInput2, jsonMaskConfig2);
```

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

### Mask Phone Number with Custom Options

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Mask phone numbers by specifying the number of unmasked digits at the start and end.

```javascript
const MaskData = require('./maskdata');

const maskPhoneOptions = {
  // Character to mask the data
  // default value is '*'
  maskWith: "*",

  //Should be positive Integer
  // If the starting 'n' digits need to be unmasked
  // Default value is 4
  unmaskedStartDigits: 5, 

  // Should be positive Integer
  //If the ending 'n' digits need to be unmasked
  // Default value is 1
  unmaskedEndDigits: 1 
};

const phoneNumber = "+911234567890";

const maskedPhoneNumber = MaskData.maskPhone(phoneNumber, maskPhoneOptions);
//Output: +9112*******0
```

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

### Import maskdata

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=readme

Basic requirement statement for the module.

```javascript
const MaskData = require('./maskdata');
```

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

### Basic JSON Masking with Default Configurations

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Use this for general masking of common sensitive fields like credit cards, emails, and passwords with default masking rules. Ensure the `maskData` library is imported.

```javascript
const jsonInput = {
  'credit': '1234-5678-8765-1234', 
  'debit': '0000-1111-2222-3333',
  'primaryEmail': 'primary@Email.com', 
  'secondaryEmail': 'secondary@Email.com',
  'password': 'dummyPassword',
  'homePhone': "+1 1234567890",
  'workPhone': "+1 9876543210",
  'addressLine1': "This is my addressline 1. This is my home",
  'addressLine2': "AddressLine 2",
  'uuid1': '123e4567-e89b-12d3-a456-426614174000',
  'randomStrings': {
    'row1': 'This is row 1 random string',
    'row2': ['Entry1', 'Entry2', 'Entry3'],
    'row3': {
      'key1': 'Row3 Object 1',
      'key2': 'Row3 Object 2',
      'key3': ['Entry1', 'Entry2', 'Entry3']
    }
  }
};

const jsonMaskConfig = {
    cardFields: ['credit', 'debit'],
    emailFields: ['primaryEmail', 'secondaryEmail'],
    passwordFields: ['password'],
    phoneFields: ['homePhone', 'workPhone'],
    stringMaskOptions:  {
      maskWith: "*",
      maskOnlyFirstOccurance: false,
      values: ["This"]
    },
    stringFields: ['addressLine1', 'addressLine2'],
    uuidFields: ['uuid1'],
    genericStrings: [
        {
          fields: ['randomStrings.row1'],
          config: {
            maskWith: '*', 
            unmaskedStartCharacters: 2,
            unmaskedEndCharacters: 3,
            maxMaskedCharacters: 8
          }
        },
        { fields: ['randomStrings.row2.*'], config: { maskWith: 'X', unmaskedEndCharacters: 1 } },
        { fields: ['randomStrings.row3.key1'] },
        {
          fields: ['randomStrings.row3.key3.*'],
          config: { maskWith: '@', unmaskedEndCharacters: 1 }
        }
    ]
};

const maskedJsonOutput = maskData.maskJSON2(jsonInput, jsonMaskConfig);
```

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

### Mask Password with Default Configuration

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Mask a password using the library's default settings by omitting the configuration object.

```javascript
const MaskData = require('./maskdata');

  /** Default Options
    maskWith: "*"
    maxMaskedCharacters: 16,
    unmaskedStartCharacters: 0,
    fixedOutputLength: undefined,
    unmaskedEndCharacters: 0
  **/

const password = "Password1$";

const maskedPassword = MaskData.maskPassword(password)
```

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

### Detailed JSON Masking Configurations

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Provides detailed default configurations for masking specific data types like credit cards, emails, passwords, phone numbers, strings, UUIDs, and JWTs. Customize these options to control the masking behavior.

```javascript
const defaultjsonMask2Configs = {
    cardMaskOptions: {
        maskWith: "*",
        unmaskedStartDigits: 4,
        unmaskedEndDigits: 1
    },
    cardFields: [],

    emailMaskOptions: {
        maskWith: "*",
        unmaskedStartCharactersBeforeAt: 3,
        unmaskedEndCharactersAfterAt: 2,
        maskAtTheRate: false
    },
    emailFields: [],

    passwordMaskOptions: {
        maskWith: "*",
        maxMaskedCharacters: 16,
        fixedOutputLength: undefined,
        unmaskedStartCharacters: 0,
        unmaskedEndCharacters: 0
    },
    passwordFields: [],

    phoneMaskOptions: {
        maskWith: "*",
        unmaskedStartDigits: 4,
        unmaskedEndDigits: 1
    },
    phoneFields: [],

    stringMaskOptions:  {
        maskWith: "*",
        maskOnlyFirstOccurance: false,
        values: [],
        maskAll: false,
        maskSpace: true
    },
    stringFields: [],

    uuidMaskOptions: {
        maskWith: "*",
        unmaskedStartCharacters: 0,
        unmaskedEndCharacters: 0
    },
    uuidFields: [],

    jwtMaskOptions: {
        maskWith: '*',
        maxMaskedCharacters: 512,
        maskDot: true,
        maskHeader: true,
        maskPayload: true,
        maskSignature: true
    },
    jwtFields: [],
    // To extend the mask function to generic strings. 
    genericStrings: [
      {
        config: {
          maskWith: "*",
          maxMaskedCharacters: 256,
          fixedOutputLength: undefined,
          unmaskedStartDigits: 0,
          unmaskedEndDigits: 0
        },
        fields: []
      }
    ]
};

```

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

### Mask UUID alphanumeric characters

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Redact UUIDs while preserving hyphens. Optionally keep a specific number of start or end characters visible.

```javascript
const MaskData = require('./maskdata');

const maskUuidOptions = {
  // Character to mask the data. The default value is '*'
  maskWith: "*",

  // Should be a positive Integer <= 32
  // If the starting 'n' alphanumeric characters need to be visible/unmasked
  // Default value is 0
  unmaskedStartCharacters: 0, 
  
  //Should be a positive Integer <= 32
  //If the ending 'n' alphanumeric characters need to be visible/unmasked
  // Default value is 0 
  unmaskedEndCharacters: 0
};

const uuidInput = "123e4567-e89b-12d3-a456-426614174000";

const uuidAfterMasking = MaskData.maskUuid(uuidInput, maskUuidOptions);

// Output: ********-****-****-****-************
```

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

### Recursive Masking of Card Numbers

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Leverage recursive masking with specific card masking options to mask credit card numbers. This configuration allows for unmasked start and end digits while masking the middle portion.

```javascript
const inputJson = {
  cards: [
    {
      number: "1234-5678-0123-0000"
    },
    {
      number: "1111-2222-3333-4444"
    },
    {
      number: "2222-4444-6666-8888"
    },
    {
      number: "1111-3333-5555-7777"
    },
    {
      number: "0000-0000-0000-0000"
    }
  ]
};

const cardfieldsToMask = ["*number"];  // Specify the field with a '*' at the beginning and NO dot(.) anywhere else in that field.
    
const jsonMaskConfig = {
  cardMaskOptions: {
        maskWith: "*",
        unmaskedStartDigits: 4,
        unmaskedEndDigits: 1
    },
  cardFields: cardfieldsToMask, 
};

const maskedOutput = maskData.maskJSON2(jsonInput, jsonMaskConfig);

// Output: 
{
  cards: [
    { number: '1234-****-****-***0' },
    { number: '1111-****-****-***4' },
    { number: '2222-****-****-***8' },
    { number: '1111-****-****-***7' },
    { number: '0000-****-****-***0' }
  ]
}
```

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

### Customized JSON Masking with Specific Field Configurations

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Apply custom masking rules for each data type (card, email, password, phone, string, UUID) by defining specific `*MaskOptions`. This provides granular control over how each field is masked.

```javascript
const jsonInput2 = {
  'credit': '1234-5678-8765-1234', 
  'debit': '0000-1111-2222-3333',
  'primaryEmail': 'primary@Email.com', 
  'secondaryEmail': 'secondary@Email.com',
  'password': 'dummyPasswordANDdummyPassword',
  'homePhone': "+1 1234567890",
  'workPhone': "+1 9876543210",
  'addressLine1': "This is my addressline 1. This is my home",
  'addressLine2': "AddressLine 2",
  'uuid1': '123e4567-e89b-12d3-a456-426614174000'
};

const jsonMaskConfig2 = {
    // Card
    cardMaskOptions: { maskWith: "X", unmaskedStartDigits: 2,unmaskedEndDigits: 4 },
    cardFields: ['credit', 'debit'],

    // Email
    emailMaskOptions: { maskWith: "*", unmaskedStartCharactersBeforeAt: 2, unmaskedEndCharactersAfterAt: 2, maskAtTheRate: false },
    emailFields: ['primaryEmail', 'secondaryEmail'],

    // Password
    passwordMaskOptions: { maskWith: "*", maxMaskedCharacters: 10, unmaskedStartCharacters: 0, unmaskedEndCharacters: 0 },
    passwordFields: ['password'],

    // Phone
    phoneMaskOptions: { maskWith: "*", unmaskedStartDigits: 2, unmaskedEndCharacters: 1 },
    phoneFields: ['homePhone', 'workPhone'],

    // String
    stringMaskOptions: { maskWith: "*", maskOnlyFirstOccurance: false, values: [], maskAll: true, maskSpace: false },
    stringFields: ['addressLine1', 'addressLine2'],

    // UUID
    uuidMaskOptions: { maskWith: "*", unmaskedStartCharacters: 4, unmaskedEndCharacters: 2 },
    uuidFields: ['uuid1']
};

const maskedJsonOutput2 = maskData.maskJSON2(jsonInput2, jsonMaskConfig2);
```

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

### Mask Password with Custom Options

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Configure masking behavior for passwords, including character choice, length limits, and unmasked start/end segments.

```javascript
const MaskData = require('./maskdata');

const maskPasswordOptions = {
  // Character to mask the data
  // default value is '*'
  maskWith: "*",

  // To limit the *s in the response when the password length is more
  // Default value is 16
  maxMaskedCharacters: 16,

  // To fix the length of output irrespective of the length of the input. This comes in handy when the input length < maxMaskedCharacters but we want a fixed output length.
  // Default value is undefined. If this value is set, then maxMaskedCharacters will not be considered and the output length will always be equal to fixedOutputLength characters.
  fixedOutputLength: undefined,

  // To show(not mask) first 'n' characters in the password/secret key. 
  // Default value is 0. 
  unmaskedStartCharacters: 0,

  // To show(not mask) last 'n' characters in the password/secret key. 
  // Default value is 0. 
  unmaskedEndCharacters: 0
};

const password = "Password1$";

const maskedPassword = MaskData.maskPassword(password, maskPasswordOptions);

//Output: **********
```

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

### Generic String Masking with Default Options

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=readme

Mask a generic string using `maskStringV2` with default options for masking character, max masked characters, and unmasked portions.

```javascript
const MaskData = require('./maskdata');

const defaultStringMaskV2Options = {
  // Character to mask the data
  // default value is '*'
  maskWith: "*",

  // This is to limit the maximun characters in the output.
  // Default value is 256
  maxMaskedCharacters: 256,

  // To fix the length of output irrespective of the length of the input. This comes in handy when the input length < maxMaskedCharacters but we want a fixed output length.
  // Default value is undefined. If this value is set, then maxMaskedCharacters will not be considered and the output length will always be equal to fixedOutputLength characters.
  fixedOutputLength: undefined,

  // To show(not mask) first 'n' characters of the string.
  // Default value is 0. 
  unmaskedStartCharacters: 0,

  // To show(not mask) last 'n' characters of the string.
  // Default value is 0. 
  unmaskedEndCharacters: 0
};

const string1 = "Password1$";

const maskedString = MaskData.maskStringV2(string1, defaultStringMaskV2Options);

//Output: **********
```

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

### MaskData.maskStringV2

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=dependencies

Generic string masking utility for any string input.

```APIDOC
## MaskData.maskStringV2

### Description
Generic utility to mask any string based on provided configuration options.

### Parameters
#### Request Body
- **inputString** (string) - Required - The string to mask.
- **options** (object) - Optional - Configuration object:
  - **maskWith** (string) - Optional - Character to mask with (default: '*').
  - **maxMaskedCharacters** (number) - Optional - Max length of masked output (default: 256).
  - **fixedOutputLength** (number) - Optional - Fixed length for output.
  - **unmaskedStartCharacters** (number) - Optional - Number of characters to show at the start (default: 0).
  - **unmaskedEndCharacters** (number) - Optional - Number of characters to show at the end (default: 0).

### Response
- **maskedString** (string) - The resulting masked string.
```

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

### Configure JSON Masking Options

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=readme

Defines the default configuration structure for masking various data types in a JSON object.

```javascript
const MaskData = require('./maskdata');

// Default configs are as below. If specific masking changes are needed, use the corresponding configs for each type of field.
const defaultjsonMask2Configs = {
    cardMaskOptions: defaultCardMaskOptions, // Optional 
    cardFields: [], // List of card fields to be masked

    emailMaskOptions: defaultEmailMask2Options, // Optional 
    emailFields: [], // List of email fields to be masked

    passwordMaskOptions: defaultPasswordMaskOptions, // Optional 
    passwordFields: [], // List of password fields to be masked

    phoneMaskOptions: defaultPhoneMaskOptions, // Optional 
    phoneFields: [], // List of phone fields to be masked

    stringMaskOptions:  defaultStringMaskOptions, // Mandatory if stringFields are given. Otherwise, stringFields won't be masked
    stringFields: [], // List of String fields to be masked

    uuidMaskOptions: defaultUuidMaskOptions, // Optional 
    uuidFields: [], // List of UUID fields to be masked

    jwtMaskOptions: defaultJwtMaskOptions, // Optional 
    jwtFields: [], // List of JWT fields to be masked

    genericStrings: [ // This list can have multiple entries of { config: defaultStringMaskV2Options, fields: [] }
      {
        config: defaultStringMaskV2Options,
        fields: []
      }
    ]
};
```

```javascript
const defaultjsonMask2Configs = {
    cardMaskOptions: {
        maskWith: "*",
        unmaskedStartDigits: 4,
        unmaskedEndDigits: 1
    },
    cardFields: [],

    emailMaskOptions: {
        maskWith: "*",
        unmaskedStartCharactersBeforeAt: 3,
        unmaskedEndCharactersAfterAt: 2,
        maskAtTheRate: false
    },
    emailFields: [],

    passwordMaskOptions: {
        maskWith: "*",
        maxMaskedCharacters: 16,
        fixedOutputLength: undefined,
        unmaskedStartCharacters: 0,
        unmaskedEndCharacters: 0
    },
    passwordFields: [],

    phoneMaskOptions: {
        maskWith: "*",
        unmaskedStartDigits: 4,
        unmaskedEndDigits: 1
    },
    phoneFields: [],

    stringMaskOptions:  {
        maskWith: "*",
        maskOnlyFirstOccurance: false,
        values: [],
        maskAll: false,
        maskSpace: true
    },
    stringFields: [],

    uuidMaskOptions: {
        maskWith: "*",
        unmaskedStartCharacters: 0,
        unmaskedEndCharacters: 0
    },
    uuidFields: [],

    jwtMaskOptions: {
        maskWith: '*',
        maxMaskedCharacters: 512,
        maskDot: true,
        maskHeader: true,
        maskPayload: true,
        maskSignature: true
    },
    jwtFields: [],
    // To extend the mask function to generic strings. 
    genericStrings: [
      {
        config: {
          maskWith: "*",
          maxMaskedCharacters: 256,
          fixedOutputLength: undefined,
          unmaskedStartDigits: 0,
          unmaskedEndDigits: 0
        },
        fields: []
      }
    ]
};
```

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

### Default JSON Masking Configurations

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Defines the default configuration object for masking various data types in JSON. Use this as a base and modify specific fields or options as needed.

```javascript
const MaskData = require('./maskdata');

// Default configs are as below. If specific masking changes are needed, use the corresponding configs for each type of field.
const defaultjsonMask2Configs = {
    cardMaskOptions: defaultCardMaskOptions, // Optional 
    cardFields: [], // List of card fields to be masked

    emailMaskOptions: defaultEmailMask2Options, // Optional 
    emailFields: [], // List of email fields to be masked

    passwordMaskOptions: defaultPasswordMaskOptions, // Optional 
    passwordFields: [], // List of password fields to be masked

    phoneMaskOptions: defaultPhoneMaskOptions, // Optional 
    phoneFields: [], // List of phone fields to be masked

    stringMaskOptions:  defaultStringMaskOptions, // Mandatory if stringFields are given. Otherwise, stringFields won't be masked
    stringFields: [], // List of String fields to be masked

    uuidMaskOptions: defaultUuidMaskOptions, // Optional 
    uuidFields: [], // List of UUID fields to be masked

    jwtMaskOptions: defaultJwtMaskOptions, // Optional 
    jwtFields: [], // List of JWT fields to be masked

    genericStrings: [ // This list can have multiple entries of { config: defaultStringMaskV2Options, fields: [] }
      {
        config: defaultStringMaskV2Options,
        fields: []
      }
    ]
};

```

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

### Recursive Masking

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=dependents

Demonstrates how to mask fields recursively using the `*{field_name}` syntax. This allows masking a field regardless of its depth within the JSON structure.

```APIDOC
## Recursive Masking

### Description
Masks all fields with a given name irrespective of their level in the JSON object.

### Method
`maskJSON2` (from maskdata library)

### Parameters
- `inputJson` (object) - The JSON object to mask.
- `jsonMaskConfig` (object) - Configuration object for masking.
  - `genericStrings` (array) - An array of masking configurations for generic string fields.
    - `config` (object) - Configuration for the masking.
      - `maskWith` (string) - The character to use for masking (e.g., '*').
      - `maxMaskedCharacters` (number) - The maximum number of characters to mask.
    - `fields` (array of strings) - An array of field names to mask, prefixed with '*' (e.g., `["*addressLine1"]`).
  - `cardMaskOptions` (object) - Configuration for masking card numbers.
    - `maskWith` (string) - The character to use for masking (e.g., '*').
    - `unmaskedStartDigits` (number) - Number of digits to keep unmasked at the start.
    - `unmaskedEndDigits` (number) - Number of digits to keep unmasked at the end.
  - `cardFields` (array of strings) - An array of card number field names to mask, prefixed with '*' (e.g., `["*number"]`).

### Request Example (Generic Strings)
```javascript
const inputJson = {
  car: "Mazda",
  addressLine1: "Mask me!",
  deeper: {
    addressLine1: "Mask me!",
    evenDeeper: { addressLine1: "Mask me!" },
  },
};

const fieldsToMask = ["*addressLine1"];

const jsonMaskConfig = {
  genericStrings: [
    {
      config: {
        maskWith: "*",
        maxMaskedCharacters: 6
      },
      fields: fieldsToMask
    },
  ],
};

const maskedOutput = maskData.maskJSON2(inputJson, jsonMaskConfig);
```

### Response Example (Generic Strings)
```json
{
  "car": "Mazda",
  "addressLine1": "******",
  "deeper": {
    "addressLine1": "******",
    "evenDeeper": { "addressLine1": "******" }
  }
}
```

### Request Example (Card Numbers)
```javascript
const inputJson = {
  cards: [
    { number: "1234-5678-0123-0000" },
    { number: "1111-2222-3333-4444" },
    { number: "2222-4444-6666-8888" },
    { number: "1111-3333-5555-7777" },
    { number: "0000-0000-0000-0000" }
  ]
};

const cardfieldsToMask = ["*number"];
    
const jsonMaskConfig = {
  cardMaskOptions: {
        maskWith: "*",
        unmaskedStartDigits: 4,
        unmaskedEndDigits: 1
    },
  cardFields: cardfieldsToMask
};

const maskedOutput = maskData.maskJSON2(inputJson, jsonMaskConfig);
```

### Response Example (Card Numbers)
```json
{
  "cards": [
    { "number": "1234-****-****-***0" },
    { "number": "1111-****-****-***4" },
    { "number": "2222-****-****-***8" },
    { "number": "1111-****-****-***7" },
    { "number": "0000-****-****-***0" }
  ]
}
```
```

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

### Mask String

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=readme

Masks characters or words within a given string based on specified options.

```APIDOC
## Mask String

### Description
Mask the characters or words in the string if present in the given string.

### Method
`MaskData.maskString(str, options)`

### Parameters
#### Request Body
- **str** (string) - Required - The input string to mask.
- **options** (object) - Optional - Configuration object for masking.
  - **maskWith** (string) - Optional - Character to mask the data. Default: '*'.
  - **values** (array of strings) - Optional - Words/substrings to mask. Used only when `maskAll` is false. Default: [].
  - **maskOnlyFirstOccurance** (boolean) - Optional - If true, masks only the first occurrence of each word/substring. Default: false.
  - **maskAll** (boolean) - Optional - If true, masks all characters in the string. `values` will be ignored. Default: false.
  - **maskSpace** (boolean) - Optional - If true and `maskAll` is true, masks spaces. Default: true.

### Request Example
```javascript
const MaskData = require('./maskdata');
const maskStringOptions = {
  maskWith: "*",
  values: ['is', 'test'],
  maskOnlyFirstOccurance: false,
  maskAll: false,
  maskSpace: true
};
const str = "This is a test String";
const strAfterMasking = MaskData.maskString(str, maskStringOptions);
// Output: Th** ** a **** String
```

### Mask all characters in the String

#### Example 1: Mask all characters except spaces
```javascript
const MaskData = require('./maskdata');
const str = "This is a test String";
const stringMaskOptions = {
  maskWith: "*",
  values: [],
  maskAll: true,
  maskSpace: false
};
const strAfterMasking = MaskData.maskString(str, stringMaskOptions);
// Output: **** ** * **** *****
```

#### Example 2: Mask all characters including spaces
```javascript
const MaskData = require('./maskdata');
const str = "This is a test String";
const stringMaskOptions = {
  maskWith: "*",
  values: [],
  maskAll: true,
  maskSpace: true
};
const strAfterMasking = MaskData.maskString(str, stringMaskOptions);
// Output: ********************
```
```

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

### Mask Generic Strings

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Apply generic string masking using the maskStringV2 method with custom configurations.

```javascript
const MaskData = require('./maskdata');

const defaultStringMaskV2Options = {
  // Character to mask the data
  // default value is '*'
  maskWith: "*",

  // This is to limit the maximun characters in the output.
  // Default value is 256
  maxMaskedCharacters: 256,

  // To fix the length of output irrespective of the length of the input. This comes in handy when the input length < maxMaskedCharacters but we want a fixed output length.
  // Default value is undefined. If this value is set, then maxMaskedCharacters will not be considered and the output length will always be equal to fixedOutputLength characters.
  fixedOutputLength: undefined,

  // To show(not mask) first 'n' characters of the string.
  // Default value is 0. 
  unmaskedStartCharacters: 0,

  // To show(not mask) last 'n' characters of the string.
  // Default value is 0. 
  unmaskedEndCharacters: 0
};

const string1 = "Password1$";

const maskedString = MaskData.maskStringV2(string1, defaultStringMaskV2Options);

//Output: **********
```

```javascript
const MaskData = require('./maskdata');

const stringMaskV2Options = {
  maskWith: "X",
  maxMaskedCharacters: 20, // To limit the output length to 20.
  unmaskedStartCharacters: 4,
  unmaskedEndCharacters: 9,
  fixedOutputLength: undefined
};

const secret = "TEST:U2VjcmV0S2V5MQ==:CLIENT-A";

const maskedSecret = MaskData.maskStringV2(password, stringMaskV2Options);
//Output: TESTXXXXXXX:CLIENT-A

stringMaskV2Options.unmaskedStartCharacters = 0;

maskedSecret = MaskData.maskStringV2(password, stringMaskV2Options);
//Output: XXXXXXXXXXX:CLIENT-A
```

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

### Generic String Masking with Custom Options

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=readme

Mask a generic string with custom options for masking character, max masked characters, and unmasked start/end characters using `maskStringV2`.

```javascript
const MaskData = require('./maskdata');

const stringMaskV2Options = {
  maskWith: "X",
  maxMaskedCharacters: 20, // To limit the output length to 20.
  unmaskedStartCharacters: 4,
  unmaskedEndCharacters: 9,
  fixedOutputLength: undefined
};

const secret = "TEST:U2VjcmV0S2V5MQ==:CLIENT-A";

const maskedSecret = MaskData.maskStringV2(password, stringMaskV2Options);
//Output: TESTXXXXXXX:CLIENT-A

stringMaskV2Options.unmaskedStartCharacters = 0;

maskedSecret = MaskData.maskStringV2(password, stringMaskV2Options);
//Output: XXXXXXXXXXX:CLIENT-A
```

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

### Recursive Masking with Card Config

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=code

Apply recursive masking to card numbers using a specific card mask configuration. This method is versatile for various data types.

```javascript
const inputJson = {
  cards: [
    {
      number: "1234-5678-0123-0000"
    },
    {
      number: "1111-2222-3333-4444"
    },
    {
      number: "2222-4444-6666-8888"
    },
    {
      number: "1111-3333-5555-7777"
    },
    {
      number: "0000-0000-0000-0000"
    }
  ]
};

const cardfieldsToMask = ["*number"];  // Specify the field with a '*' at the beginning and NO dot(.) anywhere else in that field.
    
const jsonMaskConfig = {
  cardMaskOptions: {
        maskWith: "*",
        unmaskedStartDigits: 4,
        unmaskedEndDigits: 1
    },
  cardFields: cardfieldsToMask, 
};

const maskedOutput = maskData.maskJSON2(inputJson, jsonMaskConfig);

// Output: 
{
  cards: [
    { number: '1234-****-****-***0' },
    { number: '1111-****-****-***4' },
    { number: '2222-****-****-***8' },
    { number: '1111-****-****-***7' },
    { number: '0000-****-****-***0' }
  ]
}
```

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

### Mask all characters in a string

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Configure maskAll to true to redact the entire string, with optional space preservation.

```javascript
const str = "This is a test String";

const strAfterMasking = MaskData.maskString(str, maskStringOptions);

const stringMaskOptions = {
  maskWith: "*",
  values: [],
  maskAll: true,
  maskSpace: false   // Maks all characters except spaces
};

// Output: **** ** * **** *****

const str = "This is a test String";

const strAfterMasking = MaskData.maskString(str, maskStringOptions);

const stringMaskOptions = {
  maskWith: "*",
  values: [],
  maskAll: true,
  maskSpace: true   // Mask all characters including spaces
};

// Output: ********************
```

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

### Mask Phone Number with Default Configuration

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=versions

Mask a phone number using the library's default digit preservation settings.

```javascript
const MaskData = require('./maskdata');

/** Default Options
  maskWith: "*"
  unmaskedStartDigits: 4
  unmaskedEndDigits: 1 
**/
const phoneNumber = "+111234567890";

const maskedPhoneNumber = MaskData.maskPhone(phoneNumber);

//Output: +911********0
```

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

### Mask All Characters in a String (Including Spaces)

Source: https://www.npmjs.com/package/maskdata/v/1.3.4?activeTab=dependencies

Masks all characters in a string, including spaces. This provides complete obfuscation of the string content.

```javascript
const str = "This is a test String";

const strAfterMasking = MaskData.maskString(str, maskStringOptions);

const stringMaskOptions = {
  maskWith: "*",
  values: [],
  maskAll: true,
  maskSpace: true   // Mask all characters including spaces
};

// Output: ********************
```
Tokens:
Raw