@sinclair/typebox 0.32.0-dev-16 → 0.32.0-dev-17

package/build/import/type/union/union-create.mjs

@@ -1,3 +1,30 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 import { CloneRest } from '../clone/type.mjs';
 import { Kind } from '../symbols/index.mjs';
 export function UnionCreate(T, options) {

package/build/import/type/union/union-evaluated.d.mts

@@ -12,5 +12,6 @@ declare function RemoveOptionalFromType<T extends TSchema>(T: T): RemoveOptional
 type ResolveUnion<T extends TSchema[], R extends TSchema[] = RemoveOptionalFromRest<T>> = (IsUnionOptional<T> extends true ? TOptional<TUnion<R>> : TUnion<R>);
 declare function ResolveUnion<T extends TSchema[]>(T: T, options: SchemaOptions): ResolveUnion<T>;
 export type UnionEvaluated<T extends TSchema[]> = (T extends [] ? TNever : T extends [TSchema] ? T[0] : ResolveUnion<T>);
+/** `[Json]` Creates an evaluated Union type */
 export declare function UnionEvaluated<T extends TSchema[], R = UnionEvaluated<T>>(T: [...T], options?: SchemaOptions): R;
 export {};

package/build/import/type/union/union-evaluated.mjs

@@ -1,10 +1,42 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 import { OptionalKind } from '../symbols/index.mjs';
 import { CloneType } from '../clone/type.mjs';
 import { Discard } from '../discard/index.mjs';
 import { Never } from '../never/index.mjs';
 import { Optional } from '../optional/index.mjs';
 import { UnionCreate } from './union-create.mjs';
+// ------------------------------------------------------------------
+// TypeGuard
+// ------------------------------------------------------------------
+// prettier-ignore
 import { TOptional as IsOptionalType } from '../guard/type.mjs';
+// prettier-ignore
 function IsUnionOptional(T) {
     const [L, ...R] = T;
     return (T.length > 0
@@ -13,18 +45,23 @@ function IsUnionOptional(T) {
             : IsUnionOptional(R)
         : false);
 }
+// prettier-ignore
 function RemoveOptionalFromRest(T) {
     return (T.map(T => RemoveOptionalFromType(T)));
 }
+// prettier-ignore
 function RemoveOptionalFromType(T) {
     return (Discard(T, [OptionalKind]));
 }
+// prettier-ignore
 function ResolveUnion(T, options) {
     return (IsUnionOptional(T)
         ? Optional(UnionCreate(RemoveOptionalFromRest(T), options))
         : UnionCreate(RemoveOptionalFromRest(T), options));
 }
+/** `[Json]` Creates an evaluated Union type */
 export function UnionEvaluated(T, options = {}) {
+    // prettier-ignore
     return (T.length === 0 ? Never(options) :
         T.length === 1 ? CloneType(T[0], options) :
             ResolveUnion(T, options));

package/build/import/type/union/union-type.mjs

@@ -1 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 import { Kind } from '../symbols/index.mjs';

package/build/import/type/union/union.d.mts

@@ -2,4 +2,5 @@ import type { TSchema, SchemaOptions } from '../schema/index.mjs';
 import { type TNever } from '../never/index.mjs';
 import type { TUnion } from './union-type.mjs';
 export type Union<T extends TSchema[]> = (T extends [] ? TNever : T extends [TSchema] ? T[0] : TUnion<T>);
+/** `[Json]` Creates a Union type */
 export declare function Union<T extends TSchema[]>(T: [...T], options?: SchemaOptions): Union<T>;

package/build/import/type/union/union.mjs

@@ -1,7 +1,36 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 import { Never } from '../never/index.mjs';
 import { CloneType } from '../clone/type.mjs';
 import { UnionCreate } from './union-create.mjs';
+/** `[Json]` Creates a Union type */
 export function Union(T, options = {}) {
+    // prettier-ignore
     return (T.length === 0 ? Never(options) :
         T.length === 1 ? CloneType(T[0], options) :
             UnionCreate(T, options));

package/build/import/type/unknown/index.mjs

@@ -1 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 export * from './unknown.mjs';

package/build/import/type/unknown/unknown.d.mts

@@ -4,4 +4,5 @@ export interface TUnknown extends TSchema {
     [Kind]: 'Unknown';
     static: unknown;
 }
+/** `[Json]` Creates an Unknown type */
 export declare function Unknown(options?: SchemaOptions): TUnknown;

package/build/import/type/unknown/unknown.mjs

@@ -1,4 +1,32 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 import { Kind } from '../symbols/index.mjs';
+/** `[Json]` Creates an Unknown type */
 export function Unknown(options = {}) {
     return {
         ...options,

package/build/import/type/unsafe/index.mjs

@@ -1 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 export * from './unsafe.mjs';

package/build/import/type/unsafe/unsafe.d.mts

@@ -7,4 +7,5 @@ export interface TUnsafe<T> extends TSchema {
     [Kind]: string;
     static: T;
 }
+/** `[Json]` Creates a Unsafe type that will infers as the generic argument T */
 export declare function Unsafe<T>(options?: UnsafeOptions): TUnsafe<T>;

package/build/import/type/unsafe/unsafe.mjs

@@ -1,4 +1,32 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 import { Kind } from '../symbols/index.mjs';
+/** `[Json]` Creates a Unsafe type that will infers as the generic argument T */
 export function Unsafe(options = {}) {
     return {
         ...options,

package/build/import/type/void/index.mjs

@@ -1 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 export * from './void.mjs';

package/build/import/type/void/void.d.mts

@@ -5,4 +5,5 @@ export interface TVoid extends TSchema {
     static: void;
     type: 'void';
 }
+/** `[JavaScript]` Creates a Void type */
 export declare function Void(options?: SchemaOptions): TVoid;

package/build/import/type/void/void.mjs

@@ -1,4 +1,32 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/type
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 import { Kind } from '../symbols/index.mjs';
+/** `[JavaScript]` Creates a Void type */
 export function Void(options = {}) {
     return {
         ...options,

package/build/import/value/cast/cast.d.mts

@@ -17,5 +17,7 @@ export declare class ValueCastUnknownTypeError extends Error {
     readonly schema: TSchema;
     constructor(schema: TSchema);
 }
+/** Casts a value into a given type and references. The return value will retain as much information of the original value as possible. */
 export declare function Cast<T extends TSchema>(schema: T, references: TSchema[], value: unknown): Static<T>;
+/** Casts a value into a given type. The return value will retain as much information of the original value as possible. */
 export declare function Cast<T extends TSchema>(schema: T, value: unknown): Static<T>;

package/build/import/value/cast/cast.mjs

@@ -1,9 +1,39 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/value
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 import { IsPlainObject, IsArray, IsString, IsNumber, IsNull } from '../guard/index.mjs';
 import { Kind } from '../../type/symbols/index.mjs';
 import { Create } from '../create/index.mjs';
 import { Check } from '../check/index.mjs';
 import { Clone } from '../clone/index.mjs';
 import { Deref } from '../deref/index.mjs';
+// ------------------------------------------------------------------
+// Errors
+// ------------------------------------------------------------------
 export class ValueCastArrayUniqueItemsTypeError extends Error {
     schema;
     value;
@@ -34,6 +64,14 @@ export class ValueCastUnknownTypeError extends Error {
         this.schema = schema;
     }
 }
+// ------------------------------------------------------------------
+// The following will score a schema against a value. For objects,
+// the score is the tally of points awarded for each property of
+// the value. Property points are (1.0 / propertyCount) to prevent
+// large property counts biasing results. Properties that match
+// literal values are maximally awarded as literals are typically
+// used as union discriminator fields.
+// ------------------------------------------------------------------
 function ScoreUnion(schema, references, value) {
     if (schema[Kind] === 'Object' && typeof value === 'object' && !IsNull(value)) {
         const object = schema;
@@ -71,12 +109,18 @@ function CastUnion(union, references, value) {
         return Cast(schema, references, value);
     }
 }
+// ------------------------------------------------------------------
+// Default
+// ------------------------------------------------------------------
 function DefaultClone(schema, references, value) {
     return Check(schema, references, value) ? Clone(value) : Create(schema, references);
 }
 function Default(schema, references, value) {
     return Check(schema, references, value) ? value : Create(schema, references);
 }
+// ------------------------------------------------------------------
+// Cast
+// ------------------------------------------------------------------
 function TArray(schema, references, value) {
     if (Check(schema, references, value))
         return Clone(value);
@@ -123,6 +167,7 @@ function TObject(schema, references, value) {
             continue;
         result[key] = Visit(property, references, value[key]);
     }
+    // additional schema properties
     if (typeof schema.additionalProperties === 'object') {
         const propertyNames = Object.getOwnPropertyNames(schema.properties);
         for (const propertyName of Object.getOwnPropertyNames(value)) {
@@ -168,6 +213,9 @@ function Visit(schema, references, value) {
     const references_ = IsString(schema.$id) ? [...references, schema] : references;
     const schema_ = schema;
     switch (schema[Kind]) {
+        // --------------------------------------------------------------
+        // Structural
+        // --------------------------------------------------------------
         case 'Array':
             return TArray(schema_, references_, value);
         case 'Constructor':
@@ -188,14 +236,21 @@ function Visit(schema, references, value) {
             return TTuple(schema_, references_, value);
         case 'Union':
             return TUnion(schema_, references_, value);
+        // --------------------------------------------------------------
+        // DefaultClone
+        // --------------------------------------------------------------
         case 'Date':
         case 'Symbol':
         case 'Uint8Array':
             return DefaultClone(schema, references, value);
+        // --------------------------------------------------------------
+        // Default
+        // --------------------------------------------------------------
         default:
             return Default(schema_, references_, value);
     }
 }
+/** Casts a value into a given type. The return value will retain as much information of the original value as possible. */
 export function Cast(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
 }

package/build/import/value/cast/index.mjs

@@ -1 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/value
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 export * from './cast.mjs';

package/build/import/value/check/check.d.mts

@@ -4,5 +4,7 @@ export declare class ValueCheckUnknownTypeError extends Error {
     readonly schema: TSchema;
     constructor(schema: TSchema);
 }
+/** Returns true if the value matches the given type. */
 export declare function Check<T extends TSchema>(schema: T, references: TSchema[], value: unknown): value is Static<T>;
+/** Returns true if the value matches the given type. */
 export declare function Check<T extends TSchema>(schema: T, value: unknown): value is Static<T>;

package/build/import/value/check/check.mjs

@@ -1,3 +1,30 @@
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/value
+
+The MIT License (MIT)
+
+Copyright (c) 2017-2023 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.
+
+---------------------------------------------------------------------------*/
 import { IsArray, IsUint8Array, IsDate, IsPromise, IsFunction, IsAsyncIterator, IsIterator, IsBoolean, IsNumber, IsBigInt, IsString, IsSymbol, IsInteger, IsNull, IsUndefined } from '../guard/index.mjs';
 import { TypeSystemPolicy } from '../../system/index.mjs';
 import { Deref } from '../deref/index.mjs';
@@ -8,6 +35,9 @@ import { ExtendsUndefinedCheck } from '../../type/extends/index.mjs';
 import { TSchema as IsSchemaType } from '../../type/guard/type.mjs';
 import { TypeRegistry, FormatRegistry } from '../../type/registry/index.mjs';
 import { Never } from '../../type/never/index.mjs';
+// --------------------------------------------------------------------------
+// Errors
+// --------------------------------------------------------------------------
 export class ValueCheckUnknownTypeError extends Error {
     schema;
     constructor(schema) {
@@ -15,12 +45,21 @@ export class ValueCheckUnknownTypeError extends Error {
         this.schema = schema;
     }
 }
+// --------------------------------------------------------------------------
+// TypeGuards
+// --------------------------------------------------------------------------
 function IsAnyOrUnknown(schema) {
     return schema[Kind] === 'Any' || schema[Kind] === 'Unknown';
 }
+// --------------------------------------------------------------------------
+// Guards
+// --------------------------------------------------------------------------
 function IsDefined(value) {
     return value !== undefined;
 }
+// --------------------------------------------------------------------------
+// Types
+// --------------------------------------------------------------------------
 function TAny(schema, references, value) {
     return true;
 }
@@ -36,6 +75,7 @@ function TArray(schema, references, value) {
     if (!value.every((value) => Visit(schema.items, references, value))) {
         return false;
     }
+    // prettier-ignore
     if (schema.uniqueItems === true && !((function () { const set = new Set(); for (const element of value) {
         const hashed = Hash(element);
         if (set.has(hashed)) {
@@ -47,8 +87,9 @@ function TArray(schema, references, value) {
     } return true; })())) {
         return false;
     }
+    // contains
     if (!(IsDefined(schema.contains) || IsNumber(schema.minContains) || IsNumber(schema.maxContains))) {
-        return true;
+        return true; // exit
     }
     const containsSchema = IsDefined(schema.contains) ? schema.contains : Never();
     const containsCount = value.reduce((acc, value) => (Visit(containsSchema, references, value) ? acc + 1 : acc), 0);
@@ -215,6 +256,7 @@ function TObject(schema, references, value) {
     }
     if (schema.additionalProperties === false) {
         const valueKeys = Object.getOwnPropertyNames(value);
+        // optimization: value is valid if schemaKey length matches the valueKey length
         if (schema.required && schema.required.length === knownKeys.length && valueKeys.length === knownKeys.length) {
             return true;
         }
@@ -245,9 +287,11 @@ function TRecord(schema, references, value) {
     }
     const [patternKey, patternSchema] = Object.entries(schema.patternProperties)[0];
     const regex = new RegExp(patternKey);
+    // prettier-ignore
     const check1 = Object.entries(value).every(([key, value]) => {
         return (regex.test(key)) ? Visit(patternSchema, references, value) : true;
     });
+    // prettier-ignore
     const check2 = typeof schema.additionalProperties === 'object' ? Object.entries(value).every(([key, value]) => {
         return (!regex.test(key)) ? Visit(schema.additionalProperties, references, value) : true;
     }) : true;
@@ -414,6 +458,7 @@ function Visit(schema, references, value) {
             return TKind(schema_, references_, value);
     }
 }
+/** Returns true if the value matches the given type. */
 export function Check(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
 }