react-ai-renderer 0.1.19 → 0.1.21

package/dist/client.d.ts

@@ -0,0 +1,138 @@
+import React from 'react';
+
+/**
+ * 骨架图配置接口
+ */
+interface SkeletonConfig {
+    /** 自定义骨架图组件 */
+    component?: React.ComponentType<SkeletonProps>;
+    /** 自定义骨架图元素 */
+    element?: React.ReactElement;
+    /** 自定义骨架图生成函数 */
+    generator?: (props: SkeletonProps) => React.ReactElement;
+    /** 是否启用自动生成 */
+    autoGenerate?: boolean;
+}
+/**
+ * 骨架图组件的属性
+ */
+interface SkeletonProps {
+    componentName: string;
+    componentData?: ComponentData;
+    props?: Record<string, any>;
+    style?: React.CSSProperties;
+}
+
+interface ComponentData {
+    type: "text" | "component";
+    value: string;
+    props?: Record<string, any>;
+    children?: ComponentData[] | string;
+    selfClosing?: boolean;
+    isComplete?: boolean;
+}
+interface BaseComponentHandler {
+    name: string;
+    component: React.ComponentType<any>;
+}
+interface ComponentHandler extends BaseComponentHandler {
+    selfClosing: boolean;
+    /** 组件开始渲染时的钩子（组件进入渲染流程时立即调用） */
+    onRenderStart?: (item: ComponentData, scope: any) => void;
+    /** 组件渲染过程中的钩子（当 isComplete 为 false 时调用） */
+    onRenderProcess?: (item: ComponentData, scope: any) => void;
+    /** 组件渲染完成后的钩子（当 isComplete 为 true 时调用） */
+    onRenderFinished?: (item: ComponentData, scope: any) => void;
+    /** @deprecated 使用 onRenderProcess 替代 */
+    onRender?: (item: ComponentData, scope: any) => void;
+    /** 自定义加载组件，可以是 React 组件、React 元素、字符串、布尔值或返回 React 元素的函数 */
+    loader?: React.ComponentType<any> | React.ReactElement | string | boolean | ((componentName: string) => React.ReactElement);
+    /** 骨架图配置，用于在加载时显示骨架图。如果未提供且 loader 也未提供，将自动根据组件名称生成骨架图 */
+    skeleton?: SkeletonConfig;
+    /** 组件的显示标签，用于在占位组件中显示 */
+    label?: string;
+}
+/** 增强模式的组件配置 */
+interface EnhancedComponentConfig {
+    /** 组件本身 */
+    value: React.ComponentType<any>;
+    /** 组件的显示标签 */
+    label?: string;
+    /** 自定义加载组件，可以是 React 组件、React 元素、字符串、布尔值或返回 React 元素的函数 */
+    loader?: React.ComponentType<any> | React.ReactElement | string | boolean | ((componentName: string) => React.ReactElement);
+    /** 骨架图配置，用于在加载时显示骨架图。如果未提供且 loader 也未提供，将自动根据组件名称生成骨架图 */
+    skeleton?: SkeletonConfig;
+    /** 组件开始渲染时的钩子 */
+    onRenderStart?: (item: ComponentData, scope: any) => void;
+    /** 组件渲染过程中的钩子 */
+    onRenderProcess?: (item: ComponentData, scope: any) => void;
+    /** 组件渲染完成后的钩子 */
+    onRenderFinished?: (item: ComponentData, scope: any) => void;
+    /** 是否自闭合 */
+    selfClosing?: boolean;
+}
+/** 组件值类型：可以是组件本身，也可以是增强配置对象 */
+type ComponentValue = React.ComponentType<any> | EnhancedComponentConfig;
+interface ParserState {
+    position: number;
+    stack: ComponentData[];
+    buffer: string;
+}
+interface ParseResult {
+    props: Record<string, any>;
+    endIndex: number;
+    selfClosing?: boolean;
+}
+interface ReactMarkdownProps {
+    children: string;
+    components?: Record<string, React.ComponentType<any>>;
+    componentHandlers?: ComponentHandler[];
+    remarkPlugins?: any[];
+    rehypePlugins?: any[];
+    scope?: any;
+    [key: string]: any;
+}
+interface StructuredRenderItem {
+    type: 'text' | 'component';
+    value: string;
+}
+interface ReactAIRendererProps {
+    /** 要渲染的 Markdown/MDX 内容 */
+    content?: string;
+    /** 作用域对象，用于传递变量和函数给组件 */
+    scope?: Record<string, any>;
+    /** 自定义组件映射，支持普通模式（组件）和增强模式（配置对象） */
+    components?: Record<string, ComponentValue>;
+    /** 子元素，作为 content 的替代方案 */
+    children?: string;
+    /** 组件处理器数组 */
+    componentHandlers?: ComponentHandler[];
+    /** MdxLayout 相关配置 */
+    /** 是否注入 GitHub Markdown 样式 */
+    useGithubStyles?: boolean;
+    /** MdxLayout 的自定义类名 */
+    mdxLayoutClassName?: string;
+    /** MdxLayout 的自定义样式 */
+    mdxLayoutStyle?: React.CSSProperties;
+    /** 其他传递给组件的属性 */
+    [key: string]: any;
+}
+
+declare function ReactAIRenderer({ content, scope, components, children, componentHandlers, useGithubStyles, mdxLayoutClassName, mdxLayoutStyle }: ReactAIRendererProps): React.JSX.Element | null;
+
+interface ThinkProps {
+    content: string;
+    children?: React.ReactNode;
+}
+
+declare const BuiltInComponents: {
+    _THINK: React.FC<ThinkProps>;
+    pre: (props: any) => React.JSX.Element;
+    code: (props: any) => React.JSX.Element;
+    p: (pProps: any) => React.JSX.Element;
+    a: (aProps: any) => React.JSX.Element;
+    video: ({ node, ...props }: any) => React.JSX.Element;
+    audio: ({ node, ...props }: any) => React.JSX.Element;
+};
+
+export { BaseComponentHandler, BuiltInComponents, ComponentData, ComponentHandler, ComponentValue, EnhancedComponentConfig, ParseResult, ParserState, ReactAIRenderer, ReactAIRendererProps, ReactMarkdownProps, StructuredRenderItem };