@sinclair/typebox
Version:
JSONSchema Type Builder with Static Type Resolution for TypeScript
329 lines (321 loc) • 14.9 kB
JavaScript
"use strict";
/*--------------------------------------------------------------------------
@sinclair/typebox
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.Type = exports.TypeBuilder = exports.Modifier = exports.Kind = void 0;
// --------------------------------------------------------------------------
// Symbols
// --------------------------------------------------------------------------
exports.Kind = Symbol.for('TypeBox.Kind');
exports.Modifier = Symbol.for('TypeBox.Modifier');
// --------------------------------------------------------------------------
// TypeBuilder
// --------------------------------------------------------------------------
let TypeOrdinal = 0;
class TypeBuilder {
// ----------------------------------------------------------------------
// Modifiers
// ----------------------------------------------------------------------
/** Creates a readonly optional property */
ReadonlyOptional(item) {
return { [exports.Modifier]: 'ReadonlyOptional', ...item };
}
/** Creates a readonly property */
Readonly(item) {
return { [exports.Modifier]: 'Readonly', ...item };
}
/** Creates a optional property */
Optional(item) {
return { [exports.Modifier]: 'Optional', ...item };
}
// ----------------------------------------------------------------------
// Types
// ----------------------------------------------------------------------
/** Creates a any type */
Any(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Any' });
}
/** Creates a array type */
Array(items, options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Array', type: 'array', items });
}
/** Creates a boolean type */
Boolean(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Boolean', type: 'boolean' });
}
/** Creates a constructor type */
Constructor(parameters, returns, options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Constructor', type: 'constructor', parameters, returns });
}
/** Creates a enum type */
Enum(item, options = {}) {
const values = Object.keys(item)
.filter((key) => isNaN(key))
.map((key) => item[key]);
const anyOf = values.map((value) => (typeof value === 'string' ? { [exports.Kind]: 'Literal', type: 'string', const: value } : { [exports.Kind]: 'Literal', type: 'number', const: value }));
return this.Create({ ...options, [exports.Kind]: 'Union', anyOf });
}
/** Creates a function type */
Function(parameters, returns, options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Function', type: 'function', parameters, returns });
}
/** Creates a integer type */
Integer(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Integer', type: 'integer' });
}
/** Creates a intersect type. */
Intersect(objects, options = {}) {
const isOptional = (schema) => (schema[exports.Modifier] && schema[exports.Modifier] === 'Optional') || schema[exports.Modifier] === 'ReadonlyOptional';
const [required, optional] = [new Set(), new Set()];
for (const object of objects) {
for (const [key, schema] of Object.entries(object.properties)) {
if (isOptional(schema))
optional.add(key);
}
}
for (const object of objects) {
for (const key of Object.keys(object.properties)) {
if (!optional.has(key))
required.add(key);
}
}
const properties = {};
for (const object of objects) {
for (const [key, schema] of Object.entries(object.properties)) {
properties[key] = properties[key] === undefined ? schema : { [exports.Kind]: 'Union', anyOf: [properties[key], { ...schema }] };
}
}
if (required.size > 0) {
return this.Create({ ...options, [exports.Kind]: 'Object', type: 'object', properties, required: [...required] });
}
else {
return this.Create({ ...options, [exports.Kind]: 'Object', type: 'object', properties });
}
}
/** Creates a keyof type */
KeyOf(object, options = {}) {
const items = Object.keys(object.properties).map((key) => this.Create({ ...options, [exports.Kind]: 'Literal', type: 'string', const: key }));
return this.Create({ ...options, [exports.Kind]: 'Union', anyOf: items });
}
/** Creates a literal type. */
Literal(value, options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Literal', const: value, type: typeof value });
}
/** Creates a null type */
Null(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Null', type: 'null' });
}
/** Creates a number type */
Number(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Number', type: 'number' });
}
/** Creates an object type with the given properties */
Object(properties, options = {}) {
const property_names = Object.keys(properties);
const optional = property_names.filter((name) => {
const property = properties[name];
const modifier = property[exports.Modifier];
return modifier && (modifier === 'Optional' || modifier === 'ReadonlyOptional');
});
const required = property_names.filter((name) => !optional.includes(name));
if (required.length > 0) {
return this.Create({ ...options, [exports.Kind]: 'Object', type: 'object', properties, required });
}
else {
return this.Create({ ...options, [exports.Kind]: 'Object', type: 'object', properties });
}
}
/** Creates a new object whose properties are omitted from the given object */
Omit(schema, keys, options = {}) {
const next = { ...this.Clone(schema), ...options };
next.required = next.required ? next.required.filter((key) => !keys.includes(key)) : undefined;
for (const key of Object.keys(next.properties)) {
if (keys.includes(key))
delete next.properties[key];
}
return this.Create(next);
}
/** Creates an object type whose properties are all optional */
Partial(schema, options = {}) {
const next = { ...this.Clone(schema), ...options };
delete next.required;
for (const key of Object.keys(next.properties)) {
const property = next.properties[key];
const modifer = property[exports.Modifier];
switch (modifer) {
case 'ReadonlyOptional':
property[exports.Modifier] = 'ReadonlyOptional';
break;
case 'Readonly':
property[exports.Modifier] = 'ReadonlyOptional';
break;
case 'Optional':
property[exports.Modifier] = 'Optional';
break;
default:
property[exports.Modifier] = 'Optional';
break;
}
}
return this.Create(next);
}
/** Creates a new object whose properties are picked from the given object */
Pick(schema, keys, options = {}) {
const next = { ...this.Clone(schema), ...options };
next.required = next.required ? next.required.filter((key) => keys.includes(key)) : undefined;
for (const key of Object.keys(next.properties)) {
if (!keys.includes(key))
delete next.properties[key];
}
return this.Create(next);
}
/** Creates a promise type. This type cannot be represented in schema. */
Promise(item, options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Promise', type: 'promise', item });
}
/** Creates a record type */
Record(key, value, options = {}) {
// If string literal union return TObject with properties extracted from union.
if (key[exports.Kind] === 'Union') {
return this.Object(key.anyOf.reduce((acc, literal) => {
return { ...acc, [literal.const]: value };
}, {}), { ...options });
}
// otherwise return TRecord with patternProperties
const pattern = key[exports.Kind] === 'Number' ? '^(0|[1-9][0-9]*)$' : key[exports.Kind] === 'String' && key.pattern ? key.pattern : '^.*$';
return this.Create({
...options,
[exports.Kind]: 'Record',
type: 'object',
patternProperties: { [pattern]: value },
additionalProperties: false,
});
}
/** Creates a recursive object type */
Recursive(callback, options = {}) {
if (options.$id === undefined)
options.$id = `type-${TypeOrdinal++}`;
const self = callback({ [exports.Kind]: 'Self', $ref: `${options.$id}` });
self.$id = options.$id;
return this.Create({ ...options, ...self });
}
/** Creates a reference schema */
Ref(schema, options = {}) {
if (schema.$id === undefined)
throw Error('Cannot create reference schema as target schema as has no $id');
return this.Create({ ...options, [exports.Kind]: 'Ref', $ref: schema.$id });
}
/** Creates a string type from a regular expression */
RegEx(regex, options = {}) {
return this.Create({ ...options, [exports.Kind]: 'String', type: 'string', pattern: regex.source });
}
/** Creates an object type whose properties are all required */
Required(schema, options = {}) {
const next = { ...this.Clone(schema), ...options };
next.required = Object.keys(next.properties);
for (const key of Object.keys(next.properties)) {
const property = next.properties[key];
const modifier = property[exports.Modifier];
switch (modifier) {
case 'ReadonlyOptional':
property[exports.Modifier] = 'Readonly';
break;
case 'Readonly':
property[exports.Modifier] = 'Readonly';
break;
case 'Optional':
delete property[exports.Modifier];
break;
default:
delete property[exports.Modifier];
break;
}
}
return this.Create(next);
}
/** Removes Kind and Modifier symbol property keys from this schema */
Strict(schema) {
return JSON.parse(JSON.stringify(schema));
}
/** Creates a string type */
String(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'String', type: 'string' });
}
/** Creates a tuple type */
Tuple(items, options = {}) {
const additionalItems = false;
const minItems = items.length;
const maxItems = items.length;
const schema = (items.length > 0 ? { ...options, [exports.Kind]: 'Tuple', type: 'array', items, additionalItems, minItems, maxItems } : { ...options, [exports.Kind]: 'Tuple', type: 'array', minItems, maxItems });
return this.Create(schema);
}
/** Creates a undefined type */
Undefined(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Undefined', type: 'object', specialized: 'Undefined' });
}
/** Creates a union type */
Union(items, options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Union', anyOf: items });
}
/** Creates a Uint8Array type */
Uint8Array(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Uint8Array', type: 'object', specialized: 'Uint8Array' });
}
/** Creates an unknown type */
Unknown(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Unknown' });
}
/** Creates a user defined schema that infers as type T */
Unsafe(options = {}) {
return this.Create({ ...options, [exports.Kind]: options[exports.Kind] || 'Unsafe' });
}
/** Creates a void type */
Void(options = {}) {
return this.Create({ ...options, [exports.Kind]: 'Void', type: 'null' });
}
/** Use this function to return TSchema with static and params omitted */
Create(schema) {
return schema;
}
/** Clones the given value */
Clone(value) {
const isObject = (object) => typeof object === 'object' && object !== null && !Array.isArray(object);
const isArray = (object) => typeof object === 'object' && object !== null && Array.isArray(object);
if (isObject(value)) {
return Object.keys(value).reduce((acc, key) => ({
...acc,
[key]: this.Clone(value[key]),
}), Object.getOwnPropertySymbols(value).reduce((acc, key) => ({
...acc,
[key]: this.Clone(value[key]),
}), {}));
}
else if (isArray(value)) {
return value.map((item) => this.Clone(item));
}
else {
return value;
}
}
}
exports.TypeBuilder = TypeBuilder;
/** JSON Schema Type Builder with Static Type Resolution for TypeScript */
exports.Type = new TypeBuilder();