Initial implementation

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,4 @@
+node_modules
+test
+.github
+.gitignore

README.md

@@ -0,0 +1,114 @@
+# SuperAgent JSON22 Plugin
+SuperAgent plugin providing support to [JSON22](https://github.com/dancecoder/json22#readme) data format in your applications.
+
+## Features
+* Ready to use [SuperAgent](https://visionmedia.github.io/superagent/) plugin
+* Parse [JSON22](https://github.com/dancecoder/json22#readme) body content
+* Serialize data to JSON22
+* Can be used with [SuperTest](https://github.com/visionmedia/supertest#readme)
+* Both CJS/ESM modules support
+
+## Installation
+```shell
+npm install superagent-json22
+```
+
+Add plugin to a request
+```javascript
+import superagent from 'superagent';
+import { json22Plugin } from 'superagent-json22';
+
+async function sendData() {
+    try {
+        return await superagent
+            .post('https://example.com/api/data')
+            .use(json22Plugin())
+            .send(data);
+    } catch (e) {
+        console.error(e);
+    }
+}
+```
+
+Old-fashioned javascript imports
+```javascript
+const superagent = require('superagent');
+const { json22Plugin } =  require('superagent-json22');
+```
+
+## Options
+
+Both stringify and parse methods of JSON22 accepts options. You may be interested to define such options at global level as well as with isolated client instance.
+
+`Json22RequestInterceptor` accepts the next options structure
+
+```typescript
+interface Json22SuperagentPluginOptions {
+    json22ParseOptions?: Json22ParseOptions;
+    json22StringifyOptions?: Json22StringifyOptions;
+}
+```
+See also `Json22ParseOptions` and `Json22StringifyOptions` at [JSON22 API description](https://github.com/dancecoder/json22#api)
+
+### Define options on each request
+```javascript
+import superagent from 'superagent';
+import { json22Plugin } from 'superagent-json22';
+import { TypedModel } from './models/typed-model.js';
+
+async function sendData() {
+    try {
+        return await superagent
+            .post('https://example.com/api/data')
+            .use(json22Plugin({
+                json22ParseOptions: { context: { TypedModel } },
+            }))
+            .send(data);
+    } catch (e) {
+        console.error(e);
+    }
+}
+```
+
+### Define an agent instance plugin options
+```javascript
+import superagent from 'superagent';
+import { json22Plugin } from 'superagent-json22';
+import { TypedModel } from './models/typed-model.js';
+
+const agent = superagent.agent().use(json22Plugin({
+    json22ParseOptions: { context: { TypedModel } },
+}));
+
+async function sendData() {
+    try {
+        return await agent.post('https://example.com/api/data').send(data);
+    } catch (e) {
+        console.error(e);
+    }
+}
+```
+
+## Using with SuperTest
+SuperTest uses SuperAgent under the hood. SuperAgent isn't well isolated by SuperTest,
+so you can easily use any SuperAgent plugin including superagent-json22. Here is the example.
+```javascript
+import supertest from 'supertest';
+import { appFactory } from '../lib/app/appFatory.js';
+import { TypedModel } from '../lib/models/typed-model.js';
+
+suite('Response tests', () => {
+
+    test('supertest with plugin', (done) => {
+        const app = appFactory();
+        supertest(app)
+            .post('/')
+            .use(json22Plugin({ json22ParseOptions: { context: { TypedModel } }}))
+            .send(data)
+            .expect(200)
+            .then(resp => done())
+            .catch(done);
+    });
+
+});
+```

index.cjs

@@ -0,0 +1,75 @@
+/*
+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 { JSON22 } = require('json22');
+
+const METHODS_WITH_BODY = ['POST', 'PUT', 'PATCH'];
+
+module.exports = { json22Plugin };
+
+/**
+ * @param {Json22SuperagentPluginOptions} [options]
+ * @return {request.Plugin}
+ * */
+function json22Plugin(options) {
+    return requestPlugin.bind(options ?? {});
+}
+
+/**
+ * @this Json22SuperagentPluginOptions
+ * @param {SuperAgentRequest} request
+ **/
+function requestPlugin(request) {
+    if (METHODS_WITH_BODY.indexOf(request.method) > -1) {
+        request.type(JSON22.mimeType);
+        request.serialize(data => JSON22.stringify(data, this.json22StringifyOptions));
+    }
+    request.accept(JSON22.mimeType);
+    request.buffer(true); // required for parsing in node environment
+    request.parse((textOrResp, cb) => {
+        if (cb == null) {
+            return JSON22.parse(textOrResp, this.json22ParseOptions);
+        } else {
+            json22Parse(textOrResp, cb, this.json22ParseOptions);
+        }
+    });
+}
+
+
+function json22Parse(res, fn, json22ParseOptions) {
+    const chunks = [];
+    res.setEncoding('utf8');
+    res.on('data', chunk => chunks.push(chunk));
+    res.on('end', function () {
+        try {
+            const text = chunks.join('');
+            const body = JSON22.parse(text, json22ParseOptions);
+            res.text = text
+            fn(undefined, body);
+        } catch (e) {
+            e.rawResponse = chunks.join('');
+            e.statusCode = res.statusCode;
+            fn(e);
+        }
+    });
+}

index.d.ts

@@ -0,0 +1,31 @@
+/*
+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 Json22SuperagentPluginOptions {
+    json22ParseOptions?: Json22ParseOptions;
+    json22StringifyOptions?: Json22StringifyOptions;
+}
+
+export declare function json22Plugin(options?: Json22SuperagentPluginOptions);

index.js

@@ -0,0 +1,73 @@
+/*
+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 { JSON22 } from 'json22';
+
+const METHODS_WITH_BODY = ['POST', 'PUT', 'PATCH'];
+
+/**
+ * @param {Json22SuperagentPluginOptions} [options]
+ * @return {request.Plugin}
+ * */
+export function json22Plugin(options) {
+    return requestPlugin.bind(options ?? {});
+}
+
+/**
+ * @this Json22SuperagentPluginOptions
+ * @param {SuperAgentRequest} request
+ **/
+function requestPlugin(request) {
+    if (METHODS_WITH_BODY.indexOf(request.method) > -1) {
+        request.type(JSON22.mimeType);
+        request.serialize(data => JSON22.stringify(data, this.json22StringifyOptions));
+    }
+    request.accept(JSON22.mimeType);
+    request.buffer(true); // required for parsing in node environment
+    request.parse((textOrResp, cb) => {
+        if (cb == null) {
+            return JSON22.parse(textOrResp, this.json22ParseOptions);
+        } else {
+            json22Parse(textOrResp, cb, this.json22ParseOptions);
+        }
+    });
+}
+
+
+function json22Parse(res, fn, json22ParseOptions) {
+    const chunks = [];
+    res.setEncoding('utf8');
+    res.on('data', chunk => chunks.push(chunk));
+    res.on('end', function () {
+        try {
+            const text = chunks.join('');
+            const body = JSON22.parse(text, json22ParseOptions);
+            res.text = text
+            fn(undefined, body);
+        } catch (e) {
+            e.rawResponse = chunks.join('');
+            e.statusCode = res.statusCode;
+            fn(e);
+        }
+    });
+}