Merge pull request #2718 from hey-api/feat/import-file-extension

feat(config): add output.importFileExtension option

Author: mrlubos

.changeset/pretty-deers-change.md

@@ -0,0 +1,21 @@
+---
+'@hey-api/openapi-ts': minor
+---
+
+refactor(config): replace 'off' with null to disable options
+
+### Updated `output` options
+
+We made the `output` configuration more consistent by using `null` to represent disabled options. This change does not affect boolean options.
+
+```js
+export default {
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
+  output: {
+    format: null,
+    lint: null,
+    path: 'src/client',
+    tsConfigPath: null,
+  },
+};
+```

.changeset/red-bats-eat.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+feat(config): add `output.importFileExtension` option

.changeset/refactor-pinia-colada-query.md

@@ -3,3 +3,48 @@
 ---
 
 feat(pinia-colada): query options use `defineQueryOptions`
+
+### Updated Pinia Colada query options
+
+Pinia Colada query options now use `defineQueryOptions` to improve reactivity support. Instead of calling the query options function, you can use one of the following approaches.
+
+#### No params
+
+```ts
+useQuery(getPetsQuery);
+```
+
+#### Constant
+
+```ts
+useQuery(getPetByIdQuery, () => ({
+  path: {
+    petId: 1,
+  },
+}));
+```
+
+#### Reactive
+
+```ts
+const petId = ref<number | null>(1);
+
+useQuery(getPetByIdQuery, () => ({
+  path: {
+    petId: petId.value,
+  },
+}));
+```
+
+#### Properties
+
+```ts
+const petId = ref<number | null>(1);
+
+useQuery(() => ({
+  ...getPetByIdQuery({
+    path: { petId: petId.value as number },
+  }),
+  enabled: () => petId.value != null,
+}));
+```

docs/openapi-ts/configuration/output.md

@@ -80,7 +80,7 @@ export default {
 };
 ```
 
-```js [off]
+```js [disabled]
 export default {
   input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: {
@@ -106,17 +106,77 @@ export default {
 
 :::
 
+## Import File Extension
+
+You can customize the extension used for imported TypeScript files.
+
+::: code-group
+
+```js [default]
+export default {
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
+  output: {
+    importFileExtension: undefined, // [!code ++]
+    path: 'src/client',
+  },
+};
+```
+
+```js [disabled]
+export default {
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
+  output: {
+    importFileExtension: null, // [!code ++]
+    path: 'src/client',
+  },
+};
+```
+
+```js [js]
+export default {
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
+  output: {
+    importFileExtension: '.js', // [!code ++]
+    path: 'src/client',
+  },
+};
+```
+
+```js [ts]
+export default {
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
+  output: {
+    importFileExtension: '.ts', // [!code ++]
+    path: 'src/client',
+  },
+};
+```
+
+:::
+
+By default, we don't add a file extension and let the runtime resolve it.
+
+```js
+import foo from './foo';
+```
+
+If we detect a [TSConfig file](#tsconfig-path) with `moduleResolution` option set to `nodenext`, we default the extension to `.js`.
+
+```js
+import foo from './foo.js';
+```
+
 ## Format
 
-To format your output folder contents, set `output.format` to a valid formatter.
+To format your output folder contents, set `format` to a valid formatter.
 
 ::: code-group
 
 ```js [disabled]
 export default {
   input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: {
-    format: false, // [!code ++]
+    format: null, // [!code ++]
     path: 'src/client',
   },
 };
@@ -148,15 +208,15 @@ You can also prevent your output from being formatted by adding your output path
 
 ## Lint
 
-To lint your output folder contents, set `output.lint` to a valid linter.
+To lint your output folder contents, set `lint` to a valid linter.
 
 ::: code-group
 
 ```js [disabled]
 export default {
   input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: {
-    lint: false, // [!code ++]
+    lint: null, // [!code ++]
     path: 'src/client',
   },
 };
@@ -198,10 +258,20 @@ You can also prevent your output from being linted by adding your output path to
 
 ## TSConfig Path
 
-We use the [TSConfig file](https://www.typescriptlang.org/tsconfig/) to generate output matching your project's settings. By default, we attempt to find a TSConfig file starting from the location of the `@hey-api/openapi-ts` configuration file and traversing up. If your file is located in a different place or you want to disable this setting, set `output.tsConfigPath` to a string.
+We use the [TSConfig file](https://www.typescriptlang.org/tsconfig/) to generate output matching your project's settings. By default, we attempt to find a TSConfig file starting from the location of the `@hey-api/openapi-ts` configuration file and traversing up.
 
 ::: code-group
 
+```js [default]
+export default {
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
+  output: {
+    path: 'src/client',
+    tsConfigPath: undefined, // [!code ++]
+  },
+};
+```
+
 ```js [custom]
 export default {
   input: 'hey-api/backend', // sign up at app.heyapi.dev
@@ -212,12 +282,12 @@ export default {
 };
 ```
 
-```js [off]
+```js [disabled]
 export default {
   input: 'hey-api/backend', // sign up at app.heyapi.dev
   output: {
     path: 'src/client',
-    tsConfigPath: 'off', // [!code ++]
+    tsConfigPath: null, // [!code ++]
   },
 };
 ```
@@ -226,7 +296,7 @@ export default {
 
 ## Custom Files
 
-By default, you can't keep custom files in the `output.path` folder because it's emptied on every run. If you're sure you need to disable this behavior, set `output.clean` to `false`.
+By default, you can't keep custom files in the `path` folder because it's emptied on every run. If you're sure you need to disable this behavior, set `clean` to `false`.
 
 ```js
 export default {
@@ -239,7 +309,7 @@ export default {
 ```
 
 ::: warning
-Setting `output.clean` to `false` may result in broken output. Ensure you typecheck your code.
+Setting `clean` to `false` may result in broken output. Ensure you typecheck your code.
 :::
 
 <!--@include: ../../partials/examples.md-->

docs/openapi-ts/migrating.md

@@ -7,6 +7,68 @@ description: Migrating to @hey-api/openapi-ts.
 
 While we try to avoid breaking changes, sometimes it's unavoidable in order to offer you the latest features. This page lists changes that require updates to your code. If you run into a problem with migration, please [open an issue](https://github.com/hey-api/openapi-ts/issues).
 
+## v0.85.0
+
+### Updated `output` options
+
+We made the `output` configuration more consistent by using `null` to represent disabled options. This change does not affect boolean options.
+
+```js
+export default {
+  input: 'hey-api/backend', // sign up at app.heyapi.dev
+  output: {
+    format: false, // [!code --]
+    format: null, // [!code ++]
+    lint: false, // [!code --]
+    lint: null, // [!code ++]
+    path: 'src/client',
+    tsConfigPath: 'off', // [!code --]
+    tsConfigPath: null, // [!code ++]
+  },
+};
+```
+
+### Updated Pinia Colada query options
+
+Pinia Colada query options now use `defineQueryOptions` to improve reactivity support. Instead of calling the query options function, you can use one of the following approaches.
+
+::: code-group
+
+```ts [no params]
+useQuery(getPetsQuery);
+```
+
+```ts [constant]
+useQuery(getPetByIdQuery, () => ({
+  path: {
+    petId: 1,
+  },
+}));
+```
+
+```ts [reactive]
+const petId = ref<number | null>(1);
+
+useQuery(getPetByIdQuery, () => ({
+  path: {
+    petId: petId.value,
+  },
+}));
+```
+
+```ts [properties]
+const petId = ref<number | null>(1);
+
+useQuery(() => ({
+  ...getPetByIdQuery({
+    path: { petId: petId.value as number },
+  }),
+  enabled: () => petId.value != null,
+}));
+```
+
+:::
+
 ## v0.84.0
 
 ### Symbol API

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/import-file-extension-ts/client.gen.ts

@@ -0,0 +1,18 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import { type ClientOptions, type Config, createClient, createConfig } from './client/index.ts';
+import type { ClientOptions as ClientOptions2 } from './types.gen.ts';
+
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
+
+export const client = createClient(createConfig<ClientOptions2>({
+    baseURL: 'http://localhost:3000/base'
+}));