@squiz/json-schema-library/lib/eachSchema.ts

Customizable and hackable json-validator and json-schema utilities for traversal, data generation and validation

import gp from "@sagold/json-pointer";
import getTypeDefs from "./schema/getTypeDefs";
import { JSONSchema, JSONPointer } from "./types";

export type EachSchemaCallback = (schema: JSONSchema, pointer: JSONPointer) => void;

type Walker = {
    nextTypeDefs: typeof nextTypeDefs;
    callback: EachSchemaCallback;
};

const isObject = (value: unknown): value is Record<string, unknown> =>
    Object.prototype.toString.call(value) === "[object Object]";

function nextTypeDefs(schema: JSONSchema, pointer: JSONPointer) {
    if (this.callback(schema, pointer) === true) {
        // eslint-disable-line no-invalid-this
        return; // stop iteration
    }

    const defs = getTypeDefs(schema);
    // eslint-disable-next-line no-invalid-this
    defs.forEach((next) => this.nextTypeDefs(next.def, gp.join(pointer, next.pointer, false)));
}

function eachDefinition(
    walk: Walker,
    schema: JSONSchema,
    pointer: JSONPointer,
    key = "definitions"
) {
    const defs = schema[key];
    Object.keys(defs).forEach((defId) => {
        if (defs[defId] === false || isObject(defs[defId])) {
            walk.nextTypeDefs(defs[defId], gp.join(pointer, key, defId, false));
            return;
        }
        // console.log(`Invalid schema in ${pointer}/${key}/${defId}`);
    });
}

export function eachSchema(
    schema: JSONSchema,
    callback: EachSchemaCallback,
    pointer: JSONPointer = "#"
) {
    const walk = { callback, nextTypeDefs };
    walk.nextTypeDefs(schema, pointer);

    if (schema.definitions != null) {
        walk.callback = (defschema, schemaPointer) => {
            callback(defschema, schemaPointer);
            if (defschema.definitions != null) {
                eachDefinition(walk, defschema, schemaPointer);
            }
        };

        eachDefinition(walk, schema, pointer);
    }

    if (schema.$defs != null) {
        walk.callback = (defschema, schemaPointer) => {
            callback(defschema, schemaPointer);
            if (defschema.definitions != null) {
                eachDefinition(walk, defschema, schemaPointer);
            }
        };

        eachDefinition(walk, schema, pointer, "$defs");
    }
}