Skip to content

fix: expand JSON Schema scope detection to handle and logical keywords #2029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shuklax wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: expand JSON Schema scope detection to handle and logical keywords #2029

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 89 additions & 38 deletions lib/getScopesOfParsedJsonSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,47 +13,98 @@ export default function getScopesOfParsedJsonSchema(
): JsonSchemaPathWithScope[] {
if (typeof parsedJsonSchema !== 'object' || parsedJsonSchema === null)
return [];
const typeDefinitionScope = {
jsonPath,
scope: JsonSchemaScope.TypeDefinition,
};
if (parsedJsonSchema.type === 'object') {
const scopesOfProperties = Object.keys(
parsedJsonSchema?.properties || {},
).reduce<JsonSchemaPathWithScope[]>((acc, property) => {
return [
...acc,
...getScopesOfParsedJsonSchema(
parsedJsonSchema.properties?.[property],
`${jsonPath}['properties']['${property}']`,
),

let scopes: JsonSchemaPathWithScope[] = [
{
jsonPath,
scope: JsonSchemaScope.TypeDefinition,
},
];

// 1. Objects where each value is a subschema
const mapKeywords = [
'properties',
'patternProperties',
'definitions',
'$defs',
'dependentSchemas',
];

mapKeywords.forEach((keyword) => {
const map = parsedJsonSchema[keyword];
if (map && typeof map === 'object' && !Array.isArray(map)) {
Object.keys(map).forEach((key) => {
scopes = [
...scopes,
...getScopesOfParsedJsonSchema(
map[key],
`${jsonPath}['${keyword}']['${key}']`,
),
];
});
}
});

// 2. Arrays where each item is a subschema
const arrayKeywords = ['allOf', 'anyOf', 'oneOf', 'prefixItems'];

arrayKeywords.forEach((keyword) => {
const list = parsedJsonSchema[keyword];
if (Array.isArray(list)) {
list.forEach((subschema: any, index: number) => {
scopes = [
...scopes,
...getScopesOfParsedJsonSchema(
subschema,
`${jsonPath}['${keyword}'][${index}]`,
),
];
});
}
});

// 3. Single subschemas
const singleKeywords = [
'items',
'not',
'if',
'then',
'else',
'additionalProperties',
'propertyNames',
'unevaluatedProperties',
'additionalItems',
'unevaluatedItems',
];

singleKeywords.forEach((keyword) => {
const subschema = parsedJsonSchema[keyword];
// In JSON Schema, a subschema can be an object or a boolean (true/false)
if (typeof subschema === 'object' && subschema !== null) {
scopes = [
...scopes,
...getScopesOfParsedJsonSchema(subschema, `${jsonPath}['${keyword}']`),
];
}, []);
const scopesOfPatternProperties = Object.keys(
parsedJsonSchema?.patternProperties || {},
).reduce<JsonSchemaPathWithScope[]>((acc, property) => {
return [
...acc,
} else if (typeof subschema === 'boolean') {
scopes.push({
jsonPath: `${jsonPath}['${keyword}']`,
scope: JsonSchemaScope.TypeDefinition,
});
}
});

// Special case: "items" as an array (pre-Draft 2020-12 style)
if (Array.isArray(parsedJsonSchema.items)) {
parsedJsonSchema.items.forEach((subschema: any, index: number) => {
scopes = [
...scopes,
...getScopesOfParsedJsonSchema(
parsedJsonSchema.patternProperties?.[property],
`${jsonPath}['patternProperties']['${property}']`,
subschema,
`${jsonPath}['items'][${index}]`,
),
];
}, []);
return [
typeDefinitionScope,
...scopesOfProperties,
...scopesOfPatternProperties,
];
}
if (parsedJsonSchema.type === 'array') {
return [
typeDefinitionScope,
...getScopesOfParsedJsonSchema(
parsedJsonSchema.items,
`${jsonPath}['items']`,
),
];
});
}
return [typeDefinitionScope];

return scopes;
}
Loading