Class DocumentBridge

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

Example

const bridge = DocumentBridge.getInstance(context);
const uri = await bridge.openDocument(document, spaceId, spaceName);

Constructors

`Private`constructor

new DocumentBridge(
context?: ExtensionContext,
sdk?: DatalayerClient,
): DocumentBridge
Parameters
- Optionalcontext: ExtensionContext
- Optionalsdk: DatalayerClient
Returns DocumentBridge
- Defined in src/services/bridges/documentBridge.ts:127

Properties

`Private`activeRuntimes

activeRuntimes: Set<string> = ...

`Private`documentMetadata

documentMetadata: Map<string, DocumentMetadata> = ...

`Private`tempDir

tempDir: string

`Private` `Static` `Optional`context

context?: ExtensionContext

`Private` `Static`instance

instance: DocumentBridge

`Private` `Static` `Readonly`METADATA_STORAGE_KEY

METADATA_STORAGE_KEY: "datalayer.documentMetadata"

`Private` `Static`sdk

sdk: DatalayerClient

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:538

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:616

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:555

getActiveRuntimes

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

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

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

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:516

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:489

`Private`loadMetadata

loadMetadata(): void
Load persisted document metadata from storage. Only restores metadata where the local file still exists.

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

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:262

`Private`saveMetadata

saveMetadata(): Promise<void>
Persist document metadata to storage.

Returns Promise<void>
- Defined in src/services/bridges/documentBridge.ts:172

`Static`getInstance

getInstance(context?: ExtensionContext, sdk?: 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)
- Optionalsdk: DatalayerClient
  SDK 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:241

`Static`getInstanceAsync

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

Class DocumentBridge

Example

Index

Constructors

Properties

Methods

Constructors

Privateconstructor

Parameters

Returns DocumentBridge

Properties

PrivateactiveRuntimes

PrivatedocumentMetadata

PrivatetempDir

Private Static Optionalcontext

Private Staticinstance

Private Static ReadonlyMETADATA_STORAGE_KEY

Private Staticsdk

Methods

clearDocument

Parameters

Returns void

dispose

Returns void

ensureRuntime

Parameters

Returns Promise<RuntimeDTO>

getActiveRuntimes

Returns string[]

getDocumentMetadata

Parameters

Returns DocumentMetadata

getMetadataById

Parameters

Returns DocumentMetadata

getMetadataByPath

Parameters

Returns DocumentMetadata

PrivateloadMetadata

Returns void

openDocument

Parameters

Returns Promise<Uri>

PrivatesaveMetadata

Returns Promise<void>

StaticgetInstance

Parameters

Returns DocumentBridge

Deprecated

StaticgetInstanceAsync

Parameters

Returns Promise<DocumentBridge>

Settings

On This Page

`Private`constructor

`Private`activeRuntimes

`Private`documentMetadata

`Private`tempDir

`Private` `Static` `Optional`context

`Private` `Static`instance

`Private` `Static` `Readonly`METADATA_STORAGE_KEY

`Private` `Static`sdk

`Private`loadMetadata

`Private`saveMetadata

`Static`getInstance

`Static`getInstanceAsync