swpp-backends 0.0.1-alpha

package/types/swppRules.d.ts

@@ -0,0 +1,101 @@
+import { Request, Response } from 'node-fetch';
+import { SwppConfig } from './SwppConfig';
+/**
+ * 读取最后一次构建的 rules
+ *
+ * **执行该函数前必须调用过 [loadRules]**
+ */
+export declare function readRules(): SwppRules;
+/**
+ * 添加一个 rules 映射事件，这个事件允许用户修改 rules 的内容
+ *
+ * 执行时按照注册的顺序执行
+ */
+export declare function addRulesMapEvent(mapper: (rules: any) => void): void;
+/**
+ * 加载 rules 文件
+ * @param root 项目根目录
+ * @param fileName rules 文件名称
+ * @param selects 附加的可选目录，优先级低于 [root]
+ */
+export declare function loadRules(root: string, fileName: string, selects: string[]): SwppRules;
+export interface SwppRules {
+    /** 配置项 */
+    config: SwppConfig;
+    /** 缓存规则 */
+    cacheRules?: {
+        [propName: string]: CacheRules;
+    };
+    /**
+     * 修改 Request
+     * @param request 原始 request
+     * @param $eject 用于访问通过 [ejectValues] 函数插入的变量，变量名必须为 `$eject`
+     * @return 修改后的 Request，不修改的话返回 null 或不返回数据
+     */
+    modifyRequest?: (request: Request, $eject: any) => Request | undefined;
+    /**
+     * 获取一个 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 spare 备用 URL
+     */
+    fetchFile?: (request: Request, banCache: boolean, spare?: SpareURLs) => Promise<Response>;
+}
+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/utils.d.ts

@@ -0,0 +1,41 @@
+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;
+/**
+ * 获取指定值的 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<import("node-fetch").Response>;
+/**
+ * 替换编译期的 URL（CDN 竞速）
+ *
+ * **调用该函数前必须调用过 [loadRules]**
+ */
+export declare function replaceDevRequest(link: string): string[] | string;