@tremho/mist-lift 2.2.9 → 2.4.0

package/build/lib/TypeCheck.js

@@ -0,0 +1,1204 @@
+"use strict";
+/*
+Module for Constraint definitions and TypeCheck support
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validate = exports.parseConstraints = exports.parseConstraintsToMap = exports.stringFromValueType = exports.valueTypeFromString = exports.ElementCheckType = exports.TypeConstraint = exports.ValueType = void 0;
+/**
+ * Enumeration of basic types
+ *
+ * - see [stringFromValueType](#module_TypeCheck..stringFromValueType)
+ * - see [valueTypeFromString](#module_TypeCheck..valueTypeFromString)
+ */
+var ValueType;
+(function (ValueType) {
+    ValueType[ValueType["none"] = 0] = "none";
+    ValueType[ValueType["number"] = 1] = "number";
+    ValueType[ValueType["string"] = 2] = "string";
+    ValueType[ValueType["boolean"] = 3] = "boolean";
+    ValueType[ValueType["object"] = 4] = "object";
+    ValueType[ValueType["array"] = 5] = "array";
+    ValueType[ValueType["regex"] = 6] = "regex";
+})(ValueType || (exports.ValueType = ValueType = {}));
+/**
+ * Base for all Constraint errors.
+ * Defines the identifying class archetype and consistent error message prefix
+ */
+class ConstraintError extends Error {
+    constructor() {
+        super();
+        this.message = 'Constraint Error: ';
+    }
+}
+/**
+ * An error message for when a value fails validation.
+ */
+class ConstraintFail extends ConstraintError {
+    constructor(failType, value) {
+        super();
+        this.message += `Failed ${failType}: ${value}`;
+    }
+}
+/**
+ * An error for when the basic type is wrong
+ */
+class ConstraintBasicTypeError extends ConstraintError {
+    constructor(value, expType) {
+        super();
+        this.message += `Incorrect type ${typeof value}, (${expType} expected) ${value}`;
+    }
+}
+/**
+ * An error for when we expected null or undefined
+ */
+// class NullConstraintError extends ConstraintError {
+//     constructor() {
+//         super();
+//         this.message += 'Expected NULL or undefined'
+//     }
+// }
+/**
+ * An error for when a min/max range has been violated, including what type of range.
+ */
+class RangeConstraintError extends ConstraintError {
+    constructor(value, comp, rangeType = 'Number') {
+        super();
+        // we don't need to test both range ends, because we know we are here because of an error one way
+        // or the other.
+        if (value < comp) {
+            this.message += `${rangeType} ${value} is less than range minimum of ${comp}`;
+        }
+        else {
+            this.message += `${rangeType} ${value} exceeds range maximum of ${comp}`;
+        }
+    }
+}
+/**
+ * An error for when an integer was expected
+ */
+class IntegerConstraintError extends ConstraintError {
+    constructor(value) {
+        super();
+        if (value === undefined) {
+            this.message += 'Integer expected';
+        }
+        else {
+            this.message += `Value ${value} is not an integer`;
+        }
+    }
+}
+/**
+ * An error for when a positive value was expected
+ */
+class PositiveConstraintError extends ConstraintError {
+    constructor(value) {
+        super();
+        if (value === undefined) {
+            this.message += 'Positive value expected';
+        }
+        else {
+            this.message += `Value ${value} is not positive`;
+        }
+    }
+}
+/**
+ * An error for when a negative value was expected
+ */
+class NegativeConstraintError extends ConstraintError {
+    constructor(value) {
+        super();
+        if (value === undefined) {
+            this.message += 'Positive value expected';
+        }
+        else {
+            this.message += `Value ${value} is not negative`;
+        }
+    }
+}
+/**
+ * An error for when zero was not expected.
+ */
+class ZeroValueConstraintError extends ConstraintError {
+    constructor() {
+        super();
+        this.message += 'Zero is not an allowable value';
+    }
+}
+/**
+ * An error for declaring both ! and not ! variants of the same expression
+ */
+class ConstraintConflictError extends ConstraintError {
+    constructor(conflictType) {
+        super();
+        this.message += `Both ${conflictType} and !${conflictType} declared`;
+    }
+}
+/**
+ * Base form of TypeConstraint.
+ * Defines the base type and the test method.
+ */
+class TypeConstraint {
+    constructor(typeString = '') {
+        this.type = typeString.trim().toLowerCase();
+    }
+    /**
+       * Perform a runtime test of the value
+  
+       * returns without throw if test was okay, otherwise throws a ConstraintError explaining the violation.
+       *
+       * @param value - value to test against this constraint
+       *
+       * @throws {ConstraintError} Error is thrown if test fails its constraints
+       */
+    test(value) {
+        if (typeof value !== this.type) {
+            throw new ConstraintBasicTypeError(value, this.type);
+        }
+    }
+    // Describes the constraint in printable terms (not really used, a bit redundant to describe)
+    toString() {
+        if (this.badName)
+            return `"${this.badName}" is not a recognized constraint for ${this.type}`;
+        if (this.note)
+            return this.note;
+        return '- No Constraint';
+    }
+    // describe the constraints in human terms.
+    describe() {
+        if (this.badName)
+            return `"${this.badName}" is not a recognized constraint for ${this.type}`;
+        if (this.note)
+            return this.note;
+        return 'No Constraint';
+    }
+}
+exports.TypeConstraint = TypeConstraint;
+// /**
+//  * Enumeration of recognized status for a parameter or return constraint
+//  */
+// enum ConstraintStatus {
+//     None = "",       // not parsed
+//     NotConstraint = "NotConstraint", // doesn't start with '-', treat as description
+//     Error = "Error",     // parsing error
+//     NotProvided = "NotProvided", // no constraint block
+//
+//
+// }
+/**
+ *  Null only applies to objects.
+ */
+// class NullConstraint extends TypeConstraint {
+//     test(value) {
+//         if(value || typeof value !== 'object') {
+//             throw new NullConstraintError()
+//         }
+//     }
+// }
+/**
+ * Constraints recorded on a number
+ * Integer, Positive, Negative, NotZero, min, max
+ */
+class NumberConstraint extends TypeConstraint {
+    constructor() {
+        super('number');
+        this.isInteger = false; // number must be an integer
+        this.isPositive = false; // number must be positive
+        this.isNegative = false; // number must be negative
+        this.notZero = false; // number must not be zero
+    }
+    test(value) {
+        super.test(value);
+        if (this.isInteger) {
+            if (Math.floor(value) !== value) {
+                throw new IntegerConstraintError(value);
+            }
+        }
+        if (this.notZero) {
+            if (value === 0) {
+                throw new ZeroValueConstraintError();
+            }
+        }
+        if (this.isPositive && this.isNegative) {
+            throw new ConstraintConflictError('positive');
+        }
+        if (this.isPositive) {
+            if (value < 0) {
+                throw new PositiveConstraintError(value);
+            }
+        }
+        if (this.isNegative) {
+            if (value < 0) {
+                throw new NegativeConstraintError(value);
+            }
+        }
+        if (this.min !== undefined) {
+            if (value < this.min) {
+                throw new RangeConstraintError(value, this.min);
+            }
+        }
+        if (this.max !== undefined) {
+            if (value > this.max) {
+                throw new RangeConstraintError(value, this.max);
+            }
+        }
+        if (this.maxx !== undefined) {
+            if (value >= this.maxx) {
+                throw new RangeConstraintError(value, this.maxx);
+            }
+        }
+    }
+    toString() {
+        const keys = [];
+        if (this.isInteger)
+            keys.push('Integer');
+        if (this.notZero)
+            keys.push('Not Zero');
+        if (this.isPositive)
+            keys.push('Positive');
+        if (this.isNegative)
+            keys.push('Negative');
+        if (this.min !== undefined)
+            keys.push(`Min = ${this.min}`);
+        if (this.max !== undefined)
+            keys.push(`Max = ${this.max}`);
+        if (this.maxx !== undefined)
+            keys.push(`Maxx = ${this.maxx}`);
+        if (this.note)
+            keys.push(this.note);
+        return (keys.length > 0) ? '- ' + keys.join(',') : super.toString();
+    }
+    describe() {
+        const keys = [];
+        if (this.isInteger)
+            keys.push('number must be an integer');
+        if (this.notZero)
+            keys.push('number must not be zero');
+        if (this.isPositive)
+            keys.push('number must be positive');
+        if (this.isNegative)
+            keys.push('number must be negative');
+        if (this.min !== undefined)
+            keys.push(`Minimum value is ${this.min}`);
+        if (this.max !== undefined)
+            keys.push(`Maximum value is ${this.max}`);
+        if (this.maxx !== undefined)
+            keys.push(`Maximum value is less than ${this.maxx}`);
+        if (this.note || this.badName)
+            keys.push(super.describe());
+        return (keys.length > 0) ? keys.join('\n') : super.describe();
+    }
+}
+/**
+ * Constraints recorded on a string
+ * minLength, maxLength, (!)startsWith, (!)endsWith, (!)contains, (!)match
+ */
+class StringConstraint extends TypeConstraint {
+    constructor() {
+        super('string');
+    }
+    test(value) {
+        super.test(value);
+        if (this.minLength) {
+            if (value.length < this.minLength) {
+                throw new RangeConstraintError(value.length, this.minLength, 'String Length');
+            }
+        }
+        if (this.maxLength) {
+            if (value.length > this.maxLength) {
+                throw new RangeConstraintError(value.length, this.maxLength, 'String Length');
+            }
+        }
+        if (this.startsWith && this.notStartsWith) {
+            throw new ConstraintConflictError('startsWith');
+        }
+        if (this.startsWith || this.notStartsWith) {
+            const comp = this.startsWith || this.notStartsWith || '';
+            const not = !!this.notStartsWith;
+            if (value.substring(0, comp.length) === comp) {
+                if (not)
+                    throw new ConstraintFail('!startsWith', value);
+            }
+            else {
+                if (!not)
+                    throw new ConstraintFail('startsWith', value);
+            }
+        }
+        if (this.endsWith && this.notEndsWith) {
+            throw new ConstraintConflictError('endsWith');
+        }
+        if (this.endsWith || this.notEndsWith) {
+            const comp = this.endsWith || this.notEndsWith || '';
+            const not = !!this.notEndsWith;
+            if (value.substring(value.length - comp.length) === comp) {
+                if (not)
+                    throw new ConstraintFail('!endsWith', value);
+            }
+            else {
+                if (!not)
+                    throw new ConstraintFail('endsWith', value);
+            }
+        }
+        if (this.contains && this.notContains) {
+            throw new ConstraintConflictError('contains');
+        }
+        if (this.contains || this.notContains) {
+            const comp = this.contains || this.notContains;
+            const not = !!this.notContains;
+            if (value.indexOf(comp) !== -1) {
+                if (not)
+                    throw new ConstraintFail('!contains', value);
+            }
+            else {
+                if (!not)
+                    throw new ConstraintFail('contains', value);
+            }
+        }
+        if (this.match && this.notMatch) {
+            throw new ConstraintConflictError('match');
+        }
+        if (this.match || this.notMatch) {
+            const comp = this.match || this.notMatch;
+            const not = !!this.notMatch;
+            const re = new RegExp(comp || '');
+            if (re.test(value)) {
+                if (not)
+                    throw new ConstraintFail('!match', value);
+            }
+            else {
+                if (!not)
+                    throw new ConstraintFail('match', value);
+            }
+        }
+    }
+    toString() {
+        const keys = [];
+        if (this.minLength)
+            keys.push(`Min Length = ${this.minLength}`);
+        if (this.maxLength)
+            keys.push(`Max Length = ${this.maxLength}`);
+        if (this.startsWith)
+            keys.push(`Starts With = ${this.startsWith}`);
+        if (this.notStartsWith)
+            keys.push(`!StartsWith = ${this.startsWith}`);
+        if (this.endsWith)
+            keys.push(`Ends With = ${this.endsWith}`);
+        if (this.notEndsWith)
+            keys.push(`!EndsWith = ${this.endsWith}`);
+        if (this.contains)
+            keys.push(`Contains = ${this.contains}`);
+        if (this.notContains)
+            keys.push(`!Contains = ${this.notContains}`);
+        if (this.match)
+            keys.push(`Match = ${this.match}`);
+        if (this.notMatch)
+            keys.push(`!Match = ${this.notMatch}`);
+        if (this.note)
+            keys.push(this.note);
+        return (keys.length > 0) ? '- ' + keys.join(',') : super.toString();
+    }
+    describe() {
+        const keys = [];
+        if (this.minLength)
+            keys.push(`string must be at least ${this.minLength} characters long`);
+        if (this.maxLength)
+            keys.push(`string must consist of less than ${this.maxLength} characters`);
+        if (this.startsWith)
+            keys.push(`string must start with "${this.startsWith}"`);
+        if (this.notStartsWith)
+            keys.push(`string must NOT start with "${this.startsWith}"`);
+        if (this.endsWith)
+            keys.push(`string must end with "${this.endsWith}"`);
+        if (this.notEndsWith)
+            keys.push(`string must NOT end with "${this.endsWith}"`);
+        if (this.contains)
+            keys.push(`must contain substring "${this.contains}"`);
+        if (this.notContains)
+            keys.push(`must NOT contain substring "${this.notContains}"`);
+        if (this.match)
+            keys.push(`must match Regular Expression "${this.match}"`);
+        if (this.notMatch)
+            keys.push(`must NOT match RegExp "${this.notMatch}"`);
+        if (this.note || this.badName)
+            keys.push(super.describe());
+        return (keys.length > 0) ? keys.join('\n') : super.describe();
+    }
+}
+/**
+ * Constraints recorded on an object
+ * (!)empty, (!)hasProperties, notNested, noPrototype, canSerialize, noUndefinedProps
+ */
+class ObjectConstraint extends TypeConstraint {
+    constructor() {
+        super('object');
+    }
+    test(value) {
+        super.test(value);
+        if (this.empty && this.notEmpty) {
+            throw new ConstraintConflictError('empty');
+        }
+        if ((this.hasProperties != null) && (this.notHasProperties != null)) {
+            const collisions = [];
+            for (const has of this.hasProperties) {
+                if (this.notHasProperties.includes(has)) {
+                    collisions.push(has);
+                }
+            }
+            if (collisions.length > 0) {
+                throw new ConstraintConflictError('hasProperties "' + collisions.join(',') + '"');
+            }
+        }
+        if (this.empty) {
+            if (Object.getOwnPropertyNames(value).length > 0) {
+                throw new ConstraintFail('empty', 'object contains ' + Object.getOwnPropertyNames(value).length + ' props');
+            }
+        }
+        if (this.notEmpty) {
+            if (Object.getOwnPropertyNames(value).length === 0) {
+                throw new ConstraintFail('!empty', value);
+            }
+        }
+        if (this.hasProperties != null) {
+            for (const has of this.hasProperties) {
+                if (!value.hasOwnProperty(has)) {
+                    throw new ConstraintFail('hasProperties', has);
+                }
+            }
+        }
+        if (this.notHasProperties != null) {
+            for (const hasnot of this.notHasProperties) {
+                if (value.hasOwnProperty(hasnot)) {
+                    throw new ConstraintFail('!hasProperties', hasnot);
+                }
+            }
+        }
+        if (this.notNested) {
+            for (const p of Object.getOwnPropertyNames(value)) {
+                const v = value[p];
+                if (typeof v === 'object') {
+                    if (!Array.isArray(v)) {
+                        throw new ConstraintFail('notNested', p);
+                    }
+                }
+            }
+        }
+        if (this.noPrototype) {
+            const prot = Object.getPrototypeOf(value);
+            const name = prot && prot.constructor.name;
+            if (name && name !== 'Object') {
+                throw new ConstraintFail('noPrototype', value);
+            }
+        }
+        if (this.canSerialize) {
+            let json;
+            try {
+                json = JSON.stringify(value);
+            }
+            catch (e) {
+            }
+            if (!json) {
+                throw new ConstraintFail('canSerialize', value);
+            }
+        }
+        if (this.noFalseyProps) {
+            for (const p of Object.getOwnPropertyNames(value)) {
+                const v = value[p];
+                if (!v) {
+                    throw new ConstraintFail('noFalseyProps', p);
+                }
+            }
+        }
+        if (this.noTruthyProps) {
+            for (const p of Object.getOwnPropertyNames(value)) {
+                const v = value[p];
+                if (v) {
+                    throw new ConstraintFail('noTruthyProps', p);
+                }
+            }
+        }
+        if (this.instanceOf) {
+            if (value.constructor.name !== this.instanceOf) {
+                throw new ConstraintFail('instanceOf (' + this.instanceOf + ')', value.constructor.name);
+            }
+        }
+        if (this.notInstanceOf) {
+            if (value.constructor.name === this.notInstanceOf) {
+                throw new ConstraintFail('!instanceOf', this.notInstanceOf);
+            }
+        }
+    }
+    toString() {
+        const keys = [];
+        if (this.empty)
+            keys.push('Empty');
+        if (this.notEmpty)
+            keys.push('!Empty');
+        if (this.hasProperties != null)
+            keys.push(`Has Properties =${this.hasProperties.join(',')}`);
+        if (this.notHasProperties != null)
+            keys.push(`!Has Properties =${this.notHasProperties}`);
+        if (this.notNested)
+            keys.push('Not Nested');
+        if (this.noPrototype)
+            keys.push('No Prototype');
+        if (this.canSerialize)
+            keys.push('Can Serialize');
+        if (this.noFalseyProps)
+            keys.push('No Falsey Props');
+        if (this.noTruthyProps)
+            keys.push('No Truthy Props');
+        if (this.instanceOf)
+            keys.push(`Instance Of = ${this.instanceOf}`);
+        if (this.notInstanceOf)
+            keys.push(`Not an instance of ${this.notInstanceOf}`);
+        if (this.note)
+            keys.push(this.note);
+        return (keys.length > 0) ? '- ' + keys.join(',') : super.toString();
+    }
+    describe() {
+        const keys = [];
+        if (this.empty)
+            keys.push('object must be empty');
+        if (this.notEmpty)
+            keys.push('object must not be empty');
+        if (this.hasProperties != null)
+            keys.push(`object must contain properties "${this.hasProperties.join(',')}"`);
+        if (this.notHasProperties != null)
+            keys.push(`object must not contain properties "${this.notHasProperties.join(',')}"`);
+        if (this.notNested)
+            keys.push('object must not contain nested objects');
+        if (this.noPrototype)
+            keys.push('object must not derive from a prototype');
+        if (this.canSerialize)
+            keys.push('object can be serialized');
+        if (this.noFalseyProps)
+            keys.push('object can contain no properties that evaluate as false');
+        if (this.noTruthyProps)
+            keys.push('object can contain no properties that evaluate as true');
+        if (this.instanceOf)
+            keys.push(`object must be an instance of "${this.instanceOf}"`);
+        if (this.notInstanceOf)
+            keys.push(`object must not be an instance of "${this.notInstanceOf}"`);
+        if (this.note || this.badName)
+            keys.push(super.describe());
+        return (keys.length > 0) ? keys.join('\n') : super.describe();
+    }
+}
+/**
+ * Enumeration of checkType parsed results.
+ *
+ * parameters (p1, p2) are parsed at same time, and meaning does vary per checkType.
+ */
+var ElementCheckType;
+(function (ElementCheckType) {
+    ElementCheckType[ElementCheckType["none"] = 0] = "none";
+    ElementCheckType[ElementCheckType["all"] = 1] = "all";
+    ElementCheckType[ElementCheckType["random"] = 2] = "random";
+    ElementCheckType[ElementCheckType["step"] = 3] = "step";
+    ElementCheckType[ElementCheckType["first"] = 4] = "first";
+    ElementCheckType[ElementCheckType["last"] = 5] = "last";
+    ElementCheckType[ElementCheckType["firstThenLast"] = 6] = "firstThenLast";
+    ElementCheckType[ElementCheckType["firstThenStep"] = 7] = "firstThenStep";
+    ElementCheckType[ElementCheckType["firstThenRandom"] = 8] = "firstThenRandom"; // test all up to (p1) elements, then up to (p2) of the remaining, chosen at random
+})(ElementCheckType || (exports.ElementCheckType = ElementCheckType = {}));
+/**
+ * Constraints recorded on an array
+ * minLength, maxLength, (!)contains, checkType, each
+ */
+class ArrayConstraint extends TypeConstraint {
+    constructor() {
+        super('array');
+        this.elementConstraints = []; // elements are tested for compliance under these rules
+        this.elementCheckType = ElementCheckType.none; // defines the extent of runtime coverage on elements
+        this.elementCheckParameter = 0; // defined by elementCheckType
+        this.elementCheckParameter2 = 0; // defined by elementCheckType
+    }
+    test(value) {
+        if (!Array.isArray(value)) {
+            throw new ConstraintBasicTypeError(value, 'array');
+        }
+        const length = value.length;
+        if (this.minLength) {
+            if (length < this.minLength) {
+                throw new RangeConstraintError(length, this.minLength, 'Array Length');
+            }
+        }
+        if (this.maxLength) {
+            if (length > this.maxLength) {
+                throw new RangeConstraintError(length, this.maxLength, 'Array Length');
+            }
+        }
+        if (this.contains && this.notContains) {
+            throw new ConstraintConflictError('contains');
+        }
+        if (this.contains || this.notContains) {
+            const comp = this.contains || this.notContains;
+            const not = !!this.notContains;
+            if (value.includes(comp)) {
+                if (not)
+                    throw new ConstraintFail('!contains', this.notContains);
+            }
+            else {
+                if (!not)
+                    throw new ConstraintFail('contains', this.contains);
+            }
+        }
+        if (this.elementConstraints || this.elementCheckType) {
+            const checkType = this.elementCheckType === undefined ? ElementCheckType.all : this.elementCheckType;
+            let i = 0;
+            let count = 0;
+            let step = 1;
+            let firstCount = 0;
+            let thenCount = 0;
+            let counting = false;
+            const tested = {};
+            switch (checkType) {
+                case ElementCheckType.none:
+                    firstCount = 0;
+                    thenCount = 0;
+                    counting = false;
+                    break;
+                case ElementCheckType.all:
+                    firstCount = length;
+                    step = 1;
+                    thenCount = 0;
+                    counting = true;
+                    break;
+                case ElementCheckType.first:
+                    firstCount = parseInt('' + this.elementCheckParameter);
+                    step = 1;
+                    thenCount = 0;
+                    counting = true;
+                    break;
+                case ElementCheckType.last:
+                    firstCount = 0;
+                    step = 1;
+                    thenCount = length - this.elementCheckParameter;
+                    counting = false;
+                    break;
+                case ElementCheckType.firstThenLast:
+                    firstCount = parseInt('' + this.elementCheckParameter);
+                    thenCount = length - this.elementCheckParameter;
+                    if (thenCount < 0)
+                        thenCount = length;
+                    step = 1;
+                    counting = true;
+                    break;
+                case ElementCheckType.step:
+                    firstCount = length;
+                    thenCount = 0;
+                    counting = true;
+                    step = parseInt('' + this.elementCheckParameter);
+                    break;
+                case ElementCheckType.random:
+                    firstCount = 0;
+                    thenCount = parseInt('' + this.elementCheckParameter);
+                    step = 0;
+                    counting = true;
+                    break;
+                case ElementCheckType.firstThenStep:
+                    firstCount = parseInt('' + this.elementCheckParameter);
+                    thenCount = length - firstCount;
+                    step = parseInt('' + this.elementCheckParameter2);
+                    counting = true;
+                    break;
+                case ElementCheckType.firstThenRandom:
+                    firstCount = parseInt('' + this.elementCheckParameter);
+                    thenCount = parseInt('' + this.elementCheckParameter2);
+                    step = 0;
+                    counting = true;
+                    break;
+            }
+            while (i < length) {
+                if (counting) {
+                    const ev = value[i];
+                    let t = typeof ev;
+                    if (Array.isArray(ev))
+                        t = 'array';
+                    const m = this.elementConstraints;
+                    const c = m && m.get(t);
+                    const tc = (c != null) || parseConstraints(t, '');
+                    if (tc !== true && (tc === null || tc === void 0 ? void 0 : tc.test) != undefined)
+                        tc.test(ev);
+                    count++;
+                }
+                if ((checkType === ElementCheckType.last || checkType === ElementCheckType.firstThenLast) && i === thenCount) {
+                    counting = true;
+                }
+                if (checkType === ElementCheckType.firstThenLast && i === firstCount) {
+                    counting = false;
+                }
+                if (count >= firstCount) {
+                    if (count >= firstCount + thenCount) {
+                        break;
+                    }
+                }
+                if (step) {
+                    i += step;
+                }
+                else {
+                    while (true) {
+                        const rr = Math.floor(Math.random() * (length - count));
+                        i = count + rr;
+                        if (i < length && !tested[i]) {
+                            tested[i] = true;
+                            break;
+                        }
+                    }
+                }
+            }
+        }
+    }
+    toString() {
+        const keys = [];
+        if (this.minLength)
+            keys.push(`Min Length = ${this.minLength}`);
+        if (this.maxLength)
+            keys.push(`Max Length = ${this.maxLength}`);
+        if (this.contains)
+            keys.push(`Contains = ${this.contains}`);
+        if (this.notContains)
+            keys.push(`!Contains = ${this.notContains}`);
+        if (this.elementConstraints)
+            keys.push(`each element of the array has the following constraints by type ${listEachConstraints(this.elementConstraints)}`);
+        if (this.elementCheckType)
+            keys.push(`(elements will be tested using the ${checkTypeToString(this.elementCheckType, this.elementCheckParameter, this.elementCheckParameter2)} method)`);
+        if (this.note)
+            keys.push(this.note);
+        return (keys.length > 0) ? '- ' + keys.join(',') : super.toString();
+    }
+    describe() {
+        const keys = [];
+        if (this.minLength)
+            keys.push(`array must contain at least ${this.minLength} elements`);
+        if (this.maxLength)
+            keys.push(`array must contain no more than ${this.maxLength} elements`);
+        if (this.contains)
+            keys.push(`array must contain element value "${this.contains}"`);
+        if (this.notContains)
+            keys.push(`array must not contain an element value "${this.notContains}"`);
+        if (this.elementConstraints)
+            keys.push(`each element of the array has the following constraints by type ${listEachConstraints(this.elementConstraints)}`);
+        if (this.elementCheckType)
+            keys.push(`(elements will be tested using the ${checkTypeToString(this.elementCheckType, this.elementCheckParameter, this.elementCheckParameter2)} method)`);
+        if (this.note || this.badName)
+            keys.push(super.describe());
+        return (keys.length > 0) ? keys.join('\n') : super.describe();
+    }
+}
+function listEachConstraints(cmap) {
+    let out = '';
+    const types = cmap.keys();
+    const entries = cmap.entries();
+    let entry;
+    while ((entry = entries.next().value)) {
+        out += '<br/><b>' + entry[0] + ' elements:</b><br/>&nbsp;&nbsp; -';
+        out += entry[1].describe().replace(/\n/g, '<br/>&nbsp;&nbsp; - ');
+    }
+    return out;
+}
+/**
+ * Translates a type string (number, string, boolean, object, array, regex) into the corresponding ValueType enum
+ * Note that strings beside none, array, and regex are synonymous with the `typeof` operator value
+ * @param str
+ */
+function valueTypeFromString(str) {
+    switch (str.trim().toLowerCase()) {
+        default: return str.trim().length ? str.includes('[]') ? ValueType.array : ValueType.object : ValueType.none;
+        case 'number': return ValueType.number;
+        case 'string': return ValueType.string;
+        case 'boolean': return ValueType.boolean;
+        case 'object': return ValueType.object;
+        case 'array': return ValueType.array;
+        case 'regex': return ValueType.regex;
+        case 'regexp': return ValueType.regex;
+    }
+}
+exports.valueTypeFromString = valueTypeFromString;
+/**
+ * Translates a ValueType enum value into the corresponding string.
+ * Note that strings beside none, array, and regex are synonymous with the `typeof` operator value
+ * @param vt
+ */
+function stringFromValueType(vt) {
+    switch (vt) {
+        case ValueType.none: return '';
+        case ValueType.number: return 'number';
+        case ValueType.string: return 'string';
+        case ValueType.boolean: return 'boolean';
+        case ValueType.object: return 'object';
+        case ValueType.array: return 'array';
+        case ValueType.regex: return 'regex';
+    }
+}
+exports.stringFromValueType = stringFromValueType;
+/**
+ * Read either a value or a list from an expression value
+ * @param str
+ */
+function constraintListParse(str = '') {
+    str.trim();
+    if (str.charAt(0) === '"' || str.charAt(0) === "'") {
+        str = str.substring(1, str.length - 1);
+    }
+    if (str.includes(',')) {
+        return str.split(','); // return the split array
+    }
+    if (isFinite(Number(str))) {
+        return Number(str);
+    }
+    return str; // return the unquoted string value
+}
+/**
+ * Used to parse the type+constraints blocks from an "each" directive list
+ * @param str
+ */
+function eachListParse(str = '') {
+    const map = new Map();
+    const esplit = str.split('|');
+    for (const tblock of esplit) {
+        const ci = tblock.indexOf(',');
+        if (ci !== -1) {
+            const type = tblock.substring(0, ci).trim();
+            const cdef = tblock.substring(ci + 1);
+            const constraint = (parseConstraints(type, cdef) != null) || new TypeConstraint();
+            if (constraint !== undefined && constraint !== true) {
+                map.set(type, constraint);
+            }
+        }
+    }
+    return map;
+}
+/**
+ * Parse out the checkType and return the resulting type name and the parsed parameters in a structure.
+ * @param ctStr
+ * @return {{string}name,{number}[p1],{number}[p2]}
+ */
+function parseCheckType(ctStr = '') {
+    let opi = ctStr.indexOf('(');
+    if (opi === -1)
+        opi = ctStr.length;
+    const name = ctStr.substring(0, opi);
+    let cpi = ctStr.indexOf(')', opi);
+    if (cpi === -1)
+        cpi = ctStr.length;
+    const p = ctStr.substring(opi + 1, cpi).split(',');
+    let p1, p2;
+    try {
+        p1 = p[0] && parseInt(p[0]);
+        p2 = p[1] && parseInt(p[1]);
+    }
+    catch (e) { }
+    return { name, p1, p2 };
+}
+function checkTypeToString(ct, p1, p2) {
+    switch (ct) {
+        case ElementCheckType.random:
+            return `random(${p1})`;
+        case ElementCheckType.step:
+            return `step(${p1})`;
+        case ElementCheckType.first:
+            return `first(${p1})`;
+        case ElementCheckType.last:
+            return `last(${p1})`;
+        case ElementCheckType.firstThenLast:
+            return `firstThenLast(${p1},${p2})`;
+        case ElementCheckType.firstThenStep:
+            return `firstThenStep(${p1},${p2})`;
+        case ElementCheckType.firstThenRandom:
+            return `firstThenRandom(${p1},${p2})`;
+        case ElementCheckType.none:
+            return 'none';
+        default:
+        case ElementCheckType.all:
+            return 'all';
+    }
+}
+function checkTypeFromString(ctstr) {
+    switch (ctstr.trim().toLowerCase()) {
+        case 'random': return ElementCheckType.random;
+        case 'step': return ElementCheckType.step;
+        case 'first': return ElementCheckType.first;
+        case 'last': return ElementCheckType.last;
+        case 'firstthenlast': return ElementCheckType.firstThenLast;
+        case 'firstthenstep': return ElementCheckType.firstThenStep;
+        case 'firstthenrandom': return ElementCheckType.firstThenRandom;
+        case 'none': return ElementCheckType.none;
+        default:
+        case 'all': return ElementCheckType.all;
+    }
+}
+// parse constraints from what may be more than one type (e.g. string|number)
+function parseConstraintsToMap(typeString, blockSet = '') {
+    const map = new Map();
+    const types = typeString.split('|');
+    const blocks = blockSet.split(',');
+    for (let type of types) {
+        type = (type || '').trim();
+        const constraint = (parseConstraints(type, blockSet) != null) || new TypeConstraint();
+        if (constraint !== undefined && constraint !== true) {
+            map.set(type, constraint);
+        }
+    }
+    return map;
+}
+exports.parseConstraintsToMap = parseConstraintsToMap;
+/**
+ * Given a block of text, parse as constraints and return the set if this is a constraint declaration
+ * otherwise, return ConstraintStatus.NotConstraint  to signify this is a description block and not a constraint declaration
+ * @param type - the type parsed from the param or return declaration
+ * @param block - the block of text to evaluate
+ * @param delim - the split delimiter (defaults to ',')
+ */
+function parseConstraints(type, block, delim = ',') {
+    let constraint;
+    if (!block || !type)
+        return;
+    const valueType = valueTypeFromString(type);
+    let cblock = block.trim();
+    // get any constraint parameters
+    let fpi = cblock.indexOf('(');
+    while (fpi !== -1) {
+        let cpi = cblock.indexOf(')', fpi);
+        if (cpi === -1)
+            cpi = cblock.length;
+        const swap = cblock.substring(fpi, cpi).replace(/,/g, ';;');
+        cblock = cblock.substring(0, fpi) + swap + cblock.substring(cpi);
+        fpi = cblock.indexOf('(', cpi);
+    }
+    const expressions = cblock.split(delim);
+    for (let expr of expressions) {
+        let expVal;
+        let params;
+        let not = false;
+        expr = expr.trim();
+        if (!expr.startsWith('match') && !expr.startsWith('!match')) {
+            const cpi = expr.indexOf('(');
+            if (cpi !== -1) {
+                params = expr.substring(cpi).replace(/;;/g, ',').trim();
+                if (params.charAt(0) === '(')
+                    params = params.substring(1);
+                if (params.charAt(params.length - 1) === ')')
+                    params = params.substring(0, params.length - 1);
+                expr = expr.substring(0, cpi).trim();
+                if (expr === 'each') {
+                    expVal = eachListParse(params);
+                }
+                else {
+                    expVal = constraintListParse(params);
+                }
+            }
+        }
+        if (expr.charAt(0) === '!') {
+            not = true;
+            expr = expr.substring(1);
+        }
+        if (expr.includes('=')) {
+            const p = expr.split('=');
+            if (p.length > 2) {
+                p[1] = p.slice(1).join('=');
+            }
+            expr = p[0].trim();
+            if (expr === 'each') {
+                expVal = eachListParse(p[1]);
+            }
+            else {
+                expVal = constraintListParse(p[1]);
+            }
+        }
+        expr = expr.trim().toLowerCase();
+        switch (valueType) {
+            case ValueType.number:
+                constraint = constraint || new NumberConstraint();
+                switch (expr) {
+                    case 'noconstraint':
+                    case 'no constraint':
+                        return constraint; // early exit if we encounter "- No Constraint"
+                    /* Integer, Positive, Negative, NotZero, min, max */
+                    case 'integer':
+                        constraint.isInteger = true;
+                        break;
+                    case 'positive':
+                        constraint.isPositive = true;
+                        break;
+                    case 'negative':
+                        constraint.isNegative = true;
+                        break;
+                    case 'notzero':
+                    case 'not zero':
+                    case 'nonzero':
+                        constraint.notZero = true;
+                        break;
+                    case 'min':
+                        constraint.min = expVal;
+                        break;
+                    case 'max':
+                        constraint.max = expVal;
+                        break;
+                    case 'maxx':
+                        constraint.maxx = expVal;
+                        break;
+                    case 'note':
+                        constraint.note = expVal;
+                        break;
+                    default:
+                        constraint.badName = expr;
+                        break;
+                }
+                break;
+            case ValueType.string:
+                // minLength, maxLength, (!)startsWith, (!)endsWith, (!)contains,  (!)match
+                constraint = constraint || new StringConstraint();
+                switch (expr) {
+                    case 'noconstraint':
+                    case 'no constraint':
+                        return constraint; // early exit if we encounter "- No Constraint"
+                    case 'minlength':
+                        constraint.minLength = expVal;
+                        break;
+                    case 'maxlength':
+                        constraint.maxLength = expVal;
+                        break;
+                    case 'startswith':
+                        not ? constraint.notStartsWith = expVal : constraint.startsWith = expVal;
+                        break;
+                    case 'endswith':
+                        not ? constraint.notEndsWith = expVal : constraint.endsWith = expVal;
+                        break;
+                    case 'contains':
+                        not ? constraint.notContains = expVal : constraint.contains = expVal;
+                        break;
+                    case 'match':
+                        not ? constraint.notMatch = expVal : constraint.match = expVal;
+                        break;
+                    case 'note':
+                        constraint.note = expVal;
+                        break;
+                    default:
+                        constraint.badName = expr;
+                        break;
+                }
+                break;
+            case ValueType.object:
+                // (!)empty, (!)hasProperties, notNested, noPrototype, canSerialize, noUndefinedProps
+                constraint = constraint || new ObjectConstraint();
+                switch (expr) {
+                    case 'noconstraint':
+                    case 'no constraint':
+                        return constraint; // early exit if we encounter "- No Constraint"
+                    case 'empty':
+                        constraint.empty = !not;
+                        constraint.notEmpty = not;
+                        break;
+                    case 'hasproperties':
+                    case 'has properties':
+                        if (typeof expVal === 'string')
+                            expVal = [expVal];
+                        not ? constraint.notHasProperties = expVal : constraint.hasProperties = expVal;
+                        break;
+                    case 'notnested':
+                    case 'not nested':
+                        constraint.notNested = true;
+                        break;
+                    case 'noprototype':
+                    case 'no prototype':
+                        constraint.noPrototype = true;
+                        break;
+                    case 'canserialize':
+                    case 'can serialize':
+                        constraint.canSerialize = true;
+                        break;
+                    case 'notruthyprops':
+                    case 'no truthy props':
+                        constraint.noTruthyProps = true;
+                        break;
+                    case 'nofalseyprops':
+                    case 'no falsey props':
+                        constraint.noFalseyProps = true;
+                        break;
+                    case 'instanceof':
+                    case 'instance of':
+                        if (not)
+                            constraint.notInstanceOf = expVal;
+                        else
+                            constraint.instanceOf = expVal;
+                        break;
+                    case 'note':
+                        constraint.note = expVal;
+                        break;
+                    default:
+                        constraint.badName = expr;
+                        break;
+                }
+                break;
+            case ValueType.array:
+                // minLength, maxLength, (!)contains, each:
+                constraint = constraint || new ArrayConstraint();
+                switch (expr) {
+                    case 'noconstraint':
+                    case 'no constraint':
+                        return constraint; // early exit if we encounter "- No Constraint"
+                    case 'minlength':
+                    case 'min length':
+                        constraint.minLength = expVal;
+                        break;
+                    case 'maxlength':
+                    case 'max length':
+                        constraint.maxLength = expVal;
+                        break;
+                    case 'contains':
+                        not ? constraint.notContains = expVal : constraint.contains = expVal;
+                        break;
+                    case 'checktype':
+                    case 'check type':
+                        const psplit = (params || '').split(',');
+                        const pct = parseCheckType('' + expVal);
+                        constraint.elementCheckType = checkTypeFromString(pct.name);
+                        constraint.elementCheckParameter = (psplit[0] || pct.p1);
+                        constraint.elementCheckParameter2 = (psplit[1] || pct.p2);
+                        break;
+                    case 'each':
+                        const type = 'any';
+                        constraint.elementConstraints = expVal;
+                        break;
+                    case 'note':
+                        constraint.note = expVal;
+                        break;
+                    default:
+                        constraint.badName = expr;
+                        break;
+                }
+                break;
+            default: // none, boolean, regex
+                if (expr === 'no constraint')
+                    return;
+                constraint = new TypeConstraint(stringFromValueType(valueType));
+                break;
+        }
+    }
+    return constraint;
+}
+exports.parseConstraints = parseConstraints;
+/**
+ * Simple test to see if a value adheres to a set of constraints
+ */
+function validate(value, // The value to test for constraints. Must be one of the basic types supported by contraints
+constraintString // the constraints to test it against. Constraints listed must match the type being tested. Do not include < > brackets.
+) {
+    let type = typeof value;
+    if (type === 'object') {
+        if (Array.isArray(value))
+            type = 'array';
+    }
+    const tc = parseConstraints(type, constraintString || '');
+    let ok = '';
+    try {
+        if (tc != null)
+            tc.test(value);
+    }
+    catch (e) {
+        ok = e.message || e.toString();
+    }
+    return ok;
+}
+exports.validate = validate;
+//# sourceMappingURL=TypeCheck.js.map