feat!: Introduce @seamapi/url-search-params-parser behind useLegacyQueryParamsParser

example/lib/middlewares/with-route-spec.ts

@@ -1,8 +1,4 @@
-import {
-  createWithRouteSpec,
-  QueryArrayFormats,
-  UnauthorizedException,
-} from "nextlove"
+import { createWithRouteSpec, UnauthorizedException } from "nextlove"
 import { withAuthToken } from "./with-auth-token"
 import { withUserSession } from "./with-user-session"
 import * as ZT from "lib/zod"
@@ -39,13 +35,10 @@ export const withRouteSpecWithGlobalMiddlewareAfterAuth = createWithRouteSpec({
   ...defaultRouteSpec,
 } as const)
 
-export const withRouteSpecSupportedArrayFormats = (
-  supportedArrayFormats: QueryArrayFormats
-) =>
-  createWithRouteSpec({
-    ...defaultRouteSpec,
-    supportedArrayFormats,
-  })
+export const withRouteSpecNewQueryParamsParser = createWithRouteSpec({
+  ...defaultRouteSpec,
+  useLegacyQueryParamsParser: false,
+} as const)
 
 export const withRouteSpecWithoutValidateGetRequestBody = createWithRouteSpec({
   authMiddlewareMap: { auth_token: withAuthToken },

example/pages/api/todo/legacy-query-params-parser.ts

@@ -0,0 +1,27 @@
+import { withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { z } from "zod"
+
+export const queryParams = z.object({
+  ids: z.array(z.string()),
+  flag: z.boolean().optional(),
+})
+
+// Uses the default factory: the legacy query param parser is the
+// default in v4, so no option is set.
+export const route_spec = checkRouteSpec({
+  methods: ["GET"],
+  auth: "none",
+  jsonResponse: z.object({
+    ok: z.boolean(),
+    ids: z.array(z.string()),
+    flag: z.boolean().optional(),
+  }),
+  queryParams,
+})
+
+export default withRouteSpec(route_spec)(async (req, res) => {
+  return res
+    .status(200)
+    .json({ ok: true, ids: req.query.ids, flag: req.query.flag })
+})

example/pages/api/todo/new-query-params-parser-per-route.ts

@@ -0,0 +1,28 @@
+import { withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { z } from "zod"
+
+export const queryParams = z.object({
+  ids: z.array(z.string()),
+  flag: z.boolean().optional(),
+})
+
+export const route_spec = checkRouteSpec({
+  methods: ["GET"],
+  auth: "none",
+  // The route-level option overrides the factory default (legacy in v4),
+  // so a shared createWithRouteSpec factory can migrate route by route.
+  useLegacyQueryParamsParser: false,
+  jsonResponse: z.object({
+    ok: z.boolean(),
+    ids: z.array(z.string()),
+    flag: z.boolean().optional(),
+  }),
+  queryParams,
+})
+
+export default withRouteSpec(route_spec)(async (req, res) => {
+  return res
+    .status(200)
+    .json({ ok: true, ids: req.query.ids, flag: req.query.flag })
+})

example/pages/api/todo/array-query-brackets.ts → example/pages/api/todo/new-query-params-parser.ts

@@ -1,9 +1,10 @@
-import { withRouteSpecSupportedArrayFormats } from "lib/middlewares"
+import { withRouteSpecNewQueryParamsParser } from "lib/middlewares"
 import { checkRouteSpec } from "nextlove"
 import { z } from "zod"
 
 export const queryParams = z.object({
   ids: z.array(z.string()),
+  flag: z.boolean().optional(),
 })
 
 export const route_spec = checkRouteSpec({
@@ -12,12 +13,15 @@ export const route_spec = checkRouteSpec({
   jsonResponse: z.object({
     ok: z.boolean(),
     ids: z.array(z.string()),
+    flag: z.boolean().optional(),
   }),
   queryParams,
 })
 
-export default withRouteSpecSupportedArrayFormats(["brackets"])(route_spec)(
+export default withRouteSpecNewQueryParamsParser(route_spec)(
   async (req, res) => {
-    return res.status(200).json({ ok: true, ids: req.query.ids })
+    return res
+      .status(200)
+      .json({ ok: true, ids: req.query.ids, flag: req.query.flag })
   }
 )