feat: support banner with context for Oas

kubb-labs · Jan 9, 2025 · d2b9643 · d2b9643
1 parent 8e03792
commit d2b9643
Show file tree

Hide file tree

Showing 88 changed files with 406 additions and 118 deletions.
diff --git a/.changeset/nine-onions-brake.md b/.changeset/nine-onions-brake.md
@@ -0,0 +1,17 @@
+---
+"@kubb/plugin-svelte-query": minor
+"@kubb/plugin-react-query": minor
+"@kubb/plugin-solid-query": minor
+"@kubb/plugin-vue-query": minor
+"@kubb/plugin-client": minor
+"@kubb/plugin-faker": minor
+"@kubb/plugin-redoc": minor
+"@kubb/plugin-msw": minor
+"@kubb/plugin-oas": minor
+"@kubb/plugin-swr": minor
+"@kubb/plugin-zod": minor
+"@kubb/plugin-ts": minor
+"@kubb/core": minor
+---
+
+support banner with context for Oas
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -4,6 +4,19 @@ title: Changelog
 
 # Changelog
 
+## 3.5.0
+- [`core`](/plugins/core): support banner with context for Oas
+```typescript
+pluginTs({
+  output: {
+    path: 'models',
+    banner(oas) {
+      return `// version: ${oas.api.info.version}`
+    },
+  },
+}),
+```
+
 ## 3.4.6
 - [`core`](/plugins/core): ignore acronyms when doing casing switch to pascal or camelcase
 

diff --git a/docs/plugins/plugin-client/index.md b/docs/plugins/plugin-client/index.md
@@ -69,15 +69,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 ### group

diff --git a/docs/plugins/plugin-faker/index.md b/docs/plugins/plugin-faker/index.md
@@ -69,15 +69,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 ### group

diff --git a/docs/plugins/plugin-msw/index.md b/docs/plugins/plugin-msw/index.md
@@ -69,15 +69,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 ### handlers

diff --git a/docs/plugins/plugin-oas/index.md b/docs/plugins/plugin-oas/index.md
@@ -63,18 +63,18 @@ Define what needs to be exported, here you can also disable the export of barrel
 #### output.banner
 Add a banner text in the beginning of every file.
 
-|           |                                       |
-|----------:|:--------------------------------------|
-|     Type: | `string` |
-| Required: | `false`                               |
+|           |                                  |
+|----------:|:---------------------------------|
+|     Type: | `string \| (oas: Oas) => string` |
+| Required: | `false`                          |
 
 #### output.footer
 Add a footer text at the end of every file.
 
-|           |                                       |
-|----------:|:--------------------------------------|
-|     Type: | `string` |
-| Required: | `false`                               |
+|           |         |
+|----------:|:--------|
+|     Type: | `string \| (oas: Oas) => string`        |
+| Required: | `false` |
 
 ### validate
 

diff --git a/docs/plugins/plugin-react-query/index.md b/docs/plugins/plugin-react-query/index.md
@@ -69,15 +69,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 ## Installation
 
@@ -139,15 +139,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 ### group

diff --git a/docs/plugins/plugin-solid-query/index.md b/docs/plugins/plugin-solid-query/index.md
@@ -69,15 +69,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 ### group

diff --git a/docs/plugins/plugin-svelte-query/index.md b/docs/plugins/plugin-svelte-query/index.md
@@ -69,15 +69,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 ### group

diff --git a/docs/plugins/plugin-swr/index.md b/docs/plugins/plugin-swr/index.md
@@ -69,15 +69,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 ### group

diff --git a/docs/plugins/plugin-ts/index.md b/docs/plugins/plugin-ts/index.md
@@ -67,15 +67,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 

diff --git a/docs/plugins/plugin-vue-query/index.md b/docs/plugins/plugin-vue-query/index.md
@@ -70,15 +70,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 ### group

diff --git a/docs/plugins/plugin-zod/index.md b/docs/plugins/plugin-zod/index.md
@@ -67,15 +67,15 @@ Add a banner text in the beginning of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 #### output.footer
 Add a footer text at the end of every file.
 
 |           |                                       |
 |----------:|:--------------------------------------|
-|     Type: | `string` |
+|     Type: | `string \| (oas: Oas) => string` |
 | Required: | `false`                               |
 
 ### group

diff --git a/examples/client/src/generators/clientStaticGenerator.tsx b/examples/client/src/generators/clientStaticGenerator.tsx
@@ -3,6 +3,8 @@ import type { PluginClient } from '@kubb/plugin-client'
 import { Client } from '@kubb/plugin-client/components'
 import { createReactGenerator } from '@kubb/plugin-oas'
 import { useOperationManager } from '@kubb/plugin-oas/hooks'
+import { useOas } from '@kubb/plugin-oas/hooks'
+import { getBanner, getFooter } from '@kubb/plugin-oas/utils'
 import { pluginTsName } from '@kubb/plugin-ts'
 import { File, useApp } from '@kubb/react'
 
@@ -14,6 +16,7 @@ export const clientStaticGenerator = createReactGenerator<PluginClient>({
         options: { output },
       },
     } = useApp<PluginClient>()
+    const oas = useOas()
     const { getSchemas, getName, getFile } = useOperationManager()
 
     const client = {
@@ -27,7 +30,13 @@ export const clientStaticGenerator = createReactGenerator<PluginClient>({
     }
 
     return (
-      <File baseName={client.file.baseName} path={client.file.path} meta={client.file.meta} banner={output?.banner} footer={output?.footer}>
+      <File
+        baseName={client.file.baseName}
+        path={client.file.path}
+        meta={client.file.meta}
+        banner={getBanner({ oas, output })}
+        footer={getFooter({ oas, output })}
+      >
         <File.Import name={'client'} path={options.importPath} />
         <File.Import name={['RequestConfig', 'ResponseErrorConfig']} path={options.importPath} isTypeOnly />
         <File.Import

diff --git a/examples/react-query/kubb.config.ts b/examples/react-query/kubb.config.ts
@@ -22,6 +22,9 @@ export const config = {
     pluginTs({
       output: {
         path: 'models',
+        banner(oas) {
+          return `// version: ${oas.api.info.version}`
+        },
       },
     }),
     pluginReactQuery({

diff --git a/examples/react-query/src/gen/models/AddPet.ts b/examples/react-query/src/gen/models/AddPet.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { AddPetRequest } from './AddPetRequest.ts'
 import type { Pet } from './Pet.ts'
 

diff --git a/examples/react-query/src/gen/models/AddPetRequest.ts b/examples/react-query/src/gen/models/AddPetRequest.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { Category } from './Category.ts'
 import type { Tag } from './Tag.ts'
 

diff --git a/examples/react-query/src/gen/models/Address.ts b/examples/react-query/src/gen/models/Address.ts
@@ -1,3 +1,5 @@
+// version: 1.0.11
+
 export type Address = {
   /**
    * @type string | undefined

diff --git a/examples/react-query/src/gen/models/ApiResponse.ts b/examples/react-query/src/gen/models/ApiResponse.ts
@@ -1,3 +1,5 @@
+// version: 1.0.11
+
 export type ApiResponse = {
   /**
    * @type integer | undefined, int32

diff --git a/examples/react-query/src/gen/models/Category.ts b/examples/react-query/src/gen/models/Category.ts
@@ -1,3 +1,5 @@
+// version: 1.0.11
+
 export type Category = {
   /**
    * @type integer | undefined, int64

diff --git a/examples/react-query/src/gen/models/CreateUser.ts b/examples/react-query/src/gen/models/CreateUser.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { User } from './User.ts'
 
 /**

diff --git a/examples/react-query/src/gen/models/CreateUsersWithListInput.ts b/examples/react-query/src/gen/models/CreateUsersWithListInput.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { User } from './User.ts'
 
 /**

diff --git a/examples/react-query/src/gen/models/Customer.ts b/examples/react-query/src/gen/models/Customer.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { Address } from './Address.ts'
 
 export type Customer = {

diff --git a/examples/react-query/src/gen/models/DeleteOrder.ts b/examples/react-query/src/gen/models/DeleteOrder.ts
@@ -1,3 +1,5 @@
+// version: 1.0.11
+
 export type DeleteOrderPathParams = {
   /**
    * @description ID of the order that needs to be deleted

diff --git a/examples/react-query/src/gen/models/DeletePet.ts b/examples/react-query/src/gen/models/DeletePet.ts
@@ -1,3 +1,5 @@
+// version: 1.0.11
+
 export type DeletePetPathParams = {
   /**
    * @description Pet id to delete

diff --git a/examples/react-query/src/gen/models/DeleteUser.ts b/examples/react-query/src/gen/models/DeleteUser.ts
@@ -1,3 +1,5 @@
+// version: 1.0.11
+
 export type DeleteUserPathParams = {
   /**
    * @description The name that needs to be deleted

diff --git a/examples/react-query/src/gen/models/FindPetsByStatus.ts b/examples/react-query/src/gen/models/FindPetsByStatus.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { Pet } from './Pet.ts'
 
 export const findPetsByStatusQueryParamsStatusEnum = {

diff --git a/examples/react-query/src/gen/models/FindPetsByTags.ts b/examples/react-query/src/gen/models/FindPetsByTags.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { Pet } from './Pet.ts'
 
 export type FindPetsByTagsQueryParams = {

diff --git a/examples/react-query/src/gen/models/GetInventory.ts b/examples/react-query/src/gen/models/GetInventory.ts
@@ -1,3 +1,5 @@
+// version: 1.0.11
+
 /**
  * @description successful operation
  */

diff --git a/examples/react-query/src/gen/models/GetOrderById.ts b/examples/react-query/src/gen/models/GetOrderById.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { Order } from './Order.ts'
 
 export type GetOrderByIdPathParams = {

diff --git a/examples/react-query/src/gen/models/GetPetById.ts b/examples/react-query/src/gen/models/GetPetById.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { Pet } from './Pet.ts'
 
 export type GetPetByIdPathParams = {

diff --git a/examples/react-query/src/gen/models/GetUserByName.ts b/examples/react-query/src/gen/models/GetUserByName.ts
@@ -1,3 +1,4 @@
+// version: 1.0.11
 import type { User } from './User.ts'
 
 export type GetUserByNamePathParams = {