typebox 1.0.16 → 1.0.17

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

@@ -1,26 +1,70 @@
 import { type TSchema } from './schema.mjs';
-type TResult<Value extends unknown = unknown> = TValue<Value> | TIssues;
-interface TValue<Value extends unknown = unknown> {
-    value: Value;
+interface StandardSchemaV1<Input = unknown, Output = Input> {
+    /** The Standard Schema properties. */
+    readonly '~standard': StandardSchemaV1.Props<Input, Output>;
 }
-interface TIssues {
-    issues: object[];
-}
-declare class StandardValidatorV1<Value extends unknown = unknown> {
-    private readonly check;
-    private readonly errors;
-    readonly vendor = "typebox";
-    readonly version = 1;
-    constructor(check: (value: unknown) => boolean, errors: (value: unknown) => object[]);
-    readonly validate: (value: unknown) => TResult<Value>;
+declare namespace StandardSchemaV1 {
+    /** The Standard Schema properties interface. */
+    export interface Props<Input = unknown, Output = Input> {
+        /** The version number of the standard. */
+        readonly version: 1;
+        /** The vendor name of the schema library. */
+        readonly vendor: string;
+        /** Validates unknown input values. */
+        readonly validate: (value: unknown) => Result<Output> | Promise<Result<Output>>;
+        /** Inferred types associated with the schema. */
+        readonly types?: Types<Input, Output> | undefined;
+    }
+    /** The result interface of the validate function. */
+    export type Result<Output> = SuccessResult<Output> | FailureResult;
+    /** The result interface if validation succeeds. */
+    export interface SuccessResult<Output> {
+        /** The typed output value. */
+        readonly value: Output;
+        /** The non-existent issues. */
+        readonly issues?: undefined;
+    }
+    /** The result interface if validation fails. */
+    export interface FailureResult {
+        /** The issues of failed validation. */
+        readonly issues: ReadonlyArray<Issue>;
+    }
+    /** The issue interface of the failure output. */
+    export interface Issue {
+        /** The error message of the issue. */
+        readonly message: string;
+        /** The path of the issue, if any. */
+        readonly path?: ReadonlyArray<PropertyKey | PathSegment> | undefined;
+    }
+    /** The path segment interface of the issue. */
+    export interface PathSegment {
+        /** The key representing a path segment. */
+        readonly key: PropertyKey;
+    }
+    /** The Standard Schema types interface. */
+    export interface Types<Input = unknown, Output = Input> {
+        /** The input type of the schema. */
+        readonly input: Input;
+        /** The output type of the schema. */
+        readonly output: Output;
+    }
+    /** Infers the input type of a Standard Schema. */
+    export type InferInput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['input'];
+    /** Infers the output type of a Standard Schema. */
+    export type InferOutput<Schema extends StandardSchemaV1> = NonNullable<Schema['~standard']['types']>['output'];
+    export {};
 }
 export declare class BaseNotImplemented extends Error {
-    constructor(type: Base, override: string);
+    readonly cause: {
+        type: Base;
+        method: string;
+    };
+    constructor(type: Base, method: string);
 }
 /** Base class for creating extension types. */
 export declare class Base<Value extends unknown = unknown> implements TSchema {
     readonly '~kind': 'Base';
-    readonly '~standard': StandardValidatorV1<Value>;
+    readonly '~standard': StandardSchemaV1.Props<Value>;
     constructor();
     /** Checks a value or returns false if invalid */
     Check(value: unknown): value is Value;

package/build/type/types/base.mjs

@@ -1,9 +1,16 @@
 // deno-fmt-ignore-file
 import { IsKind } from './schema.mjs';
+// --------------------------------------------------------
+// Standard Schema Factory
+// --------------------------------------------------------
 function Value(value) {
     return { value };
 }
 function Issues(issues) {
+    // We cannot guarantee that the caller will pass an object with an
+    // error message, but it is generally implied. Additionally, we do
+    // not want StandardSchema interfaces proliferating throughout the
+    // codebase; they must remain contained within this module only.
     return { issues };
 }
 // ------------------------------------------------------------------------------------
@@ -24,9 +31,14 @@ class StandardValidatorV1 {
 // BaseError
 // ------------------------------------------------------------------
 export class BaseNotImplemented extends Error {
-    constructor(type, override) {
-        // @ts-ignore - options supported in deno, node, etc.
-        super(`Base type does not implement '${override}' function`, { cause: type });
+    constructor(type, method) {
+        super(`Base type does not implement the '${method}' function`);
+        Object.defineProperty(this, 'cause', {
+            value: { type, method },
+            writable: false,
+            configurable: false,
+            enumerable: false
+        });
     }
 }
 // ------------------------------------------------------------------
@@ -35,13 +47,13 @@ export class BaseNotImplemented extends Error {
 /** Base class for creating extension types. */
 export class Base {
     constructor() {
-        const validator = new StandardValidatorV1(value => this.Check(value), value => this.Errors(value));
+        const validator = new StandardValidatorV1((value) => this.Check(value), (value) => this.Errors(value));
         const configuration = {
             writable: false,
             configurable: false,
             enumerable: false
         };
-        Object.defineProperty(this, '~kind', { ...configuration, value: 'Base', });
+        Object.defineProperty(this, '~kind', { ...configuration, value: 'Base' });
         Object.defineProperty(this, '~standard', { ...configuration, value: validator });
     }
     /** Checks a value or returns false if invalid */

package/package.json

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