Ion.js

Yet another QQ bot framework based on CQHTTP & CoolQ.

介绍

Ion.js 是一个用 TypeScript 写就，在 Node.js 环境下运行，基于 CQHTTP 和 酷Q 的 QQ 机器人框架。

Ion.js 提供两类消息处理器：中间件和会话。接收到的消息将经过中间件依次处理，并最终分发给会话。得益于 JavaScript 的异步 I/O 与对消息流的封装，开发者可以便捷地创建与用户持续交互的会话；同时，Ion.js 提供了一系列实用工具（甚至一个用以声明命令的 DSL），以更加方便地描述、书写消息处理器。

Ion.js 使用 koa 来与 CQHTTP 通信，同时使用了 Node.js 原生的 stream.PassThrough 简单流来构造持续的消息流。

需要注意的是，Ion.js 仍使用的是传统的 HTTP 通信方式，且不内置对会话状态的长期存储（即仅有内存存储）；Ion.js 要求 Node.js 环境支持 ES2017，CQHTTP 插件在版本 4 以上。

特性

• 是可引入的 CommonJS 模块，因此无需遵循特定的路径结构；
• 有一系列实用工具，包括获取消息时的条件判断与CQ码的处理等；
• 支持真正的中间件，数据传至下游、控制传回上游；
• 提供更强大的命令声明与解析，包括具名参数、引号转义、默认值等；
• 支持创建与用户持续交互的会话，使用友好的异步 I/O。

文档

贡献

• 如果本项目对你有帮助，请点一颗 Star。
• 如遇到任何问题，且确定问题来源不是你的代码，请第一时间提出 issue 以便 Ion.js 修复。
• 欢迎 Pull Requests。

0.6.5 (2019-03-09)

Bug Fixes

• BotWhen: use a no-prefix command when none is given in config, even withPrefixes (2dbadd6)
• BotWhen#command: args should be message content instead of message objects (cbff21e)
• middleware timeout: only log middleware timeout warn when the run isn't finished (1cc52e1)

0.6.4 (2019-02-11)

Performance Improvements

• dependencies: remove @types/sinon from dependencies (c6297c2)

0.6.3 (2019-02-11)

Bug Fixes

• dependencies: put @types/* in dependencies instead of devDependencies (d21cd25)

0.6.2 (2019-02-10)

Bug Fixes

• add "app.*" to package.json#files (ee932b4)

Warning: The content below are NOT conventional changelog.

0.6.1

• [Fix] 修复了 BotWhen#at() 在私聊中永远不会被触发的 Bug
• [Fix] 修复了 Sender#send() 只对 post_type: 'message' 的上报消息有效的 Bug
• [Add] 增加了示例项目（/example/，inspired from richardchien/nonebot/demo/）

0.6.0

• [Change] 将 BotWhen.init() 改为 BotWhen#init()
• [Add] 添加了 use*Metadata 与 get*Metadata 等元信息管理函数

0.5.1

• [Fix] 修复了会话管理器预置标识符生成器的错误逻辑
• [Fix] 修复了 ISessionContext#init 错误的 typings

0.5.0

• [Remove] 移除一切附属 package 并停止开发附属 package
• [Fix] 修复了在将 setter ISessionContext#timeout 设为大于 Number.MAX_SAFE_INT 值时仍然运行 setTimeout() 的问题
• [Add] 增加了导出变量 sessionCount，为正在进行的会话计数。
• [Change] 使用 Map 而不是原生 Object 存储命令形参数据
• [Change] 使用 Map 而不是原生 Object 存储会话管理器
• [Change] 使用 Httpie 作为 Sender 的 HTTP 框架

0.4.0

• [Change] 将处理队列的超时在 init({...}) 中更名为 middlewareTimeout
• [Change] 增加会话的默认超时，在 init({...}) 中为 sessionTimeout，并可在 ISessionContext#timeout 中使用 setter 重置

0.3.1

• [Add] 增加了一些 logger
• [Security] 增加了若干对用户代码的 error catches

0.3.0

• [Add] 增加部分文档
• [Change] 重构了 CommandParseError，增加了 prop args, notGiven
• [Remove] 移除了 Command#parse() 的第二个参数并改为同步函数
• [Change] 重构了 BotWhen#command()
• [Add] 开始开发附属 package：auto-accept

0.2.0

• [Add] 增加部分文档
• [Change] 将 IStrangeInfoResult, IMemberInfoResult 合并为 IInfoResult
• [Change] 将 SessionStore 改为泛型类
• [Add] 向 When 类添加 TValidatorCallback 作为 TValidator 的回调
• [Change] 将 MiddlewareManager 改为泛型类
• [Add] 增加接口 IMessage 用以表示 CQHTTP 上报消息，TExtensibleMessage 用以表示包含其他 props 的 IMessage

0.1.3

• [Security] 增加处理队列的超时时间

0.1.2

• [Add] 增加部分文档
• [Add] 导出实用函数 unionIdOf()
• [Fix] 修复 default 会话管理器错误的会话标识符
• [Fix] 修复 Utils 中 filterType() 的 bug
• [Security] 使用 Promise-based 处理队列来保证会话处理的稳定性

0.1.0, 0.1.1

• [Add] 迁移 ionjs-dev/adapter-cqhttp => classes/receiver, classes/sender, classes/cqcode
• [Add] 迁移 ionjs-dev/flow => classes/session
• [Add] 迁移 ionjs-dev/command => classes/command
• [Add] 迁移 ionjs-dev/chan/middleware => classes/middleware
• [Fix] Sender#to() 方法现在返回一个新的实例
• [Remove] 删除了 SessionManager#removeBehavior()
• [Change] 更改了 debug loggers 中的类名和模块名，微调级别
• [Add] 增加了 Command 类的 typings
• [Add] 增加了 CommandParseError 类作为 Command#parse() 抛出的错误类型
• [Add] 增加了 Command#parse() 的第二个参数作为参数处理器
• [Change] 将 Command#parse() 改为异步函数
• [Fix] 使用与 koa 相同的正确的中间件实现
• [Add] 增加类型别名 TMiddleware
• [Change] SessionManager 改为 SessionStore 抽象基类
• [Change] SessionStore#addBehavior(IBehavior) 改为 SessionStore#use(...any)，SessionStore#push(any) 改为 SessionStore#run(any)
• [Add] 增加类型别名 TSessionFn, TMatcher
• [Change] ConcurrentSessionManager#use 参数列表改为 (TSessionFn, TMatcher)
• [Change] SingleSessionManager#use 参数列表改为 (TSessionFn, TMatcher)
• [Add] 增加了默认中间件管理器实例
• [Add] 增加了导出函数 init(), start(), useMiddleware(), useSession()(), runMiddleware(), runSession
• [Add] 为 split() 增加了自定义分隔符与界定符
• [Add] 增加接口 ICQCode
• [Change] 将 Sender 请求结果接口加上统一后缀 Result
• [Add] 增加 When 类，用来生成判断条件以及解析上报对象
• [Add] 增加 When 实例的默认导出
• [Add] 增加默认会话管理器实例
• [Add] 增加会话上下文接口 ISessionContext
• [Add] 增加导出实用函数 contextTypeOf()
• [Security] 预防了 *SessionManager 可能的内存泄露
• [Change] 将 package 重命名为 @ionjs/core