@kubb/plugin-swr 3.0.0-alpha.9 → 3.0.0-beta.2

package/dist/index-B3C-JOIU.d.cts

@@ -1,299 +0,0 @@
-import { URLPath } from '@kubb/core/utils';
-import { HttpMethod } from '@kubb/oas';
-import { ReactNode } from 'react';
-import { PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
-import * as KubbFile from '@kubb/fs/types';
-import { ResolvePathOptions, Exclude, Include, Override } from '@kubb/plugin-oas';
-
-type TemplateProps$2 = {
-    /**
-     * Name of the function
-     */
-    name: string;
-    /**
-     * Parameters/options/props that need to be used
-     */
-    params: string;
-    /**
-     * Generics that needs to be added for TypeScript
-     */
-    generics?: string;
-    /**
-     * ReturnType(see async for adding Promise type)
-     */
-    returnType?: string;
-    /**
-     * Options for JSdocs
-     */
-    JSDoc?: {
-        comments: string[];
-    };
-    hook: {
-        name: string;
-        generics?: string;
-    };
-    client: {
-        method: HttpMethod;
-        generics: string;
-        withQueryParams: boolean;
-        withPathParams: boolean;
-        withData: boolean;
-        withHeaders: boolean;
-        path: URLPath;
-    };
-    dataReturnType: NonNullable<PluginSwr['options']['dataReturnType']>;
-};
-declare function Template$2({ name, generics, returnType, params, JSDoc, client, hook, dataReturnType }: TemplateProps$2): ReactNode;
-declare const defaultTemplates$1: {
-    readonly default: typeof Template$2;
-};
-type Props$2 = {
-    factory: {
-        name: string;
-    };
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    Template?: React.ComponentType<TemplateProps$2>;
-};
-declare function Mutation({ factory, Template }: Props$2): ReactNode;
-declare namespace Mutation {
-    var File: ({ templates }: FileProps$1) => ReactNode;
-    var templates: {
-        readonly default: typeof Template$2;
-    };
-}
-type FileProps$1 = {
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    templates?: typeof defaultTemplates$1;
-};
-
-type TemplateProps$1 = {
-    /**
-     * Name of the function
-     */
-    name: string;
-    /**
-     * Parameters/options/props that need to be used
-     */
-    params: string;
-    /**
-     * Generics that needs to be added for TypeScript
-     */
-    generics?: string;
-    /**
-     * ReturnType(see async for adding Promise type)
-     */
-    returnType?: string;
-    /**
-     * Options for JSdocs
-     */
-    JSDoc?: {
-        comments: string[];
-    };
-    client: {
-        generics: string;
-        method: HttpMethod;
-        path: URLPath;
-        withQueryParams: boolean;
-        withPathParams: boolean;
-        withData: boolean;
-        withHeaders: boolean;
-        contentType: string;
-    };
-    dataReturnType: NonNullable<PluginSwr['options']['dataReturnType']>;
-    parser: string | undefined;
-};
-declare function Template$1({ name, params, generics, returnType, JSDoc, client, dataReturnType, parser }: TemplateProps$1): ReactNode;
-type Props$1 = {
-    factory: {
-        name: string;
-    };
-    dataReturnType: NonNullable<PluginSwr['options']['dataReturnType']>;
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    Template?: React.ComponentType<TemplateProps$1>;
-};
-declare function QueryOptions({ factory, dataReturnType, Template }: Props$1): ReactNode;
-declare namespace QueryOptions {
-    var templates: {
-        readonly default: typeof Template$1;
-    };
-}
-
-type TemplateProps = {
-    /**
-     * Name of the function
-     */
-    name: string;
-    /**
-     * Parameters/options/props that need to be used
-     */
-    params: string;
-    /**
-     * Generics that needs to be added for TypeScript
-     */
-    generics?: string;
-    /**
-     * ReturnType(see async for adding Promise type)
-     */
-    returnType?: string;
-    /**
-     * Options for JSdocs
-     */
-    JSDoc?: {
-        comments: string[];
-    };
-    hook: {
-        name: string;
-        generics?: string;
-        queryOptions: string;
-    };
-    client: {
-        path: URLPath;
-        withQueryParams: boolean;
-    };
-};
-declare function Template({ name, generics, returnType, params, JSDoc, hook, client }: TemplateProps): ReactNode;
-declare const defaultTemplates: {
-    readonly default: typeof Template;
-};
-type Props = {
-    factory: {
-        name: string;
-    };
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    Template?: React.ComponentType<TemplateProps>;
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    QueryOptionsTemplate?: React.ComponentType<React.ComponentProps<typeof QueryOptions.templates.default>>;
-};
-declare function Query({ factory, Template, QueryOptionsTemplate }: Props): ReactNode;
-declare namespace Query {
-    var File: ({ templates }: FileProps) => ReactNode;
-    var templates: {
-        readonly default: typeof Template;
-    };
-}
-type FileProps = {
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    templates?: {
-        query: typeof defaultTemplates;
-        queryOptions: typeof QueryOptions.templates;
-    };
-};
-
-type Templates = {
-    mutation?: typeof Mutation.templates | false;
-    query?: typeof Query.templates | false;
-    queryOptions?: typeof QueryOptions.templates | false;
-};
-type Options = {
-    output?: {
-        /**
-         * Output to save the SWR hooks.
-         * @default `"hooks"`
-         */
-        path: string;
-        /**
-         * Name to be used for the `export * as {{exportAs}} from './'`
-         */
-        exportAs?: string;
-        /**
-         * Add an extension to the generated imports and exports, default it will not use an extension
-         */
-        extName?: KubbFile.Extname;
-        /**
-         * Define what needs to exported, here you can also disable the export of barrel files
-         * @default `'barrel'`
-         */
-        exportType?: 'barrel' | 'barrelNamed' | false;
-    };
-    /**
-     * Group the SWR hooks based on the provided name.
-     */
-    group?: {
-        /**
-         * Tag will group based on the operation tag inside the Swagger file
-         */
-        type: 'tag';
-        /**
-         * Relative path to save the grouped SWR hooks.
-         *
-         * `{{tag}}` will be replaced by the current tagName.
-         * @example `${output}/{{tag}}Controller` => `hooks/PetController`
-         * @default `${output}/{{tag}}Controller`
-         */
-        output?: string;
-        /**
-         * Name to be used for the `export * as {{exportAs}} from './`
-         * @default `"{{tag}}SWRHooks"`
-         */
-        exportAs?: string;
-    };
-    /**
-     * 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?: {
-        /**
-         * Path to the client import path that will be used to do the API calls.
-         * It will be used as `import client from '${client.importPath}'`.
-         * It allow both relative and absolute path.
-         * the path will be applied as is, so relative path shoule be based on the file being generated.
-         * @default '@kubb/plugin-client/client'
-         */
-        importPath?: string;
-    };
-    /**
-     * ReturnType that needs to be used when calling client().
-     *
-     * `Data` will return ResponseConfig[data].
-     *
-     * `Full` will return ResponseConfig.
-     * @default `'data'`
-     * @private
-     */
-    dataReturnType?: 'data' | 'full';
-    transformers?: {
-        /**
-         * Customize the names based on the type that is provided by the plugin.
-         */
-        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-    };
-    /**
-     * Which parser can be used before returning the data to `@tanstack/query`.
-     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
-     */
-    parser?: 'zod';
-    /**
-     * Make it possible to override one of the templates
-     */
-    templates?: Partial<Templates>;
-};
-type ResolvedOptions = {
-    extName: KubbFile.Extname | undefined;
-    client: Required<NonNullable<Options['client']>>;
-    dataReturnType: NonNullable<Options['dataReturnType']>;
-    templates: NonNullable<Templates>;
-    parser: Options['parser'];
-};
-type PluginSwr = PluginFactoryOptions<'plugin-swr', Options, ResolvedOptions, never, ResolvePathOptions>;
-
-export { Mutation as M, type Options as O, type PluginSwr as P, Query as Q, QueryOptions as a };

package/dist/index-B3C-JOIU.d.ts

@@ -1,299 +0,0 @@
-import { URLPath } from '@kubb/core/utils';
-import { HttpMethod } from '@kubb/oas';
-import { ReactNode } from 'react';
-import { PluginFactoryOptions, ResolveNameParams } from '@kubb/core';
-import * as KubbFile from '@kubb/fs/types';
-import { ResolvePathOptions, Exclude, Include, Override } from '@kubb/plugin-oas';
-
-type TemplateProps$2 = {
-    /**
-     * Name of the function
-     */
-    name: string;
-    /**
-     * Parameters/options/props that need to be used
-     */
-    params: string;
-    /**
-     * Generics that needs to be added for TypeScript
-     */
-    generics?: string;
-    /**
-     * ReturnType(see async for adding Promise type)
-     */
-    returnType?: string;
-    /**
-     * Options for JSdocs
-     */
-    JSDoc?: {
-        comments: string[];
-    };
-    hook: {
-        name: string;
-        generics?: string;
-    };
-    client: {
-        method: HttpMethod;
-        generics: string;
-        withQueryParams: boolean;
-        withPathParams: boolean;
-        withData: boolean;
-        withHeaders: boolean;
-        path: URLPath;
-    };
-    dataReturnType: NonNullable<PluginSwr['options']['dataReturnType']>;
-};
-declare function Template$2({ name, generics, returnType, params, JSDoc, client, hook, dataReturnType }: TemplateProps$2): ReactNode;
-declare const defaultTemplates$1: {
-    readonly default: typeof Template$2;
-};
-type Props$2 = {
-    factory: {
-        name: string;
-    };
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    Template?: React.ComponentType<TemplateProps$2>;
-};
-declare function Mutation({ factory, Template }: Props$2): ReactNode;
-declare namespace Mutation {
-    var File: ({ templates }: FileProps$1) => ReactNode;
-    var templates: {
-        readonly default: typeof Template$2;
-    };
-}
-type FileProps$1 = {
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    templates?: typeof defaultTemplates$1;
-};
-
-type TemplateProps$1 = {
-    /**
-     * Name of the function
-     */
-    name: string;
-    /**
-     * Parameters/options/props that need to be used
-     */
-    params: string;
-    /**
-     * Generics that needs to be added for TypeScript
-     */
-    generics?: string;
-    /**
-     * ReturnType(see async for adding Promise type)
-     */
-    returnType?: string;
-    /**
-     * Options for JSdocs
-     */
-    JSDoc?: {
-        comments: string[];
-    };
-    client: {
-        generics: string;
-        method: HttpMethod;
-        path: URLPath;
-        withQueryParams: boolean;
-        withPathParams: boolean;
-        withData: boolean;
-        withHeaders: boolean;
-        contentType: string;
-    };
-    dataReturnType: NonNullable<PluginSwr['options']['dataReturnType']>;
-    parser: string | undefined;
-};
-declare function Template$1({ name, params, generics, returnType, JSDoc, client, dataReturnType, parser }: TemplateProps$1): ReactNode;
-type Props$1 = {
-    factory: {
-        name: string;
-    };
-    dataReturnType: NonNullable<PluginSwr['options']['dataReturnType']>;
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    Template?: React.ComponentType<TemplateProps$1>;
-};
-declare function QueryOptions({ factory, dataReturnType, Template }: Props$1): ReactNode;
-declare namespace QueryOptions {
-    var templates: {
-        readonly default: typeof Template$1;
-    };
-}
-
-type TemplateProps = {
-    /**
-     * Name of the function
-     */
-    name: string;
-    /**
-     * Parameters/options/props that need to be used
-     */
-    params: string;
-    /**
-     * Generics that needs to be added for TypeScript
-     */
-    generics?: string;
-    /**
-     * ReturnType(see async for adding Promise type)
-     */
-    returnType?: string;
-    /**
-     * Options for JSdocs
-     */
-    JSDoc?: {
-        comments: string[];
-    };
-    hook: {
-        name: string;
-        generics?: string;
-        queryOptions: string;
-    };
-    client: {
-        path: URLPath;
-        withQueryParams: boolean;
-    };
-};
-declare function Template({ name, generics, returnType, params, JSDoc, hook, client }: TemplateProps): ReactNode;
-declare const defaultTemplates: {
-    readonly default: typeof Template;
-};
-type Props = {
-    factory: {
-        name: string;
-    };
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    Template?: React.ComponentType<TemplateProps>;
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    QueryOptionsTemplate?: React.ComponentType<React.ComponentProps<typeof QueryOptions.templates.default>>;
-};
-declare function Query({ factory, Template, QueryOptionsTemplate }: Props): ReactNode;
-declare namespace Query {
-    var File: ({ templates }: FileProps) => ReactNode;
-    var templates: {
-        readonly default: typeof Template;
-    };
-}
-type FileProps = {
-    /**
-     * This will make it possible to override the default behaviour.
-     */
-    templates?: {
-        query: typeof defaultTemplates;
-        queryOptions: typeof QueryOptions.templates;
-    };
-};
-
-type Templates = {
-    mutation?: typeof Mutation.templates | false;
-    query?: typeof Query.templates | false;
-    queryOptions?: typeof QueryOptions.templates | false;
-};
-type Options = {
-    output?: {
-        /**
-         * Output to save the SWR hooks.
-         * @default `"hooks"`
-         */
-        path: string;
-        /**
-         * Name to be used for the `export * as {{exportAs}} from './'`
-         */
-        exportAs?: string;
-        /**
-         * Add an extension to the generated imports and exports, default it will not use an extension
-         */
-        extName?: KubbFile.Extname;
-        /**
-         * Define what needs to exported, here you can also disable the export of barrel files
-         * @default `'barrel'`
-         */
-        exportType?: 'barrel' | 'barrelNamed' | false;
-    };
-    /**
-     * Group the SWR hooks based on the provided name.
-     */
-    group?: {
-        /**
-         * Tag will group based on the operation tag inside the Swagger file
-         */
-        type: 'tag';
-        /**
-         * Relative path to save the grouped SWR hooks.
-         *
-         * `{{tag}}` will be replaced by the current tagName.
-         * @example `${output}/{{tag}}Controller` => `hooks/PetController`
-         * @default `${output}/{{tag}}Controller`
-         */
-        output?: string;
-        /**
-         * Name to be used for the `export * as {{exportAs}} from './`
-         * @default `"{{tag}}SWRHooks"`
-         */
-        exportAs?: string;
-    };
-    /**
-     * 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?: {
-        /**
-         * Path to the client import path that will be used to do the API calls.
-         * It will be used as `import client from '${client.importPath}'`.
-         * It allow both relative and absolute path.
-         * the path will be applied as is, so relative path shoule be based on the file being generated.
-         * @default '@kubb/plugin-client/client'
-         */
-        importPath?: string;
-    };
-    /**
-     * ReturnType that needs to be used when calling client().
-     *
-     * `Data` will return ResponseConfig[data].
-     *
-     * `Full` will return ResponseConfig.
-     * @default `'data'`
-     * @private
-     */
-    dataReturnType?: 'data' | 'full';
-    transformers?: {
-        /**
-         * Customize the names based on the type that is provided by the plugin.
-         */
-        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-    };
-    /**
-     * Which parser can be used before returning the data to `@tanstack/query`.
-     * `'zod'` will use `@kubb/plugin-zod` to parse the data.
-     */
-    parser?: 'zod';
-    /**
-     * Make it possible to override one of the templates
-     */
-    templates?: Partial<Templates>;
-};
-type ResolvedOptions = {
-    extName: KubbFile.Extname | undefined;
-    client: Required<NonNullable<Options['client']>>;
-    dataReturnType: NonNullable<Options['dataReturnType']>;
-    templates: NonNullable<Templates>;
-    parser: Options['parser'];
-};
-type PluginSwr = PluginFactoryOptions<'plugin-swr', Options, ResolvedOptions, never, ResolvePathOptions>;
-
-export { Mutation as M, type Options as O, type PluginSwr as P, Query as Q, QueryOptions as a };

package/src/OperationGenerator.tsx

@@ -1,75 +0,0 @@
-import { OperationGenerator as Generator } from '@kubb/plugin-oas'
-import { Oas } from '@kubb/plugin-oas/components'
-import { App, createRoot } from '@kubb/react'
-
-import { Mutation } from './components/Mutation.tsx'
-import { Query } from './components/Query.tsx'
-
-import type { Operation } from '@kubb/oas'
-import type { OperationMethodResult } from '@kubb/plugin-oas'
-import type { FileMeta, PluginSwr } from './types.ts'
-
-export class OperationGenerator extends Generator<PluginSwr['resolvedOptions'], PluginSwr, FileMeta> {
-  async get(operation: Operation, options: PluginSwr['resolvedOptions']): OperationMethodResult<FileMeta> {
-    const { oas, pluginManager, plugin, mode } = this.context
-
-    const root = createRoot({
-      logger: pluginManager.logger,
-    })
-
-    if (!options.templates?.query || !options.templates?.queryOptions) {
-      return []
-    }
-
-    root.render(
-      <App pluginManager={pluginManager} plugin={{ ...plugin, options }} mode={mode}>
-        <Oas oas={oas} operations={[operation]} generator={this}>
-          <Oas.Operation operation={operation}>
-            <Query.File
-              templates={{
-                query: options.templates.query,
-                queryOptions: options.templates.queryOptions,
-              }}
-            />
-          </Oas.Operation>
-        </Oas>
-      </App>,
-    )
-
-    return root.files
-  }
-
-  async post(operation: Operation, options: PluginSwr['resolvedOptions']): OperationMethodResult<FileMeta> {
-    const { oas, pluginManager, plugin, mode } = this.context
-
-    const root = createRoot({
-      logger: pluginManager.logger,
-    })
-
-    if (!options.templates?.mutation) {
-      return []
-    }
-
-    root.render(
-      <App pluginManager={pluginManager} plugin={{ ...plugin, options }} mode={mode}>
-        <Oas oas={oas} operations={[operation]} generator={this}>
-          <Oas.Operation operation={operation}>
-            <Mutation.File templates={options.templates.mutation} />
-          </Oas.Operation>
-        </Oas>
-      </App>,
-    )
-
-    return root.files
-  }
-
-  async put(operation: Operation, options: PluginSwr['resolvedOptions']): OperationMethodResult<FileMeta> {
-    return this.post(operation, options)
-  }
-  async patch(operation: Operation, options: PluginSwr['resolvedOptions']): OperationMethodResult<FileMeta> {
-    return this.post(operation, options)
-  }
-  async delete(operation: Operation, options: PluginSwr['resolvedOptions']): OperationMethodResult<FileMeta> {
-    return this.post(operation, options)
-  }
-}