Class LexicalProvider

Custom editor provider for Lexical documents. Handles webview lifecycle management, document state synchronization, and collaboration features for rich text editing.

Example

const provider = new LexicalProvider(context);
// Provider is registered automatically via static register method

Hierarchy (View Summary)

BaseDocumentProvider<LexicalDocument>
- LexicalProvider

Index

Constructors

constructor

Properties

_callbacks _context _messageRouter _networkBridge _onDidChangeCustomDocument _runners _runtimeBridge adapterConnectionTimes adapterCreationTimes adapterToWebview autoConnectService documents loroAdapters onDidChangeCustomDocument webviews _instance viewType

Constructors

constructor

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

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<LexicalDocument>,
> = ...

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`adapterConnectionTimes

adapterConnectionTimes: Map<string, number> = ...

`Private` `Readonly`adapterCreationTimes

adapterCreationTimes: Map<string, number> = ...

`Private` `Readonly`adapterToWebview

adapterToWebview: Map<string, string> = ...

`Private` `Readonly`autoConnectService

autoConnectService: AutoConnectService = ...

Auto-connect service for automatically connecting to runtimes

`Private` `Readonly`documents

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

Map of document instances keyed by document URI. Used for dirty state tracking and document operations.

`Private` `Readonly`loroAdapters

loroAdapters: Map<string, LoroWebSocketAdapter> = ...

Map of Loro WebSocket adapters keyed by adapter ID.

`Readonly`onDidChangeCustomDocument

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

Event for document changes (required by CustomEditorProvider interface).

`Private` `Readonly`webviews

webviews: Map<string, { resource: string; webviewPanel: WebviewPanel }> = ...

Map of currently active webviews keyed by document URI.

`Private` `Static`_instance

_instance: LexicalProvider

`Private` `Static` `Readonly`viewType

viewType: "datalayer.lexical-editor"

Methods

backupCustomDocument

backupCustomDocument(
    document: LexicalDocument,
    context: CustomDocumentBackupContext,
    cancellation: CancellationToken,
): Thenable<CustomDocumentBackup>
Creates a backup of a custom document.
Parameters
- document: LexicalDocument
  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/lexicalProvider.ts:956

`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/lexicalProvider.ts:1359

`Private`createProactiveLSPDocuments

createProactiveLSPDocuments(
lexicalId: string,
documentData: Uint8Array,
): Promise<void>
Proactively create LSP virtual documents for all Python and Markdown JupyterInputNodes. Parses the Lexical editor state JSON and extracts code blocks. This allows Pylance to start analyzing BEFORE the webview finishes loading, providing instant completions when the user presses Tab.
Parameters
- lexicalId: string
  Unique lexical document identifier
- documentData: Uint8Array
  Raw .dlex file bytes (Lexical editor state JSON)
Returns Promise<void>
- Defined in src/providers/lexicalProvider.ts:762

`Private`getCompletionConfig

getCompletionConfig(): InlineCompletionConfig
Get completion configuration from VS Code settings. Reads user preferences for inline completions (code and prose).

Returns InlineCompletionConfig
InlineCompletionConfig with user settings or defaults
- Defined in src/providers/lexicalProvider.ts:1050

`Protected`getDocumentUri

getDocumentUri(document: LexicalDocument): Uri
Gets the URI for a lexical document.
Parameters
- document: LexicalDocument
  The lexical document
Returns Uri
The document URI
Overrides BaseDocumentProvider.getDocumentUri
- Defined in src/providers/lexicalProvider.ts:1146

`Private`getDocumentUriForPanel

getDocumentUriForPanel(panel: WebviewPanel): string
Find document URI for a given webview panel
Parameters
- panel: WebviewPanel
Returns string
- Defined in src/providers/lexicalProvider.ts:377

`Private`getHtmlForWebview

getHtmlForWebview(webview: Webview): string
Generates the HTML content for the Lexical editor webview.
Parameters
- webview: Webview
  The webview instance
Returns string
HTML content for the webview
- Defined in src/providers/lexicalProvider.ts:970

`Private`getLLMCompletion

getLLMCompletion(
    prefix: string,
    suffix: string,
    language: string,
    contentType?: "code" | "prose",
): Promise<string>
Requests completion from VS Code's Language Model API. Uses GitHub Copilot if available, falls back to other models. Supports both code and prose completions with appropriate prompts.
Parameters
- prefix: string
  Text before cursor position
- suffix: string
  Text after cursor position
- language: string
  Programming language (e.g., 'python')
- contentType: "code" | "prose" = "code"
  Content type ('code' or 'prose') for prompt selection
Returns Promise<string>
Completion text or null if unavailable

Remarks
Requires VS Code 1.90+ with Language Model API enabled. Automatically cleans markdown formatting from LLM responses.
- Defined in src/providers/lexicalProvider.ts:1285

`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

`Private`handleLoroMessage

handleLoroMessage(
    message: {
        adapterId: string;
        data?: { websocketUrl?: string; [key: string]: unknown };
        type: string;
    },
    webviewPanel: WebviewPanel,
): void
Handles Loro collaboration messages from the webview. Creates/manages WebSocket adapters and forwards messages.
Parameters
- message: {
      adapterId: string;
      data?: { websocketUrl?: string; [key: string]: unknown };
      type: string;
  }
  Message from webview
- webviewPanel: WebviewPanel
  The webview panel
Returns void
- Defined in src/providers/lexicalProvider.ts:1157

initializeAuthListener

initializeAuthListener(authProvider: SDKAuthProvider): void
Initialize auth listener for userInfo updates. Called after extension activation, passing authProvider directly to avoid circular dependency.
Parameters
- authProvider: SDKAuthProvider
Returns void
- Defined in src/providers/lexicalProvider.ts:337

`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: LexicalDocument,
    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: LexicalDocument
  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<LexicalDocument>
Opens a custom document for the lexical editor.
Parameters
- uri: Uri
  Document URI to open
- openContext: { backupId?: string }
  Context including backup information
- _token: CancellationToken
  Cancellation token
Returns Promise<LexicalDocument>
Promise resolving to the lexical document
Overrides BaseDocumentProvider.openCustomDocument
- Defined in src/providers/lexicalProvider.ts:396

`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

refreshCollaborationConfigs

refreshCollaborationConfigs(): Promise<void>
Refreshes collaboration config for all active webviews. Called when auth state changes (login/logout) to update usernames.

Returns Promise<void>
- Defined in src/providers/lexicalProvider.ts:205

`Protected`registerMessageHandlers

registerMessageHandlers(): void
Registers lexical-specific message handlers. Overrides base class to add lexical-specific handlers.

Returns void
Overrides BaseDocumentProvider.registerMessageHandlers
- Defined in src/providers/lexicalProvider.ts:1085

resolveCustomEditor

resolveCustomEditor(
    document: LexicalDocument,
    webviewPanel: WebviewPanel,
    _token: CancellationToken,
): Promise<void>
Resolves a custom editor by setting up the webview and initializing collaboration.
Parameters
- document: LexicalDocument
  The lexical 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/lexicalProvider.ts:499

revertCustomDocument

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

saveCustomDocument

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

saveCustomDocumentAs

saveCustomDocumentAs(
    document: LexicalDocument,
    destination: Uri,
    cancellation: CancellationToken,
): Thenable<void>
Saves a custom document to a new location.
Parameters
- document: LexicalDocument
  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/lexicalProvider.ts:926

sendToWebview

sendToWebview(uri: Uri, message: unknown): Promise<void>
Send a message to a specific Lexical webview
Parameters
- uri: Uri
- message: unknown
Returns Promise<void>
- Defined in src/providers/lexicalProvider.ts:186

sendToWebviewWithResponse

sendToWebviewWithResponse(
    uri: Uri,
    message: unknown,
    requestId: string,
): Promise<unknown>
Send a message to a specific Lexical webview and wait for response
Parameters
- uri: Uri
- message: unknown
- requestId: string
Returns Promise<unknown>
- Defined in src/providers/lexicalProvider.ts:248

`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/lexicalProvider.ts:1380

`Private`updateUserInfoInAllWebviews

updateUserInfoInAllWebviews(authProvider: SDKAuthProvider): void
Updates userInfo in all open lexical webviews when auth state changes (login/logout)
Parameters
- authProvider: SDKAuthProvider
Returns void
- Defined in src/providers/lexicalProvider.ts:348

`Static`getInstance

getInstance(): LexicalProvider
Get the singleton instance of LexicalProvider for message routing

Returns LexicalProvider
- Defined in src/providers/lexicalProvider.ts:179

`Static`register

register(context: ExtensionContext): Disposable
Registers the Lexical editor provider and commands with VS Code.
Parameters
- context: ExtensionContext
  Extension context for resource management
Returns Disposable
Disposable for cleanup
- Defined in src/providers/lexicalProvider.ts:64

Class LexicalProvider

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LexicalProvider

Properties

Protected Readonly_callbacks

Protected Readonly_context

Protected Readonly_messageRouter

Protected Readonly_networkBridge

Protected Readonly_onDidChangeCustomDocument

Protected Readonly_runners

Protected Readonly_runtimeBridge

Private ReadonlyadapterConnectionTimes

Private ReadonlyadapterCreationTimes

Private ReadonlyadapterToWebview

Private ReadonlyautoConnectService

Private Readonlydocuments

Private ReadonlyloroAdapters

ReadonlyonDidChangeCustomDocument

Private Readonlywebviews

Private Static_instance

Private Static ReadonlyviewType

Methods

backupCustomDocument

Parameters

Returns Thenable<CustomDocumentBackup>

PrivatecleanCompletion

Parameters

Returns string

PrivatecreateProactiveLSPDocuments

Parameters

Returns Promise<void>

PrivategetCompletionConfig

Returns InlineCompletionConfig

ProtectedgetDocumentUri

Parameters

Returns Uri

PrivategetDocumentUriForPanel

Parameters

Returns string

PrivategetHtmlForWebview

Parameters

Returns string

PrivategetLLMCompletion

Parameters

Returns Promise<string>

Remarks

ProtectedgetRunnerForWebview

Parameters

Returns Runner

PrivatehandleLoroMessage

Parameters

Returns void

initializeAuthListener

Parameters

Returns void

ProtectedinitializeRunnerForWebview

Parameters

Returns Promise<Runner>

Example

ProtectedonMessage

Parameters

Returns Promise<void>

openCustomDocument

Parameters

Returns Promise<LexicalDocument>

ProtectedpostMessage

Parameters

Returns void

ProtectedpostMessageWithResponse

Type Parameters

Parameters

Returns Promise<R>

`Protected` `Readonly`_callbacks

`Protected` `Readonly`_context

`Protected` `Readonly`_messageRouter

`Protected` `Readonly`_networkBridge

`Protected` `Readonly`_onDidChangeCustomDocument

`Protected` `Readonly`_runners

`Protected` `Readonly`_runtimeBridge

`Private` `Readonly`adapterConnectionTimes

`Private` `Readonly`adapterCreationTimes

`Private` `Readonly`adapterToWebview

`Private` `Readonly`autoConnectService

`Private` `Readonly`documents

`Private` `Readonly`loroAdapters

`Readonly`onDidChangeCustomDocument

`Private` `Readonly`webviews

`Private` `Static`_instance

`Private` `Static` `Readonly`viewType

`Private`cleanCompletion

`Private`createProactiveLSPDocuments

`Private`getCompletionConfig

`Protected`getDocumentUri

`Private`getDocumentUriForPanel

`Private`getHtmlForWebview

`Private`getLLMCompletion

`Protected`getRunnerForWebview

`Private`handleLoroMessage

`Protected`initializeRunnerForWebview

`Protected`onMessage

`Protected`postMessage

`Protected`postMessageWithResponse

`Protected`registerMessageHandlers

`Private`tryAutoConnect

`Private`updateUserInfoInAllWebviews

`Static`getInstance

`Static`register