vscode-languageserver-protocol 3.17.0-next.12 → 3.17.0-next.13

package/lib/common/api.d.ts

@@ -101,24 +101,26 @@ export declare namespace Proposed {
     const InlineValuesRefreshRequest: typeof iv.InlineValuesRefreshRequest;
     type $NotebookDocumentClientCapabilities = nb.$NotebookDocumentClientCapabilities;
     type NotebookDocumentSyncClientCapabilities = nb.NotebookDocumentSyncClientCapabilities;
-    type $NotebookDocumentServerCapabilities = nb.$NotebookDocumentServerCapabilities;
+    type $NotebookDocumentSyncServerCapabilities = nb.$NotebookDocumentSyncServerCapabilities;
     type NotebookCellKind = nb.NotebookCellKind;
     const NotebookCellKind: typeof nb.NotebookCellKind;
     type NotebookCell = nb.NotebookCell;
     const NotebookCell: typeof nb.NotebookCell;
-    type NotebookCellChange = nb.NotebookCellChange;
+    type NotebookCellArrayChange = nb.NotebookCellArrayChange;
     type NotebookDocument = nb.NotebookDocument;
     const NotebookDocument: typeof nb.NotebookDocument;
     type NotebookDocumentChangeEvent = nb.NotebookDocumentChangeEvent;
     type NotebookDocumentIdentifier = nb.NotebookDocumentIdentifier;
     type VersionedNotebookDocumentIdentifier = nb.VersionedNotebookDocumentIdentifier;
-    type NotebookDocumentOptions = nb.NotebookDocumentOptions;
-    type NotebookDocumentRegistrationOptions = nb.NotebookDocumentRegistrationOptions;
+    type NotebookDocumentSyncOptions = nb.NotebookDocumentSyncOptions;
+    type NotebookDocumentSyncRegistrationOptions = nb.NotebookDocumentSyncRegistrationOptions;
     const NotebookDocumentSyncRegistrationType: typeof nb.NotebookDocumentSyncRegistrationType;
     type DidOpenNotebookDocumentParams = nb.DidOpenNotebookDocumentParams;
     const DidOpenNotebookDocumentNotification: typeof nb.DidOpenNotebookDocumentNotification;
     type DidChangeNotebookDocumentParams = nb.DidChangeNotebookDocumentParams;
     const DidChangeNotebookDocumentNotification: typeof nb.DidChangeNotebookDocumentNotification;
+    type DidSaveNotebookDocumentParams = nb.DidSaveNotebookDocumentParams;
+    const DidSaveNotebookDocumentNotification: typeof nb.DidSaveNotebookDocumentNotification;
     type DidCloseNotebookDocumentParams = nb.DidCloseNotebookDocumentParams;
     const DidCloseNotebookDocumentNotification: typeof nb.DidCloseNotebookDocumentNotification;
 }

package/lib/common/api.js

@@ -93,6 +93,7 @@ var Proposed;
     Proposed.NotebookDocumentSyncRegistrationType = nb.NotebookDocumentSyncRegistrationType;
     Proposed.DidOpenNotebookDocumentNotification = nb.DidOpenNotebookDocumentNotification;
     Proposed.DidChangeNotebookDocumentNotification = nb.DidChangeNotebookDocumentNotification;
+    Proposed.DidSaveNotebookDocumentNotification = nb.DidSaveNotebookDocumentNotification;
     Proposed.DidCloseNotebookDocumentNotification = nb.DidCloseNotebookDocumentNotification;
 })(Proposed = exports.Proposed || (exports.Proposed = {}));
 //# sourceMappingURL=api.js.map

package/lib/common/proposed.notebooks.d.ts

@@ -1,6 +1,6 @@
-import { URI, integer, DocumentUri, uinteger } from 'vscode-languageserver-types';
+import { URI, integer, DocumentUri, uinteger, LSPObject, TextDocumentItem, TextDocumentIdentifier, VersionedTextDocumentIdentifier } from 'vscode-languageserver-types';
 import { ProtocolNotificationType, RegistrationType } from './messages';
-import { StaticRegistrationOptions, NotebookDocumentFilter } from './protocol';
+import { StaticRegistrationOptions, NotebookDocumentFilter, TextDocumentContentChangeEvent } from './protocol';
 /**
  * Notebook specific client capabilities.
  *
@@ -40,6 +40,10 @@ export declare type NotebookCellKind = 1 | 2;
 /**
  * A notebook cell.
  *
+ * A cell's document URI must be unique across ALL notebook
+ * cells and can therefore be used to uniquely identify a
+ * notebook cell or the cell's text document.
+ *
  * @since 3.17.0 - proposed state
  */
 export interface NotebookCell {
@@ -48,40 +52,19 @@ export interface NotebookCell {
      */
     kind: NotebookCellKind;
     /**
-     * The cell's text represented as a text document.
-     * The document's content is synced using the
-     * existing text document sync notifications.
+     * The URI of the cell's text document
+     * content.
      */
     document: DocumentUri;
+    /**
+     * Additional metadata stored with the cell.
+     */
+    metadata?: LSPObject;
 }
 export declare namespace NotebookCell {
     function create(kind: NotebookCellKind, document: DocumentUri): NotebookCell;
     function is(value: any): value is NotebookCell;
-    function equal(one: NotebookCell, two: NotebookCell): boolean;
-}
-/**
- * A change describing how to move a `NotebookCell`
- * array from state S' to S''.
- *
- * @since 3.17.0 - proposed state
- */
-export interface NotebookCellChange {
-    /**
-     * The start oftest of the cell that changed.
-     */
-    start: uinteger;
-    /**
-     * The deleted cells
-     */
-    deleteCount: uinteger;
-    /**
-     * The new cells, if any
-     */
-    cells?: NotebookCell[];
-}
-export declare namespace NotebookCellChange {
-    function is(value: any): value is NotebookCellChange;
-    function create(start: uinteger, deleteCount: uinteger, cells?: NotebookCell[]): NotebookCellChange;
+    function equals(one: NotebookCell, other: NotebookCell, compareMetaData?: boolean): boolean;
 }
 /**
  * A notebook document.
@@ -102,6 +85,11 @@ export interface NotebookDocument {
      * change, including undo/redo).
      */
     version: integer;
+    /**
+     * Additional metadata stored with the notebook
+     * document.
+     */
+    metadata?: LSPObject;
     /**
      * The cells of a notebook.
      */
@@ -141,7 +129,7 @@ export interface VersionedNotebookDocumentIdentifier {
  * Options specific to a notebook plus its cells
  * to be synced to the server.
  *
- * If a selector provider a notebook document
+ * If a selector provide a notebook document
  * filter but no cell selector all cells of a
  * matching notebook document will be synced.
  *
@@ -152,8 +140,11 @@ export interface VersionedNotebookDocumentIdentifier {
  *
  * @since 3.17.0 - proposed state
  */
-export declare type NotebookDocumentOptions = {
-    notebookDocumentSelector?: ({
+export declare type NotebookDocumentSyncOptions = {
+    /**
+     * The notebook document to be synced
+     */
+    notebookDocumentSelector: ({
         /** The notebook documents to be synced */
         notebookDocumentFilter: NotebookDocumentFilter;
         /** The cells of the matching notebook to be synced */
@@ -168,19 +159,36 @@ export declare type NotebookDocumentOptions = {
             language: string;
         }[];
     })[];
+    /**
+     * Determines how the notebook is synchronized.
+     *
+     * If set to 'notebook' the notebook document,
+     * its meta data, cell structure and the cell's
+     * text documents are synchronized.
+     *
+     * If set to 'cellContent' only the cell content
+     * is synchronized using the available
+     * `textDocument/did*` notifications.
+     */
+    mode: 'notebook' | 'cellContent';
+    /**
+     * Whether save notification should be forwarded to
+     * the server. Will only be honored if mode === `notebook`.
+     */
+    save?: boolean;
 };
-export interface $NotebookDocumentServerCapabilities {
-    notebookDocumentSync?: NotebookDocumentOptions | NotebookDocumentRegistrationOptions;
-}
 /**
  * Registration options specific to a notebook.
  *
  * @since 3.17.0 - proposed state
  */
-export declare type NotebookDocumentRegistrationOptions = NotebookDocumentOptions & StaticRegistrationOptions;
+export declare type NotebookDocumentSyncRegistrationOptions = NotebookDocumentSyncOptions & StaticRegistrationOptions;
+export interface $NotebookDocumentSyncServerCapabilities {
+    notebookDocumentSync?: NotebookDocumentSyncOptions | NotebookDocumentSyncRegistrationOptions;
+}
 export declare namespace NotebookDocumentSyncRegistrationType {
     const method: 'notebookDocument/sync';
-    const type: RegistrationType<NotebookDocumentRegistrationOptions>;
+    const type: RegistrationType<NotebookDocumentSyncRegistrationOptions>;
 }
 /**
  * The params sent in a open notebook document notification.
@@ -192,6 +200,11 @@ export interface DidOpenNotebookDocumentParams {
      * The notebook document that got opened.
      */
     notebookDocument: NotebookDocument;
+    /**
+     * The text documents that represent the content
+     * of a notebook cell.
+     */
+    cellTextDocuments: TextDocumentItem[];
 }
 /**
  * A notification sent when a notebook opens.
@@ -202,13 +215,82 @@ export declare namespace DidOpenNotebookDocumentNotification {
     const method: 'notebookDocument/didOpen';
     const type: ProtocolNotificationType<DidOpenNotebookDocumentParams, void>;
 }
+/**
+ * A change describing how to move a `NotebookCell`
+ * array from state S to S'.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface NotebookCellArrayChange {
+    /**
+     * The start oftest of the cell that changed.
+     */
+    start: uinteger;
+    /**
+     * The deleted cells
+     */
+    deleteCount: uinteger;
+    /**
+     * The new cells, if any
+     */
+    cells?: NotebookCell[];
+}
+export declare namespace NotebookCellArrayChange {
+    function is(value: any): value is NotebookCellArrayChange;
+    function create(start: uinteger, deleteCount: uinteger, cells?: NotebookCell[]): NotebookCellArrayChange;
+}
+/**
+ * A change event for a notebook document.
+ *
+ * @since 3.17.0 - proposed state
+ */
 export interface NotebookDocumentChangeEvent {
-    cells: NotebookCellChange;
+    /**
+     * The changed meta data if any.
+     */
+    metadata?: LSPObject;
+    /**
+     * Changes to the cell structure to add or
+     * remove cells.
+     */
+    cellStructure?: {
+        /**
+         * The change to the cell array.
+         */
+        array: NotebookCellArrayChange;
+        /**
+         * Additional opened cell text documents.
+         */
+        didOpen?: TextDocumentItem[];
+        /**
+         * Additional closed cell text documents.
+         */
+        didClose?: TextDocumentIdentifier[];
+    };
+    /**
+     * 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[];
+    }[];
 }
+/**
+ * The params sent in a change notebook document notification.
+ *
+ * @since 3.17.0 - proposed state
+ */
 export interface DidChangeNotebookDocumentParams {
     /**
      * The notebook document that did change. The version number points
-     * to the version after all provided changes have been applied.
+     * to the version after all provided changes have been applied. If
+     * only the text document content of a cell changes the notebook version
+     * doesn't necessarily have to change.
      */
     notebookDocument: VersionedNotebookDocumentIdentifier;
     /**
@@ -226,12 +308,32 @@ export interface DidChangeNotebookDocumentParams {
      * - apply the `NotebookChangeEvent`s in a single notification in the order
      *   you receive them.
      */
-    changes: NotebookDocumentChangeEvent[];
+    change: NotebookDocumentChangeEvent;
 }
 export declare namespace DidChangeNotebookDocumentNotification {
     const method: 'notebookDocument/didChange';
     const type: ProtocolNotificationType<DidChangeNotebookDocumentParams, void>;
 }
+/**
+ * The params sent in a save notebook document notification.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface DidSaveNotebookDocumentParams {
+    /**
+     * The notebook document that got saved.
+     */
+    notebookDocument: NotebookDocumentIdentifier;
+}
+/**
+ * A notification sent when a notebook document is saved.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export declare namespace DidSaveNotebookDocumentNotification {
+    const method: 'notebookDocument/didSave';
+    const type: ProtocolNotificationType<DidSaveNotebookDocumentParams, void>;
+}
 /**
  * The params sent in a close notebook document notification.
  *
@@ -239,9 +341,14 @@ export declare namespace DidChangeNotebookDocumentNotification {
  */
 export interface DidCloseNotebookDocumentParams {
     /**
-     * The notebook document that got opened.
+     * The notebook document that got closed.
      */
     notebookDocument: NotebookDocumentIdentifier;
+    /**
+     * The text documents that represent the content
+     * of a notebook cell that got closed.
+     */
+    cellTextDocuments: TextDocumentIdentifier[];
 }
 /**
  * A notification sent when a notebook closes.

package/lib/common/proposed.notebooks.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DidCloseNotebookDocumentNotification = exports.DidChangeNotebookDocumentNotification = exports.DidOpenNotebookDocumentNotification = exports.NotebookDocumentSyncRegistrationType = exports.NotebookDocument = exports.NotebookCellChange = exports.NotebookCell = exports.NotebookCellKind = void 0;
+exports.DidCloseNotebookDocumentNotification = exports.DidSaveNotebookDocumentNotification = exports.DidChangeNotebookDocumentNotification = exports.NotebookCellArrayChange = exports.DidOpenNotebookDocumentNotification = exports.NotebookDocumentSyncRegistrationType = exports.NotebookDocument = exports.NotebookCell = exports.NotebookCellKind = void 0;
 const vscode_languageserver_types_1 = require("vscode-languageserver-types");
 const Is = require("./utils/is");
 const messages_1 = require("./messages");
@@ -36,30 +36,66 @@ var NotebookCell;
     NotebookCell.create = create;
     function is(value) {
         const candidate = value;
-        return Is.objectLiteral(candidate) && NotebookCellKind.is(candidate.kind) && vscode_languageserver_types_1.DocumentUri.is(candidate.document);
+        return Is.objectLiteral(candidate) && NotebookCellKind.is(candidate.kind) && vscode_languageserver_types_1.DocumentUri.is(candidate.document) &&
+            (candidate.metadata === undefined || Is.objectLiteral(candidate.metadata));
     }
     NotebookCell.is = is;
-    function equal(one, two) {
-        return one.kind === two.kind && one.document === two.document;
-    }
-    NotebookCell.equal = equal;
-})(NotebookCell = exports.NotebookCell || (exports.NotebookCell = {}));
-var NotebookCellChange;
-(function (NotebookCellChange) {
-    function is(value) {
-        const candidate = value;
-        return Is.objectLiteral(candidate) && vscode_languageserver_types_1.uinteger.is(candidate.start) && vscode_languageserver_types_1.uinteger.is(candidate.deleteCount) && (candidate.cells === undefined || Is.typedArray(candidate.cells, NotebookCell.is));
+    function equals(one, other, compareMetaData = false) {
+        if (one.kind !== other.kind || one.document !== other.document) {
+            return false;
+        }
+        return !compareMetaData || (compareMetaData && equalsMetadata(one.metadata, other.metadata));
     }
-    NotebookCellChange.is = is;
-    function create(start, deleteCount, cells) {
-        const result = { start, deleteCount };
-        if (cells !== undefined) {
-            result.cells = cells;
+    NotebookCell.equals = equals;
+    function equalsMetadata(one, other) {
+        if (one === other) {
+            return true;
         }
-        return result;
+        if (one === null || one === undefined || other === null || other === undefined) {
+            return false;
+        }
+        if (typeof one !== typeof other) {
+            return false;
+        }
+        if (typeof one !== 'object') {
+            return false;
+        }
+        const oneArray = Array.isArray(one);
+        const otherArray = Array.isArray(other);
+        if (oneArray !== otherArray) {
+            return false;
+        }
+        if (oneArray && otherArray) {
+            if (one.length !== other.length) {
+                return false;
+            }
+            for (let i = 0; i < one.length; i++) {
+                if (!equalsMetadata(one[i], other[i])) {
+                    return false;
+                }
+            }
+        }
+        if (Is.objectLiteral(one) && Is.objectLiteral(other)) {
+            const oneKeys = Object.keys(one);
+            const otherKeys = Object.keys(other);
+            if (oneKeys.length !== otherKeys.length) {
+                return false;
+            }
+            oneKeys.sort();
+            otherKeys.sort();
+            if (!equalsMetadata(oneKeys, otherKeys)) {
+                return false;
+            }
+            for (let i = 0; i < oneKeys.length; i++) {
+                const prop = oneKeys[i];
+                if (!equalsMetadata(one[prop], other[prop])) {
+                    return false;
+                }
+            }
+        }
+        return true;
     }
-    NotebookCellChange.create = create;
-})(NotebookCellChange = exports.NotebookCellChange || (exports.NotebookCellChange = {}));
+})(NotebookCell = exports.NotebookCell || (exports.NotebookCell = {}));
 var NotebookDocument;
 (function (NotebookDocument) {
     function create(uri, notebookType, version, cells) {
@@ -87,11 +123,37 @@ var DidOpenNotebookDocumentNotification;
     DidOpenNotebookDocumentNotification.method = 'notebookDocument/didOpen';
     DidOpenNotebookDocumentNotification.type = new messages_1.ProtocolNotificationType(DidOpenNotebookDocumentNotification.method);
 })(DidOpenNotebookDocumentNotification = exports.DidOpenNotebookDocumentNotification || (exports.DidOpenNotebookDocumentNotification = {}));
+var NotebookCellArrayChange;
+(function (NotebookCellArrayChange) {
+    function is(value) {
+        const candidate = value;
+        return Is.objectLiteral(candidate) && vscode_languageserver_types_1.uinteger.is(candidate.start) && vscode_languageserver_types_1.uinteger.is(candidate.deleteCount) && (candidate.cells === undefined || Is.typedArray(candidate.cells, NotebookCell.is));
+    }
+    NotebookCellArrayChange.is = is;
+    function create(start, deleteCount, cells) {
+        const result = { start, deleteCount };
+        if (cells !== undefined) {
+            result.cells = cells;
+        }
+        return result;
+    }
+    NotebookCellArrayChange.create = create;
+})(NotebookCellArrayChange = exports.NotebookCellArrayChange || (exports.NotebookCellArrayChange = {}));
 var DidChangeNotebookDocumentNotification;
 (function (DidChangeNotebookDocumentNotification) {
     DidChangeNotebookDocumentNotification.method = 'notebookDocument/didChange';
     DidChangeNotebookDocumentNotification.type = new messages_1.ProtocolNotificationType(DidChangeNotebookDocumentNotification.method);
 })(DidChangeNotebookDocumentNotification = exports.DidChangeNotebookDocumentNotification || (exports.DidChangeNotebookDocumentNotification = {}));
+/**
+ * A notification sent when a notebook document is saved.
+ *
+ * @since 3.17.0 - proposed state
+ */
+var DidSaveNotebookDocumentNotification;
+(function (DidSaveNotebookDocumentNotification) {
+    DidSaveNotebookDocumentNotification.method = 'notebookDocument/didSave';
+    DidSaveNotebookDocumentNotification.type = new messages_1.ProtocolNotificationType(DidSaveNotebookDocumentNotification.method);
+})(DidSaveNotebookDocumentNotification = exports.DidSaveNotebookDocumentNotification || (exports.DidSaveNotebookDocumentNotification = {}));
 /**
  * A notification sent when a notebook closes.
  *

package/lib/common/protocol.d.ts

@@ -129,6 +129,19 @@ export declare type NotebookCellTextDocumentFilter = {
      * notebook cell document.
      */
     cellLanguage?: string;
+} | {
+    /**
+     * A filter that matches against the notebook
+     * containing the notebook cell.
+     */
+    notebookDocument?: NotebookDocumentFilter;
+    /**
+     * A language id like `python`.
+     *
+     * Will be matched against the language id of the
+     * notebook cell document.
+     */
+    cellLanguage: string;
 };
 /**
  * The NotebookCellTextDocumentFilter namespace provides helper functions to work with

package/lib/common/protocol.js

@@ -97,7 +97,7 @@ var NotebookCellTextDocumentFilter;
 (function (NotebookCellTextDocumentFilter) {
     function is(value) {
         const candidate = value;
-        return Is.objectLiteral(candidate) && NotebookDocumentFilter.is(candidate.notebookDocument) && (candidate.cellLanguage === undefined || Is.string(candidate.cellLanguage));
+        return Is.objectLiteral(candidate) && (NotebookDocumentFilter.is(candidate.notebookDocument) || Is.string(candidate.cellLanguage));
     }
     NotebookCellTextDocumentFilter.is = is;
 })(NotebookCellTextDocumentFilter = exports.NotebookCellTextDocumentFilter || (exports.NotebookCellTextDocumentFilter = {}));

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "vscode-languageserver-protocol",
 	"description": "VSCode Language Server Protocol implementation",
-	"version": "3.17.0-next.12",
+	"version": "3.17.0-next.13",
 	"author": "Microsoft Corporation",
 	"license": "MIT",
 	"repository": {
@@ -18,8 +18,8 @@
 	},
 	"typings": "./lib/common/api.d.ts",
 	"dependencies": {
-		"vscode-jsonrpc": "8.0.0-next.5",
-		"vscode-languageserver-types": "3.17.0-next.6"
+		"vscode-jsonrpc": "8.0.0-next.6",
+		"vscode-languageserver-types": "3.17.0-next.7"
 	},
 	"scripts": {
 		"prepublishOnly": "git clean -xfd . && npm install && npm run clean && npm run compile && npm test",