Skip to content

Refactor: Minor safety and modernization updates in processSchema #34

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
Manas-Dikshit wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Refactor: Minor safety and modernization updates in processSchema #34

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b7a2eb9
Refactor processSchema for improved safety and readability
Manas-Dikshit Mar 2, 2026
de598eb
Add JSDoc comments for schema processing functions
Manas-Dikshit Mar 3, 2026
e91043f
Refactor JSDoc comments and type definitions
Manas-Dikshit Mar 3, 2026
2f9b1f3
Refine type definitions for JSONSchema processing
Manas-Dikshit Mar 3, 2026
a8841e6
Update SchemaVisitor context type to ProcessContext
Manas-Dikshit Mar 3, 2026
d94d408
Refactor process-schema.js for clarity and structure
Manas-Dikshit Mar 3, 2026
2fb2ff8
Refine JSONSchema and ProcessContext typedefs
Manas-Dikshit Mar 3, 2026
89ddde0
Refactor JSON schema types and context handling
Manas-Dikshit Mar 5, 2026
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
52 changes: 40 additions & 12 deletions lib/process-schema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,64 @@
const NESTED_WITH_NAME = ["definitions", "properties"];
/**
* @typedef {import("json-schema").JSONSchema7} JSONSchema
*/

const NESTED_DIRECT = ["items", "additionalProperties", "not"];
/**
* @typedef {Object} SchemaVisitor
* @property {(schema: JSONSchema | boolean, context?: unknown) => JSONSchema | boolean | void} [schema]
* @property {(obj: JSONSchema | boolean, context?: unknown) => JSONSchema | boolean | void} [object]
* @property {(arr: (JSONSchema | boolean)[], context?: unknown) => void} [array]
*/

const NESTED_WITH_NAME = ["definitions", "properties"];
const NESTED_DIRECT = ["items", "additionalProperties", "not"];
const NESTED_ARRAY = ["oneOf", "anyOf", "allOf"];

/**
* Recursively processes a JSON Schema using the visitor pattern.
*
* @param {SchemaVisitor} visitor
* @param {JSONSchema | boolean} json
* @param {unknown} [context]
* @returns {JSONSchema | boolean}
*/
const processSchema = (visitor, json, context) => {
if (!json || typeof json !== "object") return json;

json = { ...json };
if (visitor.schema) json = visitor.schema(json, context);

if (typeof visitor?.schema === "function") {
json = visitor.schema(json, context) || json;
}

for (const name of NESTED_WITH_NAME) {
if (name in json && json[name] && typeof json[name] === "object") {
if (visitor.object) json[name] = visitor.object(json[name], context);
for (const key in json[name]) {
if (json[name] && typeof json[name] === "object" && !Array.isArray(json[name])) {
if (typeof visitor?.object === "function") {
json[name] = visitor.object(json[name], context) || json[name];
}

for (const key of Object.keys(json[name])) {
json[name][key] = processSchema(visitor, json[name][key], context);
}
}
}

for (const name of NESTED_DIRECT) {
if (name in json && json[name] && typeof json[name] === "object") {
if (json[name] && typeof json[name] === "object" && !Array.isArray(json[name])) {
json[name] = processSchema(visitor, json[name], context);
}
}

for (const name of NESTED_ARRAY) {
if (name in json && Array.isArray(json[name])) {
json[name] = json[name].slice();
for (let i = 0; i < json[name].length; i++) {
json[name][i] = processSchema(visitor, json[name][i], context);
if (Array.isArray(json[name])) {
json[name] = json[name].map((item) => processSchema(visitor, item, context));

if (typeof visitor?.array === "function") {
visitor.array(json[name], context);
}
if (visitor.array) visitor.array(json[name], context);
}
}

return json;
};

module.exports = processSchema;