@kubb/react-fabric 0.9.5 → 0.11.0

package/dist/index.d.ts

@@ -1,359 +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-DitK3IEP.js";
-import { a as JSDoc, d as KubbNode, g as FunctionParams, o as Key, y as createFunctionParams } from "./types-CSUzVTpn.js";
-import { t as Options$1 } from "./reactPlugin-4-kcMKwZ.js";
-import * as react3 from "react";
-import React, { ReactNode } from "react";
-
-//#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 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;
-};
-declare function App<TMeta = unknown>({
-  meta,
-  children
-}: Props$4<TMeta>): react3.JSX.Element;
-declare namespace App {
-  var Context: react3.Context<AppContextProps<unknown> | undefined>;
-  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;
-};
-declare function Const({
-  name,
-  export: canExport,
-  type,
-  JSDoc,
-  asConst,
-  children
-}: Props$3): react3.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).
-   * 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;
-};
-declare function File<TMeta extends object = object>({
-  children,
-  ...rest
-}: Props$2<TMeta>): react3.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;
-};
-declare function FileSource({
-  isTypeOnly,
-  name,
-  isExportable,
-  isIndexable,
-  children
-}: FileSourceProps): react3.JSX.Element;
-declare namespace FileSource {
-  var displayName: string;
-}
-type FileExportProps = Export & {
-  key?: Key;
-};
-declare function FileExport({
-  name,
-  path,
-  isTypeOnly,
-  asAlias
-}: FileExportProps): react3.JSX.Element;
-declare namespace FileExport {
-  var displayName: string;
-}
-type FileImportProps = Import & {
-  key?: Key;
-};
-declare function FileImport({
-  name,
-  root,
-  path,
-  isTypeOnly,
-  isNameSpace
-}: FileImportProps): react3.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;
-};
-declare function Function({
-  name,
-  default: isDefault,
-  export: canExport,
-  async,
-  generics,
-  params,
-  returnType,
-  JSDoc,
-  children
-}: Props$1): react3.JSX.Element;
-declare namespace Function {
-  var displayName: string;
-  var Arrow: typeof ArrowFunction;
-}
-type ArrowFunctionProps = Props$1 & {
-  /**
-   * Create Arrow function in one line
-   */
-  singleLine?: boolean;
-};
-declare function ArrowFunction({
-  name,
-  default: isDefault,
-  export: canExport,
-  async,
-  generics,
-  params,
-  returnType,
-  JSDoc,
-  singleLine,
-  children
-}: 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.
- */
-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;
-};
-declare function Type({
-  name,
-  export: canExport,
-  JSDoc,
-  children
-}: Props): react3.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.
- */
-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 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
-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 };
-//# sourceMappingURL=index.d.ts.map
+import { c as FileManager, l as FileProcessor, t as Fabric } from "./Fabric-DbJhvsCq.js";
+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-DwaohVJS.js";
+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 };

package/dist/index.js

@@ -1,9 +1,9 @@
 import { r as __toESM } from "./chunk-BCPZiDLE.js";
 import { t as require_react } from "./react-DfIUVisP.js";
-import { a as _classPrivateFieldInitSpec, i as _classPrivateFieldGet2, n as Runtime, o as Root, r as _classPrivateFieldSet2, s as RootContext, t as reactPlugin } from "./reactPlugin-ixOr00MK.js";
-import { i as jsxs, n as jsx, t as Fragment$1 } from "./jsx-runtime-DDu0mFTI.js";
-import { t as open } from "./devtools-D6dZodXp.js";
-import { createFabric } from "@kubb/fabric-core";
+import { i as jsxs, n as jsx, t as Fragment$1 } from "./jsx-runtime-Isgf9orn.js";
+import { t as open } from "./devtools-8_UKWDTl.js";
+import { a as _classPrivateFieldInitSpec, i as _classPrivateFieldGet2, n as Runtime, r as _classPrivateFieldSet2, t as reactPlugin } from "./reactPlugin-CAtVV84d.js";
+import { AppContext, FileContext, NodeTreeContext, RootContext, createFabric, createJSDoc, provide, useApp, useContext as useContext$1, useFile, useFile as useFile$1, useFileManager, useNodeTree } from "@kubb/fabric-core";
 import dedent from "dedent";
 import { orderBy } from "natural-orderby";
 
@@ -11,31 +11,37 @@ export * from "@kubb/fabric-core"
 
 //#region src/components/App.tsx
 var import_react = /* @__PURE__ */ __toESM(require_react());
-const AppContext = (0, import_react.createContext)(void 0);
-function App({ meta, children }) {
-	const { exit } = (0, import_react.useContext)(RootContext);
-	return /* @__PURE__ */ jsx(AppContext.Provider, {
-		value: {
-			exit,
-			meta
-		},
-		children
+/**
+* App container containing the AppContext carrying `meta` and an `exit` hook.
+*/
+function App({ children, ...props }) {
+	const { meta = {} } = props;
+	const { exit } = useContext$1(RootContext);
+	const nodeTree = useNodeTree();
+	if (nodeTree) provide(NodeTreeContext, nodeTree.addChild({
+		type: "App",
+		props
+	}));
+	provide(AppContext, {
+		exit,
+		meta
 	});
+	return children;
 }
-App.Context = AppContext;
 App.displayName = "KubbApp";
 
-//#endregion
-//#region src/utils/createJSDoc.ts
-function createJSDoc({ comments }) {
-	const filtered = comments.filter((c) => c.trim());
-	if (!filtered.length) return "";
-	return `/**\n * ${filtered.join("\n * ")}\n */`;
-}
-
 //#endregion
 //#region src/components/Const.tsx
-function Const({ name, export: canExport, type, JSDoc, asConst, children }) {
+/**
+* Generates a TypeScript constant declaration.
+*/
+function Const({ children, ...props }) {
+	const { name, export: canExport, type, JSDoc, asConst } = props;
+	const nodeTree = useNodeTree();
+	if (nodeTree) provide(NodeTreeContext, nodeTree.addChild({
+		type: "Const",
+		props
+	}));
 	return /* @__PURE__ */ jsxs(Fragment$1, { children: [
 		(JSDoc === null || JSDoc === void 0 ? void 0 : JSDoc.comments) && /* @__PURE__ */ jsxs(Fragment$1, { children: [createJSDoc({ comments: JSDoc === null || JSDoc === void 0 ? void 0 : JSDoc.comments }), /* @__PURE__ */ jsx("br", {})] }),
 		canExport && /* @__PURE__ */ jsx(Fragment$1, { children: "export " }),
@@ -56,23 +62,49 @@ Const.displayName = "KubbConst";
 
 //#endregion
 //#region src/components/File.tsx
-const FileContext = (0, import_react.createContext)({});
-function File({ children, ...rest }) {
-	if (!rest.baseName || !rest.path) return /* @__PURE__ */ jsx(Fragment$1, { children });
+/**
+* Adds files to the FileManager
+*/
+function File({ children, ...props }) {
+	const { baseName, path, meta = {}, footer, banner } = props;
+	const fileManager = useFileManager();
+	const nodeTree = useNodeTree();
+	if (nodeTree) provide(NodeTreeContext, nodeTree.addChild({
+		type: "File",
+		props
+	}));
+	if (!baseName || !path) return /* @__PURE__ */ jsx(Fragment$1, { children });
+	const file = {
+		baseName,
+		path,
+		meta,
+		banner,
+		footer,
+		sources: [],
+		imports: [],
+		exports: []
+	};
+	const [resolvedFile] = fileManager.add(file);
+	provide(FileContext, resolvedFile);
 	return /* @__PURE__ */ jsx("kubb-file", {
-		...rest,
-		children: /* @__PURE__ */ jsx(FileContext.Provider, {
-			value: {
-				baseName: rest.baseName,
-				path: rest.path,
-				meta: rest.meta
-			},
-			children
-		})
+		...props,
+		children
 	});
 }
 File.displayName = "KubbFile";
-function FileSource({ isTypeOnly, name, isExportable, isIndexable, children }) {
+/**
+* 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({ children, ...props }) {
+	const { name, isExportable, isIndexable, isTypeOnly } = props;
+	const nodeTree = useNodeTree();
+	if (nodeTree) provide(NodeTreeContext, nodeTree.addChild({
+		type: "FileSource",
+		props
+	}));
 	return /* @__PURE__ */ jsx("kubb-source", {
 		name,
 		isTypeOnly,
@@ -82,29 +114,66 @@ function FileSource({ isTypeOnly, name, isExportable, isIndexable, children }) {
 	});
 }
 FileSource.displayName = "KubbFileSource";
-function FileExport({ name, path, isTypeOnly, asAlias }) {
+/**
+* File.Export
+*
+* Declares an export entry for the current file. This will be collected by
+* the FileCollector for later emission.
+*/
+function FileExport(props) {
+	const { name, path, isTypeOnly, asAlias } = props;
+	const nodeTree = useNodeTree();
+	const file = useFile$1();
+	if (nodeTree) provide(NodeTreeContext, nodeTree.addChild({
+		type: "FileExport",
+		props
+	}));
+	if (file) file.exports.push({
+		name,
+		path,
+		asAlias,
+		isTypeOnly
+	});
 	return /* @__PURE__ */ jsx("kubb-export", {
 		name,
 		path,
-		isTypeOnly: isTypeOnly || false,
+		isTypeOnly,
 		asAlias
 	});
 }
 FileExport.displayName = "KubbFileExport";
-function FileImport({ name, root, path, isTypeOnly, isNameSpace }) {
+/**
+* File.Import
+*
+* Declares an import entry for the current file.
+*/
+function FileImport(props) {
+	const { name, root, path, isTypeOnly, isNameSpace } = props;
+	const nodeTree = useNodeTree();
+	const file = useFile$1();
+	if (nodeTree) provide(NodeTreeContext, nodeTree.addChild({
+		type: "FileImport",
+		props
+	}));
+	if (file) file.imports.push({
+		name,
+		path,
+		root,
+		isNameSpace,
+		isTypeOnly
+	});
 	return /* @__PURE__ */ jsx("kubb-import", {
 		name,
 		root,
 		path,
 		isNameSpace,
-		isTypeOnly: isTypeOnly || false
+		isTypeOnly
 	});
 }
 FileImport.displayName = "KubbFileImport";
 File.Export = FileExport;
 File.Import = FileImport;
 File.Source = FileSource;
-File.Context = FileContext;
 
 //#endregion
 //#region ../../node_modules/.pnpm/indent-string@5.0.0/node_modules/indent-string/index.js
@@ -124,6 +193,9 @@ function indentString(string, count = 1, options = {}) {
 /**
 * 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.
 */
 function Indent({ size = 2, children }) {
 	if (!children) return null;
@@ -150,7 +222,16 @@ function Indent({ size = 2, children }) {
 
 //#endregion
 //#region src/components/Function.tsx
-function Function({ name, default: isDefault, export: canExport, async, generics, params, returnType, JSDoc, children }) {
+/**
+* Generates a TypeScript function declaration.
+*/
+function Function({ children, ...props }) {
+	const { name, default: isDefault, export: canExport, async, generics, params, returnType, JSDoc } = props;
+	const nodeTree = useNodeTree();
+	if (nodeTree) provide(NodeTreeContext, nodeTree.addChild({
+		type: "Function",
+		props
+	}));
 	return /* @__PURE__ */ jsxs(Fragment$1, { children: [
 		(JSDoc === null || JSDoc === void 0 ? void 0 : JSDoc.comments) && /* @__PURE__ */ jsxs(Fragment$1, { children: [createJSDoc({ comments: JSDoc === null || JSDoc === void 0 ? void 0 : JSDoc.comments }), /* @__PURE__ */ jsx("br", {})] }),
 		canExport && /* @__PURE__ */ jsx(Fragment$1, { children: "export " }),
@@ -184,7 +265,19 @@ function Function({ name, default: isDefault, export: canExport, async, generics
 	] });
 }
 Function.displayName = "KubbFunction";
-function ArrowFunction({ name, default: isDefault, export: canExport, async, generics, params, returnType, JSDoc, singleLine, children }) {
+/**
+* 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({ children, ...props }) {
+	const { name, default: isDefault, export: canExport, async, generics, params, returnType, JSDoc, singleLine } = props;
+	const nodeTree = useNodeTree();
+	if (nodeTree) provide(NodeTreeContext, nodeTree.addChild({
+		type: "ArrowFunction",
+		props
+	}));
 	return /* @__PURE__ */ jsxs(Fragment$1, { children: [
 		(JSDoc === null || JSDoc === void 0 ? void 0 : JSDoc.comments) && /* @__PURE__ */ jsxs(Fragment$1, { children: [createJSDoc({ comments: JSDoc === null || JSDoc === void 0 ? void 0 : JSDoc.comments }), /* @__PURE__ */ jsx("br", {})] }),
 		canExport && /* @__PURE__ */ jsx(Fragment$1, { children: "export " }),
@@ -231,7 +324,16 @@ Function.Arrow = ArrowFunction;
 
 //#endregion
 //#region src/components/Type.tsx
-function Type({ name, export: canExport, JSDoc, children }) {
+/**
+* Generates a TypeScript type declaration.
+*/
+function Type({ children, ...props }) {
+	const { name, export: canExport, JSDoc } = props;
+	const nodeTree = useNodeTree();
+	if (nodeTree) provide(NodeTreeContext, nodeTree.addChild({
+		type: "Type",
+		props
+	}));
 	if (name.charAt(0).toUpperCase() !== name.charAt(0)) throw new Error("Name should start with a capital letter(see TypeScript types)");
 	return /* @__PURE__ */ jsxs(Fragment$1, { children: [
 		(JSDoc === null || JSDoc === void 0 ? void 0 : JSDoc.comments) && /* @__PURE__ */ jsxs(Fragment$1, { children: [createJSDoc({ comments: JSDoc === null || JSDoc === void 0 ? void 0 : JSDoc.comments }), /* @__PURE__ */ jsx("br", {})] }),
@@ -244,36 +346,17 @@ function Type({ name, export: canExport, JSDoc, children }) {
 }
 Type.displayName = "KubbType";
 
-//#endregion
-//#region src/composables/useApp.ts
-/**
-* `useApp` will return the current App with plugin, pluginManager, fileManager and mode.
-*/
-function useApp() {
-	const app = (0, import_react.useContext)(App.Context);
-	if (!app) throw new Error("<App /> should be set");
-	return app;
-}
-
-//#endregion
-//#region src/composables/useFile.ts
-/**
-* `useFile` will return the current file when <File/> is used.
-*/
-function useFile() {
-	return (0, import_react.useContext)(File.Context);
-}
-
 //#endregion
 //#region src/composables/useLifecycle.tsx
 /**
-* `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.
 */
 function useLifecycle() {
-	const { exit } = (0, import_react.useContext)(Root.Context);
+	const { exit } = useContext$1(RootContext);
 	return { exit: () => {
-		const timeout = setTimeout(() => {
-			clearTimeout(timeout);
+		setTimeout(() => {
 			exit();
 		}, 0);
 	} };