fix: allow pathParams to be reactive getter (#39)

* fix: allow pathParams to be a object ref * refactor: use reactive getter for `pathParams` --------- Co-authored-by: Johann Schopplich <[email protected]>
johannschopplich · Aug 26, 2023 · 41bd30e · 41bd30e
1 parent e5537f7
commit 41bd30e
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 8 deletions.
diff --git a/docs/guide/openapi-types.md b/docs/guide/openapi-types.md
@@ -145,6 +145,18 @@ const data = await $myApi('foo/{id}', {
 })
 ```
 
+For reactive `pathParams`, pass a ref or getter function instead of a plain object.
+
+```ts
+const id = ref(10)
+
+const data = await $myApi('foo/{id}', {
+  pathParams: () => ({
+    id: id.value
+  })
+})
+```
+
 ::: warning
 Issues will **NOT** be reported at runtime by `nuxt-api-party` if the wrong parameters are used. The **incomplete** path will be sent to the backend **AS IS**.
 :::

diff --git a/playground/pages/petStore.vue b/playground/pages/petStore.vue
@@ -25,8 +25,8 @@ async function updateUser() {
     })
     await execute()
   }
-  catch (e) {
-    console.error(e)
+  catch (error) {
+    console.error(error)
   }
 }
 
@@ -50,8 +50,8 @@ async function fetchPetData(petId: number) {
       },
     })
   }
-  catch (e) {
-    console.error(e)
+  catch (error) {
+    console.error(error)
   }
 }
 

diff --git a/src/runtime/composables/useApiData.ts b/src/runtime/composables/useApiData.ts
@@ -51,7 +51,7 @@ export type UseApiDataOptions<T> = Pick<
   | 'retryDelay'
   | 'timeout'
 > & {
-  pathParams?: MaybeRef<Record<string, string>>
+  pathParams?: MaybeRefOrGetter<Record<string, string>>
   body?: MaybeRef<string | Record<string, any> | FormData | null | undefined>
 } & BaseUseApiDataOptions<T>
 

diff --git a/src/runtime/utils.ts b/src/runtime/utils.ts
@@ -41,12 +41,11 @@ export async function deserializeMaybeEncodedBody(value: ApiFetchOptions['body']
   return value
 }
 
-export function resolvePath(path: string, params?: Record<string, string>) {
+export function resolvePath(path: string, params?: Record<string, unknown>) {
   // To simplify typings, OpenAPI path parameters can be expanded here
   if (params) {
     return Object.entries(params).reduce(
-      (path, [name, value]) =>
-        path.replace(`{${name}}`, encodeURIComponent(value)),
+      (path, [name, value]) => path.replace(`{${name}}`, encodeURIComponent(String(value))),
       path,
     )
   }