@azure/msal-common 14.14.0 → 14.14.1
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 +66 -66
- package/dist/account/AccountInfo.mjs +77 -77
- 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 +19 -19
- package/dist/account/ClientInfo.d.ts +18 -18
- package/dist/account/ClientInfo.mjs +37 -37
- package/dist/account/TokenClaims.d.ts +83 -83
- package/dist/account/TokenClaims.mjs +20 -20
- package/dist/authority/Authority.d.ts +254 -254
- package/dist/authority/Authority.mjs +836 -836
- package/dist/authority/AuthorityFactory.d.ts +18 -18
- package/dist/authority/AuthorityFactory.mjs +28 -28
- package/dist/authority/AuthorityMetadata.d.ts +43 -43
- package/dist/authority/AuthorityMetadata.mjs +137 -137
- package/dist/authority/AuthorityOptions.d.ts +27 -27
- package/dist/authority/AuthorityOptions.mjs +18 -18
- 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 +497 -497
- package/dist/cache/CacheManager.mjs +1249 -1249
- package/dist/cache/entities/AccessTokenEntity.d.ts +25 -25
- package/dist/cache/entities/AccountEntity.d.ts +106 -106
- package/dist/cache/entities/AccountEntity.mjs +240 -240
- package/dist/cache/entities/AppMetadataEntity.d.ts +11 -11
- package/dist/cache/entities/AuthorityMetadataEntity.d.ts +15 -15
- package/dist/cache/entities/CacheRecord.d.ts +13 -13
- package/dist/cache/entities/CredentialEntity.d.ts +30 -30
- package/dist/cache/entities/IdTokenEntity.d.ts +8 -8
- package/dist/cache/entities/RefreshTokenEntity.d.ts +7 -7
- package/dist/cache/entities/ServerTelemetryEntity.d.ts +6 -6
- package/dist/cache/entities/ThrottlingEntity.d.ts +7 -7
- 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/CacheHelpers.d.ts +94 -94
- package/dist/cache/utils/CacheHelpers.mjs +324 -324
- package/dist/cache/utils/CacheTypes.d.ts +69 -69
- package/dist/client/AuthorizationCodeClient.d.ts +74 -74
- package/dist/client/AuthorizationCodeClient.mjs +420 -420
- package/dist/client/BaseClient.d.ts +51 -51
- package/dist/client/BaseClient.mjs +100 -100
- package/dist/client/RefreshTokenClient.d.ts +35 -35
- package/dist/client/RefreshTokenClient.mjs +211 -211
- package/dist/client/SilentFlowClient.d.ts +27 -27
- package/dist/client/SilentFlowClient.mjs +133 -133
- package/dist/config/AppTokenProvider.d.ts +38 -38
- package/dist/config/ClientConfiguration.d.ts +150 -150
- package/dist/config/ClientConfiguration.mjs +95 -95
- package/dist/constants/AADServerParamKeys.d.ts +53 -53
- package/dist/constants/AADServerParamKeys.mjs +57 -57
- package/dist/crypto/ICrypto.d.ts +68 -68
- package/dist/crypto/ICrypto.mjs +36 -36
- 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 +59 -59
- package/dist/crypto/PopTokenGenerator.mjs +81 -81
- package/dist/crypto/SignedHttpRequest.d.ts +15 -15
- 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/CacheError.d.ts +20 -20
- package/dist/error/CacheError.mjs +24 -24
- package/dist/error/CacheErrorCodes.d.ts +2 -2
- package/dist/error/CacheErrorCodes.mjs +6 -6
- package/dist/error/ClientAuthError.d.ts +237 -237
- package/dist/error/ClientAuthError.mjs +249 -249
- package/dist/error/ClientAuthErrorCodes.d.ts +44 -44
- package/dist/error/ClientAuthErrorCodes.mjs +48 -48
- 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 +65 -65
- package/dist/error/InteractionRequiredAuthError.mjs +85 -85
- package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +7 -7
- package/dist/error/InteractionRequiredAuthErrorCodes.mjs +13 -13
- 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 +15 -15
- package/dist/error/ServerError.mjs +16 -16
- package/dist/index.cjs +8662 -8658
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +107 -107
- package/dist/index.mjs +1 -1
- 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 +18 -18
- 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.mjs +4 -4
- package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
- package/dist/request/AuthenticationHeaderParser.mjs +55 -55
- package/dist/request/BaseAuthRequest.d.ts +47 -47
- 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 +27 -27
- 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 +382 -382
- package/dist/request/RequestValidator.d.ts +27 -27
- package/dist/request/RequestValidator.mjs +64 -64
- 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 +69 -69
- package/dist/response/ResponseHandler.mjs +374 -374
- package/dist/response/ServerAuthorizationCodeResponse.d.ts +26 -26
- package/dist/response/ServerAuthorizationTokenResponse.d.ts +47 -47
- package/dist/telemetry/performance/IPerformanceClient.d.ts +57 -57
- package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
- package/dist/telemetry/performance/PerformanceClient.d.ts +242 -242
- package/dist/telemetry/performance/PerformanceClient.mjs +587 -587
- package/dist/telemetry/performance/PerformanceEvent.d.ts +515 -505
- package/dist/telemetry/performance/PerformanceEvent.d.ts.map +1 -1
- package/dist/telemetry/performance/PerformanceEvent.mjs +484 -480
- 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 +78 -78
- package/dist/telemetry/server/ServerTelemetryManager.mjs +260 -260
- package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
- package/dist/url/IUri.d.ts +12 -12
- package/dist/url/UrlString.d.ts +48 -48
- package/dist/url/UrlString.mjs +161 -161
- package/dist/utils/ClientAssertionUtils.d.ts +2 -2
- package/dist/utils/ClientAssertionUtils.mjs +16 -16
- package/dist/utils/Constants.d.ts +309 -309
- package/dist/utils/Constants.mjs +322 -322
- package/dist/utils/FunctionWrappers.d.ts +27 -27
- package/dist/utils/FunctionWrappers.mjs +94 -94
- 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 +25 -25
- package/dist/utils/TimeUtils.mjs +43 -43
- package/dist/utils/UrlUtils.d.ts +10 -10
- package/dist/utils/UrlUtils.mjs +44 -44
- package/package.json +1 -1
- package/src/packageMetadata.ts +1 -1
- package/src/telemetry/performance/PerformanceEvent.ts +12 -0
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Validates server consumable params from the "request" objects
|
|
3
|
-
*/
|
|
4
|
-
export declare class RequestValidator {
|
|
5
|
-
/**
|
|
6
|
-
* Utility to check if the `redirectUri` in the request is a non-null value
|
|
7
|
-
* @param redirectUri
|
|
8
|
-
*/
|
|
9
|
-
static validateRedirectUri(redirectUri: string): void;
|
|
10
|
-
/**
|
|
11
|
-
* Utility to validate prompt sent by the user in the request
|
|
12
|
-
* @param prompt
|
|
13
|
-
*/
|
|
14
|
-
static validatePrompt(prompt: string): void;
|
|
15
|
-
static validateClaims(claims: string): void;
|
|
16
|
-
/**
|
|
17
|
-
* Utility to validate code_challenge and code_challenge_method
|
|
18
|
-
* @param codeChallenge
|
|
19
|
-
* @param codeChallengeMethod
|
|
20
|
-
*/
|
|
21
|
-
static validateCodeChallengeParams(codeChallenge: string, codeChallengeMethod: string): void;
|
|
22
|
-
/**
|
|
23
|
-
* Utility to validate code_challenge_method
|
|
24
|
-
* @param codeChallengeMethod
|
|
25
|
-
*/
|
|
26
|
-
static validateCodeChallengeMethod(codeChallengeMethod: string): void;
|
|
27
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* Validates server consumable params from the "request" objects
|
|
3
|
+
*/
|
|
4
|
+
export declare class RequestValidator {
|
|
5
|
+
/**
|
|
6
|
+
* Utility to check if the `redirectUri` in the request is a non-null value
|
|
7
|
+
* @param redirectUri
|
|
8
|
+
*/
|
|
9
|
+
static validateRedirectUri(redirectUri: string): void;
|
|
10
|
+
/**
|
|
11
|
+
* Utility to validate prompt sent by the user in the request
|
|
12
|
+
* @param prompt
|
|
13
|
+
*/
|
|
14
|
+
static validatePrompt(prompt: string): void;
|
|
15
|
+
static validateClaims(claims: string): void;
|
|
16
|
+
/**
|
|
17
|
+
* Utility to validate code_challenge and code_challenge_method
|
|
18
|
+
* @param codeChallenge
|
|
19
|
+
* @param codeChallengeMethod
|
|
20
|
+
*/
|
|
21
|
+
static validateCodeChallengeParams(codeChallenge: string, codeChallengeMethod: string): void;
|
|
22
|
+
/**
|
|
23
|
+
* Utility to validate code_challenge_method
|
|
24
|
+
* @param codeChallengeMethod
|
|
25
|
+
*/
|
|
26
|
+
static validateCodeChallengeMethod(codeChallengeMethod: string): void;
|
|
27
|
+
}
|
|
28
28
|
//# sourceMappingURL=RequestValidator.d.ts.map
|
|
@@ -1,72 +1,72 @@
|
|
|
1
|
-
/*! @azure/msal-common v14.14.
|
|
1
|
+
/*! @azure/msal-common v14.14.1 2024-08-13 */
|
|
2
2
|
'use strict';
|
|
3
3
|
import { createClientConfigurationError } from '../error/ClientConfigurationError.mjs';
|
|
4
4
|
import { CodeChallengeMethodValues, PromptValue } from '../utils/Constants.mjs';
|
|
5
5
|
import { redirectUriEmpty, invalidPromptValue, invalidClaims, pkceParamsMissing, invalidCodeChallengeMethod } from '../error/ClientConfigurationErrorCodes.mjs';
|
|
6
6
|
|
|
7
|
-
/*
|
|
8
|
-
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
9
|
-
* Licensed under the MIT License.
|
|
10
|
-
*/
|
|
11
|
-
/**
|
|
12
|
-
* Validates server consumable params from the "request" objects
|
|
13
|
-
*/
|
|
14
|
-
class RequestValidator {
|
|
15
|
-
/**
|
|
16
|
-
* Utility to check if the `redirectUri` in the request is a non-null value
|
|
17
|
-
* @param redirectUri
|
|
18
|
-
*/
|
|
19
|
-
static validateRedirectUri(redirectUri) {
|
|
20
|
-
if (!redirectUri) {
|
|
21
|
-
throw createClientConfigurationError(redirectUriEmpty);
|
|
22
|
-
}
|
|
23
|
-
}
|
|
24
|
-
/**
|
|
25
|
-
* Utility to validate prompt sent by the user in the request
|
|
26
|
-
* @param prompt
|
|
27
|
-
*/
|
|
28
|
-
static validatePrompt(prompt) {
|
|
29
|
-
const promptValues = [];
|
|
30
|
-
for (const value in PromptValue) {
|
|
31
|
-
promptValues.push(PromptValue[value]);
|
|
32
|
-
}
|
|
33
|
-
if (promptValues.indexOf(prompt) < 0) {
|
|
34
|
-
throw createClientConfigurationError(invalidPromptValue);
|
|
35
|
-
}
|
|
36
|
-
}
|
|
37
|
-
static validateClaims(claims) {
|
|
38
|
-
try {
|
|
39
|
-
JSON.parse(claims);
|
|
40
|
-
}
|
|
41
|
-
catch (e) {
|
|
42
|
-
throw createClientConfigurationError(invalidClaims);
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
/**
|
|
46
|
-
* Utility to validate code_challenge and code_challenge_method
|
|
47
|
-
* @param codeChallenge
|
|
48
|
-
* @param codeChallengeMethod
|
|
49
|
-
*/
|
|
50
|
-
static validateCodeChallengeParams(codeChallenge, codeChallengeMethod) {
|
|
51
|
-
if (!codeChallenge || !codeChallengeMethod) {
|
|
52
|
-
throw createClientConfigurationError(pkceParamsMissing);
|
|
53
|
-
}
|
|
54
|
-
else {
|
|
55
|
-
this.validateCodeChallengeMethod(codeChallengeMethod);
|
|
56
|
-
}
|
|
57
|
-
}
|
|
58
|
-
/**
|
|
59
|
-
* Utility to validate code_challenge_method
|
|
60
|
-
* @param codeChallengeMethod
|
|
61
|
-
*/
|
|
62
|
-
static validateCodeChallengeMethod(codeChallengeMethod) {
|
|
63
|
-
if ([
|
|
64
|
-
CodeChallengeMethodValues.PLAIN,
|
|
65
|
-
CodeChallengeMethodValues.S256,
|
|
66
|
-
].indexOf(codeChallengeMethod) < 0) {
|
|
67
|
-
throw createClientConfigurationError(invalidCodeChallengeMethod);
|
|
68
|
-
}
|
|
69
|
-
}
|
|
7
|
+
/*
|
|
8
|
+
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
9
|
+
* Licensed under the MIT License.
|
|
10
|
+
*/
|
|
11
|
+
/**
|
|
12
|
+
* Validates server consumable params from the "request" objects
|
|
13
|
+
*/
|
|
14
|
+
class RequestValidator {
|
|
15
|
+
/**
|
|
16
|
+
* Utility to check if the `redirectUri` in the request is a non-null value
|
|
17
|
+
* @param redirectUri
|
|
18
|
+
*/
|
|
19
|
+
static validateRedirectUri(redirectUri) {
|
|
20
|
+
if (!redirectUri) {
|
|
21
|
+
throw createClientConfigurationError(redirectUriEmpty);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Utility to validate prompt sent by the user in the request
|
|
26
|
+
* @param prompt
|
|
27
|
+
*/
|
|
28
|
+
static validatePrompt(prompt) {
|
|
29
|
+
const promptValues = [];
|
|
30
|
+
for (const value in PromptValue) {
|
|
31
|
+
promptValues.push(PromptValue[value]);
|
|
32
|
+
}
|
|
33
|
+
if (promptValues.indexOf(prompt) < 0) {
|
|
34
|
+
throw createClientConfigurationError(invalidPromptValue);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
static validateClaims(claims) {
|
|
38
|
+
try {
|
|
39
|
+
JSON.parse(claims);
|
|
40
|
+
}
|
|
41
|
+
catch (e) {
|
|
42
|
+
throw createClientConfigurationError(invalidClaims);
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Utility to validate code_challenge and code_challenge_method
|
|
47
|
+
* @param codeChallenge
|
|
48
|
+
* @param codeChallengeMethod
|
|
49
|
+
*/
|
|
50
|
+
static validateCodeChallengeParams(codeChallenge, codeChallengeMethod) {
|
|
51
|
+
if (!codeChallenge || !codeChallengeMethod) {
|
|
52
|
+
throw createClientConfigurationError(pkceParamsMissing);
|
|
53
|
+
}
|
|
54
|
+
else {
|
|
55
|
+
this.validateCodeChallengeMethod(codeChallengeMethod);
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Utility to validate code_challenge_method
|
|
60
|
+
* @param codeChallengeMethod
|
|
61
|
+
*/
|
|
62
|
+
static validateCodeChallengeMethod(codeChallengeMethod) {
|
|
63
|
+
if ([
|
|
64
|
+
CodeChallengeMethodValues.PLAIN,
|
|
65
|
+
CodeChallengeMethodValues.S256,
|
|
66
|
+
].indexOf(codeChallengeMethod) < 0) {
|
|
67
|
+
throw createClientConfigurationError(invalidCodeChallengeMethod);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
70
|
}
|
|
71
71
|
|
|
72
72
|
export { RequestValidator };
|
|
@@ -1,89 +1,89 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* The ScopeSet class creates a set of scopes. Scopes are case-insensitive, unique values, so the Set object in JS makes
|
|
3
|
-
* the most sense to implement for this class. All scopes are trimmed and converted to lower case strings in intersection and union functions
|
|
4
|
-
* to ensure uniqueness of strings.
|
|
5
|
-
*/
|
|
6
|
-
export declare class ScopeSet {
|
|
7
|
-
private scopes;
|
|
8
|
-
constructor(inputScopes: Array<string>);
|
|
9
|
-
/**
|
|
10
|
-
* Factory method to create ScopeSet from space-delimited string
|
|
11
|
-
* @param inputScopeString
|
|
12
|
-
* @param appClientId
|
|
13
|
-
* @param scopesRequired
|
|
14
|
-
*/
|
|
15
|
-
static fromString(inputScopeString: string): ScopeSet;
|
|
16
|
-
/**
|
|
17
|
-
* Creates the set of scopes to search for in cache lookups
|
|
18
|
-
* @param inputScopeString
|
|
19
|
-
* @returns
|
|
20
|
-
*/
|
|
21
|
-
static createSearchScopes(inputScopeString: Array<string>): ScopeSet;
|
|
22
|
-
/**
|
|
23
|
-
* Used to validate the scopes input parameter requested by the developer.
|
|
24
|
-
* @param {Array<string>} inputScopes - Developer requested permissions. Not all scopes are guaranteed to be included in the access token returned.
|
|
25
|
-
* @param {boolean} scopesRequired - Boolean indicating whether the scopes array is required or not
|
|
26
|
-
*/
|
|
27
|
-
private validateInputScopes;
|
|
28
|
-
/**
|
|
29
|
-
* Check if a given scope is present in this set of scopes.
|
|
30
|
-
* @param scope
|
|
31
|
-
*/
|
|
32
|
-
containsScope(scope: string): boolean;
|
|
33
|
-
/**
|
|
34
|
-
* Check if a set of scopes is present in this set of scopes.
|
|
35
|
-
* @param scopeSet
|
|
36
|
-
*/
|
|
37
|
-
containsScopeSet(scopeSet: ScopeSet): boolean;
|
|
38
|
-
/**
|
|
39
|
-
* Check if set of scopes contains only the defaults
|
|
40
|
-
*/
|
|
41
|
-
containsOnlyOIDCScopes(): boolean;
|
|
42
|
-
/**
|
|
43
|
-
* Appends single scope if passed
|
|
44
|
-
* @param newScope
|
|
45
|
-
*/
|
|
46
|
-
appendScope(newScope: string): void;
|
|
47
|
-
/**
|
|
48
|
-
* Appends multiple scopes if passed
|
|
49
|
-
* @param newScopes
|
|
50
|
-
*/
|
|
51
|
-
appendScopes(newScopes: Array<string>): void;
|
|
52
|
-
/**
|
|
53
|
-
* Removes element from set of scopes.
|
|
54
|
-
* @param scope
|
|
55
|
-
*/
|
|
56
|
-
removeScope(scope: string): void;
|
|
57
|
-
/**
|
|
58
|
-
* Removes default scopes from set of scopes
|
|
59
|
-
* Primarily used to prevent cache misses if the default scopes are not returned from the server
|
|
60
|
-
*/
|
|
61
|
-
removeOIDCScopes(): void;
|
|
62
|
-
/**
|
|
63
|
-
* Combines an array of scopes with the current set of scopes.
|
|
64
|
-
* @param otherScopes
|
|
65
|
-
*/
|
|
66
|
-
unionScopeSets(otherScopes: ScopeSet): Set<string>;
|
|
67
|
-
/**
|
|
68
|
-
* Check if scopes intersect between this set and another.
|
|
69
|
-
* @param otherScopes
|
|
70
|
-
*/
|
|
71
|
-
intersectingScopeSets(otherScopes: ScopeSet): boolean;
|
|
72
|
-
/**
|
|
73
|
-
* Returns size of set of scopes.
|
|
74
|
-
*/
|
|
75
|
-
getScopeCount(): number;
|
|
76
|
-
/**
|
|
77
|
-
* Returns the scopes as an array of string values
|
|
78
|
-
*/
|
|
79
|
-
asArray(): Array<string>;
|
|
80
|
-
/**
|
|
81
|
-
* Prints scopes into a space-delimited string
|
|
82
|
-
*/
|
|
83
|
-
printScopes(): string;
|
|
84
|
-
/**
|
|
85
|
-
* Prints scopes into a space-delimited lower-case string (used for caching)
|
|
86
|
-
*/
|
|
87
|
-
printScopesLowerCase(): string;
|
|
88
|
-
}
|
|
1
|
+
/**
|
|
2
|
+
* The ScopeSet class creates a set of scopes. Scopes are case-insensitive, unique values, so the Set object in JS makes
|
|
3
|
+
* the most sense to implement for this class. All scopes are trimmed and converted to lower case strings in intersection and union functions
|
|
4
|
+
* to ensure uniqueness of strings.
|
|
5
|
+
*/
|
|
6
|
+
export declare class ScopeSet {
|
|
7
|
+
private scopes;
|
|
8
|
+
constructor(inputScopes: Array<string>);
|
|
9
|
+
/**
|
|
10
|
+
* Factory method to create ScopeSet from space-delimited string
|
|
11
|
+
* @param inputScopeString
|
|
12
|
+
* @param appClientId
|
|
13
|
+
* @param scopesRequired
|
|
14
|
+
*/
|
|
15
|
+
static fromString(inputScopeString: string): ScopeSet;
|
|
16
|
+
/**
|
|
17
|
+
* Creates the set of scopes to search for in cache lookups
|
|
18
|
+
* @param inputScopeString
|
|
19
|
+
* @returns
|
|
20
|
+
*/
|
|
21
|
+
static createSearchScopes(inputScopeString: Array<string>): ScopeSet;
|
|
22
|
+
/**
|
|
23
|
+
* Used to validate the scopes input parameter requested by the developer.
|
|
24
|
+
* @param {Array<string>} inputScopes - Developer requested permissions. Not all scopes are guaranteed to be included in the access token returned.
|
|
25
|
+
* @param {boolean} scopesRequired - Boolean indicating whether the scopes array is required or not
|
|
26
|
+
*/
|
|
27
|
+
private validateInputScopes;
|
|
28
|
+
/**
|
|
29
|
+
* Check if a given scope is present in this set of scopes.
|
|
30
|
+
* @param scope
|
|
31
|
+
*/
|
|
32
|
+
containsScope(scope: string): boolean;
|
|
33
|
+
/**
|
|
34
|
+
* Check if a set of scopes is present in this set of scopes.
|
|
35
|
+
* @param scopeSet
|
|
36
|
+
*/
|
|
37
|
+
containsScopeSet(scopeSet: ScopeSet): boolean;
|
|
38
|
+
/**
|
|
39
|
+
* Check if set of scopes contains only the defaults
|
|
40
|
+
*/
|
|
41
|
+
containsOnlyOIDCScopes(): boolean;
|
|
42
|
+
/**
|
|
43
|
+
* Appends single scope if passed
|
|
44
|
+
* @param newScope
|
|
45
|
+
*/
|
|
46
|
+
appendScope(newScope: string): void;
|
|
47
|
+
/**
|
|
48
|
+
* Appends multiple scopes if passed
|
|
49
|
+
* @param newScopes
|
|
50
|
+
*/
|
|
51
|
+
appendScopes(newScopes: Array<string>): void;
|
|
52
|
+
/**
|
|
53
|
+
* Removes element from set of scopes.
|
|
54
|
+
* @param scope
|
|
55
|
+
*/
|
|
56
|
+
removeScope(scope: string): void;
|
|
57
|
+
/**
|
|
58
|
+
* Removes default scopes from set of scopes
|
|
59
|
+
* Primarily used to prevent cache misses if the default scopes are not returned from the server
|
|
60
|
+
*/
|
|
61
|
+
removeOIDCScopes(): void;
|
|
62
|
+
/**
|
|
63
|
+
* Combines an array of scopes with the current set of scopes.
|
|
64
|
+
* @param otherScopes
|
|
65
|
+
*/
|
|
66
|
+
unionScopeSets(otherScopes: ScopeSet): Set<string>;
|
|
67
|
+
/**
|
|
68
|
+
* Check if scopes intersect between this set and another.
|
|
69
|
+
* @param otherScopes
|
|
70
|
+
*/
|
|
71
|
+
intersectingScopeSets(otherScopes: ScopeSet): boolean;
|
|
72
|
+
/**
|
|
73
|
+
* Returns size of set of scopes.
|
|
74
|
+
*/
|
|
75
|
+
getScopeCount(): number;
|
|
76
|
+
/**
|
|
77
|
+
* Returns the scopes as an array of string values
|
|
78
|
+
*/
|
|
79
|
+
asArray(): Array<string>;
|
|
80
|
+
/**
|
|
81
|
+
* Prints scopes into a space-delimited string
|
|
82
|
+
*/
|
|
83
|
+
printScopes(): string;
|
|
84
|
+
/**
|
|
85
|
+
* Prints scopes into a space-delimited lower-case string (used for caching)
|
|
86
|
+
*/
|
|
87
|
+
printScopesLowerCase(): string;
|
|
88
|
+
}
|
|
89
89
|
//# sourceMappingURL=ScopeSet.d.ts.map
|