@shirokasoke/webapi-sdk 2.9.0-beta2-0.11-pre → 2.9.0-beta2-0.11-test2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +27 -0
- package/dist/client.js +60 -1
- package/dist/esm/client.js +60 -1
- package/dist/esm/validators/block.js +3 -2
- package/dist/esm/validators/gt5.js +2 -1
- package/dist/esm/validators/item.js +5 -3
- package/dist/types/block.d.ts +3 -2
- package/dist/types/gt5.d.ts +2 -1
- package/dist/types/item.d.ts +10 -3
- package/dist/validators/block.js +2 -1
- package/dist/validators/gt5.js +2 -1
- package/dist/validators/item.d.ts +1 -0
- package/dist/validators/item.js +6 -4
- package/package.json +4 -3
package/dist/client.d.ts
CHANGED
|
@@ -9,6 +9,7 @@ export declare class WebApiClient {
|
|
|
9
9
|
private baseUrl;
|
|
10
10
|
private authToken?;
|
|
11
11
|
private fetchImpl;
|
|
12
|
+
SSE: boolean;
|
|
12
13
|
constructor(options: WebApiClientOptions);
|
|
13
14
|
private request;
|
|
14
15
|
/**
|
|
@@ -20,6 +21,8 @@ export declare class WebApiClient {
|
|
|
20
21
|
* @param callback 业务数据回调
|
|
21
22
|
* @param errorCallback 出错回调,接收模板抛出或 `parse` 抛出的异常(如 {@link WebApiError})
|
|
22
23
|
* @param parse 解析事件的 data 文本为业务数据,抛出异常表示该帧无效
|
|
24
|
+
* @param init 可选的请求附加参数(如 GT5 批量 SSE 需 POST JSON body);携带 body 时自动附加
|
|
25
|
+
* `Content-Type: application/json`
|
|
23
26
|
* @returns AbortController,调用 `abort()` 可停止订阅
|
|
24
27
|
*/
|
|
25
28
|
private subscribeSse;
|
|
@@ -28,6 +31,15 @@ export declare class WebApiClient {
|
|
|
28
31
|
* @returns 使用 {@link RootInfoSchema} 验证
|
|
29
32
|
*/
|
|
30
33
|
getRoot(): Promise<RootInfo>;
|
|
34
|
+
/**
|
|
35
|
+
* SSE 可用性探测:连接测试端点 `/test/sse`,确认服务端 SSE(Server-Sent Events)通道可用。
|
|
36
|
+
*
|
|
37
|
+
* 注意:仅当服务端启用虚拟线程(useVirtualThreads)时该路由才会注册。
|
|
38
|
+
* @param timeoutMs 探测超时(ms)
|
|
39
|
+
* @returns 服务端 SSE 可用返回 `true`,否则返回 `false`
|
|
40
|
+
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/test/SSETestHandler.java)
|
|
41
|
+
*/
|
|
42
|
+
getSSE(timeoutMs?: number): Promise<boolean>;
|
|
31
43
|
/**
|
|
32
44
|
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/TPSHandler.java)
|
|
33
45
|
* @returns 使用 `Joi.object().pattern(Joi.string(), {@link TPSInfoSchema})` 验证
|
|
@@ -311,6 +323,21 @@ export declare class WebApiClient {
|
|
|
311
323
|
* @returns 使用 {@link GT5ScanJobResultSchema} 验证
|
|
312
324
|
*/
|
|
313
325
|
waitForGT5ScanJob(jobId: string, intervalMs?: number): Promise<GT5ScanJobResult>;
|
|
326
|
+
/**
|
|
327
|
+
* 以回调方式订阅批量 GT5 机器信息 SSE 推送(基于 fetchEventSource,可携带 Authorization 头,原生 EventSource 不支持)。
|
|
328
|
+
* 服务端以 `machines` 数组作为 POST body 提交批量查询,任务完成后推送一次 `gt5` 事件
|
|
329
|
+
* ({@link GT5BatchJobResult} JSON,含 machines 结果),随后每隔 interval 秒(默认 5)自动重跑并再次推送;
|
|
330
|
+
* 连接建立后发生异常时推送 `error` 事件(纯文本消息)并关闭连接。
|
|
331
|
+
* @param machines 目标机器坐标列表,作为 POST JSON body 提交
|
|
332
|
+
* @param callback 每次收到批量查询完整结果(任务完成,含 machines)时调用
|
|
333
|
+
* @param errorCallback 出错(网络错误、鉴权失败、服务端 error 事件、业务失败、数据解析失败)时调用,库内自动重连会随之停止
|
|
334
|
+
* @param params.interval 任务完成后自动重跑的间隔(秒),省略时由服务端取默认值
|
|
335
|
+
* @returns AbortController,调用 `abort()` 可停止订阅
|
|
336
|
+
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchSSEHandler.java)
|
|
337
|
+
*/
|
|
338
|
+
gt5BatchSseCallback(machines: GT5BatchMachineCoord[], callback: (data: GT5BatchJobResult) => void, errorCallback: (error: Error) => void, params?: {
|
|
339
|
+
interval?: number;
|
|
340
|
+
}): AbortController;
|
|
314
341
|
/**
|
|
315
342
|
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEBaseHandler.java)
|
|
316
343
|
* @returns 使用 {@link AEHitResultSchema} 验证
|
package/dist/client.js
CHANGED
|
@@ -19,6 +19,7 @@ function unwrapApiResponse(body) {
|
|
|
19
19
|
}
|
|
20
20
|
class WebApiClient {
|
|
21
21
|
constructor(options) {
|
|
22
|
+
this.SSE = false;
|
|
22
23
|
this.baseUrl = options.baseUrl.replace(/\/$/, "");
|
|
23
24
|
this.authToken = options.authToken;
|
|
24
25
|
const globalFetch = typeof globalThis !== "undefined" ? globalThis.fetch : undefined;
|
|
@@ -61,16 +62,23 @@ class WebApiClient {
|
|
|
61
62
|
* @param callback 业务数据回调
|
|
62
63
|
* @param errorCallback 出错回调,接收模板抛出或 `parse` 抛出的异常(如 {@link WebApiError})
|
|
63
64
|
* @param parse 解析事件的 data 文本为业务数据,抛出异常表示该帧无效
|
|
65
|
+
* @param init 可选的请求附加参数(如 GT5 批量 SSE 需 POST JSON body);携带 body 时自动附加
|
|
66
|
+
* `Content-Type: application/json`
|
|
64
67
|
* @returns AbortController,调用 `abort()` 可停止订阅
|
|
65
68
|
*/
|
|
66
|
-
subscribeSse(url, eventName, callback, errorCallback, parse) {
|
|
69
|
+
subscribeSse(url, eventName, callback, errorCallback, parse, init) {
|
|
67
70
|
const controller = new AbortController();
|
|
68
71
|
const headers = {};
|
|
72
|
+
if (init?.body !== undefined) {
|
|
73
|
+
headers["Content-Type"] = "application/json";
|
|
74
|
+
}
|
|
69
75
|
if (this.authToken) {
|
|
70
76
|
headers["Authorization"] = this.authToken;
|
|
71
77
|
}
|
|
72
78
|
(0, fetch_event_source_1.fetchEventSource)(url, {
|
|
73
79
|
signal: controller.signal,
|
|
80
|
+
method: init?.method,
|
|
81
|
+
body: init?.body,
|
|
74
82
|
headers,
|
|
75
83
|
openWhenHidden: true,
|
|
76
84
|
fetch: this.fetchImpl,
|
|
@@ -114,6 +122,36 @@ class WebApiClient {
|
|
|
114
122
|
getRoot() {
|
|
115
123
|
return this.request("/version");
|
|
116
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
* SSE 可用性探测:连接测试端点 `/test/sse`,确认服务端 SSE(Server-Sent Events)通道可用。
|
|
127
|
+
*
|
|
128
|
+
* 注意:仅当服务端启用虚拟线程(useVirtualThreads)时该路由才会注册。
|
|
129
|
+
* @param timeoutMs 探测超时(ms)
|
|
130
|
+
* @returns 服务端 SSE 可用返回 `true`,否则返回 `false`
|
|
131
|
+
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/test/SSETestHandler.java)
|
|
132
|
+
*/
|
|
133
|
+
getSSE(timeoutMs = 500) {
|
|
134
|
+
if (this.SSE)
|
|
135
|
+
return Promise.resolve(this.SSE);
|
|
136
|
+
return new Promise(resolve => {
|
|
137
|
+
let controller;
|
|
138
|
+
let settled = false;
|
|
139
|
+
let timer;
|
|
140
|
+
/** 首次结果生效,后续(含 abort 触发的 onerror)一律忽略 */
|
|
141
|
+
const finish = (ok) => {
|
|
142
|
+
if (settled)
|
|
143
|
+
return;
|
|
144
|
+
settled = true;
|
|
145
|
+
if (timer !== undefined)
|
|
146
|
+
clearTimeout(timer);
|
|
147
|
+
controller?.abort();
|
|
148
|
+
this.SSE = ok;
|
|
149
|
+
resolve(ok);
|
|
150
|
+
};
|
|
151
|
+
timer = setTimeout(() => finish(false), timeoutMs);
|
|
152
|
+
controller = this.subscribeSse(`${this.baseUrl}/test/sse`, "success", () => finish(true), () => finish(false), raw => raw);
|
|
153
|
+
});
|
|
154
|
+
}
|
|
117
155
|
// region TPS / Performance
|
|
118
156
|
/**
|
|
119
157
|
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/TPSHandler.java)
|
|
@@ -434,6 +472,27 @@ class WebApiClient {
|
|
|
434
472
|
await new Promise(r => setTimeout(r, intervalMs));
|
|
435
473
|
}
|
|
436
474
|
}
|
|
475
|
+
/**
|
|
476
|
+
* 以回调方式订阅批量 GT5 机器信息 SSE 推送(基于 fetchEventSource,可携带 Authorization 头,原生 EventSource 不支持)。
|
|
477
|
+
* 服务端以 `machines` 数组作为 POST body 提交批量查询,任务完成后推送一次 `gt5` 事件
|
|
478
|
+
* ({@link GT5BatchJobResult} JSON,含 machines 结果),随后每隔 interval 秒(默认 5)自动重跑并再次推送;
|
|
479
|
+
* 连接建立后发生异常时推送 `error` 事件(纯文本消息)并关闭连接。
|
|
480
|
+
* @param machines 目标机器坐标列表,作为 POST JSON body 提交
|
|
481
|
+
* @param callback 每次收到批量查询完整结果(任务完成,含 machines)时调用
|
|
482
|
+
* @param errorCallback 出错(网络错误、鉴权失败、服务端 error 事件、业务失败、数据解析失败)时调用,库内自动重连会随之停止
|
|
483
|
+
* @param params.interval 任务完成后自动重跑的间隔(秒),省略时由服务端取默认值
|
|
484
|
+
* @returns AbortController,调用 `abort()` 可停止订阅
|
|
485
|
+
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchSSEHandler.java)
|
|
486
|
+
*/
|
|
487
|
+
gt5BatchSseCallback(machines, callback, errorCallback, params) {
|
|
488
|
+
return this.subscribeSse(`${this.baseUrl}/gt5/batch/sse${buildQuery(params ?? {})}`, "gt5", callback, errorCallback, raw => {
|
|
489
|
+
const body = JSON.parse(raw);
|
|
490
|
+
// 服务端当前推送裸对象(其 success 为数字计数),同时兼容 ApiResponse 包装形式(success 为布尔值)
|
|
491
|
+
return typeof body.success === "boolean"
|
|
492
|
+
? unwrapApiResponse(body)
|
|
493
|
+
: body;
|
|
494
|
+
}, { method: "POST", body: JSON.stringify(machines) });
|
|
495
|
+
}
|
|
437
496
|
// region AE2
|
|
438
497
|
/**
|
|
439
498
|
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEBaseHandler.java)
|
package/dist/esm/client.js
CHANGED
|
@@ -16,6 +16,7 @@ function unwrapApiResponse(body) {
|
|
|
16
16
|
}
|
|
17
17
|
export class WebApiClient {
|
|
18
18
|
constructor(options) {
|
|
19
|
+
this.SSE = false;
|
|
19
20
|
this.baseUrl = options.baseUrl.replace(/\/$/, "");
|
|
20
21
|
this.authToken = options.authToken;
|
|
21
22
|
const globalFetch = typeof globalThis !== "undefined" ? globalThis.fetch : undefined;
|
|
@@ -58,16 +59,23 @@ export class WebApiClient {
|
|
|
58
59
|
* @param callback 业务数据回调
|
|
59
60
|
* @param errorCallback 出错回调,接收模板抛出或 `parse` 抛出的异常(如 {@link WebApiError})
|
|
60
61
|
* @param parse 解析事件的 data 文本为业务数据,抛出异常表示该帧无效
|
|
62
|
+
* @param init 可选的请求附加参数(如 GT5 批量 SSE 需 POST JSON body);携带 body 时自动附加
|
|
63
|
+
* `Content-Type: application/json`
|
|
61
64
|
* @returns AbortController,调用 `abort()` 可停止订阅
|
|
62
65
|
*/
|
|
63
|
-
subscribeSse(url, eventName, callback, errorCallback, parse) {
|
|
66
|
+
subscribeSse(url, eventName, callback, errorCallback, parse, init) {
|
|
64
67
|
const controller = new AbortController();
|
|
65
68
|
const headers = {};
|
|
69
|
+
if (init?.body !== undefined) {
|
|
70
|
+
headers["Content-Type"] = "application/json";
|
|
71
|
+
}
|
|
66
72
|
if (this.authToken) {
|
|
67
73
|
headers["Authorization"] = this.authToken;
|
|
68
74
|
}
|
|
69
75
|
fetchEventSource(url, {
|
|
70
76
|
signal: controller.signal,
|
|
77
|
+
method: init?.method,
|
|
78
|
+
body: init?.body,
|
|
71
79
|
headers,
|
|
72
80
|
openWhenHidden: true,
|
|
73
81
|
fetch: this.fetchImpl,
|
|
@@ -111,6 +119,36 @@ export class WebApiClient {
|
|
|
111
119
|
getRoot() {
|
|
112
120
|
return this.request("/version");
|
|
113
121
|
}
|
|
122
|
+
/**
|
|
123
|
+
* SSE 可用性探测:连接测试端点 `/test/sse`,确认服务端 SSE(Server-Sent Events)通道可用。
|
|
124
|
+
*
|
|
125
|
+
* 注意:仅当服务端启用虚拟线程(useVirtualThreads)时该路由才会注册。
|
|
126
|
+
* @param timeoutMs 探测超时(ms)
|
|
127
|
+
* @returns 服务端 SSE 可用返回 `true`,否则返回 `false`
|
|
128
|
+
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/test/SSETestHandler.java)
|
|
129
|
+
*/
|
|
130
|
+
getSSE(timeoutMs = 500) {
|
|
131
|
+
if (this.SSE)
|
|
132
|
+
return Promise.resolve(this.SSE);
|
|
133
|
+
return new Promise(resolve => {
|
|
134
|
+
let controller;
|
|
135
|
+
let settled = false;
|
|
136
|
+
let timer;
|
|
137
|
+
/** 首次结果生效,后续(含 abort 触发的 onerror)一律忽略 */
|
|
138
|
+
const finish = (ok) => {
|
|
139
|
+
if (settled)
|
|
140
|
+
return;
|
|
141
|
+
settled = true;
|
|
142
|
+
if (timer !== undefined)
|
|
143
|
+
clearTimeout(timer);
|
|
144
|
+
controller?.abort();
|
|
145
|
+
this.SSE = ok;
|
|
146
|
+
resolve(ok);
|
|
147
|
+
};
|
|
148
|
+
timer = setTimeout(() => finish(false), timeoutMs);
|
|
149
|
+
controller = this.subscribeSse(`${this.baseUrl}/test/sse`, "success", () => finish(true), () => finish(false), raw => raw);
|
|
150
|
+
});
|
|
151
|
+
}
|
|
114
152
|
// region TPS / Performance
|
|
115
153
|
/**
|
|
116
154
|
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/TPSHandler.java)
|
|
@@ -431,6 +469,27 @@ export class WebApiClient {
|
|
|
431
469
|
await new Promise(r => setTimeout(r, intervalMs));
|
|
432
470
|
}
|
|
433
471
|
}
|
|
472
|
+
/**
|
|
473
|
+
* 以回调方式订阅批量 GT5 机器信息 SSE 推送(基于 fetchEventSource,可携带 Authorization 头,原生 EventSource 不支持)。
|
|
474
|
+
* 服务端以 `machines` 数组作为 POST body 提交批量查询,任务完成后推送一次 `gt5` 事件
|
|
475
|
+
* ({@link GT5BatchJobResult} JSON,含 machines 结果),随后每隔 interval 秒(默认 5)自动重跑并再次推送;
|
|
476
|
+
* 连接建立后发生异常时推送 `error` 事件(纯文本消息)并关闭连接。
|
|
477
|
+
* @param machines 目标机器坐标列表,作为 POST JSON body 提交
|
|
478
|
+
* @param callback 每次收到批量查询完整结果(任务完成,含 machines)时调用
|
|
479
|
+
* @param errorCallback 出错(网络错误、鉴权失败、服务端 error 事件、业务失败、数据解析失败)时调用,库内自动重连会随之停止
|
|
480
|
+
* @param params.interval 任务完成后自动重跑的间隔(秒),省略时由服务端取默认值
|
|
481
|
+
* @returns AbortController,调用 `abort()` 可停止订阅
|
|
482
|
+
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchSSEHandler.java)
|
|
483
|
+
*/
|
|
484
|
+
gt5BatchSseCallback(machines, callback, errorCallback, params) {
|
|
485
|
+
return this.subscribeSse(`${this.baseUrl}/gt5/batch/sse${buildQuery(params ?? {})}`, "gt5", callback, errorCallback, raw => {
|
|
486
|
+
const body = JSON.parse(raw);
|
|
487
|
+
// 服务端当前推送裸对象(其 success 为数字计数),同时兼容 ApiResponse 包装形式(success 为布尔值)
|
|
488
|
+
return typeof body.success === "boolean"
|
|
489
|
+
? unwrapApiResponse(body)
|
|
490
|
+
: body;
|
|
491
|
+
}, { method: "POST", body: JSON.stringify(machines) });
|
|
492
|
+
}
|
|
434
493
|
// region AE2
|
|
435
494
|
/**
|
|
436
495
|
* @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEBaseHandler.java)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import Joi from "joi";
|
|
2
2
|
import { ClassInfoSchema, CoordinatesSchema } from "./common";
|
|
3
|
-
import { ItemStackSchema } from "./item";
|
|
3
|
+
import { ItemStackSchema, NBTCompoundSchema } from "./item";
|
|
4
4
|
export const MaterialSchema = Joi.object({
|
|
5
5
|
isLiquid: Joi.boolean().required(),
|
|
6
6
|
isSolid: Joi.boolean().required(),
|
|
@@ -39,10 +39,11 @@ export const BlockDetailSchema = Joi.object({
|
|
|
39
39
|
metadata: Joi.number().required(),
|
|
40
40
|
isAir: Joi.boolean().required(),
|
|
41
41
|
tileEntity: Joi.object({
|
|
42
|
+
nbt: NBTCompoundSchema.required(),
|
|
42
43
|
class: ClassInfoSchema.optional(),
|
|
43
44
|
inventorySize: Joi.number().optional(),
|
|
44
45
|
items: Joi.array().items(ItemStackSchema.append({ slot: Joi.number().required() })).optional(),
|
|
45
|
-
}).
|
|
46
|
+
}).optional(),
|
|
46
47
|
});
|
|
47
48
|
export const SetBlockBodySchema = Joi.object({
|
|
48
49
|
id: Joi.number().required(),
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import Joi from "joi";
|
|
2
2
|
import { ClassInfoSchema } from "./common";
|
|
3
3
|
import { FluidSchema } from "./fluid";
|
|
4
|
+
import { NBTCompoundSchema } from "./item";
|
|
4
5
|
// ========== GT5 Machine Base ==========
|
|
5
6
|
export const GT5MachineTypeSchema = Joi.string().valid("MULTIBLOCK", "SINGLE", "GENERATOR", "HATCH", "UNKNOWN");
|
|
6
7
|
export const GT5ShutDownReasonSchema = Joi.object({
|
|
@@ -111,7 +112,7 @@ export const GT5MachineInfoSchema = Joi.object({
|
|
|
111
112
|
owner: Joi.string().required(),
|
|
112
113
|
state: GT5MachineStateSchema.required(),
|
|
113
114
|
class: ClassInfoSchema.optional(),
|
|
114
|
-
nbt:
|
|
115
|
+
nbt: NBTCompoundSchema.required(),
|
|
115
116
|
}).concat(GT5MachineFieldsSchema);
|
|
116
117
|
export const GT5BatchMachineCoordSchema = Joi.object({
|
|
117
118
|
x: Joi.number().required(),
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import Joi from "joi";
|
|
2
2
|
import { ClassInfoSchema } from "./common";
|
|
3
|
+
export const NBTCompoundSchema = Joi.object({
|
|
4
|
+
nbtstr: Joi.string().required(),
|
|
5
|
+
nbtWrite: Joi.string().required(),
|
|
6
|
+
}).unknown();
|
|
3
7
|
export const NBTDataSchema = Joi.object({
|
|
4
|
-
|
|
5
|
-
nbtWrite: Joi.string().optional(),
|
|
6
|
-
nbt: Joi.object().unknown().optional(),
|
|
8
|
+
nbt: NBTCompoundSchema.optional(),
|
|
7
9
|
});
|
|
8
10
|
export const ItemSchema = Joi.object({
|
|
9
11
|
class: ClassInfoSchema.optional(),
|
package/dist/types/block.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ClassInfo } from "./common";
|
|
2
|
-
import type { ItemStack } from "./item";
|
|
2
|
+
import type { ItemStack, NBTCompound } from "./item";
|
|
3
3
|
export interface Material {
|
|
4
4
|
isLiquid: boolean;
|
|
5
5
|
isSolid: boolean;
|
|
@@ -39,12 +39,13 @@ export interface BlockDetail {
|
|
|
39
39
|
metadata: number;
|
|
40
40
|
isAir: boolean;
|
|
41
41
|
tileEntity?: {
|
|
42
|
+
nbt: NBTCompound;
|
|
42
43
|
class?: ClassInfo;
|
|
43
44
|
inventorySize?: number;
|
|
44
45
|
items?: Array<ItemStack & {
|
|
45
46
|
slot: number;
|
|
46
47
|
}>;
|
|
47
|
-
}
|
|
48
|
+
};
|
|
48
49
|
}
|
|
49
50
|
export interface SetBlockBody {
|
|
50
51
|
id: number;
|
package/dist/types/gt5.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { ClassInfo } from "./common";
|
|
2
2
|
import type { Fluid } from "./fluid";
|
|
3
|
+
import type { NBTCompound } from "./item";
|
|
3
4
|
export type GT5MachineType = "MULTIBLOCK" | "SINGLE" | "GENERATOR" | "HATCH" | "UNKNOWN";
|
|
4
5
|
export interface GT5ShutDownReason {
|
|
5
6
|
id: string;
|
|
@@ -130,7 +131,7 @@ export type GT5MachineInfo = {
|
|
|
130
131
|
owner: string;
|
|
131
132
|
state: GT5MachineState;
|
|
132
133
|
class?: ClassInfo;
|
|
133
|
-
nbt:
|
|
134
|
+
nbt: NBTCompound;
|
|
134
135
|
} & GT5Machine;
|
|
135
136
|
export interface GT5BatchMachineCoord {
|
|
136
137
|
x: number;
|
package/dist/types/item.d.ts
CHANGED
|
@@ -1,8 +1,15 @@
|
|
|
1
1
|
import type { ClassInfo } from "./common";
|
|
2
|
+
export interface NBTCompound {
|
|
3
|
+
/** NBT 的 SNBT 字符串形式 */
|
|
4
|
+
nbtstr: string;
|
|
5
|
+
/** Base64 编码的 NBT 二进制数据 */
|
|
6
|
+
nbtWrite: string;
|
|
7
|
+
/** NBT 复合标签内的各键值 */
|
|
8
|
+
[key: string]: unknown;
|
|
9
|
+
}
|
|
10
|
+
/** 携带 NBT 的对象,NBT 为空时不输出 `nbt` */
|
|
2
11
|
export interface NBTData {
|
|
3
|
-
|
|
4
|
-
nbtWrite?: string;
|
|
5
|
-
nbt?: Record<string, unknown>;
|
|
12
|
+
nbt?: NBTCompound;
|
|
6
13
|
}
|
|
7
14
|
export interface Item {
|
|
8
15
|
class?: ClassInfo;
|
package/dist/validators/block.js
CHANGED
|
@@ -45,10 +45,11 @@ exports.BlockDetailSchema = joi_1.default.object({
|
|
|
45
45
|
metadata: joi_1.default.number().required(),
|
|
46
46
|
isAir: joi_1.default.boolean().required(),
|
|
47
47
|
tileEntity: joi_1.default.object({
|
|
48
|
+
nbt: item_1.NBTCompoundSchema.required(),
|
|
48
49
|
class: common_1.ClassInfoSchema.optional(),
|
|
49
50
|
inventorySize: joi_1.default.number().optional(),
|
|
50
51
|
items: joi_1.default.array().items(item_1.ItemStackSchema.append({ slot: joi_1.default.number().required() })).optional(),
|
|
51
|
-
}).
|
|
52
|
+
}).optional(),
|
|
52
53
|
});
|
|
53
54
|
exports.SetBlockBodySchema = joi_1.default.object({
|
|
54
55
|
id: joi_1.default.number().required(),
|
package/dist/validators/gt5.js
CHANGED
|
@@ -7,6 +7,7 @@ exports.GT5ScanJobResultSchema = exports.GT5ScanJobStatusSchema = exports.GT5Sca
|
|
|
7
7
|
const joi_1 = __importDefault(require("joi"));
|
|
8
8
|
const common_1 = require("./common");
|
|
9
9
|
const fluid_1 = require("./fluid");
|
|
10
|
+
const item_1 = require("./item");
|
|
10
11
|
// ========== GT5 Machine Base ==========
|
|
11
12
|
exports.GT5MachineTypeSchema = joi_1.default.string().valid("MULTIBLOCK", "SINGLE", "GENERATOR", "HATCH", "UNKNOWN");
|
|
12
13
|
exports.GT5ShutDownReasonSchema = joi_1.default.object({
|
|
@@ -117,7 +118,7 @@ exports.GT5MachineInfoSchema = joi_1.default.object({
|
|
|
117
118
|
owner: joi_1.default.string().required(),
|
|
118
119
|
state: exports.GT5MachineStateSchema.required(),
|
|
119
120
|
class: common_1.ClassInfoSchema.optional(),
|
|
120
|
-
nbt:
|
|
121
|
+
nbt: item_1.NBTCompoundSchema.required(),
|
|
121
122
|
}).concat(GT5MachineFieldsSchema);
|
|
122
123
|
exports.GT5BatchMachineCoordSchema = joi_1.default.object({
|
|
123
124
|
x: joi_1.default.number().required(),
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import Joi from "joi";
|
|
2
2
|
import type { AEItemDefinitions, Item, ItemDetail } from "../types/item";
|
|
3
|
+
export declare const NBTCompoundSchema: Joi.ObjectSchema<any>;
|
|
3
4
|
export declare const NBTDataSchema: Joi.ObjectSchema<any>;
|
|
4
5
|
export declare const ItemSchema: Joi.ObjectSchema<Item>;
|
|
5
6
|
export declare const ItemStackSchema: Joi.ObjectSchema<{
|
package/dist/validators/item.js
CHANGED
|
@@ -3,13 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.AEItemDefinitionsSchema = exports.ItemDetailSchema = exports.ItemStackSchema = exports.ItemSchema = exports.NBTDataSchema = void 0;
|
|
6
|
+
exports.AEItemDefinitionsSchema = exports.ItemDetailSchema = exports.ItemStackSchema = exports.ItemSchema = exports.NBTDataSchema = exports.NBTCompoundSchema = void 0;
|
|
7
7
|
const joi_1 = __importDefault(require("joi"));
|
|
8
8
|
const common_1 = require("./common");
|
|
9
|
+
exports.NBTCompoundSchema = joi_1.default.object({
|
|
10
|
+
nbtstr: joi_1.default.string().required(),
|
|
11
|
+
nbtWrite: joi_1.default.string().required(),
|
|
12
|
+
}).unknown();
|
|
9
13
|
exports.NBTDataSchema = joi_1.default.object({
|
|
10
|
-
|
|
11
|
-
nbtWrite: joi_1.default.string().optional(),
|
|
12
|
-
nbt: joi_1.default.object().unknown().optional(),
|
|
14
|
+
nbt: exports.NBTCompoundSchema.optional(),
|
|
13
15
|
});
|
|
14
16
|
exports.ItemSchema = joi_1.default.object({
|
|
15
17
|
class: common_1.ClassInfoSchema.optional(),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shirokasoke/webapi-sdk",
|
|
3
|
-
"version": "2.9.0-beta2-0.11-
|
|
3
|
+
"version": "2.9.0-beta2-0.11-test2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "TypeScript SDK for the love.shirokasoke.WebAPI Minecraft Mod",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -26,7 +26,8 @@
|
|
|
26
26
|
"build": "npm run build:cjs && npm run build:esm",
|
|
27
27
|
"build:cjs": "tsc -p tsconfig.json",
|
|
28
28
|
"build:esm": "tsc -p tsconfig.esm.json && echo '{\"type\": \"module\"}' > dist/esm/package.json",
|
|
29
|
-
"test": "tsx --test test/*.test.ts"
|
|
29
|
+
"test": "tsx --test test/*.test.ts",
|
|
30
|
+
"web": "npm run build && cp -r /workspace/sdk/ts/dist/* /workspace/web/node_modules/@shirokasoke/webapi-sdk/dist/"
|
|
30
31
|
},
|
|
31
32
|
"keywords": [
|
|
32
33
|
"gtnh",
|
|
@@ -46,4 +47,4 @@
|
|
|
46
47
|
"@microsoft/fetch-event-source": "^2.0.1",
|
|
47
48
|
"joi": "^18.2.1"
|
|
48
49
|
}
|
|
49
|
-
}
|
|
50
|
+
}
|