feat: add new api for masked contact number in phone number module [ATLAS-197]

[RgnDunes]

Description

This module adds a new API that returns us a masked contact number as shown below:

// Example: 

// Masking a U.S. phone number completely
console.log(
  getMaskedPhoneNumber({
    countryCode: 'US',
    phoneNumber: '2025550125',
    withDialCode: true,
  }),
);
// Output: +1 xxx-xxx-xxxx

// Partially masking an Indian phone number, hiding the last 6 digits
console.log(
  getMaskedPhoneNumber({
    countryCode: 'IN',
    phoneNumber: '9876543210',
    maskingOptions: {
      maskingStyle: 'suffix',
      maskedDigitsCount: 6,
      maskingChar: '*',
    },
    withDialCode: true,
  }),
);
// Output: +91 9876**-****

// Formatting and completely masking a phone number for Brazil without specifying a phone number
console.log(
  getMaskedPhoneNumber({
    countryCode: 'BR',
  }),
);
// Output: xx xxxx-xxxx

Changes Made

List the main changes made in this pull request.

Title	---
JIRA link	https://razorpay.atlassian.net/browse/ATLAS-197
Slack thread (if any)	NA
Product spec	NA
Tech spec/One-pager	NA
Bundle Size Difference	NA
Fixes Issue	NA

Type of change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [x] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [x] This change requires a documentation update
• [x] This change is a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• [x] Is your change backward compatible ?
• [x] Tested on major browsers (Chrome, Firefox, Safari, IE) ?
• [x] Tested in a consumer application(s) ?

Additional Notes

Any additional information that would be helpful for the reviewer.

Checklist:

• [x] Add Jira ID(s) in PR title and in the description?
• [x] I have performed a self-review of my code
• [x] I have commented my code, particularly in hard-to-understand areas
• [x] My code is written in TypeScript and follows the coding standards of the project.
• [x] I have added relevant documentation and updated the README if necessary.
• [x] My commit messages are clear and follow the project's commit message conventions.
• [x] Is any external library added?
• [x] My changes do not introduce any new runtime errors or warnings.
• [x] All relevant unit tests have been added/updated in my PR for the change.
• [NA] Any Screenshots (mobile & desktop) required for PR? If yes, have you added the respective screenshots ?
• [x] Any manual dev testing done by you on beta/func environment?
• [x] Reviewer added (SLA 2 days)

Reviewer Checklist

• [ ] Sufficient QA/Dev-Testing is done with proof (test cases list)
• [ ] Ensure that the change in bundle size falls within the acceptable range.

---

PR Title Format

Format: <type>: <subject>

Types can be as follows:

• feat: (new feature for the user, not a new feature for build script)
• fix: (bug fix for the user, not a fix to a build script)
• docs: (changes to the documentation)
• style: (formatting, missing semi colons, etc; no production code change)
• refactor: (refactoring production code, eg. renaming a variable)
• test: (adding missing tests, refactoring tests; no production code change)
• chore: (updating grunt tasks etc; no production code change)

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: e4b328b059a32515f1d1e278b16ef7b304947eaa

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

| Name | Type | | ----------------------- | ----- | | @razorpay/i18nify-js | Minor | | @razorpay/i18nify-react | Major |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 4f1dccdf.

[rzpcibot]

	Warnings
:warning:	Your PR has over 600 lines of code additions :scream: . Try to breakup into separate PRs :+1:

Bundle Size Report

Files

click to expand/collapse

| 🟢 No Change | 🗑 File Deleted | 🆕 New File | 📈 Size Increased | 👍 Size Reduced | | --- | --- | --- | --- | --- |

		Parsed (kb)
🚦	File Name	Base	PR	Diff	%
📈	cjs/index.js	138.9	146.13	$\textcolor{red}{7.23}$	5.21
📈	esm/index.min.js	51.45	52.74	$\textcolor{red}{1.29}$	2.51
📈	umd/index.js	158.85	166.67	$\textcolor{red}{7.82}$	4.92

Generated by :no_entry_sign: dangerJS against e4b328b059a32515f1d1e278b16ef7b304947eaa

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 21cdd204.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 58340142.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 51f0427c.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 07ae9e38.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit b7c1b9c3.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 516c1499.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 23384b40.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 418cd4c2.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 5983c45f.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 1c53298f.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit a322fec2.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit ebd1ebd6.

[github-actions[bot]]

Unit Test Results

0 files  0 suites   0s :stopwatch: 0 tests 0 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit 84ef659a.