json-schema-library/lib/types.ts

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

import { Draft } from "./draft";

export type JsonSchema = { [p: string]: any };
export type JsonPointer = string;
export type ErrorData<T extends Record<string, unknown> = { [p: string]: unknown }> = T & {
    /* json-pointer to location of error */
    pointer: string;
    /* json-schema of error location */
    schema: JsonSchema;
    /* value: data in error location */
    value: unknown;
};

export type JsonError<T extends ErrorData = ErrorData> = {
    type: "error";
    name: string;
    code: string;
    message: string;
    data: T;
    [p: string]: unknown;
};

/**
 * ts type guard for json error
 * @returns true if passed type is a JsonError
 */
export function isJsonError(error: any): error is JsonError {
    return error?.type === "error";
}

export interface JsonValidator {
    (draft: Draft, schema: JsonSchema, value: unknown, pointer: JsonPointer):
        | void
        | undefined
        | JsonError
        | JsonError[]
        | JsonError[][];
}

export interface JsonTypeValidator {
    (draft: Draft, schema: JsonSchema, value: unknown, pointer: JsonPointer): Array<
        void | undefined | JsonError | JsonError[] | JsonError[][]
    >;
}