@polyv/product-sdk 1.8.0 → 1.9.0

package/index.es.d.ts

@@ -4,6 +4,7 @@ import { InteractionCore } from '@polyv/interaction-core';
 import { LinkJumpWay } from '@polyv/utils/es/external-link';
 import { PageContent } from '@polyv/interaction-core';
 import { PageOptions } from '@polyv/interaction-core';
+import { YN } from '@polyv/interaction-core';
 
 export declare class Address {
     interactionCore: InteractionCore;
@@ -276,6 +277,13 @@ export declare interface EditAddressParams extends AddressBasicData {
     id: string;
 }
 
+/**
+ * 生成商品数据
+ * @param internalData 内部商品数据
+ * @returns 商品数据
+ */
+export declare function filterInternalData(internalData: InternalProductData): ProductData;
+
 /**
  * 金融商品数据
  */
@@ -298,6 +306,12 @@ export declare interface GetLaunchProductListParams {
     status?: ProductStatus;
 }
 
+export declare interface GetLaunchProductTagListParams {
+    pageNumber?: number;
+    pageSize?: number;
+    keyword?: string;
+}
+
 /**
  * 获取订单详情参数
  */
@@ -351,6 +365,100 @@ export declare interface GetProductListParams {
     page?: number;
 }
 
+/**
+ * 内部商品数据
+ */
+declare interface InternalProductData extends ProductLinkData, ProductExplainData {
+    /** 商品 id */
+    productId: number;
+    /** 封面 */
+    cover: string;
+    /** 名称 */
+    name: string;
+    /** 描述 */
+    productDesc: string;
+    /** 详情 */
+    productDetail: string;
+    /** 状态 */
+    status: ProductStatus;
+    /** 序号 */
+    showId: number;
+    /** 序号（管理端用） */
+    rank: number;
+    /** 按钮文案 */
+    btnShow: string;
+    /** 特色标签 json 字符串 */
+    features: string;
+    /** 商品类型 */
+    productType: ProductType;
+    /** 原价 */
+    price: number;
+    /** 原价类型 */
+    originalPriceType: ProductPriceType;
+    /** 自定义原价 */
+    customOriginalPrice: string;
+    /** 价格类型 */
+    priceType: ProductPriceType;
+    /** 推送规则 */
+    productPushRule?: ProductPushRule;
+    /** 商品推送记录 id */
+    logId?: string;
+    /** 其他数据，有 coverList、videoList、jumpWay */
+    ext?: string;
+    /** 购买类型 */
+    buyType: ProductBuyType;
+    /** 价格 */
+    realPrice: number;
+    /** 自定义价格 */
+    customPrice: string;
+    /** 是否开价 */
+    openPriceEnable: YN;
+    /** 履约方式 */
+    deliveryType: ProductDeliveryType;
+    /** 客服联系方式(二维码图片地址), 渠道码被删除则没有值 */
+    customerServiceContact: string;
+    /** 客服方式 */
+    customerServiceType: ProductServiceType;
+    /** 是否显示售罄 */
+    markAsSoldout: YN;
+    /** 库存开关 */
+    stockEnabled: YN;
+    /** 库存 */
+    stock: number;
+    /** 收益率 */
+    yield: string;
+    /** 参数，里面有薪资待遇 */
+    params: string;
+    /** 是否已置顶 */
+    toppingEnable: YN;
+    /** AI 手卡 json */
+    aiCard: string;
+    /** 商品来源 */
+    productOrigin: ProductOrigin;
+    /** 版本号 */
+    version: ProductVersion;
+    /** 商品讲解次数 */
+    productExplainNum: number;
+    /** 商品标签 */
+    tags?: InternalProductTagItem[];
+}
+
+declare type InternalProductPayload = Omit<InternalProductData, 'productId' | 'showId' | 'rank' | 'logId' | 'productExplainNum' | 'tags'> & Partial<Pick<InternalProductData, 'productId' | 'showId' | 'rank' | 'logId' | 'productExplainNum' | 'tags'>>;
+
+declare interface InternalProductTagItem {
+    id: number;
+    name: string;
+}
+
+declare interface InternalProductTagItem {
+    channelId: number;
+    id: number;
+    name: string;
+    type: string;
+    createTime: number;
+    updateTime: number;
+}
+
 export declare interface LaunchProductListResult extends PageContent<ProductData> {
     /**
      * 上架数量
@@ -736,6 +844,13 @@ export declare interface OrderWaitPayData extends OrderBasicData {
     expiredAt: number;
 }
 
+/**
+ * 格式化特色标签
+ */
+export declare function parseFeature(features: string): string[];
+
+export declare function parseTags(tags?: InternalProductTagItem[]): ProductTagItem[];
+
 export declare class Payment {
     interactionCore: InteractionCore;
     config: ProductSDKConfig;
@@ -917,12 +1032,13 @@ export declare class Product {
      * 保存商品 AI 手卡内容（发起端）
      * @param {number} productId 商品 ID
      * @param {string} aiCardContent AI 手卡内容
+     * @param {boolean} sendSocket 是否发送 socket 更新
      * @example
      * ```js
-     * await productTarget.UpdateProductAiCardContent(123, '新的 AI 手卡内容');
+     * await productTarget.updateProductAiCardContent(123, '新的 AI 手卡内容');
      * ```
      */
-    UpdateProductAiCardContent(productId: number, aiCardContent: string): Promise<void>;
+    updateProductAiCardContent(productId: number, aiCardContent: string, sendSocket?: boolean): Promise<void>;
     /**
      * 获取商品数据
      * @param productId 商品 id
@@ -938,6 +1054,43 @@ export declare class Product {
      * ```
      */
     getLaunchProductData(productId: number): Promise<ProductData>;
+    /**
+     * 获取商品标签数据（发起端）
+     * @param params 请求参数
+     * @example
+     * ```js
+     * const res = await productTarget.getLaunchProductTagList({ pageNumber: 1, pageSize: 10 });
+     * console.log(res.contents);
+     * ```
+     */
+    getLaunchProductTagList(params: GetLaunchProductTagListParams): Promise<PageContent<ProductTagItem>>;
+    /**
+     * 创建商品标签（发起端）
+     * @param name 标签名称
+     * @example
+     * ```js
+     * const tag = await productTarget.createProductTag('新品');
+     * ```
+     */
+    createProductTag(name: string): Promise<ProductTagItem>;
+    /**
+     * 创建商品
+     * @param data 商品数据
+     * @example
+     * ```js
+     * await productTarget.createProduct(productData);
+     * ```
+     */
+    createProduct(data: ProductData): Promise<void>;
+    /**
+     * 更新商品
+     * @param data 商品数据
+     * @example
+     * ```js
+     * await productTarget.updateProduct(productData);
+     * ```
+     */
+    updateProduct(data: ProductData): Promise<void>;
     /**
      * 发送商品点击事件
      *
@@ -1349,6 +1502,10 @@ export declare interface ProductBasicData {
      * 版本号
      */
     version: ProductVersion;
+    /**
+     * 商品标签
+     */
+    tags: ProductTagItem[];
 }
 
 /**
@@ -2149,6 +2306,20 @@ export declare interface ProductTag {
     name: string;
 }
 
+/**
+ * 商品标签数据
+ */
+export declare interface ProductTagItem {
+    /**
+     * 标签名称
+     */
+    label: string;
+    /**
+     * 标签 id
+     */
+    value: number;
+}
+
 /**
  * 商品类型
  */
@@ -2207,6 +2378,14 @@ export declare enum RefundStatus {
     Processing = "PROCESSING"
 }
 
+export declare function restoreInternalData(productData: ProductData, mode?: RestoreMode): Partial<InternalProductPayload>;
+
+/**
+ * 还原内部商品数据
+ * @param productData 商品数据
+ */
+declare type RestoreMode = 'create' | 'update';
+
 export declare interface SendProductClickParams {
     /**
      * 商品 id