fumapress 0.2.2 → 0.2.4

package/css/generated.css

@@ -0,0 +1,103 @@
+@source inline("@orama/orama");
+@source inline("absolutePath");
+@source inline("adapter");
+@source inline("as");
+@source inline("async");
+@source inline("await");
+@source inline("body");
+@source inline("border-b");
+@source inline("className");
+@source inline("client");
+@source inline("const");
+@source inline("core:docs-layout");
+@source inline("core:home-layout");
+@source inline("core:provider");
+@source inline("core:render-body");
+@source inline("core:render-toc");
+@source inline("create");
+@source inline("createDocsLayout");
+@source inline("createHomeLayout");
+@source inline("createRootLayout");
+@source inline("data");
+@source inline("data-version");
+@source inline("default");
+@source inline("else");
+@source inline("empty");
+@source inline("en");
+@source inline("english");
+@source inline("export");
+@source inline("extends");
+@source inline("flex");
+@source inline("flex-col");
+@source inline("flex-row");
+@source inline("flexsearchStaticClient");
+@source inline("for");
+@source inline("from");
+@source inline("fumadocs-core/source");
+@source inline("fumadocs-core/toc");
+@source inline("function");
+@source inline("gap-2");
+@source inline("githubUrl");
+@source inline("hook");
+@source inline("hooks");
+@source inline("i18n");
+@source inline("i18nConfig");
+@source inline("if");
+@source inline("import");
+@source inline("in");
+@source inline("interface");
+@source inline("isLoading");
+@source inline("items");
+@source inline("items-center");
+@source inline("lang");
+@source inline("language");
+@source inline("languages");
+@source inline("layoutData");
+@source inline("layoutProps");
+@source inline("let");
+@source inline("loaderConfig");
+@source inline("locale");
+@source inline("locales");
+@source inline("markdownUrl");
+@source inline("mb-0");
+@source inline("min-h-screen");
+@source inline("name");
+@source inline("new");
+@source inline("of");
+@source inline("onSearchChange");
+@source inline("option");
+@source inline("page");
+@source inline("pageProps");
+@source inline("pb-6");
+@source inline("providerProps");
+@source inline("pt-2");
+@source inline("query");
+@source inline("r");
+@source inline("react");
+@source inline("render");
+@source inline("renderCtx");
+@source inline("renderPageMeta");
+@source inline("renderRootMeta");
+@source inline("result");
+@source inline("return");
+@source inline("root");
+@source inline("satisfies");
+@source inline("schema");
+@source inline("search");
+@source inline("source");
+@source inline("specify");
+@source inline("static");
+@source inline("string");
+@source inline("styles");
+@source inline("the");
+@source inline("this");
+@source inline("throw");
+@source inline("toc");
+@source inline("translations");
+@source inline("tree");
+@source inline("type");
+@source inline("undefined");
+@source inline("unstable_notFound");
+@source inline("use");
+@source inline("useDocsSearch");
+@source inline("useI18n");

package/dist/adapters/mdx.d.ts

@@ -0,0 +1,12 @@
+import { AppContext } from "../lib/shared.js";
+import { ConfigContext } from "../config.js";
+import { Adapter, Awaitable } from "../lib/types.js";
+import { MDXComponents } from "mdx/types";
+
+//#region src/adapters/mdx.d.ts
+interface MdxAdapterOptions<C extends ConfigContext = ConfigContext> {
+  getMdxComponents?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<MDXComponents>;
+}
+declare function fumadocsMdx<C extends ConfigContext = ConfigContext>(options?: MdxAdapterOptions<C>): Adapter<C>;
+//#endregion
+export { MdxAdapterOptions, fumadocsMdx };

package/dist/adapters/mdx.js

@@ -0,0 +1,37 @@
+import { createElement } from "react";
+import defaultMdxComponents, { createRelativeLink } from "fumadocs-ui/mdx";
+//#region src/adapters/mdx.ts
+function fumadocsMdx(options) {
+	const getMdxComponents = options?.getMdxComponents;
+	return {
+		async "core:get-text"(page) {
+			if (isAsyncEntry(page.data) || isSyncEntry(page.data)) return page.data.getText("processed");
+		},
+		async "core:get-structured-data"(page) {
+			if (isSyncEntry(page.data)) return page.data.structuredData;
+			if (isAsyncEntry(page.data)) return (await page.data.load()).structuredData;
+		},
+		async "core:render-body"(page) {
+			let body;
+			if (isSyncEntry(page.data)) body = page.data.body;
+			else if (isAsyncEntry(page.data)) body = (await page.data.load()).body;
+			else return;
+			return createElement(body, getMdxComponents ? await getMdxComponents.call(this, page) : { components: {
+				...defaultMdxComponents,
+				a: createRelativeLink(await this.getLoader(), page)
+			} });
+		},
+		async "core:render-toc"(page) {
+			if (isSyncEntry(page.data)) return page.data.toc;
+			if (isAsyncEntry(page.data)) return (await page.data.load()).toc;
+		}
+	};
+}
+function isSyncEntry(v) {
+	return "info" in v && typeof v.info === "object" && "_exports" in v && typeof v._exports === "object";
+}
+function isAsyncEntry(v) {
+	return "info" in v && typeof v.info === "object" && "load" in v && typeof v.load === "function";
+}
+//#endregion
+export { fumadocsMdx };

package/dist/components/flexsearch-static.js

@@ -0,0 +1,24 @@
+"use client";
+import { jsx, jsxs } from "react/jsx-runtime";
+import { SearchDialog, SearchDialogClose, SearchDialogContent, SearchDialogHeader, SearchDialogIcon, SearchDialogInput, SearchDialogList, SearchDialogOverlay } from "fumadocs-ui/components/dialog/search";
+import { useDocsSearch } from "fumadocs-core/search/client";
+import { flexsearchStaticClient } from "fumadocs-core/search/client/flexsearch-static";
+import { useI18n } from "fumadocs-ui/contexts/i18n";
+//#region src/components/flexsearch-static.tsx
+function DefaultSearchDialog(props) {
+	const { locale } = useI18n();
+	const { search, setSearch, query } = useDocsSearch({ client: flexsearchStaticClient({ locale }) });
+	return /* @__PURE__ */ jsxs(SearchDialog, {
+		search,
+		onSearchChange: setSearch,
+		isLoading: query.isLoading,
+		...props,
+		children: [/* @__PURE__ */ jsx(SearchDialogOverlay, {}), /* @__PURE__ */ jsxs(SearchDialogContent, { children: [/* @__PURE__ */ jsxs(SearchDialogHeader, { children: [
+			/* @__PURE__ */ jsx(SearchDialogIcon, {}),
+			/* @__PURE__ */ jsx(SearchDialogInput, {}),
+			/* @__PURE__ */ jsx(SearchDialogClose, {})
+		] }), /* @__PURE__ */ jsx(SearchDialogList, { items: query.data !== "empty" ? query.data : null })] })]
+	});
+}
+//#endregion
+export { DefaultSearchDialog as default };

package/dist/components/orama-search-static.js

@@ -0,0 +1,34 @@
+"use client";
+import { jsx, jsxs } from "react/jsx-runtime";
+import { SearchDialog, SearchDialogClose, SearchDialogContent, SearchDialogHeader, SearchDialogIcon, SearchDialogInput, SearchDialogList, SearchDialogOverlay } from "fumadocs-ui/components/dialog/search";
+import { useDocsSearch } from "fumadocs-core/search/client";
+import { useI18n } from "fumadocs-ui/contexts/i18n";
+import { create } from "@orama/orama";
+//#region src/components/orama-search-static.tsx
+function initOrama() {
+	return create({
+		schema: { _: "string" },
+		language: "english"
+	});
+}
+function DefaultSearchDialog(props) {
+	const { locale } = useI18n();
+	const { search, setSearch, query } = useDocsSearch({
+		type: "static",
+		initOrama,
+		locale
+	});
+	return /* @__PURE__ */ jsxs(SearchDialog, {
+		search,
+		onSearchChange: setSearch,
+		isLoading: query.isLoading,
+		...props,
+		children: [/* @__PURE__ */ jsx(SearchDialogOverlay, {}), /* @__PURE__ */ jsxs(SearchDialogContent, { children: [/* @__PURE__ */ jsxs(SearchDialogHeader, { children: [
+			/* @__PURE__ */ jsx(SearchDialogIcon, {}),
+			/* @__PURE__ */ jsx(SearchDialogInput, {}),
+			/* @__PURE__ */ jsx(SearchDialogClose, {})
+		] }), /* @__PURE__ */ jsx(SearchDialogList, { items: query.data !== "empty" ? query.data : null })] })]
+	});
+}
+//#endregion
+export { DefaultSearchDialog as default };

package/dist/config.d.ts

@@ -0,0 +1,84 @@
+import { AppContext } from "./lib/shared.js";
+import { Adapter, Awaitable, ServerPlugin } from "./lib/types.js";
+import { ComponentType, ReactNode } from "react";
+import { TranslationsOption } from "fumadocs-ui/contexts/i18n";
+import { LoaderConfig, LoaderOutput } from "fumadocs-core/source";
+import { I18nConfig } from "fumadocs-core/i18n";
+
+//#region src/config.d.ts
+interface ConfigContext {
+  loaderConfig: LoaderConfig;
+  lang: string;
+}
+type BuildMode = "static" | "dynamic" | "default";
+interface Config<C extends ConfigContext = ConfigContext> {
+  /**
+   * - `static`: always prefer static, including search etc.
+   * - `dynamic`: always prefer dynamic.
+   * - `default`: only certain parts like search routes are dynamic.
+   */
+  mode?: BuildMode;
+  /** the default content loader */
+  loader: LoaderOutput<C["loaderConfig"]> | (() => Awaitable<LoaderOutput<C["loaderConfig"]>>);
+  site?: SiteConfig;
+  layouts?: Partial<Layouts>;
+  plugins?: ServerPlugin[];
+  /** adapter for content sources, use `fumadocs-mdx` if not specified */
+  adapters?: Adapter[];
+  i18n?: I18nConfig$1<C["lang"]>;
+  meta?: {
+    /** render meta tags for any pages */root?: (this: AppContext<C>) => ReactNode; /** render meta tags for page */
+    page?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => ReactNode;
+  };
+}
+interface Layouts<C extends ConfigContext = ConfigContext> {
+  root: ComponentType<AppContext<C> & {
+    lang?: string;
+    children: ReactNode;
+  }>;
+  page: ComponentType<AppContext<C> & {
+    lang?: string;
+    slugs: string[];
+  }>;
+  notFound: ComponentType<AppContext<C> & {
+    lang?: string;
+  }>;
+}
+interface I18nConfig$1<Lang extends string = string> extends Pick<I18nConfig<NoInfer<Lang>>, "fallbackLanguage" | "parser"> {
+  /** locale code -> language info */
+  languages: { [K in Lang]: {
+    displayName: string;
+    translations?: TranslationsOption;
+  } };
+  defaultLanguage: NoInfer<Lang>;
+}
+interface SiteConfig {
+  /** full URL of app, used for metadata generation*/
+  baseUrl?: string;
+  name?: string;
+  git?: {
+    user: string;
+    repo: string;
+    branch: string; /** the root directory of git repo */
+    rootDir?: string;
+  };
+}
+interface I18nConfigBuilder<Lang extends string> extends I18nConfig$1<Lang> {
+  /** convert Fumapress i18n config to core i18n config */
+  toCore: () => I18nConfig<Lang>;
+}
+interface ConfigBuilder<C extends ConfigContext> extends Config<C> {
+  usePlugins: (...plugins: ServerPlugin<C>[]) => ConfigBuilder<C>;
+  useLayouts: (layouts: Partial<Layouts<C>>) => ConfigBuilder<C>;
+  useAdapters: (...adapters: Adapter[]) => ConfigBuilder<C>;
+}
+declare function defineConfig<C extends LoaderConfig, L extends string = string>(config: Config<{
+  loaderConfig: C;
+  lang: L;
+}>): ConfigBuilder<{
+  loaderConfig: C;
+  lang: L;
+}>;
+declare function defineI18nConfig<Lang extends string>(config: I18nConfig$1<Lang>): I18nConfigBuilder<Lang>;
+//#endregion
+export { BuildMode, Config, ConfigBuilder, ConfigContext, I18nConfig$1 as I18nConfig, I18nConfigBuilder, Layouts, SiteConfig, defineConfig, defineI18nConfig };

package/dist/config.js

@@ -0,0 +1,36 @@
+//#region src/config.ts
+function defineConfig(config) {
+	return {
+		...config,
+		useAdapters(...adapters) {
+			this.adapters ??= [];
+			this.adapters.push(...adapters);
+			return this;
+		},
+		useLayouts(layouts) {
+			this.layouts ??= {};
+			Object.assign(this.layouts, layouts);
+			return this;
+		},
+		usePlugins(...plugins) {
+			this.plugins ??= [];
+			this.plugins.push(...plugins);
+			return this;
+		}
+	};
+}
+function defineI18nConfig(config) {
+	return {
+		...config,
+		toCore() {
+			return {
+				defaultLanguage: this.defaultLanguage,
+				fallbackLanguage: this.fallbackLanguage,
+				parser: this.parser,
+				languages: Object.keys(this.languages)
+			};
+		}
+	};
+}
+//#endregion
+export { defineConfig, defineI18nConfig };

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { AppContext, AppContextData } from "./lib/shared.js";
+import { BuildMode, Config, ConfigBuilder, ConfigContext, I18nConfig, I18nConfigBuilder, Layouts, SiteConfig, defineConfig, defineI18nConfig } from "./config.js";
+import { Adapter, ServerPlugin } from "./lib/types.js";
+export { type Adapter, type AppContext, type AppContextData, BuildMode, Config, ConfigBuilder, ConfigContext, I18nConfig, I18nConfigBuilder, Layouts, type ServerPlugin, SiteConfig, defineConfig, defineI18nConfig };

package/dist/index.js

@@ -0,0 +1,2 @@
+import { defineConfig, defineI18nConfig } from "./config.js";
+export { defineConfig, defineI18nConfig };

package/dist/layouts/docs.d.ts

@@ -0,0 +1,35 @@
+import { AppContext } from "../lib/shared.js";
+import { ConfigContext, Layouts } from "../config.js";
+import { Awaitable } from "../lib/types.js";
+import { ReactNode } from "react";
+import { DocsLayoutProps } from "fumadocs-ui/layouts/docs";
+import { DocsPageProps } from "fumadocs-ui/layouts/docs/page";
+import { Page } from "fumadocs-core/source";
+
+//#region src/layouts/docs.d.ts
+interface DocsLayoutOptions<C extends ConfigContext = ConfigContext> {
+  render?: (this: AppContext<C> & {
+    lang?: string;
+  }, page: C["loaderConfig"]["page"]) => Awaitable<{
+    markdownUrl?: string;
+    body?: ReactNode;
+    layoutProps?: Partial<DocsLayoutProps>;
+    pageProps?: DocsPageProps;
+  }>;
+}
+interface DocsLayoutRenderData {
+  markdownUrl?: string;
+  body: ReactNode;
+  layoutProps: DocsLayoutProps;
+  pageProps: DocsPageProps;
+}
+interface DocsLayoutContextData {
+  renderers?: ((this: {
+    page: Page;
+  }, data: DocsLayoutRenderData) => Awaitable<DocsLayoutRenderData>)[];
+}
+declare function createDocsLayout<C extends ConfigContext = ConfigContext>({
+  render
+}?: DocsLayoutOptions<NoInfer<C>>): Layouts<C>["page"];
+//#endregion
+export { DocsLayoutContextData, DocsLayoutOptions, DocsLayoutRenderData, createDocsLayout };

package/dist/layouts/docs.js

@@ -0,0 +1,85 @@
+import { baseOptions, getGitHubFileUrl, renderPageMeta } from "../lib/shared.js";
+import { jsx, jsxs } from "react/jsx-runtime";
+import { unstable_notFound } from "waku/router/server";
+import { DocsLayout } from "fumadocs-ui/layouts/docs";
+import { DocsBody, DocsDescription, DocsPage, DocsTitle, MarkdownCopyButton, ViewOptionsPopover } from "fumadocs-ui/layouts/docs/page";
+//#region src/layouts/docs.tsx
+function createDocsLayout({ render } = {}) {
+	async function defaultRender(page) {
+		let body;
+		let toc;
+		for (const adapter of this.adapters) {
+			body = await adapter["core:render-body"]?.call(this, page);
+			if (body !== void 0) break;
+		}
+		for (const adapter of this.adapters) {
+			toc = await adapter["core:render-toc"]?.call(this, page);
+			if (toc !== void 0) break;
+		}
+		if (body === void 0) throw new Error("[Fumapress] Please specify the `render` option in createDocsLayout()");
+		return {
+			body,
+			pageProps: { toc }
+		};
+	}
+	return async function Layout(props) {
+		const { slugs, lang, getLoader, data: { "core:docs-layout": layoutData } } = props;
+		const source = await getLoader();
+		const page = source.getPage(slugs, lang);
+		if (!page) unstable_notFound();
+		const _raw = await (render ?? defaultRender).call(props, page);
+		let result;
+		if (_raw.body === void 0 || _raw.pageProps === void 0) {
+			const _default = await defaultRender.call(props, page);
+			result = {
+				markdownUrl: _raw.markdownUrl,
+				pageProps: _raw.pageProps ?? _default.pageProps,
+				body: _raw.body ?? _default.body,
+				layoutProps: {
+					tree: source.getPageTree(lang),
+					..._raw.layoutProps ?? baseOptions(props)
+				}
+			};
+		} else result = {
+			body: _raw.body,
+			pageProps: _raw.pageProps,
+			markdownUrl: _raw.markdownUrl,
+			layoutProps: {
+				tree: source.getPageTree(lang),
+				..._raw.layoutProps ?? baseOptions(props)
+			}
+		};
+		if (layoutData?.renderers) {
+			const renderCtx = { page };
+			for (const r of layoutData.renderers) result = await r.call(renderCtx, result);
+		}
+		return /* @__PURE__ */ jsxs(DocsLayout, {
+			...result.layoutProps,
+			children: [
+				renderPageMeta(page, props),
+				result.layoutProps.children,
+				/* @__PURE__ */ jsxs(DocsPage, {
+					...result.pageProps,
+					children: [
+						result.pageProps.children,
+						/* @__PURE__ */ jsx(DocsTitle, { children: page.data.title }),
+						/* @__PURE__ */ jsx(DocsDescription, {
+							className: "mb-0",
+							children: page.data.description
+						}),
+						/* @__PURE__ */ jsxs("div", {
+							className: "flex flex-row gap-2 items-center border-b pt-2 pb-6",
+							children: [result.markdownUrl && /* @__PURE__ */ jsx(MarkdownCopyButton, { markdownUrl: result.markdownUrl }), /* @__PURE__ */ jsx(ViewOptionsPopover, {
+								markdownUrl: result.markdownUrl,
+								githubUrl: page.absolutePath ? getGitHubFileUrl(props, page.absolutePath) : void 0
+							})]
+						}),
+						/* @__PURE__ */ jsx(DocsBody, { children: result.body })
+					]
+				})
+			]
+		});
+	};
+}
+//#endregion
+export { createDocsLayout };

package/dist/layouts/home.d.ts

@@ -0,0 +1,28 @@
+import { AppContext } from "../lib/shared.js";
+import { ConfigContext, Layouts } from "../config.js";
+import { Awaitable } from "../lib/types.js";
+import { ReactNode } from "react";
+import { HomeLayoutProps } from "fumadocs-ui/layouts/home";
+import { Page } from "fumadocs-core/source";
+
+//#region src/layouts/home.d.ts
+interface HomeLayoutOptions<C extends ConfigContext = ConfigContext> {
+  render?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<{
+    body?: ReactNode;
+    layoutProps?: Partial<HomeLayoutProps>;
+  }>;
+}
+interface HomeLayoutRenderData {
+  body: ReactNode;
+  layoutProps: HomeLayoutProps;
+}
+interface HomeLayoutContextData {
+  renderers?: ((this: {
+    page: Page;
+  }, data: HomeLayoutRenderData) => Awaitable<HomeLayoutRenderData>)[];
+}
+declare function createHomeLayout<C extends ConfigContext = ConfigContext>({
+  render
+}: HomeLayoutOptions<NoInfer<C>>): Layouts<C>["page"];
+//#endregion
+export { HomeLayoutContextData, HomeLayoutOptions, HomeLayoutRenderData, createHomeLayout };

package/dist/layouts/home.js

@@ -0,0 +1,34 @@
+import { baseOptions, renderPageMeta } from "../lib/shared.js";
+import { jsxs } from "react/jsx-runtime";
+import { unstable_notFound } from "waku/router/server";
+import { HomeLayout } from "fumadocs-ui/layouts/home";
+//#region src/layouts/home.tsx
+function createHomeLayout({ render }) {
+	async function renderDefault(page) {
+		for (const adapter of this.adapters) {
+			const body = await adapter["core:render-body"]?.call(this, page);
+			if (body !== void 0) return { body };
+		}
+		throw new Error("[Fumapress] Please specify the `render` option in createHomeLayout()");
+	}
+	return async function Layout(props) {
+		const { slugs, lang, getLoader, data: { "core:home-layout": layoutData } } = props;
+		const page = (await getLoader()).getPage(slugs, lang);
+		if (!page) unstable_notFound();
+		const _raw = await (render ?? renderDefault).call(props, page);
+		let result = {
+			body: _raw.body === void 0 ? (await renderDefault.call(props, page)).body : _raw.body,
+			layoutProps: _raw.layoutProps ?? baseOptions(props)
+		};
+		if (layoutData?.renderers) {
+			const renderCtx = { page };
+			for (const r of layoutData.renderers) result = await r.call(renderCtx, result);
+		}
+		return /* @__PURE__ */ jsxs(HomeLayout, {
+			...result.layoutProps,
+			children: [renderPageMeta(page, props), result.body]
+		});
+	};
+}
+//#endregion
+export { createHomeLayout };

package/dist/layouts/root.d.ts

@@ -0,0 +1,10 @@
+import { ConfigContext, Layouts } from "../config.js";
+import { RootProviderProps } from "fumadocs-ui/provider/waku";
+
+//#region src/layouts/root.d.ts
+interface RootLayoutOptions {
+  providerProps?: RootProviderProps;
+}
+declare function createRootLayout<C extends ConfigContext = ConfigContext>(options?: RootLayoutOptions): Layouts<C>["root"];
+//#endregion
+export { RootLayoutOptions, createRootLayout };

package/dist/layouts/root.js

@@ -0,0 +1,38 @@
+import { renderRootMeta } from "../lib/shared.js";
+import { jsx, jsxs } from "react/jsx-runtime";
+import styles from "virtual:root.css?inline";
+import { RootProvider } from "fumadocs-ui/provider/waku";
+//#region src/layouts/root.tsx
+function createRootLayout(options) {
+	return async function(props) {
+		const { children, lang, i18nConfig, data } = props;
+		const hooks = data["core:provider"];
+		let providerProps = { ...options?.providerProps };
+		if (i18nConfig) {
+			const { languages } = i18nConfig;
+			providerProps.i18n ??= {
+				locale: lang,
+				locales: Object.entries(languages).map(([k, v]) => ({
+					name: v.displayName,
+					locale: k
+				})),
+				translations: lang ? languages[lang]?.translations : void 0
+			};
+		}
+		if (hooks) for (const hook of hooks) providerProps = await hook(providerProps);
+		return /* @__PURE__ */ jsxs("html", {
+			lang: lang ?? "en",
+			suppressHydrationWarning: true,
+			children: [/* @__PURE__ */ jsxs("head", { children: [/* @__PURE__ */ jsx("style", { children: styles }), renderRootMeta(props)] }), /* @__PURE__ */ jsx("body", {
+				"data-version": "1.0",
+				className: "flex flex-col min-h-screen",
+				children: /* @__PURE__ */ jsx(RootProvider, {
+					...providerProps,
+					children
+				})
+			})]
+		});
+	};
+}
+//#endregion
+export { createRootLayout };

package/dist/lib/fs.js

@@ -0,0 +1,18 @@
+import { existsSync } from "node:fs";
+import { dirname, join } from "node:path";
+//#region src/lib/fs.ts
+/**
+* Returns the absolute path to the root directory of the current git repository.
+*/
+function getGitRootDir(startDir = process.cwd()) {
+	let dir = startDir;
+	while (true) {
+		if (existsSync(join(dir, ".git"))) return dir;
+		const parent = dirname(dir);
+		if (parent === dir) break;
+		dir = parent;
+	}
+	return null;
+}
+//#endregion
+export { getGitRootDir };

package/dist/lib/shared.d.ts

@@ -0,0 +1,41 @@
+import { DocsLayoutContextData } from "../layouts/docs.js";
+import { HomeLayoutContextData } from "../layouts/home.js";
+import { BuildMode, Config, ConfigContext, I18nConfig } from "../config.js";
+import { Adapter, Awaitable, ServerPlugin } from "./types.js";
+import { ReactNode } from "react";
+import { RootProviderProps } from "fumadocs-ui/provider/waku";
+import { LoaderOutput, Page } from "fumadocs-core/source";
+
+//#region src/lib/shared.d.ts
+interface AppContext<C extends ConfigContext = ConfigContext> {
+  mode: BuildMode;
+  getLoader: () => Awaitable<LoaderOutput<C["loaderConfig"]>>;
+  plugins: ServerPlugin<C>[];
+  adapters: Adapter<C>[];
+  /** always `undefined`, easier way to infer types */
+  $context: C;
+  /**
+   * custom data in app context, can be referenced from plugins/pages etc
+   */
+  data: AppContextData & Record<string, unknown>;
+  i18nConfig?: I18nConfig<C["lang"]>;
+  metaConfig?: Config<C>["meta"];
+  siteConfig: {
+    name: string;
+    baseUrl?: string;
+    git?: {
+      user: string;
+      repo: string;
+      branch: string;
+      rootDir: string;
+    };
+  };
+}
+interface AppContextData {
+  "core:page-meta"?: ((page: Page) => ReactNode)[];
+  "core:docs-layout"?: DocsLayoutContextData;
+  "core:home-layout"?: HomeLayoutContextData;
+  "core:provider"?: ((props: RootProviderProps) => Awaitable<RootProviderProps>)[];
+}
+//#endregion
+export { AppContext, AppContextData };