@fz-firefly/web 0.0.0-stage → 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,47 @@
+import { CaptureContext, FireflyClient, FireflyClient as FireflyClient$1, FireflyOptions, FireflyOptions as FireflyOptions$1, FireflyStorage, FireflyTransport, PlatformContext, ResolvedOptions, Tags } from "@fz-firefly/core";
+/**
+ * 浏览器端的初始化参数。
+ * 与 core 的 FireflyOptions 一致，dsn 与 endpoint 在浏览器场景下必填。
+ */
+interface InitOptions extends FireflyOptions$1 {
+  /** 项目公开写入凭证，从后台项目设置里获取。 */
+  dsn: string;
+  /** 服务端地址，例如 https://firefly.example.com。 */
+  endpoint: string;
+  /** 是否自动记录点击面包屑，默认 true。 */
+  captureClicks?: boolean;
+  /** 是否自动记录 console.error / console.warn，默认 true。 */
+  captureConsole?: boolean;
+  /** 是否记录页面可见性与网络状态变化，默认 true。 */
+  captureLifecycle?: boolean;
+  /** 是否记录资源加载失败，默认 true。 */
+  captureResourceErrors?: boolean;
+}
+/** initFirefly 的返回值。 */
+interface FireflyHandle {
+  /** 客户端实例，可用于手动 captureException / track / setUser。 */
+  client: FireflyClient$1;
+  /** 移除所有全局钩子并停止定时器。SPA 卸载或热更新时调用。 */
+  dispose(): void;
+}
+declare global {
+  interface Window {
+    /** 内联 SDK 或业务入口创建的全局实例。 */
+    __firefly__?: FireflyHandle;
+  }
+}
+/**
+ * 浏览器端入口。
+ *
+ * 一行接入：
+ * ```ts
+ * const handle = initFirefly({ dsn, endpoint, environment, release });
+ * ```
+ * 之后未捕获异常、未处理的 Promise 拒绝、资源加载失败会自动上报；
+ * 失败 HTTP 请求会单独上报，成功请求进入页面请求日志，慢请求额外
+ * 写 warning 面包屑；点击、路由、console、生命周期和失败请求会写入
+ * 面包屑时间线。
+ */
+export declare function initFirefly(options: InitOptions): FireflyHandle;
+export type { CaptureContext, FireflyClient, FireflyHandle, FireflyOptions, FireflyStorage, FireflyTransport, InitOptions, PlatformContext, ResolvedOptions, Tags };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,47 @@
+import { CaptureContext, FireflyClient, FireflyClient as FireflyClient$1, FireflyOptions, FireflyOptions as FireflyOptions$1, FireflyStorage, FireflyTransport, PlatformContext, ResolvedOptions, Tags } from "@fz-firefly/core";
+/**
+ * 浏览器端的初始化参数。
+ * 与 core 的 FireflyOptions 一致，dsn 与 endpoint 在浏览器场景下必填。
+ */
+interface InitOptions extends FireflyOptions$1 {
+  /** 项目公开写入凭证，从后台项目设置里获取。 */
+  dsn: string;
+  /** 服务端地址，例如 https://firefly.example.com。 */
+  endpoint: string;
+  /** 是否自动记录点击面包屑，默认 true。 */
+  captureClicks?: boolean;
+  /** 是否自动记录 console.error / console.warn，默认 true。 */
+  captureConsole?: boolean;
+  /** 是否记录页面可见性与网络状态变化，默认 true。 */
+  captureLifecycle?: boolean;
+  /** 是否记录资源加载失败，默认 true。 */
+  captureResourceErrors?: boolean;
+}
+/** initFirefly 的返回值。 */
+interface FireflyHandle {
+  /** 客户端实例，可用于手动 captureException / track / setUser。 */
+  client: FireflyClient$1;
+  /** 移除所有全局钩子并停止定时器。SPA 卸载或热更新时调用。 */
+  dispose(): void;
+}
+declare global {
+  interface Window {
+    /** 内联 SDK 或业务入口创建的全局实例。 */
+    __firefly__?: FireflyHandle;
+  }
+}
+/**
+ * 浏览器端入口。
+ *
+ * 一行接入：
+ * ```ts
+ * const handle = initFirefly({ dsn, endpoint, environment, release });
+ * ```
+ * 之后未捕获异常、未处理的 Promise 拒绝、资源加载失败会自动上报；
+ * 失败 HTTP 请求会单独上报，成功请求进入页面请求日志，慢请求额外
+ * 写 warning 面包屑；点击、路由、console、生命周期和失败请求会写入
+ * 面包屑时间线。
+ */
+export declare function initFirefly(options: InitOptions): FireflyHandle;
+export type { CaptureContext, FireflyClient, FireflyHandle, FireflyOptions, FireflyStorage, FireflyTransport, InitOptions, PlatformContext, ResolvedOptions, Tags };
+//# sourceMappingURL=index.d.ts.map