jest-webextension-mock 3.8.11 → 3.8.13

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# jest-webextension-mock
+
+## 3.8.13
+
+### Patch Changes
+
+- 2800518: Add storage onChange event listeners

package/README.md

@@ -1,7 +1,5 @@
 [![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:
@@ -102,10 +100,3 @@ it('should toggle the profiler on from stopped', () => {
 npm install
 npm test
 ```
-
-## Publish
-
-Publishing new releases is automated via the GitHub Action https://github.com/mikeal/merge-release tool. 
-
-To ensure your feature is properly released prefix your commit message with `feat` for any new feature. For example: `feat: new API` and this will bump the minor release number.  All other changes will be assumed as patch releases unless you include the string `BREAKING CHANGE` in your commit message or description which will trigger a new major release.  (do not do this unless absolutely required)
-

package/__tests__/storage.test.js

@@ -143,6 +143,26 @@ describe('browser.storage', () => {
           });
         });
       });
+      test('onChanged', () => {
+        const callback = jest.fn();
+        expect(jest.isMockFunction(storage.onChanged.addListener)).toBe(true);
+        expect(jest.isMockFunction(storage.onChanged.removeListener)).toBe(
+          true
+        );
+        expect(jest.isMockFunction(storage.onChanged.hasListener)).toBe(true);
+        expect(jest.isMockFunction(storage.onChanged.hasListeners)).toBe(true);
+
+        expect(storage.onChanged.hasListeners()).toBe(false);
+        expect(storage.onChanged.hasListener(callback)).toBe(false);
+
+        storage.onChanged.addListener(callback);
+        expect(storage.onChanged.hasListeners()).toBe(true);
+        expect(storage.onChanged.hasListener(callback)).toBe(true);
+
+        storage.onChanged.removeListener(callback);
+        expect(storage.onChanged.hasListeners()).toBe(false);
+        expect(storage.onChanged.hasListener(callback)).toBe(false);
+      });
     });
   });
 });

package/__tests__/tabs.test.js

@@ -102,6 +102,22 @@ describe('browser.tabs', () => {
       expect(browser.tabs.onUpdated[method]).toHaveBeenCalledTimes(1);
       expect(callback).toHaveBeenCalledTimes(0);
     });
+
+    test(`onRemoved.${method}`, () => {
+      const callback = jest.fn();
+      expect(jest.isMockFunction(browser.tabs.onRemoved[method])).toBe(true);
+      browser.tabs.onRemoved[method](callback);
+      expect(browser.tabs.onRemoved[method]).toHaveBeenCalledTimes(1);
+      expect(callback).toHaveBeenCalledTimes(0);
+    });
+
+    test(`onCreated.${method}`, () => {
+      const callback = jest.fn();
+      expect(jest.isMockFunction(browser.tabs.onCreated[method])).toBe(true);
+      browser.tabs.onCreated[method](callback);
+      expect(browser.tabs.onCreated[method]).toHaveBeenCalledTimes(1);
+      expect(callback).toHaveBeenCalledTimes(0);
+    });
   });
   test('reload', (done) => {
     const callback = jest.fn(() => done());

package/dist/setup.js

@@ -215,6 +215,16 @@ var tabs = {
     removeListener: jest.fn(),
     hasListener: jest.fn()
   },
+  onRemoved: {
+    addListener: jest.fn(),
+    removeListener: jest.fn(),
+    hasListener: jest.fn()
+  },
+  onCreated: {
+    addListener: jest.fn(),
+    removeListener: jest.fn(),
+    hasListener: jest.fn()
+  },
   sendMessage: jest.fn(function (tabId, message, cb) {
     onMessageListeners.forEach(function (listener) {
       return listener(tabId, message);
@@ -229,6 +239,26 @@ var tabs = {
   })
 };
 
+var createEventListeners = function createEventListeners() {
+  var listeners = [];
+  return {
+    addListener: jest.fn(function (listener) {
+      listeners.push(listener);
+    }),
+    removeListener: jest.fn(function (listener) {
+      listeners = listeners.filter(function (l) {
+        return l !== listener;
+      });
+    }),
+    hasListener: jest.fn(function (listener) {
+      return listeners.includes(listener);
+    }),
+    hasListeners: jest.fn(function () {
+      return listeners.length > 0;
+    })
+  };
+};
+
 var store = {};
 function resolveKey(key) {
   if (typeof key === 'string') {
@@ -288,7 +318,8 @@ var storage = {
         return cb();
       }
       return Promise.resolve();
-    })
+    }),
+    onChanged: createEventListeners()
   },
   local: {
     get: jest.fn(function (id, cb) {
@@ -329,7 +360,8 @@ var storage = {
         return cb();
       }
       return Promise.resolve();
-    })
+    }),
+    onChanged: createEventListeners()
   },
   managed: {
     get: jest.fn(function (id, cb) {
@@ -370,13 +402,10 @@ var storage = {
         return cb();
       }
       return Promise.resolve();
-    })
+    }),
+    onChanged: createEventListeners()
   },
-  onChanged: {
-    addListener: jest.fn(),
-    removeListener: jest.fn(),
-    hasListener: jest.fn()
-  }
+  onChanged: createEventListeners()
 };
 
 var getDetails = function getDetails(details, cb) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-webextension-mock",
-  "version": "3.8.11",
+  "version": "3.8.13",
   "description": "Mock the components of a WebExtension",
   "main": "dist/setup.js",
   "module": "src/setup.js",
@@ -13,12 +13,14 @@
   "scripts": {
     "test": "jest",
     "build": "rollup -c",
+    "release": "changeset version",
     "prettier": "prettier --write \"{config,src,__{tests,setups}__}/**/*.js\" rollup.config.js",
     "eslint-check": "eslint --print-config .eslintrc.js | eslint-config-prettier-check"
   },
   "devDependencies": {
     "@babel/core": "^7.11.6",
     "@babel/preset-env": "^7.11.5",
+    "@changesets/cli": "^2.27.1",
     "babel-core": "^7.0.0-bridge.0",
     "babel-jest": "^26.5.2",
     "eslint": "^7.11.0",
@@ -44,6 +46,5 @@
     "setupFiles": [
       "./__setups__/chrome.js"
     ]
-  },
-  "dependencies": {}
+  }
 }

package/src/createEventListeners.js

@@ -0,0 +1,18 @@
+export const createEventListeners = () => {
+  let listeners = [];
+
+  return {
+    addListener: jest.fn((listener) => {
+      listeners.push(listener);
+    }),
+    removeListener: jest.fn((listener) => {
+      listeners = listeners.filter((l) => l !== listener);
+    }),
+    hasListener: jest.fn((listener) => {
+      return listeners.includes(listener);
+    }),
+    hasListeners: jest.fn(() => {
+      return listeners.length > 0;
+    }),
+  };
+};

package/src/storage.js

@@ -1,4 +1,5 @@
 let store = {};
+import { createEventListeners } from './createEventListeners';
 
 function resolveKey(key) {
   if (typeof key === 'string') {
@@ -56,6 +57,7 @@ export const storage = {
       }
       return Promise.resolve();
     }),
+    onChanged: createEventListeners(),
   },
   local: {
     get: jest.fn((id, cb) => {
@@ -93,6 +95,7 @@ export const storage = {
       }
       return Promise.resolve();
     }),
+    onChanged: createEventListeners(),
   },
   managed: {
     get: jest.fn((id, cb) => {
@@ -130,10 +133,7 @@ export const storage = {
       }
       return Promise.resolve();
     }),
+    onChanged: createEventListeners(),
   },
-  onChanged: {
-    addListener: jest.fn(),
-    removeListener: jest.fn(),
-    hasListener: jest.fn(),
-  },
+  onChanged: createEventListeners(),
 };

package/src/tabs.js

@@ -45,6 +45,16 @@ export const tabs = {
     removeListener: jest.fn(),
     hasListener: jest.fn(),
   },
+  onRemoved: {
+    addListener: jest.fn(),
+    removeListener: jest.fn(),
+    hasListener: jest.fn(),
+  },
+  onCreated: {
+    addListener: jest.fn(),
+    removeListener: jest.fn(),
+    hasListener: jest.fn(),
+  },
   sendMessage: jest.fn((tabId, message, cb) => {
     onMessageListeners.forEach((listener) => listener(tabId, message));
     if (cb !== undefined) {

package/.github/workflows/publish.yml

@@ -1,22 +0,0 @@
-on:
-  push:
-    branches:
-      - main
-
-name: Publish
-
-jobs:
-  all:
-    name: Merge-Release
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - run: npm ci
-      - run: npm test
-      - run: npm run build --if-present
-      - run: git status --porcelain dist/setup.js
-      - uses: mikeal/merge-release@master
-        if: github.ref == 'refs/heads/main'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}