Merge pull request #6 from evex-dev/dev

Merge
evex-dev · Aug 18, 2024 · 4456efd · 4456efd
2 parents 8b07864 + d672869
commit 4456efd
Show file tree

Hide file tree

Showing 74 changed files with 73,841 additions and 50,539 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.html b/README.html
diff --git a/README.md b/README.md
@@ -1,12 +1,370 @@
 # Line-Deno-Client
 
-Line Deno ClientはDenoで書かれたLINEの非公式APIです
+Line-Deno-ClientはDenoで書かれたLINEの非公式APIです。
 
-$ deno run ./server/main.js
+DenoまたはDeno DeployのHTTPサーバーを利用してブラウザ上で、またDeno単体でも実行できます。
 
-WEB sample -> https://line-selfbot.deno.dev/tmp/tmp.html
+## 使用方法
 
-```bash
-# format
-deno fmt
-```
+```sh
+git clone -b dev https://github.com/test0987654321234567890/Line-Deno-Client
+cd Line-Deno-Client
+# HTTPサーバー起動
+deno run server/main.js
+```
+
+## コード例
+
+### インスタンス生成と初期化
+
+Denoの場合、importします。
+
+```js
+import LineClient from "./server/line_deno.js";
+```
+
+Webの場合、`deno run server/main.js`でサーバーを起動してから[localhost:7070](http://localhost:7070)にアクセスします。
+
+または、[Deno Deployのテストサーバー](https://line-selfbot--dev.deno.dev/)にアクセスします。
+
+メールとパスワードでログイン:
+
+```js
+const Line = new LineClient();
+await Line.init({
+    device: "device",
+    email: "email",
+    pw: "pass_word",
+    pincall: (pincode) => {
+        // pincode callback
+    },
+});
+```
+
+Tokenで初期化:
+
+```js
+const Line = new LineClient();
+await Line.init({
+    authToken: "FHZWgN1MvZyCcGvljBib.vVQ0sVYTH+QJRnQ0rDoTsW.GBdUE+X+C7SrvpMBMbBrjaVbhQc+hCFoijX6xE29cbM=",
+    device: "IOSIPAD",
+});
+```
+
+### Lineリクエストを送信
+
+`LineClient.request`を使用してthriftデータを送信、受信できます:
+
+```js
+await Line.request(
+    CHRdata = [], // CHRLINE Thrift [[ftype,fid,value],...]
+    methodName, // Method Name
+    protocol_type = 3, // 3:TBINARY 4:TCOMPACT
+    parse = true, // true:auto-parse false:no-parse "name":name-parse
+    path = "/S3", // gw.line.naver.jp{path}
+    headers = {}, // HTTP headers
+);
+// return Promise<Object(thriftData)>
+// throw error.cause = thriftExceptionData
+```
+
+実装されているメソッドを利用することもできます:
+
+```js
+// SquareServise
+await Line.getJoinedSquares(limit = 50, continuationToken);
+await Line.inviteIntoSquareChat(inviteeMids, squareChatMid);
+await Line.inviteToSquare(squareMid, invitees, squareChatMid);
+await Line.markAsRead(squareChatMid, messageId);
+await Line.reactToMessage(squareChatMid, messageId, reactionType = 2);
+/*
+    reactionType
+        ALL     = 0,
+        UNDO    = 1,
+        NICE    = 2,
+        LOVE    = 3,
+        FUN     = 4,
+        AMAZING = 5,
+        SAD     = 6,
+        OMG     = 7,
+*/
+await Line.findSquareByInvitationTicket(invitationTicket);
+await Line.fetchMyEvents(
+    syncToken = undefined,
+    limit = 100,
+    continuationToken = undefined,
+    subscriptionId,
+);
+await Line.fetchSquareChatEvents(
+    squareChatMid,
+    syncToken = undefined,
+    continuationToken = undefined,
+    subscriptionId = 0,
+    limit = 100,
+);
+await Line.sendSquareMessage(
+    squareChatMid,
+    text = "test Message",
+    contentType = 0,
+    contentMetadata = {},
+    relatedMessageId = undefined,
+);
+await Line.getSquare(squareMid);
+await Line.getSquareChat(squareChatMid);
+await Line.getJoinableSquareChats(
+    squareMid,
+    continuationToken = undefined,
+    limit = 100,
+);
+await Line.createSquare(
+    name = "TEST Square",
+    displayName = "Tester",
+    profileImageObsHash =
+        "0h6tJf0hQsaVt3H0eLAsAWDFheczgHd3wTCTx2eApNKSoefHNVGRdwfgxbdgUMLi8MSngnPFMeNmpbLi8MSngnPFMeNmpbLi8MSngnOA",
+    desc = "test with Line-Deno-Client",
+    searchable = true,
+    SquareJoinMethodType = 0,
+);
+/*
+    SquareJoinMethodType
+        NONE(0),
+        APPROVAL(1),
+        CODE(2);
+*/
+await Line.getSquareChatAnnouncements(squareChatMid);
+await Line.updateSquareFeatureSet(
+    updateAttributes = [],
+    squareMid,
+    revision,
+    creatingSecretSquareChat = 0,
+);
+/*
+    updateAttributes:
+        CREATING_SECRET_SQUARE_CHAT(1),
+        INVITING_INTO_OPEN_SQUARE_CHAT(2),
+        CREATING_SQUARE_CHAT(3),
+        READONLY_DEFAULT_CHAT(4),
+        SHOWING_ADVERTISEMENT(5),
+        DELEGATE_JOIN_TO_PLUG(6),
+        DELEGATE_KICK_OUT_TO_PLUG(7),
+        DISABLE_UPDATE_JOIN_METHOD(8),
+        DISABLE_TRANSFER_ADMIN(9),
+        CREATING_LIVE_TALK(10);
+*/
+await Line.joinSquare(
+    squareMid,
+    displayName,
+    ableToReceiveMessage = false,
+    passCode = undefined,
+);
+await Line.removeSubscriptions(subscriptionIds = []);
+await Line.unsendSquareMessage(squareChatMid, messageId);
+await Line.createSquareChat(
+    squareChatMid,
+    name,
+    chatImageObsHash,
+    squareChatType = 1,
+    maxMemberCount = 5000,
+    ableToSearchMessage = 1,
+    squareMemberMids = [],
+);
+/*
+    - SquareChatType:
+        OPEN(1),
+        SECRET(2),
+        ONE_ON_ONE(3),
+        SQUARE_DEFAULT(4);
+    - ableToSearchMessage:
+        NONE(0),
+        OFF(1),
+        ON(2);
+*/
+await Line.getSquareChatMembers(
+    squareChatMid,
+    continuationToken = undefined,
+    limit = 200,
+);
+await Line.getSquareFeatureSet(squareMid);
+await Line.getSquareInvitationTicketUrl(mid);
+await Line.updateSquareChatMember(
+    squareMemberMid,
+    squareChatMid,
+    notificationForMessage = true,
+    notificationForNewMember = true,
+    updatedAttrs = [6],
+);
+/*
+    - SquareChatMemberAttribute:
+        MEMBERSHIP_STATE(4),
+        NOTIFICATION_MESSAGE(6),
+        NOTIFICATION_NEW_MEMBER(7);
+*/
+await Line.updateSquareMember(
+    updatedAttrs = [],
+    updatedPreferenceAttrs = [],
+    squareMemberMid,
+    squareMid,
+    revision,
+    displayName,
+    membershipState,
+    role,
+);
+/*
+    SquareMemberAttribute:
+        DISPLAY_NAME(1),
+        PROFILE_IMAGE(2),
+        ABLE_TO_RECEIVE_MESSAGE(3),
+        MEMBERSHIP_STATE(5),
+        ROLE(6),
+        PREFERENCE(7);
+    SquareMembershipState:
+        JOIN_REQUESTED(1),
+        JOINED(2),
+        REJECTED(3),
+        LEFT(4),
+        KICK_OUT(5),
+        BANNED(6),
+        DELETED(7);
+*/
+await Line.kickOutSquareMember(sid, pid);
+await Line.checkSquareJoinCode(squareMid, code);
+await Line.createSquareChatAnnouncement(
+    squareChatMid,
+    messageId,
+    text,
+    senderSquareMemberMid,
+    createdAt,
+    announcementType = 0,
+);
+await Line.getSquareMember(squareMemberMid);
+await Line.searchSquareChatMembers(
+    squareChatMid,
+    displayName = "",
+    continuationToken,
+    limit = 20,
+);
+await Line.getSquareEmid(squareMid);
+await Line.getSquareMembersBySquare(squareMid, squareMemberMids = []);
+await Line.manualRepair(syncToken, limit = 100, continuationToken);
+await Line.sendSquareRequestByName(METHOD_NAME, params); // send SquareRequest
+// LineServise
+await Line.getProfile();
+// LiffServise
+await Line.issueLiffView(
+    chatMid,
+    liffId = "1562242036-RW04okm",
+    lang = "ja_JP",
+);
+// ChannelService
+await Line.approveChannelAndIssueChannelToken(channelId = "1341209850");
+```
+
+### イベントハンドラー
+
+Squareでイベントハンドラーを利用できます。
+
+fetchMyEventsのハンドラー:
+
+```js
+const handler = (event, line) => {
+    console.log(event);
+};
+const remove = await Line.squareEvent(handler, ?syncToken, ?interval, ?remove);
+function stopRoop() {
+    remove.remove = true;
+}
+```
+
+fetchSquareChatEventsのハンドラー:
+
+```js
+const handler = (event, line, mid) => {
+    console.log(event);
+};
+const remove = await Line.squareChatEvent(
+    handler,
+    mid,
+    ?syncToken,
+    ?interval,
+    ?remove,
+);
+function stopRoop() {
+    remove.remove = true;
+}
+```
+
+#### addEventListener
+
+addEventListenerを利用して処理することもできます。
+
+fetchMyEventsのハンドラー:
+
+```js
+const eventTarget = Line.getSquareEventTarget();
+eventTarget.addEventListener(
+    "message",
+    (e) => console.log(e.squareMessage.message.text),
+);
+eventTarget.onmessage = (e) => console.log(e.squareMessage.message.text);
+
+function stopRoop() {
+    eventTarget.remove.remove = true;
+}
+```
+
+fetchSquareChatEventsのハンドラー:
+
+```js
+const eventTarget = Line.getSquareChatEventTarget(mid);
+eventTarget.addEventListener(
+    "message",
+    (e) => {
+        console.log(e.squareMessage.message.text);
+        Line.sendSquareMessage(
+            mid,
+            e.squareMessage.message.text,
+        );
+        // echo BOT
+    },
+);
+eventTarget.onmessage = (e) => console.log(e.squareMessage.message.text);
+// message は receiveMessage,sendMessage の受信時にも発火します
+eventTarget.addEventListener(
+    "markAsRead",
+    (e) => console.log("既読:", e),
+);
+
+function stopRoop() {
+    eventTarget.remove.remove = true;
+}
+```
+
+イベント名の配列は以下のコードで取得できます:
+
+```js
+const eventNameArray = Line.parser.def.SquareEventPayload.map((e) => {
+    let name = e.name.replace("notified", "")
+        .replace("notification", "");
+    name = name[0].toLowerCase() + name.substring(1);
+    return name;
+});
+```
+
+ただし、全てのイベントが確実に発生するとは限りません。
+
+例えば、メッセージの受信時に`squareEventTarget`では`message`のみ発生しますが、`squareChatEventTarget`では`sendMessage`と`receiveMessage`も発生します。
+
+また、[`/site/res/thrift.json`](./site/res/thrift.json)|[for web](/res/thrift.json)に記載されていないイベントではイベント名はその`fid`の値になります。
+
+## Thanks
+
+`このプロジェクトは直接的、または間接的に以下の人々/プロジェクトの支援を得ました。深く感謝します。`
+
+- [EdamAmex](https://github.com/EdamAme-x)
+- [羽風](https://github.com/hafusun)
+- [jkFujiyama](https://github.com/jkFujiyama)
+- [DeachSword/CHRLINE](https://github.com/DeachSword/CHRLINE)
+- [thriftrw-node](https://github.com/thriftrw/thriftrw-node/)
+- Line open-chat 拓也集落's group members
+
+## Licence free
diff --git a/deno.json b/deno.json
diff --git a/run.bat b/run.bat
diff --git a/server/.DS_Store b/server/.DS_Store