[identity] Enable browser customization for web view (#27444)

Azure · Oct 23, 2023 · f814d7d · f814d7d
1 parent 6d7f635
commit f814d7d
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 3 deletions.
diff --git a/sdk/identity/identity/review/identity.api.md b/sdk/identity/identity/review/identity.api.md
@@ -116,6 +116,15 @@ export interface AzurePowerShellCredentialOptions extends MultiTenantTokenCreden
     tenantId?: string;
 }
 
+// @public
+export interface BrowserCustomizationOptions {
+    // (undocumented)
+    browserCustomizationOptions?: {
+        errorMessage: string;
+        successMessage: string;
+    };
+}
+
 // @public
 export type BrowserLoginStyle = "redirect" | "popup";
 
@@ -282,7 +291,7 @@ export interface InteractiveBrowserCredentialInBrowserOptions extends Interactiv
 }
 
 // @public
-export interface InteractiveBrowserCredentialNodeOptions extends InteractiveCredentialOptions, CredentialPersistenceOptions {
+export interface InteractiveBrowserCredentialNodeOptions extends InteractiveCredentialOptions, CredentialPersistenceOptions, BrowserCustomizationOptions {
     clientId?: string;
     loginHint?: string;
     redirectUri?: string | (() => string);

diff --git a/sdk/identity/identity/src/credentials/browserCustomizationOptions.ts b/sdk/identity/identity/src/credentials/browserCustomizationOptions.ts
@@ -0,0 +1,18 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+/**
+ * Shared configuration options for browser customization
+ */
+export interface BrowserCustomizationOptions {
+  browserCustomizationOptions?: {
+    /**
+     * Format for error messages for display in browser
+     */
+    errorMessage: string;
+    /**
+     * Format for success messages for display in browser
+     */
+    successMessage: string;
+  };
+}
diff --git a/sdk/identity/identity/src/credentials/interactiveBrowserCredential.ts b/sdk/identity/identity/src/credentials/interactiveBrowserCredential.ts
@@ -63,6 +63,8 @@ export class InteractiveBrowserCredential implements TokenCredential {
       tokenCredentialOptions: options,
       logger,
       redirectUri,
+      browserCustomizationOptions: (options as InteractiveBrowserCredentialNodeOptions)
+        .browserCustomizationOptions,
     });
     this.disableAutomaticAuthentication = options?.disableAutomaticAuthentication;
   }

diff --git a/sdk/identity/identity/src/credentials/interactiveBrowserCredentialOptions.ts b/sdk/identity/identity/src/credentials/interactiveBrowserCredentialOptions.ts
@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
+import { BrowserCustomizationOptions } from "./browserCustomizationOptions";
 import { CredentialPersistenceOptions } from "./credentialPersistenceOptions";
 import { InteractiveCredentialOptions } from "./interactiveCredentialOptions";
 
@@ -20,7 +21,8 @@ export type BrowserLoginStyle = "redirect" | "popup";
  */
 export interface InteractiveBrowserCredentialNodeOptions
   extends InteractiveCredentialOptions,
-    CredentialPersistenceOptions {
+    CredentialPersistenceOptions,
+    BrowserCustomizationOptions {
   /**
    * Gets the redirect URI of the application. This should be same as the value
    * in the application registration portal.  Defaults to `window.location.href`.

diff --git a/sdk/identity/identity/src/index.ts b/sdk/identity/identity/src/index.ts
@@ -93,7 +93,7 @@ export { VisualStudioCodeCredentialOptions } from "./credentials/visualStudioCod
 export { OnBehalfOfCredential } from "./credentials/onBehalfOfCredential";
 export { WorkloadIdentityCredential } from "./credentials/workloadIdentityCredential";
 export { WorkloadIdentityCredentialOptions } from "./credentials/workloadIdentityCredentialOptions";
-
+export { BrowserCustomizationOptions } from "./credentials/browserCustomizationOptions";
 export { TokenCachePersistenceOptions } from "./msal/nodeFlows/tokenCachePersistenceOptions";
 
 export { TokenCredential, GetTokenOptions, AccessToken } from "@azure/core-auth";

diff --git a/sdk/identity/identity/src/msal/nodeFlows/msalOpenBrowser.ts b/sdk/identity/identity/src/msal/nodeFlows/msalOpenBrowser.ts
@@ -14,6 +14,10 @@ import open from "open";
 export interface MsalOpenBrowserOptions extends MsalNodeOptions {
   redirectUri?: string;
   loginHint?: string;
+  browserCustomizationOptions?: {
+    errorMessage?: string;
+    successMessage?: string;
+  };
 }
 
 /**
@@ -31,10 +35,14 @@ export const interactiveBrowserMockable = {
  */
 export class MsalOpenBrowser extends MsalNode {
   private loginHint?: string;
+  private errorTemplate?: string;
+  private successTemplate?: string;
 
   constructor(options: MsalOpenBrowserOptions) {
     super(options);
     this.loginHint = options.loginHint;
+    this.errorTemplate = options.browserCustomizationOptions?.errorMessage;
+    this.successTemplate = options.browserCustomizationOptions?.successMessage;
     this.logger = credentialLogger("Node.js MSAL Open Browser");
   }
 
@@ -52,6 +60,8 @@ export class MsalOpenBrowser extends MsalNode {
         claims: options?.claims,
         correlationId: options?.correlationId,
         loginHint: this.loginHint,
+        errorTemplate: this.errorTemplate,
+        successTemplate: this.successTemplate,
       });
       return this.handleResult(scopes, this.clientId, result || undefined);
     } catch (err: any) {