card-validator - npm Package Compare versions

Comparing version 9.0.0 to 9.1.0

dist/card-number.d.ts

@@ -19,4 +19,5 @@ import type { Verification } from "./types";
     luhnValidateUnionPay?: boolean;
+    skipLuhnValidation?: boolean;
 };
 export declare function cardNumber(value: string | unknown, options?: CardNumberOptions): CardNumberVerification;
 export {};

dist/card-number.js

@@ -34,4 +34,5 @@ "use strict";
     }
-    if (cardType.type === getCardTypes.types.UNIONPAY &&
-        options.luhnValidateUnionPay !== true) {
+    if (options.skipLuhnValidation === true ||
+        (cardType.type === getCardTypes.types.UNIONPAY &&
+            options.luhnValidateUnionPay !== true)) {
         isValid = true;
@@ -38,0 +39,0 @@ }

package.json

 {
   "name": "card-validator",
-  "version": "9.0.0",
+  "version": "9.1.0",
   "description": "A library for validating credit card fields",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -79,2 +79,4 @@ # Credit Card Validator [![Build Status](https://github.com/braintree/card-validator/workflows/Unit%20Tests/badge.svg)](https://github.com/braintree/card-validator/actions?query=workflow%3A%22Unit+Tests%22) [![npm version](https://badge.fury.io/js/card-validator.svg)](http://badge.fury.io/js/card-validator)
 
+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
@@ -81,0 +83,0 @@ valid.number(<Maestro Card with 19 Digits>, {maxLength: 16});

src/__tests__/card-number.ts

@@ -352,2 +352,23 @@ import { cardNumber, CardNumberVerification } from "../card-number";
   });
+
+  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);
+    });
+  });
 });

src/card-number.ts

@@ -25,2 +25,3 @@ import luhn10 = require("./luhn-10");
   luhnValidateUnionPay?: boolean;
+  skipLuhnValidation?: boolean;
 };
@@ -71,4 +72,5 @@
   if (
-    cardType.type === getCardTypes.types.UNIONPAY &&
-    options.luhnValidateUnionPay !== true
+    options.skipLuhnValidation === true ||
+    (cardType.type === getCardTypes.types.UNIONPAY &&
+      options.luhnValidateUnionPay !== true)
   ) {
@@ -75,0 +77,0 @@ isValid = true;

No alert changes

Improved metrics

Total package byte prevSize

118584

increased by1.02%

Lines of code

3512

increased by0.6%

Number of lines in readme file

402

increased by0.5%

No dependency changes