Middleware implemented

Author: Dmitry Dutikov

.github/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  workflow_dispatch:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.idea

.npmignore

@@ -0,0 +1,3 @@
+node_modules
+test
+.github

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Dmitry Dutikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,95 @@
+# JSON22-Express
+Expressjs middleware providing support to [JSON22](https://github.com/dancecoder/json22#readme) data format in your applications.
+
+## Features
+* Ready to use [Express](https://expressjs.com/) middleware
+* Parse [JSON22](https://github.com/dancecoder/json22#readme) body content
+* Parse JSON body content
+* Support for `deflate`, `gzip`, `br` content encodings
+* Define Request.json22 method to send [JSON22](https://github.com/dancecoder/json22#readme) encoded data 
+* Zero-dependency npm-package
+* Both CJS/ESM modules support
+
+## Installation
+```
+npm install json22-express
+```
+In your application initialization file add as a middleware
+```javascript
+import express from 'express'; 
+import { json22express } from 'json22-express'
+
+const app = express();
+app.use(json22express());
+```
+
+For old-fashioned applications
+```javascript
+const express = require('express'); 
+const { json22express } = require('json22-express'); 
+
+const app = express();
+app.use(json22express());
+```
+
+## Configuration
+JSON22-Express middleware support set of configuration options.
+
+### Pass options
+```javascript
+import express from 'express'; 
+import { json22express } from 'json22-express'
+
+const app = express();
+app.use(json22express({
+    overrideResponseJsonMethod: true,
+    maxContentLength: 1024 * 1024, // 1 meg
+}));
+```
+
+### Options
+| Option     | Type      | Default | Description                      |
+|:-----------|:----------|---------|:----------------------------------|
+| handleJson | boolean   | false   | Parse JSON content as well as JSON22 |
+| maxContentLength | number | no limit | Prevent from parsing of too large payloads |
+| keepRawAs  | string | do not keep raw body | Define `Request` field name to save payload Buffer to | 
+| overrideResponseJsonMethod | boolean | false | Override response json method as well |
+| json22ParseOptions | Json22ParseOptions | empty | Options to be passed to `JSON22.parse()` method |
+| json22StringifyOptions | Json22StringifyOptions | empty | Options to be passed to `JSON22.stringify()` method |
+
+## Usage
+
+```javascript
+import express from 'express'; 
+import { json22express } from 'json22-express'
+
+const app = express();
+
+app.use(json22express({
+    overrideResponseJsonMethod: true,
+    maxContentLength: 1024 * 1024, // 1 meg
+}));
+
+app.get('/date', (req, res, next) => {
+    // Use .json22() method from Response object
+    res.status(200).json22({ date: new Date() });
+    next();
+});
+
+app.get('/json', (req, res, next) => {
+    // in case overrideResponseJsonMethod is set to true you may use 
+    // .json() method to send JSON22 as well
+    res.status(200).json({ date: new Date() });
+    next();
+});
+
+app.get('/deprecated', (req, res, next) => {
+    // WARNING: don't do this. It is deprecated method interface and in case
+    // you set overrideResponseJsonMethod to true this method will throw an exception
+    res.json(200, { date: new Date() });
+    next();
+});
+
+
+```
+

index.cjs

@@ -0,0 +1,131 @@
+/*
+MIT License
+
+Copyright (c) 2022 Dmitry Dutikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ */
+
+const zlib = require('zlib');
+const { JSON22 } = require('json22');
+const { Buffer } = require('buffer');
+const { pipeline } = require('stream');
+const { MediaType } = require('./media-type');
+const { Json22Parser } = require('./json22-parser');
+
+const JSON22_MEDIA_TYPE = MediaType.parse(JSON22.mimeType);
+const JSON_MEDIA_TYPE = MediaType.parse('application/json');
+const DEFAULT_CHARSET = 'utf-8';
+const SUPPORTED_CHARSETS = ['utf-8', 'utf8', 'utf-16', 'utf16', 'utf-32', 'utf32'];
+const SUPPORTED_ENCODINGS = ['deflate', 'gzip', 'br', 'identity'];
+
+const HTTP_PAYLOAD_TOO_LARGE = 413;
+const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
+
+const JSON22_WAS_HERE = Symbol();
+
+/**
+ * @param {Json22ExpressOptions} [options = {}]
+ * */
+function json22express(options = {}) {
+
+    const SUPPORTED_MEDIA_TYPE = [JSON22_MEDIA_TYPE];
+    if (options.handleJson) {
+        SUPPORTED_MEDIA_TYPE.push(JSON_MEDIA_TYPE);
+    }
+
+    /**
+     * @param {IncomingMessage} req
+     * @param {ServerResponse} res
+     * @param {Function} next
+     * */
+    async function json22Middleware (req, res, next) {
+
+        if (req[JSON22_WAS_HERE] === true) {
+            next(new Error('Duplicated json22 middleware on the pipe'));
+            return;
+        }
+
+        req[JSON22_WAS_HERE] = true;
+
+        res.json22 = function (obj) {
+            const serialized = JSON22.stringify(obj, options.json22StringifyOptions);
+            res.set('Content-Type', JSON22.mimeType);
+            return res.send(serialized);
+        }
+
+        if (options.overrideResponseJsonMethod) {
+            res.json = function (obj) {
+                if (arguments.length > 1) {
+                    throw new Error('Too much arguments');
+                }
+                return res.json22(obj);
+            }
+        }
+
+        if (req.headers['transfer-encoding'] == null && (req.headers['content-length'] == null || req.headers['content-length'] === '0')) {
+            next();
+            return;
+        }
+
+        const contentLength = Number(req.headers['content-length']);
+        if (options.maxContentLength != null && contentLength > options.maxContentLength) {
+            res.status(HTTP_PAYLOAD_TOO_LARGE).send('Payload too large');
+            return;
+        }
+
+        const ct = MediaType.parse(req.headers['content-type'] ?? '');
+        if (SUPPORTED_MEDIA_TYPE.some(mt => ct.match(mt))) {
+            const charset = ct.parameters.charset?.toLowerCase() ?? DEFAULT_CHARSET;
+            if (Buffer.isEncoding(charset) && SUPPORTED_CHARSETS.some(enc => enc === charset)) {
+                const encoding = req.headers['content-encoding']?.toLowerCase() ?? 'identity';
+                if (SUPPORTED_ENCODINGS.some(enc => enc === encoding)) {
+                    const streams = [req];
+                    switch (encoding) {
+                        case 'deflate': streams.push(zlib.createInflate()); break;
+                        case 'gzip': streams.push(zlib.createGunzip()); break;
+                        case 'br': streams.push(zlib.createBrotliDecompress()); break;
+                        case 'identity':
+                        default:
+                            break;
+                    }
+                    streams.push(new Json22Parser(req, charset, options.maxContentLength, options.keepRawAs, options.json22ParseOptions));
+                    await pipeline(...streams, err => {
+                        if (err == null) {
+                            next();
+                        } else {
+                            res.status(HTTP_UNSUPPORTED_MEDIA_TYPE).send(`Wrong content encoding: ${err.code ?? err.message}`);
+                        }
+                    });
+                } else {
+                    res.status(HTTP_UNSUPPORTED_MEDIA_TYPE).send(`Unsupported content encoding "${encoding}"`);
+                }
+            } else {
+                res.status(HTTP_UNSUPPORTED_MEDIA_TYPE).send(`Unsupported charset "${ct.parameters.charset}"`);
+            }
+        } else {
+            next();
+        }
+
+    }
+
+    return json22Middleware;
+}
+
+module.exports = { json22express };

index.d.ts

@@ -0,0 +1,36 @@
+/*
+MIT License
+
+Copyright (c) 2022 Dmitry Dutikov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ */
+
+import { Json22ParseOptions, Json22StringifyOptions } from 'json22';
+
+export interface Json22ExpressOptions {
+    handleJson?: boolean;
+    maxContentLength?: number;
+    keepRawAs?: string;
+    overrideResponseJsonMethod?: boolean;
+    json22ParseOptions?: Json22ParseOptions;
+    json22StringifyOptions?: Json22StringifyOptions;
+}
+
+export declare function json22express(options: Json22ExpressOptions): Function;