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

package/lib/common/proposed.diagnostic.js

@@ -1,14 +1,72 @@
 "use strict";
 /* --------------------------------------------------------------------------------------------
- * Copyright (c) TypeFox and others. All rights reserved.
+ * 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.DiagnosticRequest = void 0;
+exports.DiagnosticRefreshRequest = exports.WorkspaceDiagnosticRequest = exports.DocumentDiagnosticRequest = exports.DocumentDiagnosticReportKind = exports.DiagnosticServerCancellationData = void 0;
+const vscode_jsonrpc_1 = require("vscode-jsonrpc");
+const Is = require("./utils/is");
 const messages_1 = require("./messages");
-var DiagnosticRequest;
-(function (DiagnosticRequest) {
-    DiagnosticRequest.method = 'textDocument/diagnostic';
-    DiagnosticRequest.type = new messages_1.ProtocolRequestType(DiagnosticRequest.method);
-})(DiagnosticRequest = exports.DiagnosticRequest || (exports.DiagnosticRequest = {}));
+/**
+ * @since 3.17.0 - proposed state
+ */
+var DiagnosticServerCancellationData;
+(function (DiagnosticServerCancellationData) {
+    function is(value) {
+        const candidate = value;
+        return candidate && Is.boolean(candidate.retriggerRequest);
+    }
+    DiagnosticServerCancellationData.is = is;
+})(DiagnosticServerCancellationData = exports.DiagnosticServerCancellationData || (exports.DiagnosticServerCancellationData = {}));
+/**
+ * The document diagnostic report kinds.
+ *
+ * @since 3.17.0 - proposed state
+ */
+var DocumentDiagnosticReportKind;
+(function (DocumentDiagnosticReportKind) {
+    /**
+     * A diagnostic report with a full
+     * set of problems.
+     */
+    DocumentDiagnosticReportKind["full"] = "full";
+    /**
+     * A report indicating that the last
+     * returned report is still accurate.
+     */
+    DocumentDiagnosticReportKind["unChanged"] = "unChanged";
+})(DocumentDiagnosticReportKind = exports.DocumentDiagnosticReportKind || (exports.DocumentDiagnosticReportKind = {}));
+/**
+ * The document diagnostic request definition.
+ *
+ * @since 3.17.0 - proposed state
+ */
+var DocumentDiagnosticRequest;
+(function (DocumentDiagnosticRequest) {
+    DocumentDiagnosticRequest.method = 'textDocument/diagnostic';
+    DocumentDiagnosticRequest.type = new messages_1.ProtocolRequestType(DocumentDiagnosticRequest.method);
+    DocumentDiagnosticRequest.partialResult = new vscode_jsonrpc_1.ProgressType();
+})(DocumentDiagnosticRequest = exports.DocumentDiagnosticRequest || (exports.DocumentDiagnosticRequest = {}));
+/**
+ * The workspace diagnostic request definition.
+ *
+ * @since 3.17.0 - proposed state
+ */
+var WorkspaceDiagnosticRequest;
+(function (WorkspaceDiagnosticRequest) {
+    WorkspaceDiagnosticRequest.method = 'workspace/diagnostic';
+    WorkspaceDiagnosticRequest.type = new messages_1.ProtocolRequestType(WorkspaceDiagnosticRequest.method);
+    WorkspaceDiagnosticRequest.partialResult = new vscode_jsonrpc_1.ProgressType();
+})(WorkspaceDiagnosticRequest = exports.WorkspaceDiagnosticRequest || (exports.WorkspaceDiagnosticRequest = {}));
+/**
+ * The diagnostic refresh request definition.
+ *
+ * @since 3.17.0 - proposed state
+ */
+var DiagnosticRefreshRequest;
+(function (DiagnosticRefreshRequest) {
+    DiagnosticRefreshRequest.method = `workspace/diagnostic/refresh`;
+    DiagnosticRefreshRequest.type = new messages_1.ProtocolRequestType0(DiagnosticRefreshRequest.method);
+})(DiagnosticRefreshRequest = exports.DiagnosticRefreshRequest || (exports.DiagnosticRefreshRequest = {}));
 //# sourceMappingURL=proposed.diagnostic.js.map

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

@@ -0,0 +1,86 @@
+import { TextDocumentIdentifier, Range, InlineValue, InlineValuesContext } from 'vscode-languageserver-types';
+import { RequestHandler, RequestHandler0 } from 'vscode-jsonrpc';
+import { ProtocolRequestType, ProtocolRequestType0 } from './messages';
+import { TextDocumentRegistrationOptions, WorkDoneProgressOptions, StaticRegistrationOptions, WorkDoneProgressParams } from './protocol';
+/**
+ * Client capabilities specific to inline values.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface InlineValuesClientCapabilities {
+    /**
+     * Whether implementation supports dynamic registration for inline value providers.
+     */
+    dynamicRegistration?: boolean;
+}
+/**
+ * Client workspace capabilities specific to inline values.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface InlineValuesWorkspaceClientCapabilities {
+    /**
+     * Whether the client implementation supports a refresh request sent from the
+     * server to the client.
+     *
+     * Note that this event is global and will force the client to refresh all
+     * inline values currently shown. It should be used with absolute care and is
+     * useful for situation where a server for example detect a project wide
+     * change that requires such a calculation.
+     */
+    refreshSupport?: boolean;
+}
+/**
+ * Inline values options used during static registration.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface InlineValuesOptions extends WorkDoneProgressOptions {
+}
+/**
+ * Inline value options used during static or dynamic registration.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface InlineValuesRegistrationOptions extends InlineValuesOptions, TextDocumentRegistrationOptions, StaticRegistrationOptions {
+}
+/**
+ * A parameter literal used in inline values requests.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export interface InlineValuesParams extends WorkDoneProgressParams {
+    /**
+     * The text document.
+     */
+    textDocument: TextDocumentIdentifier;
+    /**
+     * The visible document range for which inline values should be computed.
+     */
+    viewPort: Range;
+    /**
+     * Additional information about the context in which inline values were
+     * requested.
+     */
+    context: InlineValuesContext;
+}
+/**
+ * A request to provide inline values in a document. The request's parameter is of
+ * type [InlineValuesParams](#InlineValuesParams), the response is of type
+ * [InlineValue[]](#InlineValue[]) or a Thenable that resolves to such.
+ *
+ * @since 3.17.0 - proposed state
+ */
+export declare namespace InlineValuesRequest {
+    const method: 'textDocument/inlineValues';
+    const type: ProtocolRequestType<InlineValuesParams, InlineValue[] | null, InlineValue[], any, InlineValuesRegistrationOptions>;
+    type HandlerSignature = RequestHandler<InlineValuesParams, InlineValue[] | null, void>;
+}
+/**
+ * @since 3.17.0 - proposed state
+ */
+export declare namespace InlineValuesRefreshRequest {
+    const method: `workspace/inlineValues/refresh`;
+    const type: ProtocolRequestType0<void, void, void, void>;
+    type HandlerSignature = RequestHandler0<void, void>;
+}

package/lib/common/proposed.inlineValue.js

@@ -0,0 +1,29 @@
+"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.InlineValuesRefreshRequest = exports.InlineValuesRequest = void 0;
+const messages_1 = require("./messages");
+/**
+ * A request to provide inline values in a document. The request's parameter is of
+ * type [InlineValuesParams](#InlineValuesParams), the response is of type
+ * [InlineValue[]](#InlineValue[]) or a Thenable that resolves to such.
+ *
+ * @since 3.17.0 - proposed state
+ */
+var InlineValuesRequest;
+(function (InlineValuesRequest) {
+    InlineValuesRequest.method = 'textDocument/inlineValues';
+    InlineValuesRequest.type = new messages_1.ProtocolRequestType(InlineValuesRequest.method);
+})(InlineValuesRequest = exports.InlineValuesRequest || (exports.InlineValuesRequest = {}));
+/**
+ * @since 3.17.0 - proposed state
+ */
+var InlineValuesRefreshRequest;
+(function (InlineValuesRefreshRequest) {
+    InlineValuesRefreshRequest.method = `workspace/inlineValues/refresh`;
+    InlineValuesRefreshRequest.type = new messages_1.ProtocolRequestType0(InlineValuesRefreshRequest.method);
+})(InlineValuesRefreshRequest = exports.InlineValuesRefreshRequest || (exports.InlineValuesRefreshRequest = {}));
+//# sourceMappingURL=proposed.inlineValue.js.map

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

@@ -0,0 +1,361 @@
+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;
+}
+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;
+/**
+ * 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;
+}
+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;
+}
+/**
+ * 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 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. 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>;
+}