Support Channel access token v2.1 (#223)

Author: xingoxu

docs/api-reference/oauth.md

@@ -9,12 +9,19 @@ corresponding to [messaging APIs](https://developers.line.biz/en/reference/messa
 class OAuth {
   constructor() {}
 
-  issueAccessToken(client_id: string, client_secret: string): Promise<{
-    access_token: string;
-    expires_in: number;
-    token_type: "Bearer";
-  }>
+  issueAccessToken(client_id: string, client_secret: string): Promise<Types.ChannelAccessToken>
   revokeAccessToken(access_token: string): Promise<{}>
+  issueChannelAccessTokenV2_1(
+    client_assertion: string,
+  ): Promise<Types.ChannelAccessToken>
+  getIssuedChannelAccessTokenV2_1(
+    client_assertion: string,
+  ): Promise<{ access_tokens: string[] }>
+  revokeChannelAccessTokenV2_1(
+    client_id: string,
+    client_secret: string,
+    access_token: string,
+  ): Promise<{}>
 }
 ```
 
@@ -51,7 +58,7 @@ in [the Client guide](../guide/client.md).
 
 ### OAuth
 
-#### `issueAccessToken(client_id: string, client_secret: string): Promise<{ access_token: string; expires_in: number; token_type: "Bearer"; }>`
+#### `issueAccessToken(client_id: string, client_secret: string): Promise<Types.ChannelAccessToken>`
 
 It corresponds to the [Issue channel access token](https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token) API.
 
@@ -67,4 +74,17 @@ It corresponds to the [Revoke channel access token](https://developers.line.biz/
 
 ``` js
 await oauth.revokeAccessToken("access_token");
-```
+```
+
+
+#### issueChannelAccessTokenV2_1(client_assertion: string): Promise<Types.ChannelAccessToken>
+
+It corresponds to the [Issue channel access token v2.1](https://developers.line.biz/en/reference/messaging-api/#issue-channel-access-token-v2-1) API.
+
+#### getIssuedChannelAccessTokenV2_1(client_assertion: string): Promise<{ access_tokens: string[] }>
+
+It corresponds to the [Get Issued channel access token v2.1](https://developers.line.biz/en/reference/messaging-api/#get-issued-channel-access-tokens-v2-1) API.
+
+#### revokeChannelAccessTokenV2_1(client_id: string, client_secret: string, access_token: string): Promise<{}>
+
+It corresponds to the [Revoke channel access token v2.1](https://developers.line.biz/en/reference/messaging-api/#revoke-channel-access-token-v2-1) API.

lib/client.ts

@@ -603,11 +603,7 @@ export class OAuth {
   public issueAccessToken(
     client_id: string,
     client_secret: string,
-  ): Promise<{
-    access_token: string;
-    expires_in: number;
-    token_type: "Bearer";
-  }> {
+  ): Promise<Types.ChannelAccessToken> {
     return this.http.postForm(`${OAUTH_BASE_PREFIX}/accessToken`, {
       grant_type: "client_credentials",
       client_id,
@@ -618,4 +614,37 @@ export class OAuth {
   public revokeAccessToken(access_token: string): Promise<{}> {
     return this.http.postForm(`${OAUTH_BASE_PREFIX}/revoke`, { access_token });
   }
+
+  public issueChannelAccessTokenV2_1(
+    client_assertion: string,
+  ): Promise<Types.ChannelAccessToken> {
+    return this.http.postForm(`${OAUTH_BASE_PREFIX}/v2.1/token`, {
+      grant_type: "client_credentials",
+      client_assertion_type:
+        "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
+      client_assertion,
+    });
+  }
+
+  public getIssuedChannelAccessTokenV2_1(
+    client_assertion: string,
+  ): Promise<{ access_tokens: string[] }> {
+    return this.http.get(`${OAUTH_BASE_PREFIX}/v2.1/tokens`, {
+      client_assertion_type:
+        "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
+      client_assertion,
+    });
+  }
+
+  public revokeChannelAccessTokenV2_1(
+    client_id: string,
+    client_secret: string,
+    access_token: string,
+  ): Promise<{}> {
+    return this.http.postForm(`${OAUTH_BASE_PREFIX}/v2.1/revoke`, {
+      client_id,
+      client_secret,
+      access_token,
+    });
+  }
 }

lib/types.ts

@@ -2426,6 +2426,12 @@ export type AudienceGroups = _AudienceGroup[];
 
 export type AudienceGroupAuthorityLevel = "PUBLIC" | "PRIVATE";
 
+export type ChannelAccessToken = {
+  access_token: string;
+  expires_in: number;
+  token_type: "Bearer";
+};
+
 /**
  * Response body of get group summary.
  *

test/client.spec.ts

@@ -901,6 +901,12 @@ describe("oauth", () => {
   afterEach(() => nock.cleanAll());
   after(() => nock.enableNetConnect());
 
+  const accessTokenReply = {
+    access_token: "access_token",
+    expires_in: 2592000,
+    token_type: "Bearer",
+  };
+
   const interceptionOption = {
     reqheaders: {
       "content-type": "application/x-www-form-urlencoded",
@@ -917,19 +923,11 @@ describe("oauth", () => {
         client_id,
         client_secret,
       })
-      .reply(200, {
-        access_token: "access_token",
-        expires_in: 2592000,
-        token_type: "Bearer",
-      });
+      .reply(200, accessTokenReply);
 
     const res = await oauth.issueAccessToken(client_id, client_secret);
     equal(scope.isDone(), true);
-    deepEqual(res, {
-      access_token: "access_token",
-      expires_in: 2592000,
-      token_type: "Bearer",
-    });
+    deepEqual(res, accessTokenReply);
   });
 
   it("revokeAccessToken", async () => {
@@ -942,4 +940,58 @@ describe("oauth", () => {
     equal(scope.isDone(), true);
     deepEqual(res, {});
   });
+
+  it("issueChannelAccessTokenV2_1", async () => {
+    const client_assertion = "client_assertion";
+
+    const scope = nock(OAUTH_BASE_PREFIX, interceptionOption)
+      .post("/v2.1/token", {
+        grant_type: "client_credentials",
+        client_assertion_type:
+          "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
+        client_assertion,
+      })
+      .reply(200, accessTokenReply);
+
+    const res = await oauth.issueChannelAccessTokenV2_1(client_assertion);
+    equal(scope.isDone(), true);
+    deepEqual(res, accessTokenReply);
+  });
+
+  it("getIssuedChannelAccessTokenV2_1", async () => {
+    const client_assertion = "client_assertion";
+    const accessTokenReply = {
+      access_tokens: ["test_access_tokens"],
+    };
+
+    const scope = nock(OAUTH_BASE_PREFIX)
+      .get("/v2.1/tokens")
+      .query({
+        client_assertion_type:
+          "urn:ietf:params:oauth:client-assertion-type:jwt-bearer",
+        client_assertion,
+      })
+      .reply(200, accessTokenReply);
+
+    const res = await oauth.getIssuedChannelAccessTokenV2_1(client_assertion);
+    equal(scope.isDone(), true);
+    deepEqual(res, accessTokenReply);
+  });
+
+  it("revokeChannelAccessTokenV2_1", async () => {
+    const client_id = "test_client_id",
+      client_secret = "test_client_secret",
+      access_token = "test_channel_access_token";
+    const scope = nock(OAUTH_BASE_PREFIX, interceptionOption)
+      .post("/v2.1/revoke", { client_id, client_secret, access_token })
+      .reply(200, {});
+
+    const res = await oauth.revokeChannelAccessTokenV2_1(
+      client_id,
+      client_secret,
+      access_token,
+    );
+    equal(scope.isDone(), true);
+    deepEqual(res, {});
+  });
 });