webext-schema 5.4.3 → 5.5.1

package/modules/browser.js

@@ -39,7 +39,7 @@ export const createBookmark = async opt => {
 /**
  * get bookmark tree node
  * @param {string|Array} [id] - bookmark ID or array of bookmark IDs
- * @returns {Promise.<?Array>} - array of bookmarks.BookmarkTreeNode
+ * @returns {Promise.<?Array.<object>>} - array of bookmarks.BookmarkTreeNode
  */
 export const getBookmarkTreeNode = async id => {
   const isGranted = await isPermissionGranted({
@@ -182,7 +182,7 @@ export const updateCommand = async (id, value = '') => {
 /* contextualIdentities */
 /**
  * get all contextual identities
- * @returns {Promise.<?Array>} - array of contextualIdentities.ContextualIdentity
+ * @returns {Promise.<?Array.<object>>} - array of contextualIdentities.ContextualIdentity
  */
 export const getAllContextualIdentities = async () => {
   const isGranted = await isPermissionGranted({
@@ -219,7 +219,7 @@ export const getContextualId = async cookieStoreId => {
 /* management */
 /**
  * get enabled theme
- * @returns {Promise.<?Array>} - array of management.ExtensionInfo
+ * @returns {Promise.<?Array.<object>>} - array of management.ExtensionInfo
  */
 export const getEnabledTheme = async () => {
   const isGranted = await isPermissionGranted({
@@ -258,7 +258,7 @@ export const getExtensionInfo = async id => {
 
 /**
  * get external extensions
- * @returns {Promise.<?Array|boolean>} - array of management.extensionInfo
+ * @returns {Promise.<?Array.<object>>} - array of management.extensionInfo
  */
 export const getExternalExtensions = async () => {
   const isGranted = await isPermissionGranted({
@@ -469,7 +469,7 @@ export const isScriptingAvailable = async () => {
 /**
  * execute script to tab
  * @param {object} opt - options
- * @returns {Promise.<?Array|boolean>} - array of InjectionResult object
+ * @returns {Promise.<?Array.<object>>} - array of InjectionResult object
  */
 export const executeScriptToTab = async (opt = {}) => {
   const { args, injectImmediately, files, func, target } = opt;
@@ -496,6 +496,32 @@ export const executeScriptToTab = async (opt = {}) => {
 };
 
 /* search */
+/**
+ * search in new tab
+ * @param {string} text - query string
+ * @param {object} opt - create tab options
+ * @returns {Promise.<object>} - tabs.Tab
+ */
+export const searchInNewTab = async (text, opt) => {
+  if (!isString(text)) {
+    throw new TypeError(`Expected String but got ${getType(text)}.`);
+  }
+  const isGranted = await isPermissionGranted({
+    permissions: ['search']
+  });
+  let tab;
+  if (isGranted) {
+    const { search } = browser;
+    const { id: tabId } = await tabs.create(isObjectNotEmpty(opt) ? opt : null);
+    await search.query({
+      tabId,
+      text
+    });
+    tab = await tabs.get(tabId);
+  }
+  return tab ?? null;
+};
+
 /**
  * search with a search engine
  * @param {string} query - search query
@@ -732,7 +758,7 @@ export const duplicateTab = async (tabId, opt) => {
 /**
  * query tabs
  * @param {object} opt - options
- * @returns {Promise.<?Array>} - result
+ * @returns {Promise.<Array.<object>>} - array of tabs.Tab
  */
 export const queryTabs = async opt => {
   const res = await tabs.query(opt);
@@ -852,7 +878,7 @@ export const getActiveTabId = async windowId => {
 /**
  * get all tabs in window
  * @param {number} [windowId] - window ID
- * @returns {Promise.<?Array>} - array of tabs.Tab
+ * @returns {Promise.<Array.<object>>} - array of tabs.Tab
  */
 export const getAllTabsInWindow = async windowId => {
   if (!Number.isInteger(windowId)) {
@@ -868,7 +894,7 @@ export const getAllTabsInWindow = async windowId => {
 /**
  * get highlighted tab
  * @param {number} [windowId] - window ID
- * @returns {Promise.<?Array>} - array of tabs.Tab
+ * @returns {Promise.<Array.<object>>} - array of tabs.Tab
  */
 export const getHighlightedTab = async windowId => {
   if (!Number.isInteger(windowId)) {
@@ -923,7 +949,7 @@ export const highlightTab = async (index, windowId) => {
  * move tab
  * @param {number|Array} tabId - tab ID
  * @param {object} [opt] - options
- * @returns {Promise.<?Array>} - array of tabs.Tab
+ * @returns {Promise.<?Array.<object>>} - array of tabs.Tab
  */
 export const moveTab = async (tabId, opt) => {
   if (!(Array.isArray(tabId) || Number.isInteger(tabId))) {
@@ -1083,7 +1109,7 @@ export const createNewWindow = async opt => {
 /**
  * get all windows
  * @param {boolean} populate - populate tabs
- * @returns {Promise.<Array>} - array of windows.Window
+ * @returns {Promise.<Array.<object>>} - array of windows.Window
  */
 export const getAllNormalWindows = async (populate = false) => {
   const arr = await windows.getAll({

package/modules/commander.js

@@ -33,7 +33,7 @@ export const cleanDirectory = (cmdOpts = {}) => {
  * @returns {void}
  */
 export const parseCommand = args => {
-  const reg = /^(?:(?:--)?help|-[h|v]|--version|c(?:lean)?|u(?:pdate)?)$/;
+  const reg = /^(?:(?:--)?help|-[hv]|--version|c(?:lean)?|u(?:pdate)?)$/;
   if (Array.isArray(args) && args.some(arg => reg.test(arg))) {
     commander.exitOverride();
     commander.version(process.env.npm_package_version, '-v, --version');

package/modules/schema.js

@@ -55,6 +55,7 @@ export class Schema {
 
   /**
    * get target from namespace key
+   * @private
    * @param {string} key - namespace key
    * @returns {object} - target object
    */
@@ -81,6 +82,7 @@ export class Schema {
 
   /**
    * assign imported values
+   * @private
    * @returns {void}
    */
   _assignImportMap() {
@@ -107,6 +109,7 @@ export class Schema {
 
   /**
    * assign referred values
+   * @private
    * @returns {void}
    */
   _assignRefMap() {
@@ -133,6 +136,7 @@ export class Schema {
 
   /**
    * mock events
+   * @private
    * @param {object} target - target object
    * @param {Array} events - events
    * @returns {object} - target object
@@ -158,6 +162,7 @@ export class Schema {
 
   /**
    * mock functions
+   * @private
    * @param {object} target - target object
    * @param {Array} funcs - functions
    * @returns {object} - target object
@@ -180,6 +185,7 @@ export class Schema {
 
   /**
    * mock properties
+   * @private
    * @param {object} target - target object
    * @param {object} props - properties
    * @param {string} namespace - namespace
@@ -220,6 +226,7 @@ export class Schema {
 
   /**
    * mock types
+   * @private
    * @param {object} target - target object
    * @param {Array} types - types
    * @param {string} namespace - namespace
@@ -257,6 +264,7 @@ export class Schema {
 
   /**
    * parse schema content
+   * @private
    * @returns {object} - schema
    */
   _parseSchemaContent() {
@@ -274,7 +282,7 @@ export class Schema {
   /**
    * get schema
    * @param {string} name - API name or file name
-   * @returns {Array} - schema
+   * @returns {?Array.<object>} - schema
    */
   get(name) {
     if (!isString(name)) {
@@ -304,7 +312,7 @@ export class Schema {
 
   /**
    * list schemas
-   * @returns {Array} - file list
+   * @returns {Array.<string>} - file list
    */
   list() {
     const schemas = this._schema ?? this._parseSchemaContent();

package/modules/update.js

@@ -1,6 +1,7 @@
 /**
  * update.js
  */
+/* eslint-disable no-await-in-loop */
 
 /* api */
 import path from 'node:path';
@@ -108,46 +109,57 @@ export const getFileList = async baseUrl => {
 /**
  * get all schema data
  * @param {string} baseUrl - base URL
- * @returns {Promise.<Array>} - schemas data in array
+ * @param {boolean} info - console info
+ * @returns {Promise.<Array.<object>>} - schemas data in array
  */
-export const getAllSchemaData = async baseUrl => {
+export const getAllSchemaData = async (baseUrl, info) => {
   if (!isString(baseUrl)) {
     throw new TypeError(`Expected String but got ${getType(baseUrl)}.`);
   }
+  const schemas = [];
   const items = await getFileList(baseUrl);
-  const func = [];
   for (const item of items) {
-    func.push(getSchemaData(item, baseUrl));
+    if (info) {
+      console.info(`Fetching ${item}`);
+    }
+    const schema = await getSchemaData(item, baseUrl);
+    schemas.push(schema);
   }
-  return Promise.all(func);
+  return schemas;
 };
 
 /**
  * get listed schema data
  * @param {string} baseUrl - base URL
  * @param {Array} arr - array of schema file names
- * @returns {Promise.<Array>} - schema data in array
+ * @param {boolean} info - console info
+ * @returns {Promise.<Array.<object>>} - schema data in array
  */
-export const getListedSchemaData = async (baseUrl, arr) => {
+export const getListedSchemaData = async (baseUrl, arr, info) => {
   if (!isString(baseUrl)) {
     throw new TypeError(`Expected String but got ${getType(baseUrl)}.`);
   }
   if (!Array.isArray(arr)) {
     throw new TypeError(`Expected Array but got ${getType(arr)}.`);
   }
-  const func = [];
+  const schemas = [];
   for (const item of arr) {
-    func.push(getSchemaData(item, baseUrl));
+    if (info) {
+      console.info(`Fetching ${item}`);
+    }
+    const schema = await getSchemaData(item, baseUrl);
+    schemas.push(schema);
   }
-  return Promise.all(func);
+  return schemas;
 };
 
 /**
  * get MailExtensions schema data
  * @param {string} baseUrl - base URL
- * @returns {Promise.<Array>} - results of each handler
+ * @param {boolean} info - console info
+ * @returns {Promise.<Array.<object>>} - results of each handler
  */
-export const getMailExtSchemaData = async baseUrl => {
+export const getMailExtSchemaData = async (baseUrl, info) => {
   if (!isString(baseUrl)) {
     throw new TypeError(`Expected String but got ${getType(baseUrl)}.`);
   }
@@ -157,19 +169,26 @@ export const getMailExtSchemaData = async baseUrl => {
     'commands.json',
     'pkcs11.json'
   ];
-  const func = [];
+  const schemas = [];
   for (const item of items) {
-    !excludeFile.includes(item) && func.push(getSchemaData(item, schemaUrl));
+    if (!excludeFile.includes(item)) {
+      if (info) {
+        console.info(`Fetching ${item}`);
+      }
+      const schema = await getSchemaData(item, schemaUrl);
+      schemas.push(schema);
+    }
   }
-  return Promise.all(func);
+  return schemas;
 };
 
 /**
  * create unified schema
  * @param {string} channel - release channel
+ * @param {boolean} info - console info
  * @returns {Promise.<object>} - schema
  */
-export const createUnifiedSchema = async channel => {
+export const createUnifiedSchema = async (channel, info) => {
   const channelUrl = getChannelUrl(channel);
   const schema = {};
   let arr;
@@ -187,14 +206,16 @@ export const createUnifiedSchema = async channel => {
     const toolkitBaseUrl =
       `${getChannelUrl('central')}toolkit/components/extensions/schemas/`;
     arr = await Promise.all([
-      getListedSchemaData(browserBaseUrl, browserItems),
-      getListedSchemaData(toolkitBaseUrl, toolkitItems),
-      getMailExtSchemaData(`${channelUrl}mail/components/extensions/`)
+      getListedSchemaData(browserBaseUrl, browserItems, info),
+      getListedSchemaData(toolkitBaseUrl, toolkitItems, info),
+      getMailExtSchemaData(`${channelUrl}mail/components/extensions/`, info)
     ]);
   } else {
     arr = await Promise.all([
-      getAllSchemaData(`${channelUrl}browser/components/extensions/schemas/`),
-      getAllSchemaData(`${channelUrl}toolkit/components/extensions/schemas/`)
+      getAllSchemaData(`${channelUrl}browser/components/extensions/schemas/`,
+        info),
+      getAllSchemaData(`${channelUrl}toolkit/components/extensions/schemas/`,
+        info)
     ]);
   }
   for (const items of arr) {
@@ -216,7 +237,7 @@ export const saveSchemaFile = async (channel, info) => {
   if (!isString(channel)) {
     throw new TypeError(`Expected String but got ${getType(channel)}.`);
   }
-  const schema = await createUnifiedSchema(channel);
+  const schema = await createUnifiedSchema(channel, info);
   const content = `${JSON.stringify(schema, null, INDENT)}\n`;
   const fileName = channel === 'mail' ? 'mailext' : 'webext';
   const filePath =

package/package.json

@@ -21,20 +21,23 @@
   },
   "devDependencies": {
     "@types/firefox-webext-browser": "^120.0.4",
-    "@types/node": "^22.7.4",
+    "@types/node": "^22.10.1",
     "@types/sinon": "^17.0.3",
     "c8": "^10.1.2",
-    "chai": "^5.1.1",
-    "eslint": "^8.57.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.30.0",
-    "eslint-plugin-jsdoc": "^50.3.0",
-    "eslint-plugin-regexp": "^2.6.0",
-    "eslint-plugin-unicorn": "^55.0.0",
-    "mocha": "^10.7.3",
-    "npm-run-all": "^4.1.5",
-    "typescript": "^5.6.2",
-    "undici": "^6.19.8"
+    "eslint": "^9.15.0",
+    "eslint-plugin-import-x": "^4.4.3",
+    "eslint-plugin-jsdoc": "^50.6.0",
+    "eslint-plugin-regexp": "^2.7.0",
+    "eslint-plugin-unicorn": "^56.0.1",
+    "globals": "^15.12.0",
+    "mocha": "^10.8.2",
+    "neostandard": "^0.11.9",
+    "npm-run-all2": "^7.0.1",
+    "typescript": "^5.7.2",
+    "undici": "^7.0.0"
+  },
+  "overrides": {
+    "glob": "^10.4.5"
   },
   "scripts": {
     "build": "npm run tsc && npm run lint && npm run test",
@@ -54,5 +57,5 @@
     "update-mail": "node index update --channel=mail -i",
     "update-release": "node index update --channel=release -i"
   },
-  "version": "5.4.3"
+  "version": "5.5.1"
 }