Make index script export all the types and exceptions

To simplify the interface, and also enable only types to be imported.

Author: Hyunje Jun

exceptions.js

@@ -1,11 +1,12 @@
 import { get, post, stream } from "./http";
+import * as Types from "./types";
 import * as URL from "./urls";
 import { toArray } from "./util";
 
 export default class Client {
-  public config: Line.ClientConfig;
+  public config: Types.ClientConfig;
 
-  constructor(config: Line.Config & Line.ClientConfig) {
+  constructor(config: Types.Config & Types.ClientConfig) {
     if (!config.channelAccessToken) {
       throw new Error("no channel access token");
     }
@@ -15,7 +16,7 @@ export default class Client {
 
   public pushMessage(
     to: string,
-    messages: Line.Message | Line.Message[],
+    messages: Types.Message | Types.Message[],
   ): Promise<any> {
     return this.post(URL.push, {
       messages: toArray(messages),
@@ -25,7 +26,7 @@ export default class Client {
 
   public replyMessage(
     replyToken: string,
-    messages: Line.Message | Line.Message[],
+    messages: Types.Message | Types.Message[],
   ): Promise<any> {
     return this.post(URL.reply, {
       messages: toArray(messages),
@@ -35,29 +36,29 @@ export default class Client {
 
   public multicast(
     to: string[],
-    messages: Line.Message | Line.Message[],
+    messages: Types.Message | Types.Message[],
   ): Promise<any> {
     return this.post(URL.multicast, {
       messages: toArray(messages),
       to,
     });
   }
 
-  public getProfile(userId: string): Promise<Line.Profile> {
+  public getProfile(userId: string): Promise<Types.Profile> {
     return this.get(URL.profile(userId));
   }
 
   public getGroupMemberProfile(
     groupId: string,
     userId: string,
-  ): Promise<Line.Profile> {
+  ): Promise<Types.Profile> {
     return this.get(URL.groupMemberProfile(groupId, userId));
   }
 
   public getRoomMemberProfile(
     roomId: string,
     userId: string,
-  ): Promise<Line.Profile> {
+  ): Promise<Types.Profile> {
     return this.get(URL.roomMemberProfile(roomId, userId));
   }
 

exceptions.ts

@@ -3,3 +3,7 @@ import middleware from "./middleware";
 import validateSignature from "./validate-signature";
 
 export { Client, middleware, validateSignature };
+
+// re-export exceptions and types
+export * from "./exceptions";
+export * from "./types";

lib/client.ts

@@ -1,6 +1,7 @@
 import { raw } from "body-parser";
 import * as http from "http";
 import { JSONParseError, SignatureValidationFailed } from "./exceptions";
+import * as Types from "./types";
 import validateSignature from "./validate-signature";
 
 export type Request = http.IncomingMessage & { body: any };
@@ -14,7 +15,7 @@ export type Middleware = (
 ) => void;
 
 export default function middleware(
-  config: Line.Config & Line.MiddlewareConfig,
+  config: Types.Config & Types.MiddlewareConfig,
 ): Middleware {
   if (!config.channelSecret) {
     throw new Error("no channel secret");

lib/index.ts

@@ -0,0 +1,269 @@
+export type ClientConfig = {
+  channelAccessToken: string;
+};
+
+export type MiddlewareConfig = {
+  channelSecret: string;
+};
+
+export type Config = ClientConfig | MiddlewareConfig;
+
+export type Profile = {
+  displayName: string;
+  userId: string;
+  pictureUrl: string;
+  statusMessage: string;
+};
+
+export type WebhookEvent =
+  | MessageEvent
+  | FollowEvent
+  | UnfollowEvent
+  | JoinEvent
+  | LeaveEvent
+  | PostbackEvent
+  | BeaconEvent;
+
+export type EventBase = {
+  timestamp: number;
+  source: EventSource;
+};
+
+export type EventSource = User | Group | Room;
+
+export type User = { type: "user"; userId: string };
+
+export type Group = { type: "group"; groupId: string; userId?: string };
+
+export type Room = { type: "room"; roomId: string; userId?: string };
+
+export type ReplyableEvent = EventBase & { replyToken: string };
+
+export type MessageEvent = {
+  type: "message";
+  message: EventMessage;
+} & ReplyableEvent;
+
+export type FollowEvent = { type: "follow" } & ReplyableEvent;
+
+export type UnfollowEvent = { type: "unfollow" } & EventBase;
+
+export type JoinEvent = { type: "join" } & ReplyableEvent;
+
+export type LeaveEvent = { type: "leave" } & EventBase;
+
+export type PostbackEvent = {
+  type: "postback";
+  postback: Postback;
+} & ReplyableEvent;
+
+export type BeaconEvent = ReplyableEvent & {
+  type: "beacon";
+  beacon: {
+    type: "enter" | "leave" | "banner";
+    hwid: string;
+    dm?: string;
+  };
+};
+
+export type EventMessage =
+  | TextEventMessage
+  | ImageEventMessage
+  | VideoEventMessage
+  | AudioEventMessage
+  | LocationEventMessage
+  | StickerEventMessage;
+
+export type EventMessageBase = { id: string };
+
+export type TextEventMessage = {
+  type: "text";
+  text: string;
+} & EventMessageBase;
+
+export type ImageEventMessage = { type: "image" } & EventMessageBase;
+
+export type VideoEventMessage = { type: "video" } & EventMessageBase;
+
+export type AudioEventMessage = { type: "audio" } & EventMessageBase;
+
+export type FileEventMessage = {
+  type: "file";
+  fileName: string;
+  fileSize: string;
+} & EventMessageBase;
+
+export type LocationEventMessage = {
+  type: "location";
+  title: string;
+  address: string;
+  latitude: number;
+  longitude: number;
+} & EventMessageBase;
+
+export type StickerEventMessage = {
+  type: "sticker";
+  packageId: string;
+  stickerId: string;
+} & EventMessageBase;
+
+export type Postback = {
+  data: string;
+  params?: {
+    date?: string;
+    time?: string;
+    datetime?: string;
+  };
+};
+
+export type Message =
+  | TextMessage
+  | ImageMessage
+  | VideoMessage
+  | AudioMessage
+  | LocationMessage
+  | StickerMessage
+  | ImageMapMessage
+  | TemplateMessage;
+
+export type TextMessage = {
+  type: "text";
+  text: string;
+};
+
+export type ImageMessage = {
+  type: "image";
+  originalContentUrl: string;
+  previewImageUrl: string;
+};
+
+export type VideoMessage = {
+  type: "video";
+  originalContentUrl: string;
+  previewImageUrl: string;
+};
+
+export type AudioMessage = {
+  type: "audio";
+  originalContentUrl: string;
+  duration: string;
+};
+
+export type LocationMessage = {
+  type: "location";
+  title: string;
+  address: string;
+  latitude: number;
+  longitude: number;
+};
+
+export type StickerMessage = {
+  type: "sticker";
+  packageId: string;
+  stickerId: string;
+};
+
+export type ImageMapMessage = {
+  type: "image";
+  baseUrl: string;
+  altText: string;
+  baseSize: { width: number; height: number };
+  actions: ImageMapAction[];
+};
+
+export type TemplateMessage = {
+  type: "template";
+  altText: string;
+  template: TemplateContent;
+};
+
+export type ImageMapAction = ImageMapURIAction | ImageMapMessageAction;
+
+export type ImageMapActionBase = { area: ImageMapArea };
+
+export type ImageMapURIAction = {
+  type: "uri";
+  linkUri: string;
+} & ImageMapActionBase;
+
+export type ImageMapMessageAction = {
+  type: "message";
+  text: string;
+} & ImageMapActionBase;
+
+export type ImageMapArea = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+
+export type TemplateContent =
+  | TemplateButtons
+  | TemplateConfirm
+  | TemplateCarousel
+  | TemplateImageCarousel;
+
+export type TemplateButtons = {
+  type: "buttons";
+  thumbnailImageUrl?: string;
+  title?: string;
+  text: string;
+  actions: TemplateAction<{ label: string }>[];
+};
+
+export type TemplateConfirm = {
+  type: "confirm";
+  text: string;
+  actions: TemplateAction<{ label: string }>[];
+};
+
+export type TemplateCarousel = { type: "carousel"; columns: TemplateColumn[] };
+
+export type TemplateColumn = {
+  thumbnailImageUrl?: string;
+  title?: string;
+  text: string;
+  actions: TemplateAction<{ label: string }>[];
+};
+
+export type TemplateImageCarousel = {
+  type: "image_carousel";
+  columns: TemplateImageColumn;
+};
+
+export type TemplateImageColumn = {
+  imageUrl: string;
+  action: TemplateAction<{ label?: string }>;
+};
+
+export type TemplateAction<Label> =
+  | TemplatePostbackAction & Label
+  | TemplateMessageAction & Label
+  | TemplateURIAction & Label
+  | TemplateDatetimePickerAction & Label;
+
+export type TemplatePostbackAction = {
+  type: "postback";
+  data: string;
+  text?: string;
+};
+
+export type TemplateMessageAction = {
+  type: "message";
+  text: string;
+};
+
+export type TemplateURIAction = {
+  type: "uri";
+  uri: string;
+};
+
+export type TemplateDatetimePickerAction = {
+  type: "datetimepicker";
+  data: string;
+  mode: "date" | "time" | "datetime";
+  initial?: string;
+  max?: string;
+  min?: string;
+};

lib/middleware.ts

@@ -6,14 +6,11 @@
     "node": ">=4"
   },
   "main": "dist/index.js",
-  "types": "types/index.d.ts",
+  "types": "dist/index.d.ts",
   "files": [
     "dist",
     "docs",
-    "exceptions.js",
-    "exceptions.ts",
-    "lib",
-    "types"
+    "lib"
   ],
   "scripts": {
     "pretest": "npm run build",

lib/types.ts

@@ -1,5 +1,6 @@
 import { deepEqual, equal } from "assert";
 import Client from "../lib/client";
+import * as Types from "../lib/types";
 import { getStreamData } from "./helpers/stream";
 import { close, listen } from "./helpers/test-server";
 
@@ -14,7 +15,7 @@ describe("client", () => {
   before(() => listen(TEST_PORT));
   after(() => close());
 
-  const testMsg: Line.TextMessage = { type: "text", text: "hello" };
+  const testMsg: Types.TextMessage = { type: "text", text: "hello" };
 
   it("reply", () => {
     return client.replyMessage("test_reply_token", testMsg).then((res: any) => {