@sinclair/typebox 0.24.3 → 0.24.6

package/compiler/compiler.d.ts

@@ -1,21 +1,18 @@
+import { TypeError } from './errors';
 import * as Types from '../typebox';
 export declare type CheckFunction = (value: unknown) => boolean;
-export declare class TypeCheckAssertError extends Error {
-    readonly schema: Types.TSchema;
-    readonly value: unknown;
-    constructor(schema: Types.TSchema, value: unknown);
-}
 export declare class TypeCheck<T extends Types.TSchema> {
     private readonly schema;
+    private readonly additional;
     private readonly checkFunc;
     private readonly code;
-    constructor(schema: T, checkFunc: CheckFunction, code: string);
-    /** Returns the compiled validation code used to check this type. */
+    constructor(schema: T, additional: Types.TSchema[], checkFunc: CheckFunction, code: string);
+    /** Returns the generated validation code used to validate this type */
     Code(): string;
-    /** Returns true if the value is valid. */
+    /** Returns an iterator for each type error found in this value */
+    Errors(value: unknown): Generator<TypeError>;
+    /** Returns true if the value matches the given type. */
     Check(value: unknown): value is Types.Static<T>;
-    /** Asserts the given value and throws a TypeCheckAssertError if invalid. */
-    Assert(value: unknown): void;
 }
 export declare namespace TypeCompiler {
     /** Compiles the given type for runtime type checking. This compiler only accepts known TypeBox types non-inclusive of unsafe types. */

package/compiler/compiler.js

@@ -27,43 +27,35 @@ THE SOFTWARE.
 
 ---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeCompiler = exports.TypeCheck = exports.TypeCheckAssertError = void 0;
+exports.TypeCompiler = exports.TypeCheck = void 0;
+const errors_1 = require("./errors");
 const Types = require("../typebox");
 // -------------------------------------------------------------------
 // TypeCheck
 // -------------------------------------------------------------------
-class TypeCheckAssertError extends Error {
-    schema;
-    value;
-    constructor(schema, value) {
-        super(`TypeCheckAssertError`);
-        this.schema = Types.Type.Strict(schema);
-        this.value = value;
-    }
-}
-exports.TypeCheckAssertError = TypeCheckAssertError;
 class TypeCheck {
     schema;
+    additional;
     checkFunc;
     code;
-    constructor(schema, checkFunc, code) {
+    constructor(schema, additional, checkFunc, code) {
         this.schema = schema;
+        this.additional = additional;
         this.checkFunc = checkFunc;
         this.code = code;
     }
-    /** Returns the compiled validation code used to check this type. */
+    /** Returns the generated validation code used to validate this type */
     Code() {
         return this.code;
     }
-    /** Returns true if the value is valid. */
+    /** Returns an iterator for each type error found in this value */
+    Errors(value) {
+        return errors_1.TypeErrors.Errors(this.schema, this.additional, value);
+    }
+    /** Returns true if the value matches the given type. */
     Check(value) {
         return this.checkFunc(value);
     }
-    /** Asserts the given value and throws a TypeCheckAssertError if invalid. */
-    Assert(value) {
-        if (!this.checkFunc(value))
-            throw new TypeCheckAssertError(this.schema, value);
-    }
 }
 exports.TypeCheck = TypeCheck;
 // -------------------------------------------------------------------
@@ -95,7 +87,7 @@ var TypeCompiler;
         if (schema.multipleOf)
             yield `(${path} % ${schema.multipleOf} === 0)`;
         if (schema.exclusiveMinimum)
-            yield `(${path} < ${schema.exclusiveMinimum})`;
+            yield `(${path} > ${schema.exclusiveMinimum})`;
         if (schema.exclusiveMaximum)
             yield `(${path} < ${schema.exclusiveMaximum})`;
         if (schema.minimum)
@@ -119,7 +111,7 @@ var TypeCompiler;
         if (schema.multipleOf)
             yield `(${path} % ${schema.multipleOf} === 0)`;
         if (schema.exclusiveMinimum)
-            yield `(${path} < ${schema.exclusiveMinimum})`;
+            yield `(${path} > ${schema.exclusiveMinimum})`;
         if (schema.exclusiveMaximum)
             yield `(${path} < ${schema.exclusiveMaximum})`;
         if (schema.minimum)
@@ -338,7 +330,7 @@ var TypeCompiler;
     function Compile(schema, additional = []) {
         const code = Build(schema, additional);
         const func = globalThis.Function(code);
-        return new TypeCheck(schema, func(), code);
+        return new TypeCheck(schema, additional, func(), code);
     }
     TypeCompiler.Compile = Compile;
 })(TypeCompiler = exports.TypeCompiler || (exports.TypeCompiler = {}));

package/compiler/errors.d.ts

@@ -0,0 +1,10 @@
+import * as Types from '../typebox';
+export interface TypeError {
+    schema: Types.TSchema;
+    path: string;
+    value: unknown;
+    message: string;
+}
+export declare namespace TypeErrors {
+    function Errors<T extends Types.TSchema>(schema: T, additional: Types.TSchema[], value: any): Generator<TypeError>;
+}

package/compiler/errors.js

@@ -0,0 +1,311 @@
+"use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/compiler
+
+The MIT License (MIT)
+
+Copyright (c) 2022 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeErrors = void 0;
+const Types = require("../typebox");
+var TypeErrors;
+(function (TypeErrors) {
+    function* Any(schema, path, value) { }
+    function* Array(schema, path, value) {
+        if (!globalThis.Array.isArray(value)) {
+            return yield { schema, path, value, message: `Expected array` };
+        }
+        for (let i = 0; i < value.length; i++) {
+            yield* Visit(schema.items, `${path}/${i}`, value[i]);
+        }
+    }
+    function* Boolean(schema, path, value) {
+        if (!(typeof value === 'boolean')) {
+            return yield { schema, path, value, message: `Expected boolean` };
+        }
+    }
+    function* Constructor(schema, path, value) {
+        yield* Visit(schema.yields, path, value);
+    }
+    function* Function(schema, path, value) {
+        if (!(typeof value === 'function')) {
+            return yield { schema, path, value, message: `Expected function` };
+        }
+    }
+    function* Integer(schema, path, value) {
+        if (!(typeof value === 'number')) {
+            return yield { schema, path, value, message: `Expected number` };
+        }
+        if (!globalThis.Number.isInteger(value)) {
+            yield { schema, path, value, message: `Expected integer` };
+        }
+        if (schema.multipleOf && !(value % schema.multipleOf === 0)) {
+            yield { schema, path, value, message: `Expected number to be a multiple of ${schema.multipleOf}` };
+        }
+        if (schema.exclusiveMinimum && !(value > schema.exclusiveMinimum)) {
+            yield { schema, path, value, message: `Expected number to be greater than ${schema.exclusiveMinimum}` };
+        }
+        if (schema.exclusiveMaximum && !(value < schema.exclusiveMaximum)) {
+            yield { schema, path, value, message: `Expected number to be less than ${schema.exclusiveMaximum}` };
+        }
+        if (schema.minimum && !(value >= schema.minimum)) {
+            yield { schema, path, value, message: `Expected number to be greater or equal to ${schema.minimum}` };
+        }
+        if (schema.maximum && !(value <= schema.maximum)) {
+            yield { schema, path, value, message: `Expected number to be less or equal to ${schema.maximum}` };
+        }
+    }
+    function* Literal(schema, path, value) {
+        if (!(value === schema.const)) {
+            const error = typeof schema.const === 'string' ? `'${schema.const}'` : schema.const;
+            return yield { schema, path, value, message: `Expected ${error}` };
+        }
+    }
+    function* Null(schema, path, value) {
+        if (!(value === null)) {
+            return yield { schema, path, value, message: `Expected null` };
+        }
+    }
+    function* Number(schema, path, value) {
+        if (!(typeof value === 'number')) {
+            return yield { schema, path, value, message: `Expected number` };
+        }
+        if (schema.multipleOf && !(value % schema.multipleOf === 0)) {
+            yield { schema, path, value, message: `Expected number to be a multiple of ${schema.multipleOf}` };
+        }
+        if (schema.exclusiveMinimum && !(value > schema.exclusiveMinimum)) {
+            yield { schema, path, value, message: `Expected number to be greater than ${schema.exclusiveMinimum}` };
+        }
+        if (schema.exclusiveMaximum && !(value < schema.exclusiveMaximum)) {
+            yield { schema, path, value, message: `Expected number to be less than ${schema.exclusiveMaximum}` };
+        }
+        if (schema.minimum && !(value >= schema.minimum)) {
+            yield { schema, path, value, message: `Expected number to be greater or equal to ${schema.minimum}` };
+        }
+        if (schema.maximum && !(value <= schema.maximum)) {
+            yield { schema, path, value, message: `Expected number to be less or equal to ${schema.maximum}` };
+        }
+    }
+    function* Object(schema, path, value) {
+        if (!(typeof value === 'object' && value !== null && !globalThis.Array.isArray(value))) {
+            return yield { schema, path, value, message: `Expected object` };
+        }
+        if (schema.minProperties !== undefined && !(globalThis.Object.keys(value).length >= schema.minProperties)) {
+            yield { schema, path, value, message: `Expected object to have at least ${schema.minProperties} properties` };
+        }
+        if (schema.maxProperties !== undefined && !(globalThis.Object.keys(value).length <= schema.maxProperties)) {
+            yield { schema, path, value, message: `Expected object to have less than ${schema.minProperties} properties` };
+        }
+        const propertyKeys = globalThis.Object.keys(schema.properties);
+        if (schema.additionalProperties === false) {
+            // optimization: If the property key length matches the required keys length
+            // then we only need check that the values property key length matches that
+            // of the property key length. This is because exhaustive testing for values
+            // will occur in subsequent property tests.
+            if (schema.required && schema.required.length === propertyKeys.length && !(globalThis.Object.keys(value).length === propertyKeys.length)) {
+                yield { schema, path, value, message: 'Expected object must not have additional properties' };
+            }
+            else {
+                if (!globalThis.Object.keys(value).every((key) => propertyKeys.includes(key))) {
+                    yield { schema, path, value, message: 'Expected object must not have additional properties' };
+                }
+            }
+        }
+        for (const propertyKey of propertyKeys) {
+            const propertySchema = schema.properties[propertyKey];
+            if (schema.required && schema.required.includes(propertyKey)) {
+                yield* Visit(propertySchema, `${path}/${propertyKey}`, value[propertyKey]);
+            }
+            else {
+                if (value[propertyKey] !== undefined) {
+                    yield* Visit(propertySchema, `${path}/${propertyKey}`, value[propertyKey]);
+                }
+            }
+        }
+    }
+    function* Promise(schema, path, value) {
+        if (!(typeof value === 'object' && typeof value.then === 'function')) {
+            yield { schema, path, value, message: `Expected Promise` };
+        }
+    }
+    function* Record(schema, path, value) {
+        if (!(typeof value === 'object' && value !== null && !globalThis.Array.isArray(value))) {
+            return yield { schema, path, value, message: `Expected object` };
+        }
+        const [keyPattern, valueSchema] = globalThis.Object.entries(schema.patternProperties)[0];
+        const regex = new RegExp(keyPattern);
+        if (!globalThis.Object.keys(value).every((key) => regex.test(key))) {
+            const message = keyPattern === '^(0|[1-9][0-9]*)$' ? 'Expected all object property keys to be numeric' : 'Expected all object property keys to be strings';
+            return yield { schema, path, value, message };
+        }
+        for (const [propKey, propValue] of globalThis.Object.entries(value)) {
+            yield* Visit(valueSchema, `${path}/${propKey}`, propValue);
+        }
+    }
+    function* Ref(schema, path, value) {
+        if (!referenceMap.has(schema.$ref)) {
+            throw Error(`TypeErrors: Cannot locate referenced schema for $id '${schema.$id}'`);
+        }
+        const referencedSchema = referenceMap.get(schema.$ref);
+        yield* Visit(referencedSchema, path, value);
+    }
+    function* Self(schema, path, value) {
+        if (!referenceMap.has(schema.$ref)) {
+            throw Error(`TypeErrors: Cannot locate referenced schema for $id '${schema.$id}'`);
+        }
+        const referencedSchema = referenceMap.get(schema.$ref);
+        yield* Visit(referencedSchema, path, value);
+    }
+    function* String(schema, path, value) {
+        if (!(typeof value === 'string')) {
+            return yield { schema, path, value, message: 'Expected string' };
+        }
+        if (schema.pattern !== undefined) {
+            const regex = new RegExp(schema.pattern);
+            if (!regex.test(value)) {
+                yield { schema, path, value, message: `Expected string to match pattern ${schema.pattern}` };
+            }
+        }
+    }
+    function* Tuple(schema, path, value) {
+        if (!global.Array.isArray(value)) {
+            return yield { schema, path, value, message: 'Expected Array' };
+        }
+        if (schema.items === undefined && !(value.length === 0)) {
+            return yield { schema, path, value, message: 'Expected tuple to have 0 elements' };
+        }
+        if (!(value.length === schema.maxItems)) {
+            yield { schema, path, value, message: `Expected tuple to have ${schema.maxItems} elements` };
+        }
+        if (!schema.items) {
+            return;
+        }
+        for (let i = 0; i < schema.items.length; i++) {
+            yield* Visit(schema.items[i], `${path}/${i}`, value[i]);
+        }
+    }
+    function* Undefined(schema, path, value) {
+        if (!(value === undefined)) {
+            yield { schema, path, value, message: `Expected undefined` };
+        }
+    }
+    function* Union(schema, path, value) {
+        const errors = [];
+        for (const inner of schema.anyOf) {
+            const variantErrors = [...Visit(inner, path, value)];
+            if (variantErrors.length === 0)
+                return;
+            errors.push(...variantErrors);
+        }
+        for (const error of errors) {
+            yield error;
+        }
+        if (errors.length > 0) {
+            yield { schema, path, value, message: 'Expected value of union' };
+        }
+    }
+    function* Uint8Array(schema, path, value) {
+        if (!(value instanceof globalThis.Uint8Array)) {
+            return yield { schema, path, value, message: `Expected Uint8Array` };
+        }
+        if (schema.maxByteLength && !(value.length <= schema.maxByteLength)) {
+            yield { schema, path, value, message: `Expected Uint8Array to have a byte length less or equal to ${schema.maxByteLength}` };
+        }
+        if (schema.minByteLength && !(value.length >= schema.minByteLength)) {
+            yield { schema, path, value, message: `Expected Uint8Array to have a byte length greater or equal to ${schema.maxByteLength}` };
+        }
+    }
+    function* Unknown(schema, path, value) { }
+    function* Void(schema, path, value) {
+        if (!(value === null)) {
+            return yield { schema, path, value, message: `Expected null` };
+        }
+    }
+    function* Visit(schema, path, value) {
+        if (schema.$id !== undefined) {
+            referenceMap.set(schema.$id, schema);
+        }
+        const anySchema = schema;
+        switch (anySchema[Types.Kind]) {
+            case 'Any':
+                return yield* Any(anySchema, path, value);
+            case 'Array':
+                return yield* Array(anySchema, path, value);
+            case 'Boolean':
+                return yield* Boolean(anySchema, path, value);
+            case 'Constructor':
+                return yield* Constructor(anySchema, path, value);
+            case 'Function':
+                return yield* Function(anySchema, path, value);
+            case 'Integer':
+                return yield* Integer(anySchema, path, value);
+            case 'Literal':
+                return yield* Literal(anySchema, path, value);
+            case 'Null':
+                return yield* Null(anySchema, path, value);
+            case 'Number':
+                return yield* Number(anySchema, path, value);
+            case 'Object':
+                return yield* Object(anySchema, path, value);
+            case 'Promise':
+                return yield* Promise(anySchema, path, value);
+            case 'Record':
+                return yield* Record(anySchema, path, value);
+            case 'Ref':
+                return yield* Ref(anySchema, path, value);
+            case 'Self':
+                return yield* Self(anySchema, path, value);
+            case 'String':
+                return yield* String(anySchema, path, value);
+            case 'Tuple':
+                return yield* Tuple(anySchema, path, value);
+            case 'Undefined':
+                return yield* Undefined(anySchema, path, value);
+            case 'Union':
+                return yield* Union(anySchema, path, value);
+            case 'Uint8Array':
+                return yield* Uint8Array(anySchema, path, value);
+            case 'Unknown':
+                return yield* Unknown(anySchema, path, value);
+            case 'Void':
+                return yield* Void(anySchema, path, value);
+            default:
+                throw Error(`Unknown schema kind '${schema[Types.Kind]}'`);
+        }
+    }
+    const referenceMap = new Map();
+    function SetAdditional(additional = []) {
+        referenceMap.clear();
+        for (const schema of additional) {
+            if (!schema.$id)
+                throw Error('TypeErrors: Referenced additional schemas must have an $id');
+            referenceMap.set(schema.$id, schema);
+        }
+    }
+    function* Errors(schema, additional, value) {
+        SetAdditional(additional);
+        yield* Visit(schema, '', value);
+    }
+    TypeErrors.Errors = Errors;
+})(TypeErrors = exports.TypeErrors || (exports.TypeErrors = {}));

package/compiler/index.d.ts

@@ -1 +1,2 @@
 export * from './compiler';
+export * from './errors';

package/compiler/index.js

@@ -38,3 +38,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./compiler"), exports);
+__exportStar(require("./errors"), exports);

package/guard/guard.d.ts

@@ -0,0 +1,48 @@
+import * as Types from '../typebox';
+/** Structural checks for TypeBox types */
+export declare namespace TypeGuard {
+    /** Returns true if the given schema is TAny */
+    function TAny(schema: any): schema is Types.TAny;
+    /** Returns true if the given schema is TArray */
+    function TArray(schema: any): schema is Types.TArray;
+    /** Returns true if the given schema is TBoolean */
+    function TBoolean(schema: any): schema is Types.TBoolean;
+    /** Returns true if the given schema is TConstructor */
+    function TConstructor(schema: any): schema is Types.TConstructor;
+    /** Returns true if the given schema is TFunction */
+    function TFunction(schema: any): schema is Types.TFunction;
+    /** Returns true if the given schema is TInteger */
+    function TInteger(schema: any): schema is Types.TInteger;
+    /** Returns true if the given schema is TLiteral */
+    function TLiteral(schema: any): schema is Types.TLiteral;
+    /** Returns true if the given schema is TNull */
+    function TNull(schema: any): schema is Types.TNull;
+    /** Returns true if the given schema is TNumber */
+    function TNumber(schema: any): schema is Types.TNumber;
+    /** Returns true if the given schema is TObject */
+    function TObject(schema: any): schema is Types.TObject;
+    /** Returns true if the given schema is TPromise */
+    function TPromise(schema: any): schema is Types.TPromise;
+    /** Returns true if the given schema is TRecord */
+    function TRecord(schema: any): schema is Types.TRecord;
+    /** Returns true if the given schema is TSelf */
+    function TSelf(schema: any): schema is Types.TSelf;
+    /** Returns true if the given schema is TRef */
+    function TRef(schema: any): schema is Types.TSelf;
+    /** Returns true if the given schema is TString */
+    function TString(schema: any): schema is Types.TString;
+    /** Returns true if the given schema is TTuple */
+    function TTuple(schema: any): schema is Types.TTuple;
+    /** Returns true if the given schema is TUndefined */
+    function TUndefined(schema: any): schema is Types.TUndefined;
+    /** Returns true if the given schema is TUnion */
+    function TUnion(schema: any): schema is Types.TUnion;
+    /** Returns true if the given schema is TUint8Array */
+    function TUint8Array(schema: any): schema is Types.TUint8Array;
+    /** Returns true if the given schema is TUnknown */
+    function TUnknown(schema: any): schema is Types.TUnknown;
+    /** Returns true if the given schema is TVoid */
+    function TVoid(schema: any): schema is Types.TVoid;
+    /** Returns true if the given schema is TSchema */
+    function TSchema(schema: any): schema is Types.TSchema;
+}

package/guard/guard.js

@@ -0,0 +1,222 @@
+"use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/guard
+
+The MIT License (MIT)
+
+Copyright (c) 2022 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, dTribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeGuard = void 0;
+const Types = require("../typebox");
+/** Structural checks for TypeBox types */
+var TypeGuard;
+(function (TypeGuard) {
+    function IsObject(schema) {
+        return typeof schema === 'object' && schema !== null && !Array.isArray(schema);
+    }
+    function IsArray(schema) {
+        return typeof schema === 'object' && schema !== null && Array.isArray(schema);
+    }
+    /** Returns true if the given schema is TAny */
+    function TAny(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Any';
+    }
+    TypeGuard.TAny = TAny;
+    /** Returns true if the given schema is TArray */
+    function TArray(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Array' && schema.type === 'array' && TSchema(schema.items);
+    }
+    TypeGuard.TArray = TArray;
+    /** Returns true if the given schema is TBoolean */
+    function TBoolean(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Boolean' && schema.type === 'boolean';
+    }
+    TypeGuard.TBoolean = TBoolean;
+    /** Returns true if the given schema is TConstructor */
+    function TConstructor(schema) {
+        if (!(IsObject(schema) && schema[Types.Kind] === 'Constructor' && schema.type === 'constructor' && IsArray(schema.parameters) && TSchema(schema.returns))) {
+            return false;
+        }
+        for (const parameter of schema.parameters) {
+            if (!TSchema(parameter))
+                return false;
+        }
+        return true;
+    }
+    TypeGuard.TConstructor = TConstructor;
+    /** Returns true if the given schema is TFunction */
+    function TFunction(schema) {
+        if (!(IsObject(schema) && schema[Types.Kind] === 'Function' && schema.type === 'function' && IsArray(schema.parameters) && TSchema(schema.returns))) {
+            return false;
+        }
+        for (const parameter of schema.parameters) {
+            if (!TSchema(parameter))
+                return false;
+        }
+        return true;
+    }
+    TypeGuard.TFunction = TFunction;
+    /** Returns true if the given schema is TInteger */
+    function TInteger(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Integer' && schema.type === 'integer';
+    }
+    TypeGuard.TInteger = TInteger;
+    /** Returns true if the given schema is TLiteral */
+    function TLiteral(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Literal' && (typeof schema.const === 'string' || typeof schema.const === 'number' || typeof schema.const === 'boolean');
+    }
+    TypeGuard.TLiteral = TLiteral;
+    /** Returns true if the given schema is TNull */
+    function TNull(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Null' && schema.type === 'null';
+    }
+    TypeGuard.TNull = TNull;
+    /** Returns true if the given schema is TNumber */
+    function TNumber(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Number' && schema.type === 'number';
+    }
+    TypeGuard.TNumber = TNumber;
+    /** Returns true if the given schema is TObject */
+    function TObject(schema) {
+        if (!(IsObject(schema) && schema[Types.Kind] === 'Object' && schema.type === 'object' && IsObject(schema.properties))) {
+            return false;
+        }
+        for (const property of Object.values(schema.properties)) {
+            if (!TSchema(property))
+                return false;
+        }
+        return true;
+    }
+    TypeGuard.TObject = TObject;
+    /** Returns true if the given schema is TPromise */
+    function TPromise(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Promise' && schema.type === 'promise' && TSchema(schema.item);
+    }
+    TypeGuard.TPromise = TPromise;
+    /** Returns true if the given schema is TRecord */
+    function TRecord(schema) {
+        if (!(IsObject(schema) && schema[Types.Kind] === 'Record' && schema.type === 'object' && IsObject(schema.patternProperties))) {
+            return false;
+        }
+        const keys = Object.keys(schema.patternProperties);
+        if (keys.length !== 1) {
+            return false;
+        }
+        if (!TSchema(schema.patternProperties[keys[0]])) {
+            return false;
+        }
+        return true;
+    }
+    TypeGuard.TRecord = TRecord;
+    /** Returns true if the given schema is TSelf */
+    function TSelf(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Self' && typeof schema.$ref === 'string';
+    }
+    TypeGuard.TSelf = TSelf;
+    /** Returns true if the given schema is TRef */
+    function TRef(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Ref' && typeof schema.$ref === 'string';
+    }
+    TypeGuard.TRef = TRef;
+    /** Returns true if the given schema is TString */
+    function TString(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'String' && schema.type === 'string';
+    }
+    TypeGuard.TString = TString;
+    /** Returns true if the given schema is TTuple */
+    function TTuple(schema) {
+        if (!(IsObject(schema) && schema[Types.Kind] === 'Tuple' && schema.type === 'array' && schema.additionalItems === false && typeof schema.minItems === 'number' && typeof schema.maxItems === 'number' && schema.minItems === schema.maxItems)) {
+            return false;
+        }
+        if (schema.items === undefined && schema.minItems === 0) {
+            return true;
+        }
+        if (!IsArray(schema.items)) {
+            return false;
+        }
+        for (const inner of schema.items) {
+            if (!TSchema(inner))
+                return false;
+        }
+        return true;
+    }
+    TypeGuard.TTuple = TTuple;
+    /** Returns true if the given schema is TUndefined */
+    function TUndefined(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Undefined' && schema.type === 'object' && schema.specialized === 'Undefined';
+    }
+    TypeGuard.TUndefined = TUndefined;
+    /** Returns true if the given schema is TUnion */
+    function TUnion(schema) {
+        if (!(IsObject(schema) && schema[Types.Kind] === 'Union' && IsArray(schema.anyOf))) {
+            return false;
+        }
+        for (const inner of schema.anyOf) {
+            if (!TSchema(inner))
+                return false;
+        }
+        return true;
+    }
+    TypeGuard.TUnion = TUnion;
+    /** Returns true if the given schema is TUint8Array */
+    function TUint8Array(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Uint8Array' && schema.type === 'object' && schema.specialized === 'Uint8Array';
+    }
+    TypeGuard.TUint8Array = TUint8Array;
+    /** Returns true if the given schema is TUnknown */
+    function TUnknown(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Unknown';
+    }
+    TypeGuard.TUnknown = TUnknown;
+    /** Returns true if the given schema is TVoid */
+    function TVoid(schema) {
+        return IsObject(schema) && schema[Types.Kind] === 'Void' && schema.type === 'null';
+    }
+    TypeGuard.TVoid = TVoid;
+    /** Returns true if the given schema is TSchema */
+    function TSchema(schema) {
+        return (TAny(schema) ||
+            TArray(schema) ||
+            TBoolean(schema) ||
+            TConstructor(schema) ||
+            TFunction(schema) ||
+            TInteger(schema) ||
+            TLiteral(schema) ||
+            TNull(schema) ||
+            TNumber(schema) ||
+            TObject(schema) ||
+            TPromise(schema) ||
+            TRecord(schema) ||
+            TSelf(schema) ||
+            TRef(schema) ||
+            TString(schema) ||
+            TTuple(schema) ||
+            TUndefined(schema) ||
+            TUnion(schema) ||
+            TUint8Array(schema) ||
+            TUnknown(schema) ||
+            TVoid(schema));
+    }
+    TypeGuard.TSchema = TSchema;
+})(TypeGuard = exports.TypeGuard || (exports.TypeGuard = {}));

package/guard/index.d.ts

@@ -0,0 +1 @@
+export * from './guard';

package/guard/index.js

@@ -0,0 +1,40 @@
+"use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/guards
+
+The MIT License (MIT)
+
+Copyright (c) 2022 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./guard"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sinclair/typebox",
-  "version": "0.24.3",
+  "version": "0.24.6",
   "description": "JSONSchema Type Builder with Static Type Resolution for TypeScript",
   "keywords": [
     "json-schema",

package/readme.md

@@ -62,6 +62,7 @@ License MIT
 - [Generic Types](#Generic-Types)
 - [Unsafe Types](#Unsafe-Types)
 - [Values](#Values)
+- [Guards](#Guards)
 - [Strict](#Strict)
 - [Validation](#Validation)
 - [Compiler](#Compiler)
@@ -435,7 +436,7 @@ In addition to JSON schema types, TypeBox provides several extended types that a
 │                                │                             │                                │
 ├────────────────────────────────┼─────────────────────────────┼────────────────────────────────┤
 │ const T = Type.Uint8Array()    │ type T = Uint8Array         │ const T = {                    │
-│                                │                             │   type: 'Uint8Array',          │
+│                                │                             │   type: 'object',              │
 │                                │                             │   specialized: 'Uint8Array'    │
 │                                │                             │ }                              │
 │                                │                             │                                │
@@ -600,6 +601,7 @@ const T = StringEnum(['A', 'B', 'C'])                // const T = {
 
 type T = Static<typeof T>                            // type T = 'A' | 'B' | 'C'
 ```
+
 <a name="Values"></a>
 
 ### Values
@@ -623,6 +625,29 @@ const V = Value.Create(T)                            // const V = {
                                                      // }
 ```
 
+<a name="Guards"></a>
+
+### Guards
+
+In some scenarios it may be helpful to test if an object is a valid TypeBox type. You can use the TypeGuard module to check an object conforms to a valid TypeBox schema representation. Consider the following.
+
+```typescript
+import { TypeGuard } from '@sinclair/typebox/guard'
+import { Type }  from '@sinclair/typebox'
+
+const T: any = Type.String()                         // T is any
+
+const { type } = T                                   // unsafe: type is any
+
+if(TypeGuard.TString(T)) {
+    
+  const { type } = T                                 // safe: type is 'string'
+}
+
+```
+
+
+
 <a name="Strict"></a>
 
 ### Strict
@@ -727,7 +752,7 @@ Please refer to the official AJV [documentation](https://ajv.js.org/guide/gettin
 
 ### Compiler
 
-TypeBox provides an optional type compiler that can be used as a runtime type checker in absense of a JSON Schema validator. Please note that this compiler is not fully JSON Schema compliant and only permits compilation of TypeBox types only (where the schema representation is known in advance). The `TypeCompiler` contains a `TypeCompiler.Compile(T)` method that returns a `TypeCheck<T>` object that can be used to test the validity of a value.
+TypeBox includes a specialized type compiler that can be used as a runtime type checker in absense of a JSON Schema validator. This compiler is optimized for high throughput validation scenarios and generally performs better than AJV for most structural checks. Please note that this compiler is not fully JSON Schema compliant and is limited to TypeBox types only. The `TypeCompiler` contains a `Compile(T)` function that returns a `TypeCheck<T>` object that can be used to test the validity of a value as well as obtain errors.
 
 ```typescript
 import { TypeCompiler } from '@sinclair/typebox/compiler'
@@ -747,9 +772,40 @@ const OK = C.Check({
   z: 3 
 }) // -> true
 ```
+Errors can be obtained by calling the `Errors(...)` function. This function returns an iterator that may contain zero or more errors for the given value. For performance, you should only call `Errors(V)` if the `Check(V)` function returns false. 
+```typescript
+const C = TypeCompiler.Compile(Type.Object({
+  x: Type.Number(),
+  y: Type.Number(),
+  z: Type.Number()
+}))
+
+const V = { } // invalid
+
+if(!C.Check(V)) {
+  for(const error of C.Errors(V)) {
+    console.log(error)
+  }
+}
+```
+To inspect the generated validation code created by the compiler. You can call the `Code()` function on the `TypeCheck<T>` object.
+
+```typescript
+const C = TypeCompiler.Compile(Type.String())
+
+console.log(C.Code())
+//
+// outputs:
+//
+// return function check(value) {
+//   return (
+//     (typeof value === 'string')
+//  )
+// }
+```
 
 <a name="Contribute"></a>
 
 ### Contribute
 
-TypeBox is open to community contribution, however please ensure you submit an open issue before submitting your pull request. The TypeBox project does preference open community discussion prior to accepting new features.
+TypeBox is open to community contribution, however please ensure you submit an open issue before submitting your pull request. The TypeBox project does preference open community discussion prior to accepting new features.

package/typebox.js

@@ -107,7 +107,6 @@ class TypeBuilder {
         const properties = {};
         for (const object of objects) {
             for (const [key, schema] of Object.entries(object.properties)) {
-                delete schema[exports.Modifier];
                 properties[key] = properties[key] === undefined ? schema : { [exports.Kind]: 'Union', anyOf: [properties[key], { ...schema }] };
             }
         }