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

package/dist/swppRules.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.SwppRulesLoadError = exports.loadRules = void 0;
+exports.loadRules = exports.addRulesMapEvent = exports.readRules = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const defConfig = {
@@ -33,19 +33,41 @@ const defConfig = {
     json: {
         maxHtml: 15,
         charLimit: 1024,
-        precisionMode: {
-            'default': false
-        },
         merge: [],
-        exclude: [/^\/sw\.js$/]
+        exclude: {
+            localhost: [/^\/sw\.js$/],
+            other: []
+        }
     },
     external: {
         timeout: 5000,
         js: [],
-        skip: [],
+        stable: [],
         replacer: it => it
     }
 };
+const eventList = [];
+let _rules;
+/**
+ * 读取最后一次构建的 rules
+ *
+ * **执行该函数前必须调用过 [loadRules]**
+ */
+function readRules() {
+    if (!_rules)
+        throw 'rules 尚未初始化';
+    return _rules;
+}
+exports.readRules = readRules;
+/**
+ * 添加一个 rules 映射事件，这个事件允许用户修改 rules 的内容
+ *
+ * 执行时按照注册的顺序执行
+ */
+function addRulesMapEvent(mapper) {
+    eventList.push(mapper);
+}
+exports.addRulesMapEvent = addRulesMapEvent;
 /**
  * 加载 rules 文件
  * @param root 项目根目录
@@ -54,14 +76,14 @@ const defConfig = {
  */
 function loadRules(root, fileName, selects) {
     // 支持的拓展名
-    const extensions = ['ts', 'cjs', 'js'];
+    const extensions = ['cjs', 'js'];
     // 根目录下的 rules 文件
     const rootPath = extensions.map(it => path_1.default.resolve(root, `${fileName}.${it}`))
         .find(it => fs_1.default.existsSync(it));
     // 其它可选目录下的 rules 文件
     const selectPath = selects.flatMap(value => extensions.map(it => path_1.default.resolve(value, `${fileName}.${it}`))).find(it => fs_1.default.existsSync(it));
     if (!(rootPath || selectPath))
-        throw new SwppRulesLoadError('未查询到 rules 文件');
+        throw '未查询到 rules 文件';
     const rootRules = rootPath ? { ...require(rootPath) } : {};
     const selectRules = selectPath ? require(selectPath) : {};
     const config = rootRules.config ?? {};
@@ -69,7 +91,10 @@ function loadRules(root, fileName, selects) {
     mergeConfig(config, defConfig);
     Object.assign(rootRules, selectRules);
     rootRules.config = config;
-    return rootRules;
+    for (let event of eventList) {
+        event(rootRules);
+    }
+    return _rules = rootRules;
 }
 exports.loadRules = loadRules;
 /** 合并配置项 */
@@ -90,10 +115,3 @@ function mergeConfig(dist, that) {
     }
     return dist;
 }
-/** rules 加载异常 */
-class SwppRulesLoadError {
-    constructor(message) {
-        this.message = message;
-    }
-}
-exports.SwppRulesLoadError = SwppRulesLoadError;

package/dist/utils.js

@@ -3,23 +3,35 @@ 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 = void 0;
+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({
     debug: false,
     silent: false
 });
+function error(type, message) {
+    logger.error(`[SWPP ${type}] ${message}`);
+}
+exports.error = error;
+function warn(type, message) {
+    logger.warn(`[SWPP ${type}] ${message}`);
+}
+exports.warn = warn;
 let ejectData = undefined;
 /**
  * 获取 eject values
+ *
+ * + **执行该函数前必须调用过 [loadRules]**
+ *
  * @param framework 框架对象
- * @param rules swpp rules 对象
  */
-function calcEjectValues(framework, rules) {
+function calcEjectValues(framework) {
+    const rules = (0, SwppRules_1.readRules)();
     if (!('ejectValues' in rules))
         return;
     // noinspection JSUnresolvedReference
-    const eject = rules.ejectValues(framework, rules);
+    const eject = rules.ejectValues?.(framework, rules);
     const nodeEject = {};
     let ejectStr = '';
     for (let key in eject) {
@@ -43,7 +55,12 @@ function calcEjectValues(framework, rules) {
     };
 }
 exports.calcEjectValues = calcEjectValues;
-/** 读取最近的已计算的 eject 数据 */
+/**
+ * 读取最近的已计算的 eject 数据
+ *
+ * + **执行该函数前必须调用过 [loadRules]**
+ * + **执行该函数前必须调用过 [calcEjectValues]**
+ */
 function readEjectData() {
     if (!ejectData)
         throw 'eject data 尚未初始化';
@@ -85,8 +102,9 @@ function getSource(obj, typeChecker = undefined, whiteList = undefined, isTop =
                     if (str.length === 0)
                         return '';
                     if (isTop && whiteList && ['cacheList', 'modifyRequest'].includes(key)) {
-                        str = str.replace(/\(\s*(.*?)\s*,\s*\$eject\s*\)/g, "$1")
-                            .replaceAll(/\$eject\.(\w+)/g, (_, match) => `eject${match[0].toUpperCase()}${match.substring(1)}`);
+                        str = str
+                            .replace(/\(\s*(.*?)\s*,\s*\$eject\s*\)/g, "$1") // 去掉箭头函数参数表中的 $eject
+                            .replaceAll(/\$eject\.(\w+)/g, (_, match) => `eject${match[0].toUpperCase()}${match.substring(1)}`); // 将函数体中的 $eject.xxx 替换为 ejectXxx
                     }
                     return isTop ? `let ${key} = ${str}` : `${key}: ${str}`;
                 })
@@ -112,9 +130,14 @@ function getSource(obj, typeChecker = undefined, whiteList = undefined, isTop =
     }
 }
 exports.getSource = getSource;
-/** 拉取文件 */
-async function fetchFile(config, link) {
-    const url = replaceDevRequest(config, link);
+/**
+ * 拉取文件
+ *
+ * **调用该函数前必须调用过 [loadRules]**
+ */
+async function fetchFile(link) {
+    const config = (0, SwppRules_1.readRules)().config;
+    const url = replaceDevRequest(link);
     const opts = {
         headers: {
             referer: 'kmar-swpp',
@@ -141,12 +164,17 @@ async function fetchFile(config, link) {
     }
 }
 exports.fetchFile = fetchFile;
-function replaceDevRequest(config, link) {
-    if (typeof config.external === 'boolean')
-        return link;
-    return config.external.replacer(link);
+/**
+ * 替换编译期的 URL（CDN 竞速）
+ *
+ * **调用该函数前必须调用过 [loadRules]**
+ */
+function replaceDevRequest(link) {
+    const config = (0, SwppRules_1.readRules)().config;
+    return config.external?.replacer(link) ?? link;
 }
 exports.replaceDevRequest = replaceDevRequest;
+/** 通过 CDN 竞速的方式拉取文件 */
 async function fetchSpeed(list) {
     const controllers = new Array(list.length);
     const result = await Promise.any(list.map((it, index) => (0, node_fetch_1.default)(it, {

package/package.json

@@ -1,22 +1,37 @@
-{
-  "name": "swpp-backends",
-  "version": "0.0.1-alpha.0",
-  "main": "dist/index.js",
-  "typings": "types/index.d.ts",
-  "scripts": {
-    "build": "tsc"
-  },
-  "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"
-  }
+{
+  "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/{src/SwppConfig.ts → types/SwppConfig.d.ts}

@@ -1,125 +1,125 @@
-/** Service Worker Plus Plus 的配置项 */
-export interface SwppConfig {
-    serviceWorker?: ServiceWorkerConfig,
-    register?: RegisterConfig,
-    dom?: DomConfig,
-    json?: VersionJsonConfig,
-    external?: ExternalMonitorConfig
-}
-
-/** 与 ServiceWorker 有关的配置 */
-export interface ServiceWorkerConfig {
-    /** 逃生门 */
-    escape: number,
-    /** 缓存库名称 */
-    cacheName: string,
-    /** 是否启用调试 */
-    debug: boolean
-}
-
-/** 与 ServiceWorker 注册有关的配置 */
-export interface RegisterConfig {
-    /** 注册成功后执行的代码 */
-    onsuccess?: VoidFunction,
-    /** 注册失败后执行的代码 */
-    onerror: VoidFunction
-    /**
-     * 生成注册 ServiceWorker 的 HTML 代码片段
-     * @param root 网页根目录的 URL
-     * @param framework 框架对象
-     * @param pluginConfig swpp 插件配置项
-     */
-    builder: (root: string, framework: any, pluginConfig: SwppConfig) => string
-}
-
-/** 与 DOM 端有关的配置 */
-export interface DomConfig {
-    /** 缓存更新成功后触发的操作 */
-    onsuccess: VoidFunction
-}
-
-/** 与版本文件相关的配置项 */
-export interface VersionJsonConfig {
-    /** 更新缓存时允许更新的最大 HTML 数量 */
-    maxHtml: number,
-    /** update.json 文件的字符数量限制 */
-    charLimit: number,
-    /** 是否合并指定项目 */
-    merge: string[],
-    /** 生成 cacheList.json 时忽略的文件 */
-    exclude: {
-        localhost: RegExp[],
-        other: RegExp[]
-    }
-}
-
-/** 外部文件更新监听 */
-export interface ExternalMonitorConfig {
-    /** 拉取网络文件的超时时间 */
-    timeout: number,
-    /** 匹配 JS 代码中的 URL */
-    js: ({ head: string, tail: string } | ((jsCode: string) => string[]))[],
-    /** 链接不变内容就不变的 URL */
-    stable: RegExp[],
-    /** 构建过程中将原始 URL 映射为新的 URL */
-    replacer: (srcUrl: string) => string[] | string
-}
-
-/** Service Worker Plus Plus 的配置项模板 */
-export interface SwppConfigTemplate {
-    /** 有关 ServiceWorker 的配置 */
-    serviceWorker?: boolean | {
-        /** 逃生门 */
-        escape?: number,
-        /** 缓存库名称 */
-        cacheName?: string,
-        /** 是否启用调试 */
-        debug?: boolean
-    },
-    /** 与 ServiceWorker 注册有关的配置 */
-    register: boolean | {
-        /** 注册成功后执行的代码 */
-        onsuccess?: VoidFunction,
-        /** 注册失败后执行的代码 */
-        onerror?: VoidFunction,
-        /**
-         * 生成注册 ServiceWorker 的 HTML 代码片段
-         * @param root 网页根目录的 URL
-         * @param framework 框架对象
-         * @param pluginConfig swpp 插件配置项
-         */
-        builder?: ((root: string, framework: any, pluginConfig: SwppConfig) => string) | undefined
-    },
-    /** 与 DOM 端有关的配置 */
-    dom?: boolean | {
-        /** 缓存更新成功后触发的操作 */
-        onsuccess?: VoidFunction
-    },
-    /** 与版本文件相关的配置项 */
-    json?: boolean | {
-        /** 更新缓存时允许更新的最大 HTML 数量 */
-        maxHtml?: number,
-        /** update.json 文件的字符数量限制 */
-        charLimit?: number,
-        /** 是否合并指定项目 */
-        merge?: string[],
-        /** 生成 cacheList.json 时忽略的文件 */
-        exclude?: {
-            /** 当前网站的 URL */
-            localhost?: RegExp[],
-            /** 其它网站的 URL */
-            other?: RegExp[]
-        }
-    },
-    /** 外部文件更新监听 */
-    external?: boolean | {
-        /** 拉取网络文件的超时时间 */
-        timeout?: number,
-        /** 匹配 JS 代码中的 URL */
-        js?: ({ head: string, tail: string } | ((jsCode: string) => string[]))[],
-        /** 链接不变内容就不变的 URL */
-        stable?: RegExp[],
-        /** 构建过程中将原始 URL 映射为新的 URL */
-        replacer?: (srcUrl: string) => string[] | string
-    }
-}
+/** Service Worker Plus Plus 的配置项 */
+export interface SwppConfig {
+    serviceWorker?: ServiceWorkerConfig;
+    register?: RegisterConfig;
+    dom?: DomConfig;
+    json?: VersionJsonConfig;
+    external?: ExternalMonitorConfig;
+}
+/** 与 ServiceWorker 有关的配置 */
+export interface ServiceWorkerConfig {
+    /** 逃生门 */
+    escape: number;
+    /** 缓存库名称 */
+    cacheName: string;
+    /** 是否启用调试 */
+    debug: boolean;
+}
+/** 与 ServiceWorker 注册有关的配置 */
+export interface RegisterConfig {
+    /** 注册成功后执行的代码 */
+    onsuccess?: VoidFunction;
+    /** 注册失败后执行的代码 */
+    onerror: VoidFunction;
+    /**
+     * 生成注册 ServiceWorker 的 HTML 代码片段
+     * @param root 网页根目录的 URL
+     * @param framework 框架对象
+     * @param pluginConfig swpp 插件配置项
+     */
+    builder: (root: string, framework: any, pluginConfig: SwppConfig) => string;
+}
+/** 与 DOM 端有关的配置 */
+export interface DomConfig {
+    /** 缓存更新成功后触发的操作 */
+    onsuccess: VoidFunction;
+}
+/** 与版本文件相关的配置项 */
+export interface VersionJsonConfig {
+    /** 更新缓存时允许更新的最大 HTML 数量 */
+    maxHtml: number;
+    /** update.json 文件的字符数量限制 */
+    charLimit: number;
+    /** 是否合并指定项目 */
+    merge: string[];
+    /** 生成 cacheList.json 时忽略的文件 */
+    exclude: {
+        localhost: RegExp[];
+        other: RegExp[];
+    };
+}
+/** 外部文件更新监听 */
+export interface ExternalMonitorConfig {
+    /** 拉取网络文件的超时时间 */
+    timeout: number;
+    /** 匹配 JS 代码中的 URL */
+    js: ({
+        head: string;
+        tail: string;
+    } | ((jsCode: string) => string[]))[];
+    /** 链接不变内容就不变的 URL */
+    stable: RegExp[];
+    /** 构建过程中将原始 URL 映射为新的 URL */
+    replacer: (srcUrl: string) => string[] | string;
+}
+/** Service Worker Plus Plus 的配置项模板 */
+export interface SwppConfigTemplate {
+    /** 有关 ServiceWorker 的配置 */
+    serviceWorker?: boolean | {
+        /** 逃生门 */
+        escape?: number;
+        /** 缓存库名称 */
+        cacheName?: string;
+        /** 是否启用调试 */
+        debug?: boolean;
+    };
+    /** 与 ServiceWorker 注册有关的配置 */
+    register: boolean | {
+        /** 注册成功后执行的代码 */
+        onsuccess?: VoidFunction;
+        /** 注册失败后执行的代码 */
+        onerror?: VoidFunction;
+        /**
+         * 生成注册 ServiceWorker 的 HTML 代码片段
+         * @param root 网页根目录的 URL
+         * @param framework 框架对象
+         * @param pluginConfig swpp 插件配置项
+         */
+        builder?: ((root: string, framework: any, pluginConfig: SwppConfig) => string) | undefined;
+    };
+    /** 与 DOM 端有关的配置 */
+    dom?: boolean | {
+        /** 缓存更新成功后触发的操作 */
+        onsuccess?: VoidFunction;
+    };
+    /** 与版本文件相关的配置项 */
+    json?: boolean | {
+        /** 更新缓存时允许更新的最大 HTML 数量 */
+        maxHtml?: number;
+        /** update.json 文件的字符数量限制 */
+        charLimit?: number;
+        /** 是否合并指定项目 */
+        merge?: string[];
+        /** 生成 cacheList.json 时忽略的文件 */
+        exclude?: {
+            /** 当前网站的 URL */
+            localhost?: RegExp[];
+            /** 其它网站的 URL */
+            other?: RegExp[];
+        };
+    };
+    /** 外部文件更新监听 */
+    external?: boolean | {
+        /** 拉取网络文件的超时时间 */
+        timeout?: number;
+        /** 匹配 JS 代码中的 URL */
+        js?: ({
+            head: string;
+            tail: string;
+        } | ((jsCode: string) => string[]))[];
+        /** 链接不变内容就不变的 URL */
+        stable?: RegExp[];
+        /** 构建过程中将原始 URL 映射为新的 URL */
+        replacer?: (srcUrl: string) => string[] | string;
+    };
+}

package/types/UpdateJsonBuilder.d.ts

@@ -0,0 +1,50 @@
+import { AnalyzerResult } from './VersionAnalyzer';
+/** 提交修改 */
+export declare function submitChange(...change: ChangeExpression[]): void;
+/**
+ * 加载版本文件
+ *
+ * + **调用该函数前必须调用过 [loadRules]**
+ */
+export declare function loadUpdateJson(url: string): Promise<UpdateJson | null>;
+/**
+ * 读取最后一次加载的版本文件
+ *
+ * + **调用该函数前必须调用过 [loadRules]**
+ * + **调用该函数前必须调用过 [loadUpdateJson]**
+ */
+export declare function readUpdateJson(): UpdateJson | null;
+/**
+ * 构建新的 update json
+ *
+ * + **执行该函数前必须调用过 [loadRules]**
+ * + **调用该函数前必须调用过 [loadCacheJson]**
+ * + **执行该函数前必须调用过 [buildVersionJson]**
+ * + **执行该函数前必须调用过 [calcEjectValues]**
+ *
+ * @param root 网站根路径（包括网络协议）
+ * @param dif 网站文件变化
+ */
+export declare function buildNewInfo(root: string, dif: AnalyzerResult): UpdateJson;
+/**
+ * 获取 URL 的缩写形式
+ *
+ * + **执行该函数前必须调用过 [loadRules]**
+ * + **调用该函数前必须调用过 [loadCacheJson]**
+ * + **执行该函数前必须调用过 [buildVersionJson]**
+ * + **执行该函数前必须调用过 [calcEjectValues]**
+ */
+export declare function getShorthand(url: string, offset?: number): string;
+export interface UpdateJson {
+    global: number;
+    info: UpdateVersionInfo[];
+}
+export interface UpdateVersionInfo {
+    version: number;
+    change?: ChangeExpression[];
+}
+export interface ChangeExpression {
+    flag: FlagStr;
+    value?: string | string[];
+}
+export type FlagStr = 'html' | 'end' | 'begin' | 'str' | 'reg';

package/types/VersionAnalyzer.d.ts

@@ -0,0 +1,29 @@
+import { VersionJson } from './FileAnalyzer';
+/**
+ * 分析两个版本信息的不同
+ *
+ * + **执行该函数前必须调用过 [loadRules]**
+ * + **调用该函数前必须调用过 [loadCacheJson]**
+ *
+ * @param version 新的版本信息
+ */
+export declare function analyzer(version: VersionJson): AnalyzerResult;
+/** 手动添加一个要刷新的 URL */
+export declare function refreshUrl(url: string): void;
+export interface AnalyzerResult {
+    /** 是否强制刷新所有缓存 */
+    force: boolean;
+    /** 被删除的 URL */
+    deleted: string[];
+    /** 内容变化的 URL */
+    variational: string[];
+    /** 手动刷新的 URL */
+    refresh: string[];
+    /** 因 stable 规则变化导致数据变动的 URL */
+    rules: {
+        /** 新规则将其识别为 stable */
+        add: string[];
+        /** 新规则将其识别为非 stable */
+        remove: string[];
+    };
+}