From 42f5a27c548d6ebe0a71c235760baa9e6ea32693 Mon Sep 17 00:00:00 2001 From: VSC-Service-Account Date: Tue, 14 Mar 2023 03:05:27 +0000 Subject: [PATCH 01/24] CI Update Build.Reason:Manual by Yanan Zhao Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=351647&view=results --- .../@azure/msal-angular/IMsalService.yml | 12 - .../@azure/msal-angular/MatchingResources.yml | 1 - .../MsalBroadcastConfiguration.yml | 1 - .../msal-angular/MsalBroadcastService.yml | 4 - .../MsalCustomNavigationClient.yml | 4 - .../@azure/msal-angular/MsalGuard.yml | 8 - .../msal-angular/MsalGuardAuthRequest.yml | 1 - .../msal-angular/MsalGuardConfiguration.yml | 1 - .../@azure/msal-angular/MsalInterceptor.yml | 13 +- .../MsalInterceptorAuthRequest.yml | 1 - .../MsalInterceptorConfiguration.yml | 1 - .../@azure/msal-angular/MsalModule.yml | 2 - .../msal-angular/MsalRedirectComponent.yml | 3 - .../@azure/msal-angular/MsalService.yml | 16 - .../msal-angular/ProtectedResourceScopes.yml | 6 +- .../@azure/msal-browser/ApiId.yml | 1 - .../msal-browser/AsyncMemoryStorage.yml | 151 ----- .../msal-browser/AuthorizationCodeRequest.yml | 1 - .../msal-browser/AuthorizationUrlRequest.yml | 1 - .../@azure/msal-browser/Base64Decode.yml | 32 - .../@azure/msal-browser/Base64Encode.yml | 66 -- .../msal-browser/BaseInteractionClient.yml | 5 - .../@azure/msal-browser/BrowserAuthError.yml | 72 +- .../msal-browser/BrowserAuthOptions.yml | 1 - .../msal-browser/BrowserCacheLocation.yml | 1 - .../msal-browser/BrowserCacheManager.yml | 106 +-- .../msal-browser/BrowserConfiguration.yml | 1 - .../BrowserConfigurationAuthError.yml | 19 - .../@azure/msal-browser/BrowserCrypto.yml | 150 ----- .../msal-browser/BrowserPerformanceClient.yml | 182 +++++- .../BrowserPerformanceMeasurement.yml | 24 +- .../msal-browser/BrowserProtocolUtils.yml | 3 - .../msal-browser/BrowserStateObject.yml | 1 - .../@azure/msal-browser/BrowserStorage.yml | 98 --- .../msal-browser/BrowserStringUtils.yml | 82 --- .../msal-browser/BrowserSystemOptions.yml | 1 - .../msal-browser/BrowserTelemetryOptions.yml | 1 - .../@azure/msal-browser/BrowserUtils.yml | 14 - .../@azure/msal-browser/CacheLookupPolicy.yml | 1 - .../@azure/msal-browser/CacheOptions.yml | 1 - .../@azure/msal-browser/CachedKeyPair.yml | 1 - .../@azure/msal-browser/ClientApplication.yml | 29 - .../@azure/msal-browser/Configuration.yml | 1 - .../@azure/msal-browser/CryptoKeyStore.yml | 79 --- .../msal-browser/CryptoKeyStoreNames.yml | 18 - .../@azure/msal-browser/CryptoOps.yml | 11 - .../@azure/msal-browser/CryptoOptions.yml | 1 - .../@azure/msal-browser/DatabaseStorage.yml | 147 ----- .../msal-browser/EndSessionPopupRequest.yml | 5 +- .../@azure/msal-browser/EndSessionRequest.yml | 9 +- .../msal-browser/EventCallbackFunction.yml | 1 - .../@azure/msal-browser/EventError.yml | 1 - .../@azure/msal-browser/EventHandler.yml | 7 - .../@azure/msal-browser/EventMessage.yml | 1 - .../@azure/msal-browser/EventMessageUtils.yml | 2 - .../@azure/msal-browser/EventPayload.yml | 1 - .../@azure/msal-browser/EventType.yml | 1 - .../@azure/msal-browser/FetchClient.yml | 55 -- .../@azure/msal-browser/GuidGenerator.yml | 54 -- .../@azure/msal-browser/HTTP_REQUEST_TYPE.yml | 1 - .../HybridSpaAuthorizationCodeClient.yml | 184 ------ .../@azure/msal-browser/IAsyncStorage.yml | 98 --- .../@azure/msal-browser/INavigationClient.yml | 3 - .../msal-browser/IPublicClientApplication.yml | 31 - .../@azure/msal-browser/ISubtleCrypto.yml | 153 ----- .../@azure/msal-browser/ITokenCache.yml | 2 - .../@azure/msal-browser/IWindowStorage.yml | 6 - .../@azure/msal-browser/InMemoryCacheKeys.yml | 1 - .../msal-browser/InteractionHandler.yml | 12 +- .../@azure/msal-browser/InteractionParams.yml | 1 - .../@azure/msal-browser/InteractionStatus.yml | 1 - .../@azure/msal-browser/InteractionType.yml | 1 - .../@azure/msal-browser/LoadTokenOptions.yml | 1 - .../@azure/msal-browser/MATS.yml | 1 - .../@azure/msal-browser/MathUtils.yml | 28 - .../@azure/msal-browser/MemoryStorage.yml | 8 - .../msal-browser/ModernBrowserCrypto.yml | 140 ---- .../@azure/msal-browser/MsBrowserCrypto.yml | 140 ---- .../@azure/msal-browser/MsrBrowserCrypto.yml | 153 ----- .../@azure/msal-browser/NativeAccountInfo.yml | 1 - .../@azure/msal-browser/NativeAuthError.yml | 17 - .../msal-browser/NativeExtensionMethod.yml | 1 - .../msal-browser/NativeExtensionRequest.yml | 1 - .../NativeExtensionRequestBody.yml | 1 - .../msal-browser/NativeInteractionClient.yml | 100 ++- .../msal-browser/NativeMessageHandler.yml | 22 +- .../@azure/msal-browser/NativeResponse.yml | 1 - .../msal-browser/NativeResponseProperties.yml | 1 - .../@azure/msal-browser/NativeStatusCode.yml | 1 - .../msal-browser/NativeTokenRequest.yml | 1 - .../@azure/msal-browser/NavigationClient.yml | 3 - .../@azure/msal-browser/NavigationOptions.yml | 1 - .../@azure/msal-browser/OSError.yml | 1 - .../@azure/msal-browser/PkceGenerator.yml | 39 -- .../@azure/msal-browser/PopupClient.yml | 13 - .../@azure/msal-browser/PopupEvent.yml | 1 - .../@azure/msal-browser/PopupParams.yml | 1 - .../@azure/msal-browser/PopupPosition.yml | 1 - .../@azure/msal-browser/PopupRequest.yml | 1 - .../@azure/msal-browser/PopupSize.yml | 1 - .../msal-browser/PopupWindowAttributes.yml | 1 - .../msal-browser/PublicClientApplication.yml | 32 - .../@azure/msal-browser/RedirectClient.yml | 6 - .../@azure/msal-browser/RedirectHandler.yml | 13 +- .../@azure/msal-browser/RedirectParams.yml | 1 - .../@azure/msal-browser/RedirectRequest.yml | 1 - .../@azure/msal-browser/SignedHttpRequest.yml | 5 - .../msal-browser/SignedHttpRequestOptions.yml | 1 - .../msal-browser/SilentAuthCodeClient.yml | 5 - .../@azure/msal-browser/SilentCacheClient.yml | 6 - .../@azure/msal-browser/SilentHandler.yml | 161 ----- .../msal-browser/SilentIframeClient.yml | 5 - .../msal-browser/SilentRefreshClient.yml | 5 - .../@azure/msal-browser/SilentRequest.yml | 1 - .../@azure/msal-browser/SsoSilentRequest.yml | 1 - .../StandardInteractionClient.yml | 5 - .../msal-browser/TemporaryCacheKeys.yml | 5 +- .../@azure/msal-browser/TokenCache.yml | 4 - .../@azure/msal-browser/WrapperSKU.yml | 1 - .../@azure/msal-browser/XhrClient.yml | 53 -- .../@azure/msal-browser/index.yml | 96 ++- .../msal-common/AADAuthorityConstants.yml | 1 - .../@azure/msal-common/AADServerParamKeys.yml | 1 - .../@azure/msal-common/AccessTokenCache.yml | 1 - .../@azure/msal-common/AccessTokenEntity.yml | 27 - .../@azure/msal-common/AccountCache.yml | 1 - .../@azure/msal-common/AccountEntity.yml | 25 - .../@azure/msal-common/AccountFilter.yml | 1 - .../@azure/msal-common/AccountInfo.yml | 1 - .../msal-common/ActiveAccountFilters.yml | 1 - .../@azure/msal-common/AppMetadataCache.yml | 1 - .../@azure/msal-common/AppMetadataEntity.yml | 8 - .../@azure/msal-common/AppMetadataFilter.yml | 1 - .../AppTokenProviderParameters.yml | 1 - .../msal-common/AppTokenProviderResult.yml | 1 - .../msal-common/ApplicationTelemetry.yml | 1 - .../@azure/msal-common/AuthError.yml | 13 - .../@azure/msal-common/AuthOptions.yml | 1 - .../@azure/msal-common/AuthToken.yml | 6 - .../AuthenticationHeaderParser.yml | 3 - .../msal-common/AuthenticationResult.yml | 1 - .../msal-common/AuthenticationScheme.yml | 1 - .../@azure/msal-common/Authority.yml | 35 +- .../@azure/msal-common/AuthorityFactory.yml | 24 +- .../msal-common/AuthorityMetadataEntity.yml | 20 - .../msal-common/AuthorityMetadataSource.yml | 1 - .../@azure/msal-common/AuthorityOptions.yml | 1 - .../@azure/msal-common/AuthorityType.yml | 1 - .../msal-common/AuthorizationCodeClient.yml | 37 +- .../msal-common/AuthorizationCodePayload.yml | 1 - .../@azure/msal-common/AzureCloudInstance.yml | 1 - .../@azure/msal-common/AzureCloudOptions.yml | 1 - .../@azure/msal-common/AzureRegion.yml | 1 - .../msal-common/AzureRegionConfiguration.yml | 1 - .../@azure/msal-common/BaseAuthRequest.yml | 5 +- .../@azure/msal-common/BaseClient.yml | 20 +- .../@azure/msal-common/CacheAccountType.yml | 1 - .../@azure/msal-common/CacheManager.yml | 45 -- .../@azure/msal-common/CacheOutcome.yml | 1 - .../@azure/msal-common/CacheRecord.yml | 7 - .../@azure/msal-common/CacheSchemaType.yml | 1 - .../@azure/msal-common/CacheType.yml | 1 - .../@azure/msal-common/CcsCredential.yml | 1 - .../@azure/msal-common/CcsCredentialType.yml | 1 - .../@azure/msal-common/ClaimsRequestKeys.yml | 1 - .../@azure/msal-common/ClientAssertion.yml | 1 - .../@azure/msal-common/ClientAuthError.yml | 78 +-- .../msal-common/ClientConfiguration.yml | 1 - .../msal-common/ClientConfigurationError.yml | 107 +-- .../msal-common/ClientCredentialClient.yml | 25 +- .../@azure/msal-common/ClientCredentials.yml | 1 - .../@azure/msal-common/ClientInfo.yml | 1 - .../msal-common/CloudDiscoveryMetadata.yml | 1 - .../CloudInstanceDiscoveryResponse.yml | 16 - .../CommonAuthorizationCodeRequest.yml | 13 +- .../CommonAuthorizationUrlRequest.yml | 2 - .../msal-common/CommonClientConfiguration.yml | 1 - .../CommonClientCredentialRequest.yml | 4 +- .../msal-common/CommonDeviceCodeRequest.yml | 10 +- .../msal-common/CommonEndSessionRequest.yml | 4 +- .../msal-common/CommonOnBehalfOfRequest.yml | 4 +- .../msal-common/CommonRefreshTokenRequest.yml | 5 +- .../msal-common/CommonSilentFlowRequest.yml | 9 +- .../CommonUsernamePasswordRequest.yml | 4 +- .../@azure/msal-common/Counters.yml | 15 + .../@azure/msal-common/CredentialCache.yml | 1 - .../@azure/msal-common/CredentialEntity.yml | 20 - .../@azure/msal-common/CredentialFilter.yml | 1 - .../@azure/msal-common/CredentialType.yml | 1 - .../@azure/msal-common/DecodedAuthToken.yml | 4 - .../msal-common/DefaultStorageClass.yml | 45 -- .../@azure/msal-common/DeviceCodeClient.yml | 43 +- .../@azure/msal-common/DeviceCodeResponse.yml | 1 - .../msal-common/ExternalTokenResponse.yml | 1 - .../@azure/msal-common/GrantType.yml | 1 - .../@azure/msal-common/HeaderNames.yml | 5 +- .../@azure/msal-common/IAppTokenProvider.yml | 1 - .../@azure/msal-common/ICacheManager.yml | 28 - .../@azure/msal-common/ICachePlugin.yml | 3 - .../@azure/msal-common/ICrypto.yml | 10 - .../@azure/msal-common/IGuidGenerator.yml | 3 - .../@azure/msal-common/ILoggerCallback.yml | 1 - .../@azure/msal-common/IMDSBadResponse.yml | 10 - .../msal-common/INativeBrokerPlugin.yml | 127 ++++ .../@azure/msal-common/INetworkModule.yml | 3 - .../@azure/msal-common/IPerformanceClient.yml | 108 ++- .../msal-common/IPerformanceMeasurement.yml | 4 - .../msal-common/ISerializableTokenCache.yml | 3 - .../@azure/msal-common/IUri.yml | 8 - .../@azure/msal-common/IdTokenCache.yml | 1 - .../@azure/msal-common/IdTokenEntity.yml | 22 - .../@azure/msal-common/ImdsOptions.yml | 11 - .../InProgressPerformanceEvent.yml | 3 +- .../InteractionRequiredAuthError.yml | 87 ++- .../@azure/msal-common/JoseHeader.yml | 6 - .../@azure/msal-common/JoseHeaderError.yml | 218 ------ .../@azure/msal-common/JoseHeaderOptions.yml | 1 - .../@azure/msal-common/JsonTypes.yml | 5 +- .../@azure/msal-common/KeyLocation.yml | 1 - .../@azure/msal-common/LibraryInfo.yml | 1 - .../@azure/msal-common/LibraryStateObject.yml | 1 - .../@azure/msal-common/LogLevel.yml | 1 - .../@azure/msal-common/Logger.yml | 15 - .../msal-common/LoggerMessageOptions.yml | 1 - .../@azure/msal-common/LoggerOptions.yml | 1 - .../@azure/msal-common/NativeRequest.yml | 27 + .../msal-common/NativeSignOutRequest.yml | 14 + .../@azure/msal-common/NetworkManager.yml | 3 - .../msal-common/NetworkRequestOptions.yml | 8 +- .../@azure/msal-common/NetworkResponse.yml | 1 - .../@azure/msal-common/OnBehalfOfClient.yml | 25 +- .../msal-common/OpenIdConfigResponse.yml | 1 - .../msal-common/PasswordGrantConstants.yml | 1 - .../PerformanceCallbackFunction.yml | 1 - .../@azure/msal-common/PerformanceClient.yml | 184 +++++- .../@azure/msal-common/PerformanceEvent.yml | 45 +- .../msal-common/PerformanceEventStatus.yml | 1 - .../@azure/msal-common/PerformanceEvents.yml | 195 +++++- .../msal-common/PersistentCacheKeys.yml | 1 - .../@azure/msal-common/PkceCodes.yml | 1 - .../@azure/msal-common/PopTokenGenerator.yml | 15 +- .../@azure/msal-common/PreQueueEvent.yml | 34 + .../@azure/msal-common/ProtocolMode.yml | 1 - .../@azure/msal-common/ProtocolUtils.yml | 4 - .../@azure/msal-common/QueueMeasurement.yml | 14 + .../@azure/msal-common/RefreshTokenCache.yml | 1 - .../@azure/msal-common/RefreshTokenClient.yml | 26 +- .../@azure/msal-common/RefreshTokenEntity.yml | 22 - .../@azure/msal-common/RegionDiscovery.yml | 50 -- .../msal-common/RegionDiscoveryMetadata.yml | 1 - .../msal-common/RegionDiscoveryOutcomes.yml | 1 - .../msal-common/RegionDiscoverySources.yml | 1 - .../@azure/msal-common/ReqCnf.yml | 1 - .../@azure/msal-common/ReqCnfData.yml | 1 - .../msal-common/RequestParameterBuilder.yml | 618 ------------------ .../@azure/msal-common/RequestStateObject.yml | 1 - .../@azure/msal-common/RequestThumbprint.yml | 1 - .../@azure/msal-common/RequestValidator.yml | 108 --- .../@azure/msal-common/ResponseCodes.yml | 1 - .../@azure/msal-common/ResponseHandler.yml | 189 ------ .../@azure/msal-common/ResponseMode.yml | 1 - .../@azure/msal-common/SSOTypes.yml | 1 - .../@azure/msal-common/ScopeSet.yml | 16 - .../@azure/msal-common/Separators.yml | 1 - .../ServerAuthorizationCodeResponse.yml | 5 +- .../ServerAuthorizationTokenResponse.yml | 3 +- .../msal-common/ServerDeviceCodeResponse.yml | 1 - .../@azure/msal-common/ServerError.yml | 12 - .../msal-common/ServerTelemetryEntity.yml | 6 - .../msal-common/ServerTelemetryManager.yml | 12 - .../msal-common/ServerTelemetryRequest.yml | 1 - .../@azure/msal-common/SignedHttpRequest.yml | 1 - .../SignedHttpRequestParameters.yml | 1 - .../@azure/msal-common/SilentFlowClient.yml | 26 +- .../@azure/msal-common/StaticFields.yml | 7 +- .../@azure/msal-common/StringDict.yml | 1 - .../msal-common/StubPerformanceClient.yml | 151 ++++- .../StubPerformanceMeasurement.yml | 4 - .../@azure/msal-common/SubMeasurement.yml | 10 + .../@azure/msal-common/SystemOptions.yml | 2 - .../@azure/msal-common/TelemetryOptions.yml | 1 - .../@azure/msal-common/ThrottlingEntity.yml | 7 - .../@azure/msal-common/ThrottlingUtils.yml | 8 - .../@azure/msal-common/TimeUtils.yml | 5 - .../@azure/msal-common/TokenCacheContext.yml | 6 - .../@azure/msal-common/TokenClaims.yml | 1 - .../@azure/msal-common/UrlString.yml | 18 - .../msal-common/UrlToHttpRequestOptions.yml | 20 + .../msal-common/UsernamePasswordClient.yml | 25 +- .../@azure/msal-common/ValidCacheType.yml | 1 - .../msal-common/ValidCredentialType.yml | 1 - .../@azure/msal-common/index.yml | 42 +- .../@azure/msal-node/ApiId.yml | 50 -- .../msal-node/AuthorizationCodeRequest.yml | 3 +- .../msal-node/AuthorizationUrlRequest.yml | 1 - .../@azure/msal-node/BrokerOptions.yml | 17 + .../@azure/msal-node/CacheKVStore.yml | 1 - .../@azure/msal-node/CacheOptions.yml | 1 - .../@azure/msal-node/ClientApplication.yml | 10 - .../@azure/msal-node/ClientAssertion.yml | 5 - .../msal-node/ClientCredentialRequest.yml | 4 +- .../ConfidentialClientApplication.yml | 14 - .../@azure/msal-node/Configuration.yml | 6 +- .../@azure/msal-node/CryptoProvider.yml | 11 - .../@azure/msal-node/Deserializer.yml | 151 ----- .../@azure/msal-node/DeviceCodeRequest.yml | 4 +- .../msal-node/DistributedCachePlugin.yml | 4 - .../@azure/msal-node/EncodingUtils.yml | 97 --- .../@azure/msal-node/GuidGenerator.yml | 44 -- .../@azure/msal-node/HashUtils.yml | 28 - .../@azure/msal-node/HttpClient.yml | 59 -- .../@azure/msal-node/HttpMethod.yml | 18 - .../@azure/msal-node/HttpStatus.yml | 45 -- .../@azure/msal-node/ICacheClient.yml | 3 - .../IConfidentialClientApplication.yml | 13 - ...LoopbackClient.yml => ILoopbackClient.yml} | 30 +- .../@azure/msal-node/IPartitionManager.yml | 3 - .../msal-node/IPublicClientApplication.yml | 38 +- .../@azure/msal-node/ITokenCache.yml | 5 - .../@azure/msal-node/InMemoryCache.yml | 1 - .../@azure/msal-node/InteractiveRequest.yml | 24 +- .../@azure/msal-node/JsonCache.yml | 1 - .../@azure/msal-node/NetworkUtils.yml | 35 - .../@azure/msal-node/NodeAuthError.yml | 270 -------- .../@azure/msal-node/NodeAuthOptions.yml | 1 - .../@azure/msal-node/NodeConfiguration.yml | 2 +- .../@azure/msal-node/NodeStorage.yml | 57 -- .../@azure/msal-node/NodeSystemOptions.yml | 2 +- .../@azure/msal-node/NodeTelemetryOptions.yml | 1 - .../@azure/msal-node/OnBehalfOfRequest.yml | 4 +- .../@azure/msal-node/PkceGenerator.yml | 37 -- .../@azure/msal-node/ProxyStatus.yml | 25 - .../msal-node/PublicClientApplication.yml | 98 +-- .../@azure/msal-node/RefreshTokenRequest.yml | 1 - .../msal-node/SerializedAccessTokenEntity.yml | 2 +- .../msal-node/SerializedAccountEntity.yml | 1 - .../msal-node/SerializedAppMetadataEntity.yml | 1 - .../msal-node/SerializedIdTokenEntity.yml | 1 - .../SerializedRefreshTokenEntity.yml | 1 - .../@azure/msal-node/Serializer.yml | 149 ----- .../@azure/msal-node/SignOutRequest.yml | 10 + .../@azure/msal-node/SilentFlowRequest.yml | 3 +- .../@azure/msal-node/TokenCache.yml | 10 - .../msal-node/UsernamePasswordRequest.yml | 4 +- .../@azure/msal-node/index.yml | 45 +- .../@azure/msal-react/AccountIdentifiers.yml | 1 - .../msal-react/AuthenticatedTemplateProps.yml | 1 - .../@azure/msal-react/FaaCFunction.yml | 1 - .../@azure/msal-react/IMsalContext.yml | 5 - .../msal-react/MsalAuthenticationProps.yml | 1 - .../msal-react/MsalAuthenticationResult.yml | 1 - .../@azure/msal-react/MsalProviderProps.yml | 1 - .../@azure/msal-react/ReactAuthError.yml | 206 ------ .../@azure/msal-react/SetComplement.yml | 1 - .../@azure/msal-react/SetDifference.yml | 1 - .../@azure/msal-react/Subtract.yml | 1 - .../UnauthenticatedTemplateProps.yml | 1 - .../@azure/msal-react/WithMsalProps.yml | 1 - .../@azure/msal-react/index.yml | 12 - .../docs-ref-autogen/@azure/msal/API_CODE.yml | 1 - .../@azure/msal/API_EVENT_IDENTIFIER.yml | 1 - .../docs-ref-autogen/@azure/msal/Account.yml | 11 - .../docs-ref-autogen/@azure/msal/ApiEvent.yml | 20 - .../@azure/msal/AuthError.yml | 10 - .../@azure/msal/AuthOptions.yml | 1 - .../@azure/msal/AuthResponse.yml | 1 - .../@azure/msal/AuthenticationParameters.yml | 1 - .../@azure/msal/AuthorityFactory.yml | 100 --- .../@azure/msal/CacheLocation.yml | 1 - .../@azure/msal/CacheOptions.yml | 1 - .../@azure/msal/ClientAuthError.yml | 30 - .../@azure/msal/ClientConfigurationError.yml | 47 -- .../@azure/msal/CompletedEvents.yml | 1 - .../@azure/msal/Configuration.yml | 1 - .../@azure/msal/DefaultEvent.yml | 157 ----- .../@azure/msal/ErrorCacheKeys.yml | 1 - .../@azure/msal/EventCount.yml | 1 - .../@azure/msal/EventCountByCorrelationId.yml | 1 - .../@azure/msal/FrameworkOptions.yml | 1 - .../@azure/msal/HttpEvent.yml | 22 - .../msal/IClientConfigurationErrorMessage.yml | 3 - .../@azure/msal/ILoggerCallback.yml | 1 - .../@azure/msal/InProgressEvents.yml | 1 - .../msal/InteractionRequiredAuthError.yml | 15 - .../@azure/msal/InteractionType.yml | 1 - .../@azure/msal/LibraryStateObject.yml | 11 - .../docs-ref-autogen/@azure/msal/LogLevel.yml | 1 - .../docs-ref-autogen/@azure/msal/Logger.yml | 3 - .../@azure/msal/NetworkInformation.yml | 2 - .../@azure/msal/OpenIdConfiguration.yml | 1 - .../@azure/msal/PersistentCacheKeys.yml | 1 - .../docs-ref-autogen/@azure/msal/ScopeSet.yml | 146 ----- .../@azure/msal/ServerError.yml | 11 - .../@azure/msal/ServerHashParamKeys.yml | 1 - .../@azure/msal/StringDict.yml | 1 - .../@azure/msal/SystemOptions.yml | 1 - .../@azure/msal/TelemetryConfig.yml | 4 - .../@azure/msal/TelemetryEmitter.yml | 1 - .../@azure/msal/TelemetryEvent.yml | 10 - .../@azure/msal/TelemetryManager.yml | 9 - .../@azure/msal/TelemetryOptions.yml | 1 - .../@azure/msal/TelemetryPlatform.yml | 6 - .../@azure/msal/TrustedAuthority.yml | 85 --- .../@azure/msal/UserAgentApplication.yml | 19 - .../@azure/msal/WindowUtils.yml | 3 - .../@azure/msal/XhrResponse.yml | 11 - .../@azure/msal/authResponseCallback.yml | 1 - .../@azure/msal/errorReceivedCallback.yml | 1 - nodejs/docs-ref-autogen/@azure/msal/index.yml | 10 - .../@azure/msal/tokenReceivedCallback.yml | 1 - nodejs/docs-ref-autogen/toc.yml | 191 ++---- 411 files changed, 1840 insertions(+), 7312 deletions(-) delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/AsyncMemoryStorage.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/Base64Decode.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/Base64Encode.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCrypto.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStringUtils.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/CryptoKeyStore.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/CryptoKeyStoreNames.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/DatabaseStorage.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/FetchClient.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/GuidGenerator.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/HybridSpaAuthorizationCodeClient.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/IAsyncStorage.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/ISubtleCrypto.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/MathUtils.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/ModernBrowserCrypto.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/MsBrowserCrypto.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/MsrBrowserCrypto.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/PkceGenerator.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/SilentHandler.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/XhrClient.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/CloudInstanceDiscoveryResponse.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/Counters.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/IMDSBadResponse.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/INativeBrokerPlugin.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/ImdsOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/JoseHeaderError.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/NativeRequest.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/NativeSignOutRequest.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/PreQueueEvent.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/QueueMeasurement.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscovery.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/RequestValidator.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/ResponseHandler.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/SubMeasurement.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/ApiId.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/BrokerOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/Deserializer.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/EncodingUtils.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/GuidGenerator.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/HashUtils.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/HttpClient.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/HttpMethod.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/HttpStatus.yml rename nodejs/docs-ref-autogen/@azure/msal-node/{LoopbackClient.yml => ILoopbackClient.yml} (63%) delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/NetworkUtils.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/NodeAuthError.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/PkceGenerator.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/ProxyStatus.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/Serializer.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-node/SignOutRequest.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-react/ReactAuthError.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal/AuthorityFactory.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal/DefaultEvent.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal/LibraryStateObject.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal/ScopeSet.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal/TrustedAuthority.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal/XhrResponse.yml diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/IMsalService.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/IMsalService.yml index fca58de..8344719 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/IMsalService.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/IMsalService.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: IMsalService remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,7 +30,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -50,7 +47,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -68,7 +64,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -80,7 +75,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -94,7 +88,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(): Observable' @@ -106,7 +99,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -124,7 +116,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loginRedirect(request?: RedirectRequest): Observable' @@ -140,7 +131,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(logoutRequest?: EndSessionRequest): Observable' @@ -156,7 +146,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' @@ -169,7 +158,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MatchingResources.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MatchingResources.yml index 9eea32e..9469a59 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MatchingResources.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MatchingResources.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MatchingResources remarks: '' -isPreview: false isDeprecated: false syntax: | type MatchingResources = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml index 11f2a69..4c7da1d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalBroadcastConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalBroadcastConfiguration = { eventsToReplay: number } diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml index 6719dcb..7afdf83 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalBroadcastService remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -40,7 +38,6 @@ properties: summary: '' fullName: inProgress$ remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inProgress$: Observable' @@ -53,7 +50,6 @@ properties: summary: '' fullName: msalSubject$ remarks: '' - isPreview: false isDeprecated: false syntax: content: 'msalSubject$: Observable' diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml index 3437105..5ecb756 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml @@ -10,7 +10,6 @@ summary: >- https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-angular/docs/v2-docs/performance.md fullName: MsalCustomNavigationClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -43,7 +41,6 @@ inheritedMethods: Navigates to other pages outside the web application i.e. the Identity Provider remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -67,7 +64,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml index 826c27a..fad94bd 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalGuard remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -45,7 +43,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -66,7 +63,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -87,7 +83,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function canLoad(): Observable' @@ -99,7 +94,6 @@ methods: package: '@azure/msal-angular' summary: Builds the absolute url for the destination page remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getDestinationUrl(path: string): string' @@ -115,7 +109,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function includesCode(path: string): boolean' @@ -131,7 +124,6 @@ methods: package: '@azure/msal-angular' summary: Parses url string to UrlTree remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function parseUrl(url: string): UrlTree' diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuardAuthRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuardAuthRequest.yml index e191174..031d3d9 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuardAuthRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuardAuthRequest.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalGuardAuthRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalGuardAuthRequest = diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml index ff6ab62..4a7d5ad 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalGuardConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalGuardConfiguration = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptor.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptor.yml index 7f14e4f..84ad715 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptor.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptor.yml @@ -5,21 +5,22 @@ package: '@azure/msal-angular' summary: '' fullName: MsalInterceptor remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'MsalInterceptor(MsalInterceptorConfiguration, MsalService, Location, any)' + - name: >- + MsalInterceptor(MsalInterceptorConfiguration, MsalService, Location, + MsalBroadcastService, any) uid: '@azure/msal-angular.MsalInterceptor.constructor' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new MsalInterceptor(msalInterceptorConfig: MsalInterceptorConfiguration, - authService: MsalService, location: Location, document?: any) + authService: MsalService, location: Location, msalBroadcastService: + MsalBroadcastService, document?: any) parameters: - id: msalInterceptorConfig type: @@ -30,6 +31,9 @@ constructors: - id: location type: Location description: '' + - id: msalBroadcastService + type: + description: '' - id: document type: any description: '' @@ -39,7 +43,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml index a82f4ef..8798d07 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalInterceptorAuthRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalInterceptorAuthRequest = diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml index abd57b0..3a21b0f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalInterceptorConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalInterceptorConfiguration = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalModule.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalModule.yml index db129ea..3625f27 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalModule.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalModule.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalModule remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -16,7 +15,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml index b16e65a..9906f05 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalRedirectComponent remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new MsalRedirectComponent(authService: MsalService)' @@ -28,7 +26,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function ngOnInit() diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalService.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalService.yml index 99343c1..176907f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/MsalService.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/MsalService.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: MsalService remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new MsalService(instance: IPublicClientApplication, location: Location)' @@ -32,7 +30,6 @@ properties: summary: '' fullName: instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'instance: IPublicClientApplication' @@ -45,7 +42,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -63,7 +59,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -81,7 +76,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -103,7 +97,6 @@ methods: If no logger set, returns logger instance created with same options as msal-browser remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -115,7 +108,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -133,7 +125,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(): Observable' @@ -145,7 +136,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -163,7 +153,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loginRedirect(request?: RedirectRequest): Observable' @@ -179,7 +168,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(logoutRequest?: EndSessionRequest): Observable' @@ -195,7 +183,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -213,7 +200,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -231,7 +217,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' @@ -244,7 +229,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml b/nodejs/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml index 113c68c..af45295 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml @@ -5,7 +5,9 @@ package: '@azure/msal-angular' summary: '' fullName: ProtectedResourceScopes remarks: '' -isPreview: false isDeprecated: false syntax: | - type ProtectedResourceScopes = { httpMethod: string, scopes: Array } + type ProtectedResourceScopes = { + httpMethod: string, + scopes: Array | null, + } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/ApiId.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/ApiId.yml index 7af7853..f2443ec 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/ApiId.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/ApiId.yml @@ -13,7 +13,6 @@ summary: >- 800-899 Auth Code Flow fullName: ApiId remarks: '' -isPreview: false isDeprecated: false fields: - name: acquireTokenSilent_silentFlow diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/AsyncMemoryStorage.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/AsyncMemoryStorage.yml deleted file mode 100644 index a5521f2..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/AsyncMemoryStorage.yml +++ /dev/null @@ -1,151 +0,0 @@ -### YamlMime:TSType -name: AsyncMemoryStorage -uid: '@azure/msal-browser.AsyncMemoryStorage' -package: '@azure/msal-browser' -summary: >- - This class allows MSAL to store artifacts asynchronously using the - DatabaseStorage IndexedDB wrapper, - - backed up with the more volatile MemoryStorage object for cases in which - IndexedDB may be unavailable. -fullName: AsyncMemoryStorage -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'AsyncMemoryStorage(Logger, string)' - uid: '@azure/msal-browser.AsyncMemoryStorage.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new AsyncMemoryStorage(logger: Logger, storeName: string)' - parameters: - - id: logger - type: Logger - description: '' - - id: storeName - type: string - description: '' -methods: - - name: clearInMemory() - uid: '@azure/msal-browser.AsyncMemoryStorage.clearInMemory' - package: '@azure/msal-browser' - summary: Clears in-memory Map - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function clearInMemory() - - name: clearPersistent() - uid: '@azure/msal-browser.AsyncMemoryStorage.clearPersistent' - package: '@azure/msal-browser' - summary: Tries to delete the IndexedDB database - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function clearPersistent(): Promise' - return: - description: '' - type: Promise<boolean> - - name: containsKey(string) - uid: '@azure/msal-browser.AsyncMemoryStorage.containsKey' - package: '@azure/msal-browser' - summary: Returns true or false if the given key is present in the cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function containsKey(key: string): Promise' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: Promise<boolean> - - name: getItem(string) - uid: '@azure/msal-browser.AsyncMemoryStorage.getItem' - package: '@azure/msal-browser' - summary: >- - Get the item matching the given key. Tries in-memory cache first, then in - the asynchronous - - storage object if item isn't found in-memory. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getItem(key: string): Promise' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: Promise<T | null> - - name: getKeys() - uid: '@azure/msal-browser.AsyncMemoryStorage.getKeys' - package: '@azure/msal-browser' - summary: >- - Get all the keys from the in-memory cache as an iterable array of strings. - If no keys are found, query the keys in the - - asynchronous storage object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getKeys(): Promise' - return: - description: '' - type: 'Promise<string[]>' - - name: removeItem(string) - uid: '@azure/msal-browser.AsyncMemoryStorage.removeItem' - package: '@azure/msal-browser' - summary: >- - Removes the item matching the key from the in-memory cache, then tries to - remove it from the asynchronous storage object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeItem(key: string): Promise' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: Promise<void> - - name: 'setItem(string, T)' - uid: '@azure/msal-browser.AsyncMemoryStorage.setItem' - package: '@azure/msal-browser' - summary: >- - Sets the item in the in-memory cache and then tries to set it in the - asynchronous - - storage object with the given key. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setItem(key: string, value: T): Promise' - parameters: - - id: key - type: string - description: '' - - id: value - type: T - description: |+ - - return: - description: '' - type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/AuthorizationCodeRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/AuthorizationCodeRequest.yml index 3030157..6a877d7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/AuthorizationCodeRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/AuthorizationCodeRequest.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: AuthorizationCodeRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthorizationCodeRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml index 6781ee6..ab13354 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: This type is deprecated and will be removed on the next major version update fullName: AuthorizationUrlRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthorizationUrlRequest = Omit< diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/Base64Decode.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/Base64Decode.yml deleted file mode 100644 index 2beecb4..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/Base64Decode.yml +++ /dev/null @@ -1,32 +0,0 @@ -### YamlMime:TSType -name: Base64Decode -uid: '@azure/msal-browser.Base64Decode' -package: '@azure/msal-browser' -summary: >- - Class which exposes APIs to decode base64 strings to plaintext. See here for - implementation details: - - https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding#Solution_2_%E2%80%93_JavaScript's_UTF-16_%3E_UTF-8_%3E_base64 -fullName: Base64Decode -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: decode(string) - uid: '@azure/msal-browser.Base64Decode.decode' - package: '@azure/msal-browser' - summary: Returns a URL-safe plaintext decoded string from b64 encoded input. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function decode(input: string): string' - parameters: - - id: input - type: string - description: |+ - - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/Base64Encode.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/Base64Encode.yml deleted file mode 100644 index 3b0c3fb..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/Base64Encode.yml +++ /dev/null @@ -1,66 +0,0 @@ -### YamlMime:TSType -name: Base64Encode -uid: '@azure/msal-browser.Base64Encode' -package: '@azure/msal-browser' -summary: >- - Class which exposes APIs to encode plaintext to base64 encoded string. See - here for implementation details: - - https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding#Solution_2_%E2%80%93_JavaScript's_UTF-16_%3E_UTF-8_%3E_base64 -fullName: Base64Encode -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: encode(string) - uid: '@azure/msal-browser.Base64Encode.encode' - package: '@azure/msal-browser' - summary: Returns b64 encoded string from plaintext string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function encode(input: string): string' - parameters: - - id: input - type: string - description: |+ - - return: - description: '' - type: string - - name: urlEncode(string) - uid: '@azure/msal-browser.Base64Encode.urlEncode' - package: '@azure/msal-browser' - summary: Returns URL Safe b64 encoded string from a plaintext string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function urlEncode(input: string): string' - parameters: - - id: input - type: string - description: |+ - - return: - description: '' - type: string - - name: urlEncodeArr(Uint8Array) - uid: '@azure/msal-browser.Base64Encode.urlEncodeArr' - package: '@azure/msal-browser' - summary: Returns URL Safe b64 encoded string from an int8Array. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function urlEncodeArr(inputArr: Uint8Array): string' - parameters: - - id: inputArr - type: Uint8Array - description: |+ - - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml index 86f3c3d..0d5fe38 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: BaseInteractionClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -60,7 +58,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -81,7 +78,6 @@ methods: package: '@azure/msal-browser' summary: Use to get the redirect uri configured in MSAL or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(requestRedirectUri?: string): string' @@ -97,7 +93,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(request: EndSessionRequest): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml index ac34697..79e72c2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Browser library error class thrown by the MSAL.js library for SPAs fullName: BrowserAuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BrowserAuthError(errorCode: string, errorMessage?: string)' @@ -32,7 +30,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -46,7 +43,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -60,7 +56,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -74,7 +69,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -88,7 +82,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -102,7 +95,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -116,7 +108,6 @@ inheritedProperties: summary: Describes the subclass of an error fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -130,7 +121,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Creates an error for post request failures. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createPostRequestFailed(errDesc: string): AuthError' @@ -149,7 +139,6 @@ inheritedMethods: Creates an error that is thrown when something unexpected happens in the library. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -167,7 +156,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -185,7 +173,6 @@ methods: Create an error when an authorization code or native account ID is required but not provided remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -199,7 +186,6 @@ methods: package: '@azure/msal-browser' summary: Create an error when an authorization code is required but not provided remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createAuthCodeRequiredError(): BrowserAuthError' @@ -213,7 +199,6 @@ methods: Creates an error thrown when handleCodeResponse is called before initiateAuthRequest (InteractionHandler) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createAuthRequestNotSetError(): BrowserAuthError' @@ -225,7 +210,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when a popup attempts to call an acquireToken API remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createBlockAcquireTokenInPopupsError(): BrowserAuthError' @@ -237,7 +221,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when an auth reload is done inside an iframe. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createBlockReloadInHiddenIframeError(): BrowserAuthError' @@ -249,7 +232,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when the crypto object is unavailable. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -268,7 +250,6 @@ methods: package: '@azure/msal-browser' summary: Create an error thrown when indexDB database is not open remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createDatabaseNotOpenError(): BrowserAuthError' @@ -280,7 +261,6 @@ methods: package: '@azure/msal-browser' summary: Create an error when IndexedDB is unavailable remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createDatabaseUnavailableError(): BrowserAuthError' @@ -292,7 +272,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when the hash string value is unexpectedly empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -311,7 +290,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when the navigation URI is empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createEmptyNavigationUriError(): BrowserAuthError' @@ -323,7 +301,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when window.open returns an empty window object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createEmptyWindowCreatedError(): BrowserAuthError' @@ -336,7 +313,6 @@ methods: package: '@azure/msal-browser' summary: Create an error thrown when network client fails to parse network response remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -356,7 +332,6 @@ methods: Create an error thrown when get request fails due to reasons other than internet connectivity remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -380,7 +355,6 @@ methods: Creates an error thrown when the hash string value does not contain known properties remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -394,7 +368,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when the hash string value is unexpectedly empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createHashDoesNotContainStateError(): BrowserAuthError' @@ -408,7 +381,6 @@ methods: Creates an error thrown when an HTTP method hasn't been implemented by the browser class. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -429,7 +401,6 @@ methods: Creates an error thrown when an iframe is found to be closed before the timeout is reached. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createIframeClosedPrematurelyError(): BrowserAuthError' @@ -443,7 +414,6 @@ methods: Creates an error thrown when a browser interaction (redirect or popup) is in progress. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInteractionInProgressError(): BrowserAuthError' @@ -455,7 +425,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown if cache type is invalid. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidCacheTypeError(): BrowserAuthError' @@ -469,7 +438,6 @@ methods: Creates an error thrown when monitorIframeFromHash times out for a given iframe. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createMonitorIframeTimeoutError(): BrowserAuthError' @@ -483,7 +451,6 @@ methods: Creates an error thrown when monitorPopupFromHash times out for a given popup. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createMonitorPopupTimeoutError(): BrowserAuthError' @@ -496,7 +463,6 @@ methods: package: '@azure/msal-browser' summary: Create an error thrown when the initialize function hasn't been called remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -511,7 +477,6 @@ methods: package: '@azure/msal-browser' summary: Create an error when native connection has not been established remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -526,7 +491,6 @@ methods: package: '@azure/msal-browser' summary: Create an error thrown when browser extension is not installed remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -540,7 +504,6 @@ methods: package: '@azure/msal-browser' summary: Create an error thrown when Handshake with browser extension times out remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNativeHandshakeTimeoutError(): BrowserAuthError' @@ -559,7 +522,6 @@ methods: These requests must go through eSTS to ensure eSTS is aware of the new account remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -575,7 +537,6 @@ methods: Creates an error thrown when the account object is not provided in the acquireTokenSilent API. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoAccountError(): BrowserAuthError' @@ -589,7 +550,6 @@ methods: Creates an error thrown when the authority could not be retrieved from the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoCachedAuthorityError(): BrowserAuthError' @@ -603,7 +563,6 @@ methods: Create an error thrown when login and token requests are made from a non-browser environment remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNonBrowserEnvironmentError(): BrowserAuthError' @@ -615,7 +574,6 @@ methods: package: '@azure/msal-browser' summary: Create an error thrown when token fetch fails due to no internet remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoNetworkConnectivityError(): BrowserAuthError' @@ -629,7 +587,6 @@ methods: Creates an error thrown when the token request could not be retrieved from the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoTokenRequestCacheError(): BrowserAuthError' @@ -641,7 +598,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when PKCE is not implemented. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -660,7 +616,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when the popup window could not be opened. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -681,7 +636,6 @@ methods: Create an error thrown when token fetch fails due to reasons other than internet connectivity remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -704,7 +658,6 @@ methods: Creates an error thrown when navigateWindow is called inside an iframe or brokered applications. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -726,7 +679,6 @@ methods: Create an error thrown when the queried cryptographic key is not found in IndexedDB remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -746,7 +698,6 @@ methods: Creates an error thrown when the logout API is called on any of the silent interaction clients remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createSilentLogoutUnsupportedError(): BrowserAuthError' @@ -760,7 +711,6 @@ methods: Creates an error thrown when a given prompt value is invalid for silent requests. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -773,6 +723,22 @@ methods: return: description: '' type: + - name: createSpaCodeAndNativeAccountIdPresentError() + uid: >- + @azure/msal-browser.BrowserAuthError.createSpaCodeAndNativeAccountIdPresentError + package: '@azure/msal-browser' + summary: >- + Create an error when both authorization code and native account ID are + provided + remarks: '' + isDeprecated: false + syntax: + content: >- + static function createSpaCodeAndNativeAccountIdPresentError(): + BrowserAuthError + return: + description: '' + type: - name: createStateInteractionTypeMismatchError() uid: >- @azure/msal-browser.BrowserAuthError.createStateInteractionTypeMismatchError @@ -781,7 +747,6 @@ methods: Creates an error thrown when the state value in the hash does not match the interaction type of the API attempting to consume it. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -796,7 +761,6 @@ methods: package: '@azure/msal-browser' summary: Create an error when native token acquisition is not possible remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -812,7 +776,6 @@ methods: Create an error thrown when the necessary information is not available to sideload tokens remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -830,7 +793,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when the hash string value is unexpectedly empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnableToParseStateError(): BrowserAuthError' @@ -845,7 +807,6 @@ methods: Creates an error thrown when the cached token request could not be retrieved from the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -859,7 +820,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when the user closes a popup. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserCancelledError(): BrowserAuthError' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml index fae85fb..d3c1749 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Use this to configure the auth options in the Configuration object fullName: BrowserAuthOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type BrowserAuthOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml index 193c7da..eea25fe 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserCacheLocation remarks: '' -isPreview: false isDeprecated: false fields: - name: LocalStorage diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml index 603157d..4128fc6 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml @@ -11,7 +11,6 @@ summary: >- parameters such as state and nonce, generally. fullName: BrowserCacheManager remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -20,7 +19,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -45,7 +43,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: returns cache key used for cloud instance metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAuthorityMetadataCacheKey(authority: string): string' @@ -67,7 +64,6 @@ inheritedMethods: not checking for casing as keys are all generated in lower case, remember to convert to lower case if object properties are compared remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -86,7 +82,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Returns all accounts in cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): AccountInfo[]' @@ -101,7 +96,6 @@ inheritedMethods: retrieve appMetadata matching all provided filters; if no filter is set, get all appMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -121,7 +115,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: retrieve authorityMetadata that contains a matching alias remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -142,7 +135,6 @@ inheritedMethods: retrieve credentails matching all provided filters; if no filter is set, get all credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -161,7 +153,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Return the family_id value associated with FOCI remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -184,7 +175,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Retrieve AccessTokenEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -209,7 +199,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Retrieve AccountEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -230,7 +219,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Retrieve AccountEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -249,7 +237,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Retrieve AppMetadataEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -271,7 +258,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Retrieve the cached credentials into a cacherecord remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -299,7 +285,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Retrieve IdTokenEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -321,7 +306,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Helper to retrieve the appropriate refresh token from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -347,7 +331,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: returns a boolean if the given account is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccount(accountKey: string): Promise' @@ -364,7 +347,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Removes credentials associated with the provided account remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccountContext(account: AccountEntity): Promise' @@ -382,7 +364,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Removes all accounts and related tokens from cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAllAccounts(): Promise' @@ -395,7 +376,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Removes all app metadata objects from cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAppMetadata(): boolean' @@ -408,7 +388,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: returns a boolean if the given credential is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -428,7 +407,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: saves a cache record remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' @@ -446,7 +424,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Helper to convert serialized data to object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function toObject(obj: T, json: object): T' @@ -468,7 +445,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -491,7 +467,6 @@ methods: Used in scenarios where temp cache needs to be cleaned but state is not known, such as clicking browser back button. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cleanRequestByInteractionType(interactionType: InteractionType)' @@ -505,7 +480,6 @@ methods: package: '@azure/msal-browser' summary: Removes temporary cache for the provided state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cleanRequestByState(stateString: string)' @@ -519,7 +493,6 @@ methods: package: '@azure/msal-browser' summary: Clears all cache entries created by MSAL. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function clear(): Promise' @@ -531,7 +504,6 @@ methods: package: '@azure/msal-browser' summary: Clear an item in the cookies by key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function clearItemCookie(cookieName: string)' @@ -547,7 +519,6 @@ methods: Clear all msal-related cookies currently set in the browser. Should only be used to clear temporary cache items. remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearMsalCookies() @@ -556,7 +527,6 @@ methods: package: '@azure/msal-browser' summary: Checks whether key is in cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function containsKey(key: string): boolean' @@ -573,7 +543,6 @@ methods: package: '@azure/msal-browser' summary: Create authorityKey to cache authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAuthorityKey(stateString: string): string' @@ -592,7 +561,6 @@ methods: (defined schemas do not need the key appended: AccessToken Keys or the upcoming schema) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCacheKey(key: string): string' @@ -608,7 +576,6 @@ methods: package: '@azure/msal-browser' summary: Create Nonce key to cache nonce remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateNonceKey(stateString: string): string' @@ -624,7 +591,6 @@ methods: package: '@azure/msal-browser' summary: Creates full cache key for the request state remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateStateKey(stateString: string): string' @@ -641,7 +607,6 @@ methods: package: '@azure/msal-browser' summary: generates accessToken entity from a string remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -659,7 +624,6 @@ methods: package: '@azure/msal-browser' summary: fetch the account entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccount(accountKey: string): AccountEntity | null' @@ -678,7 +642,6 @@ methods: package: '@azure/msal-browser' summary: Gets a list of accounts that match all of the filters provided remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -696,7 +659,6 @@ methods: package: '@azure/msal-browser' summary: Checks the cache for accounts matching loginHint or SID remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -718,7 +680,6 @@ methods: package: '@azure/msal-browser' summary: Gets the active account remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getActiveAccount(): AccountInfo | null' @@ -730,7 +691,6 @@ methods: package: '@azure/msal-browser' summary: fetch appMetadata entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -749,7 +709,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -767,7 +726,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAuthorityMetadataKeys(): Array' @@ -779,7 +737,6 @@ methods: package: '@azure/msal-browser' summary: Gets the cache object referenced by the browser remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCache(): object' @@ -793,7 +750,6 @@ methods: Gets the cached authority based on the cached state. Returns empty if no cached state found. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCachedAuthority(cachedState: string): string | null' @@ -809,7 +765,6 @@ methods: package: '@azure/msal-browser' summary: Gets cached native request for redirect flows remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCachedNativeRequest(): NativeTokenRequest | null' @@ -823,7 +778,6 @@ methods: Gets the token exchange parameters from the cache. Throws an error if nothing is found. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -844,7 +798,6 @@ methods: package: '@azure/msal-browser' summary: Get cookie expiration time remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCookieExpirationTime(cookieLifeDays: number): string' @@ -861,7 +814,6 @@ methods: package: '@azure/msal-browser' summary: generates idToken entity from a string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getIdTokenCredential(idTokenKey: string): IdTokenEntity | null' @@ -878,7 +830,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getInteractionInProgress(): string | null' @@ -890,7 +841,6 @@ methods: package: '@azure/msal-browser' summary: fetches the entry from the browser storage based off the key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getItem(key: string): string | null' @@ -907,7 +857,6 @@ methods: package: '@azure/msal-browser' summary: Get one item by key from cookies remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getItemCookie(cookieName: string): string' @@ -924,7 +873,6 @@ methods: package: '@azure/msal-browser' summary: Gets all keys in window. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKeys(): string[]' @@ -936,19 +884,30 @@ methods: package: '@azure/msal-browser' summary: Returns username retrieved from ADAL or MSAL v1 idToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLegacyLoginHint(): string | null' return: description: '' type: string | null + - name: getRedirectRequestContext() + uid: '@azure/msal-browser.BrowserCacheManager.getRedirectRequestContext' + package: '@azure/msal-browser' + summary: >- + Returns application id as redirect context during AcquireTokenRedirect + flow. + remarks: '' + isDeprecated: false + syntax: + content: 'function getRedirectRequestContext(): string | null' + return: + description: '' + type: string | null - name: getRefreshTokenCredential(string) uid: '@azure/msal-browser.BrowserCacheManager.getRefreshTokenCredential' package: '@azure/msal-browser' summary: generates refreshToken entity from a string remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -967,7 +926,6 @@ methods: package: '@azure/msal-browser' summary: fetch server telemetry entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -988,7 +946,6 @@ methods: Gets cache item with given key. Will retrieve from cookies if storeAuthStateInCookie is set to true. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1009,7 +966,6 @@ methods: package: '@azure/msal-browser' summary: fetch throttling entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1028,7 +984,6 @@ methods: package: '@azure/msal-browser' summary: Returns wrapper metadata from in-memory storage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getWrapperMetadata(): [string, string]' @@ -1040,7 +995,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isInteractionInProgress(matchClientId?: boolean): boolean' @@ -1058,7 +1012,6 @@ methods: Removes the cache item with the given key. Will also clear the cookie item if storeAuthStateInCookie is set to true. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeItem(key: string): boolean' @@ -1075,7 +1028,6 @@ methods: package: '@azure/msal-browser' summary: Reset all temporary cache items remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function resetRequestCache(state: string)' @@ -1089,7 +1041,6 @@ methods: package: '@azure/msal-browser' summary: set accessToken credential to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' @@ -1103,7 +1054,6 @@ methods: package: '@azure/msal-browser' summary: set account entity in the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAccount(account: AccountEntity)' @@ -1116,7 +1066,6 @@ methods: package: '@azure/msal-browser' summary: Sets the active account's localAccountId in cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setActiveAccount(account: AccountInfo | null)' @@ -1130,7 +1079,6 @@ methods: package: '@azure/msal-browser' summary: set appMetadata entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' @@ -1144,7 +1092,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1165,7 +1112,6 @@ methods: interface compat, we cannot overwrite browser cache; Functionality is supported by individual entities in browser remarks: '' - isPreview: false isDeprecated: false syntax: content: function setCache() @@ -1174,7 +1120,6 @@ methods: package: '@azure/msal-browser' summary: set IdToken credential to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setIdTokenCredential(idToken: IdTokenEntity)' @@ -1188,7 +1133,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setInteractionInProgress(inProgress: boolean)' @@ -1201,7 +1145,6 @@ methods: package: '@azure/msal-browser' summary: sets the entry in the browser storage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setItem(key: string, value: string)' @@ -1218,7 +1161,6 @@ methods: package: '@azure/msal-browser' summary: Add value to cookies remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1235,12 +1177,26 @@ methods: type: number description: |+ + - name: setRedirectRequestContext(string) + uid: '@azure/msal-browser.BrowserCacheManager.setRedirectRequestContext' + package: '@azure/msal-browser' + summary: >- + Sets application id as the redirect context during AcquireTokenRedirect + flow. + remarks: '' + isDeprecated: false + syntax: + content: 'function setRedirectRequestContext(value: string)' + parameters: + - id: value + type: string + description: |+ + - name: setRefreshTokenCredential(RefreshTokenEntity) uid: '@azure/msal-browser.BrowserCacheManager.setRefreshTokenCredential' package: '@azure/msal-browser' summary: set refreshToken credential to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)' @@ -1254,7 +1210,6 @@ methods: package: '@azure/msal-browser' summary: set server telemetry entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1276,7 +1231,6 @@ methods: Stores in cookie if storeAuthStateInCookie is set to true. This can cause cookie overflow if used incorrectly. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1298,7 +1252,6 @@ methods: package: '@azure/msal-browser' summary: set throttling entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1317,7 +1270,6 @@ methods: package: '@azure/msal-browser' summary: Sets wrapper metadata in memory remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setWrapperMetadata(wrapperSKU: string, wrapperVersion: string)' @@ -1334,7 +1286,6 @@ methods: package: '@azure/msal-browser' summary: 'Updates account, authority, and state in cache' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1363,7 +1314,6 @@ methods: package: '@azure/msal-browser' summary: Updates a credential's cache key if the current cache key is outdated remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserConfiguration.yml index da2eee5..b7f16f7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserConfiguration.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type BrowserConfiguration = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml index 0418599..9c76b60 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Browser library error class thrown by the MSAL.js library for SPAs fullName: BrowserConfigurationAuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,7 +32,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -48,7 +45,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -62,7 +58,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -76,7 +71,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -90,7 +84,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -104,7 +97,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -118,7 +110,6 @@ inheritedProperties: summary: Describes the subclass of an error fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -132,7 +123,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Creates an error for post request failures. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createPostRequestFailed(errDesc: string): AuthError' @@ -151,7 +141,6 @@ inheritedMethods: Creates an error that is thrown when something unexpected happens in the library. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -169,7 +158,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -186,7 +174,6 @@ methods: Creates an error thrown when a crypto interface that requires entropy is initialized without entropy remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -201,7 +188,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -218,7 +204,6 @@ methods: Creates an error thrown when the post-logout redirect uri is empty (not set by caller) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -235,7 +220,6 @@ methods: Creates error thrown when redirect callbacks are not set before calling loginRedirect() or acquireTokenRedirect(). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -250,7 +234,6 @@ methods: package: '@azure/msal-browser' summary: Creates an error thrown when the redirect uri is empty (not set by caller) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -265,7 +248,6 @@ methods: package: '@azure/msal-browser' summary: Creates error thrown when given storage location is not supported. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -287,7 +269,6 @@ methods: Creates error thrown when the stub instance of PublicClientApplication is called. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCrypto.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCrypto.yml deleted file mode 100644 index 07b6f40..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCrypto.yml +++ /dev/null @@ -1,150 +0,0 @@ -### YamlMime:TSType -name: BrowserCrypto -uid: '@azure/msal-browser.BrowserCrypto' -package: '@azure/msal-browser' -summary: >- - This class implements functions used by the browser library to perform - cryptography operations such as - - hashing and encoding. It also has helper functions to validate the - availability of specific APIs. -fullName: BrowserCrypto -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'BrowserCrypto(Logger, CryptoOptions)' - uid: '@azure/msal-browser.BrowserCrypto.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new BrowserCrypto(logger: Logger, cryptoOptions?: CryptoOptions)' - parameters: - - id: logger - type: Logger - description: '' - - id: cryptoOptions - type: - description: '' -methods: - - name: exportJwk(CryptoKey) - uid: '@azure/msal-browser.BrowserCrypto.exportJwk' - package: '@azure/msal-browser' - summary: Export key as Json Web Key (JWK) - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function exportJwk(key: CryptoKey): Promise' - parameters: - - id: key - type: CryptoKey - description: '' - return: - description: '' - type: Promise<JsonWebKey> - - name: 'generateKeyPair(boolean, Array)' - uid: '@azure/msal-browser.BrowserCrypto.generateKeyPair' - package: '@azure/msal-browser' - summary: Generates a keypair based on current keygen algorithm config. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function generateKeyPair(extractable: boolean, usages: Array): - Promise - parameters: - - id: extractable - type: boolean - description: '' - - id: usages - type: Array<KeyUsage> - description: |+ - - return: - description: '' - type: Promise<CryptoKeyPair> - - name: getRandomValues(Uint8Array) - uid: '@azure/msal-browser.BrowserCrypto.getRandomValues' - package: '@azure/msal-browser' - summary: Populates buffer with cryptographically random values. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getRandomValues(dataBuffer: Uint8Array): Uint8Array' - parameters: - - id: dataBuffer - type: Uint8Array - description: |+ - - return: - description: '' - type: Uint8Array - - name: 'importJwk(JsonWebKey, boolean, Array)' - uid: '@azure/msal-browser.BrowserCrypto.importJwk' - package: '@azure/msal-browser' - summary: 'Imports key as Json Web Key (JWK), can set extractable and usages.' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function importJwk(key: JsonWebKey, extractable: boolean, usages: - Array): Promise - parameters: - - id: key - type: JsonWebKey - description: '' - - id: extractable - type: boolean - description: '' - - id: usages - type: Array<KeyUsage> - description: |+ - - return: - description: '' - type: Promise<CryptoKey> - - name: sha256Digest(string) - uid: '@azure/msal-browser.BrowserCrypto.sha256Digest' - package: '@azure/msal-browser' - summary: Returns a sha-256 hash of the given dataString as an ArrayBuffer. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function sha256Digest(dataString: string): Promise' - parameters: - - id: dataString - type: string - description: |+ - - return: - description: '' - type: Promise<ArrayBuffer> - - name: 'sign(CryptoKey, ArrayBuffer)' - uid: '@azure/msal-browser.BrowserCrypto.sign' - package: '@azure/msal-browser' - summary: Signs given data with given key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function sign(key: CryptoKey, data: ArrayBuffer): Promise' - parameters: - - id: key - type: CryptoKey - description: '' - - id: data - type: ArrayBuffer - description: |+ - - return: - description: '' - type: Promise<ArrayBuffer> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml index 312e0f4..673b278 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserPerformanceClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -52,7 +50,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Registers a callback function to receive performance events. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -71,7 +68,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Saves extra information to be emitted when the measurements are flushed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addStaticFields(fields: StaticFields, correlationId: string)' @@ -84,12 +80,37 @@ inheritedMethods: description: |+ inheritanceDescription: Inherited From PerformanceClient.addStaticFields + - name: 'calculateQueuedTime(number, number)' + uid: '@azure/msal-browser.BrowserPerformanceClient.calculateQueuedTime' + package: '@azure/msal-browser' + summary: >- + Calculates the difference between current time and time when function was + queued. + + Note: It is possible to have 0 as the queue time if the current time and + the queued time was the same. + remarks: '' + isDeprecated: false + syntax: + content: >- + function calculateQueuedTime(preQueueTime: number, currentTime: number): + number + parameters: + - id: preQueueTime + type: number + description: '' + - id: currentTime + type: number + description: '' + return: + description: '' + type: number + inheritanceDescription: Inherited From PerformanceClient.calculateQueuedTime - name: discardMeasurements(string) uid: '@azure/msal-browser.BrowserPerformanceClient.discardMeasurements' package: '@azure/msal-browser' summary: Removes measurements for a given correlation id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function discardMeasurements(correlationId: string)' @@ -104,7 +125,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Emits events to all registered callbacks. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emitEvents(events: PerformanceEvent[], correlationId: string)' @@ -116,7 +136,7 @@ inheritedMethods: type: string description: '' inheritanceDescription: Inherited From PerformanceClient.emitEvents - - name: endMeasurement(PerformanceEvent) + - name: 'endMeasurement(PerformanceEvent, IPerformanceMeasurement)' uid: '@azure/msal-browser.BrowserPerformanceClient.endMeasurement' package: '@azure/msal-browser' summary: >- @@ -124,49 +144,85 @@ inheritedMethods: directly by PerformanceClient classes, as consumers should instead use the function returned by startMeasurement. + + Adds a new field named as "[event name]DurationMs" for sub-measurements, + completes and emits an event + + otherwise. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function endMeasurement(event: PerformanceEvent): PerformanceEvent | - null + function endMeasurement(event: PerformanceEvent, measurement?: + IPerformanceMeasurement): PerformanceEvent | null parameters: - id: event type: PerformanceEvent description: '' + - id: measurement + type: IPerformanceMeasurement + description: '' return: description: '' type: PerformanceEvent | null inheritanceDescription: Inherited From PerformanceClient.endMeasurement - - name: 'flushMeasurements(PerformanceEvents, string)' - uid: '@azure/msal-browser.BrowserPerformanceClient.flushMeasurements' + - name: getIntFields() + uid: '@azure/msal-browser.BrowserPerformanceClient.getIntFields' package: '@azure/msal-browser' - summary: >- - Gathers and emits performance events for measurements taked for the given - top-level API and correlation ID. + summary: |- + Get integral fields. + Override to change the set. + remarks: '' + isDeprecated: false + syntax: + content: 'function getIntFields(): ReadonlySet' + return: + description: '' + type: ReadonlySet<string> + inheritanceDescription: Inherited From PerformanceClient.getIntFields + - name: 'getPreQueueTime(PerformanceEvents, string)' + uid: '@azure/msal-browser.BrowserPerformanceClient.getPreQueueTime' + package: '@azure/msal-browser' + summary: Gets map of pre-queue times by correlation Id remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function flushMeasurements(measureName: PerformanceEvents, - correlationId: string) + function getPreQueueTime(eventName: PerformanceEvents, correlationId: + string): number | void parameters: - - id: measureName + - id: eventName type: PerformanceEvents description: '' - id: correlationId type: string - description: |+ - - inheritanceDescription: Inherited From PerformanceClient.flushMeasurements + description: '' + return: + description: '' + type: number | void + inheritanceDescription: Inherited From PerformanceClient.getPreQueueTime + - name: 'increment(Counters, string)' + uid: '@azure/msal-browser.BrowserPerformanceClient.increment' + package: '@azure/msal-browser' + summary: Increment counters to be emitted when the measurements are flushed + remarks: '' + isDeprecated: false + syntax: + content: 'function increment(counters: Counters, correlationId: string)' + parameters: + - id: counters + type: Counters + description: '' + - id: correlationId + type: string + description: | + correlation identifier + inheritanceDescription: Inherited From PerformanceClient.increment - name: removePerformanceCallback(string) uid: '@azure/msal-browser.BrowserPerformanceClient.removePerformanceCallback' package: '@azure/msal-browser' summary: Removes a callback registered with addPerformanceCallback. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -178,19 +234,84 @@ inheritedMethods: description: '' type: boolean inheritanceDescription: Inherited From PerformanceClient.removePerformanceCallback + - name: 'startPerformanceMeasurement(string, string)' + uid: '@azure/msal-browser.BrowserPerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-browser' + summary: >- + Starts and returns an platform-specific implementation of + IPerformanceMeasurement. + + Note: this function can be changed to abstract at the next major version + bump. + remarks: '' + isDeprecated: false + syntax: + content: >- + function startPerformanceMeasurement(measureName: string, correlationId: + string): IPerformanceMeasurement + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: IPerformanceMeasurement + inheritanceDescription: Inherited From PerformanceClient.startPerformanceMeasurement methods: + - name: 'addQueueMeasurement(PerformanceEvents, string, number, boolean)' + uid: '@azure/msal-browser.BrowserPerformanceClient.addQueueMeasurement' + package: '@azure/msal-browser' + summary: Calculates and adds queue time measurement for given performance event. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addQueueMeasurement(eventName: PerformanceEvents, + correlationId?: string, queueTime?: number, manuallyCompleted?: boolean) + parameters: + - id: eventName + type: PerformanceEvents + description: '' + - id: correlationId + type: string + description: '' + - id: queueTime + type: number + description: '' + - id: manuallyCompleted + type: boolean + description: indicator for manually completed queue measurements - name: generateId() uid: '@azure/msal-browser.BrowserPerformanceClient.generateId' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateId(): string' return: description: '' type: string + - name: 'setPreQueueTime(PerformanceEvents, string)' + uid: '@azure/msal-browser.BrowserPerformanceClient.setPreQueueTime' + package: '@azure/msal-browser' + summary: Adds pre-queue time to preQueueTimeByCorrelationId map. + remarks: '' + isDeprecated: false + syntax: + content: >- + function setPreQueueTime(eventName: PerformanceEvents, correlationId?: + string) + parameters: + - id: eventName + type: PerformanceEvents + description: '' + - id: correlationId + type: string + description: '' - name: 'startMeasurement(PerformanceEvents, string)' uid: '@azure/msal-browser.BrowserPerformanceClient.startMeasurement' package: '@azure/msal-browser' @@ -200,7 +321,6 @@ methods: Also captures browser page visibilityState. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -221,7 +341,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -237,4 +356,15 @@ methods: return: description: '' type: IPerformanceMeasurement + - name: supportsBrowserPerformanceNow() + uid: '@azure/msal-browser.BrowserPerformanceClient.supportsBrowserPerformanceNow' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function supportsBrowserPerformanceNow(): boolean' + return: + description: '' + type: boolean extends: PerformanceClient diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml index 2174112..683ad13 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserPerformanceMeasurement remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new BrowserPerformanceMeasurement(name: string, correlationId: string)' @@ -31,7 +29,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function endMeasurement() @@ -40,19 +37,35 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function flushMeasurement(): number | null' return: description: '' type: number | null + - name: 'flushMeasurements(string, SubMeasurement[])' + uid: '@azure/msal-browser.BrowserPerformanceMeasurement.flushMeasurements' + package: '@azure/msal-browser' + summary: Flush browser marks and measurements. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function flushMeasurements(correlationId: string, measurements: + SubMeasurement[]) + parameters: + - id: correlationId + type: string + description: '' + - id: measurements + type: 'SubMeasurement[]' + description: |+ + - name: startMeasurement() uid: '@azure/msal-browser.BrowserPerformanceMeasurement.startMeasurement' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function startMeasurement() @@ -62,7 +75,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function supportsBrowserPerformance(): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserProtocolUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserProtocolUtils.yml index c446d82..3cd7977 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserProtocolUtils.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserProtocolUtils.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserProtocolUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-browser' summary: Extracts the BrowserStateObject from the state string. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,7 +34,6 @@ methods: package: '@azure/msal-browser' summary: Parses properties of server response from url hash remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStateObject.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStateObject.yml index 0b5f714..6acb7c6 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStateObject.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStateObject.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserStateObject remarks: '' -isPreview: false isDeprecated: false syntax: | type BrowserStateObject = { interactionType: InteractionType } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml deleted file mode 100644 index 7fc4279..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml +++ /dev/null @@ -1,98 +0,0 @@ -### YamlMime:TSType -name: BrowserStorage -uid: '@azure/msal-browser.BrowserStorage' -package: '@azure/msal-browser' -summary: '' -fullName: BrowserStorage -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: BrowserStorage(string) - uid: '@azure/msal-browser.BrowserStorage.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new BrowserStorage(cacheLocation: string)' - parameters: - - id: cacheLocation - type: string - description: '' -methods: - - name: containsKey(string) - uid: '@azure/msal-browser.BrowserStorage.containsKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function containsKey(key: string): boolean' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: boolean - - name: getItem(string) - uid: '@azure/msal-browser.BrowserStorage.getItem' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getItem(key: string): string | null' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: string | null - - name: getKeys() - uid: '@azure/msal-browser.BrowserStorage.getKeys' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getKeys(): string[]' - return: - description: '' - type: 'string[]' - - name: removeItem(string) - uid: '@azure/msal-browser.BrowserStorage.removeItem' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeItem(key: string)' - parameters: - - id: key - type: string - description: '' - - name: 'setItem(string, string)' - uid: '@azure/msal-browser.BrowserStorage.setItem' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setItem(key: string, value: string)' - parameters: - - id: key - type: string - description: '' - - id: value - type: string - description: '' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStringUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStringUtils.yml deleted file mode 100644 index c5de376..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserStringUtils.yml +++ /dev/null @@ -1,82 +0,0 @@ -### YamlMime:TSType -name: BrowserStringUtils -uid: '@azure/msal-browser.BrowserStringUtils' -package: '@azure/msal-browser' -summary: >- - Utility functions for strings in a browser. See here for implementation - details: - - https://developer.mozilla.org/en-US/docs/Web/API/WindowBase64/Base64_encoding_and_decoding#Solution_2_%E2%80%93_JavaScript's_UTF-16_%3E_UTF-8_%3E_base64 -fullName: BrowserStringUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: getSortedObjectString(object) - uid: '@azure/msal-browser.BrowserStringUtils.getSortedObjectString' - package: '@azure/msal-browser' - summary: Returns stringified jwk. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function getSortedObjectString(obj: object): string' - parameters: - - id: obj - type: object - description: '' - return: - description: '' - type: string - - name: stringToArrayBuffer(string) - uid: '@azure/msal-browser.BrowserStringUtils.stringToArrayBuffer' - package: '@azure/msal-browser' - summary: Converst string to ArrayBuffer - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function stringToArrayBuffer(dataString: string): ArrayBuffer' - parameters: - - id: dataString - type: string - description: |+ - - return: - description: '' - type: ArrayBuffer - - name: stringToUtf8Arr(string) - uid: '@azure/msal-browser.BrowserStringUtils.stringToUtf8Arr' - package: '@azure/msal-browser' - summary: Converts string to Uint8Array - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function stringToUtf8Arr(sDOMStr: string): Uint8Array' - parameters: - - id: sDOMStr - type: string - description: |+ - - return: - description: '' - type: Uint8Array - - name: utf8ArrToString(Uint8Array) - uid: '@azure/msal-browser.BrowserStringUtils.utf8ArrToString' - package: '@azure/msal-browser' - summary: Converts Uint8Array to a string - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function utf8ArrToString(aBytes: Uint8Array): string' - parameters: - - id: aBytes - type: Uint8Array - description: |+ - - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml index f616882..d56ff9e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserSystemOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type BrowserSystemOptions = SystemOptions & { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml index 1670031..8091a28 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Telemetry Options fullName: BrowserTelemetryOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type BrowserTelemetryOptions = { application?: ApplicationTelemetry } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml index a605091..26f7fb5 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Utility class for browser specific functions fullName: BrowserUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-browser' summary: Block redirectUri loaded in popup from calling AcquireToken APIs remarks: '' - isPreview: false isDeprecated: false syntax: content: static function blockAcquireTokenInPopups() @@ -25,7 +23,6 @@ methods: Throws error if native brokering is enabled but initialize hasn't been called remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -45,7 +42,6 @@ methods: package: '@azure/msal-browser' summary: Throws error if token requests are made in non-browser environment remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -61,7 +57,6 @@ methods: package: '@azure/msal-browser' summary: Block redirect operations in iframes unless explicitly allowed remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -82,7 +77,6 @@ methods: Throws error if we have completed an auth and are attempting another auth request inside an iframe. remarks: '' - isPreview: false isDeprecated: false syntax: content: static function blockReloadInHiddenIframes() @@ -91,7 +85,6 @@ methods: package: '@azure/msal-browser' summary: Clears hash from window url. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function clearHash(contentWindow: Window)' @@ -106,7 +99,6 @@ methods: Returns boolean of whether current browser is an Internet Explorer or Edge browser. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function detectIEOrEdge(): boolean' @@ -118,7 +110,6 @@ methods: package: '@azure/msal-browser' summary: Returns best compatible network client object. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function getBrowserNetworkClient(): INetworkModule' @@ -130,7 +121,6 @@ methods: package: '@azure/msal-browser' summary: Returns current window URL as redirect uri remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function getCurrentUri(): string' @@ -142,7 +132,6 @@ methods: package: '@azure/msal-browser' summary: Gets the homepage url for the current window location. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function getHomepage(): string' @@ -154,7 +143,6 @@ methods: package: '@azure/msal-browser' summary: Returns boolean of whether the current window is in an iframe or not. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function isInIframe(): boolean' @@ -168,7 +156,6 @@ methods: Returns boolean of whether or not the current window is a popup opened by msal remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function isInPopup(): boolean' @@ -180,7 +167,6 @@ methods: package: '@azure/msal-browser' summary: Replaces current hash with hash from provided url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function replaceHash(url: string)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml index fad71a3..4398174 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: CacheLookupPolicy remarks: '' -isPreview: false isDeprecated: false fields: - name: Default diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml index 5a0c652..a724554 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: 'Use this to configure the below cache configuration options:' fullName: CacheOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type CacheOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/CachedKeyPair.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/CachedKeyPair.yml index 3346eba..dc4a23c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/CachedKeyPair.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/CachedKeyPair.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: CachedKeyPair remarks: '' -isPreview: false isDeprecated: false syntax: | type CachedKeyPair = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml index 2b59432..8aebe1a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: ClientApplication remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ClientApplication(configuration: Configuration)' @@ -40,7 +38,6 @@ methods: Redemption of this authorization code will not require PKCE, as it was acquired by a confidential client. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -62,7 +59,6 @@ methods: Use when you want to obtain an access_token for your API via opening a popup window in the user's browser remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -95,7 +91,6 @@ methods: browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function acquireTokenRedirect(request: RedirectRequest): Promise' @@ -112,7 +107,6 @@ methods: package: '@azure/msal-browser' summary: Adds event callbacks to array remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -131,7 +125,6 @@ methods: package: '@azure/msal-browser' summary: Registers a callback to receive performance events. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -151,7 +144,6 @@ methods: Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window remarks: '' - isPreview: false isDeprecated: false syntax: content: function disableAccountStorageEvents() @@ -162,7 +154,6 @@ methods: Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window remarks: '' - isPreview: false isDeprecated: false syntax: content: function enableAccountStorageEvents() @@ -174,7 +165,6 @@ methods: (the account object is created at the time of successful login) or null when no matching account is found remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountByHomeId(homeAccountId: string): AccountInfo | null' @@ -193,7 +183,6 @@ methods: (the account object is created at the time of successful login) or null when no matching account is found remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountByLocalId(localAccountId: string): AccountInfo | null' @@ -217,7 +206,6 @@ methods: This API is provided for convenience but getAccountById should be used for best reliability remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountByUsername(userName: string): AccountInfo | null' @@ -233,7 +221,6 @@ methods: package: '@azure/msal-browser' summary: Gets the currently active account remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getActiveAccount(): AccountInfo | null' @@ -248,7 +235,6 @@ methods: (the account object is created at the time of successful login) or empty array when no accounts are found remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): AccountInfo[]' @@ -260,7 +246,6 @@ methods: package: '@azure/msal-browser' summary: Returns the configuration object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getConfiguration(): BrowserConfiguration' @@ -272,7 +257,6 @@ methods: package: '@azure/msal-browser' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -284,7 +268,6 @@ methods: package: '@azure/msal-browser' summary: Gets the token cache for the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): ITokenCache' @@ -303,7 +286,6 @@ methods: auth flows. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -328,7 +310,6 @@ methods: Initializer function to perform async startup tasks such as connecting to WAM extension remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(): Promise' @@ -342,7 +323,6 @@ methods: Called by wrapper libraries (Angular & React) to set SKU and Version passed down to telemetry, logger, etc. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' @@ -359,7 +339,6 @@ methods: package: '@azure/msal-browser' summary: Deprecated logout function. Use logoutRedirect or logoutPopup instead remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -378,7 +357,6 @@ methods: Clears local cache for the current user then opens a popup window prompting the user to sign-out of the server remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -401,7 +379,6 @@ methods: Default behaviour is to redirect the user to `window.location.href`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -420,7 +397,6 @@ methods: package: '@azure/msal-browser' summary: Removes callback with provided id from callback array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeEventCallback(callbackId: string)' @@ -434,7 +410,6 @@ methods: package: '@azure/msal-browser' summary: Removes a callback registered with addPerformanceCallback. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -452,7 +427,6 @@ methods: Sets the account to use as the active account. If no account is passed to the acquireToken APIs, then MSAL will use this active account. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setActiveAccount(account: AccountInfo | null)' @@ -468,7 +442,6 @@ methods: Replaces the default logger set in configurations with new Logger with new configurations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' @@ -482,7 +455,6 @@ methods: package: '@azure/msal-browser' summary: Sets navigation client remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setNavigationClient(navigationClient: INavigationClient)' @@ -515,7 +487,6 @@ methods: you session on the server still exists. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/Configuration.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/Configuration.yml index 0dcf1d0..37e5c80 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/Configuration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/Configuration.yml @@ -7,7 +7,6 @@ summary: >- and is passed into the constructor of PublicClientApplication fullName: Configuration remarks: '' -isPreview: false isDeprecated: false syntax: | type Configuration = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoKeyStore.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoKeyStore.yml deleted file mode 100644 index 4fa9db8..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoKeyStore.yml +++ /dev/null @@ -1,79 +0,0 @@ -### YamlMime:TSType -name: CryptoKeyStore -uid: '@azure/msal-browser.CryptoKeyStore' -package: '@azure/msal-browser' -summary: MSAL CryptoKeyStore DB Version 2 -fullName: CryptoKeyStore -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: CryptoKeyStore(Logger) - uid: '@azure/msal-browser.CryptoKeyStore.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new CryptoKeyStore(logger: Logger)' - parameters: - - id: logger - type: Logger - description: '' -properties: - - name: asymmetricKeys - uid: '@azure/msal-browser.CryptoKeyStore.asymmetricKeys' - package: '@azure/msal-browser' - summary: '' - fullName: asymmetricKeys - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'asymmetricKeys: AsyncMemoryStorage' - return: - description: '' - type: >- - <> - - name: logger - uid: '@azure/msal-browser.CryptoKeyStore.logger' - package: '@azure/msal-browser' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: Logger - - name: symmetricKeys - uid: '@azure/msal-browser.CryptoKeyStore.symmetricKeys' - package: '@azure/msal-browser' - summary: '' - fullName: symmetricKeys - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'symmetricKeys: AsyncMemoryStorage' - return: - description: '' - type: <CryptoKey> -methods: - - name: clear() - uid: '@azure/msal-browser.CryptoKeyStore.clear' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function clear(): Promise' - return: - description: '' - type: Promise<boolean> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoKeyStoreNames.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoKeyStoreNames.yml deleted file mode 100644 index e7c172a..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoKeyStoreNames.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: CryptoKeyStoreNames -uid: '@azure/msal-browser.CryptoKeyStoreNames' -package: '@azure/msal-browser' -summary: '' -fullName: CryptoKeyStoreNames -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: asymmetricKeys - uid: '@azure/msal-browser.CryptoKeyStoreNames.asymmetricKeys' - package: '@azure/msal-browser' - summary: '' - - name: symmetricKeys - uid: '@azure/msal-browser.CryptoKeyStoreNames.symmetricKeys' - package: '@azure/msal-browser' - summary: '' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoOps.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoOps.yml index dbc4fe0..557fbda 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoOps.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoOps.yml @@ -10,7 +10,6 @@ summary: >- Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636). fullName: CryptoOps remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -41,7 +39,6 @@ methods: package: '@azure/msal-browser' summary: Decodes input string from base64. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Decode(input: string): string' @@ -58,7 +55,6 @@ methods: package: '@azure/msal-browser' summary: Encodes input string to base64. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Encode(input: string): string' @@ -75,7 +71,6 @@ methods: package: '@azure/msal-browser' summary: Removes all cryptographic keys from IndexedDB storage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function clearKeystore(): Promise' @@ -87,7 +82,6 @@ methods: package: '@azure/msal-browser' summary: Creates a new random GUID - used to populate state and nonce. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createNewGuid(): string' @@ -99,7 +93,6 @@ methods: package: '@azure/msal-browser' summary: Generates PKCE codes used in Authorization Code Flow. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generatePkceCodes(): Promise' @@ -111,7 +104,6 @@ methods: package: '@azure/msal-browser' summary: 'Generates a keypair, stores it and returns a thumbprint' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -130,7 +122,6 @@ methods: package: '@azure/msal-browser' summary: Returns the SHA-256 hash of an input string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function hashString(plainText: string): Promise' @@ -147,7 +138,6 @@ methods: package: '@azure/msal-browser' summary: Removes cryptographic keypair from key store matching the keyId passed in remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeTokenBindingKey(kid: string): Promise' @@ -166,7 +156,6 @@ methods: Signs the given object as a jwt payload with private key retrieved by given kid. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoOptions.yml index 60d6dfe..056c4db 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/CryptoOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: CryptoOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type CryptoOptions = { entropy?: Uint8Array, useMsrCrypto?: boolean } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/DatabaseStorage.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/DatabaseStorage.yml deleted file mode 100644 index 9394657..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/DatabaseStorage.yml +++ /dev/null @@ -1,147 +0,0 @@ -### YamlMime:TSType -name: DatabaseStorage -uid: '@azure/msal-browser.DatabaseStorage' -package: '@azure/msal-browser' -summary: >- - Storage wrapper for IndexedDB storage in browsers: - https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API -fullName: DatabaseStorage -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DatabaseStorage() - uid: '@azure/msal-browser.DatabaseStorage.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new DatabaseStorage() -methods: - - name: closeConnection() - uid: '@azure/msal-browser.DatabaseStorage.closeConnection' - package: '@azure/msal-browser' - summary: |- - Closes the connection to IndexedDB database when all pending transactions - complete. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function closeConnection() - - name: containsKey(string) - uid: '@azure/msal-browser.DatabaseStorage.containsKey' - package: '@azure/msal-browser' - summary: Checks whether there is an object under the search key in the object store - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function containsKey(key: string): Promise' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: Promise<boolean> - - name: deleteDatabase() - uid: '@azure/msal-browser.DatabaseStorage.deleteDatabase' - package: '@azure/msal-browser' - summary: >- - Deletes the MSAL database. The database is deleted rather than cleared to - make it possible - - for client applications to downgrade to a previous MSAL version without - worrying about forward compatibility issues - - with IndexedDB database versions. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function deleteDatabase(): Promise' - return: - description: '' - type: Promise<boolean> - - name: getItem(string) - uid: '@azure/msal-browser.DatabaseStorage.getItem' - package: '@azure/msal-browser' - summary: Retrieves item from IndexedDB instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getItem(key: string): Promise' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: Promise<T | null> - - name: getKeys() - uid: '@azure/msal-browser.DatabaseStorage.getKeys' - package: '@azure/msal-browser' - summary: Get all the keys from the storage object as an iterable array of strings. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getKeys(): Promise' - return: - description: '' - type: 'Promise<string[]>' - - name: open() - uid: '@azure/msal-browser.DatabaseStorage.open' - package: '@azure/msal-browser' - summary: Opens IndexedDB instance. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function open(): Promise' - return: - description: '' - type: Promise<void> - - name: removeItem(string) - uid: '@azure/msal-browser.DatabaseStorage.removeItem' - package: '@azure/msal-browser' - summary: Removes item from IndexedDB under given key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeItem(key: string): Promise' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: Promise<void> - - name: 'setItem(string, T)' - uid: '@azure/msal-browser.DatabaseStorage.setItem' - package: '@azure/msal-browser' - summary: Adds item to IndexedDB under given key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setItem(key: string, payload: T): Promise' - parameters: - - id: key - type: string - description: '' - - id: payload - type: T - description: |+ - - return: - description: '' - type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml index 67c2a44..3d56ea3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml @@ -29,10 +29,11 @@ summary: >- logged out in order to skip the server account picker on logout fullName: EndSessionPopupRequest remarks: '' -isPreview: false isDeprecated: false syntax: | - type EndSessionPopupRequest = Partial & { + type EndSessionPopupRequest = Partial< + Omit + > & { authority?: string, mainWindowRedirectUri?: string, popupWindowAttributes?: PopupWindowAttributes, diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml index f22b00f..0a34ab1 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml @@ -25,10 +25,9 @@ summary: >- logged out in order to skip the server account picker on logout fullName: EndSessionRequest remarks: '' -isPreview: false isDeprecated: false -syntax: | - type EndSessionRequest = Partial & { - authority?: string, - onRedirectNavigate?: (url: string) => boolean | void, +syntax: > + type EndSessionRequest = Partial< + Omit + > & { authority?: string, onRedirectNavigate?: (url: string) => boolean | void } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml index 1468512..43067a3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: EventCallbackFunction remarks: '' -isPreview: false isDeprecated: false syntax: | type EventCallbackFunction = (message: EventMessage) => void diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EventError.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EventError.yml index 45d042a..97b16ca 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EventError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EventError.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: EventError remarks: '' -isPreview: false isDeprecated: false syntax: | type EventError = AuthError | Error | null diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EventHandler.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EventHandler.yml index 7bc4572..3efb04e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EventHandler.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EventHandler.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: EventHandler remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new EventHandler(logger: Logger, browserCrypto: ICrypto)' @@ -31,7 +29,6 @@ methods: package: '@azure/msal-browser' summary: Adds event callbacks to array remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -52,7 +49,6 @@ methods: Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window remarks: '' - isPreview: false isDeprecated: false syntax: content: function disableAccountStorageEvents() @@ -61,7 +57,6 @@ methods: package: '@azure/msal-browser' summary: Emits events by calling callback with event message remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -88,7 +83,6 @@ methods: Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window remarks: '' - isPreview: false isDeprecated: false syntax: content: function enableAccountStorageEvents() @@ -97,7 +91,6 @@ methods: package: '@azure/msal-browser' summary: Removes callback with provided id from callback array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeEventCallback(callbackId: string)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EventMessage.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EventMessage.yml index c30fc3d..0531f5d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EventMessage.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EventMessage.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: EventMessage remarks: '' -isPreview: false isDeprecated: false syntax: | type EventMessage = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml index c272a3c..edd5016 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: EventMessageUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-browser' summary: Gets interaction status from event message remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EventPayload.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EventPayload.yml index 8a18b74..de8c150 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EventPayload.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EventPayload.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: EventPayload remarks: '' -isPreview: false isDeprecated: false syntax: | type EventPayload = diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EventType.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EventType.yml index 613ccff..583b815 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EventType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EventType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: EventType remarks: '' -isPreview: false isDeprecated: false fields: - name: ACCOUNT_ADDED diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/FetchClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/FetchClient.yml deleted file mode 100644 index 50db09b..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/FetchClient.yml +++ /dev/null @@ -1,55 +0,0 @@ -### YamlMime:TSType -name: FetchClient -uid: '@azure/msal-browser.FetchClient' -package: '@azure/msal-browser' -summary: >- - This class implements the Fetch API for GET and POST requests. See more here: - https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API -fullName: FetchClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'sendGetRequestAsync(string, NetworkRequestOptions)' - uid: '@azure/msal-browser.FetchClient.sendGetRequestAsync' - package: '@azure/msal-browser' - summary: Fetch Client for REST endpoints - Get request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendGetRequestAsync(url: string, options?: - NetworkRequestOptions): Promise> - parameters: - - id: url - type: string - description: '' - - id: options - type: NetworkRequestOptions - description: '' - return: - description: '' - type: Promise<NetworkResponse<T>> - - name: 'sendPostRequestAsync(string, NetworkRequestOptions)' - uid: '@azure/msal-browser.FetchClient.sendPostRequestAsync' - package: '@azure/msal-browser' - summary: Fetch Client for REST endpoints - Post request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendPostRequestAsync(url: string, options?: - NetworkRequestOptions): Promise> - parameters: - - id: url - type: string - description: '' - - id: options - type: NetworkRequestOptions - description: '' - return: - description: '' - type: Promise<NetworkResponse<T>> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/GuidGenerator.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/GuidGenerator.yml deleted file mode 100644 index 887e407..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/GuidGenerator.yml +++ /dev/null @@ -1,54 +0,0 @@ -### YamlMime:TSType -name: GuidGenerator -uid: '@azure/msal-browser.GuidGenerator' -package: '@azure/msal-browser' -summary: '' -fullName: GuidGenerator -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: GuidGenerator(BrowserCrypto) - uid: '@azure/msal-browser.GuidGenerator.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new GuidGenerator(cryptoObj: BrowserCrypto)' - parameters: - - id: cryptoObj - type: - description: '' -methods: - - name: generateGuid() - uid: '@azure/msal-browser.GuidGenerator.generateGuid' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateGuid(): string' - return: - description: '' - type: string - - name: isGuid(string) - uid: '@azure/msal-browser.GuidGenerator.isGuid' - package: '@azure/msal-browser' - summary: verifies if a string is GUID - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isGuid(guid: string): boolean' - parameters: - - id: guid - type: string - description: |+ - - return: - description: '' - type: boolean diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/HTTP_REQUEST_TYPE.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/HTTP_REQUEST_TYPE.yml index 6be7fef..d6e5200 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/HTTP_REQUEST_TYPE.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/HTTP_REQUEST_TYPE.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: HTTP Request types supported by MSAL. fullName: HTTP_REQUEST_TYPE remarks: '' -isPreview: false isDeprecated: false fields: - name: GET diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/HybridSpaAuthorizationCodeClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/HybridSpaAuthorizationCodeClient.yml deleted file mode 100644 index a93fa8a..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/HybridSpaAuthorizationCodeClient.yml +++ /dev/null @@ -1,184 +0,0 @@ -### YamlMime:TSType -name: HybridSpaAuthorizationCodeClient -uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient' -package: '@azure/msal-browser' -summary: '' -fullName: HybridSpaAuthorizationCodeClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: HybridSpaAuthorizationCodeClient(ClientConfiguration) - uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new HybridSpaAuthorizationCodeClient(config: ClientConfiguration)' - parameters: - - id: config - type: ClientConfiguration - description: '' -inheritedProperties: - - name: authority - uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.authority' - package: '@azure/msal-browser' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: Authority' - return: - description: '' - type: Authority - inheritanceDescription: Inherited From BaseClient.authority - - name: logger - uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.logger' - package: '@azure/msal-browser' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: Logger - inheritanceDescription: Inherited From BaseClient.logger -inheritedMethods: - - name: 'acquireToken(CommonAuthorizationCodeRequest, AuthorizationCodePayload)' - uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.acquireToken' - package: '@azure/msal-browser' - summary: >- - API to acquire a token in exchange of 'authorization_code` acquired by the - user in the first leg of the - - authorization_code_grant - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: CommonAuthorizationCodeRequest, - authCodePayload?: AuthorizationCodePayload): - Promise - parameters: - - id: request - type: CommonAuthorizationCodeRequest - description: |+ - - - id: authCodePayload - type: AuthorizationCodePayload - description: '' - return: - description: '' - type: Promise<AuthenticationResult> - inheritanceDescription: Inherited From AuthorizationCodeClient.acquireToken - - name: getAuthCodeUrl(CommonAuthorizationUrlRequest) - uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.getAuthCodeUrl' - package: '@azure/msal-browser' - summary: >- - Creates the URL of the authorization request letting the user input - credentials and consent to the - - application. The URL target the /authorize endpoint of the authority - configured in the - - application object. - - Once the user inputs their credentials and consents, the authority will - send a response to the redirect URI - - sent in the request and should contain an authorization code, which can - then be used to acquire tokens via - - acquireToken(AuthorizationCodeRequest) - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthCodeUrl(request: CommonAuthorizationUrlRequest): - Promise - parameters: - - id: request - type: CommonAuthorizationUrlRequest - description: |+ - - return: - description: '' - type: Promise<string> - inheritanceDescription: Inherited From AuthorizationCodeClient.getAuthCodeUrl - - name: getLogoutUri(CommonEndSessionRequest) - uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.getLogoutUri' - package: '@azure/msal-browser' - summary: >- - Used to log out the current user, and redirect the user to the - postLogoutRedirectUri. - - Default behaviour is to redirect the user to `window.location.href`. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getLogoutUri(logoutRequest: CommonEndSessionRequest): string' - parameters: - - id: logoutRequest - type: CommonEndSessionRequest - description: '' - return: - description: '' - type: string - inheritanceDescription: Inherited From AuthorizationCodeClient.getLogoutUri - - name: 'handleFragmentResponse(string, string)' - uid: >- - @azure/msal-browser.HybridSpaAuthorizationCodeClient.handleFragmentResponse - package: '@azure/msal-browser' - summary: >- - 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. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleFragmentResponse(hashFragment: string, cachedState: - string): AuthorizationCodePayload - parameters: - - id: hashFragment - type: string - description: |+ - - - id: cachedState - type: string - description: '' - return: - description: '' - type: AuthorizationCodePayload - inheritanceDescription: Inherited From AuthorizationCodeClient.handleFragmentResponse - - name: updateAuthority(Authority) - uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient.updateAuthority' - package: '@azure/msal-browser' - summary: >- - Updates the authority object of the client. Endpoint discovery must be - completed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function updateAuthority(updatedAuthority: Authority)' - parameters: - - id: updatedAuthority - type: Authority - description: |+ - - inheritanceDescription: Inherited From BaseClient.updateAuthority -extends: AuthorizationCodeClient diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/IAsyncStorage.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/IAsyncStorage.yml deleted file mode 100644 index 2a3325e..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/IAsyncStorage.yml +++ /dev/null @@ -1,98 +0,0 @@ -### YamlMime:TSType -name: IAsyncStorage -uid: '@azure/msal-browser.IAsyncStorage' -package: '@azure/msal-browser' -summary: '' -fullName: IAsyncStorage -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: containsKey(string) - uid: '@azure/msal-browser.IAsyncStorage.containsKey' - package: '@azure/msal-browser' - summary: Returns true or false if the given key is present in the cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function containsKey(key: string): Promise' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: Promise<boolean> - - name: getItem(string) - uid: '@azure/msal-browser.IAsyncStorage.getItem' - package: '@azure/msal-browser' - summary: Get the item from the asynchronous storage object matching the given key. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getItem(key: string): Promise' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: Promise<T | null> - - name: getKeys() - uid: '@azure/msal-browser.IAsyncStorage.getKeys' - package: '@azure/msal-browser' - summary: >- - Get all the keys from the asynchronous storage object as an iterable array - of strings. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getKeys(): Promise' - return: - description: '' - type: 'Promise<string[]>' - - name: removeItem(string) - uid: '@azure/msal-browser.IAsyncStorage.removeItem' - package: '@azure/msal-browser' - summary: >- - Removes the item in the asynchronous storage object matching the given - key. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeItem(key: string): Promise' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: Promise<void> - - name: 'setItem(string, T)' - uid: '@azure/msal-browser.IAsyncStorage.setItem' - package: '@azure/msal-browser' - summary: Sets the item in the asynchronous storage object with the given key. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setItem(key: string, value: T): Promise' - parameters: - - id: key - type: string - description: '' - - id: value - type: T - description: |+ - - return: - description: '' - type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml index 6be5efc..3cac69e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: INavigationClient remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -16,7 +15,6 @@ methods: Navigates to other pages outside the web application i.e. the Identity Provider remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -42,7 +40,6 @@ methods: Return false if this doesn't cause the page to reload i.e. Client-side navigation remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml index 7e1474d..832255d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: IPublicClientApplication remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,7 +30,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -50,7 +47,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function acquireTokenRedirect(request: RedirectRequest): Promise' @@ -66,7 +62,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -84,7 +79,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addEventCallback(callback: Function): string | null' @@ -100,7 +94,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -118,7 +111,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function disableAccountStorageEvents() @@ -127,7 +119,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function enableAccountStorageEvents() @@ -136,7 +127,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountByHomeId(homeAccountId: string): AccountInfo | null' @@ -152,7 +142,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountByLocalId(localId: string): AccountInfo | null' @@ -168,7 +157,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountByUsername(userName: string): AccountInfo | null' @@ -184,7 +172,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getActiveAccount(): AccountInfo | null' @@ -196,7 +183,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): AccountInfo[]' @@ -208,7 +194,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getConfiguration(): BrowserConfiguration' @@ -220,7 +205,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -232,7 +216,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): ITokenCache' @@ -244,7 +227,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -262,7 +244,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(): Promise' @@ -274,7 +255,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' @@ -290,7 +270,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -308,7 +287,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loginRedirect(request?: RedirectRequest): Promise' @@ -324,7 +302,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(logoutRequest?: EndSessionRequest): Promise' @@ -340,7 +317,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -358,7 +334,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -376,7 +351,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeEventCallback(callbackId: string)' @@ -389,7 +363,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -405,7 +378,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setActiveAccount(account: AccountInfo | null)' @@ -418,7 +390,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' @@ -431,7 +402,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setNavigationClient(navigationClient: INavigationClient)' @@ -444,7 +414,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/ISubtleCrypto.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/ISubtleCrypto.yml deleted file mode 100644 index 8e75141..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/ISubtleCrypto.yml +++ /dev/null @@ -1,153 +0,0 @@ -### YamlMime:TSType -name: ISubtleCrypto -uid: '@azure/msal-browser.ISubtleCrypto' -package: '@azure/msal-browser' -summary: '' -fullName: ISubtleCrypto -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: 'digest(AlgorithmIdentifier, Uint8Array)' - uid: '@azure/msal-browser.ISubtleCrypto.digest' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function digest(algorithm: AlgorithmIdentifier, data: Uint8Array): - Promise - parameters: - - id: algorithm - type: AlgorithmIdentifier - description: '' - - id: data - type: Uint8Array - description: '' - return: - description: '' - type: Promise<ArrayBuffer> - - name: exportKey(CryptoKey) - uid: '@azure/msal-browser.ISubtleCrypto.exportKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function exportKey(key: CryptoKey): Promise' - parameters: - - id: key - type: CryptoKey - description: '' - return: - description: '' - type: Promise<JsonWebKey> - - name: 'generateKey(RsaHashedKeyGenParams, boolean, KeyUsage[])' - uid: '@azure/msal-browser.ISubtleCrypto.generateKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function generateKey(algorithm: RsaHashedKeyGenParams, extractable: - boolean, keyUsages: KeyUsage[]): Promise - parameters: - - id: algorithm - type: RsaHashedKeyGenParams - description: '' - - id: extractable - type: boolean - description: '' - - id: keyUsages - type: 'KeyUsage[]' - description: '' - return: - description: '' - type: Promise<CryptoKeyPair> - - name: getRandomValues(Uint8Array) - uid: '@azure/msal-browser.ISubtleCrypto.getRandomValues' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getRandomValues(dataBuffer: Uint8Array): Uint8Array' - parameters: - - id: dataBuffer - type: Uint8Array - description: '' - return: - description: '' - type: Uint8Array - - name: 'importKey(JsonWebKey, RsaHashedImportParams, boolean, KeyUsage[])' - uid: '@azure/msal-browser.ISubtleCrypto.importKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function importKey(keyData: JsonWebKey, algorithm: - RsaHashedImportParams, extractable: boolean, keyUsages: KeyUsage[]): - Promise - parameters: - - id: keyData - type: JsonWebKey - description: '' - - id: algorithm - type: RsaHashedImportParams - description: '' - - id: extractable - type: boolean - description: '' - - id: keyUsages - type: 'KeyUsage[]' - description: '' - return: - description: '' - type: Promise<CryptoKey> - - name: initPrng(Uint8Array) - uid: '@azure/msal-browser.ISubtleCrypto.initPrng' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function initPrng(entropy: Uint8Array)' - parameters: - - id: entropy - type: Uint8Array - description: '' - - name: 'sign(AlgorithmIdentifier, CryptoKey, ArrayBuffer)' - uid: '@azure/msal-browser.ISubtleCrypto.sign' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sign(algorithm: AlgorithmIdentifier, key: CryptoKey, data: - ArrayBuffer): Promise - parameters: - - id: algorithm - type: AlgorithmIdentifier - description: '' - - id: key - type: CryptoKey - description: '' - - id: data - type: ArrayBuffer - description: '' - return: - description: '' - type: Promise<ArrayBuffer> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml index 295692e..7cdb38b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: ITokenCache remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-browser' summary: API to side-load tokens to MSAL cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml index 03bcd05..0def7aa 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: IWindowStorage remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-browser' summary: Returns true or false if the given key is present in the cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function containsKey(key: string): boolean' @@ -31,7 +29,6 @@ methods: package: '@azure/msal-browser' summary: Get the item from the window storage object matching the given key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getItem(key: string): T | null' @@ -50,7 +47,6 @@ methods: Get all the keys from the window storage object as an iterable array of strings. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKeys(): string[]' @@ -62,7 +58,6 @@ methods: package: '@azure/msal-browser' summary: Removes the item in the window storage object matching the given key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeItem(key: string)' @@ -76,7 +71,6 @@ methods: package: '@azure/msal-browser' summary: Sets the item in the window storage object with the given key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setItem(key: string, value: T)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/InMemoryCacheKeys.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/InMemoryCacheKeys.yml index d426ead..54292b2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/InMemoryCacheKeys.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/InMemoryCacheKeys.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Cache keys stored in-memory fullName: InMemoryCacheKeys remarks: '' -isPreview: false isDeprecated: false fields: - name: WRAPPER_SKU diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionHandler.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionHandler.yml index 16e36a4..b5f5ae6 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionHandler.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionHandler.yml @@ -7,24 +7,23 @@ summary: >- class. fullName: InteractionHandler remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: >- InteractionHandler(AuthorizationCodeClient, BrowserCacheManager, - CommonAuthorizationCodeRequest, Logger) + CommonAuthorizationCodeRequest, Logger, IPerformanceClient) uid: '@azure/msal-browser.InteractionHandler.constructor' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new InteractionHandler(authCodeModule: AuthorizationCodeClient, storageImpl: BrowserCacheManager, authCodeRequest: - CommonAuthorizationCodeRequest, logger: Logger) + CommonAuthorizationCodeRequest, logger: Logger, performanceClient: + IPerformanceClient) parameters: - id: authCodeModule type: AuthorizationCodeClient @@ -38,13 +37,15 @@ constructors: - id: logger type: Logger description: '' + - id: performanceClient + type: IPerformanceClient + description: '' methods: - name: 'handleCodeResponseFromHash(string, string, Authority, INetworkModule)' uid: '@azure/msal-browser.InteractionHandler.handleCodeResponseFromHash' package: '@azure/msal-browser' summary: Function to handle response parameters from hash. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -75,7 +76,6 @@ methods: package: '@azure/msal-browser' summary: Process auth code response from AAD remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionParams.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionParams.yml index 5543676..dd95d3f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionParams.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionParams.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: InteractionParams remarks: '' -isPreview: false isDeprecated: false syntax: | type InteractionParams = Object diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml index 176b96a..b35fd6d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml @@ -9,7 +9,6 @@ summary: >- interaction is in progress or all interactions are complete. fullName: InteractionStatus remarks: '' -isPreview: false isDeprecated: false fields: - name: AcquireToken diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionType.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionType.yml index 9a5d982..70c9654 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/InteractionType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: InteractionType remarks: '' -isPreview: false isDeprecated: false fields: - name: None diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml index 426e4d2..08dff34 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: LoadTokenOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type LoadTokenOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/MATS.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/MATS.yml index 1e3d54f..a8e3a4e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/MATS.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/MATS.yml @@ -8,7 +8,6 @@ summary: >- following properties in the telemetry it collects. fullName: MATS remarks: '' -isPreview: false isDeprecated: false syntax: | type MATS = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/MathUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/MathUtils.yml deleted file mode 100644 index c3822ae..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/MathUtils.yml +++ /dev/null @@ -1,28 +0,0 @@ -### YamlMime:TSType -name: MathUtils -uid: '@azure/msal-browser.MathUtils' -package: '@azure/msal-browser' -summary: Utility class for math specific functions in browser. -fullName: MathUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: decimalToHex(number) - uid: '@azure/msal-browser.MathUtils.decimalToHex' - package: '@azure/msal-browser' - summary: Decimal to Hex - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function decimalToHex(num: number): string' - parameters: - - id: num - type: number - description: |+ - - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml index d385603..3ae8ee0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: MemoryStorage remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: new MemoryStorage() @@ -24,7 +22,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function clear() @@ -33,7 +30,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function containsKey(key: string): boolean' @@ -49,7 +45,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getItem(key: string): T | null' @@ -65,7 +60,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKeys(): string[]' @@ -77,7 +71,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeItem(key: string)' @@ -90,7 +83,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setItem(key: string, value: T)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/ModernBrowserCrypto.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/ModernBrowserCrypto.yml deleted file mode 100644 index 76b0b9f..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/ModernBrowserCrypto.yml +++ /dev/null @@ -1,140 +0,0 @@ -### YamlMime:TSType -name: ModernBrowserCrypto -uid: '@azure/msal-browser.ModernBrowserCrypto' -package: '@azure/msal-browser' -summary: '' -fullName: ModernBrowserCrypto -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'digest(AlgorithmIdentifier, Uint8Array)' - uid: '@azure/msal-browser.ModernBrowserCrypto.digest' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function digest(algorithm: AlgorithmIdentifier, data: Uint8Array): - Promise - parameters: - - id: algorithm - type: AlgorithmIdentifier - description: '' - - id: data - type: Uint8Array - description: '' - return: - description: '' - type: Promise<ArrayBuffer> - - name: exportKey(CryptoKey) - uid: '@azure/msal-browser.ModernBrowserCrypto.exportKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function exportKey(key: CryptoKey): Promise' - parameters: - - id: key - type: CryptoKey - description: '' - return: - description: '' - type: Promise<JsonWebKey> - - name: 'generateKey(RsaHashedKeyGenParams, boolean, KeyUsage[])' - uid: '@azure/msal-browser.ModernBrowserCrypto.generateKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function generateKey(algorithm: RsaHashedKeyGenParams, extractable: - boolean, keyUsages: KeyUsage[]): Promise - parameters: - - id: algorithm - type: RsaHashedKeyGenParams - description: '' - - id: extractable - type: boolean - description: '' - - id: keyUsages - type: 'KeyUsage[]' - description: '' - return: - description: '' - type: Promise<CryptoKeyPair> - - name: getRandomValues(Uint8Array) - uid: '@azure/msal-browser.ModernBrowserCrypto.getRandomValues' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getRandomValues(dataBuffer: Uint8Array): Uint8Array' - parameters: - - id: dataBuffer - type: Uint8Array - description: '' - return: - description: '' - type: Uint8Array - - name: 'importKey(JsonWebKey, RsaHashedImportParams, boolean, KeyUsage[])' - uid: '@azure/msal-browser.ModernBrowserCrypto.importKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function importKey(keyData: JsonWebKey, algorithm: - RsaHashedImportParams, extractable: boolean, keyUsages: KeyUsage[]): - Promise - parameters: - - id: keyData - type: JsonWebKey - description: '' - - id: algorithm - type: RsaHashedImportParams - description: '' - - id: extractable - type: boolean - description: '' - - id: keyUsages - type: 'KeyUsage[]' - description: '' - return: - description: '' - type: Promise<CryptoKey> - - name: 'sign(AlgorithmIdentifier, CryptoKey, ArrayBuffer)' - uid: '@azure/msal-browser.ModernBrowserCrypto.sign' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sign(algorithm: AlgorithmIdentifier, key: CryptoKey, data: - ArrayBuffer): Promise - parameters: - - id: algorithm - type: AlgorithmIdentifier - description: '' - - id: key - type: CryptoKey - description: '' - - id: data - type: ArrayBuffer - description: '' - return: - description: '' - type: Promise<ArrayBuffer> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/MsBrowserCrypto.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/MsBrowserCrypto.yml deleted file mode 100644 index a137998..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/MsBrowserCrypto.yml +++ /dev/null @@ -1,140 +0,0 @@ -### YamlMime:TSType -name: MsBrowserCrypto -uid: '@azure/msal-browser.MsBrowserCrypto' -package: '@azure/msal-browser' -summary: '' -fullName: MsBrowserCrypto -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'digest(AlgorithmIdentifier, Uint8Array)' - uid: '@azure/msal-browser.MsBrowserCrypto.digest' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function digest(algorithm: AlgorithmIdentifier, data: Uint8Array): - Promise - parameters: - - id: algorithm - type: AlgorithmIdentifier - description: '' - - id: data - type: Uint8Array - description: '' - return: - description: '' - type: Promise<ArrayBuffer> - - name: exportKey(CryptoKey) - uid: '@azure/msal-browser.MsBrowserCrypto.exportKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function exportKey(key: CryptoKey): Promise' - parameters: - - id: key - type: CryptoKey - description: '' - return: - description: '' - type: Promise<JsonWebKey> - - name: 'generateKey(RsaHashedKeyGenParams, boolean, KeyUsage[])' - uid: '@azure/msal-browser.MsBrowserCrypto.generateKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function generateKey(algorithm: RsaHashedKeyGenParams, extractable: - boolean, keyUsages: KeyUsage[]): Promise - parameters: - - id: algorithm - type: RsaHashedKeyGenParams - description: '' - - id: extractable - type: boolean - description: '' - - id: keyUsages - type: 'KeyUsage[]' - description: '' - return: - description: '' - type: Promise<CryptoKeyPair> - - name: getRandomValues(Uint8Array) - uid: '@azure/msal-browser.MsBrowserCrypto.getRandomValues' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getRandomValues(dataBuffer: Uint8Array): Uint8Array' - parameters: - - id: dataBuffer - type: Uint8Array - description: '' - return: - description: '' - type: Uint8Array - - name: 'importKey(JsonWebKey, RsaHashedImportParams, boolean, KeyUsage[])' - uid: '@azure/msal-browser.MsBrowserCrypto.importKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function importKey(keyData: JsonWebKey, algorithm: - RsaHashedImportParams, extractable: boolean, keyUsages: KeyUsage[]): - Promise - parameters: - - id: keyData - type: JsonWebKey - description: '' - - id: algorithm - type: RsaHashedImportParams - description: '' - - id: extractable - type: boolean - description: '' - - id: keyUsages - type: 'KeyUsage[]' - description: '' - return: - description: '' - type: Promise<CryptoKey> - - name: 'sign(AlgorithmIdentifier, CryptoKey, ArrayBuffer)' - uid: '@azure/msal-browser.MsBrowserCrypto.sign' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sign(algorithm: AlgorithmIdentifier, key: CryptoKey, data: - ArrayBuffer): Promise - parameters: - - id: algorithm - type: AlgorithmIdentifier - description: '' - - id: key - type: CryptoKey - description: '' - - id: data - type: ArrayBuffer - description: '' - return: - description: '' - type: Promise<ArrayBuffer> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/MsrBrowserCrypto.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/MsrBrowserCrypto.yml deleted file mode 100644 index 55221b3..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/MsrBrowserCrypto.yml +++ /dev/null @@ -1,153 +0,0 @@ -### YamlMime:TSType -name: MsrBrowserCrypto -uid: '@azure/msal-browser.MsrBrowserCrypto' -package: '@azure/msal-browser' -summary: '' -fullName: MsrBrowserCrypto -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'digest(AlgorithmIdentifier, Uint8Array)' - uid: '@azure/msal-browser.MsrBrowserCrypto.digest' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function digest(algorithm: AlgorithmIdentifier, data: Uint8Array): - Promise - parameters: - - id: algorithm - type: AlgorithmIdentifier - description: '' - - id: data - type: Uint8Array - description: '' - return: - description: '' - type: Promise<ArrayBuffer> - - name: exportKey(CryptoKey) - uid: '@azure/msal-browser.MsrBrowserCrypto.exportKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function exportKey(key: CryptoKey): Promise' - parameters: - - id: key - type: CryptoKey - description: '' - return: - description: '' - type: Promise<JsonWebKey> - - name: 'generateKey(RsaHashedKeyGenParams, boolean, KeyUsage[])' - uid: '@azure/msal-browser.MsrBrowserCrypto.generateKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function generateKey(algorithm: RsaHashedKeyGenParams, extractable: - boolean, keyUsages: KeyUsage[]): Promise - parameters: - - id: algorithm - type: RsaHashedKeyGenParams - description: '' - - id: extractable - type: boolean - description: '' - - id: keyUsages - type: 'KeyUsage[]' - description: '' - return: - description: '' - type: Promise<CryptoKeyPair> - - name: getRandomValues(Uint8Array) - uid: '@azure/msal-browser.MsrBrowserCrypto.getRandomValues' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getRandomValues(dataBuffer: Uint8Array): Uint8Array' - parameters: - - id: dataBuffer - type: Uint8Array - description: '' - return: - description: '' - type: Uint8Array - - name: 'importKey(JsonWebKey, RsaHashedImportParams, boolean, KeyUsage[])' - uid: '@azure/msal-browser.MsrBrowserCrypto.importKey' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function importKey(keyData: JsonWebKey, algorithm: - RsaHashedImportParams, extractable: boolean, keyUsages: KeyUsage[]): - Promise - parameters: - - id: keyData - type: JsonWebKey - description: '' - - id: algorithm - type: RsaHashedImportParams - description: '' - - id: extractable - type: boolean - description: '' - - id: keyUsages - type: 'KeyUsage[]' - description: '' - return: - description: '' - type: Promise<CryptoKey> - - name: initPrng(Uint8Array) - uid: '@azure/msal-browser.MsrBrowserCrypto.initPrng' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function initPrng(entropy: Uint8Array)' - parameters: - - id: entropy - type: Uint8Array - description: '' - - name: 'sign(AlgorithmIdentifier, CryptoKey, ArrayBuffer)' - uid: '@azure/msal-browser.MsrBrowserCrypto.sign' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sign(algorithm: AlgorithmIdentifier, key: CryptoKey, data: - ArrayBuffer): Promise - parameters: - - id: algorithm - type: AlgorithmIdentifier - description: '' - - id: key - type: CryptoKey - description: '' - - id: data - type: ArrayBuffer - description: '' - return: - description: '' - type: Promise<ArrayBuffer> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeAccountInfo.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeAccountInfo.yml index abe7baf..25bb610 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeAccountInfo.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeAccountInfo.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Account properties returned by Native Platform e.g. WAM fullName: NativeAccountInfo remarks: '' -isPreview: false isDeprecated: false syntax: | type NativeAccountInfo = { id: string, properties: object, userName: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeAuthError.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeAuthError.yml index 678f784..3cc664e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeAuthError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeAuthError.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: NativeAuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,7 +35,6 @@ properties: summary: '' fullName: ext remarks: '' - isPreview: false isDeprecated: false syntax: content: 'ext: OSError | undefined' @@ -51,7 +48,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -65,7 +61,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -79,7 +74,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -93,7 +87,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -107,7 +100,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -121,7 +113,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -135,7 +126,6 @@ inheritedProperties: summary: Describes the subclass of an error fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -149,7 +139,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Creates an error for post request failures. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createPostRequestFailed(errDesc: string): AuthError' @@ -168,7 +157,6 @@ inheritedMethods: Creates an error that is thrown when something unexpected happens in the library. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -186,7 +174,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -201,7 +188,6 @@ methods: package: '@azure/msal-browser' summary: Create the appropriate error object based on the WAM status code. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -225,7 +211,6 @@ methods: package: '@azure/msal-browser' summary: Creates a tokens not found error when the internal cache look up fails remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createTokensNotFoundInCacheError(): NativeAuthError' @@ -239,7 +224,6 @@ methods: Creates user switch error when the user chooses a different account in the native broker prompt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserSwitchError(): NativeAuthError' @@ -253,7 +237,6 @@ methods: These errors should result in a fallback to the 'standard' browser based auth flow. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isFatal(): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionMethod.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionMethod.yml index edfc9d9..4b2bb75 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionMethod.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionMethod.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: NativeExtensionMethod remarks: '' -isPreview: false isDeprecated: false fields: - name: GetToken diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequest.yml index 9f6c915..5741701 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequest.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Browser extension request fullName: NativeExtensionRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type NativeExtensionRequest = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequestBody.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequestBody.yml index 5c51518..ff1ba2a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequestBody.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequestBody.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Request which will be forwarded to native broker by the browser extension fullName: NativeExtensionRequestBody remarks: '' -isPreview: false isDeprecated: false syntax: | type NativeExtensionRequestBody = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml index 0d06de4..2a64989 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: NativeInteractionClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -71,7 +69,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Use to get the redirect uri configured in MSAL or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(requestRedirectUri?: string): string' @@ -91,7 +88,6 @@ methods: package: '@azure/msal-browser' summary: Acquire token from native platform via browser extension remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -115,7 +111,6 @@ methods: Acquires a token from native platform then redirects to the redirectUri instead of returning the response remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function acquireTokenRedirect(request: RedirectRequest): Promise' @@ -127,6 +122,99 @@ methods: return: description: '' type: Promise<void> + - name: cacheAccount(AccountEntity) + uid: '@azure/msal-browser.NativeInteractionClient.cacheAccount' + package: '@azure/msal-browser' + summary: cache the account entity in browser storage + remarks: '' + isDeprecated: false + syntax: + content: 'function cacheAccount(accountEntity: AccountEntity)' + parameters: + - id: accountEntity + type: AccountEntity + description: |+ + + - name: >- + cacheNativeTokens(NativeResponse, NativeTokenRequest, string, AuthToken, + string, string, number) + uid: '@azure/msal-browser.NativeInteractionClient.cacheNativeTokens' + package: '@azure/msal-browser' + summary: Stores the access_token and id_token in inmemory storage + remarks: '' + isDeprecated: false + syntax: + content: >- + function cacheNativeTokens(response: NativeResponse, request: + NativeTokenRequest, homeAccountIdentifier: string, idTokenObj: + AuthToken, responseAccessToken: string, tenantId: string, reqTimestamp: + number) + parameters: + - id: response + type: + description: '' + - id: request + type: + description: '' + - id: homeAccountIdentifier + type: string + description: '' + - id: idTokenObj + type: AuthToken + description: '' + - id: responseAccessToken + type: string + description: '' + - id: tenantId + type: string + description: '' + - id: reqTimestamp + type: number + description: |+ + + - name: 'generatePopAccessToken(NativeResponse, NativeTokenRequest)' + uid: '@azure/msal-browser.NativeInteractionClient.generatePopAccessToken' + package: '@azure/msal-browser' + summary: >- + If PoP token is requesred, records the PoP token if returned from the WAM, + else generates one in the browser + remarks: '' + isDeprecated: false + syntax: + content: >- + function generatePopAccessToken(response: NativeResponse, request: + NativeTokenRequest): Promise + parameters: + - id: response + type: + description: |+ + + - id: request + type: + description: '' + return: + description: '' + type: Promise<string> + - name: 'generateScopes(NativeResponse, NativeTokenRequest)' + uid: '@azure/msal-browser.NativeInteractionClient.generateScopes' + package: '@azure/msal-browser' + summary: Helper to generate scopes + remarks: '' + isDeprecated: false + syntax: + content: >- + function generateScopes(response: NativeResponse, request: + NativeTokenRequest): ScopeSet + parameters: + - id: response + type: + description: '' + - id: request + type: + description: '' + return: + description: '' + type: ScopeSet - name: handleRedirectPromise() uid: '@azure/msal-browser.NativeInteractionClient.handleRedirectPromise' package: '@azure/msal-browser' @@ -134,7 +222,6 @@ methods: If the previous page called native platform for a token using redirect APIs, send the same request again and return the response remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function handleRedirectPromise(): Promise' @@ -146,7 +233,6 @@ methods: package: '@azure/msal-browser' summary: Logout from native platform via browser extension remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeMessageHandler.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeMessageHandler.yml index 9b43061..7511fa3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeMessageHandler.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeMessageHandler.yml @@ -5,21 +5,19 @@ package: '@azure/msal-browser' summary: '' fullName: NativeMessageHandler remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'NativeMessageHandler(Logger, number, string)' + - name: 'NativeMessageHandler(Logger, number, IPerformanceClient, string)' uid: '@azure/msal-browser.NativeMessageHandler.constructor' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new NativeMessageHandler(logger: Logger, handshakeTimeoutMs: number, - extensionId?: string) + performanceClient: IPerformanceClient, extensionId?: string) parameters: - id: logger type: Logger @@ -27,29 +25,35 @@ constructors: - id: handshakeTimeoutMs type: number description: '' + - id: performanceClient + type: IPerformanceClient + description: '' - id: extensionId type: string description: '' methods: - - name: 'createProvider(Logger, number)' + - name: 'createProvider(Logger, number, IPerformanceClient)' uid: '@azure/msal-browser.NativeMessageHandler.createProvider' package: '@azure/msal-browser' summary: >- Returns an instance of the MessageHandler that has successfully established a connection with an extension remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function createProvider(logger: Logger, handshakeTimeoutMs: - number): Promise + number, performanceClient: IPerformanceClient): + Promise parameters: - id: logger type: Logger description: '' - id: handshakeTimeoutMs type: number + description: '' + - id: performanceClient + type: IPerformanceClient description: |+ return: @@ -62,7 +66,6 @@ methods: Returns the Id for the browser extension this handler is communicating with remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExtensionId(): string | undefined' @@ -76,7 +79,6 @@ methods: Returns the version for the browser extension this handler is communicating with remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getExtensionVersion(): string | undefined' @@ -92,7 +94,6 @@ methods: Returns boolean indicating whether or not the request should attempt to use native broker remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -123,7 +124,6 @@ methods: Sends a given message to the extension and resolves with the extension response remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function sendMessage(body: NativeExtensionRequestBody): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeResponse.yml index 040521d..a4cb316 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeResponse.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeResponse.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Token response returned by Native Platform e.g. WAM fullName: NativeResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type NativeResponse = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeResponseProperties.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeResponseProperties.yml index 267ed6d..b10d1e1 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeResponseProperties.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeResponseProperties.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Properties returned under "properties" of the NativeResponse fullName: NativeResponseProperties remarks: '' -isPreview: false isDeprecated: false syntax: | type NativeResponseProperties = { MATS?: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeStatusCode.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeStatusCode.yml index ce98bea..4e34002 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeStatusCode.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeStatusCode.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: NativeStatusCode remarks: '' -isPreview: false isDeprecated: false fields: - name: ACCOUNT_UNAVAILABLE diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeTokenRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeTokenRequest.yml index a1d3ddc..117572e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeTokenRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeTokenRequest.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Token request which native broker will use to acquire tokens fullName: NativeTokenRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type NativeTokenRequest = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml index 9c44421..918ee25 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: NavigationClient remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -16,7 +15,6 @@ methods: Navigates to other pages outside the web application i.e. the Identity Provider remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -38,7 +36,6 @@ methods: package: '@azure/msal-browser' summary: Navigates to other pages within the same web application remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NavigationOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NavigationOptions.yml index 13e1064..6590f97 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NavigationOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NavigationOptions.yml @@ -7,7 +7,6 @@ summary: >- functions fullName: NavigationOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type NavigationOptions = { apiId: ApiId, noHistory: boolean, timeout: number } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/OSError.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/OSError.yml index e4c73c0..4d29c15 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/OSError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/OSError.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: OSError remarks: '' -isPreview: false isDeprecated: false syntax: | type OSError = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PkceGenerator.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PkceGenerator.yml deleted file mode 100644 index 59a3917..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PkceGenerator.yml +++ /dev/null @@ -1,39 +0,0 @@ -### YamlMime:TSType -name: PkceGenerator -uid: '@azure/msal-browser.PkceGenerator' -package: '@azure/msal-browser' -summary: Class which exposes APIs to generate PKCE codes and code verifiers. -fullName: PkceGenerator -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: PkceGenerator(BrowserCrypto) - uid: '@azure/msal-browser.PkceGenerator.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new PkceGenerator(cryptoObj: BrowserCrypto)' - parameters: - - id: cryptoObj - type: - description: '' -methods: - - name: generateCodes() - uid: '@azure/msal-browser.PkceGenerator.generateCodes' - package: '@azure/msal-browser' - summary: >- - Generates PKCE Codes. See the RFC for more information: - https://tools.ietf.org/html/rfc7636 - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCodes(): Promise' - return: - description: '' - type: Promise<PkceCodes> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupClient.yml index ff04ad7..bd5db78 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: PopupClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -64,7 +62,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Use to get the redirect uri configured in MSAL or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(requestRedirectUri?: string): string' @@ -86,7 +83,6 @@ methods: Acquires tokens by opening a popup window to the /authorize endpoint of the authority remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -105,7 +101,6 @@ methods: package: '@azure/msal-browser' summary: 'Closes popup, removes any state vars created during popup calls.' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cleanPopup(popupWindow?: Window)' @@ -121,7 +116,6 @@ methods: Generates the name for the popup based on the client id and request for logouts remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -140,7 +134,6 @@ methods: package: '@azure/msal-browser' summary: Generates the name for the popup based on the client id and request remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -161,7 +154,6 @@ methods: package: '@azure/msal-browser' summary: Opens a popup window with given request Url. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -185,7 +177,6 @@ methods: Clears local cache for the current user then opens a popup window prompting the user to sign-out of the server remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(logoutRequest?: EndSessionPopupRequest): Promise' @@ -202,7 +193,6 @@ methods: package: '@azure/msal-browser' summary: Monitors a window until it loads a url with the same origin. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function monitorPopupForHash(popupWindow: Window): Promise' @@ -218,7 +208,6 @@ methods: package: '@azure/msal-browser' summary: Helper function to set popup window dimensions and position remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -242,7 +231,6 @@ methods: package: '@azure/msal-browser' summary: Event callback to unload main window. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unloadWindow(e: Event)' @@ -255,7 +243,6 @@ methods: package: '@azure/msal-browser' summary: Waits for user interaction in logout popup window remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function waitForLogoutPopup(popupWindow: Window): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml index 5532de3..f86cbb3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: PopupEvent remarks: '' -isPreview: false isDeprecated: false syntax: | type PopupEvent = { popupWindow: Window } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupParams.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupParams.yml index 78e5922..e3bf655 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupParams.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupParams.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: PopupParams remarks: '' -isPreview: false isDeprecated: false syntax: | type PopupParams = InteractionParams & { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml index a3f0e29..b1d0ff8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: PopupPosition remarks: '' -isPreview: false isDeprecated: false syntax: | type PopupPosition = { left: number, top: number } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml index 4ebc4b3..c923a10 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml @@ -68,7 +68,6 @@ summary: > with height and width, and popupPosition with top and left can be set. fullName: PopupRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type PopupRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupSize.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupSize.yml index a8079f1..77effca 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupSize.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupSize.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: PopupSize remarks: '' -isPreview: false isDeprecated: false syntax: | type PopupSize = { height: number, width: number } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml index beaca48..970f058 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Popup configurations for setting dimensions and position of popup window fullName: PopupWindowAttributes remarks: '' -isPreview: false isDeprecated: false syntax: | type PopupWindowAttributes = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml index 366266b..79ac12a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -10,7 +10,6 @@ summary: >- with PKCE specification. fullName: PublicClientApplication remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new PublicClientApplication(configuration: Configuration)' @@ -45,7 +43,6 @@ inheritedMethods: Redemption of this authorization code will not require PKCE, as it was acquired by a confidential client. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -70,7 +67,6 @@ inheritedMethods: Use when you want to obtain an access_token for your API via opening a popup window in the user's browser remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -106,7 +102,6 @@ inheritedMethods: browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function acquireTokenRedirect(request: RedirectRequest): Promise' @@ -126,7 +121,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Adds event callbacks to array remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -148,7 +142,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Registers a callback to receive performance events. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -171,7 +164,6 @@ inheritedMethods: Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window remarks: '' - isPreview: false isDeprecated: false syntax: content: function disableAccountStorageEvents() @@ -185,7 +177,6 @@ inheritedMethods: Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window remarks: '' - isPreview: false isDeprecated: false syntax: content: function enableAccountStorageEvents() @@ -200,7 +191,6 @@ inheritedMethods: (the account object is created at the time of successful login) or null when no matching account is found remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountByHomeId(homeAccountId: string): AccountInfo | null' @@ -222,7 +212,6 @@ inheritedMethods: (the account object is created at the time of successful login) or null when no matching account is found remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountByLocalId(localAccountId: string): AccountInfo | null' @@ -249,7 +238,6 @@ inheritedMethods: This API is provided for convenience but getAccountById should be used for best reliability remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountByUsername(userName: string): AccountInfo | null' @@ -268,7 +256,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Gets the currently active account remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getActiveAccount(): AccountInfo | null' @@ -286,7 +273,6 @@ inheritedMethods: (the account object is created at the time of successful login) or empty array when no accounts are found remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): AccountInfo[]' @@ -301,7 +287,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Returns the configuration object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getConfiguration(): BrowserConfiguration' @@ -316,7 +301,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -331,7 +315,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Gets the token cache for the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): ITokenCache' @@ -353,7 +336,6 @@ inheritedMethods: auth flows. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -381,7 +363,6 @@ inheritedMethods: Initializer function to perform async startup tasks such as connecting to WAM extension remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(): Promise' @@ -398,7 +379,6 @@ inheritedMethods: Called by wrapper libraries (Angular & React) to set SKU and Version passed down to telemetry, logger, etc. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' @@ -418,7 +398,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Deprecated logout function. Use logoutRedirect or logoutPopup instead remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -440,7 +419,6 @@ inheritedMethods: Clears local cache for the current user then opens a popup window prompting the user to sign-out of the server remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -466,7 +444,6 @@ inheritedMethods: Default behaviour is to redirect the user to `window.location.href`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -488,7 +465,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Removes callback with provided id from callback array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeEventCallback(callbackId: string)' @@ -505,7 +481,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Removes a callback registered with addPerformanceCallback. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -526,7 +501,6 @@ inheritedMethods: Sets the account to use as the active account. If no account is passed to the acquireToken APIs, then MSAL will use this active account. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setActiveAccount(account: AccountInfo | null)' @@ -545,7 +519,6 @@ inheritedMethods: Replaces the default logger set in configurations with new Logger with new configurations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' @@ -562,7 +535,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Sets navigation client remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setNavigationClient(navigationClient: INavigationClient)' @@ -598,7 +570,6 @@ inheritedMethods: you session on the server still exists. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -625,7 +596,6 @@ methods: Silently acquire an access token for a given set of scopes. Returns currently processing promise if parallel requests are made. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -648,7 +618,6 @@ methods: Use when initiating the login process via opening a popup window in the user's browser remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -680,7 +649,6 @@ methods: browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loginRedirect(request?: RedirectRequest): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml index 908161e..00f6b76 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: RedirectClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -64,7 +62,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Use to get the redirect uri configured in MSAL or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(requestRedirectUri?: string): string' @@ -84,7 +81,6 @@ methods: package: '@azure/msal-browser' summary: Redirects the page to the /authorize endpoint of the IDP remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function acquireToken(request: RedirectRequest): Promise' @@ -104,7 +100,6 @@ methods: - if true, performs logic to cache and navigate - if false, handles hash string and parses response remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -127,7 +122,6 @@ methods: Default behaviour is to redirect the user to `window.location.href`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(logoutRequest?: EndSessionRequest): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectHandler.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectHandler.yml index 76915fc..a4aa446 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectHandler.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectHandler.yml @@ -5,24 +5,23 @@ package: '@azure/msal-browser' summary: '' fullName: RedirectHandler remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: >- RedirectHandler(AuthorizationCodeClient, BrowserCacheManager, - CommonAuthorizationCodeRequest, Logger, ICrypto) + CommonAuthorizationCodeRequest, Logger, ICrypto, IPerformanceClient) uid: '@azure/msal-browser.RedirectHandler.constructor' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new RedirectHandler(authCodeModule: AuthorizationCodeClient, storageImpl: BrowserCacheManager, authCodeRequest: - CommonAuthorizationCodeRequest, logger: Logger, browserCrypto: ICrypto) + CommonAuthorizationCodeRequest, logger: Logger, browserCrypto: ICrypto, + performanceClient: IPerformanceClient) parameters: - id: authCodeModule type: AuthorizationCodeClient @@ -39,6 +38,9 @@ constructors: - id: browserCrypto type: ICrypto description: '' + - id: performanceClient + type: IPerformanceClient + description: '' inheritedMethods: - name: >- handleCodeResponseFromServer(AuthorizationCodePayload, string, Authority, @@ -47,7 +49,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Process auth code response from AAD remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -83,7 +84,6 @@ methods: package: '@azure/msal-browser' summary: Handle authorization code response in the window. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -111,7 +111,6 @@ methods: package: '@azure/msal-browser' summary: Redirects window to given URL. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectParams.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectParams.yml index d4f276f..7684731 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectParams.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectParams.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: RedirectParams remarks: '' -isPreview: false isDeprecated: false syntax: | type RedirectParams = InteractionParams & { diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml index b30bf4b..1ca9661 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml @@ -74,7 +74,6 @@ summary: > will navigate to. Returning false in the callback will stop navigation. fullName: RedirectRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type RedirectRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml index 6c32706..6b7fd57 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: SignedHttpRequest remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -33,7 +31,6 @@ methods: package: '@azure/msal-browser' summary: Generates and caches a keypair for the given request options. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generatePublicKeyThumbprint(): Promise' @@ -45,7 +42,6 @@ methods: package: '@azure/msal-browser' summary: Removes cached keys from browser for given public key thumbprint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeKeys(publicKeyThumbprint: string): Promise' @@ -61,7 +57,6 @@ methods: package: '@azure/msal-browser' summary: Generates a signed http request for the given payload with the given key. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml index f9ea20a..295321a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: SignedHttpRequestOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type SignedHttpRequestOptions = { loggerOptions: LoggerOptions } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml index df8bda2..f38ff5b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: SilentAuthCodeClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -63,7 +61,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Use to get the redirect uri configured in MSAL or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(requestRedirectUri?: string): string' @@ -85,7 +82,6 @@ methods: Acquires a token silently by redeeming an authorization code against the /token endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -104,7 +100,6 @@ methods: package: '@azure/msal-browser' summary: Currently Unsupported remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml index 9d2a09e..48d481f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: SilentCacheClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -60,7 +58,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Use to get the redirect uri configured in MSAL or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(requestRedirectUri?: string): string' @@ -80,7 +77,6 @@ methods: package: '@azure/msal-browser' summary: 'Returns unexpired tokens from the cache, if available' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -99,7 +95,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -120,7 +115,6 @@ methods: package: '@azure/msal-browser' summary: Currently Unsupported remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentHandler.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentHandler.yml deleted file mode 100644 index 40f460f..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentHandler.yml +++ /dev/null @@ -1,161 +0,0 @@ -### YamlMime:TSType -name: SilentHandler -uid: '@azure/msal-browser.SilentHandler' -package: '@azure/msal-browser' -summary: '' -fullName: SilentHandler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - SilentHandler(AuthorizationCodeClient, BrowserCacheManager, - CommonAuthorizationCodeRequest, Logger, - Required>) - uid: '@azure/msal-browser.SilentHandler.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new SilentHandler(authCodeModule: AuthorizationCodeClient, storageImpl: - BrowserCacheManager, authCodeRequest: CommonAuthorizationCodeRequest, - logger: Logger, systemOptions: Required>) - parameters: - - id: authCodeModule - type: AuthorizationCodeClient - description: '' - - id: storageImpl - type: - description: '' - - id: authCodeRequest - type: CommonAuthorizationCodeRequest - description: '' - - id: logger - type: Logger - description: '' - - id: systemOptions - type: >- - Required<Pick<, - "navigateFrameWait" | "pollIntervalMilliseconds">> - description: '' -inheritedMethods: - - name: 'handleCodeResponseFromHash(string, string, Authority, INetworkModule)' - uid: '@azure/msal-browser.SilentHandler.handleCodeResponseFromHash' - package: '@azure/msal-browser' - summary: Function to handle response parameters from hash. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleCodeResponseFromHash(locationHash: string, state: string, - authority: Authority, networkModule: INetworkModule): - Promise - parameters: - - id: locationHash - type: string - description: |+ - - - id: state - type: string - description: '' - - id: authority - type: Authority - description: '' - - id: networkModule - type: INetworkModule - description: '' - return: - description: '' - type: Promise<AuthenticationResult> - inheritanceDescription: >- - Inherited From - [InteractionHandler.handleCodeResponseFromHash](xref:@azure/msal-browser.InteractionHandler.handleCodeResponseFromHash) - - name: >- - handleCodeResponseFromServer(AuthorizationCodePayload, string, Authority, - INetworkModule, boolean) - uid: '@azure/msal-browser.SilentHandler.handleCodeResponseFromServer' - package: '@azure/msal-browser' - summary: Process auth code response from AAD - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleCodeResponseFromServer(authCodeResponse: - AuthorizationCodePayload, state: string, authority: Authority, - networkModule: INetworkModule, validateNonce?: boolean): - Promise - parameters: - - id: authCodeResponse - type: AuthorizationCodePayload - description: '' - - id: state - type: string - description: '' - - id: authority - type: Authority - description: '' - - id: networkModule - type: INetworkModule - description: '' - - id: validateNonce - type: boolean - description: '' - return: - description: '' - type: Promise<AuthenticationResult> - inheritanceDescription: >- - Inherited From - [InteractionHandler.handleCodeResponseFromServer](xref:@azure/msal-browser.InteractionHandler.handleCodeResponseFromServer) -methods: - - name: initiateAuthRequest(string) - uid: '@azure/msal-browser.SilentHandler.initiateAuthRequest' - package: '@azure/msal-browser' - summary: Creates a hidden iframe to given URL using user-requested scopes as an id. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function initiateAuthRequest(requestUrl: string): - Promise - parameters: - - id: requestUrl - type: string - description: '' - return: - description: '' - type: Promise<HTMLIFrameElement> - - name: 'monitorIframeForHash(HTMLIFrameElement, number)' - uid: '@azure/msal-browser.SilentHandler.monitorIframeForHash' - package: '@azure/msal-browser' - summary: >- - Monitors an iframe content window until it loads a url with a known hash, - or hits a specified timeout. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function monitorIframeForHash(iframe: HTMLIFrameElement, timeout: - number): Promise - parameters: - - id: iframe - type: HTMLIFrameElement - description: '' - - id: timeout - type: number - description: |+ - - return: - description: '' - type: Promise<string> -extends: diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml index 492a1c5..474c911 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: SilentIframeClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -67,7 +65,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Use to get the redirect uri configured in MSAL or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(requestRedirectUri?: string): string' @@ -89,7 +86,6 @@ methods: Acquires a token silently by opening a hidden iframe to the /authorize endpoint with prompt=none or prompt=no_session remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -108,7 +104,6 @@ methods: package: '@azure/msal-browser' summary: Currently Unsupported remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml index 2582385..3e68d51 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: SilentRefreshClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -17,7 +16,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -60,7 +58,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Use to get the redirect uri configured in MSAL or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(requestRedirectUri?: string): string' @@ -80,7 +77,6 @@ methods: package: '@azure/msal-browser' summary: Exchanges the refresh token for new tokens remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -99,7 +95,6 @@ methods: package: '@azure/msal-browser' summary: Currently Unsupported remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml index 71c3bfb..e55958c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml @@ -44,7 +44,6 @@ summary: > no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY. fullName: SilentRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type SilentRequest = Omit< diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml index a5b2b5d..64c72f0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml @@ -63,7 +63,6 @@ summary: > to mitigate replay attacks. fullName: SsoSilentRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type SsoSilentRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml index a9e721e..0ad2cdd 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml @@ -7,7 +7,6 @@ summary: >- non-brokered auth flows (popup, redirect, silent (RT), silent (iframe)) fullName: StandardInteractionClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -62,7 +60,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -86,7 +83,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: Use to get the redirect uri configured in MSAL or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(requestRedirectUri?: string): string' @@ -105,7 +101,6 @@ inheritedMethods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(request: EndSessionRequest): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/TemporaryCacheKeys.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/TemporaryCacheKeys.yml index d7ab3e1..c5e6eb0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/TemporaryCacheKeys.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/TemporaryCacheKeys.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: 'Temporary cache keys for MSAL, deleted after any request.' fullName: TemporaryCacheKeys remarks: '' -isPreview: false isDeprecated: false fields: - name: ACQUIRE_TOKEN_ACCOUNT @@ -40,6 +39,10 @@ fields: uid: '@azure/msal-browser.TemporaryCacheKeys.ORIGIN_URI' package: '@azure/msal-browser' summary: '' + - name: REDIRECT_CONTEXT + uid: '@azure/msal-browser.TemporaryCacheKeys.REDIRECT_CONTEXT' + package: '@azure/msal-browser' + summary: '' - name: RENEW_STATUS uid: '@azure/msal-browser.TemporaryCacheKeys.RENEW_STATUS' package: '@azure/msal-browser' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/TokenCache.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/TokenCache.yml index 97346cd..33d6cd1 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/TokenCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/TokenCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: Token cache manager fullName: TokenCache remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -40,7 +38,6 @@ properties: summary: '' fullName: isBrowserEnvironment remarks: '' - isPreview: false isDeprecated: false syntax: content: 'isBrowserEnvironment: boolean' @@ -53,7 +50,6 @@ methods: package: '@azure/msal-browser' summary: API to load tokens to msal-browser cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml index 012dac1..f1f9dce 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml @@ -5,7 +5,6 @@ package: '@azure/msal-browser' summary: '' fullName: WrapperSKU remarks: '' -isPreview: false isDeprecated: false fields: - name: Angular diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/XhrClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/XhrClient.yml deleted file mode 100644 index e23f543..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/XhrClient.yml +++ /dev/null @@ -1,53 +0,0 @@ -### YamlMime:TSType -name: XhrClient -uid: '@azure/msal-browser.XhrClient' -package: '@azure/msal-browser' -summary: This client implements the XMLHttpRequest class to send GET and POST requests. -fullName: XhrClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'sendGetRequestAsync(string, NetworkRequestOptions)' - uid: '@azure/msal-browser.XhrClient.sendGetRequestAsync' - package: '@azure/msal-browser' - summary: XhrClient for REST endpoints - Get request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendGetRequestAsync(url: string, options?: - NetworkRequestOptions): Promise> - parameters: - - id: url - type: string - description: '' - - id: options - type: NetworkRequestOptions - description: '' - return: - description: '' - type: Promise<NetworkResponse<T>> - - name: 'sendPostRequestAsync(string, NetworkRequestOptions)' - uid: '@azure/msal-browser.XhrClient.sendPostRequestAsync' - package: '@azure/msal-browser' - summary: XhrClient for REST endpoints - Post request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendPostRequestAsync(url: string, options?: - NetworkRequestOptions): Promise> - parameters: - - id: url - type: string - description: '' - - id: options - type: NetworkRequestOptions - description: '' - return: - description: '' - type: Promise<NetworkResponse<T>> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/index.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/index.yml index 65f25a9..e90519b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/index.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/index.yml @@ -7,30 +7,17 @@ classes: - '@azure/msal-browser.ClientApplication' - '@azure/msal-browser.PublicClientApplication' - '@azure/msal-browser.NativeMessageHandler' - - '@azure/msal-browser.AsyncMemoryStorage' - '@azure/msal-browser.BrowserCacheManager' - - '@azure/msal-browser.BrowserStorage' - - '@azure/msal-browser.CryptoKeyStore' - - '@azure/msal-browser.DatabaseStorage' - '@azure/msal-browser.MemoryStorage' - '@azure/msal-browser.TokenCache' - - '@azure/msal-browser.BrowserCrypto' - '@azure/msal-browser.CryptoOps' - - '@azure/msal-browser.GuidGenerator' - - '@azure/msal-browser.ModernBrowserCrypto' - - '@azure/msal-browser.MsBrowserCrypto' - - '@azure/msal-browser.MsrBrowserCrypto' - - '@azure/msal-browser.PkceGenerator' - '@azure/msal-browser.SignedHttpRequest' - - '@azure/msal-browser.Base64Decode' - - '@azure/msal-browser.Base64Encode' - '@azure/msal-browser.BrowserAuthError' - '@azure/msal-browser.BrowserConfigurationAuthError' - '@azure/msal-browser.NativeAuthError' - '@azure/msal-browser.EventHandler' - '@azure/msal-browser.EventMessageUtils' - '@azure/msal-browser.BaseInteractionClient' - - '@azure/msal-browser.HybridSpaAuthorizationCodeClient' - '@azure/msal-browser.NativeInteractionClient' - '@azure/msal-browser.PopupClient' - '@azure/msal-browser.RedirectClient' @@ -41,22 +28,15 @@ classes: - '@azure/msal-browser.StandardInteractionClient' - '@azure/msal-browser.InteractionHandler' - '@azure/msal-browser.RedirectHandler' - - '@azure/msal-browser.SilentHandler' - '@azure/msal-browser.NavigationClient' - - '@azure/msal-browser.FetchClient' - - '@azure/msal-browser.XhrClient' - '@azure/msal-browser.BrowserPerformanceClient' - '@azure/msal-browser.BrowserPerformanceMeasurement' - '@azure/msal-browser.BrowserProtocolUtils' - - '@azure/msal-browser.BrowserStringUtils' - '@azure/msal-browser.BrowserUtils' - - '@azure/msal-browser.MathUtils' interfaces: - '@azure/msal-browser.IPublicClientApplication' - - '@azure/msal-browser.IAsyncStorage' - '@azure/msal-browser.ITokenCache' - '@azure/msal-browser.IWindowStorage' - - '@azure/msal-browser.ISubtleCrypto' - '@azure/msal-browser.INavigationClient' typeAliases: - '@azure/msal-browser.NativeExtensionRequest' @@ -98,20 +78,6 @@ typeAliases: - '@azure/msal-browser.SilentRequest' - '@azure/msal-browser.SsoSilentRequest' - '@azure/msal-browser.BrowserStateObject' -enums: - - '@azure/msal-browser.CryptoKeyStoreNames' - - '@azure/msal-browser.NativeStatusCode' - - '@azure/msal-browser.EventType' - - '@azure/msal-browser.ApiId' - - '@azure/msal-browser.BrowserCacheLocation' - - '@azure/msal-browser.CacheLookupPolicy' - - '@azure/msal-browser.HTTP_REQUEST_TYPE' - - '@azure/msal-browser.InMemoryCacheKeys' - - '@azure/msal-browser.InteractionStatus' - - '@azure/msal-browser.InteractionType' - - '@azure/msal-browser.NativeExtensionMethod' - - '@azure/msal-browser.TemporaryCacheKeys' - - '@azure/msal-browser.WrapperSKU' functions: - name: >- buildConfiguration({ userInputAuth: { authority?: string, @@ -123,22 +89,21 @@ functions: skipAuthorityMetadataCache?: boolean }, userInputCache: { cacheLocation?: BrowserCacheLocation | string, secureCookies?: boolean, storeAuthStateInCookie?: boolean }, userInputSystem: { - preventCorsPreflight?: boolean, proxyUrl?: string, - tokenRenewalOffsetSeconds?: number } & { allowNativeBroker?: boolean, - allowRedirectInIframe?: boolean, asyncPopups?: boolean, cryptoOptions?: - CryptoOptions, iframeHashTimeout?: number, loadFrameTimeout?: number, - loggerOptions?: LoggerOptions, nativeBrokerHandshakeTimeout?: number, - navigateFrameWait?: number, navigationClient?: INavigationClient, - networkClient?: INetworkModule, pollIntervalMilliseconds?: number, - redirectNavigationTimeout?: number, windowHashTimeout?: number }, - userInputTelemetry: { application?: ApplicationTelemetry } }, boolean) + preventCorsPreflight?: boolean, tokenRenewalOffsetSeconds?: number } & { + allowNativeBroker?: boolean, allowRedirectInIframe?: boolean, + asyncPopups?: boolean, cryptoOptions?: CryptoOptions, iframeHashTimeout?: + number, loadFrameTimeout?: number, loggerOptions?: LoggerOptions, + nativeBrokerHandshakeTimeout?: number, navigateFrameWait?: number, + navigationClient?: INavigationClient, networkClient?: INetworkModule, + pollIntervalMilliseconds?: number, redirectNavigationTimeout?: number, + windowHashTimeout?: number }, userInputTelemetry: { application?: + ApplicationTelemetry } }, boolean) uid: '@azure/msal-browser.buildConfiguration' package: '@azure/msal-browser' summary: >- MSAL function that sets the default options when not explicitly configured from app developer remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -151,11 +116,11 @@ functions: skipAuthorityMetadataCache?: boolean }, userInputCache: { cacheLocation?: BrowserCacheLocation | string, secureCookies?: boolean, storeAuthStateInCookie?: boolean }, userInputSystem: { - preventCorsPreflight?: boolean, proxyUrl?: string, - tokenRenewalOffsetSeconds?: number } & { allowNativeBroker?: boolean, - allowRedirectInIframe?: boolean, asyncPopups?: boolean, cryptoOptions?: - CryptoOptions, iframeHashTimeout?: number, loadFrameTimeout?: number, - loggerOptions?: LoggerOptions, nativeBrokerHandshakeTimeout?: number, + preventCorsPreflight?: boolean, tokenRenewalOffsetSeconds?: number } & { + allowNativeBroker?: boolean, allowRedirectInIframe?: boolean, + asyncPopups?: boolean, cryptoOptions?: CryptoOptions, + iframeHashTimeout?: number, loadFrameTimeout?: number, loggerOptions?: + LoggerOptions, nativeBrokerHandshakeTimeout?: number, navigateFrameWait?: number, navigationClient?: INavigationClient, networkClient?: INetworkModule, pollIntervalMilliseconds?: number, redirectNavigationTimeout?: number, windowHashTimeout?: number }, @@ -173,16 +138,16 @@ functions: skipAuthorityMetadataCache?: boolean }, userInputCache: { cacheLocation?: BrowserCacheLocation | string, secureCookies?: boolean, storeAuthStateInCookie?: boolean }, userInputSystem: { - preventCorsPreflight?: boolean, proxyUrl?: string, - tokenRenewalOffsetSeconds?: number } & { allowNativeBroker?: - boolean, allowRedirectInIframe?: boolean, asyncPopups?: boolean, - cryptoOptions?: CryptoOptions, iframeHashTimeout?: number, - loadFrameTimeout?: number, loggerOptions?: LoggerOptions, - nativeBrokerHandshakeTimeout?: number, navigateFrameWait?: number, - navigationClient?: INavigationClient, networkClient?: - INetworkModule, pollIntervalMilliseconds?: number, - redirectNavigationTimeout?: number, windowHashTimeout?: number }, - userInputTelemetry: { application?: ApplicationTelemetry } } + preventCorsPreflight?: boolean, tokenRenewalOffsetSeconds?: number } + & { allowNativeBroker?: boolean, allowRedirectInIframe?: boolean, + asyncPopups?: boolean, cryptoOptions?: CryptoOptions, + iframeHashTimeout?: number, loadFrameTimeout?: number, + loggerOptions?: LoggerOptions, nativeBrokerHandshakeTimeout?: + number, navigateFrameWait?: number, navigationClient?: + INavigationClient, networkClient?: INetworkModule, + pollIntervalMilliseconds?: number, redirectNavigationTimeout?: + number, windowHashTimeout?: number }, userInputTelemetry: { + application?: ApplicationTelemetry } } description: '' - id: isBrowserEnvironment type: boolean @@ -190,3 +155,16 @@ functions: return: description: Configuration object type: +enums: + - '@azure/msal-browser.NativeStatusCode' + - '@azure/msal-browser.EventType' + - '@azure/msal-browser.ApiId' + - '@azure/msal-browser.BrowserCacheLocation' + - '@azure/msal-browser.CacheLookupPolicy' + - '@azure/msal-browser.HTTP_REQUEST_TYPE' + - '@azure/msal-browser.InMemoryCacheKeys' + - '@azure/msal-browser.InteractionStatus' + - '@azure/msal-browser.InteractionType' + - '@azure/msal-browser.NativeExtensionMethod' + - '@azure/msal-browser.TemporaryCacheKeys' + - '@azure/msal-browser.WrapperSKU' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml index 2ba7ffd..4cac8e8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: String constants related to AAD Authority fullName: AADAuthorityConstants remarks: '' -isPreview: false isDeprecated: false fields: - name: COMMON diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml index dc15f07..53542d8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Keys in the hashParams sent by AAD Server fullName: AADServerParamKeys remarks: '' -isPreview: false isDeprecated: false fields: - name: ACCESS_TOKEN diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenCache.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenCache.yml index dac45b2..036fc3b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: AccessTokenCache remarks: '' -isPreview: false isDeprecated: false syntax: | type AccessTokenCache = Record diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml index ee003f4..25a858c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml @@ -31,7 +31,6 @@ summary: > } fullName: AccessTokenEntity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -41,7 +40,6 @@ properties: summary: '' fullName: cachedAt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cachedAt: string' @@ -54,7 +52,6 @@ properties: summary: '' fullName: expiresOn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expiresOn: string' @@ -67,7 +64,6 @@ properties: summary: '' fullName: extendedExpiresOn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'extendedExpiresOn?: string' @@ -80,7 +76,6 @@ properties: summary: '' fullName: keyId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'keyId?: string' @@ -93,7 +88,6 @@ properties: summary: '' fullName: realm remarks: '' - isPreview: false isDeprecated: false syntax: content: 'realm: string' @@ -106,7 +100,6 @@ properties: summary: '' fullName: refreshOn remarks: '' - isPreview: false isDeprecated: false syntax: content: 'refreshOn?: string' @@ -119,7 +112,6 @@ properties: summary: '' fullName: requestedClaims remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestedClaims?: string' @@ -132,7 +124,6 @@ properties: summary: '' fullName: requestedClaimsHash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestedClaimsHash?: string' @@ -145,7 +136,6 @@ properties: summary: '' fullName: target remarks: '' - isPreview: false isDeprecated: false syntax: content: 'target: string' @@ -158,7 +148,6 @@ properties: summary: '' fullName: tokenType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenType?: AuthenticationScheme' @@ -172,7 +161,6 @@ inheritedProperties: summary: '' fullName: clientId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientId: string' @@ -188,7 +176,6 @@ inheritedProperties: summary: '' fullName: credentialType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'credentialType: CredentialType' @@ -204,7 +191,6 @@ inheritedProperties: summary: '' fullName: environment remarks: '' - isPreview: false isDeprecated: false syntax: content: 'environment: string' @@ -220,7 +206,6 @@ inheritedProperties: summary: '' fullName: familyId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'familyId?: string' @@ -236,7 +221,6 @@ inheritedProperties: summary: '' fullName: homeAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'homeAccountId: string' @@ -252,7 +236,6 @@ inheritedProperties: summary: '' fullName: secret remarks: '' - isPreview: false isDeprecated: false syntax: content: 'secret: string' @@ -268,7 +251,6 @@ inheritedProperties: summary: '' fullName: userAssertionHash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userAssertionHash?: string' @@ -286,7 +268,6 @@ inheritedMethods: Generate Account Id key component as per the schema: - remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAccountId(): string' @@ -306,7 +287,6 @@ inheritedMethods: -\----- remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -355,7 +335,6 @@ inheritedMethods: Generate Credential Id key component as per the schema: -- remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCredentialId(): string' @@ -370,7 +349,6 @@ inheritedMethods: package: '@azure/msal-common' summary: generates credential key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCredentialKey(): string' @@ -385,7 +363,6 @@ inheritedMethods: package: '@azure/msal-common' summary: 'Generate target key component as per schema: ' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateTarget(): string' @@ -400,7 +377,6 @@ inheritedMethods: package: '@azure/msal-common' summary: returns the type of the cache (in this case credential) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateType(): number' @@ -415,7 +391,6 @@ inheritedMethods: package: '@azure/msal-common' summary: helper function to return `CredentialType` remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function getCredentialType(key: string): string' @@ -439,7 +414,6 @@ methods: package: '@azure/msal-common' summary: Create AccessTokenEntity remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -505,7 +479,6 @@ methods: package: '@azure/msal-common' summary: 'Validates an entity: checks for all expected params' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function isAccessTokenEntity(entity: object): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AccountCache.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AccountCache.yml index a2d75f0..fdf22f2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AccountCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AccountCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: AccountCache remarks: '' -isPreview: false isDeprecated: false syntax: | type AccountCache = Record diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AccountEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AccountEntity.yml index 385edc4..030c120 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AccountEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AccountEntity.yml @@ -30,7 +30,6 @@ summary: > } fullName: AccountEntity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -40,7 +39,6 @@ properties: summary: '' fullName: authorityType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authorityType: string' @@ -53,7 +51,6 @@ properties: summary: '' fullName: clientInfo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientInfo?: string' @@ -66,7 +63,6 @@ properties: summary: '' fullName: cloudGraphHostName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cloudGraphHostName?: string' @@ -79,7 +75,6 @@ properties: summary: '' fullName: environment remarks: '' - isPreview: false isDeprecated: false syntax: content: 'environment: string' @@ -92,7 +87,6 @@ properties: summary: '' fullName: homeAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'homeAccountId: string' @@ -105,7 +99,6 @@ properties: summary: '' fullName: idTokenClaims remarks: '' - isPreview: false isDeprecated: false syntax: content: 'idTokenClaims?: TokenClaims' @@ -118,7 +111,6 @@ properties: summary: '' fullName: lastModificationApp remarks: '' - isPreview: false isDeprecated: false syntax: content: 'lastModificationApp?: string' @@ -131,7 +123,6 @@ properties: summary: '' fullName: lastModificationTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'lastModificationTime?: string' @@ -144,7 +135,6 @@ properties: summary: '' fullName: localAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'localAccountId: string' @@ -157,7 +147,6 @@ properties: summary: '' fullName: msGraphHost remarks: '' - isPreview: false isDeprecated: false syntax: content: 'msGraphHost?: string' @@ -170,7 +159,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name?: string' @@ -183,7 +171,6 @@ properties: summary: '' fullName: nativeAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'nativeAccountId?: string' @@ -196,7 +183,6 @@ properties: summary: '' fullName: realm remarks: '' - isPreview: false isDeprecated: false syntax: content: 'realm: string' @@ -209,7 +195,6 @@ properties: summary: '' fullName: username remarks: '' - isPreview: false isDeprecated: false syntax: content: 'username: string' @@ -224,7 +209,6 @@ methods: Helper function to determine whether 2 accountInfo objects represent the same account remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -254,7 +238,6 @@ methods: Build Account cache from IdToken, clientInfo and authority/policy. Associated with AAD. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -295,7 +278,6 @@ methods: package: '@azure/msal-common' summary: Builds non-AAD/ADFS account. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -330,7 +312,6 @@ methods: package: '@azure/msal-common' summary: Generates account key from interface remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -351,7 +332,6 @@ methods: Generate Account Id key component as per the schema: - remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAccountId(): string' @@ -365,7 +345,6 @@ methods: Generate Account Cache Key as per the schema: -- remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAccountKey(): string' @@ -377,7 +356,6 @@ methods: package: '@azure/msal-common' summary: Generate HomeAccountId from server response remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -409,7 +387,6 @@ methods: package: '@azure/msal-common' summary: returns the type of the cache (in this case account) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateType(): number' @@ -421,7 +398,6 @@ methods: package: '@azure/msal-common' summary: Returns the AccountInfo interface for this account. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountInfo(): AccountInfo' @@ -433,7 +409,6 @@ methods: package: '@azure/msal-common' summary: 'Validates an entity: checks for all expected params' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function isAccountEntity(entity: object): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AccountFilter.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AccountFilter.yml index d440253..4baa72c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AccountFilter.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AccountFilter.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: "Account:\t--" fullName: AccountFilter remarks: '' -isPreview: false isDeprecated: false syntax: | type AccountFilter = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AccountInfo.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AccountInfo.yml index eaace28..2da6238 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AccountInfo.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AccountInfo.yml @@ -31,7 +31,6 @@ summary: >- - nativeAccountId - The user's native account ID fullName: AccountInfo remarks: '' -isPreview: false isDeprecated: false syntax: >- type AccountInfo = { environment: string, homeAccountId: string, idToken?: diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml index 8a8df1d..0b2986f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ActiveAccountFilters remarks: '' -isPreview: false isDeprecated: false syntax: | type ActiveAccountFilters = { homeAccountId: string, localAccountId: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataCache.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataCache.yml index 29c7b63..aca197f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: AppMetadataCache remarks: '' -isPreview: false isDeprecated: false syntax: | type AppMetadataCache = Record diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml index 7fd8c09..6f4042c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml @@ -16,7 +16,6 @@ summary: | } fullName: AppMetadataEntity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -26,7 +25,6 @@ properties: summary: '' fullName: clientId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientId: string' @@ -39,7 +37,6 @@ properties: summary: '' fullName: environment remarks: '' - isPreview: false isDeprecated: false syntax: content: 'environment: string' @@ -52,7 +49,6 @@ properties: summary: '' fullName: familyId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'familyId?: string' @@ -65,7 +61,6 @@ methods: package: '@azure/msal-common' summary: Creates AppMetadataEntity remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -90,7 +85,6 @@ methods: package: '@azure/msal-common' summary: Generate AppMetadata Cache Key remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -113,7 +107,6 @@ methods: Generate AppMetadata Cache Key as per the schema: appmetadata-- remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAppMetadataKey(): string' @@ -125,7 +118,6 @@ methods: package: '@azure/msal-common' summary: 'Validates an entity: checks for all expected params' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataFilter.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataFilter.yml index e48c4bf..d2a42c5 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataFilter.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AppMetadataFilter.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: 'AppMetadata: appmetadata--' fullName: AppMetadataFilter remarks: '' -isPreview: false isDeprecated: false syntax: | type AppMetadataFilter = { clientId?: string, environment?: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml index 2588e04..05da318 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml @@ -17,7 +17,6 @@ summary: > - claims - any extra claims that the token must satisfy fullName: AppTokenProviderParameters remarks: '' -isPreview: false isDeprecated: false syntax: | type AppTokenProviderParameters = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml index 1f5e4ae..19f41ca 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml @@ -16,7 +16,6 @@ summary: > response. fullName: AppTokenProviderResult remarks: '' -isPreview: false isDeprecated: false syntax: | type AppTokenProviderResult = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ApplicationTelemetry.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ApplicationTelemetry.yml index 313a3df..ccabe03 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ApplicationTelemetry.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ApplicationTelemetry.yml @@ -8,7 +8,6 @@ summary: |- - appVersion: Version of the application using MSAL fullName: ApplicationTelemetry remarks: '' -isPreview: false isDeprecated: false syntax: | type ApplicationTelemetry = { appName: string, appVersion: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthError.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthError.yml index 4d96c1a..65d2098 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthError.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: General error class thrown by the MSAL.js library. fullName: AuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,7 +35,6 @@ properties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -50,7 +47,6 @@ properties: summary: '' fullName: Error remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static Error: ErrorConstructor' @@ -63,7 +59,6 @@ properties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -76,7 +71,6 @@ properties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -89,7 +83,6 @@ properties: summary: Describes the subclass of an error fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -103,7 +96,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -117,7 +109,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -131,7 +122,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -145,7 +135,6 @@ methods: package: '@azure/msal-common' summary: Creates an error for post request failures. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createPostRequestFailed(errDesc: string): AuthError' @@ -163,7 +152,6 @@ methods: Creates an error that is thrown when something unexpected happens in the library. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -180,7 +168,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthOptions.yml index 50cb0ac..c164605 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthOptions.yml @@ -29,7 +29,6 @@ summary: > the local metadata cache during authority initialization. Defaults to false. fullName: AuthOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthToken.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthToken.yml index a18a0da..41f0b8c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthToken.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthToken.yml @@ -7,7 +7,6 @@ summary: >- object. fullName: AuthToken remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AuthToken(rawToken: string, crypto: ICrypto)' @@ -34,7 +32,6 @@ properties: summary: '' fullName: claims remarks: '' - isPreview: false isDeprecated: false syntax: content: 'claims: TokenClaims' @@ -47,7 +44,6 @@ properties: summary: '' fullName: rawToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'rawToken: string' @@ -60,7 +56,6 @@ methods: package: '@azure/msal-common' summary: Determine if the token's max_age has transpired remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function checkMaxAge(authTime: number, maxAge: number)' @@ -76,7 +71,6 @@ methods: package: '@azure/msal-common' summary: Extract token by decoding the rawToken remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml index 4d3b4a3..ef439ad 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml @@ -10,7 +10,6 @@ summary: >- flows. fullName: AuthenticationHeaderParser remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AuthenticationHeaderParser(headers: Record)' @@ -35,7 +33,6 @@ methods: This method parses the SHR nonce value out of either the Authentication-Info or WWW-Authenticate authentication headers. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getShrNonce(): string' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml index 083af98..c255501 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml @@ -37,7 +37,6 @@ summary: >- - requestId - Request ID returned as part of the response fullName: AuthenticationResult remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthenticationResult = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml index 69f88a0..ea37269 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Type of the authentication request fullName: AuthenticationScheme remarks: '' -isPreview: false isDeprecated: false fields: - name: BEARER diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/Authority.yml b/nodejs/docs-ref-autogen/@azure/msal-common/Authority.yml index 9d586e2..15054e1 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/Authority.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/Authority.yml @@ -10,24 +10,22 @@ summary: >- during token calls. fullName: Authority remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: >- Authority(string, INetworkModule, ICacheManager, AuthorityOptions, Logger, - string) + IPerformanceClient, string) uid: '@azure/msal-common.Authority.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new Authority(authority: string, networkInterface: INetworkModule, cacheManager: ICacheManager, authorityOptions: AuthorityOptions, logger: - Logger, proxyUrl?: string) + Logger, performanceClient?: IPerformanceClient, correlationId?: string) parameters: - id: authority type: string @@ -44,7 +42,10 @@ constructors: - id: logger type: description: '' - - id: proxyUrl + - id: performanceClient + type: + description: '' + - id: correlationId type: string description: '' properties: @@ -54,7 +55,6 @@ properties: summary: '' fullName: authorityType remarks: '' - isPreview: false isDeprecated: false syntax: content: AuthorityType authorityType @@ -67,7 +67,6 @@ properties: summary: OAuth /authorize endpoint for requests fullName: authorizationEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: string authorizationEndpoint @@ -82,7 +81,6 @@ properties: Sets canonical authority. fullName: canonicalAuthority remarks: '' - isPreview: false isDeprecated: false syntax: content: string canonicalAuthority @@ -95,7 +93,6 @@ properties: summary: Get authority components. fullName: canonicalAuthorityUrlComponents remarks: '' - isPreview: false isDeprecated: false syntax: content: IUri canonicalAuthorityUrlComponents @@ -108,7 +105,6 @@ properties: summary: '' fullName: deviceCodeEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: string deviceCodeEndpoint @@ -121,7 +117,6 @@ properties: summary: OAuth logout endpoint for requests fullName: endSessionEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: string endSessionEndpoint @@ -134,7 +129,6 @@ properties: summary: Get hostname and port i.e. login.microsoftonline.com fullName: hostnameAndPort remarks: '' - isPreview: false isDeprecated: false syntax: content: string hostnameAndPort @@ -147,7 +141,6 @@ properties: summary: Jwks_uri for token signing keys fullName: jwksUri remarks: '' - isPreview: false isDeprecated: false syntax: content: string jwksUri @@ -162,7 +155,6 @@ properties: authority instance fullName: options remarks: '' - isPreview: false isDeprecated: false syntax: content: AuthorityOptions options @@ -175,7 +167,6 @@ properties: summary: ProtocolMode enum representing the way endpoints are constructed. fullName: protocolMode remarks: '' - isPreview: false isDeprecated: false syntax: content: ProtocolMode protocolMode @@ -188,7 +179,6 @@ properties: summary: '' fullName: regionDiscoveryMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'regionDiscoveryMetadata: RegionDiscoveryMetadata' @@ -201,7 +191,6 @@ properties: summary: OAuth issuer for requests fullName: selfSignedJwtAudience remarks: '' - isPreview: false isDeprecated: false syntax: content: string selfSignedJwtAudience @@ -214,7 +203,6 @@ properties: summary: Get tenant for authority. fullName: tenant remarks: '' - isPreview: false isDeprecated: false syntax: content: string tenant @@ -227,7 +215,6 @@ properties: summary: OAuth /token endpoint for requests fullName: tokenEndpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: string tokenEndpoint @@ -240,7 +227,6 @@ methods: package: '@azure/msal-common' summary: Rebuild the authority string with the region remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -265,7 +251,6 @@ methods: package: '@azure/msal-common' summary: Creates cloud discovery metadata object from a given host remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -284,7 +269,6 @@ methods: package: '@azure/msal-common' summary: Boolean that returns whethr or not tenant discovery has been completed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function discoveryComplete(): boolean' @@ -296,7 +280,6 @@ methods: package: '@azure/msal-common' summary: helper function to populate the authority based on azureCloudOptions remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -322,7 +305,6 @@ methods: Searches instance discovery network response for the entry that contains the host in the aliases list remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -345,7 +327,6 @@ methods: package: '@azure/msal-common' summary: helper function to generate environment from authority object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getPreferredCache(): string' @@ -359,7 +340,6 @@ methods: Returns whether or not the provided host is an alias of this authority instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isAlias(host: string): boolean' @@ -376,7 +356,6 @@ methods: package: '@azure/msal-common' summary: Checks whether the provided host is that of a public cloud authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function isPublicCloudAuthority(host: string): boolean' @@ -394,7 +373,6 @@ methods: Replace the endpoints in the metadata object with their regional equivalents. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -420,7 +398,6 @@ methods: and the /authorize, /token and logout endpoints. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function resolveEndpointsAsync(): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml index 67c5020..0882031 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml @@ -5,13 +5,12 @@ package: '@azure/msal-common' summary: '' fullName: AuthorityFactory remarks: '' -isPreview: false isDeprecated: false type: class methods: - name: >- createDiscoveredInstance(string, INetworkModule, ICacheManager, - AuthorityOptions, Logger, string) + AuthorityOptions, Logger, IPerformanceClient, string) uid: '@azure/msal-common.AuthorityFactory.createDiscoveredInstance' package: '@azure/msal-common' summary: > @@ -22,14 +21,13 @@ methods: Also performs endpoint discovery. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function createDiscoveredInstance(authorityUri: string, networkClient: INetworkModule, cacheManager: ICacheManager, - authorityOptions: AuthorityOptions, logger: Logger, proxyUrl?: string): - Promise + authorityOptions: AuthorityOptions, logger: Logger, performanceClient?: + IPerformanceClient, correlationId?: string): Promise parameters: - id: authorityUri type: string @@ -46,7 +44,10 @@ methods: - id: logger type: description: '' - - id: proxyUrl + - id: performanceClient + type: + description: '' + - id: correlationId type: string description: '' return: @@ -54,7 +55,7 @@ methods: type: Promise<> - name: >- createInstance(string, INetworkModule, ICacheManager, AuthorityOptions, - Logger, string) + Logger, IPerformanceClient, string) uid: '@azure/msal-common.AuthorityFactory.createInstance' package: '@azure/msal-common' summary: > @@ -65,13 +66,13 @@ methods: Does not perform endpoint discovery. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function createInstance(authorityUrl: string, networkInterface: INetworkModule, cacheManager: ICacheManager, authorityOptions: - AuthorityOptions, logger: Logger, proxyUrl?: string): Authority + AuthorityOptions, logger: Logger, performanceClient?: + IPerformanceClient, correlationId?: string): Authority parameters: - id: authorityUrl type: string @@ -88,7 +89,10 @@ methods: - id: logger type: description: '' - - id: proxyUrl + - id: performanceClient + type: + description: '' + - id: correlationId type: string description: '' return: diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityMetadataEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityMetadataEntity.yml index 22d91fc..433f400 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityMetadataEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityMetadataEntity.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: AuthorityMetadataEntity remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: new AuthorityMetadataEntity() @@ -25,7 +23,6 @@ properties: summary: '' fullName: aliases remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aliases: Array' @@ -38,7 +35,6 @@ properties: summary: '' fullName: aliasesFromNetwork remarks: '' - isPreview: false isDeprecated: false syntax: content: 'aliasesFromNetwork: boolean' @@ -51,7 +47,6 @@ properties: summary: '' fullName: authorization_endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authorization_endpoint: string' @@ -64,7 +59,6 @@ properties: summary: '' fullName: canonical_authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'canonical_authority: string' @@ -77,7 +71,6 @@ properties: summary: '' fullName: endpointsFromNetwork remarks: '' - isPreview: false isDeprecated: false syntax: content: 'endpointsFromNetwork: boolean' @@ -90,7 +83,6 @@ properties: summary: '' fullName: end_session_endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'end_session_endpoint?: string' @@ -103,7 +95,6 @@ properties: summary: '' fullName: expiresAt remarks: '' - isPreview: false isDeprecated: false syntax: content: 'expiresAt: number' @@ -116,7 +107,6 @@ properties: summary: '' fullName: issuer remarks: '' - isPreview: false isDeprecated: false syntax: content: 'issuer: string' @@ -129,7 +119,6 @@ properties: summary: '' fullName: jwks_uri remarks: '' - isPreview: false isDeprecated: false syntax: content: 'jwks_uri: string' @@ -142,7 +131,6 @@ properties: summary: '' fullName: preferred_cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'preferred_cache: string' @@ -155,7 +143,6 @@ properties: summary: '' fullName: preferred_network remarks: '' - isPreview: false isDeprecated: false syntax: content: 'preferred_network: string' @@ -168,7 +155,6 @@ properties: summary: '' fullName: token_endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'token_endpoint: string' @@ -181,7 +167,6 @@ methods: package: '@azure/msal-common' summary: 'Validates an entity: checks for all expected params' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -203,7 +188,6 @@ methods: package: '@azure/msal-common' summary: Returns whether or not the data needs to be refreshed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isExpired(): boolean' @@ -215,7 +199,6 @@ methods: package: '@azure/msal-common' summary: Reset the exiresAt value remarks: '' - isPreview: false isDeprecated: false syntax: content: function resetExpiresAt() @@ -224,7 +207,6 @@ methods: package: '@azure/msal-common' summary: Save the authority that was used to create this cache entry remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateCanonicalAuthority(authority: string)' @@ -240,7 +222,6 @@ methods: Update the entity with new aliases, preferred_cache and preferred_network values remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -259,7 +240,6 @@ methods: package: '@azure/msal-common' summary: Update the entity with new endpoints remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityMetadataSource.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityMetadataSource.yml index 0ef8322..f56146f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityMetadataSource.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityMetadataSource.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: AuthorityMetadataSource remarks: '' -isPreview: false isDeprecated: false fields: - name: CACHE diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml index 87b153d..fe34cc4 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: AuthorityOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthorityOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityType.yml index 0dcf8a3..efc591a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Authority types supported by MSAL. fullName: AuthorityType remarks: '' -isPreview: false isDeprecated: false fields: - name: Default diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorizationCodeClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorizationCodeClient.yml index 5c3a1f2..63d6fc7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorizationCodeClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorizationCodeClient.yml @@ -5,23 +5,26 @@ package: '@azure/msal-common' summary: Oauth2.0 Authorization Code client fullName: AuthorizationCodeClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: AuthorizationCodeClient(ClientConfiguration) + - name: 'AuthorizationCodeClient(ClientConfiguration, IPerformanceClient)' uid: '@azure/msal-common.AuthorizationCodeClient.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new AuthorizationCodeClient(configuration: ClientConfiguration)' + content: >- + new AuthorizationCodeClient(configuration: ClientConfiguration, + performanceClient?: IPerformanceClient) parameters: - id: configuration type: description: '' + - id: performanceClient + type: + description: '' inheritedProperties: - name: authority uid: '@azure/msal-common.AuthorizationCodeClient.authority' @@ -29,7 +32,6 @@ inheritedProperties: summary: '' fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: Authority' @@ -45,7 +47,6 @@ inheritedProperties: summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' @@ -56,6 +57,25 @@ inheritedProperties: Inherited From [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-common.AuthorizationCodeClient.createTokenQueryParameters' + package: '@azure/msal-common' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: |+ + + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseClient.createTokenQueryParameters](xref:@azure/msal-common.BaseClient.createTokenQueryParameters) - name: updateAuthority(Authority) uid: '@azure/msal-common.AuthorizationCodeClient.updateAuthority' package: '@azure/msal-common' @@ -63,7 +83,6 @@ inheritedMethods: Updates the authority object of the client. Endpoint discovery must be completed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateAuthority(updatedAuthority: Authority)' @@ -85,7 +104,6 @@ methods: authorization_code_grant remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -123,7 +141,6 @@ methods: acquireToken(AuthorizationCodeRequest) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -146,7 +163,6 @@ methods: Default behaviour is to redirect the user to `window.location.href`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogoutUri(logoutRequest: CommonEndSessionRequest): string' @@ -166,7 +182,6 @@ methods: the client to exchange for a token in acquireToken. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml index f524222..bfde839 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Response returned after processing the code response query string or fragment. fullName: AuthorizationCodePayload remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthorizationCodePayload = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml index 34d4b64..c683e91 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: AzureCloudInstance remarks: '' -isPreview: false isDeprecated: false fields: - name: AzureChina diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml index e482abf..090804a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml @@ -11,7 +11,6 @@ summary: > - tenant - provision to provide the tenant info fullName: AzureCloudOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type AzureCloudOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AzureRegion.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AzureRegion.yml index 084244b..c5cb5a0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AzureRegion.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AzureRegion.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: AzureRegion remarks: '' -isPreview: false isDeprecated: false syntax: | type AzureRegion = string diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml index 432d409..1ccb1aa 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: AzureRegionConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type AzureRegionConfiguration = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml index a3f60fe..d9c2a3c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml @@ -47,9 +47,11 @@ summary: >- - requestedClaimsHash - SHA 256 hash string of the requested claims string, used as part of an access token cache key so tokens can be filtered by requested claims + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call fullName: BaseAuthRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type BaseAuthRequest = { @@ -67,4 +69,5 @@ syntax: | shrNonce?: string, sshJwk?: string, sshKid?: string, + tokenQueryParameters?: StringDict, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/BaseClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/BaseClient.yml index d7544c4..8c5ef69 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/BaseClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/BaseClient.yml @@ -7,7 +7,6 @@ summary: >- responses from the Microsoft STS using the authorization code flow. fullName: BaseClient remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -17,7 +16,6 @@ properties: summary: '' fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: Authority' @@ -30,7 +28,6 @@ properties: summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' @@ -38,6 +35,22 @@ properties: description: '' type: methods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-common.BaseClient.createTokenQueryParameters' + package: '@azure/msal-common' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: |+ + + return: + description: '' + type: string - name: updateAuthority(Authority) uid: '@azure/msal-common.BaseClient.updateAuthority' package: '@azure/msal-common' @@ -45,7 +58,6 @@ methods: Updates the authority object of the client. Endpoint discovery must be completed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateAuthority(updatedAuthority: Authority)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml index e986251..a5a3d4b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Account types in Cache fullName: CacheAccountType remarks: '' -isPreview: false isDeprecated: false fields: - name: ADFS_ACCOUNT_TYPE diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheManager.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheManager.yml index b153785..09ebe64 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CacheManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CacheManager.yml @@ -7,7 +7,6 @@ summary: >- perform validity checks, and store tokens. fullName: CacheManager remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new CacheManager(clientId: string, cryptoImpl: ICrypto)' @@ -33,7 +31,6 @@ methods: package: '@azure/msal-common' summary: Function which clears cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function clear(): Promise' @@ -45,7 +42,6 @@ methods: package: '@azure/msal-common' summary: Function which returns boolean whether cache contains a specific key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function containsKey(key: string, type?: string): boolean' @@ -65,7 +61,6 @@ methods: package: '@azure/msal-common' summary: returns cache key used for cloud instance metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAuthorityMetadataCacheKey(authority: string): string' @@ -81,7 +76,6 @@ methods: package: '@azure/msal-common' summary: fetch the idToken entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -102,7 +96,6 @@ methods: fetch the account entity from the platform cache @param accountKey remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccount(accountKey: string): AccountEntity | null' @@ -123,7 +116,6 @@ methods: not checking for casing as keys are all generated in lower case, remember to convert to lower case if object properties are compared remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -141,7 +133,6 @@ methods: package: '@azure/msal-common' summary: Returns all accounts in cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): AccountInfo[]' @@ -153,7 +144,6 @@ methods: package: '@azure/msal-common' summary: fetch appMetadata entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -174,7 +164,6 @@ methods: retrieve appMetadata matching all provided filters; if no filter is set, get all appMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -193,7 +182,6 @@ methods: package: '@azure/msal-common' summary: fetch cloud discovery metadata entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -212,7 +200,6 @@ methods: package: '@azure/msal-common' summary: retrieve authorityMetadata that contains a matching alias remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -230,7 +217,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAuthorityMetadataKeys(): Array' @@ -244,7 +230,6 @@ methods: retrieve credentails matching all provided filters; if no filter is set, get all credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -262,7 +247,6 @@ methods: package: '@azure/msal-common' summary: fetch the idToken entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getIdTokenCredential(idTokenKey: string): IdTokenEntity | null' @@ -279,7 +263,6 @@ methods: package: '@azure/msal-common' summary: Function which retrieves all current keys from the cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKeys(): string[]' @@ -291,7 +274,6 @@ methods: package: '@azure/msal-common' summary: fetch the idToken entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -310,7 +292,6 @@ methods: package: '@azure/msal-common' summary: fetch server telemetry entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -329,7 +310,6 @@ methods: package: '@azure/msal-common' summary: fetch throttling entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -348,7 +328,6 @@ methods: package: '@azure/msal-common' summary: Return the family_id value associated with FOCI remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -370,7 +349,6 @@ methods: package: '@azure/msal-common' summary: Retrieve AccessTokenEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -394,7 +372,6 @@ methods: package: '@azure/msal-common' summary: Retrieve AccountEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -413,7 +390,6 @@ methods: package: '@azure/msal-common' summary: Retrieve AccountEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -431,7 +407,6 @@ methods: package: '@azure/msal-common' summary: Retrieve AppMetadataEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -452,7 +427,6 @@ methods: package: '@azure/msal-common' summary: Retrieve the cached credentials into a cacherecord remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -479,7 +453,6 @@ methods: package: '@azure/msal-common' summary: Retrieve IdTokenEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -500,7 +473,6 @@ methods: package: '@azure/msal-common' summary: Helper to retrieve the appropriate refresh token from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -525,7 +497,6 @@ methods: package: '@azure/msal-common' summary: returns a boolean if the given account is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccount(accountKey: string): Promise' @@ -541,7 +512,6 @@ methods: package: '@azure/msal-common' summary: Removes credentials associated with the provided account remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccountContext(account: AccountEntity): Promise' @@ -558,7 +528,6 @@ methods: package: '@azure/msal-common' summary: Removes all accounts and related tokens from cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAllAccounts(): Promise' @@ -570,7 +539,6 @@ methods: package: '@azure/msal-common' summary: Removes all app metadata objects from cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAppMetadata(): boolean' @@ -582,7 +550,6 @@ methods: package: '@azure/msal-common' summary: returns a boolean if the given credential is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -601,7 +568,6 @@ methods: package: '@azure/msal-common' summary: Function to remove an item from cache given its key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeItem(key: string, type?: string): boolean' @@ -621,7 +587,6 @@ methods: package: '@azure/msal-common' summary: saves a cache record remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' @@ -638,7 +603,6 @@ methods: package: '@azure/msal-common' summary: set idToken entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' @@ -652,7 +616,6 @@ methods: package: '@azure/msal-common' summary: set account entity in the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAccount(account: AccountEntity)' @@ -666,7 +629,6 @@ methods: package: '@azure/msal-common' summary: set appMetadata entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' @@ -680,7 +642,6 @@ methods: package: '@azure/msal-common' summary: set cloud discovery metadata entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -699,7 +660,6 @@ methods: package: '@azure/msal-common' summary: set idToken entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setIdTokenCredential(idToken: IdTokenEntity)' @@ -713,7 +673,6 @@ methods: package: '@azure/msal-common' summary: set idToken entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)' @@ -727,7 +686,6 @@ methods: package: '@azure/msal-common' summary: set server telemetry entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -746,7 +704,6 @@ methods: package: '@azure/msal-common' summary: set throttling entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -765,7 +722,6 @@ methods: package: '@azure/msal-common' summary: Helper to convert serialized data to object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function toObject(obj: T, json: object): T' @@ -785,7 +741,6 @@ methods: package: '@azure/msal-common' summary: Function which updates an outdated credential cache key remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml index 5a607d0..dd6aad9 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: CacheOutcome remarks: '' -isPreview: false isDeprecated: false fields: - name: CACHED_ACCESS_TOKEN_EXPIRED diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheRecord.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheRecord.yml index 713bd22..e45f525 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CacheRecord.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CacheRecord.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: CacheRecord remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -47,7 +45,6 @@ properties: summary: '' fullName: accessToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'accessToken: AccessTokenEntity | null' @@ -60,7 +57,6 @@ properties: summary: '' fullName: account remarks: '' - isPreview: false isDeprecated: false syntax: content: 'account: AccountEntity | null' @@ -73,7 +69,6 @@ properties: summary: '' fullName: appMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'appMetadata: AppMetadataEntity | null' @@ -86,7 +81,6 @@ properties: summary: '' fullName: idToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'idToken: IdTokenEntity | null' @@ -99,7 +93,6 @@ properties: summary: '' fullName: refreshToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'refreshToken: RefreshTokenEntity | null' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml index 84ec08b..1121152 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Credential Type stored in the cache fullName: CacheSchemaType remarks: '' -isPreview: false isDeprecated: false fields: - name: ACCESS_TOKEN diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheType.yml index a7377bb..614cdd2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CacheType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CacheType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Combine all cache types fullName: CacheType remarks: '' -isPreview: false isDeprecated: false fields: - name: ADFS diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CcsCredential.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CcsCredential.yml index c52c799..dd91437 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CcsCredential.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CcsCredential.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: CcsCredential remarks: '' -isPreview: false isDeprecated: false syntax: | type CcsCredential = { credential: string, type: CcsCredentialType } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml index 79069e2..8abfc29 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: CcsCredentialType remarks: '' -isPreview: false isDeprecated: false fields: - name: HOME_ACCOUNT_ID diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml index 55d2f6b..28bd1bd 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Claims request keys fullName: ClaimsRequestKeys remarks: '' -isPreview: false isDeprecated: false fields: - name: ACCESS_TOKEN diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml index c6c31c0..6e9b662 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Client Assertion credential for Confidential Clients fullName: ClientAssertion remarks: '' -isPreview: false isDeprecated: false syntax: | type ClientAssertion = { assertion: string, assertionType: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml index b495806..b678eaa 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Error thrown when there is an error in the client code running on the browser. fullName: ClientAuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ClientAuthError(errorCode: string, errorMessage?: string)' @@ -32,7 +30,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -48,7 +45,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -64,7 +60,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -80,7 +75,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -94,7 +88,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -108,7 +101,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -122,7 +114,6 @@ inheritedProperties: summary: Describes the subclass of an error fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -138,7 +129,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error for post request failures. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createPostRequestFailed(errDesc: string): AuthError' @@ -159,7 +149,6 @@ inheritedMethods: Creates an error that is thrown when something unexpected happens in the library. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -179,7 +168,6 @@ inheritedMethods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -198,7 +186,6 @@ methods: Throws error when attempting to append a null, undefined or empty scope to a set remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -217,7 +204,6 @@ methods: package: '@azure/msal-common' summary: Throws error when attempting to append null or empty ScopeSet. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -238,7 +224,6 @@ methods: Creates an error thrown when max_age was provided in the request, but auth_time is not in the token claims remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createAuthTimeNotFoundError(): ClientAuthError' @@ -250,7 +235,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createBindingKeyNotRemovedError(): ClientAuthError' @@ -262,7 +246,6 @@ methods: package: '@azure/msal-common' summary: Throws error if ICachePlugin not set on CacheManager. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createCachePluginError(): ClientAuthError' @@ -274,7 +257,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when client info object doesn't decode correctly. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -293,7 +275,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown if the client info is empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createClientInfoEmptyError(): ClientAuthError' @@ -307,7 +288,6 @@ methods: Throws error if user sets CancellationToken.cancel = true during polling of token endpoint during device code flow remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createDeviceCodeCancelledError(): ClientAuthError' @@ -319,7 +299,6 @@ methods: package: '@azure/msal-common' summary: Throws error if device code is expired remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createDeviceCodeExpiredError(): ClientAuthError' @@ -331,7 +310,6 @@ methods: package: '@azure/msal-common' summary: Throws error if device code is expired remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createDeviceCodeUnknownError(): ClientAuthError' @@ -343,7 +321,6 @@ methods: package: '@azure/msal-common' summary: Throws error if ScopeSet is null or undefined. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createEmptyInputScopeSetError(): ClientAuthError' @@ -357,7 +334,6 @@ methods: Creates an error thrown when the endpoint discovery doesn't complete correctly. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -375,7 +351,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when the hash cannot be deserialized. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -394,7 +369,6 @@ methods: package: '@azure/msal-common' summary: Throws error if client assertion is not valid. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidAssertionError(): ClientAuthError' @@ -408,7 +382,6 @@ methods: Throws error when provided environment is not part of the CloudDiscoveryMetadata object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidCacheEnvironmentError(): ClientAuthError' @@ -420,7 +393,6 @@ methods: package: '@azure/msal-common' summary: Throws error if cache type is invalid. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidCacheTypeError(): ClientAuthError' @@ -432,7 +404,6 @@ methods: package: '@azure/msal-common' summary: Throws error if client assertion is not valid. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidCredentialError(): ClientAuthError' @@ -444,7 +415,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when the state cannot be parsed. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -468,7 +438,6 @@ methods: Create an error when kid attribute is missing from a PoP token's cache record remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createKeyIdMissingError(): ClientAuthError' @@ -482,7 +451,6 @@ methods: Thrown when logout is attempted for an authority that doesnt have an end_session_endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createLogoutNotSupportedError(): ClientAuthError' @@ -496,7 +464,6 @@ methods: Creates an error thrown when too much time has elapsed since the last end-user authentication remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createMaxAgeTranspiredError(): ClientAuthError' @@ -509,7 +476,6 @@ methods: package: '@azure/msal-common' summary: Throws error when multiple accounts are in cache for the given params remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -524,7 +490,6 @@ methods: package: '@azure/msal-common' summary: Throws error when multiple appMetada are in cache for the given clientId. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -539,7 +504,6 @@ methods: package: '@azure/msal-common' summary: Throws error when multiple tokens are in cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -553,7 +517,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when the fetch client throws remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -574,7 +537,6 @@ methods: package: '@azure/msal-common' summary: Throws error when account is not found in cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoAccountFoundError(): ClientAuthError' @@ -586,7 +548,6 @@ methods: package: '@azure/msal-common' summary: Throws error when silent requests are made without an account object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoAccountInSilentRequestError(): ClientAuthError' @@ -600,7 +561,6 @@ methods: Throws error when the authorization code is missing from the server response remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoAuthCodeInServerResponseError(): ClientAuthError' @@ -612,7 +572,6 @@ methods: package: '@azure/msal-common' summary: Throws error if crypto object not found. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -631,7 +590,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when the nonce does not match. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNonceMismatchError(): ClientAuthError' @@ -643,7 +601,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when the mnonce is not present remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -654,6 +611,17 @@ methods: type: string description: |+ + return: + description: '' + type: + - name: createNoNetworkConnectivityError() + uid: '@azure/msal-common.ClientAuthError.createNoNetworkConnectivityError' + package: '@azure/msal-common' + summary: Create an error when the client does not have network connectivity + remarks: '' + isDeprecated: false + syntax: + content: 'static function createNoNetworkConnectivityError(): ClientAuthError' return: description: '' type: @@ -662,7 +630,6 @@ methods: package: '@azure/msal-common' summary: Throws error when cache record is null or undefined. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNullOrUndefinedCacheRecord(): ClientAuthError' @@ -676,7 +643,6 @@ methods: Throws error if token cannot be retrieved from cache due to refresh being required. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createRefreshRequiredError(): ClientAuthError' @@ -690,7 +656,6 @@ methods: Throws error when attempting to append a null, undefined or empty scope to a set remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -709,7 +674,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when two states do not match. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createStateMismatchError(): ClientAuthError' @@ -721,7 +685,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when the state is not present remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -740,7 +703,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createTokenClaimsRequiredError(): ClientAuthError' @@ -752,7 +714,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when the id token string is null or empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -771,7 +732,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when the id token extraction errors out. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -791,7 +751,6 @@ methods: Throws error when no auth code or refresh token is given to ServerTokenRequestParameters. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createTokenRequestCannotBeMadeError(): ClientAuthError' @@ -805,7 +764,6 @@ methods: Creates an error thrown when the openid-configuration endpoint cannot be reached or does not contain the required data remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -823,7 +781,6 @@ methods: package: '@azure/msal-common' summary: Throws error if unexpected account type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedAccountTypeError(): ClientAuthError' @@ -835,19 +792,28 @@ methods: package: '@azure/msal-common' summary: Throws error if unexpected credential type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedCredentialTypeError(): ClientAuthError' return: description: '' type: + - name: createUserCanceledError() + uid: '@azure/msal-common.ClientAuthError.createUserCanceledError' + package: '@azure/msal-common' + summary: Create an error when the user cancels the flow + remarks: '' + isDeprecated: false + syntax: + content: 'static function createUserCanceledError(): ClientAuthError' + return: + description: '' + type: - name: createUserTimeoutReachedError() uid: '@azure/msal-common.ClientAuthError.createUserTimeoutReachedError' package: '@azure/msal-common' summary: Throws error if the user defined timeout is reached. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserTimeoutReachedError(): ClientAuthError' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml index 82582e7..1069322 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml @@ -27,7 +27,6 @@ summary: > - clientCredentials - Credentials options for confidential clients fullName: ClientConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type ClientConfiguration = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml index cc89dcf..cbc39f0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Error thrown when there is an error in configuration of the MSAL.js library. fullName: ClientConfigurationError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ClientConfigurationError(errorCode: string, errorMessage?: string)' @@ -32,7 +30,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -48,7 +45,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -64,7 +60,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -80,7 +75,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -94,7 +88,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -108,7 +101,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -122,7 +114,6 @@ inheritedProperties: summary: Describes the subclass of an error fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -141,7 +132,6 @@ inheritedMethods: Throws error when attempting to append a null, undefined or empty scope to a set remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -163,7 +153,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error when attempting to append null or empty ScopeSet. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -187,7 +176,6 @@ inheritedMethods: Creates an error thrown when max_age was provided in the request, but auth_time is not in the token claims remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createAuthTimeNotFoundError(): ClientAuthError' @@ -203,7 +191,6 @@ inheritedMethods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createBindingKeyNotRemovedError(): ClientAuthError' @@ -218,7 +205,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if ICachePlugin not set on CacheManager. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createCachePluginError(): ClientAuthError' @@ -233,7 +219,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when client info object doesn't decode correctly. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -255,7 +240,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown if the client info is empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createClientInfoEmptyError(): ClientAuthError' @@ -272,7 +256,6 @@ inheritedMethods: Throws error if user sets CancellationToken.cancel = true during polling of token endpoint during device code flow remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createDeviceCodeCancelledError(): ClientAuthError' @@ -287,7 +270,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if device code is expired remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createDeviceCodeExpiredError(): ClientAuthError' @@ -302,7 +284,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if device code is expired remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createDeviceCodeUnknownError(): ClientAuthError' @@ -317,7 +298,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if ScopeSet is null or undefined. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createEmptyInputScopeSetError(): ClientAuthError' @@ -335,7 +315,6 @@ inheritedMethods: Creates an error thrown when the endpoint discovery doesn't complete correctly. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -356,7 +335,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when the hash cannot be deserialized. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -378,7 +356,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if client assertion is not valid. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidAssertionError(): ClientAuthError' @@ -396,7 +373,6 @@ inheritedMethods: Throws error when provided environment is not part of the CloudDiscoveryMetadata object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidCacheEnvironmentError(): ClientAuthError' @@ -411,7 +387,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if cache type is invalid. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidCacheTypeError(): ClientAuthError' @@ -426,7 +401,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if client assertion is not valid. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidCredentialError(): ClientAuthError' @@ -441,7 +415,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when the state cannot be parsed. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -468,7 +441,6 @@ inheritedMethods: Create an error when kid attribute is missing from a PoP token's cache record remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createKeyIdMissingError(): ClientAuthError' @@ -485,7 +457,6 @@ inheritedMethods: Thrown when logout is attempted for an authority that doesnt have an end_session_endpoint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createLogoutNotSupportedError(): ClientAuthError' @@ -502,7 +473,6 @@ inheritedMethods: Creates an error thrown when too much time has elapsed since the last end-user authentication remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createMaxAgeTranspiredError(): ClientAuthError' @@ -518,7 +488,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error when multiple accounts are in cache for the given params remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -536,7 +505,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error when multiple appMetada are in cache for the given clientId. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -554,7 +522,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error when multiple tokens are in cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -571,7 +538,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when the fetch client throws remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -595,7 +561,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error when account is not found in cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoAccountFoundError(): ClientAuthError' @@ -611,7 +576,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error when silent requests are made without an account object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoAccountInSilentRequestError(): ClientAuthError' @@ -629,7 +593,6 @@ inheritedMethods: Throws error when the authorization code is missing from the server response remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoAuthCodeInServerResponseError(): ClientAuthError' @@ -644,7 +607,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if crypto object not found. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -666,7 +628,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when the nonce does not match. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNonceMismatchError(): ClientAuthError' @@ -681,7 +642,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when the mnonce is not present remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -698,13 +658,27 @@ inheritedMethods: inheritanceDescription: >- Inherited From [ClientAuthError.createNonceNotFoundError](xref:@azure/msal-common.ClientAuthError.createNonceNotFoundError) + - name: createNoNetworkConnectivityError() + uid: >- + @azure/msal-common.ClientConfigurationError.createNoNetworkConnectivityError + package: '@azure/msal-common' + summary: Create an error when the client does not have network connectivity + remarks: '' + isDeprecated: false + syntax: + content: 'static function createNoNetworkConnectivityError(): ClientAuthError' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ClientAuthError.createNoNetworkConnectivityError](xref:@azure/msal-common.ClientAuthError.createNoNetworkConnectivityError) - name: createNullOrUndefinedCacheRecord() uid: >- @azure/msal-common.ClientConfigurationError.createNullOrUndefinedCacheRecord package: '@azure/msal-common' summary: Throws error when cache record is null or undefined. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNullOrUndefinedCacheRecord(): ClientAuthError' @@ -719,7 +693,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error for post request failures. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createPostRequestFailed(errDesc: string): AuthError' @@ -740,7 +713,6 @@ inheritedMethods: Throws error if token cannot be retrieved from cache due to refresh being required. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createRefreshRequiredError(): ClientAuthError' @@ -758,7 +730,6 @@ inheritedMethods: Throws error when attempting to append a null, undefined or empty scope to a set remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -780,7 +751,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when two states do not match. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createStateMismatchError(): ClientAuthError' @@ -795,7 +765,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when the state is not present remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -817,7 +786,6 @@ inheritedMethods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createTokenClaimsRequiredError(): ClientAuthError' @@ -832,7 +800,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when the id token string is null or empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -854,7 +821,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error thrown when the id token extraction errors out. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -878,7 +844,6 @@ inheritedMethods: Throws error when no auth code or refresh token is given to ServerTokenRequestParameters. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createTokenRequestCannotBeMadeError(): ClientAuthError' @@ -896,7 +861,6 @@ inheritedMethods: Creates an error thrown when the openid-configuration endpoint cannot be reached or does not contain the required data remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -918,7 +882,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if unexpected account type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedAccountTypeError(): ClientAuthError' @@ -934,7 +897,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Throws error if unexpected credential type. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedCredentialTypeError(): ClientAuthError' @@ -951,7 +913,6 @@ inheritedMethods: Creates an error that is thrown when something unexpected happens in the library. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -966,12 +927,25 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.createUnexpectedError](xref:@azure/msal-common.AuthError.createUnexpectedError) + - name: createUserCanceledError() + uid: '@azure/msal-common.ClientConfigurationError.createUserCanceledError' + package: '@azure/msal-common' + summary: Create an error when the user cancels the flow + remarks: '' + isDeprecated: false + syntax: + content: 'static function createUserCanceledError(): ClientAuthError' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ClientAuthError.createUserCanceledError](xref:@azure/msal-common.ClientAuthError.createUserCanceledError) - name: createUserTimeoutReachedError() uid: '@azure/msal-common.ClientConfigurationError.createUserTimeoutReachedError' package: '@azure/msal-common' summary: Throws error if the user defined timeout is reached. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserTimeoutReachedError(): ClientAuthError' @@ -986,7 +960,6 @@ inheritedMethods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -1006,7 +979,6 @@ methods: Creates an error thrown when the claims request could not be successfully parsed remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1024,7 +996,6 @@ methods: package: '@azure/msal-common' summary: Error thrown when client id scope is not provided as single scope. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1043,7 +1014,6 @@ methods: package: '@azure/msal-common' summary: Throws error when token request is empty and nothing cached in storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1057,7 +1027,6 @@ methods: package: '@azure/msal-common' summary: Error thrown when scopes are empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createEmptyScopesArrayError(): ClientConfigurationError' @@ -1069,7 +1038,6 @@ methods: package: '@azure/msal-common' summary: Throws error when token request is empty and nothing cached in storage. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createEmptyTokenRequestError(): ClientConfigurationError' @@ -1082,7 +1050,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown if authority uri is given an insecure protocol. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1102,7 +1069,6 @@ methods: package: '@azure/msal-common' summary: Throws error when a provided header is invalid in any way remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1125,7 +1091,6 @@ methods: package: '@azure/msal-common' summary: Throws an error when the user passes invalid cloudDiscoveryMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1140,7 +1105,6 @@ methods: package: '@azure/msal-common' summary: Throws error when the AzureCloudInstance is set to an invalid value remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1157,7 +1121,6 @@ methods: Creates error thrown when claims parameter is not a stringified JSON object remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1172,7 +1135,6 @@ methods: package: '@azure/msal-common' summary: Throws an error when the user passes invalid cloudDiscoveryMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1187,7 +1149,6 @@ methods: package: '@azure/msal-common' summary: Throws error when an invalid code_challenge_method is passed by the user remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1204,7 +1165,6 @@ methods: Throws error when both params: code_challenge and code_challenge_method are not passed together remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1218,7 +1178,6 @@ methods: package: '@azure/msal-common' summary: Error thrown when prompt is not an allowed type. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1240,7 +1199,6 @@ methods: Throws error when provided headers don't contain a header that a server nonce can be extracted from remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1256,7 +1214,6 @@ methods: Throws an error when the authentication scheme is set to SSH but the SSH public key is omitted from the request remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createMissingSshJwkError(): ClientConfigurationError' @@ -1270,7 +1227,6 @@ methods: Throws an error when the authentication scheme is set to SSH but the SSH public key ID is omitted from the request remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createMissingSshKidError(): ClientConfigurationError' @@ -1285,7 +1241,6 @@ methods: Creates an error thrown when the post-logout redirect uri is empty (not set by caller) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1299,7 +1254,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown when the redirect uri is empty (not set by caller) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createRedirectUriEmptyError(): ClientConfigurationError' @@ -1313,7 +1267,6 @@ methods: Throws error when provided authority is not a member of the trusted host list remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -1327,7 +1280,6 @@ methods: package: '@azure/msal-common' summary: Creates an error thrown if URL string is empty or null. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUrlEmptyError(): ClientConfigurationError' @@ -1341,7 +1293,6 @@ methods: Creates an error thrown if URL string does not parse into separate segments. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClientCredentialClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClientCredentialClient.yml index cdcf324..281a332 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClientCredentialClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClientCredentialClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: OAuth2.0 client credential grant fullName: ClientCredentialClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,7 +32,6 @@ inheritedProperties: summary: '' fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: Authority' @@ -50,7 +47,6 @@ inheritedProperties: summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' @@ -61,6 +57,25 @@ inheritedProperties: Inherited From [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-common.ClientCredentialClient.createTokenQueryParameters' + package: '@azure/msal-common' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: |+ + + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseClient.createTokenQueryParameters](xref:@azure/msal-common.BaseClient.createTokenQueryParameters) - name: updateAuthority(Authority) uid: '@azure/msal-common.ClientCredentialClient.updateAuthority' package: '@azure/msal-common' @@ -68,7 +83,6 @@ inheritedMethods: Updates the authority object of the client. Endpoint discovery must be completed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateAuthority(updatedAuthority: Authority)' @@ -88,7 +102,6 @@ methods: Public API to acquire a token with ClientCredential Flow for Confidential clients remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClientCredentials.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClientCredentials.yml index 73d7778..54ff6b4 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClientCredentials.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClientCredentials.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Client Credentials set for Confidential Clients fullName: ClientCredentials remarks: '' -isPreview: false isDeprecated: false syntax: | type ClientCredentials = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClientInfo.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClientInfo.yml index 8cf749d..dbba5dc 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClientInfo.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClientInfo.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Client info object which consists of two IDs. Need to add more info here. fullName: ClientInfo remarks: '' -isPreview: false isDeprecated: false syntax: | type ClientInfo = { uid: string, utid: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CloudDiscoveryMetadata.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CloudDiscoveryMetadata.yml index 8d0c3f8..3cfd91d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CloudDiscoveryMetadata.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CloudDiscoveryMetadata.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: CloudDiscoveryMetadata remarks: '' -isPreview: false isDeprecated: false syntax: | type CloudDiscoveryMetadata = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CloudInstanceDiscoveryResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CloudInstanceDiscoveryResponse.yml deleted file mode 100644 index 757932f..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CloudInstanceDiscoveryResponse.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: CloudInstanceDiscoveryResponse -uid: '@azure/msal-common.CloudInstanceDiscoveryResponse' -package: '@azure/msal-common' -summary: >- - The OpenID Configuration Endpoint Response type. Used by the authority class - to get relevant OAuth endpoints. -fullName: CloudInstanceDiscoveryResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type CloudInstanceDiscoveryResponse = { - metadata: Array, - tenant_discovery_endpoint: string, - } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml index 61ee6d0..956c9d2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml @@ -34,17 +34,19 @@ summary: > request.For more information, see the PKCE RFC: https://tools.ietf.org/html/rfc7636 - - resourceRequestMethod - HTTP Request type used to request data from the + - resourceRequestMethod - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.). Used for proof-of-possession flows. - - resourceRequestUri - URI that token will be used for. Used for + - resourceRequestUri - URI that token will be used for. Used for proof-of-possession flows. - - enableSpaAuthCode - Enables the acqusition of a spa authorization - code (confidential clients only) + - enableSpaAuthCode - Enables the acqusition of a spa authorization code + (confidential clients only) + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call fullName: CommonAuthorizationCodeRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonAuthorizationCodeRequest = BaseAuthRequest & { @@ -55,5 +57,4 @@ syntax: | enableSpaAuthorizationCode?: boolean, redirectUri: string, tokenBodyParameters?: StringDict, - tokenQueryParameters?: StringDict, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml index 810e3cc..bb1c00c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml @@ -86,7 +86,6 @@ summary: > proof-of-possession flows. fullName: CommonAuthorizationUrlRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonAuthorizationUrlRequest = BaseAuthRequest & { @@ -104,5 +103,4 @@ syntax: | responseMode: ResponseMode, sid?: string, state?: string, - tokenQueryParameters?: StringDict, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml index 5381b82..e1131e2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: CommonClientConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonClientConfiguration = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml index 08a669c..71d1698 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml @@ -19,9 +19,11 @@ summary: >- - preferredAzureRegionOptions - Options of the user's preferred azure region + + - tokenQueryParameters - String to string map of custom query + parameters added to the /token call fullName: CommonClientCredentialRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonClientCredentialRequest = BaseAuthRequest & { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml index c89c654..650fcb1 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml @@ -39,13 +39,17 @@ summary: >- of this period; assuming the device code has not expired yet; the device code polling is stopped and the request cancelled. The device code expiration window will always take precedence over this set period. + + - extraQueryParameters - String to string map of custom query parameters + added to the query string fullName: CommonDeviceCodeRequest remarks: '' -isPreview: false isDeprecated: false -syntax: | - type CommonDeviceCodeRequest = BaseAuthRequest & { +syntax: > + type CommonDeviceCodeRequest = Omit & + { cancel?: boolean, deviceCodeCallback: (response: DeviceCodeResponse) => void, + extraQueryParameters?: StringDict, timeout?: number, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml index 28805b1..77baeb6 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml @@ -22,9 +22,11 @@ summary: >- - logoutHint - A string that specifies the account that is being logged out in order to skip the server account picker on logout + + - extraQueryParameters - String to string map of custom query parameters + added to the /authorize call fullName: CommonEndSessionRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonEndSessionRequest = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml index a493905..7ece7b1 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml @@ -17,9 +17,11 @@ summary: >- - skipCache - Skip token cache lookup and force request to authority to get a a new token. Defaults to false. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call fullName: CommonOnBehalfOfRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonOnBehalfOfRequest = BaseAuthRequest & { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml index 64d7169..130be72 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml @@ -28,14 +28,15 @@ summary: >- - forceCache - Force MSAL to cache a refresh token flow response when there is no account in the cache. Used for migration scenarios. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call fullName: CommonRefreshTokenRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonRefreshTokenRequest = BaseAuthRequest & { ccsCredential?: CcsCredential, forceCache?: boolean, refreshToken: string, - tokenQueryParameters?: StringDict, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml index 8d1706e..278754a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml @@ -23,18 +23,19 @@ summary: >- - forceRefresh - Forces silent requests to make network calls if true. - - resourceRequestMethod - HTTP Request type used to request data from the + - resourceRequestMethod - HTTP Request type used to request data from the resource (i.e. "GET", "POST", etc.). Used for proof-of-possession flows. - - resourceRequestUri - URI that token will be used for. Used for + - resourceRequestUri - URI that token will be used for. Used for proof-of-possession flows. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call fullName: CommonSilentFlowRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonSilentFlowRequest = BaseAuthRequest & { account: AccountInfo, forceRefresh: boolean, - tokenQueryParameters?: StringDict, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml index 782abd8..c9f5846 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml @@ -24,9 +24,11 @@ summary: > - username - username of the client - password - credentials + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call fullName: CommonUsernamePasswordRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonUsernamePasswordRequest = BaseAuthRequest & { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/Counters.yml b/nodejs/docs-ref-autogen/@azure/msal-common/Counters.yml new file mode 100644 index 0000000..9cee228 --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/Counters.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: Counters +uid: '@azure/msal-common.Counters' +package: '@azure/msal-common' +summary: Fields whose value may change throughout a request +fullName: Counters +remarks: '' +isDeprecated: false +syntax: | + type Counters = { + incompleteSubsCount?: number, + queuedCount?: number, + queuedManuallyCompletedCount?: number, + visibilityChangeCount?: number, + } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialCache.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialCache.yml index 69eb8c8..45fb3ca 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: CredentialCache remarks: '' -isPreview: false isDeprecated: false syntax: | type CredentialCache = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml index 813e5d4..55adf4a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml @@ -30,7 +30,6 @@ summary: > } fullName: CredentialEntity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -40,7 +39,6 @@ properties: summary: '' fullName: clientId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientId: string' @@ -53,7 +51,6 @@ properties: summary: '' fullName: credentialType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'credentialType: CredentialType' @@ -66,7 +63,6 @@ properties: summary: '' fullName: environment remarks: '' - isPreview: false isDeprecated: false syntax: content: 'environment: string' @@ -79,7 +75,6 @@ properties: summary: '' fullName: familyId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'familyId?: string' @@ -92,7 +87,6 @@ properties: summary: '' fullName: homeAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'homeAccountId: string' @@ -105,7 +99,6 @@ properties: summary: '' fullName: keyId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'keyId?: string' @@ -118,7 +111,6 @@ properties: summary: '' fullName: realm remarks: '' - isPreview: false isDeprecated: false syntax: content: 'realm?: string' @@ -131,7 +123,6 @@ properties: summary: '' fullName: requestedClaimsHash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestedClaimsHash?: string' @@ -144,7 +135,6 @@ properties: summary: '' fullName: secret remarks: '' - isPreview: false isDeprecated: false syntax: content: 'secret: string' @@ -157,7 +147,6 @@ properties: summary: '' fullName: target remarks: '' - isPreview: false isDeprecated: false syntax: content: 'target?: string' @@ -170,7 +159,6 @@ properties: summary: '' fullName: tokenType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenType?: AuthenticationScheme' @@ -183,7 +171,6 @@ properties: summary: '' fullName: userAssertionHash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userAssertionHash?: string' @@ -198,7 +185,6 @@ methods: Generate Account Id key component as per the schema: - remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAccountId(): string' @@ -215,7 +201,6 @@ methods: -\----- remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -261,7 +246,6 @@ methods: Generate Credential Id key component as per the schema: -- remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCredentialId(): string' @@ -273,7 +257,6 @@ methods: package: '@azure/msal-common' summary: generates credential key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCredentialKey(): string' @@ -285,7 +268,6 @@ methods: package: '@azure/msal-common' summary: 'Generate target key component as per schema: ' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateTarget(): string' @@ -297,7 +279,6 @@ methods: package: '@azure/msal-common' summary: returns the type of the cache (in this case credential) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateType(): number' @@ -309,7 +290,6 @@ methods: package: '@azure/msal-common' summary: helper function to return `CredentialType` remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function getCredentialType(key: string): string' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml index 79797bb..0693b00 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml @@ -7,7 +7,6 @@ summary: >- ------ fullName: CredentialFilter remarks: '' -isPreview: false isDeprecated: false syntax: | type CredentialFilter = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialType.yml index a99cf46..4137eac 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Credential Type stored in the cache fullName: CredentialType remarks: '' -isPreview: false isDeprecated: false fields: - name: ACCESS_TOKEN diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/DecodedAuthToken.yml b/nodejs/docs-ref-autogen/@azure/msal-common/DecodedAuthToken.yml index b1214c5..ff7e196 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/DecodedAuthToken.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/DecodedAuthToken.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Interface for Decoded JWT tokens. fullName: DecodedAuthToken remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: header remarks: '' - isPreview: false isDeprecated: false syntax: content: 'header: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: JWSPayload remarks: '' - isPreview: false isDeprecated: false syntax: content: 'JWSPayload: string' @@ -41,7 +38,6 @@ properties: summary: '' fullName: JWSSig remarks: '' - isPreview: false isDeprecated: false syntax: content: 'JWSSig: string' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml b/nodejs/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml index 9735bb6..283b58f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: DefaultStorageClass remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new DefaultStorageClass(clientId: string, cryptoImpl: ICrypto)' @@ -31,7 +29,6 @@ inheritedMethods: package: '@azure/msal-common' summary: returns cache key used for cloud instance metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAuthorityMetadataCacheKey(authority: string): string' @@ -55,7 +52,6 @@ inheritedMethods: not checking for casing as keys are all generated in lower case, remember to convert to lower case if object properties are compared remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -76,7 +72,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Returns all accounts in cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): AccountInfo[]' @@ -93,7 +88,6 @@ inheritedMethods: retrieve appMetadata matching all provided filters; if no filter is set, get all appMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -115,7 +109,6 @@ inheritedMethods: package: '@azure/msal-common' summary: retrieve authorityMetadata that contains a matching alias remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -138,7 +131,6 @@ inheritedMethods: retrieve credentails matching all provided filters; if no filter is set, get all credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -159,7 +151,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Return the family_id value associated with FOCI remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -184,7 +175,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Retrieve AccessTokenEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -211,7 +201,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Retrieve AccountEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -234,7 +223,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Retrieve AccountEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -255,7 +243,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Retrieve AppMetadataEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -279,7 +266,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Retrieve the cached credentials into a cacherecord remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -309,7 +295,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Retrieve IdTokenEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -333,7 +318,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Helper to retrieve the appropriate refresh token from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -361,7 +345,6 @@ inheritedMethods: package: '@azure/msal-common' summary: returns a boolean if the given account is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccount(accountKey: string): Promise' @@ -380,7 +363,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Removes credentials associated with the provided account remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccountContext(account: AccountEntity): Promise' @@ -400,7 +382,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Removes all accounts and related tokens from cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAllAccounts(): Promise' @@ -415,7 +396,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Removes all app metadata objects from cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAppMetadata(): boolean' @@ -430,7 +410,6 @@ inheritedMethods: package: '@azure/msal-common' summary: returns a boolean if the given credential is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -452,7 +431,6 @@ inheritedMethods: package: '@azure/msal-common' summary: saves a cache record remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' @@ -472,7 +450,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Helper to convert serialized data to object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function toObject(obj: T, json: object): T' @@ -496,7 +473,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function clear(): Promise' @@ -508,7 +484,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function containsKey(): boolean' @@ -520,7 +495,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccessTokenCredential(): AccessTokenEntity' @@ -532,7 +506,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccount(): AccountEntity' @@ -544,7 +517,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAppMetadata(): AppMetadataEntity' @@ -556,7 +528,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAuthorityMetadata(): AuthorityMetadataEntity | null' @@ -568,7 +539,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAuthorityMetadataKeys(): Array' @@ -580,7 +550,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getIdTokenCredential(): IdTokenEntity' @@ -592,7 +561,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKeys(): string[]' @@ -604,7 +572,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRefreshTokenCredential(): RefreshTokenEntity' @@ -616,7 +583,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getServerTelemetry(): ServerTelemetryEntity' @@ -628,7 +594,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getThrottlingCache(): ThrottlingEntity' @@ -640,7 +605,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeItem(): boolean' @@ -652,7 +616,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function setAccessTokenCredential() @@ -661,7 +624,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function setAccount() @@ -670,7 +632,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function setAppMetadata() @@ -679,7 +640,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function setAuthorityMetadata() @@ -688,7 +648,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function setIdTokenCredential() @@ -697,7 +656,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function setRefreshTokenCredential() @@ -706,7 +664,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function setServerTelemetry() @@ -715,7 +672,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function setThrottlingCache() @@ -724,7 +680,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateCredentialCacheKey(): string' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/DeviceCodeClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/DeviceCodeClient.yml index 1de4c58..95c00da 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/DeviceCodeClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/DeviceCodeClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: OAuth2.0 Device code client fullName: DeviceCodeClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new DeviceCodeClient(configuration: ClientConfiguration)' @@ -29,7 +27,6 @@ inheritedProperties: summary: '' fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: Authority' @@ -45,7 +42,6 @@ inheritedProperties: summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' @@ -56,6 +52,25 @@ inheritedProperties: Inherited From [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-common.DeviceCodeClient.createTokenQueryParameters' + package: '@azure/msal-common' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: |+ + + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseClient.createTokenQueryParameters](xref:@azure/msal-common.BaseClient.createTokenQueryParameters) - name: updateAuthority(Authority) uid: '@azure/msal-common.DeviceCodeClient.updateAuthority' package: '@azure/msal-common' @@ -63,7 +78,6 @@ inheritedMethods: Updates the authority object of the client. Endpoint discovery must be completed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateAuthority(updatedAuthority: Authority)' @@ -85,7 +99,6 @@ methods: polls token endpoint to exchange device code for tokens remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -101,4 +114,22 @@ methods: type: >- Promise< | null> + - name: createExtraQueryParameters(CommonDeviceCodeRequest) + uid: '@azure/msal-common.DeviceCodeClient.createExtraQueryParameters' + package: '@azure/msal-common' + summary: Creates query string for the device code request + remarks: '' + isDeprecated: false + syntax: + content: >- + function createExtraQueryParameters(request: CommonDeviceCodeRequest): + string + parameters: + - id: request + type: + description: |+ + + return: + description: '' + type: string extends: diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml index 0764b3f..984bac2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml @@ -21,7 +21,6 @@ summary: >- - message: message which should be displayed to the user fullName: DeviceCodeResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type DeviceCodeResponse = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml index 163c06b..fdd0e80 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml @@ -24,7 +24,6 @@ summary: >- - client_info: Client info object fullName: ExternalTokenResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type ExternalTokenResponse = Pick< diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/GrantType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/GrantType.yml index fe34492..43c5827 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/GrantType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/GrantType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: allowed grant_type fullName: GrantType remarks: '' -isPreview: false isDeprecated: false fields: - name: AUTHORIZATION_CODE_GRANT diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/HeaderNames.yml b/nodejs/docs-ref-autogen/@azure/msal-common/HeaderNames.yml index 2763285..93f2fad 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/HeaderNames.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/HeaderNames.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Request header names fullName: HeaderNames remarks: '' -isPreview: false isDeprecated: false fields: - name: AuthenticationInfo @@ -28,6 +27,10 @@ fields: uid: '@azure/msal-common.HeaderNames.WWWAuthenticate' package: '@azure/msal-common' summary: '' + - name: X_MS_HTTP_VERSION + uid: '@azure/msal-common.HeaderNames.X_MS_HTTP_VERSION' + package: '@azure/msal-common' + summary: '' - name: X_MS_REQUEST_ID uid: '@azure/msal-common.HeaderNames.X_MS_REQUEST_ID' package: '@azure/msal-common' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml b/nodejs/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml index 34ab003..744be66 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml @@ -19,6 +19,5 @@ summary: >- meant for Azure SDK to enhance Managed Identity support. fullName: IAppTokenProvider remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ICacheManager.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ICacheManager.yml index bec62ad..3746241 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ICacheManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ICacheManager.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ICacheManager remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-common' summary: given an authority generates the cache key for authorityMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAuthorityMetadataCacheKey(authority: string): string' @@ -31,7 +29,6 @@ methods: package: '@azure/msal-common' summary: fetch the idToken entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -50,7 +47,6 @@ methods: package: '@azure/msal-common' summary: fetch the account entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccount(accountKey: string): AccountEntity | null' @@ -69,7 +65,6 @@ methods: retrieve accounts matching all provided filters; if no filter is set, get all accounts remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccountsFilteredBy(filter: AccountFilter): AccountCache' @@ -85,7 +80,6 @@ methods: package: '@azure/msal-common' summary: Returns all accounts in cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): AccountInfo[]' @@ -97,7 +91,6 @@ methods: package: '@azure/msal-common' summary: fetch appMetadata entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -116,7 +109,6 @@ methods: package: '@azure/msal-common' summary: fetch cloud discovery metadata entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -135,7 +127,6 @@ methods: package: '@azure/msal-common' summary: Provide an alias to find a matching AuthorityMetadataEntity in cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -154,7 +145,6 @@ methods: package: '@azure/msal-common' summary: Get cache keys for authority metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAuthorityMetadataKeys(): Array' @@ -168,7 +158,6 @@ methods: retrieve credentials matching all provided filters; if no filter is set, get all credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -186,7 +175,6 @@ methods: package: '@azure/msal-common' summary: fetch the idToken entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getIdTokenCredential(idTokenKey: string): IdTokenEntity | null' @@ -203,7 +191,6 @@ methods: package: '@azure/msal-common' summary: fetch the idToken entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -222,7 +209,6 @@ methods: package: '@azure/msal-common' summary: fetch server telemetry entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,7 +227,6 @@ methods: package: '@azure/msal-common' summary: fetch throttling entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -260,7 +245,6 @@ methods: package: '@azure/msal-common' summary: returns a boolean if the given account is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccount(accountKey: string): Promise' @@ -276,7 +260,6 @@ methods: package: '@azure/msal-common' summary: returns a boolean if the given account is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccountContext(account: AccountEntity): Promise' @@ -293,7 +276,6 @@ methods: package: '@azure/msal-common' summary: Removes all accounts and related tokens from cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAllAccounts(): Promise' @@ -305,7 +287,6 @@ methods: package: '@azure/msal-common' summary: returns a boolean if the given credential is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -324,7 +305,6 @@ methods: package: '@azure/msal-common' summary: saves a cache record remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' @@ -341,7 +321,6 @@ methods: package: '@azure/msal-common' summary: set idToken entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' @@ -355,7 +334,6 @@ methods: package: '@azure/msal-common' summary: set account entity in the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAccount(account: AccountEntity)' @@ -369,7 +347,6 @@ methods: package: '@azure/msal-common' summary: set appMetadata entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' @@ -383,7 +360,6 @@ methods: package: '@azure/msal-common' summary: set cloud discovery metadata entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -402,7 +378,6 @@ methods: package: '@azure/msal-common' summary: set idToken entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setIdTokenCredential(idToken: IdTokenEntity)' @@ -416,7 +391,6 @@ methods: package: '@azure/msal-common' summary: set idToken entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)' @@ -430,7 +404,6 @@ methods: package: '@azure/msal-common' summary: set server telemetry entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -449,7 +422,6 @@ methods: package: '@azure/msal-common' summary: set throttling entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml index a814e0e..9e48b36 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ICachePlugin remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: afterCacheAccess remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -30,7 +28,6 @@ properties: summary: '' fullName: beforeCacheAccess remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ICrypto.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ICrypto.yml index de9db47..3e14f2e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ICrypto.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ICrypto.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Interface for crypto functions used by library fullName: ICrypto remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-common' summary: base64 decode string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Decode(input: string): string' @@ -31,7 +29,6 @@ methods: package: '@azure/msal-common' summary: base64 Encode string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Encode(input: string): string' @@ -48,7 +45,6 @@ methods: package: '@azure/msal-common' summary: Removes all cryptographic keys from IndexedDB storage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function clearKeystore(): Promise' @@ -60,7 +56,6 @@ methods: package: '@azure/msal-common' summary: Creates a guid randomly. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createNewGuid(): string' @@ -74,7 +69,6 @@ methods: Generate PKCE codes for OAuth. See RFC here: https://tools.ietf.org/html/rfc7636 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generatePkceCodes(): Promise' @@ -86,7 +80,6 @@ methods: package: '@azure/msal-common' summary: Generates an JWK RSA S256 Thumbprint remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -105,7 +98,6 @@ methods: package: '@azure/msal-common' summary: Returns the SHA-256 hash of an input string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function hashString(plainText: string): Promise' @@ -122,7 +114,6 @@ methods: package: '@azure/msal-common' summary: Removes cryptographic keypair from key store matching the keyId passed in remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeTokenBindingKey(kid: string): Promise' @@ -141,7 +132,6 @@ methods: Returns a signed proof-of-possession token with a given acces token that contains a cnf claim with the required kid. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml b/nodejs/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml index 93088bc..89b9afe 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: IGuidGenerator remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateGuid(): string' @@ -26,7 +24,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isGuid(guid: string): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml index 6bb7d14..066e98f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml @@ -5,6 +5,5 @@ package: '@azure/msal-common' summary: Callback to send the messages to. fullName: ILoggerCallback remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/IMDSBadResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-common/IMDSBadResponse.yml deleted file mode 100644 index bd235a6..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/IMDSBadResponse.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: IMDSBadResponse -uid: '@azure/msal-common.IMDSBadResponse' -package: '@azure/msal-common' -summary: '' -fullName: IMDSBadResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: 'type IMDSBadResponse = { error: string, newest-versions: Array }' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/INativeBrokerPlugin.yml b/nodejs/docs-ref-autogen/@azure/msal-common/INativeBrokerPlugin.yml new file mode 100644 index 0000000..e2a0d91 --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/INativeBrokerPlugin.yml @@ -0,0 +1,127 @@ +### YamlMime:TSType +name: INativeBrokerPlugin +uid: '@azure/msal-common.INativeBrokerPlugin' +package: '@azure/msal-common' +summary: '' +fullName: INativeBrokerPlugin +remarks: '' +isDeprecated: false +type: interface +properties: + - name: isBrokerAvailable + uid: '@azure/msal-common.INativeBrokerPlugin.isBrokerAvailable' + package: '@azure/msal-common' + summary: '' + fullName: isBrokerAvailable + remarks: '' + isDeprecated: false + syntax: + content: 'isBrokerAvailable: boolean' + return: + description: '' + type: boolean +methods: + - name: 'acquireTokenInteractive(NativeRequest, Buffer)' + uid: '@azure/msal-common.INativeBrokerPlugin.acquireTokenInteractive' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenInteractive(request: NativeRequest, windowHandle?: + Buffer): Promise + parameters: + - id: request + type: + description: '' + - id: windowHandle + type: Buffer + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenSilent(NativeRequest) + uid: '@azure/msal-common.INativeBrokerPlugin.acquireTokenSilent' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(request: NativeRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: 'getAccountById(string, string)' + uid: '@azure/msal-common.INativeBrokerPlugin.getAccountById' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountById(accountId: string, correlationId: string): + Promise + parameters: + - id: accountId + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<> + - name: 'getAllAccounts(string, string)' + uid: '@azure/msal-common.INativeBrokerPlugin.getAllAccounts' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAllAccounts(clientId: string, correlationId: string): + Promise + parameters: + - id: clientId + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: 'Promise<[]>' + - name: setLogger(LoggerOptions) + uid: '@azure/msal-common.INativeBrokerPlugin.setLogger' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(loggerOptions: LoggerOptions)' + parameters: + - id: loggerOptions + type: + description: '' + - name: signOut(NativeSignOutRequest) + uid: '@azure/msal-common.INativeBrokerPlugin.signOut' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function signOut(request: NativeSignOutRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/INetworkModule.yml b/nodejs/docs-ref-autogen/@azure/msal-common/INetworkModule.yml index 51eff0d..1a41883 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/INetworkModule.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/INetworkModule.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Client network interface to send backend requests. fullName: INetworkModule remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -16,7 +15,6 @@ methods: Interface function for async network "GET" requests. Based on the Fetch standard: https://fetch.spec.whatwg.org/ remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -45,7 +43,6 @@ methods: Interface function for async network "POST" requests. Based on the Fetch standard: https://fetch.spec.whatwg.org/ remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml index 1cd5a60..685a9bd 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: IPerformanceClient remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -27,12 +25,34 @@ methods: return: description: '' type: string + - name: 'addQueueMeasurement(PerformanceEvents, string, number, boolean)' + uid: '@azure/msal-common.IPerformanceClient.addQueueMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addQueueMeasurement(eventName: PerformanceEvents, + correlationId?: string, queueTime?: number, manuallyCompleted?: boolean) + parameters: + - id: eventName + type: + description: '' + - id: correlationId + type: string + description: '' + - id: queueTime + type: number + description: '' + - id: manuallyCompleted + type: boolean + description: '' - name: 'addStaticFields(StaticFields, string)' uid: '@azure/msal-common.IPerformanceClient.addStaticFields' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -45,12 +65,31 @@ methods: - id: correlationId type: string description: '' + - name: 'calculateQueuedTime(number, number)' + uid: '@azure/msal-common.IPerformanceClient.calculateQueuedTime' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function calculateQueuedTime(preQueueTime: number, currentTime: number): + number + parameters: + - id: preQueueTime + type: number + description: '' + - id: currentTime + type: number + description: '' + return: + description: '' + type: number - name: discardMeasurements(string) uid: '@azure/msal-common.IPerformanceClient.discardMeasurements' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function discardMeasurements(correlationId: string)' @@ -63,7 +102,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emitEvents(events: PerformanceEvent[], correlationId: string)' @@ -79,7 +117,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -92,30 +129,11 @@ methods: return: description: '' type: | null - - name: 'flushMeasurements(PerformanceEvents, string)' - uid: '@azure/msal-common.IPerformanceClient.flushMeasurements' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function flushMeasurements(measureName: PerformanceEvents, - correlationId?: string) - parameters: - - id: measureName - type: - description: '' - - id: correlationId - type: string - description: '' - name: generateId() uid: '@azure/msal-common.IPerformanceClient.generateId' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateId(): string' @@ -127,7 +145,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -138,12 +155,28 @@ methods: return: description: '' type: boolean + - name: 'setPreQueueTime(PerformanceEvents, string)' + uid: '@azure/msal-common.IPerformanceClient.setPreQueueTime' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function setPreQueueTime(eventName: PerformanceEvents, correlationId?: + string) + parameters: + - id: eventName + type: + description: '' + - id: correlationId + type: string + description: '' - name: 'startMeasurement(PerformanceEvents, string)' uid: '@azure/msal-common.IPerformanceClient.startMeasurement' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -164,7 +197,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -180,3 +212,23 @@ methods: return: description: '' type: + - name: 'startPerformanceMeasurement(string, string)' + uid: '@azure/msal-common.IPerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function startPerformanceMeasurement(measureName: string, correlationId: + string): IPerformanceMeasurement + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml b/nodejs/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml index 72bee72..915a8ce 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: IPerformanceMeasurement remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function endMeasurement() @@ -23,7 +21,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function flushMeasurement(): number | null' @@ -35,7 +32,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function startMeasurement() diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ISerializableTokenCache.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ISerializableTokenCache.yml index 1740dfe..eb45cbc 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ISerializableTokenCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ISerializableTokenCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ISerializableTokenCache remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: deserialize remarks: '' - isPreview: false isDeprecated: false syntax: content: 'deserialize: (cache: string) => void' @@ -28,7 +26,6 @@ properties: summary: '' fullName: serialize remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serialize: () => string' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/IUri.yml b/nodejs/docs-ref-autogen/@azure/msal-common/IUri.yml index c7fe7a7..4f14e0f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/IUri.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/IUri.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Interface which describes URI components. fullName: IUri remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: AbsolutePath remarks: '' - isPreview: false isDeprecated: false syntax: content: 'AbsolutePath: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: Hash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'Hash: string' @@ -41,7 +38,6 @@ properties: summary: '' fullName: HostNameAndPort remarks: '' - isPreview: false isDeprecated: false syntax: content: 'HostNameAndPort: string' @@ -54,7 +50,6 @@ properties: summary: '' fullName: PathSegments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'PathSegments: string[]' @@ -67,7 +62,6 @@ properties: summary: '' fullName: Protocol remarks: '' - isPreview: false isDeprecated: false syntax: content: 'Protocol: string' @@ -80,7 +74,6 @@ properties: summary: '' fullName: QueryString remarks: '' - isPreview: false isDeprecated: false syntax: content: 'QueryString: string' @@ -93,7 +86,6 @@ properties: summary: '' fullName: Search remarks: '' - isPreview: false isDeprecated: false syntax: content: 'Search: string' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenCache.yml b/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenCache.yml index 50bb81c..39ebdc4 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: IdTokenCache remarks: '' -isPreview: false isDeprecated: false syntax: | type IdTokenCache = Record diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml index 84d8406..7178661 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml @@ -19,7 +19,6 @@ summary: | } fullName: IdTokenEntity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -29,7 +28,6 @@ properties: summary: '' fullName: realm remarks: '' - isPreview: false isDeprecated: false syntax: content: 'realm: string' @@ -43,7 +41,6 @@ inheritedProperties: summary: '' fullName: clientId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientId: string' @@ -59,7 +56,6 @@ inheritedProperties: summary: '' fullName: credentialType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'credentialType: CredentialType' @@ -75,7 +71,6 @@ inheritedProperties: summary: '' fullName: environment remarks: '' - isPreview: false isDeprecated: false syntax: content: 'environment: string' @@ -91,7 +86,6 @@ inheritedProperties: summary: '' fullName: familyId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'familyId?: string' @@ -107,7 +101,6 @@ inheritedProperties: summary: '' fullName: homeAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'homeAccountId: string' @@ -123,7 +116,6 @@ inheritedProperties: summary: '' fullName: keyId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'keyId?: string' @@ -139,7 +131,6 @@ inheritedProperties: summary: '' fullName: requestedClaimsHash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestedClaimsHash?: string' @@ -155,7 +146,6 @@ inheritedProperties: summary: '' fullName: secret remarks: '' - isPreview: false isDeprecated: false syntax: content: 'secret: string' @@ -171,7 +161,6 @@ inheritedProperties: summary: '' fullName: target remarks: '' - isPreview: false isDeprecated: false syntax: content: 'target?: string' @@ -187,7 +176,6 @@ inheritedProperties: summary: '' fullName: tokenType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenType?: AuthenticationScheme' @@ -203,7 +191,6 @@ inheritedProperties: summary: '' fullName: userAssertionHash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userAssertionHash?: string' @@ -221,7 +208,6 @@ inheritedMethods: Generate Account Id key component as per the schema: - remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAccountId(): string' @@ -241,7 +227,6 @@ inheritedMethods: -\----- remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -290,7 +275,6 @@ inheritedMethods: Generate Credential Id key component as per the schema: -- remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCredentialId(): string' @@ -305,7 +289,6 @@ inheritedMethods: package: '@azure/msal-common' summary: generates credential key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCredentialKey(): string' @@ -320,7 +303,6 @@ inheritedMethods: package: '@azure/msal-common' summary: 'Generate target key component as per schema: ' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateTarget(): string' @@ -335,7 +317,6 @@ inheritedMethods: package: '@azure/msal-common' summary: returns the type of the cache (in this case credential) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateType(): number' @@ -350,7 +331,6 @@ inheritedMethods: package: '@azure/msal-common' summary: helper function to return `CredentialType` remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function getCredentialType(key: string): string' @@ -371,7 +351,6 @@ methods: package: '@azure/msal-common' summary: Create IdTokenEntity remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -402,7 +381,6 @@ methods: package: '@azure/msal-common' summary: 'Validates an entity: checks for all expected params' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function isIdTokenEntity(entity: object): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ImdsOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ImdsOptions.yml deleted file mode 100644 index 9e6878c..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ImdsOptions.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: ImdsOptions -uid: '@azure/msal-common.ImdsOptions' -package: '@azure/msal-common' -summary: '' -fullName: ImdsOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ImdsOptions = { headers?: { Metadata: string }, proxyUrl?: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml b/nodejs/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml index 9e90aa5..90c0238 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: InProgressPerformanceEvent remarks: '' -isPreview: false isDeprecated: false syntax: | type InProgressPerformanceEvent = { @@ -15,6 +14,6 @@ syntax: | event?: Partial ) => PerformanceEvent | null, event: PerformanceEvent, - flushMeasurement: () => void, + increment: (counters: Counters) => void, measurement: IPerformanceMeasurement, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml b/nodejs/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml index cf79796..8a3f5e0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml @@ -5,21 +5,22 @@ package: '@azure/msal-common' summary: Error thrown when user interaction is required. fullName: InteractionRequiredAuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'InteractionRequiredAuthError(string, string, string)' + - name: >- + InteractionRequiredAuthError(string, string, string, string, string, + string, string) uid: '@azure/msal-common.InteractionRequiredAuthError.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new InteractionRequiredAuthError(errorCode?: string, errorMessage?: - string, subError?: string) + string, subError?: string, timestamp?: string, traceId?: string, + correlationId?: string, claims?: string) parameters: - id: errorCode type: string @@ -30,6 +31,71 @@ constructors: - id: subError type: string description: '' + - id: timestamp + type: string + description: '' + - id: traceId + type: string + description: '' + - id: correlationId + type: string + description: '' + - id: claims + type: string + description: '' +properties: + - name: claims + uid: '@azure/msal-common.InteractionRequiredAuthError.claims' + package: '@azure/msal-common' + summary: > + https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-common/docs/claims-challenge.md + + A string with extra claims needed for the token request to succeed + + web site: redirect the user to the authorization page and set the extra + claims + + web api: include the claims in the WWW-Authenticate header that are sent + back to the client so that it knows to request a token with the extra + claims + + desktop application or browser context: include the claims when acquiring + the token interactively + + app to app context (client_credentials): include the claims in the + AcquireTokenByClientCredential request + fullName: claims + remarks: '' + isDeprecated: false + syntax: + content: 'claims: string' + return: + description: '' + type: string + - name: timestamp + uid: '@azure/msal-common.InteractionRequiredAuthError.timestamp' + package: '@azure/msal-common' + summary: The time the error occured at + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp: string' + return: + description: '' + type: string + - name: traceId + uid: '@azure/msal-common.InteractionRequiredAuthError.traceId' + package: '@azure/msal-common' + summary: TraceId associated with the error + fullName: traceId + remarks: '' + isDeprecated: false + syntax: + content: 'traceId: string' + return: + description: '' + type: string inheritedProperties: - name: correlationId uid: '@azure/msal-common.InteractionRequiredAuthError.correlationId' @@ -37,7 +103,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -53,7 +118,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -69,7 +133,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -85,7 +148,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -99,7 +161,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -113,7 +174,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -127,7 +187,6 @@ inheritedProperties: summary: Describes the subclass of an error fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -143,7 +202,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error for post request failures. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createPostRequestFailed(errDesc: string): AuthError' @@ -164,7 +222,6 @@ inheritedMethods: Creates an error that is thrown when something unexpected happens in the library. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -184,7 +241,6 @@ inheritedMethods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -205,7 +261,6 @@ methods: status, indicating that the account was removed and interactive sign-in is required remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -221,7 +276,6 @@ methods: Creates an error thrown when the authorization code required for a token request is null or empty. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoTokensFoundError(): InteractionRequiredAuthError' @@ -235,7 +289,6 @@ methods: Helper function used to determine if an error thrown by the server requires interaction to resolve remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeader.yml b/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeader.yml index 0ed17c5..5a3fb48 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeader.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeader.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: JoseHeader remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new JoseHeader(options: JoseHeaderOptions)' @@ -29,7 +27,6 @@ properties: summary: '' fullName: alg remarks: '' - isPreview: false isDeprecated: false syntax: content: 'alg?: string' @@ -42,7 +39,6 @@ properties: summary: '' fullName: kid remarks: '' - isPreview: false isDeprecated: false syntax: content: 'kid?: string' @@ -55,7 +51,6 @@ properties: summary: '' fullName: typ remarks: '' - isPreview: false isDeprecated: false syntax: content: 'typ?: JsonTypes' @@ -76,7 +71,6 @@ methods: Throws if keyId or algorithm aren't provided since they are required for Access Token Binding. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeaderError.yml b/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeaderError.yml deleted file mode 100644 index 6c725e8..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeaderError.yml +++ /dev/null @@ -1,218 +0,0 @@ -### YamlMime:TSType -name: JoseHeaderError -uid: '@azure/msal-common.JoseHeaderError' -package: '@azure/msal-common' -summary: Error thrown when there is an error in the client code running on the browser. -fullName: JoseHeaderError -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'JoseHeaderError(string, string)' - uid: '@azure/msal-common.JoseHeaderError.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new JoseHeaderError(errorCode: string, errorMessage?: string)' - parameters: - - id: errorCode - type: string - description: '' - - id: errorMessage - type: string - description: '' -inheritedProperties: - - name: correlationId - uid: '@azure/msal-common.JoseHeaderError.correlationId' - package: '@azure/msal-common' - summary: CorrelationId associated with the error - fullName: correlationId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'correlationId: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.correlationId](xref:@azure/msal-common.AuthError.correlationId) - - name: errorCode - uid: '@azure/msal-common.JoseHeaderError.errorCode' - package: '@azure/msal-common' - summary: Short string denoting error - fullName: errorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorCode: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorCode](xref:@azure/msal-common.AuthError.errorCode) - - name: errorMessage - uid: '@azure/msal-common.JoseHeaderError.errorMessage' - package: '@azure/msal-common' - summary: Detailed description of error - fullName: errorMessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorMessage](xref:@azure/msal-common.AuthError.errorMessage) - - name: message - uid: '@azure/msal-common.JoseHeaderError.message' - package: '@azure/msal-common' - summary: '' - fullName: message - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'message: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.message - - name: name - uid: '@azure/msal-common.JoseHeaderError.name' - package: '@azure/msal-common' - summary: '' - fullName: name - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.name - - name: stack - uid: '@azure/msal-common.JoseHeaderError.stack' - package: '@azure/msal-common' - summary: '' - fullName: stack - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack - - name: subError - uid: '@azure/msal-common.JoseHeaderError.subError' - package: '@azure/msal-common' - summary: Describes the subclass of an error - fullName: subError - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'subError: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.subError](xref:@azure/msal-common.AuthError.subError) -inheritedMethods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-common.JoseHeaderError.createPostRequestFailed' - package: '@azure/msal-common' - summary: Creates an error for post request failures. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [AuthError.createPostRequestFailed](xref:@azure/msal-common.AuthError.createPostRequestFailed) - - name: createUnexpectedError(string) - uid: '@azure/msal-common.JoseHeaderError.createUnexpectedError' - package: '@azure/msal-common' - summary: >- - Creates an error that is thrown when something unexpected happens in the - library. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUnexpectedError(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: |+ - - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [AuthError.createUnexpectedError](xref:@azure/msal-common.AuthError.createUnexpectedError) - - name: setCorrelationId(string) - uid: '@azure/msal-common.JoseHeaderError.setCorrelationId' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setCorrelationId(correlationId: string)' - parameters: - - id: correlationId - type: string - description: '' - inheritanceDescription: >- - Inherited From - [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) -methods: - - name: createMissingAlgError() - uid: '@azure/msal-common.JoseHeaderError.createMissingAlgError' - package: '@azure/msal-common' - summary: Creates an error thrown when algorithm isn't set on JOSE header. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createMissingAlgError(): JoseHeaderError' - return: - description: '' - type: - - name: createMissingKidError() - uid: '@azure/msal-common.JoseHeaderError.createMissingKidError' - package: '@azure/msal-common' - summary: Creates an error thrown when keyId isn't set on JOSE header. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createMissingKidError(): JoseHeaderError' - return: - description: '' - type: -extends: diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeaderOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeaderOptions.yml index d8898f1..03a5ec8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeaderOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/JoseHeaderOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: JoseHeaderOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type JoseHeaderOptions = { alg?: string, kid?: string, typ?: JsonTypes } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/JsonTypes.yml b/nodejs/docs-ref-autogen/@azure/msal-common/JsonTypes.yml index a465a41..8735aa1 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/JsonTypes.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/JsonTypes.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: JsonTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: Jwk @@ -16,3 +15,7 @@ fields: uid: '@azure/msal-common.JsonTypes.Jwt' package: '@azure/msal-common' summary: '' + - name: Pop + uid: '@azure/msal-common.JsonTypes.Pop' + package: '@azure/msal-common' + summary: '' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/KeyLocation.yml b/nodejs/docs-ref-autogen/@azure/msal-common/KeyLocation.yml index 39fe5c5..dc2fde2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/KeyLocation.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/KeyLocation.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: KeyLocation remarks: '' -isPreview: false isDeprecated: false fields: - name: SW diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/LibraryInfo.yml b/nodejs/docs-ref-autogen/@azure/msal-common/LibraryInfo.yml index 83f7db5..7b60bea 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/LibraryInfo.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/LibraryInfo.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Library-specific options fullName: LibraryInfo remarks: '' -isPreview: false isDeprecated: false syntax: | type LibraryInfo = { cpu: string, os: string, sku: string, version: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml b/nodejs/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml index e67af40..b78c4c5 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml @@ -16,7 +16,6 @@ summary: >- - platformState - string value sent from the platform. fullName: LibraryStateObject remarks: '' -isPreview: false isDeprecated: false syntax: | type LibraryStateObject = { id: string, meta?: Record } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/LogLevel.yml b/nodejs/docs-ref-autogen/@azure/msal-common/LogLevel.yml index 1327f33..5e2c3c3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/LogLevel.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/LogLevel.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Log message level. fullName: LogLevel remarks: '' -isPreview: false isDeprecated: false fields: - name: Error diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/Logger.yml b/nodejs/docs-ref-autogen/@azure/msal-common/Logger.yml index 2d12a5f..197664d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/Logger.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/Logger.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Class which facilitates logging of messages to a specific place. fullName: Logger remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,7 +34,6 @@ methods: package: '@azure/msal-common' summary: Create new Logger with existing configurations. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -60,7 +57,6 @@ methods: package: '@azure/msal-common' summary: Logs error messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function error(message: string, correlationId?: string)' @@ -76,7 +72,6 @@ methods: package: '@azure/msal-common' summary: Logs error messages with PII. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function errorPii(message: string, correlationId?: string)' @@ -92,7 +87,6 @@ methods: package: '@azure/msal-common' summary: Execute callback with message. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -113,7 +107,6 @@ methods: package: '@azure/msal-common' summary: Logs info messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function info(message: string, correlationId?: string)' @@ -129,7 +122,6 @@ methods: package: '@azure/msal-common' summary: Logs info messages with PII. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function infoPii(message: string, correlationId?: string)' @@ -145,7 +137,6 @@ methods: package: '@azure/msal-common' summary: Returns whether PII Logging is enabled or not. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isPiiLoggingEnabled(): boolean' @@ -157,7 +148,6 @@ methods: package: '@azure/msal-common' summary: Logs trace messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trace(message: string, correlationId?: string)' @@ -173,7 +163,6 @@ methods: package: '@azure/msal-common' summary: Logs trace messages with PII. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tracePii(message: string, correlationId?: string)' @@ -189,7 +178,6 @@ methods: package: '@azure/msal-common' summary: Logs verbose messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function verbose(message: string, correlationId?: string)' @@ -205,7 +193,6 @@ methods: package: '@azure/msal-common' summary: Logs verbose messages with PII. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function verbosePii(message: string, correlationId?: string)' @@ -221,7 +208,6 @@ methods: package: '@azure/msal-common' summary: Logs warning messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function warning(message: string, correlationId?: string)' @@ -237,7 +223,6 @@ methods: package: '@azure/msal-common' summary: Logs warning messages with PII. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function warningPii(message: string, correlationId?: string)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/LoggerMessageOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/LoggerMessageOptions.yml index f02a1b6..9b2d585 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/LoggerMessageOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/LoggerMessageOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Options for logger messages. fullName: LoggerMessageOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type LoggerMessageOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml index 6d95d83..cb986a8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml @@ -10,7 +10,6 @@ summary: |2 - correlationId - Sets the correlationId printed by the logger fullName: LoggerOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type LoggerOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/NativeRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/NativeRequest.yml new file mode 100644 index 0000000..f06f8e0 --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/NativeRequest.yml @@ -0,0 +1,27 @@ +### YamlMime:TSTypeAlias +name: NativeRequest +uid: '@azure/msal-common.NativeRequest' +package: '@azure/msal-common' +summary: '' +fullName: NativeRequest +remarks: '' +isDeprecated: false +syntax: | + type NativeRequest = { + accountId?: string, + authenticationScheme?: string, + authority: string, + claims?: string, + clientId: string, + correlationId: string, + extraParameters?: StringDict, + extraScopesToConsent?: Array, + forceRefresh?: boolean, + loginHint?: string, + prompt?: string, + redirectUri: string, + resourceRequestMethod?: string, + resourceRequestUri?: string, + scopes: Array, + shrNonce?: string, + } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/NativeSignOutRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/NativeSignOutRequest.yml new file mode 100644 index 0000000..ce547ad --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/NativeSignOutRequest.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: NativeSignOutRequest +uid: '@azure/msal-common.NativeSignOutRequest' +package: '@azure/msal-common' +summary: '' +fullName: NativeSignOutRequest +remarks: '' +isDeprecated: false +syntax: | + type NativeSignOutRequest = { + accountId: string, + clientId: string, + correlationId: string, + } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/NetworkManager.yml b/nodejs/docs-ref-autogen/@azure/msal-common/NetworkManager.yml index 2a13b9a..f008eef 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/NetworkManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/NetworkManager.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: NetworkManager remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -33,7 +31,6 @@ methods: package: '@azure/msal-common' summary: Wraps sendPostRequestAsync with necessary preflight and postflight logic remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml index d6659af..eaafa81 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml @@ -5,11 +5,7 @@ package: '@azure/msal-common' summary: Options allowed by network request APIs. fullName: NetworkRequestOptions remarks: '' -isPreview: false isDeprecated: false -syntax: | - type NetworkRequestOptions = { - body?: string, - headers?: Record, - proxyUrl?: string, +syntax: > + type NetworkRequestOptions = { body?: string, headers?: Record } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml index e1fec41..efca279 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: NetworkResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type NetworkResponse = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/OnBehalfOfClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/OnBehalfOfClient.yml index a630dfe..6745475 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/OnBehalfOfClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/OnBehalfOfClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: On-Behalf-Of client fullName: OnBehalfOfClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new OnBehalfOfClient(configuration: ClientConfiguration)' @@ -29,7 +27,6 @@ inheritedProperties: summary: '' fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: Authority' @@ -45,7 +42,6 @@ inheritedProperties: summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' @@ -56,6 +52,25 @@ inheritedProperties: Inherited From [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-common.OnBehalfOfClient.createTokenQueryParameters' + package: '@azure/msal-common' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: |+ + + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseClient.createTokenQueryParameters](xref:@azure/msal-common.BaseClient.createTokenQueryParameters) - name: updateAuthority(Authority) uid: '@azure/msal-common.OnBehalfOfClient.updateAuthority' package: '@azure/msal-common' @@ -63,7 +78,6 @@ inheritedMethods: Updates the authority object of the client. Endpoint discovery must be completed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateAuthority(updatedAuthority: Authority)' @@ -81,7 +95,6 @@ methods: package: '@azure/msal-common' summary: Public API to acquire tokens with on behalf of flow remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/OpenIdConfigResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-common/OpenIdConfigResponse.yml index c198e45..45ece97 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/OpenIdConfigResponse.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/OpenIdConfigResponse.yml @@ -7,7 +7,6 @@ summary: >- needed for authentication and authorization. fullName: OpenIdConfigResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type OpenIdConfigResponse = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml index cd990f5..c440e17 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Password grant parameters fullName: PasswordGrantConstants remarks: '' -isPreview: false isDeprecated: false fields: - name: password diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceCallbackFunction.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceCallbackFunction.yml index b58e95d..30a3d48 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceCallbackFunction.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceCallbackFunction.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: PerformanceCallbackFunction remarks: '' -isPreview: false isDeprecated: false syntax: | type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml index e5c2ca2..a29eb2e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: PerformanceClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: Creates an instance of PerformanceClient, an abstract class containing core performance telemetry logic. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -51,7 +49,6 @@ methods: package: '@azure/msal-common' summary: Registers a callback function to receive performance events. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -64,12 +61,36 @@ methods: return: description: '' type: string + - name: 'addQueueMeasurement(PerformanceEvents, string, number, boolean)' + uid: '@azure/msal-common.PerformanceClient.addQueueMeasurement' + package: '@azure/msal-common' + summary: >- + Adds queue measurement time to QueueMeasurements array for given + correlation ID. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addQueueMeasurement(eventName: PerformanceEvents, + correlationId?: string, queueTime?: number, manuallyCompleted?: boolean) + parameters: + - id: eventName + type: + description: '' + - id: correlationId + type: string + description: '' + - id: queueTime + type: number + description: '' + - id: manuallyCompleted + type: boolean + description: indicator for manually completed queue measurements - name: 'addStaticFields(StaticFields, string)' uid: '@azure/msal-common.PerformanceClient.addStaticFields' package: '@azure/msal-common' summary: Saves extra information to be emitted when the measurements are flushed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addStaticFields(fields: StaticFields, correlationId: string)' @@ -81,12 +102,36 @@ methods: type: string description: |+ + - name: 'calculateQueuedTime(number, number)' + uid: '@azure/msal-common.PerformanceClient.calculateQueuedTime' + package: '@azure/msal-common' + summary: >- + Calculates the difference between current time and time when function was + queued. + + Note: It is possible to have 0 as the queue time if the current time and + the queued time was the same. + remarks: '' + isDeprecated: false + syntax: + content: >- + function calculateQueuedTime(preQueueTime: number, currentTime: number): + number + parameters: + - id: preQueueTime + type: number + description: '' + - id: currentTime + type: number + description: '' + return: + description: '' + type: number - name: discardMeasurements(string) uid: '@azure/msal-common.PerformanceClient.discardMeasurements' package: '@azure/msal-common' summary: Removes measurements for a given correlation id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function discardMeasurements(correlationId: string)' @@ -100,7 +145,6 @@ methods: package: '@azure/msal-common' summary: Emits events to all registered callbacks. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emitEvents(events: PerformanceEvent[], correlationId: string)' @@ -111,7 +155,7 @@ methods: - id: correlationId type: string description: '' - - name: endMeasurement(PerformanceEvent) + - name: 'endMeasurement(PerformanceEvent, IPerformanceMeasurement)' uid: '@azure/msal-common.PerformanceClient.endMeasurement' package: '@azure/msal-common' summary: >- @@ -119,59 +163,92 @@ methods: directly by PerformanceClient classes, as consumers should instead use the function returned by startMeasurement. + + Adds a new field named as "[event name]DurationMs" for sub-measurements, + completes and emits an event + + otherwise. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function endMeasurement(event: PerformanceEvent): PerformanceEvent | - null + function endMeasurement(event: PerformanceEvent, measurement?: + IPerformanceMeasurement): PerformanceEvent | null parameters: - id: event type: description: '' + - id: measurement + type: + description: '' return: description: '' type: | null - - name: 'flushMeasurements(PerformanceEvents, string)' - uid: '@azure/msal-common.PerformanceClient.flushMeasurements' + - name: generateId() + uid: '@azure/msal-common.PerformanceClient.generateId' package: '@azure/msal-common' - summary: >- - Gathers and emits performance events for measurements taked for the given - top-level API and correlation ID. + summary: 'Generates and returns a unique id, typically a guid.' + remarks: '' + isDeprecated: false + syntax: + content: 'function generateId(): string' + return: + description: '' + type: string + - name: getIntFields() + uid: '@azure/msal-common.PerformanceClient.getIntFields' + package: '@azure/msal-common' + summary: |- + Get integral fields. + Override to change the set. + remarks: '' + isDeprecated: false + syntax: + content: 'function getIntFields(): ReadonlySet' + return: + description: '' + type: ReadonlySet<string> + - name: 'getPreQueueTime(PerformanceEvents, string)' + uid: '@azure/msal-common.PerformanceClient.getPreQueueTime' + package: '@azure/msal-common' + summary: Gets map of pre-queue times by correlation Id remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function flushMeasurements(measureName: PerformanceEvents, - correlationId: string) + function getPreQueueTime(eventName: PerformanceEvents, correlationId: + string): number | void parameters: - - id: measureName + - id: eventName type: description: '' - id: correlationId type: string - description: |+ - - - name: generateId() - uid: '@azure/msal-common.PerformanceClient.generateId' + description: '' + return: + description: '' + type: number | void + - name: 'increment(Counters, string)' + uid: '@azure/msal-common.PerformanceClient.increment' package: '@azure/msal-common' - summary: 'Generates and returns a unique id, typically a guid.' + summary: Increment counters to be emitted when the measurements are flushed remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function generateId(): string' - return: - description: '' - type: string + content: 'function increment(counters: Counters, correlationId: string)' + parameters: + - id: counters + type: + description: '' + - id: correlationId + type: string + description: | + correlation identifier - name: removePerformanceCallback(string) uid: '@azure/msal-common.PerformanceClient.removePerformanceCallback' package: '@azure/msal-common' summary: Removes a callback registered with addPerformanceCallback. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -182,6 +259,23 @@ methods: return: description: '' type: boolean + - name: 'setPreQueueTime(PerformanceEvents, string)' + uid: '@azure/msal-common.PerformanceClient.setPreQueueTime' + package: '@azure/msal-common' + summary: Sets pre-queue time by correlation Id + remarks: '' + isDeprecated: false + syntax: + content: >- + function setPreQueueTime(eventName: PerformanceEvents, correlationId?: + string) + parameters: + - id: eventName + type: + description: '' + - id: correlationId + type: string + description: '' - name: 'startMeasurement(PerformanceEvents, string)' uid: '@azure/msal-common.PerformanceClient.startMeasurement' package: '@azure/msal-common' @@ -189,7 +283,6 @@ methods: Starts measuring performance for a given operation. Returns a function that should be used to end the measurement. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -211,8 +304,10 @@ methods: summary: >- Starts and returns an platform-specific implementation of IPerformanceMeasurement. + + Note: this incorrectly-named function will be removed at the next major + version bump. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -228,3 +323,28 @@ methods: return: description: '' type: + - name: 'startPerformanceMeasurement(string, string)' + uid: '@azure/msal-common.PerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-common' + summary: >- + Starts and returns an platform-specific implementation of + IPerformanceMeasurement. + + Note: this function can be changed to abstract at the next major version + bump. + remarks: '' + isDeprecated: false + syntax: + content: >- + function startPerformanceMeasurement(measureName: string, correlationId: + string): IPerformanceMeasurement + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml index 43a4c1f..50ef8d8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -7,26 +7,29 @@ summary: >- request and application. fullName: PerformanceEvent remarks: '' -isPreview: false isDeprecated: false syntax: | - type PerformanceEvent = StaticFields & { - authority: string, - clientId: string, - correlationId: string, - durationMs?: number, - endPageVisibility?: string | null, - errorCode?: string, - eventId: string, - fromCache?: boolean | null, - isNativeBroker?: boolean, - libraryName: string, - libraryVersion: string, - name: PerformanceEvents, - requestId?: string, - startPageVisibility?: string | null, - startTimeMs: number, - status: PerformanceEventStatus, - subErrorCode?: string, - success?: boolean | null, - } + type PerformanceEvent = StaticFields & + Counters & { + authority: string, + cacheLookupPolicy?: number | undefined, + clientId: string, + correlationId: string, + durationMs?: number, + endPageVisibility?: string | null, + errorCode?: string, + eventId: string, + fromCache?: boolean | null, + incompleteSubMeasurements?: Map, + isNativeBroker?: boolean, + libraryName: string, + libraryVersion: string, + name: PerformanceEvents, + queuedTimeMs?: number, + requestId?: string, + startPageVisibility?: string | null, + startTimeMs: number, + status: PerformanceEventStatus, + subErrorCode?: string, + success?: boolean | null, + } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml index 3deafb5..5c9b729 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: State of the performance event. fullName: PerformanceEventStatus remarks: '' -isPreview: false isDeprecated: false fields: - name: NotStarted diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml index 5f9f11a..a2f7308 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml @@ -7,7 +7,6 @@ summary: >- measured by the PerformanceClient. fullName: PerformanceEvents remarks: '' -isPreview: false isDeprecated: false fields: - name: AcquireTokenByBroker @@ -22,6 +21,10 @@ fields: Used to acquire tokens by trading an authorization code against the token endpoint. + - name: AcquireTokenByCodeAsync + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenByCodeAsync' + package: '@azure/msal-common' + summary: '' - name: AcquireTokenByRefreshToken uid: '@azure/msal-common.PerformanceEvents.AcquireTokenByRefreshToken' package: '@azure/msal-common' @@ -34,6 +37,18 @@ fields: uid: '@azure/msal-common.PerformanceEvents.AcquireTokenByRefreshTokenInBroker' package: '@azure/msal-common' summary: acquireTokenByRefreshToken API in BrokerClientApplication (PW-Broker) . + - name: AcquireTokenBySilentIframe + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenBySilentIframe' + package: '@azure/msal-common' + summary: |- + acquireTokenBySilentIframe (msal-browser). + Internal API for acquiring token by silent Iframe + - name: AcquireTokenFromCache + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenFromCache' + package: '@azure/msal-common' + summary: |- + acquireTokenFromCache (msal-browser). + Internal API for acquiring token from cache - name: AcquireTokenPopup uid: '@azure/msal-common.PerformanceEvents.AcquireTokenPopup' package: '@azure/msal-common' @@ -54,6 +69,54 @@ fields: summary: |- acquireTokenSilentAsync (msal-browser). Internal API for acquireTokenSilent. + - name: AuthClientAcquireToken + uid: '@azure/msal-common.PerformanceEvents.AuthClientAcquireToken' + package: '@azure/msal-common' + summary: APIs in Authorization Code Client (msal-common) + - name: AuthClientCreateQueryString + uid: '@azure/msal-common.PerformanceEvents.AuthClientCreateQueryString' + package: '@azure/msal-common' + summary: '' + - name: AuthClientCreateTokenRequestBody + uid: '@azure/msal-common.PerformanceEvents.AuthClientCreateTokenRequestBody' + package: '@azure/msal-common' + summary: '' + - name: AuthClientExecuteTokenRequest + uid: '@azure/msal-common.PerformanceEvents.AuthClientExecuteTokenRequest' + package: '@azure/msal-common' + summary: '' + - name: AuthorityFactoryCreateDiscoveredInstance + uid: >- + @azure/msal-common.PerformanceEvents.AuthorityFactoryCreateDiscoveredInstance + package: '@azure/msal-common' + summary: Authority functions + - name: AuthorityGetCloudDiscoveryMetadataFromNetwork + uid: >- + @azure/msal-common.PerformanceEvents.AuthorityGetCloudDiscoveryMetadataFromNetwork + package: '@azure/msal-common' + summary: '' + - name: AuthorityGetEndpointMetadataFromNetwork + uid: >- + @azure/msal-common.PerformanceEvents.AuthorityGetEndpointMetadataFromNetwork + package: '@azure/msal-common' + summary: '' + - name: AuthorityResolveEndpointsAsync + uid: '@azure/msal-common.PerformanceEvents.AuthorityResolveEndpointsAsync' + package: '@azure/msal-common' + summary: '' + - name: AuthorityUpdateCloudDiscoveryMetadata + uid: '@azure/msal-common.PerformanceEvents.AuthorityUpdateCloudDiscoveryMetadata' + package: '@azure/msal-common' + summary: '' + - name: AuthorityUpdateEndpointMetadata + uid: '@azure/msal-common.PerformanceEvents.AuthorityUpdateEndpointMetadata' + package: '@azure/msal-common' + summary: '' + - name: AuthorityUpdateMetadataWithRegionalInformation + uid: >- + @azure/msal-common.PerformanceEvents.AuthorityUpdateMetadataWithRegionalInformation + package: '@azure/msal-common' + summary: '' - name: BaseClientCreateTokenRequestHeaders uid: '@azure/msal-common.PerformanceEvents.BaseClientCreateTokenRequestHeaders' package: '@azure/msal-common' @@ -84,6 +147,51 @@ fields: summary: |- acquireToken APIs in msal-browser. Used to make an /authorize endpoint call with native brokering enabled. + - name: GetAuthCodeUrl + uid: '@azure/msal-common.PerformanceEvents.GetAuthCodeUrl' + package: '@azure/msal-common' + summary: getAuthCodeUrl API (msal-browser and msal-node). + - name: GetCloudDiscoveryMetadataFromNetworkMeasurement + uid: >- + @azure/msal-common.PerformanceEvents.GetCloudDiscoveryMetadataFromNetworkMeasurement + package: '@azure/msal-common' + summary: '' + - name: GetEndpointMetadataFromNetwork + uid: '@azure/msal-common.PerformanceEvents.GetEndpointMetadataFromNetwork' + package: '@azure/msal-common' + summary: '' + - name: HandleCodeResponseFromHash + uid: '@azure/msal-common.PerformanceEvents.HandleCodeResponseFromHash' + package: '@azure/msal-common' + summary: '' + - name: HandleCodeResponseFromServer + uid: '@azure/msal-common.PerformanceEvents.HandleCodeResponseFromServer' + package: '@azure/msal-common' + summary: Functions from InteractionHandler (msal-browser) + - name: HandleRedirectPromiseMeasurement + uid: '@azure/msal-common.PerformanceEvents.HandleRedirectPromiseMeasurement' + package: '@azure/msal-common' + summary: '' + - name: HandleServerTokenResponse + uid: '@azure/msal-common.PerformanceEvents.HandleServerTokenResponse' + package: '@azure/msal-common' + summary: handleServerTokenResponse API in ResponseHandler (msal-common) + - name: InitializeBaseRequest + uid: '@azure/msal-common.PerformanceEvents.InitializeBaseRequest' + package: '@azure/msal-common' + summary: >- + Internal API for initializing base request in BaseInteractionClient + (msal-browser) + - name: InitializeClientApplication + uid: '@azure/msal-common.PerformanceEvents.InitializeClientApplication' + package: '@azure/msal-common' + summary: '' + - name: InitializeSilentRequest + uid: '@azure/msal-common.PerformanceEvents.InitializeSilentRequest' + package: '@azure/msal-common' + summary: >- + Internal API for initializing silent request in SilentCacheClient + (msal-browser) - name: NativeInteractionClientAcquireToken uid: '@azure/msal-common.PerformanceEvents.NativeInteractionClientAcquireToken' package: '@azure/msal-common' @@ -92,25 +200,73 @@ fields: Used to acquire a token from Native component when native brokering is enabled. + - name: NativeMessageHandlerHandshake + uid: '@azure/msal-common.PerformanceEvents.NativeMessageHandlerHandshake' + package: '@azure/msal-common' + summary: '' + - name: PopTokenGenerateCnf + uid: '@azure/msal-common.PerformanceEvents.PopTokenGenerateCnf' + package: '@azure/msal-common' + summary: Generate functions in PopTokenGenerator (msal-common) + - name: PopTokenGenerateKid + uid: '@azure/msal-common.PerformanceEvents.PopTokenGenerateKid' + package: '@azure/msal-common' + summary: '' - name: RefreshTokenClientAcquireToken uid: '@azure/msal-common.PerformanceEvents.RefreshTokenClientAcquireToken' package: '@azure/msal-common' summary: 'Time taken for acquiring refresh token , records RT size' + - name: RefreshTokenClientAcquireTokenByRefreshToken + uid: >- + @azure/msal-common.PerformanceEvents.RefreshTokenClientAcquireTokenByRefreshToken + package: '@azure/msal-common' + summary: acquireTokenByRefreshToken API in RefreshTokenClient (msal-common). - name: RefreshTokenClientAcquireTokenWithCachedRefreshToken uid: >- @azure/msal-common.PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken package: '@azure/msal-common' summary: Time taken for acquiring cached refresh token + - name: RefreshTokenClientCreateTokenRequestBody + uid: >- + @azure/msal-common.PerformanceEvents.RefreshTokenClientCreateTokenRequestBody + package: '@azure/msal-common' + summary: >- + Helper function to create token request body in RefreshTokenClient + (msal-common). - name: RefreshTokenClientExecuteTokenRequest uid: '@azure/msal-common.PerformanceEvents.RefreshTokenClientExecuteTokenRequest' package: '@azure/msal-common' summary: Time spent on the network for refresh token acquisition + - name: RegionDiscoveryDetectRegion + uid: '@azure/msal-common.PerformanceEvents.RegionDiscoveryDetectRegion' + package: '@azure/msal-common' + summary: Region Discovery functions + - name: RegionDiscoveryGetCurrentVersion + uid: '@azure/msal-common.PerformanceEvents.RegionDiscoveryGetCurrentVersion' + package: '@azure/msal-common' + summary: '' + - name: RegionDiscoveryGetRegionFromIMDS + uid: '@azure/msal-common.PerformanceEvents.RegionDiscoveryGetRegionFromIMDS' + package: '@azure/msal-common' + summary: '' - name: SilentCacheClientAcquireToken uid: '@azure/msal-common.PerformanceEvents.SilentCacheClientAcquireToken' package: '@azure/msal-common' summary: |- acquireToken API in the SilentCacheClient class (msal-browser). Used to read access tokens from the cache. + - name: SilentHandlerInitiateAuthRequest + uid: '@azure/msal-common.PerformanceEvents.SilentHandlerInitiateAuthRequest' + package: '@azure/msal-common' + summary: SilentHandler + - name: SilentHandlerLoadFrame + uid: '@azure/msal-common.PerformanceEvents.SilentHandlerLoadFrame' + package: '@azure/msal-common' + summary: '' + - name: SilentHandlerMonitorIframeForHash + uid: '@azure/msal-common.PerformanceEvents.SilentHandlerMonitorIframeForHash' + package: '@azure/msal-common' + summary: '' - name: SilentIframeClientAcquireToken uid: '@azure/msal-common.PerformanceEvents.SilentIframeClientAcquireToken' package: '@azure/msal-common' @@ -119,6 +275,10 @@ fields: Used to acquire a new set of tokens from the authorize endpoint in a hidden iframe. + - name: SilentIframeClientTokenHelper + uid: '@azure/msal-common.PerformanceEvents.SilentIframeClientTokenHelper' + package: '@azure/msal-common' + summary: Helper function in SilentIframeClient class (msal-browser). - name: SilentRefreshClientAcquireToken uid: '@azure/msal-common.PerformanceEvents.SilentRefreshClientAcquireToken' package: '@azure/msal-common' @@ -135,6 +295,16 @@ fields: Used to silently acquire an authorization code and set of tokens using a hidden iframe. + - name: StandardInteractionClientCreateAuthCodeClient + uid: >- + @azure/msal-common.PerformanceEvents.StandardInteractionClientCreateAuthCodeClient + package: '@azure/msal-common' + summary: Helper functions in StandardInteractionClient class (msal-browser) + - name: StandardInteractionClientGetClientConfiguration + uid: >- + @azure/msal-common.PerformanceEvents.StandardInteractionClientGetClientConfiguration + package: '@azure/msal-common' + summary: '' - name: StandardInteractionClientGetDiscoveredAuthority uid: >- @azure/msal-common.PerformanceEvents.StandardInteractionClientGetDiscoveredAuthority @@ -144,3 +314,26 @@ fields: (msal-browser). Used to load authority metadata for a request. + - name: StandardInteractionClientInitializeAuthorizationCodeRequest + uid: >- + @azure/msal-common.PerformanceEvents.StandardInteractionClientInitializeAuthorizationCodeRequest + package: '@azure/msal-common' + summary: '' + - name: StandardInteractionClientInitializeAuthorizationRequest + uid: >- + @azure/msal-common.PerformanceEvents.StandardInteractionClientInitializeAuthorizationRequest + package: '@azure/msal-common' + summary: '' + - name: UpdateCloudDiscoveryMetadataMeasurement + uid: >- + @azure/msal-common.PerformanceEvents.UpdateCloudDiscoveryMetadataMeasurement + package: '@azure/msal-common' + summary: '' + - name: UpdateTokenEndpointAuthority + uid: '@azure/msal-common.PerformanceEvents.UpdateTokenEndpointAuthority' + package: '@azure/msal-common' + summary: '' + - name: UsernamePasswordClientAcquireToken + uid: '@azure/msal-common.PerformanceEvents.UsernamePasswordClientAcquireToken' + package: '@azure/msal-common' + summary: '' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml index c16ad9c..ee977dc 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Persistent cache keys MSAL which stay while user is logged in. fullName: PersistentCacheKeys remarks: '' -isPreview: false isDeprecated: false fields: - name: ACTIVE_ACCOUNT diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PkceCodes.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PkceCodes.yml index 7de9a33..d02c71b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/PkceCodes.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PkceCodes.yml @@ -8,7 +8,6 @@ summary: |- challenge and verifier pairs fullName: PkceCodes remarks: '' -isPreview: false isDeprecated: false syntax: | type PkceCodes = { challenge: string, verifier: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PopTokenGenerator.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PopTokenGenerator.yml index adfddc4..88e8456 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/PopTokenGenerator.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PopTokenGenerator.yml @@ -5,23 +5,26 @@ package: '@azure/msal-common' summary: '' fullName: PopTokenGenerator remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: PopTokenGenerator(ICrypto) + - name: 'PopTokenGenerator(ICrypto, IPerformanceClient)' uid: '@azure/msal-common.PopTokenGenerator.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new PopTokenGenerator(cryptoUtils: ICrypto)' + content: >- + new PopTokenGenerator(cryptoUtils: ICrypto, performanceClient?: + IPerformanceClient) parameters: - id: cryptoUtils type: description: '' + - id: performanceClient + type: + description: '' methods: - name: generateCnf(SignedHttpRequestParameters) uid: '@azure/msal-common.PopTokenGenerator.generateCnf' @@ -33,7 +36,6 @@ methods: and returns an object containing the keyid, the full req_cnf string and the req_cnf string hash remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -51,7 +53,6 @@ methods: package: '@azure/msal-common' summary: Generates key_id for a SHR token request remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -69,7 +70,6 @@ methods: package: '@azure/msal-common' summary: Utility function to generate the signed JWT for an access_token remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -96,7 +96,6 @@ methods: package: '@azure/msal-common' summary: Signs the POP access_token with the local generated key-pair remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/PreQueueEvent.yml b/nodejs/docs-ref-autogen/@azure/msal-common/PreQueueEvent.yml new file mode 100644 index 0000000..9d5442b --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/PreQueueEvent.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: PreQueueEvent +uid: '@azure/msal-common.PreQueueEvent' +package: '@azure/msal-common' +summary: '' +fullName: PreQueueEvent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: '@azure/msal-common.PreQueueEvent.name' + package: '@azure/msal-common' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: PerformanceEvents' + return: + description: '' + type: + - name: time + uid: '@azure/msal-common.PreQueueEvent.time' + package: '@azure/msal-common' + summary: '' + fullName: time + remarks: '' + isDeprecated: false + syntax: + content: 'time: number' + return: + description: '' + type: number diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml index e71dbfa..c2d32ca 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Protocol modes supported by MSAL. fullName: ProtocolMode remarks: '' -isPreview: false isDeprecated: false fields: - name: AAD diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml index 0012bd8..bd6cc07 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Class which provides helpers for OAuth 2.0 protocol specific values fullName: ProtocolUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-common' summary: Generates the state value used by the common library. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -38,7 +36,6 @@ methods: Parses the state into the RequestStateObject, which contains the LibraryState info and the state passed by the user. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -60,7 +57,6 @@ methods: package: '@azure/msal-common' summary: 'Appends user state with random guid, or returns random guid.' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/QueueMeasurement.yml b/nodejs/docs-ref-autogen/@azure/msal-common/QueueMeasurement.yml new file mode 100644 index 0000000..26362d2 --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/QueueMeasurement.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: QueueMeasurement +uid: '@azure/msal-common.QueueMeasurement' +package: '@azure/msal-common' +summary: Queue measurement type +fullName: QueueMeasurement +remarks: '' +isDeprecated: false +syntax: | + type QueueMeasurement = { + eventName: PerformanceEvents, + manuallyCompleted?: boolean, + queueTime: number, + } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenCache.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenCache.yml index fa4abc0..3524005 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: RefreshTokenCache remarks: '' -isPreview: false isDeprecated: false syntax: | type RefreshTokenCache = Record diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenClient.yml index a88ad5b..401acfd 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: OAuth2.0 refresh token client fullName: RefreshTokenClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,7 +32,6 @@ inheritedProperties: summary: '' fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: Authority' @@ -50,7 +47,6 @@ inheritedProperties: summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' @@ -61,6 +57,25 @@ inheritedProperties: Inherited From [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-common.RefreshTokenClient.createTokenQueryParameters' + package: '@azure/msal-common' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: |+ + + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseClient.createTokenQueryParameters](xref:@azure/msal-common.BaseClient.createTokenQueryParameters) - name: updateAuthority(Authority) uid: '@azure/msal-common.RefreshTokenClient.updateAuthority' package: '@azure/msal-common' @@ -68,7 +83,6 @@ inheritedMethods: Updates the authority object of the client. Endpoint discovery must be completed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateAuthority(updatedAuthority: Authority)' @@ -86,7 +100,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -106,7 +119,6 @@ methods: Gets cached refresh token and attaches to request, then calls acquireToken API remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml index 3466e22..f0ee7dc 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml @@ -21,7 +21,6 @@ summary: | } fullName: RefreshTokenEntity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -31,7 +30,6 @@ properties: summary: '' fullName: familyId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'familyId?: string' @@ -45,7 +43,6 @@ inheritedProperties: summary: '' fullName: clientId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientId: string' @@ -61,7 +58,6 @@ inheritedProperties: summary: '' fullName: credentialType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'credentialType: CredentialType' @@ -77,7 +73,6 @@ inheritedProperties: summary: '' fullName: environment remarks: '' - isPreview: false isDeprecated: false syntax: content: 'environment: string' @@ -93,7 +88,6 @@ inheritedProperties: summary: '' fullName: homeAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'homeAccountId: string' @@ -109,7 +103,6 @@ inheritedProperties: summary: '' fullName: keyId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'keyId?: string' @@ -125,7 +118,6 @@ inheritedProperties: summary: '' fullName: realm remarks: '' - isPreview: false isDeprecated: false syntax: content: 'realm?: string' @@ -141,7 +133,6 @@ inheritedProperties: summary: '' fullName: requestedClaimsHash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestedClaimsHash?: string' @@ -157,7 +148,6 @@ inheritedProperties: summary: '' fullName: secret remarks: '' - isPreview: false isDeprecated: false syntax: content: 'secret: string' @@ -173,7 +163,6 @@ inheritedProperties: summary: '' fullName: target remarks: '' - isPreview: false isDeprecated: false syntax: content: 'target?: string' @@ -189,7 +178,6 @@ inheritedProperties: summary: '' fullName: tokenType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tokenType?: AuthenticationScheme' @@ -205,7 +193,6 @@ inheritedProperties: summary: '' fullName: userAssertionHash remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userAssertionHash?: string' @@ -223,7 +210,6 @@ inheritedMethods: Generate Account Id key component as per the schema: - remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAccountId(): string' @@ -243,7 +229,6 @@ inheritedMethods: -\----- remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -292,7 +277,6 @@ inheritedMethods: Generate Credential Id key component as per the schema: -- remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCredentialId(): string' @@ -307,7 +291,6 @@ inheritedMethods: package: '@azure/msal-common' summary: generates credential key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCredentialKey(): string' @@ -322,7 +305,6 @@ inheritedMethods: package: '@azure/msal-common' summary: 'Generate target key component as per schema: ' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateTarget(): string' @@ -337,7 +319,6 @@ inheritedMethods: package: '@azure/msal-common' summary: returns the type of the cache (in this case credential) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateType(): number' @@ -352,7 +333,6 @@ inheritedMethods: package: '@azure/msal-common' summary: helper function to return `CredentialType` remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function getCredentialType(key: string): string' @@ -373,7 +353,6 @@ methods: package: '@azure/msal-common' summary: Create RefreshTokenEntity remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -407,7 +386,6 @@ methods: package: '@azure/msal-common' summary: 'Validates an entity: checks for all expected params' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function isRefreshTokenEntity(entity: object): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscovery.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscovery.yml deleted file mode 100644 index cf35858..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscovery.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: RegionDiscovery -uid: '@azure/msal-common.RegionDiscovery' -package: '@azure/msal-common' -summary: '' -fullName: RegionDiscovery -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: RegionDiscovery(INetworkModule) - uid: '@azure/msal-common.RegionDiscovery.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new RegionDiscovery(networkInterface: INetworkModule)' - parameters: - - id: networkInterface - type: - description: '' -methods: - - name: 'detectRegion(string | undefined, RegionDiscoveryMetadata, string)' - uid: '@azure/msal-common.RegionDiscovery.detectRegion' - package: '@azure/msal-common' - summary: Detect the region from the application's environment. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function detectRegion(environmentRegion: string | undefined, - regionDiscoveryMetadata: RegionDiscoveryMetadata, proxyUrl: string): - Promise - parameters: - - id: environmentRegion - type: string | undefined - description: '' - - id: regionDiscoveryMetadata - type: - description: '' - - id: proxyUrl - type: string - description: '' - return: - description: Promise - type: Promise<string | null> diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoveryMetadata.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoveryMetadata.yml index 54bd869..8ab5f3b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoveryMetadata.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoveryMetadata.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: RegionDiscoveryMetadata remarks: '' -isPreview: false isDeprecated: false syntax: | type RegionDiscoveryMetadata = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoveryOutcomes.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoveryOutcomes.yml index c8f34d8..e23ce5a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoveryOutcomes.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoveryOutcomes.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Region Discovery Outcomes fullName: RegionDiscoveryOutcomes remarks: '' -isPreview: false isDeprecated: false fields: - name: AUTO_DETECTION_REQUESTED_FAILED diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoverySources.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoverySources.yml index bd672d7..eb696be 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoverySources.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/RegionDiscoverySources.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Region Discovery Sources fullName: RegionDiscoverySources remarks: '' -isPreview: false isDeprecated: false fields: - name: ENVIRONMENT_VARIABLE diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ReqCnf.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ReqCnf.yml index ce9c1f7..e781089 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ReqCnf.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ReqCnf.yml @@ -14,7 +14,6 @@ summary: >- - uhw: hardware storage fullName: ReqCnf remarks: '' -isPreview: false isDeprecated: false syntax: | type ReqCnf = { kid: string, xms_ksl: KeyLocation } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ReqCnfData.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ReqCnfData.yml index 315d60d..cefdfc8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ReqCnfData.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ReqCnfData.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ReqCnfData remarks: '' -isPreview: false isDeprecated: false syntax: | type ReqCnfData = { kid: string, reqCnfHash: string, reqCnfString: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml deleted file mode 100644 index e85f8d0..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml +++ /dev/null @@ -1,618 +0,0 @@ -### YamlMime:TSType -name: RequestParameterBuilder -uid: '@azure/msal-common.RequestParameterBuilder' -package: '@azure/msal-common' -summary: '' -fullName: RequestParameterBuilder -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: RequestParameterBuilder() - uid: '@azure/msal-common.RequestParameterBuilder.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new RequestParameterBuilder() -methods: - - name: addApplicationTelemetry(ApplicationTelemetry) - uid: '@azure/msal-common.RequestParameterBuilder.addApplicationTelemetry' - package: '@azure/msal-common' - summary: Add client telemetry parameters - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addApplicationTelemetry(appTelemetry: ApplicationTelemetry)' - parameters: - - id: appTelemetry - type: - description: |+ - - - name: addAuthorizationCode(string) - uid: '@azure/msal-common.RequestParameterBuilder.addAuthorizationCode' - package: '@azure/msal-common' - summary: add the `authorization_code` passed by the user to exchange for a token - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addAuthorizationCode(code: string)' - parameters: - - id: code - type: string - description: |+ - - - name: addCcsOid(ClientInfo) - uid: '@azure/msal-common.RequestParameterBuilder.addCcsOid' - package: '@azure/msal-common' - summary: Adds the CCS (Cache Credential Service) query parameter for account object - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addCcsOid(clientInfo: ClientInfo)' - parameters: - - id: clientInfo - type: - description: '' - - name: addCcsUpn(string) - uid: '@azure/msal-common.RequestParameterBuilder.addCcsUpn' - package: '@azure/msal-common' - summary: Adds the CCS (Cache Credential Service) query parameter for login_hint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addCcsUpn(loginHint: string)' - parameters: - - id: loginHint - type: string - description: |+ - - - name: 'addClaims(string, Array)' - uid: '@azure/msal-common.RequestParameterBuilder.addClaims' - package: '@azure/msal-common' - summary: add claims - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addClaims(claims?: string, clientCapabilities?: Array)' - parameters: - - id: claims - type: string - description: |+ - - - id: clientCapabilities - type: Array<string> - description: '' - - name: addClientAssertion(string) - uid: '@azure/msal-common.RequestParameterBuilder.addClientAssertion' - package: '@azure/msal-common' - summary: add clientAssertion for confidential client flows - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addClientAssertion(clientAssertion: string)' - parameters: - - id: clientAssertion - type: string - description: |+ - - - name: addClientAssertionType(string) - uid: '@azure/msal-common.RequestParameterBuilder.addClientAssertionType' - package: '@azure/msal-common' - summary: add clientAssertionType for confidential client flows - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addClientAssertionType(clientAssertionType: string)' - parameters: - - id: clientAssertionType - type: string - description: |+ - - - name: 'addClientCapabilitiesToClaims(string, Array)' - uid: '@azure/msal-common.RequestParameterBuilder.addClientCapabilitiesToClaims' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addClientCapabilitiesToClaims(claims?: string, - clientCapabilities?: Array): string - parameters: - - id: claims - type: string - description: '' - - id: clientCapabilities - type: Array<string> - description: '' - return: - description: '' - type: string - - name: addClientId(string) - uid: '@azure/msal-common.RequestParameterBuilder.addClientId' - package: '@azure/msal-common' - summary: add clientId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addClientId(clientId: string)' - parameters: - - id: clientId - type: string - description: |+ - - - name: addClientInfo() - uid: '@azure/msal-common.RequestParameterBuilder.addClientInfo' - package: '@azure/msal-common' - summary: add client info - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function addClientInfo() - - name: addClientSecret(string) - uid: '@azure/msal-common.RequestParameterBuilder.addClientSecret' - package: '@azure/msal-common' - summary: add client_secret - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addClientSecret(clientSecret: string)' - parameters: - - id: clientSecret - type: string - description: |+ - - - name: 'addCodeChallengeParams(string, string)' - uid: '@azure/msal-common.RequestParameterBuilder.addCodeChallengeParams' - package: '@azure/msal-common' - summary: |- - add code_challenge and code_challenge_method - - throw if either of them are not passed - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addCodeChallengeParams(codeChallenge: string, - codeChallengeMethod: string) - parameters: - - id: codeChallenge - type: string - description: '' - - id: codeChallengeMethod - type: string - description: |+ - - - name: addCodeVerifier(string) - uid: '@azure/msal-common.RequestParameterBuilder.addCodeVerifier' - package: '@azure/msal-common' - summary: add the `code_verifier` passed by the user to exchange for a token - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addCodeVerifier(codeVerifier: string)' - parameters: - - id: codeVerifier - type: string - description: |+ - - - name: addCorrelationId(string) - uid: '@azure/msal-common.RequestParameterBuilder.addCorrelationId' - package: '@azure/msal-common' - summary: add correlationId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addCorrelationId(correlationId: string)' - parameters: - - id: correlationId - type: string - description: |+ - - - name: addDeviceCode(string) - uid: '@azure/msal-common.RequestParameterBuilder.addDeviceCode' - package: '@azure/msal-common' - summary: add the `authorization_code` passed by the user to exchange for a token - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addDeviceCode(code: string)' - parameters: - - id: code - type: string - description: |+ - - - name: addDomainHint(string) - uid: '@azure/msal-common.RequestParameterBuilder.addDomainHint' - package: '@azure/msal-common' - summary: add domain_hint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addDomainHint(domainHint: string)' - parameters: - - id: domainHint - type: string - description: |+ - - - name: addExtraQueryParameters(StringDict) - uid: '@azure/msal-common.RequestParameterBuilder.addExtraQueryParameters' - package: '@azure/msal-common' - summary: add extraQueryParams - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addExtraQueryParameters(eQparams: StringDict)' - parameters: - - id: eQparams - type: - description: |+ - - - name: addGrantType(string) - uid: '@azure/msal-common.RequestParameterBuilder.addGrantType' - package: '@azure/msal-common' - summary: add grant type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addGrantType(grantType: string)' - parameters: - - id: grantType - type: string - description: |+ - - - name: addIdTokenHint(string) - uid: '@azure/msal-common.RequestParameterBuilder.addIdTokenHint' - package: '@azure/msal-common' - summary: add id_token_hint to logout request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addIdTokenHint(idTokenHint: string)' - parameters: - - id: idTokenHint - type: string - description: |+ - - - name: addLibraryInfo(LibraryInfo) - uid: '@azure/msal-common.RequestParameterBuilder.addLibraryInfo' - package: '@azure/msal-common' - summary: add library info query params - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addLibraryInfo(libraryInfo: LibraryInfo)' - parameters: - - id: libraryInfo - type: - description: |+ - - - name: addLoginHint(string) - uid: '@azure/msal-common.RequestParameterBuilder.addLoginHint' - package: '@azure/msal-common' - summary: add login_hint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addLoginHint(loginHint: string)' - parameters: - - id: loginHint - type: string - description: |+ - - - name: addLogoutHint(string) - uid: '@azure/msal-common.RequestParameterBuilder.addLogoutHint' - package: '@azure/msal-common' - summary: >- - Adds logout_hint parameter for "silent" logout which prevent server - account picker - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addLogoutHint(logoutHint: string)' - parameters: - - id: logoutHint - type: string - description: '' - - name: addNativeBroker() - uid: '@azure/msal-common.RequestParameterBuilder.addNativeBroker' - package: '@azure/msal-common' - summary: Add flag to indicate STS should attempt to use WAM if available - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function addNativeBroker() - - name: addNonce(string) - uid: '@azure/msal-common.RequestParameterBuilder.addNonce' - package: '@azure/msal-common' - summary: add nonce - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addNonce(nonce: string)' - parameters: - - id: nonce - type: string - description: |+ - - - name: addOboAssertion(string) - uid: '@azure/msal-common.RequestParameterBuilder.addOboAssertion' - package: '@azure/msal-common' - summary: add OBO assertion for confidential client flows - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addOboAssertion(oboAssertion: string)' - parameters: - - id: oboAssertion - type: string - description: '' - - name: addPassword(string) - uid: '@azure/msal-common.RequestParameterBuilder.addPassword' - package: '@azure/msal-common' - summary: adds `password` for Password Grant flow - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addPassword(password: string)' - parameters: - - id: password - type: string - description: |+ - - - name: addPopToken(string) - uid: '@azure/msal-common.RequestParameterBuilder.addPopToken' - package: '@azure/msal-common' - summary: add pop_jwk to query params - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addPopToken(cnfString: string)' - parameters: - - id: cnfString - type: string - description: |+ - - - name: addPostLogoutRedirectUri(string) - uid: '@azure/msal-common.RequestParameterBuilder.addPostLogoutRedirectUri' - package: '@azure/msal-common' - summary: add post logout redirectUri - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addPostLogoutRedirectUri(redirectUri: string)' - parameters: - - id: redirectUri - type: string - description: |+ - - - name: addPrompt(string) - uid: '@azure/msal-common.RequestParameterBuilder.addPrompt' - package: '@azure/msal-common' - summary: add prompt - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addPrompt(prompt: string)' - parameters: - - id: prompt - type: string - description: |+ - - - name: addRedirectUri(string) - uid: '@azure/msal-common.RequestParameterBuilder.addRedirectUri' - package: '@azure/msal-common' - summary: add redirect_uri - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addRedirectUri(redirectUri: string)' - parameters: - - id: redirectUri - type: string - description: |+ - - - name: addRefreshToken(string) - uid: '@azure/msal-common.RequestParameterBuilder.addRefreshToken' - package: '@azure/msal-common' - summary: add the `refreshToken` passed by the user - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addRefreshToken(refreshToken: string)' - parameters: - - id: refreshToken - type: string - description: |+ - - - name: addRequestTokenUse(string) - uid: '@azure/msal-common.RequestParameterBuilder.addRequestTokenUse' - package: '@azure/msal-common' - summary: add grant type - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addRequestTokenUse(tokenUse: string)' - parameters: - - id: tokenUse - type: string - description: '' - - name: addResponseMode(ResponseMode) - uid: '@azure/msal-common.RequestParameterBuilder.addResponseMode' - package: '@azure/msal-common' - summary: add response_mode. defaults to query. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addResponseMode(responseMode?: ResponseMode)' - parameters: - - id: responseMode - type: - description: |+ - - - name: addResponseTypeCode() - uid: '@azure/msal-common.RequestParameterBuilder.addResponseTypeCode' - package: '@azure/msal-common' - summary: add response_type = code - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function addResponseTypeCode() - - name: addResponseTypeForTokenAndIdToken() - uid: >- - @azure/msal-common.RequestParameterBuilder.addResponseTypeForTokenAndIdToken - package: '@azure/msal-common' - summary: add response_type = token id_token - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function addResponseTypeForTokenAndIdToken() - - name: 'addScopes(string[], boolean)' - uid: '@azure/msal-common.RequestParameterBuilder.addScopes' - package: '@azure/msal-common' - summary: >- - add scopes. set addOidcScopes to false to prevent default scopes in - non-user scenarios - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addScopes(scopes: string[], addOidcScopes?: boolean)' - parameters: - - id: scopes - type: 'string[]' - description: '' - - id: addOidcScopes - type: boolean - description: |+ - - - name: addServerTelemetry(ServerTelemetryManager) - uid: '@azure/msal-common.RequestParameterBuilder.addServerTelemetry' - package: '@azure/msal-common' - summary: add server telemetry fields - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function addServerTelemetry(serverTelemetryManager: - ServerTelemetryManager) - parameters: - - id: serverTelemetryManager - type: - description: |+ - - - name: addSid(string) - uid: '@azure/msal-common.RequestParameterBuilder.addSid' - package: '@azure/msal-common' - summary: add sid - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addSid(sid: string)' - parameters: - - id: sid - type: string - description: |+ - - - name: addSshJwk(string) - uid: '@azure/msal-common.RequestParameterBuilder.addSshJwk' - package: '@azure/msal-common' - summary: add SSH JWK and key ID to query params - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addSshJwk(sshJwkString: string)' - parameters: - - id: sshJwkString - type: string - description: '' - - name: addState(string) - uid: '@azure/msal-common.RequestParameterBuilder.addState' - package: '@azure/msal-common' - summary: add state - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addState(state: string)' - parameters: - - id: state - type: string - description: |+ - - - name: addThrottling() - uid: '@azure/msal-common.RequestParameterBuilder.addThrottling' - package: '@azure/msal-common' - summary: Adds parameter that indicates to the server that throttling is supported - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function addThrottling() - - name: addUsername(string) - uid: '@azure/msal-common.RequestParameterBuilder.addUsername' - package: '@azure/msal-common' - summary: adds `username` for Password Grant flow - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function addUsername(username: string)' - parameters: - - id: username - type: string - description: |+ - - - name: createQueryString() - uid: '@azure/msal-common.RequestParameterBuilder.createQueryString' - package: '@azure/msal-common' - summary: Utility to create a URL from the params map - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function createQueryString(): string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml index 0f75105..81af331 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml @@ -7,7 +7,6 @@ summary: >- the authorize request. fullName: RequestStateObject remarks: '' -isPreview: false isDeprecated: false syntax: | type RequestStateObject = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml index 8780688..1377301 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Type representing a unique request thumbprint. fullName: RequestThumbprint remarks: '' -isPreview: false isDeprecated: false syntax: | type RequestThumbprint = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RequestValidator.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RequestValidator.yml deleted file mode 100644 index e2a3f96..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RequestValidator.yml +++ /dev/null @@ -1,108 +0,0 @@ -### YamlMime:TSType -name: RequestValidator -uid: '@azure/msal-common.RequestValidator' -package: '@azure/msal-common' -summary: Validates server consumable params from the "request" objects -fullName: RequestValidator -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'sanitizeEQParams(StringDict, Map)' - uid: '@azure/msal-common.RequestValidator.sanitizeEQParams' - package: '@azure/msal-common' - summary: >- - Removes unnecessary or duplicate query parameters from - extraQueryParameters - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function sanitizeEQParams(eQParams: StringDict, queryParams: - Map): StringDict - parameters: - - id: eQParams - type: - description: '' - - id: queryParams - type: 'Map<string, string>' - description: '' - return: - description: '' - type: - - name: validateClaims(string) - uid: '@azure/msal-common.RequestValidator.validateClaims' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function validateClaims(claims: string)' - parameters: - - id: claims - type: string - description: '' - - name: validateCodeChallengeMethod(string) - uid: '@azure/msal-common.RequestValidator.validateCodeChallengeMethod' - package: '@azure/msal-common' - summary: Utility to validate code_challenge_method - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function validateCodeChallengeMethod(codeChallengeMethod: string)' - parameters: - - id: codeChallengeMethod - type: string - description: |+ - - - name: 'validateCodeChallengeParams(string, string)' - uid: '@azure/msal-common.RequestValidator.validateCodeChallengeParams' - package: '@azure/msal-common' - summary: Utility to validate code_challenge and code_challenge_method - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function validateCodeChallengeParams(codeChallenge: string, - codeChallengeMethod: string) - parameters: - - id: codeChallenge - type: string - description: '' - - id: codeChallengeMethod - type: string - description: |+ - - - name: validatePrompt(string) - uid: '@azure/msal-common.RequestValidator.validatePrompt' - package: '@azure/msal-common' - summary: Utility to validate prompt sent by the user in the request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function validatePrompt(prompt: string)' - parameters: - - id: prompt - type: string - description: |+ - - - name: validateRedirectUri(string) - uid: '@azure/msal-common.RequestValidator.validateRedirectUri' - package: '@azure/msal-common' - summary: Utility to check if the `redirectUri` in the request is a non-null value - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function validateRedirectUri(redirectUri: string)' - parameters: - - id: redirectUri - type: string - description: |+ - diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ResponseCodes.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ResponseCodes.yml index da5543d..3e47c8f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ResponseCodes.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ResponseCodes.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Response codes fullName: ResponseCodes remarks: '' -isPreview: false isDeprecated: false fields: - name: httpSuccess diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ResponseHandler.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ResponseHandler.yml deleted file mode 100644 index 97547e5..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ResponseHandler.yml +++ /dev/null @@ -1,189 +0,0 @@ -### YamlMime:TSType -name: ResponseHandler -uid: '@azure/msal-common.ResponseHandler' -package: '@azure/msal-common' -summary: Class that handles response parsing. -fullName: ResponseHandler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - ResponseHandler(string, CacheManager, ICrypto, Logger, - ISerializableTokenCache | null, ICachePlugin | null) - uid: '@azure/msal-common.ResponseHandler.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new ResponseHandler(clientId: string, cacheStorage: CacheManager, - cryptoObj: ICrypto, logger: Logger, serializableCache: - ISerializableTokenCache | null, persistencePlugin: ICachePlugin | null) - parameters: - - id: clientId - type: string - description: '' - - id: cacheStorage - type: - description: '' - - id: cryptoObj - type: - description: '' - - id: logger - type: - description: '' - - id: serializableCache - type: | null - description: '' - - id: persistencePlugin - type: | null - description: '' -methods: - - name: >- - generateAuthenticationResult(ICrypto, Authority, CacheRecord, boolean, - BaseAuthRequest, AuthToken, RequestStateObject, string, string) - uid: '@azure/msal-common.ResponseHandler.generateAuthenticationResult' - package: '@azure/msal-common' - summary: > - Creates an @AuthenticationResult from @CacheRecord , @IdToken , and a - boolean that states whether or not the result is from cache. - - Optionally takes a state string that is set as-is in the response. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateAuthenticationResult(cryptoObj: ICrypto, - authority: Authority, cacheRecord: CacheRecord, fromTokenCache: boolean, - request: BaseAuthRequest, idTokenObj?: AuthToken, requestState?: - RequestStateObject, code?: string, requestId?: string): - Promise - parameters: - - id: cryptoObj - type: - description: '' - - id: authority - type: - description: '' - - id: cacheRecord - type: - description: '' - - id: fromTokenCache - type: boolean - description: '' - - id: request - type: - description: '' - - id: idTokenObj - type: - description: '' - - id: requestState - type: - description: '' - - id: code - type: string - description: '' - - id: requestId - type: string - description: '' - return: - description: '' - type: Promise<> - - name: >- - handleServerTokenResponse(ServerAuthorizationTokenResponse, Authority, - number, BaseAuthRequest, AuthorizationCodePayload, string, boolean, - boolean, string) - uid: '@azure/msal-common.ResponseHandler.handleServerTokenResponse' - package: '@azure/msal-common' - summary: >- - Returns a constructed token response based on given string. Also manages - the cache updates and cleanups. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleServerTokenResponse(serverTokenResponse: - ServerAuthorizationTokenResponse, authority: Authority, reqTimestamp: - number, request: BaseAuthRequest, authCodePayload?: - AuthorizationCodePayload, userAssertionHash?: string, - handlingRefreshTokenResponse?: boolean, forceCacheRefreshTokenResponse?: - boolean, serverRequestId?: string): Promise - parameters: - - id: serverTokenResponse - type: - description: '' - - id: authority - type: - description: |+ - - - id: reqTimestamp - type: number - description: '' - - id: request - type: - description: '' - - id: authCodePayload - type: - description: '' - - id: userAssertionHash - type: string - description: '' - - id: handlingRefreshTokenResponse - type: boolean - description: '' - - id: forceCacheRefreshTokenResponse - type: boolean - description: '' - - id: serverRequestId - type: string - description: '' - return: - description: '' - type: Promise<> - - name: >- - validateServerAuthorizationCodeResponse(ServerAuthorizationCodeResponse, - string, ICrypto) - uid: '@azure/msal-common.ResponseHandler.validateServerAuthorizationCodeResponse' - package: '@azure/msal-common' - summary: Function which validates server authorization code response. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function validateServerAuthorizationCodeResponse(serverResponseHash: - ServerAuthorizationCodeResponse, cachedState: string, cryptoObj: - ICrypto) - parameters: - - id: serverResponseHash - type: - description: '' - - id: cachedState - type: string - description: '' - - id: cryptoObj - type: - description: |+ - - - name: validateTokenResponse(ServerAuthorizationTokenResponse) - uid: '@azure/msal-common.ResponseHandler.validateTokenResponse' - package: '@azure/msal-common' - summary: Function which validates server authorization token response. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function validateTokenResponse(serverResponse: - ServerAuthorizationTokenResponse) - parameters: - - id: serverResponse - type: - description: |+ - diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ResponseMode.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ResponseMode.yml index 8ddf613..9317b12 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ResponseMode.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ResponseMode.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: allowed values for response_mode fullName: ResponseMode remarks: '' -isPreview: false isDeprecated: false fields: - name: FORM_POST diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/SSOTypes.yml b/nodejs/docs-ref-autogen/@azure/msal-common/SSOTypes.yml index ba59026..9cfd534 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/SSOTypes.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/SSOTypes.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: SSO Types - generated to populate hints fullName: SSOTypes remarks: '' -isPreview: false isDeprecated: false fields: - name: ACCOUNT diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ScopeSet.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ScopeSet.yml index 17db8e9..080dba3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ScopeSet.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ScopeSet.yml @@ -12,7 +12,6 @@ summary: >- to ensure uniqueness of strings. fullName: ScopeSet remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -21,7 +20,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ScopeSet(inputScopes: Array)' @@ -35,7 +33,6 @@ methods: package: '@azure/msal-common' summary: Appends single scope if passed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function appendScope(newScope: string)' @@ -49,7 +46,6 @@ methods: package: '@azure/msal-common' summary: Appends multiple scopes if passed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function appendScopes(newScopes: Array)' @@ -63,7 +59,6 @@ methods: package: '@azure/msal-common' summary: Returns the scopes as an array of string values remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function asArray(): Array' @@ -75,7 +70,6 @@ methods: package: '@azure/msal-common' summary: Check if set of scopes contains only the defaults remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function containsOnlyOIDCScopes(): boolean' @@ -87,7 +81,6 @@ methods: package: '@azure/msal-common' summary: Check if a given scope is present in this set of scopes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function containsScope(scope: string): boolean' @@ -104,7 +97,6 @@ methods: package: '@azure/msal-common' summary: Check if a set of scopes is present in this set of scopes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function containsScopeSet(scopeSet: ScopeSet): boolean' @@ -121,7 +113,6 @@ methods: package: '@azure/msal-common' summary: Factory method to create ScopeSet from space-delimited string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function fromString(inputScopeString: string): ScopeSet' @@ -137,7 +128,6 @@ methods: package: '@azure/msal-common' summary: Returns size of set of scopes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getScopeCount(): number' @@ -149,7 +139,6 @@ methods: package: '@azure/msal-common' summary: Check if scopes intersect between this set and another. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function intersectingScopeSets(otherScopes: ScopeSet): boolean' @@ -166,7 +155,6 @@ methods: package: '@azure/msal-common' summary: Prints scopes into a space-delimited string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function printScopes(): string' @@ -178,7 +166,6 @@ methods: package: '@azure/msal-common' summary: Prints scopes into a space-delimited lower-case string (used for caching) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function printScopesLowerCase(): string' @@ -194,7 +181,6 @@ methods: Primarily used to prevent cache misses if the default scopes are not returned from the server remarks: '' - isPreview: false isDeprecated: false syntax: content: function removeOIDCScopes() @@ -203,7 +189,6 @@ methods: package: '@azure/msal-common' summary: Removes element from set of scopes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeScope(scope: string)' @@ -217,7 +202,6 @@ methods: package: '@azure/msal-common' summary: Combines an array of scopes with the current set of scopes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function unionScopeSets(otherScopes: ScopeSet): Set' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/Separators.yml b/nodejs/docs-ref-autogen/@azure/msal-common/Separators.yml index c508c40..4b26077 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/Separators.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/Separators.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Separators used in cache fullName: Separators remarks: '' -isPreview: false isDeprecated: false fields: - name: CACHE_KEY_SEPARATOR diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml index 75f150b..579243b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml @@ -11,19 +11,22 @@ summary: |- - error: description fullName: ServerAuthorizationCodeResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type ServerAuthorizationCodeResponse = { accountId?: string, + claims?: string, client_info?: string, cloud_graph_host_name?: string, cloud_instance_host_name?: string, cloud_instance_name?: string, code?: string, + correlation_id?: string, error?: string, error_description?: string, msgraph_host?: string, state?: string, suberror?: string, + timestamp?: string, + trace_id?: string, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml index dfec2d8..55445e7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml @@ -48,11 +48,11 @@ summary: > diagnostics across components. fullName: ServerAuthorizationTokenResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type ServerAuthorizationTokenResponse = { access_token?: string, + claims?: string, client_info?: string, correlation_id?: string, error?: string, @@ -66,6 +66,7 @@ syntax: | refresh_in?: number, refresh_token?: string, scope?: string, + spa_accountid?: string, spa_code?: string, suberror?: string, timestamp?: string, diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml index b8018ae..3e12ecf 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ServerDeviceCodeResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type ServerDeviceCodeResponse = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ServerError.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ServerError.yml index 00f1206..61d7a20 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ServerError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ServerError.yml @@ -7,7 +7,6 @@ summary: >- unavailability. fullName: ServerError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -39,7 +37,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -55,7 +52,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -71,7 +67,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -87,7 +82,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -101,7 +95,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -115,7 +108,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -129,7 +121,6 @@ inheritedProperties: summary: Describes the subclass of an error fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -145,7 +136,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Creates an error for post request failures. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createPostRequestFailed(errDesc: string): AuthError' @@ -166,7 +156,6 @@ inheritedMethods: Creates an error that is thrown when something unexpected happens in the library. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -186,7 +175,6 @@ inheritedMethods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml index af31812..d1ee842 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ServerTelemetryEntity remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: new ServerTelemetryEntity() @@ -25,7 +23,6 @@ properties: summary: '' fullName: cacheHits remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cacheHits: number' @@ -38,7 +35,6 @@ properties: summary: '' fullName: errors remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errors: string[]' @@ -51,7 +47,6 @@ properties: summary: '' fullName: failedRequests remarks: '' - isPreview: false isDeprecated: false syntax: content: 'failedRequests: Array' @@ -64,7 +59,6 @@ methods: package: '@azure/msal-common' summary: 'validates if a given cache entry is "Telemetry", parses ' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryManager.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryManager.yml index 82bd19b..688eb67 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryManager.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ServerTelemetryManager remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -33,7 +31,6 @@ methods: package: '@azure/msal-common' summary: API to cache token failures for MSER data capture remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cacheFailedRequest(error: AuthError)' @@ -47,7 +44,6 @@ methods: package: '@azure/msal-common' summary: Remove server telemetry cache entry remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearTelemetryCache() @@ -57,7 +53,6 @@ methods: package: '@azure/msal-common' summary: API to add MSER Telemetry to request remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateCurrentRequestHeaderValue(): string' @@ -69,7 +64,6 @@ methods: package: '@azure/msal-common' summary: API to add MSER Telemetry for the last failed request remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateLastRequestHeaderValue(): string' @@ -81,7 +75,6 @@ methods: package: '@azure/msal-common' summary: Get the server telemetry entity from cache or initialize a new one remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLastRequests(): ServerTelemetryEntity' @@ -93,7 +86,6 @@ methods: package: '@azure/msal-common' summary: Get the region discovery fields remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRegionDiscoveryFields(): string' @@ -105,7 +97,6 @@ methods: package: '@azure/msal-common' summary: Update server telemetry cache entry by incrementing cache hit counter remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function incrementCacheHits(): number' @@ -119,7 +110,6 @@ methods: Returns the maximum number of errors that can be flushed to the server in the next network request remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -138,7 +128,6 @@ methods: package: '@azure/msal-common' summary: Set cache outcome remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCacheOutcome(cacheOutcome: CacheOutcome)' @@ -151,7 +140,6 @@ methods: package: '@azure/msal-common' summary: Update the region discovery metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml index 60380d0..52a64e7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ServerTelemetryRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type ServerTelemetryRequest = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml index cd4e739..cece0fa 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: SignedHttpRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type SignedHttpRequest = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml b/nodejs/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml index 5d3e3cd..ecd87bb 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: SignedHttpRequestParameters remarks: '' -isPreview: false isDeprecated: false syntax: | type SignedHttpRequestParameters = Pick< diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/SilentFlowClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/SilentFlowClient.yml index 225581d..71bf83b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/SilentFlowClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/SilentFlowClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: SilentFlowClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,7 +32,6 @@ inheritedProperties: summary: '' fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: Authority' @@ -50,7 +47,6 @@ inheritedProperties: summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' @@ -61,6 +57,25 @@ inheritedProperties: Inherited From [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-common.SilentFlowClient.createTokenQueryParameters' + package: '@azure/msal-common' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: |+ + + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseClient.createTokenQueryParameters](xref:@azure/msal-common.BaseClient.createTokenQueryParameters) - name: updateAuthority(Authority) uid: '@azure/msal-common.SilentFlowClient.updateAuthority' package: '@azure/msal-common' @@ -68,7 +83,6 @@ inheritedMethods: Updates the authority object of the client. Endpoint discovery must be completed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateAuthority(updatedAuthority: Authority)' @@ -86,7 +100,6 @@ methods: package: '@azure/msal-common' summary: Retrieves token from cache or throws an error if it must be refreshed. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -109,7 +122,6 @@ methods: the given token and returns the renewed token remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/StaticFields.yml b/nodejs/docs-ref-autogen/@azure/msal-common/StaticFields.yml index 1ad7d85..4293e9f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/StaticFields.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/StaticFields.yml @@ -5,16 +5,21 @@ package: '@azure/msal-common' summary: Fields whose value will not change throughout a request fullName: StaticFields remarks: '' -isPreview: false isDeprecated: false syntax: | type StaticFields = { accessTokenSize?: number, + allowNativeBroker?: boolean, appName?: string, appVersion?: string, cacheLookupPolicy?: number | undefined, + extensionHandshakeTimedOut?: boolean, + extensionHandshakeTimeoutMs?: number, extensionId?: string, + extensionInstalled?: boolean, extensionVersion?: string, + httpVerAuthority?: string, + httpVerToken?: string, idTokenSize?: number, matsAccountJoinOnEnd?: string, matsAccountJoinOnStart?: string, diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/StringDict.yml b/nodejs/docs-ref-autogen/@azure/msal-common/StringDict.yml index 67e49d3..12eda56 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/StringDict.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/StringDict.yml @@ -5,6 +5,5 @@ package: '@azure/msal-common' summary: 'Key-Value type to support queryParams, extraQueryParams and claims' fullName: StringDict remarks: '' -isPreview: false isDeprecated: false syntax: 'type StringDict = [key: string]: string' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml index 4e2e364..e0fc227 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: StubPerformanceClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: Creates an instance of PerformanceClient, an abstract class containing core performance telemetry logic. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -51,7 +49,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Registers a callback function to receive performance events. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -72,7 +69,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Saves extra information to be emitted when the measurements are flushed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function addStaticFields(fields: StaticFields, correlationId: string)' @@ -92,7 +88,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Removes measurements for a given correlation id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function discardMeasurements(correlationId: string)' @@ -109,7 +104,6 @@ inheritedMethods: package: '@azure/msal-common' summary: Emits events to all registered callbacks. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emitEvents(events: PerformanceEvent[], correlationId: string)' @@ -123,7 +117,7 @@ inheritedMethods: inheritanceDescription: >- Inherited From [PerformanceClient.emitEvents](xref:@azure/msal-common.PerformanceClient.emitEvents) - - name: endMeasurement(PerformanceEvent) + - name: 'endMeasurement(PerformanceEvent, IPerformanceMeasurement)' uid: '@azure/msal-common.StubPerformanceClient.endMeasurement' package: '@azure/msal-common' summary: >- @@ -131,53 +125,93 @@ inheritedMethods: directly by PerformanceClient classes, as consumers should instead use the function returned by startMeasurement. + + Adds a new field named as "[event name]DurationMs" for sub-measurements, + completes and emits an event + + otherwise. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function endMeasurement(event: PerformanceEvent): PerformanceEvent | - null + function endMeasurement(event: PerformanceEvent, measurement?: + IPerformanceMeasurement): PerformanceEvent | null parameters: - id: event type: description: '' + - id: measurement + type: + description: '' return: description: '' type: | null inheritanceDescription: >- Inherited From [PerformanceClient.endMeasurement](xref:@azure/msal-common.PerformanceClient.endMeasurement) - - name: 'flushMeasurements(PerformanceEvents, string)' - uid: '@azure/msal-common.StubPerformanceClient.flushMeasurements' + - name: getIntFields() + uid: '@azure/msal-common.StubPerformanceClient.getIntFields' package: '@azure/msal-common' - summary: >- - Gathers and emits performance events for measurements taked for the given - top-level API and correlation ID. + summary: |- + Get integral fields. + Override to change the set. + remarks: '' + isDeprecated: false + syntax: + content: 'function getIntFields(): ReadonlySet' + return: + description: '' + type: ReadonlySet<string> + inheritanceDescription: >- + Inherited From + [PerformanceClient.getIntFields](xref:@azure/msal-common.PerformanceClient.getIntFields) + - name: 'getPreQueueTime(PerformanceEvents, string)' + uid: '@azure/msal-common.StubPerformanceClient.getPreQueueTime' + package: '@azure/msal-common' + summary: Gets map of pre-queue times by correlation Id remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function flushMeasurements(measureName: PerformanceEvents, - correlationId: string) + function getPreQueueTime(eventName: PerformanceEvents, correlationId: + string): number | void parameters: - - id: measureName + - id: eventName type: description: '' - id: correlationId type: string - description: |+ - + description: '' + return: + description: '' + type: number | void inheritanceDescription: >- Inherited From - [PerformanceClient.flushMeasurements](xref:@azure/msal-common.PerformanceClient.flushMeasurements) + [PerformanceClient.getPreQueueTime](xref:@azure/msal-common.PerformanceClient.getPreQueueTime) + - name: 'increment(Counters, string)' + uid: '@azure/msal-common.StubPerformanceClient.increment' + package: '@azure/msal-common' + summary: Increment counters to be emitted when the measurements are flushed + remarks: '' + isDeprecated: false + syntax: + content: 'function increment(counters: Counters, correlationId: string)' + parameters: + - id: counters + type: + description: '' + - id: correlationId + type: string + description: | + correlation identifier + inheritanceDescription: >- + Inherited From + [PerformanceClient.increment](xref:@azure/msal-common.PerformanceClient.increment) - name: removePerformanceCallback(string) uid: '@azure/msal-common.StubPerformanceClient.removePerformanceCallback' package: '@azure/msal-common' summary: Removes a callback registered with addPerformanceCallback. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -198,7 +232,6 @@ inheritedMethods: Starts measuring performance for a given operation. Returns a function that should be used to end the measurement. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -218,28 +251,94 @@ inheritedMethods: Inherited From [PerformanceClient.startMeasurement](xref:@azure/msal-common.PerformanceClient.startMeasurement) methods: + - name: 'addQueueMeasurement(PerformanceEvents, string, number)' + uid: '@azure/msal-common.StubPerformanceClient.addQueueMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addQueueMeasurement(eventName: PerformanceEvents, + correlationId: string, queueTime: number) + parameters: + - id: eventName + type: + description: '' + - id: correlationId + type: string + description: '' + - id: queueTime + type: number + description: '' + - name: 'calculateQueuedTime(number, number)' + uid: '@azure/msal-common.StubPerformanceClient.calculateQueuedTime' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function calculateQueuedTime(preQueueTime: number, currentTime: number): + number + parameters: + - id: preQueueTime + type: number + description: '' + - id: currentTime + type: number + description: '' + return: + description: '' + type: number - name: generateId() uid: '@azure/msal-common.StubPerformanceClient.generateId' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateId(): string' return: description: '' type: string + - name: 'setPreQueueTime(PerformanceEvents, string | undefined)' + uid: '@azure/msal-common.StubPerformanceClient.setPreQueueTime' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function setPreQueueTime(eventName: PerformanceEvents, correlationId?: + string | undefined) + parameters: + - id: eventName + type: + description: '' + - id: correlationId + type: string | undefined + description: '' - name: startPerformanceMeasuremeant() uid: '@azure/msal-common.StubPerformanceClient.startPerformanceMeasuremeant' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function startPerformanceMeasuremeant(): IPerformanceMeasurement' return: description: '' type: + - name: startPerformanceMeasurement() + uid: '@azure/msal-common.StubPerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function startPerformanceMeasurement(): IPerformanceMeasurement' + return: + description: '' + type: extends: diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/StubPerformanceMeasurement.yml b/nodejs/docs-ref-autogen/@azure/msal-common/StubPerformanceMeasurement.yml index 6551b75..1135359 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/StubPerformanceMeasurement.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/StubPerformanceMeasurement.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: StubPerformanceMeasurement remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function endMeasurement() @@ -23,7 +21,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function flushMeasurement(): number | null' @@ -35,7 +32,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function startMeasurement() diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/SubMeasurement.yml b/nodejs/docs-ref-autogen/@azure/msal-common/SubMeasurement.yml new file mode 100644 index 0000000..4320ebd --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/SubMeasurement.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: SubMeasurement +uid: '@azure/msal-common.SubMeasurement' +package: '@azure/msal-common' +summary: '' +fullName: SubMeasurement +remarks: '' +isDeprecated: false +syntax: | + type SubMeasurement = { name: PerformanceEvents, startTimeMs: number } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/SystemOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/SystemOptions.yml index 3cf4139..9003724 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/SystemOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/SystemOptions.yml @@ -9,11 +9,9 @@ summary: > token before expiry fullName: SystemOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type SystemOptions = { preventCorsPreflight?: boolean, - proxyUrl?: string, tokenRenewalOffsetSeconds?: number, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/TelemetryOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/TelemetryOptions.yml index 5754bdf..e894e88 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/TelemetryOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/TelemetryOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: TelemetryOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type TelemetryOptions = { application: ApplicationTelemetry } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml index 72f89d6..f651cd0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ThrottlingEntity remarks: '' -isPreview: false isDeprecated: false type: class properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: error remarks: '' - isPreview: false isDeprecated: false syntax: content: 'error?: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: errorCodes remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCodes?: Array' @@ -41,7 +38,6 @@ properties: summary: '' fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage?: string' @@ -54,7 +50,6 @@ properties: summary: '' fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError?: string' @@ -67,7 +62,6 @@ properties: summary: '' fullName: throttleTime remarks: '' - isPreview: false isDeprecated: false syntax: content: 'throttleTime: number' @@ -80,7 +74,6 @@ methods: package: '@azure/msal-common' summary: 'validates if a given cache entry is "Throttling", parses ' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml index fb0ce15..0a11388 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: '' fullName: ThrottlingUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -16,7 +15,6 @@ methods: Calculates the Unix-time value for a throttle to expire given throttleTime in seconds. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function calculateThrottleTime(throttleTime: number): number' @@ -34,7 +32,6 @@ methods: package: '@azure/msal-common' summary: Checks a NetworkResponse object's RetryAfter header remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -55,7 +52,6 @@ methods: package: '@azure/msal-common' summary: Checks a NetworkResponse object's status codes against 429 or 5xx remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -76,7 +72,6 @@ methods: package: '@azure/msal-common' summary: Prepares a RequestThumbprint to be stored as a key. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -97,7 +92,6 @@ methods: package: '@azure/msal-common' summary: Performs necessary throttling checks after a network request. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -122,7 +116,6 @@ methods: package: '@azure/msal-common' summary: Performs necessary throttling checks before a network request. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -141,7 +134,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/TimeUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-common/TimeUtils.yml index fe884f3..519ea43 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/TimeUtils.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/TimeUtils.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Utility class which exposes functions for managing date and time operations. fullName: TimeUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-common' summary: Waits for t number of milliseconds remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function delay(t: number, value?: T): Promise' @@ -34,7 +32,6 @@ methods: package: '@azure/msal-common' summary: check if a token is expired based on given UTC time in seconds. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -56,7 +53,6 @@ methods: package: '@azure/msal-common' summary: return the current time in Unix time (seconds). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function nowSeconds(): number' @@ -72,7 +68,6 @@ methods: i.e. The system clock was turned back after acquiring the cached token remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function wasClockTurnedBack(cachedAt: string): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml b/nodejs/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml index 6be4dcb..7ee5913 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml @@ -7,7 +7,6 @@ summary: |- decisions to read from and write to the persistent cache fullName: TokenCacheContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,7 +34,6 @@ properties: summary: serializable token cache interface fullName: cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'cache: ISerializableTokenCache' @@ -49,7 +46,6 @@ properties: summary: boolean which indicates the changes in cache fullName: cacheHasChanged remarks: '' - isPreview: false isDeprecated: false syntax: content: boolean cacheHasChanged @@ -62,7 +58,6 @@ properties: summary: boolean indicating cache change fullName: hasChanged remarks: '' - isPreview: false isDeprecated: false syntax: content: 'hasChanged: boolean' @@ -75,7 +70,6 @@ properties: summary: function to retrieve the token cache fullName: tokenCache remarks: '' - isPreview: false isDeprecated: false syntax: content: ISerializableTokenCache tokenCache diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/TokenClaims.yml b/nodejs/docs-ref-autogen/@azure/msal-common/TokenClaims.yml index 666c3a7..9bb839f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/TokenClaims.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/TokenClaims.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Type which describes Id Token claims known by MSAL. fullName: TokenClaims remarks: '' -isPreview: false isDeprecated: false syntax: | type TokenClaims = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/UrlString.yml b/nodejs/docs-ref-autogen/@azure/msal-common/UrlString.yml index f1429a8..8c29b55 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/UrlString.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/UrlString.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Url object class which can perform various transformations on url strings. fullName: UrlString remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new UrlString(url: string)' @@ -29,7 +27,6 @@ properties: summary: '' fullName: urlString remarks: '' - isPreview: false isDeprecated: false syntax: content: string urlString @@ -44,7 +41,6 @@ methods: Given a url and a query string return the url with provided query string appended remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -66,7 +62,6 @@ methods: package: '@azure/msal-common' summary: Ensure urls are lower case and end with a / character. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function canonicalizeUri(url: string): string' @@ -83,7 +78,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -101,7 +95,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -122,7 +115,6 @@ methods: package: '@azure/msal-common' summary: Returns URL hash as server auth code response object. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -140,7 +132,6 @@ methods: package: '@azure/msal-common' summary: Returns URL query string as server auth code response object. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -158,7 +149,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function getDomainFromUrl(url: string): string' @@ -174,7 +164,6 @@ methods: package: '@azure/msal-common' summary: Returns the anchor part(#) of the URL remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getHash(): string' @@ -186,7 +175,6 @@ methods: package: '@azure/msal-common' summary: Parses out the components from a url string. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getUrlComponents(): IUri' @@ -200,7 +188,6 @@ methods: package: '@azure/msal-common' summary: Check if the hash of the URL string contains known properties remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function hashContainsKnownProperties(hash: string): boolean' @@ -218,7 +205,6 @@ methods: Parses hash string from given string. Returns empty string if no hash symbol is found. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function parseHash(hashString: string): string' @@ -237,7 +223,6 @@ methods: Parses query string from given string. Returns empty string if no query symbol is found. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function parseQueryString(queryString: string): string' @@ -254,7 +239,6 @@ methods: package: '@azure/msal-common' summary: Returns a url with the hash removed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function removeHashFromUrl(url: string): string' @@ -273,7 +257,6 @@ methods: Given a url like https://a:b/common/d?e=f#g, and a tenantId, returns https://a:b/tenantId/d remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function replaceTenantPath(tenantId: string): UrlString' @@ -290,7 +273,6 @@ methods: package: '@azure/msal-common' summary: Throws if urlString passed is not a valid authority URI string. remarks: '' - isPreview: false isDeprecated: false syntax: content: function validateAsUri() diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml new file mode 100644 index 0000000..e970fff --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: UrlToHttpRequestOptions +uid: '@azure/msal-common.UrlToHttpRequestOptions' +package: '@azure/msal-common' +summary: '' +fullName: UrlToHttpRequestOptions +remarks: '' +isDeprecated: false +syntax: | + type UrlToHttpRequestOptions = { + auth?: string, + hash: string, + hostname: string, + href: string, + path: string, + pathname: string, + port?: number, + protocol: string, + search: string, + } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/UsernamePasswordClient.yml b/nodejs/docs-ref-autogen/@azure/msal-common/UsernamePasswordClient.yml index 401dee3..c37b207 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/UsernamePasswordClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/UsernamePasswordClient.yml @@ -9,7 +9,6 @@ summary: >- testing purposes fullName: UsernamePasswordClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new UsernamePasswordClient(configuration: ClientConfiguration)' @@ -33,7 +31,6 @@ inheritedProperties: summary: '' fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: Authority' @@ -49,7 +46,6 @@ inheritedProperties: summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' @@ -60,6 +56,25 @@ inheritedProperties: Inherited From [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-common.UsernamePasswordClient.createTokenQueryParameters' + package: '@azure/msal-common' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: |+ + + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [BaseClient.createTokenQueryParameters](xref:@azure/msal-common.BaseClient.createTokenQueryParameters) - name: updateAuthority(Authority) uid: '@azure/msal-common.UsernamePasswordClient.updateAuthority' package: '@azure/msal-common' @@ -67,7 +82,6 @@ inheritedMethods: Updates the authority object of the client. Endpoint discovery must be completed. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function updateAuthority(updatedAuthority: Authority)' @@ -89,7 +103,6 @@ methods: password_grant remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ValidCacheType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ValidCacheType.yml index 3fffb83..0597368 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ValidCacheType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ValidCacheType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Object type of all accepted cache types fullName: ValidCacheType remarks: '' -isPreview: false isDeprecated: false syntax: | type ValidCacheType = diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ValidCredentialType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ValidCredentialType.yml index 18c9bf2..2ddfd3c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ValidCredentialType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ValidCredentialType.yml @@ -5,7 +5,6 @@ package: '@azure/msal-common' summary: Object type of all credential types fullName: ValidCredentialType remarks: '' -isPreview: false isDeprecated: false syntax: | type ValidCredentialType = diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/index.yml b/nodejs/docs-ref-autogen/@azure/msal-common/index.yml index 0374e47..d714389 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/index.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/index.yml @@ -15,8 +15,6 @@ typeAliases: - '@azure/msal-common.AzureRegion' - '@azure/msal-common.AzureRegionConfiguration' - '@azure/msal-common.CloudDiscoveryMetadata' - - '@azure/msal-common.CloudInstanceDiscoveryResponse' - - '@azure/msal-common.ImdsOptions' - '@azure/msal-common.OpenIdConfigResponse' - '@azure/msal-common.RegionDiscoveryMetadata' - '@azure/msal-common.AccessTokenCache' @@ -50,6 +48,7 @@ typeAliases: - '@azure/msal-common.LoggerMessageOptions' - '@azure/msal-common.NetworkRequestOptions' - '@azure/msal-common.NetworkResponse' + - '@azure/msal-common.UrlToHttpRequestOptions' - '@azure/msal-common.RequestThumbprint' - '@azure/msal-common.BaseAuthRequest' - '@azure/msal-common.CommonAuthorizationCodeRequest' @@ -61,18 +60,22 @@ typeAliases: - '@azure/msal-common.CommonRefreshTokenRequest' - '@azure/msal-common.CommonSilentFlowRequest' - '@azure/msal-common.CommonUsernamePasswordRequest' + - '@azure/msal-common.NativeRequest' + - '@azure/msal-common.NativeSignOutRequest' - '@azure/msal-common.AuthenticationResult' - '@azure/msal-common.AuthorizationCodePayload' - '@azure/msal-common.DeviceCodeResponse' - '@azure/msal-common.ServerDeviceCodeResponse' - '@azure/msal-common.ExternalTokenResponse' - - '@azure/msal-common.IMDSBadResponse' - '@azure/msal-common.ServerAuthorizationCodeResponse' - '@azure/msal-common.ServerAuthorizationTokenResponse' - '@azure/msal-common.InProgressPerformanceEvent' - '@azure/msal-common.PerformanceCallbackFunction' + - '@azure/msal-common.QueueMeasurement' + - '@azure/msal-common.Counters' - '@azure/msal-common.PerformanceEvent' - '@azure/msal-common.StaticFields' + - '@azure/msal-common.SubMeasurement' - '@azure/msal-common.ServerTelemetryRequest' - '@azure/msal-common.StringDict' - '@azure/msal-common.LibraryStateObject' @@ -81,7 +84,6 @@ classes: - '@azure/msal-common.AuthToken' - '@azure/msal-common.Authority' - '@azure/msal-common.AuthorityFactory' - - '@azure/msal-common.RegionDiscovery' - '@azure/msal-common.CacheManager' - '@azure/msal-common.DefaultStorageClass' - '@azure/msal-common.AccessTokenEntity' @@ -109,16 +111,12 @@ classes: - '@azure/msal-common.ClientAuthError' - '@azure/msal-common.ClientConfigurationError' - '@azure/msal-common.InteractionRequiredAuthError' - - '@azure/msal-common.JoseHeaderError' - '@azure/msal-common.ServerError' - '@azure/msal-common.Logger' - '@azure/msal-common.NetworkManager' - '@azure/msal-common.ThrottlingUtils' - '@azure/msal-common.AuthenticationHeaderParser' - - '@azure/msal-common.RequestParameterBuilder' - - '@azure/msal-common.RequestValidator' - '@azure/msal-common.ScopeSet' - - '@azure/msal-common.ResponseHandler' - '@azure/msal-common.PerformanceClient' - '@azure/msal-common.StubPerformanceClient' - '@azure/msal-common.StubPerformanceMeasurement' @@ -162,7 +160,6 @@ functions: package: '@azure/msal-common' summary: Function to build a client info object from server clientInfo string remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -184,7 +181,6 @@ functions: package: '@azure/msal-common' summary: Function to build a client info object from cached homeAccountId string remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -198,28 +194,11 @@ functions: return: description: '' type: - - name: isCloudInstanceDiscoveryResponse(object) - uid: '@azure/msal-common.isCloudInstanceDiscoveryResponse' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isCloudInstanceDiscoveryResponse(response: object): boolean' - parameters: - - id: response - type: object - description: '' - return: - description: '' - type: boolean - name: isOpenIdConfigResponse(object) uid: '@azure/msal-common.isOpenIdConfigResponse' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isOpenIdConfigResponse(response: object): boolean' @@ -242,7 +221,7 @@ functions: Array, clientId: string, skipAuthorityMetadataCache?: boolean }, userLoggerOption: { correlationId?: string, logLevel?: LogLevel, loggerCallback?: ILoggerCallback, piiLoggingEnabled?: boolean }, - userSystemOptions: { preventCorsPreflight?: boolean, proxyUrl?: string, + userSystemOptions: { preventCorsPreflight?: boolean, tokenRenewalOffsetSeconds?: number } }) uid: '@azure/msal-common.buildClientConfiguration' package: '@azure/msal-common' @@ -250,7 +229,6 @@ functions: Function that sets the default options when not explicitly configured from app developer remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -266,7 +244,7 @@ functions: Array, clientId: string, skipAuthorityMetadataCache?: boolean }, userLoggerOption: { correlationId?: string, logLevel?: LogLevel, loggerCallback?: ILoggerCallback, piiLoggingEnabled?: boolean }, - userSystemOptions: { preventCorsPreflight?: boolean, proxyUrl?: string, + userSystemOptions: { preventCorsPreflight?: boolean, tokenRenewalOffsetSeconds?: number } }): CommonClientConfiguration parameters: - id: __namedParameters @@ -284,13 +262,14 @@ functions: boolean }, userLoggerOption: { correlationId?: string, logLevel?: LogLevel, loggerCallback?: ILoggerCallback, piiLoggingEnabled?: boolean }, userSystemOptions: { preventCorsPreflight?: boolean, - proxyUrl?: string, tokenRenewalOffsetSeconds?: number } } + tokenRenewalOffsetSeconds?: number } } description: '' return: description: Configuration type: interfaces: - '@azure/msal-common.DecodedAuthToken' + - '@azure/msal-common.INativeBrokerPlugin' - '@azure/msal-common.ICacheManager' - '@azure/msal-common.ICachePlugin' - '@azure/msal-common.ISerializableTokenCache' @@ -301,4 +280,5 @@ interfaces: - '@azure/msal-common.INetworkModule' - '@azure/msal-common.IPerformanceClient' - '@azure/msal-common.IPerformanceMeasurement' + - '@azure/msal-common.PreQueueEvent' - '@azure/msal-common.IUri' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/ApiId.yml b/nodejs/docs-ref-autogen/@azure/msal-node/ApiId.yml deleted file mode 100644 index bbcecba..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/ApiId.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSEnum -name: ApiId -uid: '@azure/msal-node.ApiId' -package: '@azure/msal-node' -summary: >- - API Codes for Telemetry purposes. - - Before adding a new code you must claim it in the MSAL Telemetry tracker as - these number spaces are shared across all MSALs - - 0-99 Silent Flow - - 600-699 Device Code Flow - - 800-899 Auth Code Flow -fullName: ApiId -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: acquireTokenSilent - uid: '@azure/msal-node.ApiId.acquireTokenSilent' - package: '@azure/msal-node' - summary: '' - numericValue: 62 - - name: acquireTokenByUsernamePassword - uid: '@azure/msal-node.ApiId.acquireTokenByUsernamePassword' - package: '@azure/msal-node' - summary: '' - numericValue: 371 - - name: acquireTokenByDeviceCode - uid: '@azure/msal-node.ApiId.acquireTokenByDeviceCode' - package: '@azure/msal-node' - summary: '' - numericValue: 671 - - name: acquireTokenByClientCredential - uid: '@azure/msal-node.ApiId.acquireTokenByClientCredential' - package: '@azure/msal-node' - summary: '' - numericValue: 771 - - name: acquireTokenByCode - uid: '@azure/msal-node.ApiId.acquireTokenByCode' - package: '@azure/msal-node' - summary: '' - numericValue: 871 - - name: acquireTokenByRefreshToken - uid: '@azure/msal-node.ApiId.acquireTokenByRefreshToken' - package: '@azure/msal-node' - summary: '' - numericValue: 872 diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml index 281687f..0285bcb 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml @@ -26,7 +26,7 @@ summary: >- will redirect to after the user inputs credentials and consents. It must exactly match one of the redirect URIs you registered in the portal. - - tokenQueryParameters - String to string map of custom query parameters + - tokenQueryParameters - String to string map of custom query parameters added to the /token call - code - The authorization_code that the user acquired in @@ -45,7 +45,6 @@ summary: >- https://datatracker.ietf.org/doc/html/rfc6819#section-3.6. fullName: AuthorizationCodeRequest remarks: '' -isPreview: false isDeprecated: false syntax: > type AuthorizationCodeRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml index 33b526f..9d6bfc7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml @@ -79,7 +79,6 @@ summary: >- to mitigate replay attacks. fullName: AuthorizationUrlRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthorizationUrlRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/BrokerOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-node/BrokerOptions.yml new file mode 100644 index 0000000..857e64d --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-node/BrokerOptions.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: BrokerOptions +uid: '@azure/msal-node.BrokerOptions' +package: '@azure/msal-node' +summary: >- + Use this to configure the below broker options: + + - nativeBrokerPlugin - Native broker implementation (should be imported from + msal-node-extensions) + + Note: These options are only available for PublicClientApplications using the + Authorization Code Flow +fullName: BrokerOptions +remarks: '' +isDeprecated: false +syntax: | + type BrokerOptions = { nativeBrokerPlugin?: INativeBrokerPlugin } diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/CacheKVStore.yml b/nodejs/docs-ref-autogen/@azure/msal-node/CacheKVStore.yml index 2e8d7b7..a03550c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/CacheKVStore.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/CacheKVStore.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: Key value store for in-memory cache fullName: CacheKVStore remarks: '' -isPreview: false isDeprecated: false syntax: | type CacheKVStore = Record diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/CacheOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-node/CacheOptions.yml index d8950f9..dd5414c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/CacheOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/CacheOptions.yml @@ -7,7 +7,6 @@ summary: |- - cachePlugin - Plugin for reading and writing token cache to disk. fullName: CacheOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type CacheOptions = { cachePlugin?: ICachePlugin } diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/ClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-node/ClientApplication.yml index 57e0252..2303a5e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/ClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/ClientApplication.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: Base abstract class for all ClientApplications - public and confidential fullName: ClientApplication remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -26,7 +25,6 @@ methods: AuthorizationCodeRequest are the same. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -58,7 +56,6 @@ methods: handle the caching and refreshing of tokens automatically. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -88,7 +85,6 @@ methods: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -120,7 +116,6 @@ methods: and the guidance is for the user to call any interactive token acquisition API (eg: `acquireTokenByCode()`). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -138,7 +133,6 @@ methods: package: '@azure/msal-node' summary: Clear the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearCache() @@ -162,7 +156,6 @@ methods: `acquireTokenByCode(AuthorizationCodeRequest)`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -180,7 +173,6 @@ methods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -192,7 +184,6 @@ methods: package: '@azure/msal-node' summary: Gets the token cache for the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): TokenCache' @@ -206,7 +197,6 @@ methods: Replaces the default logger set in configurations with new Logger with new configurations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml b/nodejs/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml index f9b8177..6d4f951 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: Client assertion of type jwt-bearer used in confidential client flows fullName: ClientAssertion remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -16,7 +15,6 @@ methods: Initialize the ClientAssertion class from the clientAssertion passed by the user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function fromAssertion(assertion: string): ClientAssertion' @@ -35,7 +33,6 @@ methods: Initialize the ClientAssertion class from the certificate passed by the user remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -63,7 +60,6 @@ methods: Update JWT for certificate based clientAssertion, if passed by the user, uses it as is remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -90,7 +86,6 @@ methods: Extracts the raw certs from a given certificate string and returns them in an array. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml index e153153..689b84b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml @@ -19,9 +19,11 @@ summary: >- - clientAssertion - A Base64Url-encoded signed JWT assertion string used in the Client Credential flow + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call fullName: ClientCredentialRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type ClientCredentialRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml index b2f65c2..b008e7b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml @@ -8,7 +8,6 @@ summary: >- will configure application secrets, client certificates/assertions as applicable fullName: ConfidentialClientApplication remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -54,7 +53,6 @@ constructors: Full B2C functionality will be available in this library in future versions. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ConfidentialClientApplication(configuration: Configuration)' @@ -80,7 +78,6 @@ inheritedMethods: AuthorizationCodeRequest are the same. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -115,7 +112,6 @@ inheritedMethods: handle the caching and refreshing of tokens automatically. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -149,7 +145,6 @@ inheritedMethods: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -184,7 +179,6 @@ inheritedMethods: and the guidance is for the user to call any interactive token acquisition API (eg: `acquireTokenByCode()`). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -205,7 +199,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Clear the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearCache() @@ -232,7 +225,6 @@ inheritedMethods: `acquireTokenByCode(AuthorizationCodeRequest)`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -253,7 +245,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -268,7 +259,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Gets the token cache for the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): TokenCache' @@ -285,7 +275,6 @@ inheritedMethods: Replaces the default logger set in configurations with new Logger with new configurations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' @@ -306,7 +295,6 @@ methods: Acquires tokens from the authority for the application (not for an end user). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -341,7 +329,6 @@ methods: https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow#gaining-consent-for-the-middle-tier-application remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -363,7 +350,6 @@ methods: is meant for Azure SDK to enhance Managed Identity support. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function SetAppTokenProvider(provider: IAppTokenProvider)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/Configuration.yml b/nodejs/docs-ref-autogen/@azure/msal-node/Configuration.yml index 2af5a41..f727b9b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/Configuration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/Configuration.yml @@ -9,16 +9,20 @@ summary: >- - auth: this is where you configure auth elements like clientID, authority used for authenticating against the Microsoft Identity Platform + - broker: this is where you configure broker options + - cache: this is where you configure cache location - system: this is where you can configure the network client, logger + + - telemetry: this is where you can configure telemetry options fullName: Configuration remarks: '' -isPreview: false isDeprecated: false syntax: | type Configuration = { auth: NodeAuthOptions, + broker?: BrokerOptions, cache?: CacheOptions, system?: NodeSystemOptions, telemetry?: NodeTelemetryOptions, diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml b/nodejs/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml index e146e10..414fdcf 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml @@ -10,7 +10,6 @@ summary: >- Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636). fullName: CryptoProvider remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -19,7 +18,6 @@ constructors: package: '@azure/msal-node' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: new CryptoProvider() @@ -29,7 +27,6 @@ methods: package: '@azure/msal-node' summary: Decodes input string from base64. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Decode(input: string): string' @@ -46,7 +43,6 @@ methods: package: '@azure/msal-node' summary: Encodes input string to base64. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Encode(input: string): string' @@ -63,7 +59,6 @@ methods: package: '@azure/msal-node' summary: Removes all cryptographic keys from Keystore remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function clearKeystore(): Promise' @@ -75,7 +70,6 @@ methods: package: '@azure/msal-node' summary: Creates a new random GUID - used to populate state and nonce. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createNewGuid(): string' @@ -87,7 +81,6 @@ methods: package: '@azure/msal-node' summary: Generates PKCE codes used in Authorization Code Flow. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generatePkceCodes(): Promise' @@ -101,7 +94,6 @@ methods: Generates a keypair, stores it and returns a thumbprint - not yet implemented for node remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getPublicKeyThumbprint(): Promise' @@ -113,7 +105,6 @@ methods: package: '@azure/msal-node' summary: Returns the SHA-256 hash of an input string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function hashString(plainText: string): Promise' @@ -129,7 +120,6 @@ methods: package: '@azure/msal-node' summary: Removes cryptographic keypair from key store matching the keyId passed in remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeTokenBindingKey(): Promise' @@ -143,7 +133,6 @@ methods: Signs the given object as a jwt payload with private key retrieved by given kid - currently not implemented for node remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function signJwt(): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/Deserializer.yml b/nodejs/docs-ref-autogen/@azure/msal-node/Deserializer.yml deleted file mode 100644 index a6f4cf9..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/Deserializer.yml +++ /dev/null @@ -1,151 +0,0 @@ -### YamlMime:TSType -name: Deserializer -uid: '@azure/msal-node.Deserializer' -package: '@azure/msal-node' -summary: >- - This class deserializes cache entities read from the file into in memory - object types defined internally -fullName: Deserializer -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'deserializeAccessTokens(Record)' - uid: '@azure/msal-node.Deserializer.deserializeAccessTokens' - package: '@azure/msal-node' - summary: Deserializes access tokens to AccessTokenEntity objects - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function deserializeAccessTokens(accessTokens: Record): AccessTokenCache - parameters: - - id: accessTokens - type: >- - Record<string, > - description: |+ - - return: - description: '' - type: AccessTokenCache - - name: 'deserializeAccounts(Record)' - uid: '@azure/msal-node.Deserializer.deserializeAccounts' - package: '@azure/msal-node' - summary: Deserializes accounts to AccountEntity objects - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function deserializeAccounts(accounts: Record): AccountCache - parameters: - - id: accounts - type: >- - Record<string, > - description: |+ - - return: - description: '' - type: AccountCache - - name: deserializeAllCache(JsonCache) - uid: '@azure/msal-node.Deserializer.deserializeAllCache' - package: '@azure/msal-node' - summary: Deserialize an inMemory Cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function deserializeAllCache(jsonCache: JsonCache): InMemoryCache' - parameters: - - id: jsonCache - type: - description: |+ - - return: - description: '' - type: - - name: 'deserializeAppMetadata(Record)' - uid: '@azure/msal-node.Deserializer.deserializeAppMetadata' - package: '@azure/msal-node' - summary: Deserializes appMetadata to AppMetaData objects - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function deserializeAppMetadata(appMetadata: Record): AppMetadataCache - parameters: - - id: appMetadata - type: >- - Record<string, > - description: |+ - - return: - description: '' - type: AppMetadataCache - - name: 'deserializeIdTokens(Record)' - uid: '@azure/msal-node.Deserializer.deserializeIdTokens' - package: '@azure/msal-node' - summary: Deserializes id tokens to IdTokenEntity objects - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function deserializeIdTokens(idTokens: Record): IdTokenCache - parameters: - - id: idTokens - type: >- - Record<string, > - description: |+ - - return: - description: '' - type: IdTokenCache - - name: deserializeJSONBlob(string) - uid: '@azure/msal-node.Deserializer.deserializeJSONBlob' - package: '@azure/msal-node' - summary: Parse the JSON blob in memory and deserialize the content - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function deserializeJSONBlob(jsonFile: string): JsonCache' - parameters: - - id: jsonFile - type: string - description: '' - return: - description: '' - type: - - name: 'deserializeRefreshTokens(Record)' - uid: '@azure/msal-node.Deserializer.deserializeRefreshTokens' - package: '@azure/msal-node' - summary: Deserializes refresh tokens to RefreshTokenEntity objects - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function deserializeRefreshTokens(refreshTokens: Record): RefreshTokenCache - parameters: - - id: refreshTokens - type: >- - Record<string, > - description: |+ - - return: - description: '' - type: RefreshTokenCache diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/DeviceCodeRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/DeviceCodeRequest.yml index c22e132..f0aa768 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/DeviceCodeRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/DeviceCodeRequest.yml @@ -27,9 +27,11 @@ summary: >- the token endpoint of security token service for the interval specified in the device code response (usually 15 minutes). To stop polling and cancel the request, set cancel=true. + + - extraQueryParameters - String to string map of custom query parameters + added to the query string fullName: DeviceCodeRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type DeviceCodeRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml b/nodejs/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml index 8b5867f..1712e3e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: '' fullName: DistributedCachePlugin remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-node' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -33,7 +31,6 @@ methods: package: '@azure/msal-node' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -51,7 +48,6 @@ methods: package: '@azure/msal-node' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/EncodingUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-node/EncodingUtils.yml deleted file mode 100644 index afcca40..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/EncodingUtils.yml +++ /dev/null @@ -1,97 +0,0 @@ -### YamlMime:TSType -name: EncodingUtils -uid: '@azure/msal-node.EncodingUtils' -package: '@azure/msal-node' -summary: '' -fullName: EncodingUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: base64Decode(string) - uid: '@azure/msal-node.EncodingUtils.base64Decode' - package: '@azure/msal-node' - summary: >- - 'utf8': Multibyte encoded Unicode characters. Many web pages and other - document formats use UTF-8. - - 'base64': Base64 encoding. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function base64Decode(base64Str: string): string' - parameters: - - id: base64Str - type: string - description: | - Base64 encoded text - return: - description: '' - type: string - - name: base64DecodeUrl(string) - uid: '@azure/msal-node.EncodingUtils.base64DecodeUrl' - package: '@azure/msal-node' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function base64DecodeUrl(base64Str: string): string' - parameters: - - id: base64Str - type: string - description: | - Base64 encoded Url - return: - description: '' - type: string - - name: 'base64Encode(string, BufferEncoding)' - uid: '@azure/msal-node.EncodingUtils.base64Encode' - package: '@azure/msal-node' - summary: >- - 'utf8': Multibyte encoded Unicode characters. Many web pages and other - document formats use UTF-8. - - 'base64': Base64 encoding. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function base64Encode(str: string, encoding?: BufferEncoding): - string - parameters: - - id: str - type: string - description: | - text - - id: encoding - type: BufferEncoding - description: '' - return: - description: '' - type: string - - name: 'base64EncodeUrl(string, BufferEncoding)' - uid: '@azure/msal-node.EncodingUtils.base64EncodeUrl' - package: '@azure/msal-node' - summary: encode a URL - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function base64EncodeUrl(str: string, encoding?: BufferEncoding): - string - parameters: - - id: str - type: string - description: |+ - - - id: encoding - type: BufferEncoding - description: '' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/GuidGenerator.yml b/nodejs/docs-ref-autogen/@azure/msal-node/GuidGenerator.yml deleted file mode 100644 index e112907..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/GuidGenerator.yml +++ /dev/null @@ -1,44 +0,0 @@ -### YamlMime:TSType -name: GuidGenerator -uid: '@azure/msal-node.GuidGenerator' -package: '@azure/msal-node' -summary: '' -fullName: GuidGenerator -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: generateGuid() - uid: '@azure/msal-node.GuidGenerator.generateGuid' - package: '@azure/msal-node' - summary: >- - RFC4122: The version 4 UUID is meant for generating UUIDs from - truly-random or pseudo-random numbers. - - uuidv4 generates guids from cryprtographically-string random - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateGuid(): string' - return: - description: '' - type: string - - name: isGuid(string) - uid: '@azure/msal-node.GuidGenerator.isGuid' - package: '@azure/msal-node' - summary: verifies if a string is GUID - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isGuid(guid: string): boolean' - parameters: - - id: guid - type: string - description: |+ - - return: - description: '' - type: boolean diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/HashUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-node/HashUtils.yml deleted file mode 100644 index ced0a5f..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/HashUtils.yml +++ /dev/null @@ -1,28 +0,0 @@ -### YamlMime:TSType -name: HashUtils -uid: '@azure/msal-node.HashUtils' -package: '@azure/msal-node' -summary: '' -fullName: HashUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: sha256(string) - uid: '@azure/msal-node.HashUtils.sha256' - package: '@azure/msal-node' - summary: generate 'SHA256' hash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function sha256(buffer: string): Buffer' - parameters: - - id: buffer - type: string - description: |+ - - return: - description: '' - type: Buffer diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/HttpClient.yml b/nodejs/docs-ref-autogen/@azure/msal-node/HttpClient.yml deleted file mode 100644 index faf2e42..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/HttpClient.yml +++ /dev/null @@ -1,59 +0,0 @@ -### YamlMime:TSType -name: HttpClient -uid: '@azure/msal-node.HttpClient' -package: '@azure/msal-node' -summary: This class implements the API for network requests. -fullName: HttpClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'sendGetRequestAsync(string, NetworkRequestOptions)' - uid: '@azure/msal-node.HttpClient.sendGetRequestAsync' - package: '@azure/msal-node' - summary: Http Get request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendGetRequestAsync(url: string, options?: - NetworkRequestOptions): Promise> - parameters: - - id: url - type: string - description: '' - - id: options - type: NetworkRequestOptions - description: |+ - - return: - description: '' - type: Promise<NetworkResponse<T>> - - name: 'sendPostRequestAsync(string, NetworkRequestOptions, number)' - uid: '@azure/msal-node.HttpClient.sendPostRequestAsync' - package: '@azure/msal-node' - summary: Http Post request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendPostRequestAsync(url: string, options?: - NetworkRequestOptions, cancellationToken?: number): - Promise> - parameters: - - id: url - type: string - description: '' - - id: options - type: NetworkRequestOptions - description: |+ - - - id: cancellationToken - type: number - description: '' - return: - description: '' - type: Promise<NetworkResponse<T>> diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/HttpMethod.yml b/nodejs/docs-ref-autogen/@azure/msal-node/HttpMethod.yml deleted file mode 100644 index 9ae696c..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/HttpMethod.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: HttpMethod -uid: '@azure/msal-node.HttpMethod' -package: '@azure/msal-node' -summary: http methods -fullName: HttpMethod -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: GET - uid: '@azure/msal-node.HttpMethod.GET' - package: '@azure/msal-node' - summary: '' - - name: POST - uid: '@azure/msal-node.HttpMethod.POST' - package: '@azure/msal-node' - summary: '' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/HttpStatus.yml b/nodejs/docs-ref-autogen/@azure/msal-node/HttpStatus.yml deleted file mode 100644 index 63e200d..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/HttpStatus.yml +++ /dev/null @@ -1,45 +0,0 @@ -### YamlMime:TSEnum -name: HttpStatus -uid: '@azure/msal-node.HttpStatus' -package: '@azure/msal-node' -summary: '' -fullName: HttpStatus -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: SUCCESS_RANGE_START - uid: '@azure/msal-node.HttpStatus.SUCCESS_RANGE_START' - package: '@azure/msal-node' - summary: '' - numericValue: 200 - - name: SUCCESS_RANGE_END - uid: '@azure/msal-node.HttpStatus.SUCCESS_RANGE_END' - package: '@azure/msal-node' - summary: '' - numericValue: 299 - - name: REDIRECT - uid: '@azure/msal-node.HttpStatus.REDIRECT' - package: '@azure/msal-node' - summary: '' - numericValue: 302 - - name: CLIENT_ERROR_RANGE_START - uid: '@azure/msal-node.HttpStatus.CLIENT_ERROR_RANGE_START' - package: '@azure/msal-node' - summary: '' - numericValue: 400 - - name: CLIENT_ERROR_RANGE_END - uid: '@azure/msal-node.HttpStatus.CLIENT_ERROR_RANGE_END' - package: '@azure/msal-node' - summary: '' - numericValue: 499 - - name: SERVER_ERROR_RANGE_START - uid: '@azure/msal-node.HttpStatus.SERVER_ERROR_RANGE_START' - package: '@azure/msal-node' - summary: '' - numericValue: 500 - - name: SERVER_ERROR_RANGE_END - uid: '@azure/msal-node.HttpStatus.SERVER_ERROR_RANGE_END' - package: '@azure/msal-node' - summary: '' - numericValue: 599 diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/ICacheClient.yml b/nodejs/docs-ref-autogen/@azure/msal-node/ICacheClient.yml index 85396c3..7800a60 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/ICacheClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/ICacheClient.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: '' fullName: ICacheClient remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-node' summary: Retrieve the value from the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(key: string): Promise' @@ -30,7 +28,6 @@ methods: package: '@azure/msal-node' summary: Save the required value using the provided key to cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function set(key: string, value: string): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml index ae35de8..5a7dd21 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml @@ -7,7 +7,6 @@ summary: >- signatures fullName: IConfidentialClientApplication remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -19,7 +18,6 @@ methods: Acquires tokens from the authority for the application (not for an end user) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -39,7 +37,6 @@ methods: Acquires a token by exchanging the authorization code received from the first step of OAuth 2.0 Authorization Code Flow remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -59,7 +56,6 @@ methods: Acquires a token by exchanging the refresh token provided for a new set of tokens remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -80,7 +76,6 @@ methods: Acquires tokens with password grant by exchanging client applications username and password for credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -98,7 +93,6 @@ methods: package: '@azure/msal-node' summary: Acquires tokens from the authority for the application remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -118,7 +112,6 @@ methods: Acquires a token silently when a user specifies the account the token is requested for remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -136,7 +129,6 @@ methods: package: '@azure/msal-node' summary: Clear the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearCache() @@ -145,7 +137,6 @@ methods: package: '@azure/msal-node' summary: Creates the URL of the authorization request remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -163,7 +154,6 @@ methods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -175,7 +165,6 @@ methods: package: '@azure/msal-node' summary: Gets the token cache for the application remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): TokenCache' @@ -189,7 +178,6 @@ methods: This extensibility point is meant for Azure SDK to enhance Managed Identity support remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function SetAppTokenProvider(provider: IAppTokenProvider)' @@ -204,7 +192,6 @@ methods: Replaces the default logger set in configurations with new Logger with new configurations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/LoopbackClient.yml b/nodejs/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml similarity index 63% rename from nodejs/docs-ref-autogen/@azure/msal-node/LoopbackClient.yml rename to nodejs/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml index cf68fc5..347fb8c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/LoopbackClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml @@ -1,29 +1,28 @@ ### YamlMime:TSType -name: LoopbackClient -uid: '@azure/msal-node.LoopbackClient' +name: ILoopbackClient +uid: '@azure/msal-node.ILoopbackClient' package: '@azure/msal-node' -summary: '' -fullName: LoopbackClient +summary: >- + Interface for LoopbackClient allowing to replace the default loopback server + with a custom implementation. +fullName: ILoopbackClient remarks: '' -isPreview: false isDeprecated: false -type: class +type: interface methods: - name: closeServer() - uid: '@azure/msal-node.LoopbackClient.closeServer' + uid: '@azure/msal-node.ILoopbackClient.closeServer' package: '@azure/msal-node' - summary: Close the loopback server + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function closeServer() - name: getRedirectUri() - uid: '@azure/msal-node.LoopbackClient.getRedirectUri' + uid: '@azure/msal-node.ILoopbackClient.getRedirectUri' package: '@azure/msal-node' - summary: Get the port that the loopback server is running on + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(): string' @@ -31,13 +30,10 @@ methods: description: '' type: string - name: 'listenForAuthCode(string, string)' - uid: '@azure/msal-node.LoopbackClient.listenForAuthCode' + uid: '@azure/msal-node.ILoopbackClient.listenForAuthCode' package: '@azure/msal-node' - summary: >- - Spins up a loopback server which returns the server response when the - localhost redirectUri is hit + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml b/nodejs/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml index 4474bcf..cf61ec7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: '' fullName: IPartitionManager remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -30,7 +29,6 @@ methods: [RedisTestApp](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/RedisTestApp) to see it in action. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function extractKey(accountEntity: AccountEntity): Promise' @@ -62,7 +60,6 @@ methods: [RedisTestApp](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/RedisTestApp) to see it in action. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKey(): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml index 7c42d7a..2762733 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml @@ -7,7 +7,6 @@ summary: >- signatures fullName: IPublicClientApplication remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -18,7 +17,6 @@ methods: Acquires a token by exchanging the authorization code received from the first step of OAuth 2.0 Authorization Code Flow remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,7 +34,6 @@ methods: package: '@azure/msal-node' summary: Acquires a token from the authority using OAuth2.0 device code flow remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -56,7 +53,6 @@ methods: Acquires a token by exchanging the refresh token provided for a new set of tokens remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -76,7 +72,6 @@ methods: Acquires tokens with password grant by exchanging client applications username and password for credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -94,7 +89,6 @@ methods: package: '@azure/msal-node' summary: Acquires a token interactively remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -114,7 +108,6 @@ methods: Acquires a token silently when a user specifies the account the token is requested for remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -132,16 +125,25 @@ methods: package: '@azure/msal-node' summary: Clear the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearCache() + - name: getAllAccounts() + uid: '@azure/msal-node.IPublicClientApplication.getAllAccounts' + package: '@azure/msal-node' + summary: Gets all cached accounts + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(): Promise' + return: + description: '' + type: 'Promise<AccountInfo[]>' - name: getAuthCodeUrl(AuthorizationUrlRequest) uid: '@azure/msal-node.IPublicClientApplication.getAuthCodeUrl' package: '@azure/msal-node' summary: Creates the URL of the authorization request remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -159,7 +161,6 @@ methods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -171,7 +172,6 @@ methods: package: '@azure/msal-node' summary: Gets the token cache for the application remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): TokenCache' @@ -185,7 +185,6 @@ methods: Replaces the default logger set in configurations with new Logger with new configurations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' @@ -193,3 +192,18 @@ methods: - id: logger type: Logger description: '' + - name: signOut(SignOutRequest) + uid: '@azure/msal-node.IPublicClientApplication.signOut' + package: '@azure/msal-node' + summary: Removes cache artifacts associated with the given account + remarks: '' + isDeprecated: false + syntax: + content: 'function signOut(request: SignOutRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/ITokenCache.yml b/nodejs/docs-ref-autogen/@azure/msal-node/ITokenCache.yml index ecd0cbb..8e56568 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/ITokenCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/ITokenCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: 'Token cache interface for the client, giving access to cache APIs' fullName: ITokenCache remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal-node' summary: Returns the signed in account matching homeAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -32,7 +30,6 @@ methods: package: '@azure/msal-node' summary: Returns the signed in account matching localAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -50,7 +47,6 @@ methods: package: '@azure/msal-node' summary: API that retrieves all accounts currently in cache to the user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): Promise' @@ -62,7 +58,6 @@ methods: package: '@azure/msal-node' summary: API to remove a specific account and the relevant data from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccount(account: AccountInfo): Promise' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml b/nodejs/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml index 2a4e83b..1e04dc3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: Intermittent type to handle in-memory data objects with defined types fullName: InMemoryCache remarks: '' -isPreview: false isDeprecated: false syntax: | type InMemoryCache = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml index c15f707..a1af7a4 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml @@ -2,10 +2,28 @@ name: InteractiveRequest uid: '@azure/msal-node.InteractiveRequest' package: '@azure/msal-node' -summary: '' +summary: >- + Request object passed by user to configure acquireTokenInteractive API + + - openBrowser - Function to open a browser instance on user's + system. + + - scopes - Array of scopes the application is requesting + access to. + + - successTemplate: - Template to be displayed on the opened browser + instance upon successful token acquisition. + + - errorTemplate - Template to be displayed on the opened browser + instance upon token acquisition failure. + + - windowHandle - Used in native broker flows to properly parent the + native broker window + + - loopbackClient - Custom implementation for a loopback server to + listen for authorization code response. fullName: InteractiveRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type InteractiveRequest = Pick< @@ -22,7 +40,9 @@ syntax: | | "prompt" > & { errorTemplate?: string, + loopbackClient?: ILoopbackClient, openBrowser: (url: string) => Promise, scopes?: Array, successTemplate?: string, + windowHandle?: Buffer, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/JsonCache.yml b/nodejs/docs-ref-autogen/@azure/msal-node/JsonCache.yml index 5ee3919..d3532f2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/JsonCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/JsonCache.yml @@ -7,7 +7,6 @@ summary: >- instantiation fullName: JsonCache remarks: '' -isPreview: false isDeprecated: false syntax: | type JsonCache = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/NetworkUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-node/NetworkUtils.yml deleted file mode 100644 index 250722a..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/NetworkUtils.yml +++ /dev/null @@ -1,35 +0,0 @@ -### YamlMime:TSType -name: NetworkUtils -uid: '@azure/msal-node.NetworkUtils' -package: '@azure/msal-node' -summary: '' -fullName: NetworkUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'getNetworkResponse(Record, T, number)' - uid: '@azure/msal-node.NetworkUtils.getNetworkResponse' - package: '@azure/msal-node' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function getNetworkResponse(headers: Record, - body: T, statusCode: number): NetworkResponse - parameters: - - id: headers - type: 'Record<string, string>' - description: '' - - id: body - type: T - description: '' - - id: statusCode - type: number - description: '' - return: - description: '' - type: NetworkResponse<T> diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/NodeAuthError.yml b/nodejs/docs-ref-autogen/@azure/msal-node/NodeAuthError.yml deleted file mode 100644 index 3f7be2a..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/NodeAuthError.yml +++ /dev/null @@ -1,270 +0,0 @@ -### YamlMime:TSType -name: NodeAuthError -uid: '@azure/msal-node.NodeAuthError' -package: '@azure/msal-node' -summary: '' -fullName: NodeAuthError -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'NodeAuthError(string, string)' - uid: '@azure/msal-node.NodeAuthError.constructor' - package: '@azure/msal-node' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new NodeAuthError(errorCode: string, errorMessage?: string)' - parameters: - - id: errorCode - type: string - description: '' - - id: errorMessage - type: string - description: '' -inheritedProperties: - - name: correlationId - uid: '@azure/msal-node.NodeAuthError.correlationId' - package: '@azure/msal-node' - summary: CorrelationId associated with the error - fullName: correlationId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'correlationId: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From AuthError.correlationId - - name: errorCode - uid: '@azure/msal-node.NodeAuthError.errorCode' - package: '@azure/msal-node' - summary: Short string denoting error - fullName: errorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorCode: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From AuthError.errorCode - - name: errorMessage - uid: '@azure/msal-node.NodeAuthError.errorMessage' - package: '@azure/msal-node' - summary: Detailed description of error - fullName: errorMessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From AuthError.errorMessage - - name: message - uid: '@azure/msal-node.NodeAuthError.message' - package: '@azure/msal-node' - summary: '' - fullName: message - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'message: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.message - - name: name - uid: '@azure/msal-node.NodeAuthError.name' - package: '@azure/msal-node' - summary: '' - fullName: name - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.name - - name: stack - uid: '@azure/msal-node.NodeAuthError.stack' - package: '@azure/msal-node' - summary: '' - fullName: stack - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack - - name: subError - uid: '@azure/msal-node.NodeAuthError.subError' - package: '@azure/msal-node' - summary: Describes the subclass of an error - fullName: subError - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'subError: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From AuthError.subError -inheritedMethods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-node.NodeAuthError.createPostRequestFailed' - package: '@azure/msal-node' - summary: Creates an error for post request failures. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: AuthError - inheritanceDescription: Inherited From AuthError.createPostRequestFailed - - name: createUnexpectedError(string) - uid: '@azure/msal-node.NodeAuthError.createUnexpectedError' - package: '@azure/msal-node' - summary: >- - Creates an error that is thrown when something unexpected happens in the - library. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUnexpectedError(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: |+ - - return: - description: '' - type: AuthError - inheritanceDescription: Inherited From AuthError.createUnexpectedError - - name: setCorrelationId(string) - uid: '@azure/msal-node.NodeAuthError.setCorrelationId' - package: '@azure/msal-node' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setCorrelationId(correlationId: string)' - parameters: - - id: correlationId - type: string - description: '' - inheritanceDescription: Inherited From AuthError.setCorrelationId -methods: - - name: createInvalidLoopbackAddressTypeError() - uid: '@azure/msal-node.NodeAuthError.createInvalidLoopbackAddressTypeError' - package: '@azure/msal-node' - summary: Creates an error thrown if loopback server address is of type string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidLoopbackAddressTypeError(): NodeAuthError' - return: - description: '' - type: - - name: createLoopbackServerAlreadyExistsError() - uid: '@azure/msal-node.NodeAuthError.createLoopbackServerAlreadyExistsError' - package: '@azure/msal-node' - summary: >- - Creates an error thrown if a loopback server already exists when - attempting to create another one. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createLoopbackServerAlreadyExistsError(): NodeAuthError' - return: - description: '' - type: - - name: createLoopbackServerTimeoutError() - uid: '@azure/msal-node.NodeAuthError.createLoopbackServerTimeoutError' - package: '@azure/msal-node' - summary: >- - Creates an error thrown if the loopback server times out registering the - auth code listener. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createLoopbackServerTimeoutError(): NodeAuthError' - return: - description: '' - type: - - name: createNoAuthCodeInResponseError() - uid: '@azure/msal-node.NodeAuthError.createNoAuthCodeInResponseError' - package: '@azure/msal-node' - summary: >- - Creates an error thrown if the server response does not contain an auth - code. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createNoAuthCodeInResponseError(): NodeAuthError' - return: - description: '' - type: - - name: createNoLoopbackServerExistsError() - uid: '@azure/msal-node.NodeAuthError.createNoLoopbackServerExistsError' - package: '@azure/msal-node' - summary: Creates an error thrown if the loopback server has not been spun up yet. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createNoLoopbackServerExistsError(): NodeAuthError' - return: - description: '' - type: - - name: createStateNotFoundError() - uid: '@azure/msal-node.NodeAuthError.createStateNotFoundError' - package: '@azure/msal-node' - summary: Creates an error thrown when the state is not present. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createStateNotFoundError(): NodeAuthError' - return: - description: '' - type: - - name: createUnableToLoadRedirectUrlError() - uid: '@azure/msal-node.NodeAuthError.createUnableToLoadRedirectUrlError' - package: '@azure/msal-node' - summary: Creates an error thrown if the loopback server is unable to get a url. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUnableToLoadRedirectUrlError(): NodeAuthError' - return: - description: '' - type: -extends: AuthError diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml index 84c7289..e26f6b4 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml @@ -33,7 +33,6 @@ summary: >- local metadata cache during authority initialization. Defaults to false. fullName: NodeAuthOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type NodeAuthOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/NodeConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-node/NodeConfiguration.yml index c5d2835..4f419c1 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/NodeConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/NodeConfiguration.yml @@ -5,11 +5,11 @@ package: '@azure/msal-node' summary: '' fullName: NodeConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type NodeConfiguration = { auth: Required, + broker: BrokerOptions, cache: CacheOptions, system: Required, telemetry: Required, diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/NodeStorage.yml b/nodejs/docs-ref-autogen/@azure/msal-node/NodeStorage.yml index 0340128..1d32273 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/NodeStorage.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/NodeStorage.yml @@ -7,7 +7,6 @@ summary: >- storage location or an extension library fullName: NodeStorage remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal-node' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new NodeStorage(logger: Logger, clientId: string, cryptoImpl: ICrypto)' @@ -36,7 +34,6 @@ inheritedMethods: package: '@azure/msal-node' summary: returns cache key used for cloud instance metadata remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generateAuthorityMetadataCacheKey(authority: string): string' @@ -58,7 +55,6 @@ inheritedMethods: not checking for casing as keys are all generated in lower case, remember to convert to lower case if object properties are compared remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -77,7 +73,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Returns all accounts in cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): AccountInfo[]' @@ -92,7 +87,6 @@ inheritedMethods: retrieve appMetadata matching all provided filters; if no filter is set, get all appMetadata remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -112,7 +106,6 @@ inheritedMethods: package: '@azure/msal-node' summary: retrieve authorityMetadata that contains a matching alias remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -133,7 +126,6 @@ inheritedMethods: retrieve credentails matching all provided filters; if no filter is set, get all credentials remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -152,7 +144,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Return the family_id value associated with FOCI remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -175,7 +166,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Retrieve AccessTokenEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -200,7 +190,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Retrieve AccountEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -220,7 +209,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Retrieve AccountEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -239,7 +227,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Retrieve AppMetadataEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -261,7 +248,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Retrieve the cached credentials into a cacherecord remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -289,7 +275,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Retrieve IdTokenEntity from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -311,7 +296,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Helper to retrieve the appropriate refresh token from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -337,7 +321,6 @@ inheritedMethods: package: '@azure/msal-node' summary: returns a boolean if the given account is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccount(accountKey: string): Promise' @@ -354,7 +337,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Removes credentials associated with the provided account remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccountContext(account: AccountEntity): Promise' @@ -372,7 +354,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Removes all accounts and related tokens from cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAllAccounts(): Promise' @@ -385,7 +366,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Removes all app metadata objects from cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAppMetadata(): boolean' @@ -398,7 +378,6 @@ inheritedMethods: package: '@azure/msal-node' summary: returns a boolean if the given credential is removed remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -418,7 +397,6 @@ inheritedMethods: package: '@azure/msal-node' summary: saves a cache record remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' @@ -436,7 +414,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Helper to convert serialized data to object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function toObject(obj: T, json: object): T' @@ -458,7 +435,6 @@ methods: package: '@azure/msal-node' summary: Converts cacheKVStore to InMemoryCache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function cacheToInMemoryCache(cache: CacheKVStore): InMemoryCache' @@ -475,7 +451,6 @@ methods: package: '@azure/msal-node' summary: Clears all cache entries created by MSAL (except tokens). remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function clear(): Promise' @@ -487,7 +462,6 @@ methods: package: '@azure/msal-node' summary: Checks whether key is in cache. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function containsKey(key: string): boolean' @@ -504,7 +478,6 @@ methods: package: '@azure/msal-node' summary: Invoke the callback when cache changes remarks: '' - isPreview: false isDeprecated: false syntax: content: function emitChange() @@ -513,7 +486,6 @@ methods: package: '@azure/msal-node' summary: Initialize in memory cache from an exisiting cache vault remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function generateInMemoryCache(cache: string): InMemoryCache' @@ -530,7 +502,6 @@ methods: package: '@azure/msal-node' summary: retrieves the final JSON remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -549,7 +520,6 @@ methods: package: '@azure/msal-node' summary: fetch the accessToken credential remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -568,7 +538,6 @@ methods: package: '@azure/msal-node' summary: fetch the account entity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccount(accountKey: string): AccountEntity | null' @@ -585,7 +554,6 @@ methods: package: '@azure/msal-node' summary: fetch appMetadata entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -604,7 +572,6 @@ methods: package: '@azure/msal-node' summary: fetch authority metadata entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -623,7 +590,6 @@ methods: package: '@azure/msal-node' summary: Get all authority metadata keys remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAuthorityMetadataKeys(): Array' @@ -635,7 +601,6 @@ methods: package: '@azure/msal-node' summary: get the current cache key-value store remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCache(): CacheKVStore' @@ -647,7 +612,6 @@ methods: package: '@azure/msal-node' summary: fetch the idToken credential remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getIdTokenCredential(idTokenKey: string): IdTokenEntity | null' @@ -664,7 +628,6 @@ methods: package: '@azure/msal-node' summary: gets the current in memory cache for the client remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getInMemoryCache(): InMemoryCache' @@ -676,7 +639,6 @@ methods: package: '@azure/msal-node' summary: Gets cache item with given key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getItem(key: string): ValidCacheType' @@ -693,7 +655,6 @@ methods: package: '@azure/msal-node' summary: Gets all keys in window. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKeys(): string[]' @@ -705,7 +666,6 @@ methods: package: '@azure/msal-node' summary: fetch the refreshToken credential remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -724,7 +684,6 @@ methods: package: '@azure/msal-node' summary: fetch server telemetry entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -743,7 +702,6 @@ methods: package: '@azure/msal-node' summary: fetch throttling entity from the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -762,7 +720,6 @@ methods: package: '@azure/msal-node' summary: converts inMemoryCache to CacheKVStore remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -781,7 +738,6 @@ methods: package: '@azure/msal-node' summary: Queue up callbacks remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function registerChangeEmitter(func: () => void)' @@ -795,7 +751,6 @@ methods: package: '@azure/msal-node' summary: Removes the cache item from memory with the given key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeItem(key: string): boolean' @@ -811,7 +766,6 @@ methods: package: '@azure/msal-node' summary: set accessToken credential remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' @@ -825,7 +779,6 @@ methods: package: '@azure/msal-node' summary: set account entity remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAccount(account: AccountEntity)' @@ -839,7 +792,6 @@ methods: package: '@azure/msal-node' summary: set appMetadata entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' @@ -853,7 +805,6 @@ methods: package: '@azure/msal-node' summary: set authority metadata entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -872,7 +823,6 @@ methods: package: '@azure/msal-node' summary: sets the current cache (key value store) remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCache(cache: CacheKVStore)' @@ -885,7 +835,6 @@ methods: package: '@azure/msal-node' summary: set idToken credential remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setIdTokenCredential(idToken: IdTokenEntity)' @@ -899,7 +848,6 @@ methods: package: '@azure/msal-node' summary: sets the current in memory cache for the client remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setInMemoryCache(inMemoryCache: InMemoryCache)' @@ -913,7 +861,6 @@ methods: package: '@azure/msal-node' summary: Gets cache item with given key-value remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setItem(key: string, value: ValidCacheType)' @@ -930,7 +877,6 @@ methods: package: '@azure/msal-node' summary: set refreshToken credential remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)' @@ -944,7 +890,6 @@ methods: package: '@azure/msal-node' summary: set server telemetry entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -963,7 +908,6 @@ methods: package: '@azure/msal-node' summary: set throttling entity to the platform cache remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -982,7 +926,6 @@ methods: package: '@azure/msal-node' summary: Updates a credential's cache key if the current cache key is outdated remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml index 19414c9..01c29bb 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml @@ -12,10 +12,10 @@ summary: >- calls. Defaults to using MSAL's default http client. fullName: NodeSystemOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type NodeSystemOptions = { + customAgentOptions?: httpAgentOptions | httpsAgentOptions, loggerOptions?: LoggerOptions, networkClient?: INetworkModule, proxyUrl?: string, diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/NodeTelemetryOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-node/NodeTelemetryOptions.yml index cfed5d2..b3baed5 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/NodeTelemetryOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/NodeTelemetryOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: '' fullName: NodeTelemetryOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type NodeTelemetryOptions = { application?: ApplicationTelemetry } diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/OnBehalfOfRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/OnBehalfOfRequest.yml index 43656b7..5140111 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/OnBehalfOfRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/OnBehalfOfRequest.yml @@ -17,9 +17,11 @@ summary: >- - skipCache - Skip token cache lookup and force request to authority to get a a new token. Defaults to false. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call fullName: OnBehalfOfRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type OnBehalfOfRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/PkceGenerator.yml b/nodejs/docs-ref-autogen/@azure/msal-node/PkceGenerator.yml deleted file mode 100644 index 7531db0..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/PkceGenerator.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: PkceGenerator -uid: '@azure/msal-node.PkceGenerator' -package: '@azure/msal-node' -summary: 'https://tools.ietf.org/html/rfc7636#page-8' -fullName: PkceGenerator -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: PkceGenerator() - uid: '@azure/msal-node.PkceGenerator.constructor' - package: '@azure/msal-node' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new PkceGenerator() -methods: - - name: generatePkceCodes() - uid: '@azure/msal-node.PkceGenerator.generatePkceCodes' - package: '@azure/msal-node' - summary: >- - generates the codeVerfier and the challenge from the codeVerfier - - reference: https://tools.ietf.org/html/rfc7636#section-4.1 and - https://tools.ietf.org/html/rfc7636#section-4.2 - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generatePkceCodes(): Promise' - return: - description: '' - type: Promise<PkceCodes> diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/ProxyStatus.yml b/nodejs/docs-ref-autogen/@azure/msal-node/ProxyStatus.yml deleted file mode 100644 index b1edeef..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/ProxyStatus.yml +++ /dev/null @@ -1,25 +0,0 @@ -### YamlMime:TSEnum -name: ProxyStatus -uid: '@azure/msal-node.ProxyStatus' -package: '@azure/msal-node' -summary: '' -fullName: ProxyStatus -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: SUCCESS_RANGE_START - uid: '@azure/msal-node.ProxyStatus.SUCCESS_RANGE_START' - package: '@azure/msal-node' - summary: '' - numericValue: 200 - - name: SUCCESS_RANGE_END - uid: '@azure/msal-node.ProxyStatus.SUCCESS_RANGE_END' - package: '@azure/msal-node' - summary: '' - numericValue: 299 - - name: SERVER_ERROR - uid: '@azure/msal-node.ProxyStatus.SERVER_ERROR' - package: '@azure/msal-node' - summary: '' - numericValue: 500 diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml index 11f924c..9ce3cc4 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml @@ -10,7 +10,6 @@ summary: >- request tokens in the name of an user. fullName: PublicClientApplication remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -54,7 +53,6 @@ constructors: ADFS authorities are of the form https://\{instance\}/adfs. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new PublicClientApplication(configuration: Configuration)' @@ -80,7 +78,6 @@ inheritedMethods: AuthorizationCodeRequest are the same. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -115,7 +112,6 @@ inheritedMethods: handle the caching and refreshing of tokens automatically. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -148,7 +144,6 @@ inheritedMethods: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -165,46 +160,11 @@ inheritedMethods: inheritanceDescription: >- Inherited From [ClientApplication.acquireTokenByUsernamePassword](xref:@azure/msal-node.ClientApplication.acquireTokenByUsernamePassword) - - name: acquireTokenSilent(SilentFlowRequest) - uid: '@azure/msal-node.PublicClientApplication.acquireTokenSilent' - package: '@azure/msal-node' - summary: > - Acquires a token silently when a user specifies the account the token is - requested for. - - This API expects the user to provide an account object and looks into the - cache to retrieve the token if present. - - There is also an optional "forceRefresh" boolean the user can send to - bypass the cache for access_token and id_token. - - In case the refresh_token is expired or not found, an error is thrown - - and the guidance is for the user to call any interactive token acquisition - API (eg: `acquireTokenByCode()`). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireTokenSilent(request: SilentFlowRequest): - Promise - parameters: - - id: request - type: - description: '' - return: - description: '' - type: Promise<AuthenticationResult | null> - inheritanceDescription: >- - Inherited From - [ClientApplication.acquireTokenSilent](xref:@azure/msal-node.ClientApplication.acquireTokenSilent) - name: clearCache() uid: '@azure/msal-node.PublicClientApplication.clearCache' package: '@azure/msal-node' summary: Clear the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearCache() @@ -231,7 +191,6 @@ inheritedMethods: `acquireTokenByCode(AuthorizationCodeRequest)`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -252,7 +211,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' @@ -267,7 +225,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Gets the token cache for the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): TokenCache' @@ -284,7 +241,6 @@ inheritedMethods: Replaces the default logger set in configurations with new Logger with new configurations remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' @@ -320,7 +276,6 @@ methods: until the end-user completes input of credentials. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -337,10 +292,9 @@ methods: uid: '@azure/msal-node.PublicClientApplication.acquireTokenInteractive' package: '@azure/msal-node' summary: >- - Acquires a token by requesting an Authorization code then exchanging it - for a token. + Acquires a token interactively via the browser by requesting an + authorization code then exchanging it for a token. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -353,4 +307,52 @@ methods: return: description: '' type: Promise<AuthenticationResult> + - name: acquireTokenSilent(SilentFlowRequest) + uid: '@azure/msal-node.PublicClientApplication.acquireTokenSilent' + package: '@azure/msal-node' + summary: >- + Returns a token retrieved either from the cache or by exchanging the + refresh token for a fresh access token. If brokering is enabled the token + request will be serviced by the broker. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(request: SilentFlowRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<AuthenticationResult | null> + - name: getAllAccounts() + uid: '@azure/msal-node.PublicClientApplication.getAllAccounts' + package: '@azure/msal-node' + summary: >- + Returns all cached accounts for this application. If brokering is enabled + this request will be serviced by the broker. + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(): Promise' + return: + description: '' + type: 'Promise<AccountInfo[]>' + - name: signOut(SignOutRequest) + uid: '@azure/msal-node.PublicClientApplication.signOut' + package: '@azure/msal-node' + summary: Removes cache artifacts associated with the given account + remarks: '' + isDeprecated: false + syntax: + content: 'function signOut(request: SignOutRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> extends: diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/RefreshTokenRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/RefreshTokenRequest.yml index 85a45c1..4a8ece3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/RefreshTokenRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/RefreshTokenRequest.yml @@ -27,7 +27,6 @@ summary: >- when there is no account in the cache. Used for migration scenarios. fullName: RefreshTokenRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type RefreshTokenRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml index e2a33f6..7c42d75 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: Access token credential type fullName: SerializedAccessTokenEntity remarks: '' -isPreview: false isDeprecated: false syntax: | type SerializedAccessTokenEntity = { @@ -24,4 +23,5 @@ syntax: | secret: string, target: string, token_type?: string, + userAssertionHash?: string, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml index 814e487..278f81a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: Account type fullName: SerializedAccountEntity remarks: '' -isPreview: false isDeprecated: false syntax: | type SerializedAccountEntity = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml index 8f3fa99..681a09d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: AppMetadata type fullName: SerializedAppMetadataEntity remarks: '' -isPreview: false isDeprecated: false syntax: | type SerializedAppMetadataEntity = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml index f51f41e..86e0c82 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: Idtoken credential type fullName: SerializedIdTokenEntity remarks: '' -isPreview: false isDeprecated: false syntax: | type SerializedIdTokenEntity = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml index a411297..fa07a2d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: Refresh token credential type fullName: SerializedRefreshTokenEntity remarks: '' -isPreview: false isDeprecated: false syntax: | type SerializedRefreshTokenEntity = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/Serializer.yml b/nodejs/docs-ref-autogen/@azure/msal-node/Serializer.yml deleted file mode 100644 index 6493768..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-node/Serializer.yml +++ /dev/null @@ -1,149 +0,0 @@ -### YamlMime:TSType -name: Serializer -uid: '@azure/msal-node.Serializer' -package: '@azure/msal-node' -summary: '' -fullName: Serializer -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: serializeAccessTokens(AccessTokenCache) - uid: '@azure/msal-node.Serializer.serializeAccessTokens' - package: '@azure/msal-node' - summary: Serializes AccessTokens - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function serializeAccessTokens(atCache: AccessTokenCache): - Record - parameters: - - id: atCache - type: AccessTokenCache - description: |+ - - return: - description: '' - type: >- - Record<string, > - - name: serializeAccounts(AccountCache) - uid: '@azure/msal-node.Serializer.serializeAccounts' - package: '@azure/msal-node' - summary: Serialize Accounts - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function serializeAccounts(accCache: AccountCache): - Record - parameters: - - id: accCache - type: AccountCache - description: |+ - - return: - description: '' - type: >- - Record<string, > - - name: serializeAllCache(InMemoryCache) - uid: '@azure/msal-node.Serializer.serializeAllCache' - package: '@azure/msal-node' - summary: Serialize the cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function serializeAllCache(inMemCache: InMemoryCache): JsonCache' - parameters: - - id: inMemCache - type: - description: '' - return: - description: '' - type: - - name: serializeAppMetadata(AppMetadataCache) - uid: '@azure/msal-node.Serializer.serializeAppMetadata' - package: '@azure/msal-node' - summary: Serialize amdtCache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function serializeAppMetadata(amdtCache: AppMetadataCache): - Record - parameters: - - id: amdtCache - type: AppMetadataCache - description: |+ - - return: - description: '' - type: >- - Record<string, > - - name: serializeIdTokens(IdTokenCache) - uid: '@azure/msal-node.Serializer.serializeIdTokens' - package: '@azure/msal-node' - summary: Serialize IdTokens - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function serializeIdTokens(idTCache: IdTokenCache): - Record - parameters: - - id: idTCache - type: IdTokenCache - description: |+ - - return: - description: '' - type: >- - Record<string, > - - name: serializeJSONBlob(JsonCache) - uid: '@azure/msal-node.Serializer.serializeJSONBlob' - package: '@azure/msal-node' - summary: serialize the JSON blob - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function serializeJSONBlob(data: JsonCache): string' - parameters: - - id: data - type: - description: |+ - - return: - description: '' - type: string - - name: serializeRefreshTokens(RefreshTokenCache) - uid: '@azure/msal-node.Serializer.serializeRefreshTokens' - package: '@azure/msal-node' - summary: Serialize refreshTokens - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function serializeRefreshTokens(rtCache: RefreshTokenCache): - Record - parameters: - - id: rtCache - type: RefreshTokenCache - description: |+ - - return: - description: '' - type: >- - Record<string, > diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/SignOutRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/SignOutRequest.yml new file mode 100644 index 0000000..7fc7b07 --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-node/SignOutRequest.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: SignOutRequest +uid: '@azure/msal-node.SignOutRequest' +package: '@azure/msal-node' +summary: '' +fullName: SignOutRequest +remarks: '' +isDeprecated: false +syntax: | + type SignOutRequest = { account: AccountInfo, correlationId?: string } diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml index 43458ef..9bdc195 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml @@ -18,7 +18,7 @@ summary: >- - correlationId - Unique GUID set per request to trace a request end-to-end for telemetry purposes. - - tokenQueryParameters - String to string map of custom query parameters + - tokenQueryParameters - String to string map of custom query parameters added to the /token call - account - Account entity to lookup the credentials. @@ -27,7 +27,6 @@ summary: >- true. fullName: SilentFlowRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type SilentFlowRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/TokenCache.yml b/nodejs/docs-ref-autogen/@azure/msal-node/TokenCache.yml index cfb8238..3cd9898 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/TokenCache.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/TokenCache.yml @@ -5,7 +5,6 @@ package: '@azure/msal-node' summary: In-memory token cache manager fullName: TokenCache remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal-node' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -38,7 +36,6 @@ methods: Deserializes JSON to in-memory cache. JSON should be in MSAL cache schema format remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function deserialize(cache: string)' @@ -55,7 +52,6 @@ methods: (the account object is created at the time of successful login) or null when no matching account is found remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -77,7 +73,6 @@ methods: (the account object is created at the time of successful login) or null when no matching account is found remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -97,7 +92,6 @@ methods: package: '@azure/msal-node' summary: API that retrieves all accounts currently in cache to the user remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): Promise' @@ -109,7 +103,6 @@ methods: package: '@azure/msal-node' summary: Fetches the cache key-value map remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKVStore(): CacheKVStore' @@ -123,7 +116,6 @@ methods: Set to true if cache state has changed since last time serialize or writeToPersistence was called remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function hasChanged(): boolean' @@ -135,7 +127,6 @@ methods: package: '@azure/msal-node' summary: API to remove a specific account and the relevant data from cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccount(account: AccountInfo): Promise' @@ -152,7 +143,6 @@ methods: package: '@azure/msal-node' summary: Serializes in memory cache to JSON remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function serialize(): string' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml b/nodejs/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml index a33e7be..ee8b6ee 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml @@ -24,9 +24,11 @@ summary: >- - username - username of the client - password - credentials + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call fullName: UsernamePasswordRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type UsernamePasswordRequest = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/index.yml b/nodejs/docs-ref-autogen/@azure/msal-node/index.yml index ccf719c..5aeeb68 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/index.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/index.yml @@ -9,25 +9,16 @@ interfaces: - '@azure/msal-node.IPartitionManager' - '@azure/msal-node.IConfidentialClientApplication' - '@azure/msal-node.IPublicClientApplication' + - '@azure/msal-node.ILoopbackClient' classes: - '@azure/msal-node.NodeStorage' - '@azure/msal-node.TokenCache' - '@azure/msal-node.DistributedCachePlugin' - - '@azure/msal-node.Deserializer' - - '@azure/msal-node.Serializer' - '@azure/msal-node.ClientApplication' - '@azure/msal-node.ClientAssertion' - '@azure/msal-node.ConfidentialClientApplication' - '@azure/msal-node.PublicClientApplication' - '@azure/msal-node.CryptoProvider' - - '@azure/msal-node.GuidGenerator' - - '@azure/msal-node.HashUtils' - - '@azure/msal-node.PkceGenerator' - - '@azure/msal-node.NodeAuthError' - - '@azure/msal-node.HttpClient' - - '@azure/msal-node.LoopbackClient' - - '@azure/msal-node.EncodingUtils' - - '@azure/msal-node.NetworkUtils' typeAliases: - '@azure/msal-node.CacheKVStore' - '@azure/msal-node.InMemoryCache' @@ -37,6 +28,7 @@ typeAliases: - '@azure/msal-node.SerializedAppMetadataEntity' - '@azure/msal-node.SerializedIdTokenEntity' - '@azure/msal-node.SerializedRefreshTokenEntity' + - '@azure/msal-node.BrokerOptions' - '@azure/msal-node.CacheOptions' - '@azure/msal-node.Configuration' - '@azure/msal-node.NodeAuthOptions' @@ -50,6 +42,7 @@ typeAliases: - '@azure/msal-node.InteractiveRequest' - '@azure/msal-node.OnBehalfOfRequest' - '@azure/msal-node.RefreshTokenRequest' + - '@azure/msal-node.SignOutRequest' - '@azure/msal-node.SilentFlowRequest' - '@azure/msal-node.UsernamePasswordRequest' functions: @@ -60,14 +53,15 @@ functions: string, thumbprint: string, x5c?: string }, clientId: string, clientSecret?: string, cloudDiscoveryMetadata?: string, knownAuthorities?: Array, protocolMode?: ProtocolMode, skipAuthorityMetadataCache?: - boolean }, cache: { cachePlugin?: ICachePlugin }, system: { - loggerOptions?: LoggerOptions, networkClient?: INetworkModule, proxyUrl?: - string }, telemetry: { application?: ApplicationTelemetry } }) + boolean }, broker: { nativeBrokerPlugin?: INativeBrokerPlugin }, cache: { + cachePlugin?: ICachePlugin }, system: { customAgentOptions?: + httpAgentOptions | httpsAgentOptions, loggerOptions?: LoggerOptions, + networkClient?: INetworkModule, proxyUrl?: string }, telemetry: { + application?: ApplicationTelemetry } }) uid: '@azure/msal-node.buildAppConfiguration' package: '@azure/msal-node' summary: Sets the default options when not explicitly configured from app developer remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -78,9 +72,11 @@ functions: string, x5c?: string }, clientId: string, clientSecret?: string, cloudDiscoveryMetadata?: string, knownAuthorities?: Array, protocolMode?: ProtocolMode, skipAuthorityMetadataCache?: boolean }, - cache: { cachePlugin?: ICachePlugin }, system: { loggerOptions?: - LoggerOptions, networkClient?: INetworkModule, proxyUrl?: string }, - telemetry: { application?: ApplicationTelemetry } }): NodeConfiguration + broker: { nativeBrokerPlugin?: INativeBrokerPlugin }, cache: { + cachePlugin?: ICachePlugin }, system: { customAgentOptions?: + httpAgentOptions | httpsAgentOptions, loggerOptions?: LoggerOptions, + networkClient?: INetworkModule, proxyUrl?: string }, telemetry: { + application?: ApplicationTelemetry } }): NodeConfiguration parameters: - id: __namedParameters type: >- @@ -90,16 +86,13 @@ functions: privateKey: string, thumbprint: string, x5c?: string }, clientId: string, clientSecret?: string, cloudDiscoveryMetadata?: string, knownAuthorities?: Array<string>, protocolMode?: ProtocolMode, - skipAuthorityMetadataCache?: boolean }, cache: { cachePlugin?: - ICachePlugin }, system: { loggerOptions?: LoggerOptions, - networkClient?: INetworkModule, proxyUrl?: string }, telemetry: { - application?: ApplicationTelemetry } } + skipAuthorityMetadataCache?: boolean }, broker: { + nativeBrokerPlugin?: INativeBrokerPlugin }, cache: { cachePlugin?: + ICachePlugin }, system: { customAgentOptions?: httpAgentOptions | + httpsAgentOptions, loggerOptions?: LoggerOptions, networkClient?: + INetworkModule, proxyUrl?: string }, telemetry: { application?: + ApplicationTelemetry } } description: '' return: description: Configuration type: -enums: - - '@azure/msal-node.ApiId' - - '@azure/msal-node.HttpMethod' - - '@azure/msal-node.HttpStatus' - - '@azure/msal-node.ProxyStatus' diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml b/nodejs/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml index 05a77f4..7e4c9ad 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: AccountIdentifiers remarks: '' -isPreview: false isDeprecated: false syntax: | type AccountIdentifiers = Partial< diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml b/nodejs/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml index a868bc3..c6a1ef9 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: AuthenticatedTemplateProps remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthenticatedTemplateProps = PropsWithChildren diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/FaaCFunction.yml b/nodejs/docs-ref-autogen/@azure/msal-react/FaaCFunction.yml index 595649b..6db4969 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/FaaCFunction.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/FaaCFunction.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: FaaCFunction remarks: '' -isPreview: false isDeprecated: false syntax: | type FaaCFunction = (args: T) => React.ReactNode diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/IMsalContext.yml b/nodejs/docs-ref-autogen/@azure/msal-react/IMsalContext.yml index 1d33e7c..613cda0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/IMsalContext.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/IMsalContext.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: IMsalContext remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: accounts remarks: '' - isPreview: false isDeprecated: false syntax: content: 'accounts: AccountInfo[]' @@ -28,7 +26,6 @@ properties: summary: '' fullName: inProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inProgress: InteractionStatus' @@ -41,7 +38,6 @@ properties: summary: '' fullName: instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'instance: IPublicClientApplication' @@ -54,7 +50,6 @@ properties: summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml b/nodejs/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml index 22c76ce..7bc9212 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: MsalAuthenticationProps remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalAuthenticationProps = PropsWithChildren< diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml b/nodejs/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml index aa6ee5c..69341e8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: MsalAuthenticationResult remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalAuthenticationResult = { diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml b/nodejs/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml index ee137ae..8666c2b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: MsalProviderProps remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalProviderProps = PropsWithChildren<{ diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/ReactAuthError.yml b/nodejs/docs-ref-autogen/@azure/msal-react/ReactAuthError.yml deleted file mode 100644 index 5803204..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-react/ReactAuthError.yml +++ /dev/null @@ -1,206 +0,0 @@ -### YamlMime:TSType -name: ReactAuthError -uid: '@azure/msal-react.ReactAuthError' -package: '@azure/msal-react' -summary: '' -fullName: ReactAuthError -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'ReactAuthError(string, string)' - uid: '@azure/msal-react.ReactAuthError.constructor' - package: '@azure/msal-react' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new ReactAuthError(errorCode: string, errorMessage?: string)' - parameters: - - id: errorCode - type: string - description: '' - - id: errorMessage - type: string - description: '' -inheritedProperties: - - name: correlationId - uid: '@azure/msal-react.ReactAuthError.correlationId' - package: '@azure/msal-react' - summary: CorrelationId associated with the error - fullName: correlationId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'correlationId: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From AuthError.correlationId - - name: errorCode - uid: '@azure/msal-react.ReactAuthError.errorCode' - package: '@azure/msal-react' - summary: Short string denoting error - fullName: errorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorCode: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From AuthError.errorCode - - name: errorMessage - uid: '@azure/msal-react.ReactAuthError.errorMessage' - package: '@azure/msal-react' - summary: Detailed description of error - fullName: errorMessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From AuthError.errorMessage - - name: message - uid: '@azure/msal-react.ReactAuthError.message' - package: '@azure/msal-react' - summary: '' - fullName: message - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'message: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.message - - name: name - uid: '@azure/msal-react.ReactAuthError.name' - package: '@azure/msal-react' - summary: '' - fullName: name - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.name - - name: stack - uid: '@azure/msal-react.ReactAuthError.stack' - package: '@azure/msal-react' - summary: '' - fullName: stack - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack - - name: subError - uid: '@azure/msal-react.ReactAuthError.subError' - package: '@azure/msal-react' - summary: Describes the subclass of an error - fullName: subError - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'subError: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From AuthError.subError -inheritedMethods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-react.ReactAuthError.createPostRequestFailed' - package: '@azure/msal-react' - summary: Creates an error for post request failures. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: AuthError - inheritanceDescription: Inherited From AuthError.createPostRequestFailed - - name: createUnexpectedError(string) - uid: '@azure/msal-react.ReactAuthError.createUnexpectedError' - package: '@azure/msal-react' - summary: >- - Creates an error that is thrown when something unexpected happens in the - library. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUnexpectedError(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: |+ - - return: - description: '' - type: AuthError - inheritanceDescription: Inherited From AuthError.createUnexpectedError - - name: setCorrelationId(string) - uid: '@azure/msal-react.ReactAuthError.setCorrelationId' - package: '@azure/msal-react' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setCorrelationId(correlationId: string)' - parameters: - - id: correlationId - type: string - description: '' - inheritanceDescription: Inherited From AuthError.setCorrelationId -methods: - - name: createInvalidInteractionTypeError() - uid: '@azure/msal-react.ReactAuthError.createInvalidInteractionTypeError' - package: '@azure/msal-react' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidInteractionTypeError(): ReactAuthError' - return: - description: '' - type: - - name: createUnableToFallbackToInteractionError() - uid: '@azure/msal-react.ReactAuthError.createUnableToFallbackToInteractionError' - package: '@azure/msal-react' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createUnableToFallbackToInteractionError(): - ReactAuthError - return: - description: '' - type: -extends: AuthError diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/SetComplement.yml b/nodejs/docs-ref-autogen/@azure/msal-react/SetComplement.yml index 819a124..2fc43a2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/SetComplement.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/SetComplement.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: 'SetComplement' remarks: '' -isPreview: false isDeprecated: false syntax: | type SetComplement = SetDifference diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/SetDifference.yml b/nodejs/docs-ref-autogen/@azure/msal-react/SetDifference.yml index 753bda5..a47d5cc 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/SetDifference.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/SetDifference.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: 'SetDifference' remarks: '' -isPreview: false isDeprecated: false syntax: | type SetDifference = SetDifference diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/Subtract.yml b/nodejs/docs-ref-autogen/@azure/msal-react/Subtract.yml index 1a95714..eb719f0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/Subtract.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/Subtract.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: 'Subtract' remarks: '' -isPreview: false isDeprecated: false syntax: | type Subtract = Pick> diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/UnauthenticatedTemplateProps.yml b/nodejs/docs-ref-autogen/@azure/msal-react/UnauthenticatedTemplateProps.yml index ab4f1b1..f205942 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/UnauthenticatedTemplateProps.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/UnauthenticatedTemplateProps.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: UnauthenticatedTemplateProps remarks: '' -isPreview: false isDeprecated: false syntax: | type UnauthenticatedTemplateProps = PropsWithChildren diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml b/nodejs/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml index 25ac21e..5152bd0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml @@ -5,7 +5,6 @@ package: '@azure/msal-react' summary: '' fullName: WithMsalProps remarks: '' -isPreview: false isDeprecated: false syntax: | type WithMsalProps = { msalContext: IMsalContext } diff --git a/nodejs/docs-ref-autogen/@azure/msal-react/index.yml b/nodejs/docs-ref-autogen/@azure/msal-react/index.yml index bd7d03f..c0a6523 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-react/index.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-react/index.yml @@ -25,7 +25,6 @@ functions: MSAL context provider component. This must be rendered above any other components that use MSAL. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -45,7 +44,6 @@ functions: package: '@azure/msal-react' summary: Renders child components if user is authenticated remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -71,7 +69,6 @@ functions: Attempts to authenticate user if not already authenticated, then renders child components remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -96,7 +93,6 @@ functions: package: '@azure/msal-react' summary: Renders child components if user is unauthenticated remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -119,7 +115,6 @@ functions: Given 1 or more accountIdentifiers, returns the Account object if the user is signed-in remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -140,7 +135,6 @@ functions: Returns whether or not a user is currently signed-in. Optionally provide 1 or more accountIdentifiers to determine if a specific user is signed-in remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function useIsAuthenticated(matchAccount?: AccountIdentifiers): boolean' @@ -169,7 +163,6 @@ functions: Optionally provide a specific user that should be logged in. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -200,7 +193,6 @@ functions: Helper function to determine whether 2 arrays are equal Used to avoid unnecessary state updates remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -222,7 +214,6 @@ functions: package: '@azure/msal-react' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -243,7 +234,6 @@ functions: package: '@azure/msal-react' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -261,5 +251,3 @@ functions: return: description: '' type: -classes: - - '@azure/msal-react.ReactAuthError' diff --git a/nodejs/docs-ref-autogen/@azure/msal/API_CODE.yml b/nodejs/docs-ref-autogen/@azure/msal/API_CODE.yml index 53f801b..bb3cd4e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/API_CODE.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/API_CODE.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: API_CODE remarks: '' -isPreview: false isDeprecated: false fields: - name: AcquireTokenRedirect diff --git a/nodejs/docs-ref-autogen/@azure/msal/API_EVENT_IDENTIFIER.yml b/nodejs/docs-ref-autogen/@azure/msal/API_EVENT_IDENTIFIER.yml index dbf69e5..a0ba363 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/API_EVENT_IDENTIFIER.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/API_EVENT_IDENTIFIER.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: API_EVENT_IDENTIFIER remarks: '' -isPreview: false isDeprecated: false fields: - name: AcquireTokenPopup diff --git a/nodejs/docs-ref-autogen/@azure/msal/Account.yml b/nodejs/docs-ref-autogen/@azure/msal/Account.yml index e21fe16..86ff9e3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/Account.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/Account.yml @@ -12,7 +12,6 @@ summary: |- environment idtoken.issuer (the authority that issues the token) fullName: Account remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -21,7 +20,6 @@ constructors: package: '@azure/msal' summary: Creates an Account Object remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -58,7 +56,6 @@ properties: summary: '' fullName: accountIdentifier remarks: '' - isPreview: false isDeprecated: false syntax: content: 'accountIdentifier: string' @@ -71,7 +68,6 @@ properties: summary: '' fullName: environment remarks: '' - isPreview: false isDeprecated: false syntax: content: 'environment: string' @@ -84,7 +80,6 @@ properties: summary: '' fullName: homeAccountIdentifier remarks: '' - isPreview: false isDeprecated: false syntax: content: 'homeAccountIdentifier: string' @@ -97,7 +92,6 @@ properties: summary: '' fullName: idToken remarks: '' - isPreview: false isDeprecated: false syntax: content: 'idToken: StringDict' @@ -110,7 +104,6 @@ properties: summary: '' fullName: idTokenClaims remarks: '' - isPreview: false isDeprecated: false syntax: content: 'idTokenClaims: StringDict' @@ -123,7 +116,6 @@ properties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -136,7 +128,6 @@ properties: summary: '' fullName: sid remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sid: string' @@ -149,7 +140,6 @@ properties: summary: '' fullName: userName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userName: string' @@ -164,7 +154,6 @@ methods: Utils function to compare two Account objects - used to check if the same user account is logged in remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function compareAccounts(a1: Account, a2: Account): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal/ApiEvent.yml b/nodejs/docs-ref-autogen/@azure/msal/ApiEvent.yml index 2e2e2dc..729a6a4 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/ApiEvent.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/ApiEvent.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: ApiEvent remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,7 +35,6 @@ properties: summary: '' fullName: accountId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'accountId: string' @@ -50,7 +47,6 @@ properties: summary: '' fullName: apiCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'apiCode: number' @@ -63,7 +59,6 @@ properties: summary: '' fullName: apiErrorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'apiErrorCode: string' @@ -76,7 +71,6 @@ properties: summary: '' fullName: apiEventIdentifier remarks: '' - isPreview: false isDeprecated: false syntax: content: 'apiEventIdentifier: string' @@ -89,7 +83,6 @@ properties: summary: '' fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: string' @@ -102,7 +95,6 @@ properties: summary: '' fullName: authorityType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authorityType: string' @@ -115,7 +107,6 @@ properties: summary: '' fullName: loginHint remarks: '' - isPreview: false isDeprecated: false syntax: content: 'loginHint: string' @@ -128,7 +119,6 @@ properties: summary: '' fullName: promptType remarks: '' - isPreview: false isDeprecated: false syntax: content: 'promptType: string' @@ -141,7 +131,6 @@ properties: summary: '' fullName: tenantId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'tenantId: string' @@ -154,7 +143,6 @@ properties: summary: '' fullName: wasSuccessful remarks: '' - isPreview: false isDeprecated: false syntax: content: 'wasSuccessful: boolean' @@ -168,7 +156,6 @@ inheritedProperties: summary: '' fullName: displayName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayName: string' @@ -184,7 +171,6 @@ inheritedProperties: summary: '' fullName: eventId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventId: string' @@ -200,7 +186,6 @@ inheritedProperties: summary: '' fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName: string' @@ -216,7 +201,6 @@ inheritedProperties: summary: '' fullName: key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'key: string' @@ -232,7 +216,6 @@ inheritedProperties: summary: '' fullName: telemetryCorrelationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryCorrelationId: string' @@ -248,7 +231,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(): object' @@ -263,7 +245,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function start() @@ -275,7 +256,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function stop() diff --git a/nodejs/docs-ref-autogen/@azure/msal/AuthError.yml b/nodejs/docs-ref-autogen/@azure/msal/AuthError.yml index affd2d6..bb1522a 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/AuthError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/AuthError.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: General error class thrown by the MSAL.js library. fullName: AuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AuthError(errorCode: string, errorMessage?: string)' @@ -32,7 +30,6 @@ properties: summary: '' fullName: Error remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static Error: ErrorConstructor' @@ -45,7 +42,6 @@ properties: summary: '' fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -58,7 +54,6 @@ properties: summary: '' fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -72,7 +67,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -86,7 +80,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -100,7 +93,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -114,7 +106,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoWindowObjectError(errDesc: string): AuthError' @@ -130,7 +121,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' diff --git a/nodejs/docs-ref-autogen/@azure/msal/AuthOptions.yml b/nodejs/docs-ref-autogen/@azure/msal/AuthOptions.yml index a55edaf..06b528e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/AuthOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/AuthOptions.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: AuthOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal/AuthResponse.yml b/nodejs/docs-ref-autogen/@azure/msal/AuthResponse.yml index 70a760b..f67b816 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/AuthResponse.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/AuthResponse.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: AuthResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthResponse = { diff --git a/nodejs/docs-ref-autogen/@azure/msal/AuthenticationParameters.yml b/nodejs/docs-ref-autogen/@azure/msal/AuthenticationParameters.yml index 61c33f1..5ab05c2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/AuthenticationParameters.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/AuthenticationParameters.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: AuthenticationParameters remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthenticationParameters = { diff --git a/nodejs/docs-ref-autogen/@azure/msal/AuthorityFactory.yml b/nodejs/docs-ref-autogen/@azure/msal/AuthorityFactory.yml deleted file mode 100644 index 1b6951c..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal/AuthorityFactory.yml +++ /dev/null @@ -1,100 +0,0 @@ -### YamlMime:TSType -name: AuthorityFactory -uid: '@azure/msal.AuthorityFactory' -package: '@azure/msal' -summary: '' -fullName: AuthorityFactory -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'CreateInstance(string, boolean, string)' - uid: '@azure/msal.AuthorityFactory.CreateInstance' - package: '@azure/msal' - summary: >- - Create an authority object of the correct type based on the url - - Performs basic authority validation - checks to see if the authority is of - a valid type (eg aad, b2c) - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function CreateInstance(authorityUrl: string, validateAuthority: - boolean, authorityMetadata?: string): Authority - parameters: - - id: authorityUrl - type: string - description: '' - - id: validateAuthority - type: boolean - description: '' - - id: authorityMetadata - type: string - description: '' - return: - description: '' - type: Authority - - name: getMetadata(string) - uid: '@azure/msal.AuthorityFactory.getMetadata' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function getMetadata(authorityUrl: string): - ITenantDiscoveryResponse - parameters: - - id: authorityUrl - type: string - description: '' - return: - description: '' - type: ITenantDiscoveryResponse - - name: 'saveMetadataFromConfig(string, string)' - uid: '@azure/msal.AuthorityFactory.saveMetadataFromConfig' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function saveMetadataFromConfig(authorityUrl: string, - authorityMetadataJson: string) - parameters: - - id: authorityUrl - type: string - description: '' - - id: authorityMetadataJson - type: string - description: '' - - name: 'saveMetadataFromNetwork(Authority, TelemetryManager, string)' - uid: '@azure/msal.AuthorityFactory.saveMetadataFromNetwork' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function saveMetadataFromNetwork(authorityInstance: Authority, - telemetryManager: TelemetryManager, correlationId: string): - Promise - parameters: - - id: authorityInstance - type: Authority - description: '' - - id: telemetryManager - type: - description: '' - - id: correlationId - type: string - description: '' - return: - description: '' - type: Promise<ITenantDiscoveryResponse> diff --git a/nodejs/docs-ref-autogen/@azure/msal/CacheLocation.yml b/nodejs/docs-ref-autogen/@azure/msal/CacheLocation.yml index 52cd6cc..9623195 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/CacheLocation.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/CacheLocation.yml @@ -8,7 +8,6 @@ summary: |- - session storage: MSAL uses the browsers session storage to store its cache fullName: CacheLocation remarks: '' -isPreview: false isDeprecated: false syntax: | type CacheLocation = "localStorage" | "sessionStorage" diff --git a/nodejs/docs-ref-autogen/@azure/msal/CacheOptions.yml b/nodejs/docs-ref-autogen/@azure/msal/CacheOptions.yml index 342c119..c5923c8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/CacheOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/CacheOptions.yml @@ -13,7 +13,6 @@ summary: > this flag is set to false. fullName: CacheOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type CacheOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal/ClientAuthError.yml b/nodejs/docs-ref-autogen/@azure/msal/ClientAuthError.yml index a1631aa..eeff298 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/ClientAuthError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/ClientAuthError.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: Error thrown when there is an error in the client code running on the browser. fullName: ClientAuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ClientAuthError(errorCode: string, errorMessage?: string)' @@ -32,7 +30,6 @@ inheritedProperties: summary: '' fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -48,7 +45,6 @@ inheritedProperties: summary: '' fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -64,7 +60,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -78,7 +73,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -92,7 +86,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -106,7 +99,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoWindowObjectError(errDesc: string): AuthError' @@ -125,7 +117,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -145,7 +136,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createAcquireTokenInProgressError(): ClientAuthError' @@ -157,7 +147,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -171,7 +160,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createCacheParseError(key: string): ClientAuthError' @@ -187,7 +175,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -205,7 +192,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -223,7 +209,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -241,7 +226,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -259,7 +243,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -277,7 +260,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -295,7 +277,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -313,7 +294,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidInteractionTypeError(): ClientAuthError' @@ -325,7 +305,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -346,7 +325,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createLoginInProgressError(): ClientAuthError' @@ -358,7 +336,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -376,7 +353,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -397,7 +373,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -415,7 +390,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -433,7 +407,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createTokenRenewalTimeoutError(): ClientAuthError' @@ -445,7 +418,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserCancelledError(): ClientAuthError' @@ -457,7 +429,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserDoesNotExistError(): ClientAuthError' @@ -469,7 +440,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserLoginRequiredError(): ClientAuthError' diff --git a/nodejs/docs-ref-autogen/@azure/msal/ClientConfigurationError.yml b/nodejs/docs-ref-autogen/@azure/msal/ClientConfigurationError.yml index 8ff9de9..b881b94 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/ClientConfigurationError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/ClientConfigurationError.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: Error thrown when there is an error in configuration of the .js library. fullName: ClientConfigurationError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ClientConfigurationError(errorCode: string, errorMessage?: string)' @@ -32,7 +30,6 @@ inheritedProperties: summary: '' fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -48,7 +45,6 @@ inheritedProperties: summary: '' fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -64,7 +60,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -78,7 +73,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -92,7 +86,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -106,7 +99,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createAcquireTokenInProgressError(): ClientAuthError' @@ -122,7 +114,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -139,7 +130,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createCacheParseError(key: string): ClientAuthError' @@ -158,7 +148,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -179,7 +168,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -200,7 +188,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -221,7 +208,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -242,7 +228,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -263,7 +248,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -284,7 +268,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -305,7 +288,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createInvalidInteractionTypeError(): ClientAuthError' @@ -320,7 +302,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -344,7 +325,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createLoginInProgressError(): ClientAuthError' @@ -359,7 +339,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -380,7 +359,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -404,7 +382,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoWindowObjectError(errDesc: string): AuthError' @@ -423,7 +400,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -444,7 +420,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -465,7 +440,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createTokenRenewalTimeoutError(): ClientAuthError' @@ -480,7 +454,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -499,7 +472,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserCancelledError(): ClientAuthError' @@ -514,7 +486,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserDoesNotExistError(): ClientAuthError' @@ -529,7 +500,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUserLoginRequiredError(): ClientAuthError' @@ -545,7 +515,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -563,7 +532,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createEmptyRequestError(): ClientConfigurationError' @@ -575,7 +543,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -593,7 +560,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -607,7 +573,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -621,7 +586,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -639,7 +603,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -653,7 +616,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -671,7 +633,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -685,7 +646,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -699,7 +659,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -713,7 +672,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -731,7 +689,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -749,7 +706,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createSsoSilentError(): ClientConfigurationError' @@ -761,7 +717,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -779,7 +734,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -797,7 +751,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/nodejs/docs-ref-autogen/@azure/msal/CompletedEvents.yml b/nodejs/docs-ref-autogen/@azure/msal/CompletedEvents.yml index ceb00c3..f9547b7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/CompletedEvents.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/CompletedEvents.yml @@ -5,6 +5,5 @@ package: '@azure/msal' summary: '' fullName: CompletedEvents remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/nodejs/docs-ref-autogen/@azure/msal/Configuration.yml b/nodejs/docs-ref-autogen/@azure/msal/Configuration.yml index db8c9e4..9d9bdd3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/Configuration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/Configuration.yml @@ -20,7 +20,6 @@ summary: > to come here soon. fullName: Configuration remarks: '' -isPreview: false isDeprecated: false syntax: | type Configuration = { diff --git a/nodejs/docs-ref-autogen/@azure/msal/DefaultEvent.yml b/nodejs/docs-ref-autogen/@azure/msal/DefaultEvent.yml deleted file mode 100644 index 6f510e8..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal/DefaultEvent.yml +++ /dev/null @@ -1,157 +0,0 @@ -### YamlMime:TSType -name: DefaultEvent -uid: '@azure/msal.DefaultEvent' -package: '@azure/msal' -summary: '' -fullName: DefaultEvent -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'DefaultEvent(TelemetryPlatform, string, string, EventCount)' - uid: '@azure/msal.DefaultEvent.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new DefaultEvent(platform: TelemetryPlatform, correlationId: string, - clientId: string, eventCount: EventCount) - parameters: - - id: platform - type: - description: '' - - id: correlationId - type: string - description: '' - - id: clientId - type: string - description: '' - - id: eventCount - type: - description: '' -inheritedProperties: - - name: displayName - uid: '@azure/msal.DefaultEvent.displayName' - package: '@azure/msal' - summary: '' - fullName: displayName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'displayName: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TelemetryEvent.displayName](xref:@azure/msal.TelemetryEvent.displayName) - - name: eventId - uid: '@azure/msal.DefaultEvent.eventId' - package: '@azure/msal' - summary: '' - fullName: eventId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'eventId: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TelemetryEvent.eventId](xref:@azure/msal.TelemetryEvent.eventId) - - name: eventName - uid: '@azure/msal.DefaultEvent.eventName' - package: '@azure/msal' - summary: '' - fullName: eventName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'eventName: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TelemetryEvent.eventName](xref:@azure/msal.TelemetryEvent.eventName) - - name: key - uid: '@azure/msal.DefaultEvent.key' - package: '@azure/msal' - summary: '' - fullName: key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'key: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TelemetryEvent.key](xref:@azure/msal.TelemetryEvent.key) - - name: telemetryCorrelationId - uid: '@azure/msal.DefaultEvent.telemetryCorrelationId' - package: '@azure/msal' - summary: '' - fullName: telemetryCorrelationId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryCorrelationId: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TelemetryEvent.telemetryCorrelationId](xref:@azure/msal.TelemetryEvent.telemetryCorrelationId) -inheritedMethods: - - name: get() - uid: '@azure/msal.DefaultEvent.get' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function get(): object' - return: - description: '' - type: object - inheritanceDescription: >- - Inherited From - [TelemetryEvent.get](xref:@azure/msal.TelemetryEvent.get) - - name: start() - uid: '@azure/msal.DefaultEvent.start' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function start() - inheritanceDescription: >- - Inherited From - [TelemetryEvent.start](xref:@azure/msal.TelemetryEvent.start) - - name: stop() - uid: '@azure/msal.DefaultEvent.stop' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function stop() - inheritanceDescription: >- - Inherited From - [TelemetryEvent.stop](xref:@azure/msal.TelemetryEvent.stop) -extends: diff --git a/nodejs/docs-ref-autogen/@azure/msal/ErrorCacheKeys.yml b/nodejs/docs-ref-autogen/@azure/msal/ErrorCacheKeys.yml index d30d846..1614f6b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/ErrorCacheKeys.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/ErrorCacheKeys.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: ErrorCacheKeys remarks: '' -isPreview: false isDeprecated: false fields: - name: ERROR diff --git a/nodejs/docs-ref-autogen/@azure/msal/EventCount.yml b/nodejs/docs-ref-autogen/@azure/msal/EventCount.yml index 3c8267f..51396d3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/EventCount.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/EventCount.yml @@ -5,6 +5,5 @@ package: '@azure/msal' summary: '' fullName: EventCount remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/nodejs/docs-ref-autogen/@azure/msal/EventCountByCorrelationId.yml b/nodejs/docs-ref-autogen/@azure/msal/EventCountByCorrelationId.yml index 2965067..1749632 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/EventCountByCorrelationId.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/EventCountByCorrelationId.yml @@ -5,6 +5,5 @@ package: '@azure/msal' summary: '' fullName: EventCountByCorrelationId remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/nodejs/docs-ref-autogen/@azure/msal/FrameworkOptions.yml b/nodejs/docs-ref-autogen/@azure/msal/FrameworkOptions.yml index f260908..b2c28b3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/FrameworkOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/FrameworkOptions.yml @@ -22,7 +22,6 @@ summary: >+ fullName: FrameworkOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type FrameworkOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal/HttpEvent.yml b/nodejs/docs-ref-autogen/@azure/msal/HttpEvent.yml index 0c01757..2cbf788 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/HttpEvent.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/HttpEvent.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: HttpEvent remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new HttpEvent(correlationId: string, eventLabel: string)' @@ -32,7 +30,6 @@ properties: summary: '' fullName: apiVersion remarks: '' - isPreview: false isDeprecated: false syntax: content: 'apiVersion: string' @@ -45,7 +42,6 @@ properties: summary: '' fullName: httpMethod remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpMethod: string' @@ -58,7 +54,6 @@ properties: summary: '' fullName: httpPath remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpPath: string' @@ -71,7 +66,6 @@ properties: summary: '' fullName: httpResponseStatus remarks: '' - isPreview: false isDeprecated: false syntax: content: 'httpResponseStatus: number' @@ -84,7 +78,6 @@ properties: summary: '' fullName: oAuthErrorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'oAuthErrorCode: string' @@ -97,7 +90,6 @@ properties: summary: '' fullName: queryParams remarks: '' - isPreview: false isDeprecated: false syntax: content: 'queryParams: any' @@ -110,7 +102,6 @@ properties: summary: '' fullName: requestIdHeader remarks: '' - isPreview: false isDeprecated: false syntax: content: 'requestIdHeader: string' @@ -123,7 +114,6 @@ properties: summary: '' fullName: serverErrorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serverErrorCode: string' @@ -136,7 +126,6 @@ properties: summary: '' fullName: serverSubErrorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'serverSubErrorCode: string' @@ -155,7 +144,6 @@ properties: indicates the request occurred on the inner ring fullName: speInfo remarks: '' - isPreview: false isDeprecated: false syntax: content: 'speInfo: string' @@ -168,7 +156,6 @@ properties: summary: '' fullName: url remarks: '' - isPreview: false isDeprecated: false syntax: content: 'url: string' @@ -181,7 +168,6 @@ properties: summary: '' fullName: userAgent remarks: '' - isPreview: false isDeprecated: false syntax: content: 'userAgent: string' @@ -195,7 +181,6 @@ inheritedProperties: summary: '' fullName: displayName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayName: string' @@ -211,7 +196,6 @@ inheritedProperties: summary: '' fullName: eventId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventId: string' @@ -227,7 +211,6 @@ inheritedProperties: summary: '' fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName: string' @@ -243,7 +226,6 @@ inheritedProperties: summary: '' fullName: key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'key: string' @@ -259,7 +241,6 @@ inheritedProperties: summary: '' fullName: telemetryCorrelationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryCorrelationId: string' @@ -275,7 +256,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(): object' @@ -290,7 +270,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function start() @@ -302,7 +281,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function stop() diff --git a/nodejs/docs-ref-autogen/@azure/msal/IClientConfigurationErrorMessage.yml b/nodejs/docs-ref-autogen/@azure/msal/IClientConfigurationErrorMessage.yml index 7b35917..b90dd32 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/IClientConfigurationErrorMessage.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/IClientConfigurationErrorMessage.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: IClientConfigurationErrorMessage remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: code remarks: '' - isPreview: false isDeprecated: false syntax: content: 'code: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: desc remarks: '' - isPreview: false isDeprecated: false syntax: content: 'desc: string' diff --git a/nodejs/docs-ref-autogen/@azure/msal/ILoggerCallback.yml b/nodejs/docs-ref-autogen/@azure/msal/ILoggerCallback.yml index b658672..a152f3e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/ILoggerCallback.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/ILoggerCallback.yml @@ -5,6 +5,5 @@ package: '@azure/msal' summary: '' fullName: ILoggerCallback remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/nodejs/docs-ref-autogen/@azure/msal/InProgressEvents.yml b/nodejs/docs-ref-autogen/@azure/msal/InProgressEvents.yml index 4342355..71b0a40 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/InProgressEvents.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/InProgressEvents.yml @@ -5,6 +5,5 @@ package: '@azure/msal' summary: '' fullName: InProgressEvents remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/nodejs/docs-ref-autogen/@azure/msal/InteractionRequiredAuthError.yml b/nodejs/docs-ref-autogen/@azure/msal/InteractionRequiredAuthError.yml index 13af3c5..5c57ab5 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/InteractionRequiredAuthError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/InteractionRequiredAuthError.yml @@ -7,7 +7,6 @@ summary: >- request. fullName: InteractionRequiredAuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,7 +34,6 @@ inheritedProperties: summary: '' fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -52,7 +49,6 @@ inheritedProperties: summary: '' fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -68,7 +64,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -82,7 +77,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -96,7 +90,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -110,7 +103,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoWindowObjectError(errDesc: string): AuthError' @@ -129,7 +121,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createServerUnavailableError(): ServerError' @@ -144,7 +135,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -163,7 +153,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnknownServerError(errorDesc: string): ServerError' @@ -183,7 +172,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -202,7 +190,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -220,7 +207,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -238,7 +224,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function isInteractionRequiredError(errorString: string): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal/InteractionType.yml b/nodejs/docs-ref-autogen/@azure/msal/InteractionType.yml index 9dafdb6..b20718e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/InteractionType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/InteractionType.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: InteractionType remarks: '' -isPreview: false isDeprecated: false syntax: | type InteractionType = diff --git a/nodejs/docs-ref-autogen/@azure/msal/LibraryStateObject.yml b/nodejs/docs-ref-autogen/@azure/msal/LibraryStateObject.yml deleted file mode 100644 index 5812c0c..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal/LibraryStateObject.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: LibraryStateObject -uid: '@azure/msal.LibraryStateObject' -package: '@azure/msal' -summary: '' -fullName: LibraryStateObject -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type LibraryStateObject = { id: string, method: string, ts: number } diff --git a/nodejs/docs-ref-autogen/@azure/msal/LogLevel.yml b/nodejs/docs-ref-autogen/@azure/msal/LogLevel.yml index 100a058..a69ceb2 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/LogLevel.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/LogLevel.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: LogLevel remarks: '' -isPreview: false isDeprecated: false fields: - name: Error diff --git a/nodejs/docs-ref-autogen/@azure/msal/Logger.yml b/nodejs/docs-ref-autogen/@azure/msal/Logger.yml index e9e8856..9a6753d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/Logger.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/Logger.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: Logger remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,7 +35,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isPiiLoggingEnabled(): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal/NetworkInformation.yml b/nodejs/docs-ref-autogen/@azure/msal/NetworkInformation.yml index 4cb7f52..94607ac 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/NetworkInformation.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/NetworkInformation.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: NetworkInformation remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: connectionSpeed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'connectionSpeed: string' diff --git a/nodejs/docs-ref-autogen/@azure/msal/OpenIdConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal/OpenIdConfiguration.yml index 51d3fd0..54f1027 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/OpenIdConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/OpenIdConfiguration.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: Response type for openid-configuration endpoints fullName: OpenIdConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type OpenIdConfiguration = { diff --git a/nodejs/docs-ref-autogen/@azure/msal/PersistentCacheKeys.yml b/nodejs/docs-ref-autogen/@azure/msal/PersistentCacheKeys.yml index d4ee036..b47903f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/PersistentCacheKeys.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/PersistentCacheKeys.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: PersistentCacheKeys remarks: '' -isPreview: false isDeprecated: false fields: - name: CLIENT_INFO diff --git a/nodejs/docs-ref-autogen/@azure/msal/ScopeSet.yml b/nodejs/docs-ref-autogen/@azure/msal/ScopeSet.yml deleted file mode 100644 index e235d7a..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal/ScopeSet.yml +++ /dev/null @@ -1,146 +0,0 @@ -### YamlMime:TSType -name: ScopeSet -uid: '@azure/msal.ScopeSet' -package: '@azure/msal' -summary: '' -fullName: ScopeSet -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'containsScope(Array, Array)' - uid: '@azure/msal.ScopeSet.containsScope' - package: '@azure/msal' - summary: Check if a given scope is present in the request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function containsScope(cachedScopes: Array, scopes: - Array): boolean - parameters: - - id: cachedScopes - type: Array<string> - description: '' - - id: scopes - type: Array<string> - description: |+ - - return: - description: '' - type: boolean - - name: 'isIntersectingScopes(Array, Array)' - uid: '@azure/msal.ScopeSet.isIntersectingScopes' - package: '@azure/msal' - summary: Check if there are dup scopes in a given request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function isIntersectingScopes(cachedScopes: Array, - scopes: Array): boolean - parameters: - - id: cachedScopes - type: Array<string> - description: '' - - id: scopes - type: Array<string> - description: |+ - - return: - description: '' - type: boolean - - name: parseScope(Array) - uid: '@azure/msal.ScopeSet.parseScope' - package: '@azure/msal' - summary: Parse the scopes into a formatted scopeList - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function parseScope(scopes: Array): string' - parameters: - - id: scopes - type: Array<string> - description: |+ - - return: - description: '' - type: string - - name: 'removeElement(Array, string)' - uid: '@azure/msal.ScopeSet.removeElement' - package: '@azure/msal' - summary: Remove one element from a scope array - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function removeElement(scopes: Array, scope: string): - Array - parameters: - - id: scopes - type: Array<string> - description: '' - - id: scope - type: string - description: |+ - - return: - description: '' - type: Array<string> - - name: trimAndConvertArrayToLowerCase(Array) - uid: '@azure/msal.ScopeSet.trimAndConvertArrayToLowerCase' - package: '@azure/msal' - summary: Performs trimAndConvertToLowerCase on string array - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function trimAndConvertArrayToLowerCase(scopes: Array): - Array - parameters: - - id: scopes - type: Array<string> - description: |+ - - return: - description: '' - type: Array<string> - - name: trimAndConvertToLowerCase(string) - uid: '@azure/msal.ScopeSet.trimAndConvertToLowerCase' - package: '@azure/msal' - summary: Trims and converts string to lower case - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function trimAndConvertToLowerCase(scope: string): string' - parameters: - - id: scope - type: string - description: '' - return: - description: '' - type: string - - name: trimScopes(Array) - uid: '@azure/msal.ScopeSet.trimScopes' - package: '@azure/msal' - summary: Trims each scope in scopes array - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function trimScopes(scopes: Array): Array' - parameters: - - id: scopes - type: Array<string> - description: |+ - - return: - description: '' - type: Array<string> diff --git a/nodejs/docs-ref-autogen/@azure/msal/ServerError.yml b/nodejs/docs-ref-autogen/@azure/msal/ServerError.yml index a8c320d..3157653 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/ServerError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/ServerError.yml @@ -7,7 +7,6 @@ summary: >- unavailability. fullName: ServerError remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -16,7 +15,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ServerError(errorCode: string, errorMessage?: string)' @@ -34,7 +32,6 @@ inheritedProperties: summary: '' fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -50,7 +47,6 @@ inheritedProperties: summary: '' fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -66,7 +62,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -80,7 +75,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -94,7 +88,6 @@ inheritedProperties: summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -108,7 +101,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createNoWindowObjectError(errDesc: string): AuthError' @@ -127,7 +119,6 @@ inheritedMethods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnexpectedError(errDesc: string): AuthError' @@ -147,7 +138,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createServerUnavailableError(): ServerError' @@ -159,7 +149,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function createUnknownServerError(errorDesc: string): ServerError' diff --git a/nodejs/docs-ref-autogen/@azure/msal/ServerHashParamKeys.yml b/nodejs/docs-ref-autogen/@azure/msal/ServerHashParamKeys.yml index 316033a..e3c71ba 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/ServerHashParamKeys.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/ServerHashParamKeys.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: Keys in the hashParams fullName: ServerHashParamKeys remarks: '' -isPreview: false isDeprecated: false fields: - name: ACCESS_TOKEN diff --git a/nodejs/docs-ref-autogen/@azure/msal/StringDict.yml b/nodejs/docs-ref-autogen/@azure/msal/StringDict.yml index 2768fca..b386aff 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/StringDict.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/StringDict.yml @@ -5,6 +5,5 @@ package: '@azure/msal' summary: 'Key-Value type to support queryParams, extraQueryParams and claims' fullName: StringDict remarks: '' -isPreview: false isDeprecated: false syntax: 'type StringDict = [key: string]: string' diff --git a/nodejs/docs-ref-autogen/@azure/msal/SystemOptions.yml b/nodejs/docs-ref-autogen/@azure/msal/SystemOptions.yml index 8a0d1cf..2ad9465 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/SystemOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/SystemOptions.yml @@ -18,7 +18,6 @@ summary: > navigation fullName: SystemOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type SystemOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal/TelemetryConfig.yml b/nodejs/docs-ref-autogen/@azure/msal/TelemetryConfig.yml index d93bd00..687a2ed 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/TelemetryConfig.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/TelemetryConfig.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: TelemetryConfig remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: clientId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'clientId: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: onlySendFailureTelemetry remarks: '' - isPreview: false isDeprecated: false syntax: content: 'onlySendFailureTelemetry?: boolean' @@ -41,7 +38,6 @@ properties: summary: '' fullName: platform remarks: '' - isPreview: false isDeprecated: false syntax: content: 'platform: TelemetryPlatform' diff --git a/nodejs/docs-ref-autogen/@azure/msal/TelemetryEmitter.yml b/nodejs/docs-ref-autogen/@azure/msal/TelemetryEmitter.yml index 6f01444..600beda 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/TelemetryEmitter.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/TelemetryEmitter.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: TelemetryEmitter remarks: '' -isPreview: false isDeprecated: false syntax: | type TelemetryEmitter = (events: Array) => void diff --git a/nodejs/docs-ref-autogen/@azure/msal/TelemetryEvent.yml b/nodejs/docs-ref-autogen/@azure/msal/TelemetryEvent.yml index 6ea605e..9cbc7fe 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/TelemetryEvent.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/TelemetryEvent.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: TelemetryEvent remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,7 +35,6 @@ properties: summary: '' fullName: displayName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'displayName: string' @@ -50,7 +47,6 @@ properties: summary: '' fullName: eventId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventId: string' @@ -63,7 +59,6 @@ properties: summary: '' fullName: eventName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'eventName: string' @@ -76,7 +71,6 @@ properties: summary: '' fullName: key remarks: '' - isPreview: false isDeprecated: false syntax: content: 'key: string' @@ -89,7 +83,6 @@ properties: summary: '' fullName: telemetryCorrelationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'telemetryCorrelationId: string' @@ -102,7 +95,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(): object' @@ -114,7 +106,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function start() @@ -123,7 +114,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function stop() diff --git a/nodejs/docs-ref-autogen/@azure/msal/TelemetryManager.yml b/nodejs/docs-ref-autogen/@azure/msal/TelemetryManager.yml index ecdf290..9ec082e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/TelemetryManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/TelemetryManager.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: TelemetryManager remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -14,7 +13,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -36,7 +34,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -57,7 +54,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -84,7 +80,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function flush(correlationId: string)' @@ -97,7 +92,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -118,7 +112,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function startEvent(event: TelemetryEvent)' @@ -131,7 +124,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -155,7 +147,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function stopEvent(event: TelemetryEvent)' diff --git a/nodejs/docs-ref-autogen/@azure/msal/TelemetryOptions.yml b/nodejs/docs-ref-autogen/@azure/msal/TelemetryOptions.yml index 7fa35a1..bd76d73 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/TelemetryOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/TelemetryOptions.yml @@ -13,7 +13,6 @@ summary: >- to fullName: TelemetryOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type TelemetryOptions = { diff --git a/nodejs/docs-ref-autogen/@azure/msal/TelemetryPlatform.yml b/nodejs/docs-ref-autogen/@azure/msal/TelemetryPlatform.yml index cb5bd6c..4f8531d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/TelemetryPlatform.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/TelemetryPlatform.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: TelemetryPlatform remarks: '' -isPreview: false isDeprecated: false type: interface properties: @@ -15,7 +14,6 @@ properties: summary: '' fullName: applicationName remarks: '' - isPreview: false isDeprecated: false syntax: content: 'applicationName: string' @@ -28,7 +26,6 @@ properties: summary: '' fullName: applicationVersion remarks: '' - isPreview: false isDeprecated: false syntax: content: 'applicationVersion: string' @@ -41,7 +38,6 @@ properties: summary: '' fullName: networkInformation remarks: '' - isPreview: false isDeprecated: false syntax: content: 'networkInformation?: NetworkInformation' @@ -54,7 +50,6 @@ properties: summary: '' fullName: sdk remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sdk?: string' @@ -67,7 +62,6 @@ properties: summary: '' fullName: sdkVersion remarks: '' - isPreview: false isDeprecated: false syntax: content: 'sdkVersion?: string' diff --git a/nodejs/docs-ref-autogen/@azure/msal/TrustedAuthority.yml b/nodejs/docs-ref-autogen/@azure/msal/TrustedAuthority.yml deleted file mode 100644 index bf1a867..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal/TrustedAuthority.yml +++ /dev/null @@ -1,85 +0,0 @@ -### YamlMime:TSType -name: TrustedAuthority -uid: '@azure/msal.TrustedAuthority' -package: '@azure/msal' -summary: '' -fullName: TrustedAuthority -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: getTrustedHostList() - uid: '@azure/msal.TrustedAuthority.getTrustedHostList' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function getTrustedHostList(): Array' - return: - description: '' - type: Array<string> - - name: IsInTrustedHostList(string) - uid: '@azure/msal.TrustedAuthority.IsInTrustedHostList' - package: '@azure/msal' - summary: Checks to see if the host is in a list of trusted hosts - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function IsInTrustedHostList(host: string): boolean' - parameters: - - id: host - type: string - description: |+ - - return: - description: '' - type: boolean - - name: 'setTrustedAuthoritiesFromConfig(boolean, Array)' - uid: '@azure/msal.TrustedAuthority.setTrustedAuthoritiesFromConfig' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function setTrustedAuthoritiesFromConfig(validateAuthority: - boolean, knownAuthorities: Array) - parameters: - - id: validateAuthority - type: boolean - description: '' - - id: knownAuthorities - type: Array<string> - description: |+ - - - name: 'setTrustedAuthoritiesFromNetwork(string, TelemetryManager, string)' - uid: '@azure/msal.TrustedAuthority.setTrustedAuthoritiesFromNetwork' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function setTrustedAuthoritiesFromNetwork(authorityToVerify: - string, telemetryManager: TelemetryManager, correlationId?: string): - Promise - parameters: - - id: authorityToVerify - type: string - description: '' - - id: telemetryManager - type: - description: '' - - id: correlationId - type: string - description: |+ - - return: - description: '' - type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@azure/msal/UserAgentApplication.yml b/nodejs/docs-ref-autogen/@azure/msal/UserAgentApplication.yml index 7642139..edbff84 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/UserAgentApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/UserAgentApplication.yml @@ -9,7 +9,6 @@ summary: > functions fullName: UserAgentApplication remarks: '' -isPreview: false isDeprecated: false type: class constructors: @@ -18,7 +17,6 @@ constructors: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new UserAgentApplication(configuration: Configuration)' @@ -34,7 +32,6 @@ properties: summary: Method to manage the authority URL. fullName: authority remarks: '' - isPreview: false isDeprecated: false syntax: content: 'authority: string' @@ -49,7 +46,6 @@ methods: Use when you want to obtain an access_token for your API via opening a popup window in the user's browser remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -72,7 +68,6 @@ methods: Use when you want to obtain an access_token for your API by redirecting the user's browser window to the authorization endpoint. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function acquireTokenRedirect(userRequest: AuthenticationParameters)' @@ -92,7 +87,6 @@ methods: Or it send's a request to the STS to obtain a new token using a hidden iframe. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -116,7 +110,6 @@ methods: (the account object is created at the time of successful login) or null when no state is found remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAccount(): Account' @@ -130,7 +123,6 @@ methods: Use to get a list of unique accounts in MSAL cache based on homeAccountIdentifier. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): Array' @@ -142,7 +134,6 @@ methods: package: '@azure/msal' summary: Get the current authority instance from the MSAL configuration object remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAuthorityInstance(): Authority' @@ -154,7 +145,6 @@ methods: package: '@azure/msal' summary: 'Use to get the current object in MSAL' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getCurrentConfiguration(): Configuration' @@ -166,7 +156,6 @@ methods: package: '@azure/msal' summary: Return boolean flag to developer to help inform if login is in progress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLoginInProgress(): boolean' @@ -182,7 +171,6 @@ methods: Evaluates postLogoutredirectUri if its a function, otherwise simply returns its value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getPostLogoutRedirectUri(): string' @@ -198,7 +186,6 @@ methods: Evaluates redirectUri if its a function, otherwise simply returns its value. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getRedirectUri(reqRedirectUri?: string): string' @@ -216,7 +203,6 @@ methods: Use when initiating the login process via opening a popup window in the user's browser remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -239,7 +225,6 @@ methods: Use when initiating the login process by redirecting the user's browser to the authorization endpoint. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loginRedirect(userRequest?: AuthenticationParameters)' @@ -256,7 +241,6 @@ methods: Default behaviour is to redirect the user to `window.location.href`. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(correlationId?: string)' @@ -269,7 +253,6 @@ methods: package: '@azure/msal' summary: Sets the logger callback. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' @@ -285,7 +268,6 @@ methods: API interfacing idToken request when applications already have a session/hint acquired by authorization client applications remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -304,7 +286,6 @@ methods: package: '@azure/msal' summary: Public API to verify if the URL contains the hash with known properties remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function urlContainsHash(hash: string): boolean' diff --git a/nodejs/docs-ref-autogen/@azure/msal/WindowUtils.yml b/nodejs/docs-ref-autogen/@azure/msal/WindowUtils.yml index 5674528..b6a2a56 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/WindowUtils.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/WindowUtils.yml @@ -5,7 +5,6 @@ package: '@azure/msal' summary: '' fullName: WindowUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: @@ -14,7 +13,6 @@ methods: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function checkIfBackButtonIsPressed(cacheStorage: AuthCache)' @@ -28,7 +26,6 @@ methods: package: '@azure/msal' summary: Removes url fragment from browser url remarks: '' - isPreview: false isDeprecated: false syntax: content: static function clearUrlFragment() diff --git a/nodejs/docs-ref-autogen/@azure/msal/XhrResponse.yml b/nodejs/docs-ref-autogen/@azure/msal/XhrResponse.yml deleted file mode 100644 index 6c9313a..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal/XhrResponse.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: XhrResponse -uid: '@azure/msal.XhrResponse' -package: '@azure/msal' -summary: '' -fullName: XhrResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type XhrResponse = { body: any, statusCode: number } diff --git a/nodejs/docs-ref-autogen/@azure/msal/authResponseCallback.yml b/nodejs/docs-ref-autogen/@azure/msal/authResponseCallback.yml index 1ce6e70..600bcf5 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/authResponseCallback.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/authResponseCallback.yml @@ -7,7 +7,6 @@ summary: |- fullName: authResponseCallback remarks: '' -isPreview: false isDeprecated: false syntax: | type authResponseCallback = ( diff --git a/nodejs/docs-ref-autogen/@azure/msal/errorReceivedCallback.yml b/nodejs/docs-ref-autogen/@azure/msal/errorReceivedCallback.yml index 47ce970..fa74f3c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/errorReceivedCallback.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/errorReceivedCallback.yml @@ -7,7 +7,6 @@ summary: |- fullName: errorReceivedCallback remarks: '' -isPreview: false isDeprecated: false syntax: > type errorReceivedCallback = (authErr: AuthError, accountState: string) => diff --git a/nodejs/docs-ref-autogen/@azure/msal/index.yml b/nodejs/docs-ref-autogen/@azure/msal/index.yml index b5574a6..206e4a4 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/index.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/index.yml @@ -6,17 +6,13 @@ type: package classes: - '@azure/msal.Account' - '@azure/msal.Logger' - - '@azure/msal.ScopeSet' - '@azure/msal.UserAgentApplication' - - '@azure/msal.AuthorityFactory' - - '@azure/msal.TrustedAuthority' - '@azure/msal.AuthError' - '@azure/msal.ClientAuthError' - '@azure/msal.ClientConfigurationError' - '@azure/msal.InteractionRequiredAuthError' - '@azure/msal.ServerError' - '@azure/msal.ApiEvent' - - '@azure/msal.DefaultEvent' - '@azure/msal.HttpEvent' - '@azure/msal.TelemetryEvent' - '@azure/msal.TelemetryManager' @@ -35,18 +31,15 @@ typeAliases: - '@azure/msal.authResponseCallback' - '@azure/msal.errorReceivedCallback' - '@azure/msal.tokenReceivedCallback' - - '@azure/msal.XhrResponse' - '@azure/msal.OpenIdConfiguration' - '@azure/msal.TelemetryEmitter' - '@azure/msal.InteractionType' - - '@azure/msal.LibraryStateObject' functions: - name: buildResponseStateOnly(string) uid: '@azure/msal.buildResponseStateOnly' package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function buildResponseStateOnly(state: string): AuthResponse' @@ -62,7 +55,6 @@ functions: package: '@azure/msal' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function validateClaimsRequest(request: AuthenticationParameters)' @@ -87,7 +79,6 @@ functions: MSAL function that sets the default options when not explicitly configured from app developer remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -124,7 +115,6 @@ functions: package: '@azure/msal' summary: MSAL JS Library Version remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function libraryVersion(): string' diff --git a/nodejs/docs-ref-autogen/@azure/msal/tokenReceivedCallback.yml b/nodejs/docs-ref-autogen/@azure/msal/tokenReceivedCallback.yml index 6c16ebd..734d398 100644 --- a/nodejs/docs-ref-autogen/@azure/msal/tokenReceivedCallback.yml +++ b/nodejs/docs-ref-autogen/@azure/msal/tokenReceivedCallback.yml @@ -7,7 +7,6 @@ summary: |- fullName: tokenReceivedCallback remarks: '' -isPreview: false isDeprecated: false syntax: | type tokenReceivedCallback = (response: AuthResponse) => void diff --git a/nodejs/docs-ref-autogen/toc.yml b/nodejs/docs-ref-autogen/toc.yml index cc05488..edf6298 100644 --- a/nodejs/docs-ref-autogen/toc.yml +++ b/nodejs/docs-ref-autogen/toc.yml @@ -1,4 +1,4 @@ -- name: 'MSAL' +- name: '@azure/msal' items: - name: Overview uid: '@azure/msal' @@ -23,9 +23,6 @@ - uid: '@azure/msal.AuthOptions' name: AuthOptions items: [] - - uid: '@azure/msal.AuthorityFactory' - name: AuthorityFactory - items: [] - uid: '@azure/msal.AuthResponse' name: AuthResponse items: [] @@ -50,9 +47,6 @@ - uid: '@azure/msal.Configuration' name: Configuration items: [] - - uid: '@azure/msal.DefaultEvent' - name: DefaultEvent - items: [] - uid: '@azure/msal.ErrorCacheKeys' name: ErrorCacheKeys items: [] @@ -86,9 +80,6 @@ - uid: '@azure/msal.InteractionType' name: InteractionType items: [] - - uid: '@azure/msal.LibraryStateObject' - name: LibraryStateObject - items: [] - uid: '@azure/msal.Logger' name: Logger items: [] @@ -104,9 +95,6 @@ - uid: '@azure/msal.PersistentCacheKeys' name: PersistentCacheKeys items: [] - - uid: '@azure/msal.ScopeSet' - name: ScopeSet - items: [] - uid: '@azure/msal.ServerError' name: ServerError items: [] @@ -140,19 +128,13 @@ - uid: '@azure/msal.tokenReceivedCallback' name: tokenReceivedCallback items: [] - - uid: '@azure/msal.TrustedAuthority' - name: TrustedAuthority - items: [] - uid: '@azure/msal.UserAgentApplication' name: UserAgentApplication items: [] - uid: '@azure/msal.WindowUtils' name: WindowUtils items: [] - - uid: '@azure/msal.XhrResponse' - name: XhrResponse - items: [] -- name: 'MSAL Angular' +- name: '@azure/msal-angular' items: - name: Overview uid: '@azure/msal-angular' @@ -201,28 +183,19 @@ - uid: '@azure/msal-angular.ProtectedResourceScopes' name: ProtectedResourceScopes items: [] -- name: 'MSAL Browser' +- name: '@azure/msal-browser' items: - name: Overview uid: '@azure/msal-browser' - uid: '@azure/msal-browser.ApiId' name: ApiId items: [] - - uid: '@azure/msal-browser.AsyncMemoryStorage' - name: AsyncMemoryStorage - items: [] - uid: '@azure/msal-browser.AuthorizationCodeRequest' name: AuthorizationCodeRequest items: [] - uid: '@azure/msal-browser.AuthorizationUrlRequest' name: AuthorizationUrlRequest items: [] - - uid: '@azure/msal-browser.Base64Decode' - name: Base64Decode - items: [] - - uid: '@azure/msal-browser.Base64Encode' - name: Base64Encode - items: [] - uid: '@azure/msal-browser.BaseInteractionClient' name: BaseInteractionClient items: [] @@ -244,9 +217,6 @@ - uid: '@azure/msal-browser.BrowserConfigurationAuthError' name: BrowserConfigurationAuthError items: [] - - uid: '@azure/msal-browser.BrowserCrypto' - name: BrowserCrypto - items: [] - uid: '@azure/msal-browser.BrowserPerformanceClient' name: BrowserPerformanceClient items: [] @@ -259,12 +229,6 @@ - uid: '@azure/msal-browser.BrowserStateObject' name: BrowserStateObject items: [] - - uid: '@azure/msal-browser.BrowserStorage' - name: BrowserStorage - items: [] - - uid: '@azure/msal-browser.BrowserStringUtils' - name: BrowserStringUtils - items: [] - uid: '@azure/msal-browser.BrowserSystemOptions' name: BrowserSystemOptions items: [] @@ -289,21 +253,12 @@ - uid: '@azure/msal-browser.Configuration' name: Configuration items: [] - - uid: '@azure/msal-browser.CryptoKeyStore' - name: CryptoKeyStore - items: [] - - uid: '@azure/msal-browser.CryptoKeyStoreNames' - name: CryptoKeyStoreNames - items: [] - uid: '@azure/msal-browser.CryptoOps' name: CryptoOps items: [] - uid: '@azure/msal-browser.CryptoOptions' name: CryptoOptions items: [] - - uid: '@azure/msal-browser.DatabaseStorage' - name: DatabaseStorage - items: [] - uid: '@azure/msal-browser.EndSessionPopupRequest' name: EndSessionPopupRequest items: [] @@ -331,21 +286,9 @@ - uid: '@azure/msal-browser.EventType' name: EventType items: [] - - uid: '@azure/msal-browser.FetchClient' - name: FetchClient - items: [] - - uid: '@azure/msal-browser.GuidGenerator' - name: GuidGenerator - items: [] - uid: '@azure/msal-browser.HTTP_REQUEST_TYPE' name: HTTP_REQUEST_TYPE items: [] - - uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient' - name: HybridSpaAuthorizationCodeClient - items: [] - - uid: '@azure/msal-browser.IAsyncStorage' - name: IAsyncStorage - items: [] - uid: '@azure/msal-browser.INavigationClient' name: INavigationClient items: [] @@ -367,9 +310,6 @@ - uid: '@azure/msal-browser.IPublicClientApplication' name: IPublicClientApplication items: [] - - uid: '@azure/msal-browser.ISubtleCrypto' - name: ISubtleCrypto - items: [] - uid: '@azure/msal-browser.ITokenCache' name: ITokenCache items: [] @@ -379,24 +319,12 @@ - uid: '@azure/msal-browser.LoadTokenOptions' name: LoadTokenOptions items: [] - - uid: '@azure/msal-browser.MathUtils' - name: MathUtils - items: [] - uid: '@azure/msal-browser.MATS' name: MATS items: [] - uid: '@azure/msal-browser.MemoryStorage' name: MemoryStorage items: [] - - uid: '@azure/msal-browser.ModernBrowserCrypto' - name: ModernBrowserCrypto - items: [] - - uid: '@azure/msal-browser.MsBrowserCrypto' - name: MsBrowserCrypto - items: [] - - uid: '@azure/msal-browser.MsrBrowserCrypto' - name: MsrBrowserCrypto - items: [] - uid: '@azure/msal-browser.NativeAccountInfo' name: NativeAccountInfo items: [] @@ -439,9 +367,6 @@ - uid: '@azure/msal-browser.OSError' name: OSError items: [] - - uid: '@azure/msal-browser.PkceGenerator' - name: PkceGenerator - items: [] - uid: '@azure/msal-browser.PopupClient' name: PopupClient items: [] @@ -490,9 +415,6 @@ - uid: '@azure/msal-browser.SilentCacheClient' name: SilentCacheClient items: [] - - uid: '@azure/msal-browser.SilentHandler' - name: SilentHandler - items: [] - uid: '@azure/msal-browser.SilentIframeClient' name: SilentIframeClient items: [] @@ -517,10 +439,7 @@ - uid: '@azure/msal-browser.WrapperSKU' name: WrapperSKU items: [] - - uid: '@azure/msal-browser.XhrClient' - name: XhrClient - items: [] -- name: 'MSAL Common' +- name: '@azure/msal-common' items: - name: Overview uid: '@azure/msal-common' @@ -680,9 +599,6 @@ - uid: '@azure/msal-common.CloudDiscoveryMetadata' name: CloudDiscoveryMetadata items: [] - - uid: '@azure/msal-common.CloudInstanceDiscoveryResponse' - name: CloudInstanceDiscoveryResponse - items: [] - uid: '@azure/msal-common.CommonAuthorizationCodeRequest' name: CommonAuthorizationCodeRequest items: [] @@ -713,6 +629,9 @@ - uid: '@azure/msal-common.CommonUsernamePasswordRequest' name: CommonUsernamePasswordRequest items: [] + - uid: '@azure/msal-common.Counters' + name: Counters + items: [] - uid: '@azure/msal-common.CredentialCache' name: CredentialCache items: [] @@ -770,11 +689,8 @@ - uid: '@azure/msal-common.ILoggerCallback' name: ILoggerCallback items: [] - - uid: '@azure/msal-common.IMDSBadResponse' - name: IMDSBadResponse - items: [] - - uid: '@azure/msal-common.ImdsOptions' - name: ImdsOptions + - uid: '@azure/msal-common.INativeBrokerPlugin' + name: INativeBrokerPlugin items: [] - uid: '@azure/msal-common.INetworkModule' name: INetworkModule @@ -800,9 +716,6 @@ - uid: '@azure/msal-common.JoseHeader' name: JoseHeader items: [] - - uid: '@azure/msal-common.JoseHeaderError' - name: JoseHeaderError - items: [] - uid: '@azure/msal-common.JoseHeaderOptions' name: JoseHeaderOptions items: [] @@ -830,6 +743,12 @@ - uid: '@azure/msal-common.LogLevel' name: LogLevel items: [] + - uid: '@azure/msal-common.NativeRequest' + name: NativeRequest + items: [] + - uid: '@azure/msal-common.NativeSignOutRequest' + name: NativeSignOutRequest + items: [] - uid: '@azure/msal-common.NetworkManager' name: NetworkManager items: [] @@ -872,12 +791,18 @@ - uid: '@azure/msal-common.PopTokenGenerator' name: PopTokenGenerator items: [] + - uid: '@azure/msal-common.PreQueueEvent' + name: PreQueueEvent + items: [] - uid: '@azure/msal-common.ProtocolMode' name: ProtocolMode items: [] - uid: '@azure/msal-common.ProtocolUtils' name: ProtocolUtils items: [] + - uid: '@azure/msal-common.QueueMeasurement' + name: QueueMeasurement + items: [] - uid: '@azure/msal-common.RefreshTokenCache' name: RefreshTokenCache items: [] @@ -887,9 +812,6 @@ - uid: '@azure/msal-common.RefreshTokenEntity' name: RefreshTokenEntity items: [] - - uid: '@azure/msal-common.RegionDiscovery' - name: RegionDiscovery - items: [] - uid: '@azure/msal-common.RegionDiscoveryMetadata' name: RegionDiscoveryMetadata items: [] @@ -905,24 +827,15 @@ - uid: '@azure/msal-common.ReqCnfData' name: ReqCnfData items: [] - - uid: '@azure/msal-common.RequestParameterBuilder' - name: RequestParameterBuilder - items: [] - uid: '@azure/msal-common.RequestStateObject' name: RequestStateObject items: [] - uid: '@azure/msal-common.RequestThumbprint' name: RequestThumbprint items: [] - - uid: '@azure/msal-common.RequestValidator' - name: RequestValidator - items: [] - uid: '@azure/msal-common.ResponseCodes' name: ResponseCodes items: [] - - uid: '@azure/msal-common.ResponseHandler' - name: ResponseHandler - items: [] - uid: '@azure/msal-common.ResponseMode' name: ResponseMode items: [] @@ -977,6 +890,9 @@ - uid: '@azure/msal-common.StubPerformanceMeasurement' name: StubPerformanceMeasurement items: [] + - uid: '@azure/msal-common.SubMeasurement' + name: SubMeasurement + items: [] - uid: '@azure/msal-common.SystemOptions' name: SystemOptions items: [] @@ -1001,6 +917,9 @@ - uid: '@azure/msal-common.UrlString' name: UrlString items: [] + - uid: '@azure/msal-common.UrlToHttpRequestOptions' + name: UrlToHttpRequestOptions + items: [] - uid: '@azure/msal-common.UsernamePasswordClient' name: UsernamePasswordClient items: [] @@ -1010,19 +929,19 @@ - uid: '@azure/msal-common.ValidCredentialType' name: ValidCredentialType items: [] -- name: 'MSAL Node' +- name: '@azure/msal-node' items: - name: Overview uid: '@azure/msal-node' - - uid: '@azure/msal-node.ApiId' - name: ApiId - items: [] - uid: '@azure/msal-node.AuthorizationCodeRequest' name: AuthorizationCodeRequest items: [] - uid: '@azure/msal-node.AuthorizationUrlRequest' name: AuthorizationUrlRequest items: [] + - uid: '@azure/msal-node.BrokerOptions' + name: BrokerOptions + items: [] - uid: '@azure/msal-node.CacheKVStore' name: CacheKVStore items: [] @@ -1047,39 +966,21 @@ - uid: '@azure/msal-node.CryptoProvider' name: CryptoProvider items: [] - - uid: '@azure/msal-node.Deserializer' - name: Deserializer - items: [] - uid: '@azure/msal-node.DeviceCodeRequest' name: DeviceCodeRequest items: [] - uid: '@azure/msal-node.DistributedCachePlugin' name: DistributedCachePlugin items: [] - - uid: '@azure/msal-node.EncodingUtils' - name: EncodingUtils - items: [] - - uid: '@azure/msal-node.GuidGenerator' - name: GuidGenerator - items: [] - - uid: '@azure/msal-node.HashUtils' - name: HashUtils - items: [] - - uid: '@azure/msal-node.HttpClient' - name: HttpClient - items: [] - - uid: '@azure/msal-node.HttpMethod' - name: HttpMethod - items: [] - - uid: '@azure/msal-node.HttpStatus' - name: HttpStatus - items: [] - uid: '@azure/msal-node.ICacheClient' name: ICacheClient items: [] - uid: '@azure/msal-node.IConfidentialClientApplication' name: IConfidentialClientApplication items: [] + - uid: '@azure/msal-node.ILoopbackClient' + name: ILoopbackClient + items: [] - uid: '@azure/msal-node.InMemoryCache' name: InMemoryCache items: [] @@ -1098,15 +999,6 @@ - uid: '@azure/msal-node.JsonCache' name: JsonCache items: [] - - uid: '@azure/msal-node.LoopbackClient' - name: LoopbackClient - items: [] - - uid: '@azure/msal-node.NetworkUtils' - name: NetworkUtils - items: [] - - uid: '@azure/msal-node.NodeAuthError' - name: NodeAuthError - items: [] - uid: '@azure/msal-node.NodeAuthOptions' name: NodeAuthOptions items: [] @@ -1125,12 +1017,6 @@ - uid: '@azure/msal-node.OnBehalfOfRequest' name: OnBehalfOfRequest items: [] - - uid: '@azure/msal-node.PkceGenerator' - name: PkceGenerator - items: [] - - uid: '@azure/msal-node.ProxyStatus' - name: ProxyStatus - items: [] - uid: '@azure/msal-node.PublicClientApplication' name: PublicClientApplication items: [] @@ -1152,8 +1038,8 @@ - uid: '@azure/msal-node.SerializedRefreshTokenEntity' name: SerializedRefreshTokenEntity items: [] - - uid: '@azure/msal-node.Serializer' - name: Serializer + - uid: '@azure/msal-node.SignOutRequest' + name: SignOutRequest items: [] - uid: '@azure/msal-node.SilentFlowRequest' name: SilentFlowRequest @@ -1164,7 +1050,7 @@ - uid: '@azure/msal-node.UsernamePasswordRequest' name: UsernamePasswordRequest items: [] -- name: 'MSAL React' +- name: '@azure/msal-react' items: - name: Overview uid: '@azure/msal-react' @@ -1189,9 +1075,6 @@ - uid: '@azure/msal-react.MsalProviderProps' name: MsalProviderProps items: [] - - uid: '@azure/msal-react.ReactAuthError' - name: ReactAuthError - items: [] - uid: '@azure/msal-react.SetComplement' name: SetComplement items: [] From cdfa6e4ad3cfad29a642d2613527dca353d52444 Mon Sep 17 00:00:00 2001 From: VSC-Service-Account Date: Wed, 26 Jul 2023 22:32:50 +0000 Subject: [PATCH 02/24] CI Update Build.Reason:Manual by Den Delimarsky Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=375854&view=results --- .../msal-browser/BaseInteractionClient.yml | 20 + .../msal-browser/BrowserCacheManager.yml | 529 +++++++++++++----- .../@azure/msal-browser/CacheOptions.yml | 3 + .../@azure/msal-browser/ClientApplication.yml | 4 +- .../@azure/msal-browser/EventType.yml | 4 + .../msal-browser/NativeInteractionClient.yml | 36 +- .../@azure/msal-browser/PopupClient.yml | 23 + .../msal-browser/PublicClientApplication.yml | 4 +- .../@azure/msal-browser/RedirectClient.yml | 23 + .../msal-browser/SilentAuthCodeClient.yml | 23 + .../@azure/msal-browser/SilentCacheClient.yml | 23 + .../msal-browser/SilentIframeClient.yml | 23 + .../msal-browser/SilentRefreshClient.yml | 23 + .../StandardInteractionClient.yml | 23 + .../@azure/msal-browser/StaticCacheKeys.yml | 17 + .../@azure/msal-browser/index.yml | 47 +- .../@azure/msal-common/AccessTokenEntity.yml | 19 - .../@azure/msal-common/AccountFilter.yml | 2 + .../@azure/msal-common/Authority.yml | 26 + .../@azure/msal-common/AuthorityType.yml | 5 + .../@azure/msal-common/CacheManager.yml | 409 ++++++++++---- .../@azure/msal-common/CacheOptions.yml | 13 + .../@azure/msal-common/CacheOutcome.yml | 4 + .../@azure/msal-common/CacheSchemaType.yml | 49 -- .../msal-common/ClientConfiguration.yml | 3 + .../msal-common/ClientConfigurationError.yml | 13 + .../msal-common/CommonClientConfiguration.yml | 1 + .../@azure/msal-common/CredentialCache.yml | 14 - .../@azure/msal-common/CredentialEntity.yml | 16 - .../@azure/msal-common/CredentialFilter.yml | 2 +- .../msal-common/DefaultStorageClass.yml | 441 +++++++++++---- .../@azure/msal-common/ICacheManager.yml | 124 ++-- .../@azure/msal-common/IdTokenEntity.yml | 19 - .../@azure/msal-common/RefreshTokenEntity.yml | 19 - .../@azure/msal-common/ScopeSet.yml | 17 + .../@azure/msal-common/ThrottlingUtils.yml | 6 +- .../@azure/msal-common/TokenClaims.yml | 2 + .../@azure/msal-common/TokenKeys.yml | 14 + .../@azure/msal-common/index.yml | 13 +- .../@azure/msal-node/CacheOptions.yml | 11 +- .../@azure/msal-node/IPartitionManager.yml | 24 +- .../@azure/msal-node/NodeStorage.yml | 411 ++++++++++---- .../@azure/msal-node/index.yml | 26 +- nodejs/docs-ref-autogen/toc.yml | 15 +- 44 files changed, 1806 insertions(+), 737 deletions(-) create mode 100644 nodejs/docs-ref-autogen/@azure/msal-browser/StaticCacheKeys.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/CacheOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml delete mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/CredentialCache.yml create mode 100644 nodejs/docs-ref-autogen/@azure/msal-common/TokenKeys.yml diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml index 0d5fe38..54d440f 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml @@ -103,3 +103,23 @@ methods: return: description: '' type: Promise<void> + - name: 'validateRequestAuthority(string, AccountInfo)' + uid: '@azure/msal-browser.BaseInteractionClient.validateRequestAuthority' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateRequestAuthority(authority: string, account: + AccountInfo): Promise + parameters: + - id: authority + type: string + description: '' + - id: account + type: AccountInfo + description: '' + return: + description: '' + type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml index 4128fc6..dd5bc2d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml @@ -38,6 +38,53 @@ constructors: type: Logger description: '' inheritedMethods: + - name: 'accessTokenKeyMatchesFilter(string, CredentialFilter, boolean)' + uid: '@azure/msal-browser.BrowserCacheManager.accessTokenKeyMatchesFilter' + package: '@azure/msal-browser' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function accessTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter, keyMustContainAllScopes: boolean): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: CredentialFilter + description: '' + - id: keyMustContainAllScopes + type: boolean + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.accessTokenKeyMatchesFilter + - name: 'credentialMatchesFilter(ValidCredentialType, CredentialFilter)' + uid: '@azure/msal-browser.BrowserCacheManager.credentialMatchesFilter' + package: '@azure/msal-browser' + summary: Returns whether or not the given credential entity matches the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function credentialMatchesFilter(entity: ValidCredentialType, filter: + CredentialFilter): boolean + parameters: + - id: entity + type: ValidCredentialType + description: '' + - id: filter + type: CredentialFilter + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.credentialMatchesFilter - name: generateAuthorityMetadataCacheKey(string) uid: '@azure/msal-browser.BrowserCacheManager.generateAuthorityMetadataCacheKey' package: '@azure/msal-browser' @@ -54,6 +101,66 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From CacheManager.generateAuthorityMetadataCacheKey + - name: 'getAccessToken(AccountInfo, BaseAuthRequest, TokenKeys)' + uid: '@azure/msal-browser.BrowserCacheManager.getAccessToken' + package: '@azure/msal-browser' + summary: Retrieve AccessTokenEntity from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessToken(account: AccountInfo, request: BaseAuthRequest, + tokenKeys?: TokenKeys): AccessTokenEntity | null + parameters: + - id: account + type: AccountInfo + description: '' + - id: request + type: BaseAuthRequest + description: '' + - id: tokenKeys + type: TokenKeys + description: '' + return: + description: '' + type: AccessTokenEntity | null + inheritanceDescription: Inherited From CacheManager.getAccessToken + - name: getAccessTokensByFilter(CredentialFilter) + uid: '@azure/msal-browser.BrowserCacheManager.getAccessTokensByFilter' + package: '@azure/msal-browser' + summary: Gets all access tokens matching the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessTokensByFilter(filter: CredentialFilter): + AccessTokenEntity[] + parameters: + - id: filter + type: CredentialFilter + description: '' + return: + description: '' + type: 'AccessTokenEntity[]' + inheritanceDescription: Inherited From CacheManager.getAccessTokensByFilter + - name: getAccountInfoFilteredBy(AccountFilter) + uid: '@azure/msal-browser.BrowserCacheManager.getAccountInfoFilteredBy' + package: '@azure/msal-browser' + summary: Gets accountInfo object based on provided filters + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountInfoFilteredBy(accountFilter: AccountFilter): + AccountInfo | null + parameters: + - id: accountFilter + type: AccountFilter + description: '' + return: + description: '' + type: AccountInfo | null + inheritanceDescription: Inherited From CacheManager.getAccountInfoFilteredBy - name: getAccountsFilteredBy(AccountFilter) uid: '@azure/msal-browser.BrowserCacheManager.getAccountsFilteredBy' package: '@azure/msal-browser' @@ -67,15 +174,15 @@ inheritedMethods: isDeprecated: false syntax: content: >- - function getAccountsFilteredBy(accountFilter?: AccountFilter): - AccountCache + function getAccountsFilteredBy(accountFilter: AccountFilter): + AccountEntity[] parameters: - id: accountFilter type: AccountFilter description: '' return: description: '' - type: AccountCache + type: 'AccountEntity[]' inheritanceDescription: Inherited From CacheManager.getAccountsFilteredBy - name: getAllAccounts() uid: '@azure/msal-browser.BrowserCacheManager.getAllAccounts' @@ -128,72 +235,155 @@ inheritedMethods: description: '' type: AuthorityMetadataEntity | null inheritanceDescription: Inherited From CacheManager.getAuthorityMetadataByAlias - - name: getCredentialsFilteredBy(CredentialFilter) - uid: '@azure/msal-browser.BrowserCacheManager.getCredentialsFilteredBy' + - name: 'getIdToken(AccountInfo, TokenKeys)' + uid: '@azure/msal-browser.BrowserCacheManager.getIdToken' package: '@azure/msal-browser' - summary: >- - retrieve credentails matching all provided filters; if no filter is set, - get all credentials + summary: Retrieve IdTokenEntity from cache remarks: '' isDeprecated: false syntax: content: >- - function getCredentialsFilteredBy(filter: CredentialFilter): - CredentialCache + function getIdToken(account: AccountInfo, tokenKeys?: TokenKeys): + IdTokenEntity | null + parameters: + - id: account + type: AccountInfo + description: '' + - id: tokenKeys + type: TokenKeys + description: '' + return: + description: '' + type: IdTokenEntity | null + inheritanceDescription: Inherited From CacheManager.getIdToken + - name: 'getIdTokensByFilter(CredentialFilter, TokenKeys)' + uid: '@azure/msal-browser.BrowserCacheManager.getIdTokensByFilter' + package: '@azure/msal-browser' + summary: Gets all idTokens matching the given filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getIdTokensByFilter(filter: CredentialFilter, tokenKeys?: + TokenKeys): IdTokenEntity[] parameters: - id: filter type: CredentialFilter description: '' + - id: tokenKeys + type: TokenKeys + description: '' return: description: '' - type: CredentialCache - inheritanceDescription: Inherited From CacheManager.getCredentialsFilteredBy - - name: 'isAppMetadataFOCI(string, string)' - uid: '@azure/msal-browser.BrowserCacheManager.isAppMetadataFOCI' + type: 'IdTokenEntity[]' + inheritanceDescription: Inherited From CacheManager.getIdTokensByFilter + - name: 'getRefreshToken(AccountInfo, boolean, TokenKeys)' + uid: '@azure/msal-browser.BrowserCacheManager.getRefreshToken' package: '@azure/msal-browser' - summary: Return the family_id value associated with FOCI + summary: Helper to retrieve the appropriate refresh token from cache remarks: '' isDeprecated: false syntax: content: >- - function isAppMetadataFOCI(environment: string, clientId: string): - boolean + function getRefreshToken(account: AccountInfo, familyRT: boolean, + tokenKeys?: TokenKeys): RefreshTokenEntity | null parameters: - - id: environment - type: string + - id: account + type: AccountInfo description: '' - - id: clientId - type: string + - id: familyRT + type: boolean description: |+ + - id: tokenKeys + type: TokenKeys + description: '' + return: + description: '' + type: RefreshTokenEntity | null + inheritanceDescription: Inherited From CacheManager.getRefreshToken + - name: 'idTokenKeyMatchesFilter(string, CredentialFilter)' + uid: '@azure/msal-browser.BrowserCacheManager.idTokenKeyMatchesFilter' + package: '@azure/msal-browser' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function idTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: CredentialFilter + description: '' return: description: '' type: boolean - inheritanceDescription: Inherited From CacheManager.isAppMetadataFOCI - - name: 'readAccessTokenFromCache(string, AccountInfo, BaseAuthRequest)' - uid: '@azure/msal-browser.BrowserCacheManager.readAccessTokenFromCache' + inheritanceDescription: Inherited From CacheManager.idTokenKeyMatchesFilter + - name: 'isAccountKey(string, string, string)' + uid: '@azure/msal-browser.BrowserCacheManager.isAccountKey' package: '@azure/msal-browser' - summary: Retrieve AccessTokenEntity from cache + summary: >- + Returns true if the given key matches our account key schema. Also matches + homeAccountId and/or tenantId if provided remarks: '' isDeprecated: false syntax: content: >- - function readAccessTokenFromCache(clientId: string, account: - AccountInfo, request: BaseAuthRequest): AccessTokenEntity | null + function isAccountKey(key: string, homeAccountId?: string, tenantId?: + string): boolean parameters: - - id: clientId + - id: key type: string description: '' - - id: account - type: AccountInfo + - id: homeAccountId + type: string description: '' - - id: request - type: BaseAuthRequest + - id: tenantId + type: string description: '' return: description: '' - type: AccessTokenEntity | null - inheritanceDescription: Inherited From CacheManager.readAccessTokenFromCache + type: boolean + inheritanceDescription: Inherited From CacheManager.isAccountKey + - name: isAppMetadataFOCI(string) + uid: '@azure/msal-browser.BrowserCacheManager.isAppMetadataFOCI' + package: '@azure/msal-browser' + summary: Return the family_id value associated with FOCI + remarks: '' + isDeprecated: false + syntax: + content: 'function isAppMetadataFOCI(environment: string): boolean' + parameters: + - id: environment + type: string + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.isAppMetadataFOCI + - name: isCredentialKey(string) + uid: '@azure/msal-browser.BrowserCacheManager.isCredentialKey' + package: '@azure/msal-browser' + summary: Returns true if the given key matches our credential key schema. + remarks: '' + isDeprecated: false + syntax: + content: 'function isCredentialKey(key: string): boolean' + parameters: + - id: key + type: string + description: |+ + + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.isCredentialKey - name: readAccountFromCache(AccountInfo) uid: '@azure/msal-browser.BrowserCacheManager.readAccountFromCache' package: '@azure/msal-browser' @@ -213,26 +403,7 @@ inheritedMethods: description: '' type: AccountEntity | null inheritanceDescription: Inherited From CacheManager.readAccountFromCache - - name: readAccountFromCacheWithNativeAccountId(string) - uid: >- - @azure/msal-browser.BrowserCacheManager.readAccountFromCacheWithNativeAccountId - package: '@azure/msal-browser' - summary: Retrieve AccountEntity from cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function readAccountFromCacheWithNativeAccountId(nativeAccountId: - string): AccountEntity | null - parameters: - - id: nativeAccountId - type: string - description: '' - return: - description: AccountEntity or Null - type: AccountEntity | null - inheritanceDescription: Inherited From CacheManager.readAccountFromCacheWithNativeAccountId - - name: 'readAppMetadataFromCache(string, string)' + - name: readAppMetadataFromCache(string) uid: '@azure/msal-browser.BrowserCacheManager.readAppMetadataFromCache' package: '@azure/msal-browser' summary: Retrieve AppMetadataEntity from cache @@ -240,20 +411,17 @@ inheritedMethods: isDeprecated: false syntax: content: >- - function readAppMetadataFromCache(environment: string, clientId: - string): AppMetadataEntity | null + function readAppMetadataFromCache(environment: string): + AppMetadataEntity | null parameters: - id: environment type: string description: '' - - id: clientId - type: string - description: '' return: description: '' type: AppMetadataEntity | null inheritanceDescription: Inherited From CacheManager.readAppMetadataFromCache - - name: 'readCacheRecord(AccountInfo, string, BaseAuthRequest, string)' + - name: 'readCacheRecord(AccountInfo, BaseAuthRequest, string)' uid: '@azure/msal-browser.BrowserCacheManager.readCacheRecord' package: '@azure/msal-browser' summary: Retrieve the cached credentials into a cacherecord @@ -261,15 +429,12 @@ inheritedMethods: isDeprecated: false syntax: content: >- - function readCacheRecord(account: AccountInfo, clientId: string, - request: BaseAuthRequest, environment: string): CacheRecord + function readCacheRecord(account: AccountInfo, request: BaseAuthRequest, + environment: string): CacheRecord parameters: - id: account type: AccountInfo description: '' - - id: clientId - type: string - description: '' - id: request type: BaseAuthRequest description: '' @@ -280,68 +445,30 @@ inheritedMethods: description: '' type: CacheRecord inheritanceDescription: Inherited From CacheManager.readCacheRecord - - name: 'readIdTokenFromCache(string, AccountInfo)' - uid: '@azure/msal-browser.BrowserCacheManager.readIdTokenFromCache' + - name: 'refreshTokenKeyMatchesFilter(string, CredentialFilter)' + uid: '@azure/msal-browser.BrowserCacheManager.refreshTokenKeyMatchesFilter' package: '@azure/msal-browser' - summary: Retrieve IdTokenEntity from cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function readIdTokenFromCache(clientId: string, account: AccountInfo): - IdTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: AccountInfo - description: '' - return: - description: '' - type: IdTokenEntity | null - inheritanceDescription: Inherited From CacheManager.readIdTokenFromCache - - name: 'readRefreshTokenFromCache(string, AccountInfo, boolean)' - uid: '@azure/msal-browser.BrowserCacheManager.readRefreshTokenFromCache' - package: '@azure/msal-browser' - summary: Helper to retrieve the appropriate refresh token from cache + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value remarks: '' isDeprecated: false syntax: content: >- - function readRefreshTokenFromCache(clientId: string, account: - AccountInfo, familyRT: boolean): RefreshTokenEntity | null + function refreshTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean parameters: - - id: clientId + - id: inputKey type: string description: '' - - id: account - type: AccountInfo - description: '' - - id: familyRT - type: boolean + - id: filter + type: CredentialFilter description: |+ return: description: '' - type: RefreshTokenEntity | null - inheritanceDescription: Inherited From CacheManager.readRefreshTokenFromCache - - name: removeAccount(string) - uid: '@azure/msal-browser.BrowserCacheManager.removeAccount' - package: '@azure/msal-browser' - summary: returns a boolean if the given account is removed - remarks: '' - isDeprecated: false - syntax: - content: 'function removeAccount(accountKey: string): Promise' - parameters: - - id: accountKey - type: string - description: '' - return: - description: '' - type: Promise<boolean> - inheritanceDescription: Inherited From CacheManager.removeAccount + type: boolean + inheritanceDescription: Inherited From CacheManager.refreshTokenKeyMatchesFilter - name: removeAccountContext(AccountEntity) uid: '@azure/msal-browser.BrowserCacheManager.removeAccountContext' package: '@azure/msal-browser' @@ -349,7 +476,7 @@ inheritedMethods: remarks: '' isDeprecated: false syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' + content: 'function removeAccountContext(account: AccountEntity): Promise' parameters: - id: account type: AccountEntity @@ -357,7 +484,7 @@ inheritedMethods: return: description: '' - type: Promise<boolean> + type: Promise<void> inheritanceDescription: Inherited From CacheManager.removeAccountContext - name: removeAllAccounts() uid: '@azure/msal-browser.BrowserCacheManager.removeAllAccounts' @@ -366,10 +493,10 @@ inheritedMethods: remarks: '' isDeprecated: false syntax: - content: 'function removeAllAccounts(): Promise' + content: 'function removeAllAccounts(): Promise' return: description: '' - type: Promise<boolean> + type: Promise<void> inheritanceDescription: Inherited From CacheManager.removeAllAccounts - name: removeAppMetadata() uid: '@azure/msal-browser.BrowserCacheManager.removeAppMetadata' @@ -383,25 +510,6 @@ inheritedMethods: description: '' type: boolean inheritanceDescription: Inherited From CacheManager.removeAppMetadata - - name: removeCredential(CredentialEntity) - uid: '@azure/msal-browser.BrowserCacheManager.removeCredential' - package: '@azure/msal-browser' - summary: returns a boolean if the given credential is removed - remarks: '' - isDeprecated: false - syntax: - content: >- - function removeCredential(credential: CredentialEntity): - Promise - parameters: - - id: credential - type: CredentialEntity - description: |+ - - return: - description: '' - type: Promise<boolean> - inheritanceDescription: Inherited From CacheManager.removeCredential - name: saveCacheRecord(CacheRecord) uid: '@azure/msal-browser.BrowserCacheManager.saveCacheRecord' package: '@azure/msal-browser' @@ -440,6 +548,35 @@ inheritedMethods: type: T inheritanceDescription: Inherited From CacheManager.toObject methods: + - name: addAccountKeyToMap(string) + uid: '@azure/msal-browser.BrowserCacheManager.addAccountKeyToMap' + package: '@azure/msal-browser' + summary: Add a new account to the key map + remarks: '' + isDeprecated: false + syntax: + content: 'function addAccountKeyToMap(key: string)' + parameters: + - id: key + type: string + description: |+ + + - name: 'addTokenKey(string, CredentialType)' + uid: '@azure/msal-browser.BrowserCacheManager.addTokenKey' + package: '@azure/msal-browser' + summary: Adds the given key to the token key map + remarks: '' + isDeprecated: false + syntax: + content: 'function addTokenKey(key: string, type: CredentialType)' + parameters: + - id: key + type: string + description: '' + - id: type + type: CredentialType + description: |+ + - name: 'cacheCodeRequest(CommonAuthorizationCodeRequest, ICrypto)' uid: '@azure/msal-browser.BrowserCacheManager.cacheCodeRequest' package: '@azure/msal-browser' @@ -675,6 +812,17 @@ methods: return: description: '' type: AccountInfo | null + - name: getAccountKeys() + uid: '@azure/msal-browser.BrowserCacheManager.getAccountKeys' + package: '@azure/msal-browser' + summary: Returns the array of account keys currently cached + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountKeys(): Array' + return: + description: '' + type: Array<string> - name: getActiveAccount() uid: '@azure/msal-browser.BrowserCacheManager.getActiveAccount' package: '@azure/msal-browser' @@ -979,6 +1127,17 @@ methods: return: description: '' type: ThrottlingEntity | null + - name: getTokenKeys() + uid: '@azure/msal-browser.BrowserCacheManager.getTokenKeys' + package: '@azure/msal-browser' + summary: Gets the keys for the cached tokens associated with this clientId + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenKeys(): TokenKeys' + return: + description: '' + type: TokenKeys - name: getWrapperMetadata() uid: '@azure/msal-browser.BrowserCacheManager.getWrapperMetadata' package: '@azure/msal-browser' @@ -1005,6 +1164,66 @@ methods: return: description: '' type: boolean + - name: removeAccessToken(string) + uid: '@azure/msal-browser.BrowserCacheManager.removeAccessToken' + package: '@azure/msal-browser' + summary: Removes given accessToken from the cache and from the key map + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAccessToken(key: string): Promise' + parameters: + - id: key + type: string + description: |+ + + return: + description: '' + type: Promise<void> + - name: removeAccount(string) + uid: '@azure/msal-browser.BrowserCacheManager.removeAccount' + package: '@azure/msal-browser' + summary: >- + Extends inherited removeAccount function to include removal of the account + key from the map + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAccount(key: string): Promise' + parameters: + - id: key + type: string + description: |+ + + return: + description: '' + type: Promise<void> + - name: removeAccountKeyFromMap(string) + uid: '@azure/msal-browser.BrowserCacheManager.removeAccountKeyFromMap' + package: '@azure/msal-browser' + summary: Remove an account from the key map + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAccountKeyFromMap(key: string)' + parameters: + - id: key + type: string + description: |+ + + - name: removeIdToken(string) + uid: '@azure/msal-browser.BrowserCacheManager.removeIdToken' + package: '@azure/msal-browser' + summary: Removes given idToken from the cache and from the key map + remarks: '' + isDeprecated: false + syntax: + content: 'function removeIdToken(key: string)' + parameters: + - id: key + type: string + description: |+ + - name: removeItem(string) uid: '@azure/msal-browser.BrowserCacheManager.removeItem' package: '@azure/msal-browser' @@ -1014,15 +1233,41 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function removeItem(key: string): boolean' + content: 'function removeItem(key: string)' parameters: - id: key type: string description: |+ - return: - description: '' - type: boolean + - name: removeRefreshToken(string) + uid: '@azure/msal-browser.BrowserCacheManager.removeRefreshToken' + package: '@azure/msal-browser' + summary: Removes given refreshToken from the cache and from the key map + remarks: '' + isDeprecated: false + syntax: + content: 'function removeRefreshToken(key: string)' + parameters: + - id: key + type: string + description: |+ + + - name: 'removeTokenKey(string, CredentialType)' + uid: '@azure/msal-browser.BrowserCacheManager.removeTokenKey' + package: '@azure/msal-browser' + summary: Removes the given key from the token key map + remarks: '' + isDeprecated: false + syntax: + content: 'function removeTokenKey(key: string, type: CredentialType)' + parameters: + - id: key + type: string + description: '' + - id: type + type: CredentialType + description: |+ + - name: resetRequestCache(string) uid: '@azure/msal-browser.BrowserCacheManager.resetRequestCache' package: '@azure/msal-browser' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml index a724554..3127f64 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml @@ -9,6 +9,9 @@ isDeprecated: false syntax: | type CacheOptions = { cacheLocation?: BrowserCacheLocation | string, + cacheMigrationEnabled?: boolean, + claimsBasedCachingEnabled?: boolean, secureCookies?: boolean, storeAuthStateInCookie?: boolean, + temporaryCacheLocation?: BrowserCacheLocation | string, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml index 8aebe1a..aa9e2a5 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml @@ -208,9 +208,9 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function getAccountByUsername(userName: string): AccountInfo | null' + content: 'function getAccountByUsername(username: string): AccountInfo | null' parameters: - - id: userName + - id: username type: string description: '' return: diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/EventType.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/EventType.yml index 583b815..75b0230 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/EventType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/EventType.yml @@ -91,6 +91,10 @@ fields: uid: '@azure/msal-browser.EventType.POPUP_OPENED' package: '@azure/msal-browser' summary: '' + - name: RESTORE_FROM_BFCACHE + uid: '@azure/msal-browser.EventType.RESTORE_FROM_BFCACHE' + package: '@azure/msal-browser' + summary: '' - name: SSO_SILENT_FAILURE uid: '@azure/msal-browser.EventType.SSO_SILENT_FAILURE' package: '@azure/msal-browser' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml index 2a64989..9eee0b8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml @@ -82,6 +82,29 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) + - name: 'validateRequestAuthority(string, AccountInfo)' + uid: '@azure/msal-browser.NativeInteractionClient.validateRequestAuthority' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateRequestAuthority(authority: string, account: + AccountInfo): Promise + parameters: + - id: authority + type: string + description: '' + - id: account + type: AccountInfo + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BaseInteractionClient.validateRequestAuthority](xref:@azure/msal-browser.BaseInteractionClient.validateRequestAuthority) methods: - name: acquireToken(PopupRequest | SilentRequest | SsoSilentRequest) uid: '@azure/msal-browser.NativeInteractionClient.acquireToken' @@ -136,8 +159,8 @@ methods: description: |+ - name: >- - cacheNativeTokens(NativeResponse, NativeTokenRequest, string, AuthToken, - string, string, number) + cacheNativeTokens(NativeResponse, NativeTokenRequest, string, + AccountEntity, AuthToken, string, string, number) uid: '@azure/msal-browser.NativeInteractionClient.cacheNativeTokens' package: '@azure/msal-browser' summary: Stores the access_token and id_token in inmemory storage @@ -146,9 +169,9 @@ methods: syntax: content: >- function cacheNativeTokens(response: NativeResponse, request: - NativeTokenRequest, homeAccountIdentifier: string, idTokenObj: - AuthToken, responseAccessToken: string, tenantId: string, reqTimestamp: - number) + NativeTokenRequest, homeAccountIdentifier: string, accountEntity: + AccountEntity, idTokenObj: AuthToken, responseAccessToken: string, + tenantId: string, reqTimestamp: number) parameters: - id: response type: @@ -159,6 +182,9 @@ methods: - id: homeAccountIdentifier type: string description: '' + - id: accountEntity + type: AccountEntity + description: '' - id: idTokenObj type: AuthToken description: '' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupClient.yml index bd5db78..d79514d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PopupClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PopupClient.yml @@ -75,6 +75,29 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) + - name: 'validateRequestAuthority(string, AccountInfo)' + uid: '@azure/msal-browser.PopupClient.validateRequestAuthority' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateRequestAuthority(authority: string, account: + AccountInfo): Promise + parameters: + - id: authority + type: string + description: '' + - id: account + type: AccountInfo + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BaseInteractionClient.validateRequestAuthority](xref:@azure/msal-browser.BaseInteractionClient.validateRequestAuthority) methods: - name: acquireToken(PopupRequest) uid: '@azure/msal-browser.PopupClient.acquireToken' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml index 79ac12a..92fba88 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -240,9 +240,9 @@ inheritedMethods: remarks: '' isDeprecated: false syntax: - content: 'function getAccountByUsername(userName: string): AccountInfo | null' + content: 'function getAccountByUsername(username: string): AccountInfo | null' parameters: - - id: userName + - id: username type: string description: '' return: diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml index 00f6b76..0f42de0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml @@ -75,6 +75,29 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) + - name: 'validateRequestAuthority(string, AccountInfo)' + uid: '@azure/msal-browser.RedirectClient.validateRequestAuthority' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateRequestAuthority(authority: string, account: + AccountInfo): Promise + parameters: + - id: authority + type: string + description: '' + - id: account + type: AccountInfo + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BaseInteractionClient.validateRequestAuthority](xref:@azure/msal-browser.BaseInteractionClient.validateRequestAuthority) methods: - name: acquireToken(RedirectRequest) uid: '@azure/msal-browser.RedirectClient.acquireToken' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml index f38ff5b..3705e20 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml @@ -74,6 +74,29 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) + - name: 'validateRequestAuthority(string, AccountInfo)' + uid: '@azure/msal-browser.SilentAuthCodeClient.validateRequestAuthority' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateRequestAuthority(authority: string, account: + AccountInfo): Promise + parameters: + - id: authority + type: string + description: '' + - id: account + type: AccountInfo + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BaseInteractionClient.validateRequestAuthority](xref:@azure/msal-browser.BaseInteractionClient.validateRequestAuthority) methods: - name: acquireToken(AuthorizationCodeRequest) uid: '@azure/msal-browser.SilentAuthCodeClient.acquireToken' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml index 48d481f..0279ff0 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml @@ -71,6 +71,29 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) + - name: 'validateRequestAuthority(string, AccountInfo)' + uid: '@azure/msal-browser.SilentCacheClient.validateRequestAuthority' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateRequestAuthority(authority: string, account: + AccountInfo): Promise + parameters: + - id: authority + type: string + description: '' + - id: account + type: AccountInfo + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BaseInteractionClient.validateRequestAuthority](xref:@azure/msal-browser.BaseInteractionClient.validateRequestAuthority) methods: - name: acquireToken(CommonSilentFlowRequest) uid: '@azure/msal-browser.SilentCacheClient.acquireToken' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml index 474c911..5bdb215 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml @@ -78,6 +78,29 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) + - name: 'validateRequestAuthority(string, AccountInfo)' + uid: '@azure/msal-browser.SilentIframeClient.validateRequestAuthority' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateRequestAuthority(authority: string, account: + AccountInfo): Promise + parameters: + - id: authority + type: string + description: '' + - id: account + type: AccountInfo + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BaseInteractionClient.validateRequestAuthority](xref:@azure/msal-browser.BaseInteractionClient.validateRequestAuthority) methods: - name: acquireToken(SsoSilentRequest) uid: '@azure/msal-browser.SilentIframeClient.acquireToken' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml index 3e68d51..e382669 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml @@ -71,6 +71,29 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) + - name: 'validateRequestAuthority(string, AccountInfo)' + uid: '@azure/msal-browser.SilentRefreshClient.validateRequestAuthority' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateRequestAuthority(authority: string, account: + AccountInfo): Promise + parameters: + - id: authority + type: string + description: '' + - id: account + type: AccountInfo + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BaseInteractionClient.validateRequestAuthority](xref:@azure/msal-browser.BaseInteractionClient.validateRequestAuthority) methods: - name: acquireToken(CommonSilentFlowRequest) uid: '@azure/msal-browser.SilentRefreshClient.acquireToken' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml index 0ad2cdd..8cef12d 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml @@ -114,4 +114,27 @@ inheritedMethods: inheritanceDescription: >- Inherited From [BaseInteractionClient.logout](xref:@azure/msal-browser.BaseInteractionClient.logout) + - name: 'validateRequestAuthority(string, AccountInfo)' + uid: '@azure/msal-browser.StandardInteractionClient.validateRequestAuthority' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateRequestAuthority(authority: string, account: + AccountInfo): Promise + parameters: + - id: authority + type: string + description: '' + - id: account + type: AccountInfo + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: >- + Inherited From + [BaseInteractionClient.validateRequestAuthority](xref:@azure/msal-browser.BaseInteractionClient.validateRequestAuthority) extends: diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/StaticCacheKeys.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/StaticCacheKeys.yml new file mode 100644 index 0000000..ce6a83a --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/StaticCacheKeys.yml @@ -0,0 +1,17 @@ +### YamlMime:TSEnum +name: StaticCacheKeys +uid: '@azure/msal-browser.StaticCacheKeys' +package: '@azure/msal-browser' +summary: '' +fullName: StaticCacheKeys +remarks: '' +isDeprecated: false +fields: + - name: ACCOUNT_KEYS + uid: '@azure/msal-browser.StaticCacheKeys.ACCOUNT_KEYS' + package: '@azure/msal-browser' + summary: '' + - name: TOKEN_KEYS + uid: '@azure/msal-browser.StaticCacheKeys.TOKEN_KEYS' + package: '@azure/msal-browser' + summary: '' diff --git a/nodejs/docs-ref-autogen/@azure/msal-browser/index.yml b/nodejs/docs-ref-autogen/@azure/msal-browser/index.yml index e90519b..b9b729e 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-browser/index.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-browser/index.yml @@ -87,12 +87,14 @@ functions: navigateToLoginRequestUrl?: boolean, postLogoutRedirectUri?: string | null, protocolMode?: ProtocolMode, redirectUri?: string, skipAuthorityMetadataCache?: boolean }, userInputCache: { cacheLocation?: - BrowserCacheLocation | string, secureCookies?: boolean, - storeAuthStateInCookie?: boolean }, userInputSystem: { - preventCorsPreflight?: boolean, tokenRenewalOffsetSeconds?: number } & { - allowNativeBroker?: boolean, allowRedirectInIframe?: boolean, - asyncPopups?: boolean, cryptoOptions?: CryptoOptions, iframeHashTimeout?: - number, loadFrameTimeout?: number, loggerOptions?: LoggerOptions, + BrowserCacheLocation | string, cacheMigrationEnabled?: boolean, + claimsBasedCachingEnabled?: boolean, secureCookies?: boolean, + storeAuthStateInCookie?: boolean, temporaryCacheLocation?: + BrowserCacheLocation | string }, userInputSystem: { preventCorsPreflight?: + boolean, tokenRenewalOffsetSeconds?: number } & { allowNativeBroker?: + boolean, allowRedirectInIframe?: boolean, asyncPopups?: boolean, + cryptoOptions?: CryptoOptions, iframeHashTimeout?: number, + loadFrameTimeout?: number, loggerOptions?: LoggerOptions, nativeBrokerHandshakeTimeout?: number, navigateFrameWait?: number, navigationClient?: INavigationClient, networkClient?: INetworkModule, pollIntervalMilliseconds?: number, redirectNavigationTimeout?: number, @@ -114,8 +116,10 @@ functions: navigateToLoginRequestUrl?: boolean, postLogoutRedirectUri?: string | null, protocolMode?: ProtocolMode, redirectUri?: string, skipAuthorityMetadataCache?: boolean }, userInputCache: { - cacheLocation?: BrowserCacheLocation | string, secureCookies?: boolean, - storeAuthStateInCookie?: boolean }, userInputSystem: { + cacheLocation?: BrowserCacheLocation | string, cacheMigrationEnabled?: + boolean, claimsBasedCachingEnabled?: boolean, secureCookies?: boolean, + storeAuthStateInCookie?: boolean, temporaryCacheLocation?: + BrowserCacheLocation | string }, userInputSystem: { preventCorsPreflight?: boolean, tokenRenewalOffsetSeconds?: number } & { allowNativeBroker?: boolean, allowRedirectInIframe?: boolean, asyncPopups?: boolean, cryptoOptions?: CryptoOptions, @@ -136,18 +140,20 @@ functions: navigateToLoginRequestUrl?: boolean, postLogoutRedirectUri?: string | null, protocolMode?: ProtocolMode, redirectUri?: string, skipAuthorityMetadataCache?: boolean }, userInputCache: { - cacheLocation?: BrowserCacheLocation | string, secureCookies?: - boolean, storeAuthStateInCookie?: boolean }, userInputSystem: { - preventCorsPreflight?: boolean, tokenRenewalOffsetSeconds?: number } - & { allowNativeBroker?: boolean, allowRedirectInIframe?: boolean, - asyncPopups?: boolean, cryptoOptions?: CryptoOptions, - iframeHashTimeout?: number, loadFrameTimeout?: number, - loggerOptions?: LoggerOptions, nativeBrokerHandshakeTimeout?: - number, navigateFrameWait?: number, navigationClient?: - INavigationClient, networkClient?: INetworkModule, - pollIntervalMilliseconds?: number, redirectNavigationTimeout?: - number, windowHashTimeout?: number }, userInputTelemetry: { - application?: ApplicationTelemetry } } + cacheLocation?: BrowserCacheLocation | string, + cacheMigrationEnabled?: boolean, claimsBasedCachingEnabled?: + boolean, secureCookies?: boolean, storeAuthStateInCookie?: boolean, + temporaryCacheLocation?: BrowserCacheLocation | string }, + userInputSystem: { preventCorsPreflight?: boolean, + tokenRenewalOffsetSeconds?: number } & { allowNativeBroker?: + boolean, allowRedirectInIframe?: boolean, asyncPopups?: boolean, + cryptoOptions?: CryptoOptions, iframeHashTimeout?: number, + loadFrameTimeout?: number, loggerOptions?: LoggerOptions, + nativeBrokerHandshakeTimeout?: number, navigateFrameWait?: number, + navigationClient?: INavigationClient, networkClient?: + INetworkModule, pollIntervalMilliseconds?: number, + redirectNavigationTimeout?: number, windowHashTimeout?: number }, + userInputTelemetry: { application?: ApplicationTelemetry } } description: '' - id: isBrowserEnvironment type: boolean @@ -166,5 +172,6 @@ enums: - '@azure/msal-browser.InteractionStatus' - '@azure/msal-browser.InteractionType' - '@azure/msal-browser.NativeExtensionMethod' + - '@azure/msal-browser.StaticCacheKeys' - '@azure/msal-browser.TemporaryCacheKeys' - '@azure/msal-browser.WrapperSKU' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml index 25a858c..5fee10c 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml @@ -386,25 +386,6 @@ inheritedMethods: inheritanceDescription: >- Inherited From [CredentialEntity.generateType](xref:@azure/msal-common.CredentialEntity.generateType) - - name: getCredentialType(string) - uid: '@azure/msal-common.AccessTokenEntity.getCredentialType' - package: '@azure/msal-common' - summary: helper function to return `CredentialType` - remarks: '' - isDeprecated: false - syntax: - content: 'static function getCredentialType(key: string): string' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.getCredentialType](xref:@azure/msal-common.CredentialEntity.getCredentialType) methods: - name: >- createAccessTokenEntity(string, string, string, string, string, string, diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AccountFilter.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AccountFilter.yml index 4baa72c..cf8a8e8 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AccountFilter.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AccountFilter.yml @@ -10,6 +10,8 @@ syntax: | type AccountFilter = { environment?: string, homeAccountId?: string, + localAccountId?: string, nativeAccountId?: string, realm?: string, + username?: string, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/Authority.yml b/nodejs/docs-ref-autogen/@azure/msal-common/Authority.yml index 15054e1..85e2244 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/Authority.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/Authority.yml @@ -404,3 +404,29 @@ methods: return: description: '' type: Promise<void> + - name: transformCIAMAuthority(string) + uid: '@azure/msal-common.Authority.transformCIAMAuthority' + package: '@azure/msal-common' + summary: > + Transform CIAM_AUTHORIY as per the below rules: + + If no path segments found and it is a CIAM authority (hostname ends with + .ciamlogin.com), then transform it + + NOTE: The transformation path should go away once STS supports CIAM with + the format: `tenantIdorDomain.ciamlogin.com` + + `ciamlogin.com` can also change in the future and we should accommodate + the same + remarks: '' + isDeprecated: false + syntax: + content: 'static function transformCIAMAuthority(authority: string): string' + parameters: + - id: authority + type: string + description: |+ + + return: + description: '' + type: string diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityType.yml index efc591a..e80d214 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityType.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/AuthorityType.yml @@ -22,3 +22,8 @@ fields: package: '@azure/msal-common' summary: '' numericValue: 2 + - name: Ciam + uid: '@azure/msal-common.AuthorityType.Ciam' + package: '@azure/msal-common' + summary: '' + numericValue: 3 diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheManager.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheManager.yml index 09ebe64..36af769 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CacheManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CacheManager.yml @@ -10,14 +10,14 @@ remarks: '' isDeprecated: false type: class constructors: - - name: 'CacheManager(string, ICrypto)' + - name: 'CacheManager(string, ICrypto, Logger)' uid: '@azure/msal-common.CacheManager.constructor' package: '@azure/msal-common' summary: '' remarks: '' isDeprecated: false syntax: - content: 'new CacheManager(clientId: string, cryptoImpl: ICrypto)' + content: 'new CacheManager(clientId: string, cryptoImpl: ICrypto, logger: Logger)' parameters: - id: clientId type: string @@ -25,7 +25,35 @@ constructors: - id: cryptoImpl type: description: '' + - id: logger + type: + description: '' methods: + - name: 'accessTokenKeyMatchesFilter(string, CredentialFilter, boolean)' + uid: '@azure/msal-common.CacheManager.accessTokenKeyMatchesFilter' + package: '@azure/msal-common' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function accessTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter, keyMustContainAllScopes: boolean): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: + description: '' + - id: keyMustContainAllScopes + type: boolean + description: '' + return: + description: '' + type: boolean - name: clear() uid: '@azure/msal-common.CacheManager.clear' package: '@azure/msal-common' @@ -56,6 +84,26 @@ methods: return: description: '' type: boolean + - name: 'credentialMatchesFilter(ValidCredentialType, CredentialFilter)' + uid: '@azure/msal-common.CacheManager.credentialMatchesFilter' + package: '@azure/msal-common' + summary: Returns whether or not the given credential entity matches the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function credentialMatchesFilter(entity: ValidCredentialType, filter: + CredentialFilter): boolean + parameters: + - id: entity + type: + description: '' + - id: filter + type: + description: '' + return: + description: '' + type: boolean - name: generateAuthorityMetadataCacheKey(string) uid: '@azure/msal-common.CacheManager.generateAuthorityMetadataCacheKey' package: '@azure/msal-common' @@ -71,6 +119,29 @@ methods: return: description: '' type: string + - name: 'getAccessToken(AccountInfo, BaseAuthRequest, TokenKeys)' + uid: '@azure/msal-common.CacheManager.getAccessToken' + package: '@azure/msal-common' + summary: Retrieve AccessTokenEntity from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessToken(account: AccountInfo, request: BaseAuthRequest, + tokenKeys?: TokenKeys): AccessTokenEntity | null + parameters: + - id: account + type: + description: '' + - id: request + type: + description: '' + - id: tokenKeys + type: + description: '' + return: + description: '' + type: | null - name: getAccessTokenCredential(string) uid: '@azure/msal-common.CacheManager.getAccessTokenCredential' package: '@azure/msal-common' @@ -89,6 +160,23 @@ methods: return: description: '' type: | null + - name: getAccessTokensByFilter(CredentialFilter) + uid: '@azure/msal-common.CacheManager.getAccessTokensByFilter' + package: '@azure/msal-common' + summary: Gets all access tokens matching the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessTokensByFilter(filter: CredentialFilter): + AccessTokenEntity[] + parameters: + - id: filter + type: + description: '' + return: + description: '' + type: '[]' - name: getAccount(string) uid: '@azure/msal-common.CacheManager.getAccount' package: '@azure/msal-common' @@ -106,6 +194,34 @@ methods: return: description: '' type: | null + - name: getAccountInfoFilteredBy(AccountFilter) + uid: '@azure/msal-common.CacheManager.getAccountInfoFilteredBy' + package: '@azure/msal-common' + summary: Gets accountInfo object based on provided filters + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountInfoFilteredBy(accountFilter: AccountFilter): + AccountInfo | null + parameters: + - id: accountFilter + type: + description: '' + return: + description: '' + type: | null + - name: getAccountKeys() + uid: '@azure/msal-common.CacheManager.getAccountKeys' + package: '@azure/msal-common' + summary: Function which retrieves all account keys from the cache + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountKeys(): string[]' + return: + description: '' + type: 'string[]' - name: getAccountsFilteredBy(AccountFilter) uid: '@azure/msal-common.CacheManager.getAccountsFilteredBy' package: '@azure/msal-common' @@ -119,15 +235,15 @@ methods: isDeprecated: false syntax: content: >- - function getAccountsFilteredBy(accountFilter?: AccountFilter): - AccountCache + function getAccountsFilteredBy(accountFilter: AccountFilter): + AccountEntity[] parameters: - id: accountFilter type: description: '' return: description: '' - type: + type: '[]' - name: getAllAccounts() uid: '@azure/msal-common.CacheManager.getAllAccounts' package: '@azure/msal-common' @@ -223,25 +339,26 @@ methods: return: description: '' type: Array<string> - - name: getCredentialsFilteredBy(CredentialFilter) - uid: '@azure/msal-common.CacheManager.getCredentialsFilteredBy' + - name: 'getIdToken(AccountInfo, TokenKeys)' + uid: '@azure/msal-common.CacheManager.getIdToken' package: '@azure/msal-common' - summary: >- - retrieve credentails matching all provided filters; if no filter is set, - get all credentials + summary: Retrieve IdTokenEntity from cache remarks: '' isDeprecated: false syntax: content: >- - function getCredentialsFilteredBy(filter: CredentialFilter): - CredentialCache + function getIdToken(account: AccountInfo, tokenKeys?: TokenKeys): + IdTokenEntity | null parameters: - - id: filter - type: + - id: account + type: + description: '' + - id: tokenKeys + type: description: '' return: description: '' - type: + type: | null - name: getIdTokenCredential(string) uid: '@azure/msal-common.CacheManager.getIdTokenCredential' package: '@azure/msal-common' @@ -258,6 +375,26 @@ methods: return: description: '' type: | null + - name: 'getIdTokensByFilter(CredentialFilter, TokenKeys)' + uid: '@azure/msal-common.CacheManager.getIdTokensByFilter' + package: '@azure/msal-common' + summary: Gets all idTokens matching the given filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getIdTokensByFilter(filter: CredentialFilter, tokenKeys?: + TokenKeys): IdTokenEntity[] + parameters: + - id: filter + type: + description: '' + - id: tokenKeys + type: + description: '' + return: + description: '' + type: '[]' - name: getKeys() uid: '@azure/msal-common.CacheManager.getKeys' package: '@azure/msal-common' @@ -269,6 +406,30 @@ methods: return: description: '' type: 'string[]' + - name: 'getRefreshToken(AccountInfo, boolean, TokenKeys)' + uid: '@azure/msal-common.CacheManager.getRefreshToken' + package: '@azure/msal-common' + summary: Helper to retrieve the appropriate refresh token from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getRefreshToken(account: AccountInfo, familyRT: boolean, + tokenKeys?: TokenKeys): RefreshTokenEntity | null + parameters: + - id: account + type: + description: '' + - id: familyRT + type: boolean + description: |+ + + - id: tokenKeys + type: + description: '' + return: + description: '' + type: | null - name: getRefreshTokenCredential(string) uid: '@azure/msal-common.CacheManager.getRefreshTokenCredential' package: '@azure/msal-common' @@ -323,86 +484,114 @@ methods: return: description: '' type: | null - - name: 'isAppMetadataFOCI(string, string)' - uid: '@azure/msal-common.CacheManager.isAppMetadataFOCI' + - name: getTokenKeys() + uid: '@azure/msal-common.CacheManager.getTokenKeys' package: '@azure/msal-common' - summary: Return the family_id value associated with FOCI + summary: Function which retrieves all token keys from the cache + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenKeys(): TokenKeys' + return: + description: '' + type: + - name: 'idTokenKeyMatchesFilter(string, CredentialFilter)' + uid: '@azure/msal-common.CacheManager.idTokenKeyMatchesFilter' + package: '@azure/msal-common' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value remarks: '' isDeprecated: false syntax: content: >- - function isAppMetadataFOCI(environment: string, clientId: string): - boolean + function idTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean parameters: - - id: environment + - id: inputKey type: string description: '' - - id: clientId - type: string - description: |+ - + - id: filter + type: + description: '' return: description: '' type: boolean - - name: 'readAccessTokenFromCache(string, AccountInfo, BaseAuthRequest)' - uid: '@azure/msal-common.CacheManager.readAccessTokenFromCache' + - name: 'isAccountKey(string, string, string)' + uid: '@azure/msal-common.CacheManager.isAccountKey' package: '@azure/msal-common' - summary: Retrieve AccessTokenEntity from cache + summary: >- + Returns true if the given key matches our account key schema. Also matches + homeAccountId and/or tenantId if provided remarks: '' isDeprecated: false syntax: content: >- - function readAccessTokenFromCache(clientId: string, account: - AccountInfo, request: BaseAuthRequest): AccessTokenEntity | null + function isAccountKey(key: string, homeAccountId?: string, tenantId?: + string): boolean parameters: - - id: clientId + - id: key type: string description: '' - - id: account - type: + - id: homeAccountId + type: string description: '' - - id: request - type: + - id: tenantId + type: string description: '' return: description: '' - type: | null - - name: readAccountFromCache(AccountInfo) - uid: '@azure/msal-common.CacheManager.readAccountFromCache' + type: boolean + - name: isAppMetadataFOCI(string) + uid: '@azure/msal-common.CacheManager.isAppMetadataFOCI' package: '@azure/msal-common' - summary: Retrieve AccountEntity from cache + summary: Return the family_id value associated with FOCI remarks: '' isDeprecated: false syntax: - content: >- - function readAccountFromCache(account: AccountInfo): AccountEntity | - null + content: 'function isAppMetadataFOCI(environment: string): boolean' parameters: - - id: account - type: + - id: environment + type: string + description: '' + return: + description: '' + type: boolean + - name: isCredentialKey(string) + uid: '@azure/msal-common.CacheManager.isCredentialKey' + package: '@azure/msal-common' + summary: Returns true if the given key matches our credential key schema. + remarks: '' + isDeprecated: false + syntax: + content: 'function isCredentialKey(key: string): boolean' + parameters: + - id: key + type: string description: |+ return: description: '' - type: | null - - name: readAccountFromCacheWithNativeAccountId(string) - uid: '@azure/msal-common.CacheManager.readAccountFromCacheWithNativeAccountId' + type: boolean + - name: readAccountFromCache(AccountInfo) + uid: '@azure/msal-common.CacheManager.readAccountFromCache' package: '@azure/msal-common' summary: Retrieve AccountEntity from cache remarks: '' isDeprecated: false syntax: content: >- - function readAccountFromCacheWithNativeAccountId(nativeAccountId: - string): AccountEntity | null + function readAccountFromCache(account: AccountInfo): AccountEntity | + null parameters: - - id: nativeAccountId - type: string - description: '' + - id: account + type: + description: |+ + return: - description: AccountEntity or Null + description: '' type: | null - - name: 'readAppMetadataFromCache(string, string)' + - name: readAppMetadataFromCache(string) uid: '@azure/msal-common.CacheManager.readAppMetadataFromCache' package: '@azure/msal-common' summary: Retrieve AppMetadataEntity from cache @@ -410,19 +599,16 @@ methods: isDeprecated: false syntax: content: >- - function readAppMetadataFromCache(environment: string, clientId: - string): AppMetadataEntity | null + function readAppMetadataFromCache(environment: string): + AppMetadataEntity | null parameters: - id: environment type: string description: '' - - id: clientId - type: string - description: '' return: description: '' type: | null - - name: 'readCacheRecord(AccountInfo, string, BaseAuthRequest, string)' + - name: 'readCacheRecord(AccountInfo, BaseAuthRequest, string)' uid: '@azure/msal-common.CacheManager.readCacheRecord' package: '@azure/msal-common' summary: Retrieve the cached credentials into a cacherecord @@ -430,15 +616,12 @@ methods: isDeprecated: false syntax: content: >- - function readCacheRecord(account: AccountInfo, clientId: string, - request: BaseAuthRequest, environment: string): CacheRecord + function readCacheRecord(account: AccountInfo, request: BaseAuthRequest, + environment: string): CacheRecord parameters: - id: account type: description: '' - - id: clientId - type: string - description: '' - id: request type: description: '' @@ -448,65 +631,59 @@ methods: return: description: '' type: - - name: 'readIdTokenFromCache(string, AccountInfo)' - uid: '@azure/msal-common.CacheManager.readIdTokenFromCache' + - name: 'refreshTokenKeyMatchesFilter(string, CredentialFilter)' + uid: '@azure/msal-common.CacheManager.refreshTokenKeyMatchesFilter' package: '@azure/msal-common' - summary: Retrieve IdTokenEntity from cache + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value remarks: '' isDeprecated: false syntax: content: >- - function readIdTokenFromCache(clientId: string, account: AccountInfo): - IdTokenEntity | null + function refreshTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean parameters: - - id: clientId + - id: inputKey type: string description: '' - - id: account - type: - description: '' + - id: filter + type: + description: |+ + return: description: '' - type: | null - - name: 'readRefreshTokenFromCache(string, AccountInfo, boolean)' - uid: '@azure/msal-common.CacheManager.readRefreshTokenFromCache' + type: boolean + - name: removeAccessToken(string) + uid: '@azure/msal-common.CacheManager.removeAccessToken' package: '@azure/msal-common' - summary: Helper to retrieve the appropriate refresh token from cache + summary: returns a boolean if the given credential is removed remarks: '' isDeprecated: false syntax: - content: >- - function readRefreshTokenFromCache(clientId: string, account: - AccountInfo, familyRT: boolean): RefreshTokenEntity | null + content: 'function removeAccessToken(key: string): Promise' parameters: - - id: clientId + - id: key type: string description: '' - - id: account - type: - description: '' - - id: familyRT - type: boolean - description: |+ - return: description: '' - type: | null + type: Promise<void> - name: removeAccount(string) uid: '@azure/msal-common.CacheManager.removeAccount' package: '@azure/msal-common' - summary: returns a boolean if the given account is removed + summary: Removes the account and related tokens for a given account key remarks: '' isDeprecated: false syntax: - content: 'function removeAccount(accountKey: string): Promise' + content: 'function removeAccount(accountKey: string): Promise' parameters: - id: accountKey type: string description: '' return: description: '' - type: Promise<boolean> + type: Promise<void> - name: removeAccountContext(AccountEntity) uid: '@azure/msal-common.CacheManager.removeAccountContext' package: '@azure/msal-common' @@ -514,7 +691,7 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' + content: 'function removeAccountContext(account: AccountEntity): Promise' parameters: - id: account type: @@ -522,7 +699,7 @@ methods: return: description: '' - type: Promise<boolean> + type: Promise<void> - name: removeAllAccounts() uid: '@azure/msal-common.CacheManager.removeAllAccounts' package: '@azure/msal-common' @@ -530,10 +707,10 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function removeAllAccounts(): Promise' + content: 'function removeAllAccounts(): Promise' return: description: '' - type: Promise<boolean> + type: Promise<void> - name: removeAppMetadata() uid: '@azure/msal-common.CacheManager.removeAppMetadata' package: '@azure/msal-common' @@ -545,43 +722,45 @@ methods: return: description: '' type: boolean - - name: removeCredential(CredentialEntity) - uid: '@azure/msal-common.CacheManager.removeCredential' + - name: removeIdToken(string) + uid: '@azure/msal-common.CacheManager.removeIdToken' package: '@azure/msal-common' - summary: returns a boolean if the given credential is removed + summary: Removes idToken from the cache remarks: '' isDeprecated: false syntax: - content: >- - function removeCredential(credential: CredentialEntity): - Promise + content: 'function removeIdToken(key: string)' parameters: - - id: credential - type: + - id: key + type: string description: |+ - return: - description: '' - type: Promise<boolean> - - name: 'removeItem(string, string)' + - name: removeItem(string) uid: '@azure/msal-common.CacheManager.removeItem' package: '@azure/msal-common' summary: Function to remove an item from cache given its key. remarks: '' isDeprecated: false syntax: - content: 'function removeItem(key: string, type?: string): boolean' + content: 'function removeItem(key: string)' parameters: - id: key type: string description: |+ - - id: type + - name: removeRefreshToken(string) + uid: '@azure/msal-common.CacheManager.removeRefreshToken' + package: '@azure/msal-common' + summary: Removes refresh token from the cache + remarks: '' + isDeprecated: false + syntax: + content: 'function removeRefreshToken(key: string)' + parameters: + - id: key type: string - description: '' - return: - description: '' - type: boolean + description: |+ + - name: saveCacheRecord(CacheRecord) uid: '@azure/msal-common.CacheManager.saveCacheRecord' package: '@azure/msal-common' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheOptions.yml new file mode 100644 index 0000000..9a3b190 --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CacheOptions.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: CacheOptions +uid: '@azure/msal-common.CacheOptions' +package: '@azure/msal-common' +summary: >2 + Use this to configure credential cache preferences in the ClientConfiguration object + - claimsBasedCachingEnabled - Sets whether tokens should be cached based on + the claims hash. Default is true. +fullName: CacheOptions +remarks: '' +isDeprecated: false +syntax: | + type CacheOptions = { claimsBasedCachingEnabled?: boolean } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml index dd6aad9..0da1ad7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml @@ -11,6 +11,10 @@ fields: uid: '@azure/msal-common.CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED' package: '@azure/msal-common' summary: '' + - name: CLAIMS_REQUESTED_CACHE_SKIPPED + uid: '@azure/msal-common.CacheOutcome.CLAIMS_REQUESTED_CACHE_SKIPPED' + package: '@azure/msal-common' + summary: '' - name: FORCE_REFRESH uid: '@azure/msal-common.CacheOutcome.FORCE_REFRESH' package: '@azure/msal-common' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml deleted file mode 100644 index 1121152..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml +++ /dev/null @@ -1,49 +0,0 @@ -### YamlMime:TSEnum -name: CacheSchemaType -uid: '@azure/msal-common.CacheSchemaType' -package: '@azure/msal-common' -summary: Credential Type stored in the cache -fullName: CacheSchemaType -remarks: '' -isDeprecated: false -fields: - - name: ACCESS_TOKEN - uid: '@azure/msal-common.CacheSchemaType.ACCESS_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: ACCOUNT - uid: '@azure/msal-common.CacheSchemaType.ACCOUNT' - package: '@azure/msal-common' - summary: '' - - name: APP_METADATA - uid: '@azure/msal-common.CacheSchemaType.APP_METADATA' - package: '@azure/msal-common' - summary: '' - - name: CREDENTIAL - uid: '@azure/msal-common.CacheSchemaType.CREDENTIAL' - package: '@azure/msal-common' - summary: '' - - name: ID_TOKEN - uid: '@azure/msal-common.CacheSchemaType.ID_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: REFRESH_TOKEN - uid: '@azure/msal-common.CacheSchemaType.REFRESH_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: TELEMETRY - uid: '@azure/msal-common.CacheSchemaType.TELEMETRY' - package: '@azure/msal-common' - summary: '' - - name: TEMPORARY - uid: '@azure/msal-common.CacheSchemaType.TEMPORARY' - package: '@azure/msal-common' - summary: '' - - name: THROTTLING - uid: '@azure/msal-common.CacheSchemaType.THROTTLING' - package: '@azure/msal-common' - summary: '' - - name: UNDEFINED - uid: '@azure/msal-common.CacheSchemaType.UNDEFINED' - package: '@azure/msal-common' - summary: '' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml index 1069322..30c4c65 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml @@ -18,6 +18,8 @@ summary: > - loggerOptions - Logging for application + - cacheOptions - Cache options for application + - networkInterface - Network implementation - storageInterface - Storage implementation @@ -31,6 +33,7 @@ isDeprecated: false syntax: | type ClientConfiguration = { authOptions: AuthOptions, + cacheOptions?: CacheOptions, clientCredentials?: ClientCredentials, cryptoInterface?: ICrypto, libraryInfo?: LibraryInfo, diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml index cbc39f0..1e3522b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml @@ -971,6 +971,19 @@ inheritedMethods: Inherited From [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) methods: + - name: createAuthorityMismatchError() + uid: '@azure/msal-common.ClientConfigurationError.createAuthorityMismatchError' + package: '@azure/msal-common' + summary: >- + Create an error when the authority provided in request does not match + authority provided in account or MSAL.js configuration. + remarks: '' + isDeprecated: false + syntax: + content: 'static function createAuthorityMismatchError(): ClientConfigurationError' + return: + description: '' + type: - name: createClaimsRequestParsingError(string) uid: >- @azure/msal-common.ClientConfigurationError.createClaimsRequestParsingError diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml index e1131e2..4246441 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml @@ -9,6 +9,7 @@ isDeprecated: false syntax: | type CommonClientConfiguration = { authOptions: Required, + cacheOptions: Required, clientCredentials: ClientCredentials, cryptoInterface: Required, libraryInfo: LibraryInfo, diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialCache.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialCache.yml deleted file mode 100644 index 45fb3ca..0000000 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialCache.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: CredentialCache -uid: '@azure/msal-common.CredentialCache' -package: '@azure/msal-common' -summary: '' -fullName: CredentialCache -remarks: '' -isDeprecated: false -syntax: | - type CredentialCache = { - accessTokens: AccessTokenCache, - idTokens: IdTokenCache, - refreshTokens: RefreshTokenCache, - } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml index 55adf4a..6952349 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml @@ -285,19 +285,3 @@ methods: return: description: '' type: number - - name: getCredentialType(string) - uid: '@azure/msal-common.CredentialEntity.getCredentialType' - package: '@azure/msal-common' - summary: helper function to return `CredentialType` - remarks: '' - isDeprecated: false - syntax: - content: 'static function getCredentialType(key: string): string' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml index 0693b00..33c41f4 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml @@ -18,7 +18,7 @@ syntax: | keyId?: string, realm?: string, requestedClaimsHash?: string, - target?: string, + target?: ScopeSet, tokenType?: AuthenticationScheme, userAssertionHash?: string, } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml b/nodejs/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml index 283b58f..a78c530 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml @@ -8,14 +8,16 @@ remarks: '' isDeprecated: false type: class constructors: - - name: 'DefaultStorageClass(string, ICrypto)' + - name: 'DefaultStorageClass(string, ICrypto, Logger)' uid: '@azure/msal-common.DefaultStorageClass.constructor' package: '@azure/msal-common' summary: '' remarks: '' isDeprecated: false syntax: - content: 'new DefaultStorageClass(clientId: string, cryptoImpl: ICrypto)' + content: >- + new DefaultStorageClass(clientId: string, cryptoImpl: ICrypto, logger: + Logger) parameters: - id: clientId type: string @@ -23,7 +25,61 @@ constructors: - id: cryptoImpl type: description: '' + - id: logger + type: + description: '' inheritedMethods: + - name: 'accessTokenKeyMatchesFilter(string, CredentialFilter, boolean)' + uid: '@azure/msal-common.DefaultStorageClass.accessTokenKeyMatchesFilter' + package: '@azure/msal-common' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function accessTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter, keyMustContainAllScopes: boolean): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: + description: '' + - id: keyMustContainAllScopes + type: boolean + description: '' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [CacheManager.accessTokenKeyMatchesFilter](xref:@azure/msal-common.CacheManager.accessTokenKeyMatchesFilter) + - name: 'credentialMatchesFilter(ValidCredentialType, CredentialFilter)' + uid: '@azure/msal-common.DefaultStorageClass.credentialMatchesFilter' + package: '@azure/msal-common' + summary: Returns whether or not the given credential entity matches the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function credentialMatchesFilter(entity: ValidCredentialType, filter: + CredentialFilter): boolean + parameters: + - id: entity + type: + description: '' + - id: filter + type: + description: '' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [CacheManager.credentialMatchesFilter](xref:@azure/msal-common.CacheManager.credentialMatchesFilter) - name: generateAuthorityMetadataCacheKey(string) uid: '@azure/msal-common.DefaultStorageClass.generateAuthorityMetadataCacheKey' package: '@azure/msal-common' @@ -42,6 +98,72 @@ inheritedMethods: inheritanceDescription: >- Inherited From [CacheManager.generateAuthorityMetadataCacheKey](xref:@azure/msal-common.CacheManager.generateAuthorityMetadataCacheKey) + - name: 'getAccessToken(AccountInfo, BaseAuthRequest, TokenKeys)' + uid: '@azure/msal-common.DefaultStorageClass.getAccessToken' + package: '@azure/msal-common' + summary: Retrieve AccessTokenEntity from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessToken(account: AccountInfo, request: BaseAuthRequest, + tokenKeys?: TokenKeys): AccessTokenEntity | null + parameters: + - id: account + type: + description: '' + - id: request + type: + description: '' + - id: tokenKeys + type: + description: '' + return: + description: '' + type: | null + inheritanceDescription: >- + Inherited From + [CacheManager.getAccessToken](xref:@azure/msal-common.CacheManager.getAccessToken) + - name: getAccessTokensByFilter(CredentialFilter) + uid: '@azure/msal-common.DefaultStorageClass.getAccessTokensByFilter' + package: '@azure/msal-common' + summary: Gets all access tokens matching the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessTokensByFilter(filter: CredentialFilter): + AccessTokenEntity[] + parameters: + - id: filter + type: + description: '' + return: + description: '' + type: '[]' + inheritanceDescription: >- + Inherited From + [CacheManager.getAccessTokensByFilter](xref:@azure/msal-common.CacheManager.getAccessTokensByFilter) + - name: getAccountInfoFilteredBy(AccountFilter) + uid: '@azure/msal-common.DefaultStorageClass.getAccountInfoFilteredBy' + package: '@azure/msal-common' + summary: Gets accountInfo object based on provided filters + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountInfoFilteredBy(accountFilter: AccountFilter): + AccountInfo | null + parameters: + - id: accountFilter + type: + description: '' + return: + description: '' + type: | null + inheritanceDescription: >- + Inherited From + [CacheManager.getAccountInfoFilteredBy](xref:@azure/msal-common.CacheManager.getAccountInfoFilteredBy) - name: getAccountsFilteredBy(AccountFilter) uid: '@azure/msal-common.DefaultStorageClass.getAccountsFilteredBy' package: '@azure/msal-common' @@ -55,15 +177,15 @@ inheritedMethods: isDeprecated: false syntax: content: >- - function getAccountsFilteredBy(accountFilter?: AccountFilter): - AccountCache + function getAccountsFilteredBy(accountFilter: AccountFilter): + AccountEntity[] parameters: - id: accountFilter type: description: '' return: description: '' - type: + type: '[]' inheritanceDescription: >- Inherited From [CacheManager.getAccountsFilteredBy](xref:@azure/msal-common.CacheManager.getAccountsFilteredBy) @@ -124,121 +246,191 @@ inheritedMethods: inheritanceDescription: >- Inherited From [CacheManager.getAuthorityMetadataByAlias](xref:@azure/msal-common.CacheManager.getAuthorityMetadataByAlias) - - name: getCredentialsFilteredBy(CredentialFilter) - uid: '@azure/msal-common.DefaultStorageClass.getCredentialsFilteredBy' + - name: 'getIdToken(AccountInfo, TokenKeys)' + uid: '@azure/msal-common.DefaultStorageClass.getIdToken' package: '@azure/msal-common' - summary: >- - retrieve credentails matching all provided filters; if no filter is set, - get all credentials + summary: Retrieve IdTokenEntity from cache remarks: '' isDeprecated: false syntax: content: >- - function getCredentialsFilteredBy(filter: CredentialFilter): - CredentialCache + function getIdToken(account: AccountInfo, tokenKeys?: TokenKeys): + IdTokenEntity | null + parameters: + - id: account + type: + description: '' + - id: tokenKeys + type: + description: '' + return: + description: '' + type: | null + inheritanceDescription: >- + Inherited From + [CacheManager.getIdToken](xref:@azure/msal-common.CacheManager.getIdToken) + - name: 'getIdTokensByFilter(CredentialFilter, TokenKeys)' + uid: '@azure/msal-common.DefaultStorageClass.getIdTokensByFilter' + package: '@azure/msal-common' + summary: Gets all idTokens matching the given filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getIdTokensByFilter(filter: CredentialFilter, tokenKeys?: + TokenKeys): IdTokenEntity[] parameters: - id: filter type: description: '' + - id: tokenKeys + type: + description: '' return: description: '' - type: + type: '[]' inheritanceDescription: >- Inherited From - [CacheManager.getCredentialsFilteredBy](xref:@azure/msal-common.CacheManager.getCredentialsFilteredBy) - - name: 'isAppMetadataFOCI(string, string)' - uid: '@azure/msal-common.DefaultStorageClass.isAppMetadataFOCI' + [CacheManager.getIdTokensByFilter](xref:@azure/msal-common.CacheManager.getIdTokensByFilter) + - name: 'getRefreshToken(AccountInfo, boolean, TokenKeys)' + uid: '@azure/msal-common.DefaultStorageClass.getRefreshToken' package: '@azure/msal-common' - summary: Return the family_id value associated with FOCI + summary: Helper to retrieve the appropriate refresh token from cache remarks: '' isDeprecated: false syntax: content: >- - function isAppMetadataFOCI(environment: string, clientId: string): - boolean + function getRefreshToken(account: AccountInfo, familyRT: boolean, + tokenKeys?: TokenKeys): RefreshTokenEntity | null parameters: - - id: environment - type: string + - id: account + type: description: '' - - id: clientId - type: string + - id: familyRT + type: boolean description: |+ + - id: tokenKeys + type: + description: '' + return: + description: '' + type: | null + inheritanceDescription: >- + Inherited From + [CacheManager.getRefreshToken](xref:@azure/msal-common.CacheManager.getRefreshToken) + - name: 'idTokenKeyMatchesFilter(string, CredentialFilter)' + uid: '@azure/msal-common.DefaultStorageClass.idTokenKeyMatchesFilter' + package: '@azure/msal-common' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function idTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: + description: '' return: description: '' type: boolean inheritanceDescription: >- Inherited From - [CacheManager.isAppMetadataFOCI](xref:@azure/msal-common.CacheManager.isAppMetadataFOCI) - - name: 'readAccessTokenFromCache(string, AccountInfo, BaseAuthRequest)' - uid: '@azure/msal-common.DefaultStorageClass.readAccessTokenFromCache' + [CacheManager.idTokenKeyMatchesFilter](xref:@azure/msal-common.CacheManager.idTokenKeyMatchesFilter) + - name: 'isAccountKey(string, string, string)' + uid: '@azure/msal-common.DefaultStorageClass.isAccountKey' package: '@azure/msal-common' - summary: Retrieve AccessTokenEntity from cache + summary: >- + Returns true if the given key matches our account key schema. Also matches + homeAccountId and/or tenantId if provided remarks: '' isDeprecated: false syntax: content: >- - function readAccessTokenFromCache(clientId: string, account: - AccountInfo, request: BaseAuthRequest): AccessTokenEntity | null + function isAccountKey(key: string, homeAccountId?: string, tenantId?: + string): boolean parameters: - - id: clientId + - id: key type: string description: '' - - id: account - type: + - id: homeAccountId + type: string description: '' - - id: request - type: + - id: tenantId + type: string description: '' return: description: '' - type: | null + type: boolean inheritanceDescription: >- Inherited From - [CacheManager.readAccessTokenFromCache](xref:@azure/msal-common.CacheManager.readAccessTokenFromCache) - - name: readAccountFromCache(AccountInfo) - uid: '@azure/msal-common.DefaultStorageClass.readAccountFromCache' + [CacheManager.isAccountKey](xref:@azure/msal-common.CacheManager.isAccountKey) + - name: isAppMetadataFOCI(string) + uid: '@azure/msal-common.DefaultStorageClass.isAppMetadataFOCI' package: '@azure/msal-common' - summary: Retrieve AccountEntity from cache + summary: Return the family_id value associated with FOCI remarks: '' isDeprecated: false syntax: - content: >- - function readAccountFromCache(account: AccountInfo): AccountEntity | - null + content: 'function isAppMetadataFOCI(environment: string): boolean' parameters: - - id: account - type: + - id: environment + type: string + description: '' + return: + description: '' + type: boolean + inheritanceDescription: >- + Inherited From + [CacheManager.isAppMetadataFOCI](xref:@azure/msal-common.CacheManager.isAppMetadataFOCI) + - name: isCredentialKey(string) + uid: '@azure/msal-common.DefaultStorageClass.isCredentialKey' + package: '@azure/msal-common' + summary: Returns true if the given key matches our credential key schema. + remarks: '' + isDeprecated: false + syntax: + content: 'function isCredentialKey(key: string): boolean' + parameters: + - id: key + type: string description: |+ return: description: '' - type: | null + type: boolean inheritanceDescription: >- Inherited From - [CacheManager.readAccountFromCache](xref:@azure/msal-common.CacheManager.readAccountFromCache) - - name: readAccountFromCacheWithNativeAccountId(string) - uid: >- - @azure/msal-common.DefaultStorageClass.readAccountFromCacheWithNativeAccountId + [CacheManager.isCredentialKey](xref:@azure/msal-common.CacheManager.isCredentialKey) + - name: readAccountFromCache(AccountInfo) + uid: '@azure/msal-common.DefaultStorageClass.readAccountFromCache' package: '@azure/msal-common' summary: Retrieve AccountEntity from cache remarks: '' isDeprecated: false syntax: content: >- - function readAccountFromCacheWithNativeAccountId(nativeAccountId: - string): AccountEntity | null + function readAccountFromCache(account: AccountInfo): AccountEntity | + null parameters: - - id: nativeAccountId - type: string - description: '' + - id: account + type: + description: |+ + return: - description: AccountEntity or Null + description: '' type: | null inheritanceDescription: >- Inherited From - [CacheManager.readAccountFromCacheWithNativeAccountId](xref:@azure/msal-common.CacheManager.readAccountFromCacheWithNativeAccountId) - - name: 'readAppMetadataFromCache(string, string)' + [CacheManager.readAccountFromCache](xref:@azure/msal-common.CacheManager.readAccountFromCache) + - name: readAppMetadataFromCache(string) uid: '@azure/msal-common.DefaultStorageClass.readAppMetadataFromCache' package: '@azure/msal-common' summary: Retrieve AppMetadataEntity from cache @@ -246,22 +438,19 @@ inheritedMethods: isDeprecated: false syntax: content: >- - function readAppMetadataFromCache(environment: string, clientId: - string): AppMetadataEntity | null + function readAppMetadataFromCache(environment: string): + AppMetadataEntity | null parameters: - id: environment type: string description: '' - - id: clientId - type: string - description: '' return: description: '' type: | null inheritanceDescription: >- Inherited From [CacheManager.readAppMetadataFromCache](xref:@azure/msal-common.CacheManager.readAppMetadataFromCache) - - name: 'readCacheRecord(AccountInfo, string, BaseAuthRequest, string)' + - name: 'readCacheRecord(AccountInfo, BaseAuthRequest, string)' uid: '@azure/msal-common.DefaultStorageClass.readCacheRecord' package: '@azure/msal-common' summary: Retrieve the cached credentials into a cacherecord @@ -269,15 +458,12 @@ inheritedMethods: isDeprecated: false syntax: content: >- - function readCacheRecord(account: AccountInfo, clientId: string, - request: BaseAuthRequest, environment: string): CacheRecord + function readCacheRecord(account: AccountInfo, request: BaseAuthRequest, + environment: string): CacheRecord parameters: - id: account type: description: '' - - id: clientId - type: string - description: '' - id: request type: description: '' @@ -290,71 +476,65 @@ inheritedMethods: inheritanceDescription: >- Inherited From [CacheManager.readCacheRecord](xref:@azure/msal-common.CacheManager.readCacheRecord) - - name: 'readIdTokenFromCache(string, AccountInfo)' - uid: '@azure/msal-common.DefaultStorageClass.readIdTokenFromCache' + - name: 'refreshTokenKeyMatchesFilter(string, CredentialFilter)' + uid: '@azure/msal-common.DefaultStorageClass.refreshTokenKeyMatchesFilter' package: '@azure/msal-common' - summary: Retrieve IdTokenEntity from cache + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value remarks: '' isDeprecated: false syntax: content: >- - function readIdTokenFromCache(clientId: string, account: AccountInfo): - IdTokenEntity | null + function refreshTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean parameters: - - id: clientId + - id: inputKey type: string description: '' - - id: account - type: - description: '' + - id: filter + type: + description: |+ + return: description: '' - type: | null + type: boolean inheritanceDescription: >- Inherited From - [CacheManager.readIdTokenFromCache](xref:@azure/msal-common.CacheManager.readIdTokenFromCache) - - name: 'readRefreshTokenFromCache(string, AccountInfo, boolean)' - uid: '@azure/msal-common.DefaultStorageClass.readRefreshTokenFromCache' + [CacheManager.refreshTokenKeyMatchesFilter](xref:@azure/msal-common.CacheManager.refreshTokenKeyMatchesFilter) + - name: removeAccessToken(string) + uid: '@azure/msal-common.DefaultStorageClass.removeAccessToken' package: '@azure/msal-common' - summary: Helper to retrieve the appropriate refresh token from cache + summary: returns a boolean if the given credential is removed remarks: '' isDeprecated: false syntax: - content: >- - function readRefreshTokenFromCache(clientId: string, account: - AccountInfo, familyRT: boolean): RefreshTokenEntity | null + content: 'function removeAccessToken(key: string): Promise' parameters: - - id: clientId + - id: key type: string description: '' - - id: account - type: - description: '' - - id: familyRT - type: boolean - description: |+ - return: description: '' - type: | null + type: Promise<void> inheritanceDescription: >- Inherited From - [CacheManager.readRefreshTokenFromCache](xref:@azure/msal-common.CacheManager.readRefreshTokenFromCache) + [CacheManager.removeAccessToken](xref:@azure/msal-common.CacheManager.removeAccessToken) - name: removeAccount(string) uid: '@azure/msal-common.DefaultStorageClass.removeAccount' package: '@azure/msal-common' - summary: returns a boolean if the given account is removed + summary: Removes the account and related tokens for a given account key remarks: '' isDeprecated: false syntax: - content: 'function removeAccount(accountKey: string): Promise' + content: 'function removeAccount(accountKey: string): Promise' parameters: - id: accountKey type: string description: '' return: description: '' - type: Promise<boolean> + type: Promise<void> inheritanceDescription: >- Inherited From [CacheManager.removeAccount](xref:@azure/msal-common.CacheManager.removeAccount) @@ -365,7 +545,7 @@ inheritedMethods: remarks: '' isDeprecated: false syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' + content: 'function removeAccountContext(account: AccountEntity): Promise' parameters: - id: account type: @@ -373,7 +553,7 @@ inheritedMethods: return: description: '' - type: Promise<boolean> + type: Promise<void> inheritanceDescription: >- Inherited From [CacheManager.removeAccountContext](xref:@azure/msal-common.CacheManager.removeAccountContext) @@ -384,10 +564,10 @@ inheritedMethods: remarks: '' isDeprecated: false syntax: - content: 'function removeAllAccounts(): Promise' + content: 'function removeAllAccounts(): Promise' return: description: '' - type: Promise<boolean> + type: Promise<void> inheritanceDescription: >- Inherited From [CacheManager.removeAllAccounts](xref:@azure/msal-common.CacheManager.removeAllAccounts) @@ -405,27 +585,38 @@ inheritedMethods: inheritanceDescription: >- Inherited From [CacheManager.removeAppMetadata](xref:@azure/msal-common.CacheManager.removeAppMetadata) - - name: removeCredential(CredentialEntity) - uid: '@azure/msal-common.DefaultStorageClass.removeCredential' + - name: removeIdToken(string) + uid: '@azure/msal-common.DefaultStorageClass.removeIdToken' package: '@azure/msal-common' - summary: returns a boolean if the given credential is removed + summary: Removes idToken from the cache remarks: '' isDeprecated: false syntax: - content: >- - function removeCredential(credential: CredentialEntity): - Promise + content: 'function removeIdToken(key: string)' parameters: - - id: credential - type: + - id: key + type: string + description: |+ + + inheritanceDescription: >- + Inherited From + [CacheManager.removeIdToken](xref:@azure/msal-common.CacheManager.removeIdToken) + - name: removeRefreshToken(string) + uid: '@azure/msal-common.DefaultStorageClass.removeRefreshToken' + package: '@azure/msal-common' + summary: Removes refresh token from the cache + remarks: '' + isDeprecated: false + syntax: + content: 'function removeRefreshToken(key: string)' + parameters: + - id: key + type: string description: |+ - return: - description: '' - type: Promise<boolean> inheritanceDescription: >- Inherited From - [CacheManager.removeCredential](xref:@azure/msal-common.CacheManager.removeCredential) + [CacheManager.removeRefreshToken](xref:@azure/msal-common.CacheManager.removeRefreshToken) - name: saveCacheRecord(CacheRecord) uid: '@azure/msal-common.DefaultStorageClass.saveCacheRecord' package: '@azure/msal-common' @@ -512,6 +703,17 @@ methods: return: description: '' type: + - name: getAccountKeys() + uid: '@azure/msal-common.DefaultStorageClass.getAccountKeys' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountKeys(): string[]' + return: + description: '' + type: 'string[]' - name: getAppMetadata() uid: '@azure/msal-common.DefaultStorageClass.getAppMetadata' package: '@azure/msal-common' @@ -600,6 +802,17 @@ methods: return: description: '' type: + - name: getTokenKeys() + uid: '@azure/msal-common.DefaultStorageClass.getTokenKeys' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenKeys(): TokenKeys' + return: + description: '' + type: - name: removeItem() uid: '@azure/msal-common.DefaultStorageClass.removeItem' package: '@azure/msal-common' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ICacheManager.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ICacheManager.yml index 3746241..2c5cad6 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ICacheManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ICacheManager.yml @@ -58,6 +58,24 @@ methods: return: description: '' type: | null + - name: getAccountInfoFilteredBy(AccountFilter) + uid: '@azure/msal-common.ICacheManager.getAccountInfoFilteredBy' + package: '@azure/msal-common' + summary: Get AccountInfo object based on provided filters + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountInfoFilteredBy(filter: AccountFilter): AccountInfo | + null + parameters: + - id: filter + type: + description: |+ + + return: + description: '' + type: | null - name: getAccountsFilteredBy(AccountFilter) uid: '@azure/msal-common.ICacheManager.getAccountsFilteredBy' package: '@azure/msal-common' @@ -67,14 +85,14 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function getAccountsFilteredBy(filter: AccountFilter): AccountCache' + content: 'function getAccountsFilteredBy(filter: AccountFilter): AccountEntity[]' parameters: - id: filter type: description: '' return: description: '' - type: + type: '[]' - name: getAllAccounts() uid: '@azure/msal-common.ICacheManager.getAllAccounts' package: '@azure/msal-common' @@ -151,25 +169,6 @@ methods: return: description: '' type: Array<string> - - name: getCredentialsFilteredBy(CredentialFilter) - uid: '@azure/msal-common.ICacheManager.getCredentialsFilteredBy' - package: '@azure/msal-common' - summary: >- - retrieve credentials matching all provided filters; if no filter is set, - get all credentials - remarks: '' - isDeprecated: false - syntax: - content: >- - function getCredentialsFilteredBy(filter: CredentialFilter): - CredentialCache - parameters: - - id: filter - type: - description: '' - return: - description: '' - type: - name: getIdTokenCredential(string) uid: '@azure/msal-common.ICacheManager.getIdTokenCredential' package: '@azure/msal-common' @@ -240,6 +239,47 @@ methods: return: description: '' type: | null + - name: 'isAccountKey(string, string, string)' + uid: '@azure/msal-common.ICacheManager.isAccountKey' + package: '@azure/msal-common' + summary: >- + Returns true if the given key matches our account key schema. Also matches + homeAccountId and/or tenantId if provided + remarks: '' + isDeprecated: false + syntax: + content: >- + function isAccountKey(key: string, homeAccountId?: string, tenantId?: + string): boolean + parameters: + - id: key + type: string + description: '' + - id: homeAccountId + type: string + description: '' + - id: tenantId + type: string + description: '' + return: + description: '' + type: boolean + - name: removeAccessToken(string) + uid: '@azure/msal-common.ICacheManager.removeAccessToken' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAccessToken(key: string): Promise' + parameters: + - id: key + type: string + description: |+ + + return: + description: '' + type: Promise<void> - name: removeAccount(string) uid: '@azure/msal-common.ICacheManager.removeAccount' package: '@azure/msal-common' @@ -247,14 +287,14 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function removeAccount(accountKey: string): Promise' + content: 'function removeAccount(accountKey: string): Promise' parameters: - id: accountKey type: string description: '' return: description: '' - type: Promise<boolean> + type: Promise<void> - name: removeAccountContext(AccountEntity) uid: '@azure/msal-common.ICacheManager.removeAccountContext' package: '@azure/msal-common' @@ -262,7 +302,7 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' + content: 'function removeAccountContext(account: AccountEntity): Promise' parameters: - id: account type: @@ -270,7 +310,7 @@ methods: return: description: '' - type: Promise<boolean> + type: Promise<void> - name: removeAllAccounts() uid: '@azure/msal-common.ICacheManager.removeAllAccounts' package: '@azure/msal-common' @@ -278,28 +318,36 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function removeAllAccounts(): Promise' + content: 'function removeAllAccounts(): Promise' return: description: '' - type: Promise<boolean> - - name: removeCredential(CredentialEntity) - uid: '@azure/msal-common.ICacheManager.removeCredential' + type: Promise<void> + - name: removeIdToken(string) + uid: '@azure/msal-common.ICacheManager.removeIdToken' package: '@azure/msal-common' - summary: returns a boolean if the given credential is removed + summary: '' remarks: '' isDeprecated: false syntax: - content: >- - function removeCredential(credential: CredentialEntity): - Promise + content: 'function removeIdToken(key: string)' parameters: - - id: credential - type: + - id: key + type: string + description: |+ + + - name: removeRefreshToken(string) + uid: '@azure/msal-common.ICacheManager.removeRefreshToken' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeRefreshToken(key: string)' + parameters: + - id: key + type: string description: |+ - return: - description: '' - type: Promise<boolean> - name: saveCacheRecord(CacheRecord) uid: '@azure/msal-common.ICacheManager.saveCacheRecord' package: '@azure/msal-common' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml index 7178661..81cda33 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml @@ -326,25 +326,6 @@ inheritedMethods: inheritanceDescription: >- Inherited From [CredentialEntity.generateType](xref:@azure/msal-common.CredentialEntity.generateType) - - name: getCredentialType(string) - uid: '@azure/msal-common.IdTokenEntity.getCredentialType' - package: '@azure/msal-common' - summary: helper function to return `CredentialType` - remarks: '' - isDeprecated: false - syntax: - content: 'static function getCredentialType(key: string): string' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.getCredentialType](xref:@azure/msal-common.CredentialEntity.getCredentialType) methods: - name: 'createIdTokenEntity(string, string, string, string, string)' uid: '@azure/msal-common.IdTokenEntity.createIdTokenEntity' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml b/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml index f0ee7dc..5184667 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml @@ -328,25 +328,6 @@ inheritedMethods: inheritanceDescription: >- Inherited From [CredentialEntity.generateType](xref:@azure/msal-common.CredentialEntity.generateType) - - name: getCredentialType(string) - uid: '@azure/msal-common.RefreshTokenEntity.getCredentialType' - package: '@azure/msal-common' - summary: helper function to return `CredentialType` - remarks: '' - isDeprecated: false - syntax: - content: 'static function getCredentialType(key: string): string' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.getCredentialType](xref:@azure/msal-common.CredentialEntity.getCredentialType) methods: - name: 'createRefreshTokenEntity(string, string, string, string, string, string)' uid: '@azure/msal-common.RefreshTokenEntity.createRefreshTokenEntity' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ScopeSet.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ScopeSet.yml index 080dba3..4fcc900 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ScopeSet.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ScopeSet.yml @@ -108,6 +108,23 @@ methods: return: description: '' type: boolean + - name: createSearchScopes(Array) + uid: '@azure/msal-common.ScopeSet.createSearchScopes' + package: '@azure/msal-common' + summary: Creates the set of scopes to search for in cache lookups + remarks: '' + isDeprecated: false + syntax: + content: >- + static function createSearchScopes(inputScopeString: Array): + ScopeSet + parameters: + - id: inputScopeString + type: Array<string> + description: '' + return: + description: '' + type: - name: fromString(string) uid: '@azure/msal-common.ScopeSet.fromString' package: '@azure/msal-common' diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml b/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml index 0a11388..afca3c3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml @@ -138,8 +138,7 @@ methods: syntax: content: >- static function removeThrottle(cacheManager: CacheManager, clientId: - string, request: BaseAuthRequest, homeAccountIdentifier?: string): - boolean + string, request: BaseAuthRequest, homeAccountIdentifier?: string) parameters: - id: cacheManager type: @@ -153,6 +152,3 @@ methods: - id: homeAccountIdentifier type: string description: '' - return: - description: '' - type: boolean diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/TokenClaims.yml b/nodejs/docs-ref-autogen/@azure/msal-common/TokenClaims.yml index 9bb839f..f18e67b 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/TokenClaims.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/TokenClaims.yml @@ -31,6 +31,8 @@ syntax: | roles?: string[], sid?: string, sub?: string, + tenant_region_scope?: string, + tenant_region_sub_scope?: string, tid?: string, ts?: number, u?: string, diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/TokenKeys.yml b/nodejs/docs-ref-autogen/@azure/msal-common/TokenKeys.yml new file mode 100644 index 0000000..81c306b --- /dev/null +++ b/nodejs/docs-ref-autogen/@azure/msal-common/TokenKeys.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: TokenKeys +uid: '@azure/msal-common.TokenKeys' +package: '@azure/msal-common' +summary: '' +fullName: TokenKeys +remarks: '' +isDeprecated: false +syntax: | + type TokenKeys = { + accessToken: string[], + idToken: string[], + refreshToken: string[], + } diff --git a/nodejs/docs-ref-autogen/@azure/msal-common/index.yml b/nodejs/docs-ref-autogen/@azure/msal-common/index.yml index d714389..8d8b4c3 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-common/index.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-common/index.yml @@ -22,10 +22,10 @@ typeAliases: - '@azure/msal-common.AccountFilter' - '@azure/msal-common.AppMetadataCache' - '@azure/msal-common.AppMetadataFilter' - - '@azure/msal-common.CredentialCache' - '@azure/msal-common.CredentialFilter' - '@azure/msal-common.IdTokenCache' - '@azure/msal-common.RefreshTokenCache' + - '@azure/msal-common.TokenKeys' - '@azure/msal-common.ValidCacheType' - '@azure/msal-common.ValidCredentialType' - '@azure/msal-common.AppTokenProviderParameters' @@ -33,6 +33,7 @@ typeAliases: - '@azure/msal-common.ApplicationTelemetry' - '@azure/msal-common.AuthOptions' - '@azure/msal-common.AzureCloudOptions' + - '@azure/msal-common.CacheOptions' - '@azure/msal-common.ClientConfiguration' - '@azure/msal-common.CommonClientConfiguration' - '@azure/msal-common.LibraryInfo' @@ -139,7 +140,6 @@ enums: - '@azure/msal-common.AuthorityMetadataSource' - '@azure/msal-common.CacheAccountType' - '@azure/msal-common.CacheOutcome' - - '@azure/msal-common.CacheSchemaType' - '@azure/msal-common.CacheType' - '@azure/msal-common.ClaimsRequestKeys' - '@azure/msal-common.CredentialType' @@ -219,6 +219,7 @@ functions: application: ApplicationTelemetry }, userAuthOptions: { authority: Authority, azureCloudOptions?: AzureCloudOptions, clientCapabilities?: Array, clientId: string, skipAuthorityMetadataCache?: boolean }, + userCacheOptions: { claimsBasedCachingEnabled?: boolean }, userLoggerOption: { correlationId?: string, logLevel?: LogLevel, loggerCallback?: ILoggerCallback, piiLoggingEnabled?: boolean }, userSystemOptions: { preventCorsPreflight?: boolean, @@ -242,6 +243,7 @@ functions: ApplicationTelemetry }, userAuthOptions: { authority: Authority, azureCloudOptions?: AzureCloudOptions, clientCapabilities?: Array, clientId: string, skipAuthorityMetadataCache?: boolean }, + userCacheOptions: { claimsBasedCachingEnabled?: boolean }, userLoggerOption: { correlationId?: string, logLevel?: LogLevel, loggerCallback?: ILoggerCallback, piiLoggingEnabled?: boolean }, userSystemOptions: { preventCorsPreflight?: boolean, @@ -259,9 +261,10 @@ functions: ApplicationTelemetry }, userAuthOptions: { authority: Authority, azureCloudOptions?: AzureCloudOptions, clientCapabilities?: Array<string>, clientId: string, skipAuthorityMetadataCache?: - boolean }, userLoggerOption: { correlationId?: string, logLevel?: - LogLevel, loggerCallback?: ILoggerCallback, piiLoggingEnabled?: - boolean }, userSystemOptions: { preventCorsPreflight?: boolean, + boolean }, userCacheOptions: { claimsBasedCachingEnabled?: boolean + }, userLoggerOption: { correlationId?: string, logLevel?: LogLevel, + loggerCallback?: ILoggerCallback, piiLoggingEnabled?: boolean }, + userSystemOptions: { preventCorsPreflight?: boolean, tokenRenewalOffsetSeconds?: number } } description: '' return: diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/CacheOptions.yml b/nodejs/docs-ref-autogen/@azure/msal-node/CacheOptions.yml index dd5414c..4d9ebd7 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/CacheOptions.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/CacheOptions.yml @@ -2,11 +2,18 @@ name: CacheOptions uid: '@azure/msal-node.CacheOptions' package: '@azure/msal-node' -summary: |- +summary: >- Use this to configure the below cache configuration options: + - cachePlugin - Plugin for reading and writing token cache to disk. + + - claimsBasedCachingEnabled - Flag to enable/disable claims based caching. Set + to true by default. fullName: CacheOptions remarks: '' isDeprecated: false syntax: | - type CacheOptions = { cachePlugin?: ICachePlugin } + type CacheOptions = { + cachePlugin?: ICachePlugin, + claimsBasedCachingEnabled?: boolean, + } diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml b/nodejs/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml index cf61ec7..5af19a9 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml @@ -11,23 +11,13 @@ methods: - name: extractKey(AccountEntity) uid: '@azure/msal-node.IPartitionManager.extractKey' package: '@azure/msal-node' - summary: > + summary: | This function should return the correct key being used to save each - user's cache information to cache - given an AccountEntity - Example: Your application may be partitioning the user's cache - information for each user using the homeAccountId thus - this function would return the homeAccountId from - the provided AccountEntity - - - Visit the - [RedisTestApp](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/RedisTestApp) - to see it in action. remarks: '' isDeprecated: false syntax: @@ -42,23 +32,13 @@ methods: - name: getKey() uid: '@azure/msal-node.IPartitionManager.getKey' package: '@azure/msal-node' - summary: > + summary: | This function should return the correct key from which to read - the specific user's information from cache. - Example: Your application may be partitioning the user's cache - information for each user using the homeAccountId and thus - this function would return the homeAccountId for - the user in question - - - Visit the - [RedisTestApp](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/RedisTestApp) - to see it in action. remarks: '' isDeprecated: false syntax: diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/NodeStorage.yml b/nodejs/docs-ref-autogen/@azure/msal-node/NodeStorage.yml index 1d32273..45bf023 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/NodeStorage.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/NodeStorage.yml @@ -29,6 +29,53 @@ constructors: type: ICrypto description: '' inheritedMethods: + - name: 'accessTokenKeyMatchesFilter(string, CredentialFilter, boolean)' + uid: '@azure/msal-node.NodeStorage.accessTokenKeyMatchesFilter' + package: '@azure/msal-node' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function accessTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter, keyMustContainAllScopes: boolean): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: CredentialFilter + description: '' + - id: keyMustContainAllScopes + type: boolean + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.accessTokenKeyMatchesFilter + - name: 'credentialMatchesFilter(ValidCredentialType, CredentialFilter)' + uid: '@azure/msal-node.NodeStorage.credentialMatchesFilter' + package: '@azure/msal-node' + summary: Returns whether or not the given credential entity matches the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function credentialMatchesFilter(entity: ValidCredentialType, filter: + CredentialFilter): boolean + parameters: + - id: entity + type: ValidCredentialType + description: '' + - id: filter + type: CredentialFilter + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.credentialMatchesFilter - name: generateAuthorityMetadataCacheKey(string) uid: '@azure/msal-node.NodeStorage.generateAuthorityMetadataCacheKey' package: '@azure/msal-node' @@ -45,6 +92,66 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From CacheManager.generateAuthorityMetadataCacheKey + - name: 'getAccessToken(AccountInfo, BaseAuthRequest, TokenKeys)' + uid: '@azure/msal-node.NodeStorage.getAccessToken' + package: '@azure/msal-node' + summary: Retrieve AccessTokenEntity from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessToken(account: AccountInfo, request: BaseAuthRequest, + tokenKeys?: TokenKeys): AccessTokenEntity | null + parameters: + - id: account + type: AccountInfo + description: '' + - id: request + type: BaseAuthRequest + description: '' + - id: tokenKeys + type: TokenKeys + description: '' + return: + description: '' + type: AccessTokenEntity | null + inheritanceDescription: Inherited From CacheManager.getAccessToken + - name: getAccessTokensByFilter(CredentialFilter) + uid: '@azure/msal-node.NodeStorage.getAccessTokensByFilter' + package: '@azure/msal-node' + summary: Gets all access tokens matching the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessTokensByFilter(filter: CredentialFilter): + AccessTokenEntity[] + parameters: + - id: filter + type: CredentialFilter + description: '' + return: + description: '' + type: 'AccessTokenEntity[]' + inheritanceDescription: Inherited From CacheManager.getAccessTokensByFilter + - name: getAccountInfoFilteredBy(AccountFilter) + uid: '@azure/msal-node.NodeStorage.getAccountInfoFilteredBy' + package: '@azure/msal-node' + summary: Gets accountInfo object based on provided filters + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountInfoFilteredBy(accountFilter: AccountFilter): + AccountInfo | null + parameters: + - id: accountFilter + type: AccountFilter + description: '' + return: + description: '' + type: AccountInfo | null + inheritanceDescription: Inherited From CacheManager.getAccountInfoFilteredBy - name: getAccountsFilteredBy(AccountFilter) uid: '@azure/msal-node.NodeStorage.getAccountsFilteredBy' package: '@azure/msal-node' @@ -58,15 +165,15 @@ inheritedMethods: isDeprecated: false syntax: content: >- - function getAccountsFilteredBy(accountFilter?: AccountFilter): - AccountCache + function getAccountsFilteredBy(accountFilter: AccountFilter): + AccountEntity[] parameters: - id: accountFilter type: AccountFilter description: '' return: description: '' - type: AccountCache + type: 'AccountEntity[]' inheritanceDescription: Inherited From CacheManager.getAccountsFilteredBy - name: getAllAccounts() uid: '@azure/msal-node.NodeStorage.getAllAccounts' @@ -119,72 +226,155 @@ inheritedMethods: description: '' type: AuthorityMetadataEntity | null inheritanceDescription: Inherited From CacheManager.getAuthorityMetadataByAlias - - name: getCredentialsFilteredBy(CredentialFilter) - uid: '@azure/msal-node.NodeStorage.getCredentialsFilteredBy' + - name: 'getIdToken(AccountInfo, TokenKeys)' + uid: '@azure/msal-node.NodeStorage.getIdToken' package: '@azure/msal-node' - summary: >- - retrieve credentails matching all provided filters; if no filter is set, - get all credentials + summary: Retrieve IdTokenEntity from cache remarks: '' isDeprecated: false syntax: content: >- - function getCredentialsFilteredBy(filter: CredentialFilter): - CredentialCache + function getIdToken(account: AccountInfo, tokenKeys?: TokenKeys): + IdTokenEntity | null + parameters: + - id: account + type: AccountInfo + description: '' + - id: tokenKeys + type: TokenKeys + description: '' + return: + description: '' + type: IdTokenEntity | null + inheritanceDescription: Inherited From CacheManager.getIdToken + - name: 'getIdTokensByFilter(CredentialFilter, TokenKeys)' + uid: '@azure/msal-node.NodeStorage.getIdTokensByFilter' + package: '@azure/msal-node' + summary: Gets all idTokens matching the given filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getIdTokensByFilter(filter: CredentialFilter, tokenKeys?: + TokenKeys): IdTokenEntity[] parameters: - id: filter type: CredentialFilter description: '' + - id: tokenKeys + type: TokenKeys + description: '' return: description: '' - type: CredentialCache - inheritanceDescription: Inherited From CacheManager.getCredentialsFilteredBy - - name: 'isAppMetadataFOCI(string, string)' - uid: '@azure/msal-node.NodeStorage.isAppMetadataFOCI' + type: 'IdTokenEntity[]' + inheritanceDescription: Inherited From CacheManager.getIdTokensByFilter + - name: 'getRefreshToken(AccountInfo, boolean, TokenKeys)' + uid: '@azure/msal-node.NodeStorage.getRefreshToken' package: '@azure/msal-node' - summary: Return the family_id value associated with FOCI + summary: Helper to retrieve the appropriate refresh token from cache remarks: '' isDeprecated: false syntax: content: >- - function isAppMetadataFOCI(environment: string, clientId: string): - boolean + function getRefreshToken(account: AccountInfo, familyRT: boolean, + tokenKeys?: TokenKeys): RefreshTokenEntity | null parameters: - - id: environment - type: string + - id: account + type: AccountInfo description: '' - - id: clientId - type: string + - id: familyRT + type: boolean description: |+ + - id: tokenKeys + type: TokenKeys + description: '' + return: + description: '' + type: RefreshTokenEntity | null + inheritanceDescription: Inherited From CacheManager.getRefreshToken + - name: 'idTokenKeyMatchesFilter(string, CredentialFilter)' + uid: '@azure/msal-node.NodeStorage.idTokenKeyMatchesFilter' + package: '@azure/msal-node' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function idTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: CredentialFilter + description: '' return: description: '' type: boolean - inheritanceDescription: Inherited From CacheManager.isAppMetadataFOCI - - name: 'readAccessTokenFromCache(string, AccountInfo, BaseAuthRequest)' - uid: '@azure/msal-node.NodeStorage.readAccessTokenFromCache' + inheritanceDescription: Inherited From CacheManager.idTokenKeyMatchesFilter + - name: 'isAccountKey(string, string, string)' + uid: '@azure/msal-node.NodeStorage.isAccountKey' package: '@azure/msal-node' - summary: Retrieve AccessTokenEntity from cache + summary: >- + Returns true if the given key matches our account key schema. Also matches + homeAccountId and/or tenantId if provided remarks: '' isDeprecated: false syntax: content: >- - function readAccessTokenFromCache(clientId: string, account: - AccountInfo, request: BaseAuthRequest): AccessTokenEntity | null + function isAccountKey(key: string, homeAccountId?: string, tenantId?: + string): boolean parameters: - - id: clientId + - id: key type: string description: '' - - id: account - type: AccountInfo + - id: homeAccountId + type: string description: '' - - id: request - type: BaseAuthRequest + - id: tenantId + type: string description: '' return: description: '' - type: AccessTokenEntity | null - inheritanceDescription: Inherited From CacheManager.readAccessTokenFromCache + type: boolean + inheritanceDescription: Inherited From CacheManager.isAccountKey + - name: isAppMetadataFOCI(string) + uid: '@azure/msal-node.NodeStorage.isAppMetadataFOCI' + package: '@azure/msal-node' + summary: Return the family_id value associated with FOCI + remarks: '' + isDeprecated: false + syntax: + content: 'function isAppMetadataFOCI(environment: string): boolean' + parameters: + - id: environment + type: string + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.isAppMetadataFOCI + - name: isCredentialKey(string) + uid: '@azure/msal-node.NodeStorage.isCredentialKey' + package: '@azure/msal-node' + summary: Returns true if the given key matches our credential key schema. + remarks: '' + isDeprecated: false + syntax: + content: 'function isCredentialKey(key: string): boolean' + parameters: + - id: key + type: string + description: |+ + + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.isCredentialKey - name: readAccountFromCache(AccountInfo) uid: '@azure/msal-node.NodeStorage.readAccountFromCache' package: '@azure/msal-node' @@ -204,25 +394,7 @@ inheritedMethods: description: '' type: AccountEntity | null inheritanceDescription: Inherited From CacheManager.readAccountFromCache - - name: readAccountFromCacheWithNativeAccountId(string) - uid: '@azure/msal-node.NodeStorage.readAccountFromCacheWithNativeAccountId' - package: '@azure/msal-node' - summary: Retrieve AccountEntity from cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function readAccountFromCacheWithNativeAccountId(nativeAccountId: - string): AccountEntity | null - parameters: - - id: nativeAccountId - type: string - description: '' - return: - description: AccountEntity or Null - type: AccountEntity | null - inheritanceDescription: Inherited From CacheManager.readAccountFromCacheWithNativeAccountId - - name: 'readAppMetadataFromCache(string, string)' + - name: readAppMetadataFromCache(string) uid: '@azure/msal-node.NodeStorage.readAppMetadataFromCache' package: '@azure/msal-node' summary: Retrieve AppMetadataEntity from cache @@ -230,20 +402,17 @@ inheritedMethods: isDeprecated: false syntax: content: >- - function readAppMetadataFromCache(environment: string, clientId: - string): AppMetadataEntity | null + function readAppMetadataFromCache(environment: string): + AppMetadataEntity | null parameters: - id: environment type: string description: '' - - id: clientId - type: string - description: '' return: description: '' type: AppMetadataEntity | null inheritanceDescription: Inherited From CacheManager.readAppMetadataFromCache - - name: 'readCacheRecord(AccountInfo, string, BaseAuthRequest, string)' + - name: 'readCacheRecord(AccountInfo, BaseAuthRequest, string)' uid: '@azure/msal-node.NodeStorage.readCacheRecord' package: '@azure/msal-node' summary: Retrieve the cached credentials into a cacherecord @@ -251,15 +420,12 @@ inheritedMethods: isDeprecated: false syntax: content: >- - function readCacheRecord(account: AccountInfo, clientId: string, - request: BaseAuthRequest, environment: string): CacheRecord + function readCacheRecord(account: AccountInfo, request: BaseAuthRequest, + environment: string): CacheRecord parameters: - id: account type: AccountInfo description: '' - - id: clientId - type: string - description: '' - id: request type: BaseAuthRequest description: '' @@ -270,67 +436,61 @@ inheritedMethods: description: '' type: CacheRecord inheritanceDescription: Inherited From CacheManager.readCacheRecord - - name: 'readIdTokenFromCache(string, AccountInfo)' - uid: '@azure/msal-node.NodeStorage.readIdTokenFromCache' + - name: 'refreshTokenKeyMatchesFilter(string, CredentialFilter)' + uid: '@azure/msal-node.NodeStorage.refreshTokenKeyMatchesFilter' package: '@azure/msal-node' - summary: Retrieve IdTokenEntity from cache + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value remarks: '' isDeprecated: false syntax: content: >- - function readIdTokenFromCache(clientId: string, account: AccountInfo): - IdTokenEntity | null + function refreshTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean parameters: - - id: clientId + - id: inputKey type: string description: '' - - id: account - type: AccountInfo - description: '' + - id: filter + type: CredentialFilter + description: |+ + return: description: '' - type: IdTokenEntity | null - inheritanceDescription: Inherited From CacheManager.readIdTokenFromCache - - name: 'readRefreshTokenFromCache(string, AccountInfo, boolean)' - uid: '@azure/msal-node.NodeStorage.readRefreshTokenFromCache' + type: boolean + inheritanceDescription: Inherited From CacheManager.refreshTokenKeyMatchesFilter + - name: removeAccessToken(string) + uid: '@azure/msal-node.NodeStorage.removeAccessToken' package: '@azure/msal-node' - summary: Helper to retrieve the appropriate refresh token from cache + summary: returns a boolean if the given credential is removed remarks: '' isDeprecated: false syntax: - content: >- - function readRefreshTokenFromCache(clientId: string, account: - AccountInfo, familyRT: boolean): RefreshTokenEntity | null + content: 'function removeAccessToken(key: string): Promise' parameters: - - id: clientId + - id: key type: string description: '' - - id: account - type: AccountInfo - description: '' - - id: familyRT - type: boolean - description: |+ - return: description: '' - type: RefreshTokenEntity | null - inheritanceDescription: Inherited From CacheManager.readRefreshTokenFromCache + type: Promise<void> + inheritanceDescription: Inherited From CacheManager.removeAccessToken - name: removeAccount(string) uid: '@azure/msal-node.NodeStorage.removeAccount' package: '@azure/msal-node' - summary: returns a boolean if the given account is removed + summary: Removes the account and related tokens for a given account key remarks: '' isDeprecated: false syntax: - content: 'function removeAccount(accountKey: string): Promise' + content: 'function removeAccount(accountKey: string): Promise' parameters: - id: accountKey type: string description: '' return: description: '' - type: Promise<boolean> + type: Promise<void> inheritanceDescription: Inherited From CacheManager.removeAccount - name: removeAccountContext(AccountEntity) uid: '@azure/msal-node.NodeStorage.removeAccountContext' @@ -339,7 +499,7 @@ inheritedMethods: remarks: '' isDeprecated: false syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' + content: 'function removeAccountContext(account: AccountEntity): Promise' parameters: - id: account type: AccountEntity @@ -347,7 +507,7 @@ inheritedMethods: return: description: '' - type: Promise<boolean> + type: Promise<void> inheritanceDescription: Inherited From CacheManager.removeAccountContext - name: removeAllAccounts() uid: '@azure/msal-node.NodeStorage.removeAllAccounts' @@ -356,10 +516,10 @@ inheritedMethods: remarks: '' isDeprecated: false syntax: - content: 'function removeAllAccounts(): Promise' + content: 'function removeAllAccounts(): Promise' return: description: '' - type: Promise<boolean> + type: Promise<void> inheritanceDescription: Inherited From CacheManager.removeAllAccounts - name: removeAppMetadata() uid: '@azure/msal-node.NodeStorage.removeAppMetadata' @@ -373,25 +533,34 @@ inheritedMethods: description: '' type: boolean inheritanceDescription: Inherited From CacheManager.removeAppMetadata - - name: removeCredential(CredentialEntity) - uid: '@azure/msal-node.NodeStorage.removeCredential' + - name: removeIdToken(string) + uid: '@azure/msal-node.NodeStorage.removeIdToken' package: '@azure/msal-node' - summary: returns a boolean if the given credential is removed + summary: Removes idToken from the cache remarks: '' isDeprecated: false syntax: - content: >- - function removeCredential(credential: CredentialEntity): - Promise + content: 'function removeIdToken(key: string)' parameters: - - id: credential - type: CredentialEntity + - id: key + type: string description: |+ - return: - description: '' - type: Promise<boolean> - inheritanceDescription: Inherited From CacheManager.removeCredential + inheritanceDescription: Inherited From CacheManager.removeIdToken + - name: removeRefreshToken(string) + uid: '@azure/msal-node.NodeStorage.removeRefreshToken' + package: '@azure/msal-node' + summary: Removes refresh token from the cache + remarks: '' + isDeprecated: false + syntax: + content: 'function removeRefreshToken(key: string)' + parameters: + - id: key + type: string + description: |+ + + inheritanceDescription: Inherited From CacheManager.removeRefreshToken - name: saveCacheRecord(CacheRecord) uid: '@azure/msal-node.NodeStorage.saveCacheRecord' package: '@azure/msal-node' @@ -549,6 +718,17 @@ methods: return: description: '' type: AccountEntity | null + - name: getAccountKeys() + uid: '@azure/msal-node.NodeStorage.getAccountKeys' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountKeys(): string[]' + return: + description: '' + type: 'string[]' - name: getAppMetadata(string) uid: '@azure/msal-node.NodeStorage.getAppMetadata' package: '@azure/msal-node' @@ -715,6 +895,17 @@ methods: return: description: '' type: ThrottlingEntity | null + - name: getTokenKeys() + uid: '@azure/msal-node.NodeStorage.getTokenKeys' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenKeys(): TokenKeys' + return: + description: '' + type: TokenKeys - name: inMemoryCacheToCache(InMemoryCache) uid: '@azure/msal-node.NodeStorage.inMemoryCacheToCache' package: '@azure/msal-node' diff --git a/nodejs/docs-ref-autogen/@azure/msal-node/index.yml b/nodejs/docs-ref-autogen/@azure/msal-node/index.yml index 5aeeb68..3f99cfa 100644 --- a/nodejs/docs-ref-autogen/@azure/msal-node/index.yml +++ b/nodejs/docs-ref-autogen/@azure/msal-node/index.yml @@ -54,10 +54,10 @@ functions: clientSecret?: string, cloudDiscoveryMetadata?: string, knownAuthorities?: Array, protocolMode?: ProtocolMode, skipAuthorityMetadataCache?: boolean }, broker: { nativeBrokerPlugin?: INativeBrokerPlugin }, cache: { - cachePlugin?: ICachePlugin }, system: { customAgentOptions?: - httpAgentOptions | httpsAgentOptions, loggerOptions?: LoggerOptions, - networkClient?: INetworkModule, proxyUrl?: string }, telemetry: { - application?: ApplicationTelemetry } }) + cachePlugin?: ICachePlugin, claimsBasedCachingEnabled?: boolean }, system: + { customAgentOptions?: httpAgentOptions | httpsAgentOptions, + loggerOptions?: LoggerOptions, networkClient?: INetworkModule, proxyUrl?: + string }, telemetry: { application?: ApplicationTelemetry } }) uid: '@azure/msal-node.buildAppConfiguration' package: '@azure/msal-node' summary: Sets the default options when not explicitly configured from app developer @@ -73,10 +73,11 @@ functions: cloudDiscoveryMetadata?: string, knownAuthorities?: Array, protocolMode?: ProtocolMode, skipAuthorityMetadataCache?: boolean }, broker: { nativeBrokerPlugin?: INativeBrokerPlugin }, cache: { - cachePlugin?: ICachePlugin }, system: { customAgentOptions?: - httpAgentOptions | httpsAgentOptions, loggerOptions?: LoggerOptions, - networkClient?: INetworkModule, proxyUrl?: string }, telemetry: { - application?: ApplicationTelemetry } }): NodeConfiguration + cachePlugin?: ICachePlugin, claimsBasedCachingEnabled?: boolean }, + system: { customAgentOptions?: httpAgentOptions | httpsAgentOptions, + loggerOptions?: LoggerOptions, networkClient?: INetworkModule, + proxyUrl?: string }, telemetry: { application?: ApplicationTelemetry } + }): NodeConfiguration parameters: - id: __namedParameters type: >- @@ -88,10 +89,11 @@ functions: knownAuthorities?: Array<string>, protocolMode?: ProtocolMode, skipAuthorityMetadataCache?: boolean }, broker: { nativeBrokerPlugin?: INativeBrokerPlugin }, cache: { cachePlugin?: - ICachePlugin }, system: { customAgentOptions?: httpAgentOptions | - httpsAgentOptions, loggerOptions?: LoggerOptions, networkClient?: - INetworkModule, proxyUrl?: string }, telemetry: { application?: - ApplicationTelemetry } } + ICachePlugin, claimsBasedCachingEnabled?: boolean }, system: { + customAgentOptions?: httpAgentOptions | httpsAgentOptions, + loggerOptions?: LoggerOptions, networkClient?: INetworkModule, + proxyUrl?: string }, telemetry: { application?: ApplicationTelemetry + } } description: '' return: description: Configuration diff --git a/nodejs/docs-ref-autogen/toc.yml b/nodejs/docs-ref-autogen/toc.yml index edf6298..fed2582 100644 --- a/nodejs/docs-ref-autogen/toc.yml +++ b/nodejs/docs-ref-autogen/toc.yml @@ -430,6 +430,9 @@ - uid: '@azure/msal-browser.StandardInteractionClient' name: StandardInteractionClient items: [] + - uid: '@azure/msal-browser.StaticCacheKeys' + name: StaticCacheKeys + items: [] - uid: '@azure/msal-browser.TemporaryCacheKeys' name: TemporaryCacheKeys items: [] @@ -554,15 +557,15 @@ - uid: '@azure/msal-common.CacheManager' name: CacheManager items: [] + - uid: '@azure/msal-common.CacheOptions' + name: CacheOptions + items: [] - uid: '@azure/msal-common.CacheOutcome' name: CacheOutcome items: [] - uid: '@azure/msal-common.CacheRecord' name: CacheRecord items: [] - - uid: '@azure/msal-common.CacheSchemaType' - name: CacheSchemaType - items: [] - uid: '@azure/msal-common.CacheType' name: CacheType items: [] @@ -632,9 +635,6 @@ - uid: '@azure/msal-common.Counters' name: Counters items: [] - - uid: '@azure/msal-common.CredentialCache' - name: CredentialCache - items: [] - uid: '@azure/msal-common.CredentialEntity' name: CredentialEntity items: [] @@ -914,6 +914,9 @@ - uid: '@azure/msal-common.TokenClaims' name: TokenClaims items: [] + - uid: '@azure/msal-common.TokenKeys' + name: TokenKeys + items: [] - uid: '@azure/msal-common.UrlString' name: UrlString items: [] From 96fb46f23cf8b374508c7e3ce0a8cf40629de435 Mon Sep 17 00:00:00 2001 From: VSC-Service-Account Date: Wed, 24 Apr 2024 02:41:15 +0000 Subject: [PATCH 03/24] CI Update Build.Reason:Manual by Yanan Zhao Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=425819&view=results --- .../@azure/msal-angular/IMsalService.yml | 182 +++ .../MsalBroadcastConfiguration.yml | 10 + .../msal-angular/MsalBroadcastService.yml | 89 ++ .../MsalCustomNavigationClient.yml | 110 ++ .../@azure/msal-angular/MsalGuard.yml | 165 +++ .../msal-angular/MsalGuardAuthRequest.yml | 12 + .../msal-angular/MsalGuardConfiguration.yml | 13 + .../@azure/msal-angular/MsalInterceptor.yml | 89 ++ .../MsalInterceptorAuthRequest.yml | 13 + .../MsalInterceptorConfiguration.yml | 14 + .../@azure/msal-angular/MsalModule.yml | 83 ++ .../msal-angular/MsalRedirectComponent.yml | 63 + .../@azure/msal-angular/MsalService.yml | 281 ++++ .../msal-angular/ProtectedResourceScopes.yml | 10 + .../@azure/msal-angular/index.yml | 22 + .../@azure/msal-browser/AccountInfo.yml | 51 + .../@azure/msal-browser/ApiId.yml | 10 + .../@azure/msal-browser/AuthError.yml | 181 +++ .../@azure/msal-browser/AuthErrorCodes.yml | 6 + .../AuthenticationHeaderParser.yml | 41 + .../msal-browser/AuthenticationResult.yml | 12 + .../msal-browser/AuthenticationScheme.yml | 11 + .../msal-browser/AuthorizationCodeRequest.yml | 21 + .../msal-browser/AuthorizationUrlRequest.yml | 13 + .../msal-browser/AzureCloudInstance.yml | 11 + .../@azure/msal-browser/AzureCloudOptions.yml | 20 + .../@azure/msal-browser/BrowserAuthError.yml | 198 +++ .../msal-browser/BrowserAuthErrorCodes.yml | 6 + .../msal-browser/BrowserAuthOptions.yml | 25 + .../msal-browser/BrowserCacheLocation.yml | 11 + .../BrowserConfigurationAuthError.yml | 203 +++ .../BrowserConfigurationAuthErrorCodes.yml | 6 + .../msal-browser/BrowserPerformanceClient.yml | 311 +++++ .../BrowserPerformanceMeasurement.yml | 82 ++ .../@azure/msal-browser/BrowserStorage.yml | 91 ++ .../msal-browser/BrowserSystemOptions.yml | 24 + .../msal-browser/BrowserTelemetryOptions.yml | 13 + .../@azure/msal-browser/BrowserUtils.yml | 181 +++ .../@azure/msal-browser/CacheLookupPolicy.yml | 11 + .../@azure/msal-browser/CacheOptions.yml | 17 + .../@azure/msal-browser/ClearCacheRequest.yml | 20 + .../@azure/msal-browser/ClientAuthError.yml | 201 +++ .../msal-browser/ClientAuthErrorCodes.yml | 6 + .../msal-browser/ClientConfigurationError.yml | 198 +++ .../ClientConfigurationErrorCodes.yml | 6 + .../@azure/msal-browser/Configuration.yml | 17 + .../msal-browser/EndSessionPopupRequest.yml | 40 + .../@azure/msal-browser/EndSessionRequest.yml | 33 + .../msal-browser/EventCallbackFunction.yml | 10 + .../@azure/msal-browser/EventError.yml | 10 + .../@azure/msal-browser/EventMessage.yml | 16 + .../@azure/msal-browser/EventMessageUtils.yml | 30 + .../@azure/msal-browser/EventPayload.yml | 19 + .../@azure/msal-browser/EventType.yml | 10 + .../msal-browser/ExternalTokenResponse.yml | 32 + .../@azure/msal-browser/IController.yml | 511 +++++++ .../@azure/msal-browser/ILoggerCallback.yml | 9 + .../@azure/msal-browser/INavigationClient.yml | 56 + .../@azure/msal-browser/INetworkModule.yml | 62 + .../msal-browser/IPerformanceClient.yml | 230 ++++ .../msal-browser/IPublicClientApplication.yml | 463 +++++++ .../@azure/msal-browser/ITokenCache.yml | 33 + .../@azure/msal-browser/IdTokenClaims.yml | 44 + .../InProgressPerformanceEvent.yml | 20 + .../InteractionRequiredAuthError.yml | 275 ++++ .../InteractionRequiredAuthErrorCodes.yml | 6 + .../@azure/msal-browser/InteractionStatus.yml | 11 + .../@azure/msal-browser/InteractionType.yml | 25 + .../@azure/msal-browser/JsonWebTokenTypes.yml | 11 + .../@azure/msal-browser/LoadTokenOptions.yml | 14 + .../@azure/msal-browser/LogLevel.yml | 34 + .../@azure/msal-browser/Logger.yml | 235 ++++ .../@azure/msal-browser/MemoryStorage.yml | 86 ++ .../@azure/msal-browser/NavigationClient.yml | 52 + .../@azure/msal-browser/NavigationOptions.yml | 12 + .../msal-browser/NetworkRequestOptions.yml | 11 + .../@azure/msal-browser/NetworkResponse.yml | 14 + .../PerformanceCallbackFunction.yml | 10 + .../@azure/msal-browser/PerformanceEvent.yml | 75 ++ .../@azure/msal-browser/PerformanceEvents.yml | 426 ++++++ .../@azure/msal-browser/PopupEvent.yml | 10 + .../@azure/msal-browser/PopupPosition.yml | 10 + .../@azure/msal-browser/PopupRequest.yml | 92 ++ .../@azure/msal-browser/PopupSize.yml | 10 + .../msal-browser/PopupWindowAttributes.yml | 13 + .../@azure/msal-browser/ProtocolMode.yml | 10 + .../msal-browser/PublicClientApplication.yml | 656 +++++++++ .../@azure/msal-browser/PublicClientNext.yml | 643 +++++++++ .../@azure/msal-browser/RedirectRequest.yml | 99 ++ .../@azure/msal-browser/ServerError.yml | 208 +++ .../msal-browser/ServerResponseType.yml | 11 + .../@azure/msal-browser/SignedHttpRequest.yml | 77 ++ .../msal-browser/SignedHttpRequestOptions.yml | 10 + .../@azure/msal-browser/SilentRequest.yml | 71 + .../@azure/msal-browser/SsoSilentRequest.yml | 82 ++ .../msal-browser/StubPerformanceClient.yml | 153 +++ .../@azure/msal-browser/TenantProfile.yml | 13 + .../@azure/msal-browser/UrlString.yml | 194 +++ .../@azure/msal-browser/WrapperSKU.yml | 10 + .../@azure/msal-browser/index.yml | 86 ++ .../msal-common/AADAuthorityConstants.yml | 11 + .../@azure/msal-common/AADServerParamKeys.yml | 6 + .../@azure/msal-common/AccessTokenEntity.yml | 20 + .../@azure/msal-common/AccountFilter.yml | 16 + .../@azure/msal-common/AccountInfo.yml | 51 + .../msal-common/ActiveAccountFilters.yml | 14 + .../@azure/msal-common/AppMetadataEntity.yml | 14 + .../AppTokenProviderParameters.yml | 28 + .../msal-common/AppTokenProviderResult.yml | 26 + .../msal-common/ApplicationTelemetry.yml | 13 + .../@azure/msal-common/AuthError.yml | 181 +++ .../@azure/msal-common/AuthErrorCodes.yml | 6 + .../@azure/msal-common/AuthToken.yml | 57 + .../AuthenticationHeaderParser.yml | 41 + .../msal-common/AuthenticationResult.yml | 67 + .../msal-common/AuthenticationScheme.yml | 11 + .../@azure/msal-common/AuthorityFactory.yml | 6 + .../@azure/msal-common/AuthorityOptions.yml | 19 + .../@azure/msal-common/AuthorityType.yml | 10 + .../msal-common/AuthorizationCodePayload.yml | 19 + .../@azure/msal-common/AzureCloudInstance.yml | 11 + .../@azure/msal-common/AzureCloudOptions.yml | 20 + .../@azure/msal-common/AzureRegion.yml | 10 + .../msal-common/AzureRegionConfiguration.yml | 13 + .../@azure/msal-common/BaseAuthRequest.yml | 81 ++ .../@azure/msal-common/CacheAccountType.yml | 11 + .../@azure/msal-common/CacheError.yml | 139 ++ .../@azure/msal-common/CacheErrorCodes.yml | 6 + .../@azure/msal-common/CacheHelpers.yml | 394 ++++++ .../@azure/msal-common/CacheOptions.yml | 16 + .../@azure/msal-common/CacheOutcome.yml | 10 + .../@azure/msal-common/CacheType.yml | 10 + .../@azure/msal-common/CcsCredential.yml | 10 + .../@azure/msal-common/CcsCredentialType.yml | 11 + .../@azure/msal-common/ClaimsRequestKeys.yml | 11 + .../@azure/msal-common/ClientAssertion.yml | 10 + .../@azure/msal-common/ClientAuthError.yml | 201 +++ .../msal-common/ClientAuthErrorCodes.yml | 6 + .../msal-common/ClientConfigurationError.yml | 198 +++ .../ClientConfigurationErrorCodes.yml | 6 + .../@azure/msal-common/ClientInfo.yml | 10 + .../CommonAuthorizationCodeRequest.yml | 61 + .../CommonAuthorizationUrlRequest.yml | 107 ++ .../CommonClientCredentialRequest.yml | 33 + .../msal-common/CommonDeviceCodeRequest.yml | 55 + .../msal-common/CommonEndSessionRequest.yml | 40 + .../msal-common/CommonOnBehalfOfRequest.yml | 30 + .../msal-common/CommonRefreshTokenRequest.yml | 44 + .../msal-common/CommonSilentFlowRequest.yml | 44 + .../CommonUsernamePasswordRequest.yml | 38 + .../@azure/msal-common/CredentialEntity.yml | 23 + .../@azure/msal-common/CredentialFilter.yml | 24 + .../@azure/msal-common/CredentialType.yml | 10 + .../@azure/msal-common/DeviceCodeResponse.yml | 33 + .../msal-common/ExternalTokenResponse.yml | 32 + .../@azure/msal-common/GrantType.yml | 10 + .../@azure/msal-common/HeaderNames.yml | 10 + .../@azure/msal-common/HttpStatus.yml | 10 + .../@azure/msal-common/IAppTokenProvider.yml | 9 + .../@azure/msal-common/ICachePlugin.yml | 38 + .../@azure/msal-common/ICrypto.yml | 137 ++ .../@azure/msal-common/IGuidGenerator.yml | 36 + .../@azure/msal-common/ILoggerCallback.yml | 9 + .../msal-common/INativeBrokerPlugin.yml | 127 ++ .../@azure/msal-common/INetworkModule.yml | 62 + .../@azure/msal-common/IPerformanceClient.yml | 230 ++++ .../msal-common/IPerformanceMeasurement.yml | 37 + .../msal-common/ISerializableTokenCache.yml | 34 + .../@azure/msal-common/IUri.yml | 94 ++ .../@azure/msal-common/IdTokenEntity.yml | 10 + .../InProgressPerformanceEvent.yml | 20 + .../InteractionRequiredAuthError.yml | 275 ++++ .../InteractionRequiredAuthErrorCodes.yml | 6 + .../@azure/msal-common/JsonWebTokenTypes.yml | 11 + .../@azure/msal-common/LibraryStateObject.yml | 21 + .../@azure/msal-common/LogLevel.yml | 34 + .../@azure/msal-common/Logger.yml | 235 ++++ .../@azure/msal-common/LoggerOptions.yml | 26 + .../@azure/msal-common/NativeRequest.yml | 27 + .../msal-common/NativeSignOutRequest.yml | 14 + .../msal-common/NetworkRequestOptions.yml | 11 + .../@azure/msal-common/NetworkResponse.yml | 14 + .../@azure/msal-common/OIDCOptions.yml | 13 + .../msal-common/PasswordGrantConstants.yml | 11 + .../PerformanceCallbackFunction.yml | 10 + .../@azure/msal-common/PerformanceClient.yml | 320 +++++ .../@azure/msal-common/PerformanceEvent.yml | 75 ++ .../msal-common/PerformanceEventStatus.yml | 24 + .../@azure/msal-common/PerformanceEvents.yml | 424 ++++++ .../msal-common/PersistentCacheKeys.yml | 11 + .../@azure/msal-common/PkceCodes.yml | 13 + .../@azure/msal-common/PreQueueEvent.yml | 34 + .../@azure/msal-common/ProtocolMode.yml | 10 + .../@azure/msal-common/ProtocolUtils.yml | 75 ++ .../@azure/msal-common/QueueMeasurement.yml | 14 + .../@azure/msal-common/RefreshTokenEntity.yml | 10 + .../@azure/msal-common/RequestStateObject.yml | 15 + .../@azure/msal-common/RequestThumbprint.yml | 22 + .../@azure/msal-common/ResponseMode.yml | 10 + .../@azure/msal-common/ScopeSet.yml | 223 ++++ .../ServerAuthorizationCodeResponse.yml | 32 + .../ServerAuthorizationTokenResponse.yml | 80 ++ .../msal-common/ServerDeviceCodeResponse.yml | 17 + .../@azure/msal-common/ServerError.yml | 208 +++ .../@azure/msal-common/ServerResponseType.yml | 11 + .../msal-common/ServerTelemetryEntity.yml | 14 + .../msal-common/ServerTelemetryRequest.yml | 17 + .../@azure/msal-common/ShrOptions.yml | 10 + .../@azure/msal-common/SignedHttpRequest.yml | 20 + .../SignedHttpRequestParameters.yml | 17 + .../msal-common/StaticAuthorityOptions.yml | 15 + .../@azure/msal-common/StoreInCache.yml | 17 + .../@azure/msal-common/StringDict.yml | 10 + .../msal-common/StubPerformanceClient.yml | 153 +++ .../@azure/msal-common/SubMeasurement.yml | 10 + .../@azure/msal-common/SystemOptions.yml | 18 + .../@azure/msal-common/TenantProfile.yml | 13 + .../@azure/msal-common/ThrottlingEntity.yml | 16 + .../@azure/msal-common/TimeUtils.yml | 73 + .../@azure/msal-common/TokenCacheContext.yml | 78 ++ .../@azure/msal-common/TokenClaims.yml | 44 + .../@azure/msal-common/TokenKeys.yml | 14 + .../@azure/msal-common/UrlString.yml | 194 +++ .../msal-common/UrlToHttpRequestOptions.yml | 20 + .../@azure/msal-common/UrlUtils.yml | 43 + .../@azure/msal-common/index.yml | 422 ++++++ .../@azure/msal-node/AccountInfo.yml | 51 + .../msal-node/AppTokenProviderParameters.yml | 28 + .../msal-node/AppTokenProviderResult.yml | 26 + .../@azure/msal-node/AuthError.yml | 181 +++ .../@azure/msal-node/AuthErrorCodes.yml | 6 + .../@azure/msal-node/AuthenticationResult.yml | 67 + .../msal-node/AuthorizationCodePayload.yml | 19 + .../msal-node/AuthorizationCodeRequest.yml | 63 + .../msal-node/AuthorizationUrlRequest.yml | 96 ++ .../@azure/msal-node/AzureCloudInstance.yml | 11 + .../@azure/msal-node/AzureCloudOptions.yml | 20 + .../@azure/msal-node/BrokerOptions.yml | 18 + .../@azure/msal-node/CacheKVStore.yml | 10 + .../@azure/msal-node/CacheOptions.yml | 16 + .../@azure/msal-node/ClientApplication.yml | 214 +++ .../@azure/msal-node/ClientAssertion.yml | 98 ++ .../@azure/msal-node/ClientAuthError.yml | 201 +++ .../@azure/msal-node/ClientAuthErrorCodes.yml | 6 + .../msal-node/ClientConfigurationError.yml | 198 +++ .../ClientConfigurationErrorCodes.yml | 6 + .../msal-node/ClientCredentialClient.yml | 158 +++ .../msal-node/ClientCredentialRequest.yml | 40 + .../ConfidentialClientApplication.yml | 373 ++++++ .../@azure/msal-node/Configuration.yml | 30 + .../@azure/msal-node/CryptoProvider.yml | 130 ++ .../@azure/msal-node/DeviceCodeClient.yml | 131 ++ .../@azure/msal-node/DeviceCodeRequest.yml | 50 + .../msal-node/DistributedCachePlugin.yml | 62 + .../@azure/msal-node/IAppTokenProvider.yml | 9 + .../@azure/msal-node/ICacheClient.yml | 43 + .../@azure/msal-node/ICachePlugin.yml | 38 + .../IConfidentialClientApplication.yml | 211 +++ .../@azure/msal-node/ILoopbackClient.yml | 53 + .../@azure/msal-node/INativeBrokerPlugin.yml | 127 ++ .../@azure/msal-node/INetworkModule.yml | 62 + .../@azure/msal-node/IPartitionManager.yml | 50 + .../msal-node/IPublicClientApplication.yml | 215 +++ .../msal-node/ISerializableTokenCache.yml | 34 + .../@azure/msal-node/ITokenCache.yml | 70 + .../@azure/msal-node/IdTokenClaims.yml | 44 + .../@azure/msal-node/InMemoryCache.yml | 16 + .../InteractionRequiredAuthError.yml | 275 ++++ .../InteractionRequiredAuthErrorCodes.yml | 6 + .../@azure/msal-node/InteractiveRequest.yml | 49 + .../@azure/msal-node/JsonCache.yml | 18 + .../@azure/msal-node/LogLevel.yml | 34 + .../@azure/msal-node/Logger.yml | 235 ++++ .../msal-node/ManagedIdentityApplication.yml | 42 + .../ManagedIdentityConfiguration.yml | 13 + .../msal-node/ManagedIdentityIdParams.yml | 14 + .../ManagedIdentityRequestParams.yml | 20 + .../msal-node/NetworkRequestOptions.yml | 11 + .../@azure/msal-node/NetworkResponse.yml | 14 + .../@azure/msal-node/NodeAuthOptions.yml | 51 + .../@azure/msal-node/NodeStorage.yml | 1173 +++++++++++++++++ .../@azure/msal-node/NodeSystemOptions.yml | 24 + .../@azure/msal-node/NodeTelemetryOptions.yml | 10 + .../@azure/msal-node/OnBehalfOfClient.yml | 110 ++ .../@azure/msal-node/OnBehalfOfRequest.yml | 37 + .../@azure/msal-node/ProtocolMode.yml | 10 + .../msal-node/PublicClientApplication.yml | 367 ++++++ .../@azure/msal-node/RefreshTokenRequest.yml | 43 + .../@azure/msal-node/ResponseMode.yml | 10 + .../msal-node/SerializedAccessTokenEntity.yml | 27 + .../msal-node/SerializedAccountEntity.yml | 22 + .../msal-node/SerializedAppMetadataEntity.yml | 14 + .../msal-node/SerializedIdTokenEntity.yml | 17 + .../SerializedRefreshTokenEntity.yml | 19 + .../ServerAuthorizationCodeResponse.yml | 32 + .../@azure/msal-node/ServerError.yml | 208 +++ .../@azure/msal-node/SignOutRequest.yml | 10 + .../@azure/msal-node/SilentFlowRequest.yml | 42 + .../@azure/msal-node/TokenCache.yml | 148 +++ .../@azure/msal-node/TokenCacheContext.yml | 78 ++ .../msal-node/UsernamePasswordClient.yml | 118 ++ .../msal-node/UsernamePasswordRequest.yml | 46 + .../@azure/msal-node/index.yml | 83 ++ .../msal-node/internals.Deserializer.yml | 137 ++ .../@azure/msal-node/internals.Serializer.yml | 135 ++ .../@azure/msal-node/internals.yml | 9 + .../@azure/msal-react/AccountIdentifiers.yml | 12 + .../msal-react/AuthenticatedTemplateProps.yml | 10 + .../@azure/msal-react/IMsalContext.yml | 58 + .../msal-react/MsalAuthenticationProps.yml | 17 + .../msal-react/MsalAuthenticationResult.yml | 21 + .../@azure/msal-react/MsalProviderProps.yml | 12 + .../@azure/msal-react/SetComplement.yml | 10 + .../@azure/msal-react/SetDifference.yml | 10 + .../@azure/msal-react/Subtract.yml | 10 + .../UnauthenticatedTemplateProps.yml | 10 + .../@azure/msal-react/WithMsalProps.yml | 10 + .../@azure/msal-react/index.yml | 239 ++++ msal/docs-ref-autogen/toc.yml | 960 ++++++++++++++ 319 files changed, 23715 insertions(+) create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalGuardAuthRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptor.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalModule.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-angular/index.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AccountInfo.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ApiId.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AuthenticationHeaderParser.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AuthenticationResult.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AuthenticationScheme.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AuthorizationCodeRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AzureCloudInstance.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AzureCloudOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ClearCacheRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ClientAuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ClientAuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/Configuration.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/EventError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/EventPayload.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/EventType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/IController.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ILoggerCallback.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/IPerformanceClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/IdTokenClaims.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InProgressPerformanceEvent.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InteractionType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/JsonWebTokenTypes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/LogLevel.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/Logger.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NavigationOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NetworkRequestOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NetworkResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PerformanceCallbackFunction.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PopupSize.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ProtocolMode.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ServerResponseType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/StubPerformanceClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/TenantProfile.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/UrlString.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/index.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AccountFilter.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AccountInfo.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ApplicationTelemetry.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthToken.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthorityType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AzureRegion.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheHelpers.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CcsCredential.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientAuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientInfo.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CredentialType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/GrantType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/HeaderNames.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/HttpStatus.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/INativeBrokerPlugin.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ISerializableTokenCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/IUri.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/JsonWebTokenTypes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/LogLevel.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/Logger.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/NativeRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/NativeSignOutRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/OIDCOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PerformanceCallbackFunction.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PkceCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PreQueueEvent.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/QueueMeasurement.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ResponseMode.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ScopeSet.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ServerError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ServerResponseType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ShrOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/StaticAuthorityOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/StoreInCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/StringDict.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/SubMeasurement.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/SystemOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/TenantProfile.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/TokenClaims.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/TokenKeys.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/UrlString.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/index.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AccountInfo.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AppTokenProviderParameters.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AppTokenProviderResult.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AuthenticationResult.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodePayload.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AzureCloudInstance.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AzureCloudOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/BrokerOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/CacheKVStore.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/CacheOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ClientAuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ClientAuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ClientCredentialClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/Configuration.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/DeviceCodeRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/IAppTokenProvider.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ICachePlugin.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/INativeBrokerPlugin.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ISerializableTokenCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ITokenCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/IdTokenClaims.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthErrorCodes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/JsonCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/LogLevel.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/Logger.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityApplication.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityConfiguration.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityIdParams.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/NetworkRequestOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/NetworkResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/NodeTelemetryOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ProtocolMode.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/RefreshTokenRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ResponseMode.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ServerError.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/SignOutRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/TokenCacheContext.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/index.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/internals.Deserializer.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/internals.Serializer.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/internals.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/IMsalContext.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/SetComplement.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/SetDifference.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/Subtract.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/UnauthenticatedTemplateProps.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-react/index.yml create mode 100644 msal/docs-ref-autogen/toc.yml diff --git a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml new file mode 100644 index 0000000..28682bb --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml @@ -0,0 +1,182 @@ +### YamlMime:TSType +name: IMsalService +uid: '@azure/msal-angular.IMsalService' +package: '@azure/msal-angular' +summary: '' +fullName: IMsalService +remarks: '' +isDeprecated: false +type: interface +methods: + - name: acquireTokenPopup(PopupRequest) + uid: '@azure/msal-angular.IMsalService.acquireTokenPopup' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenPopup(request: PopupRequest): + Observable + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Observable<> + - name: acquireTokenRedirect(RedirectRequest) + uid: '@azure/msal-angular.IMsalService.acquireTokenRedirect' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenRedirect(request: RedirectRequest): + Observable + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Observable<void> + - name: acquireTokenSilent(SilentRequest) + uid: '@azure/msal-angular.IMsalService.acquireTokenSilent' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(silentRequest: SilentRequest): + Observable + parameters: + - id: silentRequest + type: + description: '' + return: + description: '' + type: >- + Observable<> + - name: getLogger() + uid: '@azure/msal-angular.IMsalService.getLogger' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + - name: handleRedirectObservable() + uid: '@azure/msal-angular.IMsalService.handleRedirectObservable' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function handleRedirectObservable(): Observable + return: + description: '' + type: >- + Observable<null | > + - name: initialize() + uid: '@azure/msal-angular.IMsalService.initialize' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(): Observable' + return: + description: '' + type: Observable<void> + - name: loginPopup(PopupRequest) + uid: '@azure/msal-angular.IMsalService.loginPopup' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function loginPopup(request?: PopupRequest): + Observable + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Observable<> + - name: loginRedirect(RedirectRequest) + uid: '@azure/msal-angular.IMsalService.loginRedirect' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function loginRedirect(request?: RedirectRequest): Observable' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Observable<void> + - name: logout(EndSessionRequest) + uid: '@azure/msal-angular.IMsalService.logout' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function logout(logoutRequest?: EndSessionRequest): Observable' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Observable<void> + - name: setLogger(Logger) + uid: '@azure/msal-angular.IMsalService.setLogger' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: '' + - name: ssoSilent(AuthorizationUrlRequest) + uid: '@azure/msal-angular.IMsalService.ssoSilent' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function ssoSilent(request: AuthorizationUrlRequest): + Observable + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Observable<> diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml new file mode 100644 index 0000000..4c7da1d --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: MsalBroadcastConfiguration +uid: '@azure/msal-angular.MsalBroadcastConfiguration' +package: '@azure/msal-angular' +summary: '' +fullName: MsalBroadcastConfiguration +remarks: '' +isDeprecated: false +syntax: | + type MsalBroadcastConfiguration = { eventsToReplay: number } diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml new file mode 100644 index 0000000..4e34cc5 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml @@ -0,0 +1,89 @@ +### YamlMime:TSType +name: MsalBroadcastService +uid: '@azure/msal-angular.MsalBroadcastService' +package: '@azure/msal-angular' +summary: '' +fullName: MsalBroadcastService +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + MsalBroadcastService(IPublicClientApplication, MsalService, + MsalBroadcastConfiguration) + uid: '@azure/msal-angular.MsalBroadcastService.constructor' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new MsalBroadcastService(msalInstance: IPublicClientApplication, + authService: MsalService, msalBroadcastConfig?: + MsalBroadcastConfiguration) + parameters: + - id: msalInstance + type: + description: '' + - id: authService + type: + description: '' + - id: msalBroadcastConfig + type: + description: '' +properties: + - name: inProgress$ + uid: '@azure/msal-angular.MsalBroadcastService.inProgress$' + package: '@azure/msal-angular' + summary: '' + fullName: inProgress$ + remarks: '' + isDeprecated: false + syntax: + content: 'inProgress$: Observable' + return: + description: '' + type: Observable<> + - name: msalSubject$ + uid: '@azure/msal-angular.MsalBroadcastService.msalSubject$' + package: '@azure/msal-angular' + summary: '' + fullName: msalSubject$ + remarks: '' + isDeprecated: false + syntax: + content: 'msalSubject$: Observable' + return: + description: '' + type: Observable<> + - name: ɵfac + uid: '@azure/msal-angular.MsalBroadcastService.ɵfac' + package: '@azure/msal-angular' + summary: '' + fullName: ɵfac + remarks: '' + isDeprecated: false + syntax: + content: >- + static ɵfac: ɵɵFactoryDeclaration + return: + description: '' + type: >- + ɵɵFactoryDeclaration<, [null, null, { + optional: true }]> + - name: ɵprov + uid: '@azure/msal-angular.MsalBroadcastService.ɵprov' + package: '@azure/msal-angular' + summary: '' + fullName: ɵprov + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵprov: ɵɵInjectableDeclaration' + return: + description: '' + type: >- + ɵɵInjectableDeclaration<> diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml new file mode 100644 index 0000000..3fdbd26 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml @@ -0,0 +1,110 @@ +### YamlMime:TSType +name: MsalCustomNavigationClient +uid: '@azure/msal-angular.MsalCustomNavigationClient' +package: '@azure/msal-angular' +summary: >- + Custom navigation used for Angular client-side navigation. + + See performance doc for details: + + https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-angular/docs/performance.md +fullName: MsalCustomNavigationClient +remarks: '' +isDeprecated: false +type: class +constructors: + - name: MsalCustomNavigationClient(MsalService, Router, Location) + uid: '@azure/msal-angular.MsalCustomNavigationClient.constructor' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new MsalCustomNavigationClient(authService: MsalService, router: Router, + location: Location) + parameters: + - id: authService + type: + description: '' + - id: router + type: Router + description: '' + - id: location + type: Location + description: '' +properties: + - name: ɵfac + uid: '@azure/msal-angular.MsalCustomNavigationClient.ɵfac' + package: '@azure/msal-angular' + summary: '' + fullName: ɵfac + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵfac: ɵɵFactoryDeclaration' + return: + description: '' + type: >- + ɵɵFactoryDeclaration<, never> + - name: ɵprov + uid: '@azure/msal-angular.MsalCustomNavigationClient.ɵprov' + package: '@azure/msal-angular' + summary: '' + fullName: ɵprov + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵprov: ɵɵInjectableDeclaration' + return: + description: '' + type: >- + ɵɵInjectableDeclaration<> +inheritedMethods: + - name: navigateExternal(string, NavigationOptions) + uid: '@azure/msal-angular.MsalCustomNavigationClient.navigateExternal' + package: '@azure/msal-angular' + summary: >- + Navigates to other pages outside the web application i.e. the Identity + Provider + remarks: '' + isDeprecated: false + syntax: + content: >- + function navigateExternal(url: string, options: NavigationOptions): + Promise + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + return: + description: '' + type: Promise<boolean> + inheritanceDescription: Inherited From NavigationClient.navigateExternal +methods: + - name: navigateInternal(string, NavigationOptions) + uid: '@azure/msal-angular.MsalCustomNavigationClient.navigateInternal' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function navigateInternal(url: string, options: NavigationOptions): + Promise + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + return: + description: '' + type: Promise<boolean> +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml new file mode 100644 index 0000000..69bc73c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml @@ -0,0 +1,165 @@ +### YamlMime:TSType +name: MsalGuard +uid: '@azure/msal-angular.MsalGuard' +package: '@azure/msal-angular' +summary: '' +fullName: MsalGuard +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + MsalGuard(MsalGuardConfiguration, MsalBroadcastService, MsalService, + Location, Router) + uid: '@azure/msal-angular.MsalGuard.constructor' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new MsalGuard(msalGuardConfig: MsalGuardConfiguration, + msalBroadcastService: MsalBroadcastService, authService: MsalService, + location: Location, router: Router) + parameters: + - id: msalGuardConfig + type: + description: '' + - id: msalBroadcastService + type: + description: '' + - id: authService + type: + description: '' + - id: location + type: Location + description: '' + - id: router + type: Router + description: '' +properties: + - name: ɵfac + uid: '@azure/msal-angular.MsalGuard.ɵfac' + package: '@azure/msal-angular' + summary: '' + fullName: ɵfac + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵfac: ɵɵFactoryDeclaration' + return: + description: '' + type: >- + ɵɵFactoryDeclaration<, + never> + - name: ɵprov + uid: '@azure/msal-angular.MsalGuard.ɵprov' + package: '@azure/msal-angular' + summary: '' + fullName: ɵprov + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵprov: ɵɵInjectableDeclaration' + return: + description: '' + type: >- + ɵɵInjectableDeclaration<> +methods: + - name: canActivate(ActivatedRouteSnapshot, RouterStateSnapshot) + uid: '@azure/msal-angular.MsalGuard.canActivate' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function canActivate(route: ActivatedRouteSnapshot, state: + RouterStateSnapshot): Observable + parameters: + - id: route + type: ActivatedRouteSnapshot + description: '' + - id: state + type: RouterStateSnapshot + description: '' + return: + description: '' + type: Observable<any> + - name: canActivateChild(ActivatedRouteSnapshot, RouterStateSnapshot) + uid: '@azure/msal-angular.MsalGuard.canActivateChild' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function canActivateChild(route: ActivatedRouteSnapshot, state: + RouterStateSnapshot): Observable + parameters: + - id: route + type: ActivatedRouteSnapshot + description: '' + - id: state + type: RouterStateSnapshot + description: '' + return: + description: '' + type: Observable<any> + - name: canMatch() + uid: '@azure/msal-angular.MsalGuard.canMatch' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function canMatch(): Observable' + return: + description: '' + type: Observable<any> + - name: getDestinationUrl(string) + uid: '@azure/msal-angular.MsalGuard.getDestinationUrl' + package: '@azure/msal-angular' + summary: Builds the absolute url for the destination page + remarks: '' + isDeprecated: false + syntax: + content: 'function getDestinationUrl(path: string): string' + parameters: + - id: path + type: string + description: Relative path of requested page + return: + description: Full destination url + type: string + - name: includesCode(string) + uid: '@azure/msal-angular.MsalGuard.includesCode' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function includesCode(path: string): boolean' + parameters: + - id: path + type: string + description: '' + return: + description: '' + type: boolean + - name: parseUrl(string) + uid: '@azure/msal-angular.MsalGuard.parseUrl' + package: '@azure/msal-angular' + summary: Parses url string to UrlTree + remarks: '' + isDeprecated: false + syntax: + content: 'function parseUrl(url: string): UrlTree' + parameters: + - id: url + type: string + description: '' + return: + description: '' + type: UrlTree diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardAuthRequest.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardAuthRequest.yml new file mode 100644 index 0000000..031d3d9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardAuthRequest.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: MsalGuardAuthRequest +uid: '@azure/msal-angular.MsalGuardAuthRequest' +package: '@azure/msal-angular' +summary: '' +fullName: MsalGuardAuthRequest +remarks: '' +isDeprecated: false +syntax: | + type MsalGuardAuthRequest = + | Partial + | Partial> diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml new file mode 100644 index 0000000..0dbc490 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: MsalGuardConfiguration +uid: '@azure/msal-angular.MsalGuardConfiguration' +package: '@azure/msal-angular' +summary: '' +fullName: MsalGuardConfiguration +remarks: '' +isDeprecated: false +syntax: >- + type MsalGuardConfiguration = { authRequest?: MsalGuardAuthRequest | + (authService: MsalService, state: RouterStateSnapshot) => + MsalGuardAuthRequest, interactionType: InteractionType, loginFailedRoute?: + string } diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptor.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptor.yml new file mode 100644 index 0000000..c4759cf --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptor.yml @@ -0,0 +1,89 @@ +### YamlMime:TSType +name: MsalInterceptor +uid: '@azure/msal-angular.MsalInterceptor' +package: '@azure/msal-angular' +summary: '' +fullName: MsalInterceptor +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + MsalInterceptor(MsalInterceptorConfiguration, MsalService, Location, + MsalBroadcastService, any) + uid: '@azure/msal-angular.MsalInterceptor.constructor' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new MsalInterceptor(msalInterceptorConfig: MsalInterceptorConfiguration, + authService: MsalService, location: Location, msalBroadcastService: + MsalBroadcastService, document?: any) + parameters: + - id: msalInterceptorConfig + type: + description: '' + - id: authService + type: + description: '' + - id: location + type: Location + description: '' + - id: msalBroadcastService + type: + description: '' + - id: document + type: any + description: '' +properties: + - name: ɵfac + uid: '@azure/msal-angular.MsalInterceptor.ɵfac' + package: '@azure/msal-angular' + summary: '' + fullName: ɵfac + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵfac: ɵɵFactoryDeclaration' + return: + description: '' + type: >- + ɵɵFactoryDeclaration<, never> + - name: ɵprov + uid: '@azure/msal-angular.MsalInterceptor.ɵprov' + package: '@azure/msal-angular' + summary: '' + fullName: ɵprov + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵprov: ɵɵInjectableDeclaration' + return: + description: '' + type: >- + ɵɵInjectableDeclaration<> +methods: + - name: intercept(HttpRequest, HttpHandler) + uid: '@azure/msal-angular.MsalInterceptor.intercept' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function intercept(req: HttpRequest, next: HttpHandler): + Observable> + parameters: + - id: req + type: HttpRequest<any> + description: '' + - id: next + type: HttpHandler + description: '' + return: + description: '' + type: Observable<HttpEvent<any>> diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml new file mode 100644 index 0000000..8798d07 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: MsalInterceptorAuthRequest +uid: '@azure/msal-angular.MsalInterceptorAuthRequest' +package: '@azure/msal-angular' +summary: '' +fullName: MsalInterceptorAuthRequest +remarks: '' +isDeprecated: false +syntax: | + type MsalInterceptorAuthRequest = + | Omit + | Omit + | Omit diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml new file mode 100644 index 0000000..3759b74 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: MsalInterceptorConfiguration +uid: '@azure/msal-angular.MsalInterceptorConfiguration' +package: '@azure/msal-angular' +summary: '' +fullName: MsalInterceptorConfiguration +remarks: '' +isDeprecated: false +syntax: >- + type MsalInterceptorConfiguration = { authRequest?: MsalInterceptorAuthRequest + | (msalService: MsalService, req: HttpRequest, originalAuthRequest: + MsalInterceptorAuthRequest) => MsalInterceptorAuthRequest, interactionType: + InteractionType, protectedResourceMap: Map } diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalModule.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalModule.yml new file mode 100644 index 0000000..9159656 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalModule.yml @@ -0,0 +1,83 @@ +### YamlMime:TSType +name: MsalModule +uid: '@azure/msal-angular.MsalModule' +package: '@azure/msal-angular' +summary: '' +fullName: MsalModule +remarks: '' +isDeprecated: false +type: class +properties: + - name: ɵfac + uid: '@azure/msal-angular.MsalModule.ɵfac' + package: '@azure/msal-angular' + summary: '' + fullName: ɵfac + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵfac: ɵɵFactoryDeclaration' + return: + description: '' + type: >- + ɵɵFactoryDeclaration<, + never> + - name: ɵinj + uid: '@azure/msal-angular.MsalModule.ɵinj' + package: '@azure/msal-angular' + summary: '' + fullName: ɵinj + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵinj: ɵɵInjectorDeclaration' + return: + description: '' + type: >- + ɵɵInjectorDeclaration<> + - name: ɵmod + uid: '@azure/msal-angular.MsalModule.ɵmod' + package: '@azure/msal-angular' + summary: '' + fullName: ɵmod + remarks: '' + isDeprecated: false + syntax: + content: >- + static ɵmod: ɵɵNgModuleDeclaration + return: + description: '' + type: >- + ɵɵNgModuleDeclaration<, [typeof MsalRedirectComponent], [any], never> +methods: + - name: >- + forRoot(IPublicClientApplication, MsalGuardConfiguration, + MsalInterceptorConfiguration) + uid: '@azure/msal-angular.MsalModule.forRoot' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function forRoot(msalInstance: IPublicClientApplication, + guardConfig: MsalGuardConfiguration, interceptorConfig: + MsalInterceptorConfiguration): ModuleWithProviders + parameters: + - id: msalInstance + type: + description: '' + - id: guardConfig + type: + description: '' + - id: interceptorConfig + type: + description: '' + return: + description: '' + type: >- + ModuleWithProviders<> diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml new file mode 100644 index 0000000..7e4bffe --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: MsalRedirectComponent +uid: '@azure/msal-angular.MsalRedirectComponent' +package: '@azure/msal-angular' +summary: '' +fullName: MsalRedirectComponent +remarks: '' +isDeprecated: false +type: class +constructors: + - name: MsalRedirectComponent(MsalService) + uid: '@azure/msal-angular.MsalRedirectComponent.constructor' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new MsalRedirectComponent(authService: MsalService)' + parameters: + - id: authService + type: + description: '' +properties: + - name: ɵcmp + uid: '@azure/msal-angular.MsalRedirectComponent.ɵcmp' + package: '@azure/msal-angular' + summary: '' + fullName: ɵcmp + remarks: '' + isDeprecated: false + syntax: + content: >- + static ɵcmp: ɵɵComponentDeclaration + return: + description: '' + type: >- + ɵɵComponentDeclaration<, "app-redirect", + never, {}, {}, never, never, false, never> + - name: ɵfac + uid: '@azure/msal-angular.MsalRedirectComponent.ɵfac' + package: '@azure/msal-angular' + summary: '' + fullName: ɵfac + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵfac: ɵɵFactoryDeclaration' + return: + description: '' + type: >- + ɵɵFactoryDeclaration<, never> +methods: + - name: ngOnInit() + uid: '@azure/msal-angular.MsalRedirectComponent.ngOnInit' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function ngOnInit() diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml new file mode 100644 index 0000000..b60d243 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml @@ -0,0 +1,281 @@ +### YamlMime:TSType +name: MsalService +uid: '@azure/msal-angular.MsalService' +package: '@azure/msal-angular' +summary: '' +fullName: MsalService +remarks: '' +isDeprecated: false +type: class +constructors: + - name: MsalService(IPublicClientApplication, Location) + uid: '@azure/msal-angular.MsalService.constructor' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new MsalService(instance: IPublicClientApplication, location: Location)' + parameters: + - id: instance + type: + description: '' + - id: location + type: Location + description: '' +properties: + - name: instance + uid: '@azure/msal-angular.MsalService.instance' + package: '@azure/msal-angular' + summary: '' + fullName: instance + remarks: '' + isDeprecated: false + syntax: + content: 'instance: IPublicClientApplication' + return: + description: '' + type: + - name: ɵfac + uid: '@azure/msal-angular.MsalService.ɵfac' + package: '@azure/msal-angular' + summary: '' + fullName: ɵfac + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵfac: ɵɵFactoryDeclaration' + return: + description: '' + type: >- + ɵɵFactoryDeclaration<, never> + - name: ɵprov + uid: '@azure/msal-angular.MsalService.ɵprov' + package: '@azure/msal-angular' + summary: '' + fullName: ɵprov + remarks: '' + isDeprecated: false + syntax: + content: 'static ɵprov: ɵɵInjectableDeclaration' + return: + description: '' + type: >- + ɵɵInjectableDeclaration<> +methods: + - name: acquireTokenPopup(PopupRequest) + uid: '@azure/msal-angular.MsalService.acquireTokenPopup' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenPopup(request: PopupRequest): + Observable + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Observable<> + - name: acquireTokenRedirect(RedirectRequest) + uid: '@azure/msal-angular.MsalService.acquireTokenRedirect' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenRedirect(request: RedirectRequest): + Observable + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Observable<void> + - name: acquireTokenSilent(SilentRequest) + uid: '@azure/msal-angular.MsalService.acquireTokenSilent' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(silentRequest: SilentRequest): + Observable + parameters: + - id: silentRequest + type: + description: '' + return: + description: '' + type: >- + Observable<> + - name: getLogger() + uid: '@azure/msal-angular.MsalService.getLogger' + package: '@azure/msal-angular' + summary: >- + Gets logger for msal-angular. + + If no logger set, returns logger instance created with same options as + msal-browser + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + - name: handleRedirectObservable(string) + uid: '@azure/msal-angular.MsalService.handleRedirectObservable' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function handleRedirectObservable(hash?: string): + Observable + parameters: + - id: hash + type: string + description: '' + return: + description: '' + type: >- + Observable<> + - name: initialize() + uid: '@azure/msal-angular.MsalService.initialize' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(): Observable' + return: + description: '' + type: Observable<void> + - name: loginPopup(PopupRequest) + uid: '@azure/msal-angular.MsalService.loginPopup' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function loginPopup(request?: PopupRequest): + Observable + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Observable<> + - name: loginRedirect(RedirectRequest) + uid: '@azure/msal-angular.MsalService.loginRedirect' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function loginRedirect(request?: RedirectRequest): Observable' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Observable<void> + - name: logout(EndSessionRequest) + uid: '@azure/msal-angular.MsalService.logout' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function logout(logoutRequest?: EndSessionRequest): Observable' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Observable<void> + - name: logoutPopup(EndSessionPopupRequest) + uid: '@azure/msal-angular.MsalService.logoutPopup' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutPopup(logoutRequest?: EndSessionPopupRequest): + Observable + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Observable<void> + - name: logoutRedirect(EndSessionRequest) + uid: '@azure/msal-angular.MsalService.logoutRedirect' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutRedirect(logoutRequest?: EndSessionRequest): + Observable + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Observable<void> + - name: setLogger(Logger) + uid: '@azure/msal-angular.MsalService.setLogger' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: '' + - name: ssoSilent(SsoSilentRequest) + uid: '@azure/msal-angular.MsalService.ssoSilent' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function ssoSilent(request: SsoSilentRequest): + Observable + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Observable<> diff --git a/msal/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml b/msal/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml new file mode 100644 index 0000000..2de6b17 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ProtectedResourceScopes +uid: '@azure/msal-angular.ProtectedResourceScopes' +package: '@azure/msal-angular' +summary: '' +fullName: ProtectedResourceScopes +remarks: '' +isDeprecated: false +syntax: | + type ProtectedResourceScopes = { httpMethod: string; scopes: string[] | null } diff --git a/msal/docs-ref-autogen/@azure/msal-angular/index.yml b/msal/docs-ref-autogen/@azure/msal-angular/index.yml new file mode 100644 index 0000000..beea1d0 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-angular/index.yml @@ -0,0 +1,22 @@ +### YamlMime:TSPackage +uid: '@azure/msal-angular' +name: '@azure/msal-angular' +summary: '' +type: package +classes: + - '@azure/msal-angular.MsalBroadcastService' + - '@azure/msal-angular.MsalCustomNavigationClient' + - '@azure/msal-angular.MsalGuard' + - '@azure/msal-angular.MsalInterceptor' + - '@azure/msal-angular.MsalModule' + - '@azure/msal-angular.MsalRedirectComponent' + - '@azure/msal-angular.MsalService' +interfaces: + - '@azure/msal-angular.IMsalService' +typeAliases: + - '@azure/msal-angular.MsalBroadcastConfiguration' + - '@azure/msal-angular.MsalGuardAuthRequest' + - '@azure/msal-angular.MsalGuardConfiguration' + - '@azure/msal-angular.MsalInterceptorAuthRequest' + - '@azure/msal-angular.MsalInterceptorConfiguration' + - '@azure/msal-angular.ProtectedResourceScopes' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AccountInfo.yml b/msal/docs-ref-autogen/@azure/msal-browser/AccountInfo.yml new file mode 100644 index 0000000..7411412 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AccountInfo.yml @@ -0,0 +1,51 @@ +### YamlMime:TSTypeAlias +name: AccountInfo +uid: '@azure/msal-browser.AccountInfo' +package: '@azure/msal-browser' +summary: >- + Account object with the following signature: + + - homeAccountId - Home account identifier for this account object + + - environment - Entity which issued the token represented by the + domain of the issuer (e.g. login.microsoftonline.com) + + - tenantId - Full tenant or organizational id that this account + belongs to + + - 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 + + - idToken - raw ID token + + - idTokenClaims - Object contains claims from ID token + + - nativeAccountId - The user's native account ID + + - tenantProfiles - Map of tenant profile objects for each tenant that + the account has authenticated with in the browser +fullName: AccountInfo +remarks: '' +isDeprecated: false +syntax: | + type AccountInfo = { + authorityType?: string + environment: string + homeAccountId: string + idToken?: string + idTokenClaims?: TokenClaims & { + [key: string]: string | number | string[] | object | undefined | unknown + } + localAccountId: string + name?: string + nativeAccountId?: string + tenantId: string + tenantProfiles?: Map + username: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ApiId.yml b/msal/docs-ref-autogen/@azure/msal-browser/ApiId.yml new file mode 100644 index 0000000..c7b72bd --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ApiId.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ApiId +uid: '@azure/msal-browser.ApiId' +package: '@azure/msal-browser' +summary: '' +fullName: ApiId +remarks: '' +isDeprecated: false +syntax: | + type ApiId = (typeof ApiId)[keyof typeof ApiId] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthError.yml new file mode 100644 index 0000000..ef4be62 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthError.yml @@ -0,0 +1,181 @@ +### YamlMime:TSType +name: AuthError +uid: '@azure/msal-browser.AuthError' +package: '@azure/msal-browser' +summary: General error class thrown by the MSAL.js library. +fullName: AuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: AuthError(string, string, string) + uid: '@azure/msal-browser.AuthError.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new AuthError(errorCode?: string, errorMessage?: string, suberror?: + string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: suberror + type: string + description: '' +properties: + - name: correlationId + uid: '@azure/msal-browser.AuthError.correlationId' + package: '@azure/msal-browser' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + - name: errorCode + uid: '@azure/msal-browser.AuthError.errorCode' + package: '@azure/msal-browser' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + - name: errorMessage + uid: '@azure/msal-browser.AuthError.errorMessage' + package: '@azure/msal-browser' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + - name: subError + uid: '@azure/msal-browser.AuthError.subError' + package: '@azure/msal-browser' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string +inheritedProperties: + - name: message + uid: '@azure/msal-browser.AuthError.message' + package: '@azure/msal-browser' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.message + - name: name + uid: '@azure/msal-browser.AuthError.name' + package: '@azure/msal-browser' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: '@azure/msal-browser.AuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace + - name: stack + uid: '@azure/msal-browser.AuthError.stack' + package: '@azure/msal-browser' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: '@azure/msal-browser.AuthError.stackTraceLimit' + package: '@azure/msal-browser' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-browser.AuthError.captureStackTrace' + package: '@azure/msal-browser' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace +methods: + - name: setCorrelationId(string) + uid: '@azure/msal-browser.AuthError.setCorrelationId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' +extends: Error diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthErrorCodes.yml new file mode 100644 index 0000000..7d5d392 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-browser.AuthErrorCodes' +name: AuthErrorCodes +type: module +package: '@azure/msal-browser' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthenticationHeaderParser.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthenticationHeaderParser.yml new file mode 100644 index 0000000..5c1bdfc --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthenticationHeaderParser.yml @@ -0,0 +1,41 @@ +### YamlMime:TSType +name: AuthenticationHeaderParser +uid: '@azure/msal-browser.AuthenticationHeaderParser' +package: '@azure/msal-browser' +summary: >- + This is a helper class that parses supported HTTP response authentication + headers to extract and return + + header challenge values that can be used outside the basic authorization + flows. +fullName: AuthenticationHeaderParser +remarks: '' +isDeprecated: false +type: class +constructors: + - name: AuthenticationHeaderParser(Record) + uid: '@azure/msal-browser.AuthenticationHeaderParser.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new AuthenticationHeaderParser(headers: Record)' + parameters: + - id: headers + type: Record<string, string> + description: '' +methods: + - name: getShrNonce() + uid: '@azure/msal-browser.AuthenticationHeaderParser.getShrNonce' + package: '@azure/msal-browser' + summary: >- + This method parses the SHR nonce value out of either the + Authentication-Info or WWW-Authenticate authentication headers. + remarks: '' + isDeprecated: false + syntax: + content: 'function getShrNonce(): string' + return: + description: '' + type: string diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthenticationResult.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthenticationResult.yml new file mode 100644 index 0000000..10ed1ea --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthenticationResult.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: AuthenticationResult +uid: '@azure/msal-browser.AuthenticationResult' +package: '@azure/msal-browser' +summary: '' +fullName: AuthenticationResult +remarks: '' +isDeprecated: false +syntax: | + type AuthenticationResult = CommonAuthenticationResult & { + account: AccountInfo + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthenticationScheme.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthenticationScheme.yml new file mode 100644 index 0000000..a0bac49 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthenticationScheme.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: AuthenticationScheme +uid: '@azure/msal-browser.AuthenticationScheme' +package: '@azure/msal-browser' +summary: '' +fullName: AuthenticationScheme +remarks: '' +isDeprecated: false +syntax: | + type AuthenticationScheme = + (typeof AuthenticationScheme)[keyof typeof AuthenticationScheme] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationCodeRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationCodeRequest.yml new file mode 100644 index 0000000..0e68dcf --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationCodeRequest.yml @@ -0,0 +1,21 @@ +### YamlMime:TSTypeAlias +name: AuthorizationCodeRequest +uid: '@azure/msal-browser.AuthorizationCodeRequest' +package: '@azure/msal-browser' +summary: '' +fullName: AuthorizationCodeRequest +remarks: '' +isDeprecated: false +syntax: | + type AuthorizationCodeRequest = Partial< + Omit< + CommonAuthorizationCodeRequest, + "code" | "enableSpaAuthorizationCode" | "requestedClaimsHash" + > + > & { + cloudGraphHostName?: string + cloudInstanceHostName?: string + code?: string + msGraphHost?: string + nativeAccountId?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml new file mode 100644 index 0000000..56c8c90 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: AuthorizationUrlRequest +uid: '@azure/msal-browser.AuthorizationUrlRequest' +package: '@azure/msal-browser' +summary: This type is deprecated and will be removed on the next major version update +fullName: AuthorizationUrlRequest +remarks: '' +isDeprecated: false +syntax: | + type AuthorizationUrlRequest = Omit< + CommonAuthorizationUrlRequest, + "state" | "nonce" | "requestedClaimsHash" | "nativeBroker" + > & { nonce: string; state: string } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AzureCloudInstance.yml b/msal/docs-ref-autogen/@azure/msal-browser/AzureCloudInstance.yml new file mode 100644 index 0000000..486187b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AzureCloudInstance.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: AzureCloudInstance +uid: '@azure/msal-browser.AzureCloudInstance' +package: '@azure/msal-browser' +summary: '' +fullName: AzureCloudInstance +remarks: '' +isDeprecated: false +syntax: | + type AzureCloudInstance = + (typeof AzureCloudInstance)[keyof typeof AzureCloudInstance] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AzureCloudOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/AzureCloudOptions.yml new file mode 100644 index 0000000..523d548 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/AzureCloudOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: AzureCloudOptions +uid: '@azure/msal-browser.AzureCloudOptions' +package: '@azure/msal-browser' +summary: >- + AzureCloudInstance specific options + + + - azureCloudInstance - string enum providing short notation for + soverign and public cloud authorities + + - tenant - provision to provide the tenant info +fullName: AzureCloudOptions +remarks: '' +isDeprecated: false +syntax: | + type AzureCloudOptions = { + azureCloudInstance: AzureCloudInstance + tenant?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml new file mode 100644 index 0000000..5eb4920 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml @@ -0,0 +1,198 @@ +### YamlMime:TSType +name: BrowserAuthError +uid: '@azure/msal-browser.BrowserAuthError' +package: '@azure/msal-browser' +summary: Browser library error class thrown by the MSAL.js library for SPAs +fullName: BrowserAuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: BrowserAuthError(string) + uid: '@azure/msal-browser.BrowserAuthError.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new BrowserAuthError(errorCode: string)' + parameters: + - id: errorCode + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-browser.BrowserAuthError.correlationId' + package: '@azure/msal-browser' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-browser.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-browser.BrowserAuthError.errorCode' + package: '@azure/msal-browser' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-browser.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-browser.BrowserAuthError.errorMessage' + package: '@azure/msal-browser' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-browser.AuthError.errorMessage) + - name: message + uid: '@azure/msal-browser.BrowserAuthError.message' + package: '@azure/msal-browser' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-browser.AuthError.message) + - name: name + uid: '@azure/msal-browser.BrowserAuthError.name' + package: '@azure/msal-browser' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-browser.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-browser.BrowserAuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-browser.BrowserAuthError.stack' + package: '@azure/msal-browser' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-browser.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-browser.BrowserAuthError.stackTraceLimit' + package: '@azure/msal-browser' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-browser.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-browser.BrowserAuthError.subError' + package: '@azure/msal-browser' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-browser.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-browser.BrowserAuthError.captureStackTrace' + package: '@azure/msal-browser' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-browser.BrowserAuthError.setCorrelationId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-browser.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthErrorCodes.yml new file mode 100644 index 0000000..917ec8b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-browser.BrowserAuthErrorCodes' +name: BrowserAuthErrorCodes +type: module +package: '@azure/msal-browser' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml new file mode 100644 index 0000000..5efd561 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml @@ -0,0 +1,25 @@ +### YamlMime:TSTypeAlias +name: BrowserAuthOptions +uid: '@azure/msal-browser.BrowserAuthOptions' +package: '@azure/msal-browser' +summary: Use this to configure the auth options in the Configuration object +fullName: BrowserAuthOptions +remarks: '' +isDeprecated: false +syntax: | + type BrowserAuthOptions = { + OIDCOptions?: OIDCOptions + authority?: string + authorityMetadata?: string + azureCloudOptions?: AzureCloudOptions + clientCapabilities?: string[] + clientId: string + cloudDiscoveryMetadata?: string + knownAuthorities?: string[] + navigateToLoginRequestUrl?: boolean + postLogoutRedirectUri?: string | null + protocolMode?: ProtocolMode + redirectUri?: string + skipAuthorityMetadataCache?: boolean + supportsNestedAppAuth?: boolean + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml new file mode 100644 index 0000000..0370532 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: BrowserCacheLocation +uid: '@azure/msal-browser.BrowserCacheLocation' +package: '@azure/msal-browser' +summary: '' +fullName: BrowserCacheLocation +remarks: '' +isDeprecated: false +syntax: | + type BrowserCacheLocation = + (typeof BrowserCacheLocation)[keyof typeof BrowserCacheLocation] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml new file mode 100644 index 0000000..d75f427 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml @@ -0,0 +1,203 @@ +### YamlMime:TSType +name: BrowserConfigurationAuthError +uid: '@azure/msal-browser.BrowserConfigurationAuthError' +package: '@azure/msal-browser' +summary: Browser library error class thrown by the MSAL.js library for SPAs +fullName: BrowserConfigurationAuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: BrowserConfigurationAuthError(string, string) + uid: '@azure/msal-browser.BrowserConfigurationAuthError.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new BrowserConfigurationAuthError(errorCode: string, errorMessage?: + string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-browser.BrowserConfigurationAuthError.correlationId' + package: '@azure/msal-browser' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-browser.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-browser.BrowserConfigurationAuthError.errorCode' + package: '@azure/msal-browser' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-browser.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-browser.BrowserConfigurationAuthError.errorMessage' + package: '@azure/msal-browser' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-browser.AuthError.errorMessage) + - name: message + uid: '@azure/msal-browser.BrowserConfigurationAuthError.message' + package: '@azure/msal-browser' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-browser.AuthError.message) + - name: name + uid: '@azure/msal-browser.BrowserConfigurationAuthError.name' + package: '@azure/msal-browser' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-browser.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-browser.BrowserConfigurationAuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-browser.BrowserConfigurationAuthError.stack' + package: '@azure/msal-browser' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-browser.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-browser.BrowserConfigurationAuthError.stackTraceLimit' + package: '@azure/msal-browser' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-browser.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-browser.BrowserConfigurationAuthError.subError' + package: '@azure/msal-browser' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-browser.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-browser.BrowserConfigurationAuthError.captureStackTrace' + package: '@azure/msal-browser' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-browser.BrowserConfigurationAuthError.setCorrelationId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-browser.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthErrorCodes.yml new file mode 100644 index 0000000..98b6e29 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-browser.BrowserConfigurationAuthErrorCodes' +name: BrowserConfigurationAuthErrorCodes +type: module +package: '@azure/msal-browser' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml new file mode 100644 index 0000000..018ac52 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml @@ -0,0 +1,311 @@ +### YamlMime:TSType +name: BrowserPerformanceClient +uid: '@azure/msal-browser.BrowserPerformanceClient' +package: '@azure/msal-browser' +summary: '' +fullName: BrowserPerformanceClient +remarks: '' +isDeprecated: false +type: class +constructors: + - name: BrowserPerformanceClient(Configuration, Set, Map) + uid: '@azure/msal-browser.BrowserPerformanceClient.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new BrowserPerformanceClient(configuration: Configuration, intFields?: + Set, abbreviations?: Map) + parameters: + - id: configuration + type: + description: '' + - id: intFields + type: Set<string> + description: '' + - id: abbreviations + type: Map<string, string> + description: '' +inheritedMethods: + - name: 'addFields({[key: string]: {} | undefined}, string)' + uid: '@azure/msal-browser.BrowserPerformanceClient.addFields' + package: '@azure/msal-browser' + summary: Saves extra information to be emitted when the measurements are flushed + remarks: '' + isDeprecated: false + syntax: + content: >- + function addFields(fields: {[key: string]: {} | undefined}, + correlationId: string) + parameters: + - id: fields + type: '{[key: string]: {} | undefined}' + description: '' + - id: correlationId + type: string + description: '' + inheritanceDescription: Inherited From PerformanceClient.addFields + - name: addPerformanceCallback(PerformanceCallbackFunction) + uid: '@azure/msal-browser.BrowserPerformanceClient.addPerformanceCallback' + package: '@azure/msal-browser' + summary: Registers a callback function to receive performance events. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addPerformanceCallback(callback: PerformanceCallbackFunction): + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From PerformanceClient.addPerformanceCallback + - name: calculateQueuedTime(number, number) + uid: '@azure/msal-browser.BrowserPerformanceClient.calculateQueuedTime' + package: '@azure/msal-browser' + summary: >- + Calculates the difference between current time and time when function was + queued. + + Note: It is possible to have 0 as the queue time if the current time and + the queued time was the same. + remarks: '' + isDeprecated: false + syntax: + content: >- + function calculateQueuedTime(preQueueTime: number, currentTime: number): + number + parameters: + - id: preQueueTime + type: number + description: '' + - id: currentTime + type: number + description: '' + return: + description: '' + type: number + inheritanceDescription: Inherited From PerformanceClient.calculateQueuedTime + - name: discardMeasurements(string) + uid: '@azure/msal-browser.BrowserPerformanceClient.discardMeasurements' + package: '@azure/msal-browser' + summary: Removes measurements for a given correlation id. + remarks: '' + isDeprecated: false + syntax: + content: 'function discardMeasurements(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: Inherited From PerformanceClient.discardMeasurements + - name: emitEvents(PerformanceEvent[], string) + uid: '@azure/msal-browser.BrowserPerformanceClient.emitEvents' + package: '@azure/msal-browser' + summary: Emits events to all registered callbacks. + remarks: '' + isDeprecated: false + syntax: + content: 'function emitEvents(events: PerformanceEvent[], correlationId?: string)' + parameters: + - id: events + type: [] + description: '' + - id: correlationId + type: string + description: '' + inheritanceDescription: Inherited From PerformanceClient.emitEvents + - name: endMeasurement(PerformanceEvent, unknown) + uid: '@azure/msal-browser.BrowserPerformanceClient.endMeasurement' + package: '@azure/msal-browser' + summary: >- + Stops measuring the performance for an operation. Should only be called + directly by PerformanceClient classes, + + as consumers should instead use the function returned by startMeasurement. + + Adds a new field named as "[event name]DurationMs" for sub-measurements, + completes and emits an event + + otherwise. + remarks: '' + isDeprecated: false + syntax: + content: >- + function endMeasurement(event: PerformanceEvent, error?: unknown): null + | PerformanceEvent + parameters: + - id: event + type: + description: '' + - id: error + type: unknown + description: '' + return: + description: '' + type: null | + inheritanceDescription: Inherited From PerformanceClient.endMeasurement + - name: getPreQueueTime(string, string) + uid: '@azure/msal-browser.BrowserPerformanceClient.getPreQueueTime' + package: '@azure/msal-browser' + summary: Gets map of pre-queue times by correlation Id + remarks: '' + isDeprecated: false + syntax: + content: >- + function getPreQueueTime(eventName: string, correlationId: string): + number | void + parameters: + - id: eventName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: number | void + inheritanceDescription: Inherited From PerformanceClient.getPreQueueTime + - name: 'incrementFields({[key: string]: number | undefined}, string)' + uid: '@azure/msal-browser.BrowserPerformanceClient.incrementFields' + package: '@azure/msal-browser' + summary: Increment counters to be emitted when the measurements are flushed + remarks: '' + isDeprecated: false + syntax: + content: >- + function incrementFields(fields: {[key: string]: number | undefined}, + correlationId: string) + parameters: + - id: fields + type: '{[key: string]: number | undefined}' + description: '{string[]}' + - id: correlationId + type: string + description: '{string} correlation identifier' + inheritanceDescription: Inherited From PerformanceClient.incrementFields + - name: removePerformanceCallback(string) + uid: '@azure/msal-browser.BrowserPerformanceClient.removePerformanceCallback' + package: '@azure/msal-browser' + summary: Removes a callback registered with addPerformanceCallback. + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(callbackId: string): boolean' + parameters: + - id: callbackId + type: string + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From PerformanceClient.removePerformanceCallback + - name: startPerformanceMeasurement(string, string) + uid: '@azure/msal-browser.BrowserPerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-browser' + summary: >- + Starts and returns an platform-specific implementation of + IPerformanceMeasurement. + + Note: this function can be changed to abstract at the next major version + bump. + remarks: '' + isDeprecated: true + customDeprecatedMessage: This method will be removed in the next major version + syntax: + content: >- + function startPerformanceMeasurement(measureName: string, correlationId: + string): IPerformanceMeasurement + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: + inheritanceDescription: Inherited From PerformanceClient.startPerformanceMeasurement +methods: + - name: addQueueMeasurement(string, string, number, boolean) + uid: '@azure/msal-browser.BrowserPerformanceClient.addQueueMeasurement' + package: '@azure/msal-browser' + summary: Calculates and adds queue time measurement for given performance event. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addQueueMeasurement(eventName: string, correlationId?: string, + queueTime?: number, manuallyCompleted?: boolean) + parameters: + - id: eventName + type: string + description: '' + - id: correlationId + type: string + description: '' + - id: queueTime + type: number + description: '' + - id: manuallyCompleted + type: boolean + description: indicator for manually completed queue measurements + - name: generateId() + uid: '@azure/msal-browser.BrowserPerformanceClient.generateId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function generateId(): string' + return: + description: '' + type: string + - name: setPreQueueTime(PerformanceEvents, string) + uid: '@azure/msal-browser.BrowserPerformanceClient.setPreQueueTime' + package: '@azure/msal-browser' + summary: Adds pre-queue time to preQueueTimeByCorrelationId map. + remarks: '' + isDeprecated: false + syntax: + content: >- + function setPreQueueTime(eventName: PerformanceEvents, correlationId?: + string) + parameters: + - id: eventName + type: + description: '' + - id: correlationId + type: string + description: '' + - name: startMeasurement(string, string) + uid: '@azure/msal-browser.BrowserPerformanceClient.startMeasurement' + package: '@azure/msal-browser' + summary: >- + Starts measuring performance for a given operation. Returns a function + that should be used to end the measurement. + + Also captures browser page visibilityState. + remarks: '' + isDeprecated: false + syntax: + content: >- + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml new file mode 100644 index 0000000..8d85736 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: BrowserPerformanceMeasurement +uid: '@azure/msal-browser.BrowserPerformanceMeasurement' +package: '@azure/msal-browser' +summary: '' +fullName: BrowserPerformanceMeasurement +remarks: '' +isDeprecated: false +type: class +constructors: + - name: BrowserPerformanceMeasurement(string, string) + uid: '@azure/msal-browser.BrowserPerformanceMeasurement.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new BrowserPerformanceMeasurement(name: string, correlationId: string)' + parameters: + - id: name + type: string + description: '' + - id: correlationId + type: string + description: '' +methods: + - name: endMeasurement() + uid: '@azure/msal-browser.BrowserPerformanceMeasurement.endMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function endMeasurement() + - name: flushMeasurement() + uid: '@azure/msal-browser.BrowserPerformanceMeasurement.flushMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function flushMeasurement(): null | number' + return: + description: '' + type: null | number + - name: flushMeasurements(string, SubMeasurement[]) + uid: '@azure/msal-browser.BrowserPerformanceMeasurement.flushMeasurements' + package: '@azure/msal-browser' + summary: Flush browser marks and measurements. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function flushMeasurements(correlationId: string, measurements: + SubMeasurement[]) + parameters: + - id: correlationId + type: string + description: '' + - id: measurements + type: [] + description: '' + - name: startMeasurement() + uid: '@azure/msal-browser.BrowserPerformanceMeasurement.startMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function startMeasurement() + - name: supportsBrowserPerformance() + uid: >- + @azure/msal-browser.BrowserPerformanceMeasurement.supportsBrowserPerformance + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function supportsBrowserPerformance(): boolean' + return: + description: '' + type: boolean diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml new file mode 100644 index 0000000..4f3ea26 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml @@ -0,0 +1,91 @@ +### YamlMime:TSType +name: BrowserStorage +uid: '@azure/msal-browser.BrowserStorage' +package: '@azure/msal-browser' +summary: '' +fullName: BrowserStorage +remarks: '' +isDeprecated: false +type: class +constructors: + - name: BrowserStorage(string) + uid: '@azure/msal-browser.BrowserStorage.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new BrowserStorage(cacheLocation: string)' + parameters: + - id: cacheLocation + type: string + description: '' +methods: + - name: containsKey(string) + uid: '@azure/msal-browser.BrowserStorage.containsKey' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function containsKey(key: string): boolean' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: boolean + - name: getItem(string) + uid: '@azure/msal-browser.BrowserStorage.getItem' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getItem(key: string): null | string' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: null | string + - name: getKeys() + uid: '@azure/msal-browser.BrowserStorage.getKeys' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getKeys(): string[]' + return: + description: '' + type: string[] + - name: removeItem(string) + uid: '@azure/msal-browser.BrowserStorage.removeItem' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeItem(key: string)' + parameters: + - id: key + type: string + description: '' + - name: setItem(string, string) + uid: '@azure/msal-browser.BrowserStorage.setItem' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setItem(key: string, value: string)' + parameters: + - id: key + type: string + description: '' + - id: value + type: string + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml new file mode 100644 index 0000000..1a9c94b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml @@ -0,0 +1,24 @@ +### YamlMime:TSTypeAlias +name: BrowserSystemOptions +uid: '@azure/msal-browser.BrowserSystemOptions' +package: '@azure/msal-browser' +summary: '' +fullName: BrowserSystemOptions +remarks: '' +isDeprecated: false +syntax: | + type BrowserSystemOptions = SystemOptions & { + allowNativeBroker?: boolean + allowRedirectInIframe?: boolean + asyncPopups?: boolean + iframeHashTimeout?: number + loadFrameTimeout?: number + loggerOptions?: LoggerOptions + nativeBrokerHandshakeTimeout?: number + navigateFrameWait?: number + navigationClient?: INavigationClient + networkClient?: INetworkModule + pollIntervalMilliseconds?: number + redirectNavigationTimeout?: number + windowHashTimeout?: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml new file mode 100644 index 0000000..c15135a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: BrowserTelemetryOptions +uid: '@azure/msal-browser.BrowserTelemetryOptions' +package: '@azure/msal-browser' +summary: Telemetry Options +fullName: BrowserTelemetryOptions +remarks: '' +isDeprecated: false +syntax: | + type BrowserTelemetryOptions = { + application?: ApplicationTelemetry + client?: IPerformanceClient + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml new file mode 100644 index 0000000..3780403 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml @@ -0,0 +1,181 @@ +### YamlMime:TSPackage +uid: '@azure/msal-browser.BrowserUtils' +name: BrowserUtils +type: module +package: '@azure/msal-browser' +summary: '' +functions: + - name: blockAcquireTokenInPopups() + uid: '@azure/msal-browser.BrowserUtils.blockAcquireTokenInPopups' + package: '@azure/msal-browser' + summary: Block redirectUri loaded in popup from calling AcquireToken APIs + remarks: '' + isDeprecated: false + syntax: + content: function blockAcquireTokenInPopups() + - name: blockAPICallsBeforeInitialize(boolean) + uid: '@azure/msal-browser.BrowserUtils.blockAPICallsBeforeInitialize' + package: '@azure/msal-browser' + summary: Throws error if initialize hasn't been called + remarks: '' + isDeprecated: false + syntax: + content: 'function blockAPICallsBeforeInitialize(initialized: boolean)' + parameters: + - id: initialized + type: boolean + description: '' + - name: blockNonBrowserEnvironment() + uid: '@azure/msal-browser.BrowserUtils.blockNonBrowserEnvironment' + package: '@azure/msal-browser' + summary: Throws error if token requests are made in non-browser environment + remarks: '' + isDeprecated: false + syntax: + content: function blockNonBrowserEnvironment() + - name: blockRedirectInIframe(boolean) + uid: '@azure/msal-browser.BrowserUtils.blockRedirectInIframe' + package: '@azure/msal-browser' + summary: Block redirect operations in iframes unless explicitly allowed + remarks: '' + isDeprecated: false + syntax: + content: 'function blockRedirectInIframe(allowRedirectInIframe: boolean)' + parameters: + - id: allowRedirectInIframe + type: boolean + description: Config value to allow redirects when app is inside an iframe + - name: blockReloadInHiddenIframes() + uid: '@azure/msal-browser.BrowserUtils.blockReloadInHiddenIframes' + package: '@azure/msal-browser' + summary: |- + Throws error if we have completed an auth and are + attempting another auth request inside an iframe. + remarks: '' + isDeprecated: false + syntax: + content: function blockReloadInHiddenIframes() + - name: clearHash(Window) + uid: '@azure/msal-browser.BrowserUtils.clearHash' + package: '@azure/msal-browser' + summary: Clears hash from window url. + remarks: '' + isDeprecated: false + syntax: + content: 'function clearHash(contentWindow: Window)' + parameters: + - id: contentWindow + type: Window + description: '' + - name: createGuid() + uid: '@azure/msal-browser.BrowserUtils.createGuid' + package: '@azure/msal-browser' + summary: Wrapper function that creates a UUID v7 from the current timestamp. + remarks: '' + isDeprecated: false + syntax: + content: 'function createGuid(): string' + return: + description: '' + type: string + - name: getCurrentUri() + uid: '@azure/msal-browser.BrowserUtils.getCurrentUri' + package: '@azure/msal-browser' + summary: Returns current window URL as redirect uri + remarks: '' + isDeprecated: false + syntax: + content: 'function getCurrentUri(): string' + return: + description: '' + type: string + - name: getHomepage() + uid: '@azure/msal-browser.BrowserUtils.getHomepage' + package: '@azure/msal-browser' + summary: Gets the homepage url for the current window location. + remarks: '' + isDeprecated: false + syntax: + content: 'function getHomepage(): string' + return: + description: '' + type: string + - name: isInIframe() + uid: '@azure/msal-browser.BrowserUtils.isInIframe' + package: '@azure/msal-browser' + summary: Returns boolean of whether the current window is in an iframe or not. + remarks: '' + isDeprecated: false + syntax: + content: 'function isInIframe(): boolean' + return: + description: '' + type: boolean + - name: isInPopup() + uid: '@azure/msal-browser.BrowserUtils.isInPopup' + package: '@azure/msal-browser' + summary: >- + Returns boolean of whether or not the current window is a popup opened by + msal + remarks: '' + isDeprecated: false + syntax: + content: 'function isInPopup(): boolean' + return: + description: '' + type: boolean + - name: preconnect(string) + uid: '@azure/msal-browser.BrowserUtils.preconnect' + package: '@azure/msal-browser' + summary: >- + Adds a preconnect link element to the header which begins DNS resolution + and SSL connection in anticipation of the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function preconnect(authority: string)' + parameters: + - id: authority + type: string + description: '' + - name: preflightCheck(boolean) + uid: '@azure/msal-browser.BrowserUtils.preflightCheck' + package: '@azure/msal-browser' + summary: Helper to validate app environment before making an auth request + remarks: '' + isDeprecated: false + syntax: + content: 'function preflightCheck(initialized: boolean)' + parameters: + - id: initialized + type: boolean + description: '' + - name: redirectPreflightCheck(boolean, BrowserConfiguration) + uid: '@azure/msal-browser.BrowserUtils.redirectPreflightCheck' + package: '@azure/msal-browser' + summary: Helper to validate app enviornment before making redirect request + remarks: '' + isDeprecated: false + syntax: + content: >- + function redirectPreflightCheck(initialized: boolean, config: + BrowserConfiguration) + parameters: + - id: initialized + type: boolean + description: '' + - id: config + type: BrowserConfiguration + description: '' + - name: replaceHash(string) + uid: '@azure/msal-browser.BrowserUtils.replaceHash' + package: '@azure/msal-browser' + summary: Replaces current hash with hash from provided url + remarks: '' + isDeprecated: false + syntax: + content: 'function replaceHash(url: string)' + parameters: + - id: url + type: string + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml b/msal/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml new file mode 100644 index 0000000..c18d2a1 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: CacheLookupPolicy +uid: '@azure/msal-browser.CacheLookupPolicy' +package: '@azure/msal-browser' +summary: '' +fullName: CacheLookupPolicy +remarks: '' +isDeprecated: false +syntax: | + type CacheLookupPolicy = + (typeof CacheLookupPolicy)[keyof typeof CacheLookupPolicy] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml new file mode 100644 index 0000000..f4c5863 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: CacheOptions +uid: '@azure/msal-browser.CacheOptions' +package: '@azure/msal-browser' +summary: 'Use this to configure the below cache configuration options:' +fullName: CacheOptions +remarks: '' +isDeprecated: false +syntax: | + type CacheOptions = { + cacheLocation?: BrowserCacheLocation | string + cacheMigrationEnabled?: boolean + claimsBasedCachingEnabled?: boolean + secureCookies?: boolean + storeAuthStateInCookie?: boolean + temporaryCacheLocation?: BrowserCacheLocation | string + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ClearCacheRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/ClearCacheRequest.yml new file mode 100644 index 0000000..ece30e7 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ClearCacheRequest.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: ClearCacheRequest +uid: '@azure/msal-browser.ClearCacheRequest' +package: '@azure/msal-browser' +summary: >- + ClearCacheRequest + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - account - Account object that will be logged out of. All + tokens tied to this account will be cleared. +fullName: ClearCacheRequest +remarks: '' +isDeprecated: false +syntax: | + type ClearCacheRequest = { + account?: AccountInfo | null + correlationId?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthError.yml new file mode 100644 index 0000000..838de04 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthError.yml @@ -0,0 +1,201 @@ +### YamlMime:TSType +name: ClientAuthError +uid: '@azure/msal-browser.ClientAuthError' +package: '@azure/msal-browser' +summary: Error thrown when there is an error in the client code running on the browser. +fullName: ClientAuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ClientAuthError(string, string) + uid: '@azure/msal-browser.ClientAuthError.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ClientAuthError(errorCode: string, additionalMessage?: string)' + parameters: + - id: errorCode + type: string + description: '' + - id: additionalMessage + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-browser.ClientAuthError.correlationId' + package: '@azure/msal-browser' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-browser.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-browser.ClientAuthError.errorCode' + package: '@azure/msal-browser' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-browser.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-browser.ClientAuthError.errorMessage' + package: '@azure/msal-browser' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-browser.AuthError.errorMessage) + - name: message + uid: '@azure/msal-browser.ClientAuthError.message' + package: '@azure/msal-browser' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-browser.AuthError.message) + - name: name + uid: '@azure/msal-browser.ClientAuthError.name' + package: '@azure/msal-browser' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-browser.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-browser.ClientAuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-browser.ClientAuthError.stack' + package: '@azure/msal-browser' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-browser.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-browser.ClientAuthError.stackTraceLimit' + package: '@azure/msal-browser' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-browser.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-browser.ClientAuthError.subError' + package: '@azure/msal-browser' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-browser.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-browser.ClientAuthError.captureStackTrace' + package: '@azure/msal-browser' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-browser.ClientAuthError.setCorrelationId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-browser.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthErrorCodes.yml new file mode 100644 index 0000000..a313578 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-browser.ClientAuthErrorCodes' +name: ClientAuthErrorCodes +type: module +package: '@azure/msal-browser' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationError.yml b/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationError.yml new file mode 100644 index 0000000..2b67c8c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationError.yml @@ -0,0 +1,198 @@ +### YamlMime:TSType +name: ClientConfigurationError +uid: '@azure/msal-browser.ClientConfigurationError' +package: '@azure/msal-browser' +summary: Error thrown when there is an error in configuration of the MSAL.js library. +fullName: ClientConfigurationError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ClientConfigurationError(string) + uid: '@azure/msal-browser.ClientConfigurationError.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ClientConfigurationError(errorCode: string)' + parameters: + - id: errorCode + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-browser.ClientConfigurationError.correlationId' + package: '@azure/msal-browser' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-browser.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-browser.ClientConfigurationError.errorCode' + package: '@azure/msal-browser' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-browser.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-browser.ClientConfigurationError.errorMessage' + package: '@azure/msal-browser' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-browser.AuthError.errorMessage) + - name: message + uid: '@azure/msal-browser.ClientConfigurationError.message' + package: '@azure/msal-browser' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-browser.AuthError.message) + - name: name + uid: '@azure/msal-browser.ClientConfigurationError.name' + package: '@azure/msal-browser' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-browser.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-browser.ClientConfigurationError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-browser.ClientConfigurationError.stack' + package: '@azure/msal-browser' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-browser.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-browser.ClientConfigurationError.stackTraceLimit' + package: '@azure/msal-browser' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-browser.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-browser.ClientConfigurationError.subError' + package: '@azure/msal-browser' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-browser.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-browser.ClientConfigurationError.captureStackTrace' + package: '@azure/msal-browser' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-browser.ClientConfigurationError.setCorrelationId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-browser.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationErrorCodes.yml new file mode 100644 index 0000000..81dc674 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-browser.ClientConfigurationErrorCodes' +name: ClientConfigurationErrorCodes +type: module +package: '@azure/msal-browser' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/Configuration.yml b/msal/docs-ref-autogen/@azure/msal-browser/Configuration.yml new file mode 100644 index 0000000..059fed4 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/Configuration.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: Configuration +uid: '@azure/msal-browser.Configuration' +package: '@azure/msal-browser' +summary: >- + This object allows you to configure important elements of MSAL functionality + and is passed into the constructor of PublicClientApplication +fullName: Configuration +remarks: '' +isDeprecated: false +syntax: | + type Configuration = { + auth: BrowserAuthOptions + cache?: CacheOptions + system?: BrowserSystemOptions + telemetry?: BrowserTelemetryOptions + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml new file mode 100644 index 0000000..ca5a0da --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml @@ -0,0 +1,40 @@ +### YamlMime:TSTypeAlias +name: EndSessionPopupRequest +uid: '@azure/msal-browser.EndSessionPopupRequest' +package: '@azure/msal-browser' +summary: >- + EndSessionPopupRequest + + - 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 inside the + popup. Required to ensure popup can be closed. + + - 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 + + - mainWindowRedirectUri - URI to navigate the main window to after logout is + complete + + - popupWindowAttributes - Optional popup window attributes. popupSize with + height and width, and popupPosition with top and left can be set. + + - logoutHint - A string that specifies the account that is being + logged out in order to skip the server account picker on logout +fullName: EndSessionPopupRequest +remarks: '' +isDeprecated: false +syntax: | + type EndSessionPopupRequest = Partial< + Omit + > & { + authority?: string + mainWindowRedirectUri?: string + popupWindowAttributes?: PopupWindowAttributes + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml new file mode 100644 index 0000000..1d8283a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml @@ -0,0 +1,33 @@ +### YamlMime:TSTypeAlias +name: EndSessionRequest +uid: '@azure/msal-browser.EndSessionRequest' +package: '@azure/msal-browser' +summary: >- + 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 + + - onRedirectNavigate - Callback that will be passed the url that MSAL will + navigate to. Returning false in the callback will stop navigation. + + - logoutHint - A string that specifies the account that is being + logged out in order to skip the server account picker on logout +fullName: EndSessionRequest +remarks: '' +isDeprecated: false +syntax: > + type EndSessionRequest = Partial< + Omit + > & { authority?: string; onRedirectNavigate?: (url: string) => boolean | void + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml new file mode 100644 index 0000000..43067a3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: EventCallbackFunction +uid: '@azure/msal-browser.EventCallbackFunction' +package: '@azure/msal-browser' +summary: '' +fullName: EventCallbackFunction +remarks: '' +isDeprecated: false +syntax: | + type EventCallbackFunction = (message: EventMessage) => void diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventError.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventError.yml new file mode 100644 index 0000000..97b16ca --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventError.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: EventError +uid: '@azure/msal-browser.EventError' +package: '@azure/msal-browser' +summary: '' +fullName: EventError +remarks: '' +isDeprecated: false +syntax: | + type EventError = AuthError | Error | null diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml new file mode 100644 index 0000000..4d17ab8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: EventMessage +uid: '@azure/msal-browser.EventMessage' +package: '@azure/msal-browser' +summary: '' +fullName: EventMessage +remarks: '' +isDeprecated: false +syntax: | + type EventMessage = { + error: EventError + eventType: EventType + interactionType: InteractionType | null + payload: EventPayload + timestamp: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml new file mode 100644 index 0000000..8bfd1be --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: EventMessageUtils +uid: '@azure/msal-browser.EventMessageUtils' +package: '@azure/msal-browser' +summary: '' +fullName: EventMessageUtils +remarks: '' +isDeprecated: false +type: class +methods: + - name: getInteractionStatusFromEvent(EventMessage, InteractionStatus) + uid: '@azure/msal-browser.EventMessageUtils.getInteractionStatusFromEvent' + package: '@azure/msal-browser' + summary: Gets interaction status from event message + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getInteractionStatusFromEvent(message: EventMessage, + currentStatus?: InteractionStatus): null | InteractionStatus + parameters: + - id: message + type: + description: '' + - id: currentStatus + type: InteractionStatus + description: '' + return: + description: '' + type: null | InteractionStatus diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventPayload.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventPayload.yml new file mode 100644 index 0000000..de8c150 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventPayload.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: EventPayload +uid: '@azure/msal-browser.EventPayload' +package: '@azure/msal-browser' +summary: '' +fullName: EventPayload +remarks: '' +isDeprecated: false +syntax: | + type EventPayload = + | AccountInfo + | PopupRequest + | RedirectRequest + | SilentRequest + | SsoSilentRequest + | EndSessionRequest + | AuthenticationResult + | PopupEvent + | null diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventType.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventType.yml new file mode 100644 index 0000000..e9f2d79 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventType.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: EventType +uid: '@azure/msal-browser.EventType' +package: '@azure/msal-browser' +summary: '' +fullName: EventType +remarks: '' +isDeprecated: false +syntax: | + type EventType = (typeof EventType)[keyof typeof EventType] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml b/msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml new file mode 100644 index 0000000..c6698bb --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml @@ -0,0 +1,32 @@ +### YamlMime:TSTypeAlias +name: ExternalTokenResponse +uid: '@azure/msal-browser.ExternalTokenResponse' +package: '@azure/msal-browser' +summary: >- + Response object used for loading external tokens to cache. + + - token_type: Indicates the token type value. The only type that Azure AD + supports is Bearer. + + - scope: The scopes that the access_token is valid for. + + - expires_in: How long the access token is valid (in seconds). + + - id_token: A JSON Web Token (JWT). The app can decode the segments of this + token to request information about the user who signed in. + + - refresh_token: An OAuth 2.0 refresh token. The app can use this token + acquire additional access tokens after the current access token expires. + + - access_token: The requested access token. The app can use this token to + authenticate to the secured resource, such as a web API. + + - client_info: Client info object +fullName: ExternalTokenResponse +remarks: '' +isDeprecated: false +syntax: | + type ExternalTokenResponse = Pick< + ServerAuthorizationTokenResponse, + "token_type" | "scope" | "expires_in" | "id_token" | "refresh_token" + > & { access_token?: string; client_info?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml new file mode 100644 index 0000000..e2a45b6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml @@ -0,0 +1,511 @@ +### YamlMime:TSType +name: IController +uid: '@azure/msal-browser.IController' +package: '@azure/msal-browser' +summary: '' +fullName: IController +remarks: '' +isDeprecated: false +type: interface +methods: + - name: acquireTokenByCode(AuthorizationCodeRequest) + uid: '@azure/msal-browser.IController.acquireTokenByCode' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByCode(request: AuthorizationCodeRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: >- + acquireTokenNative(PopupRequest | SilentRequest | SsoSilentRequest, ApiId, + string) + uid: '@azure/msal-browser.IController.acquireTokenNative' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenNative(request: PopupRequest | SilentRequest | + SsoSilentRequest, apiId: ApiId, accountId?: string): + Promise + parameters: + - id: request + type: >- + | | + description: '' + - id: apiId + type: ApiId + description: '' + - id: accountId + type: string + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenPopup(PopupRequest) + uid: '@azure/msal-browser.IController.acquireTokenPopup' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenPopup(request: PopupRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenRedirect(RedirectRequest) + uid: '@azure/msal-browser.IController.acquireTokenRedirect' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function acquireTokenRedirect(request: RedirectRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> + - name: acquireTokenSilent(SilentRequest) + uid: '@azure/msal-browser.IController.acquireTokenSilent' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(silentRequest: SilentRequest): + Promise + parameters: + - id: silentRequest + type: + description: '' + return: + description: '' + type: Promise<> + - name: addEventCallback(EventCallbackFunction) + uid: '@azure/msal-browser.IController.addEventCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addEventCallback(callback: EventCallbackFunction): null | + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: null | string + - name: addPerformanceCallback(PerformanceCallbackFunction) + uid: '@azure/msal-browser.IController.addPerformanceCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addPerformanceCallback(callback: PerformanceCallbackFunction): + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: string + - name: clearCache(ClearCacheRequest) + uid: '@azure/msal-browser.IController.clearCache' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function clearCache(logoutRequest?: ClearCacheRequest): Promise' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: disableAccountStorageEvents() + uid: '@azure/msal-browser.IController.disableAccountStorageEvents' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function disableAccountStorageEvents() + - name: enableAccountStorageEvents() + uid: '@azure/msal-browser.IController.enableAccountStorageEvents' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function enableAccountStorageEvents() + - name: getAccount(AccountFilter) + uid: '@azure/msal-browser.IController.getAccount' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccount(accountFilter: AccountFilter): null | AccountInfo' + parameters: + - id: accountFilter + type: + description: '' + return: + description: '' + type: null | + - name: getAccountByHomeId(string) + uid: '@azure/msal-browser.IController.getAccountByHomeId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountByHomeId(homeAccountId: string): null | AccountInfo' + parameters: + - id: homeAccountId + type: string + description: '' + return: + description: '' + type: null | + - name: getAccountByLocalId(string) + uid: '@azure/msal-browser.IController.getAccountByLocalId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountByLocalId(localId: string): null | AccountInfo' + parameters: + - id: localId + type: string + description: '' + return: + description: '' + type: null | + - name: getAccountByUsername(string) + uid: '@azure/msal-browser.IController.getAccountByUsername' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountByUsername(userName: string): null | AccountInfo' + parameters: + - id: userName + type: string + description: '' + return: + description: '' + type: null | + - name: getActiveAccount() + uid: '@azure/msal-browser.IController.getActiveAccount' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getActiveAccount(): null | AccountInfo' + return: + description: '' + type: null | + - name: getAllAccounts(AccountFilter) + uid: '@azure/msal-browser.IController.getAllAccounts' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]' + parameters: + - id: accountFilter + type: + description: '' + return: + description: '' + type: [] + - name: getLogger() + uid: '@azure/msal-browser.IController.getLogger' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + - name: getTokenCache() + uid: '@azure/msal-browser.IController.getTokenCache' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenCache(): ITokenCache' + return: + description: '' + type: + - name: handleRedirectPromise(string) + uid: '@azure/msal-browser.IController.handleRedirectPromise' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function handleRedirectPromise(hash?: string): Promise + parameters: + - id: hash + type: string + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: >- + hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | + SilentRequest | SsoSilentRequest) + uid: '@azure/msal-browser.IController.hydrateCache' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function hydrateCache(result: AuthenticationResult, request: + PopupRequest | RedirectRequest | SilentRequest | SsoSilentRequest): + Promise + parameters: + - id: result + type: + description: '' + - id: request + type: >- + | | | + description: '' + return: + description: '' + type: Promise<void> + - name: initialize() + uid: '@azure/msal-browser.IController.initialize' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(): Promise' + return: + description: '' + type: Promise<void> + - name: initializeWrapperLibrary(WrapperSKU, string) + uid: '@azure/msal-browser.IController.initializeWrapperLibrary' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' + parameters: + - id: sku + type: WrapperSKU + description: '' + - id: version + type: string + description: '' + - name: loginPopup(PopupRequest) + uid: '@azure/msal-browser.IController.loginPopup' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function loginPopup(request?: PopupRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: loginRedirect(RedirectRequest) + uid: '@azure/msal-browser.IController.loginRedirect' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function loginRedirect(request?: RedirectRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logout(EndSessionRequest) + uid: '@azure/msal-browser.IController.logout' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function logout(logoutRequest?: EndSessionRequest): Promise' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logoutPopup(EndSessionPopupRequest) + uid: '@azure/msal-browser.IController.logoutPopup' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutPopup(logoutRequest?: EndSessionPopupRequest): + Promise + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logoutRedirect(EndSessionRequest) + uid: '@azure/msal-browser.IController.logoutRedirect' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutRedirect(logoutRequest?: EndSessionRequest): + Promise + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: removeEventCallback(string) + uid: '@azure/msal-browser.IController.removeEventCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeEventCallback(callbackId: string)' + parameters: + - id: callbackId + type: string + description: '' + - name: removePerformanceCallback(string) + uid: '@azure/msal-browser.IController.removePerformanceCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(callbackId: string): boolean' + parameters: + - id: callbackId + type: string + description: '' + return: + description: '' + type: boolean + - name: setActiveAccount(null | AccountInfo) + uid: '@azure/msal-browser.IController.setActiveAccount' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setActiveAccount(account: null | AccountInfo)' + parameters: + - id: account + type: null | + description: '' + - name: setLogger(Logger) + uid: '@azure/msal-browser.IController.setLogger' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: '' + - name: setNavigationClient(INavigationClient) + uid: '@azure/msal-browser.IController.setNavigationClient' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setNavigationClient(navigationClient: INavigationClient)' + parameters: + - id: navigationClient + type: + description: '' + - name: ssoSilent(SsoSilentRequest) + uid: '@azure/msal-browser.IController.ssoSilent' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function ssoSilent(request: SsoSilentRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ILoggerCallback.yml b/msal/docs-ref-autogen/@azure/msal-browser/ILoggerCallback.yml new file mode 100644 index 0000000..537e161 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ILoggerCallback.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: ILoggerCallback +uid: '@azure/msal-browser.ILoggerCallback' +package: '@azure/msal-browser' +summary: '' +fullName: ILoggerCallback +remarks: '' +isDeprecated: false +type: interface diff --git a/msal/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml new file mode 100644 index 0000000..d9f8dbb --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml @@ -0,0 +1,56 @@ +### YamlMime:TSType +name: INavigationClient +uid: '@azure/msal-browser.INavigationClient' +package: '@azure/msal-browser' +summary: '' +fullName: INavigationClient +remarks: '' +isDeprecated: false +type: interface +methods: + - name: navigateExternal(string, NavigationOptions) + uid: '@azure/msal-browser.INavigationClient.navigateExternal' + package: '@azure/msal-browser' + summary: >- + Navigates to other pages outside the web application i.e. the Identity + Provider + remarks: '' + isDeprecated: false + syntax: + content: >- + function navigateExternal(url: string, options: NavigationOptions): + Promise + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + return: + description: '' + type: Promise<boolean> + - name: navigateInternal(string, NavigationOptions) + uid: '@azure/msal-browser.INavigationClient.navigateInternal' + package: '@azure/msal-browser' + summary: >- + Navigates to other pages within the same web application + + Return false if this doesn't cause the page to reload i.e. Client-side + navigation + remarks: '' + isDeprecated: false + syntax: + content: >- + function navigateInternal(url: string, options: NavigationOptions): + Promise + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + return: + description: '' + type: Promise<boolean> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml b/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml new file mode 100644 index 0000000..b7d5df8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: INetworkModule +uid: '@azure/msal-browser.INetworkModule' +package: '@azure/msal-browser' +summary: Client network interface to send backend requests. +fullName: INetworkModule +remarks: '' +isDeprecated: false +type: interface +methods: + - name: sendGetRequestAsync(string, NetworkRequestOptions, number) + uid: '@azure/msal-browser.INetworkModule.sendGetRequestAsync' + package: '@azure/msal-browser' + summary: >- + Interface function for async network "GET" requests. Based on the Fetch + standard: https://fetch.spec.whatwg.org/ + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendGetRequestAsync(url: string, options?: + NetworkRequestOptions, cancellationToken?: number): + Promise> + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + - id: cancellationToken + type: number + description: '' + return: + description: '' + type: >- + Promise<<T>> + - name: sendPostRequestAsync(string, NetworkRequestOptions) + uid: '@azure/msal-browser.INetworkModule.sendPostRequestAsync' + package: '@azure/msal-browser' + summary: >- + Interface function for async network "POST" requests. Based on the Fetch + standard: https://fetch.spec.whatwg.org/ + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendPostRequestAsync(url: string, options?: + NetworkRequestOptions): Promise> + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + return: + description: '' + type: >- + Promise<<T>> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IPerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/IPerformanceClient.yml new file mode 100644 index 0000000..4efe740 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/IPerformanceClient.yml @@ -0,0 +1,230 @@ +### YamlMime:TSType +name: IPerformanceClient +uid: '@azure/msal-browser.IPerformanceClient' +package: '@azure/msal-browser' +summary: '' +fullName: IPerformanceClient +remarks: '' +isDeprecated: false +type: interface +methods: + - name: 'addFields({[key: string]: {} | undefined}, string)' + uid: '@azure/msal-browser.IPerformanceClient.addFields' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addFields(fields: {[key: string]: {} | undefined}, + correlationId: string) + parameters: + - id: fields + type: '{[key: string]: {} | undefined}' + description: '' + - id: correlationId + type: string + description: '' + - name: addPerformanceCallback(PerformanceCallbackFunction) + uid: '@azure/msal-browser.IPerformanceClient.addPerformanceCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addPerformanceCallback(callback: PerformanceCallbackFunction): + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: string + - name: addQueueMeasurement(string, string, number, boolean) + uid: '@azure/msal-browser.IPerformanceClient.addQueueMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addQueueMeasurement(eventName: string, correlationId?: string, + queueTime?: number, manuallyCompleted?: boolean) + parameters: + - id: eventName + type: string + description: '' + - id: correlationId + type: string + description: '' + - id: queueTime + type: number + description: '' + - id: manuallyCompleted + type: boolean + description: '' + - name: calculateQueuedTime(number, number) + uid: '@azure/msal-browser.IPerformanceClient.calculateQueuedTime' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function calculateQueuedTime(preQueueTime: number, currentTime: number): + number + parameters: + - id: preQueueTime + type: number + description: '' + - id: currentTime + type: number + description: '' + return: + description: '' + type: number + - name: discardMeasurements(string) + uid: '@azure/msal-browser.IPerformanceClient.discardMeasurements' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function discardMeasurements(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + - name: emitEvents(PerformanceEvent[], string) + uid: '@azure/msal-browser.IPerformanceClient.emitEvents' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function emitEvents(events: PerformanceEvent[], correlationId: string)' + parameters: + - id: events + type: [] + description: '' + - id: correlationId + type: string + description: '' + - name: endMeasurement(PerformanceEvent) + uid: '@azure/msal-browser.IPerformanceClient.endMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function endMeasurement(event: PerformanceEvent): null | + PerformanceEvent + parameters: + - id: event + type: + description: '' + return: + description: '' + type: null | + - name: generateId() + uid: '@azure/msal-browser.IPerformanceClient.generateId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function generateId(): string' + return: + description: '' + type: string + - name: 'incrementFields({[key: string]: number | undefined}, string)' + uid: '@azure/msal-browser.IPerformanceClient.incrementFields' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function incrementFields(fields: {[key: string]: number | undefined}, + correlationId: string) + parameters: + - id: fields + type: '{[key: string]: number | undefined}' + description: '' + - id: correlationId + type: string + description: '' + - name: removePerformanceCallback(string) + uid: '@azure/msal-browser.IPerformanceClient.removePerformanceCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(callbackId: string): boolean' + parameters: + - id: callbackId + type: string + description: '' + return: + description: '' + type: boolean + - name: setPreQueueTime(string, string) + uid: '@azure/msal-browser.IPerformanceClient.setPreQueueTime' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setPreQueueTime(eventName: string, correlationId?: string)' + parameters: + - id: eventName + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: startMeasurement(string, string) + uid: '@azure/msal-browser.IPerformanceClient.startMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: + - name: startPerformanceMeasurement(string, string) + uid: '@azure/msal-browser.IPerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: This method will be removed in the next major version + syntax: + content: >- + function startPerformanceMeasurement(measureName: string, correlationId: + string): IPerformanceMeasurement + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml new file mode 100644 index 0000000..fbf178c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml @@ -0,0 +1,463 @@ +### YamlMime:TSType +name: IPublicClientApplication +uid: '@azure/msal-browser.IPublicClientApplication' +package: '@azure/msal-browser' +summary: '' +fullName: IPublicClientApplication +remarks: '' +isDeprecated: false +type: interface +methods: + - name: acquireTokenByCode(AuthorizationCodeRequest) + uid: '@azure/msal-browser.IPublicClientApplication.acquireTokenByCode' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByCode(request: AuthorizationCodeRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenPopup(PopupRequest) + uid: '@azure/msal-browser.IPublicClientApplication.acquireTokenPopup' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenPopup(request: PopupRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenRedirect(RedirectRequest) + uid: '@azure/msal-browser.IPublicClientApplication.acquireTokenRedirect' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function acquireTokenRedirect(request: RedirectRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> + - name: acquireTokenSilent(SilentRequest) + uid: '@azure/msal-browser.IPublicClientApplication.acquireTokenSilent' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(silentRequest: SilentRequest): + Promise + parameters: + - id: silentRequest + type: + description: '' + return: + description: '' + type: Promise<> + - name: addEventCallback(EventCallbackFunction) + uid: '@azure/msal-browser.IPublicClientApplication.addEventCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addEventCallback(callback: EventCallbackFunction): null | + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: null | string + - name: addPerformanceCallback(PerformanceCallbackFunction) + uid: '@azure/msal-browser.IPublicClientApplication.addPerformanceCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addPerformanceCallback(callback: PerformanceCallbackFunction): + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: string + - name: clearCache(ClearCacheRequest) + uid: '@azure/msal-browser.IPublicClientApplication.clearCache' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function clearCache(logoutRequest?: ClearCacheRequest): Promise' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: disableAccountStorageEvents() + uid: '@azure/msal-browser.IPublicClientApplication.disableAccountStorageEvents' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function disableAccountStorageEvents() + - name: enableAccountStorageEvents() + uid: '@azure/msal-browser.IPublicClientApplication.enableAccountStorageEvents' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function enableAccountStorageEvents() + - name: getAccountByHomeId(string) + uid: '@azure/msal-browser.IPublicClientApplication.getAccountByHomeId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountByHomeId(homeAccountId: string): null | AccountInfo' + parameters: + - id: homeAccountId + type: string + description: '' + return: + description: '' + type: null | + - name: getAccountByLocalId(string) + uid: '@azure/msal-browser.IPublicClientApplication.getAccountByLocalId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountByLocalId(localId: string): null | AccountInfo' + parameters: + - id: localId + type: string + description: '' + return: + description: '' + type: null | + - name: getAccountByUsername(string) + uid: '@azure/msal-browser.IPublicClientApplication.getAccountByUsername' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountByUsername(userName: string): null | AccountInfo' + parameters: + - id: userName + type: string + description: '' + return: + description: '' + type: null | + - name: getActiveAccount() + uid: '@azure/msal-browser.IPublicClientApplication.getActiveAccount' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getActiveAccount(): null | AccountInfo' + return: + description: '' + type: null | + - name: getAllAccounts() + uid: '@azure/msal-browser.IPublicClientApplication.getAllAccounts' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(): AccountInfo[]' + return: + description: '' + type: [] + - name: getLogger() + uid: '@azure/msal-browser.IPublicClientApplication.getLogger' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + - name: getTokenCache() + uid: '@azure/msal-browser.IPublicClientApplication.getTokenCache' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenCache(): ITokenCache' + return: + description: '' + type: + - name: handleRedirectPromise(string) + uid: '@azure/msal-browser.IPublicClientApplication.handleRedirectPromise' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function handleRedirectPromise(hash?: string): Promise + parameters: + - id: hash + type: string + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: >- + hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | + SilentRequest | SsoSilentRequest) + uid: '@azure/msal-browser.IPublicClientApplication.hydrateCache' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function hydrateCache(result: AuthenticationResult, request: + PopupRequest | RedirectRequest | SilentRequest | SsoSilentRequest): + Promise + parameters: + - id: result + type: + description: '' + - id: request + type: >- + | | | + description: '' + return: + description: '' + type: Promise<void> + - name: initialize() + uid: '@azure/msal-browser.IPublicClientApplication.initialize' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(): Promise' + return: + description: '' + type: Promise<void> + - name: initializeWrapperLibrary(WrapperSKU, string) + uid: '@azure/msal-browser.IPublicClientApplication.initializeWrapperLibrary' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' + parameters: + - id: sku + type: WrapperSKU + description: '' + - id: version + type: string + description: '' + - name: loginPopup(PopupRequest) + uid: '@azure/msal-browser.IPublicClientApplication.loginPopup' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function loginPopup(request?: PopupRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: loginRedirect(RedirectRequest) + uid: '@azure/msal-browser.IPublicClientApplication.loginRedirect' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function loginRedirect(request?: RedirectRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logout(EndSessionRequest) + uid: '@azure/msal-browser.IPublicClientApplication.logout' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function logout(logoutRequest?: EndSessionRequest): Promise' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logoutPopup(EndSessionPopupRequest) + uid: '@azure/msal-browser.IPublicClientApplication.logoutPopup' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutPopup(logoutRequest?: EndSessionPopupRequest): + Promise + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logoutRedirect(EndSessionRequest) + uid: '@azure/msal-browser.IPublicClientApplication.logoutRedirect' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutRedirect(logoutRequest?: EndSessionRequest): + Promise + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: removeEventCallback(string) + uid: '@azure/msal-browser.IPublicClientApplication.removeEventCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeEventCallback(callbackId: string)' + parameters: + - id: callbackId + type: string + description: '' + - name: removePerformanceCallback(string) + uid: '@azure/msal-browser.IPublicClientApplication.removePerformanceCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(callbackId: string): boolean' + parameters: + - id: callbackId + type: string + description: '' + return: + description: '' + type: boolean + - name: setActiveAccount(null | AccountInfo) + uid: '@azure/msal-browser.IPublicClientApplication.setActiveAccount' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setActiveAccount(account: null | AccountInfo)' + parameters: + - id: account + type: null | + description: '' + - name: setLogger(Logger) + uid: '@azure/msal-browser.IPublicClientApplication.setLogger' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: '' + - name: setNavigationClient(INavigationClient) + uid: '@azure/msal-browser.IPublicClientApplication.setNavigationClient' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setNavigationClient(navigationClient: INavigationClient)' + parameters: + - id: navigationClient + type: + description: '' + - name: ssoSilent(SsoSilentRequest) + uid: '@azure/msal-browser.IPublicClientApplication.ssoSilent' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function ssoSilent(request: SsoSilentRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml b/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml new file mode 100644 index 0000000..bc98ac3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml @@ -0,0 +1,33 @@ +### YamlMime:TSType +name: ITokenCache +uid: '@azure/msal-browser.ITokenCache' +package: '@azure/msal-browser' +summary: '' +fullName: ITokenCache +remarks: '' +isDeprecated: false +type: interface +methods: + - name: loadExternalTokens(SilentRequest, ExternalTokenResponse, LoadTokenOptions) + uid: '@azure/msal-browser.ITokenCache.loadExternalTokens' + package: '@azure/msal-browser' + summary: API to side-load tokens to MSAL cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function loadExternalTokens(request: SilentRequest, response: + ExternalTokenResponse, options: LoadTokenOptions): AuthenticationResult + parameters: + - id: request + type: + description: '' + - id: response + type: + description: '' + - id: options + type: + description: '' + return: + description: '`AuthenticationResult` for the response that was loaded.' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IdTokenClaims.yml b/msal/docs-ref-autogen/@azure/msal-browser/IdTokenClaims.yml new file mode 100644 index 0000000..70e3571 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/IdTokenClaims.yml @@ -0,0 +1,44 @@ +### YamlMime:TSTypeAlias +name: IdTokenClaims +uid: '@azure/msal-browser.IdTokenClaims' +package: '@azure/msal-browser' +summary: Type which describes Id Token claims known by MSAL. +fullName: IdTokenClaims +remarks: '' +isDeprecated: false +syntax: | + type IdTokenClaims = { + acr?: string + amr?: string[] + at?: string + aud?: string + auth_time?: number + cloud_instance_host_name?: string + cnf?: { kid: string } + emails?: string[] + exp?: number + home_oid?: string + iat?: number + idp?: string + iss?: string + login_hint?: string + m?: string + name?: string + nbf?: number + nonce?: string + oid?: string + p?: string + preferred_username?: string + roles?: string[] + sid?: string + sub?: string + tenant_region_scope?: string + tenant_region_sub_scope?: string + tfp?: string + tid?: string + ts?: number + u?: string + upn?: string + ver?: string + x5c_ca?: string[] + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/InProgressPerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/InProgressPerformanceEvent.yml new file mode 100644 index 0000000..27c0491 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/InProgressPerformanceEvent.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: InProgressPerformanceEvent +uid: '@azure/msal-browser.InProgressPerformanceEvent' +package: '@azure/msal-browser' +summary: '' +fullName: InProgressPerformanceEvent +remarks: '' +isDeprecated: false +syntax: | + type InProgressPerformanceEvent = { + add: (fields: { [key: string]: {} | undefined }) => void + discard: () => void + end: ( + event?: Partial, + error?: unknown + ) => PerformanceEvent | null + event: PerformanceEvent + increment: (fields: { [key: string]: number | undefined }) => void + measurement: IPerformanceMeasurement + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml new file mode 100644 index 0000000..c0ab087 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: InteractionRequiredAuthError +uid: '@azure/msal-browser.InteractionRequiredAuthError' +package: '@azure/msal-browser' +summary: Error thrown when user interaction is required. +fullName: InteractionRequiredAuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + InteractionRequiredAuthError(string, string, string, string, string, + string, string) + uid: '@azure/msal-browser.InteractionRequiredAuthError.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new InteractionRequiredAuthError(errorCode?: string, errorMessage?: + string, subError?: string, timestamp?: string, traceId?: string, + correlationId?: string, claims?: string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: subError + type: string + description: '' + - id: timestamp + type: string + description: '' + - id: traceId + type: string + description: '' + - id: correlationId + type: string + description: '' + - id: claims + type: string + description: '' +properties: + - name: claims + uid: '@azure/msal-browser.InteractionRequiredAuthError.claims' + package: '@azure/msal-browser' + summary: >- + https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-common/docs/claims-challenge.md + + + A string with extra claims needed for the token request to succeed + + web site: redirect the user to the authorization page and set the extra + claims + + web api: include the claims in the WWW-Authenticate header that are sent + back to the client so that it knows to request a token with the extra + claims + + desktop application or browser context: include the claims when acquiring + the token interactively + + app to app context (client_credentials): include the claims in the + AcquireTokenByClientCredential request + fullName: claims + remarks: '' + isDeprecated: false + syntax: + content: 'claims: string' + return: + description: '' + type: string + - name: timestamp + uid: '@azure/msal-browser.InteractionRequiredAuthError.timestamp' + package: '@azure/msal-browser' + summary: The time the error occured at + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp: string' + return: + description: '' + type: string + - name: traceId + uid: '@azure/msal-browser.InteractionRequiredAuthError.traceId' + package: '@azure/msal-browser' + summary: TraceId associated with the error + fullName: traceId + remarks: '' + isDeprecated: false + syntax: + content: 'traceId: string' + return: + description: '' + type: string +inheritedProperties: + - name: correlationId + uid: '@azure/msal-browser.InteractionRequiredAuthError.correlationId' + package: '@azure/msal-browser' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-browser.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-browser.InteractionRequiredAuthError.errorCode' + package: '@azure/msal-browser' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-browser.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-browser.InteractionRequiredAuthError.errorMessage' + package: '@azure/msal-browser' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-browser.AuthError.errorMessage) + - name: message + uid: '@azure/msal-browser.InteractionRequiredAuthError.message' + package: '@azure/msal-browser' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-browser.AuthError.message) + - name: name + uid: '@azure/msal-browser.InteractionRequiredAuthError.name' + package: '@azure/msal-browser' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-browser.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-browser.InteractionRequiredAuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-browser.InteractionRequiredAuthError.stack' + package: '@azure/msal-browser' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-browser.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-browser.InteractionRequiredAuthError.stackTraceLimit' + package: '@azure/msal-browser' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-browser.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-browser.InteractionRequiredAuthError.subError' + package: '@azure/msal-browser' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-browser.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-browser.InteractionRequiredAuthError.captureStackTrace' + package: '@azure/msal-browser' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-browser.InteractionRequiredAuthError.setCorrelationId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-browser.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthErrorCodes.yml new file mode 100644 index 0000000..0b29863 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-browser.InteractionRequiredAuthErrorCodes' +name: InteractionRequiredAuthErrorCodes +type: module +package: '@azure/msal-browser' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml b/msal/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml new file mode 100644 index 0000000..27becd7 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: InteractionStatus +uid: '@azure/msal-browser.InteractionStatus' +package: '@azure/msal-browser' +summary: '' +fullName: InteractionStatus +remarks: '' +isDeprecated: false +syntax: | + type InteractionStatus = + (typeof InteractionStatus)[keyof typeof InteractionStatus] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/InteractionType.yml b/msal/docs-ref-autogen/@azure/msal-browser/InteractionType.yml new file mode 100644 index 0000000..70c9654 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/InteractionType.yml @@ -0,0 +1,25 @@ +### YamlMime:TSEnum +name: InteractionType +uid: '@azure/msal-browser.InteractionType' +package: '@azure/msal-browser' +summary: '' +fullName: InteractionType +remarks: '' +isDeprecated: false +fields: + - name: None + uid: '@azure/msal-browser.InteractionType.None' + package: '@azure/msal-browser' + summary: '' + - name: Popup + uid: '@azure/msal-browser.InteractionType.Popup' + package: '@azure/msal-browser' + summary: '' + - name: Redirect + uid: '@azure/msal-browser.InteractionType.Redirect' + package: '@azure/msal-browser' + summary: '' + - name: Silent + uid: '@azure/msal-browser.InteractionType.Silent' + package: '@azure/msal-browser' + summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/JsonWebTokenTypes.yml b/msal/docs-ref-autogen/@azure/msal-browser/JsonWebTokenTypes.yml new file mode 100644 index 0000000..eec70c8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/JsonWebTokenTypes.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: JsonWebTokenTypes +uid: '@azure/msal-browser.JsonWebTokenTypes' +package: '@azure/msal-browser' +summary: '' +fullName: JsonWebTokenTypes +remarks: '' +isDeprecated: false +syntax: | + type JsonWebTokenTypes = + (typeof JsonWebTokenTypes)[keyof typeof JsonWebTokenTypes] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml new file mode 100644 index 0000000..41bd5dc --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: LoadTokenOptions +uid: '@azure/msal-browser.LoadTokenOptions' +package: '@azure/msal-browser' +summary: '' +fullName: LoadTokenOptions +remarks: '' +isDeprecated: false +syntax: | + type LoadTokenOptions = { + clientInfo?: string + expiresOn?: number + extendedExpiresOn?: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/LogLevel.yml b/msal/docs-ref-autogen/@azure/msal-browser/LogLevel.yml new file mode 100644 index 0000000..a138f49 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/LogLevel.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: LogLevel +uid: '@azure/msal-browser.LogLevel' +package: '@azure/msal-browser' +summary: Log message level. +fullName: LogLevel +remarks: '' +isDeprecated: false +fields: + - name: Error + uid: '@azure/msal-browser.LogLevel.Error' + package: '@azure/msal-browser' + summary: '' + numericValue: 0 + - name: Warning + uid: '@azure/msal-browser.LogLevel.Warning' + package: '@azure/msal-browser' + summary: '' + numericValue: 1 + - name: Info + uid: '@azure/msal-browser.LogLevel.Info' + package: '@azure/msal-browser' + summary: '' + numericValue: 2 + - name: Verbose + uid: '@azure/msal-browser.LogLevel.Verbose' + package: '@azure/msal-browser' + summary: '' + numericValue: 3 + - name: Trace + uid: '@azure/msal-browser.LogLevel.Trace' + package: '@azure/msal-browser' + summary: '' + numericValue: 4 diff --git a/msal/docs-ref-autogen/@azure/msal-browser/Logger.yml b/msal/docs-ref-autogen/@azure/msal-browser/Logger.yml new file mode 100644 index 0000000..682901a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/Logger.yml @@ -0,0 +1,235 @@ +### YamlMime:TSType +name: Logger +uid: '@azure/msal-browser.Logger' +package: '@azure/msal-browser' +summary: Class which facilitates logging of messages to a specific place. +fullName: Logger +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Logger(LoggerOptions, string, string) + uid: '@azure/msal-browser.Logger.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Logger(loggerOptions: LoggerOptions, packageName?: string, + packageVersion?: string) + parameters: + - id: loggerOptions + type: + description: '' + - id: packageName + type: string + description: '' + - id: packageVersion + type: string + description: '' +methods: + - name: clone(string, string, string) + uid: '@azure/msal-browser.Logger.clone' + package: '@azure/msal-browser' + summary: Create new Logger with existing configurations. + remarks: '' + isDeprecated: false + syntax: + content: >- + function clone(packageName: string, packageVersion: string, + correlationId?: string): Logger + parameters: + - id: packageName + type: string + description: '' + - id: packageVersion + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: + - name: error(string, string) + uid: '@azure/msal-browser.Logger.error' + package: '@azure/msal-browser' + summary: Logs error messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function error(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: errorPii(string, string) + uid: '@azure/msal-browser.Logger.errorPii' + package: '@azure/msal-browser' + summary: Logs error messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function errorPii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: executeCallback(LogLevel, string, boolean) + uid: '@azure/msal-browser.Logger.executeCallback' + package: '@azure/msal-browser' + summary: Execute callback with message. + remarks: '' + isDeprecated: false + syntax: + content: >- + function executeCallback(level: LogLevel, message: string, containsPii: + boolean) + parameters: + - id: level + type: + description: '' + - id: message + type: string + description: '' + - id: containsPii + type: boolean + description: '' + - name: info(string, string) + uid: '@azure/msal-browser.Logger.info' + package: '@azure/msal-browser' + summary: Logs info messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function info(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: infoPii(string, string) + uid: '@azure/msal-browser.Logger.infoPii' + package: '@azure/msal-browser' + summary: Logs info messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function infoPii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: isPiiLoggingEnabled() + uid: '@azure/msal-browser.Logger.isPiiLoggingEnabled' + package: '@azure/msal-browser' + summary: Returns whether PII Logging is enabled or not. + remarks: '' + isDeprecated: false + syntax: + content: 'function isPiiLoggingEnabled(): boolean' + return: + description: '' + type: boolean + - name: trace(string, string) + uid: '@azure/msal-browser.Logger.trace' + package: '@azure/msal-browser' + summary: Logs trace messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function trace(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: tracePii(string, string) + uid: '@azure/msal-browser.Logger.tracePii' + package: '@azure/msal-browser' + summary: Logs trace messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function tracePii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: verbose(string, string) + uid: '@azure/msal-browser.Logger.verbose' + package: '@azure/msal-browser' + summary: Logs verbose messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function verbose(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: verbosePii(string, string) + uid: '@azure/msal-browser.Logger.verbosePii' + package: '@azure/msal-browser' + summary: Logs verbose messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function verbosePii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: warning(string, string) + uid: '@azure/msal-browser.Logger.warning' + package: '@azure/msal-browser' + summary: Logs warning messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function warning(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: warningPii(string, string) + uid: '@azure/msal-browser.Logger.warningPii' + package: '@azure/msal-browser' + summary: Logs warning messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function warningPii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml new file mode 100644 index 0000000..6ecde16 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml @@ -0,0 +1,86 @@ +### YamlMime:TSType +name: MemoryStorage +uid: '@azure/msal-browser.MemoryStorage' +package: '@azure/msal-browser' +summary: '' +fullName: MemoryStorage +remarks: '' +isDeprecated: false +type: class +methods: + - name: clear() + uid: '@azure/msal-browser.MemoryStorage.clear' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function clear() + - name: containsKey(string) + uid: '@azure/msal-browser.MemoryStorage.containsKey' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function containsKey(key: string): boolean' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: boolean + - name: getItem(string) + uid: '@azure/msal-browser.MemoryStorage.getItem' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getItem(key: string): null | T' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: null | T + - name: getKeys() + uid: '@azure/msal-browser.MemoryStorage.getKeys' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getKeys(): string[]' + return: + description: '' + type: string[] + - name: removeItem(string) + uid: '@azure/msal-browser.MemoryStorage.removeItem' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removeItem(key: string)' + parameters: + - id: key + type: string + description: '' + - name: setItem(string, T) + uid: '@azure/msal-browser.MemoryStorage.setItem' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setItem(key: string, value: T)' + parameters: + - id: key + type: string + description: '' + - id: value + type: T + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml new file mode 100644 index 0000000..41b4f34 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml @@ -0,0 +1,52 @@ +### YamlMime:TSType +name: NavigationClient +uid: '@azure/msal-browser.NavigationClient' +package: '@azure/msal-browser' +summary: '' +fullName: NavigationClient +remarks: '' +isDeprecated: false +type: class +methods: + - name: navigateExternal(string, NavigationOptions) + uid: '@azure/msal-browser.NavigationClient.navigateExternal' + package: '@azure/msal-browser' + summary: >- + Navigates to other pages outside the web application i.e. the Identity + Provider + remarks: '' + isDeprecated: false + syntax: + content: >- + function navigateExternal(url: string, options: NavigationOptions): + Promise + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + return: + description: '' + type: Promise<boolean> + - name: navigateInternal(string, NavigationOptions) + uid: '@azure/msal-browser.NavigationClient.navigateInternal' + package: '@azure/msal-browser' + summary: Navigates to other pages within the same web application + remarks: '' + isDeprecated: false + syntax: + content: >- + function navigateInternal(url: string, options: NavigationOptions): + Promise + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + return: + description: '' + type: Promise<boolean> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NavigationOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/NavigationOptions.yml new file mode 100644 index 0000000..8db8f49 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/NavigationOptions.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: NavigationOptions +uid: '@azure/msal-browser.NavigationOptions' +package: '@azure/msal-browser' +summary: >- + Additional information passed to the navigateInternal and navigateExternal + functions +fullName: NavigationOptions +remarks: '' +isDeprecated: false +syntax: | + type NavigationOptions = { apiId: ApiId; noHistory: boolean; timeout: number } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NetworkRequestOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/NetworkRequestOptions.yml new file mode 100644 index 0000000..62b1ce8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/NetworkRequestOptions.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: NetworkRequestOptions +uid: '@azure/msal-browser.NetworkRequestOptions' +package: '@azure/msal-browser' +summary: Options allowed by network request APIs. +fullName: NetworkRequestOptions +remarks: '' +isDeprecated: false +syntax: > + type NetworkRequestOptions = { body?: string; headers?: Record + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NetworkResponse.yml b/msal/docs-ref-autogen/@azure/msal-browser/NetworkResponse.yml new file mode 100644 index 0000000..1e9eeae --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/NetworkResponse.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: NetworkResponse +uid: '@azure/msal-browser.NetworkResponse' +package: '@azure/msal-browser' +summary: '' +fullName: NetworkResponse +remarks: '' +isDeprecated: false +syntax: | + type NetworkResponse = { + body: T + headers: Record + status: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceCallbackFunction.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceCallbackFunction.yml new file mode 100644 index 0000000..745b14e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceCallbackFunction.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: PerformanceCallbackFunction +uid: '@azure/msal-browser.PerformanceCallbackFunction' +package: '@azure/msal-browser' +summary: '' +fullName: PerformanceCallbackFunction +remarks: '' +isDeprecated: false +syntax: | + type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml new file mode 100644 index 0000000..6b4d14b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml @@ -0,0 +1,75 @@ +### YamlMime:TSTypeAlias +name: PerformanceEvent +uid: '@azure/msal-browser.PerformanceEvent' +package: '@azure/msal-browser' +summary: >- + Performance measurement taken by the library, including metadata about the + request and application. +fullName: PerformanceEvent +remarks: '' +isDeprecated: false +syntax: | + type PerformanceEvent = { + accessTokenSize?: number + allowNativeBroker?: boolean + appName?: string + appVersion?: string + authority: string + awaitIframeCorrelationId?: string + cacheAtCount?: number + cacheIdCount?: number + cacheLookupPolicy?: number + cacheOutcome?: number + cacheRtCount?: number + clientId: string + context?: string + correlationId: string + durationMs?: number + endPageVisibility?: string | null + errorCode?: string + errorName?: string + errorStack?: string[] + eventId: string + extensionHandshakeTimedOut?: boolean + extensionHandshakeTimeoutMs?: number + extensionId?: string + extensionInstalled?: boolean + extensionVersion?: string + fromCache?: boolean | null + httpVerToken?: string + idTokenSize?: number + incompleteSubMeasurements?: Map + incompleteSubsCount?: number + isNativeBroker?: boolean + libraryName: string + libraryVersion: string + matsAccountJoinOnEnd?: string + matsAccountJoinOnStart?: string + matsApiErrorCode?: number + matsBrokerVersion?: string + matsDeviceJoin?: string + matsHttpEventCount?: number + matsHttpStatus?: number + matsPromptBehavior?: string + matsSilentBiSubCode?: number + matsSilentCode?: number + matsSilentMessage?: string + matsSilentStatus?: number + matsUiVisible?: boolean + multiMatchedAT?: number + multiMatchedID?: number + multiMatchedRT?: number + name: string + nestedAppAuthRequest?: boolean + queuedCount?: number + queuedManuallyCompletedCount?: number + queuedTimeMs?: number + refreshTokenSize?: number + requestId?: string + startPageVisibility?: string | null + startTimeMs: number + status: PerformanceEventStatus + subErrorCode?: string + success?: boolean | null + visibilityChangeCount?: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml new file mode 100644 index 0000000..d8ecfc4 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -0,0 +1,426 @@ +### YamlMime:TSEnum +name: PerformanceEvents +uid: '@azure/msal-browser.PerformanceEvents' +package: '@azure/msal-browser' +summary: >- + Enumeration of operations that are instrumented by have their performance + measured by the PerformanceClient. +fullName: PerformanceEvents +remarks: '' +isDeprecated: false +fields: + - name: AcquireTokenByBroker + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenByBroker' + package: '@azure/msal-browser' + summary: Time taken for token acquisition by broker + - name: AcquireTokenByCode + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenByCode' + package: '@azure/msal-browser' + summary: >- + acquireTokenByCode API (msal-browser and msal-node). + + Used to acquire tokens by trading an authorization code against the token + endpoint. + - name: AcquireTokenByCodeAsync + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenByCodeAsync' + package: '@azure/msal-browser' + summary: '' + - name: AcquireTokenByRefreshToken + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenByRefreshToken' + package: '@azure/msal-browser' + summary: >- + acquireTokenByRefreshToken API (msal-browser and msal-node). + + Used to renew an access token using a refresh token against the token + endpoint. + - name: AcquireTokenByRefreshTokenInBroker + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenByRefreshTokenInBroker' + package: '@azure/msal-browser' + summary: acquireTokenByRefreshToken API in BrokerClientApplication (PW-Broker) . + - name: AcquireTokenBySilentIframe + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenBySilentIframe' + package: '@azure/msal-browser' + summary: |- + acquireTokenBySilentIframe (msal-browser). + Internal API for acquiring token by silent Iframe + - name: AcquireTokenFromCache + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenFromCache' + package: '@azure/msal-browser' + summary: |- + acquireTokenFromCache (msal-browser). + Internal API for acquiring token from cache + - name: AcquireTokenPopup + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenPopup' + package: '@azure/msal-browser' + summary: |- + acquireTokenPopup (msal-browser). + Used to acquire a new access token interactively through pop ups + - name: AcquireTokenRedirect + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenRedirect' + package: '@azure/msal-browser' + summary: |- + acquireTokenRedirect (msal-browser). + Used to acquire a new access token interactively through redirects + - name: AcquireTokenSilent + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenSilent' + package: '@azure/msal-browser' + summary: >- + acquireTokenSilent API (msal-browser and msal-node). + + Used to silently acquire a new access token (from the cache or the + network). + - name: AcquireTokenSilentAsync + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenSilentAsync' + package: '@azure/msal-browser' + summary: |- + acquireTokenSilentAsync (msal-browser). + Internal API for acquireTokenSilent. + - name: AuthClientAcquireToken + uid: '@azure/msal-browser.PerformanceEvents.AuthClientAcquireToken' + package: '@azure/msal-browser' + summary: APIs in Authorization Code Client (msal-common) + - name: AuthClientCreateQueryString + uid: '@azure/msal-browser.PerformanceEvents.AuthClientCreateQueryString' + package: '@azure/msal-browser' + summary: '' + - name: AuthClientCreateTokenRequestBody + uid: '@azure/msal-browser.PerformanceEvents.AuthClientCreateTokenRequestBody' + package: '@azure/msal-browser' + summary: '' + - name: AuthClientExecuteTokenRequest + uid: '@azure/msal-browser.PerformanceEvents.AuthClientExecuteTokenRequest' + package: '@azure/msal-browser' + summary: '' + - name: AuthorityFactoryCreateDiscoveredInstance + uid: >- + @azure/msal-browser.PerformanceEvents.AuthorityFactoryCreateDiscoveredInstance + package: '@azure/msal-browser' + summary: Authority functions + - name: AuthorityGetCloudDiscoveryMetadataFromNetwork + uid: >- + @azure/msal-browser.PerformanceEvents.AuthorityGetCloudDiscoveryMetadataFromNetwork + package: '@azure/msal-browser' + summary: '' + - name: AuthorityGetEndpointMetadataFromNetwork + uid: >- + @azure/msal-browser.PerformanceEvents.AuthorityGetEndpointMetadataFromNetwork + package: '@azure/msal-browser' + summary: '' + - name: AuthorityResolveEndpointsAsync + uid: '@azure/msal-browser.PerformanceEvents.AuthorityResolveEndpointsAsync' + package: '@azure/msal-browser' + summary: '' + - name: AuthorityResolveEndpointsFromLocalSources + uid: >- + @azure/msal-browser.PerformanceEvents.AuthorityResolveEndpointsFromLocalSources + package: '@azure/msal-browser' + summary: '' + - name: AuthorityUpdateCloudDiscoveryMetadata + uid: >- + @azure/msal-browser.PerformanceEvents.AuthorityUpdateCloudDiscoveryMetadata + package: '@azure/msal-browser' + summary: '' + - name: AuthorityUpdateEndpointMetadata + uid: '@azure/msal-browser.PerformanceEvents.AuthorityUpdateEndpointMetadata' + package: '@azure/msal-browser' + summary: '' + - name: AuthorityUpdateMetadataWithRegionalInformation + uid: >- + @azure/msal-browser.PerformanceEvents.AuthorityUpdateMetadataWithRegionalInformation + package: '@azure/msal-browser' + summary: '' + - name: AuthorizationCodeClientExecutePostToTokenEndpoint + uid: >- + @azure/msal-browser.PerformanceEvents.AuthorizationCodeClientExecutePostToTokenEndpoint + package: '@azure/msal-browser' + summary: '' + - name: AwaitConcurrentIframe + uid: '@azure/msal-browser.PerformanceEvents.AwaitConcurrentIframe' + package: '@azure/msal-browser' + summary: '' + - name: BaseClientCreateTokenRequestHeaders + uid: '@azure/msal-browser.PerformanceEvents.BaseClientCreateTokenRequestHeaders' + package: '@azure/msal-browser' + summary: Time spent creating default headers for requests to token endpoint + - name: BrokerHandhshake + uid: '@azure/msal-browser.PerformanceEvents.BrokerHandhshake' + package: '@azure/msal-browser' + summary: >- + Used to measure the time taken for completing embedded-broker handshake + (PW-Broker). + - name: CacheManagerGetRefreshToken + uid: '@azure/msal-browser.PerformanceEvents.CacheManagerGetRefreshToken' + package: '@azure/msal-browser' + summary: '' + - name: ClearTokensAndKeysWithClaims + uid: '@azure/msal-browser.PerformanceEvents.ClearTokensAndKeysWithClaims' + package: '@azure/msal-browser' + summary: Cache operations + - name: CryptoOptsGetPublicKeyThumbprint + uid: '@azure/msal-browser.PerformanceEvents.CryptoOptsGetPublicKeyThumbprint' + package: '@azure/msal-browser' + summary: >- + getPublicKeyThumbprint API in CryptoOpts class (msal-browser). + + Used to generate a public/private keypair and generate a public key + thumbprint for pop requests. + - name: CryptoOptsSignJwt + uid: '@azure/msal-browser.PerformanceEvents.CryptoOptsSignJwt' + package: '@azure/msal-browser' + summary: |- + signJwt API in CryptoOpts class (msal-browser). + Used to signed a pop token. + - name: DeserializeResponse + uid: '@azure/msal-browser.PerformanceEvents.DeserializeResponse' + package: '@azure/msal-browser' + summary: '' + - name: FetchAccountIdWithNativeBroker + uid: '@azure/msal-browser.PerformanceEvents.FetchAccountIdWithNativeBroker' + package: '@azure/msal-browser' + summary: |- + acquireToken APIs in msal-browser. + Used to make an /authorize endpoint call with native brokering enabled. + - name: GenerateCodeChallengeFromVerifier + uid: '@azure/msal-browser.PerformanceEvents.GenerateCodeChallengeFromVerifier' + package: '@azure/msal-browser' + summary: '' + - name: GenerateCodeVerifier + uid: '@azure/msal-browser.PerformanceEvents.GenerateCodeVerifier' + package: '@azure/msal-browser' + summary: '' + - name: GeneratePkceCodes + uid: '@azure/msal-browser.PerformanceEvents.GeneratePkceCodes' + package: '@azure/msal-browser' + summary: Crypto Operations + - name: GetAuthCodeUrl + uid: '@azure/msal-browser.PerformanceEvents.GetAuthCodeUrl' + package: '@azure/msal-browser' + summary: getAuthCodeUrl API (msal-browser and msal-node). + - name: GetCloudDiscoveryMetadataFromNetworkMeasurement + uid: >- + @azure/msal-browser.PerformanceEvents.GetCloudDiscoveryMetadataFromNetworkMeasurement + package: '@azure/msal-browser' + summary: '' + - name: GetEndpointMetadataFromNetwork + uid: '@azure/msal-browser.PerformanceEvents.GetEndpointMetadataFromNetwork' + package: '@azure/msal-browser' + summary: '' + - name: GetRandomValues + uid: '@azure/msal-browser.PerformanceEvents.GetRandomValues' + package: '@azure/msal-browser' + summary: '' + - name: HandleCodeResponse + uid: '@azure/msal-browser.PerformanceEvents.HandleCodeResponse' + package: '@azure/msal-browser' + summary: '' + - name: HandleCodeResponseFromServer + uid: '@azure/msal-browser.PerformanceEvents.HandleCodeResponseFromServer' + package: '@azure/msal-browser' + summary: Functions from InteractionHandler (msal-browser) + - name: HandleNativeRedirectPromiseMeasurement + uid: >- + @azure/msal-browser.PerformanceEvents.HandleNativeRedirectPromiseMeasurement + package: '@azure/msal-browser' + summary: '' + - name: HandleRedirectPromiseMeasurement + uid: '@azure/msal-browser.PerformanceEvents.HandleRedirectPromiseMeasurement' + package: '@azure/msal-browser' + summary: '' + - name: HandleServerTokenResponse + uid: '@azure/msal-browser.PerformanceEvents.HandleServerTokenResponse' + package: '@azure/msal-browser' + summary: handleServerTokenResponse API in ResponseHandler (msal-common) + - name: InitializeBaseRequest + uid: '@azure/msal-browser.PerformanceEvents.InitializeBaseRequest' + package: '@azure/msal-browser' + summary: >- + Internal API for initializing base request in BaseInteractionClient + (msal-browser) + - name: InitializeClientApplication + uid: '@azure/msal-browser.PerformanceEvents.InitializeClientApplication' + package: '@azure/msal-browser' + summary: '' + - name: InitializeSilentRequest + uid: '@azure/msal-browser.PerformanceEvents.InitializeSilentRequest' + package: '@azure/msal-browser' + summary: >- + Internal API for initializing silent request in SilentCacheClient + (msal-browser) + - name: NativeGenerateAuthResult + uid: '@azure/msal-browser.PerformanceEvents.NativeGenerateAuthResult' + package: '@azure/msal-browser' + summary: '' + - name: NativeInteractionClientAcquireToken + uid: '@azure/msal-browser.PerformanceEvents.NativeInteractionClientAcquireToken' + package: '@azure/msal-browser' + summary: >- + acquireToken API in NativeInteractionClient class (msal-browser). + + Used to acquire a token from Native component when native brokering is + enabled. + - name: NativeMessageHandlerHandshake + uid: '@azure/msal-browser.PerformanceEvents.NativeMessageHandlerHandshake' + package: '@azure/msal-browser' + summary: '' + - name: PopTokenGenerateCnf + uid: '@azure/msal-browser.PerformanceEvents.PopTokenGenerateCnf' + package: '@azure/msal-browser' + summary: Generate functions in PopTokenGenerator (msal-common) + - name: PopTokenGenerateKid + uid: '@azure/msal-browser.PerformanceEvents.PopTokenGenerateKid' + package: '@azure/msal-browser' + summary: '' + - name: RefreshTokenClientAcquireToken + uid: '@azure/msal-browser.PerformanceEvents.RefreshTokenClientAcquireToken' + package: '@azure/msal-browser' + summary: Time taken for acquiring refresh token , records RT size + - name: RefreshTokenClientAcquireTokenByRefreshToken + uid: >- + @azure/msal-browser.PerformanceEvents.RefreshTokenClientAcquireTokenByRefreshToken + package: '@azure/msal-browser' + summary: acquireTokenByRefreshToken API in RefreshTokenClient (msal-common). + - name: RefreshTokenClientAcquireTokenWithCachedRefreshToken + uid: >- + @azure/msal-browser.PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken + package: '@azure/msal-browser' + summary: Time taken for acquiring cached refresh token + - name: RefreshTokenClientCreateTokenRequestBody + uid: >- + @azure/msal-browser.PerformanceEvents.RefreshTokenClientCreateTokenRequestBody + package: '@azure/msal-browser' + summary: >- + Helper function to create token request body in RefreshTokenClient + (msal-common). + - name: RefreshTokenClientExecutePostToTokenEndpoint + uid: >- + @azure/msal-browser.PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint + package: '@azure/msal-browser' + summary: >- + Time spent sending/waiting for the response of a request to the token + endpoint + - name: RefreshTokenClientExecuteTokenRequest + uid: >- + @azure/msal-browser.PerformanceEvents.RefreshTokenClientExecuteTokenRequest + package: '@azure/msal-browser' + summary: Time spent on the network for refresh token acquisition + - name: RegionDiscoveryDetectRegion + uid: '@azure/msal-browser.PerformanceEvents.RegionDiscoveryDetectRegion' + package: '@azure/msal-browser' + summary: Region Discovery functions + - name: RegionDiscoveryGetCurrentVersion + uid: '@azure/msal-browser.PerformanceEvents.RegionDiscoveryGetCurrentVersion' + package: '@azure/msal-browser' + summary: '' + - name: RegionDiscoveryGetRegionFromIMDS + uid: '@azure/msal-browser.PerformanceEvents.RegionDiscoveryGetRegionFromIMDS' + package: '@azure/msal-browser' + summary: '' + - name: RemoveHiddenIframe + uid: '@azure/msal-browser.PerformanceEvents.RemoveHiddenIframe' + package: '@azure/msal-browser' + summary: '' + - name: Sha256Digest + uid: '@azure/msal-browser.PerformanceEvents.Sha256Digest' + package: '@azure/msal-browser' + summary: '' + - name: SilentCacheClientAcquireToken + uid: '@azure/msal-browser.PerformanceEvents.SilentCacheClientAcquireToken' + package: '@azure/msal-browser' + summary: |- + acquireToken API in the SilentCacheClient class (msal-browser). + Used to read access tokens from the cache. + - name: SilentFlowClientAcquireCachedToken + uid: '@azure/msal-browser.PerformanceEvents.SilentFlowClientAcquireCachedToken' + package: '@azure/msal-browser' + summary: '' + - name: SilentFlowClientGenerateResultFromCacheRecord + uid: >- + @azure/msal-browser.PerformanceEvents.SilentFlowClientGenerateResultFromCacheRecord + package: '@azure/msal-browser' + summary: '' + - name: SilentHandlerInitiateAuthRequest + uid: '@azure/msal-browser.PerformanceEvents.SilentHandlerInitiateAuthRequest' + package: '@azure/msal-browser' + summary: SilentHandler + - name: SilentHandlerLoadFrame + uid: '@azure/msal-browser.PerformanceEvents.SilentHandlerLoadFrame' + package: '@azure/msal-browser' + summary: '' + - name: SilentHandlerLoadFrameSync + uid: '@azure/msal-browser.PerformanceEvents.SilentHandlerLoadFrameSync' + package: '@azure/msal-browser' + summary: '' + - name: SilentHandlerMonitorIframeForHash + uid: '@azure/msal-browser.PerformanceEvents.SilentHandlerMonitorIframeForHash' + package: '@azure/msal-browser' + summary: '' + - name: SilentIframeClientAcquireToken + uid: '@azure/msal-browser.PerformanceEvents.SilentIframeClientAcquireToken' + package: '@azure/msal-browser' + summary: >- + acquireToken API in the SilentIframeClient class (msal-browser). + + Used to acquire a new set of tokens from the authorize endpoint in a + hidden iframe. + - name: SilentIframeClientTokenHelper + uid: '@azure/msal-browser.PerformanceEvents.SilentIframeClientTokenHelper' + package: '@azure/msal-browser' + summary: Helper function in SilentIframeClient class (msal-browser). + - name: SilentRefreshClientAcquireToken + uid: '@azure/msal-browser.PerformanceEvents.SilentRefreshClientAcquireToken' + package: '@azure/msal-browser' + summary: >- + acquireToken API in SilentRereshClient (msal-browser). + + Used to acquire a new set of tokens from the token endpoint using a + refresh token. + - name: SsoSilent + uid: '@azure/msal-browser.PerformanceEvents.SsoSilent' + package: '@azure/msal-browser' + summary: >- + ssoSilent API (msal-browser). + + Used to silently acquire an authorization code and set of tokens using a + hidden iframe. + - name: StandardInteractionClientCreateAuthCodeClient + uid: >- + @azure/msal-browser.PerformanceEvents.StandardInteractionClientCreateAuthCodeClient + package: '@azure/msal-browser' + summary: Helper functions in StandardInteractionClient class (msal-browser) + - name: StandardInteractionClientGetClientConfiguration + uid: >- + @azure/msal-browser.PerformanceEvents.StandardInteractionClientGetClientConfiguration + package: '@azure/msal-browser' + summary: '' + - name: StandardInteractionClientGetDiscoveredAuthority + uid: >- + @azure/msal-browser.PerformanceEvents.StandardInteractionClientGetDiscoveredAuthority + package: '@azure/msal-browser' + summary: >- + getDiscoveredAuthority API in StandardInteractionClient class + (msal-browser). + + Used to load authority metadata for a request. + - name: StandardInteractionClientInitializeAuthorizationCodeRequest + uid: >- + @azure/msal-browser.PerformanceEvents.StandardInteractionClientInitializeAuthorizationCodeRequest + package: '@azure/msal-browser' + summary: '' + - name: StandardInteractionClientInitializeAuthorizationRequest + uid: >- + @azure/msal-browser.PerformanceEvents.StandardInteractionClientInitializeAuthorizationRequest + package: '@azure/msal-browser' + summary: '' + - name: UpdateCloudDiscoveryMetadataMeasurement + uid: >- + @azure/msal-browser.PerformanceEvents.UpdateCloudDiscoveryMetadataMeasurement + package: '@azure/msal-browser' + summary: '' + - name: UpdateTokenEndpointAuthority + uid: '@azure/msal-browser.PerformanceEvents.UpdateTokenEndpointAuthority' + package: '@azure/msal-browser' + summary: '' + - name: UsernamePasswordClientAcquireToken + uid: '@azure/msal-browser.PerformanceEvents.UsernamePasswordClientAcquireToken' + package: '@azure/msal-browser' + summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml new file mode 100644 index 0000000..f86cbb3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: PopupEvent +uid: '@azure/msal-browser.PopupEvent' +package: '@azure/msal-browser' +summary: '' +fullName: PopupEvent +remarks: '' +isDeprecated: false +syntax: | + type PopupEvent = { popupWindow: Window } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml new file mode 100644 index 0000000..01c0326 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: PopupPosition +uid: '@azure/msal-browser.PopupPosition' +package: '@azure/msal-browser' +summary: '' +fullName: PopupPosition +remarks: '' +isDeprecated: false +syntax: | + type PopupPosition = { left: number; top: number } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml new file mode 100644 index 0000000..633beaf --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml @@ -0,0 +1,92 @@ +### YamlMime:TSTypeAlias +name: PopupRequest +uid: '@azure/msal-browser.PopupRequest' +package: '@azure/msal-browser' +summary: >- + PopupRequest: Request object passed by user to retrieve a Code from the + + server (first leg of authorization code grant flow) with a popup window. + + + - scopes - Array of scopes the application is requesting + access to. + + - authority - Url of the authority which the application + acquires tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - 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. + + - extraScopesToConsent - Scopes for a different resource when the user + needs consent upfront. + + - state - A value included in the request that is also + returned in the token response. A randomly generated unique value is typically + used for preventing cross site request forgery attacks. The state is also used + to encode information about the user's state in the app before the + authentication request occurred. + + - prompt - Indicates the type of user interaction that is + required. + login: will force the user to enter their credentials on that request, negating single-sign on + none: will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error + consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app + select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account + create: will direct the user to the account creation experience instead of the log in experience + no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY. + - loginHint - Can be used to pre-fill the username/email + address field of the sign-in page for the user, if you know the username/email + address ahead of time. Often apps use this parameter during re-authentication, + having already extracted the username from a previous sign-in using the + login_hint or preferred_username claim. + + - sid - Session ID, unique identifier for the session. + Available as an optional claim on ID tokens. + + - domainHint - Provides a hint about the tenant or domain that + the user should use to sign in. The value of the domain hint is a registered + domain for the tenant. + + - extraQueryParameters - String to string map of custom query parameters + added to the /authorize call + + - tokenBodyParameters - String to string map of custom token request + body parameters added to the /token call. Only used when renewing access + tokens. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call + + - claims - In cases where Azure AD tenant admin has + enabled conditional access policies, and the policy has not been met, + exceptions will contain claims that need to be consented to. + + - nonce - A value included in the request that is + returned in the id token. A randomly generated unique value is typically used + to mitigate replay attacks. + + - popupWindowAttributes - Optional popup window attributes. popupSize + with height and width, and popupPosition with top and left can be set. +fullName: PopupRequest +remarks: '' +isDeprecated: false +syntax: | + type PopupRequest = Partial< + Omit< + CommonAuthorizationUrlRequest, + | "responseMode" + | "scopes" + | "codeChallenge" + | "codeChallengeMethod" + | "requestedClaimsHash" + | "nativeBroker" + > + > & { + popupWindowAttributes?: PopupWindowAttributes + scopes: string[] + tokenBodyParameters?: StringDict + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupSize.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupSize.yml new file mode 100644 index 0000000..563d077 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupSize.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: PopupSize +uid: '@azure/msal-browser.PopupSize' +package: '@azure/msal-browser' +summary: '' +fullName: PopupSize +remarks: '' +isDeprecated: false +syntax: | + type PopupSize = { height: number; width: number } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml new file mode 100644 index 0000000..573d44e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: PopupWindowAttributes +uid: '@azure/msal-browser.PopupWindowAttributes' +package: '@azure/msal-browser' +summary: Popup configurations for setting dimensions and position of popup window +fullName: PopupWindowAttributes +remarks: '' +isDeprecated: false +syntax: | + type PopupWindowAttributes = { + popupPosition?: PopupPosition + popupSize?: PopupSize + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ProtocolMode.yml b/msal/docs-ref-autogen/@azure/msal-browser/ProtocolMode.yml new file mode 100644 index 0000000..5f34e29 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ProtocolMode.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ProtocolMode +uid: '@azure/msal-browser.ProtocolMode' +package: '@azure/msal-browser' +summary: '' +fullName: ProtocolMode +remarks: '' +isDeprecated: false +syntax: | + type ProtocolMode = (typeof ProtocolMode)[keyof typeof ProtocolMode] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml new file mode 100644 index 0000000..e9ed0a8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -0,0 +1,656 @@ +### YamlMime:TSType +name: PublicClientApplication +uid: '@azure/msal-browser.PublicClientApplication' +package: '@azure/msal-browser' +summary: >- + The PublicClientApplication class is the object exposed by the library to + perform authentication and authorization functions in Single Page Applications + + to obtain JWT tokens as described in the OAuth 2.0 Authorization Code Flow + with PKCE specification. +fullName: PublicClientApplication +remarks: '' +isDeprecated: false +type: class +constructors: + - name: PublicClientApplication(Configuration, IController) + uid: '@azure/msal-browser.PublicClientApplication.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new PublicClientApplication(configuration: Configuration, controller?: + IController) + parameters: + - id: configuration + type: + description: Object for the MSAL PublicClientApplication instance + - id: controller + type: + description: '' +methods: + - name: acquireTokenByCode(AuthorizationCodeRequest) + uid: '@azure/msal-browser.PublicClientApplication.acquireTokenByCode' + package: '@azure/msal-browser' + summary: >- + This function redeems an authorization code (passed as code) from the eSTS + token endpoint. + + This authorization code should be acquired server-side using a + confidential client to acquire a spa_code. + + This API is not indended for normal authorization code acquisition and + redemption. + + + Redemption of this authorization code will not require PKCE, as it was + acquired by a confidential client. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByCode(request: AuthorizationCodeRequest): + Promise + parameters: + - id: request + type: + description: >- + [AuthorizationCodeRequest](xref:@azure/msal-browser.AuthorizationCodeRequest) + return: + description: >- + A promise that is fulfilled when this function has completed, or + rejected if an error was raised. + type: Promise<> + - name: acquireTokenPopup(PopupRequest) + uid: '@azure/msal-browser.PublicClientApplication.acquireTokenPopup' + package: '@azure/msal-browser' + summary: >- + Use when you want to obtain an access_token for your API via opening a + popup window in the user's browser + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenPopup(request: PopupRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: >- + A promise that is fulfilled when this function has completed, or + rejected if an error was raised. + type: Promise<> + - name: acquireTokenRedirect(RedirectRequest) + uid: '@azure/msal-browser.PublicClientApplication.acquireTokenRedirect' + package: '@azure/msal-browser' + summary: >- + Use when you want to obtain an access_token for your API by redirecting + the user's browser window to the authorization endpoint. This function + redirects + + the page, so any code that follows this function will not execute. + + + IMPORTANT: It is NOT recommended to have code that is dependent on the + resolution of the Promise. This function will navigate away from the + current + + browser window. It currently returns a Promise in order to reflect the + asynchronous nature of the code running in this function. + remarks: '' + isDeprecated: false + syntax: + content: 'function acquireTokenRedirect(request: RedirectRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> + - name: acquireTokenSilent(SilentRequest) + uid: '@azure/msal-browser.PublicClientApplication.acquireTokenSilent' + package: '@azure/msal-browser' + summary: >- + Silently acquire an access token for a given set of scopes. Returns + currently processing promise if parallel requests are made. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(silentRequest: SilentRequest): + Promise + parameters: + - id: silentRequest + type: + description: '' + return: + description: >- + - a promise that is fulfilled when this function has completed, or + rejected if an error was raised. Returns the + [AuthenticationResult](xref:@azure/msal-browser.AuthenticationResult) + object + type: Promise<> + - name: addEventCallback(EventCallbackFunction) + uid: '@azure/msal-browser.PublicClientApplication.addEventCallback' + package: '@azure/msal-browser' + summary: Adds event callbacks to array + remarks: '' + isDeprecated: false + syntax: + content: >- + function addEventCallback(callback: EventCallbackFunction): null | + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: null | string + - name: addPerformanceCallback(PerformanceCallbackFunction) + uid: '@azure/msal-browser.PublicClientApplication.addPerformanceCallback' + package: '@azure/msal-browser' + summary: Registers a callback to receive performance events. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addPerformanceCallback(callback: PerformanceCallbackFunction): + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: string + - name: clearCache(ClearCacheRequest) + uid: '@azure/msal-browser.PublicClientApplication.clearCache' + package: '@azure/msal-browser' + summary: Clears tokens and account from the browser cache. + remarks: '' + isDeprecated: false + syntax: + content: 'function clearCache(logoutRequest?: ClearCacheRequest): Promise' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: createPublicClientApplication(Configuration) + uid: '@azure/msal-browser.PublicClientApplication.createPublicClientApplication' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function createPublicClientApplication(configuration: + Configuration): Promise + parameters: + - id: configuration + type: + description: '' + return: + description: '' + type: >- + Promise<> + - name: disableAccountStorageEvents() + uid: '@azure/msal-browser.PublicClientApplication.disableAccountStorageEvents' + package: '@azure/msal-browser' + summary: >- + Removes event listener that emits an event when a user account is added or + removed from localstorage in a different browser tab or window + remarks: '' + isDeprecated: false + syntax: + content: function disableAccountStorageEvents() + - name: enableAccountStorageEvents() + uid: '@azure/msal-browser.PublicClientApplication.enableAccountStorageEvents' + package: '@azure/msal-browser' + summary: >- + Adds event listener that emits an event when a user account is added or + removed from localstorage in a different browser tab or window + remarks: '' + isDeprecated: false + syntax: + content: function enableAccountStorageEvents() + - name: getAccount(AccountFilter) + uid: '@azure/msal-browser.PublicClientApplication.getAccount' + package: '@azure/msal-browser' + summary: >- + Returns the first account found in the cache that matches the account + filter passed in. + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccount(accountFilter: AccountFilter): null | AccountInfo' + parameters: + - id: accountFilter + type: + description: '' + return: + description: >- + The first account found in the cache matching the provided filter or + null if no account could be found. + type: null | + - name: getAccountByHomeId(string) + uid: '@azure/msal-browser.PublicClientApplication.getAccountByHomeId' + package: '@azure/msal-browser' + summary: |- + Returns the signed in account matching homeAccountId. + (the account object is created at the time of successful login) + or null when no matching account is found + remarks: '' + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' + syntax: + content: 'function getAccountByHomeId(homeAccountId: string): null | AccountInfo' + parameters: + - id: homeAccountId + type: string + description: '' + return: + description: The account object stored in MSAL + type: null | + - name: getAccountByLocalId(string) + uid: '@azure/msal-browser.PublicClientApplication.getAccountByLocalId' + package: '@azure/msal-browser' + summary: |- + Returns the signed in account matching localAccountId. + (the account object is created at the time of successful login) + or null when no matching account is found + remarks: '' + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' + syntax: + content: 'function getAccountByLocalId(localId: string): null | AccountInfo' + parameters: + - id: localId + type: string + description: '' + return: + description: The account object stored in MSAL + type: null | + - name: getAccountByUsername(string) + uid: '@azure/msal-browser.PublicClientApplication.getAccountByUsername' + package: '@azure/msal-browser' + summary: >- + Returns the signed in account matching username. + + (the account object is created at the time of successful login) + + or null when no matching account is found. + + This API is provided for convenience but getAccountById should be used for + best reliability + remarks: '' + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' + syntax: + content: 'function getAccountByUsername(userName: string): null | AccountInfo' + parameters: + - id: userName + type: string + description: '' + return: + description: The account object stored in MSAL + type: null | + - name: getActiveAccount() + uid: '@azure/msal-browser.PublicClientApplication.getActiveAccount' + package: '@azure/msal-browser' + summary: Gets the currently active account + remarks: '' + isDeprecated: false + syntax: + content: 'function getActiveAccount(): null | AccountInfo' + return: + description: '' + type: null | + - name: getAllAccounts(AccountFilter) + uid: '@azure/msal-browser.PublicClientApplication.getAllAccounts' + package: '@azure/msal-browser' + summary: >- + Returns all the accounts in the cache that match the optional filter. If + no filter is provided, all accounts are returned. + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]' + parameters: + - id: accountFilter + type: + description: (Optional) filter to narrow down the accounts returned + return: + description: Array of AccountInfo objects in cache + type: [] + - name: getLogger() + uid: '@azure/msal-browser.PublicClientApplication.getLogger' + package: '@azure/msal-browser' + summary: Returns the logger instance + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + - name: getTokenCache() + uid: '@azure/msal-browser.PublicClientApplication.getTokenCache' + package: '@azure/msal-browser' + summary: Gets the token cache for the application. + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenCache(): ITokenCache' + return: + description: '' + type: + - name: handleRedirectPromise(string) + uid: '@azure/msal-browser.PublicClientApplication.handleRedirectPromise' + package: '@azure/msal-browser' + summary: >- + Event handler function which allows users to fire events after the + PublicClientApplication object + + has loaded during redirect flows. This should be invoked on all page loads + involved in redirect + + auth flows. + remarks: '' + isDeprecated: false + syntax: + content: >- + function handleRedirectPromise(hash?: string): Promise + parameters: + - id: hash + type: string + description: >- + Hash to process. Defaults to the current value of + window.location.hash. Only needs to be provided explicitly if the + response to be handled is not contained in the current value. + return: + description: >- + Token response or null. If the return value is null, then no auth + redirect was detected. + type: >- + Promise<null | > + - name: >- + hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | + SilentRequest | SsoSilentRequest) + uid: '@azure/msal-browser.PublicClientApplication.hydrateCache' + package: '@azure/msal-browser' + summary: >- + Hydrates cache with the tokens and account in the AuthenticationResult + object + remarks: '' + isDeprecated: false + syntax: + content: >- + function hydrateCache(result: AuthenticationResult, request: + PopupRequest | RedirectRequest | SilentRequest | SsoSilentRequest): + Promise + parameters: + - id: result + type: + description: '' + - id: request + type: >- + | | | + description: The request object that was used to obtain the AuthenticationResult + return: + description: '' + type: Promise<void> + - name: initialize() + uid: '@azure/msal-browser.PublicClientApplication.initialize' + package: '@azure/msal-browser' + summary: >- + Initializer function to perform async startup tasks such as connecting to + WAM extension + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(): Promise' + return: + description: '' + type: Promise<void> + - name: initializeWrapperLibrary(WrapperSKU, string) + uid: '@azure/msal-browser.PublicClientApplication.initializeWrapperLibrary' + package: '@azure/msal-browser' + summary: >- + Called by wrapper libraries (Angular & React) to set SKU and Version + passed down to telemetry, logger, etc. + remarks: '' + isDeprecated: false + syntax: + content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' + parameters: + - id: sku + type: WrapperSKU + description: '' + - id: version + type: string + description: '' + - name: loginPopup(PopupRequest) + uid: '@azure/msal-browser.PublicClientApplication.loginPopup' + package: '@azure/msal-browser' + summary: >- + Use when initiating the login process via opening a popup window in the + user's browser + remarks: '' + isDeprecated: false + syntax: + content: >- + function loginPopup(request?: PopupRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: >- + A promise that is fulfilled when this function has completed, or + rejected if an error was raised. + type: Promise<> + - name: loginRedirect(RedirectRequest) + uid: '@azure/msal-browser.PublicClientApplication.loginRedirect' + package: '@azure/msal-browser' + summary: >- + Use when initiating the login process by redirecting the user's browser to + the authorization endpoint. This function redirects the page, so + + any code that follows this function will not execute. + + + IMPORTANT: It is NOT recommended to have code that is dependent on the + resolution of the Promise. This function will navigate away from the + current + + browser window. It currently returns a Promise in order to reflect the + asynchronous nature of the code running in this function. + remarks: '' + isDeprecated: false + syntax: + content: 'function loginRedirect(request?: RedirectRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logout(EndSessionRequest) + uid: '@azure/msal-browser.PublicClientApplication.logout' + package: '@azure/msal-browser' + summary: Deprecated logout function. Use logoutRedirect or logoutPopup instead + remarks: '' + isDeprecated: true + customDeprecatedMessage: '' + syntax: + content: 'function logout(logoutRequest?: EndSessionRequest): Promise' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logoutPopup(EndSessionPopupRequest) + uid: '@azure/msal-browser.PublicClientApplication.logoutPopup' + package: '@azure/msal-browser' + summary: >- + Clears local cache for the current user then opens a popup window + prompting the user to sign-out of the server + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutPopup(logoutRequest?: EndSessionPopupRequest): + Promise + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logoutRedirect(EndSessionRequest) + uid: '@azure/msal-browser.PublicClientApplication.logoutRedirect' + package: '@azure/msal-browser' + summary: >- + 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`. + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutRedirect(logoutRequest?: EndSessionRequest): + Promise + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: removeEventCallback(string) + uid: '@azure/msal-browser.PublicClientApplication.removeEventCallback' + package: '@azure/msal-browser' + summary: Removes callback with provided id from callback array + remarks: '' + isDeprecated: false + syntax: + content: 'function removeEventCallback(callbackId: string)' + parameters: + - id: callbackId + type: string + description: '' + - name: removePerformanceCallback(string) + uid: '@azure/msal-browser.PublicClientApplication.removePerformanceCallback' + package: '@azure/msal-browser' + summary: Removes a callback registered with addPerformanceCallback. + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(callbackId: string): boolean' + parameters: + - id: callbackId + type: string + description: '' + return: + description: '' + type: boolean + - name: setActiveAccount(null | AccountInfo) + uid: '@azure/msal-browser.PublicClientApplication.setActiveAccount' + package: '@azure/msal-browser' + summary: >- + Sets the account to use as the active account. If no account is passed to + the acquireToken APIs, then MSAL will use this active account. + remarks: '' + isDeprecated: false + syntax: + content: 'function setActiveAccount(account: null | AccountInfo)' + parameters: + - id: account + type: null | + description: '' + - name: setLogger(Logger) + uid: '@azure/msal-browser.PublicClientApplication.setLogger' + package: '@azure/msal-browser' + summary: >- + Replaces the default logger set in configurations with new Logger with new + configurations + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: Logger instance + - name: setNavigationClient(INavigationClient) + uid: '@azure/msal-browser.PublicClientApplication.setNavigationClient' + package: '@azure/msal-browser' + summary: Sets navigation client + remarks: '' + isDeprecated: false + syntax: + content: 'function setNavigationClient(navigationClient: INavigationClient)' + parameters: + - id: navigationClient + type: + description: '' + - name: ssoSilent(SsoSilentRequest) + uid: '@azure/msal-browser.PublicClientApplication.ssoSilent' + package: '@azure/msal-browser' + summary: >- + This function uses a hidden iframe to fetch an authorization code from the + eSTS. There are cases where this may not work: + + - Any browser using a form of Intelligent Tracking Prevention + + - If there is not an established session with the service + + + In these cases, the request must be done inside a popup or full frame + redirect. + + + For the cases where interaction is required, you cannot send a request + with prompt=none. + + + If your refresh token has expired, you can use this function to fetch a + new set of tokens silently as long as + + you session on the server still exists. + remarks: '' + isDeprecated: false + syntax: + content: >- + function ssoSilent(request: SsoSilentRequest): + Promise + parameters: + - id: request + type: + description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' + return: + description: >- + A promise that is fulfilled when this function has completed, or + rejected if an error was raised. + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml new file mode 100644 index 0000000..7ac4d0a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml @@ -0,0 +1,643 @@ +### YamlMime:TSType +name: PublicClientNext +uid: '@azure/msal-browser.PublicClientNext' +package: '@azure/msal-browser' +summary: >- + PublicClientNext is an early look at the planned implementation of + PublicClientApplication in the next major version of MSAL.js. + + It contains support for multiple API implementations based on the runtime + environment that it is running in. + + + The goals of these changes are to provide a clean separation of behavior + between different operating contexts (Nested App Auth, Platform Brokers, Plain + old Browser, etc.) + + while still providing a consistent API surface for developers. +fullName: PublicClientNext +remarks: '' +isDeprecated: false +type: class +methods: + - name: acquireTokenByCode(AuthorizationCodeRequest) + uid: '@azure/msal-browser.PublicClientNext.acquireTokenByCode' + package: '@azure/msal-browser' + summary: >- + This function redeems an authorization code (passed as code) from the eSTS + token endpoint. + + This authorization code should be acquired server-side using a + confidential client to acquire a spa_code. + + This API is not indended for normal authorization code acquisition and + redemption. + + + Redemption of this authorization code will not require PKCE, as it was + acquired by a confidential client. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByCode(request: AuthorizationCodeRequest): + Promise + parameters: + - id: request + type: + description: >- + [AuthorizationCodeRequest](xref:@azure/msal-browser.AuthorizationCodeRequest) + return: + description: >- + A promise that is fulfilled when this function has completed, or + rejected if an error was raised. + type: Promise<> + - name: acquireTokenPopup(PopupRequest) + uid: '@azure/msal-browser.PublicClientNext.acquireTokenPopup' + package: '@azure/msal-browser' + summary: >- + Use when you want to obtain an access_token for your API via opening a + popup window in the user's browser + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenPopup(request: PopupRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: >- + A promise that is fulfilled when this function has completed, or + rejected if an error was raised. + type: Promise<> + - name: acquireTokenRedirect(RedirectRequest) + uid: '@azure/msal-browser.PublicClientNext.acquireTokenRedirect' + package: '@azure/msal-browser' + summary: >- + Use when you want to obtain an access_token for your API by redirecting + the user's browser window to the authorization endpoint. This function + redirects + + the page, so any code that follows this function will not execute. + + + IMPORTANT: It is NOT recommended to have code that is dependent on the + resolution of the Promise. This function will navigate away from the + current + + browser window. It currently returns a Promise in order to reflect the + asynchronous nature of the code running in this function. + remarks: '' + isDeprecated: false + syntax: + content: 'function acquireTokenRedirect(request: RedirectRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> + - name: acquireTokenSilent(SilentRequest) + uid: '@azure/msal-browser.PublicClientNext.acquireTokenSilent' + package: '@azure/msal-browser' + summary: >- + Silently acquire an access token for a given set of scopes. Returns + currently processing promise if parallel requests are made. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(silentRequest: SilentRequest): + Promise + parameters: + - id: silentRequest + type: + description: '' + return: + description: >- + - a promise that is fulfilled when this function has completed, or + rejected if an error was raised. Returns the + [AuthenticationResult](xref:@azure/msal-browser.AuthenticationResult) + object + type: Promise<> + - name: addEventCallback(EventCallbackFunction) + uid: '@azure/msal-browser.PublicClientNext.addEventCallback' + package: '@azure/msal-browser' + summary: Adds event callbacks to array + remarks: '' + isDeprecated: false + syntax: + content: >- + function addEventCallback(callback: EventCallbackFunction): null | + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: null | string + - name: addPerformanceCallback(PerformanceCallbackFunction) + uid: '@azure/msal-browser.PublicClientNext.addPerformanceCallback' + package: '@azure/msal-browser' + summary: Registers a callback to receive performance events. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addPerformanceCallback(callback: PerformanceCallbackFunction): + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: string + - name: clearCache(ClearCacheRequest) + uid: '@azure/msal-browser.PublicClientNext.clearCache' + package: '@azure/msal-browser' + summary: Clears tokens and account from the browser cache. + remarks: '' + isDeprecated: false + syntax: + content: 'function clearCache(logoutRequest?: ClearCacheRequest): Promise' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: createPublicClientApplication(Configuration) + uid: '@azure/msal-browser.PublicClientNext.createPublicClientApplication' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function createPublicClientApplication(configuration: + Configuration): Promise + parameters: + - id: configuration + type: + description: '' + return: + description: '' + type: >- + Promise<> + - name: disableAccountStorageEvents() + uid: '@azure/msal-browser.PublicClientNext.disableAccountStorageEvents' + package: '@azure/msal-browser' + summary: >- + Removes event listener that emits an event when a user account is added or + removed from localstorage in a different browser tab or window + remarks: '' + isDeprecated: false + syntax: + content: function disableAccountStorageEvents() + - name: enableAccountStorageEvents() + uid: '@azure/msal-browser.PublicClientNext.enableAccountStorageEvents' + package: '@azure/msal-browser' + summary: >- + Adds event listener that emits an event when a user account is added or + removed from localstorage in a different browser tab or window + remarks: '' + isDeprecated: false + syntax: + content: function enableAccountStorageEvents() + - name: getAccount(AccountFilter) + uid: '@azure/msal-browser.PublicClientNext.getAccount' + package: '@azure/msal-browser' + summary: >- + Returns the first account found in the cache that matches the account + filter passed in. + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccount(accountFilter: AccountFilter): null | AccountInfo' + parameters: + - id: accountFilter + type: + description: '' + return: + description: >- + The first account found in the cache matching the provided filter or + null if no account could be found. + type: null | + - name: getAccountByHomeId(string) + uid: '@azure/msal-browser.PublicClientNext.getAccountByHomeId' + package: '@azure/msal-browser' + summary: |- + Returns the signed in account matching homeAccountId. + (the account object is created at the time of successful login) + or null when no matching account is found + remarks: '' + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' + syntax: + content: 'function getAccountByHomeId(homeAccountId: string): null | AccountInfo' + parameters: + - id: homeAccountId + type: string + description: '' + return: + description: The account object stored in MSAL + type: null | + - name: getAccountByLocalId(string) + uid: '@azure/msal-browser.PublicClientNext.getAccountByLocalId' + package: '@azure/msal-browser' + summary: |- + Returns the signed in account matching localAccountId. + (the account object is created at the time of successful login) + or null when no matching account is found + remarks: '' + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' + syntax: + content: 'function getAccountByLocalId(localId: string): null | AccountInfo' + parameters: + - id: localId + type: string + description: '' + return: + description: The account object stored in MSAL + type: null | + - name: getAccountByUsername(string) + uid: '@azure/msal-browser.PublicClientNext.getAccountByUsername' + package: '@azure/msal-browser' + summary: >- + Returns the signed in account matching username. + + (the account object is created at the time of successful login) + + or null when no matching account is found. + + This API is provided for convenience but getAccountById should be used for + best reliability + remarks: '' + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' + syntax: + content: 'function getAccountByUsername(userName: string): null | AccountInfo' + parameters: + - id: userName + type: string + description: '' + return: + description: The account object stored in MSAL + type: null | + - name: getActiveAccount() + uid: '@azure/msal-browser.PublicClientNext.getActiveAccount' + package: '@azure/msal-browser' + summary: Gets the currently active account + remarks: '' + isDeprecated: false + syntax: + content: 'function getActiveAccount(): null | AccountInfo' + return: + description: '' + type: null | + - name: getAllAccounts(AccountFilter) + uid: '@azure/msal-browser.PublicClientNext.getAllAccounts' + package: '@azure/msal-browser' + summary: >- + Returns all the accounts in the cache that match the optional filter. If + no filter is provided, all accounts are returned. + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]' + parameters: + - id: accountFilter + type: + description: (Optional) filter to narrow down the accounts returned + return: + description: Array of AccountInfo objects in cache + type: [] + - name: getLogger() + uid: '@azure/msal-browser.PublicClientNext.getLogger' + package: '@azure/msal-browser' + summary: Returns the logger instance + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + - name: getTokenCache() + uid: '@azure/msal-browser.PublicClientNext.getTokenCache' + package: '@azure/msal-browser' + summary: Gets the token cache for the application. + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenCache(): ITokenCache' + return: + description: '' + type: + - name: handleRedirectPromise(string) + uid: '@azure/msal-browser.PublicClientNext.handleRedirectPromise' + package: '@azure/msal-browser' + summary: >- + Event handler function which allows users to fire events after the + PublicClientApplication object + + has loaded during redirect flows. This should be invoked on all page loads + involved in redirect + + auth flows. + remarks: '' + isDeprecated: false + syntax: + content: >- + function handleRedirectPromise(hash?: string): Promise + parameters: + - id: hash + type: string + description: >- + Hash to process. Defaults to the current value of + window.location.hash. Only needs to be provided explicitly if the + response to be handled is not contained in the current value. + return: + description: >- + Token response or null. If the return value is null, then no auth + redirect was detected. + type: >- + Promise<null | > + - name: >- + hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | + SilentRequest | SsoSilentRequest) + uid: '@azure/msal-browser.PublicClientNext.hydrateCache' + package: '@azure/msal-browser' + summary: >- + Hydrates cache with the tokens and account in the AuthenticationResult + object + remarks: '' + isDeprecated: false + syntax: + content: >- + function hydrateCache(result: AuthenticationResult, request: + PopupRequest | RedirectRequest | SilentRequest | SsoSilentRequest): + Promise + parameters: + - id: result + type: + description: '' + - id: request + type: >- + | | | + description: The request object that was used to obtain the AuthenticationResult + return: + description: '' + type: Promise<void> + - name: initialize() + uid: '@azure/msal-browser.PublicClientNext.initialize' + package: '@azure/msal-browser' + summary: >- + Initializer function to perform async startup tasks such as connecting to + WAM extension + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(): Promise' + return: + description: '' + type: Promise<void> + - name: initializeWrapperLibrary(WrapperSKU, string) + uid: '@azure/msal-browser.PublicClientNext.initializeWrapperLibrary' + package: '@azure/msal-browser' + summary: >- + Called by wrapper libraries (Angular & React) to set SKU and Version + passed down to telemetry, logger, etc. + remarks: '' + isDeprecated: false + syntax: + content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' + parameters: + - id: sku + type: WrapperSKU + description: '' + - id: version + type: string + description: '' + - name: loginPopup(PopupRequest) + uid: '@azure/msal-browser.PublicClientNext.loginPopup' + package: '@azure/msal-browser' + summary: >- + Use when initiating the login process via opening a popup window in the + user's browser + remarks: '' + isDeprecated: false + syntax: + content: >- + function loginPopup(request?: PopupRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: >- + A promise that is fulfilled when this function has completed, or + rejected if an error was raised. + type: Promise<> + - name: loginRedirect(RedirectRequest) + uid: '@azure/msal-browser.PublicClientNext.loginRedirect' + package: '@azure/msal-browser' + summary: >- + Use when initiating the login process by redirecting the user's browser to + the authorization endpoint. This function redirects the page, so + + any code that follows this function will not execute. + + + IMPORTANT: It is NOT recommended to have code that is dependent on the + resolution of the Promise. This function will navigate away from the + current + + browser window. It currently returns a Promise in order to reflect the + asynchronous nature of the code running in this function. + remarks: '' + isDeprecated: false + syntax: + content: 'function loginRedirect(request?: RedirectRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logout(EndSessionRequest) + uid: '@azure/msal-browser.PublicClientNext.logout' + package: '@azure/msal-browser' + summary: Deprecated logout function. Use logoutRedirect or logoutPopup instead + remarks: '' + isDeprecated: true + customDeprecatedMessage: '' + syntax: + content: 'function logout(logoutRequest?: EndSessionRequest): Promise' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logoutPopup(EndSessionRequest) + uid: '@azure/msal-browser.PublicClientNext.logoutPopup' + package: '@azure/msal-browser' + summary: >- + Clears local cache for the current user then opens a popup window + prompting the user to sign-out of the server + remarks: '' + isDeprecated: false + syntax: + content: 'function logoutPopup(logoutRequest?: EndSessionRequest): Promise' + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: logoutRedirect(EndSessionRequest) + uid: '@azure/msal-browser.PublicClientNext.logoutRedirect' + package: '@azure/msal-browser' + summary: >- + 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`. + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutRedirect(logoutRequest?: EndSessionRequest): + Promise + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Promise<void> + - name: removeEventCallback(string) + uid: '@azure/msal-browser.PublicClientNext.removeEventCallback' + package: '@azure/msal-browser' + summary: Removes callback with provided id from callback array + remarks: '' + isDeprecated: false + syntax: + content: 'function removeEventCallback(callbackId: string)' + parameters: + - id: callbackId + type: string + description: '' + - name: removePerformanceCallback(string) + uid: '@azure/msal-browser.PublicClientNext.removePerformanceCallback' + package: '@azure/msal-browser' + summary: Removes a callback registered with addPerformanceCallback. + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(callbackId: string): boolean' + parameters: + - id: callbackId + type: string + description: '' + return: + description: '' + type: boolean + - name: setActiveAccount(null | AccountInfo) + uid: '@azure/msal-browser.PublicClientNext.setActiveAccount' + package: '@azure/msal-browser' + summary: >- + Sets the account to use as the active account. If no account is passed to + the acquireToken APIs, then MSAL will use this active account. + remarks: '' + isDeprecated: false + syntax: + content: 'function setActiveAccount(account: null | AccountInfo)' + parameters: + - id: account + type: null | + description: '' + - name: setLogger(Logger) + uid: '@azure/msal-browser.PublicClientNext.setLogger' + package: '@azure/msal-browser' + summary: >- + Replaces the default logger set in configurations with new Logger with new + configurations + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: Logger instance + - name: setNavigationClient(INavigationClient) + uid: '@azure/msal-browser.PublicClientNext.setNavigationClient' + package: '@azure/msal-browser' + summary: Sets navigation client + remarks: '' + isDeprecated: false + syntax: + content: 'function setNavigationClient(navigationClient: INavigationClient)' + parameters: + - id: navigationClient + type: + description: '' + - name: ssoSilent(SsoSilentRequest) + uid: '@azure/msal-browser.PublicClientNext.ssoSilent' + package: '@azure/msal-browser' + summary: >- + This function uses a hidden iframe to fetch an authorization code from the + eSTS. There are cases where this may not work: + + - Any browser using a form of Intelligent Tracking Prevention + + - If there is not an established session with the service + + + In these cases, the request must be done inside a popup or full frame + redirect. + + + For the cases where interaction is required, you cannot send a request + with prompt=none. + + + If your refresh token has expired, you can use this function to fetch a + new set of tokens silently as long as + + you session on the server still exists. + remarks: '' + isDeprecated: false + syntax: + content: >- + function ssoSilent(request: SsoSilentRequest): + Promise + parameters: + - id: request + type: + description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' + return: + description: >- + A promise that is fulfilled when this function has completed, or + rejected if an error was raised. + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml new file mode 100644 index 0000000..fb98e03 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml @@ -0,0 +1,99 @@ +### YamlMime:TSTypeAlias +name: RedirectRequest +uid: '@azure/msal-browser.RedirectRequest' +package: '@azure/msal-browser' +summary: >- + RedirectRequest: Request object passed by user to retrieve a Code from the + + server (first leg of authorization code grant flow) with a full page redirect. + + + - scopes - Array of scopes the application is requesting + access to. + + - authority - Url of the authority which the application + acquires tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - 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. + + - extraScopesToConsent - Scopes for a different resource when the user + needs consent upfront. + + - state - A value included in the request that is also + returned in the token response. A randomly generated unique value is typically + used for preventing cross site request forgery attacks. The state is also used + to encode information about the user's state in the app before the + authentication request occurred. + + - prompt - Indicates the type of user interaction that is + required. + login: will force the user to enter their credentials on that request, negating single-sign on + none: will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error + consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app + select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account + create: will direct the user to the account creation experience instead of the log in experience + no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY. + - loginHint - Can be used to pre-fill the username/email + address field of the sign-in page for the user, if you know the username/email + address ahead of time. Often apps use this parameter during re-authentication, + having already extracted the username from a previous sign-in using the + login_hint or preferred_username claim. + + - sid - Session ID, unique identifier for the session. + Available as an optional claim on ID tokens. + + - domainHint - Provides a hint about the tenant or domain that + the user should use to sign in. The value of the domain hint is a registered + domain for the tenant. + + - extraQueryParameters - String to string map of custom query parameters + added to the /authorize call + + - tokenBodyParameters - String to string map of custom token request + body parameters added to the /token call. Only used when renewing access + tokens. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call + + - claims - In cases where Azure AD tenant admin has + enabled conditional access policies, and the policy has not been met, + exceptions will contain claims that need to be consented to. + + - nonce - A value included in the request that is + returned in the id token. A randomly generated unique value is typically used + to mitigate replay attacks. + + - redirectStartPage - The page that should be returned to after + loginRedirect or acquireTokenRedirect. This should only be used if this is + different from the redirectUri and will default to the page that initiates the + request. When the navigateToLoginRequestUrl config option is set to false this + parameter will be ignored. + + - onRedirectNavigate - Callback that will be passed the url that MSAL + will navigate to. Returning false in the callback will stop navigation. +fullName: RedirectRequest +remarks: '' +isDeprecated: false +syntax: | + type RedirectRequest = Partial< + Omit< + CommonAuthorizationUrlRequest, + | "responseMode" + | "scopes" + | "codeChallenge" + | "codeChallengeMethod" + | "requestedClaimsHash" + | "nativeBroker" + > + > & { + onRedirectNavigate?: (url: string) => boolean | void + redirectStartPage?: string + scopes: string[] + tokenBodyParameters?: StringDict + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml new file mode 100644 index 0000000..137c352 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml @@ -0,0 +1,208 @@ +### YamlMime:TSType +name: ServerError +uid: '@azure/msal-browser.ServerError' +package: '@azure/msal-browser' +summary: >- + Error thrown when there is an error with the server code, for example, + unavailability. +fullName: ServerError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ServerError(string, string, string) + uid: '@azure/msal-browser.ServerError.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ServerError(errorCode?: string, errorMessage?: string, subError?: + string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: subError + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-browser.ServerError.correlationId' + package: '@azure/msal-browser' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-browser.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-browser.ServerError.errorCode' + package: '@azure/msal-browser' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-browser.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-browser.ServerError.errorMessage' + package: '@azure/msal-browser' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-browser.AuthError.errorMessage) + - name: message + uid: '@azure/msal-browser.ServerError.message' + package: '@azure/msal-browser' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-browser.AuthError.message) + - name: name + uid: '@azure/msal-browser.ServerError.name' + package: '@azure/msal-browser' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-browser.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-browser.ServerError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-browser.ServerError.stack' + package: '@azure/msal-browser' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-browser.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-browser.ServerError.stackTraceLimit' + package: '@azure/msal-browser' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-browser.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-browser.ServerError.subError' + package: '@azure/msal-browser' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-browser.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-browser.ServerError.captureStackTrace' + package: '@azure/msal-browser' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-browser.ServerError.setCorrelationId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-browser.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ServerResponseType.yml b/msal/docs-ref-autogen/@azure/msal-browser/ServerResponseType.yml new file mode 100644 index 0000000..899c5b8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ServerResponseType.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: ServerResponseType +uid: '@azure/msal-browser.ServerResponseType' +package: '@azure/msal-browser' +summary: '' +fullName: ServerResponseType +remarks: '' +isDeprecated: false +syntax: | + type ServerResponseType = + (typeof ServerResponseType)[keyof typeof ServerResponseType] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml new file mode 100644 index 0000000..729a9c6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: SignedHttpRequest +uid: '@azure/msal-browser.SignedHttpRequest' +package: '@azure/msal-browser' +summary: '' +fullName: SignedHttpRequest +remarks: '' +isDeprecated: false +type: class +constructors: + - name: SignedHttpRequest(SignedHttpRequestParameters, SignedHttpRequestOptions) + uid: '@azure/msal-browser.SignedHttpRequest.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new SignedHttpRequest(shrParameters: SignedHttpRequestParameters, + shrOptions?: SignedHttpRequestOptions) + parameters: + - id: shrParameters + type: + description: '' + - id: shrOptions + type: + description: '' +methods: + - name: generatePublicKeyThumbprint() + uid: '@azure/msal-browser.SignedHttpRequest.generatePublicKeyThumbprint' + package: '@azure/msal-browser' + summary: Generates and caches a keypair for the given request options. + remarks: '' + isDeprecated: false + syntax: + content: 'function generatePublicKeyThumbprint(): Promise' + return: + description: Public key digest, which should be sent to the token issuer. + type: Promise<string> + - name: removeKeys(string) + uid: '@azure/msal-browser.SignedHttpRequest.removeKeys' + package: '@azure/msal-browser' + summary: Removes cached keys from browser for given public key thumbprint + remarks: '' + isDeprecated: false + syntax: + content: 'function removeKeys(publicKeyThumbprint: string): Promise' + parameters: + - id: publicKeyThumbprint + type: string + description: Public key digest (from generatePublicKeyThumbprint API) + return: + description: If keys are properly deleted + type: Promise<boolean> + - name: signRequest(string, string, object) + uid: '@azure/msal-browser.SignedHttpRequest.signRequest' + package: '@azure/msal-browser' + summary: Generates a signed http request for the given payload with the given key. + remarks: '' + isDeprecated: false + syntax: + content: >- + function signRequest(payload: string, publicKeyThumbprint: string, + claims?: object): Promise + parameters: + - id: payload + type: string + description: Payload to sign (e.g. access token) + - id: publicKeyThumbprint + type: string + description: Public key digest (from generatePublicKeyThumbprint API) + - id: claims + type: object + description: Additional claims to include/override in the signed JWT + return: + description: Pop token signed with the corresponding private key + type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml new file mode 100644 index 0000000..295321a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: SignedHttpRequestOptions +uid: '@azure/msal-browser.SignedHttpRequestOptions' +package: '@azure/msal-browser' +summary: '' +fullName: SignedHttpRequestOptions +remarks: '' +isDeprecated: false +syntax: | + type SignedHttpRequestOptions = { loggerOptions: LoggerOptions } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml new file mode 100644 index 0000000..5a7b46c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml @@ -0,0 +1,71 @@ +### YamlMime:TSTypeAlias +name: SilentRequest +uid: '@azure/msal-browser.SilentRequest' +package: '@azure/msal-browser' +summary: >- + SilentRequest: Request object passed by user to retrieve tokens from the + + cache, renew an expired token with a refresh token, or retrieve a code (first + leg of authorization code grant flow) + + in a hidden iframe. + + + - scopes - Array of scopes the application is requesting + access to. + + - authority - Url of the authority which the application acquires + tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - account - Account entity to lookup the credentials. + + - forceRefresh - Forces silent requests to make network calls if + true. + + - extraQueryParameters - String to string map of custom query parameters + added to the /authorize call. Only used when renewing the refresh token. + + - tokenBodyParameters - String to string map of custom token request body + parameters added to the /token call. Only used when renewing access tokens. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call. Only used when renewing access tokens. + + - 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. Only used for cases where refresh token + is expired. + + - cacheLookupPolicy - Enum of different ways the silent token can be + retrieved. + + - prompt - Indicates the type of user interaction that is + required. + none: will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error + no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY. +fullName: SilentRequest +remarks: '' +isDeprecated: false +syntax: | + type SilentRequest = Omit< + CommonSilentFlowRequest, + | "authority" + | "correlationId" + | "forceRefresh" + | "account" + | "requestedClaimsHash" + > & { + account?: AccountInfo + authority?: string + cacheLookupPolicy?: CacheLookupPolicy + correlationId?: string + extraQueryParameters?: StringDict + forceRefresh?: boolean + prompt?: string + redirectUri?: string + state?: string + tokenBodyParameters?: StringDict + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml new file mode 100644 index 0000000..41dbf43 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml @@ -0,0 +1,82 @@ +### YamlMime:TSTypeAlias +name: SsoSilentRequest +uid: '@azure/msal-browser.SsoSilentRequest' +package: '@azure/msal-browser' +summary: >- + Request object passed by user to ssoSilent to retrieve a Code from the server + (first leg of authorization code grant flow) + + + - scopes - Array of scopes the application is requesting + access to (optional for ssoSilent calls) + + - claims - A stringified claims request which will be + added to all /authorize and /token calls + + - authority - Url of the authority which the application + acquires tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - 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. + + - extraScopesToConsent - Scopes for a different resource when the user + needs consent upfront. + + - state - A value included in the request that is also + returned in the token response. A randomly generated unique value is typically + used for preventing cross site request forgery attacks. The state is also used + to encode information about the user's state in the app before the + authentication request occurred. + + - prompt - Indicates the type of user interaction that is + required. + login: will force the user to enter their credentials on that request, negating single-sign on + none: will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error + consent: will trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app + select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account + create: will direct the user to the account creation experience instead of the log in experience + no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY. + - loginHint - Can be used to pre-fill the username/email + address field of the sign-in page for the user, if you know the username/email + address ahead of time. Often apps use this parameter during re-authentication, + having already extracted the username from a previous sign-in using the + login_hint or preferred_username claim. + + - sid - Session ID, unique identifier for the session. + Available as an optional claim on ID tokens. + + - domainHint - Provides a hint about the tenant or domain that + the user should use to sign in. The value of the domain hint is a registered + domain for the tenant. + + - extraQueryParameters - String to string map of custom query parameters + added to the /authorize call + + - tokenBodyParameters - String to string map of custom token request + body parameters added to the /token call. Only used when renewing access + tokens. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call + + - nonce - A value included in the request that is + returned in the id token. A randomly generated unique value is typically used + to mitigate replay attacks. +fullName: SsoSilentRequest +remarks: '' +isDeprecated: false +syntax: | + type SsoSilentRequest = Partial< + Omit< + CommonAuthorizationUrlRequest, + | "responseMode" + | "codeChallenge" + | "codeChallengeMethod" + | "requestedClaimsHash" + | "nativeBroker" + > + > & { tokenBodyParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/StubPerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/StubPerformanceClient.yml new file mode 100644 index 0000000..26c4995 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/StubPerformanceClient.yml @@ -0,0 +1,153 @@ +### YamlMime:TSType +name: StubPerformanceClient +uid: '@azure/msal-browser.StubPerformanceClient' +package: '@azure/msal-browser' +summary: '' +fullName: StubPerformanceClient +remarks: '' +isDeprecated: false +type: class +methods: + - name: addFields() + uid: '@azure/msal-browser.StubPerformanceClient.addFields' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function addFields() + - name: addPerformanceCallback() + uid: '@azure/msal-browser.StubPerformanceClient.addPerformanceCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addPerformanceCallback(): string' + return: + description: '' + type: string + - name: addQueueMeasurement() + uid: '@azure/msal-browser.StubPerformanceClient.addQueueMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function addQueueMeasurement() + - name: cacheEventByCorrelationId() + uid: '@azure/msal-browser.StubPerformanceClient.cacheEventByCorrelationId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function cacheEventByCorrelationId() + - name: calculateQueuedTime() + uid: '@azure/msal-browser.StubPerformanceClient.calculateQueuedTime' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function calculateQueuedTime(): number' + return: + description: '' + type: number + - name: discardMeasurements() + uid: '@azure/msal-browser.StubPerformanceClient.discardMeasurements' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function discardMeasurements() + - name: emitEvents() + uid: '@azure/msal-browser.StubPerformanceClient.emitEvents' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function emitEvents() + - name: endMeasurement() + uid: '@azure/msal-browser.StubPerformanceClient.endMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function endMeasurement(): null | PerformanceEvent' + return: + description: '' + type: null | + - name: generateId() + uid: '@azure/msal-browser.StubPerformanceClient.generateId' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function generateId(): string' + return: + description: '' + type: string + - name: incrementFields() + uid: '@azure/msal-browser.StubPerformanceClient.incrementFields' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function incrementFields() + - name: removePerformanceCallback() + uid: '@azure/msal-browser.StubPerformanceClient.removePerformanceCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(): boolean' + return: + description: '' + type: boolean + - name: setPreQueueTime() + uid: '@azure/msal-browser.StubPerformanceClient.setPreQueueTime' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function setPreQueueTime() + - name: startMeasurement(string, string) + uid: '@azure/msal-browser.StubPerformanceClient.startMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: + - name: startPerformanceMeasurement() + uid: '@azure/msal-browser.StubPerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: This method will be removed in the next major version + syntax: + content: 'function startPerformanceMeasurement(): IPerformanceMeasurement' + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/TenantProfile.yml b/msal/docs-ref-autogen/@azure/msal-browser/TenantProfile.yml new file mode 100644 index 0000000..5968920 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/TenantProfile.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: TenantProfile +uid: '@azure/msal-browser.TenantProfile' +package: '@azure/msal-browser' +summary: Account details that vary across tenants for the same user +fullName: TenantProfile +remarks: '' +isDeprecated: false +syntax: | + type TenantProfile = Pick< + AccountInfo, + "tenantId" | "localAccountId" | "name" + > & { isHomeTenant?: boolean } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/UrlString.yml b/msal/docs-ref-autogen/@azure/msal-browser/UrlString.yml new file mode 100644 index 0000000..67269c6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/UrlString.yml @@ -0,0 +1,194 @@ +### YamlMime:TSType +name: UrlString +uid: '@azure/msal-browser.UrlString' +package: '@azure/msal-browser' +summary: Url object class which can perform various transformations on url strings. +fullName: UrlString +remarks: '' +isDeprecated: false +type: class +constructors: + - name: UrlString(string) + uid: '@azure/msal-browser.UrlString.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new UrlString(url: string)' + parameters: + - id: url + type: string + description: '' +properties: + - name: urlString + uid: '@azure/msal-browser.UrlString.urlString' + package: '@azure/msal-browser' + summary: '' + fullName: urlString + remarks: '' + isDeprecated: false + syntax: + content: string urlString + return: + description: '' + type: string +methods: + - name: appendQueryString(string, string) + uid: '@azure/msal-browser.UrlString.appendQueryString' + package: '@azure/msal-browser' + summary: >- + Given a url and a query string return the url with provided query string + appended + remarks: '' + isDeprecated: false + syntax: + content: >- + static function appendQueryString(url: string, queryString: string): + string + parameters: + - id: url + type: string + description: '' + - id: queryString + type: string + description: '' + return: + description: '' + type: string + - name: canonicalizeUri(string) + uid: '@azure/msal-browser.UrlString.canonicalizeUri' + package: '@azure/msal-browser' + summary: Ensure urls are lower case and end with a / character. + remarks: '' + isDeprecated: false + syntax: + content: 'static function canonicalizeUri(url: string): string' + parameters: + - id: url + type: string + description: '' + return: + description: '' + type: string + - name: constructAuthorityUriFromObject(IUri) + uid: '@azure/msal-browser.UrlString.constructAuthorityUriFromObject' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function constructAuthorityUriFromObject(urlObject: IUri): + UrlString + parameters: + - id: urlObject + type: + description: '' + return: + description: '' + type: + - name: getAbsoluteUrl(string, string) + uid: '@azure/msal-browser.UrlString.getAbsoluteUrl' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getAbsoluteUrl(relativeUrl: string, baseUrl: string): + string + parameters: + - id: relativeUrl + type: string + description: '' + - id: baseUrl + type: string + description: '' + return: + description: '' + type: string + - name: getDomainFromUrl(string) + uid: '@azure/msal-browser.UrlString.getDomainFromUrl' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function getDomainFromUrl(url: string): string' + parameters: + - id: url + type: string + description: '' + return: + description: '' + type: string + - name: getUrlComponents() + uid: '@azure/msal-browser.UrlString.getUrlComponents' + package: '@azure/msal-browser' + summary: Parses out the components from a url string. + remarks: '' + isDeprecated: false + syntax: + content: 'function getUrlComponents(): IUri' + return: + description: >- + An object with the various components. Please cache this value insted + of calling this multiple times on the same url. + type: + - name: hashContainsKnownProperties(string) + uid: '@azure/msal-browser.UrlString.hashContainsKnownProperties' + package: '@azure/msal-browser' + summary: Check if the hash of the URL string contains known properties + remarks: '' + isDeprecated: true + customDeprecatedMessage: This API will be removed in a future version + syntax: + content: 'static function hashContainsKnownProperties(response: string): boolean' + parameters: + - id: response + type: string + description: '' + return: + description: '' + type: boolean + - name: removeHashFromUrl(string) + uid: '@azure/msal-browser.UrlString.removeHashFromUrl' + package: '@azure/msal-browser' + summary: Returns a url with the hash removed + remarks: '' + isDeprecated: false + syntax: + content: 'static function removeHashFromUrl(url: string): string' + parameters: + - id: url + type: string + description: '' + return: + description: '' + type: string + - name: replaceTenantPath(string) + uid: '@azure/msal-browser.UrlString.replaceTenantPath' + package: '@azure/msal-browser' + summary: >- + Given a url like https://a:b/common/d?e=f#g, and a tenantId, returns + https://a:b/tenantId/d + remarks: '' + isDeprecated: false + syntax: + content: 'function replaceTenantPath(tenantId: string): UrlString' + parameters: + - id: tenantId + type: string + description: The tenant id to replace + return: + description: '' + type: + - name: validateAsUri() + uid: '@azure/msal-browser.UrlString.validateAsUri' + package: '@azure/msal-browser' + summary: Throws if urlString passed is not a valid authority URI string. + remarks: '' + isDeprecated: false + syntax: + content: function validateAsUri() diff --git a/msal/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml b/msal/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml new file mode 100644 index 0000000..fcdf4fa --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: WrapperSKU +uid: '@azure/msal-browser.WrapperSKU' +package: '@azure/msal-browser' +summary: '' +fullName: WrapperSKU +remarks: '' +isDeprecated: false +syntax: | + type WrapperSKU = (typeof WrapperSKU)[keyof typeof WrapperSKU] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/index.yml b/msal/docs-ref-autogen/@azure/msal-browser/index.yml new file mode 100644 index 0000000..758953b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/index.yml @@ -0,0 +1,86 @@ +### YamlMime:TSPackage +uid: '@azure/msal-browser' +name: '@azure/msal-browser' +summary: '' +type: package +enums: + - '@azure/msal-browser.InteractionType' + - '@azure/msal-browser.LogLevel' + - '@azure/msal-browser.PerformanceEvents' +classes: + - '@azure/msal-browser.AuthError' + - '@azure/msal-browser.AuthenticationHeaderParser' + - '@azure/msal-browser.BrowserAuthError' + - '@azure/msal-browser.BrowserConfigurationAuthError' + - '@azure/msal-browser.BrowserPerformanceClient' + - '@azure/msal-browser.BrowserPerformanceMeasurement' + - '@azure/msal-browser.BrowserStorage' + - '@azure/msal-browser.ClientAuthError' + - '@azure/msal-browser.ClientConfigurationError' + - '@azure/msal-browser.EventMessageUtils' + - '@azure/msal-browser.InteractionRequiredAuthError' + - '@azure/msal-browser.Logger' + - '@azure/msal-browser.MemoryStorage' + - '@azure/msal-browser.NavigationClient' + - '@azure/msal-browser.PublicClientApplication' + - '@azure/msal-browser.PublicClientNext' + - '@azure/msal-browser.ServerError' + - '@azure/msal-browser.SignedHttpRequest' + - '@azure/msal-browser.StubPerformanceClient' + - '@azure/msal-browser.UrlString' +interfaces: + - '@azure/msal-browser.IController' + - '@azure/msal-browser.ILoggerCallback' + - '@azure/msal-browser.INavigationClient' + - '@azure/msal-browser.INetworkModule' + - '@azure/msal-browser.IPerformanceClient' + - '@azure/msal-browser.IPublicClientApplication' + - '@azure/msal-browser.ITokenCache' +typeAliases: + - '@azure/msal-browser.AccountInfo' + - '@azure/msal-browser.ApiId' + - '@azure/msal-browser.AuthenticationResult' + - '@azure/msal-browser.AuthenticationScheme' + - '@azure/msal-browser.AuthorizationCodeRequest' + - '@azure/msal-browser.AuthorizationUrlRequest' + - '@azure/msal-browser.AzureCloudInstance' + - '@azure/msal-browser.AzureCloudOptions' + - '@azure/msal-browser.BrowserAuthOptions' + - '@azure/msal-browser.BrowserCacheLocation' + - '@azure/msal-browser.BrowserSystemOptions' + - '@azure/msal-browser.BrowserTelemetryOptions' + - '@azure/msal-browser.CacheLookupPolicy' + - '@azure/msal-browser.CacheOptions' + - '@azure/msal-browser.ClearCacheRequest' + - '@azure/msal-browser.Configuration' + - '@azure/msal-browser.EndSessionPopupRequest' + - '@azure/msal-browser.EndSessionRequest' + - '@azure/msal-browser.EventCallbackFunction' + - '@azure/msal-browser.EventError' + - '@azure/msal-browser.EventMessage' + - '@azure/msal-browser.EventPayload' + - '@azure/msal-browser.EventType' + - '@azure/msal-browser.ExternalTokenResponse' + - '@azure/msal-browser.IdTokenClaims' + - '@azure/msal-browser.InProgressPerformanceEvent' + - '@azure/msal-browser.InteractionStatus' + - '@azure/msal-browser.JsonWebTokenTypes' + - '@azure/msal-browser.LoadTokenOptions' + - '@azure/msal-browser.NavigationOptions' + - '@azure/msal-browser.NetworkRequestOptions' + - '@azure/msal-browser.NetworkResponse' + - '@azure/msal-browser.PerformanceCallbackFunction' + - '@azure/msal-browser.PerformanceEvent' + - '@azure/msal-browser.PopupEvent' + - '@azure/msal-browser.PopupPosition' + - '@azure/msal-browser.PopupRequest' + - '@azure/msal-browser.PopupSize' + - '@azure/msal-browser.PopupWindowAttributes' + - '@azure/msal-browser.ProtocolMode' + - '@azure/msal-browser.RedirectRequest' + - '@azure/msal-browser.ServerResponseType' + - '@azure/msal-browser.SignedHttpRequestOptions' + - '@azure/msal-browser.SilentRequest' + - '@azure/msal-browser.SsoSilentRequest' + - '@azure/msal-browser.TenantProfile' + - '@azure/msal-browser.WrapperSKU' diff --git a/msal/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml b/msal/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml new file mode 100644 index 0000000..e4082ab --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: AADAuthorityConstants +uid: '@azure/msal-common.AADAuthorityConstants' +package: '@azure/msal-common' +summary: '' +fullName: AADAuthorityConstants +remarks: '' +isDeprecated: false +syntax: | + type AADAuthorityConstants = + (typeof AADAuthorityConstants)[keyof typeof AADAuthorityConstants] diff --git a/msal/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml b/msal/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml new file mode 100644 index 0000000..d30feb3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.AADServerParamKeys' +name: AADServerParamKeys +type: module +package: '@azure/msal-common' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml new file mode 100644 index 0000000..756f004 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: AccessTokenEntity +uid: '@azure/msal-common.AccessTokenEntity' +package: '@azure/msal-common' +summary: Access token cache type +fullName: AccessTokenEntity +remarks: '' +isDeprecated: false +syntax: | + type AccessTokenEntity = CredentialEntity & { + cachedAt: string + expiresOn: string + extendedExpiresOn?: string + realm: string + refreshOn?: string + requestedClaims?: string + requestedClaimsHash?: string + target: string + tokenType?: AuthenticationScheme + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AccountFilter.yml b/msal/docs-ref-autogen/@azure/msal-common/AccountFilter.yml new file mode 100644 index 0000000..3afe3b9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AccountFilter.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: AccountFilter +uid: '@azure/msal-common.AccountFilter' +package: '@azure/msal-common' +summary: "Account:\t--" +fullName: AccountFilter +remarks: '' +isDeprecated: false +syntax: > + type AccountFilter = Omit, "idToken" | "idTokenClaims"> & + { + isHomeTenant?: boolean + loginHint?: string + realm?: string + sid?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AccountInfo.yml b/msal/docs-ref-autogen/@azure/msal-common/AccountInfo.yml new file mode 100644 index 0000000..9fdabd4 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AccountInfo.yml @@ -0,0 +1,51 @@ +### YamlMime:TSTypeAlias +name: AccountInfo +uid: '@azure/msal-common.AccountInfo' +package: '@azure/msal-common' +summary: >- + Account object with the following signature: + + - homeAccountId - Home account identifier for this account object + + - environment - Entity which issued the token represented by the + domain of the issuer (e.g. login.microsoftonline.com) + + - tenantId - Full tenant or organizational id that this account + belongs to + + - 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 + + - idToken - raw ID token + + - idTokenClaims - Object contains claims from ID token + + - nativeAccountId - The user's native account ID + + - tenantProfiles - Map of tenant profile objects for each tenant that + the account has authenticated with in the browser +fullName: AccountInfo +remarks: '' +isDeprecated: false +syntax: | + type AccountInfo = { + authorityType?: string + environment: string + homeAccountId: string + idToken?: string + idTokenClaims?: TokenClaims & { + [key: string]: string | number | string[] | object | undefined | unknown + } + localAccountId: string + name?: string + nativeAccountId?: string + tenantId: string + tenantProfiles?: Map + username: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml b/msal/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml new file mode 100644 index 0000000..882cb2b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: ActiveAccountFilters +uid: '@azure/msal-common.ActiveAccountFilters' +package: '@azure/msal-common' +summary: '' +fullName: ActiveAccountFilters +remarks: '' +isDeprecated: false +syntax: | + type ActiveAccountFilters = { + homeAccountId: string + localAccountId: string + tenantId?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml new file mode 100644 index 0000000..4ef689c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: AppMetadataEntity +uid: '@azure/msal-common.AppMetadataEntity' +package: '@azure/msal-common' +summary: App Metadata Cache Type +fullName: AppMetadataEntity +remarks: '' +isDeprecated: false +syntax: | + type AppMetadataEntity = { + clientId: string + environment: string + familyId?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml b/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml new file mode 100644 index 0000000..f7de6f0 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml @@ -0,0 +1,28 @@ +### YamlMime:TSTypeAlias +name: AppTokenProviderParameters +uid: '@azure/msal-common.AppTokenProviderParameters' +package: '@azure/msal-common' +summary: >- + Input object for the IAppTokenProvider extensiblity. MSAL will create this + object, which can be used + + to help create an AppTokenProviderResult. + + + - correlationId - the correlation Id associated with the request + + - tenantId - the tenant Id for which the token must be provided + + - scopes - the scopes for which the token must be provided + + - claims - any extra claims that the token must satisfy +fullName: AppTokenProviderParameters +remarks: '' +isDeprecated: false +syntax: | + type AppTokenProviderParameters = { + claims?: string + correlationId?: string + scopes: string[] + tenantId: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml b/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml new file mode 100644 index 0000000..2fe33e4 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml @@ -0,0 +1,26 @@ +### YamlMime:TSTypeAlias +name: AppTokenProviderResult +uid: '@azure/msal-common.AppTokenProviderResult' +package: '@azure/msal-common' +summary: >- + Output object for IAppTokenProvider extensiblity. + + + - accessToken - the actual access token, typically in JWT format, + that satisfies the request data AppTokenProviderParameters + + - expiresInSeconds - how long the tokens has before expiry, in seconds. + Similar to the "expires_in" field in an AAD token response. + + - refreshInSeconds - how long the token has before it should be + proactively refreshed. Similar to the "refresh_in" field in an AAD token + response. +fullName: AppTokenProviderResult +remarks: '' +isDeprecated: false +syntax: | + type AppTokenProviderResult = { + accessToken: string + expiresInSeconds: number + refreshInSeconds?: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ApplicationTelemetry.yml b/msal/docs-ref-autogen/@azure/msal-common/ApplicationTelemetry.yml new file mode 100644 index 0000000..f8edade --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ApplicationTelemetry.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: ApplicationTelemetry +uid: '@azure/msal-common.ApplicationTelemetry' +package: '@azure/msal-common' +summary: |- + Telemetry information sent on request + - appName: Unique string name of an application + - appVersion: Version of the application using MSAL +fullName: ApplicationTelemetry +remarks: '' +isDeprecated: false +syntax: | + type ApplicationTelemetry = { appName: string; appVersion: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthError.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthError.yml new file mode 100644 index 0000000..40a15ca --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthError.yml @@ -0,0 +1,181 @@ +### YamlMime:TSType +name: AuthError +uid: '@azure/msal-common.AuthError' +package: '@azure/msal-common' +summary: General error class thrown by the MSAL.js library. +fullName: AuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: AuthError(string, string, string) + uid: '@azure/msal-common.AuthError.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new AuthError(errorCode?: string, errorMessage?: string, suberror?: + string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: suberror + type: string + description: '' +properties: + - name: correlationId + uid: '@azure/msal-common.AuthError.correlationId' + package: '@azure/msal-common' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + - name: errorCode + uid: '@azure/msal-common.AuthError.errorCode' + package: '@azure/msal-common' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + - name: errorMessage + uid: '@azure/msal-common.AuthError.errorMessage' + package: '@azure/msal-common' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + - name: subError + uid: '@azure/msal-common.AuthError.subError' + package: '@azure/msal-common' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string +inheritedProperties: + - name: message + uid: '@azure/msal-common.AuthError.message' + package: '@azure/msal-common' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.message + - name: name + uid: '@azure/msal-common.AuthError.name' + package: '@azure/msal-common' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: '@azure/msal-common.AuthError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace + - name: stack + uid: '@azure/msal-common.AuthError.stack' + package: '@azure/msal-common' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: '@azure/msal-common.AuthError.stackTraceLimit' + package: '@azure/msal-common' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.AuthError.captureStackTrace' + package: '@azure/msal-common' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace +methods: + - name: setCorrelationId(string) + uid: '@azure/msal-common.AuthError.setCorrelationId' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' +extends: Error diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthErrorCodes.yml new file mode 100644 index 0000000..15a9aa8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.AuthErrorCodes' +name: AuthErrorCodes +type: module +package: '@azure/msal-common' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthToken.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthToken.yml new file mode 100644 index 0000000..15d0b79 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthToken.yml @@ -0,0 +1,57 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.AuthToken' +name: AuthToken +type: module +package: '@azure/msal-common' +summary: '' +functions: + - name: checkMaxAge(number, number) + uid: '@azure/msal-common.AuthToken.checkMaxAge' + package: '@azure/msal-common' + summary: Determine if the token's max_age has transpired + remarks: '' + isDeprecated: false + syntax: + content: 'function checkMaxAge(authTime: number, maxAge: number)' + parameters: + - id: authTime + type: number + description: '' + - id: maxAge + type: number + description: '' + - name: 'extractTokenClaims(string, (input: string) => string)' + uid: '@azure/msal-common.AuthToken.extractTokenClaims' + package: '@azure/msal-common' + summary: Extract token by decoding the rawToken + remarks: '' + isDeprecated: false + syntax: + content: >- + function extractTokenClaims(encodedToken: string, base64Decode: (input: + string) => string): TokenClaims + parameters: + - id: encodedToken + type: string + description: '' + - id: base64Decode + type: '(input: string) => string' + description: '' + return: + description: '' + type: + - name: getJWSPayload(string) + uid: '@azure/msal-common.AuthToken.getJWSPayload' + package: '@azure/msal-common' + summary: decode a JWT + remarks: '' + isDeprecated: false + syntax: + content: 'function getJWSPayload(authToken: string): string' + parameters: + - id: authToken + type: string + description: '' + return: + description: '' + type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml new file mode 100644 index 0000000..36d8a15 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml @@ -0,0 +1,41 @@ +### YamlMime:TSType +name: AuthenticationHeaderParser +uid: '@azure/msal-common.AuthenticationHeaderParser' +package: '@azure/msal-common' +summary: >- + This is a helper class that parses supported HTTP response authentication + headers to extract and return + + header challenge values that can be used outside the basic authorization + flows. +fullName: AuthenticationHeaderParser +remarks: '' +isDeprecated: false +type: class +constructors: + - name: AuthenticationHeaderParser(Record) + uid: '@azure/msal-common.AuthenticationHeaderParser.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new AuthenticationHeaderParser(headers: Record)' + parameters: + - id: headers + type: Record<string, string> + description: '' +methods: + - name: getShrNonce() + uid: '@azure/msal-common.AuthenticationHeaderParser.getShrNonce' + package: '@azure/msal-common' + summary: >- + This method parses the SHR nonce value out of either the + Authentication-Info or WWW-Authenticate authentication headers. + remarks: '' + isDeprecated: false + syntax: + content: 'function getShrNonce(): string' + return: + description: '' + type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml new file mode 100644 index 0000000..9a6bdbe --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml @@ -0,0 +1,67 @@ +### YamlMime:TSTypeAlias +name: AuthenticationResult +uid: '@azure/msal-common.AuthenticationResult' +package: '@azure/msal-common' +summary: >- + Result returned from the authority's token endpoint. + + - uniqueId - `oid` or `sub` claim from ID token + + - tenantId - `tid` claim from ID token + + - scopes - Scopes that are validated for the respective token + + - account - An account object representation of the currently + signed-in user + + - idToken - Id token received as part of the response + + - idTokenClaims - MSAL-relevant ID token claims + + - accessToken - Access token or SSH certificate received as part of + the response + + - fromCache - Boolean denoting whether token came from cache + + - expiresOn - Javascript Date object representing relative + expiration of access token + + - extExpiresOn - Javascript Date object representing extended + relative expiration of access token in case of server outage + + - refreshOn - Javascript Date object representing relative time + until an access token must be refreshed + + - state - Value passed in by user in request + + - familyId - Family ID identifier, usually only used for refresh + tokens + + - requestId - Request ID returned as part of the response +fullName: AuthenticationResult +remarks: '' +isDeprecated: false +syntax: | + type AuthenticationResult = { + accessToken: string + account: AccountInfo | null + authority: string + cloudGraphHostName?: string + code?: string + correlationId: string + expiresOn: Date | null + extExpiresOn?: Date + familyId?: string + fromCache: boolean + fromNativeBroker?: boolean + idToken: string + idTokenClaims: object + msGraphHost?: string + refreshOn?: Date + requestId?: string + scopes: string[] + state?: string + tenantId: string + tokenType: string + uniqueId: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml new file mode 100644 index 0000000..662d351 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: AuthenticationScheme +uid: '@azure/msal-common.AuthenticationScheme' +package: '@azure/msal-common' +summary: '' +fullName: AuthenticationScheme +remarks: '' +isDeprecated: false +syntax: | + type AuthenticationScheme = + (typeof AuthenticationScheme)[keyof typeof AuthenticationScheme] diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml new file mode 100644 index 0000000..b387adc --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.AuthorityFactory' +name: AuthorityFactory +type: module +package: '@azure/msal-common' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml new file mode 100644 index 0000000..e3849b3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: AuthorityOptions +uid: '@azure/msal-common.AuthorityOptions' +package: '@azure/msal-common' +summary: '' +fullName: AuthorityOptions +remarks: '' +isDeprecated: false +syntax: | + type AuthorityOptions = { + OIDCOptions?: OIDCOptions | null + authority?: string + authorityMetadata: string + azureRegionConfiguration?: AzureRegionConfiguration + cloudDiscoveryMetadata: string + knownAuthorities: string[] + protocolMode: ProtocolMode + skipAuthorityMetadataCache?: boolean + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorityType.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorityType.yml new file mode 100644 index 0000000..a03f9ac --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorityType.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: AuthorityType +uid: '@azure/msal-common.AuthorityType' +package: '@azure/msal-common' +summary: '' +fullName: AuthorityType +remarks: '' +isDeprecated: false +syntax: | + type AuthorityType = (typeof AuthorityType)[keyof typeof AuthorityType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml new file mode 100644 index 0000000..286f060 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: AuthorizationCodePayload +uid: '@azure/msal-common.AuthorizationCodePayload' +package: '@azure/msal-common' +summary: Response returned after processing the code response query string or fragment. +fullName: AuthorizationCodePayload +remarks: '' +isDeprecated: false +syntax: | + type AuthorizationCodePayload = { + client_info?: string + cloud_graph_host_name?: string + cloud_instance_host_name?: string + cloud_instance_name?: string + code: string + msgraph_host?: string + nonce?: string + state?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml b/msal/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml new file mode 100644 index 0000000..675b7a9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: AzureCloudInstance +uid: '@azure/msal-common.AzureCloudInstance' +package: '@azure/msal-common' +summary: '' +fullName: AzureCloudInstance +remarks: '' +isDeprecated: false +syntax: | + type AzureCloudInstance = + (typeof AzureCloudInstance)[keyof typeof AzureCloudInstance] diff --git a/msal/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml new file mode 100644 index 0000000..fad34b3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: AzureCloudOptions +uid: '@azure/msal-common.AzureCloudOptions' +package: '@azure/msal-common' +summary: >- + AzureCloudInstance specific options + + + - azureCloudInstance - string enum providing short notation for + soverign and public cloud authorities + + - tenant - provision to provide the tenant info +fullName: AzureCloudOptions +remarks: '' +isDeprecated: false +syntax: | + type AzureCloudOptions = { + azureCloudInstance: AzureCloudInstance + tenant?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AzureRegion.yml b/msal/docs-ref-autogen/@azure/msal-common/AzureRegion.yml new file mode 100644 index 0000000..c5cb5a0 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AzureRegion.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: AzureRegion +uid: '@azure/msal-common.AzureRegion' +package: '@azure/msal-common' +summary: '' +fullName: AzureRegion +remarks: '' +isDeprecated: false +syntax: | + type AzureRegion = string diff --git a/msal/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml new file mode 100644 index 0000000..d67a598 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: AzureRegionConfiguration +uid: '@azure/msal-common.AzureRegionConfiguration' +package: '@azure/msal-common' +summary: '' +fullName: AzureRegionConfiguration +remarks: '' +isDeprecated: false +syntax: | + type AzureRegionConfiguration = { + azureRegion?: AzureRegion + environmentRegion: string | undefined + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml new file mode 100644 index 0000000..ba15366 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml @@ -0,0 +1,81 @@ +### YamlMime:TSTypeAlias +name: BaseAuthRequest +uid: '@azure/msal-common.BaseAuthRequest' +package: '@azure/msal-common' +summary: >- + BaseAuthRequest + + - authority - URL of the authority, the security token service + (STS) from which MSAL will acquire tokens. Defaults to + https://login.microsoftonline.com/common. If using the same authority for all + request, authority should set on client application object and not request, to + avoid resolving authority endpoints multiple times. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - scopes - Array of scopes the application is requesting + access to. + + - authenticationScheme - The type of token retrieved. Defaults to "Bearer". + Can also be type "pop" or "SSH". + + - claims - A stringified claims request which will be added + to all /authorize and /token calls + + - shrClaims - A stringified claims object which will be added to + a Signed HTTP Request + + - shrNonce - A server-generated timestamp that has been + encrypted and base64URL encoded, which will be added to a Signed HTTP Request. + + - shrOptions - An object containing options for the Signed HTTP + Request + + - resourceRequestMethod - HTTP Request type used to request data from the + resource (i.e. "GET", "POST", etc.). Used for proof-of-possession flows. + + - resourceRequestUri - URI that token will be used for. Used for + proof-of-possession flows. + + - sshJwk - A stringified JSON Web Key representing a public + key that can be signed by an SSH certificate. + + - sshKid - Key ID that uniquely identifies the SSH public key + mentioned above. + + - azureCloudOptions - Convenience string enums for users to provide + public/sovereign cloud ids + + - requestedClaimsHash - SHA 256 hash string of the requested claims + string, used as part of an access token cache key so tokens can be filtered by + requested claims + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call + + - storeInCache - Object containing boolean values indicating + whether to store tokens in the cache or not (default is true) +fullName: BaseAuthRequest +remarks: '' +isDeprecated: false +syntax: | + type BaseAuthRequest = { + authenticationScheme?: AuthenticationScheme + authority: string + azureCloudOptions?: AzureCloudOptions + claims?: string + correlationId: string + maxAge?: number + requestedClaimsHash?: string + resourceRequestMethod?: string + resourceRequestUri?: string + scopes: string[] + shrClaims?: string + shrNonce?: string + shrOptions?: ShrOptions + sshJwk?: string + sshKid?: string + storeInCache?: StoreInCache + tokenQueryParameters?: StringDict + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml new file mode 100644 index 0000000..f113372 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: CacheAccountType +uid: '@azure/msal-common.CacheAccountType' +package: '@azure/msal-common' +summary: '' +fullName: CacheAccountType +remarks: '' +isDeprecated: false +syntax: > + type CacheAccountType = (typeof CacheAccountType)[keyof typeof + CacheAccountType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheError.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheError.yml new file mode 100644 index 0000000..a3c711d --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheError.yml @@ -0,0 +1,139 @@ +### YamlMime:TSType +name: CacheError +uid: '@azure/msal-common.CacheError' +package: '@azure/msal-common' +summary: Error thrown when there is an error with the cache +fullName: CacheError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: CacheError(string, string) + uid: '@azure/msal-common.CacheError.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new CacheError(errorCode: string, errorMessage?: string)' + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' +properties: + - name: errorCode + uid: '@azure/msal-common.CacheError.errorCode' + package: '@azure/msal-common' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + - name: errorMessage + uid: '@azure/msal-common.CacheError.errorMessage' + package: '@azure/msal-common' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string +inheritedProperties: + - name: message + uid: '@azure/msal-common.CacheError.message' + package: '@azure/msal-common' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.message + - name: name + uid: '@azure/msal-common.CacheError.name' + package: '@azure/msal-common' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: '@azure/msal-common.CacheError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace + - name: stack + uid: '@azure/msal-common.CacheError.stack' + package: '@azure/msal-common' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: '@azure/msal-common.CacheError.stackTraceLimit' + package: '@azure/msal-common' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.CacheError.captureStackTrace' + package: '@azure/msal-common' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace +extends: Error diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheErrorCodes.yml new file mode 100644 index 0000000..dca32e9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.CacheErrorCodes' +name: CacheErrorCodes +type: module +package: '@azure/msal-common' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheHelpers.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheHelpers.yml new file mode 100644 index 0000000..d2dd760 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheHelpers.yml @@ -0,0 +1,394 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.CacheHelpers' +name: CacheHelpers +type: module +package: '@azure/msal-common' +summary: '' +functions: + - name: >- + createAccessTokenEntity(string, string, string, string, string, string, + number, number, (input: string) => string, number, AuthenticationScheme, + string, string, string, string) + uid: '@azure/msal-common.CacheHelpers.createAccessTokenEntity' + package: '@azure/msal-common' + summary: Create AccessTokenEntity + remarks: '' + isDeprecated: false + syntax: + content: >- + function createAccessTokenEntity(homeAccountId: string, environment: + string, accessToken: string, clientId: string, tenantId: string, scopes: + string, expiresOn: number, extExpiresOn: number, base64Decode: (input: + string) => string, refreshOn?: number, tokenType?: AuthenticationScheme, + userAssertionHash?: string, keyId?: string, requestedClaims?: string, + requestedClaimsHash?: string): AccessTokenEntity + parameters: + - id: homeAccountId + type: string + description: '' + - id: environment + type: string + description: '' + - id: accessToken + type: string + description: '' + - id: clientId + type: string + description: '' + - id: tenantId + type: string + description: '' + - id: scopes + type: string + description: '' + - id: expiresOn + type: number + description: '' + - id: extExpiresOn + type: number + description: '' + - id: base64Decode + type: '(input: string) => string' + description: '' + - id: refreshOn + type: number + description: '' + - id: tokenType + type: AuthenticationScheme + description: '' + - id: userAssertionHash + type: string + description: '' + - id: keyId + type: string + description: '' + - id: requestedClaims + type: string + description: '' + - id: requestedClaimsHash + type: string + description: '' + return: + description: '' + type: + - name: createIdTokenEntity(string, string, string, string, string) + uid: '@azure/msal-common.CacheHelpers.createIdTokenEntity' + package: '@azure/msal-common' + summary: Create IdTokenEntity + remarks: '' + isDeprecated: false + syntax: + content: >- + function createIdTokenEntity(homeAccountId: string, environment: string, + idToken: string, clientId: string, tenantId: string): IdTokenEntity + parameters: + - id: homeAccountId + type: string + description: '' + - id: environment + type: string + description: '' + - id: idToken + type: string + description: '' + - id: clientId + type: string + description: '' + - id: tenantId + type: string + description: '' + return: + description: '' + type: + - name: >- + createRefreshTokenEntity(string, string, string, string, string, string, + number) + uid: '@azure/msal-common.CacheHelpers.createRefreshTokenEntity' + package: '@azure/msal-common' + summary: Create RefreshTokenEntity + remarks: '' + isDeprecated: false + syntax: + content: >- + function createRefreshTokenEntity(homeAccountId: string, environment: + string, refreshToken: string, clientId: string, familyId?: string, + userAssertionHash?: string, expiresOn?: number): RefreshTokenEntity + parameters: + - id: homeAccountId + type: string + description: '' + - id: environment + type: string + description: '' + - id: refreshToken + type: string + description: '' + - id: clientId + type: string + description: '' + - id: familyId + type: string + description: '' + - id: userAssertionHash + type: string + description: '' + - id: expiresOn + type: number + description: '' + return: + description: '' + type: + - name: generateAppMetadataKey(AppMetadataEntity) + uid: '@azure/msal-common.CacheHelpers.generateAppMetadataKey' + package: '@azure/msal-common' + summary: >- + Generate AppMetadata Cache Key as per the schema: + appmetadata-- + remarks: '' + isDeprecated: false + syntax: + content: >- + function generateAppMetadataKey(__namedParameters: AppMetadataEntity): + string + parameters: + - id: __namedParameters + type: + description: '' + return: + description: '' + type: string + - name: generateAuthorityMetadataExpiresAt() + uid: '@azure/msal-common.CacheHelpers.generateAuthorityMetadataExpiresAt' + package: '@azure/msal-common' + summary: Reset the exiresAt value + remarks: '' + isDeprecated: false + syntax: + content: 'function generateAuthorityMetadataExpiresAt(): number' + return: + description: '' + type: number + - name: generateCredentialKey(CredentialEntity) + uid: '@azure/msal-common.CacheHelpers.generateCredentialKey' + package: '@azure/msal-common' + summary: >- + Cache Key: ------- + + IdToken Example: + uid.utid-login.microsoftonline.com-idtoken-app_client_id-contoso.com + + AccessToken Example: + uid.utid-login.microsoftonline.com-accesstoken-app_client_id-contoso.com-scope1 + scope2--pop + + RefreshToken Example: + uid.utid-login.microsoftonline.com-refreshtoken-1-contoso.com + remarks: '' + isDeprecated: false + syntax: + content: >- + function generateCredentialKey(credentialEntity: CredentialEntity): + string + parameters: + - id: credentialEntity + type: + description: '' + return: + description: '' + type: string + - name: isAccessTokenEntity(object) + uid: '@azure/msal-common.CacheHelpers.isAccessTokenEntity' + package: '@azure/msal-common' + summary: 'Validates an entity: checks for all expected params' + remarks: '' + isDeprecated: false + syntax: + content: 'function isAccessTokenEntity(entity: object): boolean' + parameters: + - id: entity + type: object + description: '' + return: + description: '' + type: boolean + - name: isAppMetadataEntity(string, object) + uid: '@azure/msal-common.CacheHelpers.isAppMetadataEntity' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function isAppMetadataEntity(key: string, entity: object): boolean' + parameters: + - id: key + type: string + description: '' + - id: entity + type: object + description: '' + return: + description: '' + type: boolean + - name: isAuthorityMetadataEntity(string, object) + uid: '@azure/msal-common.CacheHelpers.isAuthorityMetadataEntity' + package: '@azure/msal-common' + summary: 'Validates an entity: checks for all expected params' + remarks: '' + isDeprecated: false + syntax: + content: 'function isAuthorityMetadataEntity(key: string, entity: object): boolean' + parameters: + - id: key + type: string + description: '' + - id: entity + type: object + description: '' + return: + description: '' + type: boolean + - name: isAuthorityMetadataExpired(AuthorityMetadataEntity) + uid: '@azure/msal-common.CacheHelpers.isAuthorityMetadataExpired' + package: '@azure/msal-common' + summary: Returns whether or not the data needs to be refreshed + remarks: '' + isDeprecated: false + syntax: + content: >- + function isAuthorityMetadataExpired(metadata: AuthorityMetadataEntity): + boolean + parameters: + - id: metadata + type: AuthorityMetadataEntity + description: '' + return: + description: '' + type: boolean + - name: isCredentialEntity(object) + uid: '@azure/msal-common.CacheHelpers.isCredentialEntity' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function isCredentialEntity(entity: object): boolean' + parameters: + - id: entity + type: object + description: '' + return: + description: '' + type: boolean + - name: isIdTokenEntity(object) + uid: '@azure/msal-common.CacheHelpers.isIdTokenEntity' + package: '@azure/msal-common' + summary: 'Validates an entity: checks for all expected params' + remarks: '' + isDeprecated: false + syntax: + content: 'function isIdTokenEntity(entity: object): boolean' + parameters: + - id: entity + type: object + description: '' + return: + description: '' + type: boolean + - name: isRefreshTokenEntity(object) + uid: '@azure/msal-common.CacheHelpers.isRefreshTokenEntity' + package: '@azure/msal-common' + summary: 'Validates an entity: checks for all expected params' + remarks: '' + isDeprecated: false + syntax: + content: 'function isRefreshTokenEntity(entity: object): boolean' + parameters: + - id: entity + type: object + description: '' + return: + description: '' + type: boolean + - name: isServerTelemetryEntity(string, object) + uid: '@azure/msal-common.CacheHelpers.isServerTelemetryEntity' + package: '@azure/msal-common' + summary: validates if a given cache entry is "Telemetry", parses + remarks: '' + isDeprecated: false + syntax: + content: 'function isServerTelemetryEntity(key: string, entity?: object): boolean' + parameters: + - id: key + type: string + description: '' + - id: entity + type: object + description: '' + return: + description: '' + type: boolean + - name: isThrottlingEntity(string, object) + uid: '@azure/msal-common.CacheHelpers.isThrottlingEntity' + package: '@azure/msal-common' + summary: validates if a given cache entry is "Throttling", parses + remarks: '' + isDeprecated: false + syntax: + content: 'function isThrottlingEntity(key: string, entity?: object): boolean' + parameters: + - id: key + type: string + description: '' + - id: entity + type: object + description: '' + return: + description: '' + type: boolean + - name: >- + updateAuthorityEndpointMetadata(AuthorityMetadataEntity, + OpenIdConfigResponse, boolean) + uid: '@azure/msal-common.CacheHelpers.updateAuthorityEndpointMetadata' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateAuthorityEndpointMetadata(authorityMetadata: + AuthorityMetadataEntity, updatedValues: OpenIdConfigResponse, + fromNetwork: boolean) + parameters: + - id: authorityMetadata + type: AuthorityMetadataEntity + description: '' + - id: updatedValues + type: OpenIdConfigResponse + description: '' + - id: fromNetwork + type: boolean + description: '' + - name: >- + updateCloudDiscoveryMetadata(AuthorityMetadataEntity, + CloudDiscoveryMetadata, boolean) + uid: '@azure/msal-common.CacheHelpers.updateCloudDiscoveryMetadata' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateCloudDiscoveryMetadata(authorityMetadata: + AuthorityMetadataEntity, updatedValues: CloudDiscoveryMetadata, + fromNetwork: boolean) + parameters: + - id: authorityMetadata + type: AuthorityMetadataEntity + description: '' + - id: updatedValues + type: CloudDiscoveryMetadata + description: '' + - id: fromNetwork + type: boolean + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheOptions.yml new file mode 100644 index 0000000..2ed15f9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheOptions.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: CacheOptions +uid: '@azure/msal-common.CacheOptions' +package: '@azure/msal-common' +summary: >- + Use this to configure credential cache preferences in the ClientConfiguration + object + + + - claimsBasedCachingEnabled - Sets whether tokens should be cached based on + the claims hash. Default is false. +fullName: CacheOptions +remarks: '' +isDeprecated: false +syntax: | + type CacheOptions = { claimsBasedCachingEnabled?: boolean } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml new file mode 100644 index 0000000..e6f2c7e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: CacheOutcome +uid: '@azure/msal-common.CacheOutcome' +package: '@azure/msal-common' +summary: '' +fullName: CacheOutcome +remarks: '' +isDeprecated: false +syntax: | + type CacheOutcome = (typeof CacheOutcome)[keyof typeof CacheOutcome] diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheType.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheType.yml new file mode 100644 index 0000000..1af0175 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheType.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: CacheType +uid: '@azure/msal-common.CacheType' +package: '@azure/msal-common' +summary: '' +fullName: CacheType +remarks: '' +isDeprecated: false +syntax: | + type CacheType = (typeof CacheType)[keyof typeof CacheType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/CcsCredential.yml b/msal/docs-ref-autogen/@azure/msal-common/CcsCredential.yml new file mode 100644 index 0000000..0443e46 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CcsCredential.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: CcsCredential +uid: '@azure/msal-common.CcsCredential' +package: '@azure/msal-common' +summary: '' +fullName: CcsCredential +remarks: '' +isDeprecated: false +syntax: | + type CcsCredential = { credential: string; type: CcsCredentialType } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml b/msal/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml new file mode 100644 index 0000000..3377d03 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: CcsCredentialType +uid: '@azure/msal-common.CcsCredentialType' +package: '@azure/msal-common' +summary: '' +fullName: CcsCredentialType +remarks: '' +isDeprecated: false +syntax: | + type CcsCredentialType = + (typeof CcsCredentialType)[keyof typeof CcsCredentialType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml b/msal/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml new file mode 100644 index 0000000..d083ca2 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: ClaimsRequestKeys +uid: '@azure/msal-common.ClaimsRequestKeys' +package: '@azure/msal-common' +summary: '' +fullName: ClaimsRequestKeys +remarks: '' +isDeprecated: false +syntax: | + type ClaimsRequestKeys = + (typeof ClaimsRequestKeys)[keyof typeof ClaimsRequestKeys] diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml new file mode 100644 index 0000000..1580dd6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ClientAssertion +uid: '@azure/msal-common.ClientAssertion' +package: '@azure/msal-common' +summary: Client Assertion credential for Confidential Clients +fullName: ClientAssertion +remarks: '' +isDeprecated: false +syntax: | + type ClientAssertion = { assertion: string; assertionType: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml new file mode 100644 index 0000000..918fc5a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml @@ -0,0 +1,201 @@ +### YamlMime:TSType +name: ClientAuthError +uid: '@azure/msal-common.ClientAuthError' +package: '@azure/msal-common' +summary: Error thrown when there is an error in the client code running on the browser. +fullName: ClientAuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ClientAuthError(string, string) + uid: '@azure/msal-common.ClientAuthError.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ClientAuthError(errorCode: string, additionalMessage?: string)' + parameters: + - id: errorCode + type: string + description: '' + - id: additionalMessage + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-common.ClientAuthError.correlationId' + package: '@azure/msal-common' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-common.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-common.ClientAuthError.errorCode' + package: '@azure/msal-common' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-common.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-common.ClientAuthError.errorMessage' + package: '@azure/msal-common' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-common.AuthError.errorMessage) + - name: message + uid: '@azure/msal-common.ClientAuthError.message' + package: '@azure/msal-common' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-common.AuthError.message) + - name: name + uid: '@azure/msal-common.ClientAuthError.name' + package: '@azure/msal-common' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-common.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-common.ClientAuthError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-common.ClientAuthError.stack' + package: '@azure/msal-common' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-common.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-common.ClientAuthError.stackTraceLimit' + package: '@azure/msal-common' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-common.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-common.ClientAuthError.subError' + package: '@azure/msal-common' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-common.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.ClientAuthError.captureStackTrace' + package: '@azure/msal-common' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-common.ClientAuthError.setCorrelationId' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientAuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAuthErrorCodes.yml new file mode 100644 index 0000000..216ec5a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.ClientAuthErrorCodes' +name: ClientAuthErrorCodes +type: module +package: '@azure/msal-common' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml new file mode 100644 index 0000000..c6018f8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml @@ -0,0 +1,198 @@ +### YamlMime:TSType +name: ClientConfigurationError +uid: '@azure/msal-common.ClientConfigurationError' +package: '@azure/msal-common' +summary: Error thrown when there is an error in configuration of the MSAL.js library. +fullName: ClientConfigurationError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ClientConfigurationError(string) + uid: '@azure/msal-common.ClientConfigurationError.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ClientConfigurationError(errorCode: string)' + parameters: + - id: errorCode + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-common.ClientConfigurationError.correlationId' + package: '@azure/msal-common' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-common.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-common.ClientConfigurationError.errorCode' + package: '@azure/msal-common' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-common.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-common.ClientConfigurationError.errorMessage' + package: '@azure/msal-common' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-common.AuthError.errorMessage) + - name: message + uid: '@azure/msal-common.ClientConfigurationError.message' + package: '@azure/msal-common' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-common.AuthError.message) + - name: name + uid: '@azure/msal-common.ClientConfigurationError.name' + package: '@azure/msal-common' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-common.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-common.ClientConfigurationError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-common.ClientConfigurationError.stack' + package: '@azure/msal-common' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-common.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-common.ClientConfigurationError.stackTraceLimit' + package: '@azure/msal-common' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-common.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-common.ClientConfigurationError.subError' + package: '@azure/msal-common' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-common.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.ClientConfigurationError.captureStackTrace' + package: '@azure/msal-common' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-common.ClientConfigurationError.setCorrelationId' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationErrorCodes.yml new file mode 100644 index 0000000..8a0745f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.ClientConfigurationErrorCodes' +name: ClientConfigurationErrorCodes +type: module +package: '@azure/msal-common' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientInfo.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientInfo.yml new file mode 100644 index 0000000..278dc1f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientInfo.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ClientInfo +uid: '@azure/msal-common.ClientInfo' +package: '@azure/msal-common' +summary: Client info object which consists of two IDs. Need to add more info here. +fullName: ClientInfo +remarks: '' +isDeprecated: false +syntax: | + type ClientInfo = { uid: string; utid: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml new file mode 100644 index 0000000..f27f952 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml @@ -0,0 +1,61 @@ +### YamlMime:TSTypeAlias +name: CommonAuthorizationCodeRequest +uid: '@azure/msal-common.CommonAuthorizationCodeRequest' +package: '@azure/msal-common' +summary: >- + Request object passed by user to acquire a token from the server exchanging a + valid authorization code (second leg of OAuth2.0 Authorization Code flow) + + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be added + to all /authorize and /token calls + + - authority: - URL of the authority, the security token service + (STS) from which MSAL will acquire tokens. If authority is set on client + application object, this will override that value. Overriding the value will + cause for authority validation to happen each time. If the same authority will + be used for all request, set on the application object instead of the + requests. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - redirectUri - The redirect URI of your app, where the authority + will redirect to after the user inputs credentials and consents. It must + exactly match one of the redirect URIs you registered in the portal + + - code - The authorization_code that the user acquired in + the first leg of the flow. + + - codeVerifier - The same code_verifier that was used to obtain the + authorization_code. Required if PKCE was used in the authorization code grant + request.For more information, see the PKCE RFC: + https://tools.ietf.org/html/rfc7636 + + - resourceRequestMethod - HTTP Request type used to request data from the + resource (i.e. "GET", "POST", etc.). Used for proof-of-possession flows. + + - resourceRequestUri - URI that token will be used for. Used for + proof-of-possession flows. + + - enableSpaAuthCode - Enables the acqusition of a spa authorization code + (confidential clients only) + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call +fullName: CommonAuthorizationCodeRequest +remarks: '' +isDeprecated: false +syntax: | + type CommonAuthorizationCodeRequest = BaseAuthRequest & { + ccsCredential?: CcsCredential + clientInfo?: string + code: string + codeVerifier?: string + enableSpaAuthorizationCode?: boolean + redirectUri: string + tokenBodyParameters?: StringDict + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml new file mode 100644 index 0000000..e61243c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml @@ -0,0 +1,107 @@ +### YamlMime:TSTypeAlias +name: CommonAuthorizationUrlRequest +uid: '@azure/msal-common.CommonAuthorizationUrlRequest' +package: '@azure/msal-common' +summary: >- + Request object passed by user to retrieve a Code from the server (first leg of + authorization code grant flow) + + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be + added to all /authorize and /token calls + + - authority - Url of the authority which the application + acquires tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - 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. + + - extraScopesToConsent - Scopes for a different resource when the user + needs consent upfront. + + - responseMode - Specifies the method that should be used to + send the authentication result to your app. Can be query, form_post, or + fragment. If no value is passed in, it defaults to query. + + - codeChallenge - Used to secure authorization code grant via + Proof of Key for Code Exchange (PKCE). For more information, see the PKCE + RCF:https://tools.ietf.org/html/rfc7636 + + - codeChallengeMethod - The method used to encode the code verifier for + the code challenge parameter. Can be "plain" or "S256". If excluded, code + challenge is assumed to be plaintext. For more information, see the PKCE RCF: + https://tools.ietf.org/html/rfc7636 + + - state - A value included in the request that is also + returned in the token response. A randomly generated unique value is typically + used for preventing cross site request forgery attacks. The state is also used + to encode information about the user's state in the app before the + authentication request occurred. + + - prompt - Indicates the type of user interaction that is + required. + login: will force the user to enter their credentials on that request, negating single-sign on + none: will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error + consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app + select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account + create: will direct the user to the account creation experience instead of the log in experience + no_session: will not read existing session token when authenticating the user. Upon user being successfully authenticated, EVO won’t create a new session for the user. FOR INTERNAL USE ONLY. + - account - AccountInfo obtained from a getAccount API. + Will be used in certain scenarios to generate login_hint if both loginHint and + sid params are not provided. + + - loginHint - Can be used to pre-fill the username/email + address field of the sign-in page for the user, if you know the username/email + address ahead of time. Often apps use this parameter during re-authentication, + having already extracted the username from a previous sign-in using the + preferred_username claim. + + - sid - Session ID, unique identifier for the session. + Available as an optional claim on ID tokens. + + - domainHint - Provides a hint about the tenant or domain that + the user should use to sign in. The value of the domain hint is a registered + domain for the tenant. + + - extraQueryParameters - String to string map of custom query parameters + added to the /authorize call + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call + + - nonce - A value included in the request that is + returned in the id token. A randomly generated unique value is typically used + to mitigate replay attacks. + + - resourceRequestMethod - HTTP Request type used to request data from the + resource (i.e. "GET", "POST", etc.). Used for proof-of-possession flows. + + - resourceRequestUri - URI that token will be used for. Used for + proof-of-possession flows. +fullName: CommonAuthorizationUrlRequest +remarks: '' +isDeprecated: false +syntax: | + type CommonAuthorizationUrlRequest = BaseAuthRequest & { + account?: AccountInfo + codeChallenge?: string + codeChallengeMethod?: string + domainHint?: string + extraQueryParameters?: StringDict + extraScopesToConsent?: string[] + loginHint?: string + nativeBroker?: boolean + nonce?: string + prompt?: string + redirectUri: string + responseMode: ResponseMode + sid?: string + state?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml new file mode 100644 index 0000000..53e2874 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml @@ -0,0 +1,33 @@ +### YamlMime:TSTypeAlias +name: CommonClientCredentialRequest +uid: '@azure/msal-common.CommonClientCredentialRequest' +package: '@azure/msal-common' +summary: >- + CommonClientCredentialRequest + + - 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. + + - skipCache - Skip token cache lookup and force + request to authority to get a a new token. Defaults to false. + + - preferredAzureRegionOptions - Options of the user's preferred azure + region + + - tokenQueryParameters - String to string map of custom query + parameters added to the /token call +fullName: CommonClientCredentialRequest +remarks: '' +isDeprecated: false +syntax: | + type CommonClientCredentialRequest = BaseAuthRequest & { + azureRegion?: AzureRegion + clientAssertion?: ClientAssertion + skipCache?: boolean + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml new file mode 100644 index 0000000..77bc1e1 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml @@ -0,0 +1,55 @@ +### YamlMime:TSTypeAlias +name: CommonDeviceCodeRequest +uid: '@azure/msal-common.CommonDeviceCodeRequest' +package: '@azure/msal-common' +summary: >- + Parameters for Oauth2 device code flow. + + - 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. If authority is set on + client application object, this will override that value. Overriding the value + will cause for authority validation to happen each time. If the same authority + will be used for all request, set on the application object instead of the + requests. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - deviceCodeCallback - Callback containing device code response. + Message should be shown to end user. End user can then navigate to the + verification_uri, input the user_code, and input credentials. + + - cancel - Boolean to cancel polling of device code + endpoint. While the user authenticates on a separate device, MSAL polls the + the token endpoint of security token service for the interval specified in the + device code response (usually 15 minutes). To stop polling and cancel the + request, set cancel=true. + + - resourceRequestMethod - HTTP Request type used to request data from the + resource (i.e. "GET", "POST", etc.). Used for proof-of-possession flows. + + - resourceRequestUri - URI that token will be used for. Used for + proof-of-possession flows. + + - timeout - Timeout period in seconds which the user + explicitly configures for the polling of the device code endpoint. At the end + of this period; assuming the device code has not expired yet; the device code + polling is stopped and the request cancelled. The device code expiration + window will always take precedence over this set period. + + - extraQueryParameters - String to string map of custom query parameters + added to the query string +fullName: CommonDeviceCodeRequest +remarks: '' +isDeprecated: false +syntax: > + type CommonDeviceCodeRequest = Omit & + { + cancel?: boolean + deviceCodeCallback: (response: DeviceCodeResponse) => void + extraQueryParameters?: StringDict + timeout?: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml new file mode 100644 index 0000000..fb5fc2f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml @@ -0,0 +1,40 @@ +### YamlMime:TSTypeAlias +name: CommonEndSessionRequest +uid: '@azure/msal-common.CommonEndSessionRequest' +package: '@azure/msal-common' +summary: >- + CommonEndSessionRequest + + - 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. + + - 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 + + - state - A value included in the request to the logout + endpoint which will be returned in the query string upon post logout + redirection + + - logoutHint - A string that specifies the account that is being + logged out in order to skip the server account picker on logout + + - extraQueryParameters - String to string map of custom query parameters + added to the /authorize call +fullName: CommonEndSessionRequest +remarks: '' +isDeprecated: false +syntax: | + type CommonEndSessionRequest = { + account?: AccountInfo | null + correlationId: string + extraQueryParameters?: StringDict + idTokenHint?: string + logoutHint?: string + postLogoutRedirectUri?: string | null + state?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml new file mode 100644 index 0000000..658e444 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml @@ -0,0 +1,30 @@ +### YamlMime:TSTypeAlias +name: CommonOnBehalfOfRequest +uid: '@azure/msal-common.CommonOnBehalfOfRequest' +package: '@azure/msal-common' +summary: >- + - 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. + + - oboAssertion - The access token that was sent to the middle-tier + API. This token must have an audience of the app making this OBO request. + + - skipCache - Skip token cache lookup and force request to + authority to get a a new token. Defaults to false. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call +fullName: CommonOnBehalfOfRequest +remarks: '' +isDeprecated: false +syntax: | + type CommonOnBehalfOfRequest = BaseAuthRequest & { + oboAssertion: string + skipCache?: boolean + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml new file mode 100644 index 0000000..0626320 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml @@ -0,0 +1,44 @@ +### YamlMime:TSTypeAlias +name: CommonRefreshTokenRequest +uid: '@azure/msal-common.CommonRefreshTokenRequest' +package: '@azure/msal-common' +summary: >- + CommonRefreshTokenRequest + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be added + to all /authorize and /token calls + + - 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. + + - refreshToken - A refresh token returned from a previous request + to the Identity provider. + + - resourceRequestMethod - HTTP Request type used to request data from the + resource (i.e. "GET", "POST", etc.). Used for proof-of-possession flows. + + - resourceRequestUri - URI that token will be used for. Used for + proof-of-possession flows. + + - forceCache - Force MSAL to cache a refresh token flow response + when there is no account in the cache. Used for migration scenarios. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call +fullName: CommonRefreshTokenRequest +remarks: '' +isDeprecated: false +syntax: | + type CommonRefreshTokenRequest = BaseAuthRequest & { + ccsCredential?: CcsCredential + forceCache?: boolean + redirectUri?: string + refreshToken: string + tokenBodyParameters?: StringDict + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml new file mode 100644 index 0000000..f5da28e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml @@ -0,0 +1,44 @@ +### YamlMime:TSTypeAlias +name: CommonSilentFlowRequest +uid: '@azure/msal-common.CommonSilentFlowRequest' +package: '@azure/msal-common' +summary: >- + SilentFlow parameters passed by the user to retrieve credentials silently + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be added to + all /authorize and /token calls. When included on a silent request, cache + lookup will be skipped and token will be refreshed. + + - authority - Url of the authority which the application acquires + tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - account - Account entity to lookup the credentials. + + - forceRefresh - Forces silent requests to make network calls if + true. + + - resourceRequestMethod - HTTP Request type used to request data from the + resource (i.e. "GET", "POST", etc.). Used for proof-of-possession flows. + + - resourceRequestUri - URI that token will be used for. Used for + proof-of-possession flows. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call +fullName: CommonSilentFlowRequest +remarks: '' +isDeprecated: false +syntax: | + type CommonSilentFlowRequest = BaseAuthRequest & { + account: AccountInfo + forceRefresh: boolean + redirectUri?: string + refreshTokenExpirationOffsetSeconds?: number + tokenBodyParameters?: StringDict + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml new file mode 100644 index 0000000..414476b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml @@ -0,0 +1,38 @@ +### YamlMime:TSTypeAlias +name: CommonUsernamePasswordRequest +uid: '@azure/msal-common.CommonUsernamePasswordRequest' +package: '@azure/msal-common' +summary: >- + CommonUsernamePassword parameters passed by the user to retrieve credentials + + Note: The latest OAuth 2.0 Security Best Current Practice disallows the + password grant entirely. This flow is added for internal testing. + + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be added to + all /authorize and /token calls. When included on a silent request, cache + lookup will be skipped and token will be refreshed. + + - authority - Url of the authority which the application acquires + tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - username - username of the client + + - password - credentials + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call +fullName: CommonUsernamePasswordRequest +remarks: '' +isDeprecated: false +syntax: | + type CommonUsernamePasswordRequest = BaseAuthRequest & { + password: string + username: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml new file mode 100644 index 0000000..232ad70 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml @@ -0,0 +1,23 @@ +### YamlMime:TSTypeAlias +name: CredentialEntity +uid: '@azure/msal-common.CredentialEntity' +package: '@azure/msal-common' +summary: Credential Cache Type +fullName: CredentialEntity +remarks: '' +isDeprecated: false +syntax: | + type CredentialEntity = { + clientId: string + credentialType: CredentialType + environment: string + familyId?: string + homeAccountId: string + keyId?: string + realm?: string + requestedClaimsHash?: string + secret: string + target?: string + tokenType?: AuthenticationScheme + userAssertionHash?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml b/msal/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml new file mode 100644 index 0000000..c3fb0a6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml @@ -0,0 +1,24 @@ +### YamlMime:TSTypeAlias +name: CredentialFilter +uid: '@azure/msal-common.CredentialFilter' +package: '@azure/msal-common' +summary: >- + Credential: + ------ +fullName: CredentialFilter +remarks: '' +isDeprecated: false +syntax: | + type CredentialFilter = { + clientId?: string + credentialType?: string + environment?: string + familyId?: string + homeAccountId?: string + keyId?: string + realm?: string + requestedClaimsHash?: string + target?: ScopeSet + tokenType?: AuthenticationScheme + userAssertionHash?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CredentialType.yml b/msal/docs-ref-autogen/@azure/msal-common/CredentialType.yml new file mode 100644 index 0000000..ad1dda8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/CredentialType.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: CredentialType +uid: '@azure/msal-common.CredentialType' +package: '@azure/msal-common' +summary: '' +fullName: CredentialType +remarks: '' +isDeprecated: false +syntax: | + type CredentialType = (typeof CredentialType)[keyof typeof CredentialType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml new file mode 100644 index 0000000..3adb738 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml @@ -0,0 +1,33 @@ +### YamlMime:TSTypeAlias +name: DeviceCodeResponse +uid: '@azure/msal-common.DeviceCodeResponse' +package: '@azure/msal-common' +summary: >- + DeviceCode returned by the security token service device code endpoint + containing information necessary for device code flow. + + - userCode: code which user needs to provide when authenticating at the + verification URI + + - deviceCode: code which should be included in the request for the access + token + + - verificationUri: URI where user can authenticate + + - expiresIn: expiration time of the device code in seconds + + - interval: interval at which the STS should be polled at + + - message: message which should be displayed to the user +fullName: DeviceCodeResponse +remarks: '' +isDeprecated: false +syntax: | + type DeviceCodeResponse = { + deviceCode: string + expiresIn: number + interval: number + message: string + userCode: string + verificationUri: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml new file mode 100644 index 0000000..17dd107 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml @@ -0,0 +1,32 @@ +### YamlMime:TSTypeAlias +name: ExternalTokenResponse +uid: '@azure/msal-common.ExternalTokenResponse' +package: '@azure/msal-common' +summary: >- + Response object used for loading external tokens to cache. + + - token_type: Indicates the token type value. The only type that Azure AD + supports is Bearer. + + - scope: The scopes that the access_token is valid for. + + - expires_in: How long the access token is valid (in seconds). + + - id_token: A JSON Web Token (JWT). The app can decode the segments of this + token to request information about the user who signed in. + + - refresh_token: An OAuth 2.0 refresh token. The app can use this token + acquire additional access tokens after the current access token expires. + + - access_token: The requested access token. The app can use this token to + authenticate to the secured resource, such as a web API. + + - client_info: Client info object +fullName: ExternalTokenResponse +remarks: '' +isDeprecated: false +syntax: | + type ExternalTokenResponse = Pick< + ServerAuthorizationTokenResponse, + "token_type" | "scope" | "expires_in" | "id_token" | "refresh_token" + > & { access_token?: string; client_info?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/GrantType.yml b/msal/docs-ref-autogen/@azure/msal-common/GrantType.yml new file mode 100644 index 0000000..f2cdc1b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/GrantType.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: GrantType +uid: '@azure/msal-common.GrantType' +package: '@azure/msal-common' +summary: '' +fullName: GrantType +remarks: '' +isDeprecated: false +syntax: | + type GrantType = (typeof GrantType)[keyof typeof GrantType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/HeaderNames.yml b/msal/docs-ref-autogen/@azure/msal-common/HeaderNames.yml new file mode 100644 index 0000000..be3fcf2 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/HeaderNames.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: HeaderNames +uid: '@azure/msal-common.HeaderNames' +package: '@azure/msal-common' +summary: '' +fullName: HeaderNames +remarks: '' +isDeprecated: false +syntax: | + type HeaderNames = (typeof HeaderNames)[keyof typeof HeaderNames] diff --git a/msal/docs-ref-autogen/@azure/msal-common/HttpStatus.yml b/msal/docs-ref-autogen/@azure/msal-common/HttpStatus.yml new file mode 100644 index 0000000..dba9e13 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/HttpStatus.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: HttpStatus +uid: '@azure/msal-common.HttpStatus' +package: '@azure/msal-common' +summary: '' +fullName: HttpStatus +remarks: '' +isDeprecated: false +syntax: | + type HttpStatus = (typeof HttpStatus)[keyof typeof HttpStatus] diff --git a/msal/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml b/msal/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml new file mode 100644 index 0000000..692ec6b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: IAppTokenProvider +uid: '@azure/msal-common.IAppTokenProvider' +package: '@azure/msal-common' +summary: '' +fullName: IAppTokenProvider +remarks: '' +isDeprecated: false +type: interface diff --git a/msal/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml b/msal/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml new file mode 100644 index 0000000..9e48b36 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: ICachePlugin +uid: '@azure/msal-common.ICachePlugin' +package: '@azure/msal-common' +summary: '' +fullName: ICachePlugin +remarks: '' +isDeprecated: false +type: interface +properties: + - name: afterCacheAccess + uid: '@azure/msal-common.ICachePlugin.afterCacheAccess' + package: '@azure/msal-common' + summary: '' + fullName: afterCacheAccess + remarks: '' + isDeprecated: false + syntax: + content: >- + afterCacheAccess: (tokenCacheContext: TokenCacheContext) => + Promise + return: + description: '' + type: '(tokenCacheContext: TokenCacheContext) => Promise<void>' + - name: beforeCacheAccess + uid: '@azure/msal-common.ICachePlugin.beforeCacheAccess' + package: '@azure/msal-common' + summary: '' + fullName: beforeCacheAccess + remarks: '' + isDeprecated: false + syntax: + content: >- + beforeCacheAccess: (tokenCacheContext: TokenCacheContext) => + Promise + return: + description: '' + type: '(tokenCacheContext: TokenCacheContext) => Promise<void>' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml b/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml new file mode 100644 index 0000000..f62da7e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml @@ -0,0 +1,137 @@ +### YamlMime:TSType +name: ICrypto +uid: '@azure/msal-common.ICrypto' +package: '@azure/msal-common' +summary: Interface for crypto functions used by library +fullName: ICrypto +remarks: '' +isDeprecated: false +type: interface +methods: + - name: base64Decode(string) + uid: '@azure/msal-common.ICrypto.base64Decode' + package: '@azure/msal-common' + summary: base64 decode string + remarks: '' + isDeprecated: false + syntax: + content: 'function base64Decode(input: string): string' + parameters: + - id: input + type: string + description: '' + return: + description: '' + type: string + - name: base64Encode(string) + uid: '@azure/msal-common.ICrypto.base64Encode' + package: '@azure/msal-common' + summary: base64 Encode string + remarks: '' + isDeprecated: false + syntax: + content: 'function base64Encode(input: string): string' + parameters: + - id: input + type: string + description: '' + return: + description: '' + type: string + - name: clearKeystore() + uid: '@azure/msal-common.ICrypto.clearKeystore' + package: '@azure/msal-common' + summary: Removes all cryptographic keys from IndexedDB storage + remarks: '' + isDeprecated: false + syntax: + content: 'function clearKeystore(): Promise' + return: + description: '' + type: Promise<boolean> + - name: createNewGuid() + uid: '@azure/msal-common.ICrypto.createNewGuid' + package: '@azure/msal-common' + summary: Creates a guid randomly. + remarks: '' + isDeprecated: false + syntax: + content: 'function createNewGuid(): string' + return: + description: '' + type: string + - name: getPublicKeyThumbprint(SignedHttpRequestParameters) + uid: '@azure/msal-common.ICrypto.getPublicKeyThumbprint' + package: '@azure/msal-common' + summary: Generates an JWK RSA S256 Thumbprint + remarks: '' + isDeprecated: false + syntax: + content: >- + function getPublicKeyThumbprint(request: SignedHttpRequestParameters): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<string> + - name: hashString(string) + uid: '@azure/msal-common.ICrypto.hashString' + package: '@azure/msal-common' + summary: Returns the SHA-256 hash of an input string + remarks: '' + isDeprecated: false + syntax: + content: 'function hashString(plainText: string): Promise' + parameters: + - id: plainText + type: string + description: '' + return: + description: '' + type: Promise<string> + - name: removeTokenBindingKey(string) + uid: '@azure/msal-common.ICrypto.removeTokenBindingKey' + package: '@azure/msal-common' + summary: Removes cryptographic keypair from key store matching the keyId passed in + remarks: '' + isDeprecated: false + syntax: + content: 'function removeTokenBindingKey(kid: string): Promise' + parameters: + - id: kid + type: string + description: '' + return: + description: '' + type: Promise<boolean> + - name: signJwt(SignedHttpRequest, string, ShrOptions, string) + uid: '@azure/msal-common.ICrypto.signJwt' + package: '@azure/msal-common' + summary: >- + Returns a signed proof-of-possession token with a given acces token that + contains a cnf claim with the required kid. + remarks: '' + isDeprecated: false + syntax: + content: >- + function signJwt(payload: SignedHttpRequest, kid: string, shrOptions?: + ShrOptions, correlationId?: string): Promise + parameters: + - id: payload + type: + description: '' + - id: kid + type: string + description: '' + - id: shrOptions + type: + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml b/msal/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml new file mode 100644 index 0000000..89b9afe --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml @@ -0,0 +1,36 @@ +### YamlMime:TSType +name: IGuidGenerator +uid: '@azure/msal-common.IGuidGenerator' +package: '@azure/msal-common' +summary: '' +fullName: IGuidGenerator +remarks: '' +isDeprecated: false +type: interface +methods: + - name: generateGuid() + uid: '@azure/msal-common.IGuidGenerator.generateGuid' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function generateGuid(): string' + return: + description: '' + type: string + - name: isGuid(string) + uid: '@azure/msal-common.IGuidGenerator.isGuid' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function isGuid(guid: string): boolean' + parameters: + - id: guid + type: string + description: '' + return: + description: '' + type: boolean diff --git a/msal/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml b/msal/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml new file mode 100644 index 0000000..08f46ed --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: ILoggerCallback +uid: '@azure/msal-common.ILoggerCallback' +package: '@azure/msal-common' +summary: '' +fullName: ILoggerCallback +remarks: '' +isDeprecated: false +type: interface diff --git a/msal/docs-ref-autogen/@azure/msal-common/INativeBrokerPlugin.yml b/msal/docs-ref-autogen/@azure/msal-common/INativeBrokerPlugin.yml new file mode 100644 index 0000000..fc7f195 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/INativeBrokerPlugin.yml @@ -0,0 +1,127 @@ +### YamlMime:TSType +name: INativeBrokerPlugin +uid: '@azure/msal-common.INativeBrokerPlugin' +package: '@azure/msal-common' +summary: '' +fullName: INativeBrokerPlugin +remarks: '' +isDeprecated: false +type: interface +properties: + - name: isBrokerAvailable + uid: '@azure/msal-common.INativeBrokerPlugin.isBrokerAvailable' + package: '@azure/msal-common' + summary: '' + fullName: isBrokerAvailable + remarks: '' + isDeprecated: false + syntax: + content: 'isBrokerAvailable: boolean' + return: + description: '' + type: boolean +methods: + - name: acquireTokenInteractive(NativeRequest, Buffer) + uid: '@azure/msal-common.INativeBrokerPlugin.acquireTokenInteractive' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenInteractive(request: NativeRequest, windowHandle?: + Buffer): Promise + parameters: + - id: request + type: + description: '' + - id: windowHandle + type: Buffer + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenSilent(NativeRequest) + uid: '@azure/msal-common.INativeBrokerPlugin.acquireTokenSilent' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(request: NativeRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: getAccountById(string, string) + uid: '@azure/msal-common.INativeBrokerPlugin.getAccountById' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountById(accountId: string, correlationId: string): + Promise + parameters: + - id: accountId + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<> + - name: getAllAccounts(string, string) + uid: '@azure/msal-common.INativeBrokerPlugin.getAllAccounts' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAllAccounts(clientId: string, correlationId: string): + Promise + parameters: + - id: clientId + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<[]> + - name: setLogger(LoggerOptions) + uid: '@azure/msal-common.INativeBrokerPlugin.setLogger' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(loggerOptions: LoggerOptions)' + parameters: + - id: loggerOptions + type: + description: '' + - name: signOut(NativeSignOutRequest) + uid: '@azure/msal-common.INativeBrokerPlugin.signOut' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function signOut(request: NativeSignOutRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml b/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml new file mode 100644 index 0000000..b165996 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: INetworkModule +uid: '@azure/msal-common.INetworkModule' +package: '@azure/msal-common' +summary: Client network interface to send backend requests. +fullName: INetworkModule +remarks: '' +isDeprecated: false +type: interface +methods: + - name: sendGetRequestAsync(string, NetworkRequestOptions, number) + uid: '@azure/msal-common.INetworkModule.sendGetRequestAsync' + package: '@azure/msal-common' + summary: >- + Interface function for async network "GET" requests. Based on the Fetch + standard: https://fetch.spec.whatwg.org/ + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendGetRequestAsync(url: string, options?: + NetworkRequestOptions, cancellationToken?: number): + Promise> + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + - id: cancellationToken + type: number + description: '' + return: + description: '' + type: >- + Promise<<T>> + - name: sendPostRequestAsync(string, NetworkRequestOptions) + uid: '@azure/msal-common.INetworkModule.sendPostRequestAsync' + package: '@azure/msal-common' + summary: >- + Interface function for async network "POST" requests. Based on the Fetch + standard: https://fetch.spec.whatwg.org/ + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendPostRequestAsync(url: string, options?: + NetworkRequestOptions): Promise> + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + return: + description: '' + type: >- + Promise<<T>> diff --git a/msal/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml new file mode 100644 index 0000000..7a2f392 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml @@ -0,0 +1,230 @@ +### YamlMime:TSType +name: IPerformanceClient +uid: '@azure/msal-common.IPerformanceClient' +package: '@azure/msal-common' +summary: '' +fullName: IPerformanceClient +remarks: '' +isDeprecated: false +type: interface +methods: + - name: 'addFields({[key: string]: {} | undefined}, string)' + uid: '@azure/msal-common.IPerformanceClient.addFields' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addFields(fields: {[key: string]: {} | undefined}, + correlationId: string) + parameters: + - id: fields + type: '{[key: string]: {} | undefined}' + description: '' + - id: correlationId + type: string + description: '' + - name: addPerformanceCallback(PerformanceCallbackFunction) + uid: '@azure/msal-common.IPerformanceClient.addPerformanceCallback' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addPerformanceCallback(callback: PerformanceCallbackFunction): + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: string + - name: addQueueMeasurement(string, string, number, boolean) + uid: '@azure/msal-common.IPerformanceClient.addQueueMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addQueueMeasurement(eventName: string, correlationId?: string, + queueTime?: number, manuallyCompleted?: boolean) + parameters: + - id: eventName + type: string + description: '' + - id: correlationId + type: string + description: '' + - id: queueTime + type: number + description: '' + - id: manuallyCompleted + type: boolean + description: '' + - name: calculateQueuedTime(number, number) + uid: '@azure/msal-common.IPerformanceClient.calculateQueuedTime' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function calculateQueuedTime(preQueueTime: number, currentTime: number): + number + parameters: + - id: preQueueTime + type: number + description: '' + - id: currentTime + type: number + description: '' + return: + description: '' + type: number + - name: discardMeasurements(string) + uid: '@azure/msal-common.IPerformanceClient.discardMeasurements' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function discardMeasurements(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + - name: emitEvents(PerformanceEvent[], string) + uid: '@azure/msal-common.IPerformanceClient.emitEvents' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function emitEvents(events: PerformanceEvent[], correlationId: string)' + parameters: + - id: events + type: [] + description: '' + - id: correlationId + type: string + description: '' + - name: endMeasurement(PerformanceEvent) + uid: '@azure/msal-common.IPerformanceClient.endMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function endMeasurement(event: PerformanceEvent): null | + PerformanceEvent + parameters: + - id: event + type: + description: '' + return: + description: '' + type: null | + - name: generateId() + uid: '@azure/msal-common.IPerformanceClient.generateId' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function generateId(): string' + return: + description: '' + type: string + - name: 'incrementFields({[key: string]: number | undefined}, string)' + uid: '@azure/msal-common.IPerformanceClient.incrementFields' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function incrementFields(fields: {[key: string]: number | undefined}, + correlationId: string) + parameters: + - id: fields + type: '{[key: string]: number | undefined}' + description: '' + - id: correlationId + type: string + description: '' + - name: removePerformanceCallback(string) + uid: '@azure/msal-common.IPerformanceClient.removePerformanceCallback' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(callbackId: string): boolean' + parameters: + - id: callbackId + type: string + description: '' + return: + description: '' + type: boolean + - name: setPreQueueTime(string, string) + uid: '@azure/msal-common.IPerformanceClient.setPreQueueTime' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setPreQueueTime(eventName: string, correlationId?: string)' + parameters: + - id: eventName + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: startMeasurement(string, string) + uid: '@azure/msal-common.IPerformanceClient.startMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: + - name: startPerformanceMeasurement(string, string) + uid: '@azure/msal-common.IPerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: This method will be removed in the next major version + syntax: + content: >- + function startPerformanceMeasurement(measureName: string, correlationId: + string): IPerformanceMeasurement + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml b/msal/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml new file mode 100644 index 0000000..c8c58ea --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml @@ -0,0 +1,37 @@ +### YamlMime:TSType +name: IPerformanceMeasurement +uid: '@azure/msal-common.IPerformanceMeasurement' +package: '@azure/msal-common' +summary: '' +fullName: IPerformanceMeasurement +remarks: '' +isDeprecated: false +type: interface +methods: + - name: endMeasurement() + uid: '@azure/msal-common.IPerformanceMeasurement.endMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function endMeasurement() + - name: flushMeasurement() + uid: '@azure/msal-common.IPerformanceMeasurement.flushMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function flushMeasurement(): null | number' + return: + description: '' + type: null | number + - name: startMeasurement() + uid: '@azure/msal-common.IPerformanceMeasurement.startMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function startMeasurement() diff --git a/msal/docs-ref-autogen/@azure/msal-common/ISerializableTokenCache.yml b/msal/docs-ref-autogen/@azure/msal-common/ISerializableTokenCache.yml new file mode 100644 index 0000000..eb45cbc --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ISerializableTokenCache.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ISerializableTokenCache +uid: '@azure/msal-common.ISerializableTokenCache' +package: '@azure/msal-common' +summary: '' +fullName: ISerializableTokenCache +remarks: '' +isDeprecated: false +type: interface +properties: + - name: deserialize + uid: '@azure/msal-common.ISerializableTokenCache.deserialize' + package: '@azure/msal-common' + summary: '' + fullName: deserialize + remarks: '' + isDeprecated: false + syntax: + content: 'deserialize: (cache: string) => void' + return: + description: '' + type: '(cache: string) => void' + - name: serialize + uid: '@azure/msal-common.ISerializableTokenCache.serialize' + package: '@azure/msal-common' + summary: '' + fullName: serialize + remarks: '' + isDeprecated: false + syntax: + content: 'serialize: () => string' + return: + description: '' + type: () => string diff --git a/msal/docs-ref-autogen/@azure/msal-common/IUri.yml b/msal/docs-ref-autogen/@azure/msal-common/IUri.yml new file mode 100644 index 0000000..142c13e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/IUri.yml @@ -0,0 +1,94 @@ +### YamlMime:TSType +name: IUri +uid: '@azure/msal-common.IUri' +package: '@azure/msal-common' +summary: Interface which describes URI components. +fullName: IUri +remarks: '' +isDeprecated: false +type: interface +properties: + - name: AbsolutePath + uid: '@azure/msal-common.IUri.AbsolutePath' + package: '@azure/msal-common' + summary: '' + fullName: AbsolutePath + remarks: '' + isDeprecated: false + syntax: + content: 'AbsolutePath: string' + return: + description: '' + type: string + - name: Hash + uid: '@azure/msal-common.IUri.Hash' + package: '@azure/msal-common' + summary: '' + fullName: Hash + remarks: '' + isDeprecated: false + syntax: + content: 'Hash: string' + return: + description: '' + type: string + - name: HostNameAndPort + uid: '@azure/msal-common.IUri.HostNameAndPort' + package: '@azure/msal-common' + summary: '' + fullName: HostNameAndPort + remarks: '' + isDeprecated: false + syntax: + content: 'HostNameAndPort: string' + return: + description: '' + type: string + - name: PathSegments + uid: '@azure/msal-common.IUri.PathSegments' + package: '@azure/msal-common' + summary: '' + fullName: PathSegments + remarks: '' + isDeprecated: false + syntax: + content: 'PathSegments: string[]' + return: + description: '' + type: string[] + - name: Protocol + uid: '@azure/msal-common.IUri.Protocol' + package: '@azure/msal-common' + summary: '' + fullName: Protocol + remarks: '' + isDeprecated: false + syntax: + content: 'Protocol: string' + return: + description: '' + type: string + - name: QueryString + uid: '@azure/msal-common.IUri.QueryString' + package: '@azure/msal-common' + summary: '' + fullName: QueryString + remarks: '' + isDeprecated: false + syntax: + content: 'QueryString: string' + return: + description: '' + type: string + - name: Search + uid: '@azure/msal-common.IUri.Search' + package: '@azure/msal-common' + summary: '' + fullName: Search + remarks: '' + isDeprecated: false + syntax: + content: 'Search: string' + return: + description: '' + type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml new file mode 100644 index 0000000..868e304 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: IdTokenEntity +uid: '@azure/msal-common.IdTokenEntity' +package: '@azure/msal-common' +summary: Id Token Cache Type +fullName: IdTokenEntity +remarks: '' +isDeprecated: false +syntax: | + type IdTokenEntity = CredentialEntity & { realm: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml new file mode 100644 index 0000000..8d4ea8d --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: InProgressPerformanceEvent +uid: '@azure/msal-common.InProgressPerformanceEvent' +package: '@azure/msal-common' +summary: '' +fullName: InProgressPerformanceEvent +remarks: '' +isDeprecated: false +syntax: | + type InProgressPerformanceEvent = { + add: (fields: { [key: string]: {} | undefined }) => void + discard: () => void + end: ( + event?: Partial, + error?: unknown + ) => PerformanceEvent | null + event: PerformanceEvent + increment: (fields: { [key: string]: number | undefined }) => void + measurement: IPerformanceMeasurement + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml new file mode 100644 index 0000000..127e14d --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: InteractionRequiredAuthError +uid: '@azure/msal-common.InteractionRequiredAuthError' +package: '@azure/msal-common' +summary: Error thrown when user interaction is required. +fullName: InteractionRequiredAuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + InteractionRequiredAuthError(string, string, string, string, string, + string, string) + uid: '@azure/msal-common.InteractionRequiredAuthError.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new InteractionRequiredAuthError(errorCode?: string, errorMessage?: + string, subError?: string, timestamp?: string, traceId?: string, + correlationId?: string, claims?: string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: subError + type: string + description: '' + - id: timestamp + type: string + description: '' + - id: traceId + type: string + description: '' + - id: correlationId + type: string + description: '' + - id: claims + type: string + description: '' +properties: + - name: claims + uid: '@azure/msal-common.InteractionRequiredAuthError.claims' + package: '@azure/msal-common' + summary: >- + https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-common/docs/claims-challenge.md + + + A string with extra claims needed for the token request to succeed + + web site: redirect the user to the authorization page and set the extra + claims + + web api: include the claims in the WWW-Authenticate header that are sent + back to the client so that it knows to request a token with the extra + claims + + desktop application or browser context: include the claims when acquiring + the token interactively + + app to app context (client_credentials): include the claims in the + AcquireTokenByClientCredential request + fullName: claims + remarks: '' + isDeprecated: false + syntax: + content: 'claims: string' + return: + description: '' + type: string + - name: timestamp + uid: '@azure/msal-common.InteractionRequiredAuthError.timestamp' + package: '@azure/msal-common' + summary: The time the error occured at + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp: string' + return: + description: '' + type: string + - name: traceId + uid: '@azure/msal-common.InteractionRequiredAuthError.traceId' + package: '@azure/msal-common' + summary: TraceId associated with the error + fullName: traceId + remarks: '' + isDeprecated: false + syntax: + content: 'traceId: string' + return: + description: '' + type: string +inheritedProperties: + - name: correlationId + uid: '@azure/msal-common.InteractionRequiredAuthError.correlationId' + package: '@azure/msal-common' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-common.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-common.InteractionRequiredAuthError.errorCode' + package: '@azure/msal-common' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-common.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-common.InteractionRequiredAuthError.errorMessage' + package: '@azure/msal-common' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-common.AuthError.errorMessage) + - name: message + uid: '@azure/msal-common.InteractionRequiredAuthError.message' + package: '@azure/msal-common' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-common.AuthError.message) + - name: name + uid: '@azure/msal-common.InteractionRequiredAuthError.name' + package: '@azure/msal-common' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-common.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-common.InteractionRequiredAuthError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-common.InteractionRequiredAuthError.stack' + package: '@azure/msal-common' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-common.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-common.InteractionRequiredAuthError.stackTraceLimit' + package: '@azure/msal-common' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-common.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-common.InteractionRequiredAuthError.subError' + package: '@azure/msal-common' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-common.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.InteractionRequiredAuthError.captureStackTrace' + package: '@azure/msal-common' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-common.InteractionRequiredAuthError.setCorrelationId' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthErrorCodes.yml new file mode 100644 index 0000000..6d724fc --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.InteractionRequiredAuthErrorCodes' +name: InteractionRequiredAuthErrorCodes +type: module +package: '@azure/msal-common' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/JsonWebTokenTypes.yml b/msal/docs-ref-autogen/@azure/msal-common/JsonWebTokenTypes.yml new file mode 100644 index 0000000..b3afdd8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/JsonWebTokenTypes.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: JsonWebTokenTypes +uid: '@azure/msal-common.JsonWebTokenTypes' +package: '@azure/msal-common' +summary: '' +fullName: JsonWebTokenTypes +remarks: '' +isDeprecated: false +syntax: | + type JsonWebTokenTypes = + (typeof JsonWebTokenTypes)[keyof typeof JsonWebTokenTypes] diff --git a/msal/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml b/msal/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml new file mode 100644 index 0000000..38760f9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml @@ -0,0 +1,21 @@ +### YamlMime:TSTypeAlias +name: LibraryStateObject +uid: '@azure/msal-common.LibraryStateObject' +package: '@azure/msal-common' +summary: >- + Type which defines the object that is stringified, encoded and sent in the + state value. + + Contains the following: + + - id - unique identifier for this request + + - ts - timestamp for the time the request was made. Used to ensure that token + expiration is not calculated incorrectly. + + - platformState - string value sent from the platform. +fullName: LibraryStateObject +remarks: '' +isDeprecated: false +syntax: | + type LibraryStateObject = { id: string; meta?: Record } diff --git a/msal/docs-ref-autogen/@azure/msal-common/LogLevel.yml b/msal/docs-ref-autogen/@azure/msal-common/LogLevel.yml new file mode 100644 index 0000000..5e2c3c3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/LogLevel.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: LogLevel +uid: '@azure/msal-common.LogLevel' +package: '@azure/msal-common' +summary: Log message level. +fullName: LogLevel +remarks: '' +isDeprecated: false +fields: + - name: Error + uid: '@azure/msal-common.LogLevel.Error' + package: '@azure/msal-common' + summary: '' + numericValue: 0 + - name: Warning + uid: '@azure/msal-common.LogLevel.Warning' + package: '@azure/msal-common' + summary: '' + numericValue: 1 + - name: Info + uid: '@azure/msal-common.LogLevel.Info' + package: '@azure/msal-common' + summary: '' + numericValue: 2 + - name: Verbose + uid: '@azure/msal-common.LogLevel.Verbose' + package: '@azure/msal-common' + summary: '' + numericValue: 3 + - name: Trace + uid: '@azure/msal-common.LogLevel.Trace' + package: '@azure/msal-common' + summary: '' + numericValue: 4 diff --git a/msal/docs-ref-autogen/@azure/msal-common/Logger.yml b/msal/docs-ref-autogen/@azure/msal-common/Logger.yml new file mode 100644 index 0000000..9c3741e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/Logger.yml @@ -0,0 +1,235 @@ +### YamlMime:TSType +name: Logger +uid: '@azure/msal-common.Logger' +package: '@azure/msal-common' +summary: Class which facilitates logging of messages to a specific place. +fullName: Logger +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Logger(LoggerOptions, string, string) + uid: '@azure/msal-common.Logger.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Logger(loggerOptions: LoggerOptions, packageName?: string, + packageVersion?: string) + parameters: + - id: loggerOptions + type: + description: '' + - id: packageName + type: string + description: '' + - id: packageVersion + type: string + description: '' +methods: + - name: clone(string, string, string) + uid: '@azure/msal-common.Logger.clone' + package: '@azure/msal-common' + summary: Create new Logger with existing configurations. + remarks: '' + isDeprecated: false + syntax: + content: >- + function clone(packageName: string, packageVersion: string, + correlationId?: string): Logger + parameters: + - id: packageName + type: string + description: '' + - id: packageVersion + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: + - name: error(string, string) + uid: '@azure/msal-common.Logger.error' + package: '@azure/msal-common' + summary: Logs error messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function error(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: errorPii(string, string) + uid: '@azure/msal-common.Logger.errorPii' + package: '@azure/msal-common' + summary: Logs error messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function errorPii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: executeCallback(LogLevel, string, boolean) + uid: '@azure/msal-common.Logger.executeCallback' + package: '@azure/msal-common' + summary: Execute callback with message. + remarks: '' + isDeprecated: false + syntax: + content: >- + function executeCallback(level: LogLevel, message: string, containsPii: + boolean) + parameters: + - id: level + type: + description: '' + - id: message + type: string + description: '' + - id: containsPii + type: boolean + description: '' + - name: info(string, string) + uid: '@azure/msal-common.Logger.info' + package: '@azure/msal-common' + summary: Logs info messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function info(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: infoPii(string, string) + uid: '@azure/msal-common.Logger.infoPii' + package: '@azure/msal-common' + summary: Logs info messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function infoPii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: isPiiLoggingEnabled() + uid: '@azure/msal-common.Logger.isPiiLoggingEnabled' + package: '@azure/msal-common' + summary: Returns whether PII Logging is enabled or not. + remarks: '' + isDeprecated: false + syntax: + content: 'function isPiiLoggingEnabled(): boolean' + return: + description: '' + type: boolean + - name: trace(string, string) + uid: '@azure/msal-common.Logger.trace' + package: '@azure/msal-common' + summary: Logs trace messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function trace(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: tracePii(string, string) + uid: '@azure/msal-common.Logger.tracePii' + package: '@azure/msal-common' + summary: Logs trace messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function tracePii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: verbose(string, string) + uid: '@azure/msal-common.Logger.verbose' + package: '@azure/msal-common' + summary: Logs verbose messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function verbose(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: verbosePii(string, string) + uid: '@azure/msal-common.Logger.verbosePii' + package: '@azure/msal-common' + summary: Logs verbose messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function verbosePii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: warning(string, string) + uid: '@azure/msal-common.Logger.warning' + package: '@azure/msal-common' + summary: Logs warning messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function warning(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: warningPii(string, string) + uid: '@azure/msal-common.Logger.warningPii' + package: '@azure/msal-common' + summary: Logs warning messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function warningPii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml new file mode 100644 index 0000000..06d4f7a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml @@ -0,0 +1,26 @@ +### YamlMime:TSTypeAlias +name: LoggerOptions +uid: '@azure/msal-common.LoggerOptions' +package: '@azure/msal-common' +summary: >- + Use this to configure the logging that MSAL does, by configuring logger + options in the Configuration object + + + - loggerCallback - Callback for logger + + - piiLoggingEnabled - Sets whether pii logging is enabled + + - logLevel - Sets the level at which logging happens + + - correlationId - Sets the correlationId printed by the logger +fullName: LoggerOptions +remarks: '' +isDeprecated: false +syntax: | + type LoggerOptions = { + correlationId?: string + logLevel?: LogLevel + loggerCallback?: ILoggerCallback + piiLoggingEnabled?: boolean + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/NativeRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/NativeRequest.yml new file mode 100644 index 0000000..66f5c88 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/NativeRequest.yml @@ -0,0 +1,27 @@ +### YamlMime:TSTypeAlias +name: NativeRequest +uid: '@azure/msal-common.NativeRequest' +package: '@azure/msal-common' +summary: '' +fullName: NativeRequest +remarks: '' +isDeprecated: false +syntax: | + type NativeRequest = { + accountId?: string + authenticationScheme?: string + authority: string + claims?: string + clientId: string + correlationId: string + extraParameters?: StringDict + extraScopesToConsent?: string[] + forceRefresh?: boolean + loginHint?: string + prompt?: string + redirectUri: string + resourceRequestMethod?: string + resourceRequestUri?: string + scopes: string[] + shrNonce?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/NativeSignOutRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/NativeSignOutRequest.yml new file mode 100644 index 0000000..83e279b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/NativeSignOutRequest.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: NativeSignOutRequest +uid: '@azure/msal-common.NativeSignOutRequest' +package: '@azure/msal-common' +summary: '' +fullName: NativeSignOutRequest +remarks: '' +isDeprecated: false +syntax: | + type NativeSignOutRequest = { + accountId: string + clientId: string + correlationId: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml new file mode 100644 index 0000000..b91366f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: NetworkRequestOptions +uid: '@azure/msal-common.NetworkRequestOptions' +package: '@azure/msal-common' +summary: Options allowed by network request APIs. +fullName: NetworkRequestOptions +remarks: '' +isDeprecated: false +syntax: > + type NetworkRequestOptions = { body?: string; headers?: Record + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml new file mode 100644 index 0000000..0f7f12c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: NetworkResponse +uid: '@azure/msal-common.NetworkResponse' +package: '@azure/msal-common' +summary: '' +fullName: NetworkResponse +remarks: '' +isDeprecated: false +syntax: | + type NetworkResponse = { + body: T + headers: Record + status: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/OIDCOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/OIDCOptions.yml new file mode 100644 index 0000000..5530ecf --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/OIDCOptions.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: OIDCOptions +uid: '@azure/msal-common.OIDCOptions' +package: '@azure/msal-common' +summary: Options for the OIDC protocol mode. +fullName: OIDCOptions +remarks: '' +isDeprecated: false +syntax: | + type OIDCOptions = { + defaultScopes?: string[] + serverResponseType?: ServerResponseType + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml b/msal/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml new file mode 100644 index 0000000..1367a73 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: PasswordGrantConstants +uid: '@azure/msal-common.PasswordGrantConstants' +package: '@azure/msal-common' +summary: '' +fullName: PasswordGrantConstants +remarks: '' +isDeprecated: false +syntax: | + type PasswordGrantConstants = + (typeof PasswordGrantConstants)[keyof typeof PasswordGrantConstants] diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceCallbackFunction.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceCallbackFunction.yml new file mode 100644 index 0000000..30a3d48 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceCallbackFunction.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: PerformanceCallbackFunction +uid: '@azure/msal-common.PerformanceCallbackFunction' +package: '@azure/msal-common' +summary: '' +fullName: PerformanceCallbackFunction +remarks: '' +isDeprecated: false +syntax: | + type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml new file mode 100644 index 0000000..2feb54b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml @@ -0,0 +1,320 @@ +### YamlMime:TSType +name: PerformanceClient +uid: '@azure/msal-common.PerformanceClient' +package: '@azure/msal-common' +summary: '' +fullName: PerformanceClient +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + PerformanceClient(string, string, Logger, string, string, + ApplicationTelemetry, Set, Map) + uid: '@azure/msal-common.PerformanceClient.constructor' + package: '@azure/msal-common' + summary: |- + Creates an instance of PerformanceClient, + an abstract class containing core performance telemetry logic. + remarks: '' + isDeprecated: false + syntax: + content: >- + new PerformanceClient(clientId: string, authority: string, logger: + Logger, libraryName: string, libraryVersion: string, + applicationTelemetry: ApplicationTelemetry, intFields?: Set, + abbreviations?: Map) + parameters: + - id: clientId + type: string + description: Client ID of the application + - id: authority + type: string + description: Authority used by the application + - id: logger + type: + description: Logger used by the application + - id: libraryName + type: string + description: Name of the library + - id: libraryVersion + type: string + description: Version of the library + - id: applicationTelemetry + type: + description: application name and version + - id: intFields + type: Set<string> + description: integer fields to be truncated + - id: abbreviations + type: Map<string, string> + description: event name abbreviations +methods: + - name: 'addFields({[key: string]: {} | undefined}, string)' + uid: '@azure/msal-common.PerformanceClient.addFields' + package: '@azure/msal-common' + summary: Saves extra information to be emitted when the measurements are flushed + remarks: '' + isDeprecated: false + syntax: + content: >- + function addFields(fields: {[key: string]: {} | undefined}, + correlationId: string) + parameters: + - id: fields + type: '{[key: string]: {} | undefined}' + description: '' + - id: correlationId + type: string + description: '' + - name: addPerformanceCallback(PerformanceCallbackFunction) + uid: '@azure/msal-common.PerformanceClient.addPerformanceCallback' + package: '@azure/msal-common' + summary: Registers a callback function to receive performance events. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addPerformanceCallback(callback: PerformanceCallbackFunction): + string + parameters: + - id: callback + type: + description: '' + return: + description: '' + type: string + - name: addQueueMeasurement(string, string, number, boolean) + uid: '@azure/msal-common.PerformanceClient.addQueueMeasurement' + package: '@azure/msal-common' + summary: >- + Adds queue measurement time to QueueMeasurements array for given + correlation ID. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addQueueMeasurement(eventName: string, correlationId?: string, + queueTime?: number, manuallyCompleted?: boolean) + parameters: + - id: eventName + type: string + description: '' + - id: correlationId + type: string + description: '' + - id: queueTime + type: number + description: '' + - id: manuallyCompleted + type: boolean + description: indicator for manually completed queue measurements + - name: calculateQueuedTime(number, number) + uid: '@azure/msal-common.PerformanceClient.calculateQueuedTime' + package: '@azure/msal-common' + summary: >- + Calculates the difference between current time and time when function was + queued. + + Note: It is possible to have 0 as the queue time if the current time and + the queued time was the same. + remarks: '' + isDeprecated: false + syntax: + content: >- + function calculateQueuedTime(preQueueTime: number, currentTime: number): + number + parameters: + - id: preQueueTime + type: number + description: '' + - id: currentTime + type: number + description: '' + return: + description: '' + type: number + - name: discardMeasurements(string) + uid: '@azure/msal-common.PerformanceClient.discardMeasurements' + package: '@azure/msal-common' + summary: Removes measurements for a given correlation id. + remarks: '' + isDeprecated: false + syntax: + content: 'function discardMeasurements(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + - name: emitEvents(PerformanceEvent[], string) + uid: '@azure/msal-common.PerformanceClient.emitEvents' + package: '@azure/msal-common' + summary: Emits events to all registered callbacks. + remarks: '' + isDeprecated: false + syntax: + content: 'function emitEvents(events: PerformanceEvent[], correlationId?: string)' + parameters: + - id: events + type: [] + description: '' + - id: correlationId + type: string + description: '' + - name: endMeasurement(PerformanceEvent, unknown) + uid: '@azure/msal-common.PerformanceClient.endMeasurement' + package: '@azure/msal-common' + summary: >- + Stops measuring the performance for an operation. Should only be called + directly by PerformanceClient classes, + + as consumers should instead use the function returned by startMeasurement. + + Adds a new field named as "[event name]DurationMs" for sub-measurements, + completes and emits an event + + otherwise. + remarks: '' + isDeprecated: false + syntax: + content: >- + function endMeasurement(event: PerformanceEvent, error?: unknown): null + | PerformanceEvent + parameters: + - id: event + type: + description: '' + - id: error + type: unknown + description: '' + return: + description: '' + type: null | + - name: generateId() + uid: '@azure/msal-common.PerformanceClient.generateId' + package: '@azure/msal-common' + summary: Generates and returns a unique id, typically a guid. + remarks: '' + isDeprecated: false + syntax: + content: 'function generateId(): string' + return: + description: '' + type: string + - name: getPreQueueTime(string, string) + uid: '@azure/msal-common.PerformanceClient.getPreQueueTime' + package: '@azure/msal-common' + summary: Gets map of pre-queue times by correlation Id + remarks: '' + isDeprecated: false + syntax: + content: >- + function getPreQueueTime(eventName: string, correlationId: string): + number | void + parameters: + - id: eventName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: number | void + - name: 'incrementFields({[key: string]: number | undefined}, string)' + uid: '@azure/msal-common.PerformanceClient.incrementFields' + package: '@azure/msal-common' + summary: Increment counters to be emitted when the measurements are flushed + remarks: '' + isDeprecated: false + syntax: + content: >- + function incrementFields(fields: {[key: string]: number | undefined}, + correlationId: string) + parameters: + - id: fields + type: '{[key: string]: number | undefined}' + description: '{string[]}' + - id: correlationId + type: string + description: '{string} correlation identifier' + - name: removePerformanceCallback(string) + uid: '@azure/msal-common.PerformanceClient.removePerformanceCallback' + package: '@azure/msal-common' + summary: Removes a callback registered with addPerformanceCallback. + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(callbackId: string): boolean' + parameters: + - id: callbackId + type: string + description: '' + return: + description: '' + type: boolean + - name: setPreQueueTime(PerformanceEvents, string) + uid: '@azure/msal-common.PerformanceClient.setPreQueueTime' + package: '@azure/msal-common' + summary: Sets pre-queue time by correlation Id + remarks: '' + isDeprecated: false + syntax: + content: >- + function setPreQueueTime(eventName: PerformanceEvents, correlationId?: + string) + parameters: + - id: eventName + type: + description: '' + - id: correlationId + type: string + description: '' + - name: startMeasurement(string, string) + uid: '@azure/msal-common.PerformanceClient.startMeasurement' + package: '@azure/msal-common' + summary: >- + Starts measuring performance for a given operation. Returns a function + that should be used to end the measurement. + remarks: '' + isDeprecated: false + syntax: + content: >- + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: + - name: startPerformanceMeasurement(string, string) + uid: '@azure/msal-common.PerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-common' + summary: >- + Starts and returns an platform-specific implementation of + IPerformanceMeasurement. + + Note: this function can be changed to abstract at the next major version + bump. + remarks: '' + isDeprecated: true + customDeprecatedMessage: This method will be removed in the next major version + syntax: + content: >- + function startPerformanceMeasurement(measureName: string, correlationId: + string): IPerformanceMeasurement + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml new file mode 100644 index 0000000..3607f45 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -0,0 +1,75 @@ +### YamlMime:TSTypeAlias +name: PerformanceEvent +uid: '@azure/msal-common.PerformanceEvent' +package: '@azure/msal-common' +summary: >- + Performance measurement taken by the library, including metadata about the + request and application. +fullName: PerformanceEvent +remarks: '' +isDeprecated: false +syntax: | + type PerformanceEvent = { + accessTokenSize?: number + allowNativeBroker?: boolean + appName?: string + appVersion?: string + authority: string + awaitIframeCorrelationId?: string + cacheAtCount?: number + cacheIdCount?: number + cacheLookupPolicy?: number + cacheOutcome?: number + cacheRtCount?: number + clientId: string + context?: string + correlationId: string + durationMs?: number + endPageVisibility?: string | null + errorCode?: string + errorName?: string + errorStack?: string[] + eventId: string + extensionHandshakeTimedOut?: boolean + extensionHandshakeTimeoutMs?: number + extensionId?: string + extensionInstalled?: boolean + extensionVersion?: string + fromCache?: boolean | null + httpVerToken?: string + idTokenSize?: number + incompleteSubMeasurements?: Map + incompleteSubsCount?: number + isNativeBroker?: boolean + libraryName: string + libraryVersion: string + matsAccountJoinOnEnd?: string + matsAccountJoinOnStart?: string + matsApiErrorCode?: number + matsBrokerVersion?: string + matsDeviceJoin?: string + matsHttpEventCount?: number + matsHttpStatus?: number + matsPromptBehavior?: string + matsSilentBiSubCode?: number + matsSilentCode?: number + matsSilentMessage?: string + matsSilentStatus?: number + matsUiVisible?: boolean + multiMatchedAT?: number + multiMatchedID?: number + multiMatchedRT?: number + name: string + nestedAppAuthRequest?: boolean + queuedCount?: number + queuedManuallyCompletedCount?: number + queuedTimeMs?: number + refreshTokenSize?: number + requestId?: string + startPageVisibility?: string | null + startTimeMs: number + status: PerformanceEventStatus + subErrorCode?: string + success?: boolean | null + visibilityChangeCount?: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml new file mode 100644 index 0000000..5c9b729 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml @@ -0,0 +1,24 @@ +### YamlMime:TSEnum +name: PerformanceEventStatus +uid: '@azure/msal-common.PerformanceEventStatus' +package: '@azure/msal-common' +summary: State of the performance event. +fullName: PerformanceEventStatus +remarks: '' +isDeprecated: false +fields: + - name: NotStarted + uid: '@azure/msal-common.PerformanceEventStatus.NotStarted' + package: '@azure/msal-common' + summary: '' + numericValue: 0 + - name: InProgress + uid: '@azure/msal-common.PerformanceEventStatus.InProgress' + package: '@azure/msal-common' + summary: '' + numericValue: 1 + - name: Completed + uid: '@azure/msal-common.PerformanceEventStatus.Completed' + package: '@azure/msal-common' + summary: '' + numericValue: 2 diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml new file mode 100644 index 0000000..5846661 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml @@ -0,0 +1,424 @@ +### YamlMime:TSEnum +name: PerformanceEvents +uid: '@azure/msal-common.PerformanceEvents' +package: '@azure/msal-common' +summary: >- + Enumeration of operations that are instrumented by have their performance + measured by the PerformanceClient. +fullName: PerformanceEvents +remarks: '' +isDeprecated: false +fields: + - name: AcquireTokenByBroker + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenByBroker' + package: '@azure/msal-common' + summary: Time taken for token acquisition by broker + - name: AcquireTokenByCode + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenByCode' + package: '@azure/msal-common' + summary: >- + acquireTokenByCode API (msal-browser and msal-node). + + Used to acquire tokens by trading an authorization code against the token + endpoint. + - name: AcquireTokenByCodeAsync + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenByCodeAsync' + package: '@azure/msal-common' + summary: '' + - name: AcquireTokenByRefreshToken + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenByRefreshToken' + package: '@azure/msal-common' + summary: >- + acquireTokenByRefreshToken API (msal-browser and msal-node). + + Used to renew an access token using a refresh token against the token + endpoint. + - name: AcquireTokenByRefreshTokenInBroker + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenByRefreshTokenInBroker' + package: '@azure/msal-common' + summary: acquireTokenByRefreshToken API in BrokerClientApplication (PW-Broker) . + - name: AcquireTokenBySilentIframe + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenBySilentIframe' + package: '@azure/msal-common' + summary: |- + acquireTokenBySilentIframe (msal-browser). + Internal API for acquiring token by silent Iframe + - name: AcquireTokenFromCache + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenFromCache' + package: '@azure/msal-common' + summary: |- + acquireTokenFromCache (msal-browser). + Internal API for acquiring token from cache + - name: AcquireTokenPopup + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenPopup' + package: '@azure/msal-common' + summary: |- + acquireTokenPopup (msal-browser). + Used to acquire a new access token interactively through pop ups + - name: AcquireTokenRedirect + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenRedirect' + package: '@azure/msal-common' + summary: |- + acquireTokenRedirect (msal-browser). + Used to acquire a new access token interactively through redirects + - name: AcquireTokenSilent + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenSilent' + package: '@azure/msal-common' + summary: >- + acquireTokenSilent API (msal-browser and msal-node). + + Used to silently acquire a new access token (from the cache or the + network). + - name: AcquireTokenSilentAsync + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenSilentAsync' + package: '@azure/msal-common' + summary: |- + acquireTokenSilentAsync (msal-browser). + Internal API for acquireTokenSilent. + - name: AuthClientAcquireToken + uid: '@azure/msal-common.PerformanceEvents.AuthClientAcquireToken' + package: '@azure/msal-common' + summary: APIs in Authorization Code Client (msal-common) + - name: AuthClientCreateQueryString + uid: '@azure/msal-common.PerformanceEvents.AuthClientCreateQueryString' + package: '@azure/msal-common' + summary: '' + - name: AuthClientCreateTokenRequestBody + uid: '@azure/msal-common.PerformanceEvents.AuthClientCreateTokenRequestBody' + package: '@azure/msal-common' + summary: '' + - name: AuthClientExecuteTokenRequest + uid: '@azure/msal-common.PerformanceEvents.AuthClientExecuteTokenRequest' + package: '@azure/msal-common' + summary: '' + - name: AuthorityFactoryCreateDiscoveredInstance + uid: >- + @azure/msal-common.PerformanceEvents.AuthorityFactoryCreateDiscoveredInstance + package: '@azure/msal-common' + summary: Authority functions + - name: AuthorityGetCloudDiscoveryMetadataFromNetwork + uid: >- + @azure/msal-common.PerformanceEvents.AuthorityGetCloudDiscoveryMetadataFromNetwork + package: '@azure/msal-common' + summary: '' + - name: AuthorityGetEndpointMetadataFromNetwork + uid: >- + @azure/msal-common.PerformanceEvents.AuthorityGetEndpointMetadataFromNetwork + package: '@azure/msal-common' + summary: '' + - name: AuthorityResolveEndpointsAsync + uid: '@azure/msal-common.PerformanceEvents.AuthorityResolveEndpointsAsync' + package: '@azure/msal-common' + summary: '' + - name: AuthorityResolveEndpointsFromLocalSources + uid: >- + @azure/msal-common.PerformanceEvents.AuthorityResolveEndpointsFromLocalSources + package: '@azure/msal-common' + summary: '' + - name: AuthorityUpdateCloudDiscoveryMetadata + uid: '@azure/msal-common.PerformanceEvents.AuthorityUpdateCloudDiscoveryMetadata' + package: '@azure/msal-common' + summary: '' + - name: AuthorityUpdateEndpointMetadata + uid: '@azure/msal-common.PerformanceEvents.AuthorityUpdateEndpointMetadata' + package: '@azure/msal-common' + summary: '' + - name: AuthorityUpdateMetadataWithRegionalInformation + uid: >- + @azure/msal-common.PerformanceEvents.AuthorityUpdateMetadataWithRegionalInformation + package: '@azure/msal-common' + summary: '' + - name: AuthorizationCodeClientExecutePostToTokenEndpoint + uid: >- + @azure/msal-common.PerformanceEvents.AuthorizationCodeClientExecutePostToTokenEndpoint + package: '@azure/msal-common' + summary: '' + - name: AwaitConcurrentIframe + uid: '@azure/msal-common.PerformanceEvents.AwaitConcurrentIframe' + package: '@azure/msal-common' + summary: '' + - name: BaseClientCreateTokenRequestHeaders + uid: '@azure/msal-common.PerformanceEvents.BaseClientCreateTokenRequestHeaders' + package: '@azure/msal-common' + summary: Time spent creating default headers for requests to token endpoint + - name: BrokerHandhshake + uid: '@azure/msal-common.PerformanceEvents.BrokerHandhshake' + package: '@azure/msal-common' + summary: >- + Used to measure the time taken for completing embedded-broker handshake + (PW-Broker). + - name: CacheManagerGetRefreshToken + uid: '@azure/msal-common.PerformanceEvents.CacheManagerGetRefreshToken' + package: '@azure/msal-common' + summary: '' + - name: ClearTokensAndKeysWithClaims + uid: '@azure/msal-common.PerformanceEvents.ClearTokensAndKeysWithClaims' + package: '@azure/msal-common' + summary: Cache operations + - name: CryptoOptsGetPublicKeyThumbprint + uid: '@azure/msal-common.PerformanceEvents.CryptoOptsGetPublicKeyThumbprint' + package: '@azure/msal-common' + summary: >- + getPublicKeyThumbprint API in CryptoOpts class (msal-browser). + + Used to generate a public/private keypair and generate a public key + thumbprint for pop requests. + - name: CryptoOptsSignJwt + uid: '@azure/msal-common.PerformanceEvents.CryptoOptsSignJwt' + package: '@azure/msal-common' + summary: |- + signJwt API in CryptoOpts class (msal-browser). + Used to signed a pop token. + - name: DeserializeResponse + uid: '@azure/msal-common.PerformanceEvents.DeserializeResponse' + package: '@azure/msal-common' + summary: '' + - name: FetchAccountIdWithNativeBroker + uid: '@azure/msal-common.PerformanceEvents.FetchAccountIdWithNativeBroker' + package: '@azure/msal-common' + summary: |- + acquireToken APIs in msal-browser. + Used to make an /authorize endpoint call with native brokering enabled. + - name: GenerateCodeChallengeFromVerifier + uid: '@azure/msal-common.PerformanceEvents.GenerateCodeChallengeFromVerifier' + package: '@azure/msal-common' + summary: '' + - name: GenerateCodeVerifier + uid: '@azure/msal-common.PerformanceEvents.GenerateCodeVerifier' + package: '@azure/msal-common' + summary: '' + - name: GeneratePkceCodes + uid: '@azure/msal-common.PerformanceEvents.GeneratePkceCodes' + package: '@azure/msal-common' + summary: Crypto Operations + - name: GetAuthCodeUrl + uid: '@azure/msal-common.PerformanceEvents.GetAuthCodeUrl' + package: '@azure/msal-common' + summary: getAuthCodeUrl API (msal-browser and msal-node). + - name: GetCloudDiscoveryMetadataFromNetworkMeasurement + uid: >- + @azure/msal-common.PerformanceEvents.GetCloudDiscoveryMetadataFromNetworkMeasurement + package: '@azure/msal-common' + summary: '' + - name: GetEndpointMetadataFromNetwork + uid: '@azure/msal-common.PerformanceEvents.GetEndpointMetadataFromNetwork' + package: '@azure/msal-common' + summary: '' + - name: GetRandomValues + uid: '@azure/msal-common.PerformanceEvents.GetRandomValues' + package: '@azure/msal-common' + summary: '' + - name: HandleCodeResponse + uid: '@azure/msal-common.PerformanceEvents.HandleCodeResponse' + package: '@azure/msal-common' + summary: '' + - name: HandleCodeResponseFromServer + uid: '@azure/msal-common.PerformanceEvents.HandleCodeResponseFromServer' + package: '@azure/msal-common' + summary: Functions from InteractionHandler (msal-browser) + - name: HandleNativeRedirectPromiseMeasurement + uid: >- + @azure/msal-common.PerformanceEvents.HandleNativeRedirectPromiseMeasurement + package: '@azure/msal-common' + summary: '' + - name: HandleRedirectPromiseMeasurement + uid: '@azure/msal-common.PerformanceEvents.HandleRedirectPromiseMeasurement' + package: '@azure/msal-common' + summary: '' + - name: HandleServerTokenResponse + uid: '@azure/msal-common.PerformanceEvents.HandleServerTokenResponse' + package: '@azure/msal-common' + summary: handleServerTokenResponse API in ResponseHandler (msal-common) + - name: InitializeBaseRequest + uid: '@azure/msal-common.PerformanceEvents.InitializeBaseRequest' + package: '@azure/msal-common' + summary: >- + Internal API for initializing base request in BaseInteractionClient + (msal-browser) + - name: InitializeClientApplication + uid: '@azure/msal-common.PerformanceEvents.InitializeClientApplication' + package: '@azure/msal-common' + summary: '' + - name: InitializeSilentRequest + uid: '@azure/msal-common.PerformanceEvents.InitializeSilentRequest' + package: '@azure/msal-common' + summary: >- + Internal API for initializing silent request in SilentCacheClient + (msal-browser) + - name: NativeGenerateAuthResult + uid: '@azure/msal-common.PerformanceEvents.NativeGenerateAuthResult' + package: '@azure/msal-common' + summary: '' + - name: NativeInteractionClientAcquireToken + uid: '@azure/msal-common.PerformanceEvents.NativeInteractionClientAcquireToken' + package: '@azure/msal-common' + summary: >- + acquireToken API in NativeInteractionClient class (msal-browser). + + Used to acquire a token from Native component when native brokering is + enabled. + - name: NativeMessageHandlerHandshake + uid: '@azure/msal-common.PerformanceEvents.NativeMessageHandlerHandshake' + package: '@azure/msal-common' + summary: '' + - name: PopTokenGenerateCnf + uid: '@azure/msal-common.PerformanceEvents.PopTokenGenerateCnf' + package: '@azure/msal-common' + summary: Generate functions in PopTokenGenerator (msal-common) + - name: PopTokenGenerateKid + uid: '@azure/msal-common.PerformanceEvents.PopTokenGenerateKid' + package: '@azure/msal-common' + summary: '' + - name: RefreshTokenClientAcquireToken + uid: '@azure/msal-common.PerformanceEvents.RefreshTokenClientAcquireToken' + package: '@azure/msal-common' + summary: Time taken for acquiring refresh token , records RT size + - name: RefreshTokenClientAcquireTokenByRefreshToken + uid: >- + @azure/msal-common.PerformanceEvents.RefreshTokenClientAcquireTokenByRefreshToken + package: '@azure/msal-common' + summary: acquireTokenByRefreshToken API in RefreshTokenClient (msal-common). + - name: RefreshTokenClientAcquireTokenWithCachedRefreshToken + uid: >- + @azure/msal-common.PerformanceEvents.RefreshTokenClientAcquireTokenWithCachedRefreshToken + package: '@azure/msal-common' + summary: Time taken for acquiring cached refresh token + - name: RefreshTokenClientCreateTokenRequestBody + uid: >- + @azure/msal-common.PerformanceEvents.RefreshTokenClientCreateTokenRequestBody + package: '@azure/msal-common' + summary: >- + Helper function to create token request body in RefreshTokenClient + (msal-common). + - name: RefreshTokenClientExecutePostToTokenEndpoint + uid: >- + @azure/msal-common.PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint + package: '@azure/msal-common' + summary: >- + Time spent sending/waiting for the response of a request to the token + endpoint + - name: RefreshTokenClientExecuteTokenRequest + uid: '@azure/msal-common.PerformanceEvents.RefreshTokenClientExecuteTokenRequest' + package: '@azure/msal-common' + summary: Time spent on the network for refresh token acquisition + - name: RegionDiscoveryDetectRegion + uid: '@azure/msal-common.PerformanceEvents.RegionDiscoveryDetectRegion' + package: '@azure/msal-common' + summary: Region Discovery functions + - name: RegionDiscoveryGetCurrentVersion + uid: '@azure/msal-common.PerformanceEvents.RegionDiscoveryGetCurrentVersion' + package: '@azure/msal-common' + summary: '' + - name: RegionDiscoveryGetRegionFromIMDS + uid: '@azure/msal-common.PerformanceEvents.RegionDiscoveryGetRegionFromIMDS' + package: '@azure/msal-common' + summary: '' + - name: RemoveHiddenIframe + uid: '@azure/msal-common.PerformanceEvents.RemoveHiddenIframe' + package: '@azure/msal-common' + summary: '' + - name: Sha256Digest + uid: '@azure/msal-common.PerformanceEvents.Sha256Digest' + package: '@azure/msal-common' + summary: '' + - name: SilentCacheClientAcquireToken + uid: '@azure/msal-common.PerformanceEvents.SilentCacheClientAcquireToken' + package: '@azure/msal-common' + summary: |- + acquireToken API in the SilentCacheClient class (msal-browser). + Used to read access tokens from the cache. + - name: SilentFlowClientAcquireCachedToken + uid: '@azure/msal-common.PerformanceEvents.SilentFlowClientAcquireCachedToken' + package: '@azure/msal-common' + summary: '' + - name: SilentFlowClientGenerateResultFromCacheRecord + uid: >- + @azure/msal-common.PerformanceEvents.SilentFlowClientGenerateResultFromCacheRecord + package: '@azure/msal-common' + summary: '' + - name: SilentHandlerInitiateAuthRequest + uid: '@azure/msal-common.PerformanceEvents.SilentHandlerInitiateAuthRequest' + package: '@azure/msal-common' + summary: SilentHandler + - name: SilentHandlerLoadFrame + uid: '@azure/msal-common.PerformanceEvents.SilentHandlerLoadFrame' + package: '@azure/msal-common' + summary: '' + - name: SilentHandlerLoadFrameSync + uid: '@azure/msal-common.PerformanceEvents.SilentHandlerLoadFrameSync' + package: '@azure/msal-common' + summary: '' + - name: SilentHandlerMonitorIframeForHash + uid: '@azure/msal-common.PerformanceEvents.SilentHandlerMonitorIframeForHash' + package: '@azure/msal-common' + summary: '' + - name: SilentIframeClientAcquireToken + uid: '@azure/msal-common.PerformanceEvents.SilentIframeClientAcquireToken' + package: '@azure/msal-common' + summary: >- + acquireToken API in the SilentIframeClient class (msal-browser). + + Used to acquire a new set of tokens from the authorize endpoint in a + hidden iframe. + - name: SilentIframeClientTokenHelper + uid: '@azure/msal-common.PerformanceEvents.SilentIframeClientTokenHelper' + package: '@azure/msal-common' + summary: Helper function in SilentIframeClient class (msal-browser). + - name: SilentRefreshClientAcquireToken + uid: '@azure/msal-common.PerformanceEvents.SilentRefreshClientAcquireToken' + package: '@azure/msal-common' + summary: >- + acquireToken API in SilentRereshClient (msal-browser). + + Used to acquire a new set of tokens from the token endpoint using a + refresh token. + - name: SsoSilent + uid: '@azure/msal-common.PerformanceEvents.SsoSilent' + package: '@azure/msal-common' + summary: >- + ssoSilent API (msal-browser). + + Used to silently acquire an authorization code and set of tokens using a + hidden iframe. + - name: StandardInteractionClientCreateAuthCodeClient + uid: >- + @azure/msal-common.PerformanceEvents.StandardInteractionClientCreateAuthCodeClient + package: '@azure/msal-common' + summary: Helper functions in StandardInteractionClient class (msal-browser) + - name: StandardInteractionClientGetClientConfiguration + uid: >- + @azure/msal-common.PerformanceEvents.StandardInteractionClientGetClientConfiguration + package: '@azure/msal-common' + summary: '' + - name: StandardInteractionClientGetDiscoveredAuthority + uid: >- + @azure/msal-common.PerformanceEvents.StandardInteractionClientGetDiscoveredAuthority + package: '@azure/msal-common' + summary: >- + getDiscoveredAuthority API in StandardInteractionClient class + (msal-browser). + + Used to load authority metadata for a request. + - name: StandardInteractionClientInitializeAuthorizationCodeRequest + uid: >- + @azure/msal-common.PerformanceEvents.StandardInteractionClientInitializeAuthorizationCodeRequest + package: '@azure/msal-common' + summary: '' + - name: StandardInteractionClientInitializeAuthorizationRequest + uid: >- + @azure/msal-common.PerformanceEvents.StandardInteractionClientInitializeAuthorizationRequest + package: '@azure/msal-common' + summary: '' + - name: UpdateCloudDiscoveryMetadataMeasurement + uid: >- + @azure/msal-common.PerformanceEvents.UpdateCloudDiscoveryMetadataMeasurement + package: '@azure/msal-common' + summary: '' + - name: UpdateTokenEndpointAuthority + uid: '@azure/msal-common.PerformanceEvents.UpdateTokenEndpointAuthority' + package: '@azure/msal-common' + summary: '' + - name: UsernamePasswordClientAcquireToken + uid: '@azure/msal-common.PerformanceEvents.UsernamePasswordClientAcquireToken' + package: '@azure/msal-common' + summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml b/msal/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml new file mode 100644 index 0000000..47c2d0a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: PersistentCacheKeys +uid: '@azure/msal-common.PersistentCacheKeys' +package: '@azure/msal-common' +summary: '' +fullName: PersistentCacheKeys +remarks: '' +isDeprecated: false +syntax: | + type PersistentCacheKeys = + (typeof PersistentCacheKeys)[keyof typeof PersistentCacheKeys] diff --git a/msal/docs-ref-autogen/@azure/msal-common/PkceCodes.yml b/msal/docs-ref-autogen/@azure/msal-common/PkceCodes.yml new file mode 100644 index 0000000..6d066e8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/PkceCodes.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: PkceCodes +uid: '@azure/msal-common.PkceCodes' +package: '@azure/msal-common' +summary: |- + The PkceCodes type describes the structure + of objects that contain PKCE code + challenge and verifier pairs +fullName: PkceCodes +remarks: '' +isDeprecated: false +syntax: | + type PkceCodes = { challenge: string; verifier: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/PreQueueEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PreQueueEvent.yml new file mode 100644 index 0000000..9d5442b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/PreQueueEvent.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: PreQueueEvent +uid: '@azure/msal-common.PreQueueEvent' +package: '@azure/msal-common' +summary: '' +fullName: PreQueueEvent +remarks: '' +isDeprecated: false +type: interface +properties: + - name: name + uid: '@azure/msal-common.PreQueueEvent.name' + package: '@azure/msal-common' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: PerformanceEvents' + return: + description: '' + type: + - name: time + uid: '@azure/msal-common.PreQueueEvent.time' + package: '@azure/msal-common' + summary: '' + fullName: time + remarks: '' + isDeprecated: false + syntax: + content: 'time: number' + return: + description: '' + type: number diff --git a/msal/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml b/msal/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml new file mode 100644 index 0000000..1227cf3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ProtocolMode +uid: '@azure/msal-common.ProtocolMode' +package: '@azure/msal-common' +summary: '' +fullName: ProtocolMode +remarks: '' +isDeprecated: false +syntax: | + type ProtocolMode = (typeof ProtocolMode)[keyof typeof ProtocolMode] diff --git a/msal/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml new file mode 100644 index 0000000..7c00451 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: ProtocolUtils +uid: '@azure/msal-common.ProtocolUtils' +package: '@azure/msal-common' +summary: Class which provides helpers for OAuth 2.0 protocol specific values +fullName: ProtocolUtils +remarks: '' +isDeprecated: false +type: class +methods: + - name: generateLibraryState(ICrypto, Record) + uid: '@azure/msal-common.ProtocolUtils.generateLibraryState' + package: '@azure/msal-common' + summary: Generates the state value used by the common library. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function generateLibraryState(cryptoObj: ICrypto, meta?: + Record): string + parameters: + - id: cryptoObj + type: + description: '' + - id: meta + type: Record<string, string> + description: '' + return: + description: '' + type: string + - name: parseRequestState(ICrypto, string) + uid: '@azure/msal-common.ProtocolUtils.parseRequestState' + package: '@azure/msal-common' + summary: >- + Parses the state into the RequestStateObject, which contains the + LibraryState info and the state passed by the user. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function parseRequestState(cryptoObj: ICrypto, state: string): + RequestStateObject + parameters: + - id: cryptoObj + type: + description: '' + - id: state + type: string + description: '' + return: + description: '' + type: + - name: setRequestState(ICrypto, string, Record) + uid: '@azure/msal-common.ProtocolUtils.setRequestState' + package: '@azure/msal-common' + summary: Appends user state with random guid, or returns random guid. + remarks: '' + isDeprecated: false + syntax: + content: >- + static function setRequestState(cryptoObj: ICrypto, userState?: string, + meta?: Record): string + parameters: + - id: cryptoObj + type: + description: '' + - id: userState + type: string + description: '' + - id: meta + type: Record<string, string> + description: '' + return: + description: '' + type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/QueueMeasurement.yml b/msal/docs-ref-autogen/@azure/msal-common/QueueMeasurement.yml new file mode 100644 index 0000000..90a1240 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/QueueMeasurement.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: QueueMeasurement +uid: '@azure/msal-common.QueueMeasurement' +package: '@azure/msal-common' +summary: Queue measurement type +fullName: QueueMeasurement +remarks: '' +isDeprecated: false +syntax: | + type QueueMeasurement = { + eventName: string + manuallyCompleted?: boolean + queueTime: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml new file mode 100644 index 0000000..6aadc7a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: RefreshTokenEntity +uid: '@azure/msal-common.RefreshTokenEntity' +package: '@azure/msal-common' +summary: Refresh Token Cache Type +fullName: RefreshTokenEntity +remarks: '' +isDeprecated: false +syntax: | + type RefreshTokenEntity = CredentialEntity & { expiresOn?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml b/msal/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml new file mode 100644 index 0000000..d4693a2 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: RequestStateObject +uid: '@azure/msal-common.RequestStateObject' +package: '@azure/msal-common' +summary: >- + Type which defines the stringified and encoded object sent to the service in + the authorize request. +fullName: RequestStateObject +remarks: '' +isDeprecated: false +syntax: | + type RequestStateObject = { + libraryState: LibraryStateObject + userRequestState: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml b/msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml new file mode 100644 index 0000000..0d8f6a7 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml @@ -0,0 +1,22 @@ +### YamlMime:TSTypeAlias +name: RequestThumbprint +uid: '@azure/msal-common.RequestThumbprint' +package: '@azure/msal-common' +summary: Type representing a unique request thumbprint. +fullName: RequestThumbprint +remarks: '' +isDeprecated: false +syntax: | + type RequestThumbprint = { + authenticationScheme?: AuthenticationScheme + authority: string + claims?: string + clientId: string + homeAccountIdentifier?: string + resourceRequestMethod?: string + resourceRequestUri?: string + scopes: string[] + shrClaims?: string + shrOptions?: ShrOptions + sshKid?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ResponseMode.yml b/msal/docs-ref-autogen/@azure/msal-common/ResponseMode.yml new file mode 100644 index 0000000..5846dae --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ResponseMode.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ResponseMode +uid: '@azure/msal-common.ResponseMode' +package: '@azure/msal-common' +summary: '' +fullName: ResponseMode +remarks: '' +isDeprecated: false +syntax: | + type ResponseMode = (typeof ResponseMode)[keyof typeof ResponseMode] diff --git a/msal/docs-ref-autogen/@azure/msal-common/ScopeSet.yml b/msal/docs-ref-autogen/@azure/msal-common/ScopeSet.yml new file mode 100644 index 0000000..a20b77e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ScopeSet.yml @@ -0,0 +1,223 @@ +### YamlMime:TSType +name: ScopeSet +uid: '@azure/msal-common.ScopeSet' +package: '@azure/msal-common' +summary: >- + The ScopeSet class creates a set of scopes. Scopes are case-insensitive, + unique values, so the Set object in JS makes + + the most sense to implement for this class. All scopes are trimmed and + converted to lower case strings in intersection and union functions + + to ensure uniqueness of strings. +fullName: ScopeSet +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ScopeSet(string[]) + uid: '@azure/msal-common.ScopeSet.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ScopeSet(inputScopes: string[])' + parameters: + - id: inputScopes + type: string[] + description: '' +methods: + - name: appendScope(string) + uid: '@azure/msal-common.ScopeSet.appendScope' + package: '@azure/msal-common' + summary: Appends single scope if passed + remarks: '' + isDeprecated: false + syntax: + content: 'function appendScope(newScope: string)' + parameters: + - id: newScope + type: string + description: '' + - name: appendScopes(string[]) + uid: '@azure/msal-common.ScopeSet.appendScopes' + package: '@azure/msal-common' + summary: Appends multiple scopes if passed + remarks: '' + isDeprecated: false + syntax: + content: 'function appendScopes(newScopes: string[])' + parameters: + - id: newScopes + type: string[] + description: '' + - name: asArray() + uid: '@azure/msal-common.ScopeSet.asArray' + package: '@azure/msal-common' + summary: Returns the scopes as an array of string values + remarks: '' + isDeprecated: false + syntax: + content: 'function asArray(): string[]' + return: + description: '' + type: string[] + - name: containsOnlyOIDCScopes() + uid: '@azure/msal-common.ScopeSet.containsOnlyOIDCScopes' + package: '@azure/msal-common' + summary: Check if set of scopes contains only the defaults + remarks: '' + isDeprecated: false + syntax: + content: 'function containsOnlyOIDCScopes(): boolean' + return: + description: '' + type: boolean + - name: containsScope(string) + uid: '@azure/msal-common.ScopeSet.containsScope' + package: '@azure/msal-common' + summary: Check if a given scope is present in this set of scopes. + remarks: '' + isDeprecated: false + syntax: + content: 'function containsScope(scope: string): boolean' + parameters: + - id: scope + type: string + description: '' + return: + description: '' + type: boolean + - name: containsScopeSet(ScopeSet) + uid: '@azure/msal-common.ScopeSet.containsScopeSet' + package: '@azure/msal-common' + summary: Check if a set of scopes is present in this set of scopes. + remarks: '' + isDeprecated: false + syntax: + content: 'function containsScopeSet(scopeSet: ScopeSet): boolean' + parameters: + - id: scopeSet + type: + description: '' + return: + description: '' + type: boolean + - name: createSearchScopes(string[]) + uid: '@azure/msal-common.ScopeSet.createSearchScopes' + package: '@azure/msal-common' + summary: Creates the set of scopes to search for in cache lookups + remarks: '' + isDeprecated: false + syntax: + content: 'static function createSearchScopes(inputScopeString: string[]): ScopeSet' + parameters: + - id: inputScopeString + type: string[] + description: '' + return: + description: '' + type: + - name: fromString(string) + uid: '@azure/msal-common.ScopeSet.fromString' + package: '@azure/msal-common' + summary: Factory method to create ScopeSet from space-delimited string + remarks: '' + isDeprecated: false + syntax: + content: 'static function fromString(inputScopeString: string): ScopeSet' + parameters: + - id: inputScopeString + type: string + description: '' + return: + description: '' + type: + - name: getScopeCount() + uid: '@azure/msal-common.ScopeSet.getScopeCount' + package: '@azure/msal-common' + summary: Returns size of set of scopes. + remarks: '' + isDeprecated: false + syntax: + content: 'function getScopeCount(): number' + return: + description: '' + type: number + - name: intersectingScopeSets(ScopeSet) + uid: '@azure/msal-common.ScopeSet.intersectingScopeSets' + package: '@azure/msal-common' + summary: Check if scopes intersect between this set and another. + remarks: '' + isDeprecated: false + syntax: + content: 'function intersectingScopeSets(otherScopes: ScopeSet): boolean' + parameters: + - id: otherScopes + type: + description: '' + return: + description: '' + type: boolean + - name: printScopes() + uid: '@azure/msal-common.ScopeSet.printScopes' + package: '@azure/msal-common' + summary: Prints scopes into a space-delimited string + remarks: '' + isDeprecated: false + syntax: + content: 'function printScopes(): string' + return: + description: '' + type: string + - name: printScopesLowerCase() + uid: '@azure/msal-common.ScopeSet.printScopesLowerCase' + package: '@azure/msal-common' + summary: Prints scopes into a space-delimited lower-case string (used for caching) + remarks: '' + isDeprecated: false + syntax: + content: 'function printScopesLowerCase(): string' + return: + description: '' + type: string + - name: removeOIDCScopes() + uid: '@azure/msal-common.ScopeSet.removeOIDCScopes' + package: '@azure/msal-common' + summary: >- + Removes default scopes from set of scopes + + Primarily used to prevent cache misses if the default scopes are not + returned from the server + remarks: '' + isDeprecated: false + syntax: + content: function removeOIDCScopes() + - name: removeScope(string) + uid: '@azure/msal-common.ScopeSet.removeScope' + package: '@azure/msal-common' + summary: Removes element from set of scopes. + remarks: '' + isDeprecated: false + syntax: + content: 'function removeScope(scope: string)' + parameters: + - id: scope + type: string + description: '' + - name: unionScopeSets(ScopeSet) + uid: '@azure/msal-common.ScopeSet.unionScopeSets' + package: '@azure/msal-common' + summary: Combines an array of scopes with the current set of scopes. + remarks: '' + isDeprecated: false + syntax: + content: 'function unionScopeSets(otherScopes: ScopeSet): Set' + parameters: + - id: otherScopes + type: + description: '' + return: + description: '' + type: Set<string> diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml new file mode 100644 index 0000000..db6a791 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml @@ -0,0 +1,32 @@ +### YamlMime:TSTypeAlias +name: ServerAuthorizationCodeResponse +uid: '@azure/msal-common.ServerAuthorizationCodeResponse' +package: '@azure/msal-common' +summary: |- + Deserialized response object from server authorization code request. + - code: authorization code from server + - client_info: client info object + - state: OAuth2 request state + - error: error sent back in hash + - error: description +fullName: ServerAuthorizationCodeResponse +remarks: '' +isDeprecated: false +syntax: | + type ServerAuthorizationCodeResponse = { + accountId?: string + claims?: string + client_info?: string + cloud_graph_host_name?: string + cloud_instance_host_name?: string + cloud_instance_name?: string + code?: string + correlation_id?: string + error?: string + error_description?: string + msgraph_host?: string + state?: string + suberror?: string + timestamp?: string + trace_id?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml new file mode 100644 index 0000000..7a806e9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml @@ -0,0 +1,80 @@ +### YamlMime:TSTypeAlias +name: ServerAuthorizationTokenResponse +uid: '@azure/msal-common.ServerAuthorizationTokenResponse' +package: '@azure/msal-common' +summary: >- + Deserialized response object from server authorization code request. + + - token_type: Indicates the token type value. Can be either Bearer or pop. + + - scope: The scopes that the access_token is valid for. + + - expires_in: How long the access token is valid (in seconds). + + - refresh_in: Duration afer which a token should be renewed, regardless of + expiration. + + - ext_expires_in: How long the access token is valid (in seconds) if the + server isn't responding. + + - access_token: The requested access token. The app can use this token to + authenticate to the secured resource, such as a web API. + + - refresh_token: An OAuth 2.0 refresh token. The app can use this token + acquire additional access tokens after the current access token expires. + + - id_token: A JSON Web Token (JWT). The app can decode the segments of this + token to request information about the user who signed in. + + - key_id: A string that uniquely identifies a public key that the request is + bound to. + + + In case of error: + + - error: An error code string that can be used to classify types of errors + that occur, and can be used to react to errors. + + - error_description: A specific error message that can help a developer + identify the root cause of an authentication error. + + - error_codes: A list of STS-specific error codes that can help in + diagnostics. + + - timestamp: The time at which the error occurred. + + - trace_id: A unique identifier for the request that can help in diagnostics. + + - correlation_id: A unique identifier for the request that can help in + diagnostics across components. + + - status: the network request's response status +fullName: ServerAuthorizationTokenResponse +remarks: '' +isDeprecated: false +syntax: | + type ServerAuthorizationTokenResponse = { + access_token?: string + claims?: string + client_info?: string + correlation_id?: string + error?: string + error_codes?: string[] + error_description?: string + expires_in?: number + ext_expires_in?: number + foci?: string + id_token?: string + key_id?: string + refresh_in?: number + refresh_token?: string + refresh_token_expires_in?: number + scope?: string + spa_accountid?: string + spa_code?: string + status?: number + suberror?: string + timestamp?: string + token_type?: AuthenticationScheme + trace_id?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml new file mode 100644 index 0000000..d63a2ba --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: ServerDeviceCodeResponse +uid: '@azure/msal-common.ServerDeviceCodeResponse' +package: '@azure/msal-common' +summary: '' +fullName: ServerDeviceCodeResponse +remarks: '' +isDeprecated: false +syntax: | + type ServerDeviceCodeResponse = { + device_code: string + expires_in: number + interval: number + message: string + user_code: string + verification_uri: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml new file mode 100644 index 0000000..f6d6ace --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml @@ -0,0 +1,208 @@ +### YamlMime:TSType +name: ServerError +uid: '@azure/msal-common.ServerError' +package: '@azure/msal-common' +summary: >- + Error thrown when there is an error with the server code, for example, + unavailability. +fullName: ServerError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ServerError(string, string, string) + uid: '@azure/msal-common.ServerError.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ServerError(errorCode?: string, errorMessage?: string, subError?: + string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: subError + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-common.ServerError.correlationId' + package: '@azure/msal-common' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-common.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-common.ServerError.errorCode' + package: '@azure/msal-common' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-common.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-common.ServerError.errorMessage' + package: '@azure/msal-common' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-common.AuthError.errorMessage) + - name: message + uid: '@azure/msal-common.ServerError.message' + package: '@azure/msal-common' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-common.AuthError.message) + - name: name + uid: '@azure/msal-common.ServerError.name' + package: '@azure/msal-common' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-common.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-common.ServerError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-common.ServerError.stack' + package: '@azure/msal-common' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-common.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-common.ServerError.stackTraceLimit' + package: '@azure/msal-common' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-common.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-common.ServerError.subError' + package: '@azure/msal-common' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-common.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.ServerError.captureStackTrace' + package: '@azure/msal-common' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-common.ServerError.setCorrelationId' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerResponseType.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerResponseType.yml new file mode 100644 index 0000000..07685ad --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerResponseType.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: ServerResponseType +uid: '@azure/msal-common.ServerResponseType' +package: '@azure/msal-common' +summary: '' +fullName: ServerResponseType +remarks: '' +isDeprecated: false +syntax: | + type ServerResponseType = + (typeof ServerResponseType)[keyof typeof ServerResponseType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml new file mode 100644 index 0000000..889b47f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: ServerTelemetryEntity +uid: '@azure/msal-common.ServerTelemetryEntity' +package: '@azure/msal-common' +summary: '' +fullName: ServerTelemetryEntity +remarks: '' +isDeprecated: false +syntax: | + type ServerTelemetryEntity = { + cacheHits: number + errors: string[] + failedRequests: (string | number)[] + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml new file mode 100644 index 0000000..d89bb6e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: ServerTelemetryRequest +uid: '@azure/msal-common.ServerTelemetryRequest' +package: '@azure/msal-common' +summary: '' +fullName: ServerTelemetryRequest +remarks: '' +isDeprecated: false +syntax: | + type ServerTelemetryRequest = { + apiId: number + clientId: string + correlationId: string + forceRefresh?: boolean + wrapperSKU?: string + wrapperVer?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ShrOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/ShrOptions.yml new file mode 100644 index 0000000..87d7f69 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ShrOptions.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ShrOptions +uid: '@azure/msal-common.ShrOptions' +package: '@azure/msal-common' +summary: '' +fullName: ShrOptions +remarks: '' +isDeprecated: false +syntax: | + type ShrOptions = { header: JoseHeaderOptions } diff --git a/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml new file mode 100644 index 0000000..f2c8ddc --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: SignedHttpRequest +uid: '@azure/msal-common.SignedHttpRequest' +package: '@azure/msal-common' +summary: '' +fullName: SignedHttpRequest +remarks: '' +isDeprecated: false +syntax: | + type SignedHttpRequest = { + at?: string + client_claims?: string + cnf?: object + m?: string + nonce?: string + p?: string + q?: [string[], string] + ts?: number + u?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml b/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml new file mode 100644 index 0000000..1f2dfa4 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: SignedHttpRequestParameters +uid: '@azure/msal-common.SignedHttpRequestParameters' +package: '@azure/msal-common' +summary: '' +fullName: SignedHttpRequestParameters +remarks: '' +isDeprecated: false +syntax: | + type SignedHttpRequestParameters = Pick< + BaseAuthRequest, + | "resourceRequestMethod" + | "resourceRequestUri" + | "shrClaims" + | "shrNonce" + | "shrOptions" + > & { correlationId?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/StaticAuthorityOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/StaticAuthorityOptions.yml new file mode 100644 index 0000000..ef9fdf5 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/StaticAuthorityOptions.yml @@ -0,0 +1,15 @@ +### YamlMime:TSTypeAlias +name: StaticAuthorityOptions +uid: '@azure/msal-common.StaticAuthorityOptions' +package: '@azure/msal-common' +summary: '' +fullName: StaticAuthorityOptions +remarks: '' +isDeprecated: false +syntax: | + type StaticAuthorityOptions = Partial< + Pick + > & { + canonicalAuthority?: string + cloudDiscoveryMetadata?: CloudInstanceDiscoveryResponse + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/StoreInCache.yml b/msal/docs-ref-autogen/@azure/msal-common/StoreInCache.yml new file mode 100644 index 0000000..27be64c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/StoreInCache.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: StoreInCache +uid: '@azure/msal-common.StoreInCache' +package: '@azure/msal-common' +summary: >- + Controls whether tokens should be stored in the cache or not. If set to false, + tokens may still be acquired and returned but will not be cached for later + retrieval. +fullName: StoreInCache +remarks: '' +isDeprecated: false +syntax: | + type StoreInCache = { + accessToken?: boolean + idToken?: boolean + refreshToken?: boolean + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/StringDict.yml b/msal/docs-ref-autogen/@azure/msal-common/StringDict.yml new file mode 100644 index 0000000..e49d878 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/StringDict.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: StringDict +uid: '@azure/msal-common.StringDict' +package: '@azure/msal-common' +summary: Key-Value type to support queryParams, extraQueryParams and claims +fullName: StringDict +remarks: '' +isDeprecated: false +syntax: | + type StringDict = { [key: string]: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml new file mode 100644 index 0000000..58facc3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml @@ -0,0 +1,153 @@ +### YamlMime:TSType +name: StubPerformanceClient +uid: '@azure/msal-common.StubPerformanceClient' +package: '@azure/msal-common' +summary: '' +fullName: StubPerformanceClient +remarks: '' +isDeprecated: false +type: class +methods: + - name: addFields() + uid: '@azure/msal-common.StubPerformanceClient.addFields' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function addFields() + - name: addPerformanceCallback() + uid: '@azure/msal-common.StubPerformanceClient.addPerformanceCallback' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addPerformanceCallback(): string' + return: + description: '' + type: string + - name: addQueueMeasurement() + uid: '@azure/msal-common.StubPerformanceClient.addQueueMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function addQueueMeasurement() + - name: cacheEventByCorrelationId() + uid: '@azure/msal-common.StubPerformanceClient.cacheEventByCorrelationId' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function cacheEventByCorrelationId() + - name: calculateQueuedTime() + uid: '@azure/msal-common.StubPerformanceClient.calculateQueuedTime' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function calculateQueuedTime(): number' + return: + description: '' + type: number + - name: discardMeasurements() + uid: '@azure/msal-common.StubPerformanceClient.discardMeasurements' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function discardMeasurements() + - name: emitEvents() + uid: '@azure/msal-common.StubPerformanceClient.emitEvents' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function emitEvents() + - name: endMeasurement() + uid: '@azure/msal-common.StubPerformanceClient.endMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function endMeasurement(): null | PerformanceEvent' + return: + description: '' + type: null | + - name: generateId() + uid: '@azure/msal-common.StubPerformanceClient.generateId' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function generateId(): string' + return: + description: '' + type: string + - name: incrementFields() + uid: '@azure/msal-common.StubPerformanceClient.incrementFields' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function incrementFields() + - name: removePerformanceCallback() + uid: '@azure/msal-common.StubPerformanceClient.removePerformanceCallback' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function removePerformanceCallback(): boolean' + return: + description: '' + type: boolean + - name: setPreQueueTime() + uid: '@azure/msal-common.StubPerformanceClient.setPreQueueTime' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function setPreQueueTime() + - name: startMeasurement(string, string) + uid: '@azure/msal-common.StubPerformanceClient.startMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent + parameters: + - id: measureName + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: + - name: startPerformanceMeasurement() + uid: '@azure/msal-common.StubPerformanceClient.startPerformanceMeasurement' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: This method will be removed in the next major version + syntax: + content: 'function startPerformanceMeasurement(): IPerformanceMeasurement' + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-common/SubMeasurement.yml b/msal/docs-ref-autogen/@azure/msal-common/SubMeasurement.yml new file mode 100644 index 0000000..a45572d --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/SubMeasurement.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: SubMeasurement +uid: '@azure/msal-common.SubMeasurement' +package: '@azure/msal-common' +summary: '' +fullName: SubMeasurement +remarks: '' +isDeprecated: false +syntax: | + type SubMeasurement = { name: string; startTimeMs: number } diff --git a/msal/docs-ref-autogen/@azure/msal-common/SystemOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/SystemOptions.yml new file mode 100644 index 0000000..c6f37e3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/SystemOptions.yml @@ -0,0 +1,18 @@ +### YamlMime:TSTypeAlias +name: SystemOptions +uid: '@azure/msal-common.SystemOptions' +package: '@azure/msal-common' +summary: >- + Use this to configure token renewal info in the Configuration object + + + - tokenRenewalOffsetSeconds - Sets the window of offset needed to renew the + token before expiry +fullName: SystemOptions +remarks: '' +isDeprecated: false +syntax: | + type SystemOptions = { + preventCorsPreflight?: boolean + tokenRenewalOffsetSeconds?: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/TenantProfile.yml b/msal/docs-ref-autogen/@azure/msal-common/TenantProfile.yml new file mode 100644 index 0000000..dc26c5f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/TenantProfile.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: TenantProfile +uid: '@azure/msal-common.TenantProfile' +package: '@azure/msal-common' +summary: Account details that vary across tenants for the same user +fullName: TenantProfile +remarks: '' +isDeprecated: false +syntax: | + type TenantProfile = Pick< + AccountInfo, + "tenantId" | "localAccountId" | "name" + > & { isHomeTenant?: boolean } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml new file mode 100644 index 0000000..2daf056 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: ThrottlingEntity +uid: '@azure/msal-common.ThrottlingEntity' +package: '@azure/msal-common' +summary: '' +fullName: ThrottlingEntity +remarks: '' +isDeprecated: false +syntax: | + type ThrottlingEntity = { + error?: string + errorCodes?: string[] + errorMessage?: string + subError?: string + throttleTime: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml new file mode 100644 index 0000000..fcd2bb7 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml @@ -0,0 +1,73 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.TimeUtils' +name: TimeUtils +type: module +package: '@azure/msal-common' +summary: '' +functions: + - name: delay(number, T) + uid: '@azure/msal-common.TimeUtils.delay' + package: '@azure/msal-common' + summary: Waits for t number of milliseconds + remarks: '' + isDeprecated: false + syntax: + content: 'function delay(t: number, value?: T): Promise' + parameters: + - id: t + type: number + description: number + - id: value + type: T + description: T + return: + description: '' + type: Promise<T | void> + - name: isTokenExpired(string, number) + uid: '@azure/msal-common.TimeUtils.isTokenExpired' + package: '@azure/msal-common' + summary: check if a token is expired based on given UTC time in seconds. + remarks: '' + isDeprecated: false + syntax: + content: 'function isTokenExpired(expiresOn: string, offset: number): boolean' + parameters: + - id: expiresOn + type: string + description: '' + - id: offset + type: number + description: '' + return: + description: '' + type: boolean + - name: nowSeconds() + uid: '@azure/msal-common.TimeUtils.nowSeconds' + package: '@azure/msal-common' + summary: return the current time in Unix time (seconds). + remarks: '' + isDeprecated: false + syntax: + content: 'function nowSeconds(): number' + return: + description: '' + type: number + - name: wasClockTurnedBack(string) + uid: '@azure/msal-common.TimeUtils.wasClockTurnedBack' + package: '@azure/msal-common' + summary: >- + If the current time is earlier than the time that a token was cached at, + we must discard the token + + i.e. The system clock was turned back after acquiring the cached token + remarks: '' + isDeprecated: false + syntax: + content: 'function wasClockTurnedBack(cachedAt: string): boolean' + parameters: + - id: cachedAt + type: string + description: '' + return: + description: '' + type: boolean diff --git a/msal/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml b/msal/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml new file mode 100644 index 0000000..f810c14 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml @@ -0,0 +1,78 @@ +### YamlMime:TSType +name: TokenCacheContext +uid: '@azure/msal-common.TokenCacheContext' +package: '@azure/msal-common' +summary: |- + This class instance helps track the memory changes facilitating + decisions to read from and write to the persistent cache +fullName: TokenCacheContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TokenCacheContext(ISerializableTokenCache, boolean) + uid: '@azure/msal-common.TokenCacheContext.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new TokenCacheContext(tokenCache: ISerializableTokenCache, hasChanged: + boolean) + parameters: + - id: tokenCache + type: + description: '' + - id: hasChanged + type: boolean + description: '' +properties: + - name: cache + uid: '@azure/msal-common.TokenCacheContext.cache' + package: '@azure/msal-common' + summary: serializable token cache interface + fullName: cache + remarks: '' + isDeprecated: false + syntax: + content: 'cache: ISerializableTokenCache' + return: + description: '' + type: + - name: cacheHasChanged + uid: '@azure/msal-common.TokenCacheContext.cacheHasChanged' + package: '@azure/msal-common' + summary: boolean which indicates the changes in cache + fullName: cacheHasChanged + remarks: '' + isDeprecated: false + syntax: + content: boolean cacheHasChanged + return: + description: '' + type: boolean + - name: hasChanged + uid: '@azure/msal-common.TokenCacheContext.hasChanged' + package: '@azure/msal-common' + summary: boolean indicating cache change + fullName: hasChanged + remarks: '' + isDeprecated: false + syntax: + content: 'hasChanged: boolean' + return: + description: '' + type: boolean + - name: tokenCache + uid: '@azure/msal-common.TokenCacheContext.tokenCache' + package: '@azure/msal-common' + summary: function to retrieve the token cache + fullName: tokenCache + remarks: '' + isDeprecated: false + syntax: + content: ISerializableTokenCache tokenCache + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-common/TokenClaims.yml b/msal/docs-ref-autogen/@azure/msal-common/TokenClaims.yml new file mode 100644 index 0000000..f882833 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/TokenClaims.yml @@ -0,0 +1,44 @@ +### YamlMime:TSTypeAlias +name: TokenClaims +uid: '@azure/msal-common.TokenClaims' +package: '@azure/msal-common' +summary: Type which describes Id Token claims known by MSAL. +fullName: TokenClaims +remarks: '' +isDeprecated: false +syntax: | + type TokenClaims = { + acr?: string + amr?: string[] + at?: string + aud?: string + auth_time?: number + cloud_instance_host_name?: string + cnf?: { kid: string } + emails?: string[] + exp?: number + home_oid?: string + iat?: number + idp?: string + iss?: string + login_hint?: string + m?: string + name?: string + nbf?: number + nonce?: string + oid?: string + p?: string + preferred_username?: string + roles?: string[] + sid?: string + sub?: string + tenant_region_scope?: string + tenant_region_sub_scope?: string + tfp?: string + tid?: string + ts?: number + u?: string + upn?: string + ver?: string + x5c_ca?: string[] + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/TokenKeys.yml b/msal/docs-ref-autogen/@azure/msal-common/TokenKeys.yml new file mode 100644 index 0000000..b1e1ae2 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/TokenKeys.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: TokenKeys +uid: '@azure/msal-common.TokenKeys' +package: '@azure/msal-common' +summary: '' +fullName: TokenKeys +remarks: '' +isDeprecated: false +syntax: | + type TokenKeys = { + accessToken: string[] + idToken: string[] + refreshToken: string[] + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/UrlString.yml b/msal/docs-ref-autogen/@azure/msal-common/UrlString.yml new file mode 100644 index 0000000..c646f73 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/UrlString.yml @@ -0,0 +1,194 @@ +### YamlMime:TSType +name: UrlString +uid: '@azure/msal-common.UrlString' +package: '@azure/msal-common' +summary: Url object class which can perform various transformations on url strings. +fullName: UrlString +remarks: '' +isDeprecated: false +type: class +constructors: + - name: UrlString(string) + uid: '@azure/msal-common.UrlString.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new UrlString(url: string)' + parameters: + - id: url + type: string + description: '' +properties: + - name: urlString + uid: '@azure/msal-common.UrlString.urlString' + package: '@azure/msal-common' + summary: '' + fullName: urlString + remarks: '' + isDeprecated: false + syntax: + content: string urlString + return: + description: '' + type: string +methods: + - name: appendQueryString(string, string) + uid: '@azure/msal-common.UrlString.appendQueryString' + package: '@azure/msal-common' + summary: >- + Given a url and a query string return the url with provided query string + appended + remarks: '' + isDeprecated: false + syntax: + content: >- + static function appendQueryString(url: string, queryString: string): + string + parameters: + - id: url + type: string + description: '' + - id: queryString + type: string + description: '' + return: + description: '' + type: string + - name: canonicalizeUri(string) + uid: '@azure/msal-common.UrlString.canonicalizeUri' + package: '@azure/msal-common' + summary: Ensure urls are lower case and end with a / character. + remarks: '' + isDeprecated: false + syntax: + content: 'static function canonicalizeUri(url: string): string' + parameters: + - id: url + type: string + description: '' + return: + description: '' + type: string + - name: constructAuthorityUriFromObject(IUri) + uid: '@azure/msal-common.UrlString.constructAuthorityUriFromObject' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function constructAuthorityUriFromObject(urlObject: IUri): + UrlString + parameters: + - id: urlObject + type: + description: '' + return: + description: '' + type: + - name: getAbsoluteUrl(string, string) + uid: '@azure/msal-common.UrlString.getAbsoluteUrl' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + static function getAbsoluteUrl(relativeUrl: string, baseUrl: string): + string + parameters: + - id: relativeUrl + type: string + description: '' + - id: baseUrl + type: string + description: '' + return: + description: '' + type: string + - name: getDomainFromUrl(string) + uid: '@azure/msal-common.UrlString.getDomainFromUrl' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'static function getDomainFromUrl(url: string): string' + parameters: + - id: url + type: string + description: '' + return: + description: '' + type: string + - name: getUrlComponents() + uid: '@azure/msal-common.UrlString.getUrlComponents' + package: '@azure/msal-common' + summary: Parses out the components from a url string. + remarks: '' + isDeprecated: false + syntax: + content: 'function getUrlComponents(): IUri' + return: + description: >- + An object with the various components. Please cache this value insted + of calling this multiple times on the same url. + type: + - name: hashContainsKnownProperties(string) + uid: '@azure/msal-common.UrlString.hashContainsKnownProperties' + package: '@azure/msal-common' + summary: Check if the hash of the URL string contains known properties + remarks: '' + isDeprecated: true + customDeprecatedMessage: This API will be removed in a future version + syntax: + content: 'static function hashContainsKnownProperties(response: string): boolean' + parameters: + - id: response + type: string + description: '' + return: + description: '' + type: boolean + - name: removeHashFromUrl(string) + uid: '@azure/msal-common.UrlString.removeHashFromUrl' + package: '@azure/msal-common' + summary: Returns a url with the hash removed + remarks: '' + isDeprecated: false + syntax: + content: 'static function removeHashFromUrl(url: string): string' + parameters: + - id: url + type: string + description: '' + return: + description: '' + type: string + - name: replaceTenantPath(string) + uid: '@azure/msal-common.UrlString.replaceTenantPath' + package: '@azure/msal-common' + summary: >- + Given a url like https://a:b/common/d?e=f#g, and a tenantId, returns + https://a:b/tenantId/d + remarks: '' + isDeprecated: false + syntax: + content: 'function replaceTenantPath(tenantId: string): UrlString' + parameters: + - id: tenantId + type: string + description: The tenant id to replace + return: + description: '' + type: + - name: validateAsUri() + uid: '@azure/msal-common.UrlString.validateAsUri' + package: '@azure/msal-common' + summary: Throws if urlString passed is not a valid authority URI string. + remarks: '' + isDeprecated: false + syntax: + content: function validateAsUri() diff --git a/msal/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml new file mode 100644 index 0000000..463cb9e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: UrlToHttpRequestOptions +uid: '@azure/msal-common.UrlToHttpRequestOptions' +package: '@azure/msal-common' +summary: '' +fullName: UrlToHttpRequestOptions +remarks: '' +isDeprecated: false +syntax: | + type UrlToHttpRequestOptions = { + auth?: string + hash: string + hostname: string + href: string + path: string + pathname: string + port?: number + protocol: string + search: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml new file mode 100644 index 0000000..72a4e59 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml @@ -0,0 +1,43 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.UrlUtils' +name: UrlUtils +type: module +package: '@azure/msal-common' +summary: '' +functions: + - name: getDeserializedResponse(string) + uid: '@azure/msal-common.UrlUtils.getDeserializedResponse' + package: '@azure/msal-common' + summary: Returns URL hash as server auth code response object. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getDeserializedResponse(responseString: string): + ServerAuthorizationCodeResponse | null + parameters: + - id: responseString + type: string + description: '' + return: + description: '' + type: >- + | + null + - name: stripLeadingHashOrQuery(string) + uid: '@azure/msal-common.UrlUtils.stripLeadingHashOrQuery' + package: '@azure/msal-common' + summary: >- + Parses hash string from given string. Returns empty string if no hash + symbol is found. + remarks: '' + isDeprecated: false + syntax: + content: 'function stripLeadingHashOrQuery(responseString: string): string' + parameters: + - id: responseString + type: string + description: '' + return: + description: '' + type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml new file mode 100644 index 0000000..21e680f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -0,0 +1,422 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common' +name: '@azure/msal-common' +summary: '' +type: package +enums: + - '@azure/msal-common.LogLevel' + - '@azure/msal-common.PerformanceEventStatus' + - '@azure/msal-common.PerformanceEvents' +classes: + - '@azure/msal-common.AuthError' + - '@azure/msal-common.AuthenticationHeaderParser' + - '@azure/msal-common.CacheError' + - '@azure/msal-common.ClientAuthError' + - '@azure/msal-common.ClientConfigurationError' + - '@azure/msal-common.InteractionRequiredAuthError' + - '@azure/msal-common.Logger' + - '@azure/msal-common.PerformanceClient' + - '@azure/msal-common.ProtocolUtils' + - '@azure/msal-common.ScopeSet' + - '@azure/msal-common.ServerError' + - '@azure/msal-common.StubPerformanceClient' + - '@azure/msal-common.TokenCacheContext' + - '@azure/msal-common.UrlString' +interfaces: + - '@azure/msal-common.IAppTokenProvider' + - '@azure/msal-common.ICachePlugin' + - '@azure/msal-common.ICrypto' + - '@azure/msal-common.IGuidGenerator' + - '@azure/msal-common.ILoggerCallback' + - '@azure/msal-common.INativeBrokerPlugin' + - '@azure/msal-common.INetworkModule' + - '@azure/msal-common.IPerformanceClient' + - '@azure/msal-common.IPerformanceMeasurement' + - '@azure/msal-common.ISerializableTokenCache' + - '@azure/msal-common.IUri' + - '@azure/msal-common.PreQueueEvent' +typeAliases: + - '@azure/msal-common.AADAuthorityConstants' + - '@azure/msal-common.AccessTokenEntity' + - '@azure/msal-common.AccountFilter' + - '@azure/msal-common.AccountInfo' + - '@azure/msal-common.ActiveAccountFilters' + - '@azure/msal-common.AppMetadataEntity' + - '@azure/msal-common.AppTokenProviderParameters' + - '@azure/msal-common.AppTokenProviderResult' + - '@azure/msal-common.ApplicationTelemetry' + - '@azure/msal-common.AuthenticationResult' + - '@azure/msal-common.AuthenticationScheme' + - '@azure/msal-common.AuthorityOptions' + - '@azure/msal-common.AuthorityType' + - '@azure/msal-common.AuthorizationCodePayload' + - '@azure/msal-common.AzureCloudInstance' + - '@azure/msal-common.AzureCloudOptions' + - '@azure/msal-common.AzureRegion' + - '@azure/msal-common.AzureRegionConfiguration' + - '@azure/msal-common.BaseAuthRequest' + - '@azure/msal-common.CacheAccountType' + - '@azure/msal-common.CacheOptions' + - '@azure/msal-common.CacheOutcome' + - '@azure/msal-common.CacheType' + - '@azure/msal-common.CcsCredential' + - '@azure/msal-common.CcsCredentialType' + - '@azure/msal-common.ClaimsRequestKeys' + - '@azure/msal-common.ClientAssertion' + - '@azure/msal-common.ClientInfo' + - '@azure/msal-common.CommonAuthorizationCodeRequest' + - '@azure/msal-common.CommonAuthorizationUrlRequest' + - '@azure/msal-common.CommonClientCredentialRequest' + - '@azure/msal-common.CommonDeviceCodeRequest' + - '@azure/msal-common.CommonEndSessionRequest' + - '@azure/msal-common.CommonOnBehalfOfRequest' + - '@azure/msal-common.CommonRefreshTokenRequest' + - '@azure/msal-common.CommonSilentFlowRequest' + - '@azure/msal-common.CommonUsernamePasswordRequest' + - '@azure/msal-common.CredentialEntity' + - '@azure/msal-common.CredentialFilter' + - '@azure/msal-common.CredentialType' + - '@azure/msal-common.DeviceCodeResponse' + - '@azure/msal-common.ExternalTokenResponse' + - '@azure/msal-common.GrantType' + - '@azure/msal-common.HeaderNames' + - '@azure/msal-common.HttpStatus' + - '@azure/msal-common.IdTokenEntity' + - '@azure/msal-common.InProgressPerformanceEvent' + - '@azure/msal-common.JsonWebTokenTypes' + - '@azure/msal-common.LibraryStateObject' + - '@azure/msal-common.LoggerOptions' + - '@azure/msal-common.NativeRequest' + - '@azure/msal-common.NativeSignOutRequest' + - '@azure/msal-common.NetworkRequestOptions' + - '@azure/msal-common.NetworkResponse' + - '@azure/msal-common.OIDCOptions' + - '@azure/msal-common.PasswordGrantConstants' + - '@azure/msal-common.PerformanceCallbackFunction' + - '@azure/msal-common.PerformanceEvent' + - '@azure/msal-common.PersistentCacheKeys' + - '@azure/msal-common.PkceCodes' + - '@azure/msal-common.ProtocolMode' + - '@azure/msal-common.QueueMeasurement' + - '@azure/msal-common.RefreshTokenEntity' + - '@azure/msal-common.RequestStateObject' + - '@azure/msal-common.RequestThumbprint' + - '@azure/msal-common.ResponseMode' + - '@azure/msal-common.ServerAuthorizationCodeResponse' + - '@azure/msal-common.ServerAuthorizationTokenResponse' + - '@azure/msal-common.ServerDeviceCodeResponse' + - '@azure/msal-common.ServerResponseType' + - '@azure/msal-common.ServerTelemetryEntity' + - '@azure/msal-common.ServerTelemetryRequest' + - '@azure/msal-common.ShrOptions' + - '@azure/msal-common.SignedHttpRequest' + - '@azure/msal-common.SignedHttpRequestParameters' + - '@azure/msal-common.StaticAuthorityOptions' + - '@azure/msal-common.StoreInCache' + - '@azure/msal-common.StringDict' + - '@azure/msal-common.SubMeasurement' + - '@azure/msal-common.SystemOptions' + - '@azure/msal-common.TenantProfile' + - '@azure/msal-common.ThrottlingEntity' + - '@azure/msal-common.TokenClaims' + - '@azure/msal-common.TokenKeys' + - '@azure/msal-common.UrlToHttpRequestOptions' +functions: + - name: >- + buildAccountToCache(CacheManager, Authority, string, TokenClaims, (input: + string) => string, string, string, null | string, + AuthorizationCodePayload, string, Logger) + uid: '@azure/msal-common.buildAccountToCache' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function buildAccountToCache(cacheStorage: CacheManager, authority: + Authority, homeAccountId: string, idTokenClaims: TokenClaims, + base64Decode: (input: string) => string, clientInfo?: string, + environment?: string, claimsTenantId?: null | string, authCodePayload?: + AuthorizationCodePayload, nativeAccountId?: string, logger?: Logger): + AccountEntity + parameters: + - id: cacheStorage + type: CacheManager + description: '' + - id: authority + type: Authority + description: '' + - id: homeAccountId + type: string + description: '' + - id: idTokenClaims + type: + description: '' + - id: base64Decode + type: '(input: string) => string' + description: '' + - id: clientInfo + type: string + description: '' + - id: environment + type: string + description: '' + - id: claimsTenantId + type: null | string + description: '' + - id: authCodePayload + type: + description: '' + - id: nativeAccountId + type: string + description: '' + - id: logger + type: + description: '' + return: + description: '' + type: AccountEntity + - name: 'buildClientInfo(string, (input: string) => string)' + uid: '@azure/msal-common.buildClientInfo' + package: '@azure/msal-common' + summary: Function to build a client info object from server clientInfo string + remarks: '' + isDeprecated: false + syntax: + content: >- + function buildClientInfo(rawClientInfo: string, base64Decode: (input: + string) => string): ClientInfo + parameters: + - id: rawClientInfo + type: string + description: '' + - id: base64Decode + type: '(input: string) => string' + description: '' + return: + description: '' + type: + - name: buildClientInfoFromHomeAccountId(string) + uid: '@azure/msal-common.buildClientInfoFromHomeAccountId' + package: '@azure/msal-common' + summary: Function to build a client info object from cached homeAccountId string + remarks: '' + isDeprecated: false + syntax: + content: >- + function buildClientInfoFromHomeAccountId(homeAccountId: string): + ClientInfo + parameters: + - id: homeAccountId + type: string + description: '' + return: + description: '' + type: + - name: buildStaticAuthorityOptions(Partial) + uid: '@azure/msal-common.buildStaticAuthorityOptions' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function buildStaticAuthorityOptions(authOptions: + Partial): StaticAuthorityOptions + parameters: + - id: authOptions + type: Partial<> + description: '' + return: + description: '' + type: + - name: buildTenantProfileFromIdTokenClaims(string, TokenClaims) + uid: '@azure/msal-common.buildTenantProfileFromIdTokenClaims' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function buildTenantProfileFromIdTokenClaims(homeAccountId: string, + idTokenClaims: TokenClaims): TenantProfile + parameters: + - id: homeAccountId + type: string + description: '' + - id: idTokenClaims + type: + description: '' + return: + description: '' + type: + - name: createAuthError(string, string) + uid: '@azure/msal-common.createAuthError' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function createAuthError(code: string, additionalMessage?: string): + AuthError + parameters: + - id: code + type: string + description: '' + - id: additionalMessage + type: string + description: '' + return: + description: '' + type: + - name: createClientAuthError(string, string) + uid: '@azure/msal-common.createClientAuthError' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function createClientAuthError(errorCode: string, additionalMessage?: + string): ClientAuthError + parameters: + - id: errorCode + type: string + description: '' + - id: additionalMessage + type: string + description: '' + return: + description: '' + type: + - name: createClientConfigurationError(string) + uid: '@azure/msal-common.createClientConfigurationError' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function createClientConfigurationError(errorCode: string): + ClientConfigurationError + parameters: + - id: errorCode + type: string + description: '' + return: + description: '' + type: + - name: createInteractionRequiredAuthError(string) + uid: '@azure/msal-common.createInteractionRequiredAuthError' + package: '@azure/msal-common' + summary: Creates an InteractionRequiredAuthError + remarks: '' + isDeprecated: false + syntax: + content: >- + function createInteractionRequiredAuthError(errorCode: string): + InteractionRequiredAuthError + parameters: + - id: errorCode + type: string + description: '' + return: + description: '' + type: + - name: formatAuthorityUri(string) + uid: '@azure/msal-common.formatAuthorityUri' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function formatAuthorityUri(authorityUri: string): string' + parameters: + - id: authorityUri + type: string + description: '' + return: + description: '' + type: string + - name: getTenantIdFromIdTokenClaims(TokenClaims) + uid: '@azure/msal-common.getTenantIdFromIdTokenClaims' + package: '@azure/msal-common' + summary: >- + Gets tenantId from available ID token claims to set as credential realm + with the following precedence: + + 1. tid - if the token is acquired from an Azure AD tenant tid will be + present + + 2. tfp - if the token is acquired from a modern B2C tenant tfp should be + present + + 3. acr - if the token is acquired from a legacy B2C tenant acr should be + present + + Downcased to match the realm case-insensitive comparison requirements + remarks: '' + isDeprecated: false + syntax: + content: >- + function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): + string | null + parameters: + - id: idTokenClaims + type: + description: '' + return: + description: '' + type: string | null + - name: tenantIdMatchesHomeTenant(string, string) + uid: '@azure/msal-common.tenantIdMatchesHomeTenant' + package: '@azure/msal-common' + summary: Returns true if tenantId matches the utid portion of homeAccountId + remarks: '' + isDeprecated: false + syntax: + content: >- + function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: + string): boolean + parameters: + - id: tenantId + type: string + description: '' + - id: homeAccountId + type: string + description: '' + return: + description: '' + type: boolean + - name: >- + updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, + string) + uid: '@azure/msal-common.updateAccountTenantProfileData' + package: '@azure/msal-common' + summary: >- + Replaces account info that varies by tenant profile sourced from the ID + token claims passed in with the tenant-specific account info + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, + tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, + idTokenSecret?: string): AccountInfo + parameters: + - id: baseAccountInfo + type: + description: '' + - id: tenantProfile + type: + description: '' + - id: idTokenClaims + type: + description: '' + - id: idTokenSecret + type: string + description: '' + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-node/AccountInfo.yml b/msal/docs-ref-autogen/@azure/msal-node/AccountInfo.yml new file mode 100644 index 0000000..1cc7282 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AccountInfo.yml @@ -0,0 +1,51 @@ +### YamlMime:TSTypeAlias +name: AccountInfo +uid: '@azure/msal-node.AccountInfo' +package: '@azure/msal-node' +summary: >- + Account object with the following signature: + + - homeAccountId - Home account identifier for this account object + + - environment - Entity which issued the token represented by the + domain of the issuer (e.g. login.microsoftonline.com) + + - tenantId - Full tenant or organizational id that this account + belongs to + + - 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 + + - idToken - raw ID token + + - idTokenClaims - Object contains claims from ID token + + - nativeAccountId - The user's native account ID + + - tenantProfiles - Map of tenant profile objects for each tenant that + the account has authenticated with in the browser +fullName: AccountInfo +remarks: '' +isDeprecated: false +syntax: | + type AccountInfo = { + authorityType?: string + environment: string + homeAccountId: string + idToken?: string + idTokenClaims?: TokenClaims & { + [key: string]: string | number | string[] | object | undefined | unknown + } + localAccountId: string + name?: string + nativeAccountId?: string + tenantId: string + tenantProfiles?: Map + username: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/AppTokenProviderParameters.yml b/msal/docs-ref-autogen/@azure/msal-node/AppTokenProviderParameters.yml new file mode 100644 index 0000000..bffb0e6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AppTokenProviderParameters.yml @@ -0,0 +1,28 @@ +### YamlMime:TSTypeAlias +name: AppTokenProviderParameters +uid: '@azure/msal-node.AppTokenProviderParameters' +package: '@azure/msal-node' +summary: >- + Input object for the IAppTokenProvider extensiblity. MSAL will create this + object, which can be used + + to help create an AppTokenProviderResult. + + + - correlationId - the correlation Id associated with the request + + - tenantId - the tenant Id for which the token must be provided + + - scopes - the scopes for which the token must be provided + + - claims - any extra claims that the token must satisfy +fullName: AppTokenProviderParameters +remarks: '' +isDeprecated: false +syntax: | + type AppTokenProviderParameters = { + claims?: string + correlationId?: string + scopes: string[] + tenantId: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/AppTokenProviderResult.yml b/msal/docs-ref-autogen/@azure/msal-node/AppTokenProviderResult.yml new file mode 100644 index 0000000..f727db5 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AppTokenProviderResult.yml @@ -0,0 +1,26 @@ +### YamlMime:TSTypeAlias +name: AppTokenProviderResult +uid: '@azure/msal-node.AppTokenProviderResult' +package: '@azure/msal-node' +summary: >- + Output object for IAppTokenProvider extensiblity. + + + - accessToken - the actual access token, typically in JWT format, + that satisfies the request data AppTokenProviderParameters + + - expiresInSeconds - how long the tokens has before expiry, in seconds. + Similar to the "expires_in" field in an AAD token response. + + - refreshInSeconds - how long the token has before it should be + proactively refreshed. Similar to the "refresh_in" field in an AAD token + response. +fullName: AppTokenProviderResult +remarks: '' +isDeprecated: false +syntax: | + type AppTokenProviderResult = { + accessToken: string + expiresInSeconds: number + refreshInSeconds?: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/AuthError.yml b/msal/docs-ref-autogen/@azure/msal-node/AuthError.yml new file mode 100644 index 0000000..6fb7c3e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthError.yml @@ -0,0 +1,181 @@ +### YamlMime:TSType +name: AuthError +uid: '@azure/msal-node.AuthError' +package: '@azure/msal-node' +summary: General error class thrown by the MSAL.js library. +fullName: AuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: AuthError(string, string, string) + uid: '@azure/msal-node.AuthError.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new AuthError(errorCode?: string, errorMessage?: string, suberror?: + string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: suberror + type: string + description: '' +properties: + - name: correlationId + uid: '@azure/msal-node.AuthError.correlationId' + package: '@azure/msal-node' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + - name: errorCode + uid: '@azure/msal-node.AuthError.errorCode' + package: '@azure/msal-node' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + - name: errorMessage + uid: '@azure/msal-node.AuthError.errorMessage' + package: '@azure/msal-node' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + - name: subError + uid: '@azure/msal-node.AuthError.subError' + package: '@azure/msal-node' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string +inheritedProperties: + - name: message + uid: '@azure/msal-node.AuthError.message' + package: '@azure/msal-node' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.message + - name: name + uid: '@azure/msal-node.AuthError.name' + package: '@azure/msal-node' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.name + - name: prepareStackTrace + uid: '@azure/msal-node.AuthError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: Inherited From Error.prepareStackTrace + - name: stack + uid: '@azure/msal-node.AuthError.stack' + package: '@azure/msal-node' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: Inherited From Error.stack + - name: stackTraceLimit + uid: '@azure/msal-node.AuthError.stackTraceLimit' + package: '@azure/msal-node' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-node.AuthError.captureStackTrace' + package: '@azure/msal-node' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: Inherited From Error.captureStackTrace +methods: + - name: setCorrelationId(string) + uid: '@azure/msal-node.AuthError.setCorrelationId' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' +extends: Error diff --git a/msal/docs-ref-autogen/@azure/msal-node/AuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-node/AuthErrorCodes.yml new file mode 100644 index 0000000..d660666 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-node.AuthErrorCodes' +name: AuthErrorCodes +type: module +package: '@azure/msal-node' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-node/AuthenticationResult.yml b/msal/docs-ref-autogen/@azure/msal-node/AuthenticationResult.yml new file mode 100644 index 0000000..ef3eef7 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthenticationResult.yml @@ -0,0 +1,67 @@ +### YamlMime:TSTypeAlias +name: AuthenticationResult +uid: '@azure/msal-node.AuthenticationResult' +package: '@azure/msal-node' +summary: >- + Result returned from the authority's token endpoint. + + - uniqueId - `oid` or `sub` claim from ID token + + - tenantId - `tid` claim from ID token + + - scopes - Scopes that are validated for the respective token + + - account - An account object representation of the currently + signed-in user + + - idToken - Id token received as part of the response + + - idTokenClaims - MSAL-relevant ID token claims + + - accessToken - Access token or SSH certificate received as part of + the response + + - fromCache - Boolean denoting whether token came from cache + + - expiresOn - Javascript Date object representing relative + expiration of access token + + - extExpiresOn - Javascript Date object representing extended + relative expiration of access token in case of server outage + + - refreshOn - Javascript Date object representing relative time + until an access token must be refreshed + + - state - Value passed in by user in request + + - familyId - Family ID identifier, usually only used for refresh + tokens + + - requestId - Request ID returned as part of the response +fullName: AuthenticationResult +remarks: '' +isDeprecated: false +syntax: | + type AuthenticationResult = { + accessToken: string + account: AccountInfo | null + authority: string + cloudGraphHostName?: string + code?: string + correlationId: string + expiresOn: Date | null + extExpiresOn?: Date + familyId?: string + fromCache: boolean + fromNativeBroker?: boolean + idToken: string + idTokenClaims: object + msGraphHost?: string + refreshOn?: Date + requestId?: string + scopes: string[] + state?: string + tenantId: string + tokenType: string + uniqueId: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodePayload.yml b/msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodePayload.yml new file mode 100644 index 0000000..f7d9fed --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodePayload.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: AuthorizationCodePayload +uid: '@azure/msal-node.AuthorizationCodePayload' +package: '@azure/msal-node' +summary: Response returned after processing the code response query string or fragment. +fullName: AuthorizationCodePayload +remarks: '' +isDeprecated: false +syntax: | + type AuthorizationCodePayload = { + client_info?: string + cloud_graph_host_name?: string + cloud_instance_host_name?: string + cloud_instance_name?: string + code: string + msgraph_host?: string + nonce?: string + state?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml new file mode 100644 index 0000000..4018d38 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml @@ -0,0 +1,63 @@ +### YamlMime:TSTypeAlias +name: AuthorizationCodeRequest +uid: '@azure/msal-node.AuthorizationCodeRequest' +package: '@azure/msal-node' +summary: >- + Request object passed by user to acquire a token from the server exchanging a + valid authorization code (second leg of OAuth2.0 Authorization Code flow) + + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be added + to all /authorize and /token calls + + - authority: - URL of the authority, the security token service + (STS) from which MSAL will acquire tokens. If authority is set on client + application object, this will override that value. Overriding the value will + cause for authority validation to happen each time. If the same authority will + be used for all request, set on the application object instead of the + requests. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - redirectUri - The redirect URI of your app, where the authority + will redirect to after the user inputs credentials and consents. It must + exactly match one of the redirect URIs you registered in the portal. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call + + - code - The authorization_code that the user acquired in + the first leg of the flow. + + - codeVerifier - The same code_verifier that was used to obtain the + authorization_code. Required if PKCE was used in the authorization code grant + request.For more information, see the PKCE RFC: + https://tools.ietf.org/html/rfc7636 + + - state - Unique GUID generated by the user that is cached + by the user and sent to the server during the first leg of the flow. This + string is sent back by the server with the authorization code. The user cached + state is then compared with the state received from the server to mitigate the + risk of CSRF attacks. See + https://datatracker.ietf.org/doc/html/rfc6819#section-3.6. +fullName: AuthorizationCodeRequest +remarks: '' +isDeprecated: false +syntax: | + type AuthorizationCodeRequest = Partial< + Omit< + CommonAuthorizationCodeRequest, + | "scopes" + | "redirectUri" + | "code" + | "authenticationScheme" + | "resourceRequestMethod" + | "resourceRequestUri" + | "requestedClaimsHash" + | "storeInCache" + > + > & { code: string; redirectUri: string; scopes: string[]; state?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml new file mode 100644 index 0000000..bc83f2d --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml @@ -0,0 +1,96 @@ +### YamlMime:TSTypeAlias +name: AuthorizationUrlRequest +uid: '@azure/msal-node.AuthorizationUrlRequest' +package: '@azure/msal-node' +summary: >- + Request object passed by user to retrieve a Code from the server (first leg of + authorization code grant flow) + + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be + added to all /authorize and /token calls + + - authority - Url of the authority which the application + acquires tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - 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. + + - extraScopesToConsent - Scopes for a different resource when the user + needs consent upfront. + + - responseMode - Specifies the method that should be used to + send the authentication result to your app. Can be query, form_post, or + fragment. If no value is passed in, it defaults to query. + + - codeChallenge - Used to secure authorization code grant via + Proof of Key for Code Exchange (PKCE). For more information, see the PKCE + RCF:https://tools.ietf.org/html/rfc7636 + + - codeChallengeMethod - The method used to encode the code verifier for + the code challenge parameter. Can be "plain" or "S256". If excluded, code + challenge is assumed to be plaintext. For more information, see the PKCE RCF: + https://tools.ietf.org/html/rfc7636 + + - state - A value included in the request that is also + returned in the token response. A randomly generated unique value is typically + used for preventing cross site request forgery attacks. The state is also used + to encode information about the user's state in the app before the + authentication request occurred. + + - prompt - Indicates the type of user interaction that is + required. + login: will force the user to enter their credentials on that request, negating single-sign on + none: will ensure that the user isn't presented with any interactive prompt. if request can't be completed via single-sign on, the endpoint will return an interaction_required error + consent: will the trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app + select_account: will interrupt single sign-=on providing account selection experience listing all the accounts in session or any remembered accounts or an option to choose to use a different account + create: will direct the user to the account creation experience instead of the log in experience + - account - AccountInfo obtained from a getAccount API. + Will be used in certain scenarios to generate login_hint if both loginHint and + sid params are not provided. + + - loginHint - Can be used to pre-fill the username/email + address field of the sign-in page for the user, if you know the username/email + address ahead of time. Often apps use this parameter during re-authentication, + having already extracted the username from a previous sign-in using the + preferred_username claim. + + - sid - Session ID, unique identifier for the session. + Available as an optional claim on ID tokens. + + - domainHint - Provides a hint about the tenant or domain that + the user should use to sign in. The value of the domain hint is a registered + domain for the tenant. + + - extraQueryParameters - String to string map of custom query parameters + added to the /authorize call + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call + + - nonce - A value included in the request that is + returned in the id token. A randomly generated unique value is typically used + to mitigate replay attacks. +fullName: AuthorizationUrlRequest +remarks: '' +isDeprecated: false +syntax: | + type AuthorizationUrlRequest = Partial< + Omit< + CommonAuthorizationUrlRequest, + | "scopes" + | "redirectUri" + | "resourceRequestMethod" + | "resourceRequestUri" + | "authenticationScheme" + | "requestedClaimsHash" + | "storeInCache" + > + > & { redirectUri: string; scopes: string[] } diff --git a/msal/docs-ref-autogen/@azure/msal-node/AzureCloudInstance.yml b/msal/docs-ref-autogen/@azure/msal-node/AzureCloudInstance.yml new file mode 100644 index 0000000..d047e12 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AzureCloudInstance.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: AzureCloudInstance +uid: '@azure/msal-node.AzureCloudInstance' +package: '@azure/msal-node' +summary: '' +fullName: AzureCloudInstance +remarks: '' +isDeprecated: false +syntax: | + type AzureCloudInstance = + (typeof AzureCloudInstance)[keyof typeof AzureCloudInstance] diff --git a/msal/docs-ref-autogen/@azure/msal-node/AzureCloudOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/AzureCloudOptions.yml new file mode 100644 index 0000000..7516d9f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/AzureCloudOptions.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: AzureCloudOptions +uid: '@azure/msal-node.AzureCloudOptions' +package: '@azure/msal-node' +summary: >- + AzureCloudInstance specific options + + + - azureCloudInstance - string enum providing short notation for + soverign and public cloud authorities + + - tenant - provision to provide the tenant info +fullName: AzureCloudOptions +remarks: '' +isDeprecated: false +syntax: | + type AzureCloudOptions = { + azureCloudInstance: AzureCloudInstance + tenant?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/BrokerOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/BrokerOptions.yml new file mode 100644 index 0000000..dc867b9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/BrokerOptions.yml @@ -0,0 +1,18 @@ +### YamlMime:TSTypeAlias +name: BrokerOptions +uid: '@azure/msal-node.BrokerOptions' +package: '@azure/msal-node' +summary: >- + Use this to configure the below broker options: + + - nativeBrokerPlugin - Native broker implementation (should be imported from + msal-node-extensions) + + + Note: These options are only available for PublicClientApplications using the + Authorization Code Flow +fullName: BrokerOptions +remarks: '' +isDeprecated: false +syntax: | + type BrokerOptions = { nativeBrokerPlugin?: INativeBrokerPlugin } diff --git a/msal/docs-ref-autogen/@azure/msal-node/CacheKVStore.yml b/msal/docs-ref-autogen/@azure/msal-node/CacheKVStore.yml new file mode 100644 index 0000000..a03550c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/CacheKVStore.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: CacheKVStore +uid: '@azure/msal-node.CacheKVStore' +package: '@azure/msal-node' +summary: Key value store for in-memory cache +fullName: CacheKVStore +remarks: '' +isDeprecated: false +syntax: | + type CacheKVStore = Record diff --git a/msal/docs-ref-autogen/@azure/msal-node/CacheOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/CacheOptions.yml new file mode 100644 index 0000000..c73c0e2 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/CacheOptions.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: CacheOptions +uid: '@azure/msal-node.CacheOptions' +package: '@azure/msal-node' +summary: |- + Use this to configure the below cache configuration options: + + - cachePlugin - Plugin for reading and writing token cache to disk. +fullName: CacheOptions +remarks: '' +isDeprecated: false +syntax: | + type CacheOptions = { + cachePlugin?: ICachePlugin + claimsBasedCachingEnabled?: boolean + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml new file mode 100644 index 0000000..80e771a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml @@ -0,0 +1,214 @@ +### YamlMime:TSType +name: ClientApplication +uid: '@azure/msal-node.ClientApplication' +package: '@azure/msal-node' +summary: Base abstract class for all ClientApplications - public and confidential +fullName: ClientApplication +remarks: '' +isDeprecated: false +type: class +methods: + - name: acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload) + uid: '@azure/msal-node.ClientApplication.acquireTokenByCode' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the Authorization Code received from the + first step of OAuth2.0 + + Authorization Code flow. + + + `getAuthCodeUrl(AuthorizationCodeUrlRequest)` can be used to create the + URL for the first step of OAuth2.0 + + Authorization Code flow. Ensure that values for redirectUri and scopes in + AuthorizationCodeUrlRequest and + + AuthorizationCodeRequest are the same. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByCode(request: AuthorizationCodeRequest, + authCodePayLoad?: AuthorizationCodePayload): + Promise + parameters: + - id: request + type: + description: '' + - id: authCodePayLoad + type: + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenByRefreshToken(RefreshTokenRequest) + uid: '@azure/msal-node.ClientApplication.acquireTokenByRefreshToken' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the refresh token provided for a new set of + tokens. + + + This API is provided only for scenarios where you would like to migrate + from ADAL to MSAL. Otherwise, it is + + recommended that you use `acquireTokenSilent()` for silent scenarios. When + using `acquireTokenSilent()`, MSAL will + + handle the caching and refreshing of tokens automatically. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByRefreshToken(request: RefreshTokenRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenByUsernamePassword(UsernamePasswordRequest) + uid: '@azure/msal-node.ClientApplication.acquireTokenByUsernamePassword' + package: '@azure/msal-node' + summary: >- + Acquires tokens with password grant by exchanging client applications + username and password for credentials + + + The latest OAuth 2.0 Security Best Current Practice disallows the password + grant entirely. + + More details on this recommendation at + https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 + + Microsoft's documentation and recommendations are at: + + https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByUsernamePassword(request: + UsernamePasswordRequest): Promise + parameters: + - id: request + type: + description: UsenamePasswordRequest + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenSilent(SilentFlowRequest) + uid: '@azure/msal-node.ClientApplication.acquireTokenSilent' + package: '@azure/msal-node' + summary: >- + Acquires a token silently when a user specifies the account the token is + requested for. + + + This API expects the user to provide an account object and looks into the + cache to retrieve the token if present. + + There is also an optional "forceRefresh" boolean the user can send to + bypass the cache for access_token and id_token. + + In case the refresh_token is expired or not found, an error is thrown + + and the guidance is for the user to call any interactive token acquisition + API (eg: `acquireTokenByCode()`). + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(request: SilentFlowRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: clearCache() + uid: '@azure/msal-node.ClientApplication.clearCache' + package: '@azure/msal-node' + summary: Clear the cache + remarks: '' + isDeprecated: false + syntax: + content: function clearCache() + - name: getAuthCodeUrl(AuthorizationUrlRequest) + uid: '@azure/msal-node.ClientApplication.getAuthCodeUrl' + package: '@azure/msal-node' + summary: >- + Creates the URL of the authorization request, letting the user input + credentials and consent to the + + application. The URL targets the /authorize endpoint of the authority + configured in the + + application object. + + + Once the user inputs their credentials and consents, the authority will + send a response to the redirect URI + + sent in the request and should contain an authorization code, which can + then be used to acquire tokens via + + `acquireTokenByCode(AuthorizationCodeRequest)`. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAuthCodeUrl(request: AuthorizationUrlRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<string> + - name: getLogger() + uid: '@azure/msal-node.ClientApplication.getLogger' + package: '@azure/msal-node' + summary: Returns the logger instance + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + - name: getTokenCache() + uid: '@azure/msal-node.ClientApplication.getTokenCache' + package: '@azure/msal-node' + summary: Gets the token cache for the application. + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenCache(): TokenCache' + return: + description: '' + type: + - name: setLogger(Logger) + uid: '@azure/msal-node.ClientApplication.setLogger' + package: '@azure/msal-node' + summary: >- + Replaces the default logger set in configurations with new Logger with new + configurations + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: Logger instance diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml new file mode 100644 index 0000000..2c39026 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml @@ -0,0 +1,98 @@ +### YamlMime:TSType +name: ClientAssertion +uid: '@azure/msal-node.ClientAssertion' +package: '@azure/msal-node' +summary: Client assertion of type jwt-bearer used in confidential client flows +fullName: ClientAssertion +remarks: '' +isDeprecated: false +type: class +methods: + - name: fromAssertion(string) + uid: '@azure/msal-node.ClientAssertion.fromAssertion' + package: '@azure/msal-node' + summary: >- + Initialize the ClientAssertion class from the clientAssertion passed by + the user + remarks: '' + isDeprecated: false + syntax: + content: 'static function fromAssertion(assertion: string): ClientAssertion' + parameters: + - id: assertion + type: string + description: refer https://tools.ietf.org/html/rfc7521 + return: + description: '' + type: + - name: fromCertificate(string, string, string) + uid: '@azure/msal-node.ClientAssertion.fromCertificate' + package: '@azure/msal-node' + summary: >- + Initialize the ClientAssertion class from the certificate passed by the + user + remarks: '' + isDeprecated: false + syntax: + content: >- + static function fromCertificate(thumbprint: string, privateKey: string, + publicCertificate?: string): ClientAssertion + parameters: + - id: thumbprint + type: string + description: identifier of a certificate + - id: privateKey + type: string + description: secret key + - id: publicCertificate + type: string + description: >- + electronic document provided to prove the ownership of the public + key + return: + description: '' + type: + - name: getJwt(CryptoProvider, string, string) + uid: '@azure/msal-node.ClientAssertion.getJwt' + package: '@azure/msal-node' + summary: >- + Update JWT for certificate based clientAssertion, if passed by the user, + uses it as is + remarks: '' + isDeprecated: false + syntax: + content: >- + function getJwt(cryptoProvider: CryptoProvider, issuer: string, + jwtAudience: string): string + parameters: + - id: cryptoProvider + type: + description: library's crypto helper + - id: issuer + type: string + description: iss claim + - id: jwtAudience + type: string + description: aud claim + return: + description: '' + type: string + - name: parseCertificate(string) + uid: '@azure/msal-node.ClientAssertion.parseCertificate' + package: '@azure/msal-node' + summary: >- + Extracts the raw certs from a given certificate string and returns them in + an array. + remarks: '' + isDeprecated: false + syntax: + content: 'static function parseCertificate(publicCertificate: string): string[]' + parameters: + - id: publicCertificate + type: string + description: >- + electronic document provided to prove the ownership of the public + key + return: + description: '' + type: string[] diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientAuthError.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientAuthError.yml new file mode 100644 index 0000000..dce5acb --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientAuthError.yml @@ -0,0 +1,201 @@ +### YamlMime:TSType +name: ClientAuthError +uid: '@azure/msal-node.ClientAuthError' +package: '@azure/msal-node' +summary: Error thrown when there is an error in the client code running on the browser. +fullName: ClientAuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ClientAuthError(string, string) + uid: '@azure/msal-node.ClientAuthError.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ClientAuthError(errorCode: string, additionalMessage?: string)' + parameters: + - id: errorCode + type: string + description: '' + - id: additionalMessage + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-node.ClientAuthError.correlationId' + package: '@azure/msal-node' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-node.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-node.ClientAuthError.errorCode' + package: '@azure/msal-node' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-node.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-node.ClientAuthError.errorMessage' + package: '@azure/msal-node' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-node.AuthError.errorMessage) + - name: message + uid: '@azure/msal-node.ClientAuthError.message' + package: '@azure/msal-node' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-node.AuthError.message) + - name: name + uid: '@azure/msal-node.ClientAuthError.name' + package: '@azure/msal-node' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-node.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-node.ClientAuthError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-node.ClientAuthError.stack' + package: '@azure/msal-node' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-node.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-node.ClientAuthError.stackTraceLimit' + package: '@azure/msal-node' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-node.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-node.ClientAuthError.subError' + package: '@azure/msal-node' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-node.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-node.ClientAuthError.captureStackTrace' + package: '@azure/msal-node' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-node.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-node.ClientAuthError.setCorrelationId' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-node.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientAuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientAuthErrorCodes.yml new file mode 100644 index 0000000..5c5db15 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientAuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-node.ClientAuthErrorCodes' +name: ClientAuthErrorCodes +type: module +package: '@azure/msal-node' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationError.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationError.yml new file mode 100644 index 0000000..2894a03 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationError.yml @@ -0,0 +1,198 @@ +### YamlMime:TSType +name: ClientConfigurationError +uid: '@azure/msal-node.ClientConfigurationError' +package: '@azure/msal-node' +summary: Error thrown when there is an error in configuration of the MSAL.js library. +fullName: ClientConfigurationError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ClientConfigurationError(string) + uid: '@azure/msal-node.ClientConfigurationError.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new ClientConfigurationError(errorCode: string)' + parameters: + - id: errorCode + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-node.ClientConfigurationError.correlationId' + package: '@azure/msal-node' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-node.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-node.ClientConfigurationError.errorCode' + package: '@azure/msal-node' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-node.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-node.ClientConfigurationError.errorMessage' + package: '@azure/msal-node' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-node.AuthError.errorMessage) + - name: message + uid: '@azure/msal-node.ClientConfigurationError.message' + package: '@azure/msal-node' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-node.AuthError.message) + - name: name + uid: '@azure/msal-node.ClientConfigurationError.name' + package: '@azure/msal-node' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-node.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-node.ClientConfigurationError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-node.ClientConfigurationError.stack' + package: '@azure/msal-node' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-node.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-node.ClientConfigurationError.stackTraceLimit' + package: '@azure/msal-node' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-node.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-node.ClientConfigurationError.subError' + package: '@azure/msal-node' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-node.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-node.ClientConfigurationError.captureStackTrace' + package: '@azure/msal-node' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-node.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-node.ClientConfigurationError.setCorrelationId' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-node.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationErrorCodes.yml new file mode 100644 index 0000000..d68553f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-node.ClientConfigurationErrorCodes' +name: ClientConfigurationErrorCodes +type: module +package: '@azure/msal-node' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialClient.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialClient.yml new file mode 100644 index 0000000..f5ba77e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialClient.yml @@ -0,0 +1,158 @@ +### YamlMime:TSType +name: ClientCredentialClient +uid: '@azure/msal-node.ClientCredentialClient' +package: '@azure/msal-node' +summary: OAuth2.0 client credential grant +fullName: ClientCredentialClient +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ClientCredentialClient(ClientConfiguration, IAppTokenProvider) + uid: '@azure/msal-node.ClientCredentialClient.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ClientCredentialClient(configuration: ClientConfiguration, + appTokenProvider?: IAppTokenProvider) + parameters: + - id: configuration + type: + description: '' + - id: appTokenProvider + type: + description: '' +inheritedProperties: + - name: authority + uid: '@azure/msal-node.ClientCredentialClient.authority' + package: '@azure/msal-node' + summary: '' + fullName: authority + remarks: '' + isDeprecated: false + syntax: + content: 'authority: Authority' + return: + description: '' + type: + inheritanceDescription: Inherited From BaseClient.authority + - name: logger + uid: '@azure/msal-node.ClientCredentialClient.logger' + package: '@azure/msal-node' + summary: '' + fullName: logger + remarks: '' + isDeprecated: false + syntax: + content: 'logger: Logger' + return: + description: '' + type: + inheritanceDescription: Inherited From BaseClient.logger +inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-node.ClientCredentialClient.createTokenQueryParameters' + package: '@azure/msal-node' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseClient.createTokenQueryParameters + - name: updateAuthority(string, string) + uid: '@azure/msal-node.ClientCredentialClient.updateAuthority' + package: '@azure/msal-node' + summary: >- + Updates the authority object of the client. Endpoint discovery must be + completed. + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateAuthority(cloudInstanceHostname: string, correlationId: + string): Promise + parameters: + - id: cloudInstanceHostname + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseClient.updateAuthority +methods: + - name: acquireToken(CommonClientCredentialRequest) + uid: '@azure/msal-node.ClientCredentialClient.acquireToken' + package: '@azure/msal-node' + summary: >- + Public API to acquire a token with ClientCredential Flow for Confidential + clients + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireToken(request: CommonClientCredentialRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: >- + getCachedAuthenticationResult(CommonClientCredentialRequest, + ClientConfiguration | ManagedIdentityConfiguration, ICrypto, Authority, + CacheManager, null | ServerTelemetryManager) + uid: '@azure/msal-node.ClientCredentialClient.getCachedAuthenticationResult' + package: '@azure/msal-node' + summary: looks up cache if the tokens are cached already + remarks: '' + isDeprecated: false + syntax: + content: >- + function getCachedAuthenticationResult(request: + CommonClientCredentialRequest, config: ClientConfiguration | + ManagedIdentityConfiguration, cryptoUtils: ICrypto, authority: + Authority, cacheManager: CacheManager, serverTelemetryManager?: null | + ServerTelemetryManager): Promise<[null | AuthenticationResult, + CacheOutcome]> + parameters: + - id: request + type: + description: '' + - id: config + type: >- + | + description: '' + - id: cryptoUtils + type: + description: '' + - id: authority + type: + description: '' + - id: cacheManager + type: + description: '' + - id: serverTelemetryManager + type: null | + description: '' + return: + description: '' + type: Promise<[null | AuthenticationResult, CacheOutcome]> +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml new file mode 100644 index 0000000..cfe02c3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml @@ -0,0 +1,40 @@ +### YamlMime:TSTypeAlias +name: ClientCredentialRequest +uid: '@azure/msal-node.ClientCredentialRequest' +package: '@azure/msal-node' +summary: >- + CommonClientCredentialRequest + + - scopes - Array of scopes the application is requesting + access to. Typically contains only the .default scope for a single resource. + See: + https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc#the-default-scope + + - 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. + + - skipCache - Skip token cache lookup and force request to + authority to get a a new token. Defaults to false. + + - clientAssertion - A Base64Url-encoded signed JWT assertion string + used in the Client Credential flow + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call +fullName: ClientCredentialRequest +remarks: '' +isDeprecated: false +syntax: | + type ClientCredentialRequest = Partial< + Omit< + CommonClientCredentialRequest, + | "resourceRequestMethod" + | "resourceRequestUri" + | "requestedClaimsHash" + | "clientAssertion" + | "storeInCache" + > + > & { clientAssertion?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml new file mode 100644 index 0000000..a5348c6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml @@ -0,0 +1,373 @@ +### YamlMime:TSType +name: ConfidentialClientApplication +uid: '@azure/msal-node.ConfidentialClientApplication' +package: '@azure/msal-node' +summary: >- + This class is to be used to acquire tokens for confidential client + applications (webApp, webAPI). Confidential client applications + will configure application secrets, client certificates/assertions as applicable +fullName: ConfidentialClientApplication +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ConfidentialClientApplication(Configuration) + uid: '@azure/msal-node.ConfidentialClientApplication.constructor' + package: '@azure/msal-node' + summary: >- + Constructor for the ConfidentialClientApplication + + + Required attributes in the Configuration object are: + + - clientID: the application ID of your application. You can obtain one by + registering your application with our application registration portal + + - authority: the authority URL for your application. + + - client credential: Must set either client secret, certificate, or + assertion for confidential clients. You can obtain a client secret from + the application registration portal. + + + In Azure AD, authority is a URL indicating of the form + https://login.microsoftonline.com/{Enter_the_Tenant_Info_Here}. + + If your application supports Accounts in one organizational directory, + replace "Enter_the_Tenant_Info_Here" value with the Tenant Id or Tenant + name (for example, contoso.microsoft.com). + + If your application supports Accounts in any organizational directory, + replace "Enter_the_Tenant_Info_Here" value with organizations. + + If your application supports Accounts in any organizational directory and + personal Microsoft accounts, replace "Enter_the_Tenant_Info_Here" value + with common. + + To restrict support to Personal Microsoft accounts only, replace + "Enter_the_Tenant_Info_Here" value with consumers. + + + In Azure B2C, authority is of the form + https://{instance}/tfp/{tenant}/{policyName}/ + + Full B2C functionality will be available in this library in future + versions. + remarks: '' + isDeprecated: false + syntax: + content: 'new ConfidentialClientApplication(configuration: Configuration)' + parameters: + - id: configuration + type: + description: '' +inheritedMethods: + - name: acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload) + uid: '@azure/msal-node.ConfidentialClientApplication.acquireTokenByCode' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the Authorization Code received from the + first step of OAuth2.0 + + Authorization Code flow. + + + `getAuthCodeUrl(AuthorizationCodeUrlRequest)` can be used to create the + URL for the first step of OAuth2.0 + + Authorization Code flow. Ensure that values for redirectUri and scopes in + AuthorizationCodeUrlRequest and + + AuthorizationCodeRequest are the same. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByCode(request: AuthorizationCodeRequest, + authCodePayLoad?: AuthorizationCodePayload): + Promise + parameters: + - id: request + type: + description: '' + - id: authCodePayLoad + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: >- + Inherited From + [ClientApplication.acquireTokenByCode](xref:@azure/msal-node.ClientApplication.acquireTokenByCode) + - name: acquireTokenByRefreshToken(RefreshTokenRequest) + uid: '@azure/msal-node.ConfidentialClientApplication.acquireTokenByRefreshToken' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the refresh token provided for a new set of + tokens. + + + This API is provided only for scenarios where you would like to migrate + from ADAL to MSAL. Otherwise, it is + + recommended that you use `acquireTokenSilent()` for silent scenarios. When + using `acquireTokenSilent()`, MSAL will + + handle the caching and refreshing of tokens automatically. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByRefreshToken(request: RefreshTokenRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + inheritanceDescription: >- + Inherited From + [ClientApplication.acquireTokenByRefreshToken](xref:@azure/msal-node.ClientApplication.acquireTokenByRefreshToken) + - name: acquireTokenByUsernamePassword(UsernamePasswordRequest) + uid: >- + @azure/msal-node.ConfidentialClientApplication.acquireTokenByUsernamePassword + package: '@azure/msal-node' + summary: >- + Acquires tokens with password grant by exchanging client applications + username and password for credentials + + + The latest OAuth 2.0 Security Best Current Practice disallows the password + grant entirely. + + More details on this recommendation at + https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 + + Microsoft's documentation and recommendations are at: + + https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByUsernamePassword(request: + UsernamePasswordRequest): Promise + parameters: + - id: request + type: + description: UsenamePasswordRequest + return: + description: '' + type: >- + Promise<null | > + inheritanceDescription: >- + Inherited From + [ClientApplication.acquireTokenByUsernamePassword](xref:@azure/msal-node.ClientApplication.acquireTokenByUsernamePassword) + - name: acquireTokenSilent(SilentFlowRequest) + uid: '@azure/msal-node.ConfidentialClientApplication.acquireTokenSilent' + package: '@azure/msal-node' + summary: >- + Acquires a token silently when a user specifies the account the token is + requested for. + + + This API expects the user to provide an account object and looks into the + cache to retrieve the token if present. + + There is also an optional "forceRefresh" boolean the user can send to + bypass the cache for access_token and id_token. + + In case the refresh_token is expired or not found, an error is thrown + + and the guidance is for the user to call any interactive token acquisition + API (eg: `acquireTokenByCode()`). + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(request: SilentFlowRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: >- + Inherited From + [ClientApplication.acquireTokenSilent](xref:@azure/msal-node.ClientApplication.acquireTokenSilent) + - name: clearCache() + uid: '@azure/msal-node.ConfidentialClientApplication.clearCache' + package: '@azure/msal-node' + summary: Clear the cache + remarks: '' + isDeprecated: false + syntax: + content: function clearCache() + inheritanceDescription: >- + Inherited From + [ClientApplication.clearCache](xref:@azure/msal-node.ClientApplication.clearCache) + - name: getAuthCodeUrl(AuthorizationUrlRequest) + uid: '@azure/msal-node.ConfidentialClientApplication.getAuthCodeUrl' + package: '@azure/msal-node' + summary: >- + Creates the URL of the authorization request, letting the user input + credentials and consent to the + + application. The URL targets the /authorize endpoint of the authority + configured in the + + application object. + + + Once the user inputs their credentials and consents, the authority will + send a response to the redirect URI + + sent in the request and should contain an authorization code, which can + then be used to acquire tokens via + + `acquireTokenByCode(AuthorizationCodeRequest)`. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAuthCodeUrl(request: AuthorizationUrlRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<string> + inheritanceDescription: >- + Inherited From + [ClientApplication.getAuthCodeUrl](xref:@azure/msal-node.ClientApplication.getAuthCodeUrl) + - name: getLogger() + uid: '@azure/msal-node.ConfidentialClientApplication.getLogger' + package: '@azure/msal-node' + summary: Returns the logger instance + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ClientApplication.getLogger](xref:@azure/msal-node.ClientApplication.getLogger) + - name: getTokenCache() + uid: '@azure/msal-node.ConfidentialClientApplication.getTokenCache' + package: '@azure/msal-node' + summary: Gets the token cache for the application. + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenCache(): TokenCache' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ClientApplication.getTokenCache](xref:@azure/msal-node.ClientApplication.getTokenCache) + - name: setLogger(Logger) + uid: '@azure/msal-node.ConfidentialClientApplication.setLogger' + package: '@azure/msal-node' + summary: >- + Replaces the default logger set in configurations with new Logger with new + configurations + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: Logger instance + inheritanceDescription: >- + Inherited From + [ClientApplication.setLogger](xref:@azure/msal-node.ClientApplication.setLogger) +methods: + - name: acquireTokenByClientCredential(ClientCredentialRequest) + uid: >- + @azure/msal-node.ConfidentialClientApplication.acquireTokenByClientCredential + package: '@azure/msal-node' + summary: >- + Acquires tokens from the authority for the application (not for an end + user). + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByClientCredential(request: + ClientCredentialRequest): Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenOnBehalfOf(OnBehalfOfRequest) + uid: '@azure/msal-node.ConfidentialClientApplication.acquireTokenOnBehalfOf' + package: '@azure/msal-node' + summary: >- + Acquires tokens from the authority for the application. + + + Used in scenarios where the current app is a middle-tier service which was + called with a token + + representing an end user. The current app can use the token (oboAssertion) + to request another + + token to access downstream web API, on behalf of that user. + + + The current middle-tier app has no user interaction to obtain consent. + + See how to gain consent upfront for your middle-tier app from this + article. + + https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow#gaining-consent-for-the-middle-tier-application + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenOnBehalfOf(request: OnBehalfOfRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: SetAppTokenProvider(IAppTokenProvider) + uid: '@azure/msal-node.ConfidentialClientApplication.SetAppTokenProvider' + package: '@azure/msal-node' + summary: >- + This extensibility point only works for the client_credential flow, i.e. + acquireTokenByClientCredential and + + is meant for Azure SDK to enhance Managed Identity support. + remarks: '' + isDeprecated: false + syntax: + content: 'function SetAppTokenProvider(provider: IAppTokenProvider)' + parameters: + - id: provider + type: + description: '' +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/Configuration.yml b/msal/docs-ref-autogen/@azure/msal-node/Configuration.yml new file mode 100644 index 0000000..8a69ec6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/Configuration.yml @@ -0,0 +1,30 @@ +### YamlMime:TSTypeAlias +name: Configuration +uid: '@azure/msal-node.Configuration' +package: '@azure/msal-node' +summary: >- + Use the configuration object to configure MSAL and initialize the client + application object + + + - auth: this is where you configure auth elements like clientID, authority + used for authenticating against the Microsoft Identity Platform + + - broker: this is where you configure broker options + + - cache: this is where you configure cache location + + - system: this is where you can configure the network client, logger + + - telemetry: this is where you can configure telemetry options +fullName: Configuration +remarks: '' +isDeprecated: false +syntax: | + type Configuration = { + auth: NodeAuthOptions + broker?: BrokerOptions + cache?: CacheOptions + system?: NodeSystemOptions + telemetry?: NodeTelemetryOptions + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml b/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml new file mode 100644 index 0000000..2d00daf --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml @@ -0,0 +1,130 @@ +### YamlMime:TSType +name: CryptoProvider +uid: '@azure/msal-node.CryptoProvider' +package: '@azure/msal-node' +summary: >- + This class implements MSAL node's crypto interface, which allows it to perform + base64 encoding and decoding, generating cryptographically random GUIDs and + + implementing Proof Key for Code Exchange specs for the OAuth Authorization + Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636). +fullName: CryptoProvider +remarks: '' +isDeprecated: false +type: class +methods: + - name: base64Decode(string) + uid: '@azure/msal-node.CryptoProvider.base64Decode' + package: '@azure/msal-node' + summary: Decodes input string from base64. + remarks: '' + isDeprecated: false + syntax: + content: 'function base64Decode(input: string): string' + parameters: + - id: input + type: string + description: string to be decoded + return: + description: '' + type: string + - name: base64Encode(string) + uid: '@azure/msal-node.CryptoProvider.base64Encode' + package: '@azure/msal-node' + summary: Encodes input string to base64. + remarks: '' + isDeprecated: false + syntax: + content: 'function base64Encode(input: string): string' + parameters: + - id: input + type: string + description: string to be encoded + return: + description: '' + type: string + - name: clearKeystore() + uid: '@azure/msal-node.CryptoProvider.clearKeystore' + package: '@azure/msal-node' + summary: Removes all cryptographic keys from Keystore + remarks: '' + isDeprecated: false + syntax: + content: 'function clearKeystore(): Promise' + return: + description: '' + type: Promise<boolean> + - name: createNewGuid() + uid: '@azure/msal-node.CryptoProvider.createNewGuid' + package: '@azure/msal-node' + summary: Creates a new random GUID - used to populate state and nonce. + remarks: '' + isDeprecated: false + syntax: + content: 'function createNewGuid(): string' + return: + description: string (GUID) + type: string + - name: generatePkceCodes() + uid: '@azure/msal-node.CryptoProvider.generatePkceCodes' + package: '@azure/msal-node' + summary: Generates PKCE codes used in Authorization Code Flow. + remarks: '' + isDeprecated: false + syntax: + content: 'function generatePkceCodes(): Promise' + return: + description: '' + type: Promise<> + - name: getPublicKeyThumbprint() + uid: '@azure/msal-node.CryptoProvider.getPublicKeyThumbprint' + package: '@azure/msal-node' + summary: >- + Generates a keypair, stores it and returns a thumbprint - not yet + implemented for node + remarks: '' + isDeprecated: false + syntax: + content: 'function getPublicKeyThumbprint(): Promise' + return: + description: '' + type: Promise<string> + - name: hashString(string) + uid: '@azure/msal-node.CryptoProvider.hashString' + package: '@azure/msal-node' + summary: Returns the SHA-256 hash of an input string + remarks: '' + isDeprecated: false + syntax: + content: 'function hashString(plainText: string): Promise' + parameters: + - id: plainText + type: string + description: '' + return: + description: '' + type: Promise<string> + - name: removeTokenBindingKey() + uid: '@azure/msal-node.CryptoProvider.removeTokenBindingKey' + package: '@azure/msal-node' + summary: Removes cryptographic keypair from key store matching the keyId passed in + remarks: '' + isDeprecated: false + syntax: + content: 'function removeTokenBindingKey(): Promise' + return: + description: '' + type: Promise<boolean> + - name: signJwt() + uid: '@azure/msal-node.CryptoProvider.signJwt' + package: '@azure/msal-node' + summary: >- + Signs the given object as a jwt payload with private key retrieved by + given kid - currently not implemented for node + remarks: '' + isDeprecated: false + syntax: + content: 'function signJwt(): Promise' + return: + description: '' + type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml b/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml new file mode 100644 index 0000000..598e591 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml @@ -0,0 +1,131 @@ +### YamlMime:TSType +name: DeviceCodeClient +uid: '@azure/msal-node.DeviceCodeClient' +package: '@azure/msal-node' +summary: OAuth2.0 Device code client +fullName: DeviceCodeClient +remarks: '' +isDeprecated: false +type: class +constructors: + - name: DeviceCodeClient(ClientConfiguration) + uid: '@azure/msal-node.DeviceCodeClient.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new DeviceCodeClient(configuration: ClientConfiguration)' + parameters: + - id: configuration + type: + description: '' +inheritedProperties: + - name: authority + uid: '@azure/msal-node.DeviceCodeClient.authority' + package: '@azure/msal-node' + summary: '' + fullName: authority + remarks: '' + isDeprecated: false + syntax: + content: 'authority: Authority' + return: + description: '' + type: + inheritanceDescription: Inherited From BaseClient.authority + - name: logger + uid: '@azure/msal-node.DeviceCodeClient.logger' + package: '@azure/msal-node' + summary: '' + fullName: logger + remarks: '' + isDeprecated: false + syntax: + content: 'logger: Logger' + return: + description: '' + type: + inheritanceDescription: Inherited From BaseClient.logger +inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-node.DeviceCodeClient.createTokenQueryParameters' + package: '@azure/msal-node' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseClient.createTokenQueryParameters + - name: updateAuthority(string, string) + uid: '@azure/msal-node.DeviceCodeClient.updateAuthority' + package: '@azure/msal-node' + summary: >- + Updates the authority object of the client. Endpoint discovery must be + completed. + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateAuthority(cloudInstanceHostname: string, correlationId: + string): Promise + parameters: + - id: cloudInstanceHostname + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseClient.updateAuthority +methods: + - name: acquireToken(CommonDeviceCodeRequest) + uid: '@azure/msal-node.DeviceCodeClient.acquireToken' + package: '@azure/msal-node' + summary: >- + Gets device code from device code endpoint, calls back to with device code + response, and + + polls token endpoint to exchange device code for tokens + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireToken(request: CommonDeviceCodeRequest): Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: createExtraQueryParameters(CommonDeviceCodeRequest) + uid: '@azure/msal-node.DeviceCodeClient.createExtraQueryParameters' + package: '@azure/msal-node' + summary: Creates query string for the device code request + remarks: '' + isDeprecated: false + syntax: + content: >- + function createExtraQueryParameters(request: CommonDeviceCodeRequest): + string + parameters: + - id: request + type: + description: '' + return: + description: '' + type: string +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeRequest.yml new file mode 100644 index 0000000..a60d470 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeRequest.yml @@ -0,0 +1,50 @@ +### YamlMime:TSTypeAlias +name: DeviceCodeRequest +uid: '@azure/msal-node.DeviceCodeRequest' +package: '@azure/msal-node' +summary: >- + Parameters for Oauth2 device code flow. + + - 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. If authority is set on + client application object, this will override that value. Overriding the value + will cause for authority validation to happen each time. If the same authority + will be used for all request, set on the application object instead of the + requests. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - deviceCodeCallback - Callback containing device code response. + Message should be shown to end user. End user can then navigate to the + verification_uri, input the user_code, and input credentials. + + - cancel - Boolean to cancel polling of device code + endpoint. While the user authenticates on a separate device, MSAL polls the + the token endpoint of security token service for the interval specified in the + device code response (usually 15 minutes). To stop polling and cancel the + request, set cancel=true. + + - extraQueryParameters - String to string map of custom query parameters + added to the query string +fullName: DeviceCodeRequest +remarks: '' +isDeprecated: false +syntax: | + type DeviceCodeRequest = Partial< + Omit< + CommonDeviceCodeRequest, + | "scopes" + | "deviceCodeCallback" + | "resourceRequestMethod" + | "resourceRequestUri" + | "requestedClaimsHash" + | "storeInCache" + > + > & { + deviceCodeCallback: (response: DeviceCodeResponse) => void + scopes: string[] + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml b/msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml new file mode 100644 index 0000000..5cbfe9b --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: DistributedCachePlugin +uid: '@azure/msal-node.DistributedCachePlugin' +package: '@azure/msal-node' +summary: '' +fullName: DistributedCachePlugin +remarks: '' +isDeprecated: false +type: class +constructors: + - name: DistributedCachePlugin(ICacheClient, IPartitionManager) + uid: '@azure/msal-node.DistributedCachePlugin.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new DistributedCachePlugin(client: ICacheClient, partitionManager: + IPartitionManager) + parameters: + - id: client + type: + description: '' + - id: partitionManager + type: + description: '' +methods: + - name: afterCacheAccess(TokenCacheContext) + uid: '@azure/msal-node.DistributedCachePlugin.afterCacheAccess' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function afterCacheAccess(cacheContext: TokenCacheContext): + Promise + parameters: + - id: cacheContext + type: + description: '' + return: + description: '' + type: Promise<void> + - name: beforeCacheAccess(TokenCacheContext) + uid: '@azure/msal-node.DistributedCachePlugin.beforeCacheAccess' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function beforeCacheAccess(cacheContext: TokenCacheContext): + Promise + parameters: + - id: cacheContext + type: + description: '' + return: + description: '' + type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-node/IAppTokenProvider.yml b/msal/docs-ref-autogen/@azure/msal-node/IAppTokenProvider.yml new file mode 100644 index 0000000..1a40da6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/IAppTokenProvider.yml @@ -0,0 +1,9 @@ +### YamlMime:TSType +name: IAppTokenProvider +uid: '@azure/msal-node.IAppTokenProvider' +package: '@azure/msal-node' +summary: '' +fullName: IAppTokenProvider +remarks: '' +isDeprecated: false +type: interface diff --git a/msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml b/msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml new file mode 100644 index 0000000..1130ce9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml @@ -0,0 +1,43 @@ +### YamlMime:TSType +name: ICacheClient +uid: '@azure/msal-node.ICacheClient' +package: '@azure/msal-node' +summary: '' +fullName: ICacheClient +remarks: '' +isDeprecated: false +type: interface +methods: + - name: get(string) + uid: '@azure/msal-node.ICacheClient.get' + package: '@azure/msal-node' + summary: Retrieve the value from the cache + remarks: '' + isDeprecated: false + syntax: + content: 'function get(key: string): Promise' + parameters: + - id: key + type: string + description: string + return: + description: Promise + type: Promise<string> + - name: set(string, string) + uid: '@azure/msal-node.ICacheClient.set' + package: '@azure/msal-node' + summary: Save the required value using the provided key to cache + remarks: '' + isDeprecated: false + syntax: + content: 'function set(key: string, value: string): Promise' + parameters: + - id: key + type: string + description: string + - id: value + type: string + description: string + return: + description: Promise + type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-node/ICachePlugin.yml b/msal/docs-ref-autogen/@azure/msal-node/ICachePlugin.yml new file mode 100644 index 0000000..6285784 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ICachePlugin.yml @@ -0,0 +1,38 @@ +### YamlMime:TSType +name: ICachePlugin +uid: '@azure/msal-node.ICachePlugin' +package: '@azure/msal-node' +summary: '' +fullName: ICachePlugin +remarks: '' +isDeprecated: false +type: interface +properties: + - name: afterCacheAccess + uid: '@azure/msal-node.ICachePlugin.afterCacheAccess' + package: '@azure/msal-node' + summary: '' + fullName: afterCacheAccess + remarks: '' + isDeprecated: false + syntax: + content: >- + afterCacheAccess: (tokenCacheContext: TokenCacheContext) => + Promise + return: + description: '' + type: '(tokenCacheContext: TokenCacheContext) => Promise<void>' + - name: beforeCacheAccess + uid: '@azure/msal-node.ICachePlugin.beforeCacheAccess' + package: '@azure/msal-node' + summary: '' + fullName: beforeCacheAccess + remarks: '' + isDeprecated: false + syntax: + content: >- + beforeCacheAccess: (tokenCacheContext: TokenCacheContext) => + Promise + return: + description: '' + type: '(tokenCacheContext: TokenCacheContext) => Promise<void>' diff --git a/msal/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml new file mode 100644 index 0000000..b97edbd --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml @@ -0,0 +1,211 @@ +### YamlMime:TSType +name: IConfidentialClientApplication +uid: '@azure/msal-node.IConfidentialClientApplication' +package: '@azure/msal-node' +summary: >- + Interface for the ConfidentialClientApplication class defining the public API + signatures +fullName: IConfidentialClientApplication +remarks: '' +isDeprecated: false +type: interface +methods: + - name: acquireTokenByClientCredential(ClientCredentialRequest) + uid: >- + @azure/msal-node.IConfidentialClientApplication.acquireTokenByClientCredential + package: '@azure/msal-node' + summary: >- + Acquires tokens from the authority for the application (not for an end + user) + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByClientCredential(request: + ClientCredentialRequest): Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenByCode(AuthorizationCodeRequest) + uid: '@azure/msal-node.IConfidentialClientApplication.acquireTokenByCode' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the authorization code received from the + first step of OAuth 2.0 Authorization Code Flow + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByCode(request: AuthorizationCodeRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenByRefreshToken(RefreshTokenRequest) + uid: '@azure/msal-node.IConfidentialClientApplication.acquireTokenByRefreshToken' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the refresh token provided for a new set of + tokens + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByRefreshToken(request: RefreshTokenRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenByUsernamePassword(UsernamePasswordRequest) + uid: >- + @azure/msal-node.IConfidentialClientApplication.acquireTokenByUsernamePassword + package: '@azure/msal-node' + summary: >- + Acquires tokens with password grant by exchanging client applications + username and password for credentials + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByUsernamePassword(request: + UsernamePasswordRequest): Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenOnBehalfOf(OnBehalfOfRequest) + uid: '@azure/msal-node.IConfidentialClientApplication.acquireTokenOnBehalfOf' + package: '@azure/msal-node' + summary: Acquires tokens from the authority for the application + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenOnBehalfOf(request: OnBehalfOfRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenSilent(SilentFlowRequest) + uid: '@azure/msal-node.IConfidentialClientApplication.acquireTokenSilent' + package: '@azure/msal-node' + summary: >- + Acquires a token silently when a user specifies the account the token is + requested for + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(request: SilentFlowRequest): Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: clearCache() + uid: '@azure/msal-node.IConfidentialClientApplication.clearCache' + package: '@azure/msal-node' + summary: Clear the cache + remarks: '' + isDeprecated: false + syntax: + content: function clearCache() + - name: getAuthCodeUrl(AuthorizationUrlRequest) + uid: '@azure/msal-node.IConfidentialClientApplication.getAuthCodeUrl' + package: '@azure/msal-node' + summary: Creates the URL of the authorization request + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAuthCodeUrl(request: AuthorizationUrlRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<string> + - name: getLogger() + uid: '@azure/msal-node.IConfidentialClientApplication.getLogger' + package: '@azure/msal-node' + summary: Returns the logger instance + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + - name: getTokenCache() + uid: '@azure/msal-node.IConfidentialClientApplication.getTokenCache' + package: '@azure/msal-node' + summary: Gets the token cache for the application + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenCache(): TokenCache' + return: + description: '' + type: + - name: SetAppTokenProvider(IAppTokenProvider) + uid: '@azure/msal-node.IConfidentialClientApplication.SetAppTokenProvider' + package: '@azure/msal-node' + summary: >- + This extensibility point is meant for Azure SDK to enhance Managed + Identity support + remarks: '' + isDeprecated: false + syntax: + content: 'function SetAppTokenProvider(provider: IAppTokenProvider)' + parameters: + - id: provider + type: + description: '' + - name: setLogger(Logger) + uid: '@azure/msal-node.IConfidentialClientApplication.setLogger' + package: '@azure/msal-node' + summary: >- + Replaces the default logger set in configurations with new Logger with new + configurations + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml b/msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml new file mode 100644 index 0000000..32e3df9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml @@ -0,0 +1,53 @@ +### YamlMime:TSType +name: ILoopbackClient +uid: '@azure/msal-node.ILoopbackClient' +package: '@azure/msal-node' +summary: >- + Interface for LoopbackClient allowing to replace the default loopback server + with a custom implementation. +fullName: ILoopbackClient +remarks: '' +isDeprecated: false +type: interface +methods: + - name: closeServer() + uid: '@azure/msal-node.ILoopbackClient.closeServer' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: function closeServer() + - name: getRedirectUri() + uid: '@azure/msal-node.ILoopbackClient.getRedirectUri' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getRedirectUri(): string' + return: + description: '' + type: string + - name: listenForAuthCode(string, string) + uid: '@azure/msal-node.ILoopbackClient.listenForAuthCode' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function listenForAuthCode(successTemplate?: string, errorTemplate?: + string): Promise + parameters: + - id: successTemplate + type: string + description: '' + - id: errorTemplate + type: string + description: '' + return: + description: '' + type: >- + Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-node/INativeBrokerPlugin.yml b/msal/docs-ref-autogen/@azure/msal-node/INativeBrokerPlugin.yml new file mode 100644 index 0000000..3c39928 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/INativeBrokerPlugin.yml @@ -0,0 +1,127 @@ +### YamlMime:TSType +name: INativeBrokerPlugin +uid: '@azure/msal-node.INativeBrokerPlugin' +package: '@azure/msal-node' +summary: '' +fullName: INativeBrokerPlugin +remarks: '' +isDeprecated: false +type: interface +properties: + - name: isBrokerAvailable + uid: '@azure/msal-node.INativeBrokerPlugin.isBrokerAvailable' + package: '@azure/msal-node' + summary: '' + fullName: isBrokerAvailable + remarks: '' + isDeprecated: false + syntax: + content: 'isBrokerAvailable: boolean' + return: + description: '' + type: boolean +methods: + - name: acquireTokenInteractive(NativeRequest, Buffer) + uid: '@azure/msal-node.INativeBrokerPlugin.acquireTokenInteractive' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenInteractive(request: NativeRequest, windowHandle?: + Buffer): Promise + parameters: + - id: request + type: + description: '' + - id: windowHandle + type: Buffer + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenSilent(NativeRequest) + uid: '@azure/msal-node.INativeBrokerPlugin.acquireTokenSilent' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(request: NativeRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: getAccountById(string, string) + uid: '@azure/msal-node.INativeBrokerPlugin.getAccountById' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountById(accountId: string, correlationId: string): + Promise + parameters: + - id: accountId + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<> + - name: getAllAccounts(string, string) + uid: '@azure/msal-node.INativeBrokerPlugin.getAllAccounts' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAllAccounts(clientId: string, correlationId: string): + Promise + parameters: + - id: clientId + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<[]> + - name: setLogger(LoggerOptions) + uid: '@azure/msal-node.INativeBrokerPlugin.setLogger' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(loggerOptions: LoggerOptions)' + parameters: + - id: loggerOptions + type: + description: '' + - name: signOut(NativeSignOutRequest) + uid: '@azure/msal-node.INativeBrokerPlugin.signOut' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function signOut(request: NativeSignOutRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml b/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml new file mode 100644 index 0000000..052e8b4 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: INetworkModule +uid: '@azure/msal-node.INetworkModule' +package: '@azure/msal-node' +summary: Client network interface to send backend requests. +fullName: INetworkModule +remarks: '' +isDeprecated: false +type: interface +methods: + - name: sendGetRequestAsync(string, NetworkRequestOptions, number) + uid: '@azure/msal-node.INetworkModule.sendGetRequestAsync' + package: '@azure/msal-node' + summary: >- + Interface function for async network "GET" requests. Based on the Fetch + standard: https://fetch.spec.whatwg.org/ + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendGetRequestAsync(url: string, options?: + NetworkRequestOptions, cancellationToken?: number): + Promise> + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + - id: cancellationToken + type: number + description: '' + return: + description: '' + type: >- + Promise<<T>> + - name: sendPostRequestAsync(string, NetworkRequestOptions) + uid: '@azure/msal-node.INetworkModule.sendPostRequestAsync' + package: '@azure/msal-node' + summary: >- + Interface function for async network "POST" requests. Based on the Fetch + standard: https://fetch.spec.whatwg.org/ + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendPostRequestAsync(url: string, options?: + NetworkRequestOptions): Promise> + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + return: + description: '' + type: >- + Promise<<T>> diff --git a/msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml b/msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml new file mode 100644 index 0000000..69b73a5 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: IPartitionManager +uid: '@azure/msal-node.IPartitionManager' +package: '@azure/msal-node' +summary: '' +fullName: IPartitionManager +remarks: '' +isDeprecated: false +type: interface +methods: + - name: extractKey(AccountEntity) + uid: '@azure/msal-node.IPartitionManager.extractKey' + package: '@azure/msal-node' + summary: |- + This function should return the correct key being used to save each + user's cache information to cache - given an AccountEntity + + Example: Your application may be partitioning the user's cache + information for each user using the homeAccountId thus + this function would return the homeAccountId from + the provided AccountEntity + remarks: '' + isDeprecated: false + syntax: + content: 'function extractKey(accountEntity: AccountEntity): Promise' + parameters: + - id: accountEntity + type: + description: '' + return: + description: Promise + type: Promise<string> + - name: getKey() + uid: '@azure/msal-node.IPartitionManager.getKey' + package: '@azure/msal-node' + summary: |- + This function should return the correct key from which to read + the specific user's information from cache. + + Example: Your application may be partitioning the user's cache + information for each user using the homeAccountId and thus + this function would return the homeAccountId for + the user in question + remarks: '' + isDeprecated: false + syntax: + content: 'function getKey(): Promise' + return: + description: Promise + type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml new file mode 100644 index 0000000..d00cc10 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml @@ -0,0 +1,215 @@ +### YamlMime:TSType +name: IPublicClientApplication +uid: '@azure/msal-node.IPublicClientApplication' +package: '@azure/msal-node' +summary: >- + Interface for the PublicClientApplication class defining the public API + signatures +fullName: IPublicClientApplication +remarks: '' +isDeprecated: false +type: interface +methods: + - name: acquireTokenByCode(AuthorizationCodeRequest) + uid: '@azure/msal-node.IPublicClientApplication.acquireTokenByCode' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the authorization code received from the + first step of OAuth 2.0 Authorization Code Flow + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByCode(request: AuthorizationCodeRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenByDeviceCode(DeviceCodeRequest) + uid: '@azure/msal-node.IPublicClientApplication.acquireTokenByDeviceCode' + package: '@azure/msal-node' + summary: Acquires a token from the authority using OAuth2.0 device code flow + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByDeviceCode(request: DeviceCodeRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenByRefreshToken(RefreshTokenRequest) + uid: '@azure/msal-node.IPublicClientApplication.acquireTokenByRefreshToken' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the refresh token provided for a new set of + tokens + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByRefreshToken(request: RefreshTokenRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenByUsernamePassword(UsernamePasswordRequest) + uid: '@azure/msal-node.IPublicClientApplication.acquireTokenByUsernamePassword' + package: '@azure/msal-node' + summary: >- + Acquires tokens with password grant by exchanging client applications + username and password for credentials + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByUsernamePassword(request: + UsernamePasswordRequest): Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenInteractive(InteractiveRequest) + uid: '@azure/msal-node.IPublicClientApplication.acquireTokenInteractive' + package: '@azure/msal-node' + summary: Acquires a token interactively + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenInteractive(request: InteractiveRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenSilent(SilentFlowRequest) + uid: '@azure/msal-node.IPublicClientApplication.acquireTokenSilent' + package: '@azure/msal-node' + summary: >- + Acquires a token silently when a user specifies the account the token is + requested for + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(request: SilentFlowRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: clearCache() + uid: '@azure/msal-node.IPublicClientApplication.clearCache' + package: '@azure/msal-node' + summary: Clear the cache + remarks: '' + isDeprecated: false + syntax: + content: function clearCache() + - name: getAllAccounts() + uid: '@azure/msal-node.IPublicClientApplication.getAllAccounts' + package: '@azure/msal-node' + summary: Gets all cached accounts + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(): Promise' + return: + description: '' + type: Promise<[]> + - name: getAuthCodeUrl(AuthorizationUrlRequest) + uid: '@azure/msal-node.IPublicClientApplication.getAuthCodeUrl' + package: '@azure/msal-node' + summary: Creates the URL of the authorization request + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAuthCodeUrl(request: AuthorizationUrlRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<string> + - name: getLogger() + uid: '@azure/msal-node.IPublicClientApplication.getLogger' + package: '@azure/msal-node' + summary: Returns the logger instance + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + - name: getTokenCache() + uid: '@azure/msal-node.IPublicClientApplication.getTokenCache' + package: '@azure/msal-node' + summary: Gets the token cache for the application + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenCache(): TokenCache' + return: + description: '' + type: + - name: setLogger(Logger) + uid: '@azure/msal-node.IPublicClientApplication.setLogger' + package: '@azure/msal-node' + summary: >- + Replaces the default logger set in configurations with new Logger with new + configurations + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: '' + - name: signOut(SignOutRequest) + uid: '@azure/msal-node.IPublicClientApplication.signOut' + package: '@azure/msal-node' + summary: Removes cache artifacts associated with the given account + remarks: '' + isDeprecated: false + syntax: + content: 'function signOut(request: SignOutRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-node/ISerializableTokenCache.yml b/msal/docs-ref-autogen/@azure/msal-node/ISerializableTokenCache.yml new file mode 100644 index 0000000..539b55c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ISerializableTokenCache.yml @@ -0,0 +1,34 @@ +### YamlMime:TSType +name: ISerializableTokenCache +uid: '@azure/msal-node.ISerializableTokenCache' +package: '@azure/msal-node' +summary: '' +fullName: ISerializableTokenCache +remarks: '' +isDeprecated: false +type: interface +properties: + - name: deserialize + uid: '@azure/msal-node.ISerializableTokenCache.deserialize' + package: '@azure/msal-node' + summary: '' + fullName: deserialize + remarks: '' + isDeprecated: false + syntax: + content: 'deserialize: (cache: string) => void' + return: + description: '' + type: '(cache: string) => void' + - name: serialize + uid: '@azure/msal-node.ISerializableTokenCache.serialize' + package: '@azure/msal-node' + summary: '' + fullName: serialize + remarks: '' + isDeprecated: false + syntax: + content: 'serialize: () => string' + return: + description: '' + type: () => string diff --git a/msal/docs-ref-autogen/@azure/msal-node/ITokenCache.yml b/msal/docs-ref-autogen/@azure/msal-node/ITokenCache.yml new file mode 100644 index 0000000..89b0d90 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ITokenCache.yml @@ -0,0 +1,70 @@ +### YamlMime:TSType +name: ITokenCache +uid: '@azure/msal-node.ITokenCache' +package: '@azure/msal-node' +summary: Token cache interface for the client, giving access to cache APIs +fullName: ITokenCache +remarks: '' +isDeprecated: false +type: interface +methods: + - name: getAccountByHomeId(string) + uid: '@azure/msal-node.ITokenCache.getAccountByHomeId' + package: '@azure/msal-node' + summary: Returns the signed in account matching homeAccountId + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountByHomeId(homeAccountId: string): Promise + parameters: + - id: homeAccountId + type: string + description: '' + return: + description: '' + type: Promise<null | > + - name: getAccountByLocalId(string) + uid: '@azure/msal-node.ITokenCache.getAccountByLocalId' + package: '@azure/msal-node' + summary: Returns the signed in account matching localAccountId + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountByLocalId(localAccountId: string): Promise + parameters: + - id: localAccountId + type: string + description: '' + return: + description: '' + type: Promise<null | > + - name: getAllAccounts() + uid: '@azure/msal-node.ITokenCache.getAllAccounts' + package: '@azure/msal-node' + summary: API that retrieves all accounts currently in cache to the user + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(): Promise' + return: + description: '' + type: Promise<[]> + - name: removeAccount(AccountInfo) + uid: '@azure/msal-node.ITokenCache.removeAccount' + package: '@azure/msal-node' + summary: API to remove a specific account and the relevant data from cache + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAccount(account: AccountInfo): Promise' + parameters: + - id: account + type: + description: '' + return: + description: '' + type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-node/IdTokenClaims.yml b/msal/docs-ref-autogen/@azure/msal-node/IdTokenClaims.yml new file mode 100644 index 0000000..2636c93 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/IdTokenClaims.yml @@ -0,0 +1,44 @@ +### YamlMime:TSTypeAlias +name: IdTokenClaims +uid: '@azure/msal-node.IdTokenClaims' +package: '@azure/msal-node' +summary: Type which describes Id Token claims known by MSAL. +fullName: IdTokenClaims +remarks: '' +isDeprecated: false +syntax: | + type IdTokenClaims = { + acr?: string + amr?: string[] + at?: string + aud?: string + auth_time?: number + cloud_instance_host_name?: string + cnf?: { kid: string } + emails?: string[] + exp?: number + home_oid?: string + iat?: number + idp?: string + iss?: string + login_hint?: string + m?: string + name?: string + nbf?: number + nonce?: string + oid?: string + p?: string + preferred_username?: string + roles?: string[] + sid?: string + sub?: string + tenant_region_scope?: string + tenant_region_sub_scope?: string + tfp?: string + tid?: string + ts?: number + u?: string + upn?: string + ver?: string + x5c_ca?: string[] + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml b/msal/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml new file mode 100644 index 0000000..e770f60 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: InMemoryCache +uid: '@azure/msal-node.InMemoryCache' +package: '@azure/msal-node' +summary: Intermittent type to handle in-memory data objects with defined types +fullName: InMemoryCache +remarks: '' +isDeprecated: false +syntax: | + type InMemoryCache = { + accessTokens: AccessTokenCache + accounts: AccountCache + appMetadata: AppMetadataCache + idTokens: IdTokenCache + refreshTokens: RefreshTokenCache + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml new file mode 100644 index 0000000..54334f7 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml @@ -0,0 +1,275 @@ +### YamlMime:TSType +name: InteractionRequiredAuthError +uid: '@azure/msal-node.InteractionRequiredAuthError' +package: '@azure/msal-node' +summary: Error thrown when user interaction is required. +fullName: InteractionRequiredAuthError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: >- + InteractionRequiredAuthError(string, string, string, string, string, + string, string) + uid: '@azure/msal-node.InteractionRequiredAuthError.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new InteractionRequiredAuthError(errorCode?: string, errorMessage?: + string, subError?: string, timestamp?: string, traceId?: string, + correlationId?: string, claims?: string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: subError + type: string + description: '' + - id: timestamp + type: string + description: '' + - id: traceId + type: string + description: '' + - id: correlationId + type: string + description: '' + - id: claims + type: string + description: '' +properties: + - name: claims + uid: '@azure/msal-node.InteractionRequiredAuthError.claims' + package: '@azure/msal-node' + summary: >- + https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-common/docs/claims-challenge.md + + + A string with extra claims needed for the token request to succeed + + web site: redirect the user to the authorization page and set the extra + claims + + web api: include the claims in the WWW-Authenticate header that are sent + back to the client so that it knows to request a token with the extra + claims + + desktop application or browser context: include the claims when acquiring + the token interactively + + app to app context (client_credentials): include the claims in the + AcquireTokenByClientCredential request + fullName: claims + remarks: '' + isDeprecated: false + syntax: + content: 'claims: string' + return: + description: '' + type: string + - name: timestamp + uid: '@azure/msal-node.InteractionRequiredAuthError.timestamp' + package: '@azure/msal-node' + summary: The time the error occured at + fullName: timestamp + remarks: '' + isDeprecated: false + syntax: + content: 'timestamp: string' + return: + description: '' + type: string + - name: traceId + uid: '@azure/msal-node.InteractionRequiredAuthError.traceId' + package: '@azure/msal-node' + summary: TraceId associated with the error + fullName: traceId + remarks: '' + isDeprecated: false + syntax: + content: 'traceId: string' + return: + description: '' + type: string +inheritedProperties: + - name: correlationId + uid: '@azure/msal-node.InteractionRequiredAuthError.correlationId' + package: '@azure/msal-node' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-node.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-node.InteractionRequiredAuthError.errorCode' + package: '@azure/msal-node' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-node.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-node.InteractionRequiredAuthError.errorMessage' + package: '@azure/msal-node' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-node.AuthError.errorMessage) + - name: message + uid: '@azure/msal-node.InteractionRequiredAuthError.message' + package: '@azure/msal-node' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-node.AuthError.message) + - name: name + uid: '@azure/msal-node.InteractionRequiredAuthError.name' + package: '@azure/msal-node' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-node.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-node.InteractionRequiredAuthError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-node.InteractionRequiredAuthError.stack' + package: '@azure/msal-node' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-node.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-node.InteractionRequiredAuthError.stackTraceLimit' + package: '@azure/msal-node' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-node.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-node.InteractionRequiredAuthError.subError' + package: '@azure/msal-node' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-node.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-node.InteractionRequiredAuthError.captureStackTrace' + package: '@azure/msal-node' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-node.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-node.InteractionRequiredAuthError.setCorrelationId' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-node.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthErrorCodes.yml b/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthErrorCodes.yml new file mode 100644 index 0000000..f985fa5 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthErrorCodes.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-node.InteractionRequiredAuthErrorCodes' +name: InteractionRequiredAuthErrorCodes +type: module +package: '@azure/msal-node' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml new file mode 100644 index 0000000..7d35c9d --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml @@ -0,0 +1,49 @@ +### YamlMime:TSTypeAlias +name: InteractiveRequest +uid: '@azure/msal-node.InteractiveRequest' +package: '@azure/msal-node' +summary: >- + Request object passed by user to configure acquireTokenInteractive API + + + - openBrowser - Function to open a browser instance on user's + system. + + - scopes - Array of scopes the application is requesting + access to. + + - successTemplate: - Template to be displayed on the opened browser + instance upon successful token acquisition. + + - errorTemplate - Template to be displayed on the opened browser + instance upon token acquisition failure. + + - windowHandle - Used in native broker flows to properly parent the + native broker window + + - loopbackClient - Custom implementation for a loopback server to + listen for authorization code response. +fullName: InteractiveRequest +remarks: '' +isDeprecated: false +syntax: | + type InteractiveRequest = Pick< + AuthorizationUrlRequest, + | "authority" + | "correlationId" + | "claims" + | "azureCloudOptions" + | "account" + | "extraQueryParameters" + | "tokenQueryParameters" + | "extraScopesToConsent" + | "loginHint" + | "prompt" + > & { + errorTemplate?: string + loopbackClient?: ILoopbackClient + openBrowser: (url: string) => Promise + scopes?: string[] + successTemplate?: string + windowHandle?: Buffer + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/JsonCache.yml b/msal/docs-ref-autogen/@azure/msal-node/JsonCache.yml new file mode 100644 index 0000000..a58259c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/JsonCache.yml @@ -0,0 +1,18 @@ +### YamlMime:TSTypeAlias +name: JsonCache +uid: '@azure/msal-node.JsonCache' +package: '@azure/msal-node' +summary: >- + Cache format read from the cache blob provided to the configuration during app + instantiation +fullName: JsonCache +remarks: '' +isDeprecated: false +syntax: | + type JsonCache = { + AccessToken: Record + Account: Record + AppMetadata: Record + IdToken: Record + RefreshToken: Record + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/LogLevel.yml b/msal/docs-ref-autogen/@azure/msal-node/LogLevel.yml new file mode 100644 index 0000000..6571d7c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/LogLevel.yml @@ -0,0 +1,34 @@ +### YamlMime:TSEnum +name: LogLevel +uid: '@azure/msal-node.LogLevel' +package: '@azure/msal-node' +summary: Log message level. +fullName: LogLevel +remarks: '' +isDeprecated: false +fields: + - name: Error + uid: '@azure/msal-node.LogLevel.Error' + package: '@azure/msal-node' + summary: '' + numericValue: 0 + - name: Warning + uid: '@azure/msal-node.LogLevel.Warning' + package: '@azure/msal-node' + summary: '' + numericValue: 1 + - name: Info + uid: '@azure/msal-node.LogLevel.Info' + package: '@azure/msal-node' + summary: '' + numericValue: 2 + - name: Verbose + uid: '@azure/msal-node.LogLevel.Verbose' + package: '@azure/msal-node' + summary: '' + numericValue: 3 + - name: Trace + uid: '@azure/msal-node.LogLevel.Trace' + package: '@azure/msal-node' + summary: '' + numericValue: 4 diff --git a/msal/docs-ref-autogen/@azure/msal-node/Logger.yml b/msal/docs-ref-autogen/@azure/msal-node/Logger.yml new file mode 100644 index 0000000..8244e31 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/Logger.yml @@ -0,0 +1,235 @@ +### YamlMime:TSType +name: Logger +uid: '@azure/msal-node.Logger' +package: '@azure/msal-node' +summary: Class which facilitates logging of messages to a specific place. +fullName: Logger +remarks: '' +isDeprecated: false +type: class +constructors: + - name: Logger(LoggerOptions, string, string) + uid: '@azure/msal-node.Logger.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new Logger(loggerOptions: LoggerOptions, packageName?: string, + packageVersion?: string) + parameters: + - id: loggerOptions + type: + description: '' + - id: packageName + type: string + description: '' + - id: packageVersion + type: string + description: '' +methods: + - name: clone(string, string, string) + uid: '@azure/msal-node.Logger.clone' + package: '@azure/msal-node' + summary: Create new Logger with existing configurations. + remarks: '' + isDeprecated: false + syntax: + content: >- + function clone(packageName: string, packageVersion: string, + correlationId?: string): Logger + parameters: + - id: packageName + type: string + description: '' + - id: packageVersion + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: + - name: error(string, string) + uid: '@azure/msal-node.Logger.error' + package: '@azure/msal-node' + summary: Logs error messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function error(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: errorPii(string, string) + uid: '@azure/msal-node.Logger.errorPii' + package: '@azure/msal-node' + summary: Logs error messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function errorPii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: executeCallback(LogLevel, string, boolean) + uid: '@azure/msal-node.Logger.executeCallback' + package: '@azure/msal-node' + summary: Execute callback with message. + remarks: '' + isDeprecated: false + syntax: + content: >- + function executeCallback(level: LogLevel, message: string, containsPii: + boolean) + parameters: + - id: level + type: + description: '' + - id: message + type: string + description: '' + - id: containsPii + type: boolean + description: '' + - name: info(string, string) + uid: '@azure/msal-node.Logger.info' + package: '@azure/msal-node' + summary: Logs info messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function info(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: infoPii(string, string) + uid: '@azure/msal-node.Logger.infoPii' + package: '@azure/msal-node' + summary: Logs info messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function infoPii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: isPiiLoggingEnabled() + uid: '@azure/msal-node.Logger.isPiiLoggingEnabled' + package: '@azure/msal-node' + summary: Returns whether PII Logging is enabled or not. + remarks: '' + isDeprecated: false + syntax: + content: 'function isPiiLoggingEnabled(): boolean' + return: + description: '' + type: boolean + - name: trace(string, string) + uid: '@azure/msal-node.Logger.trace' + package: '@azure/msal-node' + summary: Logs trace messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function trace(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: tracePii(string, string) + uid: '@azure/msal-node.Logger.tracePii' + package: '@azure/msal-node' + summary: Logs trace messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function tracePii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: verbose(string, string) + uid: '@azure/msal-node.Logger.verbose' + package: '@azure/msal-node' + summary: Logs verbose messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function verbose(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: verbosePii(string, string) + uid: '@azure/msal-node.Logger.verbosePii' + package: '@azure/msal-node' + summary: Logs verbose messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function verbosePii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: warning(string, string) + uid: '@azure/msal-node.Logger.warning' + package: '@azure/msal-node' + summary: Logs warning messages. + remarks: '' + isDeprecated: false + syntax: + content: 'function warning(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' + - name: warningPii(string, string) + uid: '@azure/msal-node.Logger.warningPii' + package: '@azure/msal-node' + summary: Logs warning messages with PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function warningPii(message: string, correlationId?: string)' + parameters: + - id: message + type: string + description: '' + - id: correlationId + type: string + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityApplication.yml new file mode 100644 index 0000000..c8d074c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityApplication.yml @@ -0,0 +1,42 @@ +### YamlMime:TSType +name: ManagedIdentityApplication +uid: '@azure/msal-node.ManagedIdentityApplication' +package: '@azure/msal-node' +summary: Class to initialize a managed identity and identify the service +fullName: ManagedIdentityApplication +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ManagedIdentityApplication(ManagedIdentityConfiguration) + uid: '@azure/msal-node.ManagedIdentityApplication.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ManagedIdentityApplication(configuration?: + ManagedIdentityConfiguration) + parameters: + - id: configuration + type: + description: '' +methods: + - name: acquireToken(ManagedIdentityRequestParams) + uid: '@azure/msal-node.ManagedIdentityApplication.acquireToken' + package: '@azure/msal-node' + summary: Acquire an access token from the cache or the managed identity + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireToken(managedIdentityRequestParams: + ManagedIdentityRequestParams): Promise + parameters: + - id: managedIdentityRequestParams + type: + description: '' + return: + description: the access token + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityConfiguration.yml new file mode 100644 index 0000000..04871b9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityConfiguration.yml @@ -0,0 +1,13 @@ +### YamlMime:TSTypeAlias +name: ManagedIdentityConfiguration +uid: '@azure/msal-node.ManagedIdentityConfiguration' +package: '@azure/msal-node' +summary: '' +fullName: ManagedIdentityConfiguration +remarks: '' +isDeprecated: false +syntax: | + type ManagedIdentityConfiguration = { + managedIdentityIdParams?: ManagedIdentityIdParams + system?: NodeSystemOptions + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityIdParams.yml b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityIdParams.yml new file mode 100644 index 0000000..fbc6af8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityIdParams.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: ManagedIdentityIdParams +uid: '@azure/msal-node.ManagedIdentityIdParams' +package: '@azure/msal-node' +summary: '' +fullName: ManagedIdentityIdParams +remarks: '' +isDeprecated: false +syntax: | + type ManagedIdentityIdParams = { + userAssignedClientId?: string + userAssignedObjectId?: string + userAssignedResourceId?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml new file mode 100644 index 0000000..fdfbabd --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml @@ -0,0 +1,20 @@ +### YamlMime:TSTypeAlias +name: ManagedIdentityRequestParams +uid: '@azure/msal-node.ManagedIdentityRequestParams' +package: '@azure/msal-node' +summary: >- + ManagedIdentityRequest + + - forceRefresh - forces managed identity requests to skip the cache and make + network calls if true + + - resource - resource requested to access the protected API. It should be of + the form "{ResourceIdUri}" or {ResourceIdUri/.default}. For instance + https://management.azure.net or, for Microsoft Graph, + https://graph.microsoft.com/.default +fullName: ManagedIdentityRequestParams +remarks: '' +isDeprecated: false +syntax: > + type ManagedIdentityRequestParams = { forceRefresh?: boolean; resource: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/NetworkRequestOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/NetworkRequestOptions.yml new file mode 100644 index 0000000..9a25127 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/NetworkRequestOptions.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: NetworkRequestOptions +uid: '@azure/msal-node.NetworkRequestOptions' +package: '@azure/msal-node' +summary: Options allowed by network request APIs. +fullName: NetworkRequestOptions +remarks: '' +isDeprecated: false +syntax: > + type NetworkRequestOptions = { body?: string; headers?: Record + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/NetworkResponse.yml b/msal/docs-ref-autogen/@azure/msal-node/NetworkResponse.yml new file mode 100644 index 0000000..29db1ae --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/NetworkResponse.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: NetworkResponse +uid: '@azure/msal-node.NetworkResponse' +package: '@azure/msal-node' +summary: '' +fullName: NetworkResponse +remarks: '' +isDeprecated: false +syntax: | + type NetworkResponse = { + body: T + headers: Record + status: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml new file mode 100644 index 0000000..6e560a2 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml @@ -0,0 +1,51 @@ +### YamlMime:TSTypeAlias +name: NodeAuthOptions +uid: '@azure/msal-node.NodeAuthOptions' +package: '@azure/msal-node' +summary: >- + - clientId - Client id of the application. + + - authority - Url of the authority. If no value is set, defaults + to https://login.microsoftonline.com/common. + + - knownAuthorities - Needed for Azure B2C and ADFS. All authorities that + will be used in the client application. Only the host of the authority should + be passed in. + + - clientSecret - Secret string that the application uses when + requesting a token. Only used in confidential client applications. Can be + created in the Azure app registration portal. + + - clientAssertion - Assertion string that the application uses when + requesting a token. Only used in confidential client applications. Assertion + should be of type urn:ietf:params:oauth:client-assertion-type:jwt-bearer. + + - clientCertificate - Certificate that the application uses when + requesting a token. Only used in confidential client applications. Requires + hex encoded X.509 SHA-1 thumbprint of the certificiate, and the PEM encoded + private key (string should contain -----BEGIN PRIVATE KEY----- ... -----END + PRIVATE KEY----- ) + + - 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. +fullName: NodeAuthOptions +remarks: '' +isDeprecated: false +syntax: | + type NodeAuthOptions = { + authority?: string + authorityMetadata?: string + azureCloudOptions?: AzureCloudOptions + clientAssertion?: string + clientCapabilities?: string[] + clientCertificate?: { privateKey: string; thumbprint: string; x5c?: string } + clientId: string + clientSecret?: string + cloudDiscoveryMetadata?: string + knownAuthorities?: string[] + protocolMode?: ProtocolMode + skipAuthorityMetadataCache?: boolean + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml new file mode 100644 index 0000000..c5e9070 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml @@ -0,0 +1,1173 @@ +### YamlMime:TSType +name: NodeStorage +uid: '@azure/msal-node.NodeStorage' +package: '@azure/msal-node' +summary: >- + This class implements Storage for node, reading cache from user specified + storage location or an extension library +fullName: NodeStorage +remarks: '' +isDeprecated: false +type: class +constructors: + - name: NodeStorage(Logger, string, ICrypto, StaticAuthorityOptions) + uid: '@azure/msal-node.NodeStorage.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new NodeStorage(logger: Logger, clientId: string, cryptoImpl: ICrypto, + staticAuthorityOptions?: StaticAuthorityOptions) + parameters: + - id: logger + type: + description: '' + - id: clientId + type: string + description: '' + - id: cryptoImpl + type: + description: '' + - id: staticAuthorityOptions + type: + description: '' +inheritedMethods: + - name: accessTokenKeyMatchesFilter(string, CredentialFilter, boolean) + uid: '@azure/msal-node.NodeStorage.accessTokenKeyMatchesFilter' + package: '@azure/msal-node' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function accessTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter, keyMustContainAllScopes: boolean): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: + description: '' + - id: keyMustContainAllScopes + type: boolean + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.accessTokenKeyMatchesFilter + - name: credentialMatchesFilter(ValidCredentialType, CredentialFilter) + uid: '@azure/msal-node.NodeStorage.credentialMatchesFilter' + package: '@azure/msal-node' + summary: Returns whether or not the given credential entity matches the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function credentialMatchesFilter(entity: ValidCredentialType, filter: + CredentialFilter): boolean + parameters: + - id: entity + type: + description: '' + - id: filter + type: + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.credentialMatchesFilter + - name: generateAuthorityMetadataCacheKey(string) + uid: '@azure/msal-node.NodeStorage.generateAuthorityMetadataCacheKey' + package: '@azure/msal-node' + summary: returns cache key used for cloud instance metadata + remarks: '' + isDeprecated: false + syntax: + content: 'function generateAuthorityMetadataCacheKey(authority: string): string' + parameters: + - id: authority + type: string + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From CacheManager.generateAuthorityMetadataCacheKey + - name: >- + getAccessToken(AccountInfo, BaseAuthRequest, TokenKeys, string, + IPerformanceClient, string) + uid: '@azure/msal-node.NodeStorage.getAccessToken' + package: '@azure/msal-node' + summary: Retrieve AccessTokenEntity from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessToken(account: AccountInfo, request: BaseAuthRequest, + tokenKeys?: TokenKeys, targetRealm?: string, performanceClient?: + IPerformanceClient, correlationId?: string): null | AccessTokenEntity + parameters: + - id: account + type: + description: '{AccountInfo}' + - id: request + type: + description: '{BaseAuthRequest}' + - id: tokenKeys + type: + description: '{?TokenKeys}' + - id: targetRealm + type: string + description: '' + - id: performanceClient + type: + description: '{?IPerformanceClient}' + - id: correlationId + type: string + description: '{?string}' + return: + description: '' + type: null | + inheritanceDescription: Inherited From CacheManager.getAccessToken + - name: getAccessTokensByFilter(CredentialFilter) + uid: '@azure/msal-node.NodeStorage.getAccessTokensByFilter' + package: '@azure/msal-node' + summary: Gets all access tokens matching the filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessTokensByFilter(filter: CredentialFilter): + AccessTokenEntity[] + parameters: + - id: filter + type: + description: '' + return: + description: '' + type: [] + inheritanceDescription: Inherited From CacheManager.getAccessTokensByFilter + - name: getAccountInfoFilteredBy(AccountFilter) + uid: '@azure/msal-node.NodeStorage.getAccountInfoFilteredBy' + package: '@azure/msal-node' + summary: Gets first tenanted AccountInfo object found based on provided filters + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountInfoFilteredBy(accountFilter: AccountFilter): null | + AccountInfo + parameters: + - id: accountFilter + type: + description: '' + return: + description: '' + type: null | + inheritanceDescription: Inherited From CacheManager.getAccountInfoFilteredBy + - name: getAccountsFilteredBy(AccountFilter) + uid: '@azure/msal-node.NodeStorage.getAccountsFilteredBy' + package: '@azure/msal-node' + summary: >- + Retrieve account entities matching all provided tenant-agnostic filters; + if no filter is set, get all account entities in the cache + + Not checking for casing as keys are all generated in lower case, remember + to convert to lower case if object properties are compared + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountsFilteredBy(accountFilter: AccountFilter): + AccountEntity[] + parameters: + - id: accountFilter + type: + description: An object containing Account properties to filter by + return: + description: '' + type: [] + inheritanceDescription: Inherited From CacheManager.getAccountsFilteredBy + - name: getAllAccounts(AccountFilter) + uid: '@azure/msal-node.NodeStorage.getAllAccounts' + package: '@azure/msal-node' + summary: >- + Returns all the accounts in the cache that match the optional filter. If + no filter is provided, all accounts are returned. + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]' + parameters: + - id: accountFilter + type: + description: (Optional) filter to narrow down the accounts returned + return: + description: Array of AccountInfo objects in cache + type: [] + inheritanceDescription: Inherited From CacheManager.getAllAccounts + - name: getAppMetadataFilteredBy(AppMetadataFilter) + uid: '@azure/msal-node.NodeStorage.getAppMetadataFilteredBy' + package: '@azure/msal-node' + summary: >- + retrieve appMetadata matching all provided filters; if no filter is set, + get all appMetadata + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAppMetadataFilteredBy(filter: AppMetadataFilter): + AppMetadataCache + parameters: + - id: filter + type: + description: '' + return: + description: '' + type: + inheritanceDescription: Inherited From CacheManager.getAppMetadataFilteredBy + - name: getAuthorityMetadataByAlias(string) + uid: '@azure/msal-node.NodeStorage.getAuthorityMetadataByAlias' + package: '@azure/msal-node' + summary: retrieve authorityMetadata that contains a matching alias + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAuthorityMetadataByAlias(host: string): null | + AuthorityMetadataEntity + parameters: + - id: host + type: string + description: '' + return: + description: '' + type: null | + inheritanceDescription: Inherited From CacheManager.getAuthorityMetadataByAlias + - name: getBaseAccountInfo(AccountFilter) + uid: '@azure/msal-node.NodeStorage.getBaseAccountInfo' + package: '@azure/msal-node' + summary: Returns a single matching + remarks: '' + isDeprecated: false + syntax: + content: >- + function getBaseAccountInfo(accountFilter: AccountFilter): null | + AccountInfo + parameters: + - id: accountFilter + type: + description: '' + return: + description: '' + type: null | + inheritanceDescription: Inherited From CacheManager.getBaseAccountInfo + - name: getIdToken(AccountInfo, TokenKeys, string, IPerformanceClient, string) + uid: '@azure/msal-node.NodeStorage.getIdToken' + package: '@azure/msal-node' + summary: Retrieve IdTokenEntity from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getIdToken(account: AccountInfo, tokenKeys?: TokenKeys, + targetRealm?: string, performanceClient?: IPerformanceClient, + correlationId?: string): null | IdTokenEntity + parameters: + - id: account + type: + description: '{AccountInfo}' + - id: tokenKeys + type: + description: '{?TokenKeys}' + - id: targetRealm + type: string + description: '{?string}' + - id: performanceClient + type: + description: '{?IPerformanceClient}' + - id: correlationId + type: string + description: '{?string}' + return: + description: '' + type: null | + inheritanceDescription: Inherited From CacheManager.getIdToken + - name: getIdTokensByFilter(CredentialFilter, TokenKeys) + uid: '@azure/msal-node.NodeStorage.getIdTokensByFilter' + package: '@azure/msal-node' + summary: Gets all idTokens matching the given filter + remarks: '' + isDeprecated: false + syntax: + content: >- + function getIdTokensByFilter(filter: CredentialFilter, tokenKeys?: + TokenKeys): Map + parameters: + - id: filter + type: + description: '' + - id: tokenKeys + type: + description: '' + return: + description: '' + type: Map<string, > + inheritanceDescription: Inherited From CacheManager.getIdTokensByFilter + - name: >- + getRefreshToken(AccountInfo, boolean, TokenKeys, IPerformanceClient, + string) + uid: '@azure/msal-node.NodeStorage.getRefreshToken' + package: '@azure/msal-node' + summary: Helper to retrieve the appropriate refresh token from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getRefreshToken(account: AccountInfo, familyRT: boolean, + tokenKeys?: TokenKeys, performanceClient?: IPerformanceClient, + correlationId?: string): null | RefreshTokenEntity + parameters: + - id: account + type: + description: '{AccountInfo}' + - id: familyRT + type: boolean + description: '{boolean}' + - id: tokenKeys + type: + description: '{?TokenKeys}' + - id: performanceClient + type: + description: '{?IPerformanceClient}' + - id: correlationId + type: string + description: '{?string}' + return: + description: '' + type: null | + inheritanceDescription: Inherited From CacheManager.getRefreshToken + - name: idTokenKeyMatchesFilter(string, CredentialFilter) + uid: '@azure/msal-node.NodeStorage.idTokenKeyMatchesFilter' + package: '@azure/msal-node' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function idTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.idTokenKeyMatchesFilter + - name: isAccountKey(string, string, string) + uid: '@azure/msal-node.NodeStorage.isAccountKey' + package: '@azure/msal-node' + summary: >- + Returns true if the given key matches our account key schema. Also matches + homeAccountId and/or tenantId if provided + remarks: '' + isDeprecated: false + syntax: + content: >- + function isAccountKey(key: string, homeAccountId?: string, tenantId?: + string): boolean + parameters: + - id: key + type: string + description: '' + - id: homeAccountId + type: string + description: '' + - id: tenantId + type: string + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.isAccountKey + - name: isAppMetadataFOCI(string) + uid: '@azure/msal-node.NodeStorage.isAppMetadataFOCI' + package: '@azure/msal-node' + summary: Return the family_id value associated with FOCI + remarks: '' + isDeprecated: false + syntax: + content: 'function isAppMetadataFOCI(environment: string): boolean' + parameters: + - id: environment + type: string + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.isAppMetadataFOCI + - name: isCredentialKey(string) + uid: '@azure/msal-node.NodeStorage.isCredentialKey' + package: '@azure/msal-node' + summary: Returns true if the given key matches our credential key schema. + remarks: '' + isDeprecated: false + syntax: + content: 'function isCredentialKey(key: string): boolean' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.isCredentialKey + - name: readAccountFromCache(AccountInfo) + uid: '@azure/msal-node.NodeStorage.readAccountFromCache' + package: '@azure/msal-node' + summary: Retrieve AccountEntity from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function readAccountFromCache(account: AccountInfo): null | + AccountEntity + parameters: + - id: account + type: + description: '' + return: + description: '' + type: null | + inheritanceDescription: Inherited From CacheManager.readAccountFromCache + - name: readAppMetadataFromCache(string) + uid: '@azure/msal-node.NodeStorage.readAppMetadataFromCache' + package: '@azure/msal-node' + summary: Retrieve AppMetadataEntity from cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function readAppMetadataFromCache(environment: string): null | + AppMetadataEntity + parameters: + - id: environment + type: string + description: '' + return: + description: '' + type: null | + inheritanceDescription: Inherited From CacheManager.readAppMetadataFromCache + - name: refreshTokenKeyMatchesFilter(string, CredentialFilter) + uid: '@azure/msal-node.NodeStorage.refreshTokenKeyMatchesFilter' + package: '@azure/msal-node' + summary: >- + Validate the cache key against filter before retrieving and parsing cache + value + remarks: '' + isDeprecated: false + syntax: + content: >- + function refreshTokenKeyMatchesFilter(inputKey: string, filter: + CredentialFilter): boolean + parameters: + - id: inputKey + type: string + description: '' + - id: filter + type: + description: '' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.refreshTokenKeyMatchesFilter + - name: removeAccessToken(string) + uid: '@azure/msal-node.NodeStorage.removeAccessToken' + package: '@azure/msal-node' + summary: returns a boolean if the given credential is removed + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAccessToken(key: string): Promise' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From CacheManager.removeAccessToken + - name: removeAccount(string) + uid: '@azure/msal-node.NodeStorage.removeAccount' + package: '@azure/msal-node' + summary: Removes the account and related tokens for a given account key + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAccount(accountKey: string): Promise' + parameters: + - id: accountKey + type: string + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From CacheManager.removeAccount + - name: removeAccountContext(AccountEntity) + uid: '@azure/msal-node.NodeStorage.removeAccountContext' + package: '@azure/msal-node' + summary: Removes credentials associated with the provided account + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAccountContext(account: AccountEntity): Promise' + parameters: + - id: account + type: + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From CacheManager.removeAccountContext + - name: removeAllAccounts() + uid: '@azure/msal-node.NodeStorage.removeAllAccounts' + package: '@azure/msal-node' + summary: Removes all accounts and related tokens from cache. + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAllAccounts(): Promise' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From CacheManager.removeAllAccounts + - name: removeAppMetadata() + uid: '@azure/msal-node.NodeStorage.removeAppMetadata' + package: '@azure/msal-node' + summary: Removes all app metadata objects from cache. + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAppMetadata(): boolean' + return: + description: '' + type: boolean + inheritanceDescription: Inherited From CacheManager.removeAppMetadata + - name: removeIdToken(string) + uid: '@azure/msal-node.NodeStorage.removeIdToken' + package: '@azure/msal-node' + summary: Removes idToken from the cache + remarks: '' + isDeprecated: false + syntax: + content: 'function removeIdToken(key: string)' + parameters: + - id: key + type: string + description: '' + inheritanceDescription: Inherited From CacheManager.removeIdToken + - name: removeRefreshToken(string) + uid: '@azure/msal-node.NodeStorage.removeRefreshToken' + package: '@azure/msal-node' + summary: Removes refresh token from the cache + remarks: '' + isDeprecated: false + syntax: + content: 'function removeRefreshToken(key: string)' + parameters: + - id: key + type: string + description: '' + inheritanceDescription: Inherited From CacheManager.removeRefreshToken + - name: saveCacheRecord(CacheRecord, StoreInCache, string) + uid: '@azure/msal-node.NodeStorage.saveCacheRecord' + package: '@azure/msal-node' + summary: saves a cache record + remarks: '' + isDeprecated: false + syntax: + content: >- + function saveCacheRecord(cacheRecord: CacheRecord, storeInCache?: + StoreInCache, correlationId?: string): Promise + parameters: + - id: cacheRecord + type: + description: '{CacheRecord}' + - id: storeInCache + type: + description: '{?StoreInCache}' + - id: correlationId + type: string + description: '{?string} correlation id' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From CacheManager.saveCacheRecord + - name: toObject(T, object) + uid: '@azure/msal-node.NodeStorage.toObject' + package: '@azure/msal-node' + summary: Helper to convert serialized data to object + remarks: '' + isDeprecated: false + syntax: + content: 'static function toObject(obj: T, json: object): T' + parameters: + - id: obj + type: T + description: '' + - id: json + type: object + description: '' + return: + description: '' + type: T + inheritanceDescription: Inherited From CacheManager.toObject +methods: + - name: cacheToInMemoryCache(CacheKVStore) + uid: '@azure/msal-node.NodeStorage.cacheToInMemoryCache' + package: '@azure/msal-node' + summary: Converts cacheKVStore to InMemoryCache + remarks: '' + isDeprecated: false + syntax: + content: 'function cacheToInMemoryCache(cache: CacheKVStore): InMemoryCache' + parameters: + - id: cache + type: + description: key value store + return: + description: '' + type: + - name: clear() + uid: '@azure/msal-node.NodeStorage.clear' + package: '@azure/msal-node' + summary: Clears all cache entries created by MSAL (except tokens). + remarks: '' + isDeprecated: false + syntax: + content: 'function clear(): Promise' + return: + description: '' + type: Promise<void> + - name: containsKey(string) + uid: '@azure/msal-node.NodeStorage.containsKey' + package: '@azure/msal-node' + summary: Checks whether key is in cache. + remarks: '' + isDeprecated: false + syntax: + content: 'function containsKey(key: string): boolean' + parameters: + - id: key + type: string + description: look up key for a cache entity + return: + description: '' + type: boolean + - name: emitChange() + uid: '@azure/msal-node.NodeStorage.emitChange' + package: '@azure/msal-node' + summary: Invoke the callback when cache changes + remarks: '' + isDeprecated: false + syntax: + content: function emitChange() + - name: generateInMemoryCache(string) + uid: '@azure/msal-node.NodeStorage.generateInMemoryCache' + package: '@azure/msal-node' + summary: Initialize in memory cache from an exisiting cache vault + remarks: '' + isDeprecated: false + syntax: + content: 'static function generateInMemoryCache(cache: string): InMemoryCache' + parameters: + - id: cache + type: string + description: blob formatted cache (JSON) + return: + description: '' + type: + - name: generateJsonCache(InMemoryCache) + uid: '@azure/msal-node.NodeStorage.generateJsonCache' + package: '@azure/msal-node' + summary: retrieves the final JSON + remarks: '' + isDeprecated: false + syntax: + content: >- + static function generateJsonCache(inMemoryCache: InMemoryCache): + JsonCache + parameters: + - id: inMemoryCache + type: + description: itemised cache read from the JSON + return: + description: '' + type: + - name: getAccessTokenCredential(string) + uid: '@azure/msal-node.NodeStorage.getAccessTokenCredential' + package: '@azure/msal-node' + summary: fetch the accessToken credential + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccessTokenCredential(accessTokenKey: string): null | + AccessTokenEntity + parameters: + - id: accessTokenKey + type: string + description: lookup key to fetch cache type AccessTokenEntity + return: + description: '' + type: null | + - name: getAccount(string) + uid: '@azure/msal-node.NodeStorage.getAccount' + package: '@azure/msal-node' + summary: fetch the account entity + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccount(accountKey: string): null | AccountEntity' + parameters: + - id: accountKey + type: string + description: lookup key to fetch cache type AccountEntity + return: + description: '' + type: null | + - name: getAccountKeys() + uid: '@azure/msal-node.NodeStorage.getAccountKeys' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccountKeys(): string[]' + return: + description: '' + type: string[] + - name: getAppMetadata(string) + uid: '@azure/msal-node.NodeStorage.getAppMetadata' + package: '@azure/msal-node' + summary: fetch appMetadata entity from the platform cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAppMetadata(appMetadataKey: string): null | + AppMetadataEntity + parameters: + - id: appMetadataKey + type: string + description: lookup key to fetch cache type AppMetadataEntity + return: + description: '' + type: null | + - name: getAuthorityMetadata(string) + uid: '@azure/msal-node.NodeStorage.getAuthorityMetadata' + package: '@azure/msal-node' + summary: fetch authority metadata entity from the platform cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAuthorityMetadata(key: string): null | + AuthorityMetadataEntity + parameters: + - id: key + type: string + description: lookup key to fetch cache type AuthorityMetadataEntity + return: + description: '' + type: null | + - name: getAuthorityMetadataKeys() + uid: '@azure/msal-node.NodeStorage.getAuthorityMetadataKeys' + package: '@azure/msal-node' + summary: Get all authority metadata keys + remarks: '' + isDeprecated: false + syntax: + content: 'function getAuthorityMetadataKeys(): string[]' + return: + description: '' + type: string[] + - name: getCache() + uid: '@azure/msal-node.NodeStorage.getCache' + package: '@azure/msal-node' + summary: get the current cache key-value store + remarks: '' + isDeprecated: false + syntax: + content: 'function getCache(): CacheKVStore' + return: + description: '' + type: + - name: getCachedAccountEntity(string) + uid: '@azure/msal-node.NodeStorage.getCachedAccountEntity' + package: '@azure/msal-node' + summary: Reads account from cache, builds it into an account entity and returns it. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getCachedAccountEntity(accountKey: string): null | + AccountEntity + parameters: + - id: accountKey + type: string + description: '' + return: + description: '' + type: null | + - name: getIdTokenCredential(string) + uid: '@azure/msal-node.NodeStorage.getIdTokenCredential' + package: '@azure/msal-node' + summary: fetch the idToken credential + remarks: '' + isDeprecated: false + syntax: + content: 'function getIdTokenCredential(idTokenKey: string): null | IdTokenEntity' + parameters: + - id: idTokenKey + type: string + description: lookup key to fetch cache type IdTokenEntity + return: + description: '' + type: null | + - name: getInMemoryCache() + uid: '@azure/msal-node.NodeStorage.getInMemoryCache' + package: '@azure/msal-node' + summary: gets the current in memory cache for the client + remarks: '' + isDeprecated: false + syntax: + content: 'function getInMemoryCache(): InMemoryCache' + return: + description: '' + type: + - name: getItem(string) + uid: '@azure/msal-node.NodeStorage.getItem' + package: '@azure/msal-node' + summary: Gets cache item with given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function getItem(key: string): ValidCacheType' + parameters: + - id: key + type: string + description: lookup key for the cache entry + return: + description: '' + type: + - name: getKeys() + uid: '@azure/msal-node.NodeStorage.getKeys' + package: '@azure/msal-node' + summary: Gets all keys in window. + remarks: '' + isDeprecated: false + syntax: + content: 'function getKeys(): string[]' + return: + description: '' + type: string[] + - name: getRefreshTokenCredential(string) + uid: '@azure/msal-node.NodeStorage.getRefreshTokenCredential' + package: '@azure/msal-node' + summary: fetch the refreshToken credential + remarks: '' + isDeprecated: false + syntax: + content: >- + function getRefreshTokenCredential(refreshTokenKey: string): null | + RefreshTokenEntity + parameters: + - id: refreshTokenKey + type: string + description: lookup key to fetch cache type RefreshTokenEntity + return: + description: '' + type: null | + - name: getServerTelemetry(string) + uid: '@azure/msal-node.NodeStorage.getServerTelemetry' + package: '@azure/msal-node' + summary: fetch server telemetry entity from the platform cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getServerTelemetry(serverTelemetrykey: string): null | + ServerTelemetryEntity + parameters: + - id: serverTelemetrykey + type: string + description: lookup key to fetch cache type ServerTelemetryEntity + return: + description: '' + type: null | + - name: getThrottlingCache(string) + uid: '@azure/msal-node.NodeStorage.getThrottlingCache' + package: '@azure/msal-node' + summary: fetch throttling entity from the platform cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function getThrottlingCache(throttlingCacheKey: string): null | + ThrottlingEntity + parameters: + - id: throttlingCacheKey + type: string + description: lookup key to fetch cache type ThrottlingEntity + return: + description: '' + type: null | + - name: getTokenKeys() + uid: '@azure/msal-node.NodeStorage.getTokenKeys' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenKeys(): TokenKeys' + return: + description: '' + type: + - name: inMemoryCacheToCache(InMemoryCache) + uid: '@azure/msal-node.NodeStorage.inMemoryCacheToCache' + package: '@azure/msal-node' + summary: converts inMemoryCache to CacheKVStore + remarks: '' + isDeprecated: false + syntax: + content: >- + function inMemoryCacheToCache(inMemoryCache: InMemoryCache): + CacheKVStore + parameters: + - id: inMemoryCache + type: + description: kvstore map for inmemory + return: + description: '' + type: + - name: registerChangeEmitter(() => void) + uid: '@azure/msal-node.NodeStorage.registerChangeEmitter' + package: '@azure/msal-node' + summary: Queue up callbacks + remarks: '' + isDeprecated: false + syntax: + content: 'function registerChangeEmitter(func: () => void)' + parameters: + - id: func + type: () => void + description: a callback function for cache change indication + - name: removeItem(string) + uid: '@azure/msal-node.NodeStorage.removeItem' + package: '@azure/msal-node' + summary: Removes the cache item from memory with the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function removeItem(key: string): boolean' + parameters: + - id: key + type: string + description: lookup key to remove a cache entity + return: + description: '' + type: boolean + - name: removeOutdatedAccount(string) + uid: '@azure/msal-node.NodeStorage.removeOutdatedAccount' + package: '@azure/msal-node' + summary: Remove account entity from the platform cache if it's outdated + remarks: '' + isDeprecated: false + syntax: + content: 'function removeOutdatedAccount(accountKey: string)' + parameters: + - id: accountKey + type: string + description: '' + - name: setAccessTokenCredential(AccessTokenEntity) + uid: '@azure/msal-node.NodeStorage.setAccessTokenCredential' + package: '@azure/msal-node' + summary: set accessToken credential + remarks: '' + isDeprecated: false + syntax: + content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' + parameters: + - id: accessToken + type: + description: cache value to be set of type AccessTokenEntity + - name: setAccount(AccountEntity) + uid: '@azure/msal-node.NodeStorage.setAccount' + package: '@azure/msal-node' + summary: set account entity + remarks: '' + isDeprecated: false + syntax: + content: 'function setAccount(account: AccountEntity)' + parameters: + - id: account + type: + description: cache value to be set of type AccountEntity + - name: setAppMetadata(AppMetadataEntity) + uid: '@azure/msal-node.NodeStorage.setAppMetadata' + package: '@azure/msal-node' + summary: set appMetadata entity to the platform cache + remarks: '' + isDeprecated: false + syntax: + content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' + parameters: + - id: appMetadata + type: + description: cache value to be set of type AppMetadataEntity + - name: setAuthorityMetadata(string, AuthorityMetadataEntity) + uid: '@azure/msal-node.NodeStorage.setAuthorityMetadata' + package: '@azure/msal-node' + summary: set authority metadata entity to the platform cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function setAuthorityMetadata(key: string, metadata: + AuthorityMetadataEntity) + parameters: + - id: key + type: string + description: lookup key to fetch cache type AuthorityMetadataEntity + - id: metadata + type: + description: cache value to be set of type AuthorityMetadataEntity + - name: setCache(CacheKVStore) + uid: '@azure/msal-node.NodeStorage.setCache' + package: '@azure/msal-node' + summary: sets the current cache (key value store) + remarks: '' + isDeprecated: false + syntax: + content: 'function setCache(cache: CacheKVStore)' + parameters: + - id: cache + type: + description: '' + - name: setIdTokenCredential(IdTokenEntity) + uid: '@azure/msal-node.NodeStorage.setIdTokenCredential' + package: '@azure/msal-node' + summary: set idToken credential + remarks: '' + isDeprecated: false + syntax: + content: 'function setIdTokenCredential(idToken: IdTokenEntity)' + parameters: + - id: idToken + type: + description: cache value to be set of type IdTokenEntity + - name: setInMemoryCache(InMemoryCache) + uid: '@azure/msal-node.NodeStorage.setInMemoryCache' + package: '@azure/msal-node' + summary: sets the current in memory cache for the client + remarks: '' + isDeprecated: false + syntax: + content: 'function setInMemoryCache(inMemoryCache: InMemoryCache)' + parameters: + - id: inMemoryCache + type: + description: key value map in memory + - name: setItem(string, ValidCacheType) + uid: '@azure/msal-node.NodeStorage.setItem' + package: '@azure/msal-node' + summary: Gets cache item with given key-value + remarks: '' + isDeprecated: false + syntax: + content: 'function setItem(key: string, value: ValidCacheType)' + parameters: + - id: key + type: string + description: lookup key for the cache entry + - id: value + type: + description: value of the cache entry + - name: setRefreshTokenCredential(RefreshTokenEntity) + uid: '@azure/msal-node.NodeStorage.setRefreshTokenCredential' + package: '@azure/msal-node' + summary: set refreshToken credential + remarks: '' + isDeprecated: false + syntax: + content: 'function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)' + parameters: + - id: refreshToken + type: + description: cache value to be set of type RefreshTokenEntity + - name: setServerTelemetry(string, ServerTelemetryEntity) + uid: '@azure/msal-node.NodeStorage.setServerTelemetry' + package: '@azure/msal-node' + summary: set server telemetry entity to the platform cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function setServerTelemetry(serverTelemetryKey: string, serverTelemetry: + ServerTelemetryEntity) + parameters: + - id: serverTelemetryKey + type: string + description: lookup key to fetch cache type ServerTelemetryEntity + - id: serverTelemetry + type: + description: cache value to be set of type ServerTelemetryEntity + - name: setThrottlingCache(string, ThrottlingEntity) + uid: '@azure/msal-node.NodeStorage.setThrottlingCache' + package: '@azure/msal-node' + summary: set throttling entity to the platform cache + remarks: '' + isDeprecated: false + syntax: + content: >- + function setThrottlingCache(throttlingCacheKey: string, throttlingCache: + ThrottlingEntity) + parameters: + - id: throttlingCacheKey + type: string + description: lookup key to fetch cache type ThrottlingEntity + - id: throttlingCache + type: + description: cache value to be set of type ThrottlingEntity + - name: updateCredentialCacheKey(string, ValidCredentialType) + uid: '@azure/msal-node.NodeStorage.updateCredentialCacheKey' + package: '@azure/msal-node' + summary: Updates a credential's cache key if the current cache key is outdated + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateCredentialCacheKey(currentCacheKey: string, credential: + ValidCredentialType): string + parameters: + - id: currentCacheKey + type: string + description: '' + - id: credential + type: + description: '' + return: + description: '' + type: string +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml new file mode 100644 index 0000000..c34159e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml @@ -0,0 +1,24 @@ +### YamlMime:TSTypeAlias +name: NodeSystemOptions +uid: '@azure/msal-node.NodeSystemOptions' +package: '@azure/msal-node' +summary: >- + Type for configuring logger and http client options + + + - logger - Used to initialize the Logger object; TODO: + Expand on logger details or link to the documentation on logger + + - networkClient - Http client used for all http get and post + calls. Defaults to using MSAL's default http client. +fullName: NodeSystemOptions +remarks: '' +isDeprecated: false +syntax: | + type NodeSystemOptions = { + customAgentOptions?: http.AgentOptions | https.AgentOptions + disableInternalRetries?: boolean + loggerOptions?: LoggerOptions + networkClient?: INetworkModule + proxyUrl?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeTelemetryOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeTelemetryOptions.yml new file mode 100644 index 0000000..b3baed5 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeTelemetryOptions.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: NodeTelemetryOptions +uid: '@azure/msal-node.NodeTelemetryOptions' +package: '@azure/msal-node' +summary: '' +fullName: NodeTelemetryOptions +remarks: '' +isDeprecated: false +syntax: | + type NodeTelemetryOptions = { application?: ApplicationTelemetry } diff --git a/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml b/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml new file mode 100644 index 0000000..d4d335c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml @@ -0,0 +1,110 @@ +### YamlMime:TSType +name: OnBehalfOfClient +uid: '@azure/msal-node.OnBehalfOfClient' +package: '@azure/msal-node' +summary: On-Behalf-Of client +fullName: OnBehalfOfClient +remarks: '' +isDeprecated: false +type: class +constructors: + - name: OnBehalfOfClient(ClientConfiguration) + uid: '@azure/msal-node.OnBehalfOfClient.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new OnBehalfOfClient(configuration: ClientConfiguration)' + parameters: + - id: configuration + type: + description: '' +inheritedProperties: + - name: authority + uid: '@azure/msal-node.OnBehalfOfClient.authority' + package: '@azure/msal-node' + summary: '' + fullName: authority + remarks: '' + isDeprecated: false + syntax: + content: 'authority: Authority' + return: + description: '' + type: + inheritanceDescription: Inherited From BaseClient.authority + - name: logger + uid: '@azure/msal-node.OnBehalfOfClient.logger' + package: '@azure/msal-node' + summary: '' + fullName: logger + remarks: '' + isDeprecated: false + syntax: + content: 'logger: Logger' + return: + description: '' + type: + inheritanceDescription: Inherited From BaseClient.logger +inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-node.OnBehalfOfClient.createTokenQueryParameters' + package: '@azure/msal-node' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseClient.createTokenQueryParameters + - name: updateAuthority(string, string) + uid: '@azure/msal-node.OnBehalfOfClient.updateAuthority' + package: '@azure/msal-node' + summary: >- + Updates the authority object of the client. Endpoint discovery must be + completed. + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateAuthority(cloudInstanceHostname: string, correlationId: + string): Promise + parameters: + - id: cloudInstanceHostname + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseClient.updateAuthority +methods: + - name: acquireToken(CommonOnBehalfOfRequest) + uid: '@azure/msal-node.OnBehalfOfClient.acquireToken' + package: '@azure/msal-node' + summary: Public API to acquire tokens with on behalf of flow + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireToken(request: CommonOnBehalfOfRequest): Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfRequest.yml new file mode 100644 index 0000000..8512e7e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfRequest.yml @@ -0,0 +1,37 @@ +### YamlMime:TSTypeAlias +name: OnBehalfOfRequest +uid: '@azure/msal-node.OnBehalfOfRequest' +package: '@azure/msal-node' +summary: >- + - 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. + + - oboAssertion - The access token that was sent to the middle-tier + API. This token must have an audience of the app making this OBO request. + + - skipCache - Skip token cache lookup and force request to + authority to get a a new token. Defaults to false. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call +fullName: OnBehalfOfRequest +remarks: '' +isDeprecated: false +syntax: | + type OnBehalfOfRequest = Partial< + Omit< + CommonOnBehalfOfRequest, + | "oboAssertion" + | "scopes" + | "resourceRequestMethod" + | "resourceRequestUri" + | "requestedClaimsHash" + | "storeInCache" + > + > & { oboAssertion: string; scopes: string[] } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ProtocolMode.yml b/msal/docs-ref-autogen/@azure/msal-node/ProtocolMode.yml new file mode 100644 index 0000000..ea5677d --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ProtocolMode.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ProtocolMode +uid: '@azure/msal-node.ProtocolMode' +package: '@azure/msal-node' +summary: '' +fullName: ProtocolMode +remarks: '' +isDeprecated: false +syntax: | + type ProtocolMode = (typeof ProtocolMode)[keyof typeof ProtocolMode] diff --git a/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml new file mode 100644 index 0000000..1b1039a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml @@ -0,0 +1,367 @@ +### YamlMime:TSType +name: PublicClientApplication +uid: '@azure/msal-node.PublicClientApplication' +package: '@azure/msal-node' +summary: >- + This class is to be used to acquire tokens for public client applications + (desktop, mobile). Public client applications + + are not trusted to safely store application secrets, and therefore can only + request tokens in the name of an user. +fullName: PublicClientApplication +remarks: '' +isDeprecated: false +type: class +constructors: + - name: PublicClientApplication(Configuration) + uid: '@azure/msal-node.PublicClientApplication.constructor' + package: '@azure/msal-node' + summary: >- + Important attributes in the Configuration object for auth are: + + - clientID: the application ID of your application. You can obtain one by + registering your application with our Application registration portal. + + - authority: the authority URL for your application. + + + AAD authorities are of the form + https://login.microsoftonline.com/{Enter_the_Tenant_Info_Here}. + + - If your application supports Accounts in one organizational directory, + replace "Enter_the_Tenant_Info_Here" value with the Tenant Id or Tenant + name (for example, contoso.microsoft.com). + + - If your application supports Accounts in any organizational directory, + replace "Enter_the_Tenant_Info_Here" value with organizations. + + - If your application supports Accounts in any organizational directory + and personal Microsoft accounts, replace "Enter_the_Tenant_Info_Here" + value with common. + + - To restrict support to Personal Microsoft accounts only, replace + "Enter_the_Tenant_Info_Here" value with consumers. + + + Azure B2C authorities are of the form + https://{instance}/{tenant}/{policy}. Each policy is considered + + its own authority. You will have to set the all of the knownAuthorities at + the time of the client application + + construction. + + + ADFS authorities are of the form https://{instance}/adfs. + remarks: '' + isDeprecated: false + syntax: + content: 'new PublicClientApplication(configuration: Configuration)' + parameters: + - id: configuration + type: + description: '' +inheritedMethods: + - name: acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload) + uid: '@azure/msal-node.PublicClientApplication.acquireTokenByCode' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the Authorization Code received from the + first step of OAuth2.0 + + Authorization Code flow. + + + `getAuthCodeUrl(AuthorizationCodeUrlRequest)` can be used to create the + URL for the first step of OAuth2.0 + + Authorization Code flow. Ensure that values for redirectUri and scopes in + AuthorizationCodeUrlRequest and + + AuthorizationCodeRequest are the same. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByCode(request: AuthorizationCodeRequest, + authCodePayLoad?: AuthorizationCodePayload): + Promise + parameters: + - id: request + type: + description: '' + - id: authCodePayLoad + type: + description: '' + return: + description: '' + type: Promise<> + inheritanceDescription: >- + Inherited From + [ClientApplication.acquireTokenByCode](xref:@azure/msal-node.ClientApplication.acquireTokenByCode) + - name: acquireTokenByRefreshToken(RefreshTokenRequest) + uid: '@azure/msal-node.PublicClientApplication.acquireTokenByRefreshToken' + package: '@azure/msal-node' + summary: >- + Acquires a token by exchanging the refresh token provided for a new set of + tokens. + + + This API is provided only for scenarios where you would like to migrate + from ADAL to MSAL. Otherwise, it is + + recommended that you use `acquireTokenSilent()` for silent scenarios. When + using `acquireTokenSilent()`, MSAL will + + handle the caching and refreshing of tokens automatically. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByRefreshToken(request: RefreshTokenRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + inheritanceDescription: >- + Inherited From + [ClientApplication.acquireTokenByRefreshToken](xref:@azure/msal-node.ClientApplication.acquireTokenByRefreshToken) + - name: acquireTokenByUsernamePassword(UsernamePasswordRequest) + uid: '@azure/msal-node.PublicClientApplication.acquireTokenByUsernamePassword' + package: '@azure/msal-node' + summary: >- + Acquires tokens with password grant by exchanging client applications + username and password for credentials + + + The latest OAuth 2.0 Security Best Current Practice disallows the password + grant entirely. + + More details on this recommendation at + https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 + + Microsoft's documentation and recommendations are at: + + https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByUsernamePassword(request: + UsernamePasswordRequest): Promise + parameters: + - id: request + type: + description: UsenamePasswordRequest + return: + description: '' + type: >- + Promise<null | > + inheritanceDescription: >- + Inherited From + [ClientApplication.acquireTokenByUsernamePassword](xref:@azure/msal-node.ClientApplication.acquireTokenByUsernamePassword) + - name: clearCache() + uid: '@azure/msal-node.PublicClientApplication.clearCache' + package: '@azure/msal-node' + summary: Clear the cache + remarks: '' + isDeprecated: false + syntax: + content: function clearCache() + inheritanceDescription: >- + Inherited From + [ClientApplication.clearCache](xref:@azure/msal-node.ClientApplication.clearCache) + - name: getAuthCodeUrl(AuthorizationUrlRequest) + uid: '@azure/msal-node.PublicClientApplication.getAuthCodeUrl' + package: '@azure/msal-node' + summary: >- + Creates the URL of the authorization request, letting the user input + credentials and consent to the + + application. The URL targets the /authorize endpoint of the authority + configured in the + + application object. + + + Once the user inputs their credentials and consents, the authority will + send a response to the redirect URI + + sent in the request and should contain an authorization code, which can + then be used to acquire tokens via + + `acquireTokenByCode(AuthorizationCodeRequest)`. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAuthCodeUrl(request: AuthorizationUrlRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<string> + inheritanceDescription: >- + Inherited From + [ClientApplication.getAuthCodeUrl](xref:@azure/msal-node.ClientApplication.getAuthCodeUrl) + - name: getLogger() + uid: '@azure/msal-node.PublicClientApplication.getLogger' + package: '@azure/msal-node' + summary: Returns the logger instance + remarks: '' + isDeprecated: false + syntax: + content: 'function getLogger(): Logger' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ClientApplication.getLogger](xref:@azure/msal-node.ClientApplication.getLogger) + - name: getTokenCache() + uid: '@azure/msal-node.PublicClientApplication.getTokenCache' + package: '@azure/msal-node' + summary: Gets the token cache for the application. + remarks: '' + isDeprecated: false + syntax: + content: 'function getTokenCache(): TokenCache' + return: + description: '' + type: + inheritanceDescription: >- + Inherited From + [ClientApplication.getTokenCache](xref:@azure/msal-node.ClientApplication.getTokenCache) + - name: setLogger(Logger) + uid: '@azure/msal-node.PublicClientApplication.setLogger' + package: '@azure/msal-node' + summary: >- + Replaces the default logger set in configurations with new Logger with new + configurations + remarks: '' + isDeprecated: false + syntax: + content: 'function setLogger(logger: Logger)' + parameters: + - id: logger + type: + description: Logger instance + inheritanceDescription: >- + Inherited From + [ClientApplication.setLogger](xref:@azure/msal-node.ClientApplication.setLogger) +methods: + - name: acquireTokenByDeviceCode(DeviceCodeRequest) + uid: '@azure/msal-node.PublicClientApplication.acquireTokenByDeviceCode' + package: '@azure/msal-node' + summary: >- + Acquires a token from the authority using OAuth2.0 device code flow. + + This flow is designed for devices that do not have access to a browser or + have input constraints. + + The authorization server issues a DeviceCode object with a verification + code, an end-user code, + + and the end-user verification URI. The DeviceCode object is provided + through a callback, and the end-user should be + + instructed to use another device to navigate to the verification URI to + input credentials. + + Since the client cannot receive incoming requests, it polls the + authorization server repeatedly + + until the end-user completes input of credentials. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenByDeviceCode(request: DeviceCodeRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > + - name: acquireTokenInteractive(InteractiveRequest) + uid: '@azure/msal-node.PublicClientApplication.acquireTokenInteractive' + package: '@azure/msal-node' + summary: >- + Acquires a token interactively via the browser by requesting an + authorization code then exchanging it for a token. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenInteractive(request: InteractiveRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: acquireTokenSilent(SilentFlowRequest) + uid: '@azure/msal-node.PublicClientApplication.acquireTokenSilent' + package: '@azure/msal-node' + summary: >- + Returns a token retrieved either from the cache or by exchanging the + refresh token for a fresh access token. If brokering is enabled the token + request will be serviced by the broker. + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenSilent(request: SilentFlowRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<> + - name: getAllAccounts() + uid: '@azure/msal-node.PublicClientApplication.getAllAccounts' + package: '@azure/msal-node' + summary: >- + Returns all cached accounts for this application. If brokering is enabled + this request will be serviced by the broker. + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(): Promise' + return: + description: '' + type: Promise<[]> + - name: signOut(SignOutRequest) + uid: '@azure/msal-node.PublicClientApplication.signOut' + package: '@azure/msal-node' + summary: Removes cache artifacts associated with the given account + remarks: '' + isDeprecated: false + syntax: + content: 'function signOut(request: SignOutRequest): Promise' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: Promise<void> +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/RefreshTokenRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/RefreshTokenRequest.yml new file mode 100644 index 0000000..eb35667 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/RefreshTokenRequest.yml @@ -0,0 +1,43 @@ +### YamlMime:TSTypeAlias +name: RefreshTokenRequest +uid: '@azure/msal-node.RefreshTokenRequest' +package: '@azure/msal-node' +summary: >- + CommonRefreshTokenRequest + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be added + to all /authorize and /token calls + + - 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. + + - refreshToken - A refresh token returned from a previous request + to the Identity provider. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call + + - forceCache - Force MSAL to cache a refresh token flow response + when there is no account in the cache. Used for migration scenarios. +fullName: RefreshTokenRequest +remarks: '' +isDeprecated: false +syntax: | + type RefreshTokenRequest = Partial< + Omit< + CommonRefreshTokenRequest, + | "scopes" + | "refreshToken" + | "authenticationScheme" + | "resourceRequestMethod" + | "resourceRequestUri" + | "requestedClaimsHash" + | "storeInCache" + > + > & { forceCache?: boolean; refreshToken: string; scopes: string[] } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ResponseMode.yml b/msal/docs-ref-autogen/@azure/msal-node/ResponseMode.yml new file mode 100644 index 0000000..b745065 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ResponseMode.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ResponseMode +uid: '@azure/msal-node.ResponseMode' +package: '@azure/msal-node' +summary: '' +fullName: ResponseMode +remarks: '' +isDeprecated: false +syntax: | + type ResponseMode = (typeof ResponseMode)[keyof typeof ResponseMode] diff --git a/msal/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml b/msal/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml new file mode 100644 index 0000000..3822f6f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml @@ -0,0 +1,27 @@ +### YamlMime:TSTypeAlias +name: SerializedAccessTokenEntity +uid: '@azure/msal-node.SerializedAccessTokenEntity' +package: '@azure/msal-node' +summary: Access token credential type +fullName: SerializedAccessTokenEntity +remarks: '' +isDeprecated: false +syntax: | + type SerializedAccessTokenEntity = { + cached_at: string + client_id: string + credential_type: string + environment: string + expires_on: string + extended_expires_on?: string + home_account_id: string + key_id?: string + realm: string + refresh_on?: string + requestedClaims?: string + requestedClaimsHash?: string + secret: string + target: string + token_type?: string + userAssertionHash?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml b/msal/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml new file mode 100644 index 0000000..defecdf --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml @@ -0,0 +1,22 @@ +### YamlMime:TSTypeAlias +name: SerializedAccountEntity +uid: '@azure/msal-node.SerializedAccountEntity' +package: '@azure/msal-node' +summary: Account type +fullName: SerializedAccountEntity +remarks: '' +isDeprecated: false +syntax: | + type SerializedAccountEntity = { + authority_type: string + client_info?: string + environment: string + home_account_id: string + last_modification_app?: string + last_modification_time?: string + local_account_id: string + name?: string + realm: string + tenantProfiles?: string[] + username: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml b/msal/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml new file mode 100644 index 0000000..8a2b612 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml @@ -0,0 +1,14 @@ +### YamlMime:TSTypeAlias +name: SerializedAppMetadataEntity +uid: '@azure/msal-node.SerializedAppMetadataEntity' +package: '@azure/msal-node' +summary: AppMetadata type +fullName: SerializedAppMetadataEntity +remarks: '' +isDeprecated: false +syntax: | + type SerializedAppMetadataEntity = { + client_id: string + environment: string + family_id?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml b/msal/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml new file mode 100644 index 0000000..928aefc --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: SerializedIdTokenEntity +uid: '@azure/msal-node.SerializedIdTokenEntity' +package: '@azure/msal-node' +summary: Idtoken credential type +fullName: SerializedIdTokenEntity +remarks: '' +isDeprecated: false +syntax: | + type SerializedIdTokenEntity = { + client_id: string + credential_type: string + environment: string + home_account_id: string + realm: string + secret: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml b/msal/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml new file mode 100644 index 0000000..e7bb552 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml @@ -0,0 +1,19 @@ +### YamlMime:TSTypeAlias +name: SerializedRefreshTokenEntity +uid: '@azure/msal-node.SerializedRefreshTokenEntity' +package: '@azure/msal-node' +summary: Refresh token credential type +fullName: SerializedRefreshTokenEntity +remarks: '' +isDeprecated: false +syntax: | + type SerializedRefreshTokenEntity = { + client_id: string + credential_type: string + environment: string + family_id?: string + home_account_id: string + realm?: string + secret: string + target?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml new file mode 100644 index 0000000..ee65229 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml @@ -0,0 +1,32 @@ +### YamlMime:TSTypeAlias +name: ServerAuthorizationCodeResponse +uid: '@azure/msal-node.ServerAuthorizationCodeResponse' +package: '@azure/msal-node' +summary: |- + Deserialized response object from server authorization code request. + - code: authorization code from server + - client_info: client info object + - state: OAuth2 request state + - error: error sent back in hash + - error: description +fullName: ServerAuthorizationCodeResponse +remarks: '' +isDeprecated: false +syntax: | + type ServerAuthorizationCodeResponse = { + accountId?: string + claims?: string + client_info?: string + cloud_graph_host_name?: string + cloud_instance_host_name?: string + cloud_instance_name?: string + code?: string + correlation_id?: string + error?: string + error_description?: string + msgraph_host?: string + state?: string + suberror?: string + timestamp?: string + trace_id?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml new file mode 100644 index 0000000..b4232ba --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml @@ -0,0 +1,208 @@ +### YamlMime:TSType +name: ServerError +uid: '@azure/msal-node.ServerError' +package: '@azure/msal-node' +summary: >- + Error thrown when there is an error with the server code, for example, + unavailability. +fullName: ServerError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: ServerError(string, string, string) + uid: '@azure/msal-node.ServerError.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ServerError(errorCode?: string, errorMessage?: string, subError?: + string) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: subError + type: string + description: '' +inheritedProperties: + - name: correlationId + uid: '@azure/msal-node.ServerError.correlationId' + package: '@azure/msal-node' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-node.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-node.ServerError.errorCode' + package: '@azure/msal-node' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-node.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-node.ServerError.errorMessage' + package: '@azure/msal-node' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-node.AuthError.errorMessage) + - name: message + uid: '@azure/msal-node.ServerError.message' + package: '@azure/msal-node' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-node.AuthError.message) + - name: name + uid: '@azure/msal-node.ServerError.name' + package: '@azure/msal-node' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-node.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-node.ServerError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-node.ServerError.stack' + package: '@azure/msal-node' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-node.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-node.ServerError.stackTraceLimit' + package: '@azure/msal-node' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-node.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-node.ServerError.subError' + package: '@azure/msal-node' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-node.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-node.ServerError.captureStackTrace' + package: '@azure/msal-node' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-node.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-node.ServerError.setCorrelationId' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-node.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/SignOutRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/SignOutRequest.yml new file mode 100644 index 0000000..7847a71 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/SignOutRequest.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: SignOutRequest +uid: '@azure/msal-node.SignOutRequest' +package: '@azure/msal-node' +summary: '' +fullName: SignOutRequest +remarks: '' +isDeprecated: false +syntax: | + type SignOutRequest = { account: AccountInfo; correlationId?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml new file mode 100644 index 0000000..b8fba55 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml @@ -0,0 +1,42 @@ +### YamlMime:TSTypeAlias +name: SilentFlowRequest +uid: '@azure/msal-node.SilentFlowRequest' +package: '@azure/msal-node' +summary: >- + SilentFlow parameters passed by the user to retrieve credentials silently + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be added to + all /authorize and /token calls. When included on a silent request, cache + lookup will be skipped and token will be refreshed. + + - authority - Url of the authority which the application acquires + tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call + + - account - Account entity to lookup the credentials. + + - forceRefresh - Forces silent requests to make network calls if + true. +fullName: SilentFlowRequest +remarks: '' +isDeprecated: false +syntax: | + type SilentFlowRequest = Partial< + Omit< + CommonSilentFlowRequest, + | "account" + | "scopes" + | "resourceRequestMethod" + | "resourceRequestUri" + | "requestedClaimsHash" + | "storeInCache" + > + > & { account: AccountInfo; scopes: string[] } diff --git a/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml b/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml new file mode 100644 index 0000000..63369a0 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml @@ -0,0 +1,148 @@ +### YamlMime:TSType +name: TokenCache +uid: '@azure/msal-node.TokenCache' +package: '@azure/msal-node' +summary: In-memory token cache manager +fullName: TokenCache +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TokenCache(NodeStorage, Logger, ICachePlugin) + uid: '@azure/msal-node.TokenCache.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new TokenCache(storage: NodeStorage, logger: Logger, cachePlugin?: + ICachePlugin) + parameters: + - id: storage + type: + description: '' + - id: logger + type: + description: '' + - id: cachePlugin + type: + description: '' +methods: + - name: deserialize(string) + uid: '@azure/msal-node.TokenCache.deserialize' + package: '@azure/msal-node' + summary: >- + Deserializes JSON to in-memory cache. JSON should be in MSAL cache schema + format + remarks: '' + isDeprecated: false + syntax: + content: 'function deserialize(cache: string)' + parameters: + - id: cache + type: string + description: blob formatted cache + - name: getAccountByHomeId(string) + uid: '@azure/msal-node.TokenCache.getAccountByHomeId' + package: '@azure/msal-node' + summary: |- + Returns the signed in account matching homeAccountId. + (the account object is created at the time of successful login) + or null when no matching account is found + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountByHomeId(homeAccountId: string): Promise + parameters: + - id: homeAccountId + type: string + description: unique identifier for an account (uid.utid) + return: + description: '' + type: Promise<null | > + - name: getAccountByLocalId(string) + uid: '@azure/msal-node.TokenCache.getAccountByLocalId' + package: '@azure/msal-node' + summary: |- + Returns the signed in account matching localAccountId. + (the account object is created at the time of successful login) + or null when no matching account is found + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAccountByLocalId(localAccountId: string): Promise + parameters: + - id: localAccountId + type: string + description: >- + unique identifier of an account (sub/obj when homeAccountId cannot + be populated) + return: + description: '' + type: Promise<null | > + - name: getAllAccounts() + uid: '@azure/msal-node.TokenCache.getAllAccounts' + package: '@azure/msal-node' + summary: API that retrieves all accounts currently in cache to the user + remarks: '' + isDeprecated: false + syntax: + content: 'function getAllAccounts(): Promise' + return: + description: '' + type: Promise<[]> + - name: getKVStore() + uid: '@azure/msal-node.TokenCache.getKVStore' + package: '@azure/msal-node' + summary: Fetches the cache key-value map + remarks: '' + isDeprecated: false + syntax: + content: 'function getKVStore(): CacheKVStore' + return: + description: '' + type: + - name: hasChanged() + uid: '@azure/msal-node.TokenCache.hasChanged' + package: '@azure/msal-node' + summary: >- + Set to true if cache state has changed since last time serialize or + writeToPersistence was called + remarks: '' + isDeprecated: false + syntax: + content: 'function hasChanged(): boolean' + return: + description: '' + type: boolean + - name: removeAccount(AccountInfo) + uid: '@azure/msal-node.TokenCache.removeAccount' + package: '@azure/msal-node' + summary: API to remove a specific account and the relevant data from cache + remarks: '' + isDeprecated: false + syntax: + content: 'function removeAccount(account: AccountInfo): Promise' + parameters: + - id: account + type: + description: AccountInfo passed by the user + return: + description: '' + type: Promise<void> + - name: serialize() + uid: '@azure/msal-node.TokenCache.serialize' + package: '@azure/msal-node' + summary: Serializes in memory cache to JSON + remarks: '' + isDeprecated: false + syntax: + content: 'function serialize(): string' + return: + description: '' + type: string diff --git a/msal/docs-ref-autogen/@azure/msal-node/TokenCacheContext.yml b/msal/docs-ref-autogen/@azure/msal-node/TokenCacheContext.yml new file mode 100644 index 0000000..7bf7cad --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/TokenCacheContext.yml @@ -0,0 +1,78 @@ +### YamlMime:TSType +name: TokenCacheContext +uid: '@azure/msal-node.TokenCacheContext' +package: '@azure/msal-node' +summary: |- + This class instance helps track the memory changes facilitating + decisions to read from and write to the persistent cache +fullName: TokenCacheContext +remarks: '' +isDeprecated: false +type: class +constructors: + - name: TokenCacheContext(ISerializableTokenCache, boolean) + uid: '@azure/msal-node.TokenCacheContext.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new TokenCacheContext(tokenCache: ISerializableTokenCache, hasChanged: + boolean) + parameters: + - id: tokenCache + type: + description: '' + - id: hasChanged + type: boolean + description: '' +properties: + - name: cache + uid: '@azure/msal-node.TokenCacheContext.cache' + package: '@azure/msal-node' + summary: serializable token cache interface + fullName: cache + remarks: '' + isDeprecated: false + syntax: + content: 'cache: ISerializableTokenCache' + return: + description: '' + type: + - name: cacheHasChanged + uid: '@azure/msal-node.TokenCacheContext.cacheHasChanged' + package: '@azure/msal-node' + summary: boolean which indicates the changes in cache + fullName: cacheHasChanged + remarks: '' + isDeprecated: false + syntax: + content: boolean cacheHasChanged + return: + description: '' + type: boolean + - name: hasChanged + uid: '@azure/msal-node.TokenCacheContext.hasChanged' + package: '@azure/msal-node' + summary: boolean indicating cache change + fullName: hasChanged + remarks: '' + isDeprecated: false + syntax: + content: 'hasChanged: boolean' + return: + description: '' + type: boolean + - name: tokenCache + uid: '@azure/msal-node.TokenCacheContext.tokenCache' + package: '@azure/msal-node' + summary: function to retrieve the token cache + fullName: tokenCache + remarks: '' + isDeprecated: false + syntax: + content: ISerializableTokenCache tokenCache + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml new file mode 100644 index 0000000..f6c5459 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml @@ -0,0 +1,118 @@ +### YamlMime:TSType +name: UsernamePasswordClient +uid: '@azure/msal-node.UsernamePasswordClient' +package: '@azure/msal-node' +summary: >- + Oauth2.0 Password grant client + + Note: We are only supporting public clients for password grant and for purely + testing purposes +fullName: UsernamePasswordClient +remarks: '' +isDeprecated: false +type: class +constructors: + - name: UsernamePasswordClient(ClientConfiguration) + uid: '@azure/msal-node.UsernamePasswordClient.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new UsernamePasswordClient(configuration: ClientConfiguration)' + parameters: + - id: configuration + type: + description: '' +inheritedProperties: + - name: authority + uid: '@azure/msal-node.UsernamePasswordClient.authority' + package: '@azure/msal-node' + summary: '' + fullName: authority + remarks: '' + isDeprecated: false + syntax: + content: 'authority: Authority' + return: + description: '' + type: + inheritanceDescription: Inherited From BaseClient.authority + - name: logger + uid: '@azure/msal-node.UsernamePasswordClient.logger' + package: '@azure/msal-node' + summary: '' + fullName: logger + remarks: '' + isDeprecated: false + syntax: + content: 'logger: Logger' + return: + description: '' + type: + inheritanceDescription: Inherited From BaseClient.logger +inheritedMethods: + - name: createTokenQueryParameters(BaseAuthRequest) + uid: '@azure/msal-node.UsernamePasswordClient.createTokenQueryParameters' + package: '@azure/msal-node' + summary: Creates query string for the /token request + remarks: '' + isDeprecated: false + syntax: + content: 'function createTokenQueryParameters(request: BaseAuthRequest): string' + parameters: + - id: request + type: + description: '' + return: + description: '' + type: string + inheritanceDescription: Inherited From BaseClient.createTokenQueryParameters + - name: updateAuthority(string, string) + uid: '@azure/msal-node.UsernamePasswordClient.updateAuthority' + package: '@azure/msal-node' + summary: >- + Updates the authority object of the client. Endpoint discovery must be + completed. + remarks: '' + isDeprecated: false + syntax: + content: >- + function updateAuthority(cloudInstanceHostname: string, correlationId: + string): Promise + parameters: + - id: cloudInstanceHostname + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<void> + inheritanceDescription: Inherited From BaseClient.updateAuthority +methods: + - name: acquireToken(CommonUsernamePasswordRequest) + uid: '@azure/msal-node.UsernamePasswordClient.acquireToken' + package: '@azure/msal-node' + summary: >- + API to acquire a token by passing the username and password to the service + in exchage of credentials + + password_grant + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireToken(request: CommonUsernamePasswordRequest): + Promise + parameters: + - id: request + type: + description: '' + return: + description: '' + type: >- + Promise<null | > +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml new file mode 100644 index 0000000..97a5811 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml @@ -0,0 +1,46 @@ +### YamlMime:TSTypeAlias +name: UsernamePasswordRequest +uid: '@azure/msal-node.UsernamePasswordRequest' +package: '@azure/msal-node' +summary: >- + UsernamePassword parameters passed by the user to retrieve credentials + + Note: The latest OAuth 2.0 Security Best Current Practice disallows the + password grant entirely. This flow is added for internal testing. + + + - scopes - Array of scopes the application is requesting + access to. + + - claims - A stringified claims request which will be added to + all /authorize and /token calls. When included on a silent request, cache + lookup will be skipped and token will be refreshed. + + - authority - Url of the authority which the application acquires + tokens from. + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. + + - username - username of the client + + - password - credentials + + - tokenQueryParameters - String to string map of custom query parameters + added to the /token call +fullName: UsernamePasswordRequest +remarks: '' +isDeprecated: false +syntax: | + type UsernamePasswordRequest = Partial< + Omit< + CommonUsernamePasswordRequest, + | "scopes" + | "resourceRequestMethod" + | "resourceRequestUri" + | "username" + | "password" + | "requestedClaimsHash" + | "storeInCache" + > + > & { password: string; scopes: string[]; username: string } diff --git a/msal/docs-ref-autogen/@azure/msal-node/index.yml b/msal/docs-ref-autogen/@azure/msal-node/index.yml new file mode 100644 index 0000000..7595489 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/index.yml @@ -0,0 +1,83 @@ +### YamlMime:TSPackage +uid: '@azure/msal-node' +name: '@azure/msal-node' +summary: '' +type: package +classes: + - '@azure/msal-node.internals.Deserializer' + - '@azure/msal-node.internals.Serializer' + - '@azure/msal-node.AuthError' + - '@azure/msal-node.ClientApplication' + - '@azure/msal-node.ClientAssertion' + - '@azure/msal-node.ClientAuthError' + - '@azure/msal-node.ClientConfigurationError' + - '@azure/msal-node.ClientCredentialClient' + - '@azure/msal-node.ConfidentialClientApplication' + - '@azure/msal-node.CryptoProvider' + - '@azure/msal-node.DeviceCodeClient' + - '@azure/msal-node.DistributedCachePlugin' + - '@azure/msal-node.InteractionRequiredAuthError' + - '@azure/msal-node.Logger' + - '@azure/msal-node.ManagedIdentityApplication' + - '@azure/msal-node.NodeStorage' + - '@azure/msal-node.OnBehalfOfClient' + - '@azure/msal-node.PublicClientApplication' + - '@azure/msal-node.ServerError' + - '@azure/msal-node.TokenCache' + - '@azure/msal-node.TokenCacheContext' + - '@azure/msal-node.UsernamePasswordClient' +enums: + - '@azure/msal-node.LogLevel' +interfaces: + - '@azure/msal-node.IAppTokenProvider' + - '@azure/msal-node.ICacheClient' + - '@azure/msal-node.ICachePlugin' + - '@azure/msal-node.IConfidentialClientApplication' + - '@azure/msal-node.ILoopbackClient' + - '@azure/msal-node.INativeBrokerPlugin' + - '@azure/msal-node.INetworkModule' + - '@azure/msal-node.IPartitionManager' + - '@azure/msal-node.IPublicClientApplication' + - '@azure/msal-node.ISerializableTokenCache' + - '@azure/msal-node.ITokenCache' +typeAliases: + - '@azure/msal-node.AccountInfo' + - '@azure/msal-node.AppTokenProviderParameters' + - '@azure/msal-node.AppTokenProviderResult' + - '@azure/msal-node.AuthenticationResult' + - '@azure/msal-node.AuthorizationCodePayload' + - '@azure/msal-node.AuthorizationCodeRequest' + - '@azure/msal-node.AuthorizationUrlRequest' + - '@azure/msal-node.AzureCloudInstance' + - '@azure/msal-node.AzureCloudOptions' + - '@azure/msal-node.BrokerOptions' + - '@azure/msal-node.CacheKVStore' + - '@azure/msal-node.CacheOptions' + - '@azure/msal-node.ClientCredentialRequest' + - '@azure/msal-node.Configuration' + - '@azure/msal-node.DeviceCodeRequest' + - '@azure/msal-node.IdTokenClaims' + - '@azure/msal-node.InMemoryCache' + - '@azure/msal-node.InteractiveRequest' + - '@azure/msal-node.JsonCache' + - '@azure/msal-node.ManagedIdentityConfiguration' + - '@azure/msal-node.ManagedIdentityIdParams' + - '@azure/msal-node.ManagedIdentityRequestParams' + - '@azure/msal-node.NetworkRequestOptions' + - '@azure/msal-node.NetworkResponse' + - '@azure/msal-node.NodeAuthOptions' + - '@azure/msal-node.NodeSystemOptions' + - '@azure/msal-node.NodeTelemetryOptions' + - '@azure/msal-node.OnBehalfOfRequest' + - '@azure/msal-node.ProtocolMode' + - '@azure/msal-node.RefreshTokenRequest' + - '@azure/msal-node.ResponseMode' + - '@azure/msal-node.SerializedAccessTokenEntity' + - '@azure/msal-node.SerializedAccountEntity' + - '@azure/msal-node.SerializedAppMetadataEntity' + - '@azure/msal-node.SerializedIdTokenEntity' + - '@azure/msal-node.SerializedRefreshTokenEntity' + - '@azure/msal-node.ServerAuthorizationCodeResponse' + - '@azure/msal-node.SignOutRequest' + - '@azure/msal-node.SilentFlowRequest' + - '@azure/msal-node.UsernamePasswordRequest' diff --git a/msal/docs-ref-autogen/@azure/msal-node/internals.Deserializer.yml b/msal/docs-ref-autogen/@azure/msal-node/internals.Deserializer.yml new file mode 100644 index 0000000..f053f98 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/internals.Deserializer.yml @@ -0,0 +1,137 @@ +### YamlMime:TSType +name: Deserializer +uid: '@azure/msal-node.internals.Deserializer' +package: '@azure/msal-node' +summary: >- + This class deserializes cache entities read from the file into in memory + object types defined internally +fullName: Deserializer +remarks: '' +isDeprecated: false +type: class +methods: + - name: deserializeAccessTokens(Record) + uid: '@azure/msal-node.internals.Deserializer.deserializeAccessTokens' + package: '@azure/msal-node' + summary: Deserializes access tokens to AccessTokenEntity objects + remarks: '' + isDeprecated: false + syntax: + content: >- + static function deserializeAccessTokens(accessTokens: Record): AccessTokenCache + parameters: + - id: accessTokens + type: >- + Record<string, > + description: '' + return: + description: '' + type: + - name: deserializeAccounts(Record) + uid: '@azure/msal-node.internals.Deserializer.deserializeAccounts' + package: '@azure/msal-node' + summary: Deserializes accounts to AccountEntity objects + remarks: '' + isDeprecated: false + syntax: + content: >- + static function deserializeAccounts(accounts: Record): AccountCache + parameters: + - id: accounts + type: >- + Record<string, > + description: '' + return: + description: '' + type: + - name: deserializeAllCache(JsonCache) + uid: '@azure/msal-node.internals.Deserializer.deserializeAllCache' + package: '@azure/msal-node' + summary: Deserialize an inMemory Cache + remarks: '' + isDeprecated: false + syntax: + content: 'static function deserializeAllCache(jsonCache: JsonCache): InMemoryCache' + parameters: + - id: jsonCache + type: + description: '' + return: + description: '' + type: + - name: deserializeAppMetadata(Record) + uid: '@azure/msal-node.internals.Deserializer.deserializeAppMetadata' + package: '@azure/msal-node' + summary: Deserializes appMetadata to AppMetaData objects + remarks: '' + isDeprecated: false + syntax: + content: >- + static function deserializeAppMetadata(appMetadata: Record): AppMetadataCache + parameters: + - id: appMetadata + type: >- + Record<string, > + description: '' + return: + description: '' + type: + - name: deserializeIdTokens(Record) + uid: '@azure/msal-node.internals.Deserializer.deserializeIdTokens' + package: '@azure/msal-node' + summary: Deserializes id tokens to IdTokenEntity objects + remarks: '' + isDeprecated: false + syntax: + content: >- + static function deserializeIdTokens(idTokens: Record): IdTokenCache + parameters: + - id: idTokens + type: >- + Record<string, > + description: '' + return: + description: '' + type: + - name: deserializeJSONBlob(string) + uid: '@azure/msal-node.internals.Deserializer.deserializeJSONBlob' + package: '@azure/msal-node' + summary: Parse the JSON blob in memory and deserialize the content + remarks: '' + isDeprecated: false + syntax: + content: 'static function deserializeJSONBlob(jsonFile: string): JsonCache' + parameters: + - id: jsonFile + type: string + description: '' + return: + description: '' + type: + - name: deserializeRefreshTokens(Record) + uid: '@azure/msal-node.internals.Deserializer.deserializeRefreshTokens' + package: '@azure/msal-node' + summary: Deserializes refresh tokens to RefreshTokenEntity objects + remarks: '' + isDeprecated: false + syntax: + content: >- + static function deserializeRefreshTokens(refreshTokens: Record): RefreshTokenCache + parameters: + - id: refreshTokens + type: >- + Record<string, > + description: '' + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-node/internals.Serializer.yml b/msal/docs-ref-autogen/@azure/msal-node/internals.Serializer.yml new file mode 100644 index 0000000..f4e75dc --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/internals.Serializer.yml @@ -0,0 +1,135 @@ +### YamlMime:TSType +name: Serializer +uid: '@azure/msal-node.internals.Serializer' +package: '@azure/msal-node' +summary: '' +fullName: Serializer +remarks: '' +isDeprecated: false +type: class +methods: + - name: serializeAccessTokens(AccessTokenCache) + uid: '@azure/msal-node.internals.Serializer.serializeAccessTokens' + package: '@azure/msal-node' + summary: Serializes AccessTokens + remarks: '' + isDeprecated: false + syntax: + content: >- + static function serializeAccessTokens(atCache: AccessTokenCache): + Record + parameters: + - id: atCache + type: + description: '' + return: + description: '' + type: >- + Record<string, > + - name: serializeAccounts(AccountCache) + uid: '@azure/msal-node.internals.Serializer.serializeAccounts' + package: '@azure/msal-node' + summary: Serialize Accounts + remarks: '' + isDeprecated: false + syntax: + content: >- + static function serializeAccounts(accCache: AccountCache): + Record + parameters: + - id: accCache + type: + description: '' + return: + description: '' + type: >- + Record<string, > + - name: serializeAllCache(InMemoryCache) + uid: '@azure/msal-node.internals.Serializer.serializeAllCache' + package: '@azure/msal-node' + summary: Serialize the cache + remarks: '' + isDeprecated: false + syntax: + content: 'static function serializeAllCache(inMemCache: InMemoryCache): JsonCache' + parameters: + - id: inMemCache + type: + description: '' + return: + description: '' + type: + - name: serializeAppMetadata(AppMetadataCache) + uid: '@azure/msal-node.internals.Serializer.serializeAppMetadata' + package: '@azure/msal-node' + summary: Serialize amdtCache + remarks: '' + isDeprecated: false + syntax: + content: >- + static function serializeAppMetadata(amdtCache: AppMetadataCache): + Record + parameters: + - id: amdtCache + type: + description: '' + return: + description: '' + type: >- + Record<string, > + - name: serializeIdTokens(IdTokenCache) + uid: '@azure/msal-node.internals.Serializer.serializeIdTokens' + package: '@azure/msal-node' + summary: Serialize IdTokens + remarks: '' + isDeprecated: false + syntax: + content: >- + static function serializeIdTokens(idTCache: IdTokenCache): + Record + parameters: + - id: idTCache + type: + description: '' + return: + description: '' + type: >- + Record<string, > + - name: serializeJSONBlob(JsonCache) + uid: '@azure/msal-node.internals.Serializer.serializeJSONBlob' + package: '@azure/msal-node' + summary: serialize the JSON blob + remarks: '' + isDeprecated: false + syntax: + content: 'static function serializeJSONBlob(data: JsonCache): string' + parameters: + - id: data + type: + description: '' + return: + description: '' + type: string + - name: serializeRefreshTokens(RefreshTokenCache) + uid: '@azure/msal-node.internals.Serializer.serializeRefreshTokens' + package: '@azure/msal-node' + summary: Serialize refreshTokens + remarks: '' + isDeprecated: false + syntax: + content: >- + static function serializeRefreshTokens(rtCache: RefreshTokenCache): + Record + parameters: + - id: rtCache + type: + description: '' + return: + description: '' + type: >- + Record<string, > diff --git a/msal/docs-ref-autogen/@azure/msal-node/internals.yml b/msal/docs-ref-autogen/@azure/msal-node/internals.yml new file mode 100644 index 0000000..bfe514a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/internals.yml @@ -0,0 +1,9 @@ +### YamlMime:TSPackage +uid: '@azure/msal-node.internals' +name: internals +summary: '' +type: module +classes: + - '@azure/msal-node.internals.Deserializer' + - '@azure/msal-node.internals.Serializer' +package: '@azure/msal-node' diff --git a/msal/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml b/msal/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml new file mode 100644 index 0000000..7e4c9ad --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: AccountIdentifiers +uid: '@azure/msal-react.AccountIdentifiers' +package: '@azure/msal-react' +summary: '' +fullName: AccountIdentifiers +remarks: '' +isDeprecated: false +syntax: | + type AccountIdentifiers = Partial< + Pick + > diff --git a/msal/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml b/msal/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml new file mode 100644 index 0000000..c6a1ef9 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: AuthenticatedTemplateProps +uid: '@azure/msal-react.AuthenticatedTemplateProps' +package: '@azure/msal-react' +summary: '' +fullName: AuthenticatedTemplateProps +remarks: '' +isDeprecated: false +syntax: | + type AuthenticatedTemplateProps = PropsWithChildren diff --git a/msal/docs-ref-autogen/@azure/msal-react/IMsalContext.yml b/msal/docs-ref-autogen/@azure/msal-react/IMsalContext.yml new file mode 100644 index 0000000..425fbae --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/IMsalContext.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: IMsalContext +uid: '@azure/msal-react.IMsalContext' +package: '@azure/msal-react' +summary: '' +fullName: IMsalContext +remarks: '' +isDeprecated: false +type: interface +properties: + - name: accounts + uid: '@azure/msal-react.IMsalContext.accounts' + package: '@azure/msal-react' + summary: '' + fullName: accounts + remarks: '' + isDeprecated: false + syntax: + content: 'accounts: AccountInfo[]' + return: + description: '' + type: [] + - name: inProgress + uid: '@azure/msal-react.IMsalContext.inProgress' + package: '@azure/msal-react' + summary: '' + fullName: inProgress + remarks: '' + isDeprecated: false + syntax: + content: 'inProgress: InteractionStatus' + return: + description: '' + type: + - name: instance + uid: '@azure/msal-react.IMsalContext.instance' + package: '@azure/msal-react' + summary: '' + fullName: instance + remarks: '' + isDeprecated: false + syntax: + content: 'instance: IPublicClientApplication' + return: + description: '' + type: + - name: logger + uid: '@azure/msal-react.IMsalContext.logger' + package: '@azure/msal-react' + summary: '' + fullName: logger + remarks: '' + isDeprecated: false + syntax: + content: 'logger: Logger' + return: + description: '' + type: diff --git a/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml b/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml new file mode 100644 index 0000000..a18d407 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml @@ -0,0 +1,17 @@ +### YamlMime:TSTypeAlias +name: MsalAuthenticationProps +uid: '@azure/msal-react.MsalAuthenticationProps' +package: '@azure/msal-react' +summary: '' +fullName: MsalAuthenticationProps +remarks: '' +isDeprecated: false +syntax: | + type MsalAuthenticationProps = PropsWithChildren< + AccountIdentifiers & { + authenticationRequest?: PopupRequest | RedirectRequest | SsoSilentRequest + errorComponent?: React.ElementType + interactionType: InteractionType + loadingComponent?: React.ElementType + } + > diff --git a/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml b/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml new file mode 100644 index 0000000..5e82dc6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml @@ -0,0 +1,21 @@ +### YamlMime:TSTypeAlias +name: MsalAuthenticationResult +uid: '@azure/msal-react.MsalAuthenticationResult' +package: '@azure/msal-react' +summary: '' +fullName: MsalAuthenticationResult +remarks: '' +isDeprecated: false +syntax: | + type MsalAuthenticationResult = { + acquireToken: ( + callbackInteractionType?: InteractionType, + callbackRequest?: SilentRequest + ) => Promise + error: AuthError | null + login: ( + callbackInteractionType?: InteractionType, + callbackRequest?: PopupRequest | RedirectRequest | SilentRequest + ) => Promise + result: AuthenticationResult | null + } diff --git a/msal/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml b/msal/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml new file mode 100644 index 0000000..e9970cb --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: MsalProviderProps +uid: '@azure/msal-react.MsalProviderProps' +package: '@azure/msal-react' +summary: '' +fullName: MsalProviderProps +remarks: '' +isDeprecated: false +syntax: | + type MsalProviderProps = PropsWithChildren<{ + instance: IPublicClientApplication + }> diff --git a/msal/docs-ref-autogen/@azure/msal-react/SetComplement.yml b/msal/docs-ref-autogen/@azure/msal-react/SetComplement.yml new file mode 100644 index 0000000..6de8eff --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/SetComplement.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: SetComplement +uid: '@azure/msal-react.SetComplement' +package: '@azure/msal-react' +summary: '' +fullName: SetComplement +remarks: '' +isDeprecated: false +syntax: | + type SetComplement = SetDifference diff --git a/msal/docs-ref-autogen/@azure/msal-react/SetDifference.yml b/msal/docs-ref-autogen/@azure/msal-react/SetDifference.yml new file mode 100644 index 0000000..c7efc07 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/SetDifference.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: SetDifference +uid: '@azure/msal-react.SetDifference' +package: '@azure/msal-react' +summary: '' +fullName: SetDifference +remarks: '' +isDeprecated: false +syntax: | + type SetDifference = A extends B ? never : A diff --git a/msal/docs-ref-autogen/@azure/msal-react/Subtract.yml b/msal/docs-ref-autogen/@azure/msal-react/Subtract.yml new file mode 100644 index 0000000..99a5e40 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/Subtract.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: Subtract +uid: '@azure/msal-react.Subtract' +package: '@azure/msal-react' +summary: '' +fullName: Subtract +remarks: '' +isDeprecated: false +syntax: | + type Subtract = Pick> diff --git a/msal/docs-ref-autogen/@azure/msal-react/UnauthenticatedTemplateProps.yml b/msal/docs-ref-autogen/@azure/msal-react/UnauthenticatedTemplateProps.yml new file mode 100644 index 0000000..f205942 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/UnauthenticatedTemplateProps.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: UnauthenticatedTemplateProps +uid: '@azure/msal-react.UnauthenticatedTemplateProps' +package: '@azure/msal-react' +summary: '' +fullName: UnauthenticatedTemplateProps +remarks: '' +isDeprecated: false +syntax: | + type UnauthenticatedTemplateProps = PropsWithChildren diff --git a/msal/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml b/msal/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml new file mode 100644 index 0000000..5152bd0 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: WithMsalProps +uid: '@azure/msal-react.WithMsalProps' +package: '@azure/msal-react' +summary: '' +fullName: WithMsalProps +remarks: '' +isDeprecated: false +syntax: | + type WithMsalProps = { msalContext: IMsalContext } diff --git a/msal/docs-ref-autogen/@azure/msal-react/index.yml b/msal/docs-ref-autogen/@azure/msal-react/index.yml new file mode 100644 index 0000000..7d5077c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-react/index.yml @@ -0,0 +1,239 @@ +### YamlMime:TSPackage +uid: '@azure/msal-react' +name: '@azure/msal-react' +summary: '' +type: package +interfaces: + - '@azure/msal-react.IMsalContext' +typeAliases: + - '@azure/msal-react.AccountIdentifiers' + - '@azure/msal-react.AuthenticatedTemplateProps' + - '@azure/msal-react.MsalAuthenticationProps' + - '@azure/msal-react.MsalAuthenticationResult' + - '@azure/msal-react.MsalProviderProps' + - '@azure/msal-react.SetComplement' + - '@azure/msal-react.SetDifference' + - '@azure/msal-react.Subtract' + - '@azure/msal-react.UnauthenticatedTemplateProps' + - '@azure/msal-react.WithMsalProps' +functions: + - name: >- + AuthenticatedTemplate(PropsWithChildren>>) + uid: '@azure/msal-react.AuthenticatedTemplate' + package: '@azure/msal-react' + summary: Renders child components if user is authenticated + remarks: '' + isDeprecated: false + syntax: + content: >- + function AuthenticatedTemplate(props: + PropsWithChildren>>): React.ReactElement | null + parameters: + - id: props + type: >- + PropsWithChildren<Partial<Pick<, "homeAccountId" | + "localAccountId" | "username">>> + description: '' + return: + description: '' + type: | null + - name: >- + MsalAuthenticationTemplate(PropsWithChildren> & { + authenticationRequest?: PopupRequest | RedirectRequest | SsoSilentRequest, + errorComponent?: any, interactionType: InteractionType, loadingComponent?: + any }>) + uid: '@azure/msal-react.MsalAuthenticationTemplate' + package: '@azure/msal-react' + summary: >- + Attempts to authenticate user if not already authenticated, then renders + child components + remarks: '' + isDeprecated: false + syntax: + content: >- + function MsalAuthenticationTemplate(props: + PropsWithChildren> & { authenticationRequest?: PopupRequest + | RedirectRequest | SsoSilentRequest, errorComponent?: any, + interactionType: InteractionType, loadingComponent?: any }>): + React.ReactElement | null + parameters: + - id: props + type: >- + PropsWithChildren<Partial<Pick<, "homeAccountId" | + "localAccountId" | "username">> & { authenticationRequest?: + PopupRequest | RedirectRequest | SsoSilentRequest, errorComponent?: + any, interactionType: InteractionType, loadingComponent?: any }> + description: '' + return: + description: '' + type: | null + - name: 'MsalProvider(PropsWithChildren<{ instance: IPublicClientApplication }>)' + uid: '@azure/msal-react.MsalProvider' + package: '@azure/msal-react' + summary: >- + MSAL context provider component. This must be rendered above any other + components that use MSAL. + remarks: '' + isDeprecated: false + syntax: + content: >- + function MsalProvider(__namedParameters: PropsWithChildren<{ instance: + IPublicClientApplication }>): React.ReactElement + parameters: + - id: __namedParameters + type: 'PropsWithChildren<{ instance: IPublicClientApplication }>' + description: '' + return: + description: '' + type: + - name: >- + UnauthenticatedTemplate(PropsWithChildren>>) + uid: '@azure/msal-react.UnauthenticatedTemplate' + package: '@azure/msal-react' + summary: Renders child components if user is unauthenticated + remarks: '' + isDeprecated: false + syntax: + content: >- + function UnauthenticatedTemplate(props: + PropsWithChildren>>): React.ReactElement | null + parameters: + - id: props + type: >- + PropsWithChildren<Partial<Pick<, "homeAccountId" | + "localAccountId" | "username">>> + description: '' + return: + description: '' + type: | null + - name: >- + useAccount(Partial>) + uid: '@azure/msal-react.useAccount' + package: '@azure/msal-react' + summary: >- + Given 1 or more accountIdentifiers, returns the Account object if the user + is signed-in + remarks: '' + isDeprecated: false + syntax: + content: >- + function useAccount(accountIdentifiers?: Partial>): AccountInfo | null + parameters: + - id: accountIdentifiers + type: >- + Partial<Pick<, + "homeAccountId" | "localAccountId" | "username">> + description: '' + return: + description: '' + type: | null + - name: >- + useIsAuthenticated(Partial>) + uid: '@azure/msal-react.useIsAuthenticated' + package: '@azure/msal-react' + summary: >- + Returns whether or not a user is currently signed-in. Optionally provide 1 + or more accountIdentifiers to determine if a specific user is signed-in + remarks: '' + isDeprecated: false + syntax: + content: >- + function useIsAuthenticated(matchAccount?: Partial>): boolean + parameters: + - id: matchAccount + type: >- + Partial<Pick<, + "homeAccountId" | "localAccountId" | "username">> + description: '' + return: + description: '' + type: boolean + - name: useMsal() + uid: '@azure/msal-react.useMsal' + package: '@azure/msal-react' + summary: Returns Msal Context values + remarks: '' + isDeprecated: false + syntax: + content: 'function useMsal(): IMsalContext' + return: + description: '' + type: + - name: >- + useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | + SsoSilentRequest, Partial>) + uid: '@azure/msal-react.useMsalAuthentication' + package: '@azure/msal-react' + summary: >- + If a user is not currently signed in this hook invokes a login. Failed + logins can be retried using the login callback returned. + + If a user is currently signed in this hook attempts to acquire a token. + Subsequent token requests can use the acquireToken callback returned. + + Optionally provide a request object to be used in the login/acquireToken + call. + + Optionally provide a specific user that should be logged in. + remarks: '' + isDeprecated: false + syntax: + content: >- + function useMsalAuthentication(interactionType: InteractionType, + authenticationRequest?: PopupRequest | RedirectRequest | + SsoSilentRequest, accountIdentifiers?: Partial>): + MsalAuthenticationResult + parameters: + - id: interactionType + type: + description: '' + - id: authenticationRequest + type: >- + | | + description: '' + - id: accountIdentifiers + type: >- + Partial<Pick<, + "homeAccountId" | "localAccountId" | "username">> + description: '' + return: + description: '' + type: + - name: withMsal

(ComponentType

) + uid: '@azure/msal-react.withMsal' + package: '@azure/msal-react' + summary: >- + Higher order component wraps provided component with msal by injecting + msal context values into the component's props + remarks: '' + isDeprecated: false + syntax: + content: >- + function withMsal

(Component: ComponentType

): + FunctionComponent> + parameters: + - id: Component + type: ComponentType<P> + description: '' + return: + description: '' + type: >- + FunctionComponent<<P, + >> diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml new file mode 100644 index 0000000..aa82032 --- /dev/null +++ b/msal/docs-ref-autogen/toc.yml @@ -0,0 +1,960 @@ +- name: '@azure/msal-angular' + items: + - name: Overview + uid: '@azure/msal-angular' + - uid: '@azure/msal-angular.IMsalService' + name: IMsalService + items: [] + - uid: '@azure/msal-angular.MsalBroadcastConfiguration' + name: MsalBroadcastConfiguration + items: [] + - uid: '@azure/msal-angular.MsalBroadcastService' + name: MsalBroadcastService + items: [] + - uid: '@azure/msal-angular.MsalCustomNavigationClient' + name: MsalCustomNavigationClient + items: [] + - uid: '@azure/msal-angular.MsalGuard' + name: MsalGuard + items: [] + - uid: '@azure/msal-angular.MsalGuardAuthRequest' + name: MsalGuardAuthRequest + items: [] + - uid: '@azure/msal-angular.MsalGuardConfiguration' + name: MsalGuardConfiguration + items: [] + - uid: '@azure/msal-angular.MsalInterceptor' + name: MsalInterceptor + items: [] + - uid: '@azure/msal-angular.MsalInterceptorAuthRequest' + name: MsalInterceptorAuthRequest + items: [] + - uid: '@azure/msal-angular.MsalInterceptorConfiguration' + name: MsalInterceptorConfiguration + items: [] + - uid: '@azure/msal-angular.MsalModule' + name: MsalModule + items: [] + - uid: '@azure/msal-angular.MsalRedirectComponent' + name: MsalRedirectComponent + items: [] + - uid: '@azure/msal-angular.MsalService' + name: MsalService + items: [] + - uid: '@azure/msal-angular.ProtectedResourceScopes' + name: ProtectedResourceScopes + items: [] +- name: '@azure/msal-browser' + items: + - name: Overview + uid: '@azure/msal-browser' + - uid: '@azure/msal-browser.AccountInfo' + name: AccountInfo + items: [] + - uid: '@azure/msal-browser.ApiId' + name: ApiId + items: [] + - uid: '@azure/msal-browser.AuthenticationHeaderParser' + name: AuthenticationHeaderParser + items: [] + - uid: '@azure/msal-browser.AuthenticationResult' + name: AuthenticationResult + items: [] + - uid: '@azure/msal-browser.AuthenticationScheme' + name: AuthenticationScheme + items: [] + - uid: '@azure/msal-browser.AuthError' + name: AuthError + items: [] + - uid: '@azure/msal-browser.AuthErrorCodes' + name: AuthErrorCodes + items: [] + - uid: '@azure/msal-browser.AuthorizationCodeRequest' + name: AuthorizationCodeRequest + items: [] + - uid: '@azure/msal-browser.AuthorizationUrlRequest' + name: AuthorizationUrlRequest + items: [] + - uid: '@azure/msal-browser.AzureCloudInstance' + name: AzureCloudInstance + items: [] + - uid: '@azure/msal-browser.AzureCloudOptions' + name: AzureCloudOptions + items: [] + - uid: '@azure/msal-browser.BrowserAuthError' + name: BrowserAuthError + items: [] + - uid: '@azure/msal-browser.BrowserAuthErrorCodes' + name: BrowserAuthErrorCodes + items: [] + - uid: '@azure/msal-browser.BrowserAuthOptions' + name: BrowserAuthOptions + items: [] + - uid: '@azure/msal-browser.BrowserCacheLocation' + name: BrowserCacheLocation + items: [] + - uid: '@azure/msal-browser.BrowserConfigurationAuthError' + name: BrowserConfigurationAuthError + items: [] + - uid: '@azure/msal-browser.BrowserConfigurationAuthErrorCodes' + name: BrowserConfigurationAuthErrorCodes + items: [] + - uid: '@azure/msal-browser.BrowserPerformanceClient' + name: BrowserPerformanceClient + items: [] + - uid: '@azure/msal-browser.BrowserPerformanceMeasurement' + name: BrowserPerformanceMeasurement + items: [] + - uid: '@azure/msal-browser.BrowserStorage' + name: BrowserStorage + items: [] + - uid: '@azure/msal-browser.BrowserSystemOptions' + name: BrowserSystemOptions + items: [] + - uid: '@azure/msal-browser.BrowserTelemetryOptions' + name: BrowserTelemetryOptions + items: [] + - uid: '@azure/msal-browser.BrowserUtils' + name: BrowserUtils + items: [] + - uid: '@azure/msal-browser.CacheLookupPolicy' + name: CacheLookupPolicy + items: [] + - uid: '@azure/msal-browser.CacheOptions' + name: CacheOptions + items: [] + - uid: '@azure/msal-browser.ClearCacheRequest' + name: ClearCacheRequest + items: [] + - uid: '@azure/msal-browser.ClientAuthError' + name: ClientAuthError + items: [] + - uid: '@azure/msal-browser.ClientAuthErrorCodes' + name: ClientAuthErrorCodes + items: [] + - uid: '@azure/msal-browser.ClientConfigurationError' + name: ClientConfigurationError + items: [] + - uid: '@azure/msal-browser.ClientConfigurationErrorCodes' + name: ClientConfigurationErrorCodes + items: [] + - uid: '@azure/msal-browser.Configuration' + name: Configuration + items: [] + - uid: '@azure/msal-browser.EndSessionPopupRequest' + name: EndSessionPopupRequest + items: [] + - uid: '@azure/msal-browser.EndSessionRequest' + name: EndSessionRequest + items: [] + - uid: '@azure/msal-browser.EventCallbackFunction' + name: EventCallbackFunction + items: [] + - uid: '@azure/msal-browser.EventError' + name: EventError + items: [] + - uid: '@azure/msal-browser.EventMessage' + name: EventMessage + items: [] + - uid: '@azure/msal-browser.EventMessageUtils' + name: EventMessageUtils + items: [] + - uid: '@azure/msal-browser.EventPayload' + name: EventPayload + items: [] + - uid: '@azure/msal-browser.EventType' + name: EventType + items: [] + - uid: '@azure/msal-browser.ExternalTokenResponse' + name: ExternalTokenResponse + items: [] + - uid: '@azure/msal-browser.IController' + name: IController + items: [] + - uid: '@azure/msal-browser.IdTokenClaims' + name: IdTokenClaims + items: [] + - uid: '@azure/msal-browser.ILoggerCallback' + name: ILoggerCallback + items: [] + - uid: '@azure/msal-browser.INavigationClient' + name: INavigationClient + items: [] + - uid: '@azure/msal-browser.INetworkModule' + name: INetworkModule + items: [] + - uid: '@azure/msal-browser.InProgressPerformanceEvent' + name: InProgressPerformanceEvent + items: [] + - uid: '@azure/msal-browser.InteractionRequiredAuthError' + name: InteractionRequiredAuthError + items: [] + - uid: '@azure/msal-browser.InteractionRequiredAuthErrorCodes' + name: InteractionRequiredAuthErrorCodes + items: [] + - uid: '@azure/msal-browser.InteractionStatus' + name: InteractionStatus + items: [] + - uid: '@azure/msal-browser.InteractionType' + name: InteractionType + items: [] + - uid: '@azure/msal-browser.IPerformanceClient' + name: IPerformanceClient + items: [] + - uid: '@azure/msal-browser.IPublicClientApplication' + name: IPublicClientApplication + items: [] + - uid: '@azure/msal-browser.ITokenCache' + name: ITokenCache + items: [] + - uid: '@azure/msal-browser.JsonWebTokenTypes' + name: JsonWebTokenTypes + items: [] + - uid: '@azure/msal-browser.LoadTokenOptions' + name: LoadTokenOptions + items: [] + - uid: '@azure/msal-browser.Logger' + name: Logger + items: [] + - uid: '@azure/msal-browser.LogLevel' + name: LogLevel + items: [] + - uid: '@azure/msal-browser.MemoryStorage' + name: MemoryStorage + items: [] + - uid: '@azure/msal-browser.NavigationClient' + name: NavigationClient + items: [] + - uid: '@azure/msal-browser.NavigationOptions' + name: NavigationOptions + items: [] + - uid: '@azure/msal-browser.NetworkRequestOptions' + name: NetworkRequestOptions + items: [] + - uid: '@azure/msal-browser.NetworkResponse' + name: NetworkResponse + items: [] + - uid: '@azure/msal-browser.PerformanceCallbackFunction' + name: PerformanceCallbackFunction + items: [] + - uid: '@azure/msal-browser.PerformanceEvent' + name: PerformanceEvent + items: [] + - uid: '@azure/msal-browser.PerformanceEvents' + name: PerformanceEvents + items: [] + - uid: '@azure/msal-browser.PopupEvent' + name: PopupEvent + items: [] + - uid: '@azure/msal-browser.PopupPosition' + name: PopupPosition + items: [] + - uid: '@azure/msal-browser.PopupRequest' + name: PopupRequest + items: [] + - uid: '@azure/msal-browser.PopupSize' + name: PopupSize + items: [] + - uid: '@azure/msal-browser.PopupWindowAttributes' + name: PopupWindowAttributes + items: [] + - uid: '@azure/msal-browser.ProtocolMode' + name: ProtocolMode + items: [] + - uid: '@azure/msal-browser.PublicClientApplication' + name: PublicClientApplication + items: [] + - uid: '@azure/msal-browser.PublicClientNext' + name: PublicClientNext + items: [] + - uid: '@azure/msal-browser.RedirectRequest' + name: RedirectRequest + items: [] + - uid: '@azure/msal-browser.ServerError' + name: ServerError + items: [] + - uid: '@azure/msal-browser.ServerResponseType' + name: ServerResponseType + items: [] + - uid: '@azure/msal-browser.SignedHttpRequest' + name: SignedHttpRequest + items: [] + - uid: '@azure/msal-browser.SignedHttpRequestOptions' + name: SignedHttpRequestOptions + items: [] + - uid: '@azure/msal-browser.SilentRequest' + name: SilentRequest + items: [] + - uid: '@azure/msal-browser.SsoSilentRequest' + name: SsoSilentRequest + items: [] + - uid: '@azure/msal-browser.StubPerformanceClient' + name: StubPerformanceClient + items: [] + - uid: '@azure/msal-browser.TenantProfile' + name: TenantProfile + items: [] + - uid: '@azure/msal-browser.UrlString' + name: UrlString + items: [] + - uid: '@azure/msal-browser.WrapperSKU' + name: WrapperSKU + items: [] +- name: '@azure/msal-common' + items: + - name: Overview + uid: '@azure/msal-common' + - uid: '@azure/msal-common.AADAuthorityConstants' + name: AADAuthorityConstants + items: [] + - uid: '@azure/msal-common.AADServerParamKeys' + name: AADServerParamKeys + items: [] + - uid: '@azure/msal-common.AccessTokenEntity' + name: AccessTokenEntity + items: [] + - uid: '@azure/msal-common.AccountFilter' + name: AccountFilter + items: [] + - uid: '@azure/msal-common.AccountInfo' + name: AccountInfo + items: [] + - uid: '@azure/msal-common.ActiveAccountFilters' + name: ActiveAccountFilters + items: [] + - uid: '@azure/msal-common.ApplicationTelemetry' + name: ApplicationTelemetry + items: [] + - uid: '@azure/msal-common.AppMetadataEntity' + name: AppMetadataEntity + items: [] + - uid: '@azure/msal-common.AppTokenProviderParameters' + name: AppTokenProviderParameters + items: [] + - uid: '@azure/msal-common.AppTokenProviderResult' + name: AppTokenProviderResult + items: [] + - uid: '@azure/msal-common.AuthenticationHeaderParser' + name: AuthenticationHeaderParser + items: [] + - uid: '@azure/msal-common.AuthenticationResult' + name: AuthenticationResult + items: [] + - uid: '@azure/msal-common.AuthenticationScheme' + name: AuthenticationScheme + items: [] + - uid: '@azure/msal-common.AuthError' + name: AuthError + items: [] + - uid: '@azure/msal-common.AuthErrorCodes' + name: AuthErrorCodes + items: [] + - uid: '@azure/msal-common.AuthorityFactory' + name: AuthorityFactory + items: [] + - uid: '@azure/msal-common.AuthorityOptions' + name: AuthorityOptions + items: [] + - uid: '@azure/msal-common.AuthorityType' + name: AuthorityType + items: [] + - uid: '@azure/msal-common.AuthorizationCodePayload' + name: AuthorizationCodePayload + items: [] + - uid: '@azure/msal-common.AuthToken' + name: AuthToken + items: [] + - uid: '@azure/msal-common.AzureCloudInstance' + name: AzureCloudInstance + items: [] + - uid: '@azure/msal-common.AzureCloudOptions' + name: AzureCloudOptions + items: [] + - uid: '@azure/msal-common.AzureRegion' + name: AzureRegion + items: [] + - uid: '@azure/msal-common.AzureRegionConfiguration' + name: AzureRegionConfiguration + items: [] + - uid: '@azure/msal-common.BaseAuthRequest' + name: BaseAuthRequest + items: [] + - uid: '@azure/msal-common.CacheAccountType' + name: CacheAccountType + items: [] + - uid: '@azure/msal-common.CacheError' + name: CacheError + items: [] + - uid: '@azure/msal-common.CacheErrorCodes' + name: CacheErrorCodes + items: [] + - uid: '@azure/msal-common.CacheHelpers' + name: CacheHelpers + items: [] + - uid: '@azure/msal-common.CacheOptions' + name: CacheOptions + items: [] + - uid: '@azure/msal-common.CacheOutcome' + name: CacheOutcome + items: [] + - uid: '@azure/msal-common.CacheType' + name: CacheType + items: [] + - uid: '@azure/msal-common.CcsCredential' + name: CcsCredential + items: [] + - uid: '@azure/msal-common.CcsCredentialType' + name: CcsCredentialType + items: [] + - uid: '@azure/msal-common.ClaimsRequestKeys' + name: ClaimsRequestKeys + items: [] + - uid: '@azure/msal-common.ClientAssertion' + name: ClientAssertion + items: [] + - uid: '@azure/msal-common.ClientAuthError' + name: ClientAuthError + items: [] + - uid: '@azure/msal-common.ClientAuthErrorCodes' + name: ClientAuthErrorCodes + items: [] + - uid: '@azure/msal-common.ClientConfigurationError' + name: ClientConfigurationError + items: [] + - uid: '@azure/msal-common.ClientConfigurationErrorCodes' + name: ClientConfigurationErrorCodes + items: [] + - uid: '@azure/msal-common.ClientInfo' + name: ClientInfo + items: [] + - uid: '@azure/msal-common.CommonAuthorizationCodeRequest' + name: CommonAuthorizationCodeRequest + items: [] + - uid: '@azure/msal-common.CommonAuthorizationUrlRequest' + name: CommonAuthorizationUrlRequest + items: [] + - uid: '@azure/msal-common.CommonClientCredentialRequest' + name: CommonClientCredentialRequest + items: [] + - uid: '@azure/msal-common.CommonDeviceCodeRequest' + name: CommonDeviceCodeRequest + items: [] + - uid: '@azure/msal-common.CommonEndSessionRequest' + name: CommonEndSessionRequest + items: [] + - uid: '@azure/msal-common.CommonOnBehalfOfRequest' + name: CommonOnBehalfOfRequest + items: [] + - uid: '@azure/msal-common.CommonRefreshTokenRequest' + name: CommonRefreshTokenRequest + items: [] + - uid: '@azure/msal-common.CommonSilentFlowRequest' + name: CommonSilentFlowRequest + items: [] + - uid: '@azure/msal-common.CommonUsernamePasswordRequest' + name: CommonUsernamePasswordRequest + items: [] + - uid: '@azure/msal-common.CredentialEntity' + name: CredentialEntity + items: [] + - uid: '@azure/msal-common.CredentialFilter' + name: CredentialFilter + items: [] + - uid: '@azure/msal-common.CredentialType' + name: CredentialType + items: [] + - uid: '@azure/msal-common.DeviceCodeResponse' + name: DeviceCodeResponse + items: [] + - uid: '@azure/msal-common.ExternalTokenResponse' + name: ExternalTokenResponse + items: [] + - uid: '@azure/msal-common.GrantType' + name: GrantType + items: [] + - uid: '@azure/msal-common.HeaderNames' + name: HeaderNames + items: [] + - uid: '@azure/msal-common.HttpStatus' + name: HttpStatus + items: [] + - uid: '@azure/msal-common.IAppTokenProvider' + name: IAppTokenProvider + items: [] + - uid: '@azure/msal-common.ICachePlugin' + name: ICachePlugin + items: [] + - uid: '@azure/msal-common.ICrypto' + name: ICrypto + items: [] + - uid: '@azure/msal-common.IdTokenEntity' + name: IdTokenEntity + items: [] + - uid: '@azure/msal-common.IGuidGenerator' + name: IGuidGenerator + items: [] + - uid: '@azure/msal-common.ILoggerCallback' + name: ILoggerCallback + items: [] + - uid: '@azure/msal-common.INativeBrokerPlugin' + name: INativeBrokerPlugin + items: [] + - uid: '@azure/msal-common.INetworkModule' + name: INetworkModule + items: [] + - uid: '@azure/msal-common.InProgressPerformanceEvent' + name: InProgressPerformanceEvent + items: [] + - uid: '@azure/msal-common.InteractionRequiredAuthError' + name: InteractionRequiredAuthError + items: [] + - uid: '@azure/msal-common.InteractionRequiredAuthErrorCodes' + name: InteractionRequiredAuthErrorCodes + items: [] + - uid: '@azure/msal-common.IPerformanceClient' + name: IPerformanceClient + items: [] + - uid: '@azure/msal-common.IPerformanceMeasurement' + name: IPerformanceMeasurement + items: [] + - uid: '@azure/msal-common.ISerializableTokenCache' + name: ISerializableTokenCache + items: [] + - uid: '@azure/msal-common.IUri' + name: IUri + items: [] + - uid: '@azure/msal-common.JsonWebTokenTypes' + name: JsonWebTokenTypes + items: [] + - uid: '@azure/msal-common.LibraryStateObject' + name: LibraryStateObject + items: [] + - uid: '@azure/msal-common.Logger' + name: Logger + items: [] + - uid: '@azure/msal-common.LoggerOptions' + name: LoggerOptions + items: [] + - uid: '@azure/msal-common.LogLevel' + name: LogLevel + items: [] + - uid: '@azure/msal-common.NativeRequest' + name: NativeRequest + items: [] + - uid: '@azure/msal-common.NativeSignOutRequest' + name: NativeSignOutRequest + items: [] + - uid: '@azure/msal-common.NetworkRequestOptions' + name: NetworkRequestOptions + items: [] + - uid: '@azure/msal-common.NetworkResponse' + name: NetworkResponse + items: [] + - uid: '@azure/msal-common.OIDCOptions' + name: OIDCOptions + items: [] + - uid: '@azure/msal-common.PasswordGrantConstants' + name: PasswordGrantConstants + items: [] + - uid: '@azure/msal-common.PerformanceCallbackFunction' + name: PerformanceCallbackFunction + items: [] + - uid: '@azure/msal-common.PerformanceClient' + name: PerformanceClient + items: [] + - uid: '@azure/msal-common.PerformanceEvent' + name: PerformanceEvent + items: [] + - uid: '@azure/msal-common.PerformanceEvents' + name: PerformanceEvents + items: [] + - uid: '@azure/msal-common.PerformanceEventStatus' + name: PerformanceEventStatus + items: [] + - uid: '@azure/msal-common.PersistentCacheKeys' + name: PersistentCacheKeys + items: [] + - uid: '@azure/msal-common.PkceCodes' + name: PkceCodes + items: [] + - uid: '@azure/msal-common.PreQueueEvent' + name: PreQueueEvent + items: [] + - uid: '@azure/msal-common.ProtocolMode' + name: ProtocolMode + items: [] + - uid: '@azure/msal-common.ProtocolUtils' + name: ProtocolUtils + items: [] + - uid: '@azure/msal-common.QueueMeasurement' + name: QueueMeasurement + items: [] + - uid: '@azure/msal-common.RefreshTokenEntity' + name: RefreshTokenEntity + items: [] + - uid: '@azure/msal-common.RequestStateObject' + name: RequestStateObject + items: [] + - uid: '@azure/msal-common.RequestThumbprint' + name: RequestThumbprint + items: [] + - uid: '@azure/msal-common.ResponseMode' + name: ResponseMode + items: [] + - uid: '@azure/msal-common.ScopeSet' + name: ScopeSet + items: [] + - uid: '@azure/msal-common.ServerAuthorizationCodeResponse' + name: ServerAuthorizationCodeResponse + items: [] + - uid: '@azure/msal-common.ServerAuthorizationTokenResponse' + name: ServerAuthorizationTokenResponse + items: [] + - uid: '@azure/msal-common.ServerDeviceCodeResponse' + name: ServerDeviceCodeResponse + items: [] + - uid: '@azure/msal-common.ServerError' + name: ServerError + items: [] + - uid: '@azure/msal-common.ServerResponseType' + name: ServerResponseType + items: [] + - uid: '@azure/msal-common.ServerTelemetryEntity' + name: ServerTelemetryEntity + items: [] + - uid: '@azure/msal-common.ServerTelemetryRequest' + name: ServerTelemetryRequest + items: [] + - uid: '@azure/msal-common.ShrOptions' + name: ShrOptions + items: [] + - uid: '@azure/msal-common.SignedHttpRequest' + name: SignedHttpRequest + items: [] + - uid: '@azure/msal-common.SignedHttpRequestParameters' + name: SignedHttpRequestParameters + items: [] + - uid: '@azure/msal-common.StaticAuthorityOptions' + name: StaticAuthorityOptions + items: [] + - uid: '@azure/msal-common.StoreInCache' + name: StoreInCache + items: [] + - uid: '@azure/msal-common.StringDict' + name: StringDict + items: [] + - uid: '@azure/msal-common.StubPerformanceClient' + name: StubPerformanceClient + items: [] + - uid: '@azure/msal-common.SubMeasurement' + name: SubMeasurement + items: [] + - uid: '@azure/msal-common.SystemOptions' + name: SystemOptions + items: [] + - uid: '@azure/msal-common.TenantProfile' + name: TenantProfile + items: [] + - uid: '@azure/msal-common.ThrottlingEntity' + name: ThrottlingEntity + items: [] + - uid: '@azure/msal-common.TimeUtils' + name: TimeUtils + items: [] + - uid: '@azure/msal-common.TokenCacheContext' + name: TokenCacheContext + items: [] + - uid: '@azure/msal-common.TokenClaims' + name: TokenClaims + items: [] + - uid: '@azure/msal-common.TokenKeys' + name: TokenKeys + items: [] + - uid: '@azure/msal-common.UrlString' + name: UrlString + items: [] + - uid: '@azure/msal-common.UrlToHttpRequestOptions' + name: UrlToHttpRequestOptions + items: [] + - uid: '@azure/msal-common.UrlUtils' + name: UrlUtils + items: [] +- name: '@azure/msal-node' + items: + - name: Overview + uid: '@azure/msal-node' + - uid: '@azure/msal-node.AccountInfo' + name: AccountInfo + items: [] + - uid: '@azure/msal-node.AppTokenProviderParameters' + name: AppTokenProviderParameters + items: [] + - uid: '@azure/msal-node.AppTokenProviderResult' + name: AppTokenProviderResult + items: [] + - uid: '@azure/msal-node.AuthenticationResult' + name: AuthenticationResult + items: [] + - uid: '@azure/msal-node.AuthError' + name: AuthError + items: [] + - uid: '@azure/msal-node.AuthErrorCodes' + name: AuthErrorCodes + items: [] + - uid: '@azure/msal-node.AuthorizationCodePayload' + name: AuthorizationCodePayload + items: [] + - uid: '@azure/msal-node.AuthorizationCodeRequest' + name: AuthorizationCodeRequest + items: [] + - uid: '@azure/msal-node.AuthorizationUrlRequest' + name: AuthorizationUrlRequest + items: [] + - uid: '@azure/msal-node.AzureCloudInstance' + name: AzureCloudInstance + items: [] + - uid: '@azure/msal-node.AzureCloudOptions' + name: AzureCloudOptions + items: [] + - uid: '@azure/msal-node.BrokerOptions' + name: BrokerOptions + items: [] + - uid: '@azure/msal-node.CacheKVStore' + name: CacheKVStore + items: [] + - uid: '@azure/msal-node.CacheOptions' + name: CacheOptions + items: [] + - uid: '@azure/msal-node.ClientApplication' + name: ClientApplication + items: [] + - uid: '@azure/msal-node.ClientAssertion' + name: ClientAssertion + items: [] + - uid: '@azure/msal-node.ClientAuthError' + name: ClientAuthError + items: [] + - uid: '@azure/msal-node.ClientAuthErrorCodes' + name: ClientAuthErrorCodes + items: [] + - uid: '@azure/msal-node.ClientConfigurationError' + name: ClientConfigurationError + items: [] + - uid: '@azure/msal-node.ClientConfigurationErrorCodes' + name: ClientConfigurationErrorCodes + items: [] + - uid: '@azure/msal-node.ClientCredentialClient' + name: ClientCredentialClient + items: [] + - uid: '@azure/msal-node.ClientCredentialRequest' + name: ClientCredentialRequest + items: [] + - uid: '@azure/msal-node.ConfidentialClientApplication' + name: ConfidentialClientApplication + items: [] + - uid: '@azure/msal-node.Configuration' + name: Configuration + items: [] + - uid: '@azure/msal-node.CryptoProvider' + name: CryptoProvider + items: [] + - uid: '@azure/msal-node.DeviceCodeClient' + name: DeviceCodeClient + items: [] + - uid: '@azure/msal-node.DeviceCodeRequest' + name: DeviceCodeRequest + items: [] + - uid: '@azure/msal-node.DistributedCachePlugin' + name: DistributedCachePlugin + items: [] + - uid: '@azure/msal-node.IAppTokenProvider' + name: IAppTokenProvider + items: [] + - uid: '@azure/msal-node.ICacheClient' + name: ICacheClient + items: [] + - uid: '@azure/msal-node.ICachePlugin' + name: ICachePlugin + items: [] + - uid: '@azure/msal-node.IConfidentialClientApplication' + name: IConfidentialClientApplication + items: [] + - uid: '@azure/msal-node.IdTokenClaims' + name: IdTokenClaims + items: [] + - uid: '@azure/msal-node.ILoopbackClient' + name: ILoopbackClient + items: [] + - uid: '@azure/msal-node.INativeBrokerPlugin' + name: INativeBrokerPlugin + items: [] + - uid: '@azure/msal-node.INetworkModule' + name: INetworkModule + items: [] + - uid: '@azure/msal-node.InMemoryCache' + name: InMemoryCache + items: [] + - uid: '@azure/msal-node.InteractionRequiredAuthError' + name: InteractionRequiredAuthError + items: [] + - uid: '@azure/msal-node.InteractionRequiredAuthErrorCodes' + name: InteractionRequiredAuthErrorCodes + items: [] + - uid: '@azure/msal-node.InteractiveRequest' + name: InteractiveRequest + items: [] + - name: internals + items: + - name: Overview + uid: '@azure/msal-node.internals' + - uid: '@azure/msal-node.internals.Deserializer' + name: Deserializer + items: [] + - uid: '@azure/msal-node.internals.Serializer' + name: Serializer + items: [] + - uid: '@azure/msal-node.IPartitionManager' + name: IPartitionManager + items: [] + - uid: '@azure/msal-node.IPublicClientApplication' + name: IPublicClientApplication + items: [] + - uid: '@azure/msal-node.ISerializableTokenCache' + name: ISerializableTokenCache + items: [] + - uid: '@azure/msal-node.ITokenCache' + name: ITokenCache + items: [] + - uid: '@azure/msal-node.JsonCache' + name: JsonCache + items: [] + - uid: '@azure/msal-node.Logger' + name: Logger + items: [] + - uid: '@azure/msal-node.LogLevel' + name: LogLevel + items: [] + - uid: '@azure/msal-node.ManagedIdentityApplication' + name: ManagedIdentityApplication + items: [] + - uid: '@azure/msal-node.ManagedIdentityConfiguration' + name: ManagedIdentityConfiguration + items: [] + - uid: '@azure/msal-node.ManagedIdentityIdParams' + name: ManagedIdentityIdParams + items: [] + - uid: '@azure/msal-node.ManagedIdentityRequestParams' + name: ManagedIdentityRequestParams + items: [] + - uid: '@azure/msal-node.NetworkRequestOptions' + name: NetworkRequestOptions + items: [] + - uid: '@azure/msal-node.NetworkResponse' + name: NetworkResponse + items: [] + - uid: '@azure/msal-node.NodeAuthOptions' + name: NodeAuthOptions + items: [] + - uid: '@azure/msal-node.NodeStorage' + name: NodeStorage + items: [] + - uid: '@azure/msal-node.NodeSystemOptions' + name: NodeSystemOptions + items: [] + - uid: '@azure/msal-node.NodeTelemetryOptions' + name: NodeTelemetryOptions + items: [] + - uid: '@azure/msal-node.OnBehalfOfClient' + name: OnBehalfOfClient + items: [] + - uid: '@azure/msal-node.OnBehalfOfRequest' + name: OnBehalfOfRequest + items: [] + - uid: '@azure/msal-node.ProtocolMode' + name: ProtocolMode + items: [] + - uid: '@azure/msal-node.PublicClientApplication' + name: PublicClientApplication + items: [] + - uid: '@azure/msal-node.RefreshTokenRequest' + name: RefreshTokenRequest + items: [] + - uid: '@azure/msal-node.ResponseMode' + name: ResponseMode + items: [] + - uid: '@azure/msal-node.SerializedAccessTokenEntity' + name: SerializedAccessTokenEntity + items: [] + - uid: '@azure/msal-node.SerializedAccountEntity' + name: SerializedAccountEntity + items: [] + - uid: '@azure/msal-node.SerializedAppMetadataEntity' + name: SerializedAppMetadataEntity + items: [] + - uid: '@azure/msal-node.SerializedIdTokenEntity' + name: SerializedIdTokenEntity + items: [] + - uid: '@azure/msal-node.SerializedRefreshTokenEntity' + name: SerializedRefreshTokenEntity + items: [] + - uid: '@azure/msal-node.ServerAuthorizationCodeResponse' + name: ServerAuthorizationCodeResponse + items: [] + - uid: '@azure/msal-node.ServerError' + name: ServerError + items: [] + - uid: '@azure/msal-node.SignOutRequest' + name: SignOutRequest + items: [] + - uid: '@azure/msal-node.SilentFlowRequest' + name: SilentFlowRequest + items: [] + - uid: '@azure/msal-node.TokenCache' + name: TokenCache + items: [] + - uid: '@azure/msal-node.TokenCacheContext' + name: TokenCacheContext + items: [] + - uid: '@azure/msal-node.UsernamePasswordClient' + name: UsernamePasswordClient + items: [] + - uid: '@azure/msal-node.UsernamePasswordRequest' + name: UsernamePasswordRequest + items: [] +- name: '@azure/msal-react' + items: + - name: Overview + uid: '@azure/msal-react' + - uid: '@azure/msal-react.AccountIdentifiers' + name: AccountIdentifiers + items: [] + - uid: '@azure/msal-react.AuthenticatedTemplateProps' + name: AuthenticatedTemplateProps + items: [] + - uid: '@azure/msal-react.IMsalContext' + name: IMsalContext + items: [] + - uid: '@azure/msal-react.MsalAuthenticationProps' + name: MsalAuthenticationProps + items: [] + - uid: '@azure/msal-react.MsalAuthenticationResult' + name: MsalAuthenticationResult + items: [] + - uid: '@azure/msal-react.MsalProviderProps' + name: MsalProviderProps + items: [] + - uid: '@azure/msal-react.SetComplement' + name: SetComplement + items: [] + - uid: '@azure/msal-react.SetDifference' + name: SetDifference + items: [] + - uid: '@azure/msal-react.Subtract' + name: Subtract + items: [] + - uid: '@azure/msal-react.UnauthenticatedTemplateProps' + name: UnauthenticatedTemplateProps + items: [] + - uid: '@azure/msal-react.WithMsalProps' + name: WithMsalProps + items: [] From b0201e79acada22fdfb888bd888764812f7e655a Mon Sep 17 00:00:00 2001 From: VSC-Service-Account Date: Thu, 9 May 2024 10:07:16 +0000 Subject: [PATCH 04/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=428515&view=results --- .../msal-browser/BrowserPerformanceClient.yml | 2 +- .../@azure/msal-browser/INetworkModule.yml | 5 ++-- .../msal-browser/IPublicClientApplication.yml | 15 +++++++++++ .../InteractionRequiredAuthError.yml | 19 ++++++++++++-- .../@azure/msal-browser/PerformanceEvent.yml | 3 +++ .../@azure/msal-browser/ServerError.yml | 20 ++++++++++++-- .../@azure/msal-common/BaseAuthRequest.yml | 3 +++ .../@azure/msal-common/ClientAssertion.yml | 5 +++- .../msal-common/ClientAssertionCallback.yml | 12 +++++++++ .../msal-common/ClientAssertionConfig.yml | 10 +++++++ .../msal-common/ClientAssertionUtils.yml | 6 +++++ .../@azure/msal-common/INetworkModule.yml | 5 ++-- .../InteractionRequiredAuthError.yml | 19 ++++++++++++-- .../@azure/msal-common/PerformanceClient.yml | 2 +- .../@azure/msal-common/PerformanceEvent.yml | 3 +++ .../ServerAuthorizationCodeResponse.yml | 1 + .../@azure/msal-common/ServerError.yml | 20 ++++++++++++-- .../@azure/msal-common/index.yml | 26 +++++++++++++++++++ .../msal-node/ClientAssertionCallback.yml | 12 +++++++++ .../msal-node/ClientCredentialRequest.yml | 7 ++--- .../@azure/msal-node/INetworkModule.yml | 5 ++-- .../InteractionRequiredAuthError.yml | 19 ++++++++++++-- .../@azure/msal-node/NodeAuthOptions.yml | 10 ++++--- .../ServerAuthorizationCodeResponse.yml | 1 + .../@azure/msal-node/ServerError.yml | 20 ++++++++++++-- .../@azure/msal-node/index.yml | 1 + msal/docs-ref-autogen/toc.yml | 12 +++++++++ 27 files changed, 232 insertions(+), 31 deletions(-) create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientAssertionCallback.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientAssertionConfig.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientAssertionUtils.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ClientAssertionCallback.yml diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml index 018ac52..ff5208f 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml @@ -94,7 +94,7 @@ inheritedMethods: - name: discardMeasurements(string) uid: '@azure/msal-browser.BrowserPerformanceClient.discardMeasurements' package: '@azure/msal-browser' - summary: Removes measurements for a given correlation id. + summary: Removes measurements and aux data for a given correlation id. remarks: '' isDeprecated: false syntax: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml b/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml index b7d5df8..4d024b8 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml @@ -19,8 +19,7 @@ methods: syntax: content: >- function sendGetRequestAsync(url: string, options?: - NetworkRequestOptions, cancellationToken?: number): - Promise> + NetworkRequestOptions, timeout?: number): Promise> parameters: - id: url type: string @@ -28,7 +27,7 @@ methods: - id: options type: description: '' - - id: cancellationToken + - id: timeout type: number description: '' return: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml index fbf178c..8c38ec6 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml @@ -139,6 +139,21 @@ methods: isDeprecated: false syntax: content: function enableAccountStorageEvents() + - name: getAccount(AccountFilter) + uid: '@azure/msal-browser.IPublicClientApplication.getAccount' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function getAccount(accountFilter: AccountFilter): null | AccountInfo' + parameters: + - id: accountFilter + type: + description: '' + return: + description: '' + type: null | - name: getAccountByHomeId(string) uid: '@azure/msal-browser.IPublicClientApplication.getAccountByHomeId' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml index c0ab087..146217a 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml @@ -10,7 +10,7 @@ type: class constructors: - name: >- InteractionRequiredAuthError(string, string, string, string, string, - string, string) + string, string, string) uid: '@azure/msal-browser.InteractionRequiredAuthError.constructor' package: '@azure/msal-browser' summary: '' @@ -20,7 +20,7 @@ constructors: content: >- new InteractionRequiredAuthError(errorCode?: string, errorMessage?: string, subError?: string, timestamp?: string, traceId?: string, - correlationId?: string, claims?: string) + correlationId?: string, claims?: string, errorNo?: string) parameters: - id: errorCode type: string @@ -43,6 +43,9 @@ constructors: - id: claims type: string description: '' + - id: errorNo + type: string + description: '' properties: - name: claims uid: '@azure/msal-browser.InteractionRequiredAuthError.claims' @@ -73,6 +76,18 @@ properties: return: description: '' type: string + - name: errorNo + uid: '@azure/msal-browser.InteractionRequiredAuthError.errorNo' + package: '@azure/msal-browser' + summary: Server error number; + fullName: errorNo + remarks: '' + isDeprecated: false + syntax: + content: 'errorNo?: string' + return: + description: '' + type: string - name: timestamp uid: '@azure/msal-browser.InteractionRequiredAuthError.timestamp' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml index 6b4d14b..27e6b2c 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml @@ -11,6 +11,7 @@ isDeprecated: false syntax: | type PerformanceEvent = { accessTokenSize?: number + accountType?: "AAD" | "MSA" | "B2C" allowNativeBroker?: boolean appName?: string appVersion?: string @@ -66,6 +67,8 @@ syntax: | queuedTimeMs?: number refreshTokenSize?: number requestId?: string + scenarioId?: string + serverErrorNo?: string startPageVisibility?: string | null startTimeMs: number status: PerformanceEventStatus diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml index 137c352..9f3442e 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml @@ -10,7 +10,7 @@ remarks: '' isDeprecated: false type: class constructors: - - name: ServerError(string, string, string) + - name: ServerError(string, string, string, string) uid: '@azure/msal-browser.ServerError.constructor' package: '@azure/msal-browser' summary: '' @@ -19,7 +19,7 @@ constructors: syntax: content: >- new ServerError(errorCode?: string, errorMessage?: string, subError?: - string) + string, errorNo?: string) parameters: - id: errorCode type: string @@ -30,6 +30,22 @@ constructors: - id: subError type: string description: '' + - id: errorNo + type: string + description: '' +properties: + - name: errorNo + uid: '@azure/msal-browser.ServerError.errorNo' + package: '@azure/msal-browser' + summary: Server error number; + fullName: errorNo + remarks: '' + isDeprecated: false + syntax: + content: 'errorNo?: string' + return: + description: '' + type: string inheritedProperties: - name: correlationId uid: '@azure/msal-browser.ServerError.correlationId' diff --git a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml index ba15366..8b17d78 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml @@ -56,6 +56,8 @@ summary: >- - storeInCache - Object containing boolean values indicating whether to store tokens in the cache or not (default is true) + + - scenarioId - Scenario id to track custom user prompts fullName: BaseAuthRequest remarks: '' isDeprecated: false @@ -70,6 +72,7 @@ syntax: | requestedClaimsHash?: string resourceRequestMethod?: string resourceRequestUri?: string + scenarioId?: string scopes: string[] shrClaims?: string shrNonce?: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml index 1580dd6..4aec72a 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml @@ -7,4 +7,7 @@ fullName: ClientAssertion remarks: '' isDeprecated: false syntax: | - type ClientAssertion = { assertion: string; assertionType: string } + type ClientAssertion = { + assertion: string | ClientAssertionCallback + assertionType: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionCallback.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionCallback.yml new file mode 100644 index 0000000..bd7b735 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionCallback.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ClientAssertionCallback +uid: '@azure/msal-common.ClientAssertionCallback' +package: '@azure/msal-common' +summary: '' +fullName: ClientAssertionCallback +remarks: '' +isDeprecated: false +syntax: | + type ClientAssertionCallback = ( + config: ClientAssertionConfig + ) => Promise diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionConfig.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionConfig.yml new file mode 100644 index 0000000..e0f88f3 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionConfig.yml @@ -0,0 +1,10 @@ +### YamlMime:TSTypeAlias +name: ClientAssertionConfig +uid: '@azure/msal-common.ClientAssertionConfig' +package: '@azure/msal-common' +summary: '' +fullName: ClientAssertionConfig +remarks: '' +isDeprecated: false +syntax: | + type ClientAssertionConfig = { clientId: string; tokenEndpoint?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionUtils.yml new file mode 100644 index 0000000..13cd3d4 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionUtils.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.ClientAssertionUtils' +name: ClientAssertionUtils +type: module +package: '@azure/msal-common' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml b/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml index b165996..af2f043 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml @@ -19,8 +19,7 @@ methods: syntax: content: >- function sendGetRequestAsync(url: string, options?: - NetworkRequestOptions, cancellationToken?: number): - Promise> + NetworkRequestOptions, timeout?: number): Promise> parameters: - id: url type: string @@ -28,7 +27,7 @@ methods: - id: options type: description: '' - - id: cancellationToken + - id: timeout type: number description: '' return: diff --git a/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml index 127e14d..be50005 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml @@ -10,7 +10,7 @@ type: class constructors: - name: >- InteractionRequiredAuthError(string, string, string, string, string, - string, string) + string, string, string) uid: '@azure/msal-common.InteractionRequiredAuthError.constructor' package: '@azure/msal-common' summary: '' @@ -20,7 +20,7 @@ constructors: content: >- new InteractionRequiredAuthError(errorCode?: string, errorMessage?: string, subError?: string, timestamp?: string, traceId?: string, - correlationId?: string, claims?: string) + correlationId?: string, claims?: string, errorNo?: string) parameters: - id: errorCode type: string @@ -43,6 +43,9 @@ constructors: - id: claims type: string description: '' + - id: errorNo + type: string + description: '' properties: - name: claims uid: '@azure/msal-common.InteractionRequiredAuthError.claims' @@ -73,6 +76,18 @@ properties: return: description: '' type: string + - name: errorNo + uid: '@azure/msal-common.InteractionRequiredAuthError.errorNo' + package: '@azure/msal-common' + summary: Server error number; + fullName: errorNo + remarks: '' + isDeprecated: false + syntax: + content: 'errorNo?: string' + return: + description: '' + type: string - name: timestamp uid: '@azure/msal-common.InteractionRequiredAuthError.timestamp' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml index 2feb54b..8bad25b 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml @@ -137,7 +137,7 @@ methods: - name: discardMeasurements(string) uid: '@azure/msal-common.PerformanceClient.discardMeasurements' package: '@azure/msal-common' - summary: Removes measurements for a given correlation id. + summary: Removes measurements and aux data for a given correlation id. remarks: '' isDeprecated: false syntax: diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml index 3607f45..7d0a40c 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -11,6 +11,7 @@ isDeprecated: false syntax: | type PerformanceEvent = { accessTokenSize?: number + accountType?: "AAD" | "MSA" | "B2C" allowNativeBroker?: boolean appName?: string appVersion?: string @@ -66,6 +67,8 @@ syntax: | queuedTimeMs?: number refreshTokenSize?: number requestId?: string + scenarioId?: string + serverErrorNo?: string startPageVisibility?: string | null startTimeMs: number status: PerformanceEventStatus diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml index db6a791..5322898 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml @@ -24,6 +24,7 @@ syntax: | correlation_id?: string error?: string error_description?: string + error_uri?: string msgraph_host?: string state?: string suberror?: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml index f6d6ace..5bf81cb 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml @@ -10,7 +10,7 @@ remarks: '' isDeprecated: false type: class constructors: - - name: ServerError(string, string, string) + - name: ServerError(string, string, string, string) uid: '@azure/msal-common.ServerError.constructor' package: '@azure/msal-common' summary: '' @@ -19,7 +19,7 @@ constructors: syntax: content: >- new ServerError(errorCode?: string, errorMessage?: string, subError?: - string) + string, errorNo?: string) parameters: - id: errorCode type: string @@ -30,6 +30,22 @@ constructors: - id: subError type: string description: '' + - id: errorNo + type: string + description: '' +properties: + - name: errorNo + uid: '@azure/msal-common.ServerError.errorNo' + package: '@azure/msal-common' + summary: Server error number; + fullName: errorNo + remarks: '' + isDeprecated: false + syntax: + content: 'errorNo?: string' + return: + description: '' + type: string inheritedProperties: - name: correlationId uid: '@azure/msal-common.ServerError.correlationId' diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml index 21e680f..eaac3af 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -63,6 +63,8 @@ typeAliases: - '@azure/msal-common.CcsCredentialType' - '@azure/msal-common.ClaimsRequestKeys' - '@azure/msal-common.ClientAssertion' + - '@azure/msal-common.ClientAssertionCallback' + - '@azure/msal-common.ClientAssertionConfig' - '@azure/msal-common.ClientInfo' - '@azure/msal-common.CommonAuthorizationCodeRequest' - '@azure/msal-common.CommonAuthorizationUrlRequest' @@ -339,6 +341,30 @@ functions: return: description: '' type: string + - name: getClientAssertion(string | ClientAssertionCallback, string, string) + uid: '@azure/msal-common.getClientAssertion' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getClientAssertion(clientAssertion: string | + ClientAssertionCallback, clientId: string, tokenEndpoint?: string): + Promise + parameters: + - id: clientAssertion + type: string | + description: '' + - id: clientId + type: string + description: '' + - id: tokenEndpoint + type: string + description: '' + return: + description: '' + type: Promise<string> - name: getTenantIdFromIdTokenClaims(TokenClaims) uid: '@azure/msal-common.getTenantIdFromIdTokenClaims' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientAssertionCallback.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientAssertionCallback.yml new file mode 100644 index 0000000..2440428 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientAssertionCallback.yml @@ -0,0 +1,12 @@ +### YamlMime:TSTypeAlias +name: ClientAssertionCallback +uid: '@azure/msal-node.ClientAssertionCallback' +package: '@azure/msal-node' +summary: '' +fullName: ClientAssertionCallback +remarks: '' +isDeprecated: false +syntax: | + type ClientAssertionCallback = ( + config: ClientAssertionConfig + ) => Promise diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml index cfe02c3..cd83273 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml @@ -19,8 +19,9 @@ summary: >- - skipCache - Skip token cache lookup and force request to authority to get a a new token. Defaults to false. - - clientAssertion - A Base64Url-encoded signed JWT assertion string - used in the Client Credential flow + - clientAssertion - An assertion string or a callback function that + returns an assertion string (both are Base64Url-encoded signed JWTs) used in + the Client Credential flow - tokenQueryParameters - String to string map of custom query parameters added to the /token call @@ -37,4 +38,4 @@ syntax: | | "clientAssertion" | "storeInCache" > - > & { clientAssertion?: string } + > & { clientAssertion?: string | ClientAssertionCallback } diff --git a/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml b/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml index 052e8b4..5288d8d 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml @@ -19,8 +19,7 @@ methods: syntax: content: >- function sendGetRequestAsync(url: string, options?: - NetworkRequestOptions, cancellationToken?: number): - Promise> + NetworkRequestOptions, timeout?: number): Promise> parameters: - id: url type: string @@ -28,7 +27,7 @@ methods: - id: options type: description: '' - - id: cancellationToken + - id: timeout type: number description: '' return: diff --git a/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml index 54334f7..1b1111a 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml @@ -10,7 +10,7 @@ type: class constructors: - name: >- InteractionRequiredAuthError(string, string, string, string, string, - string, string) + string, string, string) uid: '@azure/msal-node.InteractionRequiredAuthError.constructor' package: '@azure/msal-node' summary: '' @@ -20,7 +20,7 @@ constructors: content: >- new InteractionRequiredAuthError(errorCode?: string, errorMessage?: string, subError?: string, timestamp?: string, traceId?: string, - correlationId?: string, claims?: string) + correlationId?: string, claims?: string, errorNo?: string) parameters: - id: errorCode type: string @@ -43,6 +43,9 @@ constructors: - id: claims type: string description: '' + - id: errorNo + type: string + description: '' properties: - name: claims uid: '@azure/msal-node.InteractionRequiredAuthError.claims' @@ -73,6 +76,18 @@ properties: return: description: '' type: string + - name: errorNo + uid: '@azure/msal-node.InteractionRequiredAuthError.errorNo' + package: '@azure/msal-node' + summary: Server error number; + fullName: errorNo + remarks: '' + isDeprecated: false + syntax: + content: 'errorNo?: string' + return: + description: '' + type: string - name: timestamp uid: '@azure/msal-node.InteractionRequiredAuthError.timestamp' package: '@azure/msal-node' diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml index 6e560a2..e00076a 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml @@ -16,9 +16,11 @@ summary: >- requesting a token. Only used in confidential client applications. Can be created in the Azure app registration portal. - - clientAssertion - Assertion string that the application uses when - requesting a token. Only used in confidential client applications. Assertion - should be of type urn:ietf:params:oauth:client-assertion-type:jwt-bearer. + - clientAssertion - A ClientAssertion object containing an assertion + string or a callback function that returns an assertion string that the + application uses when requesting a token, as well as the assertion's type + (urn:ietf:params:oauth:client-assertion-type:jwt-bearer). Only used in + confidential client applications. - clientCertificate - Certificate that the application uses when requesting a token. Only used in confidential client applications. Requires @@ -39,7 +41,7 @@ syntax: | authority?: string authorityMetadata?: string azureCloudOptions?: AzureCloudOptions - clientAssertion?: string + clientAssertion?: string | ClientAssertionCallback clientCapabilities?: string[] clientCertificate?: { privateKey: string; thumbprint: string; x5c?: string } clientId: string diff --git a/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml index ee65229..9a9a712 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml @@ -24,6 +24,7 @@ syntax: | correlation_id?: string error?: string error_description?: string + error_uri?: string msgraph_host?: string state?: string suberror?: string diff --git a/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml index b4232ba..b8e59f2 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml @@ -10,7 +10,7 @@ remarks: '' isDeprecated: false type: class constructors: - - name: ServerError(string, string, string) + - name: ServerError(string, string, string, string) uid: '@azure/msal-node.ServerError.constructor' package: '@azure/msal-node' summary: '' @@ -19,7 +19,7 @@ constructors: syntax: content: >- new ServerError(errorCode?: string, errorMessage?: string, subError?: - string) + string, errorNo?: string) parameters: - id: errorCode type: string @@ -30,6 +30,22 @@ constructors: - id: subError type: string description: '' + - id: errorNo + type: string + description: '' +properties: + - name: errorNo + uid: '@azure/msal-node.ServerError.errorNo' + package: '@azure/msal-node' + summary: Server error number; + fullName: errorNo + remarks: '' + isDeprecated: false + syntax: + content: 'errorNo?: string' + return: + description: '' + type: string inheritedProperties: - name: correlationId uid: '@azure/msal-node.ServerError.correlationId' diff --git a/msal/docs-ref-autogen/@azure/msal-node/index.yml b/msal/docs-ref-autogen/@azure/msal-node/index.yml index 7595489..cec3943 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/index.yml @@ -53,6 +53,7 @@ typeAliases: - '@azure/msal-node.BrokerOptions' - '@azure/msal-node.CacheKVStore' - '@azure/msal-node.CacheOptions' + - '@azure/msal-node.ClientAssertionCallback' - '@azure/msal-node.ClientCredentialRequest' - '@azure/msal-node.Configuration' - '@azure/msal-node.DeviceCodeRequest' diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml index aa82032..5a5a86a 100644 --- a/msal/docs-ref-autogen/toc.yml +++ b/msal/docs-ref-autogen/toc.yml @@ -412,6 +412,15 @@ - uid: '@azure/msal-common.ClientAssertion' name: ClientAssertion items: [] + - uid: '@azure/msal-common.ClientAssertionCallback' + name: ClientAssertionCallback + items: [] + - uid: '@azure/msal-common.ClientAssertionConfig' + name: ClientAssertionConfig + items: [] + - uid: '@azure/msal-common.ClientAssertionUtils' + name: ClientAssertionUtils + items: [] - uid: '@azure/msal-common.ClientAuthError' name: ClientAuthError items: [] @@ -731,6 +740,9 @@ - uid: '@azure/msal-node.ClientAssertion' name: ClientAssertion items: [] + - uid: '@azure/msal-node.ClientAssertionCallback' + name: ClientAssertionCallback + items: [] - uid: '@azure/msal-node.ClientAuthError' name: ClientAuthError items: [] From 8cee9b3a510edd6d9315317ec9e093e68a727445 Mon Sep 17 00:00:00 2001 From: VSC-Service-Account Date: Thu, 30 May 2024 10:03:28 +0000 Subject: [PATCH 05/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=432066&view=results --- .../@azure/msal-browser/PublicClientNext.yml | 6 +++ .../@azure/msal-browser/index.yml | 44 +++++++++++++++++++ .../msal-node/ManagedIdentityApplication.yml | 13 ++++++ .../msal-node/ManagedIdentitySourceNames.yml | 11 +++++ .../@azure/msal-node/index.yml | 1 + msal/docs-ref-autogen/toc.yml | 3 ++ 6 files changed, 78 insertions(+) create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ManagedIdentitySourceNames.yml diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml index 7ac4d0a..033b234 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml @@ -15,6 +15,12 @@ summary: >- old Browser, etc.) while still providing a consistent API surface for developers. + + + Please use PublicClientApplication for any prod/real-world scenarios. + + Note: PublicClientNext is experimental and subject to breaking changes without + following semver fullName: PublicClientNext remarks: '' isDeprecated: false diff --git a/msal/docs-ref-autogen/@azure/msal-browser/index.yml b/msal/docs-ref-autogen/@azure/msal-browser/index.yml index 758953b..f0ce004 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/index.yml @@ -84,3 +84,47 @@ typeAliases: - '@azure/msal-browser.SsoSilentRequest' - '@azure/msal-browser.TenantProfile' - '@azure/msal-browser.WrapperSKU' +functions: + - name: createNestablePublicClientApplication(Configuration) + uid: '@azure/msal-browser.createNestablePublicClientApplication' + package: '@azure/msal-browser' + summary: >- + creates NestedAppAuthController and passes it to the + PublicClientApplication, + + falls back to StandardController if NestedAppAuthController is not + available + remarks: '' + isDeprecated: false + syntax: + content: >- + function createNestablePublicClientApplication(configuration: + Configuration): Promise + parameters: + - id: configuration + type: + description: '' + return: + description: IPublicClientApplication + type: >- + Promise<> + - name: createStandardPublicClientApplication(Configuration) + uid: '@azure/msal-browser.createStandardPublicClientApplication' + package: '@azure/msal-browser' + summary: creates PublicClientApplication using StandardController + remarks: '' + isDeprecated: false + syntax: + content: >- + function createStandardPublicClientApplication(configuration: + Configuration): Promise + parameters: + - id: configuration + type: + description: '' + return: + description: IPublicClientApplication + type: >- + Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityApplication.yml index c8d074c..77abd28 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityApplication.yml @@ -40,3 +40,16 @@ methods: return: description: the access token type: Promise<> + - name: getManagedIdentitySource() + uid: '@azure/msal-node.ManagedIdentityApplication.getManagedIdentitySource' + package: '@azure/msal-node' + summary: >- + Determine the Managed Identity Source based on available environment + variables. This API is consumed by Azure Identity SDK. + remarks: '' + isDeprecated: false + syntax: + content: 'function getManagedIdentitySource(): ManagedIdentitySourceNames' + return: + description: ManagedIdentitySourceNames - The Managed Identity source's name + type: ManagedIdentitySourceNames diff --git a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentitySourceNames.yml b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentitySourceNames.yml new file mode 100644 index 0000000..ec51089 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentitySourceNames.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: ManagedIdentitySourceNames +uid: '@azure/msal-node.ManagedIdentitySourceNames' +package: '@azure/msal-node' +summary: The ManagedIdentitySourceNames type +fullName: ManagedIdentitySourceNames +remarks: '' +isDeprecated: false +syntax: | + type ManagedIdentitySourceNames = + (typeof ManagedIdentitySourceNames)[keyof typeof ManagedIdentitySourceNames] diff --git a/msal/docs-ref-autogen/@azure/msal-node/index.yml b/msal/docs-ref-autogen/@azure/msal-node/index.yml index cec3943..2aa8855 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/index.yml @@ -64,6 +64,7 @@ typeAliases: - '@azure/msal-node.ManagedIdentityConfiguration' - '@azure/msal-node.ManagedIdentityIdParams' - '@azure/msal-node.ManagedIdentityRequestParams' + - '@azure/msal-node.ManagedIdentitySourceNames' - '@azure/msal-node.NetworkRequestOptions' - '@azure/msal-node.NetworkResponse' - '@azure/msal-node.NodeAuthOptions' diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml index 5a5a86a..5a13633 100644 --- a/msal/docs-ref-autogen/toc.yml +++ b/msal/docs-ref-autogen/toc.yml @@ -858,6 +858,9 @@ - uid: '@azure/msal-node.ManagedIdentityRequestParams' name: ManagedIdentityRequestParams items: [] + - uid: '@azure/msal-node.ManagedIdentitySourceNames' + name: ManagedIdentitySourceNames + items: [] - uid: '@azure/msal-node.NetworkRequestOptions' name: NetworkRequestOptions items: [] From 18e701125cf0b7eb9386b1123933e0530f297eca Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Thu, 6 Jun 2024 10:03:05 +0000 Subject: [PATCH 06/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=433398&view=results --- .../@azure/msal-browser/PerformanceEvents.yml | 10 +++++++++- .../@azure/msal-common/PerformanceEvents.yml | 10 +++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml index d8ecfc4..f2b1d75 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -55,12 +55,20 @@ fields: summary: |- acquireTokenPopup (msal-browser). Used to acquire a new access token interactively through pop ups + - name: AcquireTokenPreRedirect + uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenPreRedirect' + package: '@azure/msal-browser' + summary: |- + acquireTokenPreRedirect (msal-browser). + First part of the redirect flow. + Used to acquire a new access token interactively through redirects. - name: AcquireTokenRedirect uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenRedirect' package: '@azure/msal-browser' summary: |- acquireTokenRedirect (msal-browser). - Used to acquire a new access token interactively through redirects + Second part of the redirect flow. + Used to acquire a new access token interactively through redirects. - name: AcquireTokenSilent uid: '@azure/msal-browser.PerformanceEvents.AcquireTokenSilent' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml index 5846661..a94a1ff 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml @@ -55,12 +55,20 @@ fields: summary: |- acquireTokenPopup (msal-browser). Used to acquire a new access token interactively through pop ups + - name: AcquireTokenPreRedirect + uid: '@azure/msal-common.PerformanceEvents.AcquireTokenPreRedirect' + package: '@azure/msal-common' + summary: |- + acquireTokenPreRedirect (msal-browser). + First part of the redirect flow. + Used to acquire a new access token interactively through redirects. - name: AcquireTokenRedirect uid: '@azure/msal-common.PerformanceEvents.AcquireTokenRedirect' package: '@azure/msal-common' summary: |- acquireTokenRedirect (msal-browser). - Used to acquire a new access token interactively through redirects + Second part of the redirect flow. + Used to acquire a new access token interactively through redirects. - name: AcquireTokenSilent uid: '@azure/msal-common.PerformanceEvents.AcquireTokenSilent' package: '@azure/msal-common' From 36ccbcb466b5e2a8ebe8cb488a1ffca4810b4eac Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Thu, 13 Jun 2024 10:04:29 +0000 Subject: [PATCH 07/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=434476&view=results --- .../@azure/msal-common/BaseAuthRequest.yml | 4 +++ .../@azure/msal-common/ICrypto.yml | 30 +++++++++++++++++++ .../@azure/msal-node/CryptoProvider.yml | 22 ++++++++++++++ 3 files changed, 56 insertions(+) diff --git a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml index 8b17d78..dab56cc 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml @@ -58,6 +58,9 @@ summary: >- whether to store tokens in the cache or not (default is true) - scenarioId - Scenario id to track custom user prompts + + - popKid - Key ID to identify the public key for PoP token + request fullName: BaseAuthRequest remarks: '' isDeprecated: false @@ -69,6 +72,7 @@ syntax: | claims?: string correlationId: string maxAge?: number + popKid?: string requestedClaimsHash?: string resourceRequestMethod?: string resourceRequestUri?: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml b/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml index f62da7e..d557426 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml @@ -38,6 +38,21 @@ methods: return: description: '' type: string + - name: base64UrlEncode(string) + uid: '@azure/msal-common.ICrypto.base64UrlEncode' + package: '@azure/msal-common' + summary: base64 URL safe encoded string + remarks: '' + isDeprecated: false + syntax: + content: 'function base64UrlEncode(input: string): string' + parameters: + - id: input + type: string + description: '' + return: + description: '' + type: string - name: clearKeystore() uid: '@azure/msal-common.ICrypto.clearKeystore' package: '@azure/msal-common' @@ -60,6 +75,21 @@ methods: return: description: '' type: string + - name: encodeKid(string) + uid: '@azure/msal-common.ICrypto.encodeKid' + package: '@azure/msal-common' + summary: Stringifies and base64Url encodes input public key + remarks: '' + isDeprecated: false + syntax: + content: 'function encodeKid(inputKid: string): string' + parameters: + - id: inputKid + type: string + description: '' + return: + description: Base64Url encoded public key + type: string - name: getPublicKeyThumbprint(SignedHttpRequestParameters) uid: '@azure/msal-common.ICrypto.getPublicKeyThumbprint' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml b/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml index 2d00daf..90ab658 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml @@ -43,6 +43,17 @@ methods: return: description: '' type: string + - name: base64UrlEncode() + uid: '@azure/msal-node.CryptoProvider.base64UrlEncode' + package: '@azure/msal-node' + summary: base64 URL safe encoded string + remarks: '' + isDeprecated: false + syntax: + content: 'function base64UrlEncode(): string' + return: + description: '' + type: string - name: clearKeystore() uid: '@azure/msal-node.CryptoProvider.clearKeystore' package: '@azure/msal-node' @@ -65,6 +76,17 @@ methods: return: description: string (GUID) type: string + - name: encodeKid() + uid: '@azure/msal-node.CryptoProvider.encodeKid' + package: '@azure/msal-node' + summary: Stringifies and base64Url encodes input public key + remarks: '' + isDeprecated: false + syntax: + content: 'function encodeKid(): string' + return: + description: Base64Url encoded public key + type: string - name: generatePkceCodes() uid: '@azure/msal-node.CryptoProvider.generatePkceCodes' package: '@azure/msal-node' From 6155303d6153a3c7d7febd66e37a82ea1ca5b983 Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Thu, 18 Jul 2024 10:04:58 +0000 Subject: [PATCH 08/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=439916&view=results --- .../msal-browser/ExternalTokenResponse.yml | 9 ++++- .../@azure/msal-browser/IController.yml | 10 ++++-- .../msal-browser/IPublicClientApplication.yml | 10 ++++-- .../InitializeApplicationRequest.yml | 16 +++++++++ .../msal-browser/PublicClientApplication.yml | 14 +++++--- .../@azure/msal-browser/ServerError.yml | 19 ++++++++-- .../@azure/msal-browser/index.yml | 1 + .../msal-common/ExternalTokenResponse.yml | 9 ++++- .../@azure/msal-common/ServerError.yml | 19 ++++++++-- .../@azure/msal-common/index.yml | 36 +++++++++++-------- .../@azure/msal-node/ClientAssertion.yml | 34 ++++++++++++++++-- .../@azure/msal-node/NodeAuthOptions.yml | 13 ++++--- .../@azure/msal-node/ServerError.yml | 19 ++++++++-- msal/docs-ref-autogen/toc.yml | 3 ++ 14 files changed, 175 insertions(+), 37 deletions(-) create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InitializeApplicationRequest.yml diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml b/msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml index c6698bb..d8cc8ec 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml @@ -28,5 +28,12 @@ isDeprecated: false syntax: | type ExternalTokenResponse = Pick< ServerAuthorizationTokenResponse, - "token_type" | "scope" | "expires_in" | "id_token" | "refresh_token" + | "token_type" + | "scope" + | "expires_in" + | "ext_expires_in" + | "id_token" + | "refresh_token" + | "refresh_token_expires_in" + | "foci" > & { access_token?: string; client_info?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml index e2a45b6..2afc788 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml @@ -322,14 +322,20 @@ methods: return: description: '' type: Promise<void> - - name: initialize() + - name: initialize(InitializeApplicationRequest) uid: '@azure/msal-browser.IController.initialize' package: '@azure/msal-browser' summary: '' remarks: '' isDeprecated: false syntax: - content: 'function initialize(): Promise' + content: >- + function initialize(request?: InitializeApplicationRequest): + Promise + parameters: + - id: request + type: + description: '' return: description: '' type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml index 8c38ec6..43f8d07 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml @@ -289,14 +289,20 @@ methods: return: description: '' type: Promise<void> - - name: initialize() + - name: initialize(InitializeApplicationRequest) uid: '@azure/msal-browser.IPublicClientApplication.initialize' package: '@azure/msal-browser' summary: '' remarks: '' isDeprecated: false syntax: - content: 'function initialize(): Promise' + content: >- + function initialize(request?: InitializeApplicationRequest): + Promise + parameters: + - id: request + type: + description: '' return: description: '' type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/InitializeApplicationRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/InitializeApplicationRequest.yml new file mode 100644 index 0000000..b49020c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/InitializeApplicationRequest.yml @@ -0,0 +1,16 @@ +### YamlMime:TSTypeAlias +name: InitializeApplicationRequest +uid: '@azure/msal-browser.InitializeApplicationRequest' +package: '@azure/msal-browser' +summary: >- + InitializeApplicationRequest: Request object passed by user to initialize + application + + + - correlationId - Unique GUID set per request to trace a request + end-to-end for telemetry purposes. +fullName: InitializeApplicationRequest +remarks: '' +isDeprecated: false +syntax: | + type InitializeApplicationRequest = { correlationId?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml index e9ed0a8..03ec4b5 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -187,7 +187,7 @@ methods: - name: createPublicClientApplication(Configuration) uid: '@azure/msal-browser.PublicClientApplication.createPublicClientApplication' package: '@azure/msal-browser' - summary: '' + summary: Creates StandardController and passes it to the PublicClientApplication remarks: '' isDeprecated: false syntax: @@ -197,7 +197,7 @@ methods: parameters: - id: configuration type: - description: '' + description: '{Configuration}' return: description: '' type: >- @@ -414,7 +414,7 @@ methods: return: description: '' type: Promise<void> - - name: initialize() + - name: initialize(InitializeApplicationRequest) uid: '@azure/msal-browser.PublicClientApplication.initialize' package: '@azure/msal-browser' summary: >- @@ -423,7 +423,13 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function initialize(): Promise' + content: >- + function initialize(request?: InitializeApplicationRequest): + Promise + parameters: + - id: request + type: + description: '{?InitializeApplicationRequest}' return: description: '' type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml index 9f3442e..39f67f0 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml @@ -10,7 +10,7 @@ remarks: '' isDeprecated: false type: class constructors: - - name: ServerError(string, string, string, string) + - name: ServerError(string, string, string, string, number) uid: '@azure/msal-browser.ServerError.constructor' package: '@azure/msal-browser' summary: '' @@ -19,7 +19,7 @@ constructors: syntax: content: >- new ServerError(errorCode?: string, errorMessage?: string, subError?: - string, errorNo?: string) + string, errorNo?: string, status?: number) parameters: - id: errorCode type: string @@ -33,6 +33,9 @@ constructors: - id: errorNo type: string description: '' + - id: status + type: number + description: '' properties: - name: errorNo uid: '@azure/msal-browser.ServerError.errorNo' @@ -46,6 +49,18 @@ properties: return: description: '' type: string + - name: status + uid: '@azure/msal-browser.ServerError.status' + package: '@azure/msal-browser' + summary: Http status number; + fullName: status + remarks: '' + isDeprecated: false + syntax: + content: 'status?: number' + return: + description: '' + type: number inheritedProperties: - name: correlationId uid: '@azure/msal-browser.ServerError.correlationId' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/index.yml b/msal/docs-ref-autogen/@azure/msal-browser/index.yml index f0ce004..35d6e1a 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/index.yml @@ -63,6 +63,7 @@ typeAliases: - '@azure/msal-browser.ExternalTokenResponse' - '@azure/msal-browser.IdTokenClaims' - '@azure/msal-browser.InProgressPerformanceEvent' + - '@azure/msal-browser.InitializeApplicationRequest' - '@azure/msal-browser.InteractionStatus' - '@azure/msal-browser.JsonWebTokenTypes' - '@azure/msal-browser.LoadTokenOptions' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml index 17dd107..425a073 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml @@ -28,5 +28,12 @@ isDeprecated: false syntax: | type ExternalTokenResponse = Pick< ServerAuthorizationTokenResponse, - "token_type" | "scope" | "expires_in" | "id_token" | "refresh_token" + | "token_type" + | "scope" + | "expires_in" + | "ext_expires_in" + | "id_token" + | "refresh_token" + | "refresh_token_expires_in" + | "foci" > & { access_token?: string; client_info?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml index 5bf81cb..9140d0d 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml @@ -10,7 +10,7 @@ remarks: '' isDeprecated: false type: class constructors: - - name: ServerError(string, string, string, string) + - name: ServerError(string, string, string, string, number) uid: '@azure/msal-common.ServerError.constructor' package: '@azure/msal-common' summary: '' @@ -19,7 +19,7 @@ constructors: syntax: content: >- new ServerError(errorCode?: string, errorMessage?: string, subError?: - string, errorNo?: string) + string, errorNo?: string, status?: number) parameters: - id: errorCode type: string @@ -33,6 +33,9 @@ constructors: - id: errorNo type: string description: '' + - id: status + type: number + description: '' properties: - name: errorNo uid: '@azure/msal-common.ServerError.errorNo' @@ -46,6 +49,18 @@ properties: return: description: '' type: string + - name: status + uid: '@azure/msal-common.ServerError.status' + package: '@azure/msal-common' + summary: Http status number; + fullName: status + remarks: '' + isDeprecated: false + syntax: + content: 'status?: number' + return: + description: '' + type: number inheritedProperties: - name: correlationId uid: '@azure/msal-common.ServerError.correlationId' diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml index eaac3af..9ce8222 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -125,8 +125,8 @@ typeAliases: - '@azure/msal-common.UrlToHttpRequestOptions' functions: - name: >- - buildAccountToCache(CacheManager, Authority, string, TokenClaims, (input: - string) => string, string, string, null | string, + buildAccountToCache(CacheManager, Authority, string, (input: string) => + string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger) uid: '@azure/msal-common.buildAccountToCache' package: '@azure/msal-common' @@ -136,9 +136,9 @@ functions: syntax: content: >- function buildAccountToCache(cacheStorage: CacheManager, authority: - Authority, homeAccountId: string, idTokenClaims: TokenClaims, - base64Decode: (input: string) => string, clientInfo?: string, - environment?: string, claimsTenantId?: null | string, authCodePayload?: + Authority, homeAccountId: string, base64Decode: (input: string) => + string, idTokenClaims?: TokenClaims, clientInfo?: string, environment?: + string, claimsTenantId?: null | string, authCodePayload?: AuthorizationCodePayload, nativeAccountId?: string, logger?: Logger): AccountEntity parameters: @@ -151,12 +151,12 @@ functions: - id: homeAccountId type: string description: '' - - id: idTokenClaims - type: - description: '' - id: base64Decode type: '(input: string) => string' description: '' + - id: idTokenClaims + type: + description: '' - id: clientInfo type: string description: '' @@ -232,23 +232,29 @@ functions: return: description: '' type: - - name: buildTenantProfileFromIdTokenClaims(string, TokenClaims) - uid: '@azure/msal-common.buildTenantProfileFromIdTokenClaims' + - name: buildTenantProfile(string, string, string, TokenClaims) + uid: '@azure/msal-common.buildTenantProfile' package: '@azure/msal-common' - summary: '' + summary: Build tenant profile remarks: '' isDeprecated: false syntax: content: >- - function buildTenantProfileFromIdTokenClaims(homeAccountId: string, - idTokenClaims: TokenClaims): TenantProfile + function buildTenantProfile(homeAccountId: string, localAccountId: + string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile parameters: - id: homeAccountId type: string - description: '' + description: Home account identifier for this account object + - id: localAccountId + type: string + description: Local account identifer for this account object + - id: tenantId + type: string + description: Full tenant or organizational id that this account belongs to - id: idTokenClaims type: - description: '' + description: Claims from the ID token return: description: '' type: diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml index 2c39026..cd8f368 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml @@ -28,6 +28,36 @@ methods: - name: fromCertificate(string, string, string) uid: '@azure/msal-node.ClientAssertion.fromCertificate' package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: true + customDeprecatedMessage: >- + Use fromCertificateWithSha256Thumbprint instead, with a SHA-256 thumprint + + Initialize the ClientAssertion class from the certificate passed by the + user + syntax: + content: >- + static function fromCertificate(thumbprint: string, privateKey: string, + publicCertificate?: string): ClientAssertion + parameters: + - id: thumbprint + type: string + description: identifier of a certificate + - id: privateKey + type: string + description: secret key + - id: publicCertificate + type: string + description: >- + electronic document provided to prove the ownership of the public + key + return: + description: '' + type: + - name: fromCertificateWithSha256Thumbprint(string, string, string) + uid: '@azure/msal-node.ClientAssertion.fromCertificateWithSha256Thumbprint' + package: '@azure/msal-node' summary: >- Initialize the ClientAssertion class from the certificate passed by the user @@ -35,8 +65,8 @@ methods: isDeprecated: false syntax: content: >- - static function fromCertificate(thumbprint: string, privateKey: string, - publicCertificate?: string): ClientAssertion + static function fromCertificateWithSha256Thumbprint(thumbprint: string, + privateKey: string, publicCertificate?: string): ClientAssertion parameters: - id: thumbprint type: string diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml index e00076a..4386638 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml @@ -24,9 +24,9 @@ summary: >- - clientCertificate - Certificate that the application uses when requesting a token. Only used in confidential client applications. Requires - hex encoded X.509 SHA-1 thumbprint of the certificiate, and the PEM encoded - private key (string should contain -----BEGIN PRIVATE KEY----- ... -----END - PRIVATE KEY----- ) + hex encoded X.509 SHA-1 or SHA-256 thumbprint of the certificate, and the PEM + encoded private key (string should contain -----BEGIN PRIVATE KEY----- ... + -----END PRIVATE KEY----- ) - protocolMode - Enum that represents the protocol that msal follows. Used for configuring proper endpoints. @@ -43,7 +43,12 @@ syntax: | azureCloudOptions?: AzureCloudOptions clientAssertion?: string | ClientAssertionCallback clientCapabilities?: string[] - clientCertificate?: { privateKey: string; thumbprint: string; x5c?: string } + clientCertificate?: { + privateKey: string + thumbprint?: string + thumbprintSha256?: string + x5c?: string + } clientId: string clientSecret?: string cloudDiscoveryMetadata?: string diff --git a/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml index b8e59f2..470fc39 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml @@ -10,7 +10,7 @@ remarks: '' isDeprecated: false type: class constructors: - - name: ServerError(string, string, string, string) + - name: ServerError(string, string, string, string, number) uid: '@azure/msal-node.ServerError.constructor' package: '@azure/msal-node' summary: '' @@ -19,7 +19,7 @@ constructors: syntax: content: >- new ServerError(errorCode?: string, errorMessage?: string, subError?: - string, errorNo?: string) + string, errorNo?: string, status?: number) parameters: - id: errorCode type: string @@ -33,6 +33,9 @@ constructors: - id: errorNo type: string description: '' + - id: status + type: number + description: '' properties: - name: errorNo uid: '@azure/msal-node.ServerError.errorNo' @@ -46,6 +49,18 @@ properties: return: description: '' type: string + - name: status + uid: '@azure/msal-node.ServerError.status' + package: '@azure/msal-node' + summary: Http status number; + fullName: status + remarks: '' + isDeprecated: false + syntax: + content: 'status?: number' + return: + description: '' + type: number inheritedProperties: - name: correlationId uid: '@azure/msal-node.ServerError.correlationId' diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml index 5a13633..62ccbc7 100644 --- a/msal/docs-ref-autogen/toc.yml +++ b/msal/docs-ref-autogen/toc.yml @@ -183,6 +183,9 @@ - uid: '@azure/msal-browser.INetworkModule' name: INetworkModule items: [] + - uid: '@azure/msal-browser.InitializeApplicationRequest' + name: InitializeApplicationRequest + items: [] - uid: '@azure/msal-browser.InProgressPerformanceEvent' name: InProgressPerformanceEvent items: [] From 5cc9a8b83dce5c17110706373f9f3549d4aef13f Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Thu, 25 Jul 2024 10:04:57 +0000 Subject: [PATCH 09/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=441339&view=results --- .../@azure/msal-common/ServerTelemetryEntity.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml index 889b47f..0c17c35 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml @@ -11,4 +11,5 @@ syntax: | cacheHits: number errors: string[] failedRequests: (string | number)[] + nativeBrokerErrorCode?: string } From 14487d9ae631bd332c67589380d5285cbd513042 Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Thu, 15 Aug 2024 10:03:23 +0000 Subject: [PATCH 10/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=447959&view=results --- .../@azure/msal-browser/BrowserAuthOptions.yml | 1 + .../docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml | 1 + .../@azure/msal-browser/PerformanceEvents.yml | 4 ++++ msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml | 1 + .../docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml | 4 ++++ 5 files changed, 11 insertions(+) diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml index 5efd561..722a778 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml @@ -17,6 +17,7 @@ syntax: | cloudDiscoveryMetadata?: string knownAuthorities?: string[] navigateToLoginRequestUrl?: boolean + onRedirectNavigate?: (url: string) => boolean | void postLogoutRedirectUri?: string | null protocolMode?: ProtocolMode redirectUri?: string diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml index 27e6b2c..fadf25a 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml @@ -67,6 +67,7 @@ syntax: | queuedTimeMs?: number refreshTokenSize?: number requestId?: string + retryError?: string scenarioId?: string serverErrorNo?: string startPageVisibility?: string | null diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml index f2b1d75..9060a1d 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -278,6 +278,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.PopTokenGenerateKid' package: '@azure/msal-browser' summary: '' + - name: PopupClientTokenHelper + uid: '@azure/msal-browser.PerformanceEvents.PopupClientTokenHelper' + package: '@azure/msal-browser' + summary: Helper function in PopupClient class (msal-browser). - name: RefreshTokenClientAcquireToken uid: '@azure/msal-browser.PerformanceEvents.RefreshTokenClientAcquireToken' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml index 7d0a40c..e810e96 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -67,6 +67,7 @@ syntax: | queuedTimeMs?: number refreshTokenSize?: number requestId?: string + retryError?: string scenarioId?: string serverErrorNo?: string startPageVisibility?: string | null diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml index a94a1ff..cf6b650 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml @@ -277,6 +277,10 @@ fields: uid: '@azure/msal-common.PerformanceEvents.PopTokenGenerateKid' package: '@azure/msal-common' summary: '' + - name: PopupClientTokenHelper + uid: '@azure/msal-common.PerformanceEvents.PopupClientTokenHelper' + package: '@azure/msal-common' + summary: Helper function in PopupClient class (msal-browser). - name: RefreshTokenClientAcquireToken uid: '@azure/msal-common.PerformanceEvents.RefreshTokenClientAcquireToken' package: '@azure/msal-common' From c5e5bf494039b5d10572d12a624f431636a7fb34 Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Thu, 29 Aug 2024 10:04:29 +0000 Subject: [PATCH 11/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=451793&view=results --- .../@azure/msal-browser/PerformanceEvents.yml | 4 ---- .../docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml | 4 ---- 2 files changed, 8 deletions(-) diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml index 9060a1d..f2b1d75 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -278,10 +278,6 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.PopTokenGenerateKid' package: '@azure/msal-browser' summary: '' - - name: PopupClientTokenHelper - uid: '@azure/msal-browser.PerformanceEvents.PopupClientTokenHelper' - package: '@azure/msal-browser' - summary: Helper function in PopupClient class (msal-browser). - name: RefreshTokenClientAcquireToken uid: '@azure/msal-browser.PerformanceEvents.RefreshTokenClientAcquireToken' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml index cf6b650..a94a1ff 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml @@ -277,10 +277,6 @@ fields: uid: '@azure/msal-common.PerformanceEvents.PopTokenGenerateKid' package: '@azure/msal-common' summary: '' - - name: PopupClientTokenHelper - uid: '@azure/msal-common.PerformanceEvents.PopupClientTokenHelper' - package: '@azure/msal-common' - summary: Helper function in PopupClient class (msal-browser). - name: RefreshTokenClientAcquireToken uid: '@azure/msal-common.PerformanceEvents.RefreshTokenClientAcquireToken' package: '@azure/msal-common' From 60baa503ac8b25f43cdc81e14382fd48cf0b8c6d Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Thu, 26 Sep 2024 10:04:14 +0000 Subject: [PATCH 12/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=461392&view=results --- .../msal-browser/BrowserAuthOptions.yml | 1 + .../msal-browser/EndSessionPopupRequest.yml | 4 +++ .../@azure/msal-browser/PopupRequest.yml | 4 +++ .../msal-common/ClientAssertionUtils.yml | 25 +++++++++++++++++++ .../@azure/msal-common/index.yml | 24 ------------------ 5 files changed, 34 insertions(+), 24 deletions(-) diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml index 722a778..da431d0 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml @@ -15,6 +15,7 @@ syntax: | clientCapabilities?: string[] clientId: string cloudDiscoveryMetadata?: string + instanceAware?: boolean knownAuthorities?: string[] navigateToLoginRequestUrl?: boolean onRedirectNavigate?: (url: string) => boolean | void diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml index ca5a0da..7e438ad 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml @@ -27,6 +27,9 @@ summary: >- - logoutHint - A string that specifies the account that is being logged out in order to skip the server account picker on logout + + - popupWindowParent - Optional window object to use as the parent when + opening popup windows. Uses global `window` if not given. fullName: EndSessionPopupRequest remarks: '' isDeprecated: false @@ -37,4 +40,5 @@ syntax: | authority?: string mainWindowRedirectUri?: string popupWindowAttributes?: PopupWindowAttributes + popupWindowParent?: Window } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml index 633beaf..184a757 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml @@ -71,6 +71,9 @@ summary: >- - popupWindowAttributes - Optional popup window attributes. popupSize with height and width, and popupPosition with top and left can be set. + + - popupWindowParent - Optional window object to use as the parent + when opening popup windows. Uses global `window` if not given. fullName: PopupRequest remarks: '' isDeprecated: false @@ -87,6 +90,7 @@ syntax: | > > & { popupWindowAttributes?: PopupWindowAttributes + popupWindowParent?: Window scopes: string[] tokenBodyParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionUtils.yml index 13cd3d4..0685d60 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionUtils.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionUtils.yml @@ -4,3 +4,28 @@ name: ClientAssertionUtils type: module package: '@azure/msal-common' summary: '' +functions: + - name: getClientAssertion(string | ClientAssertionCallback, string, string) + uid: '@azure/msal-common.ClientAssertionUtils.getClientAssertion' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getClientAssertion(clientAssertion: string | + ClientAssertionCallback, clientId: string, tokenEndpoint?: string): + Promise + parameters: + - id: clientAssertion + type: string | + description: '' + - id: clientId + type: string + description: '' + - id: tokenEndpoint + type: string + description: '' + return: + description: '' + type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml index 9ce8222..7ca6ba9 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -347,30 +347,6 @@ functions: return: description: '' type: string - - name: getClientAssertion(string | ClientAssertionCallback, string, string) - uid: '@azure/msal-common.getClientAssertion' - package: '@azure/msal-common' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function getClientAssertion(clientAssertion: string | - ClientAssertionCallback, clientId: string, tokenEndpoint?: string): - Promise - parameters: - - id: clientAssertion - type: string | - description: '' - - id: clientId - type: string - description: '' - - id: tokenEndpoint - type: string - description: '' - return: - description: '' - type: Promise<string> - name: getTenantIdFromIdTokenClaims(TokenClaims) uid: '@azure/msal-common.getTenantIdFromIdTokenClaims' package: '@azure/msal-common' From b7786f696539edbe0af55ad666c96bcf51689d1e Mon Sep 17 00:00:00 2001 From: "apexvss@microsoft.com" Date: Thu, 17 Oct 2024 10:05:12 +0000 Subject: [PATCH 13/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=468130&view=results --- .../@azure/msal-browser/EventHandler.yml | 85 +++++++++++++++++++ .../@azure/msal-browser/IController.yml | 9 +- .../msal-browser/IPublicClientApplication.yml | 9 +- .../msal-browser/PublicClientApplication.yml | 9 +- .../@azure/msal-browser/PublicClientNext.yml | 9 +- .../@azure/msal-browser/index.yml | 1 + .../@azure/msal-node/InteractiveRequest.yml | 17 ++-- .../ManagedIdentityRequestParams.yml | 14 ++- .../@azure/msal-node/SilentFlowRequest.yml | 7 +- msal/docs-ref-autogen/toc.yml | 3 + 10 files changed, 129 insertions(+), 34 deletions(-) create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml new file mode 100644 index 0000000..fa9260a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml @@ -0,0 +1,85 @@ +### YamlMime:TSType +name: EventHandler +uid: '@azure/msal-browser.EventHandler' +package: '@azure/msal-browser' +summary: '' +fullName: EventHandler +remarks: '' +isDeprecated: false +type: class +constructors: + - name: EventHandler(Logger) + uid: '@azure/msal-browser.EventHandler.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'new EventHandler(logger?: Logger)' + parameters: + - id: logger + type: + description: '' +methods: + - name: addEventCallback(EventCallbackFunction, EventType[], string) + uid: '@azure/msal-browser.EventHandler.addEventCallback' + package: '@azure/msal-browser' + summary: Adds event callbacks to array + remarks: '' + isDeprecated: false + syntax: + content: >- + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[], callbackId?: string): null | string + parameters: + - id: callback + type: + description: callback to be invoked when an event is raised + - id: eventTypes + type: EventType[] + description: >- + list of events that this callback will be invoked for, if not + provided callback will be invoked for all events + - id: callbackId + type: string + description: >- + Identifier for the callback, used to locate and remove the callback + when no longer required + return: + description: '' + type: null | string + - name: emitEvent(EventType, InteractionType, EventPayload, EventError) + uid: '@azure/msal-browser.EventHandler.emitEvent' + package: '@azure/msal-browser' + summary: Emits events by calling callback with event message + remarks: '' + isDeprecated: false + syntax: + content: >- + function emitEvent(eventType: EventType, interactionType?: + InteractionType, payload?: EventPayload, error?: EventError) + parameters: + - id: eventType + type: EventType + description: '' + - id: interactionType + type: + description: '' + - id: payload + type: + description: '' + - id: error + type: + description: '' + - name: removeEventCallback(string) + uid: '@azure/msal-browser.EventHandler.removeEventCallback' + package: '@azure/msal-browser' + summary: Removes callback with provided id from callback array + remarks: '' + isDeprecated: false + syntax: + content: 'function removeEventCallback(callbackId: string)' + parameters: + - id: callbackId + type: string + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml index 2afc788..facb7c6 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml @@ -103,7 +103,7 @@ methods: return: description: '' type: Promise<> - - name: addEventCallback(EventCallbackFunction) + - name: addEventCallback(EventCallbackFunction, EventType[]) uid: '@azure/msal-browser.IController.addEventCallback' package: '@azure/msal-browser' summary: '' @@ -111,12 +111,15 @@ methods: isDeprecated: false syntax: content: >- - function addEventCallback(callback: EventCallbackFunction): null | - string + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[]): null | string parameters: - id: callback type: description: '' + - id: eventTypes + type: EventType[] + description: '' return: description: '' type: null | string diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml index 43f8d07..3debaa3 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml @@ -74,7 +74,7 @@ methods: return: description: '' type: Promise<> - - name: addEventCallback(EventCallbackFunction) + - name: addEventCallback(EventCallbackFunction, EventType[]) uid: '@azure/msal-browser.IPublicClientApplication.addEventCallback' package: '@azure/msal-browser' summary: '' @@ -82,12 +82,15 @@ methods: isDeprecated: false syntax: content: >- - function addEventCallback(callback: EventCallbackFunction): null | - string + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[]): null | string parameters: - id: callback type: description: '' + - id: eventTypes + type: EventType[] + description: '' return: description: '' type: null | string diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml index 03ec4b5..9f8965d 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -135,7 +135,7 @@ methods: [AuthenticationResult](xref:@azure/msal-browser.AuthenticationResult) object type: Promise<> - - name: addEventCallback(EventCallbackFunction) + - name: addEventCallback(EventCallbackFunction, EventType[]) uid: '@azure/msal-browser.PublicClientApplication.addEventCallback' package: '@azure/msal-browser' summary: Adds event callbacks to array @@ -143,12 +143,15 @@ methods: isDeprecated: false syntax: content: >- - function addEventCallback(callback: EventCallbackFunction): null | - string + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[]): null | string parameters: - id: callback type: description: '' + - id: eventTypes + type: EventType[] + description: '' return: description: '' type: null | string diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml index 033b234..d796417 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml @@ -130,7 +130,7 @@ methods: [AuthenticationResult](xref:@azure/msal-browser.AuthenticationResult) object type: Promise<> - - name: addEventCallback(EventCallbackFunction) + - name: addEventCallback(EventCallbackFunction, EventType[]) uid: '@azure/msal-browser.PublicClientNext.addEventCallback' package: '@azure/msal-browser' summary: Adds event callbacks to array @@ -138,12 +138,15 @@ methods: isDeprecated: false syntax: content: >- - function addEventCallback(callback: EventCallbackFunction): null | - string + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[]): null | string parameters: - id: callback type: description: '' + - id: eventTypes + type: EventType[] + description: '' return: description: '' type: null | string diff --git a/msal/docs-ref-autogen/@azure/msal-browser/index.yml b/msal/docs-ref-autogen/@azure/msal-browser/index.yml index 35d6e1a..4e20459 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/index.yml @@ -17,6 +17,7 @@ classes: - '@azure/msal-browser.BrowserStorage' - '@azure/msal-browser.ClientAuthError' - '@azure/msal-browser.ClientConfigurationError' + - '@azure/msal-browser.EventHandler' - '@azure/msal-browser.EventMessageUtils' - '@azure/msal-browser.InteractionRequiredAuthError' - '@azure/msal-browser.Logger' diff --git a/msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml index 7d35c9d..9e25fcc 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml @@ -27,18 +27,11 @@ fullName: InteractiveRequest remarks: '' isDeprecated: false syntax: | - type InteractiveRequest = Pick< - AuthorizationUrlRequest, - | "authority" - | "correlationId" - | "claims" - | "azureCloudOptions" - | "account" - | "extraQueryParameters" - | "tokenQueryParameters" - | "extraScopesToConsent" - | "loginHint" - | "prompt" + type InteractiveRequest = Partial< + Omit< + CommonAuthorizationUrlRequest, + "scopes" | "redirectUri" | "requestedClaimsHash" | "storeInCache" + > > & { errorTemplate?: string loopbackClient?: ILoopbackClient diff --git a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml index fdfbabd..9c9344f 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml @@ -5,16 +5,22 @@ package: '@azure/msal-node' summary: >- ManagedIdentityRequest + - claims - a stringified claims request which will be used to determine + whether or not the cache should be skipped + - forceRefresh - forces managed identity requests to skip the cache and make network calls if true - - resource - resource requested to access the protected API. It should be of - the form "{ResourceIdUri}" or {ResourceIdUri/.default}. For instance + - resource - resource requested to access the protected API. It should be + of the form "{ResourceIdUri}" or {ResourceIdUri/.default}. For instance https://management.azure.net or, for Microsoft Graph, https://graph.microsoft.com/.default fullName: ManagedIdentityRequestParams remarks: '' isDeprecated: false -syntax: > - type ManagedIdentityRequestParams = { forceRefresh?: boolean; resource: string +syntax: | + type ManagedIdentityRequestParams = { + claims?: string + forceRefresh?: boolean + resource: string } diff --git a/msal/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml b/msal/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml index b8fba55..0ae339c 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml @@ -32,11 +32,6 @@ syntax: | type SilentFlowRequest = Partial< Omit< CommonSilentFlowRequest, - | "account" - | "scopes" - | "resourceRequestMethod" - | "resourceRequestUri" - | "requestedClaimsHash" - | "storeInCache" + "account" | "scopes" | "requestedClaimsHash" | "storeInCache" > > & { account: AccountInfo; scopes: string[] } diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml index 62ccbc7..8feb518 100644 --- a/msal/docs-ref-autogen/toc.yml +++ b/msal/docs-ref-autogen/toc.yml @@ -153,6 +153,9 @@ - uid: '@azure/msal-browser.EventError' name: EventError items: [] + - uid: '@azure/msal-browser.EventHandler' + name: EventHandler + items: [] - uid: '@azure/msal-browser.EventMessage' name: EventMessage items: [] From 8fb5c11144c904828b6c8b8cbdf05cd2e2782715 Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 7 Nov 2024 10:05:57 +0000 Subject: [PATCH 14/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=475040&view=results --- .../@azure/msal-browser/BrowserAuthError.yml | 7 +- .../@azure/msal-browser/PerformanceEvent.yml | 5 + .../@azure/msal-browser/PerformanceEvents.yml | 10 +- .../@azure/msal-common/BaseAuthRequest.yml | 6 + .../@azure/msal-common/NetworkError.yml | 243 ++++++++++++++++++ .../@azure/msal-common/PerformanceEvent.yml | 5 + .../@azure/msal-common/PerformanceEvents.yml | 10 +- .../msal-common/UrlToHttpRequestOptions.yml | 20 -- .../@azure/msal-common/index.yml | 25 +- .../msal-node/ClientCredentialClient.yml | 34 ++- .../@azure/msal-node/DeviceCodeClient.yml | 36 ++- .../msal-node/DistributedCachePlugin.yml | 12 +- .../@azure/msal-node/ICacheClient.yml | 8 +- .../@azure/msal-node/IPartitionManager.yml | 6 +- .../ManagedIdentityRequestParams.yml | 2 +- .../@azure/msal-node/NodeStorage.yml | 9 +- .../@azure/msal-node/OnBehalfOfClient.yml | 34 ++- .../msal-node/PublicClientApplication.yml | 4 +- .../msal-node/UsernamePasswordClient.yml | 34 ++- .../@azure/msal-node/index.yml | 6 +- .../msal-node/internals.Deserializer.yml | 137 ---------- .../@azure/msal-node/internals.Serializer.yml | 135 ---------- .../@azure/msal-node/internals.yml | 5 +- msal/docs-ref-autogen/toc.yml | 19 +- 24 files changed, 465 insertions(+), 347 deletions(-) create mode 100644 msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/internals.Deserializer.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/internals.Serializer.yml diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml index 5eb4920..9476c1c 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml @@ -8,18 +8,21 @@ remarks: '' isDeprecated: false type: class constructors: - - name: BrowserAuthError(string) + - name: BrowserAuthError(string, string) uid: '@azure/msal-browser.BrowserAuthError.constructor' package: '@azure/msal-browser' summary: '' remarks: '' isDeprecated: false syntax: - content: 'new BrowserAuthError(errorCode: string)' + content: 'new BrowserAuthError(errorCode: string, subError?: string)' parameters: - id: errorCode type: string description: '' + - id: subError + type: string + description: '' inheritedProperties: - name: correlationId uid: '@azure/msal-browser.BrowserAuthError.correlationId' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml index fadf25a..7a5203e 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml @@ -23,9 +23,13 @@ syntax: | cacheOutcome?: number cacheRtCount?: number clientId: string + contentLengthHeader?: string + contentTypeHeader?: string context?: string correlationId: string durationMs?: number + embeddedClientId?: string + embeddedRedirectUri?: string endPageVisibility?: string | null errorCode?: string errorName?: string @@ -37,6 +41,7 @@ syntax: | extensionInstalled?: boolean extensionVersion?: string fromCache?: boolean | null + httpStatus?: number httpVerToken?: string idTokenSize?: number incompleteSubMeasurements?: Map diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml index f2b1d75..744c842 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -270,6 +270,12 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.NativeMessageHandlerHandshake' package: '@azure/msal-browser' summary: '' + - name: NetworkClientSendPostRequestAsync + uid: '@azure/msal-browser.PerformanceEvents.NetworkClientSendPostRequestAsync' + package: '@azure/msal-browser' + summary: >- + Time spent sending/waiting for the response of a request to the token + endpoint - name: PopTokenGenerateCnf uid: '@azure/msal-browser.PerformanceEvents.PopTokenGenerateCnf' package: '@azure/msal-browser' @@ -303,9 +309,7 @@ fields: uid: >- @azure/msal-browser.PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint package: '@azure/msal-browser' - summary: >- - Time spent sending/waiting for the response of a request to the token - endpoint + summary: '' - name: RefreshTokenClientExecuteTokenRequest uid: >- @azure/msal-browser.PerformanceEvents.RefreshTokenClientExecuteTokenRequest diff --git a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml index dab56cc..6061b89 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml @@ -61,6 +61,11 @@ summary: >- - popKid - Key ID to identify the public key for PoP token request + + - embeddedClientId - Embedded client id. When specified, broker client + id (brk_client_id) and redirect uri (brk_redirect_uri) params are set with + values from the config, overriding the corresponding extra parameters, if + present. fullName: BaseAuthRequest remarks: '' isDeprecated: false @@ -71,6 +76,7 @@ syntax: | azureCloudOptions?: AzureCloudOptions claims?: string correlationId: string + embeddedClientId?: string maxAge?: number popKid?: string requestedClaimsHash?: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml b/msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml new file mode 100644 index 0000000..7ea5f1e --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml @@ -0,0 +1,243 @@ +### YamlMime:TSType +name: NetworkError +uid: '@azure/msal-common.NetworkError' +package: '@azure/msal-common' +summary: Represents network related errors +fullName: NetworkError +remarks: '' +isDeprecated: false +type: class +constructors: + - name: NetworkError(AuthError, number, Record) + uid: '@azure/msal-common.NetworkError.constructor' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new NetworkError(error: AuthError, httpStatus?: number, + responseHeaders?: Record) + parameters: + - id: error + type: + description: '' + - id: httpStatus + type: number + description: '' + - id: responseHeaders + type: Record<string, string> + description: '' +properties: + - name: error + uid: '@azure/msal-common.NetworkError.error' + package: '@azure/msal-common' + summary: '' + fullName: error + remarks: '' + isDeprecated: false + syntax: + content: 'error: AuthError' + return: + description: '' + type: + - name: httpStatus + uid: '@azure/msal-common.NetworkError.httpStatus' + package: '@azure/msal-common' + summary: '' + fullName: httpStatus + remarks: '' + isDeprecated: false + syntax: + content: 'httpStatus?: number' + return: + description: '' + type: number + - name: responseHeaders + uid: '@azure/msal-common.NetworkError.responseHeaders' + package: '@azure/msal-common' + summary: '' + fullName: responseHeaders + remarks: '' + isDeprecated: false + syntax: + content: 'responseHeaders?: Record' + return: + description: '' + type: Record<string, string> +inheritedProperties: + - name: correlationId + uid: '@azure/msal-common.NetworkError.correlationId' + package: '@azure/msal-common' + summary: CorrelationId associated with the error + fullName: correlationId + remarks: '' + isDeprecated: false + syntax: + content: 'correlationId: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.correlationId](xref:@azure/msal-common.AuthError.correlationId) + - name: errorCode + uid: '@azure/msal-common.NetworkError.errorCode' + package: '@azure/msal-common' + summary: Short string denoting error + fullName: errorCode + remarks: '' + isDeprecated: false + syntax: + content: 'errorCode: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorCode](xref:@azure/msal-common.AuthError.errorCode) + - name: errorMessage + uid: '@azure/msal-common.NetworkError.errorMessage' + package: '@azure/msal-common' + summary: Detailed description of error + fullName: errorMessage + remarks: '' + isDeprecated: false + syntax: + content: 'errorMessage: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.errorMessage](xref:@azure/msal-common.AuthError.errorMessage) + - name: message + uid: '@azure/msal-common.NetworkError.message' + package: '@azure/msal-common' + summary: '' + fullName: message + remarks: '' + isDeprecated: false + syntax: + content: 'message: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-common.AuthError.message) + - name: name + uid: '@azure/msal-common.NetworkError.name' + package: '@azure/msal-common' + summary: '' + fullName: name + remarks: '' + isDeprecated: false + syntax: + content: 'name: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.name](xref:@azure/msal-common.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-common.NetworkError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + Optional override for formatting stack traces + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace + remarks: '' + isDeprecated: false + syntax: + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' + return: + description: '' + type: '(err: Error, stackTraces: CallSite[]) => any' + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-common.NetworkError.stack' + package: '@azure/msal-common' + summary: '' + fullName: stack + remarks: '' + isDeprecated: false + syntax: + content: 'stack?: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-common.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-common.NetworkError.stackTraceLimit' + package: '@azure/msal-common' + summary: '' + fullName: stackTraceLimit + remarks: '' + isDeprecated: false + syntax: + content: 'static stackTraceLimit: number' + return: + description: '' + type: number + inheritanceDescription: >- + Inherited From + [AuthError.stackTraceLimit](xref:@azure/msal-common.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-common.NetworkError.subError' + package: '@azure/msal-common' + summary: Describes the subclass of an error + fullName: subError + remarks: '' + isDeprecated: false + syntax: + content: 'subError: string' + return: + description: '' + type: string + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-common.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.NetworkError.captureStackTrace' + package: '@azure/msal-common' + summary: Create .stack property on a target object + remarks: '' + isDeprecated: false + syntax: + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) + parameters: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-common.NetworkError.setCorrelationId' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function setCorrelationId(correlationId: string)' + parameters: + - id: correlationId + type: string + description: '' + inheritanceDescription: >- + Inherited From + [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml index e810e96..9ca4ab9 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -23,9 +23,13 @@ syntax: | cacheOutcome?: number cacheRtCount?: number clientId: string + contentLengthHeader?: string + contentTypeHeader?: string context?: string correlationId: string durationMs?: number + embeddedClientId?: string + embeddedRedirectUri?: string endPageVisibility?: string | null errorCode?: string errorName?: string @@ -37,6 +41,7 @@ syntax: | extensionInstalled?: boolean extensionVersion?: string fromCache?: boolean | null + httpStatus?: number httpVerToken?: string idTokenSize?: number incompleteSubMeasurements?: Map diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml index a94a1ff..5f8f42e 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml @@ -269,6 +269,12 @@ fields: uid: '@azure/msal-common.PerformanceEvents.NativeMessageHandlerHandshake' package: '@azure/msal-common' summary: '' + - name: NetworkClientSendPostRequestAsync + uid: '@azure/msal-common.PerformanceEvents.NetworkClientSendPostRequestAsync' + package: '@azure/msal-common' + summary: >- + Time spent sending/waiting for the response of a request to the token + endpoint - name: PopTokenGenerateCnf uid: '@azure/msal-common.PerformanceEvents.PopTokenGenerateCnf' package: '@azure/msal-common' @@ -302,9 +308,7 @@ fields: uid: >- @azure/msal-common.PerformanceEvents.RefreshTokenClientExecutePostToTokenEndpoint package: '@azure/msal-common' - summary: >- - Time spent sending/waiting for the response of a request to the token - endpoint + summary: '' - name: RefreshTokenClientExecuteTokenRequest uid: '@azure/msal-common.PerformanceEvents.RefreshTokenClientExecuteTokenRequest' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml deleted file mode 100644 index 463cb9e..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/UrlToHttpRequestOptions.yml +++ /dev/null @@ -1,20 +0,0 @@ -### YamlMime:TSTypeAlias -name: UrlToHttpRequestOptions -uid: '@azure/msal-common.UrlToHttpRequestOptions' -package: '@azure/msal-common' -summary: '' -fullName: UrlToHttpRequestOptions -remarks: '' -isDeprecated: false -syntax: | - type UrlToHttpRequestOptions = { - auth?: string - hash: string - hostname: string - href: string - path: string - pathname: string - port?: number - protocol: string - search: string - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml index 7ca6ba9..34e023c 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -15,6 +15,7 @@ classes: - '@azure/msal-common.ClientConfigurationError' - '@azure/msal-common.InteractionRequiredAuthError' - '@azure/msal-common.Logger' + - '@azure/msal-common.NetworkError' - '@azure/msal-common.PerformanceClient' - '@azure/msal-common.ProtocolUtils' - '@azure/msal-common.ScopeSet' @@ -122,7 +123,6 @@ typeAliases: - '@azure/msal-common.ThrottlingEntity' - '@azure/msal-common.TokenClaims' - '@azure/msal-common.TokenKeys' - - '@azure/msal-common.UrlToHttpRequestOptions' functions: - name: >- buildAccountToCache(CacheManager, Authority, string, (input: string) => @@ -332,6 +332,29 @@ functions: return: description: '' type: + - name: createNetworkError(AuthError, number, Record) + uid: '@azure/msal-common.createNetworkError' + package: '@azure/msal-common' + summary: Creates NetworkError object for a failed network request + remarks: '' + isDeprecated: false + syntax: + content: >- + function createNetworkError(error: AuthError, httpStatus?: number, + responseHeaders?: Record): NetworkError + parameters: + - id: error + type: + description: Error to be thrown back to the caller + - id: httpStatus + type: number + description: Status code of the network request + - id: responseHeaders + type: Record<string, string> + description: Response headers of the network request, when available + return: + description: NetworkError object + type: - name: formatAuthorityUri(string) uid: '@azure/msal-common.formatAuthorityUri' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialClient.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialClient.yml index f5ba77e..5a6cbd1 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialClient.yml @@ -69,6 +69,38 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From BaseClient.createTokenQueryParameters + - name: >- + sendPostRequest(RequestThumbprint, string, NetworkRequestOptions, + string) + uid: '@azure/msal-node.ClientCredentialClient.sendPostRequest' + package: '@azure/msal-node' + summary: Wraps sendPostRequestAsync with necessary preflight and postflight logic + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendPostRequest(thumbprint: RequestThumbprint, + tokenEndpoint: string, options: NetworkRequestOptions, correlationId: + string): Promise> + parameters: + - id: thumbprint + type: + description: Request thumbprint for throttling + - id: tokenEndpoint + type: string + description: Endpoint to make the POST to + - id: options + type: + description: Body and Headers to include on the POST request + - id: correlationId + type: string + description: CorrelationId for telemetry + return: + description: '' + type: >- + Promise<<T>> + inheritanceDescription: Inherited From BaseClient.sendPostRequest - name: updateAuthority(string, string) uid: '@azure/msal-node.ClientCredentialClient.updateAuthority' package: '@azure/msal-node' @@ -108,7 +140,7 @@ methods: parameters: - id: request type: - description: '' + description: CommonClientCredentialRequest provided by the developer return: description: '' type: >- diff --git a/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml b/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml index 598e591..027f5eb 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml @@ -64,6 +64,38 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From BaseClient.createTokenQueryParameters + - name: >- + sendPostRequest(RequestThumbprint, string, NetworkRequestOptions, + string) + uid: '@azure/msal-node.DeviceCodeClient.sendPostRequest' + package: '@azure/msal-node' + summary: Wraps sendPostRequestAsync with necessary preflight and postflight logic + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendPostRequest(thumbprint: RequestThumbprint, + tokenEndpoint: string, options: NetworkRequestOptions, correlationId: + string): Promise> + parameters: + - id: thumbprint + type: + description: Request thumbprint for throttling + - id: tokenEndpoint + type: string + description: Endpoint to make the POST to + - id: options + type: + description: Body and Headers to include on the POST request + - id: correlationId + type: string + description: CorrelationId for telemetry + return: + description: '' + type: >- + Promise<<T>> + inheritanceDescription: Inherited From BaseClient.sendPostRequest - name: updateAuthority(string, string) uid: '@azure/msal-node.DeviceCodeClient.updateAuthority' package: '@azure/msal-node' @@ -105,7 +137,7 @@ methods: parameters: - id: request type: - description: '' + description: developer provided CommonDeviceCodeRequest return: description: '' type: >- @@ -124,7 +156,7 @@ methods: parameters: - id: request type: - description: '' + description: developer provided CommonDeviceCodeRequest return: description: '' type: string diff --git a/msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml b/msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml index 5cbfe9b..890f26a 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml @@ -2,7 +2,9 @@ name: DistributedCachePlugin uid: '@azure/msal-node.DistributedCachePlugin' package: '@azure/msal-node' -summary: '' +summary: >- + Cache plugin that serializes data to the cache and deserializes data from the + cache fullName: DistributedCachePlugin remarks: '' isDeprecated: false @@ -29,7 +31,7 @@ methods: - name: afterCacheAccess(TokenCacheContext) uid: '@azure/msal-node.DistributedCachePlugin.afterCacheAccess' package: '@azure/msal-node' - summary: '' + summary: Serializes the cache after accessing it remarks: '' isDeprecated: false syntax: @@ -39,14 +41,14 @@ methods: parameters: - id: cacheContext type: - description: '' + description: TokenCacheContext return: description: '' type: Promise<void> - name: beforeCacheAccess(TokenCacheContext) uid: '@azure/msal-node.DistributedCachePlugin.beforeCacheAccess' package: '@azure/msal-node' - summary: '' + summary: Deserializes the cache before accessing it remarks: '' isDeprecated: false syntax: @@ -56,7 +58,7 @@ methods: parameters: - id: cacheContext type: - description: '' + description: TokenCacheContext return: description: '' type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml b/msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml index 1130ce9..69cd46d 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml @@ -2,7 +2,7 @@ name: ICacheClient uid: '@azure/msal-node.ICacheClient' package: '@azure/msal-node' -summary: '' +summary: Interface for the cache that defines a getter and setter fullName: ICacheClient remarks: '' isDeprecated: false @@ -19,7 +19,7 @@ methods: parameters: - id: key type: string - description: string + description: key of item in the cache return: description: Promise type: Promise<string> @@ -34,10 +34,10 @@ methods: parameters: - id: key type: string - description: string + description: key of item in the cache - id: value type: string - description: string + description: value of item to be saved in the cache return: description: Promise type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml b/msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml index 69b73a5..dc81373 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml @@ -2,7 +2,9 @@ name: IPartitionManager uid: '@azure/msal-node.IPartitionManager' package: '@azure/msal-node' -summary: '' +summary: >- + Interface that defines getter methods to get keys used to identity data in the + cache fullName: IPartitionManager remarks: '' isDeprecated: false @@ -26,7 +28,7 @@ methods: parameters: - id: accountEntity type: - description: '' + description: AccountEntity return: description: Promise type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml index 9c9344f..7757cdf 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml @@ -12,7 +12,7 @@ summary: >- network calls if true - resource - resource requested to access the protected API. It should be - of the form "{ResourceIdUri}" or {ResourceIdUri/.default}. For instance + of the form "ResourceIdUri" or "ResourceIdUri/.default". For instance https://management.azure.net or, for Microsoft Graph, https://graph.microsoft.com/.default fullName: ManagedIdentityRequestParams diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml index c5e9070..99f7024 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml @@ -655,10 +655,7 @@ methods: remarks: '' isDeprecated: false syntax: - content: 'function clear(): Promise' - return: - description: '' - type: Promise<void> + content: function clear() - name: containsKey(string) uid: '@azure/msal-node.NodeStorage.containsKey' package: '@azure/msal-node' @@ -826,7 +823,7 @@ methods: parameters: - id: accountKey type: string - description: '' + description: lookup key to fetch cache type AccountEntity return: description: '' type: null | @@ -999,7 +996,7 @@ methods: parameters: - id: accountKey type: string - description: '' + description: lookup key to fetch cache type AccountEntity - name: setAccessTokenCredential(AccessTokenEntity) uid: '@azure/msal-node.NodeStorage.setAccessTokenCredential' package: '@azure/msal-node' diff --git a/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml b/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml index d4d335c..ed68a7f 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml @@ -64,6 +64,38 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From BaseClient.createTokenQueryParameters + - name: >- + sendPostRequest(RequestThumbprint, string, NetworkRequestOptions, + string) + uid: '@azure/msal-node.OnBehalfOfClient.sendPostRequest' + package: '@azure/msal-node' + summary: Wraps sendPostRequestAsync with necessary preflight and postflight logic + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendPostRequest(thumbprint: RequestThumbprint, + tokenEndpoint: string, options: NetworkRequestOptions, correlationId: + string): Promise> + parameters: + - id: thumbprint + type: + description: Request thumbprint for throttling + - id: tokenEndpoint + type: string + description: Endpoint to make the POST to + - id: options + type: + description: Body and Headers to include on the POST request + - id: correlationId + type: string + description: CorrelationId for telemetry + return: + description: '' + type: >- + Promise<<T>> + inheritanceDescription: Inherited From BaseClient.sendPostRequest - name: updateAuthority(string, string) uid: '@azure/msal-node.OnBehalfOfClient.updateAuthority' package: '@azure/msal-node' @@ -101,7 +133,7 @@ methods: parameters: - id: request type: - description: '' + description: developer provided CommonOnBehalfOfRequest return: description: '' type: >- diff --git a/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml index 1b1039a..f05ec04 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml @@ -332,7 +332,7 @@ methods: parameters: - id: request type: - description: '' + description: developer provided SilentFlowRequest return: description: '' type: Promise<> @@ -360,7 +360,7 @@ methods: parameters: - id: request type: - description: '' + description: developer provided SignOutRequest return: description: '' type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml index f6c5459..e9e4fe0 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml @@ -68,6 +68,38 @@ inheritedMethods: description: '' type: string inheritanceDescription: Inherited From BaseClient.createTokenQueryParameters + - name: >- + sendPostRequest(RequestThumbprint, string, NetworkRequestOptions, + string) + uid: '@azure/msal-node.UsernamePasswordClient.sendPostRequest' + package: '@azure/msal-node' + summary: Wraps sendPostRequestAsync with necessary preflight and postflight logic + remarks: '' + isDeprecated: false + syntax: + content: >- + function sendPostRequest(thumbprint: RequestThumbprint, + tokenEndpoint: string, options: NetworkRequestOptions, correlationId: + string): Promise> + parameters: + - id: thumbprint + type: + description: Request thumbprint for throttling + - id: tokenEndpoint + type: string + description: Endpoint to make the POST to + - id: options + type: + description: Body and Headers to include on the POST request + - id: correlationId + type: string + description: CorrelationId for telemetry + return: + description: '' + type: >- + Promise<<T>> + inheritanceDescription: Inherited From BaseClient.sendPostRequest - name: updateAuthority(string, string) uid: '@azure/msal-node.UsernamePasswordClient.updateAuthority' package: '@azure/msal-node' @@ -109,7 +141,7 @@ methods: parameters: - id: request type: - description: '' + description: CommonUsernamePasswordRequest return: description: '' type: >- diff --git a/msal/docs-ref-autogen/@azure/msal-node/index.yml b/msal/docs-ref-autogen/@azure/msal-node/index.yml index 2aa8855..efcf6d9 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/index.yml @@ -3,9 +3,9 @@ uid: '@azure/msal-node' name: '@azure/msal-node' summary: '' type: package +enums: + - '@azure/msal-node.LogLevel' classes: - - '@azure/msal-node.internals.Deserializer' - - '@azure/msal-node.internals.Serializer' - '@azure/msal-node.AuthError' - '@azure/msal-node.ClientApplication' - '@azure/msal-node.ClientAssertion' @@ -26,8 +26,6 @@ classes: - '@azure/msal-node.TokenCache' - '@azure/msal-node.TokenCacheContext' - '@azure/msal-node.UsernamePasswordClient' -enums: - - '@azure/msal-node.LogLevel' interfaces: - '@azure/msal-node.IAppTokenProvider' - '@azure/msal-node.ICacheClient' diff --git a/msal/docs-ref-autogen/@azure/msal-node/internals.Deserializer.yml b/msal/docs-ref-autogen/@azure/msal-node/internals.Deserializer.yml deleted file mode 100644 index f053f98..0000000 --- a/msal/docs-ref-autogen/@azure/msal-node/internals.Deserializer.yml +++ /dev/null @@ -1,137 +0,0 @@ -### YamlMime:TSType -name: Deserializer -uid: '@azure/msal-node.internals.Deserializer' -package: '@azure/msal-node' -summary: >- - This class deserializes cache entities read from the file into in memory - object types defined internally -fullName: Deserializer -remarks: '' -isDeprecated: false -type: class -methods: - - name: deserializeAccessTokens(Record) - uid: '@azure/msal-node.internals.Deserializer.deserializeAccessTokens' - package: '@azure/msal-node' - summary: Deserializes access tokens to AccessTokenEntity objects - remarks: '' - isDeprecated: false - syntax: - content: >- - static function deserializeAccessTokens(accessTokens: Record): AccessTokenCache - parameters: - - id: accessTokens - type: >- - Record<string, > - description: '' - return: - description: '' - type: - - name: deserializeAccounts(Record) - uid: '@azure/msal-node.internals.Deserializer.deserializeAccounts' - package: '@azure/msal-node' - summary: Deserializes accounts to AccountEntity objects - remarks: '' - isDeprecated: false - syntax: - content: >- - static function deserializeAccounts(accounts: Record): AccountCache - parameters: - - id: accounts - type: >- - Record<string, > - description: '' - return: - description: '' - type: - - name: deserializeAllCache(JsonCache) - uid: '@azure/msal-node.internals.Deserializer.deserializeAllCache' - package: '@azure/msal-node' - summary: Deserialize an inMemory Cache - remarks: '' - isDeprecated: false - syntax: - content: 'static function deserializeAllCache(jsonCache: JsonCache): InMemoryCache' - parameters: - - id: jsonCache - type: - description: '' - return: - description: '' - type: - - name: deserializeAppMetadata(Record) - uid: '@azure/msal-node.internals.Deserializer.deserializeAppMetadata' - package: '@azure/msal-node' - summary: Deserializes appMetadata to AppMetaData objects - remarks: '' - isDeprecated: false - syntax: - content: >- - static function deserializeAppMetadata(appMetadata: Record): AppMetadataCache - parameters: - - id: appMetadata - type: >- - Record<string, > - description: '' - return: - description: '' - type: - - name: deserializeIdTokens(Record) - uid: '@azure/msal-node.internals.Deserializer.deserializeIdTokens' - package: '@azure/msal-node' - summary: Deserializes id tokens to IdTokenEntity objects - remarks: '' - isDeprecated: false - syntax: - content: >- - static function deserializeIdTokens(idTokens: Record): IdTokenCache - parameters: - - id: idTokens - type: >- - Record<string, > - description: '' - return: - description: '' - type: - - name: deserializeJSONBlob(string) - uid: '@azure/msal-node.internals.Deserializer.deserializeJSONBlob' - package: '@azure/msal-node' - summary: Parse the JSON blob in memory and deserialize the content - remarks: '' - isDeprecated: false - syntax: - content: 'static function deserializeJSONBlob(jsonFile: string): JsonCache' - parameters: - - id: jsonFile - type: string - description: '' - return: - description: '' - type: - - name: deserializeRefreshTokens(Record) - uid: '@azure/msal-node.internals.Deserializer.deserializeRefreshTokens' - package: '@azure/msal-node' - summary: Deserializes refresh tokens to RefreshTokenEntity objects - remarks: '' - isDeprecated: false - syntax: - content: >- - static function deserializeRefreshTokens(refreshTokens: Record): RefreshTokenCache - parameters: - - id: refreshTokens - type: >- - Record<string, > - description: '' - return: - description: '' - type: diff --git a/msal/docs-ref-autogen/@azure/msal-node/internals.Serializer.yml b/msal/docs-ref-autogen/@azure/msal-node/internals.Serializer.yml deleted file mode 100644 index f4e75dc..0000000 --- a/msal/docs-ref-autogen/@azure/msal-node/internals.Serializer.yml +++ /dev/null @@ -1,135 +0,0 @@ -### YamlMime:TSType -name: Serializer -uid: '@azure/msal-node.internals.Serializer' -package: '@azure/msal-node' -summary: '' -fullName: Serializer -remarks: '' -isDeprecated: false -type: class -methods: - - name: serializeAccessTokens(AccessTokenCache) - uid: '@azure/msal-node.internals.Serializer.serializeAccessTokens' - package: '@azure/msal-node' - summary: Serializes AccessTokens - remarks: '' - isDeprecated: false - syntax: - content: >- - static function serializeAccessTokens(atCache: AccessTokenCache): - Record - parameters: - - id: atCache - type: - description: '' - return: - description: '' - type: >- - Record<string, > - - name: serializeAccounts(AccountCache) - uid: '@azure/msal-node.internals.Serializer.serializeAccounts' - package: '@azure/msal-node' - summary: Serialize Accounts - remarks: '' - isDeprecated: false - syntax: - content: >- - static function serializeAccounts(accCache: AccountCache): - Record - parameters: - - id: accCache - type: - description: '' - return: - description: '' - type: >- - Record<string, > - - name: serializeAllCache(InMemoryCache) - uid: '@azure/msal-node.internals.Serializer.serializeAllCache' - package: '@azure/msal-node' - summary: Serialize the cache - remarks: '' - isDeprecated: false - syntax: - content: 'static function serializeAllCache(inMemCache: InMemoryCache): JsonCache' - parameters: - - id: inMemCache - type: - description: '' - return: - description: '' - type: - - name: serializeAppMetadata(AppMetadataCache) - uid: '@azure/msal-node.internals.Serializer.serializeAppMetadata' - package: '@azure/msal-node' - summary: Serialize amdtCache - remarks: '' - isDeprecated: false - syntax: - content: >- - static function serializeAppMetadata(amdtCache: AppMetadataCache): - Record - parameters: - - id: amdtCache - type: - description: '' - return: - description: '' - type: >- - Record<string, > - - name: serializeIdTokens(IdTokenCache) - uid: '@azure/msal-node.internals.Serializer.serializeIdTokens' - package: '@azure/msal-node' - summary: Serialize IdTokens - remarks: '' - isDeprecated: false - syntax: - content: >- - static function serializeIdTokens(idTCache: IdTokenCache): - Record - parameters: - - id: idTCache - type: - description: '' - return: - description: '' - type: >- - Record<string, > - - name: serializeJSONBlob(JsonCache) - uid: '@azure/msal-node.internals.Serializer.serializeJSONBlob' - package: '@azure/msal-node' - summary: serialize the JSON blob - remarks: '' - isDeprecated: false - syntax: - content: 'static function serializeJSONBlob(data: JsonCache): string' - parameters: - - id: data - type: - description: '' - return: - description: '' - type: string - - name: serializeRefreshTokens(RefreshTokenCache) - uid: '@azure/msal-node.internals.Serializer.serializeRefreshTokens' - package: '@azure/msal-node' - summary: Serialize refreshTokens - remarks: '' - isDeprecated: false - syntax: - content: >- - static function serializeRefreshTokens(rtCache: RefreshTokenCache): - Record - parameters: - - id: rtCache - type: - description: '' - return: - description: '' - type: >- - Record<string, > diff --git a/msal/docs-ref-autogen/@azure/msal-node/internals.yml b/msal/docs-ref-autogen/@azure/msal-node/internals.yml index bfe514a..9473a14 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/internals.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/internals.yml @@ -1,9 +1,6 @@ ### YamlMime:TSPackage uid: '@azure/msal-node.internals' name: internals -summary: '' type: module -classes: - - '@azure/msal-node.internals.Deserializer' - - '@azure/msal-node.internals.Serializer' package: '@azure/msal-node' +summary: '' diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml index 8feb518..6cbed7f 100644 --- a/msal/docs-ref-autogen/toc.yml +++ b/msal/docs-ref-autogen/toc.yml @@ -559,6 +559,9 @@ - uid: '@azure/msal-common.NativeSignOutRequest' name: NativeSignOutRequest items: [] + - uid: '@azure/msal-common.NetworkError' + name: NetworkError + items: [] - uid: '@azure/msal-common.NetworkRequestOptions' name: NetworkRequestOptions items: [] @@ -688,9 +691,6 @@ - uid: '@azure/msal-common.UrlString' name: UrlString items: [] - - uid: '@azure/msal-common.UrlToHttpRequestOptions' - name: UrlToHttpRequestOptions - items: [] - uid: '@azure/msal-common.UrlUtils' name: UrlUtils items: [] @@ -821,16 +821,9 @@ - uid: '@azure/msal-node.InteractiveRequest' name: InteractiveRequest items: [] - - name: internals - items: - - name: Overview - uid: '@azure/msal-node.internals' - - uid: '@azure/msal-node.internals.Deserializer' - name: Deserializer - items: [] - - uid: '@azure/msal-node.internals.Serializer' - name: Serializer - items: [] + - uid: '@azure/msal-node.internals' + name: internals + items: [] - uid: '@azure/msal-node.IPartitionManager' name: IPartitionManager items: [] From 24fa31367ba7f1780326be6c6c6850d05953574a Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 9 Jan 2025 10:04:00 +0000 Subject: [PATCH 15/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=489713&view=results --- .../@azure/msal-browser/BrowserStorage.yml | 15 ++-- .../@azure/msal-browser/IWindowStorage.yml | 80 +++++++++++++++++++ .../@azure/msal-browser/LocalStorage.yml | 80 +++++++++++++++++++ .../@azure/msal-browser/MemoryStorage.yml | 12 +-- .../@azure/msal-browser/SessionStorage.yml | 80 +++++++++++++++++++ .../@azure/msal-browser/index.yml | 3 + msal/docs-ref-autogen/toc.yml | 9 +++ 7 files changed, 268 insertions(+), 11 deletions(-) create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml index 4f3ea26..af3ac40 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml @@ -5,7 +5,8 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserStorage remarks: '' -isDeprecated: false +isDeprecated: true +customDeprecatedMessage: This class will be removed in a future major version type: class constructors: - name: BrowserStorage(string) @@ -24,7 +25,7 @@ methods: - name: containsKey(string) uid: '@azure/msal-browser.BrowserStorage.containsKey' package: '@azure/msal-browser' - summary: '' + summary: Returns true or false if the given key is present in the cache. remarks: '' isDeprecated: false syntax: @@ -39,7 +40,7 @@ methods: - name: getItem(string) uid: '@azure/msal-browser.BrowserStorage.getItem' package: '@azure/msal-browser' - summary: '' + summary: Get the item from the window storage object matching the given key. remarks: '' isDeprecated: false syntax: @@ -54,7 +55,9 @@ methods: - name: getKeys() uid: '@azure/msal-browser.BrowserStorage.getKeys' package: '@azure/msal-browser' - summary: '' + summary: >- + Get all the keys from the window storage object as an iterable array of + strings. remarks: '' isDeprecated: false syntax: @@ -65,7 +68,7 @@ methods: - name: removeItem(string) uid: '@azure/msal-browser.BrowserStorage.removeItem' package: '@azure/msal-browser' - summary: '' + summary: Removes the item in the window storage object matching the given key. remarks: '' isDeprecated: false syntax: @@ -77,7 +80,7 @@ methods: - name: setItem(string, string) uid: '@azure/msal-browser.BrowserStorage.setItem' package: '@azure/msal-browser' - summary: '' + summary: Sets the item in the window storage object with the given key. remarks: '' isDeprecated: false syntax: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml new file mode 100644 index 0000000..3d7eb41 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: IWindowStorage +uid: '@azure/msal-browser.IWindowStorage' +package: '@azure/msal-browser' +summary: '' +fullName: IWindowStorage +remarks: '' +isDeprecated: false +type: interface +methods: + - name: containsKey(string) + uid: '@azure/msal-browser.IWindowStorage.containsKey' + package: '@azure/msal-browser' + summary: Returns true or false if the given key is present in the cache. + remarks: '' + isDeprecated: false + syntax: + content: 'function containsKey(key: string): boolean' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: boolean + - name: getItem(string) + uid: '@azure/msal-browser.IWindowStorage.getItem' + package: '@azure/msal-browser' + summary: Get the item from the window storage object matching the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function getItem(key: string): null | T' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: null | T + - name: getKeys() + uid: '@azure/msal-browser.IWindowStorage.getKeys' + package: '@azure/msal-browser' + summary: >- + Get all the keys from the window storage object as an iterable array of + strings. + remarks: '' + isDeprecated: false + syntax: + content: 'function getKeys(): string[]' + return: + description: '' + type: string[] + - name: removeItem(string) + uid: '@azure/msal-browser.IWindowStorage.removeItem' + package: '@azure/msal-browser' + summary: Removes the item in the window storage object matching the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function removeItem(key: string)' + parameters: + - id: key + type: string + description: '' + - name: setItem(string, T) + uid: '@azure/msal-browser.IWindowStorage.setItem' + package: '@azure/msal-browser' + summary: Sets the item in the window storage object with the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function setItem(key: string, value: T)' + parameters: + - id: key + type: string + description: '' + - id: value + type: T + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.yml new file mode 100644 index 0000000..e54d7f6 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: LocalStorage +uid: '@azure/msal-browser.LocalStorage' +package: '@azure/msal-browser' +summary: '' +fullName: LocalStorage +remarks: '' +isDeprecated: false +type: class +methods: + - name: containsKey(string) + uid: '@azure/msal-browser.LocalStorage.containsKey' + package: '@azure/msal-browser' + summary: Returns true or false if the given key is present in the cache. + remarks: '' + isDeprecated: false + syntax: + content: 'function containsKey(key: string): boolean' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: boolean + - name: getItem(string) + uid: '@azure/msal-browser.LocalStorage.getItem' + package: '@azure/msal-browser' + summary: Get the item from the window storage object matching the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function getItem(key: string): null | string' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: null | string + - name: getKeys() + uid: '@azure/msal-browser.LocalStorage.getKeys' + package: '@azure/msal-browser' + summary: >- + Get all the keys from the window storage object as an iterable array of + strings. + remarks: '' + isDeprecated: false + syntax: + content: 'function getKeys(): string[]' + return: + description: '' + type: string[] + - name: removeItem(string) + uid: '@azure/msal-browser.LocalStorage.removeItem' + package: '@azure/msal-browser' + summary: Removes the item in the window storage object matching the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function removeItem(key: string)' + parameters: + - id: key + type: string + description: '' + - name: setItem(string, string) + uid: '@azure/msal-browser.LocalStorage.setItem' + package: '@azure/msal-browser' + summary: Sets the item in the window storage object with the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function setItem(key: string, value: string)' + parameters: + - id: key + type: string + description: '' + - id: value + type: string + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml index 6ecde16..733b905 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml @@ -19,7 +19,7 @@ methods: - name: containsKey(string) uid: '@azure/msal-browser.MemoryStorage.containsKey' package: '@azure/msal-browser' - summary: '' + summary: Returns true or false if the given key is present in the cache. remarks: '' isDeprecated: false syntax: @@ -34,7 +34,7 @@ methods: - name: getItem(string) uid: '@azure/msal-browser.MemoryStorage.getItem' package: '@azure/msal-browser' - summary: '' + summary: Get the item from the window storage object matching the given key. remarks: '' isDeprecated: false syntax: @@ -49,7 +49,9 @@ methods: - name: getKeys() uid: '@azure/msal-browser.MemoryStorage.getKeys' package: '@azure/msal-browser' - summary: '' + summary: >- + Get all the keys from the window storage object as an iterable array of + strings. remarks: '' isDeprecated: false syntax: @@ -60,7 +62,7 @@ methods: - name: removeItem(string) uid: '@azure/msal-browser.MemoryStorage.removeItem' package: '@azure/msal-browser' - summary: '' + summary: Removes the item in the window storage object matching the given key. remarks: '' isDeprecated: false syntax: @@ -72,7 +74,7 @@ methods: - name: setItem(string, T) uid: '@azure/msal-browser.MemoryStorage.setItem' package: '@azure/msal-browser' - summary: '' + summary: Sets the item in the window storage object with the given key. remarks: '' isDeprecated: false syntax: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml new file mode 100644 index 0000000..65db497 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: SessionStorage +uid: '@azure/msal-browser.SessionStorage' +package: '@azure/msal-browser' +summary: '' +fullName: SessionStorage +remarks: '' +isDeprecated: false +type: class +methods: + - name: containsKey(string) + uid: '@azure/msal-browser.SessionStorage.containsKey' + package: '@azure/msal-browser' + summary: Returns true or false if the given key is present in the cache. + remarks: '' + isDeprecated: false + syntax: + content: 'function containsKey(key: string): boolean' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: boolean + - name: getItem(string) + uid: '@azure/msal-browser.SessionStorage.getItem' + package: '@azure/msal-browser' + summary: Get the item from the window storage object matching the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function getItem(key: string): null | string' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: null | string + - name: getKeys() + uid: '@azure/msal-browser.SessionStorage.getKeys' + package: '@azure/msal-browser' + summary: >- + Get all the keys from the window storage object as an iterable array of + strings. + remarks: '' + isDeprecated: false + syntax: + content: 'function getKeys(): string[]' + return: + description: '' + type: string[] + - name: removeItem(string) + uid: '@azure/msal-browser.SessionStorage.removeItem' + package: '@azure/msal-browser' + summary: Removes the item in the window storage object matching the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function removeItem(key: string)' + parameters: + - id: key + type: string + description: '' + - name: setItem(string, string) + uid: '@azure/msal-browser.SessionStorage.setItem' + package: '@azure/msal-browser' + summary: Sets the item in the window storage object with the given key. + remarks: '' + isDeprecated: false + syntax: + content: 'function setItem(key: string, value: string)' + parameters: + - id: key + type: string + description: '' + - id: value + type: string + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/index.yml b/msal/docs-ref-autogen/@azure/msal-browser/index.yml index 4e20459..6e16905 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/index.yml @@ -20,12 +20,14 @@ classes: - '@azure/msal-browser.EventHandler' - '@azure/msal-browser.EventMessageUtils' - '@azure/msal-browser.InteractionRequiredAuthError' + - '@azure/msal-browser.LocalStorage' - '@azure/msal-browser.Logger' - '@azure/msal-browser.MemoryStorage' - '@azure/msal-browser.NavigationClient' - '@azure/msal-browser.PublicClientApplication' - '@azure/msal-browser.PublicClientNext' - '@azure/msal-browser.ServerError' + - '@azure/msal-browser.SessionStorage' - '@azure/msal-browser.SignedHttpRequest' - '@azure/msal-browser.StubPerformanceClient' - '@azure/msal-browser.UrlString' @@ -37,6 +39,7 @@ interfaces: - '@azure/msal-browser.IPerformanceClient' - '@azure/msal-browser.IPublicClientApplication' - '@azure/msal-browser.ITokenCache' + - '@azure/msal-browser.IWindowStorage' typeAliases: - '@azure/msal-browser.AccountInfo' - '@azure/msal-browser.ApiId' diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml index 6cbed7f..b849abe 100644 --- a/msal/docs-ref-autogen/toc.yml +++ b/msal/docs-ref-autogen/toc.yml @@ -213,12 +213,18 @@ - uid: '@azure/msal-browser.ITokenCache' name: ITokenCache items: [] + - uid: '@azure/msal-browser.IWindowStorage' + name: IWindowStorage + items: [] - uid: '@azure/msal-browser.JsonWebTokenTypes' name: JsonWebTokenTypes items: [] - uid: '@azure/msal-browser.LoadTokenOptions' name: LoadTokenOptions items: [] + - uid: '@azure/msal-browser.LocalStorage' + name: LocalStorage + items: [] - uid: '@azure/msal-browser.Logger' name: Logger items: [] @@ -282,6 +288,9 @@ - uid: '@azure/msal-browser.ServerResponseType' name: ServerResponseType items: [] + - uid: '@azure/msal-browser.SessionStorage' + name: SessionStorage + items: [] - uid: '@azure/msal-browser.SignedHttpRequest' name: SignedHttpRequest items: [] From 03674c4992fa20af6d01b957a3cb59962a8946ea Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 16 Jan 2025 10:04:18 +0000 Subject: [PATCH 16/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=491309&view=results --- .../msal-browser/AuthorizationUrlRequest.yml | 2 +- .../@azure/msal-browser/BrowserStorage.yml | 94 -- .../msal-browser/BrowserSystemOptions.yml | 2 +- .../@azure/msal-browser/ITokenCache.yml | 5 +- .../@azure/msal-browser/IWindowStorage.yml | 53 + .../@azure/msal-browser/LocalStorage.yml | 82 ++ .../@azure/msal-browser/MemoryStorage.yml | 44 + .../@azure/msal-browser/PerformanceEvent.yml | 2 +- .../@azure/msal-browser/PerformanceEvents.yml | 36 + .../@azure/msal-browser/PopupRequest.yml | 2 +- .../@azure/msal-browser/RedirectRequest.yml | 2 +- .../@azure/msal-browser/SessionStorage.yml | 44 + .../@azure/msal-browser/SsoSilentRequest.yml | 2 +- .../@azure/msal-browser/index.yml | 1 - .../CommonAuthorizationUrlRequest.yml | 2 +- .../@azure/msal-common/PerformanceEvent.yml | 2 +- .../@azure/msal-common/PerformanceEvents.yml | 36 + .../@azure/msal-node/NodeStorage.yml | 1170 ----------------- .../@azure/msal-node/TokenCache.yml | 2 +- .../@azure/msal-node/index.yml | 1 - msal/docs-ref-autogen/toc.yml | 6 - 21 files changed, 307 insertions(+), 1283 deletions(-) delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml index 56c8c90..30086a5 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml @@ -9,5 +9,5 @@ isDeprecated: false syntax: | type AuthorizationUrlRequest = Omit< CommonAuthorizationUrlRequest, - "state" | "nonce" | "requestedClaimsHash" | "nativeBroker" + "state" | "nonce" | "requestedClaimsHash" | "platformBroker" > & { nonce: string; state: string } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml deleted file mode 100644 index af3ac40..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml +++ /dev/null @@ -1,94 +0,0 @@ -### YamlMime:TSType -name: BrowserStorage -uid: '@azure/msal-browser.BrowserStorage' -package: '@azure/msal-browser' -summary: '' -fullName: BrowserStorage -remarks: '' -isDeprecated: true -customDeprecatedMessage: This class will be removed in a future major version -type: class -constructors: - - name: BrowserStorage(string) - uid: '@azure/msal-browser.BrowserStorage.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'new BrowserStorage(cacheLocation: string)' - parameters: - - id: cacheLocation - type: string - description: '' -methods: - - name: containsKey(string) - uid: '@azure/msal-browser.BrowserStorage.containsKey' - package: '@azure/msal-browser' - summary: Returns true or false if the given key is present in the cache. - remarks: '' - isDeprecated: false - syntax: - content: 'function containsKey(key: string): boolean' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: boolean - - name: getItem(string) - uid: '@azure/msal-browser.BrowserStorage.getItem' - package: '@azure/msal-browser' - summary: Get the item from the window storage object matching the given key. - remarks: '' - isDeprecated: false - syntax: - content: 'function getItem(key: string): null | string' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: null | string - - name: getKeys() - uid: '@azure/msal-browser.BrowserStorage.getKeys' - package: '@azure/msal-browser' - summary: >- - Get all the keys from the window storage object as an iterable array of - strings. - remarks: '' - isDeprecated: false - syntax: - content: 'function getKeys(): string[]' - return: - description: '' - type: string[] - - name: removeItem(string) - uid: '@azure/msal-browser.BrowserStorage.removeItem' - package: '@azure/msal-browser' - summary: Removes the item in the window storage object matching the given key. - remarks: '' - isDeprecated: false - syntax: - content: 'function removeItem(key: string)' - parameters: - - id: key - type: string - description: '' - - name: setItem(string, string) - uid: '@azure/msal-browser.BrowserStorage.setItem' - package: '@azure/msal-browser' - summary: Sets the item in the window storage object with the given key. - remarks: '' - isDeprecated: false - syntax: - content: 'function setItem(key: string, value: string)' - parameters: - - id: key - type: string - description: '' - - id: value - type: string - description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml index 1a9c94b..d3b5f38 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml @@ -8,7 +8,7 @@ remarks: '' isDeprecated: false syntax: | type BrowserSystemOptions = SystemOptions & { - allowNativeBroker?: boolean + allowPlatformBroker?: boolean allowRedirectInIframe?: boolean asyncPopups?: boolean iframeHashTimeout?: number diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml b/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml index bc98ac3..8b10b94 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml @@ -17,7 +17,8 @@ methods: syntax: content: >- function loadExternalTokens(request: SilentRequest, response: - ExternalTokenResponse, options: LoadTokenOptions): AuthenticationResult + ExternalTokenResponse, options: LoadTokenOptions): + Promise parameters: - id: request type: @@ -30,4 +31,4 @@ methods: description: '' return: description: '`AuthenticationResult` for the response that was loaded.' - type: + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml index 3d7eb41..1ac6c06 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml @@ -51,6 +51,36 @@ methods: return: description: '' type: string[] + - name: getUserData(string) + uid: '@azure/msal-browser.IWindowStorage.getUserData' + package: '@azure/msal-browser' + summary: Getter for sensitive data that may contain PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function getUserData(key: string): null | T' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: null | T + - name: initialize(string) + uid: '@azure/msal-browser.IWindowStorage.initialize' + package: '@azure/msal-browser' + summary: Async initializer + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(correlationId: string): Promise' + parameters: + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<void> - name: removeItem(string) uid: '@azure/msal-browser.IWindowStorage.removeItem' package: '@azure/msal-browser' @@ -78,3 +108,26 @@ methods: - id: value type: T description: '' + - name: setUserData(string, T, string) + uid: '@azure/msal-browser.IWindowStorage.setUserData' + package: '@azure/msal-browser' + summary: Setter for sensitive data that may contain PII. + remarks: '' + isDeprecated: false + syntax: + content: >- + function setUserData(key: string, value: T, correlationId: string): + Promise + parameters: + - id: key + type: string + description: '' + - id: value + type: T + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.yml index e54d7f6..b29c698 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.yml @@ -7,7 +7,36 @@ fullName: LocalStorage remarks: '' isDeprecated: false type: class +constructors: + - name: LocalStorage(string, Logger, IPerformanceClient) + uid: '@azure/msal-browser.LocalStorage.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new LocalStorage(clientId: string, logger: Logger, performanceClient: + IPerformanceClient) + parameters: + - id: clientId + type: string + description: '' + - id: logger + type: + description: '' + - id: performanceClient + type: + description: '' methods: + - name: clear() + uid: '@azure/msal-browser.LocalStorage.clear' + package: '@azure/msal-browser' + summary: Removes all known MSAL keys from the cache + remarks: '' + isDeprecated: false + syntax: + content: function clear() - name: containsKey(string) uid: '@azure/msal-browser.LocalStorage.containsKey' package: '@azure/msal-browser' @@ -51,6 +80,36 @@ methods: return: description: '' type: string[] + - name: getUserData(string) + uid: '@azure/msal-browser.LocalStorage.getUserData' + package: '@azure/msal-browser' + summary: Getter for sensitive data that may contain PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function getUserData(key: string): null | string' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: null | string + - name: initialize(string) + uid: '@azure/msal-browser.LocalStorage.initialize' + package: '@azure/msal-browser' + summary: Async initializer + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(correlationId: string): Promise' + parameters: + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<void> - name: removeItem(string) uid: '@azure/msal-browser.LocalStorage.removeItem' package: '@azure/msal-browser' @@ -78,3 +137,26 @@ methods: - id: value type: string description: '' + - name: setUserData(string, string, string) + uid: '@azure/msal-browser.LocalStorage.setUserData' + package: '@azure/msal-browser' + summary: Setter for sensitive data that may contain PII. + remarks: '' + isDeprecated: false + syntax: + content: >- + function setUserData(key: string, value: string, correlationId: string): + Promise + parameters: + - id: key + type: string + description: '' + - id: value + type: string + description: '' + - id: correlationId + type: string + description: '' + return: + description: '' + type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml index 733b905..ae90452 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml @@ -59,6 +59,32 @@ methods: return: description: '' type: string[] + - name: getUserData(string) + uid: '@azure/msal-browser.MemoryStorage.getUserData' + package: '@azure/msal-browser' + summary: Getter for sensitive data that may contain PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function getUserData(key: string): null | T' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: null | T + - name: initialize() + uid: '@azure/msal-browser.MemoryStorage.initialize' + package: '@azure/msal-browser' + summary: Async initializer + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(): Promise' + return: + description: '' + type: Promise<void> - name: removeItem(string) uid: '@azure/msal-browser.MemoryStorage.removeItem' package: '@azure/msal-browser' @@ -86,3 +112,21 @@ methods: - id: value type: T description: '' + - name: setUserData(string, T) + uid: '@azure/msal-browser.MemoryStorage.setUserData' + package: '@azure/msal-browser' + summary: Setter for sensitive data that may contain PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function setUserData(key: string, value: T): Promise' + parameters: + - id: key + type: string + description: '' + - id: value + type: T + description: '' + return: + description: '' + type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml index 7a5203e..24b1153 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml @@ -12,7 +12,7 @@ syntax: | type PerformanceEvent = { accessTokenSize?: number accountType?: "AAD" | "MSA" | "B2C" - allowNativeBroker?: boolean + allowPlatformBroker?: boolean appName?: string appVersion?: string authority: string diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml index 744c842..c1acff0 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -146,6 +146,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.AwaitConcurrentIframe' package: '@azure/msal-browser' summary: '' + - name: Base64Decode + uid: '@azure/msal-browser.PerformanceEvents.Base64Decode' + package: '@azure/msal-browser' + summary: '' - name: BaseClientCreateTokenRequestHeaders uid: '@azure/msal-browser.PerformanceEvents.BaseClientCreateTokenRequestHeaders' package: '@azure/msal-browser' @@ -178,16 +182,28 @@ fields: summary: |- signJwt API in CryptoOpts class (msal-browser). Used to signed a pop token. + - name: Decrypt + uid: '@azure/msal-browser.PerformanceEvents.Decrypt' + package: '@azure/msal-browser' + summary: '' - name: DeserializeResponse uid: '@azure/msal-browser.PerformanceEvents.DeserializeResponse' package: '@azure/msal-browser' summary: '' + - name: Encrypt + uid: '@azure/msal-browser.PerformanceEvents.Encrypt' + package: '@azure/msal-browser' + summary: '' - name: FetchAccountIdWithNativeBroker uid: '@azure/msal-browser.PerformanceEvents.FetchAccountIdWithNativeBroker' package: '@azure/msal-browser' summary: |- acquireToken APIs in msal-browser. Used to make an /authorize endpoint call with native brokering enabled. + - name: GenerateBaseKey + uid: '@azure/msal-browser.PerformanceEvents.GenerateBaseKey' + package: '@azure/msal-browser' + summary: '' - name: GenerateCodeChallengeFromVerifier uid: '@azure/msal-browser.PerformanceEvents.GenerateCodeChallengeFromVerifier' package: '@azure/msal-browser' @@ -196,6 +212,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.GenerateCodeVerifier' package: '@azure/msal-browser' summary: '' + - name: GenerateHKDF + uid: '@azure/msal-browser.PerformanceEvents.GenerateHKDF' + package: '@azure/msal-browser' + summary: '' - name: GeneratePkceCodes uid: '@azure/msal-browser.PerformanceEvents.GeneratePkceCodes' package: '@azure/msal-browser' @@ -238,12 +258,20 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.HandleServerTokenResponse' package: '@azure/msal-browser' summary: handleServerTokenResponse API in ResponseHandler (msal-common) + - name: ImportExistingCache + uid: '@azure/msal-browser.PerformanceEvents.ImportExistingCache' + package: '@azure/msal-browser' + summary: '' - name: InitializeBaseRequest uid: '@azure/msal-browser.PerformanceEvents.InitializeBaseRequest' package: '@azure/msal-browser' summary: >- Internal API for initializing base request in BaseInteractionClient (msal-browser) + - name: InitializeCache + uid: '@azure/msal-browser.PerformanceEvents.InitializeCache' + package: '@azure/msal-browser' + summary: '' - name: InitializeClientApplication uid: '@azure/msal-browser.PerformanceEvents.InitializeClientApplication' package: '@azure/msal-browser' @@ -331,6 +359,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.RemoveHiddenIframe' package: '@azure/msal-browser' summary: '' + - name: SetUserData + uid: '@azure/msal-browser.PerformanceEvents.SetUserData' + package: '@azure/msal-browser' + summary: '' - name: Sha256Digest uid: '@azure/msal-browser.PerformanceEvents.Sha256Digest' package: '@azure/msal-browser' @@ -432,6 +464,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.UpdateTokenEndpointAuthority' package: '@azure/msal-browser' summary: '' + - name: UrlEncodeArr + uid: '@azure/msal-browser.PerformanceEvents.UrlEncodeArr' + package: '@azure/msal-browser' + summary: '' - name: UsernamePasswordClientAcquireToken uid: '@azure/msal-browser.PerformanceEvents.UsernamePasswordClientAcquireToken' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml index 184a757..d074a81 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml @@ -86,7 +86,7 @@ syntax: | | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" - | "nativeBroker" + | "platformBroker" > > & { popupWindowAttributes?: PopupWindowAttributes diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml index fb98e03..57306e5 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml @@ -89,7 +89,7 @@ syntax: | | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" - | "nativeBroker" + | "platformBroker" > > & { onRedirectNavigate?: (url: string) => boolean | void diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml index 65db497..5201d05 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml @@ -51,6 +51,32 @@ methods: return: description: '' type: string[] + - name: getUserData(string) + uid: '@azure/msal-browser.SessionStorage.getUserData' + package: '@azure/msal-browser' + summary: Getter for sensitive data that may contain PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function getUserData(key: string): null | string' + parameters: + - id: key + type: string + description: '' + return: + description: '' + type: null | string + - name: initialize() + uid: '@azure/msal-browser.SessionStorage.initialize' + package: '@azure/msal-browser' + summary: Async initializer + remarks: '' + isDeprecated: false + syntax: + content: 'function initialize(): Promise' + return: + description: '' + type: Promise<void> - name: removeItem(string) uid: '@azure/msal-browser.SessionStorage.removeItem' package: '@azure/msal-browser' @@ -78,3 +104,21 @@ methods: - id: value type: string description: '' + - name: setUserData(string, string) + uid: '@azure/msal-browser.SessionStorage.setUserData' + package: '@azure/msal-browser' + summary: Setter for sensitive data that may contain PII. + remarks: '' + isDeprecated: false + syntax: + content: 'function setUserData(key: string, value: string): Promise' + parameters: + - id: key + type: string + description: '' + - id: value + type: string + description: '' + return: + description: '' + type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml index 41dbf43..67f29a5 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml @@ -77,6 +77,6 @@ syntax: | | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" - | "nativeBroker" + | "platformBroker" > > & { tokenBodyParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/index.yml b/msal/docs-ref-autogen/@azure/msal-browser/index.yml index 6e16905..8c875ca 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/index.yml @@ -14,7 +14,6 @@ classes: - '@azure/msal-browser.BrowserConfigurationAuthError' - '@azure/msal-browser.BrowserPerformanceClient' - '@azure/msal-browser.BrowserPerformanceMeasurement' - - '@azure/msal-browser.BrowserStorage' - '@azure/msal-browser.ClientAuthError' - '@azure/msal-browser.ClientConfigurationError' - '@azure/msal-browser.EventHandler' diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml index e61243c..b8da7ac 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml @@ -97,8 +97,8 @@ syntax: | extraQueryParameters?: StringDict extraScopesToConsent?: string[] loginHint?: string - nativeBroker?: boolean nonce?: string + platformBroker?: boolean prompt?: string redirectUri: string responseMode: ResponseMode diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml index 9ca4ab9..4bfe4f3 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -12,7 +12,7 @@ syntax: | type PerformanceEvent = { accessTokenSize?: number accountType?: "AAD" | "MSA" | "B2C" - allowNativeBroker?: boolean + allowPlatformBroker?: boolean appName?: string appVersion?: string authority: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml index 5f8f42e..6714ae2 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml @@ -145,6 +145,10 @@ fields: uid: '@azure/msal-common.PerformanceEvents.AwaitConcurrentIframe' package: '@azure/msal-common' summary: '' + - name: Base64Decode + uid: '@azure/msal-common.PerformanceEvents.Base64Decode' + package: '@azure/msal-common' + summary: '' - name: BaseClientCreateTokenRequestHeaders uid: '@azure/msal-common.PerformanceEvents.BaseClientCreateTokenRequestHeaders' package: '@azure/msal-common' @@ -177,16 +181,28 @@ fields: summary: |- signJwt API in CryptoOpts class (msal-browser). Used to signed a pop token. + - name: Decrypt + uid: '@azure/msal-common.PerformanceEvents.Decrypt' + package: '@azure/msal-common' + summary: '' - name: DeserializeResponse uid: '@azure/msal-common.PerformanceEvents.DeserializeResponse' package: '@azure/msal-common' summary: '' + - name: Encrypt + uid: '@azure/msal-common.PerformanceEvents.Encrypt' + package: '@azure/msal-common' + summary: '' - name: FetchAccountIdWithNativeBroker uid: '@azure/msal-common.PerformanceEvents.FetchAccountIdWithNativeBroker' package: '@azure/msal-common' summary: |- acquireToken APIs in msal-browser. Used to make an /authorize endpoint call with native brokering enabled. + - name: GenerateBaseKey + uid: '@azure/msal-common.PerformanceEvents.GenerateBaseKey' + package: '@azure/msal-common' + summary: '' - name: GenerateCodeChallengeFromVerifier uid: '@azure/msal-common.PerformanceEvents.GenerateCodeChallengeFromVerifier' package: '@azure/msal-common' @@ -195,6 +211,10 @@ fields: uid: '@azure/msal-common.PerformanceEvents.GenerateCodeVerifier' package: '@azure/msal-common' summary: '' + - name: GenerateHKDF + uid: '@azure/msal-common.PerformanceEvents.GenerateHKDF' + package: '@azure/msal-common' + summary: '' - name: GeneratePkceCodes uid: '@azure/msal-common.PerformanceEvents.GeneratePkceCodes' package: '@azure/msal-common' @@ -237,12 +257,20 @@ fields: uid: '@azure/msal-common.PerformanceEvents.HandleServerTokenResponse' package: '@azure/msal-common' summary: handleServerTokenResponse API in ResponseHandler (msal-common) + - name: ImportExistingCache + uid: '@azure/msal-common.PerformanceEvents.ImportExistingCache' + package: '@azure/msal-common' + summary: '' - name: InitializeBaseRequest uid: '@azure/msal-common.PerformanceEvents.InitializeBaseRequest' package: '@azure/msal-common' summary: >- Internal API for initializing base request in BaseInteractionClient (msal-browser) + - name: InitializeCache + uid: '@azure/msal-common.PerformanceEvents.InitializeCache' + package: '@azure/msal-common' + summary: '' - name: InitializeClientApplication uid: '@azure/msal-common.PerformanceEvents.InitializeClientApplication' package: '@azure/msal-common' @@ -329,6 +357,10 @@ fields: uid: '@azure/msal-common.PerformanceEvents.RemoveHiddenIframe' package: '@azure/msal-common' summary: '' + - name: SetUserData + uid: '@azure/msal-common.PerformanceEvents.SetUserData' + package: '@azure/msal-common' + summary: '' - name: Sha256Digest uid: '@azure/msal-common.PerformanceEvents.Sha256Digest' package: '@azure/msal-common' @@ -430,6 +462,10 @@ fields: uid: '@azure/msal-common.PerformanceEvents.UpdateTokenEndpointAuthority' package: '@azure/msal-common' summary: '' + - name: UrlEncodeArr + uid: '@azure/msal-common.PerformanceEvents.UrlEncodeArr' + package: '@azure/msal-common' + summary: '' - name: UsernamePasswordClientAcquireToken uid: '@azure/msal-common.PerformanceEvents.UsernamePasswordClientAcquireToken' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml deleted file mode 100644 index 99f7024..0000000 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml +++ /dev/null @@ -1,1170 +0,0 @@ -### YamlMime:TSType -name: NodeStorage -uid: '@azure/msal-node.NodeStorage' -package: '@azure/msal-node' -summary: >- - This class implements Storage for node, reading cache from user specified - storage location or an extension library -fullName: NodeStorage -remarks: '' -isDeprecated: false -type: class -constructors: - - name: NodeStorage(Logger, string, ICrypto, StaticAuthorityOptions) - uid: '@azure/msal-node.NodeStorage.constructor' - package: '@azure/msal-node' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - new NodeStorage(logger: Logger, clientId: string, cryptoImpl: ICrypto, - staticAuthorityOptions?: StaticAuthorityOptions) - parameters: - - id: logger - type: - description: '' - - id: clientId - type: string - description: '' - - id: cryptoImpl - type: - description: '' - - id: staticAuthorityOptions - type: - description: '' -inheritedMethods: - - name: accessTokenKeyMatchesFilter(string, CredentialFilter, boolean) - uid: '@azure/msal-node.NodeStorage.accessTokenKeyMatchesFilter' - package: '@azure/msal-node' - summary: >- - Validate the cache key against filter before retrieving and parsing cache - value - remarks: '' - isDeprecated: false - syntax: - content: >- - function accessTokenKeyMatchesFilter(inputKey: string, filter: - CredentialFilter, keyMustContainAllScopes: boolean): boolean - parameters: - - id: inputKey - type: string - description: '' - - id: filter - type: - description: '' - - id: keyMustContainAllScopes - type: boolean - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.accessTokenKeyMatchesFilter - - name: credentialMatchesFilter(ValidCredentialType, CredentialFilter) - uid: '@azure/msal-node.NodeStorage.credentialMatchesFilter' - package: '@azure/msal-node' - summary: Returns whether or not the given credential entity matches the filter - remarks: '' - isDeprecated: false - syntax: - content: >- - function credentialMatchesFilter(entity: ValidCredentialType, filter: - CredentialFilter): boolean - parameters: - - id: entity - type: - description: '' - - id: filter - type: - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.credentialMatchesFilter - - name: generateAuthorityMetadataCacheKey(string) - uid: '@azure/msal-node.NodeStorage.generateAuthorityMetadataCacheKey' - package: '@azure/msal-node' - summary: returns cache key used for cloud instance metadata - remarks: '' - isDeprecated: false - syntax: - content: 'function generateAuthorityMetadataCacheKey(authority: string): string' - parameters: - - id: authority - type: string - description: '' - return: - description: '' - type: string - inheritanceDescription: Inherited From CacheManager.generateAuthorityMetadataCacheKey - - name: >- - getAccessToken(AccountInfo, BaseAuthRequest, TokenKeys, string, - IPerformanceClient, string) - uid: '@azure/msal-node.NodeStorage.getAccessToken' - package: '@azure/msal-node' - summary: Retrieve AccessTokenEntity from cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function getAccessToken(account: AccountInfo, request: BaseAuthRequest, - tokenKeys?: TokenKeys, targetRealm?: string, performanceClient?: - IPerformanceClient, correlationId?: string): null | AccessTokenEntity - parameters: - - id: account - type: - description: '{AccountInfo}' - - id: request - type: - description: '{BaseAuthRequest}' - - id: tokenKeys - type: - description: '{?TokenKeys}' - - id: targetRealm - type: string - description: '' - - id: performanceClient - type: - description: '{?IPerformanceClient}' - - id: correlationId - type: string - description: '{?string}' - return: - description: '' - type: null | - inheritanceDescription: Inherited From CacheManager.getAccessToken - - name: getAccessTokensByFilter(CredentialFilter) - uid: '@azure/msal-node.NodeStorage.getAccessTokensByFilter' - package: '@azure/msal-node' - summary: Gets all access tokens matching the filter - remarks: '' - isDeprecated: false - syntax: - content: >- - function getAccessTokensByFilter(filter: CredentialFilter): - AccessTokenEntity[] - parameters: - - id: filter - type: - description: '' - return: - description: '' - type: [] - inheritanceDescription: Inherited From CacheManager.getAccessTokensByFilter - - name: getAccountInfoFilteredBy(AccountFilter) - uid: '@azure/msal-node.NodeStorage.getAccountInfoFilteredBy' - package: '@azure/msal-node' - summary: Gets first tenanted AccountInfo object found based on provided filters - remarks: '' - isDeprecated: false - syntax: - content: >- - function getAccountInfoFilteredBy(accountFilter: AccountFilter): null | - AccountInfo - parameters: - - id: accountFilter - type: - description: '' - return: - description: '' - type: null | - inheritanceDescription: Inherited From CacheManager.getAccountInfoFilteredBy - - name: getAccountsFilteredBy(AccountFilter) - uid: '@azure/msal-node.NodeStorage.getAccountsFilteredBy' - package: '@azure/msal-node' - summary: >- - Retrieve account entities matching all provided tenant-agnostic filters; - if no filter is set, get all account entities in the cache - - Not checking for casing as keys are all generated in lower case, remember - to convert to lower case if object properties are compared - remarks: '' - isDeprecated: false - syntax: - content: >- - function getAccountsFilteredBy(accountFilter: AccountFilter): - AccountEntity[] - parameters: - - id: accountFilter - type: - description: An object containing Account properties to filter by - return: - description: '' - type: [] - inheritanceDescription: Inherited From CacheManager.getAccountsFilteredBy - - name: getAllAccounts(AccountFilter) - uid: '@azure/msal-node.NodeStorage.getAllAccounts' - package: '@azure/msal-node' - summary: >- - Returns all the accounts in the cache that match the optional filter. If - no filter is provided, all accounts are returned. - remarks: '' - isDeprecated: false - syntax: - content: 'function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]' - parameters: - - id: accountFilter - type: - description: (Optional) filter to narrow down the accounts returned - return: - description: Array of AccountInfo objects in cache - type: [] - inheritanceDescription: Inherited From CacheManager.getAllAccounts - - name: getAppMetadataFilteredBy(AppMetadataFilter) - uid: '@azure/msal-node.NodeStorage.getAppMetadataFilteredBy' - package: '@azure/msal-node' - summary: >- - retrieve appMetadata matching all provided filters; if no filter is set, - get all appMetadata - remarks: '' - isDeprecated: false - syntax: - content: >- - function getAppMetadataFilteredBy(filter: AppMetadataFilter): - AppMetadataCache - parameters: - - id: filter - type: - description: '' - return: - description: '' - type: - inheritanceDescription: Inherited From CacheManager.getAppMetadataFilteredBy - - name: getAuthorityMetadataByAlias(string) - uid: '@azure/msal-node.NodeStorage.getAuthorityMetadataByAlias' - package: '@azure/msal-node' - summary: retrieve authorityMetadata that contains a matching alias - remarks: '' - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadataByAlias(host: string): null | - AuthorityMetadataEntity - parameters: - - id: host - type: string - description: '' - return: - description: '' - type: null | - inheritanceDescription: Inherited From CacheManager.getAuthorityMetadataByAlias - - name: getBaseAccountInfo(AccountFilter) - uid: '@azure/msal-node.NodeStorage.getBaseAccountInfo' - package: '@azure/msal-node' - summary: Returns a single matching - remarks: '' - isDeprecated: false - syntax: - content: >- - function getBaseAccountInfo(accountFilter: AccountFilter): null | - AccountInfo - parameters: - - id: accountFilter - type: - description: '' - return: - description: '' - type: null | - inheritanceDescription: Inherited From CacheManager.getBaseAccountInfo - - name: getIdToken(AccountInfo, TokenKeys, string, IPerformanceClient, string) - uid: '@azure/msal-node.NodeStorage.getIdToken' - package: '@azure/msal-node' - summary: Retrieve IdTokenEntity from cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function getIdToken(account: AccountInfo, tokenKeys?: TokenKeys, - targetRealm?: string, performanceClient?: IPerformanceClient, - correlationId?: string): null | IdTokenEntity - parameters: - - id: account - type: - description: '{AccountInfo}' - - id: tokenKeys - type: - description: '{?TokenKeys}' - - id: targetRealm - type: string - description: '{?string}' - - id: performanceClient - type: - description: '{?IPerformanceClient}' - - id: correlationId - type: string - description: '{?string}' - return: - description: '' - type: null | - inheritanceDescription: Inherited From CacheManager.getIdToken - - name: getIdTokensByFilter(CredentialFilter, TokenKeys) - uid: '@azure/msal-node.NodeStorage.getIdTokensByFilter' - package: '@azure/msal-node' - summary: Gets all idTokens matching the given filter - remarks: '' - isDeprecated: false - syntax: - content: >- - function getIdTokensByFilter(filter: CredentialFilter, tokenKeys?: - TokenKeys): Map - parameters: - - id: filter - type: - description: '' - - id: tokenKeys - type: - description: '' - return: - description: '' - type: Map<string, > - inheritanceDescription: Inherited From CacheManager.getIdTokensByFilter - - name: >- - getRefreshToken(AccountInfo, boolean, TokenKeys, IPerformanceClient, - string) - uid: '@azure/msal-node.NodeStorage.getRefreshToken' - package: '@azure/msal-node' - summary: Helper to retrieve the appropriate refresh token from cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function getRefreshToken(account: AccountInfo, familyRT: boolean, - tokenKeys?: TokenKeys, performanceClient?: IPerformanceClient, - correlationId?: string): null | RefreshTokenEntity - parameters: - - id: account - type: - description: '{AccountInfo}' - - id: familyRT - type: boolean - description: '{boolean}' - - id: tokenKeys - type: - description: '{?TokenKeys}' - - id: performanceClient - type: - description: '{?IPerformanceClient}' - - id: correlationId - type: string - description: '{?string}' - return: - description: '' - type: null | - inheritanceDescription: Inherited From CacheManager.getRefreshToken - - name: idTokenKeyMatchesFilter(string, CredentialFilter) - uid: '@azure/msal-node.NodeStorage.idTokenKeyMatchesFilter' - package: '@azure/msal-node' - summary: >- - Validate the cache key against filter before retrieving and parsing cache - value - remarks: '' - isDeprecated: false - syntax: - content: >- - function idTokenKeyMatchesFilter(inputKey: string, filter: - CredentialFilter): boolean - parameters: - - id: inputKey - type: string - description: '' - - id: filter - type: - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.idTokenKeyMatchesFilter - - name: isAccountKey(string, string, string) - uid: '@azure/msal-node.NodeStorage.isAccountKey' - package: '@azure/msal-node' - summary: >- - Returns true if the given key matches our account key schema. Also matches - homeAccountId and/or tenantId if provided - remarks: '' - isDeprecated: false - syntax: - content: >- - function isAccountKey(key: string, homeAccountId?: string, tenantId?: - string): boolean - parameters: - - id: key - type: string - description: '' - - id: homeAccountId - type: string - description: '' - - id: tenantId - type: string - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.isAccountKey - - name: isAppMetadataFOCI(string) - uid: '@azure/msal-node.NodeStorage.isAppMetadataFOCI' - package: '@azure/msal-node' - summary: Return the family_id value associated with FOCI - remarks: '' - isDeprecated: false - syntax: - content: 'function isAppMetadataFOCI(environment: string): boolean' - parameters: - - id: environment - type: string - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.isAppMetadataFOCI - - name: isCredentialKey(string) - uid: '@azure/msal-node.NodeStorage.isCredentialKey' - package: '@azure/msal-node' - summary: Returns true if the given key matches our credential key schema. - remarks: '' - isDeprecated: false - syntax: - content: 'function isCredentialKey(key: string): boolean' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.isCredentialKey - - name: readAccountFromCache(AccountInfo) - uid: '@azure/msal-node.NodeStorage.readAccountFromCache' - package: '@azure/msal-node' - summary: Retrieve AccountEntity from cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function readAccountFromCache(account: AccountInfo): null | - AccountEntity - parameters: - - id: account - type: - description: '' - return: - description: '' - type: null | - inheritanceDescription: Inherited From CacheManager.readAccountFromCache - - name: readAppMetadataFromCache(string) - uid: '@azure/msal-node.NodeStorage.readAppMetadataFromCache' - package: '@azure/msal-node' - summary: Retrieve AppMetadataEntity from cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function readAppMetadataFromCache(environment: string): null | - AppMetadataEntity - parameters: - - id: environment - type: string - description: '' - return: - description: '' - type: null | - inheritanceDescription: Inherited From CacheManager.readAppMetadataFromCache - - name: refreshTokenKeyMatchesFilter(string, CredentialFilter) - uid: '@azure/msal-node.NodeStorage.refreshTokenKeyMatchesFilter' - package: '@azure/msal-node' - summary: >- - Validate the cache key against filter before retrieving and parsing cache - value - remarks: '' - isDeprecated: false - syntax: - content: >- - function refreshTokenKeyMatchesFilter(inputKey: string, filter: - CredentialFilter): boolean - parameters: - - id: inputKey - type: string - description: '' - - id: filter - type: - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.refreshTokenKeyMatchesFilter - - name: removeAccessToken(string) - uid: '@azure/msal-node.NodeStorage.removeAccessToken' - package: '@azure/msal-node' - summary: returns a boolean if the given credential is removed - remarks: '' - isDeprecated: false - syntax: - content: 'function removeAccessToken(key: string): Promise' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CacheManager.removeAccessToken - - name: removeAccount(string) - uid: '@azure/msal-node.NodeStorage.removeAccount' - package: '@azure/msal-node' - summary: Removes the account and related tokens for a given account key - remarks: '' - isDeprecated: false - syntax: - content: 'function removeAccount(accountKey: string): Promise' - parameters: - - id: accountKey - type: string - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CacheManager.removeAccount - - name: removeAccountContext(AccountEntity) - uid: '@azure/msal-node.NodeStorage.removeAccountContext' - package: '@azure/msal-node' - summary: Removes credentials associated with the provided account - remarks: '' - isDeprecated: false - syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' - parameters: - - id: account - type: - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CacheManager.removeAccountContext - - name: removeAllAccounts() - uid: '@azure/msal-node.NodeStorage.removeAllAccounts' - package: '@azure/msal-node' - summary: Removes all accounts and related tokens from cache. - remarks: '' - isDeprecated: false - syntax: - content: 'function removeAllAccounts(): Promise' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CacheManager.removeAllAccounts - - name: removeAppMetadata() - uid: '@azure/msal-node.NodeStorage.removeAppMetadata' - package: '@azure/msal-node' - summary: Removes all app metadata objects from cache. - remarks: '' - isDeprecated: false - syntax: - content: 'function removeAppMetadata(): boolean' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.removeAppMetadata - - name: removeIdToken(string) - uid: '@azure/msal-node.NodeStorage.removeIdToken' - package: '@azure/msal-node' - summary: Removes idToken from the cache - remarks: '' - isDeprecated: false - syntax: - content: 'function removeIdToken(key: string)' - parameters: - - id: key - type: string - description: '' - inheritanceDescription: Inherited From CacheManager.removeIdToken - - name: removeRefreshToken(string) - uid: '@azure/msal-node.NodeStorage.removeRefreshToken' - package: '@azure/msal-node' - summary: Removes refresh token from the cache - remarks: '' - isDeprecated: false - syntax: - content: 'function removeRefreshToken(key: string)' - parameters: - - id: key - type: string - description: '' - inheritanceDescription: Inherited From CacheManager.removeRefreshToken - - name: saveCacheRecord(CacheRecord, StoreInCache, string) - uid: '@azure/msal-node.NodeStorage.saveCacheRecord' - package: '@azure/msal-node' - summary: saves a cache record - remarks: '' - isDeprecated: false - syntax: - content: >- - function saveCacheRecord(cacheRecord: CacheRecord, storeInCache?: - StoreInCache, correlationId?: string): Promise - parameters: - - id: cacheRecord - type: - description: '{CacheRecord}' - - id: storeInCache - type: - description: '{?StoreInCache}' - - id: correlationId - type: string - description: '{?string} correlation id' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CacheManager.saveCacheRecord - - name: toObject(T, object) - uid: '@azure/msal-node.NodeStorage.toObject' - package: '@azure/msal-node' - summary: Helper to convert serialized data to object - remarks: '' - isDeprecated: false - syntax: - content: 'static function toObject(obj: T, json: object): T' - parameters: - - id: obj - type: T - description: '' - - id: json - type: object - description: '' - return: - description: '' - type: T - inheritanceDescription: Inherited From CacheManager.toObject -methods: - - name: cacheToInMemoryCache(CacheKVStore) - uid: '@azure/msal-node.NodeStorage.cacheToInMemoryCache' - package: '@azure/msal-node' - summary: Converts cacheKVStore to InMemoryCache - remarks: '' - isDeprecated: false - syntax: - content: 'function cacheToInMemoryCache(cache: CacheKVStore): InMemoryCache' - parameters: - - id: cache - type: - description: key value store - return: - description: '' - type: - - name: clear() - uid: '@azure/msal-node.NodeStorage.clear' - package: '@azure/msal-node' - summary: Clears all cache entries created by MSAL (except tokens). - remarks: '' - isDeprecated: false - syntax: - content: function clear() - - name: containsKey(string) - uid: '@azure/msal-node.NodeStorage.containsKey' - package: '@azure/msal-node' - summary: Checks whether key is in cache. - remarks: '' - isDeprecated: false - syntax: - content: 'function containsKey(key: string): boolean' - parameters: - - id: key - type: string - description: look up key for a cache entity - return: - description: '' - type: boolean - - name: emitChange() - uid: '@azure/msal-node.NodeStorage.emitChange' - package: '@azure/msal-node' - summary: Invoke the callback when cache changes - remarks: '' - isDeprecated: false - syntax: - content: function emitChange() - - name: generateInMemoryCache(string) - uid: '@azure/msal-node.NodeStorage.generateInMemoryCache' - package: '@azure/msal-node' - summary: Initialize in memory cache from an exisiting cache vault - remarks: '' - isDeprecated: false - syntax: - content: 'static function generateInMemoryCache(cache: string): InMemoryCache' - parameters: - - id: cache - type: string - description: blob formatted cache (JSON) - return: - description: '' - type: - - name: generateJsonCache(InMemoryCache) - uid: '@azure/msal-node.NodeStorage.generateJsonCache' - package: '@azure/msal-node' - summary: retrieves the final JSON - remarks: '' - isDeprecated: false - syntax: - content: >- - static function generateJsonCache(inMemoryCache: InMemoryCache): - JsonCache - parameters: - - id: inMemoryCache - type: - description: itemised cache read from the JSON - return: - description: '' - type: - - name: getAccessTokenCredential(string) - uid: '@azure/msal-node.NodeStorage.getAccessTokenCredential' - package: '@azure/msal-node' - summary: fetch the accessToken credential - remarks: '' - isDeprecated: false - syntax: - content: >- - function getAccessTokenCredential(accessTokenKey: string): null | - AccessTokenEntity - parameters: - - id: accessTokenKey - type: string - description: lookup key to fetch cache type AccessTokenEntity - return: - description: '' - type: null | - - name: getAccount(string) - uid: '@azure/msal-node.NodeStorage.getAccount' - package: '@azure/msal-node' - summary: fetch the account entity - remarks: '' - isDeprecated: false - syntax: - content: 'function getAccount(accountKey: string): null | AccountEntity' - parameters: - - id: accountKey - type: string - description: lookup key to fetch cache type AccountEntity - return: - description: '' - type: null | - - name: getAccountKeys() - uid: '@azure/msal-node.NodeStorage.getAccountKeys' - package: '@azure/msal-node' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function getAccountKeys(): string[]' - return: - description: '' - type: string[] - - name: getAppMetadata(string) - uid: '@azure/msal-node.NodeStorage.getAppMetadata' - package: '@azure/msal-node' - summary: fetch appMetadata entity from the platform cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function getAppMetadata(appMetadataKey: string): null | - AppMetadataEntity - parameters: - - id: appMetadataKey - type: string - description: lookup key to fetch cache type AppMetadataEntity - return: - description: '' - type: null | - - name: getAuthorityMetadata(string) - uid: '@azure/msal-node.NodeStorage.getAuthorityMetadata' - package: '@azure/msal-node' - summary: fetch authority metadata entity from the platform cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadata(key: string): null | - AuthorityMetadataEntity - parameters: - - id: key - type: string - description: lookup key to fetch cache type AuthorityMetadataEntity - return: - description: '' - type: null | - - name: getAuthorityMetadataKeys() - uid: '@azure/msal-node.NodeStorage.getAuthorityMetadataKeys' - package: '@azure/msal-node' - summary: Get all authority metadata keys - remarks: '' - isDeprecated: false - syntax: - content: 'function getAuthorityMetadataKeys(): string[]' - return: - description: '' - type: string[] - - name: getCache() - uid: '@azure/msal-node.NodeStorage.getCache' - package: '@azure/msal-node' - summary: get the current cache key-value store - remarks: '' - isDeprecated: false - syntax: - content: 'function getCache(): CacheKVStore' - return: - description: '' - type: - - name: getCachedAccountEntity(string) - uid: '@azure/msal-node.NodeStorage.getCachedAccountEntity' - package: '@azure/msal-node' - summary: Reads account from cache, builds it into an account entity and returns it. - remarks: '' - isDeprecated: false - syntax: - content: >- - function getCachedAccountEntity(accountKey: string): null | - AccountEntity - parameters: - - id: accountKey - type: string - description: lookup key to fetch cache type AccountEntity - return: - description: '' - type: null | - - name: getIdTokenCredential(string) - uid: '@azure/msal-node.NodeStorage.getIdTokenCredential' - package: '@azure/msal-node' - summary: fetch the idToken credential - remarks: '' - isDeprecated: false - syntax: - content: 'function getIdTokenCredential(idTokenKey: string): null | IdTokenEntity' - parameters: - - id: idTokenKey - type: string - description: lookup key to fetch cache type IdTokenEntity - return: - description: '' - type: null | - - name: getInMemoryCache() - uid: '@azure/msal-node.NodeStorage.getInMemoryCache' - package: '@azure/msal-node' - summary: gets the current in memory cache for the client - remarks: '' - isDeprecated: false - syntax: - content: 'function getInMemoryCache(): InMemoryCache' - return: - description: '' - type: - - name: getItem(string) - uid: '@azure/msal-node.NodeStorage.getItem' - package: '@azure/msal-node' - summary: Gets cache item with given key. - remarks: '' - isDeprecated: false - syntax: - content: 'function getItem(key: string): ValidCacheType' - parameters: - - id: key - type: string - description: lookup key for the cache entry - return: - description: '' - type: - - name: getKeys() - uid: '@azure/msal-node.NodeStorage.getKeys' - package: '@azure/msal-node' - summary: Gets all keys in window. - remarks: '' - isDeprecated: false - syntax: - content: 'function getKeys(): string[]' - return: - description: '' - type: string[] - - name: getRefreshTokenCredential(string) - uid: '@azure/msal-node.NodeStorage.getRefreshTokenCredential' - package: '@azure/msal-node' - summary: fetch the refreshToken credential - remarks: '' - isDeprecated: false - syntax: - content: >- - function getRefreshTokenCredential(refreshTokenKey: string): null | - RefreshTokenEntity - parameters: - - id: refreshTokenKey - type: string - description: lookup key to fetch cache type RefreshTokenEntity - return: - description: '' - type: null | - - name: getServerTelemetry(string) - uid: '@azure/msal-node.NodeStorage.getServerTelemetry' - package: '@azure/msal-node' - summary: fetch server telemetry entity from the platform cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function getServerTelemetry(serverTelemetrykey: string): null | - ServerTelemetryEntity - parameters: - - id: serverTelemetrykey - type: string - description: lookup key to fetch cache type ServerTelemetryEntity - return: - description: '' - type: null | - - name: getThrottlingCache(string) - uid: '@azure/msal-node.NodeStorage.getThrottlingCache' - package: '@azure/msal-node' - summary: fetch throttling entity from the platform cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function getThrottlingCache(throttlingCacheKey: string): null | - ThrottlingEntity - parameters: - - id: throttlingCacheKey - type: string - description: lookup key to fetch cache type ThrottlingEntity - return: - description: '' - type: null | - - name: getTokenKeys() - uid: '@azure/msal-node.NodeStorage.getTokenKeys' - package: '@azure/msal-node' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function getTokenKeys(): TokenKeys' - return: - description: '' - type: - - name: inMemoryCacheToCache(InMemoryCache) - uid: '@azure/msal-node.NodeStorage.inMemoryCacheToCache' - package: '@azure/msal-node' - summary: converts inMemoryCache to CacheKVStore - remarks: '' - isDeprecated: false - syntax: - content: >- - function inMemoryCacheToCache(inMemoryCache: InMemoryCache): - CacheKVStore - parameters: - - id: inMemoryCache - type: - description: kvstore map for inmemory - return: - description: '' - type: - - name: registerChangeEmitter(() => void) - uid: '@azure/msal-node.NodeStorage.registerChangeEmitter' - package: '@azure/msal-node' - summary: Queue up callbacks - remarks: '' - isDeprecated: false - syntax: - content: 'function registerChangeEmitter(func: () => void)' - parameters: - - id: func - type: () => void - description: a callback function for cache change indication - - name: removeItem(string) - uid: '@azure/msal-node.NodeStorage.removeItem' - package: '@azure/msal-node' - summary: Removes the cache item from memory with the given key. - remarks: '' - isDeprecated: false - syntax: - content: 'function removeItem(key: string): boolean' - parameters: - - id: key - type: string - description: lookup key to remove a cache entity - return: - description: '' - type: boolean - - name: removeOutdatedAccount(string) - uid: '@azure/msal-node.NodeStorage.removeOutdatedAccount' - package: '@azure/msal-node' - summary: Remove account entity from the platform cache if it's outdated - remarks: '' - isDeprecated: false - syntax: - content: 'function removeOutdatedAccount(accountKey: string)' - parameters: - - id: accountKey - type: string - description: lookup key to fetch cache type AccountEntity - - name: setAccessTokenCredential(AccessTokenEntity) - uid: '@azure/msal-node.NodeStorage.setAccessTokenCredential' - package: '@azure/msal-node' - summary: set accessToken credential - remarks: '' - isDeprecated: false - syntax: - content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' - parameters: - - id: accessToken - type: - description: cache value to be set of type AccessTokenEntity - - name: setAccount(AccountEntity) - uid: '@azure/msal-node.NodeStorage.setAccount' - package: '@azure/msal-node' - summary: set account entity - remarks: '' - isDeprecated: false - syntax: - content: 'function setAccount(account: AccountEntity)' - parameters: - - id: account - type: - description: cache value to be set of type AccountEntity - - name: setAppMetadata(AppMetadataEntity) - uid: '@azure/msal-node.NodeStorage.setAppMetadata' - package: '@azure/msal-node' - summary: set appMetadata entity to the platform cache - remarks: '' - isDeprecated: false - syntax: - content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' - parameters: - - id: appMetadata - type: - description: cache value to be set of type AppMetadataEntity - - name: setAuthorityMetadata(string, AuthorityMetadataEntity) - uid: '@azure/msal-node.NodeStorage.setAuthorityMetadata' - package: '@azure/msal-node' - summary: set authority metadata entity to the platform cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function setAuthorityMetadata(key: string, metadata: - AuthorityMetadataEntity) - parameters: - - id: key - type: string - description: lookup key to fetch cache type AuthorityMetadataEntity - - id: metadata - type: - description: cache value to be set of type AuthorityMetadataEntity - - name: setCache(CacheKVStore) - uid: '@azure/msal-node.NodeStorage.setCache' - package: '@azure/msal-node' - summary: sets the current cache (key value store) - remarks: '' - isDeprecated: false - syntax: - content: 'function setCache(cache: CacheKVStore)' - parameters: - - id: cache - type: - description: '' - - name: setIdTokenCredential(IdTokenEntity) - uid: '@azure/msal-node.NodeStorage.setIdTokenCredential' - package: '@azure/msal-node' - summary: set idToken credential - remarks: '' - isDeprecated: false - syntax: - content: 'function setIdTokenCredential(idToken: IdTokenEntity)' - parameters: - - id: idToken - type: - description: cache value to be set of type IdTokenEntity - - name: setInMemoryCache(InMemoryCache) - uid: '@azure/msal-node.NodeStorage.setInMemoryCache' - package: '@azure/msal-node' - summary: sets the current in memory cache for the client - remarks: '' - isDeprecated: false - syntax: - content: 'function setInMemoryCache(inMemoryCache: InMemoryCache)' - parameters: - - id: inMemoryCache - type: - description: key value map in memory - - name: setItem(string, ValidCacheType) - uid: '@azure/msal-node.NodeStorage.setItem' - package: '@azure/msal-node' - summary: Gets cache item with given key-value - remarks: '' - isDeprecated: false - syntax: - content: 'function setItem(key: string, value: ValidCacheType)' - parameters: - - id: key - type: string - description: lookup key for the cache entry - - id: value - type: - description: value of the cache entry - - name: setRefreshTokenCredential(RefreshTokenEntity) - uid: '@azure/msal-node.NodeStorage.setRefreshTokenCredential' - package: '@azure/msal-node' - summary: set refreshToken credential - remarks: '' - isDeprecated: false - syntax: - content: 'function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)' - parameters: - - id: refreshToken - type: - description: cache value to be set of type RefreshTokenEntity - - name: setServerTelemetry(string, ServerTelemetryEntity) - uid: '@azure/msal-node.NodeStorage.setServerTelemetry' - package: '@azure/msal-node' - summary: set server telemetry entity to the platform cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function setServerTelemetry(serverTelemetryKey: string, serverTelemetry: - ServerTelemetryEntity) - parameters: - - id: serverTelemetryKey - type: string - description: lookup key to fetch cache type ServerTelemetryEntity - - id: serverTelemetry - type: - description: cache value to be set of type ServerTelemetryEntity - - name: setThrottlingCache(string, ThrottlingEntity) - uid: '@azure/msal-node.NodeStorage.setThrottlingCache' - package: '@azure/msal-node' - summary: set throttling entity to the platform cache - remarks: '' - isDeprecated: false - syntax: - content: >- - function setThrottlingCache(throttlingCacheKey: string, throttlingCache: - ThrottlingEntity) - parameters: - - id: throttlingCacheKey - type: string - description: lookup key to fetch cache type ThrottlingEntity - - id: throttlingCache - type: - description: cache value to be set of type ThrottlingEntity - - name: updateCredentialCacheKey(string, ValidCredentialType) - uid: '@azure/msal-node.NodeStorage.updateCredentialCacheKey' - package: '@azure/msal-node' - summary: Updates a credential's cache key if the current cache key is outdated - remarks: '' - isDeprecated: false - syntax: - content: >- - function updateCredentialCacheKey(currentCacheKey: string, credential: - ValidCredentialType): string - parameters: - - id: currentCacheKey - type: string - description: '' - - id: credential - type: - description: '' - return: - description: '' - type: string -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml b/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml index 63369a0..1d29ead 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml @@ -20,7 +20,7 @@ constructors: ICachePlugin) parameters: - id: storage - type: + type: NodeStorage description: '' - id: logger type: diff --git a/msal/docs-ref-autogen/@azure/msal-node/index.yml b/msal/docs-ref-autogen/@azure/msal-node/index.yml index efcf6d9..ba446c5 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/index.yml @@ -19,7 +19,6 @@ classes: - '@azure/msal-node.InteractionRequiredAuthError' - '@azure/msal-node.Logger' - '@azure/msal-node.ManagedIdentityApplication' - - '@azure/msal-node.NodeStorage' - '@azure/msal-node.OnBehalfOfClient' - '@azure/msal-node.PublicClientApplication' - '@azure/msal-node.ServerError' diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml index b849abe..599d7b6 100644 --- a/msal/docs-ref-autogen/toc.yml +++ b/msal/docs-ref-autogen/toc.yml @@ -105,9 +105,6 @@ - uid: '@azure/msal-browser.BrowserPerformanceMeasurement' name: BrowserPerformanceMeasurement items: [] - - uid: '@azure/msal-browser.BrowserStorage' - name: BrowserStorage - items: [] - uid: '@azure/msal-browser.BrowserSystemOptions' name: BrowserSystemOptions items: [] @@ -878,9 +875,6 @@ - uid: '@azure/msal-node.NodeAuthOptions' name: NodeAuthOptions items: [] - - uid: '@azure/msal-node.NodeStorage' - name: NodeStorage - items: [] - uid: '@azure/msal-node.NodeSystemOptions' name: NodeSystemOptions items: [] From 6c944688ce936784f8b758d06c32a0c0cc228a93 Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 6 Feb 2025 10:04:31 +0000 Subject: [PATCH 17/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=497770&view=results --- .../@azure/msal-browser/EventHandler.yml | 16 +++++++++ .../@azure/msal-browser/PerformanceEvent.yml | 9 +++++ .../@azure/msal-browser/PerformanceEvents.yml | 4 +++ .../@azure/msal-common/PerformanceEvent.yml | 9 +++++ .../@azure/msal-common/PerformanceEvents.yml | 4 +++ .../@azure/msal-node/TokenCache.yml | 35 +++++++++++++++++++ 6 files changed, 77 insertions(+) diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml index fa9260a..e87f6d6 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml @@ -83,3 +83,19 @@ methods: - id: callbackId type: string description: '' + - name: subscribeCrossTab() + uid: '@azure/msal-browser.EventHandler.subscribeCrossTab' + package: '@azure/msal-browser' + summary: Listen for events broadcasted from other tabs/instances + remarks: '' + isDeprecated: false + syntax: + content: function subscribeCrossTab() + - name: unsubscribeCrossTab() + uid: '@azure/msal-browser.EventHandler.unsubscribeCrossTab' + package: '@azure/msal-browser' + summary: Unsubscribe from broadcast events + remarks: '' + isDeprecated: false + syntax: + content: function unsubscribeCrossTab() diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml index 24b1153..8c6ea3b 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml @@ -27,6 +27,7 @@ syntax: | contentTypeHeader?: string context?: string correlationId: string + domainHintFromRequest?: boolean durationMs?: number embeddedClientId?: string embeddedRedirectUri?: string @@ -46,9 +47,13 @@ syntax: | idTokenSize?: number incompleteSubMeasurements?: Map incompleteSubsCount?: number + isAsyncPopup?: boolean isNativeBroker?: boolean libraryName: string libraryVersion: string + loginHintFromClaim?: boolean + loginHintFromRequest?: boolean + loginHintFromUpn?: boolean matsAccountJoinOnEnd?: string matsAccountJoinOnStart?: string matsApiErrorCode?: number @@ -67,14 +72,18 @@ syntax: | multiMatchedRT?: number name: string nestedAppAuthRequest?: boolean + prompt?: string queuedCount?: number queuedManuallyCompletedCount?: number queuedTimeMs?: number refreshTokenSize?: number requestId?: string retryError?: string + rtExpiresOnMs?: number scenarioId?: string serverErrorNo?: string + sidFromClaims?: boolean + sidFromRequest?: boolean startPageVisibility?: string | null startTimeMs: number status: PerformanceEventStatus diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml index c1acff0..be04bcf 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -282,6 +282,10 @@ fields: summary: >- Internal API for initializing silent request in SilentCacheClient (msal-browser) + - name: LocalStorageUpdated + uid: '@azure/msal-browser.PerformanceEvents.LocalStorageUpdated' + package: '@azure/msal-browser' + summary: '' - name: NativeGenerateAuthResult uid: '@azure/msal-browser.PerformanceEvents.NativeGenerateAuthResult' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml index 4bfe4f3..88ccf5b 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -27,6 +27,7 @@ syntax: | contentTypeHeader?: string context?: string correlationId: string + domainHintFromRequest?: boolean durationMs?: number embeddedClientId?: string embeddedRedirectUri?: string @@ -46,9 +47,13 @@ syntax: | idTokenSize?: number incompleteSubMeasurements?: Map incompleteSubsCount?: number + isAsyncPopup?: boolean isNativeBroker?: boolean libraryName: string libraryVersion: string + loginHintFromClaim?: boolean + loginHintFromRequest?: boolean + loginHintFromUpn?: boolean matsAccountJoinOnEnd?: string matsAccountJoinOnStart?: string matsApiErrorCode?: number @@ -67,14 +72,18 @@ syntax: | multiMatchedRT?: number name: string nestedAppAuthRequest?: boolean + prompt?: string queuedCount?: number queuedManuallyCompletedCount?: number queuedTimeMs?: number refreshTokenSize?: number requestId?: string retryError?: string + rtExpiresOnMs?: number scenarioId?: string serverErrorNo?: string + sidFromClaims?: boolean + sidFromRequest?: boolean startPageVisibility?: string | null startTimeMs: number status: PerformanceEventStatus diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml index 6714ae2..2259d79 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml @@ -281,6 +281,10 @@ fields: summary: >- Internal API for initializing silent request in SilentCacheClient (msal-browser) + - name: LocalStorageUpdated + uid: '@azure/msal-common.PerformanceEvents.LocalStorageUpdated' + package: '@azure/msal-common' + summary: '' - name: NativeGenerateAuthResult uid: '@azure/msal-common.PerformanceEvents.NativeGenerateAuthResult' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml b/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml index 1d29ead..889f1f2 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml @@ -28,6 +28,19 @@ constructors: - id: cachePlugin type: description: '' +properties: + - name: persistence + uid: '@azure/msal-node.TokenCache.persistence' + package: '@azure/msal-node' + summary: '' + fullName: persistence + remarks: '' + isDeprecated: false + syntax: + content: 'persistence: ICachePlugin' + return: + description: '' + type: methods: - name: deserialize(string) uid: '@azure/msal-node.TokenCache.deserialize' @@ -96,6 +109,17 @@ methods: return: description: '' type: Promise<[]> + - name: getCacheSnapshot() + uid: '@azure/msal-node.TokenCache.getCacheSnapshot' + package: '@azure/msal-node' + summary: Gets cache snapshot in CacheKVStore format + remarks: '' + isDeprecated: false + syntax: + content: 'function getCacheSnapshot(): CacheKVStore' + return: + description: '' + type: - name: getKVStore() uid: '@azure/msal-node.TokenCache.getKVStore' package: '@azure/msal-node' @@ -120,6 +144,17 @@ methods: return: description: '' type: boolean + - name: overwriteCache() + uid: '@azure/msal-node.TokenCache.overwriteCache' + package: '@azure/msal-node' + summary: Overwrites in-memory cache with persistent cache + remarks: '' + isDeprecated: false + syntax: + content: 'function overwriteCache(): Promise' + return: + description: '' + type: Promise<void> - name: removeAccount(AccountInfo) uid: '@azure/msal-node.TokenCache.removeAccount' package: '@azure/msal-node' From 59ca74dcdd0fd23a4f3f26a895562d99da5db49f Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 20 Feb 2025 10:05:12 +0000 Subject: [PATCH 18/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=502661&view=results --- msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml | 1 + msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml | 1 + msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml | 3 ++- .../@azure/msal-node/ConfidentialClientApplication.yml | 3 ++- .../@azure/msal-node/IConfidentialClientApplication.yml | 3 ++- .../@azure/msal-node/IPublicClientApplication.yml | 3 ++- .../@azure/msal-node/PublicClientApplication.yml | 3 ++- .../@azure/msal-node/UsernamePasswordClient.yml | 3 ++- 8 files changed, 14 insertions(+), 6 deletions(-) diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml index 8c6ea3b..632d1cf 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml @@ -89,5 +89,6 @@ syntax: | status: PerformanceEventStatus subErrorCode?: string success?: boolean | null + usePreGeneratedPkce?: boolean visibilityChangeCount?: number } diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml index 88ccf5b..9af9625 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -89,5 +89,6 @@ syntax: | status: PerformanceEventStatus subErrorCode?: string success?: boolean | null + usePreGeneratedPkce?: boolean visibilityChangeCount?: number } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml index 80e771a..bfb41f9 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml @@ -90,7 +90,8 @@ methods: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword remarks: '' - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: diff --git a/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml index a5348c6..6ec7996 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml @@ -151,7 +151,8 @@ inheritedMethods: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword remarks: '' - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: diff --git a/msal/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml index b97edbd..e3570f4 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml @@ -80,7 +80,8 @@ methods: Acquires tokens with password grant by exchanging client applications username and password for credentials remarks: '' - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: diff --git a/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml index d00cc10..00496bd 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml @@ -76,7 +76,8 @@ methods: Acquires tokens with password grant by exchanging client applications username and password for credentials remarks: '' - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: diff --git a/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml index f05ec04..1645490 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml @@ -150,7 +150,8 @@ inheritedMethods: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword remarks: '' - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: diff --git a/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml index e9e4fe0..faa40f0 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml @@ -9,7 +9,8 @@ summary: >- testing purposes fullName: UsernamePasswordClient remarks: '' -isDeprecated: false +isDeprecated: true +customDeprecatedMessage: '- Use a more secure flow instead' type: class constructors: - name: UsernamePasswordClient(ClientConfiguration) From a17b34415f0810cadd0d1b84345cfe7d8532e3ed Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 13 Mar 2025 10:04:37 +0000 Subject: [PATCH 19/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=510653&view=results --- .../@azure/msal-angular/MsalService.yml | 15 ++++-- .../@azure/msal-browser/IController.yml | 49 ++++++++++++++----- .../msal-browser/IPublicClientApplication.yml | 32 +++++++++--- .../@azure/msal-browser/PopupRequest.yml | 1 - .../msal-browser/PublicClientApplication.yml | 32 +++++++++--- .../@azure/msal-browser/PublicClientNext.yml | 32 +++++++++--- .../@azure/msal-browser/RedirectRequest.yml | 1 - .../@azure/msal-browser/SilentRequest.yml | 1 - .../@azure/msal-browser/SsoSilentRequest.yml | 2 +- .../@azure/msal-common/BaseAuthRequest.yml | 4 ++ .../CommonAuthorizationCodeRequest.yml | 1 - .../msal-common/CommonDeviceCodeRequest.yml | 8 +-- .../msal-common/CommonRefreshTokenRequest.yml | 1 - .../msal-common/CommonSilentFlowRequest.yml | 1 - .../@azure/msal-common/RequestThumbprint.yml | 1 + .../@azure/msal-common/TimeUtils.yml | 32 ++++++++++++ .../@azure/msal-common/index.yml | 23 +++++++++ .../@azure/msal-react/index.yml | 34 +++++++++---- 18 files changed, 210 insertions(+), 60 deletions(-) diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml index b60d243..a362598 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml @@ -260,7 +260,10 @@ methods: - id: logger type: description: '' - - name: ssoSilent(SsoSilentRequest) + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-angular.MsalService.ssoSilent' package: '@azure/msal-angular' summary: '' @@ -268,11 +271,17 @@ methods: isDeprecated: false syntax: content: >- - function ssoSilent(request: SsoSilentRequest): + function ssoSilent(request: Partial>): Observable parameters: - id: request - type: + type: >- + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml index facb7c6..608f55c 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml @@ -26,8 +26,10 @@ methods: description: '' type: Promise<> - name: >- - acquireTokenNative(PopupRequest | SilentRequest | SsoSilentRequest, ApiId, - string) + acquireTokenNative(PopupRequest | SilentRequest | + Partial>, ApiId, string) uid: '@azure/msal-browser.IController.acquireTokenNative' package: '@azure/msal-browser' summary: '' @@ -36,14 +38,19 @@ methods: syntax: content: >- function acquireTokenNative(request: PopupRequest | SilentRequest | - SsoSilentRequest, apiId: ApiId, accountId?: string): + Partial>, apiId: ApiId, accountId?: string): Promise parameters: - id: request type: >- | | + uid="@azure/msal-browser.SilentRequest" /> | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' - id: apiId type: ApiId @@ -300,7 +307,9 @@ methods: />> - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | - SilentRequest | SsoSilentRequest) + SilentRequest | Partial>) uid: '@azure/msal-browser.IController.hydrateCache' package: '@azure/msal-browser' summary: '' @@ -309,8 +318,10 @@ methods: syntax: content: >- function hydrateCache(result: AuthenticationResult, request: - PopupRequest | RedirectRequest | SilentRequest | SsoSilentRequest): - Promise + PopupRequest | RedirectRequest | SilentRequest | + Partial>): Promise parameters: - id: result type: @@ -319,8 +330,11 @@ methods: type: >- | | | + uid="@azure/msal-browser.SilentRequest" /> | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' @@ -501,7 +515,10 @@ methods: - id: navigationClient type: description: '' - - name: ssoSilent(SsoSilentRequest) + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-browser.IController.ssoSilent' package: '@azure/msal-browser' summary: '' @@ -509,11 +526,17 @@ methods: isDeprecated: false syntax: content: >- - function ssoSilent(request: SsoSilentRequest): + function ssoSilent(request: Partial>): Promise parameters: - id: request - type: + type: >- + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml index 3debaa3..a8e0d21 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml @@ -267,7 +267,9 @@ methods: />> - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | - SilentRequest | SsoSilentRequest) + SilentRequest | Partial>) uid: '@azure/msal-browser.IPublicClientApplication.hydrateCache' package: '@azure/msal-browser' summary: '' @@ -276,8 +278,10 @@ methods: syntax: content: >- function hydrateCache(result: AuthenticationResult, request: - PopupRequest | RedirectRequest | SilentRequest | SsoSilentRequest): - Promise + PopupRequest | RedirectRequest | SilentRequest | + Partial>): Promise parameters: - id: result type: @@ -286,8 +290,11 @@ methods: type: >- | | | + uid="@azure/msal-browser.SilentRequest" /> | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' @@ -468,7 +475,10 @@ methods: - id: navigationClient type: description: '' - - name: ssoSilent(SsoSilentRequest) + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-browser.IPublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: '' @@ -476,11 +486,17 @@ methods: isDeprecated: false syntax: content: >- - function ssoSilent(request: SsoSilentRequest): + function ssoSilent(request: Partial>): Promise parameters: - id: request - type: + type: >- + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml index d074a81..ae43898 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml @@ -92,5 +92,4 @@ syntax: | popupWindowAttributes?: PopupWindowAttributes popupWindowParent?: Window scopes: string[] - tokenBodyParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml index 9f8965d..ce9d447 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -390,7 +390,9 @@ methods: />> - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | - SilentRequest | SsoSilentRequest) + SilentRequest | Partial>) uid: '@azure/msal-browser.PublicClientApplication.hydrateCache' package: '@azure/msal-browser' summary: >- @@ -401,8 +403,10 @@ methods: syntax: content: >- function hydrateCache(result: AuthenticationResult, request: - PopupRequest | RedirectRequest | SilentRequest | SsoSilentRequest): - Promise + PopupRequest | RedirectRequest | SilentRequest | + Partial>): Promise parameters: - id: result type: @@ -411,8 +415,11 @@ methods: type: >- | | | + uid="@azure/msal-browser.SilentRequest" /> | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: The request object that was used to obtain the AuthenticationResult return: description: '' @@ -624,7 +631,10 @@ methods: - id: navigationClient type: description: '' - - name: ssoSilent(SsoSilentRequest) + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-browser.PublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: >- @@ -652,11 +662,17 @@ methods: isDeprecated: false syntax: content: >- - function ssoSilent(request: SsoSilentRequest): + function ssoSilent(request: Partial>): Promise parameters: - id: request - type: + type: >- + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' return: description: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml index d796417..5d3a9df 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml @@ -385,7 +385,9 @@ methods: />> - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | - SilentRequest | SsoSilentRequest) + SilentRequest | Partial>) uid: '@azure/msal-browser.PublicClientNext.hydrateCache' package: '@azure/msal-browser' summary: >- @@ -396,8 +398,10 @@ methods: syntax: content: >- function hydrateCache(result: AuthenticationResult, request: - PopupRequest | RedirectRequest | SilentRequest | SsoSilentRequest): - Promise + PopupRequest | RedirectRequest | SilentRequest | + Partial>): Promise parameters: - id: result type: @@ -406,8 +410,11 @@ methods: type: >- | | | + uid="@azure/msal-browser.SilentRequest" /> | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: The request object that was used to obtain the AuthenticationResult return: description: '' @@ -611,7 +618,10 @@ methods: - id: navigationClient type: description: '' - - name: ssoSilent(SsoSilentRequest) + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-browser.PublicClientNext.ssoSilent' package: '@azure/msal-browser' summary: >- @@ -639,11 +649,17 @@ methods: isDeprecated: false syntax: content: >- - function ssoSilent(request: SsoSilentRequest): + function ssoSilent(request: Partial>): Promise parameters: - id: request - type: + type: >- + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' return: description: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml index 57306e5..7a07161 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml @@ -95,5 +95,4 @@ syntax: | onRedirectNavigate?: (url: string) => boolean | void redirectStartPage?: string scopes: string[] - tokenBodyParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml index 5a7b46c..74187b7 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml @@ -67,5 +67,4 @@ syntax: | prompt?: string redirectUri?: string state?: string - tokenBodyParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml index 67f29a5..3b630ee 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml @@ -79,4 +79,4 @@ syntax: | | "requestedClaimsHash" | "platformBroker" > - > & { tokenBodyParameters?: StringDict } + > diff --git a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml index 6061b89..2f259fc 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml @@ -54,6 +54,9 @@ summary: >- - tokenQueryParameters - String to string map of custom query parameters added to the /token call + - tokenBodyParameters - String to string map of custom parameters added to + the body of the /token call + - storeInCache - Object containing boolean values indicating whether to store tokens in the cache or not (default is true) @@ -90,5 +93,6 @@ syntax: | sshJwk?: string sshKid?: string storeInCache?: StoreInCache + tokenBodyParameters?: StringDict tokenQueryParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml index f27f952..18573cf 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml @@ -57,5 +57,4 @@ syntax: | codeVerifier?: string enableSpaAuthorizationCode?: boolean redirectUri: string - tokenBodyParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml index 77bc1e1..51be718 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml @@ -45,9 +45,11 @@ summary: >- fullName: CommonDeviceCodeRequest remarks: '' isDeprecated: false -syntax: > - type CommonDeviceCodeRequest = Omit & - { +syntax: | + type CommonDeviceCodeRequest = Omit< + BaseAuthRequest, + "tokenQueryParameters" | "tokenBodyParameters" + > & { cancel?: boolean deviceCodeCallback: (response: DeviceCodeResponse) => void extraQueryParameters?: StringDict diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml index 0626320..6b8ad2b 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml @@ -40,5 +40,4 @@ syntax: | forceCache?: boolean redirectUri?: string refreshToken: string - tokenBodyParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml index f5da28e..1c3a621 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml @@ -40,5 +40,4 @@ syntax: | forceRefresh: boolean redirectUri?: string refreshTokenExpirationOffsetSeconds?: number - tokenBodyParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml b/msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml index 0d8f6a7..e535f8a 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml @@ -12,6 +12,7 @@ syntax: | authority: string claims?: string clientId: string + embeddedClientId?: string homeAccountIdentifier?: string resourceRequestMethod?: string resourceRequestUri?: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml index fcd2bb7..7aa6e51 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml @@ -52,6 +52,38 @@ functions: return: description: '' type: number + - name: toDateFromSeconds(undefined | string | number) + uid: '@azure/msal-common.TimeUtils.toDateFromSeconds' + package: '@azure/msal-common' + summary: >- + Convert seconds to JS Date object. Seconds can be in a number or string + format or undefined (will still return a date). + remarks: '' + isDeprecated: false + syntax: + content: 'function toDateFromSeconds(seconds: undefined | string | number): Date' + parameters: + - id: seconds + type: undefined | string | number + description: '' + return: + description: '' + type: Date + - name: toSecondsFromDate(Date) + uid: '@azure/msal-common.TimeUtils.toSecondsFromDate' + package: '@azure/msal-common' + summary: Converts JS Date object to seconds + remarks: '' + isDeprecated: false + syntax: + content: 'function toSecondsFromDate(date: Date): number' + parameters: + - id: date + type: Date + description: Date + return: + description: '' + type: number - name: wasClockTurnedBack(string) uid: '@azure/msal-common.TimeUtils.wasClockTurnedBack' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml index 34e023c..d2acd92 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -370,6 +370,29 @@ functions: return: description: '' type: string + - name: getRequestThumbprint(string, BaseAuthRequest, string) + uid: '@azure/msal-common.getRequestThumbprint' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function getRequestThumbprint(clientId: string, request: + BaseAuthRequest, homeAccountId?: string): RequestThumbprint + parameters: + - id: clientId + type: string + description: '' + - id: request + type: + description: '' + - id: homeAccountId + type: string + description: '' + return: + description: '' + type: - name: getTenantIdFromIdTokenClaims(TokenClaims) uid: '@azure/msal-common.getTenantIdFromIdTokenClaims' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-react/index.yml b/msal/docs-ref-autogen/@azure/msal-react/index.yml index 7d5077c..814d5e0 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/index.yml @@ -43,9 +43,11 @@ functions: - name: >- MsalAuthenticationTemplate(PropsWithChildren> & { - authenticationRequest?: PopupRequest | RedirectRequest | SsoSilentRequest, - errorComponent?: any, interactionType: InteractionType, loadingComponent?: - any }>) + authenticationRequest?: PopupRequest | RedirectRequest | + Partial>, errorComponent?: any, interactionType: + InteractionType, loadingComponent?: any }>) uid: '@azure/msal-react.MsalAuthenticationTemplate' package: '@azure/msal-react' summary: >- @@ -58,7 +60,9 @@ functions: function MsalAuthenticationTemplate(props: PropsWithChildren> & { authenticationRequest?: PopupRequest - | RedirectRequest | SsoSilentRequest, errorComponent?: any, + | RedirectRequest | Partial>, errorComponent?: any, interactionType: InteractionType, loadingComponent?: any }>): React.ReactElement | null parameters: @@ -67,8 +71,11 @@ functions: PropsWithChildren<Partial<Pick<, "homeAccountId" | "localAccountId" | "username">> & { authenticationRequest?: - PopupRequest | RedirectRequest | SsoSilentRequest, errorComponent?: - any, interactionType: InteractionType, loadingComponent?: any }> + PopupRequest | RedirectRequest | + Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | + "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>, errorComponent?: any, interactionType: + InteractionType, loadingComponent?: any }> description: '' return: description: '' @@ -174,7 +181,9 @@ functions: type: - name: >- useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | - SsoSilentRequest, Partial>, Partial>) uid: '@azure/msal-react.useMsalAuthentication' package: '@azure/msal-react' @@ -195,7 +204,9 @@ functions: content: >- function useMsalAuthentication(interactionType: InteractionType, authenticationRequest?: PopupRequest | RedirectRequest | - SsoSilentRequest, accountIdentifiers?: Partial>, accountIdentifiers?: Partial>): MsalAuthenticationResult parameters: @@ -205,8 +216,11 @@ functions: - id: authenticationRequest type: >- | | + uid="@azure/msal-browser.RedirectRequest" /> | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' - id: accountIdentifiers type: >- From 47bf0b1727643a0adc4e4fed66fab22fe0644fcc Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 27 Mar 2025 10:03:42 +0000 Subject: [PATCH 20/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=515188&view=results --- .../@azure/msal-angular/IMsalService.yml | 15 +- .../@azure/msal-angular/MsalService.yml | 10 +- .../msal-browser/AuthorizationUrlRequest.yml | 7 +- .../@azure/msal-browser/IController.yml | 28 +- .../msal-browser/IPublicClientApplication.yml | 20 +- .../@azure/msal-browser/PerformanceEvents.yml | 33 +- .../@azure/msal-browser/PopupRequest.yml | 1 + .../msal-browser/PublicClientApplication.yml | 20 +- .../@azure/msal-browser/PublicClientNext.yml | 20 +- .../@azure/msal-browser/RedirectRequest.yml | 1 + .../@azure/msal-browser/SsoSilentRequest.yml | 1 + .../@azure/msal-common/AuthorizeProtocol.yml | 101 +++ ...CodeResponse.yml => AuthorizeResponse.yml} | 17 +- .../CommonAuthorizationUrlRequest.yml | 5 +- .../@azure/msal-common/OAuthResponseType.yml | 11 + .../@azure/msal-common/PerformanceEvents.yml | 33 +- .../msal-common/RequestParameterBuilder.yml | 757 ++++++++++++++++++ .../@azure/msal-common/UrlUtils.yml | 21 +- .../@azure/msal-common/index.yml | 3 +- ...CodeResponse.yml => AuthorizeResponse.yml} | 17 +- .../@azure/msal-node/ILoopbackClient.yml | 6 +- .../@azure/msal-node/index.yml | 2 +- .../@azure/msal-react/index.yml | 18 +- msal/docs-ref-autogen/toc.yml | 21 +- 24 files changed, 1046 insertions(+), 122 deletions(-) create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthorizeProtocol.yml rename msal/docs-ref-autogen/@azure/msal-common/{ServerAuthorizationCodeResponse.yml => AuthorizeResponse.yml} (54%) create mode 100644 msal/docs-ref-autogen/@azure/msal-common/OAuthResponseType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml rename msal/docs-ref-autogen/@azure/msal-node/{ServerAuthorizationCodeResponse.yml => AuthorizeResponse.yml} (54%) diff --git a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml index 28682bb..c5b9c28 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml @@ -161,7 +161,10 @@ methods: - id: logger type: description: '' - - name: ssoSilent(AuthorizationUrlRequest) + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-angular.IMsalService.ssoSilent' package: '@azure/msal-angular' summary: '' @@ -169,11 +172,17 @@ methods: isDeprecated: false syntax: content: >- - function ssoSilent(request: AuthorizationUrlRequest): + function ssoSilent(request: Partial>): Observable parameters: - id: request - type: + type: >- + Partial<Omit<, + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml index a362598..c3af693 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml @@ -262,8 +262,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-angular.MsalService.ssoSilent' package: '@azure/msal-angular' summary: '' @@ -272,7 +272,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Observable parameters: @@ -280,8 +280,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml index 30086a5..b49fbed 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml @@ -5,9 +5,10 @@ package: '@azure/msal-browser' summary: This type is deprecated and will be removed on the next major version update fullName: AuthorizationUrlRequest remarks: '' -isDeprecated: false +isDeprecated: true +customDeprecatedMessage: Will be removed in future version syntax: | type AuthorizationUrlRequest = Omit< CommonAuthorizationUrlRequest, - "state" | "nonce" | "requestedClaimsHash" | "platformBroker" - > & { nonce: string; state: string } + "requestedClaimsHash" | "platformBroker" + > diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml index 608f55c..39743db 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml @@ -27,7 +27,7 @@ methods: type: Promise<> - name: >- acquireTokenNative(PopupRequest | SilentRequest | - Partial>, ApiId, string) uid: '@azure/msal-browser.IController.acquireTokenNative' @@ -38,7 +38,7 @@ methods: syntax: content: >- function acquireTokenNative(request: PopupRequest | SilentRequest | - Partial>, apiId: ApiId, accountId?: string): Promise @@ -49,8 +49,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' - id: apiId type: ApiId @@ -308,8 +308,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>) uid: '@azure/msal-browser.IController.hydrateCache' package: '@azure/msal-browser' summary: '' @@ -319,7 +319,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -333,8 +333,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' @@ -517,8 +517,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-browser.IController.ssoSilent' package: '@azure/msal-browser' summary: '' @@ -527,7 +527,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -535,8 +535,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml index a8e0d21..fd791ed 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml @@ -268,8 +268,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>) uid: '@azure/msal-browser.IPublicClientApplication.hydrateCache' package: '@azure/msal-browser' summary: '' @@ -279,7 +279,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -293,8 +293,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' @@ -477,8 +477,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-browser.IPublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: '' @@ -487,7 +487,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -495,8 +495,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml index be04bcf..cc890da 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -87,10 +87,6 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.AuthClientAcquireToken' package: '@azure/msal-browser' summary: APIs in Authorization Code Client (msal-common) - - name: AuthClientCreateQueryString - uid: '@azure/msal-browser.PerformanceEvents.AuthClientCreateQueryString' - package: '@azure/msal-browser' - summary: '' - name: AuthClientCreateTokenRequestBody uid: '@azure/msal-browser.PerformanceEvents.AuthClientCreateTokenRequestBody' package: '@azure/msal-browser' @@ -186,6 +182,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.Decrypt' package: '@azure/msal-browser' summary: '' + - name: DecryptEarResponse + uid: '@azure/msal-browser.PerformanceEvents.DecryptEarResponse' + package: '@azure/msal-browser' + summary: '' - name: DeserializeResponse uid: '@azure/msal-browser.PerformanceEvents.DeserializeResponse' package: '@azure/msal-browser' @@ -212,6 +212,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.GenerateCodeVerifier' package: '@azure/msal-browser' summary: '' + - name: GenerateEarKey + uid: '@azure/msal-browser.PerformanceEvents.GenerateEarKey' + package: '@azure/msal-browser' + summary: '' - name: GenerateHKDF uid: '@azure/msal-browser.PerformanceEvents.GenerateHKDF' package: '@azure/msal-browser' @@ -237,6 +241,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.GetRandomValues' package: '@azure/msal-browser' summary: '' + - name: GetStandardParams + uid: '@azure/msal-browser.PerformanceEvents.GetStandardParams' + package: '@azure/msal-browser' + summary: '' - name: HandleCodeResponse uid: '@azure/msal-browser.PerformanceEvents.HandleCodeResponse' package: '@azure/msal-browser' @@ -254,6 +262,18 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.HandleRedirectPromiseMeasurement' package: '@azure/msal-browser' summary: '' + - name: HandleResponseCode + uid: '@azure/msal-browser.PerformanceEvents.HandleResponseCode' + package: '@azure/msal-browser' + summary: '' + - name: HandleResponseEar + uid: '@azure/msal-browser.PerformanceEvents.HandleResponseEar' + package: '@azure/msal-browser' + summary: '' + - name: HandleResponsePlatformBroker + uid: '@azure/msal-browser.PerformanceEvents.HandleResponsePlatformBroker' + package: '@azure/msal-browser' + summary: '' - name: HandleServerTokenResponse uid: '@azure/msal-browser.PerformanceEvents.HandleServerTokenResponse' package: '@azure/msal-browser' @@ -449,11 +469,6 @@ fields: (msal-browser). Used to load authority metadata for a request. - - name: StandardInteractionClientInitializeAuthorizationCodeRequest - uid: >- - @azure/msal-browser.PerformanceEvents.StandardInteractionClientInitializeAuthorizationCodeRequest - package: '@azure/msal-browser' - summary: '' - name: StandardInteractionClientInitializeAuthorizationRequest uid: >- @azure/msal-browser.PerformanceEvents.StandardInteractionClientInitializeAuthorizationRequest diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml index ae43898..ae231af 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml @@ -83,6 +83,7 @@ syntax: | CommonAuthorizationUrlRequest, | "responseMode" | "scopes" + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml index ce9d447..b8b14fd 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -391,8 +391,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>) uid: '@azure/msal-browser.PublicClientApplication.hydrateCache' package: '@azure/msal-browser' summary: >- @@ -404,7 +404,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -418,8 +418,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: The request object that was used to obtain the AuthenticationResult return: description: '' @@ -633,8 +633,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-browser.PublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: >- @@ -663,7 +663,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -671,8 +671,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' return: description: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml index 5d3a9df..6723a7e 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml @@ -386,8 +386,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>) uid: '@azure/msal-browser.PublicClientNext.hydrateCache' package: '@azure/msal-browser' summary: >- @@ -399,7 +399,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -413,8 +413,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: The request object that was used to obtain the AuthenticationResult return: description: '' @@ -620,8 +620,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-browser.PublicClientNext.ssoSilent' package: '@azure/msal-browser' summary: >- @@ -650,7 +650,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -658,8 +658,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' return: description: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml index 7a07161..a89e91c 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml @@ -86,6 +86,7 @@ syntax: | CommonAuthorizationUrlRequest, | "responseMode" | "scopes" + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml index 3b630ee..251d414 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml @@ -74,6 +74,7 @@ syntax: | Omit< CommonAuthorizationUrlRequest, | "responseMode" + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorizeProtocol.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorizeProtocol.yml new file mode 100644 index 0000000..cb8dbc2 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorizeProtocol.yml @@ -0,0 +1,101 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.AuthorizeProtocol' +name: AuthorizeProtocol +type: module +package: '@azure/msal-common' +summary: '' +functions: + - name: getAuthorizationCodePayload(AuthorizeResponse, string) + uid: '@azure/msal-common.AuthorizeProtocol.getAuthorizationCodePayload' + package: '@azure/msal-common' + summary: >- + 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. + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAuthorizationCodePayload(serverParams: AuthorizeResponse, + cachedState: string): AuthorizationCodePayload + parameters: + - id: serverParams + type: + description: '' + - id: cachedState + type: string + description: '' + return: + description: '' + type: + - name: getAuthorizeUrl(Authority, Map) + uid: '@azure/msal-common.AuthorizeProtocol.getAuthorizeUrl' + package: '@azure/msal-common' + summary: >- + Returns authorize endpoint with given request parameters in the query + string + remarks: '' + isDeprecated: false + syntax: + content: >- + function getAuthorizeUrl(authority: Authority, requestParameters: + Map): string + parameters: + - id: authority + type: Authority + description: '' + - id: requestParameters + type: Map<string, string> + description: '' + return: + description: '' + type: string + - name: >- + getStandardAuthorizeRequestParameters(AuthOptions, + CommonAuthorizationUrlRequest, Logger, IPerformanceClient) + uid: '@azure/msal-common.AuthorizeProtocol.getStandardAuthorizeRequestParameters' + package: '@azure/msal-common' + summary: >- + Returns map of parameters that are applicable to all calls to /authorize + whether using PKCE or EAR + remarks: '' + isDeprecated: false + syntax: + content: >- + function getStandardAuthorizeRequestParameters(authOptions: AuthOptions, + request: CommonAuthorizationUrlRequest, logger: Logger, + performanceClient?: IPerformanceClient): Map + parameters: + - id: authOptions + type: AuthOptions + description: '' + - id: request + type: + description: '' + - id: logger + type: + description: '' + - id: performanceClient + type: + description: '' + return: + description: '' + type: Map<string, string> + - name: validateAuthorizationResponse(AuthorizeResponse, string) + uid: '@azure/msal-common.AuthorizeProtocol.validateAuthorizationResponse' + package: '@azure/msal-common' + summary: Function which validates server authorization code response. + remarks: '' + isDeprecated: false + syntax: + content: >- + function validateAuthorizationResponse(serverResponse: + AuthorizeResponse, requestState: string) + parameters: + - id: serverResponse + type: + description: '' + - id: requestState + type: string + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorizeResponse.yml similarity index 54% rename from msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml rename to msal/docs-ref-autogen/@azure/msal-common/AuthorizeResponse.yml index 5322898..e0d6ef9 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorizeResponse.yml @@ -1,19 +1,13 @@ ### YamlMime:TSTypeAlias -name: ServerAuthorizationCodeResponse -uid: '@azure/msal-common.ServerAuthorizationCodeResponse' +name: AuthorizeResponse +uid: '@azure/msal-common.AuthorizeResponse' package: '@azure/msal-common' -summary: |- - Deserialized response object from server authorization code request. - - code: authorization code from server - - client_info: client info object - - state: OAuth2 request state - - error: error sent back in hash - - error: description -fullName: ServerAuthorizationCodeResponse +summary: Response properties that may be returned by the /authorize endpoint +fullName: AuthorizeResponse remarks: '' isDeprecated: false syntax: | - type ServerAuthorizationCodeResponse = { + type AuthorizeResponse = { accountId?: string claims?: string client_info?: string @@ -22,6 +16,7 @@ syntax: | cloud_instance_name?: string code?: string correlation_id?: string + ear_jwe?: string error?: string error_description?: string error_uri?: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml index b8da7ac..88c68b7 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml @@ -94,14 +94,15 @@ syntax: | codeChallenge?: string codeChallengeMethod?: string domainHint?: string + earJwk?: string extraQueryParameters?: StringDict extraScopesToConsent?: string[] loginHint?: string - nonce?: string + nonce: string platformBroker?: boolean prompt?: string redirectUri: string responseMode: ResponseMode sid?: string - state?: string + state: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/OAuthResponseType.yml b/msal/docs-ref-autogen/@azure/msal-common/OAuthResponseType.yml new file mode 100644 index 0000000..c8f5d7f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/OAuthResponseType.yml @@ -0,0 +1,11 @@ +### YamlMime:TSTypeAlias +name: OAuthResponseType +uid: '@azure/msal-common.OAuthResponseType' +package: '@azure/msal-common' +summary: '' +fullName: OAuthResponseType +remarks: '' +isDeprecated: false +syntax: | + type OAuthResponseType = + (typeof OAuthResponseType)[keyof typeof OAuthResponseType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml index 2259d79..8ce7877 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml @@ -87,10 +87,6 @@ fields: uid: '@azure/msal-common.PerformanceEvents.AuthClientAcquireToken' package: '@azure/msal-common' summary: APIs in Authorization Code Client (msal-common) - - name: AuthClientCreateQueryString - uid: '@azure/msal-common.PerformanceEvents.AuthClientCreateQueryString' - package: '@azure/msal-common' - summary: '' - name: AuthClientCreateTokenRequestBody uid: '@azure/msal-common.PerformanceEvents.AuthClientCreateTokenRequestBody' package: '@azure/msal-common' @@ -185,6 +181,10 @@ fields: uid: '@azure/msal-common.PerformanceEvents.Decrypt' package: '@azure/msal-common' summary: '' + - name: DecryptEarResponse + uid: '@azure/msal-common.PerformanceEvents.DecryptEarResponse' + package: '@azure/msal-common' + summary: '' - name: DeserializeResponse uid: '@azure/msal-common.PerformanceEvents.DeserializeResponse' package: '@azure/msal-common' @@ -211,6 +211,10 @@ fields: uid: '@azure/msal-common.PerformanceEvents.GenerateCodeVerifier' package: '@azure/msal-common' summary: '' + - name: GenerateEarKey + uid: '@azure/msal-common.PerformanceEvents.GenerateEarKey' + package: '@azure/msal-common' + summary: '' - name: GenerateHKDF uid: '@azure/msal-common.PerformanceEvents.GenerateHKDF' package: '@azure/msal-common' @@ -236,6 +240,10 @@ fields: uid: '@azure/msal-common.PerformanceEvents.GetRandomValues' package: '@azure/msal-common' summary: '' + - name: GetStandardParams + uid: '@azure/msal-common.PerformanceEvents.GetStandardParams' + package: '@azure/msal-common' + summary: '' - name: HandleCodeResponse uid: '@azure/msal-common.PerformanceEvents.HandleCodeResponse' package: '@azure/msal-common' @@ -253,6 +261,18 @@ fields: uid: '@azure/msal-common.PerformanceEvents.HandleRedirectPromiseMeasurement' package: '@azure/msal-common' summary: '' + - name: HandleResponseCode + uid: '@azure/msal-common.PerformanceEvents.HandleResponseCode' + package: '@azure/msal-common' + summary: '' + - name: HandleResponseEar + uid: '@azure/msal-common.PerformanceEvents.HandleResponseEar' + package: '@azure/msal-common' + summary: '' + - name: HandleResponsePlatformBroker + uid: '@azure/msal-common.PerformanceEvents.HandleResponsePlatformBroker' + package: '@azure/msal-common' + summary: '' - name: HandleServerTokenResponse uid: '@azure/msal-common.PerformanceEvents.HandleServerTokenResponse' package: '@azure/msal-common' @@ -447,11 +467,6 @@ fields: (msal-browser). Used to load authority metadata for a request. - - name: StandardInteractionClientInitializeAuthorizationCodeRequest - uid: >- - @azure/msal-common.PerformanceEvents.StandardInteractionClientInitializeAuthorizationCodeRequest - package: '@azure/msal-common' - summary: '' - name: StandardInteractionClientInitializeAuthorizationRequest uid: >- @azure/msal-common.PerformanceEvents.StandardInteractionClientInitializeAuthorizationRequest diff --git a/msal/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml b/msal/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml new file mode 100644 index 0000000..3a9da5a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml @@ -0,0 +1,757 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.RequestParameterBuilder' +name: RequestParameterBuilder +type: module +package: '@azure/msal-common' +summary: '' +functions: + - name: addApplicationTelemetry(Map, ApplicationTelemetry) + uid: '@azure/msal-common.RequestParameterBuilder.addApplicationTelemetry' + package: '@azure/msal-common' + summary: Add client telemetry parameters + remarks: '' + isDeprecated: false + syntax: + content: >- + function addApplicationTelemetry(parameters: Map, + appTelemetry: ApplicationTelemetry) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: appTelemetry + type: + description: '' + - name: addAuthorizationCode(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addAuthorizationCode' + package: '@azure/msal-common' + summary: add the `authorization_code` passed by the user to exchange for a token + remarks: '' + isDeprecated: false + syntax: + content: >- + function addAuthorizationCode(parameters: Map, code: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: code + type: string + description: '' + - name: addBrokerParameters(Map, string, string) + uid: '@azure/msal-common.RequestParameterBuilder.addBrokerParameters' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addBrokerParameters(parameters: Map, + brokerClientId: string, brokerRedirectUri: string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: brokerClientId + type: string + description: '' + - id: brokerRedirectUri + type: string + description: '' + - name: addCcsOid(Map, ClientInfo) + uid: '@azure/msal-common.RequestParameterBuilder.addCcsOid' + package: '@azure/msal-common' + summary: Adds the CCS (Cache Credential Service) query parameter for account object + remarks: '' + isDeprecated: false + syntax: + content: >- + function addCcsOid(parameters: Map, clientInfo: + ClientInfo) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: clientInfo + type: + description: '' + - name: addCcsUpn(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addCcsUpn' + package: '@azure/msal-common' + summary: Adds the CCS (Cache Credential Service) query parameter for login_hint + remarks: '' + isDeprecated: false + syntax: + content: 'function addCcsUpn(parameters: Map, loginHint: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: loginHint + type: string + description: '' + - name: addClaims(Map, string, string[]) + uid: '@azure/msal-common.RequestParameterBuilder.addClaims' + package: '@azure/msal-common' + summary: add claims + remarks: '' + isDeprecated: false + syntax: + content: >- + function addClaims(parameters: Map, claims?: string, + clientCapabilities?: string[]) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: claims + type: string + description: '' + - id: clientCapabilities + type: string[] + description: '' + - name: addClientAssertion(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addClientAssertion' + package: '@azure/msal-common' + summary: add clientAssertion for confidential client flows + remarks: '' + isDeprecated: false + syntax: + content: >- + function addClientAssertion(parameters: Map, + clientAssertion: string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: clientAssertion + type: string + description: '' + - name: addClientAssertionType(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addClientAssertionType' + package: '@azure/msal-common' + summary: add clientAssertionType for confidential client flows + remarks: '' + isDeprecated: false + syntax: + content: >- + function addClientAssertionType(parameters: Map, + clientAssertionType: string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: clientAssertionType + type: string + description: '' + - name: addClientCapabilitiesToClaims(string, string[]) + uid: '@azure/msal-common.RequestParameterBuilder.addClientCapabilitiesToClaims' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addClientCapabilitiesToClaims(claims?: string, + clientCapabilities?: string[]): string + parameters: + - id: claims + type: string + description: '' + - id: clientCapabilities + type: string[] + description: '' + return: + description: '' + type: string + - name: addClientId(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addClientId' + package: '@azure/msal-common' + summary: add clientId + remarks: '' + isDeprecated: false + syntax: + content: 'function addClientId(parameters: Map, clientId: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: clientId + type: string + description: '' + - name: addClientInfo(Map) + uid: '@azure/msal-common.RequestParameterBuilder.addClientInfo' + package: '@azure/msal-common' + summary: add client info + remarks: '' + isDeprecated: false + syntax: + content: 'function addClientInfo(parameters: Map)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - name: addClientSecret(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addClientSecret' + package: '@azure/msal-common' + summary: add client_secret + remarks: '' + isDeprecated: false + syntax: + content: >- + function addClientSecret(parameters: Map, clientSecret: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: clientSecret + type: string + description: '' + - name: addCodeChallengeParams(Map, string, string) + uid: '@azure/msal-common.RequestParameterBuilder.addCodeChallengeParams' + package: '@azure/msal-common' + summary: |- + add code_challenge and code_challenge_method + - throw if either of them are not passed + remarks: '' + isDeprecated: false + syntax: + content: >- + function addCodeChallengeParams(parameters: Map, + codeChallenge?: string, codeChallengeMethod?: string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: codeChallenge + type: string + description: '' + - id: codeChallengeMethod + type: string + description: '' + - name: addCodeVerifier(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addCodeVerifier' + package: '@azure/msal-common' + summary: add the `code_verifier` passed by the user to exchange for a token + remarks: '' + isDeprecated: false + syntax: + content: >- + function addCodeVerifier(parameters: Map, codeVerifier: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: codeVerifier + type: string + description: '' + - name: addCorrelationId(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addCorrelationId' + package: '@azure/msal-common' + summary: add correlationId + remarks: '' + isDeprecated: false + syntax: + content: >- + function addCorrelationId(parameters: Map, + correlationId: string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: correlationId + type: string + description: '' + - name: addDeviceCode(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addDeviceCode' + package: '@azure/msal-common' + summary: add the `authorization_code` passed by the user to exchange for a token + remarks: '' + isDeprecated: false + syntax: + content: 'function addDeviceCode(parameters: Map, code: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: code + type: string + description: '' + - name: addDomainHint(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addDomainHint' + package: '@azure/msal-common' + summary: add domain_hint + remarks: '' + isDeprecated: false + syntax: + content: >- + function addDomainHint(parameters: Map, domainHint: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: domainHint + type: string + description: '' + - name: addEARParameters(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addEARParameters' + package: '@azure/msal-common' + summary: Add EAR (Encrypted Authorize Response) request parameters + remarks: '' + isDeprecated: false + syntax: + content: 'function addEARParameters(parameters: Map, jwk: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: jwk + type: string + description: '' + - name: addExtraQueryParameters(Map, StringDict) + uid: '@azure/msal-common.RequestParameterBuilder.addExtraQueryParameters' + package: '@azure/msal-common' + summary: add extraQueryParams + remarks: '' + isDeprecated: false + syntax: + content: >- + function addExtraQueryParameters(parameters: Map, + eQParams: StringDict) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: eQParams + type: + description: '' + - name: addGrantType(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addGrantType' + package: '@azure/msal-common' + summary: add grant type + remarks: '' + isDeprecated: false + syntax: + content: >- + function addGrantType(parameters: Map, grantType: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: grantType + type: string + description: '' + - name: addIdTokenHint(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addIdTokenHint' + package: '@azure/msal-common' + summary: add id_token_hint to logout request + remarks: '' + isDeprecated: false + syntax: + content: >- + function addIdTokenHint(parameters: Map, idTokenHint: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: idTokenHint + type: string + description: '' + - name: addInstanceAware(Map) + uid: '@azure/msal-common.RequestParameterBuilder.addInstanceAware' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: 'function addInstanceAware(parameters: Map)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - name: addLibraryInfo(Map, LibraryInfo) + uid: '@azure/msal-common.RequestParameterBuilder.addLibraryInfo' + package: '@azure/msal-common' + summary: add library info query params + remarks: '' + isDeprecated: false + syntax: + content: >- + function addLibraryInfo(parameters: Map, libraryInfo: + LibraryInfo) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: libraryInfo + type: LibraryInfo + description: '' + - name: addLoginHint(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addLoginHint' + package: '@azure/msal-common' + summary: add login_hint + remarks: '' + isDeprecated: false + syntax: + content: >- + function addLoginHint(parameters: Map, loginHint: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: loginHint + type: string + description: '' + - name: addLogoutHint(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addLogoutHint' + package: '@azure/msal-common' + summary: >- + Adds logout_hint parameter for "silent" logout which prevent server + account picker + remarks: '' + isDeprecated: false + syntax: + content: >- + function addLogoutHint(parameters: Map, logoutHint: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: logoutHint + type: string + description: '' + - name: addNativeBroker(Map) + uid: '@azure/msal-common.RequestParameterBuilder.addNativeBroker' + package: '@azure/msal-common' + summary: Add flag to indicate STS should attempt to use WAM if available + remarks: '' + isDeprecated: false + syntax: + content: 'function addNativeBroker(parameters: Map)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - name: addNonce(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addNonce' + package: '@azure/msal-common' + summary: add nonce + remarks: '' + isDeprecated: false + syntax: + content: 'function addNonce(parameters: Map, nonce: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: nonce + type: string + description: '' + - name: addOboAssertion(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addOboAssertion' + package: '@azure/msal-common' + summary: add OBO assertion for confidential client flows + remarks: '' + isDeprecated: false + syntax: + content: >- + function addOboAssertion(parameters: Map, oboAssertion: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: oboAssertion + type: string + description: '' + - name: addPassword(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addPassword' + package: '@azure/msal-common' + summary: adds `password` for Password Grant flow + remarks: '' + isDeprecated: false + syntax: + content: 'function addPassword(parameters: Map, password: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: password + type: string + description: '' + - name: addPopToken(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addPopToken' + package: '@azure/msal-common' + summary: add pop_jwk to query params + remarks: '' + isDeprecated: false + syntax: + content: 'function addPopToken(parameters: Map, cnfString: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: cnfString + type: string + description: '' + - name: addPostLogoutRedirectUri(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addPostLogoutRedirectUri' + package: '@azure/msal-common' + summary: add post logout redirectUri + remarks: '' + isDeprecated: false + syntax: + content: >- + function addPostLogoutRedirectUri(parameters: Map, + redirectUri: string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: redirectUri + type: string + description: '' + - name: addPrompt(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addPrompt' + package: '@azure/msal-common' + summary: add prompt + remarks: '' + isDeprecated: false + syntax: + content: 'function addPrompt(parameters: Map, prompt: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: prompt + type: string + description: '' + - name: addRedirectUri(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addRedirectUri' + package: '@azure/msal-common' + summary: add redirect_uri + remarks: '' + isDeprecated: false + syntax: + content: >- + function addRedirectUri(parameters: Map, redirectUri: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: redirectUri + type: string + description: '' + - name: addRefreshToken(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addRefreshToken' + package: '@azure/msal-common' + summary: add the `refreshToken` passed by the user + remarks: '' + isDeprecated: false + syntax: + content: >- + function addRefreshToken(parameters: Map, refreshToken: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: refreshToken + type: string + description: '' + - name: addRequestTokenUse(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addRequestTokenUse' + package: '@azure/msal-common' + summary: add grant type + remarks: '' + isDeprecated: false + syntax: + content: >- + function addRequestTokenUse(parameters: Map, tokenUse: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: tokenUse + type: string + description: '' + - name: addResponseMode(Map, ResponseMode) + uid: '@azure/msal-common.RequestParameterBuilder.addResponseMode' + package: '@azure/msal-common' + summary: add response_mode. defaults to query. + remarks: '' + isDeprecated: false + syntax: + content: >- + function addResponseMode(parameters: Map, responseMode?: + ResponseMode) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: responseMode + type: ResponseMode + description: '' + - name: addResponseType(Map, OAuthResponseType) + uid: '@azure/msal-common.RequestParameterBuilder.addResponseType' + package: '@azure/msal-common' + summary: Add the given response_type + remarks: '' + isDeprecated: false + syntax: + content: >- + function addResponseType(parameters: Map, responseType: + OAuthResponseType) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: responseType + type: OAuthResponseType + description: '' + - name: addScopes(Map, string[], boolean, string[]) + uid: '@azure/msal-common.RequestParameterBuilder.addScopes' + package: '@azure/msal-common' + summary: >- + add scopes. set addOidcScopes to false to prevent default scopes in + non-user scenarios + remarks: '' + isDeprecated: false + syntax: + content: >- + function addScopes(parameters: Map, scopes: string[], + addOidcScopes?: boolean, defaultScopes?: string[]) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: scopes + type: string[] + description: '' + - id: addOidcScopes + type: boolean + description: '' + - id: defaultScopes + type: string[] + description: '' + - name: addServerTelemetry(Map, ServerTelemetryManager) + uid: '@azure/msal-common.RequestParameterBuilder.addServerTelemetry' + package: '@azure/msal-common' + summary: add server telemetry fields + remarks: '' + isDeprecated: false + syntax: + content: >- + function addServerTelemetry(parameters: Map, + serverTelemetryManager: ServerTelemetryManager) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: serverTelemetryManager + type: ServerTelemetryManager + description: '' + - name: addSid(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addSid' + package: '@azure/msal-common' + summary: add sid + remarks: '' + isDeprecated: false + syntax: + content: 'function addSid(parameters: Map, sid: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: sid + type: string + description: '' + - name: addSshJwk(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addSshJwk' + package: '@azure/msal-common' + summary: add SSH JWK and key ID to query params + remarks: '' + isDeprecated: false + syntax: + content: >- + function addSshJwk(parameters: Map, sshJwkString: + string) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: sshJwkString + type: string + description: '' + - name: addState(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addState' + package: '@azure/msal-common' + summary: add state + remarks: '' + isDeprecated: false + syntax: + content: 'function addState(parameters: Map, state: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: state + type: string + description: '' + - name: addThrottling(Map) + uid: '@azure/msal-common.RequestParameterBuilder.addThrottling' + package: '@azure/msal-common' + summary: Adds parameter that indicates to the server that throttling is supported + remarks: '' + isDeprecated: false + syntax: + content: 'function addThrottling(parameters: Map)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - name: addUsername(Map, string) + uid: '@azure/msal-common.RequestParameterBuilder.addUsername' + package: '@azure/msal-common' + summary: adds `username` for Password Grant flow + remarks: '' + isDeprecated: false + syntax: + content: 'function addUsername(parameters: Map, username: string)' + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: username + type: string + description: '' + - name: instrumentBrokerParams(Map, string, IPerformanceClient) + uid: '@azure/msal-common.RequestParameterBuilder.instrumentBrokerParams' + package: '@azure/msal-common' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function instrumentBrokerParams(parameters: Map, + correlationId?: string, performanceClient?: IPerformanceClient) + parameters: + - id: parameters + type: Map<string, string> + description: '' + - id: correlationId + type: string + description: '' + - id: performanceClient + type: + description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml index 72a4e59..f512ce0 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml @@ -14,16 +14,29 @@ functions: syntax: content: >- function getDeserializedResponse(responseString: string): - ServerAuthorizationCodeResponse | null + AuthorizeResponse | null parameters: - id: responseString type: string description: '' return: description: '' - type: >- - | - null + type: | null + - name: mapToQueryString(Map) + uid: '@azure/msal-common.UrlUtils.mapToQueryString' + package: '@azure/msal-common' + summary: Utility to create a URL from the params map + remarks: '' + isDeprecated: false + syntax: + content: 'function mapToQueryString(parameters: Map): string' + parameters: + - id: parameters + type: Map<string, string> + description: '' + return: + description: '' + type: string - name: stripLeadingHashOrQuery(string) uid: '@azure/msal-common.UrlUtils.stripLeadingHashOrQuery' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml index d2acd92..92841f6 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -51,6 +51,7 @@ typeAliases: - '@azure/msal-common.AuthorityOptions' - '@azure/msal-common.AuthorityType' - '@azure/msal-common.AuthorizationCodePayload' + - '@azure/msal-common.AuthorizeResponse' - '@azure/msal-common.AzureCloudInstance' - '@azure/msal-common.AzureCloudOptions' - '@azure/msal-common.AzureRegion' @@ -93,6 +94,7 @@ typeAliases: - '@azure/msal-common.NativeSignOutRequest' - '@azure/msal-common.NetworkRequestOptions' - '@azure/msal-common.NetworkResponse' + - '@azure/msal-common.OAuthResponseType' - '@azure/msal-common.OIDCOptions' - '@azure/msal-common.PasswordGrantConstants' - '@azure/msal-common.PerformanceCallbackFunction' @@ -105,7 +107,6 @@ typeAliases: - '@azure/msal-common.RequestStateObject' - '@azure/msal-common.RequestThumbprint' - '@azure/msal-common.ResponseMode' - - '@azure/msal-common.ServerAuthorizationCodeResponse' - '@azure/msal-common.ServerAuthorizationTokenResponse' - '@azure/msal-common.ServerDeviceCodeResponse' - '@azure/msal-common.ServerResponseType' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-node/AuthorizeResponse.yml similarity index 54% rename from msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml rename to msal/docs-ref-autogen/@azure/msal-node/AuthorizeResponse.yml index 9a9a712..12f639a 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthorizeResponse.yml @@ -1,19 +1,13 @@ ### YamlMime:TSTypeAlias -name: ServerAuthorizationCodeResponse -uid: '@azure/msal-node.ServerAuthorizationCodeResponse' +name: AuthorizeResponse +uid: '@azure/msal-node.AuthorizeResponse' package: '@azure/msal-node' -summary: |- - Deserialized response object from server authorization code request. - - code: authorization code from server - - client_info: client info object - - state: OAuth2 request state - - error: error sent back in hash - - error: description -fullName: ServerAuthorizationCodeResponse +summary: Response properties that may be returned by the /authorize endpoint +fullName: AuthorizeResponse remarks: '' isDeprecated: false syntax: | - type ServerAuthorizationCodeResponse = { + type AuthorizeResponse = { accountId?: string claims?: string client_info?: string @@ -22,6 +16,7 @@ syntax: | cloud_instance_name?: string code?: string correlation_id?: string + ear_jwe?: string error?: string error_description?: string error_uri?: string diff --git a/msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml b/msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml index 32e3df9..0f921a3 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml @@ -38,7 +38,7 @@ methods: syntax: content: >- function listenForAuthCode(successTemplate?: string, errorTemplate?: - string): Promise + string): Promise parameters: - id: successTemplate type: string @@ -48,6 +48,4 @@ methods: description: '' return: description: '' - type: >- - Promise<> + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-node/index.yml b/msal/docs-ref-autogen/@azure/msal-node/index.yml index ba446c5..b2a7d8b 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/index.yml @@ -45,6 +45,7 @@ typeAliases: - '@azure/msal-node.AuthorizationCodePayload' - '@azure/msal-node.AuthorizationCodeRequest' - '@azure/msal-node.AuthorizationUrlRequest' + - '@azure/msal-node.AuthorizeResponse' - '@azure/msal-node.AzureCloudInstance' - '@azure/msal-node.AzureCloudOptions' - '@azure/msal-node.BrokerOptions' @@ -76,7 +77,6 @@ typeAliases: - '@azure/msal-node.SerializedAppMetadataEntity' - '@azure/msal-node.SerializedIdTokenEntity' - '@azure/msal-node.SerializedRefreshTokenEntity' - - '@azure/msal-node.ServerAuthorizationCodeResponse' - '@azure/msal-node.SignOutRequest' - '@azure/msal-node.SilentFlowRequest' - '@azure/msal-node.UsernamePasswordRequest' diff --git a/msal/docs-ref-autogen/@azure/msal-react/index.yml b/msal/docs-ref-autogen/@azure/msal-react/index.yml index 814d5e0..ac4a209 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/index.yml @@ -44,7 +44,7 @@ functions: MsalAuthenticationTemplate(PropsWithChildren> & { authenticationRequest?: PopupRequest | RedirectRequest | - Partial>, errorComponent?: any, interactionType: InteractionType, loadingComponent?: any }>) @@ -61,7 +61,7 @@ functions: PropsWithChildren> & { authenticationRequest?: PopupRequest | RedirectRequest | Partial>, errorComponent?: any, interactionType: InteractionType, loadingComponent?: any }>): React.ReactElement | null @@ -73,9 +73,9 @@ functions: "localAccountId" | "username">> & { authenticationRequest?: PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | - "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | - "platformBroker">>, errorComponent?: any, interactionType: - InteractionType, loadingComponent?: any }> + "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>, errorComponent?: + any, interactionType: InteractionType, loadingComponent?: any }> description: '' return: description: '' @@ -181,7 +181,7 @@ functions: type: - name: >- useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | - Partial>, Partial>) @@ -204,7 +204,7 @@ functions: content: >- function useMsalAuthentication(interactionType: InteractionType, authenticationRequest?: PopupRequest | RedirectRequest | - Partial>, accountIdentifiers?: Partial>): @@ -219,8 +219,8 @@ functions: uid="@azure/msal-browser.RedirectRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' - id: accountIdentifiers type: >- diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml index 599d7b6..aab0e6b 100644 --- a/msal/docs-ref-autogen/toc.yml +++ b/msal/docs-ref-autogen/toc.yml @@ -373,6 +373,12 @@ - uid: '@azure/msal-common.AuthorizationCodePayload' name: AuthorizationCodePayload items: [] + - uid: '@azure/msal-common.AuthorizeProtocol' + name: AuthorizeProtocol + items: [] + - uid: '@azure/msal-common.AuthorizeResponse' + name: AuthorizeResponse + items: [] - uid: '@azure/msal-common.AuthToken' name: AuthToken items: [] @@ -574,6 +580,9 @@ - uid: '@azure/msal-common.NetworkResponse' name: NetworkResponse items: [] + - uid: '@azure/msal-common.OAuthResponseType' + name: OAuthResponseType + items: [] - uid: '@azure/msal-common.OIDCOptions' name: OIDCOptions items: [] @@ -616,6 +625,9 @@ - uid: '@azure/msal-common.RefreshTokenEntity' name: RefreshTokenEntity items: [] + - uid: '@azure/msal-common.RequestParameterBuilder' + name: RequestParameterBuilder + items: [] - uid: '@azure/msal-common.RequestStateObject' name: RequestStateObject items: [] @@ -628,9 +640,6 @@ - uid: '@azure/msal-common.ScopeSet' name: ScopeSet items: [] - - uid: '@azure/msal-common.ServerAuthorizationCodeResponse' - name: ServerAuthorizationCodeResponse - items: [] - uid: '@azure/msal-common.ServerAuthorizationTokenResponse' name: ServerAuthorizationTokenResponse items: [] @@ -731,6 +740,9 @@ - uid: '@azure/msal-node.AuthorizationUrlRequest' name: AuthorizationUrlRequest items: [] + - uid: '@azure/msal-node.AuthorizeResponse' + name: AuthorizeResponse + items: [] - uid: '@azure/msal-node.AzureCloudInstance' name: AzureCloudInstance items: [] @@ -914,9 +926,6 @@ - uid: '@azure/msal-node.SerializedRefreshTokenEntity' name: SerializedRefreshTokenEntity items: [] - - uid: '@azure/msal-node.ServerAuthorizationCodeResponse' - name: ServerAuthorizationCodeResponse - items: [] - uid: '@azure/msal-node.ServerError' name: ServerError items: [] From 6c22b58eb6b01dbea39deca9bdd85f852c04e216 Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 3 Apr 2025 10:04:56 +0000 Subject: [PATCH 21/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=517214&view=results --- .../@azure/msal-angular/IMsalService.yml | 15 ++-------- .../@azure/msal-angular/MsalService.yml | 10 +++---- .../msal-browser/AuthorizationUrlRequest.yml | 7 ++--- .../@azure/msal-browser/IController.yml | 28 +++++++++---------- .../msal-browser/IPublicClientApplication.yml | 20 ++++++------- .../@azure/msal-browser/PerformanceEvents.yml | 20 ------------- .../@azure/msal-browser/PopupRequest.yml | 1 - .../msal-browser/PublicClientApplication.yml | 20 ++++++------- .../@azure/msal-browser/PublicClientNext.yml | 20 ++++++------- .../@azure/msal-browser/RedirectRequest.yml | 1 - .../@azure/msal-browser/SsoSilentRequest.yml | 1 - .../@azure/msal-react/index.yml | 18 ++++++------ 12 files changed, 64 insertions(+), 97 deletions(-) diff --git a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml index c5b9c28..28682bb 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml @@ -161,10 +161,7 @@ methods: - id: logger type: description: '' - - name: >- - ssoSilent(Partial>) + - name: ssoSilent(AuthorizationUrlRequest) uid: '@azure/msal-angular.IMsalService.ssoSilent' package: '@azure/msal-angular' summary: '' @@ -172,17 +169,11 @@ methods: isDeprecated: false syntax: content: >- - function ssoSilent(request: Partial>): + function ssoSilent(request: AuthorizationUrlRequest): Observable parameters: - id: request - type: >- - Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + type: description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml index c3af693..a362598 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml @@ -262,8 +262,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>) uid: '@azure/msal-angular.MsalService.ssoSilent' package: '@azure/msal-angular' summary: '' @@ -272,7 +272,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Observable parameters: @@ -280,8 +280,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml index b49fbed..30086a5 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml @@ -5,10 +5,9 @@ package: '@azure/msal-browser' summary: This type is deprecated and will be removed on the next major version update fullName: AuthorizationUrlRequest remarks: '' -isDeprecated: true -customDeprecatedMessage: Will be removed in future version +isDeprecated: false syntax: | type AuthorizationUrlRequest = Omit< CommonAuthorizationUrlRequest, - "requestedClaimsHash" | "platformBroker" - > + "state" | "nonce" | "requestedClaimsHash" | "platformBroker" + > & { nonce: string; state: string } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml index 39743db..608f55c 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml @@ -27,7 +27,7 @@ methods: type: Promise<> - name: >- acquireTokenNative(PopupRequest | SilentRequest | - Partial>, ApiId, string) uid: '@azure/msal-browser.IController.acquireTokenNative' @@ -38,7 +38,7 @@ methods: syntax: content: >- function acquireTokenNative(request: PopupRequest | SilentRequest | - Partial>, apiId: ApiId, accountId?: string): Promise @@ -49,8 +49,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' - id: apiId type: ApiId @@ -308,8 +308,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>) uid: '@azure/msal-browser.IController.hydrateCache' package: '@azure/msal-browser' summary: '' @@ -319,7 +319,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -333,8 +333,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' @@ -517,8 +517,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>) uid: '@azure/msal-browser.IController.ssoSilent' package: '@azure/msal-browser' summary: '' @@ -527,7 +527,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -535,8 +535,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml index fd791ed..a8e0d21 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml @@ -268,8 +268,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>) uid: '@azure/msal-browser.IPublicClientApplication.hydrateCache' package: '@azure/msal-browser' summary: '' @@ -279,7 +279,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -293,8 +293,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' @@ -477,8 +477,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>) uid: '@azure/msal-browser.IPublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: '' @@ -487,7 +487,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -495,8 +495,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml index cc890da..daf2373 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -182,10 +182,6 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.Decrypt' package: '@azure/msal-browser' summary: '' - - name: DecryptEarResponse - uid: '@azure/msal-browser.PerformanceEvents.DecryptEarResponse' - package: '@azure/msal-browser' - summary: '' - name: DeserializeResponse uid: '@azure/msal-browser.PerformanceEvents.DeserializeResponse' package: '@azure/msal-browser' @@ -212,10 +208,6 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.GenerateCodeVerifier' package: '@azure/msal-browser' summary: '' - - name: GenerateEarKey - uid: '@azure/msal-browser.PerformanceEvents.GenerateEarKey' - package: '@azure/msal-browser' - summary: '' - name: GenerateHKDF uid: '@azure/msal-browser.PerformanceEvents.GenerateHKDF' package: '@azure/msal-browser' @@ -262,18 +254,6 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.HandleRedirectPromiseMeasurement' package: '@azure/msal-browser' summary: '' - - name: HandleResponseCode - uid: '@azure/msal-browser.PerformanceEvents.HandleResponseCode' - package: '@azure/msal-browser' - summary: '' - - name: HandleResponseEar - uid: '@azure/msal-browser.PerformanceEvents.HandleResponseEar' - package: '@azure/msal-browser' - summary: '' - - name: HandleResponsePlatformBroker - uid: '@azure/msal-browser.PerformanceEvents.HandleResponsePlatformBroker' - package: '@azure/msal-browser' - summary: '' - name: HandleServerTokenResponse uid: '@azure/msal-browser.PerformanceEvents.HandleServerTokenResponse' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml index ae231af..ae43898 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml @@ -83,7 +83,6 @@ syntax: | CommonAuthorizationUrlRequest, | "responseMode" | "scopes" - | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml index b8b14fd..ce9d447 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -391,8 +391,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>) uid: '@azure/msal-browser.PublicClientApplication.hydrateCache' package: '@azure/msal-browser' summary: >- @@ -404,7 +404,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -418,8 +418,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: The request object that was used to obtain the AuthenticationResult return: description: '' @@ -633,8 +633,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>) uid: '@azure/msal-browser.PublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: >- @@ -663,7 +663,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -671,8 +671,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' return: description: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml index 6723a7e..5d3a9df 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml @@ -386,8 +386,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>) uid: '@azure/msal-browser.PublicClientNext.hydrateCache' package: '@azure/msal-browser' summary: >- @@ -399,7 +399,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -413,8 +413,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: The request object that was used to obtain the AuthenticationResult return: description: '' @@ -620,8 +620,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>) uid: '@azure/msal-browser.PublicClientNext.ssoSilent' package: '@azure/msal-browser' summary: >- @@ -650,7 +650,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -658,8 +658,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' return: description: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml index a89e91c..7a07161 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml @@ -86,7 +86,6 @@ syntax: | CommonAuthorizationUrlRequest, | "responseMode" | "scopes" - | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml index 251d414..3b630ee 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml @@ -74,7 +74,6 @@ syntax: | Omit< CommonAuthorizationUrlRequest, | "responseMode" - | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" diff --git a/msal/docs-ref-autogen/@azure/msal-react/index.yml b/msal/docs-ref-autogen/@azure/msal-react/index.yml index ac4a209..814d5e0 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/index.yml @@ -44,7 +44,7 @@ functions: MsalAuthenticationTemplate(PropsWithChildren> & { authenticationRequest?: PopupRequest | RedirectRequest | - Partial>, errorComponent?: any, interactionType: InteractionType, loadingComponent?: any }>) @@ -61,7 +61,7 @@ functions: PropsWithChildren> & { authenticationRequest?: PopupRequest | RedirectRequest | Partial>, errorComponent?: any, interactionType: InteractionType, loadingComponent?: any }>): React.ReactElement | null @@ -73,9 +73,9 @@ functions: "localAccountId" | "username">> & { authenticationRequest?: PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | - "earJwk" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">>, errorComponent?: - any, interactionType: InteractionType, loadingComponent?: any }> + "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>, errorComponent?: any, interactionType: + InteractionType, loadingComponent?: any }> description: '' return: description: '' @@ -181,7 +181,7 @@ functions: type: - name: >- useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | - Partial>, Partial>) @@ -204,7 +204,7 @@ functions: content: >- function useMsalAuthentication(interactionType: InteractionType, authenticationRequest?: PopupRequest | RedirectRequest | - Partial>, accountIdentifiers?: Partial>): @@ -219,8 +219,8 @@ functions: uid="@azure/msal-browser.RedirectRequest" /> | Partial<Omit<, - "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" - | "requestedClaimsHash" | "platformBroker">> + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' - id: accountIdentifiers type: >- From 611931f731238f135e0ff568ee6897a93b890f56 Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 10 Apr 2025 10:05:15 +0000 Subject: [PATCH 22/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=519897&view=results --- .../@azure/msal-angular/IMsalService.yml | 49 +++++++++++++++++-- .../msal-angular/MsalBroadcastService.yml | 9 ++++ .../@azure/msal-angular/MsalService.yml | 19 ++++--- .../msal-browser/AuthorizationUrlRequest.yml | 7 +-- .../@azure/msal-browser/IController.yml | 28 +++++------ .../msal-browser/IPublicClientApplication.yml | 20 ++++---- .../@azure/msal-browser/PerformanceEvents.yml | 20 ++++++++ .../@azure/msal-browser/PopupRequest.yml | 1 + .../msal-browser/PublicClientApplication.yml | 20 ++++---- .../@azure/msal-browser/PublicClientNext.yml | 20 ++++---- .../@azure/msal-browser/RedirectRequest.yml | 1 + .../@azure/msal-browser/SsoSilentRequest.yml | 1 + .../@azure/msal-react/index.yml | 18 +++---- 13 files changed, 147 insertions(+), 66 deletions(-) diff --git a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml index 28682bb..7c47f2b 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml @@ -149,6 +149,40 @@ methods: return: description: '' type: Observable<void> + - name: logoutPopup(EndSessionRequest) + uid: '@azure/msal-angular.IMsalService.logoutPopup' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutPopup(logoutRequest?: EndSessionRequest): + Observable + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Observable<void> + - name: logoutRedirect(EndSessionRequest) + uid: '@azure/msal-angular.IMsalService.logoutRedirect' + package: '@azure/msal-angular' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function logoutRedirect(logoutRequest?: EndSessionRequest): + Observable + parameters: + - id: logoutRequest + type: + description: '' + return: + description: '' + type: Observable<void> - name: setLogger(Logger) uid: '@azure/msal-angular.IMsalService.setLogger' package: '@azure/msal-angular' @@ -161,7 +195,10 @@ methods: - id: logger type: description: '' - - name: ssoSilent(AuthorizationUrlRequest) + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-angular.IMsalService.ssoSilent' package: '@azure/msal-angular' summary: '' @@ -169,11 +206,17 @@ methods: isDeprecated: false syntax: content: >- - function ssoSilent(request: AuthorizationUrlRequest): + function ssoSilent(request: Partial>): Observable parameters: - id: request - type: + type: >- + Partial<Omit<, + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml index 4e34cc5..5ff06f4 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml @@ -87,3 +87,12 @@ properties: type: >- ɵɵInjectableDeclaration<> +methods: + - name: resetInProgressEvent() + uid: '@azure/msal-angular.MsalBroadcastService.resetInProgressEvent' + package: '@azure/msal-angular' + summary: Resets inProgress state to None + remarks: '' + isDeprecated: false + syntax: + content: function resetInProgressEvent() diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml index a362598..8439706 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml @@ -8,14 +8,16 @@ remarks: '' isDeprecated: false type: class constructors: - - name: MsalService(IPublicClientApplication, Location) + - name: MsalService(IPublicClientApplication, Location, Injector) uid: '@azure/msal-angular.MsalService.constructor' package: '@azure/msal-angular' summary: '' remarks: '' isDeprecated: false syntax: - content: 'new MsalService(instance: IPublicClientApplication, location: Location)' + content: >- + new MsalService(instance: IPublicClientApplication, location: Location, + injector: Injector) parameters: - id: instance type: @@ -23,6 +25,9 @@ constructors: - id: location type: Location description: '' + - id: injector + type: Injector + description: '' properties: - name: instance uid: '@azure/msal-angular.MsalService.instance' @@ -262,8 +267,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-angular.MsalService.ssoSilent' package: '@azure/msal-angular' summary: '' @@ -272,7 +277,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Observable parameters: @@ -280,8 +285,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml index 30086a5..b49fbed 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationUrlRequest.yml @@ -5,9 +5,10 @@ package: '@azure/msal-browser' summary: This type is deprecated and will be removed on the next major version update fullName: AuthorizationUrlRequest remarks: '' -isDeprecated: false +isDeprecated: true +customDeprecatedMessage: Will be removed in future version syntax: | type AuthorizationUrlRequest = Omit< CommonAuthorizationUrlRequest, - "state" | "nonce" | "requestedClaimsHash" | "platformBroker" - > & { nonce: string; state: string } + "requestedClaimsHash" | "platformBroker" + > diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml index 608f55c..39743db 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml @@ -27,7 +27,7 @@ methods: type: Promise<> - name: >- acquireTokenNative(PopupRequest | SilentRequest | - Partial>, ApiId, string) uid: '@azure/msal-browser.IController.acquireTokenNative' @@ -38,7 +38,7 @@ methods: syntax: content: >- function acquireTokenNative(request: PopupRequest | SilentRequest | - Partial>, apiId: ApiId, accountId?: string): Promise @@ -49,8 +49,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' - id: apiId type: ApiId @@ -308,8 +308,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>) uid: '@azure/msal-browser.IController.hydrateCache' package: '@azure/msal-browser' summary: '' @@ -319,7 +319,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -333,8 +333,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' @@ -517,8 +517,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-browser.IController.ssoSilent' package: '@azure/msal-browser' summary: '' @@ -527,7 +527,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -535,8 +535,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml index a8e0d21..fd791ed 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml @@ -268,8 +268,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>) uid: '@azure/msal-browser.IPublicClientApplication.hydrateCache' package: '@azure/msal-browser' summary: '' @@ -279,7 +279,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -293,8 +293,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' @@ -477,8 +477,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-browser.IPublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: '' @@ -487,7 +487,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -495,8 +495,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml index daf2373..cc890da 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -182,6 +182,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.Decrypt' package: '@azure/msal-browser' summary: '' + - name: DecryptEarResponse + uid: '@azure/msal-browser.PerformanceEvents.DecryptEarResponse' + package: '@azure/msal-browser' + summary: '' - name: DeserializeResponse uid: '@azure/msal-browser.PerformanceEvents.DeserializeResponse' package: '@azure/msal-browser' @@ -208,6 +212,10 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.GenerateCodeVerifier' package: '@azure/msal-browser' summary: '' + - name: GenerateEarKey + uid: '@azure/msal-browser.PerformanceEvents.GenerateEarKey' + package: '@azure/msal-browser' + summary: '' - name: GenerateHKDF uid: '@azure/msal-browser.PerformanceEvents.GenerateHKDF' package: '@azure/msal-browser' @@ -254,6 +262,18 @@ fields: uid: '@azure/msal-browser.PerformanceEvents.HandleRedirectPromiseMeasurement' package: '@azure/msal-browser' summary: '' + - name: HandleResponseCode + uid: '@azure/msal-browser.PerformanceEvents.HandleResponseCode' + package: '@azure/msal-browser' + summary: '' + - name: HandleResponseEar + uid: '@azure/msal-browser.PerformanceEvents.HandleResponseEar' + package: '@azure/msal-browser' + summary: '' + - name: HandleResponsePlatformBroker + uid: '@azure/msal-browser.PerformanceEvents.HandleResponsePlatformBroker' + package: '@azure/msal-browser' + summary: '' - name: HandleServerTokenResponse uid: '@azure/msal-browser.PerformanceEvents.HandleServerTokenResponse' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml index ae43898..ae231af 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml @@ -83,6 +83,7 @@ syntax: | CommonAuthorizationUrlRequest, | "responseMode" | "scopes" + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml index ce9d447..b8b14fd 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -391,8 +391,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>) uid: '@azure/msal-browser.PublicClientApplication.hydrateCache' package: '@azure/msal-browser' summary: >- @@ -404,7 +404,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -418,8 +418,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: The request object that was used to obtain the AuthenticationResult return: description: '' @@ -633,8 +633,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-browser.PublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: >- @@ -663,7 +663,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -671,8 +671,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' return: description: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml index 5d3a9df..6723a7e 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml @@ -386,8 +386,8 @@ methods: - name: >- hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial>) + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>) uid: '@azure/msal-browser.PublicClientNext.hydrateCache' package: '@azure/msal-browser' summary: >- @@ -399,7 +399,7 @@ methods: content: >- function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | - Partial>): Promise parameters: @@ -413,8 +413,8 @@ methods: uid="@azure/msal-browser.SilentRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: The request object that was used to obtain the AuthenticationResult return: description: '' @@ -620,8 +620,8 @@ methods: description: '' - name: >- ssoSilent(Partial>) + "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" + | "platformBroker">>) uid: '@azure/msal-browser.PublicClientNext.ssoSilent' package: '@azure/msal-browser' summary: >- @@ -650,7 +650,7 @@ methods: syntax: content: >- function ssoSilent(request: Partial>): Promise parameters: @@ -658,8 +658,8 @@ methods: type: >- Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '[SsoSilentRequest](xref:@azure/msal-browser.SsoSilentRequest)' return: description: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml index 7a07161..a89e91c 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml @@ -86,6 +86,7 @@ syntax: | CommonAuthorizationUrlRequest, | "responseMode" | "scopes" + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml index 3b630ee..251d414 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml @@ -74,6 +74,7 @@ syntax: | Omit< CommonAuthorizationUrlRequest, | "responseMode" + | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" diff --git a/msal/docs-ref-autogen/@azure/msal-react/index.yml b/msal/docs-ref-autogen/@azure/msal-react/index.yml index 814d5e0..ac4a209 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/index.yml @@ -44,7 +44,7 @@ functions: MsalAuthenticationTemplate(PropsWithChildren> & { authenticationRequest?: PopupRequest | RedirectRequest | - Partial>, errorComponent?: any, interactionType: InteractionType, loadingComponent?: any }>) @@ -61,7 +61,7 @@ functions: PropsWithChildren> & { authenticationRequest?: PopupRequest | RedirectRequest | Partial>, errorComponent?: any, interactionType: InteractionType, loadingComponent?: any }>): React.ReactElement | null @@ -73,9 +73,9 @@ functions: "localAccountId" | "username">> & { authenticationRequest?: PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | - "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | - "platformBroker">>, errorComponent?: any, interactionType: - InteractionType, loadingComponent?: any }> + "earJwk" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">>, errorComponent?: + any, interactionType: InteractionType, loadingComponent?: any }> description: '' return: description: '' @@ -181,7 +181,7 @@ functions: type: - name: >- useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | - Partial>, Partial>) @@ -204,7 +204,7 @@ functions: content: >- function useMsalAuthentication(interactionType: InteractionType, authenticationRequest?: PopupRequest | RedirectRequest | - Partial>, accountIdentifiers?: Partial>): @@ -219,8 +219,8 @@ functions: uid="@azure/msal-browser.RedirectRequest" /> | Partial<Omit<, - "responseMode" | "codeChallenge" | "codeChallengeMethod" | - "requestedClaimsHash" | "platformBroker">> + "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" + | "requestedClaimsHash" | "platformBroker">> description: '' - id: accountIdentifiers type: >- From 67dc70fb5f6969ffa5533564bec96e859eb84e47 Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 17 Apr 2025 10:06:59 +0000 Subject: [PATCH 23/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=521947&view=results --- .../@azure/msal-browser/BrowserAuthOptions.yml | 1 + .../@azure/msal-common/AuthorizeProtocol.yml | 11 +++++++++-- .../docs-ref-autogen/@azure/msal-common/UrlUtils.yml | 12 ++++++++++-- .../@azure/msal-node/NodeAuthOptions.yml | 4 ++++ 4 files changed, 24 insertions(+), 4 deletions(-) diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml index da431d0..73d0a63 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml @@ -15,6 +15,7 @@ syntax: | clientCapabilities?: string[] clientId: string cloudDiscoveryMetadata?: string + encodeExtraQueryParams?: boolean instanceAware?: boolean knownAuthorities?: string[] navigateToLoginRequestUrl?: boolean diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorizeProtocol.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorizeProtocol.yml index cb8dbc2..c3fddc5 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthorizeProtocol.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorizeProtocol.yml @@ -29,7 +29,7 @@ functions: return: description: '' type: - - name: getAuthorizeUrl(Authority, Map) + - name: getAuthorizeUrl(Authority, Map, boolean, StringDict) uid: '@azure/msal-common.AuthorizeProtocol.getAuthorizeUrl' package: '@azure/msal-common' summary: >- @@ -40,7 +40,8 @@ functions: syntax: content: >- function getAuthorizeUrl(authority: Authority, requestParameters: - Map): string + Map, encodeParams?: boolean, extraQueryParameters?: + StringDict): string parameters: - id: authority type: Authority @@ -48,6 +49,12 @@ functions: - id: requestParameters type: Map<string, string> description: '' + - id: encodeParams + type: boolean + description: '' + - id: extraQueryParameters + type: + description: '' return: description: '' type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml index f512ce0..c0d3c79 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml @@ -22,18 +22,26 @@ functions: return: description: '' type: | null - - name: mapToQueryString(Map) + - name: mapToQueryString(Map, boolean, StringDict) uid: '@azure/msal-common.UrlUtils.mapToQueryString' package: '@azure/msal-common' summary: Utility to create a URL from the params map remarks: '' isDeprecated: false syntax: - content: 'function mapToQueryString(parameters: Map): string' + content: >- + function mapToQueryString(parameters: Map, + encodeExtraParams?: boolean, extraQueryParameters?: StringDict): string parameters: - id: parameters type: Map<string, string> description: '' + - id: encodeExtraParams + type: boolean + description: '' + - id: extraQueryParameters + type: + description: '' return: description: '' type: string diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml index 4386638..ef4d174 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml @@ -33,6 +33,9 @@ summary: >- - skipAuthorityMetadataCache - A flag to choose whether to use or not use the local metadata cache during authority initialization. Defaults to false. + + - encodeExtraQueryParams - A flag to choose whether to encode extra query + parameters in the request URL. Defaults to false. fullName: NodeAuthOptions remarks: '' isDeprecated: false @@ -52,6 +55,7 @@ syntax: | clientId: string clientSecret?: string cloudDiscoveryMetadata?: string + encodeExtraQueryParams?: boolean knownAuthorities?: string[] protocolMode?: ProtocolMode skipAuthorityMetadataCache?: boolean From 9f57e2695a2a395417790a7f115076656b9077c5 Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Thu, 8 May 2025 10:03:34 +0000 Subject: [PATCH 24/24] CI Update Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=528979&view=results --- .../msal-angular/MsalBroadcastService.yml | 16 +-- .../@azure/msal-browser/AuthError.yml | 126 ++++++++++++++--- .../@azure/msal-browser/BrowserAuthError.yml | 130 +++++++++++++++--- .../BrowserConfigurationAuthError.yml | 130 +++++++++++++++--- .../@azure/msal-browser/ClientAuthError.yml | 130 +++++++++++++++--- .../msal-browser/ClientConfigurationError.yml | 130 +++++++++++++++--- .../@azure/msal-browser/IController.yml | 9 +- .../InteractionRequiredAuthError.yml | 130 +++++++++++++++--- .../@azure/msal-browser/PerformanceEvent.yml | 2 + .../@azure/msal-browser/ServerError.yml | 130 +++++++++++++++--- .../@azure/msal-common/AuthError.yml | 126 ++++++++++++++--- .../@azure/msal-common/CacheError.yml | 126 ++++++++++++++--- .../@azure/msal-common/ClientAuthError.yml | 130 +++++++++++++++--- .../msal-common/ClientConfigurationError.yml | 130 +++++++++++++++--- .../InteractionRequiredAuthError.yml | 130 +++++++++++++++--- .../@azure/msal-common/NetworkError.yml | 130 +++++++++++++++--- .../@azure/msal-common/PerformanceEvent.yml | 2 + .../@azure/msal-common/ServerError.yml | 130 +++++++++++++++--- .../@azure/msal-common/index.yml | 8 +- .../@azure/msal-node/AuthError.yml | 126 ++++++++++++++--- .../@azure/msal-node/ClientAuthError.yml | 130 +++++++++++++++--- .../msal-node/ClientConfigurationError.yml | 130 +++++++++++++++--- .../InteractionRequiredAuthError.yml | 130 +++++++++++++++--- .../@azure/msal-node/ServerError.yml | 130 +++++++++++++++--- 24 files changed, 2103 insertions(+), 388 deletions(-) diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml index 5ff06f4..ad40902 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml @@ -8,9 +8,7 @@ remarks: '' isDeprecated: false type: class constructors: - - name: >- - MsalBroadcastService(IPublicClientApplication, MsalService, - MsalBroadcastConfiguration) + - name: MsalBroadcastService(IPublicClientApplication, MsalBroadcastConfiguration) uid: '@azure/msal-angular.MsalBroadcastService.constructor' package: '@azure/msal-angular' summary: '' @@ -19,15 +17,11 @@ constructors: syntax: content: >- new MsalBroadcastService(msalInstance: IPublicClientApplication, - authService: MsalService, msalBroadcastConfig?: - MsalBroadcastConfiguration) + msalBroadcastConfig?: MsalBroadcastConfiguration) parameters: - id: msalInstance type: description: '' - - id: authService - type: - description: '' - id: msalBroadcastConfig type: description: '' @@ -65,14 +59,14 @@ properties: isDeprecated: false syntax: content: >- - static ɵfac: ɵɵFactoryDeclaration return: description: '' type: >- ɵɵFactoryDeclaration<, [null, null, { - optional: true }]> + uid="@azure/msal-angular.MsalBroadcastService" />, [null, { optional: + true }]> - name: ɵprov uid: '@azure/msal-angular.MsalBroadcastService.ɵprov' package: '@azure/msal-angular' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/AuthError.yml index ef4be62..0062b76 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/AuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/AuthError.yml @@ -104,22 +104,6 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.name - - name: prepareStackTrace - uid: '@azure/msal-browser.AuthError.prepareStackTrace' - package: '@azure/msal-browser' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: Inherited From Error.prepareStackTrace - name: stack uid: '@azure/msal-browser.AuthError.stack' package: '@azure/msal-browser' @@ -136,7 +120,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-browser.AuthError.stackTraceLimit' package: '@azure/msal-browser' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -150,7 +151,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-browser.AuthError.captureStackTrace' package: '@azure/msal-browser' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -165,6 +231,30 @@ inheritedMethods: type: Function description: '' inheritanceDescription: Inherited From Error.captureStackTrace + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-browser.AuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: Inherited From Error.prepareStackTrace methods: - name: setCorrelationId(string) uid: '@azure/msal-browser.AuthError.setCorrelationId' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml index 9476c1c..7f45813 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml @@ -99,24 +99,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-browser.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-browser.BrowserAuthError.prepareStackTrace' - package: '@azure/msal-browser' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-browser.BrowserAuthError.stack' package: '@azure/msal-browser' @@ -135,7 +117,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-browser.BrowserAuthError.stackTraceLimit' package: '@azure/msal-browser' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -166,7 +165,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-browser.BrowserAuthError.captureStackTrace' package: '@azure/msal-browser' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -183,6 +247,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-browser.BrowserAuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-browser.BrowserAuthError.setCorrelationId' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml index d75f427..a4fa076 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml @@ -101,24 +101,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-browser.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-browser.BrowserConfigurationAuthError.prepareStackTrace' - package: '@azure/msal-browser' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-browser.BrowserConfigurationAuthError.stack' package: '@azure/msal-browser' @@ -137,7 +119,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-browser.BrowserConfigurationAuthError.stackTraceLimit' package: '@azure/msal-browser' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -168,7 +167,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-browser.BrowserConfigurationAuthError.captureStackTrace' package: '@azure/msal-browser' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -185,6 +249,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-browser.BrowserConfigurationAuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-browser.BrowserConfigurationAuthError.setCorrelationId' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthError.yml index 838de04..21919a8 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ClientAuthError.yml @@ -99,24 +99,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-browser.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-browser.ClientAuthError.prepareStackTrace' - package: '@azure/msal-browser' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-browser.ClientAuthError.stack' package: '@azure/msal-browser' @@ -135,7 +117,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-browser.ClientAuthError.stackTraceLimit' package: '@azure/msal-browser' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -166,7 +165,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-browser.ClientAuthError.captureStackTrace' package: '@azure/msal-browser' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -183,6 +247,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-browser.ClientAuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-browser.ClientAuthError.setCorrelationId' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationError.yml b/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationError.yml index 2b67c8c..1c32790 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ClientConfigurationError.yml @@ -96,24 +96,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-browser.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-browser.ClientConfigurationError.prepareStackTrace' - package: '@azure/msal-browser' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-browser.ClientConfigurationError.stack' package: '@azure/msal-browser' @@ -132,7 +114,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-browser.ClientConfigurationError.stackTraceLimit' package: '@azure/msal-browser' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -163,7 +162,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-browser.ClientConfigurationError.captureStackTrace' package: '@azure/msal-browser' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -180,6 +244,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-browser.ClientConfigurationError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-browser.ClientConfigurationError.setCorrelationId' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml index 39743db..f72055b 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IController.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml @@ -339,7 +339,7 @@ methods: return: description: '' type: Promise<void> - - name: initialize(InitializeApplicationRequest) + - name: initialize(InitializeApplicationRequest, boolean) uid: '@azure/msal-browser.IController.initialize' package: '@azure/msal-browser' summary: '' @@ -347,12 +347,15 @@ methods: isDeprecated: false syntax: content: >- - function initialize(request?: InitializeApplicationRequest): - Promise + function initialize(request?: InitializeApplicationRequest, isBroker?: + boolean): Promise parameters: - id: request type: description: '' + - id: isBroker + type: boolean + description: '' return: description: '' type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml index 146217a..9a8a75c 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml @@ -188,24 +188,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-browser.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-browser.InteractionRequiredAuthError.prepareStackTrace' - package: '@azure/msal-browser' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-browser.InteractionRequiredAuthError.stack' package: '@azure/msal-browser' @@ -224,7 +206,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-browser.InteractionRequiredAuthError.stackTraceLimit' package: '@azure/msal-browser' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -255,7 +254,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-browser.InteractionRequiredAuthError.captureStackTrace' package: '@azure/msal-browser' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -272,6 +336,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-browser.InteractionRequiredAuthError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-browser.InteractionRequiredAuthError.setCorrelationId' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml index 632d1cf..baa9b24 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml @@ -67,6 +67,7 @@ syntax: | matsSilentMessage?: string matsSilentStatus?: number matsUiVisible?: boolean + msalInstanceCount?: number multiMatchedAT?: number multiMatchedID?: number multiMatchedRT?: number @@ -80,6 +81,7 @@ syntax: | requestId?: string retryError?: string rtExpiresOnMs?: number + sameClientIdInstanceCount?: number scenarioId?: string serverErrorNo?: string sidFromClaims?: boolean diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml index 39f67f0..9ca4970 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml @@ -137,24 +137,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-browser.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-browser.ServerError.prepareStackTrace' - package: '@azure/msal-browser' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-browser.ServerError.stack' package: '@azure/msal-browser' @@ -173,7 +155,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-browser.ServerError.stackTraceLimit' package: '@azure/msal-browser' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -204,7 +203,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-browser.ServerError.captureStackTrace' package: '@azure/msal-browser' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -221,6 +285,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-browser.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-browser.ServerError.prepareStackTrace' + package: '@azure/msal-browser' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-browser.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-browser.ServerError.setCorrelationId' package: '@azure/msal-browser' diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthError.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthError.yml index 40a15ca..a590045 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthError.yml @@ -104,22 +104,6 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.name - - name: prepareStackTrace - uid: '@azure/msal-common.AuthError.prepareStackTrace' - package: '@azure/msal-common' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: Inherited From Error.prepareStackTrace - name: stack uid: '@azure/msal-common.AuthError.stack' package: '@azure/msal-common' @@ -136,7 +120,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-common.AuthError.stackTraceLimit' package: '@azure/msal-common' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -150,7 +151,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-common.AuthError.captureStackTrace' package: '@azure/msal-common' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -165,6 +231,30 @@ inheritedMethods: type: Function description: '' inheritanceDescription: Inherited From Error.captureStackTrace + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-common.AuthError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: Inherited From Error.prepareStackTrace methods: - name: setCorrelationId(string) uid: '@azure/msal-common.AuthError.setCorrelationId' diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheError.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheError.yml index a3c711d..4a2fe11 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CacheError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheError.yml @@ -75,22 +75,6 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.name - - name: prepareStackTrace - uid: '@azure/msal-common.CacheError.prepareStackTrace' - package: '@azure/msal-common' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: Inherited From Error.prepareStackTrace - name: stack uid: '@azure/msal-common.CacheError.stack' package: '@azure/msal-common' @@ -107,7 +91,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-common.CacheError.stackTraceLimit' package: '@azure/msal-common' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -121,7 +122,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-common.CacheError.captureStackTrace' package: '@azure/msal-common' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -136,4 +202,28 @@ inheritedMethods: type: Function description: '' inheritanceDescription: Inherited From Error.captureStackTrace + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-common.CacheError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: Inherited From Error.prepareStackTrace extends: Error diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml index 918fc5a..ee56ed3 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml @@ -99,24 +99,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-common.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-common.ClientAuthError.prepareStackTrace' - package: '@azure/msal-common' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-common.ClientAuthError.stack' package: '@azure/msal-common' @@ -135,7 +117,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-common.ClientAuthError.stackTraceLimit' package: '@azure/msal-common' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -166,7 +165,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-common.ClientAuthError.captureStackTrace' package: '@azure/msal-common' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -183,6 +247,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-common.ClientAuthError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-common.ClientAuthError.setCorrelationId' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml index c6018f8..9adead1 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml @@ -96,24 +96,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-common.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-common.ClientConfigurationError.prepareStackTrace' - package: '@azure/msal-common' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-common.ClientConfigurationError.stack' package: '@azure/msal-common' @@ -132,7 +114,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-common.ClientConfigurationError.stackTraceLimit' package: '@azure/msal-common' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -163,7 +162,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-common.ClientConfigurationError.captureStackTrace' package: '@azure/msal-common' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -180,6 +244,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-common.ClientConfigurationError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-common.ClientConfigurationError.setCorrelationId' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml index be50005..92b3a34 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml @@ -188,24 +188,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-common.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-common.InteractionRequiredAuthError.prepareStackTrace' - package: '@azure/msal-common' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-common.InteractionRequiredAuthError.stack' package: '@azure/msal-common' @@ -224,7 +206,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-common.InteractionRequiredAuthError.stackTraceLimit' package: '@azure/msal-common' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -255,7 +254,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-common.InteractionRequiredAuthError.captureStackTrace' package: '@azure/msal-common' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -272,6 +336,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-common.InteractionRequiredAuthError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-common.InteractionRequiredAuthError.setCorrelationId' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml b/msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml index 7ea5f1e..d7aa082 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml @@ -141,24 +141,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-common.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-common.NetworkError.prepareStackTrace' - package: '@azure/msal-common' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-common.NetworkError.stack' package: '@azure/msal-common' @@ -177,7 +159,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-common.NetworkError.stackTraceLimit' package: '@azure/msal-common' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -208,7 +207,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-common.NetworkError.captureStackTrace' package: '@azure/msal-common' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -225,6 +289,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-common.NetworkError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-common.NetworkError.setCorrelationId' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml index 9af9625..e7d8ad0 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -67,6 +67,7 @@ syntax: | matsSilentMessage?: string matsSilentStatus?: number matsUiVisible?: boolean + msalInstanceCount?: number multiMatchedAT?: number multiMatchedID?: number multiMatchedRT?: number @@ -80,6 +81,7 @@ syntax: | requestId?: string retryError?: string rtExpiresOnMs?: number + sameClientIdInstanceCount?: number scenarioId?: string serverErrorNo?: string sidFromClaims?: boolean diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml index 9140d0d..0bfd614 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml @@ -137,24 +137,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-common.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-common.ServerError.prepareStackTrace' - package: '@azure/msal-common' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-common.ServerError.stack' package: '@azure/msal-common' @@ -173,7 +155,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-common.ServerError.stackTraceLimit' package: '@azure/msal-common' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -204,7 +203,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-common.ServerError.captureStackTrace' package: '@azure/msal-common' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -221,6 +285,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-common.ServerError.prepareStackTrace' + package: '@azure/msal-common' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-common.ServerError.setCorrelationId' package: '@azure/msal-common' diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml index 92841f6..61f2757 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -333,7 +333,7 @@ functions: return: description: '' type: - - name: createNetworkError(AuthError, number, Record) + - name: createNetworkError(AuthError, number, Record, Error) uid: '@azure/msal-common.createNetworkError' package: '@azure/msal-common' summary: Creates NetworkError object for a failed network request @@ -342,7 +342,8 @@ functions: syntax: content: >- function createNetworkError(error: AuthError, httpStatus?: number, - responseHeaders?: Record): NetworkError + responseHeaders?: Record, additionalError?: Error): + NetworkError parameters: - id: error type: @@ -353,6 +354,9 @@ functions: - id: responseHeaders type: Record<string, string> description: Response headers of the network request, when available + - id: additionalError + type: Error + description: '' return: description: NetworkError object type: diff --git a/msal/docs-ref-autogen/@azure/msal-node/AuthError.yml b/msal/docs-ref-autogen/@azure/msal-node/AuthError.yml index 6fb7c3e..ac0337d 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/AuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthError.yml @@ -104,22 +104,6 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.name - - name: prepareStackTrace - uid: '@azure/msal-node.AuthError.prepareStackTrace' - package: '@azure/msal-node' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: Inherited From Error.prepareStackTrace - name: stack uid: '@azure/msal-node.AuthError.stack' package: '@azure/msal-node' @@ -136,7 +120,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-node.AuthError.stackTraceLimit' package: '@azure/msal-node' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -150,7 +151,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-node.AuthError.captureStackTrace' package: '@azure/msal-node' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -165,6 +231,30 @@ inheritedMethods: type: Function description: '' inheritanceDescription: Inherited From Error.captureStackTrace + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-node.AuthError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: Inherited From Error.prepareStackTrace methods: - name: setCorrelationId(string) uid: '@azure/msal-node.AuthError.setCorrelationId' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientAuthError.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientAuthError.yml index dce5acb..8ce0b6d 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientAuthError.yml @@ -99,24 +99,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-node.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-node.ClientAuthError.prepareStackTrace' - package: '@azure/msal-node' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-node.ClientAuthError.stack' package: '@azure/msal-node' @@ -135,7 +117,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-node.ClientAuthError.stackTraceLimit' package: '@azure/msal-node' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -166,7 +165,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-node.ClientAuthError.captureStackTrace' package: '@azure/msal-node' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -183,6 +247,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-node.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-node.ClientAuthError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-node.ClientAuthError.setCorrelationId' package: '@azure/msal-node' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationError.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationError.yml index 2894a03..29569d6 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationError.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientConfigurationError.yml @@ -96,24 +96,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-node.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-node.ClientConfigurationError.prepareStackTrace' - package: '@azure/msal-node' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-node.ClientConfigurationError.stack' package: '@azure/msal-node' @@ -132,7 +114,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-node.ClientConfigurationError.stackTraceLimit' package: '@azure/msal-node' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -163,7 +162,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-node.ClientConfigurationError.captureStackTrace' package: '@azure/msal-node' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -180,6 +244,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-node.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-node.ClientConfigurationError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-node.ClientConfigurationError.setCorrelationId' package: '@azure/msal-node' diff --git a/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml index 1b1111a..82856ba 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml @@ -188,24 +188,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-node.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-node.InteractionRequiredAuthError.prepareStackTrace' - package: '@azure/msal-node' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-node.InteractionRequiredAuthError.stack' package: '@azure/msal-node' @@ -224,7 +206,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-node.InteractionRequiredAuthError.stackTraceLimit' package: '@azure/msal-node' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -255,7 +254,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-node.InteractionRequiredAuthError.captureStackTrace' package: '@azure/msal-node' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -272,6 +336,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-node.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-node.InteractionRequiredAuthError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-node.InteractionRequiredAuthError.setCorrelationId' package: '@azure/msal-node' diff --git a/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml b/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml index 470fc39..a3c9aca 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml @@ -137,24 +137,6 @@ inheritedProperties: inheritanceDescription: >- Inherited From [AuthError.name](xref:@azure/msal-node.AuthError.name) - - name: prepareStackTrace - uid: '@azure/msal-node.ServerError.prepareStackTrace' - package: '@azure/msal-node' - summary: |- - Optional override for formatting stack traces - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - fullName: prepareStackTrace - remarks: '' - isDeprecated: false - syntax: - content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' - return: - description: '' - type: '(err: Error, stackTraces: CallSite[]) => any' - inheritanceDescription: >- - Inherited From - [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) - name: stack uid: '@azure/msal-node.ServerError.stack' package: '@azure/msal-node' @@ -173,7 +155,24 @@ inheritedProperties: - name: stackTraceLimit uid: '@azure/msal-node.ServerError.stackTraceLimit' package: '@azure/msal-node' - summary: '' + summary: >- + The `Error.stackTraceLimit` property specifies the number of stack frames + + collected by a stack trace (whether generated by `new Error().stack` or + + `Error.captureStackTrace(obj)`). + + + The default value is `10` but may be set to any valid JavaScript number. + Changes + + will affect any stack trace captured _after_ the value has been changed. + + + If set to a non-number value, or set to a negative number, stack traces + will + + not capture any frames. fullName: stackTraceLimit remarks: '' isDeprecated: false @@ -204,7 +203,72 @@ inheritedMethods: - name: captureStackTrace(object, Function) uid: '@azure/msal-node.ServerError.captureStackTrace' package: '@azure/msal-node' - summary: Create .stack property on a target object + summary: >- + Creates a `.stack` property on `targetObject`, which when accessed returns + + a string representing the location in the code at which + + `Error.captureStackTrace()` was called. + + + ```js + + const myObject = {}; + + Error.captureStackTrace(myObject); + + myObject.stack; // Similar to `new Error().stack` + + ``` + + + The first line of the trace will be prefixed with + + `${myObject.name}: ${myObject.message}`. + + + The optional `constructorOpt` argument accepts a function. If given, all + frames + + above `constructorOpt`, including `constructorOpt`, will be omitted from + the + + generated stack trace. + + + The `constructorOpt` argument is useful for hiding implementation + + details of error generation from the user. For instance: + + + ```js + + function a() { + b(); + } + + + function b() { + c(); + } + + + function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; + } + + + a(); + + ``` remarks: '' isDeprecated: false syntax: @@ -221,6 +285,32 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.captureStackTrace](xref:@azure/msal-node.AuthError.captureStackTrace) + - name: prepareStackTrace(Error, CallSite[]) + uid: '@azure/msal-node.ServerError.prepareStackTrace' + package: '@azure/msal-node' + summary: |- + + + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + remarks: '' + isDeprecated: false + syntax: + content: >- + static function prepareStackTrace(err: Error, stackTraces: CallSite[]): + any + parameters: + - id: err + type: Error + description: '' + - id: stackTraces + type: CallSite[] + description: '' + return: + description: '' + type: any + inheritanceDescription: >- + Inherited From + [AuthError.prepareStackTrace](xref:@azure/msal-node.AuthError.prepareStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-node.ServerError.setCorrelationId' package: '@azure/msal-node'