sentry-uniapp 0.12.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Sentry
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,216 @@
+# Sentry 小程序 SDK
+
+![npm version](https://img.shields.io/npm/v/sentry-miniapp)
+![npm download](https://img.shields.io/npm/dm/sentry-miniapp)
+![github forks](https://img.shields.io/github/forks/lizhiyao/sentry-miniapp?style=social)
+![github stars](https://img.shields.io/github/stars/lizhiyao/sentry-miniapp?style=social)
+![github watchers](https://img.shields.io/github/watchers/lizhiyao/sentry-miniapp?style=social)
+![github license](https://img.shields.io/github/license/lizhiyao/sentry-miniapp)
+
+用于小程序平台的 Sentry SDK
+
+## 功能特点
+
+- [x] 基于 [sentry-javascript 最新的基础模块](https://www.yuque.com/lizhiyao/dxy/zevhf1#0GMCN) 封装
+- [x] 遵守[官方统一的 API 设计文档](https://www.yuque.com/lizhiyao/dxy/gc3b9r#vQdTs)，使用方式和官方保持一致
+- [x] 使用 [TypeScript](https://www.typescriptlang.org/) 进行编写
+- [x] 包含 Sentry SDK（如：[@sentry/browser](https://github.com/getsentry/sentry-javascript/tree/master/packages/browser)）的所有基础功能
+- [x] 支持 `ES6`、`CommonJS` 两种模块系统（支持小程序原生开发方式、使用小程序框架开发方式两种开发模式下使用）
+- [x] 默认监听并上报小程序的 onError、onUnhandledRejection、onPageNotFound、onMemoryWarning 事件返回的信息（各事件支持程度与对应各小程序官方保持一致）
+- [x] 默认上报运行小程序的设备、操作系统、应用版本信息
+- [x] 支持微信小程序
+- [x] 支持微信小游戏
+- [x] 支持字节跳动小程序
+- [x] 支持支付宝小程序
+- [x] 支持钉钉小程序
+- [x] 支持百度小程序
+- [x] 支持在 [Taro](https://taro.aotu.io/) 等第三方小程序框架中使用
+- [x] 默认上报异常发生时的路由栈
+- [ ] 完善的代码测试
+
+## 用法
+
+支持两种使用方式：
+
+- 直接引用
+- 通过 npm 方式使用（推荐）
+
+### 注意
+
+1. 无论选择哪种使用方式，都需要开启「微信开发者工具 - 设置 - 项目设置 - 增强编译」功能
+2. 使用前需要确保有可用的 `Sentry Service`，比如：使用 [官方 Sentry Service](https://sentry.io/welcome/) 服务 或[自己搭建 Sentry Service](https://docs.sentry.io/server/)。如果想直接将异常信息上报到 <https://sentry.io/>，由于其没有备案，可以先将异常信息上报给自己已备案域名下的服务端接口，由服务端进行请求转发。
+3. 在小程序管理后台配置 `Sentry Service` 对应的 `request` 合法域名
+
+### 直接引用
+
+1. 微信小程序和微信小游戏下载 [sentry-miniapp.wx.min.js](https://github.com/lizhiyao/sentry-miniapp/blob/master/examples/weapp/vendor/sentry-miniapp.wx.min.js)；字节跳动小程序下载 [sentry-miniapp.tt.min.js](https://github.com/lizhiyao/sentry-miniapp/blob/master/examples/ttapp/vendor/sentry-miniapp.tt.min.js)；支付宝小程序下载 [sentry-miniapp.my.min.js](https://github.com/lizhiyao/sentry-miniapp/blob/master/examples/myapp/vendor/sentry-miniapp.my.min.js)，钉钉小程序下载 [sentry-miniapp.dd.min.js](https://github.com/lizhiyao/sentry-miniapp/blob/master/examples/ddapp/vendor/sentry-miniapp.dd.min.js)
+2. 参照 `/examples` 中各项目使用方式，将 `sentry-miniapp.xx.min.js` 放入项目的合适目录中，比如放入 `vendor` 文件夹
+3. 参照 `/examples/app.js` 代码，进行 `Sentry` 的初始化
+4. 对于提供了微信、字节跳动小程序 `sentry-miniapp` 会自动上报 `xx.onError()` 捕获的异常，对于支付宝小程序需要应用开发者在 `App.onError()` 中主动进行异常上报。详情可见 `/docs/cross-platform.md`。
+
+### npm 方式
+
+注意：目前字节跳动小程序不支持 npm 方式。
+
+1. 安装依赖
+
+   ```bash
+   npm install sentry-miniapp --save
+   # 或者
+   yarn add sentry-miniapp
+   ```
+
+2. 使用「微信开发者工具 - 工具 - 构建 npm」进行构建，详情可参考[npm 支持](https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html)
+
+3. 在 `app.js` 中引用并初始化 `Sentry`，根据实际需求设置上报到 Sentry 的元信息
+
+   ```js
+   import * as Sentry from "sentry-miniapp";
+
+   // init Sentry
+   // init options: https://github.com/getsentry/sentry-javascript/blob/master/packages/types/src/options.ts
+   Sentry.init({
+     dsn: "__DSN__",
+     // ...
+   });
+
+   // Set user information, as well as tags and further extras
+   Sentry.configureScope((scope) => {
+     scope.setExtra("battery", 0.7);
+     scope.setTag("user_mode", "admin");
+     scope.setUser({ id: "4711" });
+     // scope.clear();
+   });
+
+   // Add a breadcrumb for future events
+   Sentry.addBreadcrumb({
+     message: "My Breadcrumb",
+     // ...
+   });
+
+   // Capture exceptions, messages or manual events
+   Sentry.captureException(new Error("Good bye"));
+   Sentry.captureMessage("Hello, world!");
+   Sentry.captureEvent({
+     message: "Manual",
+     stacktrace: [
+       // ...
+     ],
+   });
+   ```
+
+## 开发
+
+### 知识储备
+
+开发前请仔细阅读下面内容：
+
+- [sentry-javascript README 中文版](https://www.yuque.com/lizhiyao/dxydance/sentry-javascript-readme-cn)
+- [Sentry 开发指南](https://www.yuque.com/lizhiyao/dxydance/sentry-develop-guide)
+- [sentry-javascript 源码阅读](https://www.yuque.com/lizhiyao/dxydance/sentry-javascript-src)
+
+#### sentry-core 设计图
+
+![Dashboard](docs/sentry-core.png)
+
+#### sentry-hub 设计图
+
+![Dashboard](docs/sentry-hub.png)
+
+#### sentry-miniapp 设计图
+
+![Dashboard](docs/sentry-miniapp.png)
+
+### 相关命令
+
+```bash
+# 根据 package.json 中的版本号更新 SDK 源码中的版本号
+npm run version
+
+# 构建供小程序直接引用的 sentry-miniapp.xx.min.js；在本地可直接使用开发者工具打开 examples 下具体项目进行调试
+npm run build:dist
+
+# 构建供微信小程序直接引用的 sentry-miniapp.wx.min.js
+npm run build:wx
+
+# 构建供支付宝小程序直接引用的 sentry-miniapp.my.min.js
+npm run build:my
+
+# 构建供钉钉小程序直接引用的 sentry-miniapp.dd.min.js
+npm run build:dd
+
+# 构建供字节跳动小程序直接引用的 sentry-miniapp.tt.min.js
+npm run build:tt
+
+# 构建供百度小程序直接引用的 sentry-miniapp.swan.min.js
+npm run build:swan
+
+# 构建用于发布到 npm 的 dist 资源
+npm run build
+
+# 构建用于发布到 npm 的 esm 资源
+npm run build:esm
+
+# 发布到 npm
+npm publish --registry=https://registry.npmjs.org/
+```
+
+## 效果图
+
+![Dashboard](docs/screenshot/sentry-admin.png)
+![Error00](docs/screenshot/sentry-error-00.png)
+![Error01](docs/screenshot/sentry-error-01.png)
+![Error02](docs/screenshot/sentry-error-02.png)
+
+## 谁在使用 sentry-miniapp
+
+### 微信小程序
+
+- 丁香医生
+- 丁香医生医生端
+- 丁香人才
+- 丁香家
+
+### 支付宝小程序
+
+- 丁香医生
+
+### 字节跳动小程序
+
+- 丁香医生
+
+## 参考资料
+
+- [sentry-javascript](https://github.com/getsentry/sentry-javascript)
+- [Sentry Getting Started](https://docs.sentry.io/error-reporting/quickstart/?platform=browsernpm)
+- [Sentry JavaScript SDKs](http://getsentry.github.io/sentry-javascript/)
+- [Sentry TypeScript Configuration](https://github.com/getsentry/sentry-javascript/tree/master/packages/typescript)
+- [wx.request](https://developers.weixin.qq.com/miniprogram/dev/api/network/request/wx.request.html)
+- [小程序 App](https://developers.weixin.qq.com/miniprogram/dev/reference/api/App.html)
+- [wx.onError、App.onError 疑惑及如何捕获 Promise 异常？](https://developers.weixin.qq.com/community/develop/doc/000c8cf5794770272709f38a756000)
+- [shields.io](https://shields.io/)
+- [字节跳动小程序文档](https://developer.toutiao.com/docs/framework/)
+- [支付宝小程序文档](https://docs.alipay.com/mini/developer)
+- [tt.onError 的疑问](http://forum.microapp.bytedance.com/topic/2806/tt-onerror-%E7%96%91%E9%97%AE)
+
+## 其他小程序异常监控产品
+
+- [Fundebug](https://www.fundebug.com/)
+- [FrontJS](https://www.frontjs.com/home/tour)
+- [Bugout](https://bugout.testin.cn/)
+
+## 贡献
+
+欢迎通过 `issue`、`pull request`等方式贡献 `sentry-miniapp`。
+
+## 联系作者
+
+PS. 由于微信群二维码有时效性限制，想入群的同学还可以加作者微信（添加时请备注 sentry-miniapp），由作者邀请入群
+
+### sentry-miniapp 微信交流群
+
+<img src="docs/qrcode/sentry-miniapp.jpeg" alt="微信交流群二维码" width="300" height="400" />
+
+### 作者微信二维码
+
+<img src="docs/qrcode/zhiyao.jpeg" alt="作者微信二维码" width="300" height="300" />

package/dist/backend.d.ts

@@ -0,0 +1,40 @@
+import { BaseBackend } from "@sentry/core";
+import { Event, EventHint, Options, Severity, Transport } from "@sentry/types";
+/**
+ * Configuration options for the Sentry Miniapp SDK.
+ * Sentry Miniapp SDK 的配置选项。
+ * @see MiniappClient for more information.
+ */
+export interface MiniappOptions extends Options {
+    /**
+     * A pattern for error URLs which should not be sent to Sentry.
+     * To whitelist certain errors instead, use {@link Options.whitelistUrls}.
+     * By default, all errors will be sent.
+     */
+    blacklistUrls?: Array<string | RegExp>;
+    /**
+     * A pattern for error URLs which should exclusively be sent to Sentry.
+     * This is the opposite of {@link Options.blacklistUrls}.
+     * By default, all errors will be sent.
+     */
+    whitelistUrls?: Array<string | RegExp>;
+}
+/**
+ * The Sentry Browser SDK Backend.
+ * @hidden
+ */
+export declare class MiniappBackend extends BaseBackend<MiniappOptions> {
+    /**
+     * @inheritDoc
+     */
+    protected _setupTransport(): Transport;
+    /**
+     * @inheritDoc
+     */
+    eventFromException(exception: any, hint?: EventHint): PromiseLike<Event>;
+    /**
+     * @inheritDoc
+     */
+    eventFromMessage(message: string, level?: Severity, hint?: EventHint): PromiseLike<Event>;
+}
+//# sourceMappingURL=backend.d.ts.map

package/dist/backend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backend.d.ts","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAM/E;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,OAAO;IAC7C;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IAEvC;;;;OAIG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;CACxC;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,WAAW,CAAC,cAAc,CAAC;IAC7D;;OAEG;IACH,SAAS,CAAC,eAAe,IAAI,SAAS;IAkBtC;;OAEG;IACI,kBAAkB,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC;IAe/E;;OAEG;IACI,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,GAAE,QAAwB,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC,KAAK,CAAC;CAWhH"}

package/dist/backend.js

@@ -0,0 +1,68 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiniappBackend = void 0;
+var tslib_1 = require("tslib");
+var core_1 = require("@sentry/core");
+var types_1 = require("@sentry/types");
+var utils_1 = require("@sentry/utils");
+var eventbuilder_1 = require("./eventbuilder");
+var index_1 = require("./transports/index");
+/**
+ * The Sentry Browser SDK Backend.
+ * @hidden
+ */
+var MiniappBackend = /** @class */ (function (_super) {
+    tslib_1.__extends(MiniappBackend, _super);
+    function MiniappBackend() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * @inheritDoc
+     */
+    MiniappBackend.prototype._setupTransport = function () {
+        if (!this._options.dsn) {
+            // We return the noop transport here in case there is no Dsn.
+            return _super.prototype._setupTransport.call(this);
+        }
+        var transportOptions = tslib_1.__assign(tslib_1.__assign({}, this._options.transportOptions), { dsn: this._options.dsn });
+        if (this._options.transport) {
+            return new this._options.transport(transportOptions);
+        }
+        return new index_1.XHRTransport(transportOptions);
+    };
+    /**
+     * @inheritDoc
+     */
+    MiniappBackend.prototype.eventFromException = function (exception, hint) {
+        var syntheticException = (hint && hint.syntheticException) || undefined;
+        var event = eventbuilder_1.eventFromUnknownInput(exception, syntheticException, {
+            attachStacktrace: this._options.attachStacktrace,
+        });
+        utils_1.addExceptionMechanism(event, {
+            handled: true,
+            type: 'generic',
+        });
+        event.level = types_1.Severity.Error;
+        if (hint && hint.event_id) {
+            event.event_id = hint.event_id;
+        }
+        return utils_1.resolvedSyncPromise(event);
+    };
+    /**
+     * @inheritDoc
+     */
+    MiniappBackend.prototype.eventFromMessage = function (message, level, hint) {
+        if (level === void 0) { level = types_1.Severity.Info; }
+        var syntheticException = (hint && hint.syntheticException) || undefined;
+        var event = eventbuilder_1.eventFromString(message, syntheticException, {
+            attachStacktrace: this._options.attachStacktrace,
+        });
+        event.level = level;
+        if (hint && hint.event_id) {
+            event.event_id = hint.event_id;
+        }
+        return utils_1.resolvedSyncPromise(event);
+    };
+    return MiniappBackend;
+}(core_1.BaseBackend));
+exports.MiniappBackend = MiniappBackend;
+//# sourceMappingURL=backend.js.map

package/dist/backend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"backend.js","sourceRoot":"","sources":["../src/backend.ts"],"names":[],"mappings":";;;AAAA,qCAA2C;AAC3C,uCAA+E;AAC/E,uCAA2E;AAE3E,+CAAwE;AACxE,4CAAkD;AAuBlD;;;GAGG;AACH;IAAoC,0CAA2B;IAA/D;;IAsDA,CAAC;IArDC;;OAEG;IACO,wCAAe,GAAzB;QACE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YACtB,6DAA6D;YAC7D,OAAO,iBAAM,eAAe,WAAE,CAAC;SAChC;QAED,IAAM,gBAAgB,yCACjB,IAAI,CAAC,QAAQ,CAAC,gBAAgB,KACjC,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,GACvB,CAAC;QAEF,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YAC3B,OAAO,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;SACtD;QAED,OAAO,IAAI,oBAAY,CAAC,gBAAgB,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,2CAAkB,GAAzB,UAA0B,SAAc,EAAE,IAAgB;QACxD,IAAM,kBAAkB,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,SAAS,CAAC;QAC1E,IAAM,KAAK,GAAG,oCAAqB,CAAC,SAAS,EAAE,kBAAkB,EAAE;YACjE,gBAAgB,EAAE,IAAI,CAAC,QAAQ,CAAC,gBAAgB;SACjD,CAAC,CAAC;QACH,6BAAqB,CAAC,KAAK,EAAE;YAC3B,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;SAChB,CAAC,CAAC;QACH,KAAK,CAAC,KAAK,GAAG,gBAAQ,CAAC,KAAK,CAAC;QAC7B,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAE;YACzB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SAChC;QACD,OAAO,2BAAmB,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IACD;;OAEG;IACI,yCAAgB,GAAvB,UAAwB,OAAe,EAAE,KAA+B,EAAE,IAAgB;QAAjD,sBAAA,EAAA,QAAkB,gBAAQ,CAAC,IAAI;QACtE,IAAM,kBAAkB,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,kBAAkB,CAAC,IAAI,SAAS,CAAC;QAC1E,IAAM,KAAK,GAAG,8BAAe,CAAC,OAAO,EAAE,kBAAkB,EAAE;YACzD,gBAAgB,EAAE,IAAI,CAAC,QAAQ,CAAC,gBAAgB;SACjD,CAAC,CAAC;QACH,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACpB,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,EAAE;YACzB,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SAChC;QACD,OAAO,2BAAmB,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC;IACH,qBAAC;AAAD,CAAC,AAtDD,CAAoC,kBAAW,GAsD9C;AAtDY,wCAAc","sourcesContent":["import { BaseBackend } from \"@sentry/core\";\nimport { Event, EventHint, Options, Severity, Transport } from \"@sentry/types\";\nimport { addExceptionMechanism, resolvedSyncPromise } from '@sentry/utils';\n\nimport { eventFromString, eventFromUnknownInput } from './eventbuilder';\nimport { XHRTransport } from \"./transports/index\";\n\n/**\n * Configuration options for the Sentry Miniapp SDK.\n * Sentry Miniapp SDK 的配置选项。\n * @see MiniappClient for more information.\n */\nexport interface MiniappOptions extends Options {\n  /**\n   * A pattern for error URLs which should not be sent to Sentry.\n   * To whitelist certain errors instead, use {@link Options.whitelistUrls}.\n   * By default, all errors will be sent.\n   */\n  blacklistUrls?: Array<string | RegExp>;\n\n  /**\n   * A pattern for error URLs which should exclusively be sent to Sentry.\n   * This is the opposite of {@link Options.blacklistUrls}.\n   * By default, all errors will be sent.\n   */\n  whitelistUrls?: Array<string | RegExp>;\n}\n\n/**\n * The Sentry Browser SDK Backend.\n * @hidden\n */\nexport class MiniappBackend extends BaseBackend<MiniappOptions> {\n  /**\n   * @inheritDoc\n   */\n  protected _setupTransport(): Transport {\n    if (!this._options.dsn) {\n      // We return the noop transport here in case there is no Dsn.\n      return super._setupTransport();\n    }\n\n    const transportOptions = {\n      ...this._options.transportOptions,\n      dsn: this._options.dsn\n    };\n\n    if (this._options.transport) {\n      return new this._options.transport(transportOptions);\n    }\n\n    return new XHRTransport(transportOptions);\n  }\n\n  /**\n   * @inheritDoc\n   */\n  public eventFromException(exception: any, hint?: EventHint): PromiseLike<Event> {\n    const syntheticException = (hint && hint.syntheticException) || undefined;\n    const event = eventFromUnknownInput(exception, syntheticException, {\n      attachStacktrace: this._options.attachStacktrace,\n    });\n    addExceptionMechanism(event, {\n      handled: true,\n      type: 'generic',\n    });\n    event.level = Severity.Error;\n    if (hint && hint.event_id) {\n      event.event_id = hint.event_id;\n    }\n    return resolvedSyncPromise(event);\n  }\n  /**\n   * @inheritDoc\n   */\n  public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {\n    const syntheticException = (hint && hint.syntheticException) || undefined;\n    const event = eventFromString(message, syntheticException, {\n      attachStacktrace: this._options.attachStacktrace,\n    });\n    event.level = level;\n    if (hint && hint.event_id) {\n      event.event_id = hint.event_id;\n    }\n    return resolvedSyncPromise(event);\n  }\n}\n"]}

package/dist/client.d.ts

@@ -0,0 +1,55 @@
+import { BaseClient, Scope } from "@sentry/core";
+import { DsnLike, Event, EventHint } from "@sentry/types";
+import { MiniappBackend, MiniappOptions } from "./backend";
+/**
+ * All properties the report dialog supports
+ */
+export interface ReportDialogOptions {
+    [key: string]: any;
+    eventId?: string;
+    dsn?: DsnLike;
+    user?: {
+        email?: string;
+        name?: string;
+    };
+    lang?: string;
+    title?: string;
+    subtitle?: string;
+    subtitle2?: string;
+    labelName?: string;
+    labelEmail?: string;
+    labelComments?: string;
+    labelClose?: string;
+    labelSubmit?: string;
+    errorGeneric?: string;
+    errorFormEntry?: string;
+    successMessage?: string;
+    /** Callback after reportDialog showed up */
+    onLoad?(): void;
+}
+/**
+ * The Sentry Miniapp SDK Client.
+ *
+ * @see MiniappOptions for documentation on configuration options.
+ * @see SentryClient for usage documentation.
+ */
+export declare class MiniappClient extends BaseClient<MiniappBackend, MiniappOptions> {
+    /**
+     * Creates a new Miniapp SDK instance.
+     *
+     * @param options Configuration options for this SDK.
+     */
+    constructor(options?: MiniappOptions);
+    /**
+     * @inheritDoc
+     */
+    protected _prepareEvent(event: Event, scope?: Scope, hint?: EventHint): PromiseLike<Event | null>;
+    /**
+     * Show a report dialog to the user to send feedback to a specific event.
+     * 向用户显示报告对话框以将反馈发送到特定事件。---> 小程序上暂时用不到&不考虑。
+     *
+     * @param options Set individual options for the dialog
+     */
+    showReportDialog(options?: ReportDialogOptions): void;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1D,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAG3D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,IAAI,CAAC,EAAE;QACL,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4CAA4C;IAC5C,MAAM,CAAC,IAAI,IAAI,CAAC;CACjB;AAED;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,UAAU,CAAC,cAAc,EAAE,cAAc,CAAC;IAC3E;;;;OAIG;gBACgB,OAAO,GAAE,cAAmB;IAI/C;;OAEG;IACH,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC,KAAK,GAAG,IAAI,CAAC;IAkBjG;;;;;OAKG;IACI,gBAAgB,CAAC,OAAO,GAAE,mBAAwB,GAAG,IAAI;CAIjE"}

package/dist/client.js

@@ -0,0 +1,51 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiniappClient = void 0;
+var tslib_1 = require("tslib");
+var core_1 = require("@sentry/core");
+var backend_1 = require("./backend");
+var version_1 = require("./version");
+/**
+ * The Sentry Miniapp SDK Client.
+ *
+ * @see MiniappOptions for documentation on configuration options.
+ * @see SentryClient for usage documentation.
+ */
+var MiniappClient = /** @class */ (function (_super) {
+    tslib_1.__extends(MiniappClient, _super);
+    /**
+     * Creates a new Miniapp SDK instance.
+     *
+     * @param options Configuration options for this SDK.
+     */
+    function MiniappClient(options) {
+        if (options === void 0) { options = {}; }
+        return _super.call(this, backend_1.MiniappBackend, options) || this;
+    }
+    /**
+     * @inheritDoc
+     */
+    MiniappClient.prototype._prepareEvent = function (event, scope, hint) {
+        event.platform = event.platform || "javascript";
+        event.sdk = tslib_1.__assign(tslib_1.__assign({}, event.sdk), { name: version_1.SDK_NAME, packages: tslib_1.__spread(((event.sdk && event.sdk.packages) || []), [
+                {
+                    name: "npm:@sentry/miniapp",
+                    version: version_1.SDK_VERSION
+                }
+            ]), version: version_1.SDK_VERSION });
+        return _super.prototype._prepareEvent.call(this, event, scope, hint);
+    };
+    /**
+     * Show a report dialog to the user to send feedback to a specific event.
+     * 向用户显示报告对话框以将反馈发送到特定事件。---> 小程序上暂时用不到&不考虑。
+     *
+     * @param options Set individual options for the dialog
+     */
+    MiniappClient.prototype.showReportDialog = function (options) {
+        if (options === void 0) { options = {}; }
+        // doesn't work without a document (React Native)
+        console.log('sentry-miniapp 暂未实现该方法', options);
+    };
+    return MiniappClient;
+}(core_1.BaseClient));
+exports.MiniappClient = MiniappClient;
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,qCAAiD;AAGjD,qCAA2D;AAC3D,qCAAkD;AA6BlD;;;;;GAKG;AACH;IAAmC,yCAA0C;IAC3E;;;;OAIG;IACH,uBAAmB,OAA4B;QAA5B,wBAAA,EAAA,YAA4B;eAC7C,kBAAM,wBAAc,EAAE,OAAO,CAAC;IAChC,CAAC;IAED;;OAEG;IACO,qCAAa,GAAvB,UAAwB,KAAY,EAAE,KAAa,EAAE,IAAgB;QACnE,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,YAAY,CAAC;QAChD,KAAK,CAAC,GAAG,yCACJ,KAAK,CAAC,GAAG,KACZ,IAAI,EAAE,kBAAQ,EACd,QAAQ,mBACH,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBAC5C;oBACE,IAAI,EAAE,qBAAqB;oBAC3B,OAAO,EAAE,qBAAW;iBACrB;gBAEH,OAAO,EAAE,qBAAW,GACrB,CAAC;QAEF,OAAO,iBAAM,aAAa,YAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,wCAAgB,GAAvB,UAAwB,OAAiC;QAAjC,wBAAA,EAAA,YAAiC;QACvD,iDAAiD;QACjD,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACH,oBAAC;AAAD,CAAC,AAzCD,CAAmC,iBAAU,GAyC5C;AAzCY,sCAAa","sourcesContent":["import { BaseClient, Scope } from \"@sentry/core\";\nimport { DsnLike, Event, EventHint } from \"@sentry/types\";\n\nimport { MiniappBackend, MiniappOptions } from \"./backend\";\nimport { SDK_NAME, SDK_VERSION } from \"./version\";\n\n/**\n * All properties the report dialog supports\n */\nexport interface ReportDialogOptions {\n  [key: string]: any;\n  eventId?: string;\n  dsn?: DsnLike;\n  user?: {\n    email?: string;\n    name?: string;\n  };\n  lang?: string;\n  title?: string;\n  subtitle?: string;\n  subtitle2?: string;\n  labelName?: string;\n  labelEmail?: string;\n  labelComments?: string;\n  labelClose?: string;\n  labelSubmit?: string;\n  errorGeneric?: string;\n  errorFormEntry?: string;\n  successMessage?: string;\n  /** Callback after reportDialog showed up */\n  onLoad?(): void;\n}\n\n/**\n * The Sentry Miniapp SDK Client.\n *\n * @see MiniappOptions for documentation on configuration options.\n * @see SentryClient for usage documentation.\n */\nexport class MiniappClient extends BaseClient<MiniappBackend, MiniappOptions> {\n  /**\n   * Creates a new Miniapp SDK instance.\n   *\n   * @param options Configuration options for this SDK.\n   */\n  public constructor(options: MiniappOptions = {}) {\n    super(MiniappBackend, options);\n  }\n\n  /**\n   * @inheritDoc\n   */\n  protected _prepareEvent(event: Event, scope?: Scope, hint?: EventHint): PromiseLike<Event | null> {\n    event.platform = event.platform || \"javascript\";\n    event.sdk = {\n      ...event.sdk,\n      name: SDK_NAME,\n      packages: [\n        ...((event.sdk && event.sdk.packages) || []),\n        {\n          name: \"npm:@sentry/miniapp\",\n          version: SDK_VERSION\n        }\n      ],\n      version: SDK_VERSION\n    };\n\n    return super._prepareEvent(event, scope, hint);\n  }\n\n  /**\n   * Show a report dialog to the user to send feedback to a specific event.\n   * 向用户显示报告对话框以将反馈发送到特定事件。---> 小程序上暂时用不到&不考虑。\n   *\n   * @param options Set individual options for the dialog\n   */\n  public showReportDialog(options: ReportDialogOptions = {}): void {\n    // doesn't work without a document (React Native)\n    console.log('sentry-miniapp 暂未实现该方法', options);\n  }\n}\n"]}

package/dist/crossPlatform.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 小程序平台 SDK 接口
+ */
+interface SDK {
+    request: Function;
+    httpRequest?: Function;
+    getSystemInfoSync: Function;
+    onError?: Function;
+    onUnhandledRejection?: Function;
+    onPageNotFound?: Function;
+    onMemoryWarning?: Function;
+    getLaunchOptionsSync?: Function;
+}
+/**
+ * 小程序平台 接口
+ */
+declare type AppName = "uniapp" | "wechat" | "alipay" | "bytedance" | "dingtalk" | "qq" | "swan" | "unknown";
+declare const sdk: SDK;
+declare const appName: AppName;
+export { sdk, appName };
+//# sourceMappingURL=crossPlatform.d.ts.map

package/dist/crossPlatform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crossPlatform.d.ts","sourceRoot":"","sources":["../src/crossPlatform.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,UAAU,GAAG;IACX,OAAO,EAAE,QAAQ,CAAC;IAClB,WAAW,CAAC,EAAE,QAAQ,CAAC;IACvB,iBAAiB,EAAE,QAAQ,CAAC;IAC5B,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,oBAAoB,CAAC,EAAE,QAAQ,CAAC;IAChC,cAAc,CAAC,EAAE,QAAQ,CAAC;IAC1B,eAAe,CAAC,EAAE,QAAQ,CAAC;IAC3B,oBAAoB,CAAC,EAAE,QAAQ,CAAC;CACjC;AAED;;GAEG;AACH,aAAK,OAAO,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,UAAU,GACV,IAAI,GACJ,MAAM,GACN,SAAS,CAAC;AAmEd,QAAA,MAAM,GAAG,KAAW,CAAC;AACrB,QAAA,MAAM,OAAO,SAAe,CAAC;AAE7B,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC"}

package/dist/crossPlatform.js

@@ -0,0 +1,79 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.appName = exports.sdk = void 0;
+/**
+ * 获取跨平台的 SDK
+ */
+var getSDK = function () {
+    var currentSdk = {
+        // tslint:disable-next-line: no-empty
+        request: function () { },
+        // tslint:disable-next-line: no-empty
+        httpRequest: function () { },
+        // tslint:disable-next-line: no-empty
+        getSystemInfoSync: function () { },
+    };
+    if (typeof uni === "object") {
+        currentSdk = uni;
+    }
+    else if (typeof wx === "object") {
+        // tslint:disable-next-line: no-unsafe-any
+        currentSdk = uni;
+    }
+    else if (typeof my === "object") {
+        // tslint:disable-next-line: no-unsafe-any
+        currentSdk = my;
+    }
+    else if (typeof tt === "object") {
+        // tslint:disable-next-line: no-unsafe-any
+        currentSdk = tt;
+    }
+    else if (typeof dd === "object") {
+        // tslint:disable-next-line: no-unsafe-any
+        currentSdk = dd;
+    }
+    else if (typeof qq === "object") {
+        // tslint:disable-next-line: no-unsafe-any
+        currentSdk = qq;
+    }
+    else if (typeof swan === "object") {
+        // tslint:disable-next-line: no-unsafe-any
+        currentSdk = swan;
+    }
+    else {
+        throw new Error("sentry-miniapp 暂不支持此平台");
+    }
+    return currentSdk;
+};
+/**
+ * 获取平台名称
+ */
+var getAppName = function () {
+    var currentAppName = "unknown";
+    if (typeof uni === "object") {
+        currentAppName = "uniapp";
+    }
+    else if (typeof wx === "object") {
+        currentAppName = "wechat";
+    }
+    else if (typeof my === "object") {
+        currentAppName = "alipay";
+    }
+    else if (typeof tt === "object") {
+        currentAppName = "bytedance";
+    }
+    else if (typeof dd === "object") {
+        currentAppName = "dingtalk";
+    }
+    else if (typeof qq === "object") {
+        currentAppName = "qq";
+    }
+    else if (typeof swan === "object") {
+        currentAppName = "swan";
+    }
+    return currentAppName;
+};
+var sdk = getSDK();
+exports.sdk = sdk;
+var appName = getAppName();
+exports.appName = appName;
+//# sourceMappingURL=crossPlatform.js.map

package/dist/crossPlatform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crossPlatform.js","sourceRoot":"","sources":["../src/crossPlatform.ts"],"names":[],"mappings":";;AAmCA;;GAEG;AACH,IAAM,MAAM,GAAG;IACb,IAAI,UAAU,GAAQ;QACpB,qCAAqC;QACrC,OAAO,EAAE,cAAO,CAAC;QACjB,qCAAqC;QACrC,WAAW,EAAE,cAAO,CAAC;QACrB,qCAAqC;QACrC,iBAAiB,EAAE,cAAO,CAAC;KAC5B,CAAC;IAEF,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,UAAU,GAAG,GAAG,CAAC;KAClB;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,0CAA0C;QAC1C,UAAU,GAAG,GAAG,CAAC;KAClB;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,0CAA0C;QAC1C,UAAU,GAAG,EAAE,CAAC;KACjB;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,0CAA0C;QAC1C,UAAU,GAAG,EAAE,CAAC;KACjB;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,0CAA0C;QAC1C,UAAU,GAAG,EAAE,CAAC;KACjB;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,0CAA0C;QAC1C,UAAU,GAAG,EAAE,CAAC;KACjB;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACnC,0CAA0C;QAC1C,UAAU,GAAG,IAAI,CAAC;KACnB;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;KAC3C;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF;;GAEG;AACH,IAAM,UAAU,GAAG;IACjB,IAAI,cAAc,GAAY,SAAS,CAAC;IAExC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,cAAc,GAAG,QAAQ,CAAC;KAC3B;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,cAAc,GAAG,QAAQ,CAAC;KAC3B;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,cAAc,GAAG,QAAQ,CAAC;KAC3B;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,cAAc,GAAG,WAAW,CAAC;KAC9B;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,cAAc,GAAG,UAAU,CAAC;KAC7B;SAAM,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;QACjC,cAAc,GAAG,IAAI,CAAC;KACvB;SAAM,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACnC,cAAc,GAAG,MAAM,CAAC;KACzB;IAED,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF,IAAM,GAAG,GAAG,MAAM,EAAE,CAAC;AAGZ,kBAAG;AAFZ,IAAM,OAAO,GAAG,UAAU,EAAE,CAAC;AAEf,0BAAO","sourcesContent":["declare const uni: any;  // uniapp\ndeclare const wx: any;   // 微信小程序、微信小游戏\ndeclare const my: any;   // 支付宝小程序\ndeclare const tt: any;   // 字节跳动小程序\ndeclare const dd: any;   // 钉钉小程序\ndeclare const qq: any;   // QQ 小程序、QQ 小游戏\ndeclare const swan: any; // 百度小程序\n\n/**\n * 小程序平台 SDK 接口\n */\ninterface SDK {\n  request: Function;\n  httpRequest?: Function; // 针对钉钉小程序\n  getSystemInfoSync: Function;\n  onError?: Function;\n  onUnhandledRejection?: Function;\n  onPageNotFound?: Function;\n  onMemoryWarning?: Function;\n  getLaunchOptionsSync?: Function;\n}\n\n/**\n * 小程序平台 接口\n */\ntype AppName =\n  | \"uniapp\"\n  | \"wechat\"\n  | \"alipay\"\n  | \"bytedance\"\n  | \"dingtalk\"\n  | \"qq\"\n  | \"swan\"\n  | \"unknown\";\n\n/**\n * 获取跨平台的 SDK\n */\nconst getSDK = () => {\n  let currentSdk: SDK = {\n    // tslint:disable-next-line: no-empty\n    request: () => {},\n    // tslint:disable-next-line: no-empty\n    httpRequest: () => {},\n    // tslint:disable-next-line: no-empty\n    getSystemInfoSync: () => {},\n  };\n\n  if (typeof uni === \"object\") {\n    currentSdk = uni;\n  } else if (typeof wx === \"object\") {\n    // tslint:disable-next-line: no-unsafe-any\n    currentSdk = uni;\n  } else if (typeof my === \"object\") {\n    // tslint:disable-next-line: no-unsafe-any\n    currentSdk = my;\n  } else if (typeof tt === \"object\") {\n    // tslint:disable-next-line: no-unsafe-any\n    currentSdk = tt;\n  } else if (typeof dd === \"object\") {\n    // tslint:disable-next-line: no-unsafe-any\n    currentSdk = dd;\n  } else if (typeof qq === \"object\") {\n    // tslint:disable-next-line: no-unsafe-any\n    currentSdk = qq;\n  } else if (typeof swan === \"object\") {\n    // tslint:disable-next-line: no-unsafe-any\n    currentSdk = swan;\n  } else {\n    throw new Error(\"sentry-miniapp 暂不支持此平台\");\n  }\n\n  return currentSdk;\n};\n\n/**\n * 获取平台名称\n */\nconst getAppName = () => {\n  let currentAppName: AppName = \"unknown\";\n\n  if (typeof uni === \"object\") {\n    currentAppName = \"uniapp\";\n  } else if (typeof wx === \"object\") {\n    currentAppName = \"wechat\";\n  } else if (typeof my === \"object\") {\n    currentAppName = \"alipay\";\n  } else if (typeof tt === \"object\") {\n    currentAppName = \"bytedance\";\n  } else if (typeof dd === \"object\") {\n    currentAppName = \"dingtalk\";\n  } else if (typeof qq === \"object\") {\n    currentAppName = \"qq\";\n  } else if (typeof swan === \"object\") {\n    currentAppName = \"swan\";\n  }\n\n  return currentAppName;\n};\n\nconst sdk = getSDK();\nconst appName = getAppName();\n\nexport { sdk, appName };\n"]}

package/dist/eventbuilder.d.ts

@@ -0,0 +1,11 @@
+import { Event } from '@sentry/types';
+/** JSDoc */
+export declare function eventFromUnknownInput(exception: unknown, syntheticException?: Error, options?: {
+    rejection?: boolean;
+    attachStacktrace?: boolean;
+}): Event;
+/** JSDoc */
+export declare function eventFromString(input: string, syntheticException?: Error, options?: {
+    attachStacktrace?: boolean;
+}): Event;
+//# sourceMappingURL=eventbuilder.d.ts.map

package/dist/eventbuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventbuilder.d.ts","sourceRoot":"","sources":["../src/eventbuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAetC,YAAY;AACZ,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,OAAO,EAClB,kBAAkB,CAAC,EAAE,KAAK,EAC1B,OAAO,GAAE;IACP,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CACvB,GACL,KAAK,CAwDP;AAGD,YAAY;AACZ,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,kBAAkB,CAAC,EAAE,KAAK,EAC1B,OAAO,GAAE;IACP,gBAAgB,CAAC,EAAE,OAAO,CAAC;CACvB,GACL,KAAK,CAcP"}