@jupyterlab/lsp 4.0.0-alpha.11

package/lib/adapters/adapter.d.ts

@@ -0,0 +1,125 @@
+import { JupyterFrontEnd } from '@jupyterlab/application';
+import { CodeEditor } from '@jupyterlab/codeeditor';
+import { DocumentRegistry, IDocumentWidget } from '@jupyterlab/docregistry';
+import * as nbformat from '@jupyterlab/nbformat';
+import { ITranslator, TranslationBundle } from '@jupyterlab/translation';
+import { Signal } from '@lumino/signaling';
+import { LanguageIdentifier } from '../lsp';
+import { IVirtualPosition } from '../positioning';
+import { IDocumentConnectionData, ILSPCodeExtractorsManager, ILSPDocumentConnectionManager, ILSPFeatureManager } from '../tokens';
+import { IForeignContext, VirtualDocument } from '../virtual/document';
+export declare class StatusMessage {
+    /**
+     * The text message to be shown on the statusbar
+     */
+    message: string;
+    changed: Signal<StatusMessage, void>;
+    private timer;
+    constructor();
+    /**
+     * Set the text message and (optionally) the timeout to remove it.
+     * @param message
+     * @param timeout - number of ms to until the message is cleaned;
+     *        -1 if the message should stay up indefinitely;
+     *        defaults to 3000ms (3 seconds)
+     */
+    set(message: string, timeout?: number): void;
+    clear(): void;
+    private expireTimer;
+}
+export interface IEditorChangedData {
+    editor: CodeEditor.IEditor;
+}
+export interface IAdapterOptions {
+    app: JupyterFrontEnd;
+    connectionManager: ILSPDocumentConnectionManager;
+    featureManager: ILSPFeatureManager;
+    foreignCodeExtractorsManager: ILSPCodeExtractorsManager;
+    translator?: ITranslator;
+}
+/**
+ * Foreign code: low level adapter is not aware of the presence of foreign languages;
+ * it operates on the virtual document and must not attempt to infer the language dependencies
+ * as this would make the logic of inspections caching impossible to maintain, thus the WidgetAdapter
+ * has to handle that, keeping multiple connections and multiple virtual documents.
+ */
+export declare abstract class WidgetAdapter<T extends IDocumentWidget> {
+    protected options: IAdapterOptions;
+    widget: T;
+    adapterConnected: Signal<WidgetAdapter<T>, IDocumentConnectionData>;
+    isConnected: boolean;
+    connectionManager: ILSPDocumentConnectionManager;
+    trans: TranslationBundle;
+    protected isDisposed: boolean;
+    protected app: JupyterFrontEnd;
+    activeEditorChanged: Signal<WidgetAdapter<T>, IEditorChangedData>;
+    editorAdded: Signal<WidgetAdapter<T>, IEditorChangedData>;
+    editorRemoved: Signal<WidgetAdapter<T>, IEditorChangedData>;
+    updateFinished: Promise<void>;
+    initialized: Promise<void>;
+    virtualDocument: VirtualDocument;
+    /**
+     * (re)create virtual document using current path and language
+     */
+    abstract createVirtualDocument(): VirtualDocument;
+    abstract getEditorIndexAt(position: IVirtualPosition): number;
+    abstract getEditorIndex(ceEditor: CodeEditor.IEditor): number;
+    abstract getEditorWrapper(ceEditor: CodeEditor.IEditor): HTMLElement;
+    protected constructor(options: IAdapterOptions, widget: T);
+    onConnectionClosed(_: ILSPDocumentConnectionManager, { virtualDocument }: IDocumentConnectionData): void;
+    dispose(): void;
+    abstract get documentPath(): string;
+    abstract get mimeType(): string;
+    get widgetId(): string;
+    get language(): LanguageIdentifier;
+    abstract get languageFileExtension(): string | undefined;
+    disconnect(): void;
+    protected reloadConnection(): void;
+    protected onSaveState(context: DocumentRegistry.IContext<DocumentRegistry.IModel>, state: DocumentRegistry.SaveState): void;
+    abstract activeEditor: CodeEditor.IEditor | undefined;
+    abstract get editors(): {
+        ceEditor: CodeEditor.IEditor;
+        type: nbformat.CellType;
+    }[];
+    /**
+     * public for use in tests (but otherwise could be private)
+     */
+    updateDocuments(): Promise<void> | undefined;
+    get hasMultipleEditors(): boolean;
+    protected onConnected(data: IDocumentConnectionData): Promise<void>;
+    /**
+     * Opens a connection for the document. The connection may or may
+     * not be initialized, yet, and depending on when this is called, the client
+     * may not be fully connected.
+     *
+     * @param virtualDocument a VirtualDocument
+     * @param sendOpen whether to open the document immediately
+     */
+    protected connectDocument(virtualDocument: VirtualDocument, sendOpen?: boolean): Promise<void>;
+    protected initVirtual(): void;
+    private onForeignDocumentClosed;
+    /**
+     * Handler for opening a document contained in a parent document. The assumption
+     * is that the editor already exists for this, and as such the document
+     * should be queued for immediate opening.
+     *
+     * @param host the VirtualDocument that contains the VirtualDocument in another language
+     * @param context information about the foreign VirtualDocument
+     */
+    protected onForeignDocumentOpened(_: VirtualDocument, context: IForeignContext): Promise<void>;
+    documentChanged(virtualDocument: VirtualDocument, document: VirtualDocument, isInit?: boolean): void;
+    private connect;
+    /**
+     * Connect the change signal in order to update all virtual documents after a change.
+     *
+     * Update to the state of a notebook may be done without a notice on the CodeMirror level,
+     * e.g. when a cell is deleted. Therefore a JupyterLab-specific signals are watched instead.
+     *
+     * While by not using the change event of CodeMirror editors we loose an easy way to send selective,
+     * (range) updates this can be still implemented by comparison of before/after states of the
+     * virtual documents, which is even more resilient and -obviously - editor-independent.
+     */
+    private connectContentChangedSignal;
+    private onContentChanged;
+    abstract get wrapperElement(): HTMLElement;
+}

package/lib/adapters/adapter.js

@@ -0,0 +1,382 @@
+import { Dialog, showDialog } from '@jupyterlab/apputils';
+import { nullTranslator } from '@jupyterlab/translation';
+import { Signal } from '@lumino/signaling';
+import mergeWith from 'lodash.mergewith';
+const createButton = Dialog.createButton;
+export class StatusMessage {
+    constructor() {
+        this.message = '';
+        this.changed = new Signal(this);
+        this.timer = null;
+    }
+    /**
+     * Set the text message and (optionally) the timeout to remove it.
+     * @param message
+     * @param timeout - number of ms to until the message is cleaned;
+     *        -1 if the message should stay up indefinitely;
+     *        defaults to 3000ms (3 seconds)
+     */
+    set(message, timeout = 1000 * 3) {
+        this.expireTimer();
+        this.message = message;
+        this.changed.emit();
+        if (timeout !== -1) {
+            this.timer = window.setTimeout(this.clear.bind(this), timeout);
+        }
+    }
+    clear() {
+        this.message = '';
+        this.changed.emit();
+    }
+    expireTimer() {
+        if (this.timer !== null) {
+            window.clearTimeout(this.timer);
+            this.timer = 0;
+        }
+    }
+}
+/**
+ * The values should follow the https://microsoft.github.io/language-server-protocol/specification guidelines
+ */
+const MIME_TYPE_LANGUAGE_MAP = {
+    'text/x-rsrc': 'r',
+    'text/x-r-source': 'r',
+    // currently there are no LSP servers for IPython we are aware of
+    'text/x-ipython': 'python'
+};
+/**
+ * Foreign code: low level adapter is not aware of the presence of foreign languages;
+ * it operates on the virtual document and must not attempt to infer the language dependencies
+ * as this would make the logic of inspections caching impossible to maintain, thus the WidgetAdapter
+ * has to handle that, keeping multiple connections and multiple virtual documents.
+ */
+export class WidgetAdapter {
+    // note: it could be using namespace/IOptions pattern,
+    // but I do not know how to make it work with the generic type T
+    // (other than using 'any' in the IOptions interface)
+    constructor(options, widget) {
+        this.options = options;
+        this.widget = widget;
+        this.isDisposed = false;
+        this.app = options.app;
+        this.connectionManager = options.connectionManager;
+        this.adapterConnected = new Signal(this);
+        this.activeEditorChanged = new Signal(this);
+        this.editorRemoved = new Signal(this);
+        this.editorAdded = new Signal(this);
+        this.isConnected = false;
+        this.trans = (options.translator || nullTranslator).load('jupyterlab-lsp');
+        // set up signal connections
+        this.widget.context.saveState.connect(this.onSaveState, this);
+        this.connectionManager.closed.connect(this.onConnectionClosed, this);
+        this.widget.disposed.connect(this.dispose, this);
+    }
+    onConnectionClosed(_, { virtualDocument }) {
+        if (virtualDocument === this.virtualDocument) {
+            this.dispose();
+        }
+    }
+    dispose() {
+        if (this.isDisposed) {
+            return;
+        }
+        this.widget.context.saveState.disconnect(this.onSaveState, this);
+        this.connectionManager.closed.disconnect(this.onConnectionClosed, this);
+        this.widget.disposed.disconnect(this.dispose, this);
+        this.disconnect();
+        // just to be sure
+        this.app = null;
+        this.widget = null;
+        this.connectionManager = null;
+        this.widget = null;
+        this.isDisposed = true;
+    }
+    get widgetId() {
+        return this.widget.id;
+    }
+    get language() {
+        // the values should follow https://microsoft.github.io/language-server-protocol/specification guidelines,
+        // see the table in https://microsoft.github.io/language-server-protocol/specification#textDocumentItem
+        if (MIME_TYPE_LANGUAGE_MAP.hasOwnProperty(this.mimeType)) {
+            return MIME_TYPE_LANGUAGE_MAP[this.mimeType];
+        }
+        else {
+            let withoutParameters = this.mimeType.split(';')[0];
+            let [type, subtype] = withoutParameters.split('/');
+            if (type === 'application' || type === 'text') {
+                if (subtype.startsWith('x-')) {
+                    return subtype.substr(2);
+                }
+                else {
+                    return subtype;
+                }
+            }
+            else {
+                return this.mimeType;
+            }
+        }
+    }
+    disconnect() {
+        this.connectionManager.unregisterDocument(this.virtualDocument);
+        this.widget.context.model.contentChanged.disconnect(this.onContentChanged, this);
+        // pretend that all editors were removed to trigger the disconnection of even handlers
+        // they will be connected again on new connection
+        for (let { ceEditor: editor } of this.editors) {
+            this.editorRemoved.emit({
+                editor: editor
+            });
+        }
+        this.virtualDocument.dispose();
+    }
+    // equivalent to triggering didClose and didOpen, as per syncing specification,
+    // but also reloads the connection; used during file rename (or when it was moved)
+    reloadConnection() {
+        // ignore premature calls (before the editor was initialized)
+        if (this.virtualDocument == null) {
+            return;
+        }
+        // disconnect all existing connections (and dispose adapters)
+        this.disconnect();
+        // recreate virtual document using current path and language
+        // as virtual editor assumes it gets the virtual document at init,
+        // just dispose virtual editor (which disposes virtual document too)
+        // and re-initialize both virtual editor and document
+        this.initVirtual();
+        // reconnect
+        this.connectDocument(this.virtualDocument, true).catch(console.warn);
+    }
+    onSaveState(context, state) {
+        // ignore premature calls (before the editor was initialized)
+        if (this.virtualDocument == null) {
+            return;
+        }
+        // TODO: remove workaround no later than with 3.2 release of JupyterLab
+        // workaround for https://github.com/jupyterlab/jupyterlab/issues/10721
+        // while already reverted in https://github.com/jupyterlab/jupyterlab/pull/10741,
+        // it was not released yet and many users will continue to run 3.1.0 and 3.1.1
+        // so lets workaround it for now
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        const completedManually = state === 'completed manually';
+        if (state === 'completed' || completedManually) {
+            // note: must only be send to the appropriate connections as
+            // some servers (Julia) break if they receive save notification
+            // for a document that was not opened before, see:
+            // https://github.com/jupyter-lsp/jupyterlab-lsp/issues/490
+            const documentsToSave = [this.virtualDocument];
+            for (let virtualDocument of documentsToSave) {
+                let connection = this.connectionManager.connections.get(virtualDocument.uri);
+                if (!connection) {
+                    continue;
+                }
+                connection.sendSaved(virtualDocument.documentInfo);
+                for (let foreign of virtualDocument.foreignDocuments.values()) {
+                    documentsToSave.push(foreign);
+                }
+            }
+        }
+    }
+    /**
+     * public for use in tests (but otherwise could be private)
+     */
+    updateDocuments() {
+        if (this.isDisposed) {
+            console.warn('Cannot update documents: adapter disposed');
+            return;
+        }
+        return this.virtualDocument.updateManager.updateDocuments(this.editors.map(({ ceEditor, type }) => {
+            return {
+                ceEditor: ceEditor,
+                value: ceEditor.model.value.text,
+                type
+            };
+        }));
+    }
+    get hasMultipleEditors() {
+        return this.editors.length > 1;
+    }
+    async onConnected(data) {
+        let { virtualDocument } = data;
+        this.adapterConnected.emit(data);
+        this.isConnected = true;
+        const promise = this.updateDocuments();
+        if (!promise) {
+            console.warn('Could not update documents');
+            return;
+        }
+        await promise.then(() => {
+            // refresh the document on the LSP server
+            this.documentChanged(virtualDocument, virtualDocument, true);
+        });
+        // Note: the logger extension behaves badly with non-default names
+        // as it changes the source to the active file afterwards anyways
+        // const loggerSourceName = virtualDocument.uri;
+        let log;
+        log = (text) => console.log(text);
+        data.connection.serverNotifications['$/logTrace'].connect((connection, message) => {
+            console.log(data.connection.serverIdentifier, 'trace', virtualDocument.uri, message);
+        });
+        data.connection.serverNotifications['window/logMessage'].connect((connection, message) => {
+            log(connection.serverIdentifier + ': ' + message.message);
+        });
+        data.connection.serverNotifications['window/showMessage'].connect((connection, message) => {
+            void showDialog({
+                title: this.trans.__('Message from ') + connection.serverIdentifier,
+                body: message.message
+            });
+        });
+        data.connection.serverRequests['window/showMessageRequest'].setHandler(async (params) => {
+            const actionItems = params.actions;
+            const buttons = actionItems
+                ? actionItems.map(action => {
+                    return createButton({
+                        label: action.title
+                    });
+                })
+                : [createButton({ label: this.trans.__('Dismiss') })];
+            const result = await showDialog({
+                title: this.trans.__('Message from ') + data.connection.serverIdentifier,
+                body: params.message,
+                buttons: buttons
+            });
+            const choice = buttons.indexOf(result.button);
+            if (choice === -1) {
+                return null;
+            }
+            if (actionItems) {
+                return actionItems[choice];
+            }
+            return null;
+        });
+    }
+    /**
+     * Opens a connection for the document. The connection may or may
+     * not be initialized, yet, and depending on when this is called, the client
+     * may not be fully connected.
+     *
+     * @param virtualDocument a VirtualDocument
+     * @param sendOpen whether to open the document immediately
+     */
+    async connectDocument(virtualDocument, sendOpen = false) {
+        virtualDocument.foreignDocumentOpened.connect(this.onForeignDocumentOpened, this);
+        const connectionContext = await this.connect(virtualDocument).catch(console.error);
+        if (connectionContext && connectionContext.connection) {
+            virtualDocument.changed.connect(this.documentChanged, this);
+            if (sendOpen) {
+                connectionContext.connection.sendOpenWhenReady(virtualDocument.documentInfo);
+            }
+        }
+    }
+    initVirtual() {
+        let virtualDocument = this.createVirtualDocument();
+        if (virtualDocument == null) {
+            console.error('Could not initialize a VirtualDocument for adapter: ', this);
+            return;
+        }
+        this.virtualDocument = virtualDocument;
+        this.connectContentChangedSignal();
+    }
+    onForeignDocumentClosed(_, context) {
+        const { foreignDocument } = context;
+        foreignDocument.foreignDocumentClosed.disconnect(this.onForeignDocumentClosed, this);
+        foreignDocument.foreignDocumentOpened.disconnect(this.onForeignDocumentOpened, this);
+        foreignDocument.changed.disconnect(this.documentChanged, this);
+    }
+    /**
+     * Handler for opening a document contained in a parent document. The assumption
+     * is that the editor already exists for this, and as such the document
+     * should be queued for immediate opening.
+     *
+     * @param host the VirtualDocument that contains the VirtualDocument in another language
+     * @param context information about the foreign VirtualDocument
+     */
+    async onForeignDocumentOpened(_, context) {
+        const { foreignDocument } = context;
+        await this.connectDocument(foreignDocument, true);
+        foreignDocument.foreignDocumentClosed.connect(this.onForeignDocumentClosed, this);
+    }
+    documentChanged(virtualDocument, document, isInit = false) {
+        if (this.isDisposed) {
+            console.warn('Cannot swap document: adapter disposed');
+            return;
+        }
+        // TODO only send the difference, using connection.sendSelectiveChange()
+        let connection = this.connectionManager.connections.get(virtualDocument.uri);
+        if (!(connection === null || connection === void 0 ? void 0 : connection.isReady)) {
+            console.log('Skipping document update signal: connection not ready');
+            return;
+        }
+        connection.sendFullTextChange(virtualDocument.value, virtualDocument.documentInfo);
+        // the first change (initial) is not propagated to features,
+        // as it has no associated CodeMirrorChange object
+        if (!isInit) {
+            // TODO??
+            // guarantee that the virtual editor won't perform an update of the virtual documents while
+            // the changes are recorded...
+            // TODO this is not ideal - why it solves the problem of some errors,
+            //  it introduces an unnecessary delay. A better way could be to invalidate some of the updates when a new one comes in.
+            //  but maybe not every one (then the outdated state could be kept for too long fo a user who writes very quickly)
+            //  also we would not want to invalidate the updates for the purpose of autocompletion (the trigger characters)
+        }
+    }
+    async connect(virtualDocument) {
+        let language = virtualDocument.language;
+        let capabilities = {
+            textDocument: {
+                synchronization: {
+                    dynamicRegistration: true,
+                    willSave: false,
+                    didSave: true,
+                    willSaveWaitUntil: false
+                }
+            },
+            workspace: {
+                didChangeConfiguration: {
+                    dynamicRegistration: true
+                }
+            }
+        };
+        capabilities = mergeWith(capabilities, this.options.featureManager.clientCapabilities());
+        let options = {
+            capabilities,
+            virtualDocument,
+            language,
+            hasLspSupportedFile: virtualDocument.hasLspSupportedFile
+        };
+        let connection = await this.connectionManager.connect(options);
+        if (connection) {
+            await this.onConnected({ virtualDocument, connection });
+            return {
+                connection,
+                virtualDocument
+            };
+        }
+        else {
+            return undefined;
+        }
+    }
+    /**
+     * Connect the change signal in order to update all virtual documents after a change.
+     *
+     * Update to the state of a notebook may be done without a notice on the CodeMirror level,
+     * e.g. when a cell is deleted. Therefore a JupyterLab-specific signals are watched instead.
+     *
+     * While by not using the change event of CodeMirror editors we loose an easy way to send selective,
+     * (range) updates this can be still implemented by comparison of before/after states of the
+     * virtual documents, which is even more resilient and -obviously - editor-independent.
+     */
+    connectContentChangedSignal() {
+        this.widget.context.model.contentChanged.connect(this.onContentChanged, this);
+    }
+    async onContentChanged(_slot) {
+        // update the virtual documents (sending the updates to LSP is out of scope here)
+        const promise = this.updateDocuments();
+        if (!promise) {
+            console.warn('Could not update documents');
+            return;
+        }
+        this.updateFinished = promise.catch(console.warn);
+        await this.updateFinished;
+    }
+}
+//# sourceMappingURL=adapter.js.map

package/lib/adapters/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../src/adapters/adapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAI1D,OAAO,EAEL,cAAc,EAEf,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,SAAS,MAAM,kBAAkB,CAAC;AAczC,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;AACzC,MAAM,OAAO,aAAa;IAQxB;QACE,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,OAAe,EAAE,UAAkB,IAAI,GAAG,CAAC;QAC7C,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACpB,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE;YAClB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;SAChE;IACH,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IAEO,WAAW;QACjB,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE;YACvB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAChC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;SAChB;IACH,CAAC;CACF;AAED;;GAEG;AACH,MAAM,sBAAsB,GAAe;IACzC,aAAa,EAAE,GAAG;IAClB,iBAAiB,EAAE,GAAG;IACtB,iEAAiE;IACjE,gBAAgB,EAAE,QAAQ;CAC3B,CAAC;AAcF;;;;;GAKG;AACH,MAAM,OAAgB,aAAa;IA2BjC,sDAAsD;IACtD,gEAAgE;IAChE,qDAAqD;IACrD,YAAgC,OAAwB,EAAS,MAAS;QAA1C,YAAO,GAAP,OAAO,CAAiB;QAAS,WAAM,GAAN,MAAM,CAAG;QAzBhE,eAAU,GAAG,KAAK,CAAC;QA0B3B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,mBAAmB,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI,cAAc,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAE3E,4BAA4B;QAC5B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;QACrE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,kBAAkB,CAChB,CAAgC,EAChC,EAAE,eAAe,EAA2B;QAE5C,IAAI,eAAe,KAAK,IAAI,CAAC,eAAe,EAAE;YAC5C,IAAI,CAAC,OAAO,EAAE,CAAC;SAChB;IACH,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO;SACR;QAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QACjE,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAEpD,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,kBAAkB;QAClB,IAAI,CAAC,GAAG,GAAG,IAAW,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAW,CAAC;QAC1B,IAAI,CAAC,iBAAiB,GAAG,IAAW,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,IAAW,CAAC;QAE1B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAMD,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;IACxB,CAAC;IAED,IAAI,QAAQ;QACV,0GAA0G;QAC1G,uGAAuG;QACvG,IAAI,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACxD,OAAO,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAW,CAAC;SACxD;aAAM;YACL,IAAI,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnD,IAAI,IAAI,KAAK,aAAa,IAAI,IAAI,KAAK,MAAM,EAAE;gBAC7C,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;oBAC5B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;iBAC1B;qBAAM;oBACL,OAAO,OAAO,CAAC;iBAChB;aACF;iBAAM;gBACL,OAAO,IAAI,CAAC,QAAQ,CAAC;aACtB;SACF;IACH,CAAC;IAID,UAAU;QACR,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,UAAU,CACjD,IAAI,CAAC,gBAAgB,EACrB,IAAI,CACL,CAAC;QAEF,sFAAsF;QACtF,iDAAiD;QACjD,KAAK,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE;YAC7C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;gBACtB,MAAM,EAAE,MAAM;aACf,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;IACjC,CAAC;IAED,+EAA+E;IAC/E,kFAAkF;IACxE,gBAAgB;QACxB,6DAA6D;QAC7D,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,EAAE;YAChC,OAAO;SACR;QAED,6DAA6D;QAC7D,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,4DAA4D;QAC5D,kEAAkE;QAClE,oEAAoE;QACpE,qDAAqD;QACrD,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,YAAY;QACZ,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,CAAC;IAES,WAAW,CACnB,OAA2D,EAC3D,KAAiC;QAEjC,6DAA6D;QAC7D,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,EAAE;YAChC,OAAO;SACR;QAED,uEAAuE;QACvE,uEAAuE;QACvE,iFAAiF;QACjF,8EAA8E;QAC9E,gCAAgC;QAChC,6DAA6D;QAC7D,aAAa;QACb,MAAM,iBAAiB,GAAG,KAAK,KAAK,oBAAoB,CAAC;QAEzD,IAAI,KAAK,KAAK,WAAW,IAAI,iBAAiB,EAAE;YAC9C,4DAA4D;YAC5D,+DAA+D;YAC/D,kDAAkD;YAClD,2DAA2D;YAC3D,MAAM,eAAe,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAE/C,KAAK,IAAI,eAAe,IAAI,eAAe,EAAE;gBAC3C,IAAI,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,CACrD,eAAe,CAAC,GAAG,CACpB,CAAC;gBACF,IAAI,CAAC,UAAU,EAAE;oBACf,SAAS;iBACV;gBACD,UAAU,CAAC,SAAS,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;gBACnD,KAAK,IAAI,OAAO,IAAI,eAAe,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE;oBAC7D,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;iBAC/B;aACF;SACF;IACH,CAAC;IASD;;OAEG;IACI,eAAe;QACpB,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;YAC1D,OAAO;SACR;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,eAAe,CACvD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE;YACtC,OAAO;gBACL,QAAQ,EAAE,QAAQ;gBAClB,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI;gBAChC,IAAI;aACL,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IACjC,CAAC;IAES,KAAK,CAAC,WAAW,CAAC,IAA6B;QACvD,IAAI,EAAE,eAAe,EAAE,GAAG,IAAI,CAAC;QAE/B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAExB,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YAC3C,OAAO;SACR;QACD,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE;YACtB,yCAAyC;YACzC,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,kEAAkE;QAClE,iEAAiE;QACjE,gDAAgD;QAChD,IAAI,GAA2B,CAAC;QAChC,GAAG,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE1C,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,OAAO,CACvD,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE;YACtB,OAAO,CAAC,GAAG,CACT,IAAI,CAAC,UAAU,CAAC,gBAAgB,EAChC,OAAO,EACP,eAAe,CAAC,GAAG,EACnB,OAAO,CACR,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC,OAAO,CAC9D,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE;YACtB,GAAG,CAAC,UAAU,CAAC,gBAAgB,GAAG,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAC5D,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAC/D,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE;YACtB,KAAK,UAAU,CAAC;gBACd,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,CAAC,GAAG,UAAU,CAAC,gBAAgB;gBACnE,IAAI,EAAE,OAAO,CAAC,OAAO;aACtB,CAAC,CAAC;QACL,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,2BAA2B,CAAC,CAAC,UAAU,CACpE,KAAK,EAAC,MAAM,EAAC,EAAE;YACb,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC;YACnC,MAAM,OAAO,GAAG,WAAW;gBACzB,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;oBACvB,OAAO,YAAY,CAAC;wBAClB,KAAK,EAAE,MAAM,CAAC,KAAK;qBACpB,CAAC,CAAC;gBACL,CAAC,CAAC;gBACJ,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC;YACxD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAU;gBACvC,KAAK,EACH,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB;gBACnE,IAAI,EAAE,MAAM,CAAC,OAAO;gBACpB,OAAO,EAAE,OAAO;aACjB,CAAC,CAAC;YACH,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC9C,IAAI,MAAM,KAAK,CAAC,CAAC,EAAE;gBACjB,OAAO,IAAI,CAAC;aACb;YACD,IAAI,WAAW,EAAE;gBACf,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;aAC5B;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,eAAe,CAC7B,eAAgC,EAChC,QAAQ,GAAG,KAAK;QAEhB,eAAe,CAAC,qBAAqB,CAAC,OAAO,CAC3C,IAAI,CAAC,uBAAuB,EAC5B,IAAI,CACL,CAAC;QACF,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,KAAK,CACjE,OAAO,CAAC,KAAK,CACd,CAAC;QAEF,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,UAAU,EAAE;YACrD,eAAe,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;YAC5D,IAAI,QAAQ,EAAE;gBACZ,iBAAiB,CAAC,UAAU,CAAC,iBAAiB,CAC5C,eAAe,CAAC,YAAY,CAC7B,CAAC;aACH;SACF;IACH,CAAC;IAES,WAAW;QACnB,IAAI,eAAe,GAAG,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACnD,IAAI,eAAe,IAAI,IAAI,EAAE;YAC3B,OAAO,CAAC,KAAK,CACX,sDAAsD,EACtD,IAAI,CACL,CAAC;YACF,OAAO;SACR;QACD,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,2BAA2B,EAAE,CAAC;IACrC,CAAC;IAEO,uBAAuB,CAC7B,CAAkB,EAClB,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QACpC,eAAe,CAAC,qBAAqB,CAAC,UAAU,CAC9C,IAAI,CAAC,uBAAuB,EAC5B,IAAI,CACL,CAAC;QACF,eAAe,CAAC,qBAAqB,CAAC,UAAU,CAC9C,IAAI,CAAC,uBAAuB,EAC5B,IAAI,CACL,CAAC;QACF,eAAe,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IACjE,CAAC;IAED;;;;;;;OAOG;IACO,KAAK,CAAC,uBAAuB,CACrC,CAAkB,EAClB,OAAwB;QAExB,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC;QAEpC,MAAM,IAAI,CAAC,eAAe,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QAElD,eAAe,CAAC,qBAAqB,CAAC,OAAO,CAC3C,IAAI,CAAC,uBAAuB,EAC5B,IAAI,CACL,CAAC;IACJ,CAAC;IAED,eAAe,CACb,eAAgC,EAChC,QAAyB,EACzB,MAAM,GAAG,KAAK;QAEd,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;YACvD,OAAO;SACR;QAED,wEAAwE;QACxE,IAAI,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,CACrD,eAAe,CAAC,GAAG,CACpB,CAAC;QAEF,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,CAAA,EAAE;YACxB,OAAO,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAC;YACrE,OAAO;SACR;QAED,UAAU,CAAC,kBAAkB,CAC3B,eAAe,CAAC,KAAK,EACrB,eAAe,CAAC,YAAY,CAC7B,CAAC;QACF,4DAA4D;QAC5D,kDAAkD;QAClD,IAAI,CAAC,MAAM,EAAE;YACX,SAAS;YACT,2FAA2F;YAC3F,8BAA8B;YAC9B,qEAAqE;YACrE,wHAAwH;YACxH,kHAAkH;YAClH,+GAA+G;SAChH;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,eAAgC;QACpD,IAAI,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC;QAExC,IAAI,YAAY,GAAuB;YACrC,YAAY,EAAE;gBACZ,eAAe,EAAE;oBACf,mBAAmB,EAAE,IAAI;oBACzB,QAAQ,EAAE,KAAK;oBACf,OAAO,EAAE,IAAI;oBACb,iBAAiB,EAAE,KAAK;iBACzB;aACF;YACD,SAAS,EAAE;gBACT,sBAAsB,EAAE;oBACtB,mBAAmB,EAAE,IAAI;iBAC1B;aACF;SACF,CAAC;QACF,YAAY,GAAG,SAAS,CACtB,YAAY,EACZ,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,kBAAkB,EAAE,CACjD,CAAC;QAEF,IAAI,OAAO,GAA6B;YACtC,YAAY;YACZ,eAAe;YACf,QAAQ;YACR,mBAAmB,EAAE,eAAe,CAAC,mBAAmB;SACzD,CAAC;QAEF,IAAI,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE/D,IAAI,UAAU,EAAE;YACd,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,CAAC;YAExD,OAAO;gBACL,UAAU;gBACV,eAAe;aAChB,CAAC;SACH;aAAM;YACL,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAED;;;;;;;;;OASG;IACK,2BAA2B;QACjC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAC9C,IAAI,CAAC,gBAAgB,EACrB,IAAI,CACL,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,KAAU;QACvC,iFAAiF;QAEjF,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACvC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;YAC3C,OAAO;SACR;QACD,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,IAAI,CAAC,cAAc,CAAC;IAC5B,CAAC;CAGF"}

package/lib/connection.d.ts

@@ -0,0 +1,65 @@
+import { IDocumentInfo, IPosition, LspWsConnection } from 'lsp-ws-connection';
+import { ClientNotifications, ClientRequests, ILSPConnection, ILSPOptions, Method, ServerNotifications, ServerRequests } from './tokens';
+import type * as lsp from 'vscode-languageserver-protocol';
+export declare const Provider: {
+    [key: string]: keyof lsp.ServerCapabilities;
+};
+declare type AnyMethod = Method.ServerNotification | Method.ClientNotification | Method.ClientRequest | Method.ServerRequest;
+declare enum MessageKind {
+    clientNotifiedServer = 0,
+    serverNotifiedClient = 1,
+    serverRequested = 2,
+    clientRequested = 3,
+    resultForClient = 4,
+    responseForServer = 5
+}
+interface IMessageLog<T extends AnyMethod = AnyMethod> {
+    method: T;
+    message: any;
+}
+export declare class LSPConnection extends LspWsConnection implements ILSPConnection {
+    serverIdentifier?: string;
+    serverLanguage?: string;
+    clientNotifications: ClientNotifications;
+    serverNotifications: ServerNotifications;
+    clientRequests: ClientRequests;
+    serverRequests: ServerRequests;
+    logAllCommunication: boolean;
+    protected documentsToOpen: IDocumentInfo[];
+    private _options;
+    constructor(options: ILSPOptions);
+    log(kind: MessageKind, message: IMessageLog): void;
+    protected constructNotificationHandlers<T extends ServerNotifications | ClientNotifications>(methods: typeof Method.ServerNotification | typeof Method.ClientNotification): T;
+    protected constructClientRequestHandler<T extends ClientRequests, U extends keyof T = keyof T>(methods: typeof Method.ClientRequest): T;
+    protected constructServerRequestHandler<T extends ServerRequests, U extends keyof T = keyof T>(methods: typeof Method.ServerRequest): T;
+    /**
+     * Initialization parameters to be sent to the language server.
+     * Subclasses can overload this when adding more features.
+     */
+    protected initializeParams(): lsp.InitializeParams;
+    sendOpenWhenReady(documentInfo: IDocumentInfo): void;
+    protected onServerInitialized(params: lsp.InitializeResult): void;
+    protected afterInitialized(): void;
+    sendSelectiveChange(changeEvent: lsp.TextDocumentContentChangeEvent, documentInfo: IDocumentInfo): void;
+    sendFullTextChange(text: string, documentInfo: IDocumentInfo): void;
+    /**
+     * @deprecated The method should not be used in new code. Use provides() instead.
+     */
+    isRenameSupported(): boolean;
+    provides(provider: keyof lsp.ServerCapabilities): boolean;
+    /**
+     * @deprecated The method should not be used in new code
+     */
+    rename(location: IPosition, documentInfo: IDocumentInfo, newName: string, emit?: boolean): Promise<lsp.WorkspaceEdit | null>;
+    connect(socket: WebSocket): this;
+    private closingManually;
+    close(): void;
+    private _sendChange;
+    getCompletionResolve(completionItem: lsp.CompletionItem): Promise<lsp.CompletionItem | undefined>;
+    /**
+     * Does support completionItem/resolve?
+     * @deprecated The method should not be used in new code
+     */
+    isCompletionResolveProvider(): boolean;
+}
+export {};