quote query segments

fix #49
tatethurston · Aug 8, 2022 · 41c1c6b · 41c1c6b
1 parent 694e0ce
commit 41c1c6b
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 17 deletions.
diff --git a/e2e/nextjs-routes.d.ts b/e2e/nextjs-routes.d.ts
@@ -5,7 +5,7 @@
 // prettier-ignore
 declare module "nextjs-routes" {
   export type Route =
-    | { pathname: "/foos/[foo]"; query: Query<{ foo: string }> }
+    | { pathname: "/foos/[foo]"; query: Query<{ "foo": string }> }
     | { pathname: "/"; query?: Query | undefined };
 
   type Query<Params = {}> = Params & { [key: string]: string | string[] | undefined };

diff --git a/examples/src-pages/nextjs-routes.d.ts b/examples/src-pages/nextjs-routes.d.ts
@@ -6,8 +6,8 @@
 declare module "nextjs-routes" {
   export type Route =
     | { pathname: "/api/hello"; query?: Query | undefined }
-    | { pathname: "/bars/[bar]"; query: Query<{ bar: string }> }
-    | { pathname: "/foos/[foo]"; query: Query<{ foo: string }> }
+    | { pathname: "/bars/[bar]"; query: Query<{ "bar": string }> }
+    | { pathname: "/foos/[foo]"; query: Query<{ "foo": string }> }
     | { pathname: "/"; query?: Query | undefined };
 
   type Query<Params = {}> = Params & { [key: string]: string | string[] | undefined };

diff --git a/examples/typescript/nextjs-routes.d.ts b/examples/typescript/nextjs-routes.d.ts
@@ -6,8 +6,8 @@
 declare module "nextjs-routes" {
   export type Route =
     | { pathname: "/api/hello"; query?: Query | undefined }
-    | { pathname: "/bars/[bar]"; query: Query<{ bar: string }> }
-    | { pathname: "/foos/[foo]"; query: Query<{ foo: string }> }
+    | { pathname: "/bars/[bar]"; query: Query<{ "bar": string }> }
+    | { pathname: "/foos/[foo]"; query: Query<{ "foo": string }> }
     | { pathname: "/"; query?: Query | undefined };
 
   type Query<Params = {}> = Params & { [key: string]: string | string[] | undefined };

diff --git a/src/__snapshots__/core.test.ts.snap b/src/__snapshots__/core.test.ts.snap
@@ -97,21 +97,21 @@ Array [
 declare module \\"nextjs-routes\\" {
   export type Route =
     | { pathname: \\"/404\\"; query?: Query | undefined }
-    | { pathname: \\"/[foo]\\"; query: Query<{ foo: string }> }
-    | { pathname: \\"/[foo]/[bar]/[baz]\\"; query: Query<{ foo: string; bar: string; baz: string }> }
-    | { pathname: \\"/[foo]/bar/[baz]\\"; query: Query<{ foo: string; baz: string }> }
-    | { pathname: \\"/[foo]/bar/[baz]/foo/[bar]\\"; query: Query<{ foo: string; baz: string; bar: string }> }
-    | { pathname: \\"/[foo]/baz\\"; query: Query<{ foo: string }> }
+    | { pathname: \\"/[foo]\\"; query: Query<{ \\"foo\\": string }> }
+    | { pathname: \\"/[foo]/[bar]/[baz]\\"; query: Query<{ \\"foo\\": string; \\"bar\\": string; \\"baz\\": string }> }
+    | { pathname: \\"/[foo]/bar/[baz]\\"; query: Query<{ \\"foo\\": string; \\"baz\\": string }> }
+    | { pathname: \\"/[foo]/bar/[baz]/foo/[bar]\\"; query: Query<{ \\"foo\\": string; \\"baz\\": string; \\"bar\\": string }> }
+    | { pathname: \\"/[foo]/baz\\"; query: Query<{ \\"foo\\": string }> }
     | { pathname: \\"/_debug\\"; query?: Query | undefined }
     | { pathname: \\"/_debug/health-check\\"; query?: Query | undefined }
     | { pathname: \\"/api/[[...segments]]\\"; query?: Query | undefined }
-    | { pathname: \\"/api/[...segments]\\"; query: Query<{ segments: string[] }> }
+    | { pathname: \\"/api/[...segments]\\"; query: Query<{ \\"segments\\": string[] }> }
     | { pathname: \\"/api/bar\\"; query?: Query | undefined }
-    | { pathname: \\"/foo/[slug]\\"; query: Query<{ slug: string }> }
+    | { pathname: \\"/foo/[slug]\\"; query: Query<{ \\"slug\\": string }> }
     | { pathname: \\"/\\"; query?: Query | undefined }
     | { pathname: \\"/not-found\\"; query?: Query | undefined }
-    | { pathname: \\"/settings/bars/[bar]\\"; query: Query<{ bar: string }> }
-    | { pathname: \\"/settings/bars/[bar]/baz\\"; query: Query<{ bar: string }> }
+    | { pathname: \\"/settings/bars/[bar]\\"; query: Query<{ \\"bar\\": string }> }
+    | { pathname: \\"/settings/bars/[bar]/baz\\"; query: Query<{ \\"bar\\": string }> }
     | { pathname: \\"/settings/foo\\"; query?: Query | undefined }
     | { pathname: \\"/settings\\"; query?: Query | undefined };
 

diff --git a/src/core.ts b/src/core.ts
@@ -66,14 +66,14 @@ function getQueryInterface(
       switch (value) {
         case "dynamic": {
           requiredKeys += 1;
-          return `${key}: string`;
+          return `"${key}": string`;
         }
         case "catch-all": {
           requiredKeys += 1;
-          return `${key}: string[]`;
+          return `"${key}": string[]`;
         }
         case "optional-catch-all": {
-          return `${key}?: string[] | undefined`;
+          return `"${key}"?: string[] | undefined`;
         }
         // istanbul ignore next
         default: {