vscode-languageserver-protocol 3.15.0-next.5 → 3.15.0-next.9

package/lib/protocol.progress.proposed.d.ts

@@ -1,21 +1,20 @@
-import { NotificationType, NotificationHandler } from 'vscode-jsonrpc';
-export interface ProgressClientCapabilities {
+import { NotificationType, NotificationHandler, RequestType, RequestHandler, ProgressType, ProgressToken } from 'vscode-jsonrpc';
+export interface WorkDoneProgressClientCapabilities {
     /**
      * Window specific client capabilities.
      */
     window?: {
         /**
-         * Whether client supports handling progress notifications.
+         * Whether client supports handling progress notifications. If set servers are allowed to
+         * report in `workDoneProgress` property in the request specific server capabilities.
+         *
+         * Since 3.15.0
          */
-        progress?: boolean;
+        workDoneProgress?: boolean;
     };
 }
-export interface ProgressStartParams {
-    /**
-     * A unique identifier to associate multiple progress notifications with
-     * the same progress.
-     */
-    id: string;
+export interface WorkDoneProgressBegin {
+    kind: 'begin';
     /**
      * Mandatory title of the progress operation. Used to briefly inform about
      * the kind of operation being performed.
@@ -47,19 +46,16 @@ export interface ProgressStartParams {
      */
     percentage?: number;
 }
-/**
- * The `window/progress/start` notification is sent from the server to the client
- * to initiate a progress.
- */
-export declare namespace ProgressStartNotification {
-    const type: NotificationType<ProgressStartParams, void>;
-    type HandlerSignature = NotificationHandler<ProgressStartParams>;
-}
-export interface ProgressReportParams {
+export interface WorkDoneProgressReport {
+    kind: 'report';
     /**
-     * A unique identifier to associate multiple progress notifications with the same progress.
+     * Controls enablement state of a cancel button. This property is only valid if a cancel
+     * button got requested in the `WorkDoneProgressStart` payload.
+     *
+     * Clients that don't support cancellation or don't support control the button's
+     * enablement state are allowed to ignore the setting.
      */
-    id: string;
+    cancellable?: boolean;
     /**
      * Optional, more detailed associated progress message. Contains
      * complementary information to the `title`.
@@ -78,39 +74,42 @@ export interface ProgressReportParams {
      */
     percentage?: number;
 }
-/**
- * The `window/progress/report` notification is sent from the server to the client
- * to initiate a progress.
- */
-export declare namespace ProgressReportNotification {
-    const type: NotificationType<ProgressReportParams, void>;
-    type HandlerSignature = NotificationHandler<ProgressReportParams>;
+export interface WorkDoneProgressEnd {
+    kind: 'end';
+    /**
+     * Optional, a final message indicating to for example indicate the outcome
+     * of the operation.
+     */
+    message?: string;
+}
+export declare namespace WorkDoneProgress {
+    const type: ProgressType<WorkDoneProgressBegin | WorkDoneProgressReport | WorkDoneProgressEnd>;
 }
-export interface ProgressDoneParams {
+export interface WorkDoneProgressCreateParams {
     /**
-     * A unique identifier to associate multiple progress notifications with the same progress.
+     * The token to be used to report progress.
      */
-    id: string;
+    token: ProgressToken;
 }
 /**
- * The `window/progress/done` notification is sent from the server to the client
- * to initiate a progress.
+ * The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress
+ * reporting from the server.
  */
-export declare namespace ProgressDoneNotification {
-    const type: NotificationType<ProgressDoneParams, void>;
-    type HandlerSignature = NotificationHandler<ProgressDoneParams>;
+export declare namespace WorkDoneProgressCreateRequest {
+    const type: RequestType<WorkDoneProgressCreateParams, void, void, void>;
+    type HandlerSignature = RequestHandler<WorkDoneProgressCreateParams, void, void>;
 }
-export interface ProgressCancelParams {
+export interface WorkDoneProgressCancelParams {
     /**
-     * A unique identifier to associate multiple progress notifications with the same progress.
+     * The token to be used to report progress.
      */
-    id: string;
+    token: ProgressToken;
 }
 /**
- * The `window/progress/cancel` notification is sent client to the server to cancel a progress
+ * The `window/workDoneProgress/cancel` notification is sent from  the client to the server to cancel a progress
  * initiated on the server side.
  */
-export declare namespace ProgressCancelNotification {
-    const type: NotificationType<ProgressCancelParams, void>;
-    type HandlerSignature = NotificationHandler<ProgressCancelParams>;
+export declare namespace WorkDoneProgressCancelNotification {
+    const type: NotificationType<WorkDoneProgressCancelParams, void>;
+    type HandlerSignature = NotificationHandler<WorkDoneProgressCancelParams>;
 }

package/lib/protocol.progress.proposed.js

@@ -5,35 +5,23 @@
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
 const vscode_jsonrpc_1 = require("vscode-jsonrpc");
+var WorkDoneProgress;
+(function (WorkDoneProgress) {
+    WorkDoneProgress.type = new vscode_jsonrpc_1.ProgressType();
+})(WorkDoneProgress = exports.WorkDoneProgress || (exports.WorkDoneProgress = {}));
 /**
- * The `window/progress/start` notification is sent from the server to the client
- * to initiate a progress.
+ * The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress
+ * reporting from the server.
  */
-var ProgressStartNotification;
-(function (ProgressStartNotification) {
-    ProgressStartNotification.type = new vscode_jsonrpc_1.NotificationType('window/progress/start');
-})(ProgressStartNotification = exports.ProgressStartNotification || (exports.ProgressStartNotification = {}));
+var WorkDoneProgressCreateRequest;
+(function (WorkDoneProgressCreateRequest) {
+    WorkDoneProgressCreateRequest.type = new vscode_jsonrpc_1.RequestType('window/workDoneProgress/create');
+})(WorkDoneProgressCreateRequest = exports.WorkDoneProgressCreateRequest || (exports.WorkDoneProgressCreateRequest = {}));
 /**
- * The `window/progress/report` notification is sent from the server to the client
- * to initiate a progress.
- */
-var ProgressReportNotification;
-(function (ProgressReportNotification) {
-    ProgressReportNotification.type = new vscode_jsonrpc_1.NotificationType('window/progress/report');
-})(ProgressReportNotification = exports.ProgressReportNotification || (exports.ProgressReportNotification = {}));
-/**
- * The `window/progress/done` notification is sent from the server to the client
- * to initiate a progress.
- */
-var ProgressDoneNotification;
-(function (ProgressDoneNotification) {
-    ProgressDoneNotification.type = new vscode_jsonrpc_1.NotificationType('window/progress/done');
-})(ProgressDoneNotification = exports.ProgressDoneNotification || (exports.ProgressDoneNotification = {}));
-/**
- * The `window/progress/cancel` notification is sent client to the server to cancel a progress
+ * The `window/workDoneProgress/cancel` notification is sent from  the client to the server to cancel a progress
  * initiated on the server side.
  */
-var ProgressCancelNotification;
-(function (ProgressCancelNotification) {
-    ProgressCancelNotification.type = new vscode_jsonrpc_1.NotificationType('window/progress/cancel');
-})(ProgressCancelNotification = exports.ProgressCancelNotification || (exports.ProgressCancelNotification = {}));
+var WorkDoneProgressCancelNotification;
+(function (WorkDoneProgressCancelNotification) {
+    WorkDoneProgressCancelNotification.type = new vscode_jsonrpc_1.NotificationType('window/workDoneProgress/cancel');
+})(WorkDoneProgressCancelNotification = exports.WorkDoneProgressCancelNotification || (exports.WorkDoneProgressCancelNotification = {}));

package/lib/protocol.selectionRange.d.ts

@@ -0,0 +1,39 @@
+import { RequestType, RequestHandler, ProgressType } from 'vscode-jsonrpc';
+import { TextDocumentIdentifier, Position, SelectionRange } from 'vscode-languageserver-types';
+import { TextDocumentRegistrationOptions, WorkDoneProgressOptions, StaticRegistrationOptions, WorkDoneProgressParams, PartialResultParams } from './protocol';
+export interface SelectionRangeClientCapabilities {
+    /**
+     * Whether implementation supports dynamic registration for selection range providers. If this is set to `true`
+     * the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server
+     * capability as well.
+     */
+    dynamicRegistration?: boolean;
+}
+export interface SelectionRangeOptions extends WorkDoneProgressOptions {
+}
+export interface SelectionRangeRegistrationOptions extends SelectionRangeOptions, TextDocumentRegistrationOptions, StaticRegistrationOptions {
+}
+/**
+ * A parameter literal used in selection range requests.
+ */
+export interface SelectionRangeParams extends WorkDoneProgressParams, PartialResultParams {
+    /**
+     * The text document.
+     */
+    textDocument: TextDocumentIdentifier;
+    /**
+     * The positions inside the text document.
+     */
+    positions: Position[];
+}
+/**
+ * A request to provide selection ranges in a document. The request's
+ * parameter is of type [SelectionRangeParams](#SelectionRangeParams), the
+ * response is of type [SelectionRange[]](#SelectionRange[]) or a Thenable
+ * that resolves to such.
+ */
+export declare namespace SelectionRangeRequest {
+    const type: RequestType<SelectionRangeParams, SelectionRange[] | null, any, SelectionRangeRegistrationOptions>;
+    const resultType: ProgressType<SelectionRange[]>;
+    type HandlerSignature = RequestHandler<SelectionRangeParams, SelectionRange[] | null, void>;
+}

package/lib/{protocol.selectionRange.proposed.js → protocol.selectionRange.js}

@@ -5,28 +5,6 @@
  *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
 const vscode_jsonrpc_1 = require("vscode-jsonrpc");
-const vscode_languageserver_types_1 = require("vscode-languageserver-types");
-/**
- * The SelectionRange namespace provides helper function to work with
- * SelectionRange literals.
- */
-var SelectionRange;
-(function (SelectionRange) {
-    /**
-     * Creates a new SelectionRange
-     * @param range the range.
-     * @param parent an optional parent.
-     */
-    function create(range, parent) {
-        return { range, parent };
-    }
-    SelectionRange.create = create;
-    function is(value) {
-        let candidate = value;
-        return candidate !== undefined && vscode_languageserver_types_1.Range.is(candidate.range) && (candidate.parent === undefined || SelectionRange.is(candidate.parent));
-    }
-    SelectionRange.is = is;
-})(SelectionRange = exports.SelectionRange || (exports.SelectionRange = {}));
 /**
  * A request to provide selection ranges in a document. The request's
  * parameter is of type [SelectionRangeParams](#SelectionRangeParams), the
@@ -36,4 +14,5 @@ var SelectionRange;
 var SelectionRangeRequest;
 (function (SelectionRangeRequest) {
     SelectionRangeRequest.type = new vscode_jsonrpc_1.RequestType('textDocument/selectionRange');
+    SelectionRangeRequest.resultType = new vscode_jsonrpc_1.ProgressType();
 })(SelectionRangeRequest = exports.SelectionRangeRequest || (exports.SelectionRangeRequest = {}));

package/lib/protocol.typeDefinition.d.ts

@@ -1,33 +1,28 @@
-import { RequestType, RequestHandler } from 'vscode-jsonrpc';
+import { RequestType, RequestHandler, ProgressType } from 'vscode-jsonrpc';
 import { Definition, DefinitionLink, LocationLink, Location } from 'vscode-languageserver-types';
-import { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams } from './protocol';
+import { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
+/**
+ * Since 3.6.0
+ */
 export interface TypeDefinitionClientCapabilities {
     /**
-     * The text document client capabilities
+     * Whether implementation supports dynamic registration. If this is set to `true`
+     * the client supports the new `TypeDefinitionRegistrationOptions` return value
+     * for the corresponding server capability as well.
      */
-    textDocument?: {
-        /**
-         * Capabilities specific to the `textDocument/typeDefinition`
-         */
-        typeDefinition?: {
-            /**
-             * 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 additional metadata in the form of definition links.
-             */
-            linkSupport?: boolean;
-        };
-    };
-}
-export interface TypeDefinitionServerCapabilities {
+    dynamicRegistration?: boolean;
     /**
-     * The server provides Goto Type Definition support.
+     * The client supports additional metadata in the form of definition links.
+     *
+     * Since 3.14.0
      */
-    typeDefinitionProvider?: boolean | (TextDocumentRegistrationOptions & StaticRegistrationOptions);
+    linkSupport?: boolean;
+}
+export interface TypeDefinitionOptions extends WorkDoneProgressOptions {
+}
+export interface TypeDefinitionRegistrationOptions extends TextDocumentRegistrationOptions, TypeDefinitionOptions, StaticRegistrationOptions {
+}
+export interface TypeDefinitionParams extends TextDocumentPositionParams, WorkDoneProgressParams, PartialResultParams {
 }
 /**
  * A request to resolve the type definition locations of a symbol at a given text
@@ -36,6 +31,7 @@ export interface TypeDefinitionServerCapabilities {
  * Thenable that resolves to such.
  */
 export declare namespace TypeDefinitionRequest {
-    const type: RequestType<TextDocumentPositionParams, Location | Location[] | LocationLink[] | null, void, TextDocumentRegistrationOptions>;
-    type HandlerSignature = RequestHandler<TextDocumentPositionParams, Definition | DefinitionLink[] | null, void>;
+    const type: RequestType<TypeDefinitionParams, Location | Location[] | LocationLink[] | null, void, TypeDefinitionRegistrationOptions>;
+    const resultType: ProgressType<Location[] | LocationLink[]>;
+    type HandlerSignature = RequestHandler<TypeDefinitionParams, Definition | DefinitionLink[] | null, void>;
 }

package/lib/protocol.typeDefinition.js

@@ -16,4 +16,5 @@ let __noDynamicImport;
 var TypeDefinitionRequest;
 (function (TypeDefinitionRequest) {
     TypeDefinitionRequest.type = new vscode_jsonrpc_1.RequestType('textDocument/typeDefinition');
+    TypeDefinitionRequest.resultType = new vscode_jsonrpc_1.ProgressType();
 })(TypeDefinitionRequest = exports.TypeDefinitionRequest || (exports.TypeDefinitionRequest = {}));

package/lib/utils/is.d.ts

@@ -7,3 +7,4 @@ export declare function array<T>(value: any): value is T[];
 export declare function stringArray(value: any): value is string[];
 export declare function typedArray<T>(value: any, check: (value: any) => boolean): value is T[];
 export declare function thenable<T>(value: any): value is Thenable<T>;
+export declare function objectLiteral(value: any): value is object;

package/lib/utils/is.js

@@ -40,3 +40,10 @@ function thenable(value) {
     return value && func(value.then);
 }
 exports.thenable = thenable;
+function objectLiteral(value) {
+    // Strictly speaking class instances pass this check as well. Since the LSP
+    // doesn't use classes we ignore this for now. If we do we need to add something
+    // like this: `Object.getPrototypeOf(Object.getPrototypeOf(x)) === null`
+    return value !== null && typeof value === 'object';
+}
+exports.objectLiteral = objectLiteral;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "vscode-languageserver-protocol",
 	"description": "VSCode Language Server Protocol implementation",
-	"version": "3.15.0-next.5",
+	"version": "3.15.0-next.9",
 	"author": "Microsoft Corporation",
 	"license": "MIT",
 	"repository": {
@@ -15,14 +15,14 @@
 	"main": "./lib/main.js",
 	"typings": "./lib/main",
 	"dependencies": {
-		"vscode-jsonrpc": "^4.1.0-next.2",
-		"vscode-languageserver-types": "3.15.0-next.1"
+		"vscode-jsonrpc": "^5.0.0-next.2",
+		"vscode-languageserver-types": "^3.15.0-next.5"
 	},
 	"scripts": {
 		"prepublishOnly": "npm run clean && npm run compile && npm test",
 		"postpublish": "node ../build/npm/post-publish.js",
-		"compile": "node ../build/bin/tsc -p ./tsconfig.json",
-		"watch": "node ../build/bin/tsc -w -p ./tsconfig.json",
+		"compile": "node ../build/bin/tsc -b ./tsconfig.json",
+		"watch": "node ../build/bin/tsc -b ./tsconfig.json -w",
 		"test": "node ../node_modules/mocha/bin/_mocha",
 		"clean": "node ../node_modules/rimraf/bin.js lib",
 		"preversion": "npm test"