vscode-languageserver-protocol - npm Package Compare versions

Comparing version 3.17.0-next.13 to 3.17.0-next.14

lib/common/api.d.ts

@@ -126,2 +126,6 @@ import type { integer } from 'vscode-languageserver-types';
     const DidCloseNotebookDocumentNotification: typeof nb.DidCloseNotebookDocumentNotification;
+    type NotebookController = nb.NotebookController;
+    const NotebookController: typeof nb.NotebookController;
+    type DidSelectNotebookControllerParams = nb.DidSelectNotebookControllerParams;
+    const DidSelectNotebookControllerNotification: typeof nb.DidSelectNotebookControllerNotification;
 }

lib/common/api.js

@@ -98,3 +98,5 @@ "use strict";
     Proposed.DidCloseNotebookDocumentNotification = nb.DidCloseNotebookDocumentNotification;
+    Proposed.NotebookController = nb.NotebookController;
+    Proposed.DidSelectNotebookControllerNotification = nb.DidSelectNotebookControllerNotification;
 })(Proposed = exports.Proposed || (exports.Proposed = {}));
 //# sourceMappingURL=api.js.map

lib/common/proposed.notebooks.d.ts

@@ -17,2 +17,6 @@ import { URI, integer, DocumentUri, uinteger, LSPObject, TextDocumentItem, TextDocumentIdentifier, VersionedTextDocumentIdentifier } from 'vscode-languageserver-types';
     dynamicRegistration?: boolean;
+    /**
+     * The client supports sending execution summary data per cell.
+     */
+    executionSummarySupport?: boolean;
 }
@@ -41,2 +45,20 @@ export interface $NotebookDocumentClientCapabilities {
 export declare type NotebookCellKind = 1 | 2;
+export declare type ExecutionSummary = {
+    /**
+     * A strict monotonically increasing value
+     * indicating the execution order of a cell
+     * inside a notebook.
+     */
+    executionOrder: uinteger;
+    /**
+     * Whether the execution was successful or
+     * not if known by the client.
+     */
+    success?: boolean;
+};
+export declare namespace ExecutionSummary {
+    function create(executionOrder: number, success?: boolean): ExecutionSummary;
+    function is(value: any): value is ExecutionSummary;
+    function equals(one: ExecutionSummary | undefined, other: ExecutionSummary | undefined): boolean;
+}
 /**
@@ -65,2 +87,7 @@ * A notebook cell.
     metadata?: LSPObject;
+    /**
+     * Additional execution summary information
+     * if supported by the client.
+     */
+    executionSummary?: ExecutionSummary;
 }
@@ -71,2 +98,3 @@ export declare namespace NotebookCell {
     function equals(one: NotebookCell, other: NotebookCell, compareMetaData?: boolean): boolean;
+    function diff(one: NotebookCell, two: NotebookCell): Set<keyof NotebookCell>;
 }
@@ -257,31 +285,36 @@ /**
     /**
-     * Changes to the cell structure to add or
-     * remove cells.
+     * Changes to cells
      */
-    cellStructure?: {
+    cells?: {
         /**
-         * The change to the cell array.
+         * Changes to the cell structure to add or
+         * remove cells.
          */
-        array: NotebookCellArrayChange;
+        structure?: {
+            /**
+             * The change to the cell array.
+             */
+            array: NotebookCellArrayChange;
+            /**
+             * Additional opened cell text documents.
+             */
+            didOpen?: TextDocumentItem[];
+            /**
+             * Additional closed cell text documents.
+             */
+            didClose?: TextDocumentIdentifier[];
+        };
         /**
-         * Additional opened cell text documents.
+         * Changes to notebook cells properties like its
+         * kind, execution summary or metadata.
          */
-        didOpen?: TextDocumentItem[];
+        data?: NotebookCell[];
         /**
-         * Additional closed cell text documents.
+         * Changes to the text content of notebook cells.
          */
-        didClose?: TextDocumentIdentifier[];
+        textContent?: {
+            document: VersionedTextDocumentIdentifier;
+            changes: TextDocumentContentChangeEvent[];
+        }[];
     };
-    /**
-     * Changes to notebook cells properties like its
-     * kind or metadata.
-     */
-    cellData?: NotebookCell[];
-    /**
-     * Changes to the text content of notebook cells.
-     */
-    cellTextDocuments?: {
-        textDocument: VersionedTextDocumentIdentifier;
-        contentChanges: TextDocumentContentChangeEvent[];
-    }[];
 }
@@ -367,1 +400,50 @@ /**
 }
+/**
+ * A notebook controller represents an entity that can execute
+ * notebook cells. This is often referred to as a kernel.
+ *
+ * There can be multiple controllers and the editor will let
+ * users choose which controller to use for a certain notebook.
+ */
+export interface NotebookController {
+    /**
+     * The identifier of this notebook controller.
+     *
+     * _Note_ that controllers are usually remembered
+     * by their identifier and that clients should use
+     * stable identifiers.
+     */
+    id: string;
+    /**
+     * Additional metadata associated with
+     * this controller.
+     */
+    metadata?: LSPObject;
+}
+export declare namespace NotebookController {
+    function create(id: string, metadata?: LSPObject): NotebookController;
+    function is(value: any): value is NotebookController;
+}
+export interface DidSelectNotebookControllerParams {
+    /**
+     * The notebook document
+     */
+    notebookDocument: NotebookDocumentIdentifier;
+    /**
+     * The selected controller
+     */
+    controller: NotebookController;
+    /**
+     * Whether the controller has been selected
+     * or unselected.
+     */
+    selected: boolean;
+}
+/**
+ * A notification send when a controller got selected
+ * for a specific notebook.
+ */
+export declare namespace DidSelectNotebookControllerNotification {
+    const method: 'notebookDocument/didSelectNotebookController';
+    const type: ProtocolNotificationType<DidSelectNotebookControllerParams, void>;
+}

lib/common/proposed.notebooks.js

@@ -7,3 +7,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DidCloseNotebookDocumentNotification = exports.DidSaveNotebookDocumentNotification = exports.DidChangeNotebookDocumentNotification = exports.NotebookCellArrayChange = exports.DidOpenNotebookDocumentNotification = exports.NotebookDocumentSyncRegistrationType = exports.NotebookDocument = exports.NotebookCell = exports.NotebookCellKind = void 0;
+exports.DidSelectNotebookControllerNotification = exports.NotebookController = exports.DidCloseNotebookDocumentNotification = exports.DidSaveNotebookDocumentNotification = exports.DidChangeNotebookDocumentNotification = exports.NotebookCellArrayChange = exports.DidOpenNotebookDocumentNotification = exports.NotebookDocumentSyncRegistrationType = exports.NotebookDocument = exports.NotebookCell = exports.ExecutionSummary = exports.NotebookCellKind = void 0;
 const vscode_languageserver_types_1 = require("vscode-languageserver-types");
@@ -32,2 +32,28 @@ const Is = require("./utils/is");
 })(NotebookCellKind = exports.NotebookCellKind || (exports.NotebookCellKind = {}));
+var ExecutionSummary;
+(function (ExecutionSummary) {
+    function create(executionOrder, success) {
+        const result = { executionOrder };
+        if (success === true || success === false) {
+            result.success = success;
+        }
+        return result;
+    }
+    ExecutionSummary.create = create;
+    function is(value) {
+        const candidate = value;
+        return Is.objectLiteral(candidate) && vscode_languageserver_types_1.uinteger.is(candidate.executionOrder) && (candidate.success === undefined || Is.boolean(candidate.success));
+    }
+    ExecutionSummary.is = is;
+    function equals(one, other) {
+        if (one === other) {
+            return true;
+        }
+        if (one === null || one === undefined || other === null || other === undefined) {
+            return false;
+        }
+        return one.executionOrder === other.executionOrder && one.success === other.success;
+    }
+    ExecutionSummary.equals = equals;
+})(ExecutionSummary = exports.ExecutionSummary || (exports.ExecutionSummary = {}));
 var NotebookCell;
@@ -45,3 +71,3 @@ (function (NotebookCell) {
     NotebookCell.is = is;
-    function equals(one, other, compareMetaData = false) {
+    function equals(one, other, compareMetaData = true) {
         if (one.kind !== other.kind || one.document !== other.document) {
@@ -101,2 +127,22 @@ return false;
     }
+    function diff(one, two) {
+        const result = new Set();
+        if (one.document !== two.document) {
+            result.add('document');
+        }
+        if (one.kind !== two.kind) {
+            result.add('kind');
+        }
+        if (one.executionSummary !== two.executionSummary) {
+            result.add('executionSummary');
+        }
+        if ((one.metadata !== undefined || two.metadata !== undefined) && !equalsMetadata(one.metadata, two.metadata)) {
+            result.add('metadata');
+        }
+        if ((one.executionSummary !== undefined || two.executionSummary !== undefined) && !ExecutionSummary.equals(one.executionSummary, two.executionSummary)) {
+            result.add('executionSummary');
+        }
+        return result;
+    }
+    NotebookCell.diff = diff;
 })(NotebookCell = exports.NotebookCell || (exports.NotebookCell = {}));
@@ -171,2 +217,27 @@ var NotebookDocument;
 })(DidCloseNotebookDocumentNotification = exports.DidCloseNotebookDocumentNotification || (exports.DidCloseNotebookDocumentNotification = {}));
+var NotebookController;
+(function (NotebookController) {
+    function create(id, metadata) {
+        const result = { id };
+        if (metadata !== undefined) {
+            result.metadata = metadata;
+        }
+        return result;
+    }
+    NotebookController.create = create;
+    function is(value) {
+        const candidate = value;
+        return Is.objectLiteral(candidate) && Is.string(candidate.id) && (candidate.metadata === undefined || Is.objectLiteral(candidate.metadata));
+    }
+    NotebookController.is = is;
+})(NotebookController = exports.NotebookController || (exports.NotebookController = {}));
+/**
+ * A notification send when a controller got selected
+ * for a specific notebook.
+ */
+var DidSelectNotebookControllerNotification;
+(function (DidSelectNotebookControllerNotification) {
+    DidSelectNotebookControllerNotification.method = 'notebookDocument/didSelectNotebookController';
+    DidSelectNotebookControllerNotification.type = new messages_1.ProtocolNotificationType(DidSelectNotebookControllerNotification.method);
+})(DidSelectNotebookControllerNotification = exports.DidSelectNotebookControllerNotification || (exports.DidSelectNotebookControllerNotification = {}));
 //# sourceMappingURL=proposed.notebooks.js.map

package.json

 {
 	"name": "vscode-languageserver-protocol",
 	"description": "VSCode Language Server Protocol implementation",
-	"version": "3.17.0-next.13",
+	"version": "3.17.0-next.14",
 	"author": "Microsoft Corporation",
@@ -6,0 +6,0 @@ "license": "MIT",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

308729

increased by2.04%

Lines of code

7552

increased by2.15%

No dependency changes