zudoku 0.1.1-dev.9 → 0.3.0-dev.100

package/src/lib/components/Select.tsx

@@ -0,0 +1,157 @@
+import * as SelectPrimitive from "@radix-ui/react-select";
+import { Check, ChevronDown, ChevronUp } from "lucide-react";
+import * as React from "react";
+import { cn } from "../util/cn.js";
+
+const Select = SelectPrimitive.Root;
+
+const SelectGroup = SelectPrimitive.Group;
+
+const SelectValue = SelectPrimitive.Value;
+
+const SelectTrigger = React.forwardRef<
+  React.ElementRef<typeof SelectPrimitive.Trigger>,
+  React.ComponentPropsWithoutRef<typeof SelectPrimitive.Trigger>
+>(({ className, children, ...props }, ref) => (
+  <SelectPrimitive.Trigger
+    ref={ref}
+    className={cn(
+      "flex h-10 w-full items-center justify-between rounded-md border border-input bg-background px-3 py-2 text-sm ring-offset-background placeholder:text-muted-foreground focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50",
+      className,
+    )}
+    {...props}
+  >
+    <span className="truncate">{children}</span>
+    <SelectPrimitive.Icon asChild>
+      <ChevronDown className="flex-shrink-0 h-4 w-4 opacity-50" />
+    </SelectPrimitive.Icon>
+  </SelectPrimitive.Trigger>
+));
+SelectTrigger.displayName = SelectPrimitive.Trigger.displayName;
+
+const SelectScrollUpButton = React.forwardRef<
+  React.ElementRef<typeof SelectPrimitive.ScrollUpButton>,
+  React.ComponentPropsWithoutRef<typeof SelectPrimitive.ScrollUpButton>
+>(({ className, ...props }, ref) => (
+  <SelectPrimitive.ScrollUpButton
+    ref={ref}
+    className={cn(
+      "flex cursor-default items-center justify-center py-1",
+      className,
+    )}
+    {...props}
+  >
+    <ChevronUp className="h-4 w-4" />
+  </SelectPrimitive.ScrollUpButton>
+));
+SelectScrollUpButton.displayName = SelectPrimitive.ScrollUpButton.displayName;
+
+const SelectScrollDownButton = React.forwardRef<
+  React.ElementRef<typeof SelectPrimitive.ScrollDownButton>,
+  React.ComponentPropsWithoutRef<typeof SelectPrimitive.ScrollDownButton>
+>(({ className, ...props }, ref) => (
+  <SelectPrimitive.ScrollDownButton
+    ref={ref}
+    className={cn(
+      "flex cursor-default items-center justify-center py-1",
+      className,
+    )}
+    {...props}
+  >
+    <ChevronDown className="h-4 w-4" />
+  </SelectPrimitive.ScrollDownButton>
+));
+SelectScrollDownButton.displayName =
+  SelectPrimitive.ScrollDownButton.displayName;
+
+const SelectContent = React.forwardRef<
+  React.ElementRef<typeof SelectPrimitive.Content>,
+  React.ComponentPropsWithoutRef<typeof SelectPrimitive.Content>
+>(({ className, children, position = "popper", ...props }, ref) => (
+  <SelectPrimitive.Portal>
+    <SelectPrimitive.Content
+      ref={ref}
+      className={cn(
+        "relative z-50 max-h-96 min-w-[8rem] overflow-hidden rounded-md border bg-popover text-popover-foreground shadow-md data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2",
+        position === "popper" &&
+          "data-[side=bottom]:translate-y-1 data-[side=left]:-translate-x-1 data-[side=right]:translate-x-1 data-[side=top]:-translate-y-1",
+        className,
+      )}
+      position={position}
+      {...props}
+    >
+      <SelectScrollUpButton />
+      <SelectPrimitive.Viewport
+        className={cn(
+          "p-1",
+          position === "popper" &&
+            "h-[var(--radix-select-trigger-height)] w-full min-w-[var(--radix-select-trigger-width)]",
+        )}
+      >
+        {children}
+      </SelectPrimitive.Viewport>
+      <SelectScrollDownButton />
+    </SelectPrimitive.Content>
+  </SelectPrimitive.Portal>
+));
+SelectContent.displayName = SelectPrimitive.Content.displayName;
+
+const SelectLabel = React.forwardRef<
+  React.ElementRef<typeof SelectPrimitive.Label>,
+  React.ComponentPropsWithoutRef<typeof SelectPrimitive.Label>
+>(({ className, ...props }, ref) => (
+  <SelectPrimitive.Label
+    ref={ref}
+    className={cn("py-1.5 pl-8 pr-2 text-sm font-semibold", className)}
+    {...props}
+  />
+));
+SelectLabel.displayName = SelectPrimitive.Label.displayName;
+
+const SelectItem = React.forwardRef<
+  React.ElementRef<typeof SelectPrimitive.Item>,
+  React.ComponentPropsWithoutRef<typeof SelectPrimitive.Item>
+>(({ className, children, ...props }, ref) => (
+  <SelectPrimitive.Item
+    ref={ref}
+    className={cn(
+      "relative flex w-full cursor-default select-none items-center rounded-sm py-1.5 pl-8 pr-2 text-sm outline-none focus:bg-accent focus:text-accent-foreground data-[disabled]:pointer-events-none data-[disabled]:opacity-50",
+      className,
+    )}
+    {...props}
+  >
+    <span className="absolute left-2 flex h-3.5 w-3.5 items-center justify-center">
+      <SelectPrimitive.ItemIndicator>
+        <Check className="h-4 w-4" />
+      </SelectPrimitive.ItemIndicator>
+    </span>
+
+    <SelectPrimitive.ItemText>{children}</SelectPrimitive.ItemText>
+  </SelectPrimitive.Item>
+));
+SelectItem.displayName = SelectPrimitive.Item.displayName;
+
+const SelectSeparator = React.forwardRef<
+  React.ElementRef<typeof SelectPrimitive.Separator>,
+  React.ComponentPropsWithoutRef<typeof SelectPrimitive.Separator>
+>(({ className, ...props }, ref) => (
+  <SelectPrimitive.Separator
+    ref={ref}
+    className={cn("-mx-1 my-1 h-px bg-muted", className)}
+    {...props}
+  />
+));
+SelectSeparator.displayName = SelectPrimitive.Separator.displayName;
+
+export {
+  Select,
+  SelectContent,
+  SelectGroup,
+  SelectItem,
+  SelectLabel,
+  SelectScrollDownButton,
+  SelectScrollUpButton,
+  SelectSeparator,
+  SelectTrigger,
+  SelectValue,
+};

package/src/lib/components/SlotletProvider.tsx

@@ -0,0 +1,25 @@
+import React, { ReactNode, useContext } from "react";
+
+export type Slotlets = Record<string, ReactNode>;
+
+const SlotletContext = React.createContext<Slotlets | undefined>({});
+
+export const SlotletProvider = ({
+  slotlets,
+  children,
+}: {
+  children: ReactNode;
+  slotlets?: Slotlets;
+}) => {
+  return (
+    <SlotletContext.Provider value={slotlets}>
+      {children}
+    </SlotletContext.Provider>
+  );
+};
+
+export const Slotlet = ({ name }: { name: string }) => {
+  const x = useContext(SlotletContext);
+
+  return x?.[name];
+};

package/src/lib/components/Spinner.tsx

@@ -0,0 +1,5 @@
+import { LoaderCircle } from "lucide-react";
+
+export const Spinner = ({ size = 16 }: { size?: number }) => (
+  <LoaderCircle size={size} className="animate-spin" />
+);

package/src/lib/components/SyntaxHighlight.tsx

@@ -0,0 +1,114 @@
+import {
+  Highlight,
+  Prism,
+  themes,
+  type HighlightProps,
+} from "prism-react-renderer";
+
+import { CheckIcon, CopyIcon } from "lucide-react";
+
+globalThis.Prism = Prism;
+// @ts-expect-error This is untyped
+import("prismjs/components/prism-bash.min.js");
+// @ts-expect-error This is untyped
+import("prismjs/components/prism-ruby.min.js");
+// @ts-expect-error This is untyped
+import("prismjs/components/prism-markup-templating.js");
+// @ts-expect-error This is untyped
+import("prismjs/components/prism-php.min.js");
+// @ts-expect-error This is untyped
+import("prismjs/components/prism-json.min.js");
+// @ts-expect-error This is untyped
+import("prismjs/components/prism-java.min.js");
+// @ts-expect-error This is untyped
+import("prismjs/components/prism-csharp.min.js");
+// @ts-expect-error This is untyped
+import("prismjs/components/prism-objectivec.min.js");
+
+import { useState } from "react";
+import { cn } from "../util/cn.js";
+import { useTheme } from "./context/ThemeContext.js";
+
+type SyntaxHighlightProps = {
+  className?: string;
+  noBackground?: boolean;
+  wrapLines?: boolean;
+  copyable?: boolean;
+  showLanguageIndicator?: boolean;
+  language?: string;
+} & Omit<HighlightProps, "children" | "language">;
+
+export const SyntaxHighlight = ({
+  copyable = true,
+  language = "plain",
+  ...props
+}: SyntaxHighlightProps) => {
+  const [isDark] = useTheme();
+  const [isCopied, setIsCopied] = useState(false);
+
+  if (!props.code) {
+    return null;
+  }
+
+  return (
+    <Highlight
+      theme={isDark ? themes.vsDark : themes.github}
+      language={language}
+      {...props}
+    >
+      {({ className, style, tokens, getLineProps, getTokenProps }) => (
+        <div className="relative group">
+          <pre
+            className={cn(
+              "relative overflow-x-auto",
+              className,
+              props.className,
+              props.noBackground && "!bg-transparent",
+              props.wrapLines && "whitespace-pre-wrap break-words",
+            )}
+            style={style}
+          >
+            {tokens.map((line, i) => (
+              // eslint-disable-next-line react/no-array-index-key
+              <div key={i} {...getLineProps({ line })}>
+                {line.map((token, key) => (
+                  // eslint-disable-next-line react/no-array-index-key
+                  <span key={key} {...getTokenProps({ token })} />
+                ))}
+              </div>
+            ))}
+          </pre>
+          {props.showLanguageIndicator && (
+            <span className="absolute top-1.5 right-3 text-[11px] font-mono text-muted-foreground transition group-hover:opacity-0">
+              {language}
+            </span>
+          )}
+          {copyable && (
+            <button
+              type="button"
+              aria-label="Copy code"
+              title="Copy code"
+              className="absolute top-1.5 right-1.5 p-2.5 opacity-0 group-hover:opacity-100 group-hover:bg-zinc-100 group-hover:dark:bg-zinc-700 hover:outline hover:outline-border/75 dark:hover:outline-border rounded-md text-sm text-gray-400 hover:text-gray-600 dark:text-gray-500 dark:hover:text-gray-400 transition"
+              disabled={isCopied}
+              onClick={() => {
+                setIsCopied(true);
+                void navigator.clipboard.writeText(
+                  tokens
+                    .map((line) => line.map(({ content }) => content).join(""))
+                    .join("\n"),
+                );
+                setTimeout(() => setIsCopied(false), 2000);
+              }}
+            >
+              {isCopied ? (
+                <CheckIcon className="text-emerald-600" size={18} />
+              ) : (
+                <CopyIcon size={18} />
+              )}
+            </button>
+          )}
+        </div>
+      )}
+    </Highlight>
+  );
+};

package/src/lib/components/TopNavigation.tsx

@@ -0,0 +1,37 @@
+import { cx } from "class-variance-authority";
+import { NavLink } from "react-router-dom";
+
+import { useZudoku } from "./context/ZudokuContext.js";
+
+export const TopNavigation = () => {
+  const { topNavigation } = useZudoku();
+
+  // Hide top nav if there is only one item
+  if (topNavigation.length <= 1) {
+    return null;
+  }
+
+  return (
+    <nav className="border-b text-sm px-12 h-[--top-nav-height]">
+      <ul className="flex flex-row items-center gap-8">
+        {topNavigation.map((item) => (
+          <li key={item.label}>
+            <NavLink
+              className={({ isActive }) =>
+                cx(
+                  "block py-3.5 font-medium -mb-px border-b-2",
+                  isActive
+                    ? "border-primary text-foreground"
+                    : "border-transparent text-foreground/75 hover:text-foreground hover:border-accent-foreground/25",
+                )
+              }
+              to={item.id}
+            >
+              {item.label}
+            </NavLink>
+          </li>
+        ))}
+      </ul>
+    </nav>
+  );
+};

package/src/lib/components/context/ThemeContext.tsx

@@ -0,0 +1,8 @@
+import { createContext, useContext } from "react";
+
+export const ThemeContext = createContext<readonly [boolean, () => void]>([
+  false,
+  () => {},
+]);
+
+export const useTheme = () => useContext(ThemeContext);

package/src/lib/components/context/ThemeProvider.tsx

@@ -0,0 +1,27 @@
+import { ReactNode, useCallback, useEffect, useState } from "react";
+import { ThemeContext } from "./ThemeContext.js";
+
+export const ThemeProvider = (props: { children: ReactNode }) => {
+  const [dark, setDark] = useState(false);
+
+  // On mount, read the preferred theme from the persistence
+  useEffect(() => {
+    const theme = localStorage.getItem("theme");
+    const prefersDark = window.matchMedia("(prefers-color-scheme: dark)");
+    const isDark = theme === "dark" || (!theme && prefersDark.matches);
+
+    setDark(isDark);
+  }, [dark]);
+
+  // To toggle between dark and light modes
+  const toggle = useCallback(() => {
+    const toggled = !dark;
+    document.documentElement.classList.toggle("dark", toggled);
+    localStorage.setItem("theme", toggled ? "dark" : "light");
+    setDark(toggled);
+  }, [dark]);
+
+  const value = [dark, toggle] as const;
+
+  return <ThemeContext.Provider value={value} {...props} />;
+};

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

@@ -0,0 +1,58 @@
+import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
+import { createContext, useContext } from "react";
+import { useLocation } from "react-router-dom";
+import { DevPortalContext } from "../../core/DevPortalContext.js";
+
+export const ZudokuReactContext = createContext<DevPortalContext | undefined>(
+  undefined,
+);
+
+export const useZudoku = () => {
+  const context = useContext(ZudokuReactContext);
+
+  if (!context) {
+    throw new Error("useDevPortal must be used within a DevPortalProvider.");
+  }
+
+  return context;
+};
+
+export const useApiIdentities = () => {
+  const { getApiIdentities } = useZudoku();
+  return useQuery({
+    queryFn: getApiIdentities,
+    queryKey: ["api-identities"],
+  });
+};
+
+export const useTopNavigationItem = () => {
+  const { topNavigation } = useZudoku();
+  const location = useLocation();
+
+  const firstPart = location.pathname.split("/").at(1);
+  if (!firstPart) return;
+
+  return topNavigation.find((item) => item.id === firstPart);
+};
+
+export const useNavigation = () => {
+  const { getPluginSidebar, sidebars } = useZudoku();
+  const navItem = useTopNavigationItem();
+  const path = navItem?.id;
+  const currentSidebar = path ? sidebars[path] ?? [] : [];
+  const location = useLocation();
+
+  return useSuspenseQuery({
+    queryFn: async () => {
+      const pluginSidebar = path
+        ? await getPluginSidebar(path)
+        : await getPluginSidebar(location.pathname);
+
+      return {
+        items: [...currentSidebar, ...pluginSidebar],
+        currentTopNavItem: navItem,
+      };
+    },
+    queryKey: ["navigation", path],
+  });
+};

package/src/lib/components/context/ZudokuProvider.tsx

@@ -0,0 +1,26 @@
+import { useSuspenseQuery } from "@tanstack/react-query";
+import type { PropsWithChildren } from "react";
+import { useNavigate } from "react-router-dom";
+import { DevPortalContext } from "../../core/DevPortalContext.js";
+import { ZudokuReactContext } from "./ZudokuContext.js";
+
+export const ZudokuProvider = ({
+  children,
+  context,
+}: PropsWithChildren<{ context: DevPortalContext }>) => {
+  const navigate = useNavigate();
+
+  useSuspenseQuery({
+    queryFn: async () => {
+      await context.initialize({ navigate });
+      return true;
+    },
+    queryKey: ["zudoku-initialize"],
+  });
+
+  return (
+    <ZudokuReactContext.Provider value={context}>
+      {children}
+    </ZudokuReactContext.Provider>
+  );
+};

package/src/lib/components/index.ts

@@ -0,0 +1,25 @@
+import { useMDXComponents as useMDXComponentsImport } from "@mdx-js/react";
+import { Helmet } from "@zudoku/react-helmet-async";
+import { Link as LinkImport } from "react-router-dom";
+import { RouterError as RouterErrorImport } from "../errors/RouterError.js";
+import { ServerError as ServerErrorImport } from "../errors/ServerError.js";
+import { Button as ButtonImport } from "../ui/Button.js";
+import { Callout as CalloutImport } from "../ui/Callout.js";
+import {
+  Bootstrap as BootstrapImport,
+  BootstrapStatic as BootstrapStaticImport,
+} from "./Bootstrap.js";
+import { DevPortal as DevPortalImport } from "./DevPortal.js";
+import { Layout as LayoutImport } from "./Layout.js";
+
+export const useMDXComponents = /*@__PURE__*/ useMDXComponentsImport;
+export const Callout = /*@__PURE__*/ CalloutImport;
+export const DevPortal = /*@__PURE__*/ DevPortalImport;
+export const Layout = /*@__PURE__*/ LayoutImport;
+export const Link = /*@__PURE__*/ LinkImport;
+export const RouterError = /*@__PURE__*/ RouterErrorImport;
+export const ServerError = /*@__PURE__*/ ServerErrorImport;
+export const Bootstrap = /*@__PURE__*/ BootstrapImport;
+export const BootstrapStatic = /*@__PURE__*/ BootstrapStaticImport;
+export const Button = /*@__PURE__*/ ButtonImport;
+export const Head = /*@__PURE__*/ Helmet;

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

@@ -0,0 +1,24 @@
+import { useRef } from "react";
+
+import { useNavigation } from "../context/ZudokuContext.js";
+import { Slotlet } from "../SlotletProvider.js";
+import { SidebarItem } from "./SidebarItem.js";
+import { SidebarWrapper } from "./SidebarWrapper.js";
+
+export const Sidebar = () => {
+  const navRef = useRef<HTMLDivElement | null>(null);
+  const navigation = useNavigation();
+
+  return (
+    <SidebarWrapper
+      ref={navRef}
+      pushMainContent={navigation.data.items.length > 0}
+    >
+      <Slotlet name="zudoku-before-navigation" />
+      {navigation.data.items.map((item) => (
+        <SidebarItem key={item.label} item={item} />
+      ))}
+      <Slotlet name="zudoku-after-navigation" />
+    </SidebarWrapper>
+  );
+};

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

@@ -0,0 +1,43 @@
+import { cn } from "../../util/cn.js";
+
+export const TextColorMap = {
+  green: "text-green-600",
+  blue: "text-sky-600",
+  yellow: "text-yellow-600",
+  red: "text-red-600",
+  purple: "text-purple-600",
+  indigo: "text-indigo-600",
+  gray: "text-gray-600",
+};
+
+export const ColorMap = {
+  green: "bg-green-400 dark:bg-green-800",
+  blue: "bg-sky-400 dark:bg-sky-800",
+  yellow: "bg-yellow-400 dark:bg-yellow-800",
+  red: "bg-red-400 dark:bg-red-800",
+  purple: "bg-purple-400 dark:bg-purple-600",
+  indigo: "bg-indigo-400 dark:bg-indigo-600",
+  gray: "bg-gray-400 dark:bg-gray-600",
+};
+
+export const SidebarBadge = ({
+  color,
+  label,
+  className,
+}: {
+  color: keyof typeof ColorMap;
+  label: string;
+  className?: string;
+}) => {
+  return (
+    <span
+      className={cn(
+        "mt-0.5 flex items-center duration-200 transition-opacity text-center uppercase font-mono text-[0.65rem] font-bold rounded text-background dark:text-zinc-50 h-4 px-1",
+        ColorMap[color],
+        className,
+      )}
+    >
+      {label}
+    </span>
+  );
+};

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

@@ -0,0 +1,105 @@
+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 { SidebarItemCategory } from "../../../config/validators/SidebarSchema.js";
+import { cn } from "../../util/cn.js";
+import { joinPath } from "../../util/joinPath.js";
+import { useTopNavigationItem } from "../context/ZudokuContext.js";
+import { navigationListItem, SidebarItem } from "./SidebarItem.js";
+import { useIsCategoryOpen } from "./utils.js";
+
+export const SidebarCategory = ({
+  category,
+  level,
+}: {
+  category: SidebarItemCategory;
+  level: number;
+}) => {
+  const topNavItem = useTopNavigationItem();
+  const isCategoryOpen = useIsCategoryOpen(category);
+
+  const isCollapsible = category.collapsible ?? true;
+  const isCollapsed = category.collapsed ?? true;
+  const isDefaultOpen = Boolean(
+    !isCollapsible || !isCollapsed || isCategoryOpen,
+  );
+  const [open, setOpen] = useState(isDefaultOpen);
+
+  useEffect(() => {
+    // this is triggered when an item from the sidebar is clicked
+    // and the sidebar, enclosing this item, is not opened
+    if (isCategoryOpen) {
+      setOpen(true);
+    }
+  }, [isCategoryOpen]);
+
+  const ToggleButton = isCollapsible && (
+    <button
+      type="button"
+      onClick={(e) => {
+        e.preventDefault();
+        setOpen((prev) => !prev);
+      }}
+    >
+      <ChevronRightIcon
+        size={16}
+        className="transition shrink-0 group-data-[state=open]:rotate-90"
+      />
+    </button>
+  );
+
+  return (
+    <Collapsible.Root
+      className={cn("flex flex-col", level === 0 && "-mx-[--padding-nav-item]")}
+      defaultOpen={isDefaultOpen}
+      open={open}
+      onOpenChange={() => setOpen(true)}
+    >
+      <Collapsible.Trigger
+        className={cn(
+          "group text-start",
+          navigationListItem({ isActive: false, isTopLevel: level === 0 }),
+          isCollapsible
+            ? "cursor-pointer"
+            : "cursor-default hover:bg-transparent",
+        )}
+        asChild
+        disabled={!isCollapsible}
+      >
+        {category.link?.type === "doc" ? (
+          <NavLink to={joinPath(topNavItem?.id, category.link.id)}>
+            {({ isActive }) => (
+              <div
+                className={cn(
+                  "flex items-center gap-2 justify-between w-full",
+                  isActive ? "text-primary font-medium" : "text-foreground/80",
+                )}
+              >
+                <div className="truncate">{category.label}</div>
+                {ToggleButton}
+              </div>
+            )}
+          </NavLink>
+        ) : (
+          <div className="flex items-center justify-between w-full">
+            <div className="flex gap-2 truncate w-full">{category.label}</div>
+            {ToggleButton}
+          </div>
+        )}
+      </Collapsible.Trigger>
+      <Collapsible.Content className="CollapsibleContent ms-[calc(var(--padding-nav-item)*1.125)]">
+        <ul className="mt-1 border-l ps-2">
+          {category.items.map((item) => (
+            <SidebarItem
+              key={item.label}
+              level={level + 1}
+              item={item}
+              // activeAnchor={activeAnchor}
+            />
+          ))}
+        </ul>
+      </Collapsible.Content>
+    </Collapsible.Root>
+  );
+};