ChannelAccessToken client doesn't have to require channel access token

line · Nov 17, 2023 · 2172d20 · 2172d20
1 parent 03b1580
commit 2172d20
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 63 deletions.
diff --git a/generator/src/main/resources/line-bot-sdk-nodejs-generator/api-single.pebble b/generator/src/main/resources/line-bot-sdk-nodejs-generator/api-single.pebble
@@ -1,5 +1,6 @@
 {# @pebvariable name="imports" type="java.util.List<java.util.Map<String, String>>" #}
 {# @pebvariable name="operations" type="org.openapitools.codegen.model.OperationMap" #}
+{# @pebvariable name="authMethods" type="java.util.ArrayList<org.openapitools.codegen.CodegenSecurity>" -#}
 {% include "./licenseInfo.pebble" %}
 
 /* tslint:disable:no-unused-locals */
@@ -19,7 +20,9 @@ import {AxiosResponse} from "axios";
 
 interface httpClientConfig {
     baseURL?: string;
+    {% if authMethods != null -%}
     channelAccessToken: string;
+    {% endif -%}
     // TODO support defaultHeaders?
 }
 
@@ -33,7 +36,9 @@ export class {{operations.classname}} {
         }
         this.httpClient = new HTTPClient({
             defaultHeaders: {
+                {% if authMethods != null -%}
                 Authorization: "Bearer " + config.channelAccessToken,
+                {% endif -%}
             },
             responseParser: this.parseHTTPResponse.bind(this),
             baseURL: config.baseURL,

diff --git a/generator/src/main/resources/line-bot-sdk-nodejs-generator/apiBody/normal.pebble b/generator/src/main/resources/line-bot-sdk-nodejs-generator/apiBody/normal.pebble
@@ -10,9 +10,15 @@
     {% if op.hasBodyParam %}const params = {{op.bodyParam.paramName}};
     {% elseif op.hasFormParams %}const formParams = {
         {% for param in op.formParams -%}
-            "{{param.paramName}}": {{param.paramName}},
+            "{{param.baseName}}": {{param.paramName}},
         {% endfor %}
         };
+        // Remove properties with undefined or empty values
+        Object.keys(formParams).forEach((key: keyof typeof formParams) => {
+          if (formParams[key] === undefined || formParams[key] === '') {
+            delete formParams[key];
+          }
+        });
     {% elseif op.hasQueryParams %}const queryParams = {
         {% for param in op.queryParams -%}
             "{{param.paramName}}": {{param.paramName}},

diff --git a/generator/src/main/resources/line-bot-sdk-nodejs-generator/api_test.pebble b/generator/src/main/resources/line-bot-sdk-nodejs-generator/api_test.pebble
@@ -1,5 +1,6 @@
 {# @pebvariable name="imports" type="java.util.List<java.util.Map<String, String>>" #}
 {# @pebvariable name="operations" type="org.openapitools.codegen.model.OperationMap" #}
+{# @pebvariable name="authMethods" type="java.util.ArrayList<org.openapitools.codegen.CodegenSecurity>" -#}
 import { {{operations.classname}} } from "../../api";
 
 {% for import in imports -%}
@@ -21,7 +22,9 @@ describe("{{operations.classname}}", () => {
   afterEach(() => { server.resetHandlers() })
 
   const client = new {{operations.classname}}({
+    {% if authMethods != null -%}
     channelAccessToken: channel_access_token,
+    {% endif -%}
   });
 
 {% for op in operations.operation %}
@@ -44,10 +47,12 @@ describe("{{operations.classname}}", () => {
         ({ request, params, cookies }) => {
           requestCount++;
 
+          {% if authMethods != null -%}
           equal(
             request.headers.get("Authorization"),
             `Bearer ${channel_access_token}`,
           );
+          {% endif -%}
           equal(
             request.headers.get("User-Agent"),
             `${pkg.name}/${pkg.version}`,

diff --git a/lib/channel-access-token/api/channelAccessTokenClient.ts b/lib/channel-access-token/api/channelAccessTokenClient.ts
@@ -31,7 +31,6 @@ import { AxiosResponse } from "axios";
 
 interface httpClientConfig {
   baseURL?: string;
-  channelAccessToken: string;
   // TODO support defaultHeaders?
 }
 
@@ -43,9 +42,7 @@ export class ChannelAccessTokenClient {
       config.baseURL = "https://api.line.me";
     }
     this.httpClient = new HTTPClient({
-      defaultHeaders: {
-        Authorization: "Bearer " + config.channelAccessToken,
-      },
+      defaultHeaders: {},
       responseParser: this.parseHTTPResponse.bind(this),
       baseURL: config.baseURL,
     });
@@ -99,10 +96,16 @@ export class ChannelAccessTokenClient {
     clientSecret?: string,
   ): Promise<IssueShortLivedChannelAccessTokenResponse> {
     const formParams = {
-      grantType: grantType,
-      clientId: clientId,
-      clientSecret: clientSecret,
+      grant_type: grantType,
+      client_id: clientId,
+      client_secret: clientSecret,
     };
+    // Remove properties with undefined or empty values
+    Object.keys(formParams).forEach((key: keyof typeof formParams) => {
+      if (formParams[key] === undefined || formParams[key] === "") {
+        delete formParams[key];
+      }
+    });
 
     const res =
       this.httpClient.postForm<IssueShortLivedChannelAccessTokenResponse>(
@@ -125,10 +128,16 @@ export class ChannelAccessTokenClient {
     clientAssertion?: string,
   ): Promise<IssueChannelAccessTokenResponse> {
     const formParams = {
-      grantType: grantType,
-      clientAssertionType: clientAssertionType,
-      clientAssertion: clientAssertion,
+      grant_type: grantType,
+      client_assertion_type: clientAssertionType,
+      client_assertion: clientAssertion,
     };
+    // Remove properties with undefined or empty values
+    Object.keys(formParams).forEach((key: keyof typeof formParams) => {
+      if (formParams[key] === undefined || formParams[key] === "") {
+        delete formParams[key];
+      }
+    });
 
     const res = this.httpClient.postForm<IssueChannelAccessTokenResponse>(
       "/oauth2/v2.1/token",
@@ -154,12 +163,18 @@ export class ChannelAccessTokenClient {
     clientSecret?: string,
   ): Promise<IssueStatelessChannelAccessTokenResponse> {
     const formParams = {
-      grantType: grantType,
-      clientAssertionType: clientAssertionType,
-      clientAssertion: clientAssertion,
-      clientId: clientId,
-      clientSecret: clientSecret,
+      grant_type: grantType,
+      client_assertion_type: clientAssertionType,
+      client_assertion: clientAssertion,
+      client_id: clientId,
+      client_secret: clientSecret,
     };
+    // Remove properties with undefined or empty values
+    Object.keys(formParams).forEach((key: keyof typeof formParams) => {
+      if (formParams[key] === undefined || formParams[key] === "") {
+        delete formParams[key];
+      }
+    });
 
     const res =
       this.httpClient.postForm<IssueStatelessChannelAccessTokenResponse>(
@@ -178,8 +193,14 @@ export class ChannelAccessTokenClient {
     accessToken?: string,
   ): Promise<Types.MessageAPIResponseBase> {
     const formParams = {
-      accessToken: accessToken,
+      access_token: accessToken,
     };
+    // Remove properties with undefined or empty values
+    Object.keys(formParams).forEach((key: keyof typeof formParams) => {
+      if (formParams[key] === undefined || formParams[key] === "") {
+        delete formParams[key];
+      }
+    });
 
     const res = this.httpClient.postForm("/v2/oauth/revoke", formParams);
     return ensureJSON(res);
@@ -198,10 +219,16 @@ export class ChannelAccessTokenClient {
     accessToken?: string,
   ): Promise<Types.MessageAPIResponseBase> {
     const formParams = {
-      clientId: clientId,
-      clientSecret: clientSecret,
-      accessToken: accessToken,
+      client_id: clientId,
+      client_secret: clientSecret,
+      access_token: accessToken,
     };
+    // Remove properties with undefined or empty values
+    Object.keys(formParams).forEach((key: keyof typeof formParams) => {
+      if (formParams[key] === undefined || formParams[key] === "") {
+        delete formParams[key];
+      }
+    });
 
     const res = this.httpClient.postForm("/oauth2/v2.1/revoke", formParams);
     return ensureJSON(res);
@@ -216,8 +243,14 @@ export class ChannelAccessTokenClient {
     accessToken?: string,
   ): Promise<VerifyChannelAccessTokenResponse> {
     const formParams = {
-      accessToken: accessToken,
+      access_token: accessToken,
     };
+    // Remove properties with undefined or empty values
+    Object.keys(formParams).forEach((key: keyof typeof formParams) => {
+      if (formParams[key] === undefined || formParams[key] === "") {
+        delete formParams[key];
+      }
+    });
 
     const res = this.httpClient.postForm<VerifyChannelAccessTokenResponse>(
       "/v2/oauth/verify",

diff --git a/lib/channel-access-token/tests/api/ChannelAccessTokenClientTest.spec.ts b/lib/channel-access-token/tests/api/ChannelAccessTokenClientTest.spec.ts
@@ -27,9 +27,7 @@ describe("ChannelAccessTokenClient", () => {
     server.resetHandlers();
   });
 
-  const client = new ChannelAccessTokenClient({
-    channelAccessToken: channel_access_token,
-  });
+  const client = new ChannelAccessTokenClient({});
 
   it("getsAllValidChannelAccessTokenKeyIds", async () => {
     let requestCount = 0;
@@ -42,10 +40,6 @@ describe("ChannelAccessTokenClient", () => {
       http.get(endpoint, ({ request, params, cookies }) => {
         requestCount++;
 
-        equal(
-          request.headers.get("Authorization"),
-          `Bearer ${channel_access_token}`,
-        );
         equal(request.headers.get("User-Agent"), `${pkg.name}/${pkg.version}`);
 
         return HttpResponse.json({});
@@ -74,10 +68,6 @@ describe("ChannelAccessTokenClient", () => {
       http.post(endpoint, ({ request, params, cookies }) => {
         requestCount++;
 
-        equal(
-          request.headers.get("Authorization"),
-          `Bearer ${channel_access_token}`,
-        );
         equal(request.headers.get("User-Agent"), `${pkg.name}/${pkg.version}`);
 
         return HttpResponse.json({});
@@ -108,10 +98,6 @@ describe("ChannelAccessTokenClient", () => {
       http.post(endpoint, ({ request, params, cookies }) => {
         requestCount++;
 
-        equal(
-          request.headers.get("Authorization"),
-          `Bearer ${channel_access_token}`,
-        );
         equal(request.headers.get("User-Agent"), `${pkg.name}/${pkg.version}`);
 
         return HttpResponse.json({});
@@ -144,10 +130,6 @@ describe("ChannelAccessTokenClient", () => {
       http.post(endpoint, ({ request, params, cookies }) => {
         requestCount++;
 
-        equal(
-          request.headers.get("Authorization"),
-          `Bearer ${channel_access_token}`,
-        );
         equal(request.headers.get("User-Agent"), `${pkg.name}/${pkg.version}`);
 
         return HttpResponse.json({});
@@ -182,10 +164,6 @@ describe("ChannelAccessTokenClient", () => {
       http.post(endpoint, ({ request, params, cookies }) => {
         requestCount++;
 
-        equal(
-          request.headers.get("Authorization"),
-          `Bearer ${channel_access_token}`,
-        );
         equal(request.headers.get("User-Agent"), `${pkg.name}/${pkg.version}`);
 
         return HttpResponse.json({});
@@ -212,10 +190,6 @@ describe("ChannelAccessTokenClient", () => {
       http.post(endpoint, ({ request, params, cookies }) => {
         requestCount++;
 
-        equal(
-          request.headers.get("Authorization"),
-          `Bearer ${channel_access_token}`,
-        );
         equal(request.headers.get("User-Agent"), `${pkg.name}/${pkg.version}`);
 
         return HttpResponse.json({});
@@ -246,10 +220,6 @@ describe("ChannelAccessTokenClient", () => {
       http.post(endpoint, ({ request, params, cookies }) => {
         requestCount++;
 
-        equal(
-          request.headers.get("Authorization"),
-          `Bearer ${channel_access_token}`,
-        );
         equal(request.headers.get("User-Agent"), `${pkg.name}/${pkg.version}`);
 
         return HttpResponse.json({});
@@ -276,10 +246,6 @@ describe("ChannelAccessTokenClient", () => {
       http.get(endpoint, ({ request, params, cookies }) => {
         requestCount++;
 
-        equal(
-          request.headers.get("Authorization"),
-          `Bearer ${channel_access_token}`,
-        );
         equal(request.headers.get("User-Agent"), `${pkg.name}/${pkg.version}`);
 
         return HttpResponse.json({});

diff --git a/lib/module-attach/api/lineModuleAttachClient.ts b/lib/module-attach/api/lineModuleAttachClient.ts
@@ -86,17 +86,23 @@ export class LineModuleAttachClient {
     brandType?: string,
   ): Promise<AttachModuleResponse> {
     const formParams = {
-      grantType: grantType,
+      grant_type: grantType,
       code: code,
-      redirectUri: redirectUri,
-      codeVerifier: codeVerifier,
-      clientId: clientId,
-      clientSecret: clientSecret,
+      redirect_uri: redirectUri,
+      code_verifier: codeVerifier,
+      client_id: clientId,
+      client_secret: clientSecret,
       region: region,
-      basicSearchId: basicSearchId,
+      basic_search_id: basicSearchId,
       scope: scope,
-      brandType: brandType,
+      brand_type: brandType,
     };
+    // Remove properties with undefined or empty values
+    Object.keys(formParams).forEach((key: keyof typeof formParams) => {
+      if (formParams[key] === undefined || formParams[key] === "") {
+        delete formParams[key];
+      }
+    });
 
     const res = this.httpClient.postForm<AttachModuleResponse>(
       "/module/auth/v1/token",