@kubb/swagger-ts 2.0.0-beta.4 → 2.0.0-beta.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/swagger-ts",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.6",
   "description": "Generator swagger-ts",
   "keywords": [
     "typescript",
@@ -44,10 +44,10 @@
   ],
   "dependencies": {
     "typescript": "^5.3.2",
-    "@kubb/core": "2.0.0-beta.4",
-    "@kubb/parser": "2.0.0-beta.4",
-    "@kubb/react": "2.0.0-beta.4",
-    "@kubb/swagger": "2.0.0-beta.4"
+    "@kubb/core": "2.0.0-beta.6",
+    "@kubb/parser": "2.0.0-beta.6",
+    "@kubb/react": "2.0.0-beta.6",
+    "@kubb/swagger": "2.0.0-beta.6"
   },
   "devDependencies": {
     "@types/react": "^18.2.38",
@@ -60,7 +60,7 @@
   },
   "peerDependencies": {
     "typescript": "^5.3.0",
-    "@kubb/react": "2.0.0-beta.4"
+    "@kubb/react": "2.0.0-beta.6"
   },
   "packageManager": "pnpm@8.3.0",
   "engines": {

package/src/TypeGenerator.ts

@@ -2,6 +2,7 @@ import { Generator } from '@kubb/core'
 import transformers from '@kubb/core/transformers'
 import { getUniqueName } from '@kubb/core/utils'
 import * as factory from '@kubb/parser/factory'
+import { keywordTypeNodes } from '@kubb/parser/factory'
 import { getSchemaFactory, isReference } from '@kubb/swagger/utils'
 
 import { pluginKey } from './plugin.ts'
@@ -332,8 +333,32 @@ export class TypeGenerator extends Generator<PluginOptions['resolvedOptions'], C
       return this.#getTypeFromProperties(schema, baseName)
     }
 
+    /**
+     * validate "const" property as defined in JSON-Schema-Validation
+     *
+     * https://json-schema.org/draft/2020-12/json-schema-validation#name-const
+     *
+     * > 6.1.3. const
+     * > The value of this keyword MAY be of any type, including null.
+     * > Use of this keyword is functionally equivalent to an "enum" (Section 6.1.2) with a single value.
+     * > An instance validates successfully against this keyword if its value is equal to the value of the keyword.
+     */
+    if (version === '3.1' && 'const' in schema) {
+      // const keyword takes precendence over the actual type.
+      if (schema['const']) {
+        if (typeof schema['const'] === 'string') {
+          return factory.createLiteralTypeNode(factory.createStringLiteral(schema['const']))
+        } else if (typeof schema['const'] === 'number') {
+          return factory.createLiteralTypeNode(factory.createNumericLiteral(schema['const']))
+        }
+      } else {
+        return keywordTypeNodes.null
+      }
+    }
+
     if (schema.type) {
       if (Array.isArray(schema.type)) {
+        // TODO  remove hardcoded first type, second nullable
         // OPENAPI v3.1.0: https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
         const [type, nullable] = schema.type as Array<OpenAPIV3_1.NonArraySchemaObjectType>
 
@@ -365,11 +390,6 @@ export class TypeGenerator extends Generator<PluginOptions['resolvedOptions'], C
       return factory.createTypeReferenceNode('Blob', [])
     }
 
-    // detect assertion "const" and define the type property as a Literal
-    if (version === '3.1' && typeof schema['const'] === 'string') {
-      return factory.createLiteralTypeNode(factory.createStringLiteral(schema['const']))
-    }
-
     return factory.keywordTypeNodes.any
   }
 }

package/src/components/Mutation.tsx

@@ -6,11 +6,11 @@ import { useOas, useOperation, useOperationFile, useOperationName, useSchemas }
 
 import { TypeBuilder } from '../TypeBuilder.ts'
 
+import type { KubbFile } from '@kubb/core'
 import type { ts } from '@kubb/parser'
 import type { Operation, OperationSchemas } from '@kubb/swagger'
 import type { ReactNode } from 'react'
 import type { FileMeta, PluginOptions } from '../types.ts'
-import type { KubbFile } from '@kubb/core'
 
 type Props = {
   builder: TypeBuilder

package/src/components/Query.tsx

@@ -6,11 +6,11 @@ import { useOas, useOperation, useOperationFile, useOperationName, useSchemas }
 
 import { TypeBuilder } from '../TypeBuilder.ts'
 
+import type { KubbFile } from '@kubb/core'
 import type { ts } from '@kubb/parser'
 import type { Operation, OperationSchemas } from '@kubb/swagger'
 import type { ReactNode } from 'react'
 import type { FileMeta, PluginOptions } from '../types.ts'
-import type { KubbFile } from '@kubb/core'
 
 type Props = {
   builder: TypeBuilder
@@ -93,7 +93,6 @@ export function Query({
   )
 }
 
-// eslint-disable-next-line @typescript-eslint/ban-types
 type FileProps = {
   mode: KubbFile.Mode
 }