@depup/typebox 1.1.23-depup.0 → 1.3.8-depup.0

package/readme.md

@@ -43,13 +43,14 @@ type T = Type.Static<typeof T>              // type T = {
                                             //   y: number,
                                             //   z: number
                                             // }
+
 ```
 
 ## Overview
 
 [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 runtime checked using standard JSON Schema validation.
 
 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.
 
@@ -72,16 +73,14 @@ License: MIT
 
 TypeBox types are JSON Schema fragments that compose into more complex types. The library offers a set of types used to construct JSON Schema compliant schematics as well as a set of extended types used to model constructs native to the JavaScript language. The schematics produced by TypeBox can be passed directly to any JSON Schema compliant validator.
 
-## Example
+### Example
 
 The following creates a User type and infers with Static.
 
 ```typescript
 import Type from 'typebox'
 
-// -------------------------------------------------------------------------------
 // Type
-// -------------------------------------------------------------------------------
 
 const User = Type.Object({                       // const User = {
   id: Type.String(),                             //   type: 'object',
@@ -92,7 +91,7 @@ const User = Type.Object({                       // const User = {
                                                  //       type: 'string', 
                                                  //       format: 'email' 
                                                  //     }
-                                                 //   }
+                                                 //   },
                                                  //   required: [
                                                  //     'id', 
                                                  //     'name', 
@@ -100,139 +99,259 @@ const User = Type.Object({                       // const User = {
                                                  //   ]
                                                  // }
 
-// -------------------------------------------------------------------------------
 // Static
-// -------------------------------------------------------------------------------
 
 type User = Type.Static<typeof User>              // type User = {
                                                   //   id: string,
                                                   //   name: string,
                                                   //   email: string
                                                   // }
+
 ```
 
 ## Script
 
-[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)
+[Documentation](https://sinclairzx81.github.io/typebox/#/docs/script/overview) | [Example 1](https://www.typescriptlang.org/play/?target=99&module=7#code/JYWwDg9gTgLgBAFQJ5gKZwGZQiOByGFVAIwgA88AoSgehrgFkIATAVwBtVKBjCAOwDO8AN5wAChCFwAvnAC8iIgDoAytyjAwMABQADSnDiE0cAKoDUUeXGEHDcYMwBccPqxDFLAGjuG+AQxBUFyENPgBzO2k7Y3QAYRwgvngFW3sHZ1d3TygfdJhUMhgQmDDwvPt-VhgAC2gXc0somKJxSRSbXwyXNw9vLphgGE4SsorDUmYkUeAI8bgq2vqzC1yu3hAkmAEXBM3UZIBtAF1m3QBKajo4ACVUDE5uQf5KCSElMGw0WGBUASVHK92h8vpZBn8lINhlw3jAQRBvuD-os6lB4Yjfv9AbD0WDMUoUdBcT8IQEgkD3p8EXiIRstliCiB-lSMRCCkUKXCWTT-nSDtsAYzmaCScjqqjiUiAcxOZL8XzkgzUEy5RDCWjuaKlGSuLR6ABJPgYSwHbhcDCsPhPYD8OCfP787SQIQuZBoVQwfyDbgAHliEAwbSEAD5zp1DM64YCI8CoZw7JGCeKidG7cD1drAlwY+8FdtDgAGY6QwowBPAvMCQvFjOpxOV6tJpZonWUaRAA) | [Example 2](https://www.typescriptlang.org/play/?target=99&module=7#code/JYWwDg9gTgLgBAFQJ5gKZwGZQiOByGFVAIwgA88AoSgehrgFkIATAVwBtVKBjCAOwDO8AKoDUUOAF5ERAHQB5YgCtU3GAAoA3pThxgzAFwy0sgHKsQxceoCUAGh1w+AQxCojyEwGUYUYHwBzW0oAXxsefiE4AGEcNz54aU9UBWVVDW1dfQ85c0tre0cYVDIYHO9ffyDC3WdWGAALaCNRcVDw3kF4AAUIKKS5RRU1LUds4xS8qyhbB10YYBhOcpSfP0DZx1JmJBXZNarN2vqmqBaxKDm4XhB4mAE9gEEoKGckdVjb1ATwsOo6OAAJVQGE4amA-EovSEsjA2DQsGAqAEsn0UL6MFh8PEC2RsgWSy40MxcIgCNxKLqjWgWLJOKRKLRxNp5IZsippxZ9LxLjc6JhpNZeJud0ZxRAKMF3JRxVK-JJ2MRwri33uqPFksVFPZJxpUqVjOY8q5BtkItVYtQEpN2o5eq1bN5XFo9AAknwMOJvtwuBhWHxwfw4HDkar1JAhHsfM4FtwADyENAQDBwYkAPhscEywYxqKNugjmIJnEchZ11KgedLubtlad1Zh5oSAgA2gAGAC6+JKMAbmKb93bXdrVYLuYHrc75c59ZCQA) | [Challenge](test/typescript/readme.md)
 
-TypeBox can transform TypeScript definitions into JSON Schema. The Script function provides an optional programmatic syntax to rapidly convert type definitions into JSON Schema, or serve more generally as an alternative to Type.* builders. The Script function is designed to handle a wide array of complex TypeScript type-level expressions.
+TypeBox includes a runtime TypeScript engine that can transform TypeScript definitions to JSON Schema. The engine is fully type-safe and supports many programmable constructs including Conditional, Mapped, Indexed, Generics, Distributive Generics, and more.
 
 ### Example
 
-The following uses the Script function to parse TypeScript interfaces into JSON Schema.
+Syntax highlighting is available via the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sinclairzx81.typebox-script)
 
 ```typescript
-import Type from 'typebox'
-
-// -------------------------------------------------------------------------------
-// Script
-// -------------------------------------------------------------------------------
-
-const { User, UserUpdate } = Type.Script(`
-
-  interface Entity {
-    id: string
+// Module
+const { Post } = Type.Script(`
+  type User = {
+    id: number,
+    name: string
   }
-
-  interface User extends Entity { 
-    name: string, 
-    email: string 
+  type Comment = {
+    id: number,
+    text: string,
+    author: User
   }
+  type Post = {
+    id: number,
+    title: string,
+    body: string,
+    author: User,
+    comments: Comment[]
+  }
+`)
 
-  type UserUpdate = Evaluate<
-    Pick<User, keyof Entity> & 
-    Partial<Omit<User, keyof Entity>>
-  >
+// Reflection
+Post.properties.id
+Post.properties.title
+Post.properties.author.properties.id
+Post.properties.author.properties.name
+Post.properties.comments.items.properties.text
+Post.properties.comments.items.properties.author.properties.id
+Post.properties.comments.items.properties.author.properties.name
+
+// Inference
+function present(post: Type.Static<typeof Post>) {
+  post.id
+  post.title
+  post.author.id
+  post.author.name
+  post.comments[0].text
+  post.comments[0].author.id
+  post.comments[0].author.name
+}
+```
 
-`)
+<a name="Schema"></a>
 
-// -------------------------------------------------------------------------------
-// Reflect
-// -------------------------------------------------------------------------------
+## Schema
 
-console.log(User)                                // {
-                                                 //   type: 'object',
-                                                 //   properties: {
-                                                 //     id: { type: 'string' },
-                                                 //     name: { type: 'string' },
-                                                 //     email: { type: 'string' }
-                                                 //   },
-                                                 //   required: [
-                                                 //     'id', 
-                                                 //     'name', 
-                                                 //     'email'
-                                                 //   ]
-                                                 // }
+[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)
 
-console.log(UserUpdate)                          // {
-                                                 //   type: 'object',
-                                                 //   properties: {
-                                                 //     id: { type: 'string' },
-                                                 //     name: { type: 'string' },
-                                                 //     email: { type: 'string' }
-                                                 //   },
-                                                 //   required: ['id']
-                                                 // }
+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.
 
-// -------------------------------------------------------------------------------
-// Static
-// -------------------------------------------------------------------------------
+The compiler is available via optional sub module import.
 
-type User = Type.Static<typeof User>              // type User = {
-                                                  //   id: string,
-                                                  //   name: string,
-                                                  //   email: string
-                                                  // }
+```typescript
+import Schema from 'typebox/schema'
+```
 
-type UserUpdate = Type.Static<typeof UserUpdate>  // type UserUpdate = {
-                                                  //   id: string,
-                                                  //   name?: string,
-                                                  //   email?: string
-                                                  // }
+### Compile
+
+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' }
+  }
+})
 ```
 
-<a name="Schema"></a>
+### Validate
 
-## Schema
+Validator instances provide functions to Check and Parse values.
 
-[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/6_specification)
+```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
+})                                                 // }
+```
 
-TypeBox includes a JSON Schema compiler designed for high-performance JIT validation. It also provides automatic fallback to dynamic interpreted checking for JIT restrictive environments such as Cloudflare Workers. The compiler is designed to be a lightweight, spec compliant alternative to Ajv for high-throughput applications based on the JSON Schema standard.
 
-### Example
 
-The following uses the Schema submodule to compile a TypeBox type.
+### Coverage
+
+The following table shows specification coverage implemented by TypeBox.
+
+[JSON Schema Test Suite](https://github.com/json-schema-org/JSON-Schema-Test-Suite) 
+
+| Spec | 3 | 4 | 6 | 7 | 2019-09 | 2020-12 | v1 |
+|:-----|:--|:--|:--|:--|:--|:--|:--|
+| additionalItems | ✅ | ✅ | ✅ | ✅ | ✅ | - | - |
+| additionalProperties | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| allOf | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| anchor | - | - | - | - | ✅ | ✅ | ✅ |
+| anyOf | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| boolean_schema | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| const | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| contains | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| content | - | - | - | - | ✅ | ✅ | ✅ |
+| default | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| dependencies | 17/18 | ✅ | ✅ | ✅ | - | - | - |
+| dependentRequired | - | - | - | - | ✅ | ✅ | ✅ |
+| dependentSchemas | - | - | - | - | ✅ | ✅ | ✅ |
+| dynamicRef | - | - | - | - | - | 38/44 | 19/27 |
+| enum | 14/16 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| exclusiveMaximum | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| exclusiveMinimum | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| if-then-else | - | - | - | ✅ | ✅ | ✅ | ✅ |
+| infinite-loop-detection | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| items | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| maxContains | - | - | - | - | ✅ | ✅ | ✅ |
+| maximum | 13/14 | 13/14 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| maxItems | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| maxLength | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| maxProperties | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| minContains | - | - | - | - | ✅ | ✅ | ✅ |
+| minimum | 12/13 | 16/17 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| minItems | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| minLength | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| minProperties | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| multipleOf | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| not | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| oneOf | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| pattern | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| patternProperties | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| prefixItems | - | - | - | - | - | ✅ | ✅ |
+| properties | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| propertyNames | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| recursiveRef | - | - | - | - | ✅ | - | - |
+| ref | 22/27 | 37/45 | 67/70 | 75/78 | 79/81 | 77/79 | 77/79 |
+| required | 3/4 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| type | 73/80 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| unevaluatedItems | - | - | - | - | ✅ | ✅ | 70/71 |
+| unevaluatedProperties | - | - | - | - | ✅ | ✅ | 128/129 |
+| uniqueItems | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+
+
+### Performance
+
+The following table shows compile performance for various JSON Schema structures using AJV8 as a basis for comparison. 
+
+```python
+┌──────────────────────┬─────────────┬─────────────┐
+│ Compile              │ TB1X        │ AJV8        │
+├──────────────────────┼─────────────┼─────────────┤
+│ Boolean              │ 39.7K ops/s │  6.8K ops/s │
+│ Number               │ 86.2K ops/s │  7.5K ops/s │
+│ String               │ 82.6K ops/s │  8.2K ops/s │
+│ Null                 │   62K ops/s │  7.3K ops/s │
+│ Literal_String       │ 72.1K ops/s │  5.7K ops/s │
+│ Literal_Number       │ 72.7K ops/s │  6.9K ops/s │
+│ Literal_Boolean      │ 80.9K ops/s │    7K ops/s │
+│ Pattern              │ 38.7K ops/s │  5.7K ops/s │
+│ Object_Open          │ 16.3K ops/s │  1.3K ops/s │
+│ Object_Close         │ 15.7K ops/s │   952 ops/s │
+│ Object_Vector3       │ 40.2K ops/s │  3.2K ops/s │
+│ Object_Basis3        │ 16.1K ops/s │   834 ops/s │
+│ Intersect_And        │ 45.7K ops/s │  3.5K ops/s │
+│ Intersect_Structural │   21K ops/s │  1.6K ops/s │
+│ Union_Or             │ 45.1K ops/s │  3.4K ops/s │
+│ Union_Structural     │ 27.6K ops/s │    2K ops/s │
+│ Tuple_Values         │ 14.7K ops/s │    2K ops/s │
+│ Tuple_Objects        │  3.7K ops/s │   380 ops/s │
+│ Array_Numbers_4      │ 73.6K ops/s │  4.3K ops/s │
+│ Array_Numbers_8      │ 50.9K ops/s │  3.8K ops/s │
+│ Array_Numbers_16     │   85K ops/s │  3.9K ops/s │
+│ Array_Objects_Open   │ 18.9K ops/s │   789 ops/s │
+│ Array_Objects_Close  │ 17.9K ops/s │   909 ops/s │
+└──────────────────────┴─────────────┴─────────────┘
+```
 
-```typescript
-import Schema from 'typebox/schema'
 
-// -------------------------------------------------------------------------------
-// Compile
-// -------------------------------------------------------------------------------
-
-const User = Schema.Compile(Type.Object({
-  id: Type.String(),
-  name: Type.String(),
-  email: Type.String({ format: 'email' })
-}))
-
-// -------------------------------------------------------------------------------
-// Parse
-// -------------------------------------------------------------------------------
-
-const user = User.Parse({                        // const user: {
-  id: '65f1a2b3c4d5e6f7a8b9c0d1',                //   id: string,
-  name: 'user',                                  //   name: string,
-  email: 'user@domain.com'                       //   email: string
-})                                               // } = ...
+The following tables shows validation performance for various JSON Schema structures using AJV8 as a basis for comparison.
+
+```python
+┌──────────────────────┬──────────────┬──────────────┐
+│ Validate             │ TB1X         │ AJV8         │
+├──────────────────────┼──────────────┼──────────────┤
+│ Boolean              │ 192.2M ops/s │ 189.5M ops/s │
+│ Number               │ 112.4M ops/s │    61M ops/s │
+│ String               │ 113.7M ops/s │  64.1M ops/s │
+│ Null                 │ 112.8M ops/s │  64.9M ops/s │
+│ Literal_String       │   108M ops/s │  62.9M ops/s │
+│ Literal_Number       │ 113.5M ops/s │  63.2M ops/s │
+│ Literal_Boolean      │ 109.2M ops/s │  64.1M ops/s │
+│ Pattern              │  26.5M ops/s │  22.4M ops/s │
+│ Object_Open          │    78M ops/s │  47.2M ops/s │
+│ Object_Close         │  38.6M ops/s │  27.6M ops/s │
+│ Object_Vector3       │    91M ops/s │  51.3M ops/s │
+│ Object_Basis3        │  41.1M ops/s │  27.4M ops/s │
+│ Intersect_And        │ 107.6M ops/s │  59.9M ops/s │
+│ Intersect_Structural │  83.6M ops/s │  46.3M ops/s │
+│ Union_Or             │    95M ops/s │   7.9M ops/s │
+│ Union_Structural     │  84.5M ops/s │  52.3M ops/s │
+│ Tuple_Values         │  74.7M ops/s │    53M ops/s │
+│ Tuple_Objects        │  32.9M ops/s │  22.3M ops/s │
+│ Array_Numbers_4      │  93.3M ops/s │  55.1M ops/s │
+│ Array_Numbers_8      │  90.3M ops/s │  50.8M ops/s │
+│ Array_Numbers_16     │  76.8M ops/s │  39.6M ops/s │
+│ Array_Objects_Open   │  28.7M ops/s │  20.4M ops/s │
+│ Array_Objects_Close  │  10.3M ops/s │  10.8M ops/s │
+└──────────────────────┴──────────────┴──────────────┘
 ```
 
 <a name="Versions"></a>
 
 ## Versions
 
-TypeBox provides two distinct versions that span two generations of the TypeScript compiler.
+TypeBox ships two distinct versions that span two generations of the TypeScript compiler. 
 
 | TypeBox | TypeScript | Description |
 | :--- | :--- | :--- |

package/build/schema/engine/_guard.d.mts

@@ -1,6 +0,0 @@
-import * as Schema from '../types/index.mjs';
-import { Stack } from './_stack.mjs';
-import { BuildContext, CheckContext, ErrorContext } from './_context.mjs';
-export declare function BuildGuard(_stack: Stack, _context: BuildContext, schema: Schema.XGuard, value: string): string;
-export declare function CheckGuard(_stack: Stack, _context: CheckContext, schema: Schema.XGuard, value: unknown): boolean;
-export declare function ErrorGuard(_stack: Stack, context: ErrorContext, schemaPath: string, instancePath: string, schema: Schema.XGuard, value: unknown): boolean;

package/build/schema/engine/_guard.mjs

@@ -1,26 +0,0 @@
-// deno-fmt-ignore-file
-import * as Externals from './_externals.mjs';
-import { EmitGuard as E } from '../../guard/index.mjs';
-// ------------------------------------------------------------------
-// Build
-// ------------------------------------------------------------------
-export function BuildGuard(_stack, _context, schema, value) {
-    return E.Call(E.Member(E.Member(Externals.CreateVariable(schema), '~guard'), 'check'), [value]);
-}
-// ------------------------------------------------------------------
-// Check
-// ------------------------------------------------------------------
-export function CheckGuard(_stack, _context, schema, value) {
-    return schema['~guard'].check(value);
-}
-// ------------------------------------------------------------------
-// Error
-// ------------------------------------------------------------------
-export function ErrorGuard(_stack, context, schemaPath, instancePath, schema, value) {
-    return schema['~guard'].check(value) || context.AddError({
-        keyword: '~guard',
-        schemaPath,
-        instancePath,
-        params: { errors: schema['~guard'].errors(value) },
-    });
-}

package/build/schema/static/~non-readonly.d.mts

@@ -1,7 +0,0 @@
-type XFromTuple<Value extends readonly unknown[]> = (Value extends [infer Left, ...infer Right extends unknown[]] ? [XNonReadonly<Left>, ...XFromTuple<Right>] : []);
-type XFromArray<Value extends unknown, Result extends unknown[] = XNonReadonly<Value>[]> = Result;
-type XFromObject<Value extends object, Result extends Record<PropertyKey, unknown> = {
-    -readonly [K in keyof Value]: XNonReadonly<Value[K]>;
-}> = Result;
-export type XNonReadonly<Value extends unknown> = (Value extends readonly [...infer Schemas extends unknown[]] ? XFromTuple<Schemas> : Value extends readonly (infer Schema)[] ? XFromArray<Schema> : Value extends object ? XFromObject<Value> : Value);
-export {};

package/build/schema/static/~readonly.d.mts

@@ -1,6 +0,0 @@
-import type { XSchema } from '../types/schema.mjs';
-export type XIsReadonly<Schema extends XSchema> = (Schema extends {
-    readOnly: true;
-} ? true : Schema extends {
-    '~readonly': true;
-} ? true : false);

package/build/schema/static/~readonly.mjs

@@ -1,2 +0,0 @@
-// deno-fmt-ignore-file
-export {};

package/build/schema/types/_guard.d.mts

@@ -1,10 +0,0 @@
-import type { XSchemaObject } from './schema.mjs';
-export interface XGuardInterface<Value extends unknown = unknown> {
-    check(value: unknown): value is Value;
-    errors(value: unknown): object[];
-}
-export interface XGuard<Value extends unknown = unknown> {
-    '~guard': XGuardInterface<Value>;
-}
-export declare function IsGuardInterface(value: unknown): value is XGuardInterface;
-export declare function IsGuard(value: XSchemaObject): value is XGuard;

package/build/schema/types/_guard.mjs

@@ -1,16 +0,0 @@
-// deno-fmt-ignore-file
-import { Guard } from '../../guard/index.mjs';
-// ------------------------------------------------------------------
-// Guard
-// ------------------------------------------------------------------
-export function IsGuardInterface(value) {
-    return Guard.IsObject(value)
-        && Guard.HasPropertyKey(value, 'check')
-        && Guard.HasPropertyKey(value, 'errors')
-        && Guard.IsFunction(value.check)
-        && Guard.IsFunction(value.errors);
-}
-export function IsGuard(value) {
-    return Guard.HasPropertyKey(value, '~guard')
-        && IsGuardInterface(value['~guard']);
-}

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

@@ -1,19 +0,0 @@
-import { type TSchema } from '../types/schema.mjs';
-/** Represents a operation to apply Optional to a property */
-export interface TOptionalAddAction<Type extends TSchema = TSchema> extends TSchema {
-    '~kind': 'OptionalAddAction';
-    type: Type;
-}
-/** Creates an OptionalAddAction. */
-export declare function OptionalAddAction<Type extends TSchema>(type: Type): TOptionalAddAction<Type>;
-/** Returns true if this value is a OptionalAddAction. */
-export declare function IsOptionalAddAction(value: unknown): value is TOptionalAddAction;
-/** Represents a operation to remove Optional from a property */
-export interface TOptionalRemoveAction<Type extends TSchema = TSchema> extends TSchema {
-    '~kind': 'OptionalRemoveAction';
-    type: Type;
-}
-/** Creates a OptionalRemoveAction. */
-export declare function OptionalRemoveAction<Type extends TSchema>(type: Type): TOptionalRemoveAction<Type>;
-/** Returns true if this value is a OptionalRemoveAction. */
-export declare function IsOptionalRemoveAction(value: unknown): value is TOptionalRemoveAction;

package/build/type/action/_optional.mjs

@@ -1,40 +0,0 @@
-// deno-fmt-ignore-file
-import { Memory } from '../../system/memory/index.mjs';
-import { Guard } from '../../guard/index.mjs';
-import { IsSchema } from '../types/schema.mjs';
-// ------------------------------------------------------------------
-// Action
-// ------------------------------------------------------------------
-/** Creates an OptionalAddAction. */
-export function OptionalAddAction(type) {
-    return Memory.Create({ ['~kind']: 'OptionalAddAction' }, { type }, {});
-}
-// ------------------------------------------------------------------
-// Guard
-// ------------------------------------------------------------------
-/** Returns true if this value is a OptionalAddAction. */
-export function IsOptionalAddAction(value) {
-    return Guard.IsObject(value)
-        && Guard.HasPropertyKey(value, '~kind')
-        && Guard.HasPropertyKey(value, 'type')
-        && Guard.IsEqual(value['~kind'], 'OptionalAddAction')
-        && IsSchema(value.type);
-}
-// ------------------------------------------------------------------
-// Factory
-// ------------------------------------------------------------------
-/** Creates a OptionalRemoveAction. */
-export function OptionalRemoveAction(type) {
-    return Memory.Create({ ['~kind']: 'OptionalRemoveAction' }, { type }, {});
-}
-// ------------------------------------------------------------------
-// Guard
-// ------------------------------------------------------------------
-/** Returns true if this value is a OptionalRemoveAction. */
-export function IsOptionalRemoveAction(value) {
-    return Guard.IsObject(value)
-        && Guard.HasPropertyKey(value, '~kind')
-        && Guard.HasPropertyKey(value, 'type')
-        && Guard.IsEqual(value['~kind'], 'OptionalRemoveAction')
-        && IsSchema(value.type);
-}

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

@@ -1,19 +0,0 @@
-import { type TSchema } from '../types/schema.mjs';
-/** Represents an operation to apply Readonly to a property. */
-export interface TReadonlyAddAction<Type extends TSchema = TSchema> extends TSchema {
-    '~kind': 'ReadonlyAddAction';
-    type: Type;
-}
-/** Creates a ReadonlyAddAction. */
-export declare function ReadonlyAddAction<Type extends TSchema>(type: Type): TReadonlyAddAction<Type>;
-/** Returns true if this value is a ReadonlyAddAction. */
-export declare function IsReadonlyAddAction(value: unknown): value is TReadonlyAddAction;
-/** Represents an action to remove Readonly from a property. */
-export interface TReadonlyRemoveAction<Type extends TSchema = TSchema> extends TSchema {
-    '~kind': 'ReadonlyRemoveAction';
-    type: Type;
-}
-/** Creates a ReadonlyRemoveAction. */
-export declare function ReadonlyRemoveAction<Type extends TSchema>(type: Type): TReadonlyRemoveAction<Type>;
-/** Returns true if this value is a ReadonlyRemoveAction. */
-export declare function IsReadonlyRemoveAction(value: unknown): value is TReadonlyRemoveAction;

package/build/type/action/_readonly.mjs

@@ -1,40 +0,0 @@
-// deno-fmt-ignore-file
-import { Memory } from '../../system/memory/index.mjs';
-import { Guard } from '../../guard/index.mjs';
-import { IsSchema } from '../types/schema.mjs';
-// ------------------------------------------------------------------
-// Action
-// ------------------------------------------------------------------
-/** Creates a ReadonlyAddAction. */
-export function ReadonlyAddAction(type) {
-    return Memory.Create({ ['~kind']: 'ReadonlyAddAction' }, { type }, {});
-}
-// ------------------------------------------------------------------
-// Guard
-// ------------------------------------------------------------------
-/** Returns true if this value is a ReadonlyAddAction. */
-export function IsReadonlyAddAction(value) {
-    return Guard.IsObject(value)
-        && Guard.HasPropertyKey(value, '~kind')
-        && Guard.HasPropertyKey(value, 'type')
-        && Guard.IsEqual(value['~kind'], 'ReadonlyAddAction')
-        && IsSchema(value.type);
-}
-// ------------------------------------------------------------------
-// Factory
-// ------------------------------------------------------------------
-/** Creates a ReadonlyRemoveAction. */
-export function ReadonlyRemoveAction(type) {
-    return Memory.Create({ ['~kind']: 'ReadonlyRemoveAction' }, { type }, {});
-}
-// ------------------------------------------------------------------
-// Guard
-// ------------------------------------------------------------------
-/** Returns true if this value is a ReadonlyRemoveAction. */
-export function IsReadonlyRemoveAction(value) {
-    return Guard.IsObject(value)
-        && Guard.HasPropertyKey(value, '~kind')
-        && Guard.HasPropertyKey(value, 'type')
-        && Guard.IsEqual(value['~kind'], 'ReadonlyRemoveAction')
-        && IsSchema(value.type);
-}

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

@@ -1,11 +0,0 @@
-import { type TSchema, type TSchemaOptions } from '../types/schema.mjs';
-import { type TDeferred } from '../types/deferred.mjs';
-import { type TInstantiate } from '../engine/instantiate.mjs';
-/** Creates a deferred Awaited action. */
-export type TAwaitedDeferred<Type extends TSchema> = (TDeferred<'Awaited', [Type]>);
-/** Creates a deferred Awaited action. */
-export declare function AwaitedDeferred<Type extends TSchema>(type: Type, options?: TSchemaOptions): TAwaitedDeferred<Type>;
-/** Applies an Awaited action to a type. */
-export type TAwaited<Type extends TSchema> = (TInstantiate<{}, TAwaitedDeferred<Type>>);
-/** Applies an Awaited action to a type. */
-export declare function Awaited<Type extends TSchema>(type: Type, options?: TSchemaOptions): TAwaited<Type>;

package/build/type/action/awaited.mjs

@@ -1,12 +0,0 @@
-// deno-lint-ignore-file ban-types
-// deno-fmt-ignore-file
-import { Deferred } from '../types/deferred.mjs';
-import { Instantiate } from '../engine/instantiate.mjs';
-/** Creates a deferred Awaited action. */
-export function AwaitedDeferred(type, options = {}) {
-    return Deferred('Awaited', [type], options);
-}
-/** Applies an Awaited action to a type. */
-export function Awaited(type, options = {}) {
-    return Instantiate({}, AwaitedDeferred(type, options));
-}