feat: Merge pull request #13 from seamapi/feat-filter-and-remap-helper

Author: codetheweb

src/helpers.ts

@@ -0,0 +1,24 @@
+import type { Replace, Except } from "type-fest"
+import { APIDef, RouteDef } from "./route-def"
+
+/**
+ * Use this to select a subset of your routes and strip a prefix from the route path.
+ *
+ * Not currently supported for the RouteDef[] input syntax.
+ */
+export type FilterByAndStripPrefix<
+  Prefix extends `/${string}/`,
+  API extends APIDef
+> = API extends Record<string, RouteDef>
+  ? {
+      [K in keyof API as Replace<
+        K extends string ? K : never,
+        Prefix,
+        "/"
+      >]: K extends `${Prefix}${string}`
+        ? Except<API[K], "route"> & {
+            route: Replace<API[K]["route"], Prefix, "/">
+          }
+        : never
+    }
+  : never

src/http-method.ts

@@ -0,0 +1,8 @@
+export type HTTPMethod =
+  | "GET"
+  | "POST"
+  | "PUT"
+  | "DELETE"
+  | "PATCH"
+  | "OPTIONS"
+  | "HEAD"

src/index.ts

@@ -1,33 +1,7 @@
 import type { AxiosResponse, AxiosRequestConfig, AxiosInstance } from "axios"
 import type { Except, SetRequired, Simplify, Split } from "type-fest"
-
-export type HTTPMethod =
-  | "GET"
-  | "POST"
-  | "PUT"
-  | "DELETE"
-  | "PATCH"
-  | "OPTIONS"
-  | "HEAD"
-
-export type RouteDef = {
-  route: string
-  method: HTTPMethod
-  queryParams?: Record<string, any>
-  jsonBody?: Record<string, any>
-  commonParams?: Record<string, any>
-  formData?: Record<string, any>
-  jsonResponse?: Record<string, any>
-  // TODO support error responses
-}
-
-export type APIDef = Record<string, RouteDef> | RouteDef[]
-
-export type APIDefToUnion<Routes extends APIDef> = Routes extends RouteDef[]
-  ? Routes[number]
-  : Routes extends Record<string, RouteDef>
-  ? Routes[keyof Routes]
-  : never
+import { APIDef, APIDefToUnion, RouteDef } from "./route-def"
+import { HTTPMethod } from "./http-method"
 
 // Given a union of {method: "GET" | "POST", ...} | {method: "PATCH", ...} converts it to a union of
 // {method: "GET", ...} | {method: "POST", ...} | {method: "PATCH", ...}
@@ -211,3 +185,6 @@ export const createTypedURLSearchParams = <T>(
 ): TypedURLSearchParams<T> => {
   return new URLSearchParams(data as any)
 }
+
+export * from "./helpers"
+export * from "./route-def"

src/route-def.ts

@@ -0,0 +1,20 @@
+import { HTTPMethod } from "./http-method"
+
+export type RouteDef = {
+  route: string
+  method: HTTPMethod
+  queryParams?: Record<string, any>
+  jsonBody?: Record<string, any>
+  commonParams?: Record<string, any>
+  formData?: Record<string, any>
+  jsonResponse?: Record<string, any>
+  // TODO support error responses
+}
+
+export type APIDef = Record<string, RouteDef> | RouteDef[]
+
+export type APIDefToUnion<Routes extends APIDef> = Routes extends RouteDef[]
+  ? Routes[number]
+  : Routes extends Record<string, RouteDef>
+  ? Routes[keyof Routes]
+  : never

tests/example-route-types.ts

@@ -120,6 +120,38 @@ export type ExampleRouteTypes4 = {
   }
 }
 
+export type DifferentDomainsAsPathsExample = {
+  "/example.com/things/create": {
+    route: "/example.com/things/create"
+    method: "POST"
+    queryParams: {}
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      thing: {
+        thing_id: string
+        name: string
+        created_at: string
+      }
+    }
+  }
+
+  "/foo.example.com/things/create": {
+    route: "/foo.example.com/things/create"
+    method: "POST"
+    queryParams: {}
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      thing_from_foo: {
+        thing_id: string
+        name: string
+        created_at: string
+      }
+    }
+  }
+}
+
 export type WildcardAndSpecificEndpointExample = {
   "/things/[thing_id]": {
     route: "/things/[thing_id]"

tests/main.test.ts

@@ -1,8 +1,13 @@
 import { toFormData } from "axios"
 import test from "ava"
 import { expectTypeOf } from "expect-type"
-import { TypedAxios, createTypedURLSearchParams } from "../src"
 import {
+  FilterByAndStripPrefix,
+  TypedAxios,
+  createTypedURLSearchParams,
+} from "../src"
+import {
+  DifferentDomainsAsPathsExample,
   ExampleRouteTypes1,
   ExampleRouteTypes3,
   ExampleRouteTypes4,
@@ -132,3 +137,31 @@ test("can create FormData", async (t) => {
   t.is(encodedData.get("resourceId"), formData.resourceId.toString())
   t.is(encodedData.get("slug"), formData.slug)
 })
+
+test.failing("", async (t) => {
+  const axios: TypedAxios<
+    FilterByAndStripPrefix<"/example.com/", DifferentDomainsAsPathsExample>
+  > = null as any
+
+  const createResponse = await axios.post("/things/create", {})
+  expectTypeOf(createResponse.data).toMatchTypeOf<{
+    thing: {
+      thing_id: string
+      name: string
+      created_at: string
+    }
+  }>()
+
+  const fooAxios: TypedAxios<
+    FilterByAndStripPrefix<"/foo.example.com/", DifferentDomainsAsPathsExample>
+  > = null as any
+
+  const fooCreateResponse = await fooAxios.post("/things/create", {})
+  expectTypeOf(fooCreateResponse.data).toMatchTypeOf<{
+    thing_from_foo: {
+      thing_id: string
+      name: string
+      created_at: string
+    }
+  }>()
+})