@uniweb/runtime 0.8.7 → 0.8.9

package/src/Ref/Ref.jsx

@@ -1,139 +0,0 @@
-/**
- * Cross-reference renderer. The framework registers `<Ref>` as a default
- * inset component so the `[#id]` author syntax (recognized by
- * content-reader) compiles to `inset_ref { component: 'Ref', key: <id> }`
- * and falls through to this renderer regardless of which foundation is
- * active.
- *
- * Resolution flow at render time:
- *   1. Read `block.website.xref.entries[id]` — the per-document
- *      registry the framework populated from {#id} attributes.
- *   2. Pick the active xref-style preset (foundation default + document
- *      override) and the kind metadata for the registered entry.
- *   3. Render via the style's label + counter + locator.
- *
- * Multi-ref clusters (`[#a;#b]`) split on `;` and render same-kind
- * groups using the style's `labelPlural`. Mixed-kind clusters fall
- * back to comma-separated singular rendering with a console warning.
- *
- * Missing ids render `[?<id-with-typo>]` so the failing key is visible
- * in the output — easier to debug than the bare `[?]` we use for
- * missing cite keys.
- *
- * @module @uniweb/kit/Ref
- */
-
-import React from 'react'
-import { resolveXrefStyle, getKindMeta } from '../xref-styles.js'
-
-function splitKeys(raw) {
-  return String(raw || '')
-    .split(';')
-    .map((k) => k.trim().replace(/^#/, ''))
-    .filter(Boolean)
-}
-
-function formatLocator(params) {
-  const { page, locator, label = 'page' } = params || {}
-  const value = page || locator
-  if (!value) return ''
-  const labels = {
-    page: 'p.',
-    chapter: 'chap.',
-    section: '§',
-    paragraph: '¶',
-  }
-  const lab = labels[label] || `${label}.`
-  return ` (${lab} ${value})`
-}
-
-function renderEntry(entry, kindMeta) {
-  // Bare "Figure 3" / "§3.2" — label + separator + counter.
-  const label = kindMeta?.label || ''
-  const sep = kindMeta?.sep ?? ' '
-  const counter = entry.counterText
-  return label ? `${label}${sep}${counter}` : counter
-}
-
-function renderGroupSameKind(entries, kindMeta) {
-  if (entries.length === 1) {
-    return renderEntry(entries[0], kindMeta)
-  }
-  // Plural label + comma-separated counters with " and " before the last.
-  const label = kindMeta?.labelPlural || kindMeta?.label || ''
-  const sep = kindMeta?.sep ?? ' '
-  const counters = entries.map((e) => e.counterText)
-  let body
-  if (counters.length === 2) {
-    body = counters.join(' and ')
-  } else {
-    body = counters.slice(0, -1).join(', ') + ', and ' + counters[counters.length - 1]
-  }
-  return label ? `${label}${sep}${body}` : body
-}
-
-export function Ref({ params, block }) {
-  const website = block?.website
-  const xref = website?.xref || website?.config?.xref || null
-  const entries = xref?.entries || {}
-  const styleName = website?.config?.book?.xrefStyle || 'humanities'
-  const style = resolveXrefStyle(styleName, website?.config)
-
-  const ids = splitKeys(params?.key)
-  if (ids.length === 0) {
-    return <span className="xref xref--missing" title="No id">[?]</span>
-  }
-
-  const resolved = ids.map((id) => {
-    const entry = entries[id]
-    return entry ? { id, entry, kindMeta: getKindMeta(style, entry.kind) } : { id, missing: true }
-  })
-
-  // Single missing-id fast path — rich placeholder with the failing key.
-  if (resolved.length === 1 && resolved[0].missing) {
-    return (
-      <span className="xref xref--missing" title={`Missing label: ${resolved[0].id}`}>
-        [?{resolved[0].id}]
-      </span>
-    )
-  }
-
-  // Group consecutive entries by kind. Mixed-kind clusters fall back to
-  // comma-separated singular rendering.
-  const allKinds = resolved.filter((r) => !r.missing).map((r) => r.entry.kind)
-  const sameKind = allKinds.every((k) => k === allKinds[0])
-
-  const locator = formatLocator(params)
-
-  if (!sameKind) {
-    if (typeof console !== 'undefined') {
-      // eslint-disable-next-line no-console
-      console.warn(
-        `[xref] mixed-kind cluster (${[...new Set(allKinds)].join(', ')}) — falling back to comma-separated rendering`,
-      )
-    }
-    const parts = resolved.map((r) =>
-      r.missing
-        ? `[?${r.id}]`
-        : renderEntry(r.entry, r.kindMeta),
-    )
-    return <span className="xref">{parts.join(', ')}{locator}</span>
-  }
-
-  // Same-kind path — group, render with labelPlural when multiple.
-  const onlyResolved = resolved.filter((r) => !r.missing)
-  const text = onlyResolved.length > 0
-    ? renderGroupSameKind(
-        onlyResolved.map((r) => r.entry),
-        onlyResolved[0].kindMeta,
-      )
-    : ''
-
-  // Append placeholders for any missing keys at the end of the cluster.
-  const missingTail = resolved.filter((r) => r.missing).map((r) => `[?${r.id}]`).join(', ')
-  const body = [text, missingTail].filter(Boolean).join(', ')
-
-  return <span className="xref">{body}{locator}</span>
-}
-
-export default Ref

package/src/Ref/index.js

@@ -1,2 +0,0 @@
-export { Ref } from './Ref.jsx'
-export { default } from './Ref.jsx'

package/src/xref-styles.js

@@ -1,103 +0,0 @@
-/**
- * Cross-reference style catalog.
- *
- * Cross-references are framework-managed (parallel to citestyle's nine
- * citation styles, but framework-internal because there's no CSL-for-
- * xrefs standard). Foundations pick a preset; documents may override
- * per-kind.
- *
- * Each preset is a map from kind name to:
- *   {
- *     label,         // singular label, e.g. "Figure"
- *     labelPlural,   // plural label, e.g. "Figures"
- *     counter,       // 'arabic' | 'hierarchical' | null (no counter)
- *     sep,           // separator between label and counter ("" | " ")
- *   }
- *
- * The catalog ships four presets:
- *   - humanities   (default — "Figure 3", "§3.2", "Equation 1")
- *   - engineering  ("Fig. 3", "Sec. 3.2", "Eq. 1")
- *   - german       ("Abb. 3", "Abschn. 3.2", "Gl. 1")
- *   - plain        (counters only — "3", "3.2", "1")
- *
- * Foundations override the preset by declaring `xref.kinds` in
- * foundation.js (additive: new kinds and overrides for existing kinds).
- * Documents override per-kind via `book.xref.<kind>:` in document.yml.
- */
-
-const HUMANITIES = {
-  figure:   { label: 'Figure',   labelPlural: 'Figures',   counter: 'arabic', sep: ' ' },
-  equation: { label: 'Equation', labelPlural: 'Equations', counter: 'arabic', sep: ' ' },
-  section:  { label: '§',        labelPlural: '§§',        counter: 'hierarchical', sep: '' },
-  table:    { label: 'Table',    labelPlural: 'Tables',    counter: 'arabic', sep: ' ' },
-}
-
-const ENGINEERING = {
-  figure:   { label: 'Fig.',     labelPlural: 'Figs.',     counter: 'arabic', sep: ' ' },
-  equation: { label: 'Eq.',      labelPlural: 'Eqs.',      counter: 'arabic', sep: ' ' },
-  section:  { label: 'Sec.',     labelPlural: 'Secs.',     counter: 'hierarchical', sep: ' ' },
-  table:    { label: 'Tab.',     labelPlural: 'Tabs.',     counter: 'arabic', sep: ' ' },
-}
-
-const GERMAN = {
-  figure:   { label: 'Abb.',     labelPlural: 'Abb.',      counter: 'arabic', sep: ' ' },
-  equation: { label: 'Gl.',      labelPlural: 'Gl.',       counter: 'arabic', sep: ' ' },
-  section:  { label: 'Abschn.',  labelPlural: 'Abschn.',   counter: 'hierarchical', sep: ' ' },
-  table:    { label: 'Tab.',     labelPlural: 'Tab.',      counter: 'arabic', sep: ' ' },
-}
-
-const PLAIN = {
-  figure:   { label: '',         labelPlural: '',          counter: 'arabic', sep: '' },
-  equation: { label: '',         labelPlural: '',          counter: 'arabic', sep: '' },
-  section:  { label: '',         labelPlural: '',          counter: 'hierarchical', sep: '' },
-  table:    { label: '',         labelPlural: '',          counter: 'arabic', sep: '' },
-}
-
-export const XREF_STYLES = {
-  humanities: HUMANITIES,
-  engineering: ENGINEERING,
-  german: GERMAN,
-  plain: PLAIN,
-}
-
-export const DEFAULT_XREF_STYLE = 'humanities'
-
-/**
- * Resolve the active xref-style for a document. Reads:
- *   - `book.xrefStyle:` in document config (preset name).
- *   - `book.xref.<kind>:` per-kind overrides on top of the preset.
- *   - Foundation-declared kinds (`foundation.xref.kinds`) extend the
- *     preset with whatever the foundation provides.
- *
- * Returns a plain map keyed by kind name; per-kind values are merged
- * objects (preset + foundation extensions + document overrides).
- */
-export function resolveXrefStyle(presetName, config) {
-  const preset = XREF_STYLES[presetName] || XREF_STYLES[DEFAULT_XREF_STYLE]
-  const merged = { ...preset }
-
-  // Foundation extensions: kinds declared by the foundation (e.g.
-  // theorem, lemma, proof for a math foundation).
-  const foundationKinds = globalThis.uniweb?.foundationConfig?.xref?.kinds
-  if (foundationKinds && typeof foundationKinds === 'object') {
-    for (const [kind, meta] of Object.entries(foundationKinds)) {
-      merged[kind] = { ...merged[kind], ...meta }
-    }
-  }
-
-  // Document overrides: `book.xref.<kind>:` granular tweaks.
-  const docOverrides = config?.book?.xref || config?.xref || null
-  if (docOverrides && typeof docOverrides === 'object') {
-    for (const [kind, meta] of Object.entries(docOverrides)) {
-      if (meta && typeof meta === 'object') {
-        merged[kind] = { ...merged[kind], ...meta }
-      }
-    }
-  }
-
-  return merged
-}
-
-export function getKindMeta(style, kind) {
-  return style?.[kind] || null
-}