feat(swr): add swrOptions property to output.override.swr (orval-…

…labs#1223)
Marfyy · Feb 17, 2024 · 74ef879 · 74ef879
1 parent 97552e4
commit 74ef879
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 2 deletions.
diff --git a/docs/src/pages/reference/configuration/output.md b/docs/src/pages/reference/configuration/output.md
@@ -817,6 +817,30 @@ Type: `Boolean`.
 
 Use to generate a <a href="https://swr.vercel.app/docs/pagination#useswrinfinite" target="_blank">useSWRInfinite</a> custom hook.
 
+##### swrOptions
+
+Type: `Object`.
+
+Use to override the `useSwr` options. Check available options [here](https://swr.vercel.app/docs/api#options)
+
+Example:
+
+```js
+module.exports = {
+ petstore: {
+ output: {
+ override: {
+ swr: {
+ swrOptions: {
+ dedupingInterval: 10000,
+ },
+ },
+ },
+ },
+ },
+};
+```
+
 #### mock
 
 Type: `Object`.

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -362,6 +362,7 @@ export type AngularOptions = {
 export type SwrOptions = {
  options?: any;
  useInfinite?: boolean;
+ swrOptions?: any;
 };
 
 export type InputTransformerFn = (spec: OpenAPIObject) => OpenAPIObject;

diff --git a/packages/swr/src/index.ts b/packages/swr/src/index.ts
@@ -378,6 +378,8 @@ ${doc}export const ${camel(
 }\n`
  : '';
 
+ const defaultSwrOptions = { ...swrOptions.swrOptions, ...swrOptions.options };
+
  const useSwrImplementation = `
 export type ${pascal(
  operationName,
@@ -418,9 +420,9 @@ ${doc}export const ${camel(`use-${operationName}`)} = <TError = ${errorType}>(
  });
 
  const ${queryResultVarName} = useSwr<Awaited<ReturnType<typeof swrFn>>, TError>(swrKey, swrFn, ${
- swrOptions.options
+ defaultSwrOptions
  ? `{
- ${stringify(swrOptions.options)?.slice(1, -1)}
+ ${stringify(defaultSwrOptions)?.slice(1, -1)}
  ...swrOptions
  }`
  : 'swrOptions'

diff --git a/tests/configs/swr.config.ts b/tests/configs/swr.config.ts
@@ -107,4 +107,22 @@ export default defineConfig({
  },
  },
  },
+ petstoreOverrideSwr: {
+ output: {
+ target: '../generated/swr/petstore-override-swr/endpoints.ts',
+ schemas: '../generated/swr/petstore-override-swr/model',
+ client: 'swr',
+ override: {
+ swr: {
+ useInfinite: true,
+ swrOptions: {
+ dedupingInterval: 10000,
+ },
+ },
+ },
+ },
+ input: {
+ target: '../specifications/petstore.yaml',
+ },
+ },
 });