@be-link/pos-cli-nodejs 1.0.234 → 1.0.236

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@be-link/pos-cli-nodejs",
-  "version": "1.0.234",
+  "version": "1.0.236",
   "description": "正向订单服务Nodejs客户端",
   "main": "index.js",
   "scripts": {

package/pos/modules/orderCore/service.test.js

@@ -17,6 +17,45 @@ jest.mock('../../http', () => ({
     callApi: (...args) => mockCallApi(...args),
 }));
 const service_1 = __importDefault(require("./service"));
+describe('OrderCoreService.sceneInfo advisorShare passthrough', () => {
+    beforeEach(() => {
+        mockCallApi.mockReset().mockResolvedValue({ tradeOrderId: 'order-1' });
+    });
+    const sceneInfo = {
+        scene1: '',
+        scene2: '',
+        appScene: 0,
+        advisorShare: { advisorId: '', cardId: 'card-1', shareAt: 0 },
+    };
+    it.each([
+        ['省略', undefined],
+        ['空对象', {}],
+        ['空字符串', { advisorId: '' }],
+        ['零时间戳', { shareAt: 0 }],
+        ['完整对象', { advisorId: 'advisor-1', cardId: 'card-1', shareAt: 123 }],
+    ])('orderCreate 透传 %s advisorShare', (_label, advisorShare) => __awaiter(void 0, void 0, void 0, function* () {
+        const request = {
+            basicInfo: {
+                sceneInfo: Object.assign({ scene1: '', scene2: '', appScene: 0 }, (advisorShare === undefined ? {} : { advisorShare })),
+            },
+        };
+        yield service_1.default.orderCreate(request);
+        expect(mockCallApi).toHaveBeenCalledWith(expect.stringMatching(/\/core\/order-create$/), request);
+        expect(mockCallApi.mock.calls[0][1].basicInfo.sceneInfo.advisorShare).toBe(advisorShare);
+    }));
+    it.each([
+        ['orderCreate', 'order-create', false],
+        ['storeOrderCreate', 'store-order-create', false],
+        ['orderCreateV2', 'order-create-v2', false],
+        ['depositOrderCreate', 'deposit-order-create', false],
+        ['depositOrderComplete', 'deposit-order-complete', true],
+    ])('%s 原样透传分享信息', (method, path, isComplete) => __awaiter(void 0, void 0, void 0, function* () {
+        const request = Object.assign({ basicInfo: { sceneInfo } }, (isComplete ? { depositOrderId: 'deposit-1' } : {}));
+        yield service_1.default[method](request);
+        expect(mockCallApi).toHaveBeenCalledWith(expect.stringMatching(new RegExp(`/core/${path}$`)), request);
+        expect(mockCallApi.mock.calls[0][1].basicInfo.sceneInfo.advisorShare).toBe(sceneInfo.advisorShare);
+    }));
+});
 describe('OrderCoreService.acknowledgeAutoConfirmedOrder', () => {
     beforeEach(() => {
         mockCallApi.mockReset().mockResolvedValue(undefined);

package/pos/modules/orderCore/types.d.ts

@@ -42,14 +42,7 @@ export declare namespace Service {
                 /** 实际支付 */
                 actuallyPaidFee: number;
                 /** 交易场景 */
-                sceneInfo: {
-                    /** 场景1 */
-                    scene1: string;
-                    /** 场景2 */
-                    scene2: string;
-                    /** app场景 */
-                    appScene: number;
-                };
+                sceneInfo: DTO.IOrderCreateSceneInfo;
                 /** 用户订单备注 */
                 orderNote?: string;
                 /** 来源人Id */
@@ -140,14 +133,7 @@ export declare namespace Service {
                 /** 实际支付 */
                 actuallyPaidFee: number;
                 /** 交易场景 */
-                sceneInfo: {
-                    /** 场景1 */
-                    scene1: string;
-                    /** 场景2 */
-                    scene2: string;
-                    /** app场景 */
-                    appScene: number;
-                };
+                sceneInfo: DTO.IOrderCreateSceneInfo;
                 /** 用户openId */
                 openId: string;
                 /** 来源人Id */
@@ -433,11 +419,7 @@ export declare namespace Service {
                 liveRoomId: string;
                 /** 实付金额（等于定金金额，单位：分） */
                 actuallyPaidFee: number;
-                sceneInfo?: {
-                    scene1: string;
-                    scene2: string;
-                    appScene: number;
-                };
+                sceneInfo?: DTO.IOrderCreateSceneInfo;
                 fromUnionId?: string;
                 fromUserRole?: string;
                 /** 预订人手机号 */

package/pos/modules/orderQuery/settlement.test.d.ts

@@ -0,0 +1 @@
+export {};

package/pos/modules/orderQuery/settlement.test.js

@@ -0,0 +1,43 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('../../http', () => ({ callApi: jest.fn() }));
+const http_1 = require("../../http");
+const pos_1 = require("vitality-meta/enums/pos");
+const user_1 = __importDefault(require("./user"));
+const mockedCallApi = http_1.callApi;
+describe('getOrderSettlementFacts', () => {
+    beforeEach(() => mockedCallApi.mockReset());
+    it.each([0, 2])('返回原始结算事实，保留 %s 份且不要求 attributes block', (remainQuantity) => __awaiter(void 0, void 0, void 0, function* () {
+        const facts = {
+            orderId: 'order-1',
+            status: pos_1.TradeOrderStatusEnum.SUCCEED,
+            remainQuantity,
+        };
+        mockedCallApi.mockResolvedValue(facts);
+        const request = { id: 'order-1' };
+        yield expect(user_1.default.getOrderSettlementFacts(request)).resolves.toBe(facts);
+        expect(mockedCallApi).toHaveBeenCalledWith(expect.stringMatching(/\/query\/user\/get-order-settlement-facts$/), request);
+    }));
+    it('未完结状态原样返回，由消费者决定重试', () => __awaiter(void 0, void 0, void 0, function* () {
+        const facts = { orderId: 'order-1', status: pos_1.TradeOrderStatusEnum.FULFILLING, remainQuantity: 1 };
+        mockedCallApi.mockResolvedValue(facts);
+        yield expect(user_1.default.getOrderSettlementFacts({ id: 'order-1' })).resolves.toEqual(facts);
+    }));
+    it('查询失败不使用零份数或缓存结果兜底', () => __awaiter(void 0, void 0, void 0, function* () {
+        const error = new Error('upstream unavailable');
+        mockedCallApi.mockRejectedValue(error);
+        yield expect(user_1.default.getOrderSettlementFacts({ id: 'order-1' })).rejects.toBe(error);
+    }));
+});

package/pos/modules/orderQuery/types.d.ts

@@ -3,6 +3,10 @@ import * as DTO from '../../../types';
 /** QueryByWeb 命名空间 */
 export declare namespace Service {
     namespace Request {
+        interface getOrderSettlementFacts {
+            /** 订单id */
+            id: string;
+        }
         interface getOrderById<K> {
             /** 订单id */
             id: string;
@@ -965,6 +969,13 @@ export declare namespace Service {
         }
     }
     namespace Response {
+        /** 查询时主库同一快照中的状态与主 ITEM 剩余份数，不是完结时快照。 */
+        interface getOrderSettlementFacts {
+            orderId: string;
+            status: PosConstants.TradeOrderStatusEnum;
+            /** 首个匹配主 ITEM 的剩余份数；无主 ITEM SKU 时取首个匹配商品行，零为有效值。 */
+            remainQuantity: number;
+        }
         interface mgetUserOrderCountList {
             /** 用户id: 数量 */
             [unionId: string]: number;
@@ -1296,6 +1307,12 @@ export declare namespace Service {
     }
     /**  用户维度查询 */
     interface QueryByUserController {
+        /**
+         * 查询当前主库结算事实，绕过缓存。调用方仅在 SUCCEED 时入账，入账后不因退款调整。
+         * 未完结订单原样返回状态；不存在或份数缺失/非法时抛错，不以零兜底。
+         * @path /query/user/get-order-settlement-facts
+         */
+        getOrderSettlementFacts(request: Request.getOrderSettlementFacts): Promise<Response.getOrderSettlementFacts>;
         /**
          * list开票记录
          * @returns 开票记录

package/pos/modules/orderQuery/user.d.ts

@@ -3,6 +3,7 @@ import { Service } from './types';
 import * as DTO from '../../../types';
 declare class QueryByUserService extends BaseService implements Service.QueryByUserController {
     protected prefixUrl: string;
+    getOrderSettlementFacts(request: Service.Request.getOrderSettlementFacts): Promise<Service.Response.getOrderSettlementFacts>;
     listOrderInvoiceCount(request: Service.Request.getOrderInvoiceRequest): Promise<number>;
     listOrderInvoice(request: Service.Request.getOrderInvoiceRequest): Promise<DTO.IPositiveOrderInvoice[]>;
     getOrderInvoiceByOrderId(request: any): Promise<DTO.IPositiveOrderInvoice>;

package/pos/modules/orderQuery/user.js

@@ -20,6 +20,9 @@ class QueryByUserService extends service_1.default {
         super(...arguments);
         this.prefixUrl = '/query/user';
     }
+    getOrderSettlementFacts(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.getOrderSettlementFacts), request);
+    }
     listOrderInvoiceCount(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.listOrderInvoiceCount), request);
     }

package/types.d.ts

@@ -8,6 +8,24 @@ import { ItemInfoProxy } from './utils/posProxy/itemInfoProxy';
 import { SkuInfoProxy } from './utils/posProxy/skuInfoProxy';
 import { VenueInfoProxy } from './utils/posProxy/venueInfoProxy';
 import { ComboInfoProxy } from './utils/posProxy/comboInfoProxy';
+/** 顾问分享信息；字段可省略，允许空字符串，是否有有效旅顾归属由业务判定。 */
+export interface IAdvisorShareInfo {
+    advisorId?: string;
+    cardId?: string;
+    shareAt?: number;
+}
+/** 订单场景信息（查询结果允许历史订单缺少场景层级）。 */
+export interface IOrderSceneInfo {
+    scene1?: string;
+    scene2?: string;
+    appScene: number;
+    advisorShare?: IAdvisorShareInfo;
+}
+/** 创建订单时必须提供一级、二级场景。 */
+export interface IOrderCreateSceneInfo extends IOrderSceneInfo {
+    scene1: string;
+    scene2: string;
+}
 /**
  * 订单正向结构
  */
@@ -59,14 +77,7 @@ export interface IPositiveOrder {
     /** 快照:关联主单ID */
     rootOrderId: string;
     /** 快照:下单场景信息 */
-    sceneInfo: {
-        /** 一级场景 */
-        scene1?: string;
-        /** 二级场景 */
-        scene2?: string;
-        /** 小程序场景值 */
-        appScene: number;
-    };
+    sceneInfo: IOrderSceneInfo;
     /** 联系人信息 */
     contactInfo: {
         /** 姓名 */

package/types.test.js

@@ -8,6 +8,42 @@ const isAutoConfirmedOrder = 1;
 const isSupplierAcknowledged = 0;
 // @ts-expect-error 原始订单结构中的布尔属性统一映射为数值
 const invalidIsAutoConfirmedOrder = true;
+// These assignments and @ts-expect-error checks run through tsc/ts-jest, not just Jest assertions.
+const advisorShare = { advisorId: '', cardId: '', shareAt: 0 };
+const createScene = { scene1: '', scene2: '', appScene: 0, advisorShare };
+const createV2Scene = createScene;
+const depositScene = createScene;
+const completeScene = createScene;
+const storedScene = { appScene: 0, advisorShare: {} };
+const legacyScene = { scene1: '', scene2: '', appScene: 0 };
+const legacyStoredScene = { appScene: 0 };
+const optionalDepositScene = undefined;
+// @ts-expect-error Share timestamps must be numeric.
+const invalidShareAt = { shareAt: '123' };
+// @ts-expect-error null is not a supported share value.
+const invalidNullShare = { advisorId: null };
+// @ts-expect-error null is not a supported scene share value.
+const invalidSceneShare = { appScene: 0, advisorShare: null };
+// @ts-expect-error New order requests still require scene1.
+const invalidCreateScene = { scene2: '', appScene: 0 };
+// @ts-expect-error Deposit creation still requires scene2 if sceneInfo is present.
+const invalidDepositScene = { scene1: '', appScene: 0 };
+describe('订单场景类型', () => {
+    it('支持空串、部分分享信息与历史订单场景', () => {
+        expect(createV2Scene.advisorShare).toBe(advisorShare);
+        expect(depositScene.advisorShare).toBe(advisorShare);
+        expect(completeScene.advisorShare).toBe(advisorShare);
+        expect(storedScene.advisorShare).toEqual({});
+        expect(legacyScene.advisorShare).toBeUndefined();
+        expect(legacyStoredScene.scene1).toBeUndefined();
+        expect(optionalDepositScene).toBeUndefined();
+        expect(invalidShareAt.shareAt).toBe('123');
+        expect(invalidNullShare.advisorId).toBeNull();
+        expect(invalidSceneShare.advisorShare).toBeNull();
+        expect(invalidCreateScene.scene1).toBeUndefined();
+        expect(invalidDepositScene.scene2).toBeUndefined();
+    });
+});
 describe('订单属性类型', () => {
     it('IPositiveAttributes 声明布尔字段，IRawOrderStructure 映射为数值字段', () => {
         expect(positiveAttributes.isAutoConfirmedOrder).toBe(true);