changed format of options

Author: jonluca

package.json

@@ -43,7 +43,7 @@
 		"@typescript-eslint/parser": "^5.31.0",
 		"c8": "^7.12.0",
 		"coveralls": "^3.1.1",
-		"eslint": "^8.20.0",
+		"eslint": "^8.21.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-prettier": "^4.2.1",
 		"eslint-plugin-unused-imports": "^2.0.0",

src/index.ts

@@ -58,7 +58,7 @@ const convert = async <T = JSONSchema>(
 	const {
 		cloneSchema = true,
 		dereference = false,
-		useRefIfCycleFound = true,
+		dereferenceOptions,
 	} = options || {};
 	let schemaToUse = schema as SchemaType;
 
@@ -69,11 +69,7 @@ const convert = async <T = JSONSchema>(
 	const parser = new RefParser();
 	if (dereference) {
 		// We run the risk of circular references here
-		const res = await parser.dereference(schema, {
-			dereference: {
-				circular: useRefIfCycleFound ? 'ignore' : true,
-			},
-		});
+		const res = await parser.dereference(schema, dereferenceOptions || {});
 		schemaToUse = res as SchemaType;
 	}
 

src/types.ts

@@ -1,4 +1,5 @@
 import type { JSONSchema } from '@apidevtools/json-schema-ref-parser';
+import type $RefParser from '@apidevtools/json-schema-ref-parser';
 
 export type addPrefixToObject<T> = {
 	[K in keyof JSONSchema as `x-${K}`]: JSONSchema[K];
@@ -7,7 +8,7 @@ export type addPrefixToObject<T> = {
 export interface Options {
 	cloneSchema?: boolean;
 	dereference?: boolean;
-	useRefIfCycleFound?: boolean;
+	dereferenceOptions?: $RefParser.Options;
 }
 type ExtendedJSONSchema = addPrefixToObject<JSONSchema> & JSONSchema;
 export type SchemaType = ExtendedJSONSchema & {

test/circular_schema.test.ts

@@ -6,6 +6,7 @@ it(`converts ${test}/openapi.json`, async ({ expect }) => {
 	const schema = getSchema(test + '/json-schema.json');
 	const result = await convert(schema, {
 		dereference: true,
+		dereferenceOptions: { dereference: { circular: 'ignore' } },
 	});
 	const expected = getSchema(test + '/openapi.json');
 	expect(result).toEqual(expected);
@@ -16,6 +17,7 @@ it(`converting ${test}/openapi.json in place`, async ({ expect }) => {
 	const result = await convert(schema, {
 		cloneSchema: false,
 		dereference: true,
+		dereferenceOptions: { dereference: { circular: 'ignore' } },
 	});
 	const expected = getSchema(test + '/openapi.json');
 	expect(schema).toEqual(result);
@@ -28,7 +30,6 @@ it(`converting ${test}/openapi.json without circular references turned off `, as
 	const schema = getSchema(test + '/json-schema.json');
 	const result = await convert(schema, {
 		cloneSchema: false,
-		useRefIfCycleFound: false,
 		dereference: true,
 	});
 	expect(result).toMatchSnapshot();