@microbt/pwa 0.0.0-stage → 0.0.1

package/dist/esm/sw.js

@@ -0,0 +1,194 @@
+// src/sw.ts
+import { CacheableResponsePlugin } from "workbox-cacheable-response";
+import { clientsClaim, skipWaiting } from "workbox-core";
+import { ExpirationPlugin } from "workbox-expiration";
+import { registerRoute, setDefaultHandler } from "workbox-routing";
+import { CacheFirst, NetworkFirst, NetworkOnly, StaleWhileRevalidate } from "workbox-strategies";
+import "./sw-polyfills";
+import {
+  JS_CSS_CACHE_NAME_PREFIX,
+  purgeMismatchedCacheEntries,
+  STATIC_ASSETS_CACHE_NAME_PREFIX,
+  ValidateResponsePlugin
+} from "./sw-cache-validation";
+import { ChunkDiagnosticsPlugin } from "./sw-chunk-diagnostics";
+import { createSwRejectionPolicy, serializeSwRejection } from "./sw-error-filter";
+import { isHttpOrHttpsRequest } from "./sw-request-filter";
+function setupServiceWorker(options) {
+  clientsClaim();
+  skipWaiting();
+  setDefaultHandler(new NetworkOnly());
+  registerRoute(
+    ({ request }) => request.mode === "navigate" && isHttpOrHttpsRequest(request.url),
+    new NetworkFirst({
+      cacheName: `cache-pages-${self.location.origin}`,
+      networkTimeoutSeconds: 3,
+      plugins: [
+        new CacheableResponsePlugin({
+          statuses: [0, 200]
+        }),
+        new ExpirationPlugin({
+          maxEntries: 10,
+          maxAgeSeconds: 60 * 60 * 24 * 3,
+          // 3 天，须短于 chunk 的 7 天
+          purgeOnQuotaError: true
+        })
+      ]
+    })
+  );
+  class CORSPlugin {
+    async requestWillFetch({ request }) {
+      return new Request(request, {
+        mode: "cors",
+        credentials: "same-origin"
+      });
+    }
+  }
+  function shouldNotCacheImage(url) {
+    try {
+      const urlObj = new URL(url);
+      const authParams = [
+        "Signature",
+        "OSSAccessKeyId",
+        "Expires",
+        "token",
+        "auth",
+        "key",
+        "apikey",
+        "api_key",
+        "access_token",
+        "x-oss-signature"
+      ];
+      for (const param of authParams) {
+        if (urlObj.searchParams.has(param)) {
+          console.log(`图片URL包含授权参数 ${param}，不进行缓存: ${url}`);
+          return true;
+        }
+      }
+      if (urlObj.search && urlObj.search.length > 20) {
+        console.log(`图片URL包含较长查询参数，可能是授权URL，不进行缓存: ${url}`);
+        return true;
+      }
+      return false;
+    } catch (error) {
+      console.error(`URL解析错误，不进行缓存: ${url}`, error);
+      return true;
+    }
+  }
+  registerRoute(
+    ({ request }) => {
+      if (!isHttpOrHttpsRequest(request.url)) {
+        return false;
+      }
+      if (request.destination === "image") {
+        return !shouldNotCacheImage(request.url);
+      }
+      return request.destination === "font";
+    },
+    new CacheFirst({
+      cacheName: `${STATIC_ASSETS_CACHE_NAME_PREFIX}${self.location.origin}`,
+      plugins: [
+        // new CORSPlugin(),
+        new CacheableResponsePlugin({
+          statuses: [0, 200]
+        }),
+        new ValidateResponsePlugin(),
+        new ExpirationPlugin({
+          maxEntries: 50,
+          // 减少最大缓存条目数量
+          maxAgeSeconds: 60 * 60 * 24 * 7,
+          // 减少缓存时间为7天
+          purgeOnQuotaError: true
+        })
+      ]
+    })
+  );
+  registerRoute(
+    ({ request }) => {
+      if (!isHttpOrHttpsRequest(request.url)) {
+        return false;
+      }
+      return request.destination === "script" || request.destination === "style";
+    },
+    new StaleWhileRevalidate({
+      cacheName: `${JS_CSS_CACHE_NAME_PREFIX}${self.location.origin}`,
+      plugins: [
+        new CORSPlugin(),
+        new CacheableResponsePlugin({
+          statuses: [0, 200]
+        }),
+        new ValidateResponsePlugin(),
+        new ExpirationPlugin({
+          // 单版本构建实测 43 个 js/css 文件，30 上限必然误逐当前版本 chunk
+          // （LRU 逐出后弱网/旧版本清理场景直接白屏），须大于单版本全量
+          maxEntries: 60,
+          maxAgeSeconds: 60 * 60 * 24 * 7,
+          // 减少缓存时间为7天
+          purgeOnQuotaError: true
+        }),
+        // 放在 CORS 改写和缓存过滤之后，只观察最终请求/缓存结果。
+        new ChunkDiagnosticsPlugin({ release: options.release })
+      ]
+    })
+  );
+  self.addEventListener("error", (event) => {
+    var _a;
+    const errorInfo = {
+      type: "error",
+      message: event.message,
+      filename: event.filename,
+      line: event.lineno,
+      column: event.colno,
+      error: event.error,
+      stack: ((_a = event.error) == null ? void 0 : _a.stack) || new Error().stack
+    };
+    console.error("[ServiceWorker Error]", errorInfo);
+    self.clients.matchAll().then((clients) => {
+      clients.forEach((client) => {
+        client.postMessage({
+          type: "SW_ERROR",
+          payload: errorInfo
+        });
+      });
+    }).catch((err) => {
+      console.error("[ServiceWorker] Error posting error to clients:", err);
+    });
+  });
+  const classifyRejection = createSwRejectionPolicy();
+  self.addEventListener("unhandledrejection", (event) => {
+    const details = serializeSwRejection(event.reason);
+    const rejectionInfo = {
+      // 保持 reason 为可读文本，旧页面也能消费新 SW 消息。
+      reason: details.name ? `${details.name}: ${details.message}` : details.message,
+      stack: details.stack || new Error().stack,
+      ...classifyRejection(details)
+    };
+    if (rejectionInfo.reportError) {
+      console.error("[ServiceWorker Unhandled Rejection]", rejectionInfo);
+    }
+    self.clients.matchAll().then((clients) => {
+      clients.forEach((client) => {
+        client.postMessage({
+          type: "SW_UNHANDLED_REJECTION",
+          payload: rejectionInfo
+        });
+      });
+    }).catch((err) => {
+      console.error("[ServiceWorker] Error posting unhandled rejection to clients:", err);
+    });
+  });
+  self.addEventListener("activate", (event) => {
+    event.waitUntil(
+      Promise.all([
+        purgeMismatchedCacheEntries(),
+        // 清理 pageCache recipe 时代的遗留 HTML 缓存：无过期机制，且新 HTML
+        // 路由已改用带 ExpirationPlugin 的 cache-pages-（旧条目若无时间戳
+        // 会被 ExpirationPlugin 视为永不过期，不能改名复用）
+        caches.delete("pages")
+      ])
+    );
+  });
+}
+export {
+  setupServiceWorker
+};

package/package.json

@@ -1,6 +1,88 @@
 {
   "name": "@microbt/pwa",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "microbt service worker runtime and page-side registration for web apps",
+  "keywords": [
+    "microbt",
+    "pwa",
+    "service-worker",
+    "workbox"
+  ],
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js"
+    },
+    "./protocol": {
+      "types": "./dist/esm/protocol.d.ts",
+      "import": "./dist/esm/protocol.js"
+    },
+    "./sw": {
+      "types": "./dist/esm/sw.d.ts",
+      "import": "./dist/esm/sw.js"
+    }
+  },
+  "main": "dist/esm/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "father build",
+    "build:deps": "father prebundle",
+    "dev": "father dev",
+    "format": "prettier --cache --write .",
+    "lint": "eslint . --fix ",
+    "prepare": "husky install",
+    "prepublishOnly": "father doctor && npm run build",
+    "postpublish": "cnpm sync @microbt/pwa",
+    "test": "vitest run"
+  },
+  "lint-staged": {
+    "*.{md,json}": [
+      "prettier --cache --write"
+    ],
+    "*.{js,jsx}": [
+      "eslint --fix",
+      "prettier --cache --write"
+    ],
+    "*.ts?(x)": [
+      "eslint --fix",
+      "prettier --cache --parser=typescript --write"
+    ]
+  },
+  "dependencies": {
+    "workbox-cacheable-response": "^7.0.0",
+    "workbox-core": "^7.0.0",
+    "workbox-expiration": "^7.0.0",
+    "workbox-routing": "^7.0.0",
+    "workbox-strategies": "^7.0.0",
+    "workbox-window": "^7.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@microbt/environment": "^1.2.14",
+    "@types/node": "^22.13.4",
+    "@typescript-eslint/eslint-plugin": "^5.54.1",
+    "@typescript-eslint/parser": "^5.54.1",
+    "eslint": "^8.36.0",
+    "father": "^4.1.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.2.0",
+    "prettier": "^2.8.4",
+    "prettier-plugin-organize-imports": "^3.2.2",
+    "prettier-plugin-packagejson": "^2.4.3",
+    "typescript": "^5.4.2",
+    "vitest": "^1.6.1"
+  },
+  "peerDependencies": {
+    "@microbt/environment": "^1.2.12"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}