@sinclair/typebox 0.31.27 → 0.32.0-dev-1

package/value/convert/index.js

@@ -0,0 +1,44 @@
+"use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/value
+
+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("./convert"), exports);

package/value/create/create.d.ts

@@ -0,0 +1,31 @@
+import type { TSchema } from '../../type/schema/index';
+import type { Static } from '../../type/static/index';
+export declare class ValueCreateUnknownTypeError extends Error {
+    readonly schema: TSchema;
+    constructor(schema: TSchema);
+}
+export declare class ValueCreateNeverTypeError extends Error {
+    readonly schema: TSchema;
+    constructor(schema: TSchema);
+}
+export declare class ValueCreateNotTypeError extends Error {
+    readonly schema: TSchema;
+    constructor(schema: TSchema);
+}
+export declare class ValueCreateIntersectTypeError extends Error {
+    readonly schema: TSchema;
+    constructor(schema: TSchema);
+}
+export declare class ValueCreateTempateLiteralTypeError extends Error {
+    readonly schema: TSchema;
+    constructor(schema: TSchema);
+}
+export declare class ValueCreateRecursiveInstantiationError extends Error {
+    readonly schema: TSchema;
+    readonly recursiveMaxDepth: number;
+    constructor(schema: TSchema, recursiveMaxDepth: number);
+}
+/** Creates a value from the given schema and references */
+export declare function Create<T extends TSchema>(schema: T, references: TSchema[]): Static<T>;
+/** Creates a value from the given schema */
+export declare function Create<T extends TSchema>(schema: T): Static<T>;

package/value/{create.js → create/create.js}

@@ -28,49 +28,52 @@ THE SOFTWARE.
 ---------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Create = exports.ValueCreateRecursiveInstantiationError = exports.ValueCreateTempateLiteralTypeError = exports.ValueCreateIntersectTypeError = exports.ValueCreateNotTypeError = exports.ValueCreateNeverTypeError = exports.ValueCreateUnknownTypeError = void 0;
-const guard_1 = require("./guard");
-const check_1 = require("./check");
-const deref_1 = require("./deref");
-const Types = require("../typebox");
-// --------------------------------------------------------------------------
+const index_1 = require("../guard/index");
+const index_2 = require("../check/index");
+const index_3 = require("../deref/index");
+const index_4 = require("../../type/template-literal/index");
+const index_5 = require("../../type/patterns/index");
+const index_6 = require("../../type/registry/index");
+const index_7 = require("../../type/symbols/index");
+// ------------------------------------------------------------------
 // Errors
-// --------------------------------------------------------------------------
-class ValueCreateUnknownTypeError extends Types.TypeBoxError {
+// ------------------------------------------------------------------
+class ValueCreateUnknownTypeError extends Error {
     constructor(schema) {
         super('Unknown type');
         this.schema = schema;
     }
 }
 exports.ValueCreateUnknownTypeError = ValueCreateUnknownTypeError;
-class ValueCreateNeverTypeError extends Types.TypeBoxError {
+class ValueCreateNeverTypeError extends Error {
     constructor(schema) {
         super('Never types cannot be created');
         this.schema = schema;
     }
 }
 exports.ValueCreateNeverTypeError = ValueCreateNeverTypeError;
-class ValueCreateNotTypeError extends Types.TypeBoxError {
+class ValueCreateNotTypeError extends Error {
     constructor(schema) {
         super('Not types must have a default value');
         this.schema = schema;
     }
 }
 exports.ValueCreateNotTypeError = ValueCreateNotTypeError;
-class ValueCreateIntersectTypeError extends Types.TypeBoxError {
+class ValueCreateIntersectTypeError extends Error {
     constructor(schema) {
         super('Intersect produced invalid value. Consider using a default value.');
         this.schema = schema;
     }
 }
 exports.ValueCreateIntersectTypeError = ValueCreateIntersectTypeError;
-class ValueCreateTempateLiteralTypeError extends Types.TypeBoxError {
+class ValueCreateTempateLiteralTypeError extends Error {
     constructor(schema) {
         super('Can only create template literal values from patterns that produce finite sequences. Consider using a default value.');
         this.schema = schema;
     }
 }
 exports.ValueCreateTempateLiteralTypeError = ValueCreateTempateLiteralTypeError;
-class ValueCreateRecursiveInstantiationError extends Types.TypeBoxError {
+class ValueCreateRecursiveInstantiationError extends Error {
     constructor(schema, recursiveMaxDepth) {
         super('Value cannot be created as recursive type may produce value of infinite size. Consider using a default.');
         this.schema = schema;
@@ -78,11 +81,11 @@ class ValueCreateRecursiveInstantiationError extends Types.TypeBoxError {
     }
 }
 exports.ValueCreateRecursiveInstantiationError = ValueCreateRecursiveInstantiationError;
-// --------------------------------------------------------------------------
-// Types
-// --------------------------------------------------------------------------
+// ------------------------------------------------------------------
+// Create
+// ------------------------------------------------------------------
 function TAny(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -90,10 +93,10 @@ function TAny(schema, references) {
     }
 }
 function TArray(schema, references) {
-    if (schema.uniqueItems === true && !(0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if (schema.uniqueItems === true && !(0, index_1.HasPropertyKey)(schema, 'default')) {
         throw new Error('ValueCreate.Array: Array with the uniqueItems constraint requires a default value');
     }
-    else if ('contains' in schema && !(0, guard_1.HasPropertyKey)(schema, 'default')) {
+    else if ('contains' in schema && !(0, index_1.HasPropertyKey)(schema, 'default')) {
         throw new Error('ValueCreate.Array: Array with the contains constraint requires a default value');
     }
     else if ('default' in schema) {
@@ -109,7 +112,7 @@ function TArray(schema, references) {
     }
 }
 function TAsyncIterator(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -117,7 +120,7 @@ function TAsyncIterator(schema, references) {
     }
 }
 function TBigInt(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -125,7 +128,7 @@ function TBigInt(schema, references) {
     }
 }
 function TBoolean(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -133,7 +136,7 @@ function TBoolean(schema, references) {
     }
 }
 function TConstructor(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -155,7 +158,7 @@ function TConstructor(schema, references) {
     }
 }
 function TDate(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else if (schema.minimumTimestamp !== undefined) {
@@ -166,7 +169,7 @@ function TDate(schema, references) {
     }
 }
 function TFunction(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -174,7 +177,7 @@ function TFunction(schema, references) {
     }
 }
 function TInteger(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else if (schema.minimum !== undefined) {
@@ -185,24 +188,28 @@ function TInteger(schema, references) {
     }
 }
 function TIntersect(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
-        // Note: The best we can do here is attempt to instance each sub type and apply through object assign. For non-object
-        // sub types, we just escape the assignment and just return the value. In the latter case, this is typically going to
+        // --------------------------------------------------------------
+        // Note: The best we can do here is attempt to instance each
+        // sub type and apply through object assign. For non-object
+        // sub types, we just escape the assignment and just return
+        // the value. In the latter case, this is typically going to
         // be a consequence of an illogical intersection.
+        // --------------------------------------------------------------
         const value = schema.allOf.reduce((acc, schema) => {
             const next = Visit(schema, references);
             return typeof next === 'object' ? { ...acc, ...next } : next;
         }, {});
-        if (!(0, check_1.Check)(schema, references, value))
+        if (!(0, index_2.Check)(schema, references, value))
             throw new ValueCreateIntersectTypeError(schema);
         return value;
     }
 }
 function TIterator(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -210,7 +217,7 @@ function TIterator(schema, references) {
     }
 }
 function TLiteral(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -221,7 +228,7 @@ function TNever(schema, references) {
     throw new ValueCreateNeverTypeError(schema);
 }
 function TNot(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -229,7 +236,7 @@ function TNot(schema, references) {
     }
 }
 function TNull(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -237,7 +244,7 @@ function TNull(schema, references) {
     }
 }
 function TNumber(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else if (schema.minimum !== undefined) {
@@ -248,7 +255,7 @@ function TNumber(schema, references) {
     }
 }
 function TObject(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -260,7 +267,7 @@ function TObject(schema, references) {
     }
 }
 function TPromise(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -269,10 +276,10 @@ function TPromise(schema, references) {
 }
 function TRecord(schema, references) {
     const [keyPattern, valueSchema] = Object.entries(schema.patternProperties)[0];
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
-    else if (!(keyPattern === Types.PatternStringExact || keyPattern === Types.PatternNumberExact)) {
+    else if (!(keyPattern === index_5.PatternStringExact || keyPattern === index_5.PatternNumberExact)) {
         const propertyKeys = keyPattern.slice(1, keyPattern.length - 1).split('|');
         return propertyKeys.reduce((acc, key) => {
             return { ...acc, [key]: Visit(valueSchema, references) };
@@ -283,16 +290,16 @@ function TRecord(schema, references) {
     }
 }
 function TRef(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
-        return Visit((0, deref_1.Deref)(schema, references), references);
+        return Visit((0, index_3.Deref)(schema, references), references);
     }
 }
 function TString(schema, references) {
     if (schema.pattern !== undefined) {
-        if (!(0, guard_1.HasPropertyKey)(schema, 'default')) {
+        if (!(0, index_1.HasPropertyKey)(schema, 'default')) {
             throw new Error('ValueCreate.String: String types with patterns must specify a default value');
         }
         else {
@@ -300,7 +307,7 @@ function TString(schema, references) {
         }
     }
     else if (schema.format !== undefined) {
-        if (!(0, guard_1.HasPropertyKey)(schema, 'default')) {
+        if (!(0, index_1.HasPropertyKey)(schema, 'default')) {
             throw new Error('ValueCreate.String: String types with formats must specify a default value');
         }
         else {
@@ -308,7 +315,7 @@ function TString(schema, references) {
         }
     }
     else {
-        if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+        if ((0, index_1.HasPropertyKey)(schema, 'default')) {
             return schema.default;
         }
         else if (schema.minLength !== undefined) {
@@ -322,7 +329,7 @@ function TString(schema, references) {
     }
 }
 function TSymbol(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else if ('value' in schema) {
@@ -333,27 +340,27 @@ function TSymbol(schema, references) {
     }
 }
 function TTemplateLiteral(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
-    const expression = Types.TemplateLiteralParser.ParseExact(schema.pattern);
-    if (!Types.TemplateLiteralFinite.Check(expression))
+    const expression = (0, index_4.TemplateLiteralParseExact)(schema.pattern);
+    if (!(0, index_4.IsTemplateLiteralFinite)(expression))
         throw new ValueCreateTempateLiteralTypeError(schema);
-    const sequence = Types.TemplateLiteralGenerator.Generate(expression);
+    const sequence = (0, index_4.TemplateLiteralGenerate)(expression);
     return sequence.next().value;
 }
 function TThis(schema, references) {
     if (recursiveDepth++ > recursiveMaxDepth)
         throw new ValueCreateRecursiveInstantiationError(schema, recursiveMaxDepth);
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
-        return Visit((0, deref_1.Deref)(schema, references), references);
+        return Visit((0, index_3.Deref)(schema, references), references);
     }
 }
 function TTuple(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     if (schema.items === undefined) {
@@ -364,7 +371,7 @@ function TTuple(schema, references) {
     }
 }
 function TUndefined(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -372,7 +379,7 @@ function TUndefined(schema, references) {
     }
 }
 function TUnion(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else if (schema.anyOf.length === 0) {
@@ -383,7 +390,7 @@ function TUnion(schema, references) {
     }
 }
 function TUint8Array(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else if (schema.minByteLength !== undefined) {
@@ -394,7 +401,7 @@ function TUint8Array(schema, references) {
     }
 }
 function TUnknown(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -402,7 +409,7 @@ function TUnknown(schema, references) {
     }
 }
 function TVoid(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -410,7 +417,7 @@ function TVoid(schema, references) {
     }
 }
 function TKind(schema, references) {
-    if ((0, guard_1.HasPropertyKey)(schema, 'default')) {
+    if ((0, index_1.HasPropertyKey)(schema, 'default')) {
         return schema.default;
     }
     else {
@@ -418,9 +425,9 @@ function TKind(schema, references) {
     }
 }
 function Visit(schema, references) {
-    const references_ = (0, guard_1.IsString)(schema.$id) ? [...references, schema] : references;
+    const references_ = (0, index_1.IsString)(schema.$id) ? [...references, schema] : references;
     const schema_ = schema;
-    switch (schema_[Types.Kind]) {
+    switch (schema_[index_7.Kind]) {
         case 'Any':
             return TAny(schema_, references_);
         case 'Array':
@@ -482,14 +489,14 @@ function Visit(schema, references) {
         case 'Void':
             return TVoid(schema_, references_);
         default:
-            if (!Types.TypeRegistry.Has(schema_[Types.Kind]))
+            if (!index_6.TypeRegistry.Has(schema_[index_7.Kind]))
                 throw new ValueCreateUnknownTypeError(schema_);
             return TKind(schema_, references_);
     }
 }
-// --------------------------------------------------------------------------
+// ------------------------------------------------------------------
 // State
-// --------------------------------------------------------------------------
+// ------------------------------------------------------------------
 const recursiveMaxDepth = 512;
 let recursiveDepth = 0;
 /** Creates a value from the given schema */

package/value/create/index.d.ts

@@ -0,0 +1 @@
+export * from './create';

package/value/create/index.js

@@ -0,0 +1,44 @@
+"use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/value
+
+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("./create"), exports);

package/value/default/default.d.ts

@@ -0,0 +1,5 @@
+import type { TSchema } from '../../type/schema/index';
+/** `[Mutable]` Generates missing properties on a value using default schema annotations if available. This function does not check the value and returns an unknown type. You should Check the result before use. Default is a mutable operation. To avoid mutation, Clone the value first. */
+export declare function Default<T extends TSchema>(schema: T, references: TSchema[], value: unknown): unknown;
+/** `[Mutable]` Generates missing properties on a value using default schema annotations if available. This function does not check the value and returns an unknown type. You should Check the result before use. Default is a mutable operation. To avoid mutation, Clone the value first. */
+export declare function Default<T extends TSchema>(schema: T, value: unknown): unknown;