express-zod-api 9.0.0-beta2 → 9.0.0-beta4
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/CHANGELOG.md +94 -0
- package/README.md +10 -9
- package/dist/api-response.d.ts +15 -6
- package/dist/api-response.js +0 -9
- package/dist/api-response.js.map +1 -1
- package/dist/client-helpers.d.ts +0 -1
- package/dist/client-helpers.js +1 -10
- package/dist/client-helpers.js.map +1 -1
- package/dist/client.js +7 -6
- package/dist/client.js.map +1 -1
- package/dist/common-helpers.d.ts +2 -1
- package/dist/common-helpers.js +10 -1
- package/dist/common-helpers.js.map +1 -1
- package/dist/endpoint.d.ts +28 -25
- package/dist/endpoint.js +46 -26
- package/dist/endpoint.js.map +1 -1
- package/dist/endpoints-factory.d.ts +4 -5
- package/dist/endpoints-factory.js +0 -3
- package/dist/endpoints-factory.js.map +1 -1
- package/dist/index.d.ts +0 -1
- package/dist/index.js +1 -3
- package/dist/index.js.map +1 -1
- package/dist/io-schema.d.ts +1 -1
- package/dist/mime.d.ts +0 -1
- package/dist/mock.d.ts +2 -2
- package/dist/open-api-helpers.d.ts +2 -2
- package/dist/open-api-helpers.js +15 -15
- package/dist/open-api-helpers.js.map +1 -1
- package/dist/open-api.d.ts +3 -0
- package/dist/open-api.js +13 -2
- package/dist/open-api.js.map +1 -1
- package/dist/result-handler.d.ts +12 -8
- package/dist/result-handler.js +18 -18
- package/dist/result-handler.js.map +1 -1
- package/dist-esm/api-response.js +1 -7
- package/dist-esm/api-response.js.map +1 -1
- package/dist-esm/client-helpers.js +0 -8
- package/dist-esm/client-helpers.js.map +1 -1
- package/dist-esm/client.js +8 -7
- package/dist-esm/client.js.map +1 -1
- package/dist-esm/common-helpers.js +8 -0
- package/dist-esm/common-helpers.js.map +1 -1
- package/dist-esm/endpoint.js +48 -28
- package/dist-esm/endpoint.js.map +1 -1
- package/dist-esm/endpoints-factory.js +0 -3
- package/dist-esm/endpoints-factory.js.map +1 -1
- package/dist-esm/index.js +0 -1
- package/dist-esm/index.js.map +1 -1
- package/dist-esm/open-api-helpers.js +12 -12
- package/dist-esm/open-api-helpers.js.map +1 -1
- package/dist-esm/open-api.js +14 -3
- package/dist-esm/open-api.js.map +1 -1
- package/dist-esm/package.json +1 -1
- package/dist-esm/result-handler.js +17 -17
- package/dist-esm/result-handler.js.map +1 -1
- package/package.json +1 -1
package/dist-esm/open-api.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"open-api.js","sourceRoot":"","sources":["../src/open-api.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,GAIf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"open-api.js","sourceRoot":"","sources":["../src/open-api.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,GAIf,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,UAAU,EACV,sBAAsB,EACtB,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAuB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAgBpE,MAAM,OAAO,OAAQ,SAAQ,cAAc;IAK/B,qBAAqB,CAAC,IAAY,EAAE,MAAc;QAC1D,MAAM,WAAW,GAAG,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,IAAI,WAAW,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAC/C,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,OAAO,GAAG,WAAW,GAAG,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;SACrE;QACD,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,WAAW,CAAC;IACrB,CAAC;IAES,4BAA4B,CAAC,OAA6B;QAClE,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,eAAe,IAAI,EAAE,EAAE;YACjE,IACE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;gBACvB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,CAAC,IAAI,CAAC,CAAC,EAChE;gBACA,OAAO,IAAI,CAAC;aACb;SACF;QACD,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,CAAC;YACtC,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACxD,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,IAClC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,CACzC,EAAE,CAAC;IACL,CAAC;IAED,YAAmB,EACjB,OAAO,EACP,MAAM,EACN,KAAK,EACL,OAAO,EACP,SAAS,EACT,6BAA6B,GAAG,qBAAqB,EACrD,wBAAwB,GAAG,gBAAgB,EAC3C,yBAAyB,GAAG,IAAI,GAChB;QAChB,KAAK,EAAE,CAAC;QAxCA,0BAAqB,GAC7B,EAAE,CAAC;QACK,4BAAuB,GAA2B,EAAE,CAAC;QAuC7D,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;QAC/D,MAAM,UAAU,GAAsC,CACpD,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,EAAE;YACF,MAAM,MAAM,GAAG,OAAiB,CAAC;YACjC,MAAM,YAAY,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;YAChD,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAI,CAAC,OAAO,EAAE,MAAM,CAAW,CAAC,GAAG,CAC5D,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CACvC,CAAC;YACF,MAAM,YAAY,GAChB,MAAM,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;YAC/D,MAAM,cAAc,GAAG,mBAAmB,CAAC;gBACzC,GAAG,YAAY;gBACf,YAAY;aACb,CAAC,CAAC;YACH,MAAM,SAAS,GAAoB;gBACjC,WAAW,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC;gBACrD,SAAS,EAAE;oBACT,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC;wBACnD,GAAG,YAAY;wBACf,WAAW,EAAE,6BAA6B;wBAC1C,UAAU,EAAE,IAAI;qBACjB,CAAC;oBACF,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,cAAc,CAAC;wBACnD,GAAG,YAAY;wBACf,WAAW,EAAE,wBAAwB;wBACrC,UAAU,EAAE,KAAK;qBAClB,CAAC;iBACH;aACF,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,SAAS,CAAC,WAAW,GAAG,QAAQ,CAAC;gBACjC,IAAI,yBAAyB,IAAI,SAAS,KAAK,SAAS,EAAE;oBACxD,SAAS,CAAC,OAAO,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;iBACtD;aACF;YACD,IAAI,SAAS,EAAE;gBACb,SAAS,CAAC,OAAO,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;aACvD;YACD,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;gBACjC,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;aACrC;YACD,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC7B,SAAS,CAAC,UAAU,GAAG,cAAc,CAAC;aACvC;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACjC,SAAS,CAAC,WAAW,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC;aACrD;YACD,MAAM,YAAY,GAAG,kBAAkB,CACrC,mBAAmB,CACjB,cAAc,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,EACtC,CAAC,cAAc,EAAE,EAAE;gBACjB,MAAM,IAAI,GAAG,IAAI,CAAC,4BAA4B,CAAC,cAAc,CAAC,CAAC;gBAC/D,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,QAAQ,CACjD,cAAc,CAAC,IAAI,CACpB;oBACC,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE;oBACtB,CAAC,CAAC,EAAE,CAAC;gBACP,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;gBAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAC1B,CAAC,CACF,CACF,CAAC;YACF,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC3B,SAAS,CAAC,QAAQ,GAAG,YAAY,CAAC;aACnC;YACD,MAAM,qBAAqB,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;YACzD,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE;gBAClC,CAAC,MAAM,CAAC,EAAE,SAAS;aACpB,CAAC,CAAC;QACL,CAAC,CAAC;QACF,WAAW,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACrC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,CAAC;CACF"}
|
package/dist-esm/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"type":"module","version":"9.0.0-
|
|
1
|
+
{"type":"module","version":"9.0.0-beta4"}
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
|
-
import { createApiResponse } from "./api-response.js";
|
|
3
2
|
import { getMessageFromError, getStatusCodeFromError } from "./common-helpers.js";
|
|
4
3
|
import { getMeta, withMeta } from "./metadata.js";
|
|
4
|
+
export const defaultStatusCodes = {
|
|
5
|
+
positive: 200,
|
|
6
|
+
negative: 400,
|
|
7
|
+
};
|
|
5
8
|
export const createResultHandler = (definition) => definition;
|
|
6
9
|
export const defaultResultHandler = createResultHandler({
|
|
7
10
|
getPositiveResponse: (output) => {
|
|
@@ -17,25 +20,22 @@ export const defaultResultHandler = createResultHandler({
|
|
|
17
20
|
data: example,
|
|
18
21
|
});
|
|
19
22
|
}
|
|
20
|
-
return
|
|
21
|
-
},
|
|
22
|
-
getNegativeResponse: () => {
|
|
23
|
-
const responseSchema = withMeta(z.object({
|
|
24
|
-
status: z.literal("error"),
|
|
25
|
-
error: z.object({
|
|
26
|
-
message: z.string(),
|
|
27
|
-
}),
|
|
28
|
-
})).example({
|
|
29
|
-
status: "error",
|
|
30
|
-
error: {
|
|
31
|
-
message: getMessageFromError(new Error("Sample error message")),
|
|
32
|
-
},
|
|
33
|
-
});
|
|
34
|
-
return createApiResponse(responseSchema);
|
|
23
|
+
return responseSchema;
|
|
35
24
|
},
|
|
25
|
+
getNegativeResponse: () => withMeta(z.object({
|
|
26
|
+
status: z.literal("error"),
|
|
27
|
+
error: z.object({
|
|
28
|
+
message: z.string(),
|
|
29
|
+
}),
|
|
30
|
+
})).example({
|
|
31
|
+
status: "error",
|
|
32
|
+
error: {
|
|
33
|
+
message: getMessageFromError(new Error("Sample error message")),
|
|
34
|
+
},
|
|
35
|
+
}),
|
|
36
36
|
handler: ({ error, input, output, request, response, logger }) => {
|
|
37
37
|
if (!error) {
|
|
38
|
-
response.status(
|
|
38
|
+
response.status(defaultStatusCodes.positive).json({
|
|
39
39
|
status: "success",
|
|
40
40
|
data: output,
|
|
41
41
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"result-handler.js","sourceRoot":"","sources":["../src/result-handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;
|
|
1
|
+
{"version":3,"file":"result-handler.js","sourceRoot":"","sources":["../src/result-handler.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAE/E,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AA8B/C,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,QAAQ,EAAE,GAAG;IACb,QAAQ,EAAE,GAAG;CACd,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAIjC,UAA6C,EAC7C,EAAE,CAAC,UAAU,CAAC;AAEhB,MAAM,CAAC,MAAM,oBAAoB,GAAG,mBAAmB,CAAC;IACtD,mBAAmB,EAAE,CAAC,MAAgB,EAAE,EAAE;QACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC;QACnD,MAAM,cAAc,GAAG,QAAQ,CAC7B,CAAC,CAAC,MAAM,CAAC;YACP,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;YAC5B,IAAI,EAAE,MAAM;SACb,CAAC,CACH,CAAC;QACF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,gDAAgD;YAChD,cAAc,CAAC,OAAO,CAAC;gBACrB,MAAM,EAAE,SAAS;gBACjB,IAAI,EAAE,OAAO;aACd,CAAC,CAAC;SACJ;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,mBAAmB,EAAE,GAAG,EAAE,CACxB,QAAQ,CACN,CAAC,CAAC,MAAM,CAAC;QACP,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC;YACd,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;SACpB,CAAC;KACH,CAAC,CACH,CAAC,OAAO,CAAC;QACR,MAAM,EAAE,OAAO;QACf,KAAK,EAAE;YACL,OAAO,EAAE,mBAAmB,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SAChE;KACF,CAAC;IACJ,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE;QAC/D,IAAI,CAAC,KAAK,EAAE;YACV,QAAQ,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;gBAChD,MAAM,EAAE,SAAkB;gBAC1B,IAAI,EAAE,MAAM;aACb,CAAC,CAAC;YACH,OAAO;SACR;QACD,MAAM,UAAU,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,UAAU,KAAK,GAAG,EAAE;YACtB,MAAM,CAAC,KAAK,CAAC,0BAA0B,KAAK,CAAC,KAAK,IAAI,EAAE;gBACtD,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,OAAO,EAAE,KAAK;aACf,CAAC,CAAC;SACJ;QACD,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC;YAC/B,MAAM,EAAE,OAAgB;YACxB,KAAK,EAAE,EAAE,OAAO,EAAE,mBAAmB,CAAC,KAAK,CAAC,EAAE;SAC/C,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,EAChC,KAAK,EACL,MAAM,EACN,QAAQ,GACgB,EAAE,EAAE;IAC5B,MAAM,CAAC,KAAK,CAAC,2BAA2B,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC;IAC1D,QAAQ;SACL,MAAM,CAAC,GAAG,CAAC;SACX,GAAG,CACF,+CAA+C,KAAK,CAAC,OAAO,GAAG;QAC7D,CAAC,KAAK,CAAC,aAAa;YAClB,CAAC,CAAC,qBAAqB,KAAK,CAAC,aAAa,CAAC,OAAO,GAAG;YACrD,CAAC,CAAC,EAAE,CAAC,CACV,CAAC;AACN,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "express-zod-api",
|
|
3
|
-
"version": "9.0.0-
|
|
3
|
+
"version": "9.0.0-beta4",
|
|
4
4
|
"description": "A Typescript library to help you get an API server up and running with I/O schema validation and custom middlewares in minutes.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"scripts": {
|