@theia/plugin 1.18.0 → 1.21.0-next.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.18.0",
+  "version": "1.21.0-next.12+c8248f736ed",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -27,10 +27,10 @@
     "watch": "theiaext watch"
   },
   "devDependencies": {
-    "@theia/ext-scripts": "1.18.0"
+    "@theia/ext-scripts": "1.20.0"
   },
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "76318d01b7b3364cdf35ee456797699363f2634d"
+  "gitHead": "c8248f736edb4939155711987333ed39d9394b11"
 }

package/src/theia-proposed.d.ts

@@ -20,7 +20,7 @@
  * This is the place for API experiments and proposals.
  * These API are NOT stable and subject to change. Use it on own risk.
  */
-declare module '@theia/plugin' {
+export module '@theia/plugin' {
     // #region auth provider
 
     /**
@@ -557,7 +557,7 @@ declare module '@theia/plugin' {
          * Handle when the underlying resource for a custom editor is renamed.
          *
          * This allows the webview for the editor be preserved throughout the rename. If this method is not implemented,
-         * Theia will destory the previous custom editor and create a replacement one.
+         * Theia will destroy the previous custom editor and create a replacement one.
          *
          * @param newDocument New text document to use for the custom editor.
          * @param existingWebviewPanel Webview panel for the custom editor.

package/src/theia.d.ts

@@ -25,7 +25,7 @@ import './theia-proposed';
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable max-len */
 
-declare module '@theia/plugin' {
+export module '@theia/plugin' {
 
     /**
      * The version of the Theia API.
@@ -2395,6 +2395,13 @@ declare module '@theia/plugin' {
      */
     export interface MessageOptions {
 
+        /*
+         * Human-readable detail message that is rendered
+         * less prominent. Note that detail is only shown
+         * for modal messages.
+         */
+        detail?: string;
+
         /**
          * Indicates that this message should be modal.
          */
@@ -7320,6 +7327,18 @@ declare module '@theia/plugin' {
         constructor(uri: Uri, rangeOrPosition: Range | Position);
     }
 
+    /**
+     * Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
+     * including an origin range.
+     */
+    export type LocationLink = DefinitionLink;
+
+    /**
+     * The declaration of a symbol representation as one or many {@link Location locations}
+     * or {@link LocationLink location links}.
+     */
+    export type Declaration = Location | Location[] | LocationLink[];
+
     /**
      * The event that is fired when diagnostics change.
      */
@@ -9178,6 +9197,13 @@ declare module '@theia/plugin' {
         export function createSourceControl(id: string, label: string, rootUri?: Uri): SourceControl;
     }
 
+    /**
+     * A DebugProtocolMessage is an opaque stand-in type for the [ProtocolMessage](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_ProtocolMessage) type defined in the Debug Adapter Protocol.
+     */
+    export interface DebugProtocolMessage {
+        // Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_ProtocolMessage).
+    }
+
     /**
      * Configuration for a debug session.
      */
@@ -9445,7 +9471,53 @@ declare module '@theia/plugin' {
         constructor(port: number, host?: string);
     }
 
-    export type DebugAdapterDescriptor = DebugAdapterExecutable | DebugAdapterServer;
+    /**
+     * Represents a debug adapter running as a Named Pipe (on Windows)/UNIX Domain Socket (on non-Windows) based server.
+     */
+    export class DebugAdapterNamedPipeServer {
+        /**
+         * The path to the NamedPipe/UNIX Domain Socket.
+         */
+        readonly path: string;
+
+        /**
+         * Create a description for a debug adapter running as a Named Pipe (on Windows)/UNIX Domain Socket (on non-Windows) based server.
+         */
+        constructor(path: string);
+    }
+
+    /**
+     * A debug adapter that implements the Debug Adapter Protocol can be registered with the editor if it implements the DebugAdapter interface.
+     */
+    export interface DebugAdapter extends Disposable {
+
+        /**
+         * An event which fires after the debug adapter has sent a Debug Adapter Protocol message to the editor.
+         * Messages can be requests, responses, or events.
+         */
+        readonly onDidSendMessage: Event<DebugProtocolMessage>;
+
+        /**
+         * Handle a Debug Adapter Protocol message.
+         * Messages can be requests, responses, or events.
+         * Results or errors are returned via onSendMessage events.
+         * @param message A Debug Adapter Protocol message
+         */
+        handleMessage(message: DebugProtocolMessage): void;
+    }
+
+    /**
+     * A debug adapter descriptor for an inline implementation.
+     */
+    export class DebugAdapterInlineImplementation {
+
+        /**
+         * Create a descriptor for an inline implementation of a debug adapter.
+         */
+        constructor(implementation: DebugAdapter);
+    }
+
+    export type DebugAdapterDescriptor = DebugAdapterExecutable | DebugAdapterServer | DebugAdapterNamedPipeServer | DebugAdapterInlineImplementation;
 
     export interface DebugAdapterDescriptorFactory {
         /**
@@ -10735,6 +10807,12 @@ declare module '@theia/plugin' {
          */
         tags?: readonly SymbolTag[];
 
+        /**
+         * A data entry field that is preserved between a call hierarchy prepare and
+         * incoming calls or outgoing calls requests.
+         */
+        data?: unknown;
+
         /**
          * Creates a new call hierarchy item.
          */
@@ -10810,7 +10888,7 @@ declare module '@theia/plugin' {
          * @returns A call hierarchy item or a thenable that resolves to such. The lack of a result can be
          * signaled by returning `undefined` or `null`.
          */
-        prepareCallHierarchy(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CallHierarchyItem>;
+        prepareCallHierarchy(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CallHierarchyItem | CallHierarchyItem[]>;
 
         /**
          * Provide all incoming calls for an item, e.g all callers for a method. In graph terms this describes directed
@@ -10969,4 +11047,3 @@ declare module '@theia/plugin' {
         export const onDidChangeSessions: Event<AuthenticationSessionsChangeEvent>;
     }
 }
-