@microsoft/vscode-azext-azureauth 4.0.2 → 4.1.0

package/out/src/AzureSubscriptionProvider.d.ts

@@ -1,63 +1,82 @@
-import type * as vscode from 'vscode';
-import type { AzureSubscription } from './AzureSubscription';
-import type { AzureTenant } from './AzureTenant';
-/**
- * An interface for obtaining Azure subscription information
- */
-export interface AzureSubscriptionProvider {
-    /**
-     * Gets a list of tenants available to the user.
-     * Use {@link isSignedIn} to check if the user is signed in to a particular tenant.
-     *
-     * @param account - Optionally pass in a specific account to get tenants for.
-     *
-     * @returns A list of tenants.
-     */
-    getTenants(account?: vscode.AuthenticationSessionAccountInformation): Promise<AzureTenant[]>;
-    /**
-     * Gets a list of Azure subscriptions available to the user.
-     *
-     * @param filter - Whether to filter the list returned, according to the list returned
-     * by `getTenantFilters()` and `getSubscriptionFilters()`. Optional, default true.
-     *
-     * @returns A list of Azure subscriptions.
-     *
-     * @throws A {@link NotSignedInError} If the user is not signed in to Azure.
-     * Use {@link isSignedIn} and/or {@link signIn} before this method to ensure
-     * the user is signed in.
-     */
-    getSubscriptions(filter: boolean): Promise<AzureSubscription[]>;
-    /**
-     * Checks to see if a user is signed in.
-     *
-     * @param tenantId (Optional) Provide to check if a user is signed in to a specific tenant.
-     *
-     * @returns True if the user is signed in, false otherwise.
-     */
-    isSignedIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
-    /**
-     * Asks the user to sign in or pick an account to use.
-     *
-     * @param tenantId (Optional) Provide to sign in to a specific tenant.
-     * @param account (Optional) Provide to sign in to a specific account.
-     *
-     * @returns True if the user is signed in, false otherwise.
-     */
-    signIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
-    /**
-     * An event that is fired when the user signs in. Debounced to fire at most once every 5 seconds.
-     */
-    onDidSignIn: vscode.Event<void>;
-    /**
-     * Signs the user out
-     *
-     * @deprecated Not currently supported by VS Code auth providers
-     *
-     * @throws Throws an {@link Error} every time
-     */
-    signOut(): Promise<void>;
-    /**
-     * An event that is fired when the user signs out. Debounced to fire at most once every 5 seconds.
-     */
-    onDidSignOut: vscode.Event<void>;
-}
+import type * as vscode from 'vscode';
+import type { AzureSubscription } from './AzureSubscription';
+import type { AzureTenant } from './AzureTenant';
+/**
+ * A filter for {@link AzureSubscriptionProvider.getSubscriptions}
+ */
+export type GetSubscriptionsFilter = {
+    /**
+     * The account to get subscriptions for. If not provided, all accounts the extension
+     * currently has access to are used.
+     */
+    account?: vscode.AuthenticationSessionAccountInformation;
+    /**
+     * The tenant to get subscriptions for. If not provided, all tenants for each account
+     * are used.
+     */
+    tenantId?: string;
+};
+/**
+ * An interface for obtaining Azure subscription information
+ */
+export interface AzureSubscriptionProvider {
+    /**
+     * Gets a list of tenants available to the user.
+     * Use {@link isSignedIn} to check if the user is signed in to a particular tenant.
+     *
+     * @param account - Optionally pass in a specific account to get tenants for.
+     *
+     * @returns A list of tenants.
+     */
+    getTenants(account?: vscode.AuthenticationSessionAccountInformation): Promise<AzureTenant[]>;
+    /**
+     * Gets a list of Azure subscriptions available to the user.
+     *
+     * @param filter - Whether to filter the list returned. When:
+     * - `true`: according to the list returned by `getTenantFilters()` and `getSubscriptionFilters()`.
+     * - `false`: return all subscriptions.
+     * - `GetSubscriptionsFilter`: according to the values in the filter.
+     *
+     * Optional, default true.
+     *
+     * @returns A list of Azure subscriptions.
+     *
+     * @throws A {@link NotSignedInError} If the user is not signed in to Azure.
+     * Use {@link isSignedIn} and/or {@link signIn} before this method to ensure
+     * the user is signed in.
+     */
+    getSubscriptions(filter: boolean | GetSubscriptionsFilter): Promise<AzureSubscription[]>;
+    /**
+     * Checks to see if a user is signed in.
+     *
+     * @param tenantId (Optional) Provide to check if a user is signed in to a specific tenant.
+     *
+     * @returns True if the user is signed in, false otherwise.
+     */
+    isSignedIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
+    /**
+     * Asks the user to sign in or pick an account to use.
+     *
+     * @param tenantId (Optional) Provide to sign in to a specific tenant.
+     * @param account (Optional) Provide to sign in to a specific account.
+     *
+     * @returns True if the user is signed in, false otherwise.
+     */
+    signIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
+    /**
+     * An event that is fired when the user signs in. Debounced to fire at most once every 5 seconds.
+     */
+    onDidSignIn: vscode.Event<void>;
+    /**
+     * Signs the user out
+     *
+     * @deprecated Not currently supported by VS Code auth providers
+     *
+     * @throws Throws an {@link Error} every time
+     */
+    signOut(): Promise<void>;
+    /**
+     * An event that is fired when the user signs out. Debounced to fire at most once every 5 seconds.
+     */
+    onDidSignOut: vscode.Event<void>;
+}

package/out/src/AzureSubscriptionProvider.js

@@ -1,7 +1,7 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=AzureSubscriptionProvider.js.map

package/out/src/AzureTenant.d.ts

@@ -1,5 +1,5 @@
-import { TenantIdDescription } from "@azure/arm-resources-subscriptions";
-import * as vscode from 'vscode';
-export interface AzureTenant extends TenantIdDescription {
-    account: vscode.AuthenticationSessionAccountInformation;
-}
+import { TenantIdDescription } from "@azure/arm-resources-subscriptions";
+import * as vscode from 'vscode';
+export interface AzureTenant extends TenantIdDescription {
+    account: vscode.AuthenticationSessionAccountInformation;
+}

package/out/src/AzureTenant.js

@@ -1,7 +1,7 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=AzureTenant.js.map

package/out/src/NotSignedInError.d.ts

@@ -1,15 +1,15 @@
-/**
- * An error indicating the user is not signed in.
- */
-export declare class NotSignedInError extends Error {
-    readonly isNotSignedInError = true;
-    constructor();
-}
-/**
- * Tests if an object is a `NotSignedInError`. This should be used instead of `instanceof`.
- *
- * @param error The object to test
- *
- * @returns True if the object is a NotSignedInError, false otherwise
- */
-export declare function isNotSignedInError(error: unknown): error is NotSignedInError;
+/**
+ * An error indicating the user is not signed in.
+ */
+export declare class NotSignedInError extends Error {
+    readonly isNotSignedInError = true;
+    constructor();
+}
+/**
+ * Tests if an object is a `NotSignedInError`. This should be used instead of `instanceof`.
+ *
+ * @param error The object to test
+ *
+ * @returns True if the object is a NotSignedInError, false otherwise
+ */
+export declare function isNotSignedInError(error: unknown): error is NotSignedInError;

package/out/src/NotSignedInError.js

@@ -1,30 +1,30 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
- *  Copyright (c) Microsoft Corporation. All rights reserved.
- *  Licensed under the MIT License. See License.txt in the project root for license information.
- *--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNotSignedInError = exports.NotSignedInError = void 0;
-const vscode = require("vscode");
-/**
- * An error indicating the user is not signed in.
- */
-class NotSignedInError extends Error {
-    constructor() {
-        super(vscode.l10n.t('You are not signed in to an Azure account. Please sign in.'));
-        this.isNotSignedInError = true;
-    }
-}
-exports.NotSignedInError = NotSignedInError;
-/**
- * Tests if an object is a `NotSignedInError`. This should be used instead of `instanceof`.
- *
- * @param error The object to test
- *
- * @returns True if the object is a NotSignedInError, false otherwise
- */
-function isNotSignedInError(error) {
-    return !!error && typeof error === 'object' && error.isNotSignedInError === true;
-}
-exports.isNotSignedInError = isNotSignedInError;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNotSignedInError = exports.NotSignedInError = void 0;
+const vscode = require("vscode");
+/**
+ * An error indicating the user is not signed in.
+ */
+class NotSignedInError extends Error {
+    constructor() {
+        super(vscode.l10n.t('You are not signed in to an Azure account. Please sign in.'));
+        this.isNotSignedInError = true;
+    }
+}
+exports.NotSignedInError = NotSignedInError;
+/**
+ * Tests if an object is a `NotSignedInError`. This should be used instead of `instanceof`.
+ *
+ * @param error The object to test
+ *
+ * @returns True if the object is a NotSignedInError, false otherwise
+ */
+function isNotSignedInError(error) {
+    return !!error && typeof error === 'object' && error.isNotSignedInError === true;
+}
+exports.isNotSignedInError = isNotSignedInError;
 //# sourceMappingURL=NotSignedInError.js.map

package/out/src/VSCodeAzureSubscriptionProvider.d.ts

@@ -1,113 +1,117 @@
-import * as vscode from 'vscode';
-import { AzureSubscription, SubscriptionId, TenantId } from './AzureSubscription';
-import { AzureSubscriptionProvider } from './AzureSubscriptionProvider';
-import { AzureTenant } from './AzureTenant';
-/**
- * A class for obtaining Azure subscription information using VSCode's built-in authentication
- * provider.
- */
-export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable implements AzureSubscriptionProvider {
-    private readonly logger?;
-    private readonly onDidSignInEmitter;
-    private lastSignInEventFired;
-    private suppressSignInEvents;
-    private readonly onDidSignOutEmitter;
-    private lastSignOutEventFired;
-    constructor(logger?: vscode.LogOutputChannel | undefined);
-    /**
-     * Gets a list of tenants available to the user.
-     * Use {@link isSignedIn} to check if the user is signed in to a particular tenant.
-     *
-     * @param account (Optional) A specific account to get tenants for. If not provided, all accounts will be used.
-     *
-     * @returns A list of tenants.
-     */
-    getTenants(account?: vscode.AuthenticationSessionAccountInformation): Promise<AzureTenant[]>;
-    /**
-     * Gets a list of Azure subscriptions available to the user.
-     *
-     * @param filter - Whether to filter the list returned, according to the list returned
-     * by `getTenantFilters()` and `getSubscriptionFilters()`. Optional, default true.
-     *
-     * @returns A list of Azure subscriptions. The list is sorted by subscription name.
-     * The list can contain duplicate subscriptions if they come from different accounts.
-     *
-     * @throws A {@link NotSignedInError} If the user is not signed in to Azure.
-     * Use {@link isSignedIn} and/or {@link signIn} before this method to ensure
-     * the user is signed in.
-     */
-    getSubscriptions(filter?: boolean): Promise<AzureSubscription[]>;
-    /**
-     * Checks to see if a user is signed in.
-     *
-     * @param tenantId (Optional) Provide to check if a user is signed in to a specific tenant.
-     * @param account (Optional) Provide to check if a user is signed in to a specific account.
-     *
-     * @returns True if the user is signed in, false otherwise.
-     *
-     * If no tenant or account is provided, then
-     * checks all accounts for a session.
-     */
-    isSignedIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
-    /**
-     * Asks the user to sign in or pick an account to use.
-     *
-     * @param tenantId (Optional) Provide to sign in to a specific tenant.
-     * @param account (Optional) Provide to sign in to a specific account.
-     *
-     * @returns True if the user is signed in, false otherwise.
-     */
-    signIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
-    /**
-     * An event that is fired when the user signs in. Debounced to fire at most once every 5 seconds.
-     */
-    readonly onDidSignIn: vscode.Event<void>;
-    /**
-     * Signs the user out
-     *
-     * @deprecated Not currently supported by VS Code auth providers
-     */
-    signOut(): Promise<void>;
-    /**
-     * An event that is fired when the user signs out. Debounced to fire at most once every 5 seconds.
-     */
-    readonly onDidSignOut: vscode.Event<void>;
-    /**
-     * Gets the tenant filters that are configured in `azureResourceGroups.selectedSubscriptions`. To
-     * override the settings with a custom filter, implement a child class with `getSubscriptionFilters()`
-     * and/or `getTenantFilters()` overridden.
-     *
-     * If no values are returned by `getTenantFilters()`, then all tenants will be scanned for subscriptions.
-     *
-     * @returns A list of tenant IDs that are configured in `azureResourceGroups.selectedSubscriptions`.
-     */
-    protected getTenantFilters(): Promise<TenantId[]>;
-    /**
-     * Gets the subscription filters that are configured in `azureResourceGroups.selectedSubscriptions`. To
-     * override the settings with a custom filter, implement a child class with `getSubscriptionFilters()`
-     * and/or `getTenantFilters()` overridden.
-     *
-     * If no values are returned by `getSubscriptionFilters()`, then all subscriptions will be returned.
-     *
-     * @returns A list of subscription IDs that are configured in `azureResourceGroups.selectedSubscriptions`.
-     */
-    protected getSubscriptionFilters(): Promise<SubscriptionId[]>;
-    /**
-     * Gets the subscriptions for a given tenant.
-     *
-     * @param tenantId The tenant ID to get subscriptions for.
-     * @param account The account to get the subscriptions for.
-     *
-     * @returns The list of subscriptions for the tenant.
-     */
-    private getSubscriptionsForTenant;
-    /**
-     * Gets a fully-configured subscription client for a given tenant ID
-     *
-     * @param tenantId (Optional) The tenant ID to get a client for
-     * @param account The account that you would like to get the session for
-     *
-     * @returns A client, the credential used by the client, and the authentication function
-     */
-    private getSubscriptionClient;
-}
+import * as vscode from 'vscode';
+import { AzureSubscription, SubscriptionId, TenantId } from './AzureSubscription';
+import { AzureSubscriptionProvider, GetSubscriptionsFilter } from './AzureSubscriptionProvider';
+import { AzureTenant } from './AzureTenant';
+/**
+ * A class for obtaining Azure subscription information using VSCode's built-in authentication
+ * provider.
+ */
+export declare class VSCodeAzureSubscriptionProvider extends vscode.Disposable implements AzureSubscriptionProvider {
+    private readonly logger?;
+    private readonly onDidSignInEmitter;
+    private lastSignInEventFired;
+    private suppressSignInEvents;
+    private readonly onDidSignOutEmitter;
+    private lastSignOutEventFired;
+    constructor(logger?: vscode.LogOutputChannel | undefined);
+    /**
+     * Gets a list of tenants available to the user.
+     * Use {@link isSignedIn} to check if the user is signed in to a particular tenant.
+     *
+     * @param account (Optional) A specific account to get tenants for. If not provided, all accounts will be used.
+     *
+     * @returns A list of tenants.
+     */
+    getTenants(account?: vscode.AuthenticationSessionAccountInformation): Promise<AzureTenant[]>;
+    /**
+     * Gets a list of Azure subscriptions available to the user.
+     *
+     * @param filter - Whether to filter the list returned. When:
+     * - `true`: according to the list returned by `getTenantFilters()` and `getSubscriptionFilters()`.
+     * - `false`: return all subscriptions.
+     * - `GetSubscriptionsFilter`: according to the values in the filter.
+     *
+     * Optional, default true.
+     *
+     * @returns A list of Azure subscriptions. The list is sorted by subscription name.
+     * The list can contain duplicate subscriptions if they come from different accounts.
+     *
+     * @throws A {@link NotSignedInError} If the user is not signed in to Azure.
+     * Use {@link isSignedIn} and/or {@link signIn} before this method to ensure
+     * the user is signed in.
+     */
+    getSubscriptions(filter?: boolean | GetSubscriptionsFilter): Promise<AzureSubscription[]>;
+    /**
+     * Checks to see if a user is signed in.
+     *
+     * @param tenantId (Optional) Provide to check if a user is signed in to a specific tenant.
+     * @param account (Optional) Provide to check if a user is signed in to a specific account.
+     *
+     * @returns True if the user is signed in, false otherwise.
+     *
+     * If no tenant or account is provided, then
+     * checks all accounts for a session.
+     */
+    isSignedIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
+    /**
+     * Asks the user to sign in or pick an account to use.
+     *
+     * @param tenantId (Optional) Provide to sign in to a specific tenant.
+     * @param account (Optional) Provide to sign in to a specific account.
+     *
+     * @returns True if the user is signed in, false otherwise.
+     */
+    signIn(tenantId?: string, account?: vscode.AuthenticationSessionAccountInformation): Promise<boolean>;
+    /**
+     * An event that is fired when the user signs in. Debounced to fire at most once every 5 seconds.
+     */
+    readonly onDidSignIn: vscode.Event<void>;
+    /**
+     * Signs the user out
+     *
+     * @deprecated Not currently supported by VS Code auth providers
+     */
+    signOut(): Promise<void>;
+    /**
+     * An event that is fired when the user signs out. Debounced to fire at most once every 5 seconds.
+     */
+    readonly onDidSignOut: vscode.Event<void>;
+    /**
+     * Gets the tenant filters that are configured in `azureResourceGroups.selectedSubscriptions`. To
+     * override the settings with a custom filter, implement a child class with `getSubscriptionFilters()`
+     * and/or `getTenantFilters()` overridden.
+     *
+     * If no values are returned by `getTenantFilters()`, then all tenants will be scanned for subscriptions.
+     *
+     * @returns A list of tenant IDs that are configured in `azureResourceGroups.selectedSubscriptions`.
+     */
+    protected getTenantFilters(): Promise<TenantId[]>;
+    /**
+     * Gets the subscription filters that are configured in `azureResourceGroups.selectedSubscriptions`. To
+     * override the settings with a custom filter, implement a child class with `getSubscriptionFilters()`
+     * and/or `getTenantFilters()` overridden.
+     *
+     * If no values are returned by `getSubscriptionFilters()`, then all subscriptions will be returned.
+     *
+     * @returns A list of subscription IDs that are configured in `azureResourceGroups.selectedSubscriptions`.
+     */
+    protected getSubscriptionFilters(): Promise<SubscriptionId[]>;
+    /**
+     * Gets the subscriptions for a given tenant.
+     *
+     * @param tenantId The tenant ID to get subscriptions for.
+     * @param account The account to get the subscriptions for.
+     *
+     * @returns The list of subscriptions for the tenant.
+     */
+    private getSubscriptionsForTenant;
+    /**
+     * Gets a fully-configured subscription client for a given tenant ID
+     *
+     * @param tenantId (Optional) The tenant ID to get a client for
+     * @param account The account that you would like to get the session for
+     *
+     * @returns A client, the credential used by the client, and the authentication function
+     */
+    private getSubscriptionClient;
+}