jest-webextension-mock 3.8.9 → 3.8.11

package/README.md

@@ -1,5 +1,7 @@
 [![npm](https://img.shields.io/npm/v/jest-webextension-mock.svg)](https://www.npmjs.com/package/jest-webextension-mock) [![npm](https://img.shields.io/npm/l/jest-webextension-mock.svg)](https://github.com/clarkbw/jest-webextension-mock/blob/master/LICENSE) [![Codecov](https://img.shields.io/codecov/c/github/clarkbw/jest-webextension-mock.svg)](https://codecov.io/gh/clarkbw/jest-webextension-mock) [![Greenkeeper badge](https://badges.greenkeeper.io/clarkbw/jest-webextension-mock.svg)](https://greenkeeper.io/) [![Twitter](https://img.shields.io/twitter/url/https/github.com/clarkbw/jest-webextension-mock.svg?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=%5Bobject%20Object%5D)
 
+💪 @RickyMarou is an official maintainer. This change was made on `2024-04-12` as @clarkbw has not been able to devote sufficient time necessary for this project.
+
 ## Install
 
 For npm:

package/__tests__/permissions.test.js

@@ -0,0 +1,39 @@
+test('chrome.permissions.contains', () => {
+  expect(jest.isMockFunction(chrome.permissions.contains)).toBe(true);
+  chrome.permissions.contains({ permissions: ['tabs'] }, () => {});
+  expect(chrome.permissions.contains).toBeCalled();
+});
+
+test('chrome.permissions.getAll', () => {
+  expect(jest.isMockFunction(chrome.permissions.getAll)).toBe(true);
+  chrome.permissions.getAll(() => {});
+  expect(chrome.permissions.getAll).toBeCalled();
+});
+
+test('chrome.permissions.remove', () => {
+  expect(jest.isMockFunction(chrome.permissions.remove)).toBe(true);
+  chrome.permissions.remove({ permissions: ['tabs'] }, () => {});
+  expect(chrome.permissions.remove).toBeCalled();
+});
+
+test('chrome.permissions.request', () => {
+  expect(jest.isMockFunction(chrome.permissions.request)).toBe(true);
+  chrome.permissions.request({ permissions: ['tabs'] }, () => {});
+  expect(chrome.permissions.request).toBeCalled();
+});
+
+test('chrome.permissions.onAdded.addListener', () => {
+  expect(jest.isMockFunction(chrome.permissions.onAdded.addListener)).toBe(
+    true
+  );
+  chrome.permissions.onAdded.addListener(() => {});
+  expect(chrome.permissions.onAdded.addListener).toBeCalled();
+});
+
+test('chrome.permissions.onRemoved.addListener', () => {
+  expect(jest.isMockFunction(chrome.permissions.onRemoved.addListener)).toBe(
+    true
+  );
+  chrome.permissions.onRemoved.addListener(() => {});
+  expect(chrome.permissions.onRemoved.addListener).toBeCalled();
+});

package/dist/setup.js

@@ -2,17 +2,14 @@
 
 function ownKeys(object, enumerableOnly) {
   var keys = Object.keys(object);
-
   if (Object.getOwnPropertySymbols) {
     var symbols = Object.getOwnPropertySymbols(object);
     enumerableOnly && (symbols = symbols.filter(function (sym) {
       return Object.getOwnPropertyDescriptor(object, sym).enumerable;
     })), keys.push.apply(keys, symbols);
   }
-
   return keys;
 }
-
 function _objectSpread2(target) {
   for (var i = 1; i < arguments.length; i++) {
     var source = null != arguments[i] ? arguments[i] : {};
@@ -22,10 +19,8 @@ function _objectSpread2(target) {
       Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
     });
   }
-
   return target;
 }
-
 function _typeof(obj) {
   "@babel/helpers - typeof";
 
@@ -35,7 +30,6 @@ function _typeof(obj) {
     return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
   }, _typeof(obj);
 }
-
 function _defineProperty(obj, key, value) {
   if (key in obj) {
     Object.defineProperty(obj, key, {
@@ -47,11 +41,11 @@ function _defineProperty(obj, key, value) {
   } else {
     obj[key] = value;
   }
-
   return obj;
 }
 
 // https://developer.chrome.com/extensions/omnibox
+
 var omnibox = {
   setDefaultSuggestion: jest.fn(),
   onInputStarted: {
@@ -91,11 +85,9 @@ var runtime = {
     onMessageListeners.forEach(function (listener) {
       return listener(message);
     });
-
     if (cb !== undefined) {
       return cb();
     }
-
     return Promise.resolve();
   }),
   onMessage: {
@@ -167,25 +159,22 @@ var tabs = {
       onMessage: {
         addListener: jest.fn()
       },
-      postMessage: jest.fn() // TODO: add sender
-
+      postMessage: jest.fn()
+      // TODO: add sender
     };
   }),
   create: jest.fn(function () {
     var props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     var cb = arguments.length > 1 ? arguments[1] : undefined;
-
     if (cb !== undefined) {
       return cb(props);
     }
-
     return Promise.resolve(props);
   }),
   remove: jest.fn(function (tabIds, cb) {
     if (cb !== undefined) {
       return cb();
     }
-
     return Promise.resolve();
   }),
   duplicate: jest.fn(function () {
@@ -230,11 +219,9 @@ var tabs = {
     onMessageListeners.forEach(function (listener) {
       return listener(tabId, message);
     });
-
     if (cb !== undefined) {
       return cb();
     }
-
     return Promise.resolve();
   }),
   reload: jest.fn(function (tabId, reloadProperties, cb) {
@@ -243,7 +230,6 @@ var tabs = {
 };
 
 var store = {};
-
 function resolveKey(key) {
   if (typeof key === 'string') {
     var result = {};
@@ -260,37 +246,30 @@ function resolveKey(key) {
       return acc;
     }, {});
   }
-
   throw new Error('Wrong key given');
 }
-
 var storage = {
   sync: {
     get: jest.fn(function (id, cb) {
       var result = id === null ? store : resolveKey(id);
-
       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 store[key] = payload[key];
       });
-
       if (cb !== undefined) {
         return cb();
       }
-
       return Promise.resolve();
     }),
     remove: jest.fn(function (id, cb) {
@@ -298,49 +277,40 @@ var storage = {
       keys.forEach(function (key) {
         return delete store[key];
       });
-
       if (cb !== undefined) {
         return cb();
       }
-
       return Promise.resolve();
     }),
     clear: jest.fn(function (cb) {
       store = {};
-
       if (cb !== undefined) {
         return cb();
       }
-
       return Promise.resolve();
     })
   },
   local: {
     get: jest.fn(function (id, cb) {
       var result = id === null ? store : resolveKey(id);
-
       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 store[key] = payload[key];
       });
-
       if (cb !== undefined) {
         return cb();
       }
-
       return Promise.resolve();
     }),
     remove: jest.fn(function (id, cb) {
@@ -348,49 +318,40 @@ var storage = {
       keys.forEach(function (key) {
         return delete store[key];
       });
-
       if (cb !== undefined) {
         return cb();
       }
-
       return Promise.resolve();
     }),
     clear: jest.fn(function (cb) {
       store = {};
-
       if (cb !== undefined) {
         return cb();
       }
-
       return Promise.resolve();
     })
   },
   managed: {
     get: jest.fn(function (id, cb) {
       var result = id === null ? store : resolveKey(id);
-
       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 store[key] = payload[key];
       });
-
       if (cb !== undefined) {
         return cb();
       }
-
       return Promise.resolve();
     }),
     remove: jest.fn(function (id, cb) {
@@ -398,20 +359,16 @@ var storage = {
       keys.forEach(function (key) {
         return delete store[key];
       });
-
       if (cb !== undefined) {
         return cb();
       }
-
       return Promise.resolve();
     }),
     clear: jest.fn(function (cb) {
       store = {};
-
       if (cb !== undefined) {
         return cb();
       }
-
       return Promise.resolve();
     })
   },
@@ -426,10 +383,8 @@ var getDetails = function getDetails(details, cb) {
   if (cb !== undefined) {
     return cb();
   }
-
   return Promise.resolve();
 };
-
 var browserAction = {
   setTitle: jest.fn(),
   getTitle: jest.fn(getDetails),
@@ -448,12 +403,12 @@ var browserAction = {
 };
 
 // https://developer.chrome.com/extensions/commands
+
 var commands = {
   getAll: jest.fn(function (cb) {
     if (cb !== undefined) {
       return cb();
     }
-
     return Promise.resolve();
   }),
   onCommand: {
@@ -465,22 +420,17 @@ var cbOrPromise$1 = function cbOrPromise(cb, value) {
   if (cb !== undefined) {
     return cb(value);
   }
-
   return Promise.resolve(value);
 };
-
 var create = function create(notificationId, options, cb) {
   if (typeof notificationId !== 'string') {
     notificationId = 'generated-id';
   }
-
   if (typeof options === 'function') {
     cb = options;
   }
-
   return cbOrPromise$1(cb, notificationId);
 };
-
 var notifications = {
   create: jest.fn(create),
   update: jest.fn(function (notificationId, options, cb) {
@@ -540,10 +490,8 @@ var cbOrPromise = function cbOrPromise(cb, value) {
   if (cb !== undefined) {
     return cb(value);
   }
-
   return Promise.resolve(value);
 };
-
 var downloads = {
   acceptDanger: jest.fn(function (downloadId, cb) {
     return cbOrPromise(cb);
@@ -578,6 +526,20 @@ var downloads = {
   showDefaultFolder: jest.fn()
 };
 
+// https://developer.chrome.com/extensions/permissions
+var permissions = {
+  contains: jest.fn(),
+  getAll: jest.fn(),
+  remove: jest.fn(),
+  request: jest.fn(),
+  onAdded: {
+    addListener: jest.fn()
+  },
+  onRemoved: {
+    addListener: jest.fn()
+  }
+};
+
 var geckoProfiler = {
   stop: jest.fn(function () {
     return Promise.resolve();
@@ -620,7 +582,8 @@ var chrome = {
   i18n: i18n,
   webNavigation: webNavigation,
   extension: extension,
-  downloads: downloads
+  downloads: downloads,
+  permissions: permissions
 };
  // Firefox uses 'browser' but aliases it to chrome
 
@@ -630,14 +593,16 @@ var chrome = {
  * directly call the module in their `setupFiles` property.
  */
 global.chrome = chrome;
-global.browser = chrome; // Firefox specific globals
+global.browser = chrome;
+
+// Firefox specific globals
 // if (navigator.userAgent.indexOf('Firefox') !== -1) {
 // https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Content_scripts#exportFunction
-
 global.exportFunction = jest.fn(function (func) {
   return func;
-}); // https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Content_scripts#cloneInto
-
+});
+// https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Content_scripts#cloneInto
 global.cloneInto = jest.fn(function (obj) {
   return obj;
-}); // }
+});
+// }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "jest-webextension-mock",
-  "version": "3.8.9",
+  "version": "3.8.11",
   "description": "Mock the components of a WebExtension",
   "main": "dist/setup.js",
   "module": "src/setup.js",
-  "author": "Bryan Clark <clarkbw@gmail.com> (https://twitter.com/clarkbw)",
+  "author": "Marwan Zibaoui <marwan.zibaoui@gmail.com> (https://mas.to/@Rickymarou)",
   "license": "ISC",
   "repository": {
     "type": "git",
-    "url": "https://github.com/clarkbw/jest-webextension-mock.git"
+    "url": "https://github.com/RickyMarou/jest-webextension-mock"
   },
   "scripts": {
     "test": "jest",

package/src/index.js

@@ -9,13 +9,14 @@ import { i18n } from './i18n';
 import { webNavigation } from './webNavigation';
 import { extension } from './extension';
 import { downloads } from './downloads';
+import { permissions } from './permissions';
 
 // Firefox specific API
 import { geckoProfiler } from './geckoProfiler';
 
 globalThis[Symbol.for('jest-webextension-mock')] = {
-	extensionPath: 'moz-extension://8b413e68-1e0d-4cad-b98e-1eb000799783/',
-  ...globalThis[Symbol.for('jest-webextension-mock')]
+  extensionPath: 'moz-extension://8b413e68-1e0d-4cad-b98e-1eb000799783/',
+  ...globalThis[Symbol.for('jest-webextension-mock')],
 };
 
 const chrome = {
@@ -31,6 +32,7 @@ const chrome = {
   webNavigation,
   extension,
   downloads,
+  permissions,
 };
 
 export { chrome };

package/src/permissions.js

@@ -0,0 +1,17 @@
+// https://developer.chrome.com/extensions/permissions
+
+export let onMessageListeners = [];
+export let onMessageExternalListeners = [];
+
+export const permissions = {
+  contains: jest.fn(),
+  getAll: jest.fn(),
+  remove: jest.fn(),
+  request: jest.fn(),
+  onAdded: {
+    addListener: jest.fn(),
+  },
+  onRemoved: {
+    addListener: jest.fn(),
+  },
+};