@ngx-pwa/local-storage/lib/validation/json-schema.d.ts

Efficient local storage module for Angular: simple API based on native localStorage API, but internally stored via the asynchronous IndexedDB API for performance, and wrapped in RxJS observables to be homogeneous with other Angular modules.

/**
 * JSON Schema to describe a boolean value.
 */
export interface JSONSchemaBoolean {
    /**
     * Type for a boolean value.
     */
    type: 'boolean';
    /**
     * Checks if a value is strictly equal to this.
     */
    const?: boolean;
}
/**
 * JSON Schema to describe a number value.
 */
export interface JSONSchemaNumber {
    /**
     * Type for a numeric value.
     */
    type: 'number';
    /**
     * Checks if a value is strictly equal to this.
     */
    const?: number;
    /**
     * Checks if a value is strictly equal to one of the value of enum.
     */
    enum?: number[];
    /**
     * Check if a number is a multiple of x.
     * Must be strictly greater than 0.
     */
    multipleOf?: number;
    /**
     * Check if a number is lower or equal than this maximum.
     */
    maximum?: number;
    /**
     * Check if a number is strictly lower than this maximum.
     */
    exclusiveMaximum?: number;
    /**
     * Check if a number is greater or equal than this minimum.
     */
    minimum?: number;
    /**
     * Check if a number is strictly greater than this minimum.
     */
    exclusiveMinimum?: number;
}
/**
 * JSON Schema to describe an integer value.
 */
export interface JSONSchemaInteger {
    /**
     * Type for an integer value.
     */
    type: 'integer';
    /**
     * Checks if a value is strictly equal to this.
     */
    const?: number;
    /**
     * Checks if a value is strictly equal to one of the value of enum.
     */
    enum?: number[];
    /**
     * Check if a number is a multiple of x.
     * Must be strictly greater than 0.
     */
    multipleOf?: number;
    /**
     * Check if a number is lower or equal than this maximum.
     */
    maximum?: number;
    /**
     * Check if a number is strictly lower than this maximum.
     */
    exclusiveMaximum?: number;
    /**
     * Check if a number is greater or equal than this minimum.
     */
    minimum?: number;
    /**
     * Check if a number is strictly greater than this minimum.
     */
    exclusiveMinimum?: number;
}
/**
 * JSON Schema to describe a string value.
 */
export interface JSONSchemaString {
    /**
     * Type for a string value.
     */
    type: 'string';
    /**
     * Checks if a value is strictly equal to this.
     */
    const?: string;
    /**
     * Checks if a value is strictly equal to one of the value of enum.
     */
    enum?: string[];
    /**
     * Maxium length for a string.
     * Must be a non-negative integer.
     */
    maxLength?: number;
    /**
     * Minimum length for a string.
     * Must be a non-negative integer.
     */
    minLength?: number;
    /**
     * Pattern to match for a string.
     * Must be a valid regular expression, *without* the `/` delimiters.
     */
    pattern?: string;
}
/**
 * JSON schema to describe an array of values.
 */
export interface JSONSchemaArray {
    /**
     * Type for an array of values.
     */
    type: 'array';
    /**
     * Schema for the values of an array, or array of schemas for a tuple.
     */
    items: JSONSchema | JSONSchema[];
    /**
     * Check if an array length is lower or equal to this value.
     * Must be a non negative integer.
     */
    maxItems?: number;
    /**
     * Check if an array length is greater or equal to this value.
     * Must be a non negative integer.
     */
    minItems?: number;
    /**
     * Check if an array only have unique values.
     */
    uniqueItems?: boolean;
}
/**
 * JSON Schema to describe an array of primitive values:
 * - array of booleans: `JSONSchemaArrayOf<JSONSchemaBoolean>`,
 * - array of numbers: `JSONSchemaArrayOf<JSONSchemaNumber>`,
 * - array of integers: `JSONSchemaArrayOf<JSONSchemaInteger>`,
 * - array of strings: `JSONSchemaArrayOf<JSONSchemaString>`.
 */
export interface JSONSchemaArrayOf<T extends JSONSchemaBoolean | JSONSchemaNumber | JSONSchemaInteger | JSONSchemaString> {
    /**
     * Type for an array of values.
     */
    type: 'array';
    /**
     * Schema for the values of an array.
     */
    items: T;
    /**
     * Check if an array length is lower or equal to this value.
     * Must be a non negative integer.
     */
    maxItems?: number;
    /**
     * Check if an array length is greater or equal to this value.
     * Must be a non negative integer.
     */
    minItems?: number;
    /**
     * Check if an array only have unique values.
     */
    uniqueItems?: boolean;
}
/**
 * JSON schema to describe an object.
 */
export interface JSONSchemaObject {
    /**
     * Type for an object.
     */
    type: 'object';
    /**
     * List of properties of the object and their associated JSON schemas.
     */
    properties: {
        [k: string]: JSONSchema;
    };
    /**
     * Array of names of the required properties for an object.
     * Properties set as required should be present in `properties` too.
     */
    required?: string[];
}
/**
 * Subset of the JSON Schema standard.
 * Types are enforced to validate everything: each value **must** have a `type`.
 * @see {@link https://github.com/cyrilletuzi/angular-async-local-storage/blob/master/docs/VALIDATION.md}
 *
 * @example
 * const schema: JSONSchema = { type: 'string' };
 *
 * @example
 * const schema: JSONSchema = { type: 'number' };
 *
 * @example
 * const schema: JSONSchema = { type: 'integer' };
 *
 * @example
 * const schema: JSONSchema = { type: 'boolean' };
 *
 * @example
 * const schema: JSONSchema = {
 *   type: 'array',
 *   items: { type: 'string' },
 * };
 *
 * @example
 * const schema: JSONSchema = {
 *   type: 'object',
 *   properties: {
 *     firstName: { type: 'string' },
 *     lastName: { type: 'string' },
 *   },
 *   required: ['firstName'],
 * };
 */
export declare type JSONSchema = JSONSchemaString | JSONSchemaNumber | JSONSchemaInteger | JSONSchemaBoolean | JSONSchemaArray | JSONSchemaObject;