@polyv/product-sdk 1.3.0-rc-20250814.1 → 1.5.0-rc-20250925.1

package/index.es.d.ts

@@ -1,15 +1,15 @@
-import { CommonResult } from '@polyv/iar-core-sdk';
+import { CommonResult } from '@polyv/interaction-core';
 import { EventEmitter } from '@polyv/utils/es/event';
-import { InteractionReceiveCore } from '@polyv/iar-core-sdk';
+import { InteractionCore } from '@polyv/interaction-core';
 import { LinkJumpWay } from '@polyv/utils/es/external-link';
 import { LinkType } from '@polyv/utils/es/external-link';
-import { PageContent } from '@polyv/iar-core-sdk';
-import { PageOptions } from '@polyv/iar-core-sdk';
+import { PageContent } from '@polyv/interaction-core';
+import { PageOptions } from '@polyv/interaction-core';
 
 export declare class Address {
-    iarCore: InteractionReceiveCore;
+    interactionCore: InteractionCore;
     config: ProductSDKConfig;
-    constructor(iarCore: InteractionReceiveCore, config: ProductSDKConfig);
+    constructor(interactionCore: InteractionCore, config: ProductSDKConfig);
     /**
      * 获取地址列表
      * @param params 分页参数
@@ -414,7 +414,7 @@ export declare interface NormalProductData extends ProductBasicData, ProductLink
 }
 
 export declare class Order {
-    iarCore: InteractionReceiveCore;
+    interactionCore: InteractionCore;
     config: ProductSDKConfig;
     OrderStatus: typeof OrderStatus;
     PayStatus: typeof PayStatus;
@@ -425,7 +425,7 @@ export declare class Order {
     RefundStatus: typeof RefundStatus;
     CreateOrderFailReason: typeof CreateOrderFailReason;
     OrderRefundFailReason: typeof OrderRefundFailReason;
-    constructor(iarCore: InteractionReceiveCore, config: ProductSDKConfig);
+    constructor(interactionCore: InteractionCore, config: ProductSDKConfig);
     /**
      * 获取订单列表
      * @param params 获取参数
@@ -720,10 +720,10 @@ export declare interface OrderWaitPayData extends OrderBasicData {
 }
 
 export declare class Payment {
-    iarCore: InteractionReceiveCore;
+    interactionCore: InteractionCore;
     config: ProductSDKConfig;
     PaymentProvider: typeof PaymentProvider;
-    constructor(iarCore: InteractionReceiveCore, config: ProductSDKConfig);
+    constructor(interactionCore: InteractionCore, config: ProductSDKConfig);
     /**
      * 获取微信/支付宝支付参数
      * @param options 支付订单参数
@@ -807,11 +807,8 @@ export declare interface PositionProductData extends ProductBasicData, ProductLi
     treatment: string;
 }
 
-/**
- * 商品库 SDK 模块
- */
 export declare class Product {
-    iarCore: InteractionReceiveCore;
+    interactionCore: InteractionCore;
     config?: ProductSDKConfig | undefined;
     ProductType: typeof ProductType;
     ProductLinkType: typeof ProductLinkType;
@@ -825,11 +822,13 @@ export declare class Product {
     ProductDeliveryType: typeof ProductDeliveryType;
     ProductServiceType: typeof ProductServiceType;
     ProductPushRule: typeof ProductPushRule;
+    ProductMoveOperation: typeof ProductMoveOperation;
+    ProductSortType: typeof ProductSortType;
     eventEmitter: EventEmitter<ProductEventsRelations, ProductEvents>;
     private __currentPushingProductId;
     private __currentPushingProductPushRule;
     private __isPushingProduct;
-    constructor(iarCore: InteractionReceiveCore, config?: ProductSDKConfig | undefined);
+    constructor(interactionCore: InteractionCore, config?: ProductSDKConfig | undefined);
     /* Excluded from this release type: __clearCurrentPushingProduct */
     /**
      * 获取商品标签列表
@@ -942,6 +941,7 @@ export declare class Product {
     /* Excluded from this release type: getCurrentPushingProductId */
     /**
      * 获取当前推送中的商品数据
+     * @param productId 可选，指定商品ID，如果不提供则获取当前配置中的推送商品
      * @example
      * ```js
      * const productData = await productTarget.getCurrentPushingProduct();
@@ -986,6 +986,15 @@ export declare class Product {
      * ```
      */
     deleteExplain(productId: number): Promise<void>;
+    /**
+     * 获取当前正在讲解的商品 id
+     * @example
+     * ```js
+     * const productId = await productTarget.getCurrentProductExplain();
+     * console.log('当前正在讲解的商品 id', productId);
+     * ```
+     */
+    getCurrentProductExplain(): Promise<number | null>;
     /**
      * 商品开价
      * @param productId 商品 id
@@ -1008,6 +1017,14 @@ export declare class Product {
      * 获取商品设置
      */
     getProductSetting(): Promise<ProductSetting>;
+    /**
+     * 更新商品设置
+     * @param {Object} params
+     * @param {boolean} params.productExplainEnabled 商品讲解开关
+     * @param {boolean} params.productExplainingAutoPushAndSticky 讲解自动置顶
+     * @param {boolean} params.hideProductPriceEnabled 隐藏商品价格
+     */
+    updateProductSetting(params: Partial<ProductSetting>): Promise<void>;
     /**
      * 推送商品
      * @param productId 商品 id
@@ -1054,6 +1071,85 @@ export declare class Product {
      * ```
      */
     batchOffShelfProduct(productIds: number[]): Promise<void>;
+    /**
+     * 商品置顶
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.topProduct(123);
+     * ```
+     */
+    topProduct(productId: number): Promise<void>;
+    /**
+     * 取消商品置顶
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.cancelTopProduct(123);
+     * ```
+     */
+    cancelTopProduct(productId: number): Promise<void>;
+    /**
+     * 设为售罄
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.setProductSoldOut(123);
+     * ```
+     */
+    setProductSoldOut(productId: number): Promise<void>;
+    /**
+     * 取消售罄
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.cancelProductSoldOut(123);
+     * ```
+     */
+    cancelProductSoldOut(productId: number): Promise<void>;
+    /**
+     * 获取商品库开关
+     * @example
+     * ```js
+     * const enabled = await productTarget.getProductEnabled();
+     * console.log('商品库开关', enabled);
+     * ```
+     */
+    getProductEnabled(): Promise<boolean>;
+    /**
+     * 更新商品库开关
+     * @param enabled true | false
+     * @example
+     * ```js
+     * await productTarget.updateProductEnabled(true);
+     * ```
+     */
+    updateProductEnabled(enabled: boolean): Promise<void>;
+    /**
+     * 修改商品排序
+     * @param {object} params
+     * @param {number} params.productId 商品 id
+     * @param {number} params.rank 排序值
+     * @example
+     * ```js
+     * await productTarget.updateProductSort({ productId: 123, rank: 1 });
+     * ```
+     */
+    updateProductSort(params: {
+        productId: number;
+        rank: number;
+    }): Promise<void>;
+    /**
+     * 上移/下移商品
+     * @param productId 商品 id
+     * @param {ProductMoveOperation} operation 操作类型
+     * @example
+     * ```js
+     * await productTarget.moveProduct(123, ProductMoveOperation.MoveUp);
+     * await productTarget.moveProduct(456, ProductMoveOperation.MoveDown);
+     * ```
+     */
+    moveProduct(productId: number, operation: ProductMoveOperation): Promise<void>;
     /**
      * 判断当前用户是否支持直接购买商品
      * @example
@@ -1141,6 +1237,10 @@ export declare interface ProductBasicData {
      * 原始数据
      */
     originalData?: unknown;
+    /**
+     * 置顶中
+     */
+    topping?: boolean;
 }
 
 /**
@@ -1244,61 +1344,163 @@ export declare enum ProductDeliveryType {
     Virtual = "virtual"
 }
 
+/**
+ * 商品事件
+ * @eventenum {@link ProductEventsRelations}
+ */
 export declare enum ProductEvents {
     /**
      * 上架商品
+     * @description 当商品上架时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.OnSaleProduct, (data) => {
+     *   console.log('商品数据', data.productData);
+     * });
+     * ```
      */
     OnSaleProduct = "OnSaleProduct",
     /**
      * 下架商品
+     * @description 当商品下架时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.OffSaleProduct, (data) => {
+     *   console.log('商品数据', data.productData);
+     * });
+     * ```
      */
     OffSaleProduct = "OffSaleProduct",
     /**
      * 添加商品
+     * @description 当商品添加时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.AddProduct, (data) => {
+     *   console.log('商品数据', data.productData);
+     * });
+     * ```
      */
     AddProduct = "AddProduct",
     /**
      * 删除商品
+     * @description 当商品删除时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.DeleteProduct, (data) => {
+     *   console.log('商品 id', data.productId);
+     * });
+     * ```
      */
     DeleteProduct = "DeleteProduct",
     /**
      * 修改商品
+     * @description 当商品修改时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.ChangeProduct, (data) => {
+     *   console.log('商品数据', data.productData);
+     * });
+     * ```
      */
     ChangeProduct = "ChangeProduct",
     /**
      * 上移或下移商品
+     * @description 当商品上移或下移时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.MoveProduct, (data) => {
+     *   console.log('发生改变的两个商品', data.targetProducts);
+     * });
+     * ```
      */
     MoveProduct = "MoveProduct",
     /**
      * 修改商品排序
+     * @description 当商品排序修改时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.ChangeProductRank, (data) => {
+     *   console.log('商品数据', data.productData);
+     * });
+     * ```
      */
     ChangeProductRank = "ChangeProductRank",
     /**
      * 商品售罄
+     * @description 当商品售罄时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.ProductSoldOut, (data) => {
+     *   console.log('商品 id', data.productId);
+     * });
+     * ```
      */
     ProductSoldOut = "ProductSoldOut",
     /**
      * 推送商品
+     * @description 当商品推送时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.PushProduct, (data) => {
+     *   console.log('商品数据', data.productData);
+     * });
+     * ```
      */
     PushProduct = "PushProduct",
     /**
      * 取消推送商品
+     * @description 当商品取消推送时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.CancelPushProduct, (data) => {
+     *   console.log('商品 id', data.productId);
+     * });
+     * ```
      */
     CancelPushProduct = "CancelPushProduct",
     /**
      * 商品库列表开关
+     * @description 当商品库列表开关时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.ProductListEnabled, (data) => {
+     *   console.log('开启或关闭', data.enabled);
+     * });
+     * ```
      */
     ProductListEnabled = "ProductListEnabled",
     /**
      * 刷新当前商品列表
+     * @description 当商品列表刷新时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.RefreshProductList, (data) => {
+     *   console.log('商品列表', data.productList);
+     * });
+     * ```
      */
     RefreshProductList = "RefreshProductList",
     /**
      * 商品点击事件
+     * @description 当商品点击时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.ProductClick, (data) => {
+     *   console.log('商品 id', data.productId);
+     * });
+     * ```
      */
     ProductClick = "ProductClick",
     /**
      * 商品点击次数统计事件
+     * @description 当点击次数发生改变时，会触发该事件
+     * @example
+     * ```js
+     * productTarget.eventEmitter.on(ProductEvents.ProductClickTimes, (data) => {
+     *   console.log('商品 id', data.productId);
+     * });
+     * ```
      */
     ProductClickTimes = "ProductClickTimes"
 }
@@ -1623,6 +1825,20 @@ export declare enum ProductMediaType {
     MaterialVideo = "material-video"
 }
 
+/**
+ * 商品移动操作
+ */
+export declare enum ProductMoveOperation {
+    /**
+     * 上移
+     */
+    MoveUp = "moveUp",
+    /**
+     * 下移
+     */
+    MoveDown = "moveDown"
+}
+
 /**
  * 商品价格类型
  */
@@ -1696,6 +1912,10 @@ export declare interface ProductSetting {
     productExplainingAutoPushAndSticky: boolean;
     /** 商品推送方式 */
     productPushRule: ProductPushRule | 'chooseCard';
+    /** 隐藏商品价格开关 */
+    hideProductPriceEnabled: boolean;
+    /** 商品排序方式  */
+    productListSortType: ProductSortType;
     /** 推送中的商品 */
     pushingProduct?: {
         productId: number;
@@ -1703,6 +1923,20 @@ export declare interface ProductSetting {
     };
 }
 
+/**
+ * 商品排序方式
+ */
+export declare enum ProductSortType {
+    /**
+     * 升序
+     */
+    Asc = "ASC",
+    /**
+     * 降序（默认排序）
+     */
+    Desc = "DESC"
+}
+
 /**
  * 商品状态
  */