@tourmind-frontend/monitor-plugin-nuxt 1.0.1

package/dist/index.cjs

@@ -0,0 +1,128 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// extensions/plugin-nuxt/src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  default: () => MonitorModule
+});
+module.exports = __toCommonJS(src_exports);
+var import_node_path = require("path");
+var import_axios = __toESM(require("axios"));
+var import_form_data = __toESM(require("form-data"));
+var LOG_PREFIX = "[frontend-monitor]";
+var UploadSourceMapWebpackPlugin = class {
+  constructor(options) {
+    if (!(options == null ? void 0 : options.url)) throw new Error(`${LOG_PREFIX} "uploadUrl" is required`);
+    if (!options.project) throw new Error(`${LOG_PREFIX} "project" is required`);
+    if (!options.branch) throw new Error(`${LOG_PREFIX} "branch" is required`);
+    this.options = options;
+  }
+  // 兼容 webpack 4 / 5；类型留作 any 以避免把 webpack 拉入类型声明。
+  apply(compiler) {
+    const opts = this.options;
+    compiler.options.devtool = "hidden-source-map";
+    compiler.hooks.emit.tapPromise("MonitorUploadSourceMapPlugin", async (compilation) => {
+      const files = [];
+      const assets = compilation.assets || {};
+      for (const name of Object.keys(assets)) {
+        if (!name.endsWith(".map")) continue;
+        const asset = assets[name];
+        const raw = typeof (asset == null ? void 0 : asset.source) === "function" ? asset.source() : "";
+        const content = typeof raw === "string" ? raw : raw ? Buffer.from(raw).toString("utf-8") : "";
+        if (typeof compilation.deleteAsset === "function") compilation.deleteAsset(name);
+        else delete assets[name];
+        if (!content) continue;
+        const base = name.includes("/") ? name.split("/").pop() : name;
+        if (!base) continue;
+        files.push([base, content]);
+      }
+      if (files.length === 0) {
+        console.warn(`${LOG_PREFIX} no .map files found in the bundle, skipping upload`);
+        return;
+      }
+      const query = {
+        project: opts.project,
+        branch: opts.branch,
+        timestamp: String(Date.now())
+      };
+      if (opts.commit) query.commit = opts.commit;
+      const qs = new URLSearchParams(query).toString();
+      const fullUrl = `${opts.url}${opts.url.includes("?") ? "&" : "?"}${qs}`;
+      const form = new import_form_data.default();
+      for (const [filename, content] of files) {
+        form.append("file", Buffer.from(content, "utf-8"), { filename });
+      }
+      try {
+        await (0, import_axios.default)({
+          method: "POST",
+          url: fullUrl,
+          data: form,
+          headers: form.getHeaders(),
+          maxBodyLength: Infinity,
+          maxContentLength: Infinity
+        });
+        console.log(
+          `${LOG_PREFIX} uploaded ${files.length} sourcemap file(s) (branch=${opts.branch}, commit=${opts.commit || "-"})`
+        );
+      } catch (err) {
+        console.error(`${LOG_PREFIX} upload failed`, err instanceof Error ? err.message : err);
+      }
+    });
+  }
+};
+function MonitorModule(options) {
+  if (!(options == null ? void 0 : options.project)) throw new Error(`${LOG_PREFIX} "project" is required`);
+  if (!options.reportUrl) throw new Error(`${LOG_PREFIX} "reportUrl" is required`);
+  if (!options.uploadUrl) throw new Error(`${LOG_PREFIX} "uploadUrl" is required`);
+  if (!options.branch) throw new Error(`${LOG_PREFIX} "branch" is required`);
+  this.extendBuild((config, { isClient, isDev }) => {
+    var _a;
+    const enabled = (_a = options.uploadEnabled) != null ? _a : !isDev;
+    if (!enabled || !isClient) return;
+    config.plugins = config.plugins || [];
+    config.plugins.push(
+      new UploadSourceMapWebpackPlugin({
+        url: options.uploadUrl,
+        project: options.project,
+        branch: options.branch,
+        commit: options.commit
+      })
+    );
+  });
+  this.addPlugin({
+    src: (0, import_node_path.resolve)(__dirname, "../templates/plugin.client.js"),
+    fileName: "monitor-tracking.client.js",
+    mode: "client",
+    options: {
+      url: options.reportUrl,
+      project: options.project
+    }
+  });
+}

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+export interface MonitorModuleOptions {
+    /** 项目名，必须为 `owner/name` 格式以匹配服务端。 */
+    project: string;
+    /** 上报接口地址，例如 `https://monitor.example.com/api/report`。 */
+    reportUrl: string;
+    /** sourcemap 上传接口地址，例如 `https://monitor.example.com/api/upload`。 */
+    uploadUrl: string;
+    /** 分支名，由调用方自行解析（如 `git rev-parse --abbrev-ref HEAD`）。 */
+    branch: string;
+    /** Commit hash，由调用方自行解析（如 `git rev-parse HEAD`）。 */
+    commit?: string;
+    /** 强制启用 / 禁用 sourcemap 上传。默认仅在生产构建（`!isDev`）时为 `true`。 */
+    uploadEnabled?: boolean;
+}
+interface NuxtBuildContext {
+    isClient: boolean;
+    isServer: boolean;
+    isDev: boolean;
+}
+interface NuxtWebpackConfig {
+    plugins?: unknown[];
+    devtool?: string | false;
+}
+interface NuxtModuleThis {
+    options: unknown;
+    extendBuild(fn: (config: NuxtWebpackConfig, ctx: NuxtBuildContext) => void): void;
+    addPlugin(opts: {
+        src: string;
+        fileName: string;
+        mode?: "client" | "server" | "all";
+        ssr?: boolean;
+        options?: unknown;
+    }): void;
+}
+/**
+ * Nuxt 2 模块入口（兼容 `nuxt@>=2.4.0` + `nuxt-property-decorator@>=2.3.0`）。
+ *
+ * - 客户端生产构建时注入 webpack 插件，把 sourcemap 上传到 `uploadUrl`
+ * - 始终注入客户端运行时插件，监听 `window.error` / `unhandledrejection` /
+ *   `Vue.config.errorHandler`，把错误堆栈上报到 `reportUrl`
+ *
+ * 在 `nuxt.config.js` 中使用：
+ *
+ * ```js
+ * export default {
+ *   modules: [
+ *     ['@tourmind-frontend/monitor-plugin-nuxt', {
+ *       project: 'your-org/your-repo',
+ *       reportUrl: 'https://monitor.example.com/api/report',
+ *       uploadUrl: 'https://monitor.example.com/api/upload',
+ *       branch: process.env.GIT_BRANCH || 'main',
+ *       commit: process.env.GIT_COMMIT,
+ *     }],
+ *   ],
+ * };
+ * ```
+ */
+export default function MonitorModule(this: NuxtModuleThis, options: MonitorModuleOptions): void;
+export {};

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@tourmind-frontend/monitor-plugin-nuxt",
+  "version": "1.0.1",
+  "description": "Nuxt 2 module that captures runtime errors and uploads sourcemaps to a frontend-monitor server.",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "templates",
+    "!dist/tsconfig.tsbuildinfo"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=13"
+  },
+  "dependencies": {
+    "@tourmind-frontend/monitor-tracking": "workspace:^",
+    "axios": "^0.27.2",
+    "form-data": "^3.0.0"
+  },
+  "peerDependencies": {
+    "nuxt": ">=2.4.0",
+    "vue": ">=2.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.6.0"
+  },
+  "keywords": [
+    "nuxt",
+    "nuxt-module",
+    "nuxt2",
+    "sourcemap",
+    "frontend-monitor",
+    "error-tracking"
+  ]
+}

package/templates/plugin.client.js

@@ -0,0 +1,22 @@
+import Vue from "vue";
+import { register } from "@tourmind-frontend/monitor-tracking";
+
+// Nuxt 2 模板：构建阶段会替换 options 占位符
+export default function () {
+  register({
+    url: "<%= options.url %>",
+    project: "<%= options.project %>",
+    // 桥接 Vue 2 的 errorHandler，链式调用既有 handler，不覆盖。
+    callback: function (handler) {
+      var existing = Vue.config.errorHandler;
+      Vue.config.errorHandler = function (err, vm, info) {
+        try {
+          handler(err);
+        } catch (_) {
+          /* 上报失败不影响业务错误处理 */
+        }
+        if (typeof existing === "function") return existing(err, vm, info);
+      };
+    },
+  });
+}