add @Private / @Protected

.eslintrc.json

@@ -14,7 +14,7 @@
         "es2020": true
     },
     "parserOptions": {
-        "ecmaVersion": 2020,
+        "ecmaVersion": 2022,
         "ecmaFeatures": {},
         "sourceType": "module"
     },

content/table.mjs.js

@@ -15,8 +15,10 @@ class TableCellEditable extends HTMLTableCellElement {
 	constructor() {
 		super();
 
+		/** @private */
 		this._span = document.createElement("span");
 
+		/** @private */
 		this._input = document.createElement("input");
 		this._input.hidden = true;
 		this._input.type = "text";
@@ -134,18 +136,27 @@ export default class DataTable {
 	 * @param {DeleteRowCallback} [deleteRowCallback]
 	 */
 	constructor(tableElement, editable = false, updatedCellValueCallback = undefined, deleteRowCallback = undefined) {
+		/** @private */
 		this._tbody = tableElement.getElementsByTagName("tbody")[0];
 		if (!this._tbody) {
 			throw new Error("No tbody element found.");
 		}
+		/** @private */
 		this._isEditable = editable;
+		/** @private */
 		this._isEditing = false;
+		/** @private */
 		this._updatedCellValueCallback = updatedCellValueCallback;
+		/** @private */
 		this._deleteRowCallback = deleteRowCallback;
 
-		/** @type {HTMLTableRowElement[]} */
+		/**
+		 * @private
+		 * @type {HTMLTableRowElement[]}
+		 */
 		this._selectedRows = [];
 
+		/** @private */
 		this._columns = Array.from(tableElement.getElementsByTagName("th")).
 			map(th => ({ name: th.dataset.name, type: th.dataset.type ?? "string" }));
 	}
@@ -240,6 +251,7 @@ export default class DataTable {
 	}
 
 	/**
+	 * @private
 	 * @param {Event} event
 	 * @returns {void}
 	 */
@@ -255,6 +267,7 @@ export default class DataTable {
 	}
 
 	/**
+	 * @private
 	 * @returns {void}
 	 */
 	_unselect() {
@@ -265,6 +278,7 @@ export default class DataTable {
 	}
 
 	/**
+	 * @private
 	 * @param {Event} event
 	 * @returns {void}
 	 */
@@ -279,6 +293,7 @@ export default class DataTable {
 	}
 
 	/**
+	 * @private
 	 * @param {TableCellEditable} cell
 	 * @returns {Promise<void>}
 	 */
@@ -328,6 +343,7 @@ export default class DataTable {
 	}
 
 	/**
+	 * @private
 	 * @param {FocusEvent} event
 	 * @returns {void}
 	 */
@@ -341,6 +357,7 @@ export default class DataTable {
 	}
 
 	/**
+	 * @private
 	 * @param {KeyboardEvent} event
 	 * @returns {void}
 	 */

experiments/dkimHeader.js

@@ -32,7 +32,11 @@ class DKIMTooltip {
 	 * @memberof DKIMTooltip
 	 */
 	constructor(document, element) {
-		// whether a separator should be added before the warnings
+		/**
+		 * Whether a separator should be added before the warnings.
+		 *
+		 * @protected
+		 */
 		this._warningsSeparator = false;
 
 		if (element) {
@@ -116,6 +120,7 @@ class DkimResultTooltip extends DKIMTooltip {
 	 */
 	constructor(document, element) {
 		super(document, element);
+		/** @protected */
 		this._warningsSeparator = true;
 		if (element) {
 			return;
@@ -188,6 +193,7 @@ class DKIMHeaderField {
 		this.element._dkimValue.style.userSelect = "text";
 
 		// DKIM warning icon
+		/** @private */
 		this._dkimWarningTooltip = new DKIMWarningsTooltip(document);
 		this.element._dkimWarningTooltip = this._dkimWarningTooltip.element;
 		this.element._dkimWarningTooltip.id = "dkim-verifier-header-tooltip-warnings";
@@ -443,6 +449,7 @@ class DkimHeaderRow {
 	 * Should be added to the `expandedHeaders2` element.
 	 *
 	 * @static
+	 * @private
 	 * @param {Document} document
 	 * @returns {HTMLElement}
 	 * @memberof DkimHeaderRow
@@ -472,6 +479,7 @@ class DkimHeaderRow {
 	 * Should be added to the `extraHeadersArea` element.
 	 *
 	 * @static
+	 * @private
 	 * @param {Document} document
 	 * @returns {HTMLElement}
 	 * @memberof DkimHeaderRow
@@ -523,7 +531,7 @@ class DkimFavicon {
 
 		this.element.id = DkimFavicon._id;
 		this.element.classList.add("headerValue");
-		this.element.setAttribute("tooltip", DkimFavicon._idTooltip);
+		this.element.setAttribute("tooltip", DkimFavicon.idTooltip);
 		// dummy text for align baseline
 		this.element.textContent = "";
 		this.element.style.setProperty("min-width", "0px", "important");
@@ -534,10 +542,11 @@ class DkimFavicon {
 		this.element.style.backgroundRepeat = "no-repeat";
 
 		// DKIM tooltip
+		/** @private */
 		this._dkimTooltipFrom = new DkimResultTooltip(document);
 		this.element._dkimTooltipFromElement = this._dkimTooltipFrom.element;
-		this.element._dkimTooltipFromElement.id = DkimFavicon._idTooltip;
-		this.element.setAttribute("tooltip", DkimFavicon._idTooltip);
+		this.element._dkimTooltipFromElement.id = DkimFavicon.idTooltip;
+		this.element.setAttribute("tooltip", DkimFavicon.idTooltip);
 
 		this.reset();
 	}
@@ -638,9 +647,15 @@ class DkimFavicon {
 			favicon._dkimTooltipFrom.element.remove();
 		}
 	}
+
+	/**
+	 * @private
+	 * @readonly
+	 */
+	static _id = "dkimFavicon";
+	/** @readonly */
+	static idTooltip = "dkim-verifier-header-tooltip-from";
 }
-DkimFavicon._id = "dkimFavicon";
-DkimFavicon._idTooltip = "dkim-verifier-header-tooltip-from";
 
 /**
  * DKIM specific modifications of the from address:
@@ -652,6 +667,7 @@ class DkimFromAddress {
 	 * Get the element containing the from address (without the following star).
 	 *
 	 * @static
+	 * @private
 	 * @param {Document} document
 	 * @returns {XULElement?}
 	 */
@@ -718,9 +734,9 @@ class DkimFromAddress {
 			}
 			emailValue.removeAttribute("tooltiptext");
 			// set DKIM tooltip
-			emailValue.setAttribute("tooltip", DkimFavicon._idTooltip);
+			emailValue.setAttribute("tooltip", DkimFavicon.idTooltip);
 		} else {
-			if (emailValue.getAttribute("tooltip") === DkimFavicon._idTooltip) {
+			if (emailValue.getAttribute("tooltip") === DkimFavicon.idTooltip) {
 				// remove DKIM tooltip
 				emailValue.removeAttribute("tooltip");
 				// restore saved tooltip
@@ -828,9 +844,13 @@ class DkimResetMessageListener {
 	onEndHeaders() { }
 	// eslint-disable-next-line no-empty-function
 	onEndAttachments() { }
+
+	/**
+	 * @private
+	 * @type {Map<Window, DkimResetMessageListener>}
+	 */
+	static _mapping = new Map();
 }
-/** @type {Map<Window, DkimResetMessageListener>} */
-DkimResetMessageListener._mapping = new Map();
 
 // eslint-disable-next-line no-invalid-this
 this.dkimHeader = class extends ExtensionCommon.ExtensionAPI {

experiments/libunbound.js

@@ -77,8 +77,12 @@ class Deferred {
 
 class LibunboundWorker {
 	constructor() {
+		/** @private */
 		this._maxCallId = 0;
-		/** @type {Map<number, Deferred<ub_result|void>>} */
+		/**
+		 * @private
+		 * @type {Map<number, Deferred<ub_result|void>>}
+		 */
 		this._openCalls = new Map();
 
 		/** @type {Libunbound.LibunboundWorker} */
@@ -208,6 +212,7 @@ class LibunboundWorker {
 	/**
 	 * Handle the callbacks from the ChromeWorker.
 	 *
+	 * @private
 	 * @param {Libunbound.WorkerResponse} msg
 	 * @returns {void}
 	 */

experiments/migration.js

@@ -31,6 +31,7 @@ this.migration = class extends ExtensionCommon.ExtensionAPI {
 	/**
 	 * Returns the preferences set in a preference branch.
 	 *
+	 * @private
 	 * @param {nsIPrefBranch} prefBranch
 	 * @returns {Object.<string, boolean|number|string>}
 	 */
@@ -60,6 +61,7 @@ this.migration = class extends ExtensionCommon.ExtensionAPI {
 	/**
 	 * Open connection to an SQLite database if it exist.
 	 *
+	 * @private
 	 * @param {string} fileName
 	 * @returns {Promise<any>?}
 	 */

experiments/storageMessage.js

@@ -17,6 +17,7 @@
 // eslint-disable-next-line no-invalid-this
 this.storageMessage = class extends ExtensionCommon.ExtensionAPI {
 	/**
+	 * @private
 	 * @param {number} messageId
 	 * @returns {nsIMsgDBHdr}
 	 */

modules/dkim/signRules.mjs.js

@@ -645,6 +645,7 @@ export default class SignRules {
 	/**
 	 * Adds should be signed rule if no enabled rule for fromAddress is found.
 	 *
+	 * @private
 	 * @param {string} fromAddress
 	 * @param {VerifierModule.dkimSigResultV2} dkimResult
 	 * @returns {Promise<void>}

modules/logging.mjs.js

@@ -24,6 +24,7 @@ class Logger {
 	 */
 	constructor(loggerName) {
 		this.name = loggerName;
+		/** @private */
 		this._logLevel = Logging.logLevel;
 		this.logLevel = Logging.logLevel;
 	}
@@ -163,7 +164,12 @@ export default class Logging {
 			}
 		});
 	}
+
+	/** @private */
+	static _logLevel = Logging.Level.Debug;
+	/**
+	 * @private
+	 * @type {Logger[]}
+	 */
+	static _loggers = [];
 }
-Logging._logLevel = Logging.Level.Debug;
-/** @type {Logger[]} */
-Logging._loggers = [];

modules/preferences.mjs.js

@@ -46,7 +46,15 @@ export class BasePreferences {
 	 * @memberof BasePreferences
 	 */
 	constructor(valueGetter, valueSetter) {
+		/**
+		 * @protected
+		 * @type {Object.<string, boolean|number|string|undefined>}
+		 */
+		this._prefs = {};
+
+		/** @private */
 		this._valueGetter = valueGetter;
+		/** @private */
 		this._valueSetter = valueSetter;
 	}
 
@@ -71,6 +79,7 @@ export class BasePreferences {
 	}
 
 	/**
+	 * @private
 	 * @param {string} name
 	 * @param {boolean} defaultValue
 	 * @returns {boolean}
@@ -88,6 +97,7 @@ export class BasePreferences {
 	}
 
 	/**
+	 * @private
 	 * @param {string} name
 	 * @param {number} defaultValue
 	 * @returns {number}
@@ -105,6 +115,7 @@ export class BasePreferences {
 	}
 
 	/**
+	 * @private
 	 * @param {string} name
 	 * @param {string} defaultValue
 	 * @returns {string}
@@ -509,6 +520,7 @@ export class BasePreferences {
 	/**
 	 * Get an boolean account preference that has a global default.
 	 *
+	 * @private
 	 * @param {string} name
 	 * @param {string} account
 	 * @returns {boolean}
@@ -568,8 +580,6 @@ export class ObjPreferences extends BasePreferences {
 			(name) => { return this._prefs[name]; },
 			(name, value) => { this._prefs[name] = value; return Promise.resolve(); },
 		);
-		/** @type {Object.<string, boolean|number|string|undefined>} */
-		this._prefs = {};
 	}
 }
 
@@ -597,9 +607,8 @@ export class StorageLocalPreferences extends BasePreferences {
 				return promise;
 			},
 		);
+		/** @private */
 		this._isInitialized = false;
-		/** @type {Object.<string, boolean|number|string|undefined>} */
-		this._prefs = {};
 	}
 
 	/**
@@ -609,7 +618,10 @@ export class StorageLocalPreferences extends BasePreferences {
 		if (this._isInitializedDeferred) {
 			return this._isInitializedDeferred.promise;
 		}
-		/** @type {Deferred<void>} */
+		/**
+		 * @private
+		 * @type {Deferred<void>}
+		 */
 		this._isInitializedDeferred = new Deferred();
 		try {
 			const preferences = await ExtensionUtils.safeGetLocalStorage();