@clarify-labs/renderer 0.4.0 → 0.5.0

package/output/types.d.ts

@@ -1,174 +1 @@
-import { ComponentType } from 'react';
-import { OpenAPISpec } from './openapi/utils';
-export type RouteComponent = ComponentType | (() => Promise<{
-    default: ComponentType;
-}>);
-export type RouteSection = {
-    id: string;
-    title: string;
-    badge?: string;
-    tags?: string[];
-};
-export type NavigationNode = {
-    path: string;
-    title: string;
-    icon?: string;
-    children?: NavigationNode[];
-    sections?: RouteSection[];
-};
-export type RouteItem = {
-    path: string;
-    basePath?: string;
-    locale?: string;
-    isFallback?: boolean;
-    alternates?: Record<string, string>;
-    title: string;
-    description?: string;
-    keywords?: string[];
-    component: RouteComponent;
-    lazy?: boolean;
-    kind?: 'mdx' | 'openapi';
-    sections?: RouteSection[];
-    contentArtifactUrl?: string;
-};
-export type ClarifyLogoConfig = string | {
-    light?: string;
-    dark?: string;
-};
-export type ClarifyFaviconConfig = string | {
-    light?: string;
-    dark?: string;
-};
-export type ClarifyLocalizedText = string | Record<string, string>;
-export type ClarifyLocaleConfig = {
-    code: string;
-    label: string;
-    dir?: 'ltr' | 'rtl';
-};
-export type ClarifyI18nConfig = {
-    defaultLocale: string;
-    missing: 'fallback' | '404' | 'hide';
-    locales: ClarifyLocaleConfig[];
-};
-export type ClarifyNavbarLink = {
-    label: ClarifyLocalizedText;
-    href: string;
-    external?: boolean;
-};
-export type ClarifyBannerConfig = {
-    content: ClarifyLocalizedText;
-    dismissible?: boolean;
-};
-export type ClarifyFooterConfig = {
-    links?: ClarifyNavbarLink[];
-    socials?: Record<string, string>;
-    copyright?: ClarifyLocalizedText;
-};
-export type ClarifyThemePreset = 'default' | 'base';
-export type ClarifyThemeColorTokensConfig = {
-    primary: string;
-    accent: string;
-    background: string;
-    foreground: string;
-    surface: string;
-    muted: string;
-    border: string;
-    codeBackground: string;
-};
-export type ClarifyThemeRadiusTokensConfig = {
-    sm: string;
-    md: string;
-    lg: string;
-    xl: string;
-};
-export type ClarifyThemeTokensConfig = {
-    colors: ClarifyThemeColorTokensConfig;
-    radius: ClarifyThemeRadiusTokensConfig;
-};
-export type ClarifyThemeLayoutConfig = {
-    maxWidth: string;
-};
-export type ClarifyThemeConfig = {
-    preset: ClarifyThemePreset;
-    tokens: ClarifyThemeTokensConfig;
-    layout: ClarifyThemeLayoutConfig;
-};
-export type ClarifyPagesItem = string | {
-    page: string;
-    title?: ClarifyLocalizedText;
-    icon?: string;
-    redirect?: string;
-} | {
-    openapi: string;
-    icon?: string;
-    title?: ClarifyLocalizedText;
-};
-export type ClarifyPagesGroup = {
-    group: ClarifyLocalizedText;
-    icon?: string;
-    pages: ClarifyPagesItem[];
-};
-export type ClarifyPagesConfig = ClarifyPagesGroup[] | 'FileTree';
-export type ClarifyTabItem = {
-    tab: ClarifyLocalizedText;
-    icon?: string;
-    pages?: ClarifyPagesConfig;
-};
-export type ClarifyTabsConfig = ClarifyTabItem[];
-export type ClarifyConfig = {
-    title: string;
-    logo?: ClarifyLogoConfig;
-    favicon?: ClarifyFaviconConfig;
-    theme: ClarifyThemeConfig;
-    description: string;
-    rootDirectory: string;
-    routePrefix: string;
-    outputDirectory: string;
-    navbar?: {
-        links?: ClarifyNavbarLink[];
-    };
-    banner?: ClarifyBannerConfig;
-    footer?: ClarifyFooterConfig;
-    i18n?: ClarifyI18nConfig;
-    tabs?: ClarifyTabsConfig;
-};
-export type NavigationTab = {
-    type: 'tab';
-    path: string;
-    title: string;
-    icon?: string;
-    children: NavigationNode[];
-};
-export type TabbedNavigation = {
-    tabs: NavigationTab[];
-};
-export type LocalizedNavigation = Record<string, NavigationNode[]>;
-export type LocalizedTabbedNavigation = Record<string, TabbedNavigation>;
-export type NavigationTree = NavigationNode[] | LocalizedNavigation | TabbedNavigation | LocalizedTabbedNavigation;
-export type RenderOptions = {
-    /** 从 virtual:clarify-config 导入的 config */
-    config: ClarifyConfig;
-    /** 从 virtual:clarify-routes 导入的路由数组 */
-    routes: RouteItem[];
-    /** 从 virtual:clarify-routes 导入的导航树；启用 i18n 时为按 locale 分组的导航树 */
-    navigation?: NavigationTree;
-    /** 从 virtual:clarify-openapi-registry 导入的 OpenAPI 规范表 */
-    openApis?: Record<string, OpenAPISpec>;
-    /** 挂载节点，默认 document.getElementById('root') */
-    container?: Element | null;
-};
-export type ServerRouteItem = Omit<RouteItem, 'component'> & {
-    component: ComponentType;
-};
-export type ServerRenderOptions = {
-    /** 从 virtual:clarify-config 导入的 config */
-    config: ClarifyConfig;
-    /** 从 virtual:clarify-routes 导入的服务端路由数组 */
-    routes: ServerRouteItem[];
-    /** 从 virtual:clarify-routes 导入的导航树；启用 i18n 时为按 locale 分组的导航树 */
-    navigation?: NavigationTree;
-    /** 从 virtual:clarify-openapi-registry 导入的 OpenAPI 规范表 */
-    openApis?: Record<string, OpenAPISpec>;
-    /** 当前请求的 URL */
-    url: string;
-};
+export type * from './core/types';

package/output/utils/clipboard.d.ts

@@ -0,0 +1 @@
+export declare function copyTextToClipboard(text: string): Promise<boolean>;

package/output/utils/hash.d.ts

@@ -0,0 +1 @@
+export declare function safeDecodeURIComponent(value: string): string;

package/output/utils/href.d.ts

@@ -0,0 +1,5 @@
+import { ClarifyConfig } from '../types';
+export declare function isExternalHref(href: string): boolean;
+export declare function hasLocalePrefix(href: string, config: ClarifyConfig): boolean;
+export declare function localizeHref(href: string, config: ClarifyConfig, locale?: string): string;
+export declare function prefixHref(href: string, routePrefix?: string): string;

package/output/utils/lucide.d.ts

@@ -0,0 +1,17 @@
+import { ComponentType, SVGProps } from 'react';
+export type LucideIconComponent = ComponentType<SVGProps<SVGSVGElement>>;
+/**
+ * Registry of all Lucide icon components keyed by their PascalCase export name.
+ *
+ * Access icons via index lookup (e.g. `lucideIconRegistry[name]`) so React
+ * tooling does not mistake the access for a component created during render.
+ */
+export declare const lucideIconRegistry: Record<string, LucideIconComponent | undefined>;
+/**
+ * Resolve an icon name into the matching Lucide registry key.
+ *
+ * Accepts both the exact PascalCase export name (e.g. `ArrowRight`) and
+ * kebab/space/snake variants (e.g. `arrow-right`), returning `undefined`
+ * when no matching icon exists.
+ */
+export declare function resolveLucideIconName(name: string | undefined): string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clarify-labs/renderer",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "AGPL-3.0-only",
   "type": "module",
   "repository": {
@@ -18,6 +18,18 @@
       "require": "./output/index.cjs",
       "default": "./output/index.js"
     },
+    "./markdown": {
+      "types": "./output/markdown.d.ts",
+      "import": "./output/markdown.js",
+      "require": "./output/markdown.cjs",
+      "default": "./output/markdown.js"
+    },
+    "./preview": {
+      "types": "./output/preview.d.ts",
+      "import": "./output/preview.js",
+      "require": "./output/preview.cjs",
+      "default": "./output/preview.js"
+    },
     "./client": {
       "types": "./output/client.d.ts",
       "import": "./output/client.js",
@@ -51,7 +63,6 @@
   },
   "devDependencies": {
     "@tailwindcss/vite": "^4.1.11",
-    "@types/github-slugger": "^2.0.0",
     "@types/react": "^19.1.8",
     "@types/react-dom": "^19.1.6",
     "@vitejs/plugin-react": "^5.0.5",
@@ -72,6 +83,8 @@
     "github-slugger": "^2.0.0",
     "lucide-react": "^1.20.0",
     "openapi-types": "^12.1.3",
+    "react-markdown": "^10.1.0",
+    "remark-gfm": "^4.0.1",
     "zustand": "^5.0.14"
   }
 }