Cache save/delete/lookup moved to platform specific implementation

Author: sameerag

lib/msal-browser/src/cache/BrowserStorage.ts

@@ -152,12 +152,13 @@ export class BrowserStorage implements ICacheStorage {
      * Will also clear the cookie item if storeAuthStateInCookie is set to true.
      * @param key
      */
-    removeItem(key: string): void {
+    removeItem(key: string): boolean {
         const msalKey = this.generateCacheKey(key);
         this.windowStorage.removeItem(msalKey);
         if (this.cacheConfig.storeAuthStateInCookie) {
             this.clearItemCookie(msalKey);
         }
+        return true;
     }
 
     /**
@@ -271,4 +272,33 @@ export class BrowserStorage implements ICacheStorage {
     setCache(): void {
         // sets nothing
     }
+
+    /**
+     *  Dummy implementation for interface compat - will change after BrowserCacheMigration
+     * @param key
+     * @param value
+     * @param type
+     */
+    setItemInMemory(key: string, value: object, type?: string): void {
+        if (key && value && type)
+            return;
+    }
+
+    /**
+     *  Dummy implementation for interface compat - will change after BrowserCacheMigration
+     * @param key
+     * @param type
+     */
+    getItemFromMemory(key: string, type?: string): object {
+        return key && type ? {} : {};
+    };
+
+    /**
+     * Dummy implementation for interface compat - will change after BrowserCacheMigration
+     * @param key
+     * @param type
+     */
+    removeItemFromMemory(key: string, type?: string): boolean {
+        return key && type ? true : false;
+    };
 }

lib/msal-common/src/cache/ICacheStorage.ts

@@ -29,18 +29,40 @@ export interface ICacheStorage {
      */
     setItem(key: string, value: string): void;
 
+    /**
+     * Function to set item in Memory
+     * @param key
+     * @param value
+     * @param type
+     */
+    setItemInMemory(key: string, value: object, type?: string): void;
+
     /**
      * Function which retrieves item from cache.
      * @param key
      */
     getItem(key: string): string;
 
     /**
-     * Function which removes item from cache.
+     * Function to get an item from memory
+     * @param key
+     * @param type
+     */
+    getItemFromMemory(key: string, type?: string): object;
+
+    /**
+     * Function to remove an item from cache given its key.
      * @param key
      */
     removeItem(key: string): boolean;
 
+    /**
+     * Function to remove an item from memory given its key
+     * @param key
+     * @param type
+     */
+    removeItemFromMemory(key: string, type?: string): boolean;
+
     /**
      * Function which returns boolean whether cache contains a specific key.
      * @param key

lib/msal-common/src/config/ClientConfiguration.ts

@@ -125,6 +125,10 @@ const DEFAULT_STORAGE_IMPLEMENTATION: ICacheStorage = {
         const notImplErr = "Storage interface - getItem() has not been implemented for the cacheStorage interface.";
         throw AuthError.createUnexpectedError(notImplErr);
     },
+    getItemFromMemory: (): object => {
+        const notImplErr = "Storage interface - getItemFromMemory() has not been implemented for the cacheStorage interface.";
+        throw AuthError.createUnexpectedError(notImplErr);
+    },
     getKeys: (): string[] => {
         const notImplErr = "Storage interface - getKeys() has not been implemented for the cacheStorage interface.";
         throw AuthError.createUnexpectedError(notImplErr);
@@ -133,10 +137,18 @@ const DEFAULT_STORAGE_IMPLEMENTATION: ICacheStorage = {
         const notImplErr = "Storage interface - removeItem() has not been implemented for the cacheStorage interface.";
         throw AuthError.createUnexpectedError(notImplErr);
     },
+    removeItemFromMemory: () => {
+        const notImplErr = "Storage interface - removeItemFromMemory() has not been implemented for the cacheStorage interface.";
+        throw AuthError.createUnexpectedError(notImplErr);
+    },
     setItem: () => {
         const notImplErr = "Storage interface - setItem() has not been implemented for the cacheStorage interface.";
         throw AuthError.createUnexpectedError(notImplErr);
     },
+    setItemInMemory: () => {
+        const notImplErr = "Storage interface - setItemInMemory() has not been implemented for the cacheStorage interface.";
+        throw AuthError.createUnexpectedError(notImplErr);
+    },
     getCache: (): InMemoryCache => {
         const notImplErr = "Storage interface - getCache() has not been implemented for the cacheStorage interface.";
         throw AuthError.createUnexpectedError(notImplErr);

lib/msal-common/src/index.ts

@@ -50,7 +50,7 @@ export { ClientAuthError, ClientAuthErrorMessage } from "./error/ClientAuthError
 export { ClientConfigurationError, ClientConfigurationErrorMessage } from "./error/ClientConfigurationError";
 // Constants and Utils
 export {
-    Constants, PromptValue, TemporaryCacheKeys, PersistentCacheKeys, Prompt, ResponseMode
+    Constants, PromptValue, TemporaryCacheKeys, PersistentCacheKeys, Prompt, ResponseMode, CacheSchemaType, CredentialType
 } from "./utils/Constants";
 export { StringUtils } from "./utils/StringUtils";
 export { StringDict } from "./utils/MsalTypes";