json-schema-describes-subset/dist/derived/derived.js

Tools for static JSON schema analysis, including functions to determine if one schema describes a subset of another or if a schema describes the empty set or to convert a schema to its disjunctive normal form (DNF).

import { schemaDescribesEmptySet, } from '../dnf/dnf.js';
import { schemaDescribesSubset } from '../schema-describes-subset/index.js';
import { resolveSchemaArgumentsIds } from '../id/index.js';
/**
 * Tries to determine whether the provided schema accepts any JSON value. In
 * that case, the schema would be equivalent to the `true` or `{}` schema.
 *
 * @returns The [limitations](https://github.com/jobohner/json-schema-describes-subset/blob/v0.4.0/docs/README.md#limitations) concerning false negative
 * `null` results apply here.
 *
 * @example 🚧TODO🚧
 *
 * @remarks Use cases
 *
 * Can't think of any 🤷‍♂️. This function was created only because it was so easy
 * to do so.
 *
 */
export function schemaDescribesUniverse(schema, options) {
    const resolved = resolveSchemaArgumentsIds([schema], options);
    return schemaDescribesEmptySet({ not: resolved.schemas[0] }, resolved.options);
}
/**
 * Tries to determine whether the provided schemas accept the exact same set of
 * data values.
 *
 * @returns The [limitations](https://github.com/jobohner/json-schema-describes-subset/blob/v0.4.0/docs/README.md#limitations) concerning false negative
 * `null` results apply here.
 *
 * @example 🚧TODO🚧
 *
 * @remarks Use cases
 *
 * One possible use case could be: If you are creating a tool that transforms a
 * JSON Schema to another representation (like {@link toDNF}), this function
 * could be useful to help create tests.
 *
 */
export function schemasAreEquivalent(schemaA, schemaB, options) {
    const resolved = resolveSchemaArgumentsIds([schemaA, schemaB], options);
    const [resolvedSchemaA, resolvedSchemaB] = resolved.schemas;
    const aDescribesSubsetOfB = schemaDescribesSubset(resolvedSchemaA, resolvedSchemaB, resolved.options);
    if (aDescribesSubsetOfB === false) {
        /* there is at least one element of 'a' that is not in 'b'
         * => definitely not equivalent */
        return false;
    }
    const bDescribesSubsetOfA = schemaDescribesSubset(resolvedSchemaB, resolvedSchemaA, resolved.options);
    if (bDescribesSubsetOfA === false) {
        /* there is at least one element of 'b' that is not in 'a'
         * => definitely not equivalent */
        return false;
    }
    return aDescribesSubsetOfB && bDescribesSubsetOfA;
}
//# sourceMappingURL=derived.js.map