Interface IDocumentBridge

Document bridge interface for document lifecycle management. Implementations should handle downloading, caching, and runtime management.

interface IDocumentBridge {
    clearDocument(documentId: string): void;
    ensureRuntime(documentId: string): Promise<Runtime>;
    getActiveRuntimes(): string[];
    getDocumentMetadata(uri: Uri): DocumentMetadata;
    getMetadataById(documentId: string): DocumentMetadata;
    getMetadataByPath(inputPath: string): DocumentMetadata;
    openDocument(
        document: Document,
        spaceId?: string,
        spaceName?: string,
    ): Promise<Uri>;
}

Index

Methods

clearDocument ensureRuntime getActiveRuntimes getDocumentMetadata getMetadataById getMetadataByPath openDocument

Methods

clearDocument

clearDocument(documentId: string): void
Clears cached document from filesystem and memory.
Parameters
- documentId: string
  Document UID to clear
Returns void
- Defined in src/services/interfaces/IDocumentBridge.ts:87

ensureRuntime

ensureRuntime(documentId: string): Promise<Runtime>
Ensures a runtime exists for the document. Verifies cached runtime status or creates a new one if needed.
Parameters
- documentId: string
  Document UID needing runtime
Returns Promise<Runtime>
Runtime instance or undefined if creation fails
- Defined in src/services/interfaces/IDocumentBridge.ts:96

getActiveRuntimes

getActiveRuntimes(): string[]
Gets list of active runtime pod names.

Returns string[]
Array of runtime pod names
- Defined in src/services/interfaces/IDocumentBridge.ts:103

getDocumentMetadata

getDocumentMetadata(uri: Uri): DocumentMetadata
Gets document metadata by VS Code URI. Handles both real filesystem and virtual URI schemes.
Parameters
- uri: Uri
  Document URI
Returns DocumentMetadata
Document metadata if found
- Defined in src/services/interfaces/IDocumentBridge.ts:80

getMetadataById

getMetadataById(documentId: string): DocumentMetadata
Gets document metadata by document ID.
Parameters
- documentId: string
  Document UID
Returns DocumentMetadata
Document metadata if found
- Defined in src/services/interfaces/IDocumentBridge.ts:71

getMetadataByPath

getMetadataByPath(inputPath: string): DocumentMetadata
Gets document metadata by path. Resolves virtual URIs to real paths for lookup.
Parameters
- inputPath: string
  Virtual or real filesystem path
Returns DocumentMetadata
Document metadata if found
- Defined in src/services/interfaces/IDocumentBridge.ts:63

openDocument

openDocument(
    document: Document,
    spaceId?: string,
    spaceName?: string,
): Promise<Uri>
Opens a document from Datalayer platform. Downloads content, caches locally, and creates virtual URI for VS Code.
Parameters
- document: Document
  The document to open
- OptionalspaceId: string
  ID of the containing space
- OptionalspaceName: string
  Name of the containing space
Returns Promise<Uri>
Virtual URI for the opened document
- Defined in src/services/interfaces/IDocumentBridge.ts:50