@lincyaw/mcp 0.0.0-stage → 1.0.0-rc.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,23 @@
-# Temporary Holding Version
+# @lincyaw/mcp
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Presmium's agent environment: a document's tools and resources over MCP, for agents such as Claude Code, Codex or VS Code.
+
+Part of [Presmium](https://github.com/Lincyaw/presmium), which turns lectures written in MyST Markdown into web pages, slides, Jupyter notebooks and narrated lectures.
+
+## Usage
+
+`presmium dev` and `presmium serve` serve it at `/mcp` and print its address and the file that holds its token. Without a server, run it over stdio:
+
+```sh
+pnpm exec presmium-mcp <document directory>
+```
+
+The reading tools (`list_sections`, `get_section`, `get_step`, `search`, `get_code_ref`, `get_outputs`, `get_diagnostics`, `locate_source` and others) are always there; `--allow operate` also provides `run_code` and `build`.
+
+## Documentation
+
+- [Author guide](https://github.com/Lincyaw/presmium/blob/main/site/guide/lecture.en.md): agents in your editor
+
+## License
+
+Apache-2.0

package/bin/presmium-mcp.mjs

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { createJiti } from 'jiti'
+
+console.log = console.info = console.debug = console.error
+
+const emitWarning = process.emitWarning
+process.emitWarning = (warning, ...args) => {
+  const code = typeof args[0] === 'object' ? args[0]?.code : args[1]
+  if (code !== 'DEP0040') emitWarning.call(process, warning, ...args)
+}
+
+const jiti = createJiti(import.meta.url)
+const { main } = await jiti.import('../src/stdio.ts')
+const code = await main(process.argv.slice(2))
+if (code !== undefined) process.exitCode = code

package/package.json

@@ -1,6 +1,44 @@
 {
   "name": "@lincyaw/mcp",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.0-rc.0",
+  "description": "Presmium's agent environment: a document's tools and resources over MCP, and presmium-mcp over stdio",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Lincyaw/presmium.git",
+    "directory": "packages/mcp"
+  },
+  "homepage": "https://github.com/Lincyaw/presmium/tree/main/packages/mcp#readme",
+  "bugs": "https://github.com/Lincyaw/presmium/issues",
+  "keywords": [
+    "presmium",
+    "mcp",
+    "agent"
+  ],
+  "type": "module",
+  "engines": {
+    "node": ">=22.19"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "presmium-mcp": "./bin/presmium-mcp.mjs"
+  },
+  "exports": {
+    ".": "./src/index.ts",
+    "./client": "./src/client.ts"
+  },
+  "files": [
+    "bin",
+    "src"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/client": "2.3.1",
+    "@modelcontextprotocol/server": "2.3.1",
+    "jiti": "^2.7.0",
+    "minisearch": "7.2.0",
+    "@lincyaw/compiler": "1.0.0-rc.0",
+    "@lincyaw/kernel": "1.0.0-rc.0"
+  }
 }

package/src/client.ts

@@ -0,0 +1,77 @@
+import { Client, StreamableHTTPClientTransport } from '@modelcontextprotocol/client'
+import { deckLocale, isRecord } from '@lincyaw/kernel'
+import type { ApprovalKind } from '@lincyaw/kernel'
+import { MCP_MESSAGES } from './messages.ts'
+
+export interface ListedTool {
+  name: string
+  description: string
+  inputSchema: Record<string, unknown>
+  kind: 'read' | ApprovalKind
+  approval?: 'ask' | 'allow'
+}
+
+export interface CalledTool {
+  isError: boolean
+  text: string
+}
+
+export interface PresmiumMcpClient {
+  tools(): Promise<ListedTool[]>
+  call(name: string, args: Record<string, unknown>, signal?: AbortSignal): Promise<CalledTool>
+  read(uri: string): Promise<unknown>
+  close(): Promise<void>
+}
+
+const KINDS = new Set(['read', 'operate', 'spend', 'write', 'agent'])
+const CALL_TIMEOUT_MS = 10 * 60_000
+
+export async function connectPresmiumMcp(url: string, token: string, name = 'presmium-dsh'): Promise<PresmiumMcpClient> {
+  const client = new Client({ name, version: '0.1.0' }, { versionNegotiation: { mode: 'auto' } })
+  await client.connect(new StreamableHTTPClientTransport(new URL(url), { requestInit: { headers: { Authorization: `Bearer ${token}` } } }))
+  return {
+    async tools() {
+      const listed: ListedTool[] = []
+      let cursor: string | undefined
+      do {
+        const page = await client.listTools(cursor ? { cursor } : undefined)
+        for (const tool of page.tools) {
+          const meta = isRecord(tool._meta) ? tool._meta : {}
+          const kind = typeof meta['presmium/kind'] === 'string' && KINDS.has(meta['presmium/kind']) ? meta['presmium/kind'] as ListedTool['kind'] : (tool.annotations?.readOnlyHint ? 'read' : 'operate')
+          const approval = meta['presmium/approval'] === 'allow' ? 'allow' : meta['presmium/approval'] === 'ask' ? 'ask' : undefined
+          listed.push({ name: tool.name, description: tool.description ?? tool.name, inputSchema: tool.inputSchema as Record<string, unknown>, kind, ...approval ? { approval } : {} })
+        }
+        cursor = page.nextCursor
+      } while (cursor)
+      return listed
+    },
+    async call(tool, args, signal) {
+      const result = await client.callTool({ name: tool, arguments: args }, { signal, timeout: CALL_TIMEOUT_MS })
+      const content = Array.isArray(result.content) ? result.content as { type: string, text?: string }[] : []
+      return { isError: result.isError === true, text: content.map(part => part.text ?? '').join('\n') }
+    },
+    async read(uri) {
+      const { contents } = await client.readResource({ uri })
+      const text = (contents[0] as { text?: string } | undefined)?.text ?? ''
+      try {
+        return JSON.parse(text) as unknown
+      } catch {
+        return text
+      }
+    },
+    close: () => client.close(),
+  }
+}
+
+export function describeOperation(tool: string, args: Record<string, unknown>, lang?: string): string {
+  const m = MCP_MESSAGES[deckLocale(lang)]
+  const text = (value: unknown) => (typeof value === 'string' ? value : typeof value === 'number' ? String(value) : '')
+  switch (tool) {
+    case 'navigate': return m.navigate(text(args.section), typeof args.step === 'number' ? args.step : 0)
+    case 'run_code': return m.run(text(args.section), text(args.block))
+    case 'build': return m.build(Array.isArray(args.to) && args.to.length ? args.to.join(', ') : m.allRenderers)
+    case 'classroom_start': return m.classroomStart(text(args.name))
+    case 'classroom_end': return m.classroomEnd
+    default: return m.tool(tool)
+  }
+}

package/src/deck.ts

@@ -0,0 +1,212 @@
+import { dirname, relative } from 'node:path'
+import { blockState, blockText, blockVisible, chapters, irBlocks, narrationAt, tokenize } from '@lincyaw/kernel'
+import type { CodeNode, Finding, IRBlock, IRDocument, IRSection, RecordedRun, RunOutput, RunResult, SourcePos } from '@lincyaw/kernel'
+import MiniSearch from 'minisearch'
+
+export interface Place {
+  file: string
+  line: number
+  endLine?: number
+}
+
+export function place(doc: IRDocument, pos: SourcePos): Place {
+  return { file: relative(dirname(doc.meta.entry), pos.file) || pos.file, line: pos.line, ...pos.endLine ? { endLine: pos.endLine } : {} }
+}
+
+export function findSection(doc: IRDocument, ref: string | number): IRSection {
+  const section = doc.sections.find(s => s.id === String(ref)) ?? doc.sections.find(s => String(s.index) === String(ref))
+  if (!section) throw new Error(`no section ${JSON.stringify(ref)}; list_sections names them`)
+  return section
+}
+
+export function findBlock(section: IRSection, id: string): IRBlock {
+  const block = [...irBlocks(section.blocks)].find(b => b.id === id)
+  if (!block) throw new Error(`no block ${JSON.stringify(id)} in section ${section.id}; get_section lists them`)
+  return block
+}
+
+export function sectionSummary(doc: IRDocument, section: IRSection) {
+  return {
+    id: section.id,
+    index: section.index,
+    title: section.title,
+    depth: section.depth,
+    steps: section.steps,
+    source: place(doc, section.source),
+    ...section.audience ? { audience: section.audience } : {},
+  }
+}
+
+export function deckInfo(doc: IRDocument, document: string) {
+  const count = (severity: Finding['severity']) => doc.diagnostics.filter(f => f.severity === severity).length
+  return {
+    document,
+    title: doc.meta.title,
+    lang: doc.meta.lang,
+    entry: place(doc, { file: doc.meta.entry, line: 1 }).file,
+    sections: doc.sections.length,
+    steps: doc.sections.reduce((sum, s) => sum + s.steps + 1, 0),
+    plugins: doc.config.plugins,
+    renderers: Object.keys(doc.config.renderers),
+    diagnostics: { errors: count('error'), warnings: count('warning'), infos: count('info') },
+  }
+}
+
+function origin(node: CodeNode) {
+  if (!node.origin) return undefined
+  const { anchor, file, startLine, endLine, status, drift, pin, permalink } = node.origin
+  return { anchor, file, startLine, endLine, status, ...drift ? { drift } : {}, ...pin ? { pin } : {}, ...permalink ? { permalink } : {} }
+}
+
+export function blockInfo(doc: IRDocument, block: IRBlock, step?: number) {
+  const { node } = block
+  const state = step === undefined ? undefined : blockState(block, step)
+  const base = {
+    id: block.id,
+    role: block.role,
+    kind: node.type === 'component' ? node.name : node.type,
+    at: block.at,
+    ...block.until !== undefined ? { until: block.until } : {},
+    ...block.span ? { span: block.span } : {},
+    ...block.only ? { only: block.only } : {},
+    ...block.audience ? { audience: block.audience } : {},
+    source: place(doc, block.source),
+  }
+  if (node.type !== 'code') return { ...base, text: blockText(block) }
+  const variant = state !== undefined ? node.variants?.[state] : undefined
+  return {
+    ...base,
+    lang: node.lang,
+    ...node.title ? { title: node.title } : {},
+    code: variant?.value ?? node.value,
+    ...variant ? { variant: variant.label } : {},
+    ...state !== undefined && node.highlight?.[state] ? { highlight: node.highlight[state] } : {},
+    ...node.origin ? { origin: origin(node) } : {},
+    ...node.run ? { run: node.run.when } : {},
+    ...node.outputs?.length ? { recorded: true } : {},
+  }
+}
+
+function narration(section: IRSection) {
+  return section.blocks.filter(b => b.role === 'narration').map(b => ({ step: b.at, block: b.id, text: blockText(b) }))
+}
+
+export function sectionDetail(doc: IRDocument, section: IRSection) {
+  return {
+    ...sectionSummary(doc, section),
+    narration: narration(section),
+    blocks: section.blocks.filter(b => b.role === 'visual').map(b => blockInfo(doc, b)),
+  }
+}
+
+export function stepDetail(doc: IRDocument, section: IRSection, step: number) {
+  if (!Number.isInteger(step) || step < 0 || step > section.steps) throw new Error(`section ${section.id} has steps 0 to ${section.steps}`)
+  return {
+    section: section.id,
+    title: section.title,
+    step,
+    steps: section.steps,
+    screen: section.blocks.filter(b => b.role === 'visual' && blockVisible(b, step)).map(b => blockInfo(doc, b, step)),
+    narration: narrationAt(section, step).map(b => blockText(b)),
+  }
+}
+
+export function codeRef(doc: IRDocument, section: IRSection, id: string) {
+  const block = findBlock(section, id)
+  if (block.node.type !== 'code') throw new Error(`block ${id} of section ${section.id} is not code`)
+  const { node } = block
+  return {
+    section: section.id,
+    block: id,
+    lang: node.lang,
+    ...node.title ? { title: node.title } : {},
+    code: node.value,
+    source: place(doc, block.source),
+    origin: origin(node) ?? null,
+    ...node.variants ? { variants: node.variants.map(v => ({ label: v.label, ...v.startLine ? { startLine: v.startLine, endLine: v.endLine } : {} })) } : {},
+    ...node.highlight ? { highlight: node.highlight } : {},
+  }
+}
+
+const TEXT = /^(text\/|application\/(json|javascript)$)/
+
+function outputData(output: RunOutput) {
+  if (output.output_type !== 'display_data' && output.output_type !== 'execute_result') return output
+  const data = Object.fromEntries(Object.entries(output.data).map(([mime, value]) =>
+    [mime, TEXT.test(mime) ? (typeof value === 'string' ? value : Array.isArray(value) ? value.join('') : JSON.stringify(value)) : `(${mime} data)`]))
+  return { output_type: output.output_type, data }
+}
+
+export function runInfo(run: RunResult | RecordedRun) {
+  return {
+    ok: run.ok,
+    exitCode: run.exitCode,
+    timedOut: run.timedOut,
+    executor: run.executorId,
+    stdout: run.stdout,
+    stderr: run.stderr,
+    ...run.outputs?.length ? { outputs: run.outputs.map(outputData) } : {},
+  }
+}
+
+export function outputsOf(section: IRSection, id?: string) {
+  const blocks = id ? [findBlock(section, id)] : [...irBlocks(section.blocks)]
+  return {
+    section: section.id,
+    outputs: blocks.flatMap(block => block.node.type === 'code' && (id || block.node.outputs?.length)
+      ? [{ block: block.id, lang: block.node.lang, runs: (block.node.outputs ?? []).map(runInfo) }]
+      : []),
+  }
+}
+
+export function diagnosticsOf(doc: IRDocument, findings: Finding[]) {
+  return findings.map(f => ({
+    severity: f.severity,
+    check: f.checkId,
+    message: f.message,
+    ...f.source ? place(doc, { file: f.source.file, line: f.source.line ?? 1 }) : {},
+    ...f.hint ? { hint: f.hint } : {},
+  }))
+}
+
+export function locate(doc: IRDocument, target: { section?: string, step?: number, block?: string, anchor?: string }) {
+  if (target.anchor) {
+    const found = doc.sections.flatMap(section => [...irBlocks(section.blocks)]
+      .filter(b => b.node.type === 'code' && b.node.origin?.anchor === target.anchor)
+      .map(b => ({ section: section.id, block: b.id, source: place(doc, b.source), code: origin(b.node as CodeNode) })))
+    if (found.length === 0) throw new Error(`no code block references ${target.anchor}`)
+    return { anchor: target.anchor, references: found }
+  }
+  if (!target.section) throw new Error('name a section, or an anchor')
+  const section = findSection(doc, target.section)
+  if (target.block) return { section: section.id, block: target.block, source: place(doc, findBlock(section, target.block).source) }
+  if (target.step !== undefined) {
+    const blocks = section.blocks.filter(b => b.at === target.step)
+    return { section: section.id, step: target.step, blocks: blocks.map(b => ({ block: b.id, role: b.role, source: place(doc, b.source) })) }
+  }
+  return { section: section.id, source: place(doc, section.source) }
+}
+
+const indexes = new WeakMap<IRDocument, MiniSearch>()
+
+function searchIndex(doc: IRDocument): MiniSearch {
+  let index = indexes.get(doc)
+  if (index) return index
+  index = new MiniSearch({ fields: ['title', 'titles', 'text'], storeFields: ['title', 'titles'], tokenize })
+  index.addAll(chapters(doc).flatMap(chapter => chapter.sections.map((section, i) => ({
+    id: section.id,
+    title: section.title,
+    titles: i === 0 ? [] : [chapter.title],
+    text: section.blocks.map(blockText).filter(Boolean).join('\n'),
+  }))))
+  indexes.set(doc, index)
+  return index
+}
+
+export function search(doc: IRDocument, query: string, limit = 10) {
+  const results = searchIndex(doc).search(query, { fuzzy: 0.2, prefix: true, boost: { title: 4, text: 2, titles: 1 } })
+  return {
+    query,
+    results: results.slice(0, limit).map(r => ({ section: r.id as string, title: r.title as string, titles: r.titles as string[], score: Math.round(r.score * 100) / 100 })),
+  }
+}

package/src/focus.ts

@@ -0,0 +1,87 @@
+import { readFileSync } from 'node:fs'
+import { dirname, isAbsolute, join, normalize, sep } from 'node:path'
+import { docBlocks, isRecord } from '@lincyaw/kernel'
+import type { Focus, FocusReport, IRDocument, SourceRange } from '@lincyaw/kernel'
+import { findBlock, findSection, place } from './deck.ts'
+
+export const EXCERPT_LINES = 20
+const QUOTE_CHARS = 2000
+const FROM = new Set<Focus['from']>(['source', 'web', 'slides'])
+
+const str = (value: unknown, max = 200) => (typeof value === 'string' && value !== '' && value.length <= max ? value : undefined)
+const line = (value: unknown) => (typeof value === 'number' && Number.isInteger(value) && value > 0 ? value : undefined)
+
+export function focusReport(value: unknown): FocusReport | string {
+  if (!isRecord(value)) return 'a focus is an object'
+  const id = str(value.id)
+  const from = value.from as Focus['from']
+  if (!id) return 'a focus has an id'
+  if (!FROM.has(from)) return 'a focus is from source, web or slides'
+  const source = isRecord(value.source) ? value.source : undefined
+  const range = source && str(source.file, 1000) && line(source.startLine) ? { file: source.file as string, startLine: source.startLine as number, endLine: line(source.endLine) ?? source.startLine as number } : undefined
+  if (source && !range) return 'a focus\'s source is { file, startLine, endLine }'
+  const report: FocusReport = { id, from }
+  for (const key of ['section', 'block'] as const) if (str(value[key])) report[key] = value[key] as string
+  if (typeof value.step === 'number' && Number.isInteger(value.step) && value.step >= 0) report.step = value.step
+  if (typeof value.quote === 'string' && value.quote.trim()) report.quote = value.quote.slice(0, QUOTE_CHARS)
+  if (range) report.source = range
+  if (!report.section && !report.block && !report.source) return 'a focus names a section, a block or a range of the source'
+  return report
+}
+
+export function excerptOf(text: string, start: number, end: number): string {
+  const lines = text.split(/\r?\n/).slice(start - 1, end)
+  if (lines.length <= EXCERPT_LINES) return lines.join('\n')
+  const half = EXCERPT_LINES / 2
+  return [...lines.slice(0, half), `[… ${lines.length - EXCERPT_LINES} more lines …]`, ...lines.slice(-half)].join('\n')
+}
+
+function blockAt(doc: IRDocument, range: SourceRange): { section: string, block?: string } | undefined {
+  let found: { section: string, block: string, span: number } | undefined
+  for (const { section, block } of docBlocks(doc)) {
+    const at = place(doc, block.source)
+    const end = at.endLine ?? at.line
+    if (at.file !== range.file || range.startLine < at.line || range.startLine > end) continue
+    if (!found || end - at.line < found.span) found = { section: section.id, block: block.id, span: end - at.line }
+  }
+  if (found) return { section: found.section, block: found.block }
+  const sections = doc.sections.filter((s) => {
+    const at = place(doc, s.source)
+    return at.file === range.file && at.line <= range.startLine
+  })
+  const section = sections.at(-1)
+  return section && { section: section.id }
+}
+
+export function resolveFocus(doc: IRDocument, document: string, report: FocusReport, read: (file: string) => string = file => readFileSync(file, 'utf8')): Focus {
+  const deckDir = dirname(doc.meta.entry)
+  let source: SourceRange
+  let section = report.section
+  let block = report.block
+  if (report.block || (report.section && !report.source)) {
+    const found = findSection(doc, report.section ?? [...docBlocks(doc)].find(b => b.block.id === report.block)?.section.id ?? '')
+    section = found.id
+    const at = report.block ? place(doc, findBlock(found, report.block).source) : place(doc, found.source)
+    source = { file: at.file, startLine: at.line, endLine: at.endLine ?? at.line }
+  } else {
+    const range = report.source!
+    const file = normalize(range.file)
+    if (isAbsolute(file) || file === '..' || file.startsWith(`..${sep}`)) throw new Error(`the file ${range.file} is not in the document directory`)
+    source = { file, startLine: range.startLine, endLine: Math.max(range.startLine, range.endLine) }
+    const at = blockAt(doc, source)
+    section ??= at?.section
+    block ??= at?.block
+  }
+  const excerpt = excerptOf(read(join(deckDir, source.file)), source.startLine, source.endLine)
+  return {
+    id: report.id,
+    from: report.from,
+    document,
+    source,
+    excerpt,
+    ...section ? { section } : {},
+    ...block ? { block } : {},
+    ...report.step !== undefined ? { step: report.step } : {},
+    ...report.quote ? { quote: report.quote } : {},
+  }
+}