@vacantthinker/firefox-addon-framework-easy 2026.5.2204 → 2026.5.2206

package/index.js

@@ -1,3 +1,4 @@
 export * from './src/baseService.js'
 export * from './src/baseRuntimeSetup.js'
 export * from './src/baseOp.js'
+export * from './src/baseORM.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vacantthinker/firefox-addon-framework-easy",
-  "version": "2026.5.2204",
+  "version": "2026.5.2206",
   "description": "",
   "main": "index.js",
   "publishConfig": {

package/src/baseORM.js

@@ -0,0 +1,228 @@
+import {stoOpCheck, stoOpGet, stoOpQuery_startsWith, stoOpRem, stoOpSet} from "./baseOp.js";
+
+
+/**
+ * eg:
+ *
+ * "domain ://abcdefg.com":{
+ *   "keyAAA": "valueBBB"
+ * }
+ */
+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));
+    }
+
+    /**
+     * @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 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;
+    }
+}
+
+/**
+ * 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;
+        },
+    };
+}