bloxd.io.d.ts 1.1.0 → 1.2.0

package/api-type-def/normal/index.d.ts

@@ -1,8 +1,3 @@
-import GetPlayerIdsInterface from "./getPlayerIds";
-import PlayerIsInGameInterface from "./playerIsInGame";
-import PlayerIsLoggedInInterface from "./playerIsLoggedIn";
-import GetPlayerPartyWhenJoinedInterface from "./getPlayerPartyWhenJoined";
-import GetNumPlayersInterface from "./getNumPlayers";
 import GetUnitCoordinatesLifeformWithinInterface from "./getUnitCoordinatesLifeformWithin";
 import { ShopApis } from "./shops";
 import { ShieldApis } from "./shields";
@@ -11,14 +6,11 @@ import { StandingOnApis } from "./standingOns";
 import { HealthApis } from "./health";
 import { KillstreakApis } from "./killstreak";
 import { MessageApis } from "./message";
+import { PlayerApis } from "./player";
 import { MargeObject } from "../../type";
 
 type AllNormalApiIntersection = PositionApis &
-  GetPlayerIdsInterface &
-  PlayerIsInGameInterface &
-  PlayerIsLoggedInInterface &
-  GetPlayerPartyWhenJoinedInterface &
-  GetNumPlayersInterface &
+  PlayerApis &
   StandingOnApis &
   GetUnitCoordinatesLifeformWithinInterface &
   ShopApis &

package/api-type-def/normal/{getPlayerIds.d.ts → player/getPlayerIds.d.ts}

@@ -1,4 +1,4 @@
-import { PlayerId } from "../../type";
+import { PlayerId } from "../../..";
 
 interface GetPlayerIdsInterface {
   /**

package/api-type-def/normal/{getPlayerPartyWhenJoined.d.ts → player/getPlayerPartyWhenJoined.d.ts}

@@ -1,4 +1,4 @@
-import { Party, PlayerId } from "../../type";
+import { Party, PlayerId } from "../../..";
 
 interface GetPlayerPartyWhenJoinedInterface {
   /**

package/api-type-def/normal/player/index.d.ts

@@ -0,0 +1,10 @@
+import GetPlayerIdsInterface from "./getPlayerIds";
+import GetNumPlayersInterface from "./getNumPlayers";
+import GetPlayerPartyWhenJoinedInterface from "./getPlayerPartyWhenJoined";
+import PlayerIsInGameInterface from "./playerIsInGame";
+import PlayerIsLoggedInInterface from "./playerIsLoggedIn";
+export type PlayerApis = GetNumPlayersInterface &
+  GetPlayerIdsInterface &
+  GetPlayerPartyWhenJoinedInterface &
+  PlayerIsInGameInterface &
+  PlayerIsLoggedInInterface;

package/api-type-def/normal/{playerIsInGame.d.ts → player/playerIsInGame.d.ts}

@@ -1,4 +1,4 @@
-import { PlayerId } from "../../type";
+import { PlayerId } from "../../..";
 interface PlayerIsInGameInterface {
   /**
    * Whether a player is currently in the game

package/api-type-def/normal/{playerIsLoggedIn.d.ts → player/playerIsLoggedIn.d.ts}

@@ -1,4 +1,4 @@
-import { PlayerId } from "../../type";
+import { PlayerId } from "../../..";
 
 interface PlayerIsLoggedInInterface {
   /**

package/api-type-def/normal/shops/configureShopCategory.d.ts

@@ -0,0 +1,17 @@
+import { ShopCategoryConfig, ShopCategoryKey } from "../../../type";
+
+interface ConfigureShopCategory {
+  /**
+   * Set properties of a shop category.
+   *
+   * @param {ShopCategoryKey} categoryKey - The key of the category to configure
+   * @param {ShopCategoryConfig} config - Category configuration properties
+   * @returns {void}
+   */
+  configureShopCategory(
+    categoryKey: ShopCategoryKey,
+    config: ShopCategoryConfig,
+  ): void;
+}
+
+export default ConfigureShopCategory;

package/api-type-def/normal/shops/createShopItem.d.ts

@@ -0,0 +1,22 @@
+import { ShopCategoryKey, ShopItem, ShopItemKey } from "../../../type";
+
+interface CreateShopItemInterface {
+  /**
+   * Create a new shop item under the given category.
+   * Will create a new category if it does not exist.
+   * If the shop item already exists then it will be replaced.
+   * If any per-player overrides exist under the same categoryKey and itemKey then they will be deleted.
+   *
+   * @param {ShopCategoryKey} categoryKey - The key of the category to create the item in
+   * @param {ShopItemKey} itemKey - The unique key for the item
+   * @param {ShopItem} item - The shop item to create (will be mutated)
+   * @returns {void}
+   */
+  createShopItem(
+    categoryKey: ShopCategoryKey,
+    itemKey: ShopItemKey,
+    item: ShopItem,
+  ): void;
+}
+
+export default CreateShopItemInterface;

package/api-type-def/normal/shops/deleteShopItem.d.ts

@@ -0,0 +1,16 @@
+import { ShopCategoryKey, ShopItemKey } from "../../../type";
+
+interface DeleteShopItemInterface {
+  /**
+   * Delete an existing shop item.
+   * Throws an error if the item does not exist.
+   * Will also delete all per-player overrides for the shop item.
+   *
+   * @param {ShopCategoryKey} categoryKey - The key of the category containing the item
+   * @param {ShopItemKey} itemKey - The unique key for the item
+   * @returns {void}
+   */
+  deleteShopItem(categoryKey: ShopCategoryKey, itemKey: ShopItemKey): void;
+}
+
+export default DeleteShopItemInterface;

package/api-type-def/normal/shops/index.d.ts

@@ -1,3 +1,10 @@
 import ShowShopTutorialInterface from "./showShopTutorial";
-
-export type ShopApis = ShowShopTutorialInterface;
+import CreateShopItemInterface from "./createShopItem";
+import UpdateShopItemInterface from "./updateShopItem";
+import DeleteShopItemInterface from "./deleteShopItem";
+import ConfigureShopCategory from "./configureShopCategory";
+export type ShopApis = ShowShopTutorialInterface &
+  CreateShopItemInterface &
+  UpdateShopItemInterface &
+  DeleteShopItemInterface &
+  ConfigureShopCategory;

package/api-type-def/normal/shops/updateShopItem.d.ts

@@ -0,0 +1,21 @@
+import { ShopCategoryKey, ShopItem, ShopItemKey } from "../../../type";
+
+interface UpdateShopItemInterface {
+  /**
+   * Update selected properties of an existing shop item.
+   * For example, { canBuy: true } to allow players to purchase the item.
+   * Throws an error if the item does not exist.
+   *
+   * @param {ShopCategoryKey} categoryKey - The key of the category containing the item
+   * @param {ShopItemKey} itemKey - The unique key for the item
+   * @param {Partial<ShopItem>} changes - Partial shop item properties to update
+   * @returns {void}
+   */
+  updateShopItem(
+    categoryKey: ShopCategoryKey,
+    itemKey: ShopItemKey,
+    changes: Partial<ShopItem>,
+  ): void;
+}
+
+export default UpdateShopItemInterface;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bloxd.io.d.ts",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "yo",
   "types": "bloxd-api.d.ts",
   "exports": {

package/type/index.d.ts

@@ -17,3 +17,4 @@ export * from "./WhoKilled";
 export * from "./utilType";
 export * from "./ApplyMeleeHitOverrides";
 export * from "./message";
+export * from "./shop";

package/type/shop/ShopCategoryConfig.d.ts

@@ -0,0 +1,10 @@
+import { CustomTextStyling } from "..";
+
+export type ShopCategoryConfig = Partial<{
+  autoSelectCategory: boolean;
+  customTitle: string; // Supports translation keys and ordinary text
+  redDot: boolean;
+  forceRemoveRedDot: boolean;
+  sortPriority: number;
+  description: string | CustomTextStyling;
+}>;

package/type/shop/ShopCategoryKey.d.ts

@@ -0,0 +1 @@
+export type ShopCategoryKey = string;

package/type/shop/ShopItem.d.ts

@@ -0,0 +1,23 @@
+import { ShopItemBadgeType, ShopItemUserInput } from ".";
+import { CustomTextStyling, StringColor } from "..";
+
+export type ShopItem = {
+  image: string;
+  cost?: number;
+  currency?: string;
+  amount?: number; // Display amount shown on the shop tile image (0 and 1 are not displayed)
+  imageColour?: StringColor;
+  canBuy?: boolean;
+  isSelected?: boolean;
+  buyButtonText?: string | CustomTextStyling;
+  customTitle?: string | CustomTextStyling;
+  description?: string | CustomTextStyling;
+  onBoughtMessage?: string | CustomTextStyling;
+  redDot?: boolean;
+  forceRemoveRedDot?: boolean;
+  badge?: { text: string | CustomTextStyling; type: ShopItemBadgeType };
+  userInput?: ShopItemUserInput;
+  sell?: boolean; // Optional, defaults to false. If true, the sign of "cost" is flipped. So a "cost" of -25 would give the player 25 currency AND be displayed as "25" (instead of -25)
+  sortPriority?: number; // Descending, bigger number means closer to the top
+  hidden?: boolean;
+};

package/type/shop/ShopItemBadgeType.d.ts

@@ -0,0 +1 @@
+export type ShopItemBadgeType = "new" | "lucky";

package/type/shop/ShopItemKey.d.ts

@@ -0,0 +1 @@
+export type ShopItemKey = string;

package/type/shop/ShopItemUserInput.d.ts

@@ -0,0 +1,18 @@
+import { PlayerId } from "..";
+
+export type ShopItemUserInput =
+  | {
+      type: "text";
+      placeholderText?: string;
+      wordCharsOnly?: boolean;
+      initialValue?: string;
+    } // wordCharsOnly defaults to false. If true, only allows \w character (alphanumeric and _). initialValue always takes precedence as the text input value when set.
+  | { type: "number"; placeholderText?: string; initialValue?: string }
+  | {
+      type: "dropdown";
+      dropdownOptions: readonly (string | { option: string; cost: number })[];
+      shouldResetSelectionOnOptionsChange?: boolean; // Defaults to false. If true, the selection will reset to the first option when dropdownOptions changes.
+      initialValue?: string;
+    }
+  | { type: "player"; excludedPlayers?: PlayerId[] } // Defaults to excluding the current player
+  | { type: "color"; initialValue?: string };

package/type/shop/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./ShopCategoryKey";
+export * from "./ShopItem";
+export * from "./ShopItemKey";
+export * from "./ShopItemUserInput";
+export * from "./ShopItemBadgeType";
+export * from "./ShopCategoryConfig";