ps99-api 2.3.3 → 2.4.0

package/.idea/node-ps99-api.iml

@@ -5,6 +5,7 @@
       <excludeFolder url="file://$MODULE_DIR$/.tmp" />
       <excludeFolder url="file://$MODULE_DIR$/temp" />
       <excludeFolder url="file://$MODULE_DIR$/tmp" />
+      <excludeFolder url="file://$MODULE_DIR$/dist" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />

package/README.md

@@ -1,7 +1,7 @@
 # ps99-api
 
 [![npm version](https://badge.fury.io/js/ps99-api.svg)](https://badge.fury.io/js/ps99-api)
-![Website](https://img.shields.io/website?url=https%3A%2F%2Fjoekiller.github.io%2Fnode-ps99-api)
+[![Website](https://img.shields.io/website?url=https%3A%2F%2Fjoekiller.github.io%2Fnode-ps99-api)](https://joekiller.github.io/node-ps99-api/)
 
 Pet Simulator Public API wrapper written in Typescript.
 

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

@@ -26,7 +26,9 @@ export type AchievementRewardItem = {
 };
 export type AchievementRewardData = {
     id: string;
+    /** potions: enchants, etc: tn is tier number */
     tn?: number;
     _am?: number;
+    /** For pets: pt=1 is golden, p2=2 is rainbow */
     pt?: number;
 };

package/dist/responses/collection/guild-battle.d.ts

@@ -18,13 +18,11 @@ export type GuildBattleItem = {
 };
 export type GuildBattleItemData = {
     id: string;
+    /** For pets: pt=1 is golden, p2=2 is rainbow */
     pt?: number;
 };
 export type GuildBattleRewards = {
-    Bronze: GuildBattleRewardItem[];
-    Gold: GuildBattleRewardItem[];
-    Good?: GuildBattleRewardItem[];
-    Silver: GuildBattleRewardItem[];
+    [key: string]: GuildBattleRewardItem[];
 };
 export type GuildBattleRewardItem = {
     _data: GuildBattleRewardItemData;

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

@@ -32,5 +32,6 @@ export type RankRewardItem = {
 export type RankRewardItemData = {
     _am?: number;
     id: string;
+    /** For potions: enchants, etc: tn is tier number */
     tn?: number;
 };

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

@@ -42,6 +42,7 @@ export interface LootTableValue {
 export type RawStackKey = string;
 export interface LootTableData {
     id: string;
+    /** For potions: enchants, etc: tn is tier number */
     tn?: number;
     _am?: number;
 }

package/dist/responses/exists.d.ts

@@ -5,7 +5,9 @@ export type ExistsData = {
 };
 export type ExistsConfigData = {
     id: string;
+    /** for pets pt=1 is golden, p2=2 is rainbow */
     pt?: number;
+    /** for pets sh is shiny */
     sh?: boolean;
 };
 export type ExistsResponseBody = {

package/example-web/react2/src/components/AchievementsComponent.tsx

@@ -1,40 +1,33 @@
 import React from "react";
 import { CollectionConfigData } from "ps99-api";
-import { GenericFetchComponent } from "./GenericFetchComponent";
 import ImageComponent from "./ImageComponent";
 
 const AchievementsComponent: React.FC<{
-  configData?: CollectionConfigData<"Achievements">;
+  configData: CollectionConfigData<"Achievements">;
 }> = ({ configData }) => {
   return (
-    <GenericFetchComponent<CollectionConfigData<"Achievements">>
-      collectionName="Achievements"
-      configData={configData}
-      render={(data) => (
-        <div>
-          <h2>{data.Name}</h2>
-          <ImageComponent src={data.Icon} alt={data.Name} />
-          <ul>
-            {data.Tiers.map((tier, index) => (
-              <li key={index}>
-                <h3>{tier.Title}</h3>
-                <p>{tier.Desc.replace("{amount}", tier.Amount.toString())}</p>
-                <p>Difficulty: {tier.Difficulty.Name}</p>
-                <p>Amount: {tier.Amount}</p>
-                <ul>
-                  {tier.Rewards.map((reward, rewardIndex) => (
-                    <li key={rewardIndex}>
-                      Reward ID: {reward.Reward._data.id} Amount:{" "}
-                      {reward.Reward._data._am}
-                    </li>
-                  ))}
-                </ul>
-              </li>
-            ))}
-          </ul>
-        </div>
-      )}
-    />
+    <div>
+      <h2>{configData.Name}</h2>
+      <ImageComponent src={configData.Icon} alt={configData.Name} />
+      <ul>
+        {configData.Tiers.map((tier, index) => (
+          <li key={index}>
+            <h3>{tier.Title}</h3>
+            <p>{tier.Desc.replace("{amount}", tier.Amount.toString())}</p>
+            <p>Difficulty: {tier.Difficulty.Name}</p>
+            <p>Amount: {tier.Amount}</p>
+            <ul>
+              {tier.Rewards.map((reward, rewardIndex) => (
+                <li key={rewardIndex}>
+                  Reward ID: {reward.Reward._data.id} Amount:{" "}
+                  {reward.Reward._data._am}
+                </li>
+              ))}
+            </ul>
+          </li>
+        ))}
+      </ul>
+    </div>
   );
 };
 

package/example-web/react2/src/components/BoostsComponent.tsx

@@ -1,23 +1,16 @@
 import React from "react";
 import { CollectionConfigData } from "ps99-api";
-import { GenericFetchComponent } from "./GenericFetchComponent";
 import ImageComponent from "./ImageComponent";
 
 const BoostsComponent: React.FC<{
-  configData?: CollectionConfigData<"Boosts">;
+  configData: CollectionConfigData<"Boosts">;
 }> = ({ configData }) => {
   return (
-    <GenericFetchComponent<CollectionConfigData<"Boosts">>
-      collectionName="Boosts"
-      configData={configData}
-      render={(data) => (
-        <div>
-          <h2>{data.DisplayName}</h2>
-          <ImageComponent src={data.Icon} alt={data.DisplayName} />
-          <p>Maximum Percent: {data.MaximumPercent}%</p>
-        </div>
-      )}
-    />
+    <div>
+      <h2>{configData.DisplayName}</h2>
+      <ImageComponent src={configData.Icon} alt={configData.DisplayName} />
+      <p>Maximum Percent: {configData.MaximumPercent}%</p>
+    </div>
   );
 };
 

package/example-web/react2/src/components/BoothsComponent.tsx

@@ -1,31 +1,63 @@
 import React from "react";
 import { CollectionConfigData } from "ps99-api";
-import { GenericFetchComponent } from "./GenericFetchComponent";
 import ImageComponent from "./ImageComponent";
 
 const BoothsComponent: React.FC<{
-  configData?: CollectionConfigData<"Booths">;
+  configData: CollectionConfigData<"Booths">;
 }> = ({ configData }) => {
   return (
-    <GenericFetchComponent<CollectionConfigData<"Booths">>
-      collectionName="Booths"
-      configData={configData}
-      render={(data) => (
-        <div>
-          <h2>{data.DisplayName}</h2>
-          <ImageComponent src={data.Icon} alt={data.DisplayName} />
-          <p>Description: {data.Desc}</p>
-          <p>Rarity: {data.Rarity.DisplayName}</p>
-          <p>Rarity Number: {data.Rarity.RarityNumber}</p>
-          {data.Hidden && <p>Hidden: Yes</p>}
-          {data.Tradable && <p>Tradable: Yes</p>}
-          {data.OffSale && <p>Off Sale: Yes</p>}
-          {data.ProductId && <p>Product ID: {data.ProductId}</p>}
-          {data.DiamondPrice && <p>Diamond Price: {data.DiamondPrice}</p>}
-          {data.Sittable && <p>Sittable: Yes</p>}
-        </div>
+    <div
+      style={{
+        padding: "1em",
+        border: "1px solid #ccc",
+        borderRadius: "8px",
+        backgroundColor: "#f9f9f9",
+      }}
+    >
+      <h2 style={{ borderBottom: "2px solid #ccc", paddingBottom: "0.5em" }}>
+        {configData.DisplayName}
+      </h2>
+      <ImageComponent src={configData.Icon} alt={configData.DisplayName} />
+      <p>
+        <strong>Description:</strong> {configData.Desc}
+      </p>
+      <p>
+        <strong>Rarity:</strong> {configData.Rarity.DisplayName}
+      </p>
+      <p>
+        <strong>Rarity Number:</strong> {configData.Rarity.RarityNumber}
+      </p>
+      {configData.Hidden && (
+        <p>
+          <strong>Hidden:</strong> Yes
+        </p>
       )}
-    />
+      {configData.Tradable && (
+        <p>
+          <strong>Tradable:</strong> Yes
+        </p>
+      )}
+      {configData.OffSale && (
+        <p>
+          <strong>Off Sale:</strong> Yes
+        </p>
+      )}
+      {configData.ProductId && (
+        <p>
+          <strong>Product ID:</strong> {configData.ProductId}
+        </p>
+      )}
+      {configData.DiamondPrice && (
+        <p>
+          <strong>Diamond Price:</strong> {configData.DiamondPrice}
+        </p>
+      )}
+      {configData.Sittable && (
+        <p>
+          <strong>Sittable:</strong> Yes
+        </p>
+      )}
+    </div>
   );
 };
 

package/example-web/react2/src/components/BoxesComponent.tsx

@@ -1,34 +1,27 @@
 import React from "react";
 import { CollectionConfigData } from "ps99-api";
-import { GenericFetchComponent } from "./GenericFetchComponent";
 import ImageComponent from "./ImageComponent";
 
 const BoxesComponent: React.FC<{
-  configData?: CollectionConfigData<"Boxes">;
+  configData: CollectionConfigData<"Boxes">;
 }> = ({ configData }) => {
   return (
-    <GenericFetchComponent<CollectionConfigData<"Boxes">>
-      collectionName="Boxes"
-      configData={configData}
-      render={(data) => (
-        <div>
-          <h2>{data.DisplayName}</h2>
-          <p>Description: {data.Desc}</p>
-          <p>Capacity: {data.Capacity}</p>
-          <p>Rarity: {data.Rarity.DisplayName}</p>
-          <p>Rarity Number: {data.Rarity.RarityNumber}</p>
-          <h3>Icons:</h3>
-          <ul>
-            {data.Icons.map((icon, index) => (
-              <li key={index}>
-                <ImageComponent src={icon.Icon} alt={icon.Name} />
-                <span>{icon.Name}</span>
-              </li>
-            ))}
-          </ul>
-        </div>
-      )}
-    />
+    <div>
+      <h2>{configData.DisplayName}</h2>
+      <p>Description: {configData.Desc}</p>
+      <p>Capacity: {configData.Capacity}</p>
+      <p>Rarity: {configData.Rarity.DisplayName}</p>
+      <p>Rarity Number: {configData.Rarity.RarityNumber}</p>
+      <h3>Icons:</h3>
+      <ul>
+        {configData.Icons.map((icon, index) => (
+          <li key={index}>
+            <ImageComponent src={icon.Icon} alt={icon.Name} />
+            <span>{icon.Name}</span>
+          </li>
+        ))}
+      </ul>
+    </div>
   );
 };
 

package/example-web/react2/src/components/BuffsComponent.tsx

@@ -1,24 +1,46 @@
 import React from "react";
 import { CollectionConfigData } from "ps99-api";
-import { GenericFetchComponent } from "./GenericFetchComponent";
+import DynamicCollectionConfigData from "./DynamicCollectionConfigData";
 
 const BuffsComponent: React.FC<{
-  configData?: CollectionConfigData<"Buffs">;
+  configData: CollectionConfigData<"Buffs">;
 }> = ({ configData }) => {
   return (
-    <GenericFetchComponent<CollectionConfigData<"Buffs">>
-      collectionName="Buffs"
-      configData={configData}
-      render={(data) => (
-        <div>
-          <h2>{data.DisplayName}</h2>
-          <p>Associated Item ID: {data.AssociatedItemID}</p>
-          <p>Associated Item Class: {data.AssociatedItemClass}</p>
-          <p>Length: {data.Length} seconds</p>
-          {data.IgnoreInstancePause && <p>Ignore Instance Pause: Yes</p>}
+    <div
+      style={{
+        padding: "1em",
+        border: "1px solid #ccc",
+        borderRadius: "8px",
+        marginBottom: "2em",
+      }}
+    >
+      <h2 style={{ borderBottom: "2px solid #ccc", paddingBottom: "0.5em" }}>
+        {configData.DisplayName}
+      </h2>
+      <p>
+        <strong>Associated Item ID:</strong> {configData.AssociatedItemID}
+      </p>
+      <p>
+        <strong>Associated Item Class:</strong> {configData.AssociatedItemClass}
+      </p>
+      <p>
+        <strong>Length:</strong> {configData.Length} seconds
+      </p>
+      {configData.IgnoreInstancePause && (
+        <p>
+          <strong>Ignore Instance Pause:</strong> Yes
+        </p>
+      )}
+      {configData.AssociatedItemClass === "Misc" && (
+        <div style={{ marginTop: "2em" }}>
+          <h3>Associated Misc Item</h3>
+          <DynamicCollectionConfigData
+            collectionName="MiscItems"
+            configName={configData.AssociatedItemID}
+          />
         </div>
       )}
-    />
+    </div>
   );
 };
 

package/example-web/react2/src/components/CharmsComponent.tsx

@@ -1,41 +1,36 @@
 import React from "react";
 import { CollectionConfigData } from "ps99-api";
-import { GenericFetchComponent } from "./GenericFetchComponent";
 import ImageComponent from "./ImageComponent";
 
 const CharmsComponent: React.FC<{
-  configData?: CollectionConfigData<"Charms">;
+  configData: CollectionConfigData<"Charms">;
 }> = ({ configData }) => {
   return (
-    <GenericFetchComponent<CollectionConfigData<"Charms">>
-      collectionName="Charms"
-      configData={configData}
-      render={(data) => (
-        <div>
-          <h2>{data.Tiers[0].DisplayName}</h2>
-          <ImageComponent src={data.Icon} alt={data.Tiers[0].DisplayName} />
-          <p>Base Tier: {data.BaseTier}</p>
-          <p>Max Tier: {data.MaxTier}</p>
-          {data.DiminishPowerThreshold && (
-            <p>Diminish Power Threshold: {data.DiminishPowerThreshold}</p>
-          )}
-          {data.Unique && <p>Unique: Yes</p>}
-          <h3>Tiers:</h3>
-          <ul>
-            {data.Tiers.map((tier, index) => (
-              <li key={index}>
-                <p>{tier.DisplayName}</p>
-                <p>Description: {tier.Desc}</p>
-                <p>Power: {tier.Power}</p>
-                <p>Rarity: {tier.Rarity.DisplayName}</p>
-                <p>Rarity Number: {tier.Rarity.RarityNumber}</p>
-              </li>
-            ))}
-          </ul>
-        </div>
+    <div>
+      <h2>{configData.Tiers[0].DisplayName}</h2>
+      <ImageComponent
+        src={configData.Icon}
+        alt={configData.Tiers[0].DisplayName}
+      />
+      <p>Base Tier: {configData.BaseTier}</p>
+      <p>Max Tier: {configData.MaxTier}</p>
+      {configData.DiminishPowerThreshold && (
+        <p>Diminish Power Threshold: {configData.DiminishPowerThreshold}</p>
       )}
-    />
+      {configData.Unique && <p>Unique: Yes</p>}
+      <h3>Tiers:</h3>
+      <ul>
+        {configData.Tiers.map((tier, index) => (
+          <li key={index}>
+            <p>{tier.DisplayName}</p>
+            <p>Description: {tier.Desc}</p>
+            <p>Power: {tier.Power}</p>
+            <p>Rarity: {tier.Rarity.DisplayName}</p>
+            <p>Rarity Number: {tier.Rarity.RarityNumber}</p>
+          </li>
+        ))}
+      </ul>
+    </div>
   );
 };
-
 export default CharmsComponent;

package/example-web/react2/src/components/CurrencyComponent.tsx

@@ -1,64 +1,57 @@
 import React from "react";
 import { CollectionConfigData } from "ps99-api";
-import { GenericFetchComponent } from "./GenericFetchComponent";
 import ImageComponent from "./ImageComponent";
 
 const CurrencyComponent: React.FC<{
-  configData?: CollectionConfigData<"Currency">;
+  configData: CollectionConfigData<"Currency">;
 }> = ({ configData }) => {
   return (
-    <GenericFetchComponent<CollectionConfigData<"Currency">>
-      collectionName="Currency"
-      configData={configData}
-      render={(data) => (
+    <div>
+      <h2>{configData.DisplayName}</h2>
+      <p>Description: {configData.Desc}</p>
+      <p>Max Amount: {configData.MaxAmount}</p>
+      <p>Rarity: {configData.Rarity.DisplayName}</p>
+      <p>Rarity Number: {configData.Rarity.RarityNumber}</p>
+      {configData.Tradable && <p>Tradable: Yes</p>}
+      {configData.IsWorldCurrency && <p>World Currency: Yes</p>}
+      {configData.PermitAutoLootScaling && <p>Permit Auto Loot Scaling: Yes</p>}
+      <h3>Tiers:</h3>
+      <ul>
+        {configData.Tiers.map((tier, index) => (
+          <li key={index}>
+            <ImageComponent src={tier.orbImage} alt={tier.tierName} />
+            <p>Tier Name: {tier.tierName}</p>
+            <p>Order: {tier.Order}</p>
+            <p>Value: {tier.value}</p>
+            <ImageComponent
+              src={tier.imageOutline}
+              alt={`${tier.tierName} outline`}
+            />
+            {tier.isBottom && <p>Is Bottom: Yes</p>}
+            <ImageComponent
+              src={tier.tinyImage}
+              alt={`${tier.tierName} tiny`}
+            />
+          </li>
+        ))}
+      </ul>
+      {configData.BagTiers && (
         <div>
-          <h2>{data.DisplayName}</h2>
-          <p>Description: {data.Desc}</p>
-          <p>Max Amount: {data.MaxAmount}</p>
-          <p>Rarity: {data.Rarity.DisplayName}</p>
-          <p>Rarity Number: {data.Rarity.RarityNumber}</p>
-          {data.Tradable && <p>Tradable: Yes</p>}
-          {data.IsWorldCurrency && <p>World Currency: Yes</p>}
-          {data.PermitAutoLootScaling && <p>Permit Auto Loot Scaling: Yes</p>}
-          <h3>Tiers:</h3>
+          <h3>Bag Tiers:</h3>
           <ul>
-            {data.Tiers.map((tier, index) => (
+            {configData.BagTiers.map((bagTier, index) => (
               <li key={index}>
-                <ImageComponent src={tier.orbImage} alt={tier.tierName} />
-                <p>Tier Name: {tier.tierName}</p>
-                <p>Order: {tier.Order}</p>
-                <p>Value: {tier.value}</p>
                 <ImageComponent
-                  src={tier.imageOutline}
-                  alt={`${tier.tierName} outline`}
-                />
-                {tier.isBottom && <p>Is Bottom: Yes</p>}
-                <ImageComponent
-                  src={tier.tinyImage}
-                  alt={`${tier.tierName} tiny`}
+                  src={bagTier.image}
+                  alt={`Bag tier ${index + 1}`}
                 />
+                <p>Value: {bagTier.value}</p>
               </li>
             ))}
           </ul>
-          {data.BagTiers && (
-            <div>
-              <h3>Bag Tiers:</h3>
-              <ul>
-                {data.BagTiers.map((bagTier, index) => (
-                  <li key={index}>
-                    <ImageComponent
-                      src={bagTier.image}
-                      alt={`Bag tier ${index + 1}`}
-                    />
-                    <p>Value: {bagTier.value}</p>
-                  </li>
-                ))}
-              </ul>
-            </div>
-          )}
         </div>
       )}
-    />
+    </div>
   );
 };
 

package/example-web/react2/src/components/DynamicCollectionConfigData.tsx

@@ -1,13 +1,25 @@
 import React, { lazy, Suspense } from "react";
 import { useParams } from "react-router-dom";
-import { CollectionName } from "ps99-api";
+import { CollectionName, CollectionConfigData } from "ps99-api";
+import { GenericFetchComponent } from "./GenericFetchComponent";
 
-const DynamicCollectionConfigData: React.FC = () => {
-  const { collectionName, configName } = useParams<{
+interface DynamicCollectionConfigDataProps {
+  collectionName?: CollectionName;
+  configName?: string;
+  render?: (configData: CollectionConfigData<any>) => React.ReactNode; // Add render prop
+}
+
+const DynamicCollectionConfigData: React.FC<
+  DynamicCollectionConfigDataProps
+> = (props) => {
+  const params = useParams<{
     collectionName: CollectionName;
     configName: string;
   }>();
 
+  const collectionName = props.collectionName || params.collectionName;
+  const configName = props.configName || params.configName;
+
   if (!collectionName || !configName) {
     return <div>Invalid collection or config name</div>;
   }
@@ -16,7 +28,14 @@ const DynamicCollectionConfigData: React.FC = () => {
 
   return (
     <Suspense fallback={<div>Loading...</div>}>
-      <Component configName={configName} />
+      <GenericFetchComponent
+        collectionName={collectionName}
+        configName={configName}
+        render={
+          props.render ||
+          ((configData) => <Component configData={configData} />)
+        } // Use render prop if provided
+      />
     </Suspense>
   );
 };