feat: friendship source

src/user/friendship.ts

@@ -34,7 +34,8 @@ import {
   FriendshipPayload,
   FriendshipType,
   FriendshipSearchQueryFilter,
-}                                 from 'wechaty-puppet'
+  FriendshipSource, FriendshipPayloadReceive,
+} from 'wechaty-puppet'
 
 import {
   Acceptable,
@@ -348,6 +349,25 @@ class Friendship extends EventEmitter implements Acceptable {
       : FriendshipType.Unknown
   }
 
+  /**
+   * Return FriendshipSource in FriendshipPayloadReceive
+   * Issue #2120: https://github.com/wechaty/wechaty/pull/2120
+   * Ref Issue #1801: https://github.com/wechaty/wechaty/issues/1801
+   * @author https://github.com/suhli
+   * @returns {FriendshipSource}
+   * @example
+   * const bot = new Wechaty()
+   * bot.on('friendship', async friendship => {
+   * if (friendship.type() === Friendship.Type.Receive) {
+   *       console.log(JSON.stringify(friendship.source(),null,2))
+   *   }
+   * }
+   * .start()
+   **/
+  public source (): FriendshipSource | null {
+    return (this.payload as FriendshipPayloadReceive).source || null
+  }
+
   /**
    * get friendShipPayload Json
    * @returns {FriendshipPayload}