Merge pull request #34 from musou1500/support-richmenu-api

WIP: Support richmenu api

Author: Hyunje Jun

lib/client.ts

@@ -1,7 +1,9 @@
-import { get, post, stream } from "./http";
+import { Readable } from "stream";
+import { get, post, stream, del, postBinary } from "./http";
 import * as Types from "./types";
 import * as URL from "./urls";
-import { toArray } from "./util";
+import { toArray, detectContentType } from "./util";
+import { JSONParseError } from "./exceptions";
 
 export default class Client {
   public config: Types.ClientConfig;
@@ -45,52 +47,58 @@ export default class Client {
   }
 
   public getProfile(userId: string): Promise<Types.Profile> {
-    return this.get(URL.profile(userId));
+    return this.get(URL.profile(userId)).then(this.checkJSON);
   }
 
   public getGroupMemberProfile(
     groupId: string,
     userId: string,
   ): Promise<Types.Profile> {
-    return this.get(URL.groupMemberProfile(groupId, userId));
+    return this.get(URL.groupMemberProfile(groupId, userId)).then(
+      this.checkJSON,
+    );
   }
 
   public getRoomMemberProfile(
     roomId: string,
     userId: string,
   ): Promise<Types.Profile> {
-    return this.get(URL.roomMemberProfile(roomId, userId));
+    return this.get(URL.roomMemberProfile(roomId, userId)).then(this.checkJSON);
   }
 
   public getGroupMemberIds(groupId: string): Promise<string[]> {
     const load = (start?: string): Promise<string[]> =>
-      this.get(
-        URL.groupMemberIds(groupId, start),
-      ).then((res: { memberIds: string[]; next?: string }) => {
-        if (!res.next) {
-          return res.memberIds;
-        }
-
-        return load(res.next).then(extraIds => res.memberIds.concat(extraIds));
-      });
+      this.get(URL.groupMemberIds(groupId, start))
+        .then(this.checkJSON)
+        .then((res: { memberIds: string[]; next?: string }) => {
+          if (!res.next) {
+            return res.memberIds;
+          }
+
+          return load(res.next).then(extraIds =>
+            res.memberIds.concat(extraIds),
+          );
+        });
     return load();
   }
 
   public getRoomMemberIds(roomId: string): Promise<string[]> {
     const load = (start?: string): Promise<string[]> =>
-      this.get(
-        URL.roomMemberIds(roomId, start),
-      ).then((res: { memberIds: string[]; next?: string }) => {
-        if (!res.next) {
-          return res.memberIds;
-        }
-
-        return load(res.next).then(extraIds => res.memberIds.concat(extraIds));
-      });
+      this.get(URL.roomMemberIds(roomId, start))
+        .then(this.checkJSON)
+        .then((res: { memberIds: string[]; next?: string }) => {
+          if (!res.next) {
+            return res.memberIds;
+          }
+
+          return load(res.next).then(extraIds =>
+            res.memberIds.concat(extraIds),
+          );
+        });
     return load();
   }
 
-  public getMessageContent(messageId: string): Promise<NodeJS.ReadableStream> {
+  public getMessageContent(messageId: string): Promise<Readable> {
     return this.stream(URL.content(messageId));
   }
 
@@ -102,10 +110,59 @@ export default class Client {
     return this.post(URL.leaveRoom(roomId));
   }
 
+  public getRichMenu(
+    richMenuId: string,
+  ): Promise<Types.RichMenuId & Types.RichMenu> {
+    return this.get(URL.richMenu(richMenuId)).then(this.checkJSON);
+  }
+
+  public createRichMenu(richMenu: Types.RichMenu): Promise<Types.RichMenuId> {
+    return this.post(URL.richMenu(), richMenu).then(this.checkJSON);
+  }
+
+  public deleteRichMenu(richMenuId: string): Promise<any> {
+    return this.delete(URL.richMenu(richMenuId));
+  }
+
+  public getUserRichMenuIds(userId: string): Promise<Types.RichMenuId> {
+    return this.get(URL.userRichMenu(userId)).then(this.checkJSON);
+  }
+
+  public linkRichMenuToUser(userId: string, richMenuId: string): Promise<any> {
+    return this.post(URL.userRichMenu(userId, richMenuId));
+  }
+
+  public unlinkRichMenuFromUser(
+    userId: string,
+    richMenuId: string,
+  ): Promise<any> {
+    return this.delete(URL.userRichMenu(userId, richMenuId));
+  }
+
+  public getRichMenuImage(richMenuId: string): Promise<Readable> {
+    return this.stream(URL.richMenuContent(richMenuId));
+  }
+
+  public setRichMenuImage(
+    richMenuId: string,
+    data: Buffer | Readable,
+    contentType?: string,
+  ): Promise<any> {
+    return this.postBinary(URL.richMenuContent(richMenuId), data, contentType);
+  }
+
+  public getRichMenuList(): Promise<Array<Types.RichMenuId & Types.RichMenu>> {
+    return this.get(URL.richMenuList()).then(this.checkJSON);
+  }
+
   private authHeader(): { [key: string]: string } {
     return { Authorization: "Bearer " + this.config.channelAccessToken };
   }
 
+  private delete(url: string): Promise<any> {
+    return del(url, this.authHeader());
+  }
+
   private get(url: string): Promise<any> {
     return get(url, this.authHeader());
   }
@@ -114,7 +171,23 @@ export default class Client {
     return post(url, this.authHeader(), body);
   }
 
-  private stream(url: string): Promise<NodeJS.ReadableStream> {
+  private postBinary(
+    url: string,
+    data: Buffer | Readable,
+    contentType?: string,
+  ) {
+    return postBinary(url, this.authHeader(), data, contentType);
+  }
+
+  private stream(url: string): Promise<Readable> {
     return stream(url, this.authHeader());
   }
+
+  private checkJSON(raw: any): any {
+    if (typeof raw === "object") {
+      return raw;
+    } else {
+      throw new JSONParseError("Failed to parse response body as JSON", raw);
+    }
+  }
 }

lib/http.ts

@@ -1,21 +1,10 @@
 import axios, { AxiosError } from "axios";
-import {
-  HTTPError,
-  JSONParseError,
-  ReadError,
-  RequestError,
-} from "./exceptions";
+import { detectContentType } from "./util";
+import { Readable } from "stream";
+import { HTTPError, ReadError, RequestError } from "./exceptions";
 
 const pkg = require("../package.json");
 
-function checkJSON(raw: any): any {
-  if (typeof raw === "object") {
-    return raw;
-  } else {
-    throw new JSONParseError("Failed to parse response body as JSON", raw);
-  }
-}
-
 function wrapError(err: AxiosError) {
   if (err.response) {
     throw new HTTPError(
@@ -37,22 +26,19 @@ function wrapError(err: AxiosError) {
 
 const userAgent = `${pkg.name}/${pkg.version}`;
 
-export function stream(
-  url: string,
-  headers: any,
-): Promise<NodeJS.ReadableStream> {
+export function stream(url: string, headers: any): Promise<Readable> {
   headers["User-Agent"] = userAgent;
   return axios
     .get(url, { headers, responseType: "stream" })
-    .then(res => res.data as NodeJS.ReadableStream);
+    .then(res => res.data as Readable);
 }
 
 export function get(url: string, headers: any): Promise<any> {
   headers["User-Agent"] = userAgent;
 
   return axios
     .get(url, { headers })
-    .then(res => checkJSON(res.data))
+    .then(res => res.data)
     .catch(wrapError);
 }
 
@@ -61,6 +47,33 @@ export function post(url: string, headers: any, data?: any): Promise<any> {
   headers["User-Agent"] = userAgent;
   return axios
     .post(url, data, { headers })
-    .then(res => checkJSON(res.data))
+    .then(res => res.data)
+    .catch(wrapError);
+}
+
+export function postBinary(
+  url: string,
+  headers: any,
+  data: Buffer | Readable,
+  contentType?: string,
+): Promise<any> {
+  return new Promise(resolve => {
+    return resolve(contentType ? contentType : detectContentType(data));
+  }).then((contentType: string) => {
+    headers["Content-Type"] = contentType;
+    headers["User-Agent"] = userAgent;
+    return axios
+      .post(url, data, { headers })
+      .then(res => res.data)
+      .catch(wrapError);
+  });
+}
+
+export function del(url: string, headers: any): Promise<any> {
+  headers["User-Agent"] = userAgent;
+
+  return axios
+    .delete(url, { headers })
+    .then(res => res.data)
     .catch(wrapError);
 }

lib/types.ts

@@ -170,7 +170,7 @@ export type ImageMapMessage = {
   type: "image";
   baseUrl: string;
   altText: string;
-  baseSize: { width: number; height: number };
+  baseSize: Size;
   actions: ImageMapAction[];
 };
 
@@ -182,7 +182,7 @@ export type TemplateMessage = {
 
 export type ImageMapAction = ImageMapURIAction | ImageMapMessageAction;
 
-export type ImageMapActionBase = { area: ImageMapArea };
+export type ImageMapActionBase = { area: Area };
 
 export type ImageMapURIAction = {
   type: "uri";
@@ -194,7 +194,7 @@ export type ImageMapMessageAction = {
   text: string;
 } & ImageMapActionBase;
 
-export type ImageMapArea = {
+export type Area = {
   x: number;
   y: number;
   width: number;
@@ -212,13 +212,13 @@ export type TemplateButtons = {
   thumbnailImageUrl?: string;
   title?: string;
   text: string;
-  actions: TemplateAction<{ label: string }>[];
+  actions: Action<{ label: string }>[];
 };
 
 export type TemplateConfirm = {
   type: "confirm";
   text: string;
-  actions: TemplateAction<{ label: string }>[];
+  actions: Action<{ label: string }>[];
 };
 
 export type TemplateCarousel = { type: "carousel"; columns: TemplateColumn[] };
@@ -227,7 +227,7 @@ export type TemplateColumn = {
   thumbnailImageUrl?: string;
   title?: string;
   text: string;
-  actions: TemplateAction<{ label: string }>[];
+  actions: Action<{ label: string }>[];
 };
 
 export type TemplateImageCarousel = {
@@ -237,36 +237,51 @@ export type TemplateImageCarousel = {
 
 export type TemplateImageColumn = {
   imageUrl: string;
-  action: TemplateAction<{ label?: string }>;
+  action: Action<{ label?: string }>;
 };
 
-export type TemplateAction<Label> =
-  | TemplatePostbackAction & Label
-  | TemplateMessageAction & Label
-  | TemplateURIAction & Label
-  | TemplateDatetimePickerAction & Label;
+export type Action<Label> =
+  | PostbackAction & Label
+  | MessageAction & Label
+  | URIAction & Label
+  | DatetimePickerAction & Label;
 
-export type TemplatePostbackAction = {
+export type PostbackAction = {
   type: "postback";
   data: string;
   text?: string;
 };
 
-export type TemplateMessageAction = {
+export type MessageAction = {
   type: "message";
   text: string;
 };
 
-export type TemplateURIAction = {
+export type URIAction = {
   type: "uri";
   uri: string;
 };
 
-export type TemplateDatetimePickerAction = {
+export type DatetimePickerAction = {
   type: "datetimepicker";
   data: string;
   mode: "date" | "time" | "datetime";
   initial?: string;
   max?: string;
   min?: string;
 };
+
+export type Size = {
+  width: number;
+  height: number;
+};
+
+export type RichMenuId = { richMenuId: string };
+
+export type RichMenu = {
+  size: Size;
+  selected: boolean;
+  name: string;
+  chatBarText: string;
+  areas: Array<{ bounds: Area; action: Action<{}> }>;
+};

lib/urls.ts

@@ -32,3 +32,14 @@ export const roomMemberIds = (roomId: string, start?: string) =>
 export const leaveGroup = (groupId: string) => apiURL(`group/${groupId}/leave`);
 
 export const leaveRoom = (roomId: string) => apiURL(`room/${roomId}/leave`);
+
+export const richMenu = (richMenuId?: string) =>
+  apiURL("richmenu" + (richMenuId ? `/${richMenuId}` : ""));
+
+export const richMenuList = () => apiURL(`richmenu/list`);
+
+export const userRichMenu = (userId: string, richMenuId?: string) =>
+  apiURL(`user/${userId}/richmenu` + (richMenuId ? `/${richMenuId}` : ""));
+
+export const richMenuContent = (richMenuId: string) =>
+  apiURL(`richmenu/${richMenuId}/content`);