@be-link/ecommerce-client-backend-service-node-sdk 0.1.62 → 0.1.64

package/enum.d.ts

@@ -268,4 +268,17 @@ export declare namespace ENUM {
             Yes = 1
         }
     }
+    /**
+     * 用户支付流水交易类型
+     */
+    enum TransactionType {
+        /** 支付成功 */
+        PAY_SUCCESS = 1,
+        /** 退款成功 */
+        REFUND_SUCCESS = 2,
+        /** 支付调整（对账冲平） */
+        PAY_ADJUST = 3,
+        /** 退款调整（对账冲平） */
+        REFUND_ADJUST = 4
+    }
 }

package/enum.js

@@ -306,4 +306,18 @@ var ENUM;
             USED[USED["Yes"] = 1] = "Yes";
         })(USED = MINI_PROGRAM.USED || (MINI_PROGRAM.USED = {}));
     })(MINI_PROGRAM = ENUM.MINI_PROGRAM || (ENUM.MINI_PROGRAM = {}));
+    /**
+     * 用户支付流水交易类型
+     */
+    let TransactionType;
+    (function (TransactionType) {
+        /** 支付成功 */
+        TransactionType[TransactionType["PAY_SUCCESS"] = 1] = "PAY_SUCCESS";
+        /** 退款成功 */
+        TransactionType[TransactionType["REFUND_SUCCESS"] = 2] = "REFUND_SUCCESS";
+        /** 支付调整（对账冲平） */
+        TransactionType[TransactionType["PAY_ADJUST"] = 3] = "PAY_ADJUST";
+        /** 退款调整（对账冲平） */
+        TransactionType[TransactionType["REFUND_ADJUST"] = 4] = "REFUND_ADJUST";
+    })(TransactionType = ENUM.TransactionType || (ENUM.TransactionType = {}));
 })(ENUM || (exports.ENUM = ENUM = {}));

package/index.d.ts

@@ -4,12 +4,14 @@ export type { DataService } from './modules/data/types';
 export type { DomainService } from './modules/domain/types';
 export type { RuleService } from './modules/rule/types';
 export type { MiniProgramService } from './modules/miniprogram/types';
+export type { UserDataService } from './modules/userData/types';
 export { roomService } from './modules/room/service';
 export { roomDataService } from './modules/roomData/service';
 export { dataService } from './modules/data/service';
 export { domainService } from './modules/domain/service';
 export { ruleService } from './modules/rule/service';
 export { miniProgramService } from './modules/miniprogram/service';
+export { userDataService } from './modules/userData/service';
 export { ENUM as CLIENT_BACKEND_ENUM } from './enum';
 export type { Room, RoomAutoStartConfig, RoomLoopVideo, RoomTag, RoomBindStore } from './types';
 export type { Domain, Current } from './modules/domain/types';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLIENT_BACKEND_ENUM = exports.miniProgramService = exports.ruleService = exports.domainService = exports.dataService = exports.roomDataService = exports.roomService = void 0;
+exports.CLIENT_BACKEND_ENUM = exports.userDataService = exports.miniProgramService = exports.ruleService = exports.domainService = exports.dataService = exports.roomDataService = exports.roomService = void 0;
 var service_1 = require("./modules/room/service");
 Object.defineProperty(exports, "roomService", { enumerable: true, get: function () { return service_1.roomService; } });
 var service_2 = require("./modules/roomData/service");
@@ -13,6 +13,8 @@ var service_5 = require("./modules/rule/service");
 Object.defineProperty(exports, "ruleService", { enumerable: true, get: function () { return service_5.ruleService; } });
 var service_6 = require("./modules/miniprogram/service");
 Object.defineProperty(exports, "miniProgramService", { enumerable: true, get: function () { return service_6.miniProgramService; } });
+var service_7 = require("./modules/userData/service");
+Object.defineProperty(exports, "userDataService", { enumerable: true, get: function () { return service_7.userDataService; } });
 var enum_1 = require("./enum");
 Object.defineProperty(exports, "CLIENT_BACKEND_ENUM", { enumerable: true, get: function () { return enum_1.ENUM; } });
 // 服务.模块.枚举名称.枚举值 示例: DEMO_ENUM.ORDER_ENUM.STATUS.PENDING

package/modules/data/service.d.ts

@@ -25,13 +25,24 @@ declare class DataServiceClass extends BaseService implements DataService.BaseCo
     /** 每日更新用户7天累计消费金额 */
     dailyUpdateUserSevenDaysAmount(): Promise<void>;
     /** 初始化用户数据-刷入所有用户 */
-    initUserExtraInfoUsers(): Promise<void>;
+    initUserExtraInfoUsers(request?: DataService.Request.InitUserExtraInfoUsers): Promise<void>;
     /** 初始化用户数据-刷最近看播时间 */
     initUserExtraInfoLastWatchTime(): Promise<void>;
     /** 初始化用户数据-刷7天累计消费 */
     initUserExtraInfoSevenDaysAmount(): Promise<void>;
     /** 手动补偿更新用户最后看播时间 */
     compensateUserLastWatchTime(request: DataService.Request.CompensateUserLastWatchTime): Promise<DataService.Response.CompensateUserLastWatchTime>;
+    /** 同步观众统计数据 */
+    syncAudienceStatistics(): Promise<void>;
+    /** 每日更新用户首次看播时间 */
+    dailyUpdateUserFirstWatchTime(): Promise<void>;
+    /** 每小时更新用户首次消费时间 */
+    hourlyUpdateUserFirstConsumptionTime(): Promise<void>;
+    /** 每日对账任务 */
+    dailyReconciliation(): Promise<void>;
+    /** 批量更新用户消费数据（从CSV文件） */
+    batchUpdateUserConsumptionFromCsv(request: DataService.Request.BatchUpdateUserConsumptionFromCsv): Promise<void>;
+    batchUpdateUserWatchDataFromCsv(request: DataService.Request.BatchUpdateUserWatchDataFromCsv): Promise<void>;
 }
 export declare const dataService: DataServiceClass;
 export default dataService;

package/modules/data/service.js

@@ -70,8 +70,8 @@ let DataServiceClass = class DataServiceClass extends BaseService_1.default {
         return (0, http_1.callApi)(this.getApiUrl(this.dailyUpdateUserSevenDaysAmount), undefined);
     }
     /** 初始化用户数据-刷入所有用户 */
-    initUserExtraInfoUsers() {
-        return (0, http_1.callApi)(this.getApiUrl(this.initUserExtraInfoUsers), undefined);
+    initUserExtraInfoUsers(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.initUserExtraInfoUsers), request);
     }
     /** 初始化用户数据-刷最近看播时间 */
     initUserExtraInfoLastWatchTime() {
@@ -85,6 +85,29 @@ let DataServiceClass = class DataServiceClass extends BaseService_1.default {
     compensateUserLastWatchTime(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.compensateUserLastWatchTime), request);
     }
+    /** 同步观众统计数据 */
+    syncAudienceStatistics() {
+        return (0, http_1.callApi)(this.getApiUrl(this.syncAudienceStatistics), undefined);
+    }
+    /** 每日更新用户首次看播时间 */
+    dailyUpdateUserFirstWatchTime() {
+        return (0, http_1.callApi)(this.getApiUrl(this.dailyUpdateUserFirstWatchTime), undefined);
+    }
+    /** 每小时更新用户首次消费时间 */
+    hourlyUpdateUserFirstConsumptionTime() {
+        return (0, http_1.callApi)(this.getApiUrl(this.hourlyUpdateUserFirstConsumptionTime), undefined);
+    }
+    /** 每日对账任务 */
+    dailyReconciliation() {
+        return (0, http_1.callApi)(this.getApiUrl(this.dailyReconciliation), undefined);
+    }
+    /** 批量更新用户消费数据（从CSV文件） */
+    batchUpdateUserConsumptionFromCsv(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.batchUpdateUserConsumptionFromCsv), request);
+    }
+    batchUpdateUserWatchDataFromCsv(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.batchUpdateUserWatchDataFromCsv), request);
+    }
 };
 __decorate([
     (0, tsoa_1.OperationId)('获取用户观看时长'),
@@ -165,6 +188,32 @@ __decorate([
     (0, tsoa_1.Post)('compensate-user-last-watch-time'),
     __param(0, (0, tsoa_1.Body)())
 ], DataServiceClass.prototype, "compensateUserLastWatchTime", null);
+__decorate([
+    (0, tsoa_1.OperationId)('同步观众统计数据'),
+    (0, tsoa_1.Post)('sync-audience-statistics')
+], DataServiceClass.prototype, "syncAudienceStatistics", null);
+__decorate([
+    (0, tsoa_1.OperationId)('每日更新用户首次看播时间'),
+    (0, tsoa_1.Post)('daily-update-user-first-watch-time')
+], DataServiceClass.prototype, "dailyUpdateUserFirstWatchTime", null);
+__decorate([
+    (0, tsoa_1.OperationId)('每小时更新用户首次消费时间'),
+    (0, tsoa_1.Post)('hourly-update-user-first-consumption-time')
+], DataServiceClass.prototype, "hourlyUpdateUserFirstConsumptionTime", null);
+__decorate([
+    (0, tsoa_1.OperationId)('每日对账任务'),
+    (0, tsoa_1.Post)('daily-reconciliation')
+], DataServiceClass.prototype, "dailyReconciliation", null);
+__decorate([
+    (0, tsoa_1.OperationId)('批量更新用户消费数据（从CSV文件）'),
+    (0, tsoa_1.Post)('batch-update-user-consumption-from-csv'),
+    __param(0, (0, tsoa_1.Body)())
+], DataServiceClass.prototype, "batchUpdateUserConsumptionFromCsv", null);
+__decorate([
+    (0, tsoa_1.OperationId)('批量更新用户观看数据（从CSV文件）'),
+    (0, tsoa_1.Post)('batch-update-user-watch-data-from-csv'),
+    __param(0, (0, tsoa_1.Body)())
+], DataServiceClass.prototype, "batchUpdateUserWatchDataFromCsv", null);
 DataServiceClass = __decorate([
     (0, tsoa_1.Route)('data'),
     (0, tsoa_1.Tags)('Data')

package/modules/data/types.d.ts

@@ -170,6 +170,15 @@ export declare namespace DataService {
             /** 直播间状态 */
             status: ENUM.LIVE_STREAM_AUDIENCE.VIEW_TYPE;
         }
+        /**
+         * 初始化用户数据-刷入所有用户
+         */
+        interface InitUserExtraInfoUsers {
+            /** 起始页码（可选，从0开始，默认0）用于断点续传 */
+            pageIndex?: number;
+            /** 每页数量（可选，默认500） */
+            pageSize?: number;
+        }
         /**
          * 手动补偿更新用户最后看播时间
          */
@@ -177,6 +186,20 @@ export declare namespace DataService {
             /** 直播间id */
             liveStreamRoomId: string;
         }
+        /**
+         * 批量更新用户消费数据（从CSV文件）
+         */
+        interface BatchUpdateUserConsumptionFromCsv {
+            /** CSV文件的COS地址 */
+            fileUrl: string;
+        }
+        /**
+         * 批量更新用户观看数据（从CSV文件）
+         */
+        interface BatchUpdateUserWatchDataFromCsv {
+            /** CSV文件的COS地址 */
+            fileUrl: string;
+        }
     }
     namespace Response {
         /**
@@ -254,10 +277,16 @@ export declare namespace DataService {
         syncTask(request: Payload.Task): Promise<void>;
         userWatchDurationTask(): Promise<void>;
         dailyUpdateUserSevenDaysAmount(req?: FastifyRequest): Promise<void>;
-        initUserExtraInfoUsers(req?: FastifyRequest): Promise<void>;
+        initUserExtraInfoUsers(request?: Request.InitUserExtraInfoUsers, req?: FastifyRequest): Promise<void>;
         initUserExtraInfoLastWatchTime(req?: FastifyRequest): Promise<void>;
         initUserExtraInfoSevenDaysAmount(req?: FastifyRequest): Promise<void>;
         compensateUserLastWatchTime(request: Request.CompensateUserLastWatchTime, req?: FastifyRequest): Promise<Response.CompensateUserLastWatchTime>;
+        syncAudienceStatistics(): Promise<void>;
+        dailyUpdateUserFirstWatchTime(req?: FastifyRequest): Promise<void>;
+        hourlyUpdateUserFirstConsumptionTime(req?: FastifyRequest): Promise<void>;
+        dailyReconciliation(req?: FastifyRequest): Promise<void>;
+        batchUpdateUserConsumptionFromCsv(request: Request.BatchUpdateUserConsumptionFromCsv, req?: FastifyRequest): Promise<void>;
+        batchUpdateUserWatchDataFromCsv(request: Request.BatchUpdateUserWatchDataFromCsv, req?: FastifyRequest): Promise<void>;
     }
 }
 /**
@@ -323,6 +352,8 @@ export interface RoomStatistics {
     pendingPaymentAmount: number;
     /** 商品销售量 */
     salesVolume: number;
+    /** 待支付份数 */
+    pendingSalesVolume: number;
 }
 export interface Product {
     /** 直播间id */
@@ -345,6 +376,8 @@ export interface Product {
     paymentAmount: number;
     /** 下单份数 */
     orderQuantity: number;
+    /** 待支付份数 */
+    pendingSalesVolume: number;
     /** 支付转化率 */
     paymentConversionRate: string;
 }

package/modules/userData/service.d.ts

@@ -0,0 +1,9 @@
+import { UserDataService } from './types';
+import BaseService from '../BaseService';
+declare class UserDataServiceClass extends BaseService implements UserDataService.BaseController {
+    protected prefixUrl: string;
+    getUserList(request: UserDataService.Request.GetUserList): Promise<UserDataService.Response.GetUserList>;
+    exportUserList(request: UserDataService.Request.ExportUserList): Promise<UserDataService.Response.ExportUserList>;
+}
+export declare const userDataService: UserDataServiceClass;
+export default userDataService;

package/modules/userData/service.js

@@ -0,0 +1,46 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userDataService = void 0;
+const tsoa_1 = require("tsoa");
+const http_1 = require("../../utils/http");
+const BaseService_1 = __importDefault(require("../BaseService"));
+let UserDataServiceClass = class UserDataServiceClass extends BaseService_1.default {
+    constructor() {
+        super(...arguments);
+        this.prefixUrl = '/userData';
+    }
+    getUserList(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.getUserList), request);
+    }
+    exportUserList(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.exportUserList), request);
+    }
+};
+__decorate([
+    (0, tsoa_1.OperationId)('获取用户列表'),
+    (0, tsoa_1.Post)('get-user-list'),
+    __param(0, (0, tsoa_1.Body)())
+], UserDataServiceClass.prototype, "getUserList", null);
+__decorate([
+    (0, tsoa_1.OperationId)('导出用户列表'),
+    (0, tsoa_1.Post)('export-user-list'),
+    __param(0, (0, tsoa_1.Body)())
+], UserDataServiceClass.prototype, "exportUserList", null);
+UserDataServiceClass = __decorate([
+    (0, tsoa_1.Route)('userData'),
+    (0, tsoa_1.Tags)('UserData')
+], UserDataServiceClass);
+exports.userDataService = new UserDataServiceClass();
+exports.default = exports.userDataService;

package/modules/userData/types.d.ts

@@ -0,0 +1,163 @@
+import { FastifyRequest } from 'fastify';
+export declare namespace UserDataService {
+    namespace Request {
+        /**
+         * 获取用户列表请求参数
+         */
+        interface GetUserList {
+            /** 注册渠道 */
+            registerChannel?: string;
+            /** 用户状态 */
+            status?: string;
+            /** 会员等级 */
+            memberLevel?: string;
+            /** 用户ID */
+            userId?: string;
+            /** 用户ID列表 */
+            userIds?: string[];
+            /** 手机号列表 */
+            mobiles?: string[];
+            /** 绑定手机号 */
+            bindMobile?: string;
+            /** unionId */
+            unionId?: string;
+            /** 昵称（模糊查询） */
+            nickname?: string;
+            /** 门店ID */
+            storeId?: string;
+            /** 可用积分范围 [最小值, 最大值] */
+            availablePointsRange?: number[];
+            /** 福利官ID列表 */
+            welfareOfficerIds?: string[];
+            /** 累计看播时长范围（毫秒）[最小值, 最大值] */
+            cumulativeWatchDurationRange?: number[];
+            /** 首次看播时间范围（毫秒）[开始时间, 结束时间] */
+            firstWatchTimeRange?: number[];
+            /** 最近看播时间范围（毫秒）[开始时间, 结束时间] */
+            lastWatchTimeRange?: number[];
+            /** 累计消费金额范围（分）[最小值, 最大值] */
+            accumulatedConsumptionAmountRange?: number[];
+            /** 最近消费时间范围（毫秒）[开始时间, 结束时间] */
+            lastConsumptionTimeRange?: number[];
+            /** 每页数量，默认20 */
+            pageSize?: number;
+            /** 页码，从0开始 */
+            pageIndex?: number;
+        }
+        /**
+         * 导出用户列表请求参数（复用 GetUserList 的筛选条件）
+         */
+        interface ExportUserList extends Omit<GetUserList, 'pageSize' | 'pageIndex'> {
+        }
+    }
+    namespace Response {
+        /**
+         * 获取用户列表响应
+         */
+        interface GetUserList {
+            list: UserInfo[];
+            total: number;
+            pageSize: number;
+            pageIndex: number;
+        }
+        /**
+         * 批量导出响应
+         */
+        interface IBatchExport {
+            /** 表头 */
+            headers: string[];
+            /** 数据 */
+            data: (string | number)[][];
+        }
+        /**
+         * 导出用户列表响应
+         */
+        interface ExportUserList extends IBatchExport {
+        }
+    }
+    interface BaseController {
+        getUserList(request: Request.GetUserList, req?: FastifyRequest): Promise<Response.GetUserList>;
+        exportUserList(request: Request.ExportUserList, req?: FastifyRequest): Promise<Response.ExportUserList>;
+    }
+}
+/**
+ * 用户信息
+ */
+export interface UserInfo {
+    /** 用户ID */
+    id: string;
+    /** unionId */
+    unionId: string;
+    /** openId */
+    openId: string;
+    /** 门店ID */
+    storeId: string;
+    /** 门店名称 */
+    storeName: string;
+    /** BD名称 */
+    bdName: string;
+    /** 用户名 */
+    username: string;
+    /** 昵称 */
+    nickname: string;
+    /** 头像 */
+    avatar: string;
+    /** 手机号 */
+    mobile: string;
+    /** 绑定手机号 */
+    bindMobile: string;
+    /** 性别 */
+    gender: string;
+    /** 生日（时间戳） */
+    birthday: number;
+    /** 注册渠道 */
+    registerChannel: string;
+    /** 注册来源 */
+    registerSource: string;
+    /** 注册时间（时间戳） */
+    registerTime: number;
+    /** 用户状态 */
+    status: string;
+    /** 会员等级 */
+    memberLevel: string;
+    /** 会员创建时间（时间戳） */
+    memberCreatedAt: number;
+    /** 会员过期时间（时间戳） */
+    memberExpireAt: number;
+    /** 总积分 */
+    totalPoint: number;
+    /** 可用积分 */
+    availablePoint: number;
+    /** 已消费积分 */
+    consumedPoint: number;
+    /** 已过期积分 */
+    expiredPoint: number;
+    /** 冻结积分 */
+    frozenPoint: number;
+    /** 福利官用户ID */
+    welfareUserId: string;
+    /** 福利官用户名 */
+    welfareUserName: string;
+    /** 福利官状态 */
+    welfareStatus: string;
+    /** 优惠券总数 */
+    totalCouponCount: number;
+    /** 累计看播时长 */
+    cumulativeWatchDuration: string;
+    /** 首次看播时间 */
+    firstWatchTime: string;
+    /** 最近看播时间 */
+    lastWatchTime: string;
+    /** 累计消费金额（元） */
+    accumulatedConsumptionAmount: number;
+    /** 最近消费时间 */
+    lastConsumptionTime: string;
+    /** 首次消费时间 */
+    firstConsumptionTime: string;
+    /** 累计订单笔数 */
+    accumulatedOrderCount: number;
+    /** 创建时间（时间戳） */
+    createdAt: number;
+    /** 更新时间（时间戳） */
+    updatedAt: number;
+}

package/modules/userData/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@be-link/ecommerce-client-backend-service-node-sdk",
-  "version": "0.1.62",
+  "version": "0.1.64",
   "description": "EcommerceClientBackendService Node.js SDK",
   "main": "index.js",
   "types": "index.d.ts",
@@ -11,7 +11,7 @@
   },
   "dependencies": {
     "@be-link/ecommerce-volcengine-open-api-sdk": "1.0.11",
-    "@be-link/ecommerce-user-service-node-sdk": "0.0.26",
+    "@be-link/ecommerce-user-service-node-sdk": "0.1.76",
     "@fastify/request-context": "6.2.1",
     "axios": "1.13.2",
     "axios-retry": "4.0.0",

package/utils/http-copy.js

@@ -7,7 +7,7 @@
 //
 // declare module '@fastify/request-context' {
 //   interface RequestContextData {
-//     requestId?: string
+//     requestId: string
 //     traceMessageId?: string
 //   }
 // }

package/utils/http.d.ts

@@ -1,6 +1,6 @@
 declare module '@fastify/request-context' {
     interface RequestContextData {
-        requestId?: string;
+        requestId: string;
         traceMessageId?: string;
         pandoraUserId?: string;
         beLinkUserId?: string;