@kubb/react-fabric 0.0.0-canary-20251020201500

package/dist/index.d.cts

@@ -0,0 +1,331 @@
+import { a as Import, c as Source, i as File$1, n as Export, o as Path, r as Extname, s as ResolvedFile, t as BaseName } from "./globals-CnATk-Sl.cjs";
+import { a as JSDoc, f as createFunctionParams, l as FunctionParams, o as Key, s as KubbNode } from "./types-C3p0Ljxf.cjs";
+import * as react1 from "react";
+import React from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region ../fabric-core/src/defineApp.d.ts
+type Component = any;
+type PluginInstallFunction<Options$1 = any[]> = Options$1 extends unknown[] ? (app: App$1, ...options: Options$1) => any : (app: App$1, options: Options$1) => any;
+type ObjectPlugin<Options$1 = any[]> = {
+  install: PluginInstallFunction<Options$1>;
+};
+type FunctionPlugin<Options$1 = any[]> = PluginInstallFunction<Options$1> & Partial<ObjectPlugin<Options$1>>;
+type Plugin<Options$1 = any[], P extends unknown[] = (Options$1 extends unknown[] ? Options$1 : [Options$1])> = FunctionPlugin<P> | ObjectPlugin<P>;
+type WriteOptions = {
+  extension?: Record<Extname, Extname | ''>;
+  dryRun?: boolean;
+};
+interface App$1 {
+  _component: Component;
+  render(): Promise<void>;
+  renderToString(): Promise<string>;
+  getFiles(): Promise<Array<ResolvedFile>>;
+  use<Options>(plugin: Plugin<Options>, options: NoInfer<Options>): this;
+  write(options?: WriteOptions): Promise<void>;
+  addFile(...files: Array<File$1>): Promise<void>;
+  waitUntilExit(): Promise<void>;
+}
+type DefineApp = (rootComponent?: Component) => App$1;
+//#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>): react_jsx_runtime0.JSX.Element;
+declare namespace App {
+  var Context: react1.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): react_jsx_runtime0.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>): react_jsx_runtime0.JSX.Element;
+declare namespace File {
+  var displayName: string;
+  var Export: typeof FileExport;
+  var Import: typeof FileImport;
+  var Source: typeof FileSource;
+  var Context: react1.Context<FileContextProps<object>>;
+}
+type FileSourceProps = Omit<Source, 'value'> & {
+  key?: Key;
+  children?: KubbNode;
+};
+declare function FileSource({
+  isTypeOnly,
+  name,
+  isExportable,
+  isIndexable,
+  children
+}: FileSourceProps): react_jsx_runtime0.JSX.Element;
+declare namespace FileSource {
+  var displayName: string;
+}
+type FileExportProps = Export & {
+  key?: Key;
+};
+declare function FileExport({
+  name,
+  path,
+  isTypeOnly,
+  asAlias
+}: FileExportProps): react_jsx_runtime0.JSX.Element;
+declare namespace FileExport {
+  var displayName: string;
+}
+type FileImportProps = Import & {
+  key?: Key;
+};
+declare function FileImport({
+  name,
+  root,
+  path,
+  isTypeOnly,
+  isNameSpace
+}: FileImportProps): react_jsx_runtime0.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): react_jsx_runtime0.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): react_jsx_runtime0.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_runtime0.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): react_jsx_runtime0.JSX.Element;
+declare namespace Type {
+  var displayName: string;
+}
+//#endregion
+//#region src/createApp.d.ts
+declare const createApp: DefineApp;
+//#endregion
+//#region src/hooks/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/hooks/useFile.d.ts
+/**
+ * `useFile` will return the current file when <File/> is used.
+ */
+declare function useFile(): FileContextProps;
+//#endregion
+//#region src/hooks/useLifecycle.d.ts
+/**
+ * `useLifecycle` will return some helpers to exit/restart the generation.
+ */
+declare function useLifecycle(): {
+  exit: () => void;
+};
+//#endregion
+//#region src/index.d.ts
+declare const createContext: typeof react1.createContext;
+declare const createElement: typeof react1.createElement;
+declare const useContext: typeof react1.useContext;
+declare const useEffect: typeof react1.useEffect;
+declare const useState: typeof react1.useState;
+declare const useRef: typeof react1.useRef;
+declare const use: typeof react1.use;
+declare const useReducer: typeof react1.useReducer;
+//#endregion
+export { App, Const, File, Function, FunctionParams, Indent, Type, createApp, createContext, createElement, createFunctionParams, use, useApp, useContext, useEffect, useFile, useLifecycle, useReducer, useRef, useState };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,331 @@
+import { a as Import, c as Source, i as File$1, n as Export, o as Path, r as Extname, s as ResolvedFile, t as BaseName } from "./globals-C6rGETh5.js";
+import { a as JSDoc, f as createFunctionParams, l as FunctionParams, o as Key, s as KubbNode } from "./types-DEroxUW0.js";
+import * as react1 from "react";
+import React from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region ../fabric-core/src/defineApp.d.ts
+type Component = any;
+type PluginInstallFunction<Options$1 = any[]> = Options$1 extends unknown[] ? (app: App$1, ...options: Options$1) => any : (app: App$1, options: Options$1) => any;
+type ObjectPlugin<Options$1 = any[]> = {
+  install: PluginInstallFunction<Options$1>;
+};
+type FunctionPlugin<Options$1 = any[]> = PluginInstallFunction<Options$1> & Partial<ObjectPlugin<Options$1>>;
+type Plugin<Options$1 = any[], P extends unknown[] = (Options$1 extends unknown[] ? Options$1 : [Options$1])> = FunctionPlugin<P> | ObjectPlugin<P>;
+type WriteOptions = {
+  extension?: Record<Extname, Extname | ''>;
+  dryRun?: boolean;
+};
+interface App$1 {
+  _component: Component;
+  render(): Promise<void>;
+  renderToString(): Promise<string>;
+  getFiles(): Promise<Array<ResolvedFile>>;
+  use<Options>(plugin: Plugin<Options>, options: NoInfer<Options>): this;
+  write(options?: WriteOptions): Promise<void>;
+  addFile(...files: Array<File$1>): Promise<void>;
+  waitUntilExit(): Promise<void>;
+}
+type DefineApp = (rootComponent?: Component) => App$1;
+//#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>): react_jsx_runtime0.JSX.Element;
+declare namespace App {
+  var Context: react1.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): react_jsx_runtime0.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>): react_jsx_runtime0.JSX.Element;
+declare namespace File {
+  var displayName: string;
+  var Export: typeof FileExport;
+  var Import: typeof FileImport;
+  var Source: typeof FileSource;
+  var Context: react1.Context<FileContextProps<object>>;
+}
+type FileSourceProps = Omit<Source, 'value'> & {
+  key?: Key;
+  children?: KubbNode;
+};
+declare function FileSource({
+  isTypeOnly,
+  name,
+  isExportable,
+  isIndexable,
+  children
+}: FileSourceProps): react_jsx_runtime0.JSX.Element;
+declare namespace FileSource {
+  var displayName: string;
+}
+type FileExportProps = Export & {
+  key?: Key;
+};
+declare function FileExport({
+  name,
+  path,
+  isTypeOnly,
+  asAlias
+}: FileExportProps): react_jsx_runtime0.JSX.Element;
+declare namespace FileExport {
+  var displayName: string;
+}
+type FileImportProps = Import & {
+  key?: Key;
+};
+declare function FileImport({
+  name,
+  root,
+  path,
+  isTypeOnly,
+  isNameSpace
+}: FileImportProps): react_jsx_runtime0.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): react_jsx_runtime0.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): react_jsx_runtime0.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_runtime0.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): react_jsx_runtime0.JSX.Element;
+declare namespace Type {
+  var displayName: string;
+}
+//#endregion
+//#region src/createApp.d.ts
+declare const createApp: DefineApp;
+//#endregion
+//#region src/hooks/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/hooks/useFile.d.ts
+/**
+ * `useFile` will return the current file when <File/> is used.
+ */
+declare function useFile(): FileContextProps;
+//#endregion
+//#region src/hooks/useLifecycle.d.ts
+/**
+ * `useLifecycle` will return some helpers to exit/restart the generation.
+ */
+declare function useLifecycle(): {
+  exit: () => void;
+};
+//#endregion
+//#region src/index.d.ts
+declare const createContext: typeof react1.createContext;
+declare const createElement: typeof react1.createElement;
+declare const useContext: typeof react1.useContext;
+declare const useEffect: typeof react1.useEffect;
+declare const useState: typeof react1.useState;
+declare const useRef: typeof react1.useRef;
+declare const use: typeof react1.use;
+declare const useReducer: typeof react1.useReducer;
+//#endregion
+export { App, Const, File, Function, FunctionParams, Indent, Type, createApp, createContext, createElement, createFunctionParams, use, useApp, useContext, useEffect, useFile, useLifecycle, useReducer, useRef, useState };
+//# sourceMappingURL=index.d.ts.map