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

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

import gp from "@sagold/json-pointer";
import { JSONSchema, JSONPointer, isJSONError } from "./types";
import { Draft } from "./draft";

const emptyObject = {};

/**
 * Returns the json-schema of a data-json-pointer.
 *
 *  Notes
 *      - Uses draft.step to walk through data and schema
 *
 * @param draft
 * @param pointer - json pointer in data to get the json schema for
 * @param [data] - the data object, which includes the json pointers value. This is optional, as
 *    long as no oneOf, anyOf, etc statement is part of the pointers schema
 * @param [schema] - the json schema to iterate. Defaults to draft.rootSchema
 * @return json schema object of the json-pointer or an error
 */
export default function getSchema(
    draft: Draft,
    pointer: JSONPointer,
    data?: unknown,
    schema: JSONSchema = draft.rootSchema
): JSONSchema {
    const frags = gp.split(pointer);
    schema = draft.resolveRef(schema);
    return _get(draft, schema, frags, pointer, data);
}

function _get(
    draft: Draft,
    schema: JSONSchema,
    frags: Array<string>,
    pointer: JSONPointer,
    data: unknown = emptyObject
): JSONSchema {
    if (frags.length === 0) {
        return draft.resolveRef(schema);
    }

    const key = frags.shift(); // step key
    schema = draft.step(key, schema, data, pointer); // step schema
    if (isJSONError(schema)) {
        return schema;
    }
    // @ts-ignore
    data = data[key]; // step data
    return _get(draft, schema, frags, `${pointer}/${key}`, data);
}