z-schema 6.0.2 → 7.0.0-beta.2

package/index.d.ts

@@ -1,175 +0,0 @@
-// Type definitions for z-schema v3.16.0
-// Project: https://github.com/zaggino/z-schema
-// Definitions by: pgonzal <https://github.com/pgonzal>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-
-declare namespace Validator {
-    export interface Options {
-        asyncTimeout?: number;
-        forceAdditional?: boolean;
-        assumeAdditional?: boolean;
-        forceItems?: boolean;
-        forceMinItems?: boolean;
-        forceMaxItems?: boolean;
-        forceMinLength?: boolean;
-        forceMaxLength?: boolean;
-        forceProperties?: boolean;
-        ignoreUnresolvableReferences?: boolean;
-        noExtraKeywords?: boolean;
-        noTypeless?: boolean;
-        noEmptyStrings?: boolean;
-        noEmptyArrays?: boolean;
-        strictUris?: boolean;
-        strictMode?: boolean;
-        reportPathAsArray?: boolean;
-        breakOnFirstError?: boolean;
-        pedanticCheck?: boolean;
-        ignoreUnknownFormats?: boolean;
-        customValidator?: (report: Report, schema: any, json: any) => void;
-    }
-
-    export interface SchemaError extends Error {
-        /**
-         * Implements the Error.name contract.  The value is always "z-schema validation error".
-         */
-        name: string;
-
-        /**
-         * An identifier indicating the type of error.
-         * Example: "JSON_OBJECT_VALIDATION_FAILED"
-         */
-        message: string;
-
-        /**
-         * Returns details for each error that occurred during validation.
-         * See Options.breakOnFirstError.
-         */
-        details: SchemaErrorDetail[];
-    }
-
-    export interface SchemaErrorDetail {
-        /**
-         * Example: "Expected type string but found type array"
-         */
-        message: string;
-        /**
-         * An error identifier that can be used to format a custom error message.
-         * Example: "INVALID_TYPE"
-         */
-        code: string;
-        /**
-         * Format parameters that can be used to format a custom error message.
-         * Example: ["string","array"]
-         */
-        params: Array<string>;
-        /**
-         * A JSON path indicating the location of the error.
-         * Example: "#/projects/1"
-         */
-        path: string;
-        /**
-         * The schema rule description, which is included for certain errors where
-         * this information is useful (e.g. to describe a constraint).
-         */
-        description: string;
-
-        /**
-         * Returns details for sub-schemas that failed to match.  For example, if the schema
-         * uses the "oneOf" constraint to accept several alternative possibilities, each
-         * alternative will have its own inner detail object explaining why it failed to match.
-         */
-        inner: SchemaErrorDetail[];
-    }
-
-    export const schemaSymbol: unique symbol
-
-    export const jsonSymbol: unique symbol
-}
-
-declare class Validator {
-    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: any) => boolean): void;
-
-    /**
-     * Unregister a format.
-     *
-     * @param name - name of the custom format
-     */
-    public static unregisterFormat(name: string): void;
-
-    /**
-     * 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[];
-
-    public static getDefaultOptions(): Validator.Options;
-
-    constructor(options: Validator.Options);
-
-    /**
-     * @param schema - JSON object representing schema
-     * @returns {boolean} true if schema is valid.
-     */
-    validateSchema(schema: any): boolean;
-
-    /**
-     * @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: any, schema: any): boolean;
-
-    /**
-     * @param json - either a JSON string or a parsed JSON object
-     * @param schema - the JSON object representing the schema
-     */
-    validate(json: any, schema: any, callback: (err: any, valid: boolean) => void): void;
-
-    /**
-     * Returns an Error object for the most recent failed validation, or null if the validation was successful.
-     */
-    getLastError(): Validator.SchemaError;
-
-    /**
-     * 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(): Validator.SchemaErrorDetail[];
-}
-
-/**
- * Basic representation of the Report class -- just enough to support customValidator
- */
-declare class Report {
-    errors: Validator.SchemaErrorDetail[];
-
-    /**
-     * Returns whether the validation did pass
-     */
-    isValid(): boolean;
-
-    /**
-     * @param errorCode - a string representing the code for the custom error, e.g. INVALID_VALUE_SET
-     * @param errorMessage - string with the message to be returned in the error
-     * @param params - an array of relevant params for the error, e.g. [fieldName, fieldValue]
-     * @param subReports - sub-schema involved in the error
-     * @param schemaDescription - description from the schema used in the validation
-     * Adds custom error to the errors array in the validation instance and sets valid to false if it is not already set as false
-     */
-    addCustomError: (errorCode: string, errorMessage: string, params: string[], subReports: string, schemaDescription: string) => void;
-}
-
-export = Validator;

package/src/Errors.js

@@ -1,60 +0,0 @@
-"use strict";
-
-module.exports = {
-
-    INVALID_TYPE:                           "Expected type {0} but found type {1}",
-    INVALID_FORMAT:                         "Object didn't pass validation for format {0}: {1}",
-    ENUM_MISMATCH:                          "No enum match for: {0}",
-    ENUM_CASE_MISMATCH:                     "Enum does not match case for: {0}",
-    ANY_OF_MISSING:                         "Data does not match any schemas from 'anyOf'",
-    ONE_OF_MISSING:                         "Data does not match any schemas from 'oneOf'",
-    ONE_OF_MULTIPLE:                        "Data is valid against more than one schema from 'oneOf'",
-    NOT_PASSED:                             "Data matches schema from 'not'",
-
-    // Array errors
-    ARRAY_LENGTH_SHORT:                     "Array is too short ({0}), minimum {1}",
-    ARRAY_LENGTH_LONG:                      "Array is too long ({0}), maximum {1}",
-    ARRAY_UNIQUE:                           "Array items are not unique (indexes {0} and {1})",
-    ARRAY_ADDITIONAL_ITEMS:                 "Additional items not allowed",
-
-    // Numeric errors
-    MULTIPLE_OF:                            "Value {0} is not a multiple of {1}",
-    MINIMUM:                                "Value {0} is less than minimum {1}",
-    MINIMUM_EXCLUSIVE:                      "Value {0} is equal or less than exclusive minimum {1}",
-    MAXIMUM:                                "Value {0} is greater than maximum {1}",
-    MAXIMUM_EXCLUSIVE:                      "Value {0} is equal or greater than exclusive maximum {1}",
-
-    // Object errors
-    OBJECT_PROPERTIES_MINIMUM:              "Too few properties defined ({0}), minimum {1}",
-    OBJECT_PROPERTIES_MAXIMUM:              "Too many properties defined ({0}), maximum {1}",
-    OBJECT_MISSING_REQUIRED_PROPERTY:       "Missing required property: {0}",
-    OBJECT_ADDITIONAL_PROPERTIES:           "Additional properties not allowed: {0}",
-    OBJECT_DEPENDENCY_KEY:                  "Dependency failed - key must exist: {0} (due to key: {1})",
-
-    // String errors
-    MIN_LENGTH:                             "String is too short ({0} chars), minimum {1}",
-    MAX_LENGTH:                             "String is too long ({0} chars), maximum {1}",
-    PATTERN:                                "String does not match pattern {0}: {1}",
-
-    // Schema validation errors
-    KEYWORD_TYPE_EXPECTED:                  "Keyword '{0}' is expected to be of type '{1}'",
-    KEYWORD_UNDEFINED_STRICT:               "Keyword '{0}' must be defined in strict mode",
-    KEYWORD_UNEXPECTED:                     "Keyword '{0}' is not expected to appear in the schema",
-    KEYWORD_MUST_BE:                        "Keyword '{0}' must be {1}",
-    KEYWORD_DEPENDENCY:                     "Keyword '{0}' requires keyword '{1}'",
-    KEYWORD_PATTERN:                        "Keyword '{0}' is not a valid RegExp pattern: {1}",
-    KEYWORD_VALUE_TYPE:                     "Each element of keyword '{0}' array must be a '{1}'",
-    UNKNOWN_FORMAT:                         "There is no validation function for format '{0}'",
-    CUSTOM_MODE_FORCE_PROPERTIES:           "{0} must define at least one property if present",
-
-    // Remote errors
-    REF_UNRESOLVED:                         "Reference has not been resolved during compilation: {0}",
-    UNRESOLVABLE_REFERENCE:                 "Reference could not be resolved: {0}",
-    SCHEMA_NOT_REACHABLE:                   "Validator was not able to read schema with uri: {0}",
-    SCHEMA_TYPE_EXPECTED:                   "Schema is expected to be of type 'object'",
-    SCHEMA_NOT_AN_OBJECT:                   "Schema is not an object: {0}",
-    ASYNC_TIMEOUT:                          "{0} asynchronous task(s) have timed out after {1} ms",
-    PARENT_SCHEMA_VALIDATION_FAILED:        "Schema failed to validate against its parent schema, see inner errors for details.",
-    REMOTE_NOT_VALID:                       "Remote reference didn't compile successfully: {0}"
-
-};

package/src/FormatValidators.js

@@ -1,129 +0,0 @@
-/*jshint maxlen: false*/
-
-var validator = require("validator");
-
-var FormatValidators = {
-    "date": function (date) {
-        if (typeof date !== "string") {
-            return true;
-        }
-        // full-date from http://tools.ietf.org/html/rfc3339#section-5.6
-        var matches = /^([0-9]{4})-([0-9]{2})-([0-9]{2})$/.exec(date);
-        if (matches === null) {
-            return false;
-        }
-        // var year = matches[1];
-        // var month = matches[2];
-        // var day = matches[3];
-        if (matches[2] < "01" || matches[2] > "12" || matches[3] < "01" || matches[3] > "31") {
-            return false;
-        }
-        return true;
-    },
-    "date-time": function (dateTime) {
-        if (typeof dateTime !== "string") {
-            return true;
-        }
-        // date-time from http://tools.ietf.org/html/rfc3339#section-5.6
-        var s = dateTime.toLowerCase().split("t");
-        if (!FormatValidators.date(s[0])) {
-            return false;
-        }
-        var matches = /^([0-9]{2}):([0-9]{2}):([0-9]{2})(.[0-9]+)?(z|([+-][0-9]{2}:[0-9]{2}))$/.exec(s[1]);
-        if (matches === null) {
-            return false;
-        }
-        // var hour = matches[1];
-        // var minute = matches[2];
-        // var second = matches[3];
-        // var fraction = matches[4];
-        // var timezone = matches[5];
-        if (matches[1] > "23" || matches[2] > "59" || matches[3] > "59") {
-            return false;
-        }
-        return true;
-    },
-    "email": function (email) {
-        if (typeof email !== "string") {
-            return true;
-        }
-        return validator.isEmail(email, { "require_tld": true });
-    },
-    "hostname": function (hostname) {
-        if (typeof hostname !== "string") {
-            return true;
-        }
-        /*
-            http://json-schema.org/latest/json-schema-validation.html#anchor114
-            A string instance is valid against this attribute if it is a valid
-            representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034].
-
-            http://tools.ietf.org/html/rfc1034#section-3.5
-
-            <digit> ::= any one of the ten digits 0 through 9
-            var digit = /[0-9]/;
-
-            <letter> ::= any one of the 52 alphabetic characters A through Z in upper case and a through z in lower case
-            var letter = /[a-zA-Z]/;
-
-            <let-dig> ::= <letter> | <digit>
-            var letDig = /[0-9a-zA-Z]/;
-
-            <let-dig-hyp> ::= <let-dig> | "-"
-            var letDigHyp = /[-0-9a-zA-Z]/;
-
-            <ldh-str> ::= <let-dig-hyp> | <let-dig-hyp> <ldh-str>
-            var ldhStr = /[-0-9a-zA-Z]+/;
-
-            <label> ::= <letter> [ [ <ldh-str> ] <let-dig> ]
-            var label = /[a-zA-Z](([-0-9a-zA-Z]+)?[0-9a-zA-Z])?/;
-
-            <subdomain> ::= <label> | <subdomain> "." <label>
-            var subdomain = /^[a-zA-Z](([-0-9a-zA-Z]+)?[0-9a-zA-Z])?(\.[a-zA-Z](([-0-9a-zA-Z]+)?[0-9a-zA-Z])?)*$/;
-
-            <domain> ::= <subdomain> | " "
-            var domain = null;
-        */
-        var valid = /^[a-zA-Z](([-0-9a-zA-Z]+)?[0-9a-zA-Z])?(\.[a-zA-Z](([-0-9a-zA-Z]+)?[0-9a-zA-Z])?)*$/.test(hostname);
-        if (valid) {
-            // the sum of all label octets and label lengths is limited to 255.
-            if (hostname.length > 255) { return false; }
-            // Each node has a label, which is zero to 63 octets in length
-            var labels = hostname.split(".");
-            for (var i = 0; i < labels.length; i++) { if (labels[i].length > 63) { return false; } }
-        }
-        return valid;
-    },
-    "host-name": function (hostname) {
-        return FormatValidators.hostname.call(this, hostname);
-    },
-    "ipv4": function (ipv4) {
-        if (typeof ipv4 !== "string") { return true; }
-        return validator.isIP(ipv4, 4);
-    },
-    "ipv6": function (ipv6) {
-        if (typeof ipv6 !== "string") { return true; }
-        return validator.isIP(ipv6, 6);
-    },
-    "regex": function (str) {
-        try {
-            RegExp(str);
-            return true;
-        } catch (e) {
-            return false;
-        }
-    },
-    "uri": function (uri) {
-        if (this.options.strictUris) {
-            return FormatValidators["strict-uri"].apply(this, arguments);
-        }
-        // https://github.com/zaggino/z-schema/issues/18
-        // RegExp from http://tools.ietf.org/html/rfc3986#appendix-B
-        return typeof uri !== "string" || RegExp("^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?").test(uri);
-    },
-    "strict-uri": function (uri) {
-        return typeof uri !== "string" || validator.isURL(uri);
-    }
-};
-
-module.exports = FormatValidators;

package/src/Polyfills.js

@@ -1,16 +0,0 @@
-// Number.isFinite polyfill
-// http://people.mozilla.org/~jorendorff/es6-draft.html#sec-number.isfinite
-if (typeof Number.isFinite !== "function") {
-    Number.isFinite = function isFinite(value) {
-        // 1. If Type(number) is not Number, return false.
-        if (typeof value !== "number") {
-            return false;
-        }
-        // 2. If number is NaN, +∞, or −∞, return false.
-        if (value !== value || value === Infinity || value === -Infinity) {
-            return false;
-        }
-        // 3. Otherwise, return true.
-        return true;
-    };
-}

package/src/Report.js

@@ -1,299 +0,0 @@
-"use strict";
-
-var get    = require("lodash.get");
-var Errors = require("./Errors");
-var Utils  = require("./Utils");
-
-/**
- * @class
- *
- * @param {Report|object} parentOrOptions
- * @param {object} [reportOptions]
- */
-function Report(parentOrOptions, reportOptions) {
-    this.parentReport = parentOrOptions instanceof Report ?
-                            parentOrOptions :
-                            undefined;
-
-    this.options = parentOrOptions instanceof Report ?
-                       parentOrOptions.options :
-                       parentOrOptions || {};
-
-    this.reportOptions = reportOptions || {};
-
-    this.errors = [];
-    /**
-     * @type {string[]}
-     */
-    this.path = [];
-    this.asyncTasks = [];
-
-    this.rootSchema = undefined;
-    this.commonErrorMessage = undefined;
-    this.json = undefined;
-}
-
-/**
- * @returns {boolean}
- */
-Report.prototype.isValid = function () {
-    if (this.asyncTasks.length > 0) {
-        throw new Error("Async tasks pending, can't answer isValid");
-    }
-    return this.errors.length === 0;
-};
-
-/**
- *
- * @param {*} fn
- * @param {*} args
- * @param {*} asyncTaskResultProcessFn
- */
-Report.prototype.addAsyncTask = function (fn, args, asyncTaskResultProcessFn) {
-    this.asyncTasks.push([fn, args, asyncTaskResultProcessFn]);
-};
-
-Report.prototype.getAncestor = function (id) {
-    if (!this.parentReport) {
-        return undefined;
-    }
-    if (this.parentReport.getSchemaId() === id) {
-        return this.parentReport;
-    }
-    return this.parentReport.getAncestor(id);
-};
-
-/**
- *
- * @param {*} timeout
- * @param {function(*, *)} callback
- *
- * @returns {void}
- */
-Report.prototype.processAsyncTasks = function (timeout, callback) {
-
-    var validationTimeout = timeout || 2000,
-        tasksCount        = this.asyncTasks.length,
-        idx               = tasksCount,
-        timedOut          = false,
-        self              = this;
-
-    function finish() {
-        process.nextTick(function () {
-            var valid = self.errors.length === 0,
-                err = valid ? null : self.errors;
-            callback(err, valid);
-        });
-    }
-
-    function respond(asyncTaskResultProcessFn) {
-        return function (asyncTaskResult) {
-            if (timedOut) { return; }
-            asyncTaskResultProcessFn(asyncTaskResult);
-            if (--tasksCount === 0) {
-                finish();
-            }
-        };
-    }
-
-    // finish if tasks are completed or there are any errors and breaking on first error was requested
-    if (tasksCount === 0 || (this.errors.length > 0 && this.options.breakOnFirstError)) {
-        finish();
-        return;
-    }
-
-    while (idx--) {
-        var task = this.asyncTasks[idx];
-        task[0].apply(null, task[1].concat(respond(task[2])));
-    }
-
-    setTimeout(function () {
-        if (tasksCount > 0) {
-            timedOut = true;
-            self.addError("ASYNC_TIMEOUT", [tasksCount, validationTimeout]);
-            callback(self.errors, false);
-        }
-    }, validationTimeout);
-
-};
-
-/**
- *
- * @param {*} returnPathAsString
- *
- * @return {string[]|string}
- */
-Report.prototype.getPath = function (returnPathAsString) {
-    /**
-     * @type {string[]|string}
-     */
-    var path = [];
-    if (this.parentReport) {
-        path = path.concat(this.parentReport.path);
-    }
-    path = path.concat(this.path);
-
-    if (returnPathAsString !== true) {
-        // Sanitize the path segments (http://tools.ietf.org/html/rfc6901#section-4)
-        path = "#/" + path.map(function (segment) {
-            segment = segment.toString();
-
-            if (Utils.isAbsoluteUri(segment)) {
-                return "uri(" + segment + ")";
-            }
-
-            return segment.replace(/\~/g, "~0").replace(/\//g, "~1");
-        }).join("/");
-    }
-    return path;
-};
-
-Report.prototype.getSchemaId = function () {
-
-    if (!this.rootSchema) {
-        return null;
-    }
-
-    // get the error path as an array
-    var path = [];
-    if (this.parentReport) {
-        path = path.concat(this.parentReport.path);
-    }
-    path = path.concat(this.path);
-
-    // try to find id in the error path
-    while (path.length > 0) {
-        var obj = get(this.rootSchema, path);
-        if (obj && obj.id) { return obj.id; }
-        path.pop();
-    }
-
-    // return id of the root
-    return this.rootSchema.id;
-};
-
-/**
- *
- * @param {*} errorCode
- * @param {*} params
- *
- * @return {boolean}
- */
-Report.prototype.hasError = function (errorCode, params) {
-    var idx = this.errors.length;
-    while (idx--) {
-        if (this.errors[idx].code === errorCode) {
-            // assume match
-            var match = true;
-
-            // check the params too
-            var idx2 = this.errors[idx].params.length;
-            while (idx2--) {
-                if (this.errors[idx].params[idx2] !== params[idx2]) {
-                    match = false;
-                }
-            }
-
-            // if match, return true
-            if (match) { return match; }
-        }
-    }
-    return false;
-};
-
-/**
- *
- * @param {*} errorCode
- * @param {*} params
- * @param {Report[]|Report} [subReports]
- * @param {*} [schema]
- *
- * @return {void}
- */
-Report.prototype.addError = function (errorCode, params, subReports, schema) {
-    if (!errorCode) { throw new Error("No errorCode passed into addError()"); }
-
-    this.addCustomError(errorCode, Errors[errorCode], params, subReports, schema);
-};
-
-Report.prototype.getJson = function () {
-    var self = this;
-    while (self.json === undefined) {
-        self = self.parentReport;
-        if (self === undefined) {
-            return undefined;
-        }
-    }
-    return self.json;
-};
-
-/**
- *
- * @param {*} errorCode
- * @param {*} errorMessage
- * @param {*[]} params
- * @param {Report[]|Report} subReports
- * @param {*} schema
- *
- * @returns {void}
- */
-Report.prototype.addCustomError = function (errorCode, errorMessage, params, subReports, schema) {
-    if (this.errors.length >= this.reportOptions.maxErrors) {
-        return;
-    }
-
-    if (!errorMessage) { throw new Error("No errorMessage known for code " + errorCode); }
-
-    params = params || [];
-
-    var idx = params.length;
-    while (idx--) {
-        var whatIs = Utils.whatIs(params[idx]);
-        var param = (whatIs === "object" || whatIs === "null") ? JSON.stringify(params[idx]) : params[idx];
-        errorMessage = errorMessage.replace("{" + idx + "}", param);
-    }
-
-    var err = {
-        code: errorCode,
-        params: params,
-        message: errorMessage,
-        path: this.getPath(this.options.reportPathAsArray),
-        schemaId: this.getSchemaId()
-    };
-
-    err[Utils.schemaSymbol] = schema;
-    err[Utils.jsonSymbol] = this.getJson();
-
-    if (schema && typeof schema === "string") {
-        err.description = schema;
-    } else if (schema && typeof schema === "object") {
-        if (schema.title) {
-            err.title = schema.title;
-        }
-        if (schema.description) {
-            err.description = schema.description;
-        }
-    }
-
-    if (subReports != null) {
-        if (!Array.isArray(subReports)) {
-            subReports = [subReports];
-        }
-        err.inner = [];
-        idx = subReports.length;
-        while (idx--) {
-            var subReport = subReports[idx],
-                idx2 = subReport.errors.length;
-            while (idx2--) {
-                err.inner.push(subReport.errors[idx2]);
-            }
-        }
-        if (err.inner.length === 0) {
-            err.inner = undefined;
-        }
-    }
-
-    this.errors.push(err);
-};
-
-module.exports = Report;