hypixel-api-reborn 11.3.4 → 12.0.0-0

package/dist/src/API/getSkyblockAuction.test.js

@@ -0,0 +1,382 @@
+import Auction from '../structures/SkyBlock/Auctions/Auction';
+import Bid from '../structures/SkyBlock/Auctions/Bid';
+import Client from '../Client';
+import ItemBytes from '../structures/ItemBytes';
+import { expect, expectTypeOf, test } from 'vitest';
+test('getSkyblockAuction (raw)', async () => {
+    const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const auctions = await client.getSkyblockAuctions(1);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const data = await client.getSkyblockAuction('player', auctions.auctions[0].auctioneerUuid, { raw: true });
+    expect(data).toBeDefined();
+    expectTypeOf(data).toEqualTypeOf();
+    client.destroy();
+});
+test('getSkyblockAuction (No Query)', () => {
+    const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    expect(() => client.getSkyblockAuction('auction', '')).rejects.toThrowError(client.errors.NO_NICKNAME_UUID);
+    client.destroy();
+});
+test('getSkyblockAuction (Bad Filter)', () => {
+    const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    expect(() => client.getSkyblockAuction('meow')).rejects.toThrowError(client.errors.BAD_AUCTION_FILTER);
+    client.destroy();
+});
+test('getSkyblockAuction (Auction)', async () => {
+    const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const auctions = await client.getSkyblockAuctions(1);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const data = await client.getSkyblockAuction('auction', auctions.auctions[0].auctioneerUuid);
+    expect(data).toBeDefined();
+    expectTypeOf(data).toEqualTypeOf();
+    expect(data).toBeDefined();
+    expectTypeOf(data).toEqualTypeOf();
+    expect(data.length).greaterThanOrEqual(0);
+    expectTypeOf(data.length).toEqualTypeOf();
+    data.forEach((auction) => {
+        expect(auction).toBeDefined();
+        expect(auction).toBeInstanceOf(Auction);
+        expectTypeOf(auction).toEqualTypeOf();
+        expect(auction.auctionId).toBeDefined();
+        expectTypeOf(auction.auctionId).toEqualTypeOf();
+        expect(auction.auctioneerUuid).toBeDefined();
+        expectTypeOf(auction.auctioneerUuid).toEqualTypeOf();
+        expect(auction.auctioneerProfile).toBeDefined();
+        expectTypeOf(auction.auctioneerProfile).toEqualTypeOf();
+        expect(auction.bin).toBeDefined();
+        expectTypeOf(auction.bin).toEqualTypeOf();
+        expect(auction.itemBytes).toBeDefined();
+        expect(auction.itemBytes).toBeNull();
+        expectTypeOf(auction.itemBytes).toEqualTypeOf();
+        expect(auction.coop).toBeDefined();
+        expectTypeOf(auction.coop).toEqualTypeOf();
+        expect(auction.auctionStartTimestamp).toBeDefined();
+        expect(auction.auctionStartTimestamp).greaterThanOrEqual(0);
+        expectTypeOf(auction.auctionStartTimestamp).toEqualTypeOf();
+        expect(auction.auctionStart).toBeDefined();
+        expectTypeOf(auction.auctionStart).toEqualTypeOf();
+        expect(auction.auctionEndTimestamp).toBeDefined();
+        expectTypeOf(auction.auctionEndTimestamp).toEqualTypeOf();
+        expect(auction.auctionEnd).toBeDefined();
+        expectTypeOf(auction.auctionEnd).toEqualTypeOf();
+        expect(auction.item).toBeDefined();
+        expectTypeOf(auction.item).toEqualTypeOf();
+        expect(auction.itemLore).toBeDefined();
+        expectTypeOf(auction.itemLore).toEqualTypeOf();
+        expect(auction.itemLoreRaw).toBeDefined();
+        expectTypeOf(auction.itemLoreRaw).toEqualTypeOf();
+        expect(auction.rarity).toBeDefined();
+        expectTypeOf(auction.rarity).toEqualTypeOf();
+        expect(auction.startingBid).toBeDefined();
+        expectTypeOf(auction.startingBid).toEqualTypeOf();
+        expect(auction.highestBid).toBeDefined();
+        expectTypeOf(auction.highestBid).toEqualTypeOf();
+        expect(auction.bids).toBeDefined();
+        expectTypeOf(auction.bids).toEqualTypeOf();
+        auction.bids.forEach((bid) => {
+            expect(bid).toBeDefined();
+            expect(bid).toBeInstanceOf(Bid);
+            expectTypeOf(bid).toEqualTypeOf();
+            expect(bid.auctionId).toBeDefined();
+            expectTypeOf(bid.auctionId).toEqualTypeOf();
+            expect(bid.profileId).toBeDefined();
+            expectTypeOf(bid.profileId).toEqualTypeOf();
+            expect(bid.amount).toBeDefined();
+            expect(bid.amount).greaterThanOrEqual(0);
+            expectTypeOf(bid.amount).toEqualTypeOf();
+            expect(bid.timestamp).toBeDefined();
+            expectTypeOf(bid.timestamp).toEqualTypeOf();
+            expect(bid.at).toBeDefined();
+            expectTypeOf(bid.at).toEqualTypeOf();
+            expect(bid.bidder).toBeDefined();
+            expectTypeOf(bid.bidder).toEqualTypeOf();
+            expect(bid.toString()).toBeDefined();
+            expect(bid.toString()).toBe(`${bid.bidder} bid ${bid.amount} coins`);
+            expectTypeOf(bid.toString()).toEqualTypeOf();
+        });
+        expect(auction.claimed).toBeDefined();
+        expectTypeOf(auction.claimed).toEqualTypeOf();
+        expect(auction.claimedBidders).toBeDefined();
+        expectTypeOf(auction.claimedBidders).toEqualTypeOf();
+        expect(auction.toString()).toBeDefined();
+        expect(auction.toString()).toEqual(auction.item);
+        expectTypeOf(auction.toString()).toEqualTypeOf();
+    });
+    client.destroy();
+});
+test('getSkyblockAuction (Player)', async () => {
+    const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const auctions = await client.getSkyblockAuctions(1);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const data = await client.getSkyblockAuction('player', auctions.auctions[0].auctioneerUuid);
+    expect(data).toBeDefined();
+    expectTypeOf(data).toEqualTypeOf();
+    expect(data).toBeDefined();
+    expectTypeOf(data).toEqualTypeOf();
+    expect(data.length).greaterThanOrEqual(0);
+    expectTypeOf(data.length).toEqualTypeOf();
+    data.forEach((auction) => {
+        expect(auction).toBeDefined();
+        expect(auction).toBeInstanceOf(Auction);
+        expectTypeOf(auction).toEqualTypeOf();
+        expect(auction.auctionId).toBeDefined();
+        expectTypeOf(auction.auctionId).toEqualTypeOf();
+        expect(auction.auctioneerUuid).toBeDefined();
+        expectTypeOf(auction.auctioneerUuid).toEqualTypeOf();
+        expect(auction.auctioneerProfile).toBeDefined();
+        expectTypeOf(auction.auctioneerProfile).toEqualTypeOf();
+        expect(auction.bin).toBeDefined();
+        expectTypeOf(auction.bin).toEqualTypeOf();
+        expect(auction.itemBytes).toBeNull();
+        expect(auction.itemBytes).toBeDefined();
+        expectTypeOf(auction.itemBytes).toEqualTypeOf();
+        expect(auction.coop).toBeDefined();
+        expectTypeOf(auction.coop).toEqualTypeOf();
+        expect(auction.auctionStartTimestamp).toBeDefined();
+        expect(auction.auctionStartTimestamp).greaterThanOrEqual(0);
+        expectTypeOf(auction.auctionStartTimestamp).toEqualTypeOf();
+        expect(auction.auctionStart).toBeDefined();
+        expectTypeOf(auction.auctionStart).toEqualTypeOf();
+        expect(auction.auctionEndTimestamp).toBeDefined();
+        expectTypeOf(auction.auctionEndTimestamp).toEqualTypeOf();
+        expect(auction.auctionEnd).toBeDefined();
+        expectTypeOf(auction.auctionEnd).toEqualTypeOf();
+        expect(auction.item).toBeDefined();
+        expectTypeOf(auction.item).toEqualTypeOf();
+        expect(auction.itemLore).toBeDefined();
+        expectTypeOf(auction.itemLore).toEqualTypeOf();
+        expect(auction.itemLoreRaw).toBeDefined();
+        expectTypeOf(auction.itemLoreRaw).toEqualTypeOf();
+        expect(auction.rarity).toBeDefined();
+        expectTypeOf(auction.rarity).toEqualTypeOf();
+        expect(auction.startingBid).toBeDefined();
+        expectTypeOf(auction.startingBid).toEqualTypeOf();
+        expect(auction.highestBid).toBeDefined();
+        expectTypeOf(auction.highestBid).toEqualTypeOf();
+        expect(auction.bids).toBeDefined();
+        expectTypeOf(auction.bids).toEqualTypeOf();
+        auction.bids.forEach((bid) => {
+            expect(bid).toBeDefined();
+            expect(bid).toBeInstanceOf(Bid);
+            expectTypeOf(bid).toEqualTypeOf();
+            expect(bid.auctionId).toBeDefined();
+            expectTypeOf(bid.auctionId).toEqualTypeOf();
+            expect(bid.profileId).toBeDefined();
+            expectTypeOf(bid.profileId).toEqualTypeOf();
+            expect(bid.amount).toBeDefined();
+            expect(bid.amount).greaterThanOrEqual(0);
+            expectTypeOf(bid.amount).toEqualTypeOf();
+            expect(bid.timestamp).toBeDefined();
+            expectTypeOf(bid.timestamp).toEqualTypeOf();
+            expect(bid.at).toBeDefined();
+            expectTypeOf(bid.at).toEqualTypeOf();
+            expect(bid.bidder).toBeDefined();
+            expectTypeOf(bid.bidder).toEqualTypeOf();
+            expect(bid.toString()).toBeDefined();
+            expect(bid.toString()).toBe(`${bid.bidder} bid ${bid.amount} coins`);
+            expectTypeOf(bid.toString()).toEqualTypeOf();
+        });
+        expect(auction.claimed).toBeDefined();
+        expectTypeOf(auction.claimed).toEqualTypeOf();
+        expect(auction.claimedBidders).toBeDefined();
+        expectTypeOf(auction.claimedBidders).toEqualTypeOf();
+        expect(auction.toString()).toBeDefined();
+        expect(auction.toString()).toEqual(auction.item);
+        expectTypeOf(auction.toString()).toEqualTypeOf();
+    });
+    client.destroy();
+});
+test('getSkyblockAuction (Profile)', async () => {
+    const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const auctions = await client.getSkyblockAuctions(1);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const data = await client.getSkyblockAuction('profile', auctions.auctions[0].auctioneerProfile);
+    expect(data).toBeDefined();
+    expectTypeOf(data).toEqualTypeOf();
+    expect(data).toBeDefined();
+    expectTypeOf(data).toEqualTypeOf();
+    expect(data.length).greaterThanOrEqual(0);
+    expectTypeOf(data.length).toEqualTypeOf();
+    data.forEach((auction) => {
+        expect(auction).toBeDefined();
+        expect(auction).toBeInstanceOf(Auction);
+        expectTypeOf(auction).toEqualTypeOf();
+        expect(auction.auctionId).toBeDefined();
+        expectTypeOf(auction.auctionId).toEqualTypeOf();
+        expect(auction.auctioneerUuid).toBeDefined();
+        expectTypeOf(auction.auctioneerUuid).toEqualTypeOf();
+        expect(auction.auctioneerProfile).toBeDefined();
+        expectTypeOf(auction.auctioneerProfile).toEqualTypeOf();
+        expect(auction.bin).toBeDefined();
+        expectTypeOf(auction.bin).toEqualTypeOf();
+        expect(auction.itemBytes).toBeDefined();
+        expect(auction.itemBytes).toBeNull();
+        expectTypeOf(auction.itemBytes).toEqualTypeOf();
+        expect(auction.coop).toBeDefined();
+        expectTypeOf(auction.coop).toEqualTypeOf();
+        expect(auction.auctionStartTimestamp).toBeDefined();
+        expect(auction.auctionStartTimestamp).greaterThanOrEqual(0);
+        expectTypeOf(auction.auctionStartTimestamp).toEqualTypeOf();
+        expect(auction.auctionStart).toBeDefined();
+        expectTypeOf(auction.auctionStart).toEqualTypeOf();
+        expect(auction.auctionEndTimestamp).toBeDefined();
+        expectTypeOf(auction.auctionEndTimestamp).toEqualTypeOf();
+        expect(auction.auctionEnd).toBeDefined();
+        expectTypeOf(auction.auctionEnd).toEqualTypeOf();
+        expect(auction.item).toBeDefined();
+        expectTypeOf(auction.item).toEqualTypeOf();
+        expect(auction.itemLore).toBeDefined();
+        expectTypeOf(auction.itemLore).toEqualTypeOf();
+        expect(auction.itemLoreRaw).toBeDefined();
+        expectTypeOf(auction.itemLoreRaw).toEqualTypeOf();
+        expect(auction.rarity).toBeDefined();
+        expectTypeOf(auction.rarity).toEqualTypeOf();
+        expect(auction.startingBid).toBeDefined();
+        expectTypeOf(auction.startingBid).toEqualTypeOf();
+        expect(auction.highestBid).toBeDefined();
+        expectTypeOf(auction.highestBid).toEqualTypeOf();
+        expect(auction.bids).toBeDefined();
+        expectTypeOf(auction.bids).toEqualTypeOf();
+        auction.bids.forEach((bid) => {
+            expect(bid).toBeDefined();
+            expect(bid).toBeInstanceOf(Bid);
+            expectTypeOf(bid).toEqualTypeOf();
+            expect(bid.auctionId).toBeDefined();
+            expectTypeOf(bid.auctionId).toEqualTypeOf();
+            expect(bid.profileId).toBeDefined();
+            expectTypeOf(bid.profileId).toEqualTypeOf();
+            expect(bid.amount).toBeDefined();
+            expect(bid.amount).greaterThanOrEqual(0);
+            expectTypeOf(bid.amount).toEqualTypeOf();
+            expect(bid.timestamp).toBeDefined();
+            expectTypeOf(bid.timestamp).toEqualTypeOf();
+            expect(bid.at).toBeDefined();
+            expectTypeOf(bid.at).toEqualTypeOf();
+            expect(bid.bidder).toBeDefined();
+            expectTypeOf(bid.bidder).toEqualTypeOf();
+            expect(bid.toString()).toBeDefined();
+            expect(bid.toString()).toBe(`${bid.bidder} bid ${bid.amount} coins`);
+            expectTypeOf(bid.toString()).toEqualTypeOf();
+        });
+        expect(auction.claimed).toBeDefined();
+        expectTypeOf(auction.claimed).toEqualTypeOf();
+        expect(auction.claimedBidders).toBeDefined();
+        expectTypeOf(auction.claimedBidders).toEqualTypeOf();
+        expect(auction.toString()).toBeDefined();
+        expect(auction.toString()).toEqual(auction.item);
+        expectTypeOf(auction.toString()).toEqualTypeOf();
+    });
+    client.destroy();
+});
+test('getSkyblockAuction (Include Item Bytes)', async () => {
+    const client = new Client(process.env.HYPIXEL_KEY ?? '', { cache: false, checkForUpdates: false, rateLimit: 'NONE' });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const auctions = await client.getSkyblockAuctions(1);
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    const data = await client.getSkyblockAuction('profile', auctions.auctions[0].auctioneerProfile, {
+        includeItemBytes: true
+    });
+    expect(data).toBeDefined();
+    expectTypeOf(data).toEqualTypeOf();
+    expect(data).toBeDefined();
+    expectTypeOf(data).toEqualTypeOf();
+    expect(data.length).greaterThanOrEqual(0);
+    expectTypeOf(data.length).toEqualTypeOf();
+    data.forEach((auction) => {
+        expect(auction).toBeDefined();
+        expect(auction).toBeInstanceOf(Auction);
+        expectTypeOf(auction).toEqualTypeOf();
+        expect(auction.auctionId).toBeDefined();
+        expectTypeOf(auction.auctionId).toEqualTypeOf();
+        expect(auction.auctioneerUuid).toBeDefined();
+        expectTypeOf(auction.auctioneerUuid).toEqualTypeOf();
+        expect(auction.auctioneerProfile).toBeDefined();
+        expectTypeOf(auction.auctioneerProfile).toEqualTypeOf();
+        expect(auction.bin).toBeDefined();
+        expectTypeOf(auction.bin).toEqualTypeOf();
+        expect(auction.itemBytes).toBeDefined();
+        expectTypeOf(auction.itemBytes).toEqualTypeOf();
+        expect(auction.itemBytes).toBeDefined();
+        if (auction.itemBytes) {
+            expect(auction.itemBytes).instanceOf(ItemBytes);
+            expect(auction.itemBytes.bytesBuffer).toBeDefined();
+            expectTypeOf(auction.itemBytes.bytesBuffer).toEqualTypeOf();
+            expect(auction.itemBytes.base64).toBeDefined();
+            expectTypeOf(auction.itemBytes.base64).toEqualTypeOf();
+            expect(auction.itemBytes.base64()).toBeDefined();
+            expectTypeOf(auction.itemBytes.base64()).toEqualTypeOf();
+        }
+        expect(auction.coop).toBeDefined();
+        expectTypeOf(auction.coop).toEqualTypeOf();
+        expect(auction.auctionStartTimestamp).toBeDefined();
+        expect(auction.auctionStartTimestamp).greaterThanOrEqual(0);
+        expectTypeOf(auction.auctionStartTimestamp).toEqualTypeOf();
+        expect(auction.auctionStart).toBeDefined();
+        expectTypeOf(auction.auctionStart).toEqualTypeOf();
+        expect(auction.auctionEndTimestamp).toBeDefined();
+        expectTypeOf(auction.auctionEndTimestamp).toEqualTypeOf();
+        expect(auction.auctionEnd).toBeDefined();
+        expectTypeOf(auction.auctionEnd).toEqualTypeOf();
+        expect(auction.item).toBeDefined();
+        expectTypeOf(auction.item).toEqualTypeOf();
+        expect(auction.itemLore).toBeDefined();
+        expectTypeOf(auction.itemLore).toEqualTypeOf();
+        expect(auction.itemLoreRaw).toBeDefined();
+        expectTypeOf(auction.itemLoreRaw).toEqualTypeOf();
+        expect(auction.rarity).toBeDefined();
+        expectTypeOf(auction.rarity).toEqualTypeOf();
+        expect(auction.startingBid).toBeDefined();
+        expectTypeOf(auction.startingBid).toEqualTypeOf();
+        expect(auction.highestBid).toBeDefined();
+        expectTypeOf(auction.highestBid).toEqualTypeOf();
+        expect(auction.bids).toBeDefined();
+        expectTypeOf(auction.bids).toEqualTypeOf();
+        auction.bids.forEach((bid) => {
+            expect(bid).toBeDefined();
+            expect(bid).toBeInstanceOf(Bid);
+            expectTypeOf(bid).toEqualTypeOf();
+            expect(bid.auctionId).toBeDefined();
+            expectTypeOf(bid.auctionId).toEqualTypeOf();
+            expect(bid.profileId).toBeDefined();
+            expectTypeOf(bid.profileId).toEqualTypeOf();
+            expect(bid.amount).toBeDefined();
+            expect(bid.amount).greaterThanOrEqual(0);
+            expectTypeOf(bid.amount).toEqualTypeOf();
+            expect(bid.timestamp).toBeDefined();
+            expectTypeOf(bid.timestamp).toEqualTypeOf();
+            expect(bid.at).toBeDefined();
+            expectTypeOf(bid.at).toEqualTypeOf();
+            expect(bid.bidder).toBeDefined();
+            expectTypeOf(bid.bidder).toEqualTypeOf();
+            expect(bid.toString()).toBeDefined();
+            expect(bid.toString()).toBe(`${bid.bidder} bid ${bid.amount} coins`);
+            expectTypeOf(bid.toString()).toEqualTypeOf();
+        });
+        expect(auction.claimed).toBeDefined();
+        expectTypeOf(auction.claimed).toEqualTypeOf();
+        expect(auction.claimedBidders).toBeDefined();
+        expectTypeOf(auction.claimedBidders).toEqualTypeOf();
+        expect(auction.toString()).toBeDefined();
+        expect(auction.toString()).toEqual(auction.item);
+        expectTypeOf(auction.toString()).toEqualTypeOf();
+    });
+    client.destroy();
+});

package/dist/src/API/getSkyblockAuctions.js

@@ -0,0 +1,51 @@
+import Auction from '../structures/SkyBlock/Auctions/Auction';
+import AuctionInfo from '../structures/SkyBlock/Auctions/AuctionInfo';
+import Endpoint from '../Private/Endpoint';
+class getSkyblockAuctions extends Endpoint {
+    client;
+    constructor(client) {
+        super(client);
+        this.client = client;
+    }
+    async execute(query, options) {
+        if (!query)
+            throw new Error(this.client.errors.INVALID_OPTION_VALUE);
+        if ('number' === typeof query && 0 >= query)
+            throw new Error(this.client.errors.INVALID_OPTION_VALUE);
+        if ('number' !== typeof query && '*' !== query)
+            throw new Error(this.client.errors.INVALID_OPTION_VALUE);
+        this.options = this.parseOptions(options);
+        if ('*' === query)
+            return await this.getAllPages();
+        return await this.getPage(query);
+    }
+    async getAllPages() {
+        const page = 0;
+        const { info, auctions } = await this.getPage(page);
+        const pages = info.totalPages;
+        const requests = [];
+        for (let i = 1; i < pages; i++) {
+            requests.push(this.getPage(i));
+        }
+        const results = await Promise.all(requests);
+        results.forEach(({ auctions: newAuctions }) => {
+            auctions.push(...newAuctions);
+        });
+        return { info, auctions };
+    }
+    async getPage(page) {
+        const res = await this.client.requests.request(`/skyblock/auctions?page=${page}`, this.options);
+        return {
+            info: new AuctionInfo(res.data),
+            auctions: res.data.auctions.map((a) => new Auction(a))
+        };
+    }
+    parseOptions(options) {
+        return {
+            includeItemBytes: options?.includeItemBytes ?? false,
+            noCache: options?.noCache ?? false,
+            raw: options?.raw ?? false
+        };
+    }
+}
+export default getSkyblockAuctions;