@flatbiz/device 2.0.4 → 2.0.5

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.4",
+  "version": "2.0.5",
   "homepage": "https://gitlab.itcjf.com/flatjs/flat-biz-devkit",
   "repository": {
     "type": "git",