API update on February 17

[Jforjo]

Property missing type
All new values in the API can be found here: HypixelDatabase/HypixelTracking@74e6777

Describe the type
See above

Additional context

(Image from Cowshed Discord server)

[zikeji]

I got an email for each of these 🙃.

I do plan on getting to this, just not tonight or tomorrow - busy busy. PRs are welcome though, but adding types should be straightforward enough. It's a bummer Hypixel doesn't keep theirs up to date, the initial api.ts was generated from their swagger.json, I pulled the most recent swagger.json - no changes.

[Jforjo]

Sorry about all the notifs lol
I would do it all myself, but I've never contributed to a project before.
I opened it in github.dev and made a single change to test, but it said something about me not having write permissions and told me to "fork" it and I gave up

[zikeji]

Yes - you would fork, there's a little button at the top right that says fork - then you can make your changes, push them up, and when you're ready you can go to the pull requests tab on my copy of the repository and create a pull request. GitHub should helpfully suggest your fork.

Another alternative is making the changes and generating a patch file - basically if you do git diff > my.patch (or whatever the Windows equivalent is) and upload that it would be a head start.

[Jforjo]

OK, that was rather easy, thanks!
Here's the PR: #474

[Jforjo]

However, I believe a "garden.ts" file is missing in "src > types > skyblock" as there is an endpoint for the garden: https://api.hypixel.net/#tag/SkyBlock/paths/~1v2~1skyblock~1garden/get

[zikeji]

src/methods/skyblock/garden.ts is the client logic, that returns the SkyBlockGardenResponse:

node-hypixel/src/types/AugmentedTypes.ts

Line 259 in 594aa22

export type SkyblockGardenResponse = Paths.V2SkyblockGarden.Get.Responses.$200 &

Which ultimately returns the type from their documentation, since I never augmented it / explored it.

node-hypixel/src/types/api.ts

Lines 325 to 487 in 594aa22

	export interface SkyBlockGarden {
	/**
	* The UUID of the profile for this garden.
	*/
	uuid: string; // uuid
	commission_data?: {
	/**
	* A map of visitor identifier to visit count
	* example:
	* {
	* "jerry": 1,
	* "jacob": 2,
	* "andrew": 3
	* }
	*/
	visits?: {
	[key: string]: unknown;
	};
	/**
	* A map of visitor identifier to completed count
	* example:
	* {
	* "jerry": 1,
	* "jacob": 1,
	* "andrew": 2
	* }
	*/
	completed?: {
	[key: string]: unknown;
	};
	total_completed?: number; // int32
	unique_npcs_served?: number; // int32
	};
	/**
	* example:
	* {
	* "organic_matter": 1772.8,
	* "fuel_units": 17000,
	* "compost_units": 0,
	* "compost_items": 2,
	* "conversion_ticks": 300,
	* "last_save": 1721039418436,
	* "upgrades": {
	* "speed": 25,
	* "multi_drop": 25,
	* "fuel_cap": 22,
	* "organic_matter_cap": 25,
	* "cost_reduction": 25
	* }
	* }
	*/
	composter_data?: {
	[key: string]: unknown;
	};
	/**
	* example:
	* {
	* "liam": {
	* "requirement": [
	* {
	* "original_item": "NETHER_STALK",
	* "original_amount": 93995,
	* "item": "MUTANT_NETHER_STALK",
	* "amount": 4
	* }
	* ],
	* "status": "NOT_STARTED",
	* "position": 1
	* },
	* "lumberjack": {
	* "requirement": [
	* {
	* "original_item": "POTATO_ITEM",
	* "original_amount": 81380,
	* "item": "ENCHANTED_BAKED_POTATO",
	* "amount": 3
	* }
	* ],
	* "status": "NOT_STARTED",
	* "position": 2
	* },
	* "oringo": {
	* "requirement": [
	* {
	* "original_item": "WHEAT",
	* "original_amount": 26798,
	* "item": "ENCHANTED_HAY_BLOCK",
	* "amount": 21
	* }
	* ],
	* "status": "NOT_STARTED",
	* "position": 3
	* },
	* "rhys": {
	* "requirement": [
	* {
	* "original_item": "JACK_O_LANTERN",
	* "original_amount": 512,
	* "item": "JACK_O_LANTERN",
	* "amount": 512
	* }
	* ],
	* "status": "NOT_STARTED",
	* "position": 4
	* },
	* "fear_mongerer": {
	* "requirement": [
	* {
	* "original_item": "PUMPKIN",
	* "original_amount": 27709,
	* "item": "POLISHED_PUMPKIN",
	* "amount": 1
	* }
	* ],
	* "status": "NOT_STARTED",
	* "position": 5,
	* "extra_rewards": [
	* {
	* "candy": "PURPLE_CANDY"
	* }
	* ]
	* }
	* }
	*/
	active_commissions?: {
	[key: string]: unknown;
	};
	/**
	* A map of resource ID to amount collected
	* example:
	* {
	* "WHEAT": 100,
	* "POTATO_ITEM": 100,
	* "INK_SACK:3": 100
	* }
	*/
	resources_collected?: {
	[key: string]: unknown;
	};
	/**
	* example:
	* {
	* "WHEAT": 1,
	* "POTATO_ITEM": 2,
	* "INK_SACK:3": 3
	* }
	*/
	crop_upgrade_levels?: {
	[key: string]: unknown;
	};
	/**
	* example:
	* [
	* "beginner_1",
	* "intermediate_3"
	* ]
	*/
	unlocked_plots_ids?: string[];
	garden_experience?: number; // double
	unlocked_barn_skins?: string[];
	selected_barn_skin?: string;
	}
	/**

(as a quick crash course, api.ts is generated from their swagger.json using dtsgen and augmented types are my type annotations to "augment" and add more intellisense/type resolution)