swpp-backends 2.2.2 → 2.3.0-beta.1

package/dist/ServiceWorkerBuilder.js

@@ -26,7 +26,7 @@ function buildServiceWorker() {
     const templatePath = path_1.default.resolve('./', module.path, 'resources/sw-template.js');
     // 获取拓展文件
     let cache = (0, Utils_1.getSource)(rules, undefined, [
-        'cacheRules', 'modifyRequest', 'getRaceUrls', 'getSpareUrls', 'blockRequest', 'fetchFile', 'skipRequest',
+        'cacheRules', 'modifyRequest', 'getRaceUrls', 'getSpareUrls', 'blockRequest', 'fetchFile', 'skipRequest', 'isCors', 'isMemoryQueue',
         ...('external' in rules && Array.isArray(rules.external) ? rules.external : [])
     ], true) + '\n';
     if (!fetchFile) {
@@ -44,7 +44,7 @@ function buildServiceWorker() {
         cache += `(${(0, Utils_1.getSource)(rules['afterJoin'])})()\n`;
     if ('afterTheme' in rules)
         cache += `(${(0, Utils_1.getSource)(rules['afterTheme'])})()\n`;
-    const keyword = "const { cacheRules, fetchFile, getSpareUrls } = require('../sw-rules')";
+    const keyword = "const { cacheRules, fetchFile, getSpareUrls, isCors, isMemoryQueue } = require('../sw-rules')";
     // noinspection JSUnresolvedVariable
     let content = fs_1.default.readFileSync(templatePath, 'utf8')
         .replaceAll("// [insertion site] values", eject?.strValue ?? '')

package/dist/SwppConfig.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileFetchModeLevel = void 0;
+exports.defConfig = exports.FileFetchModeLevel = void 0;
 /** 文件拉取模式等级 */
 var FileFetchModeLevel;
 (function (FileFetchModeLevel) {
@@ -11,3 +11,44 @@ var FileFetchModeLevel;
     /** 宽松，允许任何形式的 404，包括服务器返回 404、DNS 解析失败等 */
     FileFetchModeLevel[FileFetchModeLevel["LOOSE"] = 2] = "LOOSE";
 })(FileFetchModeLevel || (exports.FileFetchModeLevel = FileFetchModeLevel = {}));
+exports.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
+    }
+};

package/dist/SwppRules.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addRulesMapEvent = exports.loadRules = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const SwppConfig_1 = require("./SwppConfig");
 const Utils_1 = require("./Utils");
 const Variant_1 = require("./Variant");
 /**
@@ -32,7 +33,7 @@ function loadRules(root, fileName, selects) {
     const selectRules = selectPath ? require(selectPath) : {};
     const config = rootRules.config ?? {};
     mergeConfig(config, selectRules.config ?? {});
-    mergeConfig(config, defConfig);
+    mergeConfig(config, SwppConfig_1.defConfig);
     for (let key in selectRules) {
         if (!(key in rootRules))
             rootRules[key] = selectRules[key];
@@ -41,6 +42,10 @@ function loadRules(root, fileName, selects) {
     for (let event of eventList) {
         event(rootRules);
     }
+    for (let key in defRules) {
+        if (!(key in rootRules))
+            rootRules[key] = defRules[key];
+    }
     return (0, Variant_1.writeVariant)('swppRules', (0, Utils_1.deepFreeze)(rootRules));
 }
 exports.loadRules = loadRules;
@@ -72,44 +77,9 @@ 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
-    }
+const defRules = {
+    config: {},
+    // @ts-ignore
+    isCors: request => !request.headers.get('Content-Type').startsWith('image/'),
+    isMemoryQueue: () => false
 };

package/dist/index.js

@@ -10,7 +10,7 @@ const VersionAnalyzer_1 = require("./VersionAnalyzer");
 const DomBuilder_1 = require("./DomBuilder");
 // noinspection JSUnusedGlobalSymbols
 exports.default = {
-    version: '2.2.2',
+    version: '2.3.0-beta.1',
     cache: {
         readEjectData: Utils_1.readEjectData, readUpdateJson: Variant_1.readUpdateJson,
         readRules: Variant_1.readRules, readMergeVersionMap: Variant_1.readMergeVersionMap,

package/dist/resources/sw-template.js

@@ -45,7 +45,7 @@
     self.addEventListener('activate', event => event.waitUntil(clients.claim()))
 
     // noinspection JSFileReferences
-    const { cacheRules, fetchFile, getSpareUrls } = require('../sw-rules')
+    const { cacheRules, fetchFile, getSpareUrls, isCors, isMemoryQueue } = require('../sw-rules')
 
     // 检查请求是否成功
     // noinspection JSUnusedLocalSymbols
@@ -73,7 +73,7 @@
 
     /**
      * 缓存列表
-     * @type {Map<string, {s, e}[]>}
+     * @type {Map<string, function(any)[]>}
      */
     const cacheMap = new Map()
 
@@ -85,30 +85,35 @@
         // [modifyRequest call]
         // [skipRequest call]
         let cacheKey = url.hostname + url.pathname + url.search
-        let cache = cacheMap.get(cacheKey)
-        if (cache) {
-            return event.respondWith(
-                new Promise((resolve, reject) => {
-                    cacheMap.get(cacheKey).push({s: resolve, e: reject})
-                })
-            )
+        let cache
+        if (isMemoryQueue(request)) {
+            cache = cacheMap.get(cacheKey)
+            if (cache) {
+                return event.respondWith(
+                    new Promise((resolve, reject) => {
+                        cacheMap.get(cacheKey).push(arg => arg.body ? resolve(arg) : reject(arg))
+                    })
+                )
+            }
+            cacheMap.set(cacheKey, cache = [])
         }
-        cacheMap.set(cacheKey, cache = [])
         /** 处理拉取 */
-        const handleFetch = promise => event.respondWith(
-            promise.then(response => {
-                for (let item of cache) {
-                    item.s(response.clone())
-                }
-            }).catch(err => {
-                for (let item of cache) {
-                    item.e(err)
-                }
-            }).then(() => {
-                cacheMap.delete(cacheKey)
-                return promise
-            })
-        )
+        const handleFetch = promise => {
+            event.respondWith(
+                cache ? promise.then(response => {
+                    for (let item of cache) {
+                        item(response.clone())
+                    }
+                }).catch(err => {
+                    for (let item of cache) {
+                        item(err)
+                    }
+                }).then(() => {
+                    cacheMap.delete(cacheKey)
+                    return promise
+                }) : promise
+            )
+        }
         const cacheRule = findCache(url)
         if (cacheRule) {
             let key = `https://${url.host}${url.pathname}`
@@ -139,10 +144,9 @@
         // [debug message]
         if (event.data === 'update')
             updateJson().then(info => {
-                    info.type = 'update'
-                    event.source.postMessage(info)
-                }
-            )
+                info.type = 'update'
+                event.source.postMessage(info)
+            })
     })
 
     /**
@@ -155,7 +159,7 @@
     const fetchWithCors = (request, banCache, optional) => {
         if (!optional) optional = {}
         optional.cache = banCache ? 'no-store' : 'default'
-        if (request.headers.get('Content-Type')?.startsWith('image/')) {
+        if (isCors(request)) {
             optional.mode = 'cors'
             optional.credentials = 'same-origin'
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swpp-backends",
-  "version": "2.2.2",
+  "version": "2.3.0-beta.1",
   "main": "dist/index.js",
   "typings": "types/index.d.ts",
   "description": "Generate a powerful ServiceWorker for your website.",

package/types/SwppConfig.d.ts

@@ -136,3 +136,4 @@ export declare enum FileFetchModeLevel {
     /** 宽松，允许任何形式的 404，包括服务器返回 404、DNS 解析失败等 */
     LOOSE = 2
 }
+export declare const defConfig: SwppConfig;

package/types/SwppRules.d.ts

@@ -20,6 +20,23 @@ export interface SwppRules {
     cacheRules?: {
         [propName: string]: CacheRules;
     };
+    /**
+     * 判断指定请求是否使用 CORS
+     *
+     * **注意：对于需要使用缓存、竞速等功能的 URL 必须使用 CORS，否则无法判断状态码从而使得功能失效或工作异常**
+     *
+     * @param request 当前请求的 request
+     */
+    isCors?: (request: Request) => boolean;
+    /**
+     * 判断指定请求的是否启用内存队列（即请求合并）
+     *
+     * 当返回 true 时，SW 会将该请求放置到队列中，如果队列中已有 URL 相同的请求，
+     * 则不会发起新的网络请求，而是等待上一个请求结束后直接使用上一个请求的结果。
+     *
+     * @param request 当前请求的 request
+     */
+    isMemoryQueue?: (request: Request) => boolean;
     /**
      * 修改 Request
      * @param request 原始 request