feat: add comment and list related method and interface

src/mod.ts

@@ -98,6 +98,12 @@ import type {
 import type {
   MiniProgramPayload,
 }                             from './schemas/mini-program.js'
+import type {
+  CommentPayload,
+}                             from './schemas/comment.js'
+import type {
+  ListOption,
+}                             from './schemas/list.js'
 
 import type {
   PuppetOptions,
@@ -159,6 +165,8 @@ export type {
   RoomPayload,
   RoomQueryFilter,
   UrlLinkPayload,
+  CommentPayload,
+  ListOption,
 }
 
 export {

src/puppet.ts

@@ -78,13 +78,19 @@ import type {
 import type {
   MiniProgramPayload,
 }                                 from './schemas/mini-program.js'
+import type {
+  ListOption,
+}             from './schemas/list.js'
+import type {
+  CommentPayload,
+}         from './schemas/comment.js'
 import {
   PuppetOptions,
   YOU,
 }                                 from './schemas/puppet.js'
-import { PayloadType }             from './schemas/payload.js'
+import { PayloadType }            from './schemas/payload.js'
 
-import { PuppetEventEmitter }      from './events.js'
+import { PuppetEventEmitter }     from './events.js'
 
 const DEFAULT_WATCHDOG_TIMEOUT = 60
 let   PUPPET_COUNTER           = 0
@@ -504,6 +510,25 @@ export abstract class Puppet extends PuppetEventEmitter {
   abstract tagContactList ()                                   : Promise<string[]>
   abstract tagContactRemove (tagId: string, contactId: string) : Promise<void>
 
+  /**
+   *
+   * Comment
+   *
+   */
+  abstract comment (messageId: string, content: string)         : Promise<CommentPayload>
+  abstract replyComment (commentId: string, content: string)    : Promise<CommentPayload>
+  abstract revokeComment (commentId: string)                    : Promise<boolean>
+  abstract listComments (messageId: string, option: ListOption) : Promise<boolean>
+
+  /**
+   *
+   * Like
+   *
+   */
+  abstract like (messageId: string)                             : Promise<boolean>
+  abstract cancel (messageId: string)                           : Promise<boolean>
+  abstract listLikes (messageId: string, option: ListOption) : Promise<boolean>
+
   /**
    *
    * Contact

src/schemas/comment.ts

@@ -0,0 +1,7 @@
+export interface CommentPayload {
+  id?       : string,
+  content   : string,
+  creatorId : string,
+  messageId : string,
+  replyId?  : string, // replied comment id
+}

src/schemas/list.ts

@@ -0,0 +1,4 @@
+export interface ListOption {
+  pageSize: number,
+  currentPage: number,
+}

tests/fixtures/puppet-test/puppet-test.ts

@@ -13,6 +13,8 @@ import {
   RoomMemberPayload,
   RoomQueryFilter,
   ContactQueryFilter,
+  CommentPayload,
+  ListOption,
 }                           from '../../../src/mod.js'
 
 /**
@@ -126,6 +128,25 @@ class PuppetTest extends Puppet {
    */
   override async conversationReadMark (conversationId: string, hasRead?: boolean): Promise<void | boolean> { void { conversationId, hasRead } }
 
+  /**
+   *
+   * Comment
+   *
+   */
+  override async comment (messageId: string, content: string)         : Promise<CommentPayload> { return { messageId, content} as any }
+  override async replyComment (commentId: string, content: string)    : Promise<CommentPayload> { return { commentId, content} as any }
+  override async revokeComment (commentId: string)                    : Promise<boolean> { return { commentId } as any }
+  override async listComments (messageId: string, option: ListOption) : Promise<boolean> { return { messageId, option} as any }
+
+  /**
+   *
+   * Like
+   *
+   */
+  override async like (messageId: string)                          : Promise<boolean> { return { messageId } as any}
+  override async cancel (messageId: string)                        : Promise<boolean> { return { messageId } as any}
+  override async listLikes (messageId: string, option: ListOption) : Promise<boolean> { return { messageId, option } as any}
+
   /**
    *
    * Room Invitation

tests/fixtures/smoke-testing.ts

@@ -23,6 +23,8 @@ import {
 
   UrlLinkPayload,
   MiniProgramPayload,
+  CommentPayload,
+  ListOption,
 
   VERSION,
 }                             from 'wechaty-puppet'
@@ -121,6 +123,26 @@ class PuppetTest extends Puppet {
    */
   override async conversationReadMark (conversationId: string, hasRead?: boolean) : Promise<void | boolean> { void conversationId, void hasRead }
 
+  /**
+   *
+   * Comment
+   *
+   */
+  override async comment (messageId: string, content: string)         : Promise<CommentPayload> { return { messageId, content} as any }
+  override async replyComment (commentId: string, content: string)    : Promise<CommentPayload> { return { commentId, content} as any }
+  override async revokeComment (commentId: string)                    : Promise<boolean> { return { commentId } as any }
+  override async listComments (messageId: string, option: ListOption) : Promise<boolean> { return { messageId, option} as any }
+
+  /**
+   *
+   * Like
+   *
+   */
+  override async like (messageId: string)                          : Promise<boolean> { return { messageId } as any}
+  override async cancel (messageId: string)                        : Promise<boolean> { return { messageId } as any}
+  override async listLikes (messageId: string, option: ListOption) : Promise<boolean> { return { messageId, option } as any}
+
+
   /**
    *
    * Room Invitation