feat: allow configuring the query string parser

Author: thetutlage

src/define_config.ts

@@ -30,6 +30,13 @@ export function defineConfig(config: Partial<ServerConfig>): ServerConfig {
       secure: false,
       sameSite: false,
     },
+    qs: {
+      depth: 5,
+      parameterLimit: 1000,
+      allowSparse: false,
+      arrayLimit: 20,
+      comma: true,
+    },
     ...config,
   }
 

src/request.ts

@@ -117,7 +117,7 @@ export class Request extends Macroable {
    */
   #parseQueryString() {
     if (this.parsedUrl.query) {
-      this.updateQs(qs.parse(this.parsedUrl.query))
+      this.updateQs(qs.parse(this.parsedUrl.query, this.#config.qs))
       this.#originalRequestData = { ...this.#requestData }
     }
   }

src/types/request.ts

@@ -45,6 +45,50 @@ export type RequestConfig = {
   /**
    * A callback function to trust proxy ip addresses. You must use
    * the `proxy-addr` package to compute this value.
+   *
+   * Defaults to: "proxyAddr.compile('loopback')"
    */
   trustProxy: (address: string, distance: number) => boolean
+
+  /**
+   * Options to control query string parsing
+   */
+  qs: {
+    /**
+     * Nesting depth till the parameters should be parsed.
+     *
+     * Defaults to 5
+     */
+    depth: number
+
+    /**
+     * Number of parameters to parse.
+     *
+     * Defaults to 1000
+     */
+    parameterLimit: number
+
+    /**
+     * Allow sparse elements in an array.
+     *
+     * Defaults to false
+     */
+    allowSparse: boolean
+
+    /**
+     * The max limimit for the array indices. After the given limit
+     * the array indices will be converted to an object, where the
+     * index is the key.
+     *
+     * Defaults to 20
+     */
+    arrayLimit: number
+
+    /**
+     * Join comma seperated query string values to an array
+     *
+     * Defaults to false
+     */
+    comma: boolean
+  }
 }