@opensumi/sumi 2.12.1-next-079c1930

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

@@ -0,0 +1,231 @@
+declare module 'vscode' {
+  /**
+   * Represents a session of a currently logged in user.
+   */
+  export interface AuthenticationSession {
+    /**
+     * The identifier of the authentication session.
+     */
+    readonly id: string;
+
+    /**
+     * The access token.
+     */
+    readonly accessToken: string;
+
+    /**
+     * The account associated with the session.
+     */
+    readonly account: AuthenticationSessionAccountInformation;
+
+    /**
+     * The permissions granted by the session's access token. Available scopes
+     * are defined by the {@link AuthenticationProvider}.
+     */
+    readonly scopes: ReadonlyArray<string>;
+  }
+
+  /**
+   * The information of an account associated with an {@link AuthenticationSession}.
+   */
+  export interface AuthenticationSessionAccountInformation {
+    /**
+     * The unique identifier of the account.
+     */
+    readonly id: string;
+
+    /**
+     * The human-readable name of the account.
+     */
+    readonly label: string;
+  }
+
+
+  /**
+   * Options to be used when getting an {@link AuthenticationSession} from an {@link AuthenticationProvider}.
+   */
+  export interface AuthenticationGetSessionOptions {
+    /**
+     * Whether login should be performed if there is no matching session.
+     *
+     * If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown
+     * on the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This
+     * allows quietly prompting the user to sign in.
+     *
+     * If there is a matching session but the extension has not been granted access to it, setting this to true
+     * will also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon.
+     *
+     * Defaults to false.
+     */
+    createIfNone?: boolean;
+
+    /**
+     * Whether the existing user session preference should be cleared.
+     *
+     * For authentication providers that support being signed into multiple accounts at once, the user will be
+     * prompted to select an account to use when {@link authentication.getSession getSession} is called. This preference
+     * is remembered until {@link authentication.getSession getSession} is called with this flag.
+     *
+     * Defaults to false.
+     */
+    clearSessionPreference?: boolean;
+  }
+
+  /**
+   * Basic information about an {@link AuthenticationProvider}
+   */
+  export interface AuthenticationProviderInformation {
+    /**
+     * The unique identifier of the authentication provider.
+     */
+    readonly id: string;
+
+    /**
+     * The human-readable name of the authentication provider.
+     */
+    readonly label: string;
+  }
+
+  /**
+   * An {@link Event} which fires when an {@link AuthenticationSession} is added, removed, or changed.
+   */
+  export interface AuthenticationSessionsChangeEvent {
+    /**
+     * The {@link AuthenticationProvider} that has had its sessions change.
+     */
+    readonly provider: AuthenticationProviderInformation;
+  }
+
+  /**
+   * Options for creating an {@link AuthenticationProvider}.
+   */
+  export interface AuthenticationProviderOptions {
+    /**
+     * Whether it is possible to be signed into multiple accounts at once with this provider.
+     * If not specified, will default to false.
+    */
+    readonly supportsMultipleAccounts?: boolean;
+  }
+
+  /**
+  * An {@link Event} which fires when an {@link AuthenticationSession} is added, removed, or changed.
+  */
+  export interface AuthenticationProviderAuthenticationSessionsChangeEvent {
+    /**
+     * The {@link AuthenticationSession}s of the {@link AuthentiationProvider AuthenticationProvider} that have been added.
+    */
+    readonly added?: ReadonlyArray<AuthenticationSession>;
+
+    /**
+     * The {@link AuthenticationSession}s of the {@link AuthentiationProvider AuthenticationProvider} that have been removed.
+     */
+    readonly removed?: ReadonlyArray<AuthenticationSession>;
+
+    /**
+     * The {@link AuthenticationSession}s of the {@link AuthentiationProvider AuthenticationProvider} that have been changed.
+     * A session changes when its data excluding the id are updated. An example of this is a session refresh that results in a new
+     * access token being set for the session.
+     */
+    readonly changed?: ReadonlyArray<AuthenticationSession>;
+  }
+
+  /**
+   * A provider for performing authentication to a service.
+   */
+  export interface AuthenticationProvider {
+    /**
+     * An {@link Event} which fires when the array of sessions has changed, or data
+     * within a session has changed.
+     */
+    readonly onDidChangeSessions: Event<AuthenticationProviderAuthenticationSessionsChangeEvent>;
+
+    /**
+     * Get a list of sessions.
+     * @param scopes An optional list of scopes. If provided, the sessions returned should match
+     * these permissions, otherwise all sessions should be returned.
+     * @returns A promise that resolves to an array of authentication sessions.
+     */
+    getSessions(scopes?: string[]): Thenable<ReadonlyArray<AuthenticationSession>>;
+
+    /**
+     * Prompts a user to login.
+     *
+     * If login is successful, the onDidChangeSessions event should be fired.
+     *
+     * If login fails, a rejected promise should be returned.
+     *
+     * If the provider has specified that it does not support multiple accounts,
+     * then this should never be called if there is already an existing session matching these
+     * scopes.
+     * @param scopes A list of scopes, permissions, that the new session should be created with.
+     * @returns A promise that resolves to an authentication session.
+     */
+    createSession(scopes: string[]): Thenable<AuthenticationSession>;
+
+    /**
+     * Removes the session corresponding to session id.
+     *
+     * If the removal is successful, the onDidChangeSessions event should be fired.
+     *
+     * If a session cannot be removed, the provider should reject with an error message.
+     * @param sessionId The id of the session to remove.
+     */
+    removeSession(sessionId: string): Thenable<void>;
+  }
+
+
+  /**
+   * Namespace for authentication.
+   */
+  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 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>;
+
+    /**
+     * An {@link Event} which fires when the authentication sessions of an authentication provider have
+     * been added, removed, or changed.
+     */
+    export const onDidChangeSessions: Event<AuthenticationSessionsChangeEvent>;
+
+    /**
+     * Register an authentication provider.
+     *
+     * There can only be one provider per id and an error is being thrown when an id
+     * has already been used by another provider. Ids are case-sensitive.
+     *
+     * @param id The unique identifier of the provider.
+     * @param label The human-readable name of the provider.
+     * @param provider The authentication provider provider.
+     * @params options Additional options for the provider.
+     * @return A {@link Disposable} that unregisters this provider when being disposed.
+     */
+    export function registerAuthenticationProvider(id: string, label: string, provider: AuthenticationProvider, options?: AuthenticationProviderOptions): Disposable;
+  }
+}

package/vscode/typings/vscode.command.d.ts

@@ -0,0 +1,86 @@
+declare module 'vscode' {
+	/**
+	 * Represents a reference to a command. Provides a title which
+	 * will be used to represent a command in the UI and, optionally,
+	 * an array of arguments which will be passed to the command handler
+	 * function when invoked.
+	 */
+	export interface Command {
+		/**
+		 * Title of the command, like `save`.
+		 */
+		title: string;
+
+		/**
+		 * The identifier of the actual command handler.
+		 * @see [commands.registerCommand](#commands.registerCommand).
+		 */
+		command: string;
+
+		/**
+		 * A tooltip for the command, when represented in the UI.
+		 */
+		tooltip?: string;
+
+		/**
+		 * Arguments that the command handler should be
+		 * invoked with.
+		 */
+		arguments?: any[];
+	}
+  export namespace commands {
+    /**
+		 * Registers a command that can be invoked via a keyboard shortcut,
+		 * a menu item, an action, or directly.
+		 *
+		 * Registering a command with an existing command identifier twice
+		 * will cause an error.
+		 *
+		 * @param command A unique identifier for the command.
+		 * @param callback A command handler function.
+		 * @param thisArg The `this` context used when invoking the handler function.
+		 * @return Disposable which unregisters this command on disposal.
+		 */
+		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;
+
+		/**
+		 * Executes the command denoted by the given command identifier.
+		 *
+		 * * *Note 1:* When executing an editor command not all types are allowed to
+		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
+		 * `number`, `undefined`, and `null`, as well as [`Position`](#Position), [`Range`](#Range), [`Uri`](#Uri) and [`Location`](#Location).
+		 * * *Note 2:* There are no restrictions when executing commands that have been contributed
+		 * by extensions.
+		 *
+		 * @param command Identifier of the command to execute.
+		 * @param rest Parameters passed to the command function.
+		 * @return A thenable that resolves to the returned value of the given command. `undefined` when
+		 * the command handler function doesn't return anything.
+		 */
+		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
+
+		/**
+		 * Retrieve the list of all available commands. Commands starting an underscore are
+		 * treated as internal commands.
+		 *
+		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
+		 * @return Thenable that resolves to a list of command ids.
+		 */
+		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
+			/**
+		 * Registers a text editor command that can be invoked via a keyboard shortcut,
+		 * a menu item, an action, or directly.
+		 *
+		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
+		 * they only execute when there is an active editor when the command is called. Also, the
+		 * command handler of an editor command has access to the active editor and to an
+		 * [edit](#TextEditorEdit)-builder.
+		 *
+		 * @param command A unique identifier for the command.
+		 * @param callback A command handler function with access to an [editor](#TextEditor) and an [edit](#TextEditorEdit).
+		 * @param thisArg The `this` context used when invoking the handler function.
+		 * @return Disposable which unregisters this command on disposal.
+		 */
+		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
+	}
+}

package/vscode/typings/vscode.comments.d.ts

@@ -0,0 +1,292 @@
+declare module 'vscode' {
+  //#region Comments
+
+  /**
+   * Collapsible state of a [comment thread](#CommentThread)
+   */
+  export enum CommentThreadCollapsibleState {
+    /**
+     * Determines an item is collapsed
+     */
+    Collapsed = 0,
+
+    /**
+     * Determines an item is expanded
+     */
+    Expanded = 1,
+  }
+
+  /**
+   * Comment mode of a [comment](#Comment)
+   */
+  export enum CommentMode {
+    /**
+     * Displays the comment editor
+     */
+    Editing = 0,
+
+    /**
+     * Displays the preview of the comment
+     */
+    Preview = 1,
+  }
+
+  /**
+   * A collection of [comments](#Comment) representing a conversation at a particular range in a document.
+   */
+  export interface CommentThread {
+    /**
+     * The uri of the document the thread has been created on.
+     */
+    readonly uri: Uri;
+
+    /**
+     * The range the comment thread is located within the document. The thread icon will be shown
+     * at the first line of the range.
+     */
+    range: Range;
+
+    /**
+     * The ordered comments of the thread.
+     */
+    comments: ReadonlyArray<Comment>;
+
+    /**
+     * Whether the thread should be collapsed or expanded when opening the document.
+     * Defaults to Collapsed.
+     */
+    collapsibleState: CommentThreadCollapsibleState;
+
+    /**
+     * Whether the thread supports reply.
+     * Defaults to true.
+     */
+    canReply: boolean;
+
+    /**
+     * Context value of the comment thread. This can be used to contribute thread specific actions.
+     * For example, a comment thread is given a context value as `editable`. When contributing actions to `comments/commentThread/title`
+     * using `menus` extension point, you can specify context value for key `commentThread` in `when` expression like `commentThread == editable`.
+     * ```
+     *  "contributes": {
+     *    "menus": {
+     *      "comments/commentThread/title": [
+     *        {
+     *          "command": "extension.deleteCommentThread",
+     *          "when": "commentThread == editable"
+     *        }
+     *      ]
+     *    }
+     *  }
+     * ```
+     * This will show action `extension.deleteCommentThread` only for comment threads with `contextValue` is `editable`.
+     */
+    contextValue?: string;
+
+    /**
+     * The optional human-readable label describing the [Comment Thread](#CommentThread)
+     */
+    label?: string;
+
+    /**
+     * Dispose this comment thread.
+     *
+     * Once disposed, this comment thread will be removed from visible editors and Comment Panel when approriate.
+     */
+    dispose(): void;
+  }
+
+  /**
+   * Author information of a [comment](#Comment)
+   */
+  export interface CommentAuthorInformation {
+    /**
+     * The display name of the author of the comment
+     */
+    name: string;
+
+    /**
+     * The optional icon path for the author
+     */
+    iconPath?: Uri;
+  }
+
+  /**
+   * Reactions of a [comment](#Comment)
+   */
+  export interface CommentReaction {
+    /**
+     * The human-readable label for the reaction
+     */
+    readonly label: string;
+
+    /**
+     * Icon for the reaction shown in UI.
+     */
+    readonly iconPath: string | Uri;
+
+    /**
+     * The number of users who have reacted to this reaction
+     */
+    readonly count: number;
+
+    /**
+     * Whether the [author](CommentAuthorInformation) of the comment has reacted to this reaction
+     */
+    readonly authorHasReacted: boolean;
+  }
+
+  /**
+   * Represents a {@link CommentController comment controller}'s {@link CommentController.options options}.
+   */
+  export interface CommentOptions {
+    /**
+     * TODO: kaitian 评论组件交互无收起时保留输入框的设计，该值设置无效
+     * An optional string to show on the comment input box when it's collapsed.
+     */
+    prompt?: string;
+
+    /**
+     * An optional string to show as placeholder in the comment input box when it's focused.
+     */
+    placeHolder?: string;
+  }
+
+  /**
+   * A comment is displayed within the editor or the Comments Panel, depending on how it is provided.
+   */
+  export interface Comment {
+    /**
+     * The human-readable comment body
+     */
+    body: string | MarkdownString;
+
+    /**
+     * [Comment mode](#CommentMode) of the comment
+     */
+    mode: CommentMode;
+
+    /**
+     * The [author information](#CommentAuthorInformation) of the comment
+     */
+    author: CommentAuthorInformation;
+
+    /**
+     * Context value of the comment. This can be used to contribute comment specific actions.
+     * For example, a comment is given a context value as `editable`. When contributing actions to `comments/comment/title`
+     * using `menus` extension point, you can specify context value for key `comment` in `when` expression like `comment == editable`.
+     * ```json
+     *  "contributes": {
+     *    "menus": {
+     *      "comments/comment/title": [
+     *        {
+     *          "command": "extension.deleteComment",
+     *          "when": "comment == editable"
+     *        }
+     *      ]
+     *    }
+     *  }
+     * ```
+     * This will show action `extension.deleteComment` only for comments with `contextValue` is `editable`.
+     */
+    contextValue?: string;
+
+    /**
+     * Optional reactions of the [comment](#Comment)
+     */
+    reactions?: CommentReaction[];
+
+    /**
+     * Optional label describing the [Comment](#Comment)
+     * Label will be rendered next to authorName if exists.
+     */
+    label?: string;
+  }
+
+  /**
+   * Command argument for actions registered in `comments/commentThread/context`.
+   */
+  export interface CommentReply {
+    /**
+     * The active [comment thread](#CommentThread)
+     */
+    thread: CommentThread;
+
+    /**
+     * The value in the comment editor
+     */
+    text: string;
+  }
+
+  /**
+   * Commenting range provider for a [comment controller](#CommentController).
+   */
+  export interface CommentingRangeProvider {
+    /**
+     * Provide a list of ranges which allow new comment threads creation or null for a given document
+     */
+    provideCommentingRanges(document: TextDocument, token: CancellationToken): ProviderResult<Range[]>;
+  }
+
+  /**
+   * A comment controller is able to provide [comments](#CommentThread) support to the editor and
+   * provide users various ways to interact with comments.
+   */
+  export interface CommentController {
+    /**
+     * The id of this comment controller.
+     */
+    readonly id: string;
+
+    /**
+     * The human-readable label of this comment controller.
+     */
+    readonly label: string;
+
+    /**
+     * Optional commenting range provider. Provide a list [ranges](#Range) which support commenting to any given resource uri.
+     *
+     * If not provided, users can leave comments in any document opened in the editor.
+     */
+    commentingRangeProvider?: CommentingRangeProvider;
+
+    /**
+     * Create a [comment thread](#CommentThread). The comment thread will be displayed in visible text editors (if the resource matches)
+     * and Comments Panel once created.
+     *
+     * @param uri The uri of the document the thread has been created on.
+     * @param range The range the comment thread is located within the document.
+     * @param comments The ordered comments of the thread.
+     */
+    createCommentThread(uri: Uri, range: Range, comments: Comment[]): CommentThread;
+
+    /**
+     * Comment controller options
+     */
+    options?: CommentOptions;
+
+    /**
+     * Optional reaction handler for creating and deleting reactions on a [comment](#Comment).
+     */
+    reactionHandler?: (comment: Comment, reaction: CommentReaction) => Promise<void>;
+
+    /**
+     * Dispose this comment controller.
+     *
+     * Once disposed, all [comment threads](#CommentThread) created by this comment controller will also be removed from the editor
+     * and Comments Panel.
+     */
+    dispose(): void;
+  }
+
+  namespace comments {
+    /**
+     * Creates a new [comment controller](#CommentController) instance.
+     *
+     * @param id An `id` for the comment controller.
+     * @param label A human-readable string for the comment controller.
+     * @return An instance of [comment controller](#CommentController).
+     */
+    export function createCommentController(id: string, label: string): CommentController;
+  }
+}