add wxxd schemas, function, event

f-hk · web-flow · commit 45289fcf3d67 · 2025-12-18T20:26:42.000+08:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-puppet",
-  "version": "1.0.127",
+  "version": "1.0.128",
   "description": "Abstract Puppet for Wechaty",
   "type": "module",
   "exports": {
diff --git a/src/mixins/im-specific-mixin.ts b/src/mixins/im-specific-mixin.ts
@@ -5,6 +5,9 @@ import {
 import type { PuppetSkeleton } from '../puppet/puppet-skeleton.js'
 import type { ConsultCardListRequest, ConsultCardListResponse, ContactIdExternalUserIdPair, IntentCommentPayload, PaginationRequest, PaginationResponse, PremiumOnlineAppointmentCardListRequest, PremiumOnlineAppointmentCardListResponse } from '../schemas/mod.js'
 import type { CorpMessageInterceptionStrategy, RoomAntiSpamStrategy } from '../schemas/wecom.js'
+import type { WxxdShopPayload } from '../schemas/wxxd-shop.js'
+import type { WxxdProductPayload } from '../schemas/wxxd-product.js'
+import type { WxxdOrderPayload } from '../schemas/wxxd-order.js'
 
 const imSpecificMixin = <MixinBase extends typeof PuppetSkeleton>(mixinBase: MixinBase) => {
 
@@ -24,14 +27,23 @@ const imSpecificMixin = <MixinBase extends typeof PuppetSkeleton>(mixinBase: Mix
 
     abstract getCorpMessageInterceptionStrategies (): Promise<CorpMessageInterceptionStrategy[]>
 
-    // douyin
+    // 抖音
     abstract listConsultCards                  (query: ConsultCardListRequest)                  : Promise<ConsultCardListResponse>
     abstract listPremiumOnlineAppointmentCards (query: PremiumOnlineAppointmentCardListRequest) : Promise<PremiumOnlineAppointmentCardListResponse>
 
-    // xiaohongshu
+    // 小红书
     abstract listIntentComments (query: PaginationRequest): Promise<PaginationResponse<IntentCommentPayload[]>>
     abstract intentCommentPayload (id: string): Promise<IntentCommentPayload>
 
+    // 微信小店
+    abstract wxxdShopPayload(): Promise<WxxdShopPayload>
+
+    abstract listWxxdProducts(query: PaginationRequest): Promise<PaginationResponse<WxxdProductPayload[]>>
+    abstract wxxdProductPayload(productId: string): Promise<WxxdProductPayload>
+
+    abstract listWxxdOrders(query: PaginationRequest): Promise<PaginationResponse<WxxdOrderPayload[]>>
+    abstract wxxdOrderPayload(orderId: string): Promise<WxxdOrderPayload>
+
   }
 
   return ImSpecificMixin
diff --git a/src/mixins/message-mixin.ts b/src/mixins/message-mixin.ts
@@ -50,6 +50,8 @@ import type {
 } from '../schemas/consult-card.js'
 import type { CallRecordPayload } from '../schemas/call.js'
 import type { ChatHistoryPayload } from '../schemas/chat-history.js'
+import type { WxxdProductPayload } from '../schemas/wxxd-product.js'
+import type { WxxdOrderPayload } from '../schemas/wxxd-order.js'
 
 const filebox = (filebox: string | FileBoxInterface) => typeof filebox === 'string' ? FileBox.fromJSON(filebox) : filebox
 
@@ -84,6 +86,8 @@ const messageMixin = <MinxinBase extends typeof PuppetSkeleton & CacheMixin>(bas
     abstract messageChannelCard                   (messageId: string)                       : Promise<ChannelCardPayload>
     abstract messageConsultCard                   (messageId: string)                       : Promise<ConsultCardPayload>
     abstract messagePremiumOnlineAppointmentCard  (messageId: string)                       : Promise<PremiumOnlineAppointmentCardPayload>
+    abstract messageWxxdProduct                   (messageId: string)                       : Promise<WxxdProductPayload>
+    abstract messageWxxdOrder                     (messageId: string)                       : Promise<WxxdOrderPayload>
     abstract messageCallRecord                    (messageId: string)                       : Promise<CallRecordPayload>
     abstract messageChatHistory                   (messageId: string)                       : Promise<ChatHistoryPayload[]>
 
@@ -102,6 +106,8 @@ const messageMixin = <MinxinBase extends typeof PuppetSkeleton & CacheMixin>(bas
     // im-specific
     abstract messageSendPremiumOnlineAppointmentCard (conversationId: string, premiumOnlineAppointmentCardSendPayload : PremiumOnlineAppointmentCardSendPayload) : Promise<void | string>
     abstract messageSendDouyinOneClickPhoneCollection(conversationId: string, douyinOneClickPhoneCollectionSendPayload: {}) : Promise<void | string>
+    abstract messageSendWxxdProduct(conversationId: string, productId: string) : Promise<void | string>
+    abstract messageSendWxxdOrder(conversationId: string, orderId: string) : Promise<void | string>
 
     abstract messageRecall (messageId: string) : Promise<boolean>
 
@@ -334,6 +340,10 @@ const messageMixin = <MinxinBase extends typeof PuppetSkeleton & CacheMixin>(bas
           return this.messageSendChannelCard(conversationId, sayable.payload)
         case sayableTypes.PremiumOnlineAppointmentCard:
           return this.messageSendPremiumOnlineAppointmentCard(conversationId, sayable.payload)
+        case sayableTypes.WxxdProduct:
+          return this.messageSendWxxdProduct(conversationId, sayable.payload.productId)
+        case sayableTypes.WxxdOrder:
+          return this.messageSendWxxdOrder(conversationId, sayable.payload.orderId)
         default:
           throw new Error('unsupported sayable payload: ' + JSON.stringify(sayable))
       }
diff --git a/src/mixins/sayable-mixin.ts b/src/mixins/sayable-mixin.ts
@@ -78,6 +78,14 @@ const sayableMixin = <MixinBase extends typeof PuppetSkeleton & MessageMixin & P
           const premiumOnlineAppointmentCardPayload = await this.messagePremiumOnlineAppointmentCard(sayableId)
           return sayablePayloads.premiumOnlineAppointmentCard(premiumOnlineAppointmentCardPayload)
         }
+        case MessageType.WxxdProduct: {
+          const productId = await this.messageWxxdProduct(sayableId)
+          return sayablePayloads.wxxdProduct(productId)
+        }
+        case MessageType.WxxdOrder: {
+          const orderId = await this.messageWxxdOrder(sayableId)
+          return sayablePayloads.wxxdOrder(orderId)
+        }
         default:
           log.warn('PuppetSayableMixin',
             'sayablePayload() can not convert not re-sayable type: %s(%s) for %s\n%s',
diff --git a/src/puppet/events.ts b/src/puppet/events.ts
@@ -29,6 +29,8 @@ import type {
   EventIntentCommentPayload,
   EventContactEnterConversationPayload,
   EventContactLeadFilledPayload,
+  EventWxxdProductPayload,
+  EventWxxdOrderPayload,
 }                                 from '../schemas/event.js'
 
 export type PuppetDirtyListener        = (payload: EventDirtyPayload)       => void | Promise<void>
@@ -58,7 +60,9 @@ export type PuppetLoginUrlListener     = (payload: EventLoginUrlPayload)    => v
 export type PuppetIntentCommentListener     = (payload: EventIntentCommentPayload)    => void | Promise<void>
 export type PuppetContactEnterConversationListener     = (payload: EventContactEnterConversationPayload)    => void | Promise<void>
 export type PuppetContactLeadFilledListener     = (payload: EventContactLeadFilledPayload)    => void | Promise<void>
-
+export type PuppetWxxdShopListener     = () => void | Promise<void>
+export type PuppetWxxdProductListener     = (payload: EventWxxdProductPayload)    => void | Promise<void>
+export type PuppetWxxdOrderListener     = (payload: EventWxxdOrderPayload)    => void | Promise<void>
 export type PuppetStartListener      = () => void | Promise<void>
 export type PuppetStopListener       = () => void | Promise<void>
 
@@ -92,6 +96,9 @@ interface PuppetEventListener {
   'verify-slide'     : PuppetVerifySlideListener,
   'contact-enter-conversation'     : PuppetContactEnterConversationListener,
   'contact-lead-filled'     : PuppetContactLeadFilledListener,
+  'wxxd-shop'     : PuppetWxxdShopListener,
+  'wxxd-product'     : PuppetWxxdProductListener,
+  'wxxd-order'     : PuppetWxxdOrderListener,
 }
 
 const PuppetEventEmitter = EventEmitter as unknown as new () =>
diff --git a/src/schemas/event.ts b/src/schemas/event.ts
@@ -186,6 +186,13 @@ export interface EventContactLeadFilledPayload {
   }[],
   timestamp: number,
 }
+export interface EventWxxdProductPayload {
+  productId: string,
+}
+
+export interface EventWxxdOrderPayload {
+  orderId: string,
+}
 
 export type EventPayload =
   | EventDirtyPayload
@@ -215,3 +222,5 @@ export type EventPayload =
   | EventIntentCommentPayload
   | EventContactEnterConversationPayload
   | EventContactLeadFilledPayload
+  | EventWxxdProductPayload
+  | EventWxxdOrderPayload
diff --git a/src/schemas/message.ts b/src/schemas/message.ts
@@ -29,6 +29,8 @@ export enum MessageType {
   ChannelCard                  = 23,   // Channel Card
   ConsultCard                  = 24,   // Consult Card
   PremiumOnlineAppointmentCard = 25,   // Premium Online Appointment Card
+  WxxdProduct                  = 26,   // Wxxd Product
+  WxxdOrder                    = 27,   // Wxxd Order
 }
 
 /**
diff --git a/src/schemas/mod.ts b/src/schemas/mod.ts
@@ -84,6 +84,8 @@ import type {
   EventIntentCommentPayload,
   EventContactEnterConversationPayload,
   EventContactLeadFilledPayload,
+  EventWxxdProductPayload,
+  EventWxxdOrderPayload,
 }                             from './event.js'
 import {
   type RoomPayload,
@@ -185,6 +187,10 @@ import type {
   IntentCommentPayload,
 } from './xiaohongshu.js'
 
+import type { WxxdShopPayload } from './wxxd-shop.js'
+import type { WxxdProductPayload } from './wxxd-product.js'
+import type { WxxdOrderPayload } from './wxxd-order.js'
+
 export {
   CHAT_EVENT_DICT,
   ContactGender,
@@ -302,6 +308,11 @@ export {
   type TextContent,
   type CorpMessageInterceptionStrategy,
   type IntentCommentPayload,
+  type WxxdShopPayload,
+  type WxxdProductPayload,
+  type WxxdOrderPayload,
+  type EventWxxdProductPayload,
+  type EventWxxdOrderPayload,
   TagEventType,
   TagGroupEventType,
   TextContentType,
diff --git a/src/schemas/puppet.ts b/src/schemas/puppet.ts
@@ -37,6 +37,9 @@ export const CHAT_EVENT_DICT = {
   'verify-slide' : 'a verify slide is required',
   'contact-enter-conversation' : 'a contact enters the conversation',
   'contact-lead-filled' : 'a contact fills the lead card',
+  'wxxd-shop'     : 'received a new wxxd shop',
+  'wxxd-product'     : 'received a new wxxd product',
+  'wxxd-order'     : 'received a new wxxd order',
 }
 export type ChatEventName = keyof typeof CHAT_EVENT_DICT
 
diff --git a/src/schemas/sayable.ts b/src/schemas/sayable.ts
@@ -13,6 +13,8 @@ import type {
   SayablePayloadPost,
 }                                     from './post.js'
 import type { ConsultCardPayload, PremiumOnlineAppointmentCardPayload } from './consult-card.js'
+import type { WxxdProductPayload } from './wxxd-product.js'
+import type { WxxdOrderPayload } from './wxxd-order.js'
 
 const payloadContact     = (contactId: string)                      => ({ contactId })
 const payloadFilebox     = (filebox: string | FileBoxInterface)     => ({ filebox })
@@ -32,7 +34,8 @@ const payloadConsultCard                  = (consultCardPayload: ConsultCardPayl
 const payloadPremiumOnlineAppointmentCard = (premiumOnlineAppointmentCardPayload: PremiumOnlineAppointmentCardPayload) => ({
   ...premiumOnlineAppointmentCardPayload,
 })
-
+const payloadWxxdProduct                  = (wxxdProductPayload: WxxdProductPayload)                                   => ({ ...wxxdProductPayload })
+const payloadWxxdOrder                    = (wxxdOrderPayload: WxxdOrderPayload)                                   => ({ ...wxxdOrderPayload })
 /**
  * using `types` as a static typed string name list for `createAction`
  *
@@ -78,7 +81,8 @@ const channel                      = createAction(sayableTypes.Channel,
 const channelCard                  = createAction(sayableTypes.ChannelCard,                  payloadChannelCard)()
 const consultCard                  = createAction(sayableTypes.ConsultCard,                  payloadConsultCard)()
 const premiumOnlineAppointmentCard = createAction(sayableTypes.PremiumOnlineAppointmentCard, payloadPremiumOnlineAppointmentCard)()
-
+const wxxdProduct                  = createAction(sayableTypes.WxxdProduct,                  payloadWxxdProduct)()
+const wxxdOrder                    = createAction(sayableTypes.WxxdOrder,                    payloadWxxdOrder)()
 /**
  * Huan(202201): Recursive type references
  *  @link https://github.com/microsoft/TypeScript/pull/33050#issuecomment-1002455128
@@ -100,6 +104,8 @@ const sayablePayloadsNoPost = {
   channelCard,
   consultCard,
   premiumOnlineAppointmentCard,
+  wxxdProduct,
+  wxxdOrder,
 } as const
 
 /**
diff --git a/src/schemas/wxxd-order.ts b/src/schemas/wxxd-order.ts
@@ -0,0 +1,56 @@
+import type { WxxdExtraServicePayload } from './wxxd-product.js'
+
+export enum WxxdOrderStatus {
+  /** 待付款 */
+  Unpaid = 10,
+  /** 礼物待收下 */
+  GiftPending = 12,
+  /** 一起买待成团 */
+  GroupPending = 13,
+  /** 待发货（已付款） */
+  Paid = 20,
+  /** 部分发货 */
+  PartialDelivery = 21,
+  /** 待收货（已发货） */
+  Delivered = 30,
+  /** 已完成 */
+  Completed = 100,
+  /** 已取消（全部商品售后完成） */
+  Cancelled = 200,
+  /** 未付款用户主动取消或超时未付款订单自动取消 */
+  DepositPaid = 250,
+}
+
+export interface WxxdSkuAttrPayload {
+  attrKey: string;
+  attrValue: string;
+}
+
+export interface WxxdOrderExtInfoPayload {
+  customerNotes: string,
+  merchantNotes: string,
+}
+
+export interface WxxdOrderProductPayload {
+  productId: string,
+  skuId: string,
+  thumbImage: string,
+  salePrice: number,
+  skuCnt: number,
+  title: string,
+  marketPrice: number,
+  realPrice: number,
+  extraService: WxxdExtraServicePayload,
+  isDiscounted: boolean,
+  skuAttrs: WxxdSkuAttrPayload[],
+}
+
+export interface WxxdOrderPayload {
+  orderId: string,
+  openId: string,
+  status: WxxdOrderStatus,
+  createTime: number,
+  updateTime: number,
+  products: WxxdOrderProductPayload[],
+  extInfo: WxxdOrderExtInfoPayload,
+}
diff --git a/src/schemas/wxxd-product.ts b/src/schemas/wxxd-product.ts
@@ -0,0 +1,90 @@
+export enum WxxdSkuStatus {
+  /** 初始值 */
+  Initial = 0,
+  /** 上架中 */
+  OnSale = 5,
+  /** 已下架 */
+  OffShelf = 11,
+  /** 预售结束后的删除态 */
+  Deleted = 21,
+}
+
+export enum WxxdProductStatus {
+  /** 初始值 */
+  Initial = 0,
+  /** 编辑中 */
+  Editing = 1,
+  /** 审核中 */
+  Auditing = 2,
+  /** 审核失败 */
+  AuditFailed = 3,
+  /** 审核成功 */
+  AuditSuccess = 4,
+  /** 上架 */
+  OnSale = 5,
+  /** 回收站 */
+  Recycled = 6,
+  /** 商品异步提交，上传中 */
+  Uploading = 7,
+  /** 商品异步提交，上传失败 */
+  UploadFailed = 8,
+  /** 彻底删除，商品无法再进行任何操作 */
+  Deleted = 9,
+  /** 冻结，审核通过但是不能上架 */
+  Frozen = 10,
+  /** 自主下架 */
+  SelfOffShelf = 11,
+  /** 售罄下架 */
+  SoldOut = 12,
+  /** 违规下架/风控系统下架 */
+  ViolationOffShelf = 13,
+  /** 保证金不足下架 */
+  DepositInsufficient = 14,
+  /** 品牌过期下架 */
+  BrandExpired = 15,
+  /** 商品被封禁 */
+  Banned = 20,
+  /** SKU逻辑删除 */
+  SkuDeleted = 21,
+  /** 商品不存在 */
+  NotExist = 30,
+  /** 质检不通过 */
+  QualityCheckFailed = 71,
+}
+
+export interface WxxdDescInfoPayload {
+  desc: string,
+  imgs: string[],
+}
+
+export interface WxxdSkuPayload {
+  skuId: string,
+  outSkuId: string,
+  thumbImage: string,
+  salePrice: number,
+  stockNum: number,
+  skuCode: string,
+  status: WxxdSkuStatus,
+}
+
+export interface WxxdExtraServicePayload {
+  sevenDayReturn: number,
+  payAfterUse: number,
+  freightInsurance: number,
+  damageGuarantee: number,
+  fakeOnePayThree: number,
+  exchangeSupport: number,
+}
+
+export interface WxxdProductPayload {
+  productId: string,
+  title: string,
+  shortTitle: string,
+  headImgs: string[],
+  descInfo: WxxdDescInfoPayload,
+  status: WxxdProductStatus,
+  minPrice: number,
+  totalSoldNum: number,
+  skus: WxxdSkuPayload[],
+  extraService: WxxdExtraServicePayload,
+}
diff --git a/src/schemas/wxxd-shop.ts b/src/schemas/wxxd-shop.ts
@@ -0,0 +1,8 @@
+export interface WxxdShopPayload {
+  nickname: string,
+  headimgUrl: string,
+  subjectType: string,
+  status: string,
+  username: string,
+  openTimestamp: number,
+}
diff --git a/tests/fixtures/puppet-test/puppet-test.ts b/tests/fixtures/puppet-test/puppet-test.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@juzi/wechaty-puppet",`
`3`		`- "version": "1.0.127",`
	`3`	`+ "version": "1.0.128",`
`4`	`4`	`"description": "Abstract Puppet for Wechaty",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"exports": {`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ export enum MessageType {`
`29`	`29`	`ChannelCard = 23, // Channel Card`
`30`	`30`	`ConsultCard = 24, // Consult Card`
`31`	`31`	`PremiumOnlineAppointmentCard = 25, // Premium Online Appointment Card`
	`32`	`+ WxxdProduct = 26, // Wxxd Product`
	`33`	`+ WxxdOrder = 27, // Wxxd Order`
`32`	`34`	`}`
`33`	`35`
`34`	`36`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,9 @@ export const CHAT_EVENT_DICT = {`
`37`	`37`	`'verify-slide' : 'a verify slide is required',`
`38`	`38`	`'contact-enter-conversation' : 'a contact enters the conversation',`
`39`	`39`	`'contact-lead-filled' : 'a contact fills the lead card',`
	`40`	`+ 'wxxd-shop' : 'received a new wxxd shop',`
	`41`	`+ 'wxxd-product' : 'received a new wxxd product',`
	`42`	`+ 'wxxd-order' : 'received a new wxxd order',`
`40`	`43`	`}`
`41`	`44`	`export type ChatEventName = keyof typeof CHAT_EVENT_DICT`
`42`	`45`