rspress-plugin-api-extractor 0.1.0 → 0.1.1

package/runtime/index.d.ts

@@ -0,0 +1,173 @@
+import type { ReactElement } from 'react';
+import type { Root } from 'hast';
+
+/**
+ * Renders an example code block.
+ *
+ * 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 SSG-MD mode, renders a plain code block with the example code.
+ */
+export declare function ApiExample({ code, hast }: ApiExampleProps): ReactElement;
+
+export declare interface ApiExampleProps {
+    /** Example code (no Twoslash directives) */
+    code: string;
+    /**
+     * Pre-generated HAST tree from Shiki (base64-encoded JSON string).
+     * Injected by the remark-api-codeblocks plugin during MDX compilation.
+     */
+    hast?: string;
+}
+
+/**
+ * Renders an individual class/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 SSG-MD mode, renders a heading with member name, summary text,
+ * and a plain code block with the member signature.
+ */
+export declare function ApiMember({ code, memberName, summary, id, hast, hasParameters }: ApiMemberProps): ReactElement;
+
+export declare interface ApiMemberProps {
+    /** Member signature code (not wrapped in class/interface) */
+    code: string;
+    /** Display name for the heading */
+    memberName: string;
+    /** Plain text or markdown summary (not HTML, not base64) */
+    summary?: string;
+    /** Anchor ID */
+    id?: string;
+    /**
+     * Pre-generated HAST tree from Shiki (base64-encoded JSON string).
+     * Injected by the remark-api-codeblocks plugin during MDX compilation.
+     */
+    hast?: string;
+    /** Whether this signature has parameters (affects border radius in browser mode) */
+    hasParameters?: boolean | string;
+}
+
+/**
+ * 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 SSG-MD mode, renders a "Signature" heading followed by a plain
+ * code block with the type signature.
+ */
+export declare function ApiSignature({ code, heading: _heading, id: _id, hast, hasParameters, hasMembers, }: ApiSignatureProps): ReactElement;
+
+export declare interface ApiSignatureProps {
+    /** Display code (clean, no Twoslash directives) */
+    code: string;
+    /** Section heading (default: "Signature") */
+    heading?: string;
+    /** Anchor ID (default: "signature") */
+    id?: string;
+    /**
+     * Pre-generated HAST tree from Shiki (base64-encoded JSON string).
+     * Injected by the remark-api-codeblocks plugin during MDX compilation.
+     */
+    hast?: string;
+    /** Whether this signature has parameters (affects border radius in browser mode) */
+    hasParameters?: boolean | string;
+    /** Whether this signature has members table below (affects border radius in browser mode) */
+    hasMembers?: boolean | string;
+}
+
+export declare interface EnumMember {
+    name: string;
+    value?: string;
+    description: string;
+}
+
+export declare const EnumMembersTable: ({ members }: EnumMembersTableProps) => ReactElement | null;
+
+export declare interface EnumMembersTableProps {
+    members: EnumMember[];
+}
+
+/**
+ * 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
+ */
+export declare function ExampleBlock({ hast, code }: ExampleBlockProps): ReactElement;
+
+export declare 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;
+}
+
+/**
+ * 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.
+ *
+ * @param hast - The HAST root node from Shiki's `codeToHast()`
+ * @returns A React element representing the HAST tree
+ */
+export declare function hastToReact(hast: Root): ReactElement;
+
+/**
+ * Interactive member signature block with h3 header and wrap button
+ * Displays syntax-highlighted TypeScript member signatures with hover tooltips
+ */
+export declare function MemberSignature({ hast, memberName, id, summary, hasParameters, }: MemberSignatureProps): ReactElement;
+
+export declare 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;
+}
+
+export declare interface Parameter {
+    name: string;
+    type?: string;
+    description: string;
+}
+
+export declare const ParametersTable: ({ parameters }: ParametersTableProps) => ReactElement | null;
+
+export declare interface ParametersTableProps {
+    parameters: Parameter[];
+}
+
+/**
+ * Interactive signature block with wrap button
+ * Displays syntax-highlighted TypeScript signatures with hover tooltips
+ */
+export declare function SignatureBlock({ hast, heading, id, hasParameters, }: SignatureBlockProps): ReactElement;
+
+export declare 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;
+}
+
+export { }