@clarify-labs/cli 0.7.2 → 0.8.0

package/output/core/env-types.d.ts

@@ -0,0 +1,8 @@
+import { ClarifyPlugin } from '../types.js';
+export declare function generateClarifyEnvDts(_plugins: ClarifyPlugin[]): string;
+/**
+ * Writes `clarify-env.d.ts` into the project root. Only rewrites when content
+ * changes to avoid triggering unnecessary file watchers, and never overwrites a
+ * user-authored file that does not carry the generated marker.
+ */
+export declare function writeClarifyEnvDts(projectRoot: string, plugins: ClarifyPlugin[]): void;

package/output/core/hooks.d.ts

@@ -1,5 +1,6 @@
 import { ViteDevServer } from 'vite';
-import { ClarifyHookContext, ClarifyHooks, ClarifyPlugin } from '../types.js';
-export declare function runHooks<K extends Exclude<keyof ClarifyHooks, 'build:done' | 'dev:configureServer'>>(plugins: ClarifyPlugin[], hookName: K, input: Parameters<NonNullable<ClarifyHooks[K]>>[0], ctx: ClarifyHookContext): Promise<Parameters<NonNullable<ClarifyHooks[K]>>[0]>;
+import { ClarifyEmitAsset, ClarifyHookContext, ClarifyHooks, ClarifyPlugin } from '../types.js';
+export declare function runHooks<K extends Exclude<keyof ClarifyHooks, 'build:assets' | 'build:done' | 'dev:configureServer'>>(plugins: ClarifyPlugin[], hookName: K, input: Parameters<NonNullable<ClarifyHooks[K]>>[0], ctx: ClarifyHookContext): Promise<Parameters<NonNullable<ClarifyHooks[K]>>[0]>;
 export declare function runDevConfigureServerHooks(plugins: ClarifyPlugin[], server: ViteDevServer, ctx: ClarifyHookContext): Promise<void>;
+export declare function runBuildAssetsHooks(plugins: ClarifyPlugin[], ctx: ClarifyHookContext): Promise<ClarifyEmitAsset[]>;
 export declare function runBuildDoneHooks(plugins: ClarifyPlugin[], ctx: ClarifyHookContext): Promise<void>;

package/output/core/plugin.d.ts

@@ -1,4 +1,3 @@
 import { Plugin } from 'vite';
 import { ClarifyBuildOptions } from './options.js';
 export declare function clarifyPlugin(options?: ClarifyBuildOptions): Plugin[];
-export type { Plugin } from 'vite';

package/output/core/ssg.d.ts

@@ -4,7 +4,7 @@ export declare function readIndexHtml(outputDirectory: string): string | undefin
 export declare function injectSSRIntoTemplate(template: string, appHtml: string, projectConfig: ResolvedProjectConfig, route?: ContentRoute): string;
 export declare function isNotFoundRoute(route: ContentRoute): boolean;
 export declare function routeOutputFiles(outputDirectory: string, route: ContentRoute): string[];
-export declare const SSR_ENTRY_CODE = "import { renderToHTML } from '@clarify-labs/renderer/server';\nimport { routes, navigation } from 'virtual:clarify-routes/server';\nimport { config } from 'virtual:clarify-config';\nimport { openApis, bannerComponent, footerComponent } from 'virtual:clarify-runtime';\n\nexport function render(url) {\n  return renderToHTML({ config, routes, navigation, openApis, bannerComponent, footerComponent, url, themeEditor: config.theme.editor });\n}";
+export declare const SSR_ENTRY_CODE = "import { renderToHTML } from '@clarify-labs/renderer/server';\nimport { routes, navigation } from 'virtual:clarify/routes/server';\nimport { config } from 'virtual:clarify/config';\nimport { openApis } from 'virtual:clarify/openapi';\nimport { runtimeSlots } from 'virtual:clarify/slots';\n\nexport async function render(url) {\n  // Pre-resolve every slot component factory so renderToString can use\n  // them synchronously (renderToString has no Suspense support).\n  const entries = Object.values(runtimeSlots).flat()\n  await Promise.all(entries.map(async (entry) => {\n    const mod = await entry.component()\n    entry._resolved = mod.default\n  }))\n  return renderToHTML({ config, routes, navigation, openApis, runtimeSlots, url, themeEditor: config.theme.editor });\n}";
 export declare function createTempEntryFile(content: string): string;
 export declare function buildSSRBundle(root: string, ssrEntry: string, ssrOutDir: string, plugins: Plugin[]): Promise<void>;
 export declare function renderSSGRoutes(routes: ContentRoute[], projectConfig: ResolvedProjectConfig, outputDirectory: string, ssrBundlePath: string, failOnError?: boolean): Promise<void>;

package/output/core/virtual-modules.d.ts

@@ -1,25 +1,19 @@
-import { ContentRoute, NavigationTree, ResolvedBuildOptions, ResolvedProjectConfig } from '../types.js';
-export declare const VIRTUAL_CONFIG = "virtual:clarify-config";
-export declare const VIRTUAL_ROUTES = "virtual:clarify-routes";
-export declare const VIRTUAL_SERVER_ROUTES = "virtual:clarify-routes/server";
-export declare const VIRTUAL_RUNTIME = "virtual:clarify-runtime";
-export declare const VIRTUAL_CLIENT_ENTRY = "virtual:clarify-entry-client";
+import { ClarifyPlugin, ContentRoute, NavigationTree, ResolvedBuildOptions, ResolvedProjectConfig } from '../types.js';
+export declare const VIRTUAL_CONFIG = "virtual:clarify/config";
+export declare const VIRTUAL_ROUTES = "virtual:clarify/routes";
+export declare const VIRTUAL_SERVER_ROUTES = "virtual:clarify/routes/server";
+export declare const VIRTUAL_OPENAPI = "virtual:clarify/openapi";
+export declare const VIRTUAL_SLOTS = "virtual:clarify/slots";
+export declare const VIRTUAL_SLOT = "virtual:clarify/slot";
+export declare const VIRTUAL_CLIENT_ENTRY = "virtual:clarify/entry-client";
 export declare const RESOLVED_CLIENT_ENTRY: string;
 export type VirtualModules = Map<string, string>;
-type RuntimeImports = {
-    bannerComponent?: string;
-    footerComponent?: string;
-};
-type RuntimeModuleOptions = {
-    imports?: RuntimeImports;
-    bannerComponentSource?: 'path';
-    footerComponentSource?: 'path';
-};
 type BuildVirtualModulesArgs = {
     projectConfig: ResolvedProjectConfig;
     generateOptions: ResolvedBuildOptions;
     routes: ContentRoute[];
     navigation?: NavigationTree;
+    plugins?: ClarifyPlugin[];
     themeEditor?: boolean;
 };
 type CreateClientEntryModuleOptions = {
@@ -29,7 +23,26 @@ export declare function resolveVirtualId(id: string): string;
 export declare function stripVirtualPrefix(id: string): string;
 export declare function generateConfigModule(projectConfig: ResolvedProjectConfig, buildOptions: ResolvedBuildOptions): string;
 export declare function generateRoutesModule(routes: ContentRoute[], resolvedNavigation?: NavigationTree, projectConfig?: ResolvedProjectConfig, mode?: 'client' | 'server'): string;
-export declare function createRuntimeModule(options?: RuntimeModuleOptions): string;
 export declare function createClientEntryModule(options?: CreateClientEntryModuleOptions): string;
+/**
+ * Collect every plugin's `slots` declarations into a single runtime registry
+ * module. Component modules are exported as lazy import factories so the
+ * renderer can decide whether to code-split (client) or pre-resolve (SSR).
+ *
+ * Relative component paths are resolved against the project `root` so that
+ * the generated `import()` call uses an absolute specifier — Vite cannot
+ * resolve relative imports from virtual modules.
+ *
+ * Slot name validity is enforced at compile time by the `UISlotName`
+ * type — no runtime validation is needed.
+ */
+export declare function createRuntimeSlotsModule(plugins?: ClarifyPlugin[], root?: string): string;
+/**
+ * Re-exports the slot context hook from the renderer so plugin components can
+ * `import { useSlot } from 'virtual:clarify/slot'` without depending on
+ * renderer internals directly.
+ */
+export declare function createSlotModule(): string;
 export declare function buildVirtualModules(args: BuildVirtualModulesArgs): VirtualModules;
+export declare function generateOpenApiModule(): string;
 export {};

package/output/index.cjs

@@ -1,4 +1,4 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_plugin = require("./plugin-DFpkIm9j.cjs");
+const require_plugin = require("./plugin-B7c0iHMy.cjs");
 exports.clarifyPlugin = require_plugin.clarifyPlugin;
 exports.defineConfig = require_plugin.defineConfig;

package/output/index.d.ts

@@ -3,3 +3,4 @@ export { defineConfig } from './core/user-config.js';
 export type { Plugin } from 'vite';
 export * from './types.js';
 export type { ClarifyConfig } from './core/user-config.js';
+export type { UISlotName, SlotContext, UISlotRegistration } from '@clarify-labs/renderer';

package/output/index.js

@@ -1,2 +1,2 @@
-import { n as defineConfig, t as clarifyPlugin } from "./plugin-o1rP_gts.js";
+import { n as defineConfig, t as clarifyPlugin } from "./plugin-CcD5HeTN.js";
 export { clarifyPlugin, defineConfig };

package/output/parsers/routes.d.ts

@@ -1,4 +1,5 @@
 import { ContentRoute, ContentSection, ClarifyNavigationNode, ClarifyPagesConfig, ClarifyPagesGroup, ClarifyLocalizedText, ClarifyTabsConfig, LocalizedNavigation, LocalizedTabbedNavigation, ResolvedClarifyI18nConfig, TabbedNavigation } from '../types.js';
+export declare function kebabToTitle(str: string): string;
 /** 从 MDX/Markdown 内容中提取 H2/H3 章节 */
 export declare function extractMdxSections(content: string): ContentSection[];
 export declare function normalizePath(path: string): string;
@@ -7,9 +8,10 @@ export declare function basePathFromRef(ref: string): string;
 export declare function openAPIPagePathFromRef(ref: string, tagFilter?: string[], explicitPath?: string): string;
 export declare function routePathFromRef(ref: string, explicitPath?: string): string;
 export declare function virtualModuleIdFromRef(ref: string): string;
-export declare function localizedRoutePath(basePath: string, locale: string, i18n: ResolvedClarifyI18nConfig): string;
+export declare function localizedRoutePath(basePath: string, locale: string, _i18n: ResolvedClarifyI18nConfig): string;
 export declare function resolveLocalizedText(text: ClarifyLocalizedText | undefined, locale: string, fallbackLocale?: string): string | undefined;
 export declare function findContentRoutes(dir: string, base?: string): ContentRoute[];
+export declare function withAlternates(route: ContentRoute, routes: ContentRoute[], i18n: ResolvedClarifyI18nConfig): ContentRoute;
 export declare function findLocalizedContentRoutes(contentRoot: string, i18n?: ResolvedClarifyI18nConfig): ContentRoute[];
 export declare function buildNavigation(routes: ContentRoute[]): ClarifyNavigationNode[];
 export declare function applyConfiguredPageRoutePaths(routes: ContentRoute[], tabs?: ClarifyTabsConfig, i18n?: ResolvedClarifyI18nConfig): ContentRoute[];