fix: dates are only allowed to be Dates in query parameters and request payloads

Author: nlf

lib/build/index.ts

@@ -92,7 +92,14 @@ export function generateClientType(server: Server) {
         name: queryTypeName,
         required: isRequired(route.settings.validate.query as ExtendedSchema),
       };
-      statements.push(typeAliasDeclaration(queryTypeName, generateType(route.settings.validate.query as ExtendedObjectSchema), true));
+      statements.push(
+        typeAliasDeclaration(
+          queryTypeName,
+          // allow dates in query parameters, they'll get stringified appropriately
+          generateType(route.settings.validate.query as ExtendedObjectSchema, { allowDates: true }),
+          true,
+        ),
+      );
     }
 
     if (route.settings.validate?.payload) {
@@ -101,7 +108,14 @@ export function generateClientType(server: Server) {
         name: payloadTypeName,
         required: true,
       };
-      statements.push(typeAliasDeclaration(payloadTypeName, generateType(route.settings.validate.payload as ExtendedObjectSchema), true));
+      statements.push(
+        typeAliasDeclaration(
+          payloadTypeName,
+          // allow dates in payloads, they'll get stringified appropriately
+          generateType(route.settings.validate.payload as ExtendedObjectSchema, { allowDates: true }),
+          true,
+        ),
+      );
     }
 
     // the result type is the type of the actual response from the api

lib/build/nodes.ts

@@ -28,6 +28,7 @@ export type Options = {
   comments?: boolean;
   export?: boolean;
   expression?: boolean;
+  allowDates?: boolean;
 };
 
 export type Property = {

lib/build/types.ts

@@ -61,7 +61,9 @@ export function generateType(schema: Schema, options?: Options): TypeNode {
       node = booleanTypeNode();
       break;
     case "date":
-      node = unionTypeNode([dateTypeNode(), stringTypeNode()]);
+      node = options?.allowDates
+        ? unionTypeNode([dateTypeNode(), stringTypeNode()])
+        : stringTypeNode();
       break;
     case "number":
       node = numberTypeNode();

lib/index.ts

@@ -70,10 +70,10 @@ export class Client<T extends Route> {
         // it handles actually calling .toString() on the values for us
         if (Array.isArray(value)) {
           for (const v of value) {
-            query.append(key, v as string);
+            query.append(key, v instanceof Date ? v.toISOString() : v as string);
           }
         } else {
-          query.set(key, value as string);
+          query.set(key, value instanceof Date ? value.toISOString() : value as string);
         }
       }
     }

test/fetch.ts

@@ -65,6 +65,17 @@ await test("fetch()", async (t) => {
     t.assert.equal(multiRes.status, 200);
     t.assert.equal(multiRes.url, `${server.info.uri}/query?multi=one&multi=three+four`);
     t.assert.deepStrictEqual<SpecificBodyType<routeType, 200>>(multiRes.body, { flag: false, multi: ["one", "three four"] });
+
+    const now = new Date();
+    const stringDateRes = await client.get("/query", { query: { date: now.toISOString() } });
+    t.assert.equal(stringDateRes.status, 200);
+    t.assert.equal(stringDateRes.url, `${server.info.uri}/query?date=${encodeURIComponent(now.toISOString())}`);
+    t.assert.deepStrictEqual<SpecificBodyType<routeType, 200>>(stringDateRes.body, { flag: false, date: now.toISOString() });
+
+    const dateDateRes = await client.get("/query", { query: { date: now } });
+    t.assert.equal(dateDateRes.status, 200);
+    t.assert.equal(dateDateRes.url, `${server.info.uri}/query?date=${encodeURIComponent(now.toISOString())}`);
+    t.assert.deepStrictEqual<SpecificBodyType<routeType, 200>>(dateDateRes.body, { flag: false, date: now.toISOString() });
   });
 
   await t.test("GET /param/{param}", async (t: TestContext) => {

test/fixture.ts

@@ -30,15 +30,20 @@ server.route([
         query: Joi.object({
           flag: Joi.boolean().default(false),
           multi: Joi.array().items(Joi.string()),
+          date: Joi.date(),
         }),
       },
       response: {
         status: {
-          200: Joi.object({ flag: Joi.boolean().required(), multi: Joi.array().items(Joi.string()) }),
+          200: Joi.object({
+            flag: Joi.boolean().required(),
+            multi: Joi.array().items(Joi.string()),
+            date: Joi.date(),
+          }),
         },
       },
-      handler(request: Request<{ Query: { flag: boolean; multi?: string[] } }>) {
-        return { flag: request.query.flag, multi: request.query.multi };
+      handler(request: Request<{ Query: { flag: boolean; multi?: string[]; date?: Date } }>) {
+        return { flag: request.query.flag, multi: request.query.multi, date: request.query.date };
       },
     },
   },

test/inject.ts

@@ -33,6 +33,17 @@ await test("server.inject()", async (t) => {
     t.assert.equal(multiRes.status, 200);
     t.assert.equal(multiRes.url, "/query?multi=one&multi=three+four");
     t.assert.deepStrictEqual<SpecificBodyType<routeType, 200>>(multiRes.body, { flag: false, multi: ["one", "three four"] });
+
+    const now = new Date();
+    const stringDateRes = await client.get("/query", { query: { date: now.toISOString() } });
+    t.assert.equal(stringDateRes.status, 200);
+    t.assert.equal(stringDateRes.url, `/query?date=${encodeURIComponent(now.toISOString())}`);
+    t.assert.deepStrictEqual<SpecificBodyType<routeType, 200>>(stringDateRes.body, { flag: false, date: now.toISOString() });
+
+    const dateDateRes = await client.get("/query", { query: { date: now } });
+    t.assert.equal(dateDateRes.status, 200);
+    t.assert.equal(dateDateRes.url, `/query?date=${encodeURIComponent(now.toISOString())}`);
+    t.assert.deepStrictEqual<SpecificBodyType<routeType, 200>>(dateDateRes.body, { flag: false, date: now.toISOString() });
   });
 
   await t.test("GET /param/{param}", async (t: TestContext) => {