@lincyaw/viewer 0.0.0-stage → 1.0.0-rc.1

package/src/domain/index.ts

@@ -0,0 +1,22 @@
+export { clickVisible, resolveClicks } from './clicks.ts'
+export type { ClickRange, ClickSpec } from './clicks.ts'
+export { codeColumns } from './code-width.ts'
+export { footnoteSections } from './footnotes.ts'
+export { applyUpdate, diffDocuments, sectionDiagnostics } from './live.ts'
+export type { LiveUpdate } from './live.ts'
+export { VIEWER_MESSAGES } from './messages.ts'
+export type { Messages } from './messages.ts'
+export { ORIGIN_MESSAGES, originBar } from './origin.ts'
+export type { OriginBar, OriginMessages, OriginPart } from './origin.ts'
+export { OUTPUT_MESSAGES, outputNotes } from './outputs.ts'
+export type { OutputMessages } from './outputs.ts'
+export {
+  clampPosition,
+  FINAL_STEP,
+  itemVisible,
+  keepPosition,
+  nextPosition,
+  prevPosition,
+  stepAtLine,
+} from './steps.ts'
+export type { Position } from './steps.ts'

package/src/domain/live.ts

@@ -0,0 +1,44 @@
+import type { Finding, IRDocument, IRSection } from '@lincyaw/kernel'
+
+export interface LiveUpdate {
+  order: string[]
+  sections: IRSection[]
+  diagnostics: Finding[]
+  document?: Omit<IRDocument, 'sections' | 'diagnostics'>
+}
+
+function key(value: unknown): string {
+  return JSON.stringify(value)
+}
+const documentFields = ({ sections: _sections, diagnostics: _diagnostics, ...document }: IRDocument) => document
+
+export function diffDocuments(prev: IRDocument, next: IRDocument): LiveUpdate | undefined {
+  const old = new Map(prev.sections.map(s => [s.id, s]))
+  const sections = next.sections.filter(s => {
+    const previous = old.get(s.id)
+    return previous !== s && (previous === undefined || key(previous) !== key(s))
+  })
+  const order = next.sections.map(s => s.id)
+  const update: LiveUpdate = { order, sections, diagnostics: next.diagnostics }
+  const document = documentFields(next)
+  if (key(documentFields(prev)) !== key(document)) update.document = document
+  const reordered = key(order) !== key(prev.sections.map(s => s.id))
+  const changed = sections.length > 0 || reordered || update.document || key(prev.diagnostics) !== key(next.diagnostics)
+  return changed ? update : undefined
+}
+
+export function applyUpdate(doc: IRDocument, update: LiveUpdate): IRDocument {
+  const known = new Map(doc.sections.map(s => [s.id, s]))
+  for (const section of update.sections) known.set(section.id, section)
+  return {
+    ...(update.document ?? doc),
+    sections: update.order.flatMap(id => known.get(id) ?? []),
+    diagnostics: update.diagnostics,
+  }
+}
+
+export function sectionDiagnostics(section: IRSection, diagnostics: readonly Finding[]): Finding[] {
+  const ranges = [section.source, ...section.blocks.map(b => b.source)]
+  return diagnostics.filter(({ source }) => source?.line !== undefined && ranges.some(range =>
+    range.file === source.file && source.line! >= range.line && source.line! <= (range.endLine ?? range.line)))
+}

package/src/domain/messages.ts

@@ -0,0 +1,139 @@
+import type { Locale } from '@lincyaw/kernel/contracts'
+
+const zhStep = (step: number, steps: number) => `第 ${step + 1} 步，共 ${steps + 1} 步`
+
+const zh = {
+  contentRoles: { visual: '上屏内容', narration: '讲稿 · 字幕', reading: '仅供阅读' },
+  views: { document: '网页', scrolly: '滚动叙事', present: '放映', presenter: '演示者视图' },
+  present: {
+    region: '放映',
+    jumpStep: '跳转步骤',
+    captions: '字幕（按步骤）',
+    captionsHint: '字幕随步骤切换',
+    noCaptions: '本步没有讲稿',
+    step: (step: number) => `第 ${step} 步`,
+    counter: (index: number, total: number, step: number, steps: number) => `${index} / ${total}${steps > 0 ? ` · ${zhStep(step, steps)}` : ''}`,
+    prev: '上一步',
+    next: '下一步',
+    overview: '总览',
+    presenter: '演示者视图',
+    refresh: '更新',
+    fullscreen: '全屏',
+    exitFullscreen: '退出全屏',
+    exit: '结束放映',
+  },
+  presenter: {
+    step: (step: number, steps: number) => (steps > 0 ? zhStep(step, steps) : ''),
+    timer: '计时',
+    restart: '重新计时',
+    notes: '讲稿',
+    noNotes: '本页没有讲稿',
+    upcoming: '下一步',
+    end: '已到结尾',
+    nextSection: (title: string) => `下一页：${title}`,
+    nextStep: (step: number) => `第 ${step + 1} 步`,
+  },
+  section: {
+    anchor: (title: string) => `链接到“${title}”`,
+    openSource: '在编辑器中打开',
+    sourceTitle: (where: string) => `${where}（按住 Alt 单击任一内容块，在编辑器中打开）`,
+  },
+  code: {
+    actions: '代码操作',
+    executorFailed: (_id: string, message: string) => `无法运行代码：${message}`,
+    run: '运行',
+    rerun: '重新运行',
+    running: '正在运行…',
+    unavailable: '此处无法运行代码',
+    resetRunSession: '重置会话',
+    edit: '编辑代码',
+    doneEditing: '完成编辑',
+    revert: '还原代码',
+  },
+  markdown: {
+    admonitions: {
+      note: '注意',
+      tip: '提示',
+      hint: '提示',
+      important: '重要',
+      warning: '警告',
+      caution: '小心',
+      attention: '注意',
+      danger: '危险',
+      error: '错误',
+      seealso: '另请参阅',
+    } as Record<string, string>,
+    footnote: (label: string) => `脚注 ${label}`,
+  },
+  missingComponent: (_name: string) => '无法显示此内容块',
+}
+
+export type Messages = typeof zh
+
+const en: Messages = {
+  contentRoles: { visual: 'On screen', narration: 'Script · Captions', reading: 'Reading only' },
+  views: { document: 'Web', scrolly: 'Scrollytelling', present: 'Present', presenter: 'Presenter View' },
+  present: {
+    region: 'Presentation',
+    jumpStep: 'Jump to Step',
+    captions: 'Captions by step',
+    captionsHint: 'Captions follow the selected step',
+    noCaptions: 'No script for this step',
+    step: step => `Step ${step}`,
+    counter: (index, total, step, steps) => `${index} / ${total}${steps > 0 ? ` · step ${step + 1} of ${steps + 1}` : ''}`,
+    prev: 'Previous',
+    next: 'Next',
+    overview: 'Overview',
+    presenter: 'Presenter View',
+    refresh: 'Update',
+    fullscreen: 'Full Screen',
+    exitFullscreen: 'Exit Full Screen',
+    exit: 'End Show',
+  },
+  presenter: {
+    step: (step, steps) => (steps > 0 ? `Step ${step + 1} of ${steps + 1}` : ''),
+    timer: 'Timer',
+    restart: 'Restart Timer',
+    notes: 'Script',
+    noNotes: 'No script on this page',
+    upcoming: 'Next',
+    end: 'End of the document',
+    nextSection: title => `Next page: ${title}`,
+    nextStep: step => `Step ${step + 1}`,
+  },
+  section: {
+    anchor: title => `Link to “${title}”`,
+    openSource: 'Open in Editor',
+    sourceTitle: where => `${where} (Alt+click any block to open it in the editor)`,
+  },
+  code: {
+    actions: 'Code actions',
+    executorFailed: (_id, message) => `Couldn’t run the code: ${message}`,
+    run: 'Run',
+    rerun: 'Run Again',
+    running: 'Running…',
+    unavailable: 'Code can’t run here',
+    resetRunSession: 'Reset Session',
+    edit: 'Edit Code',
+    doneEditing: 'Done Editing',
+    revert: 'Restore Code',
+  },
+  markdown: {
+    admonitions: {
+      note: 'Note',
+      tip: 'Tip',
+      hint: 'Hint',
+      important: 'Important',
+      warning: 'Warning',
+      caution: 'Caution',
+      attention: 'Attention',
+      danger: 'Danger',
+      error: 'Error',
+      seealso: 'See also',
+    },
+    footnote: label => `Footnote ${label}`,
+  },
+  missingComponent: () => 'This block can’t be shown',
+}
+
+export const VIEWER_MESSAGES: Record<Locale, Messages> = { 'zh-CN': zh, 'en': en }

package/src/domain/origin.ts

@@ -0,0 +1,78 @@
+import type { CodeNode, ResolutionStatus } from '@lincyaw/kernel'
+import type { Locale } from '@lincyaw/kernel/contracts'
+
+const zh = {
+  workingTree: '当前代码',
+  status: { moved: '已移动', fuzzy: '待核对', lost: '已失效' } as Partial<Record<ResolutionStatus, string>>,
+  statusTitle: {
+    moved: '引用的代码在文件中移动了位置，显示的是移动后的代码。',
+    fuzzy: '引用的代码有改动，找到的位置有待确认；请运行 presmium check 查看。',
+    lost: '找不到引用的代码。请运行 presmium check 查看原因。',
+  } as Partial<Record<ResolutionStatus, string>>,
+  drifted: '已漂移',
+  driftedTitle: '当前代码已改变。请运行 presmium check 查看差异。',
+  synced: '已锁定',
+  syncedTitle: '锁定的代码与当前代码一致',
+  openFile: (file: string) => `在仓库中打开 ${file}`,
+}
+
+export type OriginMessages = typeof zh
+
+const en: OriginMessages = {
+  workingTree: 'Current Code',
+  status: { moved: 'Moved', fuzzy: 'Unverified', lost: 'Lost' },
+  statusTitle: {
+    moved: 'The referenced code moved in its file; this is the code where it is now.',
+    fuzzy: 'The referenced code changed and the place found is uncertain; run presmium check to see it.',
+    lost: 'The referenced code is no longer found; run presmium check to see why.',
+  },
+  drifted: 'Drifted',
+  driftedTitle: 'The current code changed; run presmium check to see the difference.',
+  synced: 'Pinned',
+  syncedTitle: 'The pinned code matches the current code',
+  openFile: file => `Open ${file} in the Repository`,
+}
+
+export const ORIGIN_MESSAGES: Record<Locale, OriginMessages> = { 'zh-CN': zh, 'en': en }
+
+export interface OriginPart {
+  kind: 'file' | 'variant' | 'commit' | 'badge'
+  text: string
+  href?: string
+  title?: string
+  active?: boolean
+  status?: ResolutionStatus
+  drift?: 'synced' | 'drifted'
+}
+
+export interface OriginBar {
+  anchor?: string
+  parts: OriginPart[]
+}
+
+function lines(start: number, end = start): string {
+  return end > start ? `${start}-${end}` : `${start}`
+}
+
+export function originBar(node: CodeNode, shown: number | undefined, locale: Locale): OriginBar | undefined {
+  const t = ORIGIN_MESSAGES[locale]
+  const { origin } = node
+  if (!origin) return node.title ? { parts: [{ kind: 'file', text: node.title }] } : undefined
+  const variants = node.variants ?? []
+  const version = shown === undefined ? undefined : variants[shown]
+  const href = version ? version.permalink : origin.permalink
+  const [start, end] = version?.startLine !== undefined ? [version.startLine, version.endLine] : [origin.startLine, origin.endLine]
+  const parts: OriginPart[] = [{ kind: 'file', text: `${node.title ?? origin.file}:${lines(start, end)}`, href, title: href ? t.openFile(origin.file) : origin.anchor }]
+  if (variants.length) {
+    variants.forEach((variant, k) => parts.push({ kind: 'variant', text: variant.label, href: variant.permalink, active: k === shown }))
+  } else {
+    parts.push({ kind: 'commit', text: origin.pin ? `@ ${origin.pin.slice(0, 7)}` : t.workingTree, title: origin.pin })
+  }
+  const status = t.status[origin.status]
+  if (status) parts.push({ kind: 'badge', text: status, title: t.statusTitle[origin.status], status: origin.status })
+  else if (origin.pin && !variants.length && origin.drift) {
+    const drifted = origin.drift === 'drifted'
+    parts.push({ kind: 'badge', text: drifted ? t.drifted : t.synced, title: drifted ? t.driftedTitle : t.syncedTitle, drift: origin.drift })
+  }
+  return { anchor: origin.anchor, parts }
+}

package/src/domain/outputs.ts

@@ -0,0 +1,27 @@
+import type { RunResult } from '@lincyaw/kernel'
+import type { Locale } from '@lincyaw/kernel/contracts'
+
+const zh = {
+  timedOut: '超时',
+  exitCode: (code: number) => `退出码 ${code}`,
+  recorded: '预录输出',
+}
+
+export type OutputMessages = typeof zh
+
+const en: OutputMessages = {
+  timedOut: 'Timed out',
+  exitCode: code => `Exit code ${code}`,
+  recorded: 'Recorded output',
+}
+
+export const OUTPUT_MESSAGES: Record<Locale, OutputMessages> = { 'zh-CN': zh, 'en': en }
+
+export function outputNotes(run: RunResult, locale: Locale): string[] {
+  const t = OUTPUT_MESSAGES[locale]
+  return [
+    run.timedOut ? t.timedOut : '',
+    run.exitCode !== null && run.exitCode !== 0 ? t.exitCode(run.exitCode) : '',
+    run.source === 'recorded' ? t.recorded : '',
+  ].filter(Boolean)
+}

package/src/domain/steps.ts

@@ -0,0 +1,46 @@
+import type { IRBlock, IRDocument } from '@lincyaw/kernel'
+
+export const FINAL_STEP = Number.POSITIVE_INFINITY
+
+export interface Position {
+  section: string
+  step: number
+  boundary?: 'start' | 'end'
+}
+
+export function itemVisible(block: IRBlock, item: number, step: number): boolean {
+  return step >= block.at + item
+}
+
+export function stepAtLine(markers: readonly { step: number, top: number }[], line: number): number {
+  return markers.reduce((step, marker) => (marker.top <= line ? Math.max(step, marker.step) : step), 0)
+}
+
+export function clampPosition(doc: IRDocument, position: Position): Position {
+  const section = doc.sections.find(s => s.id === position.section) ?? doc.sections[0]
+  if (!section) return position
+  const step = Number.isFinite(position.step) ? Math.min(Math.max(Math.round(position.step), 0), section.steps) : section.steps
+  return { section: section.id, step, ...position.boundary ? { boundary: position.boundary } : {} }
+}
+
+export function keepPosition(prev: IRDocument, next: IRDocument, position: Position): Position {
+  if (next.sections.some(s => s.id === position.section) || next.sections.length === 0) return clampPosition(next, position)
+  const at = prev.sections.findIndex(s => s.id === position.section)
+  const section = next.sections[Math.min(Math.max(at, 0), next.sections.length - 1)]!
+  return clampPosition(next, { section: section.id, step: position.step })
+}
+
+export function nextPosition(doc: IRDocument, position: Position): Position | undefined {
+  const i = doc.sections.findIndex(s => s.id === position.section)
+  const section = doc.sections[i]
+  if (section && position.step < section.steps) return { section: section.id, step: position.step + 1 }
+  const next = doc.sections[i + 1]
+  return next ? { section: next.id, step: 0 } : undefined
+}
+
+export function prevPosition(doc: IRDocument, position: Position): Position | undefined {
+  const i = doc.sections.findIndex(s => s.id === position.section)
+  if (i >= 0 && position.step > 0) return { section: position.section, step: position.step - 1 }
+  const prev = doc.sections[i - 1]
+  return prev ? { section: prev.id, step: prev.steps } : undefined
+}