fumapress 0.3.1 → 0.5.0

package/css/generated.css

@@ -1,11 +1,14 @@
 @source inline("---spacing");
 @source inline("-translate-x-1/2");
 @source inline("@orama/orama");
+@source inline("a");
 @source inline("absolutePath");
 @source inline("active:scale-95");
+@source inline("allTags");
 @source inline("as");
 @source inline("async");
 @source inline("await");
+@source inline("backToHome");
 @source inline("backdrop-blur-sm");
 @source inline("bg-fd-card");
 @source inline("bg-fd-primary");
@@ -22,12 +25,17 @@
 @source inline("border-y");
 @source inline("bottom-2");
 @source inline("buttonVariants");
+@source inline("can");
 @source inline("children");
 @source inline("class-variance-authority");
 @source inline("className");
 @source inline("client");
 @source inline("cn");
+@source inline("components");
+@source inline("config");
 @source inline("const");
+@source inline("content");
+@source inline("copied");
 @source inline("core:docs-layout");
 @source inline("core:home-layout");
 @source inline("core:notebook-layout");
@@ -39,6 +47,8 @@
 @source inline("createBlogLayoutPage");
 @source inline("createBlogTagPage");
 @source inline("createBlogTagsPage");
+@source inline("createClientAPIPage");
+@source inline("createContext");
 @source inline("createDocsLayoutPage");
 @source inline("createHomeLayout");
 @source inline("createHomeLayoutPage");
@@ -47,16 +57,22 @@
 @source inline("createNotebookLayoutPage");
 @source inline("createRootLayout");
 @source inline("creationDate");
+@source inline("cssUrl");
 @source inline("ctx");
+@source inline("current");
 @source inline("currentDate");
 @source inline("cva");
 @source inline("data");
+@source inline("data-fd-home-layout-container");
 @source inline("data-version");
 @source inline("date");
+@source inline("decoded");
 @source inline("decoration-fd-primary");
 @source inline("default");
+@source inline("defined");
 @source inline("detect");
 @source inline("detector");
+@source inline("do");
 @source inline("duration-150");
 @source inline("else");
 @source inline("empty");
@@ -66,6 +82,7 @@
 @source inline("export");
 @source inline("extends");
 @source inline("false");
+@source inline("find");
 @source inline("fixed");
 @source inline("flex");
 @source inline("flex-1");
@@ -78,13 +95,18 @@
 @source inline("font-semibold");
 @source inline("for");
 @source inline("from");
+@source inline("fumadocs-core/i18n");
 @source inline("fumadocs-core/source");
 @source inline("fumadocs-core/toc");
+@source inline("fumadocs-ui/i18n");
+@source inline("fumapress");
 @source inline("function");
 @source inline("gap-1");
 @source inline("gap-2");
 @source inline("gap-4");
-@source inline("getCreationDate");
+@source inline("getBlogContext");
+@source inline("getLayoutProps");
+@source inline("getPressContext");
 @source inline("getTags");
 @source inline("ghost");
 @source inline("githubUrl");
@@ -93,29 +115,37 @@
 @source inline("grid-cols-2");
 @source inline("groupTags");
 @source inline("grouped");
+@source inline("h-12");
 @source inline("hook");
 @source inline("hooks");
 @source inline("hover:bg-fd-accent");
 @source inline("hover:text-fd-accent-foreground");
 @source inline("href");
 @source inline("i18n");
-@source inline("i18nConfig");
+@source inline("i18nProvider");
 @source inline("if");
 @source inline("import");
 @source inline("in");
+@source inline("indexPath");
 @source inline("inherit");
+@source inline("inheritLayoutProps");
+@source inline("inherited");
 @source inline("inline-flex");
 @source inline("interface");
+@source inline("is");
+@source inline("isBlog");
 @source inline("isLoading");
+@source inline("it");
 @source inline("item");
 @source inline("items");
 @source inline("items-center");
 @source inline("items-start");
 @source inline("joinPathname");
 @source inline("key");
+@source inline("keyof");
+@source inline("label");
 @source inline("lang");
 @source inline("language");
-@source inline("languages");
 @source inline("lastModified");
 @source inline("layout");
 @source inline("layoutData");
@@ -126,10 +156,9 @@
 @source inline("let");
 @source inline("loaderConfig");
 @source inline("locale");
-@source inline("locales");
 @source inline("lucide-react");
 @source inline("markdownUrl");
-@source inline("matching");
+@source inline("matchingBlogPosts");
 @source inline("max-h-[min(600px,calc(100vh---spacing(30)))]");
 @source inline("max-sm:-mx-4");
 @source inline("max-w-[1400px]");
@@ -146,25 +175,26 @@
 @source inline("mt-6");
 @source inline("mt-auto");
 @source inline("mx-auto");
-@source inline("name");
-@source inline("never");
 @source inline("new");
 @source inline("of");
+@source inline("on");
 @source inline("onClick");
 @source inline("onCopy");
 @source inline("onOpenChange");
 @source inline("onSearchChange");
+@source inline("only");
 @source inline("open");
 @source inline("option");
 @source inline("options");
 @source inline("orderedPosts");
+@source inline("outer");
 @source inline("overline");
 @source inline("p-1");
 @source inline("p-4");
 @source inline("page");
 @source inline("pageProps");
 @source inline("panelButtonVariants");
-@source inline("pb-20");
+@source inline("payload");
 @source inline("pb-6");
 @source inline("posts");
 @source inline("primary");
@@ -174,7 +204,6 @@
 @source inline("pt-2");
 @source inline("pt-3.5");
 @source inline("pt-4");
-@source inline("pt-6");
 @source inline("px-1.5");
 @source inline("px-2");
 @source inline("px-3");
@@ -182,12 +211,16 @@
 @source inline("py-0.5");
 @source inline("py-1");
 @source inline("py-2");
+@source inline("py-6");
 @source inline("query");
 @source inline("r");
 @source inline("react");
+@source inline("rel");
 @source inline("render");
 @source inline("renderCtx");
 @source inline("renderRootMeta");
+@source inline("replacements");
+@source inline("resolved");
 @source inline("result");
 @source inline("return");
 @source inline("root");
@@ -196,7 +229,9 @@
 @source inline("rounded-lg");
 @source inline("rounded-xl");
 @source inline("schema");
+@source inline("schemaId");
 @source inline("search");
+@source inline("server");
 @source inline("setOpen");
 @source inline("shadow-inner");
 @source inline("shadow-md");
@@ -210,13 +245,23 @@
 @source inline("sm:grid-cols-3");
 @source inline("sm:max-w-[400px]");
 @source inline("sm:rounded-xl");
+@source inline("so");
 @source inline("source");
 @source inline("specify");
 @source inline("static");
 @source inline("string");
+@source inline("styleTag");
 @source inline("styles");
+@source inline("stylesheet");
+@source inline("sure");
+@source inline("swap");
+@source inline("t");
+@source inline("tag");
+@source inline("tagTitle");
 @source inline("tags");
+@source inline("tagsInTotal");
 @source inline("tagsPath");
+@source inline("text");
 @source inline("text-2xl");
 @source inline("text-3xl");
 @source inline("text-fd-card-foreground");
@@ -227,29 +272,38 @@
 @source inline("text-xs");
 @source inline("the");
 @source inline("this");
+@source inline("throw");
 @source inline("title");
 @source inline("to");
 @source inline("toc");
 @source inline("transition-all");
 @source inline("transition-colors");
 @source inline("transition-transform");
-@source inline("translations");
+@source inline("translated");
+@source inline("translationsConfig");
 @source inline("tree");
+@source inline("true");
 @source inline("truncate");
 @source inline("type");
-@source inline("undefined");
+@source inline("typeof");
 @source inline("unstable_notFound");
 @source inline("url");
 @source inline("use");
 @source inline("useCopyButton");
 @source inline("useDocsSearch");
 @source inline("useI18n");
+@source inline("useMemo");
 @source inline("useState");
 @source inline("useTOCItems");
+@source inline("useTranslations");
+@source inline("useTranslationsBase");
+@source inline("value");
 @source inline("variant");
 @source inline("w-full");
 @source inline("waku");
+@source inline("wrapper");
 @source inline("xl:grid-cols-4");
 @source inline("xl:grid-cols-6");
+@source inline("you");
 @source inline("z-2");
 @source inline("z-20");

package/dist/adapters/mdx/schema.d.ts

@@ -12,6 +12,7 @@ declare const pageSchema: z.ZodObject<{
 declare const metaSchema: z.ZodObject<{
   title: z.ZodOptional<z.ZodString>;
   pages: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  pagesIndex: z.ZodOptional<z.ZodString>;
   description: z.ZodOptional<z.ZodString>;
   root: z.ZodOptional<z.ZodBoolean>;
   defaultOpen: z.ZodOptional<z.ZodBoolean>;
@@ -29,6 +30,7 @@ declare const blogPageSchema: z.ZodObject<{
 declare const blogMetaSchema: z.ZodObject<{
   title: z.ZodOptional<z.ZodString>;
   pages: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  pagesIndex: z.ZodOptional<z.ZodString>;
   description: z.ZodOptional<z.ZodString>;
   root: z.ZodOptional<z.ZodBoolean>;
   defaultOpen: z.ZodOptional<z.ZodBoolean>;

package/dist/client.d.ts

@@ -0,0 +1,56 @@
+import { Unstable_ChangeRouteCallback, Unstable_ChangeRouteEvent } from "waku/router/client";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+import { ComponentProps, ReactNode, TransitionFunction } from "react";
+
+//#region src/client.d.ts
+interface LinkProps extends ComponentProps<"a"> {
+  /**
+   * indicates if the link should scroll or not on navigation
+   * - `true`: always scroll
+   * - `false`: never scroll
+   * - `undefined`: scroll on path/hash change (not on query-only change)
+   */
+  scroll?: boolean;
+  unstable_pending?: ReactNode;
+  unstable_notPending?: ReactNode;
+  unstable_prefetchOnEnter?: boolean;
+  unstable_prefetchOnView?: boolean;
+  unstable_startTransition?: ((fn: TransitionFunction) => void) | undefined;
+  href: string;
+}
+interface Router {
+  push: (to: string, options?: {
+    /**
+     * indicates if the link should scroll or not on navigation
+     * - `true`: always scroll
+     * - `false`: never scroll
+     * - `undefined`: scroll on path/hash change (not on query-only change)
+     */
+    scroll?: boolean;
+  }) => Promise<void>;
+  replace: (to: string, options?: {
+    /**
+     * indicates if the link should scroll or not on navigation
+     * - `true`: always scroll
+     * - `false`: never scroll
+     * - `undefined`: scroll on path/hash change (not on query-only change)
+     */
+    scroll?: boolean;
+  }) => Promise<void>;
+  reload: () => Promise<void>;
+  back: () => void;
+  forward: () => void;
+  prefetch: (to: string) => void;
+  unstable_events: Record<"on" | "off", (event: Unstable_ChangeRouteEvent, handler: Unstable_ChangeRouteCallback) => void>;
+  path: string;
+  query: string;
+  hash: string;
+}
+declare function Link({
+  href,
+  children,
+  ...props
+}: LinkProps): _$react_jsx_runtime0.JSX.Element;
+declare function useRouter(): Router;
+//#endregion
+export { Link, LinkProps, Router, useRouter };

package/dist/client.js

@@ -0,0 +1,16 @@
+"use client";
+import { Link as Link$1, useRouter as useRouter$1 } from "waku/router/client";
+import { jsx } from "react/jsx-runtime";
+//#region src/client.tsx
+function Link({ href, children, ...props }) {
+	return /* @__PURE__ */ jsx(Link$1, {
+		to: href,
+		...props,
+		children
+	});
+}
+function useRouter() {
+	return useRouter$1();
+}
+//#endregion
+export { Link, useRouter };

package/dist/components/blog-panel.js

@@ -1,7 +1,8 @@
 "use client";
 import { cn } from "../lib/cn.js";
-import { useState } from "react";
+import { useTranslations } from "./i18n.js";
 import { jsx, jsxs } from "react/jsx-runtime";
+import { useState } from "react";
 import { ChevronDown, ShareIcon } from "lucide-react";
 import { TOCProvider, TOCScrollArea, useTOCItems } from "fumadocs-ui/components/toc";
 import { TOCItem, TOCItems } from "fumadocs-ui/components/toc/clerk";
@@ -11,6 +12,7 @@ import { useCopyButton } from "fumadocs-ui/utils/use-copy-button";
 //#region src/components/blog-panel.tsx
 const panelButtonVariants = cva("inline-flex items-center font-medium gap-2 px-3 py-2 transition-all duration-150 rounded-lg hover:text-fd-accent-foreground hover:bg-fd-accent active:scale-95");
 function BlogPanel() {
+	const t = useTranslations();
 	const items = useTOCItems();
 	const [open, setOpen] = useState(false);
 	const [isSuccessful, onCopy] = useCopyButton(() => {
@@ -36,12 +38,12 @@ function BlogPanel() {
 				className: cn(panelButtonVariants(), "min-w-0"),
 				children: [/* @__PURE__ */ jsx("span", {
 					className: "truncate",
-					children: "Table of Contents"
+					children: t.tableOfContents
 				}), /* @__PURE__ */ jsx(ChevronDown, { className: cn("size-3.5 shrink-0 text-fd-muted-foreground transition-transform", open && "rotate-180") })]
 			}), /* @__PURE__ */ jsxs("button", {
 				className: cn(panelButtonVariants(), "ms-auto text-fd-muted-foreground"),
 				onClick: onCopy,
-				children: [/* @__PURE__ */ jsx(ShareIcon, { className: "size-3.5 shrink-0" }), isSuccessful ? "Copied" : "Share"]
+				children: [/* @__PURE__ */ jsx(ShareIcon, { className: "size-3.5 shrink-0" }), isSuccessful ? t.copied : t.share]
 			})]
 		})]
 	});

package/dist/components/blog.js

@@ -1,10 +1,12 @@
-import { getCreationDate } from "../lib/shared.js";
+import { getCreationDate, getPressContext } from "../lib/shared.js";
 import { cn } from "../lib/cn.js";
+import { I18nLabel } from "./i18n.js";
 import { joinPathname } from "../lib/join-pathname.js";
-import { Link } from "waku";
+import { getBlogContext } from "../plugins/blog.js";
 import { jsx, jsxs } from "react/jsx-runtime";
-import { buttonVariants } from "fumadocs-ui/components/ui/button";
+import { Link } from "waku";
 import { CornerLeftUpIcon } from "lucide-react";
+import { buttonVariants } from "fumadocs-ui/components/ui/button";
 //#region src/components/blog.tsx
 function BlogItem({ page, date }) {
 	return /* @__PURE__ */ jsxs(Link, {
@@ -26,7 +28,8 @@ function BlogItem({ page, date }) {
 		]
 	});
 }
-async function OrderedBlogGrid({ posts, ctx }) {
+async function OrderedBlogGrid({ posts }) {
+	const ctx = getPressContext();
 	const currentDate = new Date(Date.now());
 	const orderedPosts = [];
 	for (const page of posts) {
@@ -45,15 +48,16 @@ async function OrderedBlogGrid({ posts, ctx }) {
 		}, page.url))
 	});
 }
-function LinkToHome({ lang, blog }) {
-	if (!blog.indexPath) return;
+function LinkToHome({ lang }) {
+	const { indexPath } = getBlogContext();
+	if (!indexPath) return;
 	return /* @__PURE__ */ jsxs(Link, {
-		to: lang ? joinPathname(lang, blog.indexPath) : blog.indexPath,
+		to: lang ? joinPathname(lang, indexPath) : indexPath,
 		className: cn(buttonVariants({
 			variant: "ghost",
 			className: "text-fd-muted-foreground gap-2"
 		})),
-		children: [/* @__PURE__ */ jsx(CornerLeftUpIcon, { className: "size-3.5" }), "Back to Home"]
+		children: [/* @__PURE__ */ jsx(CornerLeftUpIcon, { className: "size-3.5" }), /* @__PURE__ */ jsx(I18nLabel, { label: "backToHome" })]
 	});
 }
 //#endregion

package/dist/components/flexsearch-static.js

@@ -1,9 +1,9 @@
 "use client";
 import { jsx, jsxs } from "react/jsx-runtime";
+import { useI18n } from "fumadocs-ui/contexts/i18n";
 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();

package/dist/components/i18n.js

@@ -0,0 +1,16 @@
+"use client";
+import { defaultTranslations } from "../i18n.js";
+import { renderTranslation } from "fumadocs-core/i18n";
+import { useTranslations } from "fumadocs-ui/contexts/i18n";
+//#region src/components/i18n.tsx
+function useTranslations$1() {
+	return useTranslations("fumapress") ?? defaultTranslations;
+}
+/**
+* Renders a translated string. Use in server components so the label is resolved on the client from the current locale.
+*/
+function I18nLabel({ label, replacements }) {
+	return renderTranslation(useTranslations$1()[label], replacements);
+}
+//#endregion
+export { I18nLabel, useTranslations$1 as useTranslations };

package/dist/components/openapi.js

@@ -0,0 +1,6 @@
+"use client";
+import { createClientAPIPage } from "fumadocs-openapi/ui/create-client";
+//#region src/components/openapi.tsx
+var openapi_default = createClientAPIPage();
+//#endregion
+export { openapi_default as default };

package/dist/components/openapi.payload.js

@@ -0,0 +1,21 @@
+"use client";
+import { jsx } from "react/jsx-runtime";
+import { createContext, use, useMemo } from "react";
+//#region src/components/openapi.payload.tsx
+const Context = createContext(null);
+function PayloadProvider({ payload, children }) {
+	return /* @__PURE__ */ jsx(Context, {
+		value: useMemo(() => JSON.parse(payload), [payload]),
+		children
+	});
+}
+function WithPayload({ schemaId, Comp, props }) {
+	const payload = use(Context)?.[schemaId];
+	if (!payload) throw new Error(`[Fumapress] Failed to find OpenAPI payload for schema "${schemaId}", do you sure it is defined in createOpenAPI()?`);
+	return /* @__PURE__ */ jsx(Comp, {
+		payload,
+		...props
+	});
+}
+//#endregion
+export { PayloadProvider, WithPayload };

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

@@ -1,8 +1,8 @@
 "use client";
 import { jsx, jsxs } from "react/jsx-runtime";
+import { useI18n } from "fumadocs-ui/contexts/i18n";
 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() {

package/dist/config.d.ts

@@ -1,9 +1,9 @@
 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 { Adapter, Awaitable, ServerPluginOption } from "./lib/types.js";
 import { LoaderConfig, LoaderOutput } from "fumadocs-core/source";
-import { I18nConfig } from "fumadocs-core/i18n";
+import { FC, ReactNode } from "react";
+import { I18nConfig, SingularTranslationsAPI, TranslationsAPI } from "fumadocs-core/i18n";
+import { Translations } from "fumadocs-ui/i18n";
 import { BaseLayoutProps } from "fumadocs-ui/layouts/shared";
 
 //#region src/config.d.ts
@@ -20,45 +20,43 @@ interface Config<C extends ConfigContext = ConfigContext> {
    */
   mode?: BuildMode;
   /** the default content loader */
-  loader: LoaderOutput<C["loaderConfig"]> | (() => Awaitable<LoaderOutput<C["loaderConfig"]>>);
+  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?: MetaConfig<C>;
+  /** this is optional if you have defined `translations` */
+  i18n?: I18nConfig<C["lang"]>;
+  translations?: TranslationsAPI<C["lang"], {
+    ui: Translations;
+  }> | SingularTranslationsAPI<{
+    ui: Translations;
+  }>;
+  meta?: MetaConfig<NoInfer<C>>;
 }
 interface Layouts<C extends ConfigContext = ConfigContext> {
-  root: ComponentType<{
+  root: FC<{
     lang?: string;
-    ctx: AppContext<C>;
     children: ReactNode;
-  }>;
-  page: ComponentType<{
+  }> & {
+    $ctx?: C;
+  };
+  page: FC<{
     lang?: string;
     slugs: string[];
-    ctx: AppContext<C>;
     page: C["loaderConfig"]["page"];
-  }>;
-  notFound: ComponentType<{
+  }> & {
+    $ctx?: C;
+  };
+  notFound: FC<{
     lang?: string;
-    ctx: AppContext<C>;
-  }>;
+  }> & {
+    $ctx?: C;
+  };
   /**
-   * Define default props for page layouts, will be merged with current props.
+   * Define default props for all Fumadocs layouts, will be deep-merged with current props.
    */
   defaultProps?: (this: AppContext<C>, env: {
     lang: string | undefined;
   }) => Awaitable<Omit<BaseLayoutProps, "children">>;
 }
-interface I18nConfig$1<Lang extends string = string> extends Pick<I18nConfig<NoInfer<Lang>>, "defaultLanguage" | "fallbackLanguage" | "parser"> {
-  /** locale code -> language info */
-  languages: { [K in Lang]: {
-    displayName: string;
-    translations?: TranslationsOption;
-  } };
-}
 interface MetaConfig<C extends ConfigContext = ConfigContext> {
   /** render meta tags for any pages */
   root?: (this: AppContext<C>) => ReactNode;
@@ -76,14 +74,16 @@ interface SiteConfig {
     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>;
+  /** for type inference only, always `undefined` */
+  $context: C;
+  getPlugins: () => ServerPluginOption<C>[];
+  getLayouts: () => Partial<Layouts<C>>;
+  getAdapters: () => Adapter<C>[];
+  usePlugins: (...plugins: ServerPluginOption<C>[]) => ConfigBuilder<C>;
   useLayouts: (layouts: Partial<Layouts<C>>) => ConfigBuilder<C>;
-  useAdapters: (...adapters: Adapter[]) => ConfigBuilder<C>;
+  /** Add adapter for content sources */
+  useAdapters: (...adapters: Adapter<C>[]) => ConfigBuilder<C>;
 }
 declare function defineConfig<C extends LoaderConfig, L extends string = string>(config: Config<{
   loaderConfig: C;
@@ -92,6 +92,5 @@ declare function defineConfig<C extends LoaderConfig, L extends string = string>
   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, MetaConfig, SiteConfig, defineConfig, defineI18nConfig };
+export { BuildMode, Config, ConfigBuilder, ConfigContext, Layouts, MetaConfig, SiteConfig, defineConfig };