Merge pull request #66 from juzibot/feat/room-dynamic-qrcode

feat: ✨ add parse room dynamic qrcode and join room by this qrcode

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juzi/wechaty-puppet",
-  "version": "1.0.92",
+  "version": "1.0.93",
   "description": "Abstract Puppet for Wechaty",
   "type": "module",
   "exports": {

src/mixins/room-invitation-mixin.ts

@@ -3,6 +3,7 @@ import {
 }                       from '../config.js'
 
 import type {
+  RoomInvitationAcceptByQRCode,
   RoomInvitationPayload,
 }                                 from '../schemas/room-invitation.js'
 
@@ -48,7 +49,7 @@ const roomInvitationMixin = <MixinBase extends typeof PuppetSkeleton & CacheMixi
     }
 
     abstract roomInvitationAccept (roomInvitationId: string): Promise<void>
-
+    abstract roomInvitationAcceptByQRCode (qrcode: string): Promise<RoomInvitationAcceptByQRCode>
     /**
      * Issue #155 - https://github.com/wechaty/puppet/issues/155
      *

src/mixins/room-mixin.ts

@@ -10,6 +10,7 @@ import type {
   RoomPayloadFilterFunction,
   RoomQueryFilter,
   RoomPermission,
+  RoomParseDynamicQRCode,
 }                                 from '../schemas/room.js'
 
 import type { PuppetSkeleton } from '../puppet/puppet-skeleton.js'
@@ -37,6 +38,7 @@ const roomMixin = <MixinBase extends typeof PuppetSkeleton & ContactMixin & Room
     abstract roomDel (roomId: string, contactId: string | string[])            : Promise<void>
     abstract roomList ()                                                       : Promise<string[]>
     abstract roomQRCode (roomId: string)                                       : Promise<string>
+    abstract roomParseDynamicQRCode (url: string)                              : Promise<RoomParseDynamicQRCode>
     abstract roomQuit (roomId: string)                                         : Promise<void>
     abstract roomTopic (roomId: string)                                        : Promise<string>
     abstract roomTopic (roomId: string, topic: string)                         : Promise<void>

src/mods/types.ts

@@ -4,6 +4,8 @@ import {
   type PuppetEventName,
   type ChatEventName,
   type RoomPermission,
+  type RoomParseDynamicQRCode,
+  type RoomInvitationAcceptByQRCode,
   TagEventType,
   TagGroupEventType,
   ContactGender,
@@ -82,6 +84,8 @@ export {
   type FriendshipAddOptions,
   type MessageSendTextOptions,
   type RoomPermission,
+  type RoomParseDynamicQRCode,
+  type RoomInvitationAcceptByQRCode,
   type ContactIdExternalUserIdPair,
   type RoomAntiSpamStrategy,
   type TextContent,

src/schemas/mod.ts

@@ -85,10 +85,12 @@ import {
   type RoomMemberPayload,
   type RoomMemberQueryFilter,
   type RoomPermission,
+  type RoomParseDynamicQRCode,
   RoomMemberJoinSceneType,
 }                             from './room.js'
 import type {
   RoomInvitationPayload,
+  RoomInvitationAcceptByQRCode,
 }                             from './room-invitation.js'
 import type {
   UrlLinkPayload,
@@ -226,11 +228,13 @@ export {
   type PuppetEventName,
   type PuppetOptions,
   type RoomInvitationPayload,
+  type RoomInvitationAcceptByQRCode,
   type RoomMemberPayload,
   type RoomMemberQueryFilter,
   type RoomPayload,
   type RoomQueryFilter,
   type RoomPermission,
+  type RoomParseDynamicQRCode,
   type SayablePayload,
   type TapPayload,
   type TapQueryFilter,

src/schemas/room-invitation.ts

@@ -9,3 +9,8 @@ export interface RoomInvitationPayload {
   timestamp    : number,     // Unix Timestamp, in seconds or milliseconds
   receiverId   : string,     // the room invitation should send to which contact.
 }
+
+export interface RoomInvitationAcceptByQRCode {
+  roomId: string,
+  chatId: string,
+}

src/schemas/room.ts

@@ -68,6 +68,12 @@ export interface RoomPermission {
   disableMemberMutualAdd: boolean, // 禁止外部群成员互相添加
 }
 
+export interface RoomParseDynamicQRCode {
+  qrcode: string, // 二维码url
+  qrcodeImgUrl: string, // 二维码图片url
+  roomName: string, // 群名称
+}
+
 /** @hidden */
 export type RoomPayloadFilterFunction = (payload: RoomPayload)    => boolean
 

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

@@ -189,6 +189,7 @@ class PuppetTest extends PUPPET.Puppet {
    *
    */
   override async roomInvitationAccept (_: string): Promise<void> { }
+  override async roomInvitationAcceptByQRCode (_: string): Promise<PUPPET.types.RoomInvitationAcceptByQRCode> { return {} as any }
 
   override async roomInvitationRawPayload (roomInvitationId: string) : Promise<any> { return { roomInvitationId } as any }
   override async roomInvitationRawPayloadParser (rawPayload: any)    : Promise<PUPPET.payloads.RoomInvitation> { return rawPayload }
@@ -208,6 +209,7 @@ class PuppetTest extends PUPPET.Puppet {
   override async roomDel (roomId: string, contactId: string)                       : Promise<void> { return { contactId, roomId } as any }
   override async roomQuit (roomId: string)                                         : Promise<void> { return { roomId } as any }
   override async roomQRCode (roomId: string)                                       : Promise<string> { return { roomId } as any }
+  override async roomParseDynamicQRCode (url: string)                              : Promise<PUPPET.types.RoomParseDynamicQRCode> { return { url } as any }
 
   override async roomOwnerTransfer (roomId: string, contactId: string): Promise<void> { return { roomId, contactId } as any }
   override async roomDismiss (roomId: string): Promise<void> { return { roomId } as any }

tests/fixtures/smoke-testing.ts

@@ -173,6 +173,7 @@ class PuppetTest extends PUPPET.Puppet {
    *
    */
   override async roomInvitationAccept (roomInvitationId: string): Promise<void> { void roomInvitationId }
+  override async roomInvitationAcceptByQRCode (qrcode: string): Promise<PUPPET.types.RoomInvitationAcceptByQRCode> { return { qrcode } as any }
 
   override async roomInvitationRawPayload (roomInvitationId: string) : Promise<any> { return { roomInvitationId } as any }
   override async roomInvitationRawPayloadParser (rawPayload: any)    : Promise<PUPPET.payloads.RoomInvitation> { return rawPayload }
@@ -192,6 +193,7 @@ class PuppetTest extends PUPPET.Puppet {
   override async roomDel (roomId: string, contactId: string)          : Promise<void> { return { contactId, roomId } as any }
   override async roomQuit (roomId: string)                            : Promise<void> { return { roomId } as any }
   override async roomQRCode (roomId: string)                          : Promise<string> { return { roomId } as any }
+  override async roomParseDynamicQRCode (url: string)                 : Promise<PUPPET.types.RoomParseDynamicQRCode> { return { url } as any }
 
   override async roomTopic (roomId: string)                 : Promise<string>
   override async roomTopic (roomId: string, topic: string)  : Promise<void>