@sinclair/typebox
Version:
Json Schema Type Builder with Static Type Resolution for TypeScript
242 lines (240 loc) • 11.3 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ValueCastError = void 0;
exports.Cast = Cast;
const index_1 = require("../guard/index");
const index_2 = require("../../type/error/index");
const index_3 = require("../../type/symbols/index");
const index_4 = require("../create/index");
const index_5 = require("../check/index");
const index_6 = require("../clone/index");
const index_7 = require("../deref/index");
// ------------------------------------------------------------------
// Errors
// ------------------------------------------------------------------
class ValueCastError extends index_2.TypeBoxError {
constructor(schema, message) {
super(message);
this.schema = schema;
}
}
exports.ValueCastError = ValueCastError;
// ------------------------------------------------------------------
// The following logic assigns a score to a schema based on how well
// it matches a given value. For object types, the score is calculated
// by evaluating each property of the value against the schema's
// properties. To avoid bias towards objects with many properties,
// each property contributes equally to the total score. Properties
// that exactly match literal values receive the highest possible
// score, as literals are often used as discriminators in union types.
// ------------------------------------------------------------------
function ScoreUnion(schema, references, value) {
if (schema[index_3.Kind] === 'Object' && typeof value === 'object' && !(0, index_1.IsNull)(value)) {
const object = schema;
const keys = Object.getOwnPropertyNames(value);
const entries = Object.entries(object.properties);
return entries.reduce((acc, [key, schema]) => {
const literal = schema[index_3.Kind] === 'Literal' && schema.const === value[key] ? 100 : 0;
const checks = (0, index_5.Check)(schema, references, value[key]) ? 10 : 0;
const exists = keys.includes(key) ? 1 : 0;
return acc + (literal + checks + exists);
}, 0);
}
else if (schema[index_3.Kind] === 'Union') {
const schemas = schema.anyOf.map((schema) => (0, index_7.Deref)(schema, references));
const scores = schemas.map((schema) => ScoreUnion(schema, references, value));
return Math.max(...scores);
}
else {
return (0, index_5.Check)(schema, references, value) ? 1 : 0;
}
}
function SelectUnion(union, references, value) {
const schemas = union.anyOf.map((schema) => (0, index_7.Deref)(schema, references));
let [select, best] = [schemas[0], 0];
for (const schema of schemas) {
const score = ScoreUnion(schema, references, value);
if (score > best) {
select = schema;
best = score;
}
}
return select;
}
function CastUnion(union, references, value) {
if ('default' in union) {
return typeof value === 'function' ? union.default : (0, index_6.Clone)(union.default);
}
else {
const schema = SelectUnion(union, references, value);
return Cast(schema, references, value);
}
}
// ------------------------------------------------------------------
// Default
// ------------------------------------------------------------------
function DefaultClone(schema, references, value) {
return (0, index_5.Check)(schema, references, value) ? (0, index_6.Clone)(value) : (0, index_4.Create)(schema, references);
}
function Default(schema, references, value) {
return (0, index_5.Check)(schema, references, value) ? value : (0, index_4.Create)(schema, references);
}
// ------------------------------------------------------------------
// Cast
// ------------------------------------------------------------------
function FromArray(schema, references, value) {
if ((0, index_5.Check)(schema, references, value))
return (0, index_6.Clone)(value);
const created = (0, index_1.IsArray)(value) ? (0, index_6.Clone)(value) : (0, index_4.Create)(schema, references);
const minimum = (0, index_1.IsNumber)(schema.minItems) && created.length < schema.minItems ? [...created, ...Array.from({ length: schema.minItems - created.length }, () => null)] : created;
const maximum = (0, index_1.IsNumber)(schema.maxItems) && minimum.length > schema.maxItems ? minimum.slice(0, schema.maxItems) : minimum;
const casted = maximum.map((value) => Visit(schema.items, references, value));
if (schema.uniqueItems !== true)
return casted;
const unique = [...new Set(casted)];
if (!(0, index_5.Check)(schema, references, unique))
throw new ValueCastError(schema, 'Array cast produced invalid data due to uniqueItems constraint');
return unique;
}
function FromConstructor(schema, references, value) {
if ((0, index_5.Check)(schema, references, value))
return (0, index_4.Create)(schema, references);
const required = new Set(schema.returns.required || []);
const result = function () { };
for (const [key, property] of Object.entries(schema.returns.properties)) {
if (!required.has(key) && value.prototype[key] === undefined)
continue;
result.prototype[key] = Visit(property, references, value.prototype[key]);
}
return result;
}
function FromImport(schema, references, value) {
const definitions = globalThis.Object.values(schema.$defs);
const target = schema.$defs[schema.$ref];
return Visit(target, [...references, ...definitions], value);
}
// ------------------------------------------------------------------
// Intersect
// ------------------------------------------------------------------
function IntersectAssign(correct, value) {
// trust correct on mismatch | value on non-object
if (((0, index_1.IsObject)(correct) && !(0, index_1.IsObject)(value)) || (!(0, index_1.IsObject)(correct) && (0, index_1.IsObject)(value)))
return correct;
if (!(0, index_1.IsObject)(correct) || !(0, index_1.IsObject)(value))
return value;
return globalThis.Object.getOwnPropertyNames(correct).reduce((result, key) => {
const property = key in value ? IntersectAssign(correct[key], value[key]) : correct[key];
return { ...result, [key]: property };
}, {});
}
function FromIntersect(schema, references, value) {
if ((0, index_5.Check)(schema, references, value))
return value;
const correct = (0, index_4.Create)(schema, references);
const assigned = IntersectAssign(correct, value);
return (0, index_5.Check)(schema, references, assigned) ? assigned : correct;
}
function FromNever(schema, references, value) {
throw new ValueCastError(schema, 'Never types cannot be cast');
}
function FromObject(schema, references, value) {
if ((0, index_5.Check)(schema, references, value))
return value;
if (value === null || typeof value !== 'object')
return (0, index_4.Create)(schema, references);
const required = new Set(schema.required || []);
const result = {};
for (const [key, property] of Object.entries(schema.properties)) {
if (!required.has(key) && value[key] === undefined)
continue;
result[key] = Visit(property, references, value[key]);
}
// additional schema properties
if (typeof schema.additionalProperties === 'object') {
const propertyNames = Object.getOwnPropertyNames(schema.properties);
for (const propertyName of Object.getOwnPropertyNames(value)) {
if (propertyNames.includes(propertyName))
continue;
result[propertyName] = Visit(schema.additionalProperties, references, value[propertyName]);
}
}
return result;
}
function FromRecord(schema, references, value) {
if ((0, index_5.Check)(schema, references, value))
return (0, index_6.Clone)(value);
if (value === null || typeof value !== 'object' || Array.isArray(value) || value instanceof Date)
return (0, index_4.Create)(schema, references);
const subschemaPropertyName = Object.getOwnPropertyNames(schema.patternProperties)[0];
const subschema = schema.patternProperties[subschemaPropertyName];
const result = {};
for (const [propKey, propValue] of Object.entries(value)) {
result[propKey] = Visit(subschema, references, propValue);
}
return result;
}
function FromRef(schema, references, value) {
return Visit((0, index_7.Deref)(schema, references), references, value);
}
function FromThis(schema, references, value) {
return Visit((0, index_7.Deref)(schema, references), references, value);
}
function FromTuple(schema, references, value) {
if ((0, index_5.Check)(schema, references, value))
return (0, index_6.Clone)(value);
if (!(0, index_1.IsArray)(value))
return (0, index_4.Create)(schema, references);
if (schema.items === undefined)
return [];
return schema.items.map((schema, index) => Visit(schema, references, value[index]));
}
function FromUnion(schema, references, value) {
return (0, index_5.Check)(schema, references, value) ? (0, index_6.Clone)(value) : CastUnion(schema, references, value);
}
function Visit(schema, references, value) {
const references_ = (0, index_1.IsString)(schema.$id) ? (0, index_7.Pushref)(schema, references) : references;
const schema_ = schema;
switch (schema[index_3.Kind]) {
// --------------------------------------------------------------
// Structural
// --------------------------------------------------------------
case 'Array':
return FromArray(schema_, references_, value);
case 'Constructor':
return FromConstructor(schema_, references_, value);
case 'Import':
return FromImport(schema_, references_, value);
case 'Intersect':
return FromIntersect(schema_, references_, value);
case 'Never':
return FromNever(schema_, references_, value);
case 'Object':
return FromObject(schema_, references_, value);
case 'Record':
return FromRecord(schema_, references_, value);
case 'Ref':
return FromRef(schema_, references_, value);
case 'This':
return FromThis(schema_, references_, value);
case 'Tuple':
return FromTuple(schema_, references_, value);
case 'Union':
return FromUnion(schema_, references_, value);
// --------------------------------------------------------------
// DefaultClone
// --------------------------------------------------------------
case 'Date':
case 'Symbol':
case 'Uint8Array':
return DefaultClone(schema, references, value);
// --------------------------------------------------------------
// Default
// --------------------------------------------------------------
default:
return Default(schema_, references_, value);
}
}
/** Casts a value into a given type. The return value will retain as much information of the original value as possible. */
function Cast(...args) {
return args.length === 3 ? Visit(args[0], args[1], args[2]) : Visit(args[0], [], args[1]);
}