chore: tidying up the package

Author: Phil Sturgeon

.editorconfig

@@ -1,9 +1,12 @@
+root = true
+
 [*]
 charset = utf-8
-end_of_line = lf
-insert_final_newline = true
+
+[*.{ts,js,yaml,scenario,md}]
 indent_style = space
-indent_size = tab
-max_line_length = 80
+indent_size = 2
+
+[*.{ts,js}]
 trim_trailing_whitespace = true
 insert_final_newline = true

.eslintrc.js

@@ -0,0 +1,20 @@
+module.exports = {
+  env: {
+    browser: true,
+    commonjs: true,
+    es6: true,
+    node: true
+  },
+  extends: [
+    "eslint:recommended"
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly'
+  },
+  parserOptions: {
+    ecmaVersion: 2018
+  },
+  rules: {
+  }
+}

.eslintrc.json

@@ -6,33 +6,29 @@ Currently converts from [OpenAPI 3.0](https://github.com/OAI/OpenAPI-Specificati
 
 ## Why?
 
-OpenAPI is a specification for describing RESTful APIs. OpenAPI 3.0 allows us to describe the structures of request and response payloads in a detailed manner. This would, theoretically, mean that we should be able to automatically validate request and response payloads. However, as of writing there aren't many validators around.
+OpenAPI is a specification for describing RESTful APIs. OpenAPI v3.0 allows us to describe the structures of request and response payloads in a detailed manner. This would, theoretically, mean that we should be able to automatically validate request and response payloads. However, as of writing there aren't many validators around.
 
-The good news is that there are many validators for JSON Schema for different languages. The bad news is that OpenAPI 3.0 is not entirely compatible with JSON Schema. The Schema Object of OpenAPI 3.0 is an extended subset of JSON Schema Specification Wright Draft 00 with some differences.
-
-The purpose of this project is to fill the gap by doing the conversion between these two formats.
+The good news is that there are many validators for JSON Schema for different languages. The bad news is that OpenAPI v3.0 is [not entirely compatible with JSON Schema](https://stoplight.io/blog/openapi-json-schema/). The Schema Object of OpenAPI v3.0 is an extended subset of JSON Schema Specification Wright Draft 00 with some differences. This will be resolved in OpenAPI v3.1, but until then... this tool will fill that gap.
 
 There is also a [CLI tool](https://github.com/mikunn/openapi2schema) for creating a JSON of schemas from the whole API specification.
 
-If you need to do the conversion in reverse, checkout [json-schema-to-openapi-schema](https://github.com/philsturgeon/json-schema-to-openapi-schema).
+If you need to do the conversion in reverse, checkout [json-schema-to-openapi-schema](https://github.com/openapi-contrib/json-schema-to-openapi-schema).
 
 ## Features
 
-* converts OpenAPI 3.0 Schema Object to JSON Schema Draft 4
-* converts OpenAPI 3.0 Parameter Object to JSON Schema Draft 4
-* ~~converts [common named data types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#data-types) to `type` and `format`~~ *(removed in version 2.0.0)*
-  * ~~for example `type: "dateTime"` becomes `type: "string"` with `format: "date-time"`~~
+* converts OpenAPI v3.0 Schema Object to JSON Schema Draft 4
+* converts OpenAPI v3.0 Parameter Object to JSON Schema Draft 4
 * deletes `nullable` and adds `"null"` to `type` array if `nullable` is `true`
 * supports deep structures with nested `allOf`s etc.
 * removes [OpenAPI specific properties](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#fixed-fields-20) such as `discriminator`, `deprecated` etc. unless specified otherwise
 * optionally supports `patternProperties` with `x-patternProperties` in the Schema Object
 
-**NOTE**: `$ref`s are not dereferenced. Use a dereferencer such as [json-schema-ref-parser](https://www.npmjs.com/package/json-schema-ref-parser) prior to using this package.
+**NOTE**: `$ref`s are not handled in any way, so please use a resolver such as [json-ref-resolver](https://github.com/stoplightio/json-ref-resolver) prior to using this package.
 
 ## Installation
 
 ```
-npm install --save openapi-schema-to-json-schema
+npm install --save @openapi-contrib/openapi-schema-to-json-schema
 ```
 
 ## Converting OpenAPI schema
@@ -41,8 +37,7 @@ Here's a small example to get the idea:
 
 ```js
 
-var toJsonSchema = require('openapi-schema-to-json-schema');
-// OR: toJsonSchema = require('openapi-schema-to-json-schema').fromSchema;
+var toJsonSchema = require('@openapi-contrib/openapi-schema-to-json-schema');
 
 var schema = {
   type: 'string',
@@ -87,7 +82,7 @@ var schema = {
   format: 'date'
 };
 
-var convertedSchema = toJsonSchema(schema, {dateToDateTime: true});
+var convertedSchema = toJsonSchema(schema, { dateToDateTime: true });
 
 console.log(convertedSchema);
 ```

README.md

@@ -62,10 +62,9 @@ function resolveOptions(options) {
 }
 
 function patternPropertiesHandler(schema) {
-	var pattern
-		, patternsObj = schema.patternProperties
-		, additProps = schema.additionalProperties
-	;
+  var pattern;
+  var patternsObj = schema.patternProperties;
+  var additProps = schema.additionalProperties;
 
 	if (typeof additProps !== 'object') {
 		return schema;
@@ -82,9 +81,8 @@ function patternPropertiesHandler(schema) {
 }
 
 function resolveNotSupported(notSupported, toRetain) {
-	var i = 0
-		, index
-	;
+  var i = 0;
+  var index;
 
 	for (i; i < toRetain.length; i++) {
 		index = notSupported.indexOf(toRetain[i]);

index.js

@@ -1,7 +1,7 @@
-var convertFromSchema = require('./converters/schema');
-var convertFromParameter = require('./converters/parameter');
+var convertFromSchema = require('./converters/schema')
+var convertFromParameter = require('./converters/parameter')
 
 module.exports = {
-	fromSchema: convertFromSchema,
-	fromParameter: convertFromParameter,
-};
+  fromSchema: convertFromSchema,
+  fromParameter: convertFromParameter
+}

lib/convert.js

@@ -1,38 +1,38 @@
-var convertFromSchema = require('./schema');
-var InvalidInputError = require('../errors/invalid-input-error');
+var convertFromSchema = require('./schema')
+var InvalidInputError = require('../errors/invalid-input-error')
 
-module.exports = convertFromParameter;
+module.exports = convertFromParameter
 
 // Convert from OpenAPI 3.0 `ParameterObject` to JSON schema v4
-function convertFromParameter(parameter, options) {
+function convertFromParameter (parameter, options) {
   if (parameter.schema !== undefined) {
-    return convertParameterSchema(parameter, parameter.schema, options);
+    return convertParameterSchema(parameter, parameter.schema, options)
   } else if (parameter.content !== undefined) {
-    return convertFromContents(parameter, options);
+    return convertFromContents(parameter, options)
   } else {
     if (options.strictMode) {
-      throw new InvalidInputError('OpenAPI parameter must have either a \'schema\' or a \'content\' property');
+      throw new InvalidInputError('OpenAPI parameter must have either a \'schema\' or a \'content\' property')
     }
-    return convertParameterSchema(parameter, {}, options);
+    return convertParameterSchema(parameter, {}, options)
   }
 }
 
-function convertFromContents(parameter, options) {
-  var schemas = {};
+function convertFromContents (parameter, options) {
+  var schemas = {}
 
   for (var mime in parameter.content) {
-    schemas[mime] = convertParameterSchema(parameter, parameter.content[mime].schema, options);
+    schemas[mime] = convertParameterSchema(parameter, parameter.content[mime].schema, options)
   }
 
-  return schemas;
+  return schemas
 }
 
-function convertParameterSchema(parameter, schema, options) {
-  var jsonSchema = convertFromSchema(schema || {}, options);
+function convertParameterSchema (parameter, schema, options) {
+  var jsonSchema = convertFromSchema(schema || {}, options)
 
   if (parameter.description) {
-    jsonSchema.description = parameter.description;
+    jsonSchema.description = parameter.description
   }
 
-  return jsonSchema;
+  return jsonSchema
 }