@blaaiz/docs-core 0.5.0 → 0.7.0

package/dist/ui.d.cts

@@ -1,6 +1,6 @@
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { D as DocsConfig, N as Navigation, l as NavPage } from './navigation-CGqFIPlP.cjs';
+import { D as DocsConfig, t as NavbarConfig, N as Navigation, l as NavPage } from './navigation-DvgyWSZ4.cjs';
 
 /**
  * Accordion components — the Mintlify `<Accordion>` and `<AccordionGroup>`.
@@ -297,6 +297,13 @@ interface NavJsonLink {
     readonly text: string;
     readonly url: string;
     readonly icon?: string;
+    /**
+     * Path prefixes this link is active for, when the generator knows the
+     * link's territory better than the URL shows — an API tab whose entry page
+     * lives outside its generated folder. Omitted, the section is derived from
+     * the URL. Ignored on the exact-match links (Home and the docs root).
+     */
+    readonly match?: string | readonly string[];
 }
 /**
  * A rendered top-navigation link, structurally assignable to a fumadocs
@@ -310,13 +317,14 @@ interface DocsNavLink {
     readonly icon: ReactNode;
     readonly active: 'url' | 'nested-url';
     /**
-     * The path this link is active for. Equal to `url` for Home and the docs
-     * root; the section prefix for a section link, so the link stays active on
-     * every page of its section — not only under its click target. Plain
-     * fumadocs link items cannot express this split; a site component that
-     * compares the pathname against `match` can.
+     * The path(s) this link is active for. Equal to `url` for Home and the docs
+     * root; for a section link, the section prefixes — `nav.json`'s own `match`
+     * when the generator emitted one, the URL-derived section otherwise — so the
+     * link stays active on every page of its section, not only under its click
+     * target. Plain fumadocs link items cannot express this split; a site
+     * component that compares the pathname against `match` can.
      */
-    readonly match: string;
+    readonly match: string | readonly string[];
 }
 /**
  * Options for {@link docsNavLinks}.
@@ -331,6 +339,13 @@ interface DocsNavLinksOptions {
     readonly home?: NavJsonLink | false;
     /** The docs base URL, whose link matches exactly rather than nested. */
     readonly baseUrl?: string;
+    /**
+     * Resolves an icon name from `docs.json` to an element. Defaults to the
+     * framework's `docsIcon` set; pass your own to use any icon library the
+     * site installs (return `undefined` for a text-only link). The default
+     * Home entry resolves the name `house` through it.
+     */
+    readonly icon?: (name: string | undefined) => ReactNode;
 }
 /**
  * Map `nav.json` entries to top-navigation links for `HomeLayout` and
@@ -350,6 +365,82 @@ declare function docsNavLinks(links: readonly NavJsonLink[], options?: DocsNavLi
  */
 declare function isDocsNavLinkActive(link: DocsNavLink, pathname: string): boolean;
 
+/**
+ * The section links as fumadocs navbar tabs: the docs pages' second header
+ * row. The notebook layout's navbar tabs render only `title` — a `LayoutTab`'s
+ * `icon` field is silently dropped in that mode — so the icon is folded into
+ * the title node here, once, instead of every site rediscovering it.
+ *
+ * A link whose territory is a page-tree folder binds that folder (`$folder`
+ * activates the tab on the whole subtree); the rest match their exact URLs.
+ *
+ * @packageDocumentation
+ */
+/**
+ * One navbar tab, structurally assignable to a fumadocs `LayoutTab`.
+ *
+ * @public
+ */
+interface DocsLayoutTab<Folder> {
+    /** The tab's label: the link's icon and text. */
+    readonly title: ReactNode;
+    /** The tab's click target. */
+    readonly url: string;
+    /** The page-tree folder the tab activates on, when its territory is one. */
+    readonly $folder?: Folder;
+    /** The exact URLs the tab activates on, when it binds no folder. */
+    readonly urls?: Set<string>;
+}
+/**
+ * Map `nav.json` entries to navbar tabs for `DocsLayout` with
+ * `tabMode="navbar"`.
+ *
+ * @param links - the parsed `content/nav.json`
+ * @param tree - the site's page tree (`source.pageTree`)
+ * @param options - the Home entry, docs base URL, and icon resolver
+ * @returns tabs with icons in their titles and territories bound
+ * @public
+ */
+declare function docsLayoutTabs<Node extends {
+    readonly type: string;
+}>(links: readonly NavJsonLink[], tree: {
+    readonly children: readonly Node[];
+}, options?: DocsNavLinksOptions): DocsLayoutTab<Extract<Node, {
+    readonly type: 'folder';
+}>>[];
+
+/**
+ * The top bar's action cluster: the config's calls to action, and sign-out on
+ * a workspace site. Server-compatible; sign-out is a native form post to the
+ * site's sign-out route, so no client JavaScript is involved. Styled by
+ * `styles/docs.css`.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Props for {@link NavActions}.
+ *
+ * @public
+ */
+interface NavActionsProps {
+    /** The config's `navbar` block: the primary button and the secondary link. */
+    readonly navbar?: NavbarConfig;
+    /** Whether to offer sign-out (a workspace site). */
+    readonly signOut?: boolean;
+    /** The sign-out route. Default `/api/auth/signout`. */
+    readonly signOutAction?: string;
+    /** Leading extras, such as the Ask AI trigger. */
+    readonly children?: ReactNode;
+}
+/**
+ * The action cluster a site mounts at the end of its top bar: optional extras,
+ * the secondary link, sign-out, and the primary button, in that order.
+ *
+ * @param props - the config's navbar block, the sign-out switch, and extras
+ * @public
+ */
+declare function NavActions({ navbar, signOut, signOutAction, children, }: NavActionsProps): react.JSX.Element;
+
 /**
  * A general error screen with per-kind states.
  *
@@ -500,4 +591,4 @@ declare function DocsSidebar({ nav, resolveHref, }: {
     resolveHref?: ResolveHref;
 }): react.JSX.Element;
 
-export { Accordion, AccordionGroup, type ApiOperationSlots, AuthScreen, type AuthScreenProps, Callout, Card, CardGroup, type DocsNavLink, type DocsNavLinksOptions, DocsSidebar, type ErrorKind, type ErrorPreset, ErrorScreen, type ErrorScreenProps, Info, MethodBadge, type NavJsonLink, Note, type ResolveHref, type SidebarBadgeTransformer, type SidebarItem, Step, Steps, Tip, Warning, apiMethodBadges, apiOperationLayout, authErrorMessage, docsIcon, docsNavLinks, errorPreset, isDocsNavLinkActive, mdxComponents };
+export { Accordion, AccordionGroup, type ApiOperationSlots, AuthScreen, type AuthScreenProps, Callout, Card, CardGroup, type DocsLayoutTab, type DocsNavLink, type DocsNavLinksOptions, DocsSidebar, type ErrorKind, type ErrorPreset, ErrorScreen, type ErrorScreenProps, Info, MethodBadge, NavActions, type NavActionsProps, type NavJsonLink, Note, type ResolveHref, type SidebarBadgeTransformer, type SidebarItem, Step, Steps, Tip, Warning, apiMethodBadges, apiOperationLayout, authErrorMessage, docsIcon, docsLayoutTabs, docsNavLinks, errorPreset, isDocsNavLinkActive, mdxComponents };

package/dist/ui.d.ts

@@ -1,6 +1,6 @@
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { D as DocsConfig, N as Navigation, l as NavPage } from './navigation-CGqFIPlP.js';
+import { D as DocsConfig, t as NavbarConfig, N as Navigation, l as NavPage } from './navigation-DvgyWSZ4.js';
 
 /**
  * Accordion components — the Mintlify `<Accordion>` and `<AccordionGroup>`.
@@ -297,6 +297,13 @@ interface NavJsonLink {
     readonly text: string;
     readonly url: string;
     readonly icon?: string;
+    /**
+     * Path prefixes this link is active for, when the generator knows the
+     * link's territory better than the URL shows — an API tab whose entry page
+     * lives outside its generated folder. Omitted, the section is derived from
+     * the URL. Ignored on the exact-match links (Home and the docs root).
+     */
+    readonly match?: string | readonly string[];
 }
 /**
  * A rendered top-navigation link, structurally assignable to a fumadocs
@@ -310,13 +317,14 @@ interface DocsNavLink {
     readonly icon: ReactNode;
     readonly active: 'url' | 'nested-url';
     /**
-     * The path this link is active for. Equal to `url` for Home and the docs
-     * root; the section prefix for a section link, so the link stays active on
-     * every page of its section — not only under its click target. Plain
-     * fumadocs link items cannot express this split; a site component that
-     * compares the pathname against `match` can.
+     * The path(s) this link is active for. Equal to `url` for Home and the docs
+     * root; for a section link, the section prefixes — `nav.json`'s own `match`
+     * when the generator emitted one, the URL-derived section otherwise — so the
+     * link stays active on every page of its section, not only under its click
+     * target. Plain fumadocs link items cannot express this split; a site
+     * component that compares the pathname against `match` can.
      */
-    readonly match: string;
+    readonly match: string | readonly string[];
 }
 /**
  * Options for {@link docsNavLinks}.
@@ -331,6 +339,13 @@ interface DocsNavLinksOptions {
     readonly home?: NavJsonLink | false;
     /** The docs base URL, whose link matches exactly rather than nested. */
     readonly baseUrl?: string;
+    /**
+     * Resolves an icon name from `docs.json` to an element. Defaults to the
+     * framework's `docsIcon` set; pass your own to use any icon library the
+     * site installs (return `undefined` for a text-only link). The default
+     * Home entry resolves the name `house` through it.
+     */
+    readonly icon?: (name: string | undefined) => ReactNode;
 }
 /**
  * Map `nav.json` entries to top-navigation links for `HomeLayout` and
@@ -350,6 +365,82 @@ declare function docsNavLinks(links: readonly NavJsonLink[], options?: DocsNavLi
  */
 declare function isDocsNavLinkActive(link: DocsNavLink, pathname: string): boolean;
 
+/**
+ * The section links as fumadocs navbar tabs: the docs pages' second header
+ * row. The notebook layout's navbar tabs render only `title` — a `LayoutTab`'s
+ * `icon` field is silently dropped in that mode — so the icon is folded into
+ * the title node here, once, instead of every site rediscovering it.
+ *
+ * A link whose territory is a page-tree folder binds that folder (`$folder`
+ * activates the tab on the whole subtree); the rest match their exact URLs.
+ *
+ * @packageDocumentation
+ */
+/**
+ * One navbar tab, structurally assignable to a fumadocs `LayoutTab`.
+ *
+ * @public
+ */
+interface DocsLayoutTab<Folder> {
+    /** The tab's label: the link's icon and text. */
+    readonly title: ReactNode;
+    /** The tab's click target. */
+    readonly url: string;
+    /** The page-tree folder the tab activates on, when its territory is one. */
+    readonly $folder?: Folder;
+    /** The exact URLs the tab activates on, when it binds no folder. */
+    readonly urls?: Set<string>;
+}
+/**
+ * Map `nav.json` entries to navbar tabs for `DocsLayout` with
+ * `tabMode="navbar"`.
+ *
+ * @param links - the parsed `content/nav.json`
+ * @param tree - the site's page tree (`source.pageTree`)
+ * @param options - the Home entry, docs base URL, and icon resolver
+ * @returns tabs with icons in their titles and territories bound
+ * @public
+ */
+declare function docsLayoutTabs<Node extends {
+    readonly type: string;
+}>(links: readonly NavJsonLink[], tree: {
+    readonly children: readonly Node[];
+}, options?: DocsNavLinksOptions): DocsLayoutTab<Extract<Node, {
+    readonly type: 'folder';
+}>>[];
+
+/**
+ * The top bar's action cluster: the config's calls to action, and sign-out on
+ * a workspace site. Server-compatible; sign-out is a native form post to the
+ * site's sign-out route, so no client JavaScript is involved. Styled by
+ * `styles/docs.css`.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Props for {@link NavActions}.
+ *
+ * @public
+ */
+interface NavActionsProps {
+    /** The config's `navbar` block: the primary button and the secondary link. */
+    readonly navbar?: NavbarConfig;
+    /** Whether to offer sign-out (a workspace site). */
+    readonly signOut?: boolean;
+    /** The sign-out route. Default `/api/auth/signout`. */
+    readonly signOutAction?: string;
+    /** Leading extras, such as the Ask AI trigger. */
+    readonly children?: ReactNode;
+}
+/**
+ * The action cluster a site mounts at the end of its top bar: optional extras,
+ * the secondary link, sign-out, and the primary button, in that order.
+ *
+ * @param props - the config's navbar block, the sign-out switch, and extras
+ * @public
+ */
+declare function NavActions({ navbar, signOut, signOutAction, children, }: NavActionsProps): react.JSX.Element;
+
 /**
  * A general error screen with per-kind states.
  *
@@ -500,4 +591,4 @@ declare function DocsSidebar({ nav, resolveHref, }: {
     resolveHref?: ResolveHref;
 }): react.JSX.Element;
 
-export { Accordion, AccordionGroup, type ApiOperationSlots, AuthScreen, type AuthScreenProps, Callout, Card, CardGroup, type DocsNavLink, type DocsNavLinksOptions, DocsSidebar, type ErrorKind, type ErrorPreset, ErrorScreen, type ErrorScreenProps, Info, MethodBadge, type NavJsonLink, Note, type ResolveHref, type SidebarBadgeTransformer, type SidebarItem, Step, Steps, Tip, Warning, apiMethodBadges, apiOperationLayout, authErrorMessage, docsIcon, docsNavLinks, errorPreset, isDocsNavLinkActive, mdxComponents };
+export { Accordion, AccordionGroup, type ApiOperationSlots, AuthScreen, type AuthScreenProps, Callout, Card, CardGroup, type DocsLayoutTab, type DocsNavLink, type DocsNavLinksOptions, DocsSidebar, type ErrorKind, type ErrorPreset, ErrorScreen, type ErrorScreenProps, Info, MethodBadge, NavActions, type NavActionsProps, type NavJsonLink, Note, type ResolveHref, type SidebarBadgeTransformer, type SidebarItem, Step, Steps, Tip, Warning, apiMethodBadges, apiOperationLayout, authErrorMessage, docsIcon, docsLayoutTabs, docsNavLinks, errorPreset, isDocsNavLinkActive, mdxComponents };

package/dist/ui.js

@@ -1,4 +1,4 @@
-import { strokeIcon } from './chunk-ZKOOKLZ3.js';
+import { strokeIcon } from './chunk-6H6OB7YP.js';
 import { jsxs, jsx, Fragment } from 'react/jsx-runtime';
 import { isValidElement, cloneElement } from 'react';
 
@@ -321,7 +321,11 @@ var ICONS = {
   wallet: "wallet",
   key: "key",
   webhook: "webhook",
-  globe: "globe"
+  globe: "globe",
+  user: "user",
+  users: "users",
+  building: "building",
+  clock: "clock"
 };
 var ALIASES = {
   home: "house",
@@ -333,7 +337,14 @@ var ALIASES = {
   "credit-card": "wallet",
   auth: "key",
   lock: "key",
-  world: "globe"
+  world: "globe",
+  people: "users",
+  team: "users",
+  "building-2": "building",
+  office: "building",
+  company: "building",
+  history: "clock",
+  time: "clock"
 };
 function docsIcon(name) {
   if (!name) {
@@ -348,6 +359,7 @@ function docsIcon(name) {
 function docsNavLinks(links, options = {}) {
   const baseUrl = options.baseUrl ?? "/docs";
   const home = options.home ?? { text: "Home", url: "/", icon: "house" };
+  const icon2 = options.icon ?? docsIcon;
   return [
     ...home === false ? [] : [home],
     ...links.filter((link) => home === false || link.url !== home.url)
@@ -356,12 +368,19 @@ function docsNavLinks(links, options = {}) {
     return {
       text: link.text,
       url: link.url,
-      icon: docsIcon(link.icon),
+      icon: icon2(link.icon),
       active: exact ? "url" : "nested-url",
-      match: exact ? link.url : sectionPrefix(link.url, baseUrl)
+      match: exact ? link.url : providedMatch(link.match) ?? sectionPrefix(link.url, baseUrl)
     };
   });
 }
+function providedMatch(match) {
+  if (match === void 0) {
+    return void 0;
+  }
+  const entries = (typeof match === "string" ? [match] : match).filter((entry) => entry !== "");
+  return entries.length === 0 ? void 0 : entries;
+}
 function sectionPrefix(url, baseUrl) {
   if (!url.startsWith(`${baseUrl}/`)) {
     return url;
@@ -370,10 +389,45 @@ function sectionPrefix(url, baseUrl) {
   return segment === "" ? url : `${baseUrl}/${segment}`;
 }
 function isDocsNavLinkActive(link, pathname) {
+  const matches = typeof link.match === "string" ? [link.match] : link.match;
   if (link.active === "url") {
-    return pathname === link.match;
+    return matches.includes(pathname);
   }
-  return pathname === link.match || pathname.startsWith(`${link.match}/`);
+  return matches.some((match) => pathname === match || pathname.startsWith(`${match}/`));
+}
+function docsLayoutTabs(links, tree, options = {}) {
+  const folders = tree.children.filter((node) => node.type === "folder");
+  const entryUrl = (folder) => {
+    const shape = folder;
+    const first = shape.index ?? shape.children?.find((child) => child.type === "page");
+    return first?.url;
+  };
+  return docsNavLinks(links, options).map((link) => {
+    const matches = typeof link.match === "string" ? [link.match] : [...link.match];
+    const prefix = matches[0] ?? link.url;
+    const folder = link.active === "nested-url" ? folders.find((candidate) => entryUrl(candidate)?.startsWith(`${prefix}/`)) : void 0;
+    return {
+      title: link.icon === void 0 ? link.text : /* @__PURE__ */ jsxs(Fragment, { children: [
+        link.icon,
+        link.text
+      ] }),
+      url: link.url,
+      ...folder ? { $folder: folder } : { urls: /* @__PURE__ */ new Set([...matches, link.url]) }
+    };
+  });
+}
+function NavActions({
+  navbar,
+  signOut = false,
+  signOutAction = "/api/auth/signout",
+  children
+}) {
+  return /* @__PURE__ */ jsxs("div", { className: "nav-actions", children: [
+    children,
+    navbar?.secondary ? /* @__PURE__ */ jsx("a", { className: "nav-actions__secondary", href: navbar.secondary.href, children: navbar.secondary.text }) : null,
+    signOut ? /* @__PURE__ */ jsx("form", { method: "post", action: signOutAction, children: /* @__PURE__ */ jsx("button", { type: "submit", className: "nav-actions__signout", children: "Log out" }) }) : null,
+    navbar?.primary ? /* @__PURE__ */ jsx("a", { className: "nav-actions__primary", href: navbar.primary.href, children: navbar.primary.text }) : null
+  ] });
 }
 function icon(name) {
   return strokeIcon(name, { strokeWidth: 1.75 });
@@ -564,6 +618,6 @@ function DocsSidebar({
   ] }, `t-${String(index)}`)) });
 }
 
-export { Accordion, AccordionGroup, AuthScreen, Callout, Card, CardGroup, DocsSidebar, ErrorScreen, Info, MethodBadge, Note, Step, Steps, Tip, Warning, apiMethodBadges, apiOperationLayout, authErrorMessage, docsIcon, docsNavLinks, errorPreset, isDocsNavLinkActive, mdxComponents };
+export { Accordion, AccordionGroup, AuthScreen, Callout, Card, CardGroup, DocsSidebar, ErrorScreen, Info, MethodBadge, NavActions, Note, Step, Steps, Tip, Warning, apiMethodBadges, apiOperationLayout, authErrorMessage, docsIcon, docsLayoutTabs, docsNavLinks, errorPreset, isDocsNavLinkActive, mdxComponents };
 //# sourceMappingURL=ui.js.map
 //# sourceMappingURL=ui.js.map