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

package/package.json

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

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);
     }