webext-schema 5.1.13 → 5.1.15

package/modules/browser.js

@@ -10,7 +10,6 @@ const { permissions, runtime, tabs, windows } = browser;
 
 /**
  * check if permission is granted
- *
  * @param {object} perm - permissions.Permission
  * @returns {Promise.<boolean>} - result
  */
@@ -22,7 +21,6 @@ export const isPermissionGranted = async perm => {
 /* bookmarks */
 /**
  * create bookmark
- *
  * @param {object} opt - bookmarks.CreateDetails
  * @returns {Promise.<object>} - bookmarks.BookmarkTreeNode
  */
@@ -40,7 +38,6 @@ 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
  */
@@ -65,7 +62,6 @@ export const getBookmarkTreeNode = async id => {
 /* browserSettings */
 /**
  * get closeTabsByDoubleClick user value
- *
  * @returns {Promise.<object>} - user value
  */
 export const getCloseTabsByDoubleClickValue = async () => {
@@ -82,7 +78,6 @@ export const getCloseTabsByDoubleClickValue = async () => {
 
 /**
  * set context menu on mouseup
- *
  * @returns {Promise.<boolean>} - result
  */
 export const setContextMenuOnMouseup = async () => {
@@ -106,7 +101,6 @@ export const setContextMenuOnMouseup = async () => {
 
 /**
  * clear context menu on mouseup
- *
  * @returns {Promise.<boolean>} - result
  */
 export const clearContextMenuOnMouseup = async () => {
@@ -123,7 +117,6 @@ export const clearContextMenuOnMouseup = async () => {
 
 /**
  * get new tab position value
- *
  * @returns {Promise.<object>} - result
  */
 export const getNewTabPositionValue = async () => {
@@ -141,7 +134,6 @@ export const getNewTabPositionValue = async () => {
 /* commands */
 /**
  * is command customizable
- *
  * @returns {Promise.<boolean>} - result
  */
 export const isCommandCustomizable = async () => {
@@ -159,7 +151,6 @@ export const isCommandCustomizable = async () => {
 
 /**
  * update command
- *
  * @param {string} id - command ID
  * @param {string} value - key value
  * @returns {Promise.<?void>} - commands.update() | commands.reset()
@@ -191,7 +182,6 @@ export const updateCommand = async (id, value = '') => {
 /* contextualIdentities */
 /**
  * get all contextual identities
- *
  * @returns {Promise.<?Array>} - array of contextualIdentities.ContextualIdentity
  */
 export const getAllContextualIdentities = async () => {
@@ -208,7 +198,6 @@ export const getAllContextualIdentities = async () => {
 
 /**
  * get contextual identities
- *
  * @param {string} cookieStoreId - cookie store ID
  * @returns {Promise.<object>} - contextualIdentities.ContextualIdentity
  */
@@ -230,7 +219,6 @@ export const getContextualId = async cookieStoreId => {
 /* management */
 /**
  * get enabled theme
- *
  * @returns {Promise.<?Array>} - array of management.ExtensionInfo
  */
 export const getEnabledTheme = async () => {
@@ -250,7 +238,6 @@ export const getEnabledTheme = async () => {
 
 /**
  * get extension info
- *
  * @param {string} id - extension ID
  * @returns {Promise.<object>} - management.extensionInfo
  */
@@ -271,7 +258,6 @@ export const getExtensionInfo = async id => {
 
 /**
  * get external extensions
- *
  * @returns {Promise.<?Array|boolean>} - array of management.extensionInfo
  */
 export const getExternalExtensions = async () => {
@@ -292,7 +278,6 @@ export const getExternalExtensions = async () => {
 /* notifications */
 /**
  * clear notification
- *
  * @param {string} id - notification ID
  * @returns {Promise.<?boolean>} - notifications.clear()
  */
@@ -313,7 +298,6 @@ export const clearNotification = async id => {
 
 /**
  * create notification
- *
  * @param {string} id - notification ID
  * @param {object} opt - options
  * @returns {Promise.<?string>} - notifications.create()
@@ -339,7 +323,6 @@ export const createNotification = async (id, opt) => {
 /* permissions */
 /**
  * remove permission
- *
  * @param {string|Array} perm - permission
  * @returns {Promise.<boolean>} - result
  */
@@ -362,7 +345,6 @@ export const removePermission = async perm => {
 
 /**
  * request permission
- *
  * @param {string|Array} perm - permission
  * @returns {Promise.<boolean>} - result
  */
@@ -386,7 +368,6 @@ export const requestPermission = async perm => {
 /* runtime */
 /**
  * get manifest icons
- *
  * @returns {object|string} - icons
  */
 export const getManifestIcons = () => {
@@ -396,7 +377,6 @@ export const getManifestIcons = () => {
 
 /**
  * get manifest version
- *
  * @returns {number} - version
  */
 export const getManifestVersion = () => {
@@ -406,7 +386,6 @@ export const getManifestVersion = () => {
 
 /**
  * get OS
- *
  * @returns {Promise.<string>} - OS
  */
 export const getOs = async () => {
@@ -416,7 +395,6 @@ export const getOs = async () => {
 
 /**
  * make a connection
- *
  * @param {number|string} [id] - tab ID / extension ID / host name
  * @param {object|boolean} [info] - connection info / connect to native app
  * @returns {Promise.<object>} - runtime.Port
@@ -449,7 +427,6 @@ export const makeConnection = async (id, info) => {
 
 /**
  * send message
- *
  * @param {number|string} id - tab ID / extension ID
  * @param {*} msg - message
  * @param {object} opt - options
@@ -475,7 +452,6 @@ export const sendMessage = async (id, msg, opt) => {
 /* scripting */
 /**
  * is scripting available
- *
  * @returns {Promise.<boolean>} - result
  */
 export const isScriptingAvailable = async () => {
@@ -492,7 +468,6 @@ export const isScriptingAvailable = async () => {
 
 /**
  * execute script to tab
- *
  * @param {object} opt - options
  * @returns {Promise.<?Array|boolean>} - array of InjectionResult object
  */
@@ -523,7 +498,6 @@ export const executeScriptToTab = async (opt = {}) => {
 /* search */
 /**
  * search with a search engine
- *
  * @param {string} query - search query
  * @param {object} opt - options
  * @returns {Promise.<void>} - void
@@ -545,7 +519,6 @@ export const searchWithSearchEngine = async (query, opt = {}) => {
 /* sessions */
 /**
  * get recently closed tab
- *
  * @param {number} [windowId] - window ID
  * @returns {Promise.<object>} - tabs.Tab
  */
@@ -578,7 +551,6 @@ export const getRecentlyClosedTab = async windowId => {
 
 /**
  * get session window value
- *
  * @param {string} key - key
  * @param {number} [windowId] - window ID
  * @returns {Promise.<?string>} - value
@@ -603,7 +575,6 @@ export const getSessionWindowValue = async (key, windowId) => {
 
 /**
  * restore session
- *
  * @param {string} sessionId - session ID
  * @returns {Promise.<object>} - sessions.Session
  */
@@ -624,7 +595,6 @@ export const restoreSession = async sessionId => {
 
 /**
  * set session window value
- *
  * @param {string} key - key
  * @param {string|object} value - value
  * @param {number} [windowId] - window ID
@@ -649,7 +619,6 @@ export const setSessionWindowValue = async (key, value, windowId) => {
 /* storage */
 /**
  * clear storage
- *
  * @param {string} area - storage area
  * @returns {Promise.<void>} - void
  */
@@ -666,7 +635,6 @@ export const clearStorage = async (area = 'local') => {
 
 /**
  * get all storage
- *
  * @param {string} area - storage area
  * @returns {Promise.<object>} - stored data
  */
@@ -685,7 +653,6 @@ export const getAllStorage = async (area = 'local') => {
 
 /**
  * get storage
- *
  * @param {*} key - key
  * @param {string} area - storage area
  * @returns {Promise.<object>} - stored data
@@ -705,7 +672,6 @@ export const getStorage = async (key, area = 'local') => {
 
 /**
  * remove storage
- *
  * @param {*} key - key
  * @param {string} area - storage area
  * @returns {Promise.<void>} - void
@@ -723,7 +689,6 @@ export const removeStorage = async (key, area = 'local') => {
 
 /**
  * set storage
- *
  * @param {object} obj - object to store
  * @param {string} area - storage area
  * @returns {Promise.<void>} - void
@@ -742,7 +707,6 @@ export const setStorage = async (obj, area = 'local') => {
 /* tabs */
 /**
  * create tab
- *
  * @param {object} opt - options
  * @returns {Promise.<object>} - tabs.Tab
  */
@@ -753,7 +717,6 @@ export const createTab = async (opt = {}) => {
 
 /**
  * duplicate tab
- *
  * @param {number} tabId - tab ID
  * @param {object} opt - options
  * @returns {Promise.<object>} - tabs.Tab
@@ -768,7 +731,6 @@ export const duplicateTab = async (tabId, opt) => {
 
 /**
  * query tabs
- *
  * @param {object} opt - options
  * @returns {Promise.<?Array>} - result
  */
@@ -779,7 +741,6 @@ export const queryTabs = async opt => {
 
 /**
  * execute content script to existing tab
- *
  * @param {number|object} tabId - tab ID or options
  * @param {object} opt - options
  * @returns {Promise.<?Array|boolean>} - result
@@ -804,7 +765,6 @@ export const execScriptToTab = async (tabId, opt = {}) => {
 
 /**
  * execute content script to existing tabs
- *
  * @param {object} opt - options
  * @returns {Promise.<Array>} - results of each handler
  */
@@ -826,7 +786,6 @@ export const execScriptToTabs = async (opt = {}) => {
 
 /**
  * execute scripts to tab in order
- *
  * @param {number|Array} tabId - tabId or array of options
  * @param {Array} opts - array of options
  * @returns {Promise.<*>} - result of the last executed script
@@ -858,7 +817,6 @@ export const execScriptsToTabInOrder = async (tabId, opts = []) => {
 
 /**
  * get active tab
- *
  * @param {number} [windowId] - window ID
  * @returns {Promise.<object>} - tabs.Tab
  */
@@ -876,7 +834,6 @@ export const getActiveTab = async windowId => {
 
 /**
  * get active tab ID
- *
  * @param {number} [windowId] - window ID
  * @returns {Promise.<?number>} - tab ID
  */
@@ -894,7 +851,6 @@ export const getActiveTabId = async windowId => {
 
 /**
  * get all tabs in window
- *
  * @param {number} [windowId] - window ID
  * @returns {Promise.<?Array>} - array of tabs.Tab
  */
@@ -911,7 +867,6 @@ export const getAllTabsInWindow = async windowId => {
 
 /**
  * get highlighted tab
- *
  * @param {number} [windowId] - window ID
  * @returns {Promise.<?Array>} - array of tabs.Tab
  */
@@ -929,7 +884,6 @@ export const getHighlightedTab = async windowId => {
 
 /**
  * get tab
- *
  * @param {number} tabId - tab ID
  * @returns {Promise.<object>} - tabs.Tab
  */
@@ -943,7 +897,6 @@ export const getTab = async tabId => {
 
 /**
  * highlight tab
- *
  * @param {number|Array} index - tab index
  * @param {number} [windowId] - window ID
  * @returns {Promise.<object>} - windows.Window
@@ -965,7 +918,6 @@ 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
@@ -983,7 +935,6 @@ export const moveTab = async (tabId, opt) => {
 
 /**
  * reload tab
- *
  * @param {number} tabId - tab ID
  * @param {object} opt - options
  * @returns {Promise.<void>} - void
@@ -997,7 +948,6 @@ export const reloadTab = async (tabId, opt) => {
 
 /**
  * remove tab
- *
  * @param {number|Array} arg - tab ID or array of tab ID
  * @returns {Promise.<void>} - void
  */
@@ -1013,7 +963,6 @@ export const removeTab = async arg => {
 
 /**
  * update tab
- *
  * @param {number} tabId - tab ID
  * @param {object} opt - options
  * @returns {Promise.<object>} - tabs.Tab
@@ -1028,7 +977,6 @@ export const updateTab = async (tabId, opt) => {
 
 /**
  * warmup tab
- *
  * @param {number} tabId - tab ID
  * @returns {Promise.<void>} - void
  */
@@ -1043,7 +991,6 @@ export const warmupTab = async tabId => {
 
 /**
  * is tab
- *
  * @param {*} tabId - tab ID
  * @returns {Promise.<boolean>} - result
  */
@@ -1065,7 +1012,6 @@ export const isTab = async tabId => {
 /* theme */
 /**
  * get current theme
- *
  * @param {number} [windowId] - window ID
  * @returns {Promise.<object>} - theme.Theme
  */
@@ -1085,7 +1031,6 @@ export const getCurrentTheme = async windowId => {
 /* windows */
 /**
  * create new window
- *
  * @param {object} opt - options
  * @returns {Promise.<object>} - windows.Window
  */
@@ -1096,7 +1041,6 @@ export const createNewWindow = async opt => {
 
 /**
  * get all windows
- *
  * @param {boolean} populate - populate tabs
  * @returns {Promise.<Array>} - array of windows.Window
  */
@@ -1110,7 +1054,6 @@ export const getAllNormalWindows = async (populate = false) => {
 
 /**
  * get current window
- *
  * @param {object} opt - options
  * @returns {Promise.<object>} - windows.Window
  */
@@ -1121,7 +1064,6 @@ export const getCurrentWindow = async opt => {
 
 /**
  * get window
- *
  * @param {number} windowId - window ID
  * @param {object} opt - options
  * @returns {Promise.<object>} - windows.Window
@@ -1136,7 +1078,6 @@ export const getWindow = async (windowId, opt) => {
 
 /**
  * check whether incognito window exists
- *
  * @returns {Promise.<boolean>} - result
  */
 export const checkIncognitoWindowExists = async () => {

package/modules/commander.js

@@ -14,7 +14,6 @@ const DIR_CWD = process.cwd();
 
 /**
  * clean directory
- *
  * @param {object} cmdOpts - command options
  * @returns {void}
  */
@@ -30,7 +29,6 @@ export const cleanDirectory = (cmdOpts = {}) => {
 
 /**
  * parse command
- *
  * @param {Array} args - process.argv
  * @returns {void}
  */

package/modules/common.js

@@ -8,7 +8,6 @@ const TYPE_TO = -1;
 
 /**
  * throw error
- *
  * @param {!object} e - Error
  * @throws - Error
  */
@@ -18,7 +17,6 @@ export const throwErr = e => {
 
 /**
  * log error
- *
  * @param {!object} e - Error
  * @returns {boolean} - false
  */
@@ -29,7 +27,6 @@ export const logErr = e => {
 
 /**
  * log warn
- *
  * @param {*} msg - message
  * @returns {boolean} - false
  */
@@ -40,7 +37,6 @@ export const logWarn = msg => {
 
 /**
  * log message
- *
  * @param {*} msg - message
  * @returns {*} - message
  */
@@ -51,7 +47,6 @@ export const logMsg = msg => {
 
 /**
  * get type
- *
  * @param {*} o - object to check
  * @returns {string} - type of object
  */
@@ -60,7 +55,6 @@ export const getType = o =>
 
 /**
  * is object, and not an empty object
- *
  * @param {*} o - object to check;
  * @returns {boolean} - result
  */
@@ -71,7 +65,6 @@ export const isObjectNotEmpty = o => {
 
 /**
  * is string
- *
  * @param {*} o - object to check
  * @returns {boolean} - result
  */

package/modules/file-util.js

@@ -17,7 +17,6 @@ const SUBST = 'index';
 
 /**
  * convert URI to native file path
- *
  * @param {string} uri - URI
  * @returns {?string} - file path
  */
@@ -35,7 +34,6 @@ export const convertUriToFilePath = uri => {
 
 /**
  * get absolute path
- *
  * @param {string} file - file path
  * @returns {?string} - absolute file path
  */
@@ -49,7 +47,6 @@ export const getAbsPath = file => {
 
 /**
  * get stat
- *
  * @param {string} file - file path
  * @returns {object} - file stat
  */
@@ -58,7 +55,6 @@ export const getStat = file =>
 
 /**
  * the directory is a directory
- *
  * @param {string} dir - directory path
  * @returns {boolean} - result
  */
@@ -69,7 +65,6 @@ export const isDir = dir => {
 
 /**
  * the directory is a subdirectory of a certain directory
- *
  * @param {string} dir - directory path
  * @param {string} baseDir - base directory path
  * @returns {boolean} - result
@@ -79,7 +74,6 @@ export const isSubDir = (dir, baseDir) =>
 
 /**
  * the file is a file
- *
  * @param {string} file - file path
  * @returns {boolean} - result
  */
@@ -92,7 +86,6 @@ export const isFile = file => {
  * the file is executable
  * NOTE: On Windows, fs.statSync(file).mode returns 33206 for executable
  * files like `.exe`, which is 100666 in octal.
- *
  * @param {string} file - file path
  * @param {number} [mask] - mask bit
  * @returns {boolean} - result
@@ -109,7 +102,6 @@ export const isExecutable = (file, mask = MASK_BIT) => {
 
 /**
  * get file timestamp
- *
  * @param {string} file - file path
  * @returns {number} - timestamp
  */
@@ -120,7 +112,6 @@ export const getFileTimestamp = file => {
 
 /**
  * get file name from native file path
- *
  * @param {string} file - file path
  * @param {string} [subst] - substitute file name
  * @returns {string} - file name
@@ -136,7 +127,6 @@ export const getFileNameFromFilePath = (file, subst = SUBST) => {
 
 /**
  * remove the directory and it's files synchronously
- *
  * @param {string} dir - directory path
  * @param {string} baseDir - base directory path
  * @returns {void}
@@ -155,7 +145,6 @@ export const removeDir = (dir, baseDir) => {
 
 /**
  * remove the directory and it's files
- *
  * @param {string} dir - directory path
  * @param {string} baseDir - base directory path
  * @returns {Promise.<void>} - void
@@ -174,7 +163,6 @@ export const removeDirectory = async (dir, baseDir) => {
 
 /**
  * create a directory
- *
  * @param {string} dir - directory path to create
  * @param {number} [mode] - permission
  * @returns {Promise.<string>} - directory path
@@ -197,7 +185,6 @@ export const createDirectory = async (dir, mode = PERM_DIR) => {
 
 /**
  * create a file
- *
  * @param {string} file - file path to create
  * @param {string|Buffer|Uint8Array} value - value to write
  * @param {object} [opt] - options
@@ -225,7 +212,6 @@ export const createFile = async (file, value, opt = {
 
 /**
  * read a file
- *
  * @param {string} file - file path
  * @param {object} [opt] - options
  * @param {string} [opt.encoding] - encoding

package/modules/schema.js

@@ -18,7 +18,6 @@ export class Schema {
 
   /**
    * construct
-   *
    * @param {...(string|object)} [args] - optional arguments
    *                                      {string} - release channel.
    *                                                 one of "beta", "central",
@@ -54,7 +53,6 @@ export class Schema {
 
   /**
    * get target from namespace key
-   *
    * @param {string} key - namespace key
    * @returns {object} - target object
    */
@@ -81,7 +79,6 @@ export class Schema {
 
   /**
    * assign imported values
-   *
    * @returns {void}
    */
   _assignImportMap() {
@@ -108,7 +105,6 @@ export class Schema {
 
   /**
    * assign referred values
-   *
    * @returns {void}
    */
   _assignRefMap() {
@@ -135,7 +131,6 @@ export class Schema {
 
   /**
    * mock events
-   *
    * @param {object} target - target object
    * @param {Array} events - events
    * @returns {object} - target object
@@ -161,7 +156,6 @@ export class Schema {
 
   /**
    * mock functions
-   *
    * @param {object} target - target object
    * @param {Array} funcs - functions
    * @returns {object} - target object
@@ -184,7 +178,6 @@ export class Schema {
 
   /**
    * mock properties
-   *
    * @param {object} target - target object
    * @param {object} props - properties
    * @param {string} namespace - namespace
@@ -225,7 +218,6 @@ export class Schema {
 
   /**
    * mock types
-   *
    * @param {object} target - target object
    * @param {Array} types - types
    * @param {string} namespace - namespace
@@ -263,7 +255,6 @@ export class Schema {
 
   /**
    * parse schema content
-   *
    * @returns {object} - schema
    */
   _parseSchemaContent() {
@@ -280,7 +271,6 @@ export class Schema {
 
   /**
    * get schema
-   *
    * @param {string} name - API name or file name
    * @returns {Array} - schema
    */
@@ -303,7 +293,6 @@ export class Schema {
 
   /**
    * get all schemas
-   *
    * @returns {object} - schemas
    */
   getAll() {
@@ -313,7 +302,6 @@ export class Schema {
 
   /**
    * list schemas
-   *
    * @returns {Array} - file list
    */
   list() {
@@ -328,7 +316,6 @@ export class Schema {
 
   /**
    * mock browser api
-   *
    * @returns {object} - stubbed browser api
    */
   mock() {