@naturalcycles/js-lib/dist/json-schema/jsonSchema.model.d.ts

Standard library for universal (browser + Node.js) javascript

import type { AnyObject, StringMap } from '../types.js';
export type JsonSchema<T = unknown> = JsonSchemaAny<T> | JsonSchemaOneOf<T> | JsonSchemaAllOf<T> | JsonSchemaAnyOf<T> | JsonSchemaNot<T> | JsonSchemaRef<T> | JsonSchemaConst<T> | JsonSchemaEnum<T> | JsonSchemaString | JsonSchemaNumber | JsonSchemaBoolean | JsonSchemaNull | JsonSchemaObject | JsonSchemaArray<T> | JsonSchemaTuple<T>;
export interface JsonSchemaAny<T = unknown> {
    $schema?: string;
    $id?: string;
    title?: string;
    description?: string;
    deprecated?: boolean;
    readOnly?: boolean;
    writeOnly?: boolean;
    type?: string;
    default?: T;
    if?: JsonSchema;
    then?: JsonSchema;
    else?: JsonSchema;
    /**
     * https://ajv.js.org/packages/ajv-keywords.html#instanceof
     *
     * Useful for Node.js Buffer, you can use it like:
     * `instanceof: 'Buffer'`
     */
    instanceof?: string | string[];
    /**
     * This is a temporary "intermediate AST" field that is used inside the parser.
     * In the final schema this field will NOT be present.
     */
    optionalField?: true;
}
/**
 * Union type
 */
export interface JsonSchemaOneOf<T = unknown> extends JsonSchemaAny<T> {
    oneOf: JsonSchema[];
}
/**
 * Intersection type
 */
export interface JsonSchemaAllOf<T = unknown> extends JsonSchemaAny<T> {
    allOf: JsonSchema[];
}
export interface JsonSchemaAnyOf<T = unknown> extends JsonSchemaAny<T> {
    anyOf: JsonSchema[];
}
export interface JsonSchemaNot<T = unknown> extends JsonSchemaAny<T> {
    not: JsonSchema;
}
export interface JsonSchemaConst<T = unknown> extends JsonSchemaAny<T> {
    const: T;
}
export interface JsonSchemaString<T extends string = string> extends JsonSchemaAny<T> {
    type: 'string';
    pattern?: string;
    minLength?: number;
    maxLength?: number;
    format?: string;
    contentMediaType?: string;
    contentEncoding?: string;
    /**
     * https://ajv.js.org/packages/ajv-keywords.html#transform
     */
    transform?: ('trim' | 'toLowerCase' | 'toUpperCase')[];
}
export interface JsonSchemaNumber<T extends number = number> extends JsonSchemaAny<T> {
    type: 'number' | 'integer';
    format?: string;
    multipleOf?: number;
    minimum?: number;
    exclusiveMinimum?: number;
    maximum?: number;
    exclusiveMaximum?: number;
}
export interface JsonSchemaBoolean extends JsonSchemaAny<boolean> {
    type: 'boolean';
}
export interface JsonSchemaNull extends JsonSchemaAny<null> {
    type: 'null';
}
export interface JsonSchemaEnum<T = unknown> extends JsonSchemaAny<T> {
    enum: T[];
}
export interface JsonSchemaRef<T = unknown> extends JsonSchemaAny<T> {
    $ref: string;
}
export interface JsonSchemaRootObject<T extends AnyObject = AnyObject> extends JsonSchemaObject<T> {
    $id: string;
}
export interface JsonSchemaObject<T extends AnyObject = AnyObject> extends JsonSchemaAny<T> {
    type: 'object';
    properties: {
        [k in keyof T]: JsonSchema;
    };
    required: (keyof T)[];
    additionalProperties: boolean;
    minProperties?: number;
    maxProperties?: number;
    patternProperties?: StringMap<JsonSchema>;
    propertyNames?: JsonSchema;
    /**
     * @example
     *
     * dependentRequired: {
     *   credit_card: ['billing_address']
     * }
     */
    dependentRequired?: StringMap<string[]>;
    dependentSchemas?: StringMap<JsonSchema>;
    dependencies?: StringMap<string[]>;
}
export interface JsonSchemaArray<ITEM = unknown> extends JsonSchemaAny<ITEM[]> {
    type: 'array';
    items: JsonSchema<ITEM>;
    minItems?: number;
    maxItems?: number;
    uniqueItems?: boolean;
}
export interface JsonSchemaTuple<T = unknown> extends JsonSchemaAny<T> {
    type: 'array';
    items: JsonSchema[];
    minItems: number;
    maxItems: number;
}