@azure/msal-browser 3.0.0-alpha.1 → 3.0.0-alpha.2

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 (142) 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 +377 -377
  14. package/dist/cache/BrowserCacheManager.js +1276 -1276
  15. package/dist/cache/BrowserStorage.d.ts +11 -11
  16. package/dist/cache/BrowserStorage.js +35 -35
  17. package/dist/cache/CryptoKeyStore.d.ts +17 -17
  18. package/dist/cache/CryptoKeyStore.js +41 -41
  19. package/dist/cache/DatabaseStorage.d.ts +56 -56
  20. package/dist/cache/DatabaseStorage.js +190 -190
  21. package/dist/cache/IAsyncMemoryStorage.d.ts +27 -27
  22. package/dist/cache/ITokenCache.d.ts +10 -10
  23. package/dist/cache/IWindowStorage.d.ts +27 -27
  24. package/dist/cache/MemoryStorage.d.ts +11 -11
  25. package/dist/cache/MemoryStorage.js +31 -31
  26. package/dist/cache/TokenCache.d.ts +76 -76
  27. package/dist/cache/TokenCache.js +225 -225
  28. package/dist/config/Configuration.d.ts +203 -203
  29. package/dist/config/Configuration.js +101 -101
  30. package/dist/controllers/ControllerFactory.d.ts +9 -9
  31. package/dist/controllers/ControllerFactory.js +37 -37
  32. package/dist/controllers/IController.d.ts +66 -66
  33. package/dist/controllers/StandardController.d.ts +413 -413
  34. package/dist/controllers/StandardController.js +1272 -1272
  35. package/dist/crypto/BrowserCrypto.d.ts +61 -61
  36. package/dist/crypto/BrowserCrypto.js +131 -131
  37. package/dist/crypto/CryptoOps.d.ts +73 -73
  38. package/dist/crypto/CryptoOps.js +150 -150
  39. package/dist/crypto/GuidGenerator.d.ts +12 -12
  40. package/dist/crypto/GuidGenerator.js +96 -96
  41. package/dist/crypto/ISubtleCrypto.d.ts +9 -9
  42. package/dist/crypto/ModernBrowserCrypto.d.ts +9 -9
  43. package/dist/crypto/ModernBrowserCrypto.js +24 -24
  44. package/dist/crypto/MsBrowserCrypto.d.ts +9 -9
  45. package/dist/crypto/MsBrowserCrypto.js +79 -79
  46. package/dist/crypto/MsrBrowserCrypto.d.ts +17 -17
  47. package/dist/crypto/MsrBrowserCrypto.js +28 -28
  48. package/dist/crypto/PkceGenerator.d.ts +24 -24
  49. package/dist/crypto/PkceGenerator.js +58 -58
  50. package/dist/crypto/SignedHttpRequest.d.ts +30 -30
  51. package/dist/crypto/SignedHttpRequest.js +39 -39
  52. package/dist/encode/Base64Decode.d.ts +22 -22
  53. package/dist/encode/Base64Decode.js +73 -73
  54. package/dist/encode/Base64Encode.d.ts +31 -31
  55. package/dist/encode/Base64Encode.js +79 -79
  56. package/dist/error/BrowserAuthError.d.ts +382 -382
  57. package/dist/error/BrowserAuthError.js +483 -483
  58. package/dist/error/BrowserConfigurationAuthError.d.ts +70 -70
  59. package/dist/error/BrowserConfigurationAuthError.js +96 -96
  60. package/dist/error/NativeAuthError.d.ts +56 -56
  61. package/dist/error/NativeAuthError.js +88 -88
  62. package/dist/event/EventHandler.d.ts +41 -41
  63. package/dist/event/EventHandler.js +119 -119
  64. package/dist/event/EventMessage.d.ts +25 -25
  65. package/dist/event/EventMessage.js +67 -67
  66. package/dist/event/EventType.d.ts +26 -26
  67. package/dist/event/EventType.js +31 -31
  68. package/dist/index.d.ts +35 -35
  69. package/dist/index.js +1 -1
  70. package/dist/interaction_client/BaseInteractionClient.d.ts +52 -52
  71. package/dist/interaction_client/BaseInteractionClient.js +138 -138
  72. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.d.ts +4 -4
  73. package/dist/interaction_client/HybridSpaAuthorizationCodeClient.js +10 -10
  74. package/dist/interaction_client/NativeInteractionClient.d.ts +148 -148
  75. package/dist/interaction_client/NativeInteractionClient.js +516 -516
  76. package/dist/interaction_client/PopupClient.d.ts +111 -111
  77. package/dist/interaction_client/PopupClient.js +476 -476
  78. package/dist/interaction_client/RedirectClient.d.ts +48 -48
  79. package/dist/interaction_client/RedirectClient.js +290 -290
  80. package/dist/interaction_client/SilentAuthCodeClient.d.ts +22 -22
  81. package/dist/interaction_client/SilentAuthCodeClient.js +62 -62
  82. package/dist/interaction_client/SilentCacheClient.d.ts +21 -21
  83. package/dist/interaction_client/SilentCacheClient.js +67 -67
  84. package/dist/interaction_client/SilentIframeClient.d.ts +31 -31
  85. package/dist/interaction_client/SilentIframeClient.js +127 -127
  86. package/dist/interaction_client/SilentRefreshClient.d.ts +19 -19
  87. package/dist/interaction_client/SilentRefreshClient.js +62 -62
  88. package/dist/interaction_client/StandardInteractionClient.d.ts +59 -59
  89. package/dist/interaction_client/StandardInteractionClient.js +259 -259
  90. package/dist/interaction_handler/InteractionHandler.d.ts +39 -39
  91. package/dist/interaction_handler/InteractionHandler.js +127 -127
  92. package/dist/interaction_handler/RedirectHandler.d.ts +24 -24
  93. package/dist/interaction_handler/RedirectHandler.js +118 -118
  94. package/dist/interaction_handler/SilentHandler.d.ts +47 -47
  95. package/dist/interaction_handler/SilentHandler.js +162 -162
  96. package/dist/internals.d.ts +23 -23
  97. package/dist/internals.js +4 -4
  98. package/dist/navigation/INavigationClient.d.ts +16 -16
  99. package/dist/navigation/NavigationClient.d.ts +22 -22
  100. package/dist/navigation/NavigationClient.js +40 -40
  101. package/dist/navigation/NavigationOptions.d.ts +12 -12
  102. package/dist/network/FetchClient.d.ts +26 -26
  103. package/dist/network/FetchClient.js +99 -99
  104. package/dist/network/XhrClient.d.ts +40 -40
  105. package/dist/network/XhrClient.js +117 -117
  106. package/dist/operatingcontext/BaseOperatingContext.d.ts +40 -40
  107. package/dist/operatingcontext/BaseOperatingContext.js +44 -44
  108. package/dist/operatingcontext/StandardOperatingContext.d.ts +25 -25
  109. package/dist/operatingcontext/StandardOperatingContext.js +43 -43
  110. package/dist/operatingcontext/TeamsAppOperatingContext.d.ts +25 -25
  111. package/dist/operatingcontext/TeamsAppOperatingContext.js +42 -42
  112. package/dist/packageMetadata.d.ts +2 -2
  113. package/dist/packageMetadata.js +4 -4
  114. package/dist/request/AuthorizationCodeRequest.d.ts +8 -8
  115. package/dist/request/AuthorizationUrlRequest.d.ts +8 -8
  116. package/dist/request/EndSessionPopupRequest.d.ts +18 -18
  117. package/dist/request/EndSessionRequest.d.ts +15 -15
  118. package/dist/request/PopupRequest.d.ts +32 -32
  119. package/dist/request/PopupWindowAttributes.d.ts +15 -15
  120. package/dist/request/RedirectRequest.d.ts +33 -33
  121. package/dist/request/SilentRequest.d.ts +30 -30
  122. package/dist/request/SsoSilentRequest.d.ts +26 -26
  123. package/dist/telemetry/BrowserPerformanceClient.d.ts +38 -38
  124. package/dist/telemetry/BrowserPerformanceClient.js +124 -124
  125. package/dist/telemetry/BrowserPerformanceMeasurement.d.ts +21 -21
  126. package/dist/telemetry/BrowserPerformanceMeasurement.js +92 -92
  127. package/dist/utils/BrowserConstants.d.ts +166 -166
  128. package/dist/utils/BrowserConstants.js +214 -214
  129. package/dist/utils/BrowserProtocolUtils.d.ts +18 -18
  130. package/dist/utils/BrowserProtocolUtils.js +34 -34
  131. package/dist/utils/BrowserStringUtils.d.ts +26 -26
  132. package/dist/utils/BrowserStringUtils.js +149 -149
  133. package/dist/utils/BrowserUtils.d.ts +65 -65
  134. package/dist/utils/BrowserUtils.js +138 -138
  135. package/dist/utils/MathUtils.d.ts +11 -11
  136. package/dist/utils/MathUtils.js +21 -21
  137. package/lib/msal-browser.cjs.js +18383 -0
  138. package/lib/msal-browser.cjs.js.map +1 -0
  139. package/lib/msal-browser.js +18389 -0
  140. package/lib/msal-browser.js.map +1 -0
  141. package/lib/msal-browser.min.js +74 -0
  142. package/package.json +97 -95
@@ -1,44 +1,44 @@
1
- import { NativeExtensionMethod } from "../../utils/BrowserConstants";
2
- import { StringDict } from "@azure/msal-common";
3
- /**
4
- * Token request which native broker will use to acquire tokens
5
- */
6
- export type NativeTokenRequest = {
7
- accountId: string;
8
- clientId: string;
9
- authority: string;
10
- redirectUri: string;
11
- scope: string;
12
- correlationId: string;
13
- windowTitleSubstring: string;
14
- prompt?: string;
15
- nonce?: string;
16
- claims?: string;
17
- state?: string;
18
- reqCnf?: string;
19
- keyId?: string;
20
- tokenType?: string;
21
- shrClaims?: string;
22
- shrNonce?: string;
23
- resourceRequestMethod?: string;
24
- resourceRequestUri?: string;
25
- extendedExpiryToken?: boolean;
26
- extraParameters?: StringDict;
27
- };
28
- /**
29
- * Request which will be forwarded to native broker by the browser extension
30
- */
31
- export type NativeExtensionRequestBody = {
32
- method: NativeExtensionMethod;
33
- request?: NativeTokenRequest;
34
- };
35
- /**
36
- * Browser extension request
37
- */
38
- export type NativeExtensionRequest = {
39
- channel: string;
40
- responseId: string;
41
- extensionId?: string;
42
- body: NativeExtensionRequestBody;
43
- };
1
+ import { NativeExtensionMethod } from "../../utils/BrowserConstants";
2
+ import { StringDict } from "@azure/msal-common";
3
+ /**
4
+ * Token request which native broker will use to acquire tokens
5
+ */
6
+ export type NativeTokenRequest = {
7
+ accountId: string;
8
+ clientId: string;
9
+ authority: string;
10
+ redirectUri: string;
11
+ scope: string;
12
+ correlationId: string;
13
+ windowTitleSubstring: string;
14
+ prompt?: string;
15
+ nonce?: string;
16
+ claims?: string;
17
+ state?: string;
18
+ reqCnf?: string;
19
+ keyId?: string;
20
+ tokenType?: string;
21
+ shrClaims?: string;
22
+ shrNonce?: string;
23
+ resourceRequestMethod?: string;
24
+ resourceRequestUri?: string;
25
+ extendedExpiryToken?: boolean;
26
+ extraParameters?: StringDict;
27
+ };
28
+ /**
29
+ * Request which will be forwarded to native broker by the browser extension
30
+ */
31
+ export type NativeExtensionRequestBody = {
32
+ method: NativeExtensionMethod;
33
+ request?: NativeTokenRequest;
34
+ };
35
+ /**
36
+ * Browser extension request
37
+ */
38
+ export type NativeExtensionRequest = {
39
+ channel: string;
40
+ responseId: string;
41
+ extensionId?: string;
42
+ body: NativeExtensionRequestBody;
43
+ };
44
44
  //# sourceMappingURL=NativeRequest.d.ts.map
@@ -1,49 +1,49 @@
1
- /**
2
- * Account properties returned by Native Platform e.g. WAM
3
- */
4
- export type NativeAccountInfo = {
5
- id: string;
6
- properties: object;
7
- userName: string;
8
- };
9
- /**
10
- * Token response returned by Native Platform e.g. WAM
11
- */
12
- export type NativeResponse = {
13
- access_token: string;
14
- account: NativeAccountInfo;
15
- client_info: string;
16
- expires_in: number;
17
- id_token: string;
18
- properties: NativeResponseProperties;
19
- scope: string;
20
- state: string;
21
- shr?: string;
22
- extendedLifetimeToken?: boolean;
23
- };
24
- /**
25
- * Properties returned under "properties" of the NativeResponse
26
- */
27
- export type NativeResponseProperties = {
28
- MATS?: string;
29
- };
30
- /**
31
- * The native token broker can optionally include additional information about operations it performs. If that data is returned, MSAL.js will include the following properties in the telemetry it collects.
32
- */
33
- export type MATS = {
34
- is_cached?: number;
35
- broker_version?: string;
36
- account_join_on_start?: string;
37
- account_join_on_end?: string;
38
- device_join?: string;
39
- prompt_behavior?: string;
40
- api_error_code?: number;
41
- ui_visible?: boolean;
42
- silent_code?: number;
43
- silent_bi_sub_code?: number;
44
- silent_message?: string;
45
- silent_status?: number;
46
- http_status?: number;
47
- http_event_count?: number;
48
- };
1
+ /**
2
+ * Account properties returned by Native Platform e.g. WAM
3
+ */
4
+ export type NativeAccountInfo = {
5
+ id: string;
6
+ properties: object;
7
+ userName: string;
8
+ };
9
+ /**
10
+ * Token response returned by Native Platform e.g. WAM
11
+ */
12
+ export type NativeResponse = {
13
+ access_token: string;
14
+ account: NativeAccountInfo;
15
+ client_info: string;
16
+ expires_in: number;
17
+ id_token: string;
18
+ properties: NativeResponseProperties;
19
+ scope: string;
20
+ state: string;
21
+ shr?: string;
22
+ extendedLifetimeToken?: boolean;
23
+ };
24
+ /**
25
+ * Properties returned under "properties" of the NativeResponse
26
+ */
27
+ export type NativeResponseProperties = {
28
+ MATS?: string;
29
+ };
30
+ /**
31
+ * The native token broker can optionally include additional information about operations it performs. If that data is returned, MSAL.js will include the following properties in the telemetry it collects.
32
+ */
33
+ export type MATS = {
34
+ is_cached?: number;
35
+ broker_version?: string;
36
+ account_join_on_start?: string;
37
+ account_join_on_end?: string;
38
+ device_join?: string;
39
+ prompt_behavior?: string;
40
+ api_error_code?: number;
41
+ ui_visible?: boolean;
42
+ silent_code?: number;
43
+ silent_bi_sub_code?: number;
44
+ silent_message?: string;
45
+ silent_status?: number;
46
+ http_status?: number;
47
+ http_event_count?: number;
48
+ };
49
49
  //# sourceMappingURL=NativeResponse.d.ts.map
@@ -1,52 +1,52 @@
1
- import { Logger } from "@azure/msal-common";
2
- import { IAsyncStorage } from "./IAsyncMemoryStorage";
3
- /**
4
- * This class allows MSAL to store artifacts asynchronously using the DatabaseStorage IndexedDB wrapper,
5
- * backed up with the more volatile MemoryStorage object for cases in which IndexedDB may be unavailable.
6
- */
7
- export declare class AsyncMemoryStorage<T> implements IAsyncStorage<T> {
8
- private inMemoryCache;
9
- private indexedDBCache;
10
- private logger;
11
- private storeName;
12
- constructor(logger: Logger, storeName: string);
13
- private handleDatabaseAccessError;
14
- /**
15
- * Get the item matching the given key. Tries in-memory cache first, then in the asynchronous
16
- * storage object if item isn't found in-memory.
17
- * @param key
18
- */
19
- getItem(key: string): Promise<T | null>;
20
- /**
21
- * Sets the item in the in-memory cache and then tries to set it in the asynchronous
22
- * storage object with the given key.
23
- * @param key
24
- * @param value
25
- */
26
- setItem(key: string, value: T): Promise<void>;
27
- /**
28
- * Removes the item matching the key from the in-memory cache, then tries to remove it from the asynchronous storage object.
29
- * @param key
30
- */
31
- removeItem(key: string): Promise<void>;
32
- /**
33
- * Get all the keys from the in-memory cache as an iterable array of strings. If no keys are found, query the keys in the
34
- * asynchronous storage object.
35
- */
36
- getKeys(): Promise<string[]>;
37
- /**
38
- * Returns true or false if the given key is present in the cache.
39
- * @param key
40
- */
41
- containsKey(key: string): Promise<boolean>;
42
- /**
43
- * Clears in-memory Map
44
- */
45
- clearInMemory(): void;
46
- /**
47
- * Tries to delete the IndexedDB database
48
- * @returns
49
- */
50
- clearPersistent(): Promise<boolean>;
51
- }
1
+ import { Logger } from "@azure/msal-common";
2
+ import { IAsyncStorage } from "./IAsyncMemoryStorage";
3
+ /**
4
+ * This class allows MSAL to store artifacts asynchronously using the DatabaseStorage IndexedDB wrapper,
5
+ * backed up with the more volatile MemoryStorage object for cases in which IndexedDB may be unavailable.
6
+ */
7
+ export declare class AsyncMemoryStorage<T> implements IAsyncStorage<T> {
8
+ private inMemoryCache;
9
+ private indexedDBCache;
10
+ private logger;
11
+ private storeName;
12
+ constructor(logger: Logger, storeName: string);
13
+ private handleDatabaseAccessError;
14
+ /**
15
+ * Get the item matching the given key. Tries in-memory cache first, then in the asynchronous
16
+ * storage object if item isn't found in-memory.
17
+ * @param key
18
+ */
19
+ getItem(key: string): Promise<T | null>;
20
+ /**
21
+ * Sets the item in the in-memory cache and then tries to set it in the asynchronous
22
+ * storage object with the given key.
23
+ * @param key
24
+ * @param value
25
+ */
26
+ setItem(key: string, value: T): Promise<void>;
27
+ /**
28
+ * Removes the item matching the key from the in-memory cache, then tries to remove it from the asynchronous storage object.
29
+ * @param key
30
+ */
31
+ removeItem(key: string): Promise<void>;
32
+ /**
33
+ * Get all the keys from the in-memory cache as an iterable array of strings. If no keys are found, query the keys in the
34
+ * asynchronous storage object.
35
+ */
36
+ getKeys(): Promise<string[]>;
37
+ /**
38
+ * Returns true or false if the given key is present in the cache.
39
+ * @param key
40
+ */
41
+ containsKey(key: string): Promise<boolean>;
42
+ /**
43
+ * Clears in-memory Map
44
+ */
45
+ clearInMemory(): void;
46
+ /**
47
+ * Tries to delete the IndexedDB database
48
+ * @returns
49
+ */
50
+ clearPersistent(): Promise<boolean>;
51
+ }
52
52
  //# sourceMappingURL=AsyncMemoryStorage.d.ts.map
@@ -1,140 +1,140 @@
1
- /*! @azure/msal-browser v3.0.0-alpha.1 2023-05-08 */
1
+ /*! @azure/msal-browser v3.0.0-alpha.2 2023-05-17 */
2
2
  'use strict';
3
3
  import { BrowserAuthError, BrowserAuthErrorMessage } from '../error/BrowserAuthError.js';
4
4
  import { DatabaseStorage } from './DatabaseStorage.js';
5
5
  import { MemoryStorage } from './MemoryStorage.js';
6
6
 
7
- /*
8
- * Copyright (c) Microsoft Corporation. All rights reserved.
9
- * Licensed under the MIT License.
10
- */
11
- /**
12
- * This class allows MSAL to store artifacts asynchronously using the DatabaseStorage IndexedDB wrapper,
13
- * backed up with the more volatile MemoryStorage object for cases in which IndexedDB may be unavailable.
14
- */
15
- class AsyncMemoryStorage {
16
- constructor(logger, storeName) {
17
- this.inMemoryCache = new MemoryStorage();
18
- this.indexedDBCache = new DatabaseStorage();
19
- this.logger = logger;
20
- this.storeName = storeName;
21
- }
22
- handleDatabaseAccessError(error) {
23
- if (error instanceof BrowserAuthError &&
24
- error.errorCode === BrowserAuthErrorMessage.databaseUnavailable.code) {
25
- this.logger.error("Could not access persistent storage. This may be caused by browser privacy features which block persistent storage in third-party contexts.");
26
- }
27
- else {
28
- throw error;
29
- }
30
- }
31
- /**
32
- * Get the item matching the given key. Tries in-memory cache first, then in the asynchronous
33
- * storage object if item isn't found in-memory.
34
- * @param key
35
- */
36
- async getItem(key) {
37
- const item = this.inMemoryCache.getItem(key);
38
- if (!item) {
39
- try {
40
- this.logger.verbose("Queried item not found in in-memory cache, now querying persistent storage.");
41
- return await this.indexedDBCache.getItem(key);
42
- }
43
- catch (e) {
44
- this.handleDatabaseAccessError(e);
45
- }
46
- }
47
- return item;
48
- }
49
- /**
50
- * Sets the item in the in-memory cache and then tries to set it in the asynchronous
51
- * storage object with the given key.
52
- * @param key
53
- * @param value
54
- */
55
- async setItem(key, value) {
56
- this.inMemoryCache.setItem(key, value);
57
- try {
58
- await this.indexedDBCache.setItem(key, value);
59
- }
60
- catch (e) {
61
- this.handleDatabaseAccessError(e);
62
- }
63
- }
64
- /**
65
- * Removes the item matching the key from the in-memory cache, then tries to remove it from the asynchronous storage object.
66
- * @param key
67
- */
68
- async removeItem(key) {
69
- this.inMemoryCache.removeItem(key);
70
- try {
71
- await this.indexedDBCache.removeItem(key);
72
- }
73
- catch (e) {
74
- this.handleDatabaseAccessError(e);
75
- }
76
- }
77
- /**
78
- * Get all the keys from the in-memory cache as an iterable array of strings. If no keys are found, query the keys in the
79
- * asynchronous storage object.
80
- */
81
- async getKeys() {
82
- const cacheKeys = this.inMemoryCache.getKeys();
83
- if (cacheKeys.length === 0) {
84
- try {
85
- this.logger.verbose("In-memory cache is empty, now querying persistent storage.");
86
- return await this.indexedDBCache.getKeys();
87
- }
88
- catch (e) {
89
- this.handleDatabaseAccessError(e);
90
- }
91
- }
92
- return cacheKeys;
93
- }
94
- /**
95
- * Returns true or false if the given key is present in the cache.
96
- * @param key
97
- */
98
- async containsKey(key) {
99
- const containsKey = this.inMemoryCache.containsKey(key);
100
- if (!containsKey) {
101
- try {
102
- this.logger.verbose("Key not found in in-memory cache, now querying persistent storage.");
103
- return await this.indexedDBCache.containsKey(key);
104
- }
105
- catch (e) {
106
- this.handleDatabaseAccessError(e);
107
- }
108
- }
109
- return containsKey;
110
- }
111
- /**
112
- * Clears in-memory Map
113
- */
114
- clearInMemory() {
115
- // InMemory cache is a Map instance, clear is straightforward
116
- this.logger.verbose(`Deleting in-memory keystore ${this.storeName}`);
117
- this.inMemoryCache.clear();
118
- this.logger.verbose(`In-memory keystore ${this.storeName} deleted`);
119
- }
120
- /**
121
- * Tries to delete the IndexedDB database
122
- * @returns
123
- */
124
- async clearPersistent() {
125
- try {
126
- this.logger.verbose("Deleting persistent keystore");
127
- const dbDeleted = await this.indexedDBCache.deleteDatabase();
128
- if (dbDeleted) {
129
- this.logger.verbose("Persistent keystore deleted");
130
- }
131
- return dbDeleted;
132
- }
133
- catch (e) {
134
- this.handleDatabaseAccessError(e);
135
- return false;
136
- }
137
- }
7
+ /*
8
+ * Copyright (c) Microsoft Corporation. All rights reserved.
9
+ * Licensed under the MIT License.
10
+ */
11
+ /**
12
+ * This class allows MSAL to store artifacts asynchronously using the DatabaseStorage IndexedDB wrapper,
13
+ * backed up with the more volatile MemoryStorage object for cases in which IndexedDB may be unavailable.
14
+ */
15
+ class AsyncMemoryStorage {
16
+ constructor(logger, storeName) {
17
+ this.inMemoryCache = new MemoryStorage();
18
+ this.indexedDBCache = new DatabaseStorage();
19
+ this.logger = logger;
20
+ this.storeName = storeName;
21
+ }
22
+ handleDatabaseAccessError(error) {
23
+ if (error instanceof BrowserAuthError &&
24
+ error.errorCode === BrowserAuthErrorMessage.databaseUnavailable.code) {
25
+ this.logger.error("Could not access persistent storage. This may be caused by browser privacy features which block persistent storage in third-party contexts.");
26
+ }
27
+ else {
28
+ throw error;
29
+ }
30
+ }
31
+ /**
32
+ * Get the item matching the given key. Tries in-memory cache first, then in the asynchronous
33
+ * storage object if item isn't found in-memory.
34
+ * @param key
35
+ */
36
+ async getItem(key) {
37
+ const item = this.inMemoryCache.getItem(key);
38
+ if (!item) {
39
+ try {
40
+ this.logger.verbose("Queried item not found in in-memory cache, now querying persistent storage.");
41
+ return await this.indexedDBCache.getItem(key);
42
+ }
43
+ catch (e) {
44
+ this.handleDatabaseAccessError(e);
45
+ }
46
+ }
47
+ return item;
48
+ }
49
+ /**
50
+ * Sets the item in the in-memory cache and then tries to set it in the asynchronous
51
+ * storage object with the given key.
52
+ * @param key
53
+ * @param value
54
+ */
55
+ async setItem(key, value) {
56
+ this.inMemoryCache.setItem(key, value);
57
+ try {
58
+ await this.indexedDBCache.setItem(key, value);
59
+ }
60
+ catch (e) {
61
+ this.handleDatabaseAccessError(e);
62
+ }
63
+ }
64
+ /**
65
+ * Removes the item matching the key from the in-memory cache, then tries to remove it from the asynchronous storage object.
66
+ * @param key
67
+ */
68
+ async removeItem(key) {
69
+ this.inMemoryCache.removeItem(key);
70
+ try {
71
+ await this.indexedDBCache.removeItem(key);
72
+ }
73
+ catch (e) {
74
+ this.handleDatabaseAccessError(e);
75
+ }
76
+ }
77
+ /**
78
+ * Get all the keys from the in-memory cache as an iterable array of strings. If no keys are found, query the keys in the
79
+ * asynchronous storage object.
80
+ */
81
+ async getKeys() {
82
+ const cacheKeys = this.inMemoryCache.getKeys();
83
+ if (cacheKeys.length === 0) {
84
+ try {
85
+ this.logger.verbose("In-memory cache is empty, now querying persistent storage.");
86
+ return await this.indexedDBCache.getKeys();
87
+ }
88
+ catch (e) {
89
+ this.handleDatabaseAccessError(e);
90
+ }
91
+ }
92
+ return cacheKeys;
93
+ }
94
+ /**
95
+ * Returns true or false if the given key is present in the cache.
96
+ * @param key
97
+ */
98
+ async containsKey(key) {
99
+ const containsKey = this.inMemoryCache.containsKey(key);
100
+ if (!containsKey) {
101
+ try {
102
+ this.logger.verbose("Key not found in in-memory cache, now querying persistent storage.");
103
+ return await this.indexedDBCache.containsKey(key);
104
+ }
105
+ catch (e) {
106
+ this.handleDatabaseAccessError(e);
107
+ }
108
+ }
109
+ return containsKey;
110
+ }
111
+ /**
112
+ * Clears in-memory Map
113
+ */
114
+ clearInMemory() {
115
+ // InMemory cache is a Map instance, clear is straightforward
116
+ this.logger.verbose(`Deleting in-memory keystore ${this.storeName}`);
117
+ this.inMemoryCache.clear();
118
+ this.logger.verbose(`In-memory keystore ${this.storeName} deleted`);
119
+ }
120
+ /**
121
+ * Tries to delete the IndexedDB database
122
+ * @returns
123
+ */
124
+ async clearPersistent() {
125
+ try {
126
+ this.logger.verbose("Deleting persistent keystore");
127
+ const dbDeleted = await this.indexedDBCache.deleteDatabase();
128
+ if (dbDeleted) {
129
+ this.logger.verbose("Persistent keystore deleted");
130
+ }
131
+ return dbDeleted;
132
+ }
133
+ catch (e) {
134
+ this.handleDatabaseAccessError(e);
135
+ return false;
136
+ }
137
+ }
138
138
  }
139
139
 
140
140
  export { AsyncMemoryStorage };