src/vs/platform/defaultAccount/common/defaultAccount.ts
88 LOC · 88 covered · 0 uncovered · 1 ranges · 2291 concepts · 1 introducers · 1303 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
chatEntitlementService.ts ×52
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { ICopilotTokenInfo, IDefaultAccount, IDefaultAccountAuthenticationProvider, IPolicyData } from '../../../base/common/defaultAccount.js';
import { Event } from '../../../base/common/event.js';
import { createDecorator } from '../../instantiation/common/instantiation.js';
/**
* Well-known GitHub URL paths used with {@link IDefaultAccountService.resolveGitHubUrl}.
*/
export const GitHubPaths = {
copilotSettings: 'settings/copilot/features',
billingBudgets: 'settings/copilot/features?utm_source=vscode',
copilotUpgrade: 'github-copilot/upgrade?utm_source=vscode',
} as const;
/**
* Outcome of the last `/copilot_internal/managed_settings` fetch.
* - A numeric HTTP status code indicates the server responded with that code.
* - `'ok'`: response parsed and adapted successfully (including an empty `{}` body).
* - `'no-url'`: no `managedSettingsUrl` configured in product.json.
* - `'no-response'`: network error, all sessions rejected, or active rate-limit backoff.
* - `'parse-error'`: response received but JSON parsing failed.
* - `null`: never fetched.
*/
export type ManagedSettingsFetchStatus = number | 'ok' | 'no-url' | 'no-response' | 'parse-error' | null;
export interface IDefaultAccountProvider {
readonly defaultAccount: IDefaultAccount | null;
readonly onDidChangeDefaultAccount: Event<IDefaultAccount | null>;
readonly policyData: IPolicyData | null;
readonly onDidChangePolicyData: Event<IPolicyData | null>;
readonly copilotTokenInfo: ICopilotTokenInfo | null;
readonly onDidChangeCopilotTokenInfo: Event<ICopilotTokenInfo | null>;
readonly managedSettingsFetchStatus: ManagedSettingsFetchStatus;
/** Timestamp (ms) of the last managed-settings fetch, or `null` if never fetched. */
readonly managedSettingsFetchedAt: number | null;
/** The raw JSON response from the managed-settings endpoint, for diagnostics. */
readonly managedSettingsRawResponse: unknown;
getDefaultAccountAuthenticationProvider(): IDefaultAccountAuthenticationProvider;
/**
* Resolves a GitHub URL path to a full URL, using the GitHub Enterprise
* base URL when the user is authenticated via a GHE provider, or
* `https://github.com` otherwise.
*
* @param path The path portion of the URL (e.g. `settings/copilot/features`).
*/
resolveGitHubUrl(path: string): string;
refresh(options?: { forceRefresh?: boolean }): Promise<IDefaultAccount | null>;
signIn(options?: { additionalScopes?: readonly string[];[key: string]: unknown }): Promise<IDefaultAccount | null>;
signOut(): Promise<void>;
}
export const IDefaultAccountService = createDecorator<IDefaultAccountService>('defaultAccountService');
export interface IDefaultAccountService {
readonly _serviceBrand: undefined;
readonly onDidChangeDefaultAccount: Event<IDefaultAccount | null>;
readonly onDidChangePolicyData: Event<IPolicyData | null>;
readonly policyData: IPolicyData | null;
readonly currentDefaultAccount: IDefaultAccount | null;
readonly copilotTokenInfo: ICopilotTokenInfo | null;
readonly onDidChangeCopilotTokenInfo: Event<ICopilotTokenInfo | null>;
readonly managedSettingsFetchStatus: ManagedSettingsFetchStatus;
/** Timestamp (ms) of the last managed-settings fetch, or `null` if never fetched. */
readonly managedSettingsFetchedAt: number | null;
/** The raw JSON response from the managed-settings endpoint, for diagnostics. */
readonly managedSettingsRawResponse: unknown;
getDefaultAccount(): Promise<IDefaultAccount | null>;
getDefaultAccountAuthenticationProvider(): IDefaultAccountAuthenticationProvider;
setDefaultAccountProvider(provider: IDefaultAccountProvider): void;
refresh(options?: { forceRefresh?: boolean }): Promise<IDefaultAccount | null>;
signIn(options?: { additionalScopes?: readonly string[];[key: string]: unknown }): Promise<IDefaultAccount | null>;
signOut(): Promise<void>;
/**
* Resolves a GitHub URL path to a full URL, using the GitHub Enterprise
* base URL when the user is authenticated via a GHE provider, or
* `https://github.com` otherwise.
*
* @param path The path portion of the URL (e.g. `settings/copilot/features`).
*/
resolveGitHubUrl(path: string): string;
}