From f68d9a340bb1385e4202d18caa59be4473045367 Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Wed, 12 Mar 2025 08:01:47 +0000 Subject: [PATCH] CI Update Build.Reason:Manual by Tina Liu (INFOSYS LIMITED) Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=510046&view=results --- .../@azure/msal-angular/IMsalService.yml | 54 +- .../@azure/msal-angular/MatchingResources.yml | 14 - .../MsalBroadcastConfiguration.yml | 1 - .../msal-angular/MsalBroadcastService.yml | 41 +- .../MsalCustomNavigationClient.yml | 52 +- .../@azure/msal-angular/MsalGuard.yml | 60 +- .../msal-angular/MsalGuardAuthRequest.yml | 1 - .../msal-angular/MsalGuardConfiguration.yml | 17 +- .../@azure/msal-angular/MsalInterceptor.yml | 44 +- .../MsalInterceptorAuthRequest.yml | 1 - .../MsalInterceptorConfiguration.yml | 22 +- .../@azure/msal-angular/MsalModule.yml | 49 +- .../msal-angular/MsalRedirectComponent.yml | 35 +- .../@azure/msal-angular/MsalService.yml | 105 +- .../msal-angular/ProtectedResourceScopes.yml | 3 +- .../@azure/msal-angular/index.yml | 17 +- .../@azure/msal-browser/AccountInfo.yml | 51 + .../@azure/msal-browser/ApiId.yml | 61 +- .../msal-browser/AsyncMemoryStorage.yml | 151 -- .../@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 | 11 +- .../msal-browser/AuthorizationUrlRequest.yml | 5 +- .../msal-browser/AzureCloudInstance.yml | 11 + .../@azure/msal-browser/AzureCloudOptions.yml | 20 + .../@azure/msal-browser/Base64Decode.yml | 32 - .../@azure/msal-browser/Base64Encode.yml | 66 - .../msal-browser/BaseInteractionClient.yml | 110 -- .../@azure/msal-browser/BrowserAuthError.yml | 818 +--------- .../msal-browser/BrowserAuthErrorCodes.yml | 6 + .../msal-browser/BrowserAuthOptions.yml | 29 +- .../msal-browser/BrowserCacheLocation.yml | 19 +- .../msal-browser/BrowserCacheManager.yml | 1382 ----------------- .../msal-browser/BrowserConfiguration.yml | 16 - .../BrowserConfigurationAuthError.yml | 242 +-- .../BrowserConfigurationAuthErrorCodes.yml | 6 + .../@azure/msal-browser/BrowserCrypto.yml | 150 -- .../msal-browser/BrowserPerformanceClient.yml | 253 +-- .../BrowserPerformanceMeasurement.yml | 29 +- .../msal-browser/BrowserProtocolUtils.yml | 52 - .../msal-browser/BrowserStateObject.yml | 11 - .../@azure/msal-browser/BrowserStorage.yml | 98 -- .../msal-browser/BrowserStringUtils.yml | 82 - .../msal-browser/BrowserSystemOptions.yml | 28 +- .../msal-browser/BrowserTelemetryOptions.yml | 6 +- .../@azure/msal-browser/BrowserUtils.yml | 151 +- .../@azure/msal-browser/CacheLookupPolicy.yml | 37 +- .../@azure/msal-browser/CacheOptions.yml | 10 +- .../@azure/msal-browser/CachedKeyPair.yml | 16 - .../@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 | 9 +- .../@azure/msal-browser/CryptoKeyStore.yml | 79 - .../msal-browser/CryptoKeyStoreNames.yml | 18 - .../@azure/msal-browser/CryptoOps.yml | 188 --- .../@azure/msal-browser/CryptoOptions.yml | 11 - .../@azure/msal-browser/DatabaseStorage.yml | 147 -- .../msal-browser/EndSessionPopupRequest.yml | 15 +- .../@azure/msal-browser/EndSessionRequest.yml | 9 +- .../msal-browser/EventCallbackFunction.yml | 1 - .../@azure/msal-browser/EventError.yml | 1 - .../@azure/msal-browser/EventHandler.yml | 83 +- .../@azure/msal-browser/EventMessage.yml | 11 +- .../@azure/msal-browser/EventMessageUtils.yml | 13 +- .../@azure/msal-browser/EventPayload.yml | 1 - .../@azure/msal-browser/EventType.yml | 102 +- .../msal-browser/ExternalTokenResponse.yml | 39 + .../@azure/msal-browser/FetchClient.yml | 55 - .../@azure/msal-browser/GuidGenerator.yml | 54 - .../@azure/msal-browser/HTTP_REQUEST_TYPE.yml | 18 - .../HybridSpaAuthorizationCodeClient.yml | 184 --- .../@azure/msal-browser/IAsyncStorage.yml | 98 -- .../@azure/msal-browser/IController.yml | 543 +++++++ .../ILoggerCallback.yml | 5 +- .../@azure/msal-browser/INavigationClient.yml | 13 +- .../@azure/msal-browser/INetworkModule.yml | 61 + .../msal-browser/IPerformanceClient.yml | 230 +++ .../msal-browser/IPublicClientApplication.yml | 196 ++- .../@azure/msal-browser/ISubtleCrypto.yml | 153 -- .../@azure/msal-browser/ITokenCache.yml | 11 +- .../@azure/msal-browser/IWindowStorage.yml | 79 +- .../@azure/msal-browser/IdTokenClaims.yml | 44 + .../@azure/msal-browser/InMemoryCacheKeys.yml | 18 - .../InProgressPerformanceEvent.yml | 20 + .../InitializeApplicationRequest.yml | 16 + .../msal-browser/InteractionHandler.yml | 104 -- .../@azure/msal-browser/InteractionParams.yml | 11 - .../InteractionRequiredAuthError.yml | 290 ++++ .../InteractionRequiredAuthErrorCodes.yml | 6 + .../@azure/msal-browser/InteractionStatus.yml | 41 +- .../@azure/msal-browser/InteractionType.yml | 1 - .../@azure/msal-browser/JsonWebTokenTypes.yml | 11 + .../@azure/msal-browser/LoadTokenOptions.yml | 7 +- .../@azure/msal-browser/LocalStorage.yml | 162 ++ .../@azure/msal-browser/LogLevel.yml | 34 + .../@azure/msal-browser/Logger.yml | 235 +++ .../@azure/msal-browser/MATS.yml | 29 - .../@azure/msal-browser/MathUtils.yml | 28 - .../@azure/msal-browser/MemoryStorage.yml | 81 +- .../msal-browser/ModernBrowserCrypto.yml | 140 -- .../@azure/msal-browser/MsBrowserCrypto.yml | 140 -- .../@azure/msal-browser/MsrBrowserCrypto.yml | 153 -- .../@azure/msal-browser/NativeAccountInfo.yml | 11 - .../@azure/msal-browser/NativeAuthError.yml | 263 ---- .../msal-browser/NativeExtensionMethod.yml | 26 - .../msal-browser/NativeExtensionRequest.yml | 16 - .../NativeExtensionRequestBody.yml | 14 - .../msal-browser/NativeInteractionClient.yml | 156 -- .../msal-browser/NativeMessageHandler.yml | 137 -- .../@azure/msal-browser/NativeResponse.yml | 22 - .../msal-browser/NativeResponseProperties.yml | 11 - .../@azure/msal-browser/NativeStatusCode.yml | 38 - .../msal-browser/NativeTokenRequest.yml | 32 - .../@azure/msal-browser/NavigationClient.yml | 13 +- .../@azure/msal-browser/NavigationOptions.yml | 3 +- .../msal-browser/NetworkRequestOptions.yml | 11 + .../@azure/msal-browser/NetworkResponse.yml | 14 + .../@azure/msal-browser/OSError.yml | 17 - .../PerformanceCallbackFunction.yml | 10 + .../@azure/msal-browser/PerformanceEvent.yml | 94 ++ .../@azure/msal-browser/PerformanceEvents.yml | 478 ++++++ .../@azure/msal-browser/PkceGenerator.yml | 39 - .../@azure/msal-browser/PopupClient.yml | 269 ---- .../@azure/msal-browser/PopupEvent.yml | 1 - .../@azure/msal-browser/PopupParams.yml | 15 - .../@azure/msal-browser/PopupPosition.yml | 3 +- .../@azure/msal-browser/PopupRequest.yml | 19 +- .../@azure/msal-browser/PopupSize.yml | 3 +- .../msal-browser/PopupWindowAttributes.yml | 5 +- .../@azure/msal-browser/ProtocolMode.yml | 10 + .../msal-browser/PublicClientApplication.yml | 524 +++---- ...ntApplication.yml => PublicClientNext.yml} | 443 ++++-- .../@azure/msal-browser/RedirectClient.yml | 142 -- .../@azure/msal-browser/RedirectHandler.yml | 130 -- .../@azure/msal-browser/RedirectParams.yml | 16 - .../@azure/msal-browser/RedirectRequest.yml | 16 +- .../@azure/msal-browser/ServerError.yml | 239 +++ .../msal-browser/ServerResponseType.yml | 11 + .../@azure/msal-browser/SessionStorage.yml | 124 ++ .../@azure/msal-browser/SignedHttpRequest.yml | 13 +- .../msal-browser/SignedHttpRequestOptions.yml | 1 - .../msal-browser/SilentAuthCodeClient.yml | 114 -- .../@azure/msal-browser/SilentCacheClient.yml | 130 -- .../@azure/msal-browser/SilentHandler.yml | 161 -- .../msal-browser/SilentIframeClient.yml | 118 -- .../msal-browser/SilentRefreshClient.yml | 109 -- .../@azure/msal-browser/SilentRequest.yml | 24 +- .../@azure/msal-browser/SsoSilentRequest.yml | 10 +- .../StandardInteractionClient.yml | 122 -- .../msal-browser/StubPerformanceClient.yml | 153 ++ .../msal-browser/TemporaryCacheKeys.yml | 66 - .../@azure/msal-browser/TenantProfile.yml | 13 + .../@azure/msal-browser/TokenCache.yml | 74 - .../@azure/msal-browser/UrlString.yml | 194 +++ .../@azure/msal-browser/WrapperSKU.yml | 14 +- .../@azure/msal-browser/XhrClient.yml | 53 - .../@azure/msal-browser/index.yml | 238 ++- .../msal-common/AADAuthorityConstants.yml | 21 +- .../@azure/msal-common/AADServerParamKeys.yml | 204 +-- .../@azure/msal-common/AccessTokenCache.yml | 11 - .../@azure/msal-common/AccessTokenEntity.yml | 528 +------ .../@azure/msal-common/AccountCache.yml | 11 - .../@azure/msal-common/AccountEntity.yml | 447 ------ .../@azure/msal-common/AccountFilter.yml | 14 +- .../@azure/msal-common/AccountInfo.yml | 27 +- .../msal-common/ActiveAccountFilters.yml | 7 +- .../@azure/msal-common/AppMetadataCache.yml | 11 - .../@azure/msal-common/AppMetadataEntity.yml | 146 +- .../@azure/msal-common/AppMetadataFilter.yml | 11 - .../AppTokenProviderParameters.yml | 12 +- .../msal-common/AppTokenProviderResult.yml | 10 +- .../msal-common/ApplicationTelemetry.yml | 3 +- .../@azure/msal-common/AuthError.yml | 88 +- .../@azure/msal-common/AuthErrorCodes.yml | 6 + .../@azure/msal-common/AuthOptions.yml | 41 - .../@azure/msal-common/AuthToken.yml | 94 +- .../AuthenticationHeaderParser.yml | 7 +- .../msal-common/AuthenticationResult.yml | 45 +- .../msal-common/AuthenticationScheme.yml | 21 +- .../@azure/msal-common/Authority.yml | 429 ----- .../@azure/msal-common/AuthorityFactory.yml | 96 +- .../msal-common/AuthorityMetadataEntity.yml | 275 ---- .../msal-common/AuthorityMetadataSource.yml | 26 - .../@azure/msal-common/AuthorityOptions.yml | 15 +- .../@azure/msal-common/AuthorityType.yml | 23 +- .../msal-common/AuthorizationCodeClient.yml | 186 --- .../msal-common/AuthorizationCodePayload.yml | 17 +- .../@azure/msal-common/AzureCloudInstance.yml | 32 +- .../@azure/msal-common/AzureCloudOptions.yml | 8 +- .../@azure/msal-common/AzureRegion.yml | 1 - .../msal-common/AzureRegionConfiguration.yml | 5 +- .../@azure/msal-common/BaseAuthRequest.yml | 58 +- .../@azure/msal-common/BaseClient.yml | 56 - .../@azure/msal-common/CacheAccountType.yml | 25 +- .../@azure/msal-common/CacheError.yml | 139 ++ .../@azure/msal-common/CacheErrorCodes.yml | 6 + .../@azure/msal-common/CacheHelpers.yml | 394 +++++ .../@azure/msal-common/CacheManager.yml | 803 ---------- .../@azure/msal-common/CacheOptions.yml | 16 + .../@azure/msal-common/CacheOutcome.yml | 26 +- .../@azure/msal-common/CacheRecord.yml | 108 -- .../@azure/msal-common/CacheSchemaType.yml | 50 - .../@azure/msal-common/CacheType.yml | 53 +- .../@azure/msal-common/CcsCredential.yml | 3 +- .../@azure/msal-common/CcsCredentialType.yml | 15 +- .../@azure/msal-common/ClaimsRequestKeys.yml | 17 +- .../@azure/msal-common/ClientAssertion.yml | 6 +- .../msal-common/ClientAssertionCallback.yml | 12 + .../msal-common/ClientAssertionConfig.yml | 10 + .../msal-common/ClientAssertionUtils.yml | 31 + .../@azure/msal-common/ClientAuthError.yml | 770 +-------- .../msal-common/ClientAuthErrorCodes.yml | 6 + .../msal-common/ClientConfiguration.yml | 46 - .../msal-common/ClientConfigurationError.yml | 1263 +-------------- .../ClientConfigurationErrorCodes.yml | 6 + .../msal-common/ClientCredentialClient.yml | 107 -- .../@azure/msal-common/ClientCredentials.yml | 14 - .../@azure/msal-common/ClientInfo.yml | 3 +- .../msal-common/CloudDiscoveryMetadata.yml | 15 - .../CloudInstanceDiscoveryResponse.yml | 16 - .../CommonAuthorizationCodeRequest.yml | 29 +- .../CommonAuthorizationUrlRequest.yml | 33 +- .../msal-common/CommonClientConfiguration.yml | 24 - .../CommonClientCredentialRequest.yml | 10 +- .../msal-common/CommonDeviceCodeRequest.yml | 16 +- .../msal-common/CommonEndSessionRequest.yml | 18 +- .../msal-common/CommonOnBehalfOfRequest.yml | 8 +- .../msal-common/CommonRefreshTokenRequest.yml | 12 +- .../msal-common/CommonSilentFlowRequest.yml | 15 +- .../CommonUsernamePasswordRequest.yml | 11 +- .../@azure/msal-common/CredentialCache.yml | 15 - .../@azure/msal-common/CredentialEntity.yml | 334 +--- .../@azure/msal-common/CredentialFilter.yml | 23 +- .../@azure/msal-common/CredentialType.yml | 24 +- .../@azure/msal-common/DecodedAuthToken.yml | 50 - .../msal-common/DefaultStorageClass.yml | 734 --------- .../@azure/msal-common/DeviceCodeClient.yml | 104 -- .../@azure/msal-common/DeviceCodeResponse.yml | 13 +- .../msal-common/ExternalTokenResponse.yml | 12 +- .../@azure/msal-common/GrantType.yml | 36 +- .../@azure/msal-common/HeaderNames.yml | 32 +- .../@azure/msal-common/HttpStatus.yml | 10 + .../@azure/msal-common/IAppTokenProvider.yml | 17 +- .../@azure/msal-common/ICacheManager.yml | 465 ------ .../@azure/msal-common/ICachePlugin.yml | 3 - .../@azure/msal-common/ICrypto.yml | 67 +- .../@azure/msal-common/IGuidGenerator.yml | 3 - .../@azure/msal-common/ILoggerCallback.yml | 3 +- .../@azure/msal-common/IMDSBadResponse.yml | 10 - .../msal-common/INativeBrokerPlugin.yml | 127 ++ .../@azure/msal-common/INetworkModule.yml | 12 +- .../@azure/msal-common/IPerformanceClient.yml | 144 +- .../msal-common/IPerformanceMeasurement.yml | 8 +- .../msal-common/ISerializableTokenCache.yml | 3 - .../@azure/msal-common/IUri.yml | 10 +- .../@azure/msal-common/IdTokenCache.yml | 11 - .../@azure/msal-common/IdTokenEntity.yml | 415 +---- .../@azure/msal-common/ImdsOptions.yml | 11 - .../InProgressPerformanceEvent.yml | 18 +- .../InteractionRequiredAuthError.yml | 248 +-- .../InteractionRequiredAuthErrorCodes.yml | 6 + .../@azure/msal-common/JoseHeader.yml | 91 -- .../@azure/msal-common/JoseHeaderOptions.yml | 11 - .../@azure/msal-common/JsonTypes.yml | 18 - .../@azure/msal-common/JsonWebTokenTypes.yml | 11 + .../@azure/msal-common/KeyLocation.yml | 18 - .../@azure/msal-common/LibraryInfo.yml | 11 - .../@azure/msal-common/LibraryStateObject.yml | 3 +- .../@azure/msal-common/LogLevel.yml | 1 - .../@azure/msal-common/Logger.yml | 41 +- .../msal-common/LoggerMessageOptions.yml | 16 - .../@azure/msal-common/LoggerOptions.yml | 19 +- .../@azure/msal-common/NativeRequest.yml | 27 + .../msal-common/NativeSignOutRequest.yml | 14 + .../{JoseHeaderError.yml => NetworkError.yml} | 205 +-- .../@azure/msal-common/NetworkManager.yml | 58 - .../msal-common/NetworkRequestOptions.yml | 8 +- .../@azure/msal-common/NetworkResponse.yml | 7 +- .../@azure/msal-common/OIDCOptions.yml | 13 + .../@azure/msal-common/OnBehalfOfClient.yml | 100 -- .../msal-common/OpenIdConfigResponse.yml | 19 - .../msal-common/PasswordGrantConstants.yml | 17 +- .../PerformanceCallbackFunction.yml | 1 - .../@azure/msal-common/PerformanceClient.yml | 212 ++- .../@azure/msal-common/PerformanceEvent.yml | 102 +- .../msal-common/PerformanceEventStatus.yml | 1 - .../@azure/msal-common/PerformanceEvents.yml | 334 +++- .../msal-common/PersistentCacheKeys.yml | 37 +- .../@azure/msal-common/PkceCodes.yml | 3 +- .../@azure/msal-common/PopTokenGenerator.yml | 117 -- .../@azure/msal-common/PreQueueEvent.yml | 34 + .../@azure/msal-common/ProtocolMode.yml | 16 +- .../@azure/msal-common/ProtocolUtils.yml | 22 +- .../@azure/msal-common/QueueMeasurement.yml | 14 + .../@azure/msal-common/RefreshTokenCache.yml | 11 - .../@azure/msal-common/RefreshTokenClient.yml | 123 -- .../@azure/msal-common/RefreshTokenEntity.yml | 420 +---- .../@azure/msal-common/RegionDiscovery.yml | 50 - .../msal-common/RegionDiscoveryMetadata.yml | 15 - .../msal-common/RegionDiscoveryOutcomes.yml | 31 - .../msal-common/RegionDiscoverySources.yml | 26 - .../@azure/msal-common/ReqCnf.yml | 20 - .../@azure/msal-common/ReqCnfData.yml | 11 - .../msal-common/RequestParameterBuilder.yml | 618 -------- .../@azure/msal-common/RequestStateObject.yml | 5 +- .../@azure/msal-common/RequestThumbprint.yml | 23 +- .../@azure/msal-common/RequestValidator.yml | 108 -- .../@azure/msal-common/ResponseCodes.yml | 20 - .../@azure/msal-common/ResponseHandler.yml | 189 --- .../@azure/msal-common/ResponseMode.yml | 20 +- .../@azure/msal-common/SSOTypes.yml | 46 - .../@azure/msal-common/ScopeSet.yml | 68 +- .../@azure/msal-common/Separators.yml | 18 - .../ServerAuthorizationCodeResponse.yml | 28 +- .../ServerAuthorizationTokenResponse.yml | 48 +- .../msal-common/ServerDeviceCodeResponse.yml | 13 +- .../@azure/msal-common/ServerError.yml | 135 +- .../@azure/msal-common/ServerResponseType.yml | 11 + .../msal-common/ServerTelemetryEntity.yml | 84 +- .../msal-common/ServerTelemetryManager.yml | 163 -- .../msal-common/ServerTelemetryRequest.yml | 13 +- .../@azure/msal-common/ShrOptions.yml | 10 + .../@azure/msal-common/SignedHttpRequest.yml | 19 +- .../SignedHttpRequestParameters.yml | 7 +- .../@azure/msal-common/SilentFlowClient.yml | 126 -- .../msal-common/StaticAuthorityOptions.yml | 15 + .../@azure/msal-common/StaticFields.yml | 33 - .../@azure/msal-common/StoreInCache.yml | 17 + .../@azure/msal-common/StringDict.yml | 6 +- .../msal-common/StubPerformanceClient.yml | 246 +-- .../StubPerformanceMeasurement.yml | 41 - .../@azure/msal-common/SubMeasurement.yml | 10 + .../@azure/msal-common/SystemOptions.yml | 9 +- .../@azure/msal-common/TelemetryOptions.yml | 11 - .../@azure/msal-common/TenantProfile.yml | 13 + .../@azure/msal-common/ThrottlingEntity.yml | 101 +- .../@azure/msal-common/ThrottlingUtils.yml | 166 -- .../@azure/msal-common/TimeUtils.yml | 70 +- .../@azure/msal-common/TokenCacheContext.yml | 8 +- .../@azure/msal-common/TokenClaims.yml | 63 +- .../@azure/msal-common/TokenKeys.yml | 14 + .../@azure/msal-common/UrlString.yml | 122 +- .../@azure/msal-common/UrlUtils.yml | 43 + .../msal-common/UsernamePasswordClient.yml | 108 -- .../@azure/msal-common/ValidCacheType.yml | 20 - .../msal-common/ValidCredentialType.yml | 14 - .../@azure/msal-common/index.yml | 600 ++++--- .../@azure/msal-node/AccountInfo.yml | 51 + .../@azure/msal-node/ApiId.yml | 50 - .../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 | 10 +- .../msal-node/AuthorizationUrlRequest.yml | 5 +- .../@azure/msal-node/AzureCloudInstance.yml | 11 + .../@azure/msal-node/AzureCloudOptions.yml | 20 + .../@azure/msal-node/BrokerOptions.yml | 18 + .../@azure/msal-node/CacheKVStore.yml | 1 - .../@azure/msal-node/CacheOptions.yml | 7 +- .../@azure/msal-node/ClientApplication.yml | 60 +- .../@azure/msal-node/ClientAssertion.yml | 59 +- .../msal-node/ClientAssertionCallback.yml | 12 + .../@azure/msal-node/ClientAuthError.yml | 201 +++ .../@azure/msal-node/ClientAuthErrorCodes.yml | 6 + .../msal-node/ClientConfigurationError.yml | 198 +++ .../ClientConfigurationErrorCodes.yml | 6 + .../msal-node/ClientCredentialClient.yml | 190 +++ .../msal-node/ClientCredentialRequest.yml | 17 +- .../ConfidentialClientApplication.yml | 88 +- .../@azure/msal-node/Configuration.yml | 15 +- .../@azure/msal-node/CryptoProvider.yml | 50 +- .../@azure/msal-node/Deserializer.yml | 151 -- .../@azure/msal-node/DeviceCodeClient.yml | 163 ++ .../@azure/msal-node/DeviceCodeRequest.yml | 9 +- .../msal-node/DistributedCachePlugin.yml | 22 +- .../@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/IAppTokenProvider.yml | 9 + .../@azure/msal-node/ICacheClient.yml | 13 +- .../@azure/msal-node/ICachePlugin.yml | 38 + .../IConfidentialClientApplication.yml | 56 +- ...LoopbackClient.yml => ILoopbackClient.yml} | 36 +- .../@azure/msal-node/INativeBrokerPlugin.yml | 127 ++ .../@azure/msal-node/INetworkModule.yml | 61 + .../@azure/msal-node/IPartitionManager.yml | 23 +- .../msal-node/IPublicClientApplication.yml | 71 +- .../msal-node/ISerializableTokenCache.yml | 34 + .../@azure/msal-node/ITokenCache.yml | 23 +- .../@azure/msal-node/IdTokenClaims.yml | 44 + .../@azure/msal-node/InMemoryCache.yml | 11 +- .../InteractionRequiredAuthError.yml | 290 ++++ .../InteractionRequiredAuthErrorCodes.yml | 6 + .../@azure/msal-node/InteractiveRequest.yml | 50 +- .../@azure/msal-node/JsonCache.yml | 11 +- .../@azure/msal-node/LogLevel.yml | 34 + .../@azure/msal-node/Logger.yml | 235 +++ .../msal-node/ManagedIdentityApplication.yml | 55 + .../ManagedIdentityConfiguration.yml | 13 + .../msal-node/ManagedIdentityIdParams.yml | 14 + .../ManagedIdentityRequestParams.yml | 26 + .../msal-node/ManagedIdentitySourceNames.yml | 11 + .../msal-node/NetworkRequestOptions.yml | 11 + .../@azure/msal-node/NetworkResponse.yml | 14 + .../@azure/msal-node/NetworkUtils.yml | 35 - .../@azure/msal-node/NodeAuthError.yml | 270 ---- .../@azure/msal-node/NodeAuthOptions.yml | 46 +- .../@azure/msal-node/NodeConfiguration.yml | 16 - .../@azure/msal-node/NodeStorage.yml | 1001 ------------ .../@azure/msal-node/NodeSystemOptions.yml | 10 +- .../@azure/msal-node/NodeTelemetryOptions.yml | 1 - .../@azure/msal-node/OnBehalfOfClient.yml | 142 ++ .../@azure/msal-node/OnBehalfOfRequest.yml | 7 +- .../@azure/msal-node/PkceGenerator.yml | 37 - .../@azure/msal-node/ProtocolMode.yml | 10 + .../@azure/msal-node/ProxyStatus.yml | 25 - .../msal-node/PublicClientApplication.yml | 158 +- .../@azure/msal-node/RefreshTokenRequest.yml | 4 +- .../@azure/msal-node/ResponseMode.yml | 10 + .../msal-node/SerializedAccessTokenEntity.yml | 32 +- .../msal-node/SerializedAccountEntity.yml | 22 +- .../msal-node/SerializedAppMetadataEntity.yml | 7 +- .../msal-node/SerializedIdTokenEntity.yml | 13 +- .../SerializedRefreshTokenEntity.yml | 17 +- .../@azure/msal-node/Serializer.yml | 149 -- .../ServerAuthorizationCodeResponse.yml | 33 + .../@azure/msal-node/ServerError.yml | 239 +++ .../@azure/msal-node/SignOutRequest.yml | 10 + .../@azure/msal-node/SilentFlowRequest.yml | 11 +- .../@azure/msal-node/TokenCache.yml | 80 +- .../@azure/msal-node/TokenCacheContext.yml | 78 + .../msal-node/UsernamePasswordClient.yml | 151 ++ .../msal-node/UsernamePasswordRequest.yml | 8 +- .../@azure/msal-node/index.yml | 145 +- .../@azure/msal-node/internals.yml | 6 + .../@azure/msal-react/AccountIdentifiers.yml | 1 - .../msal-react/AuthenticatedTemplateProps.yml | 1 - .../@azure/msal-react/FaaCFunction.yml | 11 - .../@azure/msal-react/IMsalContext.yml | 13 +- .../msal-react/MsalAuthenticationProps.yml | 9 +- .../msal-react/MsalAuthenticationResult.yml | 15 +- .../@azure/msal-react/MsalProviderProps.yml | 3 +- .../@azure/msal-react/ReactAuthError.yml | 206 --- .../@azure/msal-react/SetComplement.yml | 3 +- .../@azure/msal-react/SetDifference.yml | 5 +- .../@azure/msal-react/Subtract.yml | 5 +- .../UnauthenticatedTemplateProps.yml | 1 - .../@azure/msal-react/WithMsalProps.yml | 1 - .../@azure/msal-react/index.yml | 262 ++-- .../docs-ref-autogen/@azure/msal/API_CODE.yml | 40 - .../@azure/msal/API_EVENT_IDENTIFIER.yml | 34 - msal/docs-ref-autogen/@azure/msal/Account.yml | 180 --- .../docs-ref-autogen/@azure/msal/ApiEvent.yml | 285 ---- .../@azure/msal/AuthError.yml | 144 -- .../@azure/msal/AuthOptions.yml | 20 - .../@azure/msal/AuthResponse.yml | 23 - .../@azure/msal/AuthenticationParameters.yml | 28 - .../@azure/msal/AuthorityFactory.yml | 100 -- .../@azure/msal/CacheLocation.yml | 14 - .../@azure/msal/CacheOptions.yml | 22 - .../@azure/msal/ClientAuthError.yml | 479 ------ .../@azure/msal/ClientConfigurationError.yml | 813 ---------- .../@azure/msal/CompletedEvents.yml | 10 - .../@azure/msal/Configuration.yml | 31 - .../@azure/msal/DefaultEvent.yml | 157 -- .../@azure/msal/ErrorCacheKeys.yml | 22 - .../@azure/msal/EventCount.yml | 10 - .../@azure/msal/EventCountByCorrelationId.yml | 10 - .../@azure/msal/FrameworkOptions.yml | 32 - .../@azure/msal/HttpEvent.yml | 312 ---- .../msal/IClientConfigurationErrorMessage.yml | 37 - .../@azure/msal/InProgressEvents.yml | 10 - .../msal/InteractionRequiredAuthError.yml | 252 --- .../@azure/msal/InteractionType.yml | 14 - .../@azure/msal/LibraryStateObject.yml | 11 - .../docs-ref-autogen/@azure/msal/LogLevel.yml | 30 - msal/docs-ref-autogen/@azure/msal/Logger.yml | 46 - .../@azure/msal/NetworkInformation.yml | 24 - .../@azure/msal/OpenIdConfiguration.yml | 15 - .../@azure/msal/PersistentCacheKeys.yml | 18 - .../docs-ref-autogen/@azure/msal/ScopeSet.yml | 146 -- .../@azure/msal/ServerError.yml | 173 --- .../@azure/msal/ServerHashParamKeys.yml | 46 - .../@azure/msal/StringDict.yml | 10 - .../@azure/msal/SystemOptions.yml | 30 - .../@azure/msal/TelemetryConfig.yml | 50 - .../@azure/msal/TelemetryEmitter.yml | 11 - .../@azure/msal/TelemetryEvent.yml | 129 -- .../@azure/msal/TelemetryManager.yml | 165 -- .../@azure/msal/TelemetryOptions.yml | 23 - .../@azure/msal/TelemetryPlatform.yml | 76 - .../@azure/msal/TrustedAuthority.yml | 85 - .../@azure/msal/UserAgentApplication.yml | 318 ---- .../@azure/msal/WindowUtils.yml | 34 - .../@azure/msal/XhrResponse.yml | 11 - .../@azure/msal/authResponseCallback.yml | 16 - .../@azure/msal/errorReceivedCallback.yml | 14 - msal/docs-ref-autogen/@azure/msal/index.yml | 150 -- .../@azure/msal/tokenReceivedCallback.yml | 13 - msal/docs-ref-autogen/toc.yml | 976 +++++++----- 512 files changed, 13290 insertions(+), 29115 deletions(-) delete mode 100644 msal/docs-ref-autogen/@azure/msal-angular/MatchingResources.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AccountInfo.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AsyncMemoryStorage.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/AzureCloudInstance.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/AzureCloudOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/Base64Decode.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/Base64Encode.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthErrorCodes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserConfiguration.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthErrorCodes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserCrypto.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserProtocolUtils.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserStateObject.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserStorage.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/BrowserStringUtils.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/CachedKeyPair.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 delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/CryptoKeyStore.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/CryptoKeyStoreNames.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/CryptoOps.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/CryptoOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/DatabaseStorage.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/FetchClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/GuidGenerator.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/HTTP_REQUEST_TYPE.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/HybridSpaAuthorizationCodeClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/IAsyncStorage.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/IController.yml rename msal/docs-ref-autogen/@azure/{msal => msal-browser}/ILoggerCallback.yml (63%) create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/IPerformanceClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ISubtleCrypto.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/IdTokenClaims.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InMemoryCacheKeys.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InProgressPerformanceEvent.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InitializeApplicationRequest.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InteractionHandler.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/InteractionParams.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/JsonWebTokenTypes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.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 delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/MATS.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/MathUtils.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ModernBrowserCrypto.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/MsBrowserCrypto.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/MsrBrowserCrypto.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeAccountInfo.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeAuthError.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionMethod.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequest.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequestBody.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeMessageHandler.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeResponse.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeResponseProperties.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeStatusCode.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/NativeTokenRequest.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 delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/OSError.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 delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PkceGenerator.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PopupClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/PopupParams.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/ProtocolMode.yml rename msal/docs-ref-autogen/@azure/msal-browser/{ClientApplication.yml => PublicClientNext.yml} (51%) delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/RedirectHandler.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/RedirectParams.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/SessionStorage.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SilentHandler.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/StubPerformanceClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/TemporaryCacheKeys.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/TenantProfile.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/TokenCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-browser/UrlString.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-browser/XhrClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/AccessTokenCache.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/AccountCache.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/AccountEntity.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/AppMetadataCache.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/AppMetadataFilter.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthErrorCodes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/Authority.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthorityMetadataEntity.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthorityMetadataSource.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodeClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/BaseClient.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 delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheManager.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheRecord.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml 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-common/ClientAuthErrorCodes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationErrorCodes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientCredentialClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ClientCredentials.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/CloudDiscoveryMetadata.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/CloudInstanceDiscoveryResponse.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/CredentialCache.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/DecodedAuthToken.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/DeviceCodeClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/HttpStatus.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ICacheManager.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/IMDSBadResponse.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/INativeBrokerPlugin.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/IdTokenCache.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ImdsOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthErrorCodes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/JoseHeader.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/JoseHeaderOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/JsonTypes.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/JsonWebTokenTypes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/KeyLocation.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/LibraryInfo.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/LoggerMessageOptions.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 rename msal/docs-ref-autogen/@azure/msal-common/{JoseHeaderError.yml => NetworkError.yml} (52%) delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/NetworkManager.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/OIDCOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/OnBehalfOfClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/OpenIdConfigResponse.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/PopTokenGenerator.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/PreQueueEvent.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/QueueMeasurement.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/RefreshTokenCache.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/RefreshTokenClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/RegionDiscovery.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/RegionDiscoveryMetadata.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/RegionDiscoveryOutcomes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/RegionDiscoverySources.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ReqCnf.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ReqCnfData.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/RequestValidator.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ResponseCodes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ResponseHandler.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/SSOTypes.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/Separators.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ServerResponseType.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryManager.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/ShrOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/SilentFlowClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/StaticAuthorityOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/StaticFields.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/StoreInCache.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/StubPerformanceMeasurement.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/SubMeasurement.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/TelemetryOptions.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/TenantProfile.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/TokenKeys.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-common/UrlUtils.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/UsernamePasswordClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ValidCacheType.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-common/ValidCredentialType.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/AccountInfo.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/ApiId.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/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/ClientAssertionCallback.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 delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/Deserializer.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/EncodingUtils.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/GuidGenerator.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/HashUtils.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/HttpClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/HttpMethod.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/HttpStatus.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/IAppTokenProvider.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ICachePlugin.yml rename msal/docs-ref-autogen/@azure/msal-node/{LoopbackClient.yml => ILoopbackClient.yml} (56%) 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/ISerializableTokenCache.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/IdTokenClaims.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/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/ManagedIdentitySourceNames.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 delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/NetworkUtils.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/NodeAuthError.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/NodeConfiguration.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/PkceGenerator.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ProtocolMode.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/ProxyStatus.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/ResponseMode.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-node/Serializer.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/TokenCacheContext.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml create mode 100644 msal/docs-ref-autogen/@azure/msal-node/internals.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-react/FaaCFunction.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal-react/ReactAuthError.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/API_CODE.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/API_EVENT_IDENTIFIER.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/Account.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/ApiEvent.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/AuthError.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/AuthOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/AuthResponse.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/AuthenticationParameters.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/AuthorityFactory.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/CacheLocation.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/CacheOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/ClientAuthError.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/ClientConfigurationError.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/CompletedEvents.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/Configuration.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/DefaultEvent.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/ErrorCacheKeys.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/EventCount.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/EventCountByCorrelationId.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/FrameworkOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/HttpEvent.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/IClientConfigurationErrorMessage.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/InProgressEvents.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/InteractionRequiredAuthError.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/InteractionType.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/LibraryStateObject.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/LogLevel.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/Logger.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/NetworkInformation.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/OpenIdConfiguration.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/PersistentCacheKeys.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/ScopeSet.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/ServerError.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/ServerHashParamKeys.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/StringDict.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/SystemOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/TelemetryConfig.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/TelemetryEmitter.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/TelemetryEvent.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/TelemetryManager.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/TelemetryOptions.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/TelemetryPlatform.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/TrustedAuthority.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/UserAgentApplication.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/WindowUtils.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/XhrResponse.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/authResponseCallback.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/errorReceivedCallback.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/index.yml delete mode 100644 msal/docs-ref-autogen/@azure/msal/tokenReceivedCallback.yml diff --git a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml index fca58de..28682bb 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml +++ b/msal/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: >- @@ -22,17 +20,18 @@ methods: Observable parameters: - id: request - type: PopupRequest + type: description: '' return: description: '' - type: Observable<AuthenticationResult> + type: >- + Observable<> - name: acquireTokenRedirect(RedirectRequest) uid: '@azure/msal-angular.IMsalService.acquireTokenRedirect' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -40,7 +39,7 @@ methods: Observable parameters: - id: request - type: RedirectRequest + type: description: '' return: description: '' @@ -50,7 +49,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -58,43 +56,44 @@ methods: Observable parameters: - id: silentRequest - type: SilentRequest + type: description: '' return: description: '' - type: Observable<AuthenticationResult> + type: >- + Observable<> - name: getLogger() uid: '@azure/msal-angular.IMsalService.getLogger' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' return: description: '' - type: Logger + type: - name: handleRedirectObservable() uid: '@azure/msal-angular.IMsalService.handleRedirectObservable' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function handleRedirectObservable(): Observable + function handleRedirectObservable(): Observable return: description: '' - type: Observable<AuthenticationResult | null> + type: >- + Observable<null | > - name: initialize() uid: '@azure/msal-angular.IMsalService.initialize' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(): Observable' @@ -106,7 +105,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -114,23 +112,24 @@ methods: Observable parameters: - id: request - type: PopupRequest + type: description: '' return: description: '' - type: Observable<AuthenticationResult> + type: >- + Observable<> - name: loginRedirect(RedirectRequest) uid: '@azure/msal-angular.IMsalService.loginRedirect' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loginRedirect(request?: RedirectRequest): Observable' parameters: - id: request - type: RedirectRequest + type: description: '' return: description: '' @@ -140,13 +139,12 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(logoutRequest?: EndSessionRequest): Observable' parameters: - id: logoutRequest - type: EndSessionRequest + type: description: '' return: description: '' @@ -156,20 +154,18 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' parameters: - id: logger - type: Logger + type: description: '' - name: ssoSilent(AuthorizationUrlRequest) uid: '@azure/msal-angular.IMsalService.ssoSilent' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -177,8 +173,10 @@ methods: Observable parameters: - id: request - type: AuthorizationUrlRequest + type: description: '' return: description: '' - type: Observable<AuthenticationResult> + type: >- + Observable<> diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MatchingResources.yml b/msal/docs-ref-autogen/@azure/msal-angular/MatchingResources.yml deleted file mode 100644 index 9eea32e..0000000 --- a/msal/docs-ref-autogen/@azure/msal-angular/MatchingResources.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: MatchingResources -uid: '@azure/msal-angular.MatchingResources' -package: '@azure/msal-angular' -summary: '' -fullName: MatchingResources -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type MatchingResources = { - absoluteResources: Array, - relativeResources: Array, - } diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml index 11f2a69..4c7da1d 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastConfiguration.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml index 6719dcb..4e34cc5 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalBroadcastService.yml +++ b/msal/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: >- @@ -25,7 +23,7 @@ constructors: MsalBroadcastConfiguration) parameters: - id: msalInstance - type: IPublicClientApplication + type: description: '' - id: authService type: @@ -40,23 +38,52 @@ properties: summary: '' fullName: inProgress$ remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inProgress$: Observable' return: description: '' - type: Observable<InteractionStatus> + type: Observable<> - name: msalSubject$ uid: '@azure/msal-angular.MsalBroadcastService.msalSubject$' package: '@azure/msal-angular' summary: '' fullName: msalSubject$ remarks: '' - isPreview: false isDeprecated: false syntax: content: 'msalSubject$: Observable' return: description: '' - type: Observable<EventMessage> + 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 index 8c28d58..3fdbd26 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalCustomNavigationClient.yml @@ -4,18 +4,20 @@ 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: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'MsalCustomNavigationClient(MsalService, Router, Location)' + - name: MsalCustomNavigationClient(MsalService, Router, Location) uid: '@azure/msal-angular.MsalCustomNavigationClient.constructor' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -31,15 +33,43 @@ constructors: - 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)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -50,20 +80,18 @@ inheritedMethods: type: string description: '' - id: options - type: NavigationOptions - description: |+ - + type: + description: '' return: description: '' type: Promise<boolean> inheritanceDescription: Inherited From NavigationClient.navigateExternal methods: - - name: 'navigateInternal(string, NavigationOptions)' + - name: navigateInternal(string, NavigationOptions) uid: '@azure/msal-angular.MsalCustomNavigationClient.navigateInternal' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -74,9 +102,9 @@ methods: type: string description: '' - id: options - type: NavigationOptions + type: description: '' return: description: '' type: Promise<boolean> -extends: NavigationClient +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml index 826c27a..69bc73c 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalGuard.yml +++ b/msal/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: >- @@ -39,18 +37,46 @@ constructors: - 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)' + - name: canActivate(ActivatedRouteSnapshot, RouterStateSnapshot) uid: '@azure/msal-angular.MsalGuard.canActivate' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function canActivate(route: ActivatedRouteSnapshot, state: - RouterStateSnapshot): Observable + RouterStateSnapshot): Observable parameters: - id: route type: ActivatedRouteSnapshot @@ -60,18 +86,17 @@ methods: description: '' return: description: '' - type: Observable<boolean | UrlTree> - - name: 'canActivateChild(ActivatedRouteSnapshot, RouterStateSnapshot)' + type: Observable<any> + - name: canActivateChild(ActivatedRouteSnapshot, RouterStateSnapshot) uid: '@azure/msal-angular.MsalGuard.canActivateChild' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function canActivateChild(route: ActivatedRouteSnapshot, state: - RouterStateSnapshot): Observable + RouterStateSnapshot): Observable parameters: - id: route type: ActivatedRouteSnapshot @@ -81,25 +106,23 @@ methods: description: '' return: description: '' - type: Observable<boolean | UrlTree> - - name: canLoad() - uid: '@azure/msal-angular.MsalGuard.canLoad' + type: Observable<any> + - name: canMatch() + uid: '@azure/msal-angular.MsalGuard.canMatch' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function canLoad(): Observable' + content: 'function canMatch(): Observable' return: description: '' - type: Observable<boolean> + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function getDestinationUrl(path: string): string' @@ -115,7 +138,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function includesCode(path: string): boolean' @@ -131,15 +153,13 @@ methods: package: '@azure/msal-angular' summary: Parses url string to UrlTree remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function parseUrl(url: string): UrlTree' parameters: - id: url type: string - description: |+ - + 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 index e191174..031d3d9 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardAuthRequest.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml index ff6ab62..0dbc490 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalGuardConfiguration.yml @@ -5,16 +5,9 @@ package: '@azure/msal-angular' summary: '' fullName: MsalGuardConfiguration remarks: '' -isPreview: false isDeprecated: false -syntax: | - type MsalGuardConfiguration = { - authRequest?: - | MsalGuardAuthRequest - | (( - authService: MsalService, - state: RouterStateSnapshot - ) => MsalGuardAuthRequest), - interactionType: Popup | Redirect, - loginFailedRoute?: string, - } +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 index 7f14e4f..c4759cf 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptor.yml +++ b/msal/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,16 +31,47 @@ constructors: - 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)' + - name: intercept(HttpRequest, HttpHandler) uid: '@azure/msal-angular.MsalInterceptor.intercept' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml index a82f4ef..8798d07 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorAuthRequest.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml index abd57b0..3759b74 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalInterceptorConfiguration.yml @@ -5,20 +5,10 @@ package: '@azure/msal-angular' summary: '' fullName: MsalInterceptorConfiguration remarks: '' -isPreview: false isDeprecated: false -syntax: | - type MsalInterceptorConfiguration = { - authRequest?: - | MsalInterceptorAuthRequest - | (( - msalService: MsalService, - req: HttpRequest, - originalAuthRequest: MsalInterceptorAuthRequest - ) => MsalInterceptorAuthRequest), - interactionType: Popup | Redirect, - protectedResourceMap: Map< - string, - Array | null - >, - } +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 index db129ea..9159656 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalModule.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalModule.yml @@ -5,9 +5,53 @@ package: '@azure/msal-angular' summary: '' fullName: MsalModule remarks: '' -isPreview: false 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, @@ -16,7 +60,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -25,7 +68,7 @@ methods: MsalInterceptorConfiguration): ModuleWithProviders parameters: - id: msalInstance - type: IPublicClientApplication + type: description: '' - id: guardConfig type: diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml index b16e65a..7e4bffe 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalRedirectComponent.yml +++ b/msal/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)' @@ -22,13 +20,44 @@ constructors: - 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: '' - isPreview: false 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 index 99343c1..a362598 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml @@ -5,22 +5,20 @@ package: '@azure/msal-angular' summary: '' fullName: MsalService remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'MsalService(IPublicClientApplication, Location)' + - name: MsalService(IPublicClientApplication, Location) uid: '@azure/msal-angular.MsalService.constructor' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new MsalService(instance: IPublicClientApplication, location: Location)' parameters: - id: instance - type: IPublicClientApplication + type: description: '' - id: location type: Location @@ -32,20 +30,46 @@ properties: summary: '' fullName: instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'instance: IPublicClientApplication' return: description: '' - type: IPublicClientApplication + 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -53,17 +77,18 @@ methods: Observable parameters: - id: request - type: PopupRequest + type: description: '' return: description: '' - type: Observable<AuthenticationResult> + type: >- + Observable<> - name: acquireTokenRedirect(RedirectRequest) uid: '@azure/msal-angular.MsalService.acquireTokenRedirect' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -71,7 +96,7 @@ methods: Observable parameters: - id: request - type: RedirectRequest + type: description: '' return: description: '' @@ -81,7 +106,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -89,11 +113,13 @@ methods: Observable parameters: - id: silentRequest - type: SilentRequest + type: description: '' return: description: '' - type: Observable<AuthenticationResult> + type: >- + Observable<> - name: getLogger() uid: '@azure/msal-angular.MsalService.getLogger' package: '@azure/msal-angular' @@ -103,19 +129,17 @@ 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' return: description: '' - type: Logger + type: - name: handleRedirectObservable(string) uid: '@azure/msal-angular.MsalService.handleRedirectObservable' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -127,13 +151,14 @@ methods: description: '' return: description: '' - type: Observable<AuthenticationResult> + type: >- + Observable<> - name: initialize() uid: '@azure/msal-angular.MsalService.initialize' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(): Observable' @@ -145,7 +170,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -153,23 +177,24 @@ methods: Observable parameters: - id: request - type: PopupRequest + type: description: '' return: description: '' - type: Observable<AuthenticationResult> + type: >- + Observable<> - name: loginRedirect(RedirectRequest) uid: '@azure/msal-angular.MsalService.loginRedirect' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loginRedirect(request?: RedirectRequest): Observable' parameters: - id: request - type: RedirectRequest + type: description: '' return: description: '' @@ -179,13 +204,12 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(logoutRequest?: EndSessionRequest): Observable' parameters: - id: logoutRequest - type: EndSessionRequest + type: description: '' return: description: '' @@ -195,7 +219,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -203,7 +226,7 @@ methods: Observable parameters: - id: logoutRequest - type: EndSessionPopupRequest + type: description: '' return: description: '' @@ -213,7 +236,6 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -221,7 +243,7 @@ methods: Observable parameters: - id: logoutRequest - type: EndSessionRequest + type: description: '' return: description: '' @@ -231,29 +253,38 @@ methods: package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' parameters: - id: logger - type: Logger + type: description: '' - - name: ssoSilent(SsoSilentRequest) + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-angular.MsalService.ssoSilent' package: '@azure/msal-angular' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function ssoSilent(request: SsoSilentRequest): + function ssoSilent(request: Partial>): Observable parameters: - id: request - type: SsoSilentRequest + type: >- + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' return: description: '' - type: Observable<AuthenticationResult> + type: >- + Observable<> diff --git a/msal/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml b/msal/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml index 113c68c..2de6b17 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/ProtectedResourceScopes.yml @@ -5,7 +5,6 @@ package: '@azure/msal-angular' summary: '' fullName: ProtectedResourceScopes remarks: '' -isPreview: false isDeprecated: false syntax: | - type ProtectedResourceScopes = { httpMethod: string, scopes: Array } + 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 index 65ec4d4..beea1d0 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/index.yml @@ -3,21 +3,20 @@ 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.MatchingResources' - '@azure/msal-angular.MsalInterceptorAuthRequest' - '@azure/msal-angular.MsalInterceptorConfiguration' - '@azure/msal-angular.ProtectedResourceScopes' -classes: - - '@azure/msal-angular.MsalBroadcastService' - - '@azure/msal-angular.MsalGuard' - - '@azure/msal-angular.MsalInterceptor' - - '@azure/msal-angular.MsalModule' - - '@azure/msal-angular.MsalCustomNavigationClient' - - '@azure/msal-angular.MsalRedirectComponent' - - '@azure/msal-angular.MsalService' 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 index 7af7853..c7b72bd 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ApiId.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ApiId.yml @@ -1,63 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: ApiId uid: '@azure/msal-browser.ApiId' package: '@azure/msal-browser' -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 - - 800-899 Auth Code Flow +summary: '' fullName: ApiId remarks: '' -isPreview: false isDeprecated: false -fields: - - name: acquireTokenSilent_silentFlow - uid: '@azure/msal-browser.ApiId.acquireTokenSilent_silentFlow' - package: '@azure/msal-browser' - summary: '' - numericValue: 61 - - name: acquireTokenRedirect - uid: '@azure/msal-browser.ApiId.acquireTokenRedirect' - package: '@azure/msal-browser' - summary: '' - numericValue: 861 - - name: acquireTokenPopup - uid: '@azure/msal-browser.ApiId.acquireTokenPopup' - package: '@azure/msal-browser' - summary: '' - numericValue: 862 - - name: ssoSilent - uid: '@azure/msal-browser.ApiId.ssoSilent' - package: '@azure/msal-browser' - summary: '' - numericValue: 863 - - name: acquireTokenSilent_authCode - uid: '@azure/msal-browser.ApiId.acquireTokenSilent_authCode' - package: '@azure/msal-browser' - summary: '' - numericValue: 864 - - name: handleRedirectPromise - uid: '@azure/msal-browser.ApiId.handleRedirectPromise' - package: '@azure/msal-browser' - summary: '' - numericValue: 865 - - name: acquireTokenByCode - uid: '@azure/msal-browser.ApiId.acquireTokenByCode' - package: '@azure/msal-browser' - summary: '' - numericValue: 866 - - name: logout - uid: '@azure/msal-browser.ApiId.logout' - package: '@azure/msal-browser' - summary: '' - numericValue: 961 - - name: logoutPopup - uid: '@azure/msal-browser.ApiId.logoutPopup' - package: '@azure/msal-browser' - summary: '' - numericValue: 962 +syntax: | + type ApiId = (typeof ApiId)[keyof typeof ApiId] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/AsyncMemoryStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/AsyncMemoryStorage.yml deleted file mode 100644 index a5521f2..0000000 --- a/msal/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/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 index 3030157..0e68dcf 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/AuthorizationCodeRequest.yml +++ b/msal/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< @@ -14,9 +13,9 @@ syntax: | "code" | "enableSpaAuthorizationCode" | "requestedClaimsHash" > > & { - cloudGraphHostName?: string, - cloudInstanceHostName?: string, - code?: string, - msGraphHost?: string, - nativeAccountId?: string, + 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 index 6781ee6..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: '' -isPreview: false isDeprecated: false syntax: | type AuthorizationUrlRequest = Omit< CommonAuthorizationUrlRequest, - "state" | "nonce" | "requestedClaimsHash" | "nativeBroker" - > & { nonce: string, state: string } + "state" | "nonce" | "requestedClaimsHash" | "platformBroker" + > & { 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/Base64Decode.yml b/msal/docs-ref-autogen/@azure/msal-browser/Base64Decode.yml deleted file mode 100644 index 2beecb4..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/Base64Encode.yml b/msal/docs-ref-autogen/@azure/msal-browser/Base64Encode.yml deleted file mode 100644 index 3b0c3fb..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml deleted file mode 100644 index 86f3c3d..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/BaseInteractionClient.yml +++ /dev/null @@ -1,110 +0,0 @@ -### YamlMime:TSType -name: BaseInteractionClient -uid: '@azure/msal-browser.BaseInteractionClient' -package: '@azure/msal-browser' -summary: '' -fullName: BaseInteractionClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - BaseInteractionClient(BrowserConfiguration, BrowserCacheManager, ICrypto, - Logger, EventHandler, INavigationClient, IPerformanceClient, - NativeMessageHandler, string) - uid: '@azure/msal-browser.BaseInteractionClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new BaseInteractionClient(config: BrowserConfiguration, storageImpl: - BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, - eventHandler: EventHandler, navigationClient: INavigationClient, - performanceClient: IPerformanceClient, nativeMessageHandler?: - NativeMessageHandler, correlationId?: string) - parameters: - - id: config - type: - description: '' - - id: storageImpl - type: - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' - - id: eventHandler - type: - description: '' - - id: navigationClient - type: - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: nativeMessageHandler - type: - description: '' - - id: correlationId - type: string - description: '' -methods: - - name: acquireToken(RedirectRequest | PopupRequest | SsoSilentRequest) - uid: '@azure/msal-browser.BaseInteractionClient.acquireToken' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: RedirectRequest | PopupRequest | - SsoSilentRequest): Promise - parameters: - - id: request - type: >- - | | - description: '' - return: - description: '' - type: Promise<AuthenticationResult | void> - - name: getRedirectUri(string) - uid: '@azure/msal-browser.BaseInteractionClient.getRedirectUri' - 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' - parameters: - - id: requestRedirectUri - type: string - description: '' - return: - description: Redirect URL - type: string - - name: logout(EndSessionRequest) - uid: '@azure/msal-browser.BaseInteractionClient.logout' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(request: EndSessionRequest): Promise' - parameters: - - id: request - type: - description: '' - return: - description: '' - type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml index ac34697..9476c1c 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthError.yml @@ -5,24 +5,22 @@ 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: - - name: 'BrowserAuthError(string, string)' + - name: BrowserAuthError(string, string) uid: '@azure/msal-browser.BrowserAuthError.constructor' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new BrowserAuthError(errorCode: string, errorMessage?: string)' + content: 'new BrowserAuthError(errorCode: string, subError?: string)' parameters: - id: errorCode type: string description: '' - - id: errorMessage + - id: subError type: string description: '' inheritedProperties: @@ -32,142 +30,164 @@ inheritedProperties: 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 + 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: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' return: description: '' type: string - inheritanceDescription: Inherited From AuthError.errorCode + 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: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' return: description: '' type: string - inheritanceDescription: Inherited From AuthError.errorMessage + 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: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.message + 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: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.name + 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: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.stack + 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: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' return: description: '' type: string - inheritanceDescription: Inherited From AuthError.subError + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-browser.AuthError.subError) inheritedMethods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-browser.BrowserAuthError.createPostRequestFailed' + - name: captureStackTrace(object, Function) + uid: '@azure/msal-browser.BrowserAuthError.captureStackTrace' package: '@azure/msal-browser' - summary: Creates an error for post request failures. + summary: Create .stack property on a target object remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) parameters: - - id: errDesc - type: string + - id: targetObject + type: object description: '' - return: - description: '' - type: AuthError - inheritanceDescription: Inherited From AuthError.createPostRequestFailed - - name: createUnexpectedError(string) - uid: '@azure/msal-browser.BrowserAuthError.createUnexpectedError' - package: '@azure/msal-browser' - 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 + - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -175,695 +195,7 @@ inheritedMethods: - id: correlationId type: string description: '' - inheritanceDescription: Inherited From AuthError.setCorrelationId -methods: - - name: createAuthCodeOrNativeAccountIdRequiredError() - uid: >- - @azure/msal-browser.BrowserAuthError.createAuthCodeOrNativeAccountIdRequiredError - package: '@azure/msal-browser' - summary: >- - Create an error when an authorization code or native account ID is - required but not provided - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createAuthCodeOrNativeAccountIdRequiredError(): - BrowserAuthError - return: - description: '' - type: - - name: createAuthCodeRequiredError() - uid: '@azure/msal-browser.BrowserAuthError.createAuthCodeRequiredError' - 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' - return: - description: '' - type: - - name: createAuthRequestNotSetError() - uid: '@azure/msal-browser.BrowserAuthError.createAuthRequestNotSetError' - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when handleCodeResponse is called before - initiateAuthRequest (InteractionHandler) - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createAuthRequestNotSetError(): BrowserAuthError' - return: - description: '' - type: - - name: createBlockAcquireTokenInPopupsError() - uid: '@azure/msal-browser.BrowserAuthError.createBlockAcquireTokenInPopupsError' - 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' - return: - description: '' - type: - - name: createBlockReloadInHiddenIframeError() - uid: '@azure/msal-browser.BrowserAuthError.createBlockReloadInHiddenIframeError' - 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' - return: - description: '' - type: - - name: createCryptoNotAvailableError(string) - uid: '@azure/msal-browser.BrowserAuthError.createCryptoNotAvailableError' - package: '@azure/msal-browser' - summary: Creates an error thrown when the crypto object is unavailable. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createCryptoNotAvailableError(errDetail: string): - BrowserAuthError - parameters: - - id: errDetail - type: string - description: |+ - - return: - description: '' - type: - - name: createDatabaseNotOpenError() - uid: '@azure/msal-browser.BrowserAuthError.createDatabaseNotOpenError' - 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' - return: - description: '' - type: - - name: createDatabaseUnavailableError() - uid: '@azure/msal-browser.BrowserAuthError.createDatabaseUnavailableError' - package: '@azure/msal-browser' - summary: Create an error when IndexedDB is unavailable - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createDatabaseUnavailableError(): BrowserAuthError' - return: - description: '' - type: - - name: createEmptyHashError(string) - uid: '@azure/msal-browser.BrowserAuthError.createEmptyHashError' - 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 createEmptyHashError(hashValue: string): - BrowserAuthError - parameters: - - id: hashValue - type: string - description: |+ - - return: - description: '' - type: - - name: createEmptyNavigationUriError() - uid: '@azure/msal-browser.BrowserAuthError.createEmptyNavigationUriError' - 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' - return: - description: '' - type: - - name: createEmptyWindowCreatedError() - uid: '@azure/msal-browser.BrowserAuthError.createEmptyWindowCreatedError' - 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' - return: - description: '' - type: - - name: createFailedToParseNetworkResponseError(string) - uid: >- - @azure/msal-browser.BrowserAuthError.createFailedToParseNetworkResponseError - package: '@azure/msal-browser' - summary: Create an error thrown when network client fails to parse network response - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createFailedToParseNetworkResponseError(endpoint: - string): BrowserAuthError - parameters: - - id: endpoint - type: string - description: '' - return: - description: '' - type: - - name: 'createGetRequestFailedError(string, string)' - uid: '@azure/msal-browser.BrowserAuthError.createGetRequestFailedError' - package: '@azure/msal-browser' - summary: >- - Create an error thrown when get request fails due to reasons other than - internet connectivity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createGetRequestFailedError(errorDesc: string, endpoint: - string): BrowserAuthError - parameters: - - id: errorDesc - type: string - description: '' - - id: endpoint - type: string - description: '' - return: - description: '' - type: - - name: createHashDoesNotContainKnownPropertiesError() - uid: >- - @azure/msal-browser.BrowserAuthError.createHashDoesNotContainKnownPropertiesError - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when the hash string value does not contain known - properties - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createHashDoesNotContainKnownPropertiesError(): - BrowserAuthError - return: - description: '' - type: - - name: createHashDoesNotContainStateError() - uid: '@azure/msal-browser.BrowserAuthError.createHashDoesNotContainStateError' - 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' - return: - description: '' - type: - - name: createHttpMethodNotImplementedError(string) - uid: '@azure/msal-browser.BrowserAuthError.createHttpMethodNotImplementedError' - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when an HTTP method hasn't been implemented by the - browser class. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createHttpMethodNotImplementedError(method: string): - BrowserAuthError - parameters: - - id: method - type: string - description: |+ - - return: - description: '' - type: - - name: createIframeClosedPrematurelyError() - uid: '@azure/msal-browser.BrowserAuthError.createIframeClosedPrematurelyError' - package: '@azure/msal-browser' - summary: >- - 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' - return: - description: '' - type: - - name: createInteractionInProgressError() - uid: '@azure/msal-browser.BrowserAuthError.createInteractionInProgressError' - package: '@azure/msal-browser' - summary: >- - 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' - return: - description: '' - type: - - name: createInvalidCacheTypeError() - uid: '@azure/msal-browser.BrowserAuthError.createInvalidCacheTypeError' - 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' - return: - description: '' - type: - - name: createMonitorIframeTimeoutError() - uid: '@azure/msal-browser.BrowserAuthError.createMonitorIframeTimeoutError' - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when monitorIframeFromHash times out for a given - iframe. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createMonitorIframeTimeoutError(): BrowserAuthError' - return: - description: '' - type: - - name: createMonitorPopupTimeoutError() - uid: '@azure/msal-browser.BrowserAuthError.createMonitorPopupTimeoutError' - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when monitorPopupFromHash times out for a given - popup. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createMonitorPopupTimeoutError(): BrowserAuthError' - return: - description: '' - type: - - name: createNativeBrokerCalledBeforeInitialize() - uid: >- - @azure/msal-browser.BrowserAuthError.createNativeBrokerCalledBeforeInitialize - package: '@azure/msal-browser' - summary: Create an error thrown when the initialize function hasn't been called - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNativeBrokerCalledBeforeInitialize(): - BrowserAuthError - return: - description: '' - type: - - name: createNativeConnectionNotEstablishedError() - uid: >- - @azure/msal-browser.BrowserAuthError.createNativeConnectionNotEstablishedError - package: '@azure/msal-browser' - summary: Create an error when native connection has not been established - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNativeConnectionNotEstablishedError(): - BrowserAuthError - return: - description: '' - type: - - name: createNativeExtensionNotInstalledError() - uid: >- - @azure/msal-browser.BrowserAuthError.createNativeExtensionNotInstalledError - package: '@azure/msal-browser' - summary: Create an error thrown when browser extension is not installed - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNativeExtensionNotInstalledError(): - BrowserAuthError - return: - description: '' - type: - - name: createNativeHandshakeTimeoutError() - uid: '@azure/msal-browser.BrowserAuthError.createNativeHandshakeTimeoutError' - 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' - return: - description: '' - type: - - name: createNativePromptParameterNotSupportedError() - uid: >- - @azure/msal-browser.BrowserAuthError.createNativePromptParameterNotSupportedError - package: '@azure/msal-browser' - summary: >- - Create an error thrown when requesting a token directly from the native - platform with an unsupported prompt parameter e.g. select_account, login - or create - - These requests must go through eSTS to ensure eSTS is aware of the new - account - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNativePromptParameterNotSupportedError(): - BrowserAuthError - return: - description: '' - type: - - name: createNoAccountError() - uid: '@azure/msal-browser.BrowserAuthError.createNoAccountError' - package: '@azure/msal-browser' - summary: >- - 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' - return: - description: '' - type: - - name: createNoCachedAuthorityError() - uid: '@azure/msal-browser.BrowserAuthError.createNoCachedAuthorityError' - package: '@azure/msal-browser' - summary: >- - 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' - return: - description: '' - type: - - name: createNonBrowserEnvironmentError() - uid: '@azure/msal-browser.BrowserAuthError.createNonBrowserEnvironmentError' - package: '@azure/msal-browser' - summary: >- - 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' - return: - description: '' - type: - - name: createNoNetworkConnectivityError() - uid: '@azure/msal-browser.BrowserAuthError.createNoNetworkConnectivityError' - 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' - return: - description: '' - type: - - name: createNoTokenRequestCacheError() - uid: '@azure/msal-browser.BrowserAuthError.createNoTokenRequestCacheError' - package: '@azure/msal-browser' - summary: >- - 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' - return: - description: '' - type: - - name: createPkceNotGeneratedError(string) - uid: '@azure/msal-browser.BrowserAuthError.createPkceNotGeneratedError' - package: '@azure/msal-browser' - summary: Creates an error thrown when PKCE is not implemented. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createPkceNotGeneratedError(errDetail: string): - BrowserAuthError - parameters: - - id: errDetail - type: string - description: |+ - - return: - description: '' - type: - - name: createPopupWindowError(string) - uid: '@azure/msal-browser.BrowserAuthError.createPopupWindowError' - package: '@azure/msal-browser' - summary: Creates an error thrown when the popup window could not be opened. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createPopupWindowError(errDetail?: string): - BrowserAuthError - parameters: - - id: errDetail - type: string - description: |+ - - return: - description: '' - type: - - name: 'createPostRequestFailedError(string, string)' - uid: '@azure/msal-browser.BrowserAuthError.createPostRequestFailedError' - package: '@azure/msal-browser' - summary: >- - Create an error thrown when token fetch fails due to reasons other than - internet connectivity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createPostRequestFailedError(errorDesc: string, - endpoint: string): BrowserAuthError - parameters: - - id: errorDesc - type: string - description: '' - - id: endpoint - type: string - description: '' - return: - description: '' - type: - - name: createRedirectInIframeError(boolean) - uid: '@azure/msal-browser.BrowserAuthError.createRedirectInIframeError' - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when navigateWindow is called inside an iframe or - brokered applications. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createRedirectInIframeError(windowParentCheck: boolean): - BrowserAuthError - parameters: - - id: windowParentCheck - type: boolean - description: |+ - - return: - description: '' - type: - - name: createSigningKeyNotFoundInStorageError(string) - uid: >- - @azure/msal-browser.BrowserAuthError.createSigningKeyNotFoundInStorageError - package: '@azure/msal-browser' - summary: >- - Create an error thrown when the queried cryptographic key is not found in - IndexedDB - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createSigningKeyNotFoundInStorageError(keyId: string): - BrowserAuthError - parameters: - - id: keyId - type: string - description: '' - return: - description: '' - type: - - name: createSilentLogoutUnsupportedError() - uid: '@azure/msal-browser.BrowserAuthError.createSilentLogoutUnsupportedError' - package: '@azure/msal-browser' - summary: >- - 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' - return: - description: '' - type: - - name: createSilentPromptValueError(string) - uid: '@azure/msal-browser.BrowserAuthError.createSilentPromptValueError' - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when a given prompt value is invalid for silent - requests. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createSilentPromptValueError(givenPrompt: string): - BrowserAuthError - parameters: - - id: givenPrompt - type: string - description: '' - return: - description: '' - type: - - name: createStateInteractionTypeMismatchError() - uid: >- - @azure/msal-browser.BrowserAuthError.createStateInteractionTypeMismatchError - package: '@azure/msal-browser' - summary: >- - 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: >- - static function createStateInteractionTypeMismatchError(): - BrowserAuthError - return: - description: '' - type: - - name: createUnableToAcquireTokenFromNativePlatformError() - uid: >- - @azure/msal-browser.BrowserAuthError.createUnableToAcquireTokenFromNativePlatformError - package: '@azure/msal-browser' - summary: Create an error when native token acquisition is not possible - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createUnableToAcquireTokenFromNativePlatformError(): - BrowserAuthError - return: - description: '' - type: - - name: createUnableToLoadTokenError(string) - uid: '@azure/msal-browser.BrowserAuthError.createUnableToLoadTokenError' - package: '@azure/msal-browser' - summary: >- - Create an error thrown when the necessary information is not available to - sideload tokens - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createUnableToLoadTokenError(errorDetail: string): - BrowserAuthError - parameters: - - id: errorDetail - type: string - description: '' - return: - description: '' - type: - - name: createUnableToParseStateError() - uid: '@azure/msal-browser.BrowserAuthError.createUnableToParseStateError' - 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' - return: - description: '' - type: - - name: createUnableToParseTokenRequestCacheError() - uid: >- - @azure/msal-browser.BrowserAuthError.createUnableToParseTokenRequestCacheError - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when the cached token request could not be - retrieved from the cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createUnableToParseTokenRequestCacheError(): - BrowserAuthError - return: - description: '' - type: - - name: createUserCancelledError() - uid: '@azure/msal-browser.BrowserAuthError.createUserCancelledError' - 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' - return: - description: '' - type: -extends: AuthError + 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 index fae85fb..da431d0 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserAuthOptions.yml @@ -5,20 +5,23 @@ 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 = { - authority?: string, - authorityMetadata?: string, - azureCloudOptions?: AzureCloudOptions, - clientCapabilities?: Array, - clientId: string, - cloudDiscoveryMetadata?: string, - knownAuthorities?: Array, - navigateToLoginRequestUrl?: boolean, - postLogoutRedirectUri?: string | null, - protocolMode?: ProtocolMode, - redirectUri?: string, - skipAuthorityMetadataCache?: boolean, + OIDCOptions?: OIDCOptions + authority?: string + authorityMetadata?: string + azureCloudOptions?: AzureCloudOptions + clientCapabilities?: string[] + clientId: string + cloudDiscoveryMetadata?: string + instanceAware?: boolean + knownAuthorities?: string[] + navigateToLoginRequestUrl?: boolean + onRedirectNavigate?: (url: string) => boolean | void + 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 index 193c7da..0370532 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheLocation.yml @@ -1,22 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: BrowserCacheLocation uid: '@azure/msal-browser.BrowserCacheLocation' package: '@azure/msal-browser' summary: '' fullName: BrowserCacheLocation remarks: '' -isPreview: false isDeprecated: false -fields: - - name: LocalStorage - uid: '@azure/msal-browser.BrowserCacheLocation.LocalStorage' - package: '@azure/msal-browser' - summary: '' - - name: MemoryStorage - uid: '@azure/msal-browser.BrowserCacheLocation.MemoryStorage' - package: '@azure/msal-browser' - summary: '' - - name: SessionStorage - uid: '@azure/msal-browser.BrowserCacheLocation.SessionStorage' - package: '@azure/msal-browser' - summary: '' +syntax: | + type BrowserCacheLocation = + (typeof BrowserCacheLocation)[keyof typeof BrowserCacheLocation] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml deleted file mode 100644 index 603157d..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserCacheManager.yml +++ /dev/null @@ -1,1382 +0,0 @@ -### YamlMime:TSType -name: BrowserCacheManager -uid: '@azure/msal-browser.BrowserCacheManager' -package: '@azure/msal-browser' -summary: >- - This class implements the cache storage interface for MSAL through browser - local or session storage. - - Cookies are only used if storeAuthStateInCookie is true, and are only used for - - parameters such as state and nonce, generally. -fullName: BrowserCacheManager -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'BrowserCacheManager(string, Required, ICrypto, Logger)' - uid: '@azure/msal-browser.BrowserCacheManager.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new BrowserCacheManager(clientId: string, cacheConfig: - Required, cryptoImpl: ICrypto, logger: Logger) - parameters: - - id: clientId - type: string - description: '' - - id: cacheConfig - type: Required<> - description: '' - - id: cryptoImpl - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' -inheritedMethods: - - name: generateAuthorityMetadataCacheKey(string) - uid: '@azure/msal-browser.BrowserCacheManager.generateAuthorityMetadataCacheKey' - 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' - parameters: - - id: authority - type: string - description: '' - return: - description: '' - type: string - inheritanceDescription: Inherited From CacheManager.generateAuthorityMetadataCacheKey - - name: getAccountsFilteredBy(AccountFilter) - uid: '@azure/msal-browser.BrowserCacheManager.getAccountsFilteredBy' - package: '@azure/msal-browser' - summary: >- - retrieve accounts matching all provided filters; if no filter is set, get - all accounts - - 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: >- - function getAccountsFilteredBy(accountFilter?: AccountFilter): - AccountCache - parameters: - - id: accountFilter - type: AccountFilter - description: '' - return: - description: '' - type: AccountCache - inheritanceDescription: Inherited From CacheManager.getAccountsFilteredBy - - name: getAllAccounts() - uid: '@azure/msal-browser.BrowserCacheManager.getAllAccounts' - package: '@azure/msal-browser' - summary: Returns all accounts in cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAllAccounts(): AccountInfo[]' - return: - description: '' - type: 'AccountInfo[]' - inheritanceDescription: Inherited From CacheManager.getAllAccounts - - name: getAppMetadataFilteredBy(AppMetadataFilter) - uid: '@azure/msal-browser.BrowserCacheManager.getAppMetadataFilteredBy' - package: '@azure/msal-browser' - summary: >- - retrieve appMetadata matching all provided filters; if no filter is set, - get all appMetadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAppMetadataFilteredBy(filter: AppMetadataFilter): - AppMetadataCache - parameters: - - id: filter - type: AppMetadataFilter - description: |+ - - return: - description: '' - type: AppMetadataCache - inheritanceDescription: Inherited From CacheManager.getAppMetadataFilteredBy - - name: getAuthorityMetadataByAlias(string) - uid: '@azure/msal-browser.BrowserCacheManager.getAuthorityMetadataByAlias' - package: '@azure/msal-browser' - summary: retrieve authorityMetadata that contains a matching alias - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadataByAlias(host: string): - AuthorityMetadataEntity | null - parameters: - - id: host - type: string - description: '' - return: - description: '' - type: AuthorityMetadataEntity | null - inheritanceDescription: Inherited From CacheManager.getAuthorityMetadataByAlias - - name: getCredentialsFilteredBy(CredentialFilter) - uid: '@azure/msal-browser.BrowserCacheManager.getCredentialsFilteredBy' - package: '@azure/msal-browser' - summary: >- - retrieve credentails matching all provided filters; if no filter is set, - get all credentials - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getCredentialsFilteredBy(filter: CredentialFilter): - CredentialCache - parameters: - - id: filter - type: CredentialFilter - description: '' - return: - description: '' - type: CredentialCache - inheritanceDescription: Inherited From CacheManager.getCredentialsFilteredBy - - name: 'isAppMetadataFOCI(string, string)' - uid: '@azure/msal-browser.BrowserCacheManager.isAppMetadataFOCI' - package: '@azure/msal-browser' - summary: Return the family_id value associated with FOCI - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function isAppMetadataFOCI(environment: string, clientId: string): - boolean - parameters: - - id: environment - type: string - description: '' - - id: clientId - type: string - description: |+ - - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.isAppMetadataFOCI - - name: 'readAccessTokenFromCache(string, AccountInfo, BaseAuthRequest)' - uid: '@azure/msal-browser.BrowserCacheManager.readAccessTokenFromCache' - package: '@azure/msal-browser' - summary: Retrieve AccessTokenEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccessTokenFromCache(clientId: string, account: - AccountInfo, request: BaseAuthRequest): AccessTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: AccountInfo - description: '' - - id: request - type: BaseAuthRequest - description: '' - return: - description: '' - type: AccessTokenEntity | null - inheritanceDescription: Inherited From CacheManager.readAccessTokenFromCache - - name: readAccountFromCache(AccountInfo) - uid: '@azure/msal-browser.BrowserCacheManager.readAccountFromCache' - package: '@azure/msal-browser' - summary: Retrieve AccountEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccountFromCache(account: AccountInfo): AccountEntity | - null - parameters: - - id: account - type: AccountInfo - description: |+ - - return: - 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: '' - isPreview: false - 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)' - uid: '@azure/msal-browser.BrowserCacheManager.readAppMetadataFromCache' - package: '@azure/msal-browser' - summary: Retrieve AppMetadataEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAppMetadataFromCache(environment: string, clientId: - 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)' - uid: '@azure/msal-browser.BrowserCacheManager.readCacheRecord' - package: '@azure/msal-browser' - summary: Retrieve the cached credentials into a cacherecord - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readCacheRecord(account: AccountInfo, clientId: string, - request: BaseAuthRequest, environment: string): CacheRecord - parameters: - - id: account - type: AccountInfo - description: '' - - id: clientId - type: string - description: '' - - id: request - type: BaseAuthRequest - description: '' - - id: environment - type: string - description: '' - return: - description: '' - type: CacheRecord - inheritanceDescription: Inherited From CacheManager.readCacheRecord - - name: 'readIdTokenFromCache(string, AccountInfo)' - uid: '@azure/msal-browser.BrowserCacheManager.readIdTokenFromCache' - package: '@azure/msal-browser' - summary: Retrieve IdTokenEntity from cache - remarks: '' - isPreview: false - 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 - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readRefreshTokenFromCache(clientId: string, account: - AccountInfo, familyRT: boolean): RefreshTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: AccountInfo - description: '' - - id: familyRT - type: boolean - 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: '' - isPreview: false - 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 - - name: removeAccountContext(AccountEntity) - uid: '@azure/msal-browser.BrowserCacheManager.removeAccountContext' - package: '@azure/msal-browser' - summary: Removes credentials associated with the provided account - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' - parameters: - - id: account - type: AccountEntity - description: |+ - - return: - description: '' - type: Promise<boolean> - inheritanceDescription: Inherited From CacheManager.removeAccountContext - - name: removeAllAccounts() - uid: '@azure/msal-browser.BrowserCacheManager.removeAllAccounts' - package: '@azure/msal-browser' - summary: Removes all accounts and related tokens from cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAllAccounts(): Promise' - return: - description: '' - type: Promise<boolean> - inheritanceDescription: Inherited From CacheManager.removeAllAccounts - - name: removeAppMetadata() - uid: '@azure/msal-browser.BrowserCacheManager.removeAppMetadata' - package: '@azure/msal-browser' - summary: Removes all app metadata objects from cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAppMetadata(): boolean' - return: - 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: '' - isPreview: false - 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' - summary: saves a cache record - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' - parameters: - - id: cacheRecord - type: CacheRecord - description: |+ - - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CacheManager.saveCacheRecord - - name: 'toObject(T, object)' - uid: '@azure/msal-browser.BrowserCacheManager.toObject' - 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' - parameters: - - id: obj - type: T - description: '' - - id: json - type: object - description: |+ - - return: - description: '' - type: T - inheritanceDescription: Inherited From CacheManager.toObject -methods: - - name: 'cacheCodeRequest(CommonAuthorizationCodeRequest, ICrypto)' - uid: '@azure/msal-browser.BrowserCacheManager.cacheCodeRequest' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function cacheCodeRequest(authCodeRequest: - CommonAuthorizationCodeRequest, browserCrypto: ICrypto) - parameters: - - id: authCodeRequest - type: CommonAuthorizationCodeRequest - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - name: cleanRequestByInteractionType(InteractionType) - uid: '@azure/msal-browser.BrowserCacheManager.cleanRequestByInteractionType' - package: '@azure/msal-browser' - summary: >- - Looks in temporary cache for any state values with the provided - interactionType and removes all temporary cache items for that state - - 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)' - parameters: - - id: interactionType - type: - description: |+ - - - name: cleanRequestByState(string) - uid: '@azure/msal-browser.BrowserCacheManager.cleanRequestByState' - package: '@azure/msal-browser' - summary: Removes temporary cache for the provided state - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function cleanRequestByState(stateString: string)' - parameters: - - id: stateString - type: string - description: |+ - - - name: clear() - uid: '@azure/msal-browser.BrowserCacheManager.clear' - package: '@azure/msal-browser' - summary: Clears all cache entries created by MSAL. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function clear(): Promise' - return: - description: '' - type: Promise<void> - - name: clearItemCookie(string) - uid: '@azure/msal-browser.BrowserCacheManager.clearItemCookie' - package: '@azure/msal-browser' - summary: Clear an item in the cookies by key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function clearItemCookie(cookieName: string)' - parameters: - - id: cookieName - type: string - description: |+ - - - name: clearMsalCookies() - uid: '@azure/msal-browser.BrowserCacheManager.clearMsalCookies' - package: '@azure/msal-browser' - summary: >- - 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() - - name: containsKey(string) - uid: '@azure/msal-browser.BrowserCacheManager.containsKey' - package: '@azure/msal-browser' - summary: Checks whether key is in cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function containsKey(key: string): boolean' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: boolean - - name: generateAuthorityKey(string) - uid: '@azure/msal-browser.BrowserCacheManager.generateAuthorityKey' - package: '@azure/msal-browser' - summary: Create authorityKey to cache authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateAuthorityKey(stateString: string): string' - parameters: - - id: stateString - type: string - description: '' - return: - description: '' - type: string - - name: generateCacheKey(string) - uid: '@azure/msal-browser.BrowserCacheManager.generateCacheKey' - package: '@azure/msal-browser' - summary: >- - Prepend msal. to each key; Skip for any JSON object as Key - (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' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: string - - name: generateNonceKey(string) - uid: '@azure/msal-browser.BrowserCacheManager.generateNonceKey' - package: '@azure/msal-browser' - summary: Create Nonce key to cache nonce - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateNonceKey(stateString: string): string' - parameters: - - id: stateString - type: string - description: '' - return: - description: '' - type: string - - name: generateStateKey(string) - uid: '@azure/msal-browser.BrowserCacheManager.generateStateKey' - 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' - parameters: - - id: stateString - type: string - description: | - State string for the request - return: - description: '' - type: string - - name: getAccessTokenCredential(string) - uid: '@azure/msal-browser.BrowserCacheManager.getAccessTokenCredential' - package: '@azure/msal-browser' - summary: generates accessToken entity from a string - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAccessTokenCredential(accessTokenKey: string): - AccessTokenEntity | null - parameters: - - id: accessTokenKey - type: string - description: '' - return: - description: '' - type: AccessTokenEntity | null - - name: getAccount(string) - uid: '@azure/msal-browser.BrowserCacheManager.getAccount' - 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' - parameters: - - id: accountKey - type: string - description: |+ - - return: - description: '' - type: AccountEntity | null - - name: >- - getAccountInfoByFilter(Partial>) - uid: '@azure/msal-browser.BrowserCacheManager.getAccountInfoByFilter' - package: '@azure/msal-browser' - summary: Gets a list of accounts that match all of the filters provided - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAccountInfoByFilter(accountFilter: Partial>): AccountInfo[] - parameters: - - id: accountFilter - type: 'Partial<Omit<AccountInfo, "idTokenClaims" | "name">>' - description: '' - return: - description: '' - type: 'AccountInfo[]' - - name: 'getAccountInfoByHints(string, string)' - uid: '@azure/msal-browser.BrowserCacheManager.getAccountInfoByHints' - package: '@azure/msal-browser' - summary: Checks the cache for accounts matching loginHint or SID - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAccountInfoByHints(loginHint?: string, sid?: string): - AccountInfo | null - parameters: - - id: loginHint - type: string - description: '' - - id: sid - type: string - description: |+ - - return: - description: '' - type: AccountInfo | null - - name: getActiveAccount() - uid: '@azure/msal-browser.BrowserCacheManager.getActiveAccount' - package: '@azure/msal-browser' - summary: Gets the active account - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getActiveAccount(): AccountInfo | null' - return: - description: '' - type: AccountInfo | null - - name: getAppMetadata(string) - uid: '@azure/msal-browser.BrowserCacheManager.getAppMetadata' - package: '@azure/msal-browser' - summary: fetch appMetadata entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAppMetadata(appMetadataKey: string): AppMetadataEntity | - null - parameters: - - id: appMetadataKey - type: string - description: |+ - - return: - description: '' - type: AppMetadataEntity | null - - name: getAuthorityMetadata(string) - uid: '@azure/msal-browser.BrowserCacheManager.getAuthorityMetadata' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadata(key: string): AuthorityMetadataEntity | - null - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: AuthorityMetadataEntity | null - - name: getAuthorityMetadataKeys() - uid: '@azure/msal-browser.BrowserCacheManager.getAuthorityMetadataKeys' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAuthorityMetadataKeys(): Array' - return: - description: '' - type: Array<string> - - name: getCache() - uid: '@azure/msal-browser.BrowserCacheManager.getCache' - package: '@azure/msal-browser' - summary: Gets the cache object referenced by the browser - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getCache(): object' - return: - description: '' - type: object - - name: getCachedAuthority(string) - uid: '@azure/msal-browser.BrowserCacheManager.getCachedAuthority' - package: '@azure/msal-browser' - summary: >- - 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' - parameters: - - id: cachedState - type: string - description: '' - return: - description: '' - type: string | null - - name: getCachedNativeRequest() - uid: '@azure/msal-browser.BrowserCacheManager.getCachedNativeRequest' - package: '@azure/msal-browser' - summary: Gets cached native request for redirect flows - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getCachedNativeRequest(): NativeTokenRequest | null' - return: - description: '' - type: | null - - name: 'getCachedRequest(string, ICrypto)' - uid: '@azure/msal-browser.BrowserCacheManager.getCachedRequest' - package: '@azure/msal-browser' - summary: >- - Gets the token exchange parameters from the cache. Throws an error if - nothing is found. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getCachedRequest(state: string, browserCrypto: ICrypto): - CommonAuthorizationCodeRequest - parameters: - - id: state - type: string - description: '' - - id: browserCrypto - type: ICrypto - description: '' - return: - description: '' - type: CommonAuthorizationCodeRequest - - name: getCookieExpirationTime(number) - uid: '@azure/msal-browser.BrowserCacheManager.getCookieExpirationTime' - package: '@azure/msal-browser' - summary: Get cookie expiration time - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getCookieExpirationTime(cookieLifeDays: number): string' - parameters: - - id: cookieLifeDays - type: number - description: |+ - - return: - description: '' - type: string - - name: getIdTokenCredential(string) - uid: '@azure/msal-browser.BrowserCacheManager.getIdTokenCredential' - package: '@azure/msal-browser' - summary: generates idToken entity from a string - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getIdTokenCredential(idTokenKey: string): IdTokenEntity | null' - parameters: - - id: idTokenKey - type: string - description: |+ - - return: - description: '' - type: IdTokenEntity | null - - name: getInteractionInProgress() - uid: '@azure/msal-browser.BrowserCacheManager.getInteractionInProgress' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getInteractionInProgress(): string | null' - return: - description: '' - type: string | null - - name: getItem(string) - uid: '@azure/msal-browser.BrowserCacheManager.getItem' - 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' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: string | null - - name: getItemCookie(string) - uid: '@azure/msal-browser.BrowserCacheManager.getItemCookie' - package: '@azure/msal-browser' - summary: Get one item by key from cookies - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getItemCookie(cookieName: string): string' - parameters: - - id: cookieName - type: string - description: |+ - - return: - description: '' - type: string - - name: getKeys() - uid: '@azure/msal-browser.BrowserCacheManager.getKeys' - package: '@azure/msal-browser' - summary: Gets all keys in window. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getKeys(): string[]' - return: - description: '' - type: 'string[]' - - name: getLegacyLoginHint() - uid: '@azure/msal-browser.BrowserCacheManager.getLegacyLoginHint' - 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: 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: >- - function getRefreshTokenCredential(refreshTokenKey: string): - RefreshTokenEntity | null - parameters: - - id: refreshTokenKey - type: string - description: |+ - - return: - description: '' - type: RefreshTokenEntity | null - - name: getServerTelemetry(string) - uid: '@azure/msal-browser.BrowserCacheManager.getServerTelemetry' - package: '@azure/msal-browser' - summary: fetch server telemetry entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getServerTelemetry(serverTelemetryKey: string): - ServerTelemetryEntity | null - parameters: - - id: serverTelemetryKey - type: string - description: |+ - - return: - description: '' - type: ServerTelemetryEntity | null - - name: 'getTemporaryCache(string, boolean)' - uid: '@azure/msal-browser.BrowserCacheManager.getTemporaryCache' - package: '@azure/msal-browser' - summary: |- - Gets cache item with given key. - Will retrieve from cookies if storeAuthStateInCookie is set to true. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getTemporaryCache(cacheKey: string, generateKey?: boolean): - string | null - parameters: - - id: cacheKey - type: string - description: '' - - id: generateKey - type: boolean - description: '' - return: - description: '' - type: string | null - - name: getThrottlingCache(string) - uid: '@azure/msal-browser.BrowserCacheManager.getThrottlingCache' - package: '@azure/msal-browser' - summary: fetch throttling entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getThrottlingCache(throttlingCacheKey: string): - ThrottlingEntity | null - parameters: - - id: throttlingCacheKey - type: string - description: |+ - - return: - description: '' - type: ThrottlingEntity | null - - name: getWrapperMetadata() - uid: '@azure/msal-browser.BrowserCacheManager.getWrapperMetadata' - package: '@azure/msal-browser' - summary: Returns wrapper metadata from in-memory storage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getWrapperMetadata(): [string, string]' - return: - description: '' - type: '[string, string]' - - name: isInteractionInProgress(boolean) - uid: '@azure/msal-browser.BrowserCacheManager.isInteractionInProgress' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isInteractionInProgress(matchClientId?: boolean): boolean' - parameters: - - id: matchClientId - type: boolean - description: '' - return: - description: '' - type: boolean - - name: removeItem(string) - uid: '@azure/msal-browser.BrowserCacheManager.removeItem' - package: '@azure/msal-browser' - summary: |- - 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' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: boolean - - name: resetRequestCache(string) - uid: '@azure/msal-browser.BrowserCacheManager.resetRequestCache' - package: '@azure/msal-browser' - summary: Reset all temporary cache items - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function resetRequestCache(state: string)' - parameters: - - id: state - type: string - description: |+ - - - name: setAccessTokenCredential(AccessTokenEntity) - uid: '@azure/msal-browser.BrowserCacheManager.setAccessTokenCredential' - package: '@azure/msal-browser' - summary: set accessToken credential to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' - parameters: - - id: accessToken - type: AccessTokenEntity - description: |+ - - - name: setAccount(AccountEntity) - uid: '@azure/msal-browser.BrowserCacheManager.setAccount' - package: '@azure/msal-browser' - summary: set account entity in the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAccount(account: AccountEntity)' - parameters: - - id: account - type: AccountEntity - description: '' - - name: setActiveAccount(AccountInfo | null) - uid: '@azure/msal-browser.BrowserCacheManager.setActiveAccount' - 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)' - parameters: - - id: account - type: AccountInfo | null - description: |+ - - - name: setAppMetadata(AppMetadataEntity) - uid: '@azure/msal-browser.BrowserCacheManager.setAppMetadata' - package: '@azure/msal-browser' - summary: set appMetadata entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' - parameters: - - id: appMetadata - type: AppMetadataEntity - description: |+ - - - name: 'setAuthorityMetadata(string, AuthorityMetadataEntity)' - uid: '@azure/msal-browser.BrowserCacheManager.setAuthorityMetadata' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setAuthorityMetadata(key: string, entity: - AuthorityMetadataEntity) - parameters: - - id: key - type: string - description: '' - - id: entity - type: AuthorityMetadataEntity - description: |+ - - - name: setCache() - uid: '@azure/msal-browser.BrowserCacheManager.setCache' - package: '@azure/msal-browser' - summary: >- - interface compat, we cannot overwrite browser cache; Functionality is - supported by individual entities in browser - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setCache() - - name: setIdTokenCredential(IdTokenEntity) - uid: '@azure/msal-browser.BrowserCacheManager.setIdTokenCredential' - package: '@azure/msal-browser' - summary: set IdToken credential to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setIdTokenCredential(idToken: IdTokenEntity)' - parameters: - - id: idToken - type: IdTokenEntity - description: |+ - - - name: setInteractionInProgress(boolean) - uid: '@azure/msal-browser.BrowserCacheManager.setInteractionInProgress' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setInteractionInProgress(inProgress: boolean)' - parameters: - - id: inProgress - type: boolean - description: '' - - name: 'setItem(string, string)' - uid: '@azure/msal-browser.BrowserCacheManager.setItem' - 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)' - parameters: - - id: key - type: string - description: '' - - id: value - type: string - description: |+ - - - name: 'setItemCookie(string, string, number)' - uid: '@azure/msal-browser.BrowserCacheManager.setItemCookie' - package: '@azure/msal-browser' - summary: Add value to cookies - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setItemCookie(cookieName: string, cookieValue: string, - expires?: number) - parameters: - - id: cookieName - type: string - description: '' - - id: cookieValue - type: string - description: '' - - id: expires - type: number - 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)' - parameters: - - id: refreshToken - type: RefreshTokenEntity - description: |+ - - - name: 'setServerTelemetry(string, ServerTelemetryEntity)' - uid: '@azure/msal-browser.BrowserCacheManager.setServerTelemetry' - package: '@azure/msal-browser' - summary: set server telemetry entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setServerTelemetry(serverTelemetryKey: string, serverTelemetry: - ServerTelemetryEntity) - parameters: - - id: serverTelemetryKey - type: string - description: '' - - id: serverTelemetry - type: ServerTelemetryEntity - description: |+ - - - name: 'setTemporaryCache(string, string, boolean)' - uid: '@azure/msal-browser.BrowserCacheManager.setTemporaryCache' - package: '@azure/msal-browser' - summary: |- - Sets the cache item with the key and value given. - Stores in cookie if storeAuthStateInCookie is set to true. - This can cause cookie overflow if used incorrectly. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setTemporaryCache(cacheKey: string, value: string, - generateKey?: boolean) - parameters: - - id: cacheKey - type: string - description: '' - - id: value - type: string - description: |+ - - - id: generateKey - type: boolean - description: '' - - name: 'setThrottlingCache(string, ThrottlingEntity)' - uid: '@azure/msal-browser.BrowserCacheManager.setThrottlingCache' - package: '@azure/msal-browser' - summary: set throttling entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setThrottlingCache(throttlingCacheKey: string, throttlingCache: - ThrottlingEntity) - parameters: - - id: throttlingCacheKey - type: string - description: '' - - id: throttlingCache - type: ThrottlingEntity - description: |+ - - - name: 'setWrapperMetadata(string, string)' - uid: '@azure/msal-browser.BrowserCacheManager.setWrapperMetadata' - package: '@azure/msal-browser' - summary: Sets wrapper metadata in memory - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setWrapperMetadata(wrapperSKU: string, wrapperVersion: string)' - parameters: - - id: wrapperSKU - type: string - description: '' - - id: wrapperVersion - type: string - description: |+ - - - name: 'updateCacheEntries(string, string, string, string, AccountInfo | null)' - uid: '@azure/msal-browser.BrowserCacheManager.updateCacheEntries' - package: '@azure/msal-browser' - summary: 'Updates account, authority, and state in cache' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function updateCacheEntries(state: string, nonce: string, - authorityInstance: string, loginHint: string, account: AccountInfo | - null) - parameters: - - id: state - type: string - description: '' - - id: nonce - type: string - description: '' - - id: authorityInstance - type: string - description: '' - - id: loginHint - type: string - description: '' - - id: account - type: AccountInfo | null - description: |+ - - - name: 'updateCredentialCacheKey(string, ValidCredentialType)' - uid: '@azure/msal-browser.BrowserCacheManager.updateCredentialCacheKey' - 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: >- - function updateCredentialCacheKey(currentCacheKey: string, credential: - ValidCredentialType): string - parameters: - - id: currentCacheKey - type: string - description: '' - - id: credential - type: ValidCredentialType - description: '' - return: - description: '' - type: string -extends: CacheManager diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfiguration.yml deleted file mode 100644 index da2eee5..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfiguration.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: BrowserConfiguration -uid: '@azure/msal-browser.BrowserConfiguration' -package: '@azure/msal-browser' -summary: '' -fullName: BrowserConfiguration -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type BrowserConfiguration = { - auth: Required, - cache: Required, - system: Required, - telemetry: Required, - } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml index 0418599..d75f427 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserConfigurationAuthError.yml @@ -5,16 +5,14 @@ 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: - - name: 'BrowserConfigurationAuthError(string, string)' + - name: BrowserConfigurationAuthError(string, string) uid: '@azure/msal-browser.BrowserConfigurationAuthError.constructor' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -34,142 +32,164 @@ inheritedProperties: 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 + 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: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' return: description: '' type: string - inheritanceDescription: Inherited From AuthError.errorCode + 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: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' return: description: '' type: string - inheritanceDescription: Inherited From AuthError.errorMessage + 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: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.message + 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: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.name + 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: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.stack + 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: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' return: description: '' type: string - inheritanceDescription: Inherited From AuthError.subError + inheritanceDescription: >- + Inherited From + [AuthError.subError](xref:@azure/msal-browser.AuthError.subError) inheritedMethods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-browser.BrowserConfigurationAuthError.createPostRequestFailed' + - name: captureStackTrace(object, Function) + uid: '@azure/msal-browser.BrowserConfigurationAuthError.captureStackTrace' package: '@azure/msal-browser' - summary: Creates an error for post request failures. + summary: Create .stack property on a target object remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) parameters: - - id: errDesc - type: string + - id: targetObject + type: object description: '' - return: - description: '' - type: AuthError - inheritanceDescription: Inherited From AuthError.createPostRequestFailed - - name: createUnexpectedError(string) - uid: '@azure/msal-browser.BrowserConfigurationAuthError.createUnexpectedError' - package: '@azure/msal-browser' - 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 + - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -177,123 +197,7 @@ inheritedMethods: - id: correlationId type: string description: '' - inheritanceDescription: Inherited From AuthError.setCorrelationId -methods: - - name: createEntropyNotProvided() - uid: '@azure/msal-browser.BrowserConfigurationAuthError.createEntropyNotProvided' - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when a crypto interface that requires entropy is - initialized without entropy - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createEntropyNotProvided(): - BrowserConfigurationAuthError - return: - description: '' - type: - - name: createInMemoryRedirectUnavailableError() - uid: >- - @azure/msal-browser.BrowserConfigurationAuthError.createInMemoryRedirectUnavailableError - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInMemoryRedirectUnavailableError(): - BrowserConfigurationAuthError - return: - description: '' - type: - - name: createPostLogoutRedirectUriEmptyError() - uid: >- - @azure/msal-browser.BrowserConfigurationAuthError.createPostLogoutRedirectUriEmptyError - package: '@azure/msal-browser' - summary: >- - Creates an error thrown when the post-logout redirect uri is empty (not - set by caller) - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createPostLogoutRedirectUriEmptyError(): - BrowserConfigurationAuthError - return: - description: '' - type: - - name: createRedirectCallbacksNotSetError() - uid: >- - @azure/msal-browser.BrowserConfigurationAuthError.createRedirectCallbacksNotSetError - package: '@azure/msal-browser' - summary: >- - Creates error thrown when redirect callbacks are not set before calling - loginRedirect() or acquireTokenRedirect(). - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createRedirectCallbacksNotSetError(): - BrowserConfigurationAuthError - return: - description: '' - type: - - name: createRedirectUriEmptyError() - uid: >- - @azure/msal-browser.BrowserConfigurationAuthError.createRedirectUriEmptyError - 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: >- - static function createRedirectUriEmptyError(): - BrowserConfigurationAuthError - return: - description: '' - type: - - name: createStorageNotSupportedError(string) - uid: >- - @azure/msal-browser.BrowserConfigurationAuthError.createStorageNotSupportedError - package: '@azure/msal-browser' - summary: Creates error thrown when given storage location is not supported. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createStorageNotSupportedError(givenStorageLocation: - string): BrowserConfigurationAuthError - parameters: - - id: givenStorageLocation - type: string - description: |+ - - return: - description: '' - type: - - name: createStubPcaInstanceCalledError() - uid: >- - @azure/msal-browser.BrowserConfigurationAuthError.createStubPcaInstanceCalledError - package: '@azure/msal-browser' - summary: >- - Creates error thrown when the stub instance of PublicClientApplication is - called. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createStubPcaInstanceCalledError(): - BrowserConfigurationAuthError - return: - description: '' - type: -extends: AuthError + 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/BrowserCrypto.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserCrypto.yml deleted file mode 100644 index 07b6f40..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml index 312e0f4..ff5208f 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceClient.yml @@ -5,54 +5,53 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserPerformanceClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: >- - BrowserPerformanceClient(string, string, Logger, string, string, - ApplicationTelemetry, CryptoOptions) + - name: BrowserPerformanceClient(Configuration, Set, Map) uid: '@azure/msal-browser.BrowserPerformanceClient.constructor' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - new BrowserPerformanceClient(clientId: string, authority: string, - logger: Logger, libraryName: string, libraryVersion: string, - applicationTelemetry: ApplicationTelemetry, cryptoOptions: - CryptoOptions) + new BrowserPerformanceClient(configuration: Configuration, intFields?: + Set, abbreviations?: Map) parameters: - - id: clientId - type: string + - id: configuration + type: description: '' - - id: authority - type: string + - id: intFields + type: Set<string> description: '' - - id: logger - type: Logger + - id: abbreviations + type: Map<string, string> description: '' - - id: libraryName - type: string +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: libraryVersion + - id: correlationId type: string description: '' - - id: applicationTelemetry - type: ApplicationTelemetry - description: '' - - id: cryptoOptions - type: - description: '' -inheritedMethods: + 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -60,63 +59,68 @@ inheritedMethods: string parameters: - id: callback - type: PerformanceCallbackFunction + type: description: '' return: description: '' type: string inheritanceDescription: Inherited From PerformanceClient.addPerformanceCallback - - name: 'addStaticFields(StaticFields, string)' - uid: '@azure/msal-browser.BrowserPerformanceClient.addStaticFields' + - name: calculateQueuedTime(number, number) + uid: '@azure/msal-browser.BrowserPerformanceClient.calculateQueuedTime' package: '@azure/msal-browser' - summary: Saves extra information to be emitted when the measurements are flushed + 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: '' - isPreview: false isDeprecated: false syntax: - content: 'function addStaticFields(fields: StaticFields, correlationId: string)' + content: >- + function calculateQueuedTime(preQueueTime: number, currentTime: number): + number parameters: - - id: fields - type: StaticFields + - id: preQueueTime + type: number description: '' - - id: correlationId - type: string - description: |+ - - inheritanceDescription: Inherited From PerformanceClient.addStaticFields + - 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. + summary: Removes measurements and aux data for a given correlation id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function discardMeasurements(correlationId: string)' parameters: - id: correlationId type: string - description: |+ - + description: '' inheritanceDescription: Inherited From PerformanceClient.discardMeasurements - - name: 'emitEvents(PerformanceEvent[], string)' + - name: emitEvents(PerformanceEvent[], string) uid: '@azure/msal-browser.BrowserPerformanceClient.emitEvents' package: '@azure/msal-browser' summary: Emits events to all registered callbacks. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function emitEvents(events: PerformanceEvent[], correlationId: string)' + content: 'function emitEvents(events: PerformanceEvent[], correlationId?: string)' parameters: - id: events - type: 'PerformanceEvent[]' + type: [] description: '' - id: correlationId type: string description: '' inheritanceDescription: Inherited From PerformanceClient.emitEvents - - name: endMeasurement(PerformanceEvent) + - name: endMeasurement(PerformanceEvent, unknown) uid: '@azure/msal-browser.BrowserPerformanceClient.endMeasurement' package: '@azure/msal-browser' summary: >- @@ -124,49 +128,72 @@ 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, error?: unknown): null + | PerformanceEvent parameters: - id: event - type: PerformanceEvent + type: + description: '' + - id: error + type: unknown description: '' return: description: '' - type: PerformanceEvent | null + type: null | inheritanceDescription: Inherited From PerformanceClient.endMeasurement - - name: 'flushMeasurements(PerformanceEvents, string)' - uid: '@azure/msal-browser.BrowserPerformanceClient.flushMeasurements' + - name: getPreQueueTime(string, string) + uid: '@azure/msal-browser.BrowserPerformanceClient.getPreQueueTime' package: '@azure/msal-browser' - summary: >- - Gathers and emits performance events for measurements taked for the given - top-level API and correlation ID. + 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: string, correlationId: string): + number | void parameters: - - id: measureName - type: PerformanceEvents + - id: eventName + type: string description: '' - id: correlationId type: string - description: |+ - - inheritanceDescription: Inherited From PerformanceClient.flushMeasurements + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -178,55 +205,99 @@ 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: 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: '' - isPreview: false isDeprecated: false syntax: content: 'function generateId(): string' return: description: '' type: string - - name: 'startMeasurement(PerformanceEvents, string)' - uid: '@azure/msal-browser.BrowserPerformanceClient.startMeasurement' + - name: setPreQueueTime(PerformanceEvents, string) + uid: '@azure/msal-browser.BrowserPerformanceClient.setPreQueueTime' 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. + summary: Adds pre-queue time to preQueueTimeByCorrelationId map. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function startMeasurement(measureName: PerformanceEvents, - correlationId?: string): InProgressPerformanceEvent + function setPreQueueTime(eventName: PerformanceEvents, correlationId?: + string) parameters: - - id: measureName - type: PerformanceEvents + - id: eventName + type: description: '' - id: correlationId type: string description: '' - return: - description: '' - type: InProgressPerformanceEvent - - name: 'startPerformanceMeasuremeant(string, string)' - uid: '@azure/msal-browser.BrowserPerformanceClient.startPerformanceMeasuremeant' + - name: startMeasurement(string, string) + uid: '@azure/msal-browser.BrowserPerformanceClient.startMeasurement' package: '@azure/msal-browser' - summary: '' + 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: '' - isPreview: false isDeprecated: false syntax: content: >- - function startPerformanceMeasuremeant(measureName: string, - correlationId: string): IPerformanceMeasurement + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent parameters: - id: measureName type: string @@ -236,5 +307,5 @@ methods: description: '' return: description: '' - type: IPerformanceMeasurement -extends: PerformanceClient + type: +extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml index 2174112..8d85736 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserPerformanceMeasurement.yml @@ -5,16 +5,14 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserPerformanceMeasurement remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'BrowserPerformanceMeasurement(string, string)' + - name: BrowserPerformanceMeasurement(string, string) uid: '@azure/msal-browser.BrowserPerformanceMeasurement.constructor' 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,34 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function flushMeasurement(): number | null' + content: 'function flushMeasurement(): null | number' return: description: '' - type: number | null + 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: '' - isPreview: false isDeprecated: false syntax: content: function startMeasurement() @@ -62,7 +74,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function supportsBrowserPerformance(): boolean' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserProtocolUtils.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserProtocolUtils.yml deleted file mode 100644 index c446d82..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserProtocolUtils.yml +++ /dev/null @@ -1,52 +0,0 @@ -### YamlMime:TSType -name: BrowserProtocolUtils -uid: '@azure/msal-browser.BrowserProtocolUtils' -package: '@azure/msal-browser' -summary: '' -fullName: BrowserProtocolUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: 'extractBrowserRequestState(ICrypto, string)' - uid: '@azure/msal-browser.BrowserProtocolUtils.extractBrowserRequestState' - package: '@azure/msal-browser' - summary: Extracts the BrowserStateObject from the state string. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function extractBrowserRequestState(browserCrypto: ICrypto, - state: string): BrowserStateObject | null - parameters: - - id: browserCrypto - type: ICrypto - description: '' - - id: state - type: string - description: |+ - - return: - description: '' - type: | null - - name: parseServerResponseFromHash(string) - uid: '@azure/msal-browser.BrowserProtocolUtils.parseServerResponseFromHash' - package: '@azure/msal-browser' - summary: Parses properties of server response from url hash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function parseServerResponseFromHash(locationHash: string): - ServerAuthorizationCodeResponse - parameters: - - id: locationHash - type: string - description: | - Hash from url - return: - description: '' - type: ServerAuthorizationCodeResponse diff --git a/msal/docs-ref-autogen/@azure/msal-browser/BrowserStateObject.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserStateObject.yml deleted file mode 100644 index 0b5f714..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserStateObject.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: BrowserStateObject -uid: '@azure/msal-browser.BrowserStateObject' -package: '@azure/msal-browser' -summary: '' -fullName: BrowserStateObject -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type BrowserStateObject = { interactionType: InteractionType } 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 7fc4279..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/BrowserStringUtils.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserStringUtils.yml deleted file mode 100644 index c5de376..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml index f616882..d3b5f38 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserSystemOptions.yml @@ -5,22 +5,20 @@ package: '@azure/msal-browser' summary: '' fullName: BrowserSystemOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type BrowserSystemOptions = SystemOptions & { - 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, + allowPlatformBroker?: 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 index 1670031..c15135a 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserTelemetryOptions.yml @@ -5,7 +5,9 @@ package: '@azure/msal-browser' summary: Telemetry Options fullName: BrowserTelemetryOptions remarks: '' -isPreview: false isDeprecated: false syntax: | - type BrowserTelemetryOptions = { application?: ApplicationTelemetry } + 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 index a605091..3780403 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/BrowserUtils.yml @@ -1,80 +1,50 @@ -### YamlMime:TSType -name: BrowserUtils +### YamlMime:TSPackage uid: '@azure/msal-browser.BrowserUtils' +name: BrowserUtils +type: module package: '@azure/msal-browser' -summary: Utility class for browser specific functions -fullName: BrowserUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: +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: '' - isPreview: false isDeprecated: false syntax: - content: static function blockAcquireTokenInPopups() - - name: 'blockNativeBrokerCalledBeforeInitialized(boolean, boolean)' - uid: '@azure/msal-browser.BrowserUtils.blockNativeBrokerCalledBeforeInitialized' + content: function blockAcquireTokenInPopups() + - name: blockAPICallsBeforeInitialize(boolean) + uid: '@azure/msal-browser.BrowserUtils.blockAPICallsBeforeInitialize' package: '@azure/msal-browser' - summary: >- - Throws error if native brokering is enabled but initialize hasn't been - called + summary: Throws error if initialize hasn't been called remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static function - blockNativeBrokerCalledBeforeInitialized(allowNativeBroker: boolean, - initialized: boolean) + content: 'function blockAPICallsBeforeInitialize(initialized: boolean)' parameters: - - id: allowNativeBroker - type: boolean - description: '' - id: initialized type: boolean - description: |+ - - - name: blockNonBrowserEnvironment(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: '' - isPreview: false isDeprecated: false syntax: - content: >- - static function blockNonBrowserEnvironment(isBrowserEnvironment: - boolean) - parameters: - - id: isBrowserEnvironment - type: boolean - description: | - Flag indicating if environment is a browser. - - name: 'blockRedirectInIframe(InteractionType, boolean)' + 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: '' - isPreview: false isDeprecated: false syntax: - content: >- - static function blockRedirectInIframe(interactionType: InteractionType, - allowRedirectInIframe: boolean) + content: 'function blockRedirectInIframe(allowRedirectInIframe: boolean)' parameters: - - id: interactionType - type: - description: Interaction type for the request - id: allowRedirectInIframe type: boolean - description: | - Config value to allow redirects when app is inside an iframe + description: Config value to allow redirects when app is inside an iframe - name: blockReloadInHiddenIframes() uid: '@azure/msal-browser.BrowserUtils.blockReloadInHiddenIframes' package: '@azure/msal-browser' @@ -82,58 +52,40 @@ 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() + content: function blockReloadInHiddenIframes() - name: clearHash(Window) uid: '@azure/msal-browser.BrowserUtils.clearHash' package: '@azure/msal-browser' summary: Clears hash from window url. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function clearHash(contentWindow: Window)' + content: 'function clearHash(contentWindow: Window)' parameters: - id: contentWindow type: Window description: '' - - name: detectIEOrEdge() - uid: '@azure/msal-browser.BrowserUtils.detectIEOrEdge' + - name: createGuid() + uid: '@azure/msal-browser.BrowserUtils.createGuid' package: '@azure/msal-browser' - summary: >- - Returns boolean of whether current browser is an Internet Explorer or Edge - browser. + summary: Wrapper function that creates a UUID v7 from the current timestamp. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function detectIEOrEdge(): boolean' + content: 'function createGuid(): string' return: description: '' - type: boolean - - name: getBrowserNetworkClient() - uid: '@azure/msal-browser.BrowserUtils.getBrowserNetworkClient' - package: '@azure/msal-browser' - summary: Returns best compatible network client object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function getBrowserNetworkClient(): INetworkModule' - return: - description: '' - type: INetworkModule + type: string - name: getCurrentUri() uid: '@azure/msal-browser.BrowserUtils.getCurrentUri' package: '@azure/msal-browser' summary: Returns current window URL as redirect uri remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function getCurrentUri(): string' + content: 'function getCurrentUri(): string' return: description: '' type: string @@ -142,10 +94,9 @@ 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' + content: 'function getHomepage(): string' return: description: '' type: string @@ -154,10 +105,9 @@ 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' + content: 'function isInIframe(): boolean' return: description: '' type: boolean @@ -168,22 +118,63 @@ 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' + 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: '' - isPreview: false isDeprecated: false syntax: - content: 'static function replaceHash(url: string)' + content: 'function replaceHash(url: string)' parameters: - id: url type: string diff --git a/msal/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml b/msal/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml index fad71a3..c18d2a1 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/CacheLookupPolicy.yml @@ -1,40 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: CacheLookupPolicy uid: '@azure/msal-browser.CacheLookupPolicy' package: '@azure/msal-browser' summary: '' fullName: CacheLookupPolicy remarks: '' -isPreview: false isDeprecated: false -fields: - - name: Default - uid: '@azure/msal-browser.CacheLookupPolicy.Default' - package: '@azure/msal-browser' - summary: '' - numericValue: 0 - - name: AccessToken - uid: '@azure/msal-browser.CacheLookupPolicy.AccessToken' - package: '@azure/msal-browser' - summary: '' - numericValue: 1 - - name: AccessTokenAndRefreshToken - uid: '@azure/msal-browser.CacheLookupPolicy.AccessTokenAndRefreshToken' - package: '@azure/msal-browser' - summary: '' - numericValue: 2 - - name: RefreshToken - uid: '@azure/msal-browser.CacheLookupPolicy.RefreshToken' - package: '@azure/msal-browser' - summary: '' - numericValue: 3 - - name: RefreshTokenAndNetwork - uid: '@azure/msal-browser.CacheLookupPolicy.RefreshTokenAndNetwork' - package: '@azure/msal-browser' - summary: '' - numericValue: 4 - - name: Skip - uid: '@azure/msal-browser.CacheLookupPolicy.Skip' - package: '@azure/msal-browser' - summary: '' - numericValue: 5 +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 index 5a0c652..f4c5863 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/CacheOptions.yml @@ -5,11 +5,13 @@ package: '@azure/msal-browser' summary: 'Use this to configure the below cache configuration options:' fullName: CacheOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type CacheOptions = { - cacheLocation?: BrowserCacheLocation | string, - secureCookies?: boolean, - storeAuthStateInCookie?: boolean, + cacheLocation?: BrowserCacheLocation | string + cacheMigrationEnabled?: boolean + claimsBasedCachingEnabled?: boolean + secureCookies?: boolean + storeAuthStateInCookie?: boolean + temporaryCacheLocation?: BrowserCacheLocation | string } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/CachedKeyPair.yml b/msal/docs-ref-autogen/@azure/msal-browser/CachedKeyPair.yml deleted file mode 100644 index 3346eba..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/CachedKeyPair.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: CachedKeyPair -uid: '@azure/msal-browser.CachedKeyPair' -package: '@azure/msal-browser' -summary: '' -fullName: CachedKeyPair -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type CachedKeyPair = { - privateKey: CryptoKey, - publicKey: CryptoKey, - requestMethod?: string, - requestUri?: 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 index 0dcf1d0..059fed4 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/Configuration.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/Configuration.yml @@ -7,12 +7,11 @@ summary: >- and is passed into the constructor of PublicClientApplication fullName: Configuration remarks: '' -isPreview: false isDeprecated: false syntax: | type Configuration = { - auth: BrowserAuthOptions, - cache?: CacheOptions, - system?: BrowserSystemOptions, - telemetry?: BrowserTelemetryOptions, + auth: BrowserAuthOptions + cache?: CacheOptions + system?: BrowserSystemOptions + telemetry?: BrowserTelemetryOptions } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/CryptoKeyStore.yml b/msal/docs-ref-autogen/@azure/msal-browser/CryptoKeyStore.yml deleted file mode 100644 index 4fa9db8..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/CryptoKeyStoreNames.yml b/msal/docs-ref-autogen/@azure/msal-browser/CryptoKeyStoreNames.yml deleted file mode 100644 index e7c172a..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/CryptoOps.yml b/msal/docs-ref-autogen/@azure/msal-browser/CryptoOps.yml deleted file mode 100644 index dbc4fe0..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/CryptoOps.yml +++ /dev/null @@ -1,188 +0,0 @@ -### YamlMime:TSType -name: CryptoOps -uid: '@azure/msal-browser.CryptoOps' -package: '@azure/msal-browser' -summary: >- - This class implements MSAL'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: CryptoOps -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'CryptoOps(Logger, IPerformanceClient, CryptoOptions)' - uid: '@azure/msal-browser.CryptoOps.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new CryptoOps(logger: Logger, performanceClient?: IPerformanceClient, - cryptoConfig?: CryptoOptions) - parameters: - - id: logger - type: Logger - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: cryptoConfig - type: - description: '' -methods: - - name: base64Decode(string) - uid: '@azure/msal-browser.CryptoOps.base64Decode' - package: '@azure/msal-browser' - summary: Decodes input string from base64. - remarks: '' - isPreview: false - 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-browser.CryptoOps.base64Encode' - package: '@azure/msal-browser' - summary: Encodes input string to base64. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function base64Encode(input: string): string' - parameters: - - id: input - type: string - description: |+ - - return: - description: '' - type: string - - name: clearKeystore() - uid: '@azure/msal-browser.CryptoOps.clearKeystore' - package: '@azure/msal-browser' - summary: Removes all cryptographic keys from IndexedDB storage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function clearKeystore(): Promise' - return: - description: '' - type: Promise<boolean> - - name: createNewGuid() - uid: '@azure/msal-browser.CryptoOps.createNewGuid' - 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' - return: - description: string (GUID) - type: string - - name: generatePkceCodes() - uid: '@azure/msal-browser.CryptoOps.generatePkceCodes' - package: '@azure/msal-browser' - summary: Generates PKCE codes used in Authorization Code Flow. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generatePkceCodes(): Promise' - return: - description: '' - type: Promise<PkceCodes> - - name: getPublicKeyThumbprint(SignedHttpRequestParameters) - uid: '@azure/msal-browser.CryptoOps.getPublicKeyThumbprint' - package: '@azure/msal-browser' - summary: 'Generates a keypair, stores it and returns a thumbprint' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getPublicKeyThumbprint(request: SignedHttpRequestParameters): - Promise - parameters: - - id: request - type: SignedHttpRequestParameters - description: |+ - - return: - description: '' - type: Promise<string> - - name: hashString(string) - uid: '@azure/msal-browser.CryptoOps.hashString' - 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' - parameters: - - id: plainText - type: string - description: |+ - - return: - description: '' - type: Promise<string> - - name: removeTokenBindingKey(string) - uid: '@azure/msal-browser.CryptoOps.removeTokenBindingKey' - 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' - parameters: - - id: kid - type: string - description: |+ - - return: - description: '' - type: Promise<boolean> - - name: 'signJwt(SignedHttpRequest, string, string)' - uid: '@azure/msal-browser.CryptoOps.signJwt' - package: '@azure/msal-browser' - summary: >- - Signs the given object as a jwt payload with private key retrieved by - given kid. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function signJwt(payload: SignedHttpRequest, kid: string, - correlationId?: string): Promise - parameters: - - id: payload - type: - description: '' - - id: kid - type: string - description: |+ - - - id: correlationId - type: string - description: '' - return: - description: '' - type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/CryptoOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/CryptoOptions.yml deleted file mode 100644 index 60d6dfe..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/CryptoOptions.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: CryptoOptions -uid: '@azure/msal-browser.CryptoOptions' -package: '@azure/msal-browser' -summary: '' -fullName: CryptoOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type CryptoOptions = { entropy?: Uint8Array, useMsrCrypto?: boolean } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/DatabaseStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/DatabaseStorage.yml deleted file mode 100644 index 9394657..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml index 67c2a44..7e438ad 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/EndSessionPopupRequest.yml @@ -27,13 +27,18 @@ 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: '' -isPreview: false isDeprecated: false syntax: | - type EndSessionPopupRequest = Partial & { - authority?: string, - mainWindowRedirectUri?: string, - popupWindowAttributes?: PopupWindowAttributes, + type EndSessionPopupRequest = Partial< + Omit + > & { + authority?: string + mainWindowRedirectUri?: string + popupWindowAttributes?: PopupWindowAttributes + popupWindowParent?: Window } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml index f22b00f..1d8283a 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EndSessionRequest.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml index 1468512..43067a3 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventCallbackFunction.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-browser/EventError.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventError.yml index 45d042a..97b16ca 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventError.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml index 7bc4572..e87f6d6 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml @@ -5,63 +5,54 @@ package: '@azure/msal-browser' summary: '' fullName: EventHandler remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'EventHandler(Logger, ICrypto)' + - name: EventHandler(Logger) uid: '@azure/msal-browser.EventHandler.constructor' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new EventHandler(logger: Logger, browserCrypto: ICrypto)' + content: 'new EventHandler(logger?: Logger)' parameters: - id: logger - type: Logger - description: '' - - id: browserCrypto - type: ICrypto + type: description: '' methods: - - name: addEventCallback(EventCallbackFunction) + - name: addEventCallback(EventCallbackFunction, EventType[], string) uid: '@azure/msal-browser.EventHandler.addEventCallback' package: '@azure/msal-browser' summary: Adds event callbacks to array remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function addEventCallback(callback: EventCallbackFunction): string | - null + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[], callbackId?: string): null | string parameters: - id: callback type: - description: |+ - + 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: string | null - - name: disableAccountStorageEvents() - uid: '@azure/msal-browser.EventHandler.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: '' - isPreview: false - isDeprecated: false - syntax: - content: function disableAccountStorageEvents() - - name: 'emitEvent(EventType, InteractionType, EventPayload, EventError)' + 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -69,7 +60,7 @@ methods: InteractionType, payload?: EventPayload, error?: EventError) parameters: - id: eventType - type: + type: EventType description: '' - id: interactionType type: @@ -79,30 +70,32 @@ methods: description: '' - id: error type: - description: |+ - - - name: enableAccountStorageEvents() - uid: '@azure/msal-browser.EventHandler.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: '' - isPreview: false - isDeprecated: false - syntax: - content: function enableAccountStorageEvents() + description: '' - name: removeEventCallback(string) uid: '@azure/msal-browser.EventHandler.removeEventCallback' package: '@azure/msal-browser' summary: Removes callback with provided id from callback array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeEventCallback(callbackId: string)' parameters: - id: callbackId type: string - description: |+ - + 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/EventMessage.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml index c30fc3d..4d17ab8 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml @@ -5,13 +5,12 @@ package: '@azure/msal-browser' summary: '' fullName: EventMessage remarks: '' -isPreview: false isDeprecated: false syntax: | type EventMessage = { - error: EventError, - eventType: EventType, - interactionType: InteractionType | null, - payload: EventPayload, - timestamp: number, + 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 index c272a3c..8bfd1be 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventMessageUtils.yml @@ -5,29 +5,26 @@ package: '@azure/msal-browser' summary: '' fullName: EventMessageUtils remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'getInteractionStatusFromEvent(EventMessage, InteractionStatus)' + - name: getInteractionStatusFromEvent(EventMessage, InteractionStatus) uid: '@azure/msal-browser.EventMessageUtils.getInteractionStatusFromEvent' package: '@azure/msal-browser' summary: Gets interaction status from event message remarks: '' - isPreview: false isDeprecated: false syntax: content: >- static function getInteractionStatusFromEvent(message: EventMessage, - currentStatus?: InteractionStatus): InteractionStatus | null + currentStatus?: InteractionStatus): null | InteractionStatus parameters: - id: message type: description: '' - id: currentStatus - type: - description: |+ - + type: InteractionStatus + description: '' return: description: '' - type: | null + 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 index 8a18b74..de8c150 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventPayload.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-browser/EventType.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventType.yml index 613ccff..e9f2d79 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventType.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventType.yml @@ -1,106 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: EventType uid: '@azure/msal-browser.EventType' package: '@azure/msal-browser' summary: '' fullName: EventType remarks: '' -isPreview: false isDeprecated: false -fields: - - name: ACCOUNT_ADDED - uid: '@azure/msal-browser.EventType.ACCOUNT_ADDED' - package: '@azure/msal-browser' - summary: '' - - name: ACCOUNT_REMOVED - uid: '@azure/msal-browser.EventType.ACCOUNT_REMOVED' - package: '@azure/msal-browser' - summary: '' - - name: ACQUIRE_TOKEN_BY_CODE_FAILURE - uid: '@azure/msal-browser.EventType.ACQUIRE_TOKEN_BY_CODE_FAILURE' - package: '@azure/msal-browser' - summary: '' - - name: ACQUIRE_TOKEN_BY_CODE_START - uid: '@azure/msal-browser.EventType.ACQUIRE_TOKEN_BY_CODE_START' - package: '@azure/msal-browser' - summary: '' - - name: ACQUIRE_TOKEN_BY_CODE_SUCCESS - uid: '@azure/msal-browser.EventType.ACQUIRE_TOKEN_BY_CODE_SUCCESS' - package: '@azure/msal-browser' - summary: '' - - name: ACQUIRE_TOKEN_FAILURE - uid: '@azure/msal-browser.EventType.ACQUIRE_TOKEN_FAILURE' - package: '@azure/msal-browser' - summary: '' - - name: ACQUIRE_TOKEN_NETWORK_START - uid: '@azure/msal-browser.EventType.ACQUIRE_TOKEN_NETWORK_START' - package: '@azure/msal-browser' - summary: '' - - name: ACQUIRE_TOKEN_START - uid: '@azure/msal-browser.EventType.ACQUIRE_TOKEN_START' - package: '@azure/msal-browser' - summary: '' - - name: ACQUIRE_TOKEN_SUCCESS - uid: '@azure/msal-browser.EventType.ACQUIRE_TOKEN_SUCCESS' - package: '@azure/msal-browser' - summary: '' - - name: HANDLE_REDIRECT_END - uid: '@azure/msal-browser.EventType.HANDLE_REDIRECT_END' - package: '@azure/msal-browser' - summary: '' - - name: HANDLE_REDIRECT_START - uid: '@azure/msal-browser.EventType.HANDLE_REDIRECT_START' - package: '@azure/msal-browser' - summary: '' - - name: INITIALIZE_END - uid: '@azure/msal-browser.EventType.INITIALIZE_END' - package: '@azure/msal-browser' - summary: '' - - name: INITIALIZE_START - uid: '@azure/msal-browser.EventType.INITIALIZE_START' - package: '@azure/msal-browser' - summary: '' - - name: LOGIN_FAILURE - uid: '@azure/msal-browser.EventType.LOGIN_FAILURE' - package: '@azure/msal-browser' - summary: '' - - name: LOGIN_START - uid: '@azure/msal-browser.EventType.LOGIN_START' - package: '@azure/msal-browser' - summary: '' - - name: LOGIN_SUCCESS - uid: '@azure/msal-browser.EventType.LOGIN_SUCCESS' - package: '@azure/msal-browser' - summary: '' - - name: LOGOUT_END - uid: '@azure/msal-browser.EventType.LOGOUT_END' - package: '@azure/msal-browser' - summary: '' - - name: LOGOUT_FAILURE - uid: '@azure/msal-browser.EventType.LOGOUT_FAILURE' - package: '@azure/msal-browser' - summary: '' - - name: LOGOUT_START - uid: '@azure/msal-browser.EventType.LOGOUT_START' - package: '@azure/msal-browser' - summary: '' - - name: LOGOUT_SUCCESS - uid: '@azure/msal-browser.EventType.LOGOUT_SUCCESS' - package: '@azure/msal-browser' - summary: '' - - name: POPUP_OPENED - uid: '@azure/msal-browser.EventType.POPUP_OPENED' - package: '@azure/msal-browser' - summary: '' - - name: SSO_SILENT_FAILURE - uid: '@azure/msal-browser.EventType.SSO_SILENT_FAILURE' - package: '@azure/msal-browser' - summary: '' - - name: SSO_SILENT_START - uid: '@azure/msal-browser.EventType.SSO_SILENT_START' - package: '@azure/msal-browser' - summary: '' - - name: SSO_SILENT_SUCCESS - uid: '@azure/msal-browser.EventType.SSO_SILENT_SUCCESS' - package: '@azure/msal-browser' - summary: '' +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..d8cc8ec --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ExternalTokenResponse.yml @@ -0,0 +1,39 @@ +### 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" + | "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/FetchClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/FetchClient.yml deleted file mode 100644 index 50db09b..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/GuidGenerator.yml b/msal/docs-ref-autogen/@azure/msal-browser/GuidGenerator.yml deleted file mode 100644 index 887e407..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/HTTP_REQUEST_TYPE.yml b/msal/docs-ref-autogen/@azure/msal-browser/HTTP_REQUEST_TYPE.yml deleted file mode 100644 index 6be7fef..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/HTTP_REQUEST_TYPE.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: HTTP_REQUEST_TYPE -uid: '@azure/msal-browser.HTTP_REQUEST_TYPE' -package: '@azure/msal-browser' -summary: HTTP Request types supported by MSAL. -fullName: HTTP_REQUEST_TYPE -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: GET - uid: '@azure/msal-browser.HTTP_REQUEST_TYPE.GET' - package: '@azure/msal-browser' - summary: '' - - name: POST - uid: '@azure/msal-browser.HTTP_REQUEST_TYPE.POST' - package: '@azure/msal-browser' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/HybridSpaAuthorizationCodeClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/HybridSpaAuthorizationCodeClient.yml deleted file mode 100644 index a93fa8a..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/IAsyncStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/IAsyncStorage.yml deleted file mode 100644 index 2a3325e..0000000 --- a/msal/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/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..608f55c --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/IController.yml @@ -0,0 +1,543 @@ +### 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 | + Partial>, ApiId, string) + uid: '@azure/msal-browser.IController.acquireTokenNative' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function acquireTokenNative(request: PopupRequest | SilentRequest | + Partial>, apiId: ApiId, accountId?: string): + Promise + parameters: + - id: request + type: >- + | | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> + 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, EventType[]) + uid: '@azure/msal-browser.IController.addEventCallback' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[]): null | string + parameters: + - id: callback + type: + description: '' + - id: eventTypes + type: EventType[] + 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 | Partial>) + uid: '@azure/msal-browser.IController.hydrateCache' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function hydrateCache(result: AuthenticationResult, request: + PopupRequest | RedirectRequest | SilentRequest | + Partial>): Promise + parameters: + - id: result + type: + description: '' + - id: request + type: >- + | | | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> + description: '' + return: + description: '' + type: Promise<void> + - name: initialize(InitializeApplicationRequest) + uid: '@azure/msal-browser.IController.initialize' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function initialize(request?: InitializeApplicationRequest): + Promise + parameters: + - id: request + type: + description: '' + 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(Partial>) + uid: '@azure/msal-browser.IController.ssoSilent' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function ssoSilent(request: Partial>): + Promise + parameters: + - id: request + type: >- + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> + description: '' + return: + description: '' + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal/ILoggerCallback.yml b/msal/docs-ref-autogen/@azure/msal-browser/ILoggerCallback.yml similarity index 63% rename from msal/docs-ref-autogen/@azure/msal/ILoggerCallback.yml rename to msal/docs-ref-autogen/@azure/msal-browser/ILoggerCallback.yml index b658672..537e161 100644 --- a/msal/docs-ref-autogen/@azure/msal/ILoggerCallback.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ILoggerCallback.yml @@ -1,10 +1,9 @@ ### YamlMime:TSType name: ILoggerCallback -uid: '@azure/msal.ILoggerCallback' -package: '@azure/msal' +uid: '@azure/msal-browser.ILoggerCallback' +package: '@azure/msal-browser' summary: '' fullName: ILoggerCallback remarks: '' -isPreview: false 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 index 6be5efc..d9f8dbb 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/INavigationClient.yml @@ -5,18 +5,16 @@ package: '@azure/msal-browser' summary: '' fullName: INavigationClient remarks: '' -isPreview: false isDeprecated: false type: interface methods: - - name: 'navigateExternal(string, NavigationOptions)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -28,12 +26,11 @@ methods: description: '' - id: options type: - description: |+ - + description: '' return: description: '' type: Promise<boolean> - - name: 'navigateInternal(string, NavigationOptions)' + - name: navigateInternal(string, NavigationOptions) uid: '@azure/msal-browser.INavigationClient.navigateInternal' package: '@azure/msal-browser' summary: >- @@ -42,7 +39,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: >- @@ -54,8 +50,7 @@ methods: description: '' - id: options type: - description: |+ - + 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..4d024b8 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml @@ -0,0 +1,61 @@ +### 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, timeout?: number): Promise> + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + - id: timeout + 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 index 7e1474d..a8e0d21 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IPublicClientApplication.yml +++ b/msal/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: >- @@ -26,13 +24,12 @@ methods: description: '' return: description: '' - type: Promise<AuthenticationResult> + type: Promise<> - name: acquireTokenPopup(PopupRequest) uid: '@azure/msal-browser.IPublicClientApplication.acquireTokenPopup' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -44,13 +41,12 @@ methods: description: '' return: description: '' - type: Promise<AuthenticationResult> + type: Promise<> - name: acquireTokenRedirect(RedirectRequest) uid: '@azure/msal-browser.IPublicClientApplication.acquireTokenRedirect' 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: >- @@ -78,29 +73,32 @@ methods: description: '' return: description: '' - type: Promise<AuthenticationResult> - - name: addEventCallback(Function) + type: Promise<> + - name: addEventCallback(EventCallbackFunction, EventType[]) uid: '@azure/msal-browser.IPublicClientApplication.addEventCallback' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function addEventCallback(callback: Function): string | null' + content: >- + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[]): null | string parameters: - id: callback - type: Function + type: + description: '' + - id: eventTypes + type: EventType[] description: '' return: description: '' - type: string | null + type: null | string - name: addPerformanceCallback(PerformanceCallbackFunction) uid: '@azure/msal-browser.IPublicClientApplication.addPerformanceCallback' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -108,17 +106,31 @@ methods: string parameters: - id: callback - type: PerformanceCallbackFunction + 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: '' - isPreview: false isDeprecated: false syntax: content: function disableAccountStorageEvents() @@ -127,112 +139,107 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false 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' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getAccountByHomeId(homeAccountId: string): AccountInfo | null' + content: 'function getAccountByHomeId(homeAccountId: string): null | AccountInfo' parameters: - id: homeAccountId type: string description: '' return: description: '' - type: AccountInfo | null + type: null | - name: getAccountByLocalId(string) uid: '@azure/msal-browser.IPublicClientApplication.getAccountByLocalId' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getAccountByLocalId(localId: string): AccountInfo | null' + content: 'function getAccountByLocalId(localId: string): null | AccountInfo' parameters: - id: localId type: string description: '' return: description: '' - type: AccountInfo | null + type: null | - name: getAccountByUsername(string) uid: '@azure/msal-browser.IPublicClientApplication.getAccountByUsername' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getAccountByUsername(userName: string): AccountInfo | null' + content: 'function getAccountByUsername(userName: string): null | AccountInfo' parameters: - id: userName type: string description: '' return: description: '' - type: AccountInfo | null + type: null | - name: getActiveAccount() uid: '@azure/msal-browser.IPublicClientApplication.getActiveAccount' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getActiveAccount(): AccountInfo | null' + content: 'function getActiveAccount(): null | AccountInfo' return: description: '' - type: AccountInfo | null + type: null | - name: getAllAccounts() uid: '@azure/msal-browser.IPublicClientApplication.getAllAccounts' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): AccountInfo[]' return: description: '' - type: 'AccountInfo[]' - - name: getConfiguration() - uid: '@azure/msal-browser.IPublicClientApplication.getConfiguration' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getConfiguration(): BrowserConfiguration' - return: - description: '' - type: + type: [] - name: getLogger() uid: '@azure/msal-browser.IPublicClientApplication.getLogger' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' return: description: '' - type: Logger + type: - name: getTokenCache() uid: '@azure/msal-browser.IPublicClientApplication.getTokenCache' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): ITokenCache' @@ -244,43 +251,82 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function handleRedirectPromise(hash?: string): - Promise + function handleRedirectPromise(hash?: string): Promise parameters: - id: hash type: string description: '' return: description: '' - type: Promise<AuthenticationResult | null> - - name: initialize() + type: >- + Promise<null | > + - name: >- + hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | + SilentRequest | Partial>) + uid: '@azure/msal-browser.IPublicClientApplication.hydrateCache' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + function hydrateCache(result: AuthenticationResult, request: + PopupRequest | RedirectRequest | SilentRequest | + Partial>): Promise + parameters: + - id: result + type: + description: '' + - id: request + type: >- + | | | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> + description: '' + return: + description: '' + type: Promise<void> + - name: initialize(InitializeApplicationRequest) uid: '@azure/msal-browser.IPublicClientApplication.initialize' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function initialize(): Promise' + content: >- + function initialize(request?: InitializeApplicationRequest): + Promise + parameters: + - id: request + type: + description: '' return: description: '' type: Promise<void> - - name: 'initializeWrapperLibrary(WrapperSKU, string)' + - name: initializeWrapperLibrary(WrapperSKU, string) uid: '@azure/msal-browser.IPublicClientApplication.initializeWrapperLibrary' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' parameters: - id: sku - type: + type: WrapperSKU description: '' - id: version type: string @@ -290,7 +336,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -302,13 +347,12 @@ methods: description: '' return: description: '' - type: Promise<AuthenticationResult> + type: Promise<> - name: loginRedirect(RedirectRequest) uid: '@azure/msal-browser.IPublicClientApplication.loginRedirect' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function loginRedirect(request?: RedirectRequest): Promise' @@ -324,7 +368,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function logout(logoutRequest?: EndSessionRequest): Promise' @@ -340,7 +383,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -358,7 +400,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -376,7 +417,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeEventCallback(callbackId: string)' @@ -389,7 +429,6 @@ methods: package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -400,38 +439,35 @@ methods: return: description: '' type: boolean - - name: setActiveAccount(AccountInfo | null) + - name: setActiveAccount(null | AccountInfo) uid: '@azure/msal-browser.IPublicClientApplication.setActiveAccount' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function setActiveAccount(account: AccountInfo | null)' + content: 'function setActiveAccount(account: null | AccountInfo)' parameters: - id: account - type: AccountInfo | null + type: null | description: '' - name: setLogger(Logger) uid: '@azure/msal-browser.IPublicClientApplication.setLogger' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' parameters: - id: logger - type: Logger + type: description: '' - name: setNavigationClient(INavigationClient) uid: '@azure/msal-browser.IPublicClientApplication.setNavigationClient' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setNavigationClient(navigationClient: INavigationClient)' @@ -439,21 +475,29 @@ methods: - id: navigationClient type: description: '' - - name: ssoSilent(SsoSilentRequest) + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-browser.IPublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false 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: '' - type: Promise<AuthenticationResult> + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ISubtleCrypto.yml b/msal/docs-ref-autogen/@azure/msal-browser/ISubtleCrypto.yml deleted file mode 100644 index 8e75141..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml b/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml index 295692e..8b10b94 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/ITokenCache.yml @@ -5,31 +5,30 @@ package: '@azure/msal-browser' summary: '' fullName: ITokenCache remarks: '' -isPreview: false isDeprecated: false type: interface methods: - - name: 'loadExternalTokens(SilentRequest, ExternalTokenResponse, LoadTokenOptions)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- function loadExternalTokens(request: SilentRequest, response: - ExternalTokenResponse, options: LoadTokenOptions): AuthenticationResult + ExternalTokenResponse, options: LoadTokenOptions): + Promise parameters: - id: request type: description: '' - id: response - type: ExternalTokenResponse + type: description: '' - id: options type: description: '' return: description: '`AuthenticationResult` for the response that was loaded.' - type: AuthenticationResult + 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 03bcd05..1ac6c06 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/IWindowStorage.yml +++ b/msal/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,15 +13,13 @@ 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' parameters: - id: key type: string - description: |+ - + description: '' return: description: '' type: boolean @@ -31,18 +28,16 @@ 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' + content: 'function getItem(key: string): null | T' parameters: - id: key type: string - description: |+ - + description: '' return: description: '' - type: T | null + type: null | T - name: getKeys() uid: '@azure/msal-browser.IWindowStorage.getKeys' package: '@azure/msal-browser' @@ -50,33 +45,59 @@ 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[]' return: description: '' - type: 'string[]' + 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' summary: Removes the item in the window storage object matching the given key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeItem(key: string)' parameters: - id: key type: string - description: |+ - - - name: 'setItem(string, T)' + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function setItem(key: string, value: T)' @@ -86,5 +107,27 @@ methods: description: '' - id: value type: T - description: |+ - + 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/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/InMemoryCacheKeys.yml b/msal/docs-ref-autogen/@azure/msal-browser/InMemoryCacheKeys.yml deleted file mode 100644 index d426ead..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/InMemoryCacheKeys.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: InMemoryCacheKeys -uid: '@azure/msal-browser.InMemoryCacheKeys' -package: '@azure/msal-browser' -summary: Cache keys stored in-memory -fullName: InMemoryCacheKeys -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: WRAPPER_SKU - uid: '@azure/msal-browser.InMemoryCacheKeys.WRAPPER_SKU' - package: '@azure/msal-browser' - summary: '' - - name: WRAPPER_VER - uid: '@azure/msal-browser.InMemoryCacheKeys.WRAPPER_VER' - package: '@azure/msal-browser' - summary: '' 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/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/InteractionHandler.yml b/msal/docs-ref-autogen/@azure/msal-browser/InteractionHandler.yml deleted file mode 100644 index 16e36a4..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/InteractionHandler.yml +++ /dev/null @@ -1,104 +0,0 @@ -### YamlMime:TSType -name: InteractionHandler -uid: '@azure/msal-browser.InteractionHandler' -package: '@azure/msal-browser' -summary: >- - Abstract class which defines operations for a browser interaction handling - class. -fullName: InteractionHandler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - InteractionHandler(AuthorizationCodeClient, BrowserCacheManager, - CommonAuthorizationCodeRequest, Logger) - 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) - parameters: - - id: authCodeModule - type: AuthorizationCodeClient - description: '' - - id: storageImpl - type: - description: '' - - id: authCodeRequest - type: CommonAuthorizationCodeRequest - description: '' - - id: logger - type: Logger - 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: >- - 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> - - name: >- - handleCodeResponseFromServer(AuthorizationCodePayload, string, Authority, - INetworkModule, boolean) - uid: '@azure/msal-browser.InteractionHandler.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> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/InteractionParams.yml b/msal/docs-ref-autogen/@azure/msal-browser/InteractionParams.yml deleted file mode 100644 index 5543676..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/InteractionParams.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: InteractionParams -uid: '@azure/msal-browser.InteractionParams' -package: '@azure/msal-browser' -summary: '' -fullName: InteractionParams -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type InteractionParams = Object 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..146217a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/InteractionRequiredAuthError.yml @@ -0,0 +1,290 @@ +### 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, 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, errorNo?: 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: '' + - id: errorNo + 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: 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' + 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 index 176b96a..27becd7 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/InteractionStatus.yml @@ -1,42 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: InteractionStatus uid: '@azure/msal-browser.InteractionStatus' package: '@azure/msal-browser' -summary: >- - Types of interaction currently in progress. - - Used in events in wrapper libraries to invoke functions when certain - interaction is in progress or all interactions are complete. +summary: '' fullName: InteractionStatus remarks: '' -isPreview: false isDeprecated: false -fields: - - name: AcquireToken - uid: '@azure/msal-browser.InteractionStatus.AcquireToken' - package: '@azure/msal-browser' - summary: Status set for acquireToken calls - - name: HandleRedirect - uid: '@azure/msal-browser.InteractionStatus.HandleRedirect' - package: '@azure/msal-browser' - summary: Status set when handleRedirect in progress - - name: Login - uid: '@azure/msal-browser.InteractionStatus.Login' - package: '@azure/msal-browser' - summary: Status set when all login calls occuring - - name: Logout - uid: '@azure/msal-browser.InteractionStatus.Logout' - package: '@azure/msal-browser' - summary: Status set when logout call occuring - - name: None - uid: '@azure/msal-browser.InteractionStatus.None' - package: '@azure/msal-browser' - summary: Status set when interaction is complete - - name: SsoSilent - uid: '@azure/msal-browser.InteractionStatus.SsoSilent' - package: '@azure/msal-browser' - summary: Status set for ssoSilent calls - - name: Startup - uid: '@azure/msal-browser.InteractionStatus.Startup' - package: '@azure/msal-browser' - summary: Initial status before interaction occurs +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 index 9a5d982..70c9654 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/InteractionType.yml +++ b/msal/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/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 index 426e4d2..41bd5dc 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/LoadTokenOptions.yml @@ -5,11 +5,10 @@ package: '@azure/msal-browser' summary: '' fullName: LoadTokenOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type LoadTokenOptions = { - clientInfo?: string, - expiresOn?: number, - extendedExpiresOn?: number, + clientInfo?: string + expiresOn?: number + extendedExpiresOn?: number } 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..b29c698 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/LocalStorage.yml @@ -0,0 +1,162 @@ +### YamlMime:TSType +name: LocalStorage +uid: '@azure/msal-browser.LocalStorage' +package: '@azure/msal-browser' +summary: '' +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' + 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: 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' + 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: '' + - 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/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/MATS.yml b/msal/docs-ref-autogen/@azure/msal-browser/MATS.yml deleted file mode 100644 index 1e3d54f..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/MATS.yml +++ /dev/null @@ -1,29 +0,0 @@ -### YamlMime:TSTypeAlias -name: MATS -uid: '@azure/msal-browser.MATS' -package: '@azure/msal-browser' -summary: >- - The native token broker can optionally include additional information about - operations it performs. If that data is returned, MSAL.js will include the - following properties in the telemetry it collects. -fullName: MATS -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type MATS = { - account_join_on_end?: string, - account_join_on_start?: string, - api_error_code?: number, - broker_version?: string, - device_join?: string, - http_event_count?: number, - http_status?: number, - is_cached?: number, - prompt_behavior?: string, - silent_bi_sub_code?: number, - silent_code?: number, - silent_message?: string, - silent_status?: number, - ui_visible?: boolean, - } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/MathUtils.yml b/msal/docs-ref-autogen/@azure/msal-browser/MathUtils.yml deleted file mode 100644 index c3822ae..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml index d385603..ae90452 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/MemoryStorage.yml @@ -5,35 +5,22 @@ package: '@azure/msal-browser' summary: '' fullName: MemoryStorage remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: MemoryStorage() - uid: '@azure/msal-browser.MemoryStorage.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new MemoryStorage() methods: - name: clear() uid: '@azure/msal-browser.MemoryStorage.clear' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: function clear() - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function containsKey(key: string): boolean' @@ -47,37 +34,62 @@ 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: '' - isPreview: false isDeprecated: false syntax: - content: 'function getItem(key: string): T | null' + content: 'function getItem(key: string): null | T' parameters: - id: key type: string description: '' return: description: '' - type: T | null + type: null | T - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function getKeys(): string[]' return: description: '' - type: 'string[]' + 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' - summary: '' + summary: Removes the item in the window storage object matching the given key. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeItem(key: string)' @@ -85,12 +97,11 @@ methods: - id: key type: string description: '' - - name: 'setItem(string, T)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function setItem(key: string, value: T)' @@ -101,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/ModernBrowserCrypto.yml b/msal/docs-ref-autogen/@azure/msal-browser/ModernBrowserCrypto.yml deleted file mode 100644 index 76b0b9f..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/MsBrowserCrypto.yml b/msal/docs-ref-autogen/@azure/msal-browser/MsBrowserCrypto.yml deleted file mode 100644 index a137998..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/MsrBrowserCrypto.yml b/msal/docs-ref-autogen/@azure/msal-browser/MsrBrowserCrypto.yml deleted file mode 100644 index 55221b3..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/NativeAccountInfo.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeAccountInfo.yml deleted file mode 100644 index abe7baf..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeAccountInfo.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: NativeAccountInfo -uid: '@azure/msal-browser.NativeAccountInfo' -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/msal/docs-ref-autogen/@azure/msal-browser/NativeAuthError.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeAuthError.yml deleted file mode 100644 index 678f784..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeAuthError.yml +++ /dev/null @@ -1,263 +0,0 @@ -### YamlMime:TSType -name: NativeAuthError -uid: '@azure/msal-browser.NativeAuthError' -package: '@azure/msal-browser' -summary: '' -fullName: NativeAuthError -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'NativeAuthError(string, string, OSError)' - uid: '@azure/msal-browser.NativeAuthError.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new NativeAuthError(errorCode: string, description: string, ext?: - OSError) - parameters: - - id: errorCode - type: string - description: '' - - id: description - type: string - description: '' - - id: ext - type: - description: '' -properties: - - name: ext - uid: '@azure/msal-browser.NativeAuthError.ext' - package: '@azure/msal-browser' - summary: '' - fullName: ext - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'ext: OSError | undefined' - return: - description: '' - type: | undefined -inheritedProperties: - - name: correlationId - uid: '@azure/msal-browser.NativeAuthError.correlationId' - package: '@azure/msal-browser' - 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-browser.NativeAuthError.errorCode' - package: '@azure/msal-browser' - 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-browser.NativeAuthError.errorMessage' - package: '@azure/msal-browser' - 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-browser.NativeAuthError.message' - package: '@azure/msal-browser' - 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-browser.NativeAuthError.name' - package: '@azure/msal-browser' - 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-browser.NativeAuthError.stack' - package: '@azure/msal-browser' - 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-browser.NativeAuthError.subError' - package: '@azure/msal-browser' - 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-browser.NativeAuthError.createPostRequestFailed' - 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' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: AuthError - inheritanceDescription: Inherited From AuthError.createPostRequestFailed - - name: createUnexpectedError(string) - uid: '@azure/msal-browser.NativeAuthError.createUnexpectedError' - package: '@azure/msal-browser' - 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-browser.NativeAuthError.setCorrelationId' - package: '@azure/msal-browser' - 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: 'createError(string, string, OSError)' - uid: '@azure/msal-browser.NativeAuthError.createError' - package: '@azure/msal-browser' - summary: Create the appropriate error object based on the WAM status code. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createError(code: string, description: string, ext?: - OSError): AuthError - parameters: - - id: code - type: string - description: '' - - id: description - type: string - description: '' - - id: ext - type: - description: '' - return: - description: '' - type: AuthError - - name: createTokensNotFoundInCacheError() - uid: '@azure/msal-browser.NativeAuthError.createTokensNotFoundInCacheError' - 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' - return: - description: 'NativeAuthError: tokensNotFoundInCache' - type: - - name: createUserSwitchError() - uid: '@azure/msal-browser.NativeAuthError.createUserSwitchError' - package: '@azure/msal-browser' - summary: >- - 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' - return: - description: '' - type: - - name: isFatal() - uid: '@azure/msal-browser.NativeAuthError.isFatal' - package: '@azure/msal-browser' - summary: >- - These errors should result in a fallback to the 'standard' browser based - auth flow. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isFatal(): boolean' - return: - description: '' - type: boolean -extends: AuthError diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionMethod.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionMethod.yml deleted file mode 100644 index edfc9d9..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionMethod.yml +++ /dev/null @@ -1,26 +0,0 @@ -### YamlMime:TSEnum -name: NativeExtensionMethod -uid: '@azure/msal-browser.NativeExtensionMethod' -package: '@azure/msal-browser' -summary: '' -fullName: NativeExtensionMethod -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: GetToken - uid: '@azure/msal-browser.NativeExtensionMethod.GetToken' - package: '@azure/msal-browser' - summary: '' - - name: HandshakeRequest - uid: '@azure/msal-browser.NativeExtensionMethod.HandshakeRequest' - package: '@azure/msal-browser' - summary: '' - - name: HandshakeResponse - uid: '@azure/msal-browser.NativeExtensionMethod.HandshakeResponse' - package: '@azure/msal-browser' - summary: '' - - name: Response - uid: '@azure/msal-browser.NativeExtensionMethod.Response' - package: '@azure/msal-browser' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequest.yml deleted file mode 100644 index 9f6c915..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequest.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: NativeExtensionRequest -uid: '@azure/msal-browser.NativeExtensionRequest' -package: '@azure/msal-browser' -summary: Browser extension request -fullName: NativeExtensionRequest -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type NativeExtensionRequest = { - body: NativeExtensionRequestBody, - channel: string, - extensionId?: string, - responseId: number, - } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequestBody.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequestBody.yml deleted file mode 100644 index 5c51518..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeExtensionRequestBody.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: NativeExtensionRequestBody -uid: '@azure/msal-browser.NativeExtensionRequestBody' -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 = { - method: NativeExtensionMethod, - request?: NativeTokenRequest, - } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml deleted file mode 100644 index 0d06de4..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeInteractionClient.yml +++ /dev/null @@ -1,156 +0,0 @@ -### YamlMime:TSType -name: NativeInteractionClient -uid: '@azure/msal-browser.NativeInteractionClient' -package: '@azure/msal-browser' -summary: '' -fullName: NativeInteractionClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - NativeInteractionClient(BrowserConfiguration, BrowserCacheManager, - ICrypto, Logger, EventHandler, INavigationClient, ApiId, - IPerformanceClient, NativeMessageHandler, string, BrowserCacheManager, - string) - uid: '@azure/msal-browser.NativeInteractionClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new NativeInteractionClient(config: BrowserConfiguration, - browserStorage: BrowserCacheManager, browserCrypto: ICrypto, logger: - Logger, eventHandler: EventHandler, navigationClient: INavigationClient, - apiId: ApiId, performanceClient: IPerformanceClient, provider: - NativeMessageHandler, accountId: string, nativeStorageImpl: - BrowserCacheManager, correlationId?: string) - parameters: - - id: config - type: - description: '' - - id: browserStorage - type: - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' - - id: eventHandler - type: - description: '' - - id: navigationClient - type: - description: '' - - id: apiId - type: - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: provider - type: - description: '' - - id: accountId - type: string - description: '' - - id: nativeStorageImpl - type: - description: '' - - id: correlationId - type: string - description: '' -inheritedMethods: - - name: getRedirectUri(string) - uid: '@azure/msal-browser.NativeInteractionClient.getRedirectUri' - 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' - parameters: - - id: requestRedirectUri - type: string - description: '' - return: - description: Redirect URL - type: string - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) -methods: - - name: acquireToken(PopupRequest | SilentRequest | SsoSilentRequest) - uid: '@azure/msal-browser.NativeInteractionClient.acquireToken' - package: '@azure/msal-browser' - summary: Acquire token from native platform via browser extension - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: PopupRequest | SilentRequest | - SsoSilentRequest): Promise - parameters: - - id: request - type: >- - | | - description: |+ - - return: - description: '' - type: Promise<AuthenticationResult> - - name: acquireTokenRedirect(RedirectRequest) - uid: '@azure/msal-browser.NativeInteractionClient.acquireTokenRedirect' - package: '@azure/msal-browser' - summary: >- - 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' - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<void> - - name: handleRedirectPromise() - uid: '@azure/msal-browser.NativeInteractionClient.handleRedirectPromise' - package: '@azure/msal-browser' - summary: >- - 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' - return: - description: '' - type: Promise<AuthenticationResult | null> - - name: logout() - uid: '@azure/msal-browser.NativeInteractionClient.logout' - package: '@azure/msal-browser' - summary: Logout from native platform via browser extension - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(): Promise' - return: - description: '' - type: Promise<void> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NativeMessageHandler.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeMessageHandler.yml deleted file mode 100644 index 9b43061..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeMessageHandler.yml +++ /dev/null @@ -1,137 +0,0 @@ -### YamlMime:TSType -name: NativeMessageHandler -uid: '@azure/msal-browser.NativeMessageHandler' -package: '@azure/msal-browser' -summary: '' -fullName: NativeMessageHandler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'NativeMessageHandler(Logger, number, 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) - parameters: - - id: logger - type: Logger - description: '' - - id: handshakeTimeoutMs - type: number - description: '' - - id: extensionId - type: string - description: '' -methods: - - name: 'createProvider(Logger, number)' - 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 - parameters: - - id: logger - type: Logger - description: '' - - id: handshakeTimeoutMs - type: number - description: |+ - - return: - description: '' - type: Promise<> - - name: getExtensionId() - uid: '@azure/msal-browser.NativeMessageHandler.getExtensionId' - package: '@azure/msal-browser' - summary: >- - Returns the Id for the browser extension this handler is communicating - with - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getExtensionId(): string | undefined' - return: - description: '' - type: string | undefined - - name: getExtensionVersion() - uid: '@azure/msal-browser.NativeMessageHandler.getExtensionVersion' - package: '@azure/msal-browser' - summary: >- - Returns the version for the browser extension this handler is - communicating with - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getExtensionVersion(): string | undefined' - return: - description: '' - type: string | undefined - - name: >- - isNativeAvailable(BrowserConfiguration, Logger, NativeMessageHandler, - AuthenticationScheme) - uid: '@azure/msal-browser.NativeMessageHandler.isNativeAvailable' - package: '@azure/msal-browser' - summary: >- - Returns boolean indicating whether or not the request should attempt to - use native broker - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function isNativeAvailable(config: BrowserConfiguration, logger: - Logger, nativeExtensionProvider?: NativeMessageHandler, - authenticationScheme?: AuthenticationScheme): boolean - parameters: - - id: config - type: - description: '' - - id: logger - type: Logger - description: '' - - id: nativeExtensionProvider - type: - description: '' - - id: authenticationScheme - type: AuthenticationScheme - description: |+ - - return: - description: '' - type: boolean - - name: sendMessage(NativeExtensionRequestBody) - uid: '@azure/msal-browser.NativeMessageHandler.sendMessage' - package: '@azure/msal-browser' - summary: >- - 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' - parameters: - - id: body - type: - description: |+ - - return: - description: '' - type: Promise<object> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NativeResponse.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeResponse.yml deleted file mode 100644 index 040521d..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeResponse.yml +++ /dev/null @@ -1,22 +0,0 @@ -### YamlMime:TSTypeAlias -name: NativeResponse -uid: '@azure/msal-browser.NativeResponse' -package: '@azure/msal-browser' -summary: Token response returned by Native Platform e.g. WAM -fullName: NativeResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type NativeResponse = { - access_token: string, - account: NativeAccountInfo, - client_info: string, - expires_in: number, - extendedLifetimeToken?: boolean, - id_token: string, - properties: NativeResponseProperties, - scope: string, - shr?: string, - state: string, - } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NativeResponseProperties.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeResponseProperties.yml deleted file mode 100644 index 267ed6d..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeResponseProperties.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: NativeResponseProperties -uid: '@azure/msal-browser.NativeResponseProperties' -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/msal/docs-ref-autogen/@azure/msal-browser/NativeStatusCode.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeStatusCode.yml deleted file mode 100644 index ce98bea..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeStatusCode.yml +++ /dev/null @@ -1,38 +0,0 @@ -### YamlMime:TSEnum -name: NativeStatusCode -uid: '@azure/msal-browser.NativeStatusCode' -package: '@azure/msal-browser' -summary: '' -fullName: NativeStatusCode -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: ACCOUNT_UNAVAILABLE - uid: '@azure/msal-browser.NativeStatusCode.ACCOUNT_UNAVAILABLE' - package: '@azure/msal-browser' - summary: '' - - name: DISABLED - uid: '@azure/msal-browser.NativeStatusCode.DISABLED' - package: '@azure/msal-browser' - summary: '' - - name: NO_NETWORK - uid: '@azure/msal-browser.NativeStatusCode.NO_NETWORK' - package: '@azure/msal-browser' - summary: '' - - name: PERSISTENT_ERROR - uid: '@azure/msal-browser.NativeStatusCode.PERSISTENT_ERROR' - package: '@azure/msal-browser' - summary: '' - - name: TRANSIENT_ERROR - uid: '@azure/msal-browser.NativeStatusCode.TRANSIENT_ERROR' - package: '@azure/msal-browser' - summary: '' - - name: USER_CANCEL - uid: '@azure/msal-browser.NativeStatusCode.USER_CANCEL' - package: '@azure/msal-browser' - summary: '' - - name: USER_INTERACTION_REQUIRED - uid: '@azure/msal-browser.NativeStatusCode.USER_INTERACTION_REQUIRED' - package: '@azure/msal-browser' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NativeTokenRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/NativeTokenRequest.yml deleted file mode 100644 index a1d3ddc..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/NativeTokenRequest.yml +++ /dev/null @@ -1,32 +0,0 @@ -### YamlMime:TSTypeAlias -name: NativeTokenRequest -uid: '@azure/msal-browser.NativeTokenRequest' -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 = { - accountId: string, - authority: string, - claims?: string, - clientId: string, - correlationId: string, - extendedExpiryToken?: boolean, - extraParameters?: StringDict, - keyId?: string, - nonce?: string, - prompt?: string, - redirectUri: string, - reqCnf?: string, - resourceRequestMethod?: string, - resourceRequestUri?: string, - scope: string, - shrClaims?: string, - shrNonce?: string, - state?: string, - tokenType?: string, - windowTitleSubstring: string, - } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml index 9c44421..41b4f34 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/NavigationClient.yml @@ -5,18 +5,16 @@ package: '@azure/msal-browser' summary: '' fullName: NavigationClient remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'navigateExternal(string, NavigationOptions)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -28,17 +26,15 @@ methods: description: '' - id: options type: - description: |+ - + description: '' return: description: '' type: Promise<boolean> - - name: 'navigateInternal(string, NavigationOptions)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -50,8 +46,7 @@ methods: description: '' - id: options type: - description: |+ - + 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 index 13e1064..8db8f49 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/NavigationOptions.yml +++ b/msal/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 } + 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/OSError.yml b/msal/docs-ref-autogen/@azure/msal-browser/OSError.yml deleted file mode 100644 index e4c73c0..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/OSError.yml +++ /dev/null @@ -1,17 +0,0 @@ -### YamlMime:TSTypeAlias -name: OSError -uid: '@azure/msal-browser.OSError' -package: '@azure/msal-browser' -summary: '' -fullName: OSError -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type OSError = { - error: number, - properties: object, - protocol_error: string, - retryable?: boolean, - status: string, - } 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..632d1cf --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvent.yml @@ -0,0 +1,94 @@ +### 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 + accountType?: "AAD" | "MSA" | "B2C" + allowPlatformBroker?: boolean + appName?: string + appVersion?: string + authority: string + awaitIframeCorrelationId?: string + cacheAtCount?: number + cacheIdCount?: number + cacheLookupPolicy?: number + cacheOutcome?: number + cacheRtCount?: number + clientId: string + contentLengthHeader?: string + contentTypeHeader?: string + context?: string + correlationId: string + domainHintFromRequest?: boolean + durationMs?: number + embeddedClientId?: string + embeddedRedirectUri?: string + endPageVisibility?: string | null + errorCode?: string + errorName?: string + errorStack?: string[] + eventId: string + extensionHandshakeTimedOut?: boolean + extensionHandshakeTimeoutMs?: number + extensionId?: string + extensionInstalled?: boolean + extensionVersion?: string + fromCache?: boolean | null + httpStatus?: number + httpVerToken?: string + 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 + 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 + 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 + subErrorCode?: string + success?: boolean | null + usePreGeneratedPkce?: boolean + 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..be04bcf --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/PerformanceEvents.yml @@ -0,0 +1,478 @@ +### 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: 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). + 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' + 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: Base64Decode + uid: '@azure/msal-browser.PerformanceEvents.Base64Decode' + 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: 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' + summary: '' + - name: GenerateCodeVerifier + 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' + 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: 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' + 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: LocalStorageUpdated + uid: '@azure/msal-browser.PerformanceEvents.LocalStorageUpdated' + package: '@azure/msal-browser' + summary: '' + - 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: 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' + 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: '' + - 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: SetUserData + uid: '@azure/msal-browser.PerformanceEvents.SetUserData' + 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: UrlEncodeArr + uid: '@azure/msal-browser.PerformanceEvents.UrlEncodeArr' + 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/PkceGenerator.yml b/msal/docs-ref-autogen/@azure/msal-browser/PkceGenerator.yml deleted file mode 100644 index 59a3917..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/PopupClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupClient.yml deleted file mode 100644 index ff04ad7..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupClient.yml +++ /dev/null @@ -1,269 +0,0 @@ -### YamlMime:TSType -name: PopupClient -uid: '@azure/msal-browser.PopupClient' -package: '@azure/msal-browser' -summary: '' -fullName: PopupClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - PopupClient(BrowserConfiguration, BrowserCacheManager, ICrypto, Logger, - EventHandler, INavigationClient, IPerformanceClient, BrowserCacheManager, - NativeMessageHandler, string) - uid: '@azure/msal-browser.PopupClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new PopupClient(config: BrowserConfiguration, storageImpl: - BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, - eventHandler: EventHandler, navigationClient: INavigationClient, - performanceClient: IPerformanceClient, nativeStorageImpl: - BrowserCacheManager, nativeMessageHandler?: NativeMessageHandler, - correlationId?: string) - parameters: - - id: config - type: - description: '' - - id: storageImpl - type: - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' - - id: eventHandler - type: - description: '' - - id: navigationClient - type: - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: nativeStorageImpl - type: - description: '' - - id: nativeMessageHandler - type: - description: '' - - id: correlationId - type: string - description: '' -inheritedMethods: - - name: getRedirectUri(string) - uid: '@azure/msal-browser.PopupClient.getRedirectUri' - 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' - parameters: - - id: requestRedirectUri - type: string - description: '' - return: - description: Redirect URL - type: string - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) -methods: - - name: acquireToken(PopupRequest) - uid: '@azure/msal-browser.PopupClient.acquireToken' - package: '@azure/msal-browser' - summary: >- - Acquires tokens by opening a popup window to the /authorize endpoint of - the authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: PopupRequest): - Promise - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<AuthenticationResult> - - name: cleanPopup(Window) - uid: '@azure/msal-browser.PopupClient.cleanPopup' - 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)' - parameters: - - id: popupWindow - type: Window - description: |+ - - - name: generateLogoutPopupName(CommonEndSessionRequest) - uid: '@azure/msal-browser.PopupClient.generateLogoutPopupName' - package: '@azure/msal-browser' - summary: >- - Generates the name for the popup based on the client id and request for - logouts - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function generateLogoutPopupName(request: CommonEndSessionRequest): - string - parameters: - - id: request - type: CommonEndSessionRequest - description: |+ - - return: - description: '' - type: string - - name: 'generatePopupName(Array, string)' - uid: '@azure/msal-browser.PopupClient.generatePopupName' - 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: >- - function generatePopupName(scopes: Array, authority: string): - string - parameters: - - id: scopes - type: Array<string> - description: '' - - id: authority - type: string - description: '' - return: - description: '' - type: string - - name: 'initiateAuthRequest(string, PopupParams)' - uid: '@azure/msal-browser.PopupClient.initiateAuthRequest' - package: '@azure/msal-browser' - summary: Opens a popup window with given request Url. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function initiateAuthRequest(requestUrl: string, params: PopupParams): - Window - parameters: - - id: requestUrl - type: string - description: |+ - - - id: params - type: - description: '' - return: - description: '' - type: Window - - name: logout(EndSessionPopupRequest) - uid: '@azure/msal-browser.PopupClient.logout' - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(logoutRequest?: EndSessionPopupRequest): Promise' - parameters: - - id: logoutRequest - type: - description: |+ - - return: - description: '' - type: Promise<void> - - name: monitorPopupForHash(Window) - uid: '@azure/msal-browser.PopupClient.monitorPopupForHash' - 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' - parameters: - - id: popupWindow - type: Window - description: window that is being monitored - return: - description: '' - type: Promise<string> - - name: 'openSizedPopup(string, string, PopupWindowAttributes)' - uid: '@azure/msal-browser.PopupClient.openSizedPopup' - package: '@azure/msal-browser' - summary: Helper function to set popup window dimensions and position - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function openSizedPopup(urlNavigate: string, popupName: string, - popupWindowAttributes: PopupWindowAttributes): Window | null - parameters: - - id: urlNavigate - type: string - description: '' - - id: popupName - type: string - description: '' - - id: popupWindowAttributes - type: - description: '' - return: - description: '' - type: Window | null - - name: unloadWindow(Event) - uid: '@azure/msal-browser.PopupClient.unloadWindow' - package: '@azure/msal-browser' - summary: Event callback to unload main window. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function unloadWindow(e: Event)' - parameters: - - id: e - type: Event - description: '' - - name: waitForLogoutPopup(Window) - uid: '@azure/msal-browser.PopupClient.waitForLogoutPopup' - 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' - parameters: - - id: popupWindow - type: Window - description: '' - return: - description: '' - type: Promise<void> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml index 5532de3..f86cbb3 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupEvent.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-browser/PopupParams.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupParams.yml deleted file mode 100644 index 78e5922..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupParams.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: PopupParams -uid: '@azure/msal-browser.PopupParams' -package: '@azure/msal-browser' -summary: '' -fullName: PopupParams -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type PopupParams = InteractionParams & { - popup?: Window | null, - popupName: string, - popupWindowAttributes: PopupWindowAttributes, - } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml index a3f0e29..01c0326 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupPosition.yml +++ b/msal/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 } + 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 index 4ebc4b3..ae43898 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupRequest.yml @@ -2,11 +2,12 @@ name: PopupRequest uid: '@azure/msal-browser.PopupRequest' package: '@azure/msal-browser' -summary: > +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. @@ -53,6 +54,10 @@ summary: > - 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 @@ -66,9 +71,11 @@ 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: '' -isPreview: false isDeprecated: false syntax: | type PopupRequest = Partial< @@ -79,6 +86,10 @@ syntax: | | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" - | "nativeBroker" + | "platformBroker" > - > & { popupWindowAttributes?: PopupWindowAttributes, scopes: Array } + > & { + popupWindowAttributes?: PopupWindowAttributes + popupWindowParent?: Window + scopes: string[] + } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/PopupSize.yml b/msal/docs-ref-autogen/@azure/msal-browser/PopupSize.yml index a8079f1..563d077 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupSize.yml +++ b/msal/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 } + 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 index beaca48..573d44e 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PopupWindowAttributes.yml @@ -5,10 +5,9 @@ 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 = { - popupPosition?: PopupPosition, - popupSize?: PopupSize, + 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 index 366266b..ce9d447 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientApplication.yml @@ -10,29 +10,31 @@ summary: >- with PKCE specification. fullName: PublicClientApplication remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: PublicClientApplication(Configuration) + - name: PublicClientApplication(Configuration, IController) uid: '@azure/msal-browser.PublicClientApplication.constructor' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new PublicClientApplication(configuration: Configuration)' + content: >- + new PublicClientApplication(configuration: Configuration, controller?: + IController) parameters: - id: configuration type: - description: | - object for the MSAL PublicClientApplication instance -inheritedMethods: + 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: > + summary: >- This function redeems an authorization code (passed as code) from the eSTS token endpoint. @@ -42,10 +44,10 @@ inheritedMethods: 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -54,15 +56,13 @@ inheritedMethods: parameters: - id: request type: - description: '' + 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<AuthenticationResult> - inheritanceDescription: >- - Inherited From - [ClientApplication.acquireTokenByCode](xref:@azure/msal-browser.ClientApplication.acquireTokenByCode) + type: Promise<> - name: acquireTokenPopup(PopupRequest) uid: '@azure/msal-browser.PublicClientApplication.acquireTokenPopup' package: '@azure/msal-browser' @@ -70,7 +70,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: >- @@ -79,26 +78,23 @@ inheritedMethods: parameters: - id: request type: - description: |+ - + description: '' return: description: >- A promise that is fulfilled when this function has completed, or rejected if an error was raised. - type: Promise<AuthenticationResult> - inheritanceDescription: >- - Inherited From - [ClientApplication.acquireTokenPopup](xref:@azure/msal-browser.ClientApplication.acquireTokenPopup) + type: Promise<> - name: acquireTokenRedirect(RedirectRequest) uid: '@azure/msal-browser.PublicClientApplication.acquireTokenRedirect' package: '@azure/msal-browser' - summary: > + 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 @@ -106,49 +102,64 @@ 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' parameters: - id: request type: - description: |+ - + description: '' return: description: '' type: Promise<void> - inheritanceDescription: >- - Inherited From - [ClientApplication.acquireTokenRedirect](xref:@azure/msal-browser.ClientApplication.acquireTokenRedirect) - - name: addEventCallback(EventCallbackFunction) + - 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, EventType[]) uid: '@azure/msal-browser.PublicClientApplication.addEventCallback' package: '@azure/msal-browser' summary: Adds event callbacks to array remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function addEventCallback(callback: EventCallbackFunction): string | - null + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[]): null | string parameters: - id: callback type: - description: |+ - + description: '' + - id: eventTypes + type: EventType[] + description: '' return: description: '' - type: string | null - inheritanceDescription: >- - Inherited From - [ClientApplication.addEventCallback](xref:@azure/msal-browser.ClientApplication.addEventCallback) + 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -156,14 +167,45 @@ inheritedMethods: string parameters: - id: callback - type: PerformanceCallbackFunction + type: description: '' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [ClientApplication.addPerformanceCallback](xref:@azure/msal-browser.ClientApplication.addPerformanceCallback) + - 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: Creates StandardController and passes it to the PublicClientApplication + remarks: '' + isDeprecated: false + syntax: + content: >- + static function createPublicClientApplication(configuration: + Configuration): Promise + parameters: + - id: configuration + type: + description: '{Configuration}' + return: + description: '' + type: >- + Promise<> - name: disableAccountStorageEvents() uid: '@azure/msal-browser.PublicClientApplication.disableAccountStorageEvents' package: '@azure/msal-browser' @@ -171,13 +213,9 @@ 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() - inheritanceDescription: >- - Inherited From - [ClientApplication.disableAccountStorageEvents](xref:@azure/msal-browser.ClientApplication.disableAccountStorageEvents) - name: enableAccountStorageEvents() uid: '@azure/msal-browser.PublicClientApplication.enableAccountStorageEvents' package: '@azure/msal-browser' @@ -185,13 +223,28 @@ 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() - inheritanceDescription: >- - Inherited From - [ClientApplication.enableAccountStorageEvents](xref:@azure/msal-browser.ClientApplication.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' @@ -200,20 +253,17 @@ 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 + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' syntax: - content: 'function getAccountByHomeId(homeAccountId: string): AccountInfo | null' + content: 'function getAccountByHomeId(homeAccountId: string): null | AccountInfo' parameters: - id: homeAccountId type: string description: '' return: description: The account object stored in MSAL - type: AccountInfo | null - inheritanceDescription: >- - Inherited From - [ClientApplication.getAccountByHomeId](xref:@azure/msal-browser.ClientApplication.getAccountByHomeId) + type: null | - name: getAccountByLocalId(string) uid: '@azure/msal-browser.PublicClientApplication.getAccountByLocalId' package: '@azure/msal-browser' @@ -222,20 +272,17 @@ 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 + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' syntax: - content: 'function getAccountByLocalId(localAccountId: string): AccountInfo | null' + content: 'function getAccountByLocalId(localId: string): null | AccountInfo' parameters: - - id: localAccountId + - id: localId type: string description: '' return: description: The account object stored in MSAL - type: AccountInfo | null - inheritanceDescription: >- - Inherited From - [ClientApplication.getAccountByLocalId](xref:@azure/msal-browser.ClientApplication.getAccountByLocalId) + type: null | - name: getAccountByUsername(string) uid: '@azure/msal-browser.PublicClientApplication.getAccountByUsername' package: '@azure/msal-browser' @@ -249,98 +296,67 @@ inheritedMethods: This API is provided for convenience but getAccountById should be used for best reliability remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' syntax: - content: 'function getAccountByUsername(userName: string): AccountInfo | null' + content: 'function getAccountByUsername(userName: string): null | AccountInfo' parameters: - id: userName type: string description: '' return: description: The account object stored in MSAL - type: AccountInfo | null - inheritanceDescription: >- - Inherited From - [ClientApplication.getAccountByUsername](xref:@azure/msal-browser.ClientApplication.getAccountByUsername) + type: null | - name: getActiveAccount() uid: '@azure/msal-browser.PublicClientApplication.getActiveAccount' package: '@azure/msal-browser' summary: Gets the currently active account remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getActiveAccount(): AccountInfo | null' + content: 'function getActiveAccount(): null | AccountInfo' return: description: '' - type: AccountInfo | null - inheritanceDescription: >- - Inherited From - [ClientApplication.getActiveAccount](xref:@azure/msal-browser.ClientApplication.getActiveAccount) - - name: getAllAccounts() + type: null | + - name: getAllAccounts(AccountFilter) uid: '@azure/msal-browser.PublicClientApplication.getAllAccounts' package: '@azure/msal-browser' - summary: |- - Returns all accounts that MSAL currently has data for. - (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[]' - return: - description: Array of account objects in cache - type: 'AccountInfo[]' - inheritanceDescription: >- - Inherited From - [ClientApplication.getAllAccounts](xref:@azure/msal-browser.ClientApplication.getAllAccounts) - - name: getConfiguration() - uid: '@azure/msal-browser.PublicClientApplication.getConfiguration' - package: '@azure/msal-browser' - summary: Returns the configuration object + summary: >- + Returns all the accounts in the cache that match the optional filter. If + no filter is provided, all accounts are returned. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConfiguration(): BrowserConfiguration' + content: 'function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]' + parameters: + - id: accountFilter + type: + description: (Optional) filter to narrow down the accounts returned return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientApplication.getConfiguration](xref:@azure/msal-browser.ClientApplication.getConfiguration) + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' return: description: '' - type: Logger - inheritanceDescription: >- - Inherited From - [ClientApplication.getLogger](xref:@azure/msal-browser.ClientApplication.getLogger) + type: - name: getTokenCache() uid: '@azure/msal-browser.PublicClientApplication.getTokenCache' package: '@azure/msal-browser' summary: Gets the token cache for the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): ITokenCache' return: description: '' type: - inheritanceDescription: >- - Inherited From - [ClientApplication.getTokenCache](xref:@azure/msal-browser.ClientApplication.getTokenCache) - name: handleRedirectPromise(string) uid: '@azure/msal-browser.PublicClientApplication.handleRedirectPromise' package: '@azure/msal-browser' @@ -353,12 +369,11 @@ inheritedMethods: auth flows. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function handleRedirectPromise(hash?: string): - Promise + function handleRedirectPromise(hash?: string): Promise parameters: - id: hash type: string @@ -370,55 +385,134 @@ inheritedMethods: description: >- Token response or null. If the return value is null, then no auth redirect was detected. - type: Promise<AuthenticationResult | null> - inheritanceDescription: >- - Inherited From - [ClientApplication.handleRedirectPromise](xref:@azure/msal-browser.ClientApplication.handleRedirectPromise) - - name: initialize() + type: >- + Promise<null | > + - name: >- + hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | + SilentRequest | Partial>) + 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 | + Partial>): Promise + parameters: + - id: result + type: + description: '' + - id: request + type: >- + | | | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> + description: The request object that was used to obtain the AuthenticationResult + return: + description: '' + type: Promise<void> + - name: initialize(InitializeApplicationRequest) 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: '' - isPreview: false isDeprecated: false syntax: - content: 'function initialize(): Promise' + content: >- + function initialize(request?: InitializeApplicationRequest): + Promise + parameters: + - id: request + type: + description: '{?InitializeApplicationRequest}' return: description: '' type: Promise<void> - inheritanceDescription: >- - Inherited From - [ClientApplication.initialize](xref:@azure/msal-browser.ClientApplication.initialize) - - name: 'initializeWrapperLibrary(WrapperSKU, string)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' parameters: - id: sku - type: + type: WrapperSKU description: '' - id: version type: string - description: |+ + 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. - inheritanceDescription: >- - Inherited From - [ClientApplication.initializeWrapperLibrary](xref:@azure/msal-browser.ClientApplication.initializeWrapperLibrary) + + 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: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -430,9 +524,6 @@ inheritedMethods: return: description: '' type: Promise<void> - inheritanceDescription: >- - Inherited From - [ClientApplication.logout](xref:@azure/msal-browser.ClientApplication.logout) - name: logoutPopup(EndSessionPopupRequest) uid: '@azure/msal-browser.PublicClientApplication.logoutPopup' package: '@azure/msal-browser' @@ -440,7 +531,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: >- @@ -449,14 +539,10 @@ inheritedMethods: parameters: - id: logoutRequest type: - description: |+ - + description: '' return: description: '' type: Promise<void> - inheritanceDescription: >- - Inherited From - [ClientApplication.logoutPopup](xref:@azure/msal-browser.ClientApplication.logoutPopup) - name: logoutRedirect(EndSessionRequest) uid: '@azure/msal-browser.PublicClientApplication.logoutRedirect' package: '@azure/msal-browser' @@ -466,7 +552,6 @@ inheritedMethods: Default behaviour is to redirect the user to `window.location.href`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -475,37 +560,27 @@ inheritedMethods: parameters: - id: logoutRequest type: - description: |+ - + description: '' return: description: '' type: Promise<void> - inheritanceDescription: >- - Inherited From - [ClientApplication.logoutRedirect](xref:@azure/msal-browser.ClientApplication.logoutRedirect) - name: removeEventCallback(string) uid: '@azure/msal-browser.PublicClientApplication.removeEventCallback' package: '@azure/msal-browser' summary: Removes callback with provided id from callback array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeEventCallback(callbackId: string)' parameters: - id: callbackId type: string - description: |+ - - inheritanceDescription: >- - Inherited From - [ClientApplication.removeEventCallback](xref:@azure/msal-browser.ClientApplication.removeEventCallback) + description: '' - name: removePerformanceCallback(string) uid: '@azure/msal-browser.PublicClientApplication.removePerformanceCallback' package: '@azure/msal-browser' summary: Removes a callback registered with addPerformanceCallback. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -516,28 +591,20 @@ inheritedMethods: return: description: '' type: boolean - inheritanceDescription: >- - Inherited From - [ClientApplication.removePerformanceCallback](xref:@azure/msal-browser.ClientApplication.removePerformanceCallback) - - name: setActiveAccount(AccountInfo | null) + - 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: '' - isPreview: false isDeprecated: false syntax: - content: 'function setActiveAccount(account: AccountInfo | null)' + content: 'function setActiveAccount(account: null | AccountInfo)' parameters: - id: account - type: AccountInfo | null - description: |+ - - inheritanceDescription: >- - Inherited From - [ClientApplication.setActiveAccount](xref:@azure/msal-browser.ClientApplication.setActiveAccount) + type: null | + description: '' - name: setLogger(Logger) uid: '@azure/msal-browser.PublicClientApplication.setLogger' package: '@azure/msal-browser' @@ -545,36 +612,29 @@ 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)' parameters: - id: logger - type: Logger - description: | - Logger instance - inheritanceDescription: >- - Inherited From - [ClientApplication.setLogger](xref:@azure/msal-browser.ClientApplication.setLogger) + type: + description: Logger instance - name: setNavigationClient(INavigationClient) uid: '@azure/msal-browser.PublicClientApplication.setNavigationClient' package: '@azure/msal-browser' summary: Sets navigation client remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setNavigationClient(navigationClient: INavigationClient)' parameters: - id: navigationClient type: - description: |+ - - inheritanceDescription: >- - Inherited From - [ClientApplication.setNavigationClient](xref:@azure/msal-browser.ClientApplication.setNavigationClient) - - name: ssoSilent(SsoSilentRequest) + description: '' + - name: >- + ssoSilent(Partial>) uid: '@azure/msal-browser.PublicClientApplication.ssoSilent' package: '@azure/msal-browser' summary: >- @@ -585,6 +645,7 @@ inheritedMethods: - 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. @@ -598,98 +659,23 @@ inheritedMethods: you session on the server still exists. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function ssoSilent(request: SsoSilentRequest): + function ssoSilent(request: Partial>): Promise parameters: - id: request - type: - description: |+ - + type: >- + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> + 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<AuthenticationResult> - inheritanceDescription: >- - Inherited From - [ClientApplication.ssoSilent](xref:@azure/msal-browser.ClientApplication.ssoSilent) -methods: - - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireTokenSilent(request: SilentRequest): - 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. Returns the - object - type: Promise<AuthenticationResult> - - 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: '' - isPreview: false - 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<AuthenticationResult> - - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function loginRedirect(request?: RedirectRequest): Promise' - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<void> -extends: + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml similarity index 51% rename from msal/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml rename to msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml index 2b59432..5d3a9df 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/ClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/PublicClientNext.yml @@ -1,33 +1,35 @@ ### YamlMime:TSType -name: ClientApplication -uid: '@azure/msal-browser.ClientApplication' +name: PublicClientNext +uid: '@azure/msal-browser.PublicClientNext' package: '@azure/msal-browser' -summary: '' -fullName: ClientApplication +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. + + + Please use PublicClientApplication for any prod/real-world scenarios. + + Note: PublicClientNext is experimental and subject to breaking changes without + following semver +fullName: PublicClientNext remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: ClientApplication(Configuration) - uid: '@azure/msal-browser.ClientApplication.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new ClientApplication(configuration: Configuration)' - parameters: - - id: configuration - type: - description: | - Object for the MSAL PublicClientApplication instance methods: - name: acquireTokenByCode(AuthorizationCodeRequest) - uid: '@azure/msal-browser.ClientApplication.acquireTokenByCode' + uid: '@azure/msal-browser.PublicClientNext.acquireTokenByCode' package: '@azure/msal-browser' - summary: > + summary: >- This function redeems an authorization code (passed as code) from the eSTS token endpoint. @@ -37,10 +39,10 @@ methods: 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -49,20 +51,20 @@ methods: parameters: - id: request type: - description: '' + 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<AuthenticationResult> + type: Promise<> - name: acquireTokenPopup(PopupRequest) - uid: '@azure/msal-browser.ClientApplication.acquireTokenPopup' + 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -71,23 +73,23 @@ methods: parameters: - id: request type: - description: |+ - + description: '' return: description: >- A promise that is fulfilled when this function has completed, or rejected if an error was raised. - type: Promise<AuthenticationResult> + type: Promise<> - name: acquireTokenRedirect(RedirectRequest) - uid: '@azure/msal-browser.ClientApplication.acquireTokenRedirect' + uid: '@azure/msal-browser.PublicClientNext.acquireTokenRedirect' package: '@azure/msal-browser' - summary: > + 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 @@ -95,43 +97,64 @@ 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' parameters: - id: request type: - description: |+ - + description: '' return: description: '' type: Promise<void> - - name: addEventCallback(EventCallbackFunction) - uid: '@azure/msal-browser.ClientApplication.addEventCallback' + - 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, EventType[]) + uid: '@azure/msal-browser.PublicClientNext.addEventCallback' package: '@azure/msal-browser' summary: Adds event callbacks to array remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function addEventCallback(callback: EventCallbackFunction): string | - null + function addEventCallback(callback: EventCallbackFunction, eventTypes?: + EventType[]): null | string parameters: - id: callback type: - description: |+ - + description: '' + - id: eventTypes + type: EventType[] + description: '' return: description: '' - type: string | null + type: null | string - name: addPerformanceCallback(PerformanceCallbackFunction) - uid: '@azure/msal-browser.ClientApplication.addPerformanceCallback' + uid: '@azure/msal-browser.PublicClientNext.addPerformanceCallback' package: '@azure/msal-browser' summary: Registers a callback to receive performance events. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -139,73 +162,124 @@ methods: string parameters: - id: callback - type: PerformanceCallbackFunction + 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.ClientApplication.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: '' - isPreview: false isDeprecated: false syntax: content: function disableAccountStorageEvents() - name: enableAccountStorageEvents() - uid: '@azure/msal-browser.ClientApplication.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: '' - isPreview: false 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.ClientApplication.getAccountByHomeId' + 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: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' syntax: - content: 'function getAccountByHomeId(homeAccountId: string): AccountInfo | null' + content: 'function getAccountByHomeId(homeAccountId: string): null | AccountInfo' parameters: - id: homeAccountId type: string description: '' return: description: The account object stored in MSAL - type: AccountInfo | null + type: null | - name: getAccountByLocalId(string) - uid: '@azure/msal-browser.ClientApplication.getAccountByLocalId' + 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: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' syntax: - content: 'function getAccountByLocalId(localAccountId: string): AccountInfo | null' + content: 'function getAccountByLocalId(localId: string): null | AccountInfo' parameters: - - id: localAccountId + - id: localId type: string description: '' return: description: The account object stored in MSAL - type: AccountInfo | null + type: null | - name: getAccountByUsername(string) - uid: '@azure/msal-browser.ClientApplication.getAccountByUsername' + uid: '@azure/msal-browser.PublicClientNext.getAccountByUsername' package: '@azure/msal-browser' summary: >- Returns the signed in account matching username. @@ -217,74 +291,61 @@ methods: This API is provided for convenience but getAccountById should be used for best reliability remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use getAccount instead' syntax: - content: 'function getAccountByUsername(userName: string): AccountInfo | null' + content: 'function getAccountByUsername(userName: string): null | AccountInfo' parameters: - id: userName type: string description: '' return: description: The account object stored in MSAL - type: AccountInfo | null + type: null | - name: getActiveAccount() - uid: '@azure/msal-browser.ClientApplication.getActiveAccount' + uid: '@azure/msal-browser.PublicClientNext.getActiveAccount' package: '@azure/msal-browser' summary: Gets the currently active account remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getActiveAccount(): AccountInfo | null' + content: 'function getActiveAccount(): null | AccountInfo' return: description: '' - type: AccountInfo | null - - name: getAllAccounts() - uid: '@azure/msal-browser.ClientApplication.getAllAccounts' - package: '@azure/msal-browser' - summary: |- - Returns all accounts that MSAL currently has data for. - (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[]' - return: - description: Array of account objects in cache - type: 'AccountInfo[]' - - name: getConfiguration() - uid: '@azure/msal-browser.ClientApplication.getConfiguration' + type: null | + - name: getAllAccounts(AccountFilter) + uid: '@azure/msal-browser.PublicClientNext.getAllAccounts' package: '@azure/msal-browser' - summary: Returns the configuration object + summary: >- + Returns all the accounts in the cache that match the optional filter. If + no filter is provided, all accounts are returned. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function getConfiguration(): BrowserConfiguration' + content: 'function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]' + parameters: + - id: accountFilter + type: + description: (Optional) filter to narrow down the accounts returned return: - description: '' - type: + description: Array of AccountInfo objects in cache + type: [] - name: getLogger() - uid: '@azure/msal-browser.ClientApplication.getLogger' + uid: '@azure/msal-browser.PublicClientNext.getLogger' package: '@azure/msal-browser' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' return: description: '' - type: Logger + type: - name: getTokenCache() - uid: '@azure/msal-browser.ClientApplication.getTokenCache' + uid: '@azure/msal-browser.PublicClientNext.getTokenCache' package: '@azure/msal-browser' summary: Gets the token cache for the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): ITokenCache' @@ -292,7 +353,7 @@ methods: description: '' type: - name: handleRedirectPromise(string) - uid: '@azure/msal-browser.ClientApplication.handleRedirectPromise' + uid: '@azure/msal-browser.PublicClientNext.handleRedirectPromise' package: '@azure/msal-browser' summary: >- Event handler function which allows users to fire events after the @@ -303,12 +364,11 @@ methods: auth flows. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function handleRedirectPromise(hash?: string): - Promise + function handleRedirectPromise(hash?: string): Promise parameters: - id: hash type: string @@ -320,46 +380,128 @@ methods: description: >- Token response or null. If the return value is null, then no auth redirect was detected. - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > + - name: >- + hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | + SilentRequest | Partial>) + 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 | + Partial>): Promise + parameters: + - id: result + type: + description: '' + - id: request + type: >- + | | | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> + description: The request object that was used to obtain the AuthenticationResult + return: + description: '' + type: Promise<void> - name: initialize() - uid: '@azure/msal-browser.ClientApplication.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: '' - isPreview: false isDeprecated: false syntax: content: 'function initialize(): Promise' return: description: '' type: Promise<void> - - name: 'initializeWrapperLibrary(WrapperSKU, string)' - uid: '@azure/msal-browser.ClientApplication.initializeWrapperLibrary' + - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function initializeWrapperLibrary(sku: WrapperSKU, version: string)' parameters: - id: sku - type: + type: WrapperSKU description: '' - id: version type: string - description: |+ + 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.ClientApplication.logout' + uid: '@azure/msal-browser.PublicClientNext.logout' package: '@azure/msal-browser' summary: Deprecated logout function. Use logoutRedirect or logoutPopup instead remarks: '' - isPreview: false isDeprecated: true customDeprecatedMessage: '' syntax: @@ -371,29 +513,25 @@ methods: return: description: '' type: Promise<void> - - name: logoutPopup(EndSessionPopupRequest) - uid: '@azure/msal-browser.ClientApplication.logoutPopup' + - 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: '' - isPreview: false isDeprecated: false syntax: - content: >- - function logoutPopup(logoutRequest?: EndSessionPopupRequest): - Promise + content: 'function logoutPopup(logoutRequest?: EndSessionRequest): Promise' parameters: - id: logoutRequest - type: - description: |+ - + type: + description: '' return: description: '' type: Promise<void> - name: logoutRedirect(EndSessionRequest) - uid: '@azure/msal-browser.ClientApplication.logoutRedirect' + uid: '@azure/msal-browser.PublicClientNext.logoutRedirect' package: '@azure/msal-browser' summary: >- Use to log out the current user, and redirect the user to the @@ -401,7 +539,6 @@ methods: Default behaviour is to redirect the user to `window.location.href`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -410,31 +547,27 @@ methods: parameters: - id: logoutRequest type: - description: |+ - + description: '' return: description: '' type: Promise<void> - name: removeEventCallback(string) - uid: '@azure/msal-browser.ClientApplication.removeEventCallback' + uid: '@azure/msal-browser.PublicClientNext.removeEventCallback' package: '@azure/msal-browser' summary: Removes callback with provided id from callback array remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeEventCallback(callbackId: string)' parameters: - id: callbackId type: string - description: |+ - + description: '' - name: removePerformanceCallback(string) - uid: '@azure/msal-browser.ClientApplication.removePerformanceCallback' + uid: '@azure/msal-browser.PublicClientNext.removePerformanceCallback' package: '@azure/msal-browser' summary: Removes a callback registered with addPerformanceCallback. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -445,54 +578,51 @@ methods: return: description: '' type: boolean - - name: setActiveAccount(AccountInfo | null) - uid: '@azure/msal-browser.ClientApplication.setActiveAccount' + - 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: '' - isPreview: false isDeprecated: false syntax: - content: 'function setActiveAccount(account: AccountInfo | null)' + content: 'function setActiveAccount(account: null | AccountInfo)' parameters: - id: account - type: AccountInfo | null - description: |+ - + type: null | + description: '' - name: setLogger(Logger) - uid: '@azure/msal-browser.ClientApplication.setLogger' + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function setLogger(logger: Logger)' parameters: - id: logger - type: Logger - description: | - Logger instance + type: + description: Logger instance - name: setNavigationClient(INavigationClient) - uid: '@azure/msal-browser.ClientApplication.setNavigationClient' + uid: '@azure/msal-browser.PublicClientNext.setNavigationClient' package: '@azure/msal-browser' summary: Sets navigation client remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setNavigationClient(navigationClient: INavigationClient)' parameters: - id: navigationClient type: - description: |+ - - - name: ssoSilent(SsoSilentRequest) - uid: '@azure/msal-browser.ClientApplication.ssoSilent' + description: '' + - name: >- + ssoSilent(Partial>) + uid: '@azure/msal-browser.PublicClientNext.ssoSilent' package: '@azure/msal-browser' summary: >- This function uses a hidden iframe to fetch an authorization code from the @@ -502,6 +632,7 @@ methods: - 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. @@ -515,19 +646,23 @@ methods: you session on the server still exists. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function ssoSilent(request: SsoSilentRequest): + function ssoSilent(request: Partial>): Promise parameters: - id: request - type: - description: |+ - + type: >- + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> + 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<AuthenticationResult> + type: Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml deleted file mode 100644 index 908161e..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/RedirectClient.yml +++ /dev/null @@ -1,142 +0,0 @@ -### YamlMime:TSType -name: RedirectClient -uid: '@azure/msal-browser.RedirectClient' -package: '@azure/msal-browser' -summary: '' -fullName: RedirectClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - RedirectClient(BrowserConfiguration, BrowserCacheManager, ICrypto, Logger, - EventHandler, INavigationClient, IPerformanceClient, BrowserCacheManager, - NativeMessageHandler, string) - uid: '@azure/msal-browser.RedirectClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new RedirectClient(config: BrowserConfiguration, storageImpl: - BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, - eventHandler: EventHandler, navigationClient: INavigationClient, - performanceClient: IPerformanceClient, nativeStorageImpl: - BrowserCacheManager, nativeMessageHandler?: NativeMessageHandler, - correlationId?: string) - parameters: - - id: config - type: - description: '' - - id: storageImpl - type: - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' - - id: eventHandler - type: - description: '' - - id: navigationClient - type: - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: nativeStorageImpl - type: - description: '' - - id: nativeMessageHandler - type: - description: '' - - id: correlationId - type: string - description: '' -inheritedMethods: - - name: getRedirectUri(string) - uid: '@azure/msal-browser.RedirectClient.getRedirectUri' - 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' - parameters: - - id: requestRedirectUri - type: string - description: '' - return: - description: Redirect URL - type: string - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) -methods: - - name: acquireToken(RedirectRequest) - uid: '@azure/msal-browser.RedirectClient.acquireToken' - 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' - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<void> - - name: handleRedirectPromise(string) - uid: '@azure/msal-browser.RedirectClient.handleRedirectPromise' - package: '@azure/msal-browser' - summary: |- - Checks if navigateToLoginRequestUrl is set, and: - - if true, performs logic to cache and navigate - - if false, handles hash string and parses response - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function handleRedirectPromise(hash?: string): - Promise - parameters: - - id: hash - type: string - description: |+ - - return: - description: '' - type: Promise<AuthenticationResult | null> - - name: logout(EndSessionRequest) - uid: '@azure/msal-browser.RedirectClient.logout' - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(logoutRequest?: EndSessionRequest): Promise' - parameters: - - id: logoutRequest - type: - description: |+ - - return: - description: '' - type: Promise<void> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectHandler.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectHandler.yml deleted file mode 100644 index 76915fc..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/RedirectHandler.yml +++ /dev/null @@ -1,130 +0,0 @@ -### YamlMime:TSType -name: RedirectHandler -uid: '@azure/msal-browser.RedirectHandler' -package: '@azure/msal-browser' -summary: '' -fullName: RedirectHandler -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - RedirectHandler(AuthorizationCodeClient, BrowserCacheManager, - CommonAuthorizationCodeRequest, Logger, ICrypto) - 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) - parameters: - - id: authCodeModule - type: AuthorizationCodeClient - description: '' - - id: storageImpl - type: - description: '' - - id: authCodeRequest - type: CommonAuthorizationCodeRequest - description: '' - - id: logger - type: Logger - description: '' - - id: browserCrypto - type: ICrypto - description: '' -inheritedMethods: - - name: >- - handleCodeResponseFromServer(AuthorizationCodePayload, string, Authority, - INetworkModule, boolean) - uid: '@azure/msal-browser.RedirectHandler.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: 'handleCodeResponseFromHash(string, string, Authority, INetworkModule)' - uid: '@azure/msal-browser.RedirectHandler.handleCodeResponseFromHash' - package: '@azure/msal-browser' - summary: Handle authorization code response in the window. - 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> - - name: 'initiateAuthRequest(string, RedirectParams)' - uid: '@azure/msal-browser.RedirectHandler.initiateAuthRequest' - package: '@azure/msal-browser' - summary: Redirects window to given URL. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function initiateAuthRequest(requestUrl: string, params: - RedirectParams): Promise - parameters: - - id: requestUrl - type: string - description: '' - - id: params - type: - description: '' - return: - description: '' - type: Promise<void> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectParams.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectParams.yml deleted file mode 100644 index d4f276f..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/RedirectParams.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: RedirectParams -uid: '@azure/msal-browser.RedirectParams' -package: '@azure/msal-browser' -summary: '' -fullName: RedirectParams -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type RedirectParams = InteractionParams & { - navigationClient: INavigationClient, - onRedirectNavigate?: (url: string) => void | boolean, - redirectStartPage: string, - redirectTimeout: number, - } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml index b30bf4b..7a07161 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/RedirectRequest.yml @@ -2,11 +2,12 @@ name: RedirectRequest uid: '@azure/msal-browser.RedirectRequest' package: '@azure/msal-browser' -summary: > +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. @@ -53,6 +54,10 @@ summary: > - 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 @@ -74,7 +79,6 @@ summary: > will navigate to. Returning false in the callback will stop navigation. fullName: RedirectRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type RedirectRequest = Partial< @@ -85,10 +89,10 @@ syntax: | | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" - | "nativeBroker" + | "platformBroker" > > & { - onRedirectNavigate?: (url: string) => boolean | void, - redirectStartPage?: string, - scopes: Array, + onRedirectNavigate?: (url: string) => boolean | void + redirectStartPage?: string + scopes: string[] } 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..39f67f0 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/ServerError.yml @@ -0,0 +1,239 @@ +### 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, string, number) + uid: '@azure/msal-browser.ServerError.constructor' + package: '@azure/msal-browser' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ServerError(errorCode?: string, errorMessage?: string, subError?: + string, errorNo?: string, status?: number) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: subError + type: string + description: '' + - id: errorNo + type: string + description: '' + - id: status + type: number + 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 + - 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' + 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/SessionStorage.yml b/msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml new file mode 100644 index 0000000..5201d05 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-browser/SessionStorage.yml @@ -0,0 +1,124 @@ +### 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: 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' + 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: '' + - 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/SignedHttpRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml index 6c32706..729a9c6 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequest.yml @@ -5,16 +5,14 @@ package: '@azure/msal-browser' summary: '' fullName: SignedHttpRequest remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'SignedHttpRequest(SignedHttpRequestParameters, SignedHttpRequestOptions)' + - name: SignedHttpRequest(SignedHttpRequestParameters, SignedHttpRequestOptions) uid: '@azure/msal-browser.SignedHttpRequest.constructor' package: '@azure/msal-browser' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -22,7 +20,7 @@ constructors: shrOptions?: SignedHttpRequestOptions) parameters: - id: shrParameters - type: SignedHttpRequestParameters + type: description: '' - id: shrOptions type: @@ -33,19 +31,17 @@ 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' return: - description: 'Public key digest, which should be sent to the token issuer.' + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function removeKeys(publicKeyThumbprint: string): Promise' @@ -56,12 +52,11 @@ methods: return: description: If keys are properly deleted type: Promise<boolean> - - name: 'signRequest(string, string, object)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml b/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml index f9ea20a..295321a 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SignedHttpRequestOptions.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml deleted file mode 100644 index df8bda2..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/SilentAuthCodeClient.yml +++ /dev/null @@ -1,114 +0,0 @@ -### YamlMime:TSType -name: SilentAuthCodeClient -uid: '@azure/msal-browser.SilentAuthCodeClient' -package: '@azure/msal-browser' -summary: '' -fullName: SilentAuthCodeClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - SilentAuthCodeClient(BrowserConfiguration, BrowserCacheManager, ICrypto, - Logger, EventHandler, INavigationClient, ApiId, IPerformanceClient, - NativeMessageHandler, string) - uid: '@azure/msal-browser.SilentAuthCodeClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new SilentAuthCodeClient(config: BrowserConfiguration, storageImpl: - BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, - eventHandler: EventHandler, navigationClient: INavigationClient, apiId: - ApiId, performanceClient: IPerformanceClient, nativeMessageHandler?: - NativeMessageHandler, correlationId?: string) - parameters: - - id: config - type: - description: '' - - id: storageImpl - type: - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' - - id: eventHandler - type: - description: '' - - id: navigationClient - type: - description: '' - - id: apiId - type: - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: nativeMessageHandler - type: - description: '' - - id: correlationId - type: string - description: '' -inheritedMethods: - - name: getRedirectUri(string) - uid: '@azure/msal-browser.SilentAuthCodeClient.getRedirectUri' - 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' - parameters: - - id: requestRedirectUri - type: string - description: '' - return: - description: Redirect URL - type: string - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) -methods: - - name: acquireToken(AuthorizationCodeRequest) - uid: '@azure/msal-browser.SilentAuthCodeClient.acquireToken' - package: '@azure/msal-browser' - summary: >- - Acquires a token silently by redeeming an authorization code against the - /token endpoint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: AuthorizationCodeRequest): - Promise - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<AuthenticationResult> - - name: logout() - uid: '@azure/msal-browser.SilentAuthCodeClient.logout' - package: '@azure/msal-browser' - summary: Currently Unsupported - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(): Promise' - return: - description: '' - type: Promise<void> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml deleted file mode 100644 index 9d2a09e..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/SilentCacheClient.yml +++ /dev/null @@ -1,130 +0,0 @@ -### YamlMime:TSType -name: SilentCacheClient -uid: '@azure/msal-browser.SilentCacheClient' -package: '@azure/msal-browser' -summary: '' -fullName: SilentCacheClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - SilentCacheClient(BrowserConfiguration, BrowserCacheManager, ICrypto, - Logger, EventHandler, INavigationClient, IPerformanceClient, - NativeMessageHandler, string) - uid: '@azure/msal-browser.SilentCacheClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new SilentCacheClient(config: BrowserConfiguration, storageImpl: - BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, - eventHandler: EventHandler, navigationClient: INavigationClient, - performanceClient: IPerformanceClient, nativeMessageHandler?: - NativeMessageHandler, correlationId?: string) - parameters: - - id: config - type: - description: '' - - id: storageImpl - type: - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' - - id: eventHandler - type: - description: '' - - id: navigationClient - type: - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: nativeMessageHandler - type: - description: '' - - id: correlationId - type: string - description: '' -inheritedMethods: - - name: getRedirectUri(string) - uid: '@azure/msal-browser.SilentCacheClient.getRedirectUri' - 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' - parameters: - - id: requestRedirectUri - type: string - description: '' - return: - description: Redirect URL - type: string - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) -methods: - - name: acquireToken(CommonSilentFlowRequest) - uid: '@azure/msal-browser.SilentCacheClient.acquireToken' - package: '@azure/msal-browser' - summary: 'Returns unexpired tokens from the cache, if available' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(silentRequest: CommonSilentFlowRequest): - Promise - parameters: - - id: silentRequest - type: CommonSilentFlowRequest - description: |+ - - return: - description: '' - type: Promise<AuthenticationResult> - - name: 'initializeSilentRequest(SilentRequest, AccountInfo)' - uid: '@azure/msal-browser.SilentCacheClient.initializeSilentRequest' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function initializeSilentRequest(request: SilentRequest, account: - AccountInfo): Promise - parameters: - - id: request - type: - description: '' - - id: account - type: AccountInfo - description: '' - return: - description: '' - type: Promise<CommonSilentFlowRequest> - - name: logout() - uid: '@azure/msal-browser.SilentCacheClient.logout' - package: '@azure/msal-browser' - summary: Currently Unsupported - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(): Promise' - return: - description: '' - type: Promise<void> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SilentHandler.yml b/msal/docs-ref-autogen/@azure/msal-browser/SilentHandler.yml deleted file mode 100644 index 40f460f..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml deleted file mode 100644 index 492a1c5..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/SilentIframeClient.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: SilentIframeClient -uid: '@azure/msal-browser.SilentIframeClient' -package: '@azure/msal-browser' -summary: '' -fullName: SilentIframeClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - SilentIframeClient(BrowserConfiguration, BrowserCacheManager, ICrypto, - Logger, EventHandler, INavigationClient, ApiId, IPerformanceClient, - BrowserCacheManager, NativeMessageHandler, string) - uid: '@azure/msal-browser.SilentIframeClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new SilentIframeClient(config: BrowserConfiguration, storageImpl: - BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, - eventHandler: EventHandler, navigationClient: INavigationClient, apiId: - ApiId, performanceClient: IPerformanceClient, nativeStorageImpl: - BrowserCacheManager, nativeMessageHandler?: NativeMessageHandler, - correlationId?: string) - parameters: - - id: config - type: - description: '' - - id: storageImpl - type: - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' - - id: eventHandler - type: - description: '' - - id: navigationClient - type: - description: '' - - id: apiId - type: - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: nativeStorageImpl - type: - description: '' - - id: nativeMessageHandler - type: - description: '' - - id: correlationId - type: string - description: '' -inheritedMethods: - - name: getRedirectUri(string) - uid: '@azure/msal-browser.SilentIframeClient.getRedirectUri' - 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' - parameters: - - id: requestRedirectUri - type: string - description: '' - return: - description: Redirect URL - type: string - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) -methods: - - name: acquireToken(SsoSilentRequest) - uid: '@azure/msal-browser.SilentIframeClient.acquireToken' - package: '@azure/msal-browser' - summary: >- - 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: >- - function acquireToken(request: SsoSilentRequest): - Promise - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<AuthenticationResult> - - name: logout() - uid: '@azure/msal-browser.SilentIframeClient.logout' - package: '@azure/msal-browser' - summary: Currently Unsupported - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(): Promise' - return: - description: '' - type: Promise<void> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml deleted file mode 100644 index 2582385..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/SilentRefreshClient.yml +++ /dev/null @@ -1,109 +0,0 @@ -### YamlMime:TSType -name: SilentRefreshClient -uid: '@azure/msal-browser.SilentRefreshClient' -package: '@azure/msal-browser' -summary: '' -fullName: SilentRefreshClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - SilentRefreshClient(BrowserConfiguration, BrowserCacheManager, ICrypto, - Logger, EventHandler, INavigationClient, IPerformanceClient, - NativeMessageHandler, string) - uid: '@azure/msal-browser.SilentRefreshClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new SilentRefreshClient(config: BrowserConfiguration, storageImpl: - BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, - eventHandler: EventHandler, navigationClient: INavigationClient, - performanceClient: IPerformanceClient, nativeMessageHandler?: - NativeMessageHandler, correlationId?: string) - parameters: - - id: config - type: - description: '' - - id: storageImpl - type: - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' - - id: eventHandler - type: - description: '' - - id: navigationClient - type: - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: nativeMessageHandler - type: - description: '' - - id: correlationId - type: string - description: '' -inheritedMethods: - - name: getRedirectUri(string) - uid: '@azure/msal-browser.SilentRefreshClient.getRedirectUri' - 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' - parameters: - - id: requestRedirectUri - type: string - description: '' - return: - description: Redirect URL - type: string - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) -methods: - - name: acquireToken(CommonSilentFlowRequest) - uid: '@azure/msal-browser.SilentRefreshClient.acquireToken' - package: '@azure/msal-browser' - summary: Exchanges the refresh token for new tokens - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: CommonSilentFlowRequest): - Promise - parameters: - - id: request - type: CommonSilentFlowRequest - description: |+ - - return: - description: '' - type: Promise<AuthenticationResult> - - name: logout() - uid: '@azure/msal-browser.SilentRefreshClient.logout' - package: '@azure/msal-browser' - summary: Currently Unsupported - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(): Promise' - return: - description: '' - type: Promise<void> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml index 71c3bfb..74187b7 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SilentRequest.yml @@ -2,7 +2,7 @@ name: SilentRequest uid: '@azure/msal-browser.SilentRequest' package: '@azure/msal-browser' -summary: > +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 @@ -10,6 +10,7 @@ summary: > in a hidden iframe. + - scopes - Array of scopes the application is requesting access to. @@ -27,6 +28,9 @@ summary: > - 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. @@ -44,7 +48,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< @@ -55,12 +58,13 @@ syntax: | | "account" | "requestedClaimsHash" > & { - account?: AccountInfo, - authority?: string, - cacheLookupPolicy?: CacheLookupPolicy, - correlationId?: string, - extraQueryParameters?: StringDict, - forceRefresh?: boolean, - prompt?: string, - redirectUri?: string, + account?: AccountInfo + authority?: string + cacheLookupPolicy?: CacheLookupPolicy + correlationId?: string + extraQueryParameters?: StringDict + forceRefresh?: boolean + prompt?: string + redirectUri?: string + state?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml index a5b2b5d..3b630ee 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/SsoSilentRequest.yml @@ -2,10 +2,11 @@ name: SsoSilentRequest uid: '@azure/msal-browser.SsoSilentRequest' package: '@azure/msal-browser' -summary: > +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) @@ -55,6 +56,10 @@ summary: > - 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 @@ -63,7 +68,6 @@ summary: > to mitigate replay attacks. fullName: SsoSilentRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type SsoSilentRequest = Partial< @@ -73,6 +77,6 @@ syntax: | | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" - | "nativeBroker" + | "platformBroker" > > diff --git a/msal/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml deleted file mode 100644 index a9e721e..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/StandardInteractionClient.yml +++ /dev/null @@ -1,122 +0,0 @@ -### YamlMime:TSType -name: StandardInteractionClient -uid: '@azure/msal-browser.StandardInteractionClient' -package: '@azure/msal-browser' -summary: >- - Defines the class structure and helper functions used by the "standard", - non-brokered auth flows (popup, redirect, silent (RT), silent (iframe)) -fullName: StandardInteractionClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - StandardInteractionClient(BrowserConfiguration, BrowserCacheManager, - ICrypto, Logger, EventHandler, INavigationClient, IPerformanceClient, - NativeMessageHandler, string) - uid: '@azure/msal-browser.StandardInteractionClient.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new StandardInteractionClient(config: BrowserConfiguration, storageImpl: - BrowserCacheManager, browserCrypto: ICrypto, logger: Logger, - eventHandler: EventHandler, navigationClient: INavigationClient, - performanceClient: IPerformanceClient, nativeMessageHandler?: - NativeMessageHandler, correlationId?: string) - parameters: - - id: config - type: - description: '' - - id: storageImpl - type: - description: '' - - id: browserCrypto - type: ICrypto - description: '' - - id: logger - type: Logger - description: '' - - id: eventHandler - type: - description: '' - - id: navigationClient - type: - description: '' - - id: performanceClient - type: IPerformanceClient - description: '' - - id: nativeMessageHandler - type: - description: '' - - id: correlationId - type: string - description: '' -inheritedMethods: - - name: acquireToken(RedirectRequest | PopupRequest | SsoSilentRequest) - uid: '@azure/msal-browser.StandardInteractionClient.acquireToken' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: RedirectRequest | PopupRequest | - SsoSilentRequest): Promise - parameters: - - id: request - type: >- - | | - description: '' - return: - description: '' - type: Promise<AuthenticationResult | void> - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.acquireToken](xref:@azure/msal-browser.BaseInteractionClient.acquireToken) - - name: getRedirectUri(string) - uid: '@azure/msal-browser.StandardInteractionClient.getRedirectUri' - 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' - parameters: - - id: requestRedirectUri - type: string - description: '' - return: - description: Redirect URL - type: string - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.getRedirectUri](xref:@azure/msal-browser.BaseInteractionClient.getRedirectUri) - - name: logout(EndSessionRequest) - uid: '@azure/msal-browser.StandardInteractionClient.logout' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(request: EndSessionRequest): Promise' - parameters: - - id: request - type: - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: >- - Inherited From - [BaseInteractionClient.logout](xref:@azure/msal-browser.BaseInteractionClient.logout) -extends: 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/TemporaryCacheKeys.yml b/msal/docs-ref-autogen/@azure/msal-browser/TemporaryCacheKeys.yml deleted file mode 100644 index d7ab3e1..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/TemporaryCacheKeys.yml +++ /dev/null @@ -1,66 +0,0 @@ -### YamlMime:TSEnum -name: TemporaryCacheKeys -uid: '@azure/msal-browser.TemporaryCacheKeys' -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 - uid: '@azure/msal-browser.TemporaryCacheKeys.ACQUIRE_TOKEN_ACCOUNT' - package: '@azure/msal-browser' - summary: '' - - name: AUTHORITY - uid: '@azure/msal-browser.TemporaryCacheKeys.AUTHORITY' - package: '@azure/msal-browser' - summary: '' - - name: CCS_CREDENTIAL - uid: '@azure/msal-browser.TemporaryCacheKeys.CCS_CREDENTIAL' - package: '@azure/msal-browser' - summary: '' - - name: CORRELATION_ID - uid: '@azure/msal-browser.TemporaryCacheKeys.CORRELATION_ID' - package: '@azure/msal-browser' - summary: '' - - name: INTERACTION_STATUS_KEY - uid: '@azure/msal-browser.TemporaryCacheKeys.INTERACTION_STATUS_KEY' - package: '@azure/msal-browser' - summary: '' - - name: NATIVE_REQUEST - uid: '@azure/msal-browser.TemporaryCacheKeys.NATIVE_REQUEST' - package: '@azure/msal-browser' - summary: '' - - name: NONCE_IDTOKEN - uid: '@azure/msal-browser.TemporaryCacheKeys.NONCE_IDTOKEN' - package: '@azure/msal-browser' - summary: '' - - name: ORIGIN_URI - uid: '@azure/msal-browser.TemporaryCacheKeys.ORIGIN_URI' - package: '@azure/msal-browser' - summary: '' - - name: RENEW_STATUS - uid: '@azure/msal-browser.TemporaryCacheKeys.RENEW_STATUS' - package: '@azure/msal-browser' - summary: '' - - name: REQUEST_PARAMS - uid: '@azure/msal-browser.TemporaryCacheKeys.REQUEST_PARAMS' - package: '@azure/msal-browser' - summary: '' - - name: REQUEST_STATE - uid: '@azure/msal-browser.TemporaryCacheKeys.REQUEST_STATE' - package: '@azure/msal-browser' - summary: '' - - name: SCOPES - uid: '@azure/msal-browser.TemporaryCacheKeys.SCOPES' - package: '@azure/msal-browser' - summary: '' - - name: SESSION_STATE - uid: '@azure/msal-browser.TemporaryCacheKeys.SESSION_STATE' - package: '@azure/msal-browser' - summary: '' - - name: URL_HASH - uid: '@azure/msal-browser.TemporaryCacheKeys.URL_HASH' - package: '@azure/msal-browser' - summary: '' 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/TokenCache.yml b/msal/docs-ref-autogen/@azure/msal-browser/TokenCache.yml deleted file mode 100644 index 97346cd..0000000 --- a/msal/docs-ref-autogen/@azure/msal-browser/TokenCache.yml +++ /dev/null @@ -1,74 +0,0 @@ -### YamlMime:TSType -name: TokenCache -uid: '@azure/msal-browser.TokenCache' -package: '@azure/msal-browser' -summary: Token cache manager -fullName: TokenCache -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'TokenCache(BrowserConfiguration, BrowserCacheManager, Logger, ICrypto)' - uid: '@azure/msal-browser.TokenCache.constructor' - package: '@azure/msal-browser' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new TokenCache(configuration: BrowserConfiguration, storage: - BrowserCacheManager, logger: Logger, cryptoObj: ICrypto) - parameters: - - id: configuration - type: - description: '' - - id: storage - type: - description: '' - - id: logger - type: Logger - description: '' - - id: cryptoObj - type: ICrypto - description: '' -properties: - - name: isBrowserEnvironment - uid: '@azure/msal-browser.TokenCache.isBrowserEnvironment' - package: '@azure/msal-browser' - summary: '' - fullName: isBrowserEnvironment - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'isBrowserEnvironment: boolean' - return: - description: '' - type: boolean -methods: - - name: 'loadExternalTokens(SilentRequest, ExternalTokenResponse, LoadTokenOptions)' - uid: '@azure/msal-browser.TokenCache.loadExternalTokens' - package: '@azure/msal-browser' - summary: API to load tokens to msal-browser cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function loadExternalTokens(request: SilentRequest, response: - ExternalTokenResponse, options: LoadTokenOptions): AuthenticationResult - parameters: - - id: request - type: - description: '' - - id: response - type: ExternalTokenResponse - description: '' - - id: options - type: - description: '' - return: - description: '`AuthenticationResult` for the response that was loaded.' - type: AuthenticationResult 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 index 012dac1..fcdf4fa 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/WrapperSKU.yml @@ -1,18 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: WrapperSKU uid: '@azure/msal-browser.WrapperSKU' package: '@azure/msal-browser' summary: '' fullName: WrapperSKU remarks: '' -isPreview: false isDeprecated: false -fields: - - name: Angular - uid: '@azure/msal-browser.WrapperSKU.Angular' - package: '@azure/msal-browser' - summary: '' - - name: React - uid: '@azure/msal-browser.WrapperSKU.React' - package: '@azure/msal-browser' - summary: '' +syntax: | + type WrapperSKU = (typeof WrapperSKU)[keyof typeof WrapperSKU] diff --git a/msal/docs-ref-autogen/@azure/msal-browser/XhrClient.yml b/msal/docs-ref-autogen/@azure/msal-browser/XhrClient.yml deleted file mode 100644 index e23f543..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-browser/index.yml b/msal/docs-ref-autogen/@azure/msal-browser/index.yml index 65f25a9..8c875ca 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/index.yml @@ -3,190 +3,132 @@ 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.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.AuthError' + - '@azure/msal-browser.AuthenticationHeaderParser' - '@azure/msal-browser.BrowserAuthError' - '@azure/msal-browser.BrowserConfigurationAuthError' - - '@azure/msal-browser.NativeAuthError' + - '@azure/msal-browser.BrowserPerformanceClient' + - '@azure/msal-browser.BrowserPerformanceMeasurement' + - '@azure/msal-browser.ClientAuthError' + - '@azure/msal-browser.ClientConfigurationError' - '@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' - - '@azure/msal-browser.SilentAuthCodeClient' - - '@azure/msal-browser.SilentCacheClient' - - '@azure/msal-browser.SilentIframeClient' - - '@azure/msal-browser.SilentRefreshClient' - - '@azure/msal-browser.StandardInteractionClient' - - '@azure/msal-browser.InteractionHandler' - - '@azure/msal-browser.RedirectHandler' - - '@azure/msal-browser.SilentHandler' + - '@azure/msal-browser.InteractionRequiredAuthError' + - '@azure/msal-browser.LocalStorage' + - '@azure/msal-browser.Logger' + - '@azure/msal-browser.MemoryStorage' - '@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' + - '@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' 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.IAsyncStorage' - '@azure/msal-browser.ITokenCache' - '@azure/msal-browser.IWindowStorage' - - '@azure/msal-browser.ISubtleCrypto' - - '@azure/msal-browser.INavigationClient' typeAliases: - - '@azure/msal-browser.NativeExtensionRequest' - - '@azure/msal-browser.NativeExtensionRequestBody' - - '@azure/msal-browser.NativeTokenRequest' - - '@azure/msal-browser.MATS' - - '@azure/msal-browser.NativeAccountInfo' - - '@azure/msal-browser.NativeResponse' - - '@azure/msal-browser.NativeResponseProperties' - - '@azure/msal-browser.LoadTokenOptions' + - '@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.BrowserConfiguration' + - '@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.CryptoOptions' - - '@azure/msal-browser.CachedKeyPair' - - '@azure/msal-browser.SignedHttpRequestOptions' - - '@azure/msal-browser.OSError' + - '@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.PopupEvent' - - '@azure/msal-browser.PopupParams' - - '@azure/msal-browser.InteractionParams' - - '@azure/msal-browser.RedirectParams' + - '@azure/msal-browser.EventType' + - '@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' - '@azure/msal-browser.NavigationOptions' - - '@azure/msal-browser.AuthorizationCodeRequest' - - '@azure/msal-browser.AuthorizationUrlRequest' - - '@azure/msal-browser.EndSessionPopupRequest' - - '@azure/msal-browser.EndSessionRequest' - - '@azure/msal-browser.PopupRequest' + - '@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.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.TenantProfile' - '@azure/msal-browser.WrapperSKU' functions: - - name: >- - buildConfiguration({ userInputAuth: { authority?: string, - authorityMetadata?: string, azureCloudOptions?: AzureCloudOptions, - clientCapabilities?: Array, clientId: string, - cloudDiscoveryMetadata?: string, knownAuthorities?: Array, - navigateToLoginRequestUrl?: boolean, postLogoutRedirectUri?: string | - null, protocolMode?: ProtocolMode, redirectUri?: string, - 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) - uid: '@azure/msal-browser.buildConfiguration' + - name: createNestablePublicClientApplication(Configuration) + uid: '@azure/msal-browser.createNestablePublicClientApplication' package: '@azure/msal-browser' summary: >- - MSAL function that sets the default options when not explicitly configured - from app developer + creates NestedAppAuthController and passes it to the + PublicClientApplication, + + falls back to StandardController if NestedAppAuthController is not + available remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function buildConfiguration(__namedParameters: { userInputAuth: { - authority?: string, authorityMetadata?: string, azureCloudOptions?: - AzureCloudOptions, clientCapabilities?: Array, clientId: string, - cloudDiscoveryMetadata?: string, knownAuthorities?: Array, - navigateToLoginRequestUrl?: boolean, postLogoutRedirectUri?: string | - null, protocolMode?: ProtocolMode, redirectUri?: string, - 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 } }, - isBrowserEnvironment: boolean): BrowserConfiguration + function createNestablePublicClientApplication(configuration: + Configuration): Promise parameters: - - id: __namedParameters - type: >- - { userInputAuth: { authority?: string, authorityMetadata?: string, - azureCloudOptions?: AzureCloudOptions, clientCapabilities?: - Array<string>, clientId: string, cloudDiscoveryMetadata?: - string, knownAuthorities?: Array<string>, - navigateToLoginRequestUrl?: boolean, postLogoutRedirectUri?: string - | null, protocolMode?: ProtocolMode, redirectUri?: string, - 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 } } + - id: configuration + type: description: '' - - id: isBrowserEnvironment - type: boolean + 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: Configuration object - type: + description: IPublicClientApplication + type: >- + Promise<> diff --git a/msal/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml b/msal/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml index 2ba7ffd..e4082ab 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AADAuthorityConstants.yml @@ -1,22 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: AADAuthorityConstants uid: '@azure/msal-common.AADAuthorityConstants' package: '@azure/msal-common' -summary: String constants related to AAD Authority +summary: '' fullName: AADAuthorityConstants remarks: '' -isPreview: false isDeprecated: false -fields: - - name: COMMON - uid: '@azure/msal-common.AADAuthorityConstants.COMMON' - package: '@azure/msal-common' - summary: '' - - name: CONSUMERS - uid: '@azure/msal-common.AADAuthorityConstants.CONSUMERS' - package: '@azure/msal-common' - summary: '' - - name: ORGANIZATIONS - uid: '@azure/msal-common.AADAuthorityConstants.ORGANIZATIONS' - package: '@azure/msal-common' - summary: '' +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 index dc15f07..d30feb3 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AADServerParamKeys.yml @@ -1,202 +1,6 @@ -### YamlMime:TSEnum -name: AADServerParamKeys +### YamlMime:TSPackage uid: '@azure/msal-common.AADServerParamKeys' +name: AADServerParamKeys +type: module package: '@azure/msal-common' -summary: Keys in the hashParams sent by AAD Server -fullName: AADServerParamKeys -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: ACCESS_TOKEN - uid: '@azure/msal-common.AADServerParamKeys.ACCESS_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: CCS_HEADER - uid: '@azure/msal-common.AADServerParamKeys.CCS_HEADER' - package: '@azure/msal-common' - summary: '' - - name: CLAIMS - uid: '@azure/msal-common.AADServerParamKeys.CLAIMS' - package: '@azure/msal-common' - summary: '' - - name: CLIENT_ASSERTION - uid: '@azure/msal-common.AADServerParamKeys.CLIENT_ASSERTION' - package: '@azure/msal-common' - summary: '' - - name: CLIENT_ASSERTION_TYPE - uid: '@azure/msal-common.AADServerParamKeys.CLIENT_ASSERTION_TYPE' - package: '@azure/msal-common' - summary: '' - - name: CLIENT_ID - uid: '@azure/msal-common.AADServerParamKeys.CLIENT_ID' - package: '@azure/msal-common' - summary: '' - - name: CLIENT_INFO - uid: '@azure/msal-common.AADServerParamKeys.CLIENT_INFO' - package: '@azure/msal-common' - summary: '' - - name: CLIENT_REQUEST_ID - uid: '@azure/msal-common.AADServerParamKeys.CLIENT_REQUEST_ID' - package: '@azure/msal-common' - summary: '' - - name: CLIENT_SECRET - uid: '@azure/msal-common.AADServerParamKeys.CLIENT_SECRET' - package: '@azure/msal-common' - summary: '' - - name: CODE - uid: '@azure/msal-common.AADServerParamKeys.CODE' - package: '@azure/msal-common' - summary: '' - - name: CODE_CHALLENGE - uid: '@azure/msal-common.AADServerParamKeys.CODE_CHALLENGE' - package: '@azure/msal-common' - summary: '' - - name: CODE_CHALLENGE_METHOD - uid: '@azure/msal-common.AADServerParamKeys.CODE_CHALLENGE_METHOD' - package: '@azure/msal-common' - summary: '' - - name: CODE_VERIFIER - uid: '@azure/msal-common.AADServerParamKeys.CODE_VERIFIER' - package: '@azure/msal-common' - summary: '' - - name: DEVICE_CODE - uid: '@azure/msal-common.AADServerParamKeys.DEVICE_CODE' - package: '@azure/msal-common' - summary: '' - - name: ERROR - uid: '@azure/msal-common.AADServerParamKeys.ERROR' - package: '@azure/msal-common' - summary: '' - - name: ERROR_DESCRIPTION - uid: '@azure/msal-common.AADServerParamKeys.ERROR_DESCRIPTION' - package: '@azure/msal-common' - summary: '' - - name: EXPIRES_IN - uid: '@azure/msal-common.AADServerParamKeys.EXPIRES_IN' - package: '@azure/msal-common' - summary: '' - - name: FOCI - uid: '@azure/msal-common.AADServerParamKeys.FOCI' - package: '@azure/msal-common' - summary: '' - - name: GRANT_TYPE - uid: '@azure/msal-common.AADServerParamKeys.GRANT_TYPE' - package: '@azure/msal-common' - summary: '' - - name: ID_TOKEN - uid: '@azure/msal-common.AADServerParamKeys.ID_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: ID_TOKEN_HINT - uid: '@azure/msal-common.AADServerParamKeys.ID_TOKEN_HINT' - package: '@azure/msal-common' - summary: '' - - name: LOGOUT_HINT - uid: '@azure/msal-common.AADServerParamKeys.LOGOUT_HINT' - package: '@azure/msal-common' - summary: '' - - name: NATIVE_BROKER - uid: '@azure/msal-common.AADServerParamKeys.NATIVE_BROKER' - package: '@azure/msal-common' - summary: '' - - name: NONCE - uid: '@azure/msal-common.AADServerParamKeys.NONCE' - package: '@azure/msal-common' - summary: '' - - name: OBO_ASSERTION - uid: '@azure/msal-common.AADServerParamKeys.OBO_ASSERTION' - package: '@azure/msal-common' - summary: '' - - name: ON_BEHALF_OF - uid: '@azure/msal-common.AADServerParamKeys.ON_BEHALF_OF' - package: '@azure/msal-common' - summary: '' - - name: POST_LOGOUT_URI - uid: '@azure/msal-common.AADServerParamKeys.POST_LOGOUT_URI' - package: '@azure/msal-common' - summary: '' - - name: PROMPT - uid: '@azure/msal-common.AADServerParamKeys.PROMPT' - package: '@azure/msal-common' - summary: '' - - name: REDIRECT_URI - uid: '@azure/msal-common.AADServerParamKeys.REDIRECT_URI' - package: '@azure/msal-common' - summary: '' - - name: REFRESH_TOKEN - uid: '@azure/msal-common.AADServerParamKeys.REFRESH_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: REQUESTED_TOKEN_USE - uid: '@azure/msal-common.AADServerParamKeys.REQUESTED_TOKEN_USE' - package: '@azure/msal-common' - summary: '' - - name: REQ_CNF - uid: '@azure/msal-common.AADServerParamKeys.REQ_CNF' - package: '@azure/msal-common' - summary: '' - - name: RESPONSE_MODE - uid: '@azure/msal-common.AADServerParamKeys.RESPONSE_MODE' - package: '@azure/msal-common' - summary: '' - - name: RESPONSE_TYPE - uid: '@azure/msal-common.AADServerParamKeys.RESPONSE_TYPE' - package: '@azure/msal-common' - summary: '' - - name: RETURN_SPA_CODE - uid: '@azure/msal-common.AADServerParamKeys.RETURN_SPA_CODE' - package: '@azure/msal-common' - summary: '' - - name: SCOPE - uid: '@azure/msal-common.AADServerParamKeys.SCOPE' - package: '@azure/msal-common' - summary: '' - - name: SESSION_STATE - uid: '@azure/msal-common.AADServerParamKeys.SESSION_STATE' - package: '@azure/msal-common' - summary: '' - - name: STATE - uid: '@azure/msal-common.AADServerParamKeys.STATE' - package: '@azure/msal-common' - summary: '' - - name: TOKEN_TYPE - uid: '@azure/msal-common.AADServerParamKeys.TOKEN_TYPE' - package: '@azure/msal-common' - summary: '' - - name: X_APP_NAME - uid: '@azure/msal-common.AADServerParamKeys.X_APP_NAME' - package: '@azure/msal-common' - summary: '' - - name: X_APP_VER - uid: '@azure/msal-common.AADServerParamKeys.X_APP_VER' - package: '@azure/msal-common' - summary: '' - - name: X_CLIENT_CPU - uid: '@azure/msal-common.AADServerParamKeys.X_CLIENT_CPU' - package: '@azure/msal-common' - summary: '' - - name: X_CLIENT_CURR_TELEM - uid: '@azure/msal-common.AADServerParamKeys.X_CLIENT_CURR_TELEM' - package: '@azure/msal-common' - summary: '' - - name: X_CLIENT_LAST_TELEM - uid: '@azure/msal-common.AADServerParamKeys.X_CLIENT_LAST_TELEM' - package: '@azure/msal-common' - summary: '' - - name: X_CLIENT_OS - uid: '@azure/msal-common.AADServerParamKeys.X_CLIENT_OS' - package: '@azure/msal-common' - summary: '' - - name: X_CLIENT_SKU - uid: '@azure/msal-common.AADServerParamKeys.X_CLIENT_SKU' - package: '@azure/msal-common' - summary: '' - - name: X_CLIENT_VER - uid: '@azure/msal-common.AADServerParamKeys.X_CLIENT_VER' - package: '@azure/msal-common' - summary: '' - - name: X_MS_LIB_CAPABILITY - uid: '@azure/msal-common.AADServerParamKeys.X_MS_LIB_CAPABILITY' - package: '@azure/msal-common' - summary: '' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/AccessTokenCache.yml b/msal/docs-ref-autogen/@azure/msal-common/AccessTokenCache.yml deleted file mode 100644 index dac45b2..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/AccessTokenCache.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: AccessTokenCache -uid: '@azure/msal-common.AccessTokenCache' -package: '@azure/msal-common' -summary: '' -fullName: AccessTokenCache -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AccessTokenCache = Record diff --git a/msal/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml index ee003f4..756f004 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AccessTokenEntity.yml @@ -1,520 +1,20 @@ -### YamlMime:TSType +### YamlMime:TSTypeAlias name: AccessTokenEntity uid: '@azure/msal-common.AccessTokenEntity' package: '@azure/msal-common' -summary: > - ACCESS_TOKEN Credential Type - - Key:Value Schema: - - - Key Example: - uid.utid-login.microsoftonline.com-accesstoken-clientId-contoso.com-user.read - - - Value Schema: - - { - homeAccountId: home account identifier for the auth scheme, - environment: entity that issued the token, represented as a full host - credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other - clientId: client ID of the application - secret: Actual credential as a string - familyId: Family ID identifier, usually only used for refresh tokens - realm: Full tenant or organizational identifier that the account belongs to - target: Permissions that are included in the token, or for refresh tokens, the resource identifier. - cachedAt: Absolute device time when entry was created in the cache. - expiresOn: Token expiry time, calculated based on current UTC time in seconds. Represented as a string. - extendedExpiresOn: Additional extended expiry time until when token is valid in case of server-side outage. Represented as string in UTC seconds. - keyId: used for POP and SSH tokenTypes - tokenType: Type of the token issued. Usually "Bearer" - } +summary: Access token cache type fullName: AccessTokenEntity remarks: '' -isPreview: false isDeprecated: false -type: class -properties: - - name: cachedAt - uid: '@azure/msal-common.AccessTokenEntity.cachedAt' - package: '@azure/msal-common' - summary: '' - fullName: cachedAt - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'cachedAt: string' - return: - description: '' - type: string - - name: expiresOn - uid: '@azure/msal-common.AccessTokenEntity.expiresOn' - package: '@azure/msal-common' - summary: '' - fullName: expiresOn - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'expiresOn: string' - return: - description: '' - type: string - - name: extendedExpiresOn - uid: '@azure/msal-common.AccessTokenEntity.extendedExpiresOn' - package: '@azure/msal-common' - summary: '' - fullName: extendedExpiresOn - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'extendedExpiresOn?: string' - return: - description: '' - type: string - - name: keyId - uid: '@azure/msal-common.AccessTokenEntity.keyId' - package: '@azure/msal-common' - summary: '' - fullName: keyId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'keyId?: string' - return: - description: '' - type: string - - name: realm - uid: '@azure/msal-common.AccessTokenEntity.realm' - package: '@azure/msal-common' - summary: '' - fullName: realm - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'realm: string' - return: - description: '' - type: string - - name: refreshOn - uid: '@azure/msal-common.AccessTokenEntity.refreshOn' - package: '@azure/msal-common' - summary: '' - fullName: refreshOn - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'refreshOn?: string' - return: - description: '' - type: string - - name: requestedClaims - uid: '@azure/msal-common.AccessTokenEntity.requestedClaims' - package: '@azure/msal-common' - summary: '' - fullName: requestedClaims - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'requestedClaims?: string' - return: - description: '' - type: string - - name: requestedClaimsHash - uid: '@azure/msal-common.AccessTokenEntity.requestedClaimsHash' - package: '@azure/msal-common' - summary: '' - fullName: requestedClaimsHash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'requestedClaimsHash?: string' - return: - description: '' - type: string - - name: target - uid: '@azure/msal-common.AccessTokenEntity.target' - package: '@azure/msal-common' - summary: '' - fullName: target - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'target: string' - return: - description: '' - type: string - - name: tokenType - uid: '@azure/msal-common.AccessTokenEntity.tokenType' - package: '@azure/msal-common' - summary: '' - fullName: tokenType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tokenType?: AuthenticationScheme' - return: - description: '' - type: -inheritedProperties: - - name: clientId - uid: '@azure/msal-common.AccessTokenEntity.clientId' - package: '@azure/msal-common' - summary: '' - fullName: clientId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clientId: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.clientId](xref:@azure/msal-common.CredentialEntity.clientId) - - name: credentialType - uid: '@azure/msal-common.AccessTokenEntity.credentialType' - package: '@azure/msal-common' - summary: '' - fullName: credentialType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'credentialType: CredentialType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [CredentialEntity.credentialType](xref:@azure/msal-common.CredentialEntity.credentialType) - - name: environment - uid: '@azure/msal-common.AccessTokenEntity.environment' - package: '@azure/msal-common' - summary: '' - fullName: environment - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'environment: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.environment](xref:@azure/msal-common.CredentialEntity.environment) - - name: familyId - uid: '@azure/msal-common.AccessTokenEntity.familyId' - package: '@azure/msal-common' - summary: '' - fullName: familyId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'familyId?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.familyId](xref:@azure/msal-common.CredentialEntity.familyId) - - name: homeAccountId - uid: '@azure/msal-common.AccessTokenEntity.homeAccountId' - package: '@azure/msal-common' - summary: '' - fullName: homeAccountId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'homeAccountId: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.homeAccountId](xref:@azure/msal-common.CredentialEntity.homeAccountId) - - name: secret - uid: '@azure/msal-common.AccessTokenEntity.secret' - package: '@azure/msal-common' - summary: '' - fullName: secret - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'secret: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.secret](xref:@azure/msal-common.CredentialEntity.secret) - - name: userAssertionHash - uid: '@azure/msal-common.AccessTokenEntity.userAssertionHash' - package: '@azure/msal-common' - summary: '' - fullName: userAssertionHash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userAssertionHash?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.userAssertionHash](xref:@azure/msal-common.CredentialEntity.userAssertionHash) -inheritedMethods: - - name: generateAccountId() - uid: '@azure/msal-common.AccessTokenEntity.generateAccountId' - package: '@azure/msal-common' - summary: >- - Generate Account Id key component as per the schema: - - - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateAccountId(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateAccountId](xref:@azure/msal-common.CredentialEntity.generateAccountId) - - name: >- - generateCredentialCacheKey(string, string, CredentialType, string, string, - string, string, AuthenticationScheme, string) - uid: '@azure/msal-common.AccessTokenEntity.generateCredentialCacheKey' - package: '@azure/msal-common' - summary: >- - generates credential key - - -\----- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateCredentialCacheKey(homeAccountId: string, - environment: string, credentialType: CredentialType, clientId: string, - realm?: string, target?: string, familyId?: string, tokenType?: - AuthenticationScheme, requestedClaimsHash?: string): string - parameters: - - id: homeAccountId - type: string - description: '' - - id: environment - type: string - description: '' - - id: credentialType - type: - description: '' - - id: clientId - type: string - description: '' - - id: realm - type: string - description: '' - - id: target - type: string - description: '' - - id: familyId - type: string - description: '' - - id: tokenType - type: - description: '' - - id: requestedClaimsHash - type: string - description: '' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateCredentialCacheKey](xref:@azure/msal-common.CredentialEntity.generateCredentialCacheKey) - - name: generateCredentialId() - uid: '@azure/msal-common.AccessTokenEntity.generateCredentialId' - package: '@azure/msal-common' - summary: >- - Generate Credential Id key component as per the schema: - -- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCredentialId(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateCredentialId](xref:@azure/msal-common.CredentialEntity.generateCredentialId) - - name: generateCredentialKey() - uid: '@azure/msal-common.AccessTokenEntity.generateCredentialKey' - package: '@azure/msal-common' - summary: generates credential key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCredentialKey(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateCredentialKey](xref:@azure/msal-common.CredentialEntity.generateCredentialKey) - - name: generateTarget() - uid: '@azure/msal-common.AccessTokenEntity.generateTarget' - package: '@azure/msal-common' - summary: 'Generate target key component as per schema: ' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateTarget(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateTarget](xref:@azure/msal-common.CredentialEntity.generateTarget) - - name: generateType() - uid: '@azure/msal-common.AccessTokenEntity.generateType' - 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' - return: - description: '' - type: number - 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: '' - isPreview: false - 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, - number, number, ICrypto, number, AuthenticationScheme, string, string, - string, string) - uid: '@azure/msal-common.AccessTokenEntity.createAccessTokenEntity' - package: '@azure/msal-common' - summary: Create AccessTokenEntity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createAccessTokenEntity(homeAccountId: string, - environment: string, accessToken: string, clientId: string, tenantId: - string, scopes: string, expiresOn: number, extExpiresOn: number, - cryptoUtils: ICrypto, 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: cryptoUtils - type: - description: '' - - id: refreshOn - type: number - description: '' - - id: tokenType - type: - 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: isAccessTokenEntity(object) - uid: '@azure/msal-common.AccessTokenEntity.isAccessTokenEntity' - 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' - parameters: - - id: entity - type: object - description: |+ - - return: - description: '' - type: boolean -extends: +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/AccountCache.yml b/msal/docs-ref-autogen/@azure/msal-common/AccountCache.yml deleted file mode 100644 index a2d75f0..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/AccountCache.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: AccountCache -uid: '@azure/msal-common.AccountCache' -package: '@azure/msal-common' -summary: '' -fullName: AccountCache -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AccountCache = Record diff --git a/msal/docs-ref-autogen/@azure/msal-common/AccountEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/AccountEntity.yml deleted file mode 100644 index 385edc4..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/AccountEntity.yml +++ /dev/null @@ -1,447 +0,0 @@ -### YamlMime:TSType -name: AccountEntity -uid: '@azure/msal-common.AccountEntity' -package: '@azure/msal-common' -summary: > - Type that defines required and optional parameters for an Account field (based - on universal cache schema implemented by all MSALs). - - Key : Value Schema - - - Key: -- - - - Value Schema: - - { - homeAccountId: home account identifier for the auth scheme, - environment: entity that issued the token, represented as a full host - realm: Full tenant or organizational identifier that the account belongs to - localAccountId: Original tenant-specific accountID, usually used for legacy cases - username: primary username that represents the user, usually corresponds to preferred_username in the v2 endpt - authorityType: Accounts authority type as a string - name: Full name for the account, including given name and family name, - clientInfo: Full base64 encoded client info received from ESTS - lastModificationTime: last time this entity was modified in the cache - lastModificationApp: - idTokenClaims: Object containing claims parsed from ID token - nativeAccountId: Account identifier on the native device - } -fullName: AccountEntity -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: authorityType - uid: '@azure/msal-common.AccountEntity.authorityType' - package: '@azure/msal-common' - summary: '' - fullName: authorityType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authorityType: string' - return: - description: '' - type: string - - name: clientInfo - uid: '@azure/msal-common.AccountEntity.clientInfo' - package: '@azure/msal-common' - summary: '' - fullName: clientInfo - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clientInfo?: string' - return: - description: '' - type: string - - name: cloudGraphHostName - uid: '@azure/msal-common.AccountEntity.cloudGraphHostName' - package: '@azure/msal-common' - summary: '' - fullName: cloudGraphHostName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'cloudGraphHostName?: string' - return: - description: '' - type: string - - name: environment - uid: '@azure/msal-common.AccountEntity.environment' - package: '@azure/msal-common' - summary: '' - fullName: environment - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'environment: string' - return: - description: '' - type: string - - name: homeAccountId - uid: '@azure/msal-common.AccountEntity.homeAccountId' - package: '@azure/msal-common' - summary: '' - fullName: homeAccountId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'homeAccountId: string' - return: - description: '' - type: string - - name: idTokenClaims - uid: '@azure/msal-common.AccountEntity.idTokenClaims' - package: '@azure/msal-common' - summary: '' - fullName: idTokenClaims - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'idTokenClaims?: TokenClaims' - return: - description: '' - type: - - name: lastModificationApp - uid: '@azure/msal-common.AccountEntity.lastModificationApp' - package: '@azure/msal-common' - summary: '' - fullName: lastModificationApp - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'lastModificationApp?: string' - return: - description: '' - type: string - - name: lastModificationTime - uid: '@azure/msal-common.AccountEntity.lastModificationTime' - package: '@azure/msal-common' - summary: '' - fullName: lastModificationTime - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'lastModificationTime?: string' - return: - description: '' - type: string - - name: localAccountId - uid: '@azure/msal-common.AccountEntity.localAccountId' - package: '@azure/msal-common' - summary: '' - fullName: localAccountId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'localAccountId: string' - return: - description: '' - type: string - - name: msGraphHost - uid: '@azure/msal-common.AccountEntity.msGraphHost' - package: '@azure/msal-common' - summary: '' - fullName: msGraphHost - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'msGraphHost?: string' - return: - description: '' - type: string - - name: name - uid: '@azure/msal-common.AccountEntity.name' - package: '@azure/msal-common' - summary: '' - fullName: name - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'name?: string' - return: - description: '' - type: string - - name: nativeAccountId - uid: '@azure/msal-common.AccountEntity.nativeAccountId' - package: '@azure/msal-common' - summary: '' - fullName: nativeAccountId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'nativeAccountId?: string' - return: - description: '' - type: string - - name: realm - uid: '@azure/msal-common.AccountEntity.realm' - package: '@azure/msal-common' - summary: '' - fullName: realm - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'realm: string' - return: - description: '' - type: string - - name: username - uid: '@azure/msal-common.AccountEntity.username' - package: '@azure/msal-common' - summary: '' - fullName: username - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'username: string' - return: - description: '' - type: string -methods: - - name: 'accountInfoIsEqual(AccountInfo | null, AccountInfo | null, boolean)' - uid: '@azure/msal-common.AccountEntity.accountInfoIsEqual' - package: '@azure/msal-common' - summary: >- - Helper function to determine whether 2 accountInfo objects represent the - same account - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function accountInfoIsEqual(accountA: AccountInfo | null, - accountB: AccountInfo | null, compareClaims?: boolean): boolean - parameters: - - id: accountA - type: | null - description: '' - - id: accountB - type: | null - description: '' - - id: compareClaims - type: boolean - description: > - If set to true idTokenClaims will also be compared to determine - account equality - return: - description: '' - type: boolean - - name: >- - createAccount(string, string, AuthToken, Authority, string, string, - string, string) - uid: '@azure/msal-common.AccountEntity.createAccount' - package: '@azure/msal-common' - summary: >- - Build Account cache from IdToken, clientInfo and authority/policy. - Associated with AAD. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createAccount(clientInfo: string, homeAccountId: string, - idToken: AuthToken, authority?: Authority, cloudGraphHostName?: string, - msGraphHost?: string, environment?: string, nativeAccountId?: string): - AccountEntity - parameters: - - id: clientInfo - type: string - description: '' - - id: homeAccountId - type: string - description: '' - - id: idToken - type: - description: '' - - id: authority - type: - description: '' - - id: cloudGraphHostName - type: string - description: '' - - id: msGraphHost - type: string - description: '' - - id: environment - type: string - description: '' - - id: nativeAccountId - type: string - description: '' - return: - description: '' - type: - - name: 'createGenericAccount(string, AuthToken, Authority, string, string, string)' - uid: '@azure/msal-common.AccountEntity.createGenericAccount' - package: '@azure/msal-common' - summary: Builds non-AAD/ADFS account. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createGenericAccount(homeAccountId: string, idToken: - AuthToken, authority?: Authority, cloudGraphHostName?: string, - msGraphHost?: string, environment?: string): AccountEntity - parameters: - - id: homeAccountId - type: string - description: '' - - id: idToken - type: - description: |+ - - - id: authority - type: - description: '' - - id: cloudGraphHostName - type: string - description: '' - - id: msGraphHost - type: string - description: '' - - id: environment - type: string - description: '' - return: - description: '' - type: - - name: generateAccountCacheKey(AccountInfo) - uid: '@azure/msal-common.AccountEntity.generateAccountCacheKey' - package: '@azure/msal-common' - summary: Generates account key from interface - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateAccountCacheKey(accountInterface: AccountInfo): - string - parameters: - - id: accountInterface - type: - description: |+ - - return: - description: '' - type: string - - name: generateAccountId() - uid: '@azure/msal-common.AccountEntity.generateAccountId' - package: '@azure/msal-common' - summary: >- - Generate Account Id key component as per the schema: - - - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateAccountId(): string' - return: - description: '' - type: string - - name: generateAccountKey() - uid: '@azure/msal-common.AccountEntity.generateAccountKey' - package: '@azure/msal-common' - summary: >- - Generate Account Cache Key as per the schema: - -- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateAccountKey(): string' - return: - description: '' - type: string - - name: 'generateHomeAccountId(string, AuthorityType, Logger, ICrypto, AuthToken)' - uid: '@azure/msal-common.AccountEntity.generateHomeAccountId' - package: '@azure/msal-common' - summary: Generate HomeAccountId from server response - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateHomeAccountId(serverClientInfo: string, - authType: AuthorityType, logger: Logger, cryptoObj: ICrypto, idToken?: - AuthToken): string - parameters: - - id: serverClientInfo - type: string - description: '' - - id: authType - type: - description: |+ - - - id: logger - type: - description: '' - - id: cryptoObj - type: - description: '' - - id: idToken - type: - description: '' - return: - description: '' - type: string - - name: generateType() - uid: '@azure/msal-common.AccountEntity.generateType' - 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' - return: - description: '' - type: number - - name: getAccountInfo() - uid: '@azure/msal-common.AccountEntity.getAccountInfo' - package: '@azure/msal-common' - summary: Returns the AccountInfo interface for this account. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAccountInfo(): AccountInfo' - return: - description: '' - type: - - name: isAccountEntity(object) - uid: '@azure/msal-common.AccountEntity.isAccountEntity' - 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' - parameters: - - id: entity - type: object - description: |+ - - return: - description: '' - type: boolean diff --git a/msal/docs-ref-autogen/@azure/msal-common/AccountFilter.yml b/msal/docs-ref-autogen/@azure/msal-common/AccountFilter.yml index d440253..3afe3b9 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AccountFilter.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AccountFilter.yml @@ -5,12 +5,12 @@ package: '@azure/msal-common' summary: "Account:\t--" fullName: AccountFilter remarks: '' -isPreview: false isDeprecated: false -syntax: | - type AccountFilter = { - environment?: string, - homeAccountId?: string, - nativeAccountId?: string, - realm?: string, +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 index eaace28..9fdabd4 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AccountInfo.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AccountInfo.yml @@ -26,15 +26,26 @@ summary: >- - idTokenClaims - Object contains claims from ID token - - localAccountId - The user's account ID - - 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: '' -isPreview: false isDeprecated: false -syntax: >- - type AccountInfo = { environment: string, homeAccountId: string, idToken?: - string, idTokenClaims?: TokenClaims & [key: string]: function, localAccountId: - string, name?: string, nativeAccountId?: string, tenantId: string, username: - string } +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 index 8a8df1d..882cb2b 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ActiveAccountFilters.yml @@ -5,7 +5,10 @@ package: '@azure/msal-common' summary: '' fullName: ActiveAccountFilters remarks: '' -isPreview: false isDeprecated: false syntax: | - type ActiveAccountFilters = { homeAccountId: string, localAccountId: string } + type ActiveAccountFilters = { + homeAccountId: string + localAccountId: string + tenantId?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AppMetadataCache.yml b/msal/docs-ref-autogen/@azure/msal-common/AppMetadataCache.yml deleted file mode 100644 index 29c7b63..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/AppMetadataCache.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: AppMetadataCache -uid: '@azure/msal-common.AppMetadataCache' -package: '@azure/msal-common' -summary: '' -fullName: AppMetadataCache -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AppMetadataCache = Record diff --git a/msal/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml index 7fd8c09..4ef689c 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AppMetadataEntity.yml @@ -1,144 +1,14 @@ -### YamlMime:TSType +### YamlMime:TSTypeAlias name: AppMetadataEntity uid: '@azure/msal-common.AppMetadataEntity' package: '@azure/msal-common' -summary: | - APP_METADATA Cache - Key:Value Schema: - - Key: appmetadata-- - - Value: - { - clientId: client ID of the application - environment: entity that issued the token, represented as a full host - familyId: Family ID identifier, '1' represents Microsoft Family - } +summary: App Metadata Cache Type fullName: AppMetadataEntity remarks: '' -isPreview: false isDeprecated: false -type: class -properties: - - name: clientId - uid: '@azure/msal-common.AppMetadataEntity.clientId' - package: '@azure/msal-common' - summary: '' - fullName: clientId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clientId: string' - return: - description: '' - type: string - - name: environment - uid: '@azure/msal-common.AppMetadataEntity.environment' - package: '@azure/msal-common' - summary: '' - fullName: environment - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'environment: string' - return: - description: '' - type: string - - name: familyId - uid: '@azure/msal-common.AppMetadataEntity.familyId' - package: '@azure/msal-common' - summary: '' - fullName: familyId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'familyId?: string' - return: - description: '' - type: string -methods: - - name: 'createAppMetadataEntity(string, string, string)' - uid: '@azure/msal-common.AppMetadataEntity.createAppMetadataEntity' - package: '@azure/msal-common' - summary: Creates AppMetadataEntity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createAppMetadataEntity(clientId: string, environment: - string, familyId?: string): AppMetadataEntity - parameters: - - id: clientId - type: string - description: '' - - id: environment - type: string - description: '' - - id: familyId - type: string - description: |+ - - return: - description: '' - type: - - name: 'generateAppMetadataCacheKey(string, string)' - uid: '@azure/msal-common.AppMetadataEntity.generateAppMetadataCacheKey' - package: '@azure/msal-common' - summary: Generate AppMetadata Cache Key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateAppMetadataCacheKey(environment: string, - clientId: string): string - parameters: - - id: environment - type: string - description: '' - - id: clientId - type: string - description: '' - return: - description: '' - type: string - - name: generateAppMetadataKey() - uid: '@azure/msal-common.AppMetadataEntity.generateAppMetadataKey' - package: '@azure/msal-common' - summary: >- - Generate AppMetadata Cache Key as per the schema: - appmetadata-- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateAppMetadataKey(): string' - return: - description: '' - type: string - - name: 'isAppMetadataEntity(string, object)' - uid: '@azure/msal-common.AppMetadataEntity.isAppMetadataEntity' - package: '@azure/msal-common' - summary: 'Validates an entity: checks for all expected params' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function isAppMetadataEntity(key: string, entity: object): - boolean - parameters: - - id: key - type: string - description: '' - - id: entity - type: object - description: |+ - - return: - description: '' - type: boolean +syntax: | + type AppMetadataEntity = { + clientId: string + environment: string + familyId?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AppMetadataFilter.yml b/msal/docs-ref-autogen/@azure/msal-common/AppMetadataFilter.yml deleted file mode 100644 index e48c4bf..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/AppMetadataFilter.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: AppMetadataFilter -uid: '@azure/msal-common.AppMetadataFilter' -package: '@azure/msal-common' -summary: 'AppMetadata: appmetadata--' -fullName: AppMetadataFilter -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AppMetadataFilter = { clientId?: string, environment?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml b/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml index 2588e04..f7de6f0 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderParameters.yml @@ -2,12 +2,13 @@ name: AppTokenProviderParameters uid: '@azure/msal-common.AppTokenProviderParameters' package: '@azure/msal-common' -summary: > +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 @@ -17,12 +18,11 @@ summary: > - claims - any extra claims that the token must satisfy fullName: AppTokenProviderParameters remarks: '' -isPreview: false isDeprecated: false syntax: | type AppTokenProviderParameters = { - claims?: string, - correlationId?: string, - scopes: Array, - tenantId: string, + 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 index 1f5e4ae..2fe33e4 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AppTokenProviderResult.yml @@ -2,9 +2,10 @@ name: AppTokenProviderResult uid: '@azure/msal-common.AppTokenProviderResult' package: '@azure/msal-common' -summary: > +summary: >- Output object for IAppTokenProvider extensiblity. + - accessToken - the actual access token, typically in JWT format, that satisfies the request data AppTokenProviderParameters @@ -16,11 +17,10 @@ summary: > response. fullName: AppTokenProviderResult remarks: '' -isPreview: false isDeprecated: false syntax: | type AppTokenProviderResult = { - accessToken: string, - expiresInSeconds: number, - refreshInSeconds?: number, + 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 index 313a3df..f8edade 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ApplicationTelemetry.yml +++ b/msal/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 } + 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 index 4d96c1a..40a15ca 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthError.yml @@ -5,16 +5,14 @@ package: '@azure/msal-common' summary: General error class thrown by the MSAL.js library. fullName: AuthError remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AuthError(string, string, string)' + - name: AuthError(string, string, string) uid: '@azure/msal-common.AuthError.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -37,33 +35,18 @@ properties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' return: description: '' type: string - - name: Error - uid: '@azure/msal-common.AuthError.Error' - package: '@azure/msal-common' - summary: '' - fullName: Error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Error: ErrorConstructor' - return: - description: '' - type: ErrorConstructor - name: errorCode uid: '@azure/msal-common.AuthError.errorCode' package: '@azure/msal-common' summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -76,7 +59,6 @@ properties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -89,7 +71,6 @@ properties: summary: Describes the subclass of an error fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -103,7 +84,6 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' @@ -117,7 +97,6 @@ inheritedProperties: summary: '' fullName: name remarks: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' @@ -125,13 +104,28 @@ 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' summary: '' fullName: stack remarks: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' @@ -139,48 +133,44 @@ inheritedProperties: description: '' type: string inheritanceDescription: Inherited From Error.stack -methods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-common.AuthError.createPostRequestFailed' + - name: stackTraceLimit + uid: '@azure/msal-common.AuthError.stackTraceLimit' package: '@azure/msal-common' - summary: Creates an error for post request failures. + summary: '' + fullName: stackTraceLimit remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' + content: 'static stackTraceLimit: number' return: description: '' - type: - - name: createUnexpectedError(string) - uid: '@azure/msal-common.AuthError.createUnexpectedError' + type: number + inheritanceDescription: Inherited From Error.stackTraceLimit +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.AuthError.captureStackTrace' package: '@azure/msal-common' - summary: >- - Creates an error that is thrown when something unexpected happens in the - library. + summary: Create .stack property on a target object remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createUnexpectedError(errDesc: string): AuthError' + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) parameters: - - id: errDesc - type: string - description: |+ - - return: - description: '' - type: + - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' 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/AuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthOptions.yml deleted file mode 100644 index 50cb0ac..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthOptions.yml +++ /dev/null @@ -1,41 +0,0 @@ -### YamlMime:TSTypeAlias -name: AuthOptions -uid: '@azure/msal-common.AuthOptions' -package: '@azure/msal-common' -summary: > - Use this to configure the auth options in the ClientConfiguration object - - - clientId - Client ID of your app registered with our - Application registration portal : - https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview - in Microsoft Identity Platform - - - authority - You can configure a specific authority, - defaults to " " or "https://login.microsoftonline.com/common" - - - knownAuthorities - An array of URIs that are known to be valid. - Used in B2C scenarios. - - - cloudDiscoveryMetadata - A string containing the cloud discovery - response. Used in AAD scenarios. - - - clientCapabilities - Array of capabilities which will be added to - the claims.access_token.xms_cc request property on every network request. - - - protocolMode - Enum that represents the protocol that msal - follows. Used for configuring proper endpoints. - - - skipAuthorityMetadataCache - A flag to choose whether to use or not use - the local metadata cache during authority initialization. Defaults to false. -fullName: AuthOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AuthOptions = { - authority: Authority, - azureCloudOptions?: AzureCloudOptions, - clientCapabilities?: Array, - clientId: string, - skipAuthorityMetadataCache?: boolean, - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthToken.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthToken.yml index a18a0da..15d0b79 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthToken.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthToken.yml @@ -1,69 +1,18 @@ -### YamlMime:TSType -name: AuthToken +### YamlMime:TSPackage uid: '@azure/msal-common.AuthToken' +name: AuthToken +type: module package: '@azure/msal-common' -summary: >- - JWT Token representation class. Parses token string and generates claims - object. -fullName: AuthToken -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'AuthToken(string, ICrypto)' - uid: '@azure/msal-common.AuthToken.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new AuthToken(rawToken: string, crypto: ICrypto)' - parameters: - - id: rawToken - type: string - description: '' - - id: crypto - type: - description: '' -properties: - - name: claims - uid: '@azure/msal-common.AuthToken.claims' - package: '@azure/msal-common' - summary: '' - fullName: claims - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'claims: TokenClaims' - return: - description: '' - type: - - name: rawToken - uid: '@azure/msal-common.AuthToken.rawToken' - package: '@azure/msal-common' - summary: '' - fullName: rawToken - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'rawToken: string' - return: - description: '' - type: string -methods: - - name: 'checkMaxAge(number, number)' +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: '' - isPreview: false isDeprecated: false syntax: - content: 'static function checkMaxAge(authTime: number, maxAge: number)' + content: 'function checkMaxAge(authTime: number, maxAge: number)' parameters: - id: authTime type: number @@ -71,25 +20,38 @@ methods: - id: maxAge type: number description: '' - - name: 'extractTokenClaims(string, ICrypto)' + - name: 'extractTokenClaims(string, (input: string) => string)' uid: '@azure/msal-common.AuthToken.extractTokenClaims' package: '@azure/msal-common' summary: Extract token by decoding the rawToken remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function extractTokenClaims(encodedToken: string, crypto: - ICrypto): TokenClaims + function extractTokenClaims(encodedToken: string, base64Decode: (input: + string) => string): TokenClaims parameters: - id: encodedToken type: string - description: |+ - - - id: crypto - type: + 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 index 4d3b4a3..36d8a15 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationHeaderParser.yml @@ -10,22 +10,20 @@ summary: >- flows. fullName: AuthenticationHeaderParser remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'AuthenticationHeaderParser(Record)' + - name: AuthenticationHeaderParser(Record) uid: '@azure/msal-common.AuthenticationHeaderParser.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new AuthenticationHeaderParser(headers: Record)' parameters: - id: headers - type: 'Record<string, string>' + type: Record<string, string> description: '' methods: - name: getShrNonce() @@ -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/msal/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml index 083af98..9a6bdbe 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationResult.yml @@ -29,6 +29,9 @@ summary: >- - 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 @@ -37,28 +40,28 @@ summary: >- - requestId - Request ID returned as part of the response fullName: AuthenticationResult remarks: '' -isPreview: false 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, - requestId?: string, - scopes: Array, - state?: string, - tenantId: string, - tokenType: string, - uniqueId: string, + 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 index 69f88a0..662d351 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthenticationScheme.yml @@ -1,22 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: AuthenticationScheme uid: '@azure/msal-common.AuthenticationScheme' package: '@azure/msal-common' -summary: Type of the authentication request +summary: '' fullName: AuthenticationScheme remarks: '' -isPreview: false isDeprecated: false -fields: - - name: BEARER - uid: '@azure/msal-common.AuthenticationScheme.BEARER' - package: '@azure/msal-common' - summary: '' - - name: POP - uid: '@azure/msal-common.AuthenticationScheme.POP' - package: '@azure/msal-common' - summary: '' - - name: SSH - uid: '@azure/msal-common.AuthenticationScheme.SSH' - package: '@azure/msal-common' - summary: '' +syntax: | + type AuthenticationScheme = + (typeof AuthenticationScheme)[keyof typeof AuthenticationScheme] diff --git a/msal/docs-ref-autogen/@azure/msal-common/Authority.yml b/msal/docs-ref-autogen/@azure/msal-common/Authority.yml deleted file mode 100644 index 9d586e2..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/Authority.yml +++ /dev/null @@ -1,429 +0,0 @@ -### YamlMime:TSType -name: Authority -uid: '@azure/msal-common.Authority' -package: '@azure/msal-common' -summary: >- - The authority class validates the authority URIs used by the user, and - retrieves the OpenID Configuration Data from the - - endpoint. It will store the pertinent config data in this object for use - during token calls. -fullName: Authority -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - Authority(string, INetworkModule, ICacheManager, AuthorityOptions, Logger, - 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) - parameters: - - id: authority - type: string - description: '' - - id: networkInterface - type: - description: '' - - id: cacheManager - type: - description: '' - - id: authorityOptions - type: - description: '' - - id: logger - type: - description: '' - - id: proxyUrl - type: string - description: '' -properties: - - name: authorityType - uid: '@azure/msal-common.Authority.authorityType' - package: '@azure/msal-common' - summary: '' - fullName: authorityType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: AuthorityType authorityType - return: - description: '' - type: - - name: authorizationEndpoint - uid: '@azure/msal-common.Authority.authorizationEndpoint' - package: '@azure/msal-common' - summary: OAuth /authorize endpoint for requests - fullName: authorizationEndpoint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string authorizationEndpoint - return: - description: '' - type: string - - name: canonicalAuthority - uid: '@azure/msal-common.Authority.canonicalAuthority' - package: '@azure/msal-common' - summary: |- - A URL that is the authority set by the developer - Sets canonical authority. - fullName: canonicalAuthority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string canonicalAuthority - return: - description: '' - type: string - - name: canonicalAuthorityUrlComponents - uid: '@azure/msal-common.Authority.canonicalAuthorityUrlComponents' - package: '@azure/msal-common' - summary: Get authority components. - fullName: canonicalAuthorityUrlComponents - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: IUri canonicalAuthorityUrlComponents - return: - description: '' - type: - - name: deviceCodeEndpoint - uid: '@azure/msal-common.Authority.deviceCodeEndpoint' - package: '@azure/msal-common' - summary: '' - fullName: deviceCodeEndpoint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string deviceCodeEndpoint - return: - description: '' - type: string - - name: endSessionEndpoint - uid: '@azure/msal-common.Authority.endSessionEndpoint' - package: '@azure/msal-common' - summary: OAuth logout endpoint for requests - fullName: endSessionEndpoint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string endSessionEndpoint - return: - description: '' - type: string - - name: hostnameAndPort - uid: '@azure/msal-common.Authority.hostnameAndPort' - package: '@azure/msal-common' - summary: Get hostname and port i.e. login.microsoftonline.com - fullName: hostnameAndPort - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string hostnameAndPort - return: - description: '' - type: string - - name: jwksUri - uid: '@azure/msal-common.Authority.jwksUri' - package: '@azure/msal-common' - summary: Jwks_uri for token signing keys - fullName: jwksUri - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string jwksUri - return: - description: '' - type: string - - name: options - uid: '@azure/msal-common.Authority.options' - package: '@azure/msal-common' - summary: >- - Returns authorityOptions which can be used to reinstantiate a new - authority instance - fullName: options - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: AuthorityOptions options - return: - description: '' - type: - - name: protocolMode - uid: '@azure/msal-common.Authority.protocolMode' - package: '@azure/msal-common' - summary: ProtocolMode enum representing the way endpoints are constructed. - fullName: protocolMode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: ProtocolMode protocolMode - return: - description: '' - type: - - name: regionDiscoveryMetadata - uid: '@azure/msal-common.Authority.regionDiscoveryMetadata' - package: '@azure/msal-common' - summary: '' - fullName: regionDiscoveryMetadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'regionDiscoveryMetadata: RegionDiscoveryMetadata' - return: - description: '' - type: - - name: selfSignedJwtAudience - uid: '@azure/msal-common.Authority.selfSignedJwtAudience' - package: '@azure/msal-common' - summary: OAuth issuer for requests - fullName: selfSignedJwtAudience - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string selfSignedJwtAudience - return: - description: '' - type: string - - name: tenant - uid: '@azure/msal-common.Authority.tenant' - package: '@azure/msal-common' - summary: Get tenant for authority. - fullName: tenant - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string tenant - return: - description: '' - type: string - - name: tokenEndpoint - uid: '@azure/msal-common.Authority.tokenEndpoint' - package: '@azure/msal-common' - summary: OAuth /token endpoint for requests - fullName: tokenEndpoint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: string tokenEndpoint - return: - description: '' - type: string -methods: - - name: 'buildRegionalAuthorityString(string, string, string)' - uid: '@azure/msal-common.Authority.buildRegionalAuthorityString' - package: '@azure/msal-common' - summary: Rebuild the authority string with the region - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function buildRegionalAuthorityString(host: string, region: - string, queryString?: string): string - parameters: - - id: host - type: string - description: string - - id: region - type: string - description: | - string - - id: queryString - type: string - description: '' - return: - description: '' - type: string - - name: createCloudDiscoveryMetadataFromHost(string) - uid: '@azure/msal-common.Authority.createCloudDiscoveryMetadataFromHost' - package: '@azure/msal-common' - summary: Creates cloud discovery metadata object from a given host - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createCloudDiscoveryMetadataFromHost(host: string): - CloudDiscoveryMetadata - parameters: - - id: host - type: string - description: |+ - - return: - description: '' - type: - - name: discoveryComplete() - uid: '@azure/msal-common.Authority.discoveryComplete' - 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' - return: - description: '' - type: boolean - - name: 'generateAuthority(string, AzureCloudOptions)' - uid: '@azure/msal-common.Authority.generateAuthority' - package: '@azure/msal-common' - summary: helper function to populate the authority based on azureCloudOptions - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateAuthority(authorityString: string, - azureCloudOptions?: AzureCloudOptions): string - parameters: - - id: authorityString - type: string - description: '' - - id: azureCloudOptions - type: - description: |+ - - return: - description: '' - type: string - - name: >- - getCloudDiscoveryMetadataFromNetworkResponse(CloudDiscoveryMetadata[], - string) - uid: '@azure/msal-common.Authority.getCloudDiscoveryMetadataFromNetworkResponse' - package: '@azure/msal-common' - summary: >- - Searches instance discovery network response for the entry that contains - the host in the aliases list - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function getCloudDiscoveryMetadataFromNetworkResponse(response: - CloudDiscoveryMetadata[], authority: string): CloudDiscoveryMetadata | - null - parameters: - - id: response - type: '[]' - description: '' - - id: authority - type: string - description: |+ - - return: - description: '' - type: | null - - name: getPreferredCache() - uid: '@azure/msal-common.Authority.getPreferredCache' - package: '@azure/msal-common' - summary: helper function to generate environment from authority object - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getPreferredCache(): string' - return: - description: '' - type: string - - name: isAlias(string) - uid: '@azure/msal-common.Authority.isAlias' - package: '@azure/msal-common' - summary: >- - 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' - parameters: - - id: host - type: string - description: |+ - - return: - description: '' - type: boolean - - name: isPublicCloudAuthority(string) - uid: '@azure/msal-common.Authority.isPublicCloudAuthority' - 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' - parameters: - - id: host - type: string - description: '' - return: - description: bool - type: boolean - - name: 'replaceWithRegionalInformation(OpenIdConfigResponse, string)' - uid: '@azure/msal-common.Authority.replaceWithRegionalInformation' - package: '@azure/msal-common' - summary: >- - Replace the endpoints in the metadata object with their regional - equivalents. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function replaceWithRegionalInformation(metadata: - OpenIdConfigResponse, azureRegion: string): OpenIdConfigResponse - parameters: - - id: metadata - type: - description: OpenIdConfigResponse - - id: azureRegion - type: string - description: | - string - return: - description: '' - type: - - name: resolveEndpointsAsync() - uid: '@azure/msal-common.Authority.resolveEndpointsAsync' - package: '@azure/msal-common' - summary: >- - Perform endpoint discovery to discover aliases, preferred_cache, - preferred_network - - and the /authorize, /token and logout endpoints. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function resolveEndpointsAsync(): Promise' - return: - description: '' - type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml index 67c5020..b387adc 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorityFactory.yml @@ -1,96 +1,6 @@ -### YamlMime:TSType -name: AuthorityFactory +### YamlMime:TSPackage uid: '@azure/msal-common.AuthorityFactory' +name: AuthorityFactory +type: module package: '@azure/msal-common' summary: '' -fullName: AuthorityFactory -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: >- - createDiscoveredInstance(string, INetworkModule, ICacheManager, - AuthorityOptions, Logger, string) - uid: '@azure/msal-common.AuthorityFactory.createDiscoveredInstance' - package: '@azure/msal-common' - 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 (i.e. aad, b2c, adfs) - - 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 - parameters: - - id: authorityUri - type: string - description: '' - - id: networkClient - type: - description: '' - - id: cacheManager - type: - description: '' - - id: authorityOptions - type: - description: '' - - id: logger - type: - description: '' - - id: proxyUrl - type: string - description: '' - return: - description: '' - type: Promise<> - - name: >- - createInstance(string, INetworkModule, ICacheManager, AuthorityOptions, - Logger, string) - uid: '@azure/msal-common.AuthorityFactory.createInstance' - package: '@azure/msal-common' - 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 (i.e. aad, b2c, adfs) - - 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 - parameters: - - id: authorityUrl - type: string - description: '' - - id: networkInterface - type: - description: '' - - id: cacheManager - type: - description: '' - - id: authorityOptions - type: - description: '' - - id: logger - type: - description: '' - - id: proxyUrl - type: string - description: '' - return: - description: '' - type: diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorityMetadataEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorityMetadataEntity.yml deleted file mode 100644 index 22d91fc..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthorityMetadataEntity.yml +++ /dev/null @@ -1,275 +0,0 @@ -### YamlMime:TSType -name: AuthorityMetadataEntity -uid: '@azure/msal-common.AuthorityMetadataEntity' -package: '@azure/msal-common' -summary: '' -fullName: AuthorityMetadataEntity -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: AuthorityMetadataEntity() - uid: '@azure/msal-common.AuthorityMetadataEntity.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new AuthorityMetadataEntity() -properties: - - name: aliases - uid: '@azure/msal-common.AuthorityMetadataEntity.aliases' - package: '@azure/msal-common' - summary: '' - fullName: aliases - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'aliases: Array' - return: - description: '' - type: Array<string> - - name: aliasesFromNetwork - uid: '@azure/msal-common.AuthorityMetadataEntity.aliasesFromNetwork' - package: '@azure/msal-common' - summary: '' - fullName: aliasesFromNetwork - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'aliasesFromNetwork: boolean' - return: - description: '' - type: boolean - - name: authorization_endpoint - uid: '@azure/msal-common.AuthorityMetadataEntity.authorization_endpoint' - package: '@azure/msal-common' - summary: '' - fullName: authorization_endpoint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authorization_endpoint: string' - return: - description: '' - type: string - - name: canonical_authority - uid: '@azure/msal-common.AuthorityMetadataEntity.canonical_authority' - package: '@azure/msal-common' - summary: '' - fullName: canonical_authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'canonical_authority: string' - return: - description: '' - type: string - - name: endpointsFromNetwork - uid: '@azure/msal-common.AuthorityMetadataEntity.endpointsFromNetwork' - package: '@azure/msal-common' - summary: '' - fullName: endpointsFromNetwork - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'endpointsFromNetwork: boolean' - return: - description: '' - type: boolean - - name: end_session_endpoint - uid: '@azure/msal-common.AuthorityMetadataEntity.end_session_endpoint' - package: '@azure/msal-common' - summary: '' - fullName: end_session_endpoint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'end_session_endpoint?: string' - return: - description: '' - type: string - - name: expiresAt - uid: '@azure/msal-common.AuthorityMetadataEntity.expiresAt' - package: '@azure/msal-common' - summary: '' - fullName: expiresAt - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'expiresAt: number' - return: - description: '' - type: number - - name: issuer - uid: '@azure/msal-common.AuthorityMetadataEntity.issuer' - package: '@azure/msal-common' - summary: '' - fullName: issuer - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'issuer: string' - return: - description: '' - type: string - - name: jwks_uri - uid: '@azure/msal-common.AuthorityMetadataEntity.jwks_uri' - package: '@azure/msal-common' - summary: '' - fullName: jwks_uri - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'jwks_uri: string' - return: - description: '' - type: string - - name: preferred_cache - uid: '@azure/msal-common.AuthorityMetadataEntity.preferred_cache' - package: '@azure/msal-common' - summary: '' - fullName: preferred_cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'preferred_cache: string' - return: - description: '' - type: string - - name: preferred_network - uid: '@azure/msal-common.AuthorityMetadataEntity.preferred_network' - package: '@azure/msal-common' - summary: '' - fullName: preferred_network - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'preferred_network: string' - return: - description: '' - type: string - - name: token_endpoint - uid: '@azure/msal-common.AuthorityMetadataEntity.token_endpoint' - package: '@azure/msal-common' - summary: '' - fullName: token_endpoint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'token_endpoint: string' - return: - description: '' - type: string -methods: - - name: 'isAuthorityMetadataEntity(string, object)' - uid: '@azure/msal-common.AuthorityMetadataEntity.isAuthorityMetadataEntity' - package: '@azure/msal-common' - summary: 'Validates an entity: checks for all expected params' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function isAuthorityMetadataEntity(key: string, entity: object): - boolean - parameters: - - id: key - type: string - description: '' - - id: entity - type: object - description: |+ - - return: - description: '' - type: boolean - - name: isExpired() - uid: '@azure/msal-common.AuthorityMetadataEntity.isExpired' - 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' - return: - description: '' - type: boolean - - name: resetExpiresAt() - uid: '@azure/msal-common.AuthorityMetadataEntity.resetExpiresAt' - package: '@azure/msal-common' - summary: Reset the exiresAt value - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function resetExpiresAt() - - name: updateCanonicalAuthority(string) - uid: '@azure/msal-common.AuthorityMetadataEntity.updateCanonicalAuthority' - 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)' - parameters: - - id: authority - type: string - description: |+ - - - name: 'updateCloudDiscoveryMetadata(CloudDiscoveryMetadata, boolean)' - uid: '@azure/msal-common.AuthorityMetadataEntity.updateCloudDiscoveryMetadata' - package: '@azure/msal-common' - summary: >- - Update the entity with new aliases, preferred_cache and preferred_network - values - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function updateCloudDiscoveryMetadata(metadata: CloudDiscoveryMetadata, - fromNetwork: boolean) - parameters: - - id: metadata - type: - description: '' - - id: fromNetwork - type: boolean - description: |+ - - - name: 'updateEndpointMetadata(OpenIdConfigResponse, boolean)' - uid: '@azure/msal-common.AuthorityMetadataEntity.updateEndpointMetadata' - package: '@azure/msal-common' - summary: Update the entity with new endpoints - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function updateEndpointMetadata(metadata: OpenIdConfigResponse, - fromNetwork: boolean) - parameters: - - id: metadata - type: - description: '' - - id: fromNetwork - type: boolean - description: |+ - diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorityMetadataSource.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorityMetadataSource.yml deleted file mode 100644 index 0ef8322..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthorityMetadataSource.yml +++ /dev/null @@ -1,26 +0,0 @@ -### YamlMime:TSEnum -name: AuthorityMetadataSource -uid: '@azure/msal-common.AuthorityMetadataSource' -package: '@azure/msal-common' -summary: '' -fullName: AuthorityMetadataSource -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: CACHE - uid: '@azure/msal-common.AuthorityMetadataSource.CACHE' - package: '@azure/msal-common' - summary: '' - - name: CONFIG - uid: '@azure/msal-common.AuthorityMetadataSource.CONFIG' - package: '@azure/msal-common' - summary: '' - - name: HARDCODED_VALUES - uid: '@azure/msal-common.AuthorityMetadataSource.HARDCODED_VALUES' - package: '@azure/msal-common' - summary: '' - - name: NETWORK - uid: '@azure/msal-common.AuthorityMetadataSource.NETWORK' - 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 index 87b153d..e3849b3 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorityOptions.yml @@ -5,14 +5,15 @@ package: '@azure/msal-common' summary: '' fullName: AuthorityOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthorityOptions = { - authorityMetadata: string, - azureRegionConfiguration?: AzureRegionConfiguration, - cloudDiscoveryMetadata: string, - knownAuthorities: Array, - protocolMode: ProtocolMode, - skipAuthorityMetadataCache?: boolean, + 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 index 0dcf8a3..a03f9ac 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthorityType.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorityType.yml @@ -1,25 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: AuthorityType uid: '@azure/msal-common.AuthorityType' package: '@azure/msal-common' -summary: Authority types supported by MSAL. +summary: '' fullName: AuthorityType remarks: '' -isPreview: false isDeprecated: false -fields: - - name: Default - uid: '@azure/msal-common.AuthorityType.Default' - package: '@azure/msal-common' - summary: '' - numericValue: 0 - - name: Adfs - uid: '@azure/msal-common.AuthorityType.Adfs' - package: '@azure/msal-common' - summary: '' - numericValue: 1 - - name: Dsts - uid: '@azure/msal-common.AuthorityType.Dsts' - package: '@azure/msal-common' - summary: '' - numericValue: 2 +syntax: | + type AuthorityType = (typeof AuthorityType)[keyof typeof AuthorityType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodeClient.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodeClient.yml deleted file mode 100644 index 5c3a1f2..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodeClient.yml +++ /dev/null @@ -1,186 +0,0 @@ -### YamlMime:TSType -name: AuthorizationCodeClient -uid: '@azure/msal-common.AuthorizationCodeClient' -package: '@azure/msal-common' -summary: Oauth2.0 Authorization Code client -fullName: AuthorizationCodeClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: AuthorizationCodeClient(ClientConfiguration) - uid: '@azure/msal-common.AuthorizationCodeClient.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new AuthorizationCodeClient(configuration: ClientConfiguration)' - parameters: - - id: configuration - type: - description: '' -inheritedProperties: - - name: authority - uid: '@azure/msal-common.AuthorizationCodeClient.authority' - package: '@azure/msal-common' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: Authority' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.authority](xref:@azure/msal-common.BaseClient.authority) - - name: logger - uid: '@azure/msal-common.AuthorizationCodeClient.logger' - package: '@azure/msal-common' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) -inheritedMethods: - - name: updateAuthority(Authority) - uid: '@azure/msal-common.AuthorizationCodeClient.updateAuthority' - package: '@azure/msal-common' - 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: - description: |+ - - inheritanceDescription: >- - Inherited From - [BaseClient.updateAuthority](xref:@azure/msal-common.BaseClient.updateAuthority) -methods: - - name: 'acquireToken(CommonAuthorizationCodeRequest, AuthorizationCodePayload)' - uid: '@azure/msal-common.AuthorizationCodeClient.acquireToken' - package: '@azure/msal-common' - 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: - description: |+ - - - id: authCodePayload - type: - description: '' - return: - description: '' - type: Promise<> - - name: getAuthCodeUrl(CommonAuthorizationUrlRequest) - uid: '@azure/msal-common.AuthorizationCodeClient.getAuthCodeUrl' - package: '@azure/msal-common' - 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: - description: |+ - - return: - description: '' - type: Promise<string> - - name: getLogoutUri(CommonEndSessionRequest) - uid: '@azure/msal-common.AuthorizationCodeClient.getLogoutUri' - package: '@azure/msal-common' - 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: - description: '' - return: - description: '' - type: string - - name: 'handleFragmentResponse(string, string)' - uid: '@azure/msal-common.AuthorizationCodeClient.handleFragmentResponse' - 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: '' - 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: -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml b/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml index f524222..286f060 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AuthorizationCodePayload.yml @@ -5,16 +5,15 @@ 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 = { - 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, + 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 index 34d4b64..675b7a9 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AzureCloudInstance.yml @@ -1,35 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: AzureCloudInstance uid: '@azure/msal-common.AzureCloudInstance' package: '@azure/msal-common' summary: '' fullName: AzureCloudInstance remarks: '' -isPreview: false isDeprecated: false -fields: - - name: AzureChina - uid: '@azure/msal-common.AzureCloudInstance.AzureChina' - package: '@azure/msal-common' - summary: '' - - name: AzureGermany - uid: '@azure/msal-common.AzureCloudInstance.AzureGermany' - package: '@azure/msal-common' - summary: '' - - name: AzurePpe - uid: '@azure/msal-common.AzureCloudInstance.AzurePpe' - package: '@azure/msal-common' - summary: '' - - name: AzurePublic - uid: '@azure/msal-common.AzureCloudInstance.AzurePublic' - package: '@azure/msal-common' - summary: '' - - name: AzureUsGovernment - uid: '@azure/msal-common.AzureCloudInstance.AzureUsGovernment' - package: '@azure/msal-common' - summary: '' - - name: None - uid: '@azure/msal-common.AzureCloudInstance.None' - package: '@azure/msal-common' - summary: '' - numericValue: 0 +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 index e482abf..fad34b3 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AzureCloudOptions.yml @@ -2,19 +2,19 @@ name: AzureCloudOptions uid: '@azure/msal-common.AzureCloudOptions' package: '@azure/msal-common' -summary: > +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: '' -isPreview: false isDeprecated: false syntax: | type AzureCloudOptions = { - azureCloudInstance: AzureCloudInstance, - tenant?: string, + 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 index 084244b..c5cb5a0 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AzureRegion.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml index 432d409..d67a598 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/AzureRegionConfiguration.yml @@ -5,10 +5,9 @@ package: '@azure/msal-common' summary: '' fullName: AzureRegionConfiguration remarks: '' -isPreview: false isDeprecated: false syntax: | type AzureRegionConfiguration = { - azureRegion?: AzureRegion, - environmentRegion: string | undefined, + 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 index a3f60fe..2f259fc 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/BaseAuthRequest.yml @@ -29,6 +29,9 @@ summary: >- - 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. @@ -47,24 +50,49 @@ 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 + + - 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) + + - scenarioId - Scenario id to track custom user prompts + + - 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: '' -isPreview: false isDeprecated: false syntax: | type BaseAuthRequest = { - authenticationScheme?: AuthenticationScheme, - authority: string, - azureCloudOptions?: AzureCloudOptions, - claims?: string, - correlationId: string, - maxAge?: number, - requestedClaimsHash?: string, - resourceRequestMethod?: string, - resourceRequestUri?: string, - scopes: Array, - shrClaims?: string, - shrNonce?: string, - sshJwk?: string, - sshKid?: string, + authenticationScheme?: AuthenticationScheme + authority: string + azureCloudOptions?: AzureCloudOptions + claims?: string + correlationId: string + embeddedClientId?: string + maxAge?: number + popKid?: string + requestedClaimsHash?: string + resourceRequestMethod?: string + resourceRequestUri?: string + scenarioId?: string + scopes: string[] + shrClaims?: string + shrNonce?: string + shrOptions?: ShrOptions + sshJwk?: string + sshKid?: string + storeInCache?: StoreInCache + tokenBodyParameters?: StringDict + tokenQueryParameters?: StringDict } diff --git a/msal/docs-ref-autogen/@azure/msal-common/BaseClient.yml b/msal/docs-ref-autogen/@azure/msal-common/BaseClient.yml deleted file mode 100644 index d7544c4..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/BaseClient.yml +++ /dev/null @@ -1,56 +0,0 @@ -### YamlMime:TSType -name: BaseClient -uid: '@azure/msal-common.BaseClient' -package: '@azure/msal-common' -summary: >- - Base application class which will construct requests to send to and handle - responses from the Microsoft STS using the authorization code flow. -fullName: BaseClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -properties: - - name: authority - uid: '@azure/msal-common.BaseClient.authority' - package: '@azure/msal-common' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: Authority' - return: - description: '' - type: - - name: logger - uid: '@azure/msal-common.BaseClient.logger' - package: '@azure/msal-common' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: -methods: - - name: updateAuthority(Authority) - uid: '@azure/msal-common.BaseClient.updateAuthority' - package: '@azure/msal-common' - 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: - description: |+ - diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml index e986251..f113372 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheAccountType.yml @@ -1,26 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: CacheAccountType uid: '@azure/msal-common.CacheAccountType' package: '@azure/msal-common' -summary: Account types in Cache +summary: '' fullName: CacheAccountType remarks: '' -isPreview: false isDeprecated: false -fields: - - name: ADFS_ACCOUNT_TYPE - uid: '@azure/msal-common.CacheAccountType.ADFS_ACCOUNT_TYPE' - package: '@azure/msal-common' - summary: '' - - name: GENERIC_ACCOUNT_TYPE - uid: '@azure/msal-common.CacheAccountType.GENERIC_ACCOUNT_TYPE' - package: '@azure/msal-common' - summary: '' - - name: MSAV1_ACCOUNT_TYPE - uid: '@azure/msal-common.CacheAccountType.MSAV1_ACCOUNT_TYPE' - package: '@azure/msal-common' - summary: '' - - name: MSSTS_ACCOUNT_TYPE - uid: '@azure/msal-common.CacheAccountType.MSSTS_ACCOUNT_TYPE' - package: '@azure/msal-common' - summary: '' +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/CacheManager.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheManager.yml deleted file mode 100644 index b153785..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/CacheManager.yml +++ /dev/null @@ -1,803 +0,0 @@ -### YamlMime:TSType -name: CacheManager -uid: '@azure/msal-common.CacheManager' -package: '@azure/msal-common' -summary: >- - Interface class which implement cache storage functions used by MSAL to - perform validity checks, and store tokens. -fullName: CacheManager -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'CacheManager(string, ICrypto)' - uid: '@azure/msal-common.CacheManager.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new CacheManager(clientId: string, cryptoImpl: ICrypto)' - parameters: - - id: clientId - type: string - description: '' - - id: cryptoImpl - type: - description: '' -methods: - - name: clear() - uid: '@azure/msal-common.CacheManager.clear' - package: '@azure/msal-common' - summary: Function which clears cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function clear(): Promise' - return: - description: '' - type: Promise<void> - - name: 'containsKey(string, string)' - uid: '@azure/msal-common.CacheManager.containsKey' - 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' - parameters: - - id: key - type: string - description: |+ - - - id: type - type: string - description: '' - return: - description: '' - type: boolean - - name: generateAuthorityMetadataCacheKey(string) - uid: '@azure/msal-common.CacheManager.generateAuthorityMetadataCacheKey' - 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' - parameters: - - id: authority - type: string - description: '' - return: - description: '' - type: string - - name: getAccessTokenCredential(string) - uid: '@azure/msal-common.CacheManager.getAccessTokenCredential' - package: '@azure/msal-common' - summary: fetch the idToken entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAccessTokenCredential(accessTokenKey: string): - AccessTokenEntity | null - parameters: - - id: accessTokenKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getAccount(string) - uid: '@azure/msal-common.CacheManager.getAccount' - package: '@azure/msal-common' - summary: |- - fetch the account entity from the platform cache - @param accountKey - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAccount(accountKey: string): AccountEntity | null' - parameters: - - id: accountKey - type: string - description: '' - return: - description: '' - type: | null - - name: getAccountsFilteredBy(AccountFilter) - uid: '@azure/msal-common.CacheManager.getAccountsFilteredBy' - package: '@azure/msal-common' - summary: >- - retrieve accounts matching all provided filters; if no filter is set, get - all accounts - - 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: >- - function getAccountsFilteredBy(accountFilter?: AccountFilter): - AccountCache - parameters: - - id: accountFilter - type: - description: '' - return: - description: '' - type: - - name: getAllAccounts() - uid: '@azure/msal-common.CacheManager.getAllAccounts' - package: '@azure/msal-common' - summary: Returns all accounts in cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAllAccounts(): AccountInfo[]' - return: - description: '' - type: '[]' - - name: getAppMetadata(string) - uid: '@azure/msal-common.CacheManager.getAppMetadata' - package: '@azure/msal-common' - summary: fetch appMetadata entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAppMetadata(appMetadataKey: string): AppMetadataEntity | - null - parameters: - - id: appMetadataKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getAppMetadataFilteredBy(AppMetadataFilter) - uid: '@azure/msal-common.CacheManager.getAppMetadataFilteredBy' - package: '@azure/msal-common' - summary: >- - retrieve appMetadata matching all provided filters; if no filter is set, - get all appMetadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAppMetadataFilteredBy(filter: AppMetadataFilter): - AppMetadataCache - parameters: - - id: filter - type: - description: |+ - - return: - description: '' - type: - - name: getAuthorityMetadata(string) - uid: '@azure/msal-common.CacheManager.getAuthorityMetadata' - package: '@azure/msal-common' - summary: fetch cloud discovery metadata entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadata(key: string): AuthorityMetadataEntity | - null - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: | null - - name: getAuthorityMetadataByAlias(string) - uid: '@azure/msal-common.CacheManager.getAuthorityMetadataByAlias' - package: '@azure/msal-common' - summary: retrieve authorityMetadata that contains a matching alias - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadataByAlias(host: string): - AuthorityMetadataEntity | null - parameters: - - id: host - type: string - description: '' - return: - description: '' - type: | null - - name: getAuthorityMetadataKeys() - uid: '@azure/msal-common.CacheManager.getAuthorityMetadataKeys' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAuthorityMetadataKeys(): Array' - return: - description: '' - type: Array<string> - - name: getCredentialsFilteredBy(CredentialFilter) - uid: '@azure/msal-common.CacheManager.getCredentialsFilteredBy' - package: '@azure/msal-common' - summary: >- - retrieve credentails matching all provided filters; if no filter is set, - get all credentials - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getCredentialsFilteredBy(filter: CredentialFilter): - CredentialCache - parameters: - - id: filter - type: - description: '' - return: - description: '' - type: - - name: getIdTokenCredential(string) - uid: '@azure/msal-common.CacheManager.getIdTokenCredential' - 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' - parameters: - - id: idTokenKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getKeys() - uid: '@azure/msal-common.CacheManager.getKeys' - package: '@azure/msal-common' - summary: Function which retrieves all current keys from the cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getKeys(): string[]' - return: - description: '' - type: 'string[]' - - name: getRefreshTokenCredential(string) - uid: '@azure/msal-common.CacheManager.getRefreshTokenCredential' - package: '@azure/msal-common' - summary: fetch the idToken entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getRefreshTokenCredential(refreshTokenKey: string): - RefreshTokenEntity | null - parameters: - - id: refreshTokenKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getServerTelemetry(string) - uid: '@azure/msal-common.CacheManager.getServerTelemetry' - package: '@azure/msal-common' - summary: fetch server telemetry entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getServerTelemetry(serverTelemetryKey: string): - ServerTelemetryEntity | null - parameters: - - id: serverTelemetryKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getThrottlingCache(string) - uid: '@azure/msal-common.CacheManager.getThrottlingCache' - package: '@azure/msal-common' - summary: fetch throttling entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getThrottlingCache(throttlingCacheKey: string): - ThrottlingEntity | null - parameters: - - id: throttlingCacheKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: 'isAppMetadataFOCI(string, string)' - uid: '@azure/msal-common.CacheManager.isAppMetadataFOCI' - package: '@azure/msal-common' - summary: Return the family_id value associated with FOCI - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function isAppMetadataFOCI(environment: string, clientId: string): - boolean - parameters: - - id: environment - type: string - description: '' - - id: clientId - type: string - description: |+ - - return: - description: '' - type: boolean - - name: 'readAccessTokenFromCache(string, AccountInfo, BaseAuthRequest)' - uid: '@azure/msal-common.CacheManager.readAccessTokenFromCache' - package: '@azure/msal-common' - summary: Retrieve AccessTokenEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccessTokenFromCache(clientId: string, account: - AccountInfo, request: BaseAuthRequest): AccessTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: - description: '' - - id: request - type: - description: '' - return: - description: '' - type: | null - - name: readAccountFromCache(AccountInfo) - uid: '@azure/msal-common.CacheManager.readAccountFromCache' - package: '@azure/msal-common' - summary: Retrieve AccountEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccountFromCache(account: AccountInfo): AccountEntity | - null - parameters: - - id: account - type: - description: |+ - - return: - description: '' - type: | null - - name: readAccountFromCacheWithNativeAccountId(string) - uid: '@azure/msal-common.CacheManager.readAccountFromCacheWithNativeAccountId' - package: '@azure/msal-common' - summary: Retrieve AccountEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccountFromCacheWithNativeAccountId(nativeAccountId: - string): AccountEntity | null - parameters: - - id: nativeAccountId - type: string - description: '' - return: - description: AccountEntity or Null - type: | null - - name: 'readAppMetadataFromCache(string, string)' - uid: '@azure/msal-common.CacheManager.readAppMetadataFromCache' - package: '@azure/msal-common' - summary: Retrieve AppMetadataEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAppMetadataFromCache(environment: string, clientId: - string): AppMetadataEntity | null - parameters: - - id: environment - type: string - description: '' - - id: clientId - type: string - description: '' - return: - description: '' - type: | null - - name: 'readCacheRecord(AccountInfo, string, BaseAuthRequest, string)' - uid: '@azure/msal-common.CacheManager.readCacheRecord' - package: '@azure/msal-common' - summary: Retrieve the cached credentials into a cacherecord - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readCacheRecord(account: AccountInfo, clientId: string, - request: BaseAuthRequest, environment: string): CacheRecord - parameters: - - id: account - type: - description: '' - - id: clientId - type: string - description: '' - - id: request - type: - description: '' - - id: environment - type: string - description: '' - return: - description: '' - type: - - name: 'readIdTokenFromCache(string, AccountInfo)' - uid: '@azure/msal-common.CacheManager.readIdTokenFromCache' - package: '@azure/msal-common' - summary: Retrieve IdTokenEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readIdTokenFromCache(clientId: string, account: AccountInfo): - IdTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: - description: '' - return: - description: '' - type: | null - - name: 'readRefreshTokenFromCache(string, AccountInfo, boolean)' - uid: '@azure/msal-common.CacheManager.readRefreshTokenFromCache' - package: '@azure/msal-common' - summary: Helper to retrieve the appropriate refresh token from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readRefreshTokenFromCache(clientId: string, account: - AccountInfo, familyRT: boolean): RefreshTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: - description: '' - - id: familyRT - type: boolean - description: |+ - - return: - description: '' - type: | null - - name: removeAccount(string) - uid: '@azure/msal-common.CacheManager.removeAccount' - 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' - parameters: - - id: accountKey - type: string - description: '' - return: - description: '' - type: Promise<boolean> - - name: removeAccountContext(AccountEntity) - uid: '@azure/msal-common.CacheManager.removeAccountContext' - package: '@azure/msal-common' - summary: Removes credentials associated with the provided account - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' - parameters: - - id: account - type: - description: |+ - - return: - description: '' - type: Promise<boolean> - - name: removeAllAccounts() - uid: '@azure/msal-common.CacheManager.removeAllAccounts' - package: '@azure/msal-common' - summary: Removes all accounts and related tokens from cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAllAccounts(): Promise' - return: - description: '' - type: Promise<boolean> - - name: removeAppMetadata() - uid: '@azure/msal-common.CacheManager.removeAppMetadata' - package: '@azure/msal-common' - summary: Removes all app metadata objects from cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAppMetadata(): boolean' - return: - description: '' - type: boolean - - name: removeCredential(CredentialEntity) - uid: '@azure/msal-common.CacheManager.removeCredential' - package: '@azure/msal-common' - summary: returns a boolean if the given credential is removed - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function removeCredential(credential: CredentialEntity): - Promise - parameters: - - id: credential - type: - description: |+ - - return: - description: '' - type: Promise<boolean> - - name: 'removeItem(string, string)' - uid: '@azure/msal-common.CacheManager.removeItem' - 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' - parameters: - - id: key - type: string - description: |+ - - - id: type - type: string - description: '' - return: - description: '' - type: boolean - - name: saveCacheRecord(CacheRecord) - uid: '@azure/msal-common.CacheManager.saveCacheRecord' - package: '@azure/msal-common' - summary: saves a cache record - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' - parameters: - - id: cacheRecord - type: - description: |+ - - return: - description: '' - type: Promise<void> - - name: setAccessTokenCredential(AccessTokenEntity) - uid: '@azure/msal-common.CacheManager.setAccessTokenCredential' - package: '@azure/msal-common' - summary: set idToken entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' - parameters: - - id: accessToken - type: - description: |+ - - - name: setAccount(AccountEntity) - uid: '@azure/msal-common.CacheManager.setAccount' - package: '@azure/msal-common' - summary: set account entity in the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAccount(account: AccountEntity)' - parameters: - - id: account - type: - description: |+ - - - name: setAppMetadata(AppMetadataEntity) - uid: '@azure/msal-common.CacheManager.setAppMetadata' - package: '@azure/msal-common' - summary: set appMetadata entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' - parameters: - - id: appMetadata - type: - description: |+ - - - name: 'setAuthorityMetadata(string, AuthorityMetadataEntity)' - uid: '@azure/msal-common.CacheManager.setAuthorityMetadata' - package: '@azure/msal-common' - summary: set cloud discovery metadata entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setAuthorityMetadata(key: string, value: - AuthorityMetadataEntity) - parameters: - - id: key - type: string - description: '' - - id: value - type: - description: |+ - - - name: setIdTokenCredential(IdTokenEntity) - uid: '@azure/msal-common.CacheManager.setIdTokenCredential' - package: '@azure/msal-common' - summary: set idToken entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setIdTokenCredential(idToken: IdTokenEntity)' - parameters: - - id: idToken - type: - description: |+ - - - name: setRefreshTokenCredential(RefreshTokenEntity) - uid: '@azure/msal-common.CacheManager.setRefreshTokenCredential' - package: '@azure/msal-common' - summary: set idToken entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)' - parameters: - - id: refreshToken - type: - description: |+ - - - name: 'setServerTelemetry(string, ServerTelemetryEntity)' - uid: '@azure/msal-common.CacheManager.setServerTelemetry' - package: '@azure/msal-common' - summary: set server telemetry entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setServerTelemetry(serverTelemetryKey: string, serverTelemetry: - ServerTelemetryEntity) - parameters: - - id: serverTelemetryKey - type: string - description: '' - - id: serverTelemetry - type: - description: |+ - - - name: 'setThrottlingCache(string, ThrottlingEntity)' - uid: '@azure/msal-common.CacheManager.setThrottlingCache' - package: '@azure/msal-common' - summary: set throttling entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setThrottlingCache(throttlingCacheKey: string, throttlingCache: - ThrottlingEntity) - parameters: - - id: throttlingCacheKey - type: string - description: '' - - id: throttlingCache - type: - description: |+ - - - name: 'toObject(T, object)' - uid: '@azure/msal-common.CacheManager.toObject' - 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' - parameters: - - id: obj - type: T - description: '' - - id: json - type: object - description: |+ - - return: - description: '' - type: T - - name: 'updateCredentialCacheKey(string, ValidCredentialType)' - uid: '@azure/msal-common.CacheManager.updateCredentialCacheKey' - package: '@azure/msal-common' - summary: Function which updates an outdated credential cache key - remarks: '' - isPreview: false - 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 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 index 5a607d0..e6f2c7e 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheOutcome.yml @@ -1,30 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: CacheOutcome uid: '@azure/msal-common.CacheOutcome' package: '@azure/msal-common' summary: '' fullName: CacheOutcome remarks: '' -isPreview: false isDeprecated: false -fields: - - name: CACHED_ACCESS_TOKEN_EXPIRED - uid: '@azure/msal-common.CacheOutcome.CACHED_ACCESS_TOKEN_EXPIRED' - package: '@azure/msal-common' - summary: '' - - name: FORCE_REFRESH - uid: '@azure/msal-common.CacheOutcome.FORCE_REFRESH' - package: '@azure/msal-common' - summary: '' - - name: NO_CACHED_ACCESS_TOKEN - uid: '@azure/msal-common.CacheOutcome.NO_CACHED_ACCESS_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: NO_CACHE_HIT - uid: '@azure/msal-common.CacheOutcome.NO_CACHE_HIT' - package: '@azure/msal-common' - summary: '' - - name: REFRESH_CACHED_ACCESS_TOKEN - uid: '@azure/msal-common.CacheOutcome.REFRESH_CACHED_ACCESS_TOKEN' - package: '@azure/msal-common' - summary: '' +syntax: | + type CacheOutcome = (typeof CacheOutcome)[keyof typeof CacheOutcome] diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheRecord.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheRecord.yml deleted file mode 100644 index 713bd22..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/CacheRecord.yml +++ /dev/null @@ -1,108 +0,0 @@ -### YamlMime:TSType -name: CacheRecord -uid: '@azure/msal-common.CacheRecord' -package: '@azure/msal-common' -summary: '' -fullName: CacheRecord -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - CacheRecord(AccountEntity | null, IdTokenEntity | null, AccessTokenEntity - | null, RefreshTokenEntity | null, AppMetadataEntity | null) - uid: '@azure/msal-common.CacheRecord.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new CacheRecord(accountEntity?: AccountEntity | null, idTokenEntity?: - IdTokenEntity | null, accessTokenEntity?: AccessTokenEntity | null, - refreshTokenEntity?: RefreshTokenEntity | null, appMetadataEntity?: - AppMetadataEntity | null) - parameters: - - id: accountEntity - type: | null - description: '' - - id: idTokenEntity - type: | null - description: '' - - id: accessTokenEntity - type: | null - description: '' - - id: refreshTokenEntity - type: | null - description: '' - - id: appMetadataEntity - type: | null - description: '' -properties: - - name: accessToken - uid: '@azure/msal-common.CacheRecord.accessToken' - package: '@azure/msal-common' - summary: '' - fullName: accessToken - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'accessToken: AccessTokenEntity | null' - return: - description: '' - type: | null - - name: account - uid: '@azure/msal-common.CacheRecord.account' - package: '@azure/msal-common' - summary: '' - fullName: account - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'account: AccountEntity | null' - return: - description: '' - type: | null - - name: appMetadata - uid: '@azure/msal-common.CacheRecord.appMetadata' - package: '@azure/msal-common' - summary: '' - fullName: appMetadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'appMetadata: AppMetadataEntity | null' - return: - description: '' - type: | null - - name: idToken - uid: '@azure/msal-common.CacheRecord.idToken' - package: '@azure/msal-common' - summary: '' - fullName: idToken - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'idToken: IdTokenEntity | null' - return: - description: '' - type: | null - - name: refreshToken - uid: '@azure/msal-common.CacheRecord.refreshToken' - package: '@azure/msal-common' - summary: '' - fullName: refreshToken - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'refreshToken: RefreshTokenEntity | null' - return: - description: '' - type: | null diff --git a/msal/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml deleted file mode 100644 index 84ec08b..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/CacheSchemaType.yml +++ /dev/null @@ -1,50 +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: '' -isPreview: false -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/msal/docs-ref-autogen/@azure/msal-common/CacheType.yml b/msal/docs-ref-autogen/@azure/msal-common/CacheType.yml index a7377bb..1af0175 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CacheType.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CacheType.yml @@ -1,55 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: CacheType uid: '@azure/msal-common.CacheType' package: '@azure/msal-common' -summary: Combine all cache types +summary: '' fullName: CacheType remarks: '' -isPreview: false isDeprecated: false -fields: - - name: ADFS - uid: '@azure/msal-common.CacheType.ADFS' - package: '@azure/msal-common' - summary: '' - numericValue: 1001 - - name: MSA - uid: '@azure/msal-common.CacheType.MSA' - package: '@azure/msal-common' - summary: '' - numericValue: 1002 - - name: MSSTS - uid: '@azure/msal-common.CacheType.MSSTS' - package: '@azure/msal-common' - summary: '' - numericValue: 1003 - - name: GENERIC - uid: '@azure/msal-common.CacheType.GENERIC' - package: '@azure/msal-common' - summary: '' - numericValue: 1004 - - name: ACCESS_TOKEN - uid: '@azure/msal-common.CacheType.ACCESS_TOKEN' - package: '@azure/msal-common' - summary: '' - numericValue: 2001 - - name: REFRESH_TOKEN - uid: '@azure/msal-common.CacheType.REFRESH_TOKEN' - package: '@azure/msal-common' - summary: '' - numericValue: 2002 - - name: ID_TOKEN - uid: '@azure/msal-common.CacheType.ID_TOKEN' - package: '@azure/msal-common' - summary: '' - numericValue: 2003 - - name: APP_METADATA - uid: '@azure/msal-common.CacheType.APP_METADATA' - package: '@azure/msal-common' - summary: '' - numericValue: 3001 - - name: UNDEFINED - uid: '@azure/msal-common.CacheType.UNDEFINED' - package: '@azure/msal-common' - summary: '' - numericValue: 9999 +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 index c52c799..0443e46 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CcsCredential.yml +++ b/msal/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 } + 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 index 79069e2..3377d03 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CcsCredentialType.yml @@ -1,18 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: CcsCredentialType uid: '@azure/msal-common.CcsCredentialType' package: '@azure/msal-common' summary: '' fullName: CcsCredentialType remarks: '' -isPreview: false isDeprecated: false -fields: - - name: HOME_ACCOUNT_ID - uid: '@azure/msal-common.CcsCredentialType.HOME_ACCOUNT_ID' - package: '@azure/msal-common' - summary: '' - - name: UPN - uid: '@azure/msal-common.CcsCredentialType.UPN' - package: '@azure/msal-common' - summary: '' +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 index 55d2f6b..d083ca2 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ClaimsRequestKeys.yml @@ -1,18 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: ClaimsRequestKeys uid: '@azure/msal-common.ClaimsRequestKeys' package: '@azure/msal-common' -summary: Claims request keys +summary: '' fullName: ClaimsRequestKeys remarks: '' -isPreview: false isDeprecated: false -fields: - - name: ACCESS_TOKEN - uid: '@azure/msal-common.ClaimsRequestKeys.ACCESS_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: XMS_CC - uid: '@azure/msal-common.ClaimsRequestKeys.XMS_CC' - package: '@azure/msal-common' - summary: '' +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 index c6c31c0..4aec72a 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertion.yml @@ -5,7 +5,9 @@ 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 } + 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..0685d60 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAssertionUtils.yml @@ -0,0 +1,31 @@ +### YamlMime:TSPackage +uid: '@azure/msal-common.ClientAssertionUtils' +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/ClientAuthError.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml index b495806..918fc5a 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientAuthError.yml @@ -5,24 +5,22 @@ 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: - - name: 'ClientAuthError(string, string)' + - name: ClientAuthError(string, string) uid: '@azure/msal-common.ClientAuthError.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ClientAuthError(errorCode: string, errorMessage?: string)' + content: 'new ClientAuthError(errorCode: string, additionalMessage?: string)' parameters: - id: errorCode type: string description: '' - - id: errorMessage + - id: additionalMessage type: string description: '' inheritedProperties: @@ -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,49 +75,84 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.message + 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: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.name + 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: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.stack + 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: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -133,53 +163,31 @@ inheritedProperties: Inherited From [AuthError.subError](xref:@azure/msal-common.AuthError.subError) inheritedMethods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-common.ClientAuthError.createPostRequestFailed' + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.ClientAuthError.captureStackTrace' package: '@azure/msal-common' - summary: Creates an error for post request failures. + summary: Create .stack property on a target object remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) parameters: - - id: errDesc - type: string + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [AuthError.createPostRequestFailed](xref:@azure/msal-common.AuthError.createPostRequestFailed) - - name: createUnexpectedError(string) - uid: '@azure/msal-common.ClientAuthError.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) + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-common.ClientAuthError.setCorrelationId' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -190,668 +198,4 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) -methods: - - name: createAppendEmptyScopeToSetError(string) - uid: '@azure/msal-common.ClientAuthError.createAppendEmptyScopeToSetError' - package: '@azure/msal-common' - summary: >- - Throws error when attempting to append a null, undefined or empty scope to - a set - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createAppendEmptyScopeToSetError(givenScope: string): - ClientAuthError - parameters: - - id: givenScope - type: string - description: |+ - - return: - description: '' - type: - - name: createAppendScopeSetError(string) - uid: '@azure/msal-common.ClientAuthError.createAppendScopeSetError' - package: '@azure/msal-common' - summary: Throws error when attempting to append null or empty ScopeSet. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createAppendScopeSetError(appendError: string): - ClientAuthError - parameters: - - id: appendError - type: string - description: |+ - - return: - description: '' - type: - - name: createAuthTimeNotFoundError() - uid: '@azure/msal-common.ClientAuthError.createAuthTimeNotFoundError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - - name: createBindingKeyNotRemovedError() - uid: '@azure/msal-common.ClientAuthError.createBindingKeyNotRemovedError' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createBindingKeyNotRemovedError(): ClientAuthError' - return: - description: '' - type: - - name: createCachePluginError() - uid: '@azure/msal-common.ClientAuthError.createCachePluginError' - package: '@azure/msal-common' - summary: Throws error if ICachePlugin not set on CacheManager. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createCachePluginError(): ClientAuthError' - return: - description: '' - type: - - name: createClientInfoDecodingError(string) - uid: '@azure/msal-common.ClientAuthError.createClientInfoDecodingError' - package: '@azure/msal-common' - summary: Creates an error thrown when client info object doesn't decode correctly. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createClientInfoDecodingError(caughtError: string): - ClientAuthError - parameters: - - id: caughtError - type: string - description: |+ - - return: - description: '' - type: - - name: createClientInfoEmptyError() - uid: '@azure/msal-common.ClientAuthError.createClientInfoEmptyError' - 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' - return: - description: '' - type: - - name: createDeviceCodeCancelledError() - uid: '@azure/msal-common.ClientAuthError.createDeviceCodeCancelledError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - - name: createDeviceCodeExpiredError() - uid: '@azure/msal-common.ClientAuthError.createDeviceCodeExpiredError' - package: '@azure/msal-common' - summary: Throws error if device code is expired - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createDeviceCodeExpiredError(): ClientAuthError' - return: - description: '' - type: - - name: createDeviceCodeUnknownError() - uid: '@azure/msal-common.ClientAuthError.createDeviceCodeUnknownError' - package: '@azure/msal-common' - summary: Throws error if device code is expired - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createDeviceCodeUnknownError(): ClientAuthError' - return: - description: '' - type: - - name: createEmptyInputScopeSetError() - uid: '@azure/msal-common.ClientAuthError.createEmptyInputScopeSetError' - package: '@azure/msal-common' - summary: Throws error if ScopeSet is null or undefined. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createEmptyInputScopeSetError(): ClientAuthError' - return: - description: '' - type: - - name: createEndpointDiscoveryIncompleteError(string) - uid: '@azure/msal-common.ClientAuthError.createEndpointDiscoveryIncompleteError' - package: '@azure/msal-common' - summary: >- - Creates an error thrown when the endpoint discovery doesn't complete - correctly. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createEndpointDiscoveryIncompleteError(errDetail: - string): ClientAuthError - parameters: - - id: errDetail - type: string - description: '' - return: - description: '' - type: - - name: createHashNotDeserializedError(string) - uid: '@azure/msal-common.ClientAuthError.createHashNotDeserializedError' - package: '@azure/msal-common' - summary: Creates an error thrown when the hash cannot be deserialized. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createHashNotDeserializedError(hashParamObj: string): - ClientAuthError - parameters: - - id: hashParamObj - type: string - description: |+ - - return: - description: '' - type: - - name: createInvalidAssertionError() - uid: '@azure/msal-common.ClientAuthError.createInvalidAssertionError' - package: '@azure/msal-common' - summary: Throws error if client assertion is not valid. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidAssertionError(): ClientAuthError' - return: - description: '' - type: - - name: createInvalidCacheEnvironmentError() - uid: '@azure/msal-common.ClientAuthError.createInvalidCacheEnvironmentError' - package: '@azure/msal-common' - summary: >- - Throws error when provided environment is not part of the - CloudDiscoveryMetadata object - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidCacheEnvironmentError(): ClientAuthError' - return: - description: '' - type: - - name: createInvalidCacheTypeError() - uid: '@azure/msal-common.ClientAuthError.createInvalidCacheTypeError' - package: '@azure/msal-common' - summary: Throws error if cache type is invalid. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidCacheTypeError(): ClientAuthError' - return: - description: '' - type: - - name: createInvalidCredentialError() - uid: '@azure/msal-common.ClientAuthError.createInvalidCredentialError' - package: '@azure/msal-common' - summary: Throws error if client assertion is not valid. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidCredentialError(): ClientAuthError' - return: - description: '' - type: - - name: 'createInvalidStateError(string, string)' - uid: '@azure/msal-common.ClientAuthError.createInvalidStateError' - package: '@azure/msal-common' - summary: Creates an error thrown when the state cannot be parsed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidStateError(invalidState: string, - errorString?: string): ClientAuthError - parameters: - - id: invalidState - type: string - description: |+ - - - id: errorString - type: string - description: '' - return: - description: '' - type: - - name: createKeyIdMissingError() - uid: '@azure/msal-common.ClientAuthError.createKeyIdMissingError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - - name: createLogoutNotSupportedError() - uid: '@azure/msal-common.ClientAuthError.createLogoutNotSupportedError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - - name: createMaxAgeTranspiredError() - uid: '@azure/msal-common.ClientAuthError.createMaxAgeTranspiredError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - - name: createMultipleMatchingAccountsInCacheError() - uid: >- - @azure/msal-common.ClientAuthError.createMultipleMatchingAccountsInCacheError - package: '@azure/msal-common' - summary: Throws error when multiple accounts are in cache for the given params - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createMultipleMatchingAccountsInCacheError(): - ClientAuthError - return: - description: '' - type: - - name: createMultipleMatchingAppMetadataInCacheError() - uid: >- - @azure/msal-common.ClientAuthError.createMultipleMatchingAppMetadataInCacheError - package: '@azure/msal-common' - summary: Throws error when multiple appMetada are in cache for the given clientId. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createMultipleMatchingAppMetadataInCacheError(): - ClientAuthError - return: - description: '' - type: - - name: createMultipleMatchingTokensInCacheError() - uid: >- - @azure/msal-common.ClientAuthError.createMultipleMatchingTokensInCacheError - package: '@azure/msal-common' - summary: Throws error when multiple tokens are in cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createMultipleMatchingTokensInCacheError(): - ClientAuthError - return: - description: '' - type: - - name: 'createNetworkError(string, string)' - uid: '@azure/msal-common.ClientAuthError.createNetworkError' - package: '@azure/msal-common' - summary: Creates an error thrown when the fetch client throws - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNetworkError(endpoint: string, errDetail: string): - ClientAuthError - parameters: - - id: endpoint - type: string - description: '' - - id: errDetail - type: string - description: '' - return: - description: '' - type: - - name: createNoAccountFoundError() - uid: '@azure/msal-common.ClientAuthError.createNoAccountFoundError' - 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' - return: - description: '' - type: - - name: createNoAccountInSilentRequestError() - uid: '@azure/msal-common.ClientAuthError.createNoAccountInSilentRequestError' - 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' - return: - description: '' - type: - - name: createNoAuthCodeInServerResponseError() - uid: '@azure/msal-common.ClientAuthError.createNoAuthCodeInServerResponseError' - package: '@azure/msal-common' - summary: >- - Throws error when the authorization code is missing from the server - response - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createNoAuthCodeInServerResponseError(): ClientAuthError' - return: - description: '' - type: - - name: createNoCryptoObjectError(string) - uid: '@azure/msal-common.ClientAuthError.createNoCryptoObjectError' - package: '@azure/msal-common' - summary: Throws error if crypto object not found. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNoCryptoObjectError(operationName: string): - ClientAuthError - parameters: - - id: operationName - type: string - description: |+ - - return: - description: '' - type: - - name: createNonceMismatchError() - uid: '@azure/msal-common.ClientAuthError.createNonceMismatchError' - 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' - return: - description: '' - type: - - name: createNonceNotFoundError(string) - uid: '@azure/msal-common.ClientAuthError.createNonceNotFoundError' - package: '@azure/msal-common' - summary: Creates an error thrown when the mnonce is not present - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNonceNotFoundError(missingNonce: string): - ClientAuthError - parameters: - - id: missingNonce - type: string - description: |+ - - return: - description: '' - type: - - name: createNullOrUndefinedCacheRecord() - uid: '@azure/msal-common.ClientAuthError.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' - return: - description: '' - type: - - name: createRefreshRequiredError() - uid: '@azure/msal-common.ClientAuthError.createRefreshRequiredError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - - name: createRemoveEmptyScopeFromSetError(string) - uid: '@azure/msal-common.ClientAuthError.createRemoveEmptyScopeFromSetError' - package: '@azure/msal-common' - summary: >- - Throws error when attempting to append a null, undefined or empty scope to - a set - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createRemoveEmptyScopeFromSetError(givenScope: string): - ClientAuthError - parameters: - - id: givenScope - type: string - description: |+ - - return: - description: '' - type: - - name: createStateMismatchError() - uid: '@azure/msal-common.ClientAuthError.createStateMismatchError' - 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' - return: - description: '' - type: - - name: createStateNotFoundError(string) - uid: '@azure/msal-common.ClientAuthError.createStateNotFoundError' - package: '@azure/msal-common' - summary: Creates an error thrown when the state is not present - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createStateNotFoundError(missingState: string): - ClientAuthError - parameters: - - id: missingState - type: string - description: |+ - - return: - description: '' - type: - - name: createTokenClaimsRequiredError() - uid: '@azure/msal-common.ClientAuthError.createTokenClaimsRequiredError' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createTokenClaimsRequiredError(): ClientAuthError' - return: - description: '' - type: - - name: createTokenNullOrEmptyError(string) - uid: '@azure/msal-common.ClientAuthError.createTokenNullOrEmptyError' - 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: >- - static function createTokenNullOrEmptyError(invalidRawTokenString: - string): ClientAuthError - parameters: - - id: invalidRawTokenString - type: string - description: |+ - - return: - description: '' - type: - - name: createTokenParsingError(string) - uid: '@azure/msal-common.ClientAuthError.createTokenParsingError' - package: '@azure/msal-common' - summary: Creates an error thrown when the id token extraction errors out. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createTokenParsingError(caughtExtractionError: string): - ClientAuthError - parameters: - - id: caughtExtractionError - type: string - description: '' - return: - description: '' - type: - - name: createTokenRequestCannotBeMadeError() - uid: '@azure/msal-common.ClientAuthError.createTokenRequestCannotBeMadeError' - package: '@azure/msal-common' - summary: >- - Throws error when no auth code or refresh token is given to - ServerTokenRequestParameters. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createTokenRequestCannotBeMadeError(): ClientAuthError' - return: - description: '' - type: - - name: createUnableToGetOpenidConfigError(string) - uid: '@azure/msal-common.ClientAuthError.createUnableToGetOpenidConfigError' - package: '@azure/msal-common' - summary: >- - 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: >- - static function createUnableToGetOpenidConfigError(errDetail: string): - ClientAuthError - parameters: - - id: errDetail - type: string - description: '' - return: - description: '' - type: - - name: createUnexpectedAccountTypeError() - uid: '@azure/msal-common.ClientAuthError.createUnexpectedAccountTypeError' - package: '@azure/msal-common' - summary: Throws error if unexpected account type. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUnexpectedAccountTypeError(): ClientAuthError' - return: - description: '' - type: - - name: createUnexpectedCredentialTypeError() - uid: '@azure/msal-common.ClientAuthError.createUnexpectedCredentialTypeError' - 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: 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' - return: - description: '' - type: 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/ClientConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml deleted file mode 100644 index 82582e7..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientConfiguration.yml +++ /dev/null @@ -1,46 +0,0 @@ -### YamlMime:TSTypeAlias -name: ClientConfiguration -uid: '@azure/msal-common.ClientConfiguration' -package: '@azure/msal-common' -summary: > - Use the configuration object to configure MSAL Modules and initialize the base - interfaces for MSAL. - - This object allows you to configure important elements of MSAL functionality: - - - authOptions - Authentication for application - - - cryptoInterface - Implementation of crypto functions - - - libraryInfo - Library metadata - - - telemetry - Telemetry options and data - - - loggerOptions - Logging for application - - - networkInterface - Network implementation - - - storageInterface - Storage implementation - - - systemOptions - Additional library options - - - clientCredentials - Credentials options for confidential clients -fullName: ClientConfiguration -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ClientConfiguration = { - authOptions: AuthOptions, - clientCredentials?: ClientCredentials, - cryptoInterface?: ICrypto, - libraryInfo?: LibraryInfo, - loggerOptions?: LoggerOptions, - networkInterface?: INetworkModule, - persistencePlugin?: ICachePlugin | null, - serializableCache?: ISerializableTokenCache | null, - serverTelemetryManager?: ServerTelemetryManager | null, - storageInterface?: CacheManager, - systemOptions?: SystemOptions, - telemetry?: TelemetryOptions, - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml index cc89dcf..c6018f8 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ClientConfigurationError.yml @@ -5,26 +5,21 @@ 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: - - name: 'ClientConfigurationError(string, string)' + - name: ClientConfigurationError(string) uid: '@azure/msal-common.ClientConfigurationError.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ClientConfigurationError(errorCode: string, errorMessage?: string)' + content: 'new ClientConfigurationError(errorCode: string)' parameters: - id: errorCode type: string description: '' - - id: errorMessage - type: string - description: '' inheritedProperties: - name: correlationId uid: '@azure/msal-common.ClientConfigurationError.correlationId' @@ -32,7 +27,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -48,7 +42,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -64,7 +57,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -80,1278 +72,127 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.message + 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: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.name - - name: stack - uid: '@azure/msal-common.ClientConfigurationError.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.ClientConfigurationError.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: createAppendEmptyScopeToSetError(string) - uid: >- - @azure/msal-common.ClientConfigurationError.createAppendEmptyScopeToSetError - package: '@azure/msal-common' - summary: >- - Throws error when attempting to append a null, undefined or empty scope to - a set - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createAppendEmptyScopeToSetError(givenScope: string): - ClientAuthError - parameters: - - id: givenScope - type: string - description: |+ - - return: - description: '' - type: inheritanceDescription: >- Inherited From - [ClientAuthError.createAppendEmptyScopeToSetError](xref:@azure/msal-common.ClientAuthError.createAppendEmptyScopeToSetError) - - name: createAppendScopeSetError(string) - uid: '@azure/msal-common.ClientConfigurationError.createAppendScopeSetError' + [AuthError.name](xref:@azure/msal-common.AuthError.name) + - name: prepareStackTrace + uid: '@azure/msal-common.ClientConfigurationError.prepareStackTrace' package: '@azure/msal-common' - summary: Throws error when attempting to append null or empty ScopeSet. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createAppendScopeSetError(appendError: string): - ClientAuthError - parameters: - - id: appendError - type: string - description: |+ + summary: |- + Optional override for formatting stack traces - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createAppendScopeSetError](xref:@azure/msal-common.ClientAuthError.createAppendScopeSetError) - - name: createAuthTimeNotFoundError() - uid: '@azure/msal-common.ClientConfigurationError.createAuthTimeNotFoundError' - package: '@azure/msal-common' - summary: >- - Creates an error thrown when max_age was provided in the request, but - auth_time is not in the token claims + See https://v8.dev/docs/stack-trace-api#customizing-stack-traces + fullName: prepareStackTrace remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createAuthTimeNotFoundError(): ClientAuthError' + content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any' return: description: '' - type: + type: '(err: Error, stackTraces: CallSite[]) => any' inheritanceDescription: >- Inherited From - [ClientAuthError.createAuthTimeNotFoundError](xref:@azure/msal-common.ClientAuthError.createAuthTimeNotFoundError) - - name: createBindingKeyNotRemovedError() - uid: >- - @azure/msal-common.ClientConfigurationError.createBindingKeyNotRemovedError + [AuthError.prepareStackTrace](xref:@azure/msal-common.AuthError.prepareStackTrace) + - name: stack + uid: '@azure/msal-common.ClientConfigurationError.stack' package: '@azure/msal-common' summary: '' + fullName: stack remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createBindingKeyNotRemovedError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createBindingKeyNotRemovedError](xref:@azure/msal-common.ClientAuthError.createBindingKeyNotRemovedError) - - name: createCachePluginError() - uid: '@azure/msal-common.ClientConfigurationError.createCachePluginError' - package: '@azure/msal-common' - summary: Throws error if ICachePlugin not set on CacheManager. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createCachePluginError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createCachePluginError](xref:@azure/msal-common.ClientAuthError.createCachePluginError) - - name: createClientInfoDecodingError(string) - uid: '@azure/msal-common.ClientConfigurationError.createClientInfoDecodingError' - package: '@azure/msal-common' - summary: Creates an error thrown when client info object doesn't decode correctly. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createClientInfoDecodingError(caughtError: string): - ClientAuthError - parameters: - - id: caughtError - type: string - description: |+ - - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createClientInfoDecodingError](xref:@azure/msal-common.ClientAuthError.createClientInfoDecodingError) - - name: createClientInfoEmptyError() - uid: '@azure/msal-common.ClientConfigurationError.createClientInfoEmptyError' - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createClientInfoEmptyError](xref:@azure/msal-common.ClientAuthError.createClientInfoEmptyError) - - name: createDeviceCodeCancelledError() - uid: '@azure/msal-common.ClientConfigurationError.createDeviceCodeCancelledError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createDeviceCodeCancelledError](xref:@azure/msal-common.ClientAuthError.createDeviceCodeCancelledError) - - name: createDeviceCodeExpiredError() - uid: '@azure/msal-common.ClientConfigurationError.createDeviceCodeExpiredError' - package: '@azure/msal-common' - summary: Throws error if device code is expired - remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createDeviceCodeExpiredError(): ClientAuthError' + content: 'stack?: string' return: description: '' - type: + type: string inheritanceDescription: >- Inherited From - [ClientAuthError.createDeviceCodeExpiredError](xref:@azure/msal-common.ClientAuthError.createDeviceCodeExpiredError) - - name: createDeviceCodeUnknownError() - uid: '@azure/msal-common.ClientConfigurationError.createDeviceCodeUnknownError' + [AuthError.stack](xref:@azure/msal-common.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-common.ClientConfigurationError.stackTraceLimit' package: '@azure/msal-common' - summary: Throws error if device code is expired + summary: '' + fullName: stackTraceLimit remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createDeviceCodeUnknownError(): ClientAuthError' + content: 'static stackTraceLimit: number' return: description: '' - type: + type: number inheritanceDescription: >- Inherited From - [ClientAuthError.createDeviceCodeUnknownError](xref:@azure/msal-common.ClientAuthError.createDeviceCodeUnknownError) - - name: createEmptyInputScopeSetError() - uid: '@azure/msal-common.ClientConfigurationError.createEmptyInputScopeSetError' + [AuthError.stackTraceLimit](xref:@azure/msal-common.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-common.ClientConfigurationError.subError' package: '@azure/msal-common' - summary: Throws error if ScopeSet is null or undefined. + summary: Describes the subclass of an error + fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createEmptyInputScopeSetError(): ClientAuthError' + content: 'subError: string' return: description: '' - type: + type: string inheritanceDescription: >- Inherited From - [ClientAuthError.createEmptyInputScopeSetError](xref:@azure/msal-common.ClientAuthError.createEmptyInputScopeSetError) - - name: createEndpointDiscoveryIncompleteError(string) - uid: >- - @azure/msal-common.ClientConfigurationError.createEndpointDiscoveryIncompleteError + [AuthError.subError](xref:@azure/msal-common.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.ClientConfigurationError.captureStackTrace' package: '@azure/msal-common' - summary: >- - Creates an error thrown when the endpoint discovery doesn't complete - correctly. + summary: Create .stack property on a target object remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - static function createEndpointDiscoveryIncompleteError(errDetail: - string): ClientAuthError + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) parameters: - - id: errDetail - type: string + - id: targetObject + type: object description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createEndpointDiscoveryIncompleteError](xref:@azure/msal-common.ClientAuthError.createEndpointDiscoveryIncompleteError) - - name: createHashNotDeserializedError(string) - uid: '@azure/msal-common.ClientConfigurationError.createHashNotDeserializedError' - package: '@azure/msal-common' - summary: Creates an error thrown when the hash cannot be deserialized. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createHashNotDeserializedError(hashParamObj: string): - ClientAuthError - parameters: - - id: hashParamObj - type: string - description: |+ - - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createHashNotDeserializedError](xref:@azure/msal-common.ClientAuthError.createHashNotDeserializedError) - - name: createInvalidAssertionError() - uid: '@azure/msal-common.ClientConfigurationError.createInvalidAssertionError' - package: '@azure/msal-common' - summary: Throws error if client assertion is not valid. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidAssertionError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createInvalidAssertionError](xref:@azure/msal-common.ClientAuthError.createInvalidAssertionError) - - name: createInvalidCacheEnvironmentError() - uid: >- - @azure/msal-common.ClientConfigurationError.createInvalidCacheEnvironmentError - package: '@azure/msal-common' - summary: >- - Throws error when provided environment is not part of the - CloudDiscoveryMetadata object - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidCacheEnvironmentError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createInvalidCacheEnvironmentError](xref:@azure/msal-common.ClientAuthError.createInvalidCacheEnvironmentError) - - name: createInvalidCacheTypeError() - uid: '@azure/msal-common.ClientConfigurationError.createInvalidCacheTypeError' - package: '@azure/msal-common' - summary: Throws error if cache type is invalid. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidCacheTypeError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createInvalidCacheTypeError](xref:@azure/msal-common.ClientAuthError.createInvalidCacheTypeError) - - name: createInvalidCredentialError() - uid: '@azure/msal-common.ClientConfigurationError.createInvalidCredentialError' - package: '@azure/msal-common' - summary: Throws error if client assertion is not valid. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidCredentialError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createInvalidCredentialError](xref:@azure/msal-common.ClientAuthError.createInvalidCredentialError) - - name: 'createInvalidStateError(string, string)' - uid: '@azure/msal-common.ClientConfigurationError.createInvalidStateError' - package: '@azure/msal-common' - summary: Creates an error thrown when the state cannot be parsed. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidStateError(invalidState: string, - errorString?: string): ClientAuthError - parameters: - - id: invalidState - type: string - description: |+ - - - id: errorString - type: string + - id: constructorOpt + type: Function description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createInvalidStateError](xref:@azure/msal-common.ClientAuthError.createInvalidStateError) - - name: createKeyIdMissingError() - uid: '@azure/msal-common.ClientConfigurationError.createKeyIdMissingError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createKeyIdMissingError](xref:@azure/msal-common.ClientAuthError.createKeyIdMissingError) - - name: createLogoutNotSupportedError() - uid: '@azure/msal-common.ClientConfigurationError.createLogoutNotSupportedError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createLogoutNotSupportedError](xref:@azure/msal-common.ClientAuthError.createLogoutNotSupportedError) - - name: createMaxAgeTranspiredError() - uid: '@azure/msal-common.ClientConfigurationError.createMaxAgeTranspiredError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createMaxAgeTranspiredError](xref:@azure/msal-common.ClientAuthError.createMaxAgeTranspiredError) - - name: createMultipleMatchingAccountsInCacheError() - uid: >- - @azure/msal-common.ClientConfigurationError.createMultipleMatchingAccountsInCacheError - package: '@azure/msal-common' - summary: Throws error when multiple accounts are in cache for the given params - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createMultipleMatchingAccountsInCacheError(): - ClientAuthError - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createMultipleMatchingAccountsInCacheError](xref:@azure/msal-common.ClientAuthError.createMultipleMatchingAccountsInCacheError) - - name: createMultipleMatchingAppMetadataInCacheError() - uid: >- - @azure/msal-common.ClientConfigurationError.createMultipleMatchingAppMetadataInCacheError - package: '@azure/msal-common' - summary: Throws error when multiple appMetada are in cache for the given clientId. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createMultipleMatchingAppMetadataInCacheError(): - ClientAuthError - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createMultipleMatchingAppMetadataInCacheError](xref:@azure/msal-common.ClientAuthError.createMultipleMatchingAppMetadataInCacheError) - - name: createMultipleMatchingTokensInCacheError() - uid: >- - @azure/msal-common.ClientConfigurationError.createMultipleMatchingTokensInCacheError - package: '@azure/msal-common' - summary: Throws error when multiple tokens are in cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createMultipleMatchingTokensInCacheError(): - ClientAuthError - return: - description: '' - type: inheritanceDescription: >- Inherited From - [ClientAuthError.createMultipleMatchingTokensInCacheError](xref:@azure/msal-common.ClientAuthError.createMultipleMatchingTokensInCacheError) - - name: 'createNetworkError(string, string)' - uid: '@azure/msal-common.ClientConfigurationError.createNetworkError' + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) + - name: setCorrelationId(string) + uid: '@azure/msal-common.ClientConfigurationError.setCorrelationId' package: '@azure/msal-common' - summary: Creates an error thrown when the fetch client throws + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static function createNetworkError(endpoint: string, errDetail: string): - ClientAuthError + content: 'function setCorrelationId(correlationId: string)' parameters: - - id: endpoint - type: string - description: '' - - id: errDetail - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createNetworkError](xref:@azure/msal-common.ClientAuthError.createNetworkError) - - name: createNoAccountFoundError() - uid: '@azure/msal-common.ClientConfigurationError.createNoAccountFoundError' - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createNoAccountFoundError](xref:@azure/msal-common.ClientAuthError.createNoAccountFoundError) - - name: createNoAccountInSilentRequestError() - uid: >- - @azure/msal-common.ClientConfigurationError.createNoAccountInSilentRequestError - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createNoAccountInSilentRequestError](xref:@azure/msal-common.ClientAuthError.createNoAccountInSilentRequestError) - - name: createNoAuthCodeInServerResponseError() - uid: >- - @azure/msal-common.ClientConfigurationError.createNoAuthCodeInServerResponseError - package: '@azure/msal-common' - summary: >- - Throws error when the authorization code is missing from the server - response - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createNoAuthCodeInServerResponseError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createNoAuthCodeInServerResponseError](xref:@azure/msal-common.ClientAuthError.createNoAuthCodeInServerResponseError) - - name: createNoCryptoObjectError(string) - uid: '@azure/msal-common.ClientConfigurationError.createNoCryptoObjectError' - package: '@azure/msal-common' - summary: Throws error if crypto object not found. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNoCryptoObjectError(operationName: string): - ClientAuthError - parameters: - - id: operationName - type: string - description: |+ - - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createNoCryptoObjectError](xref:@azure/msal-common.ClientAuthError.createNoCryptoObjectError) - - name: createNonceMismatchError() - uid: '@azure/msal-common.ClientConfigurationError.createNonceMismatchError' - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createNonceMismatchError](xref:@azure/msal-common.ClientAuthError.createNonceMismatchError) - - name: createNonceNotFoundError(string) - uid: '@azure/msal-common.ClientConfigurationError.createNonceNotFoundError' - package: '@azure/msal-common' - summary: Creates an error thrown when the mnonce is not present - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNonceNotFoundError(missingNonce: string): - ClientAuthError - parameters: - - id: missingNonce - type: string - description: |+ - - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createNonceNotFoundError](xref:@azure/msal-common.ClientAuthError.createNonceNotFoundError) - - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createNullOrUndefinedCacheRecord](xref:@azure/msal-common.ClientAuthError.createNullOrUndefinedCacheRecord) - - name: createPostRequestFailed(string) - uid: '@azure/msal-common.ClientConfigurationError.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: createRefreshRequiredError() - uid: '@azure/msal-common.ClientConfigurationError.createRefreshRequiredError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createRefreshRequiredError](xref:@azure/msal-common.ClientAuthError.createRefreshRequiredError) - - name: createRemoveEmptyScopeFromSetError(string) - uid: >- - @azure/msal-common.ClientConfigurationError.createRemoveEmptyScopeFromSetError - package: '@azure/msal-common' - summary: >- - Throws error when attempting to append a null, undefined or empty scope to - a set - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createRemoveEmptyScopeFromSetError(givenScope: string): - ClientAuthError - parameters: - - id: givenScope - type: string - description: |+ - - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createRemoveEmptyScopeFromSetError](xref:@azure/msal-common.ClientAuthError.createRemoveEmptyScopeFromSetError) - - name: createStateMismatchError() - uid: '@azure/msal-common.ClientConfigurationError.createStateMismatchError' - 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createStateMismatchError](xref:@azure/msal-common.ClientAuthError.createStateMismatchError) - - name: createStateNotFoundError(string) - uid: '@azure/msal-common.ClientConfigurationError.createStateNotFoundError' - package: '@azure/msal-common' - summary: Creates an error thrown when the state is not present - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createStateNotFoundError(missingState: string): - ClientAuthError - parameters: - - id: missingState - type: string - description: |+ - - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createStateNotFoundError](xref:@azure/msal-common.ClientAuthError.createStateNotFoundError) - - name: createTokenClaimsRequiredError() - uid: '@azure/msal-common.ClientConfigurationError.createTokenClaimsRequiredError' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createTokenClaimsRequiredError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createTokenClaimsRequiredError](xref:@azure/msal-common.ClientAuthError.createTokenClaimsRequiredError) - - name: createTokenNullOrEmptyError(string) - uid: '@azure/msal-common.ClientConfigurationError.createTokenNullOrEmptyError' - 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: >- - static function createTokenNullOrEmptyError(invalidRawTokenString: - string): ClientAuthError - parameters: - - id: invalidRawTokenString - type: string - description: |+ - - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createTokenNullOrEmptyError](xref:@azure/msal-common.ClientAuthError.createTokenNullOrEmptyError) - - name: createTokenParsingError(string) - uid: '@azure/msal-common.ClientConfigurationError.createTokenParsingError' - package: '@azure/msal-common' - summary: Creates an error thrown when the id token extraction errors out. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createTokenParsingError(caughtExtractionError: string): - ClientAuthError - parameters: - - id: caughtExtractionError - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createTokenParsingError](xref:@azure/msal-common.ClientAuthError.createTokenParsingError) - - name: createTokenRequestCannotBeMadeError() - uid: >- - @azure/msal-common.ClientConfigurationError.createTokenRequestCannotBeMadeError - package: '@azure/msal-common' - summary: >- - Throws error when no auth code or refresh token is given to - ServerTokenRequestParameters. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createTokenRequestCannotBeMadeError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createTokenRequestCannotBeMadeError](xref:@azure/msal-common.ClientAuthError.createTokenRequestCannotBeMadeError) - - name: createUnableToGetOpenidConfigError(string) - uid: >- - @azure/msal-common.ClientConfigurationError.createUnableToGetOpenidConfigError - package: '@azure/msal-common' - summary: >- - 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: >- - static function createUnableToGetOpenidConfigError(errDetail: string): - ClientAuthError - parameters: - - id: errDetail - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createUnableToGetOpenidConfigError](xref:@azure/msal-common.ClientAuthError.createUnableToGetOpenidConfigError) - - name: createUnexpectedAccountTypeError() - uid: >- - @azure/msal-common.ClientConfigurationError.createUnexpectedAccountTypeError - package: '@azure/msal-common' - summary: Throws error if unexpected account type. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUnexpectedAccountTypeError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createUnexpectedAccountTypeError](xref:@azure/msal-common.ClientAuthError.createUnexpectedAccountTypeError) - - name: createUnexpectedCredentialTypeError() - uid: >- - @azure/msal-common.ClientConfigurationError.createUnexpectedCredentialTypeError - 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: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createUnexpectedCredentialTypeError](xref:@azure/msal-common.ClientAuthError.createUnexpectedCredentialTypeError) - - name: createUnexpectedError(string) - uid: '@azure/msal-common.ClientConfigurationError.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: 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' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createUserTimeoutReachedError](xref:@azure/msal-common.ClientAuthError.createUserTimeoutReachedError) - - name: setCorrelationId(string) - uid: '@azure/msal-common.ClientConfigurationError.setCorrelationId' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setCorrelationId(correlationId: string)' - parameters: - - id: correlationId + - id: correlationId type: string description: '' inheritanceDescription: >- Inherited From [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) -methods: - - name: createClaimsRequestParsingError(string) - uid: >- - @azure/msal-common.ClientConfigurationError.createClaimsRequestParsingError - package: '@azure/msal-common' - summary: >- - Creates an error thrown when the claims request could not be successfully - parsed - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createClaimsRequestParsingError(claimsRequestParseError: - string): ClientConfigurationError - parameters: - - id: claimsRequestParseError - type: string - description: '' - return: - description: '' - type: - - name: createClientIdSingleScopeError(Array) - uid: '@azure/msal-common.ClientConfigurationError.createClientIdSingleScopeError' - package: '@azure/msal-common' - summary: Error thrown when client id scope is not provided as single scope. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createClientIdSingleScopeError(inputScopes: - Array): ClientConfigurationError - parameters: - - id: inputScopes - type: Array<string> - description: |+ - - return: - description: '' - type: - - name: createEmptyLogoutRequestError() - uid: '@azure/msal-common.ClientConfigurationError.createEmptyLogoutRequestError' - 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 createEmptyLogoutRequestError(): - ClientConfigurationError - return: - description: '' - type: - - name: createEmptyScopesArrayError() - uid: '@azure/msal-common.ClientConfigurationError.createEmptyScopesArrayError' - package: '@azure/msal-common' - summary: Error thrown when scopes are empty. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createEmptyScopesArrayError(): ClientConfigurationError' - return: - description: '' - type: - - name: createEmptyTokenRequestError() - uid: '@azure/msal-common.ClientConfigurationError.createEmptyTokenRequestError' - 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' - return: - description: '' - type: - - name: createInsecureAuthorityUriError(string) - uid: >- - @azure/msal-common.ClientConfigurationError.createInsecureAuthorityUriError - package: '@azure/msal-common' - summary: Creates an error thrown if authority uri is given an insecure protocol. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInsecureAuthorityUriError(urlString: string): - ClientConfigurationError - parameters: - - id: urlString - type: string - description: |+ - - return: - description: '' - type: - - name: 'createInvalidAuthenticationHeaderError(string, string)' - uid: >- - @azure/msal-common.ClientConfigurationError.createInvalidAuthenticationHeaderError - package: '@azure/msal-common' - summary: Throws error when a provided header is invalid in any way - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function - createInvalidAuthenticationHeaderError(invalidHeaderName: string, - details: string): ClientConfigurationError - parameters: - - id: invalidHeaderName - type: string - description: '' - - id: details - type: string - description: '' - return: - description: '' - type: - - name: createInvalidAuthorityMetadataError() - uid: >- - @azure/msal-common.ClientConfigurationError.createInvalidAuthorityMetadataError - package: '@azure/msal-common' - summary: Throws an error when the user passes invalid cloudDiscoveryMetadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidAuthorityMetadataError(): - ClientConfigurationError - return: - description: '' - type: - - name: createInvalidAzureCloudInstanceError() - uid: >- - @azure/msal-common.ClientConfigurationError.createInvalidAzureCloudInstanceError - package: '@azure/msal-common' - summary: Throws error when the AzureCloudInstance is set to an invalid value - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidAzureCloudInstanceError(): - ClientConfigurationError - return: - description: '' - type: - - name: createInvalidClaimsRequestError() - uid: >- - @azure/msal-common.ClientConfigurationError.createInvalidClaimsRequestError - package: '@azure/msal-common' - summary: >- - Creates error thrown when claims parameter is not a stringified JSON - object - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidClaimsRequestError(): - ClientConfigurationError - return: - description: '' - type: - - name: createInvalidCloudDiscoveryMetadataError() - uid: >- - @azure/msal-common.ClientConfigurationError.createInvalidCloudDiscoveryMetadataError - package: '@azure/msal-common' - summary: Throws an error when the user passes invalid cloudDiscoveryMetadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidCloudDiscoveryMetadataError(): - ClientConfigurationError - return: - description: '' - type: - - name: createInvalidCodeChallengeMethodError() - uid: >- - @azure/msal-common.ClientConfigurationError.createInvalidCodeChallengeMethodError - 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: >- - static function createInvalidCodeChallengeMethodError(): - ClientConfigurationError - return: - description: '' - type: - - name: createInvalidCodeChallengeParamsError() - uid: >- - @azure/msal-common.ClientConfigurationError.createInvalidCodeChallengeParamsError - package: '@azure/msal-common' - summary: >- - Throws error when both params: code_challenge and code_challenge_method - are not passed together - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidCodeChallengeParamsError(): - ClientConfigurationError - return: - description: '' - type: - - name: createInvalidPromptError(string) - uid: '@azure/msal-common.ClientConfigurationError.createInvalidPromptError' - package: '@azure/msal-common' - summary: Error thrown when prompt is not an allowed type. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidPromptError(promptValue: string): - ClientConfigurationError - parameters: - - id: promptValue - type: string - description: |+ - - return: - description: '' - type: - - name: createMissingNonceAuthenticationHeadersError() - uid: >- - @azure/msal-common.ClientConfigurationError.createMissingNonceAuthenticationHeadersError - package: '@azure/msal-common' - summary: >- - 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: >- - static function createMissingNonceAuthenticationHeadersError(): - ClientConfigurationError - return: - description: '' - type: - - name: createMissingSshJwkError() - uid: '@azure/msal-common.ClientConfigurationError.createMissingSshJwkError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - - name: createMissingSshKidError() - uid: '@azure/msal-common.ClientConfigurationError.createMissingSshKidError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - - name: createPostLogoutRedirectUriEmptyError() - uid: >- - @azure/msal-common.ClientConfigurationError.createPostLogoutRedirectUriEmptyError - package: '@azure/msal-common' - summary: >- - Creates an error thrown when the post-logout redirect uri is empty (not - set by caller) - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createPostLogoutRedirectUriEmptyError(): - ClientConfigurationError - return: - description: '' - type: - - name: createRedirectUriEmptyError() - uid: '@azure/msal-common.ClientConfigurationError.createRedirectUriEmptyError' - 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' - return: - description: '' - type: - - name: createUntrustedAuthorityError() - uid: '@azure/msal-common.ClientConfigurationError.createUntrustedAuthorityError' - package: '@azure/msal-common' - summary: >- - Throws error when provided authority is not a member of the trusted host - list - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createUntrustedAuthorityError(): - ClientConfigurationError - return: - description: '' - type: - - name: createUrlEmptyError() - uid: '@azure/msal-common.ClientConfigurationError.createUrlEmptyError' - 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' - return: - description: '' - type: - - name: createUrlParseError(string) - uid: '@azure/msal-common.ClientConfigurationError.createUrlParseError' - package: '@azure/msal-common' - summary: >- - Creates an error thrown if URL string does not parse into separate - segments. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createUrlParseError(urlParseError: string): - ClientConfigurationError - parameters: - - id: urlParseError - type: string - description: '' - return: - description: '' - type: -extends: +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/ClientCredentialClient.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientCredentialClient.yml deleted file mode 100644 index cdcf324..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientCredentialClient.yml +++ /dev/null @@ -1,107 +0,0 @@ -### YamlMime:TSType -name: ClientCredentialClient -uid: '@azure/msal-common.ClientCredentialClient' -package: '@azure/msal-common' -summary: OAuth2.0 client credential grant -fullName: ClientCredentialClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'ClientCredentialClient(ClientConfiguration, IAppTokenProvider)' - uid: '@azure/msal-common.ClientCredentialClient.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - 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-common.ClientCredentialClient.authority' - package: '@azure/msal-common' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: Authority' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.authority](xref:@azure/msal-common.BaseClient.authority) - - name: logger - uid: '@azure/msal-common.ClientCredentialClient.logger' - package: '@azure/msal-common' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) -inheritedMethods: - - name: updateAuthority(Authority) - uid: '@azure/msal-common.ClientCredentialClient.updateAuthority' - package: '@azure/msal-common' - 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: - description: |+ - - inheritanceDescription: >- - Inherited From - [BaseClient.updateAuthority](xref:@azure/msal-common.BaseClient.updateAuthority) -methods: - - name: acquireToken(CommonClientCredentialRequest) - uid: '@azure/msal-common.ClientCredentialClient.acquireToken' - package: '@azure/msal-common' - summary: >- - Public API to acquire a token with ClientCredential Flow for Confidential - clients - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: CommonClientCredentialRequest): - Promise - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: >- - Promise< | - null> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientCredentials.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientCredentials.yml deleted file mode 100644 index 73d7778..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientCredentials.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: ClientCredentials -uid: '@azure/msal-common.ClientCredentials' -package: '@azure/msal-common' -summary: Client Credentials set for Confidential Clients -fullName: ClientCredentials -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ClientCredentials = { - clientAssertion?: ClientAssertion, - clientSecret?: string, - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ClientInfo.yml b/msal/docs-ref-autogen/@azure/msal-common/ClientInfo.yml index 8cf749d..278dc1f 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ClientInfo.yml +++ b/msal/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 } + type ClientInfo = { uid: string; utid: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CloudDiscoveryMetadata.yml b/msal/docs-ref-autogen/@azure/msal-common/CloudDiscoveryMetadata.yml deleted file mode 100644 index 8d0c3f8..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/CloudDiscoveryMetadata.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: CloudDiscoveryMetadata -uid: '@azure/msal-common.CloudDiscoveryMetadata' -package: '@azure/msal-common' -summary: '' -fullName: CloudDiscoveryMetadata -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type CloudDiscoveryMetadata = { - aliases: Array, - preferred_cache: string, - preferred_network: string, - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CloudInstanceDiscoveryResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/CloudInstanceDiscoveryResponse.yml deleted file mode 100644 index 757932f..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml index 61ee6d0..18573cf 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationCodeRequest.yml @@ -2,10 +2,11 @@ name: CommonAuthorizationCodeRequest uid: '@azure/msal-common.CommonAuthorizationCodeRequest' package: '@azure/msal-common' -summary: > +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. @@ -34,26 +35,26 @@ 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 & { - ccsCredential?: CcsCredential, - clientInfo?: string, - code: string, - codeVerifier?: string, - enableSpaAuthorizationCode?: boolean, - redirectUri: string, - tokenBodyParameters?: StringDict, - tokenQueryParameters?: StringDict, + ccsCredential?: CcsCredential + clientInfo?: string + code: string + codeVerifier?: string + enableSpaAuthorizationCode?: boolean + redirectUri: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml index 810e3cc..b8da7ac 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonAuthorizationUrlRequest.yml @@ -2,10 +2,11 @@ name: CommonAuthorizationUrlRequest uid: '@azure/msal-common.CommonAuthorizationUrlRequest' package: '@azure/msal-common' -summary: > +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. @@ -86,23 +87,21 @@ summary: > proof-of-possession flows. fullName: CommonAuthorizationUrlRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type CommonAuthorizationUrlRequest = BaseAuthRequest & { - account?: AccountInfo, - codeChallenge?: string, - codeChallengeMethod?: string, - domainHint?: string, - extraQueryParameters?: StringDict, - extraScopesToConsent?: Array, - loginHint?: string, - nativeBroker?: boolean, - nonce?: string, - prompt?: string, - redirectUri: string, - responseMode: ResponseMode, - sid?: string, - state?: string, - tokenQueryParameters?: StringDict, + account?: AccountInfo + codeChallenge?: string + codeChallengeMethod?: string + domainHint?: string + extraQueryParameters?: StringDict + extraScopesToConsent?: string[] + loginHint?: string + nonce?: string + platformBroker?: boolean + prompt?: string + redirectUri: string + responseMode: ResponseMode + sid?: string + state?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml deleted file mode 100644 index 5381b82..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonClientConfiguration.yml +++ /dev/null @@ -1,24 +0,0 @@ -### YamlMime:TSTypeAlias -name: CommonClientConfiguration -uid: '@azure/msal-common.CommonClientConfiguration' -package: '@azure/msal-common' -summary: '' -fullName: CommonClientConfiguration -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type CommonClientConfiguration = { - authOptions: Required, - clientCredentials: ClientCredentials, - cryptoInterface: Required, - libraryInfo: LibraryInfo, - loggerOptions: Required, - networkInterface: INetworkModule, - persistencePlugin: ICachePlugin | null, - serializableCache: ISerializableTokenCache | null, - serverTelemetryManager: ServerTelemetryManager | null, - storageInterface: CacheManager, - systemOptions: Required, - telemetry: Required, - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml index 08a669c..53e2874 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonClientCredentialRequest.yml @@ -19,13 +19,15 @@ 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 & { - azureRegion?: AzureRegion, - clientAssertion?: ClientAssertion, - skipCache?: boolean, + 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 index c89c654..51be718 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonDeviceCodeRequest.yml @@ -39,13 +39,19 @@ 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 & { - cancel?: boolean, - deviceCodeCallback: (response: DeviceCodeResponse) => void, - timeout?: number, + type CommonDeviceCodeRequest = Omit< + BaseAuthRequest, + "tokenQueryParameters" | "tokenBodyParameters" + > & { + 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 index 28805b1..fb5fc2f 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonEndSessionRequest.yml @@ -22,17 +22,19 @@ 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 = { - account?: AccountInfo | null, - correlationId: string, - extraQueryParameters?: StringDict, - idTokenHint?: string, - logoutHint?: string, - postLogoutRedirectUri?: string | null, - state?: string, + 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 index a493905..658e444 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonOnBehalfOfRequest.yml @@ -17,12 +17,14 @@ 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 & { - oboAssertion: string, - skipCache?: boolean, + 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 index 64d7169..6b8ad2b 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonRefreshTokenRequest.yml @@ -28,14 +28,16 @@ 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, + ccsCredential?: CcsCredential + forceCache?: boolean + redirectUri?: string + refreshToken: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml index 8d1706e..1c3a621 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonSilentFlowRequest.yml @@ -23,18 +23,21 @@ 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, + account: AccountInfo + forceRefresh: boolean + redirectUri?: string + refreshTokenExpirationOffsetSeconds?: number } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml index 782abd8..414476b 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CommonUsernamePasswordRequest.yml @@ -2,12 +2,13 @@ name: CommonUsernamePasswordRequest uid: '@azure/msal-common.CommonUsernamePasswordRequest' package: '@azure/msal-common' -summary: > +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. @@ -24,12 +25,14 @@ 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 & { - password: string, - username: string, + password: string + username: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CredentialCache.yml b/msal/docs-ref-autogen/@azure/msal-common/CredentialCache.yml deleted file mode 100644 index 69eb8c8..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/CredentialCache.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: CredentialCache -uid: '@azure/msal-common.CredentialCache' -package: '@azure/msal-common' -summary: '' -fullName: CredentialCache -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type CredentialCache = { - accessTokens: AccessTokenCache, - idTokens: IdTokenCache, - refreshTokens: RefreshTokenCache, - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml index 813e5d4..232ad70 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CredentialEntity.yml @@ -1,323 +1,23 @@ -### YamlMime:TSType +### YamlMime:TSTypeAlias name: CredentialEntity uid: '@azure/msal-common.CredentialEntity' package: '@azure/msal-common' -summary: > - Base type for credentials to be stored in the cache: eg: ACCESS_TOKEN, - ID_TOKEN etc - - Key:Value Schema: - - - Key: - ------- - - - Value Schema: - - { - homeAccountId: home account identifier for the auth scheme, - environment: entity that issued the token, represented as a full host - credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other - clientId: client ID of the application - secret: Actual credential as a string - familyId: Family ID identifier, usually only used for refresh tokens - realm: Full tenant or organizational identifier that the account belongs to - target: Permissions that are included in the token, or for refresh tokens, the resource identifier. - tokenType: Matches the authentication scheme for which the token was issued (i.e. Bearer or pop) - requestedClaimsHash: Matches the SHA 256 hash of the claims object included in the token request - userAssertionHash: Matches the SHA 256 hash of the obo_assertion for the OBO flow - } +summary: Credential Cache Type fullName: CredentialEntity remarks: '' -isPreview: false isDeprecated: false -type: class -properties: - - name: clientId - uid: '@azure/msal-common.CredentialEntity.clientId' - package: '@azure/msal-common' - summary: '' - fullName: clientId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clientId: string' - return: - description: '' - type: string - - name: credentialType - uid: '@azure/msal-common.CredentialEntity.credentialType' - package: '@azure/msal-common' - summary: '' - fullName: credentialType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'credentialType: CredentialType' - return: - description: '' - type: - - name: environment - uid: '@azure/msal-common.CredentialEntity.environment' - package: '@azure/msal-common' - summary: '' - fullName: environment - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'environment: string' - return: - description: '' - type: string - - name: familyId - uid: '@azure/msal-common.CredentialEntity.familyId' - package: '@azure/msal-common' - summary: '' - fullName: familyId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'familyId?: string' - return: - description: '' - type: string - - name: homeAccountId - uid: '@azure/msal-common.CredentialEntity.homeAccountId' - package: '@azure/msal-common' - summary: '' - fullName: homeAccountId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'homeAccountId: string' - return: - description: '' - type: string - - name: keyId - uid: '@azure/msal-common.CredentialEntity.keyId' - package: '@azure/msal-common' - summary: '' - fullName: keyId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'keyId?: string' - return: - description: '' - type: string - - name: realm - uid: '@azure/msal-common.CredentialEntity.realm' - package: '@azure/msal-common' - summary: '' - fullName: realm - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'realm?: string' - return: - description: '' - type: string - - name: requestedClaimsHash - uid: '@azure/msal-common.CredentialEntity.requestedClaimsHash' - package: '@azure/msal-common' - summary: '' - fullName: requestedClaimsHash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'requestedClaimsHash?: string' - return: - description: '' - type: string - - name: secret - uid: '@azure/msal-common.CredentialEntity.secret' - package: '@azure/msal-common' - summary: '' - fullName: secret - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'secret: string' - return: - description: '' - type: string - - name: target - uid: '@azure/msal-common.CredentialEntity.target' - package: '@azure/msal-common' - summary: '' - fullName: target - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'target?: string' - return: - description: '' - type: string - - name: tokenType - uid: '@azure/msal-common.CredentialEntity.tokenType' - package: '@azure/msal-common' - summary: '' - fullName: tokenType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tokenType?: AuthenticationScheme' - return: - description: '' - type: - - name: userAssertionHash - uid: '@azure/msal-common.CredentialEntity.userAssertionHash' - package: '@azure/msal-common' - summary: '' - fullName: userAssertionHash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userAssertionHash?: string' - return: - description: '' - type: string -methods: - - name: generateAccountId() - uid: '@azure/msal-common.CredentialEntity.generateAccountId' - package: '@azure/msal-common' - summary: >- - Generate Account Id key component as per the schema: - - - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateAccountId(): string' - return: - description: '' - type: string - - name: >- - generateCredentialCacheKey(string, string, CredentialType, string, string, - string, string, AuthenticationScheme, string) - uid: '@azure/msal-common.CredentialEntity.generateCredentialCacheKey' - package: '@azure/msal-common' - summary: >- - generates credential key - - -\----- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateCredentialCacheKey(homeAccountId: string, - environment: string, credentialType: CredentialType, clientId: string, - realm?: string, target?: string, familyId?: string, tokenType?: - AuthenticationScheme, requestedClaimsHash?: string): string - parameters: - - id: homeAccountId - type: string - description: '' - - id: environment - type: string - description: '' - - id: credentialType - type: - description: '' - - id: clientId - type: string - description: '' - - id: realm - type: string - description: '' - - id: target - type: string - description: '' - - id: familyId - type: string - description: '' - - id: tokenType - type: - description: '' - - id: requestedClaimsHash - type: string - description: '' - return: - description: '' - type: string - - name: generateCredentialId() - uid: '@azure/msal-common.CredentialEntity.generateCredentialId' - package: '@azure/msal-common' - summary: >- - Generate Credential Id key component as per the schema: - -- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCredentialId(): string' - return: - description: '' - type: string - - name: generateCredentialKey() - uid: '@azure/msal-common.CredentialEntity.generateCredentialKey' - package: '@azure/msal-common' - summary: generates credential key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCredentialKey(): string' - return: - description: '' - type: string - - name: generateTarget() - uid: '@azure/msal-common.CredentialEntity.generateTarget' - package: '@azure/msal-common' - summary: 'Generate target key component as per schema: ' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateTarget(): string' - return: - description: '' - type: string - - name: generateType() - uid: '@azure/msal-common.CredentialEntity.generateType' - 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' - return: - description: '' - type: number - - name: getCredentialType(string) - uid: '@azure/msal-common.CredentialEntity.getCredentialType' - package: '@azure/msal-common' - summary: helper function to return `CredentialType` - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function getCredentialType(key: string): string' - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: string +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 index 79797bb..c3fb0a6 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CredentialFilter.yml @@ -7,19 +7,18 @@ summary: >- ------ fullName: CredentialFilter remarks: '' -isPreview: false isDeprecated: false syntax: | type CredentialFilter = { - clientId?: string, - credentialType?: string, - environment?: string, - familyId?: string, - homeAccountId?: string, - keyId?: string, - realm?: string, - requestedClaimsHash?: string, - target?: string, - tokenType?: AuthenticationScheme, - userAssertionHash?: string, + 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 index a99cf46..ad1dda8 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/CredentialType.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/CredentialType.yml @@ -1,26 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: CredentialType uid: '@azure/msal-common.CredentialType' package: '@azure/msal-common' -summary: Credential Type stored in the cache +summary: '' fullName: CredentialType remarks: '' -isPreview: false isDeprecated: false -fields: - - name: ACCESS_TOKEN - uid: '@azure/msal-common.CredentialType.ACCESS_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: ACCESS_TOKEN_WITH_AUTH_SCHEME - uid: '@azure/msal-common.CredentialType.ACCESS_TOKEN_WITH_AUTH_SCHEME' - package: '@azure/msal-common' - summary: '' - - name: ID_TOKEN - uid: '@azure/msal-common.CredentialType.ID_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: REFRESH_TOKEN - uid: '@azure/msal-common.CredentialType.REFRESH_TOKEN' - package: '@azure/msal-common' - summary: '' +syntax: | + type CredentialType = (typeof CredentialType)[keyof typeof CredentialType] diff --git a/msal/docs-ref-autogen/@azure/msal-common/DecodedAuthToken.yml b/msal/docs-ref-autogen/@azure/msal-common/DecodedAuthToken.yml deleted file mode 100644 index b1214c5..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/DecodedAuthToken.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: DecodedAuthToken -uid: '@azure/msal-common.DecodedAuthToken' -package: '@azure/msal-common' -summary: Interface for Decoded JWT tokens. -fullName: DecodedAuthToken -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: header - uid: '@azure/msal-common.DecodedAuthToken.header' - package: '@azure/msal-common' - summary: '' - fullName: header - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'header: string' - return: - description: '' - type: string - - name: JWSPayload - uid: '@azure/msal-common.DecodedAuthToken.JWSPayload' - package: '@azure/msal-common' - summary: '' - fullName: JWSPayload - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'JWSPayload: string' - return: - description: '' - type: string - - name: JWSSig - uid: '@azure/msal-common.DecodedAuthToken.JWSSig' - package: '@azure/msal-common' - summary: '' - fullName: JWSSig - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'JWSSig: string' - return: - description: '' - type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml b/msal/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml deleted file mode 100644 index 9735bb6..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/DefaultStorageClass.yml +++ /dev/null @@ -1,734 +0,0 @@ -### YamlMime:TSType -name: DefaultStorageClass -uid: '@azure/msal-common.DefaultStorageClass' -package: '@azure/msal-common' -summary: '' -fullName: DefaultStorageClass -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'DefaultStorageClass(string, ICrypto)' - uid: '@azure/msal-common.DefaultStorageClass.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new DefaultStorageClass(clientId: string, cryptoImpl: ICrypto)' - parameters: - - id: clientId - type: string - description: '' - - id: cryptoImpl - type: - description: '' -inheritedMethods: - - name: generateAuthorityMetadataCacheKey(string) - uid: '@azure/msal-common.DefaultStorageClass.generateAuthorityMetadataCacheKey' - 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' - parameters: - - id: authority - type: string - description: '' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CacheManager.generateAuthorityMetadataCacheKey](xref:@azure/msal-common.CacheManager.generateAuthorityMetadataCacheKey) - - name: getAccountsFilteredBy(AccountFilter) - uid: '@azure/msal-common.DefaultStorageClass.getAccountsFilteredBy' - package: '@azure/msal-common' - summary: >- - retrieve accounts matching all provided filters; if no filter is set, get - all accounts - - 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: >- - function getAccountsFilteredBy(accountFilter?: AccountFilter): - AccountCache - parameters: - - id: accountFilter - type: - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [CacheManager.getAccountsFilteredBy](xref:@azure/msal-common.CacheManager.getAccountsFilteredBy) - - name: getAllAccounts() - uid: '@azure/msal-common.DefaultStorageClass.getAllAccounts' - package: '@azure/msal-common' - summary: Returns all accounts in cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAllAccounts(): AccountInfo[]' - return: - description: '' - type: '[]' - inheritanceDescription: >- - Inherited From - [CacheManager.getAllAccounts](xref:@azure/msal-common.CacheManager.getAllAccounts) - - name: getAppMetadataFilteredBy(AppMetadataFilter) - uid: '@azure/msal-common.DefaultStorageClass.getAppMetadataFilteredBy' - package: '@azure/msal-common' - summary: >- - retrieve appMetadata matching all provided filters; if no filter is set, - get all appMetadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAppMetadataFilteredBy(filter: AppMetadataFilter): - AppMetadataCache - parameters: - - id: filter - type: - description: |+ - - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [CacheManager.getAppMetadataFilteredBy](xref:@azure/msal-common.CacheManager.getAppMetadataFilteredBy) - - name: getAuthorityMetadataByAlias(string) - uid: '@azure/msal-common.DefaultStorageClass.getAuthorityMetadataByAlias' - package: '@azure/msal-common' - summary: retrieve authorityMetadata that contains a matching alias - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadataByAlias(host: string): - AuthorityMetadataEntity | null - parameters: - - id: host - type: string - description: '' - return: - description: '' - type: | null - inheritanceDescription: >- - Inherited From - [CacheManager.getAuthorityMetadataByAlias](xref:@azure/msal-common.CacheManager.getAuthorityMetadataByAlias) - - name: getCredentialsFilteredBy(CredentialFilter) - uid: '@azure/msal-common.DefaultStorageClass.getCredentialsFilteredBy' - package: '@azure/msal-common' - summary: >- - retrieve credentails matching all provided filters; if no filter is set, - get all credentials - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getCredentialsFilteredBy(filter: CredentialFilter): - CredentialCache - parameters: - - id: filter - type: - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [CacheManager.getCredentialsFilteredBy](xref:@azure/msal-common.CacheManager.getCredentialsFilteredBy) - - name: 'isAppMetadataFOCI(string, string)' - uid: '@azure/msal-common.DefaultStorageClass.isAppMetadataFOCI' - package: '@azure/msal-common' - summary: Return the family_id value associated with FOCI - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function isAppMetadataFOCI(environment: string, clientId: string): - boolean - parameters: - - id: environment - type: string - description: '' - - id: clientId - type: string - 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' - package: '@azure/msal-common' - summary: Retrieve AccessTokenEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccessTokenFromCache(clientId: string, account: - AccountInfo, request: BaseAuthRequest): AccessTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: - description: '' - - id: request - type: - description: '' - return: - description: '' - type: | null - inheritanceDescription: >- - Inherited From - [CacheManager.readAccessTokenFromCache](xref:@azure/msal-common.CacheManager.readAccessTokenFromCache) - - name: readAccountFromCache(AccountInfo) - uid: '@azure/msal-common.DefaultStorageClass.readAccountFromCache' - package: '@azure/msal-common' - summary: Retrieve AccountEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccountFromCache(account: AccountInfo): AccountEntity | - null - parameters: - - id: account - type: - description: |+ - - return: - description: '' - type: | null - inheritanceDescription: >- - Inherited From - [CacheManager.readAccountFromCache](xref:@azure/msal-common.CacheManager.readAccountFromCache) - - name: readAccountFromCacheWithNativeAccountId(string) - uid: >- - @azure/msal-common.DefaultStorageClass.readAccountFromCacheWithNativeAccountId - package: '@azure/msal-common' - summary: Retrieve AccountEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccountFromCacheWithNativeAccountId(nativeAccountId: - string): AccountEntity | null - parameters: - - id: nativeAccountId - type: string - description: '' - return: - description: AccountEntity or Null - type: | null - inheritanceDescription: >- - Inherited From - [CacheManager.readAccountFromCacheWithNativeAccountId](xref:@azure/msal-common.CacheManager.readAccountFromCacheWithNativeAccountId) - - name: 'readAppMetadataFromCache(string, string)' - uid: '@azure/msal-common.DefaultStorageClass.readAppMetadataFromCache' - package: '@azure/msal-common' - summary: Retrieve AppMetadataEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAppMetadataFromCache(environment: string, clientId: - 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)' - uid: '@azure/msal-common.DefaultStorageClass.readCacheRecord' - package: '@azure/msal-common' - summary: Retrieve the cached credentials into a cacherecord - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readCacheRecord(account: AccountInfo, clientId: string, - request: BaseAuthRequest, environment: string): CacheRecord - parameters: - - id: account - type: - description: '' - - id: clientId - type: string - description: '' - - id: request - type: - description: '' - - id: environment - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [CacheManager.readCacheRecord](xref:@azure/msal-common.CacheManager.readCacheRecord) - - name: 'readIdTokenFromCache(string, AccountInfo)' - uid: '@azure/msal-common.DefaultStorageClass.readIdTokenFromCache' - package: '@azure/msal-common' - summary: Retrieve IdTokenEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readIdTokenFromCache(clientId: string, account: AccountInfo): - IdTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: - description: '' - return: - description: '' - type: | null - inheritanceDescription: >- - Inherited From - [CacheManager.readIdTokenFromCache](xref:@azure/msal-common.CacheManager.readIdTokenFromCache) - - name: 'readRefreshTokenFromCache(string, AccountInfo, boolean)' - uid: '@azure/msal-common.DefaultStorageClass.readRefreshTokenFromCache' - package: '@azure/msal-common' - summary: Helper to retrieve the appropriate refresh token from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readRefreshTokenFromCache(clientId: string, account: - AccountInfo, familyRT: boolean): RefreshTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: - description: '' - - id: familyRT - type: boolean - description: |+ - - return: - description: '' - type: | null - inheritanceDescription: >- - Inherited From - [CacheManager.readRefreshTokenFromCache](xref:@azure/msal-common.CacheManager.readRefreshTokenFromCache) - - name: removeAccount(string) - uid: '@azure/msal-common.DefaultStorageClass.removeAccount' - 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' - parameters: - - id: accountKey - type: string - description: '' - return: - description: '' - type: Promise<boolean> - inheritanceDescription: >- - Inherited From - [CacheManager.removeAccount](xref:@azure/msal-common.CacheManager.removeAccount) - - name: removeAccountContext(AccountEntity) - uid: '@azure/msal-common.DefaultStorageClass.removeAccountContext' - package: '@azure/msal-common' - summary: Removes credentials associated with the provided account - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' - parameters: - - id: account - type: - description: |+ - - return: - description: '' - type: Promise<boolean> - inheritanceDescription: >- - Inherited From - [CacheManager.removeAccountContext](xref:@azure/msal-common.CacheManager.removeAccountContext) - - name: removeAllAccounts() - uid: '@azure/msal-common.DefaultStorageClass.removeAllAccounts' - package: '@azure/msal-common' - summary: Removes all accounts and related tokens from cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAllAccounts(): Promise' - return: - description: '' - type: Promise<boolean> - inheritanceDescription: >- - Inherited From - [CacheManager.removeAllAccounts](xref:@azure/msal-common.CacheManager.removeAllAccounts) - - name: removeAppMetadata() - uid: '@azure/msal-common.DefaultStorageClass.removeAppMetadata' - package: '@azure/msal-common' - summary: Removes all app metadata objects from cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAppMetadata(): boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [CacheManager.removeAppMetadata](xref:@azure/msal-common.CacheManager.removeAppMetadata) - - name: removeCredential(CredentialEntity) - uid: '@azure/msal-common.DefaultStorageClass.removeCredential' - package: '@azure/msal-common' - summary: returns a boolean if the given credential is removed - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function removeCredential(credential: CredentialEntity): - Promise - parameters: - - id: credential - type: - description: |+ - - return: - description: '' - type: Promise<boolean> - inheritanceDescription: >- - Inherited From - [CacheManager.removeCredential](xref:@azure/msal-common.CacheManager.removeCredential) - - name: saveCacheRecord(CacheRecord) - uid: '@azure/msal-common.DefaultStorageClass.saveCacheRecord' - package: '@azure/msal-common' - summary: saves a cache record - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' - parameters: - - id: cacheRecord - type: - description: |+ - - return: - description: '' - type: Promise<void> - inheritanceDescription: >- - Inherited From - [CacheManager.saveCacheRecord](xref:@azure/msal-common.CacheManager.saveCacheRecord) - - name: 'toObject(T, object)' - uid: '@azure/msal-common.DefaultStorageClass.toObject' - 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' - parameters: - - id: obj - type: T - description: '' - - id: json - type: object - description: |+ - - return: - description: '' - type: T - inheritanceDescription: >- - Inherited From - [CacheManager.toObject](xref:@azure/msal-common.CacheManager.toObject) -methods: - - name: clear() - uid: '@azure/msal-common.DefaultStorageClass.clear' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function clear(): Promise' - return: - description: '' - type: Promise<void> - - name: containsKey() - uid: '@azure/msal-common.DefaultStorageClass.containsKey' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function containsKey(): boolean' - return: - description: '' - type: boolean - - name: getAccessTokenCredential() - uid: '@azure/msal-common.DefaultStorageClass.getAccessTokenCredential' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAccessTokenCredential(): AccessTokenEntity' - return: - description: '' - type: - - name: getAccount() - uid: '@azure/msal-common.DefaultStorageClass.getAccount' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAccount(): AccountEntity' - return: - description: '' - type: - - name: getAppMetadata() - uid: '@azure/msal-common.DefaultStorageClass.getAppMetadata' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAppMetadata(): AppMetadataEntity' - return: - description: '' - type: - - name: getAuthorityMetadata() - uid: '@azure/msal-common.DefaultStorageClass.getAuthorityMetadata' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAuthorityMetadata(): AuthorityMetadataEntity | null' - return: - description: '' - type: | null - - name: getAuthorityMetadataKeys() - uid: '@azure/msal-common.DefaultStorageClass.getAuthorityMetadataKeys' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAuthorityMetadataKeys(): Array' - return: - description: '' - type: Array<string> - - name: getIdTokenCredential() - uid: '@azure/msal-common.DefaultStorageClass.getIdTokenCredential' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getIdTokenCredential(): IdTokenEntity' - return: - description: '' - type: - - name: getKeys() - uid: '@azure/msal-common.DefaultStorageClass.getKeys' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getKeys(): string[]' - return: - description: '' - type: 'string[]' - - name: getRefreshTokenCredential() - uid: '@azure/msal-common.DefaultStorageClass.getRefreshTokenCredential' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getRefreshTokenCredential(): RefreshTokenEntity' - return: - description: '' - type: - - name: getServerTelemetry() - uid: '@azure/msal-common.DefaultStorageClass.getServerTelemetry' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getServerTelemetry(): ServerTelemetryEntity' - return: - description: '' - type: - - name: getThrottlingCache() - uid: '@azure/msal-common.DefaultStorageClass.getThrottlingCache' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getThrottlingCache(): ThrottlingEntity' - return: - description: '' - type: - - name: removeItem() - uid: '@azure/msal-common.DefaultStorageClass.removeItem' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeItem(): boolean' - return: - description: '' - type: boolean - - name: setAccessTokenCredential() - uid: '@azure/msal-common.DefaultStorageClass.setAccessTokenCredential' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setAccessTokenCredential() - - name: setAccount() - uid: '@azure/msal-common.DefaultStorageClass.setAccount' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setAccount() - - name: setAppMetadata() - uid: '@azure/msal-common.DefaultStorageClass.setAppMetadata' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setAppMetadata() - - name: setAuthorityMetadata() - uid: '@azure/msal-common.DefaultStorageClass.setAuthorityMetadata' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setAuthorityMetadata() - - name: setIdTokenCredential() - uid: '@azure/msal-common.DefaultStorageClass.setIdTokenCredential' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setIdTokenCredential() - - name: setRefreshTokenCredential() - uid: '@azure/msal-common.DefaultStorageClass.setRefreshTokenCredential' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setRefreshTokenCredential() - - name: setServerTelemetry() - uid: '@azure/msal-common.DefaultStorageClass.setServerTelemetry' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setServerTelemetry() - - name: setThrottlingCache() - uid: '@azure/msal-common.DefaultStorageClass.setThrottlingCache' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function setThrottlingCache() - - name: updateCredentialCacheKey() - uid: '@azure/msal-common.DefaultStorageClass.updateCredentialCacheKey' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function updateCredentialCacheKey(): string' - return: - description: '' - type: string -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeClient.yml b/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeClient.yml deleted file mode 100644 index 1de4c58..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeClient.yml +++ /dev/null @@ -1,104 +0,0 @@ -### YamlMime:TSType -name: DeviceCodeClient -uid: '@azure/msal-common.DeviceCodeClient' -package: '@azure/msal-common' -summary: OAuth2.0 Device code client -fullName: DeviceCodeClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: DeviceCodeClient(ClientConfiguration) - uid: '@azure/msal-common.DeviceCodeClient.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new DeviceCodeClient(configuration: ClientConfiguration)' - parameters: - - id: configuration - type: - description: '' -inheritedProperties: - - name: authority - uid: '@azure/msal-common.DeviceCodeClient.authority' - package: '@azure/msal-common' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: Authority' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.authority](xref:@azure/msal-common.BaseClient.authority) - - name: logger - uid: '@azure/msal-common.DeviceCodeClient.logger' - package: '@azure/msal-common' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) -inheritedMethods: - - name: updateAuthority(Authority) - uid: '@azure/msal-common.DeviceCodeClient.updateAuthority' - package: '@azure/msal-common' - 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: - description: |+ - - inheritanceDescription: >- - Inherited From - [BaseClient.updateAuthority](xref:@azure/msal-common.BaseClient.updateAuthority) -methods: - - name: acquireToken(CommonDeviceCodeRequest) - uid: '@azure/msal-common.DeviceCodeClient.acquireToken' - package: '@azure/msal-common' - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: CommonDeviceCodeRequest): - Promise - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: >- - Promise< | - null> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml index 0764b3f..3adb738 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/DeviceCodeResponse.yml @@ -21,14 +21,13 @@ summary: >- - message: message which should be displayed to the user fullName: DeviceCodeResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type DeviceCodeResponse = { - deviceCode: string, - expiresIn: number, - interval: number, - message: string, - userCode: string, - verificationUri: string, + 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 index 163c06b..425a073 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ExternalTokenResponse.yml @@ -24,10 +24,16 @@ summary: >- - client_info: Client info object fullName: ExternalTokenResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type ExternalTokenResponse = Pick< ServerAuthorizationTokenResponse, - "token_type" | "scope" | "expires_in" | "id_token" | "refresh_token" - > & { access_token?: string, client_info?: string } + | "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/GrantType.yml b/msal/docs-ref-autogen/@azure/msal-common/GrantType.yml index fe34492..f2cdc1b 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/GrantType.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/GrantType.yml @@ -1,38 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: GrantType uid: '@azure/msal-common.GrantType' package: '@azure/msal-common' -summary: allowed grant_type +summary: '' fullName: GrantType remarks: '' -isPreview: false isDeprecated: false -fields: - - name: AUTHORIZATION_CODE_GRANT - uid: '@azure/msal-common.GrantType.AUTHORIZATION_CODE_GRANT' - package: '@azure/msal-common' - summary: '' - - name: CLIENT_CREDENTIALS_GRANT - uid: '@azure/msal-common.GrantType.CLIENT_CREDENTIALS_GRANT' - package: '@azure/msal-common' - summary: '' - - name: DEVICE_CODE_GRANT - uid: '@azure/msal-common.GrantType.DEVICE_CODE_GRANT' - package: '@azure/msal-common' - summary: '' - - name: IMPLICIT_GRANT - uid: '@azure/msal-common.GrantType.IMPLICIT_GRANT' - package: '@azure/msal-common' - summary: '' - - name: JWT_BEARER - uid: '@azure/msal-common.GrantType.JWT_BEARER' - package: '@azure/msal-common' - summary: '' - - name: REFRESH_TOKEN_GRANT - uid: '@azure/msal-common.GrantType.REFRESH_TOKEN_GRANT' - package: '@azure/msal-common' - summary: '' - - name: RESOURCE_OWNER_PASSWORD_GRANT - uid: '@azure/msal-common.GrantType.RESOURCE_OWNER_PASSWORD_GRANT' - package: '@azure/msal-common' - summary: '' +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 index 2763285..be3fcf2 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/HeaderNames.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/HeaderNames.yml @@ -1,34 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: HeaderNames uid: '@azure/msal-common.HeaderNames' package: '@azure/msal-common' -summary: Request header names +summary: '' fullName: HeaderNames remarks: '' -isPreview: false isDeprecated: false -fields: - - name: AuthenticationInfo - uid: '@azure/msal-common.HeaderNames.AuthenticationInfo' - package: '@azure/msal-common' - summary: '' - - name: CCS_HEADER - uid: '@azure/msal-common.HeaderNames.CCS_HEADER' - package: '@azure/msal-common' - summary: '' - - name: CONTENT_TYPE - uid: '@azure/msal-common.HeaderNames.CONTENT_TYPE' - package: '@azure/msal-common' - summary: '' - - name: RETRY_AFTER - uid: '@azure/msal-common.HeaderNames.RETRY_AFTER' - package: '@azure/msal-common' - summary: '' - - name: WWWAuthenticate - uid: '@azure/msal-common.HeaderNames.WWWAuthenticate' - package: '@azure/msal-common' - summary: '' - - name: X_MS_REQUEST_ID - uid: '@azure/msal-common.HeaderNames.X_MS_REQUEST_ID' - package: '@azure/msal-common' - summary: '' +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 index 34ab003..692ec6b 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/IAppTokenProvider.yml @@ -2,23 +2,8 @@ name: IAppTokenProvider uid: '@azure/msal-common.IAppTokenProvider' package: '@azure/msal-common' -summary: >- - Extensibility interface, which allows the app developer to return a token, - based on the passed-in parameters, instead of fetching tokens from - - the Identity Provider (AAD). - - Developers need to construct and return an AppTokenProviderResult object back - to MSAL. MSAL will cache the token response - - in the same way it would do if the result were comming from AAD. - - This extensibility point is only defined for the client_credential flow, i.e. - acquireTokenByClientCredential and - - meant for Azure SDK to enhance Managed Identity support. +summary: '' fullName: IAppTokenProvider remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/msal/docs-ref-autogen/@azure/msal-common/ICacheManager.yml b/msal/docs-ref-autogen/@azure/msal-common/ICacheManager.yml deleted file mode 100644 index bec62ad..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ICacheManager.yml +++ /dev/null @@ -1,465 +0,0 @@ -### YamlMime:TSType -name: ICacheManager -uid: '@azure/msal-common.ICacheManager' -package: '@azure/msal-common' -summary: '' -fullName: ICacheManager -remarks: '' -isPreview: false -isDeprecated: false -type: interface -methods: - - name: generateAuthorityMetadataCacheKey(string) - uid: '@azure/msal-common.ICacheManager.generateAuthorityMetadataCacheKey' - 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' - parameters: - - id: authority - type: string - description: |+ - - return: - description: '' - type: string - - name: getAccessTokenCredential(string) - uid: '@azure/msal-common.ICacheManager.getAccessTokenCredential' - package: '@azure/msal-common' - summary: fetch the idToken entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAccessTokenCredential(accessTokenKey: string): - AccessTokenEntity | null - parameters: - - id: accessTokenKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getAccount(string) - uid: '@azure/msal-common.ICacheManager.getAccount' - 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' - parameters: - - id: accountKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getAccountsFilteredBy(AccountFilter) - uid: '@azure/msal-common.ICacheManager.getAccountsFilteredBy' - package: '@azure/msal-common' - summary: >- - 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' - parameters: - - id: filter - type: - description: '' - return: - description: '' - type: - - name: getAllAccounts() - uid: '@azure/msal-common.ICacheManager.getAllAccounts' - package: '@azure/msal-common' - summary: Returns all accounts in cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAllAccounts(): AccountInfo[]' - return: - description: '' - type: '[]' - - name: getAppMetadata(string) - uid: '@azure/msal-common.ICacheManager.getAppMetadata' - package: '@azure/msal-common' - summary: fetch appMetadata entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAppMetadata(appMetadataKey: string): AppMetadataEntity | - null - parameters: - - id: appMetadataKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getAuthorityMetadata(string) - uid: '@azure/msal-common.ICacheManager.getAuthorityMetadata' - package: '@azure/msal-common' - summary: fetch cloud discovery metadata entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadata(key: string): AuthorityMetadataEntity | - null - parameters: - - id: key - type: string - description: |+ - - return: - description: '' - type: | null - - name: getAuthorityMetadataByAlias(string) - uid: '@azure/msal-common.ICacheManager.getAuthorityMetadataByAlias' - package: '@azure/msal-common' - summary: Provide an alias to find a matching AuthorityMetadataEntity in cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadataByAlias(host: string): - AuthorityMetadataEntity | null - parameters: - - id: host - type: string - description: |+ - - return: - description: '' - type: | null - - name: getAuthorityMetadataKeys() - uid: '@azure/msal-common.ICacheManager.getAuthorityMetadataKeys' - package: '@azure/msal-common' - summary: Get cache keys for authority metadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAuthorityMetadataKeys(): Array' - 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: '' - isPreview: false - 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' - summary: fetch the idToken entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getIdTokenCredential(idTokenKey: string): IdTokenEntity | null' - parameters: - - id: idTokenKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getRefreshTokenCredential(string) - uid: '@azure/msal-common.ICacheManager.getRefreshTokenCredential' - package: '@azure/msal-common' - summary: fetch the idToken entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getRefreshTokenCredential(refreshTokenKey: string): - RefreshTokenEntity | null - parameters: - - id: refreshTokenKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getServerTelemetry(string) - uid: '@azure/msal-common.ICacheManager.getServerTelemetry' - package: '@azure/msal-common' - summary: fetch server telemetry entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getServerTelemetry(serverTelemetryKey: string): - ServerTelemetryEntity | null - parameters: - - id: serverTelemetryKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: getThrottlingCache(string) - uid: '@azure/msal-common.ICacheManager.getThrottlingCache' - package: '@azure/msal-common' - summary: fetch throttling entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getThrottlingCache(throttlingCacheKey: string): - ThrottlingEntity | null - parameters: - - id: throttlingCacheKey - type: string - description: |+ - - return: - description: '' - type: | null - - name: removeAccount(string) - uid: '@azure/msal-common.ICacheManager.removeAccount' - 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' - parameters: - - id: accountKey - type: string - description: '' - return: - description: '' - type: Promise<boolean> - - name: removeAccountContext(AccountEntity) - uid: '@azure/msal-common.ICacheManager.removeAccountContext' - 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' - parameters: - - id: account - type: - description: |+ - - return: - description: '' - type: Promise<boolean> - - name: removeAllAccounts() - uid: '@azure/msal-common.ICacheManager.removeAllAccounts' - package: '@azure/msal-common' - summary: Removes all accounts and related tokens from cache. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAllAccounts(): Promise' - return: - description: '' - type: Promise<boolean> - - name: removeCredential(CredentialEntity) - uid: '@azure/msal-common.ICacheManager.removeCredential' - package: '@azure/msal-common' - summary: returns a boolean if the given credential is removed - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function removeCredential(credential: CredentialEntity): - Promise - parameters: - - id: credential - type: - description: |+ - - return: - description: '' - type: Promise<boolean> - - name: saveCacheRecord(CacheRecord) - uid: '@azure/msal-common.ICacheManager.saveCacheRecord' - package: '@azure/msal-common' - summary: saves a cache record - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' - parameters: - - id: cacheRecord - type: - description: |+ - - return: - description: '' - type: Promise<void> - - name: setAccessTokenCredential(AccessTokenEntity) - uid: '@azure/msal-common.ICacheManager.setAccessTokenCredential' - package: '@azure/msal-common' - summary: set idToken entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' - parameters: - - id: accessToken - type: - description: |+ - - - name: setAccount(AccountEntity) - uid: '@azure/msal-common.ICacheManager.setAccount' - package: '@azure/msal-common' - summary: set account entity in the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAccount(account: AccountEntity)' - parameters: - - id: account - type: - description: |+ - - - name: setAppMetadata(AppMetadataEntity) - uid: '@azure/msal-common.ICacheManager.setAppMetadata' - package: '@azure/msal-common' - summary: set appMetadata entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' - parameters: - - id: appMetadata - type: - description: |+ - - - name: 'setAuthorityMetadata(string, AuthorityMetadataEntity)' - uid: '@azure/msal-common.ICacheManager.setAuthorityMetadata' - package: '@azure/msal-common' - summary: set cloud discovery metadata entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setAuthorityMetadata(key: string, value: - AuthorityMetadataEntity) - parameters: - - id: key - type: string - description: '' - - id: value - type: - description: |+ - - - name: setIdTokenCredential(IdTokenEntity) - uid: '@azure/msal-common.ICacheManager.setIdTokenCredential' - package: '@azure/msal-common' - summary: set idToken entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setIdTokenCredential(idToken: IdTokenEntity)' - parameters: - - id: idToken - type: - description: |+ - - - name: setRefreshTokenCredential(RefreshTokenEntity) - uid: '@azure/msal-common.ICacheManager.setRefreshTokenCredential' - package: '@azure/msal-common' - summary: set idToken entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)' - parameters: - - id: refreshToken - type: - description: |+ - - - name: 'setServerTelemetry(string, ServerTelemetryEntity)' - uid: '@azure/msal-common.ICacheManager.setServerTelemetry' - package: '@azure/msal-common' - summary: set server telemetry entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setServerTelemetry(serverTelemetryKey: string, serverTelemetry: - ServerTelemetryEntity) - parameters: - - id: serverTelemetryKey - type: string - description: '' - - id: serverTelemetry - type: - description: |+ - - - name: 'setThrottlingCache(string, ThrottlingEntity)' - uid: '@azure/msal-common.ICacheManager.setThrottlingCache' - package: '@azure/msal-common' - summary: set throttling entity to the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function setThrottlingCache(throttlingCacheKey: string, throttlingCache: - ThrottlingEntity) - parameters: - - id: throttlingCacheKey - type: string - description: '' - - id: throttlingCache - type: - description: |+ - diff --git a/msal/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml b/msal/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml index a814e0e..9e48b36 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ICachePlugin.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml b/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml index de9db47..d557426 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ICrypto.yml +++ b/msal/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,15 +13,13 @@ methods: package: '@azure/msal-common' summary: base64 decode string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Decode(input: string): string' parameters: - id: input type: string - description: |+ - + description: '' return: description: '' type: string @@ -31,15 +28,28 @@ methods: package: '@azure/msal-common' summary: base64 Encode string remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Encode(input: string): string' parameters: - id: input type: string - description: |+ - + description: '' + 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 @@ -48,7 +58,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,33 +69,32 @@ methods: package: '@azure/msal-common' summary: Creates a guid randomly. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function createNewGuid(): string' return: description: '' type: string - - name: generatePkceCodes() - uid: '@azure/msal-common.ICrypto.generatePkceCodes' + - name: encodeKid(string) + uid: '@azure/msal-common.ICrypto.encodeKid' package: '@azure/msal-common' - summary: >- - Generate PKCE codes for OAuth. See RFC here: - https://tools.ietf.org/html/rfc7636 + summary: Stringifies and base64Url encodes input public key remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function generatePkceCodes(): Promise' + content: 'function encodeKid(inputKid: string): string' + parameters: + - id: inputKid + type: string + description: '' return: - description: '' - type: Promise<> + description: Base64Url encoded public key + type: string - name: getPublicKeyThumbprint(SignedHttpRequestParameters) uid: '@azure/msal-common.ICrypto.getPublicKeyThumbprint' package: '@azure/msal-common' summary: Generates an JWK RSA S256 Thumbprint remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -95,8 +103,7 @@ methods: parameters: - id: request type: - description: |+ - + description: '' return: description: '' type: Promise<string> @@ -105,15 +112,13 @@ 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' parameters: - id: plainText type: string - description: |+ - + description: '' return: description: '' type: Promise<string> @@ -122,31 +127,28 @@ 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' parameters: - id: kid type: string - description: |+ - + description: '' return: description: '' type: Promise<boolean> - - name: 'signJwt(SignedHttpRequest, string, string)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- - function signJwt(payload: SignedHttpRequest, kid: string, - correlationId?: string): Promise + function signJwt(payload: SignedHttpRequest, kid: string, shrOptions?: + ShrOptions, correlationId?: string): Promise parameters: - id: payload type: @@ -154,6 +156,9 @@ methods: - id: kid type: string description: '' + - id: shrOptions + type: + description: '' - id: correlationId type: string description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml b/msal/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml index 93088bc..89b9afe 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/IGuidGenerator.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml b/msal/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml index 6bb7d14..08f46ed 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ILoggerCallback.yml @@ -2,9 +2,8 @@ name: ILoggerCallback uid: '@azure/msal-common.ILoggerCallback' package: '@azure/msal-common' -summary: Callback to send the messages to. +summary: '' fullName: ILoggerCallback remarks: '' -isPreview: false isDeprecated: false type: interface diff --git a/msal/docs-ref-autogen/@azure/msal-common/IMDSBadResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/IMDSBadResponse.yml deleted file mode 100644 index bd235a6..0000000 --- a/msal/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/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 index 51eff0d..af2f043 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml @@ -5,24 +5,21 @@ package: '@azure/msal-common' summary: Client network interface to send backend requests. fullName: INetworkModule remarks: '' -isPreview: false isDeprecated: false type: interface methods: - - name: 'sendGetRequestAsync(string, NetworkRequestOptions, number)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- function sendGetRequestAsync(url: string, options?: - NetworkRequestOptions, cancellationToken?: number): - Promise> + NetworkRequestOptions, timeout?: number): Promise> parameters: - id: url type: string @@ -30,7 +27,7 @@ methods: - id: options type: description: '' - - id: cancellationToken + - id: timeout type: number description: '' return: @@ -38,14 +35,13 @@ methods: type: >- Promise<<T>> - - name: 'sendPostRequestAsync(string, NetworkRequestOptions)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- diff --git a/msal/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml index 1cd5a60..7a2f392 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/IPerformanceClient.yml @@ -5,16 +5,31 @@ package: '@azure/msal-common' summary: '' fullName: IPerformanceClient remarks: '' -isPreview: false 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -27,30 +42,54 @@ methods: return: description: '' type: string - - name: 'addStaticFields(StaticFields, string)' - uid: '@azure/msal-common.IPerformanceClient.addStaticFields' + - name: addQueueMeasurement(string, string, number, boolean) + uid: '@azure/msal-common.IPerformanceClient.addQueueMeasurement' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function addStaticFields(staticFields: StaticFields, correlationId: - string) + function addQueueMeasurement(eventName: string, correlationId?: string, + queueTime?: number, manuallyCompleted?: boolean) parameters: - - id: staticFields - type: + - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function discardMeasurements(correlationId: string)' @@ -58,18 +97,17 @@ methods: - id: correlationId type: string description: '' - - name: 'emitEvents(PerformanceEvent[], string)' + - name: emitEvents(PerformanceEvent[], string) uid: '@azure/msal-common.IPerformanceClient.emitEvents' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function emitEvents(events: PerformanceEvent[], correlationId: string)' parameters: - id: events - type: '[]' + type: [] description: '' - id: correlationId type: string @@ -79,55 +117,51 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function endMeasurement(event: PerformanceEvent): PerformanceEvent | - null + function endMeasurement(event: PerformanceEvent): null | + PerformanceEvent parameters: - id: event type: description: '' 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: '' + type: null | - name: generateId() uid: '@azure/msal-common.IPerformanceClient.generateId' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false 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: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -138,20 +172,34 @@ methods: return: description: '' type: boolean - - name: 'startMeasurement(PerformanceEvents, string)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- - function startMeasurement(measureName: PerformanceEvents, - correlationId?: string): InProgressPerformanceEvent + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent parameters: - id: measureName - type: + type: string description: '' - id: correlationId type: string @@ -159,17 +207,17 @@ methods: return: description: '' type: - - name: 'startPerformanceMeasuremeant(string, string)' - uid: '@azure/msal-common.IPerformanceClient.startPerformanceMeasuremeant' + - name: startPerformanceMeasurement(string, string) + uid: '@azure/msal-common.IPerformanceClient.startPerformanceMeasurement' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: This method will be removed in the next major version syntax: content: >- - function startPerformanceMeasuremeant(measureName: string, - correlationId: string): IPerformanceMeasurement + function startPerformanceMeasurement(measureName: string, correlationId: + string): IPerformanceMeasurement parameters: - id: measureName type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml b/msal/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml index 72bee72..c8c58ea 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/IPerformanceMeasurement.yml +++ b/msal/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,19 +21,17 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function flushMeasurement(): number | null' + content: 'function flushMeasurement(): null | number' return: description: '' - type: number | null + type: null | number - name: startMeasurement() uid: '@azure/msal-common.IPerformanceMeasurement.startMeasurement' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false 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 index 1740dfe..eb45cbc 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ISerializableTokenCache.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-common/IUri.yml b/msal/docs-ref-autogen/@azure/msal-common/IUri.yml index c7fe7a7..142c13e 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/IUri.yml +++ b/msal/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,20 +50,18 @@ properties: summary: '' fullName: PathSegments remarks: '' - isPreview: false isDeprecated: false syntax: content: 'PathSegments: string[]' return: description: '' - type: 'string[]' + type: string[] - name: Protocol uid: '@azure/msal-common.IUri.Protocol' package: '@azure/msal-common' 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/msal/docs-ref-autogen/@azure/msal-common/IdTokenCache.yml b/msal/docs-ref-autogen/@azure/msal-common/IdTokenCache.yml deleted file mode 100644 index 50bb81c..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/IdTokenCache.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: IdTokenCache -uid: '@azure/msal-common.IdTokenCache' -package: '@azure/msal-common' -summary: '' -fullName: IdTokenCache -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type IdTokenCache = Record diff --git a/msal/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml index 84d8406..868e304 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/IdTokenEntity.yml @@ -1,417 +1,10 @@ -### YamlMime:TSType +### YamlMime:TSTypeAlias name: IdTokenEntity uid: '@azure/msal-common.IdTokenEntity' package: '@azure/msal-common' -summary: | - ID_TOKEN Cache - Key:Value Schema: - - Key Example: uid.utid-login.microsoftonline.com-idtoken-clientId-contoso.com- - - Value Schema: - { - homeAccountId: home account identifier for the auth scheme, - environment: entity that issued the token, represented as a full host - credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other - clientId: client ID of the application - secret: Actual credential as a string - realm: Full tenant or organizational identifier that the account belongs to - } +summary: Id Token Cache Type fullName: IdTokenEntity remarks: '' -isPreview: false isDeprecated: false -type: class -properties: - - name: realm - uid: '@azure/msal-common.IdTokenEntity.realm' - package: '@azure/msal-common' - summary: '' - fullName: realm - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'realm: string' - return: - description: '' - type: string -inheritedProperties: - - name: clientId - uid: '@azure/msal-common.IdTokenEntity.clientId' - package: '@azure/msal-common' - summary: '' - fullName: clientId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clientId: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.clientId](xref:@azure/msal-common.CredentialEntity.clientId) - - name: credentialType - uid: '@azure/msal-common.IdTokenEntity.credentialType' - package: '@azure/msal-common' - summary: '' - fullName: credentialType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'credentialType: CredentialType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [CredentialEntity.credentialType](xref:@azure/msal-common.CredentialEntity.credentialType) - - name: environment - uid: '@azure/msal-common.IdTokenEntity.environment' - package: '@azure/msal-common' - summary: '' - fullName: environment - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'environment: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.environment](xref:@azure/msal-common.CredentialEntity.environment) - - name: familyId - uid: '@azure/msal-common.IdTokenEntity.familyId' - package: '@azure/msal-common' - summary: '' - fullName: familyId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'familyId?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.familyId](xref:@azure/msal-common.CredentialEntity.familyId) - - name: homeAccountId - uid: '@azure/msal-common.IdTokenEntity.homeAccountId' - package: '@azure/msal-common' - summary: '' - fullName: homeAccountId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'homeAccountId: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.homeAccountId](xref:@azure/msal-common.CredentialEntity.homeAccountId) - - name: keyId - uid: '@azure/msal-common.IdTokenEntity.keyId' - package: '@azure/msal-common' - summary: '' - fullName: keyId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'keyId?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.keyId](xref:@azure/msal-common.CredentialEntity.keyId) - - name: requestedClaimsHash - uid: '@azure/msal-common.IdTokenEntity.requestedClaimsHash' - package: '@azure/msal-common' - summary: '' - fullName: requestedClaimsHash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'requestedClaimsHash?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.requestedClaimsHash](xref:@azure/msal-common.CredentialEntity.requestedClaimsHash) - - name: secret - uid: '@azure/msal-common.IdTokenEntity.secret' - package: '@azure/msal-common' - summary: '' - fullName: secret - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'secret: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.secret](xref:@azure/msal-common.CredentialEntity.secret) - - name: target - uid: '@azure/msal-common.IdTokenEntity.target' - package: '@azure/msal-common' - summary: '' - fullName: target - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'target?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.target](xref:@azure/msal-common.CredentialEntity.target) - - name: tokenType - uid: '@azure/msal-common.IdTokenEntity.tokenType' - package: '@azure/msal-common' - summary: '' - fullName: tokenType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tokenType?: AuthenticationScheme' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [CredentialEntity.tokenType](xref:@azure/msal-common.CredentialEntity.tokenType) - - name: userAssertionHash - uid: '@azure/msal-common.IdTokenEntity.userAssertionHash' - package: '@azure/msal-common' - summary: '' - fullName: userAssertionHash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userAssertionHash?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.userAssertionHash](xref:@azure/msal-common.CredentialEntity.userAssertionHash) -inheritedMethods: - - name: generateAccountId() - uid: '@azure/msal-common.IdTokenEntity.generateAccountId' - package: '@azure/msal-common' - summary: >- - Generate Account Id key component as per the schema: - - - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateAccountId(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateAccountId](xref:@azure/msal-common.CredentialEntity.generateAccountId) - - name: >- - generateCredentialCacheKey(string, string, CredentialType, string, string, - string, string, AuthenticationScheme, string) - uid: '@azure/msal-common.IdTokenEntity.generateCredentialCacheKey' - package: '@azure/msal-common' - summary: >- - generates credential key - - -\----- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateCredentialCacheKey(homeAccountId: string, - environment: string, credentialType: CredentialType, clientId: string, - realm?: string, target?: string, familyId?: string, tokenType?: - AuthenticationScheme, requestedClaimsHash?: string): string - parameters: - - id: homeAccountId - type: string - description: '' - - id: environment - type: string - description: '' - - id: credentialType - type: - description: '' - - id: clientId - type: string - description: '' - - id: realm - type: string - description: '' - - id: target - type: string - description: '' - - id: familyId - type: string - description: '' - - id: tokenType - type: - description: '' - - id: requestedClaimsHash - type: string - description: '' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateCredentialCacheKey](xref:@azure/msal-common.CredentialEntity.generateCredentialCacheKey) - - name: generateCredentialId() - uid: '@azure/msal-common.IdTokenEntity.generateCredentialId' - package: '@azure/msal-common' - summary: >- - Generate Credential Id key component as per the schema: - -- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCredentialId(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateCredentialId](xref:@azure/msal-common.CredentialEntity.generateCredentialId) - - name: generateCredentialKey() - uid: '@azure/msal-common.IdTokenEntity.generateCredentialKey' - package: '@azure/msal-common' - summary: generates credential key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCredentialKey(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateCredentialKey](xref:@azure/msal-common.CredentialEntity.generateCredentialKey) - - name: generateTarget() - uid: '@azure/msal-common.IdTokenEntity.generateTarget' - package: '@azure/msal-common' - summary: 'Generate target key component as per schema: ' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateTarget(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateTarget](xref:@azure/msal-common.CredentialEntity.generateTarget) - - name: generateType() - uid: '@azure/msal-common.IdTokenEntity.generateType' - 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' - return: - description: '' - type: number - 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: '' - isPreview: false - 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' - package: '@azure/msal-common' - summary: Create IdTokenEntity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static 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: isIdTokenEntity(object) - uid: '@azure/msal-common.IdTokenEntity.isIdTokenEntity' - 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' - parameters: - - id: entity - type: object - description: |+ - - return: - description: '' - type: boolean -extends: +syntax: | + type IdTokenEntity = CredentialEntity & { realm: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ImdsOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/ImdsOptions.yml deleted file mode 100644 index 9e6878c..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml index 9e90aa5..8d4ea8d 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/InProgressPerformanceEvent.yml @@ -5,16 +5,16 @@ package: '@azure/msal-common' summary: '' fullName: InProgressPerformanceEvent remarks: '' -isPreview: false isDeprecated: false syntax: | type InProgressPerformanceEvent = { - addStaticFields: (staticFields: StaticFields) => void, - discardMeasurement: () => void, - endMeasurement: ( - event?: Partial - ) => PerformanceEvent | null, - event: PerformanceEvent, - flushMeasurement: () => void, - measurement: IPerformanceMeasurement, + 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 index cf79796..be50005 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/InteractionRequiredAuthError.yml +++ b/msal/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, 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, errorNo?: string) parameters: - id: errorCode type: string @@ -30,6 +31,87 @@ 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: '' + - id: errorNo + 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: 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' + 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 +119,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -53,7 +134,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -69,7 +149,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -85,49 +164,84 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.message + 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: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.name + 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: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.stack + 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: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -138,53 +252,31 @@ inheritedProperties: Inherited From [AuthError.subError](xref:@azure/msal-common.AuthError.subError) inheritedMethods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-common.InteractionRequiredAuthError.createPostRequestFailed' + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.InteractionRequiredAuthError.captureStackTrace' package: '@azure/msal-common' - summary: Creates an error for post request failures. + summary: Create .stack property on a target object remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) parameters: - - id: errDesc - type: string + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [AuthError.createPostRequestFailed](xref:@azure/msal-common.AuthError.createPostRequestFailed) - - name: createUnexpectedError(string) - uid: '@azure/msal-common.InteractionRequiredAuthError.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) + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-common.InteractionRequiredAuthError.setCorrelationId' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -195,64 +287,4 @@ inheritedMethods: inheritanceDescription: >- Inherited From [AuthError.setCorrelationId](xref:@azure/msal-common.AuthError.setCorrelationId) -methods: - - name: createNativeAccountUnavailableError() - uid: >- - @azure/msal-common.InteractionRequiredAuthError.createNativeAccountUnavailableError - package: '@azure/msal-common' - summary: >- - Creates an error thrown when the native broker returns ACCOUNT_UNAVAILABLE - status, indicating that the account was removed and interactive sign-in is - required - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNativeAccountUnavailableError(): - InteractionRequiredAuthError - return: - description: '' - type: - - name: createNoTokensFoundError() - uid: '@azure/msal-common.InteractionRequiredAuthError.createNoTokensFoundError' - package: '@azure/msal-common' - summary: >- - 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' - return: - description: '' - type: - - name: 'isInteractionRequiredError(string, string, string)' - uid: '@azure/msal-common.InteractionRequiredAuthError.isInteractionRequiredError' - package: '@azure/msal-common' - summary: >- - Helper function used to determine if an error thrown by the server - requires interaction to resolve - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function isInteractionRequiredError(errorCode?: string, - errorString?: string, subError?: string): boolean - parameters: - - id: errorCode - type: string - description: '' - - id: errorString - type: string - description: '' - - id: subError - type: string - description: |+ - - return: - description: '' - type: boolean 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/JoseHeader.yml b/msal/docs-ref-autogen/@azure/msal-common/JoseHeader.yml deleted file mode 100644 index 0ed17c5..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/JoseHeader.yml +++ /dev/null @@ -1,91 +0,0 @@ -### YamlMime:TSType -name: JoseHeader -uid: '@azure/msal-common.JoseHeader' -package: '@azure/msal-common' -summary: '' -fullName: JoseHeader -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: JoseHeader(JoseHeaderOptions) - uid: '@azure/msal-common.JoseHeader.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new JoseHeader(options: JoseHeaderOptions)' - parameters: - - id: options - type: - description: '' -properties: - - name: alg - uid: '@azure/msal-common.JoseHeader.alg' - package: '@azure/msal-common' - summary: '' - fullName: alg - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'alg?: string' - return: - description: '' - type: string - - name: kid - uid: '@azure/msal-common.JoseHeader.kid' - package: '@azure/msal-common' - summary: '' - fullName: kid - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'kid?: string' - return: - description: '' - type: string - - name: typ - uid: '@azure/msal-common.JoseHeader.typ' - package: '@azure/msal-common' - summary: '' - fullName: typ - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'typ?: JsonTypes' - return: - description: '' - type: -methods: - - name: getShrHeaderString(JoseHeaderOptions) - uid: '@azure/msal-common.JoseHeader.getShrHeaderString' - package: '@azure/msal-common' - summary: >- - Builds SignedHttpRequest formatted JOSE Header from the - - JOSE Header options provided or previously set on the object and returns - - the stringified header object. - - Throws if keyId or algorithm aren't provided since they are required for - Access Token Binding. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function getShrHeaderString(shrHeaderOptions: JoseHeaderOptions): - string - parameters: - - id: shrHeaderOptions - type: - description: '' - return: - description: '' - type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/JoseHeaderOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/JoseHeaderOptions.yml deleted file mode 100644 index d8898f1..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/JoseHeaderOptions.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: JoseHeaderOptions -uid: '@azure/msal-common.JoseHeaderOptions' -package: '@azure/msal-common' -summary: '' -fullName: JoseHeaderOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type JoseHeaderOptions = { alg?: string, kid?: string, typ?: JsonTypes } diff --git a/msal/docs-ref-autogen/@azure/msal-common/JsonTypes.yml b/msal/docs-ref-autogen/@azure/msal-common/JsonTypes.yml deleted file mode 100644 index a465a41..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/JsonTypes.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: JsonTypes -uid: '@azure/msal-common.JsonTypes' -package: '@azure/msal-common' -summary: '' -fullName: JsonTypes -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: Jwk - uid: '@azure/msal-common.JsonTypes.Jwk' - package: '@azure/msal-common' - summary: '' - - name: Jwt - uid: '@azure/msal-common.JsonTypes.Jwt' - 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/KeyLocation.yml b/msal/docs-ref-autogen/@azure/msal-common/KeyLocation.yml deleted file mode 100644 index 39fe5c5..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/KeyLocation.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: KeyLocation -uid: '@azure/msal-common.KeyLocation' -package: '@azure/msal-common' -summary: '' -fullName: KeyLocation -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: SW - uid: '@azure/msal-common.KeyLocation.SW' - package: '@azure/msal-common' - summary: '' - - name: UHW - uid: '@azure/msal-common.KeyLocation.UHW' - package: '@azure/msal-common' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/LibraryInfo.yml b/msal/docs-ref-autogen/@azure/msal-common/LibraryInfo.yml deleted file mode 100644 index 83f7db5..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/LibraryInfo.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: LibraryInfo -uid: '@azure/msal-common.LibraryInfo' -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/msal/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml b/msal/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml index e67af40..38760f9 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/LibraryStateObject.yml +++ b/msal/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 } + 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 index 1327f33..5e2c3c3 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/LogLevel.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-common/Logger.yml b/msal/docs-ref-autogen/@azure/msal-common/Logger.yml index 2d12a5f..9c3741e 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/Logger.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/Logger.yml @@ -5,16 +5,14 @@ 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: - - name: 'Logger(LoggerOptions, string, string)' + - name: Logger(LoggerOptions, string, string) uid: '@azure/msal-common.Logger.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -31,12 +29,11 @@ constructors: type: string description: '' methods: - - name: 'clone(string, string, string)' + - name: clone(string, string, string) uid: '@azure/msal-common.Logger.clone' package: '@azure/msal-common' summary: Create new Logger with existing configurations. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -55,12 +52,11 @@ methods: return: description: '' type: - - name: 'error(string, string)' + - name: error(string, string) uid: '@azure/msal-common.Logger.error' package: '@azure/msal-common' summary: Logs error messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function error(message: string, correlationId?: string)' @@ -71,12 +67,11 @@ methods: - id: correlationId type: string description: '' - - name: 'errorPii(string, string)' + - name: errorPii(string, string) uid: '@azure/msal-common.Logger.errorPii' package: '@azure/msal-common' summary: Logs error messages with PII. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function errorPii(message: string, correlationId?: string)' @@ -87,12 +82,11 @@ methods: - id: correlationId type: string description: '' - - name: 'executeCallback(LogLevel, string, boolean)' + - name: executeCallback(LogLevel, string, boolean) uid: '@azure/msal-common.Logger.executeCallback' package: '@azure/msal-common' summary: Execute callback with message. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -108,12 +102,11 @@ methods: - id: containsPii type: boolean description: '' - - name: 'info(string, string)' + - name: info(string, string) uid: '@azure/msal-common.Logger.info' package: '@azure/msal-common' summary: Logs info messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function info(message: string, correlationId?: string)' @@ -124,12 +117,11 @@ methods: - id: correlationId type: string description: '' - - name: 'infoPii(string, string)' + - name: infoPii(string, string) uid: '@azure/msal-common.Logger.infoPii' package: '@azure/msal-common' summary: Logs info messages with PII. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function infoPii(message: string, correlationId?: string)' @@ -145,19 +137,17 @@ methods: package: '@azure/msal-common' summary: Returns whether PII Logging is enabled or not. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function isPiiLoggingEnabled(): boolean' return: description: '' type: boolean - - name: 'trace(string, string)' + - name: trace(string, string) uid: '@azure/msal-common.Logger.trace' package: '@azure/msal-common' summary: Logs trace messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function trace(message: string, correlationId?: string)' @@ -168,12 +158,11 @@ methods: - id: correlationId type: string description: '' - - name: 'tracePii(string, string)' + - name: tracePii(string, string) uid: '@azure/msal-common.Logger.tracePii' package: '@azure/msal-common' summary: Logs trace messages with PII. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function tracePii(message: string, correlationId?: string)' @@ -184,12 +173,11 @@ methods: - id: correlationId type: string description: '' - - name: 'verbose(string, string)' + - name: verbose(string, string) uid: '@azure/msal-common.Logger.verbose' package: '@azure/msal-common' summary: Logs verbose messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function verbose(message: string, correlationId?: string)' @@ -200,12 +188,11 @@ methods: - id: correlationId type: string description: '' - - name: 'verbosePii(string, string)' + - name: verbosePii(string, string) uid: '@azure/msal-common.Logger.verbosePii' package: '@azure/msal-common' summary: Logs verbose messages with PII. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function verbosePii(message: string, correlationId?: string)' @@ -216,12 +203,11 @@ methods: - id: correlationId type: string description: '' - - name: 'warning(string, string)' + - name: warning(string, string) uid: '@azure/msal-common.Logger.warning' package: '@azure/msal-common' summary: Logs warning messages. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function warning(message: string, correlationId?: string)' @@ -232,12 +218,11 @@ methods: - id: correlationId type: string description: '' - - name: 'warningPii(string, string)' + - name: warningPii(string, string) uid: '@azure/msal-common.Logger.warningPii' 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/msal/docs-ref-autogen/@azure/msal-common/LoggerMessageOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/LoggerMessageOptions.yml deleted file mode 100644 index f02a1b6..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/LoggerMessageOptions.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: LoggerMessageOptions -uid: '@azure/msal-common.LoggerMessageOptions' -package: '@azure/msal-common' -summary: Options for logger messages. -fullName: LoggerMessageOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type LoggerMessageOptions = { - containsPii?: boolean, - context?: string, - correlationId?: string, - logLevel: LogLevel, - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml index 6d95d83..06d4f7a 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/LoggerOptions.yml @@ -2,20 +2,25 @@ name: LoggerOptions uid: '@azure/msal-common.LoggerOptions' package: '@azure/msal-common' -summary: |2 - Use this to configure the logging that MSAL does, by configuring logger options in the Configuration object +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: '' -isPreview: false isDeprecated: false syntax: | type LoggerOptions = { - correlationId?: string, - logLevel?: LogLevel, - loggerCallback?: ILoggerCallback, - piiLoggingEnabled?: boolean, + 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/JoseHeaderError.yml b/msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml similarity index 52% rename from msal/docs-ref-autogen/@azure/msal-common/JoseHeaderError.yml rename to msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml index 6c725e8..7ea5f1e 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/JoseHeaderError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/NetworkError.yml @@ -1,38 +1,77 @@ ### YamlMime:TSType -name: JoseHeaderError -uid: '@azure/msal-common.JoseHeaderError' +name: NetworkError +uid: '@azure/msal-common.NetworkError' package: '@azure/msal-common' -summary: Error thrown when there is an error in the client code running on the browser. -fullName: JoseHeaderError +summary: Represents network related errors +fullName: NetworkError remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'JoseHeaderError(string, string)' - uid: '@azure/msal-common.JoseHeaderError.constructor' + - name: NetworkError(AuthError, number, Record) + uid: '@azure/msal-common.NetworkError.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new JoseHeaderError(errorCode: string, errorMessage?: string)' + content: >- + new NetworkError(error: AuthError, httpStatus?: number, + responseHeaders?: Record) parameters: - - id: errorCode - type: string + - id: error + type: description: '' - - id: errorMessage - type: string + - 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.JoseHeaderError.correlationId' + uid: '@azure/msal-common.NetworkError.correlationId' package: '@azure/msal-common' summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -43,12 +82,11 @@ inheritedProperties: Inherited From [AuthError.correlationId](xref:@azure/msal-common.AuthError.correlationId) - name: errorCode - uid: '@azure/msal-common.JoseHeaderError.errorCode' + uid: '@azure/msal-common.NetworkError.errorCode' package: '@azure/msal-common' summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -59,12 +97,11 @@ inheritedProperties: Inherited From [AuthError.errorCode](xref:@azure/msal-common.AuthError.errorCode) - name: errorMessage - uid: '@azure/msal-common.JoseHeaderError.errorMessage' + uid: '@azure/msal-common.NetworkError.errorMessage' package: '@azure/msal-common' summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -75,111 +112,124 @@ inheritedProperties: Inherited From [AuthError.errorMessage](xref:@azure/msal-common.AuthError.errorMessage) - name: message - uid: '@azure/msal-common.JoseHeaderError.message' + uid: '@azure/msal-common.NetworkError.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 + inheritanceDescription: >- + Inherited From + [AuthError.message](xref:@azure/msal-common.AuthError.message) - name: name - uid: '@azure/msal-common.JoseHeaderError.name' + uid: '@azure/msal-common.NetworkError.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 + 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.JoseHeaderError.stack' + uid: '@azure/msal-common.NetworkError.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' + inheritanceDescription: >- + Inherited From + [AuthError.stack](xref:@azure/msal-common.AuthError.stack) + - name: stackTraceLimit + uid: '@azure/msal-common.NetworkError.stackTraceLimit' package: '@azure/msal-common' - summary: Describes the subclass of an error - fullName: subError + summary: '' + fullName: stackTraceLimit remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'subError: string' + content: 'static stackTraceLimit: number' return: description: '' - type: string + type: number inheritanceDescription: >- Inherited From - [AuthError.subError](xref:@azure/msal-common.AuthError.subError) -inheritedMethods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-common.JoseHeaderError.createPostRequestFailed' + [AuthError.stackTraceLimit](xref:@azure/msal-common.AuthError.stackTraceLimit) + - name: subError + uid: '@azure/msal-common.NetworkError.subError' package: '@azure/msal-common' - summary: Creates an error for post request failures. + summary: Describes the subclass of an error + fullName: subError remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' + content: 'subError: string' return: description: '' - type: + type: string inheritanceDescription: >- Inherited From - [AuthError.createPostRequestFailed](xref:@azure/msal-common.AuthError.createPostRequestFailed) - - name: createUnexpectedError(string) - uid: '@azure/msal-common.JoseHeaderError.createUnexpectedError' + [AuthError.subError](xref:@azure/msal-common.AuthError.subError) +inheritedMethods: + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.NetworkError.captureStackTrace' package: '@azure/msal-common' - summary: >- - Creates an error that is thrown when something unexpected happens in the - library. + summary: Create .stack property on a target object remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createUnexpectedError(errDesc: string): AuthError' + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) parameters: - - id: errDesc - type: string - description: |+ - - return: - description: '' - type: + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function + description: '' inheritanceDescription: >- Inherited From - [AuthError.createUnexpectedError](xref:@azure/msal-common.AuthError.createUnexpectedError) + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) - name: setCorrelationId(string) - uid: '@azure/msal-common.JoseHeaderError.setCorrelationId' + uid: '@azure/msal-common.NetworkError.setCorrelationId' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' @@ -190,29 +240,4 @@ inheritedMethods: 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/msal/docs-ref-autogen/@azure/msal-common/NetworkManager.yml b/msal/docs-ref-autogen/@azure/msal-common/NetworkManager.yml deleted file mode 100644 index 2a13b9a..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/NetworkManager.yml +++ /dev/null @@ -1,58 +0,0 @@ -### YamlMime:TSType -name: NetworkManager -uid: '@azure/msal-common.NetworkManager' -package: '@azure/msal-common' -summary: '' -fullName: NetworkManager -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'NetworkManager(INetworkModule, CacheManager)' - uid: '@azure/msal-common.NetworkManager.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new NetworkManager(networkClient: INetworkModule, cacheManager: - CacheManager) - parameters: - - id: networkClient - type: - description: '' - - id: cacheManager - type: - description: '' -methods: - - name: 'sendPostRequest(RequestThumbprint, string, NetworkRequestOptions)' - uid: '@azure/msal-common.NetworkManager.sendPostRequest' - package: '@azure/msal-common' - summary: Wraps sendPostRequestAsync with necessary preflight and postflight logic - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function sendPostRequest(thumbprint: RequestThumbprint, - tokenEndpoint: string, options: NetworkRequestOptions): - Promise> - parameters: - - id: thumbprint - type: - description: '' - - id: tokenEndpoint - type: string - description: '' - - id: options - type: - description: |+ - - return: - description: '' - type: >- - Promise<<T>> diff --git a/msal/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml index d6659af..b91366f 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/NetworkRequestOptions.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml index e1fec41..0f7f12c 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/NetworkResponse.yml @@ -5,11 +5,10 @@ package: '@azure/msal-common' summary: '' fullName: NetworkResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type NetworkResponse = { - body: T, - headers: Record, - status: number, + 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/OnBehalfOfClient.yml b/msal/docs-ref-autogen/@azure/msal-common/OnBehalfOfClient.yml deleted file mode 100644 index a630dfe..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/OnBehalfOfClient.yml +++ /dev/null @@ -1,100 +0,0 @@ -### YamlMime:TSType -name: OnBehalfOfClient -uid: '@azure/msal-common.OnBehalfOfClient' -package: '@azure/msal-common' -summary: On-Behalf-Of client -fullName: OnBehalfOfClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: OnBehalfOfClient(ClientConfiguration) - uid: '@azure/msal-common.OnBehalfOfClient.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new OnBehalfOfClient(configuration: ClientConfiguration)' - parameters: - - id: configuration - type: - description: '' -inheritedProperties: - - name: authority - uid: '@azure/msal-common.OnBehalfOfClient.authority' - package: '@azure/msal-common' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: Authority' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.authority](xref:@azure/msal-common.BaseClient.authority) - - name: logger - uid: '@azure/msal-common.OnBehalfOfClient.logger' - package: '@azure/msal-common' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) -inheritedMethods: - - name: updateAuthority(Authority) - uid: '@azure/msal-common.OnBehalfOfClient.updateAuthority' - package: '@azure/msal-common' - 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: - description: |+ - - inheritanceDescription: >- - Inherited From - [BaseClient.updateAuthority](xref:@azure/msal-common.BaseClient.updateAuthority) -methods: - - name: acquireToken(CommonOnBehalfOfRequest) - uid: '@azure/msal-common.OnBehalfOfClient.acquireToken' - package: '@azure/msal-common' - summary: Public API to acquire tokens with on behalf of flow - remarks: '' - isPreview: false - 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-common/OpenIdConfigResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/OpenIdConfigResponse.yml deleted file mode 100644 index c198e45..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/OpenIdConfigResponse.yml +++ /dev/null @@ -1,19 +0,0 @@ -### YamlMime:TSTypeAlias -name: OpenIdConfigResponse -uid: '@azure/msal-common.OpenIdConfigResponse' -package: '@azure/msal-common' -summary: >- - Tenant Discovery Response which contains the relevant OAuth endpoints and data - needed for authentication and authorization. -fullName: OpenIdConfigResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type OpenIdConfigResponse = { - authorization_endpoint: string, - end_session_endpoint?: string, - issuer: string, - jwks_uri: string, - token_endpoint: string, - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml b/msal/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml index cd990f5..1367a73 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PasswordGrantConstants.yml @@ -1,18 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: PasswordGrantConstants uid: '@azure/msal-common.PasswordGrantConstants' package: '@azure/msal-common' -summary: Password grant parameters +summary: '' fullName: PasswordGrantConstants remarks: '' -isPreview: false isDeprecated: false -fields: - - name: password - uid: '@azure/msal-common.PasswordGrantConstants.password' - package: '@azure/msal-common' - summary: '' - - name: username - uid: '@azure/msal-common.PasswordGrantConstants.username' - package: '@azure/msal-common' - summary: '' +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 index b58e95d..30a3d48 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceCallbackFunction.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml index e5c2ca2..8bad25b 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceClient.yml @@ -5,26 +5,25 @@ package: '@azure/msal-common' summary: '' fullName: PerformanceClient remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: >- PerformanceClient(string, string, Logger, string, string, - ApplicationTelemetry) + 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: '' - isPreview: false isDeprecated: false syntax: content: >- new PerformanceClient(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, - applicationTelemetry: ApplicationTelemetry) + applicationTelemetry: ApplicationTelemetry, intFields?: Set, + abbreviations?: Map) parameters: - id: clientId type: string @@ -40,18 +39,39 @@ constructors: description: Name of the library - id: libraryVersion type: string - description: | - Version of the library + description: Version of the library - id: applicationTelemetry type: - description: '' + 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -64,54 +84,84 @@ methods: return: description: '' type: string - - name: 'addStaticFields(StaticFields, string)' - uid: '@azure/msal-common.PerformanceClient.addStaticFields' + - name: addQueueMeasurement(string, string, number, boolean) + uid: '@azure/msal-common.PerformanceClient.addQueueMeasurement' package: '@azure/msal-common' - summary: Saves extra information to be emitted when the measurements are flushed + summary: >- + Adds queue measurement time to QueueMeasurements array for given + correlation ID. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function addStaticFields(fields: StaticFields, correlationId: string)' + content: >- + function addQueueMeasurement(eventName: string, correlationId?: string, + queueTime?: number, manuallyCompleted?: boolean) parameters: - - id: fields - type: + - id: eventName + type: string description: '' - id: correlationId type: string - description: |+ + 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. + summary: Removes measurements and aux data for a given correlation id. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function discardMeasurements(correlationId: string)' parameters: - id: correlationId type: string - description: |+ - - - name: 'emitEvents(PerformanceEvent[], string)' + description: '' + - name: emitEvents(PerformanceEvent[], string) uid: '@azure/msal-common.PerformanceClient.emitEvents' package: '@azure/msal-common' summary: Emits events to all registered callbacks. remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function emitEvents(events: PerformanceEvent[], correlationId: string)' + content: 'function emitEvents(events: PerformanceEvent[], correlationId?: string)' parameters: - id: events - type: '[]' + type: [] description: '' - id: correlationId type: string description: '' - - name: endMeasurement(PerformanceEvent) + - name: endMeasurement(PerformanceEvent, unknown) uid: '@azure/msal-common.PerformanceClient.endMeasurement' package: '@azure/msal-common' summary: >- @@ -119,59 +169,80 @@ 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, error?: unknown): null + | PerformanceEvent parameters: - id: event type: description: '' + - id: error + type: unknown + description: '' return: description: '' - type: | null - - name: 'flushMeasurements(PerformanceEvents, string)' - uid: '@azure/msal-common.PerformanceClient.flushMeasurements' + type: null | + - 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: getPreQueueTime(string, 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: string, correlationId: string): + number | void parameters: - - id: measureName - type: + - id: eventName + type: string description: '' - id: correlationId type: string - description: |+ - - - name: generateId() - uid: '@azure/msal-common.PerformanceClient.generateId' + description: '' + return: + description: '' + type: number | void + - name: 'incrementFields({[key: string]: number | undefined}, string)' + uid: '@azure/msal-common.PerformanceClient.incrementFields' 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 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: '' - isPreview: false isDeprecated: false syntax: content: 'function removePerformanceCallback(callbackId: string): boolean' @@ -182,22 +253,38 @@ methods: return: description: '' type: boolean - - name: 'startMeasurement(PerformanceEvents, string)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- - function startMeasurement(measureName: PerformanceEvents, - correlationId?: string): InProgressPerformanceEvent + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent parameters: - id: measureName - type: + type: string description: '' - id: correlationId type: string @@ -205,19 +292,22 @@ methods: return: description: '' type: - - name: 'startPerformanceMeasuremeant(string, string)' - uid: '@azure/msal-common.PerformanceClient.startPerformanceMeasuremeant' + - 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: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: This method will be removed in the next major version syntax: content: >- - function startPerformanceMeasuremeant(measureName: string, - correlationId: string): IPerformanceMeasurement + function startPerformanceMeasurement(measureName: string, correlationId: + string): IPerformanceMeasurement parameters: - id: measureName type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml index 43a4c1f..9af9625 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvent.yml @@ -7,26 +7,88 @@ 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 = { + accessTokenSize?: number + accountType?: "AAD" | "MSA" | "B2C" + allowPlatformBroker?: boolean + appName?: string + appVersion?: string + authority: string + awaitIframeCorrelationId?: string + cacheAtCount?: number + cacheIdCount?: number + cacheLookupPolicy?: number + cacheOutcome?: number + cacheRtCount?: number + clientId: string + contentLengthHeader?: string + contentTypeHeader?: string + context?: string + correlationId: string + domainHintFromRequest?: boolean + durationMs?: number + embeddedClientId?: string + embeddedRedirectUri?: string + endPageVisibility?: string | null + errorCode?: string + errorName?: string + errorStack?: string[] + eventId: string + extensionHandshakeTimedOut?: boolean + extensionHandshakeTimeoutMs?: number + extensionId?: string + extensionInstalled?: boolean + extensionVersion?: string + fromCache?: boolean | null + httpStatus?: number + httpVerToken?: string + 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 + 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 + 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 + subErrorCode?: string + success?: boolean | null + usePreGeneratedPkce?: boolean + visibilityChangeCount?: number } diff --git a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml index 3deafb5..5c9b729 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEventStatus.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml b/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml index 5f9f11a..2259d79 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PerformanceEvents.yml +++ b/msal/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,12 +37,38 @@ 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' 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). + 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' @@ -54,6 +83,72 @@ 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: 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: Base64Decode + uid: '@azure/msal-common.PerformanceEvents.Base64Decode' + package: '@azure/msal-common' + summary: '' - name: BaseClientCreateTokenRequestHeaders uid: '@azure/msal-common.PerformanceEvents.BaseClientCreateTokenRequestHeaders' package: '@azure/msal-common' @@ -64,6 +159,14 @@ fields: 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' @@ -78,12 +181,114 @@ 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' + summary: '' + - name: GenerateCodeVerifier + 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' + 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: 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' + 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: LocalStorageUpdated + uid: '@azure/msal-common.PerformanceEvents.LocalStorageUpdated' + package: '@azure/msal-common' + summary: '' + - 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' @@ -92,25 +297,109 @@ 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: 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' + 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' + 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: '' - 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: SetUserData + uid: '@azure/msal-common.PerformanceEvents.SetUserData' + 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' @@ -119,6 +408,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 +428,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 +447,30 @@ 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: UrlEncodeArr + uid: '@azure/msal-common.PerformanceEvents.UrlEncodeArr' + 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 index c16ad9c..47c2d0a 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/PersistentCacheKeys.yml @@ -1,38 +1,11 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: PersistentCacheKeys uid: '@azure/msal-common.PersistentCacheKeys' package: '@azure/msal-common' -summary: Persistent cache keys MSAL which stay while user is logged in. +summary: '' fullName: PersistentCacheKeys remarks: '' -isPreview: false isDeprecated: false -fields: - - name: ACTIVE_ACCOUNT - uid: '@azure/msal-common.PersistentCacheKeys.ACTIVE_ACCOUNT' - package: '@azure/msal-common' - summary: '' - - name: ACTIVE_ACCOUNT_FILTERS - uid: '@azure/msal-common.PersistentCacheKeys.ACTIVE_ACCOUNT_FILTERS' - package: '@azure/msal-common' - summary: '' - - name: ADAL_ID_TOKEN - uid: '@azure/msal-common.PersistentCacheKeys.ADAL_ID_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: CLIENT_INFO - uid: '@azure/msal-common.PersistentCacheKeys.CLIENT_INFO' - package: '@azure/msal-common' - summary: '' - - name: ERROR - uid: '@azure/msal-common.PersistentCacheKeys.ERROR' - package: '@azure/msal-common' - summary: '' - - name: ERROR_DESC - uid: '@azure/msal-common.PersistentCacheKeys.ERROR_DESC' - package: '@azure/msal-common' - summary: '' - - name: ID_TOKEN - uid: '@azure/msal-common.PersistentCacheKeys.ID_TOKEN' - package: '@azure/msal-common' - summary: '' +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 index 7de9a33..6d066e8 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/PkceCodes.yml +++ b/msal/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 } + type PkceCodes = { challenge: string; verifier: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/PopTokenGenerator.yml b/msal/docs-ref-autogen/@azure/msal-common/PopTokenGenerator.yml deleted file mode 100644 index adfddc4..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/PopTokenGenerator.yml +++ /dev/null @@ -1,117 +0,0 @@ -### YamlMime:TSType -name: PopTokenGenerator -uid: '@azure/msal-common.PopTokenGenerator' -package: '@azure/msal-common' -summary: '' -fullName: PopTokenGenerator -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: PopTokenGenerator(ICrypto) - uid: '@azure/msal-common.PopTokenGenerator.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new PopTokenGenerator(cryptoUtils: ICrypto)' - parameters: - - id: cryptoUtils - type: - description: '' -methods: - - name: generateCnf(SignedHttpRequestParameters) - uid: '@azure/msal-common.PopTokenGenerator.generateCnf' - package: '@azure/msal-common' - summary: >- - Generates the req_cnf validated at the RP in the POP protocol for SHR - parameters - - 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: >- - function generateCnf(request: SignedHttpRequestParameters): - Promise - parameters: - - id: request - type: - description: '' - return: - description: '' - type: Promise<> - - name: generateKid(SignedHttpRequestParameters) - uid: '@azure/msal-common.PopTokenGenerator.generateKid' - package: '@azure/msal-common' - summary: Generates key_id for a SHR token request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function generateKid(request: SignedHttpRequestParameters): - Promise - parameters: - - id: request - type: - description: '' - return: - description: '' - type: Promise<> - - name: 'signPayload(string, string, SignedHttpRequestParameters, object)' - uid: '@azure/msal-common.PopTokenGenerator.signPayload' - package: '@azure/msal-common' - summary: Utility function to generate the signed JWT for an access_token - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function signPayload(payload: string, keyId: string, request: - SignedHttpRequestParameters, claims?: object): Promise - parameters: - - id: payload - type: string - description: '' - - id: keyId - type: string - description: '' - - id: request - type: - description: '' - - id: claims - type: object - description: '' - return: - description: '' - type: Promise<string> - - name: 'signPopToken(string, string, SignedHttpRequestParameters)' - uid: '@azure/msal-common.PopTokenGenerator.signPopToken' - package: '@azure/msal-common' - summary: Signs the POP access_token with the local generated key-pair - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function signPopToken(accessToken: string, keyId: string, request: - SignedHttpRequestParameters): Promise - parameters: - - id: accessToken - type: string - description: '' - - id: keyId - type: string - description: '' - - id: request - type: - description: '' - return: - description: '' - type: Promise<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 index e71dbfa..1227cf3 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ProtocolMode.yml @@ -1,18 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: ProtocolMode uid: '@azure/msal-common.ProtocolMode' package: '@azure/msal-common' -summary: Protocol modes supported by MSAL. +summary: '' fullName: ProtocolMode remarks: '' -isPreview: false isDeprecated: false -fields: - - name: AAD - uid: '@azure/msal-common.ProtocolMode.AAD' - package: '@azure/msal-common' - summary: '' - - name: OIDC - uid: '@azure/msal-common.ProtocolMode.OIDC' - package: '@azure/msal-common' - summary: '' +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 index 0012bd8..7c00451 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ProtocolUtils.yml @@ -5,16 +5,14 @@ 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: - - name: 'generateLibraryState(ICrypto, Record)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -23,22 +21,20 @@ methods: parameters: - id: cryptoObj type: - description: |+ - + description: '' - id: meta - type: 'Record<string, string>' + type: Record<string, string> description: '' return: description: '' type: string - - name: 'parseRequestState(ICrypto, 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -47,20 +43,18 @@ methods: parameters: - id: cryptoObj type: - description: |+ - + description: '' - id: state type: string description: '' return: description: '' type: - - name: 'setRequestState(ICrypto, string, Record)' + - 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.' + summary: Appends user state with random guid, or returns random guid. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -74,7 +68,7 @@ methods: type: string description: '' - id: meta - type: 'Record<string, string>' + type: Record<string, string> description: '' return: description: '' 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/RefreshTokenCache.yml b/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenCache.yml deleted file mode 100644 index fa4abc0..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenCache.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: RefreshTokenCache -uid: '@azure/msal-common.RefreshTokenCache' -package: '@azure/msal-common' -summary: '' -fullName: RefreshTokenCache -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type RefreshTokenCache = Record diff --git a/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenClient.yml b/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenClient.yml deleted file mode 100644 index a88ad5b..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenClient.yml +++ /dev/null @@ -1,123 +0,0 @@ -### YamlMime:TSType -name: RefreshTokenClient -uid: '@azure/msal-common.RefreshTokenClient' -package: '@azure/msal-common' -summary: OAuth2.0 refresh token client -fullName: RefreshTokenClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'RefreshTokenClient(ClientConfiguration, IPerformanceClient)' - uid: '@azure/msal-common.RefreshTokenClient.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new RefreshTokenClient(configuration: ClientConfiguration, - performanceClient?: IPerformanceClient) - parameters: - - id: configuration - type: - description: '' - - id: performanceClient - type: - description: '' -inheritedProperties: - - name: authority - uid: '@azure/msal-common.RefreshTokenClient.authority' - package: '@azure/msal-common' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: Authority' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.authority](xref:@azure/msal-common.BaseClient.authority) - - name: logger - uid: '@azure/msal-common.RefreshTokenClient.logger' - package: '@azure/msal-common' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) -inheritedMethods: - - name: updateAuthority(Authority) - uid: '@azure/msal-common.RefreshTokenClient.updateAuthority' - package: '@azure/msal-common' - 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: - description: |+ - - inheritanceDescription: >- - Inherited From - [BaseClient.updateAuthority](xref:@azure/msal-common.BaseClient.updateAuthority) -methods: - - name: acquireToken(CommonRefreshTokenRequest) - uid: '@azure/msal-common.RefreshTokenClient.acquireToken' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: CommonRefreshTokenRequest): - Promise - parameters: - - id: request - type: - description: '' - return: - description: '' - type: Promise<> - - name: acquireTokenByRefreshToken(CommonSilentFlowRequest) - uid: '@azure/msal-common.RefreshTokenClient.acquireTokenByRefreshToken' - package: '@azure/msal-common' - summary: >- - Gets cached refresh token and attaches to request, then calls acquireToken - API - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireTokenByRefreshToken(request: CommonSilentFlowRequest): - Promise - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<> -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml b/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml index 3466e22..6aadc7a 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/RefreshTokenEntity.yml @@ -1,422 +1,10 @@ -### YamlMime:TSType +### YamlMime:TSTypeAlias name: RefreshTokenEntity uid: '@azure/msal-common.RefreshTokenEntity' package: '@azure/msal-common' -summary: | - REFRESH_TOKEN Cache - Key:Value Schema: - - Key Example: uid.utid-login.microsoftonline.com-refreshtoken-clientId-- - - Value: - { - homeAccountId: home account identifier for the auth scheme, - environment: entity that issued the token, represented as a full host - credentialType: Type of credential as a string, can be one of the following: RefreshToken, AccessToken, IdToken, Password, Cookie, Certificate, Other - clientId: client ID of the application - secret: Actual credential as a string - familyId: Family ID identifier, '1' represents Microsoft Family - realm: Full tenant or organizational identifier that the account belongs to - target: Permissions that are included in the token, or for refresh tokens, the resource identifier. - } +summary: Refresh Token Cache Type fullName: RefreshTokenEntity remarks: '' -isPreview: false isDeprecated: false -type: class -properties: - - name: familyId - uid: '@azure/msal-common.RefreshTokenEntity.familyId' - package: '@azure/msal-common' - summary: '' - fullName: familyId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'familyId?: string' - return: - description: '' - type: string -inheritedProperties: - - name: clientId - uid: '@azure/msal-common.RefreshTokenEntity.clientId' - package: '@azure/msal-common' - summary: '' - fullName: clientId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clientId: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.clientId](xref:@azure/msal-common.CredentialEntity.clientId) - - name: credentialType - uid: '@azure/msal-common.RefreshTokenEntity.credentialType' - package: '@azure/msal-common' - summary: '' - fullName: credentialType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'credentialType: CredentialType' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [CredentialEntity.credentialType](xref:@azure/msal-common.CredentialEntity.credentialType) - - name: environment - uid: '@azure/msal-common.RefreshTokenEntity.environment' - package: '@azure/msal-common' - summary: '' - fullName: environment - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'environment: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.environment](xref:@azure/msal-common.CredentialEntity.environment) - - name: homeAccountId - uid: '@azure/msal-common.RefreshTokenEntity.homeAccountId' - package: '@azure/msal-common' - summary: '' - fullName: homeAccountId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'homeAccountId: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.homeAccountId](xref:@azure/msal-common.CredentialEntity.homeAccountId) - - name: keyId - uid: '@azure/msal-common.RefreshTokenEntity.keyId' - package: '@azure/msal-common' - summary: '' - fullName: keyId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'keyId?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.keyId](xref:@azure/msal-common.CredentialEntity.keyId) - - name: realm - uid: '@azure/msal-common.RefreshTokenEntity.realm' - package: '@azure/msal-common' - summary: '' - fullName: realm - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'realm?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.realm](xref:@azure/msal-common.CredentialEntity.realm) - - name: requestedClaimsHash - uid: '@azure/msal-common.RefreshTokenEntity.requestedClaimsHash' - package: '@azure/msal-common' - summary: '' - fullName: requestedClaimsHash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'requestedClaimsHash?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.requestedClaimsHash](xref:@azure/msal-common.CredentialEntity.requestedClaimsHash) - - name: secret - uid: '@azure/msal-common.RefreshTokenEntity.secret' - package: '@azure/msal-common' - summary: '' - fullName: secret - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'secret: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.secret](xref:@azure/msal-common.CredentialEntity.secret) - - name: target - uid: '@azure/msal-common.RefreshTokenEntity.target' - package: '@azure/msal-common' - summary: '' - fullName: target - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'target?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.target](xref:@azure/msal-common.CredentialEntity.target) - - name: tokenType - uid: '@azure/msal-common.RefreshTokenEntity.tokenType' - package: '@azure/msal-common' - summary: '' - fullName: tokenType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tokenType?: AuthenticationScheme' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [CredentialEntity.tokenType](xref:@azure/msal-common.CredentialEntity.tokenType) - - name: userAssertionHash - uid: '@azure/msal-common.RefreshTokenEntity.userAssertionHash' - package: '@azure/msal-common' - summary: '' - fullName: userAssertionHash - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userAssertionHash?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.userAssertionHash](xref:@azure/msal-common.CredentialEntity.userAssertionHash) -inheritedMethods: - - name: generateAccountId() - uid: '@azure/msal-common.RefreshTokenEntity.generateAccountId' - package: '@azure/msal-common' - summary: >- - Generate Account Id key component as per the schema: - - - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateAccountId(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateAccountId](xref:@azure/msal-common.CredentialEntity.generateAccountId) - - name: >- - generateCredentialCacheKey(string, string, CredentialType, string, string, - string, string, AuthenticationScheme, string) - uid: '@azure/msal-common.RefreshTokenEntity.generateCredentialCacheKey' - package: '@azure/msal-common' - summary: >- - generates credential key - - -\----- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateCredentialCacheKey(homeAccountId: string, - environment: string, credentialType: CredentialType, clientId: string, - realm?: string, target?: string, familyId?: string, tokenType?: - AuthenticationScheme, requestedClaimsHash?: string): string - parameters: - - id: homeAccountId - type: string - description: '' - - id: environment - type: string - description: '' - - id: credentialType - type: - description: '' - - id: clientId - type: string - description: '' - - id: realm - type: string - description: '' - - id: target - type: string - description: '' - - id: familyId - type: string - description: '' - - id: tokenType - type: - description: '' - - id: requestedClaimsHash - type: string - description: '' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateCredentialCacheKey](xref:@azure/msal-common.CredentialEntity.generateCredentialCacheKey) - - name: generateCredentialId() - uid: '@azure/msal-common.RefreshTokenEntity.generateCredentialId' - package: '@azure/msal-common' - summary: >- - Generate Credential Id key component as per the schema: - -- - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCredentialId(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateCredentialId](xref:@azure/msal-common.CredentialEntity.generateCredentialId) - - name: generateCredentialKey() - uid: '@azure/msal-common.RefreshTokenEntity.generateCredentialKey' - package: '@azure/msal-common' - summary: generates credential key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCredentialKey(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateCredentialKey](xref:@azure/msal-common.CredentialEntity.generateCredentialKey) - - name: generateTarget() - uid: '@azure/msal-common.RefreshTokenEntity.generateTarget' - package: '@azure/msal-common' - summary: 'Generate target key component as per schema: ' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateTarget(): string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [CredentialEntity.generateTarget](xref:@azure/msal-common.CredentialEntity.generateTarget) - - name: generateType() - uid: '@azure/msal-common.RefreshTokenEntity.generateType' - 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' - return: - description: '' - type: number - 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: '' - isPreview: false - 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' - package: '@azure/msal-common' - summary: Create RefreshTokenEntity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createRefreshTokenEntity(homeAccountId: string, - environment: string, refreshToken: string, clientId: string, familyId?: - string, userAssertionHash?: string): 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: '' - return: - description: '' - type: - - name: isRefreshTokenEntity(object) - uid: '@azure/msal-common.RefreshTokenEntity.isRefreshTokenEntity' - 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' - parameters: - - id: entity - type: object - description: |+ - - return: - description: '' - type: boolean -extends: +syntax: | + type RefreshTokenEntity = CredentialEntity & { expiresOn?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/RegionDiscovery.yml b/msal/docs-ref-autogen/@azure/msal-common/RegionDiscovery.yml deleted file mode 100644 index cf35858..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-common/RegionDiscoveryMetadata.yml b/msal/docs-ref-autogen/@azure/msal-common/RegionDiscoveryMetadata.yml deleted file mode 100644 index 54bd869..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/RegionDiscoveryMetadata.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: RegionDiscoveryMetadata -uid: '@azure/msal-common.RegionDiscoveryMetadata' -package: '@azure/msal-common' -summary: '' -fullName: RegionDiscoveryMetadata -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type RegionDiscoveryMetadata = { - region_outcome?: RegionDiscoveryOutcomes, - region_source?: RegionDiscoverySources, - region_used?: string, - } diff --git a/msal/docs-ref-autogen/@azure/msal-common/RegionDiscoveryOutcomes.yml b/msal/docs-ref-autogen/@azure/msal-common/RegionDiscoveryOutcomes.yml deleted file mode 100644 index c8f34d8..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/RegionDiscoveryOutcomes.yml +++ /dev/null @@ -1,31 +0,0 @@ -### YamlMime:TSEnum -name: RegionDiscoveryOutcomes -uid: '@azure/msal-common.RegionDiscoveryOutcomes' -package: '@azure/msal-common' -summary: Region Discovery Outcomes -fullName: RegionDiscoveryOutcomes -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: AUTO_DETECTION_REQUESTED_FAILED - uid: '@azure/msal-common.RegionDiscoveryOutcomes.AUTO_DETECTION_REQUESTED_FAILED' - package: '@azure/msal-common' - summary: '' - - name: AUTO_DETECTION_REQUESTED_SUCCESSFUL - uid: >- - @azure/msal-common.RegionDiscoveryOutcomes.AUTO_DETECTION_REQUESTED_SUCCESSFUL - package: '@azure/msal-common' - summary: '' - - name: CONFIGURED_MATCHES_DETECTED - uid: '@azure/msal-common.RegionDiscoveryOutcomes.CONFIGURED_MATCHES_DETECTED' - package: '@azure/msal-common' - summary: '' - - name: CONFIGURED_NOT_DETECTED - uid: '@azure/msal-common.RegionDiscoveryOutcomes.CONFIGURED_NOT_DETECTED' - package: '@azure/msal-common' - summary: '' - - name: CONFIGURED_NO_AUTO_DETECTION - uid: '@azure/msal-common.RegionDiscoveryOutcomes.CONFIGURED_NO_AUTO_DETECTION' - package: '@azure/msal-common' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/RegionDiscoverySources.yml b/msal/docs-ref-autogen/@azure/msal-common/RegionDiscoverySources.yml deleted file mode 100644 index bd672d7..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/RegionDiscoverySources.yml +++ /dev/null @@ -1,26 +0,0 @@ -### YamlMime:TSEnum -name: RegionDiscoverySources -uid: '@azure/msal-common.RegionDiscoverySources' -package: '@azure/msal-common' -summary: Region Discovery Sources -fullName: RegionDiscoverySources -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: ENVIRONMENT_VARIABLE - uid: '@azure/msal-common.RegionDiscoverySources.ENVIRONMENT_VARIABLE' - package: '@azure/msal-common' - summary: '' - - name: FAILED_AUTO_DETECTION - uid: '@azure/msal-common.RegionDiscoverySources.FAILED_AUTO_DETECTION' - package: '@azure/msal-common' - summary: '' - - name: IMDS - uid: '@azure/msal-common.RegionDiscoverySources.IMDS' - package: '@azure/msal-common' - summary: '' - - name: INTERNAL_CACHE - uid: '@azure/msal-common.RegionDiscoverySources.INTERNAL_CACHE' - package: '@azure/msal-common' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ReqCnf.yml b/msal/docs-ref-autogen/@azure/msal-common/ReqCnf.yml deleted file mode 100644 index ce9c1f7..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ReqCnf.yml +++ /dev/null @@ -1,20 +0,0 @@ -### YamlMime:TSTypeAlias -name: ReqCnf -uid: '@azure/msal-common.ReqCnf' -package: '@azure/msal-common' -summary: >- - See eSTS docs for more info. - - - A kid element, with the value containing an RFC 7638-compliant JWK - thumbprint that is base64 encoded. - - - xms_ksl element, representing the storage location of the key's secret - component on the client device. One of two values: - - sw: software storage - - uhw: hardware storage -fullName: ReqCnf -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ReqCnf = { kid: string, xms_ksl: KeyLocation } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ReqCnfData.yml b/msal/docs-ref-autogen/@azure/msal-common/ReqCnfData.yml deleted file mode 100644 index 315d60d..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ReqCnfData.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: ReqCnfData -uid: '@azure/msal-common.ReqCnfData' -package: '@azure/msal-common' -summary: '' -fullName: ReqCnfData -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ReqCnfData = { kid: string, reqCnfHash: string, reqCnfString: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml b/msal/docs-ref-autogen/@azure/msal-common/RequestParameterBuilder.yml deleted file mode 100644 index e85f8d0..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml b/msal/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml index 0f75105..d4693a2 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/RequestStateObject.yml @@ -7,10 +7,9 @@ summary: >- the authorize request. fullName: RequestStateObject remarks: '' -isPreview: false isDeprecated: false syntax: | type RequestStateObject = { - libraryState: LibraryStateObject, - userRequestState: string, + 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 index 8780688..e535f8a 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/RequestThumbprint.yml @@ -5,18 +5,19 @@ package: '@azure/msal-common' summary: Type representing a unique request thumbprint. fullName: RequestThumbprint remarks: '' -isPreview: false isDeprecated: false syntax: | type RequestThumbprint = { - authenticationScheme?: AuthenticationScheme, - authority: string, - claims?: string, - clientId: string, - homeAccountIdentifier?: string, - resourceRequestMethod?: string, - resourceRequestUri?: string, - scopes: Array, - shrClaims?: string, - sshKid?: string, + authenticationScheme?: AuthenticationScheme + authority: string + claims?: string + clientId: string + embeddedClientId?: 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/RequestValidator.yml b/msal/docs-ref-autogen/@azure/msal-common/RequestValidator.yml deleted file mode 100644 index e2a3f96..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-common/ResponseCodes.yml b/msal/docs-ref-autogen/@azure/msal-common/ResponseCodes.yml deleted file mode 100644 index da5543d..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ResponseCodes.yml +++ /dev/null @@ -1,20 +0,0 @@ -### YamlMime:TSEnum -name: ResponseCodes -uid: '@azure/msal-common.ResponseCodes' -package: '@azure/msal-common' -summary: Response codes -fullName: ResponseCodes -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: httpSuccess - uid: '@azure/msal-common.ResponseCodes.httpSuccess' - package: '@azure/msal-common' - summary: '' - numericValue: 200 - - name: httpBadRequest - uid: '@azure/msal-common.ResponseCodes.httpBadRequest' - package: '@azure/msal-common' - summary: '' - numericValue: 400 diff --git a/msal/docs-ref-autogen/@azure/msal-common/ResponseHandler.yml b/msal/docs-ref-autogen/@azure/msal-common/ResponseHandler.yml deleted file mode 100644 index 97547e5..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-common/ResponseMode.yml b/msal/docs-ref-autogen/@azure/msal-common/ResponseMode.yml index 8ddf613..5846dae 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ResponseMode.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ResponseMode.yml @@ -1,22 +1,10 @@ -### YamlMime:TSEnum +### YamlMime:TSTypeAlias name: ResponseMode uid: '@azure/msal-common.ResponseMode' package: '@azure/msal-common' -summary: allowed values for response_mode +summary: '' fullName: ResponseMode remarks: '' -isPreview: false isDeprecated: false -fields: - - name: FORM_POST - uid: '@azure/msal-common.ResponseMode.FORM_POST' - package: '@azure/msal-common' - summary: '' - - name: FRAGMENT - uid: '@azure/msal-common.ResponseMode.FRAGMENT' - package: '@azure/msal-common' - summary: '' - - name: QUERY - uid: '@azure/msal-common.ResponseMode.QUERY' - package: '@azure/msal-common' - summary: '' +syntax: | + type ResponseMode = (typeof ResponseMode)[keyof typeof ResponseMode] diff --git a/msal/docs-ref-autogen/@azure/msal-common/SSOTypes.yml b/msal/docs-ref-autogen/@azure/msal-common/SSOTypes.yml deleted file mode 100644 index ba59026..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/SSOTypes.yml +++ /dev/null @@ -1,46 +0,0 @@ -### YamlMime:TSEnum -name: SSOTypes -uid: '@azure/msal-common.SSOTypes' -package: '@azure/msal-common' -summary: SSO Types - generated to populate hints -fullName: SSOTypes -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: ACCOUNT - uid: '@azure/msal-common.SSOTypes.ACCOUNT' - package: '@azure/msal-common' - summary: '' - - name: ACCOUNT_ID - uid: '@azure/msal-common.SSOTypes.ACCOUNT_ID' - package: '@azure/msal-common' - summary: '' - - name: CONSUMERS - uid: '@azure/msal-common.SSOTypes.CONSUMERS' - package: '@azure/msal-common' - summary: '' - - name: DOMAIN_HINT - uid: '@azure/msal-common.SSOTypes.DOMAIN_HINT' - package: '@azure/msal-common' - summary: '' - - name: HOMEACCOUNT_ID - uid: '@azure/msal-common.SSOTypes.HOMEACCOUNT_ID' - package: '@azure/msal-common' - summary: '' - - name: ID_TOKEN - uid: '@azure/msal-common.SSOTypes.ID_TOKEN' - package: '@azure/msal-common' - summary: '' - - name: LOGIN_HINT - uid: '@azure/msal-common.SSOTypes.LOGIN_HINT' - package: '@azure/msal-common' - summary: '' - - name: ORGANIZATIONS - uid: '@azure/msal-common.SSOTypes.ORGANIZATIONS' - package: '@azure/msal-common' - summary: '' - - name: SID - uid: '@azure/msal-common.SSOTypes.SID' - package: '@azure/msal-common' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ScopeSet.yml b/msal/docs-ref-autogen/@azure/msal-common/ScopeSet.yml index 17db8e9..a20b77e 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ScopeSet.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ScopeSet.yml @@ -12,22 +12,20 @@ summary: >- to ensure uniqueness of strings. fullName: ScopeSet remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: ScopeSet(Array) + - name: ScopeSet(string[]) uid: '@azure/msal-common.ScopeSet.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'new ScopeSet(inputScopes: Array)' + content: 'new ScopeSet(inputScopes: string[])' parameters: - id: inputScopes - type: Array<string> + type: string[] description: '' methods: - name: appendScope(string) @@ -35,47 +33,41 @@ methods: package: '@azure/msal-common' summary: Appends single scope if passed remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function appendScope(newScope: string)' parameters: - id: newScope type: string - description: |+ - - - name: appendScopes(Array) + description: '' + - name: appendScopes(string[]) uid: '@azure/msal-common.ScopeSet.appendScopes' package: '@azure/msal-common' summary: Appends multiple scopes if passed remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function appendScopes(newScopes: Array)' + content: 'function appendScopes(newScopes: string[])' parameters: - id: newScopes - type: Array<string> - description: |+ - + 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: '' - isPreview: false isDeprecated: false syntax: - content: 'function asArray(): Array' + content: 'function asArray(): string[]' return: description: '' - type: Array<string> + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function containsOnlyOIDCScopes(): boolean' @@ -87,15 +79,13 @@ 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' parameters: - id: scope type: string - description: |+ - + description: '' return: description: '' type: boolean @@ -104,24 +94,36 @@ 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' parameters: - id: scopeSet type: - description: |+ - + 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: '' - isPreview: false isDeprecated: false syntax: content: 'static function fromString(inputScopeString: string): ScopeSet' @@ -137,7 +139,6 @@ methods: package: '@azure/msal-common' summary: Returns size of set of scopes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getScopeCount(): number' @@ -149,15 +150,13 @@ 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' parameters: - id: otherScopes type: - description: |+ - + description: '' return: description: '' type: boolean @@ -166,7 +165,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 +176,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 +191,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,29 +199,25 @@ methods: package: '@azure/msal-common' summary: Removes element from set of scopes. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function removeScope(scope: string)' parameters: - id: scope type: string - description: |+ - + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function unionScopeSets(otherScopes: ScopeSet): Set' parameters: - id: otherScopes type: - description: |+ - + description: '' return: description: '' type: Set<string> diff --git a/msal/docs-ref-autogen/@azure/msal-common/Separators.yml b/msal/docs-ref-autogen/@azure/msal-common/Separators.yml deleted file mode 100644 index c508c40..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/Separators.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: Separators -uid: '@azure/msal-common.Separators' -package: '@azure/msal-common' -summary: Separators used in cache -fullName: Separators -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: CACHE_KEY_SEPARATOR - uid: '@azure/msal-common.Separators.CACHE_KEY_SEPARATOR' - package: '@azure/msal-common' - summary: '' - - name: CLIENT_INFO_SEPARATOR - uid: '@azure/msal-common.Separators.CLIENT_INFO_SEPARATOR' - package: '@azure/msal-common' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml index 75f150b..5322898 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationCodeResponse.yml @@ -11,19 +11,23 @@ summary: |- - error: description fullName: ServerAuthorizationCodeResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type ServerAuthorizationCodeResponse = { - accountId?: string, - client_info?: string, - cloud_graph_host_name?: string, - cloud_instance_host_name?: string, - cloud_instance_name?: string, - code?: string, - error?: string, - error_description?: string, - msgraph_host?: string, - state?: string, - suberror?: string, + 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 + error_uri?: 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 index dfec2d8..7a806e9 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerAuthorizationTokenResponse.yml @@ -2,7 +2,7 @@ name: ServerAuthorizationTokenResponse uid: '@azure/msal-common.ServerAuthorizationTokenResponse' package: '@azure/msal-common' -summary: > +summary: >- Deserialized response object from server authorization code request. - token_type: Indicates the token type value. Can be either Bearer or pop. @@ -29,6 +29,7 @@ summary: > - 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 @@ -46,29 +47,34 @@ summary: > - 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: '' -isPreview: false isDeprecated: false syntax: | type ServerAuthorizationTokenResponse = { - access_token?: string, - client_info?: string, - correlation_id?: string, - error?: string, - error_codes?: Array, - error_description?: string, - expires_in?: number, - ext_expires_in?: number, - foci?: string, - id_token?: string, - key_id?: string, - refresh_in?: number, - refresh_token?: string, - scope?: string, - spa_code?: string, - suberror?: string, - timestamp?: string, - token_type?: AuthenticationScheme, - trace_id?: string, + 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 index b8018ae..d63a2ba 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerDeviceCodeResponse.yml @@ -5,14 +5,13 @@ package: '@azure/msal-common' summary: '' fullName: ServerDeviceCodeResponse remarks: '' -isPreview: false isDeprecated: false syntax: | type ServerDeviceCodeResponse = { - device_code: string, - expires_in: number, - interval: number, - message: string, - user_code: string, - verification_uri: string, + 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 index 00f1206..9140d0d 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerError.yml @@ -7,21 +7,19 @@ summary: >- unavailability. fullName: ServerError remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'ServerError(string, string, string)' + - name: ServerError(string, string, string, string, number) uid: '@azure/msal-common.ServerError.constructor' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- new ServerError(errorCode?: string, errorMessage?: string, subError?: - string) + string, errorNo?: string, status?: number) parameters: - id: errorCode type: string @@ -32,6 +30,37 @@ constructors: - id: subError type: string description: '' + - id: errorNo + type: string + description: '' + - id: status + type: number + 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 + - 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' @@ -39,7 +68,6 @@ inheritedProperties: summary: CorrelationId associated with the error fullName: correlationId remarks: '' - isPreview: false isDeprecated: false syntax: content: 'correlationId: string' @@ -55,7 +83,6 @@ inheritedProperties: summary: Short string denoting error fullName: errorCode remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorCode: string' @@ -71,7 +98,6 @@ inheritedProperties: summary: Detailed description of error fullName: errorMessage remarks: '' - isPreview: false isDeprecated: false syntax: content: 'errorMessage: string' @@ -87,49 +113,84 @@ inheritedProperties: summary: '' fullName: message remarks: '' - isPreview: false isDeprecated: false syntax: content: 'message: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.message + 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: '' - isPreview: false isDeprecated: false syntax: content: 'name: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.name + 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: '' - isPreview: false isDeprecated: false syntax: content: 'stack?: string' return: description: '' type: string - inheritanceDescription: Inherited From Error.stack + 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: '' - isPreview: false isDeprecated: false syntax: content: 'subError: string' @@ -140,53 +201,31 @@ inheritedProperties: Inherited From [AuthError.subError](xref:@azure/msal-common.AuthError.subError) inheritedMethods: - - name: createPostRequestFailed(string) - uid: '@azure/msal-common.ServerError.createPostRequestFailed' + - name: captureStackTrace(object, Function) + uid: '@azure/msal-common.ServerError.captureStackTrace' package: '@azure/msal-common' - summary: Creates an error for post request failures. + summary: Create .stack property on a target object remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'static function createPostRequestFailed(errDesc: string): AuthError' + content: >- + static function captureStackTrace(targetObject: object, constructorOpt?: + Function) parameters: - - id: errDesc - type: string + - id: targetObject + type: object + description: '' + - id: constructorOpt + type: Function description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [AuthError.createPostRequestFailed](xref:@azure/msal-common.AuthError.createPostRequestFailed) - - name: createUnexpectedError(string) - uid: '@azure/msal-common.ServerError.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) + [AuthError.captureStackTrace](xref:@azure/msal-common.AuthError.captureStackTrace) - name: setCorrelationId(string) uid: '@azure/msal-common.ServerError.setCorrelationId' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function setCorrelationId(correlationId: string)' 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 index af31812..0c17c35 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryEntity.yml @@ -1,83 +1,15 @@ -### YamlMime:TSType +### YamlMime:TSTypeAlias name: ServerTelemetryEntity uid: '@azure/msal-common.ServerTelemetryEntity' package: '@azure/msal-common' summary: '' fullName: ServerTelemetryEntity remarks: '' -isPreview: false isDeprecated: false -type: class -constructors: - - name: ServerTelemetryEntity() - uid: '@azure/msal-common.ServerTelemetryEntity.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new ServerTelemetryEntity() -properties: - - name: cacheHits - uid: '@azure/msal-common.ServerTelemetryEntity.cacheHits' - package: '@azure/msal-common' - summary: '' - fullName: cacheHits - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'cacheHits: number' - return: - description: '' - type: number - - name: errors - uid: '@azure/msal-common.ServerTelemetryEntity.errors' - package: '@azure/msal-common' - summary: '' - fullName: errors - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errors: string[]' - return: - description: '' - type: 'string[]' - - name: failedRequests - uid: '@azure/msal-common.ServerTelemetryEntity.failedRequests' - package: '@azure/msal-common' - summary: '' - fullName: failedRequests - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'failedRequests: Array' - return: - description: '' - type: Array<string | number> -methods: - - name: 'isServerTelemetryEntity(string, object)' - uid: '@azure/msal-common.ServerTelemetryEntity.isServerTelemetryEntity' - package: '@azure/msal-common' - summary: 'validates if a given cache entry is "Telemetry", parses ' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function isServerTelemetryEntity(key: string, entity?: object): - boolean - parameters: - - id: key - type: string - description: '' - - id: entity - type: object - description: |+ - - return: - description: '' - type: boolean +syntax: | + type ServerTelemetryEntity = { + cacheHits: number + errors: string[] + failedRequests: (string | number)[] + nativeBrokerErrorCode?: string + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryManager.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryManager.yml deleted file mode 100644 index 82bd19b..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryManager.yml +++ /dev/null @@ -1,163 +0,0 @@ -### YamlMime:TSType -name: ServerTelemetryManager -uid: '@azure/msal-common.ServerTelemetryManager' -package: '@azure/msal-common' -summary: '' -fullName: ServerTelemetryManager -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'ServerTelemetryManager(ServerTelemetryRequest, CacheManager)' - uid: '@azure/msal-common.ServerTelemetryManager.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new ServerTelemetryManager(telemetryRequest: ServerTelemetryRequest, - cacheManager: CacheManager) - parameters: - - id: telemetryRequest - type: - description: '' - - id: cacheManager - type: - description: '' -methods: - - name: cacheFailedRequest(AuthError) - uid: '@azure/msal-common.ServerTelemetryManager.cacheFailedRequest' - 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)' - parameters: - - id: error - type: - description: |+ - - - name: clearTelemetryCache() - uid: '@azure/msal-common.ServerTelemetryManager.clearTelemetryCache' - package: '@azure/msal-common' - summary: Remove server telemetry cache entry - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function clearTelemetryCache() - - name: generateCurrentRequestHeaderValue() - uid: >- - @azure/msal-common.ServerTelemetryManager.generateCurrentRequestHeaderValue - package: '@azure/msal-common' - summary: API to add MSER Telemetry to request - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateCurrentRequestHeaderValue(): string' - return: - description: '' - type: string - - name: generateLastRequestHeaderValue() - uid: '@azure/msal-common.ServerTelemetryManager.generateLastRequestHeaderValue' - 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' - return: - description: '' - type: string - - name: getLastRequests() - uid: '@azure/msal-common.ServerTelemetryManager.getLastRequests' - 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' - return: - description: '' - type: - - name: getRegionDiscoveryFields() - uid: '@azure/msal-common.ServerTelemetryManager.getRegionDiscoveryFields' - package: '@azure/msal-common' - summary: Get the region discovery fields - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getRegionDiscoveryFields(): string' - return: - description: string - type: string - - name: incrementCacheHits() - uid: '@azure/msal-common.ServerTelemetryManager.incrementCacheHits' - 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' - return: - description: '' - type: number - - name: maxErrorsToSend(ServerTelemetryEntity) - uid: '@azure/msal-common.ServerTelemetryManager.maxErrorsToSend' - package: '@azure/msal-common' - summary: >- - 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: >- - static function maxErrorsToSend(serverTelemetryEntity: - ServerTelemetryEntity): number - parameters: - - id: serverTelemetryEntity - type: - description: |+ - - return: - description: '' - type: number - - name: setCacheOutcome(CacheOutcome) - uid: '@azure/msal-common.ServerTelemetryManager.setCacheOutcome' - package: '@azure/msal-common' - summary: Set cache outcome - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setCacheOutcome(cacheOutcome: CacheOutcome)' - parameters: - - id: cacheOutcome - type: - description: '' - - name: updateRegionDiscoveryMetadata(RegionDiscoveryMetadata) - uid: '@azure/msal-common.ServerTelemetryManager.updateRegionDiscoveryMetadata' - package: '@azure/msal-common' - summary: Update the region discovery metadata - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function updateRegionDiscoveryMetadata(regionDiscoveryMetadata: - RegionDiscoveryMetadata) - parameters: - - id: regionDiscoveryMetadata - type: - description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml index 60380d0..d89bb6e 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ServerTelemetryRequest.yml @@ -5,14 +5,13 @@ package: '@azure/msal-common' summary: '' fullName: ServerTelemetryRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type ServerTelemetryRequest = { - apiId: number, - clientId: string, - correlationId: string, - forceRefresh?: boolean, - wrapperSKU?: string, - wrapperVer?: string, + 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 index cd4e739..f2c8ddc 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequest.yml @@ -5,17 +5,16 @@ package: '@azure/msal-common' summary: '' fullName: SignedHttpRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type SignedHttpRequest = { - at?: string, - client_claims?: string, - cnf?: object, - m?: string, - nonce?: string, - p?: string, - q?: [Array, string], - ts?: number, - u?: string, + 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 index 5d3e3cd..1f2dfa4 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/SignedHttpRequestParameters.yml @@ -5,10 +5,13 @@ package: '@azure/msal-common' summary: '' fullName: SignedHttpRequestParameters remarks: '' -isPreview: false isDeprecated: false syntax: | type SignedHttpRequestParameters = Pick< BaseAuthRequest, - "resourceRequestMethod" | "resourceRequestUri" | "shrClaims" | "shrNonce" + | "resourceRequestMethod" + | "resourceRequestUri" + | "shrClaims" + | "shrNonce" + | "shrOptions" > & { correlationId?: string } diff --git a/msal/docs-ref-autogen/@azure/msal-common/SilentFlowClient.yml b/msal/docs-ref-autogen/@azure/msal-common/SilentFlowClient.yml deleted file mode 100644 index 225581d..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/SilentFlowClient.yml +++ /dev/null @@ -1,126 +0,0 @@ -### YamlMime:TSType -name: SilentFlowClient -uid: '@azure/msal-common.SilentFlowClient' -package: '@azure/msal-common' -summary: '' -fullName: SilentFlowClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'SilentFlowClient(ClientConfiguration, IPerformanceClient)' - uid: '@azure/msal-common.SilentFlowClient.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new SilentFlowClient(configuration: ClientConfiguration, - performanceClient?: IPerformanceClient) - parameters: - - id: configuration - type: - description: '' - - id: performanceClient - type: - description: '' -inheritedProperties: - - name: authority - uid: '@azure/msal-common.SilentFlowClient.authority' - package: '@azure/msal-common' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: Authority' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.authority](xref:@azure/msal-common.BaseClient.authority) - - name: logger - uid: '@azure/msal-common.SilentFlowClient.logger' - package: '@azure/msal-common' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) -inheritedMethods: - - name: updateAuthority(Authority) - uid: '@azure/msal-common.SilentFlowClient.updateAuthority' - package: '@azure/msal-common' - 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: - description: |+ - - inheritanceDescription: >- - Inherited From - [BaseClient.updateAuthority](xref:@azure/msal-common.BaseClient.updateAuthority) -methods: - - name: acquireCachedToken(CommonSilentFlowRequest) - uid: '@azure/msal-common.SilentFlowClient.acquireCachedToken' - 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: >- - function acquireCachedToken(request: CommonSilentFlowRequest): - Promise - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<> - - name: acquireToken(CommonSilentFlowRequest) - uid: '@azure/msal-common.SilentFlowClient.acquireToken' - package: '@azure/msal-common' - summary: >- - Retrieves a token from cache if it is still valid, or uses the cached - refresh token to renew - - the given token and returns the renewed token - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function acquireToken(request: CommonSilentFlowRequest): - Promise - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<> -extends: 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/StaticFields.yml b/msal/docs-ref-autogen/@azure/msal-common/StaticFields.yml deleted file mode 100644 index 1ad7d85..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/StaticFields.yml +++ /dev/null @@ -1,33 +0,0 @@ -### YamlMime:TSTypeAlias -name: StaticFields -uid: '@azure/msal-common.StaticFields' -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, - appName?: string, - appVersion?: string, - cacheLookupPolicy?: number | undefined, - extensionId?: string, - extensionVersion?: string, - idTokenSize?: number, - 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, - refreshTokenSize?: number | undefined, - } 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 index 67e49d3..e49d878 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/StringDict.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/StringDict.yml @@ -2,9 +2,9 @@ name: StringDict uid: '@azure/msal-common.StringDict' package: '@azure/msal-common' -summary: 'Key-Value type to support queryParams, extraQueryParams and claims' +summary: Key-Value type to support queryParams, extraQueryParams and claims fullName: StringDict remarks: '' -isPreview: false isDeprecated: false -syntax: 'type StringDict = [key: string]: string' +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 index 4e2e364..58facc3 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/StubPerformanceClient.yml @@ -5,208 +5,133 @@ package: '@azure/msal-common' summary: '' fullName: StubPerformanceClient remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: >- - StubPerformanceClient(string, string, Logger, string, string, - ApplicationTelemetry) - uid: '@azure/msal-common.StubPerformanceClient.constructor' +methods: + - name: addFields() + uid: '@azure/msal-common.StubPerformanceClient.addFields' package: '@azure/msal-common' - summary: |- - Creates an instance of PerformanceClient, - an abstract class containing core performance telemetry logic. + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - new StubPerformanceClient(clientId: string, authority: string, logger: - Logger, libraryName: string, libraryVersion: string, - applicationTelemetry: ApplicationTelemetry) - 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: '' -inheritedMethods: - - name: addPerformanceCallback(PerformanceCallbackFunction) + content: function addFields() + - name: addPerformanceCallback() uid: '@azure/msal-common.StubPerformanceClient.addPerformanceCallback' package: '@azure/msal-common' - summary: Registers a callback function to receive performance events. + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function addPerformanceCallback(callback: PerformanceCallbackFunction): - string - parameters: - - id: callback - type: - description: '' + content: 'function addPerformanceCallback(): string' return: description: '' type: string - inheritanceDescription: >- - Inherited From - [PerformanceClient.addPerformanceCallback](xref:@azure/msal-common.PerformanceClient.addPerformanceCallback) - - name: 'addStaticFields(StaticFields, string)' - uid: '@azure/msal-common.StubPerformanceClient.addStaticFields' + - name: addQueueMeasurement() + uid: '@azure/msal-common.StubPerformanceClient.addQueueMeasurement' package: '@azure/msal-common' - summary: Saves extra information to be emitted when the measurements are flushed + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function addStaticFields(fields: StaticFields, correlationId: string)' - parameters: - - id: fields - type: - description: '' - - id: correlationId - type: string - description: |+ - - inheritanceDescription: >- - Inherited From - [PerformanceClient.addStaticFields](xref:@azure/msal-common.PerformanceClient.addStaticFields) - - name: discardMeasurements(string) + 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: Removes measurements for a given correlation id. + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function discardMeasurements(correlationId: string)' - parameters: - - id: correlationId - type: string - description: |+ - - inheritanceDescription: >- - Inherited From - [PerformanceClient.discardMeasurements](xref:@azure/msal-common.PerformanceClient.discardMeasurements) - - name: 'emitEvents(PerformanceEvent[], string)' + content: function discardMeasurements() + - name: emitEvents() uid: '@azure/msal-common.StubPerformanceClient.emitEvents' package: '@azure/msal-common' - summary: Emits events to all registered callbacks. + summary: '' remarks: '' - isPreview: false 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](xref:@azure/msal-common.PerformanceClient.emitEvents) - - name: endMeasurement(PerformanceEvent) + content: function emitEvents() + - name: endMeasurement() uid: '@azure/msal-common.StubPerformanceClient.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. + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function endMeasurement(event: PerformanceEvent): PerformanceEvent | - null - parameters: - - id: event - type: - description: '' + content: 'function endMeasurement(): null | PerformanceEvent' 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' + type: null | + - name: generateId() + uid: '@azure/msal-common.StubPerformanceClient.generateId' package: '@azure/msal-common' - summary: >- - Gathers and emits performance events for measurements taked for the given - top-level API and correlation ID. + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - function flushMeasurements(measureName: PerformanceEvents, - correlationId: string) - parameters: - - id: measureName - type: - description: '' - - id: correlationId - type: string - description: |+ - - inheritanceDescription: >- - Inherited From - [PerformanceClient.flushMeasurements](xref:@azure/msal-common.PerformanceClient.flushMeasurements) - - name: removePerformanceCallback(string) + 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: Removes a callback registered with addPerformanceCallback. + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function removePerformanceCallback(callbackId: string): boolean' - parameters: - - id: callbackId - type: string - description: '' + content: 'function removePerformanceCallback(): boolean' return: description: '' type: boolean - inheritanceDescription: >- - Inherited From - [PerformanceClient.removePerformanceCallback](xref:@azure/msal-common.PerformanceClient.removePerformanceCallback) - - name: 'startMeasurement(PerformanceEvents, string)' + - 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: >- - Starts measuring performance for a given operation. Returns a function - that should be used to end the measurement. + summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function startMeasurement(measureName: PerformanceEvents, - correlationId?: string): InProgressPerformanceEvent + function startMeasurement(measureName: string, correlationId?: string): + InProgressPerformanceEvent parameters: - id: measureName - type: + type: string description: '' - id: correlationId type: string @@ -214,32 +139,15 @@ inheritedMethods: return: description: '' type: - inheritanceDescription: >- - Inherited From - [PerformanceClient.startMeasurement](xref:@azure/msal-common.PerformanceClient.startMeasurement) -methods: - - name: generateId() - uid: '@azure/msal-common.StubPerformanceClient.generateId' + - name: startPerformanceMeasurement() + uid: '@azure/msal-common.StubPerformanceClient.startPerformanceMeasurement' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function generateId(): string' - return: - description: '' - type: string - - name: startPerformanceMeasuremeant() - uid: '@azure/msal-common.StubPerformanceClient.startPerformanceMeasuremeant' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: This method will be removed in the next major version syntax: - content: 'function startPerformanceMeasuremeant(): IPerformanceMeasurement' + content: 'function startPerformanceMeasurement(): IPerformanceMeasurement' return: description: '' type: -extends: diff --git a/msal/docs-ref-autogen/@azure/msal-common/StubPerformanceMeasurement.yml b/msal/docs-ref-autogen/@azure/msal-common/StubPerformanceMeasurement.yml deleted file mode 100644 index 6551b75..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/StubPerformanceMeasurement.yml +++ /dev/null @@ -1,41 +0,0 @@ -### YamlMime:TSType -name: StubPerformanceMeasurement -uid: '@azure/msal-common.StubPerformanceMeasurement' -package: '@azure/msal-common' -summary: '' -fullName: StubPerformanceMeasurement -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: endMeasurement() - uid: '@azure/msal-common.StubPerformanceMeasurement.endMeasurement' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function endMeasurement() - - name: flushMeasurement() - uid: '@azure/msal-common.StubPerformanceMeasurement.flushMeasurement' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function flushMeasurement(): number | null' - return: - description: '' - type: number | null - - name: startMeasurement() - uid: '@azure/msal-common.StubPerformanceMeasurement.startMeasurement' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function startMeasurement() 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 index 3cf4139..c6f37e3 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/SystemOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/SystemOptions.yml @@ -2,18 +2,17 @@ name: SystemOptions uid: '@azure/msal-common.SystemOptions' package: '@azure/msal-common' -summary: > +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: '' -isPreview: false isDeprecated: false syntax: | type SystemOptions = { - preventCorsPreflight?: boolean, - proxyUrl?: string, - tokenRenewalOffsetSeconds?: number, + preventCorsPreflight?: boolean + tokenRenewalOffsetSeconds?: number } diff --git a/msal/docs-ref-autogen/@azure/msal-common/TelemetryOptions.yml b/msal/docs-ref-autogen/@azure/msal-common/TelemetryOptions.yml deleted file mode 100644 index 5754bdf..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/TelemetryOptions.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: TelemetryOptions -uid: '@azure/msal-common.TelemetryOptions' -package: '@azure/msal-common' -summary: '' -fullName: TelemetryOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type TelemetryOptions = { application: ApplicationTelemetry } 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 index 72f89d6..2daf056 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/ThrottlingEntity.yml @@ -1,99 +1,16 @@ -### YamlMime:TSType +### YamlMime:TSTypeAlias name: ThrottlingEntity uid: '@azure/msal-common.ThrottlingEntity' package: '@azure/msal-common' summary: '' fullName: ThrottlingEntity remarks: '' -isPreview: false isDeprecated: false -type: class -properties: - - name: error - uid: '@azure/msal-common.ThrottlingEntity.error' - package: '@azure/msal-common' - summary: '' - fullName: error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'error?: string' - return: - description: '' - type: string - - name: errorCodes - uid: '@azure/msal-common.ThrottlingEntity.errorCodes' - package: '@azure/msal-common' - summary: '' - fullName: errorCodes - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorCodes?: Array' - return: - description: '' - type: Array<string> - - name: errorMessage - uid: '@azure/msal-common.ThrottlingEntity.errorMessage' - package: '@azure/msal-common' - summary: '' - fullName: errorMessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage?: string' - return: - description: '' - type: string - - name: subError - uid: '@azure/msal-common.ThrottlingEntity.subError' - package: '@azure/msal-common' - summary: '' - fullName: subError - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'subError?: string' - return: - description: '' - type: string - - name: throttleTime - uid: '@azure/msal-common.ThrottlingEntity.throttleTime' - package: '@azure/msal-common' - summary: '' - fullName: throttleTime - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'throttleTime: number' - return: - description: '' - type: number -methods: - - name: 'isThrottlingEntity(string, object)' - uid: '@azure/msal-common.ThrottlingEntity.isThrottlingEntity' - package: '@azure/msal-common' - summary: 'validates if a given cache entry is "Throttling", parses ' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function isThrottlingEntity(key: string, entity?: object): - boolean - parameters: - - id: key - type: string - description: '' - - id: entity - type: object - description: |+ - - return: - description: '' - type: boolean +syntax: | + type ThrottlingEntity = { + error?: string + errorCodes?: string[] + errorMessage?: string + subError?: string + throttleTime: number + } diff --git a/msal/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml deleted file mode 100644 index fb0ce15..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ThrottlingUtils.yml +++ /dev/null @@ -1,166 +0,0 @@ -### YamlMime:TSType -name: ThrottlingUtils -uid: '@azure/msal-common.ThrottlingUtils' -package: '@azure/msal-common' -summary: '' -fullName: ThrottlingUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: calculateThrottleTime(number) - uid: '@azure/msal-common.ThrottlingUtils.calculateThrottleTime' - package: '@azure/msal-common' - summary: >- - 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' - parameters: - - id: throttleTime - type: number - description: |+ - - return: - description: '' - type: number - - name: >- - checkResponseForRetryAfter(NetworkResponse) - uid: '@azure/msal-common.ThrottlingUtils.checkResponseForRetryAfter' - package: '@azure/msal-common' - summary: Checks a NetworkResponse object's RetryAfter header - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function checkResponseForRetryAfter(response: - NetworkResponse): boolean - parameters: - - id: response - type: >- - <> - description: |+ - - return: - description: '' - type: boolean - - name: checkResponseStatus(NetworkResponse) - uid: '@azure/msal-common.ThrottlingUtils.checkResponseStatus' - package: '@azure/msal-common' - summary: Checks a NetworkResponse object's status codes against 429 or 5xx - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function checkResponseStatus(response: - NetworkResponse): boolean - parameters: - - id: response - type: >- - <> - description: |+ - - return: - description: '' - type: boolean - - name: generateThrottlingStorageKey(RequestThumbprint) - uid: '@azure/msal-common.ThrottlingUtils.generateThrottlingStorageKey' - package: '@azure/msal-common' - summary: Prepares a RequestThumbprint to be stored as a key. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function generateThrottlingStorageKey(thumbprint: - RequestThumbprint): string - parameters: - - id: thumbprint - type: - description: |+ - - return: - description: '' - type: string - - name: >- - postProcess(CacheManager, RequestThumbprint, - NetworkResponse) - uid: '@azure/msal-common.ThrottlingUtils.postProcess' - package: '@azure/msal-common' - summary: Performs necessary throttling checks after a network request. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function postProcess(cacheManager: CacheManager, thumbprint: - RequestThumbprint, response: - NetworkResponse) - parameters: - - id: cacheManager - type: - description: '' - - id: thumbprint - type: - description: '' - - id: response - type: >- - <> - description: |+ - - - name: 'preProcess(CacheManager, RequestThumbprint)' - uid: '@azure/msal-common.ThrottlingUtils.preProcess' - package: '@azure/msal-common' - summary: Performs necessary throttling checks before a network request. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function preProcess(cacheManager: CacheManager, thumbprint: - RequestThumbprint) - parameters: - - id: cacheManager - type: - description: '' - - id: thumbprint - type: - description: |+ - - - name: 'removeThrottle(CacheManager, string, BaseAuthRequest, string)' - uid: '@azure/msal-common.ThrottlingUtils.removeThrottle' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function removeThrottle(cacheManager: CacheManager, clientId: - string, request: BaseAuthRequest, homeAccountIdentifier?: string): - boolean - parameters: - - id: cacheManager - type: - description: '' - - id: clientId - type: string - description: '' - - id: request - type: - description: '' - - id: homeAccountIdentifier - type: string - description: '' - return: - description: '' - type: boolean diff --git a/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml b/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml index fe884f3..7aa6e51 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/TimeUtils.yml @@ -1,50 +1,40 @@ -### YamlMime:TSType -name: TimeUtils +### YamlMime:TSPackage uid: '@azure/msal-common.TimeUtils' +name: TimeUtils +type: module 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: - - name: 'delay(number, T)' +summary: '' +functions: + - name: delay(number, T) uid: '@azure/msal-common.TimeUtils.delay' 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' + content: 'function delay(t: number, value?: T): Promise' parameters: - id: t type: number description: number - id: value type: T - description: | - T + description: T return: description: '' type: Promise<T | void> - - name: 'isTokenExpired(string, number)' + - 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: '' - isPreview: false isDeprecated: false syntax: - content: >- - static function isTokenExpired(expiresOn: string, offset: number): - boolean + content: 'function isTokenExpired(expiresOn: string, offset: number): boolean' parameters: - id: expiresOn type: string - description: |+ - + description: '' - id: offset type: number description: '' @@ -56,10 +46,41 @@ 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' + content: 'function nowSeconds(): number' + 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 @@ -72,10 +93,9 @@ 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' + content: 'function wasClockTurnedBack(cachedAt: string): boolean' parameters: - id: cachedAt type: string diff --git a/msal/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml b/msal/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml index 6be4dcb..f810c14 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/TokenCacheContext.yml @@ -7,16 +7,14 @@ summary: |- decisions to read from and write to the persistent cache fullName: TokenCacheContext remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TokenCacheContext(ISerializableTokenCache, boolean)' + - name: TokenCacheContext(ISerializableTokenCache, boolean) uid: '@azure/msal-common.TokenCacheContext.constructor' 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/msal/docs-ref-autogen/@azure/msal-common/TokenClaims.yml b/msal/docs-ref-autogen/@azure/msal-common/TokenClaims.yml index 666c3a7..f882833 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/TokenClaims.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/TokenClaims.yml @@ -5,37 +5,40 @@ package: '@azure/msal-common' summary: Type which describes Id Token claims known by MSAL. fullName: TokenClaims remarks: '' -isPreview: false isDeprecated: false syntax: | type TokenClaims = { - 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, - tid?: string, - ts?: number, - u?: string, - upn?: string, - ver?: string, - x5c_ca?: string[], + 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 index f1429a8..c646f73 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/UrlString.yml +++ b/msal/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 @@ -37,14 +34,13 @@ properties: description: '' type: string methods: - - name: 'appendQueryString(string, string)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -56,8 +52,7 @@ methods: description: '' - id: queryString type: string - description: |+ - + description: '' return: description: '' type: string @@ -66,15 +61,13 @@ 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' parameters: - id: url type: string - description: |+ - + description: '' return: description: '' type: string @@ -83,7 +76,6 @@ methods: package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -96,12 +88,11 @@ methods: return: description: '' type: - - name: 'getAbsoluteUrl(string, string)' + - name: getAbsoluteUrl(string, string) uid: '@azure/msal-common.UrlString.getAbsoluteUrl' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -117,48 +108,11 @@ methods: return: description: '' type: string - - name: getDeserializedHash(string) - uid: '@azure/msal-common.UrlString.getDeserializedHash' - package: '@azure/msal-common' - summary: Returns URL hash as server auth code response object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function getDeserializedHash(hash: string): - ServerAuthorizationCodeResponse - parameters: - - id: hash - type: string - description: '' - return: - description: '' - type: - - name: getDeserializedQueryString(string) - uid: '@azure/msal-common.UrlString.getDeserializedQueryString' - package: '@azure/msal-common' - summary: Returns URL query string as server auth code response object. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function getDeserializedQueryString(query: string): - ServerAuthorizationCodeResponse - parameters: - - id: query - type: string - description: '' - return: - description: '' - type: - name: getDomainFromUrl(string) uid: '@azure/msal-common.UrlString.getDomainFromUrl' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: 'static function getDomainFromUrl(url: string): string' @@ -169,24 +123,11 @@ methods: return: description: '' type: string - - name: getHash() - uid: '@azure/msal-common.UrlString.getHash' - package: '@azure/msal-common' - summary: Returns the anchor part(#) of the URL - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getHash(): string' - 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: '' - isPreview: false isDeprecated: false syntax: content: 'function getUrlComponents(): IUri' @@ -200,69 +141,29 @@ methods: package: '@azure/msal-common' summary: Check if the hash of the URL string contains known properties remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: This API will be removed in a future version syntax: - content: 'static function hashContainsKnownProperties(hash: string): boolean' + content: 'static function hashContainsKnownProperties(response: string): boolean' parameters: - - id: hash + - id: response type: string description: '' return: description: '' type: boolean - - name: parseHash(string) - uid: '@azure/msal-common.UrlString.parseHash' - package: '@azure/msal-common' - summary: >- - 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' - parameters: - - id: hashString - type: string - description: |+ - - return: - description: '' - type: string - - name: parseQueryString(string) - uid: '@azure/msal-common.UrlString.parseQueryString' - package: '@azure/msal-common' - summary: >- - 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' - parameters: - - id: queryString - type: string - description: |+ - - return: - description: '' - type: string - name: removeHashFromUrl(string) uid: '@azure/msal-common.UrlString.removeHashFromUrl' 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' parameters: - id: url type: string - description: |+ - + description: '' return: description: '' type: string @@ -273,15 +174,13 @@ 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' parameters: - id: tenantId type: string - description: | - The tenant id to replace + description: The tenant id to replace return: description: '' type: @@ -290,7 +189,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/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/UsernamePasswordClient.yml b/msal/docs-ref-autogen/@azure/msal-common/UsernamePasswordClient.yml deleted file mode 100644 index 401dee3..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/UsernamePasswordClient.yml +++ /dev/null @@ -1,108 +0,0 @@ -### YamlMime:TSType -name: UsernamePasswordClient -uid: '@azure/msal-common.UsernamePasswordClient' -package: '@azure/msal-common' -summary: >- - Oauth2.0 Password grant client - - Note: We are only supporting public clients for password grant and for purely - testing purposes -fullName: UsernamePasswordClient -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UsernamePasswordClient(ClientConfiguration) - uid: '@azure/msal-common.UsernamePasswordClient.constructor' - package: '@azure/msal-common' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new UsernamePasswordClient(configuration: ClientConfiguration)' - parameters: - - id: configuration - type: - description: '' -inheritedProperties: - - name: authority - uid: '@azure/msal-common.UsernamePasswordClient.authority' - package: '@azure/msal-common' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: Authority' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.authority](xref:@azure/msal-common.BaseClient.authority) - - name: logger - uid: '@azure/msal-common.UsernamePasswordClient.logger' - package: '@azure/msal-common' - summary: '' - fullName: logger - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'logger: Logger' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [BaseClient.logger](xref:@azure/msal-common.BaseClient.logger) -inheritedMethods: - - name: updateAuthority(Authority) - uid: '@azure/msal-common.UsernamePasswordClient.updateAuthority' - package: '@azure/msal-common' - 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: - description: |+ - - inheritanceDescription: >- - Inherited From - [BaseClient.updateAuthority](xref:@azure/msal-common.BaseClient.updateAuthority) -methods: - - name: acquireToken(CommonUsernamePasswordRequest) - uid: '@azure/msal-common.UsernamePasswordClient.acquireToken' - package: '@azure/msal-common' - summary: >- - API to acquire a token by passing the username and password to the service - in exchage of credentials - - password_grant - remarks: '' - isPreview: false - 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-common/ValidCacheType.yml b/msal/docs-ref-autogen/@azure/msal-common/ValidCacheType.yml deleted file mode 100644 index 3fffb83..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ValidCacheType.yml +++ /dev/null @@ -1,20 +0,0 @@ -### YamlMime:TSTypeAlias -name: ValidCacheType -uid: '@azure/msal-common.ValidCacheType' -package: '@azure/msal-common' -summary: Object type of all accepted cache types -fullName: ValidCacheType -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ValidCacheType = - | AccountEntity - | IdTokenEntity - | AccessTokenEntity - | RefreshTokenEntity - | AppMetadataEntity - | AuthorityMetadataEntity - | ServerTelemetryEntity - | ThrottlingEntity - | string diff --git a/msal/docs-ref-autogen/@azure/msal-common/ValidCredentialType.yml b/msal/docs-ref-autogen/@azure/msal-common/ValidCredentialType.yml deleted file mode 100644 index 18c9bf2..0000000 --- a/msal/docs-ref-autogen/@azure/msal-common/ValidCredentialType.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: ValidCredentialType -uid: '@azure/msal-common.ValidCredentialType' -package: '@azure/msal-common' -summary: Object type of all credential types -fullName: ValidCredentialType -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type ValidCredentialType = - | IdTokenEntity - | AccessTokenEntity - | RefreshTokenEntity diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml index 0374e47..d2acd92 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -3,55 +3,70 @@ 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.NetworkError' + - '@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.CcsCredential' - - '@azure/msal-common.ClientAssertion' - - '@azure/msal-common.ClientCredentials' - - '@azure/msal-common.ClientInfo' - - '@azure/msal-common.TokenClaims' - - '@azure/msal-common.AuthorityOptions' - - '@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' - - '@azure/msal-common.AccountCache' - - '@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.ValidCacheType' - - '@azure/msal-common.ValidCredentialType' + - '@azure/msal-common.AppMetadataEntity' - '@azure/msal-common.AppTokenProviderParameters' - '@azure/msal-common.AppTokenProviderResult' - '@azure/msal-common.ApplicationTelemetry' - - '@azure/msal-common.AuthOptions' + - '@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.ClientConfiguration' - - '@azure/msal-common.CommonClientConfiguration' - - '@azure/msal-common.LibraryInfo' - - '@azure/msal-common.LoggerOptions' - - '@azure/msal-common.SystemOptions' - - '@azure/msal-common.TelemetryOptions' - - '@azure/msal-common.PkceCodes' - - '@azure/msal-common.SignedHttpRequestParameters' - - '@azure/msal-common.JoseHeaderOptions' - - '@azure/msal-common.ReqCnf' - - '@azure/msal-common.ReqCnfData' - - '@azure/msal-common.SignedHttpRequest' - - '@azure/msal-common.LoggerMessageOptions' - - '@azure/msal-common.NetworkRequestOptions' - - '@azure/msal-common.NetworkResponse' - - '@azure/msal-common.RequestThumbprint' + - '@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.ClientAssertionCallback' + - '@azure/msal-common.ClientAssertionConfig' + - '@azure/msal-common.ClientInfo' - '@azure/msal-common.CommonAuthorizationCodeRequest' - '@azure/msal-common.CommonAuthorizationUrlRequest' - '@azure/msal-common.CommonClientCredentialRequest' @@ -61,121 +76,125 @@ typeAliases: - '@azure/msal-common.CommonRefreshTokenRequest' - '@azure/msal-common.CommonSilentFlowRequest' - '@azure/msal-common.CommonUsernamePasswordRequest' - - '@azure/msal-common.AuthenticationResult' - - '@azure/msal-common.AuthorizationCodePayload' + - '@azure/msal-common.CredentialEntity' + - '@azure/msal-common.CredentialFilter' + - '@azure/msal-common.CredentialType' - '@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.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.StaticFields' - - '@azure/msal-common.ServerTelemetryRequest' - - '@azure/msal-common.StringDict' - - '@azure/msal-common.LibraryStateObject' - - '@azure/msal-common.RequestStateObject' -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' - - '@azure/msal-common.AccountEntity' - - '@azure/msal-common.AppMetadataEntity' - - '@azure/msal-common.AuthorityMetadataEntity' - - '@azure/msal-common.CacheRecord' - - '@azure/msal-common.CredentialEntity' - - '@azure/msal-common.IdTokenEntity' + - '@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.TokenCacheContext' - - '@azure/msal-common.AuthorizationCodeClient' - - '@azure/msal-common.BaseClient' - - '@azure/msal-common.ClientCredentialClient' - - '@azure/msal-common.DeviceCodeClient' - - '@azure/msal-common.OnBehalfOfClient' - - '@azure/msal-common.RefreshTokenClient' - - '@azure/msal-common.SilentFlowClient' - - '@azure/msal-common.UsernamePasswordClient' - - '@azure/msal-common.JoseHeader' - - '@azure/msal-common.PopTokenGenerator' - - '@azure/msal-common.AuthError' - - '@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' - - '@azure/msal-common.ServerTelemetryManager' - - '@azure/msal-common.UrlString' - - '@azure/msal-common.ProtocolUtils' - - '@azure/msal-common.TimeUtils' -enums: - - '@azure/msal-common.CcsCredentialType' - - '@azure/msal-common.AzureCloudInstance' - - '@azure/msal-common.AuthorityType' - - '@azure/msal-common.ProtocolMode' - - '@azure/msal-common.KeyLocation' - - '@azure/msal-common.LogLevel' - - '@azure/msal-common.PerformanceEventStatus' - - '@azure/msal-common.PerformanceEvents' - - '@azure/msal-common.AADAuthorityConstants' - - '@azure/msal-common.AADServerParamKeys' - - '@azure/msal-common.AuthenticationScheme' - - '@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' - - '@azure/msal-common.GrantType' - - '@azure/msal-common.HeaderNames' - - '@azure/msal-common.JsonTypes' - - '@azure/msal-common.PasswordGrantConstants' - - '@azure/msal-common.PersistentCacheKeys' - - '@azure/msal-common.RegionDiscoveryOutcomes' - - '@azure/msal-common.RegionDiscoverySources' - - '@azure/msal-common.ResponseCodes' - - '@azure/msal-common.ResponseMode' - - '@azure/msal-common.SSOTypes' - - '@azure/msal-common.Separators' + - '@azure/msal-common.TokenClaims' + - '@azure/msal-common.TokenKeys' functions: - - name: 'buildClientInfo(string, ICrypto)' + - name: >- + buildAccountToCache(CacheManager, Authority, string, (input: string) => + string, TokenClaims, 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, base64Decode: (input: string) => + string, idTokenClaims?: TokenClaims, 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: base64Decode + type: '(input: string) => string' + description: '' + - id: idTokenClaims + type: + 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: '' - isPreview: false isDeprecated: false syntax: content: >- - function buildClientInfo(rawClientInfo: string, crypto: ICrypto): - ClientInfo + function buildClientInfo(rawClientInfo: string, base64Decode: (input: + string) => string): ClientInfo parameters: - id: rawClientInfo type: string description: '' - - id: crypto - type: - description: |+ - + - id: base64Decode + type: '(input: string) => string' + description: '' return: description: '' type: @@ -184,7 +203,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: >- @@ -193,112 +211,266 @@ functions: parameters: - id: homeAccountId type: string - description: |+ - + description: '' return: description: '' type: - - name: isCloudInstanceDiscoveryResponse(object) - uid: '@azure/msal-common.isCloudInstanceDiscoveryResponse' + - name: buildStaticAuthorityOptions(Partial) + uid: '@azure/msal-common.buildStaticAuthorityOptions' package: '@azure/msal-common' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function isCloudInstanceDiscoveryResponse(response: object): boolean' + content: >- + function buildStaticAuthorityOptions(authOptions: + Partial): StaticAuthorityOptions parameters: - - id: response - type: object + - id: authOptions + type: Partial<> description: '' return: description: '' - type: boolean - - name: isOpenIdConfigResponse(object) - uid: '@azure/msal-common.isOpenIdConfigResponse' + type: + - name: buildTenantProfile(string, string, string, TokenClaims) + uid: '@azure/msal-common.buildTenantProfile' + package: '@azure/msal-common' + summary: Build tenant profile + remarks: '' + isDeprecated: false + syntax: + content: >- + function buildTenantProfile(homeAccountId: string, localAccountId: + string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile + parameters: + - id: homeAccountId + type: string + 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: Claims from the ID token + 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: 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' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: - content: 'function isOpenIdConfigResponse(response: object): boolean' + content: 'function formatAuthorityUri(authorityUri: string): string' + parameters: + - id: authorityUri + type: string + description: '' + 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' + 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: response - type: object + - 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: >- - buildClientConfiguration({ clientCredentials: { clientAssertion?: - ClientAssertion, clientSecret?: string }, cryptoImplementation: ICrypto, - libraryInfo: { cpu: string, os: string, sku: string, version: string }, - networkImplementation: INetworkModule, persistencePlugin: ICachePlugin, - serializableCache: ISerializableTokenCache, serverTelemetryManager: - ServerTelemetryManager, storageImplementation: CacheManager, telemetry: { - application: ApplicationTelemetry }, userAuthOptions: { authority: - Authority, azureCloudOptions?: AzureCloudOptions, clientCapabilities?: - Array, clientId: string, skipAuthorityMetadataCache?: boolean }, - userLoggerOption: { correlationId?: string, logLevel?: LogLevel, - loggerCallback?: ILoggerCallback, piiLoggingEnabled?: boolean }, - userSystemOptions: { preventCorsPreflight?: boolean, proxyUrl?: string, - tokenRenewalOffsetSeconds?: number } }) - uid: '@azure/msal-common.buildClientConfiguration' + updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, + string) + uid: '@azure/msal-common.updateAccountTenantProfileData' package: '@azure/msal-common' summary: >- - Function that sets the default options when not explicitly configured from - app developer + Replaces account info that varies by tenant profile sourced from the ID + token claims passed in with the tenant-specific account info remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function buildClientConfiguration(__namedParameters: { - clientCredentials: { clientAssertion?: ClientAssertion, clientSecret?: - string }, cryptoImplementation: ICrypto, libraryInfo: { cpu: string, os: - string, sku: string, version: string }, networkImplementation: - INetworkModule, persistencePlugin: ICachePlugin, serializableCache: - ISerializableTokenCache, serverTelemetryManager: ServerTelemetryManager, - storageImplementation: CacheManager, telemetry: { application: - ApplicationTelemetry }, userAuthOptions: { authority: Authority, - azureCloudOptions?: AzureCloudOptions, clientCapabilities?: - Array, clientId: string, skipAuthorityMetadataCache?: boolean }, - userLoggerOption: { correlationId?: string, logLevel?: LogLevel, - loggerCallback?: ILoggerCallback, piiLoggingEnabled?: boolean }, - userSystemOptions: { preventCorsPreflight?: boolean, proxyUrl?: string, - tokenRenewalOffsetSeconds?: number } }): CommonClientConfiguration + function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, + tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, + idTokenSecret?: string): AccountInfo parameters: - - id: __namedParameters - type: >- - { clientCredentials: { clientAssertion?: ClientAssertion, - clientSecret?: string }, cryptoImplementation: ICrypto, libraryInfo: - { cpu: string, os: string, sku: string, version: string }, - networkImplementation: INetworkModule, persistencePlugin: - ICachePlugin, serializableCache: ISerializableTokenCache, - serverTelemetryManager: ServerTelemetryManager, - storageImplementation: CacheManager, telemetry: { application: - 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, - proxyUrl?: string, tokenRenewalOffsetSeconds?: number } } + - id: baseAccountInfo + type: + description: '' + - id: tenantProfile + type: + description: '' + - id: idTokenClaims + type: + description: '' + - id: idTokenSecret + type: string description: '' return: - description: Configuration - type: -interfaces: - - '@azure/msal-common.DecodedAuthToken' - - '@azure/msal-common.ICacheManager' - - '@azure/msal-common.ICachePlugin' - - '@azure/msal-common.ISerializableTokenCache' - - '@azure/msal-common.IAppTokenProvider' - - '@azure/msal-common.ICrypto' - - '@azure/msal-common.IGuidGenerator' - - '@azure/msal-common.ILoggerCallback' - - '@azure/msal-common.INetworkModule' - - '@azure/msal-common.IPerformanceClient' - - '@azure/msal-common.IPerformanceMeasurement' - - '@azure/msal-common.IUri' + 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/ApiId.yml b/msal/docs-ref-autogen/@azure/msal-node/ApiId.yml deleted file mode 100644 index bbcecba..0000000 --- a/msal/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/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 index 281687f..4018d38 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthorizationCodeRequest.yml @@ -6,6 +6,7 @@ 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. @@ -26,7 +27,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,9 +46,8 @@ summary: >- https://datatracker.ietf.org/doc/html/rfc6819#section-3.6. fullName: AuthorizationCodeRequest remarks: '' -isPreview: false isDeprecated: false -syntax: > +syntax: | type AuthorizationCodeRequest = Partial< Omit< CommonAuthorizationCodeRequest, @@ -58,6 +58,6 @@ syntax: > | "resourceRequestMethod" | "resourceRequestUri" | "requestedClaimsHash" + | "storeInCache" > - > & { code: string, redirectUri: string, scopes: Array, state?: string - } + > & { 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 index 33b526f..bc83f2d 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/AuthorizationUrlRequest.yml @@ -6,6 +6,7 @@ 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. @@ -79,7 +80,6 @@ summary: >- to mitigate replay attacks. fullName: AuthorizationUrlRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type AuthorizationUrlRequest = Partial< @@ -91,5 +91,6 @@ syntax: | | "resourceRequestUri" | "authenticationScheme" | "requestedClaimsHash" + | "storeInCache" > - > & { redirectUri: string, scopes: Array } + > & { 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 index 2e8d7b7..a03550c 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/CacheKVStore.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-node/CacheOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/CacheOptions.yml index d8950f9..c73c0e2 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/CacheOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/CacheOptions.yml @@ -4,10 +4,13 @@ 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: '' -isPreview: false isDeprecated: false syntax: | - type CacheOptions = { cachePlugin?: ICachePlugin } + 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 index 57e0252..bfb41f9 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientApplication.yml @@ -5,19 +5,19 @@ package: '@azure/msal-node' summary: Base abstract class for all ClientApplications - public and confidential fullName: ClientApplication remarks: '' -isPreview: false isDeprecated: false type: class methods: - - name: 'acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)' + - name: acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload) uid: '@azure/msal-node.ClientApplication.acquireTokenByCode' package: '@azure/msal-node' - summary: > + 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 @@ -26,7 +26,6 @@ methods: AuthorizationCodeRequest are the same. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -38,18 +37,19 @@ methods: type: description: '' - id: authCodePayLoad - type: AuthorizationCodePayload + type: description: '' return: description: '' - type: Promise<AuthenticationResult> + type: Promise<> - name: acquireTokenByRefreshToken(RefreshTokenRequest) uid: '@azure/msal-node.ClientApplication.acquireTokenByRefreshToken' package: '@azure/msal-node' - summary: > + 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 @@ -58,26 +58,28 @@ methods: handle the caching and refreshing of tokens automatically. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenByRefreshToken(request: RefreshTokenRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenByUsernamePassword(UsernamePasswordRequest) uid: '@azure/msal-node.ClientApplication.acquireTokenByUsernamePassword' package: '@azure/msal-node' - summary: > + 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. @@ -88,27 +90,29 @@ methods: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: - UsernamePasswordRequest): Promise + UsernamePasswordRequest): Promise parameters: - id: request type: - description: | - UsenamePasswordRequest + description: UsenamePasswordRequest return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenSilent(SilentFlowRequest) uid: '@azure/msal-node.ClientApplication.acquireTokenSilent' package: '@azure/msal-node' - summary: > + 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. @@ -120,32 +124,30 @@ methods: 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 + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: Promise<> - name: clearCache() uid: '@azure/msal-node.ClientApplication.clearCache' package: '@azure/msal-node' summary: Clear the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearCache() - name: getAuthCodeUrl(AuthorizationUrlRequest) uid: '@azure/msal-node.ClientApplication.getAuthCodeUrl' package: '@azure/msal-node' - summary: > + summary: >- Creates the URL of the authorization request, letting the user input credentials and consent to the @@ -154,6 +156,7 @@ methods: application object. + Once the user inputs their credentials and consents, the authority will send a response to the redirect URI @@ -162,7 +165,6 @@ methods: `acquireTokenByCode(AuthorizationCodeRequest)`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -180,19 +182,17 @@ methods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' return: description: '' - type: Logger + type: - name: getTokenCache() uid: '@azure/msal-node.ClientApplication.getTokenCache' package: '@azure/msal-node' summary: Gets the token cache for the application. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): TokenCache' @@ -206,12 +206,10 @@ 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)' parameters: - id: logger - type: Logger - description: | - Logger instance + 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 index f9b8177..cd8f368 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml +++ b/msal/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,31 +15,58 @@ 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' parameters: - id: assertion type: string - description: | - refer https://tools.ietf.org/html/rfc7521 + description: refer https://tools.ietf.org/html/rfc7521 return: description: '' type: - - name: 'fromCertificate(string, string, string)' + - 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 remarks: '' - isPreview: false 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 @@ -50,20 +76,19 @@ methods: description: secret key - id: publicCertificate type: string - description: > + description: >- electronic document provided to prove the ownership of the public key return: description: '' type: - - name: 'getJwt(CryptoProvider, string, string)' + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -78,8 +103,7 @@ methods: description: iss claim - id: jwtAudience type: string - description: | - aud claim + description: aud claim return: description: '' type: string @@ -90,18 +114,15 @@ methods: Extracts the raw certs from a given certificate string and returns them in an array. remarks: '' - isPreview: false isDeprecated: false syntax: - content: >- - static function parseCertificate(publicCertificate: string): - Array + content: 'static function parseCertificate(publicCertificate: string): string[]' parameters: - id: publicCertificate type: string - description: > + description: >- electronic document provided to prove the ownership of the public key return: description: '' - type: Array<string> + type: string[] 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/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..5a6cbd1 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialClient.yml @@ -0,0 +1,190 @@ +### 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: >- + 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' + 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: CommonClientCredentialRequest provided by the developer + 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 index e153153..cd83273 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientCredentialRequest.yml @@ -6,7 +6,9 @@ summary: >- CommonClientCredentialRequest - scopes - Array of scopes the application is requesting - access to. + 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. @@ -17,20 +19,23 @@ 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 fullName: ClientCredentialRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type ClientCredentialRequest = Partial< Omit< CommonClientCredentialRequest, - | "scopes" | "resourceRequestMethod" | "resourceRequestUri" | "requestedClaimsHash" | "clientAssertion" + | "storeInCache" > - > & { clientAssertion?: string, scopes: Array } + > & { clientAssertion?: string | ClientAssertionCallback } diff --git a/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml index a7c7f73..6ec7996 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ConfidentialClientApplication.yml @@ -8,16 +8,16 @@ summary: >- will configure application secrets, client certificates/assertions as applicable fullName: ConfidentialClientApplication remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: ConfidentialClientApplication(Configuration) uid: '@azure/msal-node.ConfidentialClientApplication.constructor' package: '@azure/msal-node' - summary: > + summary: >- Constructor for the ConfidentialClientApplication + Required attributes in the Configuration object are: - clientID: the application ID of your application. You can obtain one by @@ -31,7 +31,7 @@ constructors: In Azure AD, authority is a URL indicating of the form - `https://login.microsoftonline.com/\{Enter_the_Tenant_Info_Here\}` + 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 @@ -49,12 +49,11 @@ constructors: In Azure B2C, authority is of the form - https://\{instance\}/tfp/\{tenant\}/\{policyName\}/ + https://{instance}/tfp/{tenant}/{policyName}/ Full B2C functionality will be available in this library in future versions. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new ConfidentialClientApplication(configuration: Configuration)' @@ -63,15 +62,16 @@ constructors: type: description: '' inheritedMethods: - - name: 'acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)' + - name: acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload) uid: '@azure/msal-node.ConfidentialClientApplication.acquireTokenByCode' package: '@azure/msal-node' - summary: > + 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 @@ -80,7 +80,6 @@ inheritedMethods: AuthorizationCodeRequest are the same. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -92,21 +91,22 @@ inheritedMethods: type: description: '' - id: authCodePayLoad - type: AuthorizationCodePayload + type: description: '' return: description: '' - type: Promise<AuthenticationResult> + 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: > + 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 @@ -115,19 +115,20 @@ inheritedMethods: handle the caching and refreshing of tokens automatically. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenByRefreshToken(request: RefreshTokenRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > inheritanceDescription: >- Inherited From [ClientApplication.acquireTokenByRefreshToken](xref:@azure/msal-node.ClientApplication.acquireTokenByRefreshToken) @@ -135,10 +136,11 @@ inheritedMethods: uid: >- @azure/msal-node.ConfidentialClientApplication.acquireTokenByUsernamePassword package: '@azure/msal-node' - summary: > + 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. @@ -149,30 +151,32 @@ inheritedMethods: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: - UsernamePasswordRequest): Promise + UsernamePasswordRequest): Promise parameters: - id: request type: - description: | - UsenamePasswordRequest + description: UsenamePasswordRequest return: description: '' - type: Promise<AuthenticationResult | null> + 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: > + 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. @@ -184,19 +188,18 @@ inheritedMethods: 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 + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: Promise<> inheritanceDescription: >- Inherited From [ClientApplication.acquireTokenSilent](xref:@azure/msal-node.ClientApplication.acquireTokenSilent) @@ -205,7 +208,6 @@ inheritedMethods: package: '@azure/msal-node' summary: Clear the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearCache() @@ -215,7 +217,7 @@ inheritedMethods: - name: getAuthCodeUrl(AuthorizationUrlRequest) uid: '@azure/msal-node.ConfidentialClientApplication.getAuthCodeUrl' package: '@azure/msal-node' - summary: > + summary: >- Creates the URL of the authorization request, letting the user input credentials and consent to the @@ -224,6 +226,7 @@ inheritedMethods: application object. + Once the user inputs their credentials and consents, the authority will send a response to the redirect URI @@ -232,7 +235,6 @@ inheritedMethods: `acquireTokenByCode(AuthorizationCodeRequest)`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -253,13 +255,12 @@ inheritedMethods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' return: description: '' - type: Logger + type: inheritanceDescription: >- Inherited From [ClientApplication.getLogger](xref:@azure/msal-node.ClientApplication.getLogger) @@ -268,7 +269,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,15 +285,13 @@ 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)' parameters: - id: logger - type: Logger - description: | - Logger instance + type: + description: Logger instance inheritanceDescription: >- Inherited From [ClientApplication.setLogger](xref:@azure/msal-node.ClientApplication.setLogger) @@ -306,25 +304,27 @@ methods: Acquires tokens from the authority for the application (not for an end user). remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenByClientCredential(request: - ClientCredentialRequest): Promise + ClientCredentialRequest): Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenOnBehalfOf(OnBehalfOfRequest) uid: '@azure/msal-node.ConfidentialClientApplication.acquireTokenOnBehalfOf' package: '@azure/msal-node' - summary: > + 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 @@ -341,19 +341,20 @@ 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: >- function acquireTokenOnBehalfOf(request: OnBehalfOfRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: SetAppTokenProvider(IAppTokenProvider) uid: '@azure/msal-node.ConfidentialClientApplication.SetAppTokenProvider' package: '@azure/msal-node' @@ -363,12 +364,11 @@ methods: is meant for Azure SDK to enhance Managed Identity support. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function SetAppTokenProvider(provider: IAppTokenProvider)' parameters: - id: provider - type: IAppTokenProvider + 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 index 2af5a41..8a69ec6 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/Configuration.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/Configuration.yml @@ -6,20 +6,25 @@ 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: '' -isPreview: false isDeprecated: false syntax: | type Configuration = { - auth: NodeAuthOptions, - cache?: CacheOptions, - system?: NodeSystemOptions, - telemetry?: NodeTelemetryOptions, + 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 index e146e10..90ab658 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml @@ -10,34 +10,21 @@ summary: >- Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636). fullName: CryptoProvider remarks: '' -isPreview: false isDeprecated: false type: class -constructors: - - name: CryptoProvider() - uid: '@azure/msal-node.CryptoProvider.constructor' - package: '@azure/msal-node' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: new CryptoProvider() methods: - name: base64Decode(string) uid: '@azure/msal-node.CryptoProvider.base64Decode' package: '@azure/msal-node' summary: Decodes input string from base64. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Decode(input: string): string' parameters: - id: input type: string - description: | - string to be decoded + description: string to be decoded return: description: '' type: string @@ -46,15 +33,24 @@ methods: package: '@azure/msal-node' summary: Encodes input string to base64. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function base64Encode(input: string): string' parameters: - id: input type: string - description: | - string to be encoded + description: string to be encoded + 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 @@ -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,25 +70,34 @@ 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' 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' summary: Generates PKCE codes used in Authorization Code Flow. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function generatePkceCodes(): Promise' return: description: '' - type: Promise<PkceCodes> + type: Promise<> - name: getPublicKeyThumbprint() uid: '@azure/msal-node.CryptoProvider.getPublicKeyThumbprint' package: '@azure/msal-node' @@ -101,7 +105,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 +116,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 +131,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 +144,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/msal/docs-ref-autogen/@azure/msal-node/Deserializer.yml b/msal/docs-ref-autogen/@azure/msal-node/Deserializer.yml deleted file mode 100644 index a6f4cf9..0000000 --- a/msal/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/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..027f5eb --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeClient.yml @@ -0,0 +1,163 @@ +### 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: >- + 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' + 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: developer provided CommonDeviceCodeRequest + 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: developer provided CommonDeviceCodeRequest + 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 index c22e132..a60d470 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/DeviceCodeRequest.yml +++ b/msal/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< @@ -40,8 +42,9 @@ syntax: | | "resourceRequestMethod" | "resourceRequestUri" | "requestedClaimsHash" + | "storeInCache" > > & { - deviceCodeCallback: (response: DeviceCodeResponse) => void, - scopes: Array, + 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 index 8b5867f..890f26a 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/DistributedCachePlugin.yml @@ -2,19 +2,19 @@ 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: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'DistributedCachePlugin(ICacheClient, IPartitionManager)' + - name: DistributedCachePlugin(ICacheClient, IPartitionManager) uid: '@azure/msal-node.DistributedCachePlugin.constructor' package: '@azure/msal-node' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -31,9 +31,8 @@ methods: - name: afterCacheAccess(TokenCacheContext) uid: '@azure/msal-node.DistributedCachePlugin.afterCacheAccess' package: '@azure/msal-node' - summary: '' + summary: Serializes the cache after accessing it remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -41,17 +40,16 @@ methods: Promise parameters: - id: cacheContext - type: TokenCacheContext - description: '' + type: + 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: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -59,8 +57,8 @@ methods: Promise parameters: - id: cacheContext - type: TokenCacheContext - description: '' + type: + description: TokenCacheContext return: description: '' type: Promise<void> diff --git a/msal/docs-ref-autogen/@azure/msal-node/EncodingUtils.yml b/msal/docs-ref-autogen/@azure/msal-node/EncodingUtils.yml deleted file mode 100644 index afcca40..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-node/GuidGenerator.yml b/msal/docs-ref-autogen/@azure/msal-node/GuidGenerator.yml deleted file mode 100644 index e112907..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-node/HashUtils.yml b/msal/docs-ref-autogen/@azure/msal-node/HashUtils.yml deleted file mode 100644 index ced0a5f..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-node/HttpClient.yml b/msal/docs-ref-autogen/@azure/msal-node/HttpClient.yml deleted file mode 100644 index faf2e42..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-node/HttpMethod.yml b/msal/docs-ref-autogen/@azure/msal-node/HttpMethod.yml deleted file mode 100644 index 9ae696c..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-node/HttpStatus.yml b/msal/docs-ref-autogen/@azure/msal-node/HttpStatus.yml deleted file mode 100644 index 63e200d..0000000 --- a/msal/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/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 index 85396c3..69cd46d 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ICacheClient.yml @@ -2,10 +2,9 @@ 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: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,33 +13,31 @@ methods: package: '@azure/msal-node' summary: Retrieve the value from the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function get(key: string): Promise' parameters: - id: key type: string - description: string + description: key of item in the cache return: description: Promise type: Promise<string> - - name: 'set(string, 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: '' - isPreview: false isDeprecated: false syntax: content: 'function set(key: string, value: string): Promise' 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/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 index ae35de8..e3570f4 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/IConfidentialClientApplication.yml +++ b/msal/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,19 +18,20 @@ methods: Acquires tokens from the authority for the application (not for an end user) remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenByClientCredential(request: - ClientCredentialRequest): Promise + ClientCredentialRequest): Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenByCode(AuthorizationCodeRequest) uid: '@azure/msal-node.IConfidentialClientApplication.acquireTokenByCode' package: '@azure/msal-node' @@ -39,7 +39,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: >- @@ -51,7 +50,7 @@ methods: description: '' return: description: '' - type: Promise<AuthenticationResult> + type: Promise<> - name: acquireTokenByRefreshToken(RefreshTokenRequest) uid: '@azure/msal-node.IConfidentialClientApplication.acquireTokenByRefreshToken' package: '@azure/msal-node' @@ -59,19 +58,20 @@ methods: Acquires a token by exchanging the refresh token provided for a new set of tokens remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenByRefreshToken(request: RefreshTokenRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenByUsernamePassword(UsernamePasswordRequest) uid: >- @azure/msal-node.IConfidentialClientApplication.acquireTokenByUsernamePassword @@ -80,37 +80,40 @@ methods: Acquires tokens with password grant by exchanging client applications username and password for credentials remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: - UsernamePasswordRequest): Promise + UsernamePasswordRequest): Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + 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: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenOnBehalfOf(request: OnBehalfOfRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenSilent(SilentFlowRequest) uid: '@azure/msal-node.IConfidentialClientApplication.acquireTokenSilent' package: '@azure/msal-node' @@ -118,25 +121,25 @@ methods: Acquires a token silently when a user specifies the account the token is requested for remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function acquireTokenSilent(request: SilentFlowRequest): - Promise + function acquireTokenSilent(request: SilentFlowRequest): Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: clearCache() uid: '@azure/msal-node.IConfidentialClientApplication.clearCache' package: '@azure/msal-node' summary: Clear the cache remarks: '' - isPreview: false isDeprecated: false syntax: content: function clearCache() @@ -145,7 +148,6 @@ methods: package: '@azure/msal-node' summary: Creates the URL of the authorization request remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -163,19 +165,17 @@ methods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' return: description: '' - type: Logger + type: - name: getTokenCache() uid: '@azure/msal-node.IConfidentialClientApplication.getTokenCache' package: '@azure/msal-node' summary: Gets the token cache for the application remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): TokenCache' @@ -189,13 +189,12 @@ 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)' parameters: - id: provider - type: IAppTokenProvider + type: description: '' - name: setLogger(Logger) uid: '@azure/msal-node.IConfidentialClientApplication.setLogger' @@ -204,11 +203,10 @@ 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)' parameters: - id: logger - type: Logger + type: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-node/LoopbackClient.yml b/msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml similarity index 56% rename from msal/docs-ref-autogen/@azure/msal-node/LoopbackClient.yml rename to msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml index cf68fc5..32e3df9 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/LoopbackClient.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ILoopbackClient.yml @@ -1,43 +1,39 @@ ### 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' return: description: '' type: string - - name: 'listenForAuthCode(string, string)' - uid: '@azure/msal-node.LoopbackClient.listenForAuthCode' + - name: listenForAuthCode(string, string) + 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: >- @@ -52,4 +48,6 @@ methods: description: '' return: description: '' - type: Promise<ServerAuthorizationCodeResponse> + 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..5288d8d --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml @@ -0,0 +1,61 @@ +### 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, timeout?: number): Promise> + parameters: + - id: url + type: string + description: '' + - id: options + type: + description: '' + - id: timeout + 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 index 7dae45a..dc81373 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/IPartitionManager.yml @@ -2,57 +2,48 @@ 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: '' -isPreview: false isDeprecated: false type: interface 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 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function extractKey(accountEntity: AccountEntity): Promise' parameters: - id: accountEntity - type: AccountEntity - description: '' + type: + description: AccountEntity return: description: Promise type: Promise<string> - 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 remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKey(): Promise' diff --git a/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml index 7c42d7a..00496bd 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/IPublicClientApplication.yml +++ b/msal/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: >- @@ -30,25 +28,26 @@ methods: description: '' return: description: '' - type: Promise<AuthenticationResult> + 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: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenByDeviceCode(request: DeviceCodeRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenByRefreshToken(RefreshTokenRequest) uid: '@azure/msal-node.IPublicClientApplication.acquireTokenByRefreshToken' package: '@azure/msal-node' @@ -56,19 +55,20 @@ methods: Acquires a token by exchanging the refresh token provided for a new set of tokens remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenByRefreshToken(request: RefreshTokenRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenByUsernamePassword(UsernamePasswordRequest) uid: '@azure/msal-node.IPublicClientApplication.acquireTokenByUsernamePassword' package: '@azure/msal-node' @@ -76,25 +76,26 @@ methods: Acquires tokens with password grant by exchanging client applications username and password for credentials remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: - UsernamePasswordRequest): Promise + UsernamePasswordRequest): Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenInteractive(InteractiveRequest) uid: '@azure/msal-node.IPublicClientApplication.acquireTokenInteractive' package: '@azure/msal-node' summary: Acquires a token interactively remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -106,7 +107,7 @@ methods: description: '' return: description: '' - type: Promise<AuthenticationResult> + type: Promise<> - name: acquireTokenSilent(SilentFlowRequest) uid: '@azure/msal-node.IPublicClientApplication.acquireTokenSilent' package: '@azure/msal-node' @@ -114,34 +115,42 @@ methods: Acquires a token silently when a user specifies the account the token is requested for remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenSilent(request: SilentFlowRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: Promise<> - name: clearCache() uid: '@azure/msal-node.IPublicClientApplication.clearCache' 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<[]> - 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,19 +168,17 @@ methods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' return: description: '' - type: Logger + type: - name: getTokenCache() uid: '@azure/msal-node.IPublicClientApplication.getTokenCache' package: '@azure/msal-node' summary: Gets the token cache for the application remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getTokenCache(): TokenCache' @@ -185,11 +192,25 @@ 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)' parameters: - id: logger - type: 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 index ecd0cbb..89b0d90 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ITokenCache.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ITokenCache.yml @@ -2,10 +2,9 @@ name: ITokenCache uid: '@azure/msal-node.ITokenCache' package: '@azure/msal-node' -summary: 'Token cache interface for the client, giving access to cache APIs' +summary: Token cache interface for the client, giving access to cache APIs fullName: ITokenCache remarks: '' -isPreview: false isDeprecated: false type: interface methods: @@ -14,61 +13,57 @@ methods: package: '@azure/msal-node' summary: Returns the signed in account matching homeAccountId remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function getAccountByHomeId(homeAccountId: string): Promise + function getAccountByHomeId(homeAccountId: string): Promise parameters: - id: homeAccountId type: string description: '' return: description: '' - type: Promise<AccountInfo | null> + 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: '' - isPreview: false isDeprecated: false syntax: content: >- - function getAccountByLocalId(localAccountId: string): - Promise + function getAccountByLocalId(localAccountId: string): Promise parameters: - id: localAccountId type: string description: '' return: description: '' - type: Promise<AccountInfo | null> + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): Promise' return: description: '' - type: 'Promise<AccountInfo[]>' + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function removeAccount(account: AccountInfo): Promise' parameters: - id: account - type: AccountInfo + type: description: '' return: description: '' 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 index 2a4e83b..e770f60 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/InMemoryCache.yml @@ -5,13 +5,12 @@ 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 = { - accessTokens: AccessTokenCache, - accounts: AccountCache, - appMetadata: AppMetadataCache, - idTokens: IdTokenCache, - refreshTokens: RefreshTokenCache, + 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..1b1111a --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/InteractionRequiredAuthError.yml @@ -0,0 +1,290 @@ +### 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, 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, errorNo?: 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: '' + - id: errorNo + 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: 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' + 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 index c15f707..9e25fcc 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/InteractiveRequest.yml @@ -2,27 +2,41 @@ 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< - AuthorizationUrlRequest, - | "authority" - | "correlationId" - | "claims" - | "azureCloudOptions" - | "account" - | "extraQueryParameters" - | "tokenQueryParameters" - | "extraScopesToConsent" - | "loginHint" - | "prompt" + type InteractiveRequest = Partial< + Omit< + CommonAuthorizationUrlRequest, + "scopes" | "redirectUri" | "requestedClaimsHash" | "storeInCache" + > > & { - errorTemplate?: string, - openBrowser: (url: string) => Promise, - scopes?: Array, - successTemplate?: string, + 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 index 5ee3919..a58259c 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/JsonCache.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/JsonCache.yml @@ -7,13 +7,12 @@ summary: >- instantiation fullName: JsonCache remarks: '' -isPreview: false isDeprecated: false syntax: | type JsonCache = { - AccessToken: Record, - Account: Record, - AppMetadata: Record, - IdToken: Record, - RefreshToken: Record, + 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..77abd28 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityApplication.yml @@ -0,0 +1,55 @@ +### 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<> + - 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/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..7757cdf --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ManagedIdentityRequestParams.yml @@ -0,0 +1,26 @@ +### YamlMime:TSTypeAlias +name: ManagedIdentityRequestParams +uid: '@azure/msal-node.ManagedIdentityRequestParams' +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 + https://management.azure.net or, for Microsoft Graph, + https://graph.microsoft.com/.default +fullName: ManagedIdentityRequestParams +remarks: '' +isDeprecated: false +syntax: | + type ManagedIdentityRequestParams = { + claims?: string + forceRefresh?: boolean + resource: string + } 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/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/NetworkUtils.yml b/msal/docs-ref-autogen/@azure/msal-node/NetworkUtils.yml deleted file mode 100644 index 250722a..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-node/NodeAuthError.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthError.yml deleted file mode 100644 index 3f7be2a..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml index 483fea8..4386638 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeAuthOptions.yml @@ -6,7 +6,7 @@ summary: >- - clientId - Client id of the application. - authority - Url of the authority. If no value is set, defaults - to `https://login.microsoftonline.com/common`. + 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 @@ -16,15 +16,17 @@ 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 - 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. @@ -33,20 +35,24 @@ summary: >- local metadata cache during authority initialization. Defaults to false. fullName: NodeAuthOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type NodeAuthOptions = { - authority?: string, - authorityMetadata?: string, - azureCloudOptions?: AzureCloudOptions, - clientAssertion?: string, - clientCapabilities?: Array, - clientCertificate?: { privateKey: string, thumbprint: string, x5c?: string }, - clientId: string, - clientSecret?: string, - cloudDiscoveryMetadata?: string, - knownAuthorities?: Array, - protocolMode?: ProtocolMode, - skipAuthorityMetadataCache?: boolean, + authority?: string + authorityMetadata?: string + azureCloudOptions?: AzureCloudOptions + clientAssertion?: string | ClientAssertionCallback + clientCapabilities?: string[] + clientCertificate?: { + privateKey: string + thumbprint?: string + thumbprintSha256?: 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/NodeConfiguration.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeConfiguration.yml deleted file mode 100644 index c5d2835..0000000 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeConfiguration.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: NodeConfiguration -uid: '@azure/msal-node.NodeConfiguration' -package: '@azure/msal-node' -summary: '' -fullName: NodeConfiguration -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type NodeConfiguration = { - auth: Required, - cache: CacheOptions, - system: Required, - telemetry: Required, - } 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 0340128..0000000 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeStorage.yml +++ /dev/null @@ -1,1001 +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: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'NodeStorage(Logger, string, ICrypto)' - uid: '@azure/msal-node.NodeStorage.constructor' - package: '@azure/msal-node' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new NodeStorage(logger: Logger, clientId: string, cryptoImpl: ICrypto)' - parameters: - - id: logger - type: Logger - description: '' - - id: clientId - type: string - description: '' - - id: cryptoImpl - type: ICrypto - description: '' -inheritedMethods: - - name: generateAuthorityMetadataCacheKey(string) - uid: '@azure/msal-node.NodeStorage.generateAuthorityMetadataCacheKey' - 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' - parameters: - - id: authority - type: string - description: '' - return: - description: '' - type: string - inheritanceDescription: Inherited From CacheManager.generateAuthorityMetadataCacheKey - - name: getAccountsFilteredBy(AccountFilter) - uid: '@azure/msal-node.NodeStorage.getAccountsFilteredBy' - package: '@azure/msal-node' - summary: >- - retrieve accounts matching all provided filters; if no filter is set, get - all accounts - - 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: >- - function getAccountsFilteredBy(accountFilter?: AccountFilter): - AccountCache - parameters: - - id: accountFilter - type: AccountFilter - description: '' - return: - description: '' - type: AccountCache - inheritanceDescription: Inherited From CacheManager.getAccountsFilteredBy - - name: getAllAccounts() - uid: '@azure/msal-node.NodeStorage.getAllAccounts' - package: '@azure/msal-node' - summary: Returns all accounts in cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAllAccounts(): AccountInfo[]' - return: - description: '' - type: 'AccountInfo[]' - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAppMetadataFilteredBy(filter: AppMetadataFilter): - AppMetadataCache - parameters: - - id: filter - type: AppMetadataFilter - description: |+ - - return: - description: '' - type: AppMetadataCache - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadataByAlias(host: string): - AuthorityMetadataEntity | null - parameters: - - id: host - type: string - description: '' - return: - description: '' - type: AuthorityMetadataEntity | null - inheritanceDescription: Inherited From CacheManager.getAuthorityMetadataByAlias - - name: getCredentialsFilteredBy(CredentialFilter) - uid: '@azure/msal-node.NodeStorage.getCredentialsFilteredBy' - package: '@azure/msal-node' - summary: >- - retrieve credentails matching all provided filters; if no filter is set, - get all credentials - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getCredentialsFilteredBy(filter: CredentialFilter): - CredentialCache - parameters: - - id: filter - type: CredentialFilter - description: '' - return: - description: '' - type: CredentialCache - inheritanceDescription: Inherited From CacheManager.getCredentialsFilteredBy - - name: 'isAppMetadataFOCI(string, string)' - uid: '@azure/msal-node.NodeStorage.isAppMetadataFOCI' - package: '@azure/msal-node' - summary: Return the family_id value associated with FOCI - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function isAppMetadataFOCI(environment: string, clientId: string): - boolean - parameters: - - id: environment - type: string - description: '' - - id: clientId - type: string - description: |+ - - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.isAppMetadataFOCI - - name: 'readAccessTokenFromCache(string, AccountInfo, BaseAuthRequest)' - uid: '@azure/msal-node.NodeStorage.readAccessTokenFromCache' - package: '@azure/msal-node' - summary: Retrieve AccessTokenEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccessTokenFromCache(clientId: string, account: - AccountInfo, request: BaseAuthRequest): AccessTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: AccountInfo - description: '' - - id: request - type: BaseAuthRequest - description: '' - return: - description: '' - type: AccessTokenEntity | null - inheritanceDescription: Inherited From CacheManager.readAccessTokenFromCache - - name: readAccountFromCache(AccountInfo) - uid: '@azure/msal-node.NodeStorage.readAccountFromCache' - package: '@azure/msal-node' - summary: Retrieve AccountEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAccountFromCache(account: AccountInfo): AccountEntity | - null - parameters: - - id: account - type: AccountInfo - description: |+ - - return: - 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: '' - isPreview: false - 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)' - uid: '@azure/msal-node.NodeStorage.readAppMetadataFromCache' - package: '@azure/msal-node' - summary: Retrieve AppMetadataEntity from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readAppMetadataFromCache(environment: string, clientId: - 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)' - uid: '@azure/msal-node.NodeStorage.readCacheRecord' - package: '@azure/msal-node' - summary: Retrieve the cached credentials into a cacherecord - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readCacheRecord(account: AccountInfo, clientId: string, - request: BaseAuthRequest, environment: string): CacheRecord - parameters: - - id: account - type: AccountInfo - description: '' - - id: clientId - type: string - description: '' - - id: request - type: BaseAuthRequest - description: '' - - id: environment - type: string - description: '' - return: - description: '' - type: CacheRecord - inheritanceDescription: Inherited From CacheManager.readCacheRecord - - name: 'readIdTokenFromCache(string, AccountInfo)' - uid: '@azure/msal-node.NodeStorage.readIdTokenFromCache' - package: '@azure/msal-node' - summary: Retrieve IdTokenEntity from cache - remarks: '' - isPreview: false - 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-node.NodeStorage.readRefreshTokenFromCache' - package: '@azure/msal-node' - summary: Helper to retrieve the appropriate refresh token from cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function readRefreshTokenFromCache(clientId: string, account: - AccountInfo, familyRT: boolean): RefreshTokenEntity | null - parameters: - - id: clientId - type: string - description: '' - - id: account - type: AccountInfo - description: '' - - id: familyRT - type: boolean - description: |+ - - return: - description: '' - type: RefreshTokenEntity | null - inheritanceDescription: Inherited From CacheManager.readRefreshTokenFromCache - - name: removeAccount(string) - uid: '@azure/msal-node.NodeStorage.removeAccount' - 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' - parameters: - - id: accountKey - type: string - description: '' - return: - description: '' - type: Promise<boolean> - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAccountContext(account: AccountEntity): Promise' - parameters: - - id: account - type: AccountEntity - description: |+ - - return: - description: '' - type: Promise<boolean> - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAllAccounts(): Promise' - return: - description: '' - type: Promise<boolean> - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function removeAppMetadata(): boolean' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From CacheManager.removeAppMetadata - - name: removeCredential(CredentialEntity) - uid: '@azure/msal-node.NodeStorage.removeCredential' - package: '@azure/msal-node' - summary: returns a boolean if the given credential is removed - remarks: '' - isPreview: false - 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-node.NodeStorage.saveCacheRecord' - package: '@azure/msal-node' - summary: saves a cache record - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function saveCacheRecord(cacheRecord: CacheRecord): Promise' - parameters: - - id: cacheRecord - type: CacheRecord - description: |+ - - 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: '' - isPreview: false - 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: '' - isPreview: false - 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: '' - isPreview: false - 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: '' - isPreview: false - 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: '' - isPreview: false - 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: '' - isPreview: false - 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: '' - isPreview: false - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAccessTokenCredential(accessTokenKey: string): - AccessTokenEntity | null - parameters: - - id: accessTokenKey - type: string - description: | - lookup key to fetch cache type AccessTokenEntity - return: - description: '' - type: AccessTokenEntity | null - - name: getAccount(string) - uid: '@azure/msal-node.NodeStorage.getAccount' - package: '@azure/msal-node' - summary: fetch the account entity - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAccount(accountKey: string): AccountEntity | null' - parameters: - - id: accountKey - type: string - description: | - lookup key to fetch cache type AccountEntity - return: - description: '' - type: AccountEntity | null - - name: getAppMetadata(string) - uid: '@azure/msal-node.NodeStorage.getAppMetadata' - package: '@azure/msal-node' - summary: fetch appMetadata entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAppMetadata(appMetadataKey: string): AppMetadataEntity | - null - parameters: - - id: appMetadataKey - type: string - description: | - lookup key to fetch cache type AppMetadataEntity - return: - description: '' - type: AppMetadataEntity | null - - name: getAuthorityMetadata(string) - uid: '@azure/msal-node.NodeStorage.getAuthorityMetadata' - package: '@azure/msal-node' - summary: fetch authority metadata entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAuthorityMetadata(key: string): AuthorityMetadataEntity | - null - parameters: - - id: key - type: string - description: | - lookup key to fetch cache type AuthorityMetadataEntity - return: - description: '' - type: AuthorityMetadataEntity | null - - name: getAuthorityMetadataKeys() - uid: '@azure/msal-node.NodeStorage.getAuthorityMetadataKeys' - package: '@azure/msal-node' - summary: Get all authority metadata keys - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAuthorityMetadataKeys(): Array' - return: - description: '' - type: Array<string> - - name: getCache() - uid: '@azure/msal-node.NodeStorage.getCache' - package: '@azure/msal-node' - summary: get the current cache key-value store - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getCache(): CacheKVStore' - return: - description: '' - type: - - name: getIdTokenCredential(string) - uid: '@azure/msal-node.NodeStorage.getIdTokenCredential' - package: '@azure/msal-node' - summary: fetch the idToken credential - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getIdTokenCredential(idTokenKey: string): IdTokenEntity | null' - parameters: - - id: idTokenKey - type: string - description: | - lookup key to fetch cache type IdTokenEntity - return: - description: '' - type: IdTokenEntity | null - - name: getInMemoryCache() - uid: '@azure/msal-node.NodeStorage.getInMemoryCache' - package: '@azure/msal-node' - summary: gets the current in memory cache for the client - remarks: '' - isPreview: false - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getItem(key: string): ValidCacheType' - parameters: - - id: key - type: string - description: | - lookup key for the cache entry - return: - description: '' - type: ValidCacheType - - name: getKeys() - uid: '@azure/msal-node.NodeStorage.getKeys' - package: '@azure/msal-node' - summary: Gets all keys in window. - remarks: '' - isPreview: false - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getRefreshTokenCredential(refreshTokenKey: string): - RefreshTokenEntity | null - parameters: - - id: refreshTokenKey - type: string - description: | - lookup key to fetch cache type RefreshTokenEntity - return: - description: '' - type: RefreshTokenEntity | null - - name: getServerTelemetry(string) - uid: '@azure/msal-node.NodeStorage.getServerTelemetry' - package: '@azure/msal-node' - summary: fetch server telemetry entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getServerTelemetry(serverTelemetrykey: string): - ServerTelemetryEntity | null - parameters: - - id: serverTelemetrykey - type: string - description: | - lookup key to fetch cache type ServerTelemetryEntity - return: - description: '' - type: ServerTelemetryEntity | null - - name: getThrottlingCache(string) - uid: '@azure/msal-node.NodeStorage.getThrottlingCache' - package: '@azure/msal-node' - summary: fetch throttling entity from the platform cache - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getThrottlingCache(throttlingCacheKey: string): - ThrottlingEntity | null - parameters: - - id: throttlingCacheKey - type: string - description: | - lookup key to fetch cache type ThrottlingEntity - return: - description: '' - type: ThrottlingEntity | null - - name: inMemoryCacheToCache(InMemoryCache) - uid: '@azure/msal-node.NodeStorage.inMemoryCacheToCache' - package: '@azure/msal-node' - summary: converts inMemoryCache to CacheKVStore - remarks: '' - isPreview: false - 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: '' - isPreview: false - 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: '' - isPreview: false - 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: setAccessTokenCredential(AccessTokenEntity) - uid: '@azure/msal-node.NodeStorage.setAccessTokenCredential' - package: '@azure/msal-node' - summary: set accessToken credential - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAccessTokenCredential(accessToken: AccessTokenEntity)' - parameters: - - id: accessToken - type: AccessTokenEntity - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAccount(account: AccountEntity)' - parameters: - - id: account - type: AccountEntity - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setAppMetadata(appMetadata: AppMetadataEntity)' - parameters: - - id: appMetadata - type: AppMetadataEntity - 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: '' - isPreview: false - 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: AuthorityMetadataEntity - 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: '' - isPreview: false - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setIdTokenCredential(idToken: IdTokenEntity)' - parameters: - - id: idToken - type: IdTokenEntity - 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: '' - isPreview: false - 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: '' - isPreview: false - 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: ValidCacheType - description: | - value of the cache entry - - name: setRefreshTokenCredential(RefreshTokenEntity) - uid: '@azure/msal-node.NodeStorage.setRefreshTokenCredential' - package: '@azure/msal-node' - summary: set refreshToken credential - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)' - parameters: - - id: refreshToken - type: RefreshTokenEntity - 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: '' - isPreview: false - 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: ServerTelemetryEntity - 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: '' - isPreview: false - 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: ThrottlingEntity - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function updateCredentialCacheKey(currentCacheKey: string, credential: - ValidCredentialType): string - parameters: - - id: currentCacheKey - type: string - description: '' - - id: credential - type: ValidCredentialType - description: '' - return: - description: '' - type: string -extends: CacheManager diff --git a/msal/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml b/msal/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml index 19414c9..c34159e 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/NodeSystemOptions.yml @@ -5,6 +5,7 @@ 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 @@ -12,11 +13,12 @@ summary: >- calls. Defaults to using MSAL's default http client. fullName: NodeSystemOptions remarks: '' -isPreview: false isDeprecated: false syntax: | type NodeSystemOptions = { - loggerOptions?: LoggerOptions, - networkClient?: INetworkModule, - proxyUrl?: string, + 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 index cfed5d2..b3baed5 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/NodeTelemetryOptions.yml +++ b/msal/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/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..ed68a7f --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfClient.yml @@ -0,0 +1,142 @@ +### 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: >- + 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' + 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: developer provided CommonOnBehalfOfRequest + 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 index 43656b7..8512e7e 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/OnBehalfOfRequest.yml +++ b/msal/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< @@ -30,5 +32,6 @@ syntax: | | "resourceRequestMethod" | "resourceRequestUri" | "requestedClaimsHash" + | "storeInCache" > - > & { oboAssertion: string, scopes: Array } + > & { oboAssertion: string; scopes: string[] } diff --git a/msal/docs-ref-autogen/@azure/msal-node/PkceGenerator.yml b/msal/docs-ref-autogen/@azure/msal-node/PkceGenerator.yml deleted file mode 100644 index 7531db0..0000000 --- a/msal/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/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/ProxyStatus.yml b/msal/docs-ref-autogen/@azure/msal-node/ProxyStatus.yml deleted file mode 100644 index b1edeef..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml b/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml index 11f924c..1645490 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/PublicClientApplication.yml @@ -10,14 +10,13 @@ summary: >- request tokens in the name of an user. fullName: PublicClientApplication remarks: '' -isPreview: false isDeprecated: false type: class constructors: - name: PublicClientApplication(Configuration) uid: '@azure/msal-node.PublicClientApplication.constructor' package: '@azure/msal-node' - summary: > + summary: >- Important attributes in the Configuration object for auth are: - clientID: the application ID of your application. You can obtain one by @@ -25,8 +24,9 @@ constructors: - authority: the authority URL for your application. + AAD authorities are of the form - https://login.microsoftonline.com/\{Enter_the_Tenant_Info_Here\}. + 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 @@ -44,7 +44,7 @@ constructors: Azure B2C authorities are of the form - https://\{instance\}/\{tenant\}/\{policy\}. Each policy is considered + 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 @@ -52,9 +52,8 @@ constructors: construction. - ADFS authorities are of the form https://\{instance\}/adfs. + ADFS authorities are of the form https://{instance}/adfs. remarks: '' - isPreview: false isDeprecated: false syntax: content: 'new PublicClientApplication(configuration: Configuration)' @@ -63,15 +62,16 @@ constructors: type: description: '' inheritedMethods: - - name: 'acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)' + - name: acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload) uid: '@azure/msal-node.PublicClientApplication.acquireTokenByCode' package: '@azure/msal-node' - summary: > + 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 @@ -80,7 +80,6 @@ inheritedMethods: AuthorizationCodeRequest are the same. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -92,21 +91,22 @@ inheritedMethods: type: description: '' - id: authCodePayLoad - type: AuthorizationCodePayload + type: description: '' return: description: '' - type: Promise<AuthenticationResult> + 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: > + 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 @@ -115,29 +115,31 @@ inheritedMethods: handle the caching and refreshing of tokens automatically. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenByRefreshToken(request: RefreshTokenRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + 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: > + 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. @@ -148,63 +150,29 @@ inheritedMethods: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword remarks: '' - isPreview: false - isDeprecated: false + isDeprecated: true + customDeprecatedMessage: '- Use a more secure flow instead' syntax: content: >- function acquireTokenByUsernamePassword(request: - UsernamePasswordRequest): Promise + UsernamePasswordRequest): Promise parameters: - id: request type: - description: | - UsenamePasswordRequest + description: UsenamePasswordRequest return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > 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() @@ -214,7 +182,7 @@ inheritedMethods: - name: getAuthCodeUrl(AuthorizationUrlRequest) uid: '@azure/msal-node.PublicClientApplication.getAuthCodeUrl' package: '@azure/msal-node' - summary: > + summary: >- Creates the URL of the authorization request, letting the user input credentials and consent to the @@ -223,6 +191,7 @@ inheritedMethods: application object. + Once the user inputs their credentials and consents, the authority will send a response to the redirect URI @@ -231,7 +200,6 @@ inheritedMethods: `acquireTokenByCode(AuthorizationCodeRequest)`. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -252,13 +220,12 @@ inheritedMethods: package: '@azure/msal-node' summary: Returns the logger instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getLogger(): Logger' return: description: '' - type: Logger + type: inheritanceDescription: >- Inherited From [ClientApplication.getLogger](xref:@azure/msal-node.ClientApplication.getLogger) @@ -267,7 +234,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,15 +250,13 @@ 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)' parameters: - id: logger - type: Logger - description: | - Logger instance + type: + description: Logger instance inheritanceDescription: >- Inherited From [ClientApplication.setLogger](xref:@azure/msal-node.ClientApplication.setLogger) @@ -320,27 +284,27 @@ methods: until the end-user completes input of credentials. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function acquireTokenByDeviceCode(request: DeviceCodeRequest): - Promise + Promise parameters: - id: request type: description: '' return: description: '' - type: Promise<AuthenticationResult | null> + type: >- + Promise<null | > - name: acquireTokenInteractive(InteractiveRequest) 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: >- @@ -352,5 +316,53 @@ methods: description: '' return: description: '' - type: Promise<AuthenticationResult> + 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: developer provided SilentFlowRequest + 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: developer provided SignOutRequest + 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 index 85a45c1..eb35667 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/RefreshTokenRequest.yml +++ b/msal/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< @@ -39,5 +38,6 @@ syntax: | | "resourceRequestMethod" | "resourceRequestUri" | "requestedClaimsHash" + | "storeInCache" > - > & { forceCache?: boolean, refreshToken: string, scopes: Array } + > & { 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 index e2a33f6..3822f6f 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedAccessTokenEntity.yml @@ -5,23 +5,23 @@ package: '@azure/msal-node' summary: Access token credential type fullName: SerializedAccessTokenEntity remarks: '' -isPreview: false 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, + 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 index 814e487..defecdf 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedAccountEntity.yml @@ -5,18 +5,18 @@ package: '@azure/msal-node' summary: Account type fullName: SerializedAccountEntity remarks: '' -isPreview: false 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, - username: string, + 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 index 8f3fa99..8a2b612 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedAppMetadataEntity.yml @@ -5,11 +5,10 @@ package: '@azure/msal-node' summary: AppMetadata type fullName: SerializedAppMetadataEntity remarks: '' -isPreview: false isDeprecated: false syntax: | type SerializedAppMetadataEntity = { - client_id: string, - environment: string, - family_id?: string, + 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 index f51f41e..928aefc 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedIdTokenEntity.yml @@ -5,14 +5,13 @@ package: '@azure/msal-node' summary: Idtoken credential type fullName: SerializedIdTokenEntity remarks: '' -isPreview: false isDeprecated: false syntax: | type SerializedIdTokenEntity = { - client_id: string, - credential_type: string, - environment: string, - home_account_id: string, - realm: string, - secret: string, + 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 index a411297..e7bb552 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/SerializedRefreshTokenEntity.yml @@ -5,16 +5,15 @@ package: '@azure/msal-node' summary: Refresh token credential type fullName: SerializedRefreshTokenEntity remarks: '' -isPreview: false 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, + 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/Serializer.yml b/msal/docs-ref-autogen/@azure/msal-node/Serializer.yml deleted file mode 100644 index 6493768..0000000 --- a/msal/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/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..9a9a712 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ServerAuthorizationCodeResponse.yml @@ -0,0 +1,33 @@ +### 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 + error_uri?: 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..470fc39 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/ServerError.yml @@ -0,0 +1,239 @@ +### 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, string, number) + uid: '@azure/msal-node.ServerError.constructor' + package: '@azure/msal-node' + summary: '' + remarks: '' + isDeprecated: false + syntax: + content: >- + new ServerError(errorCode?: string, errorMessage?: string, subError?: + string, errorNo?: string, status?: number) + parameters: + - id: errorCode + type: string + description: '' + - id: errorMessage + type: string + description: '' + - id: subError + type: string + description: '' + - id: errorNo + type: string + description: '' + - id: status + type: number + 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 + - 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' + 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 index 43458ef..0ae339c 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/SilentFlowRequest.yml +++ b/msal/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,16 +27,11 @@ summary: >- true. fullName: SilentFlowRequest remarks: '' -isPreview: false isDeprecated: false syntax: | type SilentFlowRequest = Partial< Omit< CommonSilentFlowRequest, - | "account" - | "scopes" - | "resourceRequestMethod" - | "resourceRequestUri" - | "requestedClaimsHash" + "account" | "scopes" | "requestedClaimsHash" | "storeInCache" > - > & { account: AccountInfo, scopes: Array } + > & { 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 index cfb8238..889f1f2 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/TokenCache.yml @@ -5,16 +5,14 @@ package: '@azure/msal-node' summary: In-memory token cache manager fullName: TokenCache remarks: '' -isPreview: false isDeprecated: false type: class constructors: - - name: 'TokenCache(NodeStorage, Logger, ICachePlugin)' + - name: TokenCache(NodeStorage, Logger, ICachePlugin) uid: '@azure/msal-node.TokenCache.constructor' package: '@azure/msal-node' summary: '' remarks: '' - isPreview: false isDeprecated: false syntax: content: >- @@ -22,14 +20,27 @@ constructors: ICachePlugin) parameters: - id: storage - type: + type: NodeStorage description: '' - id: logger - type: Logger + type: description: '' - id: cachePlugin - type: ICachePlugin + 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' @@ -38,15 +49,13 @@ 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)' parameters: - id: cache type: string - description: | - blob formatted cache + description: blob formatted cache - name: getAccountByHomeId(string) uid: '@azure/msal-node.TokenCache.getAccountByHomeId' package: '@azure/msal-node' @@ -55,20 +64,18 @@ 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): Promise + function getAccountByHomeId(homeAccountId: string): Promise parameters: - id: homeAccountId type: string - description: | - unique identifier for an account (uid.utid) + description: unique identifier for an account (uid.utid) return: description: '' - type: Promise<AccountInfo | null> + type: Promise<null | > - name: getAccountByLocalId(string) uid: '@azure/msal-node.TokenCache.getAccountByLocalId' package: '@azure/msal-node' @@ -77,39 +84,47 @@ 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): - Promise + function getAccountByLocalId(localAccountId: string): Promise parameters: - id: localAccountId type: string - description: > + description: >- unique identifier of an account (sub/obj when homeAccountId cannot be populated) return: description: '' - type: Promise<AccountInfo | null> + 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: '' - isPreview: false isDeprecated: false syntax: content: 'function getAllAccounts(): Promise' return: description: '' - type: 'Promise<AccountInfo[]>' + 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' summary: Fetches the cache key-value map remarks: '' - isPreview: false isDeprecated: false syntax: content: 'function getKVStore(): CacheKVStore' @@ -123,27 +138,35 @@ 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' 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' 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' parameters: - id: account - type: AccountInfo - description: | - AccountInfo passed by the user + type: + description: AccountInfo passed by the user return: description: '' type: Promise<void> @@ -152,7 +175,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/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..faa40f0 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordClient.yml @@ -0,0 +1,151 @@ +### 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: true +customDeprecatedMessage: '- Use a more secure flow instead' +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: >- + 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' + 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: CommonUsernamePasswordRequest + 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 index a33e7be..97a5811 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/UsernamePasswordRequest.yml @@ -8,6 +8,7 @@ summary: >- 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. @@ -24,9 +25,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< @@ -38,5 +41,6 @@ syntax: | | "username" | "password" | "requestedClaimsHash" + | "storeInCache" > - > & { password: string, scopes: Array, username: string } + > & { 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 index ccf719c..ba446c5 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/index.yml @@ -3,103 +3,80 @@ uid: '@azure/msal-node' name: '@azure/msal-node' summary: '' type: package -interfaces: - - '@azure/msal-node.ITokenCache' - - '@azure/msal-node.ICacheClient' - - '@azure/msal-node.IPartitionManager' - - '@azure/msal-node.IConfidentialClientApplication' - - '@azure/msal-node.IPublicClientApplication' +enums: + - '@azure/msal-node.LogLevel' classes: - - '@azure/msal-node.NodeStorage' - - '@azure/msal-node.TokenCache' - - '@azure/msal-node.DistributedCachePlugin' - - '@azure/msal-node.Deserializer' - - '@azure/msal-node.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.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' + - '@azure/msal-node.DeviceCodeClient' + - '@azure/msal-node.DistributedCachePlugin' + - '@azure/msal-node.InteractionRequiredAuthError' + - '@azure/msal-node.Logger' + - '@azure/msal-node.ManagedIdentityApplication' + - '@azure/msal-node.OnBehalfOfClient' + - '@azure/msal-node.PublicClientApplication' + - '@azure/msal-node.ServerError' + - '@azure/msal-node.TokenCache' + - '@azure/msal-node.TokenCacheContext' + - '@azure/msal-node.UsernamePasswordClient' +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.InMemoryCache' - - '@azure/msal-node.JsonCache' - - '@azure/msal-node.SerializedAccessTokenEntity' - - '@azure/msal-node.SerializedAccountEntity' - - '@azure/msal-node.SerializedAppMetadataEntity' - - '@azure/msal-node.SerializedIdTokenEntity' - - '@azure/msal-node.SerializedRefreshTokenEntity' - '@azure/msal-node.CacheOptions' + - '@azure/msal-node.ClientAssertionCallback' + - '@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.ManagedIdentitySourceNames' + - '@azure/msal-node.NetworkRequestOptions' + - '@azure/msal-node.NetworkResponse' - '@azure/msal-node.NodeAuthOptions' - - '@azure/msal-node.NodeConfiguration' - '@azure/msal-node.NodeSystemOptions' - '@azure/msal-node.NodeTelemetryOptions' - - '@azure/msal-node.AuthorizationCodeRequest' - - '@azure/msal-node.AuthorizationUrlRequest' - - '@azure/msal-node.ClientCredentialRequest' - - '@azure/msal-node.DeviceCodeRequest' - - '@azure/msal-node.InteractiveRequest' - '@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' -functions: - - name: >- - buildAppConfiguration({ auth: { authority?: string, authorityMetadata?: - string, azureCloudOptions?: AzureCloudOptions, clientAssertion?: string, - clientCapabilities?: Array, clientCertificate?: { privateKey: - 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 } }) - 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: >- - function buildAppConfiguration(__namedParameters: { auth: { authority?: - string, authorityMetadata?: string, azureCloudOptions?: - AzureCloudOptions, clientAssertion?: string, clientCapabilities?: - Array, clientCertificate?: { privateKey: 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 } }): NodeConfiguration - parameters: - - id: __namedParameters - type: >- - { auth: { authority?: string, authorityMetadata?: string, - azureCloudOptions?: AzureCloudOptions, clientAssertion?: string, - clientCapabilities?: Array<string>, clientCertificate?: { - 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 } } - 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/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..9473a14 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/internals.yml @@ -0,0 +1,6 @@ +### YamlMime:TSPackage +uid: '@azure/msal-node.internals' +name: internals +type: module +package: '@azure/msal-node' +summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml b/msal/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml index 05a77f4..7e4c9ad 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/AccountIdentifiers.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml b/msal/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml index a868bc3..c6a1ef9 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/AuthenticatedTemplateProps.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-react/FaaCFunction.yml b/msal/docs-ref-autogen/@azure/msal-react/FaaCFunction.yml deleted file mode 100644 index 595649b..0000000 --- a/msal/docs-ref-autogen/@azure/msal-react/FaaCFunction.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: FaaCFunction -uid: '@azure/msal-react.FaaCFunction' -package: '@azure/msal-react' -summary: '' -fullName: FaaCFunction -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type FaaCFunction = (args: T) => React.ReactNode diff --git a/msal/docs-ref-autogen/@azure/msal-react/IMsalContext.yml b/msal/docs-ref-autogen/@azure/msal-react/IMsalContext.yml index 1d33e7c..425fbae 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/IMsalContext.yml +++ b/msal/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,49 +14,45 @@ properties: summary: '' fullName: accounts remarks: '' - isPreview: false isDeprecated: false syntax: content: 'accounts: AccountInfo[]' return: description: '' - type: 'AccountInfo[]' + type: [] - name: inProgress uid: '@azure/msal-react.IMsalContext.inProgress' package: '@azure/msal-react' summary: '' fullName: inProgress remarks: '' - isPreview: false isDeprecated: false syntax: content: 'inProgress: InteractionStatus' return: description: '' - type: InteractionStatus + type: - name: instance uid: '@azure/msal-react.IMsalContext.instance' package: '@azure/msal-react' summary: '' fullName: instance remarks: '' - isPreview: false isDeprecated: false syntax: content: 'instance: IPublicClientApplication' return: description: '' - type: IPublicClientApplication + type: - name: logger uid: '@azure/msal-react.IMsalContext.logger' package: '@azure/msal-react' summary: '' fullName: logger remarks: '' - isPreview: false isDeprecated: false syntax: content: 'logger: Logger' return: description: '' - type: Logger + type: diff --git a/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml b/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml index 22c76ce..a18d407 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationProps.yml @@ -5,14 +5,13 @@ package: '@azure/msal-react' summary: '' fullName: MsalAuthenticationProps remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalAuthenticationProps = PropsWithChildren< AccountIdentifiers & { - authenticationRequest?: PopupRequest | RedirectRequest | SsoSilentRequest, - errorComponent?: React.ElementType, - interactionType: InteractionType, - loadingComponent?: React.ElementType, + 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 index aa6ee5c..5e82dc6 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/MsalAuthenticationResult.yml @@ -5,18 +5,17 @@ package: '@azure/msal-react' summary: '' fullName: MsalAuthenticationResult remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalAuthenticationResult = { acquireToken: ( - callbackInteractionType?: InteractionType | undefined, - callbackRequest?: SilentRequest | undefined - ) => Promise, - error: AuthError | null, + callbackInteractionType?: InteractionType, + callbackRequest?: SilentRequest + ) => Promise + error: AuthError | null login: ( - callbackInteractionType?: InteractionType | undefined, + callbackInteractionType?: InteractionType, callbackRequest?: PopupRequest | RedirectRequest | SilentRequest - ) => Promise, - result: AuthenticationResult | null, + ) => 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 index ee137ae..e9970cb 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/MsalProviderProps.yml @@ -5,9 +5,8 @@ package: '@azure/msal-react' summary: '' fullName: MsalProviderProps remarks: '' -isPreview: false isDeprecated: false syntax: | type MsalProviderProps = PropsWithChildren<{ - instance: IPublicClientApplication, + instance: IPublicClientApplication }> diff --git a/msal/docs-ref-autogen/@azure/msal-react/ReactAuthError.yml b/msal/docs-ref-autogen/@azure/msal-react/ReactAuthError.yml deleted file mode 100644 index 5803204..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal-react/SetComplement.yml b/msal/docs-ref-autogen/@azure/msal-react/SetComplement.yml index 819a124..6de8eff 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/SetComplement.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/SetComplement.yml @@ -3,9 +3,8 @@ name: SetComplement uid: '@azure/msal-react.SetComplement' package: '@azure/msal-react' summary: '' -fullName: 'SetComplement' +fullName: SetComplement remarks: '' -isPreview: false 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 index 753bda5..c7efc07 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/SetDifference.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/SetDifference.yml @@ -3,9 +3,8 @@ name: SetDifference uid: '@azure/msal-react.SetDifference' package: '@azure/msal-react' summary: '' -fullName: 'SetDifference' +fullName: SetDifference remarks: '' -isPreview: false isDeprecated: false syntax: | - type SetDifference = SetDifference + 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 index 1a95714..99a5e40 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/Subtract.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/Subtract.yml @@ -3,9 +3,8 @@ name: Subtract uid: '@azure/msal-react.Subtract' package: '@azure/msal-react' summary: '' -fullName: 'Subtract' +fullName: Subtract remarks: '' -isPreview: false isDeprecated: false syntax: | - type Subtract = Pick> + 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 index ab4f1b1..f205942 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/UnauthenticatedTemplateProps.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml b/msal/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml index 25ac21e..5152bd0 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/WithMsalProps.yml +++ b/msal/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/msal/docs-ref-autogen/@azure/msal-react/index.yml b/msal/docs-ref-autogen/@azure/msal-react/index.yml index bd7d03f..814d5e0 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/index.yml @@ -6,155 +6,185 @@ type: package interfaces: - '@azure/msal-react.IMsalContext' typeAliases: - - '@azure/msal-react.MsalProviderProps' + - '@azure/msal-react.AccountIdentifiers' - '@azure/msal-react.AuthenticatedTemplateProps' - '@azure/msal-react.MsalAuthenticationProps' - - '@azure/msal-react.UnauthenticatedTemplateProps' - - '@azure/msal-react.WithMsalProps' - '@azure/msal-react.MsalAuthenticationResult' - - '@azure/msal-react.AccountIdentifiers' - - '@azure/msal-react.FaaCFunction' + - '@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: 'MsalProvider({ children: any, instance: any })' - uid: '@azure/msal-react.MsalProvider' + - name: >- + AuthenticatedTemplate(PropsWithChildren>>) + uid: '@azure/msal-react.AuthenticatedTemplate' package: '@azure/msal-react' - summary: >- - MSAL context provider component. This must be rendered above any other - components that use MSAL. + summary: Renders child components if user is authenticated remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function MsalProvider(__namedParameters: { children: any, instance: any - }): React.ReactElement + function AuthenticatedTemplate(props: + PropsWithChildren>>): React.ReactElement | null parameters: - - id: __namedParameters - type: '{ children: any, instance: any }' + - id: props + type: >- + PropsWithChildren<Partial<Pick<, "homeAccountId" | + "localAccountId" | "username">>> description: '' return: description: '' - type: + type: | null - name: >- - AuthenticatedTemplate({ children: any, homeAccountId: any, localAccountId: - any, username: any }) - uid: '@azure/msal-react.AuthenticatedTemplate' + MsalAuthenticationTemplate(PropsWithChildren> & { + authenticationRequest?: PopupRequest | RedirectRequest | + Partial>, errorComponent?: any, interactionType: + InteractionType, loadingComponent?: any }>) + uid: '@azure/msal-react.MsalAuthenticationTemplate' package: '@azure/msal-react' - summary: Renders child components if user is authenticated + summary: >- + Attempts to authenticate user if not already authenticated, then renders + child components remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function AuthenticatedTemplate(__namedParameters: { children: any, - homeAccountId: any, localAccountId: any, username: any }): + function MsalAuthenticationTemplate(props: + PropsWithChildren> & { authenticationRequest?: PopupRequest + | RedirectRequest | Partial>, errorComponent?: any, + interactionType: InteractionType, loadingComponent?: any }>): React.ReactElement | null parameters: - - id: __namedParameters + - id: props type: >- - { children: any, homeAccountId: any, localAccountId: any, username: - any } + PropsWithChildren<Partial<Pick<, "homeAccountId" | + "localAccountId" | "username">> & { authenticationRequest?: + PopupRequest | RedirectRequest | + Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | + "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | + "platformBroker">>, errorComponent?: any, interactionType: + InteractionType, loadingComponent?: any }> description: '' return: description: '' type: | null - - name: >- - MsalAuthenticationTemplate({ ErrorComponent: any, LoadingComponent: any, - authenticationRequest: any, children: any, homeAccountId: any, - interactionType: any, localAccountId: any, username: any }) - uid: '@azure/msal-react.MsalAuthenticationTemplate' + - name: 'MsalProvider(PropsWithChildren<{ instance: IPublicClientApplication }>)' + uid: '@azure/msal-react.MsalProvider' package: '@azure/msal-react' summary: >- - Attempts to authenticate user if not already authenticated, then renders - child components + MSAL context provider component. This must be rendered above any other + components that use MSAL. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function MsalAuthenticationTemplate(__namedParameters: { ErrorComponent: - any, LoadingComponent: any, authenticationRequest: any, children: any, - homeAccountId: any, interactionType: any, localAccountId: any, username: - any }): React.ReactElement | null + function MsalProvider(__namedParameters: PropsWithChildren<{ instance: + IPublicClientApplication }>): React.ReactElement parameters: - id: __namedParameters - type: >- - { ErrorComponent: any, LoadingComponent: any, authenticationRequest: - any, children: any, homeAccountId: any, interactionType: any, - localAccountId: any, username: any } + type: 'PropsWithChildren<{ instance: IPublicClientApplication }>' description: '' return: description: '' - type: | null + type: - name: >- - UnauthenticatedTemplate({ children: any, homeAccountId: any, - localAccountId: any, username: any }) + UnauthenticatedTemplate(PropsWithChildren>>) uid: '@azure/msal-react.UnauthenticatedTemplate' package: '@azure/msal-react' summary: Renders child components if user is unauthenticated remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function UnauthenticatedTemplate(__namedParameters: { children: any, - homeAccountId: any, localAccountId: any, username: any }): - React.ReactElement | null + function UnauthenticatedTemplate(props: + PropsWithChildren>>): React.ReactElement | null parameters: - - id: __namedParameters + - id: props type: >- - { children: any, homeAccountId: any, localAccountId: any, username: - any } + PropsWithChildren<Partial<Pick<, "homeAccountId" | + "localAccountId" | "username">>> description: '' return: description: '' type: | null - - name: useAccount(AccountIdentifiers) + - 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: '' - isPreview: false isDeprecated: false syntax: content: >- - function useAccount(accountIdentifiers?: AccountIdentifiers): - AccountInfo | null + function useAccount(accountIdentifiers?: Partial>): AccountInfo | null parameters: - id: accountIdentifiers - type: - description: |+ - + type: >- + Partial<Pick<, + "homeAccountId" | "localAccountId" | "username">> + description: '' return: description: '' - type: AccountInfo | null - - name: useIsAuthenticated(AccountIdentifiers) + 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: '' - isPreview: false isDeprecated: false syntax: - content: 'function useIsAuthenticated(matchAccount?: AccountIdentifiers): boolean' + content: >- + function useIsAuthenticated(matchAccount?: Partial>): boolean parameters: - id: matchAccount - type: - description: |+ - + 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, AccountIdentifiers) + Partial>, Partial>) uid: '@azure/msal-react.useMsalAuthentication' package: '@azure/msal-react' summary: >- @@ -169,97 +199,55 @@ functions: Optionally provide a specific user that should be logged in. remarks: '' - isPreview: false isDeprecated: false syntax: content: >- function useMsalAuthentication(interactionType: InteractionType, authenticationRequest?: PopupRequest | RedirectRequest | - SsoSilentRequest, accountIdentifiers?: AccountIdentifiers): + Partial>, accountIdentifiers?: Partial>): MsalAuthenticationResult parameters: - id: interactionType - type: InteractionType + type: description: '' - id: authenticationRequest - type: PopupRequest | RedirectRequest | SsoSilentRequest - description: '' - - id: accountIdentifiers - type: - description: |+ - - return: - description: '' - type: - - name: >- - accountArraysAreEqual(Array, - Array) - uid: '@azure/msal-react.accountArraysAreEqual' - package: '@azure/msal-react' - summary: |- - Helper function to determine whether 2 arrays are equal - Used to avoid unnecessary state updates - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function accountArraysAreEqual(arrayA: Array, - arrayB: Array): boolean - parameters: - - id: arrayA - type: Array<> - description: '' - - id: arrayB - type: Array<> - description: |+ - - return: - description: '' - type: boolean - - name: 'getAccountByIdentifiers(AccountInfo[], AccountIdentifiers)' - uid: '@azure/msal-react.getAccountByIdentifiers' - package: '@azure/msal-react' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function getAccountByIdentifiers(allAccounts: AccountInfo[], - accountIdentifiers: AccountIdentifiers): AccountInfo | null - parameters: - - id: allAccounts - type: 'AccountInfo[]' + type: >- + | | + Partial<Omit<, + "responseMode" | "codeChallenge" | "codeChallengeMethod" | + "requestedClaimsHash" | "platformBroker">> description: '' - id: accountIdentifiers - type: + type: >- + Partial<Pick<, + "homeAccountId" | "localAccountId" | "username">> description: '' return: description: '' - type: AccountInfo | null - - name: 'getChildrenOrFunction(React.ReactNode | FaaCFunction, T)' - uid: '@azure/msal-react.getChildrenOrFunction' + type: + - name: withMsal

(ComponentType

) + uid: '@azure/msal-react.withMsal' package: '@azure/msal-react' - summary: '' + summary: >- + Higher order component wraps provided component with msal by injecting + msal context values into the component's props remarks: '' - isPreview: false isDeprecated: false syntax: content: >- - function getChildrenOrFunction(children: React.ReactNode | - FaaCFunction, args: T): React.ReactNode + function withMsal

(Component: ComponentType

): + FunctionComponent> parameters: - - id: children - type: >- - | - description: '' - - id: args - type: T + - id: Component + type: ComponentType<P> description: '' return: description: '' - type: -classes: - - '@azure/msal-react.ReactAuthError' + type: >- + FunctionComponent<<P, + >> diff --git a/msal/docs-ref-autogen/@azure/msal/API_CODE.yml b/msal/docs-ref-autogen/@azure/msal/API_CODE.yml deleted file mode 100644 index 53f801b..0000000 --- a/msal/docs-ref-autogen/@azure/msal/API_CODE.yml +++ /dev/null @@ -1,40 +0,0 @@ -### YamlMime:TSEnum -name: API_CODE -uid: '@azure/msal.API_CODE' -package: '@azure/msal' -summary: '' -fullName: API_CODE -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: AcquireTokenRedirect - uid: '@azure/msal.API_CODE.AcquireTokenRedirect' - package: '@azure/msal' - summary: '' - numericValue: 2001 - - name: AcquireTokenSilent - uid: '@azure/msal.API_CODE.AcquireTokenSilent' - package: '@azure/msal' - summary: '' - numericValue: 2002 - - name: AcquireTokenPopup - uid: '@azure/msal.API_CODE.AcquireTokenPopup' - package: '@azure/msal' - summary: '' - numericValue: 2003 - - name: LoginRedirect - uid: '@azure/msal.API_CODE.LoginRedirect' - package: '@azure/msal' - summary: '' - numericValue: 2004 - - name: LoginPopup - uid: '@azure/msal.API_CODE.LoginPopup' - package: '@azure/msal' - summary: '' - numericValue: 2005 - - name: Logout - uid: '@azure/msal.API_CODE.Logout' - package: '@azure/msal' - summary: '' - numericValue: 2006 diff --git a/msal/docs-ref-autogen/@azure/msal/API_EVENT_IDENTIFIER.yml b/msal/docs-ref-autogen/@azure/msal/API_EVENT_IDENTIFIER.yml deleted file mode 100644 index dbf69e5..0000000 --- a/msal/docs-ref-autogen/@azure/msal/API_EVENT_IDENTIFIER.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSEnum -name: API_EVENT_IDENTIFIER -uid: '@azure/msal.API_EVENT_IDENTIFIER' -package: '@azure/msal' -summary: '' -fullName: API_EVENT_IDENTIFIER -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: AcquireTokenPopup - uid: '@azure/msal.API_EVENT_IDENTIFIER.AcquireTokenPopup' - package: '@azure/msal' - summary: '' - - name: AcquireTokenRedirect - uid: '@azure/msal.API_EVENT_IDENTIFIER.AcquireTokenRedirect' - package: '@azure/msal' - summary: '' - - name: AcquireTokenSilent - uid: '@azure/msal.API_EVENT_IDENTIFIER.AcquireTokenSilent' - package: '@azure/msal' - summary: '' - - name: LoginPopup - uid: '@azure/msal.API_EVENT_IDENTIFIER.LoginPopup' - package: '@azure/msal' - summary: '' - - name: LoginRedirect - uid: '@azure/msal.API_EVENT_IDENTIFIER.LoginRedirect' - package: '@azure/msal' - summary: '' - - name: Logout - uid: '@azure/msal.API_EVENT_IDENTIFIER.Logout' - package: '@azure/msal' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal/Account.yml b/msal/docs-ref-autogen/@azure/msal/Account.yml deleted file mode 100644 index e21fe16..0000000 --- a/msal/docs-ref-autogen/@azure/msal/Account.yml +++ /dev/null @@ -1,180 +0,0 @@ -### YamlMime:TSType -name: Account -uid: '@azure/msal.Account' -package: '@azure/msal' -summary: |- - accountIdentifier combination of idToken.uid and idToken.utid - homeAccountIdentifier combination of clientInfo.uid and clientInfo.utid - userName idToken.preferred_username - name idToken.name - idToken idToken - sid idToken.sid - session identifier - environment idtoken.issuer (the authority that issues the token) -fullName: Account -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'Account(string, string, string, string, StringDict, string, string)' - uid: '@azure/msal.Account.constructor' - package: '@azure/msal' - summary: Creates an Account Object - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new Account(accountIdentifier: string, homeAccountIdentifier: string, - userName: string, name: string, idTokenClaims: StringDict, sid: string, - environment: string) - parameters: - - id: accountIdentifier - type: string - description: '' - - id: homeAccountIdentifier - type: string - description: '' - - id: userName - type: string - description: '' - - id: name - type: string - description: '' - - id: idTokenClaims - type: - description: '' - - id: sid - type: string - description: '' - - id: environment - type: string - description: |+ - -properties: - - name: accountIdentifier - uid: '@azure/msal.Account.accountIdentifier' - package: '@azure/msal' - summary: '' - fullName: accountIdentifier - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'accountIdentifier: string' - return: - description: '' - type: string - - name: environment - uid: '@azure/msal.Account.environment' - package: '@azure/msal' - summary: '' - fullName: environment - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'environment: string' - return: - description: '' - type: string - - name: homeAccountIdentifier - uid: '@azure/msal.Account.homeAccountIdentifier' - package: '@azure/msal' - summary: '' - fullName: homeAccountIdentifier - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'homeAccountIdentifier: string' - return: - description: '' - type: string - - name: idToken - uid: '@azure/msal.Account.idToken' - package: '@azure/msal' - summary: '' - fullName: idToken - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'idToken: StringDict' - return: - description: '' - type: - - name: idTokenClaims - uid: '@azure/msal.Account.idTokenClaims' - package: '@azure/msal' - summary: '' - fullName: idTokenClaims - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'idTokenClaims: StringDict' - return: - description: '' - type: - - name: name - uid: '@azure/msal.Account.name' - package: '@azure/msal' - summary: '' - fullName: name - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - - name: sid - uid: '@azure/msal.Account.sid' - package: '@azure/msal' - summary: '' - fullName: sid - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'sid: string' - return: - description: '' - type: string - - name: userName - uid: '@azure/msal.Account.userName' - package: '@azure/msal' - summary: '' - fullName: userName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userName: string' - return: - description: '' - type: string -methods: - - name: 'compareAccounts(Account, Account)' - uid: '@azure/msal.Account.compareAccounts' - package: '@azure/msal' - summary: >- - 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' - parameters: - - id: a1 - type: - description: '' - - id: a2 - type: - description: '' - return: - description: '' - type: boolean diff --git a/msal/docs-ref-autogen/@azure/msal/ApiEvent.yml b/msal/docs-ref-autogen/@azure/msal/ApiEvent.yml deleted file mode 100644 index 2e2e2dc..0000000 --- a/msal/docs-ref-autogen/@azure/msal/ApiEvent.yml +++ /dev/null @@ -1,285 +0,0 @@ -### YamlMime:TSType -name: ApiEvent -uid: '@azure/msal.ApiEvent' -package: '@azure/msal' -summary: '' -fullName: ApiEvent -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'ApiEvent(string, boolean, API_EVENT_IDENTIFIER)' - uid: '@azure/msal.ApiEvent.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new ApiEvent(correlationId: string, piiEnabled: boolean, - apiEventIdentifier?: API_EVENT_IDENTIFIER) - parameters: - - id: correlationId - type: string - description: '' - - id: piiEnabled - type: boolean - description: '' - - id: apiEventIdentifier - type: - description: '' -properties: - - name: accountId - uid: '@azure/msal.ApiEvent.accountId' - package: '@azure/msal' - summary: '' - fullName: accountId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'accountId: string' - return: - description: '' - type: string - - name: apiCode - uid: '@azure/msal.ApiEvent.apiCode' - package: '@azure/msal' - summary: '' - fullName: apiCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'apiCode: number' - return: - description: '' - type: number - - name: apiErrorCode - uid: '@azure/msal.ApiEvent.apiErrorCode' - package: '@azure/msal' - summary: '' - fullName: apiErrorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'apiErrorCode: string' - return: - description: '' - type: string - - name: apiEventIdentifier - uid: '@azure/msal.ApiEvent.apiEventIdentifier' - package: '@azure/msal' - summary: '' - fullName: apiEventIdentifier - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'apiEventIdentifier: string' - return: - description: '' - type: string - - name: authority - uid: '@azure/msal.ApiEvent.authority' - package: '@azure/msal' - summary: '' - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: string' - return: - description: '' - type: string - - name: authorityType - uid: '@azure/msal.ApiEvent.authorityType' - package: '@azure/msal' - summary: '' - fullName: authorityType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authorityType: string' - return: - description: '' - type: string - - name: loginHint - uid: '@azure/msal.ApiEvent.loginHint' - package: '@azure/msal' - summary: '' - fullName: loginHint - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'loginHint: string' - return: - description: '' - type: string - - name: promptType - uid: '@azure/msal.ApiEvent.promptType' - package: '@azure/msal' - summary: '' - fullName: promptType - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'promptType: string' - return: - description: '' - type: string - - name: tenantId - uid: '@azure/msal.ApiEvent.tenantId' - package: '@azure/msal' - summary: '' - fullName: tenantId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'tenantId: string' - return: - description: '' - type: string - - name: wasSuccessful - uid: '@azure/msal.ApiEvent.wasSuccessful' - package: '@azure/msal' - summary: '' - fullName: wasSuccessful - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'wasSuccessful: boolean' - return: - description: '' - type: boolean -inheritedProperties: - - name: displayName - uid: '@azure/msal.ApiEvent.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.ApiEvent.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.ApiEvent.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.ApiEvent.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.ApiEvent.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.ApiEvent.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.ApiEvent.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.ApiEvent.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/msal/docs-ref-autogen/@azure/msal/AuthError.yml b/msal/docs-ref-autogen/@azure/msal/AuthError.yml deleted file mode 100644 index affd2d6..0000000 --- a/msal/docs-ref-autogen/@azure/msal/AuthError.yml +++ /dev/null @@ -1,144 +0,0 @@ -### YamlMime:TSType -name: AuthError -uid: '@azure/msal.AuthError' -package: '@azure/msal' -summary: General error class thrown by the MSAL.js library. -fullName: AuthError -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'AuthError(string, string)' - uid: '@azure/msal.AuthError.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new AuthError(errorCode: string, errorMessage?: string)' - parameters: - - id: errorCode - type: string - description: '' - - id: errorMessage - type: string - description: '' -properties: - - name: Error - uid: '@azure/msal.AuthError.Error' - package: '@azure/msal' - summary: '' - fullName: Error - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static Error: ErrorConstructor' - return: - description: '' - type: ErrorConstructor - - name: errorCode - uid: '@azure/msal.AuthError.errorCode' - package: '@azure/msal' - summary: '' - fullName: errorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorCode: string' - return: - description: '' - type: string - - name: errorMessage - uid: '@azure/msal.AuthError.errorMessage' - package: '@azure/msal' - summary: '' - fullName: errorMessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage: string' - return: - description: '' - type: string -inheritedProperties: - - name: message - uid: '@azure/msal.AuthError.message' - package: '@azure/msal' - 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.AuthError.name' - package: '@azure/msal' - 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.AuthError.stack' - package: '@azure/msal' - summary: '' - fullName: stack - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack -methods: - - name: createNoWindowObjectError(string) - uid: '@azure/msal.AuthError.createNoWindowObjectError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createNoWindowObjectError(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: - - name: createUnexpectedError(string) - uid: '@azure/msal.AuthError.createUnexpectedError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUnexpectedError(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: -extends: Error diff --git a/msal/docs-ref-autogen/@azure/msal/AuthOptions.yml b/msal/docs-ref-autogen/@azure/msal/AuthOptions.yml deleted file mode 100644 index a55edaf..0000000 --- a/msal/docs-ref-autogen/@azure/msal/AuthOptions.yml +++ /dev/null @@ -1,20 +0,0 @@ -### YamlMime:TSTypeAlias -name: AuthOptions -uid: '@azure/msal.AuthOptions' -package: '@azure/msal' -summary: '' -fullName: AuthOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AuthOptions = { - authority?: string, - authorityMetadata?: string, - clientId: string, - knownAuthorities?: Array, - navigateToLoginRequestUrl?: boolean, - postLogoutRedirectUri?: string | (() => string), - redirectUri?: string | (() => string), - validateAuthority?: boolean, - } diff --git a/msal/docs-ref-autogen/@azure/msal/AuthResponse.yml b/msal/docs-ref-autogen/@azure/msal/AuthResponse.yml deleted file mode 100644 index 70a760b..0000000 --- a/msal/docs-ref-autogen/@azure/msal/AuthResponse.yml +++ /dev/null @@ -1,23 +0,0 @@ -### YamlMime:TSTypeAlias -name: AuthResponse -uid: '@azure/msal.AuthResponse' -package: '@azure/msal' -summary: '' -fullName: AuthResponse -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AuthResponse = { - accessToken: string, - account: Account, - accountState: string, - expiresOn: Date, - fromCache: boolean, - idToken: IdToken, - idTokenClaims: StringDict, - scopes: Array, - tenantId: string, - tokenType: string, - uniqueId: string, - } diff --git a/msal/docs-ref-autogen/@azure/msal/AuthenticationParameters.yml b/msal/docs-ref-autogen/@azure/msal/AuthenticationParameters.yml deleted file mode 100644 index 61c33f1..0000000 --- a/msal/docs-ref-autogen/@azure/msal/AuthenticationParameters.yml +++ /dev/null @@ -1,28 +0,0 @@ -### YamlMime:TSTypeAlias -name: AuthenticationParameters -uid: '@azure/msal.AuthenticationParameters' -package: '@azure/msal' -summary: '' -fullName: AuthenticationParameters -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type AuthenticationParameters = { - account?: Account, - authority?: string, - authorityMetadata?: string, - claimsRequest?: string, - correlationId?: string, - extraQueryParameters?: StringDict, - extraScopesToConsent?: Array, - forceRefresh?: boolean, - loginHint?: string, - onRedirectNavigate?: (url: string) => void | boolean, - prompt?: string, - redirectStartPage?: string, - redirectUri?: string, - scopes?: Array, - sid?: string, - state?: string, - } diff --git a/msal/docs-ref-autogen/@azure/msal/AuthorityFactory.yml b/msal/docs-ref-autogen/@azure/msal/AuthorityFactory.yml deleted file mode 100644 index 1b6951c..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal/CacheLocation.yml b/msal/docs-ref-autogen/@azure/msal/CacheLocation.yml deleted file mode 100644 index 52cd6cc..0000000 --- a/msal/docs-ref-autogen/@azure/msal/CacheLocation.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: CacheLocation -uid: '@azure/msal.CacheLocation' -package: '@azure/msal' -summary: |- - Cache location options supported by MSAL are: - - local storage: MSAL uses browsers local storage to store its cache - - 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/msal/docs-ref-autogen/@azure/msal/CacheOptions.yml b/msal/docs-ref-autogen/@azure/msal/CacheOptions.yml deleted file mode 100644 index 342c119..0000000 --- a/msal/docs-ref-autogen/@azure/msal/CacheOptions.yml +++ /dev/null @@ -1,22 +0,0 @@ -### YamlMime:TSTypeAlias -name: CacheOptions -uid: '@azure/msal.CacheOptions' -package: '@azure/msal' -summary: > - Use this to configure the below cache configuration options: - - - cacheLocation - Used to specify the cacheLocation user wants to - set. Valid values are "localStorage" and "sessionStorage" - - - storeAuthStateInCookie - If set, MSAL store's the auth request state - required for validation of the auth flows in the browser cookies. By default - this flag is set to false. -fullName: CacheOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type CacheOptions = { - cacheLocation?: CacheLocation, - storeAuthStateInCookie?: boolean, - } diff --git a/msal/docs-ref-autogen/@azure/msal/ClientAuthError.yml b/msal/docs-ref-autogen/@azure/msal/ClientAuthError.yml deleted file mode 100644 index a1631aa..0000000 --- a/msal/docs-ref-autogen/@azure/msal/ClientAuthError.yml +++ /dev/null @@ -1,479 +0,0 @@ -### YamlMime:TSType -name: ClientAuthError -uid: '@azure/msal.ClientAuthError' -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: - - name: 'ClientAuthError(string, string)' - uid: '@azure/msal.ClientAuthError.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new ClientAuthError(errorCode: string, errorMessage?: string)' - parameters: - - id: errorCode - type: string - description: '' - - id: errorMessage - type: string - description: '' -inheritedProperties: - - name: errorCode - uid: '@azure/msal.ClientAuthError.errorCode' - package: '@azure/msal' - summary: '' - fullName: errorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorCode: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorCode](xref:@azure/msal.AuthError.errorCode) - - name: errorMessage - uid: '@azure/msal.ClientAuthError.errorMessage' - package: '@azure/msal' - summary: '' - fullName: errorMessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorMessage](xref:@azure/msal.AuthError.errorMessage) - - name: message - uid: '@azure/msal.ClientAuthError.message' - package: '@azure/msal' - 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.ClientAuthError.name' - package: '@azure/msal' - 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.ClientAuthError.stack' - package: '@azure/msal' - summary: '' - fullName: stack - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack -inheritedMethods: - - name: createNoWindowObjectError(string) - uid: '@azure/msal.ClientAuthError.createNoWindowObjectError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createNoWindowObjectError(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [AuthError.createNoWindowObjectError](xref:@azure/msal.AuthError.createNoWindowObjectError) - - name: createUnexpectedError(string) - uid: '@azure/msal.ClientAuthError.createUnexpectedError' - package: '@azure/msal' - summary: '' - 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.AuthError.createUnexpectedError) -methods: - - name: createAcquireTokenInProgressError() - uid: '@azure/msal.ClientAuthError.createAcquireTokenInProgressError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createAcquireTokenInProgressError(): ClientAuthError' - return: - description: '' - type: - - name: createBlockTokenRequestsInHiddenIframeError() - uid: '@azure/msal.ClientAuthError.createBlockTokenRequestsInHiddenIframeError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createBlockTokenRequestsInHiddenIframeError(): - ClientAuthError - return: - description: '' - type: - - name: createCacheParseError(string) - uid: '@azure/msal.ClientAuthError.createCacheParseError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createCacheParseError(key: string): ClientAuthError' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: - - name: createClientInfoDecodingError(string) - uid: '@azure/msal.ClientAuthError.createClientInfoDecodingError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createClientInfoDecodingError(caughtError: string): - ClientAuthError - parameters: - - id: caughtError - type: string - description: '' - return: - description: '' - type: - - name: createClientInfoNotPopulatedError(string) - uid: '@azure/msal.ClientAuthError.createClientInfoNotPopulatedError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createClientInfoNotPopulatedError(caughtError: string): - ClientAuthError - parameters: - - id: caughtError - type: string - description: '' - return: - description: '' - type: - - name: createEndpointResolutionError(string) - uid: '@azure/msal.ClientAuthError.createEndpointResolutionError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createEndpointResolutionError(errDetail?: string): - ClientAuthError - parameters: - - id: errDetail - type: string - description: '' - return: - description: '' - type: - - name: createErrorInCallbackFunction(string) - uid: '@azure/msal.ClientAuthError.createErrorInCallbackFunction' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createErrorInCallbackFunction(errorDesc: string): - ClientAuthError - parameters: - - id: errorDesc - type: string - description: '' - return: - description: '' - type: - - name: createIdTokenNullOrEmptyError(string) - uid: '@azure/msal.ClientAuthError.createIdTokenNullOrEmptyError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createIdTokenNullOrEmptyError(invalidRawTokenString: - string): ClientAuthError - parameters: - - id: invalidRawTokenString - type: string - description: '' - return: - description: '' - type: - - name: createIdTokenParsingError(string) - uid: '@azure/msal.ClientAuthError.createIdTokenParsingError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createIdTokenParsingError(caughtParsingError: string): - ClientAuthError - parameters: - - id: caughtParsingError - type: string - description: '' - return: - description: '' - type: - - name: createInvalidIdTokenError(IdToken) - uid: '@azure/msal.ClientAuthError.createInvalidIdTokenError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidIdTokenError(idToken: IdToken): - ClientAuthError - parameters: - - id: idToken - type: IdToken - description: '' - return: - description: '' - type: - - name: createInvalidInteractionTypeError() - uid: '@azure/msal.ClientAuthError.createInvalidInteractionTypeError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidInteractionTypeError(): ClientAuthError' - return: - description: '' - type: - - name: 'createInvalidStateError(string, string)' - uid: '@azure/msal.ClientAuthError.createInvalidStateError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidStateError(invalidState: string, - actualState: string): ClientAuthError - parameters: - - id: invalidState - type: string - description: '' - - id: actualState - type: string - description: '' - return: - description: '' - type: - - name: createLoginInProgressError() - uid: '@azure/msal.ClientAuthError.createLoginInProgressError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createLoginInProgressError(): ClientAuthError' - return: - description: '' - type: - - name: createMultipleAuthoritiesInCacheError(string) - uid: '@azure/msal.ClientAuthError.createMultipleAuthoritiesInCacheError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createMultipleAuthoritiesInCacheError(scope: string): - ClientAuthError - parameters: - - id: scope - type: string - description: '' - return: - description: '' - type: - - name: 'createNonceMismatchError(string, string)' - uid: '@azure/msal.ClientAuthError.createNonceMismatchError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNonceMismatchError(invalidNonce: string, - actualNonce: string): ClientAuthError - parameters: - - id: invalidNonce - type: string - description: '' - - id: actualNonce - type: string - description: '' - return: - description: '' - type: - - name: createPopupWindowError(string) - uid: '@azure/msal.ClientAuthError.createPopupWindowError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createPopupWindowError(errDetail?: string): - ClientAuthError - parameters: - - id: errDetail - type: string - description: '' - return: - description: '' - type: - - name: createTokenEncodingError(string) - uid: '@azure/msal.ClientAuthError.createTokenEncodingError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createTokenEncodingError(incorrectlyEncodedToken: - string): ClientAuthError - parameters: - - id: incorrectlyEncodedToken - type: string - description: '' - return: - description: '' - type: - - name: createTokenRenewalTimeoutError() - uid: '@azure/msal.ClientAuthError.createTokenRenewalTimeoutError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createTokenRenewalTimeoutError(): ClientAuthError' - return: - description: '' - type: - - name: createUserCancelledError() - uid: '@azure/msal.ClientAuthError.createUserCancelledError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUserCancelledError(): ClientAuthError' - return: - description: '' - type: - - name: createUserDoesNotExistError() - uid: '@azure/msal.ClientAuthError.createUserDoesNotExistError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUserDoesNotExistError(): ClientAuthError' - return: - description: '' - type: - - name: createUserLoginRequiredError() - uid: '@azure/msal.ClientAuthError.createUserLoginRequiredError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUserLoginRequiredError(): ClientAuthError' - return: - description: '' - type: -extends: diff --git a/msal/docs-ref-autogen/@azure/msal/ClientConfigurationError.yml b/msal/docs-ref-autogen/@azure/msal/ClientConfigurationError.yml deleted file mode 100644 index 8ff9de9..0000000 --- a/msal/docs-ref-autogen/@azure/msal/ClientConfigurationError.yml +++ /dev/null @@ -1,813 +0,0 @@ -### YamlMime:TSType -name: ClientConfigurationError -uid: '@azure/msal.ClientConfigurationError' -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: - - name: 'ClientConfigurationError(string, string)' - uid: '@azure/msal.ClientConfigurationError.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new ClientConfigurationError(errorCode: string, errorMessage?: string)' - parameters: - - id: errorCode - type: string - description: '' - - id: errorMessage - type: string - description: '' -inheritedProperties: - - name: errorCode - uid: '@azure/msal.ClientConfigurationError.errorCode' - package: '@azure/msal' - summary: '' - fullName: errorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorCode: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorCode](xref:@azure/msal.AuthError.errorCode) - - name: errorMessage - uid: '@azure/msal.ClientConfigurationError.errorMessage' - package: '@azure/msal' - summary: '' - fullName: errorMessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorMessage](xref:@azure/msal.AuthError.errorMessage) - - name: message - uid: '@azure/msal.ClientConfigurationError.message' - package: '@azure/msal' - 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.ClientConfigurationError.name' - package: '@azure/msal' - 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.ClientConfigurationError.stack' - package: '@azure/msal' - summary: '' - fullName: stack - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack -inheritedMethods: - - name: createAcquireTokenInProgressError() - uid: '@azure/msal.ClientConfigurationError.createAcquireTokenInProgressError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createAcquireTokenInProgressError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createAcquireTokenInProgressError](xref:@azure/msal.ClientAuthError.createAcquireTokenInProgressError) - - name: createBlockTokenRequestsInHiddenIframeError() - uid: >- - @azure/msal.ClientConfigurationError.createBlockTokenRequestsInHiddenIframeError - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createBlockTokenRequestsInHiddenIframeError(): - ClientAuthError - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createBlockTokenRequestsInHiddenIframeError](xref:@azure/msal.ClientAuthError.createBlockTokenRequestsInHiddenIframeError) - - name: createCacheParseError(string) - uid: '@azure/msal.ClientConfigurationError.createCacheParseError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createCacheParseError(key: string): ClientAuthError' - parameters: - - id: key - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createCacheParseError](xref:@azure/msal.ClientAuthError.createCacheParseError) - - name: createClientInfoDecodingError(string) - uid: '@azure/msal.ClientConfigurationError.createClientInfoDecodingError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createClientInfoDecodingError(caughtError: string): - ClientAuthError - parameters: - - id: caughtError - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createClientInfoDecodingError](xref:@azure/msal.ClientAuthError.createClientInfoDecodingError) - - name: createClientInfoNotPopulatedError(string) - uid: '@azure/msal.ClientConfigurationError.createClientInfoNotPopulatedError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createClientInfoNotPopulatedError(caughtError: string): - ClientAuthError - parameters: - - id: caughtError - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createClientInfoNotPopulatedError](xref:@azure/msal.ClientAuthError.createClientInfoNotPopulatedError) - - name: createEndpointResolutionError(string) - uid: '@azure/msal.ClientConfigurationError.createEndpointResolutionError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createEndpointResolutionError(errDetail?: string): - ClientAuthError - parameters: - - id: errDetail - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createEndpointResolutionError](xref:@azure/msal.ClientAuthError.createEndpointResolutionError) - - name: createErrorInCallbackFunction(string) - uid: '@azure/msal.ClientConfigurationError.createErrorInCallbackFunction' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createErrorInCallbackFunction(errorDesc: string): - ClientAuthError - parameters: - - id: errorDesc - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createErrorInCallbackFunction](xref:@azure/msal.ClientAuthError.createErrorInCallbackFunction) - - name: createIdTokenNullOrEmptyError(string) - uid: '@azure/msal.ClientConfigurationError.createIdTokenNullOrEmptyError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createIdTokenNullOrEmptyError(invalidRawTokenString: - string): ClientAuthError - parameters: - - id: invalidRawTokenString - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createIdTokenNullOrEmptyError](xref:@azure/msal.ClientAuthError.createIdTokenNullOrEmptyError) - - name: createIdTokenParsingError(string) - uid: '@azure/msal.ClientConfigurationError.createIdTokenParsingError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createIdTokenParsingError(caughtParsingError: string): - ClientAuthError - parameters: - - id: caughtParsingError - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createIdTokenParsingError](xref:@azure/msal.ClientAuthError.createIdTokenParsingError) - - name: createInvalidIdTokenError(IdToken) - uid: '@azure/msal.ClientConfigurationError.createInvalidIdTokenError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidIdTokenError(idToken: IdToken): - ClientAuthError - parameters: - - id: idToken - type: IdToken - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createInvalidIdTokenError](xref:@azure/msal.ClientAuthError.createInvalidIdTokenError) - - name: createInvalidInteractionTypeError() - uid: '@azure/msal.ClientConfigurationError.createInvalidInteractionTypeError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createInvalidInteractionTypeError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createInvalidInteractionTypeError](xref:@azure/msal.ClientAuthError.createInvalidInteractionTypeError) - - name: 'createInvalidStateError(string, string)' - uid: '@azure/msal.ClientConfigurationError.createInvalidStateError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidStateError(invalidState: string, - actualState: string): ClientAuthError - parameters: - - id: invalidState - type: string - description: '' - - id: actualState - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createInvalidStateError](xref:@azure/msal.ClientAuthError.createInvalidStateError) - - name: createLoginInProgressError() - uid: '@azure/msal.ClientConfigurationError.createLoginInProgressError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createLoginInProgressError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createLoginInProgressError](xref:@azure/msal.ClientAuthError.createLoginInProgressError) - - name: createMultipleAuthoritiesInCacheError(string) - uid: '@azure/msal.ClientConfigurationError.createMultipleAuthoritiesInCacheError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createMultipleAuthoritiesInCacheError(scope: string): - ClientAuthError - parameters: - - id: scope - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createMultipleAuthoritiesInCacheError](xref:@azure/msal.ClientAuthError.createMultipleAuthoritiesInCacheError) - - name: 'createNonceMismatchError(string, string)' - uid: '@azure/msal.ClientConfigurationError.createNonceMismatchError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNonceMismatchError(invalidNonce: string, - actualNonce: string): ClientAuthError - parameters: - - id: invalidNonce - type: string - description: '' - - id: actualNonce - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createNonceMismatchError](xref:@azure/msal.ClientAuthError.createNonceMismatchError) - - name: createNoWindowObjectError(string) - uid: '@azure/msal.ClientConfigurationError.createNoWindowObjectError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createNoWindowObjectError(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [AuthError.createNoWindowObjectError](xref:@azure/msal.AuthError.createNoWindowObjectError) - - name: createPopupWindowError(string) - uid: '@azure/msal.ClientConfigurationError.createPopupWindowError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createPopupWindowError(errDetail?: string): - ClientAuthError - parameters: - - id: errDetail - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createPopupWindowError](xref:@azure/msal.ClientAuthError.createPopupWindowError) - - name: createTokenEncodingError(string) - uid: '@azure/msal.ClientConfigurationError.createTokenEncodingError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createTokenEncodingError(incorrectlyEncodedToken: - string): ClientAuthError - parameters: - - id: incorrectlyEncodedToken - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createTokenEncodingError](xref:@azure/msal.ClientAuthError.createTokenEncodingError) - - name: createTokenRenewalTimeoutError() - uid: '@azure/msal.ClientConfigurationError.createTokenRenewalTimeoutError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createTokenRenewalTimeoutError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createTokenRenewalTimeoutError](xref:@azure/msal.ClientAuthError.createTokenRenewalTimeoutError) - - name: createUnexpectedError(string) - uid: '@azure/msal.ClientConfigurationError.createUnexpectedError' - package: '@azure/msal' - summary: '' - 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.AuthError.createUnexpectedError) - - name: createUserCancelledError() - uid: '@azure/msal.ClientConfigurationError.createUserCancelledError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUserCancelledError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createUserCancelledError](xref:@azure/msal.ClientAuthError.createUserCancelledError) - - name: createUserDoesNotExistError() - uid: '@azure/msal.ClientConfigurationError.createUserDoesNotExistError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUserDoesNotExistError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createUserDoesNotExistError](xref:@azure/msal.ClientAuthError.createUserDoesNotExistError) - - name: createUserLoginRequiredError() - uid: '@azure/msal.ClientConfigurationError.createUserLoginRequiredError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUserLoginRequiredError(): ClientAuthError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ClientAuthError.createUserLoginRequiredError](xref:@azure/msal.ClientAuthError.createUserLoginRequiredError) -methods: - - name: createClaimsRequestParsingError(string) - uid: '@azure/msal.ClientConfigurationError.createClaimsRequestParsingError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createClaimsRequestParsingError(claimsRequestParseError: - string): ClientConfigurationError - parameters: - - id: claimsRequestParseError - type: string - description: '' - return: - description: '' - type: - - name: createEmptyRequestError() - uid: '@azure/msal.ClientConfigurationError.createEmptyRequestError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createEmptyRequestError(): ClientConfigurationError' - return: - description: '' - type: - - name: createEmptyScopesArrayError(string) - uid: '@azure/msal.ClientConfigurationError.createEmptyScopesArrayError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createEmptyScopesArrayError(scopesValue: string): - ClientConfigurationError - parameters: - - id: scopesValue - type: string - description: '' - return: - description: '' - type: - - name: createInvalidAuthorityMetadataError() - uid: '@azure/msal.ClientConfigurationError.createInvalidAuthorityMetadataError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidAuthorityMetadataError(): - ClientConfigurationError - return: - description: '' - type: - - name: createInvalidAuthorityTypeError() - uid: '@azure/msal.ClientConfigurationError.createInvalidAuthorityTypeError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidAuthorityTypeError(): - ClientConfigurationError - return: - description: '' - type: - - name: createInvalidCallbackObjectError(object) - uid: '@azure/msal.ClientConfigurationError.createInvalidCallbackObjectError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidCallbackObjectError(callbackObject: - object): ClientConfigurationError - parameters: - - id: callbackObject - type: object - description: '' - return: - description: '' - type: - - name: createInvalidCorrelationIdError() - uid: '@azure/msal.ClientConfigurationError.createInvalidCorrelationIdError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidCorrelationIdError(): - ClientConfigurationError - return: - description: '' - type: - - name: createInvalidPromptError(any) - uid: '@azure/msal.ClientConfigurationError.createInvalidPromptError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInvalidPromptError(promptValue: any): - ClientConfigurationError - parameters: - - id: promptValue - type: any - description: '' - return: - description: '' - type: - - name: createKnownAuthoritiesNotSetError() - uid: '@azure/msal.ClientConfigurationError.createKnownAuthoritiesNotSetError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createKnownAuthoritiesNotSetError(): - ClientConfigurationError - return: - description: '' - type: - - name: createNoSetConfigurationError() - uid: '@azure/msal.ClientConfigurationError.createNoSetConfigurationError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createNoSetConfigurationError(): - ClientConfigurationError - return: - description: '' - type: - - name: createRedirectCallbacksNotSetError() - uid: '@azure/msal.ClientConfigurationError.createRedirectCallbacksNotSetError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createRedirectCallbacksNotSetError(): - ClientConfigurationError - return: - description: '' - type: - - name: createScopesNonArrayError(string) - uid: '@azure/msal.ClientConfigurationError.createScopesNonArrayError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createScopesNonArrayError(scopesValue: string): - ClientConfigurationError - parameters: - - id: scopesValue - type: string - description: '' - return: - description: '' - type: - - name: createScopesRequiredError(any) - uid: '@azure/msal.ClientConfigurationError.createScopesRequiredError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createScopesRequiredError(scopesValue: any): - ClientConfigurationError - parameters: - - id: scopesValue - type: any - description: '' - return: - description: '' - type: - - name: createSsoSilentError() - uid: '@azure/msal.ClientConfigurationError.createSsoSilentError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createSsoSilentError(): ClientConfigurationError' - return: - description: '' - type: - - name: createStorageNotSupportedError(string) - uid: '@azure/msal.ClientConfigurationError.createStorageNotSupportedError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createStorageNotSupportedError(givenCacheLocation: - string): ClientConfigurationError - parameters: - - id: givenCacheLocation - type: string - description: '' - return: - description: '' - type: - - name: createTelemetryConfigError(TelemetryOptions) - uid: '@azure/msal.ClientConfigurationError.createTelemetryConfigError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createTelemetryConfigError(config: TelemetryOptions): - ClientConfigurationError - parameters: - - id: config - type: - description: '' - return: - description: '' - type: - - name: createUntrustedAuthorityError(string) - uid: '@azure/msal.ClientConfigurationError.createUntrustedAuthorityError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createUntrustedAuthorityError(host: string): - ClientConfigurationError - parameters: - - id: host - type: string - description: '' - return: - description: '' - type: -extends: diff --git a/msal/docs-ref-autogen/@azure/msal/CompletedEvents.yml b/msal/docs-ref-autogen/@azure/msal/CompletedEvents.yml deleted file mode 100644 index ceb00c3..0000000 --- a/msal/docs-ref-autogen/@azure/msal/CompletedEvents.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSType -name: CompletedEvents -uid: '@azure/msal.CompletedEvents' -package: '@azure/msal' -summary: '' -fullName: CompletedEvents -remarks: '' -isPreview: false -isDeprecated: false -type: interface diff --git a/msal/docs-ref-autogen/@azure/msal/Configuration.yml b/msal/docs-ref-autogen/@azure/msal/Configuration.yml deleted file mode 100644 index db8c9e4..0000000 --- a/msal/docs-ref-autogen/@azure/msal/Configuration.yml +++ /dev/null @@ -1,31 +0,0 @@ -### YamlMime:TSTypeAlias -name: Configuration -uid: '@azure/msal.Configuration' -package: '@azure/msal' -summary: > - Use the configuration object to configure MSAL and initialize the - UserAgentApplication. - - This object allows you to configure important elements of MSAL functionality: - - - auth: this is where you configure auth elements like clientID, authority - used for authenticating against the Microsoft Identity Platform - - - cache: this is where you configure cache location and whether to store cache - in cookies - - - system: this is where you can configure the logger, frame timeout etc. - - - framework: this is where you can configure the running mode of angular. More - to come here soon. -fullName: Configuration -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type Configuration = { - auth: AuthOptions, - cache?: CacheOptions, - framework?: FrameworkOptions, - system?: SystemOptions, - } diff --git a/msal/docs-ref-autogen/@azure/msal/DefaultEvent.yml b/msal/docs-ref-autogen/@azure/msal/DefaultEvent.yml deleted file mode 100644 index 6f510e8..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal/ErrorCacheKeys.yml b/msal/docs-ref-autogen/@azure/msal/ErrorCacheKeys.yml deleted file mode 100644 index d30d846..0000000 --- a/msal/docs-ref-autogen/@azure/msal/ErrorCacheKeys.yml +++ /dev/null @@ -1,22 +0,0 @@ -### YamlMime:TSEnum -name: ErrorCacheKeys -uid: '@azure/msal.ErrorCacheKeys' -package: '@azure/msal' -summary: '' -fullName: ErrorCacheKeys -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: ERROR - uid: '@azure/msal.ErrorCacheKeys.ERROR' - package: '@azure/msal' - summary: '' - - name: ERROR_DESC - uid: '@azure/msal.ErrorCacheKeys.ERROR_DESC' - package: '@azure/msal' - summary: '' - - name: LOGIN_ERROR - uid: '@azure/msal.ErrorCacheKeys.LOGIN_ERROR' - package: '@azure/msal' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal/EventCount.yml b/msal/docs-ref-autogen/@azure/msal/EventCount.yml deleted file mode 100644 index 3c8267f..0000000 --- a/msal/docs-ref-autogen/@azure/msal/EventCount.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSType -name: EventCount -uid: '@azure/msal.EventCount' -package: '@azure/msal' -summary: '' -fullName: EventCount -remarks: '' -isPreview: false -isDeprecated: false -type: interface diff --git a/msal/docs-ref-autogen/@azure/msal/EventCountByCorrelationId.yml b/msal/docs-ref-autogen/@azure/msal/EventCountByCorrelationId.yml deleted file mode 100644 index 2965067..0000000 --- a/msal/docs-ref-autogen/@azure/msal/EventCountByCorrelationId.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSType -name: EventCountByCorrelationId -uid: '@azure/msal.EventCountByCorrelationId' -package: '@azure/msal' -summary: '' -fullName: EventCountByCorrelationId -remarks: '' -isPreview: false -isDeprecated: false -type: interface diff --git a/msal/docs-ref-autogen/@azure/msal/FrameworkOptions.yml b/msal/docs-ref-autogen/@azure/msal/FrameworkOptions.yml deleted file mode 100644 index f260908..0000000 --- a/msal/docs-ref-autogen/@azure/msal/FrameworkOptions.yml +++ /dev/null @@ -1,32 +0,0 @@ -### YamlMime:TSTypeAlias -name: FrameworkOptions -uid: '@azure/msal.FrameworkOptions' -package: '@azure/msal' -summary: >+ - App/Framework specific environment support - - - isAngular - flag set to determine if it is Angular Framework. - MSAL uses this to broadcast tokens. More to come here: detangle this - dependency from core. - - - unprotectedResources - Array of URI's which are unprotected resources. - MSAL will not attach a token to outgoing requests that have these URI. - Defaults to 'null'. - - - protectedResourceMap - This is mapping of resources to scopes used by - MSAL for automatically attaching access tokens in web API calls.A single - access token is obtained for the resource. So you can map a specific resource - path as follows: {"https://graph.microsoft.com/v1.0/me", ["user.read"]}, or - the app URL of the resource as: {"https://graph.microsoft.com/", ["user.read", - "mail.send"]}. This is required for CORS calls. - -fullName: FrameworkOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type FrameworkOptions = { - isAngular?: boolean, - protectedResourceMap?: Map>, - unprotectedResources?: Array, - } diff --git a/msal/docs-ref-autogen/@azure/msal/HttpEvent.yml b/msal/docs-ref-autogen/@azure/msal/HttpEvent.yml deleted file mode 100644 index 0c01757..0000000 --- a/msal/docs-ref-autogen/@azure/msal/HttpEvent.yml +++ /dev/null @@ -1,312 +0,0 @@ -### YamlMime:TSType -name: HttpEvent -uid: '@azure/msal.HttpEvent' -package: '@azure/msal' -summary: '' -fullName: HttpEvent -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'HttpEvent(string, string)' - uid: '@azure/msal.HttpEvent.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new HttpEvent(correlationId: string, eventLabel: string)' - parameters: - - id: correlationId - type: string - description: '' - - id: eventLabel - type: string - description: '' -properties: - - name: apiVersion - uid: '@azure/msal.HttpEvent.apiVersion' - package: '@azure/msal' - summary: '' - fullName: apiVersion - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'apiVersion: string' - return: - description: '' - type: string - - name: httpMethod - uid: '@azure/msal.HttpEvent.httpMethod' - package: '@azure/msal' - summary: '' - fullName: httpMethod - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'httpMethod: string' - return: - description: '' - type: string - - name: httpPath - uid: '@azure/msal.HttpEvent.httpPath' - package: '@azure/msal' - summary: '' - fullName: httpPath - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'httpPath: string' - return: - description: '' - type: string - - name: httpResponseStatus - uid: '@azure/msal.HttpEvent.httpResponseStatus' - package: '@azure/msal' - summary: '' - fullName: httpResponseStatus - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'httpResponseStatus: number' - return: - description: '' - type: number - - name: oAuthErrorCode - uid: '@azure/msal.HttpEvent.oAuthErrorCode' - package: '@azure/msal' - summary: '' - fullName: oAuthErrorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'oAuthErrorCode: string' - return: - description: '' - type: string - - name: queryParams - uid: '@azure/msal.HttpEvent.queryParams' - package: '@azure/msal' - summary: '' - fullName: queryParams - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'queryParams: any' - return: - description: '' - type: any - - name: requestIdHeader - uid: '@azure/msal.HttpEvent.requestIdHeader' - package: '@azure/msal' - summary: '' - fullName: requestIdHeader - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'requestIdHeader: string' - return: - description: '' - type: string - - name: serverErrorCode - uid: '@azure/msal.HttpEvent.serverErrorCode' - package: '@azure/msal' - summary: '' - fullName: serverErrorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'serverErrorCode: string' - return: - description: '' - type: string - - name: serverSubErrorCode - uid: '@azure/msal.HttpEvent.serverSubErrorCode' - package: '@azure/msal' - summary: '' - fullName: serverSubErrorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'serverSubErrorCode: string' - return: - description: '' - type: string - - name: speInfo - uid: '@azure/msal.HttpEvent.speInfo' - package: '@azure/msal' - summary: >- - Indicates whether the request was executed on a ring serving SPE traffic. - - An empty string indicates this occurred on an outer ring, and the string - "I" - - indicates the request occurred on the inner ring - fullName: speInfo - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'speInfo: string' - return: - description: '' - type: string - - name: url - uid: '@azure/msal.HttpEvent.url' - package: '@azure/msal' - summary: '' - fullName: url - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'url: string' - return: - description: '' - type: string - - name: userAgent - uid: '@azure/msal.HttpEvent.userAgent' - package: '@azure/msal' - summary: '' - fullName: userAgent - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'userAgent: string' - return: - description: '' - type: string -inheritedProperties: - - name: displayName - uid: '@azure/msal.HttpEvent.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.HttpEvent.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.HttpEvent.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.HttpEvent.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.HttpEvent.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.HttpEvent.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.HttpEvent.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.HttpEvent.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/msal/docs-ref-autogen/@azure/msal/IClientConfigurationErrorMessage.yml b/msal/docs-ref-autogen/@azure/msal/IClientConfigurationErrorMessage.yml deleted file mode 100644 index 7b35917..0000000 --- a/msal/docs-ref-autogen/@azure/msal/IClientConfigurationErrorMessage.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: IClientConfigurationErrorMessage -uid: '@azure/msal.IClientConfigurationErrorMessage' -package: '@azure/msal' -summary: '' -fullName: IClientConfigurationErrorMessage -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: code - uid: '@azure/msal.IClientConfigurationErrorMessage.code' - package: '@azure/msal' - summary: '' - fullName: code - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'code: string' - return: - description: '' - type: string - - name: desc - uid: '@azure/msal.IClientConfigurationErrorMessage.desc' - package: '@azure/msal' - summary: '' - fullName: desc - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'desc: string' - return: - description: '' - type: string diff --git a/msal/docs-ref-autogen/@azure/msal/InProgressEvents.yml b/msal/docs-ref-autogen/@azure/msal/InProgressEvents.yml deleted file mode 100644 index 4342355..0000000 --- a/msal/docs-ref-autogen/@azure/msal/InProgressEvents.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSType -name: InProgressEvents -uid: '@azure/msal.InProgressEvents' -package: '@azure/msal' -summary: '' -fullName: InProgressEvents -remarks: '' -isPreview: false -isDeprecated: false -type: interface diff --git a/msal/docs-ref-autogen/@azure/msal/InteractionRequiredAuthError.yml b/msal/docs-ref-autogen/@azure/msal/InteractionRequiredAuthError.yml deleted file mode 100644 index 13af3c5..0000000 --- a/msal/docs-ref-autogen/@azure/msal/InteractionRequiredAuthError.yml +++ /dev/null @@ -1,252 +0,0 @@ -### YamlMime:TSType -name: InteractionRequiredAuthError -uid: '@azure/msal.InteractionRequiredAuthError' -package: '@azure/msal' -summary: >- - Error thrown when the user is required to perform an interactive token - request. -fullName: InteractionRequiredAuthError -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'InteractionRequiredAuthError(string, string)' - uid: '@azure/msal.InteractionRequiredAuthError.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new InteractionRequiredAuthError(errorCode: string, errorMessage?: - string) - parameters: - - id: errorCode - type: string - description: '' - - id: errorMessage - type: string - description: '' -inheritedProperties: - - name: errorCode - uid: '@azure/msal.InteractionRequiredAuthError.errorCode' - package: '@azure/msal' - summary: '' - fullName: errorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorCode: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorCode](xref:@azure/msal.AuthError.errorCode) - - name: errorMessage - uid: '@azure/msal.InteractionRequiredAuthError.errorMessage' - package: '@azure/msal' - summary: '' - fullName: errorMessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorMessage](xref:@azure/msal.AuthError.errorMessage) - - name: message - uid: '@azure/msal.InteractionRequiredAuthError.message' - package: '@azure/msal' - 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.InteractionRequiredAuthError.name' - package: '@azure/msal' - 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.InteractionRequiredAuthError.stack' - package: '@azure/msal' - summary: '' - fullName: stack - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack -inheritedMethods: - - name: createNoWindowObjectError(string) - uid: '@azure/msal.InteractionRequiredAuthError.createNoWindowObjectError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createNoWindowObjectError(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [AuthError.createNoWindowObjectError](xref:@azure/msal.AuthError.createNoWindowObjectError) - - name: createServerUnavailableError() - uid: '@azure/msal.InteractionRequiredAuthError.createServerUnavailableError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createServerUnavailableError(): ServerError' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ServerError.createServerUnavailableError](xref:@azure/msal.ServerError.createServerUnavailableError) - - name: createUnexpectedError(string) - uid: '@azure/msal.InteractionRequiredAuthError.createUnexpectedError' - package: '@azure/msal' - summary: '' - 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.AuthError.createUnexpectedError) - - name: createUnknownServerError(string) - uid: '@azure/msal.InteractionRequiredAuthError.createUnknownServerError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUnknownServerError(errorDesc: string): ServerError' - parameters: - - id: errorDesc - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [ServerError.createUnknownServerError](xref:@azure/msal.ServerError.createUnknownServerError) -methods: - - name: createConsentRequiredAuthError(string) - uid: '@azure/msal.InteractionRequiredAuthError.createConsentRequiredAuthError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createConsentRequiredAuthError(errorDesc: string): - InteractionRequiredAuthError - parameters: - - id: errorDesc - type: string - description: '' - return: - description: '' - type: - - name: createInteractionRequiredAuthError(string) - uid: >- - @azure/msal.InteractionRequiredAuthError.createInteractionRequiredAuthError - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createInteractionRequiredAuthError(errorDesc: string): - InteractionRequiredAuthError - parameters: - - id: errorDesc - type: string - description: '' - return: - description: '' - type: - - name: createLoginRequiredAuthError(string) - uid: '@azure/msal.InteractionRequiredAuthError.createLoginRequiredAuthError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function createLoginRequiredAuthError(errorDesc: string): - InteractionRequiredAuthError - parameters: - - id: errorDesc - type: string - description: '' - return: - description: '' - type: - - name: isInteractionRequiredError(string) - uid: '@azure/msal.InteractionRequiredAuthError.isInteractionRequiredError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function isInteractionRequiredError(errorString: string): boolean' - parameters: - - id: errorString - type: string - description: '' - return: - description: '' - type: boolean -extends: diff --git a/msal/docs-ref-autogen/@azure/msal/InteractionType.yml b/msal/docs-ref-autogen/@azure/msal/InteractionType.yml deleted file mode 100644 index 9dafdb6..0000000 --- a/msal/docs-ref-autogen/@azure/msal/InteractionType.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: InteractionType -uid: '@azure/msal.InteractionType' -package: '@azure/msal' -summary: '' -fullName: InteractionType -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type InteractionType = - | "redirectInteraction" - | "popupInteraction" - | "silentInteraction" diff --git a/msal/docs-ref-autogen/@azure/msal/LibraryStateObject.yml b/msal/docs-ref-autogen/@azure/msal/LibraryStateObject.yml deleted file mode 100644 index 5812c0c..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal/LogLevel.yml b/msal/docs-ref-autogen/@azure/msal/LogLevel.yml deleted file mode 100644 index 100a058..0000000 --- a/msal/docs-ref-autogen/@azure/msal/LogLevel.yml +++ /dev/null @@ -1,30 +0,0 @@ -### YamlMime:TSEnum -name: LogLevel -uid: '@azure/msal.LogLevel' -package: '@azure/msal' -summary: '' -fullName: LogLevel -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: Error - uid: '@azure/msal.LogLevel.Error' - package: '@azure/msal' - summary: '' - numericValue: 0 - - name: Warning - uid: '@azure/msal.LogLevel.Warning' - package: '@azure/msal' - summary: '' - numericValue: 1 - - name: Info - uid: '@azure/msal.LogLevel.Info' - package: '@azure/msal' - summary: '' - numericValue: 2 - - name: Verbose - uid: '@azure/msal.LogLevel.Verbose' - package: '@azure/msal' - summary: '' - numericValue: 3 diff --git a/msal/docs-ref-autogen/@azure/msal/Logger.yml b/msal/docs-ref-autogen/@azure/msal/Logger.yml deleted file mode 100644 index e9e8856..0000000 --- a/msal/docs-ref-autogen/@azure/msal/Logger.yml +++ /dev/null @@ -1,46 +0,0 @@ -### YamlMime:TSType -name: Logger -uid: '@azure/msal.Logger' -package: '@azure/msal' -summary: '' -fullName: Logger -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: >- - Logger(ILoggerCallback, { correlationId?: string, level?: LogLevel, - piiLoggingEnabled?: boolean }) - uid: '@azure/msal.Logger.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new Logger(localCallback: ILoggerCallback, options?: { correlationId?: - string, level?: LogLevel, piiLoggingEnabled?: boolean }) - parameters: - - id: localCallback - type: - description: '' - - id: options - type: >- - { correlationId?: string, level?: LogLevel, piiLoggingEnabled?: - boolean } - description: '' -methods: - - name: isPiiLoggingEnabled() - uid: '@azure/msal.Logger.isPiiLoggingEnabled' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function isPiiLoggingEnabled(): boolean' - return: - description: '' - type: boolean diff --git a/msal/docs-ref-autogen/@azure/msal/NetworkInformation.yml b/msal/docs-ref-autogen/@azure/msal/NetworkInformation.yml deleted file mode 100644 index 4cb7f52..0000000 --- a/msal/docs-ref-autogen/@azure/msal/NetworkInformation.yml +++ /dev/null @@ -1,24 +0,0 @@ -### YamlMime:TSType -name: NetworkInformation -uid: '@azure/msal.NetworkInformation' -package: '@azure/msal' -summary: '' -fullName: NetworkInformation -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: connectionSpeed - uid: '@azure/msal.NetworkInformation.connectionSpeed' - package: '@azure/msal' - summary: '' - fullName: connectionSpeed - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'connectionSpeed: string' - return: - description: '' - type: string diff --git a/msal/docs-ref-autogen/@azure/msal/OpenIdConfiguration.yml b/msal/docs-ref-autogen/@azure/msal/OpenIdConfiguration.yml deleted file mode 100644 index 51d3fd0..0000000 --- a/msal/docs-ref-autogen/@azure/msal/OpenIdConfiguration.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: OpenIdConfiguration -uid: '@azure/msal.OpenIdConfiguration' -package: '@azure/msal' -summary: Response type for openid-configuration endpoints -fullName: OpenIdConfiguration -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type OpenIdConfiguration = { - authorization_endpoint: string, - end_session_endpoint: string, - issuer: string, - } diff --git a/msal/docs-ref-autogen/@azure/msal/PersistentCacheKeys.yml b/msal/docs-ref-autogen/@azure/msal/PersistentCacheKeys.yml deleted file mode 100644 index d4ee036..0000000 --- a/msal/docs-ref-autogen/@azure/msal/PersistentCacheKeys.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSEnum -name: PersistentCacheKeys -uid: '@azure/msal.PersistentCacheKeys' -package: '@azure/msal' -summary: '' -fullName: PersistentCacheKeys -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: CLIENT_INFO - uid: '@azure/msal.PersistentCacheKeys.CLIENT_INFO' - package: '@azure/msal' - summary: '' - - name: IDTOKEN - uid: '@azure/msal.PersistentCacheKeys.IDTOKEN' - package: '@azure/msal' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal/ScopeSet.yml b/msal/docs-ref-autogen/@azure/msal/ScopeSet.yml deleted file mode 100644 index e235d7a..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal/ServerError.yml b/msal/docs-ref-autogen/@azure/msal/ServerError.yml deleted file mode 100644 index a8c320d..0000000 --- a/msal/docs-ref-autogen/@azure/msal/ServerError.yml +++ /dev/null @@ -1,173 +0,0 @@ -### YamlMime:TSType -name: ServerError -uid: '@azure/msal.ServerError' -package: '@azure/msal' -summary: >- - Error thrown when there is an error with the server code, for example, - unavailability. -fullName: ServerError -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'ServerError(string, string)' - uid: '@azure/msal.ServerError.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new ServerError(errorCode: string, errorMessage?: string)' - parameters: - - id: errorCode - type: string - description: '' - - id: errorMessage - type: string - description: '' -inheritedProperties: - - name: errorCode - uid: '@azure/msal.ServerError.errorCode' - package: '@azure/msal' - summary: '' - fullName: errorCode - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorCode: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorCode](xref:@azure/msal.AuthError.errorCode) - - name: errorMessage - uid: '@azure/msal.ServerError.errorMessage' - package: '@azure/msal' - summary: '' - fullName: errorMessage - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'errorMessage: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [AuthError.errorMessage](xref:@azure/msal.AuthError.errorMessage) - - name: message - uid: '@azure/msal.ServerError.message' - package: '@azure/msal' - 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.ServerError.name' - package: '@azure/msal' - 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.ServerError.stack' - package: '@azure/msal' - summary: '' - fullName: stack - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack -inheritedMethods: - - name: createNoWindowObjectError(string) - uid: '@azure/msal.ServerError.createNoWindowObjectError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createNoWindowObjectError(errDesc: string): AuthError' - parameters: - - id: errDesc - type: string - description: '' - return: - description: '' - type: - inheritanceDescription: >- - Inherited From - [AuthError.createNoWindowObjectError](xref:@azure/msal.AuthError.createNoWindowObjectError) - - name: createUnexpectedError(string) - uid: '@azure/msal.ServerError.createUnexpectedError' - package: '@azure/msal' - summary: '' - 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.AuthError.createUnexpectedError) -methods: - - name: createServerUnavailableError() - uid: '@azure/msal.ServerError.createServerUnavailableError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createServerUnavailableError(): ServerError' - return: - description: '' - type: - - name: createUnknownServerError(string) - uid: '@azure/msal.ServerError.createUnknownServerError' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function createUnknownServerError(errorDesc: string): ServerError' - parameters: - - id: errorDesc - type: string - description: '' - return: - description: '' - type: -extends: diff --git a/msal/docs-ref-autogen/@azure/msal/ServerHashParamKeys.yml b/msal/docs-ref-autogen/@azure/msal/ServerHashParamKeys.yml deleted file mode 100644 index 316033a..0000000 --- a/msal/docs-ref-autogen/@azure/msal/ServerHashParamKeys.yml +++ /dev/null @@ -1,46 +0,0 @@ -### YamlMime:TSEnum -name: ServerHashParamKeys -uid: '@azure/msal.ServerHashParamKeys' -package: '@azure/msal' -summary: Keys in the hashParams -fullName: ServerHashParamKeys -remarks: '' -isPreview: false -isDeprecated: false -fields: - - name: ACCESS_TOKEN - uid: '@azure/msal.ServerHashParamKeys.ACCESS_TOKEN' - package: '@azure/msal' - summary: '' - - name: CLIENT_INFO - uid: '@azure/msal.ServerHashParamKeys.CLIENT_INFO' - package: '@azure/msal' - summary: '' - - name: ERROR - uid: '@azure/msal.ServerHashParamKeys.ERROR' - package: '@azure/msal' - summary: '' - - name: ERROR_DESCRIPTION - uid: '@azure/msal.ServerHashParamKeys.ERROR_DESCRIPTION' - package: '@azure/msal' - summary: '' - - name: EXPIRES_IN - uid: '@azure/msal.ServerHashParamKeys.EXPIRES_IN' - package: '@azure/msal' - summary: '' - - name: ID_TOKEN - uid: '@azure/msal.ServerHashParamKeys.ID_TOKEN' - package: '@azure/msal' - summary: '' - - name: SCOPE - uid: '@azure/msal.ServerHashParamKeys.SCOPE' - package: '@azure/msal' - summary: '' - - name: SESSION_STATE - uid: '@azure/msal.ServerHashParamKeys.SESSION_STATE' - package: '@azure/msal' - summary: '' - - name: STATE - uid: '@azure/msal.ServerHashParamKeys.STATE' - package: '@azure/msal' - summary: '' diff --git a/msal/docs-ref-autogen/@azure/msal/StringDict.yml b/msal/docs-ref-autogen/@azure/msal/StringDict.yml deleted file mode 100644 index 2768fca..0000000 --- a/msal/docs-ref-autogen/@azure/msal/StringDict.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: StringDict -uid: '@azure/msal.StringDict' -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/msal/docs-ref-autogen/@azure/msal/SystemOptions.yml b/msal/docs-ref-autogen/@azure/msal/SystemOptions.yml deleted file mode 100644 index 8a0d1cf..0000000 --- a/msal/docs-ref-autogen/@azure/msal/SystemOptions.yml +++ /dev/null @@ -1,30 +0,0 @@ -### YamlMime:TSTypeAlias -name: SystemOptions -uid: '@azure/msal.SystemOptions' -package: '@azure/msal' -summary: > - Library Specific Options - - - logger - Used to initialize the Logger object; TODO: - Expand on logger details or link to the documentation on logger - - - loadFrameTimeout - maximum time the library should wait for a - frame to load - - - tokenRenewalOffsetSeconds - sets the window of offset needed to renew the - token before expiry - - - navigateFrameWait - sets the wait time for hidden iFrame - navigation -fullName: SystemOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type SystemOptions = { - loadFrameTimeout?: number, - logger?: Logger, - navigateFrameWait?: number, - telemetry?: TelemetryOptions, - tokenRenewalOffsetSeconds?: number, - } diff --git a/msal/docs-ref-autogen/@azure/msal/TelemetryConfig.yml b/msal/docs-ref-autogen/@azure/msal/TelemetryConfig.yml deleted file mode 100644 index d93bd00..0000000 --- a/msal/docs-ref-autogen/@azure/msal/TelemetryConfig.yml +++ /dev/null @@ -1,50 +0,0 @@ -### YamlMime:TSType -name: TelemetryConfig -uid: '@azure/msal.TelemetryConfig' -package: '@azure/msal' -summary: '' -fullName: TelemetryConfig -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: clientId - uid: '@azure/msal.TelemetryConfig.clientId' - package: '@azure/msal' - summary: '' - fullName: clientId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'clientId: string' - return: - description: '' - type: string - - name: onlySendFailureTelemetry - uid: '@azure/msal.TelemetryConfig.onlySendFailureTelemetry' - package: '@azure/msal' - summary: '' - fullName: onlySendFailureTelemetry - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'onlySendFailureTelemetry?: boolean' - return: - description: '' - type: boolean - - name: platform - uid: '@azure/msal.TelemetryConfig.platform' - package: '@azure/msal' - summary: '' - fullName: platform - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'platform: TelemetryPlatform' - return: - description: '' - type: diff --git a/msal/docs-ref-autogen/@azure/msal/TelemetryEmitter.yml b/msal/docs-ref-autogen/@azure/msal/TelemetryEmitter.yml deleted file mode 100644 index 6f01444..0000000 --- a/msal/docs-ref-autogen/@azure/msal/TelemetryEmitter.yml +++ /dev/null @@ -1,11 +0,0 @@ -### YamlMime:TSTypeAlias -name: TelemetryEmitter -uid: '@azure/msal.TelemetryEmitter' -package: '@azure/msal' -summary: '' -fullName: TelemetryEmitter -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type TelemetryEmitter = (events: Array) => void diff --git a/msal/docs-ref-autogen/@azure/msal/TelemetryEvent.yml b/msal/docs-ref-autogen/@azure/msal/TelemetryEvent.yml deleted file mode 100644 index 6ea605e..0000000 --- a/msal/docs-ref-autogen/@azure/msal/TelemetryEvent.yml +++ /dev/null @@ -1,129 +0,0 @@ -### YamlMime:TSType -name: TelemetryEvent -uid: '@azure/msal.TelemetryEvent' -package: '@azure/msal' -summary: '' -fullName: TelemetryEvent -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'TelemetryEvent(string, string, string)' - uid: '@azure/msal.TelemetryEvent.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new TelemetryEvent(eventName: string, correlationId: string, eventLabel: - string) - parameters: - - id: eventName - type: string - description: '' - - id: correlationId - type: string - description: '' - - id: eventLabel - type: string - description: '' -properties: - - name: displayName - uid: '@azure/msal.TelemetryEvent.displayName' - package: '@azure/msal' - summary: '' - fullName: displayName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'displayName: string' - return: - description: '' - type: string - - name: eventId - uid: '@azure/msal.TelemetryEvent.eventId' - package: '@azure/msal' - summary: '' - fullName: eventId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'eventId: string' - return: - description: '' - type: string - - name: eventName - uid: '@azure/msal.TelemetryEvent.eventName' - package: '@azure/msal' - summary: '' - fullName: eventName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'eventName: string' - return: - description: '' - type: string - - name: key - uid: '@azure/msal.TelemetryEvent.key' - package: '@azure/msal' - summary: '' - fullName: key - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'key: string' - return: - description: '' - type: string - - name: telemetryCorrelationId - uid: '@azure/msal.TelemetryEvent.telemetryCorrelationId' - package: '@azure/msal' - summary: '' - fullName: telemetryCorrelationId - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'telemetryCorrelationId: string' - return: - description: '' - type: string -methods: - - name: get() - uid: '@azure/msal.TelemetryEvent.get' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function get(): object' - return: - description: '' - type: object - - name: start() - uid: '@azure/msal.TelemetryEvent.start' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function start() - - name: stop() - uid: '@azure/msal.TelemetryEvent.stop' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: function stop() diff --git a/msal/docs-ref-autogen/@azure/msal/TelemetryManager.yml b/msal/docs-ref-autogen/@azure/msal/TelemetryManager.yml deleted file mode 100644 index ecdf290..0000000 --- a/msal/docs-ref-autogen/@azure/msal/TelemetryManager.yml +++ /dev/null @@ -1,165 +0,0 @@ -### YamlMime:TSType -name: TelemetryManager -uid: '@azure/msal.TelemetryManager' -package: '@azure/msal' -summary: '' -fullName: TelemetryManager -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: 'TelemetryManager(TelemetryConfig, TelemetryEmitter, Logger)' - uid: '@azure/msal.TelemetryManager.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - new TelemetryManager(config: TelemetryConfig, telemetryEmitter: - TelemetryEmitter, logger: Logger) - parameters: - - id: config - type: - description: '' - - id: telemetryEmitter - type: - description: '' - - id: logger - type: - description: '' -methods: - - name: 'createAndStartApiEvent(string, API_EVENT_IDENTIFIER)' - uid: '@azure/msal.TelemetryManager.createAndStartApiEvent' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function createAndStartApiEvent(correlationId: string, - apiEventIdentifier: API_EVENT_IDENTIFIER): ApiEvent - parameters: - - id: correlationId - type: string - description: '' - - id: apiEventIdentifier - type: - description: '' - return: - description: '' - type: - - name: 'createAndStartHttpEvent(string, string, string, string)' - uid: '@azure/msal.TelemetryManager.createAndStartHttpEvent' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function createAndStartHttpEvent(correlation: string, httpMethod: - string, url: string, eventLabel: string): HttpEvent - parameters: - - id: correlation - type: string - description: '' - - id: httpMethod - type: string - description: '' - - id: url - type: string - description: '' - - id: eventLabel - type: string - description: '' - return: - description: '' - type: - - name: flush(string) - uid: '@azure/msal.TelemetryManager.flush' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function flush(correlationId: string)' - parameters: - - id: correlationId - type: string - description: '' - - name: 'getTelemetrymanagerStub(string, Logger)' - uid: '@azure/msal.TelemetryManager.getTelemetrymanagerStub' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - static function getTelemetrymanagerStub(clientId: string, logger: - Logger): TelemetryManager - parameters: - - id: clientId - type: string - description: '' - - id: logger - type: - description: '' - return: - description: '' - type: - - name: startEvent(TelemetryEvent) - uid: '@azure/msal.TelemetryManager.startEvent' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function startEvent(event: TelemetryEvent)' - parameters: - - id: event - type: - description: '' - - name: 'stopAndFlushApiEvent(string, ApiEvent, boolean, string)' - uid: '@azure/msal.TelemetryManager.stopAndFlushApiEvent' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function stopAndFlushApiEvent(correlationId: string, apiEvent: ApiEvent, - wasSuccessful: boolean, errorCode?: string) - parameters: - - id: correlationId - type: string - description: '' - - id: apiEvent - type: - description: '' - - id: wasSuccessful - type: boolean - description: '' - - id: errorCode - type: string - description: '' - - name: stopEvent(TelemetryEvent) - uid: '@azure/msal.TelemetryManager.stopEvent' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function stopEvent(event: TelemetryEvent)' - parameters: - - id: event - type: - description: '' diff --git a/msal/docs-ref-autogen/@azure/msal/TelemetryOptions.yml b/msal/docs-ref-autogen/@azure/msal/TelemetryOptions.yml deleted file mode 100644 index 7fa35a1..0000000 --- a/msal/docs-ref-autogen/@azure/msal/TelemetryOptions.yml +++ /dev/null @@ -1,23 +0,0 @@ -### YamlMime:TSTypeAlias -name: TelemetryOptions -uid: '@azure/msal.TelemetryOptions' -package: '@azure/msal' -summary: >- - Telemetry Config Options - - - applicationName - Name of the consuming apps application - - - applicationVersion - Verison of the consuming application - - - telemetryEmitter - Function where telemetry events are flushed - to -fullName: TelemetryOptions -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type TelemetryOptions = { - applicationName: string, - applicationVersion: string, - telemetryEmitter: TelemetryEmitter, - } diff --git a/msal/docs-ref-autogen/@azure/msal/TelemetryPlatform.yml b/msal/docs-ref-autogen/@azure/msal/TelemetryPlatform.yml deleted file mode 100644 index cb5bd6c..0000000 --- a/msal/docs-ref-autogen/@azure/msal/TelemetryPlatform.yml +++ /dev/null @@ -1,76 +0,0 @@ -### YamlMime:TSType -name: TelemetryPlatform -uid: '@azure/msal.TelemetryPlatform' -package: '@azure/msal' -summary: '' -fullName: TelemetryPlatform -remarks: '' -isPreview: false -isDeprecated: false -type: interface -properties: - - name: applicationName - uid: '@azure/msal.TelemetryPlatform.applicationName' - package: '@azure/msal' - summary: '' - fullName: applicationName - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'applicationName: string' - return: - description: '' - type: string - - name: applicationVersion - uid: '@azure/msal.TelemetryPlatform.applicationVersion' - package: '@azure/msal' - summary: '' - fullName: applicationVersion - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'applicationVersion: string' - return: - description: '' - type: string - - name: networkInformation - uid: '@azure/msal.TelemetryPlatform.networkInformation' - package: '@azure/msal' - summary: '' - fullName: networkInformation - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'networkInformation?: NetworkInformation' - return: - description: '' - type: - - name: sdk - uid: '@azure/msal.TelemetryPlatform.sdk' - package: '@azure/msal' - summary: '' - fullName: sdk - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'sdk?: string' - return: - description: '' - type: string - - name: sdkVersion - uid: '@azure/msal.TelemetryPlatform.sdkVersion' - package: '@azure/msal' - summary: '' - fullName: sdkVersion - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'sdkVersion?: string' - return: - description: '' - type: string diff --git a/msal/docs-ref-autogen/@azure/msal/TrustedAuthority.yml b/msal/docs-ref-autogen/@azure/msal/TrustedAuthority.yml deleted file mode 100644 index bf1a867..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal/UserAgentApplication.yml b/msal/docs-ref-autogen/@azure/msal/UserAgentApplication.yml deleted file mode 100644 index 7642139..0000000 --- a/msal/docs-ref-autogen/@azure/msal/UserAgentApplication.yml +++ /dev/null @@ -1,318 +0,0 @@ -### YamlMime:TSType -name: UserAgentApplication -uid: '@azure/msal.UserAgentApplication' -package: '@azure/msal' -summary: > - UserAgentApplication class - - Object Instance that the developer can use to make loginXX OR acquireTokenXX - functions -fullName: UserAgentApplication -remarks: '' -isPreview: false -isDeprecated: false -type: class -constructors: - - name: UserAgentApplication(Configuration) - uid: '@azure/msal.UserAgentApplication.constructor' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'new UserAgentApplication(configuration: Configuration)' - parameters: - - id: configuration - type: - description: | - object for the MSAL UserAgentApplication instance -properties: - - name: authority - uid: '@azure/msal.UserAgentApplication.authority' - package: '@azure/msal' - summary: Method to manage the authority URL. - fullName: authority - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'authority: string' - return: - description: '' - type: string -methods: - - name: acquireTokenPopup(AuthenticationParameters) - uid: '@azure/msal.UserAgentApplication.acquireTokenPopup' - package: '@azure/msal' - summary: >- - 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: >- - function acquireTokenPopup(userRequest: AuthenticationParameters): - Promise - parameters: - - id: userRequest - type: - description: '' - return: - description: >- - - a promise that is fulfilled when this function has completed, or - rejected if an error was raised. Returns the - object - type: Promise<> - - name: acquireTokenRedirect(AuthenticationParameters) - uid: '@azure/msal.UserAgentApplication.acquireTokenRedirect' - package: '@azure/msal' - summary: >- - 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)' - parameters: - - id: userRequest - type: - description: '' - - name: acquireTokenSilent(AuthenticationParameters) - uid: '@azure/msal.UserAgentApplication.acquireTokenSilent' - package: '@azure/msal' - summary: > - Use this function to obtain a token before every call to the API / - resource provider - - MSAL return's a cached token when available - - 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: >- - function acquireTokenSilent(userRequest: AuthenticationParameters): - Promise - parameters: - - id: userRequest - type: - description: '' - return: - description: >- - - a promise that is fulfilled when this function has completed, or - rejected if an error was raised. Returns the - object - type: Promise<> - - name: getAccount() - uid: '@azure/msal.UserAgentApplication.getAccount' - package: '@azure/msal' - summary: |- - Returns the signed in account - (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' - return: - description: '- the account object stored in MSAL' - type: - - name: getAllAccounts() - uid: '@azure/msal.UserAgentApplication.getAllAccounts' - package: '@azure/msal' - summary: >- - Use to get a list of unique accounts in MSAL cache based on - homeAccountIdentifier. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAllAccounts(): Array' - return: - description: '' - type: Array<> - - name: getAuthorityInstance() - uid: '@azure/msal.UserAgentApplication.getAuthorityInstance' - package: '@azure/msal' - summary: Get the current authority instance from the MSAL configuration object - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getAuthorityInstance(): Authority' - return: - description: authority instance - type: Authority - - name: getCurrentConfiguration() - uid: '@azure/msal.UserAgentApplication.getCurrentConfiguration' - package: '@azure/msal' - summary: 'Use to get the current object in MSAL' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getCurrentConfiguration(): Configuration' - return: - description: '' - type: - - name: getLoginInProgress() - uid: '@azure/msal.UserAgentApplication.getLoginInProgress' - 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' - return: - description: true/false - type: boolean - - name: getPostLogoutRedirectUri() - uid: '@azure/msal.UserAgentApplication.getPostLogoutRedirectUri' - package: '@azure/msal' - summary: >- - Use to get the post logout redirect uri configured in MSAL or null. - - Evaluates postLogoutredirectUri if its a function, otherwise simply - returns its value. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getPostLogoutRedirectUri(): string' - return: - description: post logout redirect URL - type: string - - name: getRedirectUri(string) - uid: '@azure/msal.UserAgentApplication.getRedirectUri' - package: '@azure/msal' - summary: >- - Use to get the redirect uri configured in MSAL or null. - - Evaluates redirectUri if its a function, otherwise simply returns its - value. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function getRedirectUri(reqRedirectUri?: string): string' - parameters: - - id: reqRedirectUri - type: string - description: '' - return: - description: redirect URL - type: string - - name: loginPopup(AuthenticationParameters) - uid: '@azure/msal.UserAgentApplication.loginPopup' - package: '@azure/msal' - summary: >- - Use when initiating the login process via opening a popup window in the - user's browser - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function loginPopup(userRequest?: AuthenticationParameters): - Promise - parameters: - - id: userRequest - type: - description: '' - return: - description: >- - - a promise that is fulfilled when this function has completed, or - rejected if an error was raised. Returns the - object - type: Promise<> - - name: loginRedirect(AuthenticationParameters) - uid: '@azure/msal.UserAgentApplication.loginRedirect' - package: '@azure/msal' - summary: >- - 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)' - parameters: - - id: userRequest - type: - description: '' - - name: logout(string) - uid: '@azure/msal.UserAgentApplication.logout' - package: '@azure/msal' - 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: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function logout(correlationId?: string)' - parameters: - - id: correlationId - type: string - description: '' - - name: setLogger(Logger) - uid: '@azure/msal.UserAgentApplication.setLogger' - package: '@azure/msal' - summary: Sets the logger callback. - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function setLogger(logger: Logger)' - parameters: - - id: logger - type: - description: | - Logger callback - - name: ssoSilent(AuthenticationParameters) - uid: '@azure/msal.UserAgentApplication.ssoSilent' - package: '@azure/msal' - summary: >- - API interfacing idToken request when applications already have a - session/hint acquired by authorization client applications - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function ssoSilent(request: AuthenticationParameters): - Promise - parameters: - - id: request - type: - description: |+ - - return: - description: '' - type: Promise<> - - name: urlContainsHash(string) - uid: '@azure/msal.UserAgentApplication.urlContainsHash' - 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' - parameters: - - id: hash - type: string - description: |+ - - return: - description: '' - type: boolean diff --git a/msal/docs-ref-autogen/@azure/msal/WindowUtils.yml b/msal/docs-ref-autogen/@azure/msal/WindowUtils.yml deleted file mode 100644 index 5674528..0000000 --- a/msal/docs-ref-autogen/@azure/msal/WindowUtils.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: WindowUtils -uid: '@azure/msal.WindowUtils' -package: '@azure/msal' -summary: '' -fullName: WindowUtils -remarks: '' -isPreview: false -isDeprecated: false -type: class -methods: - - name: checkIfBackButtonIsPressed(AuthCache) - uid: '@azure/msal.WindowUtils.checkIfBackButtonIsPressed' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'static function checkIfBackButtonIsPressed(cacheStorage: AuthCache)' - parameters: - - id: cacheStorage - type: AuthCache - description: |+ - - - name: clearUrlFragment() - uid: '@azure/msal.WindowUtils.clearUrlFragment' - package: '@azure/msal' - summary: Removes url fragment from browser url - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: static function clearUrlFragment() diff --git a/msal/docs-ref-autogen/@azure/msal/XhrResponse.yml b/msal/docs-ref-autogen/@azure/msal/XhrResponse.yml deleted file mode 100644 index 6c9313a..0000000 --- a/msal/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/msal/docs-ref-autogen/@azure/msal/authResponseCallback.yml b/msal/docs-ref-autogen/@azure/msal/authResponseCallback.yml deleted file mode 100644 index 1ce6e70..0000000 --- a/msal/docs-ref-autogen/@azure/msal/authResponseCallback.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: authResponseCallback -uid: '@azure/msal.authResponseCallback' -package: '@azure/msal' -summary: |- - A type alias for an authResponseCallback function. - -fullName: authResponseCallback -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type authResponseCallback = ( - authErr: AuthError, - response?: AuthResponse - ) => void diff --git a/msal/docs-ref-autogen/@azure/msal/errorReceivedCallback.yml b/msal/docs-ref-autogen/@azure/msal/errorReceivedCallback.yml deleted file mode 100644 index 47ce970..0000000 --- a/msal/docs-ref-autogen/@azure/msal/errorReceivedCallback.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: errorReceivedCallback -uid: '@azure/msal.errorReceivedCallback' -package: '@azure/msal' -summary: |- - A type alias for a errorReceivedCallback function. - -fullName: errorReceivedCallback -remarks: '' -isPreview: false -isDeprecated: false -syntax: > - type errorReceivedCallback = (authErr: AuthError, accountState: string) => - void diff --git a/msal/docs-ref-autogen/@azure/msal/index.yml b/msal/docs-ref-autogen/@azure/msal/index.yml deleted file mode 100644 index b5574a6..0000000 --- a/msal/docs-ref-autogen/@azure/msal/index.yml +++ /dev/null @@ -1,150 +0,0 @@ -### YamlMime:TSPackage -uid: '@azure/msal' -name: '@azure/msal' -summary: '' -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' - - '@azure/msal.WindowUtils' -typeAliases: - - '@azure/msal.AuthResponse' - - '@azure/msal.AuthenticationParameters' - - '@azure/msal.AuthOptions' - - '@azure/msal.CacheLocation' - - '@azure/msal.CacheOptions' - - '@azure/msal.Configuration' - - '@azure/msal.FrameworkOptions' - - '@azure/msal.SystemOptions' - - '@azure/msal.TelemetryOptions' - - '@azure/msal.StringDict' - - '@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' - parameters: - - id: state - type: string - description: '' - return: - description: '' - type: - - name: validateClaimsRequest(AuthenticationParameters) - uid: '@azure/msal.validateClaimsRequest' - package: '@azure/msal' - summary: '' - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function validateClaimsRequest(request: AuthenticationParameters)' - parameters: - - id: request - type: - description: '' - - name: >- - buildConfiguration({ auth: { authority?: string, authorityMetadata?: - string, clientId: string, knownAuthorities?: Array, - navigateToLoginRequestUrl?: boolean, postLogoutRedirectUri?: string | () - => string, redirectUri?: string | () => string, validateAuthority?: - boolean }, cache: { cacheLocation?: CacheLocation, - storeAuthStateInCookie?: boolean }, framework: { isAngular?: boolean, - protectedResourceMap?: Map>, unprotectedResources?: - Array }, system: { loadFrameTimeout?: number, logger?: Logger, - navigateFrameWait?: number, telemetry?: TelemetryOptions, - tokenRenewalOffsetSeconds?: number } }) - uid: '@azure/msal.buildConfiguration' - package: '@azure/msal' - summary: >- - MSAL function that sets the default options when not explicitly configured - from app developer - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: >- - function buildConfiguration(__namedParameters: { auth: { authority?: - string, authorityMetadata?: string, clientId: string, knownAuthorities?: - Array, navigateToLoginRequestUrl?: boolean, - postLogoutRedirectUri?: string | () => string, redirectUri?: string | () - => string, validateAuthority?: boolean }, cache: { cacheLocation?: - CacheLocation, storeAuthStateInCookie?: boolean }, framework: { - isAngular?: boolean, protectedResourceMap?: Map>, - unprotectedResources?: Array }, system: { loadFrameTimeout?: - number, logger?: Logger, navigateFrameWait?: number, telemetry?: - TelemetryOptions, tokenRenewalOffsetSeconds?: number } }): Configuration - parameters: - - id: __namedParameters - type: >- - { auth: { authority?: string, authorityMetadata?: string, clientId: - string, knownAuthorities?: Array<string>, - navigateToLoginRequestUrl?: boolean, postLogoutRedirectUri?: string - | () => string, redirectUri?: string | () => string, - validateAuthority?: boolean }, cache: { cacheLocation?: - CacheLocation, storeAuthStateInCookie?: boolean }, framework: { - isAngular?: boolean, protectedResourceMap?: Map<string, - Array<string>>, unprotectedResources?: Array<string> - }, system: { loadFrameTimeout?: number, logger?: Logger, - navigateFrameWait?: number, telemetry?: TelemetryOptions, - tokenRenewalOffsetSeconds?: number } } - description: '' - return: - description: TConfiguration object - type: - - name: libraryVersion() - uid: '@azure/msal.libraryVersion' - package: '@azure/msal' - summary: MSAL JS Library Version - remarks: '' - isPreview: false - isDeprecated: false - syntax: - content: 'function libraryVersion(): string' - return: - description: '' - type: string -enums: - - '@azure/msal.LogLevel' - - '@azure/msal.API_CODE' - - '@azure/msal.API_EVENT_IDENTIFIER' - - '@azure/msal.ErrorCacheKeys' - - '@azure/msal.PersistentCacheKeys' - - '@azure/msal.ServerHashParamKeys' -interfaces: - - '@azure/msal.ILoggerCallback' - - '@azure/msal.IClientConfigurationErrorMessage' - - '@azure/msal.CompletedEvents' - - '@azure/msal.EventCount' - - '@azure/msal.EventCountByCorrelationId' - - '@azure/msal.InProgressEvents' - - '@azure/msal.NetworkInformation' - - '@azure/msal.TelemetryConfig' - - '@azure/msal.TelemetryPlatform' diff --git a/msal/docs-ref-autogen/@azure/msal/tokenReceivedCallback.yml b/msal/docs-ref-autogen/@azure/msal/tokenReceivedCallback.yml deleted file mode 100644 index 6c16ebd..0000000 --- a/msal/docs-ref-autogen/@azure/msal/tokenReceivedCallback.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: tokenReceivedCallback -uid: '@azure/msal.tokenReceivedCallback' -package: '@azure/msal' -summary: |- - A type alias for a tokenReceivedCallback function. - -fullName: tokenReceivedCallback -remarks: '' -isPreview: false -isDeprecated: false -syntax: | - type tokenReceivedCallback = (response: AuthResponse) => void diff --git a/msal/docs-ref-autogen/toc.yml b/msal/docs-ref-autogen/toc.yml index 8b01b27..599d7b6 100644 --- a/msal/docs-ref-autogen/toc.yml +++ b/msal/docs-ref-autogen/toc.yml @@ -1,167 +1,10 @@ -- name: 'MSAL' - items: - - name: Overview - uid: '@azure/msal' - - uid: '@azure/msal.Account' - name: Account - items: [] - - uid: '@azure/msal.ApiEvent' - name: ApiEvent - items: [] - - uid: '@azure/msal.API_CODE' - name: API_CODE - items: [] - - uid: '@azure/msal.API_EVENT_IDENTIFIER' - name: API_EVENT_IDENTIFIER - items: [] - - uid: '@azure/msal.AuthenticationParameters' - name: AuthenticationParameters - items: [] - - uid: '@azure/msal.AuthError' - name: AuthError - items: [] - - uid: '@azure/msal.AuthOptions' - name: AuthOptions - items: [] - - uid: '@azure/msal.AuthorityFactory' - name: AuthorityFactory - items: [] - - uid: '@azure/msal.AuthResponse' - name: AuthResponse - items: [] - - uid: '@azure/msal.authResponseCallback' - name: authResponseCallback - items: [] - - uid: '@azure/msal.CacheLocation' - name: CacheLocation - items: [] - - uid: '@azure/msal.CacheOptions' - name: CacheOptions - items: [] - - uid: '@azure/msal.ClientAuthError' - name: ClientAuthError - items: [] - - uid: '@azure/msal.ClientConfigurationError' - name: ClientConfigurationError - items: [] - - uid: '@azure/msal.CompletedEvents' - name: CompletedEvents - items: [] - - uid: '@azure/msal.Configuration' - name: Configuration - items: [] - - uid: '@azure/msal.DefaultEvent' - name: DefaultEvent - items: [] - - uid: '@azure/msal.ErrorCacheKeys' - name: ErrorCacheKeys - items: [] - - uid: '@azure/msal.errorReceivedCallback' - name: errorReceivedCallback - items: [] - - uid: '@azure/msal.EventCount' - name: EventCount - items: [] - - uid: '@azure/msal.EventCountByCorrelationId' - name: EventCountByCorrelationId - items: [] - - uid: '@azure/msal.FrameworkOptions' - name: FrameworkOptions - items: [] - - uid: '@azure/msal.HttpEvent' - name: HttpEvent - items: [] - - uid: '@azure/msal.IClientConfigurationErrorMessage' - name: IClientConfigurationErrorMessage - items: [] - - uid: '@azure/msal.ILoggerCallback' - name: ILoggerCallback - items: [] - - uid: '@azure/msal.InProgressEvents' - name: InProgressEvents - items: [] - - uid: '@azure/msal.InteractionRequiredAuthError' - name: InteractionRequiredAuthError - items: [] - - uid: '@azure/msal.InteractionType' - name: InteractionType - items: [] - - uid: '@azure/msal.LibraryStateObject' - name: LibraryStateObject - items: [] - - uid: '@azure/msal.Logger' - name: Logger - items: [] - - uid: '@azure/msal.LogLevel' - name: LogLevel - items: [] - - uid: '@azure/msal.NetworkInformation' - name: NetworkInformation - items: [] - - uid: '@azure/msal.OpenIdConfiguration' - name: OpenIdConfiguration - items: [] - - uid: '@azure/msal.PersistentCacheKeys' - name: PersistentCacheKeys - items: [] - - uid: '@azure/msal.ScopeSet' - name: ScopeSet - items: [] - - uid: '@azure/msal.ServerError' - name: ServerError - items: [] - - uid: '@azure/msal.ServerHashParamKeys' - name: ServerHashParamKeys - items: [] - - uid: '@azure/msal.StringDict' - name: StringDict - items: [] - - uid: '@azure/msal.SystemOptions' - name: SystemOptions - items: [] - - uid: '@azure/msal.TelemetryConfig' - name: TelemetryConfig - items: [] - - uid: '@azure/msal.TelemetryEmitter' - name: TelemetryEmitter - items: [] - - uid: '@azure/msal.TelemetryEvent' - name: TelemetryEvent - items: [] - - uid: '@azure/msal.TelemetryManager' - name: TelemetryManager - items: [] - - uid: '@azure/msal.TelemetryOptions' - name: TelemetryOptions - items: [] - - uid: '@azure/msal.TelemetryPlatform' - name: TelemetryPlatform - items: [] - - 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' - uid: '@azure/msal-angular.IMsalService' name: IMsalService items: [] - - uid: '@azure/msal-angular.MatchingResources' - name: MatchingResources - items: [] - uid: '@azure/msal-angular.MsalBroadcastConfiguration' name: MsalBroadcastConfiguration items: [] @@ -201,15 +44,30 @@ - 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.AccountInfo' + name: AccountInfo + items: [] - uid: '@azure/msal-browser.ApiId' name: ApiId items: [] - - uid: '@azure/msal-browser.AsyncMemoryStorage' - name: AsyncMemoryStorage + - 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 @@ -217,35 +75,29 @@ - uid: '@azure/msal-browser.AuthorizationUrlRequest' name: AuthorizationUrlRequest items: [] - - uid: '@azure/msal-browser.Base64Decode' - name: Base64Decode - items: [] - - uid: '@azure/msal-browser.Base64Encode' - name: Base64Encode + - uid: '@azure/msal-browser.AzureCloudInstance' + name: AzureCloudInstance items: [] - - uid: '@azure/msal-browser.BaseInteractionClient' - name: BaseInteractionClient + - 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.BrowserCacheManager' - name: BrowserCacheManager - items: [] - - uid: '@azure/msal-browser.BrowserConfiguration' - name: BrowserConfiguration - items: [] - uid: '@azure/msal-browser.BrowserConfigurationAuthError' name: BrowserConfigurationAuthError items: [] - - uid: '@azure/msal-browser.BrowserCrypto' - name: BrowserCrypto + - uid: '@azure/msal-browser.BrowserConfigurationAuthErrorCodes' + name: BrowserConfigurationAuthErrorCodes items: [] - uid: '@azure/msal-browser.BrowserPerformanceClient' name: BrowserPerformanceClient @@ -253,18 +105,6 @@ - uid: '@azure/msal-browser.BrowserPerformanceMeasurement' name: BrowserPerformanceMeasurement items: [] - - uid: '@azure/msal-browser.BrowserProtocolUtils' - name: BrowserProtocolUtils - items: [] - - 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: [] @@ -274,35 +114,29 @@ - uid: '@azure/msal-browser.BrowserUtils' name: BrowserUtils items: [] - - uid: '@azure/msal-browser.CachedKeyPair' - name: CachedKeyPair - items: [] - uid: '@azure/msal-browser.CacheLookupPolicy' name: CacheLookupPolicy items: [] - uid: '@azure/msal-browser.CacheOptions' name: CacheOptions items: [] - - uid: '@azure/msal-browser.ClientApplication' - name: ClientApplication - items: [] - - uid: '@azure/msal-browser.Configuration' - name: Configuration + - uid: '@azure/msal-browser.ClearCacheRequest' + name: ClearCacheRequest items: [] - - uid: '@azure/msal-browser.CryptoKeyStore' - name: CryptoKeyStore + - uid: '@azure/msal-browser.ClientAuthError' + name: ClientAuthError items: [] - - uid: '@azure/msal-browser.CryptoKeyStoreNames' - name: CryptoKeyStoreNames + - uid: '@azure/msal-browser.ClientAuthErrorCodes' + name: ClientAuthErrorCodes items: [] - - uid: '@azure/msal-browser.CryptoOps' - name: CryptoOps + - uid: '@azure/msal-browser.ClientConfigurationError' + name: ClientConfigurationError items: [] - - uid: '@azure/msal-browser.CryptoOptions' - name: CryptoOptions + - uid: '@azure/msal-browser.ClientConfigurationErrorCodes' + name: ClientConfigurationErrorCodes items: [] - - uid: '@azure/msal-browser.DatabaseStorage' - name: DatabaseStorage + - uid: '@azure/msal-browser.Configuration' + name: Configuration items: [] - uid: '@azure/msal-browser.EndSessionPopupRequest' name: EndSessionPopupRequest @@ -331,32 +165,35 @@ - uid: '@azure/msal-browser.EventType' name: EventType items: [] - - uid: '@azure/msal-browser.FetchClient' - name: FetchClient + - uid: '@azure/msal-browser.ExternalTokenResponse' + name: ExternalTokenResponse items: [] - - uid: '@azure/msal-browser.GuidGenerator' - name: GuidGenerator + - uid: '@azure/msal-browser.IController' + name: IController items: [] - - uid: '@azure/msal-browser.HTTP_REQUEST_TYPE' - name: HTTP_REQUEST_TYPE + - uid: '@azure/msal-browser.IdTokenClaims' + name: IdTokenClaims items: [] - - uid: '@azure/msal-browser.HybridSpaAuthorizationCodeClient' - name: HybridSpaAuthorizationCodeClient - items: [] - - uid: '@azure/msal-browser.IAsyncStorage' - name: IAsyncStorage + - uid: '@azure/msal-browser.ILoggerCallback' + name: ILoggerCallback items: [] - uid: '@azure/msal-browser.INavigationClient' name: INavigationClient items: [] - - uid: '@azure/msal-browser.InMemoryCacheKeys' - name: InMemoryCacheKeys + - uid: '@azure/msal-browser.INetworkModule' + name: INetworkModule items: [] - - uid: '@azure/msal-browser.InteractionHandler' - name: InteractionHandler + - uid: '@azure/msal-browser.InitializeApplicationRequest' + name: InitializeApplicationRequest items: [] - - uid: '@azure/msal-browser.InteractionParams' - name: InteractionParams + - 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 @@ -364,93 +201,60 @@ - 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.ISubtleCrypto' - name: ISubtleCrypto - items: [] - 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.MathUtils' - name: MathUtils + - uid: '@azure/msal-browser.LocalStorage' + name: LocalStorage items: [] - - uid: '@azure/msal-browser.MATS' - name: MATS + - 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.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: [] - - uid: '@azure/msal-browser.NativeAuthError' - name: NativeAuthError - items: [] - - uid: '@azure/msal-browser.NativeExtensionMethod' - name: NativeExtensionMethod - items: [] - - uid: '@azure/msal-browser.NativeExtensionRequest' - name: NativeExtensionRequest - items: [] - - uid: '@azure/msal-browser.NativeExtensionRequestBody' - name: NativeExtensionRequestBody - items: [] - - uid: '@azure/msal-browser.NativeInteractionClient' - name: NativeInteractionClient - items: [] - - uid: '@azure/msal-browser.NativeMessageHandler' - name: NativeMessageHandler - items: [] - - uid: '@azure/msal-browser.NativeResponse' - name: NativeResponse - items: [] - - uid: '@azure/msal-browser.NativeResponseProperties' - name: NativeResponseProperties - items: [] - - uid: '@azure/msal-browser.NativeStatusCode' - name: NativeStatusCode - items: [] - - uid: '@azure/msal-browser.NativeTokenRequest' - name: NativeTokenRequest - items: [] - uid: '@azure/msal-browser.NavigationClient' name: NavigationClient items: [] - uid: '@azure/msal-browser.NavigationOptions' name: NavigationOptions items: [] - - uid: '@azure/msal-browser.OSError' - name: OSError + - uid: '@azure/msal-browser.NetworkRequestOptions' + name: NetworkRequestOptions + items: [] + - uid: '@azure/msal-browser.NetworkResponse' + name: NetworkResponse items: [] - - uid: '@azure/msal-browser.PkceGenerator' - name: PkceGenerator + - uid: '@azure/msal-browser.PerformanceCallbackFunction' + name: PerformanceCallbackFunction items: [] - - uid: '@azure/msal-browser.PopupClient' - name: PopupClient + - 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.PopupParams' - name: PopupParams - items: [] - uid: '@azure/msal-browser.PopupPosition' name: PopupPosition items: [] @@ -463,69 +267,463 @@ - 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.RedirectClient' - name: RedirectClient - items: [] - - uid: '@azure/msal-browser.RedirectHandler' - name: RedirectHandler - items: [] - - uid: '@azure/msal-browser.RedirectParams' - name: RedirectParams + - 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.SessionStorage' + name: SessionStorage + items: [] - uid: '@azure/msal-browser.SignedHttpRequest' name: SignedHttpRequest items: [] - uid: '@azure/msal-browser.SignedHttpRequestOptions' name: SignedHttpRequestOptions items: [] - - uid: '@azure/msal-browser.SilentAuthCodeClient' - name: SilentAuthCodeClient - items: [] - - uid: '@azure/msal-browser.SilentCacheClient' - name: SilentCacheClient - items: [] - - uid: '@azure/msal-browser.SilentHandler' - name: SilentHandler - items: [] - - uid: '@azure/msal-browser.SilentIframeClient' - name: SilentIframeClient - items: [] - - uid: '@azure/msal-browser.SilentRefreshClient' - name: SilentRefreshClient - items: [] - uid: '@azure/msal-browser.SilentRequest' name: SilentRequest items: [] - uid: '@azure/msal-browser.SsoSilentRequest' name: SsoSilentRequest items: [] - - uid: '@azure/msal-browser.StandardInteractionClient' - name: StandardInteractionClient + - uid: '@azure/msal-browser.StubPerformanceClient' + name: StubPerformanceClient items: [] - - uid: '@azure/msal-browser.TemporaryCacheKeys' - name: TemporaryCacheKeys + - uid: '@azure/msal-browser.TenantProfile' + name: TenantProfile items: [] - - uid: '@azure/msal-browser.TokenCache' - name: TokenCache + - uid: '@azure/msal-browser.UrlString' + name: UrlString items: [] - uid: '@azure/msal-browser.WrapperSKU' name: WrapperSKU items: [] - - uid: '@azure/msal-browser.XhrClient' - name: XhrClient +- 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.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: [] + - 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.NetworkError' + name: NetworkError + 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: [] -- name: 'MSAL Node' + - 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.UrlUtils' + name: UrlUtils + items: [] +- name: '@azure/msal-node' items: - name: Overview uid: '@azure/msal-node' - - uid: '@azure/msal-node.ApiId' - name: ApiId + - 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 @@ -533,6 +731,15 @@ - 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: [] @@ -545,6 +752,24 @@ - uid: '@azure/msal-node.ClientAssertion' name: ClientAssertion items: [] + - uid: '@azure/msal-node.ClientAssertionCallback' + name: ClientAssertionCallback + 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: [] @@ -557,8 +782,8 @@ - uid: '@azure/msal-node.CryptoProvider' name: CryptoProvider items: [] - - uid: '@azure/msal-node.Deserializer' - name: Deserializer + - uid: '@azure/msal-node.DeviceCodeClient' + name: DeviceCodeClient items: [] - uid: '@azure/msal-node.DeviceCodeRequest' name: DeviceCodeRequest @@ -566,65 +791,89 @@ - uid: '@azure/msal-node.DistributedCachePlugin' name: DistributedCachePlugin items: [] - - uid: '@azure/msal-node.EncodingUtils' - name: EncodingUtils + - uid: '@azure/msal-node.IAppTokenProvider' + name: IAppTokenProvider items: [] - - uid: '@azure/msal-node.GuidGenerator' - name: GuidGenerator + - uid: '@azure/msal-node.ICacheClient' + name: ICacheClient items: [] - - uid: '@azure/msal-node.HashUtils' - name: HashUtils + - uid: '@azure/msal-node.ICachePlugin' + name: ICachePlugin items: [] - - uid: '@azure/msal-node.HttpClient' - name: HttpClient + - uid: '@azure/msal-node.IConfidentialClientApplication' + name: IConfidentialClientApplication items: [] - - uid: '@azure/msal-node.HttpMethod' - name: HttpMethod + - uid: '@azure/msal-node.IdTokenClaims' + name: IdTokenClaims items: [] - - uid: '@azure/msal-node.HttpStatus' - name: HttpStatus + - uid: '@azure/msal-node.ILoopbackClient' + name: ILoopbackClient items: [] - - uid: '@azure/msal-node.ICacheClient' - name: ICacheClient + - uid: '@azure/msal-node.INativeBrokerPlugin' + name: INativeBrokerPlugin items: [] - - uid: '@azure/msal-node.IConfidentialClientApplication' - name: IConfidentialClientApplication + - 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: [] + - uid: '@azure/msal-node.internals' + name: internals + 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.LoopbackClient' - name: LoopbackClient + - uid: '@azure/msal-node.Logger' + name: Logger items: [] - - uid: '@azure/msal-node.NetworkUtils' - name: NetworkUtils + - uid: '@azure/msal-node.LogLevel' + name: LogLevel items: [] - - uid: '@azure/msal-node.NodeAuthError' - name: NodeAuthError + - uid: '@azure/msal-node.ManagedIdentityApplication' + name: ManagedIdentityApplication items: [] - - uid: '@azure/msal-node.NodeAuthOptions' - name: NodeAuthOptions + - uid: '@azure/msal-node.ManagedIdentityConfiguration' + name: ManagedIdentityConfiguration + items: [] + - uid: '@azure/msal-node.ManagedIdentityIdParams' + name: ManagedIdentityIdParams items: [] - - uid: '@azure/msal-node.NodeConfiguration' - name: NodeConfiguration + - uid: '@azure/msal-node.ManagedIdentityRequestParams' + name: ManagedIdentityRequestParams items: [] - - uid: '@azure/msal-node.NodeStorage' - name: NodeStorage + - uid: '@azure/msal-node.ManagedIdentitySourceNames' + name: ManagedIdentitySourceNames + 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.NodeSystemOptions' name: NodeSystemOptions @@ -632,14 +881,14 @@ - 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.PkceGenerator' - name: PkceGenerator - items: [] - - uid: '@azure/msal-node.ProxyStatus' - name: ProxyStatus + - uid: '@azure/msal-node.ProtocolMode' + name: ProtocolMode items: [] - uid: '@azure/msal-node.PublicClientApplication' name: PublicClientApplication @@ -647,6 +896,9 @@ - uid: '@azure/msal-node.RefreshTokenRequest' name: RefreshTokenRequest items: [] + - uid: '@azure/msal-node.ResponseMode' + name: ResponseMode + items: [] - uid: '@azure/msal-node.SerializedAccessTokenEntity' name: SerializedAccessTokenEntity items: [] @@ -662,8 +914,14 @@ - uid: '@azure/msal-node.SerializedRefreshTokenEntity' name: SerializedRefreshTokenEntity items: [] - - uid: '@azure/msal-node.Serializer' - name: Serializer + - 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 @@ -671,10 +929,16 @@ - 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: 'MSAL React' +- name: '@azure/msal-react' items: - name: Overview uid: '@azure/msal-react' @@ -684,9 +948,6 @@ - uid: '@azure/msal-react.AuthenticatedTemplateProps' name: AuthenticatedTemplateProps items: [] - - uid: '@azure/msal-react.FaaCFunction' - name: FaaCFunction - items: [] - uid: '@azure/msal-react.IMsalContext' name: IMsalContext items: [] @@ -699,9 +960,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: []