@fz-firefly/vue 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,84 @@
-# Temporary Holding Version
+# @fz-firefly/vue
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+萤火虫 SDK 的 Vue 2 / Vue 3 一键接入包。安装后只需要调用一次 `initFirefly`，内部会自动创建客户端、接入 Vue 错误处理并绑定路由面包屑。
+
+`@fz-firefly/web`、`@fz-firefly/core`、`@fz-firefly/vue-plugin` 都是这个包的内部依赖，用户不需要单独安装或 import。
+
+## 安装
+
+```bash
+pnpm add @fz-firefly/vue
+```
+
+## Vue 3
+
+```ts
+import { createApp } from 'vue'
+import { initFirefly } from '@fz-firefly/vue'
+import App from './App.vue'
+import router from './router'
+
+const app = createApp(App)
+
+initFirefly({
+  app,
+  router,
+  dsn: import.meta.env.VITE_FIREFLY_DSN,
+  endpoint: import.meta.env.VITE_FIREFLY_ENDPOINT,
+  environment: import.meta.env.PROD ? 'production' : 'development',
+  release: import.meta.env.VITE_APP_RELEASE,
+})
+
+app.use(router)
+app.mount('#app')
+```
+
+## Vue 2
+
+```js
+import Vue from 'vue'
+import { initFirefly } from '@fz-firefly/vue'
+import App from './App.vue'
+import router from './router'
+
+initFirefly({
+  Vue,
+  router,
+  dsn: process.env.VUE_APP_FIREFLY_DSN,
+  endpoint: process.env.VUE_APP_FIREFLY_ENDPOINT,
+  environment:
+    process.env.NODE_ENV === 'production' ? 'production' : 'development',
+  release: process.env.VUE_APP_RELEASE,
+})
+
+new Vue({
+  router,
+  render: (h) => h(App),
+}).$mount('#app')
+```
+
+## 手动上报
+
+初始化后，组件里可以直接使用：
+
+```js
+this.$firefly.captureException(new Error('something went wrong'))
+this.$firefly.captureMessage('checkout failed', 'warning')
+```
+
+`initFirefly` 的返回值也可以拿到 client：
+
+```ts
+const firefly = initFirefly({ app, ... })
+firefly.client.captureException(error)
+```
+
+## 行为
+
+- 捕获 Vue 2 / Vue 3 组件错误，并保留业务原有的 `errorHandler`。
+- 把客户端挂到 `Vue.prototype.$firefly` / `app.config.globalProperties.$firefly`。
+- 传入 `router` 时：
+  - `onError` 上报路由错误；
+  - `afterEach` 记录导航面包屑，并补报导航失败。
+- 不传 `dist` 时默认使用 `h5`。
+- 默认安装 web 全局错误钩子、资源错误钩子和 `pagehide` 冲刷。

package/dist/index.cjs

@@ -0,0 +1,128 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _fz_firefly_vue_plugin = require("@fz-firefly/vue-plugin");
+let _fz_firefly_web = require("@fz-firefly/web");
+// \0@oxc-project+runtime@0.155.0/helpers/esm/objectWithoutPropertiesLoose.js
+function _objectWithoutPropertiesLoose(r, e) {
+	if (null == r) return {};
+	var t = {};
+	for (var n in r) if ({}.hasOwnProperty.call(r, n)) {
+		if (e.includes(n)) continue;
+		t[n] = r[n];
+	}
+	return t;
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/objectWithoutProperties.js
+function _objectWithoutProperties(e, t) {
+	if (null == e) return {};
+	var o, r, i = _objectWithoutPropertiesLoose(e, t);
+	if (Object.getOwnPropertySymbols) {
+		var s = Object.getOwnPropertySymbols(e);
+		for (r = 0; r < s.length; r++) o = s[r], t.includes(o) || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]);
+	}
+	return i;
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/typeof.js
+function _typeof(o) {
+	"@babel/helpers - typeof";
+	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
+		return typeof o;
+	} : function(o) {
+		return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
+	}, _typeof(o);
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/toPrimitive.js
+function toPrimitive(t, r) {
+	if ("object" != _typeof(t) || !t) return t;
+	var e = t[Symbol.toPrimitive];
+	if (void 0 !== e) {
+		var i = e.call(t, r || "default");
+		if ("object" != _typeof(i)) return i;
+		throw new TypeError("@@toPrimitive must return a primitive value.");
+	}
+	return ("string" === r ? String : Number)(t);
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/toPropertyKey.js
+function toPropertyKey(t) {
+	var i = toPrimitive(t, "string");
+	return "symbol" == _typeof(i) ? i : i + "";
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/defineProperty.js
+function _defineProperty(e, r, t) {
+	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
+		value: t,
+		enumerable: !0,
+		configurable: !0,
+		writable: !0
+	}) : e[r] = t, e;
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/objectSpread2.js
+function ownKeys(e, r) {
+	var t = Object.keys(e);
+	if (Object.getOwnPropertySymbols) {
+		var o = Object.getOwnPropertySymbols(e);
+		r && (o = o.filter(function(r) {
+			return Object.getOwnPropertyDescriptor(e, r).enumerable;
+		})), t.push.apply(t, o);
+	}
+	return t;
+}
+function _objectSpread2(e) {
+	for (var r = 1; r < arguments.length; r++) {
+		var t = null != arguments[r] ? arguments[r] : {};
+		r % 2 ? ownKeys(Object(t), !0).forEach(function(r) {
+			_defineProperty(e, r, t[r]);
+		}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function(r) {
+			Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r));
+		});
+	}
+	return e;
+}
+// src/index.ts
+const _excluded = [
+	"app",
+	"Vue",
+	"router"
+];
+/**
+* 一次性完成 Firefly 初始化和 Vue 接入。
+*
+* - 创建客户端、安装 web 全局错误钩子；
+* - 安装 Vue 2 / Vue 3 组件错误处理；
+* - 把客户端挂到 `this.$firefly` / `app.config.globalProperties.$firefly`；
+* - 传入 router 时记录路由错误和导航面包屑。
+*/
+function initFirefly(options) {
+	var _options$dist;
+	if (options.app && options.Vue) throw new Error("Firefly: app 和 Vue 只能传一个");
+	if (!options.app && !options.Vue) throw new Error("Firefly: @fz-firefly/vue 需要传入 app（Vue 3）或 Vue（Vue 2）");
+	const { app, Vue, router } = options, webOptions = _objectWithoutProperties(options, _excluded);
+	const handle = (0, _fz_firefly_web.initFirefly)(_objectSpread2(_objectSpread2({}, webOptions), {}, { dist: (_options$dist = options.dist) !== null && _options$dist !== void 0 ? _options$dist : "h5" }));
+	(0, _fz_firefly_vue_plugin.installVue)({
+		client: handle.client,
+		app,
+		Vue,
+		router
+	});
+	return handle;
+}
+Object.defineProperty(exports, "fireflyVue", {
+	enumerable: true,
+	get: function() {
+		return _fz_firefly_vue_plugin.fireflyVue;
+	}
+});
+Object.defineProperty(exports, "fireflyVue2", {
+	enumerable: true,
+	get: function() {
+		return _fz_firefly_vue_plugin.fireflyVue2;
+	}
+});
+exports.initFirefly = initFirefly;
+Object.defineProperty(exports, "installVue", {
+	enumerable: true,
+	get: function() {
+		return _fz_firefly_vue_plugin.installVue;
+	}
+});
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.d.cts

@@ -0,0 +1,29 @@
+import { FireflyVueOptions, RouteLike, RouterLike, RouterLike as RouterLike$1, Vue2ConstructorLike, Vue2ConstructorLike as Vue2ConstructorLike$1, Vue3AppLike, Vue3AppLike as Vue3AppLike$1, fireflyVue, fireflyVue2, installVue } from "@fz-firefly/vue-plugin";
+import { FireflyHandle as FireflyHandle$1, InitOptions as InitOptions$1 } from "@fz-firefly/web";
+import { FireflyClient } from "@fz-firefly/core";
+/**
+ * Vue Web 一键初始化参数。
+ *
+ * 在 web 适配层参数的基础上，额外接收 Vue 3 app 或 Vue 2 构造函数。
+ */
+export interface InitOptions extends InitOptions$1 {
+  /** Vue 3 app；与 Vue 二选一。 */
+  app?: Vue3AppLike$1;
+  /** Vue 2 构造函数；与 app 二选一。 */
+  Vue?: Vue2ConstructorLike$1;
+  /** 可选：vue-router 实例，用于捕获路由错误和记录导航面包屑。 */
+  router?: RouterLike$1;
+}
+/** initFirefly 的返回值。 */
+export type FireflyHandle = FireflyHandle$1;
+/**
+ * 一次性完成 Firefly 初始化和 Vue 接入。
+ *
+ * - 创建客户端、安装 web 全局错误钩子；
+ * - 安装 Vue 2 / Vue 3 组件错误处理；
+ * - 把客户端挂到 `this.$firefly` / `app.config.globalProperties.$firefly`；
+ * - 传入 router 时记录路由错误和导航面包屑。
+ */
+export declare function initFirefly(options: InitOptions): FireflyHandle;
+export { type FireflyClient, type FireflyVueOptions, type RouteLike, type RouterLike, type Vue2ConstructorLike, type Vue3AppLike, fireflyVue, fireflyVue2, installVue };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+import { FireflyVueOptions, RouteLike, RouterLike, RouterLike as RouterLike$1, Vue2ConstructorLike, Vue2ConstructorLike as Vue2ConstructorLike$1, Vue3AppLike, Vue3AppLike as Vue3AppLike$1, fireflyVue, fireflyVue2, installVue } from "@fz-firefly/vue-plugin";
+import { FireflyHandle as FireflyHandle$1, InitOptions as InitOptions$1 } from "@fz-firefly/web";
+import { FireflyClient } from "@fz-firefly/core";
+/**
+ * Vue Web 一键初始化参数。
+ *
+ * 在 web 适配层参数的基础上，额外接收 Vue 3 app 或 Vue 2 构造函数。
+ */
+export interface InitOptions extends InitOptions$1 {
+  /** Vue 3 app；与 Vue 二选一。 */
+  app?: Vue3AppLike$1;
+  /** Vue 2 构造函数；与 app 二选一。 */
+  Vue?: Vue2ConstructorLike$1;
+  /** 可选：vue-router 实例，用于捕获路由错误和记录导航面包屑。 */
+  router?: RouterLike$1;
+}
+/** initFirefly 的返回值。 */
+export type FireflyHandle = FireflyHandle$1;
+/**
+ * 一次性完成 Firefly 初始化和 Vue 接入。
+ *
+ * - 创建客户端、安装 web 全局错误钩子；
+ * - 安装 Vue 2 / Vue 3 组件错误处理；
+ * - 把客户端挂到 `this.$firefly` / `app.config.globalProperties.$firefly`；
+ * - 传入 router 时记录路由错误和导航面包屑。
+ */
+export declare function initFirefly(options: InitOptions): FireflyHandle;
+export { type FireflyClient, type FireflyVueOptions, type RouteLike, type RouterLike, type Vue2ConstructorLike, type Vue3AppLike, fireflyVue, fireflyVue2, installVue };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,109 @@
+import { fireflyVue, fireflyVue2, installVue, installVue as installVue$1 } from "@fz-firefly/vue-plugin";
+import { initFirefly as initFirefly$1 } from "@fz-firefly/web";
+// \0@oxc-project+runtime@0.155.0/helpers/esm/objectWithoutPropertiesLoose.js
+function _objectWithoutPropertiesLoose(r, e) {
+	if (null == r) return {};
+	var t = {};
+	for (var n in r) if ({}.hasOwnProperty.call(r, n)) {
+		if (e.includes(n)) continue;
+		t[n] = r[n];
+	}
+	return t;
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/objectWithoutProperties.js
+function _objectWithoutProperties(e, t) {
+	if (null == e) return {};
+	var o, r, i = _objectWithoutPropertiesLoose(e, t);
+	if (Object.getOwnPropertySymbols) {
+		var s = Object.getOwnPropertySymbols(e);
+		for (r = 0; r < s.length; r++) o = s[r], t.includes(o) || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]);
+	}
+	return i;
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/typeof.js
+function _typeof(o) {
+	"@babel/helpers - typeof";
+	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
+		return typeof o;
+	} : function(o) {
+		return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
+	}, _typeof(o);
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/toPrimitive.js
+function toPrimitive(t, r) {
+	if ("object" != _typeof(t) || !t) return t;
+	var e = t[Symbol.toPrimitive];
+	if (void 0 !== e) {
+		var i = e.call(t, r || "default");
+		if ("object" != _typeof(i)) return i;
+		throw new TypeError("@@toPrimitive must return a primitive value.");
+	}
+	return ("string" === r ? String : Number)(t);
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/toPropertyKey.js
+function toPropertyKey(t) {
+	var i = toPrimitive(t, "string");
+	return "symbol" == _typeof(i) ? i : i + "";
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/defineProperty.js
+function _defineProperty(e, r, t) {
+	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
+		value: t,
+		enumerable: !0,
+		configurable: !0,
+		writable: !0
+	}) : e[r] = t, e;
+}
+// \0@oxc-project+runtime@0.155.0/helpers/esm/objectSpread2.js
+function ownKeys(e, r) {
+	var t = Object.keys(e);
+	if (Object.getOwnPropertySymbols) {
+		var o = Object.getOwnPropertySymbols(e);
+		r && (o = o.filter(function(r) {
+			return Object.getOwnPropertyDescriptor(e, r).enumerable;
+		})), t.push.apply(t, o);
+	}
+	return t;
+}
+function _objectSpread2(e) {
+	for (var r = 1; r < arguments.length; r++) {
+		var t = null != arguments[r] ? arguments[r] : {};
+		r % 2 ? ownKeys(Object(t), !0).forEach(function(r) {
+			_defineProperty(e, r, t[r]);
+		}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function(r) {
+			Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r));
+		});
+	}
+	return e;
+}
+// src/index.ts
+const _excluded = [
+	"app",
+	"Vue",
+	"router"
+];
+/**
+* 一次性完成 Firefly 初始化和 Vue 接入。
+*
+* - 创建客户端、安装 web 全局错误钩子；
+* - 安装 Vue 2 / Vue 3 组件错误处理；
+* - 把客户端挂到 `this.$firefly` / `app.config.globalProperties.$firefly`；
+* - 传入 router 时记录路由错误和导航面包屑。
+*/
+function initFirefly(options) {
+	var _options$dist;
+	if (options.app && options.Vue) throw new Error("Firefly: app 和 Vue 只能传一个");
+	if (!options.app && !options.Vue) throw new Error("Firefly: @fz-firefly/vue 需要传入 app（Vue 3）或 Vue（Vue 2）");
+	const { app, Vue, router } = options, webOptions = _objectWithoutProperties(options, _excluded);
+	const handle = initFirefly$1(_objectSpread2(_objectSpread2({}, webOptions), {}, { dist: (_options$dist = options.dist) !== null && _options$dist !== void 0 ? _options$dist : "h5" }));
+	installVue$1({
+		client: handle.client,
+		app,
+		Vue,
+		router
+	});
+	return handle;
+}
+export { fireflyVue, fireflyVue2, initFirefly, installVue };
+
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "@fz-firefly/vue",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "萤火虫 SDK 的 Vue 2 / Vue 3 一键接入包：初始化、组件错误捕获和路由面包屑。",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.map"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@fz-firefly/core": "0.2.0",
+    "@fz-firefly/vue-plugin": "0.2.0",
+    "@fz-firefly/web": "0.2.0"
+  },
+  "devDependencies": {
+    "tsdown": "0.23.2",
+    "typescript": "^5.6.0",
+    "vitest": "^5.0.5",
+    "vue": "^3.5.0"
+  },
+  "peerDependencies": {
+    "vue": "^2.0.0 || ^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "vue": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
 }