@azure/msal-common 14.6.0-alpha.0 → 14.6.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.
Files changed (212) hide show
  1. package/dist/account/AccountInfo.d.ts +58 -58
  2. package/dist/account/AccountInfo.mjs +59 -59
  3. package/dist/account/AuthToken.d.ts +17 -17
  4. package/dist/account/AuthToken.mjs +58 -58
  5. package/dist/account/CcsCredential.d.ts +9 -9
  6. package/dist/account/CcsCredential.mjs +8 -8
  7. package/dist/account/ClientCredentials.d.ts +14 -14
  8. package/dist/account/ClientInfo.d.ts +18 -18
  9. package/dist/account/ClientInfo.mjs +37 -37
  10. package/dist/account/TokenClaims.d.ts +83 -83
  11. package/dist/account/TokenClaims.mjs +20 -20
  12. package/dist/authority/Authority.d.ts +253 -254
  13. package/dist/authority/Authority.d.ts.map +1 -1
  14. package/dist/authority/Authority.mjs +831 -816
  15. package/dist/authority/Authority.mjs.map +1 -1
  16. package/dist/authority/AuthorityFactory.d.ts +18 -31
  17. package/dist/authority/AuthorityFactory.d.ts.map +1 -1
  18. package/dist/authority/AuthorityFactory.mjs +29 -50
  19. package/dist/authority/AuthorityFactory.mjs.map +1 -1
  20. package/dist/authority/AuthorityMetadata.d.ts +43 -503
  21. package/dist/authority/AuthorityMetadata.d.ts.map +1 -1
  22. package/dist/authority/AuthorityMetadata.mjs +137 -603
  23. package/dist/authority/AuthorityMetadata.mjs.map +1 -1
  24. package/dist/authority/AuthorityOptions.d.ts +27 -27
  25. package/dist/authority/AuthorityOptions.mjs +18 -18
  26. package/dist/authority/AuthorityType.d.ts +10 -10
  27. package/dist/authority/AuthorityType.mjs +13 -13
  28. package/dist/authority/AzureRegion.d.ts +1 -1
  29. package/dist/authority/AzureRegionConfiguration.d.ts +5 -5
  30. package/dist/authority/CloudDiscoveryMetadata.d.ts +5 -5
  31. package/dist/authority/CloudInstanceDiscoveryErrorResponse.d.ts +13 -13
  32. package/dist/authority/CloudInstanceDiscoveryErrorResponse.mjs +8 -8
  33. package/dist/authority/CloudInstanceDiscoveryResponse.d.ts +9 -9
  34. package/dist/authority/CloudInstanceDiscoveryResponse.mjs +8 -8
  35. package/dist/authority/ImdsOptions.d.ts +5 -5
  36. package/dist/authority/OIDCOptions.d.ts +8 -8
  37. package/dist/authority/OpenIdConfigResponse.d.ts +11 -11
  38. package/dist/authority/OpenIdConfigResponse.mjs +10 -10
  39. package/dist/authority/ProtocolMode.d.ts +8 -8
  40. package/dist/authority/ProtocolMode.mjs +11 -11
  41. package/dist/authority/RegionDiscovery.d.ts +32 -32
  42. package/dist/authority/RegionDiscovery.mjs +106 -106
  43. package/dist/authority/RegionDiscoveryMetadata.d.ts +6 -6
  44. package/dist/broker/nativeBroker/INativeBrokerPlugin.d.ts +15 -15
  45. package/dist/cache/CacheManager.d.ts +508 -508
  46. package/dist/cache/CacheManager.mjs +1237 -1237
  47. package/dist/cache/entities/AccessTokenEntity.d.ts +25 -25
  48. package/dist/cache/entities/AccountEntity.d.ts +106 -106
  49. package/dist/cache/entities/AccountEntity.mjs +244 -244
  50. package/dist/cache/entities/AppMetadataEntity.d.ts +11 -39
  51. package/dist/cache/entities/AppMetadataEntity.d.ts.map +1 -1
  52. package/dist/cache/entities/AuthorityMetadataEntity.d.ts +15 -48
  53. package/dist/cache/entities/AuthorityMetadataEntity.d.ts.map +1 -1
  54. package/dist/cache/entities/CacheRecord.d.ts +14 -14
  55. package/dist/cache/entities/CacheRecord.mjs +14 -14
  56. package/dist/cache/entities/CredentialEntity.d.ts +30 -30
  57. package/dist/cache/entities/IdTokenEntity.d.ts +8 -8
  58. package/dist/cache/entities/RefreshTokenEntity.d.ts +7 -7
  59. package/dist/cache/entities/ServerTelemetryEntity.d.ts +5 -5
  60. package/dist/cache/entities/ThrottlingEntity.d.ts +7 -7
  61. package/dist/cache/interface/ICacheManager.d.ts +166 -166
  62. package/dist/cache/interface/ICachePlugin.d.ts +5 -5
  63. package/dist/cache/interface/ISerializableTokenCache.d.ts +4 -4
  64. package/dist/cache/persistence/TokenCacheContext.d.ts +23 -23
  65. package/dist/cache/persistence/TokenCacheContext.mjs +25 -25
  66. package/dist/cache/utils/CacheHelpers.d.ts +94 -70
  67. package/dist/cache/utils/CacheHelpers.d.ts.map +1 -1
  68. package/dist/cache/utils/CacheHelpers.mjs +326 -252
  69. package/dist/cache/utils/CacheHelpers.mjs.map +1 -1
  70. package/dist/cache/utils/CacheTypes.d.ts +69 -69
  71. package/dist/client/AuthorizationCodeClient.d.ts +74 -74
  72. package/dist/client/AuthorizationCodeClient.mjs +402 -402
  73. package/dist/client/BaseClient.d.ts +51 -51
  74. package/dist/client/BaseClient.d.ts.map +1 -1
  75. package/dist/client/BaseClient.mjs +101 -101
  76. package/dist/client/BaseClient.mjs.map +1 -1
  77. package/dist/client/RefreshTokenClient.d.ts +35 -35
  78. package/dist/client/RefreshTokenClient.mjs +204 -204
  79. package/dist/client/SilentFlowClient.d.ts +27 -27
  80. package/dist/client/SilentFlowClient.mjs +128 -128
  81. package/dist/config/AppTokenProvider.d.ts +38 -38
  82. package/dist/config/ClientConfiguration.d.ts +150 -150
  83. package/dist/config/ClientConfiguration.d.ts.map +1 -1
  84. package/dist/config/ClientConfiguration.mjs +98 -96
  85. package/dist/config/ClientConfiguration.mjs.map +1 -1
  86. package/dist/constants/AADServerParamKeys.d.ts +52 -52
  87. package/dist/constants/AADServerParamKeys.mjs +56 -56
  88. package/dist/crypto/ICrypto.d.ts +58 -58
  89. package/dist/crypto/ICrypto.mjs +30 -30
  90. package/dist/crypto/IGuidGenerator.d.ts +4 -4
  91. package/dist/crypto/JoseHeader.d.ts +22 -22
  92. package/dist/crypto/JoseHeader.mjs +37 -37
  93. package/dist/crypto/PopTokenGenerator.d.ts +60 -60
  94. package/dist/crypto/PopTokenGenerator.mjs +82 -82
  95. package/dist/crypto/SignedHttpRequest.d.ts +15 -15
  96. package/dist/error/AuthError.d.ts +44 -44
  97. package/dist/error/AuthError.mjs +46 -46
  98. package/dist/error/AuthErrorCodes.d.ts +5 -5
  99. package/dist/error/AuthErrorCodes.mjs +9 -9
  100. package/dist/error/ClientAuthError.d.ts +237 -237
  101. package/dist/error/ClientAuthError.mjs +249 -249
  102. package/dist/error/ClientAuthErrorCodes.d.ts +44 -44
  103. package/dist/error/ClientAuthErrorCodes.mjs +48 -48
  104. package/dist/error/ClientConfigurationError.d.ts +128 -128
  105. package/dist/error/ClientConfigurationError.mjs +135 -135
  106. package/dist/error/ClientConfigurationErrorCodes.d.ts +22 -22
  107. package/dist/error/ClientConfigurationErrorCodes.mjs +26 -26
  108. package/dist/error/InteractionRequiredAuthError.d.ts +61 -61
  109. package/dist/error/InteractionRequiredAuthError.mjs +84 -84
  110. package/dist/error/InteractionRequiredAuthErrorCodes.d.ts +7 -7
  111. package/dist/error/InteractionRequiredAuthErrorCodes.mjs +13 -13
  112. package/dist/error/JoseHeaderError.d.ts +15 -15
  113. package/dist/error/JoseHeaderError.mjs +22 -22
  114. package/dist/error/JoseHeaderErrorCodes.d.ts +2 -2
  115. package/dist/error/JoseHeaderErrorCodes.mjs +6 -6
  116. package/dist/error/ServerError.d.ts +7 -7
  117. package/dist/error/ServerError.mjs +14 -14
  118. package/dist/index.cjs +8081 -8611
  119. package/dist/index.cjs.map +1 -1
  120. package/dist/index.d.ts +99 -99
  121. package/dist/index.d.ts.map +1 -1
  122. package/dist/index.mjs +4 -5
  123. package/dist/index.mjs.map +1 -1
  124. package/dist/logger/Logger.d.ts +95 -95
  125. package/dist/logger/Logger.mjs +188 -188
  126. package/dist/network/INetworkModule.d.ts +29 -29
  127. package/dist/network/INetworkModule.mjs +12 -12
  128. package/dist/network/NetworkManager.d.ts +33 -33
  129. package/dist/network/NetworkManager.mjs +34 -34
  130. package/dist/network/RequestThumbprint.d.ts +18 -18
  131. package/dist/network/ThrottlingUtils.d.ts +42 -42
  132. package/dist/network/ThrottlingUtils.mjs +95 -95
  133. package/dist/packageMetadata.d.ts +2 -2
  134. package/dist/packageMetadata.d.ts.map +1 -1
  135. package/dist/packageMetadata.mjs +4 -4
  136. package/dist/request/AuthenticationHeaderParser.d.ts +19 -19
  137. package/dist/request/AuthenticationHeaderParser.mjs +55 -55
  138. package/dist/request/BaseAuthRequest.d.ts +43 -43
  139. package/dist/request/CommonAuthorizationCodeRequest.d.ts +27 -27
  140. package/dist/request/CommonAuthorizationUrlRequest.d.ts +50 -50
  141. package/dist/request/CommonClientCredentialRequest.d.ts +17 -17
  142. package/dist/request/CommonDeviceCodeRequest.d.ts +21 -21
  143. package/dist/request/CommonEndSessionRequest.d.ts +21 -21
  144. package/dist/request/CommonOnBehalfOfRequest.d.ts +13 -13
  145. package/dist/request/CommonRefreshTokenRequest.d.ts +22 -22
  146. package/dist/request/CommonSilentFlowRequest.d.ts +27 -27
  147. package/dist/request/CommonUsernamePasswordRequest.d.ts +17 -17
  148. package/dist/request/NativeRequest.d.ts +19 -19
  149. package/dist/request/NativeSignOutRequest.d.ts +5 -5
  150. package/dist/request/RequestParameterBuilder.d.ts +217 -217
  151. package/dist/request/RequestParameterBuilder.mjs +381 -381
  152. package/dist/request/RequestValidator.d.ts +33 -33
  153. package/dist/request/RequestValidator.mjs +81 -81
  154. package/dist/request/ScopeSet.d.ts +88 -88
  155. package/dist/request/ScopeSet.mjs +197 -197
  156. package/dist/request/StoreInCache.d.ts +8 -8
  157. package/dist/response/AuthenticationResult.d.ts +41 -41
  158. package/dist/response/AuthorizationCodePayload.d.ts +13 -13
  159. package/dist/response/DeviceCodeResponse.d.ts +25 -25
  160. package/dist/response/ExternalTokenResponse.d.ts +15 -15
  161. package/dist/response/IMDSBadResponse.d.ts +4 -4
  162. package/dist/response/ResponseHandler.d.ts +69 -69
  163. package/dist/response/ResponseHandler.mjs +350 -347
  164. package/dist/response/ResponseHandler.mjs.map +1 -1
  165. package/dist/response/ServerAuthorizationCodeResponse.d.ts +25 -25
  166. package/dist/response/ServerAuthorizationTokenResponse.d.ts +47 -47
  167. package/dist/telemetry/performance/IPerformanceClient.d.ts +57 -57
  168. package/dist/telemetry/performance/IPerformanceMeasurement.d.ts +5 -5
  169. package/dist/telemetry/performance/PerformanceClient.d.ts +198 -198
  170. package/dist/telemetry/performance/PerformanceClient.mjs +412 -412
  171. package/dist/telemetry/performance/PerformanceEvent.d.ts +464 -464
  172. package/dist/telemetry/performance/PerformanceEvent.mjs +253 -253
  173. package/dist/telemetry/performance/StubPerformanceClient.d.ts +24 -24
  174. package/dist/telemetry/performance/StubPerformanceClient.mjs +76 -76
  175. package/dist/telemetry/server/ServerTelemetryManager.d.ts +66 -66
  176. package/dist/telemetry/server/ServerTelemetryManager.mjs +201 -201
  177. package/dist/telemetry/server/ServerTelemetryRequest.d.ts +8 -8
  178. package/dist/url/IUri.d.ts +12 -12
  179. package/dist/url/UrlString.d.ts +48 -48
  180. package/dist/url/UrlString.mjs +161 -161
  181. package/dist/utils/Constants.d.ts +296 -298
  182. package/dist/utils/Constants.d.ts.map +1 -1
  183. package/dist/utils/Constants.mjs +310 -313
  184. package/dist/utils/Constants.mjs.map +1 -1
  185. package/dist/utils/FunctionWrappers.d.ts +27 -27
  186. package/dist/utils/FunctionWrappers.mjs +84 -84
  187. package/dist/utils/MsalTypes.d.ts +6 -6
  188. package/dist/utils/ProtocolUtils.d.ts +42 -42
  189. package/dist/utils/ProtocolUtils.mjs +69 -69
  190. package/dist/utils/StringUtils.d.ts +40 -40
  191. package/dist/utils/StringUtils.mjs +95 -95
  192. package/dist/utils/TimeUtils.d.ts +27 -27
  193. package/dist/utils/TimeUtils.mjs +45 -45
  194. package/dist/utils/UrlUtils.d.ts +10 -10
  195. package/dist/utils/UrlUtils.mjs +44 -44
  196. package/package.json +1 -1
  197. package/src/authority/Authority.ts +69 -29
  198. package/src/authority/AuthorityFactory.ts +48 -92
  199. package/src/authority/AuthorityMetadata.ts +23 -526
  200. package/src/cache/entities/AppMetadataEntity.ts +6 -81
  201. package/src/cache/entities/AuthorityMetadataEntity.ts +2 -94
  202. package/src/cache/utils/CacheHelpers.ts +111 -0
  203. package/src/client/BaseClient.ts +10 -11
  204. package/src/config/ClientConfiguration.ts +4 -4
  205. package/src/index.ts +1 -2
  206. package/src/packageMetadata.ts +1 -1
  207. package/src/response/ResponseHandler.ts +5 -5
  208. package/src/utils/Constants.ts +0 -4
  209. package/dist/cache/entities/AppMetadataEntity.mjs +0 -73
  210. package/dist/cache/entities/AppMetadataEntity.mjs.map +0 -1
  211. package/dist/cache/entities/AuthorityMetadataEntity.mjs +0 -86
  212. package/dist/cache/entities/AuthorityMetadataEntity.mjs.map +0 -1
@@ -1,34 +1,34 @@
1
- import { StringDict } from "../utils/MsalTypes";
2
- /**
3
- * Validates server consumable params from the "request" objects
4
- */
5
- export declare class RequestValidator {
6
- /**
7
- * Utility to check if the `redirectUri` in the request is a non-null value
8
- * @param redirectUri
9
- */
10
- static validateRedirectUri(redirectUri: string): void;
11
- /**
12
- * Utility to validate prompt sent by the user in the request
13
- * @param prompt
14
- */
15
- static validatePrompt(prompt: string): void;
16
- static validateClaims(claims: string): void;
17
- /**
18
- * Utility to validate code_challenge and code_challenge_method
19
- * @param codeChallenge
20
- * @param codeChallengeMethod
21
- */
22
- static validateCodeChallengeParams(codeChallenge: string, codeChallengeMethod: string): void;
23
- /**
24
- * Utility to validate code_challenge_method
25
- * @param codeChallengeMethod
26
- */
27
- static validateCodeChallengeMethod(codeChallengeMethod: string): void;
28
- /**
29
- * Removes unnecessary, duplicate, and empty string query parameters from extraQueryParameters
30
- * @param request
31
- */
32
- static sanitizeEQParams(eQParams: StringDict, queryParams: Map<string, string>): StringDict;
33
- }
1
+ import { StringDict } from "../utils/MsalTypes";
2
+ /**
3
+ * Validates server consumable params from the "request" objects
4
+ */
5
+ export declare class RequestValidator {
6
+ /**
7
+ * Utility to check if the `redirectUri` in the request is a non-null value
8
+ * @param redirectUri
9
+ */
10
+ static validateRedirectUri(redirectUri: string): void;
11
+ /**
12
+ * Utility to validate prompt sent by the user in the request
13
+ * @param prompt
14
+ */
15
+ static validatePrompt(prompt: string): void;
16
+ static validateClaims(claims: string): void;
17
+ /**
18
+ * Utility to validate code_challenge and code_challenge_method
19
+ * @param codeChallenge
20
+ * @param codeChallengeMethod
21
+ */
22
+ static validateCodeChallengeParams(codeChallenge: string, codeChallengeMethod: string): void;
23
+ /**
24
+ * Utility to validate code_challenge_method
25
+ * @param codeChallengeMethod
26
+ */
27
+ static validateCodeChallengeMethod(codeChallengeMethod: string): void;
28
+ /**
29
+ * Removes unnecessary, duplicate, and empty string query parameters from extraQueryParameters
30
+ * @param request
31
+ */
32
+ static sanitizeEQParams(eQParams: StringDict, queryParams: Map<string, string>): StringDict;
33
+ }
34
34
  //# sourceMappingURL=RequestValidator.d.ts.map
@@ -1,89 +1,89 @@
1
- /*! @azure/msal-common v14.6.0-alpha.0 2023-12-15 */
1
+ /*! @azure/msal-common v14.6.1 2024-01-23 */
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
- }
70
- /**
71
- * Removes unnecessary, duplicate, and empty string query parameters from extraQueryParameters
72
- * @param request
73
- */
74
- static sanitizeEQParams(eQParams, queryParams) {
75
- if (!eQParams) {
76
- return {};
77
- }
78
- // Remove any query parameters already included in SSO params
79
- queryParams.forEach((_value, key) => {
80
- if (eQParams[key]) {
81
- delete eQParams[key];
82
- }
83
- });
84
- // remove empty string parameters
85
- return Object.fromEntries(Object.entries(eQParams).filter((kv) => kv[1] !== ""));
86
- }
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
+ /**
71
+ * Removes unnecessary, duplicate, and empty string query parameters from extraQueryParameters
72
+ * @param request
73
+ */
74
+ static sanitizeEQParams(eQParams, queryParams) {
75
+ if (!eQParams) {
76
+ return {};
77
+ }
78
+ // Remove any query parameters already included in SSO params
79
+ queryParams.forEach((_value, key) => {
80
+ if (eQParams[key]) {
81
+ delete eQParams[key];
82
+ }
83
+ });
84
+ // remove empty string parameters
85
+ return Object.fromEntries(Object.entries(eQParams).filter((kv) => kv[1] !== ""));
86
+ }
87
87
  }
88
88
 
89
89
  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