@codingame/monaco-vscode-api 20.1.0 → 20.2.0

package/vscode/src/vs/workbench/services/authentication/common/authenticationQuery.d.ts

@@ -1,4 +1,7 @@
 import { AuthenticationSessionAccount } from "./authentication.js";
+/**
+ * Statistics about authentication usage
+ */
 export interface IAuthenticationUsageStats {
     readonly totalSessions: number;
     readonly totalAccounts: number;
@@ -8,58 +11,167 @@ export interface IAuthenticationUsageStats {
         readonly usageCount: number;
     }[];
 }
+/**
+ * Information about entities using authentication within a provider
+ */
 export interface IActiveEntities {
     readonly extensions: string[];
     readonly mcpServers: string[];
 }
+/**
+ * Base query interface with common properties
+ */
 export interface IBaseQuery {
     readonly providerId: string;
 }
+/**
+ * Query interface for operations on a specific account within a provider
+ */
 export interface IAccountQuery extends IBaseQuery {
     readonly accountName: string;
+    /**
+     * Get operations for a specific extension on this account
+     * @param extensionId The extension id
+     * @returns An account-extension query interface
+     */
     extension(extensionId: string): IAccountExtensionQuery;
+    /**
+     * Get operations for a specific MCP server on this account
+     * @param mcpServerId The MCP server id
+     * @returns An account-MCP server query interface
+     */
     mcpServer(mcpServerId: string): IAccountMcpServerQuery;
+    /**
+     * Get operations for all extensions on this account
+     * @returns An account-extensions query interface
+     */
     extensions(): IAccountExtensionsQuery;
+    /**
+     * Get operations for all MCP servers on this account
+     * @returns An account-MCP servers query interface
+     */
     mcpServers(): IAccountMcpServersQuery;
+    /**
+     * Get operations for all entities (extensions and MCP servers) on this account
+     * @returns An account-entities query interface for type-agnostic operations
+     */
     entities(): IAccountEntitiesQuery;
+    /**
+     * Remove all authentication data for this account
+     */
     remove(): void;
 }
+/**
+ * Query interface for operations on a specific extension within a specific account
+ */
 export interface IAccountExtensionQuery extends IBaseQuery {
     readonly accountName: string;
     readonly extensionId: string;
+    /**
+     * Check if this extension is allowed to access this account
+     * @returns True if allowed, false if denied, undefined if not yet decided
+     */
     isAccessAllowed(): boolean | undefined;
+    /**
+     * Set access permission for this extension on this account
+     * @param allowed True to allow, false to deny access
+     * @param extensionName Optional extension name for display purposes
+     */
     setAccessAllowed(allowed: boolean, extensionName?: string): void;
+    /**
+     * Add usage record for this extension on this account
+     * @param scopes The scopes that were used
+     * @param extensionName The extension name for display purposes
+     */
     addUsage(scopes: readonly string[], extensionName: string): void;
+    /**
+     * Get usage history for this extension on this account
+     * @returns Array of usage records
+     */
     getUsage(): {
         readonly extensionId: string;
         readonly extensionName: string;
         readonly scopes: readonly string[];
         readonly lastUsed: number;
     }[];
+    /**
+     * Remove all usage data for this extension on this account
+     */
     removeUsage(): void;
+    /**
+     * Set this account as the preferred account for this extension
+     */
     setAsPreferred(): void;
+    /**
+     * Check if this account is the preferred account for this extension
+     */
     isPreferred(): boolean;
+    /**
+     * Check if this extension is trusted (defined in product.json)
+     * @returns True if the extension is trusted, false otherwise
+     */
     isTrusted(): boolean;
 }
+/**
+ * Query interface for operations on a specific MCP server within a specific account
+ */
 export interface IAccountMcpServerQuery extends IBaseQuery {
     readonly accountName: string;
     readonly mcpServerId: string;
+    /**
+     * Check if this MCP server is allowed to access this account
+     * @returns True if allowed, false if denied, undefined if not yet decided
+     */
     isAccessAllowed(): boolean | undefined;
+    /**
+     * Set access permission for this MCP server on this account
+     * @param allowed True to allow, false to deny access
+     * @param mcpServerName Optional MCP server name for display purposes
+     */
     setAccessAllowed(allowed: boolean, mcpServerName?: string): void;
+    /**
+     * Add usage record for this MCP server on this account
+     * @param scopes The scopes that were used
+     * @param mcpServerName The MCP server name for display purposes
+     */
     addUsage(scopes: readonly string[], mcpServerName: string): void;
+    /**
+     * Get usage history for this MCP server on this account
+     * @returns Array of usage records
+     */
     getUsage(): {
         readonly mcpServerId: string;
         readonly mcpServerName: string;
         readonly scopes: readonly string[];
         readonly lastUsed: number;
     }[];
+    /**
+     * Remove all usage data for this MCP server on this account
+     */
     removeUsage(): void;
+    /**
+     * Set this account as the preferred account for this MCP server
+     */
     setAsPreferred(): void;
+    /**
+     * Check if this account is the preferred account for this MCP server
+     */
     isPreferred(): boolean;
+    /**
+     * Check if this MCP server is trusted (defined in product.json)
+     * @returns True if the MCP server is trusted, false otherwise
+     */
     isTrusted(): boolean;
 }
+/**
+ * Query interface for operations on all extensions within a specific account
+ */
 export interface IAccountExtensionsQuery extends IBaseQuery {
     readonly accountName: string;
+    /**
+     * Get all extensions that have access to this account with their trusted state
+     * @returns Array of objects containing extension data including trusted state
+     */
     getAllowedExtensions(): {
         id: string;
         name: string;
@@ -67,12 +179,31 @@ export interface IAccountExtensionsQuery extends IBaseQuery {
         lastUsed?: number;
         trusted?: boolean;
     }[];
+    /**
+     * Grant access to this account for all specified extensions
+     * @param extensionIds Array of extension IDs to grant access to
+     */
     allowAccess(extensionIds: string[]): void;
+    /**
+     * Remove access to this account for all specified extensions
+     * @param extensionIds Array of extension IDs to remove access from
+     */
     removeAccess(extensionIds: string[]): void;
+    /**
+     * Execute a callback for each extension that has used this account
+     * @param callback Function to execute for each extension
+     */
     forEach(callback: (extensionQuery: IAccountExtensionQuery) => void): void;
 }
+/**
+ * Query interface for operations on all MCP servers within a specific account
+ */
 export interface IAccountMcpServersQuery extends IBaseQuery {
     readonly accountName: string;
+    /**
+     * Get all MCP servers that have access to this account with their trusted state
+     * @returns Array of objects containing MCP server data including trusted state
+     */
     getAllowedMcpServers(): {
         id: string;
         name: string;
@@ -80,53 +211,189 @@ export interface IAccountMcpServersQuery extends IBaseQuery {
         lastUsed?: number;
         trusted?: boolean;
     }[];
+    /**
+     * Grant access to this account for all specified MCP servers
+     * @param mcpServerIds Array of MCP server IDs to grant access to
+     */
     allowAccess(mcpServerIds: string[]): void;
+    /**
+     * Remove access to this account for all specified MCP servers
+     * @param mcpServerIds Array of MCP server IDs to remove access from
+     */
     removeAccess(mcpServerIds: string[]): void;
+    /**
+     * Execute a callback for each MCP server that has used this account
+     * @param callback Function to execute for each MCP server
+     */
     forEach(callback: (mcpServerQuery: IAccountMcpServerQuery) => void): void;
 }
+/**
+ * Query interface for type-agnostic operations on all entities (extensions and MCP servers) within a specific account
+ */
 export interface IAccountEntitiesQuery extends IBaseQuery {
     readonly accountName: string;
+    /**
+     * Check if this account has been used by any entity (extension or MCP server)
+     * @returns True if the account has been used, false otherwise
+     */
     hasAnyUsage(): boolean;
+    /**
+     * Get the total count of entities that have used this account
+     * @returns Object with counts for extensions and MCP servers
+     */
     getEntityCount(): {
         extensions: number;
         mcpServers: number;
         total: number;
     };
+    /**
+     * Remove access to this account for all entities (extensions and MCP servers)
+     */
     removeAllAccess(): void;
+    /**
+     * Execute a callback for each entity that has used this account
+     * @param callback Function to execute for each entity
+     */
     forEach(callback: (entityId: string, entityType: "extension" | "mcpServer") => void): void;
 }
+/**
+ * Query interface for operations on a specific extension within a provider
+ */
 export interface IProviderExtensionQuery extends IBaseQuery {
     readonly extensionId: string;
+    /**
+     * Get the preferred account for this extension within this provider
+     * @returns The account name, or undefined if no preference is set
+     */
     getPreferredAccount(): string | undefined;
+    /**
+     * Set the preferred account for this extension within this provider
+     * @param account The account to set as preferred
+     */
     setPreferredAccount(account: AuthenticationSessionAccount): void;
+    /**
+     * Remove the account preference for this extension within this provider
+     */
     removeAccountPreference(): void;
 }
+/**
+ * Query interface for operations on a specific MCP server within a provider
+ */
 export interface IProviderMcpServerQuery extends IBaseQuery {
     readonly mcpServerId: string;
+    /**
+     * Get the last used account for this MCP server within a provider
+     * @returns The account name, or undefined if no preference is set
+     */
     getLastUsedAccount(): Promise<string | undefined>;
+    /**
+     * Get the preferred account for this MCP server within a provider
+     * @returns The account name, or undefined if no preference is set
+     */
     getPreferredAccount(): string | undefined;
+    /**
+     * Set the preferred account for this MCP server within a provider
+     * @param account The account to set as preferred
+     */
     setPreferredAccount(account: AuthenticationSessionAccount): void;
+    /**
+     * Remove the account preference for this MCP server within a provider
+     */
     removeAccountPreference(): void;
+    /**
+     * Get all accounts that this MCP server has used within this provider
+     * @returns Array of account names
+     */
     getUsedAccounts(): Promise<string[]>;
 }
+/**
+ * Query interface for provider-scoped operations
+ */
 export interface IProviderQuery extends IBaseQuery {
+    /**
+     * Get operations for a specific account within this provider
+     * @param accountName The account name
+     * @returns An account query interface
+     */
     account(accountName: string): IAccountQuery;
+    /**
+     * Get operations for a specific extension within this provider
+     * @param extensionId The extension id
+     * @returns A provider-extension query interface
+     */
     extension(extensionId: string): IProviderExtensionQuery;
+    /**
+     * Get operations for a specific MCP server within this provider
+     * @param mcpServerId The MCP server id
+     * @returns A provider-MCP server query interface
+     */
     mcpServer(mcpServerId: string): IProviderMcpServerQuery;
+    /**
+     * Get information about active entities (extensions and MCP servers) within this provider
+     * @returns Information about entities that have used authentication
+     */
     getActiveEntities(): Promise<IActiveEntities>;
+    /**
+     * Get all account names for this provider
+     * @returns Array of account names
+     */
     getAccountNames(): Promise<string[]>;
+    /**
+     * Get usage statistics for this provider
+     * @returns Usage statistics
+     */
     getUsageStats(): Promise<IAuthenticationUsageStats>;
+    /**
+     * Execute a callback for each account in this provider
+     * @param callback Function to execute for each account
+     */
     forEachAccount(callback: (accountQuery: IAccountQuery) => void): Promise<void>;
 }
+/**
+ * Query interface for extension-scoped operations (cross-provider)
+ */
 export interface IExtensionQuery {
     readonly extensionId: string;
+    /**
+     * Get all providers where this extension has access
+     * @param includeInternal Whether to include internal providers (starting with INTERNAL_AUTH_PROVIDER_PREFIX)
+     * @returns Array of provider IDs
+     */
     getProvidersWithAccess(includeInternal?: boolean): Promise<string[]>;
+    /**
+     * Get account preferences for this extension across all providers
+     * @param includeInternal Whether to include internal providers (starting with INTERNAL_AUTH_PROVIDER_PREFIX)
+     * @returns Map of provider ID to account name
+     */
     getAllAccountPreferences(includeInternal?: boolean): Map<string, string>;
+    /**
+     * Get operations for this extension within a specific provider
+     * @param providerId The provider ID
+     * @returns A provider-extension query interface
+     */
     provider(providerId: string): IProviderExtensionQuery;
 }
+/**
+ * Query interface for MCP server-scoped operations (cross-provider)
+ */
 export interface IMcpServerQuery {
     readonly mcpServerId: string;
+    /**
+     * Get all providers where this MCP server has access
+     * @param includeInternal Whether to include internal providers (starting with INTERNAL_AUTH_PROVIDER_PREFIX)
+     * @returns Array of provider IDs
+     */
     getProvidersWithAccess(includeInternal?: boolean): Promise<string[]>;
+    /**
+     * Get account preferences for this MCP server across all providers
+     * @param includeInternal Whether to include internal providers (starting with INTERNAL_AUTH_PROVIDER_PREFIX)
+     * @returns Map of provider ID to account name
+     */
     getAllAccountPreferences(includeInternal?: boolean): Map<string, string>;
+    /**
+     * Get operations for this MCP server within a specific provider
+     * @param providerId The provider ID
+     * @returns A provider-MCP server query interface
+     */
     provider(providerId: string): IProviderMcpServerQuery;
 }

package/vscode/src/vs/workbench/services/authentication/common/authenticationQuery.service.d.ts

@@ -1,20 +1,53 @@
 import { Event } from "../../../../base/common/event.js";
 import { IProviderQuery, IExtensionQuery, IMcpServerQuery } from "./authenticationQuery.js";
+/**
+* Main authentication query service interface
+*/
 export declare const IAuthenticationQueryService: import("../../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<IAuthenticationQueryService>;
 export interface IAuthenticationQueryService {
     readonly _serviceBrand: undefined;
+    /**
+    * Fires when authentication preferences change
+    */
     readonly onDidChangePreferences: Event<{
         readonly providerId: string;
         readonly entityType: "extension" | "mcpServer";
         readonly entityIds: string[];
     }>;
+    /**
+    * Fires when authentication access permissions change
+    */
     readonly onDidChangeAccess: Event<{
         readonly providerId: string;
         readonly accountName: string;
     }>;
+    /**
+    * Get operations for a specific authentication provider
+    * @param providerId The authentication provider id
+    * @returns A provider query interface
+    */
     provider(providerId: string): IProviderQuery;
+    /**
+    * Get operations for a specific extension across all providers
+    * @param extensionId The extension id
+    * @returns An extension query interface
+    */
     extension(extensionId: string): IExtensionQuery;
+    /**
+    * Get operations for a specific MCP server across all providers
+    * @param mcpServerId The MCP server id
+    * @returns An MCP server query interface
+    */
     mcpServer(mcpServerId: string): IMcpServerQuery;
+    /**
+    * Get all available provider IDs
+    * @returns Array of provider IDs
+    */
     getProviderIds(): string[];
+    /**
+    * Clear all authentication data (for testing/debugging purposes)
+    * @param confirmation Must be 'CLEAR_ALL_AUTH_DATA' to confirm
+    * @param includeInternal Whether to include internal providers (defaults to true for complete clearing)
+    */
     clearAllData(confirmation: "CLEAR_ALL_AUTH_DATA", includeInternal?: boolean): Promise<void>;
 }

package/vscode/src/vs/workbench/services/authentication/common/dynamicAuthenticationProviderStorage.d.ts

@@ -2,6 +2,9 @@ import { IAuthorizationTokenResponse } from "../../../../base/common/oauth.js";
 export interface DynamicAuthenticationProviderInfo {
     readonly providerId: string;
     readonly label: string;
+    /**
+     * @deprecated in favor of authorizationServer
+     */
     readonly issuer?: string;
     readonly authorizationServer: string;
     readonly clientId: string;

package/vscode/src/vs/workbench/services/authentication/common/dynamicAuthenticationProviderStorage.service.d.ts

@@ -2,19 +2,58 @@ import { Event } from "../../../../base/common/event.js";
 import { IAuthorizationTokenResponse } from "../../../../base/common/oauth.js";
 import { DynamicAuthenticationProviderTokensChangeEvent, DynamicAuthenticationProviderInfo } from "./dynamicAuthenticationProviderStorage.js";
 export declare const IDynamicAuthenticationProviderStorageService: import("../../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<IDynamicAuthenticationProviderStorageService>;
+/**
+* Service for managing storage of dynamic authentication provider data.
+*/
 export interface IDynamicAuthenticationProviderStorageService {
     readonly _serviceBrand: undefined;
+    /**
+    * Event fired when tokens for a dynamic authentication provider change.
+    */
     readonly onDidChangeTokens: Event<DynamicAuthenticationProviderTokensChangeEvent>;
+    /**
+    * Get the client details (ID and secret) for a dynamic authentication provider.
+    * @param providerId The provider ID or authorization server URL.
+    * @returns The client details if they exist, undefined otherwise.
+    */
     getClientRegistration(providerId: string): Promise<{
         clientId?: string;
         clientSecret?: string;
     } | undefined>;
+    /**
+    * Store both client ID and client secret for a dynamic authentication provider.
+    * @param providerId The provider ID or authorization server URL.
+    * @param authorizationServer The authorization server URL for the provider.
+    * @param clientId The client ID to store.
+    * @param clientSecret Optional client secret to store.
+    * @param label Optional label for the provider.
+    */
     storeClientRegistration(providerId: string, authorizationServer: string, clientId: string, clientSecret?: string, label?: string): Promise<void>;
+    /**
+    * Get all dynamic authentication providers that have been interacted with.
+    * @returns Array of provider information.
+    */
     getInteractedProviders(): ReadonlyArray<DynamicAuthenticationProviderInfo>;
+    /**
+    * Remove a dynamic authentication provider and its stored data.
+    * @param providerId The provider ID to remove.
+    */
     removeDynamicProvider(providerId: string): Promise<void>;
+    /**
+    * Get sessions for a dynamic authentication provider from secret storage.
+    * @param authProviderId The authentication provider ID.
+    * @param clientId The client ID.
+    * @returns Array of authorization tokens with creation timestamps, or undefined if none exist.
+    */
     getSessionsForDynamicAuthProvider(authProviderId: string, clientId: string): Promise<(IAuthorizationTokenResponse & {
         created_at: number;
     })[] | undefined>;
+    /**
+    * Set sessions for a dynamic authentication provider in secret storage.
+    * @param authProviderId The authentication provider ID.
+    * @param clientId The client ID.
+    * @param sessions Array of authorization tokens with creation timestamps.
+    */
     setSessionsForDynamicAuthProvider(authProviderId: string, clientId: string, sessions: (IAuthorizationTokenResponse & {
         created_at: number;
     })[]): Promise<void>;

package/vscode/src/vs/workbench/services/configurationResolver/common/configurationResolver.service.d.ts

@@ -6,10 +6,30 @@ import { ConfigurationResolverExpression } from "./configurationResolverExpressi
 export declare const IConfigurationResolverService: import("../../../../platform/instantiation/common/instantiation.js").ServiceIdentifier<IConfigurationResolverService>;
 export interface IConfigurationResolverService {
     readonly _serviceBrand: undefined;
+    /** Variables the resolver is able to resolve. */
     readonly resolvableVariables: ReadonlySet<string>;
     resolveWithEnvironment(environment: IProcessEnvironment, folder: IWorkspaceFolderData | undefined, value: string): Promise<string>;
+    /**
+    * Recursively resolves all variables in the given config and returns a copy of it with substituted values.
+    * Command variables are only substituted if a "commandValueMapping" dictionary is given and if it contains an entry for the command.
+    */
     resolveAsync<T>(folder: IWorkspaceFolderData | undefined, config: T): Promise<T extends ConfigurationResolverExpression<infer R> ? R : T>;
+    /**
+    * Recursively resolves all variables (including commands and user input) in the given config and returns a copy of it with substituted values.
+    * If a "variables" dictionary (with names -> command ids) is given, command variables are first mapped through it before being resolved.
+    *
+    * @param section For example, 'tasks' or 'debug'. Used for resolving inputs.
+    * @param variables Aliases for commands.
+    */
     resolveWithInteractionReplace(folder: IWorkspaceFolderData | undefined, config: unknown, section?: string, variables?: IStringDictionary<string>, target?: ConfigurationTarget): Promise<any>;
+    /**
+    * Similar to resolveWithInteractionReplace, except without the replace. Returns a map of variables and their resolution.
+    * Keys in the map will be of the format input:variableName or command:variableName.
+    */
     resolveWithInteraction(folder: IWorkspaceFolderData | undefined, config: unknown, section?: string, variables?: IStringDictionary<string>, target?: ConfigurationTarget): Promise<Map<string, string> | undefined>;
+    /**
+    * Contributes a variable that can be resolved later. Consumers that use resolveAny, resolveWithInteraction,
+    * and resolveWithInteractionReplace will have contributed variables resolved.
+    */
     contributeVariable(variable: string, resolution: () => Promise<string | undefined>): void;
 }

package/vscode/src/vs/workbench/services/configurationResolver/common/configurationResolverExpression.d.ts

@@ -1,21 +1,41 @@
 import { ConfiguredInput } from "./configurationResolver.js";
+/** A replacement found in the object, as ${name} or ${name:arg} */
 export type Replacement = {
+    /** ${name:arg} */
     id: string;
+    /** The `name:arg` in ${name:arg} */
     inner: string;
+    /** The `name` in ${name:arg} */
     name: string;
+    /** The `arg` in ${name:arg} */
     arg?: string;
 };
 interface IConfigurationResolverExpression<T> {
+    /**
+     * Gets the replacements which have not yet been
+     * resolved.
+     */
     unresolved(): Iterable<Replacement>;
+    /**
+     * Gets the replacements which have been resolved.
+     */
     resolved(): Iterable<[
         Replacement,
         IResolvedValue
     ]>;
+    /**
+     * Resolves a replacement into the string value.
+     * If the value is undefined, the original variable text will be preserved.
+     */
     resolve(replacement: Replacement, data: string | IResolvedValue): void;
+    /**
+     * Returns the complete object. Any unresolved replacements are left intact.
+     */
     toObject(): T;
 }
 export interface IResolvedValue {
     value: string | undefined;
+    /** Present when the variable is resolved from an input field. */
     input?: ConfiguredInput;
 }
 export declare class ConfigurationResolverExpression<T> implements IConfigurationResolverExpression<T> {
@@ -23,8 +43,17 @@ export declare class ConfigurationResolverExpression<T> implements IConfiguratio
     private readonly locations;
     private root;
     private stringRoot;
+    /**
+     * Callbacks when a new replacement is made, so that nested resolutions from
+     * `expr.unresolved()` can be fulfilled in the same iteration.
+     */
     private newReplacementNotifiers;
     private constructor();
+    /**
+     * Creates a new {@link ConfigurationResolverExpression} from an object.
+     * Note that platform-specific keys (i.e. `windows`, `osx`, `linux`) are
+     * applied during parsing.
+     */
     static parse<T>(object: T): ConfigurationResolverExpression<T>;
     private applyPlatformSpecificKeys;
     private parseVariable;