Merge pull request #3 from wework/examples

Support "advanced example" from JSON Schema

Author: Phil Sturgeon

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1] - 2018-04-09
+### Added
+* Convert `dependencies` to an allOf + oneOf OpenAPI-valid equivalent

README.md

@@ -7,7 +7,8 @@ A little NodeJS package to convert JSON Schema to [OpenAPI Schema Objects](https
 * converts JSON Schema Draft 00 Wright (a.k.a draft v5) to OpenAPI 3.0 Schema Object
 * switches `type: ['foo', 'null']` to `type: foo` and `nullable: true`
 * supports deep structures with nested `allOf`s etc.
-* switches `patternProperties` to `x-patternProperties` in the Schema Object
+* switches `patternProperties` to `x-patternProperties`
+* converts `dependencies` to an allOf + oneOf OpenAPI-valid equivalent
 
 ## Installation
 

index.js

@@ -1,5 +1,12 @@
 const structs = ['allOf', 'anyOf', 'oneOf', 'not', 'items', 'additionalProperties'];
 
+function InvalidTypeError(message) {
+	this.name = 'InvalidTypeError';
+	this.message = message;
+}
+
+InvalidTypeError.prototype = new Error();
+
 function convert(schema, options) {
 	options = options || {};
 	options.cloneSchema = ! (options.cloneSchema === false);
@@ -8,12 +15,18 @@ function convert(schema, options) {
 		schema = JSON.parse(JSON.stringify(schema));
 	}
 
-	delete schema['$schema'];
+	schema = removeRootKeywords(schema);
 	schema = convertSchema(schema);
 
 	return schema;
 }
 
+function removeRootKeywords(schema) {
+	delete schema['$schema'];
+	delete schema['id'];
+	return schema;
+}
+
 function convertSchema(schema) {
 	let i = 0;
 	let j = 0;
@@ -47,7 +60,10 @@ function convertSchema(schema) {
 
 	}
 
+	validateType(schema.type);
+
 	schema = convertTypes(schema);
+	schema = convertDependencies(schema);
 
 	if (typeof schema['patternProperties'] === 'object') {
 		schema = convertPatternProperties(schema);
@@ -56,11 +72,19 @@ function convertSchema(schema) {
 	return schema;
 }
 
+function validateType(type) {
+	const validTypes = ['null', 'boolean', 'object', 'array', 'number', 'string', 'integer'];
+	const types = Array.isArray(type) ? type : [type];
+	types.forEach(type => {
+		if (validTypes.indexOf(type) < 0 && type !== undefined)
+			throw new InvalidTypeError('Type "' + type + '" is not a valid type');
+	});
+}
+
 function convertProperties(properties) {
-	var key
-		, property
-		, props = {}
-	;
+	let key = {};
+	let property = {};
+	let props = {};
 
 	for (key in properties) {
 		property = properties[key];
@@ -70,6 +94,51 @@ function convertProperties(properties) {
 	return props;
 }
 
+function convertDependencies(schema) {
+	const deps = schema.dependencies;
+	if (typeof deps !== 'object') {
+		return schema;
+	}
+
+	// Turns the dependencies keyword into an allOf of oneOf's
+	// "dependencies": {
+	// 		"post-office-box": ["street-address"]
+	// },
+	//
+	// becomes
+	//
+	// "allOf": [
+	// 	{
+	// 		"oneOf": [
+	// 			{"not": {"required": ["post-office-box"]}},
+	// 			{"required": ["post-office-box", "street-address"]}
+	// 		]
+	// 	}
+	//
+
+	delete schema['dependencies'];
+	if (!Array.isArray(schema.allOf)) {
+		schema.allOf = [];
+	}
+
+	for (const key in deps) {
+		const foo = {
+			'oneOf': [
+				{
+					'not': {
+						'required': [key]
+					}
+				},
+				{
+					'required': [].concat(key, deps[key])
+				}
+			]
+		};
+		schema.allOf.push(foo);
+	}
+	return schema;
+}
+
 function convertTypes(schema) {
 	var newType;
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "json-schema-to-openapi-schema",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Converts a JSON Schema to OpenAPI Schema Object",
   "main": "index.js",
   "scripts": {

package.json

@@ -0,0 +1,24 @@
+'use strict';
+
+const convert = require('../');
+const should = require('should');
+const getSchema = require('./helpers').getSchema;
+
+['basic', 'address', 'calendar'].forEach(test => {
+	it(`converts ${test}/openapi.json`, () => {
+		const schema = getSchema(test + '/json-schema.json');
+		const result = convert(schema);
+		const expected = getSchema(test + '/openapi.json');
+
+		should(result).deepEqual(expected, 'converted');
+	});
+
+	it(`converting ${test}/openapi.json in place`, () => {
+		const schema = getSchema(test + '/json-schema.json');
+		const result = convert(schema, { cloneSchema: false });
+		const expected = getSchema(test + '/openapi.json');
+
+		should(schema).deepEqual(result, 'changed schema in place');
+		should(result).deepEqual(expected, 'converted');
+	});
+});

test/clone_schema.js test/clone_schema.test.jstest/clone_schema.js renamed to test/clone_schema.test.js

@@ -0,0 +1,9 @@
+const fs = require('fs');
+const join = require('path').join;
+
+const getSchema = file => {
+	const path = join(__dirname, 'schemas', file);
+	return JSON.parse(fs.readFileSync(path));
+};
+
+module.exports = { getSchema };