swpp-backends 1.2.2 → 2.0.0

package/dist/DomBuilder.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDomJs = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const Utils_1 = require("./Utils");
+const Variant_1 = require("./Variant");
+/**
+ * 构建 DOM 端的 JS 文件
+ *
+ * + **执行该函数前必须调用过 [loadRules]**
+ */
+function buildDomJs() {
+    const config = (0, Variant_1.readRules)().config.dom;
+    if (!config) {
+        (0, Utils_1.error)('DomJsBuilder', '该配置项未开启');
+        throw '功能未开启';
+    }
+    let template = fs_1.default.readFileSync(path_1.default.resolve('./', module.path, 'resources/sw-dom.js'), 'utf-8');
+    if (config.onsuccess)
+        template = template.replaceAll('// ${onSuccess}', `(${config.onsuccess.toString()})()`);
+    return template;
+}
+exports.buildDomJs = buildDomJs;

package/dist/FileAnalyzer.js

@@ -26,15 +26,94 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceRequest = exports.findCache = exports.eachAllLinkInUrl = exports.findFileHandler = exports.registryFileHandler = exports.buildVersionJson = exports.readMergeVersionMap = exports.readNewVersionJson = exports.readOldVersionJson = exports.submitExternalUrl = exports.submitCacheInfo = exports.loadVersionJson = exports.isStable = exports.isExclude = void 0;
+exports.replaceRequest = exports.findCache = exports.eachAllLinkInUrl = exports.findFileHandler = exports.registryFileHandler = exports.submitExternalUrl = exports.submitCacheInfo = exports.loadVersionJson = exports.isStable = exports.isExclude = exports.buildVersionJson = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const node_fetch_1 = require("node-fetch");
-const SwppRules_1 = require("./SwppRules");
 const crypto = __importStar(require("crypto"));
 const buffer_1 = require("buffer");
 const fast_html_parser_1 = __importDefault(require("fast-html-parser"));
 const Utils_1 = require("./Utils");
+const Variant_1 = require("./Variant");
+/**
+ * 构建一个 version json
+ *
+ * + **执行该函数前必须调用过 [loadRules]**
+ * + **调用该函数前必须调用过 [loadCacheJson]**
+ * + **执行该函数前必须调用过 [calcEjectValues]**
+ *
+ * @param protocol 网站的网络协议
+ * @param domain 网站域名（包括二级域名）
+ * @param root 网页根目录（首页 index.html 所在目录）
+ */
+async function buildVersionJson(protocol, domain, root) {
+    const key = 'newVersionJson';
+    if ((0, Variant_1.readVariant)(key)) {
+        (0, Utils_1.error)('VersionJsonBuilder', '已经构建过一次版本文件');
+        throw '重复构建版本文件';
+    }
+    const rules = (0, Variant_1.readRules)();
+    const config = rules.config;
+    const list = {};
+    const cacheInfoMap = (0, Variant_1.readEvent)('submitCacheInfo');
+    const urlList = (0, Variant_1.readEvent)('submitExternalUrl');
+    (0, Variant_1.writeVariant)('submitCacheInfo', false);
+    (0, Variant_1.writeVariant)('submitExternalUrl', false);
+    // 遍历所有文件
+    await eachAllFile(root, async (path) => {
+        const endIndex = path.length - (/[\/\\]index\.html$/.test(path) ? 10 : 0);
+        const url = new URL(protocol + path_1.default.join(domain, path.substring(root.length, endIndex)));
+        const pathname = url.pathname;
+        if (isExclude(domain, pathname))
+            return;
+        let content = null;
+        if (findCache(url)) {
+            // 对于需要缓存的文件计算 MD5 值并存储
+            content = fs_1.default.readFileSync(path, 'utf-8');
+            const key = decodeURIComponent(url.pathname);
+            list[key] = crypto.createHash('md5').update(content).digest('hex');
+        }
+        if (!config.external)
+            return;
+        // 分析外部文件
+        const handler = findFileHandler(pathname);
+        if (handler) {
+            if (!content)
+                content = fs_1.default.readFileSync(path, 'utf-8');
+            await handler.handle(domain, url.href, content, list);
+        }
+    });
+    if (config.external) {
+        // 分析规则文件中通过 extraListenedUrls 导入的 URL
+        if ('extraListenedUrls' in rules) {
+            const urls = rules.extraListenedUrls;
+            if (typeof urls.forEach !== 'function') {
+                (0, Utils_1.error)('VersionJsonBuilder', `规则文件中的 extraListenedUrls 缺少 forEach 函数`);
+                throw 'extraListenedUrls 类型错误';
+            }
+            urls.forEach((it) => {
+                if (typeof it !== 'string') {
+                    (0, Utils_1.error)('VersionJsonBuilder', 'extraListenedUrls 中应当存储 string 类型的值');
+                    throw 'extraListenedUrls 元素类型错误';
+                }
+                urlList.add(it);
+            });
+        }
+        // 处理通过 API 提交的 URL
+        for (let url of urlList) {
+            await eachAllLinkInUrl(domain, url, list);
+        }
+    }
+    const external = {};
+    cacheInfoMap.forEach((value, key) => {
+        external[key] = value;
+    });
+    return (0, Variant_1.writeVariant)('newVersionJson', {
+        version: 3,
+        list, external
+    });
+}
+exports.buildVersionJson = buildVersionJson;
 /**
  * 遍历指定目录及其子目录中包含的所有文件（不遍历文件夹）
  * @param root 根目录
@@ -58,7 +137,7 @@ async function eachAllFile(root, cb) {
  * @param url 要判断的 URL
  */
 function isExclude(domain, url) {
-    const exclude = (0, SwppRules_1.readRules)().config?.json?.exclude;
+    const exclude = (0, Variant_1.readRules)().config?.json?.exclude;
     if (!exclude)
         return false;
     const list = isExternalLink(domain, url) ? exclude.other : exclude.localhost;
@@ -75,7 +154,7 @@ exports.isExclude = isExclude;
  * + **执行该函数前必须调用过 [loadRules]**
  */
 function isStable(url) {
-    const stable = (0, SwppRules_1.readRules)().config?.external?.stable;
+    const stable = (0, Variant_1.readRules)().config?.external?.stable;
     if (!stable)
         return false;
     for (let reg of stable) {
@@ -91,157 +170,54 @@ exports.isStable = isStable;
  * + **执行该函数前必须调用过 [loadRules]**
  */
 async function loadVersionJson(url) {
+    const key = 'oldVersionJson';
     const response = await (0, Utils_1.fetchFile)(url).catch(err => err);
     if (response?.status === 404 || response?.code === 'ENOTFOUND') {
         (0, Utils_1.warn)('LoadVersionJson', `拉取 ${url} 时出现 404 错误，如果您是第一次构建请忽略这个警告。`);
-        return _oldVersionJson = null;
+        return (0, Variant_1.writeVariant)(key, null);
     }
     else {
-        return _oldVersionJson = (await response.json());
+        return (0, Variant_1.writeVariant)(key, await response.json());
     }
 }
 exports.loadVersionJson = loadVersionJson;
-let _oldVersionJson = undefined;
-let _newVersionJson;
-let _mergeVersionMap;
-let cacheInfoMap = new Map();
-let urlList = new Set();
 /** 提交要存储到 version json 的值 */
 function submitCacheInfo(key, value) {
-    if (!cacheInfoMap) {
-        (0, Utils_1.error)('SubmitCacheInfo', 'version json 已经完成构建，调用该函数无意义！');
-        throw 'submitCacheInfo 调用时机错误';
-    }
+    const cacheInfoMap = (0, Variant_1.readEvent)('submitCacheInfo');
     cacheInfoMap.set(key, value);
 }
 exports.submitCacheInfo = submitCacheInfo;
 /** 添加一个要监听的 URL */
 function submitExternalUrl(url) {
-    if (!urlList) {
-        (0, Utils_1.error)('SubmitExternalUrl', 'version json 已经完成构建，调用该函数无意义！');
-        throw 'submitExternalUrl 调用时机错误';
-    }
-    urlList.add(url);
+    (0, Variant_1.readEvent)('submitExternalUrl').add(url);
 }
 exports.submitExternalUrl = submitExternalUrl;
-/**
- * 读取最后一次加载的 version json
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- */
-function readOldVersionJson() {
-    if (_oldVersionJson === undefined) {
-        (0, Utils_1.error)('OldVersionReader', 'version json 尚未初始化');
-        throw 'version json 尚未初始化';
-    }
-    return _oldVersionJson;
-}
-exports.readOldVersionJson = readOldVersionJson;
-/**
- * 读取最后一次构建的 VersionJson
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- * + **执行该函数前必须调用过 [buildVersionJson]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- */
-function readNewVersionJson() {
-    if (!_newVersionJson) {
-        (0, Utils_1.error)('NewVersionReader', 'version json 尚未初始化');
-        throw 'version json 尚未初始化';
-    }
-    return _newVersionJson;
-}
-exports.readNewVersionJson = readNewVersionJson;
-/**
- * 读取新旧版本文件合并后的版本地图
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- * + **执行该函数前必须调用过 [buildVersionJson]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- */
-function readMergeVersionMap() {
-    if (_mergeVersionMap)
-        return _mergeVersionMap;
-    const map = {};
-    Object.assign(map, readOldVersionJson()?.list ?? {});
-    Object.assign(map, readNewVersionJson().list);
-    return _mergeVersionMap = map;
-}
-exports.readMergeVersionMap = readMergeVersionMap;
-/**
- * 构建一个 version json
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- *
- * @param protocol 网站的网络协议
- * @param domain 网站域名（包括二级域名）
- * @param root 网页根目录（首页 index.html 所在目录）
- */
-async function buildVersionJson(protocol, domain, root) {
-    const list = {};
-    await eachAllFile(root, async (path) => {
-        const endIndex = path.length - (/[\/\\]index\.html$/.test(path) ? 10 : 0);
-        const url = new URL(protocol + path_1.default.join(domain, path.substring(root.length, endIndex)));
-        const pathname = url.pathname;
-        if (isExclude(domain, pathname))
-            return;
-        let content = null;
-        if (findCache(url)) {
-            content = fs_1.default.readFileSync(path, 'utf-8');
-            const key = decodeURIComponent(url.pathname);
-            list[key] = crypto.createHash('md5').update(content).digest('hex');
-        }
-        const handler = findFileHandler(pathname);
-        if (handler) {
-            if (!content)
-                content = fs_1.default.readFileSync(path, 'utf-8');
-            await handler.handle(domain, url.href, content, list);
-        }
-    });
-    for (let url of urlList) {
-        await eachAllLinkInUrl(domain, url, list);
-    }
-    const external = {};
-    cacheInfoMap.forEach((value, key) => {
-        external[key] = value;
-    });
-    urlList = cacheInfoMap = null;
-    return _newVersionJson = {
-        version: 3, list, external
-    };
-}
-exports.buildVersionJson = buildVersionJson;
-const fileHandlers = [
+(0, Variant_1.writeVariant)('submitCacheInfo', new Map());
+(0, Variant_1.writeVariant)('submitExternalUrl', new Set());
+(0, Variant_1.writeVariant)('registryFileHandler', []);
+(0, Variant_1.readVariant)('registryFileHandler').push(...[
     {
-        match: url => /(\/|\.html)$/.test(url),
+        match: (url) => /(\/|\.html)$/.test(url),
         handle: eachAllLinkInHtml
     },
     {
-        match: url => url.endsWith('.css'),
+        match: (url) => url.endsWith('.css'),
         handle: eachAllLinkInCss
     },
     {
-        match: url => url.endsWith('.js'),
+        match: (url) => url.endsWith('.js'),
         handle: eachAllLinkInJavaScript
     }
-];
+]);
 /** 注册一个文件处理器 */
 function registryFileHandler(handler) {
-    if (!urlList) {
-        (0, Utils_1.error)('RegistryFileHandler', '文件已经扫描完毕，调用该函数无意义！');
-        throw 'registryFileHandler 调用时机错误';
-    }
-    fileHandlers.push(handler);
+    // noinspection JSMismatchedCollectionQueryUpdate
+    (0, Variant_1.readEvent)('registryFileHandler').push(handler);
 }
 exports.registryFileHandler = registryFileHandler;
 /** 查询一个文件处理器 */
 function findFileHandler(url) {
-    return fileHandlers.find(it => it.match(url));
+    return (0, Variant_1.readEvent)('registryFileHandler').find(it => it.match(url));
 }
 exports.findFileHandler = findFileHandler;
 /**
@@ -269,7 +245,7 @@ async function eachAllLinkInUrl(domain, url, result, event) {
         return;
     const stable = isStable(url);
     if (stable) {
-        const old = readOldVersionJson()?.list;
+        const old = (0, Variant_1.readOldVersionJson)()?.list;
         if (Array.isArray(old?.[url])) {
             const copyTree = (key) => {
                 const value = old[key];
@@ -355,7 +331,7 @@ async function eachAllLinkInHtml(domain, url, content, result, event) {
         html = fast_html_parser_1.default.parse(content, { style: true, script: true });
     }
     catch (e) {
-        (0, Utils_1.error)('HtmlParser', `HTML [root=${url}] 中存在错误语法`);
+        (0, Utils_1.error)('HtmlParser', `HTML [${url}] 中存在错误语法`);
     }
     if (html)
         each(html);
@@ -385,6 +361,9 @@ async function eachAllLinkInCss(domain, url, content, result, event) {
                             break;
                     }
                     break;
+                default:
+                    ++i;
+                    break;
             }
         }
         return -1;
@@ -414,6 +393,8 @@ async function eachAllLinkInCss(domain, url, content, result, event) {
                     return 'http' + it;
                 case it.startsWith('/'):
                     return root + it;
+                case it.startsWith('./'):
+                    return root + it.substring(1);
                 default:
                     return root + '/' + it;
             }
@@ -423,7 +404,7 @@ async function eachAllLinkInCss(domain, url, content, result, event) {
 }
 function eachAllLinkInJavaScript(domain, _, content, result, event) {
     const taskList = [];
-    const ruleList = (0, SwppRules_1.readRules)().config?.external?.js;
+    const ruleList = (0, Variant_1.readRules)().config?.external?.js;
     if (!ruleList) {
         (0, Utils_1.error)('LinkItorInJS', '不应发生的异常');
         throw 'ruleList 为空';
@@ -475,7 +456,7 @@ function isExternalLink(domain, url) {
  * + **执行该函数前必须调用过 [calcEjectValues]**
  */
 function findCache(url) {
-    const { cacheRules } = (0, SwppRules_1.readRules)();
+    const { cacheRules } = (0, Variant_1.readRules)();
     const eject = (0, Utils_1.readEjectData)();
     if (typeof url === 'string')
         url = new URL(url);
@@ -495,7 +476,7 @@ exports.findCache = findCache;
  * + **执行该函数前必须调用过 [calcEjectValues]**
  */
 function replaceRequest(url) {
-    const rules = (0, SwppRules_1.readRules)();
+    const rules = (0, Variant_1.readRules)();
     if (!('modifyRequest' in rules))
         return url;
     const { modifyRequest } = rules;

package/dist/ServiceWorkerBuilder.js

@@ -4,10 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildServiceWorker = void 0;
-const SwppRules_1 = require("./SwppRules");
 const Utils_1 = require("./Utils");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const Variant_1 = require("./Variant");
 /**
  * 构建 sw
  *
@@ -15,9 +15,13 @@ const path_1 = __importDefault(require("path"));
  * + **执行该函数前必须调用过 [calcEjectValues]**
  */
 function buildServiceWorker() {
-    const rules = (0, SwppRules_1.readRules)();
+    const rules = (0, Variant_1.readRules)();
     const eject = (0, Utils_1.readEjectData)();
     const { modifyRequest, fetchFile, getRaceUrls, getSpareUrls, blockRequest, config } = rules;
+    if (!config.serviceWorker) {
+        (0, Utils_1.error)('ServiceWorkerBuilder', '插件未开启该项');
+        throw '功能未开启';
+    }
     const serviceWorkerConfig = config.serviceWorker;
     const templatePath = path_1.default.resolve('./', module.path, 'resources/sw-template.js');
     // 获取拓展文件

package/dist/SwppRules.js

@@ -3,78 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadRules = exports.addRulesMapEvent = exports.readRules = void 0;
+exports.addRulesMapEvent = exports.loadRules = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const Utils_1 = require("./Utils");
-const defConfig = {
-    serviceWorker: {
-        escape: 0,
-        cacheName: 'kmarBlogCache',
-        debug: false
-    },
-    register: {
-        onerror: () => console.error('Service Worker 注册失败！可能是由于您的浏览器不支持该功能！'),
-        builder: (root, _, pluginConfig) => {
-            const registerConfig = pluginConfig.register;
-            const { onerror, onsuccess } = registerConfig;
-            return `<script>
-                (() => {
-                    let sw = navigator.serviceWorker
-                    let error = ${onerror.toString()}
-                    if (!sw?.register('${new URL(root).pathname}sw.js')
-                        ${onsuccess ? '?.then(' + onsuccess.toString() + ')' : ''}
-                        ?.catch(error)
-                    ) error()
-                })()
-            </script>`;
-        }
-    },
-    dom: {},
-    json: {
-        maxHtml: 15,
-        charLimit: 1024,
-        merge: [],
-        exclude: {
-            localhost: [/^\/sw\.js$/],
-            other: []
-        }
-    },
-    external: {
-        timeout: 5000,
-        js: [],
-        stable: [],
-        replacer: it => it
-    }
-};
-let eventList = [];
-let _rules;
-/**
- * 读取最后一次构建的 rules
- *
- * **执行该函数前必须调用过 [loadRules]**
- */
-function readRules() {
-    if (!_rules) {
-        (0, Utils_1.error)('RulesReader', 'rules 尚未初始化');
-        throw 'rules 尚未初始化';
-    }
-    return _rules;
-}
-exports.readRules = readRules;
-/**
- * 添加一个 rules 映射事件，这个事件允许用户修改 rules 的内容
- *
- * 执行时按照注册的顺序执行
- */
-function addRulesMapEvent(mapper) {
-    if (!eventList) {
-        (0, Utils_1.error)('AddRulesMapEvent', '规则文件已经加载完成，调用该函数无意义！');
-        throw 'addRulesMapEvent 调用时机错误';
-    }
-    eventList.push(mapper);
-}
-exports.addRulesMapEvent = addRulesMapEvent;
+const Variant_1 = require("./Variant");
 /**
  * 加载 rules 文件
  * @param root 项目根目录
@@ -82,6 +15,8 @@ exports.addRulesMapEvent = addRulesMapEvent;
  * @param selects 附加的可选目录，优先级低于 [root]
  */
 function loadRules(root, fileName, selects) {
+    const eventList = (0, Variant_1.readEvent)('addRulesMapEvent');
+    (0, Variant_1.writeVariant)('addRulesMapEvent', false);
     // 支持的拓展名
     const extensions = ['cjs', 'js'];
     // 根目录下的 rules 文件
@@ -98,14 +33,15 @@ function loadRules(root, fileName, selects) {
     const config = rootRules.config ?? {};
     mergeConfig(config, selectRules.config ?? {});
     mergeConfig(config, defConfig);
-    Object.assign(rootRules, selectRules);
+    for (let key in selectRules) {
+        if (!(key in rootRules))
+            rootRules[key] = selectRules[key];
+    }
     rootRules.config = config;
     for (let event of eventList) {
         event(rootRules);
     }
-    eventList = null;
-    (0, Utils_1.deepFreeze)(rootRules);
-    return _rules = rootRules;
+    return (0, Variant_1.writeVariant)('swppRules', (0, Utils_1.deepFreeze)(rootRules));
 }
 exports.loadRules = loadRules;
 /** 合并配置项 */
@@ -126,3 +62,54 @@ function mergeConfig(dist, that) {
     }
     return dist;
 }
+(0, Variant_1.writeVariant)('addRulesMapEvent', []);
+/**
+ * 添加一个 rules 映射事件，这个事件允许用户修改 rules 的内容
+ *
+ * 执行时按照注册的顺序执行
+ */
+function addRulesMapEvent(mapper) {
+    (0, Variant_1.readEvent)('addRulesMapEvent').push(mapper);
+}
+exports.addRulesMapEvent = addRulesMapEvent;
+const defConfig = {
+    serviceWorker: {
+        escape: 0,
+        cacheName: 'kmarBlogCache',
+        debug: false
+    },
+    register: {
+        onerror: () => console.error('Service Worker 注册失败！可能是由于您的浏览器不支持该功能！'),
+        builder: (root, _, pluginConfig) => {
+            const registerConfig = pluginConfig.register;
+            const { onerror, onsuccess } = registerConfig;
+            return `<script>
+                (() => {
+                    let sw = navigator.serviceWorker
+                    let error = ${onerror.toString()}
+                    if (!sw?.register('${new URL(root).pathname}sw.js')
+                        ${onsuccess ? '?.then(' + onsuccess.toString() + ')' : ''}
+                        ?.catch(error)
+                    ) error()
+                })()
+            </script>`;
+        }
+    },
+    dom: {},
+    json: {
+        maxHtml: 15,
+        charLimit: 1024,
+        merge: [],
+        exclude: {
+            localhost: [/^\/sw\.js$/],
+            other: []
+        }
+    },
+    external: {
+        timeout: 5000,
+        concurrencyLimit: 100,
+        js: [],
+        stable: [],
+        replacer: (it) => it
+    }
+};