@ohbug/vue 1.0.14 → 2.0.0

package/README.md

@@ -2,14 +2,13 @@
 
 [![npm](https://img.shields.io/npm/v/@ohbug/vue.svg?style=flat-square)](https://www.npmjs.com/package/@ohbug/vue)
 [![npm bundle size](https://img.shields.io/bundlephobia/min/@ohbug/vue?style=flat-square)](https://bundlephobia.com/result?p=@ohbug/vue)
-[![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 
 English | [简体中文](./README-zh_CN.md)
 
 ## Installation
 
 ```
-yarn add @ohbug/browser @ohbug/vue
+pnpm instal @ohbug/browser @ohbug/vue
 ```
 
 ## Usage
@@ -19,6 +18,9 @@ import Vue from 'vue'
 import Ohbug from '@ohbug/browser'
 import OhbugVue from '@ohbug/vue'
 
-const client = Ohbug.init({ apiKey: 'YOUR_API_KEY' })
-client.use(OhbugVue, Vue)
+const client = Ohbug.setup({ apiKey: 'YOUR_API_KEY' })
+
+Vue.createApp(App)
+  .use(OhbugVue(client))
+  .mount('#app')
 ```

package/dist/index.js

@@ -0,0 +1,75 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  default: () => createVueClient
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/install.ts
+var import_core = require("@ohbug/core");
+var getComponent = (instance) => {
+  if ((instance == null ? void 0 : instance.$root) === instance)
+    return { component: "Root" };
+  const options = instance == null ? void 0 : instance.$options;
+  const component = options == null ? void 0 : options.name;
+  const file = options == null ? void 0 : options.__file;
+  return {
+    component,
+    file
+  };
+};
+function install(client, Vue) {
+  const prev = Vue.config.errorHandler;
+  const handler = (error, instance, info) => {
+    const { component, file } = getComponent(instance);
+    const detail = {
+      name: error.name,
+      message: error.message,
+      stack: error.stack,
+      errorInfo: info,
+      component,
+      file,
+      props: instance ? instance.$options.propsData : void 0
+    };
+    const event = client.createEvent({
+      category: "error",
+      type: import_core.EventTypes.VUE,
+      detail
+    });
+    client.notify(event);
+    if (typeof console !== "undefined" && typeof console.error === "function")
+      console.error(error);
+    if (typeof prev === "function")
+      prev(error, instance, info);
+  };
+  Vue.config.errorHandler = handler;
+}
+
+// src/index.ts
+function createVueClient(client) {
+  return {
+    install: (app) => {
+      install(client, app);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {});

package/dist/index.mjs

@@ -0,0 +1,51 @@
+// src/install.ts
+import { EventTypes } from "@ohbug/core";
+var getComponent = (instance) => {
+  if ((instance == null ? void 0 : instance.$root) === instance)
+    return { component: "Root" };
+  const options = instance == null ? void 0 : instance.$options;
+  const component = options == null ? void 0 : options.name;
+  const file = options == null ? void 0 : options.__file;
+  return {
+    component,
+    file
+  };
+};
+function install(client, Vue) {
+  const prev = Vue.config.errorHandler;
+  const handler = (error, instance, info) => {
+    const { component, file } = getComponent(instance);
+    const detail = {
+      name: error.name,
+      message: error.message,
+      stack: error.stack,
+      errorInfo: info,
+      component,
+      file,
+      props: instance ? instance.$options.propsData : void 0
+    };
+    const event = client.createEvent({
+      category: "error",
+      type: EventTypes.VUE,
+      detail
+    });
+    client.notify(event);
+    if (typeof console !== "undefined" && typeof console.error === "function")
+      console.error(error);
+    if (typeof prev === "function")
+      prev(error, instance, info);
+  };
+  Vue.config.errorHandler = handler;
+}
+
+// src/index.ts
+function createVueClient(client) {
+  return {
+    install: (app) => {
+      install(client, app);
+    }
+  };
+}
+export {
+  createVueClient as default
+};

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@ohbug/vue",
-  "version": "1.0.14",
+  "version": "2.0.0",
   "description": "Ohbug SDK for Vue",
+  "license": "Apache-2.0",
   "author": "chenyueban <jasonchan0527@gmail.com>",
   "homepage": "https://github.com/ohbug-org/ohbug",
   "bugs": {
@@ -11,40 +12,37 @@
     "type": "git",
     "url": "https://github.com/ohbug-org/ohbug"
   },
-  "license": "Apache-2.0",
-  "main": "./dist/ohbug-vue.umd.js",
-  "module": "./dist/ohbug-vue.es.js",
-  "unpkg": "./dist/ohbug-vue.umd.js",
-  "jsdelivr": "./dist/ohbug-vue.umd.js",
-  "types": "./dist/index.d.ts",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/ohbug-vue.es.js",
-      "require": "./dist/ohbug-vue.umd.js"
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "src"
   ],
+  "sideEffects": false,
+  "peerDependencies": {
+    "vue": "^3.0.0"
+  },
   "dependencies": {
-    "@ohbug/core": "^1.1.7"
+    "@ohbug/core": "2.0.0",
+    "@ohbug/types": "2.0.0"
   },
   "devDependencies": {
-    "vue": "^2.6.11"
-  },
-  "peerDependencies": {
-    "vue": "^2.6.0"
-  },
-  "buildOptions": {
-    "name": "OhbugVue",
-    "formats": [
-      "es",
-      "umd"
-    ],
-    "order": 4
+    "vue": "^3.2.33"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "323e4755a0da5893748c19901f3f709e903b6dd2"
-}
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  },
+  "readme": "# `@ohbug/vue`\n\n[![npm](https://img.shields.io/npm/v/@ohbug/vue.svg?style=flat-square)](https://www.npmjs.com/package/@ohbug/vue)\n[![npm bundle size](https://img.shields.io/bundlephobia/min/@ohbug/vue?style=flat-square)](https://bundlephobia.com/result?p=@ohbug/vue)\n\nEnglish | [简体中文](./README-zh_CN.md)\n\n## Installation\n\n```\npnpm instal @ohbug/browser @ohbug/vue\n```\n\n## Usage\n\n```javascript\nimport Vue from 'vue'\nimport Ohbug from '@ohbug/browser'\nimport OhbugVue from '@ohbug/vue'\n\nconst client = Ohbug.setup({ apiKey: 'YOUR_API_KEY' })\n\nVue.createApp(App)\n  .use(OhbugVue(client))\n  .mount('#app')\n```\n"
+}

package/src/index.ts

@@ -0,0 +1,13 @@
+import type { OhbugClient } from '@ohbug/types'
+import type { Plugin } from 'vue'
+import { install } from './install'
+
+export type { VueErrorDetail } from './install'
+
+export default function createVueClient(client: OhbugClient): Plugin {
+  return {
+    install: (app) => {
+      install(client, app)
+    },
+  }
+}

package/src/install.ts

@@ -0,0 +1,58 @@
+import { EventTypes } from '@ohbug/core'
+import type { OhbugBaseDetail, OhbugClient } from '@ohbug/types'
+import type { App, ComponentPublicInstance } from 'vue'
+
+export interface VueErrorDetail extends OhbugBaseDetail {
+  name: string
+  stack?: string
+  errorInfo: string
+  component?: string
+  file?: string
+  props?: Record<string, any>
+}
+
+const getComponent = (instance: ComponentPublicInstance | null) => {
+  if (instance?.$root === instance)
+    return { component: 'Root' }
+
+  const options = instance?.$options
+  const component = options?.name
+  const file = options?.__file
+
+  return {
+    component,
+    file,
+  }
+}
+
+export function install(client: OhbugClient, Vue: App) {
+  const prev = Vue.config.errorHandler
+
+  const handler = (error: Error, instance: ComponentPublicInstance | null, info: string) => {
+    const { component, file } = getComponent(instance)
+
+    const detail: VueErrorDetail = {
+      name: error.name,
+      message: error.message,
+      stack: error.stack,
+      errorInfo: info,
+      component,
+      file,
+      props: instance ? instance.$options.propsData : undefined,
+    }
+    const event = client.createEvent<VueErrorDetail>({
+      category: 'error',
+      type: EventTypes.VUE,
+      detail,
+    })
+
+    client.notify(event)
+
+    if (typeof console !== 'undefined' && typeof console.error === 'function')
+      console.error(error)
+    if (typeof prev === 'function') prev(error, instance, info)
+  }
+
+  // @ts-expect-error type is not assignable
+  Vue.config.errorHandler = handler
+}

package/dist/extension.d.ts

@@ -1,2 +0,0 @@
-export declare const extension: import("@ohbug/types").OhbugExtension<any>;
-//# sourceMappingURL=extension.d.ts.map

package/dist/extension.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"extension.d.ts","sourceRoot":"","sources":["../src/extension.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,SAAS,4CAQpB,CAAA"}

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-export type { VueErrorDetail } from './install';
-export { extension as default } from './extension';
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC/C,OAAO,EAAE,SAAS,IAAI,OAAO,EAAE,MAAM,aAAa,CAAA"}

package/dist/install.d.ts

@@ -1,12 +0,0 @@
-import type { OhbugBaseDetail, OhbugClient } from '@ohbug/types';
-import type { VueConstructor } from 'vue';
-export interface VueErrorDetail extends OhbugBaseDetail {
-    name: string;
-    stack?: string;
-    errorInfo: string;
-    component: string;
-    file: string;
-    props?: Record<string, any>;
-}
-export declare function install(client: OhbugClient, Vue: VueConstructor): void;
-//# sourceMappingURL=install.d.ts.map

package/dist/install.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"install.d.ts","sourceRoot":"","sources":["../src/install.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,KAAK,CAAA;AAGzC,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5B;AAkBD,wBAAgB,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,cAAc,QA6B/D"}

package/dist/ohbug-vue.es.js

@@ -1,15 +0,0 @@
-/*! *****************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-var e=function(){return(e=Object.assign||function(e){for(var t,r=1,n=arguments.length;r<n;r++)for(var o in t=arguments[r])Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o]);return e}).apply(this,arguments)};function t(e){return"string"==typeof e}var r=function(e,t,r,n){this.type=r,this.timestamp=n||(new Date).toISOString(),this.message=e,this.data=t};!function(){function n(e,t){var r=e.apiKey,n=e.appVersion,o=e.appType,a=e.releaseStage,i=e.timestamp,s=e.category,p=e.type,c=e.sdk,u=e.detail,f=e.device,l=e.user,h=e.actions,E=e.metaData;this.apiKey=r,this.appVersion=n,this.appType=o,this.releaseStage=a,this.timestamp=i,this.category=s,this.type=p,this.sdk=c,this.detail=u,this.device=f,this.user=l,this.actions=h,this.metaData=E,this._client=t}Object.defineProperty(n.prototype,"_isOhbugEvent",{get:function(){return!0},enumerable:!1,configurable:!0}),n.prototype.addAction=function(e,n,o,a){var i,s,p=this.actions,c=t(e)?e:"",u=n||{},f=t(o)?o:"",l=new r(c,u,f,a);p.length>=(null!==(s=null===(i=this._client)||void 0===i?void 0:i._config.maxActions)&&void 0!==s?s:30)&&p.shift(),p.push(l)},n.prototype.getUser=function(){return this.user},n.prototype.setUser=function(t){var r;if(function(e){return"[object Object]"===Object.prototype.toString.call(e)}(t)&&Object.keys(t).length<=6)return this.user=e(e({},this.user),t),this.getUser();null===(r=this._client)||void 0===r||r._logger.warn(function(e,t){return new Error("Invalid data\n- "+e+", got "+JSON.stringify(t))}("setUser should be an object and have up to 6 attributes",t))},n.prototype.addMetaData=function(e,t){return function(e,t,r){t&&(e[t]=r)}(this.metaData,e,t)},n.prototype.getMetaData=function(e){return function(e,t){if(e[t])return e[t]}(this.metaData,e)},n.prototype.deleteMetaData=function(e){return function(e,t){if(e[t])return delete e[t]}(this.metaData,e)},n.prototype.toJSON=function(){var e=this;return{apiKey:e.apiKey,appVersion:e.appVersion,appType:e.appType,timestamp:e.timestamp,category:e.category,type:e.type,sdk:e.sdk,device:e.device,detail:e.detail,user:e.user,actions:e.actions,metaData:e.metaData,releaseStage:e.releaseStage}}}();Object.freeze({__proto__:null,UNCAUGHT_ERROR:"uncaughtError",RESOURCE_ERROR:"resourceError",UNHANDLEDREJECTION_ERROR:"unhandledrejectionError",AJAX_ERROR:"ajaxError",FETCH_ERROR:"fetchError",WEBSOCKET_ERROR:"websocketError",UNKNOWN_ERROR:"unknownError",MESSAGE:"message",FEEDBACK:"feedback",VIEW:"view",REACT:"react",VUE:"vue",ANGULAR:"angular",MINIAPP_ERROR:"miniappError",MINIAPP_UNHANDLEDREJECTION_ERROR:"miniappUnhandledrejectionError",MINIAPP_PAGENOTFOUND_ERROR:"miniappPagenotfoundError",MINIAPP_MEMORYWARNING_ERROR:"miniappMemorywarningError"});var n={name:"OhbugVue",init:function(e,t){if(!t)throw new Error("Ohbug @ohbug/vue reference to `Vue` was undefined");return function(e,t){var r=t.config.errorHandler;t.config.errorHandler=function(t,n,o){var a=function(e){if(e.$root===e)return{component:"Root"};var t=e.$options;return{component:t.name,file:t.__file}}(n),i=a.component,s=a.file,p={name:t.name,message:t.message,stack:t.stack,errorInfo:o,component:i,file:s,props:n?n.$options.propsData:void 0},c=e.createEvent({category:"error",type:"vue",detail:p});e.notify(c),"undefined"!=typeof console&&"function"==typeof console.error&&console.error(t),"function"==typeof r&&r(t,n,o)}}(e,t)}};export{n as default};

package/dist/ohbug-vue.umd.js

@@ -1,15 +0,0 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).OhbugVue=t()}(this,(function(){"use strict";
-/*! *****************************************************************************
-  Copyright (c) Microsoft Corporation.
-
-  Permission to use, copy, modify, and/or distribute this software for any
-  purpose with or without fee is hereby granted.
-
-  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-  REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-  AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-  INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-  LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-  OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-  PERFORMANCE OF THIS SOFTWARE.
-  ***************************************************************************** */var e=function(){return(e=Object.assign||function(e){for(var t,r=1,n=arguments.length;r<n;r++)for(var o in t=arguments[r])Object.prototype.hasOwnProperty.call(t,o)&&(e[o]=t[o]);return e}).apply(this,arguments)};function t(e){return"string"==typeof e}var r=function(e,t,r,n){this.type=r,this.timestamp=n||(new Date).toISOString(),this.message=e,this.data=t};!function(){function n(e,t){var r=e.apiKey,n=e.appVersion,o=e.appType,i=e.releaseStage,a=e.timestamp,s=e.category,p=e.type,u=e.sdk,c=e.detail,f=e.device,l=e.user,d=e.actions,h=e.metaData;this.apiKey=r,this.appVersion=n,this.appType=o,this.releaseStage=i,this.timestamp=a,this.category=s,this.type=p,this.sdk=u,this.detail=c,this.device=f,this.user=l,this.actions=d,this.metaData=h,this._client=t}Object.defineProperty(n.prototype,"_isOhbugEvent",{get:function(){return!0},enumerable:!1,configurable:!0}),n.prototype.addAction=function(e,n,o,i){var a,s,p=this.actions,u=t(e)?e:"",c=n||{},f=t(o)?o:"",l=new r(u,c,f,i);p.length>=(null!==(s=null===(a=this._client)||void 0===a?void 0:a._config.maxActions)&&void 0!==s?s:30)&&p.shift(),p.push(l)},n.prototype.getUser=function(){return this.user},n.prototype.setUser=function(t){var r;if(function(e){return"[object Object]"===Object.prototype.toString.call(e)}(t)&&Object.keys(t).length<=6)return this.user=e(e({},this.user),t),this.getUser();null===(r=this._client)||void 0===r||r._logger.warn(function(e,t){return new Error("Invalid data\n- "+e+", got "+JSON.stringify(t))}("setUser should be an object and have up to 6 attributes",t))},n.prototype.addMetaData=function(e,t){return function(e,t,r){t&&(e[t]=r)}(this.metaData,e,t)},n.prototype.getMetaData=function(e){return function(e,t){if(e[t])return e[t]}(this.metaData,e)},n.prototype.deleteMetaData=function(e){return function(e,t){if(e[t])return delete e[t]}(this.metaData,e)},n.prototype.toJSON=function(){var e=this;return{apiKey:e.apiKey,appVersion:e.appVersion,appType:e.appType,timestamp:e.timestamp,category:e.category,type:e.type,sdk:e.sdk,device:e.device,detail:e.detail,user:e.user,actions:e.actions,metaData:e.metaData,releaseStage:e.releaseStage}}}();Object.freeze({__proto__:null,UNCAUGHT_ERROR:"uncaughtError",RESOURCE_ERROR:"resourceError",UNHANDLEDREJECTION_ERROR:"unhandledrejectionError",AJAX_ERROR:"ajaxError",FETCH_ERROR:"fetchError",WEBSOCKET_ERROR:"websocketError",UNKNOWN_ERROR:"unknownError",MESSAGE:"message",FEEDBACK:"feedback",VIEW:"view",REACT:"react",VUE:"vue",ANGULAR:"angular",MINIAPP_ERROR:"miniappError",MINIAPP_UNHANDLEDREJECTION_ERROR:"miniappUnhandledrejectionError",MINIAPP_PAGENOTFOUND_ERROR:"miniappPagenotfoundError",MINIAPP_MEMORYWARNING_ERROR:"miniappMemorywarningError"});return{name:"OhbugVue",init:function(e,t){if(!t)throw new Error("Ohbug @ohbug/vue reference to `Vue` was undefined");return function(e,t){var r=t.config.errorHandler;t.config.errorHandler=function(t,n,o){var i=function(e){if(e.$root===e)return{component:"Root"};var t=e.$options;return{component:t.name,file:t.__file}}(n),a=i.component,s=i.file,p={name:t.name,message:t.message,stack:t.stack,errorInfo:o,component:a,file:s,props:n?n.$options.propsData:void 0},u=e.createEvent({category:"error",type:"vue",detail:p});e.notify(u),"undefined"!=typeof console&&"function"==typeof console.error&&console.error(t),"function"==typeof r&&r(t,n,o)}}(e,t)}}}));