typebox 1.1.4 → 1.1.6

package/build/compile/validator.d.mts

@@ -15,13 +15,13 @@ export declare class Validator<Context extends TProperties = TProperties, Type e
     IsAccelerated(): boolean;
     /** Returns the Context for this validator. */
     Context(): Context;
-    /** Returns the Type for this validator. */
+    /** Returns the underlying Type used to construct this Validator. */
     Type(): Type;
     /** Returns the generated code for this validator. */
     Code(): string;
-    /** Checks a value matches the Validator type. */
+    /** Performs a type-guard check on the provided value. */
     Check(value: unknown): value is Encode;
-    /** Returns errors for the given value. */
+    /** Inspects a value and returns a detailed list of validation errors. */
     Errors(value: unknown): TLocalizedValidationError[];
     /** Cleans a value using the Validator type. */
     Clean(value: unknown): unknown;
@@ -33,7 +33,7 @@ export declare class Validator<Context extends TProperties = TProperties, Type e
     Default(value: unknown): unknown;
     /** Clones this validator. */
     Clone(): Validator<Context, Type>;
-    /** Parses a value */
+    /** Validates a value and returns it. Will throw if invalid. */
     Parse(value: unknown): Encode;
     /** Decodes a value */
     Decode(value: unknown): Decode;

package/build/compile/validator.mjs

@@ -50,7 +50,7 @@ export class Validator extends Base {
     Context() {
         return this.context;
     }
-    /** Returns the Type for this validator. */
+    /** Returns the underlying Type used to construct this Validator. */
     Type() {
         return this.type;
     }
@@ -64,11 +64,11 @@ export class Validator extends Base {
     // ----------------------------------------------------------------
     // Base<...>
     // ----------------------------------------------------------------
-    /** Checks a value matches the Validator type. */
+    /** Performs a type-guard check on the provided value. */
     Check(value) {
         return this.check(value);
     }
-    /** Returns errors for the given value. */
+    /** Inspects a value and returns a detailed list of validation errors. */
     Errors(value) {
         if (Environment.CanAccelerate() && this.check(value))
             return [];
@@ -94,7 +94,7 @@ export class Validator extends Base {
     Clone() {
         return new Validator(this.context, this.type, this.isAccelerated, this.hasCodec, this.code, this.check);
     }
-    /** Parses a value */
+    /** Validates a value and returns it. Will throw if invalid. */
     Parse(value) {
         const checked = this.Check(value);
         if (checked)

package/build/schema/compile.d.mts

@@ -7,11 +7,13 @@ export declare class Validator<Schema extends Schema.XSchema = Schema.XSchema, V
     constructor(context: Record<string, Schema.XSchema>, schema: Schema);
     /** Returns true if this Validator is using JIT acceleration. */
     IsAccelerated(): boolean;
-    /** Checks this value is valid */
+    /** Returns the underlying Schema used to construct this Validator. */
+    Schema(): Schema;
+    /** Performs a type-guard check on the provided value. */
     Check(value: unknown): value is Value;
-    /** Parses this value and throw if invalid */
+    /** Validates a value and returns it. Will throw if invalid. */
     Parse(value: unknown): Value;
-    /** Returns errors for the given value */
+    /** Inspects a value and returns a detailed list of validation errors. */
     Errors(value: unknown): [result: boolean, errors: TLocalizedValidationError[]];
 }
 /** Compiles this schema into a high performance Validator */

package/build/schema/compile.mjs

@@ -16,18 +16,22 @@ export class Validator {
     IsAccelerated() {
         return this.result.IsAccelerated;
     }
-    /** Checks this value is valid */
+    /** Returns the underlying Schema used to construct this Validator. */
+    Schema() {
+        return this.build.Schema();
+    }
+    /** Performs a type-guard check on the provided value. */
     Check(value) {
         return this.result.Check(value);
     }
-    /** Parses this value and throw if invalid */
+    /** Validates a value and returns it. Will throw if invalid. */
     Parse(value) {
         if (this.result.Check(value))
             return value;
         const [_result, errors] = Errors(this.build.Context(), this.build.Schema(), value);
         throw new ParseError(this.build.Schema(), value, errors);
     }
-    /** Returns errors for the given value */
+    /** Inspects a value and returns a detailed list of validation errors. */
     Errors(value) {
         return Errors(this.build.Context(), this.build.Schema(), value);
     }

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

@@ -1,7 +1,32 @@
 import { type TSchema } from './schema.mjs';
 import { type XGuard, type XGuardInterface } from '../../schema/types/index.mjs';
 export type StaticBase<Value extends unknown> = Value;
-/** Base class for creating extension types. */
+/**
+ * @deprecated Use Type.Refine() + Type.Unsafe() instead.
+ *
+ *
+ * **Reason:** It is noted that JavaScript class instances do not behave like
+ * plain objects during structural clone or when the TB compositor needs to
+ * assign dynamic modifier properties (such as '~optional').
+ *
+ * Because the TypeBox compositor needs to transform schematics via object clone /
+ * property spread, these operations can result in class instance types losing
+ * methods on the prototype (via clone), which can lead to unexpected structures being
+ * returned. This has led to special-case (non-clone) handling for Base which needs
+ * to be removed as it has proven orthogonal to the TypeBox 1.x design.
+ *
+ * The Base type was introduced in 1.x to try integrate / embed Standard Schema into JSON
+ * Schema; however, support for integrated Standard Schema embedding will not be continued
+ * in TypeBox. This type will be removed in the next minor revision of TypeBox.
+ *
+ * ```typescript
+ * // (Deprecated)
+ * class DateType extends Type.Base<Date> { Check(value) { return value instanceof Date } }
+ *
+ * // (Future)
+ * const DateType = Type.Refine(Type.Unsafe<Date>({}), value => value instanceof Date)
+ * ```
+ */
 export declare class Base<Value extends unknown = unknown> implements TSchema, XGuard<Value> {
     readonly '~kind': 'Base';
     readonly '~guard': XGuardInterface<Value>;

package/build/type/types/base.mjs

@@ -12,7 +12,32 @@ function BaseProperty(value) {
         value
     };
 }
-/** Base class for creating extension types. */
+/**
+ * @deprecated Use Type.Refine() + Type.Unsafe() instead.
+ *
+ *
+ * **Reason:** It is noted that JavaScript class instances do not behave like
+ * plain objects during structural clone or when the TB compositor needs to
+ * assign dynamic modifier properties (such as '~optional').
+ *
+ * Because the TypeBox compositor needs to transform schematics via object clone /
+ * property spread, these operations can result in class instance types losing
+ * methods on the prototype (via clone), which can lead to unexpected structures being
+ * returned. This has led to special-case (non-clone) handling for Base which needs
+ * to be removed as it has proven orthogonal to the TypeBox 1.x design.
+ *
+ * The Base type was introduced in 1.x to try integrate / embed Standard Schema into JSON
+ * Schema; however, support for integrated Standard Schema embedding will not be continued
+ * in TypeBox. This type will be removed in the next minor revision of TypeBox.
+ *
+ * ```typescript
+ * // (Deprecated)
+ * class DateType extends Type.Base<Date> { Check(value) { return value instanceof Date } }
+ *
+ * // (Future)
+ * const DateType = Type.Refine(Type.Unsafe<Date>({}), value => value instanceof Date)
+ * ```
+ */
 export class Base {
     constructor() {
         globalThis.Object.defineProperty(this, '~kind', BaseProperty('Base'));

package/package.json

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