@jupyterlab/lsp 4.0.0-alpha.11 → 4.0.0-alpha.12

package/lib/tokens.d.ts

@@ -1,65 +1,116 @@
 import { IDocumentWidget } from '@jupyterlab/docregistry';
-import { CellType } from '@jupyterlab/nbformat';
 import { ServerConnection } from '@jupyterlab/services';
 import { Token } from '@lumino/coreutils';
+import { IDisposable } from '@lumino/disposable';
 import { ISignal, Signal } from '@lumino/signaling';
-import { AnyCompletion, AnyLocation, IDocumentInfo, ILspConnection, ILspOptions, IPosition, ITokenInfo } from 'lsp-ws-connection';
-import { WidgetAdapter } from './adapters/adapter';
+import { WidgetLSPAdapter } from './adapters/adapter';
 import { IForeignCodeExtractor } from './extractors/types';
-import { ClientCapabilities, LanguageIdentifier } from './lsp';
-import { LanguageServer2 as LSPLanguageServerSettings } from './plugin';
+import { AnyCompletion, AnyLocation, ClientCapabilities, LanguageIdentifier } from './lsp';
+import { LanguageServer1 as LSPLanguageServerSettings } from './plugin';
 import * as SCHEMA from './schema';
 import { VirtualDocument } from './virtual/document';
+import { IDocumentInfo, ILspConnection, ILspOptions } from './ws-connection/types';
 import type * as rpc from 'vscode-jsonrpc';
 import type * as lsp from 'vscode-languageserver-protocol';
+export { IDocumentInfo };
+/**
+ * Example server keys==ids that are expected. The list is not exhaustive.
+ * Custom server keys are allowed. Constraining the values helps avoid errors,
+ * but at runtime any value is allowed.
+ */
 export declare type TLanguageServerId = 'pylsp' | 'bash-language-server' | 'dockerfile-language-server-nodejs' | 'javascript-typescript-langserver' | 'unified-language-server' | 'vscode-css-languageserver-bin' | 'vscode-html-languageserver-bin' | 'vscode-json-languageserver-bin' | 'yaml-language-server' | 'r-languageserver';
+/**
+ * Type alias for the server ids.
+ */
 export declare type TServerKeys = TLanguageServerId;
+/**
+ * Type of language server configuration, it is a map between server
+ * id and its setting.
+ */
 export declare type TLanguageServerConfigurations = Partial<Record<TServerKeys, LSPLanguageServerSettings>>;
+/**
+ * Type of language server session, it is a map between server
+ * id and the associated session.
+ */
 export declare type TSessionMap = Map<TServerKeys, SCHEMA.LanguageServerSession>;
+/**
+ * Type of language server specs, it is a map between server
+ * id and the associated specs.
+ */
 export declare type TSpecsMap = Map<TServerKeys, SCHEMA.LanguageServerSpec>;
+/**
+ * Type alias for language server id, it helps to clarify other types.
+ */
 export declare type TLanguageId = string;
-export interface ILanguageServerManager {
+export interface ILanguageServerManager extends IDisposable {
     /**
-     * Signal emitted when the language server sessions are changed.
+     * @alpha
      *
+     * Signal emitted when the language server sessions are changed.
      */
     sessionsChanged: ISignal<ILanguageServerManager, void>;
     /**
+     * @alpha
+     *
      * The current session information of running language servers.
      */
-    sessions: TSessionMap;
+    readonly sessions: TSessionMap;
     /**
-     * An ordered list of matching >running< sessions, with servers of higher priority higher in the list
+     * @alpha
+     *
+     * A promise that is fulfilled when the connection manager is ready.
      */
-    getMatchingServers(options: ILanguageServerManager.IGetServerIdOptions): TLanguageServerId[];
+    readonly ready: Promise<void>;
     /**
-     * A list of all known matching specs (whether detected or not).
+     * @alpha
+     *
+     * Current endpoint to get the status of running language servers
      */
-    getMatchingSpecs(options: ILanguageServerManager.IGetServerIdOptions): TSpecsMap;
+    readonly statusUrl: string;
     /**
-     * Set the configuration for language servers
+     * @alpha
      *
+     * Status code of the `fetchSession` request.
      */
-    setConfiguration(configuration: TLanguageServerConfigurations): void;
+    readonly statusCode: number;
     /**
-     * Send a request to language server handler to get the session information.
+     * @alpha
      *
+     * An ordered list of matching >running< sessions, with servers of higher rank higher in the list
      */
-    fetchSessions(): Promise<void>;
+    getMatchingServers(options: ILanguageServerManager.IGetServerIdOptions): TLanguageServerId[];
     /**
-     * Current endpoint to get the status of running language servers
+     * @alpha
+     *
+     * A list of all known matching specs (whether detected or not).
      */
-    statusUrl: string;
+    getMatchingSpecs(options: ILanguageServerManager.IGetServerIdOptions): TSpecsMap;
     /**
+     * @alpha
      *
-     * Status code of the `fetchSession` request.
+     * Set the configuration for language servers
+     */
+    setConfiguration(configuration: TLanguageServerConfigurations): void;
+    /**
+     * @alpha
+     *
+     * Send a request to language server handler to get the session information.
      */
-    statusCode: number;
+    fetchSessions(): Promise<void>;
 }
 export declare namespace ILanguageServerManager {
+    /**
+     * LSP endpoint prefix.
+     */
     const URL_NS = "lsp";
     interface IOptions {
+        /**
+         * The Jupyter server settings objec
+         */
         settings?: ServerConnection.ISettings;
+        /**
+         * Base URL of current JupyterLab server.
+         */
         baseUrl?: string;
         /**
          * Number of connection retries to fetch the sessions.
@@ -71,42 +122,63 @@ export declare namespace ILanguageServerManager {
          */
         retriesInterval?: number;
     }
+    /**
+     * The argument for getting server session or specs.
+     */
     interface IGetServerIdOptions {
+        /**
+         * Language server id
+         */
         language?: TLanguageId;
+        /**
+         * Server specs mime type.
+         */
         mimeType?: string;
     }
 }
+/**
+ * Option to create the websocket connection to the LSP proxy server
+ * on the backend.
+ */
 export interface ISocketConnectionOptions {
+    /**
+     * The virtual document trying to connect to the LSP server.
+     */
     virtualDocument: VirtualDocument;
     /**
-     * The language identifier, corresponding to the API endpoint on the LSP proxy server.
+     * The language identifier, corresponding to the API endpoint on the
+     * LSP proxy server.
      */
     language: string;
     /**
      * LSP capabilities describing currently supported features
      */
     capabilities: ClientCapabilities;
-    hasLspSupportedFile: boolean;
-}
-export interface IDocumentRegistationOptions {
-    /**
-     * The language identifier, corresponding to the API endpoint on the LSP proxy server.
-     */
-    language: string;
     /**
-     * Path to the document in the JupyterLab space
+     * Is the file format is supported by LSP?
      */
-    document: string;
-    /**
-     * LSP capabilities describing currently supported features
-     */
-    capabilities: ClientCapabilities;
     hasLspSupportedFile: boolean;
 }
+/**
+ * @alpha
+ *
+ * Interface describing the LSP connection state
+ */
 export interface IDocumentConnectionData {
+    /**
+     * The virtual document connected to the language server
+     */
     virtualDocument: VirtualDocument;
+    /**
+     * The connection between the virtual document and the language server.
+     */
     connection: ILSPConnection;
 }
+/**
+ * @alpha
+ *
+ * The LSP connection state manager
+ */
 export interface ILSPDocumentConnectionManager {
     /**
      * The mapping of document uri to the  connection to language server.
@@ -119,7 +191,7 @@ export interface ILSPDocumentConnectionManager {
     /**
      * The mapping of document uri to the widget adapter.
      */
-    adapters: Map<string, WidgetAdapter<IDocumentWidget>>;
+    adapters: Map<string, WidgetLSPAdapter<IDocumentWidget>>;
     /**
      * Signal emitted when a connection is connected.
      */
@@ -144,10 +216,14 @@ export interface ILSPDocumentConnectionManager {
      * The language server manager instance.
      */
     languageServerManager: ILanguageServerManager;
+    /**
+     * A promise that is fulfilled when the connection manager is ready.
+     */
+    readonly ready: Promise<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. `priority`).
+     * connection will be created, e.g. `rank`).
      *
      * This function should be called **before** initialization of servers.
      */
@@ -164,7 +240,6 @@ export interface ILSPDocumentConnectionManager {
     /**
      * Retry to connect to the server each `reconnectDelay` seconds
      * and for `retrialsLeft` times.
-     *
      */
     retryToConnect(options: ISocketConnectionOptions, reconnectDelay: number, retrialsLeft: number): Promise<void>;
     /**
@@ -175,12 +250,10 @@ export interface ILSPDocumentConnectionManager {
     /**
      * Disconnect the connection to the language server of the requested
      * language.
-     *
      */
     disconnect(languageId: TLanguageServerId): void;
     /**
      * Disconnect the signals of requested virtual document.
-     *
      */
     unregisterDocument(virtualDocument: VirtualDocument): void;
     /**
@@ -189,8 +262,13 @@ export interface ILSPDocumentConnectionManager {
      * @param  path - path to current document widget of input adapter
      * @param  adapter - the adapter need to be registered
      */
-    registerAdapter(path: string, adapter: WidgetAdapter<IDocumentWidget>): void;
+    registerAdapter(path: string, adapter: WidgetLSPAdapter<IDocumentWidget>): void;
 }
+/**
+ * @alpha
+ *
+ * Interface describing the client feature
+ */
 export interface IFeature {
     /**
      * The feature identifier. It must be the same as the feature plugin id.
@@ -201,6 +279,11 @@ export interface IFeature {
      */
     capabilities?: ClientCapabilities;
 }
+/**
+ * @alpha
+ *
+ * The LSP feature manager
+ */
 export interface ILSPFeatureManager {
     /**
      * A read-only registry of all registered features.
@@ -211,27 +294,67 @@ export interface ILSPFeatureManager {
      * for one or more code editor implementations.
      */
     register(feature: IFeature): void;
+    /**
+     * Signal emitted when a feature is registered
+     */
     featuresRegistered: ISignal<ILSPFeatureManager, IFeature>;
+    /**
+     * Get capabilities of all registered features
+     */
     clientCapabilities(): ClientCapabilities;
 }
 /**
+ * @alpha
+ *
  * Manages code transclusion plugins.
  */
 export interface ILSPCodeExtractorsManager {
     /**
      * Get the foreign code extractors.
      */
-    getExtractors(cellType: CellType, hostLanguage: string | null): IForeignCodeExtractor[];
+    getExtractors(cellType: string, hostLanguage: string | null): IForeignCodeExtractor[];
     /**
      * Register the extraction rules to be applied in documents with language `host_language`.
      */
     register(extractor: IForeignCodeExtractor, hostLanguage: LanguageIdentifier | null): void;
 }
+/**
+ * @alpha
+ *
+ * The virtual documents and language server connections manager
+ * Require this token in your extension to access the associated virtual
+ * document and LS connection of opened documents.
+ *
+ */
 export declare const ILSPDocumentConnectionManager: Token<ILSPDocumentConnectionManager>;
+/**
+ * @alpha
+ *
+ * The language server feature manager. Require this token in your extension
+ * to register the client capabilities implemented by your extension.
+ *
+ */
 export declare const ILSPFeatureManager: Token<ILSPFeatureManager>;
+/**
+ * @alpha
+ *
+ * The code extractor manager. Require this token in your extension to
+ * register new code extractors. Code extractor allows creating multiple
+ * virtual documents from an opened document.
+ *
+ */
 export declare const ILSPCodeExtractorsManager: Token<ILSPCodeExtractorsManager>;
+/**
+ * Argument for creating a connection to the LSP proxy server.
+ */
 export interface ILSPOptions extends ILspOptions {
+    /**
+     * Client capabilities implemented by the client.
+     */
     capabilities: ClientCapabilities;
+    /**
+     * Language server id.
+     */
     serverIdentifier?: string;
 }
 /**
@@ -278,12 +401,18 @@ export declare namespace Method {
         TYPE_DEFINITION = "textDocument/typeDefinition"
     }
 }
+/**
+ * Interface describing the notifications that come from the server.
+ */
 export interface IServerNotifyParams {
     [Method.ServerNotification.LOG_MESSAGE]: lsp.LogMessageParams;
     [Method.ServerNotification.LOG_TRACE]: rpc.LogTraceParams;
     [Method.ServerNotification.PUBLISH_DIAGNOSTICS]: lsp.PublishDiagnosticsParams;
     [Method.ServerNotification.SHOW_MESSAGE]: lsp.ShowMessageParams;
 }
+/**
+ * Interface describing the notifications that come from the client.
+ */
 export interface IClientNotifyParams {
     [Method.ClientNotification
         .DID_CHANGE_CONFIGURATION]: lsp.DidChangeConfigurationParams;
@@ -293,18 +422,27 @@ export interface IClientNotifyParams {
     [Method.ClientNotification.INITIALIZED]: lsp.InitializedParams;
     [Method.ClientNotification.SET_TRACE]: rpc.SetTraceParams;
 }
+/**
+ * Interface describing the requests sent to the server.
+ */
 export interface IServerRequestParams {
     [Method.ServerRequest.REGISTER_CAPABILITY]: lsp.RegistrationParams;
     [Method.ServerRequest.SHOW_MESSAGE_REQUEST]: lsp.ShowMessageRequestParams;
     [Method.ServerRequest.UNREGISTER_CAPABILITY]: lsp.UnregistrationParams;
     [Method.ServerRequest.WORKSPACE_CONFIGURATION]: lsp.ConfigurationParams;
 }
+/**
+ * Interface describing the responses received from the server.
+ */
 export interface IServerResult {
     [Method.ServerRequest.REGISTER_CAPABILITY]: void;
     [Method.ServerRequest.SHOW_MESSAGE_REQUEST]: lsp.MessageActionItem | null;
     [Method.ServerRequest.UNREGISTER_CAPABILITY]: void;
     [Method.ServerRequest.WORKSPACE_CONFIGURATION]: any[];
 }
+/**
+ * Interface describing the request sent to the client.
+ */
 export interface IClientRequestParams {
     [Method.ClientRequest.COMPLETION_ITEM_RESOLVE]: lsp.CompletionItem;
     [Method.ClientRequest.COMPLETION]: lsp.CompletionParams;
@@ -319,6 +457,9 @@ export interface IClientRequestParams {
     [Method.ClientRequest.SIGNATURE_HELP]: lsp.TextDocumentPositionParams;
     [Method.ClientRequest.TYPE_DEFINITION]: lsp.TextDocumentPositionParams;
 }
+/**
+ * Interface describing the responses received from the client.
+ */
 export interface IClientResult {
     [Method.ClientRequest.COMPLETION_ITEM_RESOLVE]: lsp.CompletionItem;
     [Method.ClientRequest.COMPLETION]: AnyCompletion;
@@ -333,36 +474,125 @@ export interface IClientResult {
     [Method.ClientRequest.SIGNATURE_HELP]: lsp.SignatureHelp;
     [Method.ClientRequest.TYPE_DEFINITION]: AnyLocation;
 }
+/**
+ * Type of server notification handlers, it is a map between the server
+ * notification name and the associated `ISignal`.
+ */
 export declare type ServerNotifications<T extends keyof IServerNotifyParams = keyof IServerNotifyParams> = {
     readonly [key in T]: ISignal<ILSPConnection, IServerNotifyParams[key]>;
 };
+/**
+ * Type of client notification handlers, it is a map between the client
+ * notification name and the associated signal.
+ */
 export declare type ClientNotifications<T extends keyof IClientNotifyParams = keyof IClientNotifyParams> = {
     readonly [key in T]: Signal<ILSPConnection, IClientNotifyParams[key]>;
 };
+/**
+ * Interface describing the client request handler.
+ */
 export interface IClientRequestHandler<T extends keyof IClientRequestParams = keyof IClientRequestParams> {
     request(params: IClientRequestParams[T]): Promise<IClientResult[T]>;
 }
+/**
+ * Interface describing the server request handler.
+ */
 export interface IServerRequestHandler<T extends keyof IServerRequestParams = keyof IServerRequestParams> {
     setHandler(handler: (params: IServerRequestParams[T], connection?: ILSPConnection) => Promise<IServerResult[T]>): void;
     clearHandler(): void;
 }
+/**
+ * Type of client request handlers, it is a map between the client
+ * request name and the associated handler.
+ */
 export declare type ClientRequests<T extends keyof IClientRequestParams = keyof IClientRequestParams> = {
     readonly [key in T]: IClientRequestHandler<key>;
 };
+/**
+ * Type of server request handlers, it is a map between the server
+ * request name and the associated handler.
+ */
 export declare type ServerRequests<T extends keyof IServerRequestParams = keyof IServerRequestParams> = {
     readonly [key in T]: IServerRequestHandler<key>;
 };
-export interface ILSPConnection extends ILspConnection {
+/**
+ * @alpha
+ *
+ * Interface describing he connection to the language server.
+ */
+export interface ILSPConnection extends ILspConnection, IDisposable {
+    /**
+     * @alpha
+     *
+     * Identifier of the language server
+     */
     serverIdentifier?: string;
+    /**
+     * @alpha
+     *
+     * Language of the language server
+     */
     serverLanguage?: string;
+    /**
+     * @alpha
+     *
+     * Should log all communication?
+     */
     logAllCommunication: boolean;
-    isReady: boolean;
+    /**
+     * @alpha
+     *
+     * Notifications that come from the client.
+     */
     clientNotifications: ClientNotifications;
+    /**
+     * @alpha
+     *
+     * Notifications that come from the server.
+     */
     serverNotifications: ServerNotifications;
+    /**
+     * @alpha
+     *
+     * Requests that come from the client.
+     */
     clientRequests: ClientRequests;
+    /**
+     * @alpha
+     *
+     * Responses that come from the server.
+     */
     serverRequests: ServerRequests;
-    sendSaved(documentInfo: IDocumentInfo): void;
+    /**
+     * @alpha
+     *
+     * Signal emitted when the connection is closed.
+     */
+    closeSignal: ISignal<ILSPConnection, boolean>;
+    /**
+     * @alpha
+     *
+     * Signal emitted when the connection receives an error
+     * message..
+     */
+    errorSignal: ISignal<ILSPConnection, any>;
+    /**
+     * @alpha
+     *
+     * Signal emitted when the connection is initialized.
+     */
+    serverInitialized: ISignal<ILSPConnection, lsp.ServerCapabilities<any>>;
+    /**
+     * @alpha
+     *
+     * Send the open request to the backend when the server is
+     * ready.
+     */
     sendOpenWhenReady(documentInfo: IDocumentInfo): void;
+    /**
+     * @alpha
+     *
+     * Send all changes to the server.
+     */
     sendFullTextChange(text: string, documentInfo: IDocumentInfo): void;
-    getCompletion(location: IPosition, token: ITokenInfo, documentInfo: IDocumentInfo, emit?: boolean, triggerCharacter?: string, triggerKind?: lsp.CompletionTriggerKind): Promise<lsp.CompletionItem[] | undefined>;
 }

package/lib/tokens.js

@@ -1,10 +1,38 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
 import { Token } from '@lumino/coreutils';
 export var ILanguageServerManager;
 (function (ILanguageServerManager) {
+    /**
+     * LSP endpoint prefix.
+     */
     ILanguageServerManager.URL_NS = 'lsp';
 })(ILanguageServerManager || (ILanguageServerManager = {}));
+/**
+ * @alpha
+ *
+ * The virtual documents and language server connections manager
+ * Require this token in your extension to access the associated virtual
+ * document and LS connection of opened documents.
+ *
+ */
 export const ILSPDocumentConnectionManager = new Token('@jupyterlab/lsp:ILSPDocumentConnectionManager');
+/**
+ * @alpha
+ *
+ * The language server feature manager. Require this token in your extension
+ * to register the client capabilities implemented by your extension.
+ *
+ */
 export const ILSPFeatureManager = new Token('@jupyterlab/lsp:ILSPFeatureManager');
+/**
+ * @alpha
+ *
+ * The code extractor manager. Require this token in your extension to
+ * register new code extractors. Code extractor allows creating multiple
+ * virtual documents from an opened document.
+ *
+ */
 export const ILSPCodeExtractorsManager = new Token('@jupyterlab/lsp:ILSPCodeExtractorsManager');
 /**
  * Method strings are reproduced here because a non-typing import of

package/lib/tokens.js.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AA8F1C,MAAM,KAAW,sBAAsB,CAmBtC;AAnBD,WAAiB,sBAAsB;IACxB,6BAAM,GAAG,KAAK,CAAC;AAkB9B,CAAC,EAnBgB,sBAAsB,KAAtB,sBAAsB,QAmBtC;AAyMD,MAAM,CAAC,MAAM,6BAA6B,GACxC,IAAI,KAAK,CACP,+CAA+C,CAChD,CAAC;AAEJ,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,KAAK,CACzC,oCAAoC,CACrC,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,KAAK,CAChD,2CAA2C,CAC5C,CAAC;AAOF;;;GAGG;AACH,MAAM,KAAW,MAAM,CA0CtB;AA1CD,WAAiB,MAAM;IACrB,2BAA2B;IAC3B,IAAY,kBAKX;IALD,WAAY,kBAAkB;QAC5B,6EAAuD,CAAA;QACvD,yDAAmC,CAAA;QACnC,8CAAwB,CAAA;QACxB,uDAAiC,CAAA;IACnC,CAAC,EALW,kBAAkB,GAAlB,yBAAkB,KAAlB,yBAAkB,QAK7B;IAED,2BAA2B;IAC3B,IAAY,kBAOX;IAPD,WAAY,kBAAkB;QAC5B,2DAAqC,CAAA;QACrC,mFAA6D,CAAA;QAC7D,uDAAiC,CAAA;QACjC,uDAAiC,CAAA;QACjC,iDAA2B,CAAA;QAC3B,8CAAwB,CAAA;IAC1B,CAAC,EAPW,kBAAkB,GAAlB,yBAAkB,KAAlB,yBAAkB,QAO7B;IAED,sBAAsB;IACtB,IAAY,aAKX;IALD,WAAY,aAAa;QACvB,kEAAiD,CAAA;QACjD,mEAAkD,CAAA;QAClD,sEAAqD,CAAA;QACrD,oEAAmD,CAAA;IACrD,CAAC,EALW,aAAa,GAAb,oBAAa,KAAb,oBAAa,QAKxB;IAED,sBAAsB;IACtB,IAAY,aAaX;IAbD,WAAY,aAAa;QACvB,uDAAsC,CAAA;QACtC,mEAAkD,CAAA;QAClD,uDAAsC,CAAA;QACtC,sEAAqD,CAAA;QACrD,gEAA+C,CAAA;QAC/C,6CAA4B,CAAA;QAC5B,+DAA8C,CAAA;QAC9C,0CAAyB,CAAA;QACzB,uDAAsC,CAAA;QACtC,+CAA8B,CAAA;QAC9B,8DAA6C,CAAA;QAC7C,gEAA+C,CAAA;IACjD,CAAC,EAbW,aAAa,GAAb,oBAAa,KAAb,oBAAa,QAaxB;AACH,CAAC,EA1CgB,MAAM,KAAN,MAAM,QA0CtB"}
+{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAI3D,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AA6I1C,MAAM,KAAW,sBAAsB,CA0CtC;AA1CD,WAAiB,sBAAsB;IACrC;;OAEG;IACU,6BAAM,GAAG,KAAK,CAAC;AAsC9B,CAAC,EA1CgB,sBAAsB,KAAtB,sBAAsB,QA0CtC;AA4OD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,6BAA6B,GACxC,IAAI,KAAK,CACP,+CAA+C,CAChD,CAAC;AAEJ;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,KAAK,CACzC,oCAAoC,CACrC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,KAAK,CAChD,2CAA2C,CAC5C,CAAC;AAiBF;;;GAGG;AACH,MAAM,KAAW,MAAM,CA0CtB;AA1CD,WAAiB,MAAM;IACrB,2BAA2B;IAC3B,IAAY,kBAKX;IALD,WAAY,kBAAkB;QAC5B,6EAAuD,CAAA;QACvD,yDAAmC,CAAA;QACnC,8CAAwB,CAAA;QACxB,uDAAiC,CAAA;IACnC,CAAC,EALW,kBAAkB,GAAlB,yBAAkB,KAAlB,yBAAkB,QAK7B;IAED,2BAA2B;IAC3B,IAAY,kBAOX;IAPD,WAAY,kBAAkB;QAC5B,2DAAqC,CAAA;QACrC,mFAA6D,CAAA;QAC7D,uDAAiC,CAAA;QACjC,uDAAiC,CAAA;QACjC,iDAA2B,CAAA;QAC3B,8CAAwB,CAAA;IAC1B,CAAC,EAPW,kBAAkB,GAAlB,yBAAkB,KAAlB,yBAAkB,QAO7B;IAED,sBAAsB;IACtB,IAAY,aAKX;IALD,WAAY,aAAa;QACvB,kEAAiD,CAAA;QACjD,mEAAkD,CAAA;QAClD,sEAAqD,CAAA;QACrD,oEAAmD,CAAA;IACrD,CAAC,EALW,aAAa,GAAb,oBAAa,KAAb,oBAAa,QAKxB;IAED,sBAAsB;IACtB,IAAY,aAaX;IAbD,WAAY,aAAa;QACvB,uDAAsC,CAAA;QACtC,mEAAkD,CAAA;QAClD,uDAAsC,CAAA;QACtC,sEAAqD,CAAA;QACrD,gEAA+C,CAAA;QAC/C,6CAA4B,CAAA;QAC5B,+DAA8C,CAAA;QAC9C,0CAAyB,CAAA;QACzB,uDAAsC,CAAA;QACtC,+CAA8B,CAAA;QAC9B,8DAA6C,CAAA;QAC7C,gEAA+C,CAAA;IACjD,CAAC,EAbW,aAAa,GAAb,oBAAa,KAAb,oBAAa,QAaxB;AACH,CAAC,EA1CgB,MAAM,KAAN,MAAM,QA0CtB"}

package/lib/utils.d.ts

@@ -1,7 +1,18 @@
 import { ReadonlyJSONObject, ReadonlyJSONValue } from '@lumino/coreutils';
+/**
+ * Helper to wait for timeout.
+ *
+ * @param  timeout - time out in ms
+ */
 export declare function sleep(timeout: number): Promise<void>;
+/**
+ * Wait for an event by pooling the `isReady` function.
+ */
 export declare function untilReady(isReady: CallableFunction, maxRetrials?: number, interval?: number, intervalModifier?: (i: number) => number): Promise<CallableFunction>;
-export declare const expandDottedPaths: (obj: ReadonlyJSONObject) => ReadonlyJSONObject;
+/**
+ * Convert dotted path into dictionary.
+ */
+export declare function expandDottedPaths(obj: ReadonlyJSONObject): ReadonlyJSONObject;
 /**
  * The docs for many language servers show settings in the
  * VSCode format, e.g.: "pyls.plugins.pyflakes.enabled"
@@ -10,6 +21,9 @@ export declare const expandDottedPaths: (obj: ReadonlyJSONObject) => ReadonlyJSO
  * as the language servers themselves don't accept that syntax.
  */
 export declare const expandPath: (path: string[], value: ReadonlyJSONValue) => ReadonlyJSONObject;
+/**
+ * An extended map which will create value for key on the fly.
+ */
 export declare class DefaultMap<K, V> extends Map<K, V> {
     private defaultFactory;
     constructor(defaultFactory: (...args: any[]) => V, entries?: ReadonlyArray<readonly [K, V]> | null);

package/lib/utils.js

@@ -1,4 +1,11 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
 import mergeWith from 'lodash.mergewith';
+/**
+ * Helper to wait for timeout.
+ *
+ * @param  timeout - time out in ms
+ */
 export async function sleep(timeout) {
     return new Promise(resolve => {
         setTimeout(() => {
@@ -6,6 +13,9 @@ export async function sleep(timeout) {
         }, timeout);
     });
 }
+/**
+ * Wait for an event by pooling the `isReady` function.
+ */
 export function untilReady(isReady, maxRetrials = 35, interval = 50, intervalModifier = (i) => i) {
     return (async () => {
         let i = 0;
@@ -20,14 +30,17 @@ export function untilReady(isReady, maxRetrials = 35, interval = 50, intervalMod
         return isReady;
     })();
 }
-export const expandDottedPaths = (obj) => {
+/**
+ * Convert dotted path into dictionary.
+ */
+export function expandDottedPaths(obj) {
     const settings = [];
     for (let key in obj) {
         const parsed = expandPath(key.split('.'), obj[key]);
         settings.push(parsed);
     }
     return mergeWith({}, ...settings);
-};
+}
 /**
  * The docs for many language servers show settings in the
  * VSCode format, e.g.: "pyls.plugins.pyflakes.enabled"
@@ -49,6 +62,9 @@ export const expandPath = (path, value) => {
     });
     return obj;
 };
+/**
+ * An extended map which will create value for key on the fly.
+ */
 export class DefaultMap extends Map {
     constructor(defaultFactory, entries) {
         super(entries);

package/lib/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,kBAAkB,CAAC;AACzC,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAAe;IACzC,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,CAAC;QACZ,CAAC,EAAE,OAAO,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,UAAU,CACxB,OAAyB,EACzB,cAAsB,EAAE,EACxB,QAAQ,GAAG,EAAE,EACb,mBAAmB,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC;IAEnC,OAAO,CAAC,KAAK,IAAI,EAAE;QACjB,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,OAAO,EAAE,KAAK,IAAI,EAAE;YACzB,CAAC,IAAI,CAAC,CAAC;YACP,IAAI,WAAW,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE;gBACzC,MAAM,KAAK,CAAC,mBAAmB,CAAC,CAAC;aAClC;YACD,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACtC,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;SACvB;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,EAAE,CAAC;AACP,CAAC;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAAuB,EACH,EAAE;IACtB,MAAM,QAAQ,GAAQ,EAAE,CAAC;IACzB,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE;QACnB,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KACvB;IACD,OAAO,SAAS,CAAC,EAAE,EAAE,GAAG,QAAQ,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,IAAc,EACd,KAAwB,EACJ,EAAE;IACtB,MAAM,GAAG,GAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAErC,IAAI,IAAI,GAAG,GAAG,CAAC;IACf,IAAI,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,CAAM,EAAE,EAAE;QACpC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEjC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;SACpB;aAAM;YACL,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF,MAAM,OAAO,UAAiB,SAAQ,GAAS;IAC7C,YACU,cAAqC,EAC7C,OAA+C;QAE/C,KAAK,CAAC,OAAO,CAAC,CAAC;QAHP,mBAAc,GAAd,cAAc,CAAuB;IAI/C,CAAC;IAED,GAAG,CAAC,CAAI;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,WAAW,CAAC,CAAI,EAAE,GAAG,IAAW;QAC9B,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACf,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAE,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACf,OAAO,CAAC,CAAC;SACV;IACH,CAAC;CACF"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAG3D,OAAO,SAAS,MAAM,kBAAkB,CAAC;AAEzC;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,OAAe;IACzC,OAAO,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;QACjC,UAAU,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,CAAC;QACZ,CAAC,EAAE,OAAO,CAAC,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CACxB,OAAyB,EACzB,cAAsB,EAAE,EACxB,QAAQ,GAAG,EAAE,EACb,mBAAmB,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC;IAEnC,OAAO,CAAC,KAAK,IAAI,EAAE;QACjB,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,OAAO,OAAO,EAAE,KAAK,IAAI,EAAE;YACzB,CAAC,IAAI,CAAC,CAAC;YACP,IAAI,WAAW,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,WAAW,EAAE;gBACzC,MAAM,KAAK,CAAC,mBAAmB,CAAC,CAAC;aAClC;YACD,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC;YACtC,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;SACvB;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,EAAE,CAAC;AACP,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAuB;IACvD,MAAM,QAAQ,GAAQ,EAAE,CAAC;IACzB,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE;QACnB,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACpD,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KACvB;IACD,OAAO,SAAS,CAAC,EAAE,EAAE,GAAG,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,IAAc,EACd,KAAwB,EACJ,EAAE;IACtB,MAAM,GAAG,GAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAErC,IAAI,IAAI,GAAG,GAAG,CAAC;IACf,IAAI,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,CAAM,EAAE,EAAE;QACpC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEjC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;SACpB;aAAM;YACL,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;SACnB;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,UAAiB,SAAQ,GAAS;IAC7C,YACU,cAAqC,EAC7C,OAA+C;QAE/C,KAAK,CAAC,OAAO,CAAC,CAAC;QAHP,mBAAc,GAAd,cAAc,CAAuB;IAI/C,CAAC;IAED,GAAG,CAAC,CAAI;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAC7B,CAAC;IAED,WAAW,CAAC,CAAI,EAAE,GAAG,IAAW;QAC9B,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACf,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAE,CAAC;SACtB;aAAM;YACL,IAAI,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;YACxC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YACf,OAAO,CAAC,CAAC;SACV;IACH,CAAC;CACF"}