feat: windows test bug, add support for derefencing definitions (#30)

* Clean up type imports, fix release scripts

* removed dependency, only test on greater than node 14, added lint checks

* test on windows

* test on windows

* test on windows

* test on windows

* support definitions conversions

* fix typescript complaints in tests

.eslintrc.js

@@ -27,7 +27,10 @@ module.exports = {
 				SwitchCase: 1,
 			},
 		],
-		'linebreak-style': ['error', 'unix'],
+		'linebreak-style': [
+			'error',
+			process.platform === 'win32' ? 'windows' : 'unix',
+		],
 		quotes: ['error', 'single'],
 		semi: ['error', 'always'],
 		'@typescript-eslint/ban-ts-comment': 'off',
@@ -38,5 +41,7 @@ module.exports = {
 				prefer: 'type-imports',
 			},
 		],
+		'@typescript-eslint/no-explicit-any': 'off',
 	},
+	ignorePatterns: ['dist/**', 'bin/**'],
 };

.github/workflows/release.yml

@@ -10,13 +10,13 @@ jobs:
     name: Release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 'lts/*'
-      - run: npm ci
-      - run: npm run build --if-present
-      - run: npm test
+          node-version: 18
+      - run: yarn install --frozen-lockfile
+      - run: yarn build
+      - run: yarn test
       - run: npx semantic-release --branches main
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -5,15 +5,23 @@ on: push
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - 14
+          - 16
+          - 18
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
         with:
-          node-version: 'lts/*'
-      - name: npm install, build, and test
+          node-version: ${{ matrix.node-version }}
+      - name: yarn install, build, and test
         run: |
-          npm ci
-          npm run build --if-present
-          npm test
+          yarn --frozen-lockfile
+          yarn build --if-present
+          yarn lint
+          yarn test
         env:
           CI: true

bin/json-schema-to-openapi-schema.js

@@ -2,7 +2,6 @@
 'use strict';
 
 const yargs = require('yargs');
-const chalk = require('chalk');
 const converter = require('../dist/cjs/index.js').default;
 const helpText = require('./help-text.json');
 const fs = require('fs');
@@ -103,6 +102,6 @@ function getHelpText(commandName) {
  */
 function errorHandler(err) {
 	let errorMessage = process.env.DEBUG ? err.stack : err.message;
-	console.error(chalk.red(errorMessage));
+	console.error(errorMessage);
 	process.exit(1);
 }

package.json

@@ -5,21 +5,23 @@
 	"bin": {
 		"json-schema-to-openapi-schema": "bin/json-schema-to-openapi-schema.js"
 	},
-	"types": "dist/mjs/src/index.d.ts",
+	"types": "dist/mjs/index.d.ts",
 	"files": [
 		"/dist"
 	],
-	"main": "dist/cjs/src/index.js",
-	"module": "dist/mjs/src/index.js",
+	"main": "dist/cjs/index.js",
+	"module": "dist/mjs/index.js",
 	"exports": {
 		".": {
-			"import": "./dist/mjs/src/index.js",
-			"require": "./dist/cjs/src/index.js"
+			"import": "./dist/mjs/index.js",
+			"require": "./dist/cjs/index.js"
 		}
 	},
 	"scripts": {
 		"prepublish": "yarn build",
 		"build": "rm -fr dist/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && node scripts/fixup.cjs",
+		"lint": "eslint . && prettier -c src",
+		"lint:fix": "eslint . --fix && prettier -c src -w",
 		"typecheck": "tsc --noEmit",
 		"test": "vitest",
 		"coverage": "vitest --coverage"
@@ -28,27 +30,27 @@
 	"author": "OpenAPI Contrib",
 	"license": "MIT",
 	"engines": {
-		"node": ">=10"
+		"node": ">=14"
 	},
 	"dependencies": {
 		"@apidevtools/json-schema-ref-parser": "^9.0.9",
-		"chalk": "^5.0.1",
 		"json-schema-walker": "^0.0.4",
 		"yargs": "^17.5.1"
 	},
 	"devDependencies": {
+		"@types/json-schema": "^7.0.11",
 		"@typescript-eslint/eslint-plugin": "^5.32.0",
 		"@typescript-eslint/parser": "^5.32.0",
 		"c8": "^7.12.0",
 		"eslint": "^8.21.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-prettier": "^4.2.1",
 		"eslint-plugin-unused-imports": "^2.0.0",
-		"mocha": "^10.0.0",
 		"nock": "^13.2.9",
+		"openapi-typescript": "^5.4.1",
 		"prettier": "^2.7.1",
 		"typescript": "^4.7.4",
-		"vitest": "^0.20.2"
+		"vitest": "^0.20.3"
 	},
 	"prettier": {
 		"singleQuote": true,

src/const.ts

@@ -0,0 +1,43 @@
+// TODO: having definitions inside an oas3 schema isn't exactly valid,
+// maybe it is an idea to extract and split them into multiple oas3 schemas and reference to them.
+// For now leaving as is.
+export const allowedKeywords = [
+	'$ref',
+	'definitions',
+	// From Schema
+	'title',
+	'multipleOf',
+	'maximum',
+	'exclusiveMaximum',
+	'minimum',
+	'exclusiveMinimum',
+	'maxLength',
+	'minLength',
+	'pattern',
+	'maxItems',
+	'minItems',
+	'uniqueItems',
+	'maxProperties',
+	'minProperties',
+	'required',
+	'enum',
+	'type',
+	'not',
+	'allOf',
+	'oneOf',
+	'anyOf',
+	'items',
+	'properties',
+	'additionalProperties',
+	'description',
+	'format',
+	'default',
+	'nullable',
+	'discriminator',
+	'readOnly',
+	'writeOnly',
+	'example',
+	'externalDocs',
+	'deprecated',
+	'xml',
+];

src/index.ts

@@ -5,8 +5,9 @@ import type {
 	JSONSchema7Definition,
 } from 'json-schema';
 import type { Options, SchemaType, SchemaTypeKeys } from './types';
-import { oas3schema } from './lib/openApiSchema';
 import { Walker } from 'json-schema-walker';
+import { allowedKeywords } from './const';
+import type { OpenAPI3 } from 'openapi-typescript';
 
 class InvalidTypeError extends Error {
 	constructor(message: string) {
@@ -18,23 +19,63 @@ class InvalidTypeError extends Error {
 
 const oasExtensionPrefix = 'x-';
 
-// TODO: having definitions inside an oas3 schema isn't exactly valid,
-// maybe it is an idea to extract and split them into multiple oas3 schemas and reference to them.
-// For now leaving as is.
-const allowedKeywords = [
-	'$ref',
-	'definitions',
-	...Object.keys(oas3schema.definitions.Schema.properties),
-];
+const handleDefinition = async <T>(
+	def: JSONSchema7Definition | JSONSchema6Definition | JSONSchema4,
+	schema: T
+) => {
+	if (typeof def !== 'object') {
+		return def;
+	}
+
+	const type = def.type;
+	if (type) {
+		// Walk just the definitions types
+		const walker = new Walker<T>();
+		await walker.loadSchema({ ...def, $schema: schema['$schema'] } as any, {
+			dereference: true,
+			cloneSchema: true,
+			dereferenceOptions: {
+				dereference: {
+					circular: 'ignore',
+				},
+			},
+		});
+		await walker.walk(convertSchema, walker.vocabularies.DRAFT_07);
+		return walker.rootSchema;
+	} else if (Array.isArray(def)) {
+		// if it's an array, we might want to reconstruct the type;
+		const typeArr = def;
+		const hasNull = typeArr.includes('null');
+		if (hasNull) {
+			const actualTypes = typeArr.filter((l) => l !== 'null');
+			return {
+				type: actualTypes.length === 1 ? actualTypes[0] : actualTypes,
+				nullable: true,
+				// this is incorrect but thats ok, we are in the inbetween phase here
+			} as JSONSchema7Definition | JSONSchema6Definition | JSONSchema4;
+		}
+	}
+
+	return def;
+};
 
 const convert = async <T = JSONSchema>(
 	schema: T,
 	options?: Options
-): Promise<SchemaType> => {
+): Promise<OpenAPI3> => {
 	const walker = new Walker<T>();
+	const convertDefs = options?.convertUnreferencedDefinitions ?? true;
 	await walker.loadSchema(schema, options);
 	await walker.walk(convertSchema, walker.vocabularies.DRAFT_07);
-	return walker.rootSchema;
+	// if we want to convert unreferenced definitions, we need to do it iteratively here
+	const rootSchema = walker.rootSchema as unknown as JSONSchema;
+	if (convertDefs && rootSchema?.definitions) {
+		for (const defName in rootSchema.definitions) {
+			const def = rootSchema.definitions[defName];
+			rootSchema.definitions[defName] = await handleDefinition(def, schema);
+		}
+	}
+	return rootSchema as OpenAPI3;
 };
 
 function stripIllegalKeywords(schema: SchemaType) {