@theia/plugin 1.28.0-next.8 → 1.29.0-next.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.28.0-next.8+d29ac061a13",
+  "version": "1.29.0-next.1+56190e693b7",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -27,10 +27,10 @@
     "watch": "theiaext watch"
   },
   "devDependencies": {
-    "@theia/ext-scripts": "1.27.0"
+    "@theia/ext-scripts": "1.28.0"
   },
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "d29ac061a13e962009140a8df50041479aa93966"
+  "gitHead": "56190e693b73f93cd05c428678895316e8d47c46"
 }

package/src/theia.d.ts

@@ -617,7 +617,7 @@ export module '@theia/plugin' {
      * Provides additional metadata over normal [location](#Location) definitions, including the range of
      * the defining symbol
      */
-    export interface DefinitionLink {
+    export interface LocationLink {
         /**
          * Span of the symbol being defined in the source file.
          *
@@ -2300,6 +2300,11 @@ export module '@theia/plugin' {
      * Options for configuration behavior of the quick pick
      */
     export interface QuickPickOptions {
+        /**
+         * An optional string that represents the title of the quick pick.
+         */
+        title?: string;
+
         /**
          * A flag to include the description when filtering
          */
@@ -6528,6 +6533,14 @@ export module '@theia/plugin' {
          */
         export const appRoot: string;
 
+        /**
+         * The hosted location of the application
+         * On desktop this is 'desktop'
+         * In the web this is the specified embedder i.e. 'github.dev', 'codespaces', or 'web' if the embedder
+         * does not provide that information
+         */
+        export const appHost: string;
+
         /**
          * The custom uri scheme the editor registers to in the operating system.
          */
@@ -6538,6 +6551,35 @@ export module '@theia/plugin' {
          */
         export const language: string;
 
+        /**
+         * Indicates that this is a fresh install of the application.
+         * `true` if within the first day of installation otherwise `false`.
+         */
+        export const isNewAppInstall: boolean;
+
+        /**
+         * Indicates whether the users has telemetry enabled.
+         * Can be observed to determine if the extension should send telemetry.
+         */
+        export const isTelemetryEnabled: boolean;
+
+        /**
+         * An {@link Event} which fires when the user enabled or disables telemetry.
+         * `true` if the user has enabled telemetry or `false` if the user has disabled telemetry.
+         */
+        export const onDidChangeTelemetryEnabled: Event<boolean>;
+
+        /**
+         * The name of a remote. Defined by extensions, popular samples are `wsl` for the Windows
+         * Subsystem for Linux or `ssh-remote` for remotes using a secure shell.
+         *
+         * *Note* that the value is `undefined` when there is no remote extension host but that the
+         * value is defined in all extension hosts (local and remote) in case a remote extension host
+         * exists. Use {@link Extension.extensionKind} to know if
+         * a specific extension runs remote or not.
+         */
+        export const remoteName: string | undefined;
+
         /**
          * The detected default shell for the extension host.
          */
@@ -6889,6 +6931,13 @@ export module '@theia/plugin' {
          */
         parameters: ParameterInformation[];
 
+        /**
+         * The index of the active parameter.
+         *
+         * If provided, this is used in place of SignatureHelp.activeParameter.
+         */
+        activeParameter?: number;
+
         /**
          * Creates a new signature information object.
          *
@@ -7840,10 +7889,12 @@ export module '@theia/plugin' {
     }
 
     /**
-     * Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
-     * including an origin range.
+     * Information about where a symbol is defined.
+     *
+     * Provides additional metadata over normal {@link Location} definitions, including the range of
+     * the defining symbol
      */
-    export type LocationLink = DefinitionLink;
+    export type DefinitionLink = LocationLink;
 
     /**
      * The declaration of a symbol representation as one or many {@link Location locations}
@@ -9609,6 +9660,11 @@ export module '@theia/plugin' {
          * A string to show as place holder in the input box to guide the user.
          */
         placeholder: string;
+
+        /**
+         * Controls whether the input box is visible (default is true).
+         */
+        visible: boolean;
     }
 
     interface QuickDiffProvider {
@@ -9851,6 +9907,20 @@ export module '@theia/plugin' {
         // Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_ProtocolMessage).
     }
 
+    /**
+     * A DebugProtocolBreakpoint is an opaque stand-in type for the [Breakpoint](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Breakpoint) type defined in the Debug Adapter Protocol.
+     */
+    export interface DebugProtocolBreakpoint {
+        // Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Breakpoint)
+    }
+
+    /**
+     * A DebugProtocolSource is an opaque stand-in type for the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol.
+     */
+    export interface DebugProtocolSource {
+        // Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source)
+    }
+
     /**
      * Configuration for a debug session.
      */
@@ -9910,6 +9980,15 @@ export module '@theia/plugin' {
          * Send a custom request to the debug adapter.
          */
         customRequest(command: string, args?: any): Thenable<any>;
+
+        /**
+         * Maps a breakpoint in the editor to the corresponding Debug Adapter Protocol (DAP) breakpoint that
+         * is managed by the debug adapter of the debug session. If no DAP breakpoint exists (either because
+         * the editor breakpoint was not yet registered or because the debug adapter is not interested in the
+         * breakpoint), the value undefined is returned.
+         * @param breakpoint a Breakpoint in the editor.
+         */
+        getDebugProtocolBreakpoint(breakpoint: Breakpoint): PromiseLike<DebugProtocolBreakpoint | undefined>
     }
 
     /**
@@ -10385,6 +10464,16 @@ export module '@theia/plugin' {
          */
         export function registerDebugAdapterDescriptorFactory(debugType: string, factory: DebugAdapterDescriptorFactory): Disposable;
 
+        /**
+         * Converts a "Source" descriptor object received via the Debug Adapter Protocol into a Uri that can be used to load its contents.
+         * If the source descriptor is based on a path, a file Uri is returned. If the source descriptor uses a reference number, a
+         * specific debug Uri (scheme 'debug') is constructed that requires a corresponding ContentProvider and a running debug session
+         * If the "Source" descriptor has insufficient information for creating the Uri, an error is thrown.
+         * @param source An object conforming to the Source type defined in the Debug Adapter Protocol.
+         * @param session An optional debug session that will be used when the source descriptor uses a reference number to load the contents from an active debug session.
+         */
+        export function asDebugSourceUri(source: DebugProtocolSource, session?: DebugSession): Uri;
+
         /**
          * Register a {@link DebugConfigurationProvider debug configuration provider} for a specific debug type.
          * The optional {@link DebugConfigurationProviderTriggerKind triggerKind} can be used to specify when the `provideDebugConfigurations` method of the provider is triggered.