@shirokasoke/webapi-sdk 2.9.0-1.2

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.
Files changed (64) hide show
  1. package/README.md +95 -0
  2. package/dist/client.d.ts +682 -0
  3. package/dist/client.js +793 -0
  4. package/dist/index.d.ts +4 -0
  5. package/dist/index.js +23 -0
  6. package/dist/types/ae2.d.ts +241 -0
  7. package/dist/types/ae2.js +2 -0
  8. package/dist/types/block.d.ts +97 -0
  9. package/dist/types/block.js +2 -0
  10. package/dist/types/chunk.d.ts +58 -0
  11. package/dist/types/chunk.js +2 -0
  12. package/dist/types/common.d.ts +33 -0
  13. package/dist/types/common.js +2 -0
  14. package/dist/types/entity.d.ts +132 -0
  15. package/dist/types/entity.js +2 -0
  16. package/dist/types/fluid.d.ts +34 -0
  17. package/dist/types/fluid.js +2 -0
  18. package/dist/types/fmp.d.ts +33 -0
  19. package/dist/types/fmp.js +2 -0
  20. package/dist/types/gt5.d.ts +306 -0
  21. package/dist/types/gt5.js +2 -0
  22. package/dist/types/index.d.ts +13 -0
  23. package/dist/types/index.js +29 -0
  24. package/dist/types/item.d.ts +45 -0
  25. package/dist/types/item.js +2 -0
  26. package/dist/types/rawInfo.d.ts +25 -0
  27. package/dist/types/rawInfo.js +2 -0
  28. package/dist/types/recipe.d.ts +114 -0
  29. package/dist/types/recipe.js +2 -0
  30. package/dist/types/threeD.d.ts +43 -0
  31. package/dist/types/threeD.js +2 -0
  32. package/dist/types/world.d.ts +58 -0
  33. package/dist/types/world.js +2 -0
  34. package/dist/utils/ae2.d.ts +42 -0
  35. package/dist/utils/ae2.js +89 -0
  36. package/dist/validators/ae2.d.ts +85 -0
  37. package/dist/validators/ae2.js +234 -0
  38. package/dist/validators/block.d.ts +12 -0
  39. package/dist/validators/block.js +101 -0
  40. package/dist/validators/chunk.d.ts +9 -0
  41. package/dist/validators/chunk.js +65 -0
  42. package/dist/validators/common.d.ts +8 -0
  43. package/dist/validators/common.js +38 -0
  44. package/dist/validators/entity.d.ts +10 -0
  45. package/dist/validators/entity.js +133 -0
  46. package/dist/validators/fluid.d.ts +6 -0
  47. package/dist/validators/fluid.js +36 -0
  48. package/dist/validators/fmp.d.ts +4 -0
  49. package/dist/validators/fmp.js +40 -0
  50. package/dist/validators/gt5.d.ts +35 -0
  51. package/dist/validators/gt5.js +259 -0
  52. package/dist/validators/index.d.ts +13 -0
  53. package/dist/validators/index.js +29 -0
  54. package/dist/validators/item.d.ts +14 -0
  55. package/dist/validators/item.js +39 -0
  56. package/dist/validators/rawInfo.d.ts +6 -0
  57. package/dist/validators/rawInfo.js +31 -0
  58. package/dist/validators/recipe.d.ts +30 -0
  59. package/dist/validators/recipe.js +83 -0
  60. package/dist/validators/threeD.d.ts +8 -0
  61. package/dist/validators/threeD.js +40 -0
  62. package/dist/validators/world.d.ts +5 -0
  63. package/dist/validators/world.js +65 -0
  64. package/package.json +42 -0
@@ -0,0 +1,682 @@
1
+ import type { AE2Pattern, AECPU, AECPUCancelBody, AECPUCancelResult, AECPUSuspendBody, AECPUSuspendResult, AECraftingTaskBody, AECraftingTaskResult, AEHitResult, AEItemDefinitions, AEItemsResult, AEMEInterface, AENode, BatchSetBlockJobResult, BatchSetBlockSubmitResult, BatchSetBlockTask, Block, BlockDetail, ChunkForceList, ChunkLoadResult, ChunkMapCell, ChunksByDimension, ChunkWithDimension, Coordinates, EntitiesByDimension, Entity, Fluid, FluidContainer, FMPPart, GT5BatchJobResult, GT5BatchMachineCoord, GT5BatchRerunResult, GT5BatchSubmitResult, GT5MachineInfo, GT5ScanJobResult, GT5ScanSubmitResult, GT5StatusResult, GT5VeinDefsResult, GT5VeinListResult, GT5VeinQueryResult, Item, ItemDetail, LagAnalyzerData, ProfilerData, RootInfo, SetBlockBody, SetBlockResult, TPSInfo, WorldInfoData, CraftingRecipesResult, FurnaceRecipesResult, GTRecipesResult, GTRecipeMap, PlayerPrintResult, PrintSizeResult, WorldPrintJobResult, WorldPrintSubmitResult } from "./types";
2
+ export type FetchLike = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
3
+ export interface WebApiClientOptions {
4
+ baseUrl: string;
5
+ authToken?: string;
6
+ fetch?: FetchLike;
7
+ }
8
+ export declare class WebApiClient {
9
+ private baseUrl;
10
+ private authToken?;
11
+ private fetchImpl;
12
+ SSE: boolean | undefined;
13
+ constructor(options: WebApiClientOptions);
14
+ private request;
15
+ /**
16
+ * SSE 订阅模板:统一处理鉴权头、响应校验、事件过滤与错误上报(基于 fetchEventSource,可携带
17
+ * Authorization 头,原生 EventSource 不支持)。服务端推送的 `error` 事件(纯文本消息)会转为
18
+ * {@link Error} 上报;连接建立后发生异常时同样上报并停止库内自动重连,由调用方决定是否重新订阅。
19
+ * @param url 完整订阅地址(含 query)
20
+ * @param eventName 业务事件名,其余事件将被忽略
21
+ * @param callback 业务数据回调
22
+ * @param errorCallback 出错回调,接收模板抛出或 `parse` 抛出的异常(如 {@link WebApiError})
23
+ * @param parse 解析事件的 data 文本为业务数据,抛出异常表示该帧无效
24
+ * @param init 可选的请求附加参数(如 GT5 批量 SSE 需 POST JSON body);携带 body 时自动附加
25
+ * `Content-Type: application/json`
26
+ * @returns AbortController,调用 `abort()` 可停止订阅
27
+ */
28
+ private subscribeSse;
29
+ /**
30
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/RootHandler.java)
31
+ * @returns 使用 {@link RootInfoSchema} 验证
32
+ */
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
+ checkSSE(timeoutMs?: number): Promise<boolean>;
43
+ /**
44
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/TPSHandler.java)
45
+ * @returns 使用 `Joi.object().pattern(Joi.string(), {@link TPSInfoSchema})` 验证
46
+ */
47
+ getTPS(): Promise<Record<string, TPSInfo>>;
48
+ /**
49
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ProfilerHandler.java)
50
+ * @returns 使用 {@link ProfilerDataSchema} 验证
51
+ */
52
+ getProfiler(): Promise<ProfilerData>;
53
+ /**
54
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/LagAnalyzerHandler.java)
55
+ * @returns 使用 {@link LagAnalyzerDataSchema} 验证
56
+ */
57
+ getLagAnalyzer(): Promise<LagAnalyzerData>;
58
+ /**
59
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/WorldInfoHandler.java)
60
+ * @returns 使用 `Joi.object().pattern(Joi.string(), {@link WorldInfoDataSchema})` 验证
61
+ */
62
+ getWorldInfo(): Promise<Record<string, WorldInfoData>>;
63
+ /**
64
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BlocksHandler.java)
65
+ * @returns 使用 `Joi.array().items(`{@link BlockSchema}`)` 验证
66
+ */
67
+ getBlocks(): Promise<Block[]>;
68
+ /**
69
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BlockHandler.java)
70
+ * @returns 使用 {@link BlockDetailSchema} 验证
71
+ */
72
+ getBlock(params: {
73
+ x: number;
74
+ y: number;
75
+ z: number;
76
+ dim?: number;
77
+ }): Promise<BlockDetail>;
78
+ /**
79
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/SetBlockHandler.java)
80
+ * @param body 使用 {@link SetBlockBodySchema} 验证
81
+ * @returns 使用 {@link SetBlockResultSchema} 验证
82
+ */
83
+ setBlock(params: {
84
+ x: number;
85
+ y: number;
86
+ z: number;
87
+ dim?: number;
88
+ }, body: SetBlockBody): Promise<SetBlockResult>;
89
+ /**
90
+ * 提交批量 setblock 任务到慢队列,异步执行。
91
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BatchSetBlockHandler.java)
92
+ * @param tasks 使用 `Joi.array().items(`{@link BatchSetBlockTaskSchema} ) 验证
93
+ * @returns 使用 {@link BatchSetBlockSubmitResultSchema} 验证
94
+ */
95
+ batchSetBlock(tasks: BatchSetBlockTask[]): Promise<BatchSetBlockSubmitResult>;
96
+ /**
97
+ * 查询批量 setblock 任务执行结果。
98
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BatchSetBlockHandler.java)
99
+ * @returns 使用 {@link BatchSetBlockJobResultSchema} 验证
100
+ */
101
+ getBatchSetBlockJob(params: {
102
+ id: string;
103
+ }): Promise<BatchSetBlockJobResult>;
104
+ /**
105
+ * 轮询等待批量 setblock 任务完成。
106
+ * @param jobId 任务 ID(由 batchSetBlock 返回)
107
+ * @param intervalMs 轮询间隔 (ms),默认 100
108
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BatchSetBlockHandler.java)
109
+ * @returns 使用 {@link BatchSetBlockJobResultSchema} 验证
110
+ */
111
+ waitForBatchSetBlockJob(jobId: string, intervalMs?: number): Promise<BatchSetBlockJobResult>;
112
+ /**
113
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/FMPHandler.java)
114
+ * @returns 使用 `Joi.array().items(`{@link FMPPartSchema}`)` 验证
115
+ */
116
+ getBlockFMP(params: Coordinates): Promise<FMPPart[]>;
117
+ /**
118
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BlockTileHandler.java)
119
+ * @returns 二进制数据,无 JSON Schema
120
+ */
121
+ getBlockTile(params: {
122
+ id?: number;
123
+ regName?: string;
124
+ meta?: number;
125
+ }): Promise<ArrayBuffer>;
126
+ /**
127
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/ItemsHandler.java)
128
+ * @returns 使用 `Joi.array().items(`{@link ItemSchema}`)` 验证
129
+ */
130
+ getItems(): Promise<Item[]>;
131
+ /**
132
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/ItemHandler.java)
133
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/ItemStaticHandler.java)
134
+ * @returns 使用 {@link ItemDetailSchema} 验证
135
+ */
136
+ getItem(params: {
137
+ id: number;
138
+ }): Promise<ItemDetail>;
139
+ /**
140
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/ItemIconHandler.java)
141
+ * @param params.id 物品 ID(对应 ItemStack 的 id)
142
+ * @param params.damage 物品损伤值/元数据(可选,默认 0)
143
+ * @param params.tag Base64 编码的 NBTTagCompound(可选)
144
+ * @returns 二进制 PNG 图片数据 (ArrayBuffer)
145
+ */
146
+ getItemIcon(params: {
147
+ id: number;
148
+ damage?: number;
149
+ tag?: string;
150
+ }): Promise<ArrayBuffer>;
151
+ /**
152
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/AEHandler.java)
153
+ * @returns 使用 {@link AEItemDefinitionsSchema} 验证
154
+ */
155
+ getAEItemsDef(): Promise<AEItemDefinitions>;
156
+ /**
157
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/fluid/FluidsHandler.java)
158
+ * @returns 使用 `Joi.array().items(`{@link FluidSchema}`)` 验证
159
+ */
160
+ getFluids(): Promise<Fluid[]>;
161
+ /**
162
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/fluid/FluidContainersHandler.java)
163
+ * @returns 使用 `Joi.array().items(`{@link FluidContainerSchema}`)` 验证
164
+ */
165
+ getFluidContainers(): Promise<FluidContainer[]>;
166
+ /**
167
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/fluid/FluidIconHandler.java)
168
+ * @param params.id 流体 ID(对应 Fluid 的 id)
169
+ * @param params.name 流体名称(对应 Fluid 的 name)
170
+ * @returns 二进制 PNG 图片数据 (ArrayBuffer)
171
+ */
172
+ getFluidIcon(params: {
173
+ id?: number;
174
+ name?: string;
175
+ }): Promise<ArrayBuffer>;
176
+ /**
177
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/entity/EntitiesHandler.java)
178
+ * @returns 使用 `Joi.object().pattern(Joi.string(),`{@link EntitiesByDimensionSchema}`)` 验证
179
+ *
180
+ * 其中实体为 {@link EntitySummarySchema} 精简结构
181
+ */
182
+ getEntities(): Promise<Record<string, EntitiesByDimension>>;
183
+ /**
184
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/entity/EntityHandler.java)
185
+ * @returns 使用 {@link EntitySchema} 验证
186
+ */
187
+ getEntity(params: {
188
+ id: number;
189
+ }): Promise<Entity>;
190
+ /**
191
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunksHandler.java)
192
+ * @returns 使用 `Joi.object().pattern(Joi.string(),`{@link ChunksByDimensionSchema}`)` 验证
193
+ */
194
+ getChunks(): Promise<Record<string, ChunksByDimension>>;
195
+ /**
196
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkHandler.java)
197
+ * @returns 使用 {@link ChunkWithDimensionSchema} 验证
198
+ */
199
+ getChunk(params: {
200
+ chunkX: number;
201
+ chunkZ: number;
202
+ dim?: number;
203
+ } | {
204
+ x: number;
205
+ z: number;
206
+ dim?: number;
207
+ }): Promise<ChunkWithDimension>;
208
+ /**
209
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkMapHandler.java)
210
+ * @returns JSON 模式使用 `Joi.array().items(Joi.array().items(`{@link ChunkMapCellSchema}`)` 验证;raw 模式为 ArrayBuffer
211
+ */
212
+ getChunkMap(params: {
213
+ chunkX: number;
214
+ chunkZ: number;
215
+ dim?: number;
216
+ } | {
217
+ x: number;
218
+ z: number;
219
+ dim?: number;
220
+ }, raw?: boolean): Promise<ArrayBuffer | ChunkMapCell[][]>;
221
+ /**
222
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkForceHandler.java)
223
+ * @returns 使用 {@link ChunkForceListSchema} 验证
224
+ */
225
+ getChunkForceList(): Promise<ChunkForceList>;
226
+ /**
227
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkForceHandler.java)
228
+ * @returns 使用 {@link ChunkLoadResultSchema} 验证
229
+ */
230
+ loadChunk(params: {
231
+ x: number;
232
+ z: number;
233
+ dim?: number;
234
+ duration?: number;
235
+ } | {
236
+ chunkX: number;
237
+ chunkZ: number;
238
+ dim?: number;
239
+ duration?: number;
240
+ }): Promise<ChunkLoadResult>;
241
+ /**
242
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkForceHandler.java)
243
+ * @returns 使用 {@link ChunkLoadResultSchema} 验证
244
+ */
245
+ unloadChunk(params: {
246
+ x: number;
247
+ z: number;
248
+ dim?: number;
249
+ } | {
250
+ chunkX: number;
251
+ chunkZ: number;
252
+ dim?: number;
253
+ }): Promise<ChunkLoadResult>;
254
+ /**
255
+ * 查询单个 GT5 机器信息。
256
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BaseHandler.java)
257
+ * @returns 使用 {@link GT5MachineInfoSchema} 验证
258
+ */
259
+ getGT5Machine(params: {
260
+ x: number;
261
+ y: number;
262
+ z: number;
263
+ dim?: number;
264
+ }): Promise<GT5MachineInfo>;
265
+ /**
266
+ * 启停单台 GT5 机器
267
+ *
268
+ * @returns 使用 {@link GT5StatusResultSchema} 验证;`changed=false` 表示机器本就处于目标状态
269
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5StatusHandler.java)
270
+ */
271
+ setGT5MachineStatus(params: {
272
+ x: number;
273
+ y: number;
274
+ z: number;
275
+ dim?: number;
276
+ dimension?: number;
277
+ action: "start" | "stop";
278
+ }): Promise<GT5StatusResult>;
279
+ /**
280
+ * 提交批量 GT5 机器查询任务。
281
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchHandler.java)
282
+ * @param machines 使用 `Joi.array().items(`{@link GT5BatchMachineCoordSchema}`)` 验证
283
+ * @returns 使用 {@link GT5BatchSubmitResultSchema} 验证
284
+ */
285
+ submitGT5Batch(machines: GT5BatchMachineCoord[]): Promise<GT5BatchSubmitResult>;
286
+ /**
287
+ * 查询批量 GT5 机器任务状态。
288
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchHandler.java)
289
+ * @returns 使用 {@link GT5BatchJobResultSchema} 验证
290
+ */
291
+ getGT5BatchJob(params: {
292
+ id: string;
293
+ }): Promise<GT5BatchJobResult>;
294
+ /**
295
+ * 重新执行已有的批量 GT5 机器查询任务。
296
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchHandler.java)
297
+ * @returns 使用 {@link GT5BatchRerunResultSchema} 验证
298
+ */
299
+ rerunGT5Batch(params: {
300
+ id: string;
301
+ }): Promise<GT5BatchRerunResult>;
302
+ /**
303
+ * 轮询等待批量 GT5 机器任务完成。
304
+ * @param jobId 任务 ID(由 submitGT5Batch 返回)
305
+ * @param intervalMs 轮询间隔 (ms),默认 100
306
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchHandler.java)
307
+ * @returns 使用 {@link GT5BatchJobResultSchema} 验证
308
+ */
309
+ waitForGT5BatchJob(jobId: string, intervalMs?: number): Promise<GT5BatchJobResult>;
310
+ /**
311
+ * 提交区块扫描任务,异步扫描指定区块内所有 GT5 机器。
312
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5ChunkScanHandler.java)
313
+ * @returns 使用 {@link GT5ScanSubmitResultSchema} 验证
314
+ */
315
+ submitGT5ChunkScan(params: {
316
+ chunkX: number;
317
+ chunkZ: number;
318
+ dim?: number;
319
+ } | {
320
+ x: number;
321
+ z: number;
322
+ dim?: number;
323
+ }): Promise<GT5ScanSubmitResult>;
324
+ /**
325
+ * 查询区块扫描任务状态。
326
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5ChunkScanHandler.java)
327
+ * @returns 使用 {@link GT5ScanJobResultSchema} 验证
328
+ */
329
+ getGT5ScanJob(params: {
330
+ id: string;
331
+ }): Promise<GT5ScanJobResult>;
332
+ /**
333
+ * 轮询等待区块扫描任务完成。
334
+ * @param jobId 任务 ID(由 submitGT5ChunkScan 返回)
335
+ * @param intervalMs 轮询间隔 (ms),默认 100
336
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5ChunkScanHandler.java)
337
+ * @returns 使用 {@link GT5ScanJobResultSchema} 验证
338
+ */
339
+ waitForGT5ScanJob(jobId: string, intervalMs?: number): Promise<GT5ScanJobResult>;
340
+ /**
341
+ * 以回调方式订阅批量 GT5 机器信息 SSE 推送(基于 fetchEventSource,可携带 Authorization 头,原生 EventSource 不支持)。
342
+ * 服务端以 `machines` 数组作为 POST body 提交批量查询,任务完成后推送一次 `gt5` 事件
343
+ * ({@link GT5BatchJobResult} JSON,含 machines 结果),随后每隔 interval 秒(默认 5)自动重跑并再次推送;
344
+ * 连接建立后发生异常时推送 `error` 事件(纯文本消息)并关闭连接。
345
+ * @param machines 目标机器坐标列表,作为 POST JSON body 提交
346
+ * @param callback 每次收到批量查询完整结果(任务完成,含 machines)时调用
347
+ * @param errorCallback 出错(网络错误、鉴权失败、服务端 error 事件、业务失败、数据解析失败)时调用,库内自动重连会随之停止
348
+ * @param params.interval 任务完成后自动重跑的间隔(秒),省略时由服务端取默认值
349
+ * @returns AbortController,调用 `abort()` 可停止订阅
350
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchSSEHandler.java)
351
+ */
352
+ gt5BatchSseCallback(machines: GT5BatchMachineCoord[], callback: (data: GT5BatchJobResult) => void, errorCallback: (error: Error) => void, params?: {
353
+ interval?: number;
354
+ }): AbortController;
355
+ /**
356
+ * 查询坐标附近已知的 GT5 矿脉(读取 VisualProspecting 服务端缓存),按平面距离升序返回。
357
+ *
358
+ * `matched` 是过滤后的匹配总数,`veins` 只保留最近的 `limit` 条。
359
+ * @param params.vein 只保留该注册名的矿脉(大小写不敏感,如 `ore.mix.diamond`),未知名返回 404
360
+ * @param params.radius 搜索半径(方块),默认 2048,范围 16~8192
361
+ * @param params.limit 最大返回条数,默认 32,范围 1~512
362
+ * @param params.excludeDepleted 是否跳过已枯竭矿脉,默认 true
363
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5VeinHandler.java)
364
+ * @returns 使用 {@link GT5VeinQueryResultSchema} 验证
365
+ */
366
+ getGT5Vein(params: {
367
+ x: number;
368
+ y: number;
369
+ z: number;
370
+ dim?: number;
371
+ dimension?: number;
372
+ vein?: string;
373
+ radius?: number;
374
+ limit?: number;
375
+ excludeDepleted?: boolean;
376
+ }): Promise<GT5VeinQueryResult>;
377
+ /**
378
+ * 列出指定维度全部已生成的 GT5 矿脉(读取 VisualProspecting 服务端缓存),按区块坐标排序。
379
+ *
380
+ * 矿脉定义(权重、规模、高度范围等)见 {@link getGT5VeinDefs}。
381
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5VeinListHandler.java)
382
+ * @returns 使用 {@link GT5VeinListResultSchema} 验证
383
+ */
384
+ getGT5Veins(params: {
385
+ dim: number;
386
+ } | {
387
+ dimension: number;
388
+ }): Promise<GT5VeinListResult>;
389
+ /**
390
+ * 列出各维度可生成的 GT5 矿脉定义(权重、抽取占比、规模、密度、高度范围与矿石构成)。
391
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5VeinDefHandler.java)
392
+ * @returns 使用 {@link GT5VeinDefsResultSchema} 验证
393
+ */
394
+ getGT5VeinDefs(): Promise<GT5VeinDefsResult>;
395
+ /**
396
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEBaseHandler.java)
397
+ * @returns 使用 {@link AEHitResultSchema} 验证
398
+ */
399
+ aeHit(params: {
400
+ x: number;
401
+ y: number;
402
+ z: number;
403
+ dimension?: number;
404
+ }): Promise<AEHitResult>;
405
+ /**
406
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AENodesHandler.java)
407
+ * @returns 使用 `Joi.array().items(`{@link AENodeSchema}`)` 验证
408
+ */
409
+ aeNodes(params: {
410
+ x: number;
411
+ y: number;
412
+ z: number;
413
+ dimension?: number;
414
+ }): Promise<AENode[]>;
415
+ /**
416
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AECPUHandler.java)
417
+ * @returns 使用 `Joi.array().items(`{@link AECPUSchema}`)` 验证
418
+ */
419
+ aeCPUs(params: {
420
+ x: number;
421
+ y: number;
422
+ z: number;
423
+ dimension?: number;
424
+ }): Promise<AECPU[]>;
425
+ /**
426
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEMEHandler.java)
427
+ * @returns 使用 `Joi.array().items(`{@link AE2PatternSchema}`.append({ slot: Joi.number().required(), direction: Joi.string().optional() }))` 验证
428
+ */
429
+ aeME(params: {
430
+ x: number;
431
+ y: number;
432
+ z: number;
433
+ dimension?: number;
434
+ }): Promise<Array<AE2Pattern & {
435
+ slot: number;
436
+ direction?: string;
437
+ }>>;
438
+ /**
439
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEMEsHandler.java)
440
+ * @returns 使用 `Joi.array().items(`{@link AEMEInterfaceSchema}`)` 验证
441
+ */
442
+ aeMEs(params: {
443
+ x: number;
444
+ y: number;
445
+ z: number;
446
+ dimension?: number;
447
+ pattern?: boolean;
448
+ load?: boolean;
449
+ world?: boolean;
450
+ }): Promise<AEMEInterface[]>;
451
+ /**
452
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEMEsupportHandler.java)
453
+ * @returns 字符串数组,无专用 Schema
454
+ */
455
+ aeMESupport(): Promise<string[]>;
456
+ /**
457
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEItemHandler.java)
458
+ * @returns 使用 {@link AEItemsResultSchema} 验证
459
+ */
460
+ aeItems(params: {
461
+ x: number;
462
+ y: number;
463
+ z: number;
464
+ dimension?: number;
465
+ }): Promise<AEItemsResult>;
466
+ /**
467
+ * 向 AE 合成网络提交自动合成任务
468
+ *
469
+ * 如果返回的 {@link AECraftingTaskResult} 含合成树 `job`({@link AECraftingJobTree}),
470
+ * 可配合 {@link analyzeAECraftingJobTree} 判定能否合成及缺失物品
471
+ *
472
+ * 失败时抛出 {@link WebApiError}:
473
+ * - HTTP 500 且 message 为 "Failed to simulate job" 时,`error.body` 为
474
+ * {@link AECraftingTaskErrorBody},其 `body` 携带失败时的合成树,同样可分析缺失物品;
475
+ * - HTTP 500 且 message 为 "Failed to submit job to CPU" 时,为 CPU 侧问题
476
+ * (无可用 CPU / 存储字节不足 / CPU 忙碌),与材料无关。
477
+ *
478
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AECPUTaskHandler.java)
479
+ * @param params 坐标参数;`detail` 控制合成树输出:`"all"` 始终输出,`"fail"`仅失败时输出,`"none"` 不输出
480
+ * @param body 使用 {@link AECraftingTaskBodySchema} 验证
481
+ * @returns 使用 {@link AECraftingTaskResultSchema} 验证
482
+ */
483
+ aeCraft(params: {
484
+ x: number;
485
+ y: number;
486
+ z: number;
487
+ dimension?: number;
488
+ detail?: "all" | "fail" | "none";
489
+ }, body: AECraftingTaskBody): Promise<AECraftingTaskResult>;
490
+ /**
491
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AECPUCancelHandler.java)
492
+ * @param body 使用 {@link AECPUCancelBodySchema} 验证
493
+ * @returns 使用 {@link AECPUCancelResultSchema} 验证
494
+ */
495
+ aeCancel(params: {
496
+ x: number;
497
+ y: number;
498
+ z: number;
499
+ dimension?: number;
500
+ }, body: AECPUCancelBody): Promise<AECPUCancelResult>;
501
+ /**
502
+ * 暂停(suspend=true,POST)或恢复(suspend=false,DELETE)AE 合成 CPU 上正在执行的合成任务。
503
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AECPUSuspendHandler.java)
504
+ * @param body 使用 {@link AECPUSuspendBodySchema} 验证
505
+ * @returns 使用 {@link AECPUSuspendResultSchema} 验证
506
+ */
507
+ aeSuspend(params: {
508
+ x: number;
509
+ y: number;
510
+ z: number;
511
+ dimension?: number;
512
+ }, body: AECPUSuspendBody, suspend: boolean): Promise<AECPUSuspendResult>;
513
+ /**
514
+ * 构建 AE 库存 SSE(Server-Sent Events)订阅地址。
515
+ * 注意:仅当服务端启用虚拟线程(useVirtualThreads)时该路由才会注册。
516
+ * 返回 EventSource 可直接使用的完整 URL。
517
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEItemSSEHandler.java)
518
+ */
519
+ aeItemsSseUrl(params: {
520
+ x: number;
521
+ y: number;
522
+ z: number;
523
+ dimension?: number;
524
+ }): string;
525
+ /**
526
+ * 以回调方式订阅 AE 库存 SSE 推送(基于 fetchEventSource,可携带 Authorization 头,原生 EventSource 不支持)。
527
+ * 服务端周期性推送 `aeitem` 事件(`ApiResponse<{@link AEItemsResult}>` JSON,间隔由服务端 AE2Config.item.interval 决定),
528
+ * 回调收到解包后的 {@link AEItemsResult},业务失败(success=false)时以 {@link WebApiError} 上报;
529
+ * 连接建立后发生异常时推送 `error` 事件(纯文本消息)并关闭连接。
530
+ * @param params 目标方块坐标
531
+ * @param callback 每次收到库存快照时调用
532
+ * @param errorCallback 出错(网络错误、鉴权失败、服务端 error 事件、业务失败、数据解析失败)时调用,库内自动重连会随之停止
533
+ * @returns AbortController,调用 `abort()` 可停止订阅
534
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEItemSSEHandler.java)
535
+ */
536
+ aeItemSseCallback(params: {
537
+ x: number;
538
+ y: number;
539
+ z: number;
540
+ dimension?: number;
541
+ }, callback: (data: AEItemsResult) => void, errorCallback: (error: Error) => void): AbortController;
542
+ /**
543
+ * 构建 AE 合成 CPU 状态 SSE(Server-Sent Events)订阅地址。
544
+ * 注意:仅当服务端启用虚拟线程(useVirtualThreads)时该路由才会注册。
545
+ * 返回 EventSource 可直接使用的完整 URL。
546
+ * @param params 目标方块坐标;interval 为推送间隔(秒),省略时由服务端取默认值 5
547
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AECPUSSEHandler.java)
548
+ */
549
+ aeCpuSseUrl(params: {
550
+ x: number;
551
+ y: number;
552
+ z: number;
553
+ dimension?: number;
554
+ interval?: number;
555
+ }): string;
556
+ /**
557
+ * 以回调方式订阅 AE 合成 CPU 状态 SSE 推送(基于 fetchEventSource,可携带 Authorization 头,原生 EventSource 不支持)。
558
+ * 服务端周期性推送 `aecpu` 事件({@link AECPU} 数组 JSON,间隔由 interval 参数(秒)决定,服务端默认 5),
559
+ * 回调收到 CPU 状态列表;连接建立后发生异常时推送 `error` 事件(纯文本消息)并关闭连接。
560
+ * @param params 目标方块坐标;interval 为推送间隔(秒),省略时由服务端取默认值
561
+ * @param callback 每次收到 CPU 状态快照时调用
562
+ * @param errorCallback 出错(网络错误、鉴权失败、服务端 error 事件、业务失败、数据解析失败)时调用,库内自动重连会随之停止
563
+ * @returns AbortController,调用 `abort()` 可停止订阅
564
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AECPUSSEHandler.java)
565
+ */
566
+ aeCpuSseCallback(params: {
567
+ x: number;
568
+ y: number;
569
+ z: number;
570
+ dimension?: number;
571
+ interval?: number;
572
+ }, callback: (data: AECPU[]) => void, errorCallback: (error: Error) => void): AbortController;
573
+ /**
574
+ * 查询工作台合成配方(有序/无序)。
575
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/recipe/CraftingRecipesHandler.java)
576
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/recipe/IndexedCraftingRecipesHandler.java)
577
+ * @returns 使用 {@link CraftingRecipesResultSchema} 验证
578
+ */
579
+ getCraftingRecipes(params?: {
580
+ type?: "output" | "input";
581
+ id?: number;
582
+ damage?: number;
583
+ tag?: string;
584
+ limit?: number;
585
+ offset?: number;
586
+ }): Promise<CraftingRecipesResult>;
587
+ /**
588
+ * 查询熔炉熔炼配方。
589
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/recipe/FurnaceRecipesHandler.java)
590
+ * @returns 使用 {@link FurnaceRecipesResultSchema} 验证
591
+ */
592
+ getFurnaceRecipes(params?: {
593
+ type?: "output" | "input";
594
+ id?: number;
595
+ damage?: number;
596
+ tag?: string;
597
+ limit?: number;
598
+ offset?: number;
599
+ }): Promise<FurnaceRecipesResult>;
600
+ /**
601
+ * 查询 GT5 配方表的映射表(unlocalizedName → 显示名)。
602
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/recipe/GTmaps.java)
603
+ * @returns 使用 `Joi.array().items(`{@link GTRecipeMapSchema}`)` 验证
604
+ */
605
+ getGTRecipeMaps(): Promise<GTRecipeMap[]>;
606
+ /**
607
+ * 查询 GT5 机器配方。
608
+ * 注意:必须至少提供 id/damage(物品)、fluid(流体)或 map(单个配方表)之一。
609
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/recipe/GTRecipesHandler.java)
610
+ * @returns 使用 {@link GTRecipesResultSchema} 验证
611
+ */
612
+ getGTRecipes(params: {
613
+ type?: "output" | "input";
614
+ id?: number;
615
+ damage?: number;
616
+ tag?: string;
617
+ fluid?: string | number;
618
+ map?: string;
619
+ limit?: number;
620
+ offset?: number;
621
+ }): Promise<GTRecipesResult>;
622
+ /**
623
+ * 上传图片 → OC 3D 打印件,投递到玩家背包(多余掉落在玩家附近)。
624
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ThreeD/PlayerPrintHandler.java)
625
+ * @param params 二选一:id(实体 ID)或 name(玩家名)
626
+ * @param image 图片二进制数据(png/jpg 等)
627
+ * @returns 使用 {@link PlayerPrintResultSchema} 验证
628
+ */
629
+ printToPlayer(params: {
630
+ id: number;
631
+ label?: string;
632
+ tooltip?: string;
633
+ } | {
634
+ name: string;
635
+ label?: string;
636
+ tooltip?: string;
637
+ }, image: RequestInit["body"]): Promise<PlayerPrintResult>;
638
+ /**
639
+ * 上传图片 → 在世界中铺设 OC 3D 打印像素画(慢队列逐块执行)。
640
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ThreeD/WorldPrintHandler.java)
641
+ * @returns 使用 {@link WorldPrintSubmitResultSchema} 验证
642
+ */
643
+ submitWorldPrint(params: {
644
+ x: number;
645
+ y: number;
646
+ z: number;
647
+ dim?: number;
648
+ facing?: "north" | "south" | "east" | "west";
649
+ label?: string;
650
+ tooltip?: string;
651
+ }, image: RequestInit["body"]): Promise<WorldPrintSubmitResult>;
652
+ /**
653
+ * 查询世界 3D 打印任务进度。
654
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ThreeD/WorldPrintHandler.java)
655
+ * @returns 使用 {@link WorldPrintJobResultSchema} 验证
656
+ */
657
+ getWorldPrintJob(params: {
658
+ id: string;
659
+ }): Promise<WorldPrintJobResult>;
660
+ /**
661
+ * 轮询等待世界 3D 打印任务完成。
662
+ * @param jobId 任务 ID(由 submitWorldPrint 返回)
663
+ * @param intervalMs 轮询间隔 (ms),默认 100
664
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ThreeD/WorldPrintHandler.java)
665
+ * @returns 使用 {@link WorldPrintJobResultSchema} 验证
666
+ */
667
+ waitForWorldPrintJob(jobId: string, intervalMs?: number): Promise<WorldPrintJobResult>;
668
+ /**
669
+ * 上传图片,估算生成的 3D 打印件 NBT 大小(不实际打印)。
670
+ * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ThreeD/PrintSizeHandler.java)
671
+ * @returns 使用 {@link PrintSizeResultSchema} 验证
672
+ */
673
+ getPrintSize(image: RequestInit["body"], params?: {
674
+ label?: string;
675
+ tooltip?: string;
676
+ }): Promise<PrintSizeResult>;
677
+ }
678
+ export declare class WebApiError extends Error {
679
+ status: number;
680
+ body?: unknown;
681
+ constructor(message: string, status: number, body?: unknown);
682
+ }