@azure/msal-common 14.1.0 → 14.2.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/account/AccountInfo.d.ts +31 -31
- package/dist/account/AuthToken.d.ts +17 -17
- package/dist/account/AuthToken.mjs +58 -58
- package/dist/account/CcsCredential.d.ts +9 -9
- package/dist/account/CcsCredential.mjs +8 -8
- package/dist/account/ClientCredentials.d.ts +14 -14
- package/dist/account/ClientInfo.d.ts +19 -19
- package/dist/account/ClientInfo.mjs +37 -37
- package/dist/account/TokenClaims.d.ts +65 -65
- package/dist/authority/Authority.d.ts +250 -235
- package/dist/authority/Authority.d.ts.map +1 -1
- package/dist/authority/Authority.mjs +795 -740
- package/dist/authority/Authority.mjs.map +1 -1
- package/dist/authority/AuthorityFactory.d.ts +31 -31
- package/dist/authority/AuthorityFactory.d.ts.map +1 -1
- package/dist/authority/AuthorityFactory.mjs +48 -48
- package/dist/authority/AuthorityMetadata.d.ts +646 -623
- package/dist/authority/AuthorityMetadata.d.ts.map +1 -1
- package/dist/authority/AuthorityMetadata.mjs +941 -885
- package/dist/authority/AuthorityMetadata.mjs.map +1 -1
- package/dist/authority/AuthorityOptions.d.ts +27 -21
- package/dist/authority/AuthorityOptions.d.ts.map +1 -1
- package/dist/authority/AuthorityOptions.mjs +18 -18
- package/dist/authority/AuthorityOptions.mjs.map +1 -1
- package/dist/authority/AuthorityType.d.ts +10 -10
- package/dist/authority/AuthorityType.mjs +13 -13
- package/dist/authority/AzureRegion.d.ts +1 -1
- package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
- package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
- package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
- package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
- package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
- package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
- package/dist/authority/ImdsOptions.d.ts +5 -5
- package/dist/authority/OIDCOptions.d.ts +8 -8
- package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
- package/dist/authority/OpenIdConfigResponse.mjs +10 -10
- package/dist/authority/ProtocolMode.d.ts +8 -8
- package/dist/authority/ProtocolMode.mjs +11 -11
- package/dist/authority/RegionDiscovery.d.ts +32 -32
- package/dist/authority/RegionDiscovery.mjs +106 -106
- package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
- package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
- package/dist/cache/CacheManager.d.ts +480 -464
- package/dist/cache/CacheManager.d.ts.map +1 -1
- package/dist/cache/CacheManager.mjs +1089 -1049
- package/dist/cache/CacheManager.mjs.map +1 -1
- package/dist/cache/entities/AccessTokenEntity.d.ts +56 -56
- package/dist/cache/entities/AccessTokenEntity.mjs +109 -109
- package/dist/cache/entities/AccountEntity.d.ts +101 -101
- package/dist/cache/entities/AccountEntity.d.ts.map +1 -1
- package/dist/cache/entities/AccountEntity.mjs +218 -220
- package/dist/cache/entities/AccountEntity.mjs.map +1 -1
- package/dist/cache/entities/AppMetadataEntity.d.ts +39 -39
- package/dist/cache/entities/AppMetadataEntity.mjs +66 -66
- package/dist/cache/entities/AuthorityMetadataEntity.d.ts +48 -48
- package/dist/cache/entities/AuthorityMetadataEntity.mjs +78 -78
- package/dist/cache/entities/CacheRecord.d.ts +14 -14
- package/dist/cache/entities/CacheRecord.mjs +14 -14
- package/dist/cache/entities/CredentialEntity.d.ts +88 -88
- package/dist/cache/entities/CredentialEntity.mjs +136 -136
- package/dist/cache/entities/IdTokenEntity.d.ts +34 -34
- package/dist/cache/entities/IdTokenEntity.mjs +56 -56
- package/dist/cache/entities/RefreshTokenEntity.d.ts +36 -36
- package/dist/cache/entities/RefreshTokenEntity.mjs +59 -59
- package/dist/cache/entities/ServerTelemetryEntity.d.ts +12 -12
- package/dist/cache/entities/ServerTelemetryEntity.mjs +27 -27
- package/dist/cache/entities/ThrottlingEntity.d.ts +13 -13
- package/dist/cache/entities/ThrottlingEntity.mjs +23 -23
- package/dist/cache/interface/ICacheManager.d.ts +166 -166
- package/dist/cache/interface/ICachePlugin.d.ts +5 -5
- package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
- package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
- package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
- package/dist/cache/utils/CacheTypes.d.ts +67 -66
- package/dist/cache/utils/CacheTypes.d.ts.map +1 -1
- package/dist/client/AuthorizationCodeClient.d.ts +73 -73
- package/dist/client/AuthorizationCodeClient.d.ts.map +1 -1
- package/dist/client/AuthorizationCodeClient.mjs +408 -408
- package/dist/client/AuthorizationCodeClient.mjs.map +1 -1
- package/dist/client/BaseClient.d.ts +51 -51
- package/dist/client/BaseClient.d.ts.map +1 -1
- package/dist/client/BaseClient.mjs +100 -99
- package/dist/client/BaseClient.mjs.map +1 -1
- package/dist/client/RefreshTokenClient.d.ts +35 -35
- package/dist/client/RefreshTokenClient.d.ts.map +1 -1
- package/dist/client/RefreshTokenClient.mjs +187 -187
- package/dist/client/RefreshTokenClient.mjs.map +1 -1
- package/dist/client/SilentFlowClient.d.ts +27 -26
- package/dist/client/SilentFlowClient.d.ts.map +1 -1
- package/dist/client/SilentFlowClient.mjs +118 -125
- package/dist/client/SilentFlowClient.mjs.map +1 -1
- package/dist/config/AppTokenProvider.d.ts +38 -38
- package/dist/config/ClientConfiguration.d.ts +150 -150
- package/dist/config/ClientConfiguration.d.ts.map +1 -1
- package/dist/config/ClientConfiguration.mjs +96 -98
- package/dist/config/ClientConfiguration.mjs.map +1 -1
- package/dist/crypto/ICrypto.d.ts +58 -58
- package/dist/crypto/ICrypto.mjs +30 -30
- package/dist/crypto/IGuidGenerator.d.ts +4 -4
- package/dist/crypto/JoseHeader.d.ts +22 -22
- package/dist/crypto/JoseHeader.mjs +37 -37
- package/dist/crypto/PopTokenGenerator.d.ts +60 -60
- package/dist/crypto/PopTokenGenerator.mjs +82 -82
- package/dist/crypto/SignedHttpRequest.d.ts +11 -11
- package/dist/error/AuthError.d.ts +44 -44
- package/dist/error/AuthError.mjs +46 -46
- package/dist/error/AuthErrorCodes.d.ts +5 -5
- package/dist/error/AuthErrorCodes.mjs +9 -9
- package/dist/error/ClientAuthError.d.ts +237 -232
- package/dist/error/ClientAuthError.d.ts.map +1 -1
- package/dist/error/ClientAuthError.mjs +250 -245
- package/dist/error/ClientAuthError.mjs.map +1 -1
- package/dist/error/ClientAuthErrorCodes.d.ts +44 -43
- package/dist/error/ClientAuthErrorCodes.d.ts.map +1 -1
- package/dist/error/ClientAuthErrorCodes.mjs +50 -49
- package/dist/error/ClientAuthErrorCodes.mjs.map +1 -1
- package/dist/error/ClientConfigurationError.d.ts +128 -128
- package/dist/error/ClientConfigurationError.mjs +135 -135
- package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
- package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
- package/dist/error/InteractionRequiredAuthError.d.ts +57 -57
- package/dist/error/InteractionRequiredAuthError.mjs +76 -76
- package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +5 -5
- package/dist/error/InteractionRequiredAuthErrorCodes.mjs +11 -11
- package/dist/error/JoseHeaderError.d.ts +15 -15
- package/dist/error/JoseHeaderError.mjs +22 -22
- package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
- package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
- package/dist/error/ServerError.d.ts +7 -7
- package/dist/error/ServerError.mjs +14 -14
- package/dist/index.cjs +8840 -8677
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +96 -96
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +3 -3
- package/dist/logger/Logger.d.ts +95 -95
- package/dist/logger/Logger.mjs +188 -188
- package/dist/network/INetworkModule.d.ts +29 -29
- package/dist/network/INetworkModule.mjs +12 -12
- package/dist/network/NetworkManager.d.ts +33 -33
- package/dist/network/NetworkManager.mjs +34 -34
- package/dist/network/RequestThumbprint.d.ts +16 -16
- package/dist/network/ThrottlingUtils.d.ts +42 -42
- package/dist/network/ThrottlingUtils.mjs +95 -95
- package/dist/packageMetadata.d.ts +2 -2
- package/dist/packageMetadata.d.ts.map +1 -1
- package/dist/packageMetadata.mjs +4 -4
- package/dist/packageMetadata.mjs.map +1 -1
- package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
- package/dist/request/AuthenticationHeaderParser.mjs +55 -55
- package/dist/request/BaseAuthRequest.d.ts +40 -40
- package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
- package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
- package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
- package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
- package/dist/request/CommonEndSessionRequest.d.ts +21 -21
- package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
- package/dist/request/CommonRefreshTokenRequest.d.ts +22 -22
- package/dist/request/CommonSilentFlowRequest.d.ts +20 -20
- package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
- package/dist/request/NativeRequest.d.ts +19 -19
- package/dist/request/NativeSignOutRequest.d.ts +5 -5
- package/dist/request/RequestParameterBuilder.d.ts +217 -217
- package/dist/request/RequestParameterBuilder.mjs +381 -381
- package/dist/request/RequestValidator.d.ts +33 -33
- package/dist/request/RequestValidator.mjs +81 -81
- package/dist/request/ScopeSet.d.ts +88 -88
- package/dist/request/ScopeSet.mjs +197 -197
- package/dist/request/StoreInCache.d.ts +8 -8
- package/dist/response/AuthenticationResult.d.ts +41 -41
- package/dist/response/AuthorizationCodePayload.d.ts +13 -13
- package/dist/response/DeviceCodeResponse.d.ts +25 -25
- package/dist/response/ExternalTokenResponse.d.ts +15 -15
- package/dist/response/IMDSBadResponse.d.ts +4 -4
- package/dist/response/ResponseHandler.d.ts +67 -67
- package/dist/response/ResponseHandler.d.ts.map +1 -1
- package/dist/response/ResponseHandler.mjs +315 -311
- package/dist/response/ResponseHandler.mjs.map +1 -1
- package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
- package/dist/response/ServerAuthorizationTokenResponse.d.ts +46 -46
- package/dist/telemetry/performance/IPerformanceClient.d.ts +51 -51
- package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
- package/dist/telemetry/performance/PerformanceClient.d.ts +191 -191
- package/dist/telemetry/performance/PerformanceClient.mjs +409 -409
- package/dist/telemetry/performance/PerformanceEvent.d.ts +457 -441
- package/dist/telemetry/performance/PerformanceEvent.d.ts.map +1 -1
- package/dist/telemetry/performance/PerformanceEvent.mjs +249 -242
- package/dist/telemetry/performance/PerformanceEvent.mjs.map +1 -1
- package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
- package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
- package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
- package/dist/telemetry/server/ServerTelemetryManager.mjs +197 -197
- package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
- package/dist/url/IUri.d.ts +12 -12
- package/dist/url/UrlString.d.ts +83 -83
- package/dist/url/UrlString.mjs +279 -279
- package/dist/utils/Constants.d.ts +368 -366
- package/dist/utils/Constants.d.ts.map +1 -1
- package/dist/utils/Constants.mjs +381 -378
- package/dist/utils/Constants.mjs.map +1 -1
- package/dist/utils/FunctionWrappers.d.ts +27 -27
- package/dist/utils/FunctionWrappers.mjs +84 -84
- package/dist/utils/MsalTypes.d.ts +6 -6
- package/dist/utils/ProtocolUtils.d.ts +42 -42
- package/dist/utils/ProtocolUtils.mjs +69 -69
- package/dist/utils/StringUtils.d.ts +40 -40
- package/dist/utils/StringUtils.mjs +95 -95
- package/dist/utils/TimeUtils.d.ts +27 -27
- package/dist/utils/TimeUtils.mjs +45 -45
- package/package.json +1 -1
- package/src/authority/Authority.ts +216 -130
- package/src/authority/AuthorityFactory.ts +4 -4
- package/src/authority/AuthorityMetadata.ts +87 -0
- package/src/authority/AuthorityOptions.ts +9 -0
- package/src/cache/CacheManager.ts +120 -52
- package/src/cache/entities/AccountEntity.ts +0 -3
- package/src/cache/utils/CacheTypes.ts +1 -0
- package/src/client/AuthorizationCodeClient.ts +9 -2
- package/src/client/BaseClient.ts +9 -6
- package/src/client/RefreshTokenClient.ts +17 -7
- package/src/client/SilentFlowClient.ts +49 -49
- package/src/config/ClientConfiguration.ts +4 -4
- package/src/error/ClientAuthError.ts +8 -0
- package/src/error/ClientAuthErrorCodes.ts +1 -0
- package/src/index.ts +7 -1
- package/src/packageMetadata.ts +1 -1
- package/src/response/ResponseHandler.ts +9 -3
- package/src/telemetry/performance/PerformanceEvent.ts +24 -2
- package/src/utils/Constants.ts +4 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ResponseHandler.mjs","sources":["../../src/response/ResponseHandler.ts"],"sourcesContent":[null],"names":["ClientAuthErrorCodes.invalidState"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAKA;AAEA;AAKA;AACA;;;;;
|
|
1
|
+
{"version":3,"file":"ResponseHandler.mjs","sources":["../../src/response/ResponseHandler.ts"],"sourcesContent":[null],"names":["ClientAuthErrorCodes.invalidState"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAKA;AAEA;AAKA;AACA;;;;;AA6CW,sBAAkB;IACzB,kCAA+C,EAAA,SAAA,EAAA,MAAA,EAAA,iBAAA,EAAA,iBAAA,EAAA,iBAAA,EAAA;QACxC,IAAC,CAAiB,QAAA,GAAA,QAAsB,CAAA;AAG3C,QAAA,IAAA,CAAA,YAAU,GAAA,YACV,CAAA;AAgBJ,QAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;;;;;AAKG,KAAA;AACH;AAgFA;;;;AAIG;IACH,uCACoD,CAAA,kBAAA,EAAA,WAAA;AAkEpD,QAAA,IAAA,CAAA,kBAAA,CAAA,KAAA,IAAA,CAAA,WAAA,EAAA;;;;AAIG,SAAA;QAC4B,IAAA;AAoJ/B,QAAA,IAAA,kBAAA,CAAA;;;;;AAKG,YAAA,MAAA,qBAAA,CAAAA,YAAA,EAAA,kBAAA,CAAA,KAAA,CAAA,CAAA;AACH,SAAA;AA4HA,QAAA,IAAA;;;;;;;;;AASG;YACsC,kBAAA,CAAA,KAAA;AA4G5C,YAAA,kBAAA,CAAA,iBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Deserialized response object from server authorization code request.
|
|
3
|
-
* - code: authorization code from server
|
|
4
|
-
* - client_info: client info object
|
|
5
|
-
* - state: OAuth2 request state
|
|
6
|
-
* - error: error sent back in hash
|
|
7
|
-
* - error: description
|
|
8
|
-
*/
|
|
9
|
-
export type ServerAuthorizationCodeResponse = {
|
|
10
|
-
code?: string;
|
|
11
|
-
client_info?: string;
|
|
12
|
-
state?: string;
|
|
13
|
-
cloud_instance_name?: string;
|
|
14
|
-
cloud_instance_host_name?: string;
|
|
15
|
-
cloud_graph_host_name?: string;
|
|
16
|
-
msgraph_host?: string;
|
|
17
|
-
error?: string;
|
|
18
|
-
error_description?: string;
|
|
19
|
-
suberror?: string;
|
|
20
|
-
timestamp?: string;
|
|
21
|
-
trace_id?: string;
|
|
22
|
-
correlation_id?: string;
|
|
23
|
-
claims?: string;
|
|
24
|
-
accountId?: string;
|
|
25
|
-
};
|
|
1
|
+
/**
|
|
2
|
+
* Deserialized response object from server authorization code request.
|
|
3
|
+
* - code: authorization code from server
|
|
4
|
+
* - client_info: client info object
|
|
5
|
+
* - state: OAuth2 request state
|
|
6
|
+
* - error: error sent back in hash
|
|
7
|
+
* - error: description
|
|
8
|
+
*/
|
|
9
|
+
export type ServerAuthorizationCodeResponse = {
|
|
10
|
+
code?: string;
|
|
11
|
+
client_info?: string;
|
|
12
|
+
state?: string;
|
|
13
|
+
cloud_instance_name?: string;
|
|
14
|
+
cloud_instance_host_name?: string;
|
|
15
|
+
cloud_graph_host_name?: string;
|
|
16
|
+
msgraph_host?: string;
|
|
17
|
+
error?: string;
|
|
18
|
+
error_description?: string;
|
|
19
|
+
suberror?: string;
|
|
20
|
+
timestamp?: string;
|
|
21
|
+
trace_id?: string;
|
|
22
|
+
correlation_id?: string;
|
|
23
|
+
claims?: string;
|
|
24
|
+
accountId?: string;
|
|
25
|
+
};
|
|
26
26
|
//# sourceMappingURL=ServerAuthorizationCodeResponse.d.ts.map
|
|
@@ -1,47 +1,47 @@
|
|
|
1
|
-
import { AuthenticationScheme } from "../utils/Constants";
|
|
2
|
-
/**
|
|
3
|
-
* Deserialized response object from server authorization code request.
|
|
4
|
-
* - token_type: Indicates the token type value. Can be either Bearer or pop.
|
|
5
|
-
* - scope: The scopes that the access_token is valid for.
|
|
6
|
-
* - expires_in: How long the access token is valid (in seconds).
|
|
7
|
-
* - refresh_in: Duration afer which a token should be renewed, regardless of expiration.
|
|
8
|
-
* - ext_expires_in: How long the access token is valid (in seconds) if the server isn't responding.
|
|
9
|
-
* - access_token: The requested access token. The app can use this token to authenticate to the secured resource, such as a web API.
|
|
10
|
-
* - refresh_token: An OAuth 2.0 refresh token. The app can use this token acquire additional access tokens after the current access token expires.
|
|
11
|
-
* - 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.
|
|
12
|
-
* - key_id: A string that uniquely identifies a public key that the request is bound to.
|
|
13
|
-
*
|
|
14
|
-
* In case of error:
|
|
15
|
-
* - error: An error code string that can be used to classify types of errors that occur, and can be used to react to errors.
|
|
16
|
-
* - error_description: A specific error message that can help a developer identify the root cause of an authentication error.
|
|
17
|
-
* - error_codes: A list of STS-specific error codes that can help in diagnostics.
|
|
18
|
-
* - timestamp: The time at which the error occurred.
|
|
19
|
-
* - trace_id: A unique identifier for the request that can help in diagnostics.
|
|
20
|
-
* - correlation_id: A unique identifier for the request that can help in diagnostics across components.
|
|
21
|
-
* - status: the network request's response status
|
|
22
|
-
*/
|
|
23
|
-
export type ServerAuthorizationTokenResponse = {
|
|
24
|
-
status?: number;
|
|
25
|
-
token_type?: AuthenticationScheme;
|
|
26
|
-
scope?: string;
|
|
27
|
-
expires_in?: number;
|
|
28
|
-
refresh_in?: number;
|
|
29
|
-
ext_expires_in?: number;
|
|
30
|
-
access_token?: string;
|
|
31
|
-
refresh_token?: string;
|
|
32
|
-
id_token?: string;
|
|
33
|
-
client_info?: string;
|
|
34
|
-
foci?: string;
|
|
35
|
-
spa_code?: string;
|
|
36
|
-
spa_accountid?: string;
|
|
37
|
-
key_id?: string;
|
|
38
|
-
error?: string;
|
|
39
|
-
error_description?: string;
|
|
40
|
-
error_codes?: Array<string>;
|
|
41
|
-
suberror?: string;
|
|
42
|
-
timestamp?: string;
|
|
43
|
-
trace_id?: string;
|
|
44
|
-
correlation_id?: string;
|
|
45
|
-
claims?: string;
|
|
46
|
-
};
|
|
1
|
+
import { AuthenticationScheme } from "../utils/Constants";
|
|
2
|
+
/**
|
|
3
|
+
* Deserialized response object from server authorization code request.
|
|
4
|
+
* - token_type: Indicates the token type value. Can be either Bearer or pop.
|
|
5
|
+
* - scope: The scopes that the access_token is valid for.
|
|
6
|
+
* - expires_in: How long the access token is valid (in seconds).
|
|
7
|
+
* - refresh_in: Duration afer which a token should be renewed, regardless of expiration.
|
|
8
|
+
* - ext_expires_in: How long the access token is valid (in seconds) if the server isn't responding.
|
|
9
|
+
* - access_token: The requested access token. The app can use this token to authenticate to the secured resource, such as a web API.
|
|
10
|
+
* - refresh_token: An OAuth 2.0 refresh token. The app can use this token acquire additional access tokens after the current access token expires.
|
|
11
|
+
* - 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.
|
|
12
|
+
* - key_id: A string that uniquely identifies a public key that the request is bound to.
|
|
13
|
+
*
|
|
14
|
+
* In case of error:
|
|
15
|
+
* - error: An error code string that can be used to classify types of errors that occur, and can be used to react to errors.
|
|
16
|
+
* - error_description: A specific error message that can help a developer identify the root cause of an authentication error.
|
|
17
|
+
* - error_codes: A list of STS-specific error codes that can help in diagnostics.
|
|
18
|
+
* - timestamp: The time at which the error occurred.
|
|
19
|
+
* - trace_id: A unique identifier for the request that can help in diagnostics.
|
|
20
|
+
* - correlation_id: A unique identifier for the request that can help in diagnostics across components.
|
|
21
|
+
* - status: the network request's response status
|
|
22
|
+
*/
|
|
23
|
+
export type ServerAuthorizationTokenResponse = {
|
|
24
|
+
status?: number;
|
|
25
|
+
token_type?: AuthenticationScheme;
|
|
26
|
+
scope?: string;
|
|
27
|
+
expires_in?: number;
|
|
28
|
+
refresh_in?: number;
|
|
29
|
+
ext_expires_in?: number;
|
|
30
|
+
access_token?: string;
|
|
31
|
+
refresh_token?: string;
|
|
32
|
+
id_token?: string;
|
|
33
|
+
client_info?: string;
|
|
34
|
+
foci?: string;
|
|
35
|
+
spa_code?: string;
|
|
36
|
+
spa_accountid?: string;
|
|
37
|
+
key_id?: string;
|
|
38
|
+
error?: string;
|
|
39
|
+
error_description?: string;
|
|
40
|
+
error_codes?: Array<string>;
|
|
41
|
+
suberror?: string;
|
|
42
|
+
timestamp?: string;
|
|
43
|
+
trace_id?: string;
|
|
44
|
+
correlation_id?: string;
|
|
45
|
+
claims?: string;
|
|
46
|
+
};
|
|
47
47
|
//# sourceMappingURL=ServerAuthorizationTokenResponse.d.ts.map
|
|
@@ -1,52 +1,52 @@
|
|
|
1
|
-
import { PerformanceEvent } from "./PerformanceEvent";
|
|
2
|
-
import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
|
|
3
|
-
export type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void;
|
|
4
|
-
export type InProgressPerformanceEvent = {
|
|
5
|
-
end: (event?: Partial<PerformanceEvent>) => PerformanceEvent | null;
|
|
6
|
-
discard: () => void;
|
|
7
|
-
add: (fields: {
|
|
8
|
-
[key: string]: {} | undefined;
|
|
9
|
-
}) => void;
|
|
10
|
-
increment: (fields: {
|
|
11
|
-
[key: string]: number | undefined;
|
|
12
|
-
}) => void;
|
|
13
|
-
event: PerformanceEvent;
|
|
14
|
-
measurement: IPerformanceMeasurement;
|
|
15
|
-
};
|
|
16
|
-
export interface IPerformanceClient {
|
|
17
|
-
startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
|
|
18
|
-
endMeasurement(event: PerformanceEvent): PerformanceEvent | null;
|
|
19
|
-
discardMeasurements(correlationId: string): void;
|
|
20
|
-
addFields(fields: {
|
|
21
|
-
[key: string]: {} | undefined;
|
|
22
|
-
}, correlationId: string): void;
|
|
23
|
-
incrementFields(fields: {
|
|
24
|
-
[key: string]: number | undefined;
|
|
25
|
-
}, correlationId: string): void;
|
|
26
|
-
removePerformanceCallback(callbackId: string): boolean;
|
|
27
|
-
addPerformanceCallback(callback: PerformanceCallbackFunction): string;
|
|
28
|
-
emitEvents(events: PerformanceEvent[], correlationId: string): void;
|
|
29
|
-
startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement;
|
|
30
|
-
generateId(): string;
|
|
31
|
-
calculateQueuedTime(preQueueTime: number, currentTime: number): number;
|
|
32
|
-
addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
|
|
33
|
-
setPreQueueTime(eventName: string, correlationId?: string): void;
|
|
34
|
-
}
|
|
35
|
-
/**
|
|
36
|
-
* Queue measurement type
|
|
37
|
-
*/
|
|
38
|
-
export type QueueMeasurement = {
|
|
39
|
-
/**
|
|
40
|
-
* Name of performance event
|
|
41
|
-
*/
|
|
42
|
-
eventName: string;
|
|
43
|
-
/**
|
|
44
|
-
* Time spent in JS queue
|
|
45
|
-
*/
|
|
46
|
-
queueTime: number;
|
|
47
|
-
/**
|
|
48
|
-
* Incomplete pre-queue events are instrumentation bugs that should be fixed.
|
|
49
|
-
*/
|
|
50
|
-
manuallyCompleted?: boolean;
|
|
51
|
-
};
|
|
1
|
+
import { PerformanceEvent } from "./PerformanceEvent";
|
|
2
|
+
import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
|
|
3
|
+
export type PerformanceCallbackFunction = (events: PerformanceEvent[]) => void;
|
|
4
|
+
export type InProgressPerformanceEvent = {
|
|
5
|
+
end: (event?: Partial<PerformanceEvent>) => PerformanceEvent | null;
|
|
6
|
+
discard: () => void;
|
|
7
|
+
add: (fields: {
|
|
8
|
+
[key: string]: {} | undefined;
|
|
9
|
+
}) => void;
|
|
10
|
+
increment: (fields: {
|
|
11
|
+
[key: string]: number | undefined;
|
|
12
|
+
}) => void;
|
|
13
|
+
event: PerformanceEvent;
|
|
14
|
+
measurement: IPerformanceMeasurement;
|
|
15
|
+
};
|
|
16
|
+
export interface IPerformanceClient {
|
|
17
|
+
startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
|
|
18
|
+
endMeasurement(event: PerformanceEvent): PerformanceEvent | null;
|
|
19
|
+
discardMeasurements(correlationId: string): void;
|
|
20
|
+
addFields(fields: {
|
|
21
|
+
[key: string]: {} | undefined;
|
|
22
|
+
}, correlationId: string): void;
|
|
23
|
+
incrementFields(fields: {
|
|
24
|
+
[key: string]: number | undefined;
|
|
25
|
+
}, correlationId: string): void;
|
|
26
|
+
removePerformanceCallback(callbackId: string): boolean;
|
|
27
|
+
addPerformanceCallback(callback: PerformanceCallbackFunction): string;
|
|
28
|
+
emitEvents(events: PerformanceEvent[], correlationId: string): void;
|
|
29
|
+
startPerformanceMeasurement(measureName: string, correlationId: string): IPerformanceMeasurement;
|
|
30
|
+
generateId(): string;
|
|
31
|
+
calculateQueuedTime(preQueueTime: number, currentTime: number): number;
|
|
32
|
+
addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
|
|
33
|
+
setPreQueueTime(eventName: string, correlationId?: string): void;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Queue measurement type
|
|
37
|
+
*/
|
|
38
|
+
export type QueueMeasurement = {
|
|
39
|
+
/**
|
|
40
|
+
* Name of performance event
|
|
41
|
+
*/
|
|
42
|
+
eventName: string;
|
|
43
|
+
/**
|
|
44
|
+
* Time spent in JS queue
|
|
45
|
+
*/
|
|
46
|
+
queueTime: number;
|
|
47
|
+
/**
|
|
48
|
+
* Incomplete pre-queue events are instrumentation bugs that should be fixed.
|
|
49
|
+
*/
|
|
50
|
+
manuallyCompleted?: boolean;
|
|
51
|
+
};
|
|
52
52
|
//# sourceMappingURL=IPerformanceClient.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export interface IPerformanceMeasurement {
|
|
2
|
-
startMeasurement(): void;
|
|
3
|
-
endMeasurement(): void;
|
|
4
|
-
flushMeasurement(): number | null;
|
|
5
|
-
}
|
|
1
|
+
export interface IPerformanceMeasurement {
|
|
2
|
+
startMeasurement(): void;
|
|
3
|
+
endMeasurement(): void;
|
|
4
|
+
flushMeasurement(): number | null;
|
|
5
|
+
}
|
|
6
6
|
//# sourceMappingURL=IPerformanceMeasurement.d.ts.map
|
|
@@ -1,192 +1,192 @@
|
|
|
1
|
-
import { ApplicationTelemetry } from "../../config/ClientConfiguration";
|
|
2
|
-
import { Logger } from "../../logger/Logger";
|
|
3
|
-
import { InProgressPerformanceEvent, IPerformanceClient, PerformanceCallbackFunction, QueueMeasurement } from "./IPerformanceClient";
|
|
4
|
-
import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
|
|
5
|
-
import { PerformanceEvent, PerformanceEvents } from "./PerformanceEvent";
|
|
6
|
-
export interface PreQueueEvent {
|
|
7
|
-
name: PerformanceEvents;
|
|
8
|
-
time: number;
|
|
9
|
-
}
|
|
10
|
-
export declare abstract class PerformanceClient implements IPerformanceClient {
|
|
11
|
-
protected authority: string;
|
|
12
|
-
protected libraryName: string;
|
|
13
|
-
protected libraryVersion: string;
|
|
14
|
-
protected applicationTelemetry: ApplicationTelemetry;
|
|
15
|
-
protected clientId: string;
|
|
16
|
-
protected logger: Logger;
|
|
17
|
-
protected callbacks: Map<string, PerformanceCallbackFunction>;
|
|
18
|
-
/**
|
|
19
|
-
* Multiple events with the same correlation id.
|
|
20
|
-
* @protected
|
|
21
|
-
* @type {Map<string, PerformanceEvent>}
|
|
22
|
-
*/
|
|
23
|
-
protected eventsByCorrelationId: Map<string, PerformanceEvent>;
|
|
24
|
-
/**
|
|
25
|
-
* Map of pre-queue times by correlation Id
|
|
26
|
-
*
|
|
27
|
-
* @protected
|
|
28
|
-
* @type {Map<string, PreQueueEvent>}
|
|
29
|
-
*/
|
|
30
|
-
protected preQueueTimeByCorrelationId: Map<string, PreQueueEvent>;
|
|
31
|
-
/**
|
|
32
|
-
* Map of queue measurements by correlation Id
|
|
33
|
-
*
|
|
34
|
-
* @protected
|
|
35
|
-
* @type {Map<string, Array<QueueMeasurement>>}
|
|
36
|
-
*/
|
|
37
|
-
protected queueMeasurements: Map<string, Array<QueueMeasurement>>;
|
|
38
|
-
protected intFields: Set<string>;
|
|
39
|
-
/**
|
|
40
|
-
* Creates an instance of PerformanceClient,
|
|
41
|
-
* an abstract class containing core performance telemetry logic.
|
|
42
|
-
*
|
|
43
|
-
* @constructor
|
|
44
|
-
* @param {string} clientId Client ID of the application
|
|
45
|
-
* @param {string} authority Authority used by the application
|
|
46
|
-
* @param {Logger} logger Logger used by the application
|
|
47
|
-
* @param {string} libraryName Name of the library
|
|
48
|
-
* @param {string} libraryVersion Version of the library
|
|
49
|
-
* @param {ApplicationTelemetry} applicationTelemetry application name and version
|
|
50
|
-
* @param {Set<String>} intFields integer fields to be truncated
|
|
51
|
-
*/
|
|
52
|
-
constructor(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, intFields?: Set<string>);
|
|
53
|
-
/**
|
|
54
|
-
* Generates and returns a unique id, typically a guid.
|
|
55
|
-
*
|
|
56
|
-
* @abstract
|
|
57
|
-
* @returns {string}
|
|
58
|
-
*/
|
|
59
|
-
abstract generateId(): string;
|
|
60
|
-
/**
|
|
61
|
-
* Starts and returns an platform-specific implementation of IPerformanceMeasurement.
|
|
62
|
-
* Note: this function can be changed to abstract at the next major version bump.
|
|
63
|
-
*
|
|
64
|
-
* @param {string} measureName
|
|
65
|
-
* @param {string} correlationId
|
|
66
|
-
* @returns {IPerformanceMeasurement}
|
|
67
|
-
*/
|
|
68
|
-
startPerformanceMeasurement(measureName: string, // eslint-disable-line @typescript-eslint/no-unused-vars
|
|
69
|
-
correlationId: string): IPerformanceMeasurement;
|
|
70
|
-
/**
|
|
71
|
-
* Sets pre-queue time by correlation Id
|
|
72
|
-
*
|
|
73
|
-
* @abstract
|
|
74
|
-
* @param {PerformanceEvents} eventName
|
|
75
|
-
* @param {string} correlationId
|
|
76
|
-
* @returns
|
|
77
|
-
*/
|
|
78
|
-
abstract setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
|
|
79
|
-
/**
|
|
80
|
-
* Gets map of pre-queue times by correlation Id
|
|
81
|
-
*
|
|
82
|
-
* @param {PerformanceEvents} eventName
|
|
83
|
-
* @param {string} correlationId
|
|
84
|
-
* @returns {number}
|
|
85
|
-
*/
|
|
86
|
-
getPreQueueTime(eventName: string, correlationId: string): number | void;
|
|
87
|
-
/**
|
|
88
|
-
* Calculates the difference between current time and time when function was queued.
|
|
89
|
-
* Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
|
|
90
|
-
*
|
|
91
|
-
* @param {number} preQueueTime
|
|
92
|
-
* @param {number} currentTime
|
|
93
|
-
* @returns {number}
|
|
94
|
-
*/
|
|
95
|
-
calculateQueuedTime(preQueueTime: number, currentTime: number): number;
|
|
96
|
-
/**
|
|
97
|
-
* Adds queue measurement time to QueueMeasurements array for given correlation ID.
|
|
98
|
-
*
|
|
99
|
-
* @param {PerformanceEvents} eventName
|
|
100
|
-
* @param {?string} correlationId
|
|
101
|
-
* @param {?number} queueTime
|
|
102
|
-
* @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
|
|
103
|
-
* @returns
|
|
104
|
-
*/
|
|
105
|
-
addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
|
|
106
|
-
/**
|
|
107
|
-
* Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
|
|
108
|
-
*
|
|
109
|
-
* @param {PerformanceEvents} measureName
|
|
110
|
-
* @param {?string} [correlationId]
|
|
111
|
-
* @returns {InProgressPerformanceEvent}
|
|
112
|
-
*/
|
|
113
|
-
startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
|
|
114
|
-
/**
|
|
115
|
-
* Stops measuring the performance for an operation. Should only be called directly by PerformanceClient classes,
|
|
116
|
-
* as consumers should instead use the function returned by startMeasurement.
|
|
117
|
-
* Adds a new field named as "[event name]DurationMs" for sub-measurements, completes and emits an event
|
|
118
|
-
* otherwise.
|
|
119
|
-
*
|
|
120
|
-
* @param {PerformanceEvent} event
|
|
121
|
-
* @param {IPerformanceMeasurement} measurement
|
|
122
|
-
* @returns {(PerformanceEvent | null)}
|
|
123
|
-
*/
|
|
124
|
-
endMeasurement(event: PerformanceEvent, measurement?: IPerformanceMeasurement): PerformanceEvent | null;
|
|
125
|
-
/**
|
|
126
|
-
* Saves extra information to be emitted when the measurements are flushed
|
|
127
|
-
* @param fields
|
|
128
|
-
* @param correlationId
|
|
129
|
-
*/
|
|
130
|
-
addFields(fields: {
|
|
131
|
-
[key: string]: {} | undefined;
|
|
132
|
-
}, correlationId: string): void;
|
|
133
|
-
/**
|
|
134
|
-
* Increment counters to be emitted when the measurements are flushed
|
|
135
|
-
* @param fields {string[]}
|
|
136
|
-
* @param correlationId {string} correlation identifier
|
|
137
|
-
*/
|
|
138
|
-
incrementFields(fields: {
|
|
139
|
-
[key: string]: number | undefined;
|
|
140
|
-
}, correlationId: string): void;
|
|
141
|
-
/**
|
|
142
|
-
* Upserts event into event cache.
|
|
143
|
-
* First key is the correlation id, second key is the event id.
|
|
144
|
-
* Allows for events to be grouped by correlation id,
|
|
145
|
-
* and to easily allow for properties on them to be updated.
|
|
146
|
-
*
|
|
147
|
-
* @private
|
|
148
|
-
* @param {PerformanceEvent} event
|
|
149
|
-
*/
|
|
150
|
-
protected cacheEventByCorrelationId(event: PerformanceEvent): void;
|
|
151
|
-
private getQueueInfo;
|
|
152
|
-
/**
|
|
153
|
-
* Removes measurements for a given correlation id.
|
|
154
|
-
*
|
|
155
|
-
* @param {string} correlationId
|
|
156
|
-
*/
|
|
157
|
-
discardMeasurements(correlationId: string): void;
|
|
158
|
-
/**
|
|
159
|
-
* Removes cache for a given correlation id.
|
|
160
|
-
*
|
|
161
|
-
* @param {string} correlationId correlation identifier
|
|
162
|
-
*/
|
|
163
|
-
private discardCache;
|
|
164
|
-
/**
|
|
165
|
-
* Registers a callback function to receive performance events.
|
|
166
|
-
*
|
|
167
|
-
* @param {PerformanceCallbackFunction} callback
|
|
168
|
-
* @returns {string}
|
|
169
|
-
*/
|
|
170
|
-
addPerformanceCallback(callback: PerformanceCallbackFunction): string;
|
|
171
|
-
/**
|
|
172
|
-
* Removes a callback registered with addPerformanceCallback.
|
|
173
|
-
*
|
|
174
|
-
* @param {string} callbackId
|
|
175
|
-
* @returns {boolean}
|
|
176
|
-
*/
|
|
177
|
-
removePerformanceCallback(callbackId: string): boolean;
|
|
178
|
-
/**
|
|
179
|
-
* Emits events to all registered callbacks.
|
|
180
|
-
*
|
|
181
|
-
* @param {PerformanceEvent[]} events
|
|
182
|
-
* @param {?string} [correlationId]
|
|
183
|
-
*/
|
|
184
|
-
emitEvents(events: PerformanceEvent[], correlationId: string): void;
|
|
185
|
-
/**
|
|
186
|
-
* Enforce truncation of integral fields in performance event.
|
|
187
|
-
* @param {PerformanceEvent} event performance event to update.
|
|
188
|
-
* @param {Set<string>} intFields integral fields.
|
|
189
|
-
*/
|
|
190
|
-
private truncateIntegralFields;
|
|
191
|
-
}
|
|
1
|
+
import { ApplicationTelemetry } from "../../config/ClientConfiguration";
|
|
2
|
+
import { Logger } from "../../logger/Logger";
|
|
3
|
+
import { InProgressPerformanceEvent, IPerformanceClient, PerformanceCallbackFunction, QueueMeasurement } from "./IPerformanceClient";
|
|
4
|
+
import { IPerformanceMeasurement } from "./IPerformanceMeasurement";
|
|
5
|
+
import { PerformanceEvent, PerformanceEvents } from "./PerformanceEvent";
|
|
6
|
+
export interface PreQueueEvent {
|
|
7
|
+
name: PerformanceEvents;
|
|
8
|
+
time: number;
|
|
9
|
+
}
|
|
10
|
+
export declare abstract class PerformanceClient implements IPerformanceClient {
|
|
11
|
+
protected authority: string;
|
|
12
|
+
protected libraryName: string;
|
|
13
|
+
protected libraryVersion: string;
|
|
14
|
+
protected applicationTelemetry: ApplicationTelemetry;
|
|
15
|
+
protected clientId: string;
|
|
16
|
+
protected logger: Logger;
|
|
17
|
+
protected callbacks: Map<string, PerformanceCallbackFunction>;
|
|
18
|
+
/**
|
|
19
|
+
* Multiple events with the same correlation id.
|
|
20
|
+
* @protected
|
|
21
|
+
* @type {Map<string, PerformanceEvent>}
|
|
22
|
+
*/
|
|
23
|
+
protected eventsByCorrelationId: Map<string, PerformanceEvent>;
|
|
24
|
+
/**
|
|
25
|
+
* Map of pre-queue times by correlation Id
|
|
26
|
+
*
|
|
27
|
+
* @protected
|
|
28
|
+
* @type {Map<string, PreQueueEvent>}
|
|
29
|
+
*/
|
|
30
|
+
protected preQueueTimeByCorrelationId: Map<string, PreQueueEvent>;
|
|
31
|
+
/**
|
|
32
|
+
* Map of queue measurements by correlation Id
|
|
33
|
+
*
|
|
34
|
+
* @protected
|
|
35
|
+
* @type {Map<string, Array<QueueMeasurement>>}
|
|
36
|
+
*/
|
|
37
|
+
protected queueMeasurements: Map<string, Array<QueueMeasurement>>;
|
|
38
|
+
protected intFields: Set<string>;
|
|
39
|
+
/**
|
|
40
|
+
* Creates an instance of PerformanceClient,
|
|
41
|
+
* an abstract class containing core performance telemetry logic.
|
|
42
|
+
*
|
|
43
|
+
* @constructor
|
|
44
|
+
* @param {string} clientId Client ID of the application
|
|
45
|
+
* @param {string} authority Authority used by the application
|
|
46
|
+
* @param {Logger} logger Logger used by the application
|
|
47
|
+
* @param {string} libraryName Name of the library
|
|
48
|
+
* @param {string} libraryVersion Version of the library
|
|
49
|
+
* @param {ApplicationTelemetry} applicationTelemetry application name and version
|
|
50
|
+
* @param {Set<String>} intFields integer fields to be truncated
|
|
51
|
+
*/
|
|
52
|
+
constructor(clientId: string, authority: string, logger: Logger, libraryName: string, libraryVersion: string, applicationTelemetry: ApplicationTelemetry, intFields?: Set<string>);
|
|
53
|
+
/**
|
|
54
|
+
* Generates and returns a unique id, typically a guid.
|
|
55
|
+
*
|
|
56
|
+
* @abstract
|
|
57
|
+
* @returns {string}
|
|
58
|
+
*/
|
|
59
|
+
abstract generateId(): string;
|
|
60
|
+
/**
|
|
61
|
+
* Starts and returns an platform-specific implementation of IPerformanceMeasurement.
|
|
62
|
+
* Note: this function can be changed to abstract at the next major version bump.
|
|
63
|
+
*
|
|
64
|
+
* @param {string} measureName
|
|
65
|
+
* @param {string} correlationId
|
|
66
|
+
* @returns {IPerformanceMeasurement}
|
|
67
|
+
*/
|
|
68
|
+
startPerformanceMeasurement(measureName: string, // eslint-disable-line @typescript-eslint/no-unused-vars
|
|
69
|
+
correlationId: string): IPerformanceMeasurement;
|
|
70
|
+
/**
|
|
71
|
+
* Sets pre-queue time by correlation Id
|
|
72
|
+
*
|
|
73
|
+
* @abstract
|
|
74
|
+
* @param {PerformanceEvents} eventName
|
|
75
|
+
* @param {string} correlationId
|
|
76
|
+
* @returns
|
|
77
|
+
*/
|
|
78
|
+
abstract setPreQueueTime(eventName: PerformanceEvents, correlationId?: string): void;
|
|
79
|
+
/**
|
|
80
|
+
* Gets map of pre-queue times by correlation Id
|
|
81
|
+
*
|
|
82
|
+
* @param {PerformanceEvents} eventName
|
|
83
|
+
* @param {string} correlationId
|
|
84
|
+
* @returns {number}
|
|
85
|
+
*/
|
|
86
|
+
getPreQueueTime(eventName: string, correlationId: string): number | void;
|
|
87
|
+
/**
|
|
88
|
+
* Calculates the difference between current time and time when function was queued.
|
|
89
|
+
* Note: It is possible to have 0 as the queue time if the current time and the queued time was the same.
|
|
90
|
+
*
|
|
91
|
+
* @param {number} preQueueTime
|
|
92
|
+
* @param {number} currentTime
|
|
93
|
+
* @returns {number}
|
|
94
|
+
*/
|
|
95
|
+
calculateQueuedTime(preQueueTime: number, currentTime: number): number;
|
|
96
|
+
/**
|
|
97
|
+
* Adds queue measurement time to QueueMeasurements array for given correlation ID.
|
|
98
|
+
*
|
|
99
|
+
* @param {PerformanceEvents} eventName
|
|
100
|
+
* @param {?string} correlationId
|
|
101
|
+
* @param {?number} queueTime
|
|
102
|
+
* @param {?boolean} manuallyCompleted - indicator for manually completed queue measurements
|
|
103
|
+
* @returns
|
|
104
|
+
*/
|
|
105
|
+
addQueueMeasurement(eventName: string, correlationId?: string, queueTime?: number, manuallyCompleted?: boolean): void;
|
|
106
|
+
/**
|
|
107
|
+
* Starts measuring performance for a given operation. Returns a function that should be used to end the measurement.
|
|
108
|
+
*
|
|
109
|
+
* @param {PerformanceEvents} measureName
|
|
110
|
+
* @param {?string} [correlationId]
|
|
111
|
+
* @returns {InProgressPerformanceEvent}
|
|
112
|
+
*/
|
|
113
|
+
startMeasurement(measureName: string, correlationId?: string): InProgressPerformanceEvent;
|
|
114
|
+
/**
|
|
115
|
+
* Stops measuring the performance for an operation. Should only be called directly by PerformanceClient classes,
|
|
116
|
+
* as consumers should instead use the function returned by startMeasurement.
|
|
117
|
+
* Adds a new field named as "[event name]DurationMs" for sub-measurements, completes and emits an event
|
|
118
|
+
* otherwise.
|
|
119
|
+
*
|
|
120
|
+
* @param {PerformanceEvent} event
|
|
121
|
+
* @param {IPerformanceMeasurement} measurement
|
|
122
|
+
* @returns {(PerformanceEvent | null)}
|
|
123
|
+
*/
|
|
124
|
+
endMeasurement(event: PerformanceEvent, measurement?: IPerformanceMeasurement): PerformanceEvent | null;
|
|
125
|
+
/**
|
|
126
|
+
* Saves extra information to be emitted when the measurements are flushed
|
|
127
|
+
* @param fields
|
|
128
|
+
* @param correlationId
|
|
129
|
+
*/
|
|
130
|
+
addFields(fields: {
|
|
131
|
+
[key: string]: {} | undefined;
|
|
132
|
+
}, correlationId: string): void;
|
|
133
|
+
/**
|
|
134
|
+
* Increment counters to be emitted when the measurements are flushed
|
|
135
|
+
* @param fields {string[]}
|
|
136
|
+
* @param correlationId {string} correlation identifier
|
|
137
|
+
*/
|
|
138
|
+
incrementFields(fields: {
|
|
139
|
+
[key: string]: number | undefined;
|
|
140
|
+
}, correlationId: string): void;
|
|
141
|
+
/**
|
|
142
|
+
* Upserts event into event cache.
|
|
143
|
+
* First key is the correlation id, second key is the event id.
|
|
144
|
+
* Allows for events to be grouped by correlation id,
|
|
145
|
+
* and to easily allow for properties on them to be updated.
|
|
146
|
+
*
|
|
147
|
+
* @private
|
|
148
|
+
* @param {PerformanceEvent} event
|
|
149
|
+
*/
|
|
150
|
+
protected cacheEventByCorrelationId(event: PerformanceEvent): void;
|
|
151
|
+
private getQueueInfo;
|
|
152
|
+
/**
|
|
153
|
+
* Removes measurements for a given correlation id.
|
|
154
|
+
*
|
|
155
|
+
* @param {string} correlationId
|
|
156
|
+
*/
|
|
157
|
+
discardMeasurements(correlationId: string): void;
|
|
158
|
+
/**
|
|
159
|
+
* Removes cache for a given correlation id.
|
|
160
|
+
*
|
|
161
|
+
* @param {string} correlationId correlation identifier
|
|
162
|
+
*/
|
|
163
|
+
private discardCache;
|
|
164
|
+
/**
|
|
165
|
+
* Registers a callback function to receive performance events.
|
|
166
|
+
*
|
|
167
|
+
* @param {PerformanceCallbackFunction} callback
|
|
168
|
+
* @returns {string}
|
|
169
|
+
*/
|
|
170
|
+
addPerformanceCallback(callback: PerformanceCallbackFunction): string;
|
|
171
|
+
/**
|
|
172
|
+
* Removes a callback registered with addPerformanceCallback.
|
|
173
|
+
*
|
|
174
|
+
* @param {string} callbackId
|
|
175
|
+
* @returns {boolean}
|
|
176
|
+
*/
|
|
177
|
+
removePerformanceCallback(callbackId: string): boolean;
|
|
178
|
+
/**
|
|
179
|
+
* Emits events to all registered callbacks.
|
|
180
|
+
*
|
|
181
|
+
* @param {PerformanceEvent[]} events
|
|
182
|
+
* @param {?string} [correlationId]
|
|
183
|
+
*/
|
|
184
|
+
emitEvents(events: PerformanceEvent[], correlationId: string): void;
|
|
185
|
+
/**
|
|
186
|
+
* Enforce truncation of integral fields in performance event.
|
|
187
|
+
* @param {PerformanceEvent} event performance event to update.
|
|
188
|
+
* @param {Set<string>} intFields integral fields.
|
|
189
|
+
*/
|
|
190
|
+
private truncateIntegralFields;
|
|
191
|
+
}
|
|
192
192
|
//# sourceMappingURL=PerformanceClient.d.ts.map
|