@kubb/react-fabric 0.10.0 → 0.11.0

package/dist/index.d.cts

@@ -1,511 +1,3 @@
-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 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 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
- *
- * @example
- * const fabric = createFabric()
- * fabric.use(myPlugin())
- */
-declare function createFabric<T extends FabricOptions>(config?: FabricConfig<T>): Fabric<T>;
-//#endregion
-//#region ../fabric-core/src/createFile.d.ts
-/**
- * Helper to create a file with name and id set
- */
-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 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>): react7.ReactNode;
-declare namespace App {
-  var displayName: string;
-}
-//#endregion
-//#region src/components/Const.d.ts
-type Props$3 = {
-  key?: Key;
-  /**
-   * Name of the const
-   */
-  name: string;
-  /**
-   * Does this type need to be exported.
-   */
-  export?: boolean;
-  /**
-   * Type to make the const being typed
-   */
-  type?: string;
-  /**
-   * Options for JSdocs.
-   */
-  JSDoc?: JSDoc;
-  /**
-   * Use of `const` assertions
-   */
-  asConst?: boolean;
-  children?: KubbNode;
-};
-/**
- * Renders a constant declaration. Supports optional export, type and JSDoc.
- */
-declare function Const({
-  name,
-  export: canExport,
-  type,
-  JSDoc,
-  asConst,
-  children
-}: Props$3): react7.JSX.Element;
-declare namespace Const {
-  var displayName: string;
-}
-//#endregion
-//#region src/components/File.d.ts
-type BasePropsWithBaseName = {
-  /**
-   * 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;
-};
-type BasePropsWithoutBaseName = {
-  baseName?: never;
-  /**
-   * Path will be full qualified path to a specified file.
-   */
-  path?: Path;
-};
-type BaseProps = BasePropsWithBaseName | BasePropsWithoutBaseName;
-type Props$2<TMeta> = BaseProps & {
-  key?: Key;
-  meta?: TMeta;
-  banner?: string;
-  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>): react7.JSX.Element;
-declare namespace File {
-  var displayName: string;
-  var Export: typeof FileExport;
-  var Import: typeof FileImport;
-  var Source: typeof FileSource;
-}
-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): 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): 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): react7.JSX.Element;
-declare namespace FileImport {
-  var displayName: string;
-}
-//#endregion
-//#region src/components/Function.d.ts
-type Props$1 = {
-  key?: Key;
-  /**
-   * Name of the function.
-   */
-  name: string;
-  /**
-   * Add default when export is being used
-   */
-  default?: boolean;
-  /**
-   * Parameters/options/props that need to be used.
-   */
-  params?: string;
-  /**
-   * Does this function need to be exported.
-   */
-  export?: boolean;
-  /**
-   * Does the function has async/promise behaviour.
-   * This will also add `Promise<returnType>` as the returnType.
-   */
-  async?: boolean;
-  /**
-   * Generics that needs to be added for TypeScript.
-   */
-  generics?: string | string[];
-  /**
-   * ReturnType(see async for adding Promise type).
-   */
-  returnType?: string;
-  /**
-   * Options for JSdocs.
-   */
-  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,
-  export: canExport,
-  async,
-  generics,
-  params,
-  returnType,
-  JSDoc,
-  children
-}: Props$1): react7.JSX.Element;
-declare namespace Function {
-  var displayName: string;
-  var Arrow: typeof ArrowFunction;
-}
-type ArrowFunctionProps = Props$1 & {
-  /**
-   * Create Arrow function in one line
-   */
-  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,
-  export: canExport,
-  async,
-  generics,
-  params,
-  returnType,
-  JSDoc,
-  singleLine,
-  children
-}: ArrowFunctionProps): react7.JSX.Element;
-declare namespace ArrowFunction {
-  var displayName: string;
-}
-//#endregion
-//#region src/components/Indent.d.ts
-type IndentProps = {
-  size?: number;
-  children?: React.ReactNode;
-};
-/**
- * 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,
-  children
-}: IndentProps): React.JSX.Element | null;
-//#endregion
-//#region src/components/Type.d.ts
-type Props = {
-  key?: Key;
-  /**
-   * Name of the type, this needs to start with a capital letter.
-   */
-  name: string;
-  /**
-   * Does this type need to be exported.
-   */
-  export?: boolean;
-  /**
-   * Options for JSdocs.
-   */
-  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): react7.JSX.Element;
-declare namespace Type {
-  var displayName: string;
-}
-//#endregion
-//#region src/composables/useLifecycle.d.ts
-/**
- * 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;
-};
-//#endregion
-//#region src/createReactFabric.d.ts
-declare function createReactFabric(config?: FabricConfig<Options$1 & {
-  mode?: FabricMode;
-  devtools?: boolean;
-}>): Fabric<Options$1 & {
-  mode?: FabricMode;
-  devtools?: boolean;
-}>;
-//#endregion
-//#region src/Runtime.d.ts
-type Options = {
-  fileManager: FileManager;
-  stdout?: NodeJS.WriteStream;
-  stdin?: NodeJS.ReadStream;
-  stderr?: NodeJS.WriteStream;
-  /**
-   * Set this to true to always see the result of the render in the console(line per render)
-   */
-  debug?: boolean;
-};
-declare class Runtime {
-  #private;
-  exitPromise?: Promise<void>;
-  constructor(options: Options);
-  get fileManager(): FileManager;
-  resolveExitPromise: () => void;
-  rejectExitPromise: (reason?: Error) => void;
-  unsubscribeExit: () => void;
-  onRender: () => Promise<void>;
-  onError(error: Error): void;
-  onExit(error?: Error): void;
-  render(node: ReactNode): Promise<void>;
-  renderToString(node: ReactNode): Promise<string>;
-  unmount(error?: Error | number | null): void;
-  waitUntilExit(): Promise<void>;
-}
-//#endregion
-//#region src/index.d.ts
-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, 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
+import { c as FileManager, l as FileProcessor, t as Fabric } from "./Fabric-BELBf-bX.cjs";
+import { $ as useApp, A as createFunctionParams, B as App, C as useEffect, D as FunctionParams, E as useState, F as Type, G as NodeTreeContext, H as createJSDoc, I as Indent, J as useFile, K as FileContext, L as Function, M as createReactFabric, P as useLifecycle, Q as unprovide, R as File, S as useContext, T as useRef, U as createFile, V as getRelativePath, W as createFabric, X as inject, Y as Context, Z as provide, at as TreeNode, b as createElement, et as AppContext, g as RootContext, it as useNodeTree, j as Runtime, nt as Root, q as useFileManager, tt as Text, v as Fragment, w as useReducer, x as use, y as createContext, z as Const } from "./types-C3ODUOKN.cjs";
+export { App, AppContext, Const, Context, Fabric, File, FileContext, FileManager, FileProcessor, Fragment, Function, FunctionParams, Indent, NodeTreeContext, Root, RootContext, Runtime, Text, TreeNode, Type, createContext, createElement, createFabric, createFile, createFunctionParams, createJSDoc, createReactFabric, getRelativePath, inject, provide, unprovide, use, useApp, useContext, useEffect, useFile, useFileManager, useLifecycle, useNodeTree, useReducer, useRef, useState };