add PuppetInterface (#155)

Author: huan

src/mod.ts

@@ -79,6 +79,7 @@ import {
 
 import type {
   PuppetImplementation,
+  PuppetInterface,
 }                         from './puppet/mod.js'
 
 import {
@@ -121,6 +122,7 @@ export type {
   MiniProgramPayload,
   PuppetEventName,
   PuppetImplementation,
+  PuppetInterface,
   PuppetOptions,
   RoomInvitationPayload,
   RoomMemberPayload,

src/puppet/interface.ts

@@ -0,0 +1,53 @@
+import type { Constructor } from 'clone-class'
+
+import type { Puppet } from './mod.js'
+
+/**
+ * Mixin: Property 'messageRawPayload' of exported class expression may not be private or protected.ts(4094) #155
+ *  https://github.com/wechaty/puppet/issues/155
+ *
+ * We can not use `private` or `protected` to declare Mixins
+ *  So we define a `ProtectedMethods` list to mark the protected methods
+ *    And Omit them from the Puppet typing defination
+ *    to build a new PuppetInterface
+ */
+type ProtectedMethods = never
+  | 'cacheContactPayload'
+  | 'cacheFriendshipPayload'
+  | 'cacheMessagePayload'
+  | 'cacheRoomPayload'
+  | 'cacheRoomMemberPayload'
+  | 'cacheRoomInvitationPayload'
+  | 'counter'
+  | 'memory'
+  | 'login'
+  | 'contactRawPayload'
+  | 'contactRawPayloadParser'
+  | 'contactQueryFilterFactory'
+  | 'contactPayloadCache'
+  | 'friendshipRawPayload'
+  | 'friendshipRawPayloadParser'
+  | 'friendshipPayloadCache'
+  | 'messageRawPayload'
+  | 'messageRawPayloadParser'
+  | 'messagePayloadCache'
+  | 'messageQueryFilterFactory'
+  | 'roomInvitationPayloadCache'
+  | 'roomInvitationRawPayload'
+  | 'roomInvitationRawPayloadParser'
+  | 'roomRawPayload'
+  | 'roomRawPayloadParser'
+  | 'roomMemberRawPayload'
+  | 'roomMemberRawPayloadParser'
+  | 'roomQueryFilterFactory'
+  | 'roomPayloadCache'
+
+// https://stackoverflow.com/questions/44983560/how-to-exclude-a-key-from-an-interface-in-typescript
+type PuppetInterface = Omit<Puppet, ProtectedMethods>
+
+type PuppetImplementation = Constructor<PuppetInterface>
+
+export type {
+  PuppetImplementation,
+  PuppetInterface,
+}

src/puppet/mod.ts

@@ -1,11 +1,15 @@
 import { PuppetSkelton } from './skelton.js'
 import {
   Puppet,
-  PuppetImplementation,
 }                         from './puppet.js'
+import type {
+  PuppetImplementation,
+  PuppetInterface,
+}                         from './interface.js'
 
 export type {
   PuppetImplementation,
+  PuppetInterface,
 }
 export {
   Puppet,

src/puppet/puppet.ts

@@ -344,11 +344,6 @@ abstract class Puppet extends MixinBase {
 
 }
 
-type PuppetImplementation = Constructor<Puppet>
-
-export type {
-  PuppetImplementation,
-}
 export {
   Puppet,
 }