@platformos/codemirror-language-client 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @platformos/codemirror-language-client
+
+## 0.0.2
+
+### Patch Changes
+
+- Beta release

package/README.md

@@ -0,0 +1,91 @@
+> **Warning**
+>
+> This package is open source but not open to contributions. It comes with little documentation but can serve as an example implementation of LSP features on the web.
+
+# CodeMirror Language Client
+
+[CodeMirror](https://codemirror.net/) is an open source code editor library.
+
+The [Language Server Protocol](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/) empowers developers to write one language server that can run in all language clients. Write a client, and you gain access to all servers; write one server, and all clients can use it.
+
+This repo serves as a CodeMirror Language Client. Feed it a Language Server and receive the following code editing features:
+
+- [x] Diagnostics (aka Linting)
+- [x] Completions
+- [x] Hover
+- [x] Document Highlights
+- [ ] Document Links
+- [ ] Workspace Edits (aka Refactorings, Quickfix, etc.)
+
+## Usage
+
+```typescript
+import { CodeMirrorLanguageClient } from '@platformos/codemirror-language-client';
+
+async function main() {
+  // This doesn't have to be liquid-language-server, it
+  // theoretically could be tsserver.
+  const worker = new Worker(
+    new URL('./language-server-worker.ts', import.meta.url),
+  );
+
+  // This is how you instantiate it
+  const client = new CodeMirrorLanguageClient(worker);
+  await client.start();
+
+  // Demo junk to be replaced
+  const filePath = 'browser///input.liquid';
+
+  // Here we add the client.extension for the file path.
+  new EditorView({
+    state: EditorState.create({
+      doc: exampleTemplate,
+      extensions: [
+        /* ... */
+        client.extension(filePath),
+      ],
+    }),
+    parent: document.getElementById('editor')!,
+  });
+}
+
+main();
+```
+
+## Learn more
+
+- Read the [CodeMirror System Guide](https://codemirror.net/docs/guide/) a couple of times.
+
+  The concepts are hard to grok but the time is well spent.
+
+- Read the [Language Server Protocol Spec](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/)
+
+  It's important to understand the following concepts:
+
+    - Language Client
+    - Language Server
+    - Messages
+      - Requests / Response
+      - Notifications
+      - Message direction
+    - Client Capabilities
+    - Server Capabilities
+    - TextDocument synchronization
+    - Lifecycle methods
+
+-  Take a look at the `vscode-languageserver-*` libraries offered by VS Code.
+
+   They have `vscode` in their name, but only `vscode-languageclient` is VS Code specific, the other libraries can be used in non-VS Code contexts (we do this here).
+
+   -  [`vscode-languageserver-protocol`](https://github.com/microsoft/vscode-languageserver-node/tree/main/protocol)
+
+      This library is useful to reuse and type check message parameter types.
+
+      Examples: `PublishDiagnosticsNotification`, `DiagnosticClientCapabilities`, `DiagnosticServerCapabilities`, etc.
+
+   -  [`vscode-languageserver-types`](https://github.com/microsoft/vscode-languageserver-node/tree/main/types)
+
+      This library is useful to get the types of specific parts of the Protocol.
+
+      Examples: `Diagnostic`, `URI`, `TextDocument`, `Position`, `Range`, `LocationLink`, etc.
+

package/dist/esm/CodeMirrorLanguageClient.d.ts

@@ -0,0 +1,60 @@
+import { Extension } from '@codemirror/state';
+import { Dependencies, LanguageClient } from './LanguageClient';
+import { AutocompleteOptions, DiagnosticRenderer, HoverOptions, HoverRenderer, InfoRenderer, LinterOptions } from './extensions';
+export { Dependencies };
+export interface FeatureFlags {
+    shouldComplete: boolean;
+    shouldLint: boolean;
+    shouldHover: boolean;
+}
+export type ClientDependencies = Partial<Dependencies>;
+export interface CodeMirrorDependencies {
+    /**
+     * The infoRenderer is a function that returns a DOM node that contains the documentation
+     * for a completion item. Presumably does markdown conversions to DOM nodes.
+     *
+     * A function that takes a completion object and returns a DOM node.
+     */
+    infoRenderer?: InfoRenderer;
+    /**
+     * Say you wanted to change the settings of the `autocomplete` extension,
+     * you'd do it with that.
+     */
+    autocompleteOptions?: AutocompleteOptions;
+    /**
+     * Say you wanted to change the settings of the `linter` extension,
+     * you'd do it with that.
+     */
+    linterOptions?: LinterOptions;
+    /**
+     * The diagnosticRenderer is a function that returns a DOM node that
+     * contains the content of a diagnostic. It overrides the default
+     * rendering logic for diagnostics.
+     */
+    diagnosticRenderer?: DiagnosticRenderer;
+    /**
+     * The hoverRenderer is a function that returns a DOM node that contains the documentation
+     * for the item under the cursor. The documentation is provided by the Language Server.
+     */
+    hoverRenderer?: HoverRenderer;
+    /**
+     * Say you wanted to change the settings of the `hoverTooltip` extension,
+     * you'd do it with that.
+     */
+    hoverOptions?: HoverOptions;
+}
+export declare class CodeMirrorLanguageClient {
+    private readonly worker;
+    readonly client: LanguageClient;
+    private readonly infoRenderer;
+    private readonly autocompleteExtension;
+    private readonly diagnosticRenderer;
+    private readonly linterExtension;
+    private readonly hoverRenderer;
+    private readonly hoverExtension;
+    private readonly documentHighlightsExtension;
+    constructor(worker: Worker, { log, initializationOptions }?: ClientDependencies, { infoRenderer, autocompleteOptions, diagnosticRenderer, linterOptions, hoverRenderer, hoverOptions, }?: CodeMirrorDependencies);
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    extension(fileUri: string, { shouldLint, shouldComplete, shouldHover }?: FeatureFlags): Extension[];
+}

package/dist/esm/CodeMirrorLanguageClient.js

@@ -0,0 +1,80 @@
+import { MarkupKind } from 'vscode-languageserver-protocol';
+import { LanguageClient } from './LanguageClient';
+import { clientFacet, diagnosticRendererFacet, fileUriFacet, infoRendererFacet, lspComplete, lspDocumentHighlights, lspHover, lspLinter, serverCapabilitiesFacet, textDocumentSync, } from './extensions';
+import { hoverRendererFacet } from './extensions/hover';
+/**
+ * The client capabilities are how we tell the language server what
+ * features we support so that they have the opportunity to skip doing
+ * things that the client does not support. Everything is false by default,
+ * but we migth need to change that and this is where we'll do it.
+ */
+const clientCapabilities = {
+    textDocument: {
+        documentHighlight: {
+            dynamicRegistration: false,
+        },
+        completion: {
+            // We send the completion context to the server
+            contextSupport: true,
+            completionItem: {
+                snippetSupport: true,
+                insertReplaceSupport: true,
+                documentationFormat: [MarkupKind.PlainText, MarkupKind.Markdown],
+                commitCharactersSupport: false,
+            },
+        },
+    },
+};
+const defaultLogger = console.log.bind(console);
+// There is one LanguageClient
+// There is one LanguageServer
+// There are many CodeMirror instances
+export class CodeMirrorLanguageClient {
+    constructor(worker, { log = defaultLogger, initializationOptions } = {}, { infoRenderer, autocompleteOptions, diagnosticRenderer, linterOptions, hoverRenderer, hoverOptions, } = {}) {
+        this.worker = worker;
+        this.client = new LanguageClient(worker, {
+            clientCapabilities,
+            initializationOptions,
+            log,
+        });
+        this.worker = worker;
+        this.infoRenderer = infoRenderer;
+        this.autocompleteExtension = lspComplete(autocompleteOptions);
+        this.diagnosticRenderer = diagnosticRenderer;
+        this.linterExtension = lspLinter(linterOptions);
+        this.hoverRenderer = hoverRenderer;
+        this.hoverExtension = lspHover(hoverOptions);
+        this.documentHighlightsExtension = lspDocumentHighlights();
+    }
+    async start() {
+        await this.client.start();
+    }
+    async stop() {
+        try {
+            await this.client.stop();
+        }
+        finally {
+            this.worker.terminate();
+        }
+    }
+    extension(fileUri, { shouldLint, shouldComplete, shouldHover } = {
+        shouldLint: true,
+        shouldComplete: true,
+        shouldHover: true,
+    }) {
+        return [
+            clientFacet.of(this.client),
+            serverCapabilitiesFacet.of(this.client.serverCapabilities),
+            fileUriFacet.of(fileUri),
+            textDocumentSync,
+            infoRendererFacet.of(this.infoRenderer),
+            diagnosticRendererFacet.of(this.diagnosticRenderer),
+            hoverRendererFacet.of(this.hoverRenderer),
+            this.documentHighlightsExtension,
+        ]
+            .concat(shouldLint ? this.linterExtension : [])
+            .concat(shouldComplete ? this.autocompleteExtension : [])
+            .concat(shouldHover ? this.hoverExtension : []);
+    }
+}
+//# sourceMappingURL=CodeMirrorLanguageClient.js.map

package/dist/esm/CodeMirrorLanguageClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CodeMirrorLanguageClient.js","sourceRoot":"","sources":["../../src/CodeMirrorLanguageClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAEhF,OAAO,EAAgB,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAOL,WAAW,EACX,uBAAuB,EACvB,YAAY,EACZ,iBAAiB,EACjB,WAAW,EACX,qBAAqB,EACrB,QAAQ,EACR,SAAS,EACT,uBAAuB,EACvB,gBAAgB,GACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD;;;;;GAKG;AACH,MAAM,kBAAkB,GAAuB;IAC7C,YAAY,EAAE;QACZ,iBAAiB,EAAE;YACjB,mBAAmB,EAAE,KAAK;SAC3B;QACD,UAAU,EAAE;YACV,+CAA+C;YAC/C,cAAc,EAAE,IAAI;YACpB,cAAc,EAAE;gBACd,cAAc,EAAE,IAAI;gBACpB,oBAAoB,EAAE,IAAI;gBAC1B,mBAAmB,EAAE,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;gBAChE,uBAAuB,EAAE,KAAK;aAC/B;SACF;KACF;CACF,CAAC;AAEF,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAqDhD,8BAA8B;AAC9B,8BAA8B;AAC9B,sCAAsC;AACtC,MAAM,OAAO,wBAAwB;IAUnC,YACmB,MAAc,EAC/B,EAAE,GAAG,GAAG,aAAa,EAAE,qBAAqB,KAAyB,EAAE,EACvE,EACE,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,YAAY,MACc,EAAE;QATb,WAAM,GAAN,MAAM,CAAQ;QAW/B,IAAI,CAAC,MAAM,GAAG,IAAI,cAAc,CAAC,MAAM,EAAE;YACvC,kBAAkB;YAClB,qBAAqB;YACrB,GAAG;SACJ,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,qBAAqB,GAAG,WAAW,CAAC,mBAAmB,CAAC,CAAC;QAE9D,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QAEhD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,cAAc,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;QAE7C,IAAI,CAAC,2BAA2B,GAAG,qBAAqB,EAAE,CAAC;IAC7D,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QAC1B,CAAC;IACH,CAAC;IAEM,SAAS,CACd,OAAe,EACf,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,KAAmB;QAC1D,UAAU,EAAE,IAAI;QAChB,cAAc,EAAE,IAAI;QACpB,WAAW,EAAE,IAAI;KAClB;QAED,OAAO;YACL,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;YAC3B,uBAAuB,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC;YAC1D,YAAY,CAAC,EAAE,CAAC,OAAO,CAAC;YACxB,gBAAgB;YAChB,iBAAiB,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC;YACvC,uBAAuB,CAAC,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC;YACnD,kBAAkB,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC;YACzC,IAAI,CAAC,2BAA2B;SACjC;aACE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9C,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC;aACxD,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC;CACF"}

package/dist/esm/LanguageClient.d.ts

@@ -0,0 +1,112 @@
+import { Disposable, NotificationHandler, ProtocolNotificationType, ProtocolRequestType, ProtocolRequestType0, RequestHandler, ProtocolNotificationType0, ServerCapabilities, ClientCapabilities } from 'vscode-languageserver-protocol';
+export interface PromiseCompletion {
+    resolve(value: unknown): void;
+    reject(error: unknown): void;
+}
+export interface Dependencies {
+    clientCapabilities: ClientCapabilities;
+    initializationOptions?: any;
+    log(...args: any[]): void;
+}
+export interface AbstractLanguageClient {
+    clientCapabilities: ClientCapabilities;
+    serverCapabilities: ServerCapabilities | null;
+    serverInfo: any;
+    onRequest: LanguageClient['onRequest'];
+    onNotification: LanguageClient['onNotification'];
+    sendRequest: LanguageClient['sendRequest'];
+    sendNotification: LanguageClient['sendNotification'];
+}
+export declare class LanguageClient extends EventTarget implements AbstractLanguageClient {
+    readonly worker: Worker;
+    readonly clientCapabilities: ClientCapabilities;
+    readonly initializationOptions: any;
+    serverCapabilities: ServerCapabilities | null;
+    serverInfo: any;
+    private requestId;
+    private requests;
+    private dispose;
+    private disposables;
+    private log;
+    constructor(worker: Worker, dependencies: Dependencies);
+    /**
+     * Lifecycle method to start the server
+     */
+    start(): Promise<void>;
+    /**
+     * Lifecycle method to stop the server
+     */
+    stop(): Promise<void>;
+    /**
+     * For when you want to handle requests sent from the language server.
+     *
+     * @param {MessageSignature} type this is an export from vscode-languageserver-protocol
+     * @param {RequestHandler} handler a type-inferred event handler whose return value matches the MessageSignature
+     *
+     * @example
+     * import {ApplyWorkspaceEditRequest, ApplyWorkspaceEditResponse} from 'vscode-languageserver-protocol';
+     * client.onRequest(ApplyWorkspaceEditRequest.type, (params, cancellationToken) => {
+     *   // `params` and `cancellationToken` are typed inferred
+     *   // The return value must match the MessageSignature (ApplyWorkspaceEditResponse)
+     *   return result as ApplyWorkspaceEditResponse;
+     * })
+     */
+    onRequest<P, R, PR, E, RO>(type: ProtocolRequestType<P, R, PR, E, RO>, handler: RequestHandler<P, R, E>): Disposable;
+    /**
+     * For when you want to handle notifications sent from the language server.
+     *
+     * @param {MessageSignature} type this is an export from vscode-languageserver-protocol
+     * @param {NotificationHandler} handler this is a type-inferred event handler
+     *
+     * @example
+     * import {PublishDiagnosticsNotification} from 'vscode-languageserver-protocol';
+     * client.onNotification(PublishDiagnosticsNotification.type, (params) => {
+     *   // the type of `params` is inferred from the first argument
+     * });
+     */
+    onNotification<P, RO>(type: ProtocolNotificationType<P, RO>, handler: NotificationHandler<P>): Disposable;
+    /**
+     * Send a request to the language server and await a response.
+     *
+     * @param {MessageSignature} type this is an export from vscode-languageserver-protocol
+     * @param [params] its type is inferred from the first argument
+     * @returns {any} response, its type is inferred from the first argument
+     *
+     * @example
+     *
+     * import {CompletionRequest} from 'vscode-languageserver-protocol';
+     * const completions = await client.sendRequest(
+     *   CompletionRequest.type,
+     *   params
+     * );
+     */
+    sendRequest<R, PR, E, RO>(type: ProtocolRequestType0<R, PR, E, RO>): Promise<R>;
+    sendRequest<P, R, PR, E, RO>(type: ProtocolRequestType<P, R, PR, E, RO>, params?: P): Promise<R>;
+    /**
+     * Send a notification to the language server. Notifications are fire and forget.
+     *
+     * @param {MessageSignature} type this is an export from vscode-languageserver-protocol
+     * @param [params] its type is inferred from the first argument
+     *
+     * @example
+     *
+     * import {DidChangeTextDocumentNotification} from 'vscode-languageserver-protocol';
+     * client.sendNotification(
+     *   DidChangeTextDocumentNotification.type,
+     *   params
+     * );
+     */
+    sendNotification<RO>(type: ProtocolNotificationType0<RO>): void;
+    sendNotification<P, RO>(type: ProtocolNotificationType<P, RO>, params?: P): void;
+    private sendResponse;
+    private sendMessage;
+    /**
+     * Map messages to their correct destition.
+     *  - Responses -> resolve or reject the corresponding Request
+     *  - Notification -> emit(message.method, message)
+     *  - Request -> emit(message.method, message)
+     */
+    private handleMessage;
+    private disposable;
+}
+export declare function disposable(dispose: () => void): Disposable;

package/dist/esm/LanguageClient.js

@@ -0,0 +1,187 @@
+/* eslint-disable lines-between-class-members */
+import { CancellationTokenSource, ExitNotification, InitializeRequest, InitializedNotification, ResponseError, ShutdownRequest, } from 'vscode-languageserver-protocol';
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+export class LanguageClient extends EventTarget {
+    constructor(worker, dependencies) {
+        super();
+        this.worker = worker;
+        this.requests = new Map();
+        this.requestId = 0;
+        this.dispose = () => { };
+        this.disposables = [];
+        this.clientCapabilities = dependencies.clientCapabilities;
+        this.initializationOptions = dependencies.initializationOptions;
+        this.log = dependencies.log;
+        this.serverCapabilities = null;
+        this.serverInfo = null;
+    }
+    /**
+     * Lifecycle method to start the server
+     */
+    async start() {
+        /**
+         * Here we setup the web worker event handler.
+         * We route the message sent via the worker's postMessage to our event handler.
+         */
+        const handler = (ev) => this.handleMessage(ev.data);
+        this.worker.addEventListener('message', handler);
+        this.dispose = () => {
+            this.worker.removeEventListener('message', handler);
+        };
+        /**
+         * We send the `initialize` request and obtain the capabilities supported by
+         * the language server.
+         *
+         * https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initialize
+         */
+        const response = await this.sendRequest(InitializeRequest.type, {
+            capabilities: this.clientCapabilities,
+            initializationOptions: this.initializationOptions,
+            processId: 0,
+            rootUri: 'browser:///',
+        });
+        /**
+         * We unpack the response from the server and remember the capabilities.
+         * Those will be useful.
+         */
+        this.serverCapabilities = response.capabilities;
+        this.serverInfo = response.serverInfo;
+        /**
+         * Once we're ready, we send the `initialized` notification to tell the
+         * server that we're ready to roll!
+         *
+         * https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#initialized
+         */
+        this.sendNotification(InitializedNotification.type, {});
+    }
+    /**
+     * Lifecycle method to stop the server
+     */
+    async stop() {
+        await Promise.race([this.sendRequest(ShutdownRequest.type), sleep(1000)]);
+        this.disposables.forEach((disposable) => disposable.dispose());
+        this.disposables = [];
+        this.dispose();
+        this.sendNotification(ExitNotification.type);
+    }
+    onRequest(type, handler) {
+        const method = typeof type === 'string' ? type : type.method;
+        const callback = async (event) => {
+            const { params, id } = event.detail;
+            const cancellationToken = new CancellationTokenSource().token;
+            try {
+                const response = await handler(params, cancellationToken);
+                if (response && typeof response === 'object' && 'code' in response) {
+                    this.sendResponse(id, undefined, response);
+                }
+                else {
+                    this.sendResponse(id, response, undefined);
+                }
+            }
+            catch (error) {
+                this.sendResponse(id, undefined, new ResponseError(1, error instanceof Error ? error.message : error));
+            }
+        };
+        this.addEventListener(method, callback);
+        return this.disposable(() => this.removeEventListener(method, callback));
+    }
+    onNotification(type, handler) {
+        const method = typeof type === 'string' ? type : type.method;
+        const callback = (event) => {
+            const { params } = event.detail;
+            handler(params);
+        };
+        this.addEventListener(method, callback);
+        return this.disposable(() => this.removeEventListener(method, callback));
+    }
+    async sendRequest(type, params) {
+        this.requestId += 1;
+        const requestId = this.requestId;
+        const method = typeof type === 'string' ? type : type.method;
+        const request = {
+            jsonrpc: '2.0',
+            id: requestId,
+            method,
+        };
+        if (params)
+            request.params = params;
+        this.log(`Client->Server ${request.method} request [${request.id}]`, request);
+        this.sendMessage(request);
+        return new Promise((resolve, reject) => {
+            this.requests.set(requestId.toString(), { resolve, reject });
+        });
+    }
+    sendNotification(type, params) {
+        const method = typeof type === 'string' ? type : type.method;
+        const notification = {
+            jsonrpc: '2.0',
+            method,
+        };
+        if (params)
+            notification.params = params;
+        this.log(`Client->Server ${method} notification`, notification);
+        this.sendMessage(notification);
+    }
+    sendResponse(id, result, error) {
+        const response = { jsonrpc: '2.0', id };
+        if (result !== undefined)
+            response.result = result;
+        if (error !== undefined)
+            response.error = error.toJson();
+        this.log(`Client->Server response [${id}]`, response);
+        this.sendMessage(response);
+    }
+    sendMessage(message) {
+        this.worker.postMessage(message);
+    }
+    /**
+     * Map messages to their correct destition.
+     *  - Responses -> resolve or reject the corresponding Request
+     *  - Notification -> emit(message.method, message)
+     *  - Request -> emit(message.method, message)
+     */
+    handleMessage(message) {
+        if (isResponse(message)) {
+            this.log(`Server->Client response [${message.id}]`, message);
+            const id = message.id.toString();
+            if ('result' in message) {
+                this.requests.get(id).resolve(message.result);
+            }
+            else {
+                this.requests.get(id).reject(message.error);
+            }
+            this.requests.delete(id);
+        }
+        else if (isRequest(message)) {
+            this.log(`Server->Client ${message.method} request [${message.id}]`, message);
+            this.dispatchEvent(new CustomEvent(message.method, { detail: message }));
+        }
+        else if (isNotification(message)) {
+            this.log(`Server->Client ${message.method} notification`, message);
+            this.dispatchEvent(new CustomEvent(message.method, {
+                detail: message,
+            }));
+        }
+        else {
+            this.log('what?', message);
+        }
+    }
+    disposable(dispose) {
+        const disp = disposable(dispose);
+        this.disposables.push(disp);
+        return disp;
+    }
+}
+export function disposable(dispose) {
+    return { dispose };
+}
+function isResponse(message) {
+    return 'id' in message && ('error' in message || 'result' in message);
+}
+function isRequest(message) {
+    return 'id' in message && 'method' in message;
+}
+function isNotification(message) {
+    return !('id' in message) && 'method' in message;
+}
+//# sourceMappingURL=LanguageClient.js.map

package/dist/esm/LanguageClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LanguageClient.js","sourceRoot":"","sources":["../../src/LanguageClient.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,OAAO,EAEL,uBAAuB,EAEvB,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EASvB,aAAa,EAEb,eAAe,GAKhB,MAAM,gCAAgC,CAAC;AAaxC,MAAM,KAAK,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;AAahF,MAAM,OAAO,cAAe,SAAQ,WAAW;IAY7C,YAA4B,MAAc,EAAE,YAA0B;QACpE,KAAK,EAAE,CAAC;QADkB,WAAM,GAAN,MAAM,CAAQ;QAExC,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;QACxB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,kBAAkB,GAAG,YAAY,CAAC,kBAAkB,CAAC;QAC1D,IAAI,CAAC,qBAAqB,GAAG,YAAY,CAAC,qBAAqB,CAAC;QAChE,IAAI,CAAC,GAAG,GAAG,YAAY,CAAC,GAAG,CAAC;QAC5B,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT;;;WAGG;QACH,MAAM,OAAO,GAAG,CAAC,EAAyB,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE;YAClB,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF;;;;;WAKG;QACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,IAAI,EAAE;YAC9D,YAAY,EAAE,IAAI,CAAC,kBAAkB;YACrC,qBAAqB,EAAE,IAAI,CAAC,qBAAqB;YACjD,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,aAAa;SACvB,CAAC,CAAC;QAEH;;;WAGG;QACH,IAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAC,YAAY,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;QAEtC;;;;;WAKG;QACH,IAAI,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1E,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAoBD,SAAS,CAAI,IAA+B,EAAE,OAAoC;QAChF,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAC7D,MAAM,QAAQ,GAAG,KAAK,EAAE,KAAY,EAAE,EAAE;YACtC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,GAAI,KAAqC,CAAC,MAAM,CAAC;YACrE,MAAM,iBAAiB,GAAsB,IAAI,uBAAuB,EAAE,CAAC,KAAK,CAAC;YACjF,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAkB,EAAE,iBAAiB,CAAC,CAAC;gBACtE,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,MAAM,IAAI,QAAQ,EAAE,CAAC;oBACnE,IAAI,CAAC,YAAY,CAAC,EAAG,EAAE,SAAS,EAAE,QAAgC,CAAC,CAAC;gBACtE,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,YAAY,CAAC,EAAG,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,YAAY,CACf,EAAG,EACH,SAAS,EACT,IAAI,aAAa,CAAC,CAAC,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,KAAgB,CAAC,CACjF,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;QAEF,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3E,CAAC;IAkBD,cAAc,CAAI,IAA+B,EAAE,OAA+B;QAChF,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAC7D,MAAM,QAAQ,GAAG,CAAC,KAAY,EAAE,EAAE;YAChC,MAAM,EAAE,MAAM,EAAE,GAAI,KAA0C,CAAC,MAAM,CAAC;YACtE,OAAO,CAAC,MAAkB,CAAC,CAAC;QAC9B,CAAC,CAAC;QAEF,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC3E,CAAC;IAsBM,KAAK,CAAC,WAAW,CAAI,IAA+B,EAAE,MAAY;QACvE,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC;QACpB,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAC7D,MAAM,OAAO,GAAmB;YAC9B,OAAO,EAAE,KAAK;YACd,EAAE,EAAE,SAAS;YACb,MAAM;SACP,CAAC;QACF,IAAI,MAAM;YAAE,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;QAEpC,IAAI,CAAC,GAAG,CAAC,kBAAkB,OAAO,CAAC,MAAM,aAAa,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QAC9E,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAE1B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;IACL,CAAC;IAkBM,gBAAgB,CAAC,IAA+B,EAAE,MAAY;QACnE,MAAM,MAAM,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAC7D,MAAM,YAAY,GAAwB;YACxC,OAAO,EAAE,KAAK;YACd,MAAM;SACP,CAAC;QACF,IAAI,MAAM;YAAE,YAAY,CAAC,MAAM,GAAG,MAAM,CAAC;QACzC,IAAI,CAAC,GAAG,CAAC,kBAAkB,MAAM,eAAe,EAAE,YAAY,CAAC,CAAC;QAChE,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IACjC,CAAC;IAEO,YAAY,CAAC,EAAmB,EAAE,MAAW,EAAE,KAAqB;QAC1E,MAAM,QAAQ,GAAoB,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QACzD,IAAI,MAAM,KAAK,SAAS;YAAE,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC;QACnD,IAAI,KAAK,KAAK,SAAS;YAAE,QAAQ,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QACzD,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAEO,WAAW,CAAC,OAAgB;QAClC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACK,aAAa,CAAC,OAAY;QAChC,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,4BAA4B,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;YAC7D,MAAM,EAAE,GAAG,OAAO,CAAC,EAAG,CAAC,QAAQ,EAAE,CAAC;YAClC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;gBACxB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAE,CAAC,OAAO,CAAC,OAAO,CAAC,MAAO,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAE,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC/C,CAAC;YACD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC3B,CAAC;aAAM,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,GAAG,CAAC,kBAAkB,OAAO,CAAC,MAAM,aAAa,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;YAC9E,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAiB,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAC3F,CAAC;aAAM,IAAI,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,GAAG,CAAC,kBAAkB,OAAO,CAAC,MAAM,eAAe,EAAE,OAAO,CAAC,CAAC;YACnE,IAAI,CAAC,aAAa,CAChB,IAAI,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE;gBAC9B,MAAM,EAAE,OAAO;aAChB,CAAC,CACH,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAEO,UAAU,CAAC,OAAmB;QACpC,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;QACjC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,MAAM,UAAU,UAAU,CAAC,OAAmB;IAC5C,OAAO,EAAE,OAAO,EAAE,CAAC;AACrB,CAAC;AAED,SAAS,UAAU,CAAC,OAAY;IAC9B,OAAO,IAAI,IAAI,OAAO,IAAI,CAAC,OAAO,IAAI,OAAO,IAAI,QAAQ,IAAI,OAAO,CAAC,CAAC;AACxE,CAAC;AAED,SAAS,SAAS,CAAC,OAAY;IAC7B,OAAO,IAAI,IAAI,OAAO,IAAI,QAAQ,IAAI,OAAO,CAAC;AAChD,CAAC;AAED,SAAS,cAAc,CAAC,OAAY;IAClC,OAAO,CAAC,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,QAAQ,IAAI,OAAO,CAAC;AACnD,CAAC"}

package/dist/esm/extensions/client.d.ts

@@ -0,0 +1,6 @@
+import { Facet } from '@codemirror/state';
+import { AbstractLanguageClient } from '../LanguageClient';
+import { ServerCapabilities } from 'vscode-languageserver-protocol';
+export declare const clientFacet: Facet<AbstractLanguageClient, AbstractLanguageClient>;
+export declare const fileUriFacet: Facet<string, string>;
+export declare const serverCapabilitiesFacet: Facet<ServerCapabilities<any> | null, ServerCapabilities<any>>;

package/dist/esm/extensions/client.js

@@ -0,0 +1,12 @@
+import { Facet } from '@codemirror/state';
+export const clientFacet = Facet.define({
+    combine: (values) => values[0],
+    static: true,
+});
+export const fileUriFacet = Facet.define({
+    combine: (values) => values[0],
+});
+export const serverCapabilitiesFacet = Facet.define({
+    combine: (values) => values[0] ?? {},
+});
+//# sourceMappingURL=client.js.map

package/dist/esm/extensions/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/extensions/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAK1C,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAiD;IACtF,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9B,MAAM,EAAE,IAAI;CACb,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,CAAiB;IACvD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;CAC/B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,CAAC,MAAM,CAAgD;IACjG,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE;CACrC,CAAC,CAAC"}

package/dist/esm/extensions/complete.d.ts

@@ -0,0 +1,17 @@
+import { autocompletion, CompletionContext, CompletionResult, CompletionInfo } from '@codemirror/autocomplete';
+import { CompletionItem } from 'vscode-languageserver-protocol';
+import { Facet } from '@codemirror/state';
+type FirstArgType<F> = F extends (arg: infer A) => any ? A : never;
+export type AutocompleteOptions = Partial<FirstArgType<typeof autocompletion>>;
+export declare const lspComplete: (overrides?: AutocompleteOptions) => import("@codemirror/state").Extension;
+/**
+ * An InfoRenderer would be equivalent to the Quick Info window in VS Code. It's the part of the completion
+ * window that shows you the docs about the thing that is currently selected.
+ *
+ * Takes a LSP CompletionItem as argument and returns a DOM node, optional and injected so that we can control
+ * how we render the info window from the rendering context.
+ */
+export type InfoRenderer = (completion: CompletionItem) => CompletionInfo;
+export declare const infoRendererFacet: Facet<InfoRenderer | undefined, InfoRenderer | undefined>;
+export declare function complete(context: CompletionContext): Promise<CompletionResult | null>;
+export {};