minecraft-inventory 0.1.0

package/src/types.ts

@@ -0,0 +1,176 @@
+export interface ItemStack {
+  type: number
+  count: number
+  /** Snake_case item name, e.g. "diamond_sword". Used for texture lookup. */
+  name?: string
+  metadata?: number
+  nbt?: Record<string, unknown>
+  displayName?: string
+  enchantments?: Array<{ name: string; level: number }>
+  lore?: string[]
+  durability?: number
+  maxDurability?: number
+}
+
+export interface SlotState {
+  index: number
+  item: ItemStack | null
+}
+
+export type MouseButton = 'left' | 'right' | 'middle'
+export type ClickMode = 'normal' | 'shift' | 'number' | 'middle' | 'drop' | 'drag' | 'double'
+
+export interface SlotClickEvent {
+  slotIndex: number
+  button: MouseButton
+  mode: ClickMode
+  numberKey?: number
+}
+
+export interface DragEvent {
+  startSlot: number
+  endSlot: number
+  button: MouseButton
+}
+
+export type InventoryAction =
+  | { type: 'click'; slotIndex: number; button: MouseButton; mode: ClickMode; numberKey?: number }
+  | { type: 'drop'; slotIndex: number; all: boolean }
+  | { type: 'drag'; slots: number[]; button: MouseButton }
+  | { type: 'close' }
+  | { type: 'trade'; tradeIndex: number }
+  | { type: 'rename'; text: string }
+  | { type: 'enchant'; enchantIndex: number }
+  | { type: 'beacon'; primaryEffect: number; secondaryEffect: number }
+  | { type: 'hotbar-swap'; slotIndex: number; hotbarSlot: number }
+
+export interface InventoryWindowState {
+  windowId: number
+  type: string
+  title?: string
+  slots: SlotState[]
+  properties?: Record<string, number>
+  heldItem: ItemStack | null
+}
+
+export interface PlayerState {
+  activeHotbarSlot: number
+  inventory: SlotState[]
+}
+
+export interface TextureAtlas {
+  url: string
+  tileSize: number
+  tilesPerRow: number
+}
+
+export type ScaleValue = number | string
+
+export interface InventoryGUIConfig {
+  scale?: ScaleValue
+  slotSize?: number
+  showJEI?: boolean
+  jeiPosition?: 'left' | 'right'
+  showTooltips?: boolean
+  resourcePackUrl?: string
+  textureAtlas?: TextureAtlas
+}
+
+
+export interface SlotDefinition {
+  index: number
+  x: number
+  y: number
+  size?: number
+  group: string
+  label?: string
+  acceptsItem?: (item: ItemStack) => boolean
+  resultSlot?: boolean
+  fuelSlot?: boolean
+}
+
+export interface ProgressBar {
+  id: string
+  x: number
+  y: number
+  width: number
+  height: number
+  direction: 'right' | 'up' | 'down' | 'left'
+  textureX: number
+  textureY: number
+  emptyTextureX?: number
+  emptyTextureY?: number
+  getValue: (props: Record<string, number>) => number
+  getMax: (props: Record<string, number>) => number
+}
+
+export interface InventoryTypeDefinition {
+  name: string
+  title: string
+  backgroundTexture: string
+  backgroundWidth: number
+  backgroundHeight: number
+  /** Minecraft version for GUI texture lookup, e.g. '1.16.4' or '1.21.4'. Defaults to base URL version. */
+  guiTextureVersion?: string
+  slots: SlotDefinition[]
+  progressBars?: ProgressBar[]
+  playerInventoryOffset?: { x: number; y: number }
+  properties?: Record<string, { dataSlot: number; description: string }>
+  windowType?: number | string
+  hasTitle?: boolean
+  extraData?: Record<string, unknown>
+}
+
+export interface RecipeGuide {
+  title: string
+  description?: string
+  /** 'crafting' = 3×3 grid, 'smelting' = input+fuel→result, 'custom' = description only */
+  type: 'crafting' | 'smelting' | 'custom'
+  /** For crafting: 9-element array (null = empty slot) */
+  ingredients?: (ItemStack | null)[]
+  input?: ItemStack | null
+  fuel?: ItemStack | null
+  result?: ItemStack | null
+}
+
+/** A single entry in the recipe navigation stack */
+export interface RecipeNavFrame {
+  /** The item whose recipes/usages are being viewed */
+  item: { type: number; name: string; displayName: string; count?: number; metadata?: number }
+  mode: 'recipes' | 'usages'
+  guides: RecipeGuide[]
+  /** Currently displayed guide index within `guides` */
+  guideIndex: number
+}
+
+export interface TradeOffer {
+  inputItem1: ItemStack
+  inputItem2: ItemStack | null
+  outputItem: ItemStack
+  disabled: boolean
+  uses: number
+  maxUses: number
+  xp: number
+  priceMultiplier: number
+  demand: number
+  specialPrice: number
+}
+
+export interface VillagerWindowState extends InventoryWindowState {
+  trades: TradeOffer[]
+  selectedTrade: number
+  villagerLevel: number
+  villagerXp: number
+  isRegularVillager: boolean
+  canRestock: boolean
+}
+
+export interface EnchantingWindowState extends InventoryWindowState {
+  enchantmentOptions: Array<{
+    level: number
+    enchantmentId: number
+    enchantmentLevel: number
+    requiredXp: number
+  }>
+  seed: number
+}