@kubb/renderer-jsx 5.0.0-beta.75 → 5.0.0-beta.76

package/src/components/Type.tsx

@@ -1,66 +0,0 @@
-import type { JSDoc, Key, KubbReactElement, KubbReactNode } from '../types.ts'
-
-type TypeProps = {
-  key?: Key
-  /**
-   * Identifier of the generated type alias.
-   * Must start with an uppercase letter to follow TypeScript naming conventions.
-   *
-   * @example
-   * `name: 'Pet'`
-   */
-  name: string
-  /**
-   * Emit the `export` keyword before the type alias declaration.
-   * - `true` generates `export type Name = …`
-   * - `false` generates `type Name = …`
-   * @default false
-   */
-  export?: boolean
-  /**
-   * JSDoc block to prepend to the type alias declaration.
-   * Each entry in `comments` becomes one line inside the emitted `/** … *\/` block.
-   */
-  JSDoc?: JSDoc
-  /**
-   * Child nodes rendered as the type expression on the right-hand side of the alias.
-   */
-  children?: KubbReactNode
-}
-
-/**
- * Generates a TypeScript type alias declaration.
- *
- * Throws if `name` does not start with an uppercase letter — TypeScript type aliases
- * should follow PascalCase naming conventions.
- *
- * @example Simple exported type alias
- * ```tsx
- * <Type export name="PetId">
- *   {`string | number`}
- * </Type>
- * // export type PetId = string | number
- * ```
- *
- * @example Type alias with JSDoc
- * ```tsx
- * <Type export name="Pet" JSDoc={{ comments: ['@description A pet in the store.'] }}>
- *   {`{ id: number; name: string }`}
- * </Type>
- * ```
- */
-export function Type({ children, ...props }: TypeProps): KubbReactElement {
-  const { name, export: canExport, JSDoc } = props
-
-  if (name.charAt(0).toUpperCase() !== name.charAt(0)) {
-    throw new Error('Name should start with a capital letter(see TypeScript types)')
-  }
-
-  return (
-    <kubb-type name={name} export={canExport} JSDoc={JSDoc}>
-      {children}
-    </kubb-type>
-  )
-}
-
-Type.displayName = 'Type'

package/src/constants.ts

@@ -1,28 +0,0 @@
-import type { ElementNames } from './types.ts'
-
-/**
- * Name used for text-node entries in the virtual DOM.
- */
-export const TEXT_NODE_NAME = '#text' as const
-
-/**
- * Set of all element names recognized by the Kubb renderer.
- * Used to distinguish Kubb-owned elements from unrecognized or text nodes during tree traversal.
- */
-export const nodeNames = new Set<ElementNames>([
-  'kubb-export',
-  'kubb-file',
-  'kubb-source',
-  'kubb-import',
-  'kubb-function',
-  'kubb-arrow-function',
-  'kubb-const',
-  'kubb-type',
-  'kubb-jsx',
-  'kubb-text',
-  'kubb-root',
-  'kubb-app',
-  'br',
-  'indent',
-  'dedent',
-] as const)

package/src/createRenderer.tsx

@@ -1,93 +0,0 @@
-import type { FileNode } from '@kubb/ast'
-import { Runtime } from './Runtime.tsx'
-import type { KubbReactElement } from './types.ts'
-
-type Options = {
-  /**
-   * Print each render result to the console for debugging.
-   * Useful when diagnosing output differences between renders.
-   * @default false
-   */
-  debug?: boolean
-}
-
-/**
- * The renderer instance returned by {@link createRenderer}.
- */
-type Renderer = {
-  /**
-   * Render a JSX element tree and collect the resulting {@link FileNode} entries.
-   * Resolves once all synchronous render work (including React's flush) is done.
-   */
-  render(Element: KubbReactElement): Promise<void>
-  /**
-   * Tear down the renderer and release all React resources.
-   * Pass an `Error` to signal an abnormal shutdown.
-   */
-  unmount(error?: Error | number | null): void
-  /**
-   * The {@link FileNode} entries collected from the most recent `render` call.
-   */
-  files: Array<FileNode>
-}
-
-/**
- * Create a Kubb JSX renderer.
- *
- * The renderer converts a React JSX element tree — built from the components in this
- * package — into an array of {@link FileNode} entries representing the generated files.
- *
- * @example Basic usage
- * ```ts
- * import { createRenderer, File } from '@kubb/renderer-jsx'
- *
- * const renderer = createRenderer()
- * await renderer.render(
- *   <File baseName="pet.ts" path="src/models/pet.ts">
- *     <File.Source name="Pet" isExportable isIndexable>
- *       {`export type Pet = { id: number; name: string }`}
- *     </File.Source>
- *   </File>
- * )
- * console.log(renderer.files) // [FileNode]
- * renderer.unmount()
- * ```
- */
-export function createRenderer(options: Options = {}): Renderer {
-  const runtime = new Runtime(options)
-
-  return {
-    async render(Element) {
-      await runtime.render(Element)
-    },
-    get files() {
-      return runtime.nodes
-    },
-    unmount(error) {
-      runtime.unmount(error)
-    },
-  }
-}
-
-/**
- * A renderer factory for generators that produce JSX output.
- *
- * Pass this as the `renderer` property of a `defineGenerator` call so that
- * core can render the JSX element tree returned by your generator methods
- * without a hard dependency on `@kubb/renderer-jsx`.
- *
- * @example
- * ```ts
- * import { jsxRenderer } from '@kubb/renderer-jsx'
- * import { defineGenerator } from '@kubb/core'
- *
- * export const myGenerator = defineGenerator<PluginTs>({
- *   name: 'my-generator',
- *   renderer: jsxRenderer,
- *   schema(node, options) {
- *     return <File baseName="output.ts" path="src/output.ts">...</File>
- *   },
- * })
- * ```
- */
-export const jsxRenderer: () => Renderer = () => createRenderer()

package/src/dom.ts

@@ -1,105 +0,0 @@
-import { TEXT_NODE_NAME } from './constants.ts'
-import type { DOMElement, DOMNode, DOMNodeAttribute, TextNode } from './types.ts'
-
-/**
- * Create a new, empty {@link DOMElement} with the given node name.
- * The element has no attributes, no children, and no parent.
- */
-export const createNode = (nodeName: string): DOMElement => {
-  const node: DOMElement = {
-    nodeName: nodeName as DOMElement['nodeName'],
-    attributes: new Map(),
-    childNodes: [],
-    parentNode: undefined,
-  }
-
-  return node
-}
-
-/**
- * Append `childNode` as the last child of `node`.
- *
- * If `childNode` already has a parent, it is removed from that parent first
- * (matching standard DOM move semantics).
- * Text nodes (`nodeName === '#text'`) are silently ignored.
- */
-export const appendChildNode = (node: DOMNode, childNode: DOMElement | DOMNode): void => {
-  if (childNode.parentNode) {
-    removeChildNode(childNode.parentNode, childNode)
-  }
-
-  if (node.nodeName !== TEXT_NODE_NAME) {
-    childNode.parentNode = node
-    node.childNodes.push(childNode)
-  }
-}
-
-/**
- * Insert `newChildNode` before `beforeChildNode` in `node`'s child list.
- *
- * If `newChildNode` already has a parent, it is removed from that parent first.
- * If `beforeChildNode` is not found, `newChildNode` is appended at the end.
- */
-export const insertBeforeNode = (node: DOMElement, newChildNode: DOMNode, beforeChildNode: DOMNode): void => {
-  if (newChildNode.parentNode) {
-    removeChildNode(newChildNode.parentNode, newChildNode)
-  }
-
-  newChildNode.parentNode = node
-
-  const index = node.childNodes.indexOf(beforeChildNode)
-  if (index >= 0) {
-    node.childNodes.splice(index, 0, newChildNode)
-
-    return
-  }
-
-  node.childNodes.push(newChildNode)
-}
-
-/**
- * Remove `removeNode` from `node`'s child list and clear its `parentNode` reference.
- * Does nothing if `removeNode` is not a direct child of `node`.
- */
-export const removeChildNode = (node: DOMElement, removeNode: DOMNode): void => {
-  removeNode.parentNode = undefined
-
-  const index = node.childNodes.indexOf(removeNode)
-  if (index >= 0) {
-    node.childNodes.splice(index, 1)
-  }
-}
-
-/**
- * Set an attribute on `node`, storing it in the node's `attributes` map.
- */
-export const setAttribute = (node: DOMElement, key: string, value: DOMNodeAttribute): void => {
-  node.attributes.set(key, value)
-}
-
-/**
- * Create a new {@link TextNode} with the given text value.
- */
-export const createTextNode = (text: string): TextNode => {
-  const node: TextNode = {
-    nodeName: TEXT_NODE_NAME,
-    nodeValue: text,
-    parentNode: undefined,
-  }
-
-  setTextNodeValue(node, text)
-
-  return node
-}
-
-/**
- * Update the `nodeValue` of an existing {@link TextNode}.
- * Non-string values are coerced to strings via `String(text)`.
- */
-export const setTextNodeValue = (node: TextNode, text: string): void => {
-  if (typeof text !== 'string') {
-    text = String(text)
-  }
-
-  node.nodeValue = text
-}

package/src/globals.ts

@@ -1,34 +0,0 @@
-import type React from 'react'
-import type {
-  KubbExportProps,
-  KubbFileProps,
-  KubbImportProps,
-  KubbJsxProps,
-  KubbReactElement,
-  KubbReactNode,
-  KubbSourceProps,
-  KubbTextProps,
-  LineBreakProps,
-} from './types.ts'
-
-declare global {
-  namespace JSX {
-    type Element = KubbReactElement
-
-    interface ElementClass extends React.ComponentClass<any> {
-      render(): KubbReactNode
-    }
-
-    interface IntrinsicElements {
-      'kubb-jsx': KubbJsxProps
-      'kubb-text': KubbTextProps
-      'kubb-file': KubbFileProps
-      'kubb-source': KubbSourceProps
-      'kubb-import': KubbImportProps
-      'kubb-export': KubbExportProps
-      br: LineBreakProps
-      indent: {}
-      dedent: {}
-    }
-  }
-}

package/src/index.ts

@@ -1,8 +0,0 @@
-export { createContext, inject, provide, unprovide } from '@internals/utils'
-export { Const } from './components/Const.tsx'
-export { File } from './components/File.tsx'
-export { Function } from './components/Function.tsx'
-export { Jsx } from './components/Jsx.tsx'
-export { Root } from './components/Root.tsx'
-export { Type } from './components/Type.tsx'
-export { createRenderer, jsxRenderer } from './createRenderer.tsx'

package/src/jsx-dev-runtime.ts

@@ -1,10 +0,0 @@
-import * as React from 'react/jsx-runtime'
-import type { KubbReactElement, KubbReactNode } from './types.ts'
-
-export const Fragment = React.Fragment
-export const jsxDEV = React.jsx
-
-export type * from './jsx-namespace.d.ts'
-
-export type JSXElement = KubbReactElement
-export type ReactNode = KubbReactNode

package/src/jsx-namespace.d.ts

@@ -1,52 +0,0 @@
-import type React from 'react'
-
-import type {
-  KubbArrowFunctionProps,
-  KubbConstProps,
-  KubbExportProps,
-  KubbFileProps,
-  KubbFunctionProps,
-  KubbImportProps,
-  KubbJsxProps,
-  KubbReactElement,
-  KubbReactNode,
-  KubbSourceProps,
-  KubbTextProps,
-  KubbTypeProps,
-  LineBreakProps,
-} from './types'
-
-export namespace JSX {
-  type ElementType = React.JSX.ElementType
-  type Element = KubbReactElement
-
-  interface ElementClass extends React.JSX.ElementClass {
-    render(): KubbReactNode
-  }
-  interface ElementAttributesProperty {
-    props: {}
-  }
-
-  interface ElementChildrenAttribute {
-    children: {}
-  }
-
-  interface IntrinsicElements extends React.JSX.IntrinsicElements {
-    'kubb-jsx': KubbJsxProps
-    'kubb-text': KubbTextProps
-    'kubb-file': KubbFileProps
-    'kubb-source': KubbSourceProps
-    'kubb-import': KubbImportProps
-    'kubb-export': KubbExportProps
-    'kubb-function': KubbFunctionProps
-    'kubb-arrow-function': KubbArrowFunctionProps
-    'kubb-const': KubbConstProps
-    'kubb-type': KubbTypeProps
-    br: LineBreakProps
-    indent: {}
-    dedent: {}
-  }
-  type LibraryManagedAttributes<C, P> = React.JSX.LibraryManagedAttributes<C, P>
-  interface IntrinsicClassAttributes<T> extends React.JSX.IntrinsicClassAttributes<T> {}
-  interface IntrinsicElements extends React.JSX.IntrinsicElements {}
-}

package/src/jsx-runtime.ts

@@ -1,12 +0,0 @@
-import * as React from 'react/jsx-runtime'
-import type { KubbReactElement, KubbReactNode } from './types.ts'
-
-export const Fragment = React.Fragment
-export const jsx = React.jsx
-export const jsxDEV = React.jsx
-export const jsxs = React.jsxs
-
-export type * from './jsx-namespace.d.ts'
-
-export type JSXElement = KubbReactElement
-export type ReactNode = KubbReactNode

package/src/types.ts

@@ -1,207 +0,0 @@
-import type { ArrowFunctionNode, ConstNode, ExportNode, FileNode, FunctionNode, ImportNode, SourceNode, TypeNode } from '@kubb/ast'
-import type React from 'react'
-import type { JSX, ReactNode } from 'react'
-
-/**
- * Unique identifier for a React element in lists or conditional renders.
- */
-export type Key = string | number | bigint
-
-/**
- * Custom element names recognized by the Kubb JSX renderer.
- * Each name maps to a corresponding AST node type in the generated code.
- */
-export type ElementNames =
-  | 'br'
-  | 'div'
-  | 'indent'
-  | 'dedent'
-  | 'kubb-jsx'
-  | 'kubb-text'
-  | 'kubb-file'
-  | 'kubb-source'
-  | 'kubb-import'
-  | 'kubb-export'
-  | 'kubb-function'
-  | 'kubb-arrow-function'
-  | 'kubb-const'
-  | 'kubb-type'
-  | 'kubb-root'
-  | 'kubb-app'
-
-type Node = {
-  parentNode: DOMElement | undefined
-  internal_static?: boolean
-}
-
-/**
- * Allowed attribute value types for DOM elements.
- */
-export type DOMNodeAttribute = boolean | string | number | Record<string, unknown> | Array<unknown>
-
-type TextName = '#text'
-
-/**
- * Leaf DOM node containing raw text.
- */
-export type TextNode = {
-  nodeName: TextName
-  nodeValue: string
-} & Node
-
-/**
- * Virtual DOM node — either a text node or a named element.
- */
-export type DOMNode<T = { nodeName: NodeNames }> = T extends {
-  nodeName: infer U
-}
-  ? U extends '#text'
-    ? TextNode
-    : DOMElement
-  : never
-
-type OutputTransformer = (s: string, index: number) => string
-
-/**
- * Named element in the Kubb virtual DOM tree.
- * Stores attributes, child nodes, and lifecycle callbacks for rendering.
- */
-export type DOMElement = {
-  nodeName: ElementNames
-  /**
-   * Key/value attributes passed as JSX props to this element.
-   */
-  attributes: Map<string, DOMNodeAttribute>
-  /**
-   * Ordered list of child nodes attached to this element.
-   */
-  childNodes: DOMNode[]
-  internal_transform?: OutputTransformer
-
-  // Internal properties
-  isStaticDirty?: boolean
-  staticNode?: DOMElement
-  onComputeLayout?: () => void
-  onRender?: () => void
-  onImmediateRender?: () => void
-} & Node
-
-type NodeNames = ElementNames | TextName
-
-/**
- * React node type for Kubb JSX components.
- */
-export type KubbReactNode = ReactNode
-
-/**
- * React element type returned by Kubb JSX components.
- */
-export type KubbReactElement = JSX.Element
-
-/**
- * Props for the `<kubb-jsx>` element.
- * Embeds a raw JSX string verbatim in generated output.
- */
-export type KubbJsxProps = {
-  children?: string
-}
-
-/**
- * Props for the `<kubb-text>` element.
- * Wraps React children as plain text in the output.
- */
-export type KubbTextProps = {
-  children?: KubbReactNode
-}
-
-/**
- * Props for the `<kubb-file>` element.
- * Represents a generated file.
- */
-export type KubbFileProps = {
-  id?: string
-  children?: KubbReactNode
-  baseName: string
-  path: string
-  override?: boolean
-  meta?: FileNode['meta']
-}
-
-/**
- * Props for the `<kubb-source>` element.
- * Marks a block of source text associated with a file.
- */
-export type KubbSourceProps = Omit<SourceNode, 'kind'> & {
-  children?: KubbReactNode
-}
-
-/**
- * Props for the `<kubb-import>` element.
- * Declares an import statement in the generated file.
- */
-export type KubbImportProps = Omit<ImportNode, 'kind'> & {}
-
-/**
- * Props for the `<kubb-export>` element.
- * Declares an export statement in the generated file.
- */
-export type KubbExportProps = Omit<ExportNode, 'kind'> & {}
-
-/**
- * Props for the `<kubb-function>` element.
- * Generates a function declaration.
- */
-export type KubbFunctionProps = Omit<FunctionNode, 'kind'> & {
-  children?: KubbReactNode
-}
-
-/**
- * Props for the `<kubb-arrow-function>` element.
- * Generates an arrow function declaration.
- */
-export type KubbArrowFunctionProps = Omit<ArrowFunctionNode, 'kind'> & {
-  children?: KubbReactNode
-}
-
-/**
- * Props for the `<kubb-const>` element.
- * Generates a constant declaration.
- */
-export type KubbConstProps = Omit<ConstNode, 'kind'> & {
-  children?: KubbReactNode
-}
-
-/**
- * Props for the `<kubb-type>` element.
- * Generates a TypeScript type alias declaration.
- */
-export type KubbTypeProps = Omit<TypeNode, 'kind'> & {
-  children?: KubbReactNode
-}
-
-/**
- * Props for the HTML `<br>` element.
- */
-export type LineBreakProps = React.DetailedHTMLProps<React.HTMLAttributes<HTMLBRElement>, HTMLBRElement>
-
-/**
- * JSDoc comment block to attach to a generated declaration.
- * Each string in `comments` becomes one line inside the `/** … *\/` block.
- *
- * @example
- * ```ts
- * { comments: ['@description A pet object.', '@deprecated Use PetV2 instead.'] }
- * // Emits:
- * // /**
- * //  * @description A pet object.
- * //  * @deprecated Use PetV2 instead.
- * //  *\/
- * ```
- */
-export type JSDoc = {
-  /**
-   * Lines to emit inside the JSDoc block, in source order.
-   * Use standard JSDoc tags such as `@description`, `@deprecated`, `@see`, etc.
-   */
-  comments: Array<string>
-}