Merge pull request #1472 from kubb-labs/fix/1470-enhance-jsdocs

kubb-labs · Dec 16, 2024 · 45ecf9f · 45ecf9f
2 parents 4eb9c46 + d8ffbfd
commit 45ecf9f
Show file tree

Hide file tree

Showing 37 changed files with 240 additions and 146 deletions.
diff --git a/.changeset/famous-keys-eat.md b/.changeset/famous-keys-eat.md
@@ -0,0 +1,5 @@
+---
+"@kubb/plugin-client": patch
+---
+
+baseURL could be undefined, do not throw error if that is the case
diff --git a/.changeset/large-boxes-itch.md b/.changeset/large-boxes-itch.md
@@ -0,0 +1,5 @@
+---
+"@kubb/plugin-ts": patch
+---
+
+minLength, maxLength, pattern as part of the jsdocs
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -4,6 +4,10 @@ title: Changelog
 
 # Changelog
 
+## 3.3.4
+- [`plugin-ts`](/plugins/plugin-ts): minLength, maxLength, pattern as part of the jsdocs
+- [`plugin-client`](/plugins/plugin-client): baseURL could be undefined, do not throw error if that is the case
+
 ## 3.3.3
 - [`react`](/helpers/react/): Use of `@kubb/react` as importSource for jsx(React 17, React 18, React 19 could be used next to Kubb)
 - [`cli`](/helpers/cli/): Use of `@kubb/react` as importSource for jsx(React 17, React 18, React 19 could be used next to Kubb)

diff --git a/e2e/package.json b/e2e/package.json
@@ -37,7 +37,7 @@
     "@tanstack/svelte-query": "^5.62.7",
     "@tanstack/vue-query": "^5.62.7",
     "axios": "^1.7.9",
-    "msw": "^2.6.8",
+    "msw": "^2.6.9",
     "react": "catalog:",
     "solid-js": "^1.9.3",
     "svelte": "^3.59.2",

diff --git a/examples/advanced/package.json b/examples/advanced/package.json
@@ -43,9 +43,9 @@
     "@tanstack/solid-query": "^5.62.7",
     "@tanstack/svelte-query": "^5.62.7",
     "@tanstack/vue-query": "^5.62.7",
-    "axios": "^1.7.9",
-    "msw": "^2.6.8",
     "@types/react": "^19.0.1",
+    "axios": "^1.7.9",
+    "msw": "^2.6.9",
     "react": "^19.0.0",
     "solid-js": "^1.9.3",
     "svelte": "^3.59.2",

diff --git a/examples/advanced/petStore.yaml b/examples/advanced/petStore.yaml
@@ -844,11 +844,16 @@ components:
       xml:
         name: user
     tag.Tag:
+      deprecated: true
       type: object
       properties:
         id:
           type: integer
           format: int64
+          minLength: 5
+          maxLength: 7
+          default: 1
+          deprecated: true
         name:
           type: string
       xml:

diff --git a/examples/advanced/src/gen/docs.html b/examples/advanced/src/gen/docs.html
diff --git a/examples/advanced/src/gen/models/ts/tag/Tag.ts b/examples/advanced/src/gen/models/ts/tag/Tag.ts
@@ -1,5 +1,12 @@
+/**
+ * @deprecated
+ */
 export type TagTag = {
   /**
+   * @deprecated
+   * @minLength 5
+   * @maxLength 7
+   * @default 1
    * @type integer | undefined, int64
    */
   id?: number

diff --git a/examples/advanced/src/gen/schemas/addPetRequest.json b/examples/advanced/src/gen/schemas/addPetRequest.json
@@ -15,8 +15,12 @@
       "type": "array",
       "xml": { "wrapped": true },
       "items": {
+        "deprecated": true,
         "type": "object",
-        "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
+        "properties": {
+          "id": { "type": "integer", "format": "int64", "minLength": 5, "maxLength": 7, "default": 1, "deprecated": true },
+          "name": { "type": "string" }
+        },
         "xml": { "name": "tag" },
         "x-readme-ref-name": "tag.Tag"
       }

diff --git a/examples/advanced/src/gen/schemas/pet.json b/examples/advanced/src/gen/schemas/pet.json
@@ -15,8 +15,12 @@
       "type": "array",
       "xml": { "wrapped": true },
       "items": {
+        "deprecated": true,
         "type": "object",
-        "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
+        "properties": {
+          "id": { "type": "integer", "format": "int64", "minLength": 5, "maxLength": 7, "default": 1, "deprecated": true },
+          "name": { "type": "string" }
+        },
         "xml": { "name": "tag" },
         "x-readme-ref-name": "tag.Tag"
       }

diff --git a/examples/advanced/src/gen/schemas/tagTag.json b/examples/advanced/src/gen/schemas/tagTag.json
@@ -1,6 +1,10 @@
 {
+  "deprecated": true,
   "type": "object",
-  "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
+  "properties": {
+    "id": { "type": "integer", "format": "int64", "minLength": 5, "maxLength": 7, "default": 1, "deprecated": true },
+    "name": { "type": "string" }
+  },
   "xml": { "name": "tag" },
   "x-readme-ref-name": "tag.Tag"
 }
diff --git a/examples/advanced/src/gen/schemas2/addPetRequest.json b/examples/advanced/src/gen/schemas2/addPetRequest.json
@@ -15,8 +15,12 @@
       "type": "array",
       "xml": { "wrapped": true },
       "items": {
+        "deprecated": true,
         "type": "object",
-        "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
+        "properties": {
+          "id": { "type": "integer", "format": "int64", "minLength": 5, "maxLength": 7, "default": 1, "deprecated": true },
+          "name": { "type": "string" }
+        },
         "xml": { "name": "tag" },
         "x-readme-ref-name": "tag.Tag"
       }

diff --git a/examples/advanced/src/gen/schemas2/pet.json b/examples/advanced/src/gen/schemas2/pet.json
@@ -15,8 +15,12 @@
       "type": "array",
       "xml": { "wrapped": true },
       "items": {
+        "deprecated": true,
         "type": "object",
-        "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
+        "properties": {
+          "id": { "type": "integer", "format": "int64", "minLength": 5, "maxLength": 7, "default": 1, "deprecated": true },
+          "name": { "type": "string" }
+        },
         "xml": { "name": "tag" },
         "x-readme-ref-name": "tag.Tag"
       }

diff --git a/examples/advanced/src/gen/schemas2/tagTag.json b/examples/advanced/src/gen/schemas2/tagTag.json
@@ -1,6 +1,10 @@
 {
+  "deprecated": true,
   "type": "object",
-  "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
+  "properties": {
+    "id": { "type": "integer", "format": "int64", "minLength": 5, "maxLength": 7, "default": 1, "deprecated": true },
+    "name": { "type": "string" }
+  },
   "xml": { "name": "tag" },
   "x-readme-ref-name": "tag.Tag"
 }
diff --git a/examples/advanced/src/gen/zod/tag/tagSchema.ts b/examples/advanced/src/gen/zod/tag/tagSchema.ts
@@ -3,7 +3,7 @@ import type { ToZod } from '@kubb/plugin-zod/utils'
 import { z } from 'zod'
 
 export const tagTagSchema = z.object({
-  id: z.number().int().optional(),
+  id: z.number().int().min(5).max(7).default(1),
   name: z.string().optional(),
 } satisfies ToZod<TagTag>)
 

diff --git a/examples/faker/src/gen/models/User.ts b/examples/faker/src/gen/models/User.ts
@@ -33,6 +33,7 @@ export type User = {
    */
   userStatus?: number
   /**
+   * @pattern ^[A-Z]{2}$
    * @type string | undefined
    */
   nationalityCode?: string

diff --git a/examples/msw/package.json b/examples/msw/package.json
@@ -33,7 +33,7 @@
     "@kubb/plugin-oas": "workspace:*",
     "@kubb/plugin-ts": "workspace:*",
     "@mswjs/http-middleware": "^0.9.2",
-    "msw": "^2.6.8",
+    "msw": "^2.6.9",
     "react": "^18.3.1",
     "tsup": "^8.3.5"
   },

diff --git a/examples/react-query/package.json b/examples/react-query/package.json
@@ -37,7 +37,7 @@
     "unplugin-kubb": "workspace:*"
   },
   "devDependencies": {
-    "@types/react": "^18.3.16",
+    "@types/react": "^18.3.17",
     "@types/react-dom": "^19.0.2",
     "@vitejs/plugin-react": "^4.3.4",
     "msw": "^1.3.5",

diff --git a/examples/react/package.json b/examples/react/package.json
@@ -29,7 +29,7 @@
   },
   "devDependencies": {
     "@kubb/config-ts": "workspace:*",
-    "@types/react": "^18.3.16",
+    "@types/react": "^18.3.17",
     "react": "^18.3.1",
     "tsup": "^8.3.5",
     "typescript": "^5.7.2"

diff --git a/examples/zod/src/gen/ts/PetType.ts b/examples/zod/src/gen/ts/PetType.ts
@@ -15,6 +15,7 @@ export type PetType = {
    */
   id?: number
   /**
+   * @pattern ^[0-9]{1,19}$
    * @type string | undefined
    */
   internalId?: string

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -94,7 +94,7 @@
     "natural-orderby": "^5.0.0",
     "object-hash": "^3.0.0",
     "p-queue": "^8.0.1",
-    "remeda": "^2.17.4",
+    "remeda": "^2.18.0",
     "seedrandom": "^3.0.5",
     "semver": "^7.6.3"
   },

diff --git a/packages/oas/package.json b/packages/oas/package.json
@@ -66,7 +66,7 @@
     "oas": "^25.1.0",
     "oas-normalize": "^11.1.4",
     "openapi-types": "^12.1.3",
-    "remeda": "^2.17.4",
+    "remeda": "^2.18.0",
     "swagger2openapi": "^7.0.8",
     "ts-toolbelt": "^9.6.0"
   },

diff --git a/packages/parser-ts/package.json b/packages/parser-ts/package.json
@@ -60,7 +60,7 @@
   },
   "dependencies": {
     "prettier": "^3.4.2",
-    "remeda": "^2.17.4",
+    "remeda": "^2.18.0",
     "typescript": "catalog:"
   },
   "devDependencies": {

diff --git a/packages/parser-ts/src/factory.ts b/packages/parser-ts/src/factory.ts
@@ -269,12 +269,12 @@ export function createInterfaceDeclaration({
 export function createTypeDeclaration({
   syntax,
   isExportable,
-  description,
+  comments,
   name,
   type,
 }: {
   syntax: 'type' | 'interface'
-  description?: string
+  comments: Array<string | undefined>
   isExportable?: boolean
   name: string | ts.Identifier
   type: ts.TypeNode
@@ -289,7 +289,7 @@ export function createTypeDeclaration({
 
     return appendJSDocToNode({
       node,
-      comments: [description ? `@description ${description}` : undefined].filter(Boolean),
+      comments,
     })
   }
 
@@ -302,7 +302,7 @@ export function createTypeDeclaration({
 
   return appendJSDocToNode({
     node,
-    comments: [description ? `@description ${description}` : undefined].filter(Boolean),
+    comments,
   })
 }
 

diff --git a/packages/plugin-client/src/clients/fetch.ts b/packages/plugin-client/src/clients/fetch.ts
@@ -22,7 +22,7 @@ export type ResponseConfig<TData = unknown> = {
 }
 
 export const fetchClient = async <TData, TError = unknown, TVariables = unknown>(config: RequestConfig<TVariables>): Promise<ResponseConfig<TData>> => {
-  const response = await fetch(`${config.baseURL}${config.url}`, {
+  const response = await fetch([config.baseURL, config.url].filter(Boolean).join(''), {
     method: config.method.toUpperCase(),
     body: JSON.stringify(config.data),
     signal: config.signal,

diff --git a/packages/plugin-oas/package.json b/packages/plugin-oas/package.json
@@ -90,7 +90,7 @@
     "@kubb/oas": "workspace:*",
     "@kubb/react": "workspace:*",
     "@stoplight/yaml": "^4.3.0",
-    "remeda": "^2.17.4"
+    "remeda": "^2.18.0"
   },
   "devDependencies": {
     "@kubb/config-ts": "workspace:*",

diff --git a/packages/plugin-react-query/package.json b/packages/plugin-react-query/package.json
@@ -80,7 +80,7 @@
     "@kubb/plugin-ts": "workspace:*",
     "@kubb/plugin-zod": "workspace:*",
     "@kubb/react": "workspace:*",
-    "remeda": "^2.17.4"
+    "remeda": "^2.18.0"
   },
   "devDependencies": {
     "@kubb/config-ts": "workspace:*",

diff --git a/packages/plugin-solid-query/package.json b/packages/plugin-solid-query/package.json
@@ -80,7 +80,7 @@
     "@kubb/plugin-ts": "workspace:*",
     "@kubb/plugin-zod": "workspace:*",
     "@kubb/react": "workspace:*",
-    "remeda": "^2.17.4"
+    "remeda": "^2.18.0"
   },
   "devDependencies": {
     "@kubb/config-ts": "workspace:*",

diff --git a/packages/plugin-svelte-query/package.json b/packages/plugin-svelte-query/package.json
@@ -80,7 +80,7 @@
     "@kubb/plugin-ts": "workspace:*",
     "@kubb/plugin-zod": "workspace:*",
     "@kubb/react": "workspace:*",
-    "remeda": "^2.17.4"
+    "remeda": "^2.18.0"
   },
   "devDependencies": {
     "@kubb/config-ts": "workspace:*",

diff --git a/packages/plugin-swr/package.json b/packages/plugin-swr/package.json
@@ -82,7 +82,7 @@
     "@kubb/plugin-ts": "workspace:*",
     "@kubb/plugin-zod": "workspace:*",
     "@kubb/react": "workspace:*",
-    "remeda": "^2.17.4"
+    "remeda": "^2.18.0"
   },
   "devDependencies": {
     "@kubb/config-ts": "workspace:*",

diff --git a/packages/plugin-ts/src/__snapshots__/parser.test.ts.snap b/packages/plugin-ts/src/__snapshots__/parser.test.ts.snap
@@ -634,8 +634,20 @@ NodeObject {
   "kind": 187,
   "localSymbol": undefined,
   "members": [
-    NodeObject {
-      "emitNode": undefined,
+    {
+      "emitNode": {
+        "leadingComments": [
+          {
+            "end": -1,
+            "hasTrailingNewLine": true,
+            "kind": 3,
+            "pos": -1,
+            "text": "*
+ * @minLength 2
+",
+          },
+        ],
+      },
       "end": -1,
       "flags": 16,
       "id": 0,
@@ -795,6 +807,7 @@ NodeObject {
             "pos": -1,
             "text": "*
  * @deprecated
+ * @minLength 2
  * @default test
 ",
           },
@@ -849,6 +862,7 @@ NodeObject {
             "kind": 3,
             "pos": -1,
             "text": "*
+ * @minLength 3
  * @default 2
  * @example 2
 ",
@@ -1340,6 +1354,7 @@ NodeObject {
             "pos": -1,
             "text": "*
  * @description Your address
+ * @minLength 4
  * @type string, string
 ",
           },
@@ -1421,8 +1436,20 @@ NodeObject {
   "kind": 187,
   "localSymbol": undefined,
   "members": [
-    NodeObject {
-      "emitNode": undefined,
+    {
+      "emitNode": {
+        "leadingComments": [
+          {
+            "end": -1,
+            "hasTrailingNewLine": true,
+            "kind": 3,
+            "pos": -1,
+            "text": "*
+ * @minLength 2
+",
+          },
+        ],
+      },
       "end": -1,
       "flags": 16,
       "id": 0,