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

package/build/import/value/check/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 './check.mjs';

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

@@ -1,3 +1,5 @@
 import type { TSchema } from '../../type/schema/index.mjs';
+/** `[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/import/value/clean/clean.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 { IsString, IsObject, IsArray, IsUndefined } from '../guard/index.mjs';
 import { TSchema as IsSchemaType } from '../../type/guard/type.mjs';
 import { KeyOfPropertyKeys } from '../../type/keyof/index.mjs';
@@ -5,12 +32,21 @@ import { Check } from '../check/index.mjs';
 import { Clone } from '../clone/index.mjs';
 import { Deref } from '../deref/index.mjs';
 import { Kind } from '../../type/symbols/index.mjs';
+// ------------------------------------------------------------------
+// IsSchema
+// ------------------------------------------------------------------
 function IsSchema(schema) {
     return IsSchemaType(schema);
 }
+// ------------------------------------------------------------------
+// IsCheckable
+// ------------------------------------------------------------------
 function IsCheckable(schema) {
     return IsSchemaType(schema) && schema[Kind] !== 'Unsafe';
 }
+// ------------------------------------------------------------------
+// Types
+// ------------------------------------------------------------------
 function TArray(schema, references, value) {
     if (!IsArray(value))
         return value;
@@ -34,7 +70,7 @@ function TIntersect(schema, references, value) {
 }
 function TObject(schema, references, value) {
     if (!IsObject(value) || 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) {
@@ -84,6 +120,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;
@@ -120,6 +157,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. */
 export function Clean(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
 }

package/build/import/value/clean/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 './clean.mjs';

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

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

package/build/import/value/clone/clone.mjs

@@ -1,4 +1,34 @@
+/*--------------------------------------------------------------------------
+
+@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, IsDate, IsPlainObject, IsTypedArray, IsValueType } from '../guard/index.mjs';
+// --------------------------------------------------------------------------
+// Clonable
+// --------------------------------------------------------------------------
 function ObjectType(value) {
     const keys = [...Object.getOwnPropertyNames(value), ...Object.getOwnPropertySymbols(value)];
     return keys.reduce((acc, key) => ({ ...acc, [key]: Clone(value[key]) }), {});
@@ -15,6 +45,10 @@ function DateType(value) {
 function ValueType(value) {
     return value;
 }
+// --------------------------------------------------------------------------
+// Clone
+// --------------------------------------------------------------------------
+/** Returns a clone of the given value */
 export function Clone(value) {
     if (IsArray(value))
         return ArrayType(value);

package/build/import/value/clone/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 './clone.mjs';

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

@@ -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/import/value/convert/convert.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, IsObject, IsDate, IsUndefined, IsString, IsNumber, IsBoolean, IsBigInt, IsSymbol } from '../guard/index.mjs';
 import { Clone } from '../clone/index.mjs';
 import { Check } from '../check/index.mjs';
@@ -5,6 +32,9 @@ import { Deref } from '../deref/index.mjs';
 import { TObject as IsObjectType } from '../../type/guard/type.mjs';
 import { Kind } from '../../type/symbols/index.mjs';
 import { Composite } from '../../type/composite/index.mjs';
+// ------------------------------------------------------------------
+// Errors
+// ------------------------------------------------------------------
 export class ValueConvertUnknownTypeError extends Error {
     schema;
     constructor(schema) {
@@ -12,6 +42,9 @@ export class ValueConvertUnknownTypeError extends Error {
         this.schema = schema;
     }
 }
+// ------------------------------------------------------------------
+// Conversions
+// ------------------------------------------------------------------
 function IsStringNumeric(value) {
     return IsString(value) && !isNaN(value) && !isNaN(parseFloat(value));
 }
@@ -39,6 +72,9 @@ function IsDateTimeStringWithoutTimeZone(value) {
 function IsDateString(value) {
     return 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;
@@ -51,6 +87,7 @@ function TryConvertLiteralBoolean(value, target) {
     const conversion = TryConvertBoolean(value);
     return conversion === target ? conversion : value;
 }
+// prettier-ignore
 function TryConvertLiteral(schema, value) {
     return (IsString(schema.const) ? TryConvertLiteralString(value, schema.const) :
         IsNumber(schema.const) ? TryConvertLiteralNumber(value, schema.const) :
@@ -78,6 +115,14 @@ function TryConvertNull(value) {
 function TryConvertUndefined(value) {
     return 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 (IsDate(value) ? value :
         IsNumber(value) ? new Date(value) :
@@ -91,9 +136,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 (IsArray(value)) {
         return value.map((value) => Visit(schema.items, references, value));
@@ -112,11 +163,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 => IsObjectType(schema));
     if (allObjects)
         return Visit(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);
@@ -127,6 +179,7 @@ function TNull(schema, references, value) {
 function TNumber(schema, references, value) {
     return TryConvertNumber(value);
 }
+// prettier-ignore
 function TObject(schema, references, value) {
     const isConvertable = IsObject(value);
     if (!isConvertable)
@@ -158,6 +211,7 @@ function TSymbol(schema, references, value) {
 function TThis(schema, references, value) {
     return Visit(Deref(schema, references), references, value);
 }
+// prettier-ignore
 function TTuple(schema, references, value) {
     const isConvertable = IsArray(value) && !IsUndefined(schema.items);
     if (!isConvertable)
@@ -224,6 +278,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
 export function Convert(...args) {
     return args.length === 3
         ? Visit(args[0], args[1], args[2])

package/build/import/value/convert/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 './convert.mjs';

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

@@ -25,5 +25,7 @@ export declare class ValueCreateRecursiveInstantiationError extends Error {
     readonly recursiveMaxDepth: number;
     constructor(schema: TSchema, recursiveMaxDepth: number);
 }
+/** Creates a value from the given schema and references */
 export declare function Create<T extends TSchema>(schema: T, references: TSchema[]): Static<T>;
+/** Creates a value from the given schema */
 export declare function Create<T extends TSchema>(schema: T): Static<T>;

package/build/import/value/create/create.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 { HasPropertyKey, IsString } from '../guard/index.mjs';
 import { Check } from '../check/index.mjs';
 import { Deref } from '../deref/index.mjs';
@@ -5,6 +32,9 @@ import { TemplateLiteralParseExact, IsTemplateLiteralFinite, TemplateLiteralGene
 import { PatternStringExact, PatternNumberExact } from '../../type/patterns/index.mjs';
 import { TypeRegistry } from '../../type/registry/index.mjs';
 import { Kind } from '../../type/symbols/index.mjs';
+// ------------------------------------------------------------------
+// Errors
+// ------------------------------------------------------------------
 export class ValueCreateUnknownTypeError extends Error {
     schema;
     constructor(schema) {
@@ -49,6 +79,9 @@ export class ValueCreateRecursiveInstantiationError extends Error {
         this.recursiveMaxDepth = recursiveMaxDepth;
     }
 }
+// ------------------------------------------------------------------
+// Create
+// ------------------------------------------------------------------
 function TAny(schema, references) {
     if (HasPropertyKey(schema, 'default')) {
         return schema.default;
@@ -157,6 +190,13 @@ function TIntersect(schema, references) {
         return schema.default;
     }
     else {
+        // --------------------------------------------------------------
+        // Note: The best we can do here is attempt to instance each
+        // sub type and apply through object assign. For non-object
+        // sub types, we just escape the assignment and just return
+        // the value. In the latter case, this is typically going to
+        // be a consequence of an illogical intersection.
+        // --------------------------------------------------------------
         const value = schema.allOf.reduce((acc, schema) => {
             const next = Visit(schema, references);
             return typeof next === 'object' ? { ...acc, ...next } : next;
@@ -452,8 +492,12 @@ function Visit(schema, references) {
             return TKind(schema_, references_);
     }
 }
+// ------------------------------------------------------------------
+// State
+// ------------------------------------------------------------------
 const recursiveMaxDepth = 512;
 let recursiveDepth = 0;
+/** Creates a value from the given schema */
 export function Create(...args) {
     recursiveDepth = 0;
     return args.length === 2 ? Visit(args[0], args[1]) : Visit(args[0], []);

package/build/import/value/create/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 './create.mjs';

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

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

package/build/import/value/default/default.mjs

@@ -1,17 +1,56 @@
+/*--------------------------------------------------------------------------
+
+@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 { IsString, IsObject, IsArray, IsUndefined } from '../guard/index.mjs';
 import { TSchema as IsSchemaType } from '../../type/guard/type.mjs';
 import { Check } from '../check/index.mjs';
 import { Deref } from '../deref/index.mjs';
 import { Kind } from '../../type/symbols/index.mjs';
+// ------------------------------------------------------------------
+// ValueOrDefault
+// ------------------------------------------------------------------
 function ValueOrDefault(schema, value) {
     return !(value === undefined) || !('default' in schema) ? value : schema.default;
 }
+// ------------------------------------------------------------------
+// IsCheckable
+// ------------------------------------------------------------------
 function IsCheckable(schema) {
     return IsSchemaType(schema) && schema[Kind] !== 'Unsafe';
 }
+// ------------------------------------------------------------------
+// IsDefaultSchema
+// ------------------------------------------------------------------
 function IsDefaultSchema(value) {
     return IsSchemaType(value) && 'default' in value;
 }
+// ------------------------------------------------------------------
+// Types
+// ------------------------------------------------------------------
 function TArray(schema, references, value) {
     const defaulted = ValueOrDefault(schema, value);
     if (!IsArray(defaulted))
@@ -34,13 +73,16 @@ function TObject(schema, references, value) {
         return defaulted;
     const additionalPropertiesSchema = schema.additionalProperties;
     const knownPropertyKeys = Object.getOwnPropertyNames(schema.properties);
+    // properties
     for (const key of knownPropertyKeys) {
         if (!IsDefaultSchema(schema.properties[key]))
             continue;
         defaulted[key] = Visit(schema.properties[key], references, defaulted[key]);
     }
+    // return if not additional properties
     if (!IsDefaultSchema(additionalPropertiesSchema))
         return defaulted;
+    // additional properties
     for (const key of Object.getOwnPropertyNames(defaulted)) {
         if (knownPropertyKeys.includes(key))
             continue;
@@ -55,13 +97,16 @@ function TRecord(schema, references, value) {
     const additionalPropertiesSchema = schema.additionalProperties;
     const [propertyKeyPattern, propertySchema] = Object.entries(schema.patternProperties)[0];
     const knownPropertyKey = new RegExp(propertyKeyPattern);
+    // properties
     for (const key of Object.getOwnPropertyNames(defaulted)) {
         if (!(knownPropertyKey.test(key) && IsDefaultSchema(propertySchema)))
             continue;
         defaulted[key] = Visit(propertySchema, references, defaulted[key]);
     }
+    // return if not additional properties
     if (!IsDefaultSchema(additionalPropertiesSchema))
         return defaulted;
+    // additional properties
     for (const key of Object.getOwnPropertyNames(defaulted)) {
         if (knownPropertyKey.test(key))
             continue;
@@ -120,6 +165,7 @@ function Visit(schema, references, value) {
             return ValueOrDefault(schema_, value);
     }
 }
+/** `[Mutable]` Generates missing properties on a value using default schema annotations if available. This function does not check the value and returns an unknown type. You should Check the result before use. Default is a mutable operation. To avoid mutation, Clone the value first. */
 export function Default(...args) {
     return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
 }

package/build/import/value/default/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 './default.mjs';