@devtea2025/ad-officia-ipsam-velit

v1.0.0

Published

7 months ago

Downloads

0High
0Medium
0Low

cloudsearch flatten handlers regex macos util Observables redact api byteOffset parse get shebang nested css async styling hookform dotenv predictable collection require node configurable writable ES2016 typed fixed-width parser ES5 -0 config 256 loadbalancing ec2 mru flatMap format [[Prototype]]Object.is ECMAScript 2018 typeerror equal runtime value buffers install rm -rf autoprefixer callback test form js generics input ECMAScript 2019 values Object.fromEntries queueMicrotask forEach watcher computed-types setImmediate form-validation compile less estree child group Int8Array scheme ratelimit ECMAScript 6 fsevents clone serialize contains $.extend iam color sns shrinkwrap merge deep-clone map logging events variables in css ECMAScript 2020 folder nodejs __proto__autoscaling ECMAScript 5 error toStringTag language Reflect.getPrototypeOf ES2015 promise assertion property es8 error-handling Int16Array Uint8ClampedArray fast-copy parent gradients css native deep Symbol ES2022 groupBy utility typescript internal side search typedarray hasOwnProperty String.prototype.trim TypedArray directory AsyncIterator ArrayBuffer website vest fast-deep-copy batch executable schema performant TypeBox omit ECMAScript 2021 findLastIndex YAML es-shim API https data create function rate RxJS chrome slice Stream from time type Array.prototype.filter password wget mime-db recursive busy Uint32Array parents rapid RFC-6455 break text css variable styleguide slot agent tape browserlist debugger file system last proxy xhr hardlinks rm -fr Array.prototype.includes classes object @@toStringTag postcss es7 workspace:*some entries emit crypto make accessibility .env optimizer zod validation syntaxerror css-in-js Array eslintconfig react-hook-form figlet crypt description dynamodb opens negative zero i18n Rx indicator state swf push app package.json safe lint trimLeft progress redux sqs symbols set environment spinners full find styles internal slot flags mobile es2015 Object.keys io-ts jest fastcopy eventDispatcher Push tap typedarrays ES2017 properties Array.prototype.flatten drop uuid buffer ajv stringifier persistent dayjs aws streams cors command zero argparse shell linewrap importexport bundling structuredClone ECMAScript 2016 dom-testing-library module react-hooks polyfill arrays launch bundler ECMAScript 3 Set replay extend preserve-symlinks pyyaml yup limit resolve art terminal up Object.values name callbound weakset CSS link ie fast-deep-clone compiler getOwnPropertyDescriptor ascii regular expressions awesomesauce escape length keys output symbol ArrayBuffer#slice yaml workflow ecmascript find-up stdlib Array.prototype.flatMap URLSearchParams eslintplugin promises exec scheme-validation reuse patch es5 operating-system es-shims ArrayBuffer.prototype.slice pretty fs electron regexp unicode syntax ast bdd bluebird JSON-Schema ReactiveX has deep-copy typed array getintrinsic column Object.defineProperty String.prototype.matchAll tdd descriptors includes wordbreak serialization deterministic byte chromium diff CSSStyleDeclaration symlink elm arktype path own lesscss robust types dom global parsing tostringtag ts emr elasticache trim plugin compare jQuery kinesis dataView live censor arraybuffer protobuf Uint8Array private react-testing-library sequence prune pipe Array.prototype.contains jsonpath forms tty StyleSheet tslib jasmine assign css nesting Iterator collection.es6 warning javascript fullwidth s3 getopt elb match minimal flag serializer route53 write dependencies flux date prefix ansi argument datastructure duplex bcrypt jshint Map equality ES2023 pnpm9 ES7 banner getter browser accessor Array.prototype.findLast wait shared jsdiff settings readable cloudtrail trimStart await curl xdg fastify expression ender picomatch RegExp#flags findLast names option metadata hooks concatMap ECMAScript 2017 guid columns rgb typanion classname rmdir mapreduce is formatting view Object concat logger gdpr reducer argv monorepo watchFile core invariant mocha qs call-bound exit-code Microsoft Object.assign joi request quote stringify es2017 endpoint redux-toolkit glob util.inspect deepcopy phone mkdirp less queue xterm middleware stream ES2021 fastclone loading encryption json Streams fetch tester style es-abstract immutable typesafe Symbol.toStringTag cmd task read callbind whatwg regular expression hasOwn has-own jsdom ES vpc Array.prototype.flat signals lru restful globals opener mimetypes readablestream check react connect file watch colour walk process command-line watching urls url gradients css3 HyBi which storagegateway glacier speed ES3 Int32Array term random sharedarraybuffer ECMAScript 2022 preprocessor fast-clone full-width ECMAScript 7 cli visual ES2020 nope Float64Array Observable utilities delete querystring rm weakmap code points interrupts Object.entries testing proto xdg-open cloudwatch array Underscore waf es colors WebSocket hash sigint auth sameValueZero valid intrinsic matches isConcatSpreadable env mkdir mkdirs browserslist worker real-time WebSockets walking JSON optimist look authentication identifiers Float32Array ava east-asian-width airbnb every package manager WeakSet query import sigterm idle private data bind amazon protocol-buffers getPrototypeOf BigInt64Array start bound inspect commander ReactiveExtensions higher-order stateless width negative tools stylesheet limited eslint concurrency windows installer key Promise ses karma status number toSorted functions RegExp.prototype.flags korean TypeScript framework ajax obj ES8 Array.prototype.findLastIndex console superstruct hot Function.prototype.name es2018 deepclone arguments fps styled-components inference mixins ESnext tc39 args typeof dir filter packages BigUint64Array performance setPrototypeOf jwt call efficient less css log sham setter URL rest wordwrap throttle vars starter throat positive consume cloudfront exe core-js toArray Uint16Array toobject ES2019 postcss-plugin trimRight symlinks listeners mime css streams2 immer iterator cloudformation traverse rfc4122 japanese rangeerror lazy enumerable default http telephone rds codes less compiler characters reduce superagent exit touch sinatra take byteLength fast linux findup uninstall dependency manager moment wrap sorted toolkit cache editor matchAll channel circular bootstrap less spinner _.extend cjk helpers asserts css less regular offset assert move functional iterate shim es2016 coercible chinese jsx libphonenumber remove es6 variables WeakMap once chai 0 less.js prototype eventEmitter classnames define make dir iteration signal prop emoji express router dataview copy look-up multi-package string modules sort extra bootstrap css spawn web open ponyfill l10n eslint-plugin less mixins npm ECMAScript 2015 id defineProperty spec ebs beanstalk ES2018 validate simpledb

@devtea2025/ad-officia-ipsam-velit is a Node.js module to mask various kinds of data. With the help of @devtea2025/ad-officia-ipsam-velit, you can mask email, phone number, card number, JSON fields, password, etc... Also, it provides utility methods to get a field, or replace a field from any complex/nested JSON.

Features

Mask Card numbers
Mask Email ids
Mask Password
Mask Phone numbers
Mask the given words/substrings from throughout a String
Mask UUIDs
Mask JWT tokens
Mask JSON - JSON can contain cards, emails, passwords, phones, strings, and UUIDs. Mask all of them with a single call using - Mask JSON fields
Get nested field from JSON
Set/Replace nested field values from JSON
Maskdata for typescript

Install @devtea2025/ad-officia-ipsam-velit

npm i @devtea2025/ad-officia-ipsam-velit

Release Features

Version 1.3.1

Removal of maskJSONFields function: https://www.npmjs.com/package/@devtea2025/ad-officia-ipsam-velit/v/1.1.10#mask-fields-in-a-json
String mask version2 for generic string masking in response to the below issues: Details
- https://github.com/devtea2025/ad-officia-ipsam-velit/issues/17
- https://github.com/devtea2025/ad-officia-ipsam-velit/issues/40
- https://github.com/devtea2025/ad-officia-ipsam-velit/issues/42
Supporting generic string masking(string mask V2) as part of maskJson2: generic String masking in a JSON

Version 1.2.6

JWT token masking: Mask JWT tokens with configs to mask as per your need. More details: Mask JWT Token
Mask Json now supports JWT token masking also. More details: Mask JWT in a JSON
Bug fix in maskJson2 where it was not checking for the empty/null/undefined fields and was resulting in error "TypeError: validatedConfig[typeToFunctionMap[key][1]] is not iterable"
Better test coverage to the module with the addition of new test cases

Version 1.2.3

Bug fix for masking a list of elements in the nested json. More details: Mask multiple fields
Deprecated maskJsonFields(For documentation on the maskJsonFields, check previous version README.md files) function and will be removed in the subsequent versions. Use maksJson2 instead: https://www.npmjs.com/package/@devtea2025/ad-officia-ipsam-velit#mask-json

How to Use

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

Maskdata for Typescript

Follow this document for more details: Maskdata for typescript

Mask card number

This will mask the digits in a card number.This will mask only the numerical data and not any non-numeric delimiters, alphabets, or any other types of data

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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

Mask Email id

Use this method instead of maskEmail(). To mask with the default options, don't pass the configurations.

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

const emailMask2Options = {
    maskWith: "*", 
    unmaskedStartCharactersBeforeAt: 3,
    unmaskedEndCharactersAfterAt: 2,
    maskAtTheRate: false
};

const email = "[email protected]";

const maskedEmail = MaskData.maskEmail2(email, emailMask2Options);

//Output: my.********@**********om

Consider an email: [email protected]

Here,

number of characters before @ -> 4
number of characters after @ --> 9

unmaskedStartCharactersBeforeAt --> number of starting characters (before @)not to be masked.
- If unmaskedStartCharactersBeforeAt > number of characters before @, then it will not mask the characters before @
unmaskedEndCharactersAfterAt --> number of characters not to be masked starting from the end till @.
- If unmaskedEndCharactersAfterAt > number of characters after @, then it will not mask the characters after @

Mask only the characters before '@'

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

const emailMask2Options = {
    maskWith: "*", 
    unmaskedStartCharactersBeforeAt: 0,
    unmaskedEndCharactersAfterAt: 257, // Give a number which is more than the characters after @
    maskAtTheRate: false
};

const email = "[email protected]";

const maskedEmail = MaskData.maskEmail2(email, emailMask2Options);

//Output: ****@email.com

Mask Email id with the default configuration

To mask with the default options, don't pass the configurations.

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

/** Default Options
    maskWith: "*", 
    unmaskedStartCharactersBeforeAt: 3,
    unmaskedEndCharactersAfterAt: 2,
    maskAtTheRate: false
**/
const email = "[email protected]";

const maskedEmail = MaskData.maskEmail2(email);

//Output: my.********@**********om

Mask JSON

This is the new functionality in version 1.2.0+ to handle masking of multiple types of data in the JSON object with a single mask function call.

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

// 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

    // For passwords, tokens, etc...
    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: [
      {
        config: defaultStringMaskV2Options,
        fields: []
      }
    ]
};

NOTE: For details on the configs mentioned above, refer: defaultCardMaskOptions defaultEmailMask2Options defaultPasswordMaskOptions defaultPhoneMaskOptions defaultStringMaskOptions defaultUuidMaskOptions defaultJwtMaskOptions defaultStringMaskV2Options / generic String Maksing

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

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

    passwordMaskOptions: {
        maskWith: "*",
        maxMaskedCharacters: 16,
        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 other types of data. 
    genericStrings: [
      {
        config: {
          maskWith: "*",
          maxMaskedCharacters: 256,
          unmaskedStartDigits: 0,
          unmaskedEndDigits: 0
        },
        fields: []
      }
    ]
};

JSON mask examples

Example1:

const jsonInput = {
  'credit': '1234-5678-8765-1234', 
  'debit': '0000-1111-2222-3333', 
  'primaryEmail': '[email protected]', 
  'secondaryEmail': '[email protected]',
  '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);

Output:
{
  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']
    }
  }
}


Example2: Mask with custom configs for each/any type of fields

const jsonInput2 = {
  'credit': '1234-5678-8765-1234', 
  'debit': '0000-1111-2222-3333', 
  'primaryEmail': '[email protected]', 
  'secondaryEmail': '[email protected]',
  '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);

Output:

{
  credit: '12XX-XXXX-XXXX-1234',
  debit: '00XX-XXXX-XXXX-3333',
  primaryEmail: 'pr*****@*******om',
  secondaryEmail: 'se*******@*******om',
  password: '**********',
  homePhone: '+1**********0',
  workPhone: '+1**********0',
  addressLine1: '**** ** ** *********** ** **** ** ** ****',
  addressLine2: '*********** *',
  uuid1: '123e****-****-****-****-**********00'
}

Example3: Mask nested json fields -> Use dot(.) and Array([]) notation to specify the inner fields.


const jsonInput2 = {
  cards: {
    creditCards: ['1234-5678-8765-1234', '1111-2222-1111-2222'],
    debitCards: ['0000-1111-2222-3333', '2222-1111-3333-4444']
  },
  emails: {
    primaryEmail: '[email protected]', 
    secondaryEmail: '[email protected]'
  },
  passwords: [
    ['dummyPasswordANDdummyPassword', 'dummyPasswordANDdummyPassword']
  ],
  phones: {
    homePhone: "+1 1234567890",
    workPhone: "+1 9876543210",
  },
  address: {
    addressLine1: "This is my addressline 1. This is my home",
    addressLine2: "AddressLine 2"
  },
  uuids: {
    uuid1: '123e4567-e89b-12d3-a456-426614174000'
  },
  jwt: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ'
};

const jsonMaskConfig2 = {
    // Card
    cardMaskOptions: { maskWith: "X", unmaskedStartDigits: 2,unmaskedEndDigits: 4 },
    cardFields: ['cards.creditCards[0]', 'cards.creditCards[1]', 'cards.debitCards[0]', 'cards.debitCards[1]'],

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

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

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

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

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

    // JWT
    jwtMaskOptions: { maskWith: '*', maxMaskedCharacters: 512, maskDot: true, maskHeader: true, maskPayload: true, maskSignature: true},
    jwtFields: ['jwt']
};

const maskedJsonOutput2 = MaskData.maskJSON2(jsonInput2, jsonMaskConfig2);
// OUTPUT:
{
  cards: {
    creditCards: [ '12XX-XXXX-XXXX-1234', '11XX-XXXX-XXXX-2222' ],
    debitCards: [ '00XX-XXXX-XXXX-3333', '22XX-XXXX-XXXX-4444' ]
  },
  emails: {
    primaryEmail: 'pr*****@*******om',
    secondaryEmail: 'se*******@*******om'
  },
  passwords: [ [ '**********', '**********' ] ],
  phones: { homePhone: '+1**********0', workPhone: '+1**********0' },
  address: {
    addressLine1: '**** ** ** *********** ** **** ** ** ****',
    addressLine2: '*********** *'
  },
  uuids: { uuid1: '123e****-****-****-****-**********00' },
  jwt: '*********************************************************************************************************'
}

Mask Password

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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 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: **********

## Mask Password with the default configuration
To mask with the default options, don't pass the configurations.
```javascript
const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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

const password = "Password1$";

const maskedPassword = MaskData.maskPassword(password)

Example: Mask password OR secretKey with some meta info at the end

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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
};

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

Mask Phone Number

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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

Mask Phone Number with the default configuration

To mask with the default options, don't pass the configurations.

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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

const maskedPhoneNumber = MaskData.maskPhone(phoneNumber);

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

Generic string masking

This functionality can be used to mask any string with the below configs.

Example1

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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 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: **********

Example2

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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

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

Mask the characters or words in the string

This will mask the characters or words if present in the given string.

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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

  /** 
   * It is the words/substrings to mask. 
   * Should be an array of strings.
   * Can give multiple words/substrings.
   * values[] can be used only when maskAll is false. If maskAll is true, then this is of no use.
  */
  values: ['is', 'test'], 

  /** 
   * If to mask only the first occurrence of each word/substring in the given string
   * Should be boolean
   * Default value is false
  */
  maskOnlyFirstOccurance: false,

  /** 
   * If to mask all the characters in a string make maskAll: true
   * If maskAll is true, the words/substrings inside values[] will not be considered. 
   * Default value is false
  */
  maskAll: false,

  /** 
   * This is to mask/not mask the spaces in a string when masking all the characters.
   * Can be used ONLY when maskAll: true
   * If maskSpace is false, the spaces in the string will not be masked.
   * This feature is to know the words and each word's length but to hide the content
   * Default value is true
  */
  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

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 UUID

This will mask the alphanumeric characters in a UUID.This will not mask the hyphen present in the UUID. Masking is done, only when the input is a valid UUID with only a-f, A-F, and 0-9 and has 36 characters (32 alphanumerics + 4 hyphens, and should work with the regex:

/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/g;).

If the input is not a valid UUID, it will return the input itself without masking.

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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: ********-****-****-****-************

Mask JWT Token

This function returns the masked JWT tokens. A JWT token consists of 3 parts separated by 2 dots. i.e, {header}.{payload}.{signature}. Based on the usecase, we will have to mask/keep a part/s of jwt token. With @devtea2025/ad-officia-ipsam-velit you can mask JWT tokens with all possible combinations. If the input is null, undefined, non-string, string with length < 5, doesn't contain 2 dots(invalid JWT format), the function will return the input as it is without masking.


const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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

  // Max masked characters in the output(EXCLUDING the unmasked characters). Default value is 512
  maxMaskedCharacters: 512,

  // Config to mask OR keep the dots(.). Default value is true, i.e, mask dots
  maskDot: true,

  // Config to mask OR keep the first part of the JWT. i.e, the header part. Default value is true, i.e, mask the header part
  maskHeader: true,

  // Config to mask OR keep the second part of the JWT. i.e, the payload part. Default value is true, i.e, mask the payload part
  maskPayload: true,

  // Config to mask OR keep the third part of the JWT. i.e, the signature part. Default value is true, i.e, mask the signature part
  maskSignature: true
};

const jwt =
  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ';

/** In this example,
 * Header = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
 * Payload = eyJpYXQiOjE1MTYyMzkwMjJ9
 * Signature = tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ
 */ 
const maskedJwt = MaskData.maskJwt(jwt, jwtMaskOptions);

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

Example: Mask only the signature part


const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

const jwtMaskOptions = {
  maskWith: '*',
  maxMaskedCharacters: 512,
  maskDot: false,
  maskHeader: false,
  maskPayload: false,
  maskSignature: true
};

const jwt =
  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ';

/** In this example,
 * Header = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
 * Payload = eyJpYXQiOjE1MTYyMzkwMjJ9
 * Signature = tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ
 */ 
const maskedJwt = MaskData.maskJwt(jwt, jwtMaskOptions);

// Output:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.*******************************************

Example: Mask header and the signature part


const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

const jwtMaskOptions = {
  maskWith: '*',
  maxMaskedCharacters: 512,
  maskDot: false,
  maskHeader: true,
  maskPayload: false,
  maskSignature: true
};

const jwt =
  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ';

/** In this example,
 * Header = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
 * Payload = eyJpYXQiOjE1MTYyMzkwMjJ9
 * Signature = tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ
 */ 
const maskedJwt = MaskData.maskJwt(jwt, jwtMaskOptions);

// Output:
************************************.eyJpYXQiOjE1MTYyMzkwMjJ9.*******************************************

Example: Mask all parts except dots and limit the max masked characters in the output to lower value, say 16


const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

const jwtMaskOptions = {
  maskWith: '*',
  maxMaskedCharacters: 16,
  maskDot: false,
  maskHeader: true,
  maskPayload: true,
  maskSignature: true
};

const jwt =
  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTYyMzkwMjJ9.tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ';

/** In this example,
 * Header = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
 * Payload = eyJpYXQiOjE1MTYyMzkwMjJ9
 * Signature = tbDepxpstvGdW8TC3G8zg4B6rUYAOvfzdceoH48wgRQ
 */ 
const maskedJwt = MaskData.maskJwt(jwt, jwtMaskOptions);

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

Get Nested JSON Property

This method returns the value of the nested JSON property if it exists. Otherwise, it returns undefined

const MaskData = require('./@devtea2025/ad-officia-ipsam-velit');

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');

Replace the value of a JSON field

To replace a value by keeping the type.


const input = {
  name: "John",
  age: 33,
  married: true
}

let afterReplacing = MaskData.replaceValue(input, 'age', 99);
afterReplacing = MaskData.replaceValue(input, 'married', false);

//Output: 
Before replacing: {"name":"John","age":33,"married":true}
After replacing: {"name":"John","age":99,"married":false}

Type of age: number
Type of married: boolean

Mask Multiple Fields

const jsonInput = {
  cards: [
    {
      number: '1234-5678-8765-1234'
    },
    {
      number: '1111-2222-1111-2222'
    },
    {
      number: '0000-1111-2222-3333'
    },
    {
      name: "No card number here"
    }
  ],
  emails: {
    primaryEmail: '[email protected]', 
    secondaryEmail: '[email protected]',
    moreEmails: ["[email protected]", "[email protected]", "[email protected]", {childEmail: "[email protected]", secondChild: {nestedkid: "[email protected]"}}]
  },
  array: ["element1", "element22", "element333"],
  jwt: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJsb2wiLCJuYW1lIjoiVGVzdCIsImlhdCI6ImxvbCJ9.XNDxZcBWWEKYkCiu6XFGmAeuPF7iFnI7Sdv91gVZJMU'
};

const jsonMaskConfig = {
  cardMaskOptions: { maskWith: "X", unmaskedStartDigits: 0, unmaskedEndDigits: 0},

  emailMaskOptions: { maskWith: "*", unmaskedStartCharactersBeforeAt: 0, 
  unmaskedEndCharactersAfterAt: 0, maskAtTheRate: false },

  stringMaskOptions: { maskWith: "?", maskOnlyFirstOccurance: false, values: [], maskAll: true, maskSpace: false },
  jwtMaskOptions: { maskWith: '*', maxMaskedCharacters: 32, maskDot: false, maskHeader: true, maskPayload: true, maskSignature: true},

  cardFields: ['cards[*].number'],
  emailFields: ['emails.*'],
  stringFields: ['array.*'],
  jwtFields: ['jwt']
}

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

// Output: 
{
  "cards": [
    {
      "number": "XXXX-XXXX-XXXX-XXXX"
    },
    {
      "number": "XXXX-XXXX-XXXX-XXXX"
    },
    {
      "number": "XXXX-XXXX-XXXX-XXXX"
    },
    {
      "name": "No card number here"
    }
  ],
  "emails": {
    "primaryEmail": "*******@*********",
    "secondaryEmail": "*********@*********",
    "moreEmails": [
      "******@*********",
      "******@*********",
      "******@*********",
      {
        "childEmail": "*****@*********",
        "secondChild": {
          "nestedkid": "*****@*********"
        }
      }
    ]
  },
  "array": ["????????", "?????????", "??????????"],
  "jwt": "************.**********.**********"
}

Report Bugs

If there is any help needed with the library functionalities or if there is any bug/issue, please raise an issue in GitHub: https://github.com/devtea2025/ad-officia-ipsam-velit/issues

Give a Star

You can give a star at: https://github.com/devtea2025/ad-officia-ipsam-velit/stargazers

LICENSE - "MIT"

Licensed under MIT Licence

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.