@azure/msal-common 1.7.2 → 2.0.0

package/dist/src/account/AccountInfo.d.ts

@@ -6,6 +6,8 @@
  * - username               - preferred_username claim of the id_token that represents this account
  * - localAccountId         - Local, tenant-specific account identifer for this account object, usually used in legacy cases
  * - name                   - Full name for the account, including given name and family name
+ * - idTokenClaims          - Object contains claims from ID token
+ * - localAccountId         - The user's account ID
  */
 export declare type AccountInfo = {
     homeAccountId: string;
@@ -14,4 +16,5 @@ export declare type AccountInfo = {
     username: string;
     localAccountId: string;
     name?: string;
+    idTokenClaims?: object;
 };

package/dist/src/authority/Authority.d.ts

@@ -69,12 +69,19 @@ export declare class Authority {
      * @param openIdConfigurationEndpoint
      */
     private discoverEndpoints;
-    private get aadInstanceDiscoveryEndpointUrl();
+    /**
+     * Set the trusted hosts and validate subsequent calls
+     */
     private validateAndSetPreferredNetwork;
     /**
      * Perform endpoint discovery to discover the /authorize, /token and logout endpoints.
      */
     resolveEndpointsAsync(): Promise<void>;
+    /**
+     * Determine if given hostname is alias of this authority
+     * @param host
+     */
+    isAuthorityAlias(host: string): boolean;
     /**
      * helper function to generate environment from authority object
      * @param authority

package/dist/src/cache/CacheManager.d.ts

@@ -11,10 +11,14 @@ import { AccountInfo } from "../account/AccountInfo";
 import { AppMetadataEntity } from "./entities/AppMetadataEntity";
 import { ServerTelemetryEntity } from "./entities/ServerTelemetryEntity";
 import { ThrottlingEntity } from "./entities/ThrottlingEntity";
+import { ICrypto } from "../crypto/ICrypto";
 /**
  * Interface class which implement cache storage functions used by MSAL to perform validity checks, and store tokens.
  */
 export declare abstract class CacheManager implements ICacheManager {
+    protected clientId: string;
+    protected cryptoImpl: ICrypto;
+    constructor(clientId: string, cryptoImpl: ICrypto);
     /**
      * fetch the account entity from the platform cache
      *  @param accountKey
@@ -227,7 +231,7 @@ export declare abstract class CacheManager implements ICacheManager {
     /**
      * Retrieve AppMetadataEntity from cache
      */
-    readAppMetadataFromCache(environment: string, clientId: string): AppMetadataEntity;
+    readAppMetadataFromCache(environment: string, clientId: string): AppMetadataEntity | null;
     /**
      * Return the family_id value associated  with FOCI
      * @param environment

package/dist/src/cache/entities/AccountEntity.d.ts

@@ -4,6 +4,7 @@ import { ICrypto } from "../../crypto/ICrypto";
 import { AccountInfo } from "../../account/AccountInfo";
 import { AuthorityType } from "../../authority/AuthorityType";
 import { Logger } from "../../logger/Logger";
+import { TokenClaims } from "../../account/TokenClaims";
 /**
  * Type that defines required and optional parameters for an Account field (based on universal cache schema implemented by all MSALs).
  *
@@ -24,6 +25,7 @@ import { Logger } from "../../logger/Logger";
  *      lastModificationTime: last time this entity was modified in the cache
  *      lastModificationApp:
  *      oboAssertion: access token passed in as part of OBO request
+ *      idTokenClaims: Object containing claims parsed from ID token
  * }
  */
 export declare class AccountEntity {
@@ -38,6 +40,9 @@ export declare class AccountEntity {
     lastModificationTime?: string;
     lastModificationApp?: string;
     oboAssertion?: string;
+    cloudGraphHostName?: string;
+    msGraphHost?: string;
+    idTokenClaims?: TokenClaims;
     /**
      * Generate Account Id key component as per the schema: <home_account_id>-<environment>
      */
@@ -66,13 +71,13 @@ export declare class AccountEntity {
      * @param idToken
      * @param policy
      */
-    static createAccount(clientInfo: string, homeAccountId: string, authority: Authority, idToken: AuthToken, oboAssertion?: string): AccountEntity;
+    static createAccount(clientInfo: string, homeAccountId: string, authority: Authority, idToken: AuthToken, oboAssertion?: string, cloudGraphHostName?: string, msGraphHost?: string): AccountEntity;
     /**
      * Builds non-AAD/ADFS account.
      * @param authority
      * @param idToken
      */
-    static createGenericAccount(authority: Authority, homeAccountId: string, idToken: AuthToken, oboAssertion?: string): AccountEntity;
+    static createGenericAccount(authority: Authority, homeAccountId: string, idToken: AuthToken, oboAssertion?: string, cloudGraphHostName?: string, msGraphHost?: string): AccountEntity;
     /**
      * Generate HomeAccountId from server response
      * @param serverClientInfo

package/dist/src/cache/entities/CacheRecord.d.ts

@@ -4,10 +4,10 @@ import { RefreshTokenEntity } from "./RefreshTokenEntity";
 import { AccountEntity } from "./AccountEntity";
 import { AppMetadataEntity } from "./AppMetadataEntity";
 export declare class CacheRecord {
-    account: AccountEntity;
-    idToken: IdTokenEntity;
-    accessToken: AccessTokenEntity;
-    refreshToken: RefreshTokenEntity;
-    appMetadata: AppMetadataEntity;
-    constructor(accountEntity?: AccountEntity, idTokenEntity?: IdTokenEntity, accessTokenEntity?: AccessTokenEntity, refreshTokenEntity?: RefreshTokenEntity, appMetadataEntity?: AppMetadataEntity);
+    account: AccountEntity | null;
+    idToken: IdTokenEntity | null;
+    accessToken: AccessTokenEntity | null;
+    refreshToken: RefreshTokenEntity | null;
+    appMetadata: AppMetadataEntity | null;
+    constructor(accountEntity?: AccountEntity | null, idTokenEntity?: IdTokenEntity | null, accessTokenEntity?: AccessTokenEntity | null, refreshTokenEntity?: RefreshTokenEntity | null, appMetadataEntity?: AppMetadataEntity | null);
 }

package/dist/src/client/AuthorizationCodeClient.d.ts

@@ -4,6 +4,7 @@ import { AuthorizationCodeRequest } from "../request/AuthorizationCodeRequest";
 import { ClientConfiguration } from "../config/ClientConfiguration";
 import { AuthenticationResult } from "../response/AuthenticationResult";
 import { EndSessionRequest } from "../request/EndSessionRequest";
+import { AuthorizationCodePayload } from "../response/AuthorizationCodePayload";
 /**
  * Oauth2.0 Authorization Code client
  */
@@ -25,13 +26,13 @@ export declare class AuthorizationCodeClient extends BaseClient {
      * authorization_code_grant
      * @param request
      */
-    acquireToken(request: AuthorizationCodeRequest, cachedNonce?: string, cachedState?: string): Promise<AuthenticationResult>;
+    acquireToken(request: AuthorizationCodeRequest, authCodePayload?: AuthorizationCodePayload): Promise<AuthenticationResult | null>;
     /**
      * Handles the hash fragment response from public client code request. Returns a code response used by
      * the client to exchange for a token in acquireToken.
      * @param hashFragment
      */
-    handleFragmentResponse(hashFragment: string, cachedState: string): string;
+    handleFragmentResponse(hashFragment: string, cachedState: string): AuthorizationCodePayload;
     /**
      * Use to log out the current user, and redirect the user to the postLogoutRedirectUri.
      * Default behaviour is to redirect the user to `window.location.href`.
@@ -54,4 +55,9 @@ export declare class AuthorizationCodeClient extends BaseClient {
      * @param request
      */
     private createAuthCodeUrlQueryString;
+    /**
+     * This API validates the `EndSessionRequest` and creates a URL
+     * @param request
+     */
+    private createLogoutUrlQueryString;
 }

package/dist/src/client/BaseClient.d.ts

@@ -1,4 +1,4 @@
-import { ClientConfiguration } from "../config/ClientConfiguration";
+import { ClientConfiguration, CommonClientConfiguration } from "../config/ClientConfiguration";
 import { INetworkModule } from "../network/INetworkModule";
 import { NetworkManager, NetworkResponse } from "../network/NetworkManager";
 import { ICrypto } from "../crypto/ICrypto";
@@ -13,13 +13,13 @@ import { RequestThumbprint } from "../network/RequestThumbprint";
  */
 export declare abstract class BaseClient {
     logger: Logger;
-    protected config: ClientConfiguration;
+    protected config: CommonClientConfiguration;
     protected cryptoUtils: ICrypto;
     protected cacheManager: CacheManager;
     protected networkClient: INetworkModule;
-    protected serverTelemetryManager: ServerTelemetryManager;
+    protected serverTelemetryManager: ServerTelemetryManager | null;
     protected networkManager: NetworkManager;
-    protected authority: Authority;
+    authority: Authority;
     protected constructor(configuration: ClientConfiguration);
     /**
      * Creates default headers for requests to token endpoint
@@ -37,4 +37,9 @@ export declare abstract class BaseClient {
      * @param thumbprint
      */
     protected executePostToTokenEndpoint(tokenEndpoint: string, queryString: string, headers: Record<string, string>, thumbprint: RequestThumbprint): Promise<NetworkResponse<ServerAuthorizationTokenResponse>>;
+    /**
+     * Updates the authority object of the client. Endpoint discovery must be completed.
+     * @param updatedAuthority
+     */
+    updateAuthority(updatedAuthority: Authority): void;
 }

package/dist/src/client/ClientCredentialClient.d.ts

@@ -8,9 +8,29 @@ import { ClientCredentialRequest } from "../request/ClientCredentialRequest";
 export declare class ClientCredentialClient extends BaseClient {
     private scopeSet;
     constructor(configuration: ClientConfiguration);
-    acquireToken(request: ClientCredentialRequest): Promise<AuthenticationResult>;
+    /**
+     * Public API to acquire a token with ClientCredential Flow for Confidential clients
+     * @param request
+     */
+    acquireToken(request: ClientCredentialRequest): Promise<AuthenticationResult | null>;
+    /**
+     * looks up cache if the tokens are cached already
+     */
     private getCachedAuthenticationResult;
+    /**
+     * Reads access token from the cache
+     * TODO: Move this call to cacheManager instead
+     */
     private readAccessTokenFromCache;
+    /**
+     * Makes a network call to request the token from the service
+     * @param request
+     * @param authority
+     */
     private executeTokenRequest;
+    /**
+     * generate the request to the server in the acceptable format
+     * @param request
+     */
     private createTokenRequestBody;
 }

package/dist/src/client/DeviceCodeClient.d.ts

@@ -12,7 +12,7 @@ export declare class DeviceCodeClient extends BaseClient {
      * polls token endpoint to exchange device code for tokens
      * @param request
      */
-    acquireToken(request: DeviceCodeRequest): Promise<AuthenticationResult>;
+    acquireToken(request: DeviceCodeRequest): Promise<AuthenticationResult | null>;
     /**
      * Creates device code request and executes http GET
      * @param request

package/dist/src/client/OnBehalfOfClient.d.ts

@@ -8,11 +8,40 @@ import { OnBehalfOfRequest } from "../request/OnBehalfOfRequest";
 export declare class OnBehalfOfClient extends BaseClient {
     private scopeSet;
     constructor(configuration: ClientConfiguration);
-    acquireToken(request: OnBehalfOfRequest): Promise<AuthenticationResult>;
+    /**
+     * Public API to acquire tokens with on behalf of flow
+     * @param request
+     */
+    acquireToken(request: OnBehalfOfRequest): Promise<AuthenticationResult | null>;
+    /**
+     * look up cache for tokens
+     * @param request
+     */
     private getCachedAuthenticationResult;
+    /**
+     * read access token from cache TODO: CacheManager API should be used here
+     * @param request
+     */
     private readAccessTokenFromCache;
+    /**
+     * read idtoken from cache TODO: CacheManager API should be used here instead
+     * @param request
+     */
     private readIdTokenFromCache;
+    /**
+     * read account from cache, TODO: CacheManager API should be used here instead
+     * @param account
+     */
     private readAccountFromCache;
+    /**
+     * Make a network call to the server requesting credentials
+     * @param request
+     * @param authority
+     */
     private executeTokenRequest;
+    /**
+     * generate a server request in accepable format
+     * @param request
+     */
     private createTokenRequestBody;
 }

package/dist/src/client/RefreshTokenClient.d.ts

@@ -8,12 +8,12 @@ import { SilentFlowRequest } from "../request/SilentFlowRequest";
  */
 export declare class RefreshTokenClient extends BaseClient {
     constructor(configuration: ClientConfiguration);
-    acquireToken(request: RefreshTokenRequest): Promise<AuthenticationResult>;
+    acquireToken(request: RefreshTokenRequest): Promise<AuthenticationResult | null>;
     /**
      * Gets cached refresh token and attaches to request, then calls acquireToken API
      * @param request
      */
-    acquireTokenByRefreshToken(request: SilentFlowRequest): Promise<AuthenticationResult>;
+    acquireTokenByRefreshToken(request: SilentFlowRequest): Promise<AuthenticationResult | null>;
     /**
      * makes a network call to acquire tokens by exchanging RefreshToken available in userCache; throws if refresh token is not cached
      * @param request

package/dist/src/client/SilentFlowClient.d.ts

@@ -9,7 +9,7 @@ export declare class SilentFlowClient extends BaseClient {
      * the given token and returns the renewed token
      * @param request
      */
-    acquireToken(request: SilentFlowRequest): Promise<AuthenticationResult>;
+    acquireToken(request: SilentFlowRequest): Promise<AuthenticationResult | null>;
     /**
      * Retrieves token from cache or throws an error if it must be refreshed.
      * @param request

package/dist/src/client/UsernamePasswordClient.d.ts

@@ -13,7 +13,7 @@ export declare class UsernamePasswordClient extends BaseClient {
      * password_grant
      * @param request
      */
-    acquireToken(request: UsernamePasswordRequest): Promise<AuthenticationResult>;
+    acquireToken(request: UsernamePasswordRequest): Promise<AuthenticationResult | null>;
     /**
      * Executes POST request to token endpoint
      * @param authority

package/dist/src/config/ClientConfiguration.d.ts

@@ -29,9 +29,22 @@ export declare type ClientConfiguration = {
     cryptoInterface?: ICrypto;
     clientCredentials?: ClientCredentials;
     libraryInfo?: LibraryInfo;
-    serverTelemetryManager?: ServerTelemetryManager;
-    persistencePlugin?: ICachePlugin;
-    serializableCache?: ISerializableTokenCache;
+    serverTelemetryManager?: ServerTelemetryManager | null;
+    persistencePlugin?: ICachePlugin | null;
+    serializableCache?: ISerializableTokenCache | null;
+};
+export declare type CommonClientConfiguration = {
+    authOptions: Required<AuthOptions>;
+    systemOptions: Required<SystemOptions>;
+    loggerOptions: Required<LoggerOptions>;
+    storageInterface: CacheManager;
+    networkInterface: INetworkModule;
+    cryptoInterface: Required<ICrypto>;
+    libraryInfo: LibraryInfo;
+    serverTelemetryManager: ServerTelemetryManager | null;
+    clientCredentials: ClientCredentials;
+    persistencePlugin: ICachePlugin | null;
+    serializableCache: ISerializableTokenCache | null;
 };
 /**
  * Use this to configure the auth options in the ClientConfiguration object
@@ -45,7 +58,7 @@ export declare type ClientConfiguration = {
  */
 export declare type AuthOptions = {
     clientId: string;
-    authority?: Authority;
+    authority: Authority;
     knownAuthorities?: Array<string>;
     cloudDiscoveryMetadata?: string;
     clientCapabilities?: Array<string>;
@@ -90,7 +103,7 @@ export declare type ClientCredentials = {
         assertionType: string;
     };
 };
-export declare const DEFAULT_SYSTEM_OPTIONS: SystemOptions;
+export declare const DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>;
 /**
  * Function that sets the default options when not explicitly configured from app developer
  *
@@ -98,4 +111,4 @@ export declare const DEFAULT_SYSTEM_OPTIONS: SystemOptions;
  *
  * @returns Configuration
  */
-export declare function buildClientConfiguration({ authOptions: userAuthOptions, systemOptions: userSystemOptions, loggerOptions: userLoggerOption, storageInterface: storageImplementation, networkInterface: networkImplementation, cryptoInterface: cryptoImplementation, clientCredentials: clientCredentials, libraryInfo: libraryInfo, serverTelemetryManager: serverTelemetryManager, persistencePlugin: persistencePlugin, serializableCache: serializableCache }: ClientConfiguration): ClientConfiguration;
+export declare function buildClientConfiguration({ authOptions: userAuthOptions, systemOptions: userSystemOptions, loggerOptions: userLoggerOption, storageInterface: storageImplementation, networkInterface: networkImplementation, cryptoInterface: cryptoImplementation, clientCredentials: clientCredentials, libraryInfo: libraryInfo, serverTelemetryManager: serverTelemetryManager, persistencePlugin: persistencePlugin, serializableCache: serializableCache }: ClientConfiguration): CommonClientConfiguration;

package/dist/src/error/AuthError.d.ts

@@ -13,8 +13,8 @@ export declare const AuthErrorMessage: {
 export declare class AuthError extends Error {
     errorCode: string;
     errorMessage: string;
-    suberror: string;
-    constructor(errorCode: string, errorMessage?: string, suberror?: string);
+    subError: string;
+    constructor(errorCode?: string, errorMessage?: string, suberror?: string);
     /**
      * Creates an error that is thrown when something unexpected happens in the library.
      * @param errDesc

package/dist/src/error/ClientAuthError.d.ts

@@ -40,10 +40,18 @@ export declare const ClientAuthErrorMessage: {
         code: string;
         desc: string;
     };
+    stateNotFoundError: {
+        code: string;
+        desc: string;
+    };
     nonceMismatchError: {
         code: string;
         desc: string;
     };
+    nonceNotFoundError: {
+        code: string;
+        desc: string;
+    };
     noTokensFoundError: {
         code: string;
         desc: string;
@@ -136,6 +144,14 @@ export declare const ClientAuthErrorMessage: {
         code: string;
         desc: string;
     };
+    tokenClaimsRequired: {
+        code: string;
+        desc: string;
+    };
+    noAuthorizationCodeFromServer: {
+        code: string;
+        desc: string;
+    };
 };
 /**
  * Error thrown when there is an error in the client code running on the browser.
@@ -151,7 +167,7 @@ export declare class ClientAuthError extends AuthError {
      * Creates an error thrown if the client info is empty.
      * @param rawClientInfo
      */
-    static createClientInfoEmptyError(rawClientInfo: string): ClientAuthError;
+    static createClientInfoEmptyError(): ClientAuthError;
     /**
      * Creates an error thrown when the id token extraction errors out.
      * @param err
@@ -180,10 +196,20 @@ export declare class ClientAuthError extends AuthError {
      * Creates an error thrown when two states do not match.
      */
     static createStateMismatchError(): ClientAuthError;
+    /**
+     * Creates an error thrown when the state is not present
+     * @param missingState
+     */
+    static createStateNotFoundError(missingState: string): ClientAuthError;
     /**
      * Creates an error thrown when the nonce does not match.
      */
     static createNonceMismatchError(): ClientAuthError;
+    /**
+     * Creates an error thrown when the mnonce is not present
+     * @param missingNonce
+     */
+    static createNonceNotFoundError(missingNonce: string): ClientAuthError;
     /**
      * Creates an error thrown when the authorization code required for a token request is null or empty.
      */
@@ -281,4 +307,12 @@ export declare class ClientAuthError extends AuthError {
      * Throws error if token cannot be retrieved from cache due to refresh being required.
      */
     static createRefreshRequiredError(): ClientAuthError;
+    /**
+     * Throws error if token claims are not populated for a signed jwt generation
+     */
+    static createTokenClaimsRequiredError(): ClientAuthError;
+    /**
+     * Throws error when the authorization code is missing from the server response
+     */
+    static createNoAuthCodeInServerResponseError(): ClientAuthError;
 }

package/dist/src/error/ClientConfigurationError.d.ts

@@ -75,6 +75,10 @@ export declare const ClientConfigurationErrorMessage: {
         code: string;
         desc: string;
     };
+    resourceRequestParametersRequired: {
+        code: string;
+        desc: string;
+    };
 };
 /**
  * Error thrown when there is an error in configuration of the MSAL.js library.
@@ -160,4 +164,8 @@ export declare class ClientConfigurationError extends ClientAuthError {
      * Throws error when provided authority is not a member of the trusted host list
      */
     static createUntrustedAuthorityError(): ClientConfigurationError;
+    /**
+     * Throws error when resourceRequestMethod or resourceRequestUri is missing
+     */
+    static createResourceRequestParametersRequiredError(): ClientConfigurationError;
 }

package/dist/src/error/InteractionRequiredAuthError.d.ts

@@ -8,6 +8,6 @@ export declare const InteractionRequiredAuthSubErrorMessage: string[];
  * Error thrown when user interaction is required at the auth server.
  */
 export declare class InteractionRequiredAuthError extends ServerError {
-    constructor(errorCode: string, errorMessage?: string, subError?: string);
-    static isInteractionRequiredError(errorCode: string, errorString: string, subError?: string): boolean;
+    constructor(errorCode?: string, errorMessage?: string, subError?: string);
+    static isInteractionRequiredError(errorCode?: string, errorString?: string, subError?: string): boolean;
 }

package/dist/src/error/ServerError.d.ts

@@ -3,6 +3,5 @@ import { AuthError } from "./AuthError";
  * Error thrown when there is an error with the server code, for example, unavailability.
  */
 export declare class ServerError extends AuthError {
-    subError: string;
-    constructor(errorCode: string, errorMessage?: string, subError?: string);
+    constructor(errorCode?: string, errorMessage?: string, subError?: string);
 }

package/dist/src/index.d.ts

@@ -50,7 +50,9 @@ export { DeviceCodeRequest } from "./request/DeviceCodeRequest";
 export { EndSessionRequest } from "./request/EndSessionRequest";
 export { UsernamePasswordRequest } from "./request/UsernamePasswordRequest";
 export { AuthenticationResult } from "./response/AuthenticationResult";
+export { AuthorizationCodePayload } from "./response/AuthorizationCodePayload";
 export { ServerAuthorizationCodeResponse } from "./response/ServerAuthorizationCodeResponse";
+export { DeviceCodeResponse } from "./response/DeviceCodeResponse";
 export { ILoggerCallback, LogLevel, Logger } from "./logger/Logger";
 export { InteractionRequiredAuthError } from "./error/InteractionRequiredAuthError";
 export { AuthError, AuthErrorMessage } from "./error/AuthError";

package/dist/src/logger/Logger.d.ts

@@ -31,7 +31,13 @@ export declare class Logger {
     private level;
     private piiLoggingEnabled;
     private localCallback;
-    constructor(loggerOptions: LoggerOptions);
+    private packageName;
+    private packageVersion;
+    constructor(loggerOptions: LoggerOptions, packageName?: string, packageVersion?: string);
+    /**
+     * Create new Logger with existing configurations.
+     */
+    clone(packageName: string, packageVersion: string): Logger;
     /**
      * Log message with required options.
      */

package/dist/src/request/AuthorizationCodeRequest.d.ts

@@ -15,8 +15,8 @@ import { AuthenticationScheme } from "../utils/Constants";
  * - resourceRequestUri         - URI that token will be used for. Used for proof-of-possession flows.
  */
 export declare type AuthorizationCodeRequest = BaseAuthRequest & {
-    redirectUri: string;
+    authenticationScheme: AuthenticationScheme;
     code: string;
+    redirectUri: string;
     codeVerifier?: string;
-    authenticationScheme?: AuthenticationScheme;
 };

package/dist/src/request/AuthorizationUrlRequest.d.ts

@@ -31,18 +31,18 @@ import { AccountInfo } from "../account/AccountInfo";
  * - resourceRequestUri         - URI that token will be used for. Used for proof-of-possession flows.
  */
 export declare type AuthorizationUrlRequest = BaseAuthRequest & {
-    authenticationScheme?: AuthenticationScheme;
-    redirectUri?: string;
-    extraScopesToConsent?: Array<string>;
-    responseMode?: ResponseMode;
+    authenticationScheme: AuthenticationScheme;
+    redirectUri: string;
+    responseMode: ResponseMode;
+    account?: AccountInfo;
     codeChallenge?: string;
     codeChallengeMethod?: string;
-    state?: string;
-    prompt?: string;
-    account?: AccountInfo;
-    loginHint?: string;
     domainHint?: string;
-    sid?: string;
     extraQueryParameters?: StringDict;
+    extraScopesToConsent?: Array<string>;
+    loginHint?: string;
     nonce?: string;
+    prompt?: string;
+    sid?: string;
+    state?: string;
 };

package/dist/src/request/BaseAuthRequest.d.ts

@@ -8,10 +8,10 @@
  * - resourceRequestUri         - URI that token will be used for. Used for proof-of-possession flows.
  */
 export declare type BaseAuthRequest = {
+    authority: string;
+    correlationId: string;
     scopes: Array<string>;
     claims?: string;
-    authority?: string;
-    correlationId?: string;
     resourceRequestMethod?: string;
     resourceRequestUri?: string;
 };

package/dist/src/request/ClientCredentialRequest.d.ts

@@ -1,6 +1,6 @@
 import { BaseAuthRequest } from "./BaseAuthRequest";
 /**
- * RefreshTokenRequest
+ * ClientCredentialRequest
  * - scopes                  - Array of scopes the application is requesting access to.
  * - authority               - URL of the authority, the security token service (STS) from which MSAL will acquire tokens.
  * - correlationId           - Unique GUID set per request to trace a request end-to-end for telemetry purposes.

package/dist/src/request/EndSessionRequest.d.ts

@@ -3,12 +3,12 @@ import { AccountInfo } from "../account/AccountInfo";
  * EndSessionRequest
  * - account                - Account object that will be logged out of. All tokens tied to this account will be cleared.
  * - postLogoutRedirectUri  - URI to navigate to after logout page.
- * - authority              - Authority to send logout request to.
  * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ * - idTokenHint            - ID Token used by B2C to validate logout if required by the policy
  */
 export declare type EndSessionRequest = {
+    correlationId: string;
     account?: AccountInfo;
     postLogoutRedirectUri?: string;
-    authority?: string;
-    correlationId?: string;
+    idTokenHint?: string;
 };

package/dist/src/request/RefreshTokenRequest.d.ts

@@ -12,5 +12,5 @@ import { AuthenticationScheme } from "../utils/Constants";
  */
 export declare type RefreshTokenRequest = BaseAuthRequest & {
     refreshToken: string;
-    authenticationScheme?: AuthenticationScheme;
+    authenticationScheme: AuthenticationScheme;
 };

package/dist/src/request/RequestParameterBuilder.d.ts

@@ -29,6 +29,16 @@ export declare class RequestParameterBuilder {
      * @param redirectUri
      */
     addRedirectUri(redirectUri: string): void;
+    /**
+     * add post logout redirectUri
+     * @param redirectUri
+     */
+    addPostLogoutRedirectUri(redirectUri: string): void;
+    /**
+     * add id_token_hint to logout request
+     * @param idTokenHint
+     */
+    addIdTokenHint(idTokenHint: string): void;
     /**
      * add domain_hint
      * @param domainHint
@@ -48,7 +58,7 @@ export declare class RequestParameterBuilder {
      * add claims
      * @param claims
      */
-    addClaims(claims: string, clientCapabilities: Array<string>): void;
+    addClaims(claims?: string, clientCapabilities?: Array<string>): void;
     /**
      * add correlationId
      * @param correlationId
@@ -141,7 +151,7 @@ export declare class RequestParameterBuilder {
      * @param eQparams
      */
     addExtraQueryParameters(eQparams: StringDict): void;
-    addClientCapabilitiesToClaims(claims: string, clientCapabilities: Array<string>): string;
+    addClientCapabilitiesToClaims(claims?: string, clientCapabilities?: Array<string>): string;
     /**
      * adds `username` for Password Grant flow
      * @param username

package/dist/src/request/SilentFlowRequest.d.ts

@@ -13,5 +13,5 @@ import { BaseAuthRequest } from "./BaseAuthRequest";
  */
 export declare type SilentFlowRequest = BaseAuthRequest & {
     account: AccountInfo;
-    forceRefresh?: boolean;
+    forceRefresh: boolean;
 };