@umami/shiso 0.55.0 → 1.0.0

package/src/components/ui/tooltip.tsx

@@ -0,0 +1,52 @@
+import { Tooltip as TooltipPrimitive } from '@base-ui/react/tooltip';
+
+import { cn } from '@/lib/utils';
+
+function TooltipProvider({ delay = 0, ...props }: TooltipPrimitive.Provider.Props) {
+  return <TooltipPrimitive.Provider data-slot="tooltip-provider" delay={delay} {...props} />;
+}
+
+function Tooltip({ ...props }: TooltipPrimitive.Root.Props) {
+  return <TooltipPrimitive.Root data-slot="tooltip" {...props} />;
+}
+
+function TooltipTrigger({ ...props }: TooltipPrimitive.Trigger.Props) {
+  return <TooltipPrimitive.Trigger data-slot="tooltip-trigger" {...props} />;
+}
+
+function TooltipContent({
+  className,
+  side = 'top',
+  sideOffset = 4,
+  align = 'center',
+  alignOffset = 0,
+  children,
+  ...props
+}: TooltipPrimitive.Popup.Props &
+  Pick<TooltipPrimitive.Positioner.Props, 'align' | 'alignOffset' | 'side' | 'sideOffset'>) {
+  return (
+    <TooltipPrimitive.Portal>
+      <TooltipPrimitive.Positioner
+        align={align}
+        alignOffset={alignOffset}
+        side={side}
+        sideOffset={sideOffset}
+        className="isolate z-50"
+      >
+        <TooltipPrimitive.Popup
+          data-slot="tooltip-content"
+          className={cn(
+            'z-50 inline-flex w-fit max-w-xs origin-(--transform-origin) items-center gap-1.5 rounded-md bg-foreground px-3 py-1.5 text-sm text-background has-data-[slot=kbd]:pr-1.5 data-[side=bottom]:slide-in-from-top-2 data-[side=inline-end]:slide-in-from-left-2 data-[side=inline-start]:slide-in-from-right-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 **:data-[slot=kbd]:relative **:data-[slot=kbd]:isolate **:data-[slot=kbd]:z-50 **:data-[slot=kbd]:rounded-sm data-[state=delayed-open]:animate-in data-[state=delayed-open]:fade-in-0 data-[state=delayed-open]:zoom-in-95 data-open:animate-in data-open:fade-in-0 data-open:zoom-in-95 data-closed:animate-out data-closed:fade-out-0 data-closed:zoom-out-95',
+            className,
+          )}
+          {...props}
+        >
+          {children}
+          <TooltipPrimitive.Arrow className="z-50 size-2.5 translate-y-[calc(-50%-2px)] rotate-45 rounded-[2px] bg-foreground fill-foreground data-[side=bottom]:top-1 data-[side=inline-end]:top-1/2! data-[side=inline-end]:-left-1 data-[side=inline-end]:-translate-y-1/2 data-[side=inline-start]:top-1/2! data-[side=inline-start]:-right-1 data-[side=inline-start]:-translate-y-1/2 data-[side=left]:top-1/2! data-[side=left]:-right-1 data-[side=left]:-translate-y-1/2 data-[side=right]:top-1/2! data-[side=right]:-left-1 data-[side=right]:-translate-y-1/2 data-[side=top]:-bottom-2.5" />
+        </TooltipPrimitive.Popup>
+      </TooltipPrimitive.Positioner>
+    </TooltipPrimitive.Portal>
+  );
+}
+
+export { Tooltip, TooltipContent, TooltipProvider, TooltipTrigger };

package/src/declarations.d.ts

@@ -0,0 +1,9 @@
+declare module 'recursive-readdir';
+declare module '*.json';
+
+declare module 'virtual:shiso-docs-config' {
+  import type { DocsConfig } from '@/lib/types';
+
+  const config: DocsConfig;
+  export default config;
+}

package/src/entry-client.tsx

@@ -0,0 +1,17 @@
+import { hydrateRoot } from 'react-dom/client';
+import { BrowserRouter } from 'react-router';
+import { App } from '@/App';
+import { BASE_URL } from '@/lib/paths';
+
+export function mount(element: HTMLElement | null = document.getElementById('root')) {
+  if (!element) {
+    throw new Error('Shiso could not find the root element.');
+  }
+
+  return hydrateRoot(
+    element,
+    <BrowserRouter basename={BASE_URL || undefined}>
+      <App />
+    </BrowserRouter>,
+  );
+}

package/src/entry-server.tsx

@@ -0,0 +1,89 @@
+import { renderToString } from 'react-dom/server';
+import { StaticRouter } from 'react-router';
+import { App } from '@/App';
+import { getDocModule, getLastModified } from '@/lib/content';
+import { getScopeForPage } from '@/lib/docs-config';
+import { buildHead, renderHeadToString } from '@/lib/head';
+import { BASE_URL, toAbsoluteUrl } from '@/lib/paths';
+import {
+  docsHomeUrl,
+  docsSite,
+  getLocaleByPathname,
+  getRedirects,
+  getSeo,
+  siteName,
+} from '@/lib/site-config';
+
+export interface RenderResult {
+  html: string;
+  head: string;
+  /** Attributes for the document element: language and text direction. */
+  htmlAttrs: { lang: string; dir: 'ltr' | 'rtl' };
+}
+
+export interface SitemapEntry {
+  url: string;
+  lastmod?: string;
+}
+
+/** Base-relative routes for every scope. The prerenderer prepends the deploy base itself. */
+export function getRoutes(): string[] {
+  return docsSite.pages.map(page => page.url);
+}
+
+/** Redirect rules with exact-match sources, for static redirect pages. */
+export { getRedirects };
+
+/**
+ * Source file for every routed page, so the prerenderer can publish raw
+ * markdown next to each HTML page (used by the contextual menu's copy/view
+ * options and by AI tools). `filePath` is a module key like
+ * "/content/docs/index.mdx", resolved against the project root.
+ */
+export function getMarkdownPages(): { route: string; filePath: string }[] {
+  return docsSite.pages.map(page => ({ route: page.url, filePath: page.filePath }));
+}
+
+/**
+ * Absolute URLs for the sitemap, honoring `seo.indexing` and per-page
+ * noindex. Empty when `$shiso.siteUrl` is not configured, since a sitemap
+ * of relative URLs is invalid.
+ */
+export function getSitemapEntries(): SitemapEntry[] {
+  const { indexing } = getSeo();
+  const entries: SitemapEntry[] = [];
+
+  for (const page of docsSite.pages) {
+    // Hidden pages and pages of hidden scopes (versions/languages) stay out
+    // of the sitemap unless `seo.indexing: "all"` opts them in.
+    if ((page.hidden || getScopeForPage(docsSite, page).hidden) && indexing !== 'all') {
+      continue;
+    }
+
+    if (getDocModule(page.filePath)?.frontmatter?.noindex === true) {
+      continue;
+    }
+
+    const url = toAbsoluteUrl(page.url);
+
+    if (url) {
+      entries.push({ url, lastmod: getLastModified(page.filePath) });
+    }
+  }
+
+  return entries;
+}
+
+export function render(url: string): RenderResult {
+  // basename must match the client's BrowserRouter, or every <Link> in the
+  // prerendered HTML would omit the deploy base and mismatch on hydration.
+  const html = renderToString(
+    <StaticRouter basename={BASE_URL || undefined} location={`${BASE_URL}${url}`}>
+      <App />
+    </StaticRouter>,
+  );
+
+  return { html, head: renderHeadToString(buildHead(url)), htmlAttrs: getLocaleByPathname(url) };
+}
+
+export { docsHomeUrl, siteName };

package/src/generated/last-modified.ts

@@ -0,0 +1,2 @@
+// Build-time alias target. Shiso replaces this module with project timestamps.
+export const LAST_MODIFIED: Record<string, string> = {};

package/src/lib/content.ts

@@ -0,0 +1,44 @@
+import { LAST_MODIFIED } from '@/generated/last-modified';
+import { CONTENT_DIR } from '@/lib/paths';
+import type { DocModule } from '@/lib/types';
+
+/**
+ * Eagerly imports every content file at build time. Each module exports:
+ * - default: the compiled MDX component
+ * - frontmatter: parsed YAML frontmatter
+ * - toc: heading anchors injected by the remark-toc plugin
+ *
+ * Eager loading keeps server prerendering and client hydration in sync
+ * without Suspense, at the cost of bundling all pages together.
+ *
+ * The glob pattern must be a literal for Vite to statically analyze it, so it
+ * covers all of `content/` and the configured `$shiso.contentDir` is applied at
+ * lookup time instead. That also lets later versioned/localized content roots
+ * (`content/v2`, `content/es`) work without touching this glob.
+ */
+export const docModules = import.meta.glob('/content/**/*.{md,mdx}', {
+  eager: true,
+}) as Record<string, DocModule>;
+
+/**
+ * Resolves a docs.json page reference (e.g. "components/tabs") to a module
+ * key (e.g. "/content/docs/components/tabs.mdx"). Returns undefined when the
+ * file does not exist, which makes config normalization fail at startup/build.
+ */
+export function resolveDocFile(fileSlug: string, contentDir = CONTENT_DIR): string | undefined {
+  const candidates = [`/${contentDir}/${fileSlug}.mdx`, `/${contentDir}/${fileSlug}.md`];
+  return candidates.find(candidate => candidate in docModules);
+}
+
+export function getDocModule(filePath: string): DocModule | undefined {
+  return docModules[filePath];
+}
+
+/**
+ * Last-modified date of a content file, captured from git history at build
+ * time (see scripts/generate-last-modified.mjs). ISO 8601, or undefined for
+ * files outside the generated map.
+ */
+export function getLastModified(filePath: string): string | undefined {
+  return LAST_MODIFIED[filePath];
+}