@c3d.gg/mwi-types 1.7.0 → 1.8.1

package/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+NOTE: This license applies to the SOURCE CODE only. Historical market data
+served by the API is separately licensed under DATA_LICENSE.md (All Rights Reserved).
+
+Copyright (c) 2026 c3d.gg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,16 +1,16 @@
 # @c3d.gg/mwi-types
 
-TypeScript types for Milky Way Idle game data.
+TypeScript types and constants for Milky Way Idle game data.
 
 ## Installation
 
 ```bash
-bun add @c3d.gg/mwi-types
+pnpm add @c3d.gg/mwi-types
 ```
 
 ## Import Patterns
 
-### Types Only (lean, ~0KB runtime)
+### Types Only (~0KB runtime)
 
 ```typescript
 import type { Item, ItemHrid } from '@c3d.gg/mwi-types/items'
@@ -28,141 +28,26 @@ import { RECIPE_HRIDS, RECIPES_BY_OUTPUT } from '@c3d.gg/mwi-types/recipes'
 import { ACTION_HRIDS, ACTIONS_BY_SKILL } from '@c3d.gg/mwi-types/actions'
 ```
 
-### Raw JSON Data (custom processing)
-
-```typescript
-import itemsJson from '@c3d.gg/mwi-types/items/data'
-import recipesJson from '@c3d.gg/mwi-types/recipes/data'
-```
-
-### Utils (lazy-loaded data + type guards)
-
-```typescript
-// Items
-import { getItem, getAllItems, getItemsByCategory, isItemHrid, isEquipment, isTradable } from '@c3d.gg/mwi-types/items/utils'
-
-// Recipes
-import { getRecipe, getAllRecipes, getRecipesForOutput, buildRecipeTree, getTotalMaterials, isRecipeHrid } from '@c3d.gg/mwi-types/recipes/utils'
-
-// Actions
-import { getAction, getActionsBySkill, isProductionAction, isCombatAction, isActionHrid } from '@c3d.gg/mwi-types/actions/utils'
-
-// Monsters
-import { getMonster, getMonstersByCombatLevel, isMonsterHrid } from '@c3d.gg/mwi-types/monsters/utils'
-
-// Skills
-import { isSkillHrid } from '@c3d.gg/mwi-types/skills/utils'
-```
-
-## Utils Reference
-
-### items/utils
-
-| Function | Description |
-|----------|-------------|
-| `getItem(hrid)` | Get item by HRID, returns undefined if not found |
-| `requireItem(hrid)` | Get item or throw |
-| `getAllItems()` | Get all items as array |
-| `getItemsByCategory(categoryHrid)` | Filter items by category |
-| `isEquipment(item)` | Check if item has equipment stats |
-| `isTradable(item)` | Check if item can be traded |
-| `isItemHrid(value)` | Type guard for ItemHrid |
-
-### recipes/utils
-
-| Function | Description |
-|----------|-------------|
-| `getRecipe(hrid)` | Get recipe by HRID |
-| `requireRecipe(hrid)` | Get recipe or throw |
-| `getAllRecipes()` | Get all recipes as array |
-| `getRecipesForOutput(itemHrid)` | Find recipes that produce an item |
-| `buildRecipeTree(itemHrid, qty)` | Build full dependency tree |
-| `getTotalMaterials(node)` | Sum base materials from tree |
-| `isRecipeHrid(value)` | Type guard for RecipeHrid |
-
-### actions/utils
-
-| Function | Description |
-|----------|-------------|
-| `getAction(hrid)` | Get action by HRID |
-| `getActionsBySkill(skillHrid)` | Filter actions by skill requirement |
-| `isProductionAction(action)` | Check if production action |
-| `isCombatAction(action)` | Check if combat action |
-| `isActionHrid(value)` | Type guard for ActionHrid |
-
-### monsters/utils
-
-| Function | Description |
-|----------|-------------|
-| `getMonster(hrid)` | Get monster by HRID |
-| `getMonstersByCombatLevel(level)` | Filter by exact combat level |
-| `isMonsterHrid(value)` | Type guard for MonsterHrid |
-
-### skills/utils
-
-| Function | Description |
-|----------|-------------|
-| `isSkillHrid(value)` | Type guard for SkillHrid |
-
-## Usage Examples
-
-### Type Guards
-
-```typescript
-import { isItemHrid } from '@c3d.gg/mwi-types/items/utils'
-import { isRecipeHrid } from '@c3d.gg/mwi-types/recipes/utils'
-
-function processHrid(value: string) {
-  if (isItemHrid(value)) {
-    // value is now typed as ItemHrid
-  }
-  if (isRecipeHrid(value)) {
-    // value is now typed as RecipeHrid
-  }
-}
-```
-
-### Recipe Tree
-
-```typescript
-import { buildRecipeTree, getTotalMaterials } from '@c3d.gg/mwi-types/recipes/utils'
-import type { ItemHrid } from '@c3d.gg/mwi-types/items'
-
-const tree = buildRecipeTree('/items/cheese' as ItemHrid, 10)
-const materials = getTotalMaterials(tree)
-// Map<ItemHrid, number> of base materials needed
-```
-
-### Item Lookup
-
-```typescript
-import { getItem, getItemsByCategory } from '@c3d.gg/mwi-types/items/utils'
-import type { ItemHrid, ItemCategoryHrid } from '@c3d.gg/mwi-types/items'
-
-const milk = getItem('/items/milk' as ItemHrid)
-const foods = getItemsByCategory('/item_categories/food' as ItemCategoryHrid)
-```
-
 ## Available Domains
 
-| Domain | Types | Constants | Utils |
-|--------|-------|-----------|-------|
-| `/items` | Item, ItemHrid, ItemCategory, etc. | ITEM_HRIDS, ITEMS_BY_CATEGORY | Yes |
-| `/recipes` | Recipe, RecipeHrid, RecipeTreeNode | RECIPE_HRIDS, RECIPES_BY_OUTPUT | Yes |
-| `/actions` | Action, ActionHrid, ActionCategory | ACTION_HRIDS, ACTIONS_BY_SKILL | Yes |
-| `/monsters` | Monster, MonsterHrid | MONSTER_HRIDS | Yes |
-| `/skills` | Skill, SkillHrid | SKILL_HRIDS | Yes |
-| `/abilities` | Ability, AbilityHrid | ABILITY_HRIDS | No |
-| `/buffs` | Buff, BuffType | BUFF_TYPES_HRIDS | No |
-| `/combat` | CombatStyle, DamageType | COMBAT_STYLE_HRIDS | No |
-| `/house` | HouseRoom, HouseRoomHrid | HOUSE_ROOM_HRIDS | No |
-| `/shop` | ShopItem, PurchaseBundle | SHOP_ITEMS_HRIDS | No |
-| `/tasks` | RandomTaskType | RANDOM_TASK_TYPE_HRIDS | No |
-| `/leaderboard` | LeaderboardCategory | LEADERBOARD_CATEGORY_HRIDS | No |
+| Domain | Types | Constants |
+|--------|-------|-----------|
+| `/items` | Item, ItemHrid, ItemCategory | ITEM_HRIDS, ITEMS_BY_CATEGORY |
+| `/recipes` | Recipe, RecipeHrid | RECIPE_HRIDS, RECIPES_BY_OUTPUT |
+| `/actions` | Action, ActionHrid, ActionCategory | ACTION_HRIDS, ACTIONS_BY_SKILL |
+| `/monsters` | Monster, MonsterHrid | MONSTER_HRIDS |
+| `/skills` | Skill, SkillHrid | SKILL_HRIDS |
+| `/abilities` | Ability, AbilityHrid | ABILITY_HRIDS |
+| `/buffs` | Buff, BuffType | BUFF_TYPES_HRIDS |
+| `/combat` | CombatStyle, DamageType | COMBAT_STYLE_HRIDS |
+| `/house` | HouseRoom, HouseRoomHrid | HOUSE_ROOM_HRIDS |
+| `/shop` | ShopItem, PurchaseBundle | SHOP_ITEMS_HRIDS |
+| `/tasks` | RandomTaskType | RANDOM_TASK_TYPE_HRIDS |
+| `/leaderboard` | LeaderboardCategory | LEADERBOARD_CATEGORY_HRIDS |
 
 ## Main Entry Point
 
-For convenience, types and constants (but not utils) are re-exported from the root:
+Types and constants re-exported from root:
 
 ```typescript
 import { ITEM_HRIDS, SKILL_HRIDS, type Item, type Skill } from '@c3d.gg/mwi-types'
@@ -170,7 +55,7 @@ import { ITEM_HRIDS, SKILL_HRIDS, type Item, type Skill } from '@c3d.gg/mwi-type
 
 ## Auto-Generated
 
-This package is generated from Milky Way Idle game data. Do not edit `dist/` files.
+Generated from Milky Way Idle game data. Do not edit `dist/` files.
 
 ## License