@kubb/plugin-ts 5.0.0-alpha.9 → 5.0.0-beta.100

package/src/components/Type.tsx

@@ -1,190 +0,0 @@
-import { camelCase, jsStringEscape, pascalCase, trimQuotes } from '@internals/utils'
-import { safePrint } from '@kubb/fabric-core/parsers/typescript'
-import type { SchemaObject } from '@kubb/oas'
-import { isKeyword, type Schema, SchemaGenerator, schemaKeywords } from '@kubb/plugin-oas'
-import { File } from '@kubb/react-fabric'
-import type { FabricReactNode } from '@kubb/react-fabric/types'
-import type ts from 'typescript'
-import * as factory from '../factory.ts'
-import { parse, typeKeywordMapper } from '../parser.ts'
-import type { PluginTs } from '../types.ts'
-
-type Props = {
-  name: string
-  typedName: string
-  schema: SchemaObject
-  tree: Array<Schema>
-  optionalType: PluginTs['resolvedOptions']['optionalType']
-  arrayType: PluginTs['resolvedOptions']['arrayType']
-  enumType: PluginTs['resolvedOptions']['enumType']
-  enumKeyCasing: PluginTs['resolvedOptions']['enumKeyCasing']
-  syntaxType: PluginTs['resolvedOptions']['syntaxType']
-  description?: string
-  keysToOmit?: string[]
-}
-
-export function Type({
-  name,
-  typedName,
-  tree,
-  keysToOmit,
-  schema,
-  optionalType,
-  arrayType,
-  syntaxType,
-  enumType,
-  enumKeyCasing,
-  description,
-}: Props): FabricReactNode {
-  const typeNodes: ts.Node[] = []
-
-  if (!tree.length) {
-    return ''
-  }
-
-  const schemaFromTree = tree.find((item) => item.keyword === schemaKeywords.schema)
-  const enumSchemas = SchemaGenerator.deepSearch(tree, schemaKeywords.enum)
-
-  let type =
-    (tree
-      .map((current, _index, siblings) =>
-        parse(
-          { name, schema, parent: undefined, current, siblings },
-          {
-            optionalType,
-            arrayType,
-            enumType,
-          },
-        ),
-      )
-      .filter(Boolean)
-      .at(0) as ts.TypeNode) || typeKeywordMapper.undefined()
-
-  // Add a "Key" suffix to avoid collisions where necessary
-  if (['asConst', 'asPascalConst'].includes(enumType) && enumSchemas.length > 0) {
-    const isDirectEnum = schema.type === 'array' && schema.items !== undefined
-    const isEnumOnly = 'enum' in schema && schema.enum
-
-    if (isDirectEnum || isEnumOnly) {
-      const enumSchema = enumSchemas[0]!
-      const typeNameWithKey = `${enumSchema.args.typeName}Key`
-
-      type = factory.createTypeReferenceNode(typeNameWithKey)
-
-      if (schema.type === 'array') {
-        if (arrayType === 'generic') {
-          type = factory.createTypeReferenceNode(factory.createIdentifier('Array'), [type])
-        } else {
-          type = factory.createArrayTypeNode(type)
-        }
-      }
-    }
-  }
-
-  if (schemaFromTree && isKeyword(schemaFromTree, schemaKeywords.schema)) {
-    const isNullish = tree.some((item) => item.keyword === schemaKeywords.nullish)
-    const isNullable = tree.some((item) => item.keyword === schemaKeywords.nullable)
-    const isOptional = tree.some((item) => item.keyword === schemaKeywords.optional)
-
-    if (isNullable) {
-      type = factory.createUnionDeclaration({
-        nodes: [type, factory.keywordTypeNodes.null],
-      }) as ts.TypeNode
-    }
-
-    if (isNullish && ['undefined', 'questionTokenAndUndefined'].includes(optionalType as string)) {
-      type = factory.createUnionDeclaration({
-        nodes: [type, factory.keywordTypeNodes.undefined],
-      }) as ts.TypeNode
-    }
-
-    if (isOptional && ['undefined', 'questionTokenAndUndefined'].includes(optionalType as string)) {
-      type = factory.createUnionDeclaration({
-        nodes: [type, factory.keywordTypeNodes.undefined],
-      }) as ts.TypeNode
-    }
-  }
-
-  const useTypeGeneration = syntaxType === 'type' || [factory.syntaxKind.union].includes(type.kind as typeof factory.syntaxKind.union) || !!keysToOmit?.length
-
-  typeNodes.push(
-    factory.createTypeDeclaration({
-      name,
-      isExportable: true,
-      type: keysToOmit?.length
-        ? factory.createOmitDeclaration({
-            keys: keysToOmit,
-            type,
-            nonNullable: true,
-          })
-        : type,
-      syntax: useTypeGeneration ? 'type' : 'interface',
-      comments: [
-        schema.title ? `${jsStringEscape(schema.title)}` : undefined,
-        description ? `@description ${jsStringEscape(description)}` : undefined,
-        schema.deprecated ? '@deprecated' : undefined,
-        schema.minLength ? `@minLength ${schema.minLength}` : undefined,
-        schema.maxLength ? `@maxLength ${schema.maxLength}` : undefined,
-        schema.pattern ? `@pattern ${schema.pattern}` : undefined,
-        schema.default ? `@default ${schema.default}` : undefined,
-        schema.example ? `@example ${schema.example}` : undefined,
-      ],
-    }),
-  )
-
-  const enums = [...new Set(enumSchemas)].map((enumSchema) => {
-    const name = enumType === 'asPascalConst' ? pascalCase(enumSchema.args.name) : camelCase(enumSchema.args.name)
-    const typeName = ['asConst', 'asPascalConst'].includes(enumType) ? `${enumSchema.args.typeName}Key` : enumSchema.args.typeName
-
-    const [nameNode, typeNode] = factory.createEnumDeclaration({
-      name,
-      typeName,
-      enums: enumSchema.args.items
-        .map((item) => (item.value === undefined ? undefined : [trimQuotes(item.name?.toString()), item.value]))
-        .filter(Boolean) as unknown as Array<[string, string]>,
-      type: enumType,
-      enumKeyCasing,
-    })
-
-    return {
-      nameNode,
-      typeNode,
-      name,
-      typeName,
-    }
-  })
-
-  // Skip enum exports when using inlineLiteral
-  const shouldExportEnums = enumType !== 'inlineLiteral'
-  const shouldExportType = enumType === 'inlineLiteral' || enums.every((item) => item.typeName !== name)
-
-  return (
-    <>
-      {shouldExportEnums &&
-        enums.map(({ name, nameNode, typeName, typeNode }) => (
-          <>
-            {nameNode && (
-              <File.Source name={name} isExportable isIndexable isTypeOnly={false}>
-                {safePrint(nameNode)}
-              </File.Source>
-            )}
-            {
-              <File.Source
-                name={typeName}
-                isIndexable
-                isExportable={['enum', 'asConst', 'asPascalConst', 'constEnum', 'literal', undefined].includes(enumType)}
-                isTypeOnly={['asConst', 'asPascalConst', 'literal', undefined].includes(enumType)}
-              >
-                {safePrint(typeNode)}
-              </File.Source>
-            }
-          </>
-        ))}
-      {shouldExportType && (
-        <File.Source name={typedName} isTypeOnly isExportable isIndexable>
-          {safePrint(...typeNodes)}
-        </File.Source>
-      )}
-    </>
-  )
-}

package/src/components/index.ts

@@ -1 +0,0 @@
-export { Type } from './Type.tsx'

package/src/components/v2/Enum.tsx

@@ -1,67 +0,0 @@
-import { camelCase, pascalCase, trimQuotes } from '@internals/utils'
-import type { EnumSchemaNode } from '@kubb/ast/types'
-import { safePrint } from '@kubb/fabric-core/parsers/typescript'
-import { File } from '@kubb/react-fabric'
-import type { FabricReactNode } from '@kubb/react-fabric/types'
-import { ENUM_TYPES_WITH_KEY_SUFFIX, ENUM_TYPES_WITH_RUNTIME_VALUE, ENUM_TYPES_WITH_TYPE_ONLY } from '../../constants.ts'
-import * as factory from '../../factory.ts'
-import type { PluginTs } from '../../types.ts'
-
-type Props = {
-  node: EnumSchemaNode
-  enumType: PluginTs['resolvedOptions']['enumType']
-  enumKeyCasing: PluginTs['resolvedOptions']['enumKeyCasing']
-}
-
-/**
- * Resolves the runtime identifier name and the TypeScript type name for an enum schema node.
- *
- * The raw `node.name` may be a YAML key such as `"enumNames.Type"` which is not a
- * valid TypeScript identifier. `pascalCase` normalizes it unconditionally; for inline enum
- * properties the adapter already emits a PascalCase+suffix name so `pascalCase` is a no-op.
- */
-export function getEnumNames(node: EnumSchemaNode, enumType: PluginTs['resolvedOptions']['enumType']): { enumName: string; typeName: string } {
-  const resolved = pascalCase(node.name!)
-  const enumName = enumType === 'asPascalConst' ? resolved : camelCase(node.name!)
-  const typeName = ENUM_TYPES_WITH_KEY_SUFFIX.has(enumType) ? `${resolved}Key` : resolved
-
-  return { enumName, typeName }
-}
-
-/**
- * Renders the enum declaration(s) for a single named `EnumSchemaNode`.
- *
- * Depending on `enumType` this may emit:
- * - A runtime object (`asConst` / `asPascalConst`) plus a `typeof` type alias
- * - A `const enum` or plain `enum` declaration (`constEnum` / `enum`)
- * - A union literal type alias (`literal`)
- *
- * The emitted `File.Source` nodes carry the resolved names so that the barrel
- * index picks up the correct export identifiers.
- */
-export function Enum({ node, enumType, enumKeyCasing }: Props): FabricReactNode {
-  const { enumName, typeName } = getEnumNames(node, enumType)
-
-  const [nameNode, typeNode] = factory.createEnumDeclaration({
-    name: enumName,
-    typeName,
-    enums: (node.namedEnumValues?.map((v) => [trimQuotes(v.name.toString()), v.value]) ??
-      node.enumValues?.filter((v): v is NonNullable<typeof v> => v !== null && v !== undefined).map((v) => [trimQuotes(v.toString()), v]) ??
-      []) as unknown as Array<[string, string]>,
-    type: enumType,
-    enumKeyCasing,
-  })
-
-  return (
-    <>
-      {nameNode && (
-        <File.Source name={enumName} isExportable isIndexable isTypeOnly={false}>
-          {safePrint(nameNode)}
-        </File.Source>
-      )}
-      <File.Source name={typeName} isIndexable isExportable={ENUM_TYPES_WITH_RUNTIME_VALUE.has(enumType)} isTypeOnly={ENUM_TYPES_WITH_TYPE_ONLY.has(enumType)}>
-        {safePrint(typeNode)}
-      </File.Source>
-    </>
-  )
-}

package/src/components/v2/Type.tsx

@@ -1,59 +0,0 @@
-import { collect } from '@kubb/ast'
-import type { EnumSchemaNode, SchemaNode } from '@kubb/ast/types'
-import { safePrint } from '@kubb/fabric-core/parsers/typescript'
-import { File } from '@kubb/react-fabric'
-import type { FabricReactNode } from '@kubb/react-fabric/types'
-import { printerTs } from '../../printer.ts'
-import type { PluginTs } from '../../types.ts'
-import { Enum, getEnumNames } from './Enum.tsx'
-
-type Props = {
-  name: string
-  typedName: string
-  node: SchemaNode
-  optionalType: PluginTs['resolvedOptions']['optionalType']
-  arrayType: PluginTs['resolvedOptions']['arrayType']
-  enumType: PluginTs['resolvedOptions']['enumType']
-  enumKeyCasing: PluginTs['resolvedOptions']['enumKeyCasing']
-  syntaxType: PluginTs['resolvedOptions']['syntaxType']
-  description?: string
-  keysToOmit?: string[]
-}
-
-export function Type({ name, typedName, node, keysToOmit, optionalType, arrayType, syntaxType, enumType, enumKeyCasing, description }: Props): FabricReactNode {
-  const resolvedDescription = description || node?.description
-  const enumSchemaNodes = collect<EnumSchemaNode>(node, {
-    schema(n): EnumSchemaNode | undefined {
-      if (n.type === 'enum' && n.name) return n as EnumSchemaNode
-    },
-  })
-
-  const printer = printerTs({ optionalType, arrayType, enumType, typeName: name, syntaxType, description: resolvedDescription, keysToOmit })
-  const typeNode = printer.print(node)
-
-  if (!typeNode) {
-    return
-  }
-
-  const enums = [...new Map(enumSchemaNodes.map((n) => [n.name, n])).values()].map((node) => {
-    return {
-      node,
-      ...getEnumNames(node, enumType),
-    }
-  })
-
-  // Skip enum exports when using inlineLiteral
-  const shouldExportEnums = enumType !== 'inlineLiteral'
-  const shouldExportType = enumType === 'inlineLiteral' || enums.every((item) => item.typeName !== name)
-
-  return (
-    <>
-      {shouldExportEnums && enums.map(({ node }) => <Enum node={node} enumType={enumType} enumKeyCasing={enumKeyCasing} />)}
-      {shouldExportType && (
-        <File.Source name={typedName} isTypeOnly isExportable isIndexable>
-          {safePrint(typeNode)}
-        </File.Source>
-      )}
-    </>
-  )
-}

package/src/constants.ts

@@ -1,29 +0,0 @@
-import type { PluginTs } from './types.ts'
-
-type OptionalType = PluginTs['resolvedOptions']['optionalType']
-type EnumType = PluginTs['resolvedOptions']['enumType']
-
-/**
- * `optionalType` values that cause a property's type to include `| undefined`.
- */
-export const OPTIONAL_ADDS_UNDEFINED = new Set<OptionalType>(['undefined', 'questionTokenAndUndefined'] as const)
-
-/**
- * `optionalType` values that render the property key with a `?` token.
- */
-export const OPTIONAL_ADDS_QUESTION_TOKEN = new Set<OptionalType>(['questionToken', 'questionTokenAndUndefined'] as const)
-
-/**
- * `enumType` values that append a `Key` suffix to the generated enum type alias.
- */
-export const ENUM_TYPES_WITH_KEY_SUFFIX = new Set<EnumType>(['asConst', 'asPascalConst'] as const)
-
-/**
- * `enumType` values that require a runtime value declaration (object, enum, or literal).
- */
-export const ENUM_TYPES_WITH_RUNTIME_VALUE = new Set<EnumType | undefined>(['enum', 'asConst', 'asPascalConst', 'constEnum', 'literal', undefined] as const)
-
-/**
- * `enumType` values whose type declaration is type-only (no runtime value emitted for the type alias).
- */
-export const ENUM_TYPES_WITH_TYPE_ONLY = new Set<EnumType | undefined>(['asConst', 'asPascalConst', 'literal', undefined] as const)