express-fast-json-stringify 1.1.2

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 ADDED
@@ -0,0 +1,19 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
+
5
+ ### [1.1.2](https://github.com/nigrosimone/express-fast-json-stringify/compare/v1.1.0...v1.1.2) (2024-09-29)
6
+
7
+ ## 1.1.0 (2024-09-29)
8
+
9
+
10
+ ### Features
11
+
12
+ * first commit ([5e3cc3e](https://github.com/nigrosimone/express-fast-json-stringify/commit/5e3cc3e46fc0d35c07299697d1133636d21bee9b))
13
+ * npmignore ([364b397](https://github.com/nigrosimone/express-fast-json-stringify/commit/364b397ec15c14846c427c8c395b756aec839174))
14
+ * vscode ([f962e81](https://github.com/nigrosimone/express-fast-json-stringify/commit/f962e8145aeaa517c8b80dc642f5bca6139dff4d))
15
+
16
+
17
+ ### Bug Fixes
18
+
19
+ * ignore publish ([ca95f45](https://github.com/nigrosimone/express-fast-json-stringify/commit/ca95f450e1ce22f957fff4cd9f7520386ee70962))
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2019 Nigro Simone
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,138 @@
1
+ # express-fast-json-stringify
2
+
3
+ One of the reasons why [Fastify](https://www.npmjs.com/package/fastify) is faster than Express is its use of [fast-json-stringify](https://www.npmjs.com/package/fast-json-stringify). `fast-json-stringify` is a library developed by the Fastify team that boosts JSON conversion speed by analyzing JSON schema definitions.
4
+
5
+ By using the `fast-json-stringify` library, Fastify can serialize JSON much faster than Express, contributing to its overall performance advantage.
6
+
7
+ With `express-fast-json-stringify`, you can leverage `fast-json-stringify` in your Express application as follows:
8
+
9
+ ```ts
10
+ import express from 'express';
11
+ import { fastJsonSchema, Schema } from 'express-fast-json-stringify';
12
+
13
+ const schema: Schema = {
14
+ title: 'Example Schema',
15
+ type: 'object',
16
+ properties: {
17
+ firstName: {
18
+ type: 'string',
19
+ },
20
+ lastName: {
21
+ type: 'string',
22
+ },
23
+ age: {
24
+ description: 'Age in years',
25
+ type: 'integer',
26
+ },
27
+ },
28
+ };
29
+
30
+ const app = express();
31
+
32
+ app.get('/', fastJsonSchema(schema), (req, res, next) => {
33
+ try {
34
+ const data = {
35
+ firstName: 'Simone',
36
+ lastName: 'Nigro',
37
+ age: 40,
38
+ };
39
+ res.fastJson(data);
40
+ } catch (error) {
41
+ next(error);
42
+ }
43
+ });
44
+ ```
45
+
46
+ ## How to Use
47
+
48
+ 1. Install the package:
49
+
50
+ ```
51
+ npm install express-fast-json-stringify
52
+ ```
53
+
54
+ 2. Create a schema object that defines the structure of your JSON response, eg.:
55
+
56
+ ```ts
57
+ import { Schema } from 'express-fast-json-stringify';
58
+
59
+ const schema: Schema = {
60
+ title: 'Example Schema',
61
+ type: 'object',
62
+ properties: {
63
+ firstName: {
64
+ type: 'string',
65
+ },
66
+ lastName: {
67
+ type: 'string',
68
+ },
69
+ age: {
70
+ description: 'Age in years',
71
+ type: 'integer',
72
+ },
73
+ },
74
+ };
75
+ ```
76
+
77
+ 3. UApply the `fastJsonSchema` middleware to your Express route, passing in the schema object, eg.:
78
+
79
+ ```ts
80
+ import { fastJsonSchema, Schema } from 'express-fast-json-stringify';
81
+
82
+ const schema: Schema = {
83
+ title: 'Example Schema',
84
+ type: 'object',
85
+ properties: {
86
+ firstName: {
87
+ type: 'string',
88
+ },
89
+ lastName: {
90
+ type: 'string',
91
+ },
92
+ age: {
93
+ description: 'Age in years',
94
+ type: 'integer',
95
+ },
96
+ },
97
+ };
98
+
99
+ app.get('/', fastJsonSchema(schema), (req, res, next) => {});
100
+ ```
101
+
102
+ 4. Send JSON Response: Use `res.fastJson()` to send your JSON response, leveraging the speed benefits of `fast-json-stringify`, eg.:
103
+
104
+ ```ts
105
+ import { fastJsonSchema, Schema } from 'express-fast-json-stringify';
106
+
107
+ const schema: Schema = {
108
+ title: 'Example Schema',
109
+ type: 'object',
110
+ properties: {
111
+ firstName: {
112
+ type: 'string',
113
+ },
114
+ lastName: {
115
+ type: 'string',
116
+ },
117
+ age: {
118
+ description: 'Age in years',
119
+ type: 'integer',
120
+ },
121
+ },
122
+ };
123
+
124
+ app.get('/', fastJsonSchema(schema), (req, res, next) => {
125
+ try {
126
+ const data = {
127
+ firstName: 'Simone',
128
+ lastName: 'Nigro',
129
+ age: 40,
130
+ };
131
+ res.fastJson(data);
132
+ } catch (error) {
133
+ next(error);
134
+ }
135
+ });
136
+ ```
137
+
138
+ By following these steps, you can enhance the performance of your Express applications with faster JSON serialization.
@@ -0,0 +1 @@
1
+ export * from './lib/middleware';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./lib/middleware"), exports);
18
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLG1EQUFpQyJ9
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,66 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const ava_1 = __importDefault(require("ava"));
7
+ const express_1 = __importDefault(require("express"));
8
+ const supertest_1 = __importDefault(require("supertest"));
9
+ const _1 = require("./");
10
+ const data = {
11
+ firstName: 'Simone',
12
+ lastName: 'Nigro',
13
+ age: 40,
14
+ };
15
+ const schema = {
16
+ title: 'Example Schema',
17
+ type: 'object',
18
+ properties: {
19
+ firstName: {
20
+ type: 'string',
21
+ },
22
+ lastName: {
23
+ type: 'string',
24
+ },
25
+ age: {
26
+ description: 'Age in years',
27
+ type: 'integer',
28
+ },
29
+ },
30
+ };
31
+ const app = (0, express_1.default)();
32
+ app.use(express_1.default.json());
33
+ app.post('/with-schema', (0, _1.fastJsonSchema)(schema), (req, res, next) => {
34
+ try {
35
+ res.fastJson(req.body.data);
36
+ }
37
+ catch (error) {
38
+ next(error);
39
+ }
40
+ });
41
+ app.post('/without-schema', (req, res, next) => {
42
+ try {
43
+ res.fastJson(req.body.data);
44
+ }
45
+ catch (error) {
46
+ next(error);
47
+ }
48
+ });
49
+ app.use((err, _req, res, _next) => {
50
+ res.status(500).json({ error: err.message });
51
+ });
52
+ (0, ava_1.default)('with schema', async (t) => {
53
+ t.plan(3);
54
+ const res = await (0, supertest_1.default)(app).post('/with-schema').send({ data });
55
+ t.like(res.body, data);
56
+ t.is(res.ok, true);
57
+ t.is(res.type, 'application/json');
58
+ });
59
+ (0, ava_1.default)('without schema', async (t) => {
60
+ t.plan(3);
61
+ const res = await (0, supertest_1.default)(app).post('/without-schema').send({ data });
62
+ t.like(res.body, { error: `res.fastJson is not a function` });
63
+ t.is(res.ok, false);
64
+ t.is(res.type, 'application/json');
65
+ });
66
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguc3BlYy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbmRleC5zcGVjLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsOENBQXVCO0FBQ3ZCLHNEQUFtRTtBQUNuRSwwREFBZ0M7QUFFaEMseUJBQTRDO0FBRTVDLE1BQU0sSUFBSSxHQUFHO0lBQ1gsU0FBUyxFQUFFLFFBQVE7SUFDbkIsUUFBUSxFQUFFLE9BQU87SUFDakIsR0FBRyxFQUFFLEVBQUU7Q0FDUixDQUFDO0FBRUYsTUFBTSxNQUFNLEdBQVc7SUFDckIsS0FBSyxFQUFFLGdCQUFnQjtJQUN2QixJQUFJLEVBQUUsUUFBUTtJQUNkLFVBQVUsRUFBRTtRQUNWLFNBQVMsRUFBRTtZQUNULElBQUksRUFBRSxRQUFRO1NBQ2Y7UUFDRCxRQUFRLEVBQUU7WUFDUixJQUFJLEVBQUUsUUFBUTtTQUNmO1FBQ0QsR0FBRyxFQUFFO1lBQ0gsV0FBVyxFQUFFLGNBQWM7WUFDM0IsSUFBSSxFQUFFLFNBQVM7U0FDaEI7S0FDRjtDQUNGLENBQUM7QUFFRixNQUFNLEdBQUcsR0FBRyxJQUFBLGlCQUFPLEdBQUUsQ0FBQztBQUV0QixHQUFHLENBQUMsR0FBRyxDQUFDLGlCQUFPLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQztBQUV4QixHQUFHLENBQUMsSUFBSSxDQUFDLGNBQWMsRUFBRSxJQUFBLGlCQUFjLEVBQUMsTUFBTSxDQUFDLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxFQUFFO0lBQ2xFLElBQUk7UUFDRixHQUFHLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7S0FDN0I7SUFBQyxPQUFPLEtBQUssRUFBRTtRQUNkLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQztLQUNiO0FBQ0gsQ0FBQyxDQUFDLENBQUM7QUFFSCxHQUFHLENBQUMsSUFBSSxDQUFDLGlCQUFpQixFQUFFLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxJQUFJLEVBQUUsRUFBRTtJQUM3QyxJQUFJO1FBQ0YsR0FBRyxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO0tBQzdCO0lBQUMsT0FBTyxLQUFLLEVBQUU7UUFDZCxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7S0FDYjtBQUNILENBQUMsQ0FBQyxDQUFDO0FBRUgsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDLEdBQVEsRUFBRSxJQUFhLEVBQUUsR0FBYSxFQUFFLEtBQW1CLEVBQUUsRUFBRTtJQUN0RSxHQUFHLENBQUMsTUFBTSxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxFQUFFLEtBQUssRUFBRSxHQUFHLENBQUMsT0FBTyxFQUFFLENBQUMsQ0FBQztBQUMvQyxDQUFDLENBQUMsQ0FBQztBQUVILElBQUEsYUFBSSxFQUFDLGFBQWEsRUFBRSxLQUFLLEVBQUUsQ0FBQyxFQUFFLEVBQUU7SUFDOUIsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUVWLE1BQU0sR0FBRyxHQUFHLE1BQU0sSUFBQSxtQkFBTyxFQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQyxJQUFJLENBQUMsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBRW5FLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztJQUN2QixDQUFDLENBQUMsRUFBRSxDQUFDLEdBQUcsQ0FBQyxFQUFFLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDbkIsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLGtCQUFrQixDQUFDLENBQUM7QUFDckMsQ0FBQyxDQUFDLENBQUM7QUFFSCxJQUFBLGFBQUksRUFBQyxnQkFBZ0IsRUFBRSxLQUFLLEVBQUUsQ0FBQyxFQUFFLEVBQUU7SUFDakMsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUVWLE1BQU0sR0FBRyxHQUFHLE1BQU0sSUFBQSxtQkFBTyxFQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxpQkFBaUIsQ0FBQyxDQUFDLElBQUksQ0FBQyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7SUFFdEUsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLEVBQUUsS0FBSyxFQUFFLGdDQUFnQyxFQUFFLENBQUMsQ0FBQztJQUM5RCxDQUFDLENBQUMsRUFBRSxDQUFDLEdBQUcsQ0FBQyxFQUFFLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDcEIsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLGtCQUFrQixDQUFDLENBQUM7QUFDckMsQ0FBQyxDQUFDLENBQUMifQ==
@@ -0,0 +1,45 @@
1
+ import type { NextFunction, Request, Response } from 'express';
2
+ import { Schema } from 'fast-json-stringify';
3
+ export type { Schema } from 'fast-json-stringify';
4
+ /**
5
+ * Set the schema
6
+ * @param {Schema} schema
7
+ *
8
+ * Examples:
9
+ * ```ts
10
+ * import express from 'express';
11
+ * import { fastJsonSchemas, Schema } from 'express-fast-json-stringify';
12
+ *
13
+ * const app = express();
14
+ *
15
+ * const schema: Schema = {
16
+ * title: 'Example Schema',
17
+ * type: 'object',
18
+ * properties: {
19
+ * firstName: {
20
+ * type: 'string',
21
+ * },
22
+ * lastName: {
23
+ * type: 'string',
24
+ * },
25
+ * age: {
26
+ * type: 'integer',
27
+ * }
28
+ * },
29
+ * };
30
+ *
31
+ * app.get('/', fastJsonSchema(schema), (req, res, next) => {
32
+ * try {
33
+ * const data = {
34
+ * firstName: "Simone",
35
+ * lastName: "Nigro",
36
+ * age: 40
37
+ * };
38
+ * res.fastJson(data);
39
+ * } catch (error) {
40
+ * next(error);
41
+ * }
42
+ * });
43
+ * ```
44
+ */
45
+ export declare const fastJsonSchema: (schema: Schema) => (_req: Request, res: Response, next: NextFunction) => void;
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.fastJsonSchema = void 0;
7
+ const fast_json_stringify_1 = __importDefault(require("fast-json-stringify"));
8
+ /**
9
+ * Set the schema
10
+ * @param {Schema} schema
11
+ *
12
+ * Examples:
13
+ * ```ts
14
+ * import express from 'express';
15
+ * import { fastJsonSchemas, Schema } from 'express-fast-json-stringify';
16
+ *
17
+ * const app = express();
18
+ *
19
+ * const schema: Schema = {
20
+ * title: 'Example Schema',
21
+ * type: 'object',
22
+ * properties: {
23
+ * firstName: {
24
+ * type: 'string',
25
+ * },
26
+ * lastName: {
27
+ * type: 'string',
28
+ * },
29
+ * age: {
30
+ * type: 'integer',
31
+ * }
32
+ * },
33
+ * };
34
+ *
35
+ * app.get('/', fastJsonSchema(schema), (req, res, next) => {
36
+ * try {
37
+ * const data = {
38
+ * firstName: "Simone",
39
+ * lastName: "Nigro",
40
+ * age: 40
41
+ * };
42
+ * res.fastJson(data);
43
+ * } catch (error) {
44
+ * next(error);
45
+ * }
46
+ * });
47
+ * ```
48
+ */
49
+ const fastJsonSchema = (schema) => {
50
+ if (!schema) {
51
+ throw new TypeError(`express-fast-json-stringify: invalid schema`);
52
+ }
53
+ const fjs = (0, fast_json_stringify_1.default)(schema);
54
+ return (_req, res, next) => {
55
+ /**
56
+ * Send JSON response.
57
+ *
58
+ * Examples:
59
+ * ```ts
60
+ * res.fastJson({ user: 'tj' });
61
+ * res.status(200).fastJson({ user: 'tj' });
62
+ * ```
63
+ */
64
+ res.fastJson = (data) => {
65
+ if (!res.getHeader('Content-Type')) {
66
+ res.setHeader('Content-Type', 'application/json');
67
+ }
68
+ return res.send(fjs(data));
69
+ };
70
+ next();
71
+ };
72
+ };
73
+ exports.fastJsonSchema = fastJsonSchema;
74
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvbWlkZGxld2FyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7QUFDQSw4RUFBdUQ7QUFJdkQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0F3Q0c7QUFDSSxNQUFNLGNBQWMsR0FBRyxDQUFDLE1BQWMsRUFBRSxFQUFFO0lBQy9DLElBQUksQ0FBQyxNQUFNLEVBQUU7UUFDWCxNQUFNLElBQUksU0FBUyxDQUFDLDZDQUE2QyxDQUFDLENBQUM7S0FDcEU7SUFDRCxNQUFNLEdBQUcsR0FBRyxJQUFBLDZCQUFRLEVBQUMsTUFBTSxDQUFDLENBQUM7SUFDN0IsT0FBTyxDQUFDLElBQWEsRUFBRSxHQUFhLEVBQUUsSUFBa0IsRUFBRSxFQUFFO1FBQzFEOzs7Ozs7OztXQVFHO1FBQ0gsR0FBRyxDQUFDLFFBQVEsR0FBRyxDQUFDLElBQVMsRUFBWSxFQUFFO1lBQ3JDLElBQUksQ0FBQyxHQUFHLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxFQUFFO2dCQUNsQyxHQUFHLENBQUMsU0FBUyxDQUFDLGNBQWMsRUFBRSxrQkFBa0IsQ0FBQyxDQUFDO2FBQ25EO1lBQ0QsT0FBTyxHQUFHLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1FBQzdCLENBQUMsQ0FBQztRQUNGLElBQUksRUFBRSxDQUFDO0lBQ1QsQ0FBQyxDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBdkJXLFFBQUEsY0FBYyxrQkF1QnpCIn0=
@@ -0,0 +1 @@
1
+ export * from './lib/middleware';
@@ -0,0 +1,2 @@
1
+ export * from './lib/middleware';
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxrQkFBa0IsQ0FBQyJ9
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,61 @@
1
+ import test from 'ava';
2
+ import express from 'express';
3
+ import request from 'supertest';
4
+ import { fastJsonSchema } from './';
5
+ const data = {
6
+ firstName: 'Simone',
7
+ lastName: 'Nigro',
8
+ age: 40,
9
+ };
10
+ const schema = {
11
+ title: 'Example Schema',
12
+ type: 'object',
13
+ properties: {
14
+ firstName: {
15
+ type: 'string',
16
+ },
17
+ lastName: {
18
+ type: 'string',
19
+ },
20
+ age: {
21
+ description: 'Age in years',
22
+ type: 'integer',
23
+ },
24
+ },
25
+ };
26
+ const app = express();
27
+ app.use(express.json());
28
+ app.post('/with-schema', fastJsonSchema(schema), (req, res, next) => {
29
+ try {
30
+ res.fastJson(req.body.data);
31
+ }
32
+ catch (error) {
33
+ next(error);
34
+ }
35
+ });
36
+ app.post('/without-schema', (req, res, next) => {
37
+ try {
38
+ res.fastJson(req.body.data);
39
+ }
40
+ catch (error) {
41
+ next(error);
42
+ }
43
+ });
44
+ app.use((err, _req, res, _next) => {
45
+ res.status(500).json({ error: err.message });
46
+ });
47
+ test('with schema', async (t) => {
48
+ t.plan(3);
49
+ const res = await request(app).post('/with-schema').send({ data });
50
+ t.like(res.body, data);
51
+ t.is(res.ok, true);
52
+ t.is(res.type, 'application/json');
53
+ });
54
+ test('without schema', async (t) => {
55
+ t.plan(3);
56
+ const res = await request(app).post('/without-schema').send({ data });
57
+ t.like(res.body, { error: `res.fastJson is not a function` });
58
+ t.is(res.ok, false);
59
+ t.is(res.type, 'application/json');
60
+ });
61
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguc3BlYy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbmRleC5zcGVjLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sSUFBSSxNQUFNLEtBQUssQ0FBQztBQUN2QixPQUFPLE9BQTRDLE1BQU0sU0FBUyxDQUFDO0FBQ25FLE9BQU8sT0FBTyxNQUFNLFdBQVcsQ0FBQztBQUVoQyxPQUFPLEVBQUUsY0FBYyxFQUFVLE1BQU0sSUFBSSxDQUFDO0FBRTVDLE1BQU0sSUFBSSxHQUFHO0lBQ1gsU0FBUyxFQUFFLFFBQVE7SUFDbkIsUUFBUSxFQUFFLE9BQU87SUFDakIsR0FBRyxFQUFFLEVBQUU7Q0FDUixDQUFDO0FBRUYsTUFBTSxNQUFNLEdBQVc7SUFDckIsS0FBSyxFQUFFLGdCQUFnQjtJQUN2QixJQUFJLEVBQUUsUUFBUTtJQUNkLFVBQVUsRUFBRTtRQUNWLFNBQVMsRUFBRTtZQUNULElBQUksRUFBRSxRQUFRO1NBQ2Y7UUFDRCxRQUFRLEVBQUU7WUFDUixJQUFJLEVBQUUsUUFBUTtTQUNmO1FBQ0QsR0FBRyxFQUFFO1lBQ0gsV0FBVyxFQUFFLGNBQWM7WUFDM0IsSUFBSSxFQUFFLFNBQVM7U0FDaEI7S0FDRjtDQUNGLENBQUM7QUFFRixNQUFNLEdBQUcsR0FBRyxPQUFPLEVBQUUsQ0FBQztBQUV0QixHQUFHLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFDO0FBRXhCLEdBQUcsQ0FBQyxJQUFJLENBQUMsY0FBYyxFQUFFLGNBQWMsQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFDLEdBQUcsRUFBRSxHQUFHLEVBQUUsSUFBSSxFQUFFLEVBQUU7SUFDbEUsSUFBSTtRQUNGLEdBQUcsQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztLQUM3QjtJQUFDLE9BQU8sS0FBSyxFQUFFO1FBQ2QsSUFBSSxDQUFDLEtBQUssQ0FBQyxDQUFDO0tBQ2I7QUFDSCxDQUFDLENBQUMsQ0FBQztBQUVILEdBQUcsQ0FBQyxJQUFJLENBQUMsaUJBQWlCLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLElBQUksRUFBRSxFQUFFO0lBQzdDLElBQUk7UUFDRixHQUFHLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7S0FDN0I7SUFBQyxPQUFPLEtBQUssRUFBRTtRQUNkLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQztLQUNiO0FBQ0gsQ0FBQyxDQUFDLENBQUM7QUFFSCxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUMsR0FBUSxFQUFFLElBQWEsRUFBRSxHQUFhLEVBQUUsS0FBbUIsRUFBRSxFQUFFO0lBQ3RFLEdBQUcsQ0FBQyxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUMsSUFBSSxDQUFDLEVBQUUsS0FBSyxFQUFFLEdBQUcsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQUFDO0FBQy9DLENBQUMsQ0FBQyxDQUFDO0FBRUgsSUFBSSxDQUFDLGFBQWEsRUFBRSxLQUFLLEVBQUUsQ0FBQyxFQUFFLEVBQUU7SUFDOUIsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUVWLE1BQU0sR0FBRyxHQUFHLE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQyxJQUFJLENBQUMsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBRW5FLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztJQUN2QixDQUFDLENBQUMsRUFBRSxDQUFDLEdBQUcsQ0FBQyxFQUFFLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDbkIsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLGtCQUFrQixDQUFDLENBQUM7QUFDckMsQ0FBQyxDQUFDLENBQUM7QUFFSCxJQUFJLENBQUMsZ0JBQWdCLEVBQUUsS0FBSyxFQUFFLENBQUMsRUFBRSxFQUFFO0lBQ2pDLENBQUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFVixNQUFNLEdBQUcsR0FBRyxNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsQ0FBQyxJQUFJLENBQUMsaUJBQWlCLENBQUMsQ0FBQyxJQUFJLENBQUMsRUFBRSxJQUFJLEVBQUUsQ0FBQyxDQUFDO0lBRXRFLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxFQUFFLEtBQUssRUFBRSxnQ0FBZ0MsRUFBRSxDQUFDLENBQUM7SUFDOUQsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxHQUFHLENBQUMsRUFBRSxFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQ3BCLENBQUMsQ0FBQyxFQUFFLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxrQkFBa0IsQ0FBQyxDQUFDO0FBQ3JDLENBQUMsQ0FBQyxDQUFDIn0=
@@ -0,0 +1,45 @@
1
+ import type { NextFunction, Request, Response } from 'express';
2
+ import { Schema } from 'fast-json-stringify';
3
+ export type { Schema } from 'fast-json-stringify';
4
+ /**
5
+ * Set the schema
6
+ * @param {Schema} schema
7
+ *
8
+ * Examples:
9
+ * ```ts
10
+ * import express from 'express';
11
+ * import { fastJsonSchemas, Schema } from 'express-fast-json-stringify';
12
+ *
13
+ * const app = express();
14
+ *
15
+ * const schema: Schema = {
16
+ * title: 'Example Schema',
17
+ * type: 'object',
18
+ * properties: {
19
+ * firstName: {
20
+ * type: 'string',
21
+ * },
22
+ * lastName: {
23
+ * type: 'string',
24
+ * },
25
+ * age: {
26
+ * type: 'integer',
27
+ * }
28
+ * },
29
+ * };
30
+ *
31
+ * app.get('/', fastJsonSchema(schema), (req, res, next) => {
32
+ * try {
33
+ * const data = {
34
+ * firstName: "Simone",
35
+ * lastName: "Nigro",
36
+ * age: 40
37
+ * };
38
+ * res.fastJson(data);
39
+ * } catch (error) {
40
+ * next(error);
41
+ * }
42
+ * });
43
+ * ```
44
+ */
45
+ export declare const fastJsonSchema: (schema: Schema) => (_req: Request, res: Response, next: NextFunction) => void;
@@ -0,0 +1,67 @@
1
+ import fastJson from 'fast-json-stringify';
2
+ /**
3
+ * Set the schema
4
+ * @param {Schema} schema
5
+ *
6
+ * Examples:
7
+ * ```ts
8
+ * import express from 'express';
9
+ * import { fastJsonSchemas, Schema } from 'express-fast-json-stringify';
10
+ *
11
+ * const app = express();
12
+ *
13
+ * const schema: Schema = {
14
+ * title: 'Example Schema',
15
+ * type: 'object',
16
+ * properties: {
17
+ * firstName: {
18
+ * type: 'string',
19
+ * },
20
+ * lastName: {
21
+ * type: 'string',
22
+ * },
23
+ * age: {
24
+ * type: 'integer',
25
+ * }
26
+ * },
27
+ * };
28
+ *
29
+ * app.get('/', fastJsonSchema(schema), (req, res, next) => {
30
+ * try {
31
+ * const data = {
32
+ * firstName: "Simone",
33
+ * lastName: "Nigro",
34
+ * age: 40
35
+ * };
36
+ * res.fastJson(data);
37
+ * } catch (error) {
38
+ * next(error);
39
+ * }
40
+ * });
41
+ * ```
42
+ */
43
+ export const fastJsonSchema = (schema) => {
44
+ if (!schema) {
45
+ throw new TypeError(`express-fast-json-stringify: invalid schema`);
46
+ }
47
+ const fjs = fastJson(schema);
48
+ return (_req, res, next) => {
49
+ /**
50
+ * Send JSON response.
51
+ *
52
+ * Examples:
53
+ * ```ts
54
+ * res.fastJson({ user: 'tj' });
55
+ * res.status(200).fastJson({ user: 'tj' });
56
+ * ```
57
+ */
58
+ res.fastJson = (data) => {
59
+ if (!res.getHeader('Content-Type')) {
60
+ res.setHeader('Content-Type', 'application/json');
61
+ }
62
+ return res.send(fjs(data));
63
+ };
64
+ next();
65
+ };
66
+ };
67
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibWlkZGxld2FyZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvbWlkZGxld2FyZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFDQSxPQUFPLFFBQW9CLE1BQU0scUJBQXFCLENBQUM7QUFJdkQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0F3Q0c7QUFDSCxNQUFNLENBQUMsTUFBTSxjQUFjLEdBQUcsQ0FBQyxNQUFjLEVBQUUsRUFBRTtJQUMvQyxJQUFJLENBQUMsTUFBTSxFQUFFO1FBQ1gsTUFBTSxJQUFJLFNBQVMsQ0FBQyw2Q0FBNkMsQ0FBQyxDQUFDO0tBQ3BFO0lBQ0QsTUFBTSxHQUFHLEdBQUcsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQzdCLE9BQU8sQ0FBQyxJQUFhLEVBQUUsR0FBYSxFQUFFLElBQWtCLEVBQUUsRUFBRTtRQUMxRDs7Ozs7Ozs7V0FRRztRQUNILEdBQUcsQ0FBQyxRQUFRLEdBQUcsQ0FBQyxJQUFTLEVBQVksRUFBRTtZQUNyQyxJQUFJLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxjQUFjLENBQUMsRUFBRTtnQkFDbEMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxjQUFjLEVBQUUsa0JBQWtCLENBQUMsQ0FBQzthQUNuRDtZQUNELE9BQU8sR0FBRyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQztRQUM3QixDQUFDLENBQUM7UUFDRixJQUFJLEVBQUUsQ0FBQztJQUNULENBQUMsQ0FBQztBQUNKLENBQUMsQ0FBQyJ9
package/package.json ADDED
@@ -0,0 +1,116 @@
1
+ {
2
+ "name": "express-fast-json-stringify",
3
+ "version": "1.1.2",
4
+ "description": "With express-fast-json-stringify, you can leverage fast-json-stringify in your Express application",
5
+ "main": "build/main/index.js",
6
+ "typings": "build/main/index.d.ts",
7
+ "module": "build/module/index.js",
8
+ "repository": "https://github.com/nigrosimone/express-fast-json-stringify",
9
+ "license": "MIT",
10
+ "keywords": [],
11
+ "scripts": {
12
+ "build": "run-p build:*",
13
+ "build:main": "tsc -p tsconfig.json",
14
+ "build:module": "tsc -p tsconfig.module.json",
15
+ "fix": "run-s fix:*",
16
+ "fix:prettier": "prettier \"src/**/*.ts\" --write",
17
+ "fix:lint": "eslint src --ext .ts --fix",
18
+ "test": "run-s build test:*",
19
+ "test:lint": "eslint src --ext .ts",
20
+ "test:prettier": "prettier \"src/**/*.ts\" --list-different",
21
+ "test:spelling": "cspell \"{README.md,.github/*.md,src/**/*.ts}\"",
22
+ "test:unit": "nyc --silent ava",
23
+ "check-cli": "run-s test diff-integration-tests check-integration-tests",
24
+ "check-integration-tests": "run-s check-integration-test:*",
25
+ "diff-integration-tests": "mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'",
26
+ "watch:build": "tsc -p tsconfig.json -w",
27
+ "watch:test": "nyc --silent ava --watch",
28
+ "cov": "run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html",
29
+ "cov:html": "nyc report --reporter=html",
30
+ "cov:lcov": "nyc report --reporter=lcov",
31
+ "cov:send": "run-s cov:lcov && codecov",
32
+ "cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
33
+ "doc": "run-s doc:html && open-cli build/docs/index.html",
34
+ "doc:html": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs",
35
+ "doc:json": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json",
36
+ "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
37
+ "version": "standard-version",
38
+ "reset-hard": "git clean -dfx && git reset --hard && npm i",
39
+ "prepare-release": "run-s reset-hard test cov:check doc:html version doc:publish"
40
+ },
41
+ "engines": {
42
+ "node": ">=18"
43
+ },
44
+ "dependencies": {
45
+ "@bitauth/libauth": "^1.17.1",
46
+ "fast-json-stringify": "^6.0.0"
47
+ },
48
+ "devDependencies": {
49
+ "@ava/typescript": "^4.1.0",
50
+ "@istanbuljs/nyc-config-typescript": "^1.0.1",
51
+ "@types/express": "^5.0.0",
52
+ "@types/node": "^20.9.0",
53
+ "@types/supertest": "^6.0.2",
54
+ "@typescript-eslint/eslint-plugin": "^6.10.0",
55
+ "@typescript-eslint/parser": "^6.10.0",
56
+ "ava": "^5.3.1",
57
+ "codecov": "^3.5.0",
58
+ "cspell": "^8.0.0",
59
+ "cz-conventional-changelog": "^3.3.0",
60
+ "eslint": "^8.53.0",
61
+ "eslint-config-prettier": "^9.0.0",
62
+ "eslint-plugin-eslint-comments": "^3.2.0",
63
+ "eslint-plugin-functional": "^6.0.0",
64
+ "eslint-plugin-import": "^2.22.0",
65
+ "express": "^4.21.0",
66
+ "gh-pages": "^6.0.0",
67
+ "npm-run-all": "^4.1.5",
68
+ "nyc": "^15.1.0",
69
+ "open-cli": "^7.2.0",
70
+ "prettier": "^3.0.3",
71
+ "standard-version": "^9.0.0",
72
+ "supertest": "^7.0.0",
73
+ "ts-node": "^10.9.1",
74
+ "typedoc": "^0.25.3",
75
+ "typescript": "^5.2.2"
76
+ },
77
+ "files": [
78
+ "build/main",
79
+ "build/module",
80
+ "!**/*.spec.*",
81
+ "!**/*.json",
82
+ "CHANGELOG.md",
83
+ "LICENSE",
84
+ "README.md"
85
+ ],
86
+ "ava": {
87
+ "failFast": true,
88
+ "timeout": "60s",
89
+ "typescript": {
90
+ "compile": false,
91
+ "rewritePaths": {
92
+ "src/": "build/main/"
93
+ }
94
+ },
95
+ "files": [
96
+ "!build/module/**"
97
+ ]
98
+ },
99
+ "config": {
100
+ "commitizen": {
101
+ "path": "cz-conventional-changelog"
102
+ }
103
+ },
104
+ "prettier": {
105
+ "singleQuote": true
106
+ },
107
+ "nyc": {
108
+ "extends": "@istanbuljs/nyc-config-typescript",
109
+ "exclude": [
110
+ "**/*.spec.js"
111
+ ]
112
+ },
113
+ "peerDependencies": {
114
+ "fast-json-stringify": "^6.0.0"
115
+ }
116
+ }