@clarify-labs/renderer 0.1.0

package/output/runtime/render.d.ts

@@ -0,0 +1,2 @@
+import { RenderOptions } from '../types';
+export declare function render(options: RenderOptions): void;

package/output/runtime/server.d.ts

@@ -0,0 +1,7 @@
+import { ServerRenderOptions } from '../types';
+/**
+ * Clarify 服务端渲染入口。
+ * 由 @clarify-labs/cli 在构建时调用，为每条路由生成 React HTML 片段。
+ * 返回 `div#root` 内部的 HTML，由 Clarify CLI 组装为完整的 HTML 文档。
+ */
+export declare function renderToHTML(options: ServerRenderOptions): string;

package/output/server.cjs

@@ -0,0 +1,34 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_AppShell = require("./AppShell-DBgUlirU.cjs");
+let react = require("react");
+let react_router_dom = require("react-router-dom");
+let react_jsx_runtime = require("react/jsx-runtime");
+let react_dom_server = require("react-dom/server");
+//#region source/runtime/server.tsx
+/**
+* Clarify 服务端渲染入口。
+* 由 @clarify-labs/cli 在构建时调用，为每条路由生成 React HTML 片段。
+* 返回 `div#root` 内部的 HTML，由 Clarify CLI 组装为完整的 HTML 文档。
+*/
+function renderToHTML(options) {
+	const { config, routes, navigation, openApis = {}, url } = options;
+	return (0, react_dom_server.renderToString)(/* @__PURE__ */ (0, react_jsx_runtime.jsx)(react.StrictMode, { children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(react_router_dom.StaticRouter, {
+		basename: config.routePrefix,
+		location: url,
+		children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(require_AppShell.ClarifyConfigContext.Provider, {
+			value: config,
+			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(require_AppShell.OpenApisContext.Provider, {
+				value: openApis,
+				children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(require_AppShell.ThemeProvider, { children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(require_AppShell.AppShell, {
+					config,
+					routes,
+					navigation: navigation ?? []
+				}) })
+			})
+		})
+	}) }));
+}
+//#endregion
+exports.renderToHTML = renderToHTML;
+
+//# sourceMappingURL=server.cjs.map

package/output/server.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.cjs","names":[],"sources":["../source/runtime/server.tsx"],"sourcesContent":["import { StrictMode } from 'react'\nimport { renderToString } from 'react-dom/server'\nimport { StaticRouter } from 'react-router-dom'\n\nimport { AppShell } from '../app/AppShell'\nimport { ThemeProvider } from '../components/ThemeProvider'\nimport { ClarifyConfigContext, OpenApisContext } from '../context'\nimport type { ServerRenderOptions } from '../types'\n\n/**\n * Clarify 服务端渲染入口。\n * 由 @clarify-labs/cli 在构建时调用，为每条路由生成 React HTML 片段。\n * 返回 `div#root` 内部的 HTML，由 Clarify CLI 组装为完整的 HTML 文档。\n */\nexport function renderToHTML(options: ServerRenderOptions): string {\n  const { config, routes, navigation, openApis = {}, url } = options\n\n  return renderToString(\n    <StrictMode>\n      <StaticRouter basename={config.routePrefix} location={url}>\n        <ClarifyConfigContext.Provider value={config}>\n          <OpenApisContext.Provider value={openApis}>\n            <ThemeProvider>\n              <AppShell config={config} routes={routes} navigation={navigation ?? []} />\n            </ThemeProvider>\n          </OpenApisContext.Provider>\n        </ClarifyConfigContext.Provider>\n      </StaticRouter>\n    </StrictMode>\n  )\n}\n"],"mappings":";;;;;;;;;;;;AAcA,SAAgB,aAAa,SAAsC;CACjE,MAAM,EAAE,QAAQ,QAAQ,YAAY,WAAW,CAAC,GAAG,QAAQ;CAE3D,QAAA,GAAA,iBAAA,gBACE,iBAAA,GAAA,kBAAA,KAAC,MAAA,YAAD,EAAA,UACE,iBAAA,GAAA,kBAAA,KAAC,iBAAA,cAAD;EAAc,UAAU,OAAO;EAAa,UAAU;YACpD,iBAAA,GAAA,kBAAA,KAAC,iBAAA,qBAAqB,UAAtB;GAA+B,OAAO;aACpC,iBAAA,GAAA,kBAAA,KAAC,iBAAA,gBAAgB,UAAjB;IAA0B,OAAO;cAC/B,iBAAA,GAAA,kBAAA,KAAC,iBAAA,eAAD,EAAA,UACE,iBAAA,GAAA,kBAAA,KAAC,iBAAA,UAAD;KAAkB;KAAgB;KAAQ,YAAY,cAAc,CAAC;IAAI,CAAA,EAC5D,CAAA;GACS,CAAA;EACG,CAAA;CACnB,CAAA,EACJ,CAAA,CACd;AACF"}

package/output/server.d.ts

@@ -0,0 +1 @@
+export { renderToHTML } from './runtime/server';

package/output/server.js

@@ -0,0 +1,33 @@
+import { m as OpenApisContext, p as ClarifyConfigContext, t as AppShell, u as ThemeProvider } from "./AppShell-C_bj6ZhV.js";
+import { StrictMode } from "react";
+import { StaticRouter } from "react-router-dom";
+import { jsx } from "react/jsx-runtime";
+import { renderToString } from "react-dom/server";
+//#region source/runtime/server.tsx
+/**
+* Clarify 服务端渲染入口。
+* 由 @clarify-labs/cli 在构建时调用，为每条路由生成 React HTML 片段。
+* 返回 `div#root` 内部的 HTML，由 Clarify CLI 组装为完整的 HTML 文档。
+*/
+function renderToHTML(options) {
+	const { config, routes, navigation, openApis = {}, url } = options;
+	return renderToString(/* @__PURE__ */ jsx(StrictMode, { children: /* @__PURE__ */ jsx(StaticRouter, {
+		basename: config.routePrefix,
+		location: url,
+		children: /* @__PURE__ */ jsx(ClarifyConfigContext.Provider, {
+			value: config,
+			children: /* @__PURE__ */ jsx(OpenApisContext.Provider, {
+				value: openApis,
+				children: /* @__PURE__ */ jsx(ThemeProvider, { children: /* @__PURE__ */ jsx(AppShell, {
+					config,
+					routes,
+					navigation: navigation ?? []
+				}) })
+			})
+		})
+	}) }));
+}
+//#endregion
+export { renderToHTML };
+
+//# sourceMappingURL=server.js.map

package/output/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","names":[],"sources":["../source/runtime/server.tsx"],"sourcesContent":["import { StrictMode } from 'react'\nimport { renderToString } from 'react-dom/server'\nimport { StaticRouter } from 'react-router-dom'\n\nimport { AppShell } from '../app/AppShell'\nimport { ThemeProvider } from '../components/ThemeProvider'\nimport { ClarifyConfigContext, OpenApisContext } from '../context'\nimport type { ServerRenderOptions } from '../types'\n\n/**\n * Clarify 服务端渲染入口。\n * 由 @clarify-labs/cli 在构建时调用，为每条路由生成 React HTML 片段。\n * 返回 `div#root` 内部的 HTML，由 Clarify CLI 组装为完整的 HTML 文档。\n */\nexport function renderToHTML(options: ServerRenderOptions): string {\n  const { config, routes, navigation, openApis = {}, url } = options\n\n  return renderToString(\n    <StrictMode>\n      <StaticRouter basename={config.routePrefix} location={url}>\n        <ClarifyConfigContext.Provider value={config}>\n          <OpenApisContext.Provider value={openApis}>\n            <ThemeProvider>\n              <AppShell config={config} routes={routes} navigation={navigation ?? []} />\n            </ThemeProvider>\n          </OpenApisContext.Provider>\n        </ClarifyConfigContext.Provider>\n      </StaticRouter>\n    </StrictMode>\n  )\n}\n"],"mappings":";;;;;;;;;;;AAcA,SAAgB,aAAa,SAAsC;CACjE,MAAM,EAAE,QAAQ,QAAQ,YAAY,WAAW,CAAC,GAAG,QAAQ;CAE3D,OAAO,eACL,oBAAC,YAAD,EAAA,UACE,oBAAC,cAAD;EAAc,UAAU,OAAO;EAAa,UAAU;YACpD,oBAAC,qBAAqB,UAAtB;GAA+B,OAAO;aACpC,oBAAC,gBAAgB,UAAjB;IAA0B,OAAO;cAC/B,oBAAC,eAAD,EAAA,UACE,oBAAC,UAAD;KAAkB;KAAgB;KAAQ,YAAY,cAAc,CAAC;IAAI,CAAA,EAC5D,CAAA;GACS,CAAA;EACG,CAAA;CACnB,CAAA,EACJ,CAAA,CACd;AACF"}

package/output/shell/ContentActions.d.ts

@@ -0,0 +1,7 @@
+import { RouteItem } from '../types';
+type ContentActionsProps = {
+    route?: RouteItem;
+    routePrefix?: string;
+};
+export declare function ContentActions(arg0: ContentActionsProps): import("react").JSX.Element | null;
+export {};

package/output/shell/Header.d.ts

@@ -0,0 +1,8 @@
+import { ClarifyConfig, NavigationNode, RouteItem } from '../types';
+export declare const Header: import('react').ForwardRefExoticComponent<Omit<Omit<import('framer-motion').HTMLMotionProps<"div">, "ref"> & import('react').RefAttributes<HTMLDivElement>, "ref"> & {
+    config: ClarifyConfig;
+    navigation: NavigationNode[];
+    routes: RouteItem[];
+    currentLocale?: string;
+    currentRoute?: RouteItem;
+} & import('react').RefAttributes<HTMLDivElement>>;

package/output/shell/Navigation.d.ts

@@ -0,0 +1,5 @@
+import { NavigationNode } from '../types';
+export declare function Navigation(arg0: {
+    navigation: NavigationNode[];
+    className?: string;
+}): import("react").JSX.Element;

package/output/shell/Search.d.ts

@@ -0,0 +1,10 @@
+import { NavigationNode, RouteItem } from '../types';
+export declare function Search(arg0: {
+    routes: RouteItem[];
+    navigation: NavigationNode[];
+}): import("react").JSX.Element;
+export declare function MobileSearch(arg0: {
+    routes: RouteItem[];
+    navigation: NavigationNode[];
+    onNavigate?: () => void;
+}): import("react").JSX.Element;

package/output/shell/index.d.ts

@@ -0,0 +1,5 @@
+export { ContentActions } from './ContentActions';
+export { Header } from './Header';
+export { MobileNavigation, useIsInsideMobileNavigation, useMobileNavigationStore } from './mobile';
+export { Navigation } from './Navigation';
+export { MobileSearch, Search } from './Search';

package/output/shell/mobile.d.ts

@@ -0,0 +1,15 @@
+import { ClarifyConfig, NavigationNode, RouteItem } from '../types';
+export declare function useIsInsideMobileNavigation(): boolean;
+export declare const useMobileNavigationStore: import('zustand').UseBoundStore<import('zustand').StoreApi<{
+    isOpen: boolean;
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+}>>;
+export declare function MobileNavigation(arg0: {
+    config: ClarifyConfig;
+    navigation: NavigationNode[];
+    routes: RouteItem[];
+    currentLocale?: string;
+    currentRoute?: RouteItem;
+}): import("react").JSX.Element;

package/output/types.d.ts

@@ -0,0 +1,121 @@
+import { ComponentType } from 'react';
+import { OpenAPISpec } from './openapi/utils';
+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;
+    component: ComponentType;
+    kind?: 'mdx' | 'openapi';
+    sections?: RouteSection[];
+    rawContentUrl?: 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 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 ClarifyConfig = {
+    title: string;
+    logo?: ClarifyLogoConfig;
+    favicon?: ClarifyFaviconConfig;
+    theme: {
+        primary?: string;
+    };
+    description: string;
+    rootDirectory: string;
+    routePrefix: string;
+    outputDirectory: string;
+    navbar?: {
+        links?: ClarifyNavbarLink[];
+    };
+    banner?: ClarifyBannerConfig;
+    footer?: ClarifyFooterConfig;
+    i18n?: ClarifyI18nConfig;
+    pages?: ClarifyPagesConfig;
+};
+export type LocalizedNavigation = Record<string, NavigationNode[]>;
+export type NavigationTree = NavigationNode[] | LocalizedNavigation;
+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 ServerRenderOptions = {
+    /** 从 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>;
+    /** 当前请求的 URL */
+    url: string;
+};

package/output/utils/remToPx.d.ts

@@ -0,0 +1 @@
+export declare function remToPx(remValue: number): number;

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@clarify-labs/renderer",
+  "version": "0.1.0",
+  "license": "AGPL-3.0-only",
+  "type": "module",
+  "main": "output/index.cjs",
+  "module": "output/index.js",
+  "types": "output/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./output/index.d.ts",
+      "import": "./output/index.js",
+      "require": "./output/index.cjs",
+      "default": "./output/index.js"
+    },
+    "./client": {
+      "types": "./output/client.d.ts",
+      "import": "./output/client.js",
+      "require": "./output/client.cjs",
+      "default": "./output/client.js"
+    },
+    "./server": {
+      "types": "./output/server.d.ts",
+      "import": "./output/server.js",
+      "require": "./output/server.cjs",
+      "default": "./output/server.js"
+    },
+    "./style.css": "./output/renderer.css",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "LICENSE",
+    "output"
+  ],
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "vite build",
+    "lint": "eslint source/",
+    "lint:fix": "eslint source/ --fix",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-router-dom": "^7.0.0"
+  },
+  "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",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-router-dom": "^7.0.0",
+    "tailwindcss": "^4.1.11",
+    "typescript": "^5.8.3",
+    "vite": "^8.0.15",
+    "vite-plugin-dts": "^4.5.4"
+  },
+  "dependencies": {
+    "@headlessui/react": "^2.2.10",
+    "@tailwindcss/typography": "^0.5.20",
+    "clsx": "^2.1.1",
+    "framer-motion": "^12.40.0",
+    "github-slugger": "^2.0.0",
+    "lucide-react": "^1.20.0",
+    "openapi-types": "^12.1.3",
+    "zustand": "^5.0.14"
+  }
+}