@kubb/react-fabric 0.9.5 → 0.10.0

package/dist/index.d.cts

@@ -1,11 +1,139 @@
 import { a as FabricOptions, b as Source, c as FileManager, f as BaseName, g as Import, h as File$1, i as FabricMode, l as FileProcessor, n as FabricConfig, p as Export, t as Fabric, v as Path, y as ResolvedFile } from "./Fabric-C61uYmUy.cjs";
-import { a as JSDoc, d as KubbNode, g as FunctionParams, o as Key, y as createFunctionParams } from "./types-DP2mgqeb.cjs";
+import { a as Key, h as FunctionParams, u as KubbNode, v as createFunctionParams, y as JSDoc } from "./types-BdOHT5YF.cjs";
 import { t as Options$1 } from "./reactPlugin-B4xarQJX.cjs";
-import * as react3 from "react";
+import * as react7 from "react";
 import React, { ReactNode } from "react";
 
+//#region ../fabric-core/src/components/Root.d.ts
+type RootProps = {
+  /**
+   * Exit (unmount) hook
+   */
+  readonly onExit: (error?: Error) => void;
+  /**
+   * Error hook
+   */
+  readonly onError: (error: Error) => void;
+  readonly children?: string;
+};
+/**
+ * Top-level root for fsx renderers. Returns children content and ensures
+ * `onError` is called for runtime exceptions. Provides a RootContext with
+ * an `exit` hook for downstream consumers.
+ */
+declare function Root({
+  onError,
+  children
+}: Omit<RootProps, 'onExit'>): string;
+declare namespace Root {
+  var displayName: string;
+}
+//#endregion
+//#region ../fabric-core/src/contexts/AppContext.d.ts
+type AppContextProps<TMeta = unknown> = {
+  /**
+   * Exit (unmount)
+   */
+  readonly exit: (error?: Error) => void;
+  readonly meta: TMeta;
+};
+/**
+ * Provides app-level metadata and lifecycle hooks (like `exit`) to
+ * components and composables within a Fabric runtime.
+ */
+declare const AppContext: Context<AppContextProps<unknown> | undefined>;
+//#endregion
+//#region ../fabric-core/src/composables/useApp.d.ts
+/**
+ * `useApp` will return the current App with meta and exit function.
+ *
+ * Throws an error when there is no AppContext available.
+ */
+declare function useApp<TMeta = unknown>(): AppContextProps<TMeta>;
+//#endregion
+//#region ../fabric-core/src/context.d.ts
+/**
+ * Context type that carries type information about its value
+ * This is a branded symbol type that enables type-safe context usage
+ */
+type Context<T> = symbol & {
+  readonly __type: T;
+};
+/**
+ * Provides a value to descendant components (Vue 3 style)
+ *
+ * @example
+ * ```ts
+ * const ThemeKey = Symbol('theme')
+ * provide(ThemeKey, { color: 'blue' })
+ * ```
+ */
+declare function provide<T>(key: symbol | Context<T>, value: T): void;
+/**
+ * Injects a value provided by an ancestor component (Vue 3 style)
+ *
+ * @example
+ * ```ts
+ * const theme = inject(ThemeKey, { color: 'default' })
+ * ```
+ */
+declare function inject<T>(key: symbol | Context<T>, defaultValue?: T): T;
+/**
+ * Unprovides a value (for cleanup)
+ * @internal
+ */
+declare function unprovide<T>(key: symbol | Context<T>): void;
+//#endregion
+//#region ../fabric-core/src/utils/FileCollector.d.ts
+/**
+ * FileCollector is used to collect files from components via context
+ * instead of walking the DOM tree.
+ */
+declare class FileCollector {
+  #private;
+  /**
+   * Add a file to the collector
+   */
+  add(file: File$1): void;
+  /**
+   * Get all collected files
+   */
+  get files(): Array<File$1>;
+  /**
+   * Clear all collected files
+   */
+  clear(): void;
+}
+//#endregion
+//#region ../fabric-core/src/composables/useFile.d.ts
+/**
+ * `useFile` will return the current FileCollector for registering files.
+ *
+ * Throws when no FileCollector is present in context — ensure a Fabric that
+ * provides a FileCollector is mounted before calling this hook.
+ */
+declare function useFile(): FileCollector;
+//#endregion
+//#region ../fabric-core/src/contexts/FileCollectorContext.d.ts
+/**
+ * Context for collecting files - provided by createFsxFabric
+ */
+declare const FileCollectorContext: Context<FileCollector | null>;
+//#endregion
+//#region ../fabric-core/src/contexts/RootContext.d.ts
+type RootContextProps = {
+  /**
+   * Exit (unmount) the whole app.
+   */
+  readonly exit: (error?: Error) => void;
+};
+/**
+ * Provides a top-level lifecycle hook (`exit`) for terminating the Fabric
+ * runtime. This context is available at the root of a Fabric app.
+ */
+declare const RootContext: Context<RootContextProps>;
+//#endregion
 //#region ../fabric-core/src/createFabric.d.ts
-
 /**
  * Creates a new Fabric instance
  *
@@ -21,24 +149,30 @@ declare function createFabric<T extends FabricOptions>(config?: FabricConfig<T>)
  */
 declare function createFile<TMeta extends object = object>(file: File$1<TMeta>): ResolvedFile<TMeta>;
 //#endregion
+//#region ../fabric-core/src/utils/createJSDoc.d.ts
+/**
+ * Create JSDoc comment block from comments array
+ */
+declare function createJSDoc({
+  comments
+}: {
+  comments: string[];
+}): string;
+//#endregion
 //#region src/components/App.d.ts
-type AppContextProps<TMeta = unknown> = {
-  /**
-   * Exit (unmount)
-   */
-  readonly exit: (error?: Error) => void;
-  readonly meta: TMeta;
-};
 type Props$4<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.
+ */
 declare function App<TMeta = unknown>({
   meta,
   children
-}: Props$4<TMeta>): react3.JSX.Element;
+}: Props$4<TMeta>): react7.ReactNode;
 declare namespace App {
-  var Context: react3.Context<AppContextProps<unknown> | undefined>;
   var displayName: string;
 }
 //#endregion
@@ -67,6 +201,9 @@ type Props$3 = {
   asConst?: boolean;
   children?: KubbNode;
 };
+/**
+ * Renders a constant declaration. Supports optional export, type and JSDoc.
+ */
 declare function Const({
   name,
   export: canExport,
@@ -74,25 +211,12 @@ declare function Const({
   JSDoc,
   asConst,
   children
-}: Props$3): react3.JSX.Element;
+}: Props$3): react7.JSX.Element;
 declare namespace Const {
   var displayName: string;
 }
 //#endregion
 //#region src/components/File.d.ts
-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: BaseName;
-  /**
-   * Path will be full qualified path to a specified file.
-   */
-  path: Path;
-  meta?: TMeta;
-};
 type BasePropsWithBaseName = {
   /**
    * Name to be used to dynamicly create the baseName(based on input.path).
@@ -120,53 +244,74 @@ type Props$2<TMeta> = BaseProps & {
   footer?: string;
   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.
+ */
 declare function File<TMeta extends object = object>({
   children,
   ...rest
-}: Props$2<TMeta>): react3.JSX.Element;
+}: Props$2<TMeta>): react7.JSX.Element;
 declare namespace File {
   var displayName: string;
   var Export: typeof FileExport;
   var Import: typeof FileImport;
   var Source: typeof FileSource;
-  var Context: react3.Context<FileContextProps<object>>;
 }
 type FileSourceProps = Omit<Source, 'value'> & {
   key?: Key;
   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.
+ */
 declare function FileSource({
   isTypeOnly,
   name,
   isExportable,
   isIndexable,
   children
-}: FileSourceProps): react3.JSX.Element;
+}: FileSourceProps): react7.JSX.Element;
 declare namespace FileSource {
   var displayName: string;
 }
 type FileExportProps = Export & {
   key?: Key;
 };
+/**
+ * File.Export
+ *
+ * Declares an export entry for the current file. This will be collected by
+ * the FileCollector for later emission.
+ */
 declare function FileExport({
   name,
   path,
   isTypeOnly,
   asAlias
-}: FileExportProps): react3.JSX.Element;
+}: FileExportProps): react7.JSX.Element;
 declare namespace FileExport {
   var displayName: string;
 }
 type FileImportProps = Import & {
   key?: Key;
 };
+/**
+ * File.Import
+ *
+ * Declares an import entry for the current file.
+ */
 declare function FileImport({
   name,
   root,
   path,
   isTypeOnly,
   isNameSpace
-}: FileImportProps): react3.JSX.Element;
+}: FileImportProps): react7.JSX.Element;
 declare namespace FileImport {
   var displayName: string;
 }
@@ -209,6 +354,10 @@ type Props$1 = {
   JSDoc?: JSDoc;
   children?: KubbNode;
 };
+/**
+ * Renders a function definition using the Fabric templating primitives.
+ * Supports optional export/default/async flags, generics, params and JSDoc.
+ */
 declare function Function({
   name,
   default: isDefault,
@@ -219,7 +368,7 @@ declare function Function({
   returnType,
   JSDoc,
   children
-}: Props$1): react3.JSX.Element;
+}: Props$1): react7.JSX.Element;
 declare namespace Function {
   var displayName: string;
   var Arrow: typeof ArrowFunction;
@@ -230,6 +379,12 @@ type ArrowFunctionProps = Props$1 & {
    */
   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.
+ */
 declare function ArrowFunction({
   name,
   default: isDefault,
@@ -241,7 +396,7 @@ declare function ArrowFunction({
   JSDoc,
   singleLine,
   children
-}: ArrowFunctionProps): react3.JSX.Element;
+}: ArrowFunctionProps): react7.JSX.Element;
 declare namespace ArrowFunction {
   var displayName: string;
 }
@@ -254,6 +409,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.
  */
 declare function Indent({
   size,
@@ -277,31 +435,25 @@ type Props = {
   JSDoc?: JSDoc;
   children?: KubbNode;
 };
+/**
+ * Renders a TypeScript type alias. Validates that the provided name starts
+ * with a capital letter and optionally emits JSDoc comments.
+ */
 declare function Type({
   name,
   export: canExport,
   JSDoc,
   children
-}: Props): react3.JSX.Element;
+}: Props): react7.JSX.Element;
 declare namespace Type {
   var displayName: string;
 }
 //#endregion
-//#region src/composables/useApp.d.ts
-/**
- * `useApp` will return the current App with plugin, pluginManager, fileManager and mode.
- */
-declare function useApp<TMeta = unknown>(): AppContextProps<TMeta>;
-//#endregion
-//#region src/composables/useFile.d.ts
-/**
- * `useFile` will return the current file when <File/> is used.
- */
-declare function useFile(): FileContextProps;
-//#endregion
 //#region src/composables/useLifecycle.d.ts
 /**
- * `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.
  */
 declare function useLifecycle(): {
   exit: () => void;
@@ -345,15 +497,15 @@ declare class Runtime {
 }
 //#endregion
 //#region src/index.d.ts
-declare const useState: typeof react3.useState;
-declare const createContext: typeof react3.createContext;
-declare const createElement: typeof react3.createElement;
-declare const Fragment: react3.ExoticComponent<react3.FragmentProps>;
-declare const use: typeof react3.use;
-declare const useContext: typeof react3.useContext;
-declare const useEffect: typeof react3.useEffect;
-declare const useReducer: typeof react3.useReducer;
-declare const useRef: typeof react3.useRef;
+declare const useState: typeof react7.useState;
+declare const createContext: typeof react7.createContext;
+declare const createElement: typeof react7.createElement;
+declare const Fragment: react7.ExoticComponent<react7.FragmentProps>;
+declare const use: typeof react7.use;
+declare const useContext: typeof react7.useContext;
+declare const useEffect: typeof react7.useEffect;
+declare const useReducer: typeof react7.useReducer;
+declare const useRef: typeof react7.useRef;
 //#endregion
-export { App, Const, type Fabric, File, FileManager, FileProcessor, Fragment, Function, FunctionParams, Indent, Runtime, Type, createContext, createElement, createFabric, createFile, createFunctionParams, createReactFabric, use, useApp, useContext, useEffect, useFile, useLifecycle, useReducer, useRef, useState };
+export { App, AppContext, Const, type Context, type Fabric, File, FileCollector, FileCollectorContext, FileManager, FileProcessor, Fragment, Function, FunctionParams, Indent, Root, RootContext, Runtime, Type, createContext, createElement, createFabric, createFile, createFunctionParams, createJSDoc, createReactFabric, inject, provide, unprovide, use, useApp, useContext, useEffect, useFile, useLifecycle, useReducer, useRef, useState };
 //# sourceMappingURL=index.d.cts.map