@tsukilabs/nil-ffi 0.7.0

package/dist/index.js

@@ -0,0 +1,741 @@
+import * as ffi from "node:ffi";
+import { isNil } from "es-toolkit/predicate";
+import * as process from "node:process";
+//#region src/ptr.ts
+function allocBuffer(size) {
+	return Buffer.alloc(size ?? pointerSize());
+}
+function readBufferPtr(buffer) {
+	if (pointerSize() === 8) return buffer.readBigUInt64LE();
+	else return BigInt(buffer.readUInt32LE());
+}
+function pointerSize() {
+	if (process.arch === "x64" || process.arch === "arm64") return 8;
+	else return 4;
+}
+//#endregion
+//#region ../bindings/dist/index.js
+var ffi_Status = /* @__PURE__ */ function(ffi_Status) {
+	ffi_Status[ffi_Status["OK"] = 0] = "OK";
+	ffi_Status[ffi_Status["ERR_NULL_POINTER"] = 1] = "ERR_NULL_POINTER";
+	ffi_Status[ffi_Status["ERR_NOTHING_TO_POLL"] = 2] = "ERR_NOTHING_TO_POLL";
+	ffi_Status[ffi_Status["ERR_SERIALIZATION"] = 3] = "ERR_SERIALIZATION";
+	ffi_Status[ffi_Status["ERR_UNKNOWN"] = 2147483647] = "ERR_UNKNOWN";
+	return ffi_Status;
+}({});
+//! Copyright (C) Call of Nil contributors
+//! SPDX-License-Identifier: AGPL-3.0-only
+//#endregion
+//#region src/error.ts
+var FfiError = class FfiError extends Error {
+	constructor(message, options) {
+		const status = options?.status ?? ffi_Status.ERR_UNKNOWN;
+		if (!message && status !== ffi_Status.OK) {
+			for (const [key, value] of Object.entries(ffi_Status)) if (value === status) {
+				message = key;
+				break;
+			}
+		}
+		message ??= "ERR_UNKNOWN";
+		super(message, options);
+		this.name = "FfiError";
+		this.status = status;
+	}
+	static fromStatus(status) {
+		return new FfiError(null, { status });
+	}
+};
+var HandleClosedError = class extends Error {
+	constructor(options) {
+		super("handle is closed", options);
+		this.name = "HandleClosedError";
+	}
+};
+//#endregion
+//#region src/queue.ts
+var Queue = class Queue {
+	static {
+		this.POLL_INTERVAL = 16;
+	}
+	static {
+		this.LIMIT_PER_TICK = 200;
+	}
+	constructor(handle) {
+		this.pending = /* @__PURE__ */ new Map();
+		this.disposed = false;
+		this.functions = handle.functions;
+	}
+	[Symbol.dispose]() {
+		if (this.disposed) return;
+		this.disposed = true;
+		this.rejectAll(new HandleClosedError());
+	}
+	request(start) {
+		if (this.disposed) return Promise.reject(new HandleClosedError());
+		return new Promise((resolve, reject) => {
+			let id;
+			try {
+				id = start();
+			} catch (err) {
+				reject(err);
+				return;
+			}
+			this.pending.set(id, {
+				resolve,
+				reject
+			});
+			this.startPolling();
+		});
+	}
+	startPolling() {
+		if (isNil(this.timer) && !this.disposed) this.timer = setTimeout(() => this.poll(), 0);
+	}
+	poll() {
+		this.timer = null;
+		if (!this.disposed && this.pending.size > 0) try {
+			for (let i = 0; i < Queue.LIMIT_PER_TICK; i++) if (!this.pollOnce()) break;
+		} catch (err) {
+			this.rejectAll(err);
+			return;
+		}
+		if (!this.disposed && this.pending.size > 0) this.timer = setTimeout(() => this.poll(), Queue.POLL_INTERVAL);
+	}
+	pollOnce() {
+		const out = allocBuffer();
+		const status = this.functions.nil_ffi_poll(out);
+		if (status === ffi_Status.ERR_NOTHING_TO_POLL) return false;
+		if (status !== ffi_Status.OK) throw FfiError.fromStatus(status);
+		const ptr = readBufferPtr(out);
+		if (ptr === 0n) throw new Error("unexpected null pointer");
+		let json;
+		try {
+			json = ffi.toString(ptr);
+		} finally {
+			this.functions.nil_ffi_free_str(ptr);
+		}
+		const entry = JSON.parse(json);
+		const response = JSON.parse(entry.json_str);
+		const pending = this.pending.get(response.id);
+		if (!pending) return true;
+		this.pending.delete(response.id);
+		if (response.kind === "ok") pending.resolve(response.data);
+		else pending.reject(new FfiError(response.error, { status: response.status }));
+		return true;
+	}
+	rejectAll(error) {
+		if (!isNil(this.timer)) {
+			clearTimeout(this.timer);
+			this.timer = null;
+		}
+		for (const { reject } of this.pending.values()) reject(error);
+		this.pending.clear();
+	}
+};
+//#endregion
+//#region src/def.ts
+var definitions = {
+	nil_ffi_free_str: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.VOID
+	},
+	nil_ffi_poll: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.INT_32
+	},
+	nil_ffi_shutdown: {
+		arguments: [],
+		return: ffi.types.VOID
+	},
+	nil_ffi_version: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_client_version: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_is_local: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_is_ready: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_is_remote: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_server_addr: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_set_user_agent: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_stop_client: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_update_client: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_user_agent: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_world: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_add_academy_recruit_order: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_add_prefecture_build_order: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_add_stable_recruit_order: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_add_workshop_recruit_order: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_authorize: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cancel_academy_recruit_order: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cancel_maneuver: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cancel_prefecture_build_order: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cancel_stable_recruit_order: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cancel_workshop_recruit_order: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_fill_world: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_academy_recruit_queue: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_academy_recruit_queues: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_all_academy_recruit_queues: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_all_prefecture_build_queues: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_all_stable_recruit_queues: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_build_steps: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_cities: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_city: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_ethics: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_idle_armies_at: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_idle_personnel_at: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_infrastructure: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_maneuvers: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_maneuvers_of: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_player: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_players: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_prefecture_build_queue: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_prefecture_build_queues: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_resources: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_stable_recruit_queue: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_stable_recruit_queues: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_get_storage_capacity: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_bot_ethics: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_building_level: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_food: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_iron: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_max_food: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_max_infrastructure: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_max_iron: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_max_resources: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_max_silo_resources: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_max_stone: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_max_warehouse_resources: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_max_wood: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_resources: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_stability: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_stone: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_set_wood: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_skip_round: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_spawn_bot: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_spawn_city: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_cheat_spawn_personnel: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_create_remote_world: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_create_user: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_delete_remote_world: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_forward_report: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_academy_recruit_catalog: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_armies: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_army: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_army_owner: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_bot_coords: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_chat_history: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_cities: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_city: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_city_score: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_continent_size: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_idle_armies_at: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_idle_armies_coords: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_maneuver: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_player: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_player_coords: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_player_ids: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_player_maintenance: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_player_military: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_player_status: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_player_storage_capacity: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_player_worlds: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_precursor_coords: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_prefecture_build_catalog: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_bot: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_bots: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_cities: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_city: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_field: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_fields: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_player: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_players: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_precursor: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_public_precursors: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_rank: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_ranking: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_remote_world: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_remote_world_limit: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_get_remote_world_limit_per_user: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_get_remote_worlds: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_get_round: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_server_kind: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_get_stable_recruit_catalog: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_workshop_recruit_catalog: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_world_bots: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_world_config: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_world_personnel: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_world_players: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_world_precursors: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_get_world_stats: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_player_exists: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_push_chat_message: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_rename_city: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_request_maneuver: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_save_local_world: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_search_city: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_search_public_city: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_server_version: {
+		arguments: [],
+		return: ffi.types.UINT_32
+	},
+	nil_set_player_ready: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_set_player_status: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_simulate_battle: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_spawn_player: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_start_round: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_toggle_building: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_user_exists: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	},
+	nil_validate_token: {
+		arguments: [ffi.types.POINTER],
+		return: ffi.types.UINT_32
+	}
+};
+//#endregion
+//#region package.json
+var version = "0.7.0";
+//#endregion
+//#region src/index.ts
+var Nil = class {
+	constructor(dll) {
+		this.disposed = false;
+		if (!dll.endsWith(ffi.suffix)) dll = `${dll}.${ffi.suffix}`;
+		this.handle = ffi.dlopen(dll, definitions);
+		this.functions = this.handle.functions;
+		this.queue = new Queue(this.handle);
+		this.setUserAgent(`nil-ffi-node/${version}`);
+	}
+	[Symbol.dispose]() {
+		this.close();
+	}
+	close() {
+		if (this.disposed) return;
+		this.disposed = true;
+		this.queue[Symbol.dispose]();
+		this.functions.nil_ffi_shutdown();
+		this.handle[Symbol.dispose]();
+	}
+	async getClientVersion() {
+		this.throwIfClosed();
+		return this.queue.request(() => {
+			return this.functions.nil_client_version();
+		});
+	}
+	async getFfiVersion() {
+		this.throwIfClosed();
+		return this.queue.request(() => {
+			return this.functions.nil_ffi_version();
+		});
+	}
+	async getUserAgent() {
+		this.throwIfClosed();
+		return this.queue.request(() => {
+			return this.functions.nil_user_agent();
+		});
+	}
+	async getWorld() {
+		this.throwIfClosed();
+		return this.queue.request(() => {
+			return this.functions.nil_world();
+		});
+	}
+	async setUserAgent(userAgent) {
+		this.throwIfClosed();
+		await this.queue.request(() => {
+			return this.functions.nil_set_user_agent(userAgent);
+		});
+	}
+	throwIfClosed() {
+		if (this.disposed) throw new HandleClosedError();
+	}
+};
+//#endregion
+export { FfiError, HandleClosedError, Nil, definitions };