ps99-api 1.2.0 → 2.0.0

package/src/responses/collection/seed.ts

@@ -0,0 +1,55 @@
+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/src/responses/collection/shovel.ts

@@ -1,18 +1,12 @@
-export type ShovelData = {
-  category: string;
-  collection: "Shovels";
-  configData: ShovelConfigData;
-  configName: string;
-  dateCreated: any;
-  dateModified: any;
-  hash: any;
-};
+import { CollectionData } from "./collection-data";
+
+export type ShovelData = CollectionData<"Shovels", ShovelConfigData>;
 
 export type ShovelConfigData = {
   AssociatedItemID: string;
-  Desc: string;
   DisplayName: string;
+  Model: unknown;
   Icon: string;
-  Model: any;
+  Desc: string;
   MerchantSalePrice?: number;
 };

package/src/responses/collection/sprinkler.ts

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

package/src/responses/collection/ultimate.ts

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

package/src/responses/collection/upgrade.ts

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

package/src/responses/collection/watering-can.ts

@@ -1,18 +1,15 @@
-export type WateringCanData = {
-  category: string;
-  collection: "WateringCans";
-  configData: WateringCanConfigData;
-  configName: string;
-  dateCreated: any;
-  dateModified: any;
-  hash: any;
-};
+import { CollectionData } from "./collection-data";
+
+export type WateringCanData = CollectionData<
+  "WateringCans",
+  WateringCanConfigData
+>;
 
 export type WateringCanConfigData = {
-  AssociatedItemID: string;
   DisplayName: string;
-  Icon: string;
-  Model: any;
+  AssociatedItemID: string;
+  Model: unknown;
   PlantTimeMultiplier: number;
+  Icon: string;
   PlantTimeMultiplierDuration: number;
 };

package/src/responses/collection/world.ts

@@ -1,19 +1,13 @@
-export type WorldData = {
-  category: string;
-  collection: "Worlds";
-  configData: WorldConfigData;
-  configName: string;
-  dateCreated: any;
-  dateModified: any;
-  hash: any;
-};
+import { CollectionData } from "./collection-data";
+
+export type WorldData = CollectionData<"Worlds", WorldConfigData>;
 
 export type WorldConfigData = {
-  FallbackSpawnLocation: any;
-  Lighting: any;
-  MapName: string;
-  PlaceId: number;
   SpawnId: string;
+  FallbackSpawnLocation: unknown;
+  Lighting: unknown;
+  PlaceId: number;
+  MapName: string;
   WorldCurrency: string;
   WorldNumber: number;
   AdditionalMusic?: string[];

package/src/responses/collection/zone-flag.ts

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

package/src/responses/collection/zone.ts

@@ -1,27 +1,21 @@
-export type ZoneData = {
-  category: string;
-  collection: "Zones";
-  configData: ZoneConfigData;
-  configName: string;
-  dateCreated: any;
-  dateModified: any;
-  hash: any;
-};
+import { CollectionData } from "./collection-data";
+
+export type ZoneData = CollectionData<"Zones", ZoneConfigData>;
 
 export type ZoneConfigData = {
+  ZoneName: string;
   Ambience?: ZoneAmbience;
-  Breakables: ZoneBreakables;
+  Price?: number;
   Currency: string;
   GateHealth?: number;
+  ZoneNumber: number;
+  Breakables: ZoneBreakables;
   MaximumAvailableEgg: number;
-  Price?: number;
   WorldNumber: number;
-  ZoneFolder: any;
-  ZoneName: string;
-  ZoneNumber: number;
-  ExtraDropTable: any;
+  ZoneFolder: unknown;
+  ExtraDropTable: unknown;
   Lighting?: ZoneLighting;
-  Chests: any;
+  Chests: unknown;
   RenderAdditionalZones?: number[];
   CannonGroupId?: number;
   QuestsRequired?: ZoneQuestsRequired[];
@@ -33,139 +27,52 @@ export type ZoneAmbience = {
   SoundId: string;
 };
 
-export type ZoneBreakables = {
-  Easy?: ZoneEasy;
-  Main?: ZoneMain;
-  VIP?: ZoneVip;
-  Main_Ice?: ZoneMainIce;
-  Main_Magma?: ZoneMainMagma;
-  HQ?: ZoneHq;
-};
+export type ZoneBreakables = { [key: string]: ZoneDataAndSettings };
 
-export type ZoneEasy = {
-  Data: ZoneEasyDaum[];
-  Settings: ZoneEasySettings;
+export type ZoneDataAndSettings = {
+  Data: ZoneTypeData[];
+  Settings: ZoneSettings;
 };
 
-export type ZoneEasyDaum = {
-  Type: string;
-  Weight: number;
-  WorldNumber: number;
-};
-
-export type ZoneEasySettings = {
-  Maximum: number;
-  RandomDiamondBreakables: boolean;
-  RespawnTime: number;
-};
-
-export type ZoneMain = {
-  Data: ZoneMainDaum[];
-  Settings: ZoneMainSettings;
-};
-
-export type ZoneMainDaum = {
+export type ZoneTypeData = {
   Type: string;
   Weight: number;
   WorldNumber?: number;
   ZoneNumber?: number;
 };
 
-export type ZoneMainSettings = {
+export type ZoneSettings = {
   Maximum: number;
-  RespawnTime: number;
   RandomDiamondBreakables?: boolean;
-};
-
-export type ZoneVip = {
-  Data: ZoneVipDaum[];
-  Settings: ZoneVipSettings;
-};
-
-export type ZoneVipDaum = {
-  Type: string;
-  Weight: number;
-  WorldNumber?: number;
-};
-
-export type ZoneVipSettings = {
-  DaycareIgnore: boolean;
-  Maximum: number;
-  RespawnTime: number;
-};
-
-export type ZoneMainIce = {
-  Data: ZoneMainIceDaum[];
-  Settings: ZoneMainIceSettings;
-};
-
-export type ZoneMainIceDaum = {
-  Type: string;
-  Weight: number;
-  WorldNumber: number;
-};
-
-export type ZoneMainIceSettings = {
-  Maximum: number;
-  RespawnTime: number;
-};
-
-export type ZoneMainMagma = {
-  Data: ZoneMainMagmaDaum[];
-  Settings: ZoneMainMagmaSettings;
-};
-
-export type ZoneMainMagmaDaum = {
-  Type: string;
-  Weight: number;
-  WorldNumber?: number;
-};
-
-export type ZoneMainMagmaSettings = {
-  Maximum: number;
-  RespawnTime: number;
-};
-
-export type ZoneHq = {
-  Data: ZoneHqDaum[];
-  Settings: ZoneHqSettings;
-};
-
-export type ZoneHqDaum = {
-  Type: string;
-  Weight: number;
-};
-
-export type ZoneHqSettings = {
-  Maximum: number;
-  Requirement: any;
   RespawnTime: number;
+  DaycareIgnore?: boolean;
+  Requirement?: unknown;
 };
 
 export type ZoneLighting = {
-  Ambient: any;
+  Ambient: unknown;
   Atmosphere: ZoneAtmosphere;
   Bloom: ZoneBloom;
   Brightness: number;
   ClockTime: number;
   ColorCorrection: ZoneColorCorrection;
-  ColorShift_Bottom: any;
-  ColorShift_Top: any;
+  ColorShift_Bottom: unknown;
+  ColorShift_Top: unknown;
   EnvironmentDiffuseScale: number;
   EnvironmentSpecularScale: number;
   ExposureCompensation: number;
-  FogColor: any;
+  FogColor: unknown;
   FogEnd: number;
   FogStart: number;
   GeographicLatitude: number;
-  OutdoorAmbient: any;
+  OutdoorAmbient: unknown;
   ShadowSoftness: number;
   Sky: ZoneSky;
 };
 
 export type ZoneAtmosphere = {
-  Color: any;
-  Decay: any;
+  Color: unknown;
+  Decay: unknown;
   Density: number;
   Glare: number;
   Haze: number;
@@ -184,7 +91,7 @@ export type ZoneColorCorrection = {
   Contrast: number;
   Enabled: boolean;
   Saturation: number;
-  TintColor: any;
+  TintColor: unknown;
 };
 
 export type ZoneSky = {

package/.release.rc

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