@sinclair/typebox 0.25.24 → 0.26.0-dev

package/value/value.js

@@ -29,39 +29,45 @@ THE SOFTWARE.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Value = void 0;
 const index_1 = require("../errors/index");
-const index_2 = require("../hash/index");
+const hash_1 = require("./hash");
 const equal_1 = require("./equal");
 const cast_1 = require("./cast");
 const clone_1 = require("./clone");
+const convert_1 = require("./convert");
 const create_1 = require("./create");
 const check_1 = require("./check");
 const delta_1 = require("./delta");
 /** Provides functions to perform structural updates to JavaScript values */
 var Value;
 (function (Value) {
-    function Cast(...args) {
-        const [schema, references, value] = args.length === 3 ? [args[0], args[1], args[2]] : [args[0], [], args[1]];
-        return cast_1.ValueCast.Cast(schema, references, value);
+    /** Casts a value into a given type. The return value will retain as much information of the original value as possible. Cast will convert string, number, boolean and date values if a reasonable conversion is possible. */
+    function Cast(schema, value) {
+        return cast_1.ValueCast.Cast(schema, value);
     }
     Value.Cast = Cast;
-    function Create(...args) {
-        const [schema, references] = args.length === 2 ? [args[0], args[1]] : [args[0], []];
-        return create_1.ValueCreate.Create(schema, references);
+    /** Creates a value from the given type */
+    function Create(schema) {
+        return create_1.ValueCreate.Create(schema);
     }
     Value.Create = Create;
-    function Check(...args) {
-        const [schema, references, value] = args.length === 3 ? [args[0], args[1], args[2]] : [args[0], [], args[1]];
-        return check_1.ValueCheck.Check(schema, references, value);
+    /** Returns true if the value matches the given type. */
+    function Check(schema, value) {
+        return check_1.ValueCheck.Check(schema, value);
     }
     Value.Check = Check;
+    /** Converts any type mismatched values to their target type if a conversion is possible. */
+    function Convert(schema, value) {
+        return convert_1.ValueConvert.Convert(schema, value);
+    }
+    Value.Convert = Convert;
     /** Returns a structural clone of the given value */
     function Clone(value) {
         return clone_1.ValueClone.Clone(value);
     }
     Value.Clone = Clone;
-    function* Errors(...args) {
-        const [schema, references, value] = args.length === 3 ? [args[0], args[1], args[2]] : [args[0], [], args[1]];
-        yield* index_1.ValueErrors.Errors(schema, references, value);
+    /** Returns an iterator for each error in this value. */
+    function Errors(schema, value) {
+        return index_1.ValueErrors.Errors(schema, value);
     }
     Value.Errors = Errors;
     /** Returns true if left and right values are structurally equal */
@@ -76,7 +82,7 @@ var Value;
     Value.Diff = Diff;
     /** Returns a FNV1A-64 non cryptographic hash of the given value */
     function Hash(value) {
-        return index_2.ValueHash.Create(value);
+        return hash_1.ValueHash.Create(value);
     }
     Value.Hash = Hash;
     /** Returns a new value with edits applied to the given value */

package/conditional/conditional.d.ts

@@ -1,17 +0,0 @@
-import * as Types from '../typebox';
-export type TExtends<L extends Types.TSchema, R extends Types.TSchema, T extends Types.TSchema, U extends Types.TSchema> = Types.Static<L> extends Types.Static<R> ? T : U;
-export interface TExclude<T extends Types.TUnion, U extends Types.TUnion> extends Types.TUnion<any[]> {
-    static: Exclude<Types.Static<T, this['params']>, Types.Static<U, this['params']>>;
-}
-export interface TExtract<T extends Types.TSchema, U extends Types.TUnion> extends Types.TUnion<any[]> {
-    static: Extract<Types.Static<T, this['params']>, Types.Static<U, this['params']>>;
-}
-/** Conditional type mapping for TypeBox types */
-export declare namespace Conditional {
-    /** (Experimental) Creates a conditional expression type */
-    function Extends<L extends Types.TSchema, R extends Types.TSchema, T extends Types.TSchema, U extends Types.TSchema>(left: L, right: R, ok: T, fail: U): TExtends<L, R, T, U>;
-    /** (Experimental) Constructs a type by excluding from UnionType all union members that are assignable to ExcludedMembers. */
-    function Exclude<T extends Types.TUnion, U extends Types.TUnion>(unionType: T, excludedMembers: U, options?: Types.SchemaOptions): TExclude<T, U>;
-    /** (Experimental) Constructs a type by extracting from Type all union members that are assignable to Union. */
-    function Extract<T extends Types.TSchema, U extends Types.TUnion>(type: T, union: U, options?: Types.SchemaOptions): TExtract<T, U>;
-}

package/conditional/conditional.js

@@ -1,91 +0,0 @@
-"use strict";
-/*--------------------------------------------------------------------------
-
-@sinclair/typebox/conditional
-
-The MIT License (MIT)
-
-Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
----------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Conditional = void 0;
-const Types = require("../typebox");
-const structural_1 = require("./structural");
-const index_1 = require("../guard/index");
-/** Conditional type mapping for TypeBox types */
-var Conditional;
-(function (Conditional) {
-    /** (Experimental) Creates a conditional expression type */
-    function Extends(left, right, ok, fail) {
-        switch (structural_1.Structural.Check(left, right)) {
-            case structural_1.StructuralResult.Union:
-                return Types.Type.Union([Clone(ok), Clone(fail)]);
-            case structural_1.StructuralResult.True:
-                return Clone(ok);
-            case structural_1.StructuralResult.False:
-                return Clone(fail);
-        }
-    }
-    Conditional.Extends = Extends;
-    /** (Experimental) Constructs a type by excluding from UnionType all union members that are assignable to ExcludedMembers. */
-    function Exclude(unionType, excludedMembers, options = {}) {
-        const anyOf = unionType.anyOf
-            .filter((schema) => {
-            const check = structural_1.Structural.Check(schema, excludedMembers);
-            return !(check === structural_1.StructuralResult.True || check === structural_1.StructuralResult.Union);
-        })
-            .map((schema) => Clone(schema));
-        return { ...options, [Types.Kind]: 'Union', anyOf };
-    }
-    Conditional.Exclude = Exclude;
-    /** (Experimental) Constructs a type by extracting from Type all union members that are assignable to Union. */
-    function Extract(type, union, options = {}) {
-        if (index_1.TypeGuard.TUnion(type)) {
-            const anyOf = type.anyOf.filter((schema) => structural_1.Structural.Check(schema, union) === structural_1.StructuralResult.True).map((schema) => Clone(schema));
-            return { ...options, [Types.Kind]: 'Union', anyOf };
-        }
-        else {
-            const anyOf = union.anyOf.filter((schema) => structural_1.Structural.Check(type, schema) === structural_1.StructuralResult.True).map((schema) => Clone(schema));
-            return { ...options, [Types.Kind]: 'Union', anyOf };
-        }
-    }
-    Conditional.Extract = Extract;
-    function Clone(value) {
-        const isObject = (object) => typeof object === 'object' && object !== null && !Array.isArray(object);
-        const isArray = (object) => typeof object === 'object' && object !== null && Array.isArray(object);
-        if (isObject(value)) {
-            return Object.keys(value).reduce((acc, key) => ({
-                ...acc,
-                [key]: Clone(value[key]),
-            }), Object.getOwnPropertySymbols(value).reduce((acc, key) => ({
-                ...acc,
-                [key]: Clone(value[key]),
-            }), {}));
-        }
-        else if (isArray(value)) {
-            return value.map((item) => Clone(item));
-        }
-        else {
-            return value;
-        }
-    }
-})(Conditional = exports.Conditional || (exports.Conditional = {}));

package/conditional/index.d.ts

@@ -1,2 +0,0 @@
-export * from './conditional';
-export * from './structural';

package/conditional/index.js

@@ -1,45 +0,0 @@
-"use strict";
-/*--------------------------------------------------------------------------
-
-@sinclair/typebox/conditional
-
-The MIT License (MIT)
-
-Copyright (c) 2017-2023 Haydn Paterson (sinclair) <haydn.developer@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
----------------------------------------------------------------------------*/
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./conditional"), exports);
-__exportStar(require("./structural"), exports);

package/conditional/structural.d.ts

@@ -1,11 +0,0 @@
-import * as Types from '../typebox';
-export declare enum StructuralResult {
-    Union = 0,
-    True = 1,
-    False = 2
-}
-/** Performs structural equivalence checks against TypeBox types. */
-export declare namespace Structural {
-    /** Structurally tests if the left schema extends the right. */
-    function Check(left: Types.TSchema, right: Types.TSchema): StructuralResult;
-}