wechaty-puppet/src/mixins/tap-mixin.ts

Abstract Puppet for Wechaty

import {
  log,
}                       from '../config.js'

import type {
  TapPayload,
  TapQueryFilter,
  TapType,
}                                 from '../schemas/tap.js'

import type { PuppetSkeleton }    from '../puppet/puppet-skeleton.js'

import type { CacheMixin }        from './cache-mixin.js'
import type {
  PaginationRequest,
  PaginationResponse,
}                           from '../schemas/pagination.js'

const tapMixin = <MinxinBase extends typeof PuppetSkeleton & CacheMixin>(baseMixin: MinxinBase) => {

  abstract class TapMixin extends baseMixin {

    constructor (...args: any[]) {
      super(...args)
      log.verbose('TapMixin', 'constructor()')
    }

    /**
     * 1. Query whether the bot has tapped the post (any types).
     * 2. Query whether the bot has tapped the post with `type`
     * 3. Update the `postId` tapped with `type` by the bot
     */
    abstract tap (
      postId : string,
      type?  : TapType,
      tap?   : boolean,
    ): Promise<void | boolean>

    /**
     * Search for taps for a post
     *
     * @param query
     * @param pagination
     */
    abstract tapSearch (
      postId      : string,
      query?      : TapQueryFilter,
      pagination? : PaginationRequest,
    ): Promise<PaginationResponse<TapPayload>>

  }

  return TapMixin
}

type TapMixin = ReturnType<typeof tapMixin>

type ProtectedPropertyTapMixin = never

export type {
  TapMixin,
  ProtectedPropertyTapMixin,
}
export { tapMixin }