kook-sdk 1.0.0

package/dist/utils/kmarkdown-builder.js

@@ -0,0 +1,291 @@
+"use strict";
+/**
+ * KMarkdown 构建器
+ * 用于方便地构建 KMarkdown 格式的消息内容
+ * 参考文档: https://github.com/kaiheila/api-docs/blob/main/docs/zh-cn/kmarkdown-desc.md
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KMarkdown = exports.KMarkdownBuilder = void 0;
+exports.kmd = kmd;
+class KMarkdownBuilder {
+    constructor() {
+        this.content = '';
+    }
+    /**
+     * 添加纯文本
+     */
+    text(text) {
+        this.content += this.escape(text);
+        return this;
+    }
+    /**
+     * 添加加粗文字
+     */
+    bold(text) {
+        this.content += `**${this.escape(text)}**`;
+        return this;
+    }
+    /**
+     * 添加斜体文字
+     */
+    italic(text) {
+        this.content += `*${this.escape(text)}*`;
+        return this;
+    }
+    /**
+     * 添加加粗斜体文字
+     */
+    boldItalic(text) {
+        this.content += `***${this.escape(text)}***`;
+        return this;
+    }
+    /**
+     * 添加删除线文字
+     */
+    strikethrough(text) {
+        this.content += `~~${this.escape(text)}~~`;
+        return this;
+    }
+    /**
+     * 添加下划线文字
+     */
+    underline(text) {
+        this.content += `(ins)${this.escape(text)}(ins)`;
+        return this;
+    }
+    /**
+     * 添加剧透文字
+     */
+    spoiler(text) {
+        this.content += `(spl)${this.escape(text)}(spl)`;
+        return this;
+    }
+    /**
+     * 添加链接
+     * @param text 链接文字
+     * @param url 链接地址 (仅支持 http, https)
+     * @param preview 是否显示链接预览 (需要 text 和 url 完全一致)
+     */
+    link(text, url, preview = false) {
+        if (preview) {
+            this.content += `[${url}](${url})`;
+        }
+        else {
+            this.content += `[${this.escape(text)}](${url})`;
+        }
+        return this;
+    }
+    /**
+     * 添加分隔线
+     */
+    divider() {
+        this.content += '\n---\n';
+        return this;
+    }
+    /**
+     * 添加引用
+     */
+    quote(text) {
+        const lines = text.split('\n');
+        const quotedLines = lines.map((line) => `> ${line}`);
+        this.content += quotedLines.join('\n') + '\n\n';
+        return this;
+    }
+    /**
+     * 添加行内代码
+     */
+    inlineCode(code) {
+        this.content += `\`${code}\``;
+        return this;
+    }
+    /**
+     * 添加代码块
+     */
+    codeBlock(code, language) {
+        this.content += '```' + (language || '') + '\n' + code + '\n```\n';
+        return this;
+    }
+    /**
+     * 提及用户
+     */
+    mention(userId) {
+        this.content += `(met)${userId}(met)`;
+        return this;
+    }
+    /**
+     * @所有人
+     */
+    mentionAll() {
+        this.content += '(met)all(met)';
+        return this;
+    }
+    /**
+     * @所有在线用户
+     */
+    mentionHere() {
+        this.content += '(met)here(met)';
+        return this;
+    }
+    /**
+     * 提及频道
+     */
+    channel(channelId) {
+        this.content += `(chn)${channelId}(chn)`;
+        return this;
+    }
+    /**
+     * 提及角色
+     */
+    role(roleId) {
+        this.content += `(rol)${roleId}(rol)`;
+        return this;
+    }
+    /**
+     * 添加 Emoji 表情
+     */
+    emoji(emojiCode) {
+        this.content += `:${emojiCode}:`;
+        return this;
+    }
+    /**
+     * 添加服务器表情
+     */
+    guildEmoji(emojiName, emojiId) {
+        this.content += `(emj)${emojiName}(emj)[${emojiId}]`;
+        return this;
+    }
+    /**
+     * 添加换行
+     */
+    newline(count = 1) {
+        this.content += '\n'.repeat(count);
+        return this;
+    }
+    /**
+     * 转义特殊字符
+     */
+    escape(text) {
+        return text
+            .replace(/\\/g, '\\\\')
+            .replace(/\*/g, '\\*')
+            .replace(/_/g, '\\_')
+            .replace(/\[/g, '\\[')
+            .replace(/\]/g, '\\]')
+            .replace(/\(/g, '\\(')
+            .replace(/\)/g, '\\)')
+            .replace(/`/g, '\\`')
+            .replace(/~/g, '\\~')
+            .replace(/>/g, '\\>');
+    }
+    /**
+     * 构建最终的 KMarkdown 字符串
+     */
+    build() {
+        return this.content.trim();
+    }
+    /**
+     * 清空内容
+     */
+    clear() {
+        this.content = '';
+        return this;
+    }
+    /**
+     * 获取当前内容
+     */
+    toString() {
+        return this.content;
+    }
+}
+exports.KMarkdownBuilder = KMarkdownBuilder;
+/**
+ * 创建 KMarkdown 构建器的快捷函数
+ */
+function kmd() {
+    return new KMarkdownBuilder();
+}
+/**
+ * 预设的 KMarkdown 快捷方法
+ */
+exports.KMarkdown = {
+    /**
+     * 加粗
+     */
+    bold: (text) => `**${text}**`,
+    /**
+     * 斜体
+     */
+    italic: (text) => `*${text}*`,
+    /**
+     * 加粗斜体
+     */
+    boldItalic: (text) => `***${text}***`,
+    /**
+     * 删除线
+     */
+    strikethrough: (text) => `~~${text}~~`,
+    /**
+     * 下划线
+     */
+    underline: (text) => `(ins)${text}(ins)`,
+    /**
+     * 剧透
+     */
+    spoiler: (text) => `(spl)${text}(spl)`,
+    /**
+     * 链接
+     */
+    link: (text, url) => `[${text}](${url})`,
+    /**
+     * 带预览的链接
+     */
+    linkWithPreview: (url) => `[${url}](${url})`,
+    /**
+     * @用户
+     */
+    mention: (userId) => `(met)${userId}(met)`,
+    /**
+     * @所有人
+     */
+    mentionAll: () => '(met)all(met)',
+    /**
+     * @在线用户
+     */
+    mentionHere: () => '(met)here(met)',
+    /**
+     * #频道
+     */
+    channel: (channelId) => `(chn)${channelId}(chn)`,
+    /**
+     * @角色
+     */
+    role: (roleId) => `(rol)${roleId}(rol)`,
+    /**
+     * Emoji 表情
+     */
+    emoji: (code) => `:${code}:`,
+    /**
+     * 服务器表情
+     */
+    guildEmoji: (name, id) => `(emj)${name}(emj)[${id}]`,
+    /**
+     * 行内代码
+     */
+    inlineCode: (code) => `\`${code}\``,
+    /**
+     * 代码块
+     */
+    codeBlock: (code, language) => '```' + (language || '') + '\n' + code + '\n```',
+    /**
+     * 引用
+     */
+    quote: (text) => text
+        .split('\n')
+        .map((line) => `> ${line}`)
+        .join('\n'),
+    /**
+     * 分隔线
+     */
+    divider: () => '---',
+};
+//# sourceMappingURL=kmarkdown-builder.js.map

package/dist/utils/kmarkdown-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"kmarkdown-builder.js","sourceRoot":"","sources":["../../src/utils/kmarkdown-builder.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAyNH,kBAEC;AAzND,MAAa,gBAAgB;IAA7B;QACU,YAAO,GAAW,EAAE,CAAC;IAiN/B,CAAC;IA/MC;;OAEG;IACH,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,OAAO,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAY;QACjB,IAAI,CAAC,OAAO,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,IAAY;QACrB,IAAI,CAAC,OAAO,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,IAAY;QACxB,IAAI,CAAC,OAAO,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,IAAY;QACpB,IAAI,CAAC,OAAO,IAAI,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;QACjD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,OAAO,IAAI,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;QACjD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAY,EAAE,GAAW,EAAE,UAAmB,KAAK;QACtD,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,OAAO,IAAI,IAAI,GAAG,KAAK,GAAG,GAAG,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QACnD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,OAAO,IAAI,SAAS,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAY;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,IAAY;QACrB,IAAI,CAAC,OAAO,IAAI,KAAK,IAAI,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,IAAY,EAAE,QAAiB;QACvC,IAAI,CAAC,OAAO,IAAI,KAAK,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,GAAG,SAAS,CAAC;QACnE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,MAAc;QACpB,IAAI,CAAC,OAAO,IAAI,QAAQ,MAAM,OAAO,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,UAAU;QACR,IAAI,CAAC,OAAO,IAAI,eAAe,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,WAAW;QACT,IAAI,CAAC,OAAO,IAAI,gBAAgB,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,SAAiB;QACvB,IAAI,CAAC,OAAO,IAAI,QAAQ,SAAS,OAAO,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,MAAc;QACjB,IAAI,CAAC,OAAO,IAAI,QAAQ,MAAM,OAAO,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAiB;QACrB,IAAI,CAAC,OAAO,IAAI,IAAI,SAAS,GAAG,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,SAAiB,EAAE,OAAe;QAC3C,IAAI,CAAC,OAAO,IAAI,QAAQ,SAAS,SAAS,OAAO,GAAG,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,OAAO,CAAC,QAAgB,CAAC;QACvB,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,IAAY;QACzB,OAAO,IAAI;aACR,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;aACtB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;aACpB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;aACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;aACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;aACrB,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;aACrB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;aACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC;aACpB,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;CACF;AAlND,4CAkNC;AAED;;GAEG;AACH,SAAgB,GAAG;IACjB,OAAO,IAAI,gBAAgB,EAAE,CAAC;AAChC,CAAC;AAED;;GAEG;AACU,QAAA,SAAS,GAAG;IACvB;;OAEG;IACH,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI;IAErC;;OAEG;IACH,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG;IAErC;;OAEG;IACH,UAAU,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,MAAM,IAAI,KAAK;IAE7C;;OAEG;IACH,aAAa,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI;IAE9C;;OAEG;IACH,SAAS,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,QAAQ,IAAI,OAAO;IAEhD;;OAEG;IACH,OAAO,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,QAAQ,IAAI,OAAO;IAE9C;;OAEG;IACH,IAAI,EAAE,CAAC,IAAY,EAAE,GAAW,EAAE,EAAE,CAAC,IAAI,IAAI,KAAK,GAAG,GAAG;IAExD;;OAEG;IACH,eAAe,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,GAAG,KAAK,GAAG,GAAG;IAEpD;;OAEG;IACH,OAAO,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,QAAQ,MAAM,OAAO;IAElD;;OAEG;IACH,UAAU,EAAE,GAAG,EAAE,CAAC,eAAe;IAEjC;;OAEG;IACH,WAAW,EAAE,GAAG,EAAE,CAAC,gBAAgB;IAEnC;;OAEG;IACH,OAAO,EAAE,CAAC,SAAiB,EAAE,EAAE,CAAC,QAAQ,SAAS,OAAO;IAExD;;OAEG;IACH,IAAI,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,QAAQ,MAAM,OAAO;IAE/C;;OAEG;IACH,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,IAAI,GAAG;IAEpC;;OAEG;IACH,UAAU,EAAE,CAAC,IAAY,EAAE,EAAU,EAAE,EAAE,CAAC,QAAQ,IAAI,SAAS,EAAE,GAAG;IAEpE;;OAEG;IACH,UAAU,EAAE,CAAC,IAAY,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI;IAE3C;;OAEG;IACH,SAAS,EAAE,CAAC,IAAY,EAAE,QAAiB,EAAE,EAAE,CAC7C,KAAK,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,GAAG,IAAI,GAAG,IAAI,GAAG,OAAO;IAElD;;OAEG;IACH,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE,CACtB,IAAI;SACD,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC;SAC1B,IAAI,CAAC,IAAI,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,GAAG,EAAE,CAAC,KAAK;CACrB,CAAC"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "kook-sdk",
+  "version": "1.0.0",
+  "description": "KOOK Bot SDK for Node.js - 开黑啦机器人开发工具包",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "ts-node examples/bot-example.ts",
+    "lint": "eslint src/**/*.ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "kook",
+    "开黑啦",
+    "bot",
+    "sdk",
+    "chatbot",
+    "websocket",
+    "kmarkdown",
+    "card-message"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ponyidc/kook-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ponyidc/kook-sdk/issues"
+  },
+  "homepage": "https://github.com/ponyidc/kook-sdk#readme",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.2",
+    "form-data": "^4.0.5",
+    "ws": "^8.14.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.4",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
+    "eslint": "^8.55.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.3.3"
+  }
+}