typebox 1.0.6 → 1.0.7

package/build/compile/validator.d.mts

@@ -4,6 +4,7 @@ export declare class Validator<Context extends TProperties = TProperties, Type e
     private readonly context;
     private readonly type;
     private readonly isEvaluated;
+    private readonly hasCodec;
     private readonly code;
     private readonly check;
     constructor(context: Context, type: Type);
@@ -15,16 +16,22 @@ export declare class Validator<Context extends TProperties = TProperties, Type e
     Type(): Type;
     /** Returns the generated code for this validator */
     Code(): string;
+    /** Checks a value matches the Validator type. */
     Check(value: unknown): value is StaticEncode<Type, Context>;
+    /** Returns errors for the given value. */
     Errors(value: unknown): TLocalizedValidationError[];
+    /** Cleans a value using the Validator type. */
     Clean(value: unknown): unknown;
+    /** Converts a value using the Validator type. */
     Convert(value: unknown): unknown;
+    /** Creates a value using the Validator type. */
     Create(): StaticEncode<Type, Context>;
+    /** Creates defaults using the Validator type. */
     Default(value: unknown): unknown;
-    /** Parses a value of this type */
+    /** Parses a value */
     Parse(value: unknown): StaticDecode<Type, Context>;
-    /** Decodes a value of this type */
+    /** Decodes a value */
     Decode(value: unknown): StaticDecode<Type, Context>;
-    /** Encodes a value of this type */
+    /** Encodes a value */
     Encode(value: unknown): StaticEncode<Type, Context>;
 }

package/build/compile/validator.mjs

@@ -1,7 +1,7 @@
 // deno-fmt-ignore-file
 import { Environment } from '../system/environment/index.mjs';
 import { Base } from '../type/index.mjs';
-import { Errors, Clean, Convert, Create, Default, Parser, Decode, Encode } from '../value/index.mjs';
+import { Errors, Clean, Convert, Create, Default, Decode, Encode, HasCodec, Parser } from '../value/index.mjs';
 import { Build } from '../schema/index.mjs';
 // ------------------------------------------------------------------
 // ValidatorType<...>
@@ -12,6 +12,7 @@ export class Validator extends Base {
         this.context = context;
         this.type = type;
         const result = Build(context, type).Evaluate();
+        this.hasCodec = HasCodec(context, type);
         this.isEvaluated = result.IsEvaluated;
         this.code = result.Code;
         this.check = result.Check;
@@ -44,40 +45,48 @@ export class Validator extends Base {
     // ----------------------------------------------------------------
     // Base<...>
     // ----------------------------------------------------------------
+    /** Checks a value matches the Validator type. */
     Check(value) {
         return this.check(value);
     }
+    /** Returns errors for the given value. */
     Errors(value) {
         if (Environment.CanEvaluate() && this.check(value))
             return [];
         return Errors(this.context, this.type, value);
     }
+    /** Cleans a value using the Validator type. */
     Clean(value) {
         return Clean(this.context, this.type, value);
     }
+    /** Converts a value using the Validator type. */
     Convert(value) {
         return Convert(this.context, this.type, value);
     }
+    /** Creates a value using the Validator type. */
     Create() {
         return Create(this.context, this.type);
     }
+    /** Creates defaults using the Validator type. */
     Default(value) {
         return Default(this.context, this.type, value);
     }
     // ----------------------------------------------------------------
-    // Parse
+    // Parse | Decode | Encode
     // ----------------------------------------------------------------
-    /** Parses a value of this type */
+    /** Parses a value */
     Parse(value) {
         const result = this.Check(value) ? value : Parser(this.context, this.type, value);
         return result;
     }
-    /** Decodes a value of this type */
+    /** Decodes a value */
     Decode(value) {
-        return Decode(this.context, this.type, value);
+        const result = this.hasCodec ? Decode(this.context, this.type, value) : this.Parse(value);
+        return result;
     }
-    /** Encodes a value of this type */
+    /** Encodes a value */
     Encode(value) {
-        return Encode(this.context, this.type, value);
+        const result = this.hasCodec ? Encode(this.context, this.type, value) : this.Parse(value);
+        return result;
     }
 }

package/build/value/check/check.d.mts

@@ -1,5 +1,5 @@
 import type { Static, TProperties, TSchema } from '../../type/index.mjs';
-/** Checks a value matches the provided type. This function returns a TypeScript type predicate and does not throw. */
+/** Checks a value matches the provided type. */
 export declare function Check<const Type extends TSchema, Result extends unknown = Static<Type>>(type: Type, value: unknown): value is Result;
-/** Checks a value matches the provided type. This function returns a TypeScript type predicate and does not throw. */
+/** Checks a value matches the provided type. */
 export declare function Check<Context extends TProperties, const Type extends TSchema, Result extends unknown = Static<Type, Context>>(context: Context, type: Type, value: unknown): value is Result;

package/build/value/check/check.mjs

@@ -1,7 +1,7 @@
 // deno-fmt-ignore-file
 import { Arguments } from '../../system/arguments/index.mjs';
 import { Check as SchemaCheck } from '../../schema/index.mjs';
-/** Checks a value matches the provided type. This function returns a TypeScript type predicate and does not throw. */
+/** Checks a value matches the provided type. */
 export function Check(...args) {
     const [context, type, value] = Arguments.Match(args, {
         3: (context, type, value) => [context, type, value],

package/build/value/codec/has.mjs

@@ -46,6 +46,9 @@ function FromRecord(context, type) {
 // Ref
 // ------------------------------------------------------------------
 function FromRef(context, type) {
+    if (visited.has(type.$ref))
+        return false;
+    visited.add(type.$ref);
     return IsCodec(type) || (Guard.HasPropertyKey(context, type.$ref)
         && FromType(context, context[type.$ref]));
 }
@@ -75,11 +78,16 @@ function FromType(context, type) {
                                 IsUnion(type) ? FromUnion(context, type) :
                                     IsCodec(type));
 }
+// ------------------------------------------------------------------
+// Visited
+// ------------------------------------------------------------------
+const visited = new Set();
 /** Returns true if this type contains a Codec */
 export function HasCodec(...args) {
     const [context, type] = Arguments.Match(args, {
         2: (context, type) => [context, type],
         1: (type) => [{}, type]
     });
+    visited.clear();
     return FromType(context, type);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typebox",
   "description": "A Runtime Type System for JavaScript",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "keywords": [
     "typescript",
     "jsonschema"

package/readme.md

@@ -33,7 +33,7 @@ import Type, { type Static } from 'typebox'
 const T = Type.Object({                             // const T = {
   x: Type.Number(),                                 //   type: 'object',
   y: Type.Number(),                                 //   required: ['x', 'y', 'z'],
-  z: Type.Number(),                                 //   properties: {
+  z: Type.Number()                                  //   properties: {
 })                                                  //     x: { type: 'number' },
                                                     //     y: { type: 'number' },
                                                     //     z: { type: 'number' }
@@ -49,25 +49,28 @@ type T = Static<typeof T>                           // type T = {
 
 ## Overview
 
-[Documentation](https://sinclairzx81.github.io/typebox/) | [1.0 Migration Guide](https://github.com/sinclairzx81/typebox/blob/main/changelog/1.0.0-migration.md)
+[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.
 
 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.
 
-
-
 License: MIT
 
 ## Contents
 
+- [Upgrade](#Upgrade)
 - [Type](#Type)
 - [Script](#Script)
 - [Value](#Value)
 - [Compile](#Compile)
 - [Contribute](#Contribute)
 
+## Upgrade
+
+Refer to the following URL for information on upgrading from 0.34.x to 1.0.
 
+[1.0 Migration Guide](https://github.com/sinclairzx81/typebox/blob/main/changelog/1.0.0-migration.md)
 
 <a name="Type"></a>