swpp-backends 0.0.1-alpha.1 → 0.0.2-alpha

package/dist/fileAnalyzer.js

@@ -26,7 +26,7 @@ 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.eachAllLinkInJavaScript = exports.eachAllLinkInCss = exports.eachAllLinkInHtml = exports.eachAllLinkInUrl = exports.buildVersionJson = exports.readMergeVersionMap = exports.readNewVersionJson = exports.readOldVersionJson = exports.loadVersionJson = exports.isStable = exports.isExclude = void 0;
+exports.replaceRequest = exports.findCache = exports.eachAllLinkInJavaScript = exports.eachAllLinkInCss = exports.eachAllLinkInHtml = exports.eachAllLinkInUrl = exports.buildVersionJson = exports.readMergeVersionMap = exports.readNewVersionJson = exports.readOldVersionJson = exports.submitCacheInfo = exports.loadVersionJson = exports.isStable = exports.isExclude = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const node_fetch_1 = require("node-fetch");
@@ -55,14 +55,14 @@ function eachAllFile(root, cb) {
  *
  * + **执行该函数前必须调用过 [loadRules]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param url 要判断的 URL
  */
-function isExclude(webRoot, url) {
+function isExclude(domain, url) {
     const exclude = (0, SwppRules_1.readRules)().config?.json?.exclude;
     if (!exclude)
         throw 'exclude 为空';
-    const list = isExternalLink(webRoot, url) ? exclude.other : exclude.localhost;
+    const list = isExternalLink(domain, url) ? exclude.other : exclude.localhost;
     for (let reg of list) {
         if (url.match(reg))
             return true;
@@ -99,6 +99,12 @@ exports.loadVersionJson = loadVersionJson;
 let _oldVersionJson;
 let _newVersionJson;
 let _mergeVersionMap;
+const event = [];
+/** 提交要存储到 version json 的值 */
+function submitCacheInfo(value) {
+    event.push(value);
+}
+exports.submitCacheInfo = submitCacheInfo;
 /**
  * 读取最后一次加载的 version json
  *
@@ -143,23 +149,23 @@ function readMergeVersionMap() {
 }
 exports.readMergeVersionMap = readMergeVersionMap;
 /**
- * 构建一个 cache json
+ * 构建一个 version json
  *
  * + **执行该函数前必须调用过 [loadRules]**
  * + **调用该函数前必须调用过 [loadCacheJson]**
  * + **执行该函数前必须调用过 [calcEjectValues]**
  *
  * @param protocol 网站的网络协议
- * @param webRoot 网站域名（包括二级域名）
+ * @param domain 网站域名（包括二级域名）
  * @param root 网页根目录（首页 index.html 所在目录）
  */
-async function buildVersionJson(protocol, webRoot, root) {
+async function buildVersionJson(protocol, domain, root) {
     const list = {};
     eachAllFile(root, async (path) => {
         const endIndex = path.length - (path.endsWith('/index.html') ? 10 : 0);
-        const url = new URL(protocol + path_1.default.join(webRoot, path.substring(root.length, endIndex)));
+        const url = new URL(protocol + path_1.default.join(domain, path.substring(root.length, endIndex)));
         const pathname = url.pathname;
-        if (isExclude(webRoot, pathname))
+        if (isExclude(domain, pathname))
             return;
         let content = null;
         if (findCache(url)) {
@@ -170,17 +176,17 @@ async function buildVersionJson(protocol, webRoot, root) {
         if (pathname.endsWith('/') || pathname.endsWith('.html')) {
             if (!content)
                 content = fs_1.default.readFileSync(path, 'utf-8');
-            await eachAllLinkInHtml(webRoot, content, list);
+            await eachAllLinkInHtml(domain, content, list);
         }
         else if (pathname.endsWith('.css')) {
             if (!content)
                 content = fs_1.default.readFileSync(path, 'utf-8');
-            await eachAllLinkInCss(webRoot, content, list);
+            await eachAllLinkInCss(domain, content, list);
         }
         else if (pathname.endsWith('.js')) {
             if (!content)
                 content = fs_1.default.readFileSync(path, 'utf-8');
-            await eachAllLinkInJavaScript(webRoot, content, list);
+            await eachAllLinkInJavaScript(domain, content, list);
         }
     });
     return _newVersionJson = {
@@ -197,19 +203,19 @@ exports.buildVersionJson = buildVersionJson;
  * + **调用该函数前必须调用过 [loadCacheJson]**
  * + **执行该函数前必须调用过 [calcEjectValues]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param url 要检索的 URL
  * @param result 存放结果的对象
  * @param event 检索到一个 URL 时触发的事件
  */
-async function eachAllLinkInUrl(webRoot, url, result, event) {
+async function eachAllLinkInUrl(domain, url, result, event) {
     if (url.startsWith('//'))
         url = 'http' + url;
     if (url in result)
         return event?.(url);
-    if (!url.startsWith('http') || isExclude(webRoot, url))
+    if (!url.startsWith('http') || isExclude(domain, url))
         return;
-    if (!(isExternalLink(webRoot, url) && findCache(new URL(url))))
+    if (!(isExternalLink(domain, url) && findCache(new URL(url))))
         return;
     event?.(url);
     const stable = isStable(url);
@@ -249,15 +255,15 @@ async function eachAllLinkInUrl(webRoot, url, result, event) {
         case pathname.endsWith('.html'):
         case pathname.endsWith('/'):
             content = await response.text();
-            await eachAllLinkInHtml(webRoot, content, result, nextEvent);
+            await eachAllLinkInHtml(domain, content, result, nextEvent);
             break;
         case pathname.endsWith('.css'):
             content = await response.text();
-            await eachAllLinkInCss(webRoot, content, result, nextEvent);
+            await eachAllLinkInCss(domain, content, result, nextEvent);
             break;
         case pathname.endsWith('.js'):
             content = await response.text();
-            await eachAllLinkInJavaScript(webRoot, content, result, nextEvent);
+            await eachAllLinkInJavaScript(domain, content, result, nextEvent);
             break;
         default:
             if (stable) {
@@ -287,12 +293,12 @@ exports.eachAllLinkInUrl = eachAllLinkInUrl;
  * + **执行该函数前必须调用过 [loadRules]**
  * + **调用该函数前必须调用过 [loadCacheJson]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param content HTML 文件内容
  * @param result 存放结果的对象
  * @param event 检索到 URL 时触发的事件
  */
-async function eachAllLinkInHtml(webRoot, content, result, event) {
+async function eachAllLinkInHtml(domain, content, result, event) {
     const each = async (node) => {
         let url = undefined;
         switch (node.tagName) {
@@ -311,13 +317,13 @@ async function eachAllLinkInHtml(webRoot, content, result, event) {
                 break;
         }
         if (url) {
-            await eachAllLinkInUrl(webRoot, url, result, event);
+            await eachAllLinkInUrl(domain, url, result, event);
         }
         else if (node.tagName === 'script') {
-            await eachAllLinkInJavaScript(webRoot, node.rawText, result, event);
+            await eachAllLinkInJavaScript(domain, node.rawText, result, event);
         }
         else if (node.tagName === 'style') {
-            await eachAllLinkInCss(webRoot, node.rawText, result, event);
+            await eachAllLinkInCss(domain, node.rawText, result, event);
         }
         for (let childNode of node.childNodes) {
             await each(childNode);
@@ -334,12 +340,12 @@ exports.eachAllLinkInHtml = eachAllLinkInHtml;
  * + **执行该函数前必须调用过 [loadRules]**
  * + **调用该函数前必须调用过 [loadCacheJson]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param content CSS 文件内容
  * @param result 存放结果的对象
  * @param event 当检索到一个 URL 后触发的事件
  */
-async function eachAllLinkInCss(webRoot, content, result, event) {
+async function eachAllLinkInCss(domain, content, result, event) {
     const each = async (any) => {
         if (!any)
             return;
@@ -354,13 +360,13 @@ async function eachAllLinkInCss(webRoot, content, result, event) {
                         ?.map(it => it.replace(/(^url\(['"])|(['"]\)$)/g, ''));
                     if (list) {
                         for (let url of list) {
-                            await eachAllLinkInUrl(webRoot, url, result, event);
+                            await eachAllLinkInUrl(domain, url, result, event);
                         }
                     }
                     break;
                 case 'import':
                     const url = rule.import.trim().replace(/^["']|["']$/g, '');
-                    await eachAllLinkInUrl(webRoot, url, result, event);
+                    await eachAllLinkInUrl(domain, url, result, event);
                     break;
             }
         }
@@ -376,12 +382,12 @@ exports.eachAllLinkInCss = eachAllLinkInCss;
  * + **执行该函数前必须调用过 [loadRules]**
  * + **调用该函数前必须调用过 [loadCacheJson]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param content JS 文件内容
  * @param result 存放结果的对象
  * @param event 当检索到一个 URL 后触发的事件
  */
-async function eachAllLinkInJavaScript(webRoot, content, result, event) {
+async function eachAllLinkInJavaScript(domain, content, result, event) {
     const ruleList = (0, SwppRules_1.readRules)().config?.external?.js;
     if (!ruleList)
         throw 'ruleList 为空';
@@ -389,7 +395,7 @@ async function eachAllLinkInJavaScript(webRoot, content, result, event) {
         if (typeof value === 'function') {
             const urls = value(content);
             for (let url of urls) {
-                await eachAllLinkInUrl(webRoot, url, result, event);
+                await eachAllLinkInUrl(domain, url, result, event);
             }
         }
         else {
@@ -400,7 +406,7 @@ async function eachAllLinkInJavaScript(webRoot, content, result, event) {
                 ?.map(it => it.replace(/^['"`]|['"`]$/g, ''));
             if (list) {
                 for (let url of list) {
-                    await eachAllLinkInUrl(webRoot, url, result, event);
+                    await eachAllLinkInUrl(domain, url, result, event);
                 }
             }
         }
@@ -408,8 +414,8 @@ async function eachAllLinkInJavaScript(webRoot, content, result, event) {
 }
 exports.eachAllLinkInJavaScript = eachAllLinkInJavaScript;
 /** 判断一个 URL 是否是外部链接 */
-function isExternalLink(webRoot, url) {
-    return new RegExp(`^(https?:)?\\/\\/${webRoot}`).test(url);
+function isExternalLink(domain, url) {
+    return new RegExp(`^(https?:)?\\/\\/${domain}`).test(url);
 }
 /**
  * 查询指定 URL 对应的缓存规则

package/dist/index.js

@@ -24,7 +24,7 @@ exports.default = {
         loadRules: SwppRules_1.loadRules, loadUpdateJson: UpdateJsonBuilder_1.loadUpdateJson, loadVersionJson: FileAnalyzer_1.loadVersionJson
     },
     event: {
-        addRulesMapEvent: SwppRules_1.addRulesMapEvent, refreshUrl: VersionAnalyzer_1.refreshUrl, submitChange: UpdateJsonBuilder_1.submitChange
+        addRulesMapEvent: SwppRules_1.addRulesMapEvent, refreshUrl: VersionAnalyzer_1.refreshUrl, submitChange: UpdateJsonBuilder_1.submitChange, submitCacheInfo: FileAnalyzer_1.submitCacheInfo
     },
     utils: {
         getSource: Utils_1.getSource, getShorthand: UpdateJsonBuilder_1.getShorthand, findCache: FileAnalyzer_1.findCache,

package/package.json

@@ -1,34 +1,37 @@
-{
-  "name": "swpp-backends",
-  "version": "0.0.1-alpha.1",
-  "main": "dist/index.js",
-  "typings": "types/index.d.ts",
-  "scripts": {
-    "prepublishOnly": "tsc && gulp copy-resources"
-  },
-  "description": "Generate a powerful ServiceWorker for your website.",
-  "author": "kmar",
-  "license": "AGPL-3.0",
-  "files": [
-    "dist", "types"
-  ],
-  "devDependencies": {
-    "@types/css": "^0.0.33",
-    "@types/fast-html-parser": "^1.0.2",
-    "@types/node": "^20.4.5",
-    "gulp": "^4.0.2",
-    "typescript": "^5.1.6"
-  },
-  "dependencies": {
-    "css": "^3.0.0",
-    "fast-html-parser": "^1.0.1",
-    "hexo-log": "^4.1.0",
-    "node-fetch": "^3.3.2"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:EmptyDreams/swpp-backends.git"
-  },
-  "homepage": "https://github.com/EmptyDreams/swpp-backends",
-  "keywords": ["ServiceWorker", "sw"]
+{
+  "name": "swpp-backends",
+  "version": "0.0.2-alpha",
+  "main": "dist/index.js",
+  "typings": "types/index.d.ts",
+  "description": "Generate a powerful ServiceWorker for your website.",
+  "author": "kmar",
+  "license": "AGPL-3.0",
+  "files": [
+    "dist",
+    "types"
+  ],
+  "devDependencies": {
+    "@types/css": "^0.0.33",
+    "@types/fast-html-parser": "^1.0.2",
+    "@types/node": "^20.4.5",
+    "gulp": "^4.0.2",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@types/node-fetch": "^2.6.4",
+    "css": "^3.0.0",
+    "fast-html-parser": "^1.0.1",
+    "hexo-log": "^4.1.0",
+    "node-fetch": "^2.6.12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/EmptyDreams/swpp-backends.git"
+  },
+  "homepage": "https://github.com/EmptyDreams/swpp-backends",
+  "keywords": [
+    "ServiceWorker",
+    "sw"
+  ],
+  "scripts": {}
 }

package/types/fileAnalyzer.d.ts

@@ -21,10 +21,10 @@ export interface VersionMap {
  *
  * + **执行该函数前必须调用过 [loadRules]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param url 要判断的 URL
  */
-export declare function isExclude(webRoot: string, url: string): boolean;
+export declare function isExclude(domain: string, url: string): boolean;
 /**
  * 判断指定 URL 是否是 stable 的
  *
@@ -37,6 +37,8 @@ export declare function isStable(url: string): boolean;
  * + **执行该函数前必须调用过 [loadRules]**
  */
 export declare function loadVersionJson(url: string): Promise<VersionJson>;
+/** 提交要存储到 version json 的值 */
+export declare function submitCacheInfo(value: any): void;
 /**
  * 读取最后一次加载的 version json
  *
@@ -63,17 +65,17 @@ export declare function readNewVersionJson(): VersionJson;
  */
 export declare function readMergeVersionMap(): VersionMap;
 /**
- * 构建一个 cache json
+ * 构建一个 version json
  *
  * + **执行该函数前必须调用过 [loadRules]**
  * + **调用该函数前必须调用过 [loadCacheJson]**
  * + **执行该函数前必须调用过 [calcEjectValues]**
  *
  * @param protocol 网站的网络协议
- * @param webRoot 网站域名（包括二级域名）
+ * @param domain 网站域名（包括二级域名）
  * @param root 网页根目录（首页 index.html 所在目录）
  */
-export declare function buildVersionJson(protocol: ('https://' | 'http://'), webRoot: string, root: string): Promise<VersionJson>;
+export declare function buildVersionJson(protocol: ('https://' | 'http://'), domain: string, root: string): Promise<VersionJson>;
 /**
  * 检索一个 URL 指向的文件中所有地外部链接
  *
@@ -83,12 +85,12 @@ export declare function buildVersionJson(protocol: ('https://' | 'http://'), web
  * + **调用该函数前必须调用过 [loadCacheJson]**
  * + **执行该函数前必须调用过 [calcEjectValues]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param url 要检索的 URL
  * @param result 存放结果的对象
  * @param event 检索到一个 URL 时触发的事件
  */
-export declare function eachAllLinkInUrl(webRoot: string, url: string, result: VersionMap, event?: (url: string) => void): Promise<void>;
+export declare function eachAllLinkInUrl(domain: string, url: string, result: VersionMap, event?: (url: string) => void): Promise<void>;
 /**
  * 检索 HTML 文件中的所有外部链接
  *
@@ -97,12 +99,12 @@ export declare function eachAllLinkInUrl(webRoot: string, url: string, result: V
  * + **执行该函数前必须调用过 [loadRules]**
  * + **调用该函数前必须调用过 [loadCacheJson]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param content HTML 文件内容
  * @param result 存放结果的对象
  * @param event 检索到 URL 时触发的事件
  */
-export declare function eachAllLinkInHtml(webRoot: string, content: string, result: VersionMap, event?: (url: string) => void): Promise<void>;
+export declare function eachAllLinkInHtml(domain: string, content: string, result: VersionMap, event?: (url: string) => void): Promise<void>;
 /**
  * 检索 CSS 文件中的所有外部链
  *
@@ -111,12 +113,12 @@ export declare function eachAllLinkInHtml(webRoot: string, content: string, resu
  * + **执行该函数前必须调用过 [loadRules]**
  * + **调用该函数前必须调用过 [loadCacheJson]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param content CSS 文件内容
  * @param result 存放结果的对象
  * @param event 当检索到一个 URL 后触发的事件
  */
-export declare function eachAllLinkInCss(webRoot: string, content: string, result: VersionMap, event?: (url: string) => void): Promise<void>;
+export declare function eachAllLinkInCss(domain: string, content: string, result: VersionMap, event?: (url: string) => void): Promise<void>;
 /**
  * 遍历 JS 文件中地所有外部链接
  *
@@ -125,12 +127,12 @@ export declare function eachAllLinkInCss(webRoot: string, content: string, resul
  * + **执行该函数前必须调用过 [loadRules]**
  * + **调用该函数前必须调用过 [loadCacheJson]**
  *
- * @param webRoot 网站域名
+ * @param domain 网站域名
  * @param content JS 文件内容
  * @param result 存放结果的对象
  * @param event 当检索到一个 URL 后触发的事件
  */
-export declare function eachAllLinkInJavaScript(webRoot: string, content: string, result: VersionMap, event?: (url: string) => void): Promise<void>;
+export declare function eachAllLinkInJavaScript(domain: string, content: string, result: VersionMap, event?: (url: string) => void): Promise<void>;
 /**
  * 查询指定 URL 对应的缓存规则
  *

package/types/index.d.ts

@@ -1,5 +1,5 @@
 import { readEjectData, getSource, fetchFile, replaceDevRequest, calcEjectValues } from './Utils';
-import { isExclude, isStable, loadVersionJson, readOldVersionJson, readNewVersionJson, readMergeVersionMap, buildVersionJson, eachAllLinkInUrl, eachAllLinkInHtml, eachAllLinkInCss, eachAllLinkInJavaScript, findCache, replaceRequest } from './FileAnalyzer';
+import { isExclude, isStable, loadVersionJson, readOldVersionJson, readNewVersionJson, readMergeVersionMap, buildVersionJson, eachAllLinkInUrl, eachAllLinkInHtml, eachAllLinkInCss, eachAllLinkInJavaScript, findCache, replaceRequest, submitCacheInfo } from './FileAnalyzer';
 import { buildServiceWorker } from './ServiceWorkerBuilder';
 import { readRules, loadRules, addRulesMapEvent } from './SwppRules';
 import { readUpdateJson, loadUpdateJson, submitChange, getShorthand, buildNewInfo } from './UpdateJsonBuilder';
@@ -29,6 +29,7 @@ declare const _default: {
         addRulesMapEvent: typeof addRulesMapEvent;
         refreshUrl: typeof refreshUrl;
         submitChange: typeof submitChange;
+        submitCacheInfo: typeof submitCacheInfo;
     };
     utils: {
         getSource: typeof getSource;