zudoku 0.3.0-dev.86 → 0.3.0-dev.87

package/lib/zudoku.plugin-api-keys.js

@@ -1,9 +1,9 @@
 import { j as e } from "./jsx-runtime-B6kdoens.js";
 import { a as p, R as f } from "./SlotletProvider-CzMAO73_.js";
-import { u as g, a as u, I as j, S as v, b as k, c as w, d as b, e as K, f as y } from "./Input-BclXSY0g.js";
+import { u as g, a as u, I as j, S as v, b as k, c as w, d as b, e as K, f as y } from "./Input-LkQSHT1l.js";
 import { b as N, L as x, O as E } from "./index-7kcHaXD6.js";
-import { u as h, q as A, t as S } from "./DevPortalProvider-CTxoCHIT.js";
-import { B as l, p as I } from "./Combination-DkycFHkm.js";
+import { u as h, q as A, t as S } from "./DevPortalProvider-D6Tr_uD_.js";
+import { B as l, p as I } from "./Combination-BOiWt0Ng.js";
 import { D as P } from "./DeveloperHint-BQSFXH01.js";
 import { useState as D } from "react";
 import { c as d, a as q } from "./Markdown-B_Gax7at.js";

package/lib/zudoku.plugin-markdown.js

@@ -6,7 +6,7 @@ const u = (t, e) => Object.entries(t).flatMap(([a, r]) => {
   return {
     path: s.at(-1) === "index" ? s.slice(0, -1).join("/") : o,
     lazy: async () => {
-      const { MdxPage: i } = await import("./MdxPage-Crlr0GmN.js"), { default: p, ...c } = await r();
+      const { MdxPage: i } = await import("./MdxPage-PhgXcrKE.js"), { default: p, ...c } = await r();
       return {
         element: /* @__PURE__ */ m.jsx(
           i,

package/lib/zudoku.plugin-openapi.js

@@ -1,9 +1,9 @@
 import "./jsx-runtime-B6kdoens.js";
-import { o as l } from "./index-DUrF63A6.js";
+import { o as l } from "./index-BuVwhb9F.js";
 import "./urql-DrBfkb92.js";
-import "./DevPortalProvider-CTxoCHIT.js";
+import "./DevPortalProvider-D6Tr_uD_.js";
 import "zudoku/openapi-worker";
-import "./Combination-DkycFHkm.js";
+import "./Combination-BOiWt0Ng.js";
 import "./Markdown-B_Gax7at.js";
 import "./joinPath-VeNuJa7y.js";
 import "./router-BiRCp01d.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zudoku",
-  "version": "0.3.0-dev.86",
+  "version": "0.3.0-dev.87",
   "type": "module",
   "files": [
     "dist",

package/src/lib/components/context/DevPortalProvider.ts

@@ -38,14 +38,14 @@ export const useTopNavigationItem = () => {
 };
 
 export const useNavigation = () => {
-  const { getPluginNavigation, sidebars } = useDevPortal();
+  const { getPluginSidebar, sidebars } = useDevPortal();
   const navItem = useTopNavigationItem();
   const path = navItem?.id;
   const currentSidebar = path ? sidebars[path] ?? [] : [];
 
   return useSuspenseQuery({
     queryFn: async () => {
-      const pluginSidebar = path ? await getPluginNavigation(path) : [];
+      const pluginSidebar = path ? await getPluginSidebar(path) : [];
 
       return {
         items: [...currentSidebar, ...pluginSidebar],

package/src/lib/components/navigation/SidebarCategory.tsx

@@ -2,7 +2,7 @@ import * as Collapsible from "@radix-ui/react-collapsible";
 import { ChevronRightIcon } from "lucide-react";
 import { useEffect, useState } from "react";
 import { NavLink } from "react-router-dom";
-import type { ResolvedSidebarItemCategory } from "../../../config/validators/ResolvedSidebarSchema.js";
+import type { SidebarItemCategory } from "../../../config/validators/SidebarSchema.js";
 import { cn } from "../../util/cn.js";
 import { joinPath } from "../../util/joinPath.js";
 import { useTopNavigationItem } from "../context/DevPortalProvider.js";
@@ -13,7 +13,7 @@ export const SidebarCategory = ({
   category,
   level,
 }: {
-  category: ResolvedSidebarItemCategory;
+  category: SidebarItemCategory;
   level: number;
 }) => {
   const topNavItem = useTopNavigationItem();

package/src/lib/components/navigation/SidebarItem.tsx

@@ -2,7 +2,7 @@ import { cva } from "class-variance-authority";
 import { ExternalLinkIcon } from "lucide-react";
 import { NavLink } from "react-router-dom";
 
-import type { ResolvedSidebarItem } from "../../../config/validators/ResolvedSidebarSchema.js";
+import type { SidebarItem as SidebarItemType } from "../../../config/validators/SidebarSchema.js";
 import { cn } from "../../util/cn.js";
 import { joinPath } from "../../util/joinPath.js";
 import { AnchorLink } from "../AnchorLink.js";
@@ -36,7 +36,7 @@ export const SidebarItem = ({
   item,
   level = 0,
 }: {
-  item: ResolvedSidebarItem;
+  item: SidebarItemType;
   basePath?: string;
   level?: number;
 }) => {
@@ -74,7 +74,7 @@ export const SidebarItem = ({
           {item.label}
           {item.badge && <SidebarBadge {...item.badge} />}
         </AnchorLink>
-      ) : (
+      ) : item.href.startsWith("http") ? (
         <a
           className={cn(
             navigationListItem({ isTopLevel: level === 0 }),
@@ -91,6 +91,10 @@ export const SidebarItem = ({
             <ExternalLinkIcon className="inline ml-1" size={12} />
           </span>
         </a>
+      ) : (
+        <NavLink className={cn(navigationListItem({}), "block")} to={item.href}>
+          {item.label}
+        </NavLink>
       );
   }
 };

package/src/lib/components/navigation/utils.ts

@@ -1,8 +1,8 @@
 import { useLocation } from "react-router-dom";
 import type {
-  ResolvedSidebarItem,
-  ResolvedSidebarItemCategory,
-} from "../../../config/validators/ResolvedSidebarSchema.js";
+  SidebarItem,
+  SidebarItemCategory,
+} from "../../../config/validators/SidebarSchema.js";
 import { joinPath } from "../../util/joinPath.js";
 import {
   useDevPortal,
@@ -10,12 +10,12 @@ import {
 } from "../context/DevPortalProvider.js";
 
 export type TraverseCallback<T> = (
-  item: ResolvedSidebarItem,
-  parentCategories: ResolvedSidebarItem[],
+  item: SidebarItem,
+  parentCategories: SidebarItem[],
 ) => T | void;
 
 export const traverseSidebar = <T>(
-  sidebar: ResolvedSidebarItem[],
+  sidebar: SidebarItem[],
   callback: TraverseCallback<T>,
 ): T | undefined => {
   for (const item of sidebar) {
@@ -25,9 +25,9 @@ export const traverseSidebar = <T>(
 };
 
 export const traverseSidebarItem = <T>(
-  item: ResolvedSidebarItem,
+  item: SidebarItem,
   callback: TraverseCallback<T>,
-  parentCategories: ResolvedSidebarItem[] = [],
+  parentCategories: SidebarItem[] = [],
 ): T | undefined => {
   const result = callback(item, parentCategories);
   if (result !== undefined) return result;
@@ -59,7 +59,7 @@ export const useCurrentItem = () => {
   });
 };
 
-export const useIsCategoryOpen = (category: ResolvedSidebarItemCategory) => {
+export const useIsCategoryOpen = (category: SidebarItemCategory) => {
   const location = useLocation();
   const topNavItem = useTopNavigationItem();
 

package/src/lib/core/DevPortalContext.ts

@@ -1,6 +1,6 @@
 import { QueryClient } from "@tanstack/react-query";
 import { NavigateFunction } from "react-router-dom";
-import type { ResolvedSidebarConfig } from "../../config/validators/ResolvedSidebarSchema.js";
+import type { SidebarConfig } from "../../config/validators/SidebarSchema.js";
 import { type AuthenticationProvider } from "../authentication/authentication.js";
 import type { ComponentsContextType } from "../components/context/ComponentsContext.js";
 import { Slotlets } from "../components/SlotletProvider.js";
@@ -56,7 +56,7 @@ export type ZudokuContextOptions = {
   page?: Page;
   authentication?: AuthenticationProvider;
   topNavigation?: Array<{ id: string; label: string }>;
-  sidebars?: ResolvedSidebarConfig;
+  sidebars?: SidebarConfig;
   plugins?: DevPortalPlugin[];
   slotlets?: Slotlets;
   mdx?: {
@@ -110,10 +110,10 @@ export class DevPortalContext {
     return keys.flat();
   };
 
-  getPluginNavigation = async (path: string) => {
+  getPluginSidebar = async (path: string) => {
     const navigations = await Promise.all(
       this.navigationPlugins.map((plugin) =>
-        plugin.getNavigation?.(joinPath(path)),
+        plugin.getSidebar?.(joinPath(path)),
       ),
     );
 

package/src/lib/core/plugins.ts

@@ -1,6 +1,6 @@
 import { type ReactElement } from "react";
 import { NavigateFunction, type RouteObject } from "react-router-dom";
-import type { ResolvedSidebar } from "../../config/validators/ResolvedSidebarSchema.js";
+import type { Sidebar } from "../../config/validators/SidebarSchema.js";
 import { MdxComponentsType } from "../util/MdxComponents.js";
 import { DevPortalContext, type ApiIdentity } from "./DevPortalContext.js";
 
@@ -12,7 +12,7 @@ export type DevPortalPlugin =
 
 export interface NavigationPlugin {
   getRoutes: () => RouteObject[];
-  getNavigation?: (path: string) => Promise<ResolvedSidebar>;
+  getSidebar?: (path: string) => Promise<Sidebar>;
 }
 
 export interface ApiIdentityPlugin {

package/src/lib/plugins/openapi/index.tsx

@@ -10,7 +10,7 @@ import {
 import { useQuery } from "@tanstack/react-query";
 import { CirclePlayIcon, LogInIcon } from "lucide-react";
 import { createClient } from "zudoku/openapi-worker";
-import type { ResolvedSidebarItem } from "../../../config/validators/ResolvedSidebarSchema.js";
+import type { SidebarItem } from "../../../config/validators/SidebarSchema.js";
 import { useAuth } from "../../authentication/hook.js";
 import { ErrorPage } from "../../components/ErrorPage.js";
 import { SyntaxHighlight } from "../../components/SyntaxHighlight.js";
@@ -136,7 +136,7 @@ export const openApiPlugin = (
         );
       },
     }),
-    getNavigation: async (path: string) => {
+    getSidebar: async (path: string) => {
       if (!matchPath({ path: basePath, end: false }, path)) {
         return [];
       }
@@ -150,7 +150,7 @@ export const openApiPlugin = (
 
       const categories = data.schema.tags
         .filter((tag) => tag.operations.length > 0)
-        .map<ResolvedSidebarItem>((tag) => ({
+        .map<SidebarItem>((tag) => ({
           type: "category",
           label: tag.name ?? "",
           collapsible: false,

package/dist/config/validators/ResolvedSidebarSchema.d.ts

@@ -1,18 +0,0 @@
-import type { BaseSidebarItemCategoryLinkDoc, BaseSidebarItemDoc, SidebarItem, SidebarItemCategory, SidebarItemLink } from "./SidebarSchema.js";
-export type ResolvedSidebarItemDoc = BaseSidebarItemDoc & {
-    label: string;
-    categoryLabel?: string;
-};
-type ResolvedSidebarItemLink = SidebarItemLink;
-type ResolvedSidebarItemCategoryLinkDoc = BaseSidebarItemCategoryLinkDoc & {
-    label: string;
-};
-export type ResolvedSidebarItemCategory = Omit<SidebarItemCategory, "items" | "link"> & {
-    items: ResolvedSidebarItem[];
-    link?: ResolvedSidebarItemCategoryLinkDoc;
-};
-export type ResolvedSidebarItem = ResolvedSidebarItemDoc | ResolvedSidebarItemLink | ResolvedSidebarItemCategory;
-export declare const resolveSidebar: (rootDir: string, parentId: string, sidebar: SidebarItem[]) => Promise<ResolvedSidebarItem[]>;
-export type ResolvedSidebar = ResolvedSidebarItem[];
-export type ResolvedSidebarConfig = Record<string, ResolvedSidebar>;
-export {};

package/dist/config/validators/ResolvedSidebarSchema.js

@@ -1,76 +0,0 @@
-import { glob } from "glob";
-import matter from "gray-matter";
-import fs from "node:fs/promises";
-const extractTitleFromContent = (content) => content.match(/^\s*#\s(.*)$/m)?.at(1);
-export const resolveSidebar = async (rootDir, parentId, sidebar) => {
-    const resolveDoc = async (id, categoryLabel) => {
-        const foundMatches = await glob(`/**/${parentId}/${id}.{md,mdx}`, {
-            root: rootDir,
-        });
-        if (foundMatches.length === 0) {
-            throw new Error(`No file found for doc ${parentId}/${id}`);
-        }
-        if (foundMatches.length > 1) {
-            throw new Error(`Multiple files found for doc ${parentId}/${id}`);
-        }
-        const file = await fs.readFile(foundMatches.at(0));
-        const { data, content } = matter(file);
-        const label = data.sidebar_label ?? data.title ?? extractTitleFromContent(content);
-        if (typeof label !== "string") {
-            throw new Error(`No title found for doc ${id}`);
-        }
-        return {
-            type: "doc",
-            id,
-            label,
-            categoryLabel,
-        };
-    };
-    const resolveLink = async (id) => {
-        const doc = await resolveDoc(id);
-        return {
-            type: "doc",
-            id: id,
-            label: doc.label,
-        };
-    };
-    const resolveSidebarItemCategoryLinkDoc = async (item) => {
-        if (typeof item === "string") {
-            return resolveLink(item);
-        }
-        const label = item.label ?? (await resolveDoc(item.id)).label;
-        return { label, ...item };
-    };
-    const resolveSidebarItemDoc = async (item, categoryLabel) => {
-        if (typeof item === "string") {
-            return resolveDoc(item, categoryLabel);
-        }
-        const label = item.label ?? (await resolveDoc(item.id, categoryLabel)).label;
-        return { ...item, label, categoryLabel };
-    };
-    const resolveSidebarItem = async (item, categoryLabel) => {
-        if (typeof item === "string") {
-            return resolveDoc(item, categoryLabel);
-        }
-        switch (item.type) {
-            case "doc":
-                return resolveSidebarItemDoc(item, categoryLabel);
-            case "link":
-                return item;
-            case "category": {
-                const categoryItem = item;
-                const items = await Promise.all(categoryItem.items.map((subItem) => resolveSidebarItem(subItem, categoryItem.label)));
-                const resolvedLink = categoryItem.link
-                    ? await resolveSidebarItemCategoryLinkDoc(categoryItem.link)
-                    : undefined;
-                return {
-                    ...categoryItem,
-                    items,
-                    link: resolvedLink,
-                };
-            }
-        }
-    };
-    return Promise.all(sidebar.map((item) => resolveSidebarItem(item)));
-};
-//# sourceMappingURL=ResolvedSidebarSchema.js.map

package/dist/config/validators/ResolvedSidebarSchema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ResolvedSidebarSchema.js","sourceRoot":"","sources":["../../../src/config/validators/ResolvedSidebarSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAiClC,MAAM,uBAAuB,GAAG,CAAC,OAAe,EAAE,EAAE,CAClD,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;AAExC,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EACjC,OAAe,EACf,QAAgB,EAChB,OAAsB,EACU,EAAE;IAClC,MAAM,UAAU,GAAG,KAAK,EAAE,EAAU,EAAE,aAAsB,EAAE,EAAE;QAC9D,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,QAAQ,IAAI,EAAE,WAAW,EAAE;YAChE,IAAI,EAAE,OAAO;SACd,CAAC,CAAC;QAEH,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7D,CAAC;QAED,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,gCAAgC,QAAQ,IAAI,EAAE,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,CAAE,CAAC,CAAC;QAEpD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,KAAK,GACT,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,KAAK,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;QAEvE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;QAClD,CAAC;QAED,OAAO;YACL,IAAI,EAAE,KAAK;YACX,EAAE;YACF,KAAK;YACL,aAAa;SACmB,CAAC;IACrC,CAAC,CAAC;IAEF,MAAM,WAAW,GAAG,KAAK,EAAE,EAAU,EAAE,EAAE;QACvC,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,EAAE,CAAC,CAAC;QACjC,OAAO;YACL,IAAI,EAAE,KAAK;YACX,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,GAAG,CAAC,KAAK;SAC4B,CAAC;IACjD,CAAC,CAAC;IAEF,MAAM,iCAAiC,GAAG,KAAK,EAC7C,IAA6C,EACA,EAAE;QAC/C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;QAE9D,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,CAAC;IAC5B,CAAC,CAAC;IAEF,MAAM,qBAAqB,GAAG,KAAK,EACjC,IAAiC,EACjC,aAAsB,EACW,EAAE;QACnC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,UAAU,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,KAAK,GACT,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC;QAEjE,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC;IAC3C,CAAC,CAAC;IAEF,MAAM,kBAAkB,GAAG,KAAK,EAC9B,IAAiB,EACjB,aAAsB,EACQ,EAAE;QAChC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,UAAU,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QACzC,CAAC;QAED,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,KAAK;gBACR,OAAO,qBAAqB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YACpD,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC;YACd,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,MAAM,YAAY,GAAG,IAAI,CAAC;gBAE1B,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACjC,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,CAChD,CACF,CAAC;gBAEF,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI;oBACpC,CAAC,CAAC,MAAM,iCAAiC,CAAC,YAAY,CAAC,IAAI,CAAC;oBAC5D,CAAC,CAAC,SAAS,CAAC;gBAEd,OAAO;oBACL,GAAG,YAAY;oBACf,KAAK;oBACL,IAAI,EAAE,YAAY;iBACnB,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEF,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC"}