Merge branch 'next'

Author: xingoxu

CHANGELOG.md

@@ -1,3 +1,13 @@
+## 7.3.0 (26 Apr 2021)
+
+### Feature
+* Support Flex Message Update 2 (#271)
+* Messaging API - January 2021 update (#277)
+
+### Misc
+* Add TypeScript Example (#270)
+* Update dependencies (#270)(#272)(#283)
+
 ## 7.2.0 (18 Sep 2020)
 
 ### Feature

examples/echo-bot-ts/.gitignore

@@ -0,0 +1,5 @@
+# Dependencies
+node_modules/
+
+# Built files.
+dist/

examples/echo-bot-ts/README.md

@@ -0,0 +1,102 @@
+# LINE Echo Bot with TypeScript
+
+An example LINE bot to echo message with TypeScript. The bot is coded according to TypeScript's best practices.
+
+## Prerequisite
+
+- Git
+- Node.js version 10 and up
+- Heroku CLI (optional)
+- LINE Developers Account for the bot
+
+## Installation
+
+- Clone the repository.
+
+```bash
+git clone https://github.com/line/line-bot-sdk-nodejs.git
+```
+
+- Change directory to the example.
+
+```bash
+cd line-bot-sdk-nodejs/examples/echo-bot-ts
+```
+
+- Install all dependencies.
+
+```bash
+npm install
+```
+
+- Configure all of the environment variables.
+
+```bash
+export CHANNEL_ACCESS_TOKEN=<YOUR_CHANNEL_ACCESS_TOKEN>
+export CHANNEL_SECRET=<YOUR_CHANNEL_SECRET>
+export PORT=<YOUR_PORT>
+```
+
+- Setup your webhook URL in your LINE Official Account to be in the following format. Don't forget to disable the greeting messages and auto-response messages for convenience.
+
+```bash
+https://example-url.com/webhook
+```
+
+- Compile the TypeScript files.
+
+```bash
+npm run build
+```
+
+- Run the application.
+
+```bash
+npm start
+```
+
+## Alternative Installation
+
+If you want to deploy it via Heroku, it is also possible and is even easier for testing purposes.
+
+- Clone the repository.
+
+```bash
+git clone https://github.com/line/line-bot-sdk-nodejs.git
+```
+
+- Change directory to the example.
+
+```bash
+cd line-bot-sdk-nodejs/examples/echo-bot-ts
+```
+
+- Create a Heroku application.
+
+```bash
+git init
+heroku create <YOUR_APP_NAME> # Do not specify for a random name
+```
+
+- Setup the environment variables, and don't forget to setup your webhook URL (from the Heroku application that you have just created) in your LINE Offical Account. The webhook URL will still accept the following format: `https://example-url.com.herokuapp.com/webhook`.
+
+```bash
+heroku config:set CHANNEL_ACCESS_TOKEN=YOUR_CHANNEL_ACCESS_TOKEN
+heroku config:set CHANNEL_SECRET=YOUR_CHANNEL_SECRET
+```
+
+- Push the application to the server.
+
+```bash
+git add .
+git commit -m "Initial commit for Heroku testing"
+git push heroku master
+```
+
+- Open your application.
+
+```bash
+heroku open
+```
+
+- Done!

examples/echo-bot-ts/environment.d.ts

@@ -0,0 +1,11 @@
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      CHANNEL_ACCESS_TOKEN: string;
+      CHANNEL_SECRET: string;
+      PORT: string;
+    }
+  }
+}
+
+export {};

examples/echo-bot-ts/index.ts

@@ -0,0 +1,97 @@
+// Import all dependencies, mostly using destructuring for better view.
+import { ClientConfig, Client, middleware, MiddlewareConfig, WebhookEvent, TextMessage, MessageAPIResponseBase } from '@line/bot-sdk';
+import express, { Application, Request, Response } from 'express';
+
+// Setup all LINE client and Express configurations.
+const clientConfig: ClientConfig = {
+  channelAccessToken: process.env.CHANNEL_ACCESS_TOKEN || '',
+  channelSecret: process.env.CHANNEL_SECRET,
+};
+
+const middlewareConfig: MiddlewareConfig = {
+  channelAccessToken: process.env.CHANNEL_ACCESS_TOKEN,
+  channelSecret: process.env.CHANNEL_SECRET || '',
+};
+
+const PORT = process.env.PORT || 3000;
+
+// Create a new LINE SDK client.
+const client = new Client(clientConfig);
+
+// Create a new Express application.
+const app: Application = express();
+
+// Function handler to receive the text.
+const textEventHandler = async (event: WebhookEvent): Promise<MessageAPIResponseBase | undefined> => {
+  // Process all variables here.
+  if (event.type !== 'message' || event.message.type !== 'text') {
+    return;
+  }
+
+  // Process all message related variables here.
+  const { replyToken } = event;
+  const { text } = event.message;
+
+  // Create a new message.
+  const response: TextMessage = {
+    type: 'text',
+    text,
+  };
+
+  // Reply to the user.
+  await client.replyMessage(replyToken, response);
+};
+
+// Register the LINE middleware.
+// As an alternative, you could also pass the middleware in the route handler, which is what is used here.
+// app.use(middleware(middlewareConfig));
+
+// Route handler to receive webhook events.
+// This route is used to receive connection tests.
+app.get(
+  '/',
+  async (_: Request, res: Response): Promise<Response> => {
+    return res.status(200).json({
+      status: 'success',
+      message: 'Connected successfully!',
+    });
+  }
+);
+
+// This route is used for the Webhook.
+app.post(
+  '/webhook',
+  middleware(middlewareConfig),
+  async (req: Request, res: Response): Promise<Response> => {
+    const events: WebhookEvent[] = req.body.events;
+
+    // Process all of the received events asynchronously.
+    const results = await Promise.all(
+      events.map(async (event: WebhookEvent) => {
+        try {
+          await textEventHandler(event);
+        } catch (err: unknown) {
+          if (err instanceof Error) {
+            console.error(err);
+          }
+
+          // Return an error message.
+          return res.status(500).json({
+            status: 'error',
+          });
+        }
+      })
+    );
+
+    // Return a successfull message.
+    return res.status(200).json({
+      status: 'success',
+      results,
+    });
+  }
+);
+
+// Create a server and listen to it.
+app.listen(PORT, () => {
+  console.log(`Application is live and listening on port ${PORT}`);
+});