typebox 1.3.0 → 1.3.2

package/build/format/_idna.mjs

@@ -1,3 +1,4 @@
+import { Unreachable } from '../system/unreachable/index.mjs';
 import * as Puny from './_puny.mjs';
 // ------------------------------------------------------------------
 // Unicode General Category Helper (RFC 5892)
@@ -34,7 +35,8 @@ const RFC5892_DISALLOWED = new Set([
 // ------------------------------------------------------------------
 // A set of Virama (halant) code points used to validate CONTEXTJ
 // rules (RFC 5892 Appendix A.1). These characters allow a subsequent
-// Zero Width Joiner (U+200D) to be valid in a label.
+// Zero Width Non-Joiner (U+200C) or Zero Width Joiner (U+200D) to
+// be valid in a label.
 // ------------------------------------------------------------------
 const VIRAMA_CPS = new Set([
     0x094d,
@@ -101,8 +103,10 @@ function IsVirama(cp) {
 // IsUnicodeLabel
 // ------------------------------------------------------------------
 function IsUnicodeLabel(value) {
+    // deno-coverage-ignore-start - unable to reach via format guards
     if (value.length === 0)
-        return false;
+        return Unreachable(); // false
+    // deno-coverage-ignore-stop
     // Use spread to handle surrogate pairs and provide O(1) neighbor access
     const cps = [...value].map((c) => c.codePointAt(0));
     const len = cps.length;
@@ -145,10 +149,17 @@ function IsUnicodeLabel(value) {
                 if (prev === undefined || !IsHebrew(prev))
                     return false;
                 break; // Hebrew GERESH
-            case 0x200d:
+            case 0x200c: // ZWNJ - RFC 5892 Appendix A.1
+                // Note: Full validation requires a Unicode joining type table. We reject
+                // only when preceded by ASCII (U+0000-U+007F), which can never satisfy
+                // the Virama or cursive-joining rules.
+                if (prev === undefined || (prev < 0x0080 && !IsVirama(prev)))
+                    return false;
+                break;
+            case 0x200d: // ZWJ  - RFC 5892 Appendix A.2
                 if (prev === undefined || !IsVirama(prev))
                     return false;
-                break; // ZWJ
+                break;
             case 0x30fb: /* Checked at end via hasJapanese */
                 break; // KATAKANA MIDDLE DOT
         }

package/build/format/_puny.mjs

@@ -1,3 +1,4 @@
+import { Unreachable } from '../system/unreachable/index.mjs';
 // ------------------------------------------------------------------
 // PunyCode (RFC 3492)
 // ------------------------------------------------------------------
@@ -52,8 +53,10 @@ export function Decode(value) {
                 digit = ch - 0x61; // a-z => 0-25
             else if (ch >= 0x30 && ch <= 0x39)
                 digit = ch - 0x30 + 26; // 0-9 => 26-35
+            // deno-coverage-ignore-start - _idna.ts maps input to lowercase, so we can't reach here
             else if (ch >= 0x41 && ch <= 0x5a)
-                digit = ch - 0x41; // A-Z => 0-25
+                Unreachable(); // digit = ch - 0x41 // A-Z => 0-25
+            // deno-coverage-ignore-stop
             else
                 throw new Error('Invalid punycode: bad digit character');
             i += digit * w;

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

@@ -1,5 +1,5 @@
 import { Stack } from './_stack.mjs';
 import { BuildContext, CheckContext, ErrorContext } from './_context.mjs';
-export declare function BuildBooleanSchema(_stack: Stack, _context: BuildContext, schema: boolean, _value: string): string;
-export declare function CheckBooleanSchema(_stack: Stack, _context: CheckContext, schema: boolean, _value: unknown): boolean;
-export declare function ErrorBooleanSchema(stack: Stack, context: ErrorContext, schemaPath: string, instancePath: string, schema: boolean, value: unknown): boolean;
+export declare function BuildSchemaBoolean(_stack: Stack, _context: BuildContext, schema: boolean, _value: string): string;
+export declare function CheckSchemaBoolean(_stack: Stack, _context: CheckContext, schema: boolean, _value: unknown): boolean;
+export declare function ErrorSchemaBoolean(stack: Stack, context: ErrorContext, schemaPath: string, instancePath: string, schema: boolean, value: unknown): boolean;

package/build/schema/engine/boolean.mjs

@@ -3,20 +3,20 @@ import { EmitGuard as E } from '../../guard/index.mjs';
 // ------------------------------------------------------------------
 // Build
 // ------------------------------------------------------------------
-export function BuildBooleanSchema(_stack, _context, schema, _value) {
+export function BuildSchemaBoolean(_stack, _context, schema, _value) {
     return schema ? E.Constant(true) : E.Constant(false);
 }
 // ------------------------------------------------------------------
 // Check
 // ------------------------------------------------------------------
-export function CheckBooleanSchema(_stack, _context, schema, _value) {
+export function CheckSchemaBoolean(_stack, _context, schema, _value) {
     return schema;
 }
 // ------------------------------------------------------------------
 // Error
 // ------------------------------------------------------------------
-export function ErrorBooleanSchema(stack, context, schemaPath, instancePath, schema, value) {
-    return CheckBooleanSchema(stack, context, schema, value) || context.AddError({
+export function ErrorSchemaBoolean(stack, context, schemaPath, instancePath, schema, value) {
+    return CheckSchemaBoolean(stack, context, schema, value) || context.AddError({
         keyword: 'boolean',
         schemaPath,
         instancePath,

package/build/schema/engine/schema.mjs

@@ -6,7 +6,7 @@ import { BuildAdditionalItems, CheckAdditionalItems, ErrorAdditionalItems } from
 import { BuildAdditionalProperties, CheckAdditionalProperties, ErrorAdditionalProperties } from './additionalProperties.mjs';
 import { BuildAllOf, CheckAllOf, ErrorAllOf } from './allOf.mjs';
 import { BuildAnyOf, CheckAnyOf, ErrorAnyOf } from './anyOf.mjs';
-import { BuildBooleanSchema, CheckBooleanSchema, ErrorBooleanSchema } from './boolean.mjs';
+import { BuildSchemaBoolean, CheckSchemaBoolean, ErrorSchemaBoolean } from './boolean.mjs';
 import { BuildConst, CheckConst, ErrorConst } from './const.mjs';
 import { BuildContains, CheckContains, ErrorContains } from './contains.mjs';
 import { BuildDependencies, CheckDependencies, ErrorDependencies } from './dependencies.mjs';
@@ -125,8 +125,8 @@ export function BuildSchemaPushStack(stack, context, schema, value) {
 export function BuildSchema(stack, context, schema, value) {
     stack.Push(schema);
     const conditions = [];
-    if (Schema.IsBooleanSchema(schema))
-        return BuildBooleanSchema(stack, context, schema, value);
+    if (Schema.IsSchemaBoolean(schema))
+        return BuildSchemaBoolean(stack, context, schema, value);
     if (Schema.IsType(schema))
         conditions.push(BuildType(stack, context, schema, value));
     if (HasObjectKeywords(schema)) {
@@ -247,7 +247,7 @@ export function CheckSchemaPushStack(stack, context, schema, value) {
 }
 export function CheckSchema(stack, context, schema, value) {
     stack.Push(schema);
-    const result = Schema.IsBooleanSchema(schema) ? CheckBooleanSchema(stack, context, schema, value) : ((!Schema.IsType(schema) || CheckType(stack, context, schema, value)) &&
+    const result = Schema.IsSchemaBoolean(schema) ? CheckSchemaBoolean(stack, context, schema, value) : ((!Schema.IsType(schema) || CheckType(stack, context, schema, value)) &&
         (!(G.IsObject(value) && !G.IsArray(value)) || ((!Schema.IsRequired(schema) || CheckRequired(stack, context, schema, value)) &&
             (!Schema.IsAdditionalProperties(schema) || CheckAdditionalProperties(stack, context, schema, value)) &&
             (!Schema.IsDependencies(schema) || CheckDependencies(stack, context, schema, value)) &&
@@ -300,7 +300,7 @@ export function ErrorSchemaPushStack(stack, context, schemaPath, instancePath, s
 }
 export function ErrorSchema(stack, context, schemaPath, instancePath, schema, value) {
     stack.Push(schema);
-    const result = (Schema.IsBooleanSchema(schema)) ? ErrorBooleanSchema(stack, context, schemaPath, instancePath, schema, value) : (!!(+(!Schema.IsType(schema) || ErrorType(stack, context, schemaPath, instancePath, schema, value)) &
+    const result = (Schema.IsSchemaBoolean(schema)) ? ErrorSchemaBoolean(stack, context, schemaPath, instancePath, schema, value) : (!!(+(!Schema.IsType(schema) || ErrorType(stack, context, schemaPath, instancePath, schema, value)) &
         +(!(G.IsObject(value) && !G.IsArray(value)) || !!(+(!Schema.IsRequired(schema) || ErrorRequired(stack, context, schemaPath, instancePath, schema, value)) &
             +(!Schema.IsAdditionalProperties(schema) || ErrorAdditionalProperties(stack, context, schemaPath, instancePath, schema, value)) &
             +(!Schema.IsDependencies(schema) || ErrorDependencies(stack, context, schemaPath, instancePath, schema, value)) &

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

@@ -3,7 +3,7 @@ export type XSchemaObject = object;
 export declare function IsSchemaObject(value: unknown): value is XSchemaObject;
 export type XSchemaBoolean = boolean;
 /** Returns true if this value is a boolean */
-export declare function IsBooleanSchema(value: unknown): value is XSchemaBoolean;
+export declare function IsSchemaBoolean(value: unknown): value is XSchemaBoolean;
 export type XSchema = XSchemaObject | XSchemaBoolean;
 /** Returns true if this value is schema like */
 export declare function IsSchema(value: unknown): value is XSchema;

package/build/schema/types/schema.mjs

@@ -5,10 +5,10 @@ export function IsSchemaObject(value) {
     return Guard.IsObject(value) && !Guard.IsArray(value);
 }
 /** Returns true if this value is a boolean */
-export function IsBooleanSchema(value) {
+export function IsSchemaBoolean(value) {
     return Guard.IsBoolean(value);
 }
 /** Returns true if this value is schema like */
 export function IsSchema(value) {
-    return IsSchemaObject(value) || IsBooleanSchema(value);
+    return IsSchemaObject(value) || IsSchemaBoolean(value);
 }

package/build/system/memory/clone.mjs

@@ -13,15 +13,16 @@ function FromClassInstance(value) {
     return value; // atomic
 }
 // ------------------------------------------------------------------
-// KindedObject
+// TypeObject
 //
 // Types have non-enumerable properties that MUST be preserved on Clone. 
 // The following is the optimal path for TypeBox types.
 // ------------------------------------------------------------------
-function IsKindedObject(value) {
-    return Guard.HasPropertyKey(value, '~kind');
+function IsTypeObject(value) {
+    return (Guard.HasPropertyKey(value, '~kind') ||
+        Guard.HasPropertyKey(value, '~unsafe'));
 }
-function FromKindedObject(value) {
+function FromTypeObject(value) {
     const result = {};
     const descriptors = Object.getOwnPropertyDescriptors(value);
     for (const key of Object.keys(descriptors)) {
@@ -54,7 +55,7 @@ function FromPlainObject(value) {
 // ------------------------------------------------------------------
 function FromObject(value) {
     return (Guard.IsClassInstance(value) ? FromClassInstance(value) :
-        IsKindedObject(value) ? FromKindedObject(value) :
+        IsTypeObject(value) ? FromTypeObject(value) :
             FromPlainObject(value));
 }
 // ------------------------------------------------------------------

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

@@ -3,6 +3,8 @@ import { type TTypeScriptEnumLike } from '../engine/enum/typescript_enum_to_enum
 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;
+/** Returns true if the given value is a EnumValue */
+export declare function IsEnumValue(value: unknown): value is TEnumValue;
 /** Represents an Enum type. */
 export interface TEnum<Values extends TEnumValue[] = TEnumValue[]> extends TSchema {
     '~kind': 'Enum';

package/build/type/types/enum.mjs

@@ -1,8 +1,13 @@
 // deno-fmt-ignore-file
+import { Guard } from '../../guard/index.mjs';
 import { Memory } from '../../system/memory/index.mjs';
 import { IsKind } from './schema.mjs';
 import { IsTypeScriptEnumLike } from '../engine/enum/typescript_enum_to_enum_values.mjs';
 import { TypeScriptEnumToEnumValues } from '../engine/enum/typescript_enum_to_enum_values.mjs';
+/** Returns true if the given value is a EnumValue */
+export function IsEnumValue(value) {
+    return Guard.IsString(value) || Guard.IsNumber(value);
+}
 /** Creates an Enum type. */
 export function Enum(value, options) {
     const values = IsTypeScriptEnumLike(value) ? TypeScriptEnumToEnumValues(value) : value;

package/build/typebox.d.mts

@@ -37,7 +37,7 @@ export { Boolean, IsBoolean, type TBoolean } from './type/types/boolean.mjs';
 export { Call, IsCall, type TCall } from './type/types/call.mjs';
 export { Constructor, IsConstructor, type TConstructor } from './type/types/constructor.mjs';
 export { Cyclic, IsCyclic, type TCyclic } from './type/types/cyclic.mjs';
-export { Enum, IsEnum, type TEnum, type TEnumValue } from './type/types/enum.mjs';
+export { Enum, IsEnum, IsEnumValue, 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';

package/build/typebox.mjs

@@ -55,7 +55,7 @@ export { Boolean, IsBoolean } from './type/types/boolean.mjs';
 export { Call, IsCall } from './type/types/call.mjs';
 export { Constructor, IsConstructor } from './type/types/constructor.mjs';
 export { Cyclic, IsCyclic } from './type/types/cyclic.mjs';
-export { Enum, IsEnum } from './type/types/enum.mjs';
+export { Enum, IsEnum, IsEnumValue } 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';

package/build/value/repair/from_type.mjs

@@ -40,6 +40,17 @@ function AssertRepairableType(context, type, value) {
     }
 }
 // ------------------------------------------------------------------
+// CreateWhenUndefined
+//
+// If the value is 'undefined' AND the type is not TUndefined, then 
+// we know the value must be created. We handle this case for undefined 
+// only as it enables 'default' annotation to be initialized via Create 
+// before we applying subsequent Repair logic.
+// ------------------------------------------------------------------
+function CreateWhenUndefined(context, type, value) {
+    return (Guard.IsUndefined(value) && !T.IsUndefined(type)) ? Create(context, type) : value;
+}
+// ------------------------------------------------------------------
 // FinalizeRepair
 //
 // When a type includes the ~refine modifier, a post-repair validation
@@ -62,15 +73,16 @@ function FinalizeRepair(context, type, repaired) {
 export function FromType(context, type, value) {
     AssertRepairableValue(context, type, value);
     AssertRepairableType(context, type, value);
-    const repaired = (T.IsArray(type) ? FromArray(context, type, value) :
-        T.IsEnum(type) ? FromEnum(context, type, value) :
-            T.IsIntersect(type) ? FromIntersect(context, type, value) :
-                T.IsObject(type) ? FromObject(context, type, value) :
-                    T.IsRecord(type) ? FromRecord(context, type, value) :
-                        T.IsRef(type) ? FromRef(context, type, value) :
-                            T.IsTemplateLiteral(type) ? FromTemplateLiteral(context, type, value) :
-                                T.IsTuple(type) ? FromTuple(context, type, value) :
-                                    T.IsUnion(type) ? FromUnion(context, type, value) :
-                                        FromUnknown(context, type, value));
+    const candidate = CreateWhenUndefined(context, type, value);
+    const repaired = (T.IsArray(type) ? FromArray(context, type, candidate) :
+        T.IsEnum(type) ? FromEnum(context, type, candidate) :
+            T.IsIntersect(type) ? FromIntersect(context, type, candidate) :
+                T.IsObject(type) ? FromObject(context, type, candidate) :
+                    T.IsRecord(type) ? FromRecord(context, type, candidate) :
+                        T.IsRef(type) ? FromRef(context, type, candidate) :
+                            T.IsTemplateLiteral(type) ? FromTemplateLiteral(context, type, candidate) :
+                                T.IsTuple(type) ? FromTuple(context, type, candidate) :
+                                    T.IsUnion(type) ? FromUnion(context, type, candidate) :
+                                        FromUnknown(context, type, candidate));
     return FinalizeRepair(context, type, repaired);
 }

package/package.json

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

package/readme.md

@@ -113,21 +113,24 @@ type User = Type.Static<typeof User>              // type User = {
 
 [Documentation](https://sinclairzx81.github.io/typebox/#/docs/script/overview) | [Example 1](https://www.typescriptlang.org/play/?target=99&module=7#code/JYWwDg9gTgLgBAFQJ5gKZwGZQiOByGFVAIwgA88AoSgehrgFonmXW32POv3b7k0AdAGUAxlGBgYACjwC5eAJS9G3VWvXdqdOADkAhiFQBnMHpGpKIiADsj8ALJ6YACzgBeREWFiJ0gAaUcHCEaHAAaqgiMNAATO5wAN5wZABccNYAriDEqFAANHBIaZnZuXAAvoHBROGR0VAAzPEAogBuegA2GU6oADwRUbFwAGSJcABexVk5UBUAfFUh6AP1ACwt7V09-XXQTaNJAO5TpbPlC35KygAiqGjWACao1vD6hiZmFla28En2xq5yvF+KhvOJJFIknIBI4XBUCn4gosahFYKgyPEElUgpAjMAYMAbGkVtBVnlseloCBOsTdo1yUEghlWrTBlAYlVKkElnAAOKoHCoGBQJCYimtXIE8xGWlosgAbQAugzGcBHsBpScZkrOcjQrDcsBOmLGXADMRgM8YKy1iqgg9gBgMBkjKgbaS7XATJEMh09FB3VBVrruTV-kZXB4saaAOYCwzCop8+NCkWe6kwQ00uAG8SdXWXLT0ABKGReoHQxdQGA6dUJ1ko4ecAjA2DQsEtRgEccFiZbbclnYEEo70oE+NQIC7rYg7YJxhbEDxBJs-dng4XZEbALXc6HPYTIt3G67I6lC4nU+PHYX1ipnWv867W6bj-3Kb7M73C7PGovmavL8TwEZk303bcIzArsMyzDooIEB0nRdUEgJvZ8IObVCnwEGC8zgrCh3NS0Xngl8dwIhdcKNfCBzQgRvREX1-VIos4CEGAnA1OAAElrAwXJnnMShnWsKJ6zgKBnieKApHeZw0hBYQOKlXolggDAcwBOYFESKo5O7D8j1-aV5QABkVRdl3rAQtyCfSD1TJBh0HEzzIEO8oGpODbLgezDKc4zjDMizQJ8-SqIfRDnVdGy9J3CK4KIq1Yrs+Kejw+i0EYv0oFi8ogA) | [Example 2](https://www.typescriptlang.org/play/?target=99&module=7#code/JYWwDg9gTgLgBAFQJ5gKZwGZQiOByGFVAIwgA88AoSgehrgFonmXW32POv3b7k0AdACpejbuImTu1OnAByAQxCoAzmAUBjVJQB2S1eq1wAsgpgALOAG9KcOKjKRYcDRB0r4ANVQaY0AExwALyIRAIA8sQAVj4wABRWcGQAXKGCcgCuIMSoUHEAlAA0cEip-KgCmdm5BXAAvvm29o7Q8K7uXrHQAMzBaRUAogBuCgA2GWaoceUCAJI6MLkqsXEA2t6+AcUzkTG+CXAAXmVhVTl5+fX5ALr5jXYOTm1uHnAbflAALH0zw2MTi2mYXmiygy326y6UG62zCuxWiQA7id0llzrUGrdGnUZPQACKoNA6AAmqAW8n0ak02nar28sAcPzh0QRTUgKmAMGAblSpgsAne0E+hSaOmgIDGvLM5gFUJhTQyQyl-MFUH8lAalFp8AA4qgcKgYFAkEzBPD9jY7ENclytCoURUAIJQKAKJBxemLMhFJrAEnAO0OgTO13umZnGp3DWNbUmSZQYBjU0Vc3xS1wJTEYBkmDKmWq4VNYnADAYDLLPOyzZfEV2NQ+DKjBRQSsF6Nal7wYyqSwhHYsi1NADm+uURtKcD1BvHtbgEtBidGytyi-bogAShkFqB0OvUBhRrFuTpKN2VDKwNg0LBsyoBCPp8aBJeINeuaoBNab3aBJzUCA7xfN9b2fCAOS5NxnyvG0QLIU8eyg18YI-B8xyfIDkLvL9bQ-P8AMQ4CPzFKAJVGAjMIEOCzwvaCbxQ0dDXQ2j3ywmCfzwwDmJAxVyLou8qIQjC+IEecVzGXiWIEYtS3LCohMkgTzwkkDRITcT5JAzNswWZSP0UmikOE1TF10u96w0Rtm1MyjcTgABlGAzADOB5gwXIyS0Sgyx0XxjzgKAyVJPJlHPIMHKcjQAB5CDQCAMBMHsAD5LnTEKZVQxikE-NjVFWAAGa5QPA48bLsNL7wY8dsu-XKCoEYjSNKucEIyqrsIDWrCp4uCyoQ4zxOkstlia8r+rIrScxGvr4xM8zLKgGy6iAA) | [Challenge](test/typescript/readme.md)
 
-TypeBox includes a syntax engine that can transform TypeScript declarations into JSON Schema. The engine is 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.
+TypeBox includes a syntax engine that can transform TypeScript declarations into JSON Schema. The engine is 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. 
+
+Syntax highlighting is available via the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sinclairzx81.typebox-script)
+
 
 ### Example
 
-The following uses Script to parse TypeScript declarations into JSON Schema.
+The following uses Script to parse TypeScript declarations into JSON Schema. 
 
 ```typescript
-// Namespace
+// Module
 const Math = Type.Script(`
   type Vector2 = { x: number, y: number }
   type Vector3 = Evaluate<Vector2 & { z: number }>
   type Vector4 = Evaluate<Vector3 & { w: number }>
 `)
 
-// Dependent Namespace
+// Dependent Module
 const { Mesh } = Type.Script({ ...Math }, `  
   type Vertex = {
     position: Vector4,