RJSF to Support Bundled Schemas

[rbrand21]

Prerequisites

• I have read the documentation

What theme are you using?

core

Is your feature request related to a problem? Please describe.

I'm bundling my disparate schemas into a single Compound Schema Document. When doing so, relative $refs (and absolute) are not resolved properly because they don't start with a #.

The library I'm using to bundle (hyperjump-io/json-schema) appears to be following the JSON Schema spec on bundling.

Here is an example:

json schemas:

// primitive-string.json
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.com/schemas/primitives/string",
     "title": "string",
     "type": "object",
     "properties": {
         "type": {"enum": ["string"]},
         "key": {"type": "string"}
     },
     "required": ["type", "key"]
}

// primitive-treatment.json
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.com/schemas/primitives/treatment",
    "type": "object",
    "anyOf": [
        {
            "title": "C",
            "properties": {
                "C": {
                    "$ref": "/schemas/primitives/string"
                }
            }
        }
    ]
}

bundling code:

//import the above two schemas as string and treatment
async function example(): Promise<object> {
    registerSchema(string)
    registerSchema(treatment)

    return await bundle("https://example.com/schemas/primitives/treatment")
}

Results in the following bundled json schema document:

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.com/schemas/primitives/treatment",
    "type": "object",
    "anyOf": [
        {
            "title": "C",
            "properties": {
                "C": {
                    "$ref": "/schemas/primitives/string"
                }
            }
        }
    ],
    "$defs": {
        "https://example.com/schemas/primitives/string": {
            "$id": "https://example.com/schemas/primitives/string",
            "title": "string",
            "type": "object",
            "properties": {
                "type": {
                    "enum": [
                        "string"
                    ]
                },
                "key": {
                    "type": "string"
                }
            },
            "required": [
                "type",
                "key"
            ]
        }
    }
}

When using that in an RJSF form:

// App.tsx

<Form
  key={key}
  schema={schema}
  validator={validator}
  onChange={log('changed')}
  onSubmit={log('submitted')}
  onError={log('errors')}
/>
)])

It results in the following error:

chunk-HOSCXNDA.js?v=a04102ad:5516 Uncaught Error: Could not find a definition for /schemas/primitives/string.

This is from the relative reference "$ref": "/schemas/primitives/string" and from the error checking code here

Describe the solution you'd like

Ideally RJSF would be able to support relative (or abolute using $ids defined within $defs) $refs

Describe alternatives you've considered

I have tried to massage the json schema from the bundling side to have $refs point to #/<some path> (which seems like it should work) but then schema bundling fails "because /defs isn't defined" or something similar.

[rbrand21]

I've also tried a work around by post-processing the bundled json to have all the $refs point to #/$defs/<schema> and changing the IDs of the schemas within $defs from "https://example.com/schemas/primitives/treatment" to treatment so that the $refs resolve correctly. Although RJSF likes this, I then started getting AJV validation errors complaining it's unable to resolve $refs which are defined in sub-schema objects within $defs

[rbrand21]

Additionally I have confirmed that AJV is capable of compiling a bundled schema with relative $refs and it's only RJSF which is not capable of resolving them.

[rbrand21]

I actually have a further question, why isn't RSJF just using something like AJV to resolve sub-schemas instead of manually writing code to do this?

[heath-freenome]

I actually have a further question, why isn't RSJF just using something like AJV to resolve sub-schemas instead of manually writing code to do this?

We don't want to be too dependent on ajv for schema manipulation and only use it for validation.

[heath-freenome]

Additionally I have confirmed that AJV is capable of compiling a bundled schema with relative $refs and it's only RJSF which is not capable of resolving them.

@rbrand21 We would welcome a fix to our @rjsf/utils functions to deal with this properly in the rjsf-v6 branch

[GlassOfWhiskey]

Hi @heath-freenome @rbrand21, is anyone actively working on this PR at the moment?
If not, I may think about taking a look at it.

[rbrand21]

Hi @heath-freenome @rbrand21, is anyone actively working on this PR at the moment? If not, I may think about taking a look at it.

Not actively working on it