Return the narrowed value in the result, and remove properties and items from object and array types

Author: ericallam

README.md

@@ -9,8 +9,6 @@
 
 - [🚀 Features](#-features)
 - [💻 Usage](#-usage)
-  - [Objects](#objects)
-  - [Arrays](#arrays)
   - [Strings](#strings)
 - [String Formats](#string-formats)
   - [Date/Time strings](#datetime-strings)
@@ -21,7 +19,7 @@
 ## 🚀 Features
 
 - Written in typescript
-- Infers types of values inside objects and arrays
+- Narrows type of the value when using with Typescript
 - Lightweight with only a few third-party dependencies
 - Includes a large set of formats for strings
   - Dates and times (and timestamps)
@@ -51,103 +49,20 @@ $ npm install --save @jsonhero/json-infer-types
 ```js
 const { inferType } = require("@jsonhero/json-infer-types");
 
-inferType(123); // => { name: "int" }
+inferType(123); // => { name: "int", value: 123 }
 ```
 
-The following basic types are supported:
+The following types are supported:
 
 ```js
-inferType(null); // => { name: "null" }
-inferType(true); // => { name: "bool" }
-inferType(123); // => { name: "int" }
-inferType(123.456); // => { name: "float" }
-inferType("hello world"); // => { name: "string" }
-```
-
-### Objects
-
-Objects have an additional `properties` property that infers its value types
-
-```js
-inferType({ foo: "bar" });
-```
-
-Will result in
-
-```json
-{ "name": "object", "properties": { "foo": { "name": "string" } } }
-```
-
-### Arrays
-
-Arrays have an additional `items` property that infers the types of its items
-
-```js
-inferType([8, 176, 3, 49, 0]); // { name: "array", items: { name: "int" }}
-```
-
-This works for an array of objects as well
-
-```js
-inferType([
-  { id: "1", email: "eric@example.com" },
-  { id: "2", email: "matt@example.com" },
-]);
-```
-
-Will result in
-
-```json
-{
-  "name": "array",
-  "items": {
-    "name": "object",
-    "properties": {
-      "id": { "name": "string" },
-      "email": {
-        "name": "string",
-        "format": {
-          "name": "email",
-          "variant": "rfc5321"
-        }
-      }
-    }
-  }
-}
-```
-
-If they array has items of different types, `items` will be an array of objects representing each unique type found in the array
-
-```js
-inferType([1, "hello world"]);
-```
-
-Gives the result
-
-```json
-{
-  "name": "array",
-  "items": [
-    {
-      "name": "int"
-    },
-    {
-      "name": "string"
-    }
-  ]
-}
-```
-
-If you don't want or need the `properties` or `items` inferred you can pass the `shallow: true` option to `inferType`
-
-```js
-inferType(
-  [
-    { id: "1", email: "eric@example.com" },
-    { id: "2", email: "matt@example.com" },
-  ],
-  { shallow: true }
-); // => { name: "array" }
+inferType(null); // => { name: "null", value: null }
+inferType(undefined); // => { name: "null", value: null }
+inferType(true); // => { name: "bool", value: true }
+inferType(123); // => { name: "int", value: 123 }
+inferType(123.456); // => { name: "float", value: 123.456 }
+inferType("hello world"); // => { name: "string", value: "hello world" }
+inferType({ foo: "bar" }); // => { name: "object", value: { foo: "bar" } }
+inferType([1, 2, 3]); // => { name: "array", value: [1, 2, 3] }
 ```
 
 ### Strings
@@ -163,6 +78,7 @@ Will be
 ```json
 {
   "name": "string",
+  "value": "https://www.example.com/foo#bar",
   "format": {
     "name": "uri"
   }
@@ -174,6 +90,7 @@ Some formats have mutliple variants, like IP Address. `inferType("192.168.0.1")`
 ```json
 {
   "name": "string",
+  "value": "192.168.0.1",
   "format": {
     "name": "ip",
     "variant": "v4"
@@ -186,6 +103,7 @@ And `inferType("2001:db8:1234::1")` will be interpreted as an IPV6 address
 ```json
 {
   "name": "string",
+  "value": "2001:db8:1234::1",
   "format": {
     "name": "ip",
     "variant": "v6"
@@ -208,6 +126,7 @@ Will result in
 ```json
 {
   "name": "string",
+  "value": "2019-01-01 00:00:00.000Z",
   "format": {
     "name": "datetime",
     "parts": "datetime",
@@ -245,6 +164,7 @@ Will result in
 ```json
 {
   "name": "string",
+  "value": "1596597629980",
   "format": {
     "name": "timestamp",
     "variant": "millisecondsSinceEpoch"
@@ -267,6 +187,7 @@ Will result in
 ```json
 {
   "name": "string",
+  "value": "https://www.example.com/foo#bar",
   "format": {
     "name": "uri"
   }
@@ -278,6 +199,7 @@ If the URI contains a file extension, the inferred `contentType` will be include
 ```json
 {
   "name": "string",
+  "value": "https://www.example.com/foo.json",
   "format": {
     "name": "uri",
     "contentType": "application/json"
@@ -300,6 +222,7 @@ Will result in
 ```json
 {
   "name": "string",
+  "value": "eallam@example.com",
   "format": {
     "name": "email",
     "variant": "rfc5321"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonhero/json-infer-types",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Infer the types of a JSON value",
   "homepage": "https://github.com/jsonhero-io/json-infer-types",
   "bugs": {

src/@types.ts

@@ -1,118 +1,39 @@
-export type JSONDateTimeFormat = {
-  name: "datetime";
-  parts: "datetime" | "date" | "time";
-  variant: "rfc2822" | "rfc3339";
-};
-
-export type JSONTimestampFormat = {
-  name: "timestamp";
-  variant: "millisecondsSinceEpoch" | "nanosecondsSinceEpoch" | "secondsSinceEpoch";
-};
-
-export type JSONEmailFormat = {
-  name: "email";
-  variant: "rfc5321" | "rfc5322";
-};
-
-export type JSONCurrencyFormat = {
-  name: "currency";
-  variant: "iso4217" | "english" | "crypto";
-};
-
-export type JSONCountryFormat = {
-  name: "country";
-  variant: "iso3166-2" | "iso3166-3";
-};
-
-export type JSONTLDFormat = {
-  name: "tld";
-};
-
-export type JSONIPAddressFormat = {
-  name: "ip";
-  variant: "v4" | "v6";
-};
-
-export type JSONLanguageFormat = {
-  name: "language";
-  variant: "iso693-1" | "iso693-2" | "english" | "native";
-};
-
-export type JSONPhoneNumberFormat = {
-  name: "phoneNumber";
-  variant: "e.164";
-};
-
-export type JSONURIFormat = {
-  name: "uri";
-  contentType?: string;
-};
-
-export type JSONUUIDFormat = {
-  name: "uuid";
-  variant: "v1" | "v4" | "v5";
-};
-
-export type JSONHostnameFormat = {
-  name: "hostname";
-  variant: "rfc1123" | "rfc5890";
-};
-
-export type JSONFilesizeFormat = {
-  name: "filesize";
-  variant: "human";
-};
-
-export type JSONJSONFormat = {
-  name: "json";
-  variant: "ecma262" | "json5";
-};
-
-export type JSONStringFormat =
-  | JSONHostnameFormat
-  | JSONUUIDFormat
-  | JSONURIFormat
-  | JSONPhoneNumberFormat
-  | JSONLanguageFormat
-  | JSONIPAddressFormat
-  | JSONTLDFormat
-  | JSONCountryFormat
-  | JSONCurrencyFormat
-  | JSONEmailFormat
-  | JSONTimestampFormat
-  | JSONDateTimeFormat
-  | JSONFilesizeFormat
-  | JSONJSONFormat;
+import { JSONStringFormat } from "./formats";
 
 export type JSONNullType = {
   name: "null";
+  value: null;
 };
 
 export type JSONBoolType = {
   name: "bool";
+  value: boolean;
 };
 
 export type JSONFloatType = {
   name: "float";
+  value: number;
 };
 
 export type JSONIntType = {
   name: "int";
+  value: number;
 };
 
 export type JSONStringType = {
   name: "string";
   format?: JSONStringFormat;
+  value: string;
 };
 
 export type JSONObjectType = {
   name: "object";
-  properties?: Record<string, JSONValueType>;
+  value: object;
 };
 
 export type JSONArrayType = {
   name: "array";
-  items?: JSONValueType | JSONValueType[];
+  value: Array<unknown>;
 };
 
 export type JSONValueType =

src/formats/country.ts

@@ -1,4 +1,7 @@
-import { JSONCountryFormat } from "../@types";
+export type JSONCountryFormat = {
+  name: "country";
+  variant: "iso3166-2" | "iso3166-3";
+};
 
 const iso31663Regex =
   /^(?:(AFG|ALB|DZA|ASM|AND|AGO|AIA|ATA|ATG|ARG|ARM|ABW|AUS|AUT|AZE|BHS|BHR|BGD|BRB|BLR|BEL|BLZ|BEN|BMU|BTN|BOL|BES|BIH|BWA|BVT|BRA|IOT|BRN|BGR|BFA|BDI|CPV|KHM|CMR|CAN|CYM|CAF|TCD|CHL|CHN|CXR|CCK|COL|COM|COD|COG|COK|CRI|HRV|CUB|CUW|CYP|CZE|CIV|DNK|DJI|DMA|DOM|ECU|EGY|SLV|GNQ|ERI|EST|SWZ|ETH|FLK|FRO|FJI|FIN|FRA|GUF|PYF|ATF|GAB|GMB|GEO|DEU|GHA|GIB|GRC|GRL|GRD|GLP|GUM|GTM|GGY|GIN|GNB|GUY|HTI|HMD|VAT|HND|HKG|HUN|ISL|IND|IDN|IRN|IRQ|IRL|IMN|ISR|ITA|JAM|JPN|JEY|JOR|KAZ|KEN|KIR|PRK|KOR|KWT|KGZ|LAO|LVA|LBN|LSO|LBR|LBY|LIE|LTU|LUX|MAC|MDG|MWI|MYS|MDV|MLI|MLT|MHL|MTQ|MRT|MUS|MYT|MEX|FSM|MDA|MCO|MNG|MNE|MSR|MAR|MOZ|MMR|NAM|NRU|NPL|NLD|NCL|NZL|NIC|NER|NGA|NIU|NFK|MNP|NOR|OMN|PAK|PLW|PSE|PAN|PNG|PRY|PER|PHL|PCN|POL|PRT|PRI|QAT|MKD|ROU|RUS|RWA|REU|BLM|SHN|KNA|LCA|MAF|SPM|VCT|WSM|SMR|STP|SAU|SEN|SRB|SYC|SLE|SGP|SXM|SVK|SVN|SLB|SOM|ZAF|SGS|SSD|ESP|LKA|SDN|SUR|SJM|SWE|CHE|SYR|TWN|TJK|TZA|THA|TLS|TGO|TKL|TON|TTO|TUN|TUR|TKM|TCA|TUV|UGA|UKR|ARE|GBR|UMI|USA|URY|UZB|VUT|VEN|VNM|VGB|VIR|WLF|ESH|YEM|ZMB|ZWE|ALA))$/;

src/formats/currency.ts

@@ -1,4 +1,7 @@
-import { JSONCurrencyFormat } from "../@types";
+export type JSONCurrencyFormat = {
+  name: "currency";
+  variant: "iso4217" | "english" | "crypto";
+};
 
 const iso4217Regex =
   /^(?:(AED|AFN|ALL|AMD|ANG|AOA|ARS|AUD|AWG|AZN|BAM|BBD|BDT|BGN|BHD|BIF|BMD|BND|BOB|BOV|BRL|BSD|BTC|BTN|BWP|BYN|BZD|CAD|CDF|CHE|CHF|CHW|CLF|CLP|CNY|COP|COU|CRC|CUC|CUP|CVE|CZK|DJF|DKK|DOP|DZD|EGP|ERN|ETB|EUR|FJD|FKP|GBP|GEL|GHS|GIP|GMD|GNF|GTQ|GYD|HKD|HNL|HRK|HTG|HUF|IDR|ILS|INR|IQD|IRR|ISK|JMD|JOD|JPY|KES|KGS|KHR|KMF|KPW|KRW|KWD|KYD|KZT|LAK|LBP|LKR|LRD|LSL|LYD|MAD|MDL|MGA|MKD|MMK|MNT|MOP|MRU|MUR|MVR|MWK|MXN|MXV|MYR|MZN|NAD|NGN|NIO|NOK|NPR|NZD|OMR|PAB|PEN|PGK|PHP|PKR|PLN|PYG|QAR|RON|RSD|RUB|RWF|SAR|SBD|SCR|SDG|SEK|SGD|SHP|SLL|SOS|SRD|SSP|STN|SVC|SYP|SZL|THB|TJS|TMT|TND|TOP|TRY|TTD|TWD|TZS|UAH|UGX|USD|USN|UYI|UYU|UYW|UZS|VED|VES|VND|VUV|WST|XAF|XAG|XAU|XBA|XBB|XBC|XBD|XCD|XDR|XOF|XPD|XPF|XPT|XSU|XTS|XUA|XXX|YER|ZAR|ZMW|ZWL))$/;

src/formats/datetime.ts

@@ -1,4 +1,8 @@
-import { JSONDateTimeFormat } from "../@types";
+export type JSONDateTimeFormat = {
+  name: "datetime";
+  parts: "datetime" | "date" | "time";
+  variant: "rfc2822" | "rfc3339";
+};
 
 export function inferDatetime(value: string): JSONDateTimeFormat | undefined {
   const rfc3339Match = inferRFC3339(value);

src/formats/email.ts

@@ -1,4 +1,7 @@
-import { JSONStringFormat } from "../@types";
+export type JSONEmailFormat = {
+  name: "email";
+  variant: "rfc5321" | "rfc5322";
+};
 
 const rfc5321AddressRegex =
   /[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?/i;
@@ -7,7 +10,7 @@ const rfc5321Regex = new RegExp(`^${rfc5321AddressRegex.source}$`);
 
 const rfc5322Regex = new RegExp(`^[^"]+<${rfc5321AddressRegex.source}>$`);
 
-export function inferEmail(value: string): JSONStringFormat | undefined {
+export function inferEmail(value: string): JSONEmailFormat | undefined {
   if (rfc5321Regex.exec(value)) {
     return { name: "email", variant: "rfc5321" };
   }

src/formats/filesize.ts

@@ -1,4 +1,7 @@
-import { JSONFilesizeFormat } from "../@types";
+export type JSONFilesizeFormat = {
+  name: "filesize";
+  variant: "human";
+};
 
 export function inferFilesize(value: string): JSONFilesizeFormat | undefined {
   if (value.match(/^[0-9.]+\s?(?:(B|MB|K|GB|TB|PB|MiB|KB|kB))$/)) {

src/formats/hostname.ts

@@ -1,4 +1,7 @@
-import { JSONHostnameFormat } from "../@types";
+export type JSONHostnameFormat = {
+  name: "hostname";
+  variant: "rfc1123" | "rfc5890";
+};
 
 function isValidHostname(value: string, allowUnderscore = false): boolean {
   if (value.length === 0) {