@takazudo/zudo-doc 0.2.21 → 1.0.0

package/dist/design-token-panel-bootstrap.js

@@ -0,0 +1,29 @@
+import { configurePanel, setLifecycleAdapter } from "@takazudo/zdtp";
+import {
+  BEFORE_NAVIGATE_EVENT,
+  AFTER_NAVIGATE_EVENT
+} from "./transitions/page-events.js";
+function bootstrapDesignTokenPanel(panelConfig) {
+  configurePanel(panelConfig);
+  if (typeof window !== "undefined") {
+    window.__zdtpReadyClicks?.();
+  }
+  if (typeof document !== "undefined") {
+    const adapter = {
+      onBeforeSwap(cb) {
+        const handler = () => cb();
+        document.addEventListener(BEFORE_NAVIGATE_EVENT, handler);
+        return () => document.removeEventListener(BEFORE_NAVIGATE_EVENT, handler);
+      },
+      onPageLoad(cb) {
+        const handler = () => cb();
+        document.addEventListener(AFTER_NAVIGATE_EVENT, handler);
+        return () => document.removeEventListener(AFTER_NAVIGATE_EVENT, handler);
+      }
+    };
+    setLifecycleAdapter(adapter);
+  }
+}
+export {
+  bootstrapDesignTokenPanel
+};

package/dist/desktop-sidebar-toggle-island/index.d.ts

@@ -0,0 +1,5 @@
+export declare const SIDEBAR_STORAGE_KEY = "zudo-doc-sidebar-visible";
+export declare function DesktopSidebarToggle(): import("preact").JSX.Element;
+export declare namespace DesktopSidebarToggle {
+    var displayName: string;
+}

package/dist/desktop-sidebar-toggle-island/index.js

@@ -0,0 +1,62 @@
+"use client";
+import { jsx } from "preact/jsx-runtime";
+import { useState, useEffect, useRef } from "preact/hooks";
+import { ChevronRight, ChevronLeft } from "../icons/index.js";
+import { AFTER_NAVIGATE_EVENT } from "../transitions/index.js";
+const SIDEBAR_STORAGE_KEY = "zudo-doc-sidebar-visible";
+function readState() {
+  if (typeof window === "undefined") return true;
+  try {
+    return localStorage.getItem(SIDEBAR_STORAGE_KEY) !== "false";
+  } catch {
+    return true;
+  }
+}
+function setDataAttribute(isVisible) {
+  if (isVisible) {
+    document.documentElement.removeAttribute("data-sidebar-hidden");
+  } else {
+    document.documentElement.setAttribute("data-sidebar-hidden", "");
+  }
+}
+function DesktopSidebarToggle() {
+  const [visible, setVisible] = useState(true);
+  const hydrated = useRef(false);
+  useEffect(() => {
+    if (!hydrated.current) return;
+    setDataAttribute(visible);
+    try {
+      localStorage.setItem(SIDEBAR_STORAGE_KEY, String(visible));
+    } catch {
+    }
+  }, [visible]);
+  useEffect(() => {
+    hydrated.current = true;
+    const actual = readState();
+    if (actual !== visible) {
+      setVisible(actual);
+    }
+  }, []);
+  useEffect(() => {
+    const handler = () => setDataAttribute(readState());
+    document.addEventListener(AFTER_NAVIGATE_EVENT, handler);
+    return () => document.removeEventListener(AFTER_NAVIGATE_EVENT, handler);
+  }, []);
+  return /* @__PURE__ */ jsx(
+    "button",
+    {
+      type: "button",
+      onClick: () => setVisible((v) => !v),
+      className: "zd-desktop-sidebar-toggle hidden lg:flex fixed bottom-vsp-xl z-sidebar items-center justify-center w-[1.5rem] h-[3rem] bg-surface border border-muted border-l-0 rounded-r-DEFAULT text-muted cursor-pointer transition-[left,color] duration-200 ease-in-out hover:text-fg",
+      "aria-label": visible ? "Hide sidebar" : "Show sidebar",
+      "aria-pressed": visible,
+      "data-zfb-transition-persist": "desktop-sidebar-toggle",
+      children: visible ? /* @__PURE__ */ jsx(ChevronLeft, { className: "h-icon-sm w-icon-sm" }) : /* @__PURE__ */ jsx(ChevronRight, { className: "h-icon-sm w-icon-sm" })
+    }
+  );
+}
+DesktopSidebarToggle.displayName = "DesktopSidebarToggle";
+export {
+  DesktopSidebarToggle,
+  SIDEBAR_STORAGE_KEY
+};

package/dist/details/details.d.ts

@@ -1,9 +1,7 @@
-import { ComponentChildren, VNode } from 'preact';
-
 /** @jsxRuntime automatic */
 /** @jsxImportSource preact */
-
-interface DetailsProps {
+import type { ComponentChildren, VNode } from "preact";
+export interface DetailsProps {
     /**
      * Summary / toggle label shown in the `<summary>` element.
      * Defaults to `"Details"` — the same fallback used by the legacy
@@ -21,6 +19,4 @@ interface DetailsProps {
  * The legacy component used Astro's `<slot />`; v2 accepts standard
  * Preact `children`.
  */
-declare function Details({ title, children }: DetailsProps): VNode;
-
-export { Details, type DetailsProps };
+export declare function Details({ title, children }: DetailsProps): VNode;

package/dist/details/index.d.ts

@@ -1,2 +1,2 @@
-export { Details, DetailsProps } from './details.js';
-import 'preact';
+export { Details } from "./details.js";
+export type { DetailsProps } from "./details.js";

package/dist/doc-body-end/index.d.ts

@@ -0,0 +1,21 @@
+/** @jsxRuntime automatic */
+/** @jsxImportSource preact */
+import type { JSX } from "preact";
+/** Settings subset read by the DocBodyEnd factory. */
+export interface DocBodyEndSettings {
+    base?: string | null;
+    sidebarResizer: boolean;
+}
+/** Dependencies injected by the host stub. */
+export interface DocBodyEndDeps {
+    settings: DocBodyEndSettings;
+    /** The `BodyEndIslands` component (host-side — reads additional settings). */
+    BodyEndIslands: (props: {
+        basePath: string;
+    }) => JSX.Element;
+}
+/**
+ * Create a `DocBodyEnd` component bound to the host's settings and
+ * BodyEndIslands component.
+ */
+export declare function createDocBodyEnd(deps: DocBodyEndDeps): () => JSX.Element;

package/dist/doc-body-end/index.js

@@ -0,0 +1,15 @@
+import { Fragment, jsx, jsxs } from "preact/jsx-runtime";
+import { SidebarResizerInit } from "../sidebar-resizer/index.js";
+function createDocBodyEnd(deps) {
+  const { settings, BodyEndIslands } = deps;
+  function DocBodyEnd() {
+    return /* @__PURE__ */ jsxs(Fragment, { children: [
+      /* @__PURE__ */ jsx(BodyEndIslands, { basePath: settings.base ?? "/" }),
+      settings.sidebarResizer && /* @__PURE__ */ jsx(SidebarResizerInit, {})
+    ] });
+  }
+  return DocBodyEnd;
+}
+export {
+  createDocBodyEnd
+};

package/dist/doc-content-header/index.d.ts

@@ -0,0 +1,69 @@
+/** @jsxRuntime automatic */
+/** @jsxImportSource preact */
+import type { JSX } from "preact";
+import { type FrontmatterCellRenderer } from "../metainfo/index.js";
+import type { DocPageEntry } from "../doc-page-props/index.js";
+export type { FrontmatterCellRenderer };
+/** Dependencies injected by the host stub. */
+export interface DocContentHeaderDeps {
+    /** Translate a UI string key for a locale. */
+    t: (key: string, locale: string) => string;
+    /**
+     * Filter a doc entry's `data` (frontmatter) into the `entries` array expected
+     * by `<FrontmatterPreview>`. Host passes the result of
+     * `createBuildFrontmatterPreviewEntries` bound to `settings` + defaultIgnoreKeys.
+     */
+    buildFrontmatterPreviewEntries: (data: Record<string, unknown> | null | undefined) => Array<[string, unknown]>;
+    /**
+     * Custom per-key renderers for frontmatter cells (from
+     * `@/config/frontmatter-preview-renderers`). Host-side — these produce
+     * styled cells (pills, badges, etc.) using host components/theme.
+     */
+    frontmatterRenderers: Record<string, FrontmatterCellRenderer>;
+    /**
+     * The `DocMetainfoArea` component (host-side factory result — reads
+     * settings.docMetainfo and the manifest).
+     */
+    DocMetainfoArea: (props: {
+        slug: string;
+        locale: string;
+        isFallback?: boolean;
+    }) => JSX.Element | null;
+    /**
+     * The `DocTagsArea` component (host-side factory result — reads settings.docTags).
+     */
+    DocTagsArea: (props: {
+        slug: string;
+        locale: string;
+        tags: readonly string[] | undefined;
+    }) => JSX.Element | null;
+}
+interface DocContentHeaderProps {
+    /** The full content entry (title, description, tags, frontmatter data). */
+    entry: DocPageEntry;
+    /** Canonical page slug for DocMetainfoArea / DocTagsArea lookups. */
+    slug: string;
+    /** Active locale string, e.g. "en", "ja". */
+    locale: string;
+    /**
+     * True when this page falls back to the base EN collection for a locale
+     * route. Renders the "not yet translated" notice. Defaults to false.
+     * Only relevant for locale-prefixed and versioned-locale routes.
+     */
+    isFallback?: boolean;
+    /**
+     * Version slug when rendering a versioned route (e.g. "1.0"); undefined =
+     * latest. On versioned pages the date block and tag chips are hidden —
+     * the doc-history-meta manifest is built only from the LATEST content
+     * dirs, so a bare versioned slug would resolve to the latest file's
+     * Created/Updated/Author (wrong data), and tag chips would link to latest
+     * tag routes that may not exist for version-only tags (404). Mirrors the
+     * #1916 reduced-chrome stance that already hides doc history on
+     * versioned pages.
+     */
+    version?: string;
+}
+/**
+ * Create a `DocContentHeader` component bound to the host's injected context.
+ */
+export declare function createDocContentHeader(deps: DocContentHeaderDeps): (props: DocContentHeaderProps) => JSX.Element;

package/dist/doc-content-header/index.js

@@ -0,0 +1,49 @@
+import { Fragment, jsx, jsxs } from "preact/jsx-runtime";
+import { FrontmatterPreview } from "../metainfo/index.js";
+function createDocContentHeader(deps) {
+  const {
+    t,
+    buildFrontmatterPreviewEntries,
+    frontmatterRenderers,
+    DocMetainfoArea,
+    DocTagsArea
+  } = deps;
+  function DocContentHeader({
+    entry,
+    slug,
+    locale,
+    isFallback = false,
+    version
+  }) {
+    return /* @__PURE__ */ jsxs(Fragment, { children: [
+      /* @__PURE__ */ jsx("h1", { class: "text-heading font-bold mb-vsp-xs", children: entry.data.title }),
+      !version && /* @__PURE__ */ jsx(DocMetainfoArea, { slug, locale, isFallback }),
+      !version && /* @__PURE__ */ jsx(DocTagsArea, { slug, locale, tags: entry.data.tags }),
+      isFallback && !entry.data.generated && /* @__PURE__ */ jsx(
+        "div",
+        {
+          class: "mb-vsp-md border border-info/30 bg-info/5 px-hsp-lg py-vsp-sm text-small text-muted rounded",
+          role: "note",
+          children: t("doc.fallbackNotice", locale)
+        }
+      ),
+      entry.data.description && /* @__PURE__ */ jsx("p", { class: "mb-vsp-lg text-title text-muted", children: entry.data.description }),
+      /* @__PURE__ */ jsx(
+        FrontmatterPreview,
+        {
+          entries: buildFrontmatterPreviewEntries(entry.data),
+          title: t("frontmatter.preview.title", locale),
+          keyColLabel: t("frontmatter.preview.keyCol", locale),
+          valueColLabel: t("frontmatter.preview.valueCol", locale),
+          renderers: frontmatterRenderers,
+          data: entry.data,
+          locale
+        }
+      )
+    ] });
+  }
+  return DocContentHeader;
+}
+export {
+  createDocContentHeader
+};

package/dist/doc-history/index.d.ts

@@ -0,0 +1,10 @@
+interface DocHistoryProps {
+    slug: string;
+    locale?: string;
+    basePath?: string;
+}
+export declare function DocHistory({ slug, locale, basePath }: DocHistoryProps): import("preact").JSX.Element;
+export declare namespace DocHistory {
+    var displayName: string;
+}
+export {};