kubb 5.0.0-beta.6 → 5.0.0-beta.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +12 -16
  2. package/dist/index.d.ts +1 -2
  3. package/package.json +11 -14
  4. package/src/index.ts +0 -1
package/README.md CHANGED
@@ -1,4 +1,5 @@
1
1
  <div align="center">
2
+ <h1>kubb</h1>
2
3
  <a href="https://kubb.dev" target="_blank" rel="noopener noreferrer">
3
4
  <img width="180" src="https://raw.githubusercontent.com/kubb-labs/kubb/main/assets/logo.png" alt="Kubb logo">
4
5
  </a>
@@ -11,7 +12,7 @@
11
12
 
12
13
  ### The meta framework for code generation
13
14
 
14
- **Stop writing glue code. Define your API once and Kubb generates types, clients, hooks, validators, mocks and more.**
15
+ Point Kubb at an OpenAPI spec and it generates types, clients, hooks, validators, mocks, and more.
15
16
 
16
17
  <h4>
17
18
  <a href="https://kubb.dev" target="_blank">Documentation</a>
@@ -27,27 +28,22 @@
27
28
  ## Installation
28
29
 
29
30
  ```bash
30
- npm install kubb
31
+ bun add kubb
31
32
  # or
32
33
  pnpm add kubb
34
+ # or
35
+ npm install kubb
33
36
  ```
34
37
 
35
- ## Quick Start
38
+ ## Quick start
36
39
 
37
- Get started with Kubb in seconds:
40
+ Run the setup wizard to create a `kubb.config.ts`:
38
41
 
39
42
  ```bash
40
43
  npx kubb init
41
44
  ```
42
45
 
43
- The interactive setup will:
44
-
45
- - Create a `package.json` (if needed)
46
- - Guide you through plugin selection
47
- - Install packages automatically
48
- - Generate `kubb.config.ts`
49
-
50
- Then generate your code:
46
+ The wizard creates a `package.json` if needed, guides you through plugin selection, installs packages, and writes `kubb.config.ts`. Then generate your code:
51
47
 
52
48
  ```bash
53
49
  npx kubb generate
@@ -58,12 +54,12 @@ See the [documentation](https://kubb.dev) for detailed usage and advanced featur
58
54
  ## Features
59
55
 
60
56
  - Works with Node.js 22+ and TypeScript 6.
61
- - Convert Swagger 2.0, OpenAPI 3.0, and OpenAPI 3.1 to TypeScript types, API clients, and more via the [plugin ecosystem](https://github.com/kubb-labs/kubb-plugins).
62
- - Extensible plugin and middleware system for customizing and composing code generation.
63
- - CLI support with interactive setup, progress bar, and detailed logs.
57
+ - Converts Swagger 2.0, OpenAPI 3.0, and OpenAPI 3.1 into TypeScript types, API clients, and more via the [plugin ecosystem](https://github.com/kubb-labs/kubb-plugins).
58
+ - Extensible plugin and middleware system that you can compose for custom code generation pipelines.
59
+ - CLI with interactive setup, progress bar, and detailed logs.
64
60
  - Model Context Protocol (MCP) server for AI assistants like [Claude](https://claude.ai), [Cursor](https://cursor.sh), and other MCP-compatible tools.
65
61
  - JSX-based renderer (`@kubb/renderer-jsx`) for building custom plugin output.
66
- - Barrel file generation via the `@kubb/middleware-barrel` middleware.
62
+ - Barrel file generation via `@kubb/middleware-barrel`.
67
63
 
68
64
  ## Supporting Kubb
69
65
 
package/dist/index.d.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  import { t as __name } from "./chunk--u3MIqq1.js";
2
- import { BarrelType } from "@kubb/middleware-barrel";
3
2
  import { CLIOptions, UserConfig } from "@kubb/core";
4
3
 
5
4
  //#region ../../internals/utils/src/promise.d.ts
@@ -40,5 +39,5 @@ type DefinedConfig<TConfig extends ConfigInput> = TConfig extends ((cli: CLIOpti
40
39
  */
41
40
  declare function defineConfig<TConfig extends ConfigInput>(config: TConfig): DefinedConfig<TConfig>;
42
41
  //#endregion
43
- export { type BarrelType, defineConfig };
42
+ export { defineConfig };
44
43
  //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,24 +1,21 @@
1
1
  {
2
2
  "name": "kubb",
3
- "version": "5.0.0-beta.6",
4
- "description": "Transform OpenAPI specifications into TypeScript, React-Query, Zod, Faker.js, MSW and more with a plugin-based code generation tool.",
3
+ "version": "5.0.0-beta.7",
4
+ "description": "Meta-package and entry point for Kubb — a plugin-based code generation framework for OpenAPI. Includes defineConfig, all public APIs, and serves as the gateway to the entire Kubb ecosystem.",
5
5
  "keywords": [
6
6
  "api-client",
7
- "cli",
8
7
  "code-generator",
9
8
  "codegen",
10
9
  "faker",
11
10
  "kubb",
11
+ "meta-framework",
12
12
  "msw",
13
- "oas",
14
13
  "openapi",
15
14
  "plugin-system",
16
- "plugins",
17
15
  "react-query",
18
16
  "sdk-generator",
19
17
  "swagger",
20
18
  "tanstack-query",
21
- "type-safe",
22
19
  "typescript",
23
20
  "zod"
24
21
  ],
@@ -57,20 +54,20 @@
57
54
  "registry": "https://registry.npmjs.org/"
58
55
  },
59
56
  "dependencies": {
60
- "@kubb/adapter-oas": "5.0.0-beta.6",
61
- "@kubb/cli": "5.0.0-beta.6",
62
- "@kubb/core": "5.0.0-beta.6",
63
- "@kubb/middleware-barrel": "5.0.0-beta.6",
64
- "@kubb/parser-ts": "5.0.0-beta.6",
65
- "@kubb/renderer-jsx": "5.0.0-beta.6"
57
+ "@kubb/adapter-oas": "5.0.0-beta.7",
58
+ "@kubb/cli": "5.0.0-beta.7",
59
+ "@kubb/core": "5.0.0-beta.7",
60
+ "@kubb/middleware-barrel": "5.0.0-beta.7",
61
+ "@kubb/parser-ts": "5.0.0-beta.7",
62
+ "@kubb/renderer-jsx": "5.0.0-beta.7"
66
63
  },
67
64
  "devDependencies": {
68
65
  "typescript": "^6.0.3",
69
66
  "@internals/utils": "0.0.0"
70
67
  },
71
68
  "peerDependencies": {
72
- "@kubb/agent": "5.0.0-beta.6",
73
- "@kubb/mcp": "5.0.0-beta.6"
69
+ "@kubb/agent": "5.0.0-beta.7",
70
+ "@kubb/mcp": "5.0.0-beta.7"
74
71
  },
75
72
  "peerDependenciesMeta": {
76
73
  "@kubb/agent": {
package/src/index.ts CHANGED
@@ -1,2 +1 @@
1
- export type { BarrelType } from '@kubb/middleware-barrel'
2
1
  export { defineConfig } from './defineConfig.ts'