Merge pull request #1010 from hey-api/fix/tanstack-query-key-client

fix: set query key base url from supplied client if provided
hey-api · Sep 4, 2024 · 12df29b · 12df29b
2 parents a254df1 + b6e58c6
commit 12df29b
Show file tree

Hide file tree

Showing 31 changed files with 77 additions and 69 deletions.
diff --git a/.changeset/olive-tables-swim.md b/.changeset/olive-tables-swim.md
@@ -0,0 +1,8 @@
+---
+'@example/openapi-ts-tanstack-svelte-query': patch
+'@example/openapi-ts-tanstack-react-query': patch
+'@example/openapi-ts-tanstack-vue-query': patch
+'@hey-api/openapi-ts': patch
+---
+
+fix: set query key base url from supplied client if provided
diff --git a/docs/openapi-ts/output.md b/docs/openapi-ts/output.md
@@ -209,7 +209,7 @@ client.post({
 Schemas are located in the `schemas.gen.ts` file. This file contains runtime schemas generated from your OpenAPI specification definitions located in `#/components/schemas`. Starting with OpenAPI 3.1, these schemas are JSON Schema compliant.
 
 ```ts
-export const $Pet = {
+export const PetSchema = {
   required: ['name'],
   properties: {
     id: {

diff --git a/examples/openapi-ts-axios/src/App.tsx b/examples/openapi-ts-axios/src/App.tsx
@@ -17,7 +17,7 @@ import {
 } from '@radix-ui/themes';
 import { useState } from 'react';
 
-import { $Pet } from './client/schemas.gen';
+import { PetSchema } from './client/schemas.gen';
 import { addPet, getPetById, updatePet } from './client/services.gen';
 import type { Pet } from './client/types.gen';
 
@@ -54,7 +54,7 @@ function App() {
 
   const onAddPet = async (formData: FormData) => {
     // simple form field validation to demonstrate using schemas
-    if ($Pet.required.includes('name') && !formData.get('name')) {
+    if (PetSchema.required.includes('name') && !formData.get('name')) {
       setIsRequiredNameError(true);
       return;
     }

diff --git a/examples/openapi-ts-axios/src/client/schemas.gen.ts b/examples/openapi-ts-axios/src/client/schemas.gen.ts
@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export const $Order = {
+export const OrderSchema = {
   properties: {
     complete: {
       type: 'boolean',
@@ -38,7 +38,7 @@ export const $Order = {
   },
 } as const;
 
-export const $Customer = {
+export const CustomerSchema = {
   properties: {
     address: {
       items: {
@@ -66,7 +66,7 @@ export const $Customer = {
   },
 } as const;
 
-export const $Address = {
+export const AddressSchema = {
   properties: {
     city: {
       example: 'Palo Alto',
@@ -91,7 +91,7 @@ export const $Address = {
   },
 } as const;
 
-export const $Category = {
+export const CategorySchema = {
   properties: {
     id: {
       example: 1,
@@ -110,7 +110,7 @@ export const $Category = {
   },
 } as const;
 
-export const $User = {
+export const UserSchema = {
   properties: {
     email: {
       example: '[email protected]',
@@ -155,7 +155,7 @@ export const $User = {
   },
 } as const;
 
-export const $Tag = {
+export const TagSchema = {
   properties: {
     id: {
       format: 'int64',
@@ -172,7 +172,7 @@ export const $Tag = {
   },
 } as const;
 
-export const $Pet = {
+export const PetSchema = {
   properties: {
     category: {
       $ref: '#/components/schemas/Category',
@@ -224,7 +224,7 @@ export const $Pet = {
   },
 } as const;
 
-export const $ApiResponse = {
+export const ApiResponseSchema = {
   properties: {
     code: {
       format: 'int32',

diff --git a/examples/openapi-ts-fetch/src/App.tsx b/examples/openapi-ts-fetch/src/App.tsx
@@ -17,7 +17,7 @@ import {
 } from '@radix-ui/themes';
 import { useState } from 'react';
 
-import { $Pet } from './client/schemas.gen';
+import { PetSchema } from './client/schemas.gen';
 import { addPet, getPetById, updatePet } from './client/services.gen';
 import type { Pet } from './client/types.gen';
 
@@ -54,7 +54,7 @@ function App() {
 
   const onAddPet = async (formData: FormData) => {
     // simple form field validation to demonstrate using schemas
-    if ($Pet.required.includes('name') && !formData.get('name')) {
+    if (PetSchema.required.includes('name') && !formData.get('name')) {
       setIsRequiredNameError(true);
       return;
     }

diff --git a/examples/openapi-ts-fetch/src/client/schemas.gen.ts b/examples/openapi-ts-fetch/src/client/schemas.gen.ts
@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export const $Order = {
+export const OrderSchema = {
   properties: {
     complete: {
       type: 'boolean',
@@ -38,7 +38,7 @@ export const $Order = {
   },
 } as const;
 
-export const $Customer = {
+export const CustomerSchema = {
   properties: {
     address: {
       items: {
@@ -66,7 +66,7 @@ export const $Customer = {
   },
 } as const;
 
-export const $Address = {
+export const AddressSchema = {
   properties: {
     city: {
       example: 'Palo Alto',
@@ -91,7 +91,7 @@ export const $Address = {
   },
 } as const;
 
-export const $Category = {
+export const CategorySchema = {
   properties: {
     id: {
       example: 1,
@@ -110,7 +110,7 @@ export const $Category = {
   },
 } as const;
 
-export const $User = {
+export const UserSchema = {
   properties: {
     email: {
       example: '[email protected]',
@@ -155,7 +155,7 @@ export const $User = {
   },
 } as const;
 
-export const $Tag = {
+export const TagSchema = {
   properties: {
     id: {
       format: 'int64',
@@ -172,7 +172,7 @@ export const $Tag = {
   },
 } as const;
 
-export const $Pet = {
+export const PetSchema = {
   properties: {
     category: {
       $ref: '#/components/schemas/Category',
@@ -224,7 +224,7 @@ export const $Pet = {
   },
 } as const;
 
-export const $ApiResponse = {
+export const ApiResponseSchema = {
   properties: {
     code: {
       format: 'int32',

diff --git a/examples/openapi-ts-tanstack-react-query/src/App.tsx b/examples/openapi-ts-tanstack-react-query/src/App.tsx
@@ -23,7 +23,7 @@ import {
   getPetByIdOptions,
   updatePetMutation,
 } from './client/@tanstack/react-query.gen';
-import { $Pet } from './client/schemas.gen';
+import { PetSchema } from './client/schemas.gen';
 import type { Pet } from './client/types.gen';
 
 const localClient = createClient({
@@ -92,7 +92,7 @@ function App() {
 
   const onAddPet = async (formData: FormData) => {
     // simple form field validation to demonstrate using schemas
-    if ($Pet.required.includes('name') && !formData.get('name')) {
+    if (PetSchema.required.includes('name') && !formData.get('name')) {
       setIsRequiredNameError(true);
       return;
     }

diff --git a/examples/openapi-ts-tanstack-react-query/src/client/@tanstack/react-query.gen.ts b/examples/openapi-ts-tanstack-react-query/src/client/@tanstack/react-query.gen.ts
@@ -77,7 +77,7 @@ const createQueryKey = <TOptions extends Options>(
 ): QueryKey<TOptions>[0] => {
   const params: QueryKey<TOptions>[0] = {
     _id: id,
-    baseUrl: client.getConfig().baseUrl,
+    baseUrl: (options?.client ?? client).getConfig().baseUrl,
   } as QueryKey<TOptions>[0];
   if (infinite) {
     params._infinite = infinite;

diff --git a/examples/openapi-ts-tanstack-react-query/src/client/schemas.gen.ts b/examples/openapi-ts-tanstack-react-query/src/client/schemas.gen.ts
@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export const $Order = {
+export const OrderSchema = {
   properties: {
     complete: {
       type: 'boolean',
@@ -38,7 +38,7 @@ export const $Order = {
   },
 } as const;
 
-export const $Customer = {
+export const CustomerSchema = {
   properties: {
     address: {
       items: {
@@ -66,7 +66,7 @@ export const $Customer = {
   },
 } as const;
 
-export const $Address = {
+export const AddressSchema = {
   properties: {
     city: {
       example: 'Palo Alto',
@@ -91,7 +91,7 @@ export const $Address = {
   },
 } as const;
 
-export const $Category = {
+export const CategorySchema = {
   properties: {
     id: {
       example: 1,
@@ -110,7 +110,7 @@ export const $Category = {
   },
 } as const;
 
-export const $User = {
+export const UserSchema = {
   properties: {
     email: {
       example: '[email protected]',
@@ -155,7 +155,7 @@ export const $User = {
   },
 } as const;
 
-export const $Tag = {
+export const TagSchema = {
   properties: {
     id: {
       format: 'int64',
@@ -172,7 +172,7 @@ export const $Tag = {
   },
 } as const;
 
-export const $Pet = {
+export const PetSchema = {
   properties: {
     category: {
       $ref: '#/components/schemas/Category',
@@ -224,7 +224,7 @@ export const $Pet = {
   },
 } as const;
 
-export const $ApiResponse = {
+export const ApiResponseSchema = {
   properties: {
     code: {
       format: 'int32',

diff --git a/examples/openapi-ts-tanstack-svelte-query/src/client/@tanstack/svelte-query.gen.ts b/examples/openapi-ts-tanstack-svelte-query/src/client/@tanstack/svelte-query.gen.ts
@@ -77,7 +77,7 @@ const createQueryKey = <TOptions extends Options>(
 ): QueryKey<TOptions>[0] => {
   const params: QueryKey<TOptions>[0] = {
     _id: id,
-    baseUrl: client.getConfig().baseUrl,
+    baseUrl: (options?.client ?? client).getConfig().baseUrl,
   } as QueryKey<TOptions>[0];
   if (infinite) {
     params._infinite = infinite;

diff --git a/examples/openapi-ts-tanstack-svelte-query/src/client/schemas.gen.ts b/examples/openapi-ts-tanstack-svelte-query/src/client/schemas.gen.ts
@@ -1,6 +1,6 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export const $Order = {
+export const OrderSchema = {
   properties: {
     complete: {
       type: 'boolean',
@@ -38,7 +38,7 @@ export const $Order = {
   },
 } as const;
 
-export const $Customer = {
+export const CustomerSchema = {
   properties: {
     address: {
       items: {
@@ -66,7 +66,7 @@ export const $Customer = {
   },
 } as const;
 
-export const $Address = {
+export const AddressSchema = {
   properties: {
     city: {
       example: 'Palo Alto',
@@ -91,7 +91,7 @@ export const $Address = {
   },
 } as const;
 
-export const $Category = {
+export const CategorySchema = {
   properties: {
     id: {
       example: 1,
@@ -110,7 +110,7 @@ export const $Category = {
   },
 } as const;
 
-export const $User = {
+export const UserSchema = {
   properties: {
     email: {
       example: '[email protected]',
@@ -155,7 +155,7 @@ export const $User = {
   },
 } as const;
 
-export const $Tag = {
+export const TagSchema = {
   properties: {
     id: {
       format: 'int64',
@@ -172,7 +172,7 @@ export const $Tag = {
   },
 } as const;
 
-export const $Pet = {
+export const PetSchema = {
   properties: {
     category: {
       $ref: '#/components/schemas/Category',
@@ -224,7 +224,7 @@ export const $Pet = {
   },
 } as const;
 
-export const $ApiResponse = {
+export const ApiResponseSchema = {
   properties: {
     code: {
       format: 'int32',

diff --git a/examples/openapi-ts-tanstack-vue-query/src/client/@tanstack/vue-query.gen.ts b/examples/openapi-ts-tanstack-vue-query/src/client/@tanstack/vue-query.gen.ts
@@ -73,7 +73,7 @@ const createQueryKey = <TOptions extends Options>(
 ): QueryKey<TOptions>[0] => {
   const params: QueryKey<TOptions>[0] = {
     _id: id,
-    baseUrl: client.getConfig().baseUrl
+    baseUrl: (options?.client ?? client).getConfig().baseUrl
   } as QueryKey<TOptions>[0]
   if (infinite) {
     params._infinite = infinite