Merge pull request #125 from tomcollins/add-draft-2020-12-support

Add support for JSON Schema draft 2020-12

Author: tomcollins

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 tests/docs
 docs
+tmp
 gh-pages/.jekyll-cache
 gh-pages/_site

README.md

@@ -9,7 +9,7 @@ Generates static documentation for humans based on the contents of [JSON schema]
 ## Support for JSON schema specification versions
 
 Currently supports schema specified using the following [specification versions](https://json-schema.org/specification-links.html):
-draft-06, draft-07 and draft-2019-09.
+draft-06, draft-07, draft-2019-09, and draft 2020-12.
 
 For complete documentation, including examples and supported keywords, see [tomcollins.github.io/json-schema-static-docs](https://tomcollins.github.io/json-schema-static-docs/).
 
@@ -38,3 +38,26 @@ const JsonSchemaStaticDocs = require("json-schema-static-docs");
   console.log("Documents generated.");
 })();
 ```
+
+### How to use draft-2020-12
+
+To use schema based on `draft-2020-12` set `options.jsonSchemaVersion` to `https://json-schema.org/draft/2020-12/schema`.
+
+```javascript
+const JsonSchemaStaticDocs = require("json-schema-static-docs");
+
+(async () => {
+  let jsonSchemaStaticDocs = new JsonSchemaStaticDocs({
+    inputPath: "./schema",
+    outputPath: "./docs",
+    jsonSchemaVersion: "https://json-schema.org/draft/2020-12/schema",
+    ajvOptions: {
+      allowUnionTypes: true,
+    },
+  });
+  await jsonSchemaStaticDocs.generate();
+  console.log("Documents generated.");
+})();
+```
+
+All schema documentsmust use must use `draft-2020-12`, you can not combine this with earlier versions such as `draft-07`.

lib/json-schema-static-docs.js

@@ -25,6 +25,7 @@ const defaultOptions = {
   enableMetaEnum: false,
   addFrontMatter: false,
   displaySchema: true,
+  jsonSchemaVersion: undefined,
 };
 
 var JsonSchemaStaticDocs = function (options) {
@@ -58,7 +59,11 @@ JsonSchemaStaticDocs.prototype.generate = async function () {
   unresolvedSchemas.forEach((schema) => {
     schemas.push(schema.data);
   });
-  const validator = new Validator(schemas, this._options.ajvOptions);
+  const validator = new Validator(
+    schemas,
+    this._options.ajvOptions,
+    this._options.jsonSchemaVersion
+  );
 
   if (this._options.enableMetaEnum) {
     validator.addMetaEnum();

lib/utils.js

@@ -1,3 +1,10 @@
+const JsonSchemaVersions = {
+  DRAFT_06: "https://json-schema.org/draft-06/schema",
+  DRAFT_07: "https://json-schema.org/draft-07/schema",
+  DRAFT_2019_09: "https://json-schema.org/draft/2019-09/schema",
+  DRAFT_2020_12: "https://json-schema.org/draft/2020-12/schema",
+};
+
 const determineSchemaRelativePath = (schemaFilename, schemaInputPath) => {
   let outputFilename = schemaFilename.substr(schemaInputPath.length);
   if (outputFilename.substr(0, 1) === "/") {
@@ -7,5 +14,6 @@ const determineSchemaRelativePath = (schemaFilename, schemaInputPath) => {
 };
 
 module.exports = {
+  JsonSchemaVersions,
   determineSchemaRelativePath: determineSchemaRelativePath,
 };

lib/validator.js

@@ -1,16 +1,22 @@
-// const Ajv = require("ajv");
 const Ajv = require("ajv/dist/2019");
+const Ajv2020 = require("ajv/dist/2020");
 const draft7MetaSchema = require("ajv/dist/refs/json-schema-draft-07.json");
 const draft6MetaSchema = require("ajv/dist/refs/json-schema-draft-06.json");
 const addFormats = require("ajv-formats");
+const { JsonSchemaVersions } = require("./utils");
 
-let Validator = function (schemas, ajvOptions) {
+let Validator = function (schemas, ajvOptions, jsonSchemaVersion) {
   let options = {};
   Object.assign(options, ajvOptions);
-  // options.schemas = schemas;
-  this._ajv = new Ajv(options);
-  this._ajv.addMetaSchema(draft7MetaSchema);
-  this._ajv.addMetaSchema(draft6MetaSchema);
+  if (jsonSchemaVersion === JsonSchemaVersions.DRAFT_2020_12) {
+    // support draft-202-12 only
+    this._ajv = new Ajv2020(options);
+  } else {
+    // support draft-06, draft-07, draft-2019-09
+    this._ajv = new Ajv(options);
+    this._ajv.addMetaSchema(draft7MetaSchema);
+    this._ajv.addMetaSchema(draft6MetaSchema);
+  }
   schemas.forEach((schema) => {
     this._ajv.addSchema(schema);
   });