@ts-rest/express - npm Package Compare versions

Comparing version 3.11.2 to 3.12.0

CHANGELOG.md

 # @ts-rest/express
 
+## 3.12.0
+
+### Minor Changes
+
+- 5a13803: Allow typed query parameters by encoding them as JSON strings (disabled by default)
+
 ## 3.11.2
@@ -4,0 +10,0 @@

package.json

 {
   "name": "@ts-rest/express",
-  "version": "3.11.2",
+  "version": "3.12.0",
   "peerDependenciesMeta": {
@@ -15,3 +15,3 @@ "zod": {
     "zod": "3.x.x",
-    "@ts-rest/core": "3.11.2",
+    "@ts-rest/core": "3.12.0",
     "@swc/helpers": "0.4.11"
@@ -18,0 +18,0 @@ },

src/lib/ts-rest-express.d.ts

@@ -31,8 +31,10 @@ /// <reference types="node" />
 };
+type Options = {
+    logInitialization?: boolean;
+    jsonQuery?: boolean;
+};
 export declare const initServer: () => {
     router: <T extends AppRouter>(router: T, args: RecursiveRouterObj<T>) => RecursiveRouterObj<T>;
 };
-export declare const createExpressEndpoints: <T extends RecursiveRouterObj<TRouter>, TRouter extends AppRouter>(schema: TRouter, router: T, app: IRouter, options?: {
-    logInitialization: boolean;
-}) => void;
+export declare const createExpressEndpoints: <T extends RecursiveRouterObj<TRouter>, TRouter extends AppRouter>(schema: TRouter, router: T, app: IRouter, options?: Options) => void;
 export {};

src/lib/ts-rest-express.js

@@ -35,3 +35,4 @@ "use strict";
     app.get(schema.path, async (req, res, next)=>{
-        const queryResult = (0, _core.checkZodSchema)(req.query, schema.query);
+        const query = options.jsonQuery ? (0, _core.parseJsonQueryObject)(req.query) : req.query;
+        const queryResult = (0, _core.checkZodSchema)(query, schema.query);
         if (!queryResult.success) {
@@ -65,3 +66,4 @@ return res.status(400).send(queryResult.error);
     const callback = async (req, res, next)=>{
-        const queryResult = (0, _core.checkZodSchema)(req.query, schema.query);
+        const query = options.jsonQuery ? (0, _core.parseJsonQueryObject)(req.query) : req.query;
+        const queryResult = (0, _core.checkZodSchema)(query, schema.query);
         if (!queryResult.success) {
@@ -115,3 +117,4 @@ return res.status(400).send(queryResult.error);
 const createExpressEndpoints = (schema, router, app, options = {
-    logInitialization: true
+    logInitialization: true,
+    jsonQuery: false
 })=>{
@@ -118,0 +121,0 @@ recursivelyApplyExpressRouter(router, [], (route, path)=>{

No alert changes

Improved metrics

Total package byte prevSize

23090

increased by4.44%

Lines of code

176

increased by2.92%

No dependency changes