@verifiedinc-public/shared-ui-elements 0.14.5-beta.3 → 0.14.5-beta.4

package/dist/utils/index.d.ts

@@ -3,3 +3,4 @@ export * from './date';
 export * from './phone';
 export * from './masks/index';
 export * from './omitProperty';
+export * from './ssn';

package/dist/utils/ssn.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Formats a SSN to the following format: •••-••-3333
+ * accepts SSNs with or without dashes (e.g. '111-22-3333' or '11223333')
+ * @param {string} rawValue the raw value of the ssncredential
+ * @returns {string} the formatted value
+ */
+export declare const ssnFormatter: (rawValue: string) => string;

package/dist/validations/ssn.schema.d.ts

@@ -1,2 +1,8 @@
 import { z } from 'zod';
 export declare const SSNSchema: z.ZodString;
+/**
+ * It accepts SSN in the format '•••-••-1900' or '123-45-6789'.
+ * When dealing with masked SSN, in the backend you will need to call 1-Click API GET to get the unmasked version of SSN again.
+ * If this is the user input SSN there will be no need to call the 1-Click API GET.
+ */
+export declare const MaskedAndUnmaskedSSNSchema: z.ZodEffects<z.ZodString, string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verifiedinc-public/shared-ui-elements",
-  "version": "0.14.5-beta.3",
+  "version": "0.14.5-beta.4",
   "description": "A set of UI components, utilities that is shareable with the core apps.",
   "private": false,
   "keywords": [],

package/src/utils/index.ts

@@ -3,3 +3,4 @@ export * from './date';
 export * from './phone';
 export * from './masks/index';
 export * from './omitProperty';
+export * from './ssn';

package/src/utils/ssn.ts

@@ -0,0 +1,8 @@
+/**
+ * Formats a SSN to the following format: •••-••-3333
+ * accepts SSNs with or without dashes (e.g. '111-22-3333' or '11223333')
+ * @param {string} rawValue the raw value of the ssncredential
+ * @returns {string} the formatted value
+ */
+export const ssnFormatter = (rawValue: string) =>
+  rawValue.replace(/(\d{3})-?(\d{2})-?(\d{4})/, '•••-••-$3');

package/src/validations/ssn.schema.ts

@@ -4,3 +4,21 @@ import { z } from 'zod';
 export const SSNSchema = z
   .string()
   .regex(/^(?!666|000|9\d{2})\d{3}(?!00)\d{2}(?!0{4})\d{4}$/);
+
+/**
+ * It accepts SSN in the format '•••-••-1900' or '123-45-6789'.
+ * When dealing with masked SSN, in the backend you will need to call 1-Click API GET to get the unmasked version of SSN again.
+ * If this is the user input SSN there will be no need to call the 1-Click API GET.
+ */
+// SSN schema, unmasked validation regex were gathered from: https://uibakery.io/regex-library/ssn
+export const MaskedAndUnmaskedSSNSchema = z.string().refine(
+  (val) => {
+    const maskedRegex = /^•••-••-(\d{4})$/;
+    const unmaskedRegex = /^(?!666|000|9\d{2})\d{3}(?!00)\d{2}(?!0{4})\d{4}$/;
+
+    return maskedRegex.test(val) || unmaskedRegex.test(val);
+  },
+  {
+    message: 'Invalid SSN',
+  },
+);