fix: add missing optional parameter type inference

serverless-seoul · Sep 25, 2020 · 96714b5 · 96714b5
1 parent 9ddcd07
commit 96714b5
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 8 deletions.
diff --git a/src/__test__/e2e/complex_api_spec.ts b/src/__test__/e2e/complex_api_spec.ts
@@ -35,6 +35,7 @@ describe("Calling complex API", () => {
             children: [
               Route.POST("", { operationId: "follow" }, {
                 testId: Parameter.Query(Type.Number()),
+                optional: Parameter.Query(Type.Optional(Type.String())),
                 update: Parameter.Body(Type.Object({
                   fieldA: Type.Number(),
                 })),
@@ -44,6 +45,7 @@ describe("Calling complex API", () => {
 
                 return this.json({
                   testId,
+                  optional: this.params.optional,
                   userId,
                   update: this.params.update,
                 });

diff --git a/src/__test__/routing-context_spec.ts b/src/__test__/routing-context_spec.ts
@@ -206,11 +206,7 @@ describe("RoutingContext", () => {
           ),
         });
 
-        expect(context.params).to.deep.eq({
-          // update: {
-          //   complex: null,
-          // },
-        });
+        expect(context.params).to.deep.eq({});
       });
     });
   });

diff --git a/src/routing-context.ts b/src/routing-context.ts
@@ -1,4 +1,4 @@
-import { Static, TStatic, Type } from "@serverless-seoul/typebox";
+import { Static, TOptional, TStatic, Type } from "@serverless-seoul/typebox";
 import * as Ajv from "ajv";
 import * as _ from "lodash";
 import * as qs from "qs";
@@ -15,6 +15,14 @@ const ajv = new Ajv({
   removeAdditional: "all",
 });
 
+type NamespaceParameterType<T extends { [P in keyof T]: TStatic }> = string extends keyof T
+  ? {}
+  : { [P in keyof T]: Static<T[P]> };
+
+type RouteParameterType<T extends { [P in keyof T]: ParameterDefinition<any> }> = string extends keyof T
+  ? {}
+  : { [P in keyof T]: T[P] extends TOptional<any> ? Static<T[P]["def"]> : Static<T[P]> };
+
 // ---- RoutingContext
 export class RoutingContext<
   T extends { [P in keyof T]: ParameterDefinition<any> },
@@ -56,8 +64,12 @@ export class RoutingContext<
     }
   }
   private readonly validatedParams:
-    (string extends keyof U ? {} : { [P in keyof U]: Static<U[P]> }) &
-    (string extends keyof T ? {} : { [P in keyof T]: Static<T[P]["def"]> }) &
+    // Inferred Namespace Parameter
+    NamespaceParameterType<U> &
+    // Inferred Route Parameter
+    RouteParameterType<T> &
+    // Unknown keys should be unknown type
+    // Below type is just for assigning custom parameter in Namespace#before
     { [key: string]: unknown };
   private normalizedHeaders: { [key: string]: string } | null;