link message prototype (#19)

* add receive and send link prototype

* refactor UrlPayload related code to support wechaty/wechaty#1539

* 0.13.1

* add url

* 0.13.2

* fix pack testing

* 0.13.3

* upgrade typescript 3

* 0.13.4

* vscode config clean

* 0.13.5

.vscode/settings.json

@@ -1,23 +1,18 @@
 {
-  "typescript.tsdk": "./node_modules/typescript/lib"
-  , "update.channel": "none"
-, "files.exclude": {
-    "node_modules/": true
-  , "package/": true
-}
-, "alignment": {
-      "operatorPadding": "right"
-    , "indentBase":      "firstline"
-    , "surroundSpace":   {
+  "typescript.tsdk": "./node_modules/typescript/lib",
+  "files.exclude": {
+    "node_modules/": true,
+    "package/": true
+  },
+  "alignment": {
+    "operatorPadding": "right",
+    "indentBase":      "firstline",
+    "surroundSpace":   {
       "colon":      [1, 1],   // The first number specify how much space to add to the left, can be negative. The second number is how much space to the right, can be negative.
       "assignment": [1, 1],    // The same as above.
       "arrow":      [1, 1],    // The same as above.
       "comment":    2          // Special how much space to add between the trailing comment and the code.
                              // If this value is negative, it means don't align the trailing comment.
     }
   }
-  , "eslint.autoFixOnSave": false
-  , "tslint.autoFixOnSave": false
-  , "editor.formatOnSave": false
-  , "typescript.extension.sortImports.sortOnSave": false
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wechaty-puppet",
-  "version": "0.11.6",
+  "version": "0.13.5",
   "description": "Abstract Puppet for Wechaty",
   "main": "dist/src/index.js",
   "typings": "dist/src/index.d.ts",
@@ -58,7 +58,7 @@
     "tslint-config-standard": "^7.1.0",
     "typedoc": "^0.11.1",
     "typedoc-plugin-markdown": "^1.1.13",
-    "typescript": "^2.9.2"
+    "typescript": "^3.0.1"
   },
   "git": {
     "scripts": {

src/index.ts

@@ -21,6 +21,9 @@ export {
 export {
   RoomInvitationPayload,
 }                         from './schemas/room-invitation'
+export {
+  UrlPayload,
+}                         from './schemas/url'
 
 export {
   PuppetOptions,

src/puppet.spec.ts

@@ -37,6 +37,9 @@ import {
 import {
   RoomInvitationPayload,
 }                                 from './schemas/room-invitation'
+import {
+  UrlPayload,
+}                                 from './schemas/url'
 
 import {
   Receiver,
@@ -97,11 +100,14 @@ class PuppetTest extends Puppet {
    * Message
    *
    */
-  public async messageFile (messageId: string)                            : Promise<FileBox> { return { messageId } as any }
+  public async messageFile (messageId: string) : Promise<FileBox> { return { messageId } as any }
+  public async messageUrl (messageId: string)  : Promise<UrlPayload> { return { messageId } as any }
+
   public async messageForward (to: Receiver, messageId: string)           : Promise<void> { return { to, messageId } as any }
   public async messageSendContact (receiver: Receiver, contactId: string) : Promise<void> { return { receiver, contactId } as any }
   public async messageSendFile (to: Receiver, file: FileBox)              : Promise<void> { return { to, file } as any }
   public async messageSendText (to: Receiver, text: string)               : Promise<void> { return { to, text } as any }
+  public async messageSendUrl (to: Receiver, urlPayload: UrlPayload)     : Promise<void> { return { to, urlPayload } as any }
 
   public async messageRawPayload (id: string)            : Promise<any> { return { id } as any }
   public async messageRawPayloadParser (rawPayload: any) : Promise<MessagePayload> { return { rawPayload } as any }

src/puppet.ts

@@ -76,6 +76,9 @@ import {
 import {
   RoomInvitationPayload,
 }                                 from './schemas/room-invitation'
+import {
+  UrlPayload,
+}                                 from './schemas/url'
 
 import {
   PuppetEventName,
@@ -747,11 +750,14 @@ export abstract class Puppet extends EventEmitter {
    * Message
    *
    */
-  public abstract async messageFile (messageId: string)                            : Promise<FileBox>
+  public abstract async messageFile (messageId: string) : Promise<FileBox>
+  public abstract async messageUrl (messageId: string)  : Promise<UrlPayload>
+
   public abstract async messageForward (receiver: Receiver, messageId: string)     : Promise<void>
   public abstract async messageSendText (receiver: Receiver, text: string)         : Promise<void>
   public abstract async messageSendContact (receiver: Receiver, contactId: string) : Promise<void>
   public abstract async messageSendFile (receiver: Receiver, file: FileBox)        : Promise<void>
+  public abstract async messageSendUrl (receiver: Receiver, urlPayload: UrlPayload): Promise<void>
 
   protected abstract async messageRawPayload (messageId: string)     : Promise<any>
   protected abstract async messageRawPayloadParser (rawPayload: any) : Promise<MessagePayload>

src/schemas/message.ts

@@ -67,8 +67,11 @@ export enum WechatMessageType {
 /** @hidden */
 export interface MessagePayloadBase {
   id            : string,
-  contactId?    : string,        // Contact ShareCard
-  filename?     : string,
+
+  // use message id to get rawPayload to get those informations when needed
+  // contactId?    : string,        // Contact ShareCard
+  // filename?     : string,
+
   text?         : string,
   timestamp     : number,        // Unix Timestamp(in seconds)
   type          : MessageType,

src/schemas/url.ts

@@ -0,0 +1,6 @@
+export interface UrlPayload {
+  description?  : string,
+  thumbnailUrl? : string,
+  title         : string,
+  url           : string,
+}

tests/fixtures/smoke-testing.ts

@@ -26,6 +26,7 @@ import {
   RoomPayload,
   RoomQueryFilter,
 
+  UrlPayload,
 }                             from 'wechaty-puppet'
 
 import {
@@ -85,11 +86,14 @@ class PuppetTest extends Puppet {
    * Message
    *
    */
-  public async messageFile (messageId: string)                            : Promise<FileBox> { return { messageId } as any }
+  public async messageFile (messageId: string) : Promise<FileBox> { return { messageId } as any }
+  public async messageUrl (messageId: string)  : Promise<UrlPayload> { return { messageId } as any }
+
   public async messageForward (to: Receiver, messageId: string)           : Promise<void> { return { to, messageId } as any }
   public async messageSendContact (receiver: Receiver, contactId: string) : Promise<void> { return { receiver, contactId } as any }
   public async messageSendFile (to: Receiver, file: FileBox)              : Promise<void> { return { to, file } as any }
   public async messageSendText (to: Receiver, text: string)               : Promise<void> { return { to, text } as any }
+  public async messageSendUrl (to: Receiver, urlPayload: UrlPayload)      : Promise<void> { return { to, urlPayload } as any }
 
   public async messageRawPayload (id: string)            : Promise<any> { return { id } as any }
   public async messageRawPayloadParser (rawPayload: any) : Promise<MessagePayload> { return { rawPayload } as any }