@azure/msal-browser 3.0.0-alpha.1 → 3.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (178) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +213 -213
  3. package/dist/app/IPublicClientApplication.d.ts +45 -45
  4. package/dist/app/IPublicClientApplication.js +96 -96
  5. package/dist/app/PublicClientApplication.d.ts +244 -244
  6. package/dist/app/PublicClientApplication.js +307 -307
  7. package/dist/broker/nativeBroker/NativeMessageHandler.d.ts +63 -63
  8. package/dist/broker/nativeBroker/NativeMessageHandler.js +255 -255
  9. package/dist/broker/nativeBroker/NativeRequest.d.ts +43 -43
  10. package/dist/broker/nativeBroker/NativeResponse.d.ts +48 -48
  11. package/dist/cache/AsyncMemoryStorage.d.ts +51 -51
  12. package/dist/cache/AsyncMemoryStorage.js +132 -132
  13. package/dist/cache/BrowserCacheManager.d.ts +376 -377
  14. package/dist/cache/BrowserCacheManager.d.ts.map +1 -1
  15. package/dist/cache/BrowserCacheManager.js +1275 -1276
  16. package/dist/cache/BrowserCacheManager.js.map +1 -1
  17. package/dist/cache/BrowserStorage.d.ts +11 -11
  18. package/dist/cache/BrowserStorage.js +35 -35
  19. package/dist/cache/CryptoKeyStore.d.ts +18 -17
  20. package/dist/cache/CryptoKeyStore.d.ts.map +1 -1
  21. package/dist/cache/CryptoKeyStore.js +40 -41
  22. package/dist/cache/CryptoKeyStore.js.map +1 -1
  23. package/dist/cache/DatabaseStorage.d.ts +56 -56
  24. package/dist/cache/DatabaseStorage.js +190 -190
  25. package/dist/cache/IAsyncMemoryStorage.d.ts +27 -27
  26. package/dist/cache/ITokenCache.d.ts +10 -10
  27. package/dist/cache/IWindowStorage.d.ts +27 -27
  28. package/dist/cache/MemoryStorage.d.ts +11 -11
  29. package/dist/cache/MemoryStorage.js +31 -31
  30. package/dist/cache/TokenCache.d.ts +76 -76
  31. package/dist/cache/TokenCache.js +225 -225
  32. package/dist/config/Configuration.d.ts +187 -203
  33. package/dist/config/Configuration.d.ts.map +1 -1
  34. package/dist/config/Configuration.js +97 -101
  35. package/dist/config/Configuration.js.map +1 -1
  36. package/dist/controllers/ControllerFactory.d.ts +9 -9
  37. package/dist/controllers/ControllerFactory.js +37 -37
  38. package/dist/controllers/IController.d.ts +66 -66
  39. package/dist/controllers/IController.d.ts.map +1 -1
  40. package/dist/controllers/StandardController.d.ts +413 -413
  41. package/dist/controllers/StandardController.d.ts.map +1 -1
  42. package/dist/controllers/StandardController.js +1277 -1272
  43. package/dist/controllers/StandardController.js.map +1 -1
  44. package/dist/crypto/BrowserCrypto.d.ts +49 -61
  45. package/dist/crypto/BrowserCrypto.d.ts.map +1 -1
  46. package/dist/crypto/BrowserCrypto.js +93 -134
  47. package/dist/crypto/BrowserCrypto.js.map +1 -1
  48. package/dist/crypto/CryptoOps.d.ts +72 -73
  49. package/dist/crypto/CryptoOps.d.ts.map +1 -1
  50. package/dist/crypto/CryptoOps.js +150 -150
  51. package/dist/crypto/CryptoOps.js.map +1 -1
  52. package/dist/crypto/GuidGenerator.d.ts +12 -12
  53. package/dist/crypto/GuidGenerator.js +96 -96
  54. package/dist/crypto/ISubtleCrypto.d.ts +9 -9
  55. package/dist/crypto/ModernBrowserCrypto.d.ts +9 -9
  56. package/dist/crypto/ModernBrowserCrypto.js +24 -24
  57. package/dist/crypto/PkceGenerator.d.ts +24 -24
  58. package/dist/crypto/PkceGenerator.js +58 -58
  59. package/dist/crypto/SignedHttpRequest.d.ts +30 -30
  60. package/dist/crypto/SignedHttpRequest.js +39 -39
  61. package/dist/encode/Base64Decode.d.ts +22 -22
  62. package/dist/encode/Base64Decode.js +73 -73
  63. package/dist/encode/Base64Encode.d.ts +31 -31
  64. package/dist/encode/Base64Encode.js +79 -79
  65. package/dist/error/BrowserAuthError.d.ts +382 -382
  66. package/dist/error/BrowserAuthError.js +483 -483
  67. package/dist/error/BrowserConfigurationAuthError.d.ts +70 -70
  68. package/dist/error/BrowserConfigurationAuthError.js +96 -96
  69. package/dist/error/NativeAuthError.d.ts +57 -56
  70. package/dist/error/NativeAuthError.d.ts.map +1 -1
  71. package/dist/error/NativeAuthError.js +93 -88
  72. package/dist/error/NativeAuthError.js.map +1 -1
  73. package/dist/event/EventHandler.d.ts +41 -41
  74. package/dist/event/EventHandler.js +119 -119
  75. package/dist/event/EventMessage.d.ts +25 -25
  76. package/dist/event/EventMessage.d.ts.map +1 -1
  77. package/dist/event/EventMessage.js +68 -67
  78. package/dist/event/EventMessage.js.map +1 -1
  79. package/dist/event/EventType.d.ts +28 -26
  80. package/dist/event/EventType.d.ts.map +1 -1
  81. package/dist/event/EventType.js +32 -32
  82. package/dist/event/EventType.js.map +1 -1
  83. package/dist/index.d.ts +35 -35
  84. package/dist/index.js +1 -1
  85. package/dist/interaction_client/BaseInteractionClient.d.ts +53 -52
  86. package/dist/interaction_client/BaseInteractionClient.d.ts.map +1 -1
  87. package/dist/interaction_client/BaseInteractionClient.js +151 -138
  88. package/dist/interaction_client/BaseInteractionClient.js.map +1 -1
  89. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.d.ts +4 -4
  90. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.js +10 -10
  91. package/dist/interaction_client/NativeInteractionClient.d.ts +148 -148
  92. package/dist/interaction_client/NativeInteractionClient.d.ts.map +1 -1
  93. package/dist/interaction_client/NativeInteractionClient.js +521 -517
  94. package/dist/interaction_client/NativeInteractionClient.js.map +1 -1
  95. package/dist/interaction_client/PopupClient.d.ts +111 -111
  96. package/dist/interaction_client/PopupClient.js +476 -476
  97. package/dist/interaction_client/RedirectClient.d.ts +48 -48
  98. package/dist/interaction_client/RedirectClient.d.ts.map +1 -1
  99. package/dist/interaction_client/RedirectClient.js +291 -290
  100. package/dist/interaction_client/RedirectClient.js.map +1 -1
  101. package/dist/interaction_client/SilentAuthCodeClient.d.ts +22 -22
  102. package/dist/interaction_client/SilentAuthCodeClient.js +62 -62
  103. package/dist/interaction_client/SilentCacheClient.d.ts +21 -21
  104. package/dist/interaction_client/SilentCacheClient.js +67 -67
  105. package/dist/interaction_client/SilentCacheClient.js.map +1 -1
  106. package/dist/interaction_client/SilentIframeClient.d.ts +31 -31
  107. package/dist/interaction_client/SilentIframeClient.js +127 -127
  108. package/dist/interaction_client/SilentRefreshClient.d.ts +19 -19
  109. package/dist/interaction_client/SilentRefreshClient.js +62 -62
  110. package/dist/interaction_client/SilentRefreshClient.js.map +1 -1
  111. package/dist/interaction_client/StandardInteractionClient.d.ts +59 -59
  112. package/dist/interaction_client/StandardInteractionClient.js +259 -259
  113. package/dist/interaction_handler/InteractionHandler.d.ts +39 -39
  114. package/dist/interaction_handler/InteractionHandler.js +127 -127
  115. package/dist/interaction_handler/RedirectHandler.d.ts +24 -24
  116. package/dist/interaction_handler/RedirectHandler.js +118 -118
  117. package/dist/interaction_handler/SilentHandler.d.ts +47 -47
  118. package/dist/interaction_handler/SilentHandler.js +162 -162
  119. package/dist/internals.d.ts +23 -23
  120. package/dist/internals.js +4 -4
  121. package/dist/navigation/INavigationClient.d.ts +16 -16
  122. package/dist/navigation/NavigationClient.d.ts +22 -22
  123. package/dist/navigation/NavigationClient.js +40 -40
  124. package/dist/navigation/NavigationOptions.d.ts +12 -12
  125. package/dist/network/FetchClient.d.ts +26 -26
  126. package/dist/network/FetchClient.js +99 -99
  127. package/dist/network/XhrClient.d.ts +40 -40
  128. package/dist/network/XhrClient.js +117 -117
  129. package/dist/operatingcontext/BaseOperatingContext.d.ts +40 -40
  130. package/dist/operatingcontext/BaseOperatingContext.js +44 -44
  131. package/dist/operatingcontext/StandardOperatingContext.d.ts +25 -25
  132. package/dist/operatingcontext/StandardOperatingContext.js +43 -43
  133. package/dist/operatingcontext/TeamsAppOperatingContext.d.ts +25 -25
  134. package/dist/operatingcontext/TeamsAppOperatingContext.js +42 -42
  135. package/dist/packageMetadata.d.ts +2 -2
  136. package/dist/packageMetadata.d.ts.map +1 -1
  137. package/dist/packageMetadata.js +4 -4
  138. package/dist/request/AuthorizationCodeRequest.d.ts +8 -8
  139. package/dist/request/AuthorizationUrlRequest.d.ts +8 -8
  140. package/dist/request/EndSessionPopupRequest.d.ts +18 -18
  141. package/dist/request/EndSessionRequest.d.ts +15 -15
  142. package/dist/request/PopupRequest.d.ts +32 -32
  143. package/dist/request/PopupWindowAttributes.d.ts +15 -15
  144. package/dist/request/RedirectRequest.d.ts +33 -33
  145. package/dist/request/SilentRequest.d.ts +30 -30
  146. package/dist/request/SsoSilentRequest.d.ts +26 -26
  147. package/dist/telemetry/BrowserPerformanceClient.d.ts +37 -38
  148. package/dist/telemetry/BrowserPerformanceClient.d.ts.map +1 -1
  149. package/dist/telemetry/BrowserPerformanceClient.js +124 -124
  150. package/dist/telemetry/BrowserPerformanceClient.js.map +1 -1
  151. package/dist/telemetry/BrowserPerformanceMeasurement.d.ts +21 -21
  152. package/dist/telemetry/BrowserPerformanceMeasurement.js +92 -92
  153. package/dist/utils/BrowserConstants.d.ts +176 -166
  154. package/dist/utils/BrowserConstants.d.ts.map +1 -1
  155. package/dist/utils/BrowserConstants.js +205 -215
  156. package/dist/utils/BrowserConstants.js.map +1 -1
  157. package/dist/utils/BrowserProtocolUtils.d.ts +18 -18
  158. package/dist/utils/BrowserProtocolUtils.js +34 -34
  159. package/dist/utils/BrowserStringUtils.d.ts +26 -26
  160. package/dist/utils/BrowserStringUtils.js +149 -149
  161. package/dist/utils/BrowserUtils.d.ts +65 -65
  162. package/dist/utils/BrowserUtils.js +138 -138
  163. package/dist/utils/MathUtils.d.ts +11 -11
  164. package/dist/utils/MathUtils.js +21 -21
  165. package/lib/msal-browser.cjs.js +18227 -0
  166. package/lib/msal-browser.cjs.js.map +1 -0
  167. package/lib/msal-browser.js +18233 -0
  168. package/lib/msal-browser.js.map +1 -0
  169. package/lib/msal-browser.min.js +63 -0
  170. package/package.json +101 -95
  171. package/dist/crypto/MsBrowserCrypto.d.ts +0 -10
  172. package/dist/crypto/MsBrowserCrypto.d.ts.map +0 -1
  173. package/dist/crypto/MsBrowserCrypto.js +0 -88
  174. package/dist/crypto/MsBrowserCrypto.js.map +0 -1
  175. package/dist/crypto/MsrBrowserCrypto.d.ts +0 -18
  176. package/dist/crypto/MsrBrowserCrypto.d.ts.map +0 -1
  177. package/dist/crypto/MsrBrowserCrypto.js +0 -35
  178. package/dist/crypto/MsrBrowserCrypto.js.map +0 -1
@@ -1,315 +1,315 @@
1
- /*! @azure/msal-browser v3.0.0-alpha.1 2023-05-08 */
1
+ /*! @azure/msal-browser v3.0.0-beta.0 2023-06-19 */
2
2
  'use strict';
3
3
  import { ControllerFactory } from '../controllers/ControllerFactory.js';
4
4
  import { StandardController } from '../controllers/StandardController.js';
5
5
  import { StandardOperatingContext } from '../operatingcontext/StandardOperatingContext.js';
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 factory = new ControllerFactory(configuration);
18
- const controller = await factory.createController();
19
- const pca = new PublicClientApplication(configuration, controller);
20
- return pca;
21
- }
22
- /**
23
- * @constructor
24
- * Constructor for the PublicClientApplication used to instantiate the PublicClientApplication object
25
- *
26
- * Important attributes in the Configuration object for auth are:
27
- * - 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
28
- * - authority: the authority URL for your application.
29
- * - redirect_uri: the uri of your application registered in the portal.
30
- *
31
- * In Azure AD, authority is a URL indicating the Azure active directory that MSAL uses to obtain tokens.
32
- * It is of the form https://login.microsoftonline.com/{Enter_the_Tenant_Info_Here}
33
- * 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).
34
- * If your application supports Accounts in any organizational directory, replace "Enter_the_Tenant_Info_Here" value with organizations.
35
- * If your application supports Accounts in any organizational directory and personal Microsoft accounts, replace "Enter_the_Tenant_Info_Here" value with common.
36
- * To restrict support to Personal Microsoft accounts only, replace "Enter_the_Tenant_Info_Here" value with consumers.
37
- *
38
- * In Azure B2C, authority is of the form https://{instance}/tfp/{tenant}/{policyName}/
39
- * Full B2C functionality will be available in this library in future versions.
40
- *
41
- * @param configuration Object for the MSAL PublicClientApplication instance
42
- * @param IController Optional parameter to explictly set the controller. (Will be removed when we remove public constructor)
43
- */
44
- constructor(configuration, controller) {
45
- if (controller) {
46
- this.controller = controller;
47
- }
48
- else {
49
- const standardOperatingContext = new StandardOperatingContext(configuration);
50
- this.controller = new StandardController(standardOperatingContext);
51
- }
52
- }
53
- /**
54
- * Initializer function to perform async startup tasks such as connecting to WAM extension
55
- */
56
- async initialize() {
57
- return this.controller.initialize();
58
- }
59
- /**
60
- * Use when you want to obtain an access_token for your API via opening a popup window in the user's browser
61
- *
62
- * @param request
63
- *
64
- * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
65
- */
66
- async acquireTokenPopup(request) {
67
- return this.controller.acquireTokenPopup(request);
68
- }
69
- /**
70
- * 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
71
- * the page, so any code that follows this function will not execute.
72
- *
73
- * 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
74
- * browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.
75
- *
76
- * @param request
77
- */
78
- acquireTokenRedirect(request) {
79
- return this.controller.acquireTokenRedirect(request);
80
- }
81
- /**
82
- * Silently acquire an access token for a given set of scopes. Returns currently processing promise if parallel requests are made.
83
- *
84
- * @param {@link (SilentRequest:type)}
85
- * @returns {Promise.<AuthenticationResult>} - a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the {@link AuthResponse} object
86
- */
87
- acquireTokenSilent(silentRequest) {
88
- return this.controller.acquireTokenSilent(silentRequest);
89
- }
90
- /**
91
- * This function redeems an authorization code (passed as code) from the eSTS token endpoint.
92
- * This authorization code should be acquired server-side using a confidential client to acquire a spa_code.
93
- * This API is not indended for normal authorization code acquisition and redemption.
94
- *
95
- * Redemption of this authorization code will not require PKCE, as it was acquired by a confidential client.
96
- *
97
- * @param request {@link AuthorizationCodeRequest}
98
- * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
99
- */
100
- acquireTokenByCode(request) {
101
- return this.controller.acquireTokenByCode(request);
102
- }
103
- /**
104
- * Adds event callbacks to array
105
- * @param callback
106
- */
107
- addEventCallback(callback) {
108
- return this.controller.addEventCallback(callback);
109
- }
110
- /**
111
- * Removes callback with provided id from callback array
112
- * @param callbackId
113
- */
114
- removeEventCallback(callbackId) {
115
- return this.controller.removeEventCallback(callbackId);
116
- }
117
- /**
118
- * Registers a callback to receive performance events.
119
- *
120
- * @param {PerformanceCallbackFunction} callback
121
- * @returns {string}
122
- */
123
- addPerformanceCallback(callback) {
124
- return this.controller.addPerformanceCallback(callback);
125
- }
126
- /**
127
- * Removes a callback registered with addPerformanceCallback.
128
- *
129
- * @param {string} callbackId
130
- * @returns {boolean}
131
- */
132
- removePerformanceCallback(callbackId) {
133
- return this.controller.removePerformanceCallback(callbackId);
134
- }
135
- /**
136
- * Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
137
- */
138
- enableAccountStorageEvents() {
139
- this.controller.enableAccountStorageEvents();
140
- }
141
- /**
142
- * Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
143
- */
144
- disableAccountStorageEvents() {
145
- this.controller.disableAccountStorageEvents();
146
- }
147
- /**
148
- * Returns the signed in account matching homeAccountId.
149
- * (the account object is created at the time of successful login)
150
- * or null when no matching account is found
151
- * @param homeAccountId
152
- * @returns The account object stored in MSAL
153
- */
154
- getAccountByHomeId(homeAccountId) {
155
- return this.controller.getAccountByHomeId(homeAccountId);
156
- }
157
- /**
158
- * Returns the signed in account matching localAccountId.
159
- * (the account object is created at the time of successful login)
160
- * or null when no matching account is found
161
- * @param localAccountId
162
- * @returns The account object stored in MSAL
163
- */
164
- getAccountByLocalId(localId) {
165
- return this.controller.getAccountByLocalId(localId);
166
- }
167
- /**
168
- * Returns the signed in account matching username.
169
- * (the account object is created at the time of successful login)
170
- * or null when no matching account is found.
171
- * This API is provided for convenience but getAccountById should be used for best reliability
172
- * @param userName
173
- * @returns The account object stored in MSAL
174
- */
175
- getAccountByUsername(userName) {
176
- return this.controller.getAccountByUsername(userName);
177
- }
178
- /**
179
- * Returns all accounts that MSAL currently has data for.
180
- * (the account object is created at the time of successful login)
181
- * or empty array when no accounts are found
182
- * @returns Array of account objects in cache
183
- */
184
- getAllAccounts() {
185
- return this.controller.getAllAccounts();
186
- }
187
- /**
188
- * Event handler function which allows users to fire events after the PublicClientApplication object
189
- * has loaded during redirect flows. This should be invoked on all page loads involved in redirect
190
- * auth flows.
191
- * @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.
192
- * @returns Token response or null. If the return value is null, then no auth redirect was detected.
193
- */
194
- handleRedirectPromise(hash) {
195
- return this.controller.handleRedirectPromise(hash);
196
- }
197
- /**
198
- * Use when initiating the login process via opening a popup window in the user's browser
199
- *
200
- * @param request
201
- *
202
- * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
203
- */
204
- loginPopup(request) {
205
- return this.controller.loginPopup(request);
206
- }
207
- /**
208
- * Use when initiating the login process by redirecting the user's browser to the authorization endpoint. This function redirects the page, so
209
- * any code that follows this function will not execute.
210
- *
211
- * 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
212
- * browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.
213
- *
214
- * @param request
215
- */
216
- loginRedirect(request) {
217
- return this.controller.loginRedirect(request);
218
- }
219
- /**
220
- * Deprecated logout function. Use logoutRedirect or logoutPopup instead
221
- * @param logoutRequest
222
- * @deprecated
223
- */
224
- logout(logoutRequest) {
225
- return this.controller.logout(logoutRequest);
226
- }
227
- /**
228
- * Use to log out the current user, and redirect the user to the postLogoutRedirectUri.
229
- * Default behaviour is to redirect the user to `window.location.href`.
230
- * @param logoutRequest
231
- */
232
- logoutRedirect(logoutRequest) {
233
- return this.controller.logoutRedirect(logoutRequest);
234
- }
235
- /**
236
- * Clears local cache for the current user then opens a popup window prompting the user to sign-out of the server
237
- * @param logoutRequest
238
- */
239
- logoutPopup(logoutRequest) {
240
- return this.controller.logoutPopup(logoutRequest);
241
- }
242
- /**
243
- * This function uses a hidden iframe to fetch an authorization code from the eSTS. There are cases where this may not work:
244
- * - Any browser using a form of Intelligent Tracking Prevention
245
- * - If there is not an established session with the service
246
- *
247
- * In these cases, the request must be done inside a popup or full frame redirect.
248
- *
249
- * For the cases where interaction is required, you cannot send a request with prompt=none.
250
- *
251
- * If your refresh token has expired, you can use this function to fetch a new set of tokens silently as long as
252
- * you session on the server still exists.
253
- * @param request {@link SsoSilentRequest}
254
- *
255
- * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
256
- */
257
- ssoSilent(request) {
258
- return this.controller.ssoSilent(request);
259
- }
260
- /**
261
- * Gets the token cache for the application.
262
- */
263
- getTokenCache() {
264
- return this.controller.getTokenCache();
265
- }
266
- /**
267
- * Returns the logger instance
268
- */
269
- getLogger() {
270
- return this.controller.getLogger();
271
- }
272
- /**
273
- * Replaces the default logger set in configurations with new Logger with new configurations
274
- * @param logger Logger instance
275
- */
276
- setLogger(logger) {
277
- this.controller.setLogger(logger);
278
- }
279
- /**
280
- * 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.
281
- * @param account
282
- */
283
- setActiveAccount(account) {
284
- this.controller.setActiveAccount(account);
285
- }
286
- /**
287
- * Gets the currently active account
288
- */
289
- getActiveAccount() {
290
- return this.controller.getActiveAccount();
291
- }
292
- /**
293
- * Called by wrapper libraries (Angular & React) to set SKU and Version passed down to telemetry, logger, etc.
294
- * @param sku
295
- * @param version
296
- */
297
- initializeWrapperLibrary(sku, version) {
298
- return this.controller.initializeWrapperLibrary(sku, version);
299
- }
300
- /**
301
- * Sets navigation client
302
- * @param navigationClient
303
- */
304
- setNavigationClient(navigationClient) {
305
- this.controller.setNavigationClient(navigationClient);
306
- }
307
- /**
308
- * Returns the configuration object
309
- */
310
- getConfiguration() {
311
- return this.controller.getConfiguration();
312
- }
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 factory = new ControllerFactory(configuration);
18
+ const controller = await factory.createController();
19
+ const pca = new PublicClientApplication(configuration, controller);
20
+ return pca;
21
+ }
22
+ /**
23
+ * @constructor
24
+ * Constructor for the PublicClientApplication used to instantiate the PublicClientApplication object
25
+ *
26
+ * Important attributes in the Configuration object for auth are:
27
+ * - 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
28
+ * - authority: the authority URL for your application.
29
+ * - redirect_uri: the uri of your application registered in the portal.
30
+ *
31
+ * In Azure AD, authority is a URL indicating the Azure active directory that MSAL uses to obtain tokens.
32
+ * It is of the form https://login.microsoftonline.com/{Enter_the_Tenant_Info_Here}
33
+ * 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).
34
+ * If your application supports Accounts in any organizational directory, replace "Enter_the_Tenant_Info_Here" value with organizations.
35
+ * If your application supports Accounts in any organizational directory and personal Microsoft accounts, replace "Enter_the_Tenant_Info_Here" value with common.
36
+ * To restrict support to Personal Microsoft accounts only, replace "Enter_the_Tenant_Info_Here" value with consumers.
37
+ *
38
+ * In Azure B2C, authority is of the form https://{instance}/tfp/{tenant}/{policyName}/
39
+ * Full B2C functionality will be available in this library in future versions.
40
+ *
41
+ * @param configuration Object for the MSAL PublicClientApplication instance
42
+ * @param IController Optional parameter to explictly set the controller. (Will be removed when we remove public constructor)
43
+ */
44
+ constructor(configuration, controller) {
45
+ if (controller) {
46
+ this.controller = controller;
47
+ }
48
+ else {
49
+ const standardOperatingContext = new StandardOperatingContext(configuration);
50
+ this.controller = new StandardController(standardOperatingContext);
51
+ }
52
+ }
53
+ /**
54
+ * Initializer function to perform async startup tasks such as connecting to WAM extension
55
+ */
56
+ async initialize() {
57
+ return this.controller.initialize();
58
+ }
59
+ /**
60
+ * Use when you want to obtain an access_token for your API via opening a popup window in the user's browser
61
+ *
62
+ * @param request
63
+ *
64
+ * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
65
+ */
66
+ async acquireTokenPopup(request) {
67
+ return this.controller.acquireTokenPopup(request);
68
+ }
69
+ /**
70
+ * 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
71
+ * the page, so any code that follows this function will not execute.
72
+ *
73
+ * 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
74
+ * browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.
75
+ *
76
+ * @param request
77
+ */
78
+ acquireTokenRedirect(request) {
79
+ return this.controller.acquireTokenRedirect(request);
80
+ }
81
+ /**
82
+ * Silently acquire an access token for a given set of scopes. Returns currently processing promise if parallel requests are made.
83
+ *
84
+ * @param {@link (SilentRequest:type)}
85
+ * @returns {Promise.<AuthenticationResult>} - a promise that is fulfilled when this function has completed, or rejected if an error was raised. Returns the {@link AuthResponse} object
86
+ */
87
+ acquireTokenSilent(silentRequest) {
88
+ return this.controller.acquireTokenSilent(silentRequest);
89
+ }
90
+ /**
91
+ * This function redeems an authorization code (passed as code) from the eSTS token endpoint.
92
+ * This authorization code should be acquired server-side using a confidential client to acquire a spa_code.
93
+ * This API is not indended for normal authorization code acquisition and redemption.
94
+ *
95
+ * Redemption of this authorization code will not require PKCE, as it was acquired by a confidential client.
96
+ *
97
+ * @param request {@link AuthorizationCodeRequest}
98
+ * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
99
+ */
100
+ acquireTokenByCode(request) {
101
+ return this.controller.acquireTokenByCode(request);
102
+ }
103
+ /**
104
+ * Adds event callbacks to array
105
+ * @param callback
106
+ */
107
+ addEventCallback(callback) {
108
+ return this.controller.addEventCallback(callback);
109
+ }
110
+ /**
111
+ * Removes callback with provided id from callback array
112
+ * @param callbackId
113
+ */
114
+ removeEventCallback(callbackId) {
115
+ return this.controller.removeEventCallback(callbackId);
116
+ }
117
+ /**
118
+ * Registers a callback to receive performance events.
119
+ *
120
+ * @param {PerformanceCallbackFunction} callback
121
+ * @returns {string}
122
+ */
123
+ addPerformanceCallback(callback) {
124
+ return this.controller.addPerformanceCallback(callback);
125
+ }
126
+ /**
127
+ * Removes a callback registered with addPerformanceCallback.
128
+ *
129
+ * @param {string} callbackId
130
+ * @returns {boolean}
131
+ */
132
+ removePerformanceCallback(callbackId) {
133
+ return this.controller.removePerformanceCallback(callbackId);
134
+ }
135
+ /**
136
+ * Adds event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
137
+ */
138
+ enableAccountStorageEvents() {
139
+ this.controller.enableAccountStorageEvents();
140
+ }
141
+ /**
142
+ * Removes event listener that emits an event when a user account is added or removed from localstorage in a different browser tab or window
143
+ */
144
+ disableAccountStorageEvents() {
145
+ this.controller.disableAccountStorageEvents();
146
+ }
147
+ /**
148
+ * Returns the signed in account matching homeAccountId.
149
+ * (the account object is created at the time of successful login)
150
+ * or null when no matching account is found
151
+ * @param homeAccountId
152
+ * @returns The account object stored in MSAL
153
+ */
154
+ getAccountByHomeId(homeAccountId) {
155
+ return this.controller.getAccountByHomeId(homeAccountId);
156
+ }
157
+ /**
158
+ * Returns the signed in account matching localAccountId.
159
+ * (the account object is created at the time of successful login)
160
+ * or null when no matching account is found
161
+ * @param localAccountId
162
+ * @returns The account object stored in MSAL
163
+ */
164
+ getAccountByLocalId(localId) {
165
+ return this.controller.getAccountByLocalId(localId);
166
+ }
167
+ /**
168
+ * Returns the signed in account matching username.
169
+ * (the account object is created at the time of successful login)
170
+ * or null when no matching account is found.
171
+ * This API is provided for convenience but getAccountById should be used for best reliability
172
+ * @param userName
173
+ * @returns The account object stored in MSAL
174
+ */
175
+ getAccountByUsername(userName) {
176
+ return this.controller.getAccountByUsername(userName);
177
+ }
178
+ /**
179
+ * Returns all accounts that MSAL currently has data for.
180
+ * (the account object is created at the time of successful login)
181
+ * or empty array when no accounts are found
182
+ * @returns Array of account objects in cache
183
+ */
184
+ getAllAccounts() {
185
+ return this.controller.getAllAccounts();
186
+ }
187
+ /**
188
+ * Event handler function which allows users to fire events after the PublicClientApplication object
189
+ * has loaded during redirect flows. This should be invoked on all page loads involved in redirect
190
+ * auth flows.
191
+ * @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.
192
+ * @returns Token response or null. If the return value is null, then no auth redirect was detected.
193
+ */
194
+ handleRedirectPromise(hash) {
195
+ return this.controller.handleRedirectPromise(hash);
196
+ }
197
+ /**
198
+ * Use when initiating the login process via opening a popup window in the user's browser
199
+ *
200
+ * @param request
201
+ *
202
+ * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
203
+ */
204
+ loginPopup(request) {
205
+ return this.controller.loginPopup(request);
206
+ }
207
+ /**
208
+ * Use when initiating the login process by redirecting the user's browser to the authorization endpoint. This function redirects the page, so
209
+ * any code that follows this function will not execute.
210
+ *
211
+ * 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
212
+ * browser window. It currently returns a Promise in order to reflect the asynchronous nature of the code running in this function.
213
+ *
214
+ * @param request
215
+ */
216
+ loginRedirect(request) {
217
+ return this.controller.loginRedirect(request);
218
+ }
219
+ /**
220
+ * Deprecated logout function. Use logoutRedirect or logoutPopup instead
221
+ * @param logoutRequest
222
+ * @deprecated
223
+ */
224
+ logout(logoutRequest) {
225
+ return this.controller.logout(logoutRequest);
226
+ }
227
+ /**
228
+ * Use to log out the current user, and redirect the user to the postLogoutRedirectUri.
229
+ * Default behaviour is to redirect the user to `window.location.href`.
230
+ * @param logoutRequest
231
+ */
232
+ logoutRedirect(logoutRequest) {
233
+ return this.controller.logoutRedirect(logoutRequest);
234
+ }
235
+ /**
236
+ * Clears local cache for the current user then opens a popup window prompting the user to sign-out of the server
237
+ * @param logoutRequest
238
+ */
239
+ logoutPopup(logoutRequest) {
240
+ return this.controller.logoutPopup(logoutRequest);
241
+ }
242
+ /**
243
+ * This function uses a hidden iframe to fetch an authorization code from the eSTS. There are cases where this may not work:
244
+ * - Any browser using a form of Intelligent Tracking Prevention
245
+ * - If there is not an established session with the service
246
+ *
247
+ * In these cases, the request must be done inside a popup or full frame redirect.
248
+ *
249
+ * For the cases where interaction is required, you cannot send a request with prompt=none.
250
+ *
251
+ * If your refresh token has expired, you can use this function to fetch a new set of tokens silently as long as
252
+ * you session on the server still exists.
253
+ * @param request {@link SsoSilentRequest}
254
+ *
255
+ * @returns A promise that is fulfilled when this function has completed, or rejected if an error was raised.
256
+ */
257
+ ssoSilent(request) {
258
+ return this.controller.ssoSilent(request);
259
+ }
260
+ /**
261
+ * Gets the token cache for the application.
262
+ */
263
+ getTokenCache() {
264
+ return this.controller.getTokenCache();
265
+ }
266
+ /**
267
+ * Returns the logger instance
268
+ */
269
+ getLogger() {
270
+ return this.controller.getLogger();
271
+ }
272
+ /**
273
+ * Replaces the default logger set in configurations with new Logger with new configurations
274
+ * @param logger Logger instance
275
+ */
276
+ setLogger(logger) {
277
+ this.controller.setLogger(logger);
278
+ }
279
+ /**
280
+ * 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.
281
+ * @param account
282
+ */
283
+ setActiveAccount(account) {
284
+ this.controller.setActiveAccount(account);
285
+ }
286
+ /**
287
+ * Gets the currently active account
288
+ */
289
+ getActiveAccount() {
290
+ return this.controller.getActiveAccount();
291
+ }
292
+ /**
293
+ * Called by wrapper libraries (Angular & React) to set SKU and Version passed down to telemetry, logger, etc.
294
+ * @param sku
295
+ * @param version
296
+ */
297
+ initializeWrapperLibrary(sku, version) {
298
+ return this.controller.initializeWrapperLibrary(sku, version);
299
+ }
300
+ /**
301
+ * Sets navigation client
302
+ * @param navigationClient
303
+ */
304
+ setNavigationClient(navigationClient) {
305
+ this.controller.setNavigationClient(navigationClient);
306
+ }
307
+ /**
308
+ * Returns the configuration object
309
+ */
310
+ getConfiguration() {
311
+ return this.controller.getConfiguration();
312
+ }
313
313
  }
314
314
 
315
315
  export { PublicClientApplication };