@kubb/renderer-jsx 5.0.0-alpha.33

package/dist/index.d.ts

@@ -0,0 +1,330 @@
+import { n as __name } from "./chunk-CErwXX-a.js";
+import { C as inject, S as createContext, T as unprovide, a as JSDoc, h as KubbReactNode, m as KubbReactElement, o as Key, w as provide, x as Context } from "./types-C7FD9BLg.js";
+import { ExportNode, FileNode, ImportNode, SourceNode } from "@kubb/ast/types";
+import * as _$react from "react";
+
+//#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?: KubbReactNode;
+};
+/**
+ * Generates a TypeScript constant declaration.
+ */
+declare function Const({
+  children,
+  ...props
+}: ConstProps): KubbReactElement;
+declare namespace Const {
+  var displayName: string;
+}
+//#endregion
+//#region src/components/File.d.ts
+type BasePropsWithBaseName = {
+  /**
+   * Name to be used to dynamically create the baseName(based on input.path).
+   * Based on UNIX basename
+   * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
+   */
+  baseName: `${string}.${string}`;
+  /**
+   * Path will be full qualified path to a specified file.
+   */
+  path: string;
+};
+type BasePropsWithoutBaseName = {
+  baseName?: never;
+  /**
+   * Path will be full qualified path to a specified file.
+   */
+  path?: string;
+};
+type BaseProps = BasePropsWithBaseName | BasePropsWithoutBaseName;
+type Props$2<TMeta> = BaseProps & {
+  key?: Key;
+  meta?: TMeta;
+  banner?: string;
+  footer?: string;
+  children?: KubbReactNode;
+};
+/**
+ * Adds files to the FileManager
+ */
+declare function File<TMeta extends object = object>({
+  children,
+  ...props
+}: Props$2<TMeta>): KubbReactElement;
+declare namespace File {
+  var displayName: string;
+  var Export: typeof FileExport;
+  var Import: typeof FileImport;
+  var Source: typeof FileSource;
+}
+type FileSourceProps = Omit<SourceNode, 'kind' | 'value'> & {
+  key?: Key;
+  children?: KubbReactNode;
+};
+/**
+ * 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): KubbReactElement;
+declare namespace FileSource {
+  var displayName: string;
+}
+type FileExportProps = Omit<ExportNode, 'kind'> & {
+  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): KubbReactElement;
+declare namespace FileExport {
+  var displayName: string;
+}
+type FileImportProps = Omit<ImportNode, 'kind'> & {
+  key?: Key;
+};
+/**
+ * File.Import
+ *
+ * Declares an import entry for the current file.
+ */
+declare function FileImport(props: FileImportProps): KubbReactElement;
+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 behavior.
+   * 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?: KubbReactNode;
+};
+/**
+ * Generates a TypeScript function declaration.
+ */
+declare function Function({
+  children,
+  ...props
+}: Props$1): KubbReactElement;
+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({
+  children,
+  ...props
+}: ArrowFunctionProps): _$react.JSX.Element;
+declare namespace ArrowFunction {
+  var displayName: string;
+}
+//#endregion
+//#region src/components/Jsx.d.ts
+type Props = {
+  /**
+   * Raw JSX string to embed verbatim in the generated code.
+   * Supports JSX fragments (`<>…</>`), elements, and any valid JSX syntax.
+   * @example
+   * ```tsx
+   * <Jsx>{'<>\n  <a href={href}>Open</a>\n</>'}</Jsx>
+   * ```
+   */
+  children?: string;
+};
+/**
+ * Embeds a raw JSX string verbatim in the generated source code.
+ *
+ * Use this component when you need to include JSX markup (including fragments
+ * `<>…</>`) in the body of a generated function or component. The `children`
+ * prop must be a plain string — expression attributes that reference runtime
+ * values should be written as template literals.
+ *
+ * @example
+ * ```tsx
+ * <Function name="MyComponent" export>
+ *   <Jsx>{'return (\n  <>\n    <div>Hello</div>\n  </>\n)'}</Jsx>
+ * </Function>
+ * ```
+ */
+declare function Jsx({
+  children
+}: Props): KubbReactElement;
+declare namespace Jsx {
+  var displayName: string;
+}
+//#endregion
+//#region 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;
+  /**
+   * Children nodes.
+   */
+  children?: KubbReactNode;
+};
+/**
+ * This component provides the root behavior for the Kubb runtime.
+ */
+declare function Root({
+  onError,
+  children
+}: RootProps): KubbReactElement;
+declare namespace Root {
+  var displayName: string;
+}
+//#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?: KubbReactNode;
+};
+/**
+ * Generates a TypeScript type declaration.
+ */
+declare function Type({
+  children,
+  ...props
+}: TypeProps): KubbReactElement;
+declare namespace Type {
+  var displayName: string;
+}
+//#endregion
+//#region src/context/KubbContext.d.ts
+type KubbContextValue = {
+  driver: unknown;
+  plugin: unknown;
+  mode: 'single' | 'split';
+};
+/**
+ * Context key for kubb render-time data (driver, plugin, mode).
+ * Use `provide`/`unprovide` from `@internals/utils` around render calls,
+ * and `inject` inside generator components.
+ * @deprecated
+ */
+declare const KubbContext: Context<KubbContextValue | null>;
+//#endregion
+//#region src/context/OasContext.d.ts
+/**
+ * Context key for the OAS (OpenAPI Specification) instance.
+ * Use `provide`/`unprovide` from `@internals/utils` around render calls,
+ * and `inject` inside generator components.
+ * @deprecated
+ */
+declare const OasContext: Context<unknown>;
+//#endregion
+//#region src/createRenderer.d.ts
+type Options = {
+  /**
+   * Set this to true to always see the result of the render in the console(line per render)
+   */
+  debug?: boolean;
+};
+type Renderer = {
+  render(Element: KubbReactElement): Promise<void>;
+  unmount(error?: Error | number | null): void;
+  files: Array<FileNode>;
+};
+declare function createRenderer(options?: Options): Renderer;
+//#endregion
+export { Const, File, Function, Jsx, KubbContext, OasContext, Root, Type, createContext, createRenderer, inject, provide, unprovide };
+//# sourceMappingURL=index.d.ts.map