Specification (#1559)

* Specification

* Documentation

Author: sinclairzx81

deno.jsonc

@@ -11,6 +11,7 @@
     "publish": "deno run -A tasks.ts publish",       // Publish Package
     "report": "deno run -A tasks.ts report",         // Test Converage
     "range": "deno run -A tasks.ts range",           // TypeScript Compiler Ranges
+    "spec": "deno run -A tasks.ts spec",             // Refresh JSON Schema Spec
     "start": "deno run -A tasks.ts start",           // Run Example
     "syntax": "deno run -A tasks.ts syntax",         // Build Parsers
     "test": "deno run -A tasks.ts test",             // Test Project

design/website/app/frontend/components/docs/docs.css

@@ -214,6 +214,67 @@ THE SOFTWARE.
   padding: 0; 
   display: block;
 }
+/* ------------------------------------------------------------------
+   TABLE LAYOUT
+   ------------------------------------------------------------------ */
+.docs .content .docs-table-wrap {
+  overflow-x: auto;
+  margin: 1.25rem 0;
+}
+.docs .content table {
+  width: 100%;
+  border-collapse: collapse;
+  font-size: 0.875rem;
+  font-family: var(--app-font-family-standard);
+  table-layout: auto;
+}
+.docs .content table thead tr {
+  background: var(--docs-menu-background-color);
+  border-bottom: 2px solid var(--docs-search-border-color);
+}
+.docs .content table thead th {
+  color: var(--docs-text-color-muted);
+  font-weight: 500;
+  text-align: left;
+  padding: 0.6rem 1rem;
+  white-space: nowrap;
+  font-size: 0.78rem;
+  letter-spacing: 0.03em;
+  text-transform: uppercase;
+}
+.docs .content table thead th:first-child {
+  border-left: 4px solid var(--docs-text-color-select);
+}
+.docs .content table tbody tr {
+  border-bottom: 1px solid var(--docs-blockquote-border-color);
+}
+.docs .content table tbody tr:last-child {
+  border-bottom: none;
+}
+.docs .content table tbody tr:hover {
+  background: var(--docs-menu-background-color);
+}
+.docs .content table tbody td {
+  padding: 0.6rem 1rem;
+  color: var(--docs-text-color);
+  vertical-align: middle;
+  line-height: 1.6;
+}
+.docs .content table tbody td:first-child {
+  border-left: 4px solid transparent;
+}
+.docs .content table tbody tr:hover td:first-child {
+  border-left-color: var(--docs-text-color-select);
+}
+.docs .content table tfoot tr {
+  border-top: 1px solid var(--docs-search-border-color);
+  background: var(--docs-menu-background-color);
+}
+.docs .content table tfoot td {
+  padding: 0.5rem 1rem;
+  font-size: 0.78rem;
+  color: var(--docs-text-color-muted);
+}
 /* ------------------------------------------------------------------
    PrismJS syntax highlighting
    ------------------------------------------------------------------ */

design/website/docs/schema/6_specification.md

@@ -0,0 +1,108 @@
+# Schema.Specification
+
+TypeBox aims for full specification compliance with the latest JSON Schema drafts as well as broad support for previous draft versions. It employs a progressive keyword adoption strategy where it implements keyword semantics as defined by newer drafts, and where keyword backwards  compatibility is supported if the keyword can be implemented without conflict on newer versions.
+
+> ⚠️ Specification alignment is a ongoing effort. While TypeBox tests in excess of 95% + of the Required Keyword suite, keywords such as `$dynamicRef`, `$dynamicAnchor` are yet to be implemented by the compiler. TypeBox aims to support these along with additional `v1` keywords while retaining broad compatibility for Draft 7.
+
+## Required Keywords
+
+These keywords form the core of TypeBox's compliance target. A ✅ indicates full passage of all test cases for that keyword under the given draft. Fractional values (e.g. 37/45) indicate the number of passing cases out of the total available for that keyword and draft combination. A dash indicates the keyword was not defined in that draft.
+
+| 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 | - | - | - | - | ✅ | ✅ | ✅ |
+| enum | 14/16 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| exclusiveMaximum | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| exclusiveMinimum | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| format | ✅ | ✅ | ✅ | ✅ | ✅ | 114/133 | - |
+| 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 | ✅ | ✅ | ✅ | ✅ | ✅ | 10/12 | 10/12 |
+| patternProperties | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | 25/26 |
+| prefixItems | - | - | - | - | - | ✅ | ✅ |
+| properties | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| propertyNames | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| recursiveRef | - | - | - | - | ✅ | - | - |
+| ref | 23/27 | 37/45 | 67/70 | 75/78 | 79/81 | 77/79 | 77/79 |
+| required | 3/4 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| type | 73/80 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| unevaluatedItems | - | - | - | - | 55/56 | 63/71 | 63/71 |
+| unevaluatedProperties | - | - | - | - | 124/125 | 123/125 | 123/125 |
+| uniqueItems | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+
+## Optional Keywords and Proposals
+
+Optional test suites cover supplementary keywords, format validators, and proposals that are not required for core compliance. Support is included where it can be provided without conflicting with required keyword semantics. Items prefixed with format/ are format-assertion tests for the corresponding string format.
+
+| Spec | 3 | 4 | 6 | 7 | 2019-09 | 2020-12 | v1 |
+|:-----|:--|:--|:--|:--|:--|:--|:--|
+| anchor | - | - | - | - | 3/4 | 3/4 | 3/4 |
+| bignum | 7/9 | 7/9 | ✅ | ✅ | ✅ | ✅ | ✅ |
+| content | - | - | - | 6/10 | - | - | - |
+| cross-draft | - | - | - | 1/2 | 1/3 | 0/1 | - |
+| dependencies-compatibility | - | - | - | - | ✅ | ✅ | ✅ |
+| dynamicRef | - | - | - | - | - | 1/2 | 1/2 |
+| ecmascript-regex | - | 64/74 | 64/74 | 64/74 | 64/74 | 64/74 | 64/74 |
+| float-overflow | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| format-annotation | - | - | - | - | - | - | 114/133 |
+| format-assertion | - | - | - | - | - | ✅ | - |
+| format/color | 3/6 | - | - | - | - | - | - |
+| format/date | ✅ | - | - | ✅ | ✅ | ✅ | ✅ |
+| format/date-time | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| format/duration | - | - | - | - | 40/42 | 40/42 | 40/42 |
+| format/ecmascript-regex | 1/2 | - | - | - | - | 0/1 | 0/1 |
+| format/email | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| format/host-name | 2/12 | - | - | - | - | - | - |
+| format/hostname | - | 27/28 | 27/28 | 37/61 | 37/61 | 37/61 | 37/61 |
+| format/idn-email | - | - | - | ✅ | ✅ | ✅ | ✅ |
+| format/idn-hostname | - | - | - | ✅ | ✅ | ✅ | ✅ |
+| format/ip-address | 1/3 | - | - | - | - | - | - |
+| format/ipv4 | - | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| format/ipv6 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| format/iri | - | - | - | ✅ | ✅ | ✅ | ✅ |
+| format/iri-reference | - | - | - | ✅ | ✅ | ✅ | ✅ |
+| format/json-pointer | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| format/regex | ✅ | - | - | ✅ | ✅ | ✅ | ✅ |
+| format/relative-json-pointer | - | - | - | ✅ | ✅ | ✅ | ✅ |
+| format/time | 2/3 | - | - | ✅ | ✅ | ✅ | ✅ |
+| format/unknown | - | ✅ | ✅ | ✅ | ✅ | ✅ | - |
+| format/uri | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
+| format/uri-reference | - | - | 15/17 | 15/17 | 15/17 | 15/17 | 15/17 |
+| format/uri-template | - | - | ✅ | ✅ | ✅ | ✅ | ✅ |
+| format/uuid | - | - | - | - | ✅ | ✅ | ✅ |
+| id | - | 2/3 | 6/7 | 6/7 | 2/3 | 2/3 | 2/3 |
+| no-schema | - | - | - | - | ✅ | ✅ | - |
+| non-bmp-regex | 9/12 | 9/12 | 9/12 | 9/12 | 9/12 | 9/12 | 9/12 |
+| proposals/propertyDependencies/additionalProperties | - | - | - | - | - | - | ✅ |
+| proposals/propertyDependencies/dynamicRef | - | - | - | - | - | - | 4/8 |
+| proposals/propertyDependencies/propertyDependencies | - | - | - | - | - | - | 17/21 |
+| proposals/propertyDependencies/unevaluatedProperties | - | - | - | - | - | - | 4/6 |
+| refOfUnknownKeyword | - | - | - | - | ✅ | ✅ | ✅ |
+| unknownKeyword | - | - | 1/3 | 1/3 | 1/3 | 1/3 | 1/3 |
+| zeroTerminatedFloats | 0/1 | 0/1 | - | - | - | - | - |

design/website/docs/schema/overview.md

@@ -4,7 +4,7 @@ High Performance JSON Schema Validator
 
 ## Overview
 
-TypeBox includes a high performance validation compiler for JSON Schema. The compiler supports both TypeBox and native JSON Schema schematics, and will convert them into optimized runtime validation routines. The compiler is designed to be a lightweight 2020-12 spec compliant alternative to Ajv for high-throughput applications.
+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
 

design/website/docs/type/overview.md

@@ -4,7 +4,7 @@ JSON Schema Type Builder with Static Type Resolution for TypeScript
 
 ## Overview
 
-TypeBox types are JSON Schema fragments that can 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.
+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