fumapress 0.5.0 → 0.5.2

package/dist/lib/pathname.js

@@ -0,0 +1,14 @@
+//#region src/lib/pathname.ts
+function joinPathname(...paths) {
+	let combined = paths.join("/").replaceAll(/\/+/g, "/");
+	if (!combined.startsWith("/")) combined = "/" + combined;
+	if (combined.endsWith("/")) combined = combined.slice(0, -1);
+	return combined;
+}
+const PATHNAME_SEGMENT_REGEX = /^[A-Za-z0-9\-._~!$&'()*+,;=:@]+$/;
+/** Check if the string is a full pathname (one that does not include `.` or `..`) */
+function isPlainPathname(s) {
+	return s.startsWith("/") && s.slice(1).split("/").every((seg) => seg !== "." && seg !== ".." && PATHNAME_SEGMENT_REGEX.test(seg));
+}
+//#endregion
+export { isPlainPathname, joinPathname };

package/dist/lib/shared.d.ts

@@ -1,30 +1,28 @@
-import { BuildMode, ConfigContext, Layouts, MetaConfig } from "../config.js";
+import { BaseConfig, BuildMode, ConfigContext, Layouts } from "../config.js";
 import { Adapter, AppContextData, Awaitable, ServerPlugin } from "./types.js";
-import { LoaderOutput } from "fumadocs-core/source";
 import { ReactNode } from "react";
+import { LoaderOutput } from "fumadocs-core/source";
 import { AsyncLocalStorage } from "node:async_hooks";
-import { I18nConfig, SingularTranslationsAPI, TranslationsAPI } from "fumadocs-core/i18n";
-import { Translations } from "fumadocs-ui/i18n";
 //#region src/lib/shared.d.ts
 interface AppContext<C extends ConfigContext = ConfigContext> {
   mode: BuildMode;
-  getLoader: () => Awaitable<LoaderOutput<C["loaderConfig"]>>;
+  getLoader: () => Awaitable<LoaderOutput<C>>;
   plugins: ServerPlugin<C>[];
   adapters: Adapter<C>[];
   layouts: Layouts<C>;
+  /** revalidate [dynamic content sources](https://fumadocs.dev/docs/headless/source-api/source#dynamic-source) */
+  revalidateLoader: (() => Promise<void>) | (C["source"] extends string ? (name: C["source"]) => Promise<void> : never);
+  /** invalidate [dynamic content sources](https://fumadocs.dev/docs/headless/source-api/source#dynamic-source) */
+  invalidateLoader: (() => void) | (C["source"] extends string ? (name: C["source"]) => void : never);
   /** 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"]>;
-  translationsConfig?: TranslationsAPI<C["lang"], {
-    ui: Translations;
-  }> | SingularTranslationsAPI<{
-    ui: Translations;
-  }>;
-  metaConfig?: MetaConfig<C>;
+  translationsConfig?: BaseConfig<C>["translations"];
+  i18nConfig?: C["i18n"];
+  metaConfig?: BaseConfig<C>["meta"];
   siteConfig: {
     name: string;
     baseUrl?: string;
@@ -36,9 +34,6 @@ interface AppContext<C extends ConfigContext = ConfigContext> {
     };
   };
 }
-declare global {
-  var appContextTemp: AppContext | undefined;
-}
 declare function getPressContext<C extends ConfigContext = ConfigContext>(): AppContext<C>;
 type TransformChildren<T> = Omit<T, "children"> & {
   children?: ((nodes: ReactNode) => ReactNode)[];

package/dist/lib/shared.js

@@ -3,63 +3,98 @@ import { getGitRootDir } from "./fs.js";
 import { require_deepmerge } from "../node_modules/.pnpm/@fastify_deepmerge@3.2.1/node_modules/@fastify/deepmerge/index.js";
 import { disableSearchPlugin } from "../plugins/internal/disable-search.js";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { Fragment as Fragment$1, isValidElement } from "react";
 import path from "node:path";
 import { loader } from "fumadocs-core/source";
-import { Fragment as Fragment$1, isValidElement } from "react";
 import { AsyncLocalStorage } from "node:async_hooks";
+import { dynamicLoader } from "fumadocs-core/source/dynamic";
 //#region src/lib/shared.tsx
 var import_deepmerge = /* @__PURE__ */ __toESM(require_deepmerge());
 const appContext = new AsyncLocalStorage({ name: "fumapress:core" });
 function getPressContext() {
-	let store = appContext.getStore();
-	if (!store) store = global.appContextTemp;
-	else delete global.appContextTemp;
+	const store = appContext.getStore();
 	if (!store) throw new Error("[Fumapress] Missing server context for Fumapress, make sure to use the middlewares from createRouter()");
 	return store;
 }
-async function parseConfig(config) {
-	const ORDER = {
-		pre: -1,
-		post: 1,
-		_: 0
-	};
-	let EMPTY;
-	function resolvePlugins(plugins) {
-		const flat = plugins.flat(Infinity);
-		flat.push(disableSearchPlugin());
-		return flat.sort((a, b) => ORDER[a.enforce ?? "_"] - ORDER[b.enforce ?? "_"]);
+const PLUGIN_ORDER = {
+	pre: -1,
+	post: 1,
+	_: 0
+};
+function flattenPlugins(plugins) {
+	const out = [];
+	for (const plugin of plugins) {
+		if (!plugin) continue;
+		if (Array.isArray(plugin)) out.push(...flattenPlugins(plugin));
+		else out.push(plugin);
 	}
-	const layouts = config.getLayouts();
-	return {
+	return out;
+}
+function resolvePlugins(plugins) {
+	return flattenPlugins(plugins).sort((a, b) => PLUGIN_ORDER[a.enforce ?? "_"] - PLUGIN_ORDER[b.enforce ?? "_"]);
+}
+async function initApp(builder) {
+	const config = builder.get();
+	const { translations, site, mode = "default", layouts } = config;
+	const plugins = resolvePlugins([...config.plugins, disableSearchPlugin()]);
+	const ctx = {
+		$context: void 0,
 		getLoader() {
-			if (typeof config.loader === "function") return config.loader();
-			if (config.loader) return config.loader;
-			console.warn("[Fumapress] loader is not specified in your config, is it a mistake?");
-			return EMPTY ??= loader({}, { baseUrl: "/" });
+			throw new Error("[Fumapress] Content loader is not initialized yet, please access it after init()");
 		},
+		revalidateLoader: () => Promise.resolve(void 0),
+		invalidateLoader: () => void 0,
+		i18nConfig: translations && "config" in translations ? translations.config : void 0,
 		layouts: {
 			...layouts,
 			root: layouts.root ?? (await import("../layouts/root.js")).createRootLayout(),
 			page: layouts.page ?? (await import("../layouts/docs.js")).createDocsLayoutPage(),
 			notFound: layouts.notFound ?? (await import("fumadocs-ui/layouts/home/not-found")).DefaultNotFound
 		},
-		plugins: resolvePlugins(config.getPlugins()),
-		adapters: config.getAdapters(),
-		$context: void 0,
+		plugins,
+		adapters: config.adapters,
 		data: {},
-		i18nConfig: config.i18n ?? (config.translations && "config" in config.translations ? config.translations.config : void 0),
-		translationsConfig: config.translations,
-		mode: config.mode ?? "default",
+		translationsConfig: translations,
+		mode,
 		metaConfig: config.meta,
 		siteConfig: {
-			name: config.site?.name ?? "Fumapress",
-			baseUrl: config.site?.baseUrl ?? getDefaultBaseUrl(),
-			git: config.site?.git ? {
-				...config.site.git,
-				rootDir: config.site.git.rootDir ?? getGitRootDir() ?? process.cwd()
+			name: site?.name ?? "Fumapress",
+			baseUrl: site?.baseUrl ?? getDefaultBaseUrl(),
+			git: site?.git ? {
+				...site.git,
+				rootDir: site.git.rootDir ?? getGitRootDir() ?? process.cwd()
 			} : void 0
 		}
 	};
+	if ("loader" in config && config.loader) {
+		ctx.i18nConfig ??= config.loader._i18n;
+		ctx.getLoader = () => config.loader;
+	} else if ("content" in config) ctx.i18nConfig ??= config.i18n;
+	else {
+		console.warn("[Fumapress] loader is not specified in your config, is it a mistake?");
+		const emptyLoader = loader({}, { baseUrl: "/" });
+		ctx.getLoader = () => emptyLoader;
+	}
+	for (const plugin of plugins) await plugin.init?.call(ctx);
+	if ("content" in config) {
+		let loaderOptions = {
+			baseUrl: "/",
+			i18n: ctx.i18nConfig,
+			...config.loaderOptions
+		};
+		for (const plugin of plugins) {
+			if (!plugin.configureLoader) continue;
+			loaderOptions = await plugin.configureLoader.call(ctx, loaderOptions);
+		}
+		const source = dynamicLoader(config.content, loaderOptions);
+		ctx.revalidateLoader = source.revalidate.bind(source);
+		ctx.invalidateLoader = source.invalidate.bind(source);
+		ctx.getLoader = () => {
+			if (config.loaderOptions?.alwaysRevalidate) source.invalidate();
+			return source.get();
+		};
+	}
+	return ctx;
 }
 function getDefaultBaseUrl() {
 	console.warn("[Fumapress] It is recommended to specify \"site.baseUrl\" in your config for better SEO.");
@@ -140,4 +175,4 @@ const mergeLayoutConfigs = (0, import_deepmerge.default)({
 	}
 });
 //#endregion
-export { appContext, baseLayoutProps, createTransformChildren, getCreationDate, getGitHubFileUrl, getLastModifiedDate, getPressContext, mergeLayoutConfigs, parseConfig, renderBody, renderPageMeta, renderRootMeta, renderToc };
+export { appContext, baseLayoutProps, createTransformChildren, getCreationDate, getGitHubFileUrl, getLastModifiedDate, getPressContext, initApp, mergeLayoutConfigs, renderBody, renderPageMeta, renderRootMeta, renderToc };

package/dist/lib/types.d.ts

@@ -3,25 +3,31 @@ import { ConfigContext } from "../config.js";
 import { DocsLayoutContextData } from "../layouts/docs.js";
 import { HomeLayoutContextData } from "../layouts/home.js";
 import { NotebookLayoutContextData } from "../layouts/notebook.js";
-import { Page } from "fumadocs-core/source";
+import { RootLayoutContextData } from "../layouts/root.js";
 import { ReactNode } from "react";
-import { CreateApi, CreateLayout, CreatePage, CreateRoot, CreateSlice } from "waku/router/server";
+import { ContentStorage, LoaderOptions, LoaderPluginOption, Page } from "fumadocs-core/source";
+import { I18nConfig } from "fumadocs-core/i18n";
+import { CreateApi, CreateLayout, CreatePage, CreateRoot, CreateSlice, createPages } from "waku/router/server";
 import { TOCItemType } from "fumadocs-core/toc";
 import { StructuredData } from "fumadocs-core/mdx-plugins";
-import { RootProviderProps } from "fumadocs-ui/provider/base";
 import { MiddlewareHandler } from "hono";
+import { unstable_createServerEntryAdapter } from "waku/adapter-builders";
 
 //#region src/lib/types.d.ts
 type Awaitable<T> = T | Promise<T>;
 /** allow content sources to implement interfaces for pages, instead of requiring consumers to specify manually */
 interface Adapter<C extends ConfigContext = ConfigContext> {
-  "core:get-text"?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<string | undefined>;
-  "core:get-structured-data"?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<StructuredData | undefined>;
-  "core:render-body"?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<ReactNode>;
-  "core:render-toc"?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<TOCItemType[] | undefined>;
-  "core:get-creation-date"?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<Date | undefined>;
-  "core:get-modified-date"?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<Date | undefined>;
-  "blog:get-tags"?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<string[] | undefined>;
+  "core:get-text"?: (this: AppContext<C>, page: C["page"]) => Awaitable<string | undefined>;
+  "core:get-structured-data"?: (this: AppContext<C>, page: C["page"]) => Awaitable<StructuredData | undefined>;
+  "core:render-body"?: (this: AppContext<C>, page: C["page"]) => Awaitable<ReactNode>;
+  "core:render-toc"?: (this: AppContext<C>, page: C["page"]) => Awaitable<TOCItemType[] | undefined>;
+  "core:get-creation-date"?: (this: AppContext<C>, page: C["page"]) => Awaitable<Date | undefined>;
+  "core:get-modified-date"?: (this: AppContext<C>, page: C["page"]) => Awaitable<Date | undefined>;
+  "blog:get-tags"?: (this: AppContext<C>, page: C["page"]) => Awaitable<string[] | undefined>;
+}
+/** make plugins an array for easier modification */
+interface PressLoaderOptions<S extends ContentStorage = ContentStorage, I18n extends I18nConfig | undefined = I18nConfig | undefined> extends Omit<LoaderOptions<S, I18n>, "plugins"> {
+  plugins?: LoaderPluginOption[];
 }
 interface ServerPlugin<C extends ConfigContext = ConfigContext> {
   name?: string;
@@ -37,17 +43,22 @@ interface ServerPlugin<C extends ConfigContext = ConfigContext> {
    * - `false`: render not found (will also exclude from static pre-rendering).
    * - `undefined`: fallback to default.
    */
-  resolvePage?: (this: AppContext<C>, page: C["loaderConfig"]["page"]) => Awaitable<C["loaderConfig"]["page"] | false | undefined>;
+  resolvePage?: (this: AppContext<C>, page: C["page"]) => Awaitable<C["page"] | false | undefined>;
   /**
    * Override the page renderer, use default fallback if `undefined` is returned.
    */
   renderPage?: (this: AppContext<C>, env: {
-    page: C["loaderConfig"]["page"];
+    page: C["page"];
     fallback: ReactNode;
     lang?: string;
     slugs: string[];
   }) => Awaitable<ReactNode>;
-  createMiddlewares?: (this: AppContext<C>) => MiddlewareHandler[] | undefined;
+  /** resolve content loader options */
+  configureLoader?: (this: AppContext<C>, options: PressLoaderOptions) => Awaitable<PressLoaderOptions>;
+  /** create Hono middlewares */
+  createMiddlewares?: (this: AppContext<C>) => Awaitable<MiddlewareHandler[] | undefined>;
+  unstable_onSSGRequest?: <T>(req: Request, next: () => T) => T;
+  unstable_onServerEntry?: (entry: ReturnType<ReturnType<typeof unstable_createServerEntryAdapter>>) => ReturnType<ReturnType<typeof unstable_createServerEntryAdapter>>;
 }
 interface BaseRouteFns {
   createPage: CreatePage;
@@ -56,6 +67,7 @@ interface BaseRouteFns {
   createApi: CreateApi;
   createSlice: CreateSlice;
 }
+type CreatePagesResult = ReturnType<typeof createPages>;
 interface RouteFns extends BaseRouteFns {
   createApiIsomorphic: (config: {
     render: "static" | "dynamic";
@@ -65,15 +77,17 @@ interface RouteFns extends BaseRouteFns {
       params: Record<string, string | string[]>;
     }) => Promise<Response>;
   }) => void;
+  /** access `createPages()` output */
+  unstable_getCreated: () => CreatePagesResult;
 }
-type ServerPluginOption<C extends ConfigContext = ConfigContext> = ServerPlugin<C> | ServerPluginOption<C>[];
+type ServerPluginOption<C extends ConfigContext = ConfigContext> = ServerPlugin<C> | false | undefined | null | ServerPluginOption<C>[];
 /** can be extended from other libraries */
 interface AppContextData {
   "core:page-meta"?: ((page: Page) => ReactNode)[];
   "core:notebook-layout"?: NotebookLayoutContextData;
   "core:docs-layout"?: DocsLayoutContextData;
   "core:home-layout"?: HomeLayoutContextData;
-  "core:provider"?: ((props: RootProviderProps) => Awaitable<RootProviderProps>)[];
+  "core:provider"?: RootLayoutContextData;
 }
 /**
  * For file-system router, route files can export a `getConfig()` function that returns a `RouteConfig` object.
@@ -88,4 +102,4 @@ interface RouteConfig {
   autoI18n?: boolean;
 }
 //#endregion
-export { Adapter, AppContextData, Awaitable, RouteConfig, RouteFns, ServerPlugin, ServerPluginOption };
+export { Adapter, AppContextData, Awaitable, PressLoaderOptions, RouteConfig, RouteFns, ServerPlugin, ServerPluginOption };