@sinclair/typebox 0.23.4 → 0.24.1

package/value/check.js

@@ -0,0 +1,232 @@
+"use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/value
+
+The MIT License (MIT)
+
+Copyright (c) 2022 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.CheckValue = void 0;
+const Types = require("../typebox");
+var CheckValue;
+(function (CheckValue) {
+    const referenceMap = new Map();
+    function Any(schema, value) {
+        return true;
+    }
+    function Array(schema, value) {
+        if (typeof value !== 'object' || !globalThis.Array.isArray(value))
+            return false;
+        for (let i = 0; i < value.length; i++) {
+            if (!Visit(schema.items, value[i]))
+                return false;
+        }
+        return true;
+    }
+    function Boolean(schema, value) {
+        return typeof value === 'boolean';
+    }
+    function Constructor(schema, value) {
+        return Visit(schema.returns, value.prototype); // check return type only (as an object)
+    }
+    function Enum(schema, value) {
+        for (const subschema of schema.anyOf) {
+            if (subschema.const === value)
+                return true;
+        }
+        return false;
+    }
+    function Function(schema, value) {
+        return typeof value === 'function';
+    }
+    function Integer(schema, value) {
+        return typeof value === 'number' && globalThis.Number.isInteger(value);
+    }
+    function Intersect(schema, value) {
+        return Object(schema, value);
+    }
+    function Literal(schema, value) {
+        return schema.const === value;
+    }
+    function Null(schema, value) {
+        return value === null;
+    }
+    function Number(schema, value) {
+        return typeof value === 'number';
+    }
+    function Object(schema, value) {
+        if (typeof value !== 'object' || value === null)
+            return false;
+        const propertyKeys = globalThis.Object.keys(schema.properties);
+        if (schema.additionalProperties === false) {
+            const valueKeys = globalThis.Object.keys(value);
+            for (const valueKey of valueKeys) {
+                if (!propertyKeys.includes(valueKey))
+                    return false;
+            }
+        }
+        for (const propertyKey of propertyKeys) {
+            const propertySchema = schema.properties[propertyKey];
+            const propertyValue = value[propertyKey];
+            if (propertyValue === undefined && schema.required !== undefined && !schema.required.includes(propertyKey))
+                return true;
+            if (!Visit(propertySchema, propertyValue))
+                return false;
+        }
+        return true;
+    }
+    function Promise(schema, value) {
+        return typeof value === 'object' && typeof value['then'] === 'function';
+    }
+    function Record(schema, value) {
+        if (typeof value !== 'object' || value === null)
+            return false;
+        const propertySchema = globalThis.Object.values(schema.patternProperties)[0];
+        for (const key of globalThis.Object.keys(value)) {
+            const propertyValue = value[key];
+            if (!Visit(propertySchema, propertyValue))
+                return false;
+        }
+        return true;
+    }
+    function Recursive(schema, value) {
+        throw new Error('Cannot typeof recursive types');
+    }
+    function Ref(schema, value) {
+        throw new Error('Cannot typeof reference types');
+    }
+    function Self(schema, value) {
+        if (!referenceMap.has(schema.$ref))
+            throw new Error(`Check: Cannot locate schema with $id '${schema.$id}' for referenced type`);
+        const referenced = referenceMap.get(schema.$ref);
+        return Visit(referenced, value);
+    }
+    function String(schema, value) {
+        if (typeof value !== 'string')
+            return false;
+        if (schema.pattern !== undefined) {
+            const regex = new RegExp(schema.pattern);
+            return value.match(regex) !== null;
+        }
+        return true;
+    }
+    function Tuple(schema, value) {
+        if (typeof value !== 'object' || !globalThis.Array.isArray(value))
+            return false;
+        if (schema.items === undefined && value.length === 0)
+            return true;
+        if (schema.items === undefined)
+            return false;
+        if (value.length < schema.minItems || value.length > schema.maxItems)
+            return false;
+        for (let i = 0; i < schema.items.length; i++) {
+            if (!Visit(schema.items[i], value[i]))
+                return false;
+        }
+        return true;
+    }
+    function Undefined(schema, value) {
+        return value === undefined;
+    }
+    function Union(schema, value) {
+        for (let i = 0; i < schema.anyOf.length; i++) {
+            if (Visit(schema.anyOf[i], value))
+                return true;
+        }
+        return false;
+    }
+    function Uint8Array(schema, value) {
+        return value instanceof globalThis.Uint8Array;
+    }
+    function Unknown(schema, value) {
+        return true;
+    }
+    function Void(schema, value) {
+        return value === null;
+    }
+    function Visit(schema, value) {
+        if (schema.$id !== undefined)
+            referenceMap.set(schema.$id, schema);
+        const anySchema = schema;
+        switch (anySchema[Types.Kind]) {
+            case 'Any':
+                return Any(anySchema, value);
+            case 'Array':
+                return Array(anySchema, value);
+            case 'Boolean':
+                return Boolean(anySchema, value);
+            case 'Constructor':
+                return Constructor(anySchema, value);
+            case 'Enum':
+                return Enum(anySchema, value);
+            case 'Function':
+                return Function(anySchema, value);
+            case 'Integer':
+                return Integer(anySchema, value);
+            case 'Intersect':
+                return Intersect(anySchema, value);
+            case 'Literal':
+                return Literal(anySchema, value);
+            case 'Null':
+                return Null(anySchema, value);
+            case 'Number':
+                return Number(anySchema, value);
+            case 'Object':
+                return Object(anySchema, value);
+            case 'Promise':
+                return Promise(anySchema, value);
+            case 'Record':
+                return Record(anySchema, value);
+            case 'Rec':
+                return Recursive(anySchema, value);
+            case 'Ref':
+                return Ref(anySchema, value);
+            case 'Self':
+                return Self(anySchema, value);
+            case 'String':
+                return String(anySchema, value);
+            case 'Tuple':
+                return Tuple(anySchema, value);
+            case 'Undefined':
+                return Undefined(anySchema, value);
+            case 'Union':
+                return Union(anySchema, value);
+            case 'Uint8Array':
+                return Uint8Array(anySchema, value);
+            case 'Unknown':
+                return Unknown(anySchema, value);
+            case 'Void':
+                return Void(anySchema, value);
+            default:
+                throw Error(`Unknown schema kind '${schema[Types.Kind]}'`);
+        }
+    }
+    CheckValue.Visit = Visit;
+    function Check(schema, value) {
+        if (referenceMap.size > 0)
+            referenceMap.clear();
+        return Visit(schema, value);
+    }
+    CheckValue.Check = Check;
+})(CheckValue = exports.CheckValue || (exports.CheckValue = {}));

package/value/clone.d.ts

@@ -0,0 +1,3 @@
+export declare namespace CloneValue {
+    function Create<T extends any>(value: T): T;
+}

package/value/clone.js

@@ -0,0 +1,94 @@
+"use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/value
+
+The MIT License (MIT)
+
+Copyright (c) 2022 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.CloneValue = void 0;
+const reflect_1 = require("./reflect");
+var CloneValue;
+(function (CloneValue) {
+    function Undefined(_value) {
+        return undefined;
+    }
+    function Null(_value) {
+        return null;
+    }
+    function Function(value) {
+        return value;
+    }
+    function Object(value) {
+        return globalThis.Object.entries(value).reduce((acc, [key, value]) => {
+            return { ...acc, [key]: Create(value) };
+        }, {});
+    }
+    function Array(value) {
+        return value.map((element) => Create(element));
+    }
+    function BigInt(value) {
+        return value;
+    }
+    function Symbol(value) {
+        return value;
+    }
+    function String(value) {
+        return value;
+    }
+    function Boolean(value) {
+        return value;
+    }
+    function Number(value) {
+        return value;
+    }
+    function Create(value) {
+        const typeName = (0, reflect_1.Reflect)(value);
+        switch (typeName) {
+            case 'array':
+                return Array(value);
+            case 'bigint':
+                return BigInt(value);
+            case 'boolean':
+                return Boolean(value);
+            case 'function':
+                return Function(value);
+            case 'null':
+                return Null(value);
+            case 'number':
+                return Number(value);
+            case 'object':
+                return Object(value);
+            case 'string':
+                return String(value);
+            case 'symbol':
+                return Symbol(value);
+            case 'undefined':
+                return Undefined(value);
+            default:
+                throw new Error(`Cannot clone from unknown typename ${typeName}`);
+        }
+    }
+    CloneValue.Create = Create;
+})(CloneValue = exports.CloneValue || (exports.CloneValue = {}));

package/value/create.d.ts

@@ -0,0 +1,7 @@
+import * as Types from '../typebox';
+export declare namespace CreateValue {
+    /** Creates a value from the given schema. If the schema specifies a default value, then that value is returned. */
+    function Visit<T extends Types.TSchema>(schema: T): Types.Static<T>;
+    /** Creates a value from the given schema. If the schema specifies a default value, then that value is returned. */
+    function Create<T extends Types.TSchema>(schema: T): Types.Static<T>;
+}

package/value/create.js

@@ -0,0 +1,337 @@
+"use strict";
+/*--------------------------------------------------------------------------
+
+@sinclair/typebox/value
+
+The MIT License (MIT)
+
+Copyright (c) 2022 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.CreateValue = void 0;
+const Types = require("../typebox");
+var CreateValue;
+(function (CreateValue) {
+    const referenceMap = new Map();
+    let recursionDepth = 0;
+    function Any(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            return {};
+        }
+    }
+    function Array(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else if (schema.minItems !== undefined) {
+            return globalThis.Array.from({ length: schema.minItems }).map((item) => {
+                return CreateValue.Create(schema.items);
+            });
+        }
+        else {
+            return [];
+        }
+    }
+    function Boolean(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            return false;
+        }
+    }
+    function Constructor(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            const value = CreateValue.Create(schema.returns);
+            if (typeof value === 'object' && !globalThis.Array.isArray(value)) {
+                return class {
+                    constructor() {
+                        for (const [key, val] of globalThis.Object.entries(value)) {
+                            const facade = this;
+                            facade[key] = val;
+                        }
+                    }
+                };
+            }
+            else {
+                return class {
+                };
+            }
+        }
+    }
+    function Enum(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else if (schema.anyOf.length === 0) {
+            throw new Error('Cannot create default enum value as this enum has no items');
+        }
+        else {
+            return schema.anyOf[0].const;
+        }
+    }
+    function Function(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            return () => CreateValue.Create(schema.returns);
+        }
+    }
+    function Integer(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else if (schema.minimum !== undefined) {
+            return schema.minimum;
+        }
+        else {
+            return 0;
+        }
+    }
+    function Intersect(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            return (schema.default ||
+                globalThis.Object.entries(schema.properties).reduce((acc, [key, schema]) => {
+                    return { ...acc, [key]: CreateValue.Create(schema) };
+                }, {}));
+        }
+    }
+    function Literal(schema) {
+        return schema.const;
+    }
+    function Null(schema) {
+        return null;
+    }
+    function Number(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else if (schema.minimum !== undefined) {
+            return schema.minimum;
+        }
+        else {
+            return 0;
+        }
+    }
+    function Object(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            // StackOverflow Prevention
+            if (schema['$dynamicAnchor'] !== undefined) {
+                for (const [key, value] of globalThis.Object.entries(schema.properties)) {
+                    if (value['$dynamicRef'] !== undefined && schema.required && schema.required.includes(key)) {
+                        throw Error(`Cannot create recursive object with immediate recursive property`);
+                    }
+                }
+            }
+            const required = new Set(schema.required);
+            return (schema.default ||
+                globalThis.Object.entries(schema.properties).reduce((acc, [key, schema]) => {
+                    return required.has(key) ? { ...acc, [key]: CreateValue.Create(schema) } : { ...acc };
+                }, {}));
+        }
+    }
+    function Promise(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            return globalThis.Promise.resolve(CreateValue.Create(schema.item));
+        }
+    }
+    function Record(schema) {
+        const [keyPattern, valueSchema] = globalThis.Object.entries(schema.patternProperties)[0];
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else if (!(keyPattern === '^.*$' || keyPattern === '^(0|[1-9][0-9]*)$')) {
+            const propertyKeys = keyPattern.slice(1, keyPattern.length - 1).split('|');
+            return propertyKeys.reduce((acc, key) => {
+                return { ...acc, [key]: Create(valueSchema) };
+            }, {});
+        }
+        else {
+            return {};
+        }
+    }
+    function Recursive(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            throw new Error('Rec types require a default value');
+        }
+    }
+    function Ref(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            throw new Error('Ref types require a default value');
+        }
+    }
+    function String(schema) {
+        if (schema.pattern !== undefined) {
+            if (schema.default === undefined) {
+                throw Error('String types with patterns must specify a default value');
+            }
+            else {
+                return schema.default;
+            }
+        }
+        else {
+            if (schema.default !== undefined) {
+                return schema.default;
+            }
+            else {
+                return '';
+            }
+        }
+    }
+    function Tuple(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        if (schema.items === undefined) {
+            return [];
+        }
+        else {
+            return globalThis.Array.from({ length: schema.minItems }).map((_, index) => CreateValue.Create(schema.items[index]));
+        }
+    }
+    function Undefined(schema) {
+        return undefined;
+    }
+    function Union(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else if (schema.anyOf.length === 0) {
+            throw Error('Cannot generate Union with empty set');
+        }
+        else {
+            return CreateValue.Create(schema.anyOf[0]);
+        }
+    }
+    function Uint8Array(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else if (schema.minByteLength) {
+            return new globalThis.Uint8Array(schema.minByteLength);
+        }
+        else {
+            return new globalThis.Uint8Array(0);
+        }
+    }
+    function Unknown(schema) {
+        if (schema.default !== undefined) {
+            return schema.default;
+        }
+        else {
+            return {};
+        }
+    }
+    function Void(schema) {
+        return null;
+    }
+    /** Creates a value from the given schema. If the schema specifies a default value, then that value is returned. */
+    function Visit(schema) {
+        recursionDepth += 1;
+        if (recursionDepth >= 1000)
+            throw new Error('Cannot create value as schema contains a infinite expansion');
+        const anySchema = schema;
+        if (anySchema.$id !== undefined)
+            referenceMap.set(anySchema.$id, anySchema);
+        switch (anySchema[Types.Kind]) {
+            case 'Any':
+                return Any(anySchema);
+            case 'Array':
+                return Array(anySchema);
+            case 'Boolean':
+                return Boolean(anySchema);
+            case 'Constructor':
+                return Constructor(anySchema);
+            case 'Enum':
+                return Enum(anySchema);
+            case 'Function':
+                return Function(anySchema);
+            case 'Integer':
+                return Integer(anySchema);
+            case 'Intersect':
+                return Intersect(anySchema);
+            case 'Literal':
+                return Literal(anySchema);
+            case 'Null':
+                return Null(anySchema);
+            case 'Number':
+                return Number(anySchema);
+            case 'Object':
+                return Object(anySchema);
+            case 'Promise':
+                return Promise(anySchema);
+            case 'Record':
+                return Record(anySchema);
+            case 'Rec':
+                return Recursive(anySchema);
+            case 'Ref':
+                return Ref(anySchema);
+            case 'String':
+                return String(anySchema);
+            case 'Tuple':
+                return Tuple(anySchema);
+            case 'Undefined':
+                return Undefined(anySchema);
+            case 'Union':
+                return Union(anySchema);
+            case 'Uint8Array':
+                return Uint8Array(anySchema);
+            case 'Unknown':
+                return Unknown(anySchema);
+            case 'Void':
+                return Void(anySchema);
+            case 'Self':
+                return Visit(referenceMap.get(anySchema.$ref));
+            default:
+                throw Error(`Unknown schema kind '${schema[Types.Kind]}'`);
+        }
+    }
+    CreateValue.Visit = Visit;
+    /** Creates a value from the given schema. If the schema specifies a default value, then that value is returned. */
+    function Create(schema) {
+        recursionDepth = 0;
+        return Visit(schema);
+    }
+    CreateValue.Create = Create;
+})(CreateValue = exports.CreateValue || (exports.CreateValue = {}));

package/value/delta.d.ts

@@ -0,0 +1,13 @@
+export declare enum EditType {
+    Delete = 0,
+    Update = 1,
+    Insert = 2
+}
+export declare type Edit = Insert | Update | Delete;
+export declare type Update = [EditType.Update, string, any];
+export declare type Insert = [EditType.Insert, string, any];
+export declare type Delete = [EditType.Delete, string];
+export declare namespace DeltaValue {
+    function Diff(valueA: any, valueB: any): Edit[];
+    function Edit(valueA: any, operations: Edit[]): any;
+}