@kubb/react-fabric 0.11.0 → 0.11.2

package/dist/types-C3ODUOKN.d.cts

@@ -1,675 +0,0 @@
-import { a as FabricOptions, b as Source, c as FileManager, f as BaseName, g as Import, h as File$1, i as FabricMode, n as FabricConfig, o as Plugin, p as Export, t as Fabric, v as Path, y as ResolvedFile } from "./Fabric-BELBf-bX.cjs";
-import * as react3 from "react";
-import React, { ElementType, JSX, Key, ReactNode } from "react";
-
-//#region ../fabric-core/src/utils/TreeNode.d.ts
-type BarrelData = {
-  file?: File$1;
-  path: string;
-  name: string;
-};
-type Graph = {
-  nodes: Array<{
-    id: string;
-    label: string;
-  }>;
-  edges: Array<{
-    from: string;
-    to: string;
-  }>;
-};
-declare class TreeNode<TData = unknown> {
-  #private;
-  data: TData;
-  parent?: TreeNode<TData>;
-  children: Array<TreeNode<TData>>;
-  constructor(data: TData, parent?: TreeNode<TData>);
-  addChild(data: TData): TreeNode<TData>;
-  getChildByName(name: string): TreeNode<TData> | undefined;
-  get leaves(): Array<TreeNode<TData>>;
-  forEach(callback: (node: TreeNode<TData>) => void): this;
-  findDeep(predicate: (node: TreeNode<TData>) => boolean): TreeNode<TData> | undefined;
-  static toGraph(root: TreeNode<BarrelData>): Graph;
-  static fromFiles(files: Array<File$1>, rootFolder?: string): TreeNode<BarrelData> | null;
-}
-//#endregion
-//#region ../fabric-core/src/composables/useNodeTree.d.ts
-type ComponentNode = {
-  type: string;
-  props: Record<string, unknown>;
-};
-declare function useNodeTree(): TreeNode<ComponentNode> | null;
-//#endregion
-//#region ../fabric-core/src/components/Root.d.ts
-type RootProps = {
-  /**
-   * Exit (unmount) the whole app.
-   */
-  onExit: (error?: Error) => void;
-  /**
-   * Error hook receiving runtime exceptions.
-   */
-  onError: (error: Error) => void;
-  /**
-   * TreeNode representing the tree structure of the app.
-   */
-  treeNode: TreeNode<ComponentNode>;
-  /**
-   * FileManager instance for managing files within the app.
-   */
-  fileManager: FileManager;
-  /**
-   * Children nodes.
-   */
-  children?: string | (() => string | Array<string> | undefined);
-};
-/**
- * This component provides the root behavior for the Fabric runtime.
- */
-declare function Root({
-  onError,
-  onExit,
-  treeNode,
-  fileManager,
-  children
-}: RootProps): string;
-declare namespace Root {
-  var displayName: string;
-}
-//#endregion
-//#region ../fabric-core/src/components/Text.d.ts
-type Props$2 = {
-  /**
-   * Children nodes.
-   */
-  children?: string | (() => string | Array<string> | undefined);
-};
-/**
- * Generates a text node from string or function returning string/array of strings.
- */
-declare function Text({
-  children
-}: Props$2): string;
-//#endregion
-//#region ../fabric-core/src/contexts/AppContext.d.ts
-type AppContextProps<TMeta extends object = object> = {
-  /**
-   * Exit (unmount)
-   */
-  exit: (error?: Error) => void;
-  meta: TMeta;
-};
-/**
- * Provides app-level metadata and lifecycle hooks (like `exit`) to
- * components and composables within a Fabric runtime.
- */
-declare const AppContext: Context<AppContextProps<object>>;
-//#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 extends object = object>(): 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/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(): ResolvedFile | null;
-//#endregion
-//#region ../fabric-core/src/composables/useFileManager.d.ts
-declare function useFileManager(): FileManager;
-//#endregion
-//#region ../fabric-core/src/contexts/FileContext.d.ts
-/**
- * Provides app-level metadata and lifecycle hooks (like `exit`) to
- * components and composables within a Fabric runtime.
- */
-declare const FileContext: Context<ResolvedFile<object> | null>;
-//#endregion
-//#region ../fabric-core/src/contexts/NodeTreeContext.d.ts
-/**
- * Context for having the current NodeTree
- */
-declare const NodeTreeContext: Context<TreeNode<ComponentNode> | null>;
-//#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 ../fabric-core/src/utils/getRelativePath.d.ts
-declare function getRelativePath(rootDir?: string | null, filePath?: string | null, platform?: 'windows' | 'mac' | 'linux'): string;
-//#endregion
-//#region src/components/App.d.ts
-type AppProps<TMeta extends object = object> = {
-  /**
-   * Metadata associated with the App.
-   */
-  meta?: TMeta;
-  /**
-   * Children nodes.
-   */
-  children?: KubbNode;
-};
-/**
- * App container containing the AppContext carrying `meta` and an `exit` hook.
- */
-declare function App<TMeta extends object = object>({
-  children,
-  ...props
-}: AppProps<TMeta>): react3.ReactNode;
-declare namespace App {
-  var displayName: string;
-}
-//#endregion
-//#region src/components/Const.d.ts
-type ConstProps = {
-  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 nodes.
-   */
-  children?: KubbNode;
-};
-/**
- * Generates a TypeScript constant declaration.
- */
-declare function Const({
-  children,
-  ...props
-}: ConstProps): react3.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$1<TMeta> = BaseProps & {
-  key?: Key;
-  meta?: TMeta;
-  banner?: string;
-  footer?: string;
-  children?: KubbNode;
-};
-/**
- * Adds files to the FileManager
- */
-declare function File<TMeta extends object = object>({
-  children,
-  ...props
-}: Props$1<TMeta>): react3.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({
-  children,
-  ...props
-}: FileSourceProps): react3.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(props: FileExportProps): react3.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(props: FileImportProps): react3.JSX.Element;
-declare namespace FileImport {
-  var displayName: string;
-}
-//#endregion
-//#region src/components/Function.d.ts
-type Props = {
-  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 nodes.
-   */
-  children?: string;
-};
-/**
- * Generates a TypeScript function declaration.
- */
-declare function Function({
-  children,
-  ...props
-}: Props): react3.JSX.Element;
-declare namespace Function {
-  var displayName: string;
-  var Arrow: typeof ArrowFunction;
-}
-type ArrowFunctionProps = Props & {
-  /**
-   * 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({
-  children,
-  ...props
-}: ArrowFunctionProps): react3.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 TypeProps = {
-  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 nodes.
-   */
-  children?: KubbNode;
-};
-/**
- * Generates a TypeScript type declaration.
- */
-declare function Type({
-  children,
-  ...props
-}: TypeProps): react3.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/plugins/reactPlugin.d.ts
-type Options$2 = {
-  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;
-};
-type ExtendOptions = {
-  render(App: KubbElement | ElementType): Promise<void>;
-  renderToString(App: KubbElement | ElementType): Promise<string>;
-  waitUntilExit(): Promise<void>;
-};
-declare global {
-  namespace Kubb {
-    interface Fabric {
-      render(App: KubbElement | ElementType): Promise<void>;
-      renderToString(App: KubbElement | ElementType): Promise<string>;
-      waitUntilExit(): Promise<void>;
-    }
-  }
-}
-declare const reactPlugin: Plugin<Options$2, ExtendOptions>;
-//#endregion
-//#region src/createReactFabric.d.ts
-declare function createReactFabric(config?: FabricConfig<Options$2 & {
-  mode?: FabricMode;
-  devtools?: boolean;
-}>): Fabric<Options$2 & {
-  mode?: FabricMode;
-  devtools?: boolean;
-}>;
-//#endregion
-//#region src/Runtime.d.ts
-type Options$1 = {
-  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$1);
-  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/utils/getFunctionParams.d.ts
-type Param = {
-  /**
-   * `object` will return the pathParams as an object.
-   *
-   * `inline` will return the pathParams as comma separated params.
-   * @default `'inline'`
-   * @private
-   */
-  mode?: 'object' | 'inline' | 'inlineSpread';
-  type?: 'string' | 'number' | (string & {});
-  optional?: boolean;
-  /**
-   * @example test = "default"
-   */
-  default?: string;
-  /**
-   * Used for no TypeScript(with mode object)
-   * @example test: "default"
-   */
-  value?: string;
-  children?: Params;
-};
-type Params = Record<string, Param | undefined>;
-type Options = {
-  type: 'constructor' | 'call' | 'object' | 'objectValue';
-  transformName?: (name: string) => string;
-  transformType?: (type: string) => string;
-};
-declare function createFunctionParams(params: Params): Params;
-declare class FunctionParams {
-  #private;
-  static factory(params: Params): FunctionParams;
-  constructor(params: Params);
-  get params(): Params;
-  get flatParams(): Params;
-  toCall({
-    transformName,
-    transformType
-  }?: Pick<Options, 'transformName' | 'transformType'>): string;
-  toObject(): string;
-  toObjectValue(): string;
-  toConstructor(): string;
-}
-//#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;
-//#endregion
-//#region ../fabric-core/src/contexts/RootContext.d.ts
-type RootContextProps = {
-  /**
-   * Exit (unmount) the whole app.
-   */
-  exit: (error?: Error) => void;
-  /**
-   * TreeNode representing the tree structure of the app.
-   */
-  treeNode: TreeNode<ComponentNode>;
-  /**
-   * FileManager instance for managing files within the app.
-   */
-  fileManager: FileManager;
-};
-/**
- * Context providing root-level functionalities such as exit hook, tree node structure, and file management.
- * Define in the `render` helper of the runtime.
- */
-declare const RootContext: Context<RootContextProps>;
-//#endregion
-//#region ../fabric-core/src/types.d.ts
-type JSDoc = {
-  comments: string[];
-};
-//#endregion
-//#region src/types.d.ts
-type ReactElementNames = 'br' | 'div';
-type ElementNames = ReactElementNames | 'kubb-text' | 'kubb-file' | 'kubb-source' | 'kubb-import' | 'kubb-export' | 'kubb-root' | 'kubb-app';
-type Node = {
-  parentNode: DOMElement | undefined;
-  internal_static?: boolean;
-};
-type DOMNodeAttribute = boolean | string | number;
-type TextName = '#text';
-type TextNode = {
-  nodeName: TextName;
-  nodeValue: string;
-} & Node;
-type DOMNode<T = {
-  nodeName: NodeNames;
-}> = T extends {
-  nodeName: infer U;
-} ? U extends '#text' ? TextNode : DOMElement : never;
-type OutputTransformer = (s: string, index: number) => string;
-type DOMElement = {
-  nodeName: ElementNames;
-  attributes: Map<string, DOMNodeAttribute>;
-  childNodes: DOMNode[];
-  internal_transform?: OutputTransformer;
-  isStaticDirty?: boolean;
-  staticNode?: DOMElement;
-  onComputeLayout?: () => void;
-  onRender?: () => void;
-  onImmediateRender?: () => void;
-} & Node;
-type NodeNames = ElementNames | TextName;
-type KubbNode = ReactNode;
-type KubbElement = JSX.Element;
-type KubbTextProps = {
-  children?: KubbNode;
-};
-type KubbFileProps = {
-  id?: string;
-  children?: KubbNode;
-  baseName: string;
-  path: string;
-  override?: boolean;
-  meta?: File$1['meta'];
-};
-type KubbSourceProps = Source & {
-  children?: KubbNode;
-};
-type KubbImportProps = Import;
-type KubbExportProps = Export;
-type LineBreakProps = React.DetailedHTMLProps<React.HTMLAttributes<HTMLBRElement>, HTMLBRElement>;
-//#endregion
-export { useApp as $, createFunctionParams as A, App as B, useEffect as C, FunctionParams as D, useState as E, Type as F, NodeTreeContext as G, createJSDoc as H, Indent as I, useFile as J, FileContext as K, Function as L, createReactFabric as M, reactPlugin as N, Param as O, useLifecycle as P, unprovide as Q, File as R, useContext as S, useRef as T, createFile as U, getRelativePath as V, createFabric as W, inject as X, Context as Y, provide as Z, RootContextProps as _, Key as a, TreeNode as at, createElement as b, KubbFileProps as c, KubbSourceProps as d, AppContext as et, KubbTextProps as f, RootContext as g, JSDoc as h, ElementNames as i, useNodeTree as it, Runtime as j, Params as k, KubbImportProps as l, TextNode as m, DOMNode as n, Root as nt, KubbElement as o, LineBreakProps as p, useFileManager as q, DOMNodeAttribute as r, ComponentNode as rt, KubbExportProps as s, DOMElement as t, Text as tt, KubbNode as u, Fragment as v, useReducer as w, use as x, createContext as y, Const as z };
-//# sourceMappingURL=types-C3ODUOKN.d.cts.map