/** * Pure read presentation: turn provider-decoded text into a bounded, line-numbered window and * model-facing envelope. Chunk scanning caps the current line, so even one newline-free giant * line cannot grow memory without bound. * @module @deepseek-ai/dsh-tool-fs/read-render */ import { FsError } from '@deepseek-ai/dsh-fs' /** Default maximum characters returned for a single line (the `readMaxLineLength` config). */ export const READ_MAX_LINE_LENGTH = 2000 /** Default maximum bytes returned for selected file lines (the `readMaxBytes` config). */ export const READ_MAX_BYTES = 50 * 1024 /** Resolved read window. The consumer applies its defaults/caps before calling. */ export interface ReadWindow { /** 1-based first line to return. */ offset: number /** Maximum number of lines to return. */ limit: number /** Maximum characters returned for a single line; overflow is truncated with a suffix. */ maxLineLength: number /** Maximum bytes of selected output; overflow stops the scan and marks `truncatedByBytes`. */ maxBytes: number } /** One line returned from a text file. */ export interface FileTextLine { /** 1-based line number in the file. */ number: number /** Line text without its trailing newline. */ text: string } /** The windowed result {@link buildWindow} produces from a file's decoded text. */ export interface WindowResult { /** Returned lines, already numbered. */ lines: FileTextLine[] /** Exact total line count in the file. */ totalLines: number /** Whether selected output hit the byte cap. */ truncatedByBytes: boolean } /** Outcome of a bounded text read — what {@link formatReadOutput} renders. */ export interface FileReadOutcome { /** 1-based first line requested. */ offset: number /** Returned lines, already numbered. */ lines: FileTextLine[] /** Exact total line count in the file. */ totalLines: number /** Whether selected output hit the byte cap. */ truncatedByBytes?: true } interface WindowAccumulator { lines: FileTextLine[] totalLines: number outputBytes: number truncatedByBytes: boolean } function newAccumulator(): WindowAccumulator { return { lines: [], totalLines: 0, outputBytes: 0, truncatedByBytes: false } } function truncateLine(line: string, maxLineLength: number): string { return line.length > maxLineLength ? `${line.substring(0, maxLineLength)}... (line truncated to ${maxLineLength} chars)` : line } function lineByteSize(line: string, currentLineCount: number): number { return Buffer.byteLength(line, 'utf8') + (currentLineCount > 0 ? 1 : 0) } function consumeLine(acc: WindowAccumulator, rawLine: string, request: ReadWindow): void { acc.totalLines += 1 if (acc.truncatedByBytes || acc.totalLines < request.offset || acc.lines.length >= request.limit) return const text = truncateLine(rawLine, request.maxLineLength) const bytes = lineByteSize(text, acc.lines.length) if (acc.outputBytes + bytes > request.maxBytes) { acc.truncatedByBytes = true return } acc.outputBytes += bytes acc.lines.push({ number: acc.totalLines, text }) } function stripCarriageReturn(line: string): string { return line.endsWith('\r') ? line.slice(0, -1) : line } function finish(acc: WindowAccumulator, request: ReadWindow, displayPath: string): WindowResult { if (!acc.truncatedByBytes && request.offset > acc.totalLines && !(acc.totalLines === 0 && request.offset === 1)) { throw new FsError(`offset ${request.offset} is out of range for "${displayPath}" (${acc.totalLines} lines)`, 'FS_NOT_FOUND') } return { lines: acc.lines, totalLines: acc.totalLines, truncatedByBytes: acc.truncatedByBytes } } /** * Build one window from streamed or whole-file chunks, enforcing line and byte caps while still * scanning to an exact total line count, and throwing `FS_NOT_FOUND` when the requested offset is * past EOF. * @param chunks - decoded text chunks in file order; chunk boundaries carry no meaning. * @param request - the resolved window; the caller has already applied its defaults and caps. * @param displayPath - the caller-facing path used in the offset-out-of-range error. * @returns the numbered window lines, the total line count seen, and the byte-cap truncation flag. */ export async function buildWindow( chunks: AsyncIterable | Iterable, request: ReadWindow, displayPath: string, ): Promise { const acc = newAccumulator() // One char past the truncation point is enough to prove a line overflows. const lineBufferCap = request.maxLineLength + 1 let lineBuffer = '' function appendToLineBuffer(segment: string): void { if (lineBuffer.length >= lineBufferCap) return lineBuffer += segment if (lineBuffer.length > lineBufferCap) lineBuffer = lineBuffer.slice(0, lineBufferCap) } function flushLine(): void { consumeLine(acc, stripCarriageReturn(lineBuffer), request) lineBuffer = '' } for await (const chunk of chunks) { let startPos = 0 let newlinePos: number while ((newlinePos = chunk.indexOf('\n', startPos)) !== -1) { appendToLineBuffer(chunk.slice(startPos, newlinePos)) flushLine() startPos = newlinePos + 1 } appendToLineBuffer(chunk.slice(startPos)) } if (lineBuffer.length > 0) flushLine() return finish(acc, request, displayPath) } /** * Format a read outcome as one OpenCode-style line-numbered text block body. * @param displayPath - the backend-resolved path rendered in the envelope's `` element. * @param outcome - the windowed read to render. * @returns the model-facing envelope: numbered lines plus a continuation or end-of-file footer. */ export function formatReadOutput(displayPath: string, outcome: FileReadOutcome): string { const endLine = outcome.lines.at(-1)?.number ?? Math.max(0, outcome.offset - 1) let footer: string if (outcome.truncatedByBytes) { footer = `(Output capped. Showing lines ${outcome.offset}-${endLine}. Use offset=${endLine + 1} to continue.)` } else if (endLine < outcome.totalLines) { footer = `(Showing lines ${outcome.offset}-${endLine} of ${outcome.totalLines}. Use offset=${endLine + 1} to continue.)` } else { footer = `(End of file - total ${outcome.totalLines} lines)` } const body = outcome.lines.length > 0 ? `${outcome.lines.map(line => `${line.number}: ${line.text}`).join('\n')}\n\n${footer}` : footer return `${displayPath} file ${body} ` } /** * Lowercased file-extension to syntax-highlighting language hint. Keys are the * extension without its dot; a UI treats an absent key as plain text. The map is * intentionally small — common source, config, and markup extensions a * line-numbered code view benefits from highlighting — not an exhaustive registry. */ const LANG_BY_EXTENSION: Readonly> = { ts: 'ts', tsx: 'tsx', mts: 'ts', cts: 'ts', js: 'js', jsx: 'jsx', mjs: 'js', cjs: 'js', json: 'json', jsonc: 'json', py: 'py', rb: 'rb', go: 'go', rs: 'rs', java: 'java', c: 'c', h: 'c', cc: 'cpp', cpp: 'cpp', hpp: 'cpp', cxx: 'cpp', cs: 'cs', kt: 'kotlin', swift: 'swift', php: 'php', sh: 'sh', bash: 'sh', zsh: 'sh', yaml: 'yaml', yml: 'yaml', toml: 'toml', ini: 'ini', md: 'md', markdown: 'md', mdx: 'mdx', html: 'html', htm: 'html', css: 'css', scss: 'scss', less: 'less', sql: 'sql', xml: 'xml', lua: 'lua', } /** * Derive a syntax-highlighting language hint from a read path's file extension. * Pure and case-insensitive on the extension; a dotfile with no extension * (`.gitignore`) and an unknown extension both yield `undefined`. * @param path - the model-facing path the read reported. * @returns the language hint for {@link LANG_BY_EXTENSION}, or `undefined` when the extension maps to none. */ export function langFromPath(path: string): string | undefined { const base = path.slice(Math.max(path.lastIndexOf('/'), path.lastIndexOf('\\')) + 1) const dot = base.lastIndexOf('.') // A leading dot is a dotfile (no extension), not an empty extension. if (dot <= 0) return undefined const ext = base.slice(dot + 1).toLowerCase() // Own-property check only: a filename whose extension is an Object.prototype // key (`foo.constructor`, `foo.__proto__`) must map to no language, not to the // inherited member — otherwise a function would reach `lang` and fail the // tool-output JSON validation. return Object.hasOwn(LANG_BY_EXTENSION, ext) ? LANG_BY_EXTENSION[ext] : undefined } /** * The `read` tool's private `tool/result` `meta` payload: the structured * line-numbered window a capable UI renders as a code view. Attached opaquely (as * `unknown`) on the tool result and persisted with the session log — it must be * JSON-serializable (the session validates this at `append`), so `presentResult` * reproduces the read card on replay when the raw structured output is no longer * on the wire. The producing tool owns and narrows this opaque shape. */ export interface FsReadMeta { /** The read file's model-facing path. */ path: string /** The 1-based first line the window requested, kept even when `lines` is empty. */ offset: number /** The returned window's lines, each keeping its file line number. */ lines: FileTextLine[] /** Exact total line count in the file. */ totalLines: number /** Syntax-highlighting language hint from the extension, or omitted for plain text. */ lang?: string } /** * Whether `value` is a valid {@link FileTextLine} (defensive narrowing from * opaque `meta`). `number` must be a 1-based integer line number, since a card * rendered from a zero, fractional, or non-finite line number would violate the * 1-based numbering contract the read window promises. */ function isFileTextLine(value: unknown): value is FileTextLine { if (typeof value !== 'object' || value === null || Array.isArray(value)) return false const { number, text } = value as Record return typeof number === 'number' && Number.isInteger(number) && number >= 1 && typeof text === 'string' } /** * Narrow opaque live or replayed result metadata to a structured read window. * Malformed metadata returns `undefined` so presentation can fall back to the * generic text card instead of throwing during replay. Beyond shape, the * semantic contract of a read window is enforced against replayed JSON that is * well-typed but out of range: `offset` must be a 1-based integer, `totalLines` * must be a non-negative integer, each line number must be a 1-based integer no * less than `offset`, the line numbers must strictly increase, and no line number * may exceed `totalLines`. Any violation declines to the generic fallback rather * than emitting a card that misnumbers or overcounts. * @param meta - result metadata. * @returns the validated read window, or `undefined` for absent, malformed, or semantically invalid data. */ export function readMetaFromMeta(meta: unknown): FsReadMeta | undefined { if (typeof meta !== 'object' || meta === null || Array.isArray(meta)) return undefined const { path, offset, lines, totalLines, lang } = meta as Record if (typeof path !== 'string' || typeof totalLines !== 'number' || typeof offset !== 'number') return undefined if (!Number.isInteger(offset) || offset < 1) return undefined if (!Number.isInteger(totalLines) || totalLines < 0) return undefined if (!Array.isArray(lines) || !lines.every(isFileTextLine)) return undefined if (lang !== undefined && typeof lang !== 'string') return undefined let previous = offset - 1 for (const { number } of lines) { if (number <= previous || number > totalLines) return undefined previous = number } return { path, offset, lines, totalLines, ...lang === undefined ? {} : { lang } } }