@airalogy/aimd-renderer 2.6.0 → 2.8.0

package/src/vue/vue-renderer.ts

@@ -1,6 +1,8 @@
 import type { Element, Root as HastRoot, Text as HastText, RootContent } from "hast"
 import type { Component, VNode, VNodeChild } from "vue"
-import type { AimdNode, AimdQuizNode, AimdStepNode, RenderContext } from "@airalogy/aimd-core/types"
+import type { AimdNode, AimdQuizNode, AimdReferenceEntry, AimdStepNode, RenderContext } from "@airalogy/aimd-core/types"
+import type { AimdCitationReferenceDisplay } from "../common/citationNumbering"
+import type { AimdAssetUrlResolver } from "../common/assetUrls"
 import {
   formatAimdExampleValue,
   getAimdFieldDescription,
@@ -10,6 +12,8 @@ import {
 } from "@airalogy/aimd-core/utils"
 import { Fragment, h } from "vue"
 import type { AimdRendererI18nOptions, AimdRendererLocale, AimdRendererMessages } from "../locales"
+import { resolveAimdAssetUrl } from "../common/assetUrls"
+import { formatCitationReferenceSummary, moveReferenceSectionsToEnd } from "../common/citationNumbering"
 import { resolveQuizPreviewOptions, type ResolvedQuizPreviewOptions } from "../common/quiz-preview"
 import {
   createAimdRendererMessages,
@@ -48,6 +52,7 @@ export type ElementRenderer = (
 export interface AimdRendererContext extends RenderContext {
   locale: AimdRendererLocale
   messages: AimdRendererMessages
+  resolveAssetUrl?: AimdAssetUrlResolver
 }
 
 export interface AimdStepCardRendererOptions {
@@ -159,6 +164,66 @@ function buildScaleBandChildren(quizNode: AimdQuizNode): VNodeChild[] {
   ]
 }
 
+function getReferenceContainer(entry: AimdReferenceEntry): string | undefined {
+  return entry.journal || entry.booktitle || entry.publisher
+}
+
+function buildReferenceChildren(entry: AimdReferenceEntry): VNodeChild[] {
+  const children: VNodeChild[] = []
+  const pushText = (value: string | undefined, suffix = "") => {
+    const normalized = value?.trim()
+    if (!normalized) {
+      return
+    }
+    if (children.length > 0) {
+      children.push(" ")
+    }
+    children.push(`${normalized}${suffix}`)
+  }
+
+  pushText(entry.author)
+  pushText(entry.year ? `(${entry.year})` : undefined)
+  pushText(entry.title, entry.title && !/[.!?]$/.test(entry.title) ? "." : "")
+  pushText(getReferenceContainer(entry), ".")
+
+  if (entry.doi) {
+    if (children.length > 0) {
+      children.push(" ")
+    }
+    const doiHref = entry.doi.startsWith("http")
+      ? entry.doi
+      : `https://doi.org/${entry.doi}`
+    children.push(h("a", { class: "aimd-refs__doi", href: doiHref }, `doi:${entry.doi}`))
+  }
+  else if (entry.url) {
+    if (children.length > 0) {
+      children.push(" ")
+    }
+    children.push(h("a", { class: "aimd-refs__url", href: entry.url }, entry.url))
+  }
+
+  return children.length > 0 ? children : [entry.id]
+}
+
+function getCitationReferenceDisplays(node: AimdNode): AimdCitationReferenceDisplay[] {
+  const citationRefs = (node as any).citationRefs
+  if (Array.isArray(citationRefs) && citationRefs.length > 0) {
+    return citationRefs
+      .map(ref => ({
+        id: String(ref?.id || "").trim(),
+        label: String(ref?.label || ref?.id || "").trim(),
+        summary: String(ref?.summary || ref?.id || "").trim(),
+      }))
+      .filter(ref => ref.id && ref.label)
+  }
+
+  const refs: unknown[] = Array.isArray((node as any).refs) ? (node as any).refs : [node.id]
+  return refs
+    .map((ref: unknown) => String(ref).trim())
+    .filter(Boolean)
+    .map((ref: string) => ({ id: ref, label: ref, summary: formatCitationReferenceSummary(undefined, ref) }))
+}
+
 interface FieldMetadataHelp {
   tooltip: string
   description?: string
@@ -560,7 +625,10 @@ const defaultAimdRenderers: Record<string, AimdComponentRenderer> = {
       "class": "aimd-ref aimd-ref--step",
       "data-aimd-type": "ref_step",
       "data-aimd-ref": refTarget,
+      "data-aimd-ref-target": refTarget,
+      "data-aimd-ref-kind": "step",
       "data-aimd-step-sequence": stepSequence,
+      "tabindex": 0,
       "title": refTarget,
     }, [
       h("span", { class: "aimd-ref__content" }, [
@@ -580,6 +648,9 @@ const defaultAimdRenderers: Record<string, AimdComponentRenderer> = {
       "class": "aimd-ref aimd-ref--var",
       "data-aimd-type": "ref_var",
       "data-aimd-ref": refTarget,
+      "data-aimd-ref-target": refTarget,
+      "data-aimd-ref-kind": "var",
+      "tabindex": 0,
       "title": refTarget,
     }, [
       h("span", { class: "aimd-ref__content" }, [
@@ -607,36 +678,64 @@ const defaultAimdRenderers: Record<string, AimdComponentRenderer> = {
     // Display figure number if available, otherwise show ID
     const displayText = ctx.messages.figure.reference(figureNumber !== undefined ? figureNumber : refTarget)
 
-    // Render as link reference to the figure
-    return h("a", {
+    return h("span", {
       "class": "aimd-ref aimd-ref--fig",
       "data-aimd-type": "ref_fig",
       "data-aimd-ref": refTarget,
-      "href": `#fig-${refTarget}`,
+      "data-aimd-ref-target": refTarget,
+      "data-aimd-ref-kind": "fig",
+      "tabindex": 0,
+      "title": refTarget,
     }, [
       h("span", { class: "aimd-ref__content" }, displayText),
     ])
   },
 
   cite: (node, ctx) => {
-    const refs = "refs" in node ? (node as any).refs : [node.id]
+    const citationRefs = getCitationReferenceDisplays(node)
 
     return h("span", {
       "class": "aimd-cite",
       "data-aimd-type": "cite",
-      "data-aimd-refs": refs.join(","),
+      "data-aimd-refs": citationRefs.map(ref => ref.id).join(","),
+      "data-aimd-citation-labels": citationRefs.map(ref => ref.label).join(","),
     }, [
-      h("span", { class: "aimd-cite__refs" }, `[${refs.join(", ")}]`),
+      "[",
+      ...citationRefs.flatMap((ref, index) => [
+        index > 0 ? ", " : "",
+        h("span", {
+          class: "aimd-cite__ref",
+          role: "doc-noteref",
+          tabindex: 0,
+          title: ref.summary,
+          "data-aimd-ref-id": ref.id,
+          "data-aimd-ref-summary": ref.summary,
+          "aria-label": ref.label === ref.id
+            ? `Reference ${ref.summary}`
+            : `Reference ${ref.label}: ${ref.summary}`,
+        }, [
+          h("span", { class: "aimd-cite__label" }, ref.label),
+          h("span", {
+            class: "aimd-cite__popover",
+            role: "tooltip",
+          }, ref.summary),
+        ]),
+      ]),
+      "]",
     ])
   },
 
   fig: (node, ctx) => {
     const figNode = node as any
     const figId = figNode.id || node.id
-    const figSrc = figNode.src || ""
     const figTitle = figNode.title
     const figLegend = figNode.legend
     const figSequence = figNode.sequence
+    const figSrc = resolveAimdAssetUrl(figNode.src || "", ctx.resolveAssetUrl, {
+      kind: "fig",
+      id: figId,
+      title: figTitle,
+    }) || ""
 
     const children: VNodeChild[] = []
 
@@ -684,6 +783,29 @@ const defaultAimdRenderers: Record<string, AimdComponentRenderer> = {
       "id": `fig-${figId}`,
     }, children)
   },
+
+  refs: (node, ctx) => {
+    const entries = Array.isArray((node as any).entries)
+      ? (node as any).entries as AimdReferenceEntry[]
+      : []
+
+    return h("section", {
+      "class": "aimd-refs",
+      "data-aimd-type": "refs",
+      "data-aimd-id": node.id,
+      "id": "refs",
+    }, [
+      h("div", { class: "aimd-refs__title" }, ctx.messages.references.title),
+      h("ol", { class: "aimd-refs__list" }, entries.map(entry =>
+        h("li", {
+          id: `ref-${entry.id}`,
+          class: "aimd-refs__item",
+          "data-aimd-ref-id": entry.id,
+          "data-aimd-ref-type": entry.entry_type,
+        }, buildReferenceChildren(entry)),
+      )),
+    ])
+  },
 }
 
 /**
@@ -709,7 +831,11 @@ export interface VueRendererOptions {
   /**
    * Render context
    */
-  context?: RenderContext & Partial<Pick<AimdRendererContext, "locale" | "messages">>
+  context?: RenderContext & Partial<Pick<AimdRendererContext, "locale" | "messages" | "resolveAssetUrl">>
+  /**
+   * Resolve protocol-local figure assets to displayable URLs.
+   */
+  resolveAssetUrl?: AimdAssetUrlResolver
   /**
    * Custom AIMD component renderers
    * Override default renderers or add new ones
@@ -751,6 +877,7 @@ function resolveRenderContext(options: VueRendererOptions): AimdRendererContext
     quizPreview: context?.quizPreview ?? topLevelQuizPreview ?? undefined,
     locale,
     messages,
+    resolveAssetUrl: context?.resolveAssetUrl ?? options.resolveAssetUrl,
   }
 }
 
@@ -817,6 +944,29 @@ function preprocessFigures(node: HastRoot | RootContent, figCtx: FigureContext):
 /**
  * Parse AIMD node from HAST element properties
  */
+function splitCsvProp(value: unknown): string[] {
+  return String(value || "")
+    .split(",")
+    .map(part => part.trim())
+    .filter(Boolean)
+}
+
+function parseStringArrayProp(value: unknown): string[] {
+  if (typeof value !== "string" || !value.trim()) {
+    return []
+  }
+
+  try {
+    const parsed = JSON.parse(value)
+    return Array.isArray(parsed)
+      ? parsed.map(item => String(item || "").trim()).filter(Boolean)
+      : []
+  }
+  catch {
+    return []
+  }
+}
+
 function parseAimdFromProps(props: Record<string, unknown>): AimdNode | undefined {
   let parsedFromJson: Record<string, unknown> | undefined
 
@@ -850,10 +1000,23 @@ function parseAimdFromProps(props: Record<string, unknown>): AimdNode | undefine
   }
 
   const stepSequence = props["data-aimd-step-sequence"] || props.dataAimdStepSequence
+  const citationRefIds = splitCsvProp(props["data-aimd-refs"] || props.dataAimdRefs)
+  const citationLabels = splitCsvProp(props["data-aimd-citation-labels"] || props.dataAimdCitationLabels)
+  const citationSummaries = parseStringArrayProp(props["data-aimd-citation-summaries"] || props.dataAimdCitationSummaries)
+  const citationRefs = citationRefIds.map((refId, index) => ({
+    id: refId,
+    label: citationLabels[index] || refId,
+    summary: citationSummaries[index] || refId,
+  }))
+
   if (parsedFromJson) {
     if (typeof stepSequence === "string" && stepSequence.trim()) {
       parsedFromJson.stepSequence = stepSequence
     }
+    if (fieldType === "cite" && citationRefs.length > 0) {
+      parsedFromJson.refs = citationRefs.map(ref => ref.id)
+      parsedFromJson.citationRefs = citationRefs
+    }
     return parsedFromJson as unknown as AimdNode
   }
 
@@ -888,6 +1051,16 @@ function parseAimdFromProps(props: Record<string, unknown>): AimdNode | undefine
     } as AimdNode
   }
 
+  if (fieldType === "cite") {
+    const refs = citationRefIds.length > 0 ? citationRefIds : [id]
+    return {
+      ...baseNode,
+      fieldType: "cite",
+      refs,
+      ...(citationRefs.length > 0 ? { citationRefs } : {}),
+    } as unknown as AimdNode
+  }
+
   // Add quiz-specific properties
   if (fieldType === "quiz") {
     const quizType = (props["data-aimd-quiz-type"] || props.dataAimdQuizType || "open") as string
@@ -1145,6 +1318,7 @@ export function renderToVNodes(
   tree: HastRoot,
   options: VueRendererOptions = {},
 ): VNode[] {
+  moveReferenceSectionsToEnd(tree)
   const result = hastToVue(tree, options)
 
   if (result === null || result === undefined) {