swpp-backends 1.1.1 → 1.2.0

package/README.md

@@ -1,5 +1,41 @@
 ## 欢迎使用 SwppBackends
 
-  这是 Service Worker Plus Plus 的后端仓库，代码正在开发中，开发完毕后会在这里补充文档并上传到 npm。
+swpp-backends（以下简称 swpp）插件的功能是为网站生成一个高度可用的 ServiceWorker（以下简称 SW），为网站优化二次加载、提供离线体验、提高可靠性，并为此附带了一些其它的功能。
 
-  有兴趣的可以看 [hexo-swpp | 山岳库博](https://kmar.top/posts/73014407/)。
+swpp 的全拼为“ServiceWorkerPlusPlus”（或“ServiceWorker++”），但是其与已有的插件“hexo-service-worker”并没有关系，插件中所有代码均为我个人开发，这一点请不要误解。
+
+swpp 生成的 SW 与其它插件的对比：
+
+|            |     swpp      | hexo-offline |
+|:----------:|:-------------:|:------------:|
+|    本地缓存    |      ✔️       |      ✔️      |
+|   缓存增量更新   |      ✔️       |      ❌       |
+|   缓存过期时间   | ❌<sup>1</sup> |      ✔️      |
+|   缓存大小限制   |       ❌       |      ✔️      |
+|    预缓存     |       ❌       |      ✔️      |
+| Request 篡改 |      ✔️       |      ❌       |
+|   URL 竞速   |      ✔️       |      ❌       |
+|   备用 URL   |      ✔️       |      ❌       |
+|    阻塞响应    |      ✔️       |      ❌       |
+|    逃生门     |      ✔️       |      ❌       |
+|    跨平台     |      ✔️       |      ❌       |
+|    高度自由    |      ✔️       |      ❌       |
+|     更新     |     非常频繁      |   超过两年没有更新   |
+
+<small>&emsp;注：上面提到的跨平台是指跨越框架（比如 Hexo、WordPress 等）。</small>
+
++ ✔️：支持
++ ❌：不支持
+
+1. 因为有增量更新，所以没提供过期的实现，没必要
+
+
+目前支持的平台：
+
+|  平台  |     插件名     |                            文档                             |           作者            |
+|:----:|:-----------:|:---------------------------------------------------------:|:-----------------------:|
+| hexo | `hexo-swpp` | [github](https://github.com/EmptyDreams/hexo-swpp#readme) | [空梦](https://kmar.top/) |
+
+如果你为某一个平台做了适配，可以在 gh 上发布 issue 或者在文档页面发布评论~
+
+文档：[Swpp Backends 官方文档 | 山岳库博](https://kmar.top/posts/b70ec88f/)

package/dist/FileAnalyzer.js

@@ -34,7 +34,6 @@ 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 css_1 = __importDefault(require("css"));
 const Utils_1 = require("./Utils");
 /**
  * 遍历指定目录及其子目录中包含的所有文件（不遍历文件夹）
@@ -316,7 +315,6 @@ async function eachAllLinkInUrl(domain, url, result, event) {
 }
 exports.eachAllLinkInUrl = eachAllLinkInUrl;
 async function eachAllLinkInHtml(domain, url, content, result, event) {
-    const root = url.substring(0, url.lastIndexOf('/') + 1);
     const taskList = [];
     const each = (node) => {
         let subUrl = undefined;
@@ -364,48 +362,39 @@ async function eachAllLinkInHtml(domain, url, content, result, event) {
     return Promise.all(taskList);
 }
 async function eachAllLinkInCss(domain, url, content, result, event) {
-    const root = url.substring(0, url.lastIndexOf('/') + 1);
-    const taskList = [];
-    const each = (any) => {
-        if (!any)
-            return;
-        for (let rule of any) {
-            if (rule.declarations)
-                each(rule.declarations);
-            switch (rule.type) {
-                case 'declaration':
-                    const value = rule.value;
-                    const list = value.match(/url\(['"]?([^'")]+)['"]?\)/g)
-                        ?.map(it => it.replace(/(^url\(['"]?)|(['"]?\)$)/g, ''));
-                    if (list) {
-                        for (let url of list) {
-                            if (!/^(https?:)|(\/\/)/.test(url)) {
-                                if (url[0] === '/')
-                                    url = root + url.substring(1);
-                                else
-                                    url = root + url;
-                            }
-                            taskList.push(eachAllLinkInUrl(domain, url, result, event));
-                        }
-                    }
-                    break;
-                case 'import':
-                    const url = rule.import.trim().replace(/^["']|["']$/g, '');
-                    taskList.push(eachAllLinkInUrl(domain, url, result, event));
-                    break;
-            }
+    const root = url.substring(0, url.lastIndexOf('/'));
+    const urls = new Set();
+    for (let i = 0; i < content.length;) {
+        const left = content.indexOf('/*', i);
+        let sub;
+        if (left < 0) {
+            sub = content.substring(i);
+            i = Number.MAX_VALUE;
         }
-    };
-    let css;
-    try {
-        css = css_1.default.parse(content).stylesheet?.rules;
-    }
-    catch (e) {
-        (0, Utils_1.error)('CssParser', `CSS [root=${root}] 中存在错误语法`);
+        else {
+            sub = content.substring(i, left);
+            const right = content.indexOf('*/', left + 2);
+            if (right < 0)
+                i = Number.MAX_VALUE;
+            else
+                i = right + 2;
+        }
+        sub.match(/(url\(.*?\))|(@import\s+['"].*?['"])|((https?:)?\/\/[^\s/$.?#].\S*)/g)
+            ?.map(it => it.replace(/(^url\((['"]?))|((['"]?)\)$)|(^@import\s+['"])|(['"]$)/g, ''))
+            ?.forEach(it => urls.add(it));
     }
-    if (css)
-        each(css);
-    return Promise.all(taskList);
+    return Promise.all(Array.from(urls).map(it => {
+        switch (true) {
+            case it.startsWith('http'):
+                return it;
+            case it.startsWith('//'):
+                return 'http' + it;
+            case it.startsWith('/'):
+                return root + it;
+            default:
+                return root + '/' + it;
+        }
+    }).map(it => eachAllLinkInUrl(domain, it, result, event)));
 }
 function eachAllLinkInJavaScript(domain, _, content, result, event) {
     const taskList = [];

package/dist/ServiceWorkerBuilder.js

@@ -57,7 +57,7 @@ function buildServiceWorker() {
     if (blockRequest) {
         content = content.replace('// [blockRequest call]', `
                 if (blockRequest(url))
-                    return event.respondWith(new Response(null, {status: 208}))
+                    return event.respondWith(new Response(null, {status: 204}))
             `);
     }
     // noinspection JSUnresolvedVariable

package/dist/SwppRules.js

@@ -104,6 +104,7 @@ function loadRules(root, fileName, selects) {
         event(rootRules);
     }
     eventList = null;
+    (0, Utils_1.deepFreeze)(rootRules);
     return _rules = rootRules;
 }
 exports.loadRules = loadRules;

package/dist/Utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.replaceDevRequest = exports.fetchFile = exports.getSource = exports.readEjectData = exports.calcEjectValues = exports.warn = exports.error = void 0;
+exports.deepFreeze = exports.replaceDevRequest = exports.fetchFile = exports.getSource = exports.readEjectData = exports.calcEjectValues = exports.warn = exports.error = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const SwppRules_1 = require("./SwppRules");
 const logger = require('hexo-log').default({
@@ -190,3 +190,15 @@ async function fetchSpeed(list) {
     }
     return result.response;
 }
+/** 深度冻结一个对象，这将使得无法修改对象中的任何值，也无法添加新的值 */
+function deepFreeze(obj) {
+    if (!obj)
+        return;
+    Object.freeze(obj);
+    for (let key in obj) {
+        const value = obj[key];
+        if (typeof value === 'object')
+            deepFreeze(value);
+    }
+}
+exports.deepFreeze = deepFreeze;

package/dist/index.js

@@ -8,6 +8,7 @@ const UpdateJsonBuilder_1 = require("./UpdateJsonBuilder");
 const VersionAnalyzer_1 = require("./VersionAnalyzer");
 // noinspection JSUnusedGlobalSymbols
 exports.default = {
+    version: '1.2.0',
     cache: {
         readEjectData: Utils_1.readEjectData, readUpdateJson: UpdateJsonBuilder_1.readUpdateJson,
         readRules: SwppRules_1.readRules, readMergeVersionMap: FileAnalyzer_1.readMergeVersionMap,
@@ -30,6 +31,6 @@ exports.default = {
         getSource: Utils_1.getSource, getShorthand: UpdateJsonBuilder_1.getShorthand, findCache: FileAnalyzer_1.findCache,
         fetchFile: Utils_1.fetchFile, replaceDevRequest: Utils_1.replaceDevRequest, replaceRequest: FileAnalyzer_1.replaceRequest,
         isStable: FileAnalyzer_1.isStable, isExclude: FileAnalyzer_1.isExclude, findFileHandler: FileAnalyzer_1.findFileHandler,
-        eachAllLinkInUrl: FileAnalyzer_1.eachAllLinkInUrl
+        eachAllLinkInUrl: FileAnalyzer_1.eachAllLinkInUrl, deepFreeze: Utils_1.deepFreeze
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swpp-backends",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "main": "dist/index.js",
   "typings": "types/index.d.ts",
   "description": "Generate a powerful ServiceWorker for your website.",
@@ -19,7 +19,6 @@
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "css": "^3.0.0",
     "fast-html-parser": "^1.0.1",
     "hexo-log": "^4.1.0",
     "node-fetch": "^2.6.12"

package/types/Utils.d.ts

@@ -39,3 +39,5 @@ export declare function fetchFile(link: string): Promise<import("node-fetch").Re
  * **调用该函数前必须调用过 [loadRules]**
  */
 export declare function replaceDevRequest(link: string): string[] | string;
+/** 深度冻结一个对象，这将使得无法修改对象中的任何值，也无法添加新的值 */
+export declare function deepFreeze(obj: any): void;

package/types/index.d.ts

@@ -1,10 +1,11 @@
-import { readEjectData, getSource, fetchFile, replaceDevRequest, calcEjectValues } from './Utils';
+import { readEjectData, getSource, fetchFile, replaceDevRequest, calcEjectValues, deepFreeze } from './Utils';
 import { isExclude, isStable, loadVersionJson, readOldVersionJson, readNewVersionJson, readMergeVersionMap, buildVersionJson, eachAllLinkInUrl, findCache, findFileHandler, replaceRequest, submitCacheInfo, submitExternalUrl, registryFileHandler } from './FileAnalyzer';
 import { buildServiceWorker } from './ServiceWorkerBuilder';
 import { readRules, loadRules, addRulesMapEvent } from './SwppRules';
 import { readUpdateJson, loadUpdateJson, submitChange, getShorthand, buildNewInfo } from './UpdateJsonBuilder';
 import { refreshUrl, analyze } from './VersionAnalyzer';
 declare const _default: {
+    version: string;
     cache: {
         readEjectData: typeof readEjectData;
         readUpdateJson: typeof readUpdateJson;
@@ -44,6 +45,7 @@ declare const _default: {
         isExclude: typeof isExclude;
         findFileHandler: typeof findFileHandler;
         eachAllLinkInUrl: typeof eachAllLinkInUrl;
+        deepFreeze: typeof deepFreeze;
     };
 };
 export default _default;