npm - @takazudo/zudo-doc - Versions diffs - 3.2.0 → 4.0.0 - Mend

@takazudo/zudo-doc 3.2.0 → 4.0.0

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 (439) hide show

package/dist/theme-pack-switcher/switcher-state.js ADDED Viewed

@@ -0,0 +1,43 @@
+import {
+  readThemePackFromDom,
+  subscribeThemePackChanged
+} from "./theme-pack-sync.js";
+function cyclePackSlug(order, active, step) {
+  if (order.length === 0) return null;
+  const idx = order.findIndex((entry) => entry.slug === active);
+  if (idx === -1) {
+    const fallback = step === 1 ? order[0] : order[order.length - 1];
+    return fallback?.slug ?? null;
+  }
+  const next = order[(idx + step + order.length) % order.length];
+  return next?.slug ?? null;
+}
+function nextPackSlug(order, active) {
+  return cyclePackSlug(order, active, 1);
+}
+function prevPackSlug(order, active) {
+  return cyclePackSlug(order, active, -1);
+}
+function resolveActiveEntry(order, active) {
+  return order.find((entry) => entry.slug === active) ?? null;
+}
+function connectActivePackSync(onActive) {
+  const sync = () => onActive(readThemePackFromDom());
+  sync();
+  return subscribeThemePackChanged(sync);
+}
+function connectEscapeToClose(onEscape) {
+  const onKeyDown = (event) => {
+    if (event.key === "Escape") onEscape();
+  };
+  document.addEventListener("keydown", onKeyDown);
+  return () => document.removeEventListener("keydown", onKeyDown);
+}
+export {
+  connectActivePackSync,
+  connectEscapeToClose,
+  cyclePackSlug,
+  nextPackSlug,
+  prevPackSlug,
+  resolveActiveEntry
+};

package/dist/theme-pack-switcher/theme-pack-sync.d.ts ADDED Viewed

@@ -0,0 +1,85 @@
+/** Window event dispatched after a theme-pack switch commits (ADR Decision 3
+ *  step 8). `detail` carries {@link ThemePackChangeDetail}. */
+export declare const THEME_PACK_CHANGED_EVENT = "theme-pack-changed";
+/** localStorage key persisting the user's chosen pack slug. */
+export declare const THEME_PACK_STORAGE_KEY = "zudo-doc-theme-pack";
+/** `<html>` attribute carrying the ACTIVE pack slug (always present on a
+ *  theme-pack-enabled page, also for `"default"`). */
+export declare const THEME_PACK_ATTR = "data-theme-pack";
+/** Marker attribute of the ACTIVE pack's stylesheet `<link>` (id-free; this
+ *  attribute is the canonical selector). Absent when the active pack is
+ *  `"default"`. */
+export declare const THEME_PACK_LINK_ATTR = "data-zd-theme-pack-css";
+/** Marker attribute of an in-flight (not yet committed) pack stylesheet
+ *  `<link>` appended by {@link applyThemePack} step 4a. */
+export declare const THEME_PACK_LINK_LOADING_ATTR = "data-zd-theme-pack-css-loading";
+/**
+ * The reserved slug meaning "the stock zudo-doc look" — no pack stylesheet is
+ * ever inserted for it. Literal parity with `DEFAULT_THEME_PACK_SLUG` in
+ * `../theme-packs-registry/meta-schema.ts` is guarded by a unit test; the
+ * constant is re-declared here (rather than imported) because `meta-schema.ts`
+ * imports `zod`, which must stay out of client island bundles.
+ */
+export declare const DEFAULT_THEME_PACK_SLUG = "default";
+/**
+ * `window` global published by the theme-pack bootstrap script
+ * (`buildThemePackBootstrap`, `../theme/theme-pack-provider.tsx`) on every
+ * hard load, carrying the inlined enabled-pack registry this module validates
+ * against and builds pack URLs from. A window global (same JS realm) survives
+ * zfb's SPA soft-swaps, so it is readable whenever `applyThemePack` runs.
+ * Absent ⇒ the page has no theme-pack bootstrap (feature inert) and
+ * `applyThemePack` refuses to switch.
+ */
+export declare const THEME_PACK_RUNTIME_GLOBAL = "__zudoDocThemePacks";
+/** Shape of the {@link THEME_PACK_RUNTIME_GLOBAL} window global. */
+export interface ThemePackRuntimeConfig {
+    /** Resolved base prefix WITH trailing slash (`"/"`, `"/sub/"`). */
+    base: string;
+    /** Ordered `{ slug → meta.version }` map of the ENABLED packs. */
+    packs: Record<string, string>;
+    /** The build-configured pack slug (`settings.themePack`). */
+    configured: string;
+}
+/** `detail` payload of the {@link THEME_PACK_CHANGED_EVENT} window event. */
+export interface ThemePackChangeDetail {
+    /** The newly committed pack slug. */
+    pack: string;
+    /** The previously active pack slug. */
+    previous: string;
+}
+/**
+ * Canonical pack-stylesheet URL (ADR Decision 2 URL scheme):
+ * `{base}theme-packs/<slug>/pack.css?v=<version>`. `base` must carry its
+ * trailing slash. The `?v=` query is the cache-busting handle driven by the
+ * pack's `meta.json` version.
+ */
+export declare function buildPackCssUrl(base: string, slug: string, version: string): string;
+/**
+ * Read the ACTIVE theme pack from `<html data-theme-pack>`. Falls back to
+ * `"default"` when the attribute is missing or empty (e.g. a page rendered
+ * without the theme-pack feature).
+ */
+export declare function readThemePackFromDom(): string;
+/**
+ * Apply `next` as the active theme pack — the ADR Decision 3 swap algorithm,
+ * implemented step-for-step. Resolves `true` on commit (also when `next` is
+ * already active), `false` on abort/failure.
+ *
+ * Atomicity: pack CSS is authored entirely under
+ * `html[data-theme-pack="<slug>"]` scoping (ADR Decision 6), so during the
+ * dual-link overlap window the incoming pack's rules are inert until the
+ * single synchronous attribute flip at step 6a — no intermediate mixed-pack
+ * frame regardless of link/cascade order.
+ *
+ * Failure semantics (step 4b): on stylesheet error or timeout the new link is
+ * removed, the CURRENT pack stays fully intact, and neither the localStorage
+ * key nor the `theme-pack-changed` event fires.
+ */
+export declare function applyThemePack(next: string): Promise<boolean>;
+/**
+ * Subscribe to theme-pack changes. Returns an unsubscribe function (suitable
+ * as a `useEffect` cleanup). Mirrors `subscribeColorSchemeChanged` — two
+ * mounted switcher surfaces (flyout + dialog) stay in sync by re-reading
+ * {@link readThemePackFromDom} when notified.
+ */
+export declare function subscribeThemePackChanged(listener: () => void): () => void;

package/dist/theme-pack-switcher/theme-pack-sync.js ADDED Viewed

@@ -0,0 +1,121 @@
+const THEME_PACK_CHANGED_EVENT = "theme-pack-changed";
+const THEME_PACK_STORAGE_KEY = "zudo-doc-theme-pack";
+const THEME_PACK_ATTR = "data-theme-pack";
+const THEME_PACK_LINK_ATTR = "data-zd-theme-pack-css";
+const THEME_PACK_LINK_LOADING_ATTR = "data-zd-theme-pack-css-loading";
+const DEFAULT_THEME_PACK_SLUG = "default";
+const THEME_PACK_RUNTIME_GLOBAL = "__zudoDocThemePacks";
+const LOAD_TIMEOUT_MS = 1e4;
+function buildPackCssUrl(base, slug, version) {
+  return `${base}theme-packs/${slug}/pack.css?v=${version}`;
+}
+function readRuntimeConfig() {
+  const cfg = window[THEME_PACK_RUNTIME_GLOBAL];
+  if (cfg === null || typeof cfg !== "object") return null;
+  return cfg;
+}
+function readThemePackFromDom() {
+  const actual = document.documentElement.getAttribute(THEME_PACK_ATTR);
+  return actual !== null && actual !== "" ? actual : DEFAULT_THEME_PACK_SLUG;
+}
+function awaitLinkLoad(link) {
+  return new Promise((resolve) => {
+    const timer = setTimeout(() => resolve(false), LOAD_TIMEOUT_MS);
+    link.addEventListener(
+      "load",
+      () => {
+        clearTimeout(timer);
+        resolve(true);
+      },
+      { once: true }
+    );
+    link.addEventListener(
+      "error",
+      () => {
+        clearTimeout(timer);
+        resolve(false);
+      },
+      { once: true }
+    );
+  });
+}
+let seq = 0;
+async function applyThemePack(next) {
+  const runtime = readRuntimeConfig();
+  if (runtime === null || !Object.prototype.hasOwnProperty.call(runtime.packs, next)) {
+    console.warn(
+      `[zudo-doc] applyThemePack: unknown theme pack "${next}" \u2014 enabled packs: ${runtime === null ? "(no theme-pack bootstrap on this page)" : Object.keys(runtime.packs).join(", ") || "(none)"}.`
+    );
+    return false;
+  }
+  const current = readThemePackFromDom();
+  if (next === current) {
+    seq++;
+    return true;
+  }
+  const token = ++seq;
+  let newLink = null;
+  if (next !== DEFAULT_THEME_PACK_SLUG) {
+    newLink = document.createElement("link");
+    newLink.setAttribute("rel", "stylesheet");
+    newLink.setAttribute(THEME_PACK_LINK_LOADING_ATTR, "");
+    newLink.setAttribute(
+      "href",
+      buildPackCssUrl(runtime.base, next, runtime.packs[next] ?? "")
+    );
+    const loading = awaitLinkLoad(newLink);
+    document.head.appendChild(newLink);
+    const loaded = await loading;
+    if (!loaded) {
+      newLink.remove();
+      if (token === seq) {
+        console.warn(
+          `[zudo-doc] theme pack "${next}" stylesheet failed to load (error or ${LOAD_TIMEOUT_MS / 1e3}s timeout) \u2014 keeping "${current}".`
+        );
+      }
+      return false;
+    }
+  }
+  if (token !== seq) {
+    newLink?.remove();
+    return false;
+  }
+  document.documentElement.setAttribute(THEME_PACK_ATTR, next);
+  const packLinks = document.querySelectorAll(
+    `link[${THEME_PACK_LINK_ATTR}], link[${THEME_PACK_LINK_LOADING_ATTR}]`
+  );
+  for (const el of Array.from(packLinks)) {
+    if (el !== newLink) el.remove();
+  }
+  if (newLink !== null) {
+    newLink.removeAttribute(THEME_PACK_LINK_LOADING_ATTR);
+    newLink.setAttribute(THEME_PACK_LINK_ATTR, "");
+  }
+  try {
+    localStorage.setItem(THEME_PACK_STORAGE_KEY, next);
+  } catch {
+  }
+  window.dispatchEvent(
+    new CustomEvent(THEME_PACK_CHANGED_EVENT, {
+      detail: { pack: next, previous: current }
+    })
+  );
+  return true;
+}
+function subscribeThemePackChanged(listener) {
+  window.addEventListener(THEME_PACK_CHANGED_EVENT, listener);
+  return () => window.removeEventListener(THEME_PACK_CHANGED_EVENT, listener);
+}
+export {
+  DEFAULT_THEME_PACK_SLUG,
+  THEME_PACK_ATTR,
+  THEME_PACK_CHANGED_EVENT,
+  THEME_PACK_LINK_ATTR,
+  THEME_PACK_LINK_LOADING_ATTR,
+  THEME_PACK_RUNTIME_GLOBAL,
+  THEME_PACK_STORAGE_KEY,
+  applyThemePack,
+  buildPackCssUrl,
+  readThemePackFromDom,
+  subscribeThemePackChanged
+};

package/dist/theme-packs/beacon/fonts/AtkinsonHyperlegible-400-latin.woff2 ADDED Viewed

Binary file

package/dist/theme-packs/beacon/fonts/AtkinsonHyperlegible-700-latin.woff2 ADDED Viewed

Binary file

package/dist/theme-packs/beacon/fonts/AtkinsonHyperlegible-italic-400-latin.woff2 ADDED Viewed

Binary file

package/dist/theme-packs/beacon/fonts/AtkinsonHyperlegible-italic-700-latin.woff2 ADDED Viewed

Binary file

package/dist/theme-packs/beacon/fonts/AtkinsonHyperlegibleMono-italic-latin.woff2 ADDED Viewed

Binary file

package/dist/theme-packs/beacon/fonts/AtkinsonHyperlegibleMono-latin.woff2 ADDED Viewed

Binary file

package/dist/theme-packs/beacon/fonts/OFL.txt ADDED Viewed

@@ -0,0 +1,94 @@
+Copyright 2020 Braille Institute of America, Inc. (https://github.com/googlefonts/atkinson-hyperlegible)
+Copyright 2024 Braille Institute of America, Inc. (https://github.com/googlefonts/atkinson-hyperlegible-next-mono)
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://scripts.sil.org/OFL
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/dist/theme-packs/beacon/meta.json ADDED Viewed

@@ -0,0 +1,37 @@
+{
+  "schemaVersion": 1,
+  "slug": "beacon",
+  "name": "Beacon",
+  "description": "WCAG-AAA high contrast — 7:1+ ink everywhere, 3px focus rings, always-underlined links. Clarity as beauty.",
+  "mode": "light",
+  "version": "1.0.1",
+  "fonts": {
+    "sans": "Atkinson Hyperlegible",
+    "mono": "Atkinson Hyperlegible Mono",
+    "loaded": ["Atkinson Hyperlegible", "Atkinson Hyperlegible Mono"]
+  },
+  "preview": {
+    "light": {
+      "bg": "#ffffff",
+      "fg": "#000000",
+      "accent": "#0044cc",
+      "syntax": {
+        "keyword": "#0044cc",
+        "string": "#a50000",
+        "comment": "#595959",
+        "callable": "#00287a"
+      }
+    },
+    "dark": {
+      "bg": "#000000",
+      "fg": "#ffffff",
+      "accent": "#6db3ff",
+      "syntax": {
+        "keyword": "#6db3ff",
+        "string": "#ff8f8f",
+        "comment": "#b3b3b3",
+        "callable": "#a8d1ff"
+      }
+    }
+  }
+}