giime 1.1.5 → 1.1.6

package/lib/track/src/utils/env.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @file 环境配置、采集接口地址动态解析与认证头构建工具（严格对齐 giime LoginDialog.vue 与 resetAxiosBaseUrl.ts）
+ * @description
+ * 为什么需要传入 `env: import.meta.env`？
+ * 因为 `import.meta.env` 是 Vite 在构建宿主业务项目时静态注入的编译期对象，已打包进 node_modules 的 SDK 无法直接读取宿主的 `.env` 文件。
+ * 传入 `env: import.meta.env` 后，SDK 即可实现与 Giime 组件库完全一致的环境切换能力：
+ * 1. 通过 `VITE_GIIME_MODE`（如 dev / test / release / production / giiktok.production 或直填完整域名）一键切换采集接口目标环境地址；
+ * 2. 通过 `VITE_GIIME_TRACK_URL`（或 `VITE_GIIME_TRACK_API`）自定义覆盖采集接口地址；
+ * 3. 通过 `VITE_GIIME_TRACK_ENABLED` 控制环境级埋点开关，通过 `VITE_GIIME_TRACK_DEBUG` 控制控制台调试输出；
+ * 4. 自动读取 `VITE_AUTH_TOKEN_KEY`、`VITE_CRX_PLUGIN_ID`、`VITE_GIIME_LOGIN_GK_SERVICE_USER` 组装与 createAxios 完全一致的认证请求头。
+ */
+/**
+ * 环境变量对象兼容类型（兼容 Vite import.meta.env、Vue2 process.env 或直接传模式字符串）
+ */
+export type TrackEnvInput = Record<string, any> | string | undefined;
+/**
+ * 租户类型（对齐 @giime/utils/src/tenant.ts）
+ */
+export type TrackTenantType = 'giikin' | 'giiktok' | 'giimall';
+/**
+ * 环境配置项（对齐 @giime/utils/src/http/createModes.ts）
+ */
+export interface TrackEnvConfig {
+    /** 环境网关基础 URL */
+    url: string;
+    /** 租户类型 */
+    tenant: TrackTenantType;
+    /** 对应域名 */
+    domain: string;
+    /** 标准化环境名 */
+    envName: 'dev' | 'test' | 'release' | 'prod';
+}
+/**
+ * 环境变量 Key 常量定义（与 @giime/constants/key.ts 保持一致）
+ */
+export declare const TRACK_ENV_KEYS: {
+    /** Giime 统一环境切换变量（在 .env.development.local 中修改可一键切换接口环境） */
+    readonly GIIME_MODE: "VITE_GIIME_MODE";
+    /** 埋点接收接口自定义覆盖地址 */
+    readonly TRACK_URL: "VITE_GIIME_TRACK_URL";
+    /** 埋点接收接口自定义覆盖地址（别名） */
+    readonly TRACK_API: "VITE_GIIME_TRACK_API";
+    /** 埋点环境级总开关（设为 'false' 可在本地开发关闭上报） */
+    readonly TRACK_ENABLED: "VITE_GIIME_TRACK_ENABLED";
+    /** 埋点控制台调试开关（设为 'true' 强制开启日志） */
+    readonly TRACK_DEBUG: "VITE_GIIME_TRACK_DEBUG";
+    /** 自定义 Token Cookie 名称 */
+    readonly AUTH_TOKEN_KEY: "VITE_AUTH_TOKEN_KEY";
+    /** Chrome 扩展插件 ID */
+    readonly CRX_PLUGIN_ID: "VITE_CRX_PLUGIN_ID";
+    /** 本地联调服务用户头 */
+    readonly GK_SERVICE_USER: "VITE_GIIME_LOGIN_GK_SERVICE_USER";
+};
+/**
+ * 统一环境配置映射表（100% 对齐 @giime/utils/src/http/createModes.ts 的 envConfigs）
+ */
+export declare const TRACK_ENV_CONFIGS: Record<string, TrackEnvConfig>;
+/**
+ * 管理端（manage）默认采集接收服务相对路径（挂载在 /guard 网关下，自动享受 giimeDevProxyFn 的本地开发代理）
+ */
+export declare const BUILTIN_MANAGE_TRACK_PATH = "/guard/data-capture/ingest/v1/auth/track";
+/**
+ * 商城端（shop）默认采集接收服务相对路径（直接跟随商城当前访问域名请求相对路径，由同域名 Nginx + Lua 接收）
+ */
+export declare const BUILTIN_SHOP_TRACK_PATH = "/ingest/v1/shop/track";
+/**
+ * 默认采集接收服务相对路径（兼容导出，等同于 BUILTIN_MANAGE_TRACK_PATH）
+ */
+export declare const BUILTIN_TRACK_PATH = "/guard/data-capture/ingest/v1/auth/track";
+/**
+ * 拼接 URL 路径（对齐 @giime/utils/src/http/url.ts 的 urlJoin）
+ */
+export declare const joinTrackUrl: (base: string, path: string) => string;
+/**
+ * 把 VITE_GIIME_MODE 解析为 TrackEnvConfig（支持预定义 key 或直接填 https:// 完整域名）
+ */
+export declare const resolveTrackModeConfig: (mode?: string) => TrackEnvConfig | undefined;
+/**
+ * 根据传入的 env (import.meta.env)、自定义地址和业务端类型 (manage / shop)，解析完整环境信息与最终采集接口地址
+ * 优先级：
+ * 1. 显式传入的 customEndpoint（或 script 标签 data-endpoint）
+ * 2. 环境变量显式指定 (VITE_GIIME_TRACK_URL / VITE_GIIME_TRACK_API)
+ * 3. 商城端模式 (appType === 'shop')：直接走相对路径 `/ingest/v1/shop/track`（跟随商城实际访问域名，严禁暴露吉客印域名）
+ * 4. 管理端本地开发 (env.DEV === true)：走相对路径 `/guard/data-capture/ingest/v1/auth/track`（复用 vite.config.ts 中 giimeDevProxyFn 生成的 /guard 代理）
+ * 5. 管理端 4 套环境地址：按 VITE_GIIME_MODE 或当前浏览器 hostname 匹配对应环境域名并拼接 `/guard/data-capture/ingest/v1/auth/track`
+ */
+export declare const resolveTrackEnvironment: (envInput?: TrackEnvInput, customEndpoint?: string, appType?: 'manage' | 'shop') => {
+    envName: 'dev' | 'test' | 'release' | 'prod';
+    tenant: TrackTenantType;
+    endpoint: string;
+    isDev: boolean;
+    isSSR: boolean;
+    envEnabled: boolean;
+    envDebug: boolean;
+    rawEnvObj: Record<string, any>;
+};
+/**
+ * 自动构建与 createAxios.ts 完全一致的认证请求头（使后端采集平台可直接获取当前登录员工 ID，无需前端传 getUserId）
+ * @param rawEnvObj import.meta.env 对象
+ */
+export declare const buildAutoAuthHeaders: (rawEnvObj?: Record<string, any>) => Record<string, string>;

package/lib/track/src/utils/id.d.ts

@@ -0,0 +1,80 @@
+/**
+ * @file 唯一标识生成、安全本地存储（带 __giime_track_ 隔离前缀）与 URL 脱敏工具
+ */
+/**
+ * 内部 LocalStorage 存储键名常量（统一使用 __giime_track_ 前缀，与商城老 SDK 完全隔离）
+ */
+export declare const GIIME_STORAGE_KEYS: {
+    /** 永久访客/设备唯一标识 */
+    readonly UID: "__giime_track_uid";
+    /** 当前访问会话标识 */
+    readonly SESSION_ID: "__giime_track_session_id";
+    /** 会话最后活跃时间戳 */
+    readonly SESSION_ACTIVE_AT: "__giime_track_session_ts";
+    /** 商城购物会话标识（对应老版 __sx_event_poster_eid，独立存储防冲突） */
+    readonly SHOP_EID: "__giime_track_eid";
+    /** 商城上一次成单会话标识（对应老版 g_pre_eid） */
+    readonly SHOP_PRE_EID: "__giime_track_pre_eid";
+    /** 上一页面访问 ID（对应老版 pre_page_id，独立存储防被老版 removeItem 删掉） */
+    readonly PRE_PAGE_ID: "__giime_track_pre_page_id";
+    /** 发送失败降级队列（仅当网络失败时落盘，避免老版无条件重放导致的 3 倍膨胀） */
+    readonly FAILED_QUEUE: "__giime_track_failed_queue";
+    /** 是否已完成首次访问标记 */
+    readonly FIRST_VISIT_DONE: "__giime_track_first_visit";
+};
+/**
+ * 商城老版 SDK 使用的原始 LocalStorage 键名（仅作只读对齐参考，绝不修改或删除）
+ */
+export declare const LEGACY_SHOPPLUS_KEYS: {
+    readonly UID: "__sx_event_poster_uid";
+    readonly EID: "__sx_event_poster_eid";
+    readonly PRE_EID: "g_pre_eid";
+    readonly PRE_PAGE_ID: "pre_page_id";
+    readonly SHOPX_PARAMS: "__shopx__params";
+};
+/**
+ * 安全读取 localStorage
+ * @param key 存储键名
+ */
+export declare const readSafeStorage: (key: string) => string;
+/**
+ * 安全写入 localStorage
+ * @param key 存储键名
+ * @param value 存储字符串值
+ */
+export declare const writeSafeStorage: (key: string, value: string) => boolean;
+/**
+ * 安全删除 localStorage 指定键
+ * @param key 存储键名
+ */
+export declare const removeSafeStorage: (key: string) => void;
+/**
+ * 安全读取 Cookie
+ * @param cookieName Cookie 名称
+ */
+export declare const getSafeCookie: (cookieName: string) => string;
+/**
+ * 生成 4 位 16 进制随机串（兼容商城 S4 算法）
+ */
+export declare const generateS4: () => string;
+/**
+ * 生成兼容商城格式的随机 ID（13位毫秒时间戳 + 12位16进制随机串）
+ */
+export declare const generateCompatRandomId: () => string;
+/**
+ * 生成带语义前缀的唯一标识
+ * @param prefix 前缀，如 evt / pg / sess / batch / op
+ */
+export declare const generateTrackId: (prefix?: string) => string;
+/**
+ * 过滤 URL 中的登录票据、密钥等敏感参数
+ * @param rawUrl 原始 URL 地址
+ */
+export declare const sanitizeTrackUrl: (rawUrl: string) => string;
+/**
+ * 生成商城兼容防伪签名 (_t 为前12位时间戳+各位数字之和个位校验位，_s 为加盐 MD5)
+ */
+export declare const generateShopPlusSign: () => {
+    _t: number;
+    _s: string;
+};

package/lib/track/vue2.d.ts

@@ -0,0 +1 @@
+export * from './src/adapters/vue2';

package/lib/track/vue3.d.ts

@@ -0,0 +1 @@
+export * from './src/adapters/vue3';

package/lib/utils/index.d.ts

@@ -16,3 +16,4 @@ export * from './src/array';
 export * from './src/regexPatterns';
 export * from './src/tenant';
 export * from './src/clarity';
+export * from './src/watermark';

package/lib/utils/index.js

@@ -18,6 +18,7 @@ var array = require('./src/array.js');
 require('./src/regexPatterns/index.js');
 var tenant = require('./src/tenant.js');
 var index$1 = require('./src/clarity/index.js');
+var index$2 = require('./src/watermark/index.js');
 var install = require('./src/vue/install.js');
 var resolver = require('./src/vue/resolver.js');
 var router = require('./src/vue/router.js');
@@ -115,6 +116,24 @@ exports.getTenantType = tenant.getTenantType;
 exports.isGiikin = tenant.isGiikin;
 exports.isGiiktok = tenant.isGiiktok;
 exports.Clarity = index$1.Clarity;
+exports.GIIME_WATERMARK_GLOBAL_SYMBOL = index$2.GIIME_WATERMARK_GLOBAL_SYMBOL;
+exports.GiimeWatermark = index$2.GiimeWatermark;
+exports.WATERMARK_DOM_CONSTANTS = index$2.WATERMARK_DOM_CONSTANTS;
+exports.WATERMARK_MESSAGE_TYPES = index$2.WATERMARK_MESSAGE_TYPES;
+exports.Watermark = index$2.Watermark;
+exports.buildWatermarkText = index$2.buildWatermarkText;
+exports.createWatermark = index$2.createWatermark;
+exports.destroyWatermark = index$2.destroyWatermark;
+exports.formatWatermarkDate = index$2.formatWatermarkDate;
+exports.getWatermarkInstance = index$2.getWatermarkInstance;
+exports.hasSameOriginAncestorWatermark = index$2.hasSameOriginAncestorWatermark;
+exports.initWatermark = index$2.initWatermark;
+exports.inspectSameOriginAncestors = index$2.inspectSameOriginAncestors;
+exports.isInIframe = index$2.isInIframe;
+exports.resolveWatermarkUserId = index$2.resolveWatermarkUserId;
+exports.sanitizeUserId = index$2.sanitizeUserId;
+exports.shouldRenderWatermark = index$2.shouldRenderWatermark;
+exports.useWatermark = index$2.useWatermark;
 exports.withInstall = install.withInstall;
 exports.withInstallDirective = install.withInstallDirective;
 exports.withInstallFunction = install.withInstallFunction;

package/lib/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/lib/utils/src/watermark/index.d.ts

@@ -0,0 +1,191 @@
+/**
+ * @file Giime (Vue 3) 内置智能水印模块 (@giime/utils/src/watermark)
+ * @description
+ * 面向 acore-front 等 Vue 3 项目的内置水印引擎（由 `app.use(Giime, ...)` 自动挂载，也可通过 `import { Watermark, initWatermark, useWatermark } from '../../../../giime'` 手动控制）：
+ * 1. 智能感知窗口嵌套与父级水印状态（默认策略 `'ancestor-detect'`）：
+ *    - 单独打开前端页面（`window.self === window.top`）：直接展示全屏水印；
+ *    - 在 GSMP 综合管理平台或已带水印的外层页面中通过 iframe 打开时：检测到外层已有水印（同源检测 `#__giime_watermark__` / 老版 `.mask_div`，或跨源 `postMessage` 握手收到 `pong` / `suppress`），自动隐藏内部水印；
+ *    - 单独打开一个**未接入水印**的外层前端页面，其内部通过 iframe 嵌套本页面时：检测到外层无水印，本页面在 iframe 内**自动兜底展示水印**；
+ * 2. 防 Cookie 篡改用户身份识别（参考 `Clarity`）：
+ *    - 直接从 `useCurrentUserStore()`（底层调用 `/guard/basic/v1/user/getCurrentUser` 校验 JWT `token`）读取服务端认证的真实 `userInfo.id`，绝不读取易被用户在控制台修改的 `sso_user_id` Cookie；
+ * 3. 视觉样式（#aaa、0.1 透明度、-20deg 逆时针倾斜、15px 微软雅黑、210×80 尺寸及自适应间距）与旧版完全一致。
+ */
+export type WatermarkIframeStrategy = 'ancestor-detect' | 'top-only' | 'always' | 'never';
+export interface WatermarkFormatContext {
+    userId: string;
+    date: string;
+    prefix: string;
+}
+export interface WatermarkOptions {
+    /** 是否启用水印（默认 true） */
+    enabled?: boolean;
+    /**
+     * Iframe 嵌套处理策略（默认 `'ancestor-detect'`）
+     * - `'ancestor-detect'`（默认）：同源向上检测 `#__giime_watermark__` / `.mask_div` + 跨源 postMessage 握手探测父级是否有水印；若外层有水印则隐藏，若外层未接入水印则子 iframe 自动兜底展示水印
+     * - `'top-only'`：仅顶层窗口渲染水印，任意处于 iframe 内的页面一律隐藏
+     * - `'always'`：强制始终渲染
+     * - `'never'`：禁用并销毁
+     */
+    iframeStrategy?: WatermarkIframeStrategy;
+    /** `'ancestor-detect'` 模式下跨源握手等待超时毫秒数（默认 120） */
+    detectTimeoutMs?: number;
+    /** 水印品牌前缀（默认 '吉客印'） */
+    prefix?: string;
+    /** 显式指定用户 ID（不传则自动从 `useCurrentUserStore().userInfo.id` 读取） */
+    userId?: string | number;
+    /** 自定义动态获取用户 ID 的函数 */
+    getUserId?: () => string | number | undefined | null;
+    /** 自定义水印文本或格式化函数（默认生成 `吉客印-${userId}-${YYYY年MM月DD日}`） */
+    text?: string | ((ctx: WatermarkFormatContext) => string);
+    /** 水印起始位置 X 轴坐标（默认 20） */
+    x?: number;
+    /** 水印起始位置 Y 轴坐标（默认 20） */
+    y?: number;
+    /** 水印行数（默认 20） */
+    rows?: number;
+    /** 水印列数（默认 20） */
+    cols?: number;
+    /** 水印 X 轴间隔（默认 100） */
+    xSpace?: number;
+    /** 水印 Y 轴间隔（默认 50） */
+    ySpace?: number;
+    /** 水印字体颜色（默认 '#aaa'） */
+    color?: string;
+    /** 水印透明度（默认 0.1） */
+    alpha?: number;
+    /** 水印字体大小（默认 '15px'） */
+    fontSize?: string;
+    /** 水印字体（默认 '微软雅黑'） */
+    font?: string;
+    /** 单个水印块宽度（默认 210） */
+    width?: number;
+    /** 单个水印块高度（默认 80） */
+    height?: number;
+    /** 水印倾斜角度度数（默认 20） */
+    angle?: number;
+    /** 水印容器层级 z-index（默认 9999） */
+    zIndex?: number;
+    /** 是否开启 MutationObserver 防篡改保护（默认 true） */
+    antiTamper?: boolean;
+    /** 是否监听窗口 resize 自动重排（默认 true） */
+    watchResize?: boolean;
+    /** 是否自动清理页面上遗留的老版裸 `.mask_div` 节点（默认 true） */
+    cleanLegacyMask?: boolean;
+}
+export interface NormalizedWatermarkConfig {
+    enabled: boolean;
+    iframeStrategy: WatermarkIframeStrategy;
+    detectTimeoutMs: number;
+    prefix: string;
+    userId?: string | number;
+    getUserId?: () => string | number | undefined | null;
+    text?: string | ((ctx: WatermarkFormatContext) => string);
+    x: number;
+    y: number;
+    rows: number;
+    cols: number;
+    xSpace: number;
+    ySpace: number;
+    color: string;
+    alpha: number;
+    fontSize: string;
+    font: string;
+    width: number;
+    height: number;
+    angle: number;
+    zIndex: number;
+    antiTamper: boolean;
+    watchResize: boolean;
+    cleanLegacyMask: boolean;
+}
+export interface WatermarkState {
+    inIframe: boolean;
+    active: boolean;
+    reason: 'rendered-top' | 'rendered-forced' | 'rendered-fallback' | 'suppressed-in-iframe' | 'suppressed-by-ancestor' | 'disabled' | 'ssr';
+    text: string;
+    userId: string;
+    rows: number;
+    cols: number;
+}
+export declare const GIIME_WATERMARK_GLOBAL_SYMBOL: unique symbol;
+export declare const WATERMARK_MESSAGE_TYPES: {
+    readonly PING: "giime-watermark:ping";
+    readonly PONG: "giime-watermark:pong";
+    readonly SUPPRESS: "giime-watermark:suppress";
+};
+export declare const WATERMARK_DOM_CONSTANTS: {
+    readonly CONTAINER_ID: "__giime_watermark__";
+    readonly CONTAINER_CLASS: "giime-watermark-container";
+    readonly LEGACY_ITEM_CLASS: "mask_div";
+    readonly ROOT_ATTR: "data-giime-watermark";
+};
+export declare const sanitizeUserId: (raw: unknown) => string;
+/**
+ * 解析当前用户 ID：
+ * 1. 优先显式配置
+ * 2. 若 useCurrentUserStore 已返回服务端真实用户 ID，则优先使用
+ * 3. 默认首屏先读 Cookie `sso_user_id`（0ms 同步直出不闪烁，随后由 useCurrentUserStore 静默比对纠偏）
+ */
+export declare const resolveWatermarkUserId: (config?: Pick<NormalizedWatermarkConfig, 'userId' | 'getUserId'>) => string;
+export declare const formatWatermarkDate: (date?: Date) => string;
+export declare const buildWatermarkText: (config: Pick<NormalizedWatermarkConfig, 'prefix' | 'text' | 'userId' | 'getUserId'>, resolvedUserId?: string, dateStr?: string) => string;
+export declare const isInIframe: (win?: Window) => boolean;
+export declare const inspectSameOriginAncestors: (win?: Window) => {
+    hasWatermark: boolean;
+    allAncestorsAccessible: boolean;
+};
+export declare const hasSameOriginAncestorWatermark: (win?: Window) => boolean;
+export declare const shouldRenderWatermark: (strategy?: WatermarkIframeStrategy, win?: Window) => {
+    shouldRender: boolean;
+    inIframe: boolean;
+    needsAsyncDetect: boolean;
+    reason: WatermarkState['reason'];
+};
+export declare class GiimeWatermark {
+    private config;
+    private state;
+    private containerEl;
+    private mutationObserver;
+    private resizeTimer;
+    private isRenderingInternal;
+    private listenersAttached;
+    private domReadyListenerAttached;
+    private readonly handleWindowResize;
+    private readonly handleWindowMessage;
+    constructor(options?: WatermarkOptions);
+    private bootstrap;
+    private activateWatermark;
+    private suppressWatermark;
+    render(): void;
+    private startMutationObserver;
+    private stopMutationObserver;
+    private attachGlobalListeners;
+    private detachGlobalListeners;
+    updateConfig(options?: WatermarkOptions): this;
+    setUserId(userId: string | number): this;
+    refresh(): this;
+    getState(): WatermarkState;
+    getConfig(): NormalizedWatermarkConfig;
+    destroy(): void;
+}
+export declare const getWatermarkInstance: () => GiimeWatermark | null;
+export declare const initWatermark: (options?: WatermarkOptions) => GiimeWatermark;
+export declare const createWatermark: (options?: WatermarkOptions) => GiimeWatermark;
+export declare const destroyWatermark: () => void;
+export declare const useWatermark: (options?: WatermarkOptions) => GiimeWatermark;
+export declare const Watermark: {
+    init: (options?: WatermarkOptions) => GiimeWatermark;
+    create: (options?: WatermarkOptions) => GiimeWatermark;
+    getInstance: () => GiimeWatermark | null;
+    destroy: () => void;
+    setUserId(userId: string | number): GiimeWatermark;
+    refresh(): GiimeWatermark;
+    getState(): WatermarkState | null;
+    isInIframe: (win?: Window) => boolean;
+    shouldRenderWatermark: (strategy?: WatermarkIframeStrategy, win?: Window) => {
+        shouldRender: boolean;
+        inIframe: boolean;
+        needsAsyncDetect: boolean;
+        reason: WatermarkState['reason'];
+    };
+};