@fz-firefly/taro 0.0.0-stage → 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,163 @@
+import { CaptureContext, FireflyClient, FireflyClient as FireflyClient$1, FireflyOptions, FireflyOptions as FireflyOptions$1, FireflyStorage, FireflyTransport, PlatformContext, ResolvedOptions, Tags } from "@fz-firefly/core";
+import { Platform } from "@fz-firefly/shared";
+/**
+ * Taro 的 @tarojs/taro 由宿主项目提供，这里只声明 SDK 真正用到的 API，
+ * 避免把整套 Taro 类型带进包依赖。
+ */
+interface TaroSystemInfo {
+  platform?: string;
+  system?: string;
+  model?: string;
+  brand?: string;
+  windowWidth?: number;
+  windowHeight?: number;
+  pixelRatio?: number;
+  language?: string;
+  networkType?: string;
+  appVersion?: string;
+  SDKVersion?: string;
+  carrier?: string;
+  operator?: string;
+}
+/** Taro.request 的响应。 */
+interface TaroRequestResult {
+  statusCode?: number;
+  data?: unknown;
+  errMsg?: string;
+  header?: Record<string, string>;
+}
+/** Taro.request 的入参。 */
+interface TaroRequestOptions {
+  url: string;
+  method?: string;
+  header?: Record<string, string>;
+  data?: unknown;
+  dataType?: string;
+  success?: (result: TaroRequestResult) => void;
+  fail?: (error: {
+    errMsg?: string;
+  }) => void;
+  complete?: (...args: unknown[]) => void;
+}
+/** Taro.addInterceptor 提供的请求链。 */
+interface TaroRequestChain {
+  requestParams: TaroRequestOptions;
+  proceed(requestParams?: TaroRequestOptions): Promise<TaroRequestResult>;
+}
+/** Taro.addInterceptor 的请求拦截器。 */
+type TaroRequestInterceptor = (chain: TaroRequestChain) => unknown;
+/** Taro.getCurrentPages() 返回的页面。 */
+interface TaroPage {
+  route?: string;
+  options?: Record<string, unknown>;
+  $taroPath?: string;
+}
+/** Taro 导航 API 的参数。 */
+interface TaroNavigationOptions {
+  url?: string;
+  delta?: number;
+  success?: (...args: unknown[]) => void;
+  fail?: (...args: unknown[]) => void;
+  complete?: (...args: unknown[]) => void;
+}
+/** SDK 会包装的导航 API。 */
+type TaroNavigationApi = 'navigateTo' | 'redirectTo' | 'switchTab' | 'reLaunch' | 'navigateBack';
+/**
+ * SDK 真正用到的 Taro API 子集。
+ *
+ * 不直接依赖 @tarojs/taro 的类型，方便在 Node 测试环境里用最小 mock 验证。
+ */
+interface TaroRuntime {
+  getEnv?(): string;
+  getSystemInfoSync?(): TaroSystemInfo;
+  getStorageSync?(key: string): unknown;
+  setStorageSync?(key: string, value: string): void;
+  removeStorageSync?(key: string): void;
+  request?(options: TaroRequestOptions): unknown;
+  addInterceptor?(interceptor: TaroRequestInterceptor): void;
+  onError?(handler: (error: unknown) => void): void;
+  offError?(handler: (error: unknown) => void): void;
+  onUnhandledRejection?(handler: (event: {
+    reason?: unknown;
+  }) => void): void;
+  offUnhandledRejection?(handler: (event: {
+    reason?: unknown;
+  }) => void): void;
+  onAppShow?(handler: () => void): void;
+  offAppShow?(handler: () => void): void;
+  onAppHide?(handler: () => void): void;
+  offAppHide?(handler: () => void): void;
+  onNetworkStatusChange?(handler: (event: {
+    isConnected?: boolean;
+    networkType?: string;
+  }) => void): void;
+  offNetworkStatusChange?(handler: (event: {
+    isConnected?: boolean;
+    networkType?: string;
+  }) => void): void;
+  navigateTo?(options: TaroNavigationOptions): unknown;
+  redirectTo?(options: TaroNavigationOptions): unknown;
+  switchTab?(options: TaroNavigationOptions): unknown;
+  reLaunch?(options: TaroNavigationOptions): unknown;
+  navigateBack?(options?: TaroNavigationOptions): unknown;
+  getCurrentPages?(): TaroPage[];
+}
+/** 读取 Taro 运行时；不在 Taro 环境时返回 null。 */
+export declare function getTaro(): TaroRuntime | null;
+/** 安全读取系统信息，失败时返回 null。 */
+export declare function readSystemInfo(runtime?: TaroRuntime | null): TaroSystemInfo | null;
+/** 读取当前页面；非 Taro 环境返回 null。 */
+export declare function readCurrentPage(runtime?: TaroRuntime | null): TaroPage | null;
+/** 平台识别结果。 */
+interface PlatformInfo {
+  /** 协议里的运行时平台。 */
+  platform: Platform;
+  /** 分发标识，例如 h5 / mp-weixin / rn。 */
+  dist: string;
+}
+/**
+ * 识别当前 Taro 运行平台。
+ *
+ * 优先使用 Taro.getEnv()（WEAPP / WEB / ALIPAY / RN...），
+ * 拿不到时按是否存在 window 粗略判断。协议只接受 web / mp-weixin /
+ * mp-alipay / app，其他小程序统一归为 app，并在 dist 里保留真实平台。
+ */
+export declare function detectPlatform(runtime?: TaroRuntime | null): PlatformInfo;
+/**
+ * Taro 初始化参数。
+ *
+ * 与 core 的 FireflyOptions 一致，额外提供 H5 / 小程序可用的采集开关。
+ */
+interface InitOptions extends FireflyOptions$1 {
+  /** 可选：注入应用实际使用的 Taro 运行时。 */
+  runtime?: TaroRuntime | null;
+  /** 是否记录 H5 点击面包屑，默认 true；小程序无 DOM 时自动跳过。 */
+  captureClicks?: boolean;
+  /** 是否记录 console.error / console.warn，默认 true。 */
+  captureConsole?: boolean;
+  /** 是否记录页面可见性/网络状态/小程序前后台，默认 true。 */
+  captureLifecycle?: boolean;
+  /** 是否记录 H5 资源加载失败，默认 true；小程序自动跳过。 */
+  captureResourceErrors?: boolean;
+}
+/** initFirefly 的返回值。 */
+interface FireflyHandle {
+  /** 客户端实例，可用于手动 captureException / track / setUser。 */
+  client: FireflyClient$1;
+  /** 移除 Taro 钩子并停止定时器。 */
+  dispose(): void;
+}
+/**
+ * Taro 平台入口。
+ *
+ * 一行接入：
+ * ```ts
+ * const handle = initFirefly({ dsn, endpoint, environment, release })
+ * ```
+ *
+ * 这个入口只负责 Taro 平台能力；React / Vue 的组件错误处理
+ * 分别从 `@fz-firefly/taro/react` 和 `@fz-firefly/taro/vue` 引入。
+ */
+export declare function initFirefly(options: InitOptions): FireflyHandle;
+export type { CaptureContext, FireflyClient, FireflyHandle, FireflyOptions, FireflyStorage, FireflyTransport, InitOptions, PlatformContext, PlatformInfo, ResolvedOptions, Tags, TaroNavigationApi, TaroNavigationOptions, TaroPage, TaroRequestChain, TaroRequestInterceptor, TaroRequestOptions, TaroRequestResult, TaroRuntime, TaroSystemInfo };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,163 @@
+import { CaptureContext, FireflyClient, FireflyClient as FireflyClient$1, FireflyOptions, FireflyOptions as FireflyOptions$1, FireflyStorage, FireflyTransport, PlatformContext, ResolvedOptions, Tags } from "@fz-firefly/core";
+import { Platform } from "@fz-firefly/shared";
+/**
+ * Taro 的 @tarojs/taro 由宿主项目提供，这里只声明 SDK 真正用到的 API，
+ * 避免把整套 Taro 类型带进包依赖。
+ */
+interface TaroSystemInfo {
+  platform?: string;
+  system?: string;
+  model?: string;
+  brand?: string;
+  windowWidth?: number;
+  windowHeight?: number;
+  pixelRatio?: number;
+  language?: string;
+  networkType?: string;
+  appVersion?: string;
+  SDKVersion?: string;
+  carrier?: string;
+  operator?: string;
+}
+/** Taro.request 的响应。 */
+interface TaroRequestResult {
+  statusCode?: number;
+  data?: unknown;
+  errMsg?: string;
+  header?: Record<string, string>;
+}
+/** Taro.request 的入参。 */
+interface TaroRequestOptions {
+  url: string;
+  method?: string;
+  header?: Record<string, string>;
+  data?: unknown;
+  dataType?: string;
+  success?: (result: TaroRequestResult) => void;
+  fail?: (error: {
+    errMsg?: string;
+  }) => void;
+  complete?: (...args: unknown[]) => void;
+}
+/** Taro.addInterceptor 提供的请求链。 */
+interface TaroRequestChain {
+  requestParams: TaroRequestOptions;
+  proceed(requestParams?: TaroRequestOptions): Promise<TaroRequestResult>;
+}
+/** Taro.addInterceptor 的请求拦截器。 */
+type TaroRequestInterceptor = (chain: TaroRequestChain) => unknown;
+/** Taro.getCurrentPages() 返回的页面。 */
+interface TaroPage {
+  route?: string;
+  options?: Record<string, unknown>;
+  $taroPath?: string;
+}
+/** Taro 导航 API 的参数。 */
+interface TaroNavigationOptions {
+  url?: string;
+  delta?: number;
+  success?: (...args: unknown[]) => void;
+  fail?: (...args: unknown[]) => void;
+  complete?: (...args: unknown[]) => void;
+}
+/** SDK 会包装的导航 API。 */
+type TaroNavigationApi = 'navigateTo' | 'redirectTo' | 'switchTab' | 'reLaunch' | 'navigateBack';
+/**
+ * SDK 真正用到的 Taro API 子集。
+ *
+ * 不直接依赖 @tarojs/taro 的类型，方便在 Node 测试环境里用最小 mock 验证。
+ */
+interface TaroRuntime {
+  getEnv?(): string;
+  getSystemInfoSync?(): TaroSystemInfo;
+  getStorageSync?(key: string): unknown;
+  setStorageSync?(key: string, value: string): void;
+  removeStorageSync?(key: string): void;
+  request?(options: TaroRequestOptions): unknown;
+  addInterceptor?(interceptor: TaroRequestInterceptor): void;
+  onError?(handler: (error: unknown) => void): void;
+  offError?(handler: (error: unknown) => void): void;
+  onUnhandledRejection?(handler: (event: {
+    reason?: unknown;
+  }) => void): void;
+  offUnhandledRejection?(handler: (event: {
+    reason?: unknown;
+  }) => void): void;
+  onAppShow?(handler: () => void): void;
+  offAppShow?(handler: () => void): void;
+  onAppHide?(handler: () => void): void;
+  offAppHide?(handler: () => void): void;
+  onNetworkStatusChange?(handler: (event: {
+    isConnected?: boolean;
+    networkType?: string;
+  }) => void): void;
+  offNetworkStatusChange?(handler: (event: {
+    isConnected?: boolean;
+    networkType?: string;
+  }) => void): void;
+  navigateTo?(options: TaroNavigationOptions): unknown;
+  redirectTo?(options: TaroNavigationOptions): unknown;
+  switchTab?(options: TaroNavigationOptions): unknown;
+  reLaunch?(options: TaroNavigationOptions): unknown;
+  navigateBack?(options?: TaroNavigationOptions): unknown;
+  getCurrentPages?(): TaroPage[];
+}
+/** 读取 Taro 运行时；不在 Taro 环境时返回 null。 */
+export declare function getTaro(): TaroRuntime | null;
+/** 安全读取系统信息，失败时返回 null。 */
+export declare function readSystemInfo(runtime?: TaroRuntime | null): TaroSystemInfo | null;
+/** 读取当前页面；非 Taro 环境返回 null。 */
+export declare function readCurrentPage(runtime?: TaroRuntime | null): TaroPage | null;
+/** 平台识别结果。 */
+interface PlatformInfo {
+  /** 协议里的运行时平台。 */
+  platform: Platform;
+  /** 分发标识，例如 h5 / mp-weixin / rn。 */
+  dist: string;
+}
+/**
+ * 识别当前 Taro 运行平台。
+ *
+ * 优先使用 Taro.getEnv()（WEAPP / WEB / ALIPAY / RN...），
+ * 拿不到时按是否存在 window 粗略判断。协议只接受 web / mp-weixin /
+ * mp-alipay / app，其他小程序统一归为 app，并在 dist 里保留真实平台。
+ */
+export declare function detectPlatform(runtime?: TaroRuntime | null): PlatformInfo;
+/**
+ * Taro 初始化参数。
+ *
+ * 与 core 的 FireflyOptions 一致，额外提供 H5 / 小程序可用的采集开关。
+ */
+interface InitOptions extends FireflyOptions$1 {
+  /** 可选：注入应用实际使用的 Taro 运行时。 */
+  runtime?: TaroRuntime | null;
+  /** 是否记录 H5 点击面包屑，默认 true；小程序无 DOM 时自动跳过。 */
+  captureClicks?: boolean;
+  /** 是否记录 console.error / console.warn，默认 true。 */
+  captureConsole?: boolean;
+  /** 是否记录页面可见性/网络状态/小程序前后台，默认 true。 */
+  captureLifecycle?: boolean;
+  /** 是否记录 H5 资源加载失败，默认 true；小程序自动跳过。 */
+  captureResourceErrors?: boolean;
+}
+/** initFirefly 的返回值。 */
+interface FireflyHandle {
+  /** 客户端实例，可用于手动 captureException / track / setUser。 */
+  client: FireflyClient$1;
+  /** 移除 Taro 钩子并停止定时器。 */
+  dispose(): void;
+}
+/**
+ * Taro 平台入口。
+ *
+ * 一行接入：
+ * ```ts
+ * const handle = initFirefly({ dsn, endpoint, environment, release })
+ * ```
+ *
+ * 这个入口只负责 Taro 平台能力；React / Vue 的组件错误处理
+ * 分别从 `@fz-firefly/taro/react` 和 `@fz-firefly/taro/vue` 引入。
+ */
+export declare function initFirefly(options: InitOptions): FireflyHandle;
+export type { CaptureContext, FireflyClient, FireflyHandle, FireflyOptions, FireflyStorage, FireflyTransport, InitOptions, PlatformContext, PlatformInfo, ResolvedOptions, Tags, TaroNavigationApi, TaroNavigationOptions, TaroPage, TaroRequestChain, TaroRequestInterceptor, TaroRequestOptions, TaroRequestResult, TaroRuntime, TaroSystemInfo };
+//# sourceMappingURL=index.d.ts.map