@polyv/product-sdk 1.2.0-rc-20250724.2 → 1.4.0-rc-20250904.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 分页参数
@@ -273,6 +273,14 @@ export declare interface FinanceProductData extends ProductBasicData, ProductLin
     yield: string;
 }
 
+export declare interface GetLaunchProductListParams {
+    pageNumber?: number;
+    pageSize?: number;
+    keyword?: string;
+    /** 在架状态 */
+    status?: ProductStatus;
+}
+
 /**
  * 获取订单详情参数
  */
@@ -326,6 +334,17 @@ export declare interface GetProductListParams {
     page?: number;
 }
 
+export declare interface LaunchProductListResult extends PageContent<ProductData> {
+    /**
+     * 上架数量
+     */
+    upCount: number;
+    /**
+     * 下架数量
+     */
+    downCount: number;
+}
+
 export declare type MaybePromise<R> = () => Promise<R> | R;
 
 /**
@@ -395,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;
@@ -406,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 获取参数
@@ -701,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 支付订单参数
@@ -788,12 +807,9 @@ export declare interface PositionProductData extends ProductBasicData, ProductLi
     treatment: string;
 }
 
-/**
- * 商品库 SDK 模块
- */
 export declare class Product {
-    iarCore: InteractionReceiveCore;
-    config: ProductSDKConfig;
+    interactionCore: InteractionCore;
+    config?: ProductSDKConfig | undefined;
     ProductType: typeof ProductType;
     ProductLinkType: typeof ProductLinkType;
     ProductLinkJumpWay: typeof ProductLinkJumpWay;
@@ -810,7 +826,7 @@ export declare class Product {
     private __currentPushingProductId;
     private __currentPushingProductPushRule;
     private __isPushingProduct;
-    constructor(iarCore: InteractionReceiveCore, config: ProductSDKConfig);
+    constructor(interactionCore: InteractionCore, config?: ProductSDKConfig | undefined);
     /* Excluded from this release type: __clearCurrentPushingProduct */
     /**
      * 获取商品标签列表
@@ -837,6 +853,11 @@ export declare class Product {
      * ```
      */
     getProductList(params?: GetProductListParams): Promise<ProductListResult>;
+    /**
+     * 获取商品列表（发起端）
+     * @param params 获取参数
+     */
+    getLaunchProductList(params: GetLaunchProductListParams): Promise<LaunchProductListResult>;
     /**
      * 获取商品数据
      * @param productId 商品 id
@@ -918,6 +939,7 @@ export declare class Product {
     /* Excluded from this release type: getCurrentPushingProductId */
     /**
      * 获取当前推送中的商品数据
+     * @param productId 可选，指定商品ID，如果不提供则获取当前配置中的推送商品
      * @example
      * ```js
      * const productData = await productTarget.getCurrentPushingProduct();
@@ -925,6 +947,120 @@ export declare class Product {
      * ```
      */
     getCurrentPushingProduct(productId?: number): Promise<ProductData | undefined>;
+    protected _explainProduct(productId: number, recordType: ProductExplainOperation): Promise<void | undefined>;
+    /**
+     * 开始商品讲解
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.startExplain(123);
+     * ```
+     */
+    startExplain(productId: number): Promise<void> | undefined;
+    /**
+     * 重新开始商品讲解
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.restartExplain(123);
+     * ```
+     */
+    restartExplain(productId: number): Promise<void> | undefined;
+    /**
+     * 结束商品讲解
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.endExplain(123);
+     * ```
+     */
+    endExplain(productId: number): Promise<void> | undefined;
+    /**
+     * 删除商品讲解
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.deleteExplain(123);
+     * ```
+     */
+    deleteExplain(productId: number): Promise<void>;
+    /**
+     * 获取当前正在讲解的商品 id
+     * @example
+     * ```js
+     * const productId = await productTarget.getCurrentProductExplain();
+     * console.log('当前正在讲解的商品 id', productId);
+     * ```
+     */
+    getCurrentProductExplain(): Promise<number | null>;
+    /**
+     * 商品开价
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.openProductPrice(123);
+     * ```
+     */
+    openProductPrice(productId: number): Promise<void>;
+    /**
+     * 商品隐藏价格
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.hideProductPrice(123);
+     * ```
+     */
+    hideProductPrice(productId: number): Promise<void>;
+    /**
+     * 获取商品设置
+     */
+    getProductSetting(): Promise<ProductSetting>;
+    /**
+     * 推送商品
+     * @param productId 商品 id
+     * @param rule 推送规则
+     * @example
+     * ```js
+     * await productTarget.pushProduct(123, ProductPushRule.SmallCard);
+     * ```
+     */
+    pushProduct(productId: number, rule?: ProductPushRule): Promise<void>;
+    /**
+     * 取消推送商品
+     * @param productId 商品 id
+     * @example
+     * ```js
+     * await productTarget.cancelPushProduct(123);
+     * ```
+     */
+    cancelPushProduct(productId: number): Promise<void>;
+    /**
+     * 批量删除商品
+     * @param productIds 商品 id 列表
+     * @example
+     * ```js
+     * await productTarget.batchDeleteProduct([123, 456]);
+     * ```
+     */
+    batchDeleteProduct(productIds: number[]): Promise<void>;
+    /**
+     * 批量上架商品
+     * @param productIds 商品 id 列表
+     * @example
+     * ```js
+     * await productTarget.batchOnShelfProduct([123, 456]);
+     * ```
+     */
+    batchOnShelfProduct(productIds: number[]): Promise<void>;
+    /**
+     * 批量下架商品
+     * @param productIds 商品 id 列表
+     * @example
+     * ```js
+     * await productTarget.batchOffShelfProduct([123, 456]);
+     * ```
+     */
+    batchOffShelfProduct(productIds: number[]): Promise<void>;
     /**
      * 判断当前用户是否支持直接购买商品
      * @example
@@ -1004,6 +1140,10 @@ export declare interface ProductBasicData {
      * 商品推送记录 id
      */
     pushLogId?: string;
+    /**
+     * 排序
+     */
+    rank: number;
     /**
      * 原始数据
      */
@@ -1053,7 +1193,7 @@ export declare interface ProductConfig {
     /**
      * 埋点上报总开关
      */
-    watchEventTrackEnabled: boolean;
+    watchEventTrackEnabled?: boolean;
     /**
      * 互动事件上报开关
      */
@@ -1065,7 +1205,7 @@ export declare interface ProductConfig {
     /**
      * 商品讲解开关
      */
-    productExplainEnabled: boolean;
+    productExplainEnabled?: boolean;
     /**
      * 商品热卖中开关
      */
@@ -1077,15 +1217,19 @@ export declare interface ProductConfig {
     /**
      * 点击商品的封面/标题区域是否直接跳转外链
      */
-    outLinkProductRedirectEnabled: boolean;
+    outLinkProductRedirectEnabled?: boolean;
     /**
      * 商品订单入口是否显示
      */
-    productPayOrderEnabled: boolean;
+    productPayOrderEnabled?: boolean;
     /**
      * 商品库链接跳转提示
      */
     productLinkJumpTipEnabled?: boolean;
+    /**
+     * 业务逻辑上是否允许直接购买
+     */
+    directBuyEnabled?: boolean;
 }
 
 /**
@@ -1107,61 +1251,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"
 }
@@ -1285,6 +1531,24 @@ export declare interface ProductExplainData {
     explainType?: ProductExplainType;
 }
 
+/**
+ * 商品讲解操作
+ */
+export declare const enum ProductExplainOperation {
+    /**
+     * 开始讲解
+     */
+    Start = "start",
+    /**
+     * 结束讲解
+     */
+    End = "end",
+    /**
+     * 重新讲解
+     */
+    Restart = "restart"
+}
+
 /**
  * 商品讲解状态
  */
@@ -1514,7 +1778,7 @@ export declare interface ProductSDKConfig {
     /**
      * 传入的商品配置
      */
-    getProductConfig: MaybePromise<ProductConfig>;
+    getProductConfig?: MaybePromise<ProductConfig>;
 }
 
 /**
@@ -1531,6 +1795,23 @@ export declare enum ProductServiceType {
     Custom = "custom"
 }
 
+/**
+ * 商品设置
+ */
+export declare interface ProductSetting {
+    /** 商品讲解开关 */
+    productExplainEnabled: boolean;
+    /** 商品讲解自动推送置顶 */
+    productExplainingAutoPushAndSticky: boolean;
+    /** 商品推送方式 */
+    productPushRule: ProductPushRule | 'chooseCard';
+    /** 推送中的商品 */
+    pushingProduct?: {
+        productId: number;
+        pushRule: ProductPushRule;
+    };
+}
+
 /**
  * 商品状态
  */
@@ -1542,7 +1823,7 @@ export declare enum ProductStatus {
     /**
      * 下架
      */
-    OffSale = 0
+    OffSale = 2
 }
 
 /**