@qson/express 0.2.0

package/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jarno Parviainen and contributors
+
+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.

package/README.md

@@ -0,0 +1,42 @@
+# QSON query string parser and middleware for Express.js
+
+See [@qson/js](https://www.npmjs.com/package/@qson/js) for what QSON is.
+
+Use either of the following that fits your project.
+
+Example:
+
+```js
+import express from "express";
+import { qsonQueryParser } from "@qson/express";
+
+const app = express();
+// Replace default query string parser (result is available in request.query)
+// Parse query string keys starting with "q_" as QSON and others as raw strings (this setting is optional)
+app.set("query parser", qsonQueryParser({ isQSON: (key) => key.startsWith("q_") }));
+```
+
+or:
+
+```js
+import express from "express";
+import { qsonMiddleware } from "@qson/express";
+
+const app = express();
+// Parse query string and make the result available in request.qson (request.query is untouched)
+// Keys "_id" is parsed as raw string and others are parsed as QSON
+app.use(qsonMiddleware({ isQSON: (key) => key !== "_id" }));
+```
+
+## API
+
+`qsonQueryParser([options])`
+- options\<ParseQueryStringOptions>
+
+`qsonMiddleware([options])`
+- options\<ParseQueryStringOptions>
+
+`ParseQueryStringOptions`
+- isQSON\<`(key:string) => boolean`> a callback that gets key as an argument and returns boolean. True for QSON fields. False for raw string fields. This applies only to query (root level) fields. (default: all fields are considered QSON)
+- reviver\<function> A json api style reviver function. It is run for each QSON field in query (root) object but not for the query object itself.
+- maxDepth\<number> Maximum nesting depth. Error is thrown if exceeded. (default: 10)

package/dist/cjs/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.qsonQueryParser = exports.qsonMiddleware = void 0;
+var qson_middleware_ts_1 = require("./qson-middleware.js");
+Object.defineProperty(exports, "qsonMiddleware", { enumerable: true, get: function () { return __importDefault(qson_middleware_ts_1).default; } });
+var qson_query_parser_ts_1 = require("./qson-query-parser.js");
+Object.defineProperty(exports, "qsonQueryParser", { enumerable: true, get: function () { return __importDefault(qson_query_parser_ts_1).default; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,2DAAiE;AAAxD,qIAAA,OAAO,OAAkB;AAClC,+DAAoE;AAA3D,wIAAA,OAAO,OAAmB"}

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/cjs/qson-middleware.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = qsonMiddleware;
+const js_1 = require("@qson/js");
+function qsonMiddleware(options = {}) {
+    function middleware(request, response, next) {
+        try {
+            request.qson = {};
+            const questionMarkIndex = request.originalUrl.indexOf("?");
+            if (questionMarkIndex === -1) {
+                next();
+                return;
+            }
+            const rawQuery = request.originalUrl.slice(questionMarkIndex + 1);
+            request.qson = (0, js_1.parseQueryString)(rawQuery, options);
+            next();
+        }
+        catch (error) {
+            next(error);
+        }
+    }
+    return middleware;
+}
+//# sourceMappingURL=qson-middleware.js.map

package/dist/cjs/qson-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qson-middleware.js","sourceRoot":"","sources":["../../src/qson-middleware.ts"],"names":[],"mappings":";;AAGA,iCAmBC;AArBD,iCAAqE;AAErE,SAAwB,cAAc,CAAC,UAAkC,EAAE;IAEvE,SAAS,UAAU,CAAC,OAAe,EAAE,QAAiB,EAAE,IAAQ;QAC5D,IAAI,CAAC;YACD,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC;YAClB,MAAM,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC3D,IAAI,iBAAiB,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC3B,IAAI,EAAE,CAAC;gBACP,OAAO;YACX,CAAC;YACD,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;YAClE,OAAO,CAAC,IAAI,GAAG,IAAA,qBAAgB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACnD,IAAI,EAAE,CAAC;QACX,CAAC;QAAC,OAAO,KAAS,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC;IACL,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC"}

package/dist/cjs/qson-query-parser.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = qsonQueryParser;
+const js_1 = require("@qson/js");
+function qsonQueryParser(options = {}) {
+    function queryParser(rawQuery) {
+        const query = (0, js_1.parseQueryString)(rawQuery, options);
+        return query;
+    }
+    return queryParser;
+}
+//# sourceMappingURL=qson-query-parser.js.map

package/dist/cjs/qson-query-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qson-query-parser.js","sourceRoot":"","sources":["../../src/qson-query-parser.ts"],"names":[],"mappings":";;AAEA,kCAQC;AAVD,iCAAqE;AAErE,SAAwB,eAAe,CAAC,UAAkC,EAAE;IAExE,SAAS,WAAW,CAAC,QAAe;QAChC,MAAM,KAAK,GAAG,IAAA,qBAAgB,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+export { default as qsonMiddleware } from "./qson-middleware.js";
+export { default as qsonQueryParser } from "./qson-query-parser.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/esm/qson-middleware.js

@@ -0,0 +1,21 @@
+import { parseQueryString } from "@qson/js";
+export default function qsonMiddleware(options = {}) {
+    function middleware(request, response, next) {
+        try {
+            request.qson = {};
+            const questionMarkIndex = request.originalUrl.indexOf("?");
+            if (questionMarkIndex === -1) {
+                next();
+                return;
+            }
+            const rawQuery = request.originalUrl.slice(questionMarkIndex + 1);
+            request.qson = parseQueryString(rawQuery, options);
+            next();
+        }
+        catch (error) {
+            next(error);
+        }
+    }
+    return middleware;
+}
+//# sourceMappingURL=qson-middleware.js.map

package/dist/esm/qson-middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qson-middleware.js","sourceRoot":"","sources":["../../src/qson-middleware.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAA2B,MAAM,UAAU,CAAC;AAErE,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,UAAkC,EAAE;IAEvE,SAAS,UAAU,CAAC,OAAe,EAAE,QAAiB,EAAE,IAAQ;QAC5D,IAAI,CAAC;YACD,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC;YAClB,MAAM,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC3D,IAAI,iBAAiB,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC3B,IAAI,EAAE,CAAC;gBACP,OAAO;YACX,CAAC;YACD,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC;YAClE,OAAO,CAAC,IAAI,GAAG,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YACnD,IAAI,EAAE,CAAC;QACX,CAAC;QAAC,OAAO,KAAS,EAAE,CAAC;YACjB,IAAI,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC;IACL,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC"}

package/dist/esm/qson-query-parser.js

@@ -0,0 +1,9 @@
+import { parseQueryString } from "@qson/js";
+export default function qsonQueryParser(options = {}) {
+    function queryParser(rawQuery) {
+        const query = parseQueryString(rawQuery, options);
+        return query;
+    }
+    return queryParser;
+}
+//# sourceMappingURL=qson-query-parser.js.map

package/dist/esm/qson-query-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qson-query-parser.js","sourceRoot":"","sources":["../../src/qson-query-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAA2B,MAAM,UAAU,CAAC;AAErE,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,UAAkC,EAAE;IAExE,SAAS,WAAW,CAAC,QAAe;QAChC,MAAM,KAAK,GAAG,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAClD,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,WAAW,CAAC;AACvB,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export { default as qsonMiddleware } from "./qson-middleware.ts";
+export { default as qsonQueryParser } from "./qson-query-parser.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/types/qson-middleware.d.ts

@@ -0,0 +1,13 @@
+import { Request, Response } from "express";
+import { ParseQueryStringOptions } from "@qson/js";
+export default function qsonMiddleware(options?: ParseQueryStringOptions): (request: Request, response: Response, next: any) => void;
+declare global {
+    namespace Express {
+        interface Request {
+            qson?: {
+                [key: string]: any;
+            };
+        }
+    }
+}
+//# sourceMappingURL=qson-middleware.d.ts.map

package/dist/types/qson-middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"qson-middleware.d.ts","sourceRoot":"","sources":["../../src/qson-middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAoB,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAErE,MAAM,CAAC,OAAO,UAAU,cAAc,CAAC,OAAO,GAAC,uBAA4B,aAE3C,OAAO,YAAW,QAAQ,QAAO,GAAG,UAiBnE;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,OAAO,CAAC;QACd,UAAU,OAAO;YACb,IAAI,CAAC,EAAE;gBAAE,CAAC,GAAG,EAAC,MAAM,GAAE,GAAG,CAAA;aAAE,CAAC;SAC/B;KACJ;CACJ"}

package/dist/types/qson-query-parser.d.ts

@@ -0,0 +1,7 @@
+import { ParseQueryStringOptions } from "@qson/js";
+export default function qsonQueryParser(options?: ParseQueryStringOptions): (rawQuery: string) => Obj;
+type Obj = {
+    [key: string]: any;
+};
+export {};
+//# sourceMappingURL=qson-query-parser.d.ts.map

package/dist/types/qson-query-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"qson-query-parser.d.ts","sourceRoot":"","sources":["../../src/qson-query-parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAErE,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,OAAO,GAAC,uBAA4B,cAE1C,MAAM,KAAE,GAAG,CAM5C;AAED,KAAK,GAAG,GAAG;IAAE,CAAC,GAAG,EAAC,MAAM,GAAE,GAAG,CAAA;CAAE,CAAC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@qson/express",
+  "version": "0.2.0",
+  "description": "",
+  "author": "Jarno Parviainen",
+  "license": "MIT",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Daaler/qson.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Daaler/qson/issues"
+  },
+  "homepage": "https://github.com/Daaler/qson",
+  "keywords": [],
+  "type": "module",
+  "main": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@qson/js": "^0.2.2"
+  },
+  "peerDependencies": {
+    "express": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "express": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.6",
+    "express": "^5.2.1",
+    "@qson/dev": "0.1.0"
+  },
+  "scripts": {
+    "test": "pnpm run test:types && node --test --import @qson/dev/test-setup \"**/*.test.js\"",
+    "test:types": "tsc --noEmit",
+    "test1": "node --test --import @qson/dev/test-setup",
+    "lint": "pnpm exec eslint",
+    "build": "pnpm exec qson-build",
+    "clean": "pnpm exec qson-clean",
+    "release": "pnpm exec qson-release --no-branch-check --no-git-checks"
+  }
+}