@forklaunch/validator 0.1.1 → 0.1.3
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/dist/index.d.ts +21 -21
- package/dist/interfaces/schemaProvider.interfaces.d.ts +23 -0
- package/dist/interfaces/schemaProvider.interfaces.js +3 -0
- package/dist/interfaces/schemaProvider.interfaces.js.map +1 -0
- package/dist/tests/typebox/equality.test.js +2 -0
- package/dist/tests/typebox/equality.test.js.map +1 -1
- package/dist/tests/typebox/largeSchema.test.js.map +1 -1
- package/dist/tests/zod/equality.test.js +2 -0
- package/dist/tests/zod/equality.test.js.map +1 -1
- package/dist/tests/zod/largeSchema.test.js.map +1 -1
- package/dist/typebox.d.ts +28 -25
- package/dist/typebox.js +29 -26
- package/dist/typebox.js.map +1 -1
- package/dist/types/schema.types.d.ts +21 -0
- package/dist/types/typebox.schema.types.d.ts +41 -0
- package/dist/types/zod.schema.types.d.ts +41 -0
- package/dist/zod.d.ts +25 -25
- package/dist/zod.js +26 -26
- package/dist/zod.js.map +1 -1
- package/package.json +1 -1
- package/dist/tests/equality.test.d.ts +0 -0
- package/dist/tests/equality.test.js +0 -2
- package/dist/tests/equality.test.js.map +0 -1
- package/dist/tests/largeSchema.test.d.ts +0 -0
- package/dist/tests/largeSchema.test.js +0 -2
- package/dist/tests/largeSchema.test.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -8,76 +8,76 @@ import { Prettify } from "@forklaunch/common";
|
|
|
8
8
|
import { IdiomaticSchema } from "./types/schema.types";
|
|
9
9
|
import { TOuterArray, TCatchall, TObject, TObjectShape, TResolve, TSchemaTranslate } from "./types/typebox.schema.types";
|
|
10
10
|
import { ZodOuterArray, ZodCatchall, ZodObject, ZodObjectShape, ZodResolve, ZodSchemaTranslate } from "./types/zod.schema.types";
|
|
11
|
-
import {
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
11
|
+
import { ZodSchemaProvider } from "./zod";
|
|
12
|
+
import { TypeboxSchemaProvider } from "./typebox";
|
|
13
|
+
import { AnySchemaProvider } from "./interfaces/schemaProvider.interfaces";
|
|
14
14
|
/**
|
|
15
15
|
* Type alias for a schema object shape.
|
|
16
16
|
* Resolves to ZodObjectShape for Zod schemas and TObjectShape for TypeBox schemas.
|
|
17
17
|
*
|
|
18
|
-
* @template SD -
|
|
18
|
+
* @template SD - SchemaProvider type.
|
|
19
19
|
*/
|
|
20
|
-
type SchemaObjectShape<SD extends
|
|
20
|
+
type SchemaObjectShape<SD extends AnySchemaProvider> = (SD extends ZodSchemaProvider ? ZodObjectShape : SD extends TypeboxSchemaProvider ? TObjectShape : never);
|
|
21
21
|
/**
|
|
22
22
|
* Type alias for a schema object.
|
|
23
23
|
* Resolves to ZodObject for Zod schemas and TObject for TypeBox schemas.
|
|
24
24
|
*
|
|
25
25
|
* @template T - Schema object shape.
|
|
26
|
-
* @template SD -
|
|
26
|
+
* @template SD - SchemaProvider type.
|
|
27
27
|
*/
|
|
28
|
-
type SchemaObject<T extends SchemaObjectShape<SD>, SD extends
|
|
28
|
+
type SchemaObject<T extends SchemaObjectShape<SD>, SD extends AnySchemaProvider> = (SD extends ZodSchemaProvider ? ZodObject<T> : SD extends TypeboxSchemaProvider ? TObject<T> : never);
|
|
29
29
|
/**
|
|
30
30
|
* Type alias for a schema outer array.
|
|
31
31
|
* Resolves to ZodOuterArray for Zod schemas and TOuterArray for TypeBox schemas.
|
|
32
32
|
*
|
|
33
33
|
* @template T - Schema object.
|
|
34
|
-
* @template SD -
|
|
34
|
+
* @template SD - SchemaProvider type.
|
|
35
35
|
*/
|
|
36
|
-
type SchemaOuterArray<T extends SchemaObject<SchemaObjectShape<SD>, SD>, SD extends
|
|
36
|
+
type SchemaOuterArray<T extends SchemaObject<SchemaObjectShape<SD>, SD>, SD extends AnySchemaProvider> = (SD extends ZodSchemaProvider ? ZodOuterArray<T> : SD extends TypeboxSchemaProvider ? TOuterArray<T> : never);
|
|
37
37
|
/**
|
|
38
38
|
* Type alias for resolving a schema.
|
|
39
39
|
* Resolves to ZodResolve for Zod schemas and TResolve for TypeBox schemas.
|
|
40
40
|
*
|
|
41
41
|
* @template T - Schema type.
|
|
42
|
-
* @template SD -
|
|
42
|
+
* @template SD - SchemaProvider type.
|
|
43
43
|
*/
|
|
44
|
-
type SchemaResolve<T, SD extends
|
|
44
|
+
type SchemaResolve<T, SD extends AnySchemaProvider> = (SD extends ZodSchemaProvider ? ZodResolve<T> : SD extends TypeboxSchemaProvider ? TResolve<T> : never);
|
|
45
45
|
/**
|
|
46
46
|
* Type alias for translating a schema.
|
|
47
47
|
* Resolves to ZodSchemaTranslate for Zod schemas and TSchemaTranslate for TypeBox schemas.
|
|
48
48
|
*
|
|
49
49
|
* @template T - Schema type.
|
|
50
|
-
* @template SD -
|
|
50
|
+
* @template SD - SchemaProvider type.
|
|
51
51
|
*/
|
|
52
|
-
type SchemaTranslate<T, SD extends
|
|
52
|
+
type SchemaTranslate<T, SD extends AnySchemaProvider> = (SD extends ZodSchemaProvider ? ZodSchemaTranslate<T> : SD extends TypeboxSchemaProvider ? TSchemaTranslate<T> : never);
|
|
53
53
|
/**
|
|
54
54
|
* Type alias for prettifying a schema translation.
|
|
55
55
|
* Uses the Prettify utility from @forklaunch/common.
|
|
56
56
|
*
|
|
57
57
|
* @template T - Schema type.
|
|
58
|
-
* @template SD -
|
|
58
|
+
* @template SD - SchemaProvider type.
|
|
59
59
|
*/
|
|
60
|
-
type SchemaPrettify<T, SD extends
|
|
60
|
+
type SchemaPrettify<T, SD extends AnySchemaProvider> = Prettify<SchemaTranslate<T, SD>>;
|
|
61
61
|
/**
|
|
62
62
|
* Type alias for a schema catchall type.
|
|
63
63
|
* Resolves to ZodCatchall for Zod schemas and TCatchall for TypeBox schemas.
|
|
64
64
|
*
|
|
65
|
-
* @template SD -
|
|
65
|
+
* @template SD - SchemaProvider type.
|
|
66
66
|
*/
|
|
67
|
-
export type SchemaCatchall<SD extends
|
|
67
|
+
export type SchemaCatchall<SD extends AnySchemaProvider> = (SD extends ZodSchemaProvider ? ZodCatchall : SD extends TypeboxSchemaProvider ? TCatchall : never);
|
|
68
68
|
/**
|
|
69
69
|
* Type alias for a valid schema object.
|
|
70
70
|
* Can be a schema object or a schema outer array.
|
|
71
71
|
*
|
|
72
|
-
* @template SD -
|
|
72
|
+
* @template SD - SchemaProvider type.
|
|
73
73
|
*/
|
|
74
|
-
export type ValidSchemaObject<SD extends
|
|
74
|
+
export type ValidSchemaObject<SD extends AnySchemaProvider> = SchemaObject<SchemaObjectShape<SD>, SD> | SchemaOuterArray<SchemaObject<SchemaObjectShape<SD>, SD>, SD>;
|
|
75
75
|
/**
|
|
76
76
|
* Type alias for a schema.
|
|
77
77
|
* Applies prettification to the resolved schema.
|
|
78
78
|
*
|
|
79
79
|
* @template T - Valid schema object or idiomatic schema.
|
|
80
|
-
* @template SD -
|
|
80
|
+
* @template SD - SchemaProvider type.
|
|
81
81
|
*/
|
|
82
|
-
export type Schema<T extends ValidSchemaObject<SD> | IdiomaticSchema<SchemaCatchall<SD>>, SD extends
|
|
82
|
+
export type Schema<T extends ValidSchemaObject<SD> | IdiomaticSchema<SchemaCatchall<SD>>, SD extends AnySchemaProvider> = SchemaPrettify<SchemaResolve<T, SD>, SD>;
|
|
83
83
|
export {};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { LiteralSchema } from "../types/schema.types";
|
|
2
|
+
import { SchemaObject } from 'openapi3-ts/oas31';
|
|
3
|
+
export interface AnySchemaProvider extends SchemaProvider<any, any, any> {
|
|
4
|
+
}
|
|
5
|
+
export interface SchemaProvider<UnionContainer, IdiomaticSchema, Catchall> {
|
|
6
|
+
string: unknown;
|
|
7
|
+
number: unknown;
|
|
8
|
+
bigint: unknown;
|
|
9
|
+
boolean: unknown;
|
|
10
|
+
date: unknown;
|
|
11
|
+
symbol: unknown;
|
|
12
|
+
empty: unknown;
|
|
13
|
+
any: unknown;
|
|
14
|
+
unknown: unknown;
|
|
15
|
+
never: unknown;
|
|
16
|
+
schemify<T extends IdiomaticSchema>(schema: T): unknown;
|
|
17
|
+
optional<T extends IdiomaticSchema>(schema: T): unknown;
|
|
18
|
+
array<T extends IdiomaticSchema>(schema: T): unknown;
|
|
19
|
+
union<T extends UnionContainer>(schemas: T): unknown;
|
|
20
|
+
literal<T extends LiteralSchema>(value: T): unknown;
|
|
21
|
+
validate<T extends Catchall>(schema: T, value: unknown): boolean;
|
|
22
|
+
openapi<T extends IdiomaticSchema>(schema: T): SchemaObject;
|
|
23
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schemaProvider.interfaces.js","sourceRoot":"","sources":["../../interfaces/schemaProvider.interfaces.ts"],"names":[],"mappings":""}
|
|
@@ -73,6 +73,7 @@ exports.assert = assert;
|
|
|
73
73
|
assert();
|
|
74
74
|
assert();
|
|
75
75
|
assert();
|
|
76
|
+
assert();
|
|
76
77
|
const shortOne = {
|
|
77
78
|
s: typebox_1.string,
|
|
78
79
|
non: typebox_1.number
|
|
@@ -82,4 +83,5 @@ const shortTwo = (0, typebox_1.schemify)({
|
|
|
82
83
|
non: typebox_1.number
|
|
83
84
|
});
|
|
84
85
|
assert();
|
|
86
|
+
assert();
|
|
85
87
|
//# sourceMappingURL=equality.test.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"equality.test.js","sourceRoot":"","sources":["../../../tests/typebox/equality.test.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"equality.test.js","sourceRoot":"","sources":["../../../tests/typebox/equality.test.ts"],"names":[],"mappings":";;;AACA,2CAAoJ;AAEpJ,MAAM,GAAG,GAAG,IAAA,eAAK,EAAC;IACd,IAAI,EAAE;QACF,CAAC,EAAE,IAAA,eAAK,EAAC,CAAC,gBAAM,EAAE,gBAAM,EAAE,cAAI,EAAE,iBAAO,EAAE,gBAAM,EAAE,eAAK,EAAE,gBAAM,EAAE,eAAK,CAAC,CAAC;QACvE,CAAC,EAAE,IAAA,kBAAQ,EAAC,IAAA,eAAK,EAAC,CAAC,IAAA,eAAK,EAAC;gBACrB,CAAC,EAAE,IAAA,eAAK,EAAC,gBAAM,CAAC;aACnB,CAAC,EAAE,gBAAM,CAAC,CAAC,CAAC;QACb,CAAC,EAAE;YACC,CAAC,EAAE,IAAA,kBAAQ,EAAC,gBAAM,CAAC;YACnB,CAAC,EAAE,gBAAM;YACT,CAAC,EAAE;gBACC,CAAC,EAAE,gBAAM;gBACT,CAAC,EAAE,gBAAM;aACZ;SACJ;KACJ;IACD,GAAG,EAAE;QACD,CAAC,EAAE,gBAAM;KACZ;IACD,CAAC,EAAE;QACC,CAAC,EAAE,IAAa;KACnB;CACJ,CAAC,CAAA;AACF,MAAM,GAAG,GAAG,IAAA,eAAK,EAAC;IACd,IAAI,EAAE;QACF,CAAC,EAAE,IAAA,eAAK,EAAC,CAAC,gBAAM,EAAE,gBAAM,EAAE,cAAI,EAAE,iBAAO,EAAE,gBAAM,EAAE,eAAK,EAAE,gBAAM,EAAE,eAAK,CAAC,CAAC;QACvE,CAAC,EAAE,IAAA,kBAAQ,EAAC,IAAA,eAAK,EAAC,CAAC,IAAA,eAAK,EAAC;gBACrB,CAAC,EAAE,IAAA,eAAK,EAAC,gBAAM,CAAC;aACnB,CAAC,EAAE,gBAAM,CAAC,CAAC,CAAC;QACb,CAAC,EAAE,IAAA,kBAAQ,EAAC;YACR,CAAC,EAAE,IAAA,kBAAQ,EAAC,gBAAM,CAAC;YACnB,CAAC,EAAE,gBAAM;YACT,CAAC,EAAE;gBACC,CAAC,EAAE,gBAAM;gBACT,CAAC,EAAE,gBAAM;aACZ;SACJ,CAAC;KACL;IACD,GAAG,EAAE;QACD,CAAC,EAAE,gBAAM;KACZ;IACD,CAAC,EAAE;QACC,CAAC,EAAE,IAAa;KACnB;CACJ,CAAC,CAAA;AACF,MAAM,KAAK,GAAG,IAAA,kBAAQ,EAAC,IAAA,eAAK,EAAC,IAAA,kBAAQ,EAAC;IAClC,IAAI,EAAE,IAAA,kBAAQ,EAAC;QACX,CAAC,EAAE,IAAA,eAAK,EAAC,CAAC,gBAAM,EAAE,gBAAM,EAAE,cAAI,EAAE,iBAAO,EAAE,gBAAM,EAAE,eAAK,EAAE,gBAAM,EAAE,eAAK,CAAC,CAAC;QACvE,CAAC,EAAE,IAAA,kBAAQ,EAAC,IAAA,eAAK,EAAC,CAAC,IAAA,eAAK,EAAC;gBACrB,CAAC,EAAE,IAAA,eAAK,EAAC,gBAAM,CAAC;aACnB,CAAC,EAAE,gBAAM,CAAC,CAAC,CAAC;QACb,CAAC,EAAE,IAAA,kBAAQ,EAAC;YACR,CAAC,EAAE,IAAA,kBAAQ,EAAC,gBAAM,CAAC;YACnB,CAAC,EAAE,gBAAM;YACT,CAAC,EAAE;gBACC,CAAC,EAAE,gBAAM;gBACT,CAAC,EAAE,gBAAM;aACZ;SACJ,CAAC;KACL,CAAC;IACF,GAAG,EAAE,IAAA,kBAAQ,EAAC;QACV,CAAC,EAAE,gBAAM;KACZ,CAAC;IACF,CAAC,EAAE,IAAA,kBAAQ,EAAC;QACR,CAAC,EAAE,IAAa;KACnB,CAAC;CACL,CAAC,CAAC,CAAC,CAAA;AAEJ,SAAgB,MAAM,KAAqB,CAAC;AAA5C,wBAA4C;AA0B5C,MAAM,EAAmC,CAAC;AAM1C,MAAM,EAAkC,CAAC;AACzC,MAAM,EAAoC,CAAC;AAC3C,MAAM,EAAoC,CAAC;AAE3C,MAAM,QAAQ,GAAG;IACb,CAAC,EAAE,gBAAM;IACT,GAAG,EAAE,gBAAM;CACd,CAAA;AAED,MAAM,QAAQ,GAAG,IAAA,kBAAQ,EAAC;IACtB,CAAC,EAAE,gBAAM;IACT,GAAG,EAAE,gBAAM;CACd,CAAC,CAAA;AAMF,MAAM,EAA2E,CAAC;AAClF,MAAM,EAA4G,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"largeSchema.test.js","sourceRoot":"","sources":["../../../tests/typebox/largeSchema.test.ts"],"names":[],"mappings":";;AACA,
|
|
1
|
+
{"version":3,"file":"largeSchema.test.js","sourceRoot":"","sources":["../../../tests/typebox/largeSchema.test.ts"],"names":[],"mappings":";;AACA,2CAA0I;AAE1I,MAAM,OAAO,GAAG;IACZ,CAAC,EAAE;QACC,CAAC,EAAE;YACC,CAAC,EAAE;gBACC,CAAC,EAAE;oBACC,CAAC,EAAE;wBACC,CAAC,EAAE;4BACC,CAAC,EAAE;gCACC,CAAC,EAAE;oCACC,CAAC,EAAE;wCACC,CAAC,EAAC;4CACE,CAAC,EAAE;gDACC,CAAC,EAAE;oDACC,CAAC,EAAE;wDACC,CAAC,EAAE;4DACC,CAAC,EAAE,QAAiB;yDACvB;qDACJ;iDACJ;6CACJ;yCACJ;qCACJ;iCACJ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;CACJ,CAAA;AAGD,MAAM,OAAO,GAAG;IACZ,CAAC,EAAE;QACC,CAAC,EAAE,gBAAM;QACT,CAAC,EAAE;YACC,CAAC,EAAE;gBACC,CAAC,EAAE;oBACC,CAAC,EAAE;wBACC,CAAC,EAAE;4BACC,CAAC,EAAE;gCACC,CAAC,EAAE;oCACC,CAAC,EAAE;wCACC,CAAC,EAAC;4CACE,CAAC,EAAE;gDACC,CAAC,EAAE;oDACC,CAAC,EAAE;wDACC,CAAC,EAAE;4DACC,CAAC,EAAE,gBAAM;yDACZ;qDACJ;iDACJ;6CACJ;yCACJ;qCACJ;iCACJ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;CACJ,CAAA;AAED,MAAM,SAAS,GAAG,IAAA,eAAK,EAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;AAG3C,MAAM,SAAS,GAAG,IAAA,eAAK,EAAC;IACpB,MAAM,EAAE;QACJ,IAAI,EAAE;YACF,CAAC,EAAE,IAAA,eAAK,EAAC,CAAC,gBAAM,EAAE,gBAAM,EAAE,cAAI,EAAE,iBAAO,EAAE,gBAAM,EAAE,eAAK,EAAE,gBAAM,EAAE,eAAK,CAAC,CAAC;YACvE,CAAC,EAAE,IAAA,kBAAQ,EAAC,IAAA,eAAK,EAAC,CAAC,IAAA,eAAK,EAAC;oBACrB,CAAC,EAAE,IAAA,eAAK,EAAC,gBAAM,CAAC;iBACnB,CAAC,EAAE,gBAAM,CAAC,CAAC,CAAC;YACb,CAAC,EAAE;gBACC,CAAC,EAAE,IAAA,kBAAQ,EAAC,gBAAM,CAAC;gBACnB,CAAC,EAAE,gBAAM;gBACT,CAAC,EAAE;oBACC,CAAC,EAAE,gBAAM;oBACT,CAAC,EAAE,gBAAM;oBACT,CAAC,EAAE;wBACC,CAAC,EAAE,gBAAM;wBACT,CAAC,EAAE,gBAAM;wBACT,CAAC,EAAE;4BACC,CAAC,EAAE,gBAAM;4BACT,CAAC,EAAE,gBAAM;4BACT,CAAC,EAAE;gCACC,CAAC,EAAE,iBAAO;gCACV,CAAC,EAAE,IAAA,eAAK,EAAC,gBAAM,CAAC;gCAChB,CAAC,EAAE,IAAA,kBAAQ,EAAC,IAAA,eAAK,EAAC,CAAC,gBAAM,EAAE,gBAAM,CAAC,CAAC,CAAC;gCACpC,CAAC,EAAE;oCACC,CAAC,EAAE,gBAAM;oCACT,CAAC,EAAE,gBAAM;iCACZ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;QACD,gBAAgB,EAAE;YACd,CAAC,EAAE,IAAA,eAAK,EAAC,CAAC,gBAAM,EAAE,iBAAO,EAAE,gBAAM,EAAE,eAAK,CAAC,CAAC;YAC1C,CAAC,EAAE,IAAA,kBAAQ,EAAC,IAAA,eAAK,EAAC,gBAAM,CAAC,CAAC;YAC1B,CAAC,EAAE;gBACC,CAAC,EAAE,gBAAM;gBACT,CAAC,EAAE,gBAAM;gBACT,CAAC,EAAE;oBACC,CAAC,EAAE,gBAAM;oBACT,CAAC,EAAE,gBAAM;iBACZ;aACJ;SACJ;QACD,gBAAgB,EAAE;YACd,CAAC,EAAE,gBAAM;YACT,CAAC,EAAE,IAAA,eAAK,EAAC,CAAC,gBAAM,EAAE,IAAA,eAAK,EAAC,iBAAO,CAAC,CAAC,CAAC;YAClC,CAAC,EAAE;gBACC,CAAC,EAAE,gBAAM;gBACT,CAAC,EAAE,gBAAM;aACZ;SACJ;KACJ;IACD,IAAI,EAAE;QACF,GAAG,EAAE;YACD,CAAC,EAAE,gBAAM;SACZ;QACD,GAAG,EAAE;YACD,CAAC,EAAE,gBAAM;SACZ;KACJ;IACD,IAAI,EAAE;QACF,CAAC,EAAE,IAAa;QAChB,CAAC,EAAE,KAAc;KACpB;CACJ,CAAC,CAAC"}
|
|
@@ -73,6 +73,7 @@ exports.assert = assert;
|
|
|
73
73
|
assert();
|
|
74
74
|
assert();
|
|
75
75
|
assert();
|
|
76
|
+
assert();
|
|
76
77
|
const shortOne = {
|
|
77
78
|
s: zod_1.string,
|
|
78
79
|
non: zod_1.number
|
|
@@ -82,4 +83,5 @@ const shortTwo = (0, zod_1.schemify)({
|
|
|
82
83
|
non: zod_1.number
|
|
83
84
|
});
|
|
84
85
|
assert();
|
|
86
|
+
assert();
|
|
85
87
|
//# sourceMappingURL=equality.test.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"equality.test.js","sourceRoot":"","sources":["../../../tests/zod/equality.test.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"equality.test.js","sourceRoot":"","sources":["../../../tests/zod/equality.test.ts"],"names":[],"mappings":";;;AACA,mCAA4I;AAE5I,MAAM,GAAG,GAAG,IAAA,WAAK,EAAC;IACd,IAAI,EAAE;QACF,CAAC,EAAE,IAAA,WAAK,EAAC,CAAC,YAAM,EAAE,YAAM,EAAE,UAAI,EAAE,aAAO,EAAE,YAAM,EAAE,WAAK,EAAE,YAAM,EAAE,WAAK,CAAC,CAAC;QACvE,CAAC,EAAE,IAAA,cAAQ,EAAC,IAAA,WAAK,EAAC,CAAC,IAAA,WAAK,EAAC;gBACrB,CAAC,EAAE,IAAA,WAAK,EAAC,YAAM,CAAC;aACnB,CAAC,EAAE,YAAM,CAAC,CAAC,CAAC;QACb,CAAC,EAAE;YACC,CAAC,EAAE,IAAA,cAAQ,EAAC,YAAM,CAAC;YACnB,CAAC,EAAE,YAAM;YACT,CAAC,EAAE;gBACC,CAAC,EAAE,YAAM;gBACT,CAAC,EAAE,YAAM;aACZ;SACJ;KACJ;IACD,GAAG,EAAE;QACD,CAAC,EAAE,YAAM;KACZ;IACD,CAAC,EAAE;QACC,CAAC,EAAE,IAAa;KACnB;CACJ,CAAC,CAAA;AACF,MAAM,GAAG,GAAG,IAAA,WAAK,EAAC;IACd,IAAI,EAAE;QACF,CAAC,EAAE,IAAA,WAAK,EAAC,CAAC,YAAM,EAAE,YAAM,EAAE,UAAI,EAAE,aAAO,EAAE,YAAM,EAAE,WAAK,EAAE,YAAM,EAAE,WAAK,CAAC,CAAC;QACvE,CAAC,EAAE,IAAA,cAAQ,EAAC,IAAA,WAAK,EAAC,CAAC,IAAA,WAAK,EAAC;gBACrB,CAAC,EAAE,IAAA,WAAK,EAAC,YAAM,CAAC;aACnB,CAAC,EAAE,YAAM,CAAC,CAAC,CAAC;QACb,CAAC,EAAE,IAAA,cAAQ,EAAC;YACR,CAAC,EAAE,IAAA,cAAQ,EAAC,YAAM,CAAC;YACnB,CAAC,EAAE,YAAM;YACT,CAAC,EAAE;gBACC,CAAC,EAAE,YAAM;gBACT,CAAC,EAAE,YAAM;aACZ;SACJ,CAAC;KACL;IACD,GAAG,EAAE;QACD,CAAC,EAAE,YAAM;KACZ;IACD,CAAC,EAAE;QACC,CAAC,EAAE,IAAa;KACnB;CACJ,CAAC,CAAA;AACF,MAAM,KAAK,GAAG,IAAA,cAAQ,EAAC,IAAA,WAAK,EAAC,IAAA,cAAQ,EAAC;IAClC,IAAI,EAAE,IAAA,cAAQ,EAAC;QACX,CAAC,EAAE,IAAA,WAAK,EAAC,CAAC,YAAM,EAAE,YAAM,EAAE,UAAI,EAAE,aAAO,EAAE,YAAM,EAAE,WAAK,EAAE,YAAM,EAAE,WAAK,CAAC,CAAC;QACvE,CAAC,EAAE,IAAA,cAAQ,EAAC,IAAA,WAAK,EAAC,CAAC,IAAA,WAAK,EAAC;gBACrB,CAAC,EAAE,IAAA,WAAK,EAAC,YAAM,CAAC;aACnB,CAAC,EAAE,YAAM,CAAC,CAAC,CAAC;QACb,CAAC,EAAE,IAAA,cAAQ,EAAC;YACR,CAAC,EAAE,IAAA,cAAQ,EAAC,YAAM,CAAC;YACnB,CAAC,EAAE,YAAM;YACT,CAAC,EAAE;gBACC,CAAC,EAAE,YAAM;gBACT,CAAC,EAAE,YAAM;aACZ;SACJ,CAAC;KACL,CAAC;IACF,GAAG,EAAE,IAAA,cAAQ,EAAC;QACV,CAAC,EAAE,YAAM;KACZ,CAAC;IACF,CAAC,EAAE,IAAA,cAAQ,EAAC;QACR,CAAC,EAAE,IAAa;KACnB,CAAC;CACL,CAAC,CAAC,CAAC,CAAA;AAEJ,SAAgB,MAAM,KAAqB,CAAC;AAA5C,wBAA4C;AA8B5C,MAAM,EAAiC,CAAC;AACxC,MAAM,EAAkC,CAAC;AACzC,MAAM,EAAoC,CAAC;AAC3C,MAAM,EAAoC,CAAC;AAE3C,MAAM,QAAQ,GAAG;IACb,CAAC,EAAE,YAAM;IACT,GAAG,EAAE,YAAM;CACd,CAAA;AAED,MAAM,QAAQ,GAAG,IAAA,cAAQ,EAAC;IACtB,CAAC,EAAE,YAAM;IACT,GAAG,EAAE,YAAM;CACd,CAAC,CAAA;AAMF,MAAM,EAAuE,CAAC;AAC9E,MAAM,EAAoG,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"largeSchema.test.js","sourceRoot":"","sources":["../../../tests/zod/largeSchema.test.ts"],"names":[],"mappings":";;AACA,
|
|
1
|
+
{"version":3,"file":"largeSchema.test.js","sourceRoot":"","sources":["../../../tests/zod/largeSchema.test.ts"],"names":[],"mappings":";;AACA,mCAAkI;AAElI,MAAM,OAAO,GAAG;IACZ,CAAC,EAAE;QACC,CAAC,EAAE;YACC,CAAC,EAAE;gBACC,CAAC,EAAE;oBACC,CAAC,EAAE;wBACC,CAAC,EAAE;4BACC,CAAC,EAAE;gCACC,CAAC,EAAE;oCACC,CAAC,EAAE;wCACC,CAAC,EAAC;4CACE,CAAC,EAAE;gDACC,CAAC,EAAE;oDACC,CAAC,EAAE;wDACC,CAAC,EAAE;4DACC,CAAC,EAAE,QAAiB;yDACvB;qDACJ;iDACJ;6CACJ;yCACJ;qCACJ;iCACJ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;CACJ,CAAA;AAGD,MAAM,OAAO,GAAG;IACZ,CAAC,EAAE;QACC,CAAC,EAAE,YAAM;QACT,CAAC,EAAE;YACC,CAAC,EAAE;gBACC,CAAC,EAAE;oBACC,CAAC,EAAE;wBACC,CAAC,EAAE;4BACC,CAAC,EAAE;gCACC,CAAC,EAAE;oCACC,CAAC,EAAE;wCACC,CAAC,EAAC;4CACE,CAAC,EAAE;gDACC,CAAC,EAAE;oDACC,CAAC,EAAE;wDACC,CAAC,EAAE;4DACC,CAAC,EAAE,YAAM;yDACZ;qDACJ;iDACJ;6CACJ;yCACJ;qCACJ;iCACJ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;CACJ,CAAA;AAED,MAAM,SAAS,GAAG,IAAA,WAAK,EAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;AAG3C,MAAM,SAAS,GAAG,IAAA,WAAK,EAAC;IACpB,MAAM,EAAE;QACJ,IAAI,EAAE;YACF,CAAC,EAAE,IAAA,WAAK,EAAC,CAAC,YAAM,EAAE,YAAM,EAAE,UAAI,EAAE,aAAO,EAAE,YAAM,EAAE,WAAK,EAAE,YAAM,EAAE,WAAK,CAAC,CAAC;YACvE,CAAC,EAAE,IAAA,cAAQ,EAAC,IAAA,WAAK,EAAC,CAAC,IAAA,WAAK,EAAC;oBACrB,CAAC,EAAE,IAAA,WAAK,EAAC,YAAM,CAAC;iBACnB,CAAC,EAAE,YAAM,CAAC,CAAC,CAAC;YACb,CAAC,EAAE;gBACC,CAAC,EAAE,IAAA,cAAQ,EAAC,YAAM,CAAC;gBACnB,CAAC,EAAE,YAAM;gBACT,CAAC,EAAE;oBACC,CAAC,EAAE,YAAM;oBACT,CAAC,EAAE,YAAM;oBACT,CAAC,EAAE;wBACC,CAAC,EAAE,YAAM;wBACT,CAAC,EAAE,YAAM;wBACT,CAAC,EAAE;4BACC,CAAC,EAAE,YAAM;4BACT,CAAC,EAAE,YAAM;4BACT,CAAC,EAAE;gCACC,CAAC,EAAE,aAAO;gCACV,CAAC,EAAE,IAAA,WAAK,EAAC,YAAM,CAAC;gCAChB,CAAC,EAAE,IAAA,cAAQ,EAAC,IAAA,WAAK,EAAC,CAAC,YAAM,EAAE,YAAM,CAAC,CAAC,CAAC;gCACpC,CAAC,EAAE;oCACC,CAAC,EAAE,YAAM;oCACT,CAAC,EAAE,YAAM;iCACZ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;QACD,gBAAgB,EAAE;YACd,CAAC,EAAE,IAAA,WAAK,EAAC,CAAC,YAAM,EAAE,aAAO,EAAE,YAAM,EAAE,WAAK,CAAC,CAAC;YAC1C,CAAC,EAAE,IAAA,cAAQ,EAAC,IAAA,WAAK,EAAC,YAAM,CAAC,CAAC;YAC1B,CAAC,EAAE;gBACC,CAAC,EAAE,YAAM;gBACT,CAAC,EAAE,YAAM;gBACT,CAAC,EAAE;oBACC,CAAC,EAAE,YAAM;oBACT,CAAC,EAAE,YAAM;iBACZ;aACJ;SACJ;QACD,gBAAgB,EAAE;YACd,CAAC,EAAE,YAAM;YACT,CAAC,EAAE,IAAA,WAAK,EAAC,CAAC,YAAM,EAAE,IAAA,WAAK,EAAC,aAAO,CAAC,CAAC,CAAC;YAClC,CAAC,EAAE;gBACC,CAAC,EAAE,YAAM;gBACT,CAAC,EAAE,YAAM;aACZ;SACJ;KACJ;IACD,IAAI,EAAE;QACF,GAAG,EAAE;YACD,CAAC,EAAE,YAAM;SACZ;QACD,GAAG,EAAE;YACD,CAAC,EAAE,YAAM;SACZ;KACJ;IACD,IAAI,EAAE;QACF,CAAC,EAAE,IAAa;QAChB,CAAC,EAAE,KAAc;KACpB;CACJ,CAAC,CAAC"}
|
package/dist/typebox.d.ts
CHANGED
|
@@ -2,18 +2,18 @@
|
|
|
2
2
|
* This module provides a TypeScript-based schema definition using the TypeBox library.
|
|
3
3
|
* It includes various types, schema creation, validation, and OpenAPI integration.
|
|
4
4
|
*
|
|
5
|
-
* @module
|
|
5
|
+
* @module TypeboxSchemaProvider
|
|
6
6
|
*/
|
|
7
7
|
import { TSchema, TArray, TOptional, TUnion, TLiteral } from '@sinclair/typebox';
|
|
8
8
|
import { LiteralSchema } from './types/schema.types';
|
|
9
|
-
import {
|
|
9
|
+
import { SchemaProvider } from './interfaces/schemaProvider.interfaces';
|
|
10
10
|
import { SchemaObject } from 'openapi3-ts/oas31';
|
|
11
11
|
import { TUnionContainer, TIdiomaticSchema, TResolve, UnionTResolve } from './types/typebox.schema.types';
|
|
12
12
|
/**
|
|
13
13
|
* Class representing a TypeBox schema definition.
|
|
14
|
-
* @implements {
|
|
14
|
+
* @implements {SchemaProvider}
|
|
15
15
|
*/
|
|
16
|
-
export declare class
|
|
16
|
+
export declare class TypeboxSchemaProvider implements SchemaProvider<TUnionContainer, TIdiomaticSchema, TSchema> {
|
|
17
17
|
string: import("@sinclair/typebox").TString;
|
|
18
18
|
number: import("@sinclair/typebox").TNumber;
|
|
19
19
|
bigint: import("@sinclair/typebox").TBigInt;
|
|
@@ -46,6 +46,9 @@ export declare class TypeboxSchemaDefinition implements SchemaDefinition<TUnionC
|
|
|
46
46
|
* Create a union schema.
|
|
47
47
|
* @param {TUnionContainer} schemas - The schemas to union.
|
|
48
48
|
* @returns {TUnion<UnionTResolve<T>>} The union schema.
|
|
49
|
+
*
|
|
50
|
+
* WARNING: If "empty" or TUndefined is included in the union, the key will still be expected.
|
|
51
|
+
* This is a limitation of TypeBox. Consider using "optional" instead.
|
|
49
52
|
*/
|
|
50
53
|
union<T extends TUnionContainer>(schemas: T): TUnion<UnionTResolve<T>>;
|
|
51
54
|
/**
|
|
@@ -69,77 +72,77 @@ export declare class TypeboxSchemaDefinition implements SchemaDefinition<TUnionC
|
|
|
69
72
|
openapi<T extends TIdiomaticSchema | TSchema>(schema: T): SchemaObject;
|
|
70
73
|
}
|
|
71
74
|
/**
|
|
72
|
-
* Factory function for creating a
|
|
73
|
-
* @returns {
|
|
75
|
+
* Factory function for creating a TypeboxSchemaProvider instance.
|
|
76
|
+
* @returns {TypeboxSchemaProvider} The TypeboxSchemaProvider instance.
|
|
74
77
|
*/
|
|
75
|
-
export declare const TypeboxSchema: () =>
|
|
76
|
-
declare const
|
|
78
|
+
export declare const TypeboxSchema: () => TypeboxSchemaProvider;
|
|
79
|
+
declare const SchemaProvider: TypeboxSchemaProvider;
|
|
77
80
|
/**
|
|
78
81
|
* TypeBox schema definition for string type.
|
|
79
82
|
*/
|
|
80
|
-
export declare const string: typeof
|
|
83
|
+
export declare const string: typeof SchemaProvider.string;
|
|
81
84
|
/**
|
|
82
85
|
* TypeBox schema definition for number type.
|
|
83
86
|
*/
|
|
84
|
-
export declare const number: typeof
|
|
87
|
+
export declare const number: typeof SchemaProvider.number;
|
|
85
88
|
/**
|
|
86
89
|
* TypeBox schema definition for bigint type.
|
|
87
90
|
*/
|
|
88
|
-
export declare const bigint: typeof
|
|
91
|
+
export declare const bigint: typeof SchemaProvider.bigint;
|
|
89
92
|
/**
|
|
90
93
|
* TypeBox schema definition for boolean type.
|
|
91
94
|
*/
|
|
92
|
-
export declare const boolean: typeof
|
|
95
|
+
export declare const boolean: typeof SchemaProvider.boolean;
|
|
93
96
|
/**
|
|
94
97
|
* TypeBox schema definition for date type.
|
|
95
98
|
*/
|
|
96
|
-
export declare const date: typeof
|
|
99
|
+
export declare const date: typeof SchemaProvider.date;
|
|
97
100
|
/**
|
|
98
101
|
* TypeBox schema definition for symbol type.
|
|
99
102
|
*/
|
|
100
|
-
export declare const symbol: typeof
|
|
103
|
+
export declare const symbol: typeof SchemaProvider.symbol;
|
|
101
104
|
/**
|
|
102
105
|
* TypeBox schema definition for undefined, null, void types.
|
|
103
106
|
*/
|
|
104
|
-
export declare const empty: typeof
|
|
107
|
+
export declare const empty: typeof SchemaProvider.empty;
|
|
105
108
|
/**
|
|
106
109
|
* TypeBox schema definition for any type.
|
|
107
110
|
*/
|
|
108
|
-
export declare const any: typeof
|
|
111
|
+
export declare const any: typeof SchemaProvider.any;
|
|
109
112
|
/**
|
|
110
113
|
* TypeBox schema definition for unknown type.
|
|
111
114
|
*/
|
|
112
|
-
export declare const unknown: typeof
|
|
115
|
+
export declare const unknown: typeof SchemaProvider.unknown;
|
|
113
116
|
/**
|
|
114
117
|
* TypeBox schema definition for never type.
|
|
115
118
|
*/
|
|
116
|
-
export declare const never: typeof
|
|
119
|
+
export declare const never: typeof SchemaProvider.never;
|
|
117
120
|
/**
|
|
118
121
|
* Transforms valid schema into TypeBox schema.
|
|
119
122
|
*/
|
|
120
|
-
export declare const schemify: typeof
|
|
123
|
+
export declare const schemify: typeof SchemaProvider.schemify;
|
|
121
124
|
/**
|
|
122
125
|
* Makes a valid schema optional.
|
|
123
126
|
*/
|
|
124
|
-
export declare const optional: typeof
|
|
127
|
+
export declare const optional: typeof SchemaProvider.optional;
|
|
125
128
|
/**
|
|
126
129
|
* Defines an array for a valid schema.
|
|
127
130
|
*/
|
|
128
|
-
export declare const array: typeof
|
|
131
|
+
export declare const array: typeof SchemaProvider.array;
|
|
129
132
|
/**
|
|
130
133
|
* Defines a union for a valid schema.
|
|
131
134
|
*/
|
|
132
|
-
export declare const union: typeof
|
|
135
|
+
export declare const union: typeof SchemaProvider.union;
|
|
133
136
|
/**
|
|
134
137
|
* Defines a literal for a valid schema.
|
|
135
138
|
*/
|
|
136
|
-
export declare const literal: typeof
|
|
139
|
+
export declare const literal: typeof SchemaProvider.literal;
|
|
137
140
|
/**
|
|
138
141
|
* Validates a value against a valid schema.
|
|
139
142
|
*/
|
|
140
|
-
export declare const validate: typeof
|
|
143
|
+
export declare const validate: typeof SchemaProvider.validate;
|
|
141
144
|
/**
|
|
142
145
|
* Generates an OpenAPI schema object from a valid schema.
|
|
143
146
|
*/
|
|
144
|
-
export declare const openapi: typeof
|
|
147
|
+
export declare const openapi: typeof SchemaProvider.openapi;
|
|
145
148
|
export {};
|
package/dist/typebox.js
CHANGED
|
@@ -3,17 +3,17 @@
|
|
|
3
3
|
* This module provides a TypeScript-based schema definition using the TypeBox library.
|
|
4
4
|
* It includes various types, schema creation, validation, and OpenAPI integration.
|
|
5
5
|
*
|
|
6
|
-
* @module
|
|
6
|
+
* @module TypeboxSchemaProvider
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.openapi = exports.validate = exports.literal = exports.union = exports.array = exports.optional = exports.schemify = exports.never = exports.unknown = exports.any = exports.empty = exports.symbol = exports.date = exports.boolean = exports.bigint = exports.number = exports.string = exports.TypeboxSchema = exports.
|
|
9
|
+
exports.openapi = exports.validate = exports.literal = exports.union = exports.array = exports.optional = exports.schemify = exports.never = exports.unknown = exports.any = exports.empty = exports.symbol = exports.date = exports.boolean = exports.bigint = exports.number = exports.string = exports.TypeboxSchema = exports.TypeboxSchemaProvider = void 0;
|
|
10
10
|
const typebox_1 = require("@sinclair/typebox");
|
|
11
11
|
const value_1 = require("@sinclair/typebox/value");
|
|
12
12
|
/**
|
|
13
13
|
* Class representing a TypeBox schema definition.
|
|
14
|
-
* @implements {
|
|
14
|
+
* @implements {SchemaProvider}
|
|
15
15
|
*/
|
|
16
|
-
class
|
|
16
|
+
class TypeboxSchemaProvider {
|
|
17
17
|
string = typebox_1.Type.String();
|
|
18
18
|
number = typebox_1.Type.Number();
|
|
19
19
|
bigint = typebox_1.Type.BigInt();
|
|
@@ -76,6 +76,9 @@ class TypeboxSchemaDefinition {
|
|
|
76
76
|
* Create a union schema.
|
|
77
77
|
* @param {TUnionContainer} schemas - The schemas to union.
|
|
78
78
|
* @returns {TUnion<UnionTResolve<T>>} The union schema.
|
|
79
|
+
*
|
|
80
|
+
* WARNING: If "empty" or TUndefined is included in the union, the key will still be expected.
|
|
81
|
+
* This is a limitation of TypeBox. Consider using "optional" instead.
|
|
79
82
|
*/
|
|
80
83
|
union(schemas) {
|
|
81
84
|
const unionTypes = schemas.map((schema) => {
|
|
@@ -112,80 +115,80 @@ class TypeboxSchemaDefinition {
|
|
|
112
115
|
return this.schemify(schema);
|
|
113
116
|
}
|
|
114
117
|
}
|
|
115
|
-
exports.
|
|
118
|
+
exports.TypeboxSchemaProvider = TypeboxSchemaProvider;
|
|
116
119
|
/**
|
|
117
|
-
* Factory function for creating a
|
|
118
|
-
* @returns {
|
|
120
|
+
* Factory function for creating a TypeboxSchemaProvider instance.
|
|
121
|
+
* @returns {TypeboxSchemaProvider} The TypeboxSchemaProvider instance.
|
|
119
122
|
*/
|
|
120
|
-
const TypeboxSchema = () => new
|
|
123
|
+
const TypeboxSchema = () => new TypeboxSchemaProvider();
|
|
121
124
|
exports.TypeboxSchema = TypeboxSchema;
|
|
122
|
-
const
|
|
125
|
+
const SchemaProvider = (0, exports.TypeboxSchema)();
|
|
123
126
|
/**
|
|
124
127
|
* TypeBox schema definition for string type.
|
|
125
128
|
*/
|
|
126
|
-
exports.string =
|
|
129
|
+
exports.string = SchemaProvider.string;
|
|
127
130
|
/**
|
|
128
131
|
* TypeBox schema definition for number type.
|
|
129
132
|
*/
|
|
130
|
-
exports.number =
|
|
133
|
+
exports.number = SchemaProvider.number;
|
|
131
134
|
/**
|
|
132
135
|
* TypeBox schema definition for bigint type.
|
|
133
136
|
*/
|
|
134
|
-
exports.bigint =
|
|
137
|
+
exports.bigint = SchemaProvider.bigint;
|
|
135
138
|
/**
|
|
136
139
|
* TypeBox schema definition for boolean type.
|
|
137
140
|
*/
|
|
138
|
-
exports.boolean =
|
|
141
|
+
exports.boolean = SchemaProvider.boolean;
|
|
139
142
|
/**
|
|
140
143
|
* TypeBox schema definition for date type.
|
|
141
144
|
*/
|
|
142
|
-
exports.date =
|
|
145
|
+
exports.date = SchemaProvider.date;
|
|
143
146
|
/**
|
|
144
147
|
* TypeBox schema definition for symbol type.
|
|
145
148
|
*/
|
|
146
|
-
exports.symbol =
|
|
149
|
+
exports.symbol = SchemaProvider.symbol;
|
|
147
150
|
/**
|
|
148
151
|
* TypeBox schema definition for undefined, null, void types.
|
|
149
152
|
*/
|
|
150
|
-
exports.empty =
|
|
153
|
+
exports.empty = SchemaProvider.empty;
|
|
151
154
|
/**
|
|
152
155
|
* TypeBox schema definition for any type.
|
|
153
156
|
*/
|
|
154
|
-
exports.any =
|
|
157
|
+
exports.any = SchemaProvider.any;
|
|
155
158
|
/**
|
|
156
159
|
* TypeBox schema definition for unknown type.
|
|
157
160
|
*/
|
|
158
|
-
exports.unknown =
|
|
161
|
+
exports.unknown = SchemaProvider.unknown;
|
|
159
162
|
/**
|
|
160
163
|
* TypeBox schema definition for never type.
|
|
161
164
|
*/
|
|
162
|
-
exports.never =
|
|
165
|
+
exports.never = SchemaProvider.never;
|
|
163
166
|
/**
|
|
164
167
|
* Transforms valid schema into TypeBox schema.
|
|
165
168
|
*/
|
|
166
|
-
exports.schemify =
|
|
169
|
+
exports.schemify = SchemaProvider.schemify.bind(SchemaProvider);
|
|
167
170
|
/**
|
|
168
171
|
* Makes a valid schema optional.
|
|
169
172
|
*/
|
|
170
|
-
exports.optional =
|
|
173
|
+
exports.optional = SchemaProvider.optional.bind(SchemaProvider);
|
|
171
174
|
/**
|
|
172
175
|
* Defines an array for a valid schema.
|
|
173
176
|
*/
|
|
174
|
-
exports.array =
|
|
177
|
+
exports.array = SchemaProvider.array.bind(SchemaProvider);
|
|
175
178
|
/**
|
|
176
179
|
* Defines a union for a valid schema.
|
|
177
180
|
*/
|
|
178
|
-
exports.union =
|
|
181
|
+
exports.union = SchemaProvider.union.bind(SchemaProvider);
|
|
179
182
|
/**
|
|
180
183
|
* Defines a literal for a valid schema.
|
|
181
184
|
*/
|
|
182
|
-
exports.literal =
|
|
185
|
+
exports.literal = SchemaProvider.literal.bind(SchemaProvider);
|
|
183
186
|
/**
|
|
184
187
|
* Validates a value against a valid schema.
|
|
185
188
|
*/
|
|
186
|
-
exports.validate =
|
|
189
|
+
exports.validate = SchemaProvider.validate.bind(SchemaProvider);
|
|
187
190
|
/**
|
|
188
191
|
* Generates an OpenAPI schema object from a valid schema.
|
|
189
192
|
*/
|
|
190
|
-
exports.openapi =
|
|
193
|
+
exports.openapi = SchemaProvider.openapi.bind(SchemaProvider);
|
|
191
194
|
//# sourceMappingURL=typebox.js.map
|
package/dist/typebox.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"typebox.js","sourceRoot":"","sources":["../typebox.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+CAA6F;AAC7F,mDAAgD;AAMhD;;;GAGG;AACH,MAAa,
|
|
1
|
+
{"version":3,"file":"typebox.js","sourceRoot":"","sources":["../typebox.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,+CAA6F;AAC7F,mDAAgD;AAMhD;;;GAGG;AACH,MAAa,qBAAqB;IAK9B,MAAM,GAAG,cAAI,CAAC,MAAM,EAAE,CAAC;IACvB,MAAM,GAAG,cAAI,CAAC,MAAM,EAAE,CAAC;IACvB,MAAM,GAAG,cAAI,CAAC,MAAM,EAAE,CAAC;IACvB,OAAO,GAAG,cAAI,CAAC,OAAO,EAAE,CAAC;IACzB,IAAI,GAAG,cAAI,CAAC,IAAI,EAAE,CAAC;IACnB,MAAM,GAAG,cAAI,CAAC,MAAM,EAAE,CAAC;IACvB,KAAK,GAAG,cAAI,CAAC,KAAK,CAAC,CAAC,cAAI,CAAC,IAAI,EAAE,EAAE,cAAI,CAAC,IAAI,EAAE,EAAE,cAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IACjE,GAAG,GAAG,cAAI,CAAC,GAAG,EAAE,CAAC;IACjB,OAAO,GAAG,cAAI,CAAC,OAAO,EAAE,CAAC;IACzB,KAAK,GAAG,cAAI,CAAC,KAAK,EAAE,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAA6B,MAAS;QAC1C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;YACzF,OAAO,cAAI,CAAC,OAAO,CAAC,MAAM,CAAgB,CAAC;SAC9C;QAED,IAAI,cAAI,IAAK,MAAkB,EAAE;YAC7B,OAAO,MAAqB,CAAC;SAChC;QAED,MAAM,SAAS,GAEX,EAAE,CAAC;QACP,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC/C,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,cAAI,IAAK,MAAM,CAAC,GAAG,CAAa,EAAE;gBACrE,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAY,CAAC;aAC3C;iBAAM;gBACH,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC1C,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;aAC3B;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,cAAI,CAAC,MAAM,CAAC,SAAS,CAAgB,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAA6B,MAAS;QAC1C,IAAI,cAAI,IAAK,MAAkB,EAAE;YAC7B,OAAO,cAAI,CAAC,QAAQ,CAAC,MAAiB,CAA2B,CAAC;SACrE;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,OAAO,cAAI,CAAC,QAAQ,CAAC,MAAM,CAA2B,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAA6B,MAAS;QACvC,IAAI,cAAI,IAAK,MAAkB,EAAE;YAC7B,OAAO,cAAI,CAAC,KAAK,CAAC,MAAiB,CAAwB,CAAC;SAC/D;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACrC,OAAO,cAAI,CAAC,KAAK,CAAC,MAAM,CAAwB,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAA4B,OAAU;QACvC,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACtC,IAAI,cAAI,IAAK,MAAkB,EAAE;gBAC7B,OAAO,MAAiB,CAAC;aAC5B;YACD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,OAAO,cAAI,CAAC,KAAK,CAAC,UAAU,CAA6B,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACH,OAAO,CAA0B,KAAQ;QACrC,OAAO,cAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAoB,MAAS,EAAE,KAAc;QACjD,OAAO,aAAK,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAuC,MAAS;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;CACJ;AArHD,sDAqHC;AAED;;;GAGG;AACI,MAAM,aAAa,GAAG,GAAG,EAAE,CAAC,IAAI,qBAAqB,EAAE,CAAC;AAAlD,QAAA,aAAa,iBAAqC;AAE/D,MAAM,cAAc,GAAG,IAAA,qBAAa,GAAE,CAAC;AAEvC;;GAEG;AACU,QAAA,MAAM,GAAiC,cAAc,CAAC,MAAM,CAAC;AAE1E;;GAEG;AACU,QAAA,MAAM,GAAiC,cAAc,CAAC,MAAM,CAAC;AAE1E;;GAEG;AACU,QAAA,MAAM,GAAiC,cAAc,CAAC,MAAM,CAAC;AAE1E;;GAEG;AACU,QAAA,OAAO,GAAkC,cAAc,CAAC,OAAO,CAAC;AAE7E;;GAEG;AACU,QAAA,IAAI,GAA+B,cAAc,CAAC,IAAI,CAAC;AAEpE;;GAEG;AACU,QAAA,MAAM,GAAiC,cAAc,CAAC,MAAM,CAAC;AAE1E;;GAEG;AACU,QAAA,KAAK,GAAgC,cAAc,CAAC,KAAK,CAAC;AAEvE;;GAEG;AACU,QAAA,GAAG,GAA8B,cAAc,CAAC,GAAG,CAAC;AAEjE;;GAEG;AACU,QAAA,OAAO,GAAkC,cAAc,CAAC,OAAO,CAAC;AAE7E;;GAEG;AACU,QAAA,KAAK,GAAgC,cAAc,CAAC,KAAK,CAAC;AAEvE;;GAEG;AACU,QAAA,QAAQ,GAAmC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAErG;;GAEG;AACU,QAAA,QAAQ,GAAmC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAErG;;GAEG;AACU,QAAA,KAAK,GAAgC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAE5F;;GAEG;AACU,QAAA,KAAK,GAAgC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAE5F;;GAEG;AACU,QAAA,OAAO,GAAkC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAElG;;GAEG;AACU,QAAA,QAAQ,GAAmC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAErG;;GAEG;AACU,QAAA,OAAO,GAAkC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC"}
|
|
@@ -1,7 +1,28 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Represents a schema for an unboxed object where each key can have an idiomatic schema.
|
|
3
|
+
*
|
|
4
|
+
* @template Catchall - The type to use for catch-all cases in the schema.
|
|
5
|
+
*/
|
|
1
6
|
export type UnboxedObjectSchema<Catchall> = {
|
|
2
7
|
[key: KeyTypes]: IdiomaticSchema<Catchall>;
|
|
3
8
|
};
|
|
9
|
+
/**
|
|
10
|
+
* Represents a schema that can be a literal value.
|
|
11
|
+
*/
|
|
4
12
|
export type LiteralSchema = string | number | boolean;
|
|
13
|
+
/**
|
|
14
|
+
* Represents an idiomatic schema which can be an unboxed object schema, a literal schema, or a catch-all type.
|
|
15
|
+
*
|
|
16
|
+
* @template Catchall - The type to use for catch-all cases in the schema.
|
|
17
|
+
*/
|
|
5
18
|
export type IdiomaticSchema<Catchall> = UnboxedObjectSchema<Catchall> | LiteralSchema | Catchall;
|
|
19
|
+
/**
|
|
20
|
+
* Increments a number type by one, with support up to 50.
|
|
21
|
+
*
|
|
22
|
+
* @template T - The number type to increment.
|
|
23
|
+
*/
|
|
6
24
|
export type Increment<T extends number> = T extends 0 ? 1 : T extends 1 ? 2 : T extends 2 ? 3 : T extends 3 ? 4 : T extends 4 ? 5 : T extends 5 ? 6 : T extends 6 ? 7 : T extends 7 ? 8 : T extends 8 ? 9 : T extends 9 ? 10 : T extends 10 ? 11 : T extends 11 ? 12 : T extends 12 ? 13 : T extends 13 ? 14 : T extends 14 ? 15 : T extends 15 ? 16 : T extends 16 ? 17 : T extends 17 ? 18 : T extends 18 ? 19 : T extends 19 ? 20 : T extends 20 ? 21 : T extends 21 ? 22 : T extends 22 ? 23 : T extends 23 ? 24 : T extends 24 ? 25 : T extends 25 ? 26 : T extends 26 ? 27 : T extends 27 ? 28 : T extends 28 ? 29 : T extends 29 ? 30 : T extends 30 ? 31 : T extends 31 ? 32 : T extends 32 ? 33 : T extends 33 ? 34 : T extends 34 ? 35 : T extends 35 ? 36 : T extends 36 ? 37 : T extends 37 ? 38 : T extends 38 ? 39 : T extends 39 ? 40 : T extends 40 ? 41 : T extends 41 ? 42 : T extends 42 ? 43 : T extends 43 ? 44 : T extends 44 ? 45 : T extends 45 ? 46 : T extends 46 ? 47 : T extends 47 ? 48 : T extends 48 ? 49 : T extends 49 ? 50 : 50;
|
|
25
|
+
/**
|
|
26
|
+
* Represents key types that can be used in the schema.
|
|
27
|
+
*/
|
|
7
28
|
export type KeyTypes = string | number;
|
|
@@ -1,15 +1,50 @@
|
|
|
1
1
|
import { TSchema, TObject as OriginalTObject, TArray, TLiteral, TNever, Static, TProperties, TKind, TAny } from '@sinclair/typebox';
|
|
2
2
|
import { Increment, KeyTypes, LiteralSchema } from './schema.types';
|
|
3
|
+
/**
|
|
4
|
+
* Represents a catch-all schema type.
|
|
5
|
+
*/
|
|
3
6
|
export type TCatchall = TSchema;
|
|
7
|
+
/**
|
|
8
|
+
* Represents an outer array schema type. If the type T is an object shape, it will return an array schema of T. Otherwise, it returns TNever.
|
|
9
|
+
*
|
|
10
|
+
* @template T - The type to check and possibly convert to an array schema.
|
|
11
|
+
*/
|
|
4
12
|
export type TOuterArray<T> = T extends TObject<TObjectShape> ? TArray<T> : TNever;
|
|
13
|
+
/**
|
|
14
|
+
* Represents the shape of an object schema.
|
|
15
|
+
*/
|
|
5
16
|
export type TObjectShape = TProperties;
|
|
17
|
+
/**
|
|
18
|
+
* Represents an object schema type. If the type T is an object shape, it will return the original TObject type of T. Otherwise, it returns TNever.
|
|
19
|
+
*
|
|
20
|
+
* @template T - The type to check and possibly convert to an object schema.
|
|
21
|
+
*/
|
|
6
22
|
export type TObject<T> = T extends TObjectShape ? OriginalTObject<T> : TNever;
|
|
23
|
+
/**
|
|
24
|
+
* Translates a schema type T to its static type if T extends TCatchall. Otherwise, it returns TNever.
|
|
25
|
+
*
|
|
26
|
+
* @template T - The schema type to translate.
|
|
27
|
+
*/
|
|
7
28
|
export type TSchemaTranslate<T> = T extends TCatchall ? Static<T> : TNever;
|
|
29
|
+
/**
|
|
30
|
+
* Represents an unboxed object schema where each key can have an idiomatic schema.
|
|
31
|
+
*/
|
|
8
32
|
export type UnboxedTObjectSchema = {
|
|
9
33
|
[key: KeyTypes]: TIdiomaticSchema;
|
|
10
34
|
};
|
|
35
|
+
/**
|
|
36
|
+
* Represents an idiomatic schema which can be an unboxed object schema or a literal schema.
|
|
37
|
+
*/
|
|
11
38
|
export type TIdiomaticSchema = UnboxedTObjectSchema | LiteralSchema;
|
|
39
|
+
/**
|
|
40
|
+
* Represents a container for a union of idiomatic schemas.
|
|
41
|
+
*/
|
|
12
42
|
export type TUnionContainer = [...TIdiomaticSchema[]];
|
|
43
|
+
/**
|
|
44
|
+
* Resolves a union container to a tuple of resolved idiomatic schemas.
|
|
45
|
+
*
|
|
46
|
+
* @template T - The union container to resolve.
|
|
47
|
+
*/
|
|
13
48
|
export type UnionTResolve<T extends TUnionContainer> = T extends [
|
|
14
49
|
...infer A extends TIdiomaticSchema[]
|
|
15
50
|
] ? [
|
|
@@ -17,6 +52,12 @@ export type UnionTResolve<T extends TUnionContainer> = T extends [
|
|
|
17
52
|
[K in keyof A]: TResolve<A[K]>;
|
|
18
53
|
}
|
|
19
54
|
] : [];
|
|
55
|
+
/**
|
|
56
|
+
* Resolves a schema type T to its resolved type. The depth is limited to 22 to prevent infinite recursion.
|
|
57
|
+
*
|
|
58
|
+
* @template T - The schema type to resolve.
|
|
59
|
+
* @template Depth - The current depth of the resolution.
|
|
60
|
+
*/
|
|
20
61
|
export type TResolve<T, Depth extends number = 0> = Depth extends 22 ? TAny : T extends TKind ? T : T extends LiteralSchema ? TLiteral<T> : T extends UnboxedTObjectSchema ? TObject<{
|
|
21
62
|
[K in keyof T]: TResolve<T[K], Increment<Depth>>;
|
|
22
63
|
}> : TNever;
|
|
@@ -1,13 +1,48 @@
|
|
|
1
1
|
import { ZodArray, ZodObject as OriginalZodObject, ZodRawShape, ZodType, ZodTypeAny, z, ZodLiteral, ZodNever, ZodAny } from "zod";
|
|
2
2
|
import { IdiomaticSchema, UnboxedObjectSchema, LiteralSchema, Increment } from "./schema.types";
|
|
3
|
+
/**
|
|
4
|
+
* Represents a catch-all Zod schema type.
|
|
5
|
+
*/
|
|
3
6
|
export type ZodCatchall = ZodTypeAny;
|
|
7
|
+
/**
|
|
8
|
+
* Represents an outer array schema type for Zod. If the type T is a Zod object, it will return an array schema of T. Otherwise, it returns ZodNever.
|
|
9
|
+
*
|
|
10
|
+
* @template T - The type to check and possibly convert to an array schema.
|
|
11
|
+
*/
|
|
4
12
|
export type ZodOuterArray<T> = T extends ZodObject<ZodObjectShape> ? ZodArray<T> : ZodNever;
|
|
13
|
+
/**
|
|
14
|
+
* Represents the shape of a Zod object schema.
|
|
15
|
+
*/
|
|
5
16
|
export type ZodObjectShape = ZodRawShape;
|
|
17
|
+
/**
|
|
18
|
+
* Represents a Zod object schema type. If the type T is a Zod object shape, it will return the original ZodObject type of T. Otherwise, it returns ZodNever.
|
|
19
|
+
*
|
|
20
|
+
* @template T - The type to check and possibly convert to a Zod object schema.
|
|
21
|
+
*/
|
|
6
22
|
export type ZodObject<T> = T extends ZodObjectShape ? OriginalZodObject<T> : ZodNever;
|
|
23
|
+
/**
|
|
24
|
+
* Translates a Zod schema type T to its static type if T extends ZodCatchall. Otherwise, it returns ZodNever.
|
|
25
|
+
*
|
|
26
|
+
* @template T - The Zod schema type to translate.
|
|
27
|
+
*/
|
|
7
28
|
export type ZodSchemaTranslate<T> = T extends ZodCatchall ? z.infer<T> : ZodNever;
|
|
29
|
+
/**
|
|
30
|
+
* Represents an unboxed Zod object schema where each key can have an idiomatic schema.
|
|
31
|
+
*/
|
|
8
32
|
export type ZodObjectSchema = UnboxedObjectSchema<ZodCatchall>;
|
|
33
|
+
/**
|
|
34
|
+
* Represents an idiomatic schema for Zod which can be an unboxed object schema or a literal schema.
|
|
35
|
+
*/
|
|
9
36
|
export type ZodIdiomaticSchema = IdiomaticSchema<ZodCatchall>;
|
|
37
|
+
/**
|
|
38
|
+
* Represents a container for a union of Zod idiomatic schemas.
|
|
39
|
+
*/
|
|
10
40
|
export type ZodUnionContainer = readonly [ZodIdiomaticSchema, ZodIdiomaticSchema, ...ZodIdiomaticSchema[]];
|
|
41
|
+
/**
|
|
42
|
+
* Resolves a union container to a tuple of resolved Zod idiomatic schemas.
|
|
43
|
+
*
|
|
44
|
+
* @template T - The union container to resolve.
|
|
45
|
+
*/
|
|
11
46
|
export type UnionZodResolve<T extends ZodUnionContainer> = T extends [
|
|
12
47
|
infer A extends ZodIdiomaticSchema,
|
|
13
48
|
infer B extends ZodIdiomaticSchema,
|
|
@@ -19,6 +54,12 @@ export type UnionZodResolve<T extends ZodUnionContainer> = T extends [
|
|
|
19
54
|
[K in keyof C]: ZodResolve<C[K]>;
|
|
20
55
|
}
|
|
21
56
|
] : [ZodNever, ZodNever];
|
|
57
|
+
/**
|
|
58
|
+
* Resolves a Zod schema type T to its resolved type. The depth is limited to 22 to prevent infinite recursion.
|
|
59
|
+
*
|
|
60
|
+
* @template T - The Zod schema type to resolve.
|
|
61
|
+
* @template Depth - The current depth of the resolution.
|
|
62
|
+
*/
|
|
22
63
|
export type ZodResolve<T, Depth extends number = 0> = Depth extends 22 ? ZodAny : T extends LiteralSchema ? ZodLiteral<T> : T extends ZodType | ZodObject<any> ? T : T extends ZodObjectSchema ? ZodObject<{
|
|
23
64
|
[K in keyof T]: ZodResolve<T[K], Increment<Depth>>;
|
|
24
65
|
}> : ZodNever;
|
package/dist/zod.d.ts
CHANGED
|
@@ -2,18 +2,18 @@
|
|
|
2
2
|
* This module provides a Zod-based schema definition.
|
|
3
3
|
* It includes various types, schema creation, validation, and OpenAPI integration.
|
|
4
4
|
*
|
|
5
|
-
* @module
|
|
5
|
+
* @module ZodSchemaProvider
|
|
6
6
|
*/
|
|
7
7
|
import { ZodArray, ZodOptional, ZodUnion, z, ZodLiteral } from "zod";
|
|
8
8
|
import { LiteralSchema } from "./types/schema.types";
|
|
9
|
-
import {
|
|
9
|
+
import { SchemaProvider } from "./interfaces/schemaProvider.interfaces";
|
|
10
10
|
import { SchemaObject } from 'openapi3-ts/oas31';
|
|
11
11
|
import { ZodUnionContainer, ZodIdiomaticSchema, ZodCatchall, ZodResolve, UnionZodResolve } from "./types/zod.schema.types";
|
|
12
12
|
/**
|
|
13
13
|
* Class representing a Zod schema definition.
|
|
14
|
-
* @implements {
|
|
14
|
+
* @implements {SchemaProvider}
|
|
15
15
|
*/
|
|
16
|
-
export declare class
|
|
16
|
+
export declare class ZodSchemaProvider implements SchemaProvider<ZodUnionContainer, ZodIdiomaticSchema, ZodCatchall> {
|
|
17
17
|
string: z.ZodString;
|
|
18
18
|
number: z.ZodNumber;
|
|
19
19
|
bigint: z.ZodBigInt;
|
|
@@ -69,77 +69,77 @@ export declare class ZodSchemaDefinition implements SchemaDefinition<ZodUnionCon
|
|
|
69
69
|
openapi<T extends ZodIdiomaticSchema>(schema: T): SchemaObject;
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
|
-
* Factory function for creating a
|
|
73
|
-
* @returns {
|
|
72
|
+
* Factory function for creating a ZodSchemaProvider instance.
|
|
73
|
+
* @returns {ZodSchemaProvider} The ZodSchemaProvider instance.
|
|
74
74
|
*/
|
|
75
|
-
export declare const ZodSchema: () =>
|
|
76
|
-
declare const
|
|
75
|
+
export declare const ZodSchema: () => ZodSchemaProvider;
|
|
76
|
+
declare const SchemaProvider: ZodSchemaProvider;
|
|
77
77
|
/**
|
|
78
78
|
* Zod schema definition for string type.
|
|
79
79
|
*/
|
|
80
|
-
export declare const string: typeof
|
|
80
|
+
export declare const string: typeof SchemaProvider.string;
|
|
81
81
|
/**
|
|
82
82
|
* Zod schema definition for number type.
|
|
83
83
|
*/
|
|
84
|
-
export declare const number: typeof
|
|
84
|
+
export declare const number: typeof SchemaProvider.number;
|
|
85
85
|
/**
|
|
86
86
|
* Zod schema definition for bigint type.
|
|
87
87
|
*/
|
|
88
|
-
export declare const bigint: typeof
|
|
88
|
+
export declare const bigint: typeof SchemaProvider.bigint;
|
|
89
89
|
/**
|
|
90
90
|
* Zod schema definition for boolean type.
|
|
91
91
|
*/
|
|
92
|
-
export declare const boolean: typeof
|
|
92
|
+
export declare const boolean: typeof SchemaProvider.boolean;
|
|
93
93
|
/**
|
|
94
94
|
* Zod schema definition for date type.
|
|
95
95
|
*/
|
|
96
|
-
export declare const date: typeof
|
|
96
|
+
export declare const date: typeof SchemaProvider.date;
|
|
97
97
|
/**
|
|
98
98
|
* Zod schema definition for symbol type.
|
|
99
99
|
*/
|
|
100
|
-
export declare const symbol: typeof
|
|
100
|
+
export declare const symbol: typeof SchemaProvider.symbol;
|
|
101
101
|
/**
|
|
102
102
|
* Zod schema definition for undefined, null, void types.
|
|
103
103
|
*/
|
|
104
|
-
export declare const empty: typeof
|
|
104
|
+
export declare const empty: typeof SchemaProvider.empty;
|
|
105
105
|
/**
|
|
106
106
|
* Zod schema definition for any type.
|
|
107
107
|
*/
|
|
108
|
-
export declare const any: typeof
|
|
108
|
+
export declare const any: typeof SchemaProvider.any;
|
|
109
109
|
/**
|
|
110
110
|
* Zod schema definition for unknown type.
|
|
111
111
|
*/
|
|
112
|
-
export declare const unknown: typeof
|
|
112
|
+
export declare const unknown: typeof SchemaProvider.unknown;
|
|
113
113
|
/**
|
|
114
114
|
* Zod schema definition for never type.
|
|
115
115
|
*/
|
|
116
|
-
export declare const never: typeof
|
|
116
|
+
export declare const never: typeof SchemaProvider.never;
|
|
117
117
|
/**
|
|
118
118
|
* Transforms valid schema into Zod schema.
|
|
119
119
|
*/
|
|
120
|
-
export declare const schemify: typeof
|
|
120
|
+
export declare const schemify: typeof SchemaProvider.schemify;
|
|
121
121
|
/**
|
|
122
122
|
* Makes a valid schema optional.
|
|
123
123
|
*/
|
|
124
|
-
export declare const optional: typeof
|
|
124
|
+
export declare const optional: typeof SchemaProvider.optional;
|
|
125
125
|
/**
|
|
126
126
|
* Defines an array for a valid schema.
|
|
127
127
|
*/
|
|
128
|
-
export declare const array: typeof
|
|
128
|
+
export declare const array: typeof SchemaProvider.array;
|
|
129
129
|
/**
|
|
130
130
|
* Defines a union for a valid schema.
|
|
131
131
|
*/
|
|
132
|
-
export declare const union: typeof
|
|
132
|
+
export declare const union: typeof SchemaProvider.union;
|
|
133
133
|
/**
|
|
134
134
|
* Defines a literal for a valid schema.
|
|
135
135
|
*/
|
|
136
|
-
export declare const literal: typeof
|
|
136
|
+
export declare const literal: typeof SchemaProvider.literal;
|
|
137
137
|
/**
|
|
138
138
|
* Validates a value against a valid schema.
|
|
139
139
|
*/
|
|
140
|
-
export declare const validate: typeof
|
|
140
|
+
export declare const validate: typeof SchemaProvider.validate;
|
|
141
141
|
/**
|
|
142
142
|
* Generates an OpenAPI schema object from a valid schema.
|
|
143
143
|
*/
|
|
144
|
-
export declare const openapi: typeof
|
|
144
|
+
export declare const openapi: typeof SchemaProvider.openapi;
|
|
145
145
|
export {};
|
package/dist/zod.js
CHANGED
|
@@ -3,17 +3,17 @@
|
|
|
3
3
|
* This module provides a Zod-based schema definition.
|
|
4
4
|
* It includes various types, schema creation, validation, and OpenAPI integration.
|
|
5
5
|
*
|
|
6
|
-
* @module
|
|
6
|
+
* @module ZodSchemaProvider
|
|
7
7
|
*/
|
|
8
8
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
-
exports.openapi = exports.validate = exports.literal = exports.union = exports.array = exports.optional = exports.schemify = exports.never = exports.unknown = exports.any = exports.empty = exports.symbol = exports.date = exports.boolean = exports.bigint = exports.number = exports.string = exports.ZodSchema = exports.
|
|
9
|
+
exports.openapi = exports.validate = exports.literal = exports.union = exports.array = exports.optional = exports.schemify = exports.never = exports.unknown = exports.any = exports.empty = exports.symbol = exports.date = exports.boolean = exports.bigint = exports.number = exports.string = exports.ZodSchema = exports.ZodSchemaProvider = void 0;
|
|
10
10
|
const zod_1 = require("zod");
|
|
11
11
|
const zod_openapi_1 = require("@anatine/zod-openapi");
|
|
12
12
|
/**
|
|
13
13
|
* Class representing a Zod schema definition.
|
|
14
|
-
* @implements {
|
|
14
|
+
* @implements {SchemaProvider}
|
|
15
15
|
*/
|
|
16
|
-
class
|
|
16
|
+
class ZodSchemaProvider {
|
|
17
17
|
string = zod_1.z.string();
|
|
18
18
|
number = zod_1.z.number();
|
|
19
19
|
bigint = zod_1.z.bigint();
|
|
@@ -113,80 +113,80 @@ class ZodSchemaDefinition {
|
|
|
113
113
|
return (0, zod_openapi_1.generateSchema)(this.schemify(schema));
|
|
114
114
|
}
|
|
115
115
|
}
|
|
116
|
-
exports.
|
|
116
|
+
exports.ZodSchemaProvider = ZodSchemaProvider;
|
|
117
117
|
/**
|
|
118
|
-
* Factory function for creating a
|
|
119
|
-
* @returns {
|
|
118
|
+
* Factory function for creating a ZodSchemaProvider instance.
|
|
119
|
+
* @returns {ZodSchemaProvider} The ZodSchemaProvider instance.
|
|
120
120
|
*/
|
|
121
|
-
const ZodSchema = () => new
|
|
121
|
+
const ZodSchema = () => new ZodSchemaProvider();
|
|
122
122
|
exports.ZodSchema = ZodSchema;
|
|
123
|
-
const
|
|
123
|
+
const SchemaProvider = (0, exports.ZodSchema)();
|
|
124
124
|
/**
|
|
125
125
|
* Zod schema definition for string type.
|
|
126
126
|
*/
|
|
127
|
-
exports.string =
|
|
127
|
+
exports.string = SchemaProvider.string;
|
|
128
128
|
/**
|
|
129
129
|
* Zod schema definition for number type.
|
|
130
130
|
*/
|
|
131
|
-
exports.number =
|
|
131
|
+
exports.number = SchemaProvider.number;
|
|
132
132
|
/**
|
|
133
133
|
* Zod schema definition for bigint type.
|
|
134
134
|
*/
|
|
135
|
-
exports.bigint =
|
|
135
|
+
exports.bigint = SchemaProvider.bigint;
|
|
136
136
|
/**
|
|
137
137
|
* Zod schema definition for boolean type.
|
|
138
138
|
*/
|
|
139
|
-
exports.boolean =
|
|
139
|
+
exports.boolean = SchemaProvider.boolean;
|
|
140
140
|
/**
|
|
141
141
|
* Zod schema definition for date type.
|
|
142
142
|
*/
|
|
143
|
-
exports.date =
|
|
143
|
+
exports.date = SchemaProvider.date;
|
|
144
144
|
/**
|
|
145
145
|
* Zod schema definition for symbol type.
|
|
146
146
|
*/
|
|
147
|
-
exports.symbol =
|
|
147
|
+
exports.symbol = SchemaProvider.symbol;
|
|
148
148
|
/**
|
|
149
149
|
* Zod schema definition for undefined, null, void types.
|
|
150
150
|
*/
|
|
151
|
-
exports.empty =
|
|
151
|
+
exports.empty = SchemaProvider.empty;
|
|
152
152
|
/**
|
|
153
153
|
* Zod schema definition for any type.
|
|
154
154
|
*/
|
|
155
|
-
exports.any =
|
|
155
|
+
exports.any = SchemaProvider.any;
|
|
156
156
|
/**
|
|
157
157
|
* Zod schema definition for unknown type.
|
|
158
158
|
*/
|
|
159
|
-
exports.unknown =
|
|
159
|
+
exports.unknown = SchemaProvider.unknown;
|
|
160
160
|
/**
|
|
161
161
|
* Zod schema definition for never type.
|
|
162
162
|
*/
|
|
163
|
-
exports.never =
|
|
163
|
+
exports.never = SchemaProvider.never;
|
|
164
164
|
/**
|
|
165
165
|
* Transforms valid schema into Zod schema.
|
|
166
166
|
*/
|
|
167
|
-
exports.schemify =
|
|
167
|
+
exports.schemify = SchemaProvider.schemify.bind(SchemaProvider);
|
|
168
168
|
/**
|
|
169
169
|
* Makes a valid schema optional.
|
|
170
170
|
*/
|
|
171
|
-
exports.optional =
|
|
171
|
+
exports.optional = SchemaProvider.optional.bind(SchemaProvider);
|
|
172
172
|
/**
|
|
173
173
|
* Defines an array for a valid schema.
|
|
174
174
|
*/
|
|
175
|
-
exports.array =
|
|
175
|
+
exports.array = SchemaProvider.array.bind(SchemaProvider);
|
|
176
176
|
/**
|
|
177
177
|
* Defines a union for a valid schema.
|
|
178
178
|
*/
|
|
179
|
-
exports.union =
|
|
179
|
+
exports.union = SchemaProvider.union.bind(SchemaProvider);
|
|
180
180
|
/**
|
|
181
181
|
* Defines a literal for a valid schema.
|
|
182
182
|
*/
|
|
183
|
-
exports.literal =
|
|
183
|
+
exports.literal = SchemaProvider.literal.bind(SchemaProvider);
|
|
184
184
|
/**
|
|
185
185
|
* Validates a value against a valid schema.
|
|
186
186
|
*/
|
|
187
|
-
exports.validate =
|
|
187
|
+
exports.validate = SchemaProvider.validate.bind(SchemaProvider);
|
|
188
188
|
/**
|
|
189
189
|
* Generates an OpenAPI schema object from a valid schema.
|
|
190
190
|
*/
|
|
191
|
-
exports.openapi =
|
|
191
|
+
exports.openapi = SchemaProvider.openapi.bind(SchemaProvider);
|
|
192
192
|
//# sourceMappingURL=zod.js.map
|
package/dist/zod.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"zod.js","sourceRoot":"","sources":["../zod.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,6BAA2F;AAG3F,sDAAsD;AAItD;;;GAGG;AACH,MAAa,
|
|
1
|
+
{"version":3,"file":"zod.js","sourceRoot":"","sources":["../zod.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,6BAA2F;AAG3F,sDAAsD;AAItD;;;GAGG;AACH,MAAa,iBAAiB;IAK1B,MAAM,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC;IACpB,MAAM,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC;IACpB,MAAM,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC;IACpB,OAAO,GAAG,OAAC,CAAC,OAAO,EAAE,CAAC;IACtB,IAAI,GAAG,OAAC,CAAC,IAAI,EAAE,CAAC;IAChB,MAAM,GAAG,OAAC,CAAC,MAAM,EAAE,CAAC;IACpB,KAAK,GAAG,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IACrD,GAAG,GAAG,OAAC,CAAC,GAAG,EAAE,CAAC;IACd,OAAO,GAAG,OAAC,CAAC,OAAO,EAAE,CAAC;IACtB,KAAK,GAAG,OAAC,CAAC,KAAK,EAAE,CAAC;IAElB;;;;OAIG;IACH,QAAQ,CAA+B,MAAS;QAC5C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE;YACzF,OAAO,OAAC,CAAC,OAAO,CAAC,MAAM,CAAkB,CAAC;SAC7C;QAED,IAAI,MAAM,YAAY,aAAO,EAAE;YAC3B,OAAO,MAAuB,CAAC;SAClC;QAED,MAAM,SAAS,GAAgB,EAAE,CAAC;QAClC,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC/C,IAAI,MAAM,CAAC,GAAG,CAAC,YAAY,aAAO,EAAE;gBAChC,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAuB,CAAC;aACtD;iBAAM;gBACH,SAAS,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;aAC/C;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,OAAC,CAAC,MAAM,CAAC,SAAS,CAAkB,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAA+B,MAAS;QAC5C,IAAI,MAAM,YAAY,aAAO,EAAE;YAC3B,OAAO,MAAM,CAAC,QAAQ,EAAgC,CAAC;SAC1D;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAgC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAA+B,MAAS;QACzC,IAAI,MAAM,YAAY,aAAO,EAAE;YAC3B,OAAO,MAAM,CAAC,KAAK,EAA6B,CAAC;SACpD;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAA6B,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAA8B,OAAU;QACzC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SAC3D;QAED,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACtC,IAAI,MAAM,YAAY,aAAO,EAAE;gBAC3B,OAAO,MAAM,CAAC;aACjB;YACD,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,OAAO,OAAC,CAAC,KAAK,CAAC,UAAyD,CAAiC,CAAC;IAC9G,CAAC;IAED;;;;OAIG;IACH,OAAO,CAA0B,KAAQ;QACrC,OAAO,OAAC,CAAC,OAAO,CAAC,KAAK,CAA8B,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAwB,MAAS,EAAE,KAAc;QACrD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,OAAO,CAA+B,MAAS;QAC3C,OAAO,IAAA,4BAAc,EAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IACjD,CAAC;CACJ;AAlHD,8CAkHC;AAED;;;GAGG;AACI,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,IAAI,iBAAiB,EAAE,CAAC;AAA1C,QAAA,SAAS,aAAiC;AAEvD,MAAM,cAAc,GAAG,IAAA,iBAAS,GAAE,CAAC;AAEnC;;GAEG;AACU,QAAA,MAAM,GAAiC,cAAc,CAAC,MAAM,CAAC;AAE1E;;GAEG;AACU,QAAA,MAAM,GAAiC,cAAc,CAAC,MAAM,CAAC;AAE1E;;GAEG;AACU,QAAA,MAAM,GAAiC,cAAc,CAAC,MAAM,CAAC;AAE1E;;GAEG;AACU,QAAA,OAAO,GAAkC,cAAc,CAAC,OAAO,CAAC;AAE7E;;GAEG;AACU,QAAA,IAAI,GAA+B,cAAc,CAAC,IAAI,CAAC;AAEpE;;GAEG;AACU,QAAA,MAAM,GAAiC,cAAc,CAAC,MAAM,CAAC;AAE1E;;GAEG;AACU,QAAA,KAAK,GAAgC,cAAc,CAAC,KAAK,CAAC;AAEvE;;GAEG;AACU,QAAA,GAAG,GAA8B,cAAc,CAAC,GAAG,CAAC;AAEjE;;GAEG;AACU,QAAA,OAAO,GAAkC,cAAc,CAAC,OAAO,CAAC;AAE7E;;GAEG;AACU,QAAA,KAAK,GAAgC,cAAc,CAAC,KAAK,CAAC;AAEvE;;GAEG;AACU,QAAA,QAAQ,GAAmC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAErG;;GAEG;AACU,QAAA,QAAQ,GAAmC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAErG;;GAEG;AACU,QAAA,KAAK,GAAgC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAE5F;;GAEG;AACU,QAAA,KAAK,GAAgC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAE5F;;GAEG;AACU,QAAA,OAAO,GAAkC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAElG;;GAEG;AACU,QAAA,QAAQ,GAAmC,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;AAErG;;GAEG;AACU,QAAA,OAAO,GAAkC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC"}
|
package/package.json
CHANGED
|
File without changes
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"equality.test.js","sourceRoot":"","sources":["../../tests/equality.test.ts"],"names":[],"mappings":""}
|
|
File without changes
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"largeSchema.test.js","sourceRoot":"","sources":["../../tests/largeSchema.test.ts"],"names":[],"mappings":""}
|