@azure/msal-common 14.14.2 → 14.16.0

package/src/config/ClientConfiguration.ts

@@ -3,26 +3,26 @@
  * Licensed under the MIT License.
  */
 
-import { INetworkModule } from "../network/INetworkModule";
-import { DEFAULT_CRYPTO_IMPLEMENTATION, ICrypto } from "../crypto/ICrypto";
-import { ILoggerCallback, Logger, LogLevel } from "../logger/Logger";
+import { INetworkModule } from "../network/INetworkModule.js";
+import { DEFAULT_CRYPTO_IMPLEMENTATION, ICrypto } from "../crypto/ICrypto.js";
+import { ILoggerCallback, Logger, LogLevel } from "../logger/Logger.js";
 import {
     Constants,
     DEFAULT_TOKEN_RENEWAL_OFFSET_SEC,
-} from "../utils/Constants";
-import { version } from "../packageMetadata";
-import { Authority } from "../authority/Authority";
-import { AzureCloudInstance } from "../authority/AuthorityOptions";
-import { CacheManager, DefaultStorageClass } from "../cache/CacheManager";
-import { ServerTelemetryManager } from "../telemetry/server/ServerTelemetryManager";
-import { ICachePlugin } from "../cache/interface/ICachePlugin";
-import { ISerializableTokenCache } from "../cache/interface/ISerializableTokenCache";
-import { ClientCredentials } from "../account/ClientCredentials";
-import { ProtocolMode } from "../authority/ProtocolMode";
+} from "../utils/Constants.js";
+import { version } from "../packageMetadata.js";
+import { Authority } from "../authority/Authority.js";
+import { AzureCloudInstance } from "../authority/AuthorityOptions.js";
+import { CacheManager, DefaultStorageClass } from "../cache/CacheManager.js";
+import { ServerTelemetryManager } from "../telemetry/server/ServerTelemetryManager.js";
+import { ICachePlugin } from "../cache/interface/ICachePlugin.js";
+import { ISerializableTokenCache } from "../cache/interface/ISerializableTokenCache.js";
+import { ClientCredentials } from "../account/ClientCredentials.js";
+import { ProtocolMode } from "../authority/ProtocolMode.js";
 import {
     ClientAuthErrorCodes,
     createClientAuthError,
-} from "../error/ClientAuthError";
+} from "../error/ClientAuthError.js";
 
 /**
  * Use the configuration object to configure MSAL Modules and initialize the base interfaces for MSAL.
@@ -80,15 +80,19 @@ export type CommonClientConfiguration = {
  * - cloudDiscoveryMetadata      - A string containing the cloud discovery response. Used in AAD scenarios.
  * - clientCapabilities          - Array of capabilities which will be added to the claims.access_token.xms_cc request property on every network request.
  * - protocolMode                - Enum that represents the protocol that msal follows. Used for configuring proper endpoints.
- * - skipAuthorityMetadataCache      - A flag to choose whether to use or not use the local metadata cache during authority initialization. Defaults to false.
+ * - skipAuthorityMetadataCache  - A flag to choose whether to use or not use the local metadata cache during authority initialization. Defaults to false.
+ * - instanceAware               - A flag of whether the STS will send back additional parameters to specify where the tokens should be retrieved from.
+ * - redirectUri                 - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
  * @internal
  */
 export type AuthOptions = {
     clientId: string;
     authority: Authority;
+    redirectUri: string;
     clientCapabilities?: Array<string>;
     azureCloudOptions?: AzureCloudOptions;
     skipAuthorityMetadataCache?: boolean;
+    instanceAware?: boolean;
 };
 
 /**
@@ -271,6 +275,7 @@ function buildAuthOptions(authOptions: AuthOptions): Required<AuthOptions> {
         clientCapabilities: [],
         azureCloudOptions: DEFAULT_AZURE_CLOUD_OPTIONS,
         skipAuthorityMetadataCache: false,
+        instanceAware: false,
         ...authOptions,
     };
 }

package/src/constants/AADServerParamKeys.ts

@@ -56,3 +56,5 @@ export const SID = "sid";
 export const LOGIN_HINT = "login_hint";
 export const DOMAIN_HINT = "domain_hint";
 export const X_CLIENT_EXTRA_SKU = "x-client-xtra-sku";
+export const BROKER_CLIENT_ID = "brk_client_id";
+export const BROKER_REDIRECT_URI = "brk_redirect_uri";

package/src/crypto/ICrypto.ts

@@ -6,9 +6,9 @@
 import {
     ClientAuthErrorCodes,
     createClientAuthError,
-} from "../error/ClientAuthError";
-import { BaseAuthRequest } from "../request/BaseAuthRequest";
-import { ShrOptions, SignedHttpRequest } from "./SignedHttpRequest";
+} from "../error/ClientAuthError.js";
+import { BaseAuthRequest } from "../request/BaseAuthRequest.js";
+import { ShrOptions, SignedHttpRequest } from "./SignedHttpRequest.js";
 
 /**
  * The PkceCodes type describes the structure

package/src/crypto/JoseHeader.ts

@@ -6,8 +6,8 @@
 import {
     JoseHeaderErrorCodes,
     createJoseHeaderError,
-} from "../error/JoseHeaderError";
-import { JsonWebTokenTypes } from "../utils/Constants";
+} from "../error/JoseHeaderError.js";
+import { JsonWebTokenTypes } from "../utils/Constants.js";
 
 export type JoseHeaderOptions = {
     typ?: JsonWebTokenTypes;

package/src/crypto/PopTokenGenerator.ts

@@ -3,13 +3,13 @@
  * Licensed under the MIT License.
  */
 
-import { ICrypto, SignedHttpRequestParameters } from "./ICrypto";
-import * as TimeUtils from "../utils/TimeUtils";
-import { UrlString } from "../url/UrlString";
-import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient";
-import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent";
-import { invokeAsync } from "../utils/FunctionWrappers";
-import { Logger } from "../logger/Logger";
+import { ICrypto, SignedHttpRequestParameters } from "./ICrypto.js";
+import * as TimeUtils from "../utils/TimeUtils.js";
+import { UrlString } from "../url/UrlString.js";
+import { IPerformanceClient } from "../telemetry/performance/IPerformanceClient.js";
+import { PerformanceEvents } from "../telemetry/performance/PerformanceEvent.js";
+import { invokeAsync } from "../utils/FunctionWrappers.js";
+import { Logger } from "../logger/Logger.js";
 
 /**
  * See eSTS docs for more info.

package/src/crypto/SignedHttpRequest.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { JoseHeaderOptions } from "./JoseHeader";
+import { JoseHeaderOptions } from "./JoseHeader.js";
 
 export type SignedHttpRequest = {
     at?: string;

package/src/error/AuthError.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { Constants } from "../utils/Constants";
-import * as AuthErrorCodes from "./AuthErrorCodes";
+import { Constants } from "../utils/Constants.js";
+import * as AuthErrorCodes from "./AuthErrorCodes.js";
 export { AuthErrorCodes };
 
 export const AuthErrorMessages = {

package/src/error/CacheError.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import * as CacheErrorCodes from "./CacheErrorCodes";
+import * as CacheErrorCodes from "./CacheErrorCodes.js";
 export { CacheErrorCodes };
 
 export const CacheErrorMessages = {

package/src/error/ClientAuthError.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { AuthError } from "./AuthError";
-import * as ClientAuthErrorCodes from "./ClientAuthErrorCodes";
+import { AuthError } from "./AuthError.js";
+import * as ClientAuthErrorCodes from "./ClientAuthErrorCodes.js";
 export { ClientAuthErrorCodes }; // Allow importing as "ClientAuthErrorCodes";
 
 /**

package/src/error/ClientConfigurationError.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { AuthError } from "./AuthError";
-import * as ClientConfigurationErrorCodes from "./ClientConfigurationErrorCodes";
+import { AuthError } from "./AuthError.js";
+import * as ClientConfigurationErrorCodes from "./ClientConfigurationErrorCodes.js";
 export { ClientConfigurationErrorCodes };
 
 export const ClientConfigurationErrorMessages = {

package/src/error/InteractionRequiredAuthError.ts

@@ -3,9 +3,9 @@
  * Licensed under the MIT License.
  */
 
-import { Constants } from "../utils/Constants";
-import { AuthError } from "./AuthError";
-import * as InteractionRequiredAuthErrorCodes from "./InteractionRequiredAuthErrorCodes";
+import { Constants } from "../utils/Constants.js";
+import { AuthError } from "./AuthError.js";
+import * as InteractionRequiredAuthErrorCodes from "./InteractionRequiredAuthErrorCodes.js";
 export { InteractionRequiredAuthErrorCodes };
 
 /**

package/src/error/JoseHeaderError.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { AuthError } from "./AuthError";
-import * as JoseHeaderErrorCodes from "./JoseHeaderErrorCodes";
+import { AuthError } from "./AuthError.js";
+import * as JoseHeaderErrorCodes from "./JoseHeaderErrorCodes.js";
 export { JoseHeaderErrorCodes };
 
 export const JoseHeaderErrorMessages = {

package/src/error/NetworkError.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { AuthError } from "./AuthError.js";
+
+/**
+ * Represents network related errors
+ */
+export class NetworkError extends AuthError {
+    error: AuthError;
+    httpStatus?: number;
+    responseHeaders?: Record<string, string>;
+
+    constructor(
+        error: AuthError,
+        httpStatus?: number,
+        responseHeaders?: Record<string, string>
+    ) {
+        super(error.errorCode, error.errorMessage, error.subError);
+
+        Object.setPrototypeOf(this, NetworkError.prototype);
+        this.name = "NetworkError";
+        this.error = error;
+        this.httpStatus = httpStatus;
+        this.responseHeaders = responseHeaders;
+    }
+}
+
+/**
+ * Creates NetworkError object for a failed network request
+ * @param error - Error to be thrown back to the caller
+ * @param httpStatus - Status code of the network request
+ * @param responseHeaders - Response headers of the network request, when available
+ * @returns NetworkError object
+ */
+export function createNetworkError(
+    error: AuthError,
+    httpStatus?: number,
+    responseHeaders?: Record<string, string>
+): NetworkError {
+    return new NetworkError(error, httpStatus, responseHeaders);
+}

package/src/error/ServerError.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { AuthError } from "./AuthError";
+import { AuthError } from "./AuthError.js";
 
 /**
  * Error thrown when there is an error with the server code, for example, unavailability.

package/src/exports-browser-only.ts

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export { SignedHttpRequest, ShrOptions } from "./crypto/SignedHttpRequest.js";
+export { JoseHeader } from "./crypto/JoseHeader.js";
+export { ExternalTokenResponse } from "./response/ExternalTokenResponse.js";
+export {
+    IPerformanceClient,
+    PerformanceCallbackFunction,
+    InProgressPerformanceEvent,
+    QueueMeasurement,
+} from "./telemetry/performance/IPerformanceClient.js";
+export {
+    IntFields,
+    PerformanceEvent,
+    PerformanceEvents,
+    PerformanceEventStatus,
+    SubMeasurement,
+} from "./telemetry/performance/PerformanceEvent.js";
+export { IPerformanceMeasurement } from "./telemetry/performance/IPerformanceMeasurement.js";
+export {
+    PerformanceClient,
+    PreQueueEvent,
+} from "./telemetry/performance/PerformanceClient.js";
+export { StubPerformanceClient } from "./telemetry/performance/StubPerformanceClient.js";
+
+export { PopTokenGenerator } from "./crypto/PopTokenGenerator.js";

package/src/exports-common.ts

@@ -0,0 +1,189 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as AuthToken from "./account/AuthToken.js";
+import * as AuthorityFactory from "./authority/AuthorityFactory.js";
+import * as CacheHelpers from "./cache/utils/CacheHelpers.js";
+import * as TimeUtils from "./utils/TimeUtils.js";
+import * as UrlUtils from "./utils/UrlUtils.js";
+import * as AADServerParamKeys from "./constants/AADServerParamKeys.js";
+
+export { AuthToken };
+export { AuthorityFactory };
+export { CacheHelpers };
+export { TimeUtils };
+export { UrlUtils };
+export { AADServerParamKeys };
+
+export { AuthorizationCodeClient } from "./client/AuthorizationCodeClient.js";
+export { RefreshTokenClient } from "./client/RefreshTokenClient.js";
+export { SilentFlowClient } from "./client/SilentFlowClient.js";
+export { BaseClient } from "./client/BaseClient.js";
+export {
+    AuthOptions,
+    SystemOptions,
+    LoggerOptions,
+    CacheOptions,
+    DEFAULT_SYSTEM_OPTIONS,
+    AzureCloudOptions,
+    ApplicationTelemetry,
+} from "./config/ClientConfiguration.js";
+export { ClientConfiguration } from "./config/ClientConfiguration.js";
+export {
+    AccountInfo,
+    ActiveAccountFilters,
+    TenantProfile,
+    updateAccountTenantProfileData,
+    tenantIdMatchesHomeTenant,
+    buildTenantProfile,
+} from "./account/AccountInfo.js";
+export {
+    TokenClaims,
+    getTenantIdFromIdTokenClaims,
+} from "./account/TokenClaims.js";
+export { TokenClaims as IdTokenClaims } from "./account/TokenClaims.js";
+export { CcsCredential, CcsCredentialType } from "./account/CcsCredential.js";
+export {
+    ClientInfo,
+    buildClientInfo,
+    buildClientInfoFromHomeAccountId,
+} from "./account/ClientInfo.js";
+export {
+    Authority,
+    formatAuthorityUri,
+    buildStaticAuthorityOptions,
+} from "./authority/Authority.js";
+export {
+    AuthorityOptions,
+    AzureCloudInstance,
+    StaticAuthorityOptions,
+} from "./authority/AuthorityOptions.js";
+export { AuthorityType } from "./authority/AuthorityType.js";
+export { ProtocolMode } from "./authority/ProtocolMode.js";
+export { OIDCOptions } from "./authority/OIDCOptions.js";
+export { CacheManager, DefaultStorageClass } from "./cache/CacheManager.js";
+export {
+    AccountCache,
+    AccountFilter,
+    AccessTokenCache,
+    IdTokenCache,
+    RefreshTokenCache,
+    AppMetadataCache,
+    CredentialFilter,
+    ValidCacheType,
+    ValidCredentialType,
+    TokenKeys,
+} from "./cache/utils/CacheTypes.js";
+export { CacheRecord } from "./cache/entities/CacheRecord.js";
+export { CredentialEntity } from "./cache/entities/CredentialEntity.js";
+export { AppMetadataEntity } from "./cache/entities/AppMetadataEntity.js";
+export { AccountEntity } from "./cache/entities/AccountEntity.js";
+export { IdTokenEntity } from "./cache/entities/IdTokenEntity.js";
+export { AccessTokenEntity } from "./cache/entities/AccessTokenEntity.js";
+export { RefreshTokenEntity } from "./cache/entities/RefreshTokenEntity.js";
+export { ServerTelemetryEntity } from "./cache/entities/ServerTelemetryEntity.js";
+export { AuthorityMetadataEntity } from "./cache/entities/AuthorityMetadataEntity.js";
+export { ThrottlingEntity } from "./cache/entities/ThrottlingEntity.js";
+export {
+    INetworkModule,
+    NetworkRequestOptions,
+    StubbedNetworkModule,
+} from "./network/INetworkModule.js";
+export { NetworkResponse } from "./network/NetworkResponse.js";
+export { ThrottlingUtils } from "./network/ThrottlingUtils.js";
+export { RequestThumbprint } from "./network/RequestThumbprint.js";
+export { IUri } from "./url/IUri.js";
+export { UrlString } from "./url/UrlString.js";
+export {
+    ICrypto,
+    PkceCodes,
+    DEFAULT_CRYPTO_IMPLEMENTATION,
+    SignedHttpRequestParameters,
+} from "./crypto/ICrypto.js";
+export { BaseAuthRequest } from "./request/BaseAuthRequest.js";
+export { CommonAuthorizationUrlRequest } from "./request/CommonAuthorizationUrlRequest.js";
+export { CommonAuthorizationCodeRequest } from "./request/CommonAuthorizationCodeRequest.js";
+export { CommonRefreshTokenRequest } from "./request/CommonRefreshTokenRequest.js";
+export { CommonSilentFlowRequest } from "./request/CommonSilentFlowRequest.js";
+export { CommonEndSessionRequest } from "./request/CommonEndSessionRequest.js";
+export { RequestParameterBuilder } from "./request/RequestParameterBuilder.js";
+export { StoreInCache } from "./request/StoreInCache.js";
+export { AzureRegion } from "./authority/AzureRegion.js";
+export { AzureRegionConfiguration } from "./authority/AzureRegionConfiguration.js";
+export { AuthenticationResult } from "./response/AuthenticationResult.js";
+export { AuthorizationCodePayload } from "./response/AuthorizationCodePayload.js";
+export { ServerAuthorizationCodeResponse } from "./response/ServerAuthorizationCodeResponse.js";
+export { ServerAuthorizationTokenResponse } from "./response/ServerAuthorizationTokenResponse.js";
+export {
+    ResponseHandler,
+    buildAccountToCache,
+} from "./response/ResponseHandler.js";
+export { ScopeSet } from "./request/ScopeSet.js";
+export { AuthenticationHeaderParser } from "./request/AuthenticationHeaderParser.js";
+export { ILoggerCallback, LogLevel, Logger } from "./logger/Logger.js";
+export {
+    InteractionRequiredAuthError,
+    InteractionRequiredAuthErrorCodes,
+    InteractionRequiredAuthErrorMessage,
+    createInteractionRequiredAuthError,
+} from "./error/InteractionRequiredAuthError.js";
+export {
+    AuthError,
+    AuthErrorMessage,
+    AuthErrorCodes,
+    createAuthError,
+} from "./error/AuthError.js";
+export { ServerError } from "./error/ServerError.js";
+export { NetworkError, createNetworkError } from "./error/NetworkError.js";
+export { CacheError, CacheErrorCodes } from "./error/CacheError.js";
+export {
+    ClientAuthError,
+    ClientAuthErrorMessage,
+    ClientAuthErrorCodes,
+    createClientAuthError,
+} from "./error/ClientAuthError.js";
+export {
+    ClientConfigurationError,
+    ClientConfigurationErrorMessage,
+    ClientConfigurationErrorCodes,
+    createClientConfigurationError,
+} from "./error/ClientConfigurationError.js";
+export {
+    Constants,
+    OIDC_DEFAULT_SCOPES,
+    PromptValue,
+    PersistentCacheKeys,
+    ServerResponseType,
+    ResponseMode,
+    CacheOutcome,
+    CredentialType,
+    CacheType,
+    CacheAccountType,
+    AuthenticationScheme,
+    CodeChallengeMethodValues,
+    PasswordGrantConstants,
+    ThrottlingConstants,
+    ClaimsRequestKeys,
+    HeaderNames,
+    Errors,
+    THE_FAMILY_ID,
+    ONE_DAY_IN_MS,
+    GrantType,
+    AADAuthorityConstants,
+    HttpStatus,
+    DEFAULT_TOKEN_RENEWAL_OFFSET_SEC,
+    JsonWebTokenTypes,
+} from "./utils/Constants.js";
+export { StringUtils } from "./utils/StringUtils.js";
+export { StringDict } from "./utils/MsalTypes.js";
+export {
+    ProtocolUtils,
+    RequestStateObject,
+    LibraryStateObject,
+} from "./utils/ProtocolUtils.js";
+export * from "./utils/FunctionWrappers.js";
+export { ServerTelemetryManager } from "./telemetry/server/ServerTelemetryManager.js";
+export { ServerTelemetryRequest } from "./telemetry/server/ServerTelemetryRequest.js";
+export { version } from "./packageMetadata.js";

package/src/exports-node-only.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import * as ClientAssertionUtils from "./utils/ClientAssertionUtils.js";
+
+export { ClientAssertionUtils };
+
+export {
+    IAppTokenProvider,
+    AppTokenProviderParameters,
+    AppTokenProviderResult,
+} from "./config/AppTokenProvider.js";
+export { INativeBrokerPlugin } from "./broker/nativeBroker/INativeBrokerPlugin.js";
+export { ICachePlugin } from "./cache/interface/ICachePlugin.js";
+export { TokenCacheContext } from "./cache/persistence/TokenCacheContext.js";
+export { ISerializableTokenCache } from "./cache/interface/ISerializableTokenCache.js";
+export { CommonClientCredentialRequest } from "./request/CommonClientCredentialRequest.js";
+export { CommonOnBehalfOfRequest } from "./request/CommonOnBehalfOfRequest.js";
+export { CommonDeviceCodeRequest } from "./request/CommonDeviceCodeRequest.js";
+export { CommonUsernamePasswordRequest } from "./request/CommonUsernamePasswordRequest.js";
+export { NativeRequest } from "./request/NativeRequest.js";
+export { NativeSignOutRequest } from "./request/NativeSignOutRequest.js";
+export {
+    ClientAssertion,
+    ClientAssertionConfig,
+    ClientAssertionCallback,
+} from "./account/ClientCredentials.js";
+export {
+    DeviceCodeResponse,
+    ServerDeviceCodeResponse,
+} from "./response/DeviceCodeResponse.js";
+export { getClientAssertion } from "./utils/ClientAssertionUtils.js";
+export { IGuidGenerator } from "./crypto/IGuidGenerator.js";

package/src/index-browser.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * This file is the entrypoint when importing with the browser subpath e.g. "import { someExport } from @azure/msal-common/browser"
+ *  Additional exports should be added to the applicable exports-*.ts files
+ */
+export * from "./exports-common.js";
+export * from "./exports-browser-only.js";

package/src/index-node.ts

@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * This file is the entrypoint when importing with the node subpath e.g. "import { someExport } from @azure/msal-common/node"
+ *  Additional exports should be added to the applicable exports-*.ts files
+ */
+export * from "./exports-common.js";
+export * from "./exports-node-only.js";