ps99-api 1.1.0 → 2.0.0

package/.github/actions/test/action.yml

@@ -1,7 +1,7 @@
-name: 'Test'
-description: 'Test the library'
+name: "Test"
+description: "Test the library"
 runs:
-  using: 'composite'
+  using: "composite"
   steps:
     - name: Checkout
       uses: actions/checkout@v4

package/.github/workflows/release-on-main.yml

@@ -5,7 +5,6 @@ on:
     branches:
       - main
 
-
 permissions:
   contents: write # to be able to publish a GitHub release
   issues: write # to be able to comment on released issues

package/.github/workflows/test-on-branch.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
   push:
     branches:
-      - '!main'
+      - "!main"
 
 jobs:
   release:

package/.idea/runConfigurations/test.xml

@@ -0,0 +1,11 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="test" type="JavaScriptTestRunnerJest">
+    <node-interpreter value="project" />
+    <jest-package value="$PROJECT_DIR$/node_modules/jest" />
+    <working-dir value="$PROJECT_DIR$" />
+    <jest-options value="--testPathIgnorePatterns ps99-api-changes.ts" />
+    <envs />
+    <scope-kind value="ALL" />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/test_changing.xml

@@ -0,0 +1,11 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="test:changing" type="JavaScriptTestRunnerJest">
+    <node-interpreter value="project" />
+    <jest-package value="$PROJECT_DIR$/node_modules/jest" />
+    <working-dir value="$PROJECT_DIR$" />
+    <envs />
+    <scope-kind value="TEST_FILE" />
+    <test-file value="src/__tests__/ps99-api-changes.ts" />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/test_snapshot.xml

@@ -0,0 +1,11 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="test:snapshot" type="JavaScriptTestRunnerJest">
+    <node-interpreter value="project" />
+    <jest-package value="$PROJECT_DIR$/node_modules/jest" />
+    <working-dir value="$PROJECT_DIR$" />
+    <jest-options value="--testPathIgnorePatterns ps99-api-changes.ts --updateSnapshot " />
+    <envs />
+    <scope-kind value="ALL" />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/runConfigurations/test_snapshot_changing.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="test:snapshot-changing" type="JavaScriptTestRunnerJest">
+    <node-interpreter value="project" />
+    <jest-package value="$PROJECT_DIR$/node_modules/jest" />
+    <working-dir value="$PROJECT_DIR$" />
+    <jest-options value="--updateSnapshot" />
+    <envs />
+    <scope-kind value="TEST_FILE" />
+    <test-file value="$PROJECT_DIR$/src/__tests__/ps99-api-changes.ts" />
+    <method v="2" />
+  </configuration>
+</component>

package/.idea/webResources.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="WebResourcesPaths">
+    <contentEntries>
+      <entry url="file://$PROJECT_DIR$">
+        <entryData>
+          <resourceRoots>
+            <path value="file://$PROJECT_DIR$/example-web/react2/public" />
+          </resourceRoots>
+        </entryData>
+      </entry>
+    </contentEntries>
+  </component>
+</project>

package/.releaserc

@@ -0,0 +1,13 @@
+{
+    "branches": ["main"],
+    "plugins": [
+        [
+            "@semantic-release/commit-analyzer",
+            {
+                "preset": "conventionalcommits"
+            }
+        ],
+        "@semantic-release/npm",
+        "@semantic-release/git"
+    ]
+}

package/README.md

@@ -9,10 +9,10 @@ Pet Simulator Public API wrapper written in Typescript.
 ## Usage
 
 ```typescript
-import {PetSimulator99API} from 'ps99-api';
+import { PetSimulator99API } from "ps99-api";
 
-const ps99api = new PetSimulator99API()
-await ps99api.getClan('CAT');
+const ps99api = new PetSimulator99API();
+await ps99api.getClan("CAT");
 ```
 
 ## Notes
@@ -21,6 +21,5 @@ await ps99api.getClan('CAT');
 
 ## Links
 
-
-* [ps99-public-api-docs](https://github.com/BIG-Games-LLC/ps99-public-api-docs)
-* [Pet Simulator Public API](https://docs.biggamesapi.io/)
+- [ps99-public-api-docs](https://github.com/BIG-Games-LLC/ps99-public-api-docs)
+- [Pet Simulator Public API](https://docs.biggamesapi.io/)

package/dist/index.d.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/dist/index.js

@@ -17,7 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ps99-api"), exports);
 __exportStar(require("./request-client/common"), exports);
 __exportStar(require("./request-client/axios"), exports);
-__exportStar(require("./responses/collections"), exports);
 __exportStar(require("./responses/clan"), exports);
 __exportStar(require("./responses/clans"), exports);
 __exportStar(require("./params/clans"), exports);
@@ -25,4 +24,37 @@ __exportStar(require("./responses/exists"), exports);
 __exportStar(require("./responses/rap"), exports);
 __exportStar(require("./responses/activeClanBattle"), exports);
 __exportStar(require("./responses/collection"), exports);
+__exportStar(require("./responses/collection/achievement"), exports);
+__exportStar(require("./responses/collection/boost"), exports);
+__exportStar(require("./responses/collection/booth"), exports);
+__exportStar(require("./responses/collection/box"), exports);
+__exportStar(require("./responses/collection/buff"), exports);
+__exportStar(require("./responses/collection/charm"), exports);
+__exportStar(require("./responses/collection/currency"), exports);
+__exportStar(require("./responses/collection/egg"), exports);
+__exportStar(require("./responses/collection/enchantment"), exports);
+__exportStar(require("./responses/collection/fishing-rod"), exports);
+__exportStar(require("./responses/collection/fruit"), exports);
+__exportStar(require("./responses/collection/guild-battle"), exports);
+__exportStar(require("./responses/collection/hoverboard"), exports);
+__exportStar(require("./responses/collection/lootbox"), exports);
+__exportStar(require("./responses/collection/mastery"), exports);
+__exportStar(require("./responses/collection/merchant"), exports);
+__exportStar(require("./responses/collection/misc-item"), exports);
+__exportStar(require("./responses/collection/pet"), exports);
+__exportStar(require("./responses/collection/potion"), exports);
+__exportStar(require("./responses/collection/random-event"), exports);
+__exportStar(require("./responses/collection/rank"), exports);
+__exportStar(require("./responses/collection/rarity"), exports);
+__exportStar(require("./responses/collection/rebirth"), exports);
+__exportStar(require("./responses/collection/secret-room"), exports);
+__exportStar(require("./responses/collection/seed"), exports);
+__exportStar(require("./responses/collection/shovel"), exports);
+__exportStar(require("./responses/collection/sprinkler"), exports);
+__exportStar(require("./responses/collection/ultimate"), exports);
+__exportStar(require("./responses/collection/upgrade"), exports);
+__exportStar(require("./responses/collection/watering-can"), exports);
+__exportStar(require("./responses/collection/world"), exports);
+__exportStar(require("./responses/collection/zone-flag"), exports);
+__exportStar(require("./responses/collection/zone"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,0DAAwC;AACxC,yDAAuC;AACvC,0DAAwC;AACxC,mDAAiC;AACjC,oDAAkC;AAClC,iDAA+B;AAC/B,qDAAmC;AACnC,kDAAgC;AAChC,+DAA6C;AAC7C,yDAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,0DAAwC;AACxC,yDAAuC;AACvC,mDAAiC;AACjC,oDAAkC;AAClC,iDAA+B;AAC/B,qDAAmC;AACnC,kDAAgC;AAChC,+DAA6C;AAC7C,yDAAuC;AACvC,qEAAmD;AACnD,+DAA6C;AAC7C,+DAA6C;AAC7C,6DAA2C;AAC3C,8DAA4C;AAC5C,+DAA6C;AAC7C,kEAAgD;AAChD,6DAA2C;AAC3C,qEAAmD;AACnD,qEAAmD;AACnD,+DAA6C;AAC7C,sEAAoD;AACpD,oEAAkD;AAClD,iEAA+C;AAC/C,iEAA+C;AAC/C,kEAAgD;AAChD,mEAAiD;AACjD,6DAA2C;AAC3C,gEAA8C;AAC9C,sEAAoD;AACpD,8DAA4C;AAC5C,gEAA8C;AAC9C,iEAA+C;AAC/C,qEAAmD;AACnD,8DAA4C;AAC5C,gEAA8C;AAC9C,mEAAiD;AACjD,kEAAgD;AAChD,iEAA+C;AAC/C,sEAAoD;AACpD,+DAA6C;AAC7C,mEAAiD;AACjD,8DAA4C"}

package/dist/ps99-api.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" />
 import { RequestClient } from "./request-client/common";
-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 { GetClansParams } from "./params/clans";
@@ -11,16 +10,27 @@ 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 declare class PetSimulator99API {
     requestClient: RequestClient;
     constructor(params?: PetSimulator99APIOptions);
     private request;
-    getCollections(): Promise<CollectionsResponseBody>;
-    getCollection<C extends Collection>(collection: C): Promise<GetCollectionResponse<C>>;
-    getClans(params?: GetClansParams): Promise<ClansResponseBody>;
-    getClan(name: string): Promise<ClanResponseBody>;
-    getExists(): Promise<ExistsResponseBody>;
+    getCollections(): Promise<ApiResponseBody<("Achievements" | "Boosts" | "Booths" | "Boxes" | "Buffs" | "Charms" | "Currency" | "Eggs" | "Enchants" | "FishingRods" | "Fruits" | "GuildBattles" | "Hoverboards" | "Lootboxes" | "Mastery" | "Merchants" | "MiscItems" | "Pets" | "Potions" | "RandomEvents" | "Ranks" | "Rarity" | "Rebirths" | "Seeds" | "SecretRooms" | "Shovels" | "Sprinklers" | "Ultimates" | "Upgrades" | "WateringCans" | "Worlds" | "ZoneFlags" | "Zones")[]>>;
+    getCollection<C extends CollectionName>(collectionName: C): Promise<ApiResponseBody<Collection<C>[]>>;
+    getClans(params?: GetClansParams): Promise<ApiResponseBody<ClansResponseBody>>;
+    getClan(name: string): Promise<ApiResponseBody<ClanResponseBody>>;
+    getExists(): Promise<ApiResponseBody<ExistsResponseBody>>;
     getRAP(): Promise<RAPResponseBody>;
-    getActiveClanBattle(): Promise<ActiveClanBattleResponseBody>;
+    getActiveClanBattle(): Promise<ApiResponseBody<ActiveClanBattleResponseBody>>;
+    /** resolve rbxassetid:// references to image/png */
     getImage(rbxassetid: string): Promise<Blob>;
 }

package/dist/ps99-api.js

@@ -27,8 +27,8 @@ class PetSimulator99API {
     getCollections() {
         return this.request("/api/collections");
     }
-    getCollection(collection) {
-        return this.request(`/api/collection/${collection}`);
+    getCollection(collectionName) {
+        return this.request(`/api/collection/${collectionName}`);
     }
     getClans(params) {
         let page;
@@ -44,7 +44,9 @@ class PetSimulator99API {
             sort: sort || "Points",
             sortOrder: sortOrder || "desc",
         };
-        return this.request("/api/clans", { params });
+        return this.request("/api/clans", {
+            params,
+        });
     }
     getClan(name) {
         return this.request(`/api/clan/${name}`);
@@ -58,11 +60,12 @@ class PetSimulator99API {
     getActiveClanBattle() {
         return this.request(`/api/activeClanBattle`);
     }
+    /** resolve rbxassetid:// references to image/png */
     getImage(rbxassetid) {
         if (rbxassetid.startsWith("rbxassetid://")) {
             rbxassetid = rbxassetid.slice(13);
         }
-        return this.request(`/api/image/${rbxassetid}`, {
+        return this.request(`/image/${rbxassetid}`, {
             responseType: "arraybuffer",
             responseEncoding: "BINARY",
         });

package/dist/ps99-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"ps99-api.js","sourceRoot":"","sources":["../src/ps99-api.ts"],"names":[],"mappings":";;;AACA,kDAAyD;AAazD,MAAa,iBAAiB;IACrB,aAAa,CAAgB;IAEpC,YAAY,MAAiC;QAC3C,IAAI,CAAC,aAAa;YAChB,MAAM,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,uBAAe,GAAE,CAAC;IAC9E,CAAC;IAEO,OAAO,CACb,IAAY,EACZ,EACE,MAAM,EACN,YAAY,EACZ,gBAAgB,MAKd;QACF,MAAM,EAAE,EAAE;QACV,YAAY,EAAE,MAAM;QACpB,gBAAgB,EAAE,MAAM;KACzB;QAED,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QACtB,YAAY,GAAG,YAAY,IAAI,MAAM,CAAC;QACtC,gBAAgB,GAAG,gBAAgB,IAAI,MAAM,CAAC;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAI;YAChC,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,yBAAyB,IAAI,EAAE;YACpC,MAAM;YACN,YAAY;YACZ,gBAAgB;SACjB,CAAC,CAAC;IACL,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,OAAO,CAA0B,kBAAkB,CAAC,CAAC;IACnE,CAAC;IAED,aAAa,CAAuB,UAAa;QAC/C,OAAO,IAAI,CAAC,OAAO,CACjB,mBAAmB,UAAU,EAAE,CAChC,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,MAAuB;QAC9B,IAAI,IAAwB,CAAC;QAC7B,IAAI,QAA4B,CAAC;QACjC,IAAI,IAA2B,CAAC;QAChC,IAAI,SAAgC,CAAC;QACrC,IAAI,MAAM,EAAE,CAAC;YACX,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,GAAG;YACP,IAAI,EAAE,IAAI,IAAI,CAAC;YACf,QAAQ,EAAE,QAAQ,IAAI,EAAE;YACxB,IAAI,EAAE,IAAI,IAAI,QAAQ;YACtB,SAAS,EAAE,SAAS,IAAI,MAAM;SAC/B,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAoB,YAAY,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,OAAO,CAAmB,aAAa,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAqB,aAAa,CAAC,CAAC;IACzD,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAkB,UAAU,CAAC,CAAC;IACnD,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,OAAO,CAA+B,uBAAuB,CAAC,CAAC;IAC7E,CAAC;IAED,QAAQ,CAAC,UAAkB;QACzB,IAAI,UAAU,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YAC3C,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAO,cAAc,UAAU,EAAE,EAAE;YACpD,YAAY,EAAE,aAAa;YAC3B,gBAAgB,EAAE,QAAQ;SAC3B,CAAC,CAAC;IACL,CAAC;CACF;AAxFD,8CAwFC"}
+{"version":3,"file":"ps99-api.js","sourceRoot":"","sources":["../src/ps99-api.ts"],"names":[],"mappings":";;;AACA,kDAAyD;AAiBzD,MAAa,iBAAiB;IACrB,aAAa,CAAgB;IAEpC,YAAY,MAAiC;QAC3C,IAAI,CAAC,aAAa;YAChB,MAAM,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,uBAAe,GAAE,CAAC;IAC9E,CAAC;IAEO,OAAO,CACb,IAAY,EACZ,EACE,MAAM,EACN,YAAY,EACZ,gBAAgB,MAKd;QACF,MAAM,EAAE,EAAE;QACV,YAAY,EAAE,MAAM;QACpB,gBAAgB,EAAE,MAAM;KACzB;QAED,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;QACtB,YAAY,GAAG,YAAY,IAAI,MAAM,CAAC;QACtC,gBAAgB,GAAG,gBAAgB,IAAI,MAAM,CAAC;QAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAI;YAChC,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,yBAAyB,IAAI,EAAE;YACpC,MAAM;YACN,YAAY;YACZ,gBAAgB;SACjB,CAAC,CAAC;IACL,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,OAAO,CAAoC,kBAAkB,CAAC,CAAC;IAC7E,CAAC;IAED,aAAa,CAA2B,cAAiB;QACvD,OAAO,IAAI,CAAC,OAAO,CACjB,mBAAmB,cAAc,EAAE,CACpC,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,MAAuB;QAC9B,IAAI,IAAwB,CAAC;QAC7B,IAAI,QAA4B,CAAC;QACjC,IAAI,IAA2B,CAAC;QAChC,IAAI,SAAgC,CAAC;QACrC,IAAI,MAAM,EAAE,CAAC;YACX,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,GAAG;YACP,IAAI,EAAE,IAAI,IAAI,CAAC;YACf,QAAQ,EAAE,QAAQ,IAAI,EAAE;YACxB,IAAI,EAAE,IAAI,IAAI,QAAQ;YACtB,SAAS,EAAE,SAAS,IAAI,MAAM;SAC/B,CAAC;QACF,OAAO,IAAI,CAAC,OAAO,CAAqC,YAAY,EAAE;YACpE,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,OAAO,CAAoC,aAAa,IAAI,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAsC,aAAa,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAkB,UAAU,CAAC,CAAC;IACnD,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,OAAO,CACjB,uBAAuB,CACxB,CAAC;IACJ,CAAC;IAED,oDAAoD;IACpD,QAAQ,CAAC,UAAkB;QACzB,IAAI,UAAU,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YAC3C,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAO,UAAU,UAAU,EAAE,EAAE;YAChD,YAAY,EAAE,aAAa;YAC3B,gBAAgB,EAAE,QAAQ;SAC3B,CAAC,CAAC;IACL,CAAC;CACF;AA7FD,8CA6FC"}

package/dist/responses/clan.d.ts

@@ -8,6 +8,7 @@ export type ClanResponseBody = {
     DiamondContributions: DiamondContributions;
     GoodMedals: number;
     GuildLevel: number;
+    /** use {@link PetSimulator99API.getImage} to get an image blob **/
     Icon: string;
     LastKickTimestamp: number;
     MemberCapacity: number;

package/dist/responses/collection/achievement.d.ts

@@ -0,0 +1,32 @@
+import { CollectionData } from "./collection-data";
+export type AchievementData = CollectionData<"Achievements", AchievementConfigData>;
+export type AchievementConfigData = {
+    Icon: string;
+    Name: string;
+    Tiers: AchievementTier[];
+};
+export type AchievementTier = {
+    Amount: number;
+    Desc: string;
+    Difficulty: AchievementDifficulty;
+    Hidden: boolean;
+    Rewards: AchievementReward[];
+    Title: string;
+    ManuallyNotify?: number;
+};
+export type AchievementDifficulty = {
+    Name: string;
+    Order: number;
+};
+export type AchievementReward = {
+    Reward: AchievementRewardItem;
+};
+export type AchievementRewardItem = {
+    _data: AchievementRewardData;
+};
+export type AchievementRewardData = {
+    id: string;
+    tn?: number;
+    _am?: number;
+    pt?: number;
+};

package/dist/responses/{collections.js → collection/achievement.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=collections.js.map
+//# sourceMappingURL=achievement.js.map

package/dist/responses/collection/achievement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"achievement.js","sourceRoot":"","sources":["../../../src/responses/collection/achievement.ts"],"names":[],"mappings":""}

package/dist/responses/collection/boost.d.ts

@@ -0,0 +1,7 @@
+import { CollectionData } from "./collection-data";
+export type BoostData = CollectionData<"Boosts", BoostConfigData, "Boosts", "Boost | Friends">;
+export type BoostConfigData = {
+    DisplayName: string;
+    Icon: string;
+    MaximumPercent: number;
+};

package/dist/responses/{collection.js → collection/boost.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=collection.js.map
+//# sourceMappingURL=boost.js.map

package/dist/responses/collection/boost.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boost.js","sourceRoot":"","sources":["../../../src/responses/collection/boost.ts"],"names":[],"mappings":""}

package/dist/responses/collection/booth.d.ts

@@ -0,0 +1,29 @@
+import { CollectionData } from "./collection-data";
+export type BoothData = CollectionData<"Booths", BoothConfigData, "Booths">;
+export type BoothConfigData = {
+    DisplayName: string;
+    Rarity: BoothRarity;
+    Model: unknown;
+    Icon: string;
+    Desc: string;
+    Hidden?: boolean;
+    Tradable?: boolean;
+    Callback: unknown;
+    OffSale?: boolean;
+    ProductId?: number;
+    DiamondPrice?: number;
+    Sittable?: boolean;
+    RenderStepped: unknown;
+};
+export type BoothRarity = {
+    RarityNumber: number;
+    Lootbag: unknown;
+    _id: string;
+    Color: unknown;
+    DisplayName: string;
+    Message: unknown;
+    ItemSlot: unknown;
+    Gradient: unknown;
+    Announce: boolean;
+    _script: unknown;
+};

package/dist/responses/collection/booth.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=booth.js.map

package/dist/responses/collection/booth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"booth.js","sourceRoot":"","sources":["../../../src/responses/collection/booth.ts"],"names":[],"mappings":""}

package/dist/responses/collection/box.d.ts

@@ -0,0 +1,26 @@
+import { CollectionData } from "./collection-data";
+export type BoxData = CollectionData<"Boxes", BoxConfigData, "Boxes">;
+export type BoxConfigData = {
+    Rarity: BoxRarity;
+    Capacity: number;
+    DisplayName: string;
+    Icons: BoxIcon[];
+    Desc: string;
+};
+export type BoxIcon = {
+    Color: unknown;
+    Name: string;
+    Icon: string;
+};
+export type BoxRarity = {
+    RarityNumber: number;
+    Lootbag: unknown;
+    _id: string;
+    Color: unknown;
+    DisplayName: string;
+    Message: unknown;
+    ItemSlot: unknown;
+    Gradient: unknown;
+    Announce: boolean;
+    _script: unknown;
+};

package/dist/responses/collection/box.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=box.js.map

package/dist/responses/collection/box.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"box.js","sourceRoot":"","sources":["../../../src/responses/collection/box.ts"],"names":[],"mappings":""}

package/dist/responses/collection/buff.d.ts

@@ -0,0 +1,9 @@
+import { CollectionData } from "./collection-data";
+export type BuffData = CollectionData<"Buffs", BuffConfigData, "BuffData">;
+export type BuffConfigData = {
+    AssociatedItemClass: string;
+    AssociatedItemID: string;
+    DisplayName: string;
+    Length: number;
+    IgnoreInstancePause?: boolean;
+};

package/dist/responses/collection/buff.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=buff.js.map

package/dist/responses/collection/buff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"buff.js","sourceRoot":"","sources":["../../../src/responses/collection/buff.ts"],"names":[],"mappings":""}

package/dist/responses/collection/charm.d.ts

@@ -0,0 +1,28 @@
+import { CollectionData } from "./collection-data";
+export type CharmData = CollectionData<"Charms", CharmConfigData, "Charms">;
+export type CharmConfigData = {
+    BaseTier: number;
+    Tiers: CharmTier[];
+    MaxTier: number;
+    Icon: string;
+    DiminishPowerThreshold?: number;
+    Unique?: boolean;
+};
+export type CharmTier = {
+    Desc: string;
+    DisplayName: string;
+    Rarity: CharmRarity;
+    Power: number;
+};
+export type CharmRarity = {
+    RarityNumber: number;
+    Lootbag: unknown;
+    _id: string;
+    Color: unknown;
+    DisplayName: string;
+    Message: unknown;
+    ItemSlot: unknown;
+    Gradient: unknown;
+    Announce: boolean;
+    _script: unknown;
+};

package/dist/responses/collection/charm.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=charm.js.map

package/dist/responses/collection/charm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"charm.js","sourceRoot":"","sources":["../../../src/responses/collection/charm.ts"],"names":[],"mappings":""}

package/dist/responses/collection/collection-data.d.ts

@@ -0,0 +1,9 @@
+export type CollectionData<Collection, ConfigData, Category = string, ConfigName = string> = {
+    category: Category;
+    collection: Collection;
+    configData: ConfigData;
+    configName: ConfigName;
+    dateCreated: unknown;
+    dateModified: unknown;
+    hash: unknown;
+};

package/dist/responses/collection/collection-data.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=collection-data.js.map

package/dist/responses/collection/collection-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-data.js","sourceRoot":"","sources":["../../../src/responses/collection/collection-data.ts"],"names":[],"mappings":""}

package/dist/responses/collection/currency.d.ts

@@ -0,0 +1,44 @@
+import { CollectionData } from "./collection-data";
+export type CurrencyData = CollectionData<"Currency", CurrencyConfigData, "Currency">;
+export type CurrencyConfigData = {
+    Rarity: CurrencyRarity;
+    Tradable: boolean;
+    Tiers: CurrencyTier[];
+    DisplayName: string;
+    _index: number;
+    IsWorldCurrency?: boolean;
+    Desc: string;
+    BagTiers?: CurrencyBagTier[];
+    MaxAmount: number;
+    PermitAutoLootScaling?: boolean;
+};
+export type CurrencyBagTier = {
+    value: number;
+    image: string;
+};
+export type CurrencyRarity = {
+    RarityNumber: number;
+    Lootbag: unknown;
+    _id: string;
+    Color: unknown;
+    DisplayName: string;
+    Message: unknown;
+    ItemSlot: unknown;
+    Gradient: unknown;
+    Announce: boolean;
+    _script: unknown;
+};
+export type CurrencyTier = {
+    orbImage: string;
+    imageOutline: string;
+    isBottom?: boolean;
+    Order: number;
+    rainData?: CurrencyRainData;
+    value: number;
+    tinyImage: string;
+    tierName: string;
+    textColor: unknown;
+};
+export type CurrencyRainData = {
+    LightEmission: number;
+};

package/dist/responses/collection/currency.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=currency.js.map

package/dist/responses/collection/currency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"currency.js","sourceRoot":"","sources":["../../../src/responses/collection/currency.ts"],"names":[],"mappings":""}