typebox 1.3.3 → 1.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/compile/validator.d.mts +1 -4
- package/build/guard/guard.d.mts +1 -1
- package/build/guard/guard.mjs +5 -2
- package/build/schema/engine/_functions.mjs +34 -15
- package/build/type/action/readonly_object.d.mts +5 -0
- package/build/type/action/readonly_object.mjs +8 -0
- package/build/typebox.d.mts +1 -1
- package/build/typebox.mjs +1 -1
- package/package.json +1 -1
- package/readme.md +29 -32
|
@@ -1,14 +1,11 @@
|
|
|
1
1
|
import { type TLocalizedValidationError } from '../error/index.mjs';
|
|
2
2
|
import { type StaticDecode, type StaticEncode, type TProperties, type TSchema } from '../type/index.mjs';
|
|
3
|
-
import { BuildResult, EvaluateResult } from '../schema/index.mjs';
|
|
4
3
|
export declare class Validator<Context extends TProperties = TProperties, Type extends TSchema = TSchema, Encode extends unknown = StaticEncode<Type, Context>, Decode extends unknown = StaticDecode<Type, Context>> {
|
|
5
4
|
private readonly hasCodec;
|
|
6
5
|
private readonly buildResult;
|
|
7
6
|
private readonly evaluateResult;
|
|
8
|
-
/** Constructs a Validator
|
|
7
|
+
/** Constructs a Validator. */
|
|
9
8
|
constructor(context: Context, type: Type);
|
|
10
|
-
/** Constructs a Validator with the given arguments. */
|
|
11
|
-
constructor(hasCodec: boolean, buildResult: BuildResult, evaluateResult: EvaluateResult);
|
|
12
9
|
/** Returns true if this Validator is using JIT acceleration. */
|
|
13
10
|
IsAccelerated(): boolean;
|
|
14
11
|
/** Returns the Context for this validator. */
|
package/build/guard/guard.d.mts
CHANGED
|
@@ -61,5 +61,5 @@ export declare function Keys(value: Record<PropertyKey, unknown>): string[];
|
|
|
61
61
|
export declare function Symbols(value: Record<PropertyKey, unknown>): symbol[];
|
|
62
62
|
/** Returns the property values for the given object via `Object.values()` */
|
|
63
63
|
export declare function Values(value: Record<PropertyKey, unknown>): unknown[];
|
|
64
|
-
/**
|
|
64
|
+
/** Returns true if left and right values are structurally equal */
|
|
65
65
|
export declare function IsDeepEqual(left: unknown, right: unknown): boolean;
|
package/build/guard/guard.mjs
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
// deno-fmt-ignore-file
|
|
1
2
|
import * as String from './string.mjs';
|
|
2
3
|
// --------------------------------------------------------------------------
|
|
3
4
|
// Guards
|
|
@@ -203,7 +204,9 @@ function DeepEqualArray(left, right) {
|
|
|
203
204
|
return IsArray(right) && IsEqual(left.length, right.length) &&
|
|
204
205
|
left.every((_, index) => IsDeepEqual(left[index], right[index]));
|
|
205
206
|
}
|
|
206
|
-
/**
|
|
207
|
+
/** Returns true if left and right values are structurally equal */
|
|
207
208
|
export function IsDeepEqual(left, right) {
|
|
208
|
-
return (IsArray(left) ? DeepEqualArray(left, right) :
|
|
209
|
+
return (IsArray(left) ? DeepEqualArray(left, right) :
|
|
210
|
+
IsObject(left) ? DeepEqualObject(left, right) :
|
|
211
|
+
IsEqual(left, right));
|
|
209
212
|
}
|
|
@@ -1,47 +1,66 @@
|
|
|
1
1
|
// deno-fmt-ignore-file
|
|
2
|
-
import * as Schema from '../types/index.mjs';
|
|
3
2
|
import { Hashing } from '../../system/hashing/index.mjs';
|
|
4
3
|
import { EmitGuard as E } from '../../guard/index.mjs';
|
|
5
4
|
import { BuildSchema } from './schema.mjs';
|
|
6
|
-
const
|
|
5
|
+
const index = [0];
|
|
6
|
+
const names = new Map;
|
|
7
|
+
const funcs = new Map();
|
|
8
|
+
// ------------------------------------------------------------------
|
|
9
|
+
// CreateName
|
|
10
|
+
// ------------------------------------------------------------------
|
|
11
|
+
function NextName() {
|
|
12
|
+
return Hashing.Hash(index[0]++);
|
|
13
|
+
}
|
|
14
|
+
function CreateName(schema, href) {
|
|
15
|
+
if (!names.has(schema))
|
|
16
|
+
names.set(schema, new Map());
|
|
17
|
+
const hrefs = names.get(schema);
|
|
18
|
+
if (hrefs.has(href))
|
|
19
|
+
return hrefs.get(href);
|
|
20
|
+
const name = NextName();
|
|
21
|
+
hrefs.set(href, name);
|
|
22
|
+
return name;
|
|
23
|
+
}
|
|
7
24
|
// ------------------------------------------------------------------
|
|
8
25
|
// CreateCallExpression
|
|
9
26
|
// ------------------------------------------------------------------
|
|
10
|
-
function CreateCallExpression(context, _schema,
|
|
27
|
+
function CreateCallExpression(context, _schema, name, value) {
|
|
11
28
|
return context.UseUnevaluated()
|
|
12
|
-
? E.Call(`check_${
|
|
13
|
-
: E.Call(`check_${
|
|
29
|
+
? E.Call(`check_${name}`, ['context', value])
|
|
30
|
+
: E.Call(`check_${name}`, [value]);
|
|
14
31
|
}
|
|
15
32
|
// ------------------------------------------------------------------
|
|
16
33
|
// CreateFunctionExpression
|
|
17
34
|
// ------------------------------------------------------------------
|
|
18
|
-
function CreateFunctionExpression(stack, context, schema,
|
|
35
|
+
function CreateFunctionExpression(stack, context, schema, name) {
|
|
19
36
|
const expression = BuildSchema(stack, context, schema, 'value');
|
|
20
37
|
return context.UseUnevaluated()
|
|
21
|
-
? E.ConstDeclaration(`check_${
|
|
22
|
-
: E.ConstDeclaration(`check_${
|
|
38
|
+
? E.ConstDeclaration(`check_${name}`, E.ArrowFunction(['context', 'value'], expression))
|
|
39
|
+
: E.ConstDeclaration(`check_${name}`, E.ArrowFunction(['value'], expression));
|
|
23
40
|
}
|
|
24
41
|
// ------------------------------------------------------------------
|
|
25
42
|
// ResetFunctions
|
|
26
43
|
// ------------------------------------------------------------------
|
|
27
44
|
export function ResetFunctions() {
|
|
28
|
-
|
|
45
|
+
index[0] = 0;
|
|
46
|
+
names.clear();
|
|
47
|
+
funcs.clear();
|
|
29
48
|
}
|
|
30
49
|
// ------------------------------------------------------------------
|
|
31
50
|
// GetFunctions
|
|
32
51
|
// ------------------------------------------------------------------
|
|
33
52
|
export function GetFunctions() {
|
|
34
|
-
return [...
|
|
53
|
+
return [...funcs.values()];
|
|
35
54
|
}
|
|
36
55
|
// ------------------------------------------------------------------
|
|
37
56
|
// CreateFunction
|
|
38
57
|
// ------------------------------------------------------------------
|
|
39
58
|
export function CreateFunction(stack, context, schema, value) {
|
|
40
|
-
const
|
|
41
|
-
const call = CreateCallExpression(context, schema,
|
|
42
|
-
if (
|
|
59
|
+
const name = CreateName(schema, stack.BaseURL().href);
|
|
60
|
+
const call = CreateCallExpression(context, schema, name, value);
|
|
61
|
+
if (funcs.has(name))
|
|
43
62
|
return call;
|
|
44
|
-
|
|
45
|
-
|
|
63
|
+
funcs.set(name, '');
|
|
64
|
+
funcs.set(name, CreateFunctionExpression(stack, context, schema, name));
|
|
46
65
|
return call;
|
|
47
66
|
}
|
|
@@ -9,3 +9,8 @@ export declare function ReadonlyObjectDeferred<Type extends TSchema>(type: Type,
|
|
|
9
9
|
export type TReadonlyObject<Type extends TSchema> = (TReadonlyObjectAction<Type>);
|
|
10
10
|
/** This type is an alias for TypeScript's `Readonly<T>` utility type. It will make all properties of a TObject readonly or marks an TArray or TTuple as immutable `readonly T[]`. */
|
|
11
11
|
export declare function ReadonlyObject<Type extends TSchema>(type: Type, options?: TSchemaOptions): TReadonlyObject<Type>;
|
|
12
|
+
/**
|
|
13
|
+
* This type has been renamed to ReadonlyObject.
|
|
14
|
+
* @deprecated
|
|
15
|
+
*/
|
|
16
|
+
export declare const ReadonlyType: typeof ReadonlyObject;
|
|
@@ -9,3 +9,11 @@ export function ReadonlyObjectDeferred(type, options = {}) {
|
|
|
9
9
|
export function ReadonlyObject(type, options = {}) {
|
|
10
10
|
return ReadonlyObjectAction(type, options);
|
|
11
11
|
}
|
|
12
|
+
// ------------------------------------------------------------------
|
|
13
|
+
// Alias
|
|
14
|
+
// ------------------------------------------------------------------
|
|
15
|
+
/**
|
|
16
|
+
* This type has been renamed to ReadonlyObject.
|
|
17
|
+
* @deprecated
|
|
18
|
+
*/
|
|
19
|
+
export const ReadonlyType = ReadonlyObject;
|
package/build/typebox.d.mts
CHANGED
|
@@ -19,7 +19,7 @@ export { Omit, type TOmit, type TOmitDeferred } from './type/action/omit.mjs';
|
|
|
19
19
|
export { Parameters, type TParameters, type TParametersDeferred } from './type/action/parameters.mjs';
|
|
20
20
|
export { Partial, type TPartial, type TPartialDeferred } from './type/action/partial.mjs';
|
|
21
21
|
export { Pick, type TPick, type TPickDeferred } from './type/action/pick.mjs';
|
|
22
|
-
export { ReadonlyObject, type TReadonlyObject, type TReadonlyObjectDeferred } from './type/action/readonly_object.mjs';
|
|
22
|
+
export { ReadonlyObject, ReadonlyType, type TReadonlyObject, type TReadonlyObjectDeferred } from './type/action/readonly_object.mjs';
|
|
23
23
|
export { Required, type TRequired, type TRequiredDeferred } from './type/action/required.mjs';
|
|
24
24
|
export { ReturnType, type TReturnType, type TReturnTypeDeferred } from './type/action/return_type.mjs';
|
|
25
25
|
export { type TUncapitalize, type TUncapitalizeDeferred, Uncapitalize } from './type/action/uncapitalize.mjs';
|
package/build/typebox.mjs
CHANGED
|
@@ -31,7 +31,7 @@ export { Omit } from './type/action/omit.mjs';
|
|
|
31
31
|
export { Parameters } from './type/action/parameters.mjs';
|
|
32
32
|
export { Partial } from './type/action/partial.mjs';
|
|
33
33
|
export { Pick } from './type/action/pick.mjs';
|
|
34
|
-
export { ReadonlyObject } from './type/action/readonly_object.mjs';
|
|
34
|
+
export { ReadonlyObject, ReadonlyType } from './type/action/readonly_object.mjs';
|
|
35
35
|
export { Required } from './type/action/required.mjs';
|
|
36
36
|
export { ReturnType } from './type/action/return_type.mjs';
|
|
37
37
|
export { Uncapitalize } from './type/action/uncapitalize.mjs';
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -111,27 +111,24 @@ type User = Type.Static<typeof User> // type User = {
|
|
|
111
111
|
|
|
112
112
|
## Script
|
|
113
113
|
|
|
114
|
-
[Documentation](https://sinclairzx81.github.io/typebox/#/docs/script/overview) | [Example 1](https://www.typescriptlang.org/play/?target=99&module=7#code/
|
|
115
|
-
|
|
116
|
-
TypeBox includes a syntax engine that can transform TypeScript declarations into JSON Schema. The engine is a full syntactic frontend to Type.* and supports many advanced type-level constructs such as Conditional, Mapped, Indexed, Infer, Generics, Distributed types and more. This feature is implemented symmetrically at runtime and statically via TypeScript Template Literal types.
|
|
117
|
-
|
|
118
|
-
Syntax highlighting is available via the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sinclairzx81.typebox-script)
|
|
114
|
+
[Documentation](https://sinclairzx81.github.io/typebox/#/docs/script/overview) | [Example 1](https://www.typescriptlang.org/play/?target=99&module=7#code/JYWwDg9gTgLgBAFQJ5gKZwGZQiOByGFVAIwgA88AoSgehrgFkIATAVwBtVKBjCAOwDO8BgEMYACzgBeREQB0AZW5RgYGAAoABpThxCaOADVU3GNABM0uAG84ZAFxw+rEMVRQANHCSPnr93AAvjp6REYmZlAAzFa2Dk4ubp7evonuXgBeqf5QQSH66Mam0AAssXbZSV4+CTmZlelwAO4NucGaAJTUdHAAIqhofMyofMIsHFy8gvC2DKgCkoFWyGiKyqoaohJemrr5YcawqGSxIbqQAsAwwPyORZElHmdO0CAi7HcR0FFPurqsADdPsUoOYQsFdAU4ABxVA4VAwKBIU5-OAA9zXbjzT5HMgAbQAur8-sAhsAsQJWoTwfsDFt3MB3ii-iJXMARjBgQ9ibpmMAMBhWAJUFzSjy4AI0NwOCIoKKoCUaZCwnMFszdABzOEgBFIxyw+GIpDit4wBnvRz0lTvGmdbr0ABKrFGoHQDtQGE4phufEoqvEcjA2DQsHZAjkWsNSMDwYxYbk6NDFLkV1QIHDQYgIeu80DEEu134MazcdzZD98wDmez8cjOqNxZrucTmNzqfTjdL4b4r3endDZYrC37OfDdd1SBH8Zb5LbZo71a7ckBU8H-tX4dN5vYG7kfIFQtQu-L68XA83Ym3u9ZxHZo2PQ6rsfPci31p3Z9HcklJhlUAftD0AoMBiOScAAJJ8Bg7gjFilCCnw3r8HAUAjMMUDqDqCyOCsR7AaB3AADwFBAGCMJWAB8HQ2CEWEBuODYzhSeIAAwEnmBY+nI5a6HREbahOCZxsxbFyD2UBvDuPFwHxDHRkx8ysexK7SXxb6Mju+6CsK3G0ZWr6Xu+cg3neMC6bx+nqX2P7Suwsq6YEQA) | [Example 2](https://www.typescriptlang.org/play/?target=99&module=7#code/JYWwDg9gTgLgBAFQJ5gKZwGZQiOByGFVAIwgA88AoSgehrgFkIATAVwBtVKA7AQxFQBnMLwDG6BrxgALOAG9KcOKjKRYcURG6D4ANVSiY0AExwAvIiIA6APLEAVgZgAKOXDIAuS2isA5ViDEqFDOAJQANHBIXsg+-oHBYXAAvqGKyqrQ8Jraek7QAMzm3qi2Dk6u7jHW8UEhEVHVcQF1YZEAXk2ltYmhKWlKKmrZWjpw+obQACzFsaV2joaVniV+Lb2R0as99R1dawm7cADu+ztJqZTJ1HRwACKoaNzMqNzwTGyclDlj+rAqs2sCwqCiUkEEwBgwC0XkkMisEyMUCm4XS3GgIF47FhUmkCPyUAKqKUrAAbjj4YiTFc0j94ABxVA4VAwKBIQE+YFLUFwUnBKHiQT7ACCUCgvCQzj+MBUEXSwGewEFIrFEuccwOrVCaUudMYUmCwCxHPm5W56X4xGArxgFLxVORxLgzGAGAwrEEqDt+MmjvSwgMHF4UG9DqmNO+o3eQlkFg1XJcPIA5kyBKytozmemnZiZVAjdj9XmCxHaPQAEqsN6gdDl1AYTiGaHcSgMGNWMDYNCwa2CKwprNsjtd-m9qx8nuCqyQ1AgPudiDdqFCDsQCFQrTDxejldkVvthdLscDtNDw87vsTgUrmdzrdHlfoqCY9j3i9WPdtwR4889lcnlkzxHP9L1HKdb3nYDlz7Mk3xAj992-ODoKsXNDSxZCxxdN0PVKX8UM-A8oLHND8ww-Cx0ta03kw3dEJ-YiV1IgtaL7ANRCDKBWIQss4AAZRgKQlTgABJbgMGCV5xEod1uCbLQ4CgV4XhCARv32AShNEAAeQg0AgDBGBjAA+PoeTUvEAPTccwKEABtAAGABdVd12bBClAs-tU0ApAbMneznKsJ8Xw8uAvKsocryVQKXNgvdPPbZiMOw91PTCrzktfKibQypKDTI192M4hDkiAA) | [Challenge](test/typescript/readme.md)
|
|
119
115
|
|
|
116
|
+
TypeBox includes a runtime scripting engine that can transform TypeScript definitions into JSON Schema. The engine is implemented symmetrically at runtime and inside TypeScript's type system. It supports many programmable type-level constructs such as Conditional, Mapped, Indexed, Generic, Distributive Conditional, and more. The engine is designed for TypeScript 7 but is supported in TypeScript 5 and above.
|
|
120
117
|
|
|
121
118
|
### Example
|
|
122
119
|
|
|
123
|
-
|
|
120
|
+
Syntax highlighting is available via the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sinclairzx81.typebox-script)
|
|
124
121
|
|
|
125
122
|
```typescript
|
|
126
123
|
// Module
|
|
127
124
|
const Math = Type.Script(`
|
|
128
125
|
type Vector2 = { x: number, y: number }
|
|
129
|
-
type Vector3 =
|
|
130
|
-
type Vector4 =
|
|
126
|
+
type Vector3 = { x: number, y: number, z: number }
|
|
127
|
+
type Vector4 = { x: number, y: number, z: number, w: number }
|
|
131
128
|
`)
|
|
132
129
|
|
|
133
130
|
// Dependent Module
|
|
134
|
-
const { Mesh } = Type.Script(
|
|
131
|
+
const { Mesh } = Type.Script(Math, `
|
|
135
132
|
type Vertex = {
|
|
136
133
|
position: Vector4,
|
|
137
134
|
normal: Vector3,
|
|
@@ -298,29 +295,29 @@ The following table shows compile performance for various JSON Schema structures
|
|
|
298
295
|
┌──────────────────────┬─────────────┬─────────────┐
|
|
299
296
|
│ Compile │ TB1X │ AJV8 │
|
|
300
297
|
├──────────────────────┼─────────────┼─────────────┤
|
|
301
|
-
│ Boolean │
|
|
302
|
-
│ Number │
|
|
303
|
-
│ String │
|
|
304
|
-
│ Null │
|
|
305
|
-
│ Literal_String │
|
|
306
|
-
│ Literal_Number │
|
|
307
|
-
│ Literal_Boolean │
|
|
308
|
-
│ Pattern │
|
|
309
|
-
│ Object_Open │
|
|
310
|
-
│ Object_Close │
|
|
311
|
-
│ Object_Vector3 │
|
|
312
|
-
│ Object_Basis3 │
|
|
313
|
-
│ Intersect_And │
|
|
314
|
-
│ Intersect_Structural │
|
|
315
|
-
│ Union_Or │
|
|
316
|
-
│ Union_Structural │
|
|
317
|
-
│ Tuple_Values │
|
|
318
|
-
│ Tuple_Objects │
|
|
319
|
-
│ Array_Numbers_4 │
|
|
320
|
-
│ Array_Numbers_8 │
|
|
321
|
-
│ Array_Numbers_16 │
|
|
322
|
-
│ Array_Objects_Open │
|
|
323
|
-
│ Array_Objects_Close │
|
|
298
|
+
│ Boolean │ 39.7K ops/s │ 6.8K ops/s │
|
|
299
|
+
│ Number │ 86.2K ops/s │ 7.5K ops/s │
|
|
300
|
+
│ String │ 82.6K ops/s │ 8.2K ops/s │
|
|
301
|
+
│ Null │ 62K ops/s │ 7.3K ops/s │
|
|
302
|
+
│ Literal_String │ 72.1K ops/s │ 5.7K ops/s │
|
|
303
|
+
│ Literal_Number │ 72.7K ops/s │ 6.9K ops/s │
|
|
304
|
+
│ Literal_Boolean │ 80.9K ops/s │ 7K ops/s │
|
|
305
|
+
│ Pattern │ 38.7K ops/s │ 5.7K ops/s │
|
|
306
|
+
│ Object_Open │ 16.3K ops/s │ 1.3K ops/s │
|
|
307
|
+
│ Object_Close │ 15.7K ops/s │ 952 ops/s │
|
|
308
|
+
│ Object_Vector3 │ 40.2K ops/s │ 3.2K ops/s │
|
|
309
|
+
│ Object_Basis3 │ 16.1K ops/s │ 834 ops/s │
|
|
310
|
+
│ Intersect_And │ 45.7K ops/s │ 3.5K ops/s │
|
|
311
|
+
│ Intersect_Structural │ 21K ops/s │ 1.6K ops/s │
|
|
312
|
+
│ Union_Or │ 45.1K ops/s │ 3.4K ops/s │
|
|
313
|
+
│ Union_Structural │ 27.6K ops/s │ 2K ops/s │
|
|
314
|
+
│ Tuple_Values │ 14.7K ops/s │ 2K ops/s │
|
|
315
|
+
│ Tuple_Objects │ 3.7K ops/s │ 380 ops/s │
|
|
316
|
+
│ Array_Numbers_4 │ 73.6K ops/s │ 4.3K ops/s │
|
|
317
|
+
│ Array_Numbers_8 │ 50.9K ops/s │ 3.8K ops/s │
|
|
318
|
+
│ Array_Numbers_16 │ 85K ops/s │ 3.9K ops/s │
|
|
319
|
+
│ Array_Objects_Open │ 18.9K ops/s │ 789 ops/s │
|
|
320
|
+
│ Array_Objects_Close │ 17.9K ops/s │ 909 ops/s │
|
|
324
321
|
└──────────────────────┴─────────────┴─────────────┘
|
|
325
322
|
```
|
|
326
323
|
|