Class NotebookProvider

Custom editor provider for Jupyter notebooks with dual-mode support. Handles both local file-based notebooks and collaborative Datalayer notebooks with runtime management, webview communication, and real-time synchronization.

Hierarchy (View Summary)

BaseDocumentProvider<NotebookDocument>
- NotebookProvider

Constructors

constructor

new NotebookProvider(context: ExtensionContext): NotebookProvider
Creates a new NotebookProvider.
Parameters
- context: ExtensionContext
  Extension context for resource access
Returns NotebookProvider
Overrides BaseDocumentProvider.constructor
- Defined in src/providers/notebookProvider.ts:207

Properties

`Protected` `Readonly`_callbacks

_callbacks: Map<string | number, (response: unknown) => void> = ...

Map of request ID to response callbacks for request/response message pattern.

`Protected` `Readonly`_context

_context: ExtensionContext

VS Code extension context providing access to storage, subscriptions, etc.

`Protected` `Readonly`_messageRouter

_messageRouter: DocumentMessageRouter

Message router for handling webview messages and routing to appropriate handlers.

`Protected` `Readonly`_networkBridge

_networkBridge: NetworkBridgeService

Network bridge service for HTTP/WebSocket communication between extension and webview.

`Protected` `Readonly`_onDidChangeCustomDocument

_onDidChangeCustomDocument: EventEmitter<
CustomDocumentEditEvent<NotebookDocument>,
> = ...

Event emitter for document changes. Subclasses should fire this event when documents change.

`Protected` `Readonly`_runners

_runners: Map<WebviewPanel, Runner> = ...

Map of webview panels to their Runner instances. Runners handle tool execution via the BridgeExecutor pattern.

`Protected` `Readonly`_runtimeBridge

_runtimeBridge: RuntimeBridgeService

Runtime bridge service for managing runtime lifecycle and selection.

`Private` `Readonly`autoConnectService

autoConnectService: AutoConnectService = ...

Auto-connect service for automatically connecting to runtimes

`Private` `Readonly`documents

documents: Map<string, NotebookDocument> = ...

Maps document URIs to NotebookDocument instances. Used to retrieve documents for makeEdit calls from webview content changes.

`Readonly`onDidChangeCustomDocument

onDidChangeCustomDocument: Event<CustomDocumentEditEvent<NotebookDocument>> = ...

Event for document changes (required by CustomEditorProvider interface).

`Private` `Readonly`webviews

webviews: WebviewCollection = ...

Tracks all known webviews

`Private` `Static`newNotebookFileId

newNotebookFileId: number = 1

`Private` `Static` `Readonly`viewType

viewType: "datalayer.jupyter-notebook"

Methods

backupCustomDocument

backupCustomDocument(
    document: NotebookDocument,
    context: CustomDocumentBackupContext,
    cancellation: CancellationToken,
): Thenable<CustomDocumentBackup>
Creates a backup of a custom document.
Parameters
- document: NotebookDocument
  Document to backup
- context: CustomDocumentBackupContext
  Backup context with destination
- cancellation: CancellationToken
  Cancellation token
Returns Thenable<CustomDocumentBackup>
Promise resolving to backup descriptor
Overrides BaseDocumentProvider.backupCustomDocument
- Defined in src/providers/notebookProvider.ts:840

`Private`cleanCompletion

cleanCompletion(completion: string): string
Clean LLM completion output by removing markdown code blocks.
Parameters
- completion: string
  Raw completion from LLM
Returns string
Cleaned completion
- Defined in src/providers/notebookProvider.ts:775

`Private`createProactiveLSPDocuments

createProactiveLSPDocuments(
notebookId: string,
documentData: Uint8Array,
): Promise<void>
Proactively create LSP virtual documents for all Python and Markdown cells. This allows Pylance to start analyzing BEFORE the webview finishes loading, providing instant completions when the user presses Tab.

Native VS Code notebooks create TextDocuments immediately when opening, giving Pylance time to analyze. Datalayer notebooks now do the same!
Parameters
- notebookId: string
  Unique notebook identifier
- documentData: Uint8Array
  Raw .ipynb file bytes
Returns Promise<void>
- Defined in src/providers/notebookProvider.ts:622

`Protected`getDocumentUri

getDocumentUri(document: NotebookDocument): Uri
Gets the URI for a notebook document.
Parameters
- document: NotebookDocument
  The notebook document
Returns Uri
The document URI
Overrides BaseDocumentProvider.getDocumentUri
- Defined in src/providers/notebookProvider.ts:911

`Private`getHtmlForWebview

getHtmlForWebview(webview: Webview): string
Get the static HTML used for the editor's webviews.
Parameters
- webview: Webview
  The webview instance
Returns string
HTML content for the webview
- Defined in src/providers/notebookProvider.ts:854

`Private`getLLMCompletion

getLLMCompletion(
    prefix: string,
    suffix: string,
    language: string,
): Promise<string>
Get LLM completion from VS Code Language Model API.
Parameters
- prefix: string
  Code before cursor
- suffix: string
  Code after cursor
- language: string
  Programming language
Returns Promise<string>
Completion string or null
- Defined in src/providers/notebookProvider.ts:720

`Protected`getRunnerForWebview

getRunnerForWebview(webviewPanel: WebviewPanel): Runner
Gets the Runner for a specific webview panel.
Parameters
- webviewPanel: WebviewPanel
  The webview panel
Returns Runner
The Runner instance, or undefined if not initialized
Inherited from BaseDocumentProvider.getRunnerForWebview
- Defined in src/providers/baseDocumentProvider.ts:247

`Protected`initializeRunnerForWebview

initializeRunnerForWebview(webviewPanel: WebviewPanel): Promise<Runner>
Initializes a Runner for a webview panel. Subclasses should call this in their resolveCustomEditor implementation.

The Runner uses a BridgeExecutor to send tool execution requests to the webview, where they are executed by the webview's own Runner with DefaultExecutor.
Parameters
- webviewPanel: WebviewPanel
  The webview panel to create a Runner for
Returns Promise<Runner>
The created Runner instance
Example
```
async resolveCustomEditor(document, webviewPanel, token) {
  // Initialize Runner for this webview
  await this.initializeRunnerForWebview(webviewPanel);

  // ... rest of setup
}
```
Inherited from BaseDocumentProvider.initializeRunnerForWebview
- Defined in src/providers/baseDocumentProvider.ts:224

`Protected`onMessage

onMessage(
    webviewPanel: WebviewPanel,
    document: NotebookDocument,
    message: ExtensionMessage,
): Promise<void>
Handles messages received from the webview. Delegates to the message router for all message types.
Parameters
- webviewPanel: WebviewPanel
  The webview panel that sent the message
- document: NotebookDocument
  The document associated with the webview
- message: ExtensionMessage
  The message from the webview
Returns Promise<void>
Inherited from BaseDocumentProvider.onMessage
- Defined in src/providers/baseDocumentProvider.ts:357

openCustomDocument

openCustomDocument(
    uri: Uri,
    openContext: { backupId?: string },
    _token: CancellationToken,
): Promise<NotebookDocument>
Opens a custom document for the notebook editor.
Parameters
- uri: Uri
  Document URI to open
- openContext: { backupId?: string }
  Context including backup information
- _token: CancellationToken
  Cancellation token
Returns Promise<NotebookDocument>
Promise resolving to the notebook document
Overrides BaseDocumentProvider.openCustomDocument
- Defined in src/providers/notebookProvider.ts:274

`Protected`postMessage

postMessage(panel: WebviewPanel, type: string, body: unknown, id?: string): void
Posts a message to the webview without expecting a response.
Parameters
- panel: WebviewPanel
  Target webview panel
- type: string
  Message type
- body: unknown
  Message body
- Optionalid: string
  Optional message ID
Returns void
Inherited from BaseDocumentProvider.postMessage
- Defined in src/providers/baseDocumentProvider.ts:283

`Protected`postMessageWithResponse

postMessageWithResponse<R = unknown>(
    panel: WebviewPanel,
    type: string,
    body: unknown,
): Promise<R>
Posts a message to the webview and waits for a response. Uses the request/response pattern with requestId tracking.
Type Parameters
- R = unknown
Parameters
- panel: WebviewPanel
  Target webview panel
- type: string
  Message type
- body: unknown
  Message body
Returns Promise<R>
Promise resolving to the response
Inherited from BaseDocumentProvider.postMessageWithResponse
- Defined in src/providers/baseDocumentProvider.ts:262

`Protected`registerMessageHandlers

registerMessageHandlers(): void
Registers notebook-specific message handlers. Overrides base class to add notebook content change handler.

Returns void
Overrides BaseDocumentProvider.registerMessageHandlers
- Defined in src/providers/notebookProvider.ts:866

resolveCustomEditor

resolveCustomEditor(
    document: NotebookDocument,
    webviewPanel: WebviewPanel,
    _token: CancellationToken,
): Promise<void>
Resolves a custom editor by setting up the webview and initializing communication.
Parameters
- document: NotebookDocument
  The notebook document to display
- webviewPanel: WebviewPanel
  The webview panel for the editor
- _token: CancellationToken
  Cancellation token
Returns Promise<void>
Promise that resolves when editor is ready
Overrides BaseDocumentProvider.resolveCustomEditor
- Defined in src/providers/notebookProvider.ts:385

revertCustomDocument

revertCustomDocument(
document: NotebookDocument,
cancellation: CancellationToken,
): Thenable<void>
Reverts a custom document to its saved state.
Parameters
- document: NotebookDocument
  Document to revert
- cancellation: CancellationToken
  Cancellation token
Returns Thenable<void>
Promise that resolves when revert is complete
Overrides BaseDocumentProvider.revertCustomDocument
- Defined in src/providers/notebookProvider.ts:825

saveCustomDocument

saveCustomDocument(
document: NotebookDocument,
cancellation: CancellationToken,
): Thenable<void>
Saves a custom document.
Parameters
- document: NotebookDocument
  Document to save
- cancellation: CancellationToken
  Cancellation token
Returns Thenable<void>
Promise that resolves when save is complete
Overrides BaseDocumentProvider.saveCustomDocument
- Defined in src/providers/notebookProvider.ts:795

saveCustomDocumentAs

saveCustomDocumentAs(
    document: NotebookDocument,
    destination: Uri,
    cancellation: CancellationToken,
): Thenable<void>
Saves a custom document to a new location.
Parameters
- document: NotebookDocument
  Document to save
- destination: Uri
  Target URI for saving
- cancellation: CancellationToken
  Cancellation token
Returns Thenable<void>
Promise that resolves when save is complete
Overrides BaseDocumentProvider.saveCustomDocumentAs
- Defined in src/providers/notebookProvider.ts:810

sendToWebviewWithResponse

sendToWebviewWithResponse(
    panel: WebviewPanel,
    message: unknown,
    requestId: string,
): Promise<unknown>
Send a message to a webview panel and wait for a response. Uses the request/response pattern inherited from BaseDocumentProvider.
Parameters
- panel: WebviewPanel
  Webview panel to send message to
- message: unknown
  Message to send (should include type and requestId)
- requestId: string
  Request ID to match response
Returns Promise<unknown>
Promise resolving to the response
- Defined in src/providers/notebookProvider.ts:232

`Private`showDatalayerRuntimeSelector

showDatalayerRuntimeSelector(document: NotebookDocument): void
Shows the Datalayer runtime selector dialog. Helper method to avoid code duplication.
Parameters
- document: NotebookDocument
  The notebook document
Returns void
- Defined in src/providers/notebookProvider.ts:921

`Private`tryAutoConnect

tryAutoConnect(documentUri: Uri): Promise<void>
Attempts to auto-connect the document to a runtime using configured strategies.
Parameters
- documentUri: Uri
  URI of the document being opened
Returns Promise<void>
- Defined in src/providers/notebookProvider.ts:966

`Static`register

register(context: ExtensionContext): Disposable
Registers the notebook editor provider and commands.
Parameters
- context: ExtensionContext
  Extension context for resource management
Returns Disposable
Disposable for cleanup
- Defined in src/providers/notebookProvider.ts:50

Class NotebookProvider

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NotebookProvider

Properties

Protected Readonly_callbacks

Protected Readonly_context

Protected Readonly_messageRouter

Protected Readonly_networkBridge

Protected Readonly_onDidChangeCustomDocument

Protected Readonly_runners

Protected Readonly_runtimeBridge

Private ReadonlyautoConnectService

Private Readonlydocuments

ReadonlyonDidChangeCustomDocument

Private Readonlywebviews

Private StaticnewNotebookFileId

Private Static ReadonlyviewType

Methods

backupCustomDocument

Parameters

Returns Thenable<CustomDocumentBackup>

PrivatecleanCompletion

Parameters

Returns string

PrivatecreateProactiveLSPDocuments

Parameters

Returns Promise<void>

ProtectedgetDocumentUri

Parameters

Returns Uri

PrivategetHtmlForWebview

Parameters

Returns string

PrivategetLLMCompletion

Parameters

Returns Promise<string>

ProtectedgetRunnerForWebview

Parameters

Returns Runner

ProtectedinitializeRunnerForWebview

Parameters

Returns Promise<Runner>

Example

ProtectedonMessage

Parameters

Returns Promise<void>

openCustomDocument

Parameters

Returns Promise<NotebookDocument>

ProtectedpostMessage

Parameters

Returns void

ProtectedpostMessageWithResponse

Type Parameters

Parameters

Returns Promise<R>

ProtectedregisterMessageHandlers

Returns void

resolveCustomEditor

Parameters

Returns Promise<void>

revertCustomDocument

Parameters

Returns Thenable<void>

saveCustomDocument

Parameters

Returns Thenable<void>

saveCustomDocumentAs

Parameters

Returns Thenable<void>

sendToWebviewWithResponse

Parameters

Returns Promise<unknown>

`Protected` `Readonly`_callbacks

`Protected` `Readonly`_context

`Protected` `Readonly`_messageRouter

`Protected` `Readonly`_networkBridge

`Protected` `Readonly`_onDidChangeCustomDocument

`Protected` `Readonly`_runners

`Protected` `Readonly`_runtimeBridge

`Private` `Readonly`autoConnectService

`Private` `Readonly`documents

`Readonly`onDidChangeCustomDocument

`Private` `Readonly`webviews

`Private` `Static`newNotebookFileId

`Private` `Static` `Readonly`viewType

`Private`cleanCompletion

`Private`createProactiveLSPDocuments

`Protected`getDocumentUri

`Private`getHtmlForWebview

`Private`getLLMCompletion

`Protected`getRunnerForWebview

`Protected`initializeRunnerForWebview

`Protected`onMessage

`Protected`postMessage

`Protected`postMessageWithResponse

`Protected`registerMessageHandlers

`Private`showDatalayerRuntimeSelector

`Private`tryAutoConnect

`Static`register