@difizen/libro-lsp 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Difizen Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/es/adapters/adapter.d.ts

@@ -0,0 +1,255 @@
+import type { NotebookView } from '@difizen/libro-core';
+import { Emitter } from '@difizen/mana-app';
+import type { Disposable, Event, View } from '@difizen/mana-app';
+import type { LanguageIdentifier } from '../lsp.js';
+import type { IVirtualPosition } from '../positioning.js';
+import type { Document, IDocumentConnectionData, ILSPCodeExtractorsManager, ILSPDocumentConnectionManager, ILSPFeatureManager } from '../tokens.js';
+import type { VirtualDocument } from '../virtual/document.js';
+export interface IEditorChangedData {
+    /**
+     * The CM editor invoking the change event.
+     */
+    editor: Document.IEditor;
+}
+export interface IAdapterOptions {
+    /**
+     * The LSP document and connection manager instance.
+     */
+    connectionManager: ILSPDocumentConnectionManager;
+    /**
+     * The LSP feature manager instance.
+     */
+    featureManager: ILSPFeatureManager;
+    /**
+     * The LSP foreign code extractor manager.
+     */
+    foreignCodeExtractorsManager: ILSPCodeExtractorsManager;
+}
+/**
+ * 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 WidgetLSPAdapter<T extends NotebookView> implements Disposable {
+    widget: T;
+    protected options: IAdapterOptions;
+    constructor(widget: T, options: IAdapterOptions);
+    /**
+     * Check if the adapter is disposed
+     */
+    get disposed(): boolean;
+    /**
+     * Check if the document contains multiple editors
+     */
+    get hasMultipleEditors(): boolean;
+    /**
+     * Get the ID of the internal widget.
+     */
+    get widgetId(): string;
+    /**
+     * Get the language identifier of the document
+     */
+    get language(): LanguageIdentifier;
+    /**
+     * Signal emitted when the adapter is connected.
+     */
+    get adapterConnected(): Event<IDocumentConnectionData>;
+    /**
+     * Signal emitted when the active editor have changed.
+     */
+    get activeEditorChanged(): Event<IEditorChangedData>;
+    /**
+     * Signal emitted when the adapter is disposed.
+     */
+    get onDispose(): Event<void>;
+    /**
+     * Signal emitted when the an editor is changed.
+     */
+    get editorAdded(): Event<IEditorChangedData>;
+    /**
+     * Signal emitted when the an editor is removed.
+     */
+    get editorRemoved(): Event<IEditorChangedData>;
+    /**
+     * Get the inner HTMLElement of the document widget.
+     */
+    abstract get wrapperElement(): HTMLElement;
+    /**
+     * Get current path of the document.
+     */
+    abstract get documentPath(): string;
+    /**
+     * Get the mime type of the document.
+     */
+    abstract get mimeType(): string;
+    /**
+     * Get the file extension of the document.
+     */
+    abstract get languageFileExtension(): string | undefined;
+    /**
+     * Get the activated CM editor.
+     */
+    abstract get activeEditor(): Document.IEditor | undefined;
+    /**
+     * Get the list of CM editors in the document, there is only one editor
+     * in the case of file editor.
+     */
+    abstract get editors(): Document.ICodeBlockOptions[];
+    /**
+     * Promise that resolves once the adapter is initialized
+     */
+    abstract get ready(): Promise<void>;
+    /**
+     * The virtual document is connected or not
+     */
+    get isConnected(): boolean;
+    /**
+     * The LSP document and connection manager instance.
+     */
+    get connectionManager(): ILSPDocumentConnectionManager;
+    /**
+     * Promise that resolves once the document is updated
+     */
+    get updateFinished(): Promise<void>;
+    /**
+     * Internal virtual document of the adapter.
+     */
+    get virtualDocument(): VirtualDocument | null;
+    /**
+     * Callback on connection closed event.
+     */
+    onConnectionClosed(_: ILSPDocumentConnectionManager, { virtualDocument }: IDocumentConnectionData): void;
+    /**
+     * Dispose the adapter.
+     */
+    dispose(): void;
+    /**
+     * Disconnect virtual document from the language server.
+     */
+    disconnect(): void;
+    /**
+     * Update the virtual document.
+     */
+    updateDocuments(): Promise<void>;
+    /**
+     * Callback called on the document changed event.
+     */
+    documentChanged(virtualDocument: VirtualDocument): void;
+    /**
+     * (re)create virtual document using current path and language
+     */
+    protected abstract createVirtualDocument(): VirtualDocument;
+    /**
+     * Get the index of editor from the cursor position in the virtual
+     * document. Since there is only one editor, this method always return
+     * 0
+     *
+     * @param position - the position of cursor in the virtual document.
+     * @return - index of the virtual editor
+     */
+    abstract getEditorIndexAt(position: IVirtualPosition): number;
+    /**
+     * Get the index of input editor
+     *
+     * @param ceEditor - instance of the code editor
+     */
+    abstract getEditorIndex(ceEditor: Document.IEditor): number;
+    /**
+     * Get the index of input editor
+     *
+     * @param ceEditor - instance of the code editor
+     */
+    abstract getCellEditor(cell: View): Document.IEditor | undefined;
+    /**
+     * Get the wrapper of input editor.
+     *
+     * @param ceEditor
+     */
+    abstract getEditorWrapper(ceEditor: Document.IEditor): HTMLElement | undefined;
+    protected reloadConnection(): void;
+    /**
+     * Callback on document saved event.
+     */
+    protected onSaveState: () => void;
+    /**
+     * Connect the virtual document with the language server.
+     */
+    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>;
+    /**
+     * Create the virtual document using current path and language.
+     */
+    protected initVirtual(): void;
+    /**
+     * 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(context: Document.IForeignContext): Promise<void>;
+    /**
+     * Signal emitted when the adapter is connected.
+     */
+    protected _adapterConnected: Emitter<IDocumentConnectionData>;
+    /**
+     * Signal emitted when the active editor have changed.
+     */
+    protected _activeEditorChanged: Emitter<IEditorChangedData>;
+    /**
+     * Signal emitted when an editor is changed.
+     */
+    protected _editorAdded: Emitter<IEditorChangedData>;
+    /**
+     * Signal emitted when an editor is removed.
+     */
+    protected _editorRemoved: Emitter<IEditorChangedData>;
+    /**
+     * Signal emitted when the adapter is disposed.
+     */
+    protected _disposed: Emitter<void>;
+    protected _isDisposed: boolean;
+    protected readonly _connectionManager: ILSPDocumentConnectionManager;
+    protected _isConnected: boolean;
+    protected _updateFinished: Promise<void>;
+    protected _virtualDocument: VirtualDocument | null;
+    /**
+     * Callback called when a foreign document is closed,
+     * the associated signals with this virtual document
+     * are disconnected.
+     */
+    protected _onForeignDocumentClosed(context: Document.IForeignContext): void;
+    /**
+     * Detect the capabilities for the document type then
+     * open the websocket connection with the language server.
+     */
+    protected _connect(virtualDocument: VirtualDocument): Promise<{
+        connection: import("../tokens.js").ILSPConnection;
+        virtualDocument: VirtualDocument;
+    } | undefined>;
+    /**
+     * Handle content changes and update all virtual documents after a change.
+     *
+     * #### Notes
+     * 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 signal is watched instead.
+     *
+     * While by not using the change event of CodeMirror editors we lose 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
+     * more resilient and editor-independent.
+     */
+    protected _onContentChanged(): Promise<void>;
+}
+//# sourceMappingURL=adapter.d.ts.map

package/es/adapters/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/adapters/adapter.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAIjE,OAAO,KAAK,EAAsB,kBAAkB,EAAE,MAAM,WAAW,CAAC;AACxE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,KAAK,EACV,QAAQ,EACR,uBAAuB,EACvB,yBAAyB,EACzB,6BAA6B,EAC7B,kBAAkB,EAEnB,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAY9D,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,iBAAiB,EAAE,6BAA6B,CAAC;IAEjD;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAC;IAEnC;;OAEG;IACH,4BAA4B,EAAE,yBAAyB,CAAC;CACzD;AAED;;;;;GAKG;AACH,8BAAsB,gBAAgB,CAAC,CAAC,SAAS,YAAY,CAAE,YAAW,UAAU;IAKzE,MAAM,EAAE,CAAC;IAChB,SAAS,CAAC,OAAO,EAAE,eAAe;gBAD3B,MAAM,EAAE,CAAC,EACN,OAAO,EAAE,eAAe;IAWpC;;OAEG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IACD;;OAEG;IACH,IAAI,kBAAkB,IAAI,OAAO,CAEhC;IACD;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,kBAAkB,CAkBjC;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAErD;IAED;;OAEG;IACH,IAAI,mBAAmB,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAEnD;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,CAE3B;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAE3C;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAE7C;IAED;;OAEG;IACH,QAAQ,KAAK,cAAc,IAAI,WAAW,CAAC;IAE3C;;OAEG;IACH,QAAQ,KAAK,YAAY,IAAI,MAAM,CAAC;IAEpC;;OAEG;IACH,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC;IAEhC;;OAEG;IACH,QAAQ,KAAK,qBAAqB,IAAI,MAAM,GAAG,SAAS,CAAC;IAEzD;;OAEG;IACH,QAAQ,KAAK,YAAY,IAAI,QAAQ,CAAC,OAAO,GAAG,SAAS,CAAC;IAE1D;;;OAGG;IACH,QAAQ,KAAK,OAAO,IAAI,QAAQ,CAAC,iBAAiB,EAAE,CAAC;IAErD;;OAEG;IACH,QAAQ,KAAK,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;OAEG;IACH,IAAI,iBAAiB,IAAI,6BAA6B,CAErD;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAElC;IAED;;OAEG;IACH,IAAI,eAAe,IAAI,eAAe,GAAG,IAAI,CAE5C;IAED;;OAEG;IACH,kBAAkB,CAChB,CAAC,EAAE,6BAA6B,EAChC,EAAE,eAAe,EAAE,EAAE,uBAAuB,GAC3C,IAAI;IAMP;;OAEG;IACH,OAAO,IAAI,IAAI;IAUf;;OAEG;IACH,UAAU,IAAI,IAAI;IAiBlB;;OAEG;IACH,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAQhC;;OAEG;IACH,eAAe,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IAiBvD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,qBAAqB,IAAI,eAAe;IAE3D;;;;;;;OAOG;IACH,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,MAAM;IAE7D;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,GAAG,MAAM;IAE3D;;;;OAIG;IACH,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,CAAC,OAAO,GAAG,SAAS;IAEhE;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,GAAG,WAAW,GAAG,SAAS;IAI9E,SAAS,CAAC,gBAAgB,IAAI,IAAI;IAmBlC;;OAEG;IACH,SAAS,CAAC,WAAW,QAAO,IAAI,CAkB9B;IAEF;;OAEG;cACa,WAAW,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmEzE;;;;;;;OAOG;cACa,eAAe,CAC7B,eAAe,EAAE,eAAe,EAChC,QAAQ,UAAQ,GACf,OAAO,CAAC,IAAI,CAAC;IAYhB;;OAEG;IACH,SAAS,CAAC,WAAW,IAAI,IAAI;IAO7B;;;;;;;OAOG;cACa,uBAAuB,CACrC,OAAO,EAAE,QAAQ,CAAC,eAAe,GAChC,OAAO,CAAC,IAAI,CAAC;IAQhB;;OAEG;IACH,SAAS,CAAC,iBAAiB,mCAA0C;IAErE;;OAEG;IACH,SAAS,CAAC,oBAAoB,8BAAqC;IAEnE;;OAEG;IACH,SAAS,CAAC,YAAY,8BAAqC;IAE3D;;OAEG;IACH,SAAS,CAAC,cAAc,8BAAqC;IAE7D;;OAEG;IACH,SAAS,CAAC,SAAS,gBAAuB;IAE1C,SAAS,CAAC,WAAW,UAAS;IAE9B,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,6BAA6B,CAAC;IAErE,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC;IAChC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,SAAS,CAAC,gBAAgB,EAAE,eAAe,GAAG,IAAI,CAAQ;IAE1D;;;;OAIG;IACH,SAAS,CAAC,wBAAwB,CAAC,OAAO,EAAE,QAAQ,CAAC,eAAe,GAAG,IAAI;IAI3E;;;OAGG;cACa,QAAQ,CAAC,eAAe,EAAE,eAAe;;;;IA4CzD;;;;;;;;;;;;OAYG;cACa,iBAAiB;CAWlC"}