@flatbiz/device 2.0.3 → 2.0.5

package/README.md

@@ -1,103 +1,166 @@
-## @flatbiz/device
+# @flatbiz/device
 
-增强 H5 设备信息采集能力：`deviceInfo` 支持自定义/自动获取 IP、屏幕分辨率字符串，并合并 UA 解析结果；`deviceId` 通过 cookie + localStorage 持久化，并支持主域与子域共享。
+H5 设备信息 SDK，提供两个核心能力：
 
-### Breaking Changes
+| API | 作用 | 返回值 |
+| --- | --- | --- |
+| `deviceInfo` | 采集设备指纹与 UA 信息 | `Promise<FlatbizDevice>` |
+| `reportDeviceInfo` | 采集后上报业务接口 | `Promise<boolean>` |
 
-- **`deviceInfo` 改为异步 API**：由同步函数改为 `async`，返回 `Promise<FlatbizDevice>`，调用方需使用 `await deviceInfo()` 或 `.then()`
-- **移除 `utils` 模块**：`getDeviceId` 统一从 `helper-get-deviceId` 导出，不再通过 `src/utils.ts`
+> 仅支持浏览器环境。非浏览器调用时：`deviceInfo` 返回 `{}`，`reportDeviceInfo` 返回 `false`。
 
-### Features
+---
 
-- 新增 **`DeviceInfoOptions`** 可选参数：
-  - **`ip`**：传入服务端下发的 IP，优先于自动获取
-  - **`autoGetIp`**：为 `true` 时通过 `https://api.ipify.org?format=json` 拉取公网 IP（默认 `false`）
-  - **`isDebug`**：为 `true` 时在控制台输出非浏览器环境或解析失败等错误信息（默认 `false`）
-- 新增返回字段 **`ip`**、**`screenSize`**（格式 `{width}x{height}`，如 `390x844`）
-- 非浏览器环境（`typeof window === 'undefined'`）安全返回 `{}`，避免 SSR/Node 直接调用抛错
-- 新增 helpers：`getIp`、`getWindowSize`；`getDeviceId` 独立为 `helper-get-deviceId`
-- **`deviceId` 持久化**：基于 `js-cookie` 写入可跨子域共享的 cookie，并与 localStorage 双向同步
-- 开发体验：补充 Vitest 单元测试（含 jsdom 主域/子域 cookie 共享用例）；`yarn demo`（Vite）可本地预览 `public/index.html`
+## 安装
 
-### `deviceInfo()` 返回字段
+```bash
+yarn add @flatbiz/device
+# 或
+npm i @flatbiz/device
+```
 
-**H5 终端（`FlatbizDeviceInfo`）**
+---
 
-- `ip`、`deviceId`、`language`
-- `screenWidth`、`screenHeight`、`screenSize`、`screenDensity`
-- `networkType`、`timezone`、`timezoneOffset`、`systemDate`、`systemTime`
-- `colorDepth`、`touchSupport`、`plugins`、`pluginNum`、`cookiesEnable`
+## 1. `deviceInfo` — 采集设备信息
 
-**UA 解析（`FlatbizUaParserResult`）**
+异步采集 H5 终端信息与 UA 解析结果，并持久化 `deviceId`（Cookie + localStorage，支持主域/子域共享）。
 
-- `userAgent`、`browserName`、`browserVersion`
-- `engineName`、`engineVersion`
-- `osName`、`osVersion`、`cpuModel`
-- `deviceType`、`deviceVendor`、`deviceModel`
+### 快速接入
 
-### deviceId 与 Cookie
+```ts
+import { deviceInfo } from '@flatbiz/device';
 
-`deviceInfo()` 内部会调用 `getDeviceId()` 生成/读取设备 ID。存储与同步规则如下。
+// 最简用法
+const info = await deviceInfo();
 
-#### 存储键
+// 推荐：由服务端下发 IP
+const info2 = await deviceInfo({ ip: '203.0.113.1' });
 
-| 介质 | Key | 说明 |
-| --- | --- | --- |
-| Cookie | `flatbiz_device_ftbzdid` | 优先读取；用于跨子域共享 |
-| localStorage | `flatbiz_device_ftbzdid` | Cookie 缺失时的回退；Cookie 有值时会被覆盖 |
+// 自动拉取公网 IP
+const info3 = await deviceInfo({ autoGetIp: true });
 
-#### 读取优先级
+// 调试模式（失败时打印日志）
+const info4 = await deviceInfo({ isDebug: true });
 
-1. **Cookie 有值**：返回该 ID，并写入/覆盖 localStorage
-2. **Cookie 无、localStorage 有**：返回 localStorage 中的 ID，并回写 Cookie
-3. **都没有**：生成新 ID（16 位类 UUID），同时写入 Cookie 与 localStorage
+console.log(info.deviceId, info.screenSize, info.browserName);
+```
 
-#### Cookie 属性
+### 入参 `DeviceInfoOptions`
 
-通过 `js-cookie` 写入，默认属性：
+全部可选。
 
-| 属性 | 值 | 说明 |
-| --- | --- | --- |
-| `expires` | `1`（约 1 天） | 过期后续访问会重新走生成/回写逻辑 |
-| `path` | `/` | 整站路径可访问 |
-| `sameSite` | `Lax` | 常规同站导航可携带 |
-| `domain` | 见下 | 主域与子域共享 |
+| 参数 | 类型 | 默认值 | 说明 |
+| --- | --- | --- | --- |
+| `ip` | `string` | - | 自定义 IP，优先于自动获取（推荐服务端下发） |
+| `autoGetIp` | `boolean` | `false` | 为 `true` 时请求 `https://api.ipify.org?format=json` 获取公网 IP |
+| `isDebug` | `boolean` | `false` | 为 `true` 时在控制台输出错误信息 |
 
-#### 跨子域共享（`domain`）
+### 出参 `FlatbizDevice`
 
-使用 [psl](https://www.npmjs.com/package/psl) 解析当前 `location.hostname` 的注册域，并设置为带前缀点的根域，例如：
+返回值为 `Partial<FlatbizDeviceInfo> & Partial<FlatbizUaParserResult>`。异常或非浏览器环境返回 `{}`。
 
-- `example.com` → `domain=.example.com`
-- `www.example.com` → `domain=.example.com`
-- `api.example.com` → `domain=.example.com`
+#### 终端字段（`FlatbizDeviceInfo`）
 
-因此在同一注册域下，主域与各子域可共享同一个 `deviceId`（localStorage 仍按源隔离，跨域依赖 Cookie）。
+| 字段 | 类型 | 说明 |
+| --- | --- | --- |
+| `ip` | `string` | IP 地址 |
+| `deviceId` | `string` | 设备 ID（持久化，见下文） |
+| `language` | `string` | 系统语言，如 `zh-CN` |
+| `screenWidth` | `number` | 屏幕宽度（px） |
+| `screenHeight` | `number` | 屏幕高度（px） |
+| `screenSize` | `string` | 分辨率，如 `390x844` |
+| `screenDensity` | `number` | 像素密度，如 `2` |
+| `networkType` | `string` | 网络类型，如 `wifi` / `4g` |
+| `timezone` | `string` | 时区，如 `Asia/Shanghai` |
+| `timezoneOffset` | `number` | 时区偏移（分钟） |
+| `systemDate` | `string` | 系统日期 |
+| `systemTime` | `string` | 系统时间 |
+| `colorDepth` | `number` | 颜色深度 |
+| `touchSupport` | `string[]` | 触摸支持信息 |
+| `plugins` | `string[]` | 浏览器插件列表 |
+| `pluginNum` | `number` | 插件数量 |
+| `cookiesEnable` | `boolean` | 是否启用 Cookie |
+| `eventId` | `string` | 事件 ID；仅 `reportDeviceInfo` 生成/重置并缓存，`deviceInfo` 读取当前值（未上报过时可能为空） |
+
+#### UA 字段（`FlatbizUaParserResult`）
+
+| 字段 | 类型 | 说明 |
+| --- | --- | --- |
+| `userAgent` | `string` | 完整 UA |
+| `browserName` | `string` | 浏览器名称 |
+| `browserVersion` | `string` | 浏览器版本 |
+| `engineName` | `string` | 内核名称 |
+| `engineVersion` | `string` | 内核版本 |
+| `osName` | `string` | 操作系统名称 |
+| `osVersion` | `string` | 操作系统版本 |
+| `cpuModel` | `string` | CPU 架构/型号 |
+| `deviceType` | `string` | UA 设备类型，如 `mobile` |
+| `deviceVendor` | `string` | 厂商 |
+| `deviceModel` | `string` | 型号 |
 
-以下场景**不设置** `domain`（仅当前 host 生效）：
+### `deviceId` 说明（简要）
 
-- `localhost`
-- IP 地址（如 `127.0.0.1`）
-- 无法解析出注册域的 hostname
+- **存储**：Cookie / localStorage，Key 均为 `flatbiz_device_ftbzdid`
+- **优先级**：Cookie > localStorage > 新生成（生成后同时写入两者）
+- **跨子域**：Cookie 设置 `domain=.注册域`（如 `.example.com`）；`localhost` / IP 不设 domain
+- **有效期**：Cookie 约 1 天；过期后若 localStorage 仍有值会回写，**ID 不变**
 
-#### 注意事项
+---
 
-- 浏览器禁用 Cookie 时，仍可能依赖 localStorage；返回字段 `cookiesEnable` 可反映 Cookie 是否启用
-- Cookie 约 24 小时过期后，若 localStorage 仍有值，会按优先级回写新 Cookie，**ID 保持不变**
+## 2. `reportDeviceInfo` — 上报设备信息
 
-### Usage
+内部先重置并缓存 `eventId`，再调用 `deviceInfo()`，按 `isProd` 选择上报地址 `POST`，将设备指纹（含 `eventId`）与业务埋点一并上报。
+
+### 快速接入
 
 ```ts
-import { deviceInfo } from '@flatbiz/device';
+import {
+  reportDeviceInfo,
+  ReportDeviceType,
+  ReportRegionType,
+  ReportUserSys,
+} from '@flatbiz/device';
+
+await reportDeviceInfo({
+  // 由业务侧注入
+  signature: '联系负责人获取',
+  pageName: 'publicCashier',
+  orderNum: 'O20260903001',
+  regionType: ReportRegionType.Overseas,
+  deviceType: ReportDeviceType.H5,
+  userId: 'u1',
+  userSys: ReportUserSys.HopeGoo,
+});
 
-// 自定义 IP（推荐由服务端下发）
-const info = await deviceInfo({ ip: '203.0.113.1' });
+```
 
-// 自动获取公网 IP
-const info2 = await deviceInfo({ autoGetIp: true });
+### 入参 `ReportDeviceInfoOptions`
 
-// 调试模式
-const info3 = await deviceInfo({ isDebug: true });
+| 参数 | 类型 | 必填 | 默认值 | 说明 |
+| --- | --- | --- | --- | --- |
+| `signature` | `string` | 是 | - | 鉴权签名，写入 `X-signature`；为空会 `console.error`（不会写入上报 body） |
+| `pageName` | `ReportPageName` | 是 | - | 采集页面，见枚举表 |
+| `orderNum` | `string` | 是 | - | 项目订单号；|
+| `regionType` | `ReportRegionType` | 是 | - | 区域类型，见枚举表 |
+| `deviceType` | `ReportDeviceType` | 是 | - | 业务侧设备类型，见枚举表 |
+| `userId` | `string` | 否 | - | 用户 ID |
+| `userSys` | `ReportUserSys` | 否 | - | 会员体系，见枚举表 |
+| `eventType` | `string` | 否 | `'pageLoad'` | `pageLoad` / `click` / 自定义 |
+| `isProd` | `boolean` | 否 | `true` | 是否生产环境；决定上报 URL |
+| `isDebug` | `boolean` | 否 | `false` | 失败时打印日志（不会写入上报 body） |
+
+#### 枚举
+
+| 枚举 | 成员 | 值 | 说明 |
+| --- | --- | --- | --- |
+| `ReportPageName` | `'detail'` / `'order'` / `'publicCashier'` / `'nativeCashier'` | 同左 | 详情 / 创单 / 公共收银台 / 原生收银台 |
+| `ReportUserSys` | `Tongcheng` / `HopeGoo` / `Tabigo` | `'01'` / `'02'` / `'03'` | 同程 / HopeGoo / Tabigo |
+| `ReportRegionType` | `Domestic` / `Overseas` | `'01'` / `'02'` | 国内 / 国外 |
+| `ReportDeviceType` | `PC` / `H5` / `HopeGooApp` / `TabigoApp` | `'1'` / `'3'` / `'4'` / `'5'` | PC / H5 / HopeGoo APP / Tabigo APP |
+
+### 出参
+
+| 类型 | 说明 |
+| --- | --- |
+| `Promise<boolean>` | `true` 上报成功；`false` 失败（网络/HTTP/业务 code/非浏览器等） |
 
-// deviceId 已持久化在 cookie / localStorage
-console.log(info.deviceId);
-```

package/dist/constant.d.ts

@@ -0,0 +1,15 @@
+/** 生产 / 非生产环境设备信息上报地址 */
+export declare const REPORT_DEVICE_INFO_URLS: {
+    readonly prod: "https://rcsapi.tcshuke.com/device/collect";
+    readonly test: "https://rcsapi.qa.tcshuke.com/device/collect";
+};
+/**
+ * 组装上报鉴权请求头
+ * @param signature 业务侧传入的签名，写入 `X-signature`（勿把密钥写进 npm 包）
+ */
+export declare const getAuthHeaders: (signature?: string) => Record<string, string>;
+/**
+ * 获取设备信息上报地址
+ * @param isProd 是否生产环境，默认 true
+ */
+export declare const getReportDeviceInfoUrl: (isProd?: boolean) => string;

package/dist/constant.js

@@ -0,0 +1,29 @@
+/** 生产 / 非生产环境设备信息上报地址 */
+export const REPORT_DEVICE_INFO_URLS = {
+    prod: 'https://rcsapi.tcshuke.com/device/collect',
+    test: 'https://rcsapi.qa.tcshuke.com/device/collect',
+};
+/**
+ * 组装上报鉴权请求头
+ * @param signature 业务侧传入的签名，写入 `X-signature`（勿把密钥写进 npm 包）
+ */
+export const getAuthHeaders = (signature) => {
+    const timestamp = Date.now().toString();
+    const requestId = Math.random().toString(36).substring(2, 15);
+    if (!signature) {
+        console.error('[@flatbiz/device] signature 不能为空，请通过 reportDeviceInfo({ signature }) 传入');
+    }
+    return {
+        'X-app-id': 'cashier',
+        'X-requestId': `${requestId}-${timestamp}`,
+        'X-timestamp': timestamp,
+        'X-signature': signature ?? '',
+    };
+};
+/**
+ * 获取设备信息上报地址
+ * @param isProd 是否生产环境，默认 true
+ */
+export const getReportDeviceInfoUrl = (isProd = true) => {
+    return isProd ? REPORT_DEVICE_INFO_URLS.prod : REPORT_DEVICE_INFO_URLS.test;
+};

package/dist/helpers/helper-event-id.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 读取当前 eventId（不会新建）
+ * 仅由 reportDeviceInfo 调用 resetEventId 时生成/重置
+ */
+export declare const getEventId: () => string | undefined;
+/**
+ * 生成并缓存新的 eventId（仅应在 reportDeviceInfo 中调用）
+ */
+export declare const resetEventId: () => string;
+/** 测试或内部清理用 */
+export declare const clearEventId: () => void;

package/dist/helpers/helper-event-id.js

@@ -0,0 +1,64 @@
+const STORAGE_KEY = 'flatbiz_device_eventId';
+let memoryEventId = null;
+const createEventId = () => {
+    return 'xxxxxxxx4xxxyxxx'.replace(/[xy]/g, (c) => {
+        const r = (Math.random() * 16) | 0;
+        const v = c === 'x' ? r : (r & 0x3) | 0x8;
+        return v.toString(16);
+    });
+};
+const readStorage = () => {
+    try {
+        if (typeof sessionStorage === 'undefined')
+            return null;
+        return sessionStorage.getItem(STORAGE_KEY);
+    }
+    catch {
+        return null;
+    }
+};
+const writeStorage = (eventId) => {
+    try {
+        if (typeof sessionStorage === 'undefined')
+            return;
+        sessionStorage.setItem(STORAGE_KEY, eventId);
+    }
+    catch {
+        // ignore quota / private mode
+    }
+};
+/**
+ * 读取当前 eventId（不会新建）
+ * 仅由 reportDeviceInfo 调用 resetEventId 时生成/重置
+ */
+export const getEventId = () => {
+    if (memoryEventId)
+        return memoryEventId;
+    const cached = readStorage();
+    if (cached) {
+        memoryEventId = cached;
+        return cached;
+    }
+    return undefined;
+};
+/**
+ * 生成并缓存新的 eventId（仅应在 reportDeviceInfo 中调用）
+ */
+export const resetEventId = () => {
+    const eventId = createEventId();
+    memoryEventId = eventId;
+    writeStorage(eventId);
+    return eventId;
+};
+/** 测试或内部清理用 */
+export const clearEventId = () => {
+    memoryEventId = null;
+    try {
+        if (typeof sessionStorage !== 'undefined') {
+            sessionStorage.removeItem(STORAGE_KEY);
+        }
+    }
+    catch {
+        // ignore
+    }
+};

package/dist/helpers/helper-report-device-info.d.ts

@@ -0,0 +1,9 @@
+import type { FlatbizDevice } from '../types/types-device.js';
+import type { ReportDeviceInfoOptions } from '../types/types-options.js';
+/** 格式化为 yyyy-MM-dd HH:mm:ss */
+export declare const formatCollectTime: (date?: Date) => string;
+/**
+ * 将设备信息 + 业务埋点字段上报到业务接口
+ * @returns 上报是否成功
+ */
+export declare const reportDeviceInfoRequest: (device: FlatbizDevice, options: ReportDeviceInfoOptions) => Promise<boolean>;

package/dist/helpers/helper-report-device-info.js

@@ -0,0 +1,76 @@
+import { getAuthHeaders, getReportDeviceInfoUrl } from '../constant.js';
+const pad2 = (n) => String(n).padStart(2, '0');
+/** 格式化为 yyyy-MM-dd HH:mm:ss */
+export const formatCollectTime = (date = new Date()) => {
+    const y = date.getFullYear();
+    const m = pad2(date.getMonth() + 1);
+    const d = pad2(date.getDate());
+    const hh = pad2(date.getHours());
+    const mm = pad2(date.getMinutes());
+    const ss = pad2(date.getSeconds());
+    return `${y}-${m}-${d} ${hh}:${mm}:${ss}`;
+};
+const REPORT_SUCCESS_CODE = '0000';
+/** 响应体 DeviceDataResp：code === "0000" 表示成功 */
+const defaultIsSuccess = (_response, data) => {
+    if (data && typeof data === 'object' && 'code' in data) {
+        return String(data.code) === REPORT_SUCCESS_CODE;
+    }
+    return false;
+};
+/**
+ * 将设备信息 + 业务埋点字段上报到业务接口
+ * @returns 上报是否成功
+ */
+export const reportDeviceInfoRequest = async (device, options) => {
+    const { isDebug = false, isProd = true, signature, ...bizParams } = options;
+    try {
+        const authHeaders = getAuthHeaders(signature);
+        const deviceSdkInfo = { ...device };
+        if ('ip' in deviceSdkInfo) {
+            delete deviceSdkInfo.ip;
+        }
+        const response = await fetch(getReportDeviceInfoUrl(isProd), {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                ...authHeaders,
+            },
+            body: JSON.stringify({
+                deviceSdkInfo,
+                orderInfo: {
+                    eventType: 'pageLoad',
+                    collectTime: formatCollectTime(),
+                    ...bizParams,
+                },
+            }),
+        });
+        if (!response.ok) {
+            if (isDebug) {
+                console.error('上报设备信息失败', response.status, response.statusText);
+            }
+            return false;
+        }
+        let data = undefined;
+        const contentType = response.headers.get('content-type') || '';
+        if (contentType.includes('application/json')) {
+            try {
+                data = await response.json();
+            }
+            catch {
+                data = undefined;
+            }
+        }
+        const success = defaultIsSuccess(response, data);
+        if (!success && isDebug) {
+            if (isDebug)
+                console.error('上报设备信息业务失败', data);
+        }
+        return success;
+    }
+    catch (error) {
+        if (isDebug)
+            console.error('上报设备信息异常', error?.message);
+        return false;
+    }
+};

package/dist/index.d.ts

@@ -1,7 +1,15 @@
 import type { FlatbizDevice } from './types/types-device.js';
-import type { DeviceInfoOptions } from './types/types-options.js';
+import type { DeviceInfoOptions, ReportDeviceInfoOptions } from './types/types-options.js';
+export type { FlatbizDevice, FlatbizDeviceInfo, FlatbizUaParserResult, } from './types/types-device.js';
+export type { DeviceInfoOptions, DeviceReportAuthInfo, ReportDeviceBizParams, ReportDeviceInfoOptions, ReportPageName, } from './types/types-options.js';
+export { ReportDeviceType, ReportRegionType, ReportUserSys, } from './types/types-options.js';
 /**
  * 获取设备信息
  * @returns FlatbizDevice
  */
 export declare const deviceInfo: (options?: DeviceInfoOptions) => Promise<FlatbizDevice>;
+/**
+ * 上报设备信息
+ * 调用时会先重置并缓存 eventId，再采集设备信息并写入 deviceSdkInfo
+ */
+export declare const reportDeviceInfo: (options: ReportDeviceInfoOptions) => Promise<boolean>;

package/dist/index.js

@@ -1,5 +1,8 @@
 import { getDeviceInfoH5 } from './helpers/helper-device-info.js';
+import { getEventId, resetEventId } from './helpers/helper-event-id.js';
+import { reportDeviceInfoRequest } from './helpers/helper-report-device-info.js';
 import { getUaParserResult } from './helpers/helper-ua-parser.js';
+export { ReportDeviceType, ReportRegionType, ReportUserSys, } from './types/types-options.js';
 /**
  * 获取设备信息
  * @returns FlatbizDevice
@@ -14,9 +17,11 @@ export const deviceInfo = async (options) => {
         }
         const deviceInfo = await getDeviceInfoH5({ ip, autoGetIp });
         const uaParserResult = getUaParserResult();
+        const eventId = getEventId();
         return {
             ...deviceInfo,
             ...uaParserResult,
+            ...(eventId ? { eventId } : {}),
         };
     }
     catch (error) {
@@ -25,3 +30,26 @@ export const deviceInfo = async (options) => {
         return {};
     }
 };
+/**
+ * 上报设备信息
+ * 调用时会先重置并缓存 eventId，再采集设备信息并写入 deviceSdkInfo
+ */
+export const reportDeviceInfo = async (options) => {
+    const { isDebug = false } = options || {};
+    try {
+        if (typeof window === 'undefined') {
+            if (isDebug)
+                console.error('请在浏览器环境中使用');
+            return false;
+        }
+        // 仅在上报时生成/重置 eventId
+        resetEventId();
+        const info = await deviceInfo({ isDebug });
+        return reportDeviceInfoRequest(info, options);
+    }
+    catch (error) {
+        if (isDebug)
+            console.error('上报设备信息异常', error?.message);
+        return false;
+    }
+};

package/dist/types/types-device.d.ts

@@ -42,6 +42,12 @@ export interface FlatbizDeviceInfo {
     pluginNum: number;
     /** 浏览器是否启用 cookies */
     cookiesEnable: boolean;
+    /**
+     * 事件 ID
+     * 仅在调用 reportDeviceInfo 时生成/重置并缓存；
+     * deviceInfo 读取当前缓存值一并返回（尚未上报过时可能为空）
+     */
+    eventId?: string;
 }
 /**
  * FlatbizUaParserResult

package/dist/types/types-options.d.ts

@@ -20,3 +20,102 @@ export type DeviceInfoOptions = {
      */
     isDebug?: boolean;
 };
+/**
+ * 鉴权信息：
+ * - string：直接作为 `Authorization` 请求头
+ * - 对象：`token` 写入 Authorization，`headers` 合并进请求头
+ */
+export type DeviceReportAuthInfo = string | {
+    token?: string;
+    headers?: Record<string, string>;
+};
+/** 埋点采集页面 */
+export type ReportPageName = 'detail' | 'order' | 'publicCashier' | 'nativeCashier';
+/**
+ * 会员体系
+ * - 01: 同程会员体系
+ * - 02: HopeGoo 会员体系
+ * - 03: Tabigo 会员体系
+ */
+export declare enum ReportUserSys {
+    /** 同程会员体系 */
+    Tongcheng = "01",
+    /** HopeGoo 会员体系 */
+    HopeGoo = "02",
+    /** Tabigo 会员体系 */
+    Tabigo = "03"
+}
+/**
+ * 区域类型
+ * - 01: 国内
+ * - 02: 国外
+ */
+export declare enum ReportRegionType {
+    /** 国内 */
+    Domestic = "01",
+    /** 国外 */
+    Overseas = "02"
+}
+/**
+ * 设备类型
+ * - 1: PC
+ * - 3: H5
+ * - 4: HopeGoo APP
+ * - 5: Tabigo APP
+ */
+export declare enum ReportDeviceType {
+    /** PC */
+    PC = "1",
+    /** H5 */
+    H5 = "3",
+    /** HopeGoo APP */
+    HopeGooApp = "4",
+    /** Tabigo APP */
+    TabigoApp = "5"
+}
+/** 上报业务入参（不含设备指纹字段） */
+export type ReportDeviceBizParams = {
+    /**
+     * 埋点采集页面
+     * - detail：产品详情页面
+     * - order：创单页面
+     * - publicCashier：公共收银台
+     * - nativeCashier：原生收银台
+     */
+    pageName: ReportPageName;
+    /**
+     * 项目订单号
+     * pageName=detail 时无该字段值
+     */
+    orderNum: string;
+    /** 区域类型 */
+    regionType: ReportRegionType;
+    /** 设备类型 */
+    deviceType: ReportDeviceType;
+    /** 用户 ID */
+    userId?: string;
+    /** 会员体系 */
+    userSys?: ReportUserSys;
+    /**
+     * 事件类型
+     * - pageLoad：页面加载
+     * - click：点击事件
+     * - 其他：自定义事件
+     */
+    eventType?: 'pageLoad' | 'click' | string;
+};
+export type ReportDeviceInfoOptions = Pick<DeviceInfoOptions, 'isDebug'> & ReportDeviceBizParams & {
+    /**
+     * 鉴权签名，写入请求头 `X-signature`
+     * 由业务侧传入
+     */
+    signature: string;
+    /**
+     * 是否生产环境
+     * 默认 true
+     *
+     * - true：使用生产上报地址
+     * - false：使用非生产上报地址
+     */
+    isProd?: boolean;
+};

package/dist/types/types-options.js

@@ -1 +1,45 @@
-export {};
+/**
+ * 会员体系
+ * - 01: 同程会员体系
+ * - 02: HopeGoo 会员体系
+ * - 03: Tabigo 会员体系
+ */
+export var ReportUserSys;
+(function (ReportUserSys) {
+    /** 同程会员体系 */
+    ReportUserSys["Tongcheng"] = "01";
+    /** HopeGoo 会员体系 */
+    ReportUserSys["HopeGoo"] = "02";
+    /** Tabigo 会员体系 */
+    ReportUserSys["Tabigo"] = "03";
+})(ReportUserSys || (ReportUserSys = {}));
+/**
+ * 区域类型
+ * - 01: 国内
+ * - 02: 国外
+ */
+export var ReportRegionType;
+(function (ReportRegionType) {
+    /** 国内 */
+    ReportRegionType["Domestic"] = "01";
+    /** 国外 */
+    ReportRegionType["Overseas"] = "02";
+})(ReportRegionType || (ReportRegionType = {}));
+/**
+ * 设备类型
+ * - 1: PC
+ * - 3: H5
+ * - 4: HopeGoo APP
+ * - 5: Tabigo APP
+ */
+export var ReportDeviceType;
+(function (ReportDeviceType) {
+    /** PC */
+    ReportDeviceType["PC"] = "1";
+    /** H5 */
+    ReportDeviceType["H5"] = "3";
+    /** HopeGoo APP */
+    ReportDeviceType["HopeGooApp"] = "4";
+    /** Tabigo APP */
+    ReportDeviceType["TabigoApp"] = "5";
+})(ReportDeviceType || (ReportDeviceType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flatbiz/device",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "homepage": "https://gitlab.itcjf.com/flatjs/flat-biz-devkit",
   "repository": {
     "type": "git",