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

package/types/SwppConfig.d.ts

@@ -1,139 +0,0 @@
-/** 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[];
-    /** 生成版本信息时忽略的文件 */
-    exclude: {
-        localhost: RegExp[];
-        other: RegExp[];
-    };
-}
-/** 外部文件更新监听 */
-export interface ExternalMonitorConfig {
-    /** 拉取网络文件的超时时间 */
-    timeout: number;
-    /** 拉取文件时的并发限制 */
-    concurrencyLimit: 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[];
-        /** 生成版本信息时忽略的文件 */
-        exclude?: {
-            /** 当前网站的 URL */
-            localhost?: RegExp[];
-            /** 其它网站的 URL */
-            other?: RegExp[];
-        };
-    };
-    /** 外部文件更新监听 */
-    external?: boolean | {
-        /** 拉取网络文件的超时时间 */
-        timeout?: number;
-        /** 拉取文件时的并发限制 */
-        concurrencyLimit: number;
-        /** 匹配 JS 代码中的 URL */
-        js?: ({
-            head: string;
-            tail: string;
-        } | ((jsCode: string) => string[]))[];
-        /** 链接不变内容就不变的 URL */
-        stable?: RegExp[];
-        /** 构建过程中将原始 URL 映射为新的 URL */
-        replacer?: (srcUrl: string) => string[] | string;
-    };
-}
-/** 文件拉取模式等级 */
-export declare enum FileFetchModeLevel {
-    /** 严格，不允许 404 */
-    STRICT = 0,
-    /** 普通，允许 404，但仅允许服务器返回 404 状态码 */
-    NORMAL = 1,
-    /** 宽松，允许任何形式的 404，包括服务器返回 404、DNS 解析失败等 */
-    LOOSE = 2
-}
-export declare const defConfig: SwppConfig;

package/types/SwppRules.d.ts

@@ -1,117 +0,0 @@
-import { Request, Response } from 'node-fetch';
-import { SwppConfig } from './SwppConfig';
-/**
- * 加载 rules 文件
- * @param root 项目根目录
- * @param fileName rules 文件名称
- * @param selects 附加的可选目录，优先级低于 [root]
- */
-export declare function loadRules(root: string, fileName: string, selects: string[]): SwppRules;
-/**
- * 添加一个 rules 映射事件，这个事件允许用户修改 rules 的内容
- *
- * 执行时按照注册的顺序执行
- */
-export declare function addRulesMapEvent(mapper: (rules: any) => void): void;
-export interface SwppRules {
-    /** 配置项 */
-    config: SwppConfig;
-    /** 缓存规则 */
-    cacheRules?: {
-        [propName: string]: CacheRules;
-    };
-    /**
-     * 判断指定请求是否使用 CORS（必须启用 CORS 的请求将不通过该函数判断）
-     * @param request 当前请求的 request
-     */
-    isCors?: (request: Request) => boolean;
-    /**
-     * 判断指定请求的是否启用内存队列（即请求合并）
-     *
-     * 当返回 true 时，SW 会将该请求放置到队列中，如果队列中已有 URL 相同的请求，
-     * 则不会发起新的网络请求，而是等待上一个请求结束后直接使用上一个请求的结果。
-     *
-     * @param request 当前请求的 request
-     */
-    isMemoryQueue?: (request: Request) => boolean;
-    /**
-     * 修改 Request
-     * @param request 原始 request
-     * @param $eject 用于访问通过 [ejectValues] 函数插入的变量，变量名必须为 `$eject`
-     * @return 修改后的 Request，不修改的话返回 null 或不返回数据
-     */
-    modifyRequest?: (request: Request, $eject: any) => Request | undefined;
-    /**
-     * 判断是否跳过处理指定的请求，返回 true 后将完全不对该请求进行任何处理
-     *
-     * 该方法会在 modifyRequest 执行后触发
-     */
-    skipRequest?: (request: Request) => boolean;
-    /**
-     * 获取一个 URL 对应的多个 CDN 的 URL
-     *
-     * 竞速时除了 URL 外所有参数保持一致
-     *
-     * @param url 原始 URL
-     * @return {?string[]} 返回值不包含则表示去除对原始 URL 地访问。返回 undefined 表示该 URL 不启用竞速
-     */
-    getRaceUrls?: (url: string) => string[] | undefined;
-    /**
-     * 获取一个 URL 对应的 URL 列表
-     *
-     * 访问顺序按列表顺序，所有 URL 访问时参数一致
-     *
-     * @param url 原始 URL
-     * @return {?SpareURLs} 返回 null 或不反悔表示对该 URL 不启用备用 URL 功能
-     */
-    getSpareUrls?: (url: string) => SpareURLs | undefined;
-    /**
-     * 判断是否阻塞指定响应
-     * @return {boolean} 返回 true 表示阻塞，false 表示不阻塞
-     */
-    blockRequest?: (url: URL) => boolean;
-    /** 插入到 sw 但不在 node 中执行的代码 */
-    afterJoin?: VoidFunction;
-    /** 插入到 sw 但不在 node 中执行的代码，框架主题禁止覆盖该项 */
-    afterTheme?: VoidFunction;
-    /** 获取要插入到 sw 中的变量和常量 */
-    ejectValues?: (framework: any, rules: SwppRules) => {
-        [propName: string]: EjectValue;
-    };
-    /** 允许插入到 sw 的值 */
-    external?: string[];
-    /**
-     * 向指定的 request 发起网络请求（GET）
-     *
-     * **注意：声明该项后 swpp 内置的“CDN 竞速”“备用 URL”都将失效**
-     *
-     * @param request 请求信息
-     * @param banCache 是否禁用缓存
-     * @param urls 备用 URL 或 URL 竞速的 URL 列表，为空表示需要手动获取
-     */
-    fetchFile?: (request: Request, banCache: boolean, urls?: SpareURLs | string[]) => Promise<Response>;
-    /** 第三方添加的值 */
-    [propName: string]: any;
-}
-export interface CacheRules {
-    /** 符合该规则的缓存在进行全局清理时是否清除 */
-    clean: boolean;
-    /** 是否检查 URL 参数（问号及问号之后的内容） */
-    search?: boolean;
-    /**
-     * 规则匹配器
-     * @param url 链接的 URL 对象（对象包括 hash 和 search，但禁止使用 hash，search 为 false 或留空时禁止使用 search）
-     * @param $eject 用于访问通过 [ejectValues] 函数插入的变量，变量名必须为 `$eject`
-     */
-    match: (url: URL, $eject?: any) => boolean;
-}
-export interface SpareURLs {
-    /** 超时时间 */
-    timeout: number;
-    /** URL 列表 */
-    list: string[];
-}
-export interface EjectValue {
-    prefix: string;
-    value: string | number | boolean | bigint | object | string[] | number[] | boolean[] | bigint[] | object[];
-}

package/types/UpdateJsonBuilder.d.ts

@@ -1,44 +0,0 @@
-import { FileFetchModeLevel } from './SwppConfig';
-import { AnalyzeResult } from './VersionAnalyzer';
-/**
- * 构建新的 update json
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- * + **执行该函数前必须调用过 [buildVersionJson]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- *
- * @param root 网站根路径（包括网络协议）
- * @param dif 网站文件变化
- */
-export declare function buildUpdateJson(root: string, dif?: AnalyzeResult): UpdateJson;
-/** 提交修改 */
-export declare function submitChange(...change: ChangeExpression[]): void;
-/**
- * 加载版本文件
- *
- * + **调用该函数前必须调用过 [loadRules]**
- */
-export declare function loadUpdateJson(url: string, level?: FileFetchModeLevel): Promise<UpdateJson | null>;
-/**
- * 获取 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/Utils.d.ts

@@ -1,43 +0,0 @@
-export declare function error(type: string, message: string): void;
-export declare function warn(type: string, message: string): void;
-export interface EjectCache {
-    strValue: string;
-    nodeEject: any;
-}
-/**
- * 获取 eject values
- *
- * + **执行该函数前必须调用过 [loadRules]**
- *
- * @param framework 框架对象
- */
-export declare function calcEjectValues(framework: any): void;
-/**
- * 读取最近的已计算的 eject 数据
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- */
-export declare function readEjectData(): EjectCache | null;
-/**
- * 获取指定值的 js 源码表达形式
- * @param obj 要转换的对象
- * @param typeChecker 类型检查器，用于筛除不希望映射的类型
- * @param whiteList 白名单，当 obj 为 Object 时将只转换在白名单中的值（不会传递）
- * @param isTop 是否为顶层元素，为 true 且 obj 为 Object 时将去除最外层的大括号，改为 let（不会传递）
- */
-export declare function getSource(obj: any, typeChecker?: ((name: string) => boolean) | undefined, whiteList?: string[] | undefined, isTop?: boolean): string;
-/**
- * 拉取文件
- *
- * **调用该函数前必须调用过 [loadRules]**
- */
-export declare function fetchFile(link: string): Promise<Response>;
-/**
- * 替换编译期的 URL（CDN 竞速）
- *
- * **调用该函数前必须调用过 [loadRules]**
- */
-export declare function replaceDevRequest(link: string): string[] | string;
-/** 深度冻结一个对象，这将使得无法修改对象中的任何值，也无法添加新的值 */
-export declare function deepFreeze<T>(obj: T): T;

package/types/Variant.d.ts

@@ -1,58 +0,0 @@
-import { VersionJson, VersionMap } from './FileAnalyzer';
-import { SwppRules } from './SwppRules';
-import { UpdateJson } from './UpdateJsonBuilder';
-import { AnalyzeResult } from './VersionAnalyzer';
-/** 创建一个变量 */
-export declare function writeVariant<T>(key: string, value: T): T;
-/** 读取一个变量 */
-export declare function readVariant(key: string): any;
-/** 移除一个变量 */
-export declare function deleteVariant(key: string): void;
-/**
- * 读取最后一次构建的 rules
- *
- * **执行该函数前必须调用过 [loadRules]**
- */
-export declare function readRules(): SwppRules;
-/**
- * 读取最后一次加载的 version json
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- */
-export declare function readOldVersionJson(): VersionJson | null;
-/**
- * 读取最后一次构建的 VersionJson
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- * + **执行该函数前必须调用过 [buildVersionJson]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- */
-export declare function readNewVersionJson(): VersionJson;
-/**
- * 读取新旧版本文件合并后的版本地图
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- * + **执行该函数前必须调用过 [buildVersionJson]**
- * + **执行该函数前必须调用过 [calcEjectValues]**
- */
-export declare function readMergeVersionMap(): VersionMap;
-/**
- * 读取最后一次加载的版本文件
- *
- * + **调用该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadUpdateJson]**
- */
-export declare function readUpdateJson(): UpdateJson | null;
-/**
- * 读取分析结果
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- * + **调用该函数前必须调用过 [analyze]**
- */
-export declare function readAnalyzeResult(): AnalyzeResult;
-/** 读取一个事件 */
-export declare function readEvent<T>(key: string): T;

package/types/VersionAnalyzer.d.ts

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

package/types/browser/ServiceWorkerRuntimeTypes.d.ts

@@ -1,18 +0,0 @@
-interface BrowserVersion {
-    /** 逃生门版本号 */
-    escape: number;
-    /** 静态版本号 */
-    global: number;
-    /** 动态版本号 */
-    local: number;
-    /** 时间戳 */
-    tp?: number;
-}
-interface UpdateInfo {
-    /** 新的版本号 */
-    new: BrowserVersion;
-    /** 旧的版本号 */
-    old?: BrowserVersion;
-    /** 刷新的 URL 列表 */
-    list?: string[];
-}

package/types/swpp/RuntimeEnv.d.ts

@@ -1,39 +0,0 @@
-export declare const runtimeEnv: {
-    /**
-     * 读取环境变量的值
-     * @throws RuntimeEnvException
-     */
-    read(key: string): any;
-    /**
-     * 设置环境变量的值
-     * @throws RuntimeEnvException
-     */
-    update(key: string, valueGetter: () => any): void;
-    /**
-     * 追加环境变量
-     * @throws RuntimeEnvException
-     */
-    append<T>(key: string, env: RuntimeEnvValue<T>): void;
-    /** 获取所有键值对 */
-    entries(): {
-        [p: string]: any;
-    };
-};
-/** 运行时环境变量包含非法值时的警告 */
-export interface RuntimeEnvException<T> {
-    /** 环境变量名 */
-    key: string;
-    /** 用户填写的值 */
-    value: T;
-    /** 错误提示 */
-    message: string;
-}
-export type RuntimeEnvErrorTemplate<T> = Omit<RuntimeEnvException<T>, 'key'>;
-export interface RuntimeEnvValue<T> {
-    /** 缺省值 */
-    default: T;
-    /** 用户填入的值 */
-    getter?: () => T;
-    /** 检查器，返回 false 表示无错误 */
-    checker?: (value: T) => false | RuntimeEnvErrorTemplate<T>;
-}

package/types/swpp/SwCodeInject.d.ts

@@ -1,17 +0,0 @@
-export declare class SwCodeInject {
-    private list;
-    /** 在指定位置前插入代码 */
-    injectBefore(key: InjectKey, code: () => void): void;
-    /** 在指定位置之后插入代码 */
-    injectAfter(key: InjectKey, code: () => void): void;
-    /**
-     * 处理代码
-     * @throws RuntimeException 若存在非法的 inject key / {code: 'invalid_inject_key'}
-     * @throws RuntimeException 若存在重复的 inject key / {code: 'repeat_inject_key'}
-     */
-    handleCode(swCode: string): string;
-    /** 遍历所有元素 */
-    forEach(consumer: (key: InjectKey, pos: 'before' | 'after', code: string) => void): void;
-}
-export type InjectKey = 'var' | 'no_deps_fun';
-export declare function isInjectKey(value: string): value is InjectKey;

package/types/swpp/config/ConfigLoader.d.ts

@@ -1,53 +0,0 @@
-import { CompilationData, RuntimeData } from '../SwCompiler';
-import { IndivisibleConfig } from './ConfigCluster';
-export declare const IndivisibleName = "1indivisible__";
-export declare class ConfigLoader {
-    /** 支持的拓展名列表 */
-    private static readonly extensions;
-    private static jiti;
-    private config;
-    private modifierList;
-    private isBuilt;
-    /**
-     * 加载一个配置文件，越早加载的优先级越高
-     * @param file
-     */
-    load(file: string): Promise<void>;
-    /** 将配置项的内容写入到环境中 */
-    generate(): Readonly<{
-        runtime: RuntimeData;
-        compilation: CompilationData;
-    }>;
-    /** 将新配置合并到已有配置中 */
-    private mergeConfig;
-}
-/**
- * 配置编辑器
- */
-export interface SwppConfigModifier {
-    /**
-     * 自定义运行时和编译期的属性表
-     *
-     * 优先级越高越优先生效
-     */
-    build?: () => {
-        runtime: IndivisibleConfig<RuntimeData>;
-        compilation: IndivisibleConfig<CompilationData>;
-    };
-    /**
-     * 本函数用于向系统注册新的属性。
-     *
-     * 该函数内应当只调用 xxx.append 函数及其它工具函数，非必要不应当包含其它有副作用的操作。
-     *
-     * 优先级越低该函数越早执行。
-     */
-    registry?: (runtime: RuntimeData, compilation: CompilationData) => void;
-    /**
-     * 本函数用于动态修改属性的值。
-     *
-     * 该函数内应当只调用 xxx.update 函数及其它工具函数，非必要不应当包含其它有副作用的操作。
-     *
-     * 优先级越低该函数越早执行
-     */
-    dynamic?: (runtime: RuntimeData, compilation: CompilationData) => void;
-}

package/types/swpp/database/KeyValueDatabase.d.ts

@@ -1,53 +0,0 @@
-/** 键值对存储器 */
-export declare class KeyValueDatabase<T, C extends Record<string, DatabaseValue<T>>> {
-    private runtimeEnvMap;
-    constructor(map?: C);
-    /** 延迟初始化 */
-    protected lazyInit(map: C): void;
-    /**
-     * 读取指定键对应的值
-     * @throws RuntimeEnvException
-     */
-    read<K extends keyof C | string>(key: K): K extends keyof C ? C[K]['default'] : T;
-    /**
-     * 设置指定键对应的值
-     * @throws RuntimeEnvException
-     */
-    update<K extends keyof C | string>(key: K, valueGetter: () => T): void;
-    /**
-     * 追加键值对
-     * @throws RuntimeEnvException
-     */
-    append(key: string, env: DatabaseValue<T>): void;
-    /** 判断是否存在指定的环境变量 */
-    hasKey<K extends keyof C | string>(key: K): (K extends keyof C ? true : boolean);
-    /** 判断指定键对应的环境变量是否存在用户设置的值 */
-    hasValue<K extends keyof C | string>(key: K): boolean;
-    /** 获取所有键值对 */
-    entries(): {
-        [p: string]: T;
-    };
-}
-/**
- * 为优化 IDE 的类型推断提供的函数，直接返回传入的值
- * @param env
- */
-export declare function buildEnv<T>(env: DatabaseValue<T>): DatabaseValue<T>;
-export interface DatabaseValue<T> {
-    /** 缺省值 */
-    default: T;
-    /** 用户填入的值 */
-    getter?: () => T;
-    /** 检查器，返回 false 表示无错误 */
-    checker?: (value: T) => false | RuntimeEnvErrorTemplate<T>;
-}
-/** 运行时环境变量包含非法值时的警告 */
-export interface RuntimeEnvException<T> {
-    /** 环境变量名 */
-    key: string;
-    /** 用户填写的值 */
-    value: T;
-    /** 错误提示 */
-    message: string;
-}
-export type RuntimeEnvErrorTemplate<T> = Omit<RuntimeEnvException<T>, 'key'>;

package/types/swpp/database/RuntimeEnv.d.ts

@@ -1,5 +0,0 @@
-import { KeyValueDatabase } from './KeyValueDatabase';
-/** 环境变量存储器 */
-export declare class RuntimeEnv extends KeyValueDatabase<any> {
-    constructor();
-}