node-red-contrib-line-messaging-api 0.3.2 → 0.3.4

package/README.md

@@ -4,14 +4,6 @@ LINE Messagin APIのNode-REDのノードです。
 
 LINE Messagin APIを利用できるNode-REDのノードです。
 
-以下のAPIを利用できます。
-
-- LINE Messaging API
-    - Webhook & Reply Message
-    - Push Message
-    - BloadCast Message
-- LINE Notify
-
 ## インストール
 
 ```
@@ -22,7 +14,16 @@ or
 
 AdminタブからInstall
 
-## 利用イメージ
+## Configノード
+
+LINE Botの設定（チャンネルシークレット、チャンネルアクセストークン）を設定しておく裏側のノードです。
+このノードはエディターには表示されずReplyやPushなどのノードの設定UIからアクセスできます。
+
+> ![](https://i.gyazo.com/2528c7ebfae089dabef263b25f03112a.gif)
+
+作成したLINE Botの設定は別のReplyノードやPushノードで使いまわせます。
+
+## 利用できるAPIと利用イメージ
 
 ### Webhook & Reply Message
 
@@ -118,6 +119,7 @@ template nodeにJSONを設定してみてください。
 
 ## release
 
+- 2024/12/27: Loaging / getProfile / configの追加
 - 2023/12/11: Notify_newを追加。スタンプや画像も送れるように。
 - 2021/8/1: Reply Messageが画像に対応（thanks [@ukkz](https://github.com/ukkz)）
 - 2020/12/17: Bloadcast Messageに対応、Reply MessageがFlex Messageに対応（thanks [@gaomar](https://github.com/gaomar)）

package/nodes/_new/push/push.html

@@ -4,10 +4,12 @@
         color: '#01B301',
         defaults: {
             name: {value:""},
+            // lineConfig: {value: "", type:"lineConfig", required:true}, //共通のlineConfigを使う 
+            lineConfig: {value: "", type:"lineConfig"}, //共通のlineConfigを使う 後方互換的にrequired:trueを外す
         },
         credentials: {
             // channelSecret: {type:"password", required:true},
-            channelAccessToken: {type:"password", required:true},
+            channelAccessToken: {type:"password"}, //後方互換的にrequired:trueを外す
             targetId:{type:"password", required:true},
         },
         inputs: 1,
@@ -19,19 +21,23 @@
     });
 </script>
 
-<script type="text/x-red" data-template-name="PushMessage_New">
+<script type="text/html" data-template-name="PushMessage_New">
     <div class="form-row">
         <label for="node-input-name"><i class="icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
-    <!-- <div class="form-row">
-        <label for="node-input-channelSecret"><i class="icon-tag"></i> Secret</label>
-        <input type="password" id="node-input-channelSecret" placeholder="ChannelSecret">
-    </div> -->
+    <!-- LINE Config -->
+    <div class="form-row">
+        <label for="node-input-lineConfig">
+            <i class="fa fa-tag"></i>
+            LINE Bot
+            <span data-i18n="getProfile.label.lineConfig"></span>
+        </label> <input type="text" id="node-input-lineConfig" data-i18n="[placeholder]getProfile.desc.lineConfig">
+    </div>
 
     <div class="form-row">
-        <label for="node-input-channelAccessToken"><i class="icon-tag"></i> AccessToken</label>
+        <label for="node-input-channelAccessToken"><i class="icon-tag"></i> （AccessToken）</label>
         <input type="password" id="node-input-channelAccessToken" placeholder="ChannelAccessToken">
     </div>
 
@@ -48,6 +54,6 @@
     </div> -->
 </script>
 
-<script type="text/x-red" data-help-name="PushMessage_New">
+<script type="text/html" data-help-name="PushMessage_New">
     <p>Send a push message by specifying the user ID or group ID.</p>
 </script>

package/nodes/_new/push/push.js

@@ -6,18 +6,30 @@ module.exports = (RED) => {
         const node = this;
         RED.nodes.createNode(node, config);
 
-        let lineconfig;
+        let lineconfig = {};
+
         try {
-            lineconfig = require('../../env');
+            lineconfig = require('../../env'); //環境変数を取得
         } catch (error) {
-            lineconfig = { 
-                // channelSecret: node.credentials.channelSecret,
-                channelAccessToken: node.credentials.channelAccessToken
-            };
+            try {
+                node.lineConfig = RED.nodes.getNode(config.lineConfig); //共通のlineConfigを取得
+                lineconfig = { 
+                    channelSecret: node.lineConfig.credentials.LineChannelSecret,
+                    channelAccessToken: node.lineConfig.credentials.LineChannelAccessToken
+                };
+                console.log(`---共通lineConfigから---`);
+            } catch (error) {
+                lineconfig = { 
+                    channelSecret: node.credentials.channelSecret,
+                    channelAccessToken: node.credentials.channelAccessToken
+                };
+                console.log(`---個別の設定から---`);
+            }
+
         }
 
         if(lineconfig.channelAccessToken === undefined || lineconfig.channelAccessToken === '') {
-            console.error('token not found1');
+            console.error('LINE token not found1');
             return;
         }
         // const client = new line.messagingApi.MessagingApiClient(lineconfig);

package/nodes/_new/reply/reply.html

@@ -4,11 +4,12 @@
         color: '#01B301',
         defaults: {
             name: {value:""},
+            lineConfig: {value: "", type:"lineConfig"}, //共通のlineConfigを使う 後方互換的にrequired:trueを外す
             replyMessage:{value:""}
         },
         credentials: {
-            channelSecret: {type:"password", required:true},
-            channelAccessToken: {type:"password", required:true},
+            channelSecret: {type:"password"}, //後方互換的にrequired:trueを外す
+            channelAccessToken: {type:"password"}, //後方互換的にrequired:trueを外す
         },
         inputs:1,
         outputs:1,
@@ -21,12 +22,21 @@
     });
 </script>
 
-<script type="text/x-red" data-template-name="ReplyMessage_New">
+<script type="text/html" data-template-name="ReplyMessage_New">
     <div class="form-row">
         <label for="node-input-name"><i class="icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
+    <!-- LINE Config -->
+    <div class="form-row">
+        <label for="node-input-lineConfig">
+            <i class="fa fa-tag"></i>
+            LINE Bot
+            <span data-i18n="getProfile.label.lineConfig"></span>
+        </label> <input type="text" id="node-input-lineConfig" data-i18n="[placeholder]getProfile.desc.lineConfig">
+    </div>
+
     <div class="form-row">
         <label for="node-input-channelSecret"><i class="icon-tag"></i> Secret</label>
         <input type="password" id="node-input-channelSecret" placeholder="ChannelSecret">
@@ -43,6 +53,6 @@
     </div>
 </script>
 
-<script type="text/x-red" data-help-name="ReplyMessage_New">
+<script type="text/html" data-help-name="ReplyMessage_New">
     <p>A simple node that converts the message payloads into all ReplyMessage characters</p>
 </script>

package/nodes/_new/reply/reply.js

@@ -10,14 +10,24 @@ module.exports = (RED) => {
         try {
             lineconfig = require('../../env');
         } catch (error) {
-            lineconfig = {
-                channelSecret: node.credentials.channelSecret,
-                channelAccessToken: node.credentials.channelAccessToken
-            };
+            try {
+                node.lineConfig = RED.nodes.getNode(config.lineConfig); //共通のlineConfigを取得
+                lineconfig = { 
+                    channelSecret: node.lineConfig.credentials.LineChannelSecret,
+                    channelAccessToken: node.lineConfig.credentials.LineChannelAccessToken
+                };
+                console.log(`---共通lineConfigから---`);
+            } catch (error) {
+                lineconfig = { 
+                    channelSecret: node.credentials.channelSecret,
+                    channelAccessToken: node.credentials.channelAccessToken
+                };
+                console.log(`---個別の設定から---`);
+            }
         }
 
         if (lineconfig.channelSecret === '' || lineconfig.channelAccessToken === '') {
-            this.error(RED._('token not found'));
+            this.error(RED._('LINE token not found'));
         }
 
         const client = new line.Client(lineconfig);

package/nodes/config/config.html

@@ -0,0 +1,38 @@
+<script type="text/javascript">
+    RED.nodes.registerType('lineConfig', {
+        category: 'config',
+        color: '#00afd5',
+        defaults: {
+            name: {value: ""}
+        },
+        credentials: {
+            LineChannelSecret: {},
+            LineChannelAccessToken: {},
+        },
+        label: function () {
+            return this.name || 'API Key';
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="lineConfig">
+    <p>LINE Bot Token Settings </p>
+    <div class="form-row">
+        <label for="node-input-name">
+            <i class="fa fa-tag fa-fw"></i> Bot Name
+        </label>
+        <input type="text" id="node-config-input-name" placeholder="Name">
+    </div>
+
+    <div class="form-row">
+      <label for="node-config-input-LineChannelSecret"> Channel Secret</label>
+      <input type="text" id="node-config-input-LineChannelSecret" placeholder="LINE Channel Secret">
+    </div>
+
+    <div class="form-row">
+      <label for="node-config-input-LineChannelAccessToken"> Channel Access Token</label>
+      <input type="text" id="node-config-input-LineChannelAccessToken" placeholder="LINE Channel Access Token">
+    </div>
+
+</script>
+

package/nodes/config/config.js

@@ -0,0 +1,18 @@
+module.exports = function(RED) {
+    function main(n) {
+        RED.nodes.createNode(this, n);
+        this.name = n.name;
+        this.LineChannelSecret = this.credentials.LineChannelSecret;
+        this.LineChannelAccessToken = this.credentials.LineChannelAccessToken;
+    }
+ 
+    RED.nodes.registerType("lineConfig", main, {
+        defaults: {
+            name: {value: ""}
+        },
+        credentials: {
+            LineChannelSecret: {type: "text"},
+            LineChannelAccessToken: {type: "text"}
+        }
+    });
+ }

package/nodes/getProfile/getProfile.html

@@ -0,0 +1,44 @@
+<script>
+    RED.nodes.registerType('getProfile', {
+        category: 'LINE',
+        color: '#01B301',
+        defaults: {
+            name: {value: ''},
+            lineConfig: {value: "", type:"lineConfig", required:true},
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "watch.png",
+        align: 'right',
+        label: function () {
+            return this.name || 'getProfile';
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="getProfile">
+    <!-- 名前 -->
+    <div class="form-row">
+        <label for="node-input-name">
+            <i class="fa fa-tag"></i>
+            <span data-i18n="node-red:common.label.name"></span>
+        </label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
+    </div>
+    
+    <!-- LINE Config -->
+    <div class="form-row">
+        <label for="node-input-lineConfig">
+            <i class="fa fa-tag"></i>
+            LINE Bot
+            <span data-i18n="getProfile.label.lineConfig"></span>
+        </label> <input type="text" id="node-input-lineConfig" data-i18n="[placeholder]getProfile.desc.lineConfig">
+    </div>
+    
+</script>
+
+<script type="text/html" data-help-name="getProfile">
+    <p>プロフィールを取得します。</p>
+</script>
+
+

package/nodes/getProfile/getProfile.js

@@ -0,0 +1,46 @@
+module.exports = (RED) => {
+    'use strict';
+    
+    const line = require('@line/bot-sdk');
+
+    const main = function(config){
+        const node = this;
+        RED.nodes.createNode(node, config);
+
+        let lineconfig = {};
+        try {
+            lineconfig = require('../../env');
+        } catch (error) {
+            node.lineConfig = RED.nodes.getNode(config.lineConfig); //共通のlineConfigを取得
+
+            lineconfig = { 
+                channelSecret: node.lineConfig.credentials.LineChannelSecret,
+                channelAccessToken: node.lineConfig.credentials.LineChannelAccessToken
+            };
+        }
+        if(lineconfig.channelAccessToken === undefined || lineconfig.channelAccessToken === '') {
+            console.error('LINE token not found');
+            return;
+        }
+        const client = new line.messagingApi.MessagingApiClient(lineconfig);
+
+        // ここでLINE APIを呼び出す処理
+        node.on('input', async(msg, send, done) =>  {
+
+            try {
+                const res = await client.getProfile(msg.payload.userId);
+                msg.payload = res;
+                send(msg);
+            } catch (error) {
+                console.error(error.body);
+                node.error(error.body, msg.payload);
+                send(msg);
+                done(error);
+            }
+
+            console.log("Message received:", msg.payload);
+        });
+    }
+
+    RED.nodes.registerType("getProfile", main);
+}

package/nodes/limit/limit.html

@@ -18,7 +18,8 @@
     });
 </script>
 
-<script type="text/x-red" data-template-name="Limit">
+<script type="text/html" data-template-name="Limit">
+    <!-- 名前 -->
     <div class="form-row">
         <label for="node-input-name"><i class="icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">

package/nodes/loading/loading.html

@@ -4,12 +4,10 @@
         color: '#01B301',
         defaults: {
             name: {value:""},
+            targetId: {value:"", required:true},
+            lineConfig: {value: "", type:"lineConfig", required:true}, //共通のlineConfigを使う
             loadingSeconds: {value: 20}
         },
-        credentials: {
-            channelAccessToken: { type: "password", required: true },
-            targetId:{type:"password", required:true}
-        },
         inputs:1,
         outputs:1,
         icon: "timer.png",
@@ -20,20 +18,22 @@
     });
 </script>
 
-<script type="text/x-red" data-template-name="Loading">
+<script type="text/html" data-template-name="Loading">
     <div class="form-row">
         <label for="node-input-name"><i class="icon-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">
     </div>
 
+    <!-- LINE Config -->
     <div class="form-row">
-        <label for="node-input-channelAccessToken">
-            <i class="icon-tag"></i>
-            Channel Access Token
-        </label>
-        <input type="password" id="node-input-channelAccessToken" placeholder="LINE Channel AccessToken">
+        <label for="node-input-lineConfig">
+            <i class="fa fa-tag"></i>
+            LINE Bot
+            <span data-i18n="getProfile.label.lineConfig"></span>
+        </label> <input type="text" id="node-input-lineConfig" data-i18n="[placeholder]getProfile.desc.lineConfig">
     </div>
 
+    <!-- chat ID / User ID -->
     <div class="form-row">
         <label for="node-input-targetId"><i class="icon-tag"></i> User Id</label>
         <input type="text" id="node-input-targetId" placeholder="User Id">
@@ -67,6 +67,6 @@
     </p>
 </script>
 
-<script type="text/x-red" data-help-name="Loading">
-    <p>当月の送信メッセージのリミットを教えてくれます。</p>
+<script type="text/html" data-help-name="Loading">
+    <p>ローディングアニメーションを流します。</p>
 </script>

package/nodes/loading/loading.js

@@ -38,7 +38,7 @@ module.exports = (RED) => {
 
                 // レスポンスが {}（空のJSONオブジェクト）なら成功らしい
                 if (res && Object.keys(res).length === 0) {
-                    node.log('ローディングが成功しました: {} が返却されました');
+                    node.log('ローディングが成功したかも?: {} が返却されました');
                 } else {
                     node.warn('ローディング処理失敗:', res);
                 }
@@ -53,10 +53,5 @@ module.exports = (RED) => {
         });
     }
 
-    RED.nodes.registerType("Loading", main, {
-        credentials: {
-            channelAccessToken: {type:"password"},
-            targetId: {type:"password"},
-        }
-    });
+    RED.nodes.registerType("Loading", main);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-line-messaging-api",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "Node-REDでLINE Botが作れます。",
   "main": "line.js",
   "repository": {
@@ -18,6 +18,8 @@
       "PushMessage_New": "./nodes/_new/push/push.js",
       "BloadcastMessage": "./nodes/bloadcast/bloadcast.js",
       "Limit": "./nodes/limit/limit.js",
+      "getProfile": "./nodes/getProfile/getProfile.js",
+      "config": "./nodes/config/config.js",
       "Loading": "./nodes/loading/loading.js",
       "ReplyMessage": "./nodes/reply/reply.js",
       "PushMessage": "./nodes/push/push.js",