webext-schema 5.1.4 → 5.1.6

package/README.md

@@ -16,7 +16,7 @@ npm i webext-schema
 ## Usage
 
 ```
-const {Schema} = require("webext-schema");
+import { Schema } from 'webext-schema';
 
 const schema = new Schema();
 ```

package/index.js

@@ -8,8 +8,8 @@
 
 /* api */
 import process from 'node:process';
+import { parseCommand } from './modules/commander.js';
 import { logErr, throwErr } from './modules/common.js';
-import { parseCommand } from './modules/update.js';
 export { Schema } from './modules/schema.js';
 
 /* process */

package/modules/browser.js

@@ -12,7 +12,7 @@ const { permissions, runtime, tabs, windows } = browser;
  * check if permission is granted
  *
  * @param {object} perm - permissions.Permission
- * @returns {boolean} - result
+ * @returns {Promise.<boolean>} - result
  */
 export const isPermissionGranted = async perm => {
   const bool = await permissions.contains(perm);
@@ -24,7 +24,7 @@ export const isPermissionGranted = async perm => {
  * create bookmark
  *
  * @param {object} opt - bookmarks.CreateDetails
- * @returns {object} - bookmarks.BookmarkTreeNode
+ * @returns {Promise.<object>} - bookmarks.BookmarkTreeNode
  */
 export const createBookmark = async opt => {
   const isGranted = await isPermissionGranted({
@@ -42,7 +42,7 @@ export const createBookmark = async opt => {
  * get bookmark tree node
  *
  * @param {string|Array} id - bookmark ID or array of bookmark IDs
- * @returns {?Array} - array of bookmarks.BookmarkTreeNode
+ * @returns {Promise.<?Array>} - array of bookmarks.BookmarkTreeNode
  */
 export const getBookmarkTreeNode = async id => {
   const isGranted = await isPermissionGranted({
@@ -66,7 +66,7 @@ export const getBookmarkTreeNode = async id => {
 /**
  * get closeTabsByDoubleClick user value
  *
- * @returns {object} - user value
+ * @returns {Promise.<object>} - user value
  */
 export const getCloseTabsByDoubleClickValue = async () => {
   const isGranted = await isPermissionGranted({
@@ -83,7 +83,7 @@ export const getCloseTabsByDoubleClickValue = async () => {
 /**
  * set context menu on mouseup
  *
- * @returns {boolean} - result
+ * @returns {Promise.<boolean>} - result
  */
 export const setContextMenuOnMouseup = async () => {
   const isGranted = await isPermissionGranted({
@@ -107,7 +107,7 @@ export const setContextMenuOnMouseup = async () => {
 /**
  * clear context menu on mouseup
  *
- * @returns {boolean} - result
+ * @returns {Promise.<boolean>} - result
  */
 export const clearContextMenuOnMouseup = async () => {
   const isGranted = await isPermissionGranted({
@@ -124,7 +124,7 @@ export const clearContextMenuOnMouseup = async () => {
 /**
  * get new tab position value
  *
- * @returns {object} - result
+ * @returns {Promise.<object>} - result
  */
 export const getNewTabPositionValue = async () => {
   const isGranted = await isPermissionGranted({
@@ -142,7 +142,7 @@ export const getNewTabPositionValue = async () => {
 /**
  * is command customizable
  *
- * @returns {boolean} - result
+ * @returns {Promise.<boolean>} - result
  */
 export const isCommandCustomizable = async () => {
   const isGranted = await isPermissionGranted({
@@ -162,7 +162,7 @@ export const isCommandCustomizable = async () => {
  *
  * @param {string} id - command ID
  * @param {string} value - key value
- * @returns {?Function} - commands.update() | commands.reset()
+ * @returns {Promise.<?void>} - commands.update() | commands.reset()
  */
 export const updateCommand = async (id, value = '') => {
   if (!isString(id)) {
@@ -192,7 +192,7 @@ export const updateCommand = async (id, value = '') => {
 /**
  * get all contextual identities
  *
- * @returns {?Array} - array of contextualIdentities.ContextualIdentity
+ * @returns {Promise.<?Array>} - array of contextualIdentities.ContextualIdentity
  */
 export const getAllContextualIdentities = async () => {
   const isGranted = await isPermissionGranted({
@@ -210,7 +210,7 @@ export const getAllContextualIdentities = async () => {
  * get contextual identities
  *
  * @param {string} cookieStoreId - cookie store ID
- * @returns {object} - contextualIdentities.ContextualIdentity
+ * @returns {Promise.<object>} - contextualIdentities.ContextualIdentity
  */
 export const getContextualId = async cookieStoreId => {
   if (!isString(cookieStoreId)) {
@@ -231,7 +231,7 @@ export const getContextualId = async cookieStoreId => {
 /**
  * get enabled theme
  *
- * @returns {?Array} - array of management.ExtensionInfo
+ * @returns {Promise.<?Array>} - array of management.ExtensionInfo
  */
 export const getEnabledTheme = async () => {
   const isGranted = await isPermissionGranted({
@@ -252,7 +252,7 @@ export const getEnabledTheme = async () => {
  * get extension info
  *
  * @param {string} id - extension ID
- * @returns {object} - management.extensionInfo
+ * @returns {Promise.<object>} - management.extensionInfo
  */
 export const getExtensionInfo = async id => {
   if (!isString(id)) {
@@ -272,7 +272,7 @@ export const getExtensionInfo = async id => {
 /**
  * get external extensions
  *
- * @returns {?Array|boolean} - array of management.extensionInfo
+ * @returns {Promise.<?Array|boolean>} - array of management.extensionInfo
  */
 export const getExternalExtensions = async () => {
   const isGranted = await isPermissionGranted({
@@ -294,7 +294,7 @@ export const getExternalExtensions = async () => {
  * clear notification
  *
  * @param {string} id - notification ID
- * @returns {?Function} - notifications.clear()
+ * @returns {Promise.<?boolean>} - notifications.clear()
  */
 export const clearNotification = async id => {
   if (!isString(id)) {
@@ -316,7 +316,7 @@ export const clearNotification = async id => {
  *
  * @param {string} id - notification ID
  * @param {object} opt - options
- * @returns {?Function} - notifications.create()
+ * @returns {Promise.<?string>} - notifications.create()
  */
 export const createNotification = async (id, opt) => {
   if (!isString(id)) {
@@ -341,7 +341,7 @@ export const createNotification = async (id, opt) => {
  * remove permission
  *
  * @param {string|Array} perm - permission
- * @returns {boolean} - result
+ * @returns {Promise.<boolean>} - result
  */
 export const removePermission = async perm => {
   if (!(isString(perm) || Array.isArray(perm))) {
@@ -364,7 +364,7 @@ export const removePermission = async perm => {
  * request permission
  *
  * @param {string|Array} perm - permission
- * @returns {boolean} - result
+ * @returns {Promise.<boolean>} - result
  */
 export const requestPermission = async perm => {
   if (!(isString(perm) || Array.isArray(perm))) {
@@ -407,7 +407,7 @@ export const getManifestVersion = () => {
 /**
  * get OS
  *
- * @returns {string} - OS
+ * @returns {Promise.<string>} - OS
  */
 export const getOs = async () => {
   const { os } = await runtime.getPlatformInfo();
@@ -419,7 +419,7 @@ export const getOs = async () => {
  *
  * @param {number|string} [id] - tab ID / extension ID / host name
  * @param {object|boolean} [info] - connection info / connect to native app
- * @returns {object} - runtime.Port
+ * @returns {Promise.<object>} - runtime.Port
  */
 export const makeConnection = async (id, info) => {
   let port;
@@ -453,7 +453,7 @@ export const makeConnection = async (id, info) => {
  * @param {number|string} id - tab ID / extension ID
  * @param {*} msg - message
  * @param {object} opt - options
- * @returns {?Function} - tabs.sendMessage() | runtime.sendMessage()
+ * @returns {Promise.<object>} - tabs.sendMessage() | runtime.sendMessage()
  */
 export const sendMessage = async (id, msg, opt) => {
   let func;
@@ -476,7 +476,7 @@ export const sendMessage = async (id, msg, opt) => {
 /**
  * is scripting available
  *
- * @returns {boolean} - result
+ * @returns {Promise.<boolean>} - result
  */
 export const isScriptingAvailable = async () => {
   const isGranted = await isPermissionGranted({
@@ -494,7 +494,7 @@ export const isScriptingAvailable = async () => {
  * execute script to tab
  *
  * @param {object} opt - options
- * @returns {?Array|boolean} - array of InjectionResult object
+ * @returns {Promise.<?Array|boolean>} - array of InjectionResult object
  */
 export const executeScriptToTab = async (opt = {}) => {
   const { args, injectImmediately, files, func, target } = opt;
@@ -526,7 +526,7 @@ export const executeScriptToTab = async (opt = {}) => {
  *
  * @param {string} query - search query
  * @param {object} opt - options
- * @returns {void}
+ * @returns {Promise.<void>} - void
  */
 export const searchWithSearchEngine = async (query, opt = {}) => {
   if (!isString(query)) {
@@ -546,8 +546,8 @@ export const searchWithSearchEngine = async (query, opt = {}) => {
 /**
  * get recently closed tab
  *
- * @param {number} windowId - window ID
- * @returns {object} - tabs.Tab
+ * @param {number} [windowId] - window ID
+ * @returns {Promise.<object>} - tabs.Tab
  */
 export const getRecentlyClosedTab = async windowId => {
   const isGranted = await isPermissionGranted({
@@ -580,8 +580,8 @@ export const getRecentlyClosedTab = async windowId => {
  * get session window value
  *
  * @param {string} key - key
- * @param {number} windowId - window ID
- * @returns {string} - value
+ * @param {number} [windowId] - window ID
+ * @returns {Promise.<?string>} - value
  */
 export const getSessionWindowValue = async (key, windowId) => {
   if (!isString(key)) {
@@ -605,7 +605,7 @@ export const getSessionWindowValue = async (key, windowId) => {
  * restore session
  *
  * @param {string} sessionId - session ID
- * @returns {object} - sessions.Session
+ * @returns {Promise.<object>} - sessions.Session
  */
 export const restoreSession = async sessionId => {
   if (!isString(sessionId)) {
@@ -627,8 +627,8 @@ export const restoreSession = async sessionId => {
  *
  * @param {string} key - key
  * @param {string|object} value - value
- * @param {number} windowId - window ID
- * @returns {void}
+ * @param {number} [windowId] - window ID
+ * @returns {Promise.<void>} - void
  */
 export const setSessionWindowValue = async (key, value, windowId) => {
   if (!isString(key)) {
@@ -651,7 +651,7 @@ export const setSessionWindowValue = async (key, value, windowId) => {
  * clear storage
  *
  * @param {string} area - storage area
- * @returns {void}
+ * @returns {Promise.<void>} - void
  */
 export const clearStorage = async (area = 'local') => {
   const isGranted = await isPermissionGranted({
@@ -668,7 +668,7 @@ export const clearStorage = async (area = 'local') => {
  * get all storage
  *
  * @param {string} area - storage area
- * @returns {object} - stored data
+ * @returns {Promise.<object>} - stored data
  */
 export const getAllStorage = async (area = 'local') => {
   const isGranted = await isPermissionGranted({
@@ -688,7 +688,7 @@ export const getAllStorage = async (area = 'local') => {
  *
  * @param {*} key - key
  * @param {string} area - storage area
- * @returns {object} - stored data
+ * @returns {Promise.<object>} - stored data
  */
 export const getStorage = async (key, area = 'local') => {
   const isGranted = await isPermissionGranted({
@@ -708,7 +708,7 @@ export const getStorage = async (key, area = 'local') => {
  *
  * @param {*} key - key
  * @param {string} area - storage area
- * @returns {void}
+ * @returns {Promise.<void>} - void
  */
 export const removeStorage = async (key, area = 'local') => {
   const isGranted = await isPermissionGranted({
@@ -726,7 +726,7 @@ export const removeStorage = async (key, area = 'local') => {
  *
  * @param {object} obj - object to store
  * @param {string} area - storage area
- * @returns {void}
+ * @returns {Promise.<void>} - void
  */
 export const setStorage = async (obj, area = 'local') => {
   const isGranted = await isPermissionGranted({
@@ -744,7 +744,7 @@ export const setStorage = async (obj, area = 'local') => {
  * create tab
  *
  * @param {object} opt - options
- * @returns {object} - tabs.Tab
+ * @returns {Promise.<object>} - tabs.Tab
  */
 export const createTab = async (opt = {}) => {
   const tab = await tabs.create(isObjectNotEmpty(opt) ? opt : null);
@@ -756,7 +756,7 @@ export const createTab = async (opt = {}) => {
  *
  * @param {number} tabId - tab ID
  * @param {object} opt - options
- * @returns {object} - tabs.Tab
+ * @returns {Promise.<object>} - tabs.Tab
  */
 export const duplicateTab = async (tabId, opt) => {
   if (!Number.isInteger(tabId)) {
@@ -770,7 +770,7 @@ export const duplicateTab = async (tabId, opt) => {
  * query tabs
  *
  * @param {object} opt - options
- * @returns {?Array} - result
+ * @returns {Promise.<?Array>} - result
  */
 export const queryTabs = async opt => {
   const res = await tabs.query(opt);
@@ -782,7 +782,7 @@ export const queryTabs = async opt => {
  *
  * @param {number|object} tabId - tab ID or options
  * @param {object} opt - options
- * @returns {?Array|boolean} - result
+ * @returns {Promise.<?Array|boolean>} - result
  */
 export const execScriptToTab = async (tabId, opt = {}) => {
   let res;
@@ -829,7 +829,7 @@ export const execScriptToTabs = async (opt = {}) => {
  *
  * @param {number|Array} tabId - tabId or array of options
  * @param {Array} opts - array of options
- * @returns {*} - result of the last executed script
+ * @returns {Promise.<*>} - result of the last executed script
  */
 export const execScriptsToTabInOrder = async (tabId, opts = []) => {
   const func = [];
@@ -859,8 +859,8 @@ export const execScriptsToTabInOrder = async (tabId, opts = []) => {
 /**
  * get active tab
  *
- * @param {number} windowId - window ID
- * @returns {object} - tabs.Tab
+ * @param {number} [windowId] - window ID
+ * @returns {Promise.<object>} - tabs.Tab
  */
 export const getActiveTab = async windowId => {
   if (!Number.isInteger(windowId)) {
@@ -877,8 +877,8 @@ export const getActiveTab = async windowId => {
 /**
  * get active tab ID
  *
- * @param {number} windowId - window ID
- * @returns {?number} - tab ID
+ * @param {number} [windowId] - window ID
+ * @returns {Promise.<?number>} - tab ID
  */
 export const getActiveTabId = async windowId => {
   if (!Number.isInteger(windowId)) {
@@ -895,8 +895,8 @@ export const getActiveTabId = async windowId => {
 /**
  * get all tabs in window
  *
- * @param {number} windowId - window ID
- * @returns {?Array} - array of tabs.Tab
+ * @param {number} [windowId] - window ID
+ * @returns {Promise.<?Array>} - array of tabs.Tab
  */
 export const getAllTabsInWindow = async windowId => {
   if (!Number.isInteger(windowId)) {
@@ -912,8 +912,8 @@ export const getAllTabsInWindow = async windowId => {
 /**
  * get highlighted tab
  *
- * @param {number} windowId - window ID
- * @returns {?Array} - array of tabs.Tab
+ * @param {number} [windowId] - window ID
+ * @returns {Promise.<?Array>} - array of tabs.Tab
  */
 export const getHighlightedTab = async windowId => {
   if (!Number.isInteger(windowId)) {
@@ -931,7 +931,7 @@ export const getHighlightedTab = async windowId => {
  * get tab
  *
  * @param {number} tabId - tab ID
- * @returns {object} - tabs.Tab
+ * @returns {Promise.<object>} - tabs.Tab
  */
 export const getTab = async tabId => {
   if (!Number.isInteger(tabId)) {
@@ -945,8 +945,8 @@ export const getTab = async tabId => {
  * highlight tab
  *
  * @param {number|Array} index - tab index
- * @param {number} windowId - window ID
- * @returns {object} - windows.Window
+ * @param {number} [windowId] - window ID
+ * @returns {Promise.<object>} - windows.Window
  */
 export const highlightTab = async (index, windowId) => {
   if (!(Array.isArray(index) || Number.isInteger(index))) {
@@ -967,8 +967,8 @@ export const highlightTab = async (index, windowId) => {
  * move tab
  *
  * @param {number|Array} tabId - tab ID
- * @param {object} opt - options
- * @returns {?Array} - array of tabs.Tab
+ * @param {object} [opt] - options
+ * @returns {Promise.<?Array>} - array of tabs.Tab
  */
 export const moveTab = async (tabId, opt) => {
   if (!(Array.isArray(tabId) || Number.isInteger(tabId))) {
@@ -978,7 +978,7 @@ export const moveTab = async (tabId, opt) => {
   if (arr && !Array.isArray(arr)) {
     arr = [arr];
   }
-  return arr ?? null;
+  return arr || null;
 };
 
 /**
@@ -986,7 +986,7 @@ export const moveTab = async (tabId, opt) => {
  *
  * @param {number} tabId - tab ID
  * @param {object} opt - options
- * @returns {void}
+ * @returns {Promise.<void>} - void
  */
 export const reloadTab = async (tabId, opt) => {
   if (!Number.isInteger(tabId)) {
@@ -999,7 +999,7 @@ export const reloadTab = async (tabId, opt) => {
  * remove tab
  *
  * @param {number|Array} arg - tab ID or array of tab ID
- * @returns {void}
+ * @returns {Promise.<void>} - void
  */
 export const removeTab = async arg => {
   if (Number.isInteger(arg)) {
@@ -1016,7 +1016,7 @@ export const removeTab = async arg => {
  *
  * @param {number} tabId - tab ID
  * @param {object} opt - options
- * @returns {object} - tabs.Tab
+ * @returns {Promise.<object>} - tabs.Tab
  */
 export const updateTab = async (tabId, opt) => {
   if (!Number.isInteger(tabId)) {
@@ -1030,7 +1030,7 @@ export const updateTab = async (tabId, opt) => {
  * warmup tab
  *
  * @param {number} tabId - tab ID
- * @returns {void}
+ * @returns {Promise.<void>} - void
  */
 export const warmupTab = async tabId => {
   if (!Number.isInteger(tabId)) {
@@ -1045,7 +1045,7 @@ export const warmupTab = async tabId => {
  * is tab
  *
  * @param {*} tabId - tab ID
- * @returns {boolean} - result
+ * @returns {Promise.<boolean>} - result
  */
 export const isTab = async tabId => {
   if (!Number.isInteger(tabId)) {
@@ -1066,8 +1066,8 @@ export const isTab = async tabId => {
 /**
  * get current theme
  *
- * @param {number} windowId - window ID
- * @returns {object} - theme.Theme
+ * @param {number} [windowId] - window ID
+ * @returns {Promise.<object>} - theme.Theme
  */
 export const getCurrentTheme = async windowId => {
   const isGranted = await isPermissionGranted({
@@ -1087,7 +1087,7 @@ export const getCurrentTheme = async windowId => {
  * create new window
  *
  * @param {object} opt - options
- * @returns {object} - windows.Window
+ * @returns {Promise.<object>} - windows.Window
  */
 export const createNewWindow = async opt => {
   const win = await windows.create(isObjectNotEmpty(opt) ? opt : null);
@@ -1098,7 +1098,7 @@ export const createNewWindow = async opt => {
  * get all windows
  *
  * @param {boolean} populate - populate tabs
- * @returns {Array} - array of windows.Window
+ * @returns {Promise.<Array>} - array of windows.Window
  */
 export const getAllNormalWindows = async (populate = false) => {
   const arr = await windows.getAll({
@@ -1112,7 +1112,7 @@ export const getAllNormalWindows = async (populate = false) => {
  * get current window
  *
  * @param {object} opt - options
- * @returns {object} - windows.Window
+ * @returns {Promise.<object>} - windows.Window
  */
 export const getCurrentWindow = async opt => {
   const win = await windows.getCurrent(isObjectNotEmpty(opt) ? opt : null);
@@ -1124,7 +1124,7 @@ export const getCurrentWindow = async opt => {
  *
  * @param {number} windowId - window ID
  * @param {object} opt - options
- * @returns {object} - windows.Window
+ * @returns {Promise.<object>} - windows.Window
  */
 export const getWindow = async (windowId, opt) => {
   if (!Number.isInteger(windowId)) {
@@ -1137,7 +1137,7 @@ export const getWindow = async (windowId, opt) => {
 /**
  * check whether incognito window exists
  *
- * @returns {boolean} - result
+ * @returns {Promise.<boolean>} - result
  */
 export const checkIncognitoWindowExists = async () => {
   const arr = await getAllNormalWindows();

package/modules/commander.js

@@ -0,0 +1,58 @@
+/**
+ * commander.js
+ */
+
+/* api */
+import path from 'node:path';
+import process from 'node:process';
+import { program as commander } from 'commander';
+import { isDir, removeDir } from './file-util.js';
+import { updateSchemas } from './update.js';
+
+/* constants */
+const DIR_CWD = process.cwd();
+
+/**
+ * clean directory
+ *
+ * @param {object} cmdOpts - command options
+ * @returns {void}
+ */
+export const cleanDirectory = (cmdOpts = {}) => {
+  const { dir, info } = cmdOpts;
+  if (isDir(dir)) {
+    removeDir(path.resolve(dir), DIR_CWD);
+    if (info) {
+      console.info(`Removed: ${path.resolve(dir)}`);
+    }
+  }
+};
+
+/**
+ * parse command
+ *
+ * @param {Array} args - process.argv
+ * @returns {void}
+ */
+export const parseCommand = args => {
+  const reg = /^(?:(?:--)?help|-[h|v]|--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');
+    commander.command('clean').alias('c')
+      .description('clean directory')
+      .option('-d, --dir <name>', 'specify directory')
+      .option('-i, --info', 'console info')
+      .action(cleanDirectory);
+    commander.command('update').alias('u').description('update schemas')
+      .option('-c, --channel <name>', 'specify the release channel')
+      .option('-i, --info', 'console info')
+      .action(updateSchemas);
+    commander.parse(args);
+  }
+};
+
+/* For test */
+export {
+  commander
+};

package/modules/file-util.js

@@ -158,7 +158,7 @@ export const removeDir = (dir, baseDir) => {
  *
  * @param {string} dir - directory path
  * @param {string} baseDir - base directory path
- * @returns {void}
+ * @returns {Promise.<void>} - void
  */
 export const removeDirectory = async (dir, baseDir) => {
   if (isDir(dir)) {
@@ -177,7 +177,7 @@ export const removeDirectory = async (dir, baseDir) => {
  *
  * @param {string} dir - directory path to create
  * @param {number} [mode] - permission
- * @returns {string} - directory path
+ * @returns {Promise.<string>} - directory path
  */
 export const createDirectory = async (dir, mode = PERM_DIR) => {
   if (!isString(dir)) {
@@ -204,7 +204,7 @@ export const createDirectory = async (dir, mode = PERM_DIR) => {
  * @param {string} [opt.encoding] - encoding
  * @param {string} [opt.flag] - flag
  * @param {number|string} [opt.mode] - file permission
- * @returns {string} - file path
+ * @returns {Promise.<string>} - file path
  */
 export const createFile = async (file, value, opt = {
   encoding: null, flag: 'w', mode: PERM_FILE
@@ -230,7 +230,7 @@ export const createFile = async (file, value, opt = {
  * @param {object} [opt] - options
  * @param {string} [opt.encoding] - encoding
  * @param {string} [opt.flag] - flag
- * @returns {string|Buffer} - file content
+ * @returns {Promise.<string|Buffer>} - file content
  */
 export const readFile = async (file, opt = { encoding: null, flag: 'r' }) => {
   if (!isFile(file)) {

package/modules/update.js

@@ -6,7 +6,6 @@
 import path from 'node:path';
 import process from 'node:process';
 import JSON5 from 'json5';
-import { program as commander } from 'commander';
 import { getType, isString } from './common.js';
 import { createFile } from './file-util.js';
 import { CHAR, INDENT } from './constant.js';
@@ -20,7 +19,7 @@ export const ESR_VER = 102;
  * fetch text
  *
  * @param {string} url - URL
- * @returns {string} - content text
+ * @returns {Promise.<string>} - content text
  */
 export const fetchText = async url => {
   if (!isString(url)) {
@@ -67,7 +66,7 @@ export const getChannelUrl = channel => {
  *
  * @param {string} file - file name
  * @param {string} baseUrl - base URL
- * @returns {object} - schema data
+ * @returns {Promise.<object>} - schema data
  */
 export const getSchemaData = async (file, baseUrl) => {
   if (!isString(file)) {
@@ -88,7 +87,7 @@ export const getSchemaData = async (file, baseUrl) => {
  * get schema file list from jar manifest
  *
  * @param {string} baseUrl - base URL
- * @returns {Array} - schema file list
+ * @returns {Promise.<Array.<string>>} - schema file list
  */
 export const getFileList = async baseUrl => {
   if (!isString(baseUrl)) {
@@ -176,7 +175,7 @@ export const getMailExtSchemaData = async baseUrl => {
  * create unified schema
  *
  * @param {string} channel - release channel
- * @returns {object} - schema
+ * @returns {Promise.<object>} - schema
  */
 export const createUnifiedSchema = async channel => {
   const channelUrl = getChannelUrl(channel);
@@ -220,7 +219,7 @@ export const createUnifiedSchema = async channel => {
  *
  * @param {string} channel - release channel
  * @param {boolean} info - console info
- * @returns {string} - file path
+ * @returns {Promise.<string>} - file path
  */
 export const saveSchemaFile = async (channel, info) => {
   if (!isString(channel)) {
@@ -244,7 +243,7 @@ export const saveSchemaFile = async (channel, info) => {
  * update schemas files
  *
  * @param {object} cmdOpts - command options
- * @returns {void}
+ * @returns {Promise.<void>} - void
  */
 export const updateSchemas = async (cmdOpts = {}) => {
   const { channel, info } = cmdOpts;
@@ -268,26 +267,3 @@ export const updateSchemas = async (cmdOpts = {}) => {
     }
   }
 };
-
-/**
- * parse command
- *
- * @param {Array} args - process.argv
- * @returns {void}
- */
-export const parseCommand = args => {
-  const reg = /^(?:(?:--)?help|-[h|v]|--version|u(?:pdate)?)$/;
-  if (Array.isArray(args) && args.some(arg => reg.test(arg))) {
-    commander.exitOverride();
-    commander.version(process.env.npm_package_version, '-v, --version');
-    commander.command('update').alias('u').description('update schemas')
-      .option('-c, --channel <name>', 'specify the release channel')
-      .option('-i, --info', 'console info')
-      .action(updateSchemas);
-    commander.parse(args);
-  }
-};
-
-export {
-  commander
-};

package/package.json

@@ -13,7 +13,8 @@
   "main": "index.js",
   "types": "types/index.d.ts",
   "dependencies": {
-    "@types/node": "^18.14.0",
+    "@types/firefox-webext-browser": "^109.0.0",
+    "@types/node": "^18.14.1",
     "@types/sinon": "^10.0.13",
     "camelize": "^1.0.1",
     "commander": "^10.0.0",
@@ -22,9 +23,9 @@
     "sinon": "^15.0.1"
   },
   "devDependencies": {
-    "c8": "^7.12.0",
+    "c8": "^7.13.0",
     "chai": "^4.3.7",
-    "eslint": "^8.34.0",
+    "eslint": "^8.35.0",
     "eslint-config-standard": "^17.0.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsdoc": "^40.0.0",
@@ -34,7 +35,7 @@
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
     "typescript": "^4.9.5",
-    "undici": "^5.19.1"
+    "undici": "^5.20.0"
   },
   "scripts": {
     "build": "npm run tsc && npm run lint && npm run test",
@@ -46,7 +47,7 @@
     "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",
     "test_all": "npm-run-all -s test-*",
-    "tsc": "node -e \"fs.rmSync('types',{recursive:true,force:true})\" && npx tsc",
+    "tsc": "node index clean --dir=types -i && npx tsc",
     "update": "node index update -i",
     "update-beta": "node index update --channel=beta -i",
     "update-central": "node index update --channel=central -i",
@@ -54,5 +55,5 @@
     "update-mail": "node index update --channel=mail -i",
     "update-release": "node index update --channel=release -i"
   },
-  "version": "5.1.4"
+  "version": "5.1.6"
 }

package/tsconfig.json

@@ -1,12 +1,16 @@
 {
-  "include": ["index.js"],
   "compilerOptions": {
     "allowJs": true,
     "allowSyntheticDefaultImports": true,
     "declaration": true,
     "declarationDir": "types",
     "emitDeclarationOnly": true,
+    "module": "esnext",
+    "moduleResolution": "node",
     "newLine": "LF",
-    "removeComments": true
-  }
+    "removeComments": true,
+    "resolveJsonModule": true,
+    "target": "esnext"
+  },
+  "include": ["index.js", "modules/browser.js"]
 }

package/types/modules/browser.d.ts

@@ -0,0 +1,59 @@
+export function isPermissionGranted(perm: object): Promise<boolean>;
+export function createBookmark(opt: object): Promise<object>;
+export function getBookmarkTreeNode(id: string | any[]): Promise<any[] | null>;
+export function getCloseTabsByDoubleClickValue(): Promise<object>;
+export function setContextMenuOnMouseup(): Promise<boolean>;
+export function clearContextMenuOnMouseup(): Promise<boolean>;
+export function getNewTabPositionValue(): Promise<object>;
+export function isCommandCustomizable(): Promise<boolean>;
+export function updateCommand(id: string, value?: string): Promise<void | null>;
+export function getAllContextualIdentities(): Promise<any[] | null>;
+export function getContextualId(cookieStoreId: string): Promise<object>;
+export function getEnabledTheme(): Promise<any[] | null>;
+export function getExtensionInfo(id: string): Promise<object>;
+export function getExternalExtensions(): Promise<(any[] | boolean) | null>;
+export function clearNotification(id: string): Promise<boolean | null>;
+export function createNotification(id: string, opt: object): Promise<string | null>;
+export function removePermission(perm: string | any[]): Promise<boolean>;
+export function requestPermission(perm: string | any[]): Promise<boolean>;
+export function getManifestIcons(): object | string;
+export function getManifestVersion(): number;
+export function getOs(): Promise<string>;
+export function makeConnection(id?: number | string, info?: object | boolean): Promise<object>;
+export function sendMessage(id: number | string, msg: any, opt: object): Promise<object>;
+export function isScriptingAvailable(): Promise<boolean>;
+export function executeScriptToTab(opt?: object): Promise<(any[] | boolean) | null>;
+export function searchWithSearchEngine(query: string, opt?: object): Promise<void>;
+export function getRecentlyClosedTab(windowId?: number): Promise<object>;
+export function getSessionWindowValue(key: string, windowId?: number): Promise<string | null>;
+export function restoreSession(sessionId: string): Promise<object>;
+export function setSessionWindowValue(key: string, value: string | object, windowId?: number): Promise<void>;
+export function clearStorage(area?: string): Promise<void>;
+export function getAllStorage(area?: string): Promise<object>;
+export function getStorage(key: any, area?: string): Promise<object>;
+export function removeStorage(key: any, area?: string): Promise<void>;
+export function setStorage(obj: object, area?: string): Promise<void>;
+export function createTab(opt?: object): Promise<object>;
+export function duplicateTab(tabId: number, opt: object): Promise<object>;
+export function queryTabs(opt: object): Promise<any[] | null>;
+export function execScriptToTab(tabId: number | object, opt?: object): Promise<(any[] | boolean) | null>;
+export function execScriptToTabs(opt?: object): Promise<any[]>;
+export function execScriptsToTabInOrder(tabId: number | any[], opts?: any[]): Promise<any>;
+export function getActiveTab(windowId?: number): Promise<object>;
+export function getActiveTabId(windowId?: number): Promise<number | null>;
+export function getAllTabsInWindow(windowId?: number): Promise<any[] | null>;
+export function getHighlightedTab(windowId?: number): Promise<any[] | null>;
+export function getTab(tabId: number): Promise<object>;
+export function highlightTab(index: number | any[], windowId?: number): Promise<object>;
+export function moveTab(tabId: number | any[], opt?: object): Promise<any[] | null>;
+export function reloadTab(tabId: number, opt: object): Promise<void>;
+export function removeTab(arg: number | any[]): Promise<void>;
+export function updateTab(tabId: number, opt: object): Promise<object>;
+export function warmupTab(tabId: number): Promise<void>;
+export function isTab(tabId: any): Promise<boolean>;
+export function getCurrentTheme(windowId?: number): Promise<object>;
+export function createNewWindow(opt: object): Promise<object>;
+export function getAllNormalWindows(populate?: boolean): Promise<any[]>;
+export function getCurrentWindow(opt: object): Promise<object>;
+export function getWindow(windowId: number, opt: object): Promise<object>;
+export function checkIncognitoWindowExists(): Promise<boolean>;

package/types/modules/commander.d.ts

@@ -0,0 +1,4 @@
+export function cleanDirectory(cmdOpts?: object): void;
+export function parseCommand(args: any[]): void;
+export { commander };
+import { program as commander } from "commander";

package/types/modules/file-util.d.ts

@@ -8,14 +8,14 @@ export function isExecutable(file: string, mask?: number): boolean;
 export function getFileTimestamp(file: string): number;
 export function getFileNameFromFilePath(file: string, subst?: string): string;
 export function removeDir(dir: string, baseDir: string): void;
-export function removeDirectory(dir: string, baseDir: string): void;
-export function createDirectory(dir: string, mode?: number): string;
+export function removeDirectory(dir: string, baseDir: string): Promise<void>;
+export function createDirectory(dir: string, mode?: number): Promise<string>;
 export function createFile(file: string, value: string | Buffer | Uint8Array, opt?: {
     encoding?: string;
     flag?: string;
     mode?: number | string;
-}): string;
+}): Promise<string>;
 export function readFile(file: string, opt?: {
     encoding?: string;
     flag?: string;
-}): string | Buffer;
+}): Promise<string | Buffer>;

package/types/modules/update.d.ts

@@ -1,14 +1,11 @@
 export const ESR_VER: 102;
-export function fetchText(url: string): string;
+export function fetchText(url: string): Promise<string>;
 export function getChannelUrl(channel: string): string;
-export function getSchemaData(file: string, baseUrl: string): object;
-export function getFileList(baseUrl: string): any[];
+export function getSchemaData(file: string, baseUrl: string): Promise<object>;
+export function getFileList(baseUrl: string): Promise<Array<string>>;
 export function getAllSchemaData(baseUrl: string): Promise<any[]>;
 export function getListedSchemaData(baseUrl: string, arr: any[]): Promise<any[]>;
 export function getMailExtSchemaData(baseUrl: string): Promise<any[]>;
-export function createUnifiedSchema(channel: string): object;
-export function saveSchemaFile(channel: string, info: boolean): string;
-export function updateSchemas(cmdOpts?: object): void;
-export function parseCommand(args: any[]): void;
-export { commander };
-import { program as commander } from "commander";
+export function createUnifiedSchema(channel: string): Promise<object>;
+export function saveSchemaFile(channel: string, info: boolean): Promise<string>;
+export function updateSchemas(cmdOpts?: object): Promise<void>;