@deafwave/osrs-botmaker-types 0.3.0 → 0.3.8

package/dist/src/types/sox/api/bot.d.ts

@@ -2,24 +2,46 @@
 
 declare const bot: SoxBotApi;
 
+interface ExchangeRequest {
+	itemId: number;
+	quantity: number;
+	aborted: boolean;
+	complete: boolean;
+	aborting: boolean;
+	slot: number | null;
+}
 interface SoxBotApi {
-	events: net.runelite.client.eventbus.EventBus;
+	events: {
+		unregisterAll: () => void;
+	} & net.runelite.client.eventbus.EventBus;
 	bank: {
 		close: () => void;
+		consumeIds: (ids: number[]) => boolean;
+		consumeNames: (names: string[]) => boolean;
+		depositAll: () => void;
 		depositAllWithId: (id: number) => void;
 		depositAllWithName: (name: string) => void;
 		depositWithId: (id: number) => void;
 		depositWithName: (name: string) => void;
+		getNotedMode: () => boolean;
+		getQuantityOfAllIds: (itemIds: number[]) => number[];
+		getQuantityOfAllNames: (itemNames: string[]) => number[];
+		getQuantityOfId: (itemId: number) => number;
+		getQuantityOfName: (itemName: string) => number;
+		isBanking: () => boolean;
 		isOpen: () => boolean;
+		open: () => void;
+		setNotedMode: (value: boolean) => void;
 		withdrawAllWithId: (id: number) => void;
 		withdrawAllWithName: (name: string) => void;
+		withdrawQuantityWithId: (id: number, quantity: number) => void;
 		withdrawWithId: (id: number) => void;
 		withdrawWithName: (name: string) => void;
 	};
 	bmCache: {
-		getBoolean: (key: string) => boolean;
-		getInt: (key: string) => number;
-		getString: (key: string) => string;
+		getBoolean: (key: string, defaultValue: boolean) => boolean;
+		getInt: (key: string, defaultValue: number) => number;
+		getString: (key: string, defaultValue: string) => string;
 		saveBoolean: (key: string, value: boolean) => void;
 		saveInt: (key: string, value: number) => void;
 		saveString: (key: string, value: string) => void;
@@ -31,10 +53,38 @@ interface SoxBotApi {
 		getCounter: (name: string) => number;
 		setCounter: (name: string, value: number) => void;
 	};
+	equipment: {
+		containsAllIds: (ids: number[]) => boolean;
+		containsAllNames: (names: string[]) => boolean;
+		containsAnyIds: (ids: number[]) => boolean;
+		containsAnyNames: (names: string[]) => boolean;
+		containsId: (id: number) => boolean;
+		containsName: (name: string) => boolean;
+		getEquipment: () => any[];
+	};
+	/** WARNING: QUEUE DOES NOT CLEAR ON GE ADDTOBUY */
+	grandExchange: {
+		addBuyToQueue: (itemId: number, quantity: number, walkToAndOpenGE: boolean) => ExchangeRequest;
+		getExchangeQueueSize: () => number;
+		getFreeSlots: () => number;
+		isExchanging: () => boolean;
+		isOpen: () => boolean;
+	};
 	graphicsObjects: {
 		getWithIds: (ids: number[]) => net.runelite.api.GraphicsObject[];
 	};
 	inventory: {
+		containsAllIds: (ids: number[]) => boolean;
+		containsAllNames: (names: string[]) => boolean;
+		containsAnyIds: (ids: number[]) => boolean;
+		containsAnyNames: (names: string[]) => boolean;
+		containsId: (id: number) => boolean;
+		containsName: (name: string) => boolean;
+		getEmptySlots: () => number;
+		getQuantityOfAllIds: (itemIds: number[]) => number[];
+		getQuantityOfAllNames: (itemNames: string[]) => number[];
+		getQuantityOfId: (itemId: number) => number;
+		getQuantityOfName: (itemName: string) => number;
 		interactWithIds: (itemIds: number[], options: string[]) => void;
 		interactWithNames: (itemNames: string[], options: string[]) => void;
 		itemOnItemWithIds: (itemId1: number, itemId2: number) => void;
@@ -43,6 +93,12 @@ interface SoxBotApi {
 		itemOnPlayerWithIds: (itemId: number, player: net.runelite.api.Player) => void;
 		itemOnPlayerWithNames: (itemNames: string[], playerNames: string[]) => void;
 	};
+	notifier: {
+		sendMessage: (message: string) => void;
+	};
+	net: {
+		sendMessage: (targetIds: string[], message: string, includeSelf: boolean) => void;
+	};
 	npcs: {
 		getAnimationID: (npc: net.runelite.api.NPC) => number;
 		getAttackSpeed: (npcId: number) => number;
@@ -53,12 +109,17 @@ interface SoxBotApi {
 		interactSupplied: (target: net.runelite.api.NPC, action: string) => void;
 	};
 	objects: {
+		getClosest: (tileObjects: net.runelite.api.TileObject[]) => net.runelite.api.TileObject;
+		getClosestWithin: (tileObjects: net.runelite.api.TileObject[], maxDistance: number) => net.runelite.api.TileObject;
 		getTileObjectComposition: (objectId: number) => net.runelite.api.ObjectComposition;
 		getTileObjectsWithIds: (ids: number[]) => net.runelite.api.TileObject[];
 		getTileObjectsWithNames: (names: string[]) => net.runelite.api.TileObject[];
+		getTileObjectsWithOptions: (options: string[]) => net.runelite.api.TileObject[];
 		interactObject: (objectName: string, action: string) => void;
 		interactObjects: (objectNames: string[], actions: string[]) => void;
 		interactSuppliedObject: (target: net.runelite.api.TileObject, action: string) => void;
+		isNearIds: (ids: number[], distance: number) => boolean;
+		isNearNames: (names: string[], distance: number) => boolean;
 	};
 	players: {
 		attackPlayer: (names: string[]) => void;
@@ -66,6 +127,21 @@ interface SoxBotApi {
 		isNearPlayer: (radius: number, names: string[]) => boolean;
 		tradePlayer: (names: string[]) => void;
 	};
+	plugins: {
+		questHelper: {
+			getCurrentQuestName: () => string;
+			getNextItem: () => any[];
+			/** TODO: ItemOnItem type */
+			getNextItemOnItem: () => any;
+			getNextNpc: () => net.runelite.api.NPC;
+			getNextTileObject: () => net.runelite.api.TileObject;
+			getNextWidget: () => net.runelite.api.widgets.Widget;
+			getNextWorldPoint: () => net.runelite.api.coords.WorldPoint;
+			getOverlayText: () => string;
+			isQuestStarted: () => boolean;
+			performNextStep: () => boolean;
+		};
+	};
 	prayer: {
 		togglePrayer: (prayer: net.runelite.api.Prayer, bypassMouseClicks: boolean) => void;
 	};
@@ -109,9 +185,22 @@ interface SoxBotApi {
 		) => void;
 		interactWidgetText: (text: string) => void;
 	};
+
+	menuAction(
+		p0: number,
+		p1: number,
+		action: MenuAction,
+		identifier: number,
+		itemId: number,
+		option: string,
+		target: string,
+		bounds?: Rectangle,
+	): void;
+
 	clearGameChat: () => void;
 	localPlayerIdle: () => boolean;
 	localPlayerMoving: () => boolean;
 	printGameMessage: (message: string) => void;
 	runClientScript: (ints: number[]) => void;
+	terminate: () => void;
 }

package/dist/src/types/sox/index.d.ts

@@ -3,6 +3,49 @@
 /// <reference path="./api/client.d.ts" />
 
 declare const configManager: {
-	getConfiguration: (groupName: string, key: string) => string | null;
-	setConfiguration: (groupName: string, key: string, value: string) => void;
+	// getConfiguration overloads
+	getConfiguration: {
+		(groupName: string, key: string): string | null;
+		(groupName: string, key: string, clazz: Type): object;
+		(groupName: string, profile: string, key: string, type: Type): object;
+	};
+
+	// setConfiguration overloads
+	setConfiguration: {
+		(groupName: string, key: string, value: object | boolean | string): void;
+		(groupName: string, profile: string, key: string, value: object | string | boolean): void;
+	};
+
+	// RS profile-specific get/set
+	getRSProfileConfiguration: {
+		(groupName: string, key: string): string | null;
+		(groupName: string, key: string, clazz: Type): object;
+	};
+	setRSProfileConfiguration: (groupName: string, key: string, value: object) => void;
+
+	// Other methods
+	getConfig: (clazz: Class) => object;
+	getConfigDescriptor: (configurationProxy: Config) => ConfigDescriptor;
+	getConfigurationKeys: (prefix: string) => List;
+	getProfile: () => ConfigProfile;
+	getRSProfileKey: () => string;
+	getRSProfileConfigurationKeys: (group: string, profile: string, keyPrefix: string) => List;
+	getRSProfiles: () => List;
+	getWholeKey: (groupName: string, profile: string, key: string) => string;
+	importAndMigrate: (lock: ProfileManager.Lock, from: File, targetProfile: ConfigProfile) => void;
+	isLoading: () => void;
+	onSessionClose: (sessionClose: SessionClose) => void;
+	onSessionOpen: (sessionOpen: SessionOpen) => void;
+	renameProfile: (profile: ConfigProfile, name: string) => void;
+	sendConfig: () => void;
+	setDefaultConfiguration: (proxy: Config, override: boolean) => void;
+	switchProfile: (profile: ConfigProfile) => void;
+	toggleSync: (profile: ConfigProfile, sync: boolean) => void;
+
+	// unsetConfiguration overloads
+	unsetConfiguration: {
+		(groupName: string, key: string): void;
+		(groupName: string, profile: string, key: string): void;
+	};
+	unsetRSProfileConfiguration: (groupName: string, key: string) => void;
 };

package/package.json

@@ -1,54 +1,54 @@
 {
-	"name": "@deafwave/osrs-botmaker-types",
-	"version": "0.3.0",
-	"author": {
-		"name": "Chandler Ferry",
-		"url": "https://github.com/ChandlerFerry"
-	},
-	"description": "Typescript Types for Sox's Botmaker",
-	"license": "Apache-2.0",
-	"type": "module",
-	"contributors": [],
-	"publishConfig": {
-		"access": "public",
-		"registry": "https://registry.npmjs.org"
-	},
-	"exports": {
-		"types": "./dist/src/index.d.ts",
-		"default": "./dist/src/exports/index.js"
-	},
-	"main": "./dist/src/exports/index.js",
-	"types": "./dist/src/index.d.ts",
-	"scripts": {
-		"lint": "eslint . --quiet",
-		"build": "tsc && cpy src/index.d.ts dist && cpy src/types dist",
-		"prepublish": "tsc && cpy src/index.d.ts dist && cpy src/types dist"
-	},
-	"files": [
-		"dist"
-	],
-	"devDependencies": {
-		"@eslint/eslintrc": "^2.1.1",
-		"@eslint/js": "~8.48.0",
-		"@tsconfig/node20": "^20.1.2",
-		"@tsconfig/strictest": "^2.0.3",
-		"@types/eslint": "^8.56.5",
-		"@types/eslint__js": "^8.42.3",
-		"@types/fs-extra": "^11.0.4",
-		"@typescript-eslint/eslint-plugin": "^7.1.1",
-		"@typescript-eslint/parser": "^7.1.1",
-		"cpy-cli": "^5.0.0",
-		"eslint": "^8.57.0",
-		"eslint-config-prettier": "^9.1.0",
-		"eslint-import-resolver-typescript": "^3.6.1",
-		"eslint-plugin-import": "^2.29.1",
-		"eslint-plugin-jest": "^27.9.0",
-		"eslint-plugin-unicorn": "^51.0.1",
-		"jsonc-eslint-parser": "^2.4.0",
-		"prettier": "^3.2.5",
-		"prettier-eslint": "^16.3.0",
-		"tsx": "^4.7.1",
-		"typescript": "5.2.2",
-		"typescript-eslint": "^7.1.1"
-	}
-}
+  "name": "@deafwave/osrs-botmaker-types",
+  "version": "0.3.8",
+  "author": {
+    "name": "Chandler Ferry",
+    "url": "https://github.com/ChandlerFerry"
+  },
+  "description": "Typescript Types for Sox's Botmaker",
+  "license": "Apache-2.0",
+  "type": "module",
+  "contributors": [],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "exports": {
+    "types": "./dist/src/index.d.ts",
+    "default": "./dist/src/exports/index.js"
+  },
+  "main": "./dist/src/exports/index.js",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@eslint/eslintrc": "^2.1.1",
+    "@eslint/js": "~8.48.0",
+    "@tsconfig/node20": "^20.1.2",
+    "@tsconfig/strictest": "^2.0.3",
+    "@types/eslint": "^8.56.5",
+    "@types/eslint__js": "^8.42.3",
+    "@types/fs-extra": "^11.0.4",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "@typescript-eslint/parser": "^7.1.1",
+    "cpy-cli": "^5.0.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-unicorn": "^51.0.1",
+    "jsonc-eslint-parser": "^2.4.0",
+    "prettier": "^3.2.5",
+    "prettier-eslint": "^16.3.0",
+    "tsx": "^4.7.1",
+    "typescript": "5.2.2",
+    "typescript-eslint": "^7.1.1"
+  },
+  "scripts": {
+    "lint": "eslint . --quiet",
+    "build": "tsc && cpy src/index.d.ts dist && cpy src/types dist",
+    "prepublish": "tsc && cpy src/index.d.ts dist && cpy src/types dist"
+  }
+}