@sinclair/typebox 0.24.22 → 0.24.25

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.
@@ -1,4 +1,4 @@
1
- import { ValueError } from '../value/errors';
1
+ import { ValueError } from '../errors/index';
2
2
  import * as Types from '../typebox';
3
3
  export declare type CheckFunction = (value: unknown) => boolean;
4
4
  export declare class TypeCheck<T extends Types.TSchema> {
@@ -14,6 +14,13 @@ export declare class TypeCheck<T extends Types.TSchema> {
14
14
  /** Returns true if the value matches the given type. */
15
15
  Check(value: unknown): value is Types.Static<T>;
16
16
  }
17
+ export declare namespace Property {
18
+ function Check(propertyName: string): boolean;
19
+ }
20
+ export declare class TypeCompilerInvalidTypeError extends Error {
21
+ readonly schema: Types.TSchema;
22
+ constructor(schema: Types.TSchema);
23
+ }
17
24
  /** Compiles Types for Runtime Type Checking */
18
25
  export declare namespace TypeCompiler {
19
26
  /** Compiles the given type for runtime type checking. This compiler only accepts known TypeBox types non-inclusive of unsafe types. */
@@ -27,10 +27,9 @@ THE SOFTWARE.
27
27
 
28
28
  ---------------------------------------------------------------------------*/
29
29
  Object.defineProperty(exports, "__esModule", { value: true });
30
- exports.TypeCompiler = exports.TypeCheck = void 0;
31
- const errors_1 = require("../value/errors");
32
- const property_1 = require("./property");
33
- const Types = require("../typebox");
30
+ exports.TypeCompiler = exports.TypeCompilerInvalidTypeError = exports.Property = exports.TypeCheck = void 0;
31
+ const index_1 = require("../errors/index");
32
+ const index_2 = require("../guard/index");
34
33
  // -------------------------------------------------------------------
35
34
  // TypeCheck
36
35
  // -------------------------------------------------------------------
@@ -47,7 +46,7 @@ class TypeCheck {
47
46
  }
48
47
  /** Returns an iterator for each error in this value. */
49
48
  Errors(value) {
50
- return errors_1.ValueErrors.Errors(this.schema, this.references, value);
49
+ return index_1.ValueErrors.Errors(this.schema, this.references, value);
51
50
  }
52
51
  /** Returns true if the value matches the given type. */
53
52
  Check(value) {
@@ -56,8 +55,60 @@ class TypeCheck {
56
55
  }
57
56
  exports.TypeCheck = TypeCheck;
58
57
  // -------------------------------------------------------------------
58
+ // Property
59
+ // -------------------------------------------------------------------
60
+ var Property;
61
+ (function (Property) {
62
+ function DollarSign(code) {
63
+ return code === 36;
64
+ }
65
+ function Underscore(code) {
66
+ return code === 95;
67
+ }
68
+ function Numeric(code) {
69
+ return code >= 48 && code <= 57;
70
+ }
71
+ function Alpha(code) {
72
+ return (code >= 65 && code <= 90) || (code >= 97 && code <= 122);
73
+ }
74
+ function AssertEscapeCharacters(propertyName) {
75
+ for (let i = 0; i < propertyName.length; i++) {
76
+ const code = propertyName.charCodeAt(i);
77
+ if ((code >= 7 && code <= 13) || code === 27 || code === 127) {
78
+ throw Error('Property: Invalid escape character found in property key');
79
+ }
80
+ }
81
+ }
82
+ function Check(propertyName) {
83
+ AssertEscapeCharacters(propertyName);
84
+ if (propertyName.length === 0)
85
+ return false;
86
+ {
87
+ const code = propertyName.charCodeAt(0);
88
+ if (!(DollarSign(code) || Underscore(code) || Alpha(code))) {
89
+ return false;
90
+ }
91
+ }
92
+ for (let i = 1; i < propertyName.length; i++) {
93
+ const code = propertyName.charCodeAt(i);
94
+ if (!(DollarSign(code) || Underscore(code) || Alpha(code) || Numeric(code))) {
95
+ return false;
96
+ }
97
+ }
98
+ return true;
99
+ }
100
+ Property.Check = Check;
101
+ })(Property = exports.Property || (exports.Property = {}));
102
+ // -------------------------------------------------------------------
59
103
  // TypeCompiler
60
104
  // -------------------------------------------------------------------
105
+ class TypeCompilerInvalidTypeError extends Error {
106
+ constructor(schema) {
107
+ super('TypeCompiler: Invalid type');
108
+ this.schema = schema;
109
+ }
110
+ }
111
+ exports.TypeCompilerInvalidTypeError = TypeCompilerInvalidTypeError;
61
112
  /** Compiles Types for Runtime Type Checking */
62
113
  var TypeCompiler;
63
114
  (function (TypeCompiler) {
@@ -100,11 +151,14 @@ var TypeCompiler;
100
151
  yield `(${value} <= ${schema.maximum})`;
101
152
  }
102
153
  function* Literal(schema, value) {
103
- if (typeof schema.const === 'string') {
154
+ if (typeof schema.const === 'number' || typeof schema.const === 'boolean') {
155
+ yield `(${value} === ${schema.const})`;
156
+ }
157
+ else if (typeof schema.const === 'string') {
104
158
  yield `(${value} === '${schema.const}')`;
105
159
  }
106
160
  else {
107
- yield `(${value} === ${schema.const})`;
161
+ throw Error('TypeCompiler: Literal value should be string, number or boolean');
108
162
  }
109
163
  }
110
164
  function* Null(schema, value) {
@@ -144,7 +198,7 @@ var TypeCompiler;
144
198
  }
145
199
  }
146
200
  for (const propertyKey of propertyKeys) {
147
- const memberExpression = property_1.Property.Check(propertyKey) ? `${value}.${propertyKey}` : `${value}['${propertyKey}']`;
201
+ const memberExpression = Property.Check(propertyKey) ? `${value}.${propertyKey}` : `${value}['${propertyKey}']`;
148
202
  const propertySchema = schema.properties[propertyKey];
149
203
  if (schema.required && schema.required.includes(propertyKey)) {
150
204
  yield* Visit(propertySchema, memberExpression);
@@ -231,52 +285,71 @@ var TypeCompiler;
231
285
  yield `(${name}(${value}))`;
232
286
  return;
233
287
  }
234
- const anySchema = schema;
235
- switch (anySchema[Types.Kind]) {
236
- case 'Any':
237
- return yield* Any(anySchema, value);
238
- case 'Array':
239
- return yield* Array(anySchema, value);
240
- case 'Boolean':
241
- return yield* Boolean(anySchema, value);
242
- case 'Constructor':
243
- return yield* Constructor(anySchema, value);
244
- case 'Function':
245
- return yield* Function(anySchema, value);
246
- case 'Integer':
247
- return yield* Integer(anySchema, value);
248
- case 'Literal':
249
- return yield* Literal(anySchema, value);
250
- case 'Null':
251
- return yield* Null(anySchema, value);
252
- case 'Number':
253
- return yield* Number(anySchema, value);
254
- case 'Object':
255
- return yield* Object(anySchema, value);
256
- case 'Promise':
257
- return yield* Promise(anySchema, value);
258
- case 'Record':
259
- return yield* Record(anySchema, value);
260
- case 'Ref':
261
- return yield* Ref(anySchema, value);
262
- case 'Self':
263
- return yield* Self(anySchema, value);
264
- case 'String':
265
- return yield* String(anySchema, value);
266
- case 'Tuple':
267
- return yield* Tuple(anySchema, value);
268
- case 'Undefined':
269
- return yield* Undefined(anySchema, value);
270
- case 'Union':
271
- return yield* Union(anySchema, value);
272
- case 'Uint8Array':
273
- return yield* Uint8Array(anySchema, value);
274
- case 'Unknown':
275
- return yield* Unknown(anySchema, value);
276
- case 'Void':
277
- return yield* Void(anySchema, value);
278
- default:
279
- throw new Error(`TypeCompiler: Unknown schema kind '${schema[Types.Kind]}'`);
288
+ if (index_2.TypeGuard.TAny(schema)) {
289
+ return yield* Any(schema, value);
290
+ }
291
+ else if (index_2.TypeGuard.TArray(schema)) {
292
+ return yield* Array(schema, value);
293
+ }
294
+ else if (index_2.TypeGuard.TBoolean(schema)) {
295
+ return yield* Boolean(schema, value);
296
+ }
297
+ else if (index_2.TypeGuard.TConstructor(schema)) {
298
+ return yield* Constructor(schema, value);
299
+ }
300
+ else if (index_2.TypeGuard.TFunction(schema)) {
301
+ return yield* Function(schema, value);
302
+ }
303
+ else if (index_2.TypeGuard.TInteger(schema)) {
304
+ return yield* Integer(schema, value);
305
+ }
306
+ else if (index_2.TypeGuard.TLiteral(schema)) {
307
+ return yield* Literal(schema, value);
308
+ }
309
+ else if (index_2.TypeGuard.TNull(schema)) {
310
+ return yield* Null(schema, value);
311
+ }
312
+ else if (index_2.TypeGuard.TNumber(schema)) {
313
+ return yield* Number(schema, value);
314
+ }
315
+ else if (index_2.TypeGuard.TObject(schema)) {
316
+ return yield* Object(schema, value);
317
+ }
318
+ else if (index_2.TypeGuard.TPromise(schema)) {
319
+ return yield* Promise(schema, value);
320
+ }
321
+ else if (index_2.TypeGuard.TRecord(schema)) {
322
+ return yield* Record(schema, value);
323
+ }
324
+ else if (index_2.TypeGuard.TRef(schema)) {
325
+ return yield* Ref(schema, value);
326
+ }
327
+ else if (index_2.TypeGuard.TSelf(schema)) {
328
+ return yield* Self(schema, value);
329
+ }
330
+ else if (index_2.TypeGuard.TString(schema)) {
331
+ return yield* String(schema, value);
332
+ }
333
+ else if (index_2.TypeGuard.TTuple(schema)) {
334
+ return yield* Tuple(schema, value);
335
+ }
336
+ else if (index_2.TypeGuard.TUndefined(schema)) {
337
+ return yield* Undefined(schema, value);
338
+ }
339
+ else if (index_2.TypeGuard.TUnion(schema)) {
340
+ return yield* Union(schema, value);
341
+ }
342
+ else if (index_2.TypeGuard.TUint8Array(schema)) {
343
+ return yield* Uint8Array(schema, value);
344
+ }
345
+ else if (index_2.TypeGuard.TUnknown(schema)) {
346
+ return yield* Unknown(schema, value);
347
+ }
348
+ else if (index_2.TypeGuard.TVoid(schema)) {
349
+ return yield* Void(schema, value);
350
+ }
351
+ else {
352
+ throw new TypeCompilerInvalidTypeError(schema);
280
353
  }
281
354
  }
282
355
  // -------------------------------------------------------------------
@@ -1,2 +1,2 @@
1
- export type { ValueError } from '../value/errors';
1
+ export { ValueError, ValueErrorType } from '../errors/index';
2
2
  export * from './compiler';
package/compiler/index.js CHANGED
@@ -41,4 +41,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
41
41
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
42
42
  };
43
43
  Object.defineProperty(exports, "__esModule", { value: true });
44
+ exports.ValueErrorType = void 0;
45
+ var index_1 = require("../errors/index");
46
+ Object.defineProperty(exports, "ValueErrorType", { enumerable: true, get: function () { return index_1.ValueErrorType; } });
44
47
  __exportStar(require("./compiler"), exports);
@@ -0,0 +1,56 @@
1
+ import * as Types from '../typebox';
2
+ export declare enum ValueErrorType {
3
+ Array = 0,
4
+ ArrayMinItems = 1,
5
+ ArrayMaxItems = 2,
6
+ ArrayUniqueItems = 3,
7
+ Boolean = 4,
8
+ Function = 5,
9
+ Integer = 6,
10
+ IntegerMultipleOf = 7,
11
+ IntegerExclusiveMinimum = 8,
12
+ IntegerExclusiveMaximum = 9,
13
+ IntegerMinimum = 10,
14
+ IntegerMaximum = 11,
15
+ Literal = 12,
16
+ Null = 13,
17
+ Number = 14,
18
+ NumberMultipleOf = 15,
19
+ NumberExclusiveMinimum = 16,
20
+ NumberExclusiveMaximum = 17,
21
+ NumberMinumum = 18,
22
+ NumberMaximum = 19,
23
+ Object = 20,
24
+ ObjectMinProperties = 21,
25
+ ObjectMaxProperties = 22,
26
+ ObjectAdditionalProperties = 23,
27
+ Promise = 24,
28
+ RecordKeyNumeric = 25,
29
+ RecordKeyString = 26,
30
+ String = 27,
31
+ StringMinLength = 28,
32
+ StringMaxLength = 29,
33
+ StringPattern = 30,
34
+ TupleZeroLength = 31,
35
+ TupleLength = 32,
36
+ Undefined = 33,
37
+ Union = 34,
38
+ Uint8Array = 35,
39
+ Uint8ArrayMinByteLength = 36,
40
+ Uint8ArrayMaxByteLength = 37,
41
+ Void = 38
42
+ }
43
+ export interface ValueError {
44
+ type: ValueErrorType;
45
+ schema: Types.TSchema;
46
+ path: string;
47
+ value: unknown;
48
+ message: string;
49
+ }
50
+ export declare class ValueErrorsInvalidTypeError extends Error {
51
+ readonly schema: Types.TSchema;
52
+ constructor(schema: Types.TSchema);
53
+ }
54
+ export declare namespace ValueErrors {
55
+ function Errors<T extends Types.TSchema>(schema: T, references: Types.TSchema[], value: any): IterableIterator<ValueError>;
56
+ }