https://github.com/ukatech/jsstp-lib
Use js to communicate with ukagaka in environments such as web pages or node.js in order to exchange information.
https://github.com/ukatech/jsstp-lib
js ukagaka web
Last synced: 4 months ago
JSON representation
Use js to communicate with ukagaka in environments such as web pages or node.js in order to exchange information.
- Host: GitHub
- URL: https://github.com/ukatech/jsstp-lib
- Owner: ukatech
- License: other
- Created: 2023-03-05T12:55:44.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-26T03:00:17.000Z (almost 2 years ago)
- Last Synced: 2025-10-24T16:29:02.491Z (7 months ago)
- Topics: js, ukagaka, web
- Language: JavaScript
- Homepage: https://ukatech.github.io/jsstp-lib/
- Size: 1.32 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](./docs/README_JP.md)
[](./docs/README_EN.md)
[](./docs/README_CN.md)
# jsstp
[](https://www.jsdelivr.com/package/gh/ukatech/jsstp-lib)
[](https://www.npmjs.com/package/jsstp)
[](./dist/jsstp.min.js)
用js在网页或node.js等环境中与伪春菜通信以实现信息交换。
详情参考[伪春菜](https://zh.moegirl.org.cn/zh-hans/%E4%BC%AA%E6%98%A5%E8%8F%9C)与[SSTP](https://ssp.shillest.net/ukadoc/manual/spec_sstp.html)。
## 用法
### 1. 引入js
#### npm
如果你使用npm，你可以使用npm安装jsstp
```shell
npm i jsstp
```
之后在js中使用`import`引入jsstp
```javascript
import jsstp from "jsstp";
//或者
var {jsstp}=await import("jsstp");
```
在CommonJS中，你也可以使用`require`引入jsstp
```javascript
var {jsstp}=require('jsstp');
```
#### cdn
或者你是怀旧党，你可以通过cdn访问jsstp的源码
```html
```
或者在js中动态载入jsstp
```javascript
var {jsstp}=await import("https://cdn.jsdelivr.net/gh/ukatech/jsstp-lib@v3.2.0.0/dist/jsstp.mjs");
```
##### 类型定义
即使使用cdn并手把手编写js代码，你也可以在ide中使用jsstp的类型定义文件以获得代码提示
首先确保你的ide可以访问jsstp，你或许可以全局安装它来在不干扰工作区文件的情况下使用它
```shell
npm i -g jsstp
```
随后，在使用jsstp的文件头部添加类型导入，根据types约定，这个声明必须在任何正式代码之前
```javascript
///
```
最后在jsstp的声明前用JSDoc注释声明其类型
```javascript
/** @type {typeof import("jsstp").jsstp} */
var jsstp;
```
###### 类型定义：i18n
jsstp的类型定义提供了中日英三语的支持，正常情况下你可以这样指定加载的语言
```javascript
///
// or
///
// or
///
```
不过如果你的ide在这样使用时出了错（或者你懒得每次都指定语言），你可以考虑手动修改`package.json`中的`types`字段来指定默认的语言
```json
{
"types": "dist/cn/jsstp.d.ts"
}
```
### 2. 使用
jsstp现在有专门的文档页面了！
你可以访问来获取更专业的信息
在观看文档的过程中，你可以在[jsstp playground](https://ukatech.github.io/jsstp-lib/playground)中尝试jsstp的各种功能
____
你可能需要先在jsstp相关操作前检查ghost是否可用
```javascript
if (!await jsstp.available())
console.log("ghost不可用,请检查ghost是否启动");
```
jsstp2.0前曾经支持将回调函数作为参数传入，现在已经不再支持
如果你需要的话，可以使用`Promise`或者`async`/`await`来获取返回值
你可以使用`jsstp.SEND`来发送报文
```javascript
jsstp.SEND(
{//事件信息
"Event": "OnTest",
"Script": "\\0Hello, World!\\e"
}
).then((data) => {
console.log("head: " + data.head);
console.log(JSON.stringify(data));
console.log(data["Script"]);
});
```
jsstp支持所有的sstp基础操作，`jsstp.[SEND|NOTIFY|COMMUNICATE|EXECUTE|GIVE]`都可以被调用。
如果你喜欢怀旧，只想获得报文本身，你可以使用`jsstp.[SEND|NOTIFY|COMMUNICATE|EXECUTE|GIVE].get_raw`
如果你只是想触发事件，而不需要自定义发送较为复杂的报文，可以这样写
```javascript
let data = await jsstp.OnTest("from jsstp.js!", 123123);
```
这等价于：
```javascript
let data = await jsstp.SEND({
"Event": "OnTest",
"Reference0": "from jsstp.js!",
"Reference1": 123123
});
```
对于所有事件你都可以这样写，不过如果事件不以`On`开头，你需要在事件名前加上`On_`来访问jsstp，这样它才能识别到你想要触发事件
你也可以使用`jsstp.event.事件名(参数)`来触发事件，这样你就不需要在事件名前加上`On_`了
在获取到返回内容后，其类型是`jsstp.sstp_info_t`，使用方法各种各样
- 以下是自`info_object`继承的方法
```javascript
data.keys; //获取所有键
data.values; //获取所有值
data.entries; //获取所有键值对
data.length; //获取键值对数量
data.forEach((value, key) => console.log(key + "=" + value)); //遍历所有键值对：如果遍历函数有返回值，该值会被更新到此键值对中
//省略key参数可以只遍历值
data.map((value, key) => value + "1"); //遍历所有键值对并返回一个由遍历函数返回值组成的数组
//省略key参数可以只遍历值
```
- 以下是自`jsstp.base_sstp_info_t`继承的方法
```javascript
data.status_code; //获取状态码
data.head; //获取报文头
data.Script; //获取报文中的Script键的值（其他键也可以这样获取）
data.status_code_text; //获取报文头中的状态码文本
```
- 以下是`jsstp.sstp_info_t`自有的方法
```javascript
data.get_passthrough("Result");
//获取报文中`X-SSTP-PassThru`的某个键的值，和`data["X-SSTP-PassThru-Result"]`等价
//你也可以直接使用`data.Result`或者`data["Result"]`来获取`X-SSTP-PassThru-Result`的值：这可能简洁一些
data.passthroughs; //获取所有`X-SSTP-PassThru`键值对
data.raw; //去除代理，访问原始对象
```
`sstp_info_t`自构造起便被一层代理包裹着，考虑到大多数情况开发者不需要访问非`X-SSTP-PassThru`键值对，此代理会在你访问某个键而该键存在`X-SSTP-PassThru`版本时优先返回`X-SSTP-PassThru-{key}`键的值。
换句话说，假若返回的报文有`Script`键和`X-SSTP-PassThru-Script`键，那么`data.Script`或`data["Script"]`会返回`X-SSTP-PassThru-Script`的值，而`data.raw.Script`和`data.raw["Script"]`会返回`Script`的值。
大多数情况下这个代理会减轻你的代码量，而在你需要访问非`X-SSTP-PassThru`键值对时，请一定记得使用`data.raw`来访问原始对象。
如果你想获取ghost是否支持某个事件，可以这样写
```javascript
let result = await jsstp.has_event("OnTest");//这和jsstp.event.Has_Event(event_name, security_level).then(({ Result }) => Result == "1")几乎一样！
console.log(result);
```
如果你想大批量的查询事件（像ukadoc那样！），你可以使用`jsstp.new_event_queryer()`来获取一个queryer
```javascript
let queryer = await jsstp.new_event_queryer();
```
queryer的类型是`jsstp.ghost_events_queryer_t`，使用方法各种各样
```javascript
queryer.check_event("OnTest").then(result => console.log(result));
```
queryer和`jsstp`一样，检查事件时有可选的参数指定事件的安全等级，默认的安全等级随着`jsstp`的运行环境而变化：
如果jsstp运行在node.js中，安全等级为`local`，如果jsstp运行在浏览器中，安全等级为`external`（因为浏览器中的jsstp只能触发外部事件！）
如果你想要固定查询local事件，你需要指定安全等级为`local`，像这样：
```javascript
queryer.check_event("OnBoot", "local");
jsstp.has_event("OnBoot", "local");//使用jsstp的话这样
```
queryer还支持一些快速检测
queryer与构造它的jsstp实例是绑定的，如果你想要让queryer指向特定的ghost，通过设置`jsstp.default_info`来修改默认的附加报文并使用`reset`清空缓存
```javascript
//使用fmo中得到的hwnd，这可以避免重名导致的尴尬情况
jsstp.default_info.ReceiverGhostHWnd = fmo[uuid].hwnd;//fmo的获取方法见下文，这里只是举个例子
await queryer.reset();
```
如果你确定你的ghost名称足够独特，你也可以直接使用ghost名称，这两个方法只用其中一个就可以了
```javascript
jsstp.default_info.ReceiverGhostName = "橘花";
await queryer.reset();
```
queryer还支持一些快速检测用于检查queryer的可用性
```javascript
if (!queryer.available)
console.info("无法获取支持的事件列表");//queryer不可用，你需要提醒用户更新ghost或者向其作者反馈：jsstp和ghost terminal一样使用`Has_Event`事件来检查事件的可用情况。
if (!queryer.fast_query_available)
console.info("无法快速获取支持的事件列表");//这不会影响使用，只是会导致查询未缓存的事件时会发出一次查询请求：如果ghost支持`Get_Supported_Events`事件的话queryer会使用它来获取事件列表（这样会快不少！）
else
console.info("好哦");
```
如果你想获取fmo信息，可以这样写
```javascript
let fmo = await jsstp.get_fmo_infos();
if (fmo.available)
console.log(fmo);
```
fmo的类型是`jsstp.fmo_info_t`，使用方法各种各样
`fmo_info_t`是特化的`base_sstp_info_t`，所以你可以对其使用`base_sstp_info_t`的所有方法（也就是说，`sstp_info_t`的所有方法除了`get_passthrough`）
它还有一些特殊的方法
```javascript
fmo.uuids; //获取所有uuid，和`fmo.keys`等价
fmo.get_uuid_by("fullname", "Taromati2"); //获取指定属性值与指定值相等的uuid
fmo.get_list_of("fullname"); //获取指定属性的所有值
fmo.available; //获取fmo是否有内容
```
fmo的每个键值对都是`String:info_object`，键是uuid，值是该uuid对应的fmo信息
你仍然可以使用`info_object`的成员方法来操作fmo的中的fmo信息（参见上文中对于`sstp_info_t`的介绍）
如果你还是不太理解，可以在控制台查看fmo的结构或者查看jsstp的源码