@azure/identity-broker 1.0.2-alpha.20240917.2 → 1.0.2-alpha.20240926.2

package/README.md

@@ -8,9 +8,9 @@ An authentication broker is an application that runs on a user’s machine that
 
 ## Getting started
 
-```typescript
-import { nativeBrokerPlugin } from "@azure/identity-broker";
+```ts snippet:getting_started
 import { useIdentityPlugin } from "@azure/identity";
+import { nativeBrokerPlugin } from "@azure/identity-broker";
 
 useIdentityPlugin(nativeBrokerPlugin);
 ```
@@ -56,15 +56,15 @@ ms-appx-web://Microsoft.AAD.BrokerPlugin/{client_id}
 
 As of `@azure/identity` version 2.0.0, the Identity client library for JavaScript includes a plugin API. This package (`@azure/identity-broker`) exports a plugin object that you must pass as an argument to the top-level `useIdentityPlugin` function from the `@azure/identity` package. Enable native broker in your program as follows:
 
-```typescript
-import { nativeBrokerPlugin } from "@azure/identity-broker";
+```ts snippet:using_plugins
 import { useIdentityPlugin, InteractiveBrowserCredential } from "@azure/identity";
+import { nativeBrokerPlugin } from "@azure/identity-broker";
 
 useIdentityPlugin(nativeBrokerPlugin);
-
 const credential = new InteractiveBrowserCredential({
   brokerOptions: {
     enabled: true,
+    parentWindowHandle: new Uint8Array(0), // This should be a handle to the parent window
   },
 });
 ```
@@ -75,32 +75,21 @@ After calling `useIdentityPlugin`, the native broker plugin is registered to the
 
 Once the plugin is registered, you can enable WAM broker authentication by passing `brokerOptions` with an `enabled` property set to `true` to a credential constructor. In the following example, we use the `InteractiveBrowserCredential`.
 
-<!-- eslint-skip -->
-```typescript
-import { nativeBrokerPlugin } from "@azure/identity-broker";
+```ts snippet:usage_example
 import { useIdentityPlugin, InteractiveBrowserCredential } from "@azure/identity";
+import { nativeBrokerPlugin } from "@azure/identity-broker";
 
 useIdentityPlugin(nativeBrokerPlugin);
-
-async function main() {
-  const credential = new InteractiveBrowserCredential({
-    brokerOptions: {
-      enabled: true,
-      parentWindowHandle: <insert_current_window_handle>
-    },
-  });
-
-  // We'll use the Microsoft Graph scope 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), "...");
-}
-
-main().catch((error) => {
-  console.error("An error occurred:", error);
-  process.exit(1);
+const credential = new InteractiveBrowserCredential({
+  brokerOptions: {
+    enabled: true,
+    parentWindowHandle: new Uint8Array(0), // This should be a handle to the parent window
+  },
 });
+// We'll use the Microsoft Graph scope as an example
+const scope = "https://graph.microsoft.com/.default";
+// Print out part of the access token
+console.log((await credential.getToken(scope)).token.substring(0, 10), "...");
 ```
 
 For a complete example of using an Electron app for retrieving a window handle, see [this sample](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity-broker/samples/v1/typescript/src/index.ts).
@@ -109,33 +98,22 @@ For a complete example of using an Electron app for retrieving a window handle,
 
 When the `useDefaultBrokerAccount` option is set to `true`, the credential will attempt to silently use the default broker account. If using the default account fails, the credential will fall back to interactive authentication.
 
-<!-- eslint-skip -->
-```typescript
-import { nativeBrokerPlugin } from "@azure/identity-broker";
+```ts snippet:use_default_account
 import { useIdentityPlugin, InteractiveBrowserCredential } from "@azure/identity";
+import { nativeBrokerPlugin } from "@azure/identity-broker";
 
 useIdentityPlugin(nativeBrokerPlugin);
-
-async function main() {
-  const credential = new InteractiveBrowserCredential({
-    brokerOptions: {
-      enabled: true,
-      useDefaultBrokerAccount: true,
-      parentWindowHandle: <insert_current_window_handle>
-    },
-  });
-
-  // We'll use the Microsoft Graph scope 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), "...");
-}
-
-main().catch((error) => {
-  console.error("An error occurred:", error);
-  process.exit(1);
+const credential = new InteractiveBrowserCredential({
+  brokerOptions: {
+    enabled: true,
+    useDefaultBrokerAccount: true,
+    parentWindowHandle: new Uint8Array(0), // This should be a handle to the parent window
+  },
 });
+// We'll use the Microsoft Graph scope 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), "...");
 ```
 
 ## Troubleshooting
@@ -146,7 +124,7 @@ See the Azure Identity [troubleshooting guide][https://github.com/Azure/azure-sd
 
 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`:
 
-```typescript
+```ts snippet:logging
 import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");

package/dist/index.js

@@ -14,12 +14,17 @@ var msalNodeExtensions = require('@azure/msal-node-extensions');
  *
  * Example:
  *
- * ```typescript
- * import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
+ * ```ts snippet:using_plugins
+ * import { useIdentityPlugin, InteractiveBrowserCredential } from "@azure/identity";
  * import { nativeBrokerPlugin } from "@azure/identity-broker";
  *
- * // Load the plugin
  * useIdentityPlugin(nativeBrokerPlugin);
+ * const credential = new InteractiveBrowserCredential({
+ *   brokerOptions: {
+ *     enabled: true,
+ *     parentWindowHandle: new Uint8Array(0), // This should be a handle to the parent window
+ *   },
+ * });
  * ```
  */
 const nativeBrokerPlugin = (context) => {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { AzurePluginContext } from \"../../identity/src/plugins/provider\";\nimport { IdentityPlugin } from \"@azure/identity\";\nimport { NativeBrokerPlugin } from \"@azure/msal-node-extensions\";\n\n/**\n * A plugin that provides WAM Integration for `@azure/identity`\n * credentials. The plugin API is compatible with `@azure/identity` versions\n * 4.0.0 and later. Load this plugin using the `useIdentityPlugin`\n * function, imported from `@azure/identity`.\n *\n * Example:\n *\n * ```typescript\n * import { useIdentityPlugin, DeviceCodeCredential } from \"@azure/identity\";\n * import { nativeBrokerPlugin } from \"@azure/identity-broker\";\n *\n * // Load the plugin\n * useIdentityPlugin(nativeBrokerPlugin);\n * ```\n */\n\nexport const nativeBrokerPlugin: IdentityPlugin = (context: unknown) => {\n  const { nativeBrokerPluginControl } = context as AzurePluginContext;\n  const brokerPlugin = new NativeBrokerPlugin();\n  nativeBrokerPluginControl.setNativeBroker(brokerPlugin);\n};\n"],"names":["NativeBrokerPlugin"],"mappings":";;;;;;AAAA;AACA;AAMA;;;;;;;;;;;;;;;AAeG;AAEU,MAAA,kBAAkB,GAAmB,CAAC,OAAgB,KAAI;AACrE,IAAA,MAAM,EAAE,yBAAyB,EAAE,GAAG,OAA6B,CAAC;AACpE,IAAA,MAAM,YAAY,GAAG,IAAIA,qCAAkB,EAAE,CAAC;AAC9C,IAAA,yBAAyB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;AAC1D;;;;"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { AzurePluginContext } from \"../../identity/src/plugins/provider\";\nimport { IdentityPlugin } from \"@azure/identity\";\nimport { NativeBrokerPlugin } from \"@azure/msal-node-extensions\";\n\n/**\n * A plugin that provides WAM Integration for `@azure/identity`\n * credentials. The plugin API is compatible with `@azure/identity` versions\n * 4.0.0 and later. Load this plugin using the `useIdentityPlugin`\n * function, imported from `@azure/identity`.\n *\n * Example:\n *\n * ```ts snippet:using_plugins\n * import { useIdentityPlugin, InteractiveBrowserCredential } from \"@azure/identity\";\n * import { nativeBrokerPlugin } from \"@azure/identity-broker\";\n *\n * useIdentityPlugin(nativeBrokerPlugin);\n * const credential = new InteractiveBrowserCredential({\n *   brokerOptions: {\n *     enabled: true,\n *     parentWindowHandle: new Uint8Array(0), // This should be a handle to the parent window\n *   },\n * });\n * ```\n */\n\nexport const nativeBrokerPlugin: IdentityPlugin = (context: unknown) => {\n  const { nativeBrokerPluginControl } = context as AzurePluginContext;\n  const brokerPlugin = new NativeBrokerPlugin();\n  nativeBrokerPluginControl.setNativeBroker(brokerPlugin);\n};\n"],"names":["NativeBrokerPlugin"],"mappings":";;;;;;AAAA;AACA;AAMA;;;;;;;;;;;;;;;;;;;;AAoBG;AAEU,MAAA,kBAAkB,GAAmB,CAAC,OAAgB,KAAI;AACrE,IAAA,MAAM,EAAE,yBAAyB,EAAE,GAAG,OAA6B,CAAC;AACpE,IAAA,MAAM,YAAY,GAAG,IAAIA,qCAAkB,EAAE,CAAC;AAC9C,IAAA,yBAAyB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;AAC1D;;;;"}

package/dist-esm/identity-broker/src/index.js

@@ -9,12 +9,17 @@ import { NativeBrokerPlugin } from "@azure/msal-node-extensions";
  *
  * Example:
  *
- * ```typescript
- * import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
+ * ```ts snippet:using_plugins
+ * import { useIdentityPlugin, InteractiveBrowserCredential } from "@azure/identity";
  * import { nativeBrokerPlugin } from "@azure/identity-broker";
  *
- * // Load the plugin
  * useIdentityPlugin(nativeBrokerPlugin);
+ * const credential = new InteractiveBrowserCredential({
+ *   brokerOptions: {
+ *     enabled: true,
+ *     parentWindowHandle: new Uint8Array(0), // This should be a handle to the parent window
+ *   },
+ * });
  * ```
  */
 export const nativeBrokerPlugin = (context) => {

package/dist-esm/identity-broker/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEjE;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAmB,CAAC,OAAgB,EAAE,EAAE;IACrE,MAAM,EAAE,yBAAyB,EAAE,GAAG,OAA6B,CAAC;IACpE,MAAM,YAAY,GAAG,IAAI,kBAAkB,EAAE,CAAC;IAC9C,yBAAyB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;AAC1D,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { AzurePluginContext } from \"../../identity/src/plugins/provider\";\nimport { IdentityPlugin } from \"@azure/identity\";\nimport { NativeBrokerPlugin } from \"@azure/msal-node-extensions\";\n\n/**\n * A plugin that provides WAM Integration for `@azure/identity`\n * credentials. The plugin API is compatible with `@azure/identity` versions\n * 4.0.0 and later. Load this plugin using the `useIdentityPlugin`\n * function, imported from `@azure/identity`.\n *\n * Example:\n *\n * ```typescript\n * import { useIdentityPlugin, DeviceCodeCredential } from \"@azure/identity\";\n * import { nativeBrokerPlugin } from \"@azure/identity-broker\";\n *\n * // Load the plugin\n * useIdentityPlugin(nativeBrokerPlugin);\n * ```\n */\n\nexport const nativeBrokerPlugin: IdentityPlugin = (context: unknown) => {\n  const { nativeBrokerPluginControl } = context as AzurePluginContext;\n  const brokerPlugin = new NativeBrokerPlugin();\n  nativeBrokerPluginControl.setNativeBroker(brokerPlugin);\n};\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAmB,CAAC,OAAgB,EAAE,EAAE;IACrE,MAAM,EAAE,yBAAyB,EAAE,GAAG,OAA6B,CAAC;IACpE,MAAM,YAAY,GAAG,IAAI,kBAAkB,EAAE,CAAC;IAC9C,yBAAyB,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;AAC1D,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { AzurePluginContext } from \"../../identity/src/plugins/provider\";\nimport { IdentityPlugin } from \"@azure/identity\";\nimport { NativeBrokerPlugin } from \"@azure/msal-node-extensions\";\n\n/**\n * A plugin that provides WAM Integration for `@azure/identity`\n * credentials. The plugin API is compatible with `@azure/identity` versions\n * 4.0.0 and later. Load this plugin using the `useIdentityPlugin`\n * function, imported from `@azure/identity`.\n *\n * Example:\n *\n * ```ts snippet:using_plugins\n * import { useIdentityPlugin, InteractiveBrowserCredential } from \"@azure/identity\";\n * import { nativeBrokerPlugin } from \"@azure/identity-broker\";\n *\n * useIdentityPlugin(nativeBrokerPlugin);\n * const credential = new InteractiveBrowserCredential({\n *   brokerOptions: {\n *     enabled: true,\n *     parentWindowHandle: new Uint8Array(0), // This should be a handle to the parent window\n *   },\n * });\n * ```\n */\n\nexport const nativeBrokerPlugin: IdentityPlugin = (context: unknown) => {\n  const { nativeBrokerPluginControl } = context as AzurePluginContext;\n  const brokerPlugin = new NativeBrokerPlugin();\n  nativeBrokerPluginControl.setNativeBroker(brokerPlugin);\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/identity-broker",
-  "version": "1.0.2-alpha.20240917.2",
+  "version": "1.0.2-alpha.20240926.2",
   "sdk-type": "client",
   "description": "A native plugin for Azure Identity credentials to enable broker authentication such as WAM",
   "main": "dist/index.js",
@@ -8,26 +8,27 @@
   "types": "./types/identity-broker.d.ts",
   "scripts": {
     "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build": "npm run extract-api && tsc -p . && dev-tool run bundle",
     "build:samples": "echo skipped",
     "build:test": "tsc -p . && dev-tool run bundle",
-    "build": "npm run extract-api && tsc -p . && dev-tool run bundle",
     "check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
     "clean": "rimraf --glob dist dist-esm types \"*.tgz\" \"*.log\"",
     "execute:samples": "echo skipped",
     "extract-api": "tsc -p . && dev-tool run extract-api",
     "format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
+    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
     "integration-test:browser": "echo skipped",
     "integration-test:node": "echo skipped",
-    "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "lint:fix": "eslint package.json api-extractor.json README.md src test --fix --fix-type [problem,suggestion]",
     "lint": "eslint package.json api-extractor.json README.md src test",
+    "lint:fix": "eslint package.json api-extractor.json README.md src test --fix --fix-type [problem,suggestion]",
     "pack": "npm pack 2>&1",
+    "test": "npm run clean && npm run build:test && npm run unit-test && npm run integration-test",
     "test:browser": "npm run clean && npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
     "test:node": "npm run clean && npm run build:test && npm run unit-test:node && npm run integration-test:node",
-    "test": "npm run clean && npm run build:test && npm run unit-test && npm run integration-test",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
     "unit-test:browser": "echo skipped",
-    "unit-test:node": "dev-tool run test:node-ts-input -- --timeout 300000 --exclude 'test/**/browser/**/*.spec.ts' 'test/**/**/*.spec.ts'",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+    "unit-test:node": "dev-tool run test:node-ts-input -- --timeout 300000 --exclude 'test/**/browser/**/*.spec.ts' --exclude 'test/snippets.spec.ts' 'test/**/**/*.spec.ts'",
+    "update-snippets": "dev-tool run update-snippets"
   },
   "files": [
     "dist/",
@@ -64,14 +65,14 @@
     "tslib": "^2.2.0"
   },
   "devDependencies": {
+    "@azure-tools/test-recorder": "^3.0.0",
+    "@azure-tools/test-utils": "^1.0.1",
     "@azure/abort-controller": "^1.1.0",
     "@azure/core-client": "^1.7.0",
     "@azure/core-util": "^1.6.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.0.4",
-    "@azure-tools/test-utils": "^1.0.1",
-    "@azure-tools/test-recorder": "^3.0.0",
     "@microsoft/api-extractor": "^7.35.1",
     "@types/mocha": "^10.0.0",
     "@types/node": "^18.0.0",
@@ -81,8 +82,8 @@
     "mocha": "^10.0.0",
     "puppeteer": "^23.0.2",
     "rimraf": "^5.0.1",
-    "typescript": "~5.5.3",
-    "sinon": "^17.0.0"
+    "sinon": "^17.0.0",
+    "typescript": "~5.6.2"
   },
   "//sampleConfiguration": {
     "productName": "Azure Identity Brokered Auth Plugin",

package/types/identity-broker.d.ts

@@ -8,12 +8,17 @@ import { IdentityPlugin } from '@azure/identity';
  *
  * Example:
  *
- * ```typescript
- * import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";
+ * ```ts snippet:using_plugins
+ * import { useIdentityPlugin, InteractiveBrowserCredential } from "@azure/identity";
  * import { nativeBrokerPlugin } from "@azure/identity-broker";
  *
- * // Load the plugin
  * useIdentityPlugin(nativeBrokerPlugin);
+ * const credential = new InteractiveBrowserCredential({
+ *   brokerOptions: {
+ *     enabled: true,
+ *     parentWindowHandle: new Uint8Array(0), // This should be a handle to the parent window
+ *   },
+ * });
  * ```
  */
 export declare const nativeBrokerPlugin: IdentityPlugin;