@kubb/plugin-fetch 5.5.8 → 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.8",
+  "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.7",
-    "@kubb/plugin-zod": "^5.4.5"
+    "@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.8.0",
+    "kubb": "^5.8.1",
     "typescript": "^6.0.3"
   },
   "peerDependencies": {
-    "kubb": "^5.8.0"
+    "kubb": "^5.8.1"
   },
   "engines": {
     "node": ">=22"

package/src/plugin.ts

@@ -2,6 +2,7 @@ import path from 'node:path'
 import { createSdkGenerator, defaultMacros, resolverClient } from '@internals/client'
 import { createGroupConfig } from '@internals/shared'
 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'
@@ -38,7 +39,7 @@ export const pluginFetchName = 'plugin-fetch' satisfies PluginFetch['name']
  * ```
  */
 export const pluginFetch = definePlugin<PluginFetch>({
-  meta: { name: pluginFetchName, version, compatibility: { kubb: '>=5.8.0' } },
+  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 } },