typebox 1.1.39 → 1.2.0

package/build/type/types/dependent.mjs

@@ -0,0 +1,24 @@
+// deno-fmt-ignore-file
+import { Memory } from '../../system/memory/index.mjs';
+import { IsKind } from './schema.mjs';
+// ------------------------------------------------------------------
+// Factory
+// ------------------------------------------------------------------
+/** Creates a Dependent type */
+export function Dependent(if_, then_, else_, options = {}) {
+    return Memory.Create({ '~kind': 'Dependent' }, { if: if_, then: then_, else: else_ }, options);
+}
+// ------------------------------------------------------------------
+// Guard
+// ------------------------------------------------------------------
+/** Returns true if the given value is TDependent. */
+export function IsDependent(value) {
+    return IsKind(value, 'Dependent');
+}
+// ------------------------------------------------------------------
+// Options
+// ------------------------------------------------------------------
+/** Extracts options from a IsDependent. */
+export function DependentOptions(type) {
+    return Memory.Discard(type, ['~kind', 'if', 'then', 'else']);
+}

package/build/type/types/enum.d.mts

@@ -2,7 +2,7 @@ import { type TSchema, type TSchemaOptions } from './schema.mjs';
 import { type TTypeScriptEnumLike } from '../engine/enum/typescript_enum_to_enum_values.mjs';
 import { type TTypeScriptEnumToEnumValues } from '../engine/enum/typescript_enum_to_enum_values.mjs';
 export type StaticEnum<Values extends TEnumValue[]> = (Values[number]);
-export type TEnumValue = string | number | null;
+export type TEnumValue = string | number;
 /** Represents an Enum type. */
 export interface TEnum<Values extends TEnumValue[] = TEnumValue[]> extends TSchema {
     '~kind': 'Enum';

package/build/type/types/index.d.mts

@@ -17,6 +17,7 @@ export * from './enum.mjs';
 export * from './function.mjs';
 export * from './generic.mjs';
 export * from './identifier.mjs';
+export * from './dependent.mjs';
 export * from './infer.mjs';
 export * from './integer.mjs';
 export * from './intersect.mjs';

package/build/type/types/index.mjs

@@ -23,6 +23,7 @@ export * from './enum.mjs';
 export * from './function.mjs';
 export * from './generic.mjs';
 export * from './identifier.mjs';
+export * from './dependent.mjs';
 export * from './infer.mjs';
 export * from './integer.mjs';
 export * from './intersect.mjs';

package/build/type/types/static.d.mts

@@ -10,6 +10,7 @@ import type { StaticCyclic, TCyclic } from './cyclic.mjs';
 import type { StaticEnum, TEnum, TEnumValue } from './enum.mjs';
 import type { StaticFunction, TFunction } from './function.mjs';
 import type { StaticInteger, TInteger } from './integer.mjs';
+import type { StaticDependent, TDependent } from './dependent.mjs';
 import type { StaticIntersect, TIntersect } from './intersect.mjs';
 import type { StaticIterator, TIterator } from './iterator.mjs';
 import type { StaticLiteral, TLiteral, TLiteralValue } from './literal.mjs';
@@ -37,7 +38,7 @@ export type StaticEvaluate<T> = {
     [K in keyof T]: T[K];
 } & {};
 export type StaticDirection = 'Encode' | 'Decode';
-export type StaticType<Stack extends string[], Direction extends StaticDirection, Context extends TProperties, This extends TProperties, Type extends TSchema> = (Type extends TCodec<infer Type extends TSchema, infer Decoded extends unknown> ? StaticCodec<Stack, Direction, Context, This, Type, Decoded> : Type extends TAny ? StaticAny : Type extends TArray<infer Items extends TSchema> ? StaticArray<Stack, Direction, Context, This, Type, Items> : Type extends TAsyncIterator<infer Type extends TSchema> ? StaticAsyncIterator<Stack, Direction, Context, This, Type> : Type extends Base<infer Value extends unknown> ? StaticBase<Value> : Type extends TBigInt ? StaticBigInt : Type extends TBoolean ? StaticBoolean : Type extends TConstructor<infer Parameters extends TSchema[], infer ReturnType extends TSchema> ? StaticConstructor<Stack, Direction, Context, This, Parameters, ReturnType> : Type extends TEnum<infer Values extends TEnumValue[]> ? StaticEnum<Values> : Type extends TFunction<infer Parameters extends TSchema[], infer ReturnType extends TSchema> ? StaticFunction<Stack, Direction, Context, This, Parameters, ReturnType> : Type extends TInteger ? StaticInteger : Type extends TIntersect<infer Types extends TSchema[]> ? StaticIntersect<Stack, Direction, Context, This, Types> : Type extends TIterator<infer Types extends TSchema> ? StaticIterator<Stack, Direction, Context, This, Types> : Type extends TLiteral<infer Value extends TLiteralValue> ? StaticLiteral<Value> : Type extends TNever ? StaticNever : Type extends TNull ? StaticNull : Type extends TNumber ? StaticNumber : Type extends TObject<infer Properties extends TProperties> ? StaticObject<Stack, Direction, Context, This, Properties> : Type extends TPromise<infer Type extends TSchema> ? StaticPromise<Stack, Direction, Context, This, Type> : Type extends TRecord<infer Key extends string, infer Value extends TSchema> ? StaticRecord<Stack, Direction, Context, This, Key, Value> : Type extends TCyclic<infer Defs extends TProperties, infer Ref extends string> ? StaticCyclic<Stack, Direction, Context, This, Defs, Ref> : Type extends TRef<infer Ref extends string> ? StaticRef<Stack, Direction, Context, This, Ref> : Type extends TString ? StaticString : Type extends TSymbol ? StaticSymbol : Type extends TTemplateLiteral<infer Pattern extends string> ? StaticTemplateLiteral<Pattern> : Type extends TThis ? StaticThis<Stack, Direction, Context, This> : Type extends TTuple<infer Items extends TSchema[]> ? StaticTuple<Stack, Direction, Context, This, Type, Items> : Type extends TUndefined ? StaticUndefined : Type extends TUnion<infer Types extends TSchema[]> ? StaticUnion<Stack, Direction, Context, This, Types> : Type extends TUnknown ? StaticUnknown : Type extends TUnsafe<infer Type extends unknown> ? StaticUnsafe<Type> : Type extends TVoid ? StaticVoid : XStatic<Type>);
+export type StaticType<Stack extends string[], Direction extends StaticDirection, Context extends TProperties, This extends TProperties, Type extends TSchema> = (Type extends TCodec<infer Type extends TSchema, infer Decoded extends unknown> ? StaticCodec<Stack, Direction, Context, This, Type, Decoded> : Type extends TAny ? StaticAny : Type extends TArray<infer Items extends TSchema> ? StaticArray<Stack, Direction, Context, This, Type, Items> : Type extends TAsyncIterator<infer Type extends TSchema> ? StaticAsyncIterator<Stack, Direction, Context, This, Type> : Type extends Base<infer Value extends unknown> ? StaticBase<Value> : Type extends TBigInt ? StaticBigInt : Type extends TBoolean ? StaticBoolean : Type extends TConstructor<infer Parameters extends TSchema[], infer ReturnType extends TSchema> ? StaticConstructor<Stack, Direction, Context, This, Parameters, ReturnType> : Type extends TEnum<infer Values extends TEnumValue[]> ? StaticEnum<Values> : Type extends TFunction<infer Parameters extends TSchema[], infer ReturnType extends TSchema> ? StaticFunction<Stack, Direction, Context, This, Parameters, ReturnType> : Type extends TDependent<infer If extends TSchema, infer Then extends TSchema, infer Else extends TSchema> ? StaticDependent<Stack, Direction, Context, This, If, Then, Else> : Type extends TInteger ? StaticInteger : Type extends TIntersect<infer Types extends TSchema[]> ? StaticIntersect<Stack, Direction, Context, This, Types> : Type extends TIterator<infer Types extends TSchema> ? StaticIterator<Stack, Direction, Context, This, Types> : Type extends TLiteral<infer Value extends TLiteralValue> ? StaticLiteral<Value> : Type extends TNever ? StaticNever : Type extends TNull ? StaticNull : Type extends TNumber ? StaticNumber : Type extends TObject<infer Properties extends TProperties> ? StaticObject<Stack, Direction, Context, This, Properties> : Type extends TPromise<infer Type extends TSchema> ? StaticPromise<Stack, Direction, Context, This, Type> : Type extends TRecord<infer Key extends string, infer Value extends TSchema> ? StaticRecord<Stack, Direction, Context, This, Key, Value> : Type extends TCyclic<infer Defs extends TProperties, infer Ref extends string> ? StaticCyclic<Stack, Direction, Context, This, Defs, Ref> : Type extends TRef<infer Ref extends string> ? StaticRef<Stack, Direction, Context, This, Ref> : Type extends TString ? StaticString : Type extends TSymbol ? StaticSymbol : Type extends TTemplateLiteral<infer Pattern extends string> ? StaticTemplateLiteral<Pattern> : Type extends TThis ? StaticThis<Stack, Direction, Context, This> : Type extends TTuple<infer Items extends TSchema[]> ? StaticTuple<Stack, Direction, Context, This, Type, Items> : Type extends TUndefined ? StaticUndefined : Type extends TUnion<infer Types extends TSchema[]> ? StaticUnion<Stack, Direction, Context, This, Types> : Type extends TUnknown ? StaticUnknown : Type extends TUnsafe<infer Type extends unknown> ? StaticUnsafe<Type> : Type extends TVoid ? StaticVoid : XStatic<Type>);
 /** Infers a static type from a TypeBox type using Parse logic. */
 export type StaticParse<Type extends TSchema, Context extends TProperties = {}, Result extends unknown = StaticType<[], 'Encode', Context, {}, Type>> = Result;
 /** Infers a static type from a TypeBox type using Decode logic. */

package/build/typebox.d.mts

@@ -17,7 +17,6 @@ export { Mapped, type TMapped, type TMappedDeferred } from './type/action/mapped
 export { Module, type TModule, type TModuleDeferred } from './type/action/module.mjs';
 export { NonNullable, type TNonNullable, type TNonNullableDeferred } from './type/action/non_nullable.mjs';
 export { Omit, type TOmit, type TOmitDeferred } from './type/action/omit.mjs';
-export { Options, type TOptions } from './type/action/options.mjs';
 export { Parameters, type TParameters, type TParametersDeferred } from './type/action/parameters.mjs';
 export { Partial, type TPartial, type TPartialDeferred } from './type/action/partial.mjs';
 export { Pick, type TPick, type TPickDeferred } from './type/action/pick.mjs';
@@ -26,6 +25,7 @@ export { Required, type TRequired, type TRequiredDeferred } from './type/action/
 export { ReturnType, type TReturnType, type TReturnTypeDeferred } from './type/action/return_type.mjs';
 export { type TUncapitalize, type TUncapitalizeDeferred, Uncapitalize } from './type/action/uncapitalize.mjs';
 export { type TUppercase, type TUppercaseDeferred, Uppercase } from './type/action/uppercase.mjs';
+export { Options, type TOptions, type TWith, With } from './type/action/with.mjs';
 export { Codec, Decode, DecodeBuilder, Encode, EncodeBuilder, IsCodec, type TCodec } from './type/types/_codec.mjs';
 export { Immutable, IsImmutable, type TImmutable } from './type/types/_immutable.mjs';
 export { IsOptional, Optional, type TOptional } from './type/types/_optional.mjs';
@@ -44,6 +44,7 @@ export { Enum, IsEnum, type TEnum, type TEnumValue } from './type/types/enum.mjs
 export { Function, IsFunction, type TFunction } from './type/types/function.mjs';
 export { Generic, IsGeneric, type TGeneric } from './type/types/generic.mjs';
 export { Identifier, IsIdentifier, type TIdentifier } from './type/types/identifier.mjs';
+export { Dependent, IsDependent, type TDependent } from './type/types/dependent.mjs';
 export { Infer, IsInfer, type TInfer } from './type/types/infer.mjs';
 export { Integer, IsInteger, type TInteger } from './type/types/integer.mjs';
 export { Intersect, IsIntersect, type TIntersect } from './type/types/intersect.mjs';

package/build/typebox.mjs

@@ -29,7 +29,6 @@ export { Mapped } from './type/action/mapped.mjs';
 export { Module } from './type/action/module.mjs';
 export { NonNullable } from './type/action/non_nullable.mjs';
 export { Omit } from './type/action/omit.mjs';
-export { Options } from './type/action/options.mjs';
 export { Parameters } from './type/action/parameters.mjs';
 export { Partial } from './type/action/partial.mjs';
 export { Pick } from './type/action/pick.mjs';
@@ -38,6 +37,7 @@ export { Required } from './type/action/required.mjs';
 export { ReturnType } from './type/action/return_type.mjs';
 export { Uncapitalize } from './type/action/uncapitalize.mjs';
 export { Uppercase } from './type/action/uppercase.mjs';
+export { Options, With } from './type/action/with.mjs';
 // ------------------------------------------------------------------
 // Extension
 // ------------------------------------------------------------------
@@ -62,6 +62,7 @@ export { Enum, IsEnum } from './type/types/enum.mjs';
 export { Function, IsFunction } from './type/types/function.mjs';
 export { Generic, IsGeneric } from './type/types/generic.mjs';
 export { Identifier, IsIdentifier } from './type/types/identifier.mjs';
+export { Dependent, IsDependent } from './type/types/dependent.mjs';
 export { Infer, IsInfer } from './type/types/infer.mjs';
 export { Integer, IsInteger } from './type/types/integer.mjs';
 export { Intersect, IsIntersect } from './type/types/intersect.mjs';

package/build/value/clean/from_intersect.mjs

@@ -1,5 +1,5 @@
 // deno-fmt-ignore-file
-import { Evaluate, Instantiate, IsObject, Options } from '../../type/index.mjs';
+import { Evaluate, Instantiate, IsObject, With } from '../../type/index.mjs';
 import { Guard } from '../../guard/index.mjs';
 import { FromType } from './from_type.mjs';
 // ------------------------------------------------------------------
@@ -13,7 +13,7 @@ function EvaluateIntersection(context, type) {
     const instantiated = Instantiate(context, type);
     const evaluated = Evaluate(instantiated);
     return IsObject(evaluated)
-        ? Options(evaluated, additionalProperties)
+        ? With(evaluated, additionalProperties)
         : evaluated;
 }
 // ------------------------------------------------------------------

package/build/value/clone/clone.mjs

@@ -1,5 +1,6 @@
 // deno-fmt-ignore-file
 import { Guard, GlobalsGuard } from '../../guard/index.mjs';
+import { Clone as SystemClone } from '../../system/memory/clone.mjs';
 // ------------------------------------------------------------------
 // ClassInstance
 //
@@ -14,6 +15,19 @@ function FromClassInstance(value) {
     return value; // atomic
 }
 // ------------------------------------------------------------------
+// TypeInstance
+//
+// TypeBox types have non-enumerable properties that should be
+// retained on Clone. We need to use a SystemClone for this
+// to ensure the non-enumerable properties are preserved.
+// ------------------------------------------------------------------
+function IsTypeInstance(value) {
+    return Guard.HasPropertyKey(value, '~kind');
+}
+function FromTypeInstance(value) {
+    return SystemClone(value);
+}
+// ------------------------------------------------------------------
 // ObjectInstance
 // ------------------------------------------------------------------
 function FromObjectInstance(value) {
@@ -32,9 +46,9 @@ function FromObjectInstance(value) {
 // Object
 // ------------------------------------------------------------------
 function FromObject(value) {
-    return (Guard.IsClassInstance(value)
-        ? FromClassInstance(value)
-        : FromObjectInstance(value));
+    return (Guard.IsClassInstance(value) ? FromClassInstance(value) :
+        IsTypeInstance(value) ? FromTypeInstance(value) :
+            FromObjectInstance(value));
 }
 // ------------------------------------------------------------------
 // Array

package/build/value/convert/from_enum.mjs

@@ -1,7 +1,6 @@
 // deno-fmt-ignore-file
-import { EnumToUnion } from '../../type/engine/enum/index.mjs';
-import { FromUnion } from './from_union.mjs';
+import { Evaluate } from '../../type/index.mjs';
+import { FromType } from './from_type.mjs';
 export function FromEnum(context, type, value) {
-    const union = EnumToUnion(type);
-    return FromUnion(context, union, value);
+    return FromType(context, Evaluate(type), value);
 }

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

@@ -1,2 +1,2 @@
-import type { TTemplateLiteral, TProperties } from '../../type/index.mjs';
+import { type TTemplateLiteral, type TProperties } from '../../type/index.mjs';
 export declare function FromTemplateLiteral(context: TProperties, type: TTemplateLiteral, value: unknown): unknown;

package/build/value/convert/from_template_literal.mjs

@@ -1,7 +1,6 @@
 // deno-fmt-ignore-file
-import { TemplateLiteralDecode } from '../../type/engine/template_literal/index.mjs';
+import { Evaluate } from '../../type/index.mjs';
 import { FromType } from './from_type.mjs';
 export function FromTemplateLiteral(context, type, value) {
-    const decoded = TemplateLiteralDecode(type.pattern);
-    return FromType(context, decoded, value);
+    return FromType(context, Evaluate(type), value);
 }

package/build/value/create/from_enum.mjs

@@ -1,6 +1,6 @@
 // deno-fmt-ignore-file
-import { EnumToUnion } from '../../type/engine/enum/index.mjs';
+import { Evaluate } from '../../type/index.mjs';
 import { FromType } from './from_type.mjs';
 export function FromEnum(context, type) {
-    return FromType(context, EnumToUnion(type));
+    return FromType(context, Evaluate(type));
 }

package/build/value/repair/from_enum.mjs

@@ -1,7 +1,6 @@
 // deno-fmt-ignore-file
-import { EnumToUnion } from '../../type/engine/enum/index.mjs';
+import { Evaluate } from '../../type/index.mjs';
 import { FromType } from './from_type.mjs';
 export function FromEnum(context, type, value) {
-    const union = EnumToUnion(type);
-    return FromType(context, union, value);
+    return FromType(context, Evaluate(type), value);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typebox",
   "description": "Json Schema Type Builder with Static Type Resolution for TypeScript",
-  "version": "1.1.39",
+  "version": "1.2.0",
   "keywords": [
     "typescript",
     "jsonschema"

package/readme.md

@@ -50,7 +50,7 @@ type T = Type.Static<typeof T>              // type T = {
 
 [Documentation](https://sinclairzx81.github.io/typebox/)
 
-TypeBox is a runtime type system that creates in-memory JSON Schema objects that infer as TypeScript types. The schematics produced by this library are designed to match the static type checking rules of the TypeScript compiler. TypeBox offers a unified type system that can be statically checked by TypeScript and validated at runtime using standard JSON Schema.
+TypeBox is a runtime type system that creates in-memory JSON Schema objects that infer as TypeScript types. The schematics produced by this library are designed to match the static type checking rules of the TypeScript compiler. TypeBox offers a unified type that can be statically checked by TypeScript and validated at runtime using standard JSON Schema.
 
 This library is designed to allow JSON Schema to compose similar to how types compose within TypeScript's type system. It can be used as a simple tool to build up complex schematics or integrated into REST and RPC services to help validate data received over the wire.
 
@@ -113,11 +113,11 @@ type User = Type.Static<typeof User>              // type User = {
 
 [Documentation](https://sinclairzx81.github.io/typebox/#/docs/script/overview) | [Example 1](https://www.typescriptlang.org/play/#code/JYWwDg9gTgLgBAFQJ5gKZwGZQiOByGFVAIwgA88AoSgehrgFonmXW32POvueHb6AygGMowMDH6Ne0mbLnNqQiADsAzvADecAKqrUUADQ69UbWAAmAQxjoAvnAC8iIgDpho8QAoABtThxgZRsoDEshdABRIOBCOA1Kf39gcwAuOHVRZQBzBLhbPwCg-VDw4304VDIbZXNVOCiYGKQ4uFz-ZUsQVDSMwKyjNoqQS2AAGx6YTKzW-3zcwjQy0wtrdCcIgDdLUYBXVYAeQYAFYCEAa33dfSMz1CQIDHrowgA+OAAyGcSjy1hgbf2AHkQDFLiYbncHk9Gq8Xrk4ZRvABKah0KTyDGYzGSABKqAwo1QQgkaKxZPJvEUKlUEEJLlGECyniuUCRiXZHM5XK5aPi3P5AsFgrR-gW3XwEGIACsiTA8AZBkKlcrOSK4GBsGg-qhVGk+SqDYa1UlUi0xWk8L1sng8grDfblca4B0unq4Ob8FasjbbHaHf7+U7UMMxm6PZbJn0fYqA7G4GrfTG4-61VBUABHHbANOmgDaSeT9qdeGS8q+hdjxZdqDLBYrKuLwZGoyo9cr9H8AF0622hWi5ko1LTUPTGcyTGYrDY2YXeT3ewK1eHJTLifL5wvuWqNRAtY0dXqN5vVR3Eskw0QLV6fX7jw3T+1OuKtOHr7aj3fEkGQ+MzZfPZG1p5B+n7xqeiagY6p5ppm2aoHmJbmHg3aQUq-aovQFJYdhLCSAIMDWKckg4SRFLUGKSyOM4aBuARjRCPsYpQiybxofQFEslR+qocKp7nukgH9CBoFqtWExTLePGBqeTahgJUzCZ+6GUBxE4rDYVHIDR+GEQxTGPCyk6rKxaKqfoRkaU43FSVufGml6kk2SeiTVgA-OJfSOU57JqrJozufJfSKXe6FAA) | [Example 2](https://www.typescriptlang.org/play/#code/JYWwDg9gTgLgBAFQJ5gKZwGZQiOByGFVAIwgA88AoSgehrgFonmXW32POvnb7k1ejbsJGj21AMYQAdgGd4AUWkxghOAF5ERAHQBJZaigYAhhNQAKANoBdADRwA3pThxgAEwBcWtNoDKMKGBpAHNzAEpKAF8Iyik5eABVWUMNb1Q9AyNTC0slFUI7R2c4aWMQVC9+dP9AkPDbYtQQY2AAG0qdGqDQiOjJGXk4JMMEsDdjGHRNKu0FADdjVoBXCYsZ-UmoZIkYK2KZgAVgCQBrc2GoexmAaVQkAHkMczzVJDCwhpdD41hgRfMZvcQKpzslLmltLcHk8XoR3hFrO9qHQhGI0eiMdxBAAlVAYVqoHaCTEk0mY-pyCAE7StCChC5hFxM5ks1lslkopzs7k83m8lEuQhoLx4CDEABWhJgeE+fLl8u5ArgYGwaF+qFkXi5Cp1uqVLncWrgQoq+HktWCeDgkVlurtfP1JTKpocxqIIvN3StNuK9r97MdTRa7UcbuFZoCXutvv9saZSp9caTLiVUFQAEclsA0544JYY8m-Y68O4ZXAC4W7cXSuUyxXKzri0G2lQG-6ldZ6225SjIhTZFT0rT6WDRuNJozk5yu93+fRBe78GLJTsZTPZ4r58rVYYVBqteuN2zHYbQyaPZGQt7bUee1uXDWXWHTXhPVfrTfb3OWc2Q67zxGFreoeX7xluiagQ6W5ppm2aoLmlglm4eCdpBUHRsSZJYdhnCCP4EzHJhOHEcR1AmkMYKpDM+EqBIAA8JoQBgFGGAAfPKKLkRcqTamhPJKqeb7BJ+fGskqj5eEJImicySq-pJl7BCBaG9mRRAsVAY6rFRnQwAR9GMcxFxaZM7FwJx6nGWM2maLxMliVugmKdJ9nmVuj4APwKRaLn2XJzRtF5cBCcpkG9kAA)
 
-The TypeBox Script function is a micro DSL for constructing JSON Schema from TypeScript syntax. It offers a full syntactic frontend to Type.* with broad support for type-level expressions including Conditional, Mapped, Infer, Generic, Distributive types and more. This feature is implemented symmetrically at both runtime and in the type system.
+TypeBox includes a micro DSL for composing JSON Schema with TypeScript syntax. The DSL offers a full syntactic frontend to Type.* and supports many advanced type-level constructs such as Conditional, Mapped, Indexed, Infer, Generics, Distributed types and more. This feature is implemented symmetrically at runtime and statically via TypeScript Template Literal types.
 
 ### Example
 
-The following uses the Script function to parse TypeScript interfaces into JSON Schema.
+The following uses Script to parse a TypeScript definition module into JSON Schema.
 
 ```typescript
 import Type from 'typebox'
@@ -189,35 +189,66 @@ type UserUpdate = Type.Static<typeof UserUpdate>  // type UserUpdate = {
 
 ## Schema
 
-[Documentation](https://sinclairzx81.github.io/typebox/#/docs/schema/overview) | [Example 1](https://www.typescriptlang.org/play/?#code/JYWwDg9gTgLgBAZQMYAsCmICGcBmUIhwDkMAnmGgEYQAeA9AM6oaZEBQokscAKuWrnyES-ajXZs6dOAFo58hYqXKVqteo0zJ0gMIEwwADZptszeYuWr8tmyQQAdg3gBVBmihwAvImZYAdHrgRmgAFHwU-gDylABWaEgwoQDebHBwwAAmAFy8-P4IMFDADgDmoQCUADRpcA6YIGi5EWgFRSXl1bUsRs35hcVlKbjQWDC5RD2GRHAAvhVs8wum1qtr61pScAAKmFDuKxtHx6q29k7wAK7unj5uHv67+2HJ6W-vH5-vW+fOcNceXKpdJZCYANgArDgAIyYABMlAAzEgACyZCFoME4ADsmAAHJQAJxIAAMmWhRCqX2pcC2IJycGcg1KNXS9UaEwBUEpNN5fO+0jZDSajPaZVZcCmnJuAAFMgRMCV-PYQDN+by6ZKsL1RczFhV1YajR8trNvHB-JagA) | [Example 2](https://www.typescriptlang.org/play/#code/JYWwDg9gTgLgBAZQMYAsCmICGcBmUIhwDkMAnmGgEYQAeA9AM6oaZEBQbddcAtH-wMFDhI0WPESenbgGECYYABs003pPUbNW-hyQQAdg3gBVBmihwAvImZYAdHPBK0ACgDebOHDIUAXMQhKACs0JBgiABpPODB8ClhgNAZ-Dy8vYAATFO9yNH8iIyhgfQBzIjgAXyi0uH1MEDy4Nxy-YkLissrqtJYlbJ9Ggpgi0sjcaCwYfN7FcoroquioNABHAFdgZay4AG1oryJMsf3iOobjmqIZ9i8AXTYKgEoOLjVtd4+P1QAFTCgzVSfIHAyS6AxGOBrMwWaymcx2X7-VzNGqotHouCvPSGeBQ8wpaKZfIANgArDgAIyYABMlAAzEgACwZUloYk4ADsmAAHJQAJxIAAMGQpYwx6Ne6W27VK3TOgzxUDF4pVqq8ktq9UaMpK3Rm+UVAAEMgRMMU7HoQOU1SqNfq4DqHo8bS7XajXhUrHA7D6gA) | [Specification](https://sinclairzx81.github.io/typebox/#/docs/schema/1_spec)
+[Documentation](https://sinclairzx81.github.io/typebox/#/docs/schema/overview) | [Example 1](https://www.typescriptlang.org/play/#code/JYWwDg9gTgLgBAZQMYAsCmICGcBmUIhwDkMAnmGgEYQAeA9AM6oaZEBQbddcAtH-wMFDhI0WPESenbgGECYYABs003pPUbNW-hyQQAdg3gBVBmihwAvImZYAdHPBK0ACgDebOHDIUAXMQhKACs0JBgiABpPODB8ClhgNAZ-Dy8vYAATFO9yNH8iIyhgfQBzIjgAXyi0uH1MEDy4Nxy-YkLissrqtJYlbJ9Ggpgi0sjcaCwYfN7FcoroquioNABHAFdgZay4AG1oryJMsf3iOobjmqIZ9i8AXTYKgEoOLjVtd4+P1QAFTCgzVSfIHAyS6AxGOBrMwWaymcx2X7-VzNGqotHouCvPSGeBQ8wpaKZfIANgArDgAIyYABMlAAzEgACwZUloYk4ADsmAAHJQAJxIAAMGQpYwx6Ne6W27VK3TOgzxUDF4pVqq8ktq9UaMpK3Rm+UVAAEMgRMMU7HoQOU1SqNfq4DqHo8bS7XajXhUrHA7D6gA) | [Example 2](https://www.typescriptlang.org/play/?#code/JYWwDg9gTgLgBAZQMYAsCmICGcBmUIhwDkMAnmGgEYQAeA9AM6oaZEBQokscAKuWrnyES-ajXZs6dOAFo58hYqXKVqteo0zJ0gMIEwwADZptszeYuWr8tmyQQAdg3gBVBmihwAvImZYAdHrgRmgAFHwU-gDylABWaEgwoQDebHBwwAAmAFy8-P4IMFDADgDmoQCUADRpcA6YIGi5EWgFRSXl1bUsRs35hcVlKbjQWDC5RD2GRHAAvhVs8wum1qtr61pScAAKmFDuKxtHx6q29k7wAK7unj5uHv67+2HJ6W-vH5-vW+fOcNceXKpdJZCYANgArDgAIyYABMlAAzEgACyZCFoME4ADsmAAHJQAJxIAAMmWhRCqX2pcC2IJycGcg1KNXS9UaEwBUEpNN5fO+0jZDSajPaZVZcCmnJuAAFMgRMCV-PYQDN+by6ZKsL1RczFhV1YajR8trNvHB-JagA)
 
-TypeBox includes a high-performance JSON Schema compiler with support for drafts 3 through to 2020-12. The compiler is designed to be a lightweight industry-grade alternative to Ajv and offers improved compilation and validation performance. The compiler also offers automatic fallback to dynamic checking in JIT-restricted environments such as Cloudflare Workers.
+TypeBox includes a high-performance JIT compiler that supports JSON Schema Draft 3 through to 2020-12. It is designed to be a lightweight industry-grade alternative to Ajv and offers improved compilation and validation performance. It also provides automatic fallback to dynamic validation in JIT restricted environments such as Cloudflare Workers.
 
-### Example
-
-The following uses the Schema submodule to compile a TypeBox type.
+The compiler is available via optional sub module import.
 
 ```typescript
 import Schema from 'typebox/schema'
+```
 
-// Compile
+### Compile
 
-const User = Schema.Compile(Type.Object({        // const User = Validator<Type.TObject<{
-  id: Type.String(),                             //   id: Type.TString;
-  name: Type.String(),                           //   name: Type.TString;
-  email: Type.String({ format: 'email' })        //   email: Type.TString;
-}))                                              // }>, { ... }>
+The compiler accepts JSON Schema and returns Validator instances.
+
+```typescript
+const Vector = Schema.Compile(Type.Object({       // const Vector: Validator<TObject<{
+  x: Type.Number(),                                //   x: TNumber
+  y: Type.Number(),                                //   y: TNumber
+  z: Type.Number()                                 //   z: TNumber
+}))                                                // }>>
+```
+With JSON Schema
+```typescript
+const Vector = Schema.Compile({                    // const Vector: Validator<{
+  type: 'object',                                  //   type: "object";
+  required: ['x', 'y', 'z'],                       //   required: ["x", "y", "z"];
+  properties: {                                    //   properties: { ... };
+    x: { type: 'number' },                         // }, { ... }>
+    y: { type: 'number' },
+    z: { type: 'number' }
+  }
+})
+```
 
-// Parse
+### Validate
 
-const user = User.Parse({                        // const user: {
-  id: '65f1a2b3c4d5e6f7a8b9c0d1',                //   id: string,
-  name: 'user',                                  //   name: string,
-  email: 'user@domain.com'                       //   email: string
-})                                               // } = ...
+Validator instances provide functions to Check and Parse values.
 
+```typescript
+const Vector = Schema.Compile(Type.Script(`{
+  x: number
+  y: number
+  z: number
+}`))
+
+const valid = Vector.Check({                       // const valid: boolean
+  x: 1,
+  y: 0,
+  z: 0
+}) 
+
+const value = Vector.Parse({                       // const value: {      
+  x: 1,                                            //   x: number
+  y: 0,                                            //   y: number
+  z: 0                                             //   z: number
+})                                                 // }
 ```
 
+
+
 ### Coverage
 
 The following table shows specification coverage implemented by TypeBox.

package/build/type/action/options.d.mts

@@ -1,11 +0,0 @@
-import { type TSchema } from '../types/schema.mjs';
-import { type TDeferred } from '../types/deferred.mjs';
-import { type TOptionsAction } from '../engine/options/instantiate.mjs';
-/** Creates a deferred Options action. */
-export type TOptionsDeferred<Type extends TSchema, Options extends TSchema> = (TDeferred<'Options', [Type, Options]>);
-/** Creates a deferred Options action. */
-export declare function OptionsDeferred<Type extends TSchema, Options extends TSchema>(type: Type, options: Options): TOptionsDeferred<Type, Options>;
-/** Applies an immediate Options action to the given type. */
-export type TOptions<Type extends TSchema, Options extends TSchema> = (Type & Options);
-/** Applies an immediate Options action to the given type. */
-export declare function Options<Type extends TSchema, const Options extends TSchema>(type: Type, options: Options): TOptionsAction<Type, Options>;

package/build/type/action/options.mjs

@@ -1,11 +0,0 @@
-// deno-fmt-ignore-file
-import { Deferred } from '../types/deferred.mjs';
-import { OptionsAction } from '../engine/options/instantiate.mjs';
-/** Creates a deferred Options action. */
-export function OptionsDeferred(type, options) {
-    return Deferred('Options', [type, options], {});
-}
-/** Applies an immediate Options action to the given type. */
-export function Options(type, options) {
-    return OptionsAction(type, options);
-}

package/build/type/engine/enum/enum_to_union.d.mts

@@ -1,14 +0,0 @@
-import { type TSchema } from '../../types/schema.mjs';
-import { type TEnum, type TEnumValue } from '../../types/enum.mjs';
-import { type TUnion } from '../../types/union.mjs';
-import { type TLiteral } from '../../types/literal.mjs';
-import { type TNull } from '../../types/null.mjs';
-import { type TNever } from '../../types/never.mjs';
-type TFromEnumValue<Value extends TEnumValue, Result extends TSchema = Value extends string | number ? TLiteral<Value> : Value extends null ? TNull : TNever> = Result;
-export type TEnumValuesToVariants<Values extends TEnumValue[], Result extends TSchema[] = []> = (Values extends [infer Left extends TEnumValue, ...infer Right extends TEnumValue[]] ? TEnumValuesToVariants<Right, [...Result, TFromEnumValue<Left>]> : Result);
-export declare function EnumValuesToVariants<Values extends TEnumValue[]>(values: [...Values]): TEnumValuesToVariants<Values>;
-export type TEnumValuesToUnion<Values extends TEnumValue[], Variants extends TSchema[] = TEnumValuesToVariants<Values>, Results extends TSchema = TUnion<Variants>> = Results;
-export declare function EnumValuesToUnion<Values extends TEnumValue[]>(values: [...Values]): TEnumValuesToUnion<Values>;
-export type TEnumToUnion<Type extends TEnum, Result extends TSchema = TEnumValuesToUnion<Type['enum']>> = Result;
-export declare function EnumToUnion<Type extends TEnum>(type: Type): TEnumToUnion<Type>;
-export {};

package/build/type/engine/enum/enum_to_union.mjs

@@ -1,24 +0,0 @@
-// deno-fmt-ignore-file
-import { Guard } from '../../../guard/index.mjs';
-import { Union } from '../../types/union.mjs';
-import { Literal } from '../../types/literal.mjs';
-import { Null } from '../../types/null.mjs';
-import { Never } from '../../types/never.mjs';
-function FromEnumValue(value) {
-    return (Guard.IsString(value) || Guard.IsNumber(value) ? Literal(value) :
-        Guard.IsNull(value) ? Null() :
-            Never());
-}
-export function EnumValuesToVariants(values) {
-    const result = values.map(value => FromEnumValue(value));
-    return result;
-}
-export function EnumValuesToUnion(values) {
-    const variants = EnumValuesToVariants(values);
-    const result = Union(variants);
-    return result;
-}
-export function EnumToUnion(type) {
-    const result = EnumValuesToUnion(type.enum);
-    return result;
-}

package/build/type/engine/options/instantiate.d.mts

@@ -1,8 +0,0 @@
-import { type TProperties } from '../../types/properties.mjs';
-import { type TSchema } from '../../types/schema.mjs';
-import { type TState, type TInstantiateType, type TCanInstantiate } from '../instantiate.mjs';
-import { type TOptionsDeferred, type TOptions } from '../../action/options.mjs';
-export type TOptionsAction<Type extends TSchema, Options extends TSchema, Result extends TSchema = TCanInstantiate<[Type]> extends true ? TOptions<Type, Options> : TOptionsDeferred<Type, Options>> = Result;
-export declare function OptionsAction<Type extends TSchema, Options extends TSchema>(type: Type, options: Options): TOptionsAction<Type, Options>;
-export type TOptionsInstantiate<Context extends TProperties, State extends TState, Type extends TSchema, Options extends TSchema, InstantiatedType extends TSchema = TInstantiateType<Context, State, Type>> = TOptionsAction<InstantiatedType, Options>;
-export declare function OptionsInstantiate<Context extends TProperties, State extends TState, Type extends TSchema, Options extends TSchema>(context: Context, state: State, type: Type, options: Options): TOptionsInstantiate<Context, State, Type, Options>;