jest-webextension-mock 4.1.1 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # jest-webextension-mock
 
+## 4.2.0
+
+### Minor Changes
+
+- e8087a9: Add a mock for the `contextMenus` API (also exposed as `menus` for Firefox parity): `create`, `update`, `remove`, `removeAll`, `refresh`, `getTargetElement`, the `ACTION_MENU_TOP_LEVEL_LIMIT` constant, and the `onClicked`/`onShown`/`onHidden` events (#11).
+- 25c1406: Flesh out the `webNavigation` mock: add the remaining events (`onBeforeNavigate`, `onCommitted`, `onDOMContentLoaded`, `onErrorOccurred`, `onCreatedNavigationTarget`, `onReferenceFragmentUpdated`, `onTabReplaced`) with full stateful listener tracking, and add `getFrame`/`getAllFrames` with the callback/promise dual pattern (#5).
+
 ## 4.1.1
 
 ### Patch Changes

package/dist/setup.js

@@ -11,9 +11,9 @@ function _arrayWithHoles(r) {
 function _defineProperty(e, r, t) {
   return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
     value: t,
-    enumerable: !0,
-    configurable: !0,
-    writable: !0
+    enumerable: true,
+    configurable: true,
+    writable: true
   }) : e[r] = t, e;
 }
 function _iterableToArrayLimit(r, l) {
@@ -24,15 +24,12 @@ function _iterableToArrayLimit(r, l) {
       i,
       u,
       a = [],
-      f = !0,
-      o = !1;
+      f = true,
+      o = false;
     try {
-      if (i = (t = t.call(r)).next, 0 === l) {
-        if (Object(t) !== t) return;
-        f = !1;
-      } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);
+      if (i = (t = t.call(r)).next, 0 === l) ; else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0);
     } catch (r) {
-      o = !0, n = r;
+      o = true, n = r;
     } finally {
       try {
         if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return;
@@ -59,7 +56,7 @@ function ownKeys(e, r) {
 function _objectSpread2(e) {
   for (var r = 1; r < arguments.length; r++) {
     var t = null != arguments[r] ? arguments[r] : {};
-    r % 2 ? ownKeys(Object(t), !0).forEach(function (r) {
+    r % 2 ? ownKeys(Object(t), true).forEach(function (r) {
       _defineProperty(e, r, t[r]);
     }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) {
       Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r));
@@ -74,7 +71,7 @@ function _toPrimitive(t, r) {
   if ("object" != typeof t || !t) return t;
   var e = t[Symbol.toPrimitive];
   if (void 0 !== e) {
-    var i = e.call(t, r || "default");
+    var i = e.call(t, r);
     if ("object" != typeof i) return i;
     throw new TypeError("@@toPrimitive must return a primitive value.");
   }
@@ -247,6 +244,43 @@ var commands = {
   }
 };
 
+var cbOrPromise$2 = function cbOrPromise(cb, value) {
+  if (cb !== undefined) {
+    return cb(value);
+  }
+  return Promise.resolve(value);
+};
+var generatedId = 0;
+var create$1 = function create(createProperties, cb) {
+  var id = createProperties && createProperties.id !== undefined ? createProperties.id : "generated-id-".concat(++generatedId);
+  if (typeof cb === 'function') {
+    cb();
+  }
+  return id;
+};
+var contextMenus = {
+  ACTION_MENU_TOP_LEVEL_LIMIT: 6,
+  create: jest.fn(create$1),
+  update: jest.fn(function (id, updateProperties, cb) {
+    return cbOrPromise$2(cb);
+  }),
+  remove: jest.fn(function (menuItemId, cb) {
+    return cbOrPromise$2(cb);
+  }),
+  removeAll: jest.fn(function (cb) {
+    return cbOrPromise$2(cb);
+  }),
+  refresh: jest.fn(function (cb) {
+    return cbOrPromise$2(cb);
+  }),
+  getTargetElement: jest.fn(function () {
+    return null;
+  }),
+  onClicked: createEventListeners(),
+  onShown: createEventListeners(),
+  onHidden: createEventListeners()
+};
+
 var cbOrPromise$1 = function cbOrPromise(cb, value) {
   if (cb !== undefined) {
     return cb(value);
@@ -415,6 +449,7 @@ var pageAction = {
 };
 
 // https://developer.chrome.com/extensions/permissions
+
 var permissions = {
   contains: jest.fn(),
   getAll: jest.fn(),
@@ -682,12 +717,27 @@ var tabs = {
 };
 
 var webNavigation = {
-  onCompleted: {
-    addListener: jest.fn()
-  },
-  onHistoryStateUpdated: {
-    addListener: jest.fn()
-  }
+  getFrame: jest.fn(function (details, cb) {
+    if (cb !== undefined) {
+      return cb(null);
+    }
+    return Promise.resolve(null);
+  }),
+  getAllFrames: jest.fn(function (details, cb) {
+    if (cb !== undefined) {
+      return cb([]);
+    }
+    return Promise.resolve([]);
+  }),
+  onBeforeNavigate: createEventListeners(),
+  onCommitted: createEventListeners(),
+  onDOMContentLoaded: createEventListeners(),
+  onCompleted: createEventListeners(),
+  onErrorOccurred: createEventListeners(),
+  onCreatedNavigationTarget: createEventListeners(),
+  onReferenceFragmentUpdated: createEventListeners(),
+  onTabReplaced: createEventListeners(),
+  onHistoryStateUpdated: createEventListeners()
 };
 
 globalThis[Symbol["for"]('jest-webextension-mock')] = _objectSpread2({
@@ -698,6 +748,9 @@ var chrome = {
   alarms: alarms,
   browserAction: browserAction,
   commands: commands,
+  contextMenus: contextMenus,
+  menus: contextMenus,
+  // Firefox exposes the same API as `menus`
   downloads: downloads,
   extension: extension,
   geckoProfiler: geckoProfiler,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-webextension-mock",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "Mock the components of a WebExtension",
   "main": "dist/setup.js",
   "module": "src/setup.js",
@@ -28,18 +28,18 @@
     "release": "changeset version"
   },
   "devDependencies": {
-    "@rollup/plugin-babel": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.0.0",
     "@babel/core": "^7.29.0",
     "@babel/preset-env": "^7.29.0",
     "@changesets/cli": "^2.29.8",
+    "@rollup/plugin-babel": "^7.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
     "babel-jest": "^29.7.0",
     "eslint": "^9.39.3",
     "eslint-config-prettier": "^9.1.2",
     "eslint-plugin-prettier": "^5.5.5",
     "jest": "^29.7.0",
     "prettier": "^3.8.1",
-    "rollup": "^2.80.0"
+    "rollup": "^4.62.2"
   },
   "jest": {
     "bail": true,

package/src/contextMenus.js

@@ -0,0 +1,37 @@
+import { createEventListeners } from './createEventListeners';
+
+const cbOrPromise = (cb, value) => {
+  if (cb !== undefined) {
+    return cb(value);
+  }
+
+  return Promise.resolve(value);
+};
+
+let generatedId = 0;
+
+const create = (createProperties, cb) => {
+  const id =
+    createProperties && createProperties.id !== undefined
+      ? createProperties.id
+      : `generated-id-${++generatedId}`;
+
+  if (typeof cb === 'function') {
+    cb();
+  }
+
+  return id;
+};
+
+export const contextMenus = {
+  ACTION_MENU_TOP_LEVEL_LIMIT: 6,
+  create: jest.fn(create),
+  update: jest.fn((id, updateProperties, cb) => cbOrPromise(cb)),
+  remove: jest.fn((menuItemId, cb) => cbOrPromise(cb)),
+  removeAll: jest.fn((cb) => cbOrPromise(cb)),
+  refresh: jest.fn((cb) => cbOrPromise(cb)),
+  getTargetElement: jest.fn(() => null),
+  onClicked: createEventListeners(),
+  onShown: createEventListeners(),
+  onHidden: createEventListeners(),
+};

package/src/index.js

@@ -1,6 +1,7 @@
 import { alarms } from './alarms';
 import { browserAction } from './browserAction';
 import { commands } from './commands';
+import { contextMenus } from './contextMenus';
 import { downloads } from './downloads';
 import { extension } from './extension';
 import { geckoProfiler } from './geckoProfiler';
@@ -24,6 +25,8 @@ const chrome = {
   alarms,
   browserAction,
   commands,
+  contextMenus,
+  menus: contextMenus, // Firefox exposes the same API as `menus`
   downloads,
   extension,
   geckoProfiler,

package/src/webNavigation.js

@@ -1,8 +1,25 @@
+import { createEventListeners } from './createEventListeners';
+
 export const webNavigation = {
-  onCompleted: {
-    addListener: jest.fn(),
-  },
-  onHistoryStateUpdated: {
-    addListener: jest.fn(),
-  },
+  getFrame: jest.fn((details, cb) => {
+    if (cb !== undefined) {
+      return cb(null);
+    }
+    return Promise.resolve(null);
+  }),
+  getAllFrames: jest.fn((details, cb) => {
+    if (cb !== undefined) {
+      return cb([]);
+    }
+    return Promise.resolve([]);
+  }),
+  onBeforeNavigate: createEventListeners(),
+  onCommitted: createEventListeners(),
+  onDOMContentLoaded: createEventListeners(),
+  onCompleted: createEventListeners(),
+  onErrorOccurred: createEventListeners(),
+  onCreatedNavigationTarget: createEventListeners(),
+  onReferenceFragmentUpdated: createEventListeners(),
+  onTabReplaced: createEventListeners(),
+  onHistoryStateUpdated: createEventListeners(),
 };