@azure/identity-vscode 1.0.1-alpha.20250228.2 → 1.0.1-alpha.20250303.2

package/README.md

@@ -4,15 +4,6 @@ This package provides a plugin to the Azure Identity library for JavaScript ([`@
 
 [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity-vscode) | [Samples](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity-vscode/samples-dev)
 
-## Getting started
-
-```javascript
-const { useIdentityPlugin } = require("@azure/identity");
-const { vsCodePlugin } = require("@azure/identity-vscode");
-
-useIdentityPlugin(vsCodePlugin);
-```
-
 ### Prerequisites
 
 - An [Azure subscription](https://azure.microsoft.com/free/).
@@ -39,9 +30,9 @@ If this is your first time using `@azure/identity` or Microsoft Entra ID, we rec
 
 As of `@azure/identity` version 2.0.0, the Identity client library for JavaScript includes a plugin API. This package (`@azure/identity-vscode`) exports a plugin object that you must pass as an argument to the top-level `useIdentityPlugin` function from the `@azure/identity` package. Enable authentication through the "Azure Account" extension for Visual Studio Code as follows:
 
-```javascript
-const { useIdentityPlugin } = require("@azure/identity");
-const { vsCodePlugin } = require("@azure/identity-vscode");
+```ts snippet:ReadmeSampleUsePlugin
+import { useIdentityPlugin } from "@azure/identity";
+import { vsCodePlugin } from "@azure/identity-vscode";
 
 useIdentityPlugin(vsCodePlugin);
 ```
@@ -58,51 +49,37 @@ After signing in, you may need to select a subscription (for example, if you hav
 
 Once the plugin is registered, you can use `VisualStudioCodeCredential` in a similar fashion to the other credential classes in `@azure/identity`:
 
-```javascript
-const { useIdentityPlugin, VisualStudioCodeCredential } = require("@azure/identity");
-const { vsCodePlugin } = require("@azure/identity-vscode");
+```ts snippet:ReadmeSampleVisualStudioCodeCredential
+import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
+import { vsCodePlugin } from "@azure/identity-vscode";
 
 useIdentityPlugin(vsCodePlugin);
 
-async function main() {
-  const credential = new VisualStudioCodeCredential();
-
-  // The graph.microsoft.com scope is used as an example
-  const scope = "https://graph.microsoft.com/.default";
+const credential = new VisualStudioCodeCredential();
 
-  // Print out part of the access token
-  console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
-}
+// The graph.microsoft.com scope is used as an example
+const scope = "https://graph.microsoft.com/.default";
 
-main().catch((error) => {
-  console.error("An error occurred:", error);
-  process.exit(1);
-});
+// Print out part of the access token
+console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
 ```
 
 You can also use `DefaultAzureCredential`, which will attempt to authenticate using the "Azure Account" extension for Visual Studio Code if it's available:
 
-```javascript
-const { useIdentityPlugin, DefaultAzureCredential } = require("@azure/identity");
-const { vsCodePlugin } = require("@azure/identity-vscode");
+```ts snippet:ReadmeSampleDefaultAzureCredential
+import { useIdentityPlugin, DefaultAzureCredential } from "@azure/identity";
+import { vsCodePlugin } from "@azure/identity-vscode";
 
 useIdentityPlugin(vsCodePlugin);
 
-async function main() {
-  // With the plugin enabled above, `DefaultAzureCredential` will use
-  // Visual Studio Code's "Azure Account" extension to authenticate if
-  // it is available.
-  const credential = new DefaultAzureCredential();
-
-  // This will print a JWT access_token and its expiration timestamp
-  // The graph.microsoft.com scope is used as an example
-  console.log("Token:", await credential.getToken("https://graph.microsoft.com/.default"));
-}
-
-main().catch((error) => {
-  console.error("An error occurred:", error);
-  process.exit(1);
-});
+// With the plugin enabled above, `DefaultAzureCredential` will use
+// Visual Studio Code's "Azure Account" extension to authenticate if
+// it is available.
+const credential = new DefaultAzureCredential();
+
+// This will print a JWT access_token and its expiration timestamp
+// The graph.microsoft.com scope is used as an example
+console.log("Token:", await credential.getToken("https://graph.microsoft.com/.default"));
 ```
 
 ## Troubleshooting
@@ -111,8 +88,8 @@ main().catch((error) => {
 
 Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
-const { setLogLevel } = require("@azure/logger");
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
 ```

package/dist/browser/index.d.ts

@@ -16,15 +16,19 @@ import type { IdentityPlugin } from "@azure/identity";
  *
  * Example:
  *
- * ```javascript
+ * ```ts snippet:ReadmeSampleVisualStudioCodeCredential
  * import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
  * import { vsCodePlugin } from "@azure/identity-vscode";
  *
- * // Load the plugin
  * useIdentityPlugin(vsCodePlugin);
  *
- * // Now that the plugin is loaded, this credential may be used
  * const credential = new VisualStudioCodeCredential();
+ *
+ * // The graph.microsoft.com scope is used as an example
+ * const scope = "https://graph.microsoft.com/.default";
+ *
+ * // Print out part of the access token
+ * console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
  * ```
  */
 export declare const vsCodePlugin: IdentityPlugin;

package/dist/browser/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA+BtD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,YAAY,EAAE,cAM1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA+BtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,YAAY,EAAE,cAM1B,CAAC"}

package/dist/browser/index.js

@@ -19,15 +19,19 @@ const VSCodeServiceName = "VS Code Azure";
  *
  * Example:
  *
- * ```javascript
+ * ```ts snippet:ReadmeSampleVisualStudioCodeCredential
  * import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
  * import { vsCodePlugin } from "@azure/identity-vscode";
  *
- * // Load the plugin
  * useIdentityPlugin(vsCodePlugin);
  *
- * // Now that the plugin is loaded, this credential may be used
  * const credential = new VisualStudioCodeCredential();
+ *
+ * // The graph.microsoft.com scope is used as an example
+ * const scope = "https://graph.microsoft.com/.default";
+ *
+ * // Print out part of the access token
+ * console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
  * ```
  */
 export const vsCodePlugin = (context) => {

package/dist/browser/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,MAAM,iBAAiB,GAAG,eAAe,CAAC;AA4B1C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,MAAM,YAAY,GAAmB,CAAC,OAAO,EAAE,EAAE;IACtD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAA6B,CAAC;IAElE,uBAAuB,CAAC,yBAAyB,CAAC,GAAG,EAAE,CACrD,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAC1C,CAAC;AACJ,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { IdentityPlugin } from \"@azure/identity\";\nimport keytar from \"keytar\";\n\nconst VSCodeServiceName = \"VS Code Azure\";\n\n/**\n * A function that searches for credentials in the Visual Studio Code credential store.\n *\n * @returns an array of credentials (username and password)\n */\ntype VSCodeCredentialFinder = () => Promise<Array<{ account: string; password: string }>>;\n\n/**\n * Plugin context entries for controlling VisualStudioCodeCredential.\n */\ninterface VisualStudioCodeCredentialControl {\n  setVsCodeCredentialFinder(finder: VSCodeCredentialFinder): void;\n}\n\n/**\n * Context options passed to a plugin during initialization.\n *\n * Plugin authors are responsible for casting their plugin context values\n * to this type.\n *\n * @internal\n */\ninterface AzurePluginContext {\n  vsCodeCredentialControl: VisualStudioCodeCredentialControl;\n}\n\n/**\n * A plugin that provides the dependencies of `VisualStudioCodeCredential`\n * and enables it within `@azure/identity`. The plugin API is compatible with\n * `@azure/identity` versions 2.0.0 and later. Load this plugin using the\n * `useIdentityPlugin` function, imported from `@azure/identity`.\n *\n * `VisualStudioCodeCredential` uses the authentication session from the \"Azure\n * Account\" extension in VS Code.\n *\n * To use this functionality, import `VisualStudioCodeCredential` or\n * `DefaultAzureCredential` from `@azure/identity`. If this plugin is not\n * enabled, then `VisualStudioCodeCredential` will throw a\n * `CredentialUnavailableError`, and `DefaultAzureCredential` will not be able\n * to use authentication through Visual Studio Code.\n *\n * Example:\n *\n * ```javascript\n * import { useIdentityPlugin, VisualStudioCodeCredential } from \"@azure/identity\";\n * import { vsCodePlugin } from \"@azure/identity-vscode\";\n *\n * // Load the plugin\n * useIdentityPlugin(vsCodePlugin);\n *\n * // Now that the plugin is loaded, this credential may be used\n * const credential = new VisualStudioCodeCredential();\n * ```\n */\nexport const vsCodePlugin: IdentityPlugin = (context) => {\n  const { vsCodeCredentialControl } = context as AzurePluginContext;\n\n  vsCodeCredentialControl.setVsCodeCredentialFinder(() =>\n    keytar.findCredentials(VSCodeServiceName),\n  );\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,MAAM,iBAAiB,GAAG,eAAe,CAAC;AA4B1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,MAAM,YAAY,GAAmB,CAAC,OAAO,EAAE,EAAE;IACtD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAA6B,CAAC;IAElE,uBAAuB,CAAC,yBAAyB,CAAC,GAAG,EAAE,CACrD,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAC1C,CAAC;AACJ,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { IdentityPlugin } from \"@azure/identity\";\nimport keytar from \"keytar\";\n\nconst VSCodeServiceName = \"VS Code Azure\";\n\n/**\n * A function that searches for credentials in the Visual Studio Code credential store.\n *\n * @returns an array of credentials (username and password)\n */\ntype VSCodeCredentialFinder = () => Promise<Array<{ account: string; password: string }>>;\n\n/**\n * Plugin context entries for controlling VisualStudioCodeCredential.\n */\ninterface VisualStudioCodeCredentialControl {\n  setVsCodeCredentialFinder(finder: VSCodeCredentialFinder): void;\n}\n\n/**\n * Context options passed to a plugin during initialization.\n *\n * Plugin authors are responsible for casting their plugin context values\n * to this type.\n *\n * @internal\n */\ninterface AzurePluginContext {\n  vsCodeCredentialControl: VisualStudioCodeCredentialControl;\n}\n\n/**\n * A plugin that provides the dependencies of `VisualStudioCodeCredential`\n * and enables it within `@azure/identity`. The plugin API is compatible with\n * `@azure/identity` versions 2.0.0 and later. Load this plugin using the\n * `useIdentityPlugin` function, imported from `@azure/identity`.\n *\n * `VisualStudioCodeCredential` uses the authentication session from the \"Azure\n * Account\" extension in VS Code.\n *\n * To use this functionality, import `VisualStudioCodeCredential` or\n * `DefaultAzureCredential` from `@azure/identity`. If this plugin is not\n * enabled, then `VisualStudioCodeCredential` will throw a\n * `CredentialUnavailableError`, and `DefaultAzureCredential` will not be able\n * to use authentication through Visual Studio Code.\n *\n * Example:\n *\n * ```ts snippet:ReadmeSampleVisualStudioCodeCredential\n * import { useIdentityPlugin, VisualStudioCodeCredential } from \"@azure/identity\";\n * import { vsCodePlugin } from \"@azure/identity-vscode\";\n *\n * useIdentityPlugin(vsCodePlugin);\n *\n * const credential = new VisualStudioCodeCredential();\n *\n * // The graph.microsoft.com scope is used as an example\n * const scope = \"https://graph.microsoft.com/.default\";\n *\n * // Print out part of the access token\n * console.log((await credential.getToken(scope)).token.substr(0, 10), \"...\");\n * ```\n */\nexport const vsCodePlugin: IdentityPlugin = (context) => {\n  const { vsCodeCredentialControl } = context as AzurePluginContext;\n\n  vsCodeCredentialControl.setVsCodeCredentialFinder(() =>\n    keytar.findCredentials(VSCodeServiceName),\n  );\n};\n"]}

package/dist/commonjs/index.d.ts

@@ -16,15 +16,19 @@ import type { IdentityPlugin } from "@azure/identity";
  *
  * Example:
  *
- * ```javascript
+ * ```ts snippet:ReadmeSampleVisualStudioCodeCredential
  * import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
  * import { vsCodePlugin } from "@azure/identity-vscode";
  *
- * // Load the plugin
  * useIdentityPlugin(vsCodePlugin);
  *
- * // Now that the plugin is loaded, this credential may be used
  * const credential = new VisualStudioCodeCredential();
+ *
+ * // The graph.microsoft.com scope is used as an example
+ * const scope = "https://graph.microsoft.com/.default";
+ *
+ * // Print out part of the access token
+ * console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
  * ```
  */
 export declare const vsCodePlugin: IdentityPlugin;

package/dist/commonjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA+BtD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,YAAY,EAAE,cAM1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA+BtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,YAAY,EAAE,cAM1B,CAAC"}

package/dist/commonjs/index.js

@@ -23,15 +23,19 @@ const VSCodeServiceName = "VS Code Azure";
  *
  * Example:
  *
- * ```javascript
+ * ```ts snippet:ReadmeSampleVisualStudioCodeCredential
  * import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
  * import { vsCodePlugin } from "@azure/identity-vscode";
  *
- * // Load the plugin
  * useIdentityPlugin(vsCodePlugin);
  *
- * // Now that the plugin is loaded, this credential may be used
  * const credential = new VisualStudioCodeCredential();
+ *
+ * // The graph.microsoft.com scope is used as an example
+ * const scope = "https://graph.microsoft.com/.default";
+ *
+ * // Print out part of the access token
+ * console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
  * ```
  */
 const vsCodePlugin = (context) => {

package/dist/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAGlC,4DAA4B;AAE5B,MAAM,iBAAiB,GAAG,eAAe,CAAC;AA4B1C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACI,MAAM,YAAY,GAAmB,CAAC,OAAO,EAAE,EAAE;IACtD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAA6B,CAAC;IAElE,uBAAuB,CAAC,yBAAyB,CAAC,GAAG,EAAE,CACrD,gBAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAC1C,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,YAAY,gBAMvB","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { IdentityPlugin } from \"@azure/identity\";\nimport keytar from \"keytar\";\n\nconst VSCodeServiceName = \"VS Code Azure\";\n\n/**\n * A function that searches for credentials in the Visual Studio Code credential store.\n *\n * @returns an array of credentials (username and password)\n */\ntype VSCodeCredentialFinder = () => Promise<Array<{ account: string; password: string }>>;\n\n/**\n * Plugin context entries for controlling VisualStudioCodeCredential.\n */\ninterface VisualStudioCodeCredentialControl {\n  setVsCodeCredentialFinder(finder: VSCodeCredentialFinder): void;\n}\n\n/**\n * Context options passed to a plugin during initialization.\n *\n * Plugin authors are responsible for casting their plugin context values\n * to this type.\n *\n * @internal\n */\ninterface AzurePluginContext {\n  vsCodeCredentialControl: VisualStudioCodeCredentialControl;\n}\n\n/**\n * A plugin that provides the dependencies of `VisualStudioCodeCredential`\n * and enables it within `@azure/identity`. The plugin API is compatible with\n * `@azure/identity` versions 2.0.0 and later. Load this plugin using the\n * `useIdentityPlugin` function, imported from `@azure/identity`.\n *\n * `VisualStudioCodeCredential` uses the authentication session from the \"Azure\n * Account\" extension in VS Code.\n *\n * To use this functionality, import `VisualStudioCodeCredential` or\n * `DefaultAzureCredential` from `@azure/identity`. If this plugin is not\n * enabled, then `VisualStudioCodeCredential` will throw a\n * `CredentialUnavailableError`, and `DefaultAzureCredential` will not be able\n * to use authentication through Visual Studio Code.\n *\n * Example:\n *\n * ```javascript\n * import { useIdentityPlugin, VisualStudioCodeCredential } from \"@azure/identity\";\n * import { vsCodePlugin } from \"@azure/identity-vscode\";\n *\n * // Load the plugin\n * useIdentityPlugin(vsCodePlugin);\n *\n * // Now that the plugin is loaded, this credential may be used\n * const credential = new VisualStudioCodeCredential();\n * ```\n */\nexport const vsCodePlugin: IdentityPlugin = (context) => {\n  const { vsCodeCredentialControl } = context as AzurePluginContext;\n\n  vsCodeCredentialControl.setVsCodeCredentialFinder(() =>\n    keytar.findCredentials(VSCodeServiceName),\n  );\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAGlC,4DAA4B;AAE5B,MAAM,iBAAiB,GAAG,eAAe,CAAC;AA4B1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACI,MAAM,YAAY,GAAmB,CAAC,OAAO,EAAE,EAAE;IACtD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAA6B,CAAC;IAElE,uBAAuB,CAAC,yBAAyB,CAAC,GAAG,EAAE,CACrD,gBAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAC1C,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,YAAY,gBAMvB","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { IdentityPlugin } from \"@azure/identity\";\nimport keytar from \"keytar\";\n\nconst VSCodeServiceName = \"VS Code Azure\";\n\n/**\n * A function that searches for credentials in the Visual Studio Code credential store.\n *\n * @returns an array of credentials (username and password)\n */\ntype VSCodeCredentialFinder = () => Promise<Array<{ account: string; password: string }>>;\n\n/**\n * Plugin context entries for controlling VisualStudioCodeCredential.\n */\ninterface VisualStudioCodeCredentialControl {\n  setVsCodeCredentialFinder(finder: VSCodeCredentialFinder): void;\n}\n\n/**\n * Context options passed to a plugin during initialization.\n *\n * Plugin authors are responsible for casting their plugin context values\n * to this type.\n *\n * @internal\n */\ninterface AzurePluginContext {\n  vsCodeCredentialControl: VisualStudioCodeCredentialControl;\n}\n\n/**\n * A plugin that provides the dependencies of `VisualStudioCodeCredential`\n * and enables it within `@azure/identity`. The plugin API is compatible with\n * `@azure/identity` versions 2.0.0 and later. Load this plugin using the\n * `useIdentityPlugin` function, imported from `@azure/identity`.\n *\n * `VisualStudioCodeCredential` uses the authentication session from the \"Azure\n * Account\" extension in VS Code.\n *\n * To use this functionality, import `VisualStudioCodeCredential` or\n * `DefaultAzureCredential` from `@azure/identity`. If this plugin is not\n * enabled, then `VisualStudioCodeCredential` will throw a\n * `CredentialUnavailableError`, and `DefaultAzureCredential` will not be able\n * to use authentication through Visual Studio Code.\n *\n * Example:\n *\n * ```ts snippet:ReadmeSampleVisualStudioCodeCredential\n * import { useIdentityPlugin, VisualStudioCodeCredential } from \"@azure/identity\";\n * import { vsCodePlugin } from \"@azure/identity-vscode\";\n *\n * useIdentityPlugin(vsCodePlugin);\n *\n * const credential = new VisualStudioCodeCredential();\n *\n * // The graph.microsoft.com scope is used as an example\n * const scope = \"https://graph.microsoft.com/.default\";\n *\n * // Print out part of the access token\n * console.log((await credential.getToken(scope)).token.substr(0, 10), \"...\");\n * ```\n */\nexport const vsCodePlugin: IdentityPlugin = (context) => {\n  const { vsCodeCredentialControl } = context as AzurePluginContext;\n\n  vsCodeCredentialControl.setVsCodeCredentialFinder(() =>\n    keytar.findCredentials(VSCodeServiceName),\n  );\n};\n"]}

package/dist/esm/index.d.ts

@@ -16,15 +16,19 @@ import type { IdentityPlugin } from "@azure/identity";
  *
  * Example:
  *
- * ```javascript
+ * ```ts snippet:ReadmeSampleVisualStudioCodeCredential
  * import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
  * import { vsCodePlugin } from "@azure/identity-vscode";
  *
- * // Load the plugin
  * useIdentityPlugin(vsCodePlugin);
  *
- * // Now that the plugin is loaded, this credential may be used
  * const credential = new VisualStudioCodeCredential();
+ *
+ * // The graph.microsoft.com scope is used as an example
+ * const scope = "https://graph.microsoft.com/.default";
+ *
+ * // Print out part of the access token
+ * console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
  * ```
  */
 export declare const vsCodePlugin: IdentityPlugin;

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA+BtD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,YAAY,EAAE,cAM1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA+BtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,YAAY,EAAE,cAM1B,CAAC"}

package/dist/esm/index.js

@@ -19,15 +19,19 @@ const VSCodeServiceName = "VS Code Azure";
  *
  * Example:
  *
- * ```javascript
+ * ```ts snippet:ReadmeSampleVisualStudioCodeCredential
  * import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
  * import { vsCodePlugin } from "@azure/identity-vscode";
  *
- * // Load the plugin
  * useIdentityPlugin(vsCodePlugin);
  *
- * // Now that the plugin is loaded, this credential may be used
  * const credential = new VisualStudioCodeCredential();
+ *
+ * // The graph.microsoft.com scope is used as an example
+ * const scope = "https://graph.microsoft.com/.default";
+ *
+ * // Print out part of the access token
+ * console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
  * ```
  */
 export const vsCodePlugin = (context) => {

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,MAAM,iBAAiB,GAAG,eAAe,CAAC;AA4B1C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,MAAM,YAAY,GAAmB,CAAC,OAAO,EAAE,EAAE;IACtD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAA6B,CAAC;IAElE,uBAAuB,CAAC,yBAAyB,CAAC,GAAG,EAAE,CACrD,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAC1C,CAAC;AACJ,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { IdentityPlugin } from \"@azure/identity\";\nimport keytar from \"keytar\";\n\nconst VSCodeServiceName = \"VS Code Azure\";\n\n/**\n * A function that searches for credentials in the Visual Studio Code credential store.\n *\n * @returns an array of credentials (username and password)\n */\ntype VSCodeCredentialFinder = () => Promise<Array<{ account: string; password: string }>>;\n\n/**\n * Plugin context entries for controlling VisualStudioCodeCredential.\n */\ninterface VisualStudioCodeCredentialControl {\n  setVsCodeCredentialFinder(finder: VSCodeCredentialFinder): void;\n}\n\n/**\n * Context options passed to a plugin during initialization.\n *\n * Plugin authors are responsible for casting their plugin context values\n * to this type.\n *\n * @internal\n */\ninterface AzurePluginContext {\n  vsCodeCredentialControl: VisualStudioCodeCredentialControl;\n}\n\n/**\n * A plugin that provides the dependencies of `VisualStudioCodeCredential`\n * and enables it within `@azure/identity`. The plugin API is compatible with\n * `@azure/identity` versions 2.0.0 and later. Load this plugin using the\n * `useIdentityPlugin` function, imported from `@azure/identity`.\n *\n * `VisualStudioCodeCredential` uses the authentication session from the \"Azure\n * Account\" extension in VS Code.\n *\n * To use this functionality, import `VisualStudioCodeCredential` or\n * `DefaultAzureCredential` from `@azure/identity`. If this plugin is not\n * enabled, then `VisualStudioCodeCredential` will throw a\n * `CredentialUnavailableError`, and `DefaultAzureCredential` will not be able\n * to use authentication through Visual Studio Code.\n *\n * Example:\n *\n * ```javascript\n * import { useIdentityPlugin, VisualStudioCodeCredential } from \"@azure/identity\";\n * import { vsCodePlugin } from \"@azure/identity-vscode\";\n *\n * // Load the plugin\n * useIdentityPlugin(vsCodePlugin);\n *\n * // Now that the plugin is loaded, this credential may be used\n * const credential = new VisualStudioCodeCredential();\n * ```\n */\nexport const vsCodePlugin: IdentityPlugin = (context) => {\n  const { vsCodeCredentialControl } = context as AzurePluginContext;\n\n  vsCodeCredentialControl.setVsCodeCredentialFinder(() =>\n    keytar.findCredentials(VSCodeServiceName),\n  );\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,MAAM,iBAAiB,GAAG,eAAe,CAAC;AA4B1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,MAAM,YAAY,GAAmB,CAAC,OAAO,EAAE,EAAE;IACtD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAA6B,CAAC;IAElE,uBAAuB,CAAC,yBAAyB,CAAC,GAAG,EAAE,CACrD,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAC1C,CAAC;AACJ,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { IdentityPlugin } from \"@azure/identity\";\nimport keytar from \"keytar\";\n\nconst VSCodeServiceName = \"VS Code Azure\";\n\n/**\n * A function that searches for credentials in the Visual Studio Code credential store.\n *\n * @returns an array of credentials (username and password)\n */\ntype VSCodeCredentialFinder = () => Promise<Array<{ account: string; password: string }>>;\n\n/**\n * Plugin context entries for controlling VisualStudioCodeCredential.\n */\ninterface VisualStudioCodeCredentialControl {\n  setVsCodeCredentialFinder(finder: VSCodeCredentialFinder): void;\n}\n\n/**\n * Context options passed to a plugin during initialization.\n *\n * Plugin authors are responsible for casting their plugin context values\n * to this type.\n *\n * @internal\n */\ninterface AzurePluginContext {\n  vsCodeCredentialControl: VisualStudioCodeCredentialControl;\n}\n\n/**\n * A plugin that provides the dependencies of `VisualStudioCodeCredential`\n * and enables it within `@azure/identity`. The plugin API is compatible with\n * `@azure/identity` versions 2.0.0 and later. Load this plugin using the\n * `useIdentityPlugin` function, imported from `@azure/identity`.\n *\n * `VisualStudioCodeCredential` uses the authentication session from the \"Azure\n * Account\" extension in VS Code.\n *\n * To use this functionality, import `VisualStudioCodeCredential` or\n * `DefaultAzureCredential` from `@azure/identity`. If this plugin is not\n * enabled, then `VisualStudioCodeCredential` will throw a\n * `CredentialUnavailableError`, and `DefaultAzureCredential` will not be able\n * to use authentication through Visual Studio Code.\n *\n * Example:\n *\n * ```ts snippet:ReadmeSampleVisualStudioCodeCredential\n * import { useIdentityPlugin, VisualStudioCodeCredential } from \"@azure/identity\";\n * import { vsCodePlugin } from \"@azure/identity-vscode\";\n *\n * useIdentityPlugin(vsCodePlugin);\n *\n * const credential = new VisualStudioCodeCredential();\n *\n * // The graph.microsoft.com scope is used as an example\n * const scope = \"https://graph.microsoft.com/.default\";\n *\n * // Print out part of the access token\n * console.log((await credential.getToken(scope)).token.substr(0, 10), \"...\");\n * ```\n */\nexport const vsCodePlugin: IdentityPlugin = (context) => {\n  const { vsCodeCredentialControl } = context as AzurePluginContext;\n\n  vsCodeCredentialControl.setVsCodeCredentialFinder(() =>\n    keytar.findCredentials(VSCodeServiceName),\n  );\n};\n"]}

package/dist/react-native/index.d.ts

@@ -16,15 +16,19 @@ import type { IdentityPlugin } from "@azure/identity";
  *
  * Example:
  *
- * ```javascript
+ * ```ts snippet:ReadmeSampleVisualStudioCodeCredential
  * import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
  * import { vsCodePlugin } from "@azure/identity-vscode";
  *
- * // Load the plugin
  * useIdentityPlugin(vsCodePlugin);
  *
- * // Now that the plugin is loaded, this credential may be used
  * const credential = new VisualStudioCodeCredential();
+ *
+ * // The graph.microsoft.com scope is used as an example
+ * const scope = "https://graph.microsoft.com/.default";
+ *
+ * // Print out part of the access token
+ * console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
  * ```
  */
 export declare const vsCodePlugin: IdentityPlugin;

package/dist/react-native/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA+BtD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,YAAY,EAAE,cAM1B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AA+BtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,YAAY,EAAE,cAM1B,CAAC"}

package/dist/react-native/index.js

@@ -19,15 +19,19 @@ const VSCodeServiceName = "VS Code Azure";
  *
  * Example:
  *
- * ```javascript
+ * ```ts snippet:ReadmeSampleVisualStudioCodeCredential
  * import { useIdentityPlugin, VisualStudioCodeCredential } from "@azure/identity";
  * import { vsCodePlugin } from "@azure/identity-vscode";
  *
- * // Load the plugin
  * useIdentityPlugin(vsCodePlugin);
  *
- * // Now that the plugin is loaded, this credential may be used
  * const credential = new VisualStudioCodeCredential();
+ *
+ * // The graph.microsoft.com scope is used as an example
+ * const scope = "https://graph.microsoft.com/.default";
+ *
+ * // Print out part of the access token
+ * console.log((await credential.getToken(scope)).token.substr(0, 10), "...");
  * ```
  */
 export const vsCodePlugin = (context) => {

package/dist/react-native/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,MAAM,iBAAiB,GAAG,eAAe,CAAC;AA4B1C;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,MAAM,YAAY,GAAmB,CAAC,OAAO,EAAE,EAAE;IACtD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAA6B,CAAC;IAElE,uBAAuB,CAAC,yBAAyB,CAAC,GAAG,EAAE,CACrD,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAC1C,CAAC;AACJ,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { IdentityPlugin } from \"@azure/identity\";\nimport keytar from \"keytar\";\n\nconst VSCodeServiceName = \"VS Code Azure\";\n\n/**\n * A function that searches for credentials in the Visual Studio Code credential store.\n *\n * @returns an array of credentials (username and password)\n */\ntype VSCodeCredentialFinder = () => Promise<Array<{ account: string; password: string }>>;\n\n/**\n * Plugin context entries for controlling VisualStudioCodeCredential.\n */\ninterface VisualStudioCodeCredentialControl {\n  setVsCodeCredentialFinder(finder: VSCodeCredentialFinder): void;\n}\n\n/**\n * Context options passed to a plugin during initialization.\n *\n * Plugin authors are responsible for casting their plugin context values\n * to this type.\n *\n * @internal\n */\ninterface AzurePluginContext {\n  vsCodeCredentialControl: VisualStudioCodeCredentialControl;\n}\n\n/**\n * A plugin that provides the dependencies of `VisualStudioCodeCredential`\n * and enables it within `@azure/identity`. The plugin API is compatible with\n * `@azure/identity` versions 2.0.0 and later. Load this plugin using the\n * `useIdentityPlugin` function, imported from `@azure/identity`.\n *\n * `VisualStudioCodeCredential` uses the authentication session from the \"Azure\n * Account\" extension in VS Code.\n *\n * To use this functionality, import `VisualStudioCodeCredential` or\n * `DefaultAzureCredential` from `@azure/identity`. If this plugin is not\n * enabled, then `VisualStudioCodeCredential` will throw a\n * `CredentialUnavailableError`, and `DefaultAzureCredential` will not be able\n * to use authentication through Visual Studio Code.\n *\n * Example:\n *\n * ```javascript\n * import { useIdentityPlugin, VisualStudioCodeCredential } from \"@azure/identity\";\n * import { vsCodePlugin } from \"@azure/identity-vscode\";\n *\n * // Load the plugin\n * useIdentityPlugin(vsCodePlugin);\n *\n * // Now that the plugin is loaded, this credential may be used\n * const credential = new VisualStudioCodeCredential();\n * ```\n */\nexport const vsCodePlugin: IdentityPlugin = (context) => {\n  const { vsCodeCredentialControl } = context as AzurePluginContext;\n\n  vsCodeCredentialControl.setVsCodeCredentialFinder(() =>\n    keytar.findCredentials(VSCodeServiceName),\n  );\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,MAAM,iBAAiB,GAAG,eAAe,CAAC;AA4B1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,MAAM,YAAY,GAAmB,CAAC,OAAO,EAAE,EAAE;IACtD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAA6B,CAAC;IAElE,uBAAuB,CAAC,yBAAyB,CAAC,GAAG,EAAE,CACrD,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAC1C,CAAC;AACJ,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { IdentityPlugin } from \"@azure/identity\";\nimport keytar from \"keytar\";\n\nconst VSCodeServiceName = \"VS Code Azure\";\n\n/**\n * A function that searches for credentials in the Visual Studio Code credential store.\n *\n * @returns an array of credentials (username and password)\n */\ntype VSCodeCredentialFinder = () => Promise<Array<{ account: string; password: string }>>;\n\n/**\n * Plugin context entries for controlling VisualStudioCodeCredential.\n */\ninterface VisualStudioCodeCredentialControl {\n  setVsCodeCredentialFinder(finder: VSCodeCredentialFinder): void;\n}\n\n/**\n * Context options passed to a plugin during initialization.\n *\n * Plugin authors are responsible for casting their plugin context values\n * to this type.\n *\n * @internal\n */\ninterface AzurePluginContext {\n  vsCodeCredentialControl: VisualStudioCodeCredentialControl;\n}\n\n/**\n * A plugin that provides the dependencies of `VisualStudioCodeCredential`\n * and enables it within `@azure/identity`. The plugin API is compatible with\n * `@azure/identity` versions 2.0.0 and later. Load this plugin using the\n * `useIdentityPlugin` function, imported from `@azure/identity`.\n *\n * `VisualStudioCodeCredential` uses the authentication session from the \"Azure\n * Account\" extension in VS Code.\n *\n * To use this functionality, import `VisualStudioCodeCredential` or\n * `DefaultAzureCredential` from `@azure/identity`. If this plugin is not\n * enabled, then `VisualStudioCodeCredential` will throw a\n * `CredentialUnavailableError`, and `DefaultAzureCredential` will not be able\n * to use authentication through Visual Studio Code.\n *\n * Example:\n *\n * ```ts snippet:ReadmeSampleVisualStudioCodeCredential\n * import { useIdentityPlugin, VisualStudioCodeCredential } from \"@azure/identity\";\n * import { vsCodePlugin } from \"@azure/identity-vscode\";\n *\n * useIdentityPlugin(vsCodePlugin);\n *\n * const credential = new VisualStudioCodeCredential();\n *\n * // The graph.microsoft.com scope is used as an example\n * const scope = \"https://graph.microsoft.com/.default\";\n *\n * // Print out part of the access token\n * console.log((await credential.getToken(scope)).token.substr(0, 10), \"...\");\n * ```\n */\nexport const vsCodePlugin: IdentityPlugin = (context) => {\n  const { vsCodeCredentialControl } = context as AzurePluginContext;\n\n  vsCodeCredentialControl.setVsCodeCredentialFinder(() =>\n    keytar.findCredentials(VSCodeServiceName),\n  );\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/identity-vscode",
-  "version": "1.0.1-alpha.20250228.2",
+  "version": "1.0.1-alpha.20250303.2",
   "sdk-type": "client",
   "description": "Use the Azure Account extension for Visual Studio Code to authenticate with Azure Identity",
   "main": "./dist/commonjs/index.js",
@@ -27,7 +27,7 @@
     "unit-test": "npm run unit-test:node && npm run unit-test:browser",
     "unit-test:browser": "echo skipped",
     "unit-test:node": "echo skipped",
-    "update-snippets": "echo skipped"
+    "update-snippets": "dev-tool run update-snippets"
   },
   "files": [
     "dist/",
@@ -66,16 +66,19 @@
     "@azure/core-client": "^1.7.0",
     "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
     "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
+    "@azure/logger": "^1.1.4",
     "@types/node": "^18.0.0",
-    "@vitest/coverage-istanbul": "^3.0.3",
+    "@vitest/browser": "^3.0.6",
+    "@vitest/coverage-istanbul": "^3.0.6",
     "dotenv": "^16.0.0",
     "eslint": "^9.9.0",
-    "playwright": "^1.49.0",
+    "playwright": "^1.50.1",
     "typescript": "~5.7.2",
-    "vitest": "^3.0.3"
+    "vitest": "^3.0.6"
   },
   "type": "module",
   "tshy": {
+    "project": "./tsconfig.src.json",
     "exports": {
       "./package.json": "./package.json",
       ".": "./src/index.ts"
@@ -88,8 +91,7 @@
       "browser",
       "react-native"
     ],
-    "selfLink": false,
-    "project": "./tsconfig.src.json"
+    "selfLink": false
   },
   "browser": "./dist/browser/index.js",
   "exports": {
@@ -112,5 +114,6 @@
         "default": "./dist/commonjs/index.js"
       }
     }
-  }
+  },
+  "react-native": "./dist/react-native/index.js"
 }