Added storybook and an example component for James

Author: ericallam

README.md

@@ -10,20 +10,53 @@
 ## Features
 
 - Written in typescript
-- Infers JSON Schema
+- Inspired by [jtd-infer](https://jsontypedef.com/docs/jtd-infer/)
+- Generate JSON schema documents from example data
 - Supports most string formats through [json-infer-types](https://github.com/jsonhero-io/json-infer-types)
   - Date and times
   - URIs
   - Email Addresses
   - Hostnames
   - IP Addresses
   - uuids
-- Infers JSON Type definitions
-- Supports hints for discriminators (tagged unions), value-only schemas, and enums
-- Provide with multiple JSON documents to improve inference
+- Available as a CLI and a library
+- Supports snapshotting and restoring inference sessions
 
 ## Usage
 
+```ts
+import { inferSchema } from "@jsonhero/schema-infer";
+
+inferSchema({
+  id: "abeb8b52-e960-44dc-9e09-57bb00d6b441",
+  name: "Eric",
+  emailAddress: "eric@example.com",
+  website: "https://github.com/ericallam",
+  joined: "2022-01-01",
+})toJSONSchema();
+```
+
+Infers the following JSON schema:
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": { "type": "string", "format": "uuid" },
+    "name": { "type": "string" },
+    "emailAddress": { "type": "string", "format": "email" },
+    "website": { "type": "string", "format": "uri" },
+    "joined": { "type": "string", "format": "date" }
+  },
+  "required": ["id", "name", "emailAddress", "website", "joined"]
+}
+```
+
+## Examples
+
 ## Roadmap
 
+- Add support for hints for discriminators (tagged unions), value-only schemas, and enums
+- Add support for [JSON Typedefs](https://jsontypedef.com)
 - Add "verbose" mode to include `$id`, `examples`, etc.

package-lock.json

@@ -42,6 +42,8 @@
     "@types/node": "^16.11.7",
     "@typescript-eslint/eslint-plugin": "^5.8.1",
     "@typescript-eslint/parser": "^5.8.1",
+    "ajv": "^8.8.2",
+    "ajv-formats": "^2.1.1",
     "eslint": "^8.5.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
@@ -75,4 +77,4 @@
   "bin": {
     "schema-infer": "./cli/schema-infer.js"
   }
-}
+}

package.json

@@ -3,8 +3,10 @@ import { readFileSync } from "fs";
 import { inferSchema, restoreSnapshot, SchemaInferrer } from "../src";
 
 const toSchema = (s: SchemaInferrer): Schema => s.toJSONSchema({ includeSchema: false });
+const readFixture = (s: string): unknown =>
+  JSON.parse(readFileSync(`./tests/json/${s}.json`, "utf8").toString());
 const fixtureToSchema = (s: string): Schema =>
-  inferSchema(JSON.parse(readFileSync(`./tests/json/${s}.json`, "utf8").toString())).toJSONSchema({
+  inferSchema(readFixture(s)).toJSONSchema({
     includeSchema: false,
   });
 
@@ -352,3 +354,18 @@ describe("real world tests", () => {
     expect(fixtureToSchema("tweets")).toMatchSnapshot();
   });
 });
+
+import Ajv2020 from "ajv/dist/2020";
+import addFormats from "ajv-formats";
+const ajv = new Ajv2020();
+addFormats(ajv);
+
+describe("validation", () => {
+  it("should pass validation if given the same json the schema was inferred from", () => {
+    const schema = fixtureToSchema("tweets");
+    const validate = ajv.compile(schema);
+    const tweetsJson = readFixture("tweets");
+
+    expect(validate(tweetsJson)).toBe(true);
+  });
+});