ps99-api 1.1.0 → 2.0.0

package/src/__tests__/ps99-api-changes.ts

@@ -1,36 +1,34 @@
 import { expect, test } from "@jest/globals";
 import { PetSimulator99API } from "../ps99-api";
 
-
 /**
- * It's hard to snapshot these because certain values will always be changing but useful for dump-result checks
+ * It's hard assert these snapshots so .skip em
  */
-describe.skip("Pet Simulator Public Live API Test - Changing Items", () => {
+describe("Pet Simulator Public Live API Test - Changing Items", () => {
   const api = new PetSimulator99API();
 
-  test('Active Clan Battle', async () => {
+  test("Active Clan Battle", async () => {
     const results = await api.getActiveClanBattle();
     expect(results).toMatchSnapshot();
   });
 
-  test('Get Clan', async () => {
-    const results = await api.getClan('MMFC');
+  test("Get Clan", async () => {
+    const results = await api.getClan("MMFC");
     expect(results).toMatchSnapshot();
   });
 
-  test('Get Clans', async () => {
-    const results = await api.getClans({pageSize: 1});
+  test("Get Clans", async () => {
+    const results = await api.getClans({ pageSize: 1 });
     expect(results).toMatchSnapshot();
   });
 
-  test('Get Exists', async () => {
+  test("Get Exists", async () => {
     const results = await api.getExists();
     expect(results).toMatchSnapshot();
   });
 
-  test('Get RAP', async () => {
+  test("Get RAP", async () => {
     const results = await api.getRAP();
     expect(results).toMatchSnapshot();
   });
-
 });

package/src/__tests__/ps99-api-live.ts

@@ -1,177 +1,176 @@
 import { expect, test } from "@jest/globals";
 import { PetSimulator99API } from "../ps99-api";
 
-
 describe("Pet Simulator Public Live API Test", () => {
   const api = new PetSimulator99API();
 
-  test('Collections Have Not Changed', async () => {
+  test("Collections Have Not Changed", async () => {
     const results = await api.getCollections();
     expect(results).toMatchSnapshot();
   });
-  
+
   test("Achievements shape", async () => {
-    const results = await api.getCollection('Achievements');
+    const results = await api.getCollection("Achievements");
     expect(results).toMatchSnapshot();
   });
 
   test("Boosts shape", async () => {
-    const results = await api.getCollection('Boosts');
+    const results = await api.getCollection("Boosts");
     expect(results).toMatchSnapshot();
   });
 
   test("Booths shape", async () => {
-    const results = await api.getCollection('Booths');
+    const results = await api.getCollection("Booths");
     expect(results).toMatchSnapshot();
   });
 
   test("Boxes shape", async () => {
-    const results = await api.getCollection('Boxes');
+    const results = await api.getCollection("Boxes");
     expect(results).toMatchSnapshot();
   });
 
   test("Buffs shape", async () => {
-    const results = await api.getCollection('Buffs');
+    const results = await api.getCollection("Buffs");
     expect(results).toMatchSnapshot();
   });
 
   test("Charms shape", async () => {
-    const results = await api.getCollection('Charms');
+    const results = await api.getCollection("Charms");
     expect(results).toMatchSnapshot();
   });
 
   test("Currency shape", async () => {
-    const results = await api.getCollection('Currency');
+    const results = await api.getCollection("Currency");
     expect(results).toMatchSnapshot();
   });
 
   test("Eggs shape", async () => {
-    const results = await api.getCollection('Eggs');
+    const results = await api.getCollection("Eggs");
     expect(results).toMatchSnapshot();
   });
 
   test("Enchants shape", async () => {
-    const results = await api.getCollection('Enchants');
+    const results = await api.getCollection("Enchants");
     expect(results).toMatchSnapshot();
   });
 
   test("FishingRods shape", async () => {
-    const results = await api.getCollection('FishingRods');
+    const results = await api.getCollection("FishingRods");
     expect(results).toMatchSnapshot();
   });
 
   test("Fruits shape", async () => {
-    const results = await api.getCollection('Fruits');
+    const results = await api.getCollection("Fruits");
     expect(results).toMatchSnapshot();
   });
 
   test("GuildBattles shape", async () => {
-    const results = await api.getCollection('GuildBattles');
+    const results = await api.getCollection("GuildBattles");
     expect(results).toMatchSnapshot();
   });
 
   test("Hoverboards shape", async () => {
-    const results = await api.getCollection('Hoverboards');
+    const results = await api.getCollection("Hoverboards");
     expect(results).toMatchSnapshot();
   });
 
   test("Lootboxes shape", async () => {
-    const results = await api.getCollection('Lootboxes');
+    const results = await api.getCollection("Lootboxes");
     expect(results).toMatchSnapshot();
   });
 
   test("Mastery shape", async () => {
-    const results = await api.getCollection('Mastery');
+    const results = await api.getCollection("Mastery");
     expect(results).toMatchSnapshot();
   });
 
   test("MiscItems shape", async () => {
-    const results = await api.getCollection('MiscItems');
+    const results = await api.getCollection("MiscItems");
     expect(results).toMatchSnapshot();
   });
 
   test("Pets shape", async () => {
-    const results = await api.getCollection('Pets');
+    const results = await api.getCollection("Pets");
     expect(results).toMatchSnapshot();
   });
 
   test("Potions shape", async () => {
-    const results = await api.getCollection('Potions');
+    const results = await api.getCollection("Potions");
     expect(results).toMatchSnapshot();
   });
 
   test("RandomEvents shape", async () => {
-    const results = await api.getCollection('RandomEvents');
+    const results = await api.getCollection("RandomEvents");
     expect(results).toMatchSnapshot();
   });
 
   test("Ranks shape", async () => {
-    const results = await api.getCollection('Ranks');
+    const results = await api.getCollection("Ranks");
     expect(results).toMatchSnapshot();
   });
 
   test("Rarity shape", async () => {
-    const results = await api.getCollection('Rarity');
+    const results = await api.getCollection("Rarity");
     expect(results).toMatchSnapshot();
   });
 
   test("Rebirths shape", async () => {
-    const results = await api.getCollection('Rebirths');
+    const results = await api.getCollection("Rebirths");
     expect(results).toMatchSnapshot();
   });
 
   test("SecretRooms shape", async () => {
-    const results = await api.getCollection('SecretRooms');
+    const results = await api.getCollection("SecretRooms");
     expect(results).toMatchSnapshot();
   });
 
   test("Seeds shape", async () => {
-    const results = await api.getCollection('Seeds');
+    const results = await api.getCollection("Seeds");
     expect(results).toMatchSnapshot();
   });
 
   test("Shovels shape", async () => {
-    const results = await api.getCollection('Shovels');
+    const results = await api.getCollection("Shovels");
     expect(results).toMatchSnapshot();
   });
 
   test("Sprinklers shape", async () => {
-    const results = await api.getCollection('Sprinklers');
+    const results = await api.getCollection("Sprinklers");
     expect(results).toMatchSnapshot();
   });
 
   test("Ultimates shape", async () => {
-    const results = await api.getCollection('Ultimates');
+    const results = await api.getCollection("Ultimates");
     expect(results).toMatchSnapshot();
   });
 
   test("Upgrades shape", async () => {
-    const results = await api.getCollection('Upgrades');
+    const results = await api.getCollection("Upgrades");
     expect(results).toMatchSnapshot();
   });
 
   test("WateringCans shape", async () => {
-    const results = await api.getCollection('WateringCans');
+    const results = await api.getCollection("WateringCans");
     expect(results).toMatchSnapshot();
   });
 
   test("Worlds shape", async () => {
-    const results = await api.getCollection('Worlds');
+    const results = await api.getCollection("Worlds");
     expect(results).toMatchSnapshot();
   });
 
   test("ZoneFlags shape", async () => {
-    const results = await api.getCollection('ZoneFlags');
+    const results = await api.getCollection("ZoneFlags");
     expect(results).toMatchSnapshot();
   });
 
   test("Zones shape", async () => {
-    const results = await api.getCollection('Zones');
+    const results = await api.getCollection("Zones");
     expect(results).toMatchSnapshot();
   });
 
   test("Merchants shape", async () => {
-    const results = await api.getCollection('Merchants');
+    const results = await api.getCollection("Merchants");
     expect(results).toMatchSnapshot();
   });
 });

package/src/__tests__/ps99-api.ts

@@ -145,7 +145,7 @@ describe("Pet Simulator Public API Tests", () => {
       params: {},
       responseEncoding: "BINARY",
       responseType: "arraybuffer",
-      url: "https://biggamesapi.io/api/image/14615650278",
+      url: "https://biggamesapi.io/image/14615650278",
     });
     await api.getImage("rbxassetid://14976576332");
     expect(axios).toBeCalledWith({
@@ -153,7 +153,7 @@ describe("Pet Simulator Public API Tests", () => {
       params: {},
       responseEncoding: "BINARY",
       responseType: "arraybuffer",
-      url: "https://biggamesapi.io/api/image/14976576332",
+      url: "https://biggamesapi.io/image/14976576332",
     });
   });
 });

package/src/index.ts

@@ -1,7 +1,6 @@
 export * from "./ps99-api";
 export * from "./request-client/common";
 export * from "./request-client/axios";
-export * from "./responses/collections";
 export * from "./responses/clan";
 export * from "./responses/clans";
 export * from "./params/clans";
@@ -9,3 +8,36 @@ export * from "./responses/exists";
 export * from "./responses/rap";
 export * from "./responses/activeClanBattle";
 export * from "./responses/collection";
+export * from "./responses/collection/achievement";
+export * from "./responses/collection/boost";
+export * from "./responses/collection/booth";
+export * from "./responses/collection/box";
+export * from "./responses/collection/buff";
+export * from "./responses/collection/charm";
+export * from "./responses/collection/currency";
+export * from "./responses/collection/egg";
+export * from "./responses/collection/enchantment";
+export * from "./responses/collection/fishing-rod";
+export * from "./responses/collection/fruit";
+export * from "./responses/collection/guild-battle";
+export * from "./responses/collection/hoverboard";
+export * from "./responses/collection/lootbox";
+export * from "./responses/collection/mastery";
+export * from "./responses/collection/merchant";
+export * from "./responses/collection/misc-item";
+export * from "./responses/collection/pet";
+export * from "./responses/collection/potion";
+export * from "./responses/collection/random-event";
+export * from "./responses/collection/rank";
+export * from "./responses/collection/rarity";
+export * from "./responses/collection/rebirth";
+export * from "./responses/collection/secret-room";
+export * from "./responses/collection/seed";
+export * from "./responses/collection/shovel";
+export * from "./responses/collection/sprinkler";
+export * from "./responses/collection/ultimate";
+export * from "./responses/collection/upgrade";
+export * from "./responses/collection/watering-can";
+export * from "./responses/collection/world";
+export * from "./responses/collection/zone-flag";
+export * from "./responses/collection/zone";

package/src/ps99-api.ts

@@ -1,7 +1,6 @@
 import { ApiRequestParams, RequestClient } from "./request-client/common";
 import { getAxiosRequest } from "./request-client/axios";
-import { CollectionsResponseBody } from "./responses/collections";
-import {Collection, GetCollectionResponse} from "./responses/collection";
+import {Collection, CollectionName} from "./responses/collection";
 import { ClanResponseBody } from "./responses/clan";
 import { ClansResponseBody } from "./responses/clans";
 import { ClansSort, GetClansParams, SortOrder } from "./params/clans";
@@ -12,6 +11,11 @@ import { ActiveClanBattleResponseBody } from "./responses/activeClanBattle";
 export type PetSimulator99APIOptions = {
   requestClient?: RequestClient;
 };
+
+export type ApiResponseBody<T> =
+  | { status: "ok"; data: T }
+  | { status: "error"; error: { message: string; ignore: boolean } };
+
 export class PetSimulator99API {
   public requestClient: RequestClient;
 
@@ -49,12 +53,12 @@ export class PetSimulator99API {
   }
 
   getCollections() {
-    return this.request<CollectionsResponseBody>("/api/collections");
+    return this.request<ApiResponseBody<CollectionName[]>>("/api/collections");
   }
 
-  getCollection<C extends Collection>(collection: C) {
-    return this.request<GetCollectionResponse<C>>(
-      `/api/collection/${collection}`,
+  getCollection<C extends CollectionName>(collectionName: C) {
+    return this.request<ApiResponseBody<Collection<C>[]>>(
+      `/api/collection/${collectionName}`,
     );
   }
 
@@ -72,15 +76,17 @@ export class PetSimulator99API {
       sort: sort || "Points",
       sortOrder: sortOrder || "desc",
     };
-    return this.request<ClansResponseBody>("/api/clans", { params });
+    return this.request<ApiResponseBody<ClansResponseBody>>("/api/clans", {
+      params,
+    });
   }
 
   getClan(name: string) {
-    return this.request<ClanResponseBody>(`/api/clan/${name}`);
+    return this.request<ApiResponseBody<ClanResponseBody>>(`/api/clan/${name}`);
   }
 
   getExists() {
-    return this.request<ExistsResponseBody>(`/api/exists`);
+    return this.request<ApiResponseBody<ExistsResponseBody>>(`/api/exists`);
   }
 
   getRAP() {
@@ -88,14 +94,17 @@ export class PetSimulator99API {
   }
 
   getActiveClanBattle() {
-    return this.request<ActiveClanBattleResponseBody>(`/api/activeClanBattle`);
+    return this.request<ApiResponseBody<ActiveClanBattleResponseBody>>(
+      `/api/activeClanBattle`,
+    );
   }
 
-  getImage(rbxassetid: string) {
+  /** resolve rbxassetid:// references to image/png */
+  getImage(rbxassetid: string): Promise<Blob> {
     if (rbxassetid.startsWith("rbxassetid://")) {
       rbxassetid = rbxassetid.slice(13);
     }
-    return this.request<Blob>(`/api/image/${rbxassetid}`, {
+    return this.request<Blob>(`/image/${rbxassetid}`, {
       responseType: "arraybuffer",
       responseEncoding: "BINARY",
     });

package/src/responses/activeClanBattle.ts

@@ -1,43 +1,43 @@
 export type ActiveBattleData = {
-  _id: string
-  category: string
-  configData: ActiveBattleConfigData
-  configName: string
-}
+  _id: string;
+  category: string;
+  configData: ActiveBattleConfigData;
+  configName: string;
+};
 
 export type ActiveBattleConfigData = {
-  FinishTime: number
-  PlacementRewards: ActiveBattlePlacementReward[]
-  Rewards: ActiveBattleRewards
-  StartTime: number
-  Title: string
-  _id: string
-  _script: any
-}
+  FinishTime: number;
+  PlacementRewards: ActiveBattlePlacementReward[];
+  Rewards: ActiveBattleRewards;
+  StartTime: number;
+  Title: string;
+  _id: string;
+  _script: any;
+};
 
 export type ActiveBattlePlacementReward = {
-  Best: number
-  Item: ActiveBattleItem
-  Worst: number
-}
+  Best: number;
+  Item: ActiveBattleItem;
+  Worst: number;
+};
 
 export type ActiveBattleItem = {
-  _data: ActiveBattleItemData
-}
+  _data: ActiveBattleItemData;
+};
 
 export type ActiveBattleItemData = {
-  id: string
-  pt?: number
-}
+  id: string;
+  pt?: number;
+};
 
 export type ActiveBattleRewards = {
-  Bronze: any[]
-  Gold: any[]
-  Good: any[]
-  Silver: any[]
-}
+  Bronze: any[];
+  Gold: any[];
+  Good: any[];
+  Silver: any[];
+};
 
 export type ActiveClanBattleResponseBody = {
-  status: string
-  data: ActiveBattleData
-}
+  status: string;
+  data: ActiveBattleData;
+};

package/src/responses/clan.ts

@@ -1,91 +1,91 @@
 export type ClanResponseBody = {
-  Battles: Battles
-  BronzeMedals: number
-  CountryCode: string
-  Created: number
-  DepositedDiamonds: number
-  Desc: string
-  DiamondContributions: DiamondContributions
-  GoodMedals: number
-  GuildLevel: number
-  Icon: string
-  LastKickTimestamp: number
-  MemberCapacity: number
-  Members: Member[]
-  Name: string
-  OfficerCapacity: number
-  Owner: number
-  SilverMedals: number
-  Status: string
-  StatusTimestamp: number
-  StatusUsername: string
-}
+  Battles: Battles;
+  BronzeMedals: number;
+  CountryCode: string;
+  Created: number;
+  DepositedDiamonds: number;
+  Desc: string;
+  DiamondContributions: DiamondContributions;
+  GoodMedals: number;
+  GuildLevel: number;
+  /** use {@link PetSimulator99API.getImage} to get an image blob **/
+  Icon: string;
+  LastKickTimestamp: number;
+  MemberCapacity: number;
+  Members: Member[];
+  Name: string;
+  OfficerCapacity: number;
+  Owner: number;
+  SilverMedals: number;
+  Status: string;
+  StatusTimestamp: number;
+  StatusUsername: string;
+};
 
-export type Battles = {[key: string]: PointsBattle | GoalBattle}
+export type Battles = { [key: string]: PointsBattle | GoalBattle };
 
 export type PointsBattle = {
-  AwardUserIDs: number[]
-  BattleID: string
-  EarnedMedal?: string
-  Place?: number
-  PointContributions: PointContribution[]
-  Points: number
-  ProcessedAwards: boolean
-}
+  AwardUserIDs: number[];
+  BattleID: string;
+  EarnedMedal?: string;
+  Place?: number;
+  PointContributions: PointContribution[];
+  Points: number;
+  ProcessedAwards: boolean;
+};
 
 export type PointContribution = {
-  Points: number
-  UserID: number
-}
+  Points: number;
+  UserID: number;
+};
 
 export type GoalBattle = {
-  AwardUserIDs: any[]
-  BattleID: string
-  EarnedMedal?: string
-  Goals: Goal[]
-  Place?: number
-  PointContributions: PointContribution[]
-  Points: number
-  ProcessedAwards: boolean
-}
+  AwardUserIDs: any[];
+  BattleID: string;
+  EarnedMedal?: string;
+  Goals: Goal[];
+  Place?: number;
+  PointContributions: PointContribution[];
+  Points: number;
+  ProcessedAwards: boolean;
+};
 
 export type Goal = {
-  Amount: number
-  Contributions: Contributions
-  Progress: number
-  Stars: number
-  Tier: number
-  Type: number
-}
+  Amount: number;
+  Contributions: Contributions;
+  Progress: number;
+  Stars: number;
+  Tier: number;
+  Type: number;
+};
 
-export type Contributions = {[key: string]: number}
+export type Contributions = { [key: string]: number };
 
 export type HackerBattle = {
-  AwardUserIDs: any[]
-  BattleID: string
-  Place: number
-  PointContributions: PointContribution[]
-  Points: number
-  ProcessedAwards: boolean
-}
-
+  AwardUserIDs: any[];
+  BattleID: string;
+  Place: number;
+  PointContributions: PointContribution[];
+  Points: number;
+  ProcessedAwards: boolean;
+};
 
 export type DiamondContributions = {
-  AllTime: AllTime
-}
+  AllTime: AllTime;
+};
 
 export type AllTime = {
-  Data: Daum[]
-  Sum: number
-}
+  Data: Daum[];
+  Sum: number;
+};
 
 export type Daum = {
-  Diamonds: number
-  UserID: number
-}
+  Diamonds: number;
+  UserID: number;
+};
 
 export type Member = {
-  JoinTime: number
-  PermissionLevel: number
-  UserID: number
-}
+  JoinTime: number;
+  PermissionLevel: number;
+  UserID: number;
+};

package/src/responses/clans.ts

@@ -1,13 +1,13 @@
 export type ClansData = {
-  CountryCode: string
-  Created: number
-  DepositedDiamonds: number
-  Icon: string
-  MemberCapacity: number
-  Members: number
-  Name: string
-  Points: number
-}
+  CountryCode: string;
+  Created: number;
+  DepositedDiamonds: number;
+  Icon: string;
+  MemberCapacity: number;
+  Members: number;
+  Name: string;
+  Points: number;
+};
 
 export type ClansResponseBody = {
   status: string;