jest-webextension-mock 3.8.8 → 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/__tests__/runtime.test.js

@@ -29,9 +29,10 @@ describe('browser.runtime', () => {
   });
   test('getURL', () => {
     const path = 'TEST_PATH';
+    const extensionOriginURL = globalThis[Symbol.for('jest-webextension-mock')].extensionPath;
     expect(jest.isMockFunction(browser.runtime.getURL)).toBe(true);
     const respPath = browser.runtime.getURL(path);
-    expect(respPath).toEqual(path);
+    expect(respPath).toEqual(extensionOriginURL + path);
     expect(browser.runtime.getURL).toHaveBeenCalledTimes(1);
   });
   test('sendMessage', (done) => {

package/dist/setup.js

@@ -1,6 +1,51 @@
 'use strict';
 
+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] : {};
+    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
+      _defineProperty(target, key, source[key]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
+      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+    });
+  }
+  return target;
+}
+function _typeof(obj) {
+  "@babel/helpers - typeof";
+
+  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
+    return typeof obj;
+  } : function (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, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+  return obj;
+}
+
 // https://developer.chrome.com/extensions/omnibox
+
 var omnibox = {
   setDefaultSuggestion: jest.fn(),
   onInputStarted: {
@@ -40,11 +85,9 @@ var runtime = {
     onMessageListeners.forEach(function (listener) {
       return listener(message);
     });
-
     if (cb !== undefined) {
       return cb();
     }
-
     return Promise.resolve();
   }),
   onMessage: {
@@ -84,7 +127,8 @@ var runtime = {
     hasListener: jest.fn()
   },
   getURL: jest.fn(function (path) {
-    return path;
+    var origin = globalThis[Symbol["for"]('jest-webextension-mock')].extensionPath;
+    return String(new URL(path, origin));
   }),
   openOptionsPage: jest.fn(),
   getManifest: jest.fn(function () {
@@ -115,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 () {
@@ -178,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) {
@@ -190,18 +229,7 @@ var tabs = {
   })
 };
 
-function _typeof(obj) {
-  "@babel/helpers - typeof";
-
-  return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
-    return typeof obj;
-  } : function (obj) {
-    return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
-  }, _typeof(obj);
-}
-
 var store = {};
-
 function resolveKey(key) {
   if (typeof key === 'string') {
     var result = {};
@@ -218,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) {
@@ -256,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) {
@@ -306,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) {
@@ -356,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();
     })
   },
@@ -384,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),
@@ -406,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: {
@@ -423,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) {
@@ -498,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);
@@ -536,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();
@@ -563,6 +567,9 @@ var geckoProfiler = {
   }
 };
 
+globalThis[Symbol["for"]('jest-webextension-mock')] = _objectSpread2({
+  extensionPath: 'moz-extension://8b413e68-1e0d-4cad-b98e-1eb000799783/'
+}, globalThis[Symbol["for"]('jest-webextension-mock')]);
 var chrome = {
   omnibox: omnibox,
   tabs: tabs,
@@ -575,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
 
@@ -585,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.8",
+  "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,10 +9,16 @@ 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')],
+};
+
 const chrome = {
   omnibox,
   tabs,
@@ -26,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(),
+  },
+};

package/src/runtime.js

@@ -56,7 +56,8 @@ export const runtime = {
     hasListener: jest.fn(),
   },
   getURL: jest.fn(function (path) {
-    return path;
+    const origin = globalThis[Symbol.for('jest-webextension-mock')].extensionPath;
+    return String(new URL(path, origin));
   }),
   openOptionsPage: jest.fn(),
   getManifest: jest.fn(() => ({ manifest_version: 3 })),