card-validator 9.0.0 → 10.0.0

package/README.md

@@ -76,6 +76,8 @@ You can optionally pass `maxLength` as a property of an object as a second argum
 
 If a card brand has a normal max length that is shorter than the passed in max length, the validator will use the shorter one. For instance, if a `maxLength` of `16` is provided, the validator will still use `15` as the max length for American Express cards.
 
+You can optionally pass `skipLuhnValidation: true` as a property of an object as a second argument. This will override the default behaviour and will skip the validation of the check digit of the card number using Luhn Algorithm. The `skipLuhnValidation` **should not** be set to `true` in production environment.
+
 ```javascript
 valid.number(<Maestro Card with 19 Digits>, {maxLength: 16});
 
@@ -343,7 +345,7 @@ The `cvv` validation by default tests for a numeric string of 3 characters in le
 
 #### `valid.postalCode(value: string, [options: object]): object`
 
-The `postalCode` validation essentially tests for a valid string greater than 3 characters in length.
+The `postalCode` validation essentially ignores leading/trailing whitespace and tests for a valid string greater than 3 characters in length. It also verifies that the first 3 letters are alphanumeric.
 
 ```javascript
 {
@@ -352,7 +354,7 @@ The `postalCode` validation essentially tests for a valid string greater than 3
 }
 ```
 
-You can optionally pass `minLength` as a property of an object as a second argument. This will override the default min length of 3.
+You can optionally pass `minLength` as a property of an object as a second argument. This will override the default min length of 3 and verify that the characters for the specified length are all alphanumeric.
 
 ```javascript
 valid.postalCode('123', {minLength: 5});

package/dist/card-number.d.ts

@@ -16,6 +16,7 @@ export interface CardNumberVerification extends Verification {
 type CardNumberOptions = {
     maxLength?: number;
     luhnValidateUnionPay?: boolean;
+    skipLuhnValidation?: boolean;
 };
 export declare function cardNumber(value: string | unknown, options?: CardNumberOptions): CardNumberVerification;
 export {};

package/dist/card-number.js

@@ -31,8 +31,9 @@ function cardNumber(value, options) {
     if (options.maxLength && testCardValue.length > options.maxLength) {
         return verification(cardType, false, false);
     }
-    if (cardType.type === getCardTypes.types.UNIONPAY &&
-        options.luhnValidateUnionPay !== true) {
+    if (options.skipLuhnValidation === true ||
+        (cardType.type === getCardTypes.types.UNIONPAY &&
+            options.luhnValidateUnionPay !== true)) {
         isValid = true;
     }
     else {

package/dist/postal-code.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.postalCode = void 0;
 var DEFAULT_MIN_POSTAL_CODE_LENGTH = 3;
+var ALPHANUM = new RegExp(/^[a-z0-9]+$/i);
 function verification(isValid, isPotentiallyValid) {
     return { isValid: isValid, isPotentiallyValid: isPotentiallyValid };
 }
@@ -14,6 +15,9 @@ function postalCode(value, options) {
     else if (value.length < minLength) {
         return verification(false, true);
     }
+    else if (!ALPHANUM.test(value.trim().slice(0, minLength))) {
+        return verification(false, true);
+    }
     return verification(true, true);
 }
 exports.postalCode = postalCode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "card-validator",
-  "version": "9.0.0",
+  "version": "10.0.0",
   "description": "A library for validating credit card fields",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/__tests__/card-number.ts

@@ -349,4 +349,25 @@ describe("number validates", () => {
       expect(actual.isValid).toBe(true);
     });
   });
+
+  describe("Skip Luhn Validation", () => {
+    const number = "5732806135556590";
+    it("should fail validation for a card with invalid luhn check digit", () => {
+      const actual = cardNumber(number);
+
+      expect(actual.card.type).toBe("maestro");
+      expect(actual.isPotentiallyValid).toBe(true);
+      expect(actual.isValid).toBe(false);
+    });
+
+    it("should succeed validation for a card with invalid luhn check digit when using skipLuhnValidation=true", () => {
+      const actual = cardNumber(number, {
+        skipLuhnValidation: true,
+      });
+
+      expect(actual.card.type).toBe("maestro");
+      expect(actual.isPotentiallyValid).toBe(true);
+      expect(actual.isValid).toBe(true);
+    });
+  });
 });

package/src/__tests__/postal-code.ts

@@ -41,6 +41,16 @@ describe("postalCode", () => {
       [["hello world", { isValid: true, isPotentiallyValid: true }]],
     ],
 
+    [
+      "returns isPotentiallyValid for strings without alphanumeric first three characters",
+      [
+        ["123", { isValid: true, isPotentiallyValid: true }],
+        ["  123", { isValid: true, isPotentiallyValid: true }],
+        ["---", { isValid: false, isPotentiallyValid: true }],
+        ["   ---", { isValid: false, isPotentiallyValid: true }],
+      ],
+    ],
+
     [
       "returns isPotentiallyValid for shorter-than-3 strings",
       [
@@ -87,6 +97,10 @@ describe("postalCode", () => {
         isValid: true,
         isPotentiallyValid: true,
       });
+      expect(postalCode(" -$%", { minLength: 0 })).toEqual({
+        isValid: false,
+        isPotentiallyValid: true,
+      });
     });
   });
 });

package/src/card-number.ts

@@ -22,6 +22,7 @@ export interface CardNumberVerification extends Verification {
 type CardNumberOptions = {
   maxLength?: number;
   luhnValidateUnionPay?: boolean;
+  skipLuhnValidation?: boolean;
 };
 
 function verification(
@@ -67,8 +68,9 @@ export function cardNumber(
   }
 
   if (
-    cardType.type === getCardTypes.types.UNIONPAY &&
-    options.luhnValidateUnionPay !== true
+    options.skipLuhnValidation === true ||
+    (cardType.type === getCardTypes.types.UNIONPAY &&
+      options.luhnValidateUnionPay !== true)
   ) {
     isValid = true;
   } else {

package/src/postal-code.ts

@@ -5,6 +5,7 @@ type PostalCodeOptions = {
 };
 
 const DEFAULT_MIN_POSTAL_CODE_LENGTH = 3;
+const ALPHANUM = new RegExp(/^[a-z0-9]+$/i);
 
 function verification(
   isValid: boolean,
@@ -23,6 +24,8 @@ export function postalCode(
     return verification(false, false);
   } else if (value.length < minLength) {
     return verification(false, true);
+  } else if (!ALPHANUM.test(value.trim().slice(0, minLength))) {
+    return verification(false, true);
   }
 
   return verification(true, true);