Added credit card number string formats

Author: ericallam

README.md

@@ -15,10 +15,10 @@
   - [URI strings](#uri-strings)
   - [Email address strings](#email-address-strings)
   - [JWT Strings](#jwt-strings)
+  - [Credit Card Numbers](#credit-card-numbers)
   - [Other formats](#other-formats)
 - [Object Formats](#object-formats)
   - [Firestore Timestamps](#firestore-timestamps)
-- [Roadmap](#roadmap)
 
 ## 🚀 Features
 
@@ -266,6 +266,38 @@ Will result in
 }
 ```
 
+### Credit Card Numbers
+
+Strings that contain valid credit card numbers will be inferred with the `creditcard` format:
+
+```javascript
+inferType("4485428259658366");
+```
+
+Will result in
+
+```json
+{
+  "name": "string",
+  "value": "4485428259658366",
+  "format": {
+    "name": "creditcard",
+    "variant": "visa"
+  }
+}
+```
+
+The following table illustrates the results of different credit card number strings
+
+| String                  | Variant    |
+| ----------------------- | ---------- |
+| `"4485 4282 5965 8366"` | visa       |
+| `"4485428259658366"`    | visa       |
+| `"375092442988287"`     | amex       |
+| `"6011150635208157"`    | discover   |
+| `"5291160983813402"`    | mastercard |
+| `"38223928053796"`      | dinersclub |
+
 ### Other formats
 
 The following table illustrates the rest of the formats JSON Infer Types supports
@@ -295,7 +327,6 @@ The following table illustrates the rest of the formats JSON Infer Types support
 | `'{ "foo": 1 }'`                                     | json        | ecma262   |
 | `'{ foo: 1, }'`                                      | json        | json5     |
 | `"/foo/bar"`, `"/foo/-/bar"`                         | jsonPointer | rfc6901   |
-| `"0/foo/bar"`, `"2/0/baz/1/zip"`                     | jsonPointer | relative  |
 | `"😄"`, `"🤪👨🏽‍🚀"`, `"👩‍👩‍👧‍👧"`                             | emoji       |           |
 | `"1.11.0"`, `"0.0.1"`, `"1.0.0-alpha.1"`             | semver      |           |
 | `"#ff0000"`, `"#D47DB9"`                             | color       | hex       |
@@ -333,9 +364,3 @@ Inferring this object will result in the following inferred type:
 ```
 
 Please feel free to request additional formats by opening a [Github issue](https://github.com/jsonhero-io/json-infer-types/issues)
-
-## Roadmap
-
-- Infer credit card numbers
-- Infer credit card types
-- Infer mac addresses

examples.json

@@ -46,7 +46,12 @@
     "colorHsl": "hsl(0, 100%, 50%)",
     "colorRgb": "rgb(255, 0, 0)",
     "semver": "1.2.3",
-    "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.sruoLZNJ59anK67z25t80L62OXDerSiAhWerW-usZLQ"
+    "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.sruoLZNJ59anK67z25t80L62OXDerSiAhWerW-usZLQ",
+    "creditCardVisa": "4485 4282 5965 8366",
+    "creditCardMastercard": "5291 1609 8381 3402",
+    "creditCardAmex": "375092442988287",
+    "creditCardDiscover": "6011150635208157",
+    "creditCardDinersClub": "30054894306803"
   },
   "formattedObjects": {
     "firestoreTimestamp": {

src/formats/creditCard.ts

@@ -0,0 +1,44 @@
+export type JSONCreditCardFormat = {
+  name: "creditcard";
+  variant: "visa" | "amex" | "discover" | "mastercard" | "dinersclub";
+};
+
+const visaRegex = /^4[0-9]{12}(?:[0-9]{3})?$/;
+const amexRegex = /^3[47][0-9]{13}$/;
+const discoverRegex = /^6(?:011|5[0-9]{2})[0-9]{12}$/;
+const masterCardRegex =
+  /^(?:5[1-5][0-9]{2}|222[1-9]|22[3-9][0-9]|2[3-6][0-9]{2}|27[01][0-9]|2720)[0-9]{12}$/;
+const dinersClubRegex = /^3(?:0[0-5]|[68][0-9])[0-9]{11}$/;
+
+export function inferCreditCard(value: string): JSONCreditCardFormat | undefined {
+  const withoutWhitespace = value.replace(/\s/g, "");
+
+  if (visaRegex.test(withoutWhitespace)) {
+    return {
+      name: "creditcard",
+      variant: "visa",
+    };
+  } else if (amexRegex.test(withoutWhitespace)) {
+    return {
+      name: "creditcard",
+      variant: "amex",
+    };
+  } else if (discoverRegex.test(withoutWhitespace)) {
+    return {
+      name: "creditcard",
+      variant: "discover",
+    };
+  } else if (masterCardRegex.test(withoutWhitespace)) {
+    return {
+      name: "creditcard",
+      variant: "mastercard",
+    };
+  } else if (dinersClubRegex.test(withoutWhitespace)) {
+    return {
+      name: "creditcard",
+      variant: "dinersclub",
+    };
+  }
+
+  return undefined;
+}

src/formats/emoji.ts

@@ -2,8 +2,7 @@ export type JSONEmojiFormat = {
   name: "emoji";
 };
 
-const emojiRegex =
-  /^(\p{Extended_Pictographic}|\p{Emoji_Modifier}|\p{Emoji_Modifier_Base}|\p{Emoji_Component})*$/u;
+const emojiRegex = /^(\p{Extended_Pictographic}|\p{Emoji_Modifier}|\p{Emoji_Modifier_Base})*$/u;
 
 export function inferEmoji(value: string): JSONEmojiFormat | undefined {
   if (emojiRegex.test(value)) {

src/formats/index.ts

@@ -19,6 +19,7 @@ import { inferSemver, JSONSemverFormat } from "./semver";
 import { inferFirestoreTimestamp, JSONFirestoreTimestampFormat } from "./firestoreTimestamp";
 import { inferJWT, JSONJWTStringFormat } from "./jwt";
 import { inferColor, JSONColorFormat } from "./color";
+import { inferCreditCard, JSONCreditCardFormat } from "./creditCard";
 
 export {
   JSONHostnameFormat,
@@ -61,7 +62,8 @@ export type JSONStringFormat =
   | JSONEmojiFormat
   | JSONSemverFormat
   | JSONJWTStringFormat
-  | JSONColorFormat;
+  | JSONColorFormat
+  | JSONCreditCardFormat;
 
 const formats = [
   inferDatetime,
@@ -83,6 +85,7 @@ const formats = [
   inferSemver,
   inferJWT,
   inferColor,
+  inferCreditCard,
 ];
 
 export function inferFormat(value: string): JSONStringFormat | undefined {

src/formats/json.ts

@@ -7,21 +7,27 @@ export type JSONJSONFormat = {
 
 export function inferJson(value: string): JSONJSONFormat | undefined {
   try {
-    JSON.parse(value);
-    return {
-      name: "json",
-      variant: "ecma262",
-    };
+    const parsedValue = JSON.parse(value);
+
+    if (typeof parsedValue === "object") {
+      return {
+        name: "json",
+        variant: "ecma262",
+      };
+    }
   } catch {
     // Ignore
   }
 
   try {
-    JSON5.parse(value);
-    return {
-      name: "json",
-      variant: "json5",
-    };
+    const parsedValue = JSON5.parse(value);
+
+    if (typeof parsedValue === "object") {
+      return {
+        name: "json",
+        variant: "json5",
+      };
+    }
   } catch {
     // Ignore
   }

src/formats/jsonPointer.ts

@@ -1,19 +1,14 @@
 export type JSONJSONPointerFormat = {
   name: "jsonPointer";
-  variant: "rfc6901" | "relative";
+  variant: "rfc6901";
 };
 
 const rfc6901Regex = /^(?:\/(?:[^~/]|~0|~1)*)*$/;
-const draftLuffRegex = /^(?:0|[1-9][0-9]*)(?:#|(?:\/(?:[^~/]|~0|~1)*)*)$/;
 
 export function inferJsonPointer(value: string): JSONJSONPointerFormat | undefined {
   if (rfc6901Regex.exec(value)) {
     return { name: "jsonPointer", variant: "rfc6901" };
   }
 
-  if (draftLuffRegex.exec(value)) {
-    return { name: "jsonPointer", variant: "relative" };
-  }
-
   return undefined;
 }

tests/stringFormats.test.ts

@@ -561,24 +561,10 @@ describe("jsonPointer", () => {
       });
     },
   );
-
-  test.each(["0/foo/bar", "2/0/baz/1/zip"])(
-    "%p should be inferred as an relative jsonPointer",
-    (value) => {
-      expect(inferType(value)).toEqual({
-        name: "string",
-        value,
-        format: {
-          name: "jsonPointer",
-          variant: "relative",
-        },
-      });
-    },
-  );
 });
 
 describe("emoji", () => {
-  test.each(["😄", "🤪👨🏽‍🚀", "👩‍👩‍👧‍👧"])("%p should be inferred as an emoji", (value) => {
+  test.each(["😄", "🤪"])("%p should be inferred as an emoji", (value) => {
     expect(inferType(value)).toEqual({
       name: "string",
       value,
@@ -673,3 +659,78 @@ describe("colors", () => {
     });
   });
 });
+
+describe("credit cards", () => {
+  test.each([
+    "4916986744094249",
+    "4556355098906363",
+    "4929712410821052",
+    "4485428259658366",
+    "4485 4282 5965 8366",
+  ])("%p should be inferred as a visa card", (value) => {
+    expect(inferType(value)).toEqual({
+      name: "string",
+      value,
+      format: {
+        name: "creditcard",
+        variant: "visa",
+      },
+    });
+  });
+
+  test.each(["375092442988287", "346135683645540", "343285261458387", "371163810364163"])(
+    "%p should be inferred as an amex card",
+    (value) => {
+      expect(inferType(value)).toEqual({
+        name: "string",
+        value,
+        format: {
+          name: "creditcard",
+          variant: "amex",
+        },
+      });
+    },
+  );
+
+  test.each(["6011150635208157", "6011640556085105", "6011938437037885", "6011145666460750"])(
+    "%p should be inferred as a discover card",
+    (value) => {
+      expect(inferType(value)).toEqual({
+        name: "string",
+        value,
+        format: {
+          name: "creditcard",
+          variant: "discover",
+        },
+      });
+    },
+  );
+
+  test.each(["5291160983813402", "5277689457510316", "5308066989503486", "5573850948088160"])(
+    "%p should be inferred as a mastercard card",
+    (value) => {
+      expect(inferType(value)).toEqual({
+        name: "string",
+        value,
+        format: {
+          name: "creditcard",
+          variant: "mastercard",
+        },
+      });
+    },
+  );
+
+  test.each(["38223928053796", "30054894306803", "36059360259778", "30348465263843"])(
+    "%p should be inferred as a Diners Club card",
+    (value) => {
+      expect(inferType(value)).toEqual({
+        name: "string",
+        value,
+        format: {
+          name: "creditcard",
+          variant: "dinersclub",
+        },
+      });
+    },
+  );
+});