@kubb/plugin-swr 0.0.0-canary-20241104172400

package/dist/types-AhGZx7jH.d.ts

@@ -0,0 +1,272 @@
+import { PluginFactoryOptions, Output, Group, ResolveNameParams } from '@kubb/core';
+import { HttpMethod, Operation } from '@kubb/oas';
+import { PluginClient } from '@kubb/plugin-client';
+import { ResolvePathOptions, Exclude, Include, Override, Generator, OperationSchemas } from '@kubb/plugin-oas';
+
+type TransformerProps$1 = {
+    operation: Operation;
+    schemas: OperationSchemas;
+};
+type Transformer$1 = (props: TransformerProps$1) => unknown[];
+type Suspense = object;
+/**
+ * Customize the queryKey
+ */
+type QueryKey$1 = Transformer$1;
+/**
+ * Customize the mutationKey
+ */
+type MutationKey$1 = Transformer$1;
+type Query$1 = {
+    /**
+     * Define which HttpMethods can be used for queries
+     * @default ['get']
+     */
+    methods: Array<HttpMethod>;
+    /**
+     * Path to the useQuery that will be used to do the useQuery functionality.
+     * It will be used as `import { useQuery } from '${importPath}'`.
+     * It allows both relative and absolute path.
+     * the path will be applied as is, so relative path should be based on the file being generated.
+     * @default '@tanstack/react-query'
+     */
+    importPath?: string;
+};
+type Mutation$1 = {
+    /**
+     * Define which HttpMethods can be used for mutations
+     * @default ['post', 'put', 'delete']
+     */
+    methods: Array<HttpMethod>;
+    /**
+     * Path to the useQuery that will be used to do the useQuery functionality.
+     * It will be used as `import { useQuery } from '${importPath}'`.
+     * It allows both relative and absolute path.
+     * the path will be applied as is, so relative path should be based on the file being generated.
+     * @default '@tanstack/react-query'
+     */
+    importPath?: string;
+};
+type Infinite = {
+    /**
+     * Specify the params key used for `pageParam`.
+     * @default 'id'
+     */
+    queryParam: string;
+    /**
+     * Which field of the data will be used, set it to undefined when no cursor is known.
+     */
+    cursorParam?: string | undefined;
+    /**
+     * The initial value, the value of the first page.
+     * @default 0
+     */
+    initialPageParam: unknown;
+};
+type Options$1 = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'hooks', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the @tanstack/query hooks based on the provided name.
+     */
+    group?: Group;
+    client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath' | 'baseURL'>;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions$1>>;
+    /**
+     * How to pass your params
+     * - 'object' will return the params and pathParams as an object.
+     * - 'inline' will return the params as comma separated params.
+     * @default 'inline'
+     */
+    paramsType?: 'object' | 'inline';
+    /**
+     * How to pass your pathParams.
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
+     */
+    pathParamsType?: PluginClient['options']['pathParamsType'];
+    /**
+     * When set, an infiniteQuery hooks will be added.
+     */
+    infinite?: Partial<Infinite> | false;
+    /**
+     * When set, a suspenseQuery hooks will be added.
+     */
+    suspense?: Partial<Suspense> | false;
+    queryKey?: QueryKey$1;
+    /**
+     * Override some useQuery behaviours.
+     */
+    query?: Partial<Query$1> | false;
+    mutationKey?: MutationKey$1;
+    /**
+     * Override some useMutation behaviours.
+     */
+    mutation?: Partial<Mutation$1> | false;
+    /**
+     * Which parser should be used before returning the data to `@tanstack/query`.
+     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     */
+    parser?: PluginClient['options']['parser'];
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Define some generators next to the react-query generators
+     */
+    generators?: Array<Generator<PluginReactQuery>>;
+};
+type ResolvedOptions$1 = {
+    output: Output;
+    client: Required<Omit<NonNullable<PluginReactQuery['options']['client']>, 'baseURL'>> & {
+        baseURL?: string;
+    };
+    parser: Required<NonNullable<Options$1['parser']>>;
+    pathParamsType: NonNullable<Options$1['pathParamsType']>;
+    paramsType: NonNullable<Options$1['paramsType']>;
+    /**
+     * Only used of infinite
+     */
+    infinite: NonNullable<Infinite> | false;
+    suspense: Suspense | false;
+    queryKey: QueryKey$1 | undefined;
+    query: NonNullable<Required<Query$1>> | false;
+    mutationKey: MutationKey$1 | undefined;
+    mutation: NonNullable<Required<Mutation$1>> | false;
+};
+type PluginReactQuery = PluginFactoryOptions<'plugin-react-query', Options$1, ResolvedOptions$1, never, ResolvePathOptions>;
+
+type TransformerProps = {
+    operation: Operation;
+    schemas: OperationSchemas;
+};
+type Transformer = (props: TransformerProps) => unknown[];
+/**
+ * Customize the queryKey
+ */
+type QueryKey = Transformer;
+/**
+ * Customize the mutationKey
+ */
+type MutationKey = Transformer;
+type Query = {
+    /**
+     * Define which HttpMethods can be used for queries
+     * @default ['get']
+     */
+    methods?: Array<HttpMethod>;
+    /**
+     * Path to the useQuery that will be used to do the useQuery functionality.
+     * It will be used as `import { useQuery } from '${importPath}'`.
+     * It allows both relative and absolute path.
+     * the path will be applied as is, so relative path should be based on the file being generated.
+     * @default 'swr'
+     */
+    importPath?: string;
+};
+type Mutation = {
+    /**
+     * Define which HttpMethods can be used for queries
+     * @default ['post', 'put', 'delete', 'patch']
+     */
+    methods?: Array<HttpMethod>;
+    /**
+     * Path to the useQuery that will be used to do the useQuery functionality.
+     * It will be used as `import { useQuery } from '${importPath}'`.
+     * It allows both relative and absolute path.
+     * the path will be applied as is, so relative path should be based on the file being generated.
+     * @default 'swr/mutation'
+     */
+    importPath?: string;
+};
+type Options = {
+    /**
+     * Specify the export location for the files and define the behavior of the output
+     * @default { path: 'hooks', barrelType: 'named' }
+     */
+    output?: Output;
+    /**
+     * Group the SWR hooks based on the provided name.
+     */
+    group?: Group;
+    /**
+     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include parameters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<ResolvedOptions>>;
+    client?: Pick<PluginClient['options'], 'dataReturnType' | 'importPath' | 'baseURL'>;
+    queryKey?: QueryKey;
+    query?: Query | false;
+    mutationKey?: MutationKey;
+    mutation?: Mutation | false;
+    /**
+     * How to pass your params
+     * - 'object' will return the params and pathParams as an object.
+     * - 'inline' will return the params as comma separated params.
+     * @default 'inline'
+     */
+    paramsType?: 'object' | 'inline';
+    /**
+     * How to pass your pathParams.
+     * - 'object' will return the pathParams as an object.
+     * - 'inline' will return the pathParams as comma separated params.
+     * @default 'inline'
+     */
+    pathParamsType?: PluginClient['options']['pathParamsType'];
+    /**
+     * Which parser should be used before returning the data to `swr`.
+     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
+     */
+    parser?: PluginClient['options']['parser'];
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Define some generators next to the swr generators
+     */
+    generators?: Array<Generator<PluginSwr>>;
+};
+type ResolvedOptions = {
+    output: Output;
+    client: Required<Omit<NonNullable<PluginReactQuery['options']['client']>, 'baseURL'>> & {
+        baseURL?: string;
+    };
+    parser: Required<NonNullable<Options['parser']>>;
+    queryKey: QueryKey | undefined;
+    query: NonNullable<Required<Query>> | false;
+    mutationKey: MutationKey | undefined;
+    mutation: NonNullable<Required<Mutation>> | false;
+    paramsType: NonNullable<Options['paramsType']>;
+    pathParamsType: NonNullable<Options['pathParamsType']>;
+};
+type PluginSwr = PluginFactoryOptions<'plugin-swr', Options, ResolvedOptions, never, ResolvePathOptions>;
+
+export type { Options as O, PluginSwr as P, Transformer as T };

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "@kubb/plugin-swr",
+  "version": "0.0.0-canary-20241104172400",
+  "description": "Generator plugin-swr",
+  "keywords": [
+    "typescript",
+    "plugins",
+    "kubb",
+    "codegen",
+    "swagger",
+    "openapi",
+    "swr",
+    "vercel",
+    "nextjs",
+    "next",
+    "axios"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kubb-labs/kubb.git",
+    "directory": "packages/plugin-swr"
+  },
+  "license": "MIT",
+  "author": "Stijn Van Hulle <stijn@stijnvanhulle.be",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.cjs"
+    },
+    "./generators": {
+      "import": "./dist/generators.js",
+      "require": "./dist/generators.cjs",
+      "default": "./dist/generators.cjs"
+    },
+    "./components": {
+      "import": "./dist/components.js",
+      "require": "./dist/components.cjs",
+      "default": "./dist/components.cjs"
+    },
+    "./package.json": "./package.json",
+    "./*": "./*"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "components": [
+        "./dist/components.d.ts"
+      ],
+      "generators": [
+        "./dist/generators.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "src",
+    "dist",
+    "!/**/**.test.**",
+    "!/**/__tests__/**"
+  ],
+  "dependencies": {
+    "@kubb/core": "0.0.0-canary-20241104172400",
+    "@kubb/fs": "0.0.0-canary-20241104172400",
+    "@kubb/oas": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-client": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-oas": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-ts": "0.0.0-canary-20241104172400",
+    "@kubb/plugin-zod": "0.0.0-canary-20241104172400",
+    "@kubb/react": "0.0.0-canary-20241104172400"
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.12",
+    "react": "^18.3.1",
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "@kubb/config-ts": "0.0.0-canary-20241104172400",
+    "@kubb/config-tsup": "0.0.0-canary-20241104172400"
+  },
+  "peerDependencies": {
+    "@kubb/react": "0.0.0-canary-20241104172400"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf ./dist",
+    "lint": "bun biome lint .",
+    "lint:fix": "bun biome lint --apply-unsafe .",
+    "release": "pnpm publish --no-git-check",
+    "release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check",
+    "start": "tsup --watch",
+    "test": "vitest --passWithNoTests",
+    "typecheck": "tsc -p ./tsconfig.json --noEmit --emitDeclarationOnly false"
+  }
+}

package/src/components/Mutation.tsx

@@ -0,0 +1,129 @@
+import { File, Function, FunctionParams } from '@kubb/react'
+
+import { type Operation, isOptional } from '@kubb/oas'
+import { Client } from '@kubb/plugin-client/components'
+import type { OperationSchemas } from '@kubb/plugin-oas'
+import { getComments, getPathParams } from '@kubb/plugin-oas/utils'
+import type { ReactNode } from 'react'
+import type { PluginSwr } from '../types.ts'
+import { MutationKey } from './MutationKey.tsx'
+
+type Props = {
+  /**
+   * Name of the function
+   */
+  name: string
+  typeName: string
+  clientName: string
+  mutationKeyName: string
+  mutationKeyTypeName: string
+  typeSchemas: OperationSchemas
+  operation: Operation
+  paramsType: PluginSwr['resolvedOptions']['paramsType']
+  dataReturnType: PluginSwr['resolvedOptions']['client']['dataReturnType']
+  pathParamsType: PluginSwr['resolvedOptions']['pathParamsType']
+}
+
+type GetParamsProps = {
+  pathParamsType: PluginSwr['resolvedOptions']['pathParamsType']
+  dataReturnType: PluginSwr['resolvedOptions']['client']['dataReturnType']
+  typeSchemas: OperationSchemas
+  mutationKeyTypeName: string
+}
+// TODO add same logic as being done for react-query mutations
+function getParams({ pathParamsType, dataReturnType, typeSchemas, mutationKeyTypeName }: GetParamsProps) {
+  const TData = dataReturnType === 'data' ? typeSchemas.response.name : `ResponseConfig<${typeSchemas.response.name}>`
+
+  return FunctionParams.factory({
+    pathParams: {
+      mode: pathParamsType === 'object' ? 'object' : 'inlineSpread',
+      children: getPathParams(typeSchemas.pathParams, { typed: true }),
+    },
+    params: typeSchemas.queryParams?.name
+      ? {
+          type: typeSchemas.queryParams?.name,
+          optional: isOptional(typeSchemas.queryParams?.schema),
+        }
+      : undefined,
+    headers: typeSchemas.headerParams?.name
+      ? {
+          type: typeSchemas.headerParams?.name,
+          optional: isOptional(typeSchemas.headerParams?.schema),
+        }
+      : undefined,
+    options: {
+      type: `
+{
+  mutation?: Parameters<typeof useSWRMutation<${[TData, typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error', mutationKeyTypeName, typeSchemas.request?.name].join(', ')}>>[2],
+  client?: ${typeSchemas.request?.name ? `Partial<RequestConfig<${typeSchemas.request?.name}>>` : 'Partial<RequestConfig>'},
+  shouldFetch?: boolean,
+}
+`,
+      default: '{}',
+    },
+  })
+}
+
+export function Mutation({
+  name,
+  clientName,
+  mutationKeyName,
+  mutationKeyTypeName,
+  paramsType,
+  pathParamsType,
+  dataReturnType,
+  typeSchemas,
+  operation,
+}: Props): ReactNode {
+  const TData = dataReturnType === 'data' ? typeSchemas.response.name : `ResponseConfig<${typeSchemas.response.name}>`
+  const generics = [
+    TData,
+    typeSchemas.errors?.map((item) => item.name).join(' | ') || 'Error',
+    `${mutationKeyTypeName} | null`,
+    typeSchemas.request?.name, //arg: data
+  ].filter(Boolean)
+
+  const mutationKeyParams = MutationKey.getParams({
+    pathParamsType,
+    typeSchemas,
+  })
+
+  const params = getParams({
+    pathParamsType,
+    dataReturnType,
+    typeSchemas,
+    mutationKeyTypeName,
+  })
+
+  const clientParams = Client.getParams({
+    paramsType,
+    typeSchemas,
+    pathParamsType,
+  })
+
+  return (
+    <File.Source name={name} isExportable isIndexable>
+      <Function
+        name={name}
+        export
+        params={params.toConstructor()}
+        JSDoc={{
+          comments: getComments(operation),
+        }}
+      >
+        {`
+        const { mutation: mutationOptions, client: config = {}, shouldFetch = true } = options ?? {}
+        const mutationKey = ${mutationKeyName}(${mutationKeyParams.toCall()})
+
+        return useSWRMutation<${generics}>(
+          shouldFetch ? mutationKey : null,
+          async (_url${typeSchemas.request?.name ? ', { arg: data }' : ''}) => {
+            return ${clientName}(${clientParams.toCall()})
+          },
+          mutationOptions
+        )
+    `}
+      </Function>
+    </File.Source>
+  )
+}

package/src/components/MutationKey.tsx

@@ -0,0 +1,54 @@
+import { URLPath } from '@kubb/core/utils'
+import { File, Function, FunctionParams, Type } from '@kubb/react'
+
+import type { Operation } from '@kubb/oas'
+import type { OperationSchemas } from '@kubb/plugin-oas'
+import type { ReactNode } from 'react'
+import type { PluginSwr, Transformer } from '../types'
+
+type Props = {
+  name: string
+  typeName: string
+  typeSchemas: OperationSchemas
+  operation: Operation
+  pathParamsType: PluginSwr['resolvedOptions']['pathParamsType']
+  transformer: Transformer | undefined
+}
+
+type GetParamsProps = {
+  pathParamsType: PluginSwr['resolvedOptions']['pathParamsType']
+  typeSchemas: OperationSchemas
+}
+
+function getParams({}: GetParamsProps) {
+  return FunctionParams.factory({})
+}
+
+const getTransformer: Transformer = ({ operation }) => {
+  const path = new URLPath(operation.path)
+
+  return [JSON.stringify({ url: path.path })].filter(Boolean)
+}
+
+export function MutationKey({ name, typeSchemas, pathParamsType, operation, typeName, transformer = getTransformer }: Props): ReactNode {
+  const params = getParams({ pathParamsType, typeSchemas })
+  const keys = transformer({ operation, schemas: typeSchemas })
+
+  return (
+    <>
+      <File.Source name={name} isExportable isIndexable>
+        <Function.Arrow name={name} export params={params.toConstructor()} singleLine>
+          {`[${keys.join(', ')}] as const`}
+        </Function.Arrow>
+      </File.Source>
+      <File.Source name={typeName} isExportable isIndexable isTypeOnly>
+        <Type name={typeName} export>
+          {`ReturnType<typeof ${name}>`}
+        </Type>
+      </File.Source>
+    </>
+  )
+}
+
+MutationKey.getParams = getParams
+MutationKey.getTransformer = getTransformer