dommief 0.0.0-stage → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,326 @@
+import { z } from 'zod';
+import { R as Route, a as RouteConfig, b as RouteTable, c as ResolvedLocale } from './types-zwMRCGy9.js';
+import { NavItem, SidebarGroup } from './theme-api.js';
+export { d as SiteData } from './types-zwMRCGy9.js';
+
+interface BuildEndContext {
+    config: ResolvedConfig;
+    outDir: string;
+    routes?: Route[];
+}
+type DommiefPluginObject = {
+    name?: string;
+    /** Đồng bộ: hook phải được `tap` xong trước khi hàm trả về. */
+    setup?: (hooks: PluginHookHost) => void;
+    modifyConfig?: (config: unknown) => unknown;
+    modifyRoutes?: (routes: Route[]) => Route[] | void;
+    addRemarkPlugins?: () => unknown | unknown[];
+    addRehypePlugins?: () => unknown | unknown[];
+    addHtmlHeadTags?: () => string | string[] | void;
+    onBuildEnd?: (ctx: BuildEndContext) => void | Promise<void>;
+};
+type PluginSetup = (hooks: PluginHookHost) => void;
+type DommiefPlugin = DommiefPluginObject | PluginSetup;
+declare class Hook<TArg = unknown, TResult = unknown> {
+    name: string;
+    constructor(name?: string);
+    taps: {
+        name: string;
+        fn: (arg: TArg) => TResult | void | Promise<TResult | void>;
+    }[];
+    tap(name: string, fn: (arg: TArg) => TResult | void | Promise<TResult | void>): void;
+    call(arg: TArg): TArg;
+    callAsync(arg: TArg): Promise<TArg>;
+}
+declare class PluginHookHost {
+    modifyConfig: Hook<unknown, unknown>;
+    modifyRoutes: Hook<Route[], Route[]>;
+    addRemarkPlugins: Hook<void, unknown[]>;
+    addRehypePlugins: Hook<void, unknown[]>;
+    addHtmlHeadTags: Hook<void, string | string[]>;
+    onBuildEnd: Hook<BuildEndContext, void>;
+    applyModifyConfig(config: unknown): Record<string, unknown>;
+    applyModifyRoutes(routes: Route[]): Route[];
+    collectRemarkPlugins(): unknown[];
+    collectRehypePlugins(): unknown[];
+    collectHtmlHeadTags(): string[];
+    runBuildEnd(ctx: BuildEndContext): Promise<void>;
+}
+declare function registerPlugin(host: PluginHookHost, plugin: DommiefPlugin | null | undefined): void;
+declare function createPluginHost(plugins?: unknown[]): PluginHookHost;
+declare function definePlugin(plugin: DommiefPlugin): DommiefPlugin;
+
+declare const ConfigSchema: z.ZodObject<{
+    title: z.ZodDefault<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    base: z.ZodDefault<z.ZodString>;
+    outDir: z.ZodDefault<z.ZodString>;
+    srcDir: z.ZodDefault<z.ZodString>;
+    preset: z.ZodDefault<z.ZodEnum<{
+        docs: "docs";
+        library: "library";
+    }>>;
+    docDirs: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        dir: z.ZodString;
+    }, z.core.$strip>]>>>;
+    forceKebabCase: z.ZodDefault<z.ZodBoolean>;
+    locales: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodOptional<z.ZodString>;
+        base: z.ZodOptional<z.ZodString>;
+        suffix: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    themeConfig: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    theme: z.ZodDefault<z.ZodString>;
+    ssg: z.ZodDefault<z.ZodObject<{
+        concurrency: z.ZodDefault<z.ZodNumber>;
+        exclude: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        noEmit: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>>;
+    cache: z.ZodDefault<z.ZodBoolean>;
+    linkCheck: z.ZodDefault<z.ZodBoolean>;
+    dev: z.ZodDefault<z.ZodObject<{
+        port: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strip>>;
+    sitemap: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodObject<{
+        hostname: z.ZodString;
+        exclude: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>]>>;
+    robots: z.ZodOptional<z.ZodBoolean>;
+    markdown: z.ZodDefault<z.ZodObject<{
+        shiki: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodObject<{
+            themes: z.ZodObject<{
+                light: z.ZodString;
+                dark: z.ZodString;
+            }, z.core.$strip>;
+        }, z.core.$strip>]>>;
+        lineNumbers: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    search: z.ZodDefault<z.ZodObject<{
+        enabled: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    plugins: z.ZodDefault<z.ZodArray<z.ZodAny>>;
+}, z.core.$strict>;
+/** What the user writes in dommief.config.ts (input type: optional fields, locale union fields). */
+type UserConfig = z.input<typeof ConfigSchema>;
+interface ResolvedConfig extends RouteConfig {
+    /** Absolute cwd the config was resolved against. */
+    root: string;
+    title: string;
+    description?: string;
+    base: string;
+    outDir: string;
+    themeConfig: Record<string, unknown>;
+    theme: string;
+    ssg: {
+        concurrency: number;
+        exclude: string[];
+        noEmit: string[];
+    };
+    cache: boolean;
+    linkCheck: boolean;
+    dev: {
+        port: number;
+    };
+    sitemap: false | {
+        hostname: string;
+        exclude: string[];
+    };
+    robots: boolean;
+    search: {
+        enabled: boolean;
+    };
+    markdown: {
+        shiki: false | {
+            themes: {
+                light: string;
+                dark: string;
+            };
+        };
+        lineNumbers: boolean;
+    };
+    plugins?: DommiefPlugin[];
+}
+interface ResolveOptions {
+    cwd: string;
+    cli?: {
+        base?: string | undefined;
+        outDir?: string | undefined;
+        cache?: boolean | undefined;
+        linkCheck?: boolean | undefined;
+    };
+    env?: Record<string, string | undefined>;
+    /** Path of the loaded config file; only used to name the source in errors. */
+    configFile?: string | undefined;
+}
+declare function defineConfig(config: UserConfig): UserConfig;
+declare function loadConfigFile(opts: {
+    cwd: string;
+    configPath?: string;
+}): Promise<{
+    path: string;
+    config: UserConfig;
+} | null>;
+declare function resolveConfig(userConfig: UserConfig, opts: ResolveOptions): ResolvedConfig;
+/** Load file at `root` + resolve with process env (and optional CLI flags). */
+declare function loadConfig(root: string, cli?: ResolveOptions['cli']): Promise<ResolvedConfig>;
+
+/** Điểm vào duy nhất của tầng route: scan → normalize → sort → map tra cứu. JSON-safe. */
+declare function buildRouteTable({ cwd, config, hooks, plugins }: {
+    cwd: string;
+    config: RouteConfig;
+    hooks?: PluginHookHost;
+    plugins?: unknown[];
+}): RouteTable;
+
+type FrontmatterMap = Record<string, Record<string, unknown>>;
+declare function buildNav(routes: Route[], frontmatter?: FrontmatterMap, locales?: ResolvedLocale[]): Record<string, NavItem[]>;
+declare function buildSidebar(routes: Route[], frontmatter?: FrontmatterMap, locales?: ResolvedLocale[]): Record<string, SidebarGroup[]>;
+interface PaginationResult {
+    prev?: Route;
+    next?: Route;
+}
+declare function paginate(routes: Route[], currentPath: string): PaginationResult;
+/** @deprecated dùng `parseFrontmatterYaml` (yaml thật). Giữ lại cho tương thích export cũ, cùng chung một parser (#12). */
+declare function parseFrontmatter(fileContent: string): Record<string, unknown>;
+
+interface ShikiOptions {
+    themes: {
+        light: string;
+        dark: string;
+    };
+}
+interface RehypeCodeOptions {
+    /** `false` = tắt Shiki (code block giữ `<pre><code>` thô). */
+    shiki?: ShikiOptions | false;
+    lineNumbers?: boolean;
+}
+
+interface TocItem {
+    id: string;
+    depth: number;
+    title: string;
+}
+interface TextFragment {
+    type?: 'content' | 'title';
+    value: string;
+    paraId?: number;
+    tocIndex?: number;
+}
+interface PageMeta {
+    frontmatter: Record<string, unknown>;
+    toc: TocItem[];
+    texts: TextFragment[];
+}
+interface TransformMarkdownOptions {
+    remarkPlugins?: unknown[];
+    rehypePlugins?: unknown[];
+    hooks?: PluginHookHost;
+    plugins?: unknown[];
+    /** file md tuyệt đối → route; để `rehypeLink` đổi `./x.md` thành path route thật. */
+    byFile?: Record<string, {
+        path: string;
+    }>;
+    /** `config.base` để gắn tiền tố cho link nội bộ. */
+    base?: string;
+    /** `config.markdown` (shiki + lineNumbers), DM-706. */
+    code?: RehypeCodeOptions;
+}
+declare function transformMarkdown(source: string, file: string, opts?: TransformMarkdownOptions): Promise<{
+    code: string;
+    meta: PageMeta;
+    warnings: string[];
+    apiSrcFiles: string[];
+    demos: {
+        id: string;
+        source: string;
+    }[];
+}>;
+
+interface ApiProp {
+    name: string;
+    type?: string;
+    required?: boolean;
+    description?: string;
+    defaultValue?: any;
+}
+interface ApiEntry {
+    displayName: string;
+    description?: string;
+    props: ApiProp[];
+    src: string;
+    hash: string;
+}
+declare function clearApiCache(): void;
+declare function hashFileContent(content: string): string;
+declare function buildApiTable(src: string, filePath?: string): ApiEntry[] | null;
+declare function rehypeApi(): (tree: any, file: any) => void;
+
+declare class DommiefError extends Error {
+    file: string;
+    line?: number | undefined;
+    col?: number | undefined;
+    code?: string | undefined;
+    layout?: string | undefined;
+    constructor(message: string, opts?: {
+        file?: string;
+        line?: number;
+        col?: number;
+        code?: string;
+        layout?: string;
+    });
+    format(): string;
+    toString(): string;
+}
+declare function formatError(err: unknown): string;
+
+interface Logger {
+    verbose: boolean;
+    info(msg: string): void;
+    debug(msg: string): void;
+    warn(msg: string): void;
+    error(msg: string): void;
+}
+declare function createLogger(verbose?: boolean): Logger;
+
+interface MiniSearchConfig {
+    tokenize: (text: string) => string[];
+    processTerm: (term: string) => string | null;
+}
+declare function createMiniSearchConfig(): MiniSearchConfig;
+
+declare const INDEX_BUDGET_BYTES_PER_PAGE: number;
+
+interface SearchDocument {
+    id: string;
+    routeId: string;
+    path: string;
+    pageTitle: string;
+    sectionTitle: string;
+    paraId: number;
+    value: string;
+    pageKey: string;
+    sectionKey: string;
+}
+interface BuildSearchIndexOptions {
+    routes: Route[];
+    loadPageMeta: (route: Route) => PageMeta | Promise<PageMeta>;
+    config: {
+        locales: ResolvedLocale[];
+    };
+}
+interface BuildSearchIndexResult {
+    locales: Record<string, unknown>;
+    stats: Record<string, {
+        docs: number;
+        bytes: number;
+        pages: number;
+    }>;
+    manifest: {
+        locales: Record<string, string>;
+    };
+}
+declare function buildSearchIndex(opts: BuildSearchIndexOptions): Promise<BuildSearchIndexResult>;
+
+export { DommiefError, Hook, INDEX_BUDGET_BYTES_PER_PAGE, PluginHookHost, PluginHookHost as PluginHooks, ResolvedLocale, Route, RouteConfig, RouteTable, buildApiTable, buildNav, buildRouteTable, buildSearchIndex, buildSidebar, clearApiCache, createLogger, createMiniSearchConfig, createPluginHost, defineConfig, definePlugin, formatError, hashFileContent, loadConfig, loadConfigFile, paginate, parseFrontmatter, registerPlugin, rehypeApi, resolveConfig, transformMarkdown };
+export type { ApiEntry, ApiProp, BuildEndContext, BuildSearchIndexOptions, BuildSearchIndexResult, DommiefPlugin, DommiefPluginObject, FrontmatterMap, Logger, MiniSearchConfig, PageMeta, PaginationResult, PluginSetup, ResolvedConfig, SearchDocument, TextFragment, TocItem, UserConfig };