ps99-api 1.1.0 → 2.0.0

package/dist/responses/collection/random-event.d.ts

@@ -0,0 +1,21 @@
+import { CollectionData } from "./collection-data";
+export type RandomEventData = CollectionData<"RandomEvents", RandomEventConfigData>;
+export type RandomEventConfigData = {
+    AllowInZones: boolean;
+    Color: string;
+    Duration: number;
+    Icon: string;
+    BreakingRequirement: number;
+    PlaytimeRequirement: number;
+    Name: string;
+    AllowInInstances: boolean;
+    Chance: number;
+    AreaWhitelist: RandomEventAreaWhitelist;
+    AllowMultiple: boolean;
+    MinimumZone?: number;
+};
+export type RandomEventAreaWhitelist = {
+    Main_Magma: boolean;
+    Main: boolean;
+    Main_Ice: boolean;
+};

package/dist/responses/collection/random-event.js

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

package/dist/responses/collection/random-event.js.map

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

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

@@ -0,0 +1,36 @@
+import { CollectionData } from "./collection-data";
+export type RankData = CollectionData<"Ranks", RankConfigData>;
+export type RankConfigData = {
+    Goals: RankGoal[][];
+    MaxEnchantsEquipped: number;
+    MaximumActiveGoals: number;
+    RankNumber: number;
+    Rewards: RankReward[];
+    Title: string;
+    UnlockableEggSlots: number;
+    UnlockablePetSlots: number;
+    RankUpRewards?: RankRewardItem[];
+    RequiredRebirth?: number;
+    RequiredZone?: string;
+};
+export type RankGoal = {
+    Amount: number;
+    Type: number;
+    Weight: number;
+    CurrencyID?: string;
+    BreakableType?: string;
+    PotionTier?: number;
+    EnchantTier?: number;
+};
+export type RankReward = {
+    Item: RankRewardItem;
+    StarsRequired: number;
+};
+export type RankRewardItem = {
+    _data: RankRewardItemData;
+};
+export type RankRewardItemData = {
+    _am?: number;
+    id: string;
+    tn?: number;
+};

package/dist/responses/collection/rank.js

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

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

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

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

@@ -0,0 +1,12 @@
+import { CollectionData } from "./collection-data";
+export type RarityData = CollectionData<"Rarity", RarityConfigData>;
+export type RarityConfigData = {
+    Announce: boolean;
+    Color: string;
+    DisplayName: string;
+    Gradient: unknown;
+    ItemSlot: unknown;
+    Lootbag: unknown;
+    Message: unknown;
+    RarityNumber: number;
+};

package/dist/responses/collection/rarity.js

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

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

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

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

@@ -0,0 +1,19 @@
+import { CollectionData } from "./collection-data";
+export type RebirthData = CollectionData<"Rebirths", RebirthConfigData>;
+export type RebirthConfigData = {
+    BoostDesc: string;
+    DisplayName: string;
+    ItemRewards: unknown;
+    RebirthNumber: number;
+    RebirthUnlocks: RebirthUnlock[];
+    StrengthPowerBoost: number;
+    ZoneNumberRequired: number;
+    RebirthCallback: unknown;
+    ResetZone?: string;
+};
+export type RebirthUnlock = {
+    Desc: string;
+    Icon: string;
+    Title: string;
+    GuiTitle?: string;
+};

package/dist/responses/collection/rebirth.js

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

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

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

package/dist/responses/collection/secret-room.d.ts

@@ -0,0 +1,9 @@
+import { CollectionData } from "./collection-data";
+export type SecretRoomData = CollectionData<"SecretRooms", SecretRoomConfigData>;
+export type SecretRoomConfigData = {
+    UnlockAnimation: unknown;
+    InstanceId: string;
+    CloseDoor: unknown;
+    RequiredZone: string;
+    DisplayName: string;
+};

package/dist/responses/collection/secret-room.js

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

package/dist/responses/collection/secret-room.js.map

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

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

@@ -0,0 +1,47 @@
+import { CollectionData } from "./collection-data";
+export type SeedData = CollectionData<"Seeds", SeedConfigData>;
+export type SeedConfigData = {
+    Rarity: SeedRarity;
+    DisplayName: string;
+    Stages: any[];
+    LootTable: LootTableRoot[] | LootTableRoot;
+    Desc: string;
+    GrowTime: number;
+    Icon: string;
+};
+export type SeedRarity = {
+    RarityNumber: number;
+    Lootbag: unknown;
+    _id: string;
+    Color: unknown;
+    DisplayName: string;
+    Message: unknown;
+    ItemSlot: unknown;
+    Gradient: unknown;
+    Announce: boolean;
+    _script: unknown;
+};
+export type LootTableRoot = {
+    _caches: any[];
+    entries: LootTableEntry[];
+};
+export interface LootTableEntry {
+    Value: LootTableValue;
+    Amount?: number;
+    Weight: number;
+}
+export interface LootTableValue {
+    _caches?: any[];
+    entries?: LootTableValue[];
+    _data?: LootTableData;
+    _stackKey?: RawStackKey;
+    _exactStackKey?: RawStackKey;
+    _maxAmount?: number;
+}
+/** use {@link JSON.parse} to parse into object of type {@link LootTableData} */
+export type RawStackKey = string;
+export interface LootTableData {
+    id: string;
+    tn?: number;
+    _am?: number;
+}

package/dist/responses/collection/seed.js

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

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

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

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

@@ -0,0 +1,10 @@
+import { CollectionData } from "./collection-data";
+export type ShovelData = CollectionData<"Shovels", ShovelConfigData>;
+export type ShovelConfigData = {
+    AssociatedItemID: string;
+    DisplayName: string;
+    Model: unknown;
+    Icon: string;
+    Desc: string;
+    MerchantSalePrice?: number;
+};

package/dist/responses/collection/shovel.js

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

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

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

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

@@ -0,0 +1,23 @@
+import { CollectionData } from "./collection-data";
+export type SprinklerData = CollectionData<"Sprinklers", SprinklerConfigData>;
+export type SprinklerConfigData = {
+    Rarity: SprinklerRarity;
+    Color: string;
+    Duration: number;
+    Desc: string;
+    Name: string;
+    Model: unknown;
+    Icon: string;
+};
+export type SprinklerRarity = {
+    RarityNumber: number;
+    Lootbag: unknown;
+    _id: string;
+    Color: unknown;
+    DisplayName: string;
+    Message: unknown;
+    ItemSlot: unknown;
+    Gradient: unknown;
+    Announce: boolean;
+    _script: unknown;
+};

package/dist/responses/collection/sprinkler.js

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

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

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

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

@@ -0,0 +1,28 @@
+import { CollectionData } from "./collection-data";
+export type UltimateData = CollectionData<"Ultimates", UltimateConfigData>;
+export type UltimateConfigData = {
+    Rarity: UltimateRarity;
+    TierToLevel: number[];
+    DisplayName: string;
+    LevelToTier: number[];
+    Desc: string;
+    Icon: string;
+    MaxTier: number;
+    Cooldown: unknown;
+    FFlagName: string;
+    Tradable?: boolean;
+    ProductId?: number;
+    NotAllowedInInstances?: boolean;
+};
+export type UltimateRarity = {
+    RarityNumber: number;
+    Lootbag: unknown;
+    _id: string;
+    Color: unknown;
+    DisplayName: string;
+    Message: unknown;
+    ItemSlot: unknown;
+    Gradient: unknown;
+    Announce: boolean;
+    _script: unknown;
+};

package/dist/responses/collection/ultimate.js

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

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

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

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

@@ -0,0 +1,51 @@
+import { CollectionData } from "./collection-data";
+export type UpgradeData = CollectionData<"Upgrades", UpgradeConfigData>;
+export type UpgradeConfigData = {
+    RewardText: unknown;
+    TierPowers: number[];
+    Icon: string;
+    TierCurrencies: UpgradeTierCurrency[];
+    TierCosts: number[];
+};
+export type UpgradeTierCurrency = {
+    Rarity: UpgradeRarity;
+    Tradable: boolean;
+    Tiers: UpgradeTier[];
+    DisplayName: string;
+    _script: unknown;
+    _index: number;
+    _id: string;
+    MaxAmount: number;
+    BagTiers: UpgradeBagTier[];
+    Desc: string;
+};
+export type UpgradeBagTier = {
+    value: number;
+    image: string;
+};
+export type UpgradeRarity = {
+    RarityNumber: number;
+    Lootbag: unknown;
+    _id: string;
+    Color: unknown;
+    DisplayName: string;
+    Message: unknown;
+    ItemSlot: unknown;
+    Gradient: unknown;
+    Announce: boolean;
+    _script: unknown;
+};
+export type UpgradeTier = {
+    orbImage: string;
+    imageOutline: string;
+    isBottom: boolean;
+    Order: number;
+    rainData: UpgradeRainData;
+    value: number;
+    tinyImage: string;
+    tierName: string;
+    textColor: unknown;
+};
+export type UpgradeRainData = {
+    LightEmission: number;
+};

package/dist/responses/collection/upgrade.js

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

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

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

package/dist/responses/collection/watering-can.d.ts

@@ -0,0 +1,10 @@
+import { CollectionData } from "./collection-data";
+export type WateringCanData = CollectionData<"WateringCans", WateringCanConfigData>;
+export type WateringCanConfigData = {
+    DisplayName: string;
+    AssociatedItemID: string;
+    Model: unknown;
+    PlantTimeMultiplier: number;
+    Icon: string;
+    PlantTimeMultiplierDuration: number;
+};

package/dist/responses/collection/watering-can.js

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

package/dist/responses/collection/watering-can.js.map

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

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

@@ -0,0 +1,12 @@
+import { CollectionData } from "./collection-data";
+export type WorldData = CollectionData<"Worlds", WorldConfigData>;
+export type WorldConfigData = {
+    SpawnId: string;
+    FallbackSpawnLocation: unknown;
+    Lighting: unknown;
+    PlaceId: number;
+    MapName: string;
+    WorldCurrency: string;
+    WorldNumber: number;
+    AdditionalMusic?: string[];
+};

package/dist/responses/collection/world.js

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

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

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

package/dist/responses/collection/zone-flag.d.ts

@@ -0,0 +1,23 @@
+import { CollectionData } from "./collection-data";
+export type ZoneFlagData = CollectionData<"ZoneFlags", ZoneFlagConfigData>;
+export type ZoneFlagConfigData = {
+    Rarity: ZoneFlagRarity;
+    Color: string;
+    Duration: number;
+    Desc: string;
+    Name: string;
+    Model: unknown;
+    Icon: string;
+};
+export type ZoneFlagRarity = {
+    RarityNumber: number;
+    Lootbag: unknown;
+    _id: string;
+    Color: unknown;
+    DisplayName: string;
+    Message: unknown;
+    ItemSlot: unknown;
+    Gradient: unknown;
+    Announce: boolean;
+    _script: unknown;
+};

package/dist/responses/collection/zone-flag.js

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

package/dist/responses/collection/zone-flag.js.map

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

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

@@ -0,0 +1,104 @@
+import { CollectionData } from "./collection-data";
+export type ZoneData = CollectionData<"Zones", ZoneConfigData>;
+export type ZoneConfigData = {
+    ZoneName: string;
+    Ambience?: ZoneAmbience;
+    Price?: number;
+    Currency: string;
+    GateHealth?: number;
+    ZoneNumber: number;
+    Breakables: ZoneBreakables;
+    MaximumAvailableEgg: number;
+    WorldNumber: number;
+    ZoneFolder: unknown;
+    ExtraDropTable: unknown;
+    Lighting?: ZoneLighting;
+    Chests: unknown;
+    RenderAdditionalZones?: number[];
+    CannonGroupId?: number;
+    QuestsRequired?: ZoneQuestsRequired[];
+    LinkedOwnership?: string;
+    TeleportToZoneOnFall?: boolean;
+};
+export type ZoneAmbience = {
+    SoundId: string;
+};
+export type ZoneBreakables = {
+    [key: string]: ZoneDataAndSettings;
+};
+export type ZoneDataAndSettings = {
+    Data: ZoneTypeData[];
+    Settings: ZoneSettings;
+};
+export type ZoneTypeData = {
+    Type: string;
+    Weight: number;
+    WorldNumber?: number;
+    ZoneNumber?: number;
+};
+export type ZoneSettings = {
+    Maximum: number;
+    RandomDiamondBreakables?: boolean;
+    RespawnTime: number;
+    DaycareIgnore?: boolean;
+    Requirement?: unknown;
+};
+export type ZoneLighting = {
+    Ambient: unknown;
+    Atmosphere: ZoneAtmosphere;
+    Bloom: ZoneBloom;
+    Brightness: number;
+    ClockTime: number;
+    ColorCorrection: ZoneColorCorrection;
+    ColorShift_Bottom: unknown;
+    ColorShift_Top: unknown;
+    EnvironmentDiffuseScale: number;
+    EnvironmentSpecularScale: number;
+    ExposureCompensation: number;
+    FogColor: unknown;
+    FogEnd: number;
+    FogStart: number;
+    GeographicLatitude: number;
+    OutdoorAmbient: unknown;
+    ShadowSoftness: number;
+    Sky: ZoneSky;
+};
+export type ZoneAtmosphere = {
+    Color: unknown;
+    Decay: unknown;
+    Density: number;
+    Glare: number;
+    Haze: number;
+    Offset: number;
+};
+export type ZoneBloom = {
+    Enabled: boolean;
+    Intensity: number;
+    Size: number;
+    Threshold: number;
+};
+export type ZoneColorCorrection = {
+    Brightness: number;
+    Contrast: number;
+    Enabled: boolean;
+    Saturation: number;
+    TintColor: unknown;
+};
+export type ZoneSky = {
+    CelestialBodiesShown: boolean;
+    MoonAngularSize: number;
+    MoonTextureId: string;
+    SkyboxBk: string;
+    SkyboxDn: string;
+    SkyboxFt: string;
+    SkyboxLf: string;
+    SkyboxRt: string;
+    SkyboxUp: string;
+    StarCount: number;
+    SunAngularSize: number;
+    SunTextureId: string;
+};
+export type ZoneQuestsRequired = {
+    Amount: number;
+    Type: number;
+};

package/dist/responses/collection/zone.js

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

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

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

package/dump-result.js

@@ -2,8 +2,20 @@
  * convert a snapshot result to friendly json and then update interface via
  * https://transform.tools/json-to-typescript
  */
-let dumpResult =
-    []
 
-const fs = require('fs');
-fs.writeFileSync('out.json', JSON.stringify(dumpResult, null, 2));
+const { PetSimulator99API } = require("./dist/ps99-api");
+const api = new PetSimulator99API();
+api.getCollections().then(async (response) => {
+  if (response.status === "ok") {
+    const collections = response.data;
+    for await (const [c, collection] of collections.map((c) =>
+      api.getCollection(c).then((_c) => [c, _c]),
+    )) {
+      const fs = require("fs");
+      fs.writeFileSync(
+        `dist/out-${c}.json`,
+        JSON.stringify(collection, null, 2),
+      );
+    }
+  }
+});