Changelog

All notable changes to this project will be documented in this file. See Conventional Commits (opens new window) for commit guidelines.

4.1.4 (opens new window) (2024-12-02)

Documentation

• issue template: add template for reporting missing type completion (5fddda0 (opens new window))

4.1.3 (opens new window) (2024-09-17)

Bug Fixes

• override SkyBlockAuction component to ensure consistent typing (a99c061 (opens new window))

4.1.2 (opens new window) (2024-09-17)

Bug Fixes

• add bin to auction type (63f2e52 (opens new window))

4.1.1 (opens new window) (2024-09-16)

Bug Fixes

• properly type hint the nature of values being undefined in the event a player has never touched Hypixel (569d245 (opens new window))
• return an empty result properly (be12a07 (opens new window))

4.1.0 (opens new window) (2024-09-16)

Features

• add augmented skyblock profiles endpoint typings (6ad6c41 (opens new window))
• add guild type augment (47e15d8 (opens new window))
• augment election endpoint (d3ee25f (opens new window))
• augmented types for the /v2/player endpoint (45075da (opens new window))
• more augmented types, some clean up (282d0cf (opens new window))
• move augment files for better organization (2435dd6 (opens new window))

Bug Fixes

• regression from removing the record augment (962801d (opens new window))
• type resolution errors (1a57979 (opens new window))

Miscellaneous Chores

• bump typescript version to latest (bf519fc (opens new window))
• more dependency updates (with an override!) (7f94df9 (opens new window))

Tests

• update helper type resolution (1e2fc01 (opens new window))

Documentation

• add category to client methods (90a7373 (opens new window))

4.0.2 (opens new window) (2024-09-11)

Bug Fixes

• ci docs publish (d30ee7e (opens new window))

4.0.1 (opens new window) (2024-09-11)

Bug Fixes

• CI fix for release (1878274 (opens new window))

4.0.0 (opens new window) (2024-09-11)

⚠ BREAKING CHANGES

• prepare 4.0.0 release

Features

• enhance collections typing (c038ee1 (opens new window)), closes #437 (opens new window)
• prepare 4.0.0 release (52d620c (opens new window))
• refactor for v2 endpoints and swagger typing (378eb4d (opens new window))
• update exports (c4a35a6 (opens new window)), closes #437 (opens new window)

Bug Fixes

• broken types (2917d0e (opens new window)), closes #437 (opens new window)
• guild level helper typing (40e61fa (opens new window)), closes #437 (opens new window)
• lint (4e50686 (opens new window)), closes #437 (opens new window)
• player helpers (f436bfa (opens new window)), closes #437 (opens new window)
• resolve proper skills (60d0e6c (opens new window)), closes #437 (opens new window)
• romanize (2740917 (opens new window)), closes #437 (opens new window)
• sky wars helper (952f6ba (opens new window)), closes #437 (opens new window)
• skyblock item data transform (6939a4d (opens new window)), closes #437 (opens new window)
• skyblock skills helper (1990a2e (opens new window)), closes #437 (opens new window)
• typings and path on collections helper (74d095a (opens new window)), closes #437 (opens new window)
• typo in skills endpoint (ef99d0b (opens new window)), closes #437 (opens new window)
• URL constructor resulting in v1 endpoitns getting called (0bd3ecb (opens new window)), closes #437 (opens new window)

Code Refactoring

• augment naming to fit nature (bb7f9d6 (opens new window)), closes #437 (opens new window)

Documentation

• update documentation generation (d2e4b8a (opens new window))

Tests

• begin to fix tests (c2fe76b (opens new window)), closes #437 (opens new window)
• omit client test (for now) (1875da7 (opens new window)), closes #437 (opens new window)
• resolve test failures (4b10d8d (opens new window))
• update cache test, add test client mocking from data directory (9839f1b (opens new window)), closes #437 (opens new window)
• update errors test (8c0608d (opens new window)), closes #437 (opens new window)
• update helpers test (c6a4e1a (opens new window))

3.1.1 (opens new window) (2021-03-30)

Bug Fixes

• add bigint check (8988723 (opens new window))

Miscellaneous Chores

• deps: update dependencies (5400617 (opens new window))
• deps docs: bump typedoc plugin (1f65240 (opens new window))
• deps docs: update documentation deps and update styles to fix issues (34988f2 (opens new window))
• docs: update CI action (f737eda (opens new window))

3.1.0 (opens new window) (2021-03-22)

Features

• add deno example, add semantic release command to change README.md (8027a8e (opens new window))

Documentation

• README: add /mod.ts to docs for Deno (357e760 (opens new window))

Miscellaneous Chores

• deps: update dependencies (28eb3b3 (opens new window))

3.0.3 (opens new window) (2021-03-22)

Bug Fixes

• ci: change token to env (9251406 (opens new window))
• ci: push after removing the deno_dist files (b81a280 (opens new window))
• ci: use API directly (5f96489 (opens new window))

3.0.2 (opens new window) (2021-03-22)

Bug Fixes

• ci: use dispatch, fix missing backtick (dad1989 (opens new window))

Tests

• helpers: migrate more deno tests (1e144bd (opens new window))

3.0.1 (opens new window) (2021-03-22)

Bug Fixes

• ci: fix typo in ci (0644fd7 (opens new window))

3.0.0 (opens new window) (2021-03-22)

⚠ BREAKING CHANGES

• separate request portion of client and add denoify port

Features

• add denoify in prep to properly add Deno support (3315eb4 (opens new window))
• add NBT deno port for TransformItemData (610aa32 (opens new window))
• ignore bulky files in distribution (ecbb545 (opens new window))
• separate request portion of client and add denoify port (687acb0 (opens new window))
• update release workflow (72265c2 (opens new window))

Bug Fixes

• add try/catch to solve issue with nbt_parser (08228b7 (opens new window))
• commit deno test files (389dcad (opens new window))
• fix incorrect merge causing issues (70ba731 (opens new window))

Miscellaneous Chores

• deps: update prismarine-nbt dev dependency (6301739 (opens new window))

Tests

• coverage: ignore deno ports for coverage (7a16dda (opens new window))
• fix: remove unused import (298bf98 (opens new window))
• refer to previous (50e1509 (opens new window))
• remove globals.d.ts from test files (8ce8a07 (opens new window))

Documentation

• restore changelog (93efe02 (opens new window))
• helpers: update minecraft item data docs for deno (8fda927 (opens new window))
• helpers: update prismarine nbt line (fb0535d (opens new window))

2.2.3 (opens new window) (2021-03-19)

Bug Fixes

• deno: rework imports and change stuff around to get Deno working (7d2e016 (opens new window))

2.2.2 (opens new window) (2021-03-19)

Bug Fixes

• deno: add deno-types comments (cd97322 (opens new window))

2.2.1 (opens new window) (2021-03-19)

Bug Fixes

• deno: add mod.ts for deno (3a024f0 (opens new window))
• deno: export all with extension in mod.ts for correct resolution (16b6839 (opens new window))

2.2.0 (opens new window) (2021-03-19)

Features

• helpers: add SkyWars helpers for level and prestige (15be627 (opens new window)), closes #203 (opens new window)

Documentation

• helpers: add SkyWars helpers documentation (ed80716 (opens new window))
• fix typo in bedwars info (db7ab77 (opens new window))
• optimize webp examples (37abc23 (opens new window))

2.1.2 (opens new window) (2021-03-19)

Miscellaneous Chores

• update dependencies (6d787bf (opens new window))
• update dev dependencies (8503b74 (opens new window))

Documentation

• add deno link (b58124d (opens new window))

2.1.1 (opens new window) (2021-01-12)

Miscellaneous Chores

• semantic-releases: add new releaseRules (b726ef8 (opens new window))

Documentation

• readme: add Discord link to README (0c583aa (opens new window))
• vuepress: add Discord link to navigation bar of documentation site (51d1abb (opens new window))

2.1.0 (opens new window) (2021-01-12)

Features

• docs: add algolia docsearch (3bf266a (opens new window))

2.0.1 (opens new window) (2021-01-09)

Bug Fixes

• docs: don't include files, only a single entry point (e734f75 (opens new window))

Documentation

• readme: add some more information to readme (685daf1 (opens new window))
• readme: update general information in readme header (49d2227 (opens new window))
• add category for new helpers (ca4c2d3 (opens new window))
• add more documentation to methods (a42eeff (opens new window))
• include full reflection in navbar title (cbd42e8 (opens new window))
• remove no-inherit plugin (ce0faba (opens new window))
• remove theme as it was removed in latest release (8ba4e4b (opens new window))
• update broken links (8a2da51 (opens new window))
• update to newer plugin options for cleaner output (85f8333 (opens new window))

Miscellaneous Chores

• deps: update out of date dependencies, resolve migration changes in vuepress-theme-mrhope (ca71397 (opens new window))

2.0.0 (opens new window) (2021-01-08)

⚠ BREAKING CHANGES

• issue with typedoc generation vuepress build

Bug Fixes

• issue with typedoc generation vuepress build (17e37c3 (opens new window))

Documentation

• dev: resolve issue rebuilding in a saturated environment (bb7fe85 (opens new window))

1.20.0 (opens new window) (2021-01-08)

Features

• helpers: add SkyBlock skills helper (2ec2d34 (opens new window))

Documentation

• helpers: add documentation for the profile skills helper (b5427d9 (opens new window))
• readme: remove 2.0 mention (5f24c6b (opens new window))
• typedoc: resolve issue with ts api docs missing (4d2dd71 (opens new window))
• vuepress: remove erroneous console.log statement (2926b8c (opens new window))
• vuepress: update all urls to point to new ts-api links (7beecf8 (opens new window))

Miscellaneous Chores

• deps: update a few documentation related dependencies (58409f0 (opens new window))
• deps: update dts generator and update processing to account for changes (05cef05 (opens new window))

1.19.0 (opens new window) (2021-01-04)

Features

• api: add /skyblock/auctions_ended endpoint (1b8a4f6 (opens new window))

Bug Fixes

• deps: duplicate line (f0359c1 (opens new window))
• docs: fix issue with newer typedoc not generating properly (9ad8e8f (opens new window))

Documentation

• helpers: add information on using the item data helper for auctions (2fb1ece (opens new window))

Miscellaneous Chores

• dependencies: update prismarine, and typings (524ba52 (opens new window))

1.18.0 (opens new window) (2020-12-08)

Features

• tests: add tests for collections helper (01a37aa (opens new window))
• add skyblock collections helper (55d0efb (opens new window))
• api: build out Guild schema more (2e9c09a (opens new window))
• helpers: add guild level helper (2bed9c3 (opens new window))

Bug Fixes

• client: fix reset date in limited event (1874bbc (opens new window))
• docs: resolve error generating TS documentation (9b9ab7d (opens new window))
• docs: update navbar style to reflect vuepress theme update changes (6d723b4 (opens new window))
• lint: fixed lint errors from newer lint preset (6afa7e5 (opens new window))

Tests

• update helpers test to reflect name change (ed11e26 (opens new window))

Documentation

• helpers: add documentation for profile collections helper (ad637f5 (opens new window))
• readme: add helpers excerpt (99d4648 (opens new window))
• add frontmatter category and tags (0a528f1 (opens new window))
• update last-updated date to be more readable (3beb18e (opens new window))
• changelog: update pages.js to rebuild changelog with better formatting (6469178 (opens new window))
• add more notes to helpers (f3f733f (opens new window))
• helpers: add guild level documentation (6e3a977 (opens new window))
• helpers: fix typo on network-level doc (cb3309b (opens new window))
• readme: add 2.0 description to readme (8c46629 (opens new window))

1.17.0 (opens new window) (2020-11-17)

Features

• api: completely explore and type out /player endpoint and update testing to validate (9e674bd (opens new window))
• api: expand typing to the player.stats.Bedwars object (4a469af (opens new window))
• api: update player schema to include more social links (2d43066 (opens new window))
• helpers: add Bedwars helper for level / prestige info (485c010 (opens new window))
• helpers: add NetworkLevel helper and add licensing information for the work (21e2342 (opens new window))
• helpers: revise skyblock item data into minecraft item data and added usage example for pit (398f3a9 (opens new window))

Bug Fixes

• helpers: add rank and plus color as they are separate (c61aba0 (opens new window))
• package: removed redundant line (f21ef7f (opens new window))

Code Refactoring

• helpers: remove NonNullable due to earlier changes making it redundant (648e476 (opens new window))

Documentation

• helpers: add description for network level helper. (e1508a7 (opens new window))
• helpers: add documentation for Bedwars helper (90f0408 (opens new window))
• helpers: add documentation for network level (c9f2cdd (opens new window))

Tests

• helpers: add bedwarslevelinfo test and trim fat (2883d57 (opens new window))

1.16.0 (opens new window) (2020-11-14)

Features

• helpers: add NBT data transformation (42f2325 (opens new window))

Bug Fixes

• test: fix compilation issue for running coverage (8fbf1b6 (opens new window))

Code Refactoring

• helpers: moved current helpers into dedicated folder (1893a68 (opens new window))

Tests

• coverage: bring coverage back to 100% (ce895d4 (opens new window))
• nbt: add tests for transforming item data to ensure they match schema (885f3d6 (opens new window))

Documentation

• helpers: add documentation and examples for item data helper (015f724 (opens new window))

1.15.0 (opens new window) (2020-11-12)

Features

• api: removed rate limit and key on /skyblock/auctions and /skyblock/bazaar (e3a882f (opens new window))
• client: add optional cache support to client (7bbeb13 (opens new window))

Bug Fixes

• client: ocassionally age is undefined when cache hit on CF (894e33a (opens new window))

Code Refactoring

• client: no longer extend EventEmitter to get cleaner type suggestions (fd2e5e5 (opens new window))

Documentation

• client: add more documentation to the client (278cf37 (opens new window))
• guide: add cache guide (236f110 (opens new window))
• readme: update README (1356d43 (opens new window))

1.14.0 (opens new window) (2020-11-11)

Features

• helpers: add hypixel rank helper (98b6fbf (opens new window))

1.13.0 (opens new window) (2020-11-10)

Features

• api: add /skyblock/auctions and /skyblock/auction endpoint (9349037 (opens new window))
• api: add /skyblock/bazaar endpoint (8ffe9a5 (opens new window))
• api: add /skyblock/profile and /skyblock/profiles endpoint (4c6285a (opens new window))
• api: update skyblock profile schema (9b84460 (opens new window))
• schema: add headers to schema (45ba69f (opens new window))

Documentation

• readme: update progress in readme (6c598d0 (opens new window))

1.12.0 (opens new window) (2020-11-08)

Features

• api: add /resources/achievements endpoint (d648dc8 (opens new window))
• api: add /resources/challenges endpoint (731895d (opens new window))
• api: add /resources/guilds/achievements and /resources/guilds/permissions endpoint (015adf4 (opens new window))
• api: add /resources/quests endpoint (ae40ec4 (opens new window))

Bug Fixes

• extra "example" key in schema (5166bc9 (opens new window))

1.11.0 (opens new window) (2020-11-07)

Features

• api: add /findGuild endpoint (2539022 (opens new window))
• api: add /friends endpoint (04b1a9e (opens new window))
• api: add /key endpoint (7c3b0f7 (opens new window))
• api: add /player endpoint (b6dd8b9 (opens new window))
• api: add boosters endpoint (a78baf6 (opens new window))
• api: add guild endpoint (66ff480 (opens new window))
• api: add leaderboards endpoint (f0917c5 (opens new window))
• api: add player count and game counts endpoints (44bf47a (opens new window))
• api: add recentGames endpoint (9424309 (opens new window))
• error handling: add GenericHTTPError to cover the rest of Hypixel's error types & increase code coverage to 100% (02c92e1 (opens new window))

Documentation

• readme: update progress in readme (4b7f29c (opens new window))

1.10.0 (opens new window) (2020-10-20)

Features

• meta: add new unenumerable meta field to results for meta information (4357a7a (opens new window))
• meta: add ratelimit to meta (3de2b7f (opens new window))

Bug Fixes

• type: resultarray returns appropriate array type (d8ae79e (opens new window))

Tests

• improve coverage, test new meta (2933f04 (opens new window))
• skyblock news: add more assertions for news test (791b02e (opens new window))

Documentation

• guide: begin fleshing out guide (be6ac06 (opens new window))
• vuepress: extract additionalpages to new plugin and adjust changelog sidebar headers (41728e6 (opens new window))

1.9.1 (opens new window) (2020-10-19)

Bug Fixes

• ci: run test on everything so CI updates properly (169ba06 (opens new window))

Documentation

• add more logging and second build to see if pesky ts-api wants to work (c7a2c16 (opens new window))
• readme: update usage example (606a46c (opens new window))

1.9.0 (opens new window) (2020-10-19)

Features

• api: add skyblock skills resource endpoint (9ee0d8a (opens new window))

Bug Fixes

• ci: main not master (a4b4c4d (opens new window))
• docs: fix sidebar warning (ff4e61c (opens new window))
• docs: refresh addthis on reload (fee1619 (opens new window))

Documentation

• readme: update readme usage example (8a0ef8b (opens new window))
• add AddThis support (11545ca (opens new window))

1.8.1 (opens new window) (2020-10-19)

Bug Fixes

• docs: checkout master and use node_env (cad343e (opens new window))

Documentation

• api: persist authorization (c3fffd2 (opens new window))

1.8.0 (opens new window) (2020-10-19)

Features

• api: add /status endpoint (29be746 (opens new window))
• docs: add support for code blocks in descriptions (e8025eb (opens new window))
• docs: revamp the schema display styles (0aa2ab7 (opens new window))
• docs: use webpack to load openapi yaml schema (33bc537 (opens new window))

Bug Fixes

• ci: type in nyc command for ci coverage (9beee2e (opens new window))
• cross-env: use a ci script (8f1b4e1 (opens new window))
• docs: fix issues causing docs:build to fail (59f0f37 (opens new window))

Documentation

• api: style authorization dialog (8554eca (opens new window))
• config: add to watched files (2d9283a (opens new window))
• openapi: add usage examples (77b6d6c (opens new window))
• readme: update to include project readme instead of custom readme for /, fix some styling (6f162c0 (opens new window))
• swagger: change expand depth (44992cb (opens new window))

1.7.0 (opens new window) (2020-10-19)

Features

• api: add watchdogstats (d6ad4b7 (opens new window))

Reverts

• ci: revert runs-on as it did not solve the issue (4022c2c (opens new window))

Code Refactoring

• client: Refactor client to closely match the methods of the API. (66854f4 (opens new window))

Documentation

• readme: update readme (6ce65d7 (opens new window))
• readme: update roadmap (71df72a (opens new window))
• readme: update roadmap (61e774d (opens new window))
• vuepress: disable cache for local dev (baea275 (opens new window))

Miscellaneous Chores

• dependencies: update dependencies (e257e22 (opens new window))
• dependencies: update them once again (7b9bbae (opens new window))

1.6.0 (opens new window) (2020-10-18)

Features

• docs: add Swagger client with some styling (7ef6f72 (opens new window))

Bug Fixes

• include all in dist folder (afa5044 (opens new window))

1.5.2 (opens new window) (2020-10-18)

Bug Fixes

• ci: add logging to action in attempt to troubleshoot missing information (c877fa4 (opens new window))

Documentation

• meta: add social, add embed metadata (858895a (opens new window))
• readme: point to coveralls (1d30fe2 (opens new window))

1.5.1 (opens new window) (2020-10-18)

Bug Fixes

• docs: properly escape hero text (d3f789d (opens new window))
• publishing: add publishconfig and explicit private (2fd4380 (opens new window))

Documentation

• readme: fix links (3565628 (opens new window))

1.5.0 (opens new window) (2020-10-18)

Features

• rebrand: again, rebrand, to an available package name (6b2fe6a (opens new window))

Bug Fixes

• typo: type in package.json (34fa9f0 (opens new window))

Miscellaneous Chores

• lock: update package-lock (bcfc0db (opens new window))

1.4.0 (opens new window) (2020-10-18)

Features

• collections: add collections resource (786f524 (opens new window))
• rebrand: rebrand to hypixelapi (ca3dc87 (opens new window))

1.3.0 (opens new window) (2020-10-17)

Features

• openapi: begin implementation of OpenAPI 3.0 spec (98dc4eb (opens new window))

Documentation

• readme: update shield (756e78f (opens new window))
• vuepress: rename typedoc generated content to ts-api (f56e9b3 (opens new window))

1.2.0 (opens new window) (2020-10-17)

Features

• docs: add new documentation using vuepress (d9a1661 (opens new window))

Tests

• queue: fix reset data issue (54ed1fd (opens new window))

Code Refactoring

• HypixelSkyblock to "Client". Add base index to re-export all for usage on NPM. (99401bb (opens new window))

Documentation

• readme: update readme (66b9c86 (opens new window))
• more documentation for the profile interface (dab4a98 (opens new window))
• more documentation tweaks, including namespacing (4de57ee (opens new window))

1.1.0 (opens new window) (2020-10-12)

Features

• ratelimit: add rate limit queue (707a342 (opens new window))

1.0.0 (2020-10-11)

Features

• houston, we are a go! (eafb0d0 (opens new window))

Bug Fixes

• actions: add environment variable (773b7a1 (opens new window))
• actions: drop support for node 8.0 (b8440f4 (opens new window))
• ci: note to self: build before running tests (c70da5a (opens new window))
• semantic-release: use main branch (81276b0 (opens new window))

Documentation

• readme: add another badge - shiny (9236b32 (opens new window))
• readme: update readme & package (ddce35d (opens new window))