redux-freeform 6.1.0 → 6.2.0-beta.0

package/dist/redux-freeform.cjs.js

@@ -115,6 +115,8 @@ validatorFns[ONLY_EXPIRATION_DATE] = (value, args, form) =>
 This validator will check if the value has more than 6 numeric characters
 We have to allow for some numeric characters to account for business
 names that include numbers like "3M Company" or "Smith Street Trust 40389"
+
+1/25 - This has been superseded by the includesPotentialCardNumber validator
 */
 const NO_MORE_THAN_SIX_NUMBERS = 'validator/NO_MORE_THAN_SIX_NUMBERS';
 const NO_MORE_THAN_SIX_NUMBERS_ERROR = 'error/NO_MORE_THAN_SIX_NUMBERS';
@@ -129,6 +131,81 @@ validatorFns[NO_MORE_THAN_SIX_NUMBERS] = (value) => {
   return !/(\d.*){7,}/.test(value);
 };
 
+/*
+ * 1/25 - Prevent users from entering full credit card numbers in the "name" field.
+ *
+ * This validator is designed to reduce the accidental inclusion of credit card numbers
+ * in fields where they don't belong (e.g., the name field). It identifies a potential
+ * credit card number based on the following criteria:
+ *
+ * - It consists of 8 to 20 digits.
+ * - Digits may be separated by optional spaces or hyphens.
+ * - It must pass the Luhn algorithm check.
+ *
+ * Note:
+ *   A string passing the Luhn algorithm is necessary but not sufficient to conclusively
+ *   determine that the string is a valid credit card number.
+ *
+ * For more details on the Luhn algorithm, refer to:
+ * https://stripe.com/en-ca/resources/more/how-to-use-the-luhn-algorithm-a-guide-in-applications-for-businesses#luhn-algorithm-formula
+ */
+
+function luhnValid(string) {
+  if (!string) {
+    return false;
+  }
+
+  const digits = string.match(/\d/g);
+  if (!digits) {
+    return false;
+  }
+
+  const digitArray = digits.map(Number);
+  let totalSum = 0;
+
+  // Start from the right.
+  for (let i = digitArray.length - 1; i >= 0; i -= 2) {
+    const lastDigit = digitArray[i];
+    const secondToLastDigit = digitArray[i - 1];
+
+    if (secondToLastDigit !== undefined) {
+      // Double the value of the second-to-last digit and continue doing the same for every second digit.
+      let secondToLastDigitDoubled = secondToLastDigit * 2;
+
+      // If the result of any doubling operation is greater than nine,
+      // then add the digits of the result together to obtain a single-digit number.
+      if (secondToLastDigitDoubled > 9) {
+        secondToLastDigitDoubled -= 9;
+      }
+
+      totalSum += secondToLastDigitDoubled;
+    }
+
+    // Find the sum of all the digits that you didn't double and the new values that you got from doubling.
+    totalSum += lastDigit;
+  }
+
+  // Determine if the total sum is a multiple of ten.
+  // According to the Luhn algorithm, the number is considered to be valid if the total ends in zero.
+  return totalSum % 10 === 0;
+}
+
+const INCLUDES_POTENTIAL_CARD_NUMBER =
+  'validator/INCLUDES_POTENTIAL_CARD_NUMBER';
+const INCLUDES_POTENTIAL_CARD_NUMBER_ERROR =
+  'error/INCLUDES_POTENTIAL_CARD_NUMBER';
+createValidator(
+  INCLUDES_POTENTIAL_CARD_NUMBER,
+  INCLUDES_POTENTIAL_CARD_NUMBER_ERROR
+);
+validatorFns[INCLUDES_POTENTIAL_CARD_NUMBER] = (value) => {
+  // This is the same regex currently used in Ghenghis
+  // A potential credit card number is a sequence of 8 to 20 digits, with optional spaces or hyphens between them
+  const regexString = '(?:\\d[ -]*){8,20}';
+  const regex = new RegExp(regexString);
+  return regex.test(value) && luhnValid(value);
+};
+
 const NUMBER_LESS_THAN = 'validator/NUMBER_LESS_THAN';
 const NUMBER_LESS_THAN_ERROR = 'error/NUMBER_LESS_THAN';
 const numberLessThan = createValidator(

package/dist/redux-freeform.esm.js

@@ -111,6 +111,8 @@ validatorFns[ONLY_EXPIRATION_DATE] = (value, args, form) =>
 This validator will check if the value has more than 6 numeric characters
 We have to allow for some numeric characters to account for business
 names that include numbers like "3M Company" or "Smith Street Trust 40389"
+
+1/25 - This has been superseded by the includesPotentialCardNumber validator
 */
 const NO_MORE_THAN_SIX_NUMBERS = 'validator/NO_MORE_THAN_SIX_NUMBERS';
 const NO_MORE_THAN_SIX_NUMBERS_ERROR = 'error/NO_MORE_THAN_SIX_NUMBERS';
@@ -125,6 +127,81 @@ validatorFns[NO_MORE_THAN_SIX_NUMBERS] = (value) => {
   return !/(\d.*){7,}/.test(value);
 };
 
+/*
+ * 1/25 - Prevent users from entering full credit card numbers in the "name" field.
+ *
+ * This validator is designed to reduce the accidental inclusion of credit card numbers
+ * in fields where they don't belong (e.g., the name field). It identifies a potential
+ * credit card number based on the following criteria:
+ *
+ * - It consists of 8 to 20 digits.
+ * - Digits may be separated by optional spaces or hyphens.
+ * - It must pass the Luhn algorithm check.
+ *
+ * Note:
+ *   A string passing the Luhn algorithm is necessary but not sufficient to conclusively
+ *   determine that the string is a valid credit card number.
+ *
+ * For more details on the Luhn algorithm, refer to:
+ * https://stripe.com/en-ca/resources/more/how-to-use-the-luhn-algorithm-a-guide-in-applications-for-businesses#luhn-algorithm-formula
+ */
+
+function luhnValid(string) {
+  if (!string) {
+    return false;
+  }
+
+  const digits = string.match(/\d/g);
+  if (!digits) {
+    return false;
+  }
+
+  const digitArray = digits.map(Number);
+  let totalSum = 0;
+
+  // Start from the right.
+  for (let i = digitArray.length - 1; i >= 0; i -= 2) {
+    const lastDigit = digitArray[i];
+    const secondToLastDigit = digitArray[i - 1];
+
+    if (secondToLastDigit !== undefined) {
+      // Double the value of the second-to-last digit and continue doing the same for every second digit.
+      let secondToLastDigitDoubled = secondToLastDigit * 2;
+
+      // If the result of any doubling operation is greater than nine,
+      // then add the digits of the result together to obtain a single-digit number.
+      if (secondToLastDigitDoubled > 9) {
+        secondToLastDigitDoubled -= 9;
+      }
+
+      totalSum += secondToLastDigitDoubled;
+    }
+
+    // Find the sum of all the digits that you didn't double and the new values that you got from doubling.
+    totalSum += lastDigit;
+  }
+
+  // Determine if the total sum is a multiple of ten.
+  // According to the Luhn algorithm, the number is considered to be valid if the total ends in zero.
+  return totalSum % 10 === 0;
+}
+
+const INCLUDES_POTENTIAL_CARD_NUMBER =
+  'validator/INCLUDES_POTENTIAL_CARD_NUMBER';
+const INCLUDES_POTENTIAL_CARD_NUMBER_ERROR =
+  'error/INCLUDES_POTENTIAL_CARD_NUMBER';
+createValidator(
+  INCLUDES_POTENTIAL_CARD_NUMBER,
+  INCLUDES_POTENTIAL_CARD_NUMBER_ERROR
+);
+validatorFns[INCLUDES_POTENTIAL_CARD_NUMBER] = (value) => {
+  // This is the same regex currently used in Ghenghis
+  // A potential credit card number is a sequence of 8 to 20 digits, with optional spaces or hyphens between them
+  const regexString = '(?:\\d[ -]*){8,20}';
+  const regex = new RegExp(regexString);
+  return regex.test(value) && luhnValid(value);
+};
+
 const NUMBER_LESS_THAN = 'validator/NUMBER_LESS_THAN';
 const NUMBER_LESS_THAN_ERROR = 'error/NUMBER_LESS_THAN';
 const numberLessThan = createValidator(

package/dist/redux-freeform.umd.js

@@ -117,6 +117,8 @@
   This validator will check if the value has more than 6 numeric characters
   We have to allow for some numeric characters to account for business
   names that include numbers like "3M Company" or "Smith Street Trust 40389"
+
+  1/25 - This has been superseded by the includesPotentialCardNumber validator
   */
   const NO_MORE_THAN_SIX_NUMBERS = 'validator/NO_MORE_THAN_SIX_NUMBERS';
   const NO_MORE_THAN_SIX_NUMBERS_ERROR = 'error/NO_MORE_THAN_SIX_NUMBERS';
@@ -131,6 +133,81 @@
     return !/(\d.*){7,}/.test(value);
   };
 
+  /*
+   * 1/25 - Prevent users from entering full credit card numbers in the "name" field.
+   *
+   * This validator is designed to reduce the accidental inclusion of credit card numbers
+   * in fields where they don't belong (e.g., the name field). It identifies a potential
+   * credit card number based on the following criteria:
+   *
+   * - It consists of 8 to 20 digits.
+   * - Digits may be separated by optional spaces or hyphens.
+   * - It must pass the Luhn algorithm check.
+   *
+   * Note:
+   *   A string passing the Luhn algorithm is necessary but not sufficient to conclusively
+   *   determine that the string is a valid credit card number.
+   *
+   * For more details on the Luhn algorithm, refer to:
+   * https://stripe.com/en-ca/resources/more/how-to-use-the-luhn-algorithm-a-guide-in-applications-for-businesses#luhn-algorithm-formula
+   */
+
+  function luhnValid(string) {
+    if (!string) {
+      return false;
+    }
+
+    const digits = string.match(/\d/g);
+    if (!digits) {
+      return false;
+    }
+
+    const digitArray = digits.map(Number);
+    let totalSum = 0;
+
+    // Start from the right.
+    for (let i = digitArray.length - 1; i >= 0; i -= 2) {
+      const lastDigit = digitArray[i];
+      const secondToLastDigit = digitArray[i - 1];
+
+      if (secondToLastDigit !== undefined) {
+        // Double the value of the second-to-last digit and continue doing the same for every second digit.
+        let secondToLastDigitDoubled = secondToLastDigit * 2;
+
+        // If the result of any doubling operation is greater than nine,
+        // then add the digits of the result together to obtain a single-digit number.
+        if (secondToLastDigitDoubled > 9) {
+          secondToLastDigitDoubled -= 9;
+        }
+
+        totalSum += secondToLastDigitDoubled;
+      }
+
+      // Find the sum of all the digits that you didn't double and the new values that you got from doubling.
+      totalSum += lastDigit;
+    }
+
+    // Determine if the total sum is a multiple of ten.
+    // According to the Luhn algorithm, the number is considered to be valid if the total ends in zero.
+    return totalSum % 10 === 0;
+  }
+
+  const INCLUDES_POTENTIAL_CARD_NUMBER =
+    'validator/INCLUDES_POTENTIAL_CARD_NUMBER';
+  const INCLUDES_POTENTIAL_CARD_NUMBER_ERROR =
+    'error/INCLUDES_POTENTIAL_CARD_NUMBER';
+  createValidator(
+    INCLUDES_POTENTIAL_CARD_NUMBER,
+    INCLUDES_POTENTIAL_CARD_NUMBER_ERROR
+  );
+  validatorFns[INCLUDES_POTENTIAL_CARD_NUMBER] = (value) => {
+    // This is the same regex currently used in Ghenghis
+    // A potential credit card number is a sequence of 8 to 20 digits, with optional spaces or hyphens between them
+    const regexString = '(?:\\d[ -]*){8,20}';
+    const regex = new RegExp(regexString);
+    return regex.test(value) && luhnValid(value);
+  };
+
   const NUMBER_LESS_THAN = 'validator/NUMBER_LESS_THAN';
   const NUMBER_LESS_THAN_ERROR = 'error/NUMBER_LESS_THAN';
   const numberLessThan = createValidator(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redux-freeform",
-  "version": "6.1.0",
+  "version": "6.2.0-beta.0",
   "description": "A small Redux form library that supports purely functional apps, without magic",
   "main": "dist/redux-freeform.cjs.js",
   "module": "dist/redux-freeform.esm.js",