feat(extract-json-schema): Added lookup from schema object to its top-level ref name

Author: grantila

README.md

@@ -318,7 +318,7 @@ or as all types at once, into one big JSON schema. In this case, all validation
 ```ts
 import { extractJsonSchema } from "suretype"
 
-const { schema: jsonSchema, lookup } =
+const { schema: jsonSchema, lookup, schemaRefName } =
     extractJsonSchema( [ userSchema, messageSchema ], { /* opts... */ } );
 ```
 
@@ -361,11 +361,14 @@ The result is an object on the form:
 interface ExtractedJsonSchema {
     schema: SchemaWithDefinitions; // Contains a 'definitions' property
     lookup: Map< CoreValidator< unknown >, any >;
+    schemaRefName: Map< any, string >;
 }
 ```
 
 The `lookup` is useful to lookup the json schema for a certain validator object reference, especially unnamed ones which are not included in the schema.
 
+The `schemaRefName` contains a lookup map from (top-level) schema object to its name as used when referring to it, not necessarily the same as what it is internally named, if there where naming conflicts and `OnTopLevelNameConflict` is `rename`.
+
 In the example above, the `jsonSchema` *object* (which can be `JSON.stringify`'d) will be something like:
 
 <details style="padding-left: 32px;border-left: 4px solid gray;">

lib/extract-json-schema.test.ts

@@ -265,16 +265,17 @@ describe( "extract-json-schema", ( ) =>
 		const schema2 = v.anyOf( [ v.string( ), v.boolean( ) ] );
 		const schema3 = v.anyOf( [ v.string( ), schema1 ] );
 
-		const { schema, lookup } = extractJsonSchema(
+		const { schema, lookup, schemaRefName } = extractJsonSchema(
 			[ schema1, schema2, schema3 ],
 			{ onNonSuretypeValidator: 'lookup' }
 		);
 
-		schema;
-		lookup;
 		expect( schema ).toMatchSnapshot( );
 		expect( lookup.get( schema1 ) ).toMatchSnapshot( );
 		expect( lookup.get( schema2 ) ).toMatchSnapshot( );
 		expect( lookup.get( schema3 ) ).toMatchSnapshot( );
+		expect( schemaRefName.get( lookup.get( schema1 ) ) ).toBe( 'Foo' );
+		expect( schemaRefName.get( lookup.get( schema2 ) ) ).toBeUndefined( );
+		expect( schemaRefName.get( lookup.get( schema3 ) ) ).toBeUndefined( );
 	} );
 } );

lib/extract-json-schema.ts

@@ -25,8 +25,22 @@ export interface SchemaWithDefinitions
 
 export interface ExtractedJsonSchema
 {
+	/**
+	 * The extracted schema definitions
+	 */
 	schema: SchemaWithDefinitions;
+
+	/**
+	 * Lookup from validator to schema object
+	 */
 	lookup: Map< CoreValidator< unknown >, any >;
+
+	/**
+	 * Lookup from top-level schema object to its corresponding name.
+	 * This is its referrable name, which might not be the same as its inner
+	 * name if it had to be renamed due to top-level naming conflicts.
+	 */
+	schemaRefName: Map< any, string >;
 }
 
 /**
@@ -86,7 +100,15 @@ export function extractJsonSchema(
 	);
 	const { schema, lookup } = traverser.getSchema( );
 
-	return { schema, lookup };
+	const schemaRefName = new Map< any, string >( );
+	Object
+		.entries( ( schema as SchemaWithDefinitions ).definitions )
+		.forEach( ( [ name, schema ] ) =>
+		{
+			schemaRefName.set( schema, name );
+		} );
+
+	return { schema, lookup, schemaRefName };
 }
 
 export type ExtractSingleSchemaResult =