@alemonjs/kook 0.0.3 → 0.1.1

package/lib/sdk/platform/kook/sdk/typings.js

@@ -0,0 +1,168 @@
+/**
+ * api枚举
+ */
+var ApiEnum;
+(function (ApiEnum) {
+    /**
+     * ********
+     * 频道相关
+     * ********
+     */
+    ApiEnum["GuildList"] = "/api/v3/guild/list";
+    ApiEnum["GuildView"] = "/api/v3/guild/view";
+    ApiEnum["GuildUserList"] = "/api/v3/guild/user-list";
+    ApiEnum["GuildNickname"] = "/api/v3/guild/nickname";
+    ApiEnum["GuildLeave"] = "/api/v3/guild/leave";
+    ApiEnum["GuildKickout"] = "/api/v3/guild/kickout";
+    ApiEnum["GuildMuteList"] = "/api/v3/guild-mute/list";
+    ApiEnum["GuildMuteCreate"] = "/api/v3/guild-mute/create";
+    ApiEnum["GuildMuteDelete"] = "/api/v3/guild-mute/delete";
+    ApiEnum["GuildBoostHistory"] = "/api/v3/guild-boost/history";
+    /**
+     * *******
+     * 子频道接口
+     * ******
+     */
+    ApiEnum["ChannelMessage"] = "/api/v3/channel/message";
+    ApiEnum["ChannelList"] = "/api/v3/channel/list";
+    ApiEnum["ChannelView"] = "/api/v3/channel/view";
+    ApiEnum["ChannelCreate"] = "/api/v3/channel/create";
+    ApiEnum["ChannelUpdate"] = "/api/v3/channel/update";
+    ApiEnum["ChannelDelete"] = "/api/v3/channel/delete";
+    ApiEnum["ChannelUserList"] = "/api/v3/channel/user-list";
+    ApiEnum["ChannelMoveUser"] = "/api/v3/channel/move-user";
+    ApiEnum["ChannelRoleIndex"] = "/api/v3/channel-role/index";
+    ApiEnum["ChannelRoleCreate"] = "/api/v3/channel-role/create";
+    ApiEnum["ChannelRoleUpdate"] = "/api/v3/channel-role/update";
+    ApiEnum["ChannelRoleSync"] = "/api/v3/channel-role/sync";
+    ApiEnum["ChannelRoleDelete"] = "/api/v3/channel-role/delete";
+    /**
+     * ******
+     * 消息接口
+     * ****
+     */
+    ApiEnum["MessageList"] = "/api/v3/message/list";
+    ApiEnum["MessageView"] = "/api/v3/message/view";
+    ApiEnum["MessageCreate"] = "/api/v3/message/create";
+    ApiEnum["MessageUpdate"] = "/api/v3/message/update";
+    ApiEnum["MessageDelete"] = "/api/v3/message/delete";
+    ApiEnum["MessageReactionList"] = "/api/v3/message/reaction-list";
+    ApiEnum["MessageAddReaction"] = "/api/v3/message/add-reaction";
+    ApiEnum["MessageDeleteReaction"] = "/api/v3/message/delete-reaction";
+    /**
+     * *******
+     * 频道用户
+     * *******
+     */
+    ApiEnum["GetJoinedChannel"] = "/api/v3/channel-user/get-joined-channel";
+    /**
+     * *******
+     * 私聊会话
+     * *******
+     */
+    ApiEnum["UserChatList"] = "/api/v3/user-chat/list";
+    ApiEnum["UserChatView"] = "/api/v3/user-chat/view";
+    ApiEnum["UserChatCreate"] = "/api/v3/user-chat/create";
+    ApiEnum["UserChatDelete"] = "/api/v3/user-chat/delete";
+    /**
+     * *******
+     * 用户私聊
+     * *******
+     */
+    ApiEnum["DirectMessageList"] = "/api/v3/direct-message/list";
+    ApiEnum["DirectMessageView"] = "/api/v3/direct-message/view";
+    ApiEnum["DirectMessageCreate"] = "/api/v3/direct-message/create";
+    ApiEnum["DirectMessageUpdate"] = "/api/v3/direct-message/update";
+    ApiEnum["DirectMessageDelete"] = "/api/v3/direct-message/delete";
+    ApiEnum["DirectMessageReactionList"] = "/api/v3/direct-message/reaction-list";
+    ApiEnum["DirectMessageAddReaction"] = "/api/v3/direct-message/add-reaction";
+    ApiEnum["DirectMessageDeleteReaction"] = "/api/v3/direct-message/delete-reaction";
+    /**
+     * ******
+     * 用户接口
+     * ******
+     */
+    ApiEnum["UserMe"] = "/api/v3/user/me";
+    ApiEnum["UserView"] = "/api/v3/user/view";
+    ApiEnum["UserOffline"] = "/api/v3/user/offline";
+    /**
+     * *******
+     * 媒体接口
+     * *******
+     */
+    ApiEnum["AssetCreate"] = "/api/v3/asset/create";
+    /**
+     * *******
+     * 服务器角色权限相关接口列表
+     * *******
+     */
+    ApiEnum["GuildRoleList"] = "/api/v3/guild-role/list";
+    ApiEnum["GuildRoleCreate"] = "/api/v3/guild-role/create";
+    ApiEnum["GuildRoleUpdate"] = "/api/v3/guild-role/update";
+    ApiEnum["GuildRoleDelete"] = "/api/v3/guild-role/delete";
+    ApiEnum["GuildRoleGrant"] = "/api/v3/guild-role/grant";
+    ApiEnum["GuildRoleRevoke"] = "/api/v3/guild-role/revoke";
+    /**
+     * *******
+     * 亲密度相关接口列表
+     * *******
+     */
+    ApiEnum["IntimacyIndex"] = "/api/v3/intimacy/index";
+    ApiEnum["IntimacyUpdate"] = "/api/v3/intimacy/update";
+    /**
+     * *******
+     * 服务器表情相关接口
+     * *******
+     */
+    ApiEnum["GuildEmojiList"] = "/api/v3/guild-emoji/list";
+    ApiEnum["GuildEmojiCreate"] = "/api/v3/guild-emoji/create";
+    ApiEnum["GuildEmojiUpdate"] = "/api/v3/guild-emoji/update";
+    ApiEnum["GuildEmojiDelete"] = "/api/v3/guild-emoji/delete";
+    /**
+     * *******
+     * 邀请相关接口
+     * *******
+     */
+    ApiEnum["InviteList"] = "/api/v3/invite/list";
+    ApiEnum["InviteCreate"] = "/api/v3/invite/create";
+    ApiEnum["InviteDelete"] = "/api/v3/invite/delete";
+    /**
+     * *******
+     * 黑名单相关接口
+     * *******
+     */
+    ApiEnum["BlacklistList"] = "/api/v3/blacklist/list";
+    ApiEnum["BlacklistCreate"] = "/api/v3/blacklist/create";
+    ApiEnum["BlacklistDelete"] = "/api/v3/blacklist/delete";
+    /**
+     * *******
+     * Badge 相关文档
+     * *******
+     */
+    ApiEnum["BadgeGuild"] = "/api/v3/badge/guild";
+    /**
+     * *******
+     * 用户动态相关接口-游戏/进程/音乐
+     * *******
+     */
+    ApiEnum["GameList"] = "/api/v3/game";
+    ApiEnum["GameCreate"] = "/api/v3/game/create";
+    ApiEnum["GameUpdate"] = "/api/v3/game/update";
+    ApiEnum["GameDelete"] = "/api/v3/game/delete";
+    ApiEnum["GameActivity"] = "/api/v3/game/activity";
+    ApiEnum["GameDeleteActivity"] = "/api/v3/game/delete-activity";
+    /**
+     * *******
+     * Gateway
+     * *******
+     */
+    ApiEnum["OAuth2Token"] = "/api/oauth2/token";
+    /**
+     * *******
+     * OAuth2.0相关接口
+     * *******
+     */
+    ApiEnum["GatewayIndex"] = "/api/v3/gateway/index";
+})(ApiEnum || (ApiEnum = {}));
+
+export { ApiEnum };

package/lib/sdk/platform/kook/sdk/wss.d.ts

@@ -0,0 +1,26 @@
+import { KOOKOptions } from './wss.types.js';
+import { KOOKAPI } from './api.js';
+import { KOOKEventMap } from './message.js';
+
+declare class KOOKClient extends KOOKAPI {
+    #private;
+    /**
+     *
+     * @param opstion
+     */
+    constructor(opstion: KOOKOptions);
+    /**
+     * 注册事件处理程序
+     * @param key 事件名称
+     * @param val 事件处理函数
+     */
+    on<T extends keyof KOOKEventMap>(key: T, val: (event: KOOKEventMap[T]) => any): this;
+    /**
+     * 使用获取到的网关连接地址建立 WebSocket 连接
+     * @param token
+     * @param conversation
+     */
+    connect(): Promise<void>;
+}
+
+export { KOOKClient };

package/lib/sdk/platform/kook/sdk/wss.js

@@ -0,0 +1,151 @@
+import WebSocket from 'ws';
+import { config } from './config.js';
+import { KOOKAPI } from './api.js';
+import { ConversationMap } from './conversation.js';
+
+class KOOKClient extends KOOKAPI {
+    // 标记是否已连接
+    #isConnected = false;
+    // 存储 session Id
+    #sessionId = null;
+    // 存储最新的消息序号
+    #lastMessageSN = 0;
+    /**
+     *
+     * @param opstion
+     */
+    constructor(opstion) {
+        super();
+        config.set('token', opstion.token);
+    }
+    #ws;
+    #events = {};
+    /**
+     * 注册事件处理程序
+     * @param key 事件名称
+     * @param val 事件处理函数
+     */
+    on(key, val) {
+        this.#events[key] = val;
+        return this;
+    }
+    /**
+     * 使用获取到的网关连接地址建立 WebSocket 连接
+     * @param token
+     * @param conversation
+     */
+    async connect() {
+        // 请求url
+        const gatewayUrl = await this.gateway()
+            .then(res => res?.data?.url)
+            .catch(err => {
+            if (this.#events['ERROR'])
+                this.#events['ERROR'](err);
+        });
+        if (!gatewayUrl && gatewayUrl == '')
+            return;
+        // 建立连接
+        const map = {
+            0: async ({ d, sn }) => {
+                /**
+                 * 处理 EVENT 信令
+                 * 包括按序处理消息和记录最新的消息序号
+                 */
+                if (d && sn) {
+                    if (sn === this.#lastMessageSN + 1) {
+                        /**
+                         * 消息序号正确
+                         * 按序处理消息
+                         */
+                        this.#lastMessageSN = sn;
+                        try {
+                            if (d.channel_type == 'GROUP') {
+                                const t = ConversationMap[d.type]['public'](d);
+                                if (this.#events[t])
+                                    await this.#events[t](d);
+                            }
+                            else {
+                                const t = ConversationMap[d.type]['direct'](d);
+                                if (this.#events[t])
+                                    await this.#events[t](d);
+                            }
+                        }
+                        catch (err) {
+                            if (this.#events['ERROR'])
+                                this.#events['ERROR'](err);
+                        }
+                        //
+                    }
+                    else if (sn > this.#lastMessageSN + 1) ;
+                    /**
+                     * 如果收到已处理过的消息序号
+                     * 则直接丢弃
+                     */
+                }
+            },
+            1: ({ d }) => {
+                if (d && d.code === 0) {
+                    console.info('[ws] ok');
+                    this.#sessionId = d.session_id;
+                    this.#isConnected = true;
+                }
+                else {
+                    console.info('[ws] err');
+                }
+            },
+            2: () => {
+                console.info('[ws] ping');
+                this.#ws.send(JSON.stringify({
+                    s: 3
+                }));
+            },
+            3: () => {
+                console.info('[ws] pong');
+            },
+            4: () => {
+                console.info('[ws] resume');
+            },
+            5: () => {
+                console.info('[ws] Connection failed, reconnect');
+                /**
+                 * 处理 RECONNECT 信令
+                 * 断开当前连接并进行重新连接
+                 */
+                this.#isConnected = false;
+                this.#sessionId = null;
+                console.info('[ws] sessionId', this.#sessionId);
+            },
+            6: () => {
+                console.info('[ws] resume ack');
+            }
+        };
+        this.#ws = new WebSocket(gatewayUrl);
+        this.#ws.on('open', () => {
+            console.info('[ws] open');
+        });
+        this.#ws.on('message', async (msg) => {
+            const message = JSON.parse(msg.toString('utf8'));
+            if (process.env.KOOK_WS == 'dev')
+                console.info('message', message);
+            if (map[message.s])
+                map[message.s](message);
+        });
+        // 心跳定时发送
+        setInterval(() => {
+            if (this.#isConnected) {
+                this.#ws.send(JSON.stringify({
+                    s: 2,
+                    sn: this.#lastMessageSN
+                }));
+            }
+        }, 30000);
+        this.#ws.on('close', () => {
+            console.error('[ws] close');
+        });
+        this.#ws.on('error', err => {
+            console.error('[ws] error', err);
+        });
+    }
+}
+
+export { KOOKClient };

package/lib/sdk/platform/kook/sdk/wss.types.d.ts

@@ -0,0 +1,12 @@
+/**
+ * ****
+ * ***
+ */
+interface KOOKOptions {
+    /**
+     * 钥匙
+     */
+    token: string;
+}
+
+export type { KOOKOptions };

package/package.json

@@ -1,14 +1,11 @@
 {
   "name": "@alemonjs/kook",
-  "version": "0.0.3",
+  "version": "0.1.1",
   "description": "kook-bot",
   "author": "lemonade",
   "license": "MIT",
   "type": "module",
   "main": "lib/index.js",
-  "dependencies": {
-    "chat-space": "^0.0.6"
-  },
   "types": "lib",
   "exports": {
     ".": {
@@ -23,11 +20,12 @@
     "chat-bot"
   ],
   "publishConfig": {
-    "registry": "https://registry.npmjs.org"
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
   },
-  "bugs": "https://github.com/ningmengchongshui/alemonjs/issues",
+  "bugs": "https://github.com/lemonade-lab/alemonjs/issues",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ningmengchongshui/alemonjs.git"
+    "url": "https://github.com/lemonade-lab/alemonjs.git"
   }
 }