vscode-languageserver-protocol 3.17.0-next.2 → 3.17.0-next.20

package/lib/browser/main.js

@@ -19,7 +19,7 @@ const browser_1 = require("vscode-jsonrpc/browser");
 __exportStar(require("vscode-jsonrpc/browser"), exports);
 __exportStar(require("../common/api"), exports);
 function createProtocolConnection(reader, writer, logger, options) {
-    return browser_1.createMessageConnection(reader, writer, logger, options);
+    return (0, browser_1.createMessageConnection)(reader, writer, logger, options);
 }
 exports.createProtocolConnection = createProtocolConnection;
 //# sourceMappingURL=main.js.map

package/lib/common/api.d.ts

@@ -12,7 +12,38 @@ export declare namespace LSPErrorCodes {
     * @since 3.16.0
     */
     const lspReservedErrorRangeStart: integer;
+    /**
+     * A request failed but it was syntactically correct, e.g the
+     * method name was known and the parameters were valid. The error
+     * message should contain human readable information about why
+     * the request failed.
+     *
+     * @since 3.17.0
+     */
+    const RequestFailed: integer;
+    /**
+     * The server cancelled the request. This error code should
+     * only be used for requests that explicitly support being
+     * server cancellable.
+     *
+     * @since 3.17.0
+     */
+    const ServerCancelled: integer;
+    /**
+     * The server detected that the content of a document got
+     * modified outside normal conditions. A server should
+     * NOT send this error code if it detects a content change
+     * in it unprocessed messages. The result even computed
+     * on an older state might still be useful for the client.
+     *
+     * If a client decides that a result is not of any use anymore
+     * the client should cancel the request.
+     */
     const ContentModified: integer;
+    /**
+     * The client has canceled a request and a server as detected
+     * the cancel.
+     */
     const RequestCancelled: integer;
     /**
     * This is the end range of LSP reserved error codes.
@@ -22,15 +53,5 @@ export declare namespace LSPErrorCodes {
     */
     const lspReservedErrorRangeEnd: integer;
 }
-import * as diag from './proposed.diagnostic';
 export declare namespace Proposed {
-    type DiagnosticClientCapabilities = diag.DiagnosticClientCapabilities;
-    type $DiagnosticClientCapabilities = diag.$DiagnosticClientCapabilities;
-    type DiagnosticParams = diag.DiagnosticParams;
-    type DiagnosticOptions = diag.DiagnosticOptions;
-    type DiagnosticRegistrationOptions = diag.DiagnosticRegistrationOptions;
-    type $DiagnosticServerCapabilities = diag.$DiagnosticServerCapabilities;
-    type DiagnosticPullMode = diag.DiagnosticPullMode;
-    const DiagnosticPullMode: typeof diag.DiagnosticPullMode;
-    const DiagnosticRequest: typeof diag.DiagnosticRequest;
 }

package/lib/common/api.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Proposed = exports.LSPErrorCodes = exports.createProtocolConnection = void 0;
+exports.LSPErrorCodes = exports.createProtocolConnection = void 0;
 __exportStar(require("vscode-jsonrpc"), exports);
 __exportStar(require("vscode-languageserver-types"), exports);
 __exportStar(require("./messages"), exports);
@@ -30,7 +30,38 @@ var LSPErrorCodes;
     * @since 3.16.0
     */
     LSPErrorCodes.lspReservedErrorRangeStart = -32899;
+    /**
+     * A request failed but it was syntactically correct, e.g the
+     * method name was known and the parameters were valid. The error
+     * message should contain human readable information about why
+     * the request failed.
+     *
+     * @since 3.17.0
+     */
+    LSPErrorCodes.RequestFailed = -32803;
+    /**
+     * The server cancelled the request. This error code should
+     * only be used for requests that explicitly support being
+     * server cancellable.
+     *
+     * @since 3.17.0
+     */
+    LSPErrorCodes.ServerCancelled = -32802;
+    /**
+     * The server detected that the content of a document got
+     * modified outside normal conditions. A server should
+     * NOT send this error code if it detects a content change
+     * in it unprocessed messages. The result even computed
+     * on an older state might still be useful for the client.
+     *
+     * If a client decides that a result is not of any use anymore
+     * the client should cancel the request.
+     */
     LSPErrorCodes.ContentModified = -32801;
+    /**
+     * The client has canceled a request and a server as detected
+     * the cancel.
+     */
     LSPErrorCodes.RequestCancelled = -32800;
     /**
     * This is the end range of LSP reserved error codes.
@@ -40,10 +71,4 @@ var LSPErrorCodes;
     */
     LSPErrorCodes.lspReservedErrorRangeEnd = -32800;
 })(LSPErrorCodes = exports.LSPErrorCodes || (exports.LSPErrorCodes = {}));
-const diag = require("./proposed.diagnostic");
-var Proposed;
-(function (Proposed) {
-    Proposed.DiagnosticPullMode = diag.DiagnosticPullMode;
-    Proposed.DiagnosticRequest = diag.DiagnosticRequest;
-})(Proposed = exports.Proposed || (exports.Proposed = {}));
 //# sourceMappingURL=api.js.map

package/lib/common/connection.d.ts

@@ -1,4 +1,4 @@
-import { Message, NotificationMessage, CancellationToken, RequestHandler0, RequestHandler, GenericRequestHandler, NotificationHandler0, NotificationHandler, GenericNotificationHandler, ProgressType, Trace, Tracer, TraceOptions, Disposable, Event, MessageReader, MessageWriter, Logger, ConnectionStrategy, ConnectionOptions, RequestType0, RequestType, NotificationType0, NotificationType } from 'vscode-jsonrpc';
+import { Message, NotificationMessage, CancellationToken, RequestHandler0, RequestHandler, GenericRequestHandler, NotificationHandler0, NotificationHandler, GenericNotificationHandler, ProgressType, Trace, Tracer, TraceOptions, Disposable, Event, MessageReader, MessageWriter, Logger, ConnectionStrategy, ConnectionOptions, RequestType0, RequestType, NotificationType0, NotificationType, MessageSignature } from 'vscode-jsonrpc';
 import { ProtocolRequestType, ProtocolRequestType0, ProtocolNotificationType, ProtocolNotificationType0 } from './messages';
 export interface ProtocolConnection {
     /**
@@ -23,25 +23,26 @@ export interface ProtocolConnection {
     /**
      * Sends a request and returns a promise resolving to the result of the request.
      *
-     * @param method the request's method name.
+     * @param method the message signature or the method name.
      * @param token An optional cancellation token.
      * @returns A promise resolving to the request's result.
      */
-    sendRequest<R>(method: string, token?: CancellationToken): Promise<R>;
+    sendRequest<R>(method: MessageSignature | string, token?: CancellationToken): Promise<R>;
     /**
      * Sends a request and returns a promise resolving to the result of the request.
      *
-     * @param method the request's method name.
+     * @param method the message signature or the method name.
      * @param params The request's parameter.
      * @param token An optional cancellation token.
      * @returns A promise resolving to the request's result.
      */
-    sendRequest<R>(method: string, param: any, token?: CancellationToken): Promise<R>;
+    sendRequest<R>(method: MessageSignature | string, param: any, token?: CancellationToken): Promise<R>;
     /**
      * Installs a request handler.
      *
      * @param type The request type to install the handler for.
      * @param handler The actual handler.
+     * @returns A disposable to remove the handler.
      */
     onRequest<R, PR, E, RO>(type: ProtocolRequestType0<R, PR, E, RO>, handler: RequestHandler0<R, E>): Disposable;
     onRequest<R, E>(type: RequestType0<R, E>, handler: RequestHandler0<R, E>): Disposable;
@@ -50,49 +51,65 @@ export interface ProtocolConnection {
      *
      * @param type The request type to install the handler for.
      * @param handler The actual handler.
+     * @returns A disposable to remove the handler.
      */
     onRequest<P, R, PR, E, RO>(type: ProtocolRequestType<P, R, PR, E, RO>, handler: RequestHandler<P, R, E>): Disposable;
     onRequest<P, R, E>(type: RequestType<P, R, E>, handler: RequestHandler<P, R, E>): Disposable;
     /**
      * Installs a request handler.
      *
-     * @param methods The method name to install the handler for.
+     * @param methods the message signature or the method name to install a handler for.
      * @param handler The actual handler.
+     * @returns A disposable to remove the handler.
      */
-    onRequest<R, E>(method: string, handler: GenericRequestHandler<R, E>): Disposable;
+    onRequest<R, E>(method: MessageSignature | string, handler: GenericRequestHandler<R, E>): Disposable;
+    /**
+     * Returns true if the connection has a pending response.
+     * Otherwise false is returned.
+     */
+    hasPendingResponse(): boolean;
     /**
      * Sends a notification.
      *
      * @param type the notification's type to send.
+     * @returns A promise that resolves when the notification is written to the
+     * network layer.
      */
-    sendNotification(type: NotificationType0): void;
-    sendNotification<RO>(type: ProtocolNotificationType0<RO>): void;
+    sendNotification(type: NotificationType0): Promise<void>;
+    sendNotification<RO>(type: ProtocolNotificationType0<RO>): Promise<void>;
     /**
      * Sends a notification.
      *
      * @param type the notification's type to send.
      * @param params the notification's parameters.
+     * @returns A promise that resolves when the notification is written to the
+     * network layer.
      */
-    sendNotification<P, RO>(type: ProtocolNotificationType<P, RO>, params?: P): void;
-    sendNotification<P>(type: NotificationType<P>, params?: P): void;
+    sendNotification<P, RO>(type: ProtocolNotificationType<P, RO>, params?: P): Promise<void>;
+    sendNotification<P>(type: NotificationType<P>, params?: P): Promise<void>;
     /**
      * Sends a notification.
      *
-     * @param method the notification's method name.
+     * @param method the notification's method signature or the method name.
+     * @returns A promise that resolves when the notification is written to the
+     * network layer.
      */
-    sendNotification(method: string): void;
+    sendNotification(method: MessageSignature | string): Promise<void>;
     /**
      * Sends a notification.
      *
-     * @param method the notification's method name.
+     * @param method the notification's method signature or the method name.
      * @param params the notification's parameters.
+     * @returns A promise that resolves when the notification is written to the
+     * network layer.
      */
-    sendNotification(method: string, params: any): void;
+    sendNotification(method: MessageSignature | string, params: any): Promise<void>;
     /**
      * Installs a notification handler.
      *
      * @param type The notification type to install the handler for.
      * @param handler The actual handler.
+     * @returns A disposable to remove the handler.
      */
     onNotification<RO>(type: ProtocolNotificationType0<RO>, handler: NotificationHandler0): Disposable;
     onNotification(type: NotificationType0, handler: NotificationHandler0): Disposable;
@@ -101,21 +118,24 @@ export interface ProtocolConnection {
      *
      * @param type The notification type to install the handler for.
      * @param handler The actual handler.
+     * @returns A disposable to remove the handler.
      */
     onNotification<P, RO>(type: ProtocolNotificationType<P, RO>, handler: NotificationHandler<P>): Disposable;
     onNotification<P>(type: NotificationType<P>, handler: NotificationHandler<P>): Disposable;
     /**
      * Installs a notification handler.
      *
-     * @param methods The method name to install the handler for.
+     * @param methods The message signature or the method name to install the handler for.
      * @param handler The actual handler.
+     * @returns A disposable to remove the handler.
      */
-    onNotification(method: string, handler: GenericNotificationHandler): Disposable;
+    onNotification(method: MessageSignature | string, handler: GenericNotificationHandler): Disposable;
     /**
      * Installs a progress handler for a given token.
      * @param type the progress type
      * @param token the token
      * @param handler the handler
+     * @returns A disposable to remove the handler.
      */
     onProgress<P>(type: ProgressType<P>, token: string | number, handler: NotificationHandler<P>): Disposable;
     /**
@@ -123,13 +143,17 @@ export interface ProtocolConnection {
      * @param type the progress type
      * @param token the token to use
      * @param value the progress value
+     * @returns A promise that resolves when the progress is written to the
+     * network layer.
      */
-    sendProgress<P>(type: ProgressType<P>, token: string | number, value: P): void;
+    sendProgress<P>(type: ProgressType<P>, token: string | number, value: P): Promise<void>;
     /**
      * Enables tracing mode for the connection.
+     * @returns A promise that resolves when the trace value is written to the
+     * network layer.
      */
-    trace(value: Trace, tracer: Tracer, sendNotification?: boolean): void;
-    trace(value: Trace, tracer: Tracer, traceOptions?: TraceOptions): void;
+    trace(value: Trace, tracer: Tracer, sendNotification?: boolean): Promise<void>;
+    trace(value: Trace, tracer: Tracer, traceOptions?: TraceOptions): Promise<void>;
     /**
      * An event emitter firing when an error occurs on the connection.
      */
@@ -139,7 +163,7 @@ export interface ProtocolConnection {
      */
     onClose: Event<void>;
     /**
-     * An event emiiter firing when the connection receives a notification that is not
+     * An event emitter firing when the connection receives a notification that is not
      * handled.
      */
     onUnhandledNotification: Event<NotificationMessage>;

package/lib/common/connection.js

@@ -10,7 +10,7 @@ function createProtocolConnection(input, output, logger, options) {
     if (vscode_jsonrpc_1.ConnectionStrategy.is(options)) {
         options = { connectionStrategy: options };
     }
-    return vscode_jsonrpc_1.createMessageConnection(input, output, logger, options);
+    return (0, vscode_jsonrpc_1.createMessageConnection)(input, output, logger, options);
 }
 exports.createProtocolConnection = createProtocolConnection;
 //# sourceMappingURL=connection.js.map

package/lib/common/messages.js

@@ -36,7 +36,4 @@ class ProtocolNotificationType extends vscode_jsonrpc_1.NotificationType {
     }
 }
 exports.ProtocolNotificationType = ProtocolNotificationType;
-// let x: ProtocolNotificationType<number, { value: number}>;
-// let y: ProtocolNotificationType<string, { value: number}>;
-// x = y;
 //# sourceMappingURL=messages.js.map

package/lib/common/protocol.$.d.ts

@@ -0,0 +1,8 @@
+import { LogTraceParams, SetTraceParams } from 'vscode-jsonrpc';
+import { ProtocolNotificationType } from './messages';
+export declare namespace SetTraceNotification {
+    const type: ProtocolNotificationType<SetTraceParams, void>;
+}
+export declare namespace LogTraceNotification {
+    const type: ProtocolNotificationType<LogTraceParams, void>;
+}

package/lib/common/protocol.$.js

@@ -0,0 +1,19 @@
+"use strict";
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) TypeFox, Microsoft and others. 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.LogTraceNotification = exports.SetTraceNotification = void 0;
+const messages_1 = require("./messages");
+// This file is used to define the $ notification partly specified in JSON-RPC
+// so that we generate proper data for them in the meta model.
+var SetTraceNotification;
+(function (SetTraceNotification) {
+    SetTraceNotification.type = new messages_1.ProtocolNotificationType('$/setTrace');
+})(SetTraceNotification = exports.SetTraceNotification || (exports.SetTraceNotification = {}));
+var LogTraceNotification;
+(function (LogTraceNotification) {
+    LogTraceNotification.type = new messages_1.ProtocolNotificationType('$/logTrace');
+})(LogTraceNotification = exports.LogTraceNotification || (exports.LogTraceNotification = {}));
+//# sourceMappingURL=protocol.$.js.map

package/lib/common/protocol.callHierarchy.d.ts

@@ -1,7 +1,7 @@
 import { RequestHandler } from 'vscode-jsonrpc';
 import { CallHierarchyItem, CallHierarchyIncomingCall, CallHierarchyOutgoingCall } from 'vscode-languageserver-types';
 import { ProtocolRequestType } from './messages';
-import { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
+import type { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
 /**
  * @since 3.16.0
  */

package/lib/common/protocol.callHierarchy.js

@@ -1,6 +1,6 @@
 "use strict";
 /* --------------------------------------------------------------------------------------------
- * Copyright (c) TypeFox and others. All rights reserved.
+ * Copyright (c) TypeFox, Microsoft and others. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 Object.defineProperty(exports, "__esModule", { value: true });

package/lib/common/protocol.colorProvider.d.ts

@@ -1,7 +1,7 @@
 import { RequestHandler } from 'vscode-jsonrpc';
 import { TextDocumentIdentifier, Range, Color, ColorInformation, ColorPresentation } from 'vscode-languageserver-types';
 import { ProtocolRequestType } from './messages';
-import { TextDocumentRegistrationOptions, StaticRegistrationOptions, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
+import type { TextDocumentRegistrationOptions, StaticRegistrationOptions, PartialResultParams, WorkDoneProgressParams, WorkDoneProgressOptions } from './protocol';
 export interface DocumentColorClientCapabilities {
     /**
      * Whether implementation supports dynamic registration. If this is set to `true`

package/lib/common/protocol.configuration.d.ts

@@ -1,19 +1,7 @@
 import { RequestHandler, HandlerResult, CancellationToken } from 'vscode-jsonrpc';
+import { LSPAny } from 'vscode-languageserver-types';
 import { ProtocolRequestType } from './messages';
-import { PartialResultParams } from './protocol';
-export interface ConfigurationClientCapabilities {
-    /**
-     * The workspace client capabilities
-     */
-    workspace?: {
-        /**
-         * The client supports `workspace/configuration` requests.
-         *
-         * @since 3.6.0
-         */
-        configuration?: boolean;
-    };
-}
+import type { PartialResultParams } from './protocol';
 /**
  * The 'workspace/configuration' request is sent from the server to the client to fetch a certain
  * configuration setting.
@@ -24,9 +12,9 @@ export interface ConfigurationClientCapabilities {
  * change event and empty the cache if such an event is received.
  */
 export declare namespace ConfigurationRequest {
-    const type: ProtocolRequestType<ConfigurationParams & PartialResultParams, any[], never, void, void>;
-    type HandlerSignature = RequestHandler<ConfigurationParams, any[], void>;
-    type MiddlewareSignature = (params: ConfigurationParams, token: CancellationToken, next: HandlerSignature) => HandlerResult<any[], void>;
+    const type: ProtocolRequestType<ConfigurationParams & PartialResultParams, LSPAny[], never, void, void>;
+    type HandlerSignature = RequestHandler<ConfigurationParams, LSPAny[], void>;
+    type MiddlewareSignature = (params: ConfigurationParams, token: CancellationToken, next: HandlerSignature) => HandlerResult<LSPAny[], void>;
 }
 export interface ConfigurationItem {
     /**

package/lib/common/protocol.configuration.js

@@ -6,6 +6,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigurationRequest = void 0;
 const messages_1 = require("./messages");
+//---- Get Configuration request ----
 /**
  * The 'workspace/configuration' request is sent from the server to the client to fetch a certain
  * configuration setting.