swpp-backends 3.0.0-alpha.3 → 3.0.0-alpha.310

package/dist/swpp/database/RuntimeDepCode.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RuntimeDepCode = void 0;
+const ConfigCluster_1 = require("../config/ConfigCluster");
 const untils_1 = require("../untils");
 const RuntimeKeyValueDatabase_1 = require("./RuntimeKeyValueDatabase");
 let CACHE_NAME;
@@ -19,31 +20,7 @@ let fetchFastest;
 /** 运行时依赖代码 */
 class RuntimeDepCode extends RuntimeKeyValueDatabase_1.RuntimeKeyValueDatabase {
     constructor() {
-        super(buildCommon());
-    }
-    /** 修正函数 */
-    fixDepFunction() {
-        const emptyLambda = () => null;
-        const hasFastestRequests = this.hasValue('getFastestRequests');
-        const hasStandbyRequests = this.hasValue('getStandbyRequests');
-        const hasFetchFile = this.hasValue('fetchFile');
-        if (!hasFastestRequests) {
-            this.update('fetchFastest', emptyLambda);
-        }
-        if (!hasStandbyRequests) {
-            this.update('fetchStandby', emptyLambda);
-        }
-        if (!hasFetchFile) {
-            if (hasFastestRequests && hasStandbyRequests) {
-                this.update('fetchFile', () => fetchFastestAndStandbyRequests);
-            }
-            else if (hasFastestRequests) {
-                this.update('fetchFile', () => fetchFastestRequests);
-            }
-            else if (hasStandbyRequests) {
-                this.update('fetchFile', () => fetchStandbyRequests);
-            }
-        }
+        super('RuntimeDepCode', buildCommon());
     }
     /** 构建 JS 源代码 */
     buildJsSource() {
@@ -117,8 +94,6 @@ function buildCommon() {
         /** 判断指定的缓存是否是有效缓存 */
         isValidCache: {
             default: (response, rule) => {
-                if (!rule)
-                    return false;
                 const headers = response.headers;
                 if (headers.has(INVALID_KEY))
                     return false;
@@ -183,7 +158,7 @@ function buildCommon() {
         },
         /** 是否启用 cors */
         isCors: {
-            default: (() => true)
+            default: (() => false)
         },
         /** 获取竞速列表 */
         getFastestRequests: {
@@ -213,7 +188,7 @@ function buildCommon() {
         fetchFastest: {
             default: async (list, optional) => {
                 const fallbackFetch = (request, controller) => {
-                    return fetchWrapper(request, true, isCors(request), {
+                    return fetchWrapper(request, true, true, {
                         ...optional,
                         signal: controller?.signal
                     });
@@ -238,7 +213,7 @@ function buildCommon() {
         fetchStandby: {
             default: async (request, standbyRequests, optional) => {
                 const fallbackFetch = (request, controller) => {
-                    return fetchWrapper(request, true, isCors(request), {
+                    return fetchWrapper(request, true, true, {
                         ...optional,
                         signal: controller?.signal
                     });
@@ -247,10 +222,10 @@ function buildCommon() {
                 let id, standbyResolve, standbyReject;
                 // 尝试封装 response
                 const resolveResponse = (index, response) => isFetchSuccessful(response) ? { i: index, r: response } : Promise.reject(response);
-                const { t: time, l: list } = standbyRequests;
-                const controllers = new Array(list.length + 1);
+                const { t: time, l: listGetter } = standbyRequests;
+                const controllers = new Array(listGetter.length + 1);
                 // 尝试同时拉取 standbyRequests 中的所有 Request
-                const task = () => Promise.any(list.map((it, index) => fallbackFetch(it, controllers[index + 1] = new AbortController())
+                const task = () => Promise.any(listGetter().map((it, index) => fallbackFetch(it, controllers[index + 1] = new AbortController())
                     .then(response => resolveResponse(index + 1, response)))).then(obj => standbyResolve(obj))
                     .catch(() => standbyReject());
                 // 尝试拉取初始 request
@@ -286,23 +261,28 @@ function buildCommon() {
         },
         /** 拉取文件 */
         fetchFile: {
-            default: (request, optional) => {
-                // @ts-ignore
-                if (!request.url)
-                    request = new Request(request);
-                return fetchWrapper(request, true, isCors(request), optional);
-            }
-        },
-        /** 归一化 URL */
-        normalizeUrl: {
-            default: (url) => {
-                if (url.endsWith('/index.html'))
-                    return url.substring(0, url.length - 10);
-                if (url.endsWith('.html'))
-                    return url.substring(0, url.length - 5);
-                else
-                    return url;
-            }
+            default: (0, ConfigCluster_1.defineLazyInitConfig)((runtime) => {
+                const runtimeDep = runtime.runtimeDep;
+                const hasFastestRequests = runtimeDep.hasValue('getFastestRequests');
+                const hasStandbyRequests = runtimeDep.hasValue('getStandbyRequests');
+                if (hasFastestRequests && hasStandbyRequests) {
+                    return fetchFastestAndStandbyRequests;
+                }
+                else if (hasFastestRequests) {
+                    return fetchFastestRequests;
+                }
+                else if (hasStandbyRequests) {
+                    return fetchStandbyRequests;
+                }
+                else {
+                    return (request, optional) => {
+                        // @ts-ignore
+                        if (!request.url)
+                            request = new Request(request);
+                        return fetchWrapper(request, true, true, optional);
+                    };
+                }
+            })
         },
         /** 是否阻断请求 */
         isBlockRequest: {

package/{types → dist}/swpp/database/RuntimeEventCode.d.ts

@@ -7,6 +7,10 @@ export declare class RuntimeEventCode extends RuntimeKeyValueDatabase<FunctionIn
     buildJsSource(): string;
 }
 declare function buildCommon(): {
+    /** SW 注册后立即激活 */
+    readonly install: {
+        readonly default: (_event: Event) => void;
+    };
     /** sw 激活后立即对所有页面生效，而非等待刷新 */
     readonly activate: {
         readonly default: (event: Event) => any;

package/dist/swpp/database/RuntimeEventCode.js

@@ -8,7 +8,7 @@ let postMessage;
 let readVersion;
 class RuntimeEventCode extends RuntimeKeyValueDatabase_1.RuntimeKeyValueDatabase {
     constructor() {
-        super(buildCommon());
+        super('RuntimeEventCode', buildCommon());
     }
     /** 构建 JS 源代码 */
     buildJsSource() {
@@ -23,6 +23,13 @@ class RuntimeEventCode extends RuntimeKeyValueDatabase_1.RuntimeKeyValueDatabase
 exports.RuntimeEventCode = RuntimeEventCode;
 function buildCommon() {
     return {
+        /** SW 注册后立即激活 */
+        install: {
+            default: (_event) => {
+                // @ts-ignore
+                skipWaiting();
+            }
+        },
         /** sw 激活后立即对所有页面生效，而非等待刷新 */
         activate: {
             // @ts-ignore

package/{types → dist}/swpp/database/RuntimeKeyValueDatabase.d.ts

@@ -1,7 +1,7 @@
 import { DatabaseValue, KeyValueDatabase } from './KeyValueDatabase';
 /** 运行时键值对存储器 */
 export declare abstract class RuntimeKeyValueDatabase<T, C extends Record<string, DatabaseValue<T>>> extends KeyValueDatabase<T, C> {
-    protected constructor(map?: C);
+    protected constructor(namespace: string, map?: C, globalChecker?: (key: string, value: T) => void);
     /** 构建运行时的 js 代码 */
     abstract buildJsSource(): string;
 }

package/dist/swpp/database/RuntimeKeyValueDatabase.js

@@ -4,8 +4,8 @@ exports.RuntimeKeyValueDatabase = void 0;
 const KeyValueDatabase_1 = require("./KeyValueDatabase");
 /** 运行时键值对存储器 */
 class RuntimeKeyValueDatabase extends KeyValueDatabase_1.KeyValueDatabase {
-    constructor(map) {
-        super(map);
+    constructor(namespace, map, globalChecker) {
+        super(namespace, map, globalChecker);
     }
 }
 exports.RuntimeKeyValueDatabase = RuntimeKeyValueDatabase;

package/dist/swpp/debug/CallChainRecorder.d.ts

@@ -0,0 +1,5 @@
+export declare class CallChainRecorder {
+    private readonly chain;
+    push(namespace: string, key: string): void;
+    pop(namespace: string, key: string): void;
+}

package/dist/swpp/debug/CallChainRecorder.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CallChainRecorder = void 0;
+const untils_1 = require("../untils");
+class CallChainRecorder {
+    constructor() {
+        this.chain = [];
+    }
+    push(namespace, key) {
+        const size = this.chain.push({ namespace, key });
+        const index1 = this.chain.findIndex(it => it.namespace === namespace && it.key === key);
+        if (index1 + 1 !== size) {
+            throw new untils_1.RuntimeException(untils_1.exceptionNames.circularDependencies, '环境变量产生了循环依赖', {
+                chain: this.chain.map((it, index) => {
+                    return `${it.namespace}::${it.key}${index % 5 == 4 ? '\n' : ''}`;
+                }).join(' -> ')
+            });
+        }
+    }
+    pop(namespace, key) {
+        const popValue = this.chain.pop();
+        if (!popValue || popValue.namespace !== namespace || popValue.key !== key) {
+            throw new untils_1.RuntimeException(untils_1.exceptionNames.error, '调用链追踪错误', {
+                chain: this.chain, popValue, expected: { namespace, key }
+            });
+        }
+    }
+}
+exports.CallChainRecorder = CallChainRecorder;

package/{types → dist}/swpp/untils.d.ts

@@ -1,10 +1,12 @@
 import * as crypto from 'node:crypto';
 export type ValuesOf<T> = T[keyof T];
-export declare const utils: Readonly<{
-    /** 将一个值封装为 lambda */
-    package<T>(value: T): () => T;
+export declare const utils: {
     /** 检查指定 URL 是否是合法的 URL */
     checkUrl(url: string): boolean;
+    /**
+     * 拼接链接
+     */
+    splicingUrl(base: URL, ...values: string[]): URL;
     /**
      * 将任意的对象转化为 JS 源码
      *
@@ -36,27 +38,20 @@ export declare const utils: Readonly<{
         [p: string]: any;
     }, includeEmptyValue?: boolean, writeAsVar?: "let" | "const"): string;
     /** 判断指定链接的 host 是否为指定的 host */
-    isSameHost(path: string, host: string): boolean;
+    isSameHost(path: string, baseUrl: URL): boolean;
     /** 计算字符串的哈希值 */
     calcHash(content: crypto.BinaryLike): string;
     time(): string;
     printError(title: string, err: any): void;
-    printInfo(title: string, info: any): void;
     printWarning(title: string, warning: any): void;
     /**
      * 将一个对象中的值都映射为另一个类型的值
      * @param obj
      * @param transfer
      */
-    objMap<T, R>(obj: {
-        [key: string]: T;
-    }, transfer: (item: T) => R): {
+    objMap<T, R>(obj: Readonly<Record<string, T>>, transfer: (item: T) => R): {
         [key: string]: R;
     };
-    /** 深度冻结一个对象 */
-    deepFreeze<T>(obj: T): Readonly<T>;
-    /** 二分查找 */
-    binarySearch<T>(array: T[], value: T, startInclude?: number, endExclude?: number, comparator?: (a: T, b: T) => number): number;
     /**
      * 在可迭代容器中查找满足指定条件的元素的下标
      */
@@ -64,18 +59,30 @@ export declare const utils: Readonly<{
         index: number;
         value: T;
     }[];
-}>;
+    /**
+     * 查找一个字符串中倒数第二次出现的子串的下标
+     */
+    findSecondLastIndex(str: string, searchString: string, position?: number): number;
+};
 export declare const exceptionNames: {
+    /** 循环依赖 */
+    readonly circularDependencies: "circular_dependencies";
     /** 无效的变量名 */
     readonly invalidVarName: "invalid_var_name";
     /** 无效的变量类型 */
     readonly invalidVarType: "invalid_var_type";
     /** 无效的插入键 */
     readonly invalidKey: "invalid_key";
+    /** 无效的插入值 */
+    readonly invalidValue: "invalid_value";
+    /** KV 库已经被冻结无法修改 */
+    readonly isFrozen: "is_frozen";
     /** 不支持的版本号 */
     readonly unsupportedVersion: "unsupported_version";
     /** 不支持的文件类型 */
     readonly unsupportedFileType: "unsupported_file_type";
+    /** 不支持的操作 */
+    readonly unsupportedOperate: "unsupported_operate";
     /** 空指针 */
     readonly nullPoint: "null_point";
     /** 配置文件已经完成构建 */
@@ -85,9 +92,9 @@ export declare const exceptionNames: {
     /** 未知分类错误 */
     readonly error: "error";
 };
-export interface RuntimeException {
-    /** 报错类型代码 */
-    code: ValuesOf<typeof exceptionNames>;
-    /** 错误提示 */
-    message: string;
+export declare class RuntimeException extends Error {
+    readonly code: ValuesOf<typeof exceptionNames>;
+    readonly message: string;
+    readonly addOn?: any;
+    constructor(code: ValuesOf<typeof exceptionNames>, message: string, addOn?: any);
 }

package/dist/swpp/untils.js

@@ -23,13 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exceptionNames = exports.utils = void 0;
+exports.RuntimeException = exports.exceptionNames = exports.utils = void 0;
 const crypto = __importStar(require("node:crypto"));
-exports.utils = Object.freeze({
-    /** 将一个值封装为 lambda */
-    package(value) {
-        return () => value;
-    },
+exports.utils = {
     /** 检查指定 URL 是否是合法的 URL */
     checkUrl(url) {
         try {
@@ -40,6 +36,12 @@ exports.utils = Object.freeze({
             return false;
         }
     },
+    /**
+     * 拼接链接
+     */
+    splicingUrl(base, ...values) {
+        return new URL(values.join('/').replaceAll(/(\/+)|\\/g, '/'), base);
+    },
     /**
      * 将任意的对象转化为 JS 源码
      *
@@ -73,11 +75,9 @@ exports.utils = Object.freeze({
         const resultList = [];
         const pushToResult = (key, value) => {
             if (writeAsVar) {
-                if (!/^[a-zA-Z_$][0-9a-zA-Z_$]*$/.test(key))
-                    throw {
-                        code: exports.exceptionNames.invalidVarName,
-                        message: '非法的变量名：' + key
-                    };
+                if (!/^[a-zA-Z_$][0-9a-zA-Z_$]*$/.test(key)) {
+                    throw new RuntimeException(exports.exceptionNames.invalidVarName, '非法的变量名：' + key);
+                }
                 resultList.push(`${writeAsVar} ${key} = ${value}`);
             }
             else if (/^[a-zA-Z_$][0-9a-zA-Z_$]*$/.test(key)) {
@@ -142,25 +142,19 @@ exports.utils = Object.freeze({
                     break;
                 }
                 case "symbol":
-                    throw {
-                        code: exports.exceptionNames.invalidVarType,
-                        message: '非法的类型：symbol, key = ' + key
-                    };
+                    throw new RuntimeException(exports.exceptionNames.invalidVarType, '非法的类型：symbol, key = ' + key);
             }
         }
         return writeAsVar ? resultList.join(';\n') : '{\n' + resultList.join(',\n') + '\n};';
     },
     /** 判断指定链接的 host 是否为指定的 host */
-    isSameHost(path, host) {
+    isSameHost(path, baseUrl) {
         try {
-            const url = new URL(path, `https://${host}`);
-            return url.host === host;
+            const url = new URL(path, baseUrl);
+            return baseUrl.hostname === url.hostname && baseUrl.pathname.startsWith(url.pathname);
         }
-        catch (_) {
-            throw {
-                value: `path: ${path}; host: ${host}`,
-                message: '传入的 path 或 host 不合法'
-            };
+        catch (e) {
+            throw new RuntimeException(exports.exceptionNames.error, `传入的 path[${path}] 不合法`, { cause: e });
         }
     },
     /** 计算字符串的哈希值 */
@@ -179,9 +173,6 @@ exports.utils = Object.freeze({
     printError(title, err) {
         console.error(`[${this.time()}] [ERR] [SWPP] [${title}]: `, err);
     },
-    printInfo(title, info) {
-        console.info(`[${this.time()}] [INFO] [SWPP] [${title}]: ${JSON.stringify(info, null, 2)}`);
-    },
     printWarning(title, warning) {
         console.warn(`[${this.time()}] [WARN] [SWPP] [${title}]: ${JSON.stringify(warning, null, 2)}`);
     },
@@ -198,32 +189,6 @@ exports.utils = Object.freeze({
         }
         return result;
     },
-    /** 深度冻结一个对象 */
-    deepFreeze(obj) {
-        const result = Object.freeze(obj);
-        for (let key in result) {
-            this.deepFreeze(obj[key]);
-        }
-        return result;
-    },
-    /** 二分查找 */
-    binarySearch(array, value, startInclude = 0, endExclude = array.length, comparator = (a, b) => a < b ? -1 : (a == b ? 0 : 1)) {
-        let left = startInclude, right = endExclude - 1;
-        while (left <= right) {
-            const midIndex = (left + right) >>> 1;
-            const cmp = comparator(array[midIndex], value);
-            if (cmp < 0) {
-                left = midIndex + 1;
-            }
-            else if (cmp > 0) {
-                right = midIndex - 1;
-            }
-            else {
-                return midIndex;
-            }
-        }
-        return -left - 1;
-    },
     /**
      * 在可迭代容器中查找满足指定条件的元素的下标
      */
@@ -236,19 +201,36 @@ exports.utils = Object.freeze({
             ++index;
         }
         return result;
+    },
+    /**
+     * 查找一个字符串中倒数第二次出现的子串的下标
+     */
+    findSecondLastIndex(str, searchString, position = str.length) {
+        const lastIndex = str.lastIndexOf(searchString, position);
+        if (lastIndex < 0)
+            return lastIndex;
+        return str.lastIndexOf(searchString, lastIndex - 1);
     }
-});
+};
 exports.exceptionNames = {
+    /** 循环依赖 */
+    circularDependencies: 'circular_dependencies',
     /** 无效的变量名 */
     invalidVarName: 'invalid_var_name',
     /** 无效的变量类型 */
     invalidVarType: 'invalid_var_type',
     /** 无效的插入键 */
     invalidKey: 'invalid_key',
+    /** 无效的插入值 */
+    invalidValue: 'invalid_value',
+    /** KV 库已经被冻结无法修改 */
+    isFrozen: 'is_frozen',
     /** 不支持的版本号 */
     unsupportedVersion: 'unsupported_version',
     /** 不支持的文件类型 */
     unsupportedFileType: 'unsupported_file_type',
+    /** 不支持的操作 */
+    unsupportedOperate: 'unsupported_operate',
     /** 空指针 */
     nullPoint: 'null_point',
     /** 配置文件已经完成构建 */
@@ -258,3 +240,15 @@ exports.exceptionNames = {
     /** 未知分类错误 */
     error: 'error'
 };
+class RuntimeException extends Error {
+    constructor(code, message, addOn) {
+        super();
+        this.code = code;
+        this.message = message;
+        this.addOn = addOn;
+        this.name = 'top.kmar.swpp.RuntimeException';
+        this.message = '运行时发生异常 ' + JSON.stringify({ code, message, addOn }, null, 2);
+        Object.setPrototypeOf(this, RuntimeException.prototype);
+    }
+}
+exports.RuntimeException = RuntimeException;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "swpp-backends",
-  "version": "3.0.0-alpha.3",
+  "version": "3.0.0-alpha.310",
   "main": "dist/index.js",
-  "typings": "types/index.d.ts",
+  "typings": "dist/index.d.ts",
   "description": "Generate a powerful ServiceWorker for your website.",
   "author": "kmar",
   "license": "AGPL-3.0",

package/types/DomBuilder.d.ts

@@ -1,6 +0,0 @@
-/**
- * 构建 DOM 端的 JS 文件
- *
- * + **执行该函数前必须调用过 [loadRules]**
- */
-export declare function buildDomJs(): string;

package/types/FileAnalyzer.d.ts

@@ -1,96 +0,0 @@
-import { FileFetchModeLevel } from './SwppConfig';
-/**
- * 构建一个 version json
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- *
- * @param protocol 网站的网络协议
- * @param domain 网站域名（包括二级域名）
- * @param root 网页根目录（首页 index.html 所在目录）
- */
-export declare function buildVersionJson(protocol: ('https://' | 'http://'), domain: string, root: string): Promise<VersionJson>;
-/**
- * 版本信息（可以用 JSON 序列化）
- * @see VersionMap
- */
-export interface VersionJson {
-    version: number;
-    list: VersionMap;
-    external: {
-        [propName: string]: any;
-    };
-}
-/**
- * 版本列表
- *
- * + key 为文件的 URL
- * + getter {string} 为 URL 对应文件的 md5 值
- * + getter {string[]} 为 stable 文件其中包含的 URL
- */
-export interface VersionMap {
-    [propName: string]: any;
-}
-/**
- * 判断指定 URL 是否排除
- *
- * + **执行该函数前必须调用过 [loadRules]**
- *
- * @param domain 网站域名
- * @param url 要判断的 URL
- */
-export declare function isExclude(domain: string, url: string): boolean;
-/**
- * 判断指定 URL 是否是 stable 的
- *
- * + **执行该函数前必须调用过 [loadRules]**
- */
-export declare function isStable(url: string): boolean;
-/**
- * 从指定 URL 加载 version json
- *
- * + **执行该函数前必须调用过 [loadRules]**
- */
-export declare function loadVersionJson(url: string, level?: FileFetchModeLevel): Promise<VersionJson | null>;
-/** 提交要存储到 version json 的值 */
-export declare function submitCacheInfo(key: string, value: any): void;
-/** 添加一个要监听的 URL */
-export declare function submitExternalUrl(url: string): void;
-/** 注册一个文件处理器 */
-export declare function registryFileHandler(handler: FileHandler): void;
-/** 查询一个文件处理器 */
-export declare function findFileHandler(url: string): FileHandler | undefined;
-/**
- * 检索一个 URL 指向的文件中所有地外部链接
- *
- * 该函数会处理该 URL 指向的文件和文件中直接或间接包含的所有 URL
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- *
- * @param domain 网站域名
- * @param url 要检索的 URL
- * @param result 存放结果的对象
- * @param event 检索到一个 URL 时触发的事件
- */
-export declare function eachAllLinkInUrl(domain: string, url: string, result: VersionMap, event?: (url: string) => void): Promise<void>;
-/**
- * 查询指定 URL 对应的缓存规则
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- */
-export declare function findCache(url: URL | string): any | null;
-/**
- * 替换请求
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- */
-export declare function replaceRequest(url: string): string;
-export interface FileHandler {
-    match: (url: string) => boolean;
-    handle: (domain: string, url: string, content: string, result: VersionMap, event?: (url: string) => void) => Promise<any>;
-}

package/types/ServiceWorkerBuilder.d.ts

@@ -1,7 +0,0 @@
-/**
- * 构建 sw
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- */
-export declare function buildServiceWorker(): string;