rspress-plugin-api-extractor 0.2.2 → 0.3.1

package/runtime/index.d.ts

@@ -1,6 +1,11 @@
 import { ReactElement } from "react";
 
 //#region src/runtime/components/ApiExample/index.d.ts
+/**
+ * Props for the {@link ApiExample} component used in generated MDX pages.
+ *
+ * @public
+ */
 interface ApiExampleProps {
   /** Example code (no Twoslash directives) */
   code: string;
@@ -11,13 +16,13 @@ interface ApiExampleProps {
   hast?: string;
 }
 /**
- * Renders an example code block.
+ * Renders an example code block in generated API documentation pages.
  *
- * Replaces ExampleBlockWrapper with a simpler component that takes a plain
- * code string (no base64, no HAST for code). The code should already have
- * Twoslash directives stripped.
+ * In browser mode renders a Shiki-highlighted code block with copy and wrap
+ * controls. In SSG-MD mode renders a plain fenced code block.
  *
- * In SSG-MD mode, renders a plain code block with the example code.
+ * @param props - {@link ApiExampleProps}
+ * @public
  */
 declare function ApiExample({
   code,
@@ -25,6 +30,11 @@ declare function ApiExample({
 }: ApiExampleProps): ReactElement;
 //#endregion
 //#region src/runtime/components/ApiMember/index.d.ts
+/**
+ * Props for the {@link ApiMember} component used in generated MDX pages.
+ *
+ * @public
+ */
 interface ApiMemberProps {
   /** Member signature code (not wrapped in class/interface) */
   code: string;
@@ -43,15 +53,13 @@ interface ApiMemberProps {
   hasParameters?: boolean | string;
 }
 /**
- * Renders an individual class/interface member signature block.
+ * Renders an individual class or interface member signature block.
  *
- * Replaces MemberSignatureWrapper with a simpler component that takes plain
- * string props. The `code` prop contains only the member signature (not
- * wrapped in a class skeleton), and `summary` is plain markdown-compatible
- * text (not HTML with anchor tags, not base64-encoded).
+ * In browser mode renders an `h3` heading with a Shiki-highlighted signature.
+ * In SSG-MD mode renders a heading, summary, and plain fenced code block.
  *
- * In SSG-MD mode, renders a heading with member name, summary text,
- * and a plain code block with the member signature.
+ * @param props - {@link ApiMemberProps}
+ * @public
  */
 declare function ApiMember({
   code,
@@ -63,6 +71,11 @@ declare function ApiMember({
 }: ApiMemberProps): ReactElement;
 //#endregion
 //#region src/runtime/components/ApiSignature/index.d.ts
+/**
+ * Props for the {@link ApiSignature} component used in generated MDX pages.
+ *
+ * @public
+ */
 interface ApiSignatureProps {
   /** Display code (clean, no Twoslash directives) */
   code: string;
@@ -83,13 +96,11 @@ interface ApiSignatureProps {
 /**
  * Renders a full API type signature block.
  *
- * Replaces SignatureBlockWrapper with a simpler component that takes plain
- * string props (no base64 encoding for code). Produces clean semantic HTML
- * that RSPress converts to LLM-readable markdown in SSG-MD mode, and renders
- * interactive Shiki-highlighted code in browser mode.
+ * In browser mode renders an interactive Shiki-highlighted code block.
+ * In SSG-MD mode renders a plain fenced code block for LLM consumption.
  *
- * In SSG-MD mode, renders a "Signature" heading followed by a plain
- * code block with the type signature.
+ * @param props - {@link ApiSignatureProps}
+ * @public
  */
 declare function ApiSignature({
   code,
@@ -101,413 +112,68 @@ declare function ApiSignature({
 }: ApiSignatureProps): ReactElement;
 //#endregion
 //#region src/runtime/components/EnumMembersTable/index.d.ts
+/**
+ * A single enum member entry for {@link EnumMembersTable}.
+ *
+ * @public
+ */
 interface EnumMember {
+  /** The enum member name. */
   name: string;
+  /** The string or numeric value of the member, if any. */
   value?: string;
+  /** HTML description rendered in the table cell. */
   description: string;
 }
-interface EnumMembersTableProps {
-  members: EnumMember[];
-}
-declare const EnumMembersTable: ({
-  members
-}: EnumMembersTableProps) => ReactElement | null;
-//#endregion
-//#region ../node_modules/.pnpm/@types+unist@3.0.3/node_modules/@types/unist/index.d.ts
-// ## Interfaces
-/**
- * Info associated with nodes by the ecosystem.
- *
- * This space is guaranteed to never be specified by unist or specifications
- * implementing unist.
- * But you can use it in utilities and plugins to store data.
- *
- * This type can be augmented to register custom data.
- * For example:
- *
- * ```ts
- * declare module 'unist' {
- *   interface Data {
- *     // `someNode.data.myId` is typed as `number | undefined`
- *     myId?: number | undefined
- *   }
- * }
- * ```
- */
-interface Data$1 {}
-/**
- * One place in a source file.
- */
-interface Point {
-  /**
-   * Line in a source file (1-indexed integer).
-   */
-  line: number;
-  /**
-   * Column in a source file (1-indexed integer).
-   */
-  column: number;
-  /**
-   * Character in a source file (0-indexed integer).
-   */
-  offset?: number | undefined;
-}
 /**
- * Position of a node in a source document.
+ * Props for the {@link EnumMembersTable} component.
  *
- * A position is a range between two points.
+ * @public
  */
-interface Position {
-  /**
-   * Place of the first character of the parsed source region.
-   */
-  start: Point;
-  /**
-   * Place of the first character after the parsed source region.
-   */
-  end: Point;
+interface EnumMembersTableProps {
+  /** Enum members to display. */
+  members: EnumMember[];
 }
 /**
- * Abstract unist node.
+ * Renders a table of enum members with their values and descriptions.
  *
- * The syntactic unit in unist syntax trees are called nodes.
- *
- * This interface is supposed to be extended.
- * If you can use {@link Literal} or {@link Parent}, you should.
- * But for example in markdown, a `thematicBreak` (`***`), is neither literal
- * nor parent, but still a node.
+ * @public
  */
-interface Node$1 {
-  /**
-   * Node type.
-   */
-  type: string;
-  /**
-   * Info from the ecosystem.
-   */
-  data?: Data$1 | undefined;
-  /**
-   * Position of a node in a source document.
-   *
-   * Nodes that are generated (not in the original source document) must not
-   * have a position.
-   */
-  position?: Position | undefined;
-}
+declare const EnumMembersTable: ({
+  members
+}: EnumMembersTableProps) => ReactElement | null;
 //#endregion
-//#region ../node_modules/.pnpm/@types+hast@3.0.4/node_modules/@types/hast/index.d.ts
-// ## Interfaces
-/**
- * Info associated with hast nodes by the ecosystem.
- *
- * This space is guaranteed to never be specified by unist or hast.
- * But you can use it in utilities and plugins to store data.
- *
- * This type can be augmented to register custom data.
- * For example:
- *
- * ```ts
- * declare module 'hast' {
- *   interface Data {
- *     // `someNode.data.myId` is typed as `number | undefined`
- *     myId?: number | undefined
- *   }
- * }
- * ```
- */
-interface Data extends Data$1 {}
-/**
- * Info associated with an element.
- */
-interface Properties {
-  [PropertyName: string]: boolean | number | string | null | undefined | Array<string | number>;
-}
-// ## Content maps
-/**
- * Union of registered hast nodes that can occur in {@link Element}.
- *
- * To register mote custom hast nodes, add them to {@link ElementContentMap}.
- * They will be automatically added here.
- */
-type ElementContent = ElementContentMap[keyof ElementContentMap];
-/**
- * Registry of all hast nodes that can occur as children of {@link Element}.
- *
- * For a union of all {@link Element} children, see {@link ElementContent}.
- */
-interface ElementContentMap {
-  comment: Comment;
-  element: Element;
-  text: Text;
-}
-/**
- * Union of registered hast nodes that can occur in {@link Root}.
- *
- * To register custom hast nodes, add them to {@link RootContentMap}.
- * They will be automatically added here.
- */
-type RootContent = RootContentMap[keyof RootContentMap];
-/**
- * Registry of all hast nodes that can occur as children of {@link Root}.
- *
- * > 👉 **Note**: {@link Root} does not need to be an entire document.
- * > it can also be a fragment.
- *
- * For a union of all {@link Root} children, see {@link RootContent}.
- */
-interface RootContentMap {
-  comment: Comment;
-  doctype: Doctype;
-  element: Element;
-  text: Text;
-}
-// ## Abstract nodes
-/**
- * Abstract hast node.
- *
- * This interface is supposed to be extended.
- * If you can use {@link Literal} or {@link Parent}, you should.
- * But for example in HTML, a `Doctype` is neither literal nor parent, but
- * still a node.
- *
- * To register custom hast nodes, add them to {@link RootContentMap} and other
- * places where relevant (such as {@link ElementContentMap}).
- *
- * For a union of all registered hast nodes, see {@link Nodes}.
- */
-interface Node extends Node$1 {
-  /**
-   * Info from the ecosystem.
-   */
-  data?: Data | undefined;
-}
-/**
- * Abstract hast node that contains the smallest possible value.
- *
- * This interface is supposed to be extended if you make custom hast nodes.
- *
- * For a union of all registered hast literals, see {@link Literals}.
- */
-interface Literal extends Node {
-  /**
-   * Plain-text value.
-   */
-  value: string;
-}
-/**
- * Abstract hast node that contains other hast nodes (*children*).
- *
- * This interface is supposed to be extended if you make custom hast nodes.
- *
- * For a union of all registered hast parents, see {@link Parents}.
- */
-interface Parent extends Node {
-  /**
-   * List of children.
-   */
-  children: RootContent[];
-}
-// ## Concrete nodes
-/**
- * HTML comment.
- */
-interface Comment extends Literal {
-  /**
-   * Node type of HTML comments in hast.
-   */
-  type: "comment";
-  /**
-   * Data associated with the comment.
-   */
-  data?: CommentData | undefined;
-}
-/**
- * Info associated with hast comments by the ecosystem.
- */
-interface CommentData extends Data {}
-/**
- * HTML document type.
- */
-interface Doctype extends Node$1 {
-  /**
-   * Node type of HTML document types in hast.
-   */
-  type: "doctype";
-  /**
-   * Data associated with the doctype.
-   */
-  data?: DoctypeData | undefined;
-}
-/**
- * Info associated with hast doctypes by the ecosystem.
- */
-interface DoctypeData extends Data {}
-/**
- * HTML element.
- */
-interface Element extends Parent {
-  /**
-   * Node type of elements.
-   */
-  type: "element";
-  /**
-   * Tag name (such as `'body'`) of the element.
-   */
-  tagName: string;
-  /**
-   * Info associated with the element.
-   */
-  properties: Properties;
-  /**
-   * Children of element.
-   */
-  children: ElementContent[];
-  /**
-   * When the `tagName` field is `'template'`, a `content` field can be
-   * present.
-   */
-  content?: Root | undefined;
-  /**
-   * Data associated with the element.
-   */
-  data?: ElementData | undefined;
-}
-/**
- * Info associated with hast elements by the ecosystem.
- */
-interface ElementData extends Data {}
+//#region src/runtime/components/ParametersTable/index.d.ts
 /**
- * Document fragment or a whole document.
+ * A single parameter entry for {@link ParametersTable}.
  *
- * Should be used as the root of a tree and must not be used as a child.
- *
- * Can also be used as the value for the content field on a `'template'` element.
- */
-interface Root extends Parent {
-  /**
-   * Node type of hast root.
-   */
-  type: "root";
-  /**
-   * Children of root.
-   */
-  children: RootContent[];
-  /**
-   * Data associated with the hast root.
-   */
-  data?: RootData | undefined;
-}
-/**
- * Info associated with hast root nodes by the ecosystem.
- */
-interface RootData extends Data {}
-/**
- * HTML character data (plain text).
- */
-interface Text extends Literal {
-  /**
-   * Node type of HTML character data (plain text) in hast.
-   */
-  type: "text";
-  /**
-   * Data associated with the text.
-   */
-  data?: TextData | undefined;
-}
-/**
- * Info associated with hast texts by the ecosystem.
- */
-interface TextData extends Data {}
-//#endregion
-//#region src/runtime/components/ExampleBlock/index.d.ts
-interface ExampleBlockProps {
-  /** Pre-generated HAST (Hypertext Abstract Syntax Tree) from Shiki */
-  hast: Root | null;
-  /** The code for copy functionality (optional for backwards compatibility) */
-  code?: string;
-}
-/**
- * Code block for examples - displays syntax-highlighted code without a heading
- * Similar to SignatureBlock but without the "Signature" header
- * Includes both copy and wrap buttons in the toolbar
+ * @public
  */
-declare function ExampleBlock({
-  hast,
-  code
-}: ExampleBlockProps): ReactElement;
-//#endregion
-//#region src/runtime/components/MemberSignature/index.d.ts
-interface MemberSignatureProps {
-  /** Pre-generated HAST (Hypertext Abstract Syntax Tree) from Shiki */
-  hast: Root | null;
-  /** Member name to display in the header */
-  memberName: string;
-  /** Optional ID for the anchor link */
-  id?: string;
-  /** Optional plain text summary to display in the toolbar */
-  summary?: string;
-  /** Whether this signature has parameters (affects border radius) */
-  hasParameters?: boolean;
-}
-/**
- * Interactive member signature block with h3 header and wrap button
- * Displays syntax-highlighted TypeScript member signatures with hover tooltips
- */
-declare function MemberSignature({
-  hast,
-  memberName,
-  id,
-  summary,
-  hasParameters
-}: MemberSignatureProps): ReactElement;
-//#endregion
-//#region src/runtime/components/ParametersTable/index.d.ts
 interface Parameter {
+  /** Parameter name. */
   name: string;
+  /** TypeScript type string, if available. */
   type?: string;
+  /** HTML description rendered in the table cell. */
   description: string;
 }
+/**
+ * Props for the {@link ParametersTable} component.
+ *
+ * @public
+ */
 interface ParametersTableProps {
+  /** Parameters to display. */
   parameters: Parameter[];
 }
-declare const ParametersTable: ({
-  parameters
-}: ParametersTableProps) => ReactElement | null;
-//#endregion
-//#region src/runtime/components/SignatureBlock/index.d.ts
-interface SignatureBlockProps {
-  /** Pre-generated HAST (Hypertext Abstract Syntax Tree) from Shiki */
-  hast: Root | null;
-  /** Optional heading text to display in the toolbar */
-  heading?: string;
-  /** Optional ID for the heading anchor link */
-  id?: string;
-  /** Whether this signature has parameters (affects border radius) */
-  hasParameters?: boolean;
-}
 /**
- * Interactive signature block with wrap button
- * Displays syntax-highlighted TypeScript signatures with hover tooltips
- */
-declare function SignatureBlock({
-  hast,
-  heading,
-  id,
-  hasParameters
-}: SignatureBlockProps): ReactElement;
-//#endregion
-//#region src/runtime/utils/hast-renderer.d.ts
-/**
- * Convert a HAST (Hypertext Abstract Syntax Tree) root to a React element.
- *
- * This function is used to render pre-generated Shiki HAST trees at runtime,
- * avoiding the need for `dangerouslySetInnerHTML` and eliminating MDX parsing
- * issues caused by long HTML strings with special characters.
+ * Renders a table of function or method parameters with their types and descriptions.
  *
- * @param hast - The HAST root node from Shiki's `codeToHast()`
- * @returns A React element representing the HAST tree
+ * @public
  */
-declare function hastToReact(hast: Root): ReactElement;
+declare const ParametersTable: ({
+  parameters
+}: ParametersTableProps) => ReactElement | null;
 //#endregion
-export { ApiExample, type ApiExampleProps, ApiMember, type ApiMemberProps, ApiSignature, type ApiSignatureProps, type EnumMember, EnumMembersTable, type EnumMembersTableProps, ExampleBlock, type ExampleBlockProps, MemberSignature, type MemberSignatureProps, type Parameter, ParametersTable, type ParametersTableProps, SignatureBlock, type SignatureBlockProps, hastToReact };
+export { ApiExample, type ApiExampleProps, ApiMember, type ApiMemberProps, ApiSignature, type ApiSignatureProps, type EnumMember, EnumMembersTable, type EnumMembersTableProps, type Parameter, ParametersTable, type ParametersTableProps };
 //# sourceMappingURL=index.d.ts.map

package/runtime/index.js

@@ -1,13 +1,9 @@
 import "./components/shared/variables.css";
 import "./components/shared/_twoslash.css";
-import { hastToReact } from "./utils/hast-renderer.js";
-import { ExampleBlock } from "./components/ExampleBlock/index.js";
 import { ApiExample } from "./components/ApiExample/index.js";
-import { MemberSignature } from "./components/MemberSignature/index.js";
 import { ApiMember } from "./components/ApiMember/index.js";
-import { SignatureBlock } from "./components/SignatureBlock/index.js";
 import { ApiSignature } from "./components/ApiSignature/index.js";
 import { EnumMembersTable } from "./components/EnumMembersTable/index.js";
 import { ParametersTable } from "./components/ParametersTable/index.js";
 
-export { ApiExample, ApiMember, ApiSignature, EnumMembersTable, ExampleBlock, MemberSignature, ParametersTable, SignatureBlock, hastToReact };
+export { ApiExample, ApiMember, ApiSignature, EnumMembersTable, ParametersTable };

package/runtime/utils/hast-renderer.js

@@ -11,6 +11,7 @@ import { toJsxRuntime } from "hast-util-to-jsx-runtime";
 *
 * @param hast - The HAST root node from Shiki's `codeToHast()`
 * @returns A React element representing the HAST tree
+* @internal
 */
 function hastToReact(hast) {
 	return toJsxRuntime(hast, {