jest-webextension-mock 3.8.15 → 3.9.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # jest-webextension-mock
 
+## 3.9.0
+
+### Minor Changes
+
+- Add support for storage.session
+
+## 3.8.16
+
+### Patch Changes
+
+- Fix storage.get method throwing when not provided with a key
+
 ## 3.8.15
 
 ### Patch Changes

package/__tests__/storage.test.js

@@ -11,7 +11,7 @@ describe('browser.storage', () => {
 });
 
 describe('browser.storage', () => {
-  ['sync', 'local', 'managed'].forEach((type) => {
+  ['sync', 'local', 'managed', 'session'].forEach((type) => {
     describe(type, () => {
       const storage = browser.storage[type];
       describe('get', () => {
@@ -55,6 +55,9 @@ describe('browser.storage', () => {
             expect(e.message).toBe('Wrong key given');
           }
         });
+        test('an undefined key', () => {
+          return expect(storage.get()).resolves.toEqual({});
+        });
         afterEach(() => {
           expect(storage.get).toHaveBeenCalledTimes(1);
           storage.clear();

package/dist/setup.js

@@ -283,7 +283,7 @@ function resolveKey(key, store) {
 var storage = {
   sync: {
     get: jest.fn(function (id, cb) {
-      var result = id === null ? syncStore : resolveKey(id, syncStore);
+      var result = id === null || id === undefined ? syncStore : resolveKey(id, syncStore);
       if (cb !== undefined) {
         return cb(result);
       }
@@ -325,7 +325,49 @@ var storage = {
   },
   local: {
     get: jest.fn(function (id, cb) {
-      var result = id === null ? localStore : resolveKey(id, localStore);
+      var result = id === null || id === undefined ? localStore : resolveKey(id, localStore);
+      if (cb !== undefined) {
+        return cb(result);
+      }
+      return Promise.resolve(result);
+    }),
+    getBytesInUse: jest.fn(function (id, cb) {
+      if (cb !== undefined) {
+        return cb(0);
+      }
+      return Promise.resolve(0);
+    }),
+    set: jest.fn(function (payload, cb) {
+      Object.keys(payload).forEach(function (key) {
+        return localStore[key] = payload[key];
+      });
+      if (cb !== undefined) {
+        return cb();
+      }
+      return Promise.resolve();
+    }),
+    remove: jest.fn(function (id, cb) {
+      var keys = typeof id === 'string' ? [id] : id;
+      keys.forEach(function (key) {
+        return delete localStore[key];
+      });
+      if (cb !== undefined) {
+        return cb();
+      }
+      return Promise.resolve();
+    }),
+    clear: jest.fn(function (cb) {
+      localStore = {};
+      if (cb !== undefined) {
+        return cb();
+      }
+      return Promise.resolve();
+    }),
+    onChanged: createEventListeners()
+  },
+  session: {
+    get: jest.fn(function (id, cb) {
+      var result = id === null || id === undefined ? localStore : resolveKey(id, localStore);
       if (cb !== undefined) {
         return cb(result);
       }
@@ -367,7 +409,7 @@ var storage = {
   },
   managed: {
     get: jest.fn(function (id, cb) {
-      var result = id === null ? managedStore : resolveKey(id, managedStore);
+      var result = id === null || id === undefined ? managedStore : resolveKey(id, managedStore);
       if (cb !== undefined) {
         return cb(result);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-webextension-mock",
-  "version": "3.8.15",
+  "version": "3.9.0",
   "description": "Mock the components of a WebExtension",
   "main": "dist/setup.js",
   "module": "src/setup.js",

package/src/storage.js

@@ -3,6 +3,7 @@ import { createEventListeners } from './createEventListeners';
 let syncStore = {};
 let localStore = {};
 let managedStore = {};
+let sessionStore = {};
 
 function resolveKey(key, store) {
   if (typeof key === 'string') {
@@ -26,7 +27,8 @@ function resolveKey(key, store) {
 export const storage = {
   sync: {
     get: jest.fn((id, cb) => {
-      const result = id === null ? syncStore : resolveKey(id, syncStore);
+      const result =
+        id === null || id === undefined ? syncStore : resolveKey(id, syncStore);
       if (cb !== undefined) {
         return cb(result);
       }
@@ -64,7 +66,51 @@ export const storage = {
   },
   local: {
     get: jest.fn((id, cb) => {
-      const result = id === null ? localStore : resolveKey(id, localStore);
+      const result =
+        id === null || id === undefined
+          ? localStore
+          : resolveKey(id, localStore);
+      if (cb !== undefined) {
+        return cb(result);
+      }
+      return Promise.resolve(result);
+    }),
+    getBytesInUse: jest.fn((id, cb) => {
+      if (cb !== undefined) {
+        return cb(0);
+      }
+      return Promise.resolve(0);
+    }),
+    set: jest.fn((payload, cb) => {
+      Object.keys(payload).forEach((key) => (localStore[key] = payload[key]));
+      if (cb !== undefined) {
+        return cb();
+      }
+      return Promise.resolve();
+    }),
+    remove: jest.fn((id, cb) => {
+      const keys = typeof id === 'string' ? [id] : id;
+      keys.forEach((key) => delete localStore[key]);
+      if (cb !== undefined) {
+        return cb();
+      }
+      return Promise.resolve();
+    }),
+    clear: jest.fn((cb) => {
+      localStore = {};
+      if (cb !== undefined) {
+        return cb();
+      }
+      return Promise.resolve();
+    }),
+    onChanged: createEventListeners(),
+  },
+  session: {
+    get: jest.fn((id, cb) => {
+      const result =
+        id === null || id === undefined
+          ? localStore
+          : resolveKey(id, localStore);
       if (cb !== undefined) {
         return cb(result);
       }
@@ -102,7 +148,10 @@ export const storage = {
   },
   managed: {
     get: jest.fn((id, cb) => {
-      const result = id === null ? managedStore : resolveKey(id, managedStore);
+      const result =
+        id === null || id === undefined
+          ? managedStore
+          : resolveKey(id, managedStore);
       if (cb !== undefined) {
         return cb(result);
       }