Files
deepseek-harness/packages/client/ui-sidebar-documentpreview/src/client/document/contract.ts
T

70 lines
2.9 KiB
TypeScript

/** Document renderer slot: the owner supplies shared file state, renderers own their presentation. */
import type { PropsRuntime, SlotHookFactory } from '@deepseek-ai/dsh-client-ui-slots'
import type { UseSidebarRightTabInfo } from '@deepseek-ai/dsh-client-ui-sidebar-right/client'
import type { RefCallback } from 'react'
/** One loaded text window, retaining source line positions. */
export interface DocumentTextPage {
readonly offset: number
readonly text: string
readonly lines: number
}
/**
* Ordinary file contents, or a request for the selected renderer to load its content.
* Byte arrays are transient UI input, never persisted layout or Session data.
*/
export type DocumentContent =
| { readonly kind: 'text'; readonly text: string; readonly pages: readonly DocumentTextPage[]; readonly eof: boolean }
| { readonly kind: 'bytes'; readonly data: Uint8Array<ArrayBuffer> }
| {
readonly kind: 'renderer'
/** Changes on reload or implementation replacement; retained contents belong to one revision. */
readonly revision: number
/** Report the displayed source version; stale revisions cannot update the owner. @param version - loaded source version. */
readonly loaded: (version: string) => void
/** Cancel the current load and start a new revision. */
readonly reload: () => void
}
/** Content and viewing inputs shared by document bodies and nested PDF presentation. */
export interface DocumentBodyOwner {
/** Original file address, also readable through the standard useResource hook. */
readonly resourceAddress: string
/** Ordinary file content or a renderer-owned loading request; text accumulates until eof. */
readonly content: DocumentContent
/** The document toolbar's current wrapping preference. */
readonly wrap: boolean
/** Report a renderer-owned scrollport; passing `null` restores the shared body as the owner. */
readonly scrollportRef: RefCallback<HTMLElement>
}
declare module '@deepseek-ai/dsh-client-ui-slots' {
interface SlotMap {
/** Document body selected by a registered implementation id. */
'sidebar.right.tab.document': {
kind: 'keyed'
scope: 'session'
owner: DocumentBodyOwner
hookContext: UseSidebarRightTabInfo
inject: {
hooks: {
tabInfo: SlotHookFactory<'sidebar.right.tab.document', UseSidebarRightTabInfo>
}
}
}
}
}
/** Standard input for every document body; entry-local stores and locale props can be intersected with it. */
export type DocumentPreviewProps = PropsRuntime<'sidebar.right.tab.document'>
/**
* Forward the framework's tab reader to the selected document body.
* @param _standard - framework standard props.
* @param useTabInfo - enclosing tab's bound reader.
* @returns the same reader, without another subscription adapter.
*/
export const documentTabInfoFactory: SlotHookFactory<'sidebar.right.tab.document', UseSidebarRightTabInfo> =
(_standard, useTabInfo) => useTabInfo