zudoku 0.39.0 → 0.39.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (143) hide show
  1. package/dist/app/entry.server.d.ts +5 -4
  2. package/dist/app/entry.server.js +2 -2
  3. package/dist/app/entry.server.js.map +1 -1
  4. package/dist/cli/cmds/dev.js +1 -7
  5. package/dist/cli/cmds/dev.js.map +1 -1
  6. package/dist/config/validators/common.d.ts +17 -0
  7. package/dist/config/validators/common.js +1 -0
  8. package/dist/config/validators/common.js.map +1 -1
  9. package/dist/config/validators/validate.d.ts +7 -0
  10. package/dist/lib/components/Bootstrap.d.ts +2 -1
  11. package/dist/lib/components/Bootstrap.js +3 -2
  12. package/dist/lib/components/Bootstrap.js.map +1 -1
  13. package/dist/lib/components/Header.js +2 -2
  14. package/dist/lib/components/Header.js.map +1 -1
  15. package/dist/lib/components/Layout.js +1 -1
  16. package/dist/lib/components/Layout.js.map +1 -1
  17. package/dist/lib/components/Main.js +1 -1
  18. package/dist/lib/components/Main.js.map +1 -1
  19. package/dist/lib/components/MobileTopNavigation.js +6 -3
  20. package/dist/lib/components/MobileTopNavigation.js.map +1 -1
  21. package/dist/lib/components/TopNavigation.d.ts +1 -0
  22. package/dist/lib/components/TopNavigation.js +2 -2
  23. package/dist/lib/components/TopNavigation.js.map +1 -1
  24. package/dist/lib/components/Zudoku.js +4 -1
  25. package/dist/lib/components/Zudoku.js.map +1 -1
  26. package/dist/lib/components/context/BypassProtectedRoutesContext.d.ts +1 -0
  27. package/dist/lib/components/context/BypassProtectedRoutesContext.js +3 -0
  28. package/dist/lib/components/context/BypassProtectedRoutesContext.js.map +1 -0
  29. package/dist/lib/components/index.d.ts +2 -1
  30. package/dist/lib/components/navigation/PoweredByZudoku.d.ts +3 -0
  31. package/dist/lib/components/navigation/PoweredByZudoku.js +6 -0
  32. package/dist/lib/components/navigation/PoweredByZudoku.js.map +1 -0
  33. package/dist/lib/components/navigation/SidebarWrapper.js +9 -2
  34. package/dist/lib/components/navigation/SidebarWrapper.js.map +1 -1
  35. package/dist/lib/components/navigation/ZudokuLogo.d.ts +6 -0
  36. package/dist/lib/components/navigation/ZudokuLogo.js +5 -0
  37. package/dist/lib/components/navigation/ZudokuLogo.js.map +1 -0
  38. package/dist/lib/core/RouteGuard.d.ts +1 -0
  39. package/dist/lib/core/RouteGuard.js +9 -3
  40. package/dist/lib/core/RouteGuard.js.map +1 -1
  41. package/dist/lib/core/ZudokuContext.d.ts +1 -0
  42. package/dist/lib/core/ZudokuContext.js.map +1 -1
  43. package/dist/lib/plugins/openapi/schema/LogicalGroup/LogicalGroupConnector.d.ts +2 -1
  44. package/dist/lib/plugins/openapi/schema/LogicalGroup/LogicalGroupConnector.js +2 -2
  45. package/dist/lib/plugins/openapi/schema/LogicalGroup/LogicalGroupConnector.js.map +1 -1
  46. package/dist/lib/plugins/openapi/schema/LogicalGroup/LogicalGroupItem.js +1 -1
  47. package/dist/lib/plugins/openapi/schema/LogicalGroup/LogicalGroupItem.js.map +1 -1
  48. package/dist/lib/plugins/search-pagefind/PagefindSearch.js +9 -4
  49. package/dist/lib/plugins/search-pagefind/PagefindSearch.js.map +1 -1
  50. package/dist/lib/plugins/search-pagefind/ResultList.d.ts +1 -1
  51. package/dist/lib/plugins/search-pagefind/ResultList.js +6 -12
  52. package/dist/lib/plugins/search-pagefind/ResultList.js.map +1 -1
  53. package/dist/lib/plugins/search-pagefind/index.d.ts +1 -3
  54. package/dist/vite/build.js +1 -9
  55. package/dist/vite/build.js.map +1 -1
  56. package/dist/vite/plugin-search.js +1 -1
  57. package/dist/vite/plugin-search.js.map +1 -1
  58. package/dist/vite/prerender/FileWritingResponse.d.ts +9 -5
  59. package/dist/vite/prerender/FileWritingResponse.js +5 -5
  60. package/dist/vite/prerender/FileWritingResponse.js.map +1 -1
  61. package/dist/vite/prerender/InMemoryResponse.d.ts +16 -0
  62. package/dist/vite/prerender/InMemoryResponse.js +32 -0
  63. package/dist/vite/prerender/InMemoryResponse.js.map +1 -0
  64. package/dist/vite/prerender/PrerenderResponse.d.ts +10 -0
  65. package/dist/vite/prerender/PrerenderResponse.js +2 -0
  66. package/dist/vite/prerender/PrerenderResponse.js.map +1 -0
  67. package/dist/vite/prerender/prerender.d.ts +1 -0
  68. package/dist/vite/prerender/prerender.js +18 -0
  69. package/dist/vite/prerender/prerender.js.map +1 -1
  70. package/dist/vite/prerender/worker.js +36 -8
  71. package/dist/vite/prerender/worker.js.map +1 -1
  72. package/dist/zuplo/with-zuplo.js +4 -0
  73. package/dist/zuplo/with-zuplo.js.map +1 -1
  74. package/lib/{Callout-D5frCCJ0.js → Callout-B2vsR09t.js} +2 -2
  75. package/lib/{Callout-D5frCCJ0.js.map → Callout-B2vsR09t.js.map} +1 -1
  76. package/lib/{Dialog-Dv6WG8RN.js → Dialog-sbgekbjb.js} +5 -5
  77. package/lib/{Dialog-Dv6WG8RN.js.map → Dialog-sbgekbjb.js.map} +1 -1
  78. package/lib/{MdxPage-ZW1StNhp.js → MdxPage-JscVnWM8.js} +22 -21
  79. package/lib/{MdxPage-ZW1StNhp.js.map → MdxPage-JscVnWM8.js.map} +1 -1
  80. package/lib/{OasProvider-Cld9RAMQ.js → OasProvider-C7Y53snX.js} +2 -2
  81. package/lib/{OasProvider-Cld9RAMQ.js.map → OasProvider-C7Y53snX.js.map} +1 -1
  82. package/lib/{OperationList-D-OfzJm6.js → OperationList-_M8wg22T.js} +49 -48
  83. package/lib/{OperationList-D-OfzJm6.js.map → OperationList-_M8wg22T.js.map} +1 -1
  84. package/lib/{Pagination-CYB3nVYx.js → Pagination-DCCvGq0m.js} +2 -2
  85. package/lib/{Pagination-CYB3nVYx.js.map → Pagination-DCCvGq0m.js.map} +1 -1
  86. package/lib/RouteGuard-CqZPoZYJ.js +744 -0
  87. package/lib/RouteGuard-CqZPoZYJ.js.map +1 -0
  88. package/lib/{SchemaList-Ci1WxRh0.js → SchemaList-CrKZdUyo.js} +3 -3
  89. package/lib/{SchemaList-Ci1WxRh0.js.map → SchemaList-CrKZdUyo.js.map} +1 -1
  90. package/lib/{SchemaView-Brn-YxHY.js → SchemaView-B4JHn-BX.js} +27 -18
  91. package/lib/SchemaView-B4JHn-BX.js.map +1 -0
  92. package/lib/{createServer-mMau3eV_.js → createServer-mYvGvmc0.js} +2469 -2443
  93. package/lib/createServer-mYvGvmc0.js.map +1 -0
  94. package/lib/{index-CjPMxpOV.js → index-C8-tlf_X.js} +13 -12
  95. package/lib/{index-CjPMxpOV.js.map → index-C8-tlf_X.js.map} +1 -1
  96. package/lib/index-D6ktNq4i.js +1863 -0
  97. package/lib/index-D6ktNq4i.js.map +1 -0
  98. package/lib/objectEntries-yMIkr2mI.js +5 -0
  99. package/lib/objectEntries-yMIkr2mI.js.map +1 -0
  100. package/lib/ui/Command.js +1 -1
  101. package/lib/useLatest-hmRS46UF.js +11 -0
  102. package/lib/useLatest-hmRS46UF.js.map +1 -0
  103. package/lib/zudoku.components.js +15 -14
  104. package/lib/zudoku.components.js.map +1 -1
  105. package/lib/zudoku.plugin-api-catalog.js +6 -5
  106. package/lib/zudoku.plugin-api-catalog.js.map +1 -1
  107. package/lib/zudoku.plugin-markdown.js +1 -1
  108. package/lib/zudoku.plugin-openapi.js +1 -1
  109. package/lib/zudoku.plugin-search-pagefind.js +132 -137
  110. package/lib/zudoku.plugin-search-pagefind.js.map +1 -1
  111. package/package.json +3 -3
  112. package/src/app/entry.server.tsx +6 -3
  113. package/src/lib/components/Bootstrap.tsx +13 -6
  114. package/src/lib/components/Header.tsx +2 -2
  115. package/src/lib/components/Layout.tsx +1 -1
  116. package/src/lib/components/Main.tsx +3 -2
  117. package/src/lib/components/MobileTopNavigation.tsx +27 -18
  118. package/src/lib/components/TopNavigation.tsx +2 -2
  119. package/src/lib/components/Zudoku.tsx +5 -3
  120. package/src/lib/components/context/BypassProtectedRoutesContext.ts +3 -0
  121. package/src/lib/components/navigation/PoweredByZudoku.tsx +23 -0
  122. package/src/lib/components/navigation/SidebarWrapper.tsx +27 -13
  123. package/src/lib/components/navigation/ZudokuLogo.tsx +25 -0
  124. package/src/lib/core/RouteGuard.tsx +26 -4
  125. package/src/lib/core/ZudokuContext.ts +1 -0
  126. package/src/lib/plugins/openapi/schema/LogicalGroup/LogicalGroupConnector.tsx +3 -0
  127. package/src/lib/plugins/openapi/schema/LogicalGroup/LogicalGroupItem.tsx +5 -1
  128. package/src/lib/plugins/search-pagefind/PagefindSearch.tsx +11 -4
  129. package/src/lib/plugins/search-pagefind/ResultList.tsx +5 -16
  130. package/src/lib/plugins/search-pagefind/index.tsx +1 -1
  131. package/dist/cli/dev/pagefind-command.d.ts +0 -3
  132. package/dist/cli/dev/pagefind-command.js +0 -59
  133. package/dist/cli/dev/pagefind-command.js.map +0 -1
  134. package/dist/lib/components/context/PluginSystem.d.ts +0 -1
  135. package/dist/lib/components/context/PluginSystem.js +0 -2
  136. package/dist/lib/components/context/PluginSystem.js.map +0 -1
  137. package/lib/SchemaView-Brn-YxHY.js.map +0 -1
  138. package/lib/createServer-mMau3eV_.js.map +0 -1
  139. package/lib/index-Bt7MKhZq.js +0 -2514
  140. package/lib/index-Bt7MKhZq.js.map +0 -1
  141. package/lib/objectEntries-BS7aAgOm.js +0 -12
  142. package/lib/objectEntries-BS7aAgOm.js.map +0 -1
  143. package/src/lib/components/context/PluginSystem.ts +0 -0
@@ -13,6 +13,7 @@ import {
13
13
  } from "react-router";
14
14
  import { RouterProvider } from "react-router/dom";
15
15
  import { StaggeredRenderContext } from "../plugins/openapi/StaggeredRender.js";
16
+ import { BypassProtectedRoutesContext } from "./context/BypassProtectedRoutesContext.js";
16
17
 
17
18
  const queryClient = new QueryClient({
18
19
  defaultOptions: {
@@ -32,11 +33,13 @@ const Bootstrap = ({
32
33
  <StrictMode>
33
34
  <QueryClientProvider client={queryClient}>
34
35
  <HydrationBoundary state={hydrate ? (window as any).DATA : undefined}>
35
- <HelmetProvider>
36
- <StaggeredRenderContext.Provider value={{ stagger: !hydrate }}>
37
- <RouterProvider router={router} />
38
- </StaggeredRenderContext.Provider>
39
- </HelmetProvider>
36
+ <BypassProtectedRoutesContext value={false}>
37
+ <HelmetProvider>
38
+ <StaggeredRenderContext.Provider value={{ stagger: !hydrate }}>
39
+ <RouterProvider router={router} />
40
+ </StaggeredRenderContext.Provider>
41
+ </HelmetProvider>
42
+ </BypassProtectedRoutesContext>
40
43
  </HydrationBoundary>
41
44
  </QueryClientProvider>
42
45
  </StrictMode>
@@ -47,16 +50,20 @@ const BootstrapStatic = ({
47
50
  context,
48
51
  queryClient,
49
52
  helmetContext,
53
+ bypassProtection = false,
50
54
  }: {
51
55
  helmetContext: HelmetData["context"];
52
56
  context: StaticHandlerContext;
53
57
  queryClient: QueryClient;
54
58
  router: ReturnType<typeof createStaticRouter>;
59
+ bypassProtection?: boolean;
55
60
  }) => (
56
61
  <StrictMode>
57
62
  <QueryClientProvider client={queryClient}>
58
63
  <HelmetProvider context={helmetContext}>
59
- <StaticRouterProvider router={router} context={context} />
64
+ <BypassProtectedRoutesContext value={bypassProtection}>
65
+ <StaticRouterProvider router={router} context={context} />
66
+ </BypassProtectedRoutesContext>
60
67
  </HelmetProvider>
61
68
  </QueryClientProvider>
62
69
  </StrictMode>
@@ -69,7 +69,7 @@ export const Header = memo(function HeaderInner() {
69
69
  <header className="sticky lg:top-0 z-10 bg-background/80 backdrop-blur w-full">
70
70
  <Banner />
71
71
  <div className="border-b">
72
- <div className="max-w-screen-2xl 2xl:border-x mx-auto flex relative items-center justify-between px-4 lg:px-8 h-[--top-header-height]">
72
+ <div className="max-w-screen-2xl mx-auto flex relative items-center justify-between px-4 lg:px-8 h-[--top-header-height] border-transparent">
73
73
  <div className="flex">
74
74
  <Link to="/">
75
75
  <div className="flex items-center gap-3.5">
@@ -182,7 +182,7 @@ export const Header = memo(function HeaderInner() {
182
182
  </div>
183
183
  </div>
184
184
  <div className="border-b hidden lg:block">
185
- <div className="max-w-screen-2xl mx-auto 2xl:border-x">
185
+ <div className="max-w-screen-2xl mx-auto border-transparent">
186
186
  <Slotlet name="top-navigation-before" />
187
187
  <TopNavigation />
188
188
  <Slotlet name="top-navigation-after" />
@@ -53,7 +53,7 @@ export const Layout = ({ children }: { children?: ReactNode }) => {
53
53
  <Header />
54
54
  <Slotlet name="layout-after-head" />
55
55
 
56
- <div className="grid grid-cols-1 grid-rows-[min-content_1fr] lg:grid-cols-[var(--side-nav-width)_1fr] max-w-screen-2xl w-full lg:mx-auto px-4 lg:px-8 2xl:border-x">
56
+ <div className="grid grid-cols-1 grid-rows-[0_min-content_1fr] lg:grid-rows-[min-content_1fr] lg:grid-cols-[var(--side-nav-width)_1fr] max-w-screen-2xl w-full lg:mx-auto">
57
57
  <Suspense fallback={<LoadingFallback />}>
58
58
  <Main>{children ?? <Outlet />}</Main>
59
59
  </Suspense>
@@ -27,7 +27,7 @@ export const Main = ({ children }: PropsWithChildren) => {
27
27
  )}
28
28
  {hasSidebar && (
29
29
  <div className="lg:hidden -mx-4 px-4 py-2 sticky bg-background/80 backdrop-blur z-10 top-0 left-0 right-0 border-b">
30
- <DrawerTrigger className="flex items-center gap-2">
30
+ <DrawerTrigger className="flex items-center gap-2 px-4">
31
31
  <PanelLeftIcon size={16} strokeWidth={1.5} />
32
32
  <span className="text-sm">Menu</span>
33
33
  </DrawerTrigger>
@@ -36,7 +36,8 @@ export const Main = ({ children }: PropsWithChildren) => {
36
36
  <main
37
37
  data-pagefind-body
38
38
  className={cn(
39
- hasSidebar ? "lg:pl-12" : "col-span-full",
39
+ "px-4 lg:pe-8 lg:px-8",
40
+ !hasSidebar && "col-span-full",
40
41
  isNavigating && "animate-pulse",
41
42
  )}
42
43
  >
@@ -9,12 +9,13 @@ import {
9
9
  DrawerTrigger,
10
10
  } from "../ui/Drawer.js";
11
11
  import { useZudoku } from "./context/ZudokuContext.js";
12
+ import { PoweredByZudoku } from "./navigation/PoweredByZudoku.js";
12
13
  import { Search } from "./Search.js";
13
14
  import { ThemeSwitch } from "./ThemeSwitch.js";
14
- import { isHiddenItem, TopNavItem } from "./TopNavigation.js";
15
+ import { isHiddenItem, PageProgress, TopNavItem } from "./TopNavigation.js";
15
16
 
16
17
  export const MobileTopNavigation = () => {
17
- const { topNavigation } = useZudoku();
18
+ const { topNavigation, options } = useZudoku();
18
19
  const { isAuthenticated } = useAuth();
19
20
  const [drawerOpen, setDrawerOpen] = useState(false);
20
21
 
@@ -28,28 +29,36 @@ export const MobileTopNavigation = () => {
28
29
  <DrawerTrigger className="lg:hidden">
29
30
  <MenuIcon size={22} />
30
31
  </DrawerTrigger>
32
+ <PageProgress />
31
33
  </div>
32
34
  <DrawerContent
33
35
  className="lg:hidden h-[100dvh] right-0 left-auto w-[320px] rounded-none"
34
36
  aria-describedby={undefined}
35
37
  >
36
- <div className="p-4 overflow-y-auto overscroll-none">
37
- <VisuallyHidden>
38
- <DrawerTitle>Navigation</DrawerTitle>
39
- </VisuallyHidden>
40
- <Search className="flex p-4" />
41
- <ul className="flex flex-col items-center gap-4 p-4">
42
- <li>
43
- <ThemeSwitch />
44
- </li>
45
- {topNavigation.filter(isHiddenItem(isAuthenticated)).map((item) => (
46
- <li key={item.label}>
47
- <button type="button" onClick={() => setDrawerOpen(false)}>
48
- <TopNavItem {...item} />
49
- </button>
38
+ <div className="p-4 overflow-y-auto overscroll-none h-full flex flex-col justify-between">
39
+ <div>
40
+ <VisuallyHidden>
41
+ <DrawerTitle>Navigation</DrawerTitle>
42
+ </VisuallyHidden>
43
+ <Search className="flex p-4" />
44
+ <ul className="flex flex-col items-center gap-4 p-4">
45
+ <li>
46
+ <ThemeSwitch />
50
47
  </li>
51
- ))}
52
- </ul>
48
+ {topNavigation
49
+ .filter(isHiddenItem(isAuthenticated))
50
+ .map((item) => (
51
+ <li key={item.label}>
52
+ <button type="button" onClick={() => setDrawerOpen(false)}>
53
+ <TopNavItem {...item} />
54
+ </button>
55
+ </li>
56
+ ))}
57
+ </ul>
58
+ </div>
59
+ {options.page?.showPoweredBy !== false && (
60
+ <PoweredByZudoku className="flex-grow-0 justify-center gap-1" />
61
+ )}
53
62
  </div>
54
63
  </DrawerContent>
55
64
  </Drawer>
@@ -21,7 +21,7 @@ export const isHiddenItem =
21
21
  );
22
22
  };
23
23
 
24
- const Progress = () => {
24
+ export const PageProgress = () => {
25
25
  const navigation = useNavigation();
26
26
  const isNavigating = navigation.state === "loading";
27
27
  // delay the animation to avoid flickering
@@ -69,8 +69,8 @@ export const TopNavigation = () => {
69
69
  </ul>
70
70
  </nav>
71
71
  <Slotlet name="top-navigation-side" />
72
- <Progress />
73
72
  </div>
73
+ <PageProgress />
74
74
  </Suspense>
75
75
  );
76
76
  };
@@ -30,6 +30,8 @@ import { ViewportAnchorProvider } from "./context/ViewportAnchorContext.js";
30
30
  import { ZudokuProvider } from "./context/ZudokuProvider.js";
31
31
  import { SlotletProvider } from "./SlotletProvider.js";
32
32
 
33
+ let zudokuContext: ZudokuContext | undefined;
34
+
33
35
  const ZudokoInner = memo(
34
36
  ({ children, ...props }: PropsWithChildren<ZudokuContextOptions>) => {
35
37
  const components = useMemo(
@@ -70,9 +72,9 @@ const ZudokoInner = memo(
70
72
  setDidNavigate(true);
71
73
  }, [didNavigate, navigation.location]);
72
74
 
73
- const [zudokuContext] = useState(
74
- () => new ZudokuContext(props, queryClient),
75
- );
75
+ if (!zudokuContext) {
76
+ zudokuContext = new ZudokuContext(props, queryClient);
77
+ }
76
78
 
77
79
  const heads = props.plugins
78
80
  ?.flatMap((plugin) =>
@@ -0,0 +1,3 @@
1
+ import { createContext } from "react";
2
+
3
+ export const BypassProtectedRoutesContext = createContext(false);
@@ -0,0 +1,23 @@
1
+ import { ChevronRightIcon } from "lucide-react";
2
+ import { cn } from "../../util/cn.js";
3
+ import ZudokuLogo from "./ZudokuLogo.js";
4
+
5
+ export const PoweredByZudoku = ({ className }: { className?: string }) => (
6
+ <a
7
+ href="https://zudoku.dev"
8
+ target="_blank"
9
+ rel="noopener noreferrer"
10
+ className={cn(
11
+ "flex justify-between items-center w-full border border-transparent hover:border-border rounded-full hover:shadow-sm h-7 px-3 text-nowrap hover:bg-muted/80 transition-all",
12
+ className,
13
+ )}
14
+ >
15
+ <div className="opacity-70 hover:opacity-100 transition-opacity gap-1.5 text-[11px] font-medium rounded-full h-7 flex items-center text-nowrap">
16
+ <ZudokuLogo className="w-3.5 h-3.5 dark:fill-white" />
17
+ powered by Zudoku
18
+ </div>
19
+ <div className="text-xs font-medium opacity-70 hover:text-foreground transition-colors cursor-pointer">
20
+ <ChevronRightIcon size={12} absoluteStrokeWidth strokeWidth={1.5} />
21
+ </div>
22
+ </a>
23
+ );
@@ -1,5 +1,7 @@
1
1
  import { type PropsWithChildren, type Ref } from "react";
2
2
  import { cn } from "../../util/cn.js";
3
+ import { useZudoku } from "../context/ZudokuContext.js";
4
+ import { PoweredByZudoku } from "./PoweredByZudoku.js";
3
5
 
4
6
  export const SidebarWrapper = ({
5
7
  children,
@@ -8,18 +10,30 @@ export const SidebarWrapper = ({
8
10
  }: PropsWithChildren<{
9
11
  className?: string;
10
12
  ref?: Ref<HTMLDivElement>;
11
- }>) => (
12
- <nav
13
- className={cn(
14
- "hidden lg:flex h-full scrollbar flex-col overflow-y-auto shrink-0 text-sm border-r pr-6",
15
- "sticky top-[--header-height] h-[calc(100vh-var(--header-height))]",
16
- "-mx-[--padding-nav-item] max-w-[--side-nav-width] pb-6 pt-[--padding-content-top] scroll-pt-2 gap-2",
17
- className,
18
- )}
19
- ref={ref}
20
- >
21
- {children}
22
- </nav>
23
- );
13
+ }>) => {
14
+ const { options } = useZudoku();
15
+
16
+ return (
17
+ <div className="grid sticky top-[--header-height] lg:h-[calc(100vh-var(--header-height))] grid-rows-[1fr_min-content] border-r">
18
+ <nav
19
+ className={cn(
20
+ "hidden max-w-[calc(var(--side-nav-width)+var(--padding-nav-item))] lg:flex scrollbar flex-col overflow-y-auto shrink-0 text-sm pe-3 ps-4 lg:ps-8",
21
+ "-mx-[--padding-nav-item] pb-6 pt-[--padding-content-top] scroll-pt-2 gap-1",
22
+ className,
23
+ )}
24
+ style={{
25
+ maskImage: `linear-gradient(180deg, transparent 1%, rgba(0, 0, 0, 1) 20px, rgba(0, 0, 0, 1) 90%, transparent 99%)`,
26
+ }}
27
+ ref={ref}
28
+ >
29
+ {children}
30
+ </nav>
31
+
32
+ <div className="bg-background border-t p-2 mx-5 gap-2 items-center mt-2 drop-shadow-[0_-3px_1px_rgba(0,0,0,0.015)] hidden lg:[&:has(>_:nth-child(1):last-child)]:flex">
33
+ {options.page?.showPoweredBy !== false && <PoweredByZudoku />}
34
+ </div>
35
+ </div>
36
+ );
37
+ };
24
38
 
25
39
  SidebarWrapper.displayName = "SidebarWrapper";
@@ -0,0 +1,25 @@
1
+ import * as React from "react";
2
+
3
+ const ZudokuLogo = (props: React.SVGProps<SVGSVGElement>) => (
4
+ <svg
5
+ xmlns="http://www.w3.org/2000/svg"
6
+ viewBox="0 0 132 100"
7
+ fill="none"
8
+ {...props}
9
+ >
10
+ <path
11
+ fill="currentColor"
12
+ fillRule="evenodd"
13
+ d="M80.092 2.963A4.66 4.66 0 0 1 84.449 0h34.049c6.325 0 10.835 6.135 8.948 12.172L116.653 46.71a4.688 4.688 0 0 1-4.474 3.29H75c-5.178 0-7.813 4.687-9.375 9.374-1.288 3.864-11.07 28.963-14.467 37.662A4.66 4.66 0 0 1 46.801 100H12.75c-6.324 0-10.834-6.134-8.947-12.171l10.793-34.54A4.688 4.688 0 0 1 19.071 50H56.25c5.178 0 7.813-4.687 9.375-9.375 1.288-3.864 11.07-28.962 14.467-37.662Z"
14
+ clipRule="evenodd"
15
+ />
16
+ <path
17
+ fill="currentColor"
18
+ d="M83.54 57.813a7.813 7.813 0 0 0-7.316 5.07L63.888 95.777c-.766 2.043.744 4.222 2.926 4.222h36.828c5.211 0 9.875-3.232 11.704-8.11l8.821-23.522c1.915-5.107-1.861-10.555-7.315-10.555H83.539ZM29.17 0a12.5 12.5 0 0 0-11.704 8.111l-8.82 23.521c-1.915 5.107 1.86 10.556 7.315 10.556h33.312a7.813 7.813 0 0 0 7.316-5.07L68.924 4.223C69.691 2.18 68.18 0 65.998 0H29.17Z"
19
+ />
20
+ </svg>
21
+ );
22
+
23
+ ZudokuLogo.displayName = "ZudokuLogo";
24
+
25
+ export default ZudokuLogo;
@@ -1,4 +1,6 @@
1
1
  import { useQuery } from "@tanstack/react-query";
2
+ import { Helmet } from "@zudoku/react-helmet-async";
3
+ import { use } from "react";
2
4
  import { matchPath, Outlet, useLocation, useNavigate } from "react-router";
3
5
  import {
4
6
  Dialog,
@@ -8,21 +10,28 @@ import {
8
10
  DialogTitle,
9
11
  } from "zudoku/ui/Dialog.js";
10
12
  import { useAuth } from "../authentication/hook.js";
13
+ import { BypassProtectedRoutesContext } from "../components/context/BypassProtectedRoutesContext.js";
11
14
  import { useZudoku } from "../components/context/ZudokuContext.js";
12
15
  import { ZudokuError } from "../util/invariant.js";
13
16
  import { useLatest } from "../util/useLatest.js";
14
17
 
18
+ export const SEARCH_PROTECTED_SECTION = "protected";
19
+
15
20
  export const RouteGuard = () => {
16
21
  const auth = useAuth();
17
22
  const zudoku = useZudoku();
18
23
  const navigate = useNavigate();
19
24
  const location = useLocation();
20
25
  const latestPath = useLatest(location.pathname);
26
+ const shouldBypass = use(BypassProtectedRoutesContext);
27
+
21
28
  const { protectedRoutes = [] } = zudoku.options;
22
29
 
23
- const isProtected = protectedRoutes.some((path) =>
24
- matchPath({ path, end: true }, location.pathname),
25
- );
30
+ const isProtected =
31
+ !shouldBypass &&
32
+ protectedRoutes.some((path) =>
33
+ matchPath({ path, end: true }, location.pathname),
34
+ );
26
35
 
27
36
  useQuery({
28
37
  queryKey: ["login-redirect"],
@@ -70,5 +79,18 @@ export const RouteGuard = () => {
70
79
  });
71
80
  }
72
81
 
73
- return <Outlet />;
82
+ return (
83
+ <>
84
+ {shouldBypass && (
85
+ <Helmet>
86
+ <meta
87
+ name="pagefind"
88
+ data-pagefind-filter={`section:${SEARCH_PROTECTED_SECTION}`}
89
+ content="true"
90
+ />
91
+ </Helmet>
92
+ )}
93
+ <Outlet />
94
+ </>
95
+ );
74
96
  };
@@ -52,6 +52,7 @@ type Metadata = Partial<{
52
52
  }>;
53
53
 
54
54
  type Page = Partial<{
55
+ showPoweredBy: boolean;
55
56
  pageTitle?: string;
56
57
  logo?: {
57
58
  src: {
@@ -24,10 +24,12 @@ export const LogicalGroupConnector = ({
24
24
  type,
25
25
  isOpen,
26
26
  className,
27
+ schemeName,
27
28
  }: {
28
29
  type: LogicalGroupType;
29
30
  isOpen: boolean;
30
31
  className?: string;
32
+ schemeName?: string;
31
33
  }) => {
32
34
  return (
33
35
  <div
@@ -48,6 +50,7 @@ export const LogicalGroupConnector = ({
48
50
  >
49
51
  <ChevronDownIcon size={16} />
50
52
  </div>
53
+ <span className="text-sm text-foreground">{schemeName}</span>
51
54
  </div>
52
55
  </div>
53
56
  );
@@ -18,7 +18,11 @@ export const LogicalGroupItem = (props: {
18
18
  className="group"
19
19
  >
20
20
  <Collapsible.Trigger>
21
- <LogicalGroupConnector type={props.type} isOpen={isOpen} />
21
+ <LogicalGroupConnector
22
+ type={props.type}
23
+ isOpen={isOpen}
24
+ schemeName={props.schema.title}
25
+ />
22
26
  </Collapsible.Trigger>
23
27
  {!isOpen && <div className="wavy-line bg-border translate-y-1" />}
24
28
  <Collapsible.Content>
@@ -11,6 +11,7 @@ import {
11
11
  import { DialogTitle } from "zudoku/ui/Dialog.js";
12
12
  import { useAuthState } from "../../authentication/state.js";
13
13
  import { useZudoku } from "../../components/context/ZudokuContext.js";
14
+ import { SEARCH_PROTECTED_SECTION } from "../../core/RouteGuard.js";
14
15
  import { joinUrl } from "../../util/joinUrl.js";
15
16
  import { getResults } from "./get-results.js";
16
17
  import type { PagefindOptions } from "./index.js";
@@ -35,11 +36,14 @@ const importPagefind = (basePath?: string): Promise<Pagefind> =>
35
36
  : import(/* @vite-ignore */ joinUrl(basePath, "/pagefind/pagefind.js"));
36
37
 
37
38
  const usePagefind = (options: PagefindOptions) => {
39
+ const {
40
+ options: { basePath },
41
+ } = useZudoku();
38
42
  const { data: pagefind, ...result } = useQuery<Pagefind>({
39
43
  queryKey: ["pagefind", options.ranking],
40
44
  retry: false,
41
45
  queryFn: async () => {
42
- const pagefind = await importPagefind(options.basePath);
46
+ const pagefind = await importPagefind(basePath);
43
47
  await pagefind.init();
44
48
  await pagefind.options({
45
49
  ranking: {
@@ -82,9 +86,13 @@ export const PagefindSearch = ({
82
86
  const inputRef = useRef<HTMLInputElement>(null);
83
87
 
84
88
  const { data: searchResults } = useQuery({
85
- queryKey: ["pagefind-search", searchTerm],
89
+ queryKey: ["pagefind-search", searchTerm, auth.isAuthenticated],
86
90
  queryFn: async () => {
87
- const search = await pagefind?.search(searchTerm);
91
+ const filters = auth.isAuthenticated
92
+ ? undefined
93
+ : { not: { section: SEARCH_PROTECTED_SECTION } };
94
+
95
+ const search = await pagefind?.search(searchTerm, { filters });
88
96
  if (!search) return [];
89
97
  return getResults({ search, options, auth, context });
90
98
  },
@@ -145,7 +153,6 @@ export const PagefindSearch = ({
145
153
  </div>
146
154
  ) : (
147
155
  <ResultList
148
- basePath={options.basePath}
149
156
  searchResults={searchResults ?? []}
150
157
  searchTerm={searchTerm}
151
158
  onClose={onClose}
@@ -1,5 +1,5 @@
1
1
  import { BracketsIcon, FileTextIcon } from "lucide-react";
2
- import { useCallback, useLayoutEffect, useRef } from "react";
2
+ import { useLayoutEffect, useRef } from "react";
3
3
  import { Link, useNavigate } from "react-router";
4
4
  import { CommandGroup, CommandItem, CommandList } from "zudoku/ui/Command.js";
5
5
  import {
@@ -22,7 +22,6 @@ const sortSubResults = (a: PagefindSubResult, b: PagefindSubResult) => {
22
22
  const hoverClassname = `cursor-pointer border border-transparent data-[selected=true]:border-border`;
23
23
 
24
24
  export const ResultList = ({
25
- basePath,
26
25
  searchResults,
27
26
  searchTerm,
28
27
  onClose,
@@ -37,16 +36,6 @@ export const ResultList = ({
37
36
  const navigate = useNavigate();
38
37
  const commandListRef = useRef<HTMLDivElement | null>(null);
39
38
 
40
- const cleanResultUrl = useCallback(
41
- (url: string) => {
42
- const clean = url.replace(".html", "");
43
- return basePath && clean.startsWith(basePath)
44
- ? clean.slice(basePath.length)
45
- : clean;
46
- },
47
- [basePath],
48
- );
49
-
50
39
  useLayoutEffect(() => {
51
40
  requestIdleCallback(() => {
52
41
  commandListRef.current?.scrollTo({ top: 0 });
@@ -71,11 +60,11 @@ export const ResultList = ({
71
60
  value={`${result.meta.title}-${result.url}`}
72
61
  className={hoverClassname}
73
62
  onSelect={() => {
74
- void navigate(cleanResultUrl(result.url));
63
+ void navigate(result.url);
75
64
  onClose();
76
65
  }}
77
66
  >
78
- <Link to={cleanResultUrl(result.url)}>
67
+ <Link to={result.url}>
79
68
  {result.meta.section === "openapi" ? (
80
69
  <BracketsIcon />
81
70
  ) : (
@@ -94,11 +83,11 @@ export const ResultList = ({
94
83
  value={`sub-${result.meta.title}-${subResult.url}`}
95
84
  className={hoverClassname}
96
85
  onSelect={() => {
97
- void navigate(cleanResultUrl(subResult.url));
86
+ void navigate(subResult.url);
98
87
  onClose();
99
88
  }}
100
89
  >
101
- <Link to={cleanResultUrl(subResult.url)} onClick={onClose}>
90
+ <Link to={subResult.url} onClick={onClose}>
102
91
  <div className="flex flex-col items-start gap-2 ms-2.5 ps-5 border-l border-muted-foreground/50">
103
92
  <span className="font-bold">{subResult.title}</span>
104
93
  <span
@@ -6,7 +6,7 @@ import { PagefindSearch } from "./PagefindSearch.js";
6
6
  export type PagefindOptions = Extract<
7
7
  ZudokuConfig["search"],
8
8
  { type: "pagefind" }
9
- > & { basePath?: string };
9
+ >;
10
10
 
11
11
  export const pagefindSearchPlugin = (
12
12
  options: PagefindOptions,
@@ -1,3 +0,0 @@
1
- export declare const pagefindCommand: (argv: {
2
- forceBuild: boolean;
3
- }) => Promise<void>;
@@ -1,59 +0,0 @@
1
- import { glob } from "glob";
2
- import fs from "node:fs/promises";
3
- import path from "node:path";
4
- import colors from "picocolors";
5
- import { runBuild } from "../../vite/build.js";
6
- import { loadZudokuConfig } from "../../vite/config.js";
7
- import { createPagefindIndex } from "../../vite/create-pagefind-index.js";
8
- import { writeLine } from "../../vite/reporter.js";
9
- import { logger } from "../common/logger.js";
10
- const captureOutput = async (fn) => {
11
- const stdout = process.stdout.write;
12
- const stderr = process.stderr.write;
13
- process.stdout.write = () => true;
14
- process.stderr.write = () => true;
15
- try {
16
- return await fn();
17
- }
18
- finally {
19
- process.stdout.write = stdout;
20
- process.stderr.write = stderr;
21
- }
22
- };
23
- export const pagefindCommand = async (argv) => {
24
- const dir = process.cwd();
25
- const dist = path.join(dir, "dist");
26
- const { config } = await loadZudokuConfig({ mode: "production", command: "build" }, dir);
27
- if (config.search?.type !== "pagefind") {
28
- logger.warn(colors.yellow("Search is not configured to use pagefind."));
29
- }
30
- const message = argv.forceBuild
31
- ? "creating build and pagefind index..."
32
- : "building pagefind index...";
33
- writeLine(colors.blue(message));
34
- if (argv.forceBuild) {
35
- await captureOutput(() => runBuild({ dir }));
36
- }
37
- const outputPath = await createPagefindIndex({
38
- dir: dist,
39
- outDir: path.join(process.cwd(), "public"),
40
- });
41
- const successMessage = argv.forceBuild
42
- ? `✓ build created and pagefind index written to ${outputPath}`
43
- : `✓ pagefind index written to ${outputPath}`;
44
- writeLine(colors.blue(successMessage));
45
- // find pagefind directory in dist with glob
46
- const pagefindGlob = await glob("**/pagefind/", {
47
- cwd: dist,
48
- absolute: true,
49
- });
50
- const pagefindDir = pagefindGlob.at(0);
51
- if (!pagefindDir) {
52
- throw new Error(`pagefind directory not found in ${dist}.`);
53
- }
54
- // move from dist to public dir so it can be consumed in dev
55
- const publicDir = path.join(dir, "public/pagefind");
56
- await fs.rm(publicDir, { recursive: true, force: true });
57
- await fs.rename(pagefindDir, publicDir);
58
- };
59
- //# sourceMappingURL=pagefind-command.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"pagefind-command.js","sourceRoot":"","sources":["../../../src/cli/dev/pagefind-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,MAAM,MAAM,YAAY,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAE7C,MAAM,aAAa,GAAG,KAAK,EAAK,EAAoB,EAAc,EAAE;IAClE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;IACpC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;IACpC,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;IAClC,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;IAClC,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,EAAE,CAAC;IACpB,CAAC;YAAS,CAAC;QACT,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;QAC9B,OAAO,CAAC,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC;IAChC,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,IAA6B,EAAE,EAAE;IACrE,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAEpC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,gBAAgB,CACvC,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,EACxC,GAAG,CACJ,CAAC;IAEF,IAAI,MAAM,CAAC,MAAM,EAAE,IAAI,KAAK,UAAU,EAAE,CAAC;QACvC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,2CAA2C,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU;QAC7B,CAAC,CAAC,sCAAsC;QACxC,CAAC,CAAC,4BAA4B,CAAC;IACjC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAEhC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,MAAM,aAAa,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,mBAAmB,CAAC;QAC3C,GAAG,EAAE,IAAI;QACT,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC;KAC3C,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU;QACpC,CAAC,CAAC,iDAAiD,UAAU,EAAE;QAC/D,CAAC,CAAC,+BAA+B,UAAU,EAAE,CAAC;IAEhD,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;IAEvC,4CAA4C;IAC5C,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE;QAC9C,GAAG,EAAE,IAAI;QACT,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,IAAI,GAAG,CAAC,CAAC;IAC9D,CAAC;IAED,4DAA4D;IAC5D,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;IAEpD,MAAM,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,MAAM,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;AAC1C,CAAC,CAAC"}
@@ -1 +0,0 @@
1
- export {};
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=PluginSystem.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"PluginSystem.js","sourceRoot":"","sources":["../../../../src/lib/components/context/PluginSystem.ts"],"names":[],"mappings":""}