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

package/build/require/value/cast/cast.js

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cast = exports.ValueCastUnknownTypeError = exports.ValueCastRecursiveTypeError = exports.ValueCastNeverTypeError = exports.ValueCastArrayUniqueItemsTypeError = void 0;
 const index_1 = require("../guard/index");
@@ -7,6 +34,9 @@ const index_3 = require("../create/index");
 const index_4 = require("../check/index");
 const index_5 = require("../clone/index");
 const index_6 = require("../deref/index");
+// ------------------------------------------------------------------
+// Errors
+// ------------------------------------------------------------------
 class ValueCastArrayUniqueItemsTypeError extends Error {
     constructor(schema, value) {
         super('Array cast produced invalid data due to uniqueItems constraint');
@@ -36,6 +66,14 @@ class ValueCastUnknownTypeError extends Error {
     }
 }
 exports.ValueCastUnknownTypeError = ValueCastUnknownTypeError;
+// ------------------------------------------------------------------
+// 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[index_2.Kind] === 'Object' && typeof value === 'object' && !(0, index_1.IsNull)(value)) {
         const object = schema;
@@ -73,12 +111,18 @@ function CastUnion(union, references, value) {
         return Cast(schema, references, value);
     }
 }
+// ------------------------------------------------------------------
+// Default
+// ------------------------------------------------------------------
 function DefaultClone(schema, references, value) {
     return (0, index_4.Check)(schema, references, value) ? (0, index_5.Clone)(value) : (0, index_3.Create)(schema, references);
 }
 function Default(schema, references, value) {
     return (0, index_4.Check)(schema, references, value) ? value : (0, index_3.Create)(schema, references);
 }
+// ------------------------------------------------------------------
+// Cast
+// ------------------------------------------------------------------
 function TArray(schema, references, value) {
     if ((0, index_4.Check)(schema, references, value))
         return (0, index_5.Clone)(value);
@@ -125,6 +169,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)) {
@@ -170,6 +215,9 @@ function Visit(schema, references, value) {
     const references_ = (0, index_1.IsString)(schema.$id) ? [...references, schema] : references;
     const schema_ = schema;
     switch (schema[index_2.Kind]) {
+        // --------------------------------------------------------------
+        // Structural
+        // --------------------------------------------------------------
         case 'Array':
             return TArray(schema_, references_, value);
         case 'Constructor':
@@ -190,14 +238,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. */
 function Cast(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
 }

package/build/require/value/cast/index.js

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/value/check/check.d.ts

@@ -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/require/value/check/check.js

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Check = exports.ValueCheckUnknownTypeError = void 0;
 const index_1 = require("../guard/index");
@@ -11,6 +38,9 @@ const index_7 = require("../../type/extends/index");
 const type_1 = require("../../type/guard/type");
 const index_8 = require("../../type/registry/index");
 const index_9 = require("../../type/never/index");
+// --------------------------------------------------------------------------
+// Errors
+// --------------------------------------------------------------------------
 class ValueCheckUnknownTypeError extends Error {
     constructor(schema) {
         super(`Unknown type`);
@@ -18,12 +48,21 @@ class ValueCheckUnknownTypeError extends Error {
     }
 }
 exports.ValueCheckUnknownTypeError = ValueCheckUnknownTypeError;
+// --------------------------------------------------------------------------
+// TypeGuards
+// --------------------------------------------------------------------------
 function IsAnyOrUnknown(schema) {
     return schema[index_5.Kind] === 'Any' || schema[index_5.Kind] === 'Unknown';
 }
+// --------------------------------------------------------------------------
+// Guards
+// --------------------------------------------------------------------------
 function IsDefined(value) {
     return value !== undefined;
 }
+// --------------------------------------------------------------------------
+// Types
+// --------------------------------------------------------------------------
 function TAny(schema, references, value) {
     return true;
 }
@@ -39,6 +78,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 = (0, index_4.Hash)(element);
         if (set.has(hashed)) {
@@ -50,8 +90,9 @@ function TArray(schema, references, value) {
     } return true; })())) {
         return false;
     }
+    // contains
     if (!(IsDefined(schema.contains) || (0, index_1.IsNumber)(schema.minContains) || (0, index_1.IsNumber)(schema.maxContains))) {
-        return true;
+        return true; // exit
     }
     const containsSchema = IsDefined(schema.contains) ? schema.contains : (0, index_9.Never)();
     const containsCount = value.reduce((acc, value) => (Visit(containsSchema, references, value) ? acc + 1 : acc), 0);
@@ -218,6 +259,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;
         }
@@ -248,9 +290,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;
@@ -417,6 +461,7 @@ function Visit(schema, references, value) {
             return TKind(schema_, references_, value);
     }
 }
+/** Returns true if the value matches the given type. */
 function Check(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
 }

package/build/require/value/check/index.js

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/value/clean/clean.d.ts

@@ -1,3 +1,5 @@
 import type { TSchema } from '../../type/schema/index';
+/** `[Mutable]` Removes excess properties from a value and returns the result. This function does not check the value and returns an unknown type. You should Check the result before use. Clean is a mutable operation. To avoid mutation, Clone the value first. */
 export declare function Clean<T extends TSchema>(schema: T, references: TSchema[], value: unknown): unknown;
+/** `[Mutable]` Removes excess properties from a value and returns the result. This function does not check the value and returns an unknown type. You should Check the result before use. Clean is a mutable operation. To avoid mutation, Clone the value first. */
 export declare function Clean<T extends TSchema>(schema: T): unknown;

package/build/require/value/clean/clean.js

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Clean = void 0;
 const index_1 = require("../guard/index");
@@ -8,12 +35,21 @@ const index_3 = require("../check/index");
 const index_4 = require("../clone/index");
 const index_5 = require("../deref/index");
 const index_6 = require("../../type/symbols/index");
+// ------------------------------------------------------------------
+// IsSchema
+// ------------------------------------------------------------------
 function IsSchema(schema) {
     return (0, type_1.TSchema)(schema);
 }
+// ------------------------------------------------------------------
+// IsCheckable
+// ------------------------------------------------------------------
 function IsCheckable(schema) {
     return (0, type_1.TSchema)(schema) && schema[index_6.Kind] !== 'Unsafe';
 }
+// ------------------------------------------------------------------
+// Types
+// ------------------------------------------------------------------
 function TArray(schema, references, value) {
     if (!(0, index_1.IsArray)(value))
         return value;
@@ -37,7 +73,7 @@ function TIntersect(schema, references, value) {
 }
 function TObject(schema, references, value) {
     if (!(0, index_1.IsObject)(value) || (0, index_1.IsArray)(value))
-        return value;
+        return value; // Check IsArray for AllowArrayObject configuration
     const additionalProperties = schema.additionalProperties;
     for (const key of Object.getOwnPropertyNames(value)) {
         if (key in schema.properties) {
@@ -87,6 +123,7 @@ function TTuple(schema, references, value) {
     for (let i = 0; i < length; i++) {
         value[i] = Visit(schema.items[i], references, value[i]);
     }
+    // prettier-ignore
     return value.length > length
         ? value.slice(0, length)
         : value;
@@ -123,6 +160,7 @@ function Visit(schema, references, value) {
             return value;
     }
 }
+/** `[Mutable]` Removes excess properties from a value and returns the result. This function does not check the value and returns an unknown type. You should Check the result before use. Clean is a mutable operation. To avoid mutation, Clone the value first. */
 function Clean(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
 }

package/build/require/value/clean/index.js

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/value/clone/clone.d.ts

@@ -1 +1,2 @@
+/** Returns a clone of the given value */
 export declare function Clone<T extends unknown>(value: T): T;

package/build/require/value/clone/clone.js

@@ -1,7 +1,37 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Clone = void 0;
 const index_1 = require("../guard/index");
+// --------------------------------------------------------------------------
+// Clonable
+// --------------------------------------------------------------------------
 function ObjectType(value) {
     const keys = [...Object.getOwnPropertyNames(value), ...Object.getOwnPropertySymbols(value)];
     return keys.reduce((acc, key) => ({ ...acc, [key]: Clone(value[key]) }), {});
@@ -18,6 +48,10 @@ function DateType(value) {
 function ValueType(value) {
     return value;
 }
+// --------------------------------------------------------------------------
+// Clone
+// --------------------------------------------------------------------------
+/** Returns a clone of the given value */
 function Clone(value) {
     if ((0, index_1.IsArray)(value))
         return ArrayType(value);

package/build/require/value/clone/index.js

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/build/require/value/convert/convert.d.ts

@@ -3,5 +3,7 @@ export declare class ValueConvertUnknownTypeError extends Error {
     readonly schema: TSchema;
     constructor(schema: TSchema);
 }
+/** Converts any type mismatched values to their target type if a reasonable conversion is possible. */
 export declare function Convert<T extends TSchema>(schema: T, references: TSchema[], value: unknown): unknown;
+/** Converts any type mismatched values to their target type if a reasonable conversion is possible. */
 export declare function Convert<T extends TSchema>(schema: T, value: unknown): unknown;

package/build/require/value/convert/convert.js

@@ -1,4 +1,31 @@
 "use strict";
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Convert = exports.ValueConvertUnknownTypeError = void 0;
 const index_1 = require("../guard/index");
@@ -8,6 +35,9 @@ const index_4 = require("../deref/index");
 const type_1 = require("../../type/guard/type");
 const index_5 = require("../../type/symbols/index");
 const index_6 = require("../../type/composite/index");
+// ------------------------------------------------------------------
+// Errors
+// ------------------------------------------------------------------
 class ValueConvertUnknownTypeError extends Error {
     constructor(schema) {
         super('Unknown type');
@@ -15,6 +45,9 @@ class ValueConvertUnknownTypeError extends Error {
     }
 }
 exports.ValueConvertUnknownTypeError = ValueConvertUnknownTypeError;
+// ------------------------------------------------------------------
+// Conversions
+// ------------------------------------------------------------------
 function IsStringNumeric(value) {
     return (0, index_1.IsString)(value) && !isNaN(value) && !isNaN(parseFloat(value));
 }
@@ -42,6 +75,9 @@ function IsDateTimeStringWithoutTimeZone(value) {
 function IsDateString(value) {
     return (0, index_1.IsString)(value) && /^\d\d\d\d-[0-1]\d-[0-3]\d$/i.test(value);
 }
+// ------------------------------------------------------------------
+// Convert
+// ------------------------------------------------------------------
 function TryConvertLiteralString(value, target) {
     const conversion = TryConvertString(value);
     return conversion === target ? conversion : value;
@@ -54,6 +90,7 @@ function TryConvertLiteralBoolean(value, target) {
     const conversion = TryConvertBoolean(value);
     return conversion === target ? conversion : value;
 }
+// prettier-ignore
 function TryConvertLiteral(schema, value) {
     return ((0, index_1.IsString)(schema.const) ? TryConvertLiteralString(value, schema.const) :
         (0, index_1.IsNumber)(schema.const) ? TryConvertLiteralNumber(value, schema.const) :
@@ -81,6 +118,14 @@ function TryConvertNull(value) {
 function TryConvertUndefined(value) {
     return (0, index_1.IsString)(value) && value === 'undefined' ? undefined : value;
 }
+// ------------------------------------------------------------------
+// note: this function may return an invalid dates for the regex
+// tests above. Invalid dates will however be checked during the
+// casting function and will return a epoch date if invalid.
+// Consider better string parsing for the iso dates in future
+// revisions.
+// ------------------------------------------------------------------
+// prettier-ignore
 function TryConvertDate(value) {
     return ((0, index_1.IsDate)(value) ? value :
         (0, index_1.IsNumber)(value) ? new Date(value) :
@@ -94,9 +139,15 @@ function TryConvertDate(value) {
                                         IsDateString(value) ? new Date(`${value}T00:00:00.000Z`) :
                                             value);
 }
+// ------------------------------------------------------------------
+// Default
+// ------------------------------------------------------------------
 function Default(value) {
     return value;
 }
+// ------------------------------------------------------------------
+// Convert
+// ------------------------------------------------------------------
 function TArray(schema, references, value) {
     if ((0, index_1.IsArray)(value)) {
         return value.map((value) => Visit(schema.items, references, value));
@@ -115,11 +166,12 @@ function TDate(schema, references, value) {
 function TInteger(schema, references, value) {
     return TryConvertInteger(value);
 }
+// prettier-ignore
 function TIntersect(schema, references, value) {
     const allObjects = schema.allOf.every(schema => (0, type_1.TObject)(schema));
     if (allObjects)
         return Visit((0, index_6.Composite)(schema.allOf), references, value);
-    return Visit(schema.allOf[0], references, value);
+    return Visit(schema.allOf[0], references, value); // todo: fix this
 }
 function TLiteral(schema, references, value) {
     return TryConvertLiteral(schema, value);
@@ -130,6 +182,7 @@ function TNull(schema, references, value) {
 function TNumber(schema, references, value) {
     return TryConvertNumber(value);
 }
+// prettier-ignore
 function TObject(schema, references, value) {
     const isConvertable = (0, index_1.IsObject)(value);
     if (!isConvertable)
@@ -161,6 +214,7 @@ function TSymbol(schema, references, value) {
 function TThis(schema, references, value) {
     return Visit((0, index_4.Deref)(schema, references), references, value);
 }
+// prettier-ignore
 function TTuple(schema, references, value) {
     const isConvertable = (0, index_1.IsArray)(value) && !(0, index_1.IsUndefined)(schema.items);
     if (!isConvertable)
@@ -227,6 +281,8 @@ function Visit(schema, references, value) {
             return Default(value);
     }
 }
+/** Converts any type mismatched values to their target type if a reasonable conversion is possible. */
+// prettier-ignore
 function Convert(...args) {
     return args.length === 3
         ? Visit(args[0], args[1], args[2])