Files
deepseek-harness/packages/client/file-upload/src/client/contract.ts
T

34 lines
1.3 KiB
TypeScript

import type { SessionId } from '@deepseek-ai/dsh-session/types'
import type { RemoteResult } from '@deepseek-ai/dsh-typert-protocol'
import type { FileUploadValue } from '../types.ts'
/** Browser request body accepted by the background file-upload service. */
export type FileUploadBody = Blob | ReadableStream<Uint8Array>
/** Monotone byte progress reported while a browser body is consumed. */
export interface FileUploadProgress {
readonly loaded: number
readonly total?: number
}
/** Browser upload service addressed by one Session identity. */
export interface FileUploadService {
/**
* Store one file for a Session. Blob and stream bodies use
* the background carrier; exact bytes use Remote.
* @param sessionId - Session that owns the staged receipt.
* @param data - browser Blob, exact bytes, or a one-shot byte stream.
* @param name - optional display name.
* @param signal - optional cancellation for the active upload.
* @param onProgress - optional byte-progress observer for background bodies.
* @returns the staged receipt and durable file reference, or a business error.
*/
upload(
sessionId: SessionId,
data: Blob | Uint8Array | ReadableStream<Uint8Array>,
name?: string,
signal?: AbortSignal,
onProgress?: (progress: FileUploadProgress) => void,
): Promise<RemoteResult<FileUploadValue>>
}