@kubb/plugin-fetch 5.5.7 → 5.5.9

package/kubb-extension.json

@@ -0,0 +1,191 @@
+{
+  "$schema": "https://kubb.dev/schemas/kubb-extension.json",
+  "kind": "plugin",
+  "name": "plugin-fetch",
+  "export": "pluginFetch",
+  "displayName": "Fetch",
+  "description": "Generates a type-safe Fetch API client from your OpenAPI spec, one async function per operation, so each call stays in sync with the API.",
+  "category": "client",
+  "icon": {
+    "light": "https://kubb.dev/feature/javascript.svg"
+  },
+  "tags": ["api-client", "fetch", "http-client", "codegen", "openapi", "validator"],
+  "docs": "https://kubb.dev/plugins/plugin-fetch",
+  "compatibility": {
+    "kubb": ">=5.8.0",
+    "node": ">=22"
+  },
+  "role": "client",
+  "options": [
+    {
+      "key": "outputPath",
+      "path": ["output", "path"],
+      "label": "Output Path",
+      "description": "Output folder for generated files",
+      "type": "text",
+      "default": "clients"
+    },
+    {
+      "key": "barrel",
+      "path": ["output", "barrel"],
+      "label": "Barrel",
+      "description": "How index.ts barrel files are generated",
+      "type": "select",
+      "default": {
+        "type": "named"
+      },
+      "choices": [
+        {
+          "label": "named",
+          "value": {
+            "type": "named"
+          }
+        },
+        {
+          "label": "named (nested)",
+          "value": {
+            "type": "named",
+            "nested": true
+          }
+        },
+        {
+          "label": "all",
+          "value": {
+            "type": "all"
+          }
+        },
+        {
+          "label": "all (nested)",
+          "value": {
+            "type": "all",
+            "nested": true
+          }
+        },
+        {
+          "label": "false (disabled)",
+          "value": false
+        }
+      ]
+    },
+    {
+      "key": "outputMode",
+      "path": ["output", "mode"],
+      "label": "Output Mode",
+      "description": "How the plugin consolidates its code into files. File mode writes everything into a single file, so the output path must include a file extension and cannot be grouped.",
+      "type": "select",
+      "default": "directory",
+      "choices": [
+        {
+          "label": "directory (one file per schema)",
+          "value": "directory"
+        },
+        {
+          "label": "file (single file)",
+          "value": "file"
+        }
+      ]
+    },
+    {
+      "key": "validator",
+      "path": ["validator"],
+      "label": "Validator",
+      "description": "Validate request and response bodies with schemas from @kubb/plugin-zod",
+      "type": "select",
+      "default": false,
+      "choices": [
+        {
+          "label": "false (disabled)",
+          "value": false
+        },
+        {
+          "label": "zod",
+          "value": "zod"
+        }
+      ]
+    },
+    {
+      "key": "group",
+      "path": ["group"],
+      "label": "Group",
+      "description": "Group generated operations by OpenAPI tag or path",
+      "type": "select",
+      "default": null,
+      "choices": [
+        {
+          "label": "none",
+          "value": null
+        },
+        {
+          "label": "by tag",
+          "value": {
+            "type": "tag"
+          }
+        },
+        {
+          "label": "by path",
+          "value": {
+            "type": "path"
+          }
+        }
+      ]
+    },
+    {
+      "key": "excludeTags",
+      "path": ["exclude"],
+      "label": "Exclude Tags",
+      "description": "Comma-separated OpenAPI tags to exclude from generation",
+      "type": "list",
+      "item": {
+        "type": "tag",
+        "pattern": "$item"
+      }
+    },
+    {
+      "key": "includeTags",
+      "path": ["include"],
+      "label": "Include Tags",
+      "description": "Comma-separated OpenAPI tags to include. Only operations with these tags are generated",
+      "type": "list",
+      "item": {
+        "type": "tag",
+        "pattern": "$item"
+      }
+    },
+    {
+      "key": "baseURL",
+      "path": ["baseURL"],
+      "label": "Base URL",
+      "description": "Custom API base URL",
+      "type": "text"
+    },
+    {
+      "key": "sdkMode",
+      "path": ["sdk", "mode"],
+      "label": "SDK Mode",
+      "description": "Group generated operations into an SDK client by tag or flat",
+      "type": "select",
+      "default": null,
+      "choices": [
+        {
+          "label": "off (standalone functions)",
+          "value": null
+        },
+        {
+          "label": "tag",
+          "value": "tag"
+        },
+        {
+          "label": "flat",
+          "value": "flat"
+        }
+      ]
+    },
+    {
+      "key": "sdkName",
+      "path": ["sdk", "name"],
+      "label": "SDK Name",
+      "description": "Root client name for the generated SDK",
+      "type": "text"
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-fetch",
-  "version": "5.5.7",
+  "version": "5.5.9",
   "description": "Generate a slim, type-safe HTTP client with Kubb based on the native Fetch api.",
   "keywords": [
     "api-client",
@@ -39,6 +39,8 @@
     "src",
     "dist",
     "templates",
+    "kubb-extension.json",
+    "OVERVIEW.md",
     "!/**/**.test.**",
     "!/**/__tests__/**",
     "!/**/__snapshots__/**"
@@ -58,6 +60,7 @@
       "require": "./dist/index.cjs"
     },
     "./package.json": "./package.json",
+    "./kubb-extension.json": "./kubb-extension.json",
     "./templates/*": "./templates/*"
   },
   "publishConfig": {
@@ -65,17 +68,17 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/plugin-ts": "^5.0.6",
-    "@kubb/plugin-zod": "^5.4.4"
+    "@kubb/plugin-ts": "^5.0.8",
+    "@kubb/plugin-zod": "^5.4.6"
   },
   "devDependencies": {
     "@internals/client": "0.0.0",
     "@internals/shared": "0.0.0",
-    "kubb": "^5.6.3",
+    "kubb": "^5.8.1",
     "typescript": "^6.0.3"
   },
   "peerDependencies": {
-    "kubb": "^5.6.3"
+    "kubb": "^5.8.1"
   },
   "engines": {
     "node": ">=22"

package/src/plugin.ts

@@ -1,7 +1,9 @@
 import path from 'node:path'
 import { createSdkGenerator, defaultMacros, resolverClient } from '@internals/client'
 import { createGroupConfig } from '@internals/shared'
-import { definePlugin, Resolver } from 'kubb/kit'
+import { addGenerator, definePlugin, injectFile, Resolver, setMacros, setResolver, useConfig } from 'kubb/kit'
+import { compatibility } from '../kubb-extension.json'
+import { version } from '../package.json'
 import { pluginTsName } from '@kubb/plugin-ts'
 import { pluginZodName } from '@kubb/plugin-zod'
 import { clientGenerator } from './generators/clientGenerator.tsx'
@@ -36,77 +38,72 @@ export const pluginFetchName = 'plugin-fetch' satisfies PluginFetch['name']
  * })
  * ```
  */
-export const pluginFetch = definePlugin<PluginFetch>((options) => {
-  const {
-    output = { path: 'clients', barrel: { type: 'named' } },
-    exclude = [],
-    include,
-    override = [],
-    baseURL,
-    throwOnErrorDefault = true,
-    validator = false,
-    returnType = 'full',
-    group,
-    sdk,
-    resolver: userResolver,
-  } = options
+export const pluginFetch = definePlugin<PluginFetch>({
+  meta: { name: pluginFetchName, version, compatibility },
+  // Both are ordering hints, skipped when the plugin is not in the pipeline. `plugin-ts` supplies
+  // the operation types unless it is absent, in which case `pluginZod({ inferred: true })` does.
+  dependencies: { [pluginTsName]: { optional: true }, [pluginZodName]: { optional: true } },
+  setup(options) {
+    const config = useConfig()
+    const {
+      output = { path: 'clients', barrel: { type: 'named' } },
+      exclude = [],
+      include,
+      override = [],
+      baseURL,
+      throwOnErrorDefault = true,
+      validator = false,
+      returnType = 'full',
+      group,
+      sdk,
+      resolver: userResolver,
+    } = options
 
-  const resolved: ResolvedOptions = {
-    output,
-    exclude,
-    include,
-    override,
-    group: createGroupConfig(group),
-    baseURL,
-    throwOnErrorDefault,
-    validator,
-    returnType,
-    sdk: sdk ? { mode: sdk.mode ?? 'tag', name: sdk.name } : undefined,
-    resolver: userResolver ? Resolver.merge<ResolverClient>(resolverClient, userResolver) : resolverClient,
-  }
+    const resolved: ResolvedOptions = {
+      output,
+      exclude,
+      include,
+      override,
+      group: createGroupConfig(group),
+      baseURL,
+      throwOnErrorDefault,
+      validator,
+      returnType,
+      sdk: sdk ? { mode: sdk.mode ?? 'tag', name: sdk.name } : undefined,
+      resolver: userResolver ? Resolver.merge<ResolverClient>(resolverClient, userResolver) : resolverClient,
+    }
 
-  // `sdk` swaps the per-operation functions for the class-based SDK; left unset, the standalone
-  // functions (which query plugins consume) stay.
-  const selectedGenerators = resolved.sdk ? [createSdkGenerator<PluginFetch>()] : [clientGenerator]
+    setResolver(resolved.resolver)
+    setMacros([...defaultMacros, ...(options.macros ?? [])])
 
-  return {
-    name: pluginFetchName,
-    options,
-    // Both are ordering hints, dropped when the plugin is not in the pipeline. `plugin-ts` supplies
-    // the operation types unless it is absent, in which case `pluginZod({ inferred: true })` does.
-    dependencies: [pluginTsName, pluginZodName],
-    hooks: {
-      'kubb:plugin:setup'(ctx) {
-        ctx.setOptions(resolved)
-        ctx.setResolver(resolved.resolver)
-        ctx.setMacros([...defaultMacros, ...(options.macros ?? [])])
+    // `sdk` swaps the per-operation functions for the class-based SDK; left unset, the standalone
+    // functions (which query plugins consume) stay.
+    addGenerator(resolved.sdk ? createSdkGenerator<PluginFetch>() : clientGenerator)
 
-        ctx.addGenerator(...selectedGenerators)
+    const root = path.resolve(config.root, config.output.path)
+    const baseURLExpression = baseURL ? (baseURL.includes('${') ? `\`${baseURL.replaceAll('`', '\\`')}\`` : JSON.stringify(baseURL)) : undefined
 
-        const root = path.resolve(ctx.config.root, ctx.config.output.path)
-        const baseURLExpression = baseURL ? (baseURL.includes('${') ? `\`${baseURL.replaceAll('`', '\\`')}\`` : JSON.stringify(baseURL)) : undefined
+    injectFile({
+      baseName: 'serializers.ts',
+      path: path.resolve(root, '.kubb/serializers.ts'),
+      copy: fetchSerializersTemplatePath,
+    })
 
-        ctx.injectFile({
-          baseName: 'serializers.ts',
-          path: path.resolve(root, '.kubb/serializers.ts'),
-          copy: fetchSerializersTemplatePath,
-        })
+    injectFile({
+      baseName: 'client.ts',
+      path: path.resolve(root, '.kubb/client.ts'),
+      copy: fetchClientTemplatePath,
+      footer: baseURLExpression ? `client.setConfig({ baseURL: ${baseURLExpression} })` : undefined,
+    })
 
-        ctx.injectFile({
-          baseName: 'client.ts',
-          path: path.resolve(root, '.kubb/client.ts'),
-          copy: fetchClientTemplatePath,
-          footer: baseURLExpression ? `client.setConfig({ baseURL: ${baseURLExpression} })` : undefined,
-        })
+    injectFile({
+      baseName: 'standardSchema.ts',
+      path: path.resolve(root, '.kubb/standardSchema.ts'),
+      copy: standardSchemaTemplatePath,
+    })
 
-        ctx.injectFile({
-          baseName: 'standardSchema.ts',
-          path: path.resolve(root, '.kubb/standardSchema.ts'),
-          copy: standardSchemaTemplatePath,
-        })
-      },
-    },
-  }
+    return resolved
+  },
 })
 
 export default pluginFetch