Class DocumentBridge

Manages document lifecycle between Datalayer platform and local filesystem. Singleton service that handles document caching and runtime association.

Index

Methods

clearDocument dispose ensureRuntime getActiveRuntimes getDocumentMetadata getMetadataById getMetadataByPath openDocument getInstance getInstanceAsync

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/bridges/documentBridge.ts:568

dispose

dispose(): void
Cleans up temporary files and metadata on disposal. Removes cached documents and clears runtime tracking.

Returns void
- Defined in src/services/bridges/documentBridge.ts:649

ensureRuntime

ensureRuntime(documentId: string): Promise<RuntimeDTO>
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<RuntimeDTO>
Runtime instance or undefined if creation fails.
- Defined in src/services/bridges/documentBridge.ts:586

getActiveRuntimes

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

Returns string[]
Array of runtime pod names.
- Defined in src/services/bridges/documentBridge.ts:641

getDocumentMetadata

getDocumentMetadata(uri: Uri): DocumentMetadata
Gets document metadata by VS Code URI. Handles both real filesystem and virtual URI schemes.
Parameters
- uri: Uri
  The target document identifier to look up.
Returns DocumentMetadata
Document metadata if found.
- Defined in src/services/bridges/documentBridge.ts:557

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/bridges/documentBridge.ts:545

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/bridges/documentBridge.ts:517

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/bridges/documentBridge.ts:362

`Static`getInstance

getInstance(
context?: ExtensionContext,
datalayer?: DatalayerClient,
): DocumentBridge
Gets the singleton instance of DocumentBridge (synchronous). Use getInstanceAsync() for better reliability during startup.
Parameters
- Optionalcontext: ExtensionContext
  Extension context (required on first call).
- Optionaldatalayer: DatalayerClient
  Datalayer instance (required on first call).
Returns DocumentBridge
The singleton instance.

Deprecated
Use getInstanceAsync() for documents opened during VS Code startup.
- Defined in src/services/bridges/documentBridge.ts:340

`Static`getInstanceAsync

getInstanceAsync(
context?: ExtensionContext,
datalayer?: DatalayerClient,
): Promise<DocumentBridge>
Gets the singleton instance of DocumentBridge. Waits for extension initialization if necessary.
Parameters
- Optionalcontext: ExtensionContext
  Extension context (required on first call).
- Optionaldatalayer: DatalayerClient
  Datalayer instance (required on first call).
Returns Promise<DocumentBridge>
The singleton instance.
- Defined in src/services/bridges/documentBridge.ts:294