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

package/src/VersionAnalyzer.ts

@@ -1,77 +0,0 @@
-import {readOldVersionJson, VersionJson} from './FileAnalyzer'
-
-const extraUrl = new Set<string>()
-
-/**
- * 分析两个版本信息的不同
- *
- * + **执行该函数前必须调用过 [loadRules]**
- * + **调用该函数前必须调用过 [loadCacheJson]**
- *
- * @param version 新的版本信息
- */
-export function analyzer(version: VersionJson): AnalyzerResult {
-    const oldVersion = readOldVersionJson()
-    const result: AnalyzerResult = {
-        force: false,
-        deleted: [],
-        variational: [],
-        refresh: [],
-        rules: {
-            add: [] as string[],
-            remove: [] as string[]
-        }
-    }
-    if (version.version !== oldVersion.version) {
-        result.force = true
-        return result
-    }
-    for (let url in oldVersion.list) {
-        if (extraUrl.has(url)) {
-            result.refresh.push(url)
-            extraUrl.delete(url)
-            continue
-        }
-        const oldValue = oldVersion.list[url]
-        const newValue = version.list[url]
-        if (!newValue) {
-            result.deleted.push(url)
-            continue
-        }
-        const oldType = typeof oldValue
-        const newType = typeof newValue
-        if (oldType !== newType) {
-            if (newType === 'string')
-                result.rules.remove.push(url)
-            else
-                result.rules.add.push(url)
-        } else if (oldType === 'string' && newValue !== oldValue) {
-            result.variational.push(url)
-        }
-    }
-    extraUrl.forEach(url => result.refresh.push(url))
-    return result
-}
-
-/** 手动添加一个要刷新的 URL */
-export function refreshUrl(url: string) {
-    extraUrl.add(url)
-}
-
-export interface AnalyzerResult {
-    /** 是否强制刷新所有缓存 */
-    force: boolean,
-    /** 被删除的 URL */
-    deleted: string[],
-    /** 内容变化的 URL */
-    variational: string[],
-    /** 手动刷新的 URL */
-    refresh: string[],
-    /** 因 stable 规则变化导致数据变动的 URL */
-    rules: {
-        /** 新规则将其识别为 stable */
-        add: string[],
-        /** 新规则将其识别为非 stable */
-        remove: string[]
-    }
-}

package/src/index.ts

@@ -1,64 +0,0 @@
-import {readEjectData, getSource, fetchFile, replaceDevRequest, calcEjectValues} from './Utils'
-import {
-    isExclude,
-    isStable,
-    loadVersionJson,
-    readOldVersionJson,
-    readNewVersionJson,
-    readMergeVersionMap,
-    buildVersionJson,
-    eachAllLinkInUrl,
-    eachAllLinkInHtml,
-    eachAllLinkInCss,
-    eachAllLinkInJavaScript,
-    findCache,
-    replaceRequest
-} from './FileAnalyzer'
-import {buildServiceWorker} from './ServiceWorkerBuilder'
-import {readRules, loadRules, addRulesMapEvent} from './SwppRules'
-import {readUpdateJson, loadUpdateJson, submitChange, getShorthand, buildNewInfo} from './UpdateJsonBuilder'
-import {refreshUrl, analyzer} from './VersionAnalyzer'
-
-// noinspection JSUnusedGlobalSymbols
-export default {
-    cache: {
-        readEjectData, readUpdateJson,
-        readRules, readMergeVersionMap,
-        readOldVersionJson, readNewVersionJson
-    },
-    builder: {
-        buildServiceWorker,
-        buildVersionJson,
-        buildNewInfo,
-        calcEjectValues,
-        analyzer
-    },
-    loader: {
-        loadRules, loadUpdateJson, loadVersionJson
-    },
-    event: {
-        addRulesMapEvent, refreshUrl, submitChange
-    },
-    utils: {
-        getSource, getShorthand, findCache,
-        fetchFile, replaceDevRequest, replaceRequest,
-        isStable, isExclude,
-        eachAllLinkInUrl, eachAllLinkInHtml, eachAllLinkInCss, eachAllLinkInJavaScript
-    }
-}
-
-// types
-export {EjectCache} from './Utils'
-export {VersionJson, VersionMap} from './FileAnalyzer'
-export {
-    ServiceWorkerConfig,
-    SwppConfig,
-    SwppConfigTemplate,
-    DomConfig,
-    VersionJsonConfig,
-    RegisterConfig,
-    ExternalMonitorConfig
-} from './SwppConfig'
-export {SwppRules, CacheRules, SpareURLs, EjectValue} from './SwppRules'
-export {UpdateJson, UpdateVersionInfo, FlagStr, ChangeExpression} from './UpdateJsonBuilder'
-export {AnalyzerResult} from './VersionAnalyzer'

package/src/resources/sw-dom.js

@@ -1,51 +0,0 @@
-document.addEventListener('DOMContentLoaded', () => {
-    /** 检查 SW 是否可用 */
-    const checkServiceWorker = () => 'serviceWorker' in navigator && navigator.serviceWorker.controller
-    /** 发送信息到 sw */
-    const postMessage2SW = type => navigator.serviceWorker.controller.postMessage(type)
-    const pjaxUpdate = url => new Promise(resolve => {
-        const type = url.endsWith('js') ? 'script' : 'link'
-        const name = type.length === 4 ? 'href' : 'src'
-        for (let item of document.querySelectorAll(type)) {
-            const itUrl = item[name]
-            if (url.length > itUrl ? url.endsWith(itUrl) : itUrl.endsWith(url)) {
-                const newEle = document.createElement(type)
-                const content = item.text || item.textContent || item.innerHTML || ''
-                Array.from(item.attributes).forEach(attr => newEle.setAttribute(attr.name, attr.value))
-                newEle.appendChild(document.createTextNode(content))
-                item.parentNode.replaceChildren(newEle, item)
-                return resolve(true)
-            }
-        }
-        resolve(false)
-    })
-    if (!checkServiceWorker()) return
-    if (sessionStorage.getItem('updated')) {
-        sessionStorage.removeItem('updated')
-        // ${onSuccess}
-    } else postMessage2SW('update')
-    navigator.serviceWorker.addEventListener('message', event => {
-        const data = event.data
-        switch (data.type) {
-            case 'update':
-                const list = data.update
-                if (!list) break
-                sessionStorage.setItem('updated', '1')
-                // noinspection JSUnresolvedVariable,JSUnresolvedFunction
-                if (window.Pjax?.isSupported()) {
-                    Promise.all(list.map(url => {
-                        if (url.endsWith('.js'))
-                            return pjaxUpdate(url)
-                        if (url.endsWith('.css'))
-                            return pjaxUpdate(url)
-                        return Promise.resolve()
-                    })).then(() => location.reload())
-                } else location.reload()
-                break
-            case 'escape':
-                sessionStorage.setItem('updated', '1')
-                location.reload()
-                break
-        }
-    })
-})

package/src/resources/sw-template.js

@@ -1,257 +0,0 @@
-// noinspection JSIgnoredPromiseFromCall
-
-(() => {
-    /** 缓存库名称 */
-    const CACHE_NAME = '@$$[cacheName]'
-    /** 控制信息存储地址（必须以`/`结尾） */
-    const CTRL_PATH = 'https://id.v3/'
-
-// [insertion site] values
-
-    /** 控制信息读写操作 */
-    const dbVersion = {
-        write: (id) => caches.open(CACHE_NAME)
-            .then(cache => cache.put(CTRL_PATH, new Response(JSON.stringify(id)))),
-        read: () => caches.match(CTRL_PATH).then(response => response?.json())
-    }
-
-    self.addEventListener('install', () => {
-        self.skipWaiting()
-        const escape = '@$$[escape]'
-        dbVersion.read().then(oldVersion => {
-            if (oldVersion && oldVersion.escape !== escape) {
-                oldVersion.escape = escape
-                // noinspection JSUnresolvedVariable
-                caches.delete(CACHE_NAME)
-                    .then(() => clients.matchAll())
-                    .then(list => list.forEach(client => client.postMessage({type: 'escape'})))
-            }
-        })
-    })
-
-    // sw 激活后立即对所有页面生效，而非等待刷新
-    // noinspection JSUnresolvedReference
-    self.addEventListener('activate', event => event.waitUntil(clients.claim()))
-
-    // noinspection JSFileReferences
-    const { cacheList, fetchFile, getSpareUrls } = require('../sw-rules')
-
-    // 检查请求是否成功
-    // noinspection JSUnusedLocalSymbols
-    const checkResponse = response => response.ok || [301, 302, 307, 308].includes(response.status)
-
-    /**
-     * 删除指定缓存
-     * @param list 要删除的缓存列表
-     * @return {Promise<string[]>} 删除的缓存的URL列表
-     */
-    const deleteCache = list => caches.open(CACHE_NAME).then(cache => cache.keys()
-        .then(keys => Promise.all(
-            keys.map(async it => {
-                const url = it.url
-                if (url !== CTRL_PATH && list.match(url)) {
-                    // [debug delete]
-                    // noinspection ES6MissingAwait,JSCheckFunctionSignatures
-                    cache.delete(it)
-                    return url
-                }
-                return null
-            })
-        )).then(list => list.filter(it => it))
-    )
-
-    self.addEventListener('fetch', event => {
-        let request = event.request
-        if (request.method !== 'GET' || !request.url.startsWith('http')) return
-        // [modifyRequest call]
-        const url = new URL(request.url)
-        // [blockRequest call]
-        const cacheRule = findCache(url)
-        if (cacheRule) {
-            let key = `https://${url.host}${url.pathname}`
-            if (key.endsWith('/index.html')) key = key.substring(0, key.length - 10)
-            if (cacheRule.search) key += url.search
-            event.respondWith(caches.match(key)
-                .then(cache => cache ?? fetchFile(request, true)
-                    .then(response => {
-                        if (checkResponse(response)) {
-                            const clone = response.clone()
-                            caches.open(CACHE_NAME).then(it => it.put(key, clone))
-                            // [debug put]
-                        }
-                        return response
-                    })
-                )
-            )
-        } else {
-            const spare = getSpareUrls(request.url)
-            if (spare) event.respondWith(fetchFile(request, false, spare))
-            // [modifyRequest else-if]
-        }
-    })
-
-    self.addEventListener('message', event => {
-        // [debug message]
-        if (event.data === 'update')
-            updateJson().then(info =>
-                // noinspection JSUnresolvedVariable
-                event.source.postMessage({
-                    type: 'update',
-                    update: info.list,
-                    version: info.version,
-                })
-            )
-    })
-
-    /** 判断指定url击中了哪一种缓存，都没有击中则返回null */
-    function findCache(url) {
-        if (url.hostname === 'localhost') return
-        for (let key in cacheList) {
-            const value = cacheList[key]
-            if (value.match(url)) return value
-        }
-    }
-
-    /**
-     * 根据JSON删除缓存
-     * @returns {Promise<{version, list}>}
-     */
-    const updateJson = () => {
-        /**
-         * 解析elements，并把结果输出到list中
-         * @return boolean 是否刷新全站缓存
-         */
-        const parseChange = (list, elements, ver) => {
-            for (let element of elements) {
-                const {version, change} = element
-                if (version === ver) return false
-                if (change) {
-                    for (let it of change)
-                        list.push(new CacheChangeExpression(it))
-                }
-            }
-            // 跨版本幅度过大，直接清理全站
-            return true
-        }
-        /** 解析字符串 */
-        const parseJson = json => dbVersion.read().then(oldVersion => {
-            const {info, global} = json
-            const newVersion = {global, local: info[0].version, escape: oldVersion?.escape}
-            //新用户不进行更新操作
-            if (!oldVersion) {
-                dbVersion.write(newVersion)
-                return newVersion
-            }
-            let list = new VersionList()
-            let refresh = parseChange(list, info, oldVersion.local)
-            dbVersion.write(newVersion)
-            // [debug escape]
-            //如果需要清理全站
-            if (refresh) {
-                if (global !== oldVersion.global) list.refresh = true
-                else list.clean(new CacheChangeExpression({'flag': 'all'}))
-            }
-            return {list, version: newVersion}
-        })
-        return fetchFile(new Request('/update.json'), false)
-            .then(response => {
-                if (checkResponse(response))
-                    return response.json().then(json =>
-                        parseJson(json).then(result => {
-                                return result.list ? deleteCache(result.list)
-                                    .then(list => list.length === 0 ? null : list)
-                                    .then(list => ({list, version: result.version}))
-                                    : {version: result}
-                            }
-                        )
-                    )
-                else throw `加载 update.json 时遇到异常，状态码：${response.status}`
-            })
-    }
-
-    /**
-     * 版本列表
-     * @constructor
-     */
-    function VersionList() {
-
-        const list = []
-
-        /**
-         * 推送一个表达式
-         * @param element {CacheChangeExpression} 要推送的表达式
-         */
-        this.push = element => {
-            list.push(element)
-        }
-
-        /**
-         * 清除列表，并将指定元素推入列表中
-         * @param element {CacheChangeExpression} 要推入的元素，留空表示不推入
-         */
-        this.clean = element => {
-            list.length = 0
-            if (!element) this.push(element)
-        }
-
-        /**
-         * 判断指定 URL 是否和某一条规则匹配
-         * @param url {string} URL
-         * @return {boolean}
-         */
-        this.match = url => {
-            if (this.refresh) return true
-            else {
-                for (let it of list) {
-                    if (it.match(url)) return true
-                }
-            }
-            return false
-        }
-
-    }
-
-    // noinspection SpellCheckingInspection
-    /**
-     * 缓存更新匹配规则表达式
-     * @param json 格式{"flag": ..., "value": ...}
-     * @see https://kmar.top/posts/bcfe8408/#23bb4130
-     * @constructor
-     */
-    function CacheChangeExpression(json) {
-        const checkCache = url => {
-            const cache = findCache(new URL(url))
-            return !cache || cache.clean
-        }
-        /**
-         * 遍历所有value
-         * @param action {function(string): boolean} 接受value并返回bool的函数
-         * @return {boolean} 如果value只有一个则返回`action(value)`，否则返回所有运算的或运算（带短路）
-         */
-        const forEachValues = action => {
-            const value = json.value
-            if (Array.isArray(value)) {
-                for (let it of value) {
-                    if (action(it)) return true
-                }
-                return false
-            } else return action(value)
-        }
-        const getMatch = () => {
-            switch (json['flag']) {
-                case 'html':
-                    return url => url.match(/(\/|\.html)$/)
-                case 'end':
-                    return url => forEachValues(value => url.endsWith(value))
-                case 'begin':
-                    return url => forEachValues(value => url.startsWith(value))
-                case 'str':
-                    return url => forEachValues(value => url.includes(value))
-                case 'reg':
-                    return url => forEachValues(value => url.match(new RegExp(value, 'i')))
-                default: throw `未知表达式：${JSON.stringify(json)}`
-            }
-        }
-        this.match = getMatch()
-    }
-})()

package/tsconfig.json

@@ -1,109 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig to read more about this file */
-
-    /* Projects */
-    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
-    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
-    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
-    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
-    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
-    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
-
-    /* Language and Environment */
-    "target": "ES2021",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
-    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
-    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
-    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
-    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
-
-    /* Modules */
-    "module": "commonjs",                                /* Specify what module code is generated. */
-    "rootDir": "./src/",                                  /* Specify the root folder within your source files. */
-    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
-    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
-    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
-    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
-    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
-    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
-    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
-    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
-    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
-    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
-    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
-    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
-    // "resolveJsonModule": true,                        /* Enable importing .json files. */
-    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
-    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
-
-    /* JavaScript Support */
-    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
-    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
-    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
-
-    /* Emit */
-    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
-    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
-    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
-    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
-    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
-    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    "outDir": "./dist/",                                   /* Specify an output folder for all emitted files. */
-    // "removeComments": true,                           /* Disable emitting comments. */
-    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
-    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
-    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
-    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
-    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
-    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
-    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
-    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
-    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
-    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
-    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
-    "declarationDir": "./types/",                           /* Specify the output directory for generated declaration files. */
-    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
-
-    /* Interop Constraints */
-    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
-    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
-    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
-    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
-    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
-
-    /* Type Checking */
-    "strict": true,                                      /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
-    "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
-    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
-    "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
-    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
-    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
-    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
-    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
-    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
-    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
-    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
-    "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
-    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
-    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
-    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
-    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
-    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
-
-    /* Completeness */
-    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
-    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
-  }
-}