@kubb/react-fabric 0.9.4 → 0.10.0

package/dist/{types-CSUzVTpn.d.ts → types-BL7PkfqA.d.ts}

@@ -1,6 +1,11 @@
 import { b as Source, g as Import, h as File, p as Export } from "./Fabric-DitK3IEP.js";
 import React, { JSX, Key, ReactNode } from "react";
 
+//#region ../fabric-core/src/types.d.ts
+type JSDoc = {
+  comments: string[];
+};
+//#endregion
 //#region src/utils/getFunctionParams.d.ts
 type Param = {
   /**
@@ -79,9 +84,6 @@ type DOMElement = {
 type NodeNames = ElementNames | TextName;
 type KubbNode = ReactNode;
 type KubbElement = JSX.Element;
-type JSDoc = {
-  comments: string[];
-};
 type KubbTextProps = {
   children?: KubbNode;
 };
@@ -100,5 +102,5 @@ type KubbImportProps = Import;
 type KubbExportProps = Export;
 type LineBreakProps = React.DetailedHTMLProps<React.HTMLAttributes<HTMLBRElement>, HTMLBRElement>;
 //#endregion
-export { Param as _, JSDoc as a, KubbExportProps as c, KubbNode as d, KubbSourceProps as f, FunctionParams as g, TextNode as h, ElementNames as i, KubbFileProps as l, LineBreakProps as m, DOMNode as n, Key as o, KubbTextProps as p, DOMNodeAttribute as r, KubbElement as s, DOMElement as t, KubbImportProps as u, Params as v, createFunctionParams as y };
-//# sourceMappingURL=types-CSUzVTpn.d.ts.map
+export { Params as _, Key as a, KubbFileProps as c, KubbSourceProps as d, KubbTextProps as f, Param as g, FunctionParams as h, ElementNames as i, KubbImportProps as l, TextNode as m, DOMNode as n, KubbElement as o, LineBreakProps as p, DOMNodeAttribute as r, KubbExportProps as s, DOMElement as t, KubbNode as u, createFunctionParams as v, JSDoc as y };
+//# sourceMappingURL=types-BL7PkfqA.d.ts.map

package/dist/{types-DP2mgqeb.d.cts → types-BdOHT5YF.d.cts}

@@ -1,6 +1,11 @@
 import { b as Source, g as Import, h as File, p as Export } from "./Fabric-C61uYmUy.cjs";
 import React, { JSX, Key, ReactNode } from "react";
 
+//#region ../fabric-core/src/types.d.ts
+type JSDoc = {
+  comments: string[];
+};
+//#endregion
 //#region src/utils/getFunctionParams.d.ts
 type Param = {
   /**
@@ -79,9 +84,6 @@ type DOMElement = {
 type NodeNames = ElementNames | TextName;
 type KubbNode = ReactNode;
 type KubbElement = JSX.Element;
-type JSDoc = {
-  comments: string[];
-};
 type KubbTextProps = {
   children?: KubbNode;
 };
@@ -100,5 +102,5 @@ type KubbImportProps = Import;
 type KubbExportProps = Export;
 type LineBreakProps = React.DetailedHTMLProps<React.HTMLAttributes<HTMLBRElement>, HTMLBRElement>;
 //#endregion
-export { Param as _, JSDoc as a, KubbExportProps as c, KubbNode as d, KubbSourceProps as f, FunctionParams as g, TextNode as h, ElementNames as i, KubbFileProps as l, LineBreakProps as m, DOMNode as n, Key as o, KubbTextProps as p, DOMNodeAttribute as r, KubbElement as s, DOMElement as t, KubbImportProps as u, Params as v, createFunctionParams as y };
-//# sourceMappingURL=types-DP2mgqeb.d.cts.map
+export { Params as _, Key as a, KubbFileProps as c, KubbSourceProps as d, KubbTextProps as f, Param as g, FunctionParams as h, ElementNames as i, KubbImportProps as l, TextNode as m, DOMNode as n, KubbElement as o, LineBreakProps as p, DOMNodeAttribute as r, KubbExportProps as s, DOMElement as t, KubbNode as u, createFunctionParams as v, JSDoc as y };
+//# sourceMappingURL=types-BdOHT5YF.d.cts.map

package/dist/types.d.cts

@@ -1,3 +1,3 @@
 import { _ as KubbFile_d_exports, a as FabricOptions, i as FabricMode, n as FabricConfig, r as FabricContext } from "./Fabric-C61uYmUy.cjs";
-import { _ as Param, a as JSDoc, c as KubbExportProps, d as KubbNode, f as KubbSourceProps, h as TextNode, i as ElementNames, l as KubbFileProps, m as LineBreakProps, n as DOMNode, o as Key, p as KubbTextProps, r as DOMNodeAttribute, s as KubbElement, t as DOMElement, u as KubbImportProps, v as Params } from "./types-DP2mgqeb.cjs";
+import { _ as Params, a as Key, c as KubbFileProps, d as KubbSourceProps, f as KubbTextProps, g as Param, i as ElementNames, l as KubbImportProps, m as TextNode, n as DOMNode, o as KubbElement, p as LineBreakProps, r as DOMNodeAttribute, s as KubbExportProps, t as DOMElement, u as KubbNode, y as JSDoc } from "./types-BdOHT5YF.cjs";
 export { DOMElement, DOMNode, DOMNodeAttribute, ElementNames, FabricConfig, FabricContext, FabricMode, FabricOptions, JSDoc, Key, KubbElement, KubbExportProps, KubbFile_d_exports as KubbFile, KubbFileProps, KubbImportProps, KubbNode, KubbSourceProps, KubbTextProps, LineBreakProps, Param, Params, TextNode };

package/dist/types.d.ts

@@ -1,3 +1,3 @@
 import { _ as KubbFile_d_exports, a as FabricOptions, i as FabricMode, n as FabricConfig, r as FabricContext } from "./Fabric-DitK3IEP.js";
-import { _ as Param, a as JSDoc, c as KubbExportProps, d as KubbNode, f as KubbSourceProps, h as TextNode, i as ElementNames, l as KubbFileProps, m as LineBreakProps, n as DOMNode, o as Key, p as KubbTextProps, r as DOMNodeAttribute, s as KubbElement, t as DOMElement, u as KubbImportProps, v as Params } from "./types-CSUzVTpn.js";
+import { _ as Params, a as Key, c as KubbFileProps, d as KubbSourceProps, f as KubbTextProps, g as Param, i as ElementNames, l as KubbImportProps, m as TextNode, n as DOMNode, o as KubbElement, p as LineBreakProps, r as DOMNodeAttribute, s as KubbExportProps, t as DOMElement, u as KubbNode, y as JSDoc } from "./types-BL7PkfqA.js";
 export { DOMElement, DOMNode, DOMNodeAttribute, ElementNames, FabricConfig, FabricContext, FabricMode, FabricOptions, JSDoc, Key, KubbElement, KubbExportProps, KubbFile_d_exports as KubbFile, KubbFileProps, KubbImportProps, KubbNode, KubbSourceProps, KubbTextProps, LineBreakProps, Param, Params, TextNode };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/react-fabric",
-  "version": "0.9.4",
+  "version": "0.10.0",
   "description": "React integration for Kubb, providing JSX runtime support and React component generation capabilities for code generation plugins.",
   "keywords": [
     "react",
@@ -111,10 +111,10 @@
     "react-devtools-core": "6.1.2",
     "signal-exit": "^4.1.0",
     "ws": "8.18.0",
-    "@kubb/fabric-core": "0.9.4"
+    "@kubb/fabric-core": "0.10.0"
   },
   "devDependencies": {
-    "@types/react": "^19.2.7",
+    "@types/react": "^19.2.8",
     "@types/react-reconciler": "0.32.0",
     "@types/ws": "^8.18.1",
     "react": "19.2.1",

package/src/components/App.tsx

@@ -1,27 +1,20 @@
-import { createContext, useContext } from 'react'
+import { AppContext, provide, RootContext, useContext } from '@kubb/fabric-core'
 import type { KubbNode } from '../types.ts'
-import { RootContext } from './Root.tsx'
-
-export type AppContextProps<TMeta = unknown> = {
-  /**
-   * Exit (unmount)
-   */
-  readonly exit: (error?: Error) => void
-  readonly meta: TMeta
-}
-
-const AppContext = createContext<AppContextProps | undefined>(undefined)
 
 type Props<TMeta = unknown> = {
   readonly children?: KubbNode
   readonly meta: TMeta
 }
 
+/**
+ * Provides the current app context (meta and exit) to descendants.
+ * This component mirrors the Fabric app container in React.
+ */
 export function App<TMeta = unknown>({ meta, children }: Props<TMeta>) {
   const { exit } = useContext(RootContext)
+  provide(AppContext, { exit, meta })
 
-  return <AppContext.Provider value={{ exit, meta }}>{children}</AppContext.Provider>
+  return children
 }
 
-App.Context = AppContext
 App.displayName = 'KubbApp'

package/src/components/Const.tsx

@@ -27,6 +27,9 @@ type Props = {
   children?: KubbNode
 }
 
+/**
+ * Renders a constant declaration. Supports optional export, type and JSDoc.
+ */
 export function Const({ name, export: canExport, type, JSDoc, asConst, children }: Props) {
   return (
     <>

package/src/components/File.tsx

@@ -1,22 +1,7 @@
+import { FileCollector, FileCollectorContext, provide, useContext } from '@kubb/fabric-core'
 import type { KubbFile } from '@kubb/fabric-core/types'
-import { createContext } from 'react'
 import type { Key, KubbNode } from '../types.ts'
 
-export type FileContextProps<TMeta extends object = object> = {
-  /**
-   * Name to be used to dynamicly create the baseName(based on input.path).
-   * Based on UNIX basename
-   * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
-   */
-  baseName: KubbFile.BaseName
-  /**
-   * Path will be full qualified path to a specified file.
-   */
-  path: KubbFile.Path
-  meta?: TMeta
-}
-const FileContext = createContext<FileContextProps>({} as FileContextProps)
-
 type BasePropsWithBaseName = {
   /**
    * Name to be used to dynamicly create the baseName(based on input.path).
@@ -48,16 +33,32 @@ type Props<TMeta> = BaseProps & {
   children?: KubbNode
 }
 
+/**
+ * Registers a file in the FileCollector context and provides a scoped collector
+ * for children. When `baseName` and `path` are provided the file will be
+ * registered so it can be emitted by the collector later.
+ */
 export function File<TMeta extends object = object>({ children, ...rest }: Props<TMeta>) {
+  const collector = useContext(FileCollectorContext, new FileCollector())
+  provide(FileCollectorContext, collector)
+
   if (!rest.baseName || !rest.path) {
     return <>{children}</>
   }
 
-  return (
-    <kubb-file {...rest}>
-      <FileContext.Provider value={{ baseName: rest.baseName, path: rest.path, meta: rest.meta }}>{children}</FileContext.Provider>
-    </kubb-file>
-  )
+  // Register this file with the collector
+  collector.add({
+    baseName: rest.baseName,
+    path: rest.path,
+    meta: rest.meta || ({} as TMeta),
+    banner: rest.banner,
+    footer: rest.footer,
+    sources: [],
+    imports: [],
+    exports: [],
+  })
+
+  return <kubb-file {...rest}>{children}</kubb-file>
 }
 
 File.displayName = 'KubbFile'
@@ -67,6 +68,12 @@ type FileSourceProps = Omit<KubbFile.Source, 'value'> & {
   children?: KubbNode
 }
 
+/**
+ * File.Source
+ *
+ * Marks a block of source text to be associated with the current file when
+ * rendering with the FileCollector. Children are treated as the source string.
+ */
 function FileSource({ isTypeOnly, name, isExportable, isIndexable, children }: FileSourceProps) {
   return (
     <kubb-source name={name} isTypeOnly={isTypeOnly} isExportable={isExportable} isIndexable={isIndexable}>
@@ -79,6 +86,12 @@ FileSource.displayName = 'KubbFileSource'
 
 type FileExportProps = KubbFile.Export & { key?: Key }
 
+/**
+ * File.Export
+ *
+ * Declares an export entry for the current file. This will be collected by
+ * the FileCollector for later emission.
+ */
 function FileExport({ name, path, isTypeOnly, asAlias }: FileExportProps) {
   return <kubb-export name={name} path={path} isTypeOnly={isTypeOnly || false} asAlias={asAlias} />
 }
@@ -87,6 +100,11 @@ FileExport.displayName = 'KubbFileExport'
 
 type FileImportProps = KubbFile.Import & { key?: Key }
 
+/**
+ * File.Import
+ *
+ * Declares an import entry for the current file.
+ */
 function FileImport({ name, root, path, isTypeOnly, isNameSpace }: FileImportProps) {
   return <kubb-import name={name} root={root} path={path} isNameSpace={isNameSpace} isTypeOnly={isTypeOnly || false} />
 }
@@ -96,4 +114,3 @@ FileImport.displayName = 'KubbFileImport'
 File.Export = FileExport
 File.Import = FileImport
 File.Source = FileSource
-File.Context = FileContext

package/src/components/Function.tsx

@@ -41,6 +41,10 @@ type Props = {
   children?: KubbNode
 }
 
+/**
+ * Renders a function definition using the Fabric templating primitives.
+ * Supports optional export/default/async flags, generics, params and JSDoc.
+ */
 export function Function({ name, default: isDefault, export: canExport, async, generics, params, returnType, JSDoc, children }: Props) {
   return (
     <>
@@ -87,6 +91,12 @@ type ArrowFunctionProps = Props & {
   singleLine?: boolean
 }
 
+/**
+ * ArrowFunction
+ *
+ * Renders an arrow function definition. Supports the same flags as `Function`.
+ * Use `singleLine` to render the body as a single-line expression.
+ */
 function ArrowFunction({ name, default: isDefault, export: canExport, async, generics, params, returnType, JSDoc, singleLine, children }: ArrowFunctionProps) {
   return (
     <>

package/src/components/Indent.tsx

@@ -10,6 +10,9 @@ type IndentProps = {
 /**
  * Indents all children by `size` spaces.
  * Collapses consecutive <br /> tags to at most 2.
+ *
+ * Indent will dedent and re-indent string children and will prefix
+ * non-string children with the requested number of spaces.
  */
 export function Indent({ size = 2, children }: IndentProps) {
   if (!children) return null

package/src/components/Root.tsx

@@ -1,4 +1,5 @@
-import { Component, createContext } from 'react'
+import { provide, RootContext } from '@kubb/fabric-core'
+import { Component } from 'react'
 
 import type { KubbNode } from '../types.ts'
 
@@ -32,17 +33,6 @@ class ErrorBoundary extends Component<{
   }
 }
 
-export type RootContextProps = {
-  /**
-   * Exit (unmount) the whole Ink app.
-   */
-  readonly exit: (error?: Error) => void
-}
-
-export const RootContext = createContext<RootContextProps>({
-  exit: () => {},
-})
-
 type RootProps = {
   /**
    * Exit (unmount) hook
@@ -55,17 +45,26 @@ type RootProps = {
   readonly children?: KubbNode
 }
 
+/**
+ * Provides the root context (exit hook) and wraps children into an
+ * ErrorBoundary so errors can be forwarded to the `onError` handler.
+ *
+ * This component provides the root behaviour for the React Fabric runtime.
+ *
+ * Returns a React node tree representing the root of the Fabric app.
+ */
 export function Root({ onError, onExit, children }: RootProps) {
+  provide(RootContext, { exit: onExit })
+
   return (
     <ErrorBoundary
       onError={(error) => {
         onError(error)
       }}
     >
-      <RootContext.Provider value={{ exit: onExit }}>{children}</RootContext.Provider>
+      {children}
     </ErrorBoundary>
   )
 }
 
-Root.Context = RootContext
 Root.displayName = 'KubbRoot'

package/src/components/Type.tsx

@@ -18,6 +18,10 @@ type Props = {
   children?: KubbNode
 }
 
+/**
+ * Renders a TypeScript type alias. Validates that the provided name starts
+ * with a capital letter and optionally emits JSDoc comments.
+ */
 export function Type({ name, export: canExport, JSDoc, children }: Props) {
   if (name.charAt(0).toUpperCase() !== name.charAt(0)) {
     throw new Error('Name should start with a capital letter(see TypeScript types)')

package/src/composables/useApp.ts

@@ -1,15 +1 @@
-import { useContext } from 'react'
-import { App, type AppContextProps } from '../components/App.tsx'
-
-/**
- * `useApp` will return the current App with plugin, pluginManager, fileManager and mode.
- */
-export function useApp<TMeta = unknown>(): AppContextProps<TMeta> {
-  const app = useContext(App.Context)
-
-  if (!app) {
-    throw new Error('<App /> should be set')
-  }
-
-  return app as AppContextProps<TMeta>
-}
+export { useApp } from '@kubb/fabric-core'

package/src/composables/useFile.ts

@@ -1,12 +1 @@
-import { useContext } from 'react'
-import type { FileContextProps } from '../components/File.tsx'
-import { File } from '../components/File.tsx'
-
-/**
- * `useFile` will return the current file when <File/> is used.
- */
-export function useFile(): FileContextProps {
-  const file = useContext(File.Context)
-
-  return file as FileContextProps
-}
+export { useFile } from '@kubb/fabric-core'

package/src/composables/useLifecycle.tsx

@@ -1,18 +1,17 @@
-import { useContext } from 'react'
-
-import { Root } from '../components/Root.tsx'
+import { RootContext, useContext } from '@kubb/fabric-core'
 
 /**
- * `useLifecycle` will return some helpers to exit/restart the generation.
+ * Provides lifecycle helpers that integrate with the Fabric runtime. The
+ * `exit` helper schedules a call to the RootContext exit function on the
+ * next tick to allow React to complete its render cycle first.
  */
 export function useLifecycle() {
-  const { exit } = useContext(Root.Context)
+  const { exit } = useContext(RootContext, { exit: () => {} })
 
   return {
     exit: () => {
-      const timeout = setTimeout(() => {
-        clearTimeout(timeout)
-
+      // need this to let React finish its current render cycle
+      setTimeout(() => {
         exit()
       }, 0)
     },

package/src/index.ts

@@ -14,16 +14,20 @@ export const useContext = React.useContext
 export const useEffect = React.useEffect
 export const useReducer = React.useReducer
 export const useRef = React.useRef
-// // components
+// components
 export { App } from './components/App.tsx'
 export { Const } from './components/Const.tsx'
 export { File } from './components/File.tsx'
 export { Function } from './components/Function.tsx'
 export { Indent } from './components/Indent.tsx'
 export { Type } from './components/Type.tsx'
+
+// composables
 export { useApp } from './composables/useApp.ts'
 export { useFile } from './composables/useFile.ts'
 export { useLifecycle } from './composables/useLifecycle.tsx'
+
+// factories
 export { createReactFabric } from './createReactFabric.ts'
 export { Runtime } from './Runtime.tsx'
 // utils

package/src/types.ts

@@ -50,10 +50,6 @@ export type KubbElement = JSX.Element
 
 export type { Key } from 'react'
 
-export type JSDoc = {
-  comments: string[]
-}
-
 export type KubbTextProps = {
   children?: KubbNode
 }

package/src/utils/createJSDoc.ts

@@ -1,8 +1 @@
-export function createJSDoc({ comments }: { comments: Array<string> }): string {
-  const filtered = comments.filter((c) => c.trim())
-  if (!filtered.length) {
-    return ''
-  }
-
-  return `/**\n * ${filtered.join('\n * ')}\n */`
-}
+export { createJSDoc } from '@kubb/fabric-core'

package/src/utils/getFunctionParams.ts

@@ -49,18 +49,22 @@ function order(items: Array<[key: string, item?: ParamItem]>) {
     [
       ([_key, item]) => {
         if (item?.children) {
-          return undefined
+          return 0 // Treat items with children as required (they'll get = {} if all children are optional)
         }
-        return !item?.default
-      },
-      ([_key, item]) => {
-        if (item?.children) {
-          return undefined
+        // Priority order: required (0) → optional (1) → default-only (2)
+        if (item?.optional) {
+          return 1 // Optional parameters (with or without default)
+        }
+        if (item?.default) {
+          // Parameters with default only (not marked as optional)
+          // Note: While the ParamItem type suggests optional and default are mutually exclusive,
+          // this handles the case where a parameter has a default value but isn't explicitly marked as optional
+          return 2
         }
-        return !item?.optional
+        return 0 // Required parameters
       },
     ],
-    ['desc', 'desc'],
+    ['asc'],
   )
 }