@shirokasoke/webapi-sdk 2.9.0-bete2-0.6-pre

package/dist/client.d.ts

@@ -0,0 +1,400 @@
+import type { AE2Pattern, AECPU, AECPUCancelBody, AECPUCancelResult, 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, Item, ItemDetail, LagAnalyzerData, ProfilerData, RootInfo, SetBlockBody, SetBlockResult, TPSInfo, WorldInfoData } from "./types";
+export type FetchLike = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+export interface WebApiClientOptions {
+    baseUrl: string;
+    authToken?: string;
+    fetch?: FetchLike;
+}
+export declare class WebApiClient {
+    private baseUrl;
+    private authToken?;
+    private fetchImpl;
+    constructor(options: WebApiClientOptions);
+    private request;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/RootHandler.java)
+     * @returns 使用 {@link RootInfoSchema} 验证
+     */
+    getRoot(): Promise<RootInfo>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/TPSHandler.java)
+     * @returns 使用 `Joi.object().pattern(Joi.string(), {@link TPSInfoSchema})` 验证
+     */
+    getTPS(): Promise<Record<string, TPSInfo>>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ProfilerHandler.java)
+     * @returns 使用 {@link ProfilerDataSchema} 验证
+     */
+    getProfiler(): Promise<ProfilerData>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/LagAnalyzerHandler.java)
+     * @returns 使用 {@link LagAnalyzerDataSchema} 验证
+     */
+    getLagAnalyzer(): Promise<LagAnalyzerData>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/WorldInfoHandler.java)
+     * @returns 使用 `Joi.object().pattern(Joi.string(), {@link WorldInfoDataSchema})` 验证
+     */
+    getWorldInfo(): Promise<Record<string, WorldInfoData>>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BlocksHandler.java)
+     * @returns 使用 `Joi.array().items(`{@link BlockSchema}`)` 验证
+     */
+    getBlocks(): Promise<Block[]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BlockHandler.java)
+     * @returns 使用 {@link BlockDetailSchema} 验证
+     */
+    getBlock(params: {
+        x: number;
+        y: number;
+        z: number;
+        dim?: number;
+    }): Promise<BlockDetail>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/SetBlockHandler.java)
+     * @param body 使用 {@link SetBlockBodySchema} 验证
+     * @returns 使用 {@link SetBlockResultSchema} 验证
+     */
+    setBlock(params: {
+        x: number;
+        y: number;
+        z: number;
+        dim?: number;
+    }, body: SetBlockBody): Promise<SetBlockResult>;
+    /**
+     * 提交批量 setblock 任务到慢队列，异步执行。
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BatchSetBlockHandler.java)
+     * @param tasks 使用 `Joi.array().items(`{@link BatchSetBlockTaskSchema} ) 验证
+     * @returns 使用 {@link BatchSetBlockSubmitResultSchema} 验证
+     */
+    batchSetBlock(tasks: BatchSetBlockTask[]): Promise<BatchSetBlockSubmitResult>;
+    /**
+     * 查询批量 setblock 任务执行结果。
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BatchSetBlockHandler.java)
+     * @returns 使用 {@link BatchSetBlockJobResultSchema} 验证
+     */
+    getBatchSetBlockJob(params: {
+        id: string;
+    }): Promise<BatchSetBlockJobResult>;
+    /**
+     * 轮询等待批量 setblock 任务完成。
+     * @param jobId 任务 ID（由 batchSetBlock 返回）
+     * @param intervalMs 轮询间隔 (ms)，默认 100
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BatchSetBlockHandler.java)
+     * @returns 使用 {@link BatchSetBlockJobResultSchema} 验证
+     */
+    waitForBatchSetBlockJob(jobId: string, intervalMs?: number): Promise<BatchSetBlockJobResult>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/FMPHandler.java)
+     * @returns 使用 `Joi.array().items(`{@link FMPPartSchema}`)` 验证
+     */
+    getBlockFMP(params: Coordinates): Promise<FMPPart[]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/block/BlockTileHandler.java)
+     * @returns 二进制数据，无 JSON Schema
+     */
+    getBlockTile(params: {
+        id?: number;
+        regName?: string;
+        meta?: number;
+    }): Promise<ArrayBuffer>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/ItemsHandler.java)
+     * @returns 使用 `Joi.array().items(`{@link ItemSchema}`)` 验证
+     */
+    getItems(): Promise<Item[]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/ItemHandler.java)
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/ItemStaticHandler.java)
+     * @returns 使用 {@link ItemDetailSchema} 验证
+     */
+    getItem(params: {
+        id: number;
+    }): Promise<ItemDetail>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/ItemIconHandler.java)
+     * @param params.id 物品 ID（对应 ItemStack 的 id）
+     * @param params.damage 物品损伤值/元数据（可选，默认 0）
+     * @param params.tag Base64 编码的 NBTTagCompound（可选）
+     * @returns 二进制 PNG 图片数据 (ArrayBuffer)
+     */
+    getItemIcon(params: {
+        id: number;
+        damage?: number;
+        tag?: string;
+    }): Promise<ArrayBuffer>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/item/AEHandler.java)
+     * @returns 使用 {@link AEItemDefinitionsSchema} 验证
+     */
+    getAEItems(): Promise<AEItemDefinitions>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/fluid/FluidsHandler.java)
+     * @returns 使用 `Joi.array().items(`{@link FluidSchema}`)` 验证
+     */
+    getFluids(): Promise<Fluid[]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/fluid/FluidContainersHandler.java)
+     * @returns 使用 `Joi.array().items(`{@link FluidContainerSchema}`)` 验证
+     */
+    getFluidContainers(): Promise<FluidContainer[]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/fluid/FluidIconHandler.java)
+     * @param params.id 流体 ID（对应 Fluid 的 id）
+     * @param params.name 流体名称（对应 Fluid 的 name）
+     * @returns 二进制 PNG 图片数据 (ArrayBuffer)
+     */
+    getFluidIcon(params: {
+        id?: number;
+        name?: string;
+    }): Promise<ArrayBuffer>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/entity/EntitiesHandler.java)
+     * @returns 使用 `Joi.object().pattern(Joi.string(),`{@link EntitiesByDimensionSchema}`)` 验证
+     *
+     * 其中实体为 {@link EntitySummarySchema} 精简结构
+     */
+    getEntities(): Promise<Record<string, EntitiesByDimension>>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/entity/EntityHandler.java)
+     * @returns 使用 {@link EntitySchema} 验证
+     */
+    getEntity(params: {
+        id: number;
+    }): Promise<Entity>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunksHandler.java)
+     * @returns 使用 `Joi.object().pattern(Joi.string(),`{@link ChunksByDimensionSchema}`)` 验证
+     */
+    getChunks(): Promise<Record<string, ChunksByDimension>>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkHandler.java)
+     * @returns 使用 {@link ChunkWithDimensionSchema} 验证
+     */
+    getChunk(params: {
+        chunkX: number;
+        chunkZ: number;
+        dim?: number;
+    } | {
+        x: number;
+        z: number;
+        dim?: number;
+    }): Promise<ChunkWithDimension>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkMapHandler.java)
+     * @returns JSON 模式使用 `Joi.array().items(Joi.array().items(`{@link ChunkMapCellSchema}`)` 验证；raw 模式为 ArrayBuffer
+     */
+    getChunkMap(params: {
+        chunkX: number;
+        chunkZ: number;
+        dim?: number;
+    } | {
+        x: number;
+        z: number;
+        dim?: number;
+    }, raw?: boolean): Promise<ArrayBuffer | ChunkMapCell[][]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkForceHandler.java)
+     * @returns 使用 {@link ChunkForceListSchema} 验证
+     */
+    getChunkForceList(): Promise<ChunkForceList>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkForceHandler.java)
+     * @returns 使用 {@link ChunkLoadResultSchema} 验证
+     */
+    loadChunk(params: {
+        x: number;
+        z: number;
+        dim?: number;
+        duration?: number;
+    } | {
+        chunkX: number;
+        chunkZ: number;
+        dim?: number;
+        duration?: number;
+    }): Promise<ChunkLoadResult>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/chunk/ChunkForceHandler.java)
+     * @returns 使用 {@link ChunkLoadResultSchema} 验证
+     */
+    unloadChunk(params: {
+        x: number;
+        z: number;
+        dim?: number;
+    } | {
+        chunkX: number;
+        chunkZ: number;
+        dim?: number;
+    }): Promise<ChunkLoadResult>;
+    /**
+     * 查询单个 GT5 机器信息。
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BaseHandler.java)
+     * @returns 使用 {@link GT5MachineInfoSchema} 验证
+     */
+    getGT5Machine(params: {
+        x: number;
+        y: number;
+        z: number;
+        dim?: number;
+    }): Promise<GT5MachineInfo>;
+    /**
+     * 提交批量 GT5 机器查询任务。
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchHandler.java)
+     * @param machines 使用 `Joi.array().items(`{@link GT5BatchMachineCoordSchema}`)` 验证
+     * @returns 使用 {@link GT5BatchSubmitResultSchema} 验证
+     */
+    submitGT5Batch(machines: GT5BatchMachineCoord[]): Promise<GT5BatchSubmitResult>;
+    /**
+     * 查询批量 GT5 机器任务状态。
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchHandler.java)
+     * @returns 使用 {@link GT5BatchJobResultSchema} 验证
+     */
+    getGT5BatchJob(params: {
+        id: string;
+    }): Promise<GT5BatchJobResult>;
+    /**
+     * 重新执行已有的批量 GT5 机器查询任务。
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchHandler.java)
+     * @returns 使用 {@link GT5BatchRerunResultSchema} 验证
+     */
+    rerunGT5Batch(params: {
+        id: string;
+    }): Promise<GT5BatchRerunResult>;
+    /**
+     * 轮询等待批量 GT5 机器任务完成。
+     * @param jobId 任务 ID（由 submitGT5Batch 返回）
+     * @param intervalMs 轮询间隔 (ms)，默认 100
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5BatchHandler.java)
+     * @returns 使用 {@link GT5BatchJobResultSchema} 验证
+     */
+    waitForGT5BatchJob(jobId: string, intervalMs?: number): Promise<GT5BatchJobResult>;
+    /**
+     * 提交区块扫描任务，异步扫描指定区块内所有 GT5 机器。
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5ChunkScanHandler.java)
+     * @returns 使用 {@link GT5ScanSubmitResultSchema} 验证
+     */
+    submitGT5ChunkScan(params: {
+        chunkX: number;
+        chunkZ: number;
+        dim?: number;
+    } | {
+        x: number;
+        z: number;
+        dim?: number;
+    }): Promise<GT5ScanSubmitResult>;
+    /**
+     * 查询区块扫描任务状态。
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5ChunkScanHandler.java)
+     * @returns 使用 {@link GT5ScanJobResultSchema} 验证
+     */
+    getGT5ScanJob(params: {
+        id: string;
+    }): Promise<GT5ScanJobResult>;
+    /**
+     * 轮询等待区块扫描任务完成。
+     * @param jobId 任务 ID（由 submitGT5ChunkScan 返回）
+     * @param intervalMs 轮询间隔 (ms)，默认 100
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/gt5/GT5ChunkScanHandler.java)
+     * @returns 使用 {@link GT5ScanJobResultSchema} 验证
+     */
+    waitForGT5ScanJob(jobId: string, intervalMs?: number): Promise<GT5ScanJobResult>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEBaseHandler.java)
+     * @returns 使用 {@link AEHitResultSchema} 验证
+     */
+    aeHit(params: {
+        x: number;
+        y: number;
+        z: number;
+        dimension?: number;
+    }): Promise<AEHitResult>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AENodesHandler.java)
+     * @returns 使用 `Joi.array().items(`{@link AENodeSchema}`)` 验证
+     */
+    aeNodes(params: {
+        x: number;
+        y: number;
+        z: number;
+        dimension?: number;
+    }): Promise<AENode[]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AECPUHandler.java)
+     * @returns 使用 `Joi.array().items(`{@link AECPUSchema}`)` 验证
+     */
+    aeCPUs(params: {
+        x: number;
+        y: number;
+        z: number;
+        dimension?: number;
+    }): Promise<AECPU[]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEMEHandler.java)
+     * @returns 使用 `Joi.array().items(`{@link AE2PatternSchema}`.append({ slot: Joi.number().required(), direction: Joi.string().optional() }))` 验证
+     */
+    aeME(params: {
+        x: number;
+        y: number;
+        z: number;
+        dimension?: number;
+    }): Promise<Array<AE2Pattern & {
+        slot: number;
+        direction?: string;
+    }>>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEMEsHandler.java)
+     * @returns 使用 `Joi.array().items(`{@link AEMEInterfaceSchema}`)` 验证
+     */
+    aeMEs(params: {
+        x: number;
+        y: number;
+        z: number;
+        dimension?: number;
+        pattern?: boolean;
+        load?: boolean;
+        world?: boolean;
+    }): Promise<AEMEInterface[]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEMEsupportHandler.java)
+     * @returns 字符串数组，无专用 Schema
+     */
+    aeMESupport(): Promise<string[]>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AEItemHandler.java)
+     * @returns 使用 {@link AEItemsResultSchema} 验证
+     */
+    aeItems(params: {
+        x: number;
+        y: number;
+        z: number;
+        dimension?: number;
+    }): Promise<AEItemsResult>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AECPUTaskHandler.java)
+     * @param body 使用 {@link AECraftingTaskBodySchema} 验证
+     * @returns 使用 {@link AECraftingTaskResultSchema} 验证
+     */
+    aeCraft(params: {
+        x: number;
+        y: number;
+        z: number;
+        dimension?: number;
+    }, body: AECraftingTaskBody): Promise<AECraftingTaskResult>;
+    /**
+     * @java [java](../../../src/main/java/love/shirokasoke/webapi/webserver/handlers/ae2/AECPUCancelHandler.java)
+     * @param body 使用 {@link AECPUCancelBodySchema} 验证
+     * @returns 使用 {@link AECPUCancelResultSchema} 验证
+     */
+    aeCancel(params: {
+        x: number;
+        y: number;
+        z: number;
+        dimension?: number;
+    }, body: AECPUCancelBody): Promise<AECPUCancelResult>;
+}
+export declare class WebApiError extends Error {
+    status: number;
+    body?: unknown;
+    constructor(message: string, status: number, body?: unknown);
+}