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

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

import { Draft } from "./draft";
import { isJSONError, JSONError, JSONSchema } from "./types";

/**
 * Returns a list of possible child-schemas for the given property key. In case of a oneOf selection, multiple schemas
 * could be added at the given property (e.g. item-index), thus an array of options is returned. In all other cases
 * a list with a single item will be returned
 *
 * @param core        - core to use
 * @param property    - parent schema of following property
 * @param [schema]    - parent schema of following property
 * @return
 */
export default function getChildSchemaSelection(
    core: Draft,
    property: string | number,
    schema: JSONSchema = core.rootSchema
): JSONSchema[] | JSONError {
    const result = core.step(property, schema, {}, "#");

    if (isJSONError(result)) {
        if (result.code === "one-of-error") {
            return result.data.oneOf.map((item: JSONSchema) => core.resolveRef(item));
        }
        return result;
    }

    return [result];
}