@azure/msal-browser 3.20.0 → 3.22.0

package/dist/interaction_client/NativeInteractionClient.d.ts

@@ -1,152 +1,152 @@
-import { Logger, ICrypto, AccountEntity, ScopeSet, IPerformanceClient, TokenClaims, InProgressPerformanceEvent, ServerTelemetryManager } from "@azure/msal-common";
-import { BaseInteractionClient } from "./BaseInteractionClient";
-import { BrowserConfiguration } from "../config/Configuration";
-import { BrowserCacheManager } from "../cache/BrowserCacheManager";
-import { EventHandler } from "../event/EventHandler";
-import { PopupRequest } from "../request/PopupRequest";
-import { SilentRequest } from "../request/SilentRequest";
-import { SsoSilentRequest } from "../request/SsoSilentRequest";
-import { NativeMessageHandler } from "../broker/nativeBroker/NativeMessageHandler";
-import { ApiId } from "../utils/BrowserConstants";
-import { NativeTokenRequest } from "../broker/nativeBroker/NativeRequest";
-import { MATS, NativeResponse } from "../broker/nativeBroker/NativeResponse";
-import { RedirectRequest } from "../request/RedirectRequest";
-import { INavigationClient } from "../navigation/INavigationClient";
-import { SilentCacheClient } from "./SilentCacheClient";
-import { AuthenticationResult } from "../response/AuthenticationResult";
-export declare class NativeInteractionClient extends BaseInteractionClient {
-    protected apiId: ApiId;
-    protected accountId: string;
-    protected nativeMessageHandler: NativeMessageHandler;
-    protected silentCacheClient: SilentCacheClient;
-    protected nativeStorageManager: BrowserCacheManager;
-    protected skus: string;
-    protected serverTelemetryManager: ServerTelemetryManager;
-    constructor(config: BrowserConfiguration, browserStorage: BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, eventHandler: EventHandler, navigationClient: INavigationClient, apiId: ApiId, performanceClient: IPerformanceClient, provider: NativeMessageHandler, accountId: string, nativeStorageImpl: BrowserCacheManager, correlationId?: string);
-    /**
-     * Adds SKUs to request extra query parameters
-     * @param request {NativeTokenRequest}
-     * @private
-     */
-    private addRequestSKUs;
-    /**
-     * Acquire token from native platform via browser extension
-     * @param request
-     */
-    acquireToken(request: PopupRequest | SilentRequest | SsoSilentRequest): Promise<AuthenticationResult>;
-    /**
-     * Creates silent flow request
-     * @param request
-     * @param cachedAccount
-     * @returns CommonSilentFlowRequest
-     */
-    private createSilentCacheRequest;
-    /**
-     * Fetches the tokens from the cache if un-expired
-     * @param nativeAccountId
-     * @param request
-     * @returns authenticationResult
-     */
-    protected acquireTokensFromCache(nativeAccountId: string, request: NativeTokenRequest): Promise<AuthenticationResult>;
-    /**
-     * Acquires a token from native platform then redirects to the redirectUri instead of returning the response
-     * @param {RedirectRequest} request
-     * @param {InProgressPerformanceEvent} rootMeasurement
-     */
-    acquireTokenRedirect(request: RedirectRequest, rootMeasurement: InProgressPerformanceEvent): Promise<void>;
-    /**
-     * If the previous page called native platform for a token using redirect APIs, send the same request again and return the response
-     * @param performanceClient {IPerformanceClient?}
-     * @param correlationId {string?} correlation identifier
-     */
-    handleRedirectPromise(performanceClient?: IPerformanceClient, correlationId?: string): Promise<AuthenticationResult | null>;
-    /**
-     * Logout from native platform via browser extension
-     * @param request
-     */
-    logout(): Promise<void>;
-    /**
-     * Transform response from native platform into AuthenticationResult object which will be returned to the end user
-     * @param response
-     * @param request
-     * @param reqTimestamp
-     */
-    protected handleNativeResponse(response: NativeResponse, request: NativeTokenRequest, reqTimestamp: number): Promise<AuthenticationResult>;
-    /**
-     * creates an homeAccountIdentifier for the account
-     * @param response
-     * @param idTokenObj
-     * @returns
-     */
-    protected createHomeAccountIdentifier(response: NativeResponse, idTokenClaims: TokenClaims): string;
-    /**
-     * Helper to generate scopes
-     * @param response
-     * @param request
-     * @returns
-     */
-    generateScopes(response: NativeResponse, request: NativeTokenRequest): ScopeSet;
-    /**
-     * If PoP token is requesred, records the PoP token if returned from the WAM, else generates one in the browser
-     * @param request
-     * @param response
-     */
-    generatePopAccessToken(response: NativeResponse, request: NativeTokenRequest): Promise<string>;
-    /**
-     * Generates authentication result
-     * @param response
-     * @param request
-     * @param idTokenObj
-     * @param accountEntity
-     * @param authority
-     * @param reqTimestamp
-     * @returns
-     */
-    protected generateAuthenticationResult(response: NativeResponse, request: NativeTokenRequest, idTokenClaims: TokenClaims, accountEntity: AccountEntity, authority: string, reqTimestamp: number): Promise<AuthenticationResult>;
-    /**
-     * cache the account entity in browser storage
-     * @param accountEntity
-     */
-    cacheAccount(accountEntity: AccountEntity): void;
-    /**
-     * Stores the access_token and id_token in inmemory storage
-     * @param response
-     * @param request
-     * @param homeAccountIdentifier
-     * @param idTokenObj
-     * @param responseAccessToken
-     * @param tenantId
-     * @param reqTimestamp
-     */
-    cacheNativeTokens(response: NativeResponse, request: NativeTokenRequest, homeAccountIdentifier: string, idTokenClaims: TokenClaims, responseAccessToken: string, tenantId: string, reqTimestamp: number): void;
-    protected addTelemetryFromNativeResponse(response: NativeResponse): MATS | null;
-    /**
-     * Validates native platform response before processing
-     * @param response
-     */
-    private validateNativeResponse;
-    /**
-     * Gets MATS telemetry from native response
-     * @param response
-     * @returns
-     */
-    private getMATSFromResponse;
-    /**
-     * Returns whether or not response came from native cache
-     * @param response
-     * @returns
-     */
-    protected isResponseFromCache(mats: MATS): boolean;
-    /**
-     * Translates developer provided request object into NativeRequest object
-     * @param request
-     */
-    protected initializeNativeRequest(request: PopupRequest | SsoSilentRequest): Promise<NativeTokenRequest>;
-    /**
-     * Handles extra broker request parameters
-     * @param request {NativeTokenRequest}
-     * @private
-     */
-    private handleExtraBrokerParams;
-}
+import { Logger, ICrypto, AccountEntity, ScopeSet, IPerformanceClient, TokenClaims, InProgressPerformanceEvent, ServerTelemetryManager } from "@azure/msal-common";
+import { BaseInteractionClient } from "./BaseInteractionClient";
+import { BrowserConfiguration } from "../config/Configuration";
+import { BrowserCacheManager } from "../cache/BrowserCacheManager";
+import { EventHandler } from "../event/EventHandler";
+import { PopupRequest } from "../request/PopupRequest";
+import { SilentRequest } from "../request/SilentRequest";
+import { SsoSilentRequest } from "../request/SsoSilentRequest";
+import { NativeMessageHandler } from "../broker/nativeBroker/NativeMessageHandler";
+import { ApiId } from "../utils/BrowserConstants";
+import { NativeTokenRequest } from "../broker/nativeBroker/NativeRequest";
+import { MATS, NativeResponse } from "../broker/nativeBroker/NativeResponse";
+import { RedirectRequest } from "../request/RedirectRequest";
+import { INavigationClient } from "../navigation/INavigationClient";
+import { SilentCacheClient } from "./SilentCacheClient";
+import { AuthenticationResult } from "../response/AuthenticationResult";
+export declare class NativeInteractionClient extends BaseInteractionClient {
+    protected apiId: ApiId;
+    protected accountId: string;
+    protected nativeMessageHandler: NativeMessageHandler;
+    protected silentCacheClient: SilentCacheClient;
+    protected nativeStorageManager: BrowserCacheManager;
+    protected skus: string;
+    protected serverTelemetryManager: ServerTelemetryManager;
+    constructor(config: BrowserConfiguration, browserStorage: BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, eventHandler: EventHandler, navigationClient: INavigationClient, apiId: ApiId, performanceClient: IPerformanceClient, provider: NativeMessageHandler, accountId: string, nativeStorageImpl: BrowserCacheManager, correlationId?: string);
+    /**
+     * Adds SKUs to request extra query parameters
+     * @param request {NativeTokenRequest}
+     * @private
+     */
+    private addRequestSKUs;
+    /**
+     * Acquire token from native platform via browser extension
+     * @param request
+     */
+    acquireToken(request: PopupRequest | SilentRequest | SsoSilentRequest): Promise<AuthenticationResult>;
+    /**
+     * Creates silent flow request
+     * @param request
+     * @param cachedAccount
+     * @returns CommonSilentFlowRequest
+     */
+    private createSilentCacheRequest;
+    /**
+     * Fetches the tokens from the cache if un-expired
+     * @param nativeAccountId
+     * @param request
+     * @returns authenticationResult
+     */
+    protected acquireTokensFromCache(nativeAccountId: string, request: NativeTokenRequest): Promise<AuthenticationResult>;
+    /**
+     * Acquires a token from native platform then redirects to the redirectUri instead of returning the response
+     * @param {RedirectRequest} request
+     * @param {InProgressPerformanceEvent} rootMeasurement
+     */
+    acquireTokenRedirect(request: RedirectRequest, rootMeasurement: InProgressPerformanceEvent): Promise<void>;
+    /**
+     * If the previous page called native platform for a token using redirect APIs, send the same request again and return the response
+     * @param performanceClient {IPerformanceClient?}
+     * @param correlationId {string?} correlation identifier
+     */
+    handleRedirectPromise(performanceClient?: IPerformanceClient, correlationId?: string): Promise<AuthenticationResult | null>;
+    /**
+     * Logout from native platform via browser extension
+     * @param request
+     */
+    logout(): Promise<void>;
+    /**
+     * Transform response from native platform into AuthenticationResult object which will be returned to the end user
+     * @param response
+     * @param request
+     * @param reqTimestamp
+     */
+    protected handleNativeResponse(response: NativeResponse, request: NativeTokenRequest, reqTimestamp: number): Promise<AuthenticationResult>;
+    /**
+     * creates an homeAccountIdentifier for the account
+     * @param response
+     * @param idTokenObj
+     * @returns
+     */
+    protected createHomeAccountIdentifier(response: NativeResponse, idTokenClaims: TokenClaims): string;
+    /**
+     * Helper to generate scopes
+     * @param response
+     * @param request
+     * @returns
+     */
+    generateScopes(response: NativeResponse, request: NativeTokenRequest): ScopeSet;
+    /**
+     * If PoP token is requesred, records the PoP token if returned from the WAM, else generates one in the browser
+     * @param request
+     * @param response
+     */
+    generatePopAccessToken(response: NativeResponse, request: NativeTokenRequest): Promise<string>;
+    /**
+     * Generates authentication result
+     * @param response
+     * @param request
+     * @param idTokenObj
+     * @param accountEntity
+     * @param authority
+     * @param reqTimestamp
+     * @returns
+     */
+    protected generateAuthenticationResult(response: NativeResponse, request: NativeTokenRequest, idTokenClaims: TokenClaims, accountEntity: AccountEntity, authority: string, reqTimestamp: number): Promise<AuthenticationResult>;
+    /**
+     * cache the account entity in browser storage
+     * @param accountEntity
+     */
+    cacheAccount(accountEntity: AccountEntity): void;
+    /**
+     * Stores the access_token and id_token in inmemory storage
+     * @param response
+     * @param request
+     * @param homeAccountIdentifier
+     * @param idTokenObj
+     * @param responseAccessToken
+     * @param tenantId
+     * @param reqTimestamp
+     */
+    cacheNativeTokens(response: NativeResponse, request: NativeTokenRequest, homeAccountIdentifier: string, idTokenClaims: TokenClaims, responseAccessToken: string, tenantId: string, reqTimestamp: number): void;
+    protected addTelemetryFromNativeResponse(response: NativeResponse): MATS | null;
+    /**
+     * Validates native platform response before processing
+     * @param response
+     */
+    private validateNativeResponse;
+    /**
+     * Gets MATS telemetry from native response
+     * @param response
+     * @returns
+     */
+    private getMATSFromResponse;
+    /**
+     * Returns whether or not response came from native cache
+     * @param response
+     * @returns
+     */
+    protected isResponseFromCache(mats: MATS): boolean;
+    /**
+     * Translates developer provided request object into NativeRequest object
+     * @param request
+     */
+    protected initializeNativeRequest(request: PopupRequest | SsoSilentRequest): Promise<NativeTokenRequest>;
+    /**
+     * Handles extra broker request parameters
+     * @param request {NativeTokenRequest}
+     * @private
+     */
+    private handleExtraBrokerParams;
+}
 //# sourceMappingURL=NativeInteractionClient.d.ts.map