z-schema 7.0.5 → 7.0.7

package/src/{ZSchema.ts → z-schema.ts}

@@ -1,19 +1,27 @@
 import get from 'lodash.get';
-import { Report, SchemaError, SchemaErrorDetail } from './Report.js';
-import { FormatValidators } from './FormatValidators.js';
-import * as JsonValidation from './JsonValidation.js';
-import * as SchemaCache from './SchemaCache.js';
-import * as SchemaCompilation from './SchemaCompilation.js';
-import * as SchemaValidation from './SchemaValidation.js';
-import * as Utils from './Utils.js';
-import Draft4Schema from './schemas/schema.json' with { type: 'json' };
-import Draft4HyperSchema from './schemas/hyper-schema.json' with { type: 'json' };
-import type { Errors } from './Errors.js';
+import { Report, SchemaError, SchemaErrorDetail } from './report.js';
+import { FormatValidatorFn, getRegisteredFormats, registerFormat, unregisterFormat } from './format-validators.js';
+import { validate as validateJson } from './json-validation.js';
+import { SchemaCache } from './schema-cache.js';
+import { SchemaCompiler } from './schema-compiler.js';
+import { SchemaValidator } from './schema-validator.js';
+import { shallowClone, deepClone } from './utils/clone.js';
+import { whatIs } from './utils/what-is.js';
+import { schemaSymbol, jsonSymbol } from './utils/symbols.js';
+import { getRemotePath } from './utils/uri.js';
+import type { Errors } from './errors.js';
+// import schemas so they don't have to be downloaded for validation purposes
+import type { JsonSchema, JsonSchemaInternal } from './json-schema.js';
+import _Draft4Schema from './schemas/draft-04-schema.json' with { type: 'json' };
+import _Draft4HyperSchema from './schemas/draft-04-hyper-schema.json' with { type: 'json' };
+
+const Draft4Schema: JsonSchema = _Draft4Schema;
+const Draft4HyperSchema: JsonSchema = _Draft4HyperSchema;
 
 /**
  * default options
  */
-const defaultOptions = {
+const defaultOptions: ZSchemaOptions = {
   // default timeout for all async tasks
   asyncTimeout: 2000,
   // force additionalProperties and additionalItems to be defined on "object" and "array" types
@@ -57,17 +65,17 @@ const defaultOptions = {
   // ignore unknown formats (do not report them as an error)
   ignoreUnknownFormats: false,
   // function to be called on every schema
-  customValidator: null,
+  customValidator: null as unknown as undefined,
 };
 
-function normalizeOptions(options) {
+const normalizeOptions = (options?: ZSchemaOptions) => {
   let normalized;
 
   // options
   if (typeof options === 'object') {
-    let keys = Object.keys(options),
-      idx = keys.length,
-      key;
+    let keys = Object.keys(options) as Array<keyof ZSchemaOptions>;
+    let idx = keys.length;
+    let key;
 
     // check that the options are correctly configured
     while (idx--) {
@@ -78,18 +86,18 @@ function normalizeOptions(options) {
     }
 
     // copy the default options into passed options
-    keys = Object.keys(defaultOptions);
+    keys = Object.keys(defaultOptions) as Array<keyof ZSchemaOptions>;
     idx = keys.length;
     while (idx--) {
       key = keys[idx];
       if (options[key] === undefined) {
-        options[key] = Utils.clone(defaultOptions[key]);
+        (options as any)[key] = shallowClone(defaultOptions[key]);
       }
     }
 
     normalized = options;
   } else {
-    normalized = Utils.clone(defaultOptions);
+    normalized = shallowClone(defaultOptions);
   }
 
   if (normalized.strictMode === true) {
@@ -104,12 +112,13 @@ function normalizeOptions(options) {
   }
 
   return normalized;
-}
+};
 
 export interface ZSchemaOptions {
   asyncTimeout?: number;
   forceAdditional?: boolean;
-  assumeAdditional?: boolean;
+  assumeAdditional?: boolean | string[];
+  enumCaseInsensitiveComparison?: boolean;
   forceItems?: boolean;
   forceMinItems?: boolean;
   forceMaxItems?: boolean;
@@ -135,60 +144,39 @@ export interface ValidateOptions {
   includeErrors?: Array<keyof typeof Errors>;
 }
 
-type ValidateCallback = (e: Error, valid: boolean) => void;
+export type ValidateCallback = (e: Error | SchemaErrorDetail[] | null, valid: boolean) => void;
 
 // a sync function that loads schemas for future use, for example from schemas directory, during server startup
-type SchemaReader = (uri: string) => unknown;
+export type SchemaReader = (uri: string) => JsonSchema;
 
 export class ZSchema {
-  public lastReport: Report | undefined;
-
-  /**
-   * Register a custom format.
-   *
-   * @param name - name of the custom format
-   * @param validatorFunction - custom format validator function.
-   *   Returns `true` if `value` matches the custom format.
-   */
-  public static registerFormat(formatName: string, validatorFunction: (value: unknown) => boolean): void {
-    FormatValidators[formatName] = validatorFunction;
+  public static registerFormat(name: string, validatorFunction: FormatValidatorFn): void {
+    return registerFormat(name, validatorFunction);
   }
 
-  /**
-   * Unregister a format.
-   *
-   * @param name - name of the custom format
-   */
   public static unregisterFormat(name: string): void {
-    delete FormatValidators[name];
+    return unregisterFormat(name);
   }
 
-  /**
-   * Get the list of all registered formats.
-   *
-   * Both the names of the burned-in formats and the custom format names are
-   * returned by this function.
-   *
-   * @returns {string[]} the list of all registered format names.
-   */
   public static getRegisteredFormats(): string[] {
-    return Object.keys(FormatValidators);
+    return getRegisteredFormats();
   }
 
   public static getDefaultOptions(): ZSchemaOptions {
-    return Utils.cloneDeep(defaultOptions);
+    return deepClone(defaultOptions);
   }
 
-  private cache: Record<string, string>;
-  private referenceCache: Array<string>;
-  private validateOptions: ValidateOptions;
+  lastReport: Report | undefined;
+  scache: SchemaCache;
+  sc: SchemaCompiler;
+  sv: SchemaValidator;
+  validateOptions: ValidateOptions = {};
   options: ZSchemaOptions;
 
   constructor(options?: ZSchemaOptions) {
-    this.cache = {};
-    this.referenceCache = [];
-    this.validateOptions = {};
-
+    this.scache = new SchemaCache(this);
+    this.sc = new SchemaCompiler(this);
+    this.sv = new SchemaValidator(this);
     this.options = normalizeOptions(options);
 
     // Disable strict validation for the built-in schemas
@@ -198,42 +186,34 @@ export class ZSchema {
     this.setRemoteReference('http://json-schema.org/draft-04/hyper-schema', Draft4HyperSchema, metaschemaOptions);
   }
 
-  /** Used by SchemaCache to break circular dependency with SchemaCompilation */
-  _compileSchema(report: Report, schema: unknown): boolean {
-    return SchemaCompilation.compileSchema.call(this, report, schema);
-  }
-
-  /**
-   * @param schema - JSON object representing schema
-   * @returns {boolean} true if schema is valid.
-   */
-  validateSchema(schema: unknown): boolean {
+  validateSchema(schema: JsonSchema): boolean {
     if (Array.isArray(schema) && schema.length === 0) {
       throw new Error('.validateSchema was called with an empty array');
     }
 
     const report = new Report(this.options);
 
-    schema = SchemaCache.getSchema.call(this, report, schema);
+    schema = this.scache.getSchema(report, schema)!;
 
-    const compiled = SchemaCompilation.compileSchema.call(this, report, schema);
+    const compiled = this.sc.compileSchema(report, schema);
     if (compiled) {
-      SchemaValidation.validateSchema.call(this, report, schema);
+      this.sv.validateSchema(report, schema);
     }
 
     this.lastReport = report;
     return report.isValid();
   }
 
-  /**
-   * @param json - either a JSON string or a parsed JSON object
-   * @param schema - the JSON object representing the schema
-   * @returns true if json matches schema
-   */
-  validate(json, schema, options?: ValidateOptions, callback?: ValidateCallback): boolean;
-  validate(json, schema, callback?): boolean;
-  validate(json, schema): boolean;
-  validate(json, schema, options?: ValidateOptions | ValidateCallback, callback?: ValidateCallback): boolean {
+  validate(json: unknown, schema: JsonSchema | string, options?: ValidateOptions, callback?: ValidateCallback): void;
+  validate(json: unknown, schema: JsonSchema | string, callback?: ValidateCallback): void;
+  validate(json: unknown, schema: JsonSchema | string, options?: ValidateOptions): boolean;
+  validate(json: unknown, schema: JsonSchema | string): boolean;
+  validate(
+    json: unknown,
+    schema: JsonSchema | string,
+    options?: ValidateOptions | ValidateCallback,
+    callback?: ValidateCallback
+  ): boolean | void {
     if (typeof options === 'function') {
       callback = options;
       options = {};
@@ -244,9 +224,11 @@ export class ZSchema {
 
     this.validateOptions = options;
 
-    const whatIs = Utils.whatIs(schema);
-    if (whatIs !== 'string' && whatIs !== 'object') {
-      const e = new Error('Invalid .validate call - schema must be a string or object but ' + whatIs + ' was passed!');
+    const schemaType = whatIs(schema);
+    if (schemaType !== 'string' && schemaType !== 'object') {
+      const e = new Error(
+        'Invalid .validate call - schema must be a string or object but ' + schemaType + ' was passed!'
+      );
       if (callback) {
         setTimeout(function () {
           callback(e, false);
@@ -260,19 +242,20 @@ export class ZSchema {
     const report = new Report(this.options);
     report.json = json;
 
+    let _schema: JsonSchemaInternal;
     if (typeof schema === 'string') {
       const schemaName = schema;
-      schema = SchemaCache.getSchema.call(this, report, schemaName);
-      if (!schema) {
+      _schema = this.scache.getSchema(report, schemaName)!;
+      if (!_schema) {
         throw new Error("Schema with id '" + schemaName + "' wasn't found in the validator cache!");
       }
     } else {
-      schema = SchemaCache.getSchema.call(this, report, schema);
+      _schema = this.scache.getSchema(report, schema)!;
     }
 
     let compiled = false;
     if (!foundError) {
-      compiled = SchemaCompilation.compileSchema.call(this, report, schema);
+      compiled = this.sc.compileSchema(report, _schema);
     }
     if (!compiled) {
       this.lastReport = report;
@@ -281,7 +264,7 @@ export class ZSchema {
 
     let validated = false;
     if (!foundError) {
-      validated = SchemaValidation.validateSchema.call(this, report, schema);
+      validated = this.sv.validateSchema(report, _schema);
     }
     if (!validated) {
       this.lastReport = report;
@@ -289,15 +272,15 @@ export class ZSchema {
     }
 
     if (options.schemaPath) {
-      report.rootSchema = schema;
-      schema = get(schema, options.schemaPath);
-      if (!schema) {
+      report.rootSchema = _schema;
+      _schema = get(_schema, options.schemaPath);
+      if (!_schema) {
         throw new Error("Schema path '" + options.schemaPath + "' wasn't found in the schema!");
       }
     }
 
     if (!foundError) {
-      JsonValidation.validate.call(this, report, schema, json);
+      validateJson.call(this, report, _schema, json);
     }
 
     if (callback) {
@@ -317,13 +300,16 @@ export class ZSchema {
   /**
    * Returns an Error object for the most recent failed validation, or null if the validation was successful.
    */
-  getLastError(): SchemaError {
+  getLastError(): SchemaError | null {
+    if (!this.lastReport) {
+      throw new Error(`getLastError() called before doing any validation!`);
+    }
     if (this.lastReport.errors.length === 0) {
       return null;
     }
     const e: SchemaError = new Error();
     e.name = 'z-schema validation error';
-    e.message = this.lastReport.commonErrorMessage;
+    e.message = this.lastReport.commonErrorMessage!;
     e.details = this.lastReport.errors;
     return e;
   }
@@ -332,43 +318,45 @@ export class ZSchema {
    * Returns the error details for the most recent validation, or undefined if the validation was successful.
    * This is the same list as the SchemaError.details property.
    */
-  getLastErrors(): SchemaErrorDetail[] {
+  getLastErrors(): SchemaErrorDetail[] | null {
     return this.lastReport && this.lastReport.errors.length > 0 ? this.lastReport.errors : null;
   }
 
-  setRemoteReference(uri, schema, validationOptions) {
+  setRemoteReference(uri: string, schema: string | JsonSchema, validationOptions: ZSchemaOptions) {
+    let _schema: JsonSchemaInternal;
+
     if (typeof schema === 'string') {
-      schema = JSON.parse(schema);
+      _schema = JSON.parse(schema);
     } else {
-      schema = Utils.cloneDeep(schema);
+      _schema = deepClone(schema);
     }
 
     if (validationOptions) {
-      schema.__$validationOptions = normalizeOptions(validationOptions);
+      _schema.__$validationOptions = normalizeOptions(validationOptions);
     }
 
-    SchemaCache.cacheSchemaByUri.call(this, uri, schema);
+    this.scache.cacheSchemaByUri(uri, _schema);
   }
 
-  compileSchema(schema) {
+  compileSchema(schema: JsonSchema) {
     const report = new Report(this.options);
 
-    schema = SchemaCache.getSchema.call(this, report, schema);
+    schema = this.scache.getSchema(report, schema)!;
 
-    SchemaCompilation.compileSchema.call(this, report, schema);
+    this.sc.compileSchema(report, schema);
 
     this.lastReport = report;
     return report.isValid();
   }
 
-  getMissingReferences(arr?) {
-    arr = arr || this.lastReport.errors;
-    let res = [],
-      idx = arr.length;
+  getMissingReferences(arr?: SchemaErrorDetail[]) {
+    arr = arr || this.lastReport?.errors || [];
+    let res: string[] = [];
+    let idx = arr.length;
     while (idx--) {
       const error = arr[idx];
       if (error.code === 'UNRESOLVABLE_REFERENCE') {
-        const reference = error.params[0];
+        const reference = error.params[0] as string;
         if (res.indexOf(reference) === -1) {
           res.push(reference);
         }
@@ -385,7 +373,7 @@ export class ZSchema {
     const missingRemoteReferences = [];
     let idx = missingReferences.length;
     while (idx--) {
-      const remoteReference = SchemaCache.getRemotePath(missingReferences[idx]);
+      const remoteReference = getRemotePath(missingReferences[idx]);
       if (remoteReference && missingRemoteReferences.indexOf(remoteReference) === -1) {
         missingRemoteReferences.push(remoteReference);
       }
@@ -393,19 +381,22 @@ export class ZSchema {
     return missingRemoteReferences;
   }
 
-  getResolvedSchema(schema) {
+  getResolvedSchema(schema: JsonSchema): JsonSchema {
     const report = new Report(this.options);
-    schema = SchemaCache.getSchema.call(this, report, schema);
+    schema = this.scache.getSchema(report, schema)!;
 
     // clone before making any modifications
-    schema = Utils.cloneDeep(schema);
+    schema = deepClone(schema);
 
-    const visited = [];
+    const visited: JsonSchemaInternalCleanup[] = [];
 
     // clean-up the schema and resolve references
-    const cleanup = function (schema) {
+    interface JsonSchemaInternalCleanup extends JsonSchemaInternal {
+      ___$visited?: boolean;
+    }
+    const cleanup = function (schema: JsonSchemaInternalCleanup) {
       let key;
-      const typeOf = Utils.whatIs(schema);
+      const typeOf = whatIs(schema);
       if (typeOf !== 'object' && typeOf !== 'array') {
         return;
       }
@@ -424,16 +415,16 @@ export class ZSchema {
         delete schema.__$refResolved;
         for (key in from) {
           if (Object.prototype.hasOwnProperty.call(from, key)) {
-            to[key] = from[key];
+            (to as any)[key] = (from as any)[key];
           }
         }
       }
       for (key in schema) {
         if (Object.prototype.hasOwnProperty.call(schema, key)) {
           if (key.indexOf('__$') === 0) {
-            delete schema[key];
+            delete (schema as any)[key];
           } else {
-            cleanup(schema[key]);
+            cleanup((schema as any)[key]);
           }
         }
       }
@@ -454,7 +445,7 @@ export class ZSchema {
 
   static schemaReader: SchemaReader;
 
-  setSchemaReader(schemaReader) {
+  setSchemaReader(schemaReader: SchemaReader) {
     return ZSchema.setSchemaReader(schemaReader);
   }
 
@@ -462,11 +453,11 @@ export class ZSchema {
     return ZSchema.schemaReader;
   }
 
-  static setSchemaReader(schemaReader) {
+  static setSchemaReader(schemaReader: SchemaReader) {
     ZSchema.schemaReader = schemaReader;
   }
 
-  static schemaSymbol = Utils.schemaSymbol;
+  static schemaSymbol = schemaSymbol;
 
-  static jsonSymbol = Utils.jsonSymbol;
+  static jsonSymbol = jsonSymbol;
 }