webext-schema 6.0.0 → 7.1.0

package/.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: ['https://paypal.me/asamuzakjp'] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: build
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  release:
+    types: [ created ]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        node-version: [ 22.x, lts/*, latest ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+          check-latest: true
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run test:all

package/README.md

@@ -1,11 +1,19 @@
+# webext-schema
+
 [![build](https://github.com/asamuzaK/webext-schema/workflows/build/badge.svg)](https://github.com/asamuzaK/webext-schema/actions?query=workflow%3Abuild)
 [![CodeQL](https://github.com/asamuzaK/webext-schema/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/asamuzaK/webext-schema/actions/workflows/github-code-scanning/codeql)
 [![npm](https://img.shields.io/npm/v/webext-schema)](https://www.npmjs.com/package/webext-schema)
 
-# webext-schema
+[WebExtensions](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions "Browser Extensions - Mozilla | MDN") schemas and [MailExtensions](https://developer.thunderbird.net/add-ons/mailextensions "A Guide to Extensions - Thunderbird") schemas fetched from [hg.mozilla.org](https://hg.mozilla.org/).
+Stubbed browser API and a standalone browser utility script are also available.
+
+## Features
 
-[WebExtentions](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions "Browser Extensions - Mozilla | MDN") schemas and [MailExtensions](https://developer.thunderbird.net/add-ons/mailextensions "A Guide to Extensions - Thunderbird") schemas fetched from [hg.mozilla.org](https://hg.mozilla.org/).
-Stubbed browser API is also available.
+* **Up-to-date Schemas:** Directly fetched from Mozilla's repositories.
+* **Multi-Channel Support:** Choose between `beta`, `central`, and `mail` channels to match your target environment.
+* **Easy API Mocking:** Instantly generate a stubbed `browser` object powered by [Sinon.JS](https://sinonjs.org/) for robust unit testing of your extensions.
+* **Standalone Utility Included:** Comes with `browser.js`, a dependency-free, Promise-wrapped utility script ready to be dropped into your extension project for easier API handling.
+* **Modern ESM & TypeScript:** Native ES Modules support with bundled TypeScript definitions (`index.d.ts`).
 
 ## Install
 
@@ -13,7 +21,7 @@ Stubbed browser API is also available.
 npm i webext-schema
 ```
 
-## Usage
+## Usage (Schema & Mock)
 
 ```javascript
 import { Schema } from 'webext-schema';
@@ -23,7 +31,7 @@ const schema = new Schema();
 
 ### new Schema(<var>channel</var>, <var>sinonConfig</var>)
 
-* @param {string} [channel] - release channel. one of "beta", "central", "release", "esr", "mail".
+* @param {string} [channel] - release channel. one of "beta", "central", "mail".
 * @param {Object} [sinonConfig] - optional configuration for `sinon.createSandbox()`, see [Sinon.JS](https://sinonjs.org/) for details.
 
 Both arguments are optional.
@@ -37,7 +45,7 @@ const schema = new Schema("central", {
 
 ### schema.channel
 
-"central", "beta", "release", "esr" for WebExtensions, and "mail" for MailExtensions are available.
+"central", "beta" for WebExtensions, and "mail" for MailExtensions are available.
 Channel defaults to "beta".
 
 ```javascript
@@ -125,3 +133,26 @@ assert.isFunction(port2.onDisconnect.addListener);
 // reset
 browser._sandbox.reset();
 ```
+
+---
+
+## Browser Utility (`browser.js`)
+
+A standalone utility script (`browser.js`) is also included in this repository. It provides useful, Promise-wrapped functions for common browser extension APIs (e.g., `browser.tabs`, `browser.runtime`, `browser.storage`).
+
+This file is designed to be copied directly into your browser extension project. It has no external dependencies and works natively in your background or content scripts.
+
+### How to use `browser.js`
+
+1. Copy `browser.js` from the `webext-schema` repository into your extension's source directory.
+2. Import the needed functions into your extension scripts:
+
+```javascript
+import { createTab, getActiveTab, setStorage } from './path/to/browser.js';
+
+// Example: Create a new tab and save data
+async function openAndSave() {
+  const tab = await createTab({ url: '[https://example.com](https://example.com)' });
+  await setStorage({ lastOpenedTabId: tab.id }, 'local');
+}
+```

package/SECURITY.md

@@ -0,0 +1,36 @@
+# Security Policy
+
+We take security vulnerabilities seriously. Thank you for improving the security of our project.
+
+## Supported Versions
+
+The following versions of this project are currently supported with security updates:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 7.x.x   | :white_check_mark: |
+| 6.x.x   | :white_check_mark: |
+| < 6.0.0 | :x:                |
+
+## Reporting a Vulnerability
+
+Please **DO NOT** open a public issue for security-related vulnerabilities. 
+
+If you discover a security vulnerability, please report it privately via **GitHub's Private vulnerability reporting** feature.
+You can do this by navigating to the **Security** tab of this repository, selecting **Advisories**, and clicking the **Report a vulnerability** button.
+
+To help us resolve the issue efficiently, please include the following details in your report:
+
+* **Type of vulnerability** (e.g., XSS, SSRF, Prototype Pollution)
+* **Affected component or file name**
+* **Steps to reproduce** (including proof of concept / PoC code if available)
+* **Potential impact** of the vulnerability
+
+### Our Response Process
+
+1. **Acknowledgment**: We will acknowledge receipt of your report within 48 to 72 hours.
+2. **Investigation**: We will verify the vulnerability and evaluate its severity.
+3. **Fix & Release**: We will work on a fix in a private fork and release a patched version as soon as possible.
+4. **Advisory**: A GitHub Security Advisory will be published if necessary, giving you full credit for the discovery (unless you prefer to remain anonymous).
+
+Please adhere to Coordinated Vulnerability Disclosure (CVD) and **do not disclose the vulnerability publicly** until a patch has been released.

package/eslint.config.mjs

@@ -0,0 +1,46 @@
+import jsdoc from 'eslint-plugin-jsdoc';
+import regexp from 'eslint-plugin-regexp';
+import unicorn from 'eslint-plugin-unicorn';
+import globals from 'globals';
+import neostandard, { plugins as neostdplugins } from 'neostandard';
+
+export default [
+  ...neostandard({
+    semi: true
+  }),
+  jsdoc.configs['flat/recommended'],
+  regexp.configs['flat/recommended'],
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+        ...globals.webextensions
+      }
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: true
+    },
+    plugins: {
+      '@stylistic': neostdplugins['@stylistic'],
+      regexp,
+      unicorn
+    },
+    rules: {
+      '@stylistic/space-before-function-paren': ['error', {
+        anonymous: 'always',
+        asyncArrow: 'always',
+        named: 'never'
+      }],
+      'no-await-in-loop': 'error',
+      'no-use-before-define': ['error', {
+        allowNamedExports: false,
+        classes: true,
+        functions: true,
+        variables: true
+      }],
+      'prefer-object-has-own': 'error',
+      'unicorn/prefer-node-protocol': 'error'
+    }
+  }
+];

package/index.js

@@ -9,11 +9,17 @@
 /* api */
 import process from 'node:process';
 import { parseCommand } from './modules/commander.js';
-import { logErr, throwErr } from './modules/common.js';
 export { Schema } from './modules/schema.js';
 
 /* process */
-process.on('uncaughtException', throwErr);
-process.on('unhandledRejection', logErr);
+process.on('uncaughtException', err => {
+  console.error('Fatal Error (Uncaught Exception):', err);
+  process.exit(1);
+});
+
+process.on('unhandledRejection', reason => {
+  console.error('Fatal Error (Unhandled Rejection):', reason);
+  process.exit(1);
+});
 
 parseCommand(process.argv);

package/modules/browser.js

@@ -2,12 +2,48 @@
  * browser.js
  */
 
-/* shared */
-import { getType, isObjectNotEmpty, isString, logErr } from './common.js';
-
 /* api */
 const { permissions, runtime, tabs, windows } = browser;
 
+/* constants & utils */
+const TYPE_FROM = 8;
+const TYPE_TO = -1;
+
+/**
+ * log error
+ * @param {!object} e - Error
+ * @returns {boolean} - false
+ */
+const logErr = e => {
+  console.error(e);
+  return false;
+};
+
+/**
+ * get type
+ * @param {object} o - object to check
+ * @returns {string} - type of object
+ */
+const getType = o =>
+  Object.prototype.toString.call(o).slice(TYPE_FROM, TYPE_TO);
+
+/**
+ * is object, and not an empty object
+ * @param {object} o - object to check;
+ * @returns {boolean} - result
+ */
+const isObjectNotEmpty = o => {
+  const items = /Object/i.test(getType(o)) && Object.keys(o);
+  return !!(items?.length);
+};
+
+/**
+ * is string
+ * @param {object} o - object to check
+ * @returns {boolean} - result
+ */
+const isString = o => typeof o === 'string' || o instanceof String;
+
 /**
  * check if permission is granted
  * @param {object} perm - permissions.Permission

package/modules/schema.js

@@ -22,14 +22,13 @@ export class Schema {
    * construct
    * @param {...(string|object)} [args] - optional arguments
    *                                      {string} - release channel.
-   *                                                 one of "beta", "central",
-   *                                                 "esr", "mail".
+   *                                                 "beta", "central", "mail".
    *                                      {object} - sinon config
    */
   constructor(...args) {
     const [arg1, arg2] = args;
     this.#channel =
-      isString(arg1) && /(?:centra|mai)l|beta|esr/.test(arg1)
+      isString(arg1) && /^(?:central|mail)$/.test(arg1)
         ? arg1
         : 'beta';
     this._sandbox =
@@ -48,7 +47,7 @@ export class Schema {
   }
 
   set channel(ch) {
-    if (isString(ch) && /(?:centra|mai)l|beta|esr/.test(ch)) {
+    if (isString(ch) && /^(?:central|mail|beta)$/.test(ch)) {
       this.#channel = ch;
     }
   }

package/modules/update.js

@@ -14,7 +14,6 @@ import { createFile } from './file-util.js';
 import { CHAR, INDENT } from './constant.js';
 const DIR_CWD = process.cwd();
 const PERM_FILE = 0o644;
-export const ESR_VER = 115;
 
 /**
  * fetch text
@@ -45,9 +44,6 @@ export const getChannelUrl = channel => {
     case 'central':
       dir = 'mozilla-central/';
       break;
-    case 'esr':
-      dir = `releases/mozilla-esr${ESR_VER}/`;
-      break;
     case 'mail':
       dir = 'comm-central/';
       break;
@@ -274,7 +270,6 @@ export const updateSchemas = async (cmdOpts = {}) => {
     func.push(
       saveSchemaFile('beta', info),
       saveSchemaFile('central', info),
-      saveSchemaFile('esr', info),
       saveSchemaFile('mail', info)
     );
   }

package/package.json

@@ -11,51 +11,60 @@
   },
   "type": "module",
   "exports": {
-    "default": {
+    ".": {
       "types": "./types/index.d.ts",
       "default": "./index.js"
-    }
+    },
+    "./package.json": "./package.json"
   },
-  "types": "types/index.d.ts",
   "dependencies": {
     "camelize": "^1.0.1",
-    "commander": "^14.0.1",
+    "commander": "^15.0.0",
     "decamelize": "^6.0.1",
     "json5": "^2.2.3",
-    "sinon": "^21.0.0"
+    "sinon": "^22.1.0"
   },
   "devDependencies": {
-    "@types/firefox-webext-browser": "^120.0.5",
-    "@types/node": "^24.6.2",
-    "@types/sinon": "^17.0.4",
-    "c8": "^10.1.3",
-    "eslint": "^9.37.0",
-    "eslint-plugin-jsdoc": "^60.8.0",
-    "eslint-plugin-regexp": "^2.10.0",
-    "eslint-plugin-unicorn": "^61.0.2",
-    "globals": "^16.4.0",
-    "mocha": "^11.7.4",
-    "neostandard": "^0.12.2",
-    "npm-run-all2": "^8.0.4",
-    "typescript": "^5.9.3",
-    "undici": "^7.16.0"
+    "@types/firefox-webext-browser": "^143.0.0",
+    "@types/node": "^26.1.1",
+    "@types/sinon": "^22.0.0",
+    "c8": "^12.0.0",
+    "eslint": "^9.39.5",
+    "eslint-plugin-jsdoc": "^63.2.2",
+    "eslint-plugin-regexp": "^3.1.1",
+    "eslint-plugin-unicorn": "^64.0.0",
+    "globals": "^17.7.0",
+    "mocha": "^11.7.6",
+    "neostandard": "^0.13.0",
+    "typescript": "^7.0.2",
+    "undici": "^8.9.0"
+  },
+  "overrides": {
+    "c8": {
+      "yargs": "^18.0.0"
+    },
+    "eslint": {
+      "js-yaml": "^4.3.0"
+    },
+    "mocha": {
+      "diff": "^8.0.3",
+      "js-yaml": "^4.3.0"
+    },
+    "serialize-javascript": "^7.0.4"
   },
   "scripts": {
     "build": "npm run tsc && npm run lint && npm run test",
     "lint": "eslint . --fix",
     "start": "node index",
     "test": "npm run test:central",
+    "test:all": "npm run test:beta && npm run test:central",
     "test:beta": "c8 mocha --require=test/mocha/setup.js --channel=beta --exit test/*.test.js",
     "test:central": "c8 mocha --require=test/mocha/setup.js --channel=central --exit test/*.test.js",
-    "test:esr": "c8 mocha --require=test/mocha/setup.js --channel=esr --exit test/*.test.js",
-    "test:release": "c8 mocha --require=test/mocha/setup.js --channel=release --exit test/*.test.js",
-    "testall": "npm-run-all -s test:*",
     "tsc": "node index clean --dir=types -i && npx tsc",
-    "update": "node index update -i",
+    "update": "npm run update:beta && npm run update:central && npm run update:mail",
     "update:beta": "node index update --channel=beta -i",
     "update:central": "node index update --channel=central -i",
-    "update:esr": "node index update --channel=esr -i",
     "update:mail": "node index update --channel=mail -i"
   },
-  "version": "6.0.0"
+  "version": "7.1.0"
 }