@sinclair/typebox
Version:
JSONSchema Type Builder with Static Type Resolution for TypeScript
248 lines (240 loc) • 10.9 kB
JavaScript
;
/*--------------------------------------------------------------------------
@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.UpcastValue = void 0;
const Types = require("../typebox");
const create_1 = require("./create");
const check_1 = require("./check");
// --------------------------------------------------------------------------
// Specialized Union Patch. Because a value can be one of many different
// unions with properties potentially overlapping, we need a strategy
// in which to resolve the appropriate schema to patch from.
//
// The following will score each union type found within the types anyOf
// array. Typically this is executed for objects only, so the score is a
// essentially a tally of how many properties are valid. The reasoning
// here is the discriminator field would tip the scales in favor of that
// union if other properties overlap and match.
// --------------------------------------------------------------------------
var UpcastUnionValue;
(function (UpcastUnionValue) {
function Score(schema, value) {
let score = 0;
if (schema[Types.Kind] === 'Object' && typeof value === 'object' && value !== null) {
const objectSchema = schema;
const entries = globalThis.Object.entries(objectSchema.properties);
score += entries.reduce((acc, [key, schema]) => acc + (check_1.CheckValue.Visit(schema, value[key]) ? 1 : 0), 0);
}
return score;
}
function Select(schema, value) {
let select = schema.anyOf[0];
let best = 0;
for (const subschema of schema.anyOf) {
const score = Score(subschema, value);
if (score > best) {
select = subschema;
best = score;
}
}
return select;
}
function Create(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : UpcastValue.Create(Select(schema, value), value);
}
UpcastUnionValue.Create = Create;
})(UpcastUnionValue || (UpcastUnionValue = {}));
var UpcastValue;
(function (UpcastValue) {
const ids = new Map();
function Any(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Array(schema, value) {
if (check_1.CheckValue.Visit(schema, value))
return value;
if (!globalThis.Array.isArray(value))
return create_1.CreateValue.Create(schema);
return value.map((element) => Create(schema.items, element));
}
function Boolean(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Constructor(schema, value) {
if (check_1.CheckValue.Visit(schema, value))
return create_1.CreateValue.Create(schema);
const required = new Set(schema.returns.required || []);
const result = function () { };
for (const [key, property] of globalThis.Object.entries(schema.returns.properties)) {
if (!required.has(key) && value.prototype[key] === undefined)
continue;
result.prototype[key] = Create(property, value.prototype[key]);
}
return result;
}
function Enum(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Function(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Integer(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Intersect(schema, value) {
return Object(schema, value);
}
function Literal(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Null(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Number(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Object(schema, value) {
if (check_1.CheckValue.Visit(schema, value))
return value;
if (value === null || typeof value !== 'object')
return create_1.CreateValue.Create(schema);
ids.set(schema.$id, schema);
const required = new Set(schema.required || []);
const result = {};
for (const [key, property] of globalThis.Object.entries(schema.properties)) {
if (!required.has(key) && value[key] === undefined)
continue;
result[key] = Create(property, value[key]);
}
return result;
}
function Promise(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Record(schema, value) {
if (check_1.CheckValue.Visit(schema, value))
return value;
if (value === null || typeof value !== 'object' || globalThis.Array.isArray(value))
return create_1.CreateValue.Create(schema);
const subschemaKey = globalThis.Object.keys(schema.patternProperties)[0];
const subschema = schema.patternProperties[subschemaKey];
const result = {};
for (const [key, property] of globalThis.Object.entries(value)) {
result[key] = Create(subschema, property);
}
return result;
}
function Recursive(schema, value) {
throw Error('Cannot patch recursive schemas');
}
function Ref(schema, value) {
throw Error('Cannot patch referenced schemas');
}
function Self(schema, value) {
if (!ids.has(schema.$ref))
throw new Error(`Upcast: Cannot locate schema with $id '${schema.$id}' for referenced type`);
return Object(ids.get(schema.$ref), value);
}
function String(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Tuple(schema, value) {
if (check_1.CheckValue.Visit(schema, value))
return value;
if (!globalThis.Array.isArray(value))
return create_1.CreateValue.Create(schema);
if (schema.items === undefined)
return [];
return schema.items.map((schema, index) => Create(schema, value[index]));
}
function Undefined(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Union(schema, value) {
return UpcastUnionValue.Create(schema, value);
}
function Uint8Array(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Unknown(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Void(schema, value) {
return check_1.CheckValue.Visit(schema, value) ? value : create_1.CreateValue.Create(schema);
}
function Create(schema, value) {
const anySchema = schema;
switch (schema[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]}'`);
}
}
UpcastValue.Create = Create;
})(UpcastValue = exports.UpcastValue || (exports.UpcastValue = {}));