@sinclair/typebox 0.31.28 → 0.32.0-dev-2

package/esm/value/convert/convert.d.mts

@@ -0,0 +1,9 @@
+import type { TSchema } from '../../type/schema/index.mjs';
+export declare class ValueConvertUnknownTypeError extends Error {
+    readonly schema: TSchema;
+    constructor(schema: TSchema);
+}
+/** Converts any type mismatched values to their target type if a reasonable conversion is possible. */
+export declare function Convert<T extends TSchema>(schema: T, references: TSchema[], value: unknown): unknown;
+/** Converts any type mismatched values to their target type if a reasonable conversion is possible. */
+export declare function Convert<T extends TSchema>(schema: T, value: unknown): unknown;

package/esm/value/convert/convert.mjs

@@ -0,0 +1,287 @@
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
+import { IsArray, IsObject, IsDate, IsUndefined, IsString, IsNumber, IsBoolean, IsBigInt, IsSymbol } from '../guard/index.mjs';
+import { Clone } from '../clone/index.mjs';
+import { Check } from '../check/index.mjs';
+import { Deref } from '../deref/index.mjs';
+import { TObject as IsObjectType } from '../../type/guard/type.mjs';
+import { Kind } from '../../type/symbols/index.mjs';
+import { Composite } from '../../type/composite/index.mjs';
+// ------------------------------------------------------------------
+// Errors
+// ------------------------------------------------------------------
+export class ValueConvertUnknownTypeError extends Error {
+    schema;
+    constructor(schema) {
+        super('Unknown type');
+        this.schema = schema;
+    }
+}
+// ------------------------------------------------------------------
+// Conversions
+// ------------------------------------------------------------------
+function IsStringNumeric(value) {
+    return IsString(value) && !isNaN(value) && !isNaN(parseFloat(value));
+}
+function IsValueToString(value) {
+    return IsBigInt(value) || IsBoolean(value) || IsNumber(value);
+}
+function IsValueTrue(value) {
+    return value === true || (IsNumber(value) && value === 1) || (IsBigInt(value) && value === BigInt('1')) || (IsString(value) && (value.toLowerCase() === 'true' || value === '1'));
+}
+function IsValueFalse(value) {
+    return value === false || (IsNumber(value) && (value === 0 || Object.is(value, -0))) || (IsBigInt(value) && value === BigInt('0')) || (IsString(value) && (value.toLowerCase() === 'false' || value === '0' || value === '-0'));
+}
+function IsTimeStringWithTimeZone(value) {
+    return IsString(value) && /^(?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)(?:\.\d+)?(?:z|[+-]\d\d(?::?\d\d)?)$/i.test(value);
+}
+function IsTimeStringWithoutTimeZone(value) {
+    return IsString(value) && /^(?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)?$/i.test(value);
+}
+function IsDateTimeStringWithTimeZone(value) {
+    return IsString(value) && /^\d\d\d\d-[0-1]\d-[0-3]\dt(?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)(?:\.\d+)?(?:z|[+-]\d\d(?::?\d\d)?)$/i.test(value);
+}
+function IsDateTimeStringWithoutTimeZone(value) {
+    return IsString(value) && /^\d\d\d\d-[0-1]\d-[0-3]\dt(?:[0-2]\d:[0-5]\d:[0-5]\d|23:59:60)?$/i.test(value);
+}
+function IsDateString(value) {
+    return IsString(value) && /^\d\d\d\d-[0-1]\d-[0-3]\d$/i.test(value);
+}
+// ------------------------------------------------------------------
+// Convert
+// ------------------------------------------------------------------
+function TryConvertLiteralString(value, target) {
+    const conversion = TryConvertString(value);
+    return conversion === target ? conversion : value;
+}
+function TryConvertLiteralNumber(value, target) {
+    const conversion = TryConvertNumber(value);
+    return conversion === target ? conversion : value;
+}
+function TryConvertLiteralBoolean(value, target) {
+    const conversion = TryConvertBoolean(value);
+    return conversion === target ? conversion : value;
+}
+// prettier-ignore
+function TryConvertLiteral(schema, value) {
+    return (IsString(schema.const) ? TryConvertLiteralString(value, schema.const) :
+        IsNumber(schema.const) ? TryConvertLiteralNumber(value, schema.const) :
+            IsBoolean(schema.const) ? TryConvertLiteralBoolean(value, schema.const) :
+                Clone(value));
+}
+function TryConvertBoolean(value) {
+    return IsValueTrue(value) ? true : IsValueFalse(value) ? false : value;
+}
+function TryConvertBigInt(value) {
+    return IsStringNumeric(value) ? BigInt(parseInt(value)) : IsNumber(value) ? BigInt(value | 0) : IsValueFalse(value) ? BigInt(0) : IsValueTrue(value) ? BigInt(1) : value;
+}
+function TryConvertString(value) {
+    return IsValueToString(value) ? value.toString() : IsSymbol(value) && value.description !== undefined ? value.description.toString() : value;
+}
+function TryConvertNumber(value) {
+    return IsStringNumeric(value) ? parseFloat(value) : IsValueTrue(value) ? 1 : IsValueFalse(value) ? 0 : value;
+}
+function TryConvertInteger(value) {
+    return IsStringNumeric(value) ? parseInt(value) : IsNumber(value) ? value | 0 : IsValueTrue(value) ? 1 : IsValueFalse(value) ? 0 : value;
+}
+function TryConvertNull(value) {
+    return IsString(value) && value.toLowerCase() === 'null' ? null : value;
+}
+function TryConvertUndefined(value) {
+    return IsString(value) && value === 'undefined' ? undefined : value;
+}
+// ------------------------------------------------------------------
+// note: this function may return an invalid dates for the regex
+// tests above. Invalid dates will however be checked during the
+// casting function and will return a epoch date if invalid.
+// Consider better string parsing for the iso dates in future
+// revisions.
+// ------------------------------------------------------------------
+// prettier-ignore
+function TryConvertDate(value) {
+    return (IsDate(value) ? value :
+        IsNumber(value) ? new Date(value) :
+            IsValueTrue(value) ? new Date(1) :
+                IsValueFalse(value) ? new Date(0) :
+                    IsStringNumeric(value) ? new Date(parseInt(value)) :
+                        IsTimeStringWithoutTimeZone(value) ? new Date(`1970-01-01T${value}.000Z`) :
+                            IsTimeStringWithTimeZone(value) ? new Date(`1970-01-01T${value}`) :
+                                IsDateTimeStringWithoutTimeZone(value) ? new Date(`${value}.000Z`) :
+                                    IsDateTimeStringWithTimeZone(value) ? new Date(value) :
+                                        IsDateString(value) ? new Date(`${value}T00:00:00.000Z`) :
+                                            value);
+}
+// ------------------------------------------------------------------
+// Default
+// ------------------------------------------------------------------
+function Default(value) {
+    return value;
+}
+// ------------------------------------------------------------------
+// Convert
+// ------------------------------------------------------------------
+function TArray(schema, references, value) {
+    if (IsArray(value)) {
+        return value.map((value) => Visit(schema.items, references, value));
+    }
+    return value;
+}
+function TBigInt(schema, references, value) {
+    return TryConvertBigInt(value);
+}
+function TBoolean(schema, references, value) {
+    return TryConvertBoolean(value);
+}
+function TDate(schema, references, value) {
+    return TryConvertDate(value);
+}
+function TInteger(schema, references, value) {
+    return TryConvertInteger(value);
+}
+// prettier-ignore
+function TIntersect(schema, references, value) {
+    const allObjects = schema.allOf.every(schema => IsObjectType(schema));
+    if (allObjects)
+        return Visit(Composite(schema.allOf), references, value);
+    return Visit(schema.allOf[0], references, value); // todo: fix this
+}
+function TLiteral(schema, references, value) {
+    return TryConvertLiteral(schema, value);
+}
+function TNull(schema, references, value) {
+    return TryConvertNull(value);
+}
+function TNumber(schema, references, value) {
+    return TryConvertNumber(value);
+}
+// prettier-ignore
+function TObject(schema, references, value) {
+    const isConvertable = IsObject(value);
+    if (!isConvertable)
+        return value;
+    return Object.getOwnPropertyNames(schema.properties).reduce((value, key) => {
+        return !IsUndefined(value[key])
+            ? ({ ...value, [key]: Visit(schema.properties[key], references, value[key]) })
+            : ({ ...value });
+    }, value);
+}
+function TRecord(schema, references, value) {
+    const propertyKey = Object.getOwnPropertyNames(schema.patternProperties)[0];
+    const property = schema.patternProperties[propertyKey];
+    const result = {};
+    for (const [propKey, propValue] of Object.entries(value)) {
+        result[propKey] = Visit(property, references, propValue);
+    }
+    return result;
+}
+function TRef(schema, references, value) {
+    return Visit(Deref(schema, references), references, value);
+}
+function TString(schema, references, value) {
+    return TryConvertString(value);
+}
+function TSymbol(schema, references, value) {
+    return IsString(value) || IsNumber(value) ? Symbol(value) : value;
+}
+function TThis(schema, references, value) {
+    return Visit(Deref(schema, references), references, value);
+}
+// prettier-ignore
+function TTuple(schema, references, value) {
+    const isConvertable = IsArray(value) && !IsUndefined(schema.items);
+    if (!isConvertable)
+        return value;
+    return value.map((value, index) => {
+        return (index < schema.items.length)
+            ? Visit(schema.items[index], references, value)
+            : value;
+    });
+}
+function TUndefined(schema, references, value) {
+    return TryConvertUndefined(value);
+}
+function TUnion(schema, references, value) {
+    for (const subschema of schema.anyOf) {
+        const converted = Visit(subschema, references, value);
+        if (Check(subschema, references, converted)) {
+            return converted;
+        }
+    }
+    return value;
+}
+function Visit(schema, references, value) {
+    const references_ = IsString(schema.$id) ? [...references, schema] : references;
+    const schema_ = schema;
+    switch (schema[Kind]) {
+        case 'Array':
+            return TArray(schema_, references_, value);
+        case 'BigInt':
+            return TBigInt(schema_, references_, value);
+        case 'Boolean':
+            return TBoolean(schema_, references_, value);
+        case 'Date':
+            return TDate(schema_, references_, value);
+        case 'Integer':
+            return TInteger(schema_, references_, value);
+        case 'Intersect':
+            return TIntersect(schema_, references_, value);
+        case 'Literal':
+            return TLiteral(schema_, references_, value);
+        case 'Null':
+            return TNull(schema_, references_, value);
+        case 'Number':
+            return TNumber(schema_, references_, value);
+        case 'Object':
+            return TObject(schema_, references_, value);
+        case 'Record':
+            return TRecord(schema_, references_, value);
+        case 'Ref':
+            return TRef(schema_, references_, value);
+        case 'String':
+            return TString(schema_, references_, value);
+        case 'Symbol':
+            return TSymbol(schema_, references_, value);
+        case 'This':
+            return TThis(schema_, references_, value);
+        case 'Tuple':
+            return TTuple(schema_, references_, value);
+        case 'Undefined':
+            return TUndefined(schema_, references_, value);
+        case 'Union':
+            return TUnion(schema_, references_, value);
+        default:
+            return Default(value);
+    }
+}
+/** Converts any type mismatched values to their target type if a reasonable conversion is possible. */
+// prettier-ignore
+export function Convert(...args) {
+    return args.length === 3
+        ? Visit(args[0], args[1], args[2])
+        : Visit(args[0], [], args[1]);
+}

package/esm/value/convert/index.d.mts

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

package/esm/value/convert/index.mjs

@@ -0,0 +1,28 @@
+/*--------------------------------------------------------------------------
+
+@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.
+
+---------------------------------------------------------------------------*/
+export * from './convert.mjs';

package/esm/value/create/create.d.mts

@@ -0,0 +1,31 @@
+import type { TSchema } from '../../type/schema/index.mjs';
+import type { Static } from '../../type/static/index.mjs';
+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>;