@azure/msal-browser 3.5.0 → 3.5.1-beta.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 (195) hide show
  1. package/dist/app/IPublicClientApplication.d.ts +51 -51
  2. package/dist/app/IPublicClientApplication.mjs +102 -102
  3. package/dist/app/PublicClientApplication.d.ts +268 -268
  4. package/dist/app/PublicClientApplication.mjs +333 -333
  5. package/dist/app/PublicClientNext.d.ts +273 -273
  6. package/dist/app/PublicClientNext.mjs +351 -351
  7. package/dist/broker/nativeBroker/NativeMessageHandler.d.ts +62 -62
  8. package/dist/broker/nativeBroker/NativeMessageHandler.mjs +254 -254
  9. package/dist/broker/nativeBroker/NativeRequest.d.ts +44 -44
  10. package/dist/broker/nativeBroker/NativeResponse.d.ts +48 -48
  11. package/dist/broker/nativeBroker/NativeStatusCodes.d.ts +7 -7
  12. package/dist/broker/nativeBroker/NativeStatusCodes.mjs +11 -11
  13. package/dist/cache/AsyncMemoryStorage.d.ts +51 -51
  14. package/dist/cache/AsyncMemoryStorage.mjs +132 -132
  15. package/dist/cache/BrowserCacheManager.d.ts +383 -383
  16. package/dist/cache/BrowserCacheManager.mjs +1262 -1262
  17. package/dist/cache/BrowserStorage.d.ts +11 -11
  18. package/dist/cache/BrowserStorage.mjs +32 -32
  19. package/dist/cache/CryptoKeyStore.d.ts +18 -18
  20. package/dist/cache/CryptoKeyStore.mjs +40 -40
  21. package/dist/cache/DatabaseStorage.d.ts +56 -56
  22. package/dist/cache/DatabaseStorage.mjs +190 -190
  23. package/dist/cache/IAsyncMemoryStorage.d.ts +27 -27
  24. package/dist/cache/ITokenCache.d.ts +11 -11
  25. package/dist/cache/IWindowStorage.d.ts +27 -27
  26. package/dist/cache/MemoryStorage.d.ts +11 -11
  27. package/dist/cache/MemoryStorage.mjs +31 -31
  28. package/dist/cache/TokenCache.d.ts +77 -77
  29. package/dist/cache/TokenCache.mjs +224 -224
  30. package/dist/config/Configuration.d.ts +206 -206
  31. package/dist/config/Configuration.mjs +128 -128
  32. package/dist/controllers/ControllerFactory.d.ts +4 -4
  33. package/dist/controllers/ControllerFactory.mjs +29 -29
  34. package/dist/controllers/IController.d.ts +61 -61
  35. package/dist/controllers/NestedAppAuthController.d.ts +95 -95
  36. package/dist/controllers/NestedAppAuthController.d.ts.map +1 -1
  37. package/dist/controllers/NestedAppAuthController.mjs +335 -333
  38. package/dist/controllers/NestedAppAuthController.mjs.map +1 -1
  39. package/dist/controllers/StandardController.d.ts +407 -407
  40. package/dist/controllers/StandardController.d.ts.map +1 -1
  41. package/dist/controllers/StandardController.mjs +1293 -1291
  42. package/dist/controllers/StandardController.mjs.map +1 -1
  43. package/dist/controllers/UnknownOperatingContextController.d.ts +87 -87
  44. package/dist/controllers/UnknownOperatingContextController.mjs +264 -264
  45. package/dist/crypto/BrowserCrypto.d.ts +44 -44
  46. package/dist/crypto/BrowserCrypto.mjs +93 -93
  47. package/dist/crypto/CryptoOps.d.ts +63 -63
  48. package/dist/crypto/CryptoOps.mjs +145 -145
  49. package/dist/crypto/PkceGenerator.d.ts +8 -8
  50. package/dist/crypto/PkceGenerator.mjs +54 -54
  51. package/dist/crypto/SignedHttpRequest.d.ts +30 -30
  52. package/dist/crypto/SignedHttpRequest.mjs +39 -39
  53. package/dist/encode/Base64Decode.d.ts +9 -9
  54. package/dist/encode/Base64Decode.mjs +36 -36
  55. package/dist/encode/Base64Encode.d.ts +19 -19
  56. package/dist/encode/Base64Encode.mjs +43 -43
  57. package/dist/error/BrowserAuthError.d.ts +250 -250
  58. package/dist/error/BrowserAuthError.mjs +258 -258
  59. package/dist/error/BrowserAuthErrorCodes.d.ts +45 -45
  60. package/dist/error/BrowserAuthErrorCodes.mjs +49 -49
  61. package/dist/error/BrowserConfigurationAuthError.d.ts +33 -33
  62. package/dist/error/BrowserConfigurationAuthError.mjs +40 -40
  63. package/dist/error/BrowserConfigurationAuthErrorCodes.d.ts +3 -3
  64. package/dist/error/BrowserConfigurationAuthErrorCodes.mjs +7 -7
  65. package/dist/error/NativeAuthError.d.ts +29 -29
  66. package/dist/error/NativeAuthError.mjs +60 -60
  67. package/dist/error/NativeAuthErrorCodes.d.ts +2 -2
  68. package/dist/error/NativeAuthErrorCodes.mjs +6 -6
  69. package/dist/error/NestedAppAuthError.d.ts +14 -14
  70. package/dist/error/NestedAppAuthError.mjs +23 -23
  71. package/dist/event/EventHandler.d.ts +41 -41
  72. package/dist/event/EventHandler.mjs +119 -119
  73. package/dist/event/EventMessage.d.ts +25 -25
  74. package/dist/event/EventMessage.mjs +68 -68
  75. package/dist/event/EventType.d.ts +28 -28
  76. package/dist/event/EventType.mjs +31 -31
  77. package/dist/index.d.ts +39 -39
  78. package/dist/index.mjs +1 -1
  79. package/dist/interaction_client/BaseInteractionClient.d.ts +54 -54
  80. package/dist/interaction_client/BaseInteractionClient.mjs +152 -152
  81. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.d.ts +4 -4
  82. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.mjs +10 -10
  83. package/dist/interaction_client/NativeInteractionClient.d.ts +140 -140
  84. package/dist/interaction_client/NativeInteractionClient.mjs +548 -548
  85. package/dist/interaction_client/PopupClient.d.ts +105 -105
  86. package/dist/interaction_client/PopupClient.mjs +432 -432
  87. package/dist/interaction_client/RedirectClient.d.ts +49 -49
  88. package/dist/interaction_client/RedirectClient.mjs +311 -311
  89. package/dist/interaction_client/SilentAuthCodeClient.d.ts +23 -23
  90. package/dist/interaction_client/SilentAuthCodeClient.mjs +57 -57
  91. package/dist/interaction_client/SilentCacheClient.d.ts +24 -24
  92. package/dist/interaction_client/SilentCacheClient.mjs +61 -61
  93. package/dist/interaction_client/SilentIframeClient.d.ts +32 -32
  94. package/dist/interaction_client/SilentIframeClient.mjs +96 -96
  95. package/dist/interaction_client/SilentRefreshClient.d.ts +20 -20
  96. package/dist/interaction_client/SilentRefreshClient.mjs +43 -43
  97. package/dist/interaction_client/StandardInteractionClient.d.ts +54 -54
  98. package/dist/interaction_client/StandardInteractionClient.mjs +222 -222
  99. package/dist/interaction_handler/InteractionHandler.d.ts +33 -33
  100. package/dist/interaction_handler/InteractionHandler.mjs +93 -93
  101. package/dist/interaction_handler/RedirectHandler.d.ts +32 -32
  102. package/dist/interaction_handler/RedirectHandler.mjs +134 -134
  103. package/dist/interaction_handler/SilentHandler.d.ts +13 -13
  104. package/dist/interaction_handler/SilentHandler.mjs +133 -133
  105. package/dist/naa/AccountInfo.d.ts +11 -12
  106. package/dist/naa/AccountInfo.d.ts.map +1 -1
  107. package/dist/naa/AccountRequests.d.ts +9 -9
  108. package/dist/naa/AuthBridge.d.ts +5 -5
  109. package/dist/naa/BridgeCapabilities.d.ts +3 -3
  110. package/dist/naa/BridgeError.d.ts +9 -9
  111. package/dist/naa/BridgeError.d.ts.map +1 -1
  112. package/dist/naa/BridgeError.mjs +7 -7
  113. package/dist/naa/BridgeError.mjs.map +1 -1
  114. package/dist/naa/BridgeProxy.d.ts +72 -71
  115. package/dist/naa/BridgeProxy.d.ts.map +1 -1
  116. package/dist/naa/BridgeProxy.mjs +152 -149
  117. package/dist/naa/BridgeProxy.mjs.map +1 -1
  118. package/dist/naa/BridgeRequest.d.ts +6 -6
  119. package/dist/naa/BridgeRequestEnvelope.d.ts +13 -13
  120. package/dist/naa/BridgeResponseEnvelope.d.ts +10 -10
  121. package/dist/naa/BridgeStatusCode.d.ts +10 -10
  122. package/dist/naa/BridgeStatusCode.mjs +15 -15
  123. package/dist/naa/IBridgeProxy.d.ts +12 -10
  124. package/dist/naa/IBridgeProxy.d.ts.map +1 -1
  125. package/dist/naa/InitializeBridgeResponse.d.ts +6 -6
  126. package/dist/naa/InitializeBridgeResponse.d.ts.map +1 -1
  127. package/dist/naa/TokenRequest.d.ts +19 -21
  128. package/dist/naa/TokenRequest.d.ts.map +1 -1
  129. package/dist/naa/TokenResponse.d.ts +15 -16
  130. package/dist/naa/TokenResponse.d.ts.map +1 -1
  131. package/dist/naa/mapping/NestedAppAuthAdapter.d.ts +23 -25
  132. package/dist/naa/mapping/NestedAppAuthAdapter.d.ts.map +1 -1
  133. package/dist/naa/mapping/NestedAppAuthAdapter.mjs +142 -170
  134. package/dist/naa/mapping/NestedAppAuthAdapter.mjs.map +1 -1
  135. package/dist/navigation/INavigationClient.d.ts +16 -16
  136. package/dist/navigation/NavigationClient.d.ts +22 -22
  137. package/dist/navigation/NavigationClient.mjs +40 -40
  138. package/dist/navigation/NavigationOptions.d.ts +12 -12
  139. package/dist/network/FetchClient.d.ts +26 -26
  140. package/dist/network/FetchClient.mjs +99 -99
  141. package/dist/operatingcontext/BaseOperatingContext.d.ts +40 -40
  142. package/dist/operatingcontext/BaseOperatingContext.mjs +44 -44
  143. package/dist/operatingcontext/StandardOperatingContext.d.ts +25 -25
  144. package/dist/operatingcontext/StandardOperatingContext.mjs +43 -43
  145. package/dist/operatingcontext/TeamsAppOperatingContext.d.ts +32 -32
  146. package/dist/operatingcontext/TeamsAppOperatingContext.d.ts.map +1 -1
  147. package/dist/operatingcontext/TeamsAppOperatingContext.mjs +85 -82
  148. package/dist/operatingcontext/TeamsAppOperatingContext.mjs.map +1 -1
  149. package/dist/operatingcontext/UnknownOperatingContext.d.ts +25 -25
  150. package/dist/operatingcontext/UnknownOperatingContext.mjs +42 -42
  151. package/dist/packageMetadata.d.ts +2 -2
  152. package/dist/packageMetadata.d.ts.map +1 -1
  153. package/dist/packageMetadata.mjs +4 -4
  154. package/dist/packageMetadata.mjs.map +1 -1
  155. package/dist/request/AuthorizationCodeRequest.d.ts +8 -8
  156. package/dist/request/AuthorizationUrlRequest.d.ts +8 -8
  157. package/dist/request/ClearCacheRequest.d.ts +10 -10
  158. package/dist/request/EndSessionPopupRequest.d.ts +18 -18
  159. package/dist/request/EndSessionRequest.d.ts +15 -15
  160. package/dist/request/PopupRequest.d.ts +34 -34
  161. package/dist/request/PopupWindowAttributes.d.ts +15 -15
  162. package/dist/request/RedirectRequest.d.ts +35 -35
  163. package/dist/request/SilentRequest.d.ts +32 -32
  164. package/dist/request/SsoSilentRequest.d.ts +29 -29
  165. package/dist/response/AuthenticationResult.d.ts +4 -4
  166. package/dist/response/ResponseHandler.d.ts +7 -7
  167. package/dist/response/ResponseHandler.mjs +36 -36
  168. package/dist/telemetry/BrowserPerformanceClient.d.ts +36 -36
  169. package/dist/telemetry/BrowserPerformanceClient.mjs +125 -125
  170. package/dist/telemetry/BrowserPerformanceMeasurement.d.ts +21 -21
  171. package/dist/telemetry/BrowserPerformanceMeasurement.mjs +92 -92
  172. package/dist/utils/BrowserConstants.d.ts +176 -176
  173. package/dist/utils/BrowserConstants.mjs +204 -204
  174. package/dist/utils/BrowserProtocolUtils.d.ts +11 -11
  175. package/dist/utils/BrowserProtocolUtils.mjs +21 -21
  176. package/dist/utils/BrowserUtils.d.ts +56 -56
  177. package/dist/utils/BrowserUtils.mjs +125 -125
  178. package/lib/msal-browser.cjs +17922 -17928
  179. package/lib/msal-browser.cjs.map +1 -1
  180. package/lib/msal-browser.js +17922 -17928
  181. package/lib/msal-browser.js.map +1 -1
  182. package/lib/msal-browser.min.js +59 -59
  183. package/package.json +102 -102
  184. package/src/controllers/NestedAppAuthController.ts +8 -3
  185. package/src/controllers/StandardController.ts +3 -1
  186. package/src/naa/AccountInfo.ts +3 -4
  187. package/src/naa/BridgeError.ts +4 -4
  188. package/src/naa/BridgeProxy.ts +6 -2
  189. package/src/naa/IBridgeProxy.ts +2 -0
  190. package/src/naa/InitializeBridgeResponse.ts +1 -1
  191. package/src/naa/TokenRequest.ts +0 -2
  192. package/src/naa/TokenResponse.ts +1 -2
  193. package/src/naa/mapping/NestedAppAuthAdapter.ts +72 -80
  194. package/src/operatingcontext/TeamsAppOperatingContext.ts +4 -1
  195. package/src/packageMetadata.ts +1 -1
@@ -1,341 +1,341 @@
1
- /*! @azure/msal-browser v3.5.0 2023-11-07 */
1
+ /*! @azure/msal-browser v3.5.1-beta.1 2023-11-14 */
2
2
  'use strict';
3
3
  import { createV3Controller } from '../controllers/ControllerFactory.mjs';
4
4
  import { StandardController } from '../controllers/StandardController.mjs';
5
5
  import { StandardOperatingContext } from '../operatingcontext/StandardOperatingContext.mjs';
6
6
 
7
- /*
8
- * Copyright (c) Microsoft Corporation. All rights reserved.
9
- * Licensed under the MIT License.
10
- */
11
- /**
12
- * The PublicClientApplication class is the object exposed by the library to perform authentication and authorization functions in Single Page Applications
13
- * to obtain JWT tokens as described in the OAuth 2.0 Authorization Code Flow with PKCE specification.
14
- */
15
- class PublicClientApplication {
16
- static async createPublicClientApplication(configuration) {
17
- const controller = await createV3Controller(configuration);
18
- const pca = new PublicClientApplication(configuration, controller);
19
- return pca;
20
- }
21
- /**
22
- * @constructor
23
- * Constructor for the PublicClientApplication used to instantiate the PublicClientApplication object
24
- *
25
- * Important attributes in the Configuration object for auth are:
26
- * - clientID: the application ID of your application. You can obtain one by registering your application with our Application registration portal : https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview
27
- * - authority: the authority URL for your application.
28
- * - redirect_uri: the uri of your application registered in the portal.
29
- *
30
- * In Azure AD, authority is a URL indicating the Azure active directory that MSAL uses to obtain tokens.
31
- * It is of the form https://login.microsoftonline.com/{Enter_the_Tenant_Info_Here}
32
- * If your application supports Accounts in one organizational directory, replace "Enter_the_Tenant_Info_Here" value with the Tenant Id or Tenant name (for example, contoso.microsoft.com).
33
- * If your application supports Accounts in any organizational directory, replace "Enter_the_Tenant_Info_Here" value with organizations.
34
- * If your application supports Accounts in any organizational directory and personal Microsoft accounts, replace "Enter_the_Tenant_Info_Here" value with common.
35
- * To restrict support to Personal Microsoft accounts only, replace "Enter_the_Tenant_Info_Here" value with consumers.
36
- *
37
- * In Azure B2C, authority is of the form https://{instance}/tfp/{tenant}/{policyName}/
38
- * Full B2C functionality will be available in this library in future versions.
39
- *
40
- * @param configuration Object for the MSAL PublicClientApplication instance
41
- * @param IController Optional parameter to explictly set the controller. (Will be removed when we remove public constructor)
42
- */
43
- constructor(configuration, controller) {
44
- if (controller) {
45
- this.controller = controller;
46
- }
47
- else {
48
- const standardOperatingContext = new StandardOperatingContext(configuration);
49
- this.controller = new StandardController(standardOperatingContext);
50
- }
51
- }
52
- /**
53
- * Initializer function to perform async startup tasks such as connecting to WAM extension
54
- */
55
- async initialize() {
56
- return this.controller.initialize();
57
- }
58
- /**
59
- * Use when you want to obtain an access_token for your API via opening a popup window in the user's browser
60
- *
61
- * @param request
62
- *
63
- * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
64
- */
65
- async acquireTokenPopup(request) {
66
- return this.controller.acquireTokenPopup(request);
67
- }
68
- /**
69
- * Use when you want to obtain an access_token for your API by redirecting the user's browser window to the authorization endpoint. This function redirects
70
- * the page, so any code that follows this function will not execute.
71
- *
72
- * IMPORTANT: It is NOT recommended to have code that is dependent on the resolution of the Promise. This function will navigate away from the current
73
- * browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.
74
- *
75
- * @param request
76
- */
77
- acquireTokenRedirect(request) {
78
- return this.controller.acquireTokenRedirect(request);
79
- }
80
- /**
81
- * Silently acquire an access token for a given set of scopes. Returns currently processing promise if parallel requests are made.
82
- *
83
- * @param {@link (SilentRequest:type)}
84
- * @returns {Promise.<AuthenticationResult>} - a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the {@link AuthenticationResult} object
85
- */
86
- acquireTokenSilent(silentRequest) {
87
- return this.controller.acquireTokenSilent(silentRequest);
88
- }
89
- /**
90
- * This function redeems an authorization code (passed as code) from the eSTS token endpoint.
91
- * This authorization code should be acquired server-side using a confidential client to acquire a spa_code.
92
- * This API is not indended for normal authorization code acquisition and redemption.
93
- *
94
- * Redemption of this authorization code will not require PKCE, as it was acquired by a confidential client.
95
- *
96
- * @param request {@link AuthorizationCodeRequest}
97
- * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
98
- */
99
- acquireTokenByCode(request) {
100
- return this.controller.acquireTokenByCode(request);
101
- }
102
- /**
103
- * Adds event callbacks to array
104
- * @param callback
105
- */
106
- addEventCallback(callback) {
107
- return this.controller.addEventCallback(callback);
108
- }
109
- /**
110
- * Removes callback with provided id from callback array
111
- * @param callbackId
112
- */
113
- removeEventCallback(callbackId) {
114
- return this.controller.removeEventCallback(callbackId);
115
- }
116
- /**
117
- * Registers a callback to receive performance events.
118
- *
119
- * @param {PerformanceCallbackFunction} callback
120
- * @returns {string}
121
- */
122
- addPerformanceCallback(callback) {
123
- return this.controller.addPerformanceCallback(callback);
124
- }
125
- /**
126
- * Removes a callback registered with addPerformanceCallback.
127
- *
128
- * @param {string} callbackId
129
- * @returns {boolean}
130
- */
131
- removePerformanceCallback(callbackId) {
132
- return this.controller.removePerformanceCallback(callbackId);
133
- }
134
- /**
135
- * Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
136
- */
137
- enableAccountStorageEvents() {
138
- this.controller.enableAccountStorageEvents();
139
- }
140
- /**
141
- * Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
142
- */
143
- disableAccountStorageEvents() {
144
- this.controller.disableAccountStorageEvents();
145
- }
146
- /**
147
- * Returns the first account found in the cache that matches the account filter passed in.
148
- * @param accountFilter
149
- * @returns The first account found in the cache matching the provided filter or null if no account could be found.
150
- */
151
- getAccount(accountFilter) {
152
- return this.controller.getAccount(accountFilter);
153
- }
154
- /**
155
- * Returns the signed in account matching homeAccountId.
156
- * (the account object is created at the time of successful login)
157
- * or null when no matching account is found
158
- * @param homeAccountId
159
- * @returns The account object stored in MSAL
160
- * @deprecated - Use getAccount instead
161
- */
162
- getAccountByHomeId(homeAccountId) {
163
- return this.controller.getAccountByHomeId(homeAccountId);
164
- }
165
- /**
166
- * Returns the signed in account matching localAccountId.
167
- * (the account object is created at the time of successful login)
168
- * or null when no matching account is found
169
- * @param localAccountId
170
- * @returns The account object stored in MSAL
171
- * @deprecated - Use getAccount instead
172
- */
173
- getAccountByLocalId(localId) {
174
- return this.controller.getAccountByLocalId(localId);
175
- }
176
- /**
177
- * Returns the signed in account matching username.
178
- * (the account object is created at the time of successful login)
179
- * or null when no matching account is found.
180
- * This API is provided for convenience but getAccountById should be used for best reliability
181
- * @param userName
182
- * @returns The account object stored in MSAL
183
- * @deprecated - Use getAccount instead
184
- */
185
- getAccountByUsername(userName) {
186
- return this.controller.getAccountByUsername(userName);
187
- }
188
- /**
189
- * Returns all the accounts in the cache that match the optional filter. If no filter is provided, all accounts are returned.
190
- * @param accountFilter - (Optional) filter to narrow down the accounts returned
191
- * @returns Array of AccountInfo objects in cache
192
- */
193
- getAllAccounts(accountFilter) {
194
- return this.controller.getAllAccounts(accountFilter);
195
- }
196
- /**
197
- * Event handler function which allows users to fire events after the PublicClientApplication object
198
- * has loaded during redirect flows. This should be invoked on all page loads involved in redirect
199
- * auth flows.
200
- * @param hash Hash to process. Defaults to the current value of window.location.hash. Only needs to be provided explicitly if the response to be handled is not contained in the current value.
201
- * @returns Token response or null. If the return value is null, then no auth redirect was detected.
202
- */
203
- handleRedirectPromise(hash) {
204
- return this.controller.handleRedirectPromise(hash);
205
- }
206
- /**
207
- * Use when initiating the login process via opening a popup window in the user's browser
208
- *
209
- * @param request
210
- *
211
- * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
212
- */
213
- loginPopup(request) {
214
- return this.controller.loginPopup(request);
215
- }
216
- /**
217
- * Use when initiating the login process by redirecting the user's browser to the authorization endpoint. This function redirects the page, so
218
- * any code that follows this function will not execute.
219
- *
220
- * IMPORTANT: It is NOT recommended to have code that is dependent on the resolution of the Promise. This function will navigate away from the current
221
- * browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.
222
- *
223
- * @param request
224
- */
225
- loginRedirect(request) {
226
- return this.controller.loginRedirect(request);
227
- }
228
- /**
229
- * Deprecated logout function. Use logoutRedirect or logoutPopup instead
230
- * @param logoutRequest
231
- * @deprecated
232
- */
233
- logout(logoutRequest) {
234
- return this.controller.logout(logoutRequest);
235
- }
236
- /**
237
- * Use to log out the current user, and redirect the user to the postLogoutRedirectUri.
238
- * Default behaviour is to redirect the user to `window.location.href`.
239
- * @param logoutRequest
240
- */
241
- logoutRedirect(logoutRequest) {
242
- return this.controller.logoutRedirect(logoutRequest);
243
- }
244
- /**
245
- * Clears local cache for the current user then opens a popup window prompting the user to sign-out of the server
246
- * @param logoutRequest
247
- */
248
- logoutPopup(logoutRequest) {
249
- return this.controller.logoutPopup(logoutRequest);
250
- }
251
- /**
252
- * This function uses a hidden iframe to fetch an authorization code from the eSTS. There are cases where this may not work:
253
- * - Any browser using a form of Intelligent Tracking Prevention
254
- * - If there is not an established session with the service
255
- *
256
- * In these cases, the request must be done inside a popup or full frame redirect.
257
- *
258
- * For the cases where interaction is required, you cannot send a request with prompt=none.
259
- *
260
- * If your refresh token has expired, you can use this function to fetch a new set of tokens silently as long as
261
- * you session on the server still exists.
262
- * @param request {@link SsoSilentRequest}
263
- *
264
- * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
265
- */
266
- ssoSilent(request) {
267
- return this.controller.ssoSilent(request);
268
- }
269
- /**
270
- * Gets the token cache for the application.
271
- */
272
- getTokenCache() {
273
- return this.controller.getTokenCache();
274
- }
275
- /**
276
- * Returns the logger instance
277
- */
278
- getLogger() {
279
- return this.controller.getLogger();
280
- }
281
- /**
282
- * Replaces the default logger set in configurations with new Logger with new configurations
283
- * @param logger Logger instance
284
- */
285
- setLogger(logger) {
286
- this.controller.setLogger(logger);
287
- }
288
- /**
289
- * Sets the account to use as the active account. If no account is passed to the acquireToken APIs, then MSAL will use this active account.
290
- * @param account
291
- */
292
- setActiveAccount(account) {
293
- this.controller.setActiveAccount(account);
294
- }
295
- /**
296
- * Gets the currently active account
297
- */
298
- getActiveAccount() {
299
- return this.controller.getActiveAccount();
300
- }
301
- /**
302
- * Called by wrapper libraries (Angular & React) to set SKU and Version passed down to telemetry, logger, etc.
303
- * @param sku
304
- * @param version
305
- */
306
- initializeWrapperLibrary(sku, version) {
307
- return this.controller.initializeWrapperLibrary(sku, version);
308
- }
309
- /**
310
- * Sets navigation client
311
- * @param navigationClient
312
- */
313
- setNavigationClient(navigationClient) {
314
- this.controller.setNavigationClient(navigationClient);
315
- }
316
- /**
317
- * Returns the configuration object
318
- * @internal
319
- */
320
- getConfiguration() {
321
- return this.controller.getConfiguration();
322
- }
323
- /**
324
- * Hydrates cache with the tokens and account in the AuthenticationResult object
325
- * @param result
326
- * @param request - The request object that was used to obtain the AuthenticationResult
327
- * @returns
328
- */
329
- async hydrateCache(result, request) {
330
- return this.controller.hydrateCache(result, request);
331
- }
332
- /**
333
- * Clears tokens and account from the browser cache.
334
- * @param logoutRequest
335
- */
336
- clearCache(logoutRequest) {
337
- return this.controller.clearCache(logoutRequest);
338
- }
7
+ /*
8
+ * Copyright (c) Microsoft Corporation. All rights reserved.
9
+ * Licensed under the MIT License.
10
+ */
11
+ /**
12
+ * The PublicClientApplication class is the object exposed by the library to perform authentication and authorization functions in Single Page Applications
13
+ * to obtain JWT tokens as described in the OAuth 2.0 Authorization Code Flow with PKCE specification.
14
+ */
15
+ class PublicClientApplication {
16
+ static async createPublicClientApplication(configuration) {
17
+ const controller = await createV3Controller(configuration);
18
+ const pca = new PublicClientApplication(configuration, controller);
19
+ return pca;
20
+ }
21
+ /**
22
+ * @constructor
23
+ * Constructor for the PublicClientApplication used to instantiate the PublicClientApplication object
24
+ *
25
+ * Important attributes in the Configuration object for auth are:
26
+ * - clientID: the application ID of your application. You can obtain one by registering your application with our Application registration portal : https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview
27
+ * - authority: the authority URL for your application.
28
+ * - redirect_uri: the uri of your application registered in the portal.
29
+ *
30
+ * In Azure AD, authority is a URL indicating the Azure active directory that MSAL uses to obtain tokens.
31
+ * It is of the form https://login.microsoftonline.com/{Enter_the_Tenant_Info_Here}
32
+ * If your application supports Accounts in one organizational directory, replace "Enter_the_Tenant_Info_Here" value with the Tenant Id or Tenant name (for example, contoso.microsoft.com).
33
+ * If your application supports Accounts in any organizational directory, replace "Enter_the_Tenant_Info_Here" value with organizations.
34
+ * If your application supports Accounts in any organizational directory and personal Microsoft accounts, replace "Enter_the_Tenant_Info_Here" value with common.
35
+ * To restrict support to Personal Microsoft accounts only, replace "Enter_the_Tenant_Info_Here" value with consumers.
36
+ *
37
+ * In Azure B2C, authority is of the form https://{instance}/tfp/{tenant}/{policyName}/
38
+ * Full B2C functionality will be available in this library in future versions.
39
+ *
40
+ * @param configuration Object for the MSAL PublicClientApplication instance
41
+ * @param IController Optional parameter to explictly set the controller. (Will be removed when we remove public constructor)
42
+ */
43
+ constructor(configuration, controller) {
44
+ if (controller) {
45
+ this.controller = controller;
46
+ }
47
+ else {
48
+ const standardOperatingContext = new StandardOperatingContext(configuration);
49
+ this.controller = new StandardController(standardOperatingContext);
50
+ }
51
+ }
52
+ /**
53
+ * Initializer function to perform async startup tasks such as connecting to WAM extension
54
+ */
55
+ async initialize() {
56
+ return this.controller.initialize();
57
+ }
58
+ /**
59
+ * Use when you want to obtain an access_token for your API via opening a popup window in the user's browser
60
+ *
61
+ * @param request
62
+ *
63
+ * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
64
+ */
65
+ async acquireTokenPopup(request) {
66
+ return this.controller.acquireTokenPopup(request);
67
+ }
68
+ /**
69
+ * Use when you want to obtain an access_token for your API by redirecting the user's browser window to the authorization endpoint. This function redirects
70
+ * the page, so any code that follows this function will not execute.
71
+ *
72
+ * IMPORTANT: It is NOT recommended to have code that is dependent on the resolution of the Promise. This function will navigate away from the current
73
+ * browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.
74
+ *
75
+ * @param request
76
+ */
77
+ acquireTokenRedirect(request) {
78
+ return this.controller.acquireTokenRedirect(request);
79
+ }
80
+ /**
81
+ * Silently acquire an access token for a given set of scopes. Returns currently processing promise if parallel requests are made.
82
+ *
83
+ * @param {@link (SilentRequest:type)}
84
+ * @returns {Promise.<AuthenticationResult>} - a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the {@link AuthenticationResult} object
85
+ */
86
+ acquireTokenSilent(silentRequest) {
87
+ return this.controller.acquireTokenSilent(silentRequest);
88
+ }
89
+ /**
90
+ * This function redeems an authorization code (passed as code) from the eSTS token endpoint.
91
+ * This authorization code should be acquired server-side using a confidential client to acquire a spa_code.
92
+ * This API is not indended for normal authorization code acquisition and redemption.
93
+ *
94
+ * Redemption of this authorization code will not require PKCE, as it was acquired by a confidential client.
95
+ *
96
+ * @param request {@link AuthorizationCodeRequest}
97
+ * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
98
+ */
99
+ acquireTokenByCode(request) {
100
+ return this.controller.acquireTokenByCode(request);
101
+ }
102
+ /**
103
+ * Adds event callbacks to array
104
+ * @param callback
105
+ */
106
+ addEventCallback(callback) {
107
+ return this.controller.addEventCallback(callback);
108
+ }
109
+ /**
110
+ * Removes callback with provided id from callback array
111
+ * @param callbackId
112
+ */
113
+ removeEventCallback(callbackId) {
114
+ return this.controller.removeEventCallback(callbackId);
115
+ }
116
+ /**
117
+ * Registers a callback to receive performance events.
118
+ *
119
+ * @param {PerformanceCallbackFunction} callback
120
+ * @returns {string}
121
+ */
122
+ addPerformanceCallback(callback) {
123
+ return this.controller.addPerformanceCallback(callback);
124
+ }
125
+ /**
126
+ * Removes a callback registered with addPerformanceCallback.
127
+ *
128
+ * @param {string} callbackId
129
+ * @returns {boolean}
130
+ */
131
+ removePerformanceCallback(callbackId) {
132
+ return this.controller.removePerformanceCallback(callbackId);
133
+ }
134
+ /**
135
+ * Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
136
+ */
137
+ enableAccountStorageEvents() {
138
+ this.controller.enableAccountStorageEvents();
139
+ }
140
+ /**
141
+ * Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
142
+ */
143
+ disableAccountStorageEvents() {
144
+ this.controller.disableAccountStorageEvents();
145
+ }
146
+ /**
147
+ * Returns the first account found in the cache that matches the account filter passed in.
148
+ * @param accountFilter
149
+ * @returns The first account found in the cache matching the provided filter or null if no account could be found.
150
+ */
151
+ getAccount(accountFilter) {
152
+ return this.controller.getAccount(accountFilter);
153
+ }
154
+ /**
155
+ * Returns the signed in account matching homeAccountId.
156
+ * (the account object is created at the time of successful login)
157
+ * or null when no matching account is found
158
+ * @param homeAccountId
159
+ * @returns The account object stored in MSAL
160
+ * @deprecated - Use getAccount instead
161
+ */
162
+ getAccountByHomeId(homeAccountId) {
163
+ return this.controller.getAccountByHomeId(homeAccountId);
164
+ }
165
+ /**
166
+ * Returns the signed in account matching localAccountId.
167
+ * (the account object is created at the time of successful login)
168
+ * or null when no matching account is found
169
+ * @param localAccountId
170
+ * @returns The account object stored in MSAL
171
+ * @deprecated - Use getAccount instead
172
+ */
173
+ getAccountByLocalId(localId) {
174
+ return this.controller.getAccountByLocalId(localId);
175
+ }
176
+ /**
177
+ * Returns the signed in account matching username.
178
+ * (the account object is created at the time of successful login)
179
+ * or null when no matching account is found.
180
+ * This API is provided for convenience but getAccountById should be used for best reliability
181
+ * @param userName
182
+ * @returns The account object stored in MSAL
183
+ * @deprecated - Use getAccount instead
184
+ */
185
+ getAccountByUsername(userName) {
186
+ return this.controller.getAccountByUsername(userName);
187
+ }
188
+ /**
189
+ * Returns all the accounts in the cache that match the optional filter. If no filter is provided, all accounts are returned.
190
+ * @param accountFilter - (Optional) filter to narrow down the accounts returned
191
+ * @returns Array of AccountInfo objects in cache
192
+ */
193
+ getAllAccounts(accountFilter) {
194
+ return this.controller.getAllAccounts(accountFilter);
195
+ }
196
+ /**
197
+ * Event handler function which allows users to fire events after the PublicClientApplication object
198
+ * has loaded during redirect flows. This should be invoked on all page loads involved in redirect
199
+ * auth flows.
200
+ * @param hash Hash to process. Defaults to the current value of window.location.hash. Only needs to be provided explicitly if the response to be handled is not contained in the current value.
201
+ * @returns Token response or null. If the return value is null, then no auth redirect was detected.
202
+ */
203
+ handleRedirectPromise(hash) {
204
+ return this.controller.handleRedirectPromise(hash);
205
+ }
206
+ /**
207
+ * Use when initiating the login process via opening a popup window in the user's browser
208
+ *
209
+ * @param request
210
+ *
211
+ * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
212
+ */
213
+ loginPopup(request) {
214
+ return this.controller.loginPopup(request);
215
+ }
216
+ /**
217
+ * Use when initiating the login process by redirecting the user's browser to the authorization endpoint. This function redirects the page, so
218
+ * any code that follows this function will not execute.
219
+ *
220
+ * IMPORTANT: It is NOT recommended to have code that is dependent on the resolution of the Promise. This function will navigate away from the current
221
+ * browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.
222
+ *
223
+ * @param request
224
+ */
225
+ loginRedirect(request) {
226
+ return this.controller.loginRedirect(request);
227
+ }
228
+ /**
229
+ * Deprecated logout function. Use logoutRedirect or logoutPopup instead
230
+ * @param logoutRequest
231
+ * @deprecated
232
+ */
233
+ logout(logoutRequest) {
234
+ return this.controller.logout(logoutRequest);
235
+ }
236
+ /**
237
+ * Use to log out the current user, and redirect the user to the postLogoutRedirectUri.
238
+ * Default behaviour is to redirect the user to `window.location.href`.
239
+ * @param logoutRequest
240
+ */
241
+ logoutRedirect(logoutRequest) {
242
+ return this.controller.logoutRedirect(logoutRequest);
243
+ }
244
+ /**
245
+ * Clears local cache for the current user then opens a popup window prompting the user to sign-out of the server
246
+ * @param logoutRequest
247
+ */
248
+ logoutPopup(logoutRequest) {
249
+ return this.controller.logoutPopup(logoutRequest);
250
+ }
251
+ /**
252
+ * This function uses a hidden iframe to fetch an authorization code from the eSTS. There are cases where this may not work:
253
+ * - Any browser using a form of Intelligent Tracking Prevention
254
+ * - If there is not an established session with the service
255
+ *
256
+ * In these cases, the request must be done inside a popup or full frame redirect.
257
+ *
258
+ * For the cases where interaction is required, you cannot send a request with prompt=none.
259
+ *
260
+ * If your refresh token has expired, you can use this function to fetch a new set of tokens silently as long as
261
+ * you session on the server still exists.
262
+ * @param request {@link SsoSilentRequest}
263
+ *
264
+ * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
265
+ */
266
+ ssoSilent(request) {
267
+ return this.controller.ssoSilent(request);
268
+ }
269
+ /**
270
+ * Gets the token cache for the application.
271
+ */
272
+ getTokenCache() {
273
+ return this.controller.getTokenCache();
274
+ }
275
+ /**
276
+ * Returns the logger instance
277
+ */
278
+ getLogger() {
279
+ return this.controller.getLogger();
280
+ }
281
+ /**
282
+ * Replaces the default logger set in configurations with new Logger with new configurations
283
+ * @param logger Logger instance
284
+ */
285
+ setLogger(logger) {
286
+ this.controller.setLogger(logger);
287
+ }
288
+ /**
289
+ * Sets the account to use as the active account. If no account is passed to the acquireToken APIs, then MSAL will use this active account.
290
+ * @param account
291
+ */
292
+ setActiveAccount(account) {
293
+ this.controller.setActiveAccount(account);
294
+ }
295
+ /**
296
+ * Gets the currently active account
297
+ */
298
+ getActiveAccount() {
299
+ return this.controller.getActiveAccount();
300
+ }
301
+ /**
302
+ * Called by wrapper libraries (Angular & React) to set SKU and Version passed down to telemetry, logger, etc.
303
+ * @param sku
304
+ * @param version
305
+ */
306
+ initializeWrapperLibrary(sku, version) {
307
+ return this.controller.initializeWrapperLibrary(sku, version);
308
+ }
309
+ /**
310
+ * Sets navigation client
311
+ * @param navigationClient
312
+ */
313
+ setNavigationClient(navigationClient) {
314
+ this.controller.setNavigationClient(navigationClient);
315
+ }
316
+ /**
317
+ * Returns the configuration object
318
+ * @internal
319
+ */
320
+ getConfiguration() {
321
+ return this.controller.getConfiguration();
322
+ }
323
+ /**
324
+ * Hydrates cache with the tokens and account in the AuthenticationResult object
325
+ * @param result
326
+ * @param request - The request object that was used to obtain the AuthenticationResult
327
+ * @returns
328
+ */
329
+ async hydrateCache(result, request) {
330
+ return this.controller.hydrateCache(result, request);
331
+ }
332
+ /**
333
+ * Clears tokens and account from the browser cache.
334
+ * @param logoutRequest
335
+ */
336
+ clearCache(logoutRequest) {
337
+ return this.controller.clearCache(logoutRequest);
338
+ }
339
339
  }
340
340
 
341
341
  export { PublicClientApplication };