vscode-languageserver-protocol 3.17.0-next.10 → 3.17.0-next.14

package/lib/common/api.d.ts

@@ -56,6 +56,7 @@ export declare namespace LSPErrorCodes {
 import * as diag from './proposed.diagnostic';
 import * as typeh from './proposed.typeHierarchy';
 import * as iv from './proposed.inlineValue';
+import * as nb from './proposed.notebooks';
 export declare namespace Proposed {
     type DiagnosticClientCapabilities = diag.DiagnosticClientCapabilities;
     type $DiagnosticClientCapabilities = diag.$DiagnosticClientCapabilities;
@@ -98,4 +99,32 @@ export declare namespace Proposed {
     type InlineValuesParams = iv.InlineValuesParams;
     const InlineValuesRequest: typeof iv.InlineValuesRequest;
     const InlineValuesRefreshRequest: typeof iv.InlineValuesRefreshRequest;
+    type $NotebookDocumentClientCapabilities = nb.$NotebookDocumentClientCapabilities;
+    type NotebookDocumentSyncClientCapabilities = nb.NotebookDocumentSyncClientCapabilities;
+    type $NotebookDocumentSyncServerCapabilities = nb.$NotebookDocumentSyncServerCapabilities;
+    type NotebookCellKind = nb.NotebookCellKind;
+    const NotebookCellKind: typeof nb.NotebookCellKind;
+    type NotebookCell = nb.NotebookCell;
+    const NotebookCell: typeof nb.NotebookCell;
+    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 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;
+    type NotebookController = nb.NotebookController;
+    const NotebookController: typeof nb.NotebookController;
+    type DidSelectNotebookControllerParams = nb.DidSelectNotebookControllerParams;
+    const DidSelectNotebookControllerNotification: typeof nb.DidSelectNotebookControllerNotification;
 }

package/lib/common/api.js

@@ -74,6 +74,7 @@ var LSPErrorCodes;
 const diag = require("./proposed.diagnostic");
 const typeh = require("./proposed.typeHierarchy");
 const iv = require("./proposed.inlineValue");
+const nb = require("./proposed.notebooks");
 var Proposed;
 (function (Proposed) {
     Proposed.DiagnosticServerCancellationData = diag.DiagnosticServerCancellationData;
@@ -86,5 +87,15 @@ var Proposed;
     Proposed.TypeHierarchySubtypesRequest = typeh.TypeHierarchySubtypesRequest;
     Proposed.InlineValuesRequest = iv.InlineValuesRequest;
     Proposed.InlineValuesRefreshRequest = iv.InlineValuesRefreshRequest;
+    Proposed.NotebookCellKind = nb.NotebookCellKind;
+    Proposed.NotebookCell = nb.NotebookCell;
+    Proposed.NotebookDocument = nb.NotebookDocument;
+    Proposed.NotebookDocumentSyncRegistrationType = nb.NotebookDocumentSyncRegistrationType;
+    Proposed.DidOpenNotebookDocumentNotification = nb.DidOpenNotebookDocumentNotification;
+    Proposed.DidChangeNotebookDocumentNotification = nb.DidChangeNotebookDocumentNotification;
+    Proposed.DidSaveNotebookDocumentNotification = nb.DidSaveNotebookDocumentNotification;
+    Proposed.DidCloseNotebookDocumentNotification = nb.DidCloseNotebookDocumentNotification;
+    Proposed.NotebookController = nb.NotebookController;
+    Proposed.DidSelectNotebookControllerNotification = nb.DidSelectNotebookControllerNotification;
 })(Proposed = exports.Proposed || (exports.Proposed = {}));
 //# sourceMappingURL=api.js.map

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

@@ -0,0 +1,443 @@
+import { URI, integer, DocumentUri, uinteger, LSPObject, TextDocumentItem, TextDocumentIdentifier, VersionedTextDocumentIdentifier } from 'vscode-languageserver-types';
+import { ProtocolNotificationType, RegistrationType } from './messages';
+import { StaticRegistrationOptions, NotebookDocumentFilter, TextDocumentContentChangeEvent } from './protocol';
+/**
+ * Notebook specific client capabilities.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface NotebookDocumentSyncClientCapabilities {
+    /**
+     * Whether implementation supports dynamic registration. If this is
+     * set to `true` the client supports the new
+     * `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+     * return value for the corresponding server capability as well.
+     */
+    dynamicRegistration?: boolean;
+    /**
+     * The client supports sending execution summary data per cell.
+     */
+    executionSummarySupport?: boolean;
+}
+export interface $NotebookDocumentClientCapabilities {
+    notebookDocument?: {
+        synchronization: NotebookDocumentSyncClientCapabilities;
+    };
+}
+/**
+ * A notebook cell kind.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export declare namespace NotebookCellKind {
+    /**
+     * A markup-cell is formatted source that is used for display.
+     */
+    const Markup: 1;
+    /**
+     * A code-cell is source code.
+     */
+    const Code: 2;
+    function is(value: any): value is NotebookCellKind;
+}
+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;
+}
+/**
+ * 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 {
+    /**
+     * The cell's kind
+     */
+    kind: NotebookCellKind;
+    /**
+     * The URI of the cell's text document
+     * content.
+     */
+    document: DocumentUri;
+    /**
+     * Additional metadata stored with the cell.
+     */
+    metadata?: LSPObject;
+    /**
+     * Additional execution summary information
+     * if supported by the client.
+     */
+    executionSummary?: ExecutionSummary;
+}
+export declare namespace NotebookCell {
+    function create(kind: NotebookCellKind, document: DocumentUri): NotebookCell;
+    function is(value: any): value is NotebookCell;
+    function equals(one: NotebookCell, other: NotebookCell, compareMetaData?: boolean): boolean;
+    function diff(one: NotebookCell, two: NotebookCell): Set<keyof NotebookCell>;
+}
+/**
+ * A notebook document.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface NotebookDocument {
+    /**
+     * The notebook document's uri.
+     */
+    uri: URI;
+    /**
+     * The type of the notebook.
+     */
+    notebookType: string;
+    /**
+     * The version number of this document (it will increase after each
+     * change, including undo/redo).
+     */
+    version: integer;
+    /**
+     * Additional metadata stored with the notebook
+     * document.
+     */
+    metadata?: LSPObject;
+    /**
+     * The cells of a notebook.
+     */
+    cells: NotebookCell[];
+}
+export declare namespace NotebookDocument {
+    function create(uri: URI, notebookType: string, version: integer, cells: NotebookCell[]): NotebookDocument;
+    function is(value: any): value is NotebookDocument;
+}
+/**
+ * A literal to identify a notebook document in the client.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface NotebookDocumentIdentifier {
+    /**
+     * The notebook document's uri.
+     */
+    uri: URI;
+}
+/**
+ * A versioned notebook document identifier.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface VersionedNotebookDocumentIdentifier {
+    /**
+     * The version number of this notebook document.
+     */
+    version: integer;
+    /**
+     * The notebook document's uri.
+     */
+    uri: URI;
+}
+/**
+ * Options specific to a notebook plus its cells
+ * to be synced to the server.
+ *
+ * If a selector provide a notebook document
+ * filter but no cell selector all cells of a
+ * matching notebook document will be synced.
+ *
+ * If a selector provides no notebook document
+ * filter but only a cell selector all notebook
+ * document that contain at least one matching
+ * cell will be synced.
+ *
+ * @since 3.17.0 - proposed state
+ */
+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 */
+        cellSelector?: {
+            language: string;
+        }[];
+    } | {
+        /** The notebook documents to be synced */
+        notebookDocumentFilter?: NotebookDocumentFilter;
+        /** The cells of the matching notebook to be synced */
+        cellSelector: {
+            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;
+};
+/**
+ * Registration options specific to a notebook.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export declare type NotebookDocumentSyncRegistrationOptions = NotebookDocumentSyncOptions & StaticRegistrationOptions;
+export interface $NotebookDocumentSyncServerCapabilities {
+    notebookDocumentSync?: NotebookDocumentSyncOptions | NotebookDocumentSyncRegistrationOptions;
+}
+export declare namespace NotebookDocumentSyncRegistrationType {
+    const method: 'notebookDocument/sync';
+    const type: RegistrationType<NotebookDocumentSyncRegistrationOptions>;
+}
+/**
+ * The params sent in a open notebook document notification.
+ *
+ * @since 3.17.0 - proposed state
+ */
+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.
+ *
+ * @since 3.17.0 - proposed state
+ */
+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 {
+    /**
+     * The changed meta data if any.
+     */
+    metadata?: LSPObject;
+    /**
+     * Changes to cells
+     */
+    cells?: {
+        /**
+         * Changes to the cell structure to add or
+         * remove cells.
+         */
+        structure?: {
+            /**
+             * 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, execution summary or metadata.
+         */
+        data?: NotebookCell[];
+        /**
+         * Changes to the text content of notebook cells.
+         */
+        textContent?: {
+            document: VersionedTextDocumentIdentifier;
+            changes: 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. If
+     * only the text document content of a cell changes the notebook version
+     * doesn't necessarily have to change.
+     */
+    notebookDocument: VersionedNotebookDocumentIdentifier;
+    /**
+     * The actual changes to the notebook document.
+     *
+     * The changes describe single state changes to the notebook document.
+     * So if there are two changes c1 (at array index 0) and c2 (at array
+     * index 1) for a notebook in state S then c1 moves the notebook from
+     * S to S' and c2 from S' to S''. So c1 is computed on the state S and
+     * c2 is computed on the state S'.
+     *
+     * To mirror the content of a notebook using change events use the following approach:
+     * - start with the same initial content
+     * - apply the 'notebookDocument/didChange' notifications in the order you receive them.
+     * - apply the `NotebookChangeEvent`s in a single notification in the order
+     *   you receive them.
+     */
+    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.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface DidCloseNotebookDocumentParams {
+    /**
+     * 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.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export declare namespace DidCloseNotebookDocumentNotification {
+    const method: 'notebookDocument/didClose';
+    const type: ProtocolNotificationType<DidCloseNotebookDocumentParams, void>;
+}
+/**
+ * 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>;
+}

package/lib/common/proposed.notebooks.js

@@ -0,0 +1,238 @@
+"use strict";
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+const Is = require("./utils/is");
+const messages_1 = require("./messages");
+/**
+ * A notebook cell kind.
+ *
+ * @since 3.17.0 - proposed state
+ */
+var NotebookCellKind;
+(function (NotebookCellKind) {
+    /**
+     * A markup-cell is formatted source that is used for display.
+     */
+    NotebookCellKind.Markup = 1;
+    /**
+     * A code-cell is source code.
+     */
+    NotebookCellKind.Code = 2;
+    function is(value) {
+        return value === 1 || value === 2;
+    }
+    NotebookCellKind.is = 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;
+(function (NotebookCell) {
+    function create(kind, document) {
+        return { kind, document };
+    }
+    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) &&
+            (candidate.metadata === undefined || Is.objectLiteral(candidate.metadata));
+    }
+    NotebookCell.is = is;
+    function equals(one, other, compareMetaData = true) {
+        if (one.kind !== other.kind || one.document !== other.document) {
+            return false;
+        }
+        return !compareMetaData || (compareMetaData && equalsMetadata(one.metadata, other.metadata));
+    }
+    NotebookCell.equals = equals;
+    function equalsMetadata(one, other) {
+        if (one === other) {
+            return true;
+        }
+        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;
+    }
+    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 = {}));
+var NotebookDocument;
+(function (NotebookDocument) {
+    function create(uri, notebookType, version, cells) {
+        return { uri, notebookType, version, cells };
+    }
+    NotebookDocument.create = create;
+    function is(value) {
+        const candidate = value;
+        return Is.objectLiteral(candidate) && Is.string(candidate.uri) && vscode_languageserver_types_1.integer.is(candidate.version) && Is.typedArray(candidate.cells, NotebookCell.is);
+    }
+    NotebookDocument.is = is;
+})(NotebookDocument = exports.NotebookDocument || (exports.NotebookDocument = {}));
+var NotebookDocumentSyncRegistrationType;
+(function (NotebookDocumentSyncRegistrationType) {
+    NotebookDocumentSyncRegistrationType.method = 'notebookDocument/sync';
+    NotebookDocumentSyncRegistrationType.type = new messages_1.RegistrationType(NotebookDocumentSyncRegistrationType.method);
+})(NotebookDocumentSyncRegistrationType = exports.NotebookDocumentSyncRegistrationType || (exports.NotebookDocumentSyncRegistrationType = {}));
+/**
+ * A notification sent when a notebook opens.
+ *
+ * @since 3.17.0 - proposed state
+ */
+var DidOpenNotebookDocumentNotification;
+(function (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.
+ *
+ * @since 3.17.0 - proposed state
+ */
+var DidCloseNotebookDocumentNotification;
+(function (DidCloseNotebookDocumentNotification) {
+    DidCloseNotebookDocumentNotification.method = 'notebookDocument/didClose';
+    DidCloseNotebookDocumentNotification.type = new messages_1.ProtocolNotificationType(DidCloseNotebookDocumentNotification.method);
+})(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/lib/common/protocol.d.ts

@@ -33,8 +33,10 @@ import { InlineValuesClientCapabilities, InlineValuesOptions, InlineValuesRegist
  *
  * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
  * @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
+ *
+ * @since 3.17.0 - proposed state.
  */
-export declare type DocumentFilter = {
+export declare type TextDocumentFilter = {
     /** A language id, like `typescript`. */
     language: string;
     /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`. */
@@ -57,12 +59,106 @@ export declare type DocumentFilter = {
     pattern: string;
 };
 /**
- * The DocumentFilter namespace provides helper functions to work with
- * [DocumentFilter](#DocumentFilter) literals.
+ * The TextDocumentFilter namespace provides helper functions to work with
+ * [TextDocumentFilter](#TextDocumentFilter) literals.
+ *
+ * @since 3.17.0 - proposed state.
+ */
+export declare namespace TextDocumentFilter {
+    function is(value: any): value is TextDocumentFilter;
+}
+/**
+ * A notebook document filter denotes a notebook document by
+ * different properties.
+ *
+ * @since 3.17.0 - proposed state.
+ */
+export declare type NotebookDocumentFilter = {
+    /** The type of the enclosing notebook. */
+    notebookType: string;
+    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+     * Will be matched against the URI of the notebook. */
+    scheme?: string;
+    /** A glob pattern, like `*.ipynb`.
+     * Will be matched against the notebooks` URI path section.*/
+    pattern?: string;
+} | {
+    /** The type of the enclosing notebook. */
+    notebookType?: string;
+    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+     * Will be matched against the URI of the notebook. */
+    scheme: string;
+    /** A glob pattern, like `*.ipynb`.
+     * Will be matched against the notebooks` URI path section.*/
+    pattern?: string;
+} | {
+    /** The type of the enclosing notebook. */
+    notebookType?: string;
+    /** A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
+     * Will be matched against the URI of the notebook. */
+    scheme?: string;
+    /** A glob pattern, like `*.ipynb`.
+     * Will be matched against the notebooks` URI path section.*/
+    pattern: string;
+};
+/**
+ * The NotebookDocumentFilter namespace provides helper functions to work with
+ * [NotebookDocumentFilter](#NotebookDocumentFilter) literals.
+ *
+ * @since 3.17.0 - proposed state.
+ */
+export declare namespace NotebookDocumentFilter {
+    function is(value: any): value is NotebookDocumentFilter;
+}
+/**
+ * A notebook cell text document filter denotes a cell text
+ * document by different properties.
+ *
+ * @since 3.17.0 - proposed state.
+ */
+export declare type NotebookCellTextDocumentFilter = {
+    /**
+     * 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;
+} | {
+    /**
+     * 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
+ * [NotebookCellTextDocumentFilter](#NotebookCellTextDocumentFilter) literals.
+ *
+ * @since 3.17.0 - proposed state.
  */
-export declare namespace DocumentFilter {
-    function is(value: any): value is DocumentFilter;
+export declare namespace NotebookCellTextDocumentFilter {
+    function is(value: any): value is NotebookCellTextDocumentFilter;
 }
+/**
+ * A document filter describes a top level text document or
+ * a notebook cell document.
+ *
+ * @since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
+ */
+export declare type DocumentFilter = TextDocumentFilter | NotebookCellTextDocumentFilter;
 /**
  * A document selector is the combination of one or many document filters.
  *
@@ -729,7 +825,7 @@ export interface _ServerCapabilities<T = any> {
      *
      * @since 3.17.0 - proposed state
      */
-    inlineValuesProvider?: boolean | InlineValuesOptions | InlineValuesOptions | InlineValuesRegistrationOptions;
+    inlineValuesProvider?: boolean | InlineValuesOptions | InlineValuesRegistrationOptions;
     /**
      * Experimental server capabilities.
      */
@@ -2734,7 +2830,7 @@ export interface ExecuteCommandRegistrationOptions extends ExecuteCommandOptions
  * a workspace edit which the client will apply to the workspace.
  */
 export declare namespace ExecuteCommandRequest {
-    const type: ProtocolRequestType<ExecuteCommandParams, LSPAny, never, void, ExecuteCommandRegistrationOptions>;
+    const type: ProtocolRequestType<ExecuteCommandParams, void | LSPAny, never, void, ExecuteCommandRegistrationOptions>;
 }
 export interface WorkspaceEditClientCapabilities {
     /**

package/lib/common/protocol.js

@@ -4,8 +4,8 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CodeLensRefreshRequest = exports.CodeLensResolveRequest = exports.CodeLensRequest = exports.WorkspaceSymbolResolveRequest = exports.WorkspaceSymbolRequest = exports.CodeActionResolveRequest = exports.CodeActionRequest = exports.DocumentSymbolRequest = exports.DocumentHighlightRequest = exports.ReferencesRequest = exports.DefinitionRequest = exports.SignatureHelpRequest = exports.SignatureHelpTriggerKind = exports.HoverRequest = exports.CompletionResolveRequest = exports.CompletionRequest = exports.CompletionTriggerKind = exports.PublishDiagnosticsNotification = exports.WatchKind = exports.FileChangeType = exports.DidChangeWatchedFilesNotification = exports.WillSaveTextDocumentWaitUntilRequest = exports.WillSaveTextDocumentNotification = exports.TextDocumentSaveReason = exports.DidSaveTextDocumentNotification = exports.DidCloseTextDocumentNotification = exports.DidChangeTextDocumentNotification = exports.TextDocumentContentChangeEvent = exports.DidOpenTextDocumentNotification = exports.TextDocumentSyncKind = exports.TelemetryEventNotification = exports.LogMessageNotification = exports.ShowMessageRequest = exports.ShowMessageNotification = exports.MessageType = exports.DidChangeConfigurationNotification = exports.ExitNotification = exports.ShutdownRequest = exports.InitializedNotification = exports.InitializeError = exports.InitializeRequest = exports.WorkDoneProgressOptions = exports.TextDocumentRegistrationOptions = exports.StaticRegistrationOptions = exports.FailureHandlingKind = exports.ResourceOperationKind = exports.UnregistrationRequest = exports.RegistrationRequest = exports.DocumentSelector = exports.DocumentFilter = void 0;
-exports.MonikerRequest = exports.MonikerKind = exports.UniquenessLevel = exports.WillDeleteFilesRequest = exports.DidDeleteFilesNotification = exports.WillRenameFilesRequest = exports.DidRenameFilesNotification = exports.WillCreateFilesRequest = exports.DidCreateFilesNotification = exports.FileOperationPatternKind = exports.LinkedEditingRangeRequest = exports.ShowDocumentRequest = exports.SemanticTokensRegistrationType = exports.SemanticTokensRefreshRequest = exports.SemanticTokensRangeRequest = exports.SemanticTokensDeltaRequest = exports.SemanticTokensRequest = exports.TokenFormat = exports.CallHierarchyPrepareRequest = exports.CallHierarchyOutgoingCallsRequest = exports.CallHierarchyIncomingCallsRequest = exports.WorkDoneProgressCancelNotification = exports.WorkDoneProgressCreateRequest = exports.WorkDoneProgress = exports.SelectionRangeRequest = exports.DeclarationRequest = exports.FoldingRangeRequest = exports.ColorPresentationRequest = exports.DocumentColorRequest = exports.ConfigurationRequest = exports.DidChangeWorkspaceFoldersNotification = exports.WorkspaceFoldersRequest = exports.TypeDefinitionRequest = exports.ImplementationRequest = exports.ApplyWorkspaceEditRequest = exports.ExecuteCommandRequest = exports.PrepareRenameRequest = exports.RenameRequest = exports.PrepareSupportDefaultBehavior = exports.DocumentOnTypeFormattingRequest = exports.DocumentRangeFormattingRequest = exports.DocumentFormattingRequest = exports.DocumentLinkResolveRequest = exports.DocumentLinkRequest = void 0;
+exports.CodeLensRequest = exports.WorkspaceSymbolResolveRequest = exports.WorkspaceSymbolRequest = exports.CodeActionResolveRequest = exports.CodeActionRequest = exports.DocumentSymbolRequest = exports.DocumentHighlightRequest = exports.ReferencesRequest = exports.DefinitionRequest = exports.SignatureHelpRequest = exports.SignatureHelpTriggerKind = exports.HoverRequest = exports.CompletionResolveRequest = exports.CompletionRequest = exports.CompletionTriggerKind = exports.PublishDiagnosticsNotification = exports.WatchKind = exports.FileChangeType = exports.DidChangeWatchedFilesNotification = exports.WillSaveTextDocumentWaitUntilRequest = exports.WillSaveTextDocumentNotification = exports.TextDocumentSaveReason = exports.DidSaveTextDocumentNotification = exports.DidCloseTextDocumentNotification = exports.DidChangeTextDocumentNotification = exports.TextDocumentContentChangeEvent = exports.DidOpenTextDocumentNotification = exports.TextDocumentSyncKind = exports.TelemetryEventNotification = exports.LogMessageNotification = exports.ShowMessageRequest = exports.ShowMessageNotification = exports.MessageType = exports.DidChangeConfigurationNotification = exports.ExitNotification = exports.ShutdownRequest = exports.InitializedNotification = exports.InitializeError = exports.InitializeRequest = exports.WorkDoneProgressOptions = exports.TextDocumentRegistrationOptions = exports.StaticRegistrationOptions = exports.FailureHandlingKind = exports.ResourceOperationKind = exports.UnregistrationRequest = exports.RegistrationRequest = exports.DocumentSelector = exports.NotebookCellTextDocumentFilter = exports.NotebookDocumentFilter = exports.TextDocumentFilter = void 0;
+exports.MonikerRequest = exports.MonikerKind = exports.UniquenessLevel = exports.WillDeleteFilesRequest = exports.DidDeleteFilesNotification = exports.WillRenameFilesRequest = exports.DidRenameFilesNotification = exports.WillCreateFilesRequest = exports.DidCreateFilesNotification = exports.FileOperationPatternKind = exports.LinkedEditingRangeRequest = exports.ShowDocumentRequest = exports.SemanticTokensRegistrationType = exports.SemanticTokensRefreshRequest = exports.SemanticTokensRangeRequest = exports.SemanticTokensDeltaRequest = exports.SemanticTokensRequest = exports.TokenFormat = exports.CallHierarchyPrepareRequest = exports.CallHierarchyOutgoingCallsRequest = exports.CallHierarchyIncomingCallsRequest = exports.WorkDoneProgressCancelNotification = exports.WorkDoneProgressCreateRequest = exports.WorkDoneProgress = exports.SelectionRangeRequest = exports.DeclarationRequest = exports.FoldingRangeRequest = exports.ColorPresentationRequest = exports.DocumentColorRequest = exports.ConfigurationRequest = exports.DidChangeWorkspaceFoldersNotification = exports.WorkspaceFoldersRequest = exports.TypeDefinitionRequest = exports.ImplementationRequest = exports.ApplyWorkspaceEditRequest = exports.ExecuteCommandRequest = exports.PrepareRenameRequest = exports.RenameRequest = exports.PrepareSupportDefaultBehavior = exports.DocumentOnTypeFormattingRequest = exports.DocumentRangeFormattingRequest = exports.DocumentFormattingRequest = exports.DocumentLinkResolveRequest = exports.DocumentLinkRequest = exports.CodeLensRefreshRequest = exports.CodeLensResolveRequest = void 0;
 const messages_1 = require("./messages");
 const Is = require("./utils/is");
 const protocol_implementation_1 = require("./protocol.implementation");
@@ -60,17 +60,47 @@ Object.defineProperty(exports, "MonikerRequest", { enumerable: true, get: functi
 // @ts-ignore: to avoid inlining LocationLink as dynamic import
 let __noDynamicImport;
 /**
- * The DocumentFilter namespace provides helper functions to work with
- * [DocumentFilter](#DocumentFilter) literals.
+ * The TextDocumentFilter namespace provides helper functions to work with
+ * [TextDocumentFilter](#TextDocumentFilter) literals.
+ *
+ * @since 3.17.0 - proposed state.
  */
-var DocumentFilter;
-(function (DocumentFilter) {
+var TextDocumentFilter;
+(function (TextDocumentFilter) {
     function is(value) {
         const candidate = value;
         return Is.string(candidate.language) || Is.string(candidate.scheme) || Is.string(candidate.pattern);
     }
-    DocumentFilter.is = is;
-})(DocumentFilter = exports.DocumentFilter || (exports.DocumentFilter = {}));
+    TextDocumentFilter.is = is;
+})(TextDocumentFilter = exports.TextDocumentFilter || (exports.TextDocumentFilter = {}));
+/**
+ * The NotebookDocumentFilter namespace provides helper functions to work with
+ * [NotebookDocumentFilter](#NotebookDocumentFilter) literals.
+ *
+ * @since 3.17.0 - proposed state.
+ */
+var NotebookDocumentFilter;
+(function (NotebookDocumentFilter) {
+    function is(value) {
+        const candidate = value;
+        return Is.objectLiteral(candidate) && (Is.string(candidate.notebookType) || Is.string(candidate.scheme) || Is.string(candidate.pattern));
+    }
+    NotebookDocumentFilter.is = is;
+})(NotebookDocumentFilter = exports.NotebookDocumentFilter || (exports.NotebookDocumentFilter = {}));
+/**
+ * The NotebookCellTextDocumentFilter namespace provides helper functions to work with
+ * [NotebookCellTextDocumentFilter](#NotebookCellTextDocumentFilter) literals.
+ *
+ * @since 3.17.0 - proposed state.
+ */
+var NotebookCellTextDocumentFilter;
+(function (NotebookCellTextDocumentFilter) {
+    function is(value) {
+        const candidate = value;
+        return Is.objectLiteral(candidate) && (NotebookDocumentFilter.is(candidate.notebookDocument) || Is.string(candidate.cellLanguage));
+    }
+    NotebookCellTextDocumentFilter.is = is;
+})(NotebookCellTextDocumentFilter = exports.NotebookCellTextDocumentFilter || (exports.NotebookCellTextDocumentFilter = {}));
 /**
  * The DocumentSelector namespace provides helper functions to work with
  * [DocumentSelector](#DocumentSelector)s.
@@ -82,7 +112,7 @@ var DocumentSelector;
             return false;
         }
         for (let elem of value) {
-            if (!Is.string(elem) && !DocumentFilter.is(elem)) {
+            if (!Is.string(elem) && !TextDocumentFilter.is(elem) && !NotebookCellTextDocumentFilter.is(elem)) {
                 return false;
             }
         }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "vscode-languageserver-protocol",
 	"description": "VSCode Language Server Protocol implementation",
-	"version": "3.17.0-next.10",
+	"version": "3.17.0-next.14",
 	"author": "Microsoft Corporation",
 	"license": "MIT",
 	"repository": {
@@ -18,8 +18,8 @@
 	},
 	"typings": "./lib/common/api.d.ts",
 	"dependencies": {
-		"vscode-jsonrpc": "8.0.0-next.4",
-		"vscode-languageserver-types": "3.17.0-next.5"
+		"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",