boltdocs 1.0.4 → 1.3.1

package/src/client/theme/ui/VersionSwitcher/VersionSwitcher.tsx

@@ -1,136 +1,136 @@
-import { useState, useRef, useEffect } from "react";
-import { Layers, ChevronDown } from "lucide-react";
-import { useNavigate, useLocation } from "react-router-dom";
-import { BoltdocsVersionsConfig } from "../../../../node/config";
-import { ComponentRoute } from "../../../types";
-
-function getBaseFilePath(
-  filePath: string,
-  version: string | undefined,
-  locale: string | undefined,
-): string {
-  let path = filePath;
-  if (version && (path === version || path.startsWith(version + "/"))) {
-    path = path === version ? "index.md" : path.slice(version.length + 1);
-  }
-  if (locale && (path === locale || path.startsWith(locale + "/"))) {
-    path = path === locale ? "index.md" : path.slice(locale.length + 1);
-  }
-  return path;
-}
-
-export function VersionSwitcher({
-  versions,
-  currentVersion,
-  currentLocale,
-  allRoutes,
-}: {
-  versions: BoltdocsVersionsConfig;
-  currentVersion: string;
-  currentLocale?: string;
-  allRoutes: ComponentRoute[];
-}) {
-  const [isOpen, setIsOpen] = useState(false);
-  const dropdownRef = useRef<HTMLDivElement>(null);
-  const navigate = useNavigate();
-  const location = useLocation();
-
-  useEffect(() => {
-    function handleClickOutside(event: MouseEvent) {
-      if (
-        dropdownRef.current &&
-        !dropdownRef.current.contains(event.target as Node)
-      ) {
-        setIsOpen(false);
-      }
-    }
-    document.addEventListener("mousedown", handleClickOutside);
-    return () => document.removeEventListener("mousedown", handleClickOutside);
-  }, []);
-
-  const handleSelect = (version: string) => {
-    setIsOpen(false);
-    if (version === currentVersion) return;
-
-    const currentRoute = allRoutes.find((r) => r.path === location.pathname);
-    let targetPath = `/docs/${version}`; // Default to root of the new version
-
-    if (currentRoute) {
-      const baseFile = getBaseFilePath(
-        currentRoute.filePath,
-        currentRoute.version,
-        currentRoute.locale,
-      );
-
-      const targetRoute = allRoutes.find(
-        (r) =>
-          getBaseFilePath(r.filePath, r.version, r.locale) === baseFile &&
-          (r.version || versions.defaultVersion) === version &&
-          (currentLocale ? r.locale === currentLocale : !r.locale),
-      );
-
-      if (targetRoute) {
-        targetPath = targetRoute.path;
-      } else {
-        // Fallback to version index
-        const versionIndexRoute = allRoutes.find(
-          (r) =>
-            getBaseFilePath(r.filePath, r.version, r.locale) === "index.md" &&
-            (r.version || versions.defaultVersion) === version &&
-            (currentLocale ? r.locale === currentLocale : !r.locale),
-        );
-        targetPath = versionIndexRoute
-          ? versionIndexRoute.path
-          : `/docs/${version}${currentLocale ? `/${currentLocale}` : ""}`;
-      }
-    }
-
-    navigate(targetPath);
-  };
-
-  return (
-    <div
-      className="boltdocs-version-switcher"
-      ref={dropdownRef}
-      style={{ position: "relative", display: "flex", alignItems: "center" }}
-    >
-      <button
-        className="navbar-version"
-        onClick={() => setIsOpen(!isOpen)}
-        aria-label="Switch version"
-        aria-expanded={isOpen}
-        aria-haspopup="listbox"
-        style={{
-          fontFamily: "inherit",
-          padding: "0.25rem 0.5rem",
-          marginLeft: "0.5rem",
-        }}
-      >
-        <span>{versions.versions[currentVersion] || currentVersion}</span>
-        <ChevronDown size={14} />
-      </button>
-
-      {isOpen && (
-        <div
-          className="language-dropdown"
-          style={{
-            left: "0.5rem",
-            right: "auto",
-            minWidth: "150px",
-            top: "calc(100% + 8px)",
-          }}
-        >
-          {Object.entries(versions.versions).map(([key, label]) => (
-            <button
-              key={key}
-              className={`language-option ${key === currentVersion ? "active" : ""}`}
-              onClick={() => handleSelect(key)}
-            >
-              {label}
-            </button>
-          ))}
-        </div>
-      )}
-    </div>
-  );
-}
+import { useState, useRef, useEffect } from "react";
+import { Layers, ChevronDown } from "lucide-react";
+import { useNavigate, useLocation } from "react-router-dom";
+import { BoltdocsVersionsConfig } from "../../../../node/config";
+import { ComponentRoute } from "../../../types";
+
+function getBaseFilePath(
+  filePath: string,
+  version: string | undefined,
+  locale: string | undefined,
+): string {
+  let path = filePath;
+  if (version && (path === version || path.startsWith(version + "/"))) {
+    path = path === version ? "index.md" : path.slice(version.length + 1);
+  }
+  if (locale && (path === locale || path.startsWith(locale + "/"))) {
+    path = path === locale ? "index.md" : path.slice(locale.length + 1);
+  }
+  return path;
+}
+
+export function VersionSwitcher({
+  versions,
+  currentVersion,
+  currentLocale,
+  allRoutes,
+}: {
+  versions: BoltdocsVersionsConfig;
+  currentVersion: string;
+  currentLocale?: string;
+  allRoutes: ComponentRoute[];
+}) {
+  const [isOpen, setIsOpen] = useState(false);
+  const dropdownRef = useRef<HTMLDivElement>(null);
+  const navigate = useNavigate();
+  const location = useLocation();
+
+  useEffect(() => {
+    function handleClickOutside(event: MouseEvent) {
+      if (
+        dropdownRef.current &&
+        !dropdownRef.current.contains(event.target as Node)
+      ) {
+        setIsOpen(false);
+      }
+    }
+    document.addEventListener("mousedown", handleClickOutside);
+    return () => document.removeEventListener("mousedown", handleClickOutside);
+  }, []);
+
+  const handleSelect = (version: string) => {
+    setIsOpen(false);
+    if (version === currentVersion) return;
+
+    const currentRoute = allRoutes.find((r) => r.path === location.pathname);
+    let targetPath = `/docs/${version}`; // Default to root of the new version
+
+    if (currentRoute) {
+      const baseFile = getBaseFilePath(
+        currentRoute.filePath,
+        currentRoute.version,
+        currentRoute.locale,
+      );
+
+      const targetRoute = allRoutes.find(
+        (r) =>
+          getBaseFilePath(r.filePath, r.version, r.locale) === baseFile &&
+          (r.version || versions.defaultVersion) === version &&
+          (currentLocale ? r.locale === currentLocale : !r.locale),
+      );
+
+      if (targetRoute) {
+        targetPath = targetRoute.path;
+      } else {
+        // Fallback to version index
+        const versionIndexRoute = allRoutes.find(
+          (r) =>
+            getBaseFilePath(r.filePath, r.version, r.locale) === "index.md" &&
+            (r.version || versions.defaultVersion) === version &&
+            (currentLocale ? r.locale === currentLocale : !r.locale),
+        );
+        targetPath = versionIndexRoute
+          ? versionIndexRoute.path
+          : `/docs/${version}${currentLocale ? `/${currentLocale}` : ""}`;
+      }
+    }
+
+    navigate(targetPath);
+  };
+
+  return (
+    <div
+      className="boltdocs-version-switcher"
+      ref={dropdownRef}
+      style={{ position: "relative", display: "flex", alignItems: "center" }}
+    >
+      <button
+        className="navbar-version"
+        onClick={() => setIsOpen(!isOpen)}
+        aria-label="Switch version"
+        aria-expanded={isOpen}
+        aria-haspopup="listbox"
+        style={{
+          fontFamily: "inherit",
+          padding: "0.25rem 0.5rem",
+          marginLeft: "0.5rem",
+        }}
+      >
+        <span>{versions.versions[currentVersion] || currentVersion}</span>
+        <ChevronDown size={14} />
+      </button>
+
+      {isOpen && (
+        <div
+          className="language-dropdown"
+          style={{
+            left: "0.5rem",
+            right: "auto",
+            minWidth: "150px",
+            top: "calc(100% + 8px)",
+          }}
+        >
+          {Object.entries(versions.versions).map(([key, label]) => (
+            <button
+              key={key}
+              className={`language-option ${key === currentVersion ? "active" : ""}`}
+              onClick={() => handleSelect(key)}
+            >
+              {label}
+            </button>
+          ))}
+        </div>
+      )}
+    </div>
+  );
+}

package/src/client/theme/ui/VersionSwitcher/index.ts

@@ -1 +1 @@
-export { VersionSwitcher } from "./VersionSwitcher";
+export { VersionSwitcher } from "./VersionSwitcher";

package/src/client/types.ts

@@ -1,50 +1,50 @@
-import React from "react";
-
-/**
- * Metadata provided by the server for a specific route.
- * Maps closely to the `RouteMeta` type in the Node environment.
- */
-export interface ComponentRoute {
-  /** The final URL path */
-  path: string;
-  /** The absolute filesystem path of the source file */
-  componentPath: string;
-  /** The page title */
-  title: string;
-  /** Explicit order in the sidebar */
-  sidebarPosition?: number;
-  /** The relative path from the docs directory */
-  filePath: string;
-  /** The group directory name */
-  group?: string;
-  /** The display title of the group */
-  groupTitle?: string;
-  /** Explicit order of the group in the sidebar */
-  groupPosition?: number;
-  /** Extracted markdown headings for search indexing */
-  headings?: { level: number; text: string; id: string }[];
-  /** The locale this route belongs to, if i18n is configured */
-  locale?: string;
-  /** The version this route belongs to, if versioning is configured */
-  version?: string;
-}
-
-/**
- * Configuration options for initializing the Boltdocs client app.
- */
-export interface CreateBoltdocsAppOptions {
-  /** CSS selector for the DOM element where the app should mount (e.g. '#root') */
-  target: string;
-  /** Initial routes generated by the Vite plugin (`virtual:boltdocs-routes`) */
-  routes: ComponentRoute[];
-  /** Site configuration (`virtual:boltdocs-config`) */
-  config: any;
-  /** Dynamic import mapping from `import.meta.glob` for the documentation pages */
-  modules: Record<string, () => Promise<any>>;
-  /** The `import.meta.hot` instance necessary for fast refresh/HMR updates */
-  hot?: any;
-  /** Optional custom React component to render when visiting the root path ('/') */
-  homePage?: React.ComponentType;
-  /** Optional custom MDX components provided by plugins */
-  components?: Record<string, React.ComponentType<any>>;
-}
+import React from "react";
+
+/**
+ * Metadata provided by the server for a specific route.
+ * Maps closely to the `RouteMeta` type in the Node environment.
+ */
+export interface ComponentRoute {
+  /** The final URL path */
+  path: string;
+  /** The absolute filesystem path of the source file */
+  componentPath: string;
+  /** The page title */
+  title: string;
+  /** Explicit order in the sidebar */
+  sidebarPosition?: number;
+  /** The relative path from the docs directory */
+  filePath: string;
+  /** The group directory name */
+  group?: string;
+  /** The display title of the group */
+  groupTitle?: string;
+  /** Explicit order of the group in the sidebar */
+  groupPosition?: number;
+  /** Extracted markdown headings for search indexing */
+  headings?: { level: number; text: string; id: string }[];
+  /** The locale this route belongs to, if i18n is configured */
+  locale?: string;
+  /** The version this route belongs to, if versioning is configured */
+  version?: string;
+}
+
+/**
+ * Configuration options for initializing the Boltdocs client app.
+ */
+export interface CreateBoltdocsAppOptions {
+  /** CSS selector for the DOM element where the app should mount (e.g. '#root') */
+  target: string;
+  /** Initial routes generated by the Vite plugin (`virtual:boltdocs-routes`) */
+  routes: ComponentRoute[];
+  /** Site configuration (`virtual:boltdocs-config`) */
+  config: any;
+  /** Dynamic import mapping from `import.meta.glob` for the documentation pages */
+  modules: Record<string, () => Promise<any>>;
+  /** The `import.meta.hot` instance necessary for fast refresh/HMR updates */
+  hot?: any;
+  /** Optional custom React component to render when visiting the root path ('/') */
+  homePage?: React.ComponentType;
+  /** Optional custom MDX components provided by plugins */
+  components?: Record<string, React.ComponentType<any>>;
+}

package/src/client/utils.ts

@@ -1,26 +1,26 @@
-/**
- * Get the number of stars for a GitHub repository.
- * @param repo - The repository name in the format "owner/repo".
- * @returns The number of stars for the repository.
- */
-export async function getStarsRepo(repo: string) {
-  const response = await fetch(`https://api.github.com/repos/${repo}`);
-  const data = await response.json();
-  if (data.stargazers_count !== undefined) {
-    return formatStars(data.stargazers_count);
-  } else {
-    return "0"; // Fallback
-  }
-}
-
-/**
- * Format a number of stars in a compact form.
- * @param count - The number of stars to format.
- * @returns The formatted number of stars.
- */
-const formatStars = (count: number): string => {
-  return Intl.NumberFormat("en", {
-    notation: "compact",
-    compactDisplay: "short",
-  }).format(count);
-};
+/**
+ * Get the number of stars for a GitHub repository.
+ * @param repo - The repository name in the format "owner/repo".
+ * @returns The number of stars for the repository.
+ */
+export async function getStarsRepo(repo: string) {
+  const response = await fetch(`https://api.github.com/repos/${repo}`);
+  const data = await response.json();
+  if (data.stargazers_count !== undefined) {
+    return formatStars(data.stargazers_count);
+  } else {
+    return "0"; // Fallback
+  }
+}
+
+/**
+ * Format a number of stars in a compact form.
+ * @param count - The number of stars to format.
+ * @returns The formatted number of stars.
+ */
+const formatStars = (count: number): string => {
+  return Intl.NumberFormat("en", {
+    notation: "compact",
+    compactDisplay: "short",
+  }).format(count);
+};