@opensumi/sumi 3.4.5 → 3.4.6-next-1730347271.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensumi/sumi",
-  "version": "3.4.5",
+  "version": "3.4.6-next-1730347271.0",
   "typings": "index.d.ts",
   "license": "MIT",
   "repository": {
@@ -12,11 +12,11 @@
     "build": "tsx ./build.ts"
   },
   "dependencies": {
-    "@opensumi/ide-components": "3.4.5",
+    "@opensumi/ide-components": "3.4.6-next-1730347271.0",
     "vscode-uri": "3.0.2"
   },
   "devDependencies": {
     "@types/react": "^18.2.0"
   },
-  "gitHead": "26f3ee057d0a1938de14a8977e12c2972f46c9e4"
+  "gitHead": "dc271e0c7c32f35a75bd4e45f28167773c912d13"
 }

package/sumi-worker/worker.editor.d.ts

@@ -543,24 +543,35 @@ declare module 'sumi-worker' {
     Nine = 9,
   }
 
+  /**
+   * Additional data about a workspace edit.
+   */
+  export interface WorkspaceEditMetadata {
+    /**
+     * Signal to the editor that this edit is a refactoring.
+     */
+    isRefactoring?: boolean;
+  }
+
   export namespace workspace {
     /**
      * Make changes to one or many resources or create, delete, and rename resources as defined by the given
-     * [workspace edit](#WorkspaceEdit).
+     * {@link WorkspaceEdit workspace edit}.
      *
      * All changes of a workspace edit are applied in the same order in which they have been added. If
      * multiple textual inserts are made at the same position, these strings appear in the resulting text
-     * in the order the 'inserts' were made. Invalid sequences like 'delete file a' -> 'insert text in file a'
-     * cause failure of the operation.
+     * in the order the 'inserts' were made, unless that are interleaved with resource edits. Invalid sequences
+     * like 'delete file a' -> 'insert text in file a' cause failure of the operation.
      *
      * When applying a workspace edit that consists only of text edits an 'all-or-nothing'-strategy is used.
      * A workspace edit with resource creations or deletions aborts the operation, e.g. consecutive edits will
      * not be attempted, when a single edit fails.
      *
      * @param edit A workspace edit.
-     * @return A thenable that resolves when the edit could be applied.
+     * @param metadata Optional {@link WorkspaceEditMetadata metadata} for the edit.
+     * @returns A thenable that resolves when the edit could be applied.
      */
-    export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;
+    export function applyEdit(edit: WorkspaceEdit, metadata?: WorkspaceEditMetadata): Thenable<boolean>;
   }
 
   export namespace window {

package/vscode/typings/vscode.authentication.d.ts

@@ -40,6 +40,16 @@ declare module 'vscode' {
     readonly label: string;
   }
 
+  /**
+	 * Optional options to be used when calling {@link authentication.getSession} with the flag `forceNewSession`.
+	 */
+	export interface AuthenticationForceNewSessionOptions {
+		/**
+		 * An optional message that will be displayed to the user when we ask to re-authenticate. Providing additional context
+		 * as to why you are asking a user to re-authenticate can help increase the odds that they will accept.
+		 */
+		detail?: string;
+	}
 
   /**
    * Options to be used when getting an {@link AuthenticationSession} from an {@link AuthenticationProvider}.
@@ -60,14 +70,17 @@ declare module 'vscode' {
     createIfNone?: boolean;
 
     /**
-     * Whether we should attempt to reauthenticate even if there is already a session available.
-     *
-     * If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios
-     * where the token needs to be re minted because it has lost some authorization.
-     *
-     * Defaults to false.
-     */
-    forceNewSession?: boolean | { detail: string };
+		 * Whether we should attempt to reauthenticate even if there is already a session available.
+		 *
+		 * If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios
+		 * where the token needs to be re minted because it has lost some authorization.
+		 *
+		 * If there are no existing sessions and forceNewSession is true, it will behave identically to
+		 * {@link AuthenticationGetSessionOptions.createIfNone createIfNone}.
+		 *
+		 * This defaults to false.
+		 */
+		forceNewSession?: boolean | AuthenticationForceNewSessionOptions;
 
 
     /**
@@ -202,34 +215,49 @@ declare module 'vscode' {
    */
   export namespace authentication {
     /**
-     * Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
-     * registered, or if the user does not consent to sharing authentication information with
-     * the extension. If there are multiple sessions with the same scopes, the user will be shown a
-     * quickpick to select which account they would like to use.
-     *
-     * Currently, there are only two authentication providers that are contributed from built in extensions
-     * to VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.
-     * @param providerId The id of the provider to use
-     * @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
-     * @param options The {@link GetSessionOptions} to use
-     * @returns A thenable that resolves to an authentication session
-     */
-    export function getSession(providerId: string, scopes: string[], options: AuthenticationGetSessionOptions & { createIfNone: true }): Thenable<AuthenticationSession>;
+		 * Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
+		 * registered, or if the user does not consent to sharing authentication information with
+		 * the extension. If there are multiple sessions with the same scopes, the user will be shown a
+		 * quickpick to select which account they would like to use.
+		 *
+		 * Currently, there are only two authentication providers that are contributed from built in extensions
+		 * to the editor that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.
+		 * @param providerId The id of the provider to use
+		 * @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
+		 * @param options The {@link AuthenticationGetSessionOptions} to use
+		 * @returns A thenable that resolves to an authentication session
+		 */
+		export function getSession(providerId: string, scopes: readonly string[], options: AuthenticationGetSessionOptions & { /** */createIfNone: true }): Thenable<AuthenticationSession>;
 
-    /**
-     * Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
-     * registered, or if the user does not consent to sharing authentication information with
-     * the extension. If there are multiple sessions with the same scopes, the user will be shown a
-     * quickpick to select which account they would like to use.
-     *
-     * Currently, there are only two authentication providers that are contributed from built in extensions
-     * to VS Code that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.
-     * @param providerId The id of the provider to use
-     * @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
-     * @param options The {@link GetSessionOptions} to use
-     * @returns A thenable that resolves to an authentication session if available, or undefined if there are no sessions
-     */
-    export function getSession(providerId: string, scopes: string[], options?: AuthenticationGetSessionOptions): Thenable<AuthenticationSession | undefined>;
+		/**
+		 * Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
+		 * registered, or if the user does not consent to sharing authentication information with
+		 * the extension. If there are multiple sessions with the same scopes, the user will be shown a
+		 * quickpick to select which account they would like to use.
+		 *
+		 * Currently, there are only two authentication providers that are contributed from built in extensions
+		 * to the editor that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.
+		 * @param providerId The id of the provider to use
+		 * @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
+		 * @param options The {@link AuthenticationGetSessionOptions} to use
+		 * @returns A thenable that resolves to an authentication session
+		 */
+		export function getSession(providerId: string, scopes: readonly string[], options: AuthenticationGetSessionOptions & { /** literal-type defines return type */forceNewSession: true | AuthenticationForceNewSessionOptions }): Thenable<AuthenticationSession>;
+
+		/**
+		 * Get an authentication session matching the desired scopes. Rejects if a provider with providerId is not
+		 * registered, or if the user does not consent to sharing authentication information with
+		 * the extension. If there are multiple sessions with the same scopes, the user will be shown a
+		 * quickpick to select which account they would like to use.
+		 *
+		 * Currently, there are only two authentication providers that are contributed from built in extensions
+		 * to the editor that implement GitHub and Microsoft authentication: their providerId's are 'github' and 'microsoft'.
+		 * @param providerId The id of the provider to use
+		 * @param scopes A list of scopes representing the permissions requested. These are dependent on the authentication provider
+		 * @param options The {@link AuthenticationGetSessionOptions} to use
+		 * @returns A thenable that resolves to an authentication session if available, or undefined if there are no sessions
+		 */
+		export function getSession(providerId: string, scopes: readonly string[], options?: AuthenticationGetSessionOptions): Thenable<AuthenticationSession | undefined>;
 
     /**
      * An {@link Event} which fires when the authentication sessions of an authentication provider have

package/vscode/typings/vscode.d.ts

@@ -1480,6 +1480,16 @@ declare module 'vscode' {
     iconPath?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
   }
 
+  /**
+	 * Additional data about a workspace edit.
+	 */
+	export interface WorkspaceEditMetadata {
+		/**
+		 * Signal to the editor that this edit is a refactoring.
+		 */
+		isRefactoring?: boolean;
+	}
+
   /**
    * A workspace edit is a collection of textual and files changes for
    * multiple resources and documents.
@@ -4034,6 +4044,28 @@ declare module 'vscode' {
     provideDocumentRangeSemanticTokens(document: TextDocument, range: Range, token: CancellationToken): ProviderResult<SemanticTokens>;
   }
 
+  /**
+	 * Provider which handles dropping of resources into a text editor.
+	 *
+	 * This allows users to drag and drop resources (including resources from external apps) into the editor. While dragging
+	 * and dropping files, users can hold down `shift` to drop the file into the editor instead of opening it.
+	 * Requires `editor.dropIntoEditor.enabled` to be on.
+	 */
+	export interface DocumentDropEditProvider {
+		/**
+		 * Provide edits which inserts the content being dragged and dropped into the document.
+		 *
+		 * @param document The document in which the drop occurred.
+		 * @param position The position in the document where the drop occurred.
+		 * @param dataTransfer A {@link DataTransfer} object that holds data about what is being dragged and dropped.
+		 * @param token A cancellation token.
+		 *
+		 * @returns A {@link DocumentDropEdit} or a thenable that resolves to such. The lack of a result can be
+		 * signaled by returning `undefined` or `null`.
+		 */
+		provideDocumentDropEdits(document: TextDocument, position: Position, dataTransfer: DataTransfer, token: CancellationToken): ProviderResult<DocumentDropEdit>;
+	}
+
   //#endregion Semantic Tokens
 
   /**

package/vscode/typings/vscode.language.d.ts

@@ -483,6 +483,16 @@ declare module 'vscode' {
      */
     export function registerDocumentRangeSemanticTokensProvider(selector: DocumentSelector, provider: DocumentRangeSemanticTokensProvider, legend: SemanticTokensLegend): Disposable;
 
+    /**
+		 * Registers a new {@link DocumentDropEditProvider}.
+		 *
+		 * @param selector A selector that defines the documents this provider applies to.
+		 * @param provider A drop provider.
+		 *
+		 * @returns A {@link Disposable} that unregisters this provider when disposed of.
+		 */
+		export function registerDocumentDropEditProvider(selector: DocumentSelector, provider: DocumentDropEditProvider): Disposable;
+
     /**
      * Register a provider that locates evaluatable expressions in text documents.
      * VS Code will evaluate the expression in the active debug session and will show the result in the debug hover.
@@ -1584,6 +1594,47 @@ declare module 'vscode' {
      */
     Outdent = 3,
   }
+
+  /**
+	 * Enumeration of commonly encountered syntax token types.
+	 */
+	export enum SyntaxTokenType {
+		/**
+		 * Everything except tokens that are part of comments, string literals and regular expressions.
+		 */
+		Other = 0,
+		/**
+		 * A comment.
+		 */
+		Comment = 1,
+		/**
+		 * A string literal.
+		 */
+		String = 2,
+		/**
+		 * A regular expression.
+		 */
+		RegEx = 3
+	}
+
+  /**
+	 * Describes pairs of strings where the close string will be automatically inserted when typing the opening string.
+	 */
+	export interface AutoClosingPair {
+		/**
+		 * The string that will trigger the automatic insertion of the closing string.
+		 */
+		open: string;
+		/**
+		 * The closing string that will be automatically inserted when typing the opening string.
+		 */
+		close: string;
+		/**
+		 * A set of tokens where the pair should not be auto closed.
+		 */
+		notIn?: SyntaxTokenType[];
+	}
+
   export interface LanguageConfiguration {
     /**
      * The language's comment settings.
@@ -1610,6 +1661,10 @@ declare module 'vscode' {
      * The language's rules to be evaluated when pressing Enter.
      */
     onEnterRules?: OnEnterRule[];
+    /**
+     * The language's auto closing pairs.
+     */
+    autoClosingPairs?: AutoClosingPair[];
 
     /**
      * **Deprecated** Do not use.
@@ -2375,6 +2430,25 @@ declare module 'vscode' {
      * signaled by returning `undefined`, `null`, or an empty array.
      */
     provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
+
+    /**
+		 * Provide formatting edits for multiple ranges in a document.
+		 *
+		 * This function is optional but allows a formatter to perform faster when formatting only modified ranges or when
+		 * formatting a large number of selections.
+		 *
+		 * The given ranges are hints and providers can decide to format a smaller
+		 * or larger range. Often this is done by adjusting the start and end
+		 * of the range to full syntax nodes.
+		 *
+		 * @param document The document in which the command was invoked.
+		 * @param ranges The ranges which should be formatted.
+		 * @param options Options controlling formatting.
+		 * @param token A cancellation token.
+		 * @returns A set of text edits or a thenable that resolves to such. The lack of a result can be
+		 * signaled by returning `undefined`, `null`, or an empty array.
+		 */
+		provideDocumentRangesFormattingEdits?(document: TextDocument, ranges: Range[], options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
   }
 
   /**

package/vscode/typings/vscode.proposed.documentPaste.d.ts

@@ -0,0 +1,196 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'vscode' {
+
+	// https://github.com/microsoft/vscode/issues/30066/
+
+	/**
+	 * The reason why paste edits were requested.
+	 */
+	export enum DocumentPasteTriggerKind {
+		/**
+		 * Pasting was requested as part of a normal paste operation.
+		 */
+		Automatic = 0,
+
+		/**
+		 * Pasting was requested by the user with the `paste as` command.
+		 */
+		PasteAs = 1,
+	}
+
+	/**
+	 * Additional information about the paste operation.
+	 */
+
+	export interface DocumentPasteEditContext {
+		/**
+		 * Requested kind of paste edits to return.
+		 */
+		readonly only: DocumentPasteEditKind | undefined;
+
+		/**
+		 * The reason why paste edits were requested.
+		 */
+		readonly triggerKind: DocumentPasteTriggerKind;
+	}
+
+	/**
+	 * Provider invoked when the user copies or pastes in a {@linkcode TextDocument}.
+	 */
+	interface DocumentPasteEditProvider<T extends DocumentPasteEdit = DocumentPasteEdit> {
+
+		/**
+		 * Optional method invoked after the user copies text in a file.
+		 *
+		 * This allows the provider to attach copy metadata to the {@link DataTransfer}
+		 * which is then passed back to providers in {@linkcode provideDocumentPasteEdits}.
+		 *
+		 * Note that currently any changes to the {@linkcode DataTransfer} are isolated to the current editor session.
+		 * This means that added metadata cannot be seen by other applications.
+		 *
+		 * @param document Document where the copy took place.
+		 * @param ranges Ranges being copied in {@linkcode document}.
+		 * @param dataTransfer The data transfer associated with the copy. You can store additional values on this for later use in  {@linkcode provideDocumentPasteEdits}.
+		 * This object is only valid for the duration of this method.
+		 * @param token A cancellation token.
+		 *
+		 * @return Optional thenable that resolves when all changes to the `dataTransfer` are complete.
+		 */
+		prepareDocumentPaste?(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, token: CancellationToken): void | Thenable<void>;
+
+		/**
+		 * Invoked before the user pastes into a document.
+		 *
+		 * Returned edits can replace the standard pasting behavior.
+		 *
+		 * @param document Document being pasted into
+		 * @param ranges Range in the {@linkcode document} to paste into.
+		 * @param dataTransfer The {@link DataTransfer data transfer} associated with the paste. This object is only valid for the duration of the paste operation.
+		 * @param context Additional context for the paste.
+		 * @param token A cancellation token.
+		 *
+		 * @return Set of potential {@link DocumentPasteEdit edits} that apply the paste. Return `undefined` to use standard pasting.
+		 */
+		provideDocumentPasteEdits?(document: TextDocument, ranges: readonly Range[], dataTransfer: DataTransfer, context: DocumentPasteEditContext, token: CancellationToken): ProviderResult<T[]>;
+
+		/**
+		 * Optional method which fills in the {@linkcode DocumentPasteEdit.additionalEdit} before the edit is applied.
+		 *
+		 * This is called once per edit and should be used if generating the complete edit may take a long time.
+		 * Resolve can only be used to change {@link DocumentPasteEdit.additionalEdit}.
+		 *
+		 * @param pasteEdit The {@linkcode DocumentPasteEdit} to resolve.
+		 * @param token A cancellation token.
+		 *
+		 * @returns The resolved paste edit or a thenable that resolves to such. It is OK to return the given
+		 * `pasteEdit`. If no result is returned, the given `pasteEdit` is used.
+		 */
+		resolveDocumentPasteEdit?(pasteEdit: T, token: CancellationToken): ProviderResult<T>;
+	}
+
+	/**
+	 * An edit applied on paste.
+	 */
+	class DocumentPasteEdit {
+
+		/**
+		 * Human readable label that describes the edit.
+		 */
+		title: string;
+
+		/**
+		 * {@link DocumentPasteEditKind Kind} of the edit.
+		 *
+		 * Used to identify specific types of edits.
+		 */
+		kind: DocumentPasteEditKind;
+
+		/**
+		 * The text or snippet to insert at the pasted locations.
+		 */
+		insertText: string | SnippetString;
+
+		/**
+		 * An optional additional edit to apply on paste.
+		 */
+		additionalEdit?: WorkspaceEdit;
+
+		/**
+		 * Controls the ordering of paste edits provided by multiple providers.
+		 *
+		 * If this edit yields to another, it will be shown lower in the list of paste edit.
+		 */
+		yieldTo?: readonly DocumentPasteEditKind[];
+
+		/**
+		 * Create a new paste edit.
+		 *
+		 * @param insertText The text or snippet to insert at the pasted locations.
+		 * @param title Human readable label that describes the edit.
+		 * @param kind {@link DocumentPasteEditKind Kind} of the edit.
+		 */
+		constructor(insertText: string | SnippetString, title: string, kind: DocumentPasteEditKind);
+	}
+
+
+	/**
+	 * TODO: Share with code action kind?
+	 */
+	class DocumentPasteEditKind {
+		static readonly Empty: DocumentPasteEditKind;
+
+		// TODO: Add `Text` any others?
+
+		private constructor(value: string);
+
+		readonly value: string;
+
+		append(...parts: string[]): CodeActionKind;
+		intersects(other: CodeActionKind): boolean;
+		contains(other: CodeActionKind): boolean;
+	}
+
+	interface DocumentPasteProviderMetadata {
+		/**
+		 * List of {@link DocumentPasteEditKind kinds} that the provider may return in {@linkcode DocumentPasteEditProvider.provideDocumentPasteEdits provideDocumentPasteEdits}.
+		 *
+		 * The provider will only be invoked when one of these kinds is being requested. For normal pasting, all providers will be invoked.
+		 */
+		readonly providedPasteEditKinds: readonly DocumentPasteEditKind[];
+
+		/**
+		 * Mime types that {@linkcode DocumentPasteEditProvider.prepareDocumentPaste prepareDocumentPaste} may add on copy.
+		 */
+		readonly copyMimeTypes?: readonly string[];
+
+		/**
+		 * Mime types that {@linkcode DocumentPasteEditProvider.provideDocumentPasteEdits provideDocumentPasteEdits} should be invoked for.
+		 *
+		 * This can either be an exact mime type such as `image/png`, or a wildcard pattern such as `image/*`.
+		 *
+		 * Use `text/uri-list` for resources dropped from the explorer or other tree views in the workbench.
+		 *
+		 * Use `files` to indicate that the provider should be invoked if any {@link DataTransferFile files} are present in the {@linkcode DataTransfer}.
+		 * Note that {@linkcode DataTransferFile} entries are only created when dropping content from outside the editor, such as
+		 * from the operating system.
+		 */
+		readonly pasteMimeTypes?: readonly string[];
+	}
+
+	namespace languages {
+		/**
+		 * Registers a new {@linkcode DocumentPasteEditProvider}.
+		 *
+		 * @param selector A selector that defines the documents this provider applies to.
+		 * @param provider A paste editor provider.
+		 * @param metadata Additional metadata about the provider.
+		 *
+		 * @returns A {@link Disposable} that unregisters this provider when disposed of.
+		 */
+		export function registerDocumentPasteEditProvider(selector: DocumentSelector, provider: DocumentPasteEditProvider, metadata: DocumentPasteProviderMetadata): Disposable;
+	}
+}

package/vscode/typings/vscode.proposed.dropMetadata.d.ts

@@ -0,0 +1,61 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'vscode' {
+
+	// https://github.com/microsoft/vscode/issues/179430
+
+
+	/**
+	 * TODO:
+	 * - Add ctor(insertText: string | SnippetString, title?: string, kind?: DocumentPasteEditKind); Can't be done as this is an extension to an existing class
+	 * - Update provider to return multiple edits
+	 */
+
+	export interface DocumentDropEdit {
+		/**
+		 * Human readable label that describes the edit.
+		 */
+		title?: string;
+
+		/**
+		 * {@link DocumentPasteEditKind Kind} of the edit.
+		 *
+		 * Used to identify specific types of edits.
+		 *
+		 * TODO: use own type?
+		 */
+		kind: DocumentPasteEditKind;
+
+		/**
+		 * The mime type from the {@link DataTransfer} that this edit applies.
+		 *
+		 * TODO: Should this be taken from `dropMimeTypes` instead?
+		 */
+		handledMimeType?: string;
+
+		/**
+		 * Controls the ordering or multiple paste edits. If this provider yield to edits, it will be shown lower in the list.
+		 */
+		yieldTo?: ReadonlyArray<DocumentPasteEditKind>;
+	}
+
+	export interface DocumentDropEditProviderMetadata {
+		readonly providedDropEditKinds?: readonly DocumentPasteEditKind[];
+
+		/**
+		 * List of {@link DataTransfer} mime types that the provider can handle.
+		 *
+		 * This can either be an exact mime type such as `image/png`, or a wildcard pattern such as `image/*`.
+		 *
+		 * Use `text/uri-list` for resources dropped from the explorer or other tree views in the workbench.
+		 *
+		 * Use `files` to indicate that the provider should be invoked if any {@link DataTransferFile files} are present in the {@link DataTransfer}.
+		 * Note that {@link DataTransferFile} entries are only created when dropping content from outside the editor, such as
+		 * from the operating system.
+		 */
+		readonly dropMimeTypes: readonly string[];
+	}
+}

package/vscode/typings/vscode.quickpick.d.ts

@@ -31,6 +31,11 @@ declare module 'vscode' {
      */
     kind?: QuickPickItemKind;
 
+    /**
+     * The icon path or {@link ThemeIcon} for the QuickPickItem.
+     */
+    iconPath?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
+
     /**
      * A human readable string which is rendered less prominent.
      */

package/vscode/typings/vscode.workspace.d.ts

@@ -57,22 +57,23 @@ declare module 'vscode' {
     export function getWorkspaceFolder(uri: Uri): WorkspaceFolder | undefined;
 
     /**
-     * Make changes to one or many resources or create, delete, and rename resources as defined by the given
-     * [workspace edit](#WorkspaceEdit).
-     *
-     * All changes of a workspace edit are applied in the same order in which they have been added. If
-     * multiple textual inserts are made at the same position, these strings appear in the resulting text
-     * in the order the 'inserts' were made. Invalid sequences like 'delete file a' -> 'insert text in file a'
-     * cause failure of the operation.
-     *
-     * When applying a workspace edit that consists only of text edits an 'all-or-nothing'-strategy is used.
-     * A workspace edit with resource creations or deletions aborts the operation, e.g. consecutive edits will
-     * not be attempted, when a single edit fails.
-     *
-     * @param edit A workspace edit.
-     * @return A thenable that resolves when the edit could be applied.
-     */
-    export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;
+		 * Make changes to one or many resources or create, delete, and rename resources as defined by the given
+		 * {@link WorkspaceEdit workspace edit}.
+		 *
+		 * All changes of a workspace edit are applied in the same order in which they have been added. If
+		 * multiple textual inserts are made at the same position, these strings appear in the resulting text
+		 * in the order the 'inserts' were made, unless that are interleaved with resource edits. Invalid sequences
+		 * like 'delete file a' -> 'insert text in file a' cause failure of the operation.
+		 *
+		 * When applying a workspace edit that consists only of text edits an 'all-or-nothing'-strategy is used.
+		 * A workspace edit with resource creations or deletions aborts the operation, e.g. consecutive edits will
+		 * not be attempted, when a single edit fails.
+		 *
+		 * @param edit A workspace edit.
+		 * @param metadata Optional {@link WorkspaceEditMetadata metadata} for the edit.
+		 * @returns A thenable that resolves when the edit could be applied.
+		 */
+		export function applyEdit(edit: WorkspaceEdit, metadata?: WorkspaceEditMetadata): Thenable<boolean>;
 
     /**
      * Get a workspace configuration object.

package/vscode.d.ts

@@ -49,3 +49,5 @@
 /// <reference path='./vscode/typings/vscode.proposed.newSymbolNamesProvider.d.ts' />
 /// <reference path='./vscode/typings/vscode.proposed.env.d.ts' />
 /// <reference path='./vscode/typings/vscode.proposed.terminalDataWriteEvent.d.ts' />
+/// <reference path='./vscode/typings/vscode.proposed.documentPaste.d.ts' />
+/// <reference path='./vscode/typings/vscode.proposed.dropMetadata.d.ts' />