@difizen/libro-lsp 0.1.2

package/es/adapters/status-message.js

@@ -0,0 +1,110 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+
+import { Emitter } from '@difizen/mana-app';
+export var StatusMessage = /*#__PURE__*/function () {
+  function StatusMessage() {
+    _classCallCheck(this, StatusMessage);
+    /**
+     * Timeout reference used to clear the previous `setTimeout` call.
+     */
+    /**
+     * The text message to be shown on the statusbar
+     */
+    this._changed = new Emitter();
+    this._isDisposed = false;
+    this._message = '';
+    this._timer = null;
+  }
+
+  /**
+   * Signal emitted on status changed event.
+   */
+  _createClass(StatusMessage, [{
+    key: "changed",
+    get: function get() {
+      return this._changed;
+    }
+
+    /**
+     * Test whether the object is disposed.
+     */
+  }, {
+    key: "isDisposed",
+    get: function get() {
+      return this._isDisposed;
+    }
+
+    /**
+     * Dispose the object.
+     */
+  }, {
+    key: "dispose",
+    value: function dispose() {
+      if (this.isDisposed) {
+        return;
+      }
+      this._isDisposed = true;
+      if (this._timer) {
+        window.clearTimeout(this._timer);
+      }
+    }
+
+    /**
+     * The text message to be shown on the statusbar.
+     */
+  }, {
+    key: "message",
+    get: function get() {
+      return this._message;
+    }
+
+    /**
+     * 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)
+     */
+  }, {
+    key: "set",
+    value: function set(message) {
+      var timeout = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 1000 * 3;
+      this._expireTimer();
+      this._message = message;
+      this._changed.fire();
+      if (timeout !== -1) {
+        this._timer = window.setTimeout(this.clear.bind(this), timeout);
+      }
+    }
+
+    /**
+     * Clear the status message.
+     */
+  }, {
+    key: "clear",
+    value: function clear() {
+      this._message = '';
+      this._changed.fire();
+    }
+
+    /**
+     * Clear the previous `setTimeout` call.
+     */
+  }, {
+    key: "_expireTimer",
+    value: function _expireTimer() {
+      if (this._timer !== null) {
+        window.clearTimeout(this._timer);
+        this._timer = null;
+      }
+    }
+  }]);
+  return StatusMessage;
+}();

package/es/connection-manager.d.ts

@@ -0,0 +1,199 @@
+import type { NotebookView } from '@difizen/libro-core';
+import type { Event } from '@difizen/mana-app';
+import { Emitter } from '@difizen/mana-app';
+import type { WidgetLSPAdapter } from './adapters/adapter.js';
+import { LSPConnection } from './connection.js';
+import type { AskServersToSendTraceNotifications } from './plugin.js';
+import type { Document, IDocumentConnectionData, ILanguageServerManager, ILSPConnection, ISocketConnectionOptions, TLanguageServerConfigurations, TLanguageServerId } from './tokens.js';
+import { ILSPDocumentConnectionManager, ILanguageServerManagerFactory } from './tokens.js';
+import type { VirtualDocument } from './virtual/document.js';
+/**
+ * Each Widget with a document (whether file or a notebook) has the same DocumentConnectionManager
+ * (see JupyterLabWidgetAdapter). Using id_path instead of uri led to documents being overwritten
+ * as two identical id_paths could be created for two different notebooks.
+ */
+export declare class DocumentConnectionManager implements ILSPDocumentConnectionManager {
+    constructor(languageServerManagerFactory: ILanguageServerManagerFactory);
+    /**
+     * Map between the URI of the virtual document and its connection
+     * to the language server
+     */
+    readonly connections: Map<VirtualDocument.uri, LSPConnection>;
+    /**
+     * Map between the path of the document and its adapter
+     */
+    readonly adapters: Map<string, WidgetLSPAdapter<NotebookView>>;
+    /**
+     * Map between the URI of the virtual document and the document itself.
+     */
+    readonly documents: Map<VirtualDocument.uri, VirtualDocument>;
+    /**
+     * The language server manager plugin.
+     */
+    readonly languageServerManager: ILanguageServerManager;
+    /**
+     * Initial configuration for the language servers.
+     */
+    initialConfigurations: TLanguageServerConfigurations;
+    /**
+     * Signal emitted when the manager is initialized.
+     */
+    get initialized(): Event<IDocumentConnectionData>;
+    /**
+     * Signal emitted when the manager is connected to the server
+     */
+    get connected(): Event<IDocumentConnectionData>;
+    /**
+     * Connection temporarily lost or could not be fully established; a re-connection will be attempted;
+     */
+    get disconnected(): Event<IDocumentConnectionData>;
+    /**
+     * Connection was closed permanently and no-reconnection will be attempted, e.g.:
+     *  - there was a serious server error
+     *  - user closed the connection,
+     *  - re-connection attempts exceeded,
+     */
+    get closed(): Event<IDocumentConnectionData>;
+    /**
+     * Signal emitted when the document is changed.
+     */
+    get documentsChanged(): Event<Map<VirtualDocument.uri, VirtualDocument>>;
+    /**
+     * Promise resolved when the language server manager is ready.
+     */
+    get ready(): Promise<void>;
+    /**
+     * Helper to connect various virtual document signal with callbacks of
+     * this class.
+     *
+     * @param  virtualDocument - virtual document to be connected.
+     */
+    connectDocumentSignals(virtualDocument: VirtualDocument): void;
+    /**
+     * Helper to disconnect various virtual document signal with callbacks of
+     * this class.
+     *
+     * @param  virtualDocument - virtual document to be disconnected.
+     */
+    disconnectDocumentSignals(virtualDocument: VirtualDocument, emit?: boolean): void;
+    /**
+     * Handle foreign document opened event.
+     */
+    onForeignDocumentOpened(context: Document.IForeignContext): void;
+    /**
+     * Handle foreign document closed event.
+     */
+    onForeignDocumentClosed(context: Document.IForeignContext): void;
+    /**
+     * Register a widget adapter with this manager
+     *
+     * @param  path - path to the inner document of the adapter
+     * @param  adapter - the adapter to be registered
+     */
+    registerAdapter(path: string, adapter: WidgetLSPAdapter<NotebookView>): void;
+    /**
+     * Handles the settings that do not require an existing connection
+     * with a language server (or can influence to which server the
+     * connection will be created, e.g. `rank`).
+     *
+     * This function should be called **before** initialization of servers.
+     */
+    updateConfiguration(allServerSettings: TLanguageServerConfigurations): void;
+    /**
+     * Handles the settings that the language servers accept using
+     * `onDidChangeConfiguration` messages, which should be passed under
+     * the "serverSettings" keyword in the setting registry.
+     * Other configuration options are handled by `updateConfiguration` instead.
+     *
+     * This function should be called **after** initialization of servers.
+     */
+    updateServerConfigurations(allServerSettings: TLanguageServerConfigurations): void;
+    /**
+     * Fired the first time a connection is opened. These _should_ be the only
+     * invocation of `.on` (once remaining LSPFeature.connection_handlers are made
+     * singletons).
+     */
+    onNewConnection: (connection: LSPConnection) => void;
+    /**
+     * Retry to connect to the server each `reconnectDelay` seconds
+     * and for `retrialsLeft` times.
+     * TODO: presently no longer referenced. A failing connection would close
+     * the socket, triggering the language server on the other end to exit.
+     */
+    retryToConnect(options: ISocketConnectionOptions, reconnectDelay: number, retrialsLeft?: number): Promise<void>;
+    /**
+     * Disconnect the connection to the language server of the requested
+     * language.
+     */
+    disconnect(languageId: TLanguageServerId): void;
+    /**
+     * Create a new connection to the language server
+     * @return A promise of the LSP connection
+     */
+    connect(options: ISocketConnectionOptions, firstTimeoutSeconds?: number, secondTimeoutMinutes?: number): Promise<ILSPConnection | undefined>;
+    /**
+     * Disconnect the signals of requested virtual document uri.
+     */
+    unregisterDocument(uri: string, emit?: boolean): void;
+    /**
+     * Enable or disable the logging feature of the language servers
+     */
+    updateLogging(logAllCommunication: boolean, setTrace: AskServersToSendTraceNotifications): void;
+    /**
+     * Create the LSP connection for requested virtual document.
+     *
+     * @return  Return the promise of the LSP connection.
+     */
+    protected _connectSocket(options: ISocketConnectionOptions): Promise<LSPConnection | undefined>;
+    /**
+     * Helper to apply callback on all documents of a connection.
+     */
+    protected _forEachDocumentOfConnection(connection: ILSPConnection, callback: (virtualDocument: VirtualDocument) => void): void;
+    protected _initialized: Emitter<IDocumentConnectionData>;
+    protected _connected: Emitter<IDocumentConnectionData>;
+    protected _disconnected: Emitter<IDocumentConnectionData>;
+    protected _closed: Emitter<IDocumentConnectionData>;
+    protected _documentsChanged: Emitter<Map<string, VirtualDocument>>;
+    /**
+     * Set of ignored languages
+     */
+    protected _ignoredLanguages: Set<string>;
+}
+export declare namespace DocumentConnectionManager {
+    interface IOptions {
+        /**
+         * The language server manager instance.
+         */
+        languageServerManager: ILanguageServerManager;
+    }
+    /**
+     * Generate the URI of a virtual document from input
+     *
+     * @param  virtualDocument - the virtual document
+     * @param  language - language of the document
+     */
+    function solveUris(virtualDocument: VirtualDocument, language: string): IURIs | undefined;
+    interface IURIs {
+        /**
+         * The root URI set by server.
+         *
+         */
+        base: string;
+        /**
+         * The URI to the virtual document.
+         *
+         */
+        document: string;
+        /**
+         * Address of websocket endpoint for LSP services.
+         *
+         */
+        server: string;
+        /**
+         * Address of websocket endpoint for the language server.
+         *
+         */
+        socket: string;
+    }
+}
+//# sourceMappingURL=connection-manager.d.ts.map

package/es/connection-manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection-manager.d.ts","sourceRoot":"","sources":["../src/connection-manager.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAqB,MAAM,mBAAmB,CAAC;AAG/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAC;AACtE,OAAO,KAAK,EACV,QAAQ,EACR,uBAAuB,EACvB,sBAAsB,EACtB,cAAc,EACd,wBAAwB,EACxB,6BAA6B,EAC7B,iBAAiB,EAElB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,6BAA6B,EAC7B,6BAA6B,EAC9B,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D;;;;GAIG;AACH,qBACa,yBAA0B,YAAW,6BAA6B;gBAG3E,4BAA4B,EAAE,6BAA6B;IAU7D;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,eAAe,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;IAE9D;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;IAE/D;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,eAAe,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;IAC9D;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,sBAAsB,CAAC;IAEvD;;OAEG;IACH,qBAAqB,EAAE,6BAA6B,CAAC;IAErD;;OAEG;IACH,IAAI,WAAW,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAEhD;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAE9C;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAEjD;IAED;;;;;OAKG;IACH,IAAI,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAE3C;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,KAAK,CAAC,GAAG,CAAC,eAAe,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC,CAEvE;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAEzB;IAED;;;;;OAKG;IACH,sBAAsB,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IAQ9D;;;;;OAKG;IACH,yBAAyB,CAAC,eAAe,EAAE,eAAe,EAAE,IAAI,UAAO,GAAG,IAAI;IAW9E;;OAEG;IAEH,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,eAAe,GAAG,IAAI;IAIhE;;OAEG;IACH,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,eAAe,GAAG,IAAI;IAMhE;;;;;OAKG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,CAAC,YAAY,CAAC,GAAG,IAAI;IAU5E;;;;;;OAMG;IACH,mBAAmB,CAAC,iBAAiB,EAAE,6BAA6B,GAAG,IAAI;IAI3E;;;;;;;OAOG;IACH,0BAA0B,CAAC,iBAAiB,EAAE,6BAA6B,GAAG,IAAI;IAmBlF;;;;OAIG;IACH,eAAe,eAAgB,aAAa,KAAG,IAAI,CA2CjD;IAEF;;;;;OAKG;IACG,cAAc,CAClB,OAAO,EAAE,wBAAwB,EACjC,cAAc,EAAE,MAAM,EACtB,YAAY,SAAK,GAChB,OAAO,CAAC,IAAI,CAAC;IA6BhB;;;OAGG;IACH,UAAU,CAAC,UAAU,EAAE,iBAAiB,GAAG,IAAI;IAI/C;;;OAGG;IACG,OAAO,CACX,OAAO,EAAE,wBAAwB,EACjC,mBAAmB,SAAK,EACxB,oBAAoB,SAAI,GACvB,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAqCtC;;OAEG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,UAAO,GAAG,IAAI;IAgBlD;;OAEG;IACH,aAAa,CACX,mBAAmB,EAAE,OAAO,EAC5B,QAAQ,EAAE,kCAAkC,GAC3C,IAAI;IASP;;;;OAIG;cAEa,cAAc,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAkCrC;;OAEG;IACH,SAAS,CAAC,4BAA4B,CACpC,UAAU,EAAE,cAAc,EAC1B,QAAQ,EAAE,CAAC,eAAe,EAAE,eAAe,KAAK,IAAI;IAUtD,SAAS,CAAC,YAAY,mCAA0C;IAEhE,SAAS,CAAC,UAAU,mCAA0C;IAE9D,SAAS,CAAC,aAAa,mCAA0C;IAEjE,SAAS,CAAC,OAAO,mCAA0C;IAE3D,SAAS,CAAC,iBAAiB,wCAEvB;IAEJ;;OAEG;IACH,SAAS,CAAC,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAC1C;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,QAAQ;QACvB;;WAEG;QACH,qBAAqB,EAAE,sBAAsB,CAAC;KAC/C;IAED;;;;;OAKG;IACH,SAAgB,SAAS,CACvB,eAAe,EAAE,eAAe,EAChC,QAAQ,EAAE,MAAM,GACf,KAAK,GAAG,SAAS,CAmCnB;IAED,UAAiB,KAAK;QACpB;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB;CACF"}