Merge branch 'inlocalstorage_storageAdapter' into inlocalstorage_sessionStorage

Author: EmilianoSanchez

src/storages/inLocalStorage/__tests__/wrapper.mock.ts

@@ -4,7 +4,7 @@ import { loggerMock } from '../../../logger/__tests__/sdkLogger.mock';
 
 export const PREFIX = 'SPLITIO';
 
-export function createMemoryStorage(): SplitIO.AsyncStorageWrapper {
+export function createMemoryStorage(): SplitIO.StorageWrapper {
   let cache: Record<string, string> = {};
   return {
     getItem(key: string) {

src/storages/inLocalStorage/index.ts

@@ -19,7 +19,7 @@ import { ILogger } from '../../logger/types';
 import SplitIO from '../../../types/splitio';
 import { storageAdapter } from './storageAdapter';
 
-function validateStorage(log: ILogger, prefix: string, wrapper?: SplitIO.SyncStorageWrapper | SplitIO.AsyncStorageWrapper): StorageAdapter | undefined {
+function validateStorage(log: ILogger, prefix: string, wrapper?: SplitIO.StorageWrapper): StorageAdapter | undefined {
   if (wrapper) {
     if (isValidStorageWrapper(wrapper)) {
       return isWebStorage(wrapper) ?

src/storages/inLocalStorage/storageAdapter.ts

@@ -4,7 +4,7 @@ import { LOG_PREFIX } from './constants';
 import { StorageAdapter } from '../types';
 
 
-export function storageAdapter(log: ILogger, prefix: string, wrapper: SplitIO.SyncStorageWrapper | SplitIO.AsyncStorageWrapper): Required<StorageAdapter> {
+export function storageAdapter(log: ILogger, prefix: string, wrapper: SplitIO.StorageWrapper): Required<StorageAdapter> {
   let keys: string[] = [];
   let cache: Record<string, string> = {};
 

src/utils/env/isLocalStorageAvailable.ts

@@ -1,22 +1,21 @@
+/* eslint-disable no-undef */
 export function isLocalStorageAvailable(): boolean {
+  var mod = '__SPLITSOFTWARE__';
   try {
-    // eslint-disable-next-line no-undef
-    return isValidStorageWrapper(localStorage);
+    localStorage.setItem(mod, mod);
+    localStorage.removeItem(mod);
+    return true;
   } catch (e) {
     return false;
   }
 }
 
 export function isValidStorageWrapper(wrapper: any): boolean {
-  var mod = '__SPLITSOFTWARE__';
-  try {
-    wrapper.setItem(mod, mod);
-    wrapper.getItem(mod);
-    wrapper.removeItem(mod);
-    return true;
-  } catch (e) {
-    return false;
-  }
+  return wrapper !== null &&
+    typeof wrapper === 'object' &&
+    typeof wrapper.setItem === 'function' &&
+    typeof wrapper.getItem === 'function' &&
+    typeof wrapper.removeItem === 'function';
 }
 
 export function isWebStorage(wrapper: any): boolean {

types/splitio.d.ts

@@ -463,34 +463,22 @@ interface IClientSideSyncSharedSettings extends IClientSideSharedSettings, ISync
  */
 declare namespace SplitIO {
 
-  interface SyncStorageWrapper {
+  interface StorageWrapper {
     /**
      * Returns the value associated with the given key, or null if the key does not exist.
+     * If the operation is asynchronous, returns a Promise.
      */
-    getItem(key: string): string | null;
+    getItem(key: string): string | null | Promise<string | null>;
     /**
      * Sets the value for the given key, creating a new key/value pair if key does not exist.
+     * If the operation is asynchronous, returns a Promise.
      */
-    setItem(key: string, value: string): void;
+    setItem(key: string, value: string): void | Promise<void>;
     /**
      * Removes the key/value pair for the given key, if the key exists.
+     * If the operation is asynchronous, returns a Promise.
      */
-    removeItem(key: string): void;
-  }
-
-  interface AsyncStorageWrapper {
-    /**
-     * Returns a promise that resolves to the value associated with the given key, or null if the key does not exist.
-     */
-    getItem(key: string): Promise<string | null>;
-    /**
-     * Returns a promise that resolves when the value of the pair identified by key is set to value, creating a new key/value pair if key does not exist.
-     */
-    setItem(key: string, value: string): Promise<void>;
-    /**
-     * Returns a promise that resolves when the key/value pair for the given key is removed, if the key exists.
-     */
-    removeItem(key: string): Promise<void>;
+    removeItem(key: string): void | Promise<void>;
   }
 
   /**
@@ -1013,7 +1001,7 @@ declare namespace SplitIO {
      *
      * @defaultValue `window.localStorage`
      */
-    wrapper?: SyncStorageWrapper | AsyncStorageWrapper;
+    wrapper?: StorageWrapper;
   }
   /**
    * Storage for asynchronous (consumer) SDK.
@@ -1380,7 +1368,7 @@ declare namespace SplitIO {
        *
        * @defaultValue `window.localStorage`
        */
-      wrapper?: SyncStorageWrapper | AsyncStorageWrapper;
+      wrapper?: StorageWrapper;
     };
   }
   /**