@vacantthinker/firefox-addon-framework-easy 2026.5.2212 → 2026.524.1751

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  push:
+    branches:
+      - main #
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+      - run: npm ci
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish --provenance --access public

package/README.md

@@ -1 +1,158 @@
-# firefox-addon-framework-easy
+# firefox-addon-framework-easy
+
+[![License: AGPL v3](https://shields.io)](https://gnu.org)
+
+## License
+
+This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+
+
+## Source Code Access
+
+According to the terms of the AGPL-3.0, the source code for this network service must be made available to all users.
+
+You can download, clone, or view the complete source code for this application here: [Insert your GitHub/GitLab URL].
+
+## API Reference (Auto-Generated)
+
+Below is a list of all public functions found inside the `src` directory:
+
+### File: `src/baseORM.js`
+```javascript
+export class BaseORM {  }
+
+```
+
+### File: `src/browserNotification.js`
+```javascript
+export async function browserNotificationCreate(content, title = null) {  }
+
+```
+
+### File: `src/browserRuntime.js`
+```javascript
+export function browserRuntimeReload() {  }
+
+export async function browserRuntimeSetUninstallURL(
+    url = 'https://addons.mozilla.org/en-US/firefox/user/17783213/',
+) {  }
+
+export function browserRuntimeOnUpdateAvailable(doWhat = null) {  }
+
+export function browserRuntimeGeckoId() {  }
+
+export async function browserRuntimePlatformInfo() {  }
+
+export function browserRuntimeManifestVersion() {  }
+
+```
+
+### File: `src/generate.js`
+```javascript
+export function generateHtmlByUserSettings(
+    userSettings,
+    radioItemClickFn,
+) {  }
+
+```
+
+### File: `src/opStorage.js`
+```javascript
+export async function stoOpCheck(k) {  }
+
+export async function stoOpGet(k) {  }
+
+export async function stoOpGetAll() {  }
+
+export async function stoOpQueryStartWith(k) {  }
+
+export async function stoOpSet(k, v) {  }
+
+export async function stoOpRem(k) {  }
+
+export async function stoOpSetNull(k) {  }
+
+```
+
+### File: `src/opTab.js`
+```javascript
+export async function tabOpGet(tabId) {  }
+
+export async function tabOpQueryAll() {  }
+
+export async function tabOpQueryUrl(urlQuery) {  }
+
+export async function tabOpQueryUrlThenRemove(urlQuery) {  }
+
+export async function tabOpReload(tabId) {  }
+
+export async function tabOpCreate(urlOrArgs) {  }
+
+export async function tabOpCreateNormal(urlOrArgs) {  }
+
+export async function tabOpRemove(tabId) {  }
+
+export async function tabOpHide(tabId) {  }
+
+export async function tabOpUpdate(tabId, updateProperties) {  }
+
+export async function tabOpUpdateActiveFalse(tabId) {  }
+
+export async function tabOpFocus(tabId) {  }
+
+export async function tabOpInsertCssCode(tabId, code) {  }
+
+export async function tabOpRemoveCssCode(tabId, code) {  }
+
+```
+
+### File: `src/serviceFetch.js`
+```javascript
+export async function servicePostJson(
+    serverUrl,
+    message,
+    handleError,
+) {  }
+
+```
+
+### File: `src/serviceGet.js`
+```javascript
+export function serviceGetDomainByUrl(url) {  }
+
+export function serviceGetCurrentDateYYYYMMDDHHMMSS() {  }
+
+```
+
+### File: `src/serviceOpContent.js`
+```javascript
+export function serviceCopyContentToClipboard(content) {  }
+
+export function serviceSaveContentToLocal(content, filename, ext = 'txt') {  }
+
+export function serviceRemoveIllegalWord(value) {  }
+
+```
+
+### File: `src/servicePureVideolink.js`
+```javascript
+export function servicePureVideolinkYTB(videolinkOrigin) {  }
+
+```
+
+### File: `src/serviceUpdateALLStyle.js`
+```javascript
+export async function serviceUpdataALLTextNodeColor(message) {  }
+
+export async function serviceUpdataALLNodeBackgroundColor(message) {  }
+
+```
+
+### File: `src/serviceUserSettings.js`
+```javascript
+export async function serviceInitUserSettings(userSettings) {  }
+
+export async function serviceGetUserSettings(userSettings) {  }
+
+```
+

package/index.js

@@ -1,12 +1,12 @@
-
-
-export * from './src/baseOp.js'
-export * from './src/baseOpTab.js'
-export * from './src/baseOpStorage.js'
-
-
 export * from './src/baseORM.js'
-
-export * from './src/baseService.js'
-export * from './src/baseRuntimeSetup.js'
-export * from './src/baseServiceZipFilesOrDirectorys.js'
+export * from './src/browserNotification.js'
+export * from './src/browserRuntime.js'
+export * from './src/generate.js'
+export * from './src/opStorage.js'
+export * from './src/opTab.js'
+export * from './src/serviceFetch.js'
+export * from './src/serviceGet.js'
+export * from './src/serviceOpContent.js'
+export * from './src/servicePureVideolink.js'
+export * from './src/serviceUpdateALLStyle.js'
+export * from './src/serviceUserSettings.js'

package/package.json

@@ -1,19 +1,15 @@
 {
   "name": "@vacantthinker/firefox-addon-framework-easy",
-  "version": "2026.5.2212",
+  "version": "2026.0524.1751",
   "description": "",
   "main": "index.js",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
-  "scripts": {
-    "npm_install": "npm install",
-    "git_acp": "git add . && git commit -m 'add baseServiceZipFilesOrDirectorys.js' && git push",
-    "npm_publish": "npm publish",
-    "webpack": "webpack",
-    "webpack_pack": "webpack && node _zipit.js"
-  },
-  "author": "vacantthinker",
+  "scripts": {},
+  "author": "VacantThinker",
+  "license": "AGPL-3.0-only",
   "repository": {
     "type": "git",
     "url": "git@github.com:VacantThinker/firefox-addon-framework-easy.git"
@@ -22,15 +18,7 @@
   "bugs": {
     "url": "https://github.com/VacantThinker/firefox-addon-framework-easy/issues"
   },
-  "devDependencies": {
-    "@types/firefox-webext-browser": "^143.0.0",
-    "@types/node": "^22.18.0",
-    "archiver": "^7.0.1",
-    "copy-webpack-plugin": "^13.0.1",
-    "html-minimizer-webpack-plugin": "^5.0.3",
-    "json-minimizer-webpack-plugin": "^5.0.1",
-    "terser-webpack-plugin": "^5.3.14",
-    "webpack": "^5.102.1",
-    "webpack-cli": "^6.0.1"
+  "dependencies": {
+    "@types/firefox-webext-browser": "^143.0.0"
   }
-}
+}

package/publish.sh

@@ -0,0 +1,81 @@
+#!/bin/bash
+
+# 1. Get the current time (Format example: 2026.0522.0443)
+# This includes the date, hour, and minute to ensure the version number increments every time you push.
+NEW_VERSION=$(date +'%Y.%m%d.%H%M')
+
+echo "🚀 Starting version update to: $NEW_VERSION"
+
+# 2. Use jq to automatically modify the version field in package.json and write it back
+jq ".version = \"$NEW_VERSION\"" package.json > package.json.tmp && mv package.json.tmp package.json
+
+# 2.5 Automatically scan all js files in the src directory and generate export statements for index.js
+echo "🚀 Dynamically generating index.js exports..."
+true > index.js
+for file in src/*.js; do
+    if [ -f "$file" ]; then
+        echo "export * from './$file'" >> index.js
+    fi
+done
+
+# 2.6 Automatically reset README.md and append the scanned public functions
+echo "📝 Updating README.md..."
+
+# 1. Write the default fixed content
+cat << 'EOF' > README.md
+# firefox-addon-framework-easy
+
+[![License: AGPL v3](https://shields.io)](https://gnu.org)
+
+## License
+
+This project is licensed under the GNU Affero General Public License v3.0 - see the [LICENSE](LICENSE) file for details.
+
+
+## Source Code Access
+
+According to the terms of the AGPL-3.0, the source code for this network service must be made available to all users.
+
+You can download, clone, or view the complete source code for this application here: [Insert your GitHub/GitLab URL].
+
+## API Reference (Auto-Generated)
+
+Below is a list of all public functions found inside the `src` directory:
+
+EOF
+
+# 2. Iterate through all js files, capture multi-line signatures, and append them to README
+for file in src/*.js; do
+    if [ -f "$file" ]; then
+        echo "### File: \`$file\`" >> README.md
+        echo "\`\`\`javascript" >> README.md
+
+        # Reads multi-line signatures up to the opening brace or semicolon
+        awk '/^export (async )?(function|const|let|var|class) / {
+            line = $0
+            # Keep reading lines if there is no opening brace or semicolon yet
+            while (line !~ /\{/ && line !~ /;/ && (getline next_line) > 0) {
+                line = line "\n" next_line
+            }
+            # Clean up the function body and replace it with standard closing
+            sub(/\{.*/, "{  }", line)
+            print line
+            print ""
+        }' "$file" >> README.md
+
+        echo "\`\`\`" >> README.md
+        echo "" >> README.md
+    fi
+done
+
+# 3. Check if there are any code changes to commit
+git add .
+
+# 4. Automatically commit and log this release version
+git commit -m "chore: bump version to $NEW_VERSION and publish"
+
+# 5. Push to GitHub to trigger cloud-based automated publishing
+echo "📤 Pushing to GitHub..."
+git push origin main
+
+echo "✅ Push complete! Please check the GitHub Actions page to view the deployment status."

package/src/baseORM.js

@@ -1,5 +1,10 @@
-import {stoOpCheck, stoOpGet, stoOpQuery_startsWith, stoOpRem, stoOpSet} from "./baseOpStorage.js";
-
+import {
+    stoOpCheck,
+    stoOpGet,
+    stoOpQueryStartWith,
+    stoOpRem,
+    stoOpSet,
+} from './opStorage.js';
 
 /**
  * eg:
@@ -9,220 +14,108 @@ import {stoOpCheck, stoOpGet, stoOpQuery_startsWith, stoOpRem, stoOpSet} from ".
  * }
  */
 export class BaseORM {
-    // Private class fields for encapsulation
-    #keyPrefix = `domain `;
-    #domainDefaultValue = {};
-
-    // Private helper method to generate the prefix key
-    #domainKey(k) {
-        return `${this.#keyPrefix}${k}`;
-    }
-
-    /**
-     * check domain exists, return true/false
-     * @param {string} domain
-     * @return {Promise<boolean>}
-     */
-    async #checkDomain(domain) {
-        return await stoOpCheck(this.#domainKey(domain));
+  // Private class fields for encapsulation
+  #keyPrefix = `domain `;
+  #domainDefaultValue = {};
+
+  // Private helper method to generate the prefix key
+  #domainKey(k) {
+    return `${this.#keyPrefix}${k}`;
+  }
+
+  /**
+   * check domain exists, return true/false
+   * @param {string} domain
+   * @return {Promise<boolean>}
+   */
+  async #checkDomain(domain) {
+    return await stoOpCheck(this.#domainKey(domain));
+  }
+
+  /**
+   * @param {string} domain
+   * @return {Promise<void>}
+   */
+  async #addDomain(domain) {
+    await stoOpSet(this.#domainKey(domain), this.#domainDefaultValue);
+  }
+
+  /**
+   * @param {string} domain
+   * @return {Promise<void>}
+   */
+  async #removeDomain(domain) {
+    await stoOpRem(this.#domainKey(domain));
+  }
+
+  /**
+   * @param {string} domain
+   * @param {*} valueNew
+   * @return {Promise<void>}
+   */
+  async #updateDomain(domain, valueNew) {
+    await stoOpSet(this.#domainKey(domain), valueNew);
+  }
+
+  /**
+   * eg: ['a.com', 'b.com', 'c.com']
+   * @returns {Promise<string[]>}
+   */
+  async getALLDomainKey() {
+    // stoOpQueryByPrefix
+    let strings = await stoOpQueryStartWith(this.#keyPrefix);
+    return strings.map(v => v.replaceAll(this.#keyPrefix, ''));
+  }
+
+  /**
+   * @returns {Promise<{domainList: string[], domainKeyValueMap: {}}>}
+   */
+  async getALLDomainMap() {
+    let domainList = await this.getALLDomainKey();
+
+    const domainKeyValueMap = {};
+    for (let domain of domainList) {
+      domainKeyValueMap[domain] = await this.getDomain(domain);
     }
 
-    /**
-     * @param {string} domain
-     * @return {Promise<void>}
-     */
-    async #addDomain(domain) {
-        await stoOpSet(this.#domainKey(domain), this.#domainDefaultValue);
-    }
+    return {domainList, domainKeyValueMap};
+  }
 
-    /**
-     * @param {string} domain
-     * @return {Promise<void>}
-     */
-    async #removeDomain(domain) {
-        await stoOpRem(this.#domainKey(domain));
+  /**
+   * @param {string} domain
+   * @returns {Promise<{}>}
+   */
+  async getDomain(domain) {
+    if (!(await this.#checkDomain(domain))) {
+      await this.#addDomain(domain);
     }
-
-    /**
-     * @param {string} domain
-     * @param {*} valueNew
-     * @return {Promise<void>}
-     */
-    async #updateDomain(domain, valueNew) {
-        await stoOpSet(this.#domainKey(domain), valueNew);
-    }
-
-    /**
-     * eg: ['a.com', 'b.com', 'c.com']
-     * @returns {Promise<string[]>}
-     */
-    async getALLDomainKey() {
-        // stoOpQueryByPrefix
-        let strings = await stoOpQuery_startsWith(this.#keyPrefix);
-        return strings.map(v => v.replaceAll(this.#keyPrefix, ''));
-    }
-
-    /**
-     * @returns {Promise<{domainList: string[], domainKeyValueMap: {}}>}
-     */
-    async getALLDomainMap() {
-        let domainList = await this.getALLDomainKey();
-
-        const domainKeyValueMap = {};
-        for (let domain of domainList) {
-            domainKeyValueMap[domain] = await this.getDomain(domain);
-        }
-
-        return {domainList, domainKeyValueMap};
-    }
-
-    /**
-     * @param {string} domain
-     * @returns {Promise<{}>}
-     */
-    async getDomain(domain) {
-        if (!(await this.#checkDomain(domain))) {
-            await this.#addDomain(domain);
-        }
-        return await stoOpGet(this.#domainKey(domain));
-    }
-
-    /**
-     * {a:a1} => {a:a222}
-     * @param {string} domain 'xxx.xxxxx.xxx'
-     * @param {string} key
-     * @param {string} valueToUpdate
-     * @return {Promise<{}>}
-     */
-    async updateDomainValueByOneKeyValue(domain, key, valueToUpdate) {
-        if (!(await this.#checkDomain(domain))) {
-            await this.#addDomain(domain);
-        }
-        let domainValueGet = await this.getDomain(domain);
-        domainValueGet[key] = valueToUpdate;
-        await this.#updateDomain(domain, domainValueGet);
-        return await this.getDomain(domain);
-    }
-
-    /**
-     * @param {string} domain 'xxx.xxxxx.xxx'
-     * @return {Promise<{}>}
-     */
-    async clearThisDomain(domain) {
-        let domainValue = await this.getDomain(domain);
-        await this.#removeDomain(domain);
-        return domainValue;
+    return await stoOpGet(this.#domainKey(domain));
+  }
+
+  /**
+   * {a:a1} => {a:a222}
+   * @param {string} domain 'xxx.xxxxx.xxx'
+   * @param {string} key
+   * @param {string} valueToUpdate
+   * @return {Promise<{}>}
+   */
+  async updateDomainValueByOneKeyValue(domain, key, valueToUpdate) {
+    if (!(await this.#checkDomain(domain))) {
+      await this.#addDomain(domain);
     }
+    let domainValueGet = await this.getDomain(domain);
+    domainValueGet[key] = valueToUpdate;
+    await this.#updateDomain(domain, domainValueGet);
+    return await this.getDomain(domain);
+  }
+
+  /**
+   * @param {string} domain 'xxx.xxxxx.xxx'
+   * @return {Promise<{}>}
+   */
+  async clearThisDomain(domain) {
+    let domainValue = await this.getDomain(domain);
+    await this.#removeDomain(domain);
+    return domainValue;
+  }
 }
-
-/**
- * eg:
- *
- * "domain www.abcdefg.com":{
- *   "keyAAA": "valueBBB"
- * }
- *
- * @returns {{getALLDomainKey: function(): Promise<string[]>, getALLDomainMap: function(): Promise<{domainList: *, domainKeyValueMap: {}}>, getDomain: function(string): Promise<{}>, updateDomainValueByOneKeyValue: function(string, string, string): Promise<{}>, clearThisDomain: function(*): Promise<{}>}}
- */
-export function baseORM() {
-
-    let keyPrefix = `domain `;
-    const domainKey = (k) => `${keyPrefix}${k}`;
-    const domainDefaultValue = {};
-
-    /**
-     * check domain exists, return true/false
-     * @param domain{string}
-     * @return {Promise<boolean>}
-     */
-    async function checkDomain(domain) {
-        return await stoOpCheck(domainKey(domain));
-    }
-
-    /**
-     * @param domain{string}
-     * @return {Promise<void>}
-     */
-    async function addDomain(domain) {
-        await stoOpSet(domainKey(domain), domainDefaultValue);
-    }
-
-    /**
-     * @param domain{string}
-     * @return {Promise<void>}
-     */
-    async function removeDomain(domain) {
-        await stoOpRem(domainKey(domain));
-    }
-
-    /**
-     * @param domain{string}
-     * @param valueNew
-     * @return {Promise<void>}
-     */
-    async function updateDomain(domain, valueNew) {
-        await stoOpSet(domainKey(domain), valueNew);
-    }
-
-    return {
-        /**
-         * eg: ['a.com', 'b.com', 'c.com']
-         * @returns {Promise<string[]>}
-         */
-        getALLDomainKey: async function () {
-            // stoOpQueryByPrefix
-            let strings = await stoOpQuery_startsWith(keyPrefix);
-            return strings.map(v => v.replaceAll(keyPrefix, ''));
-        },
-        getALLDomainMap: async function () {
-            let domainList = await this.getALLDomainKey();
-
-            // todo use for-loop not the reduce()!
-            const domainKeyValueMap = {}
-            for (let domain of domainList) {
-                domainKeyValueMap[domain] = await this.getDomain(domain)
-            }
-
-            return {domainList, domainKeyValueMap};
-        },
-
-        /**
-         *
-         * @param {string}domain
-         * @returns {Promise<{}>}
-         */
-        getDomain: async function (domain) {
-            if (!await checkDomain(domain)) {
-                await addDomain(domain);
-            }
-            return await stoOpGet(domainKey(domain));
-        },
-
-        /**
-         * {a:a1} => {a:a222}
-         * @param {string}domain 'xxx.xxxxx.xxx'
-         * @param{string}key
-         * @param {string}valueToUpdate
-         * @return {Promise<{}>}
-         */
-        updateDomainValueByOneKeyValue: async function (domain, key, valueToUpdate) {
-            if (!await checkDomain(domain)) {
-                await addDomain(domain);
-            }
-            let domainValueGet = await this.getDomain(domain);
-            domainValueGet[key] = valueToUpdate;
-            await updateDomain(domain, domainValueGet);
-            return (await this.getDomain(domain));
-        },
-
-        /**
-         * @param domain 'xxx.xxxxx.xxx'
-         * @return {Promise<{}>}
-         */
-        clearThisDomain: async function (domain) {
-            let domainValue = await this.getDomain(domain);
-            await removeDomain(domain);
-            return domainValue;
-        },
-    };
-}

package/src/browserNotification.js

@@ -0,0 +1,22 @@
+/**
+ *
+ * @param { string}content
+ * @param {string|null}title
+ * @returns {Promise<string>}
+ */
+export async function browserNotificationCreate(content, title = null) {
+  const tag = 'browserNotificationCreate';
+  try {
+    let notificationId = `${tag}cake-noti`;
+    title = title ? title : browser.runtime.getManifest().name;
+    console.info(tag, `content=${content}`, `title=${title}`);
+    await browser.notifications.create(notificationId, {
+      type: 'basic',
+      title,
+      message: content,
+    });
+    return notificationId;
+  } catch (e) {
+    console.error(tag, e);
+  }
+}