@shipload/sdk 2.0.0-rc24 → 2.0.0-rc25

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@shipload/sdk",
     "description": "SDKs for Shipload",
-    "version": "2.0.0-rc24",
+    "version": "2.0.0-rc25",
     "homepage": "https://github.com/shipload/sdk",
     "license": "MIT",
     "main": "lib/shipload.js",

package/src/capabilities/storage.ts

@@ -1,7 +1,7 @@
 import {UInt16, UInt32, UInt64, UInt64Type} from '@wharfkit/antelope'
 import {ServerContract} from '../contracts'
 import {StorageCapability} from '../types/capabilities'
-import {getItem} from '../market/items'
+import {getItem} from '../data/catalog'
 import {INSUFFICIENT_ITEM_QUANTITY} from '../errors'
 
 export interface HasCargo {

package/src/data/catalog.ts

@@ -0,0 +1,129 @@
+import {UInt16, UInt16Type} from '@wharfkit/antelope'
+import items from './items.json'
+import {tierLabels} from './colors'
+import {itemMetadata} from './metadata'
+import {CATEGORY_LABELS, Item, ItemType, ModuleType, ResourceCategory} from '../types'
+
+const itemsById = new Map<number, Item>()
+
+for (const raw of items as any[]) {
+    const meta = itemMetadata[raw.id]
+    if (!meta) {
+        throw new Error(`Missing metadata for item ${raw.id}. Add an entry to metadata.ts.`)
+    }
+    itemsById.set(raw.id, {
+        id: raw.id,
+        name: meta.name,
+        description: meta.description,
+        color: meta.color,
+        mass: raw.mass,
+        type: raw.type,
+        tier: raw.tier,
+        category: raw.category,
+        moduleType: raw.type === 'module' ? raw.subtype : undefined,
+    })
+}
+
+export const itemIds = Array.from(itemsById.keys())
+
+export function getItem(itemId: UInt16Type): Item {
+    const id = UInt16.from(itemId).toNumber()
+    const item = itemsById.get(id)
+    if (!item) throw new Error(`Unknown item id: ${id}`)
+    return item
+}
+
+export function getItems(): Item[] {
+    return Array.from(itemsById.values())
+}
+
+export function getResources(opts?: {category?: ResourceCategory; tier?: number}): Item[] {
+    const out: Item[] = []
+    for (const item of itemsById.values()) {
+        if (item.type !== 'resource') continue
+        if (opts?.category !== undefined && item.category !== opts.category) continue
+        if (opts?.tier !== undefined && item.tier !== opts.tier) continue
+        out.push(item)
+    }
+    return out
+}
+
+export function getComponents(opts?: {tier?: number}): Item[] {
+    const out: Item[] = []
+    for (const item of itemsById.values()) {
+        if (item.type !== 'component') continue
+        if (opts?.tier !== undefined && item.tier !== opts.tier) continue
+        out.push(item)
+    }
+    return out
+}
+
+export function getModules(opts?: {moduleType?: ModuleType; tier?: number}): Item[] {
+    const out: Item[] = []
+    for (const item of itemsById.values()) {
+        if (item.type !== 'module') continue
+        if (opts?.moduleType !== undefined && item.moduleType !== opts.moduleType) continue
+        if (opts?.tier !== undefined && item.tier !== opts.tier) continue
+        out.push(item)
+    }
+    return out
+}
+
+export function getEntityItems(opts?: {tier?: number}): Item[] {
+    const out: Item[] = []
+    for (const item of itemsById.values()) {
+        if (item.type !== 'entity') continue
+        if (opts?.tier !== undefined && item.tier !== opts.tier) continue
+        out.push(item)
+    }
+    return out
+}
+
+export function __registerItemInternal(item: Item): void {
+    itemsById.set(item.id, item)
+}
+
+export function resolveItemCategory(id: number): ResourceCategory | undefined {
+    const item = itemsById.get(id)
+    return item?.category
+}
+
+const TYPE_LABEL_BY_STRING: Record<ItemType, string> = {
+    resource: 'Resource',
+    component: 'Component',
+    module: 'Module',
+    entity: 'Entity',
+}
+
+const TYPE_BY_INDEX: ItemType[] = ['resource', 'component', 'module', 'entity']
+
+export function typeLabel(type: ItemType | number): string {
+    if (typeof type === 'number') {
+        const t = TYPE_BY_INDEX[type]
+        return t ? TYPE_LABEL_BY_STRING[t] : `type ${type}`
+    }
+    return TYPE_LABEL_BY_STRING[type] ?? `type ${type}`
+}
+
+export function categoryLabel(cat: ResourceCategory): string {
+    return CATEGORY_LABELS[cat]
+}
+
+export function tierLabel(tier: number): string {
+    return tierLabels[tier] ?? `T${tier}`
+}
+
+// Chain rescat enum order from server::getrescats.
+// IMPORTANT: gas=1, crystal=4 — does NOT match the player-facing T-prefix
+// order (ore=100, crystal=200, gas=300, regolith=400, biomass=500).
+// Do not "fix" this ordering — it must stay aligned with the contract enum.
+const CATEGORY_BY_INDEX: ResourceCategory[] = ['ore', 'gas', 'regolith', 'biomass', 'crystal']
+
+export function categoryFromIndex(i: number): ResourceCategory | undefined {
+    return CATEGORY_BY_INDEX[i]
+}
+
+export function categoryLabelFromIndex(i: number): string {
+    const cat = categoryFromIndex(i)
+    return cat ? CATEGORY_LABELS[cat] : `category ${i}`
+}

package/src/data/colors.ts

@@ -1,4 +1,4 @@
-import type {ResourceCategory, ResourceTier} from '../types'
+import type {ResourceCategory} from '../types'
 
 export const categoryColors: Record<ResourceCategory, string> = {
     ore: '#C26D3F',
@@ -8,20 +8,33 @@ export const categoryColors: Record<ResourceCategory, string> = {
     biomass: '#5A8B3E',
 }
 
-export const tierColors: Record<ResourceTier, string> = {
-    t1: '#8b8b8b',
-    t2: '#4ade80',
-    t3: '#818cf8',
-    t4: '#c084fc',
-    t5: '#fbbf24',
+export const tierColors: Record<number, string> = {
+    1: '#8b8b8b',
+    2: '#4ade80',
+    3: '#818cf8',
+    4: '#c084fc',
+    5: '#fbbf24',
+    6: '#f97316',
+    7: '#ef4444',
+    8: '#ec4899',
+    9: '#06b6d4',
+    10: '#ffffff',
 }
 
-export const tierLabels: Record<ResourceTier, string> = {
-    t1: 'Common',
-    t2: 'Uncommon',
-    t3: 'Rare',
-    t4: 'Epic',
-    t5: 'Legendary',
+// Rarity-tier names (badge labels). Kept disjoint from TIER_ADJECTIVES in
+// types.ts (resource descriptors like "Pristine Ore") so the two vocabularies
+// never collide at any tier.
+export const tierLabels: Record<number, string> = {
+    1: 'Common',
+    2: 'Uncommon',
+    3: 'Rare',
+    4: 'Epic',
+    5: 'Legendary',
+    6: 'Mythic',
+    7: 'Divine',
+    8: 'Celestial',
+    9: 'Eternal',
+    10: 'Transcendent',
 }
 
 export const categoryIcons: Record<ResourceCategory, string> = {

package/src/data/recipes-runtime.ts

@@ -2,7 +2,7 @@ import items from './items.json'
 import recipes from './recipes.json'
 import entities from './entities.json'
 
-import {getItem} from '../market/items'
+import {getItem} from './catalog'
 import {Item, ModuleType, ResourceCategory} from '../types'
 
 export interface RecipeInputItemId {

package/src/derivation/crafting.ts

@@ -1,7 +1,7 @@
 import {UInt64} from '@wharfkit/antelope'
 import type {ResourceCategory} from '../types'
 import {findItemByCategoryAndTier, getRecipe, Recipe} from '../data/recipes-runtime'
-import {getItem} from '../market/items'
+import {getItem} from '../data/catalog'
 import {getStatDefinitions} from './stats'
 import {deriveResourceStats} from './stratum'
 

package/src/derivation/resources.ts

@@ -1,4 +1,4 @@
-import {getItem} from '../market/items'
+import {getItem} from '../data/catalog'
 
 export const DEPTH_THRESHOLD_T1 = 0
 export const DEPTH_THRESHOLD_T2 = 2000

package/src/entities/entity-inventory.ts

@@ -1,6 +1,6 @@
 import {UInt32, UInt64} from '@wharfkit/antelope'
 import {ServerContract} from '../contracts'
-import {getItem} from '../market/items'
+import {getItem} from '../data/catalog'
 import {Item} from '../types'
 
 export class EntityInventory extends ServerContract.Types.cargo_item {

package/src/entities/makers.ts

@@ -6,7 +6,7 @@ import {Container, ContainerStateInput} from './container'
 import {ITEM_SHIP_T1_PACKED, ITEM_WAREHOUSE_T1_PACKED} from '../data/item-ids'
 import {getEntityLayout} from '../data/recipes-runtime'
 import {itemMetadata} from '../data/metadata'
-import {getItem} from '../market/items'
+import {getItem} from '../data/catalog'
 import {
     getModuleCapabilityType,
     MODULE_STORAGE,

package/src/index-module.ts

@@ -45,7 +45,21 @@ export {
 export type {EntityType, LocationStratum} from './managers'
 export type {EntityRefInput} from './managers/actions'
 
-export {getItem, getItems, itemIds} from './market/items'
+export {
+    getItem,
+    getItems,
+    itemIds,
+    getResources,
+    getComponents,
+    getModules,
+    getEntityItems,
+    resolveItemCategory,
+    typeLabel,
+    categoryLabel,
+    categoryFromIndex,
+    categoryLabelFromIndex,
+    tierLabel,
+} from './data/catalog'
 export {getCurrentEpoch, getEpochInfo} from './scheduling/epoch'
 export type {EpochInfo} from './scheduling/epoch'
 export {

package/src/resolution/display-name.ts

@@ -1,22 +1,18 @@
 import type {ResolvedItem} from './resolve-item'
 import type {ResourceCategory} from '../types'
-import {CATEGORY_LABELS, TIER_ADJECTIVES, tierNumber} from '../types'
+import {CATEGORY_LABELS, TIER_ADJECTIVES} from '../types'
 import {formatMass as defaultFormatMass} from '../format'
 
 export interface DisplayNameInput {
     itemType: 'resource' | 'component' | 'module' | 'entity' | string
-    tier: number | string
+    tier: number
     category?: ResourceCategory
     name: string
 }
 
-function asTierNumber(tier: number | string): number {
-    return typeof tier === 'number' ? tier : tierNumber(tier)
-}
-
 export function displayName(resolved: DisplayNameInput): string {
     if (resolved.itemType === 'resource') {
-        const adj = TIER_ADJECTIVES[asTierNumber(resolved.tier)] ?? 'Unknown'
+        const adj = TIER_ADJECTIVES[resolved.tier] ?? 'Unknown'
         const cat = resolved.category ? CATEGORY_LABELS[resolved.category] : 'Resource'
         return `${adj} ${cat}`
     }
@@ -32,7 +28,7 @@ export interface DescribeOptions {
 export function describeItem(resolved: ResolvedItem, opts?: DescribeOptions): string {
     const massFmt = opts?.formatMass ?? defaultFormatMass
     const mass = massFmt(resolved.mass)
-    const tier = `T${asTierNumber(resolved.tier)}`
+    const tier = `T${resolved.tier}`
     if (resolved.itemType === 'resource') {
         const cat = resolved.category ? CATEGORY_LABELS[resolved.category] : 'Resource'
         const header = `${tier} ${cat}`

package/src/resolution/resolve-item.ts

@@ -1,7 +1,7 @@
 import {UInt16, UInt64} from '@wharfkit/antelope'
 import type {UInt16Type, UInt64Type} from '@wharfkit/antelope'
 import type {ResourceCategory} from '../types'
-import {getItem} from '../market/items'
+import {getItem} from '../data/catalog'
 import {getEntityLayout} from '../data/recipes-runtime'
 import {entityMetadata, itemMetadata} from '../data/metadata'
 import {

package/src/scheduling/projection.ts

@@ -17,7 +17,7 @@ import {
     SHIP_CARGO_NOT_LOADED,
 } from '../errors'
 import {getRecipe, RecipeInput} from '../data/recipes-runtime'
-import {getItem} from '../market/items'
+import {getItem} from '../data/catalog'
 import {distanceBetweenCoordinates, lerp} from '../travel/travel'
 import {
     calcStacksMass,

package/src/travel/travel.ts

@@ -32,7 +32,7 @@ import {
     ShipLike,
     TaskType,
 } from '../types'
-import {getItem} from '../market/items'
+import {getItem} from '../data/catalog'
 import {hasSystem} from '../utils/system'
 
 export function calc_orbital_altitude(mass: number): number {

package/src/types.ts

@@ -103,7 +103,6 @@ export interface Distance {
 
 export type ItemType = 'resource' | 'component' | 'module' | 'entity'
 export type ResourceCategory = 'ore' | 'crystal' | 'gas' | 'regolith' | 'biomass'
-export type ResourceTier = 't1' | 't2' | 't3' | 't4' | 't5'
 export type ModuleType =
     | 'any'
     | 'engine'
@@ -137,10 +136,6 @@ export const CATEGORY_LABELS: Record<ResourceCategory, string> = {
     biomass: 'Biomass',
 }
 
-export function tierNumber(tier: string): number {
-    return Number(String(tier).replace(/^t/i, ''))
-}
-
 export interface Item {
     id: number
     name: string

package/src/market/items.ts

@@ -1,41 +0,0 @@
-import {UInt16, UInt16Type} from '@wharfkit/antelope'
-import items from '../data/items.json'
-import {itemMetadata} from '../data/metadata'
-import {Item} from '../types'
-
-const itemsById = new Map<number, Item>()
-
-for (const raw of items as any[]) {
-    const meta = itemMetadata[raw.id]
-    if (!meta) {
-        throw new Error(`Missing metadata for item ${raw.id}. Add an entry to metadata.ts.`)
-    }
-    itemsById.set(raw.id, {
-        id: raw.id,
-        name: meta.name,
-        description: meta.description,
-        color: meta.color,
-        mass: raw.mass,
-        type: raw.type,
-        tier: raw.tier,
-        category: raw.category,
-        moduleType: raw.type === 'module' ? raw.subtype : undefined,
-    })
-}
-
-export const itemIds = Array.from(itemsById.keys())
-
-export function getItem(itemId: UInt16Type): Item {
-    const id = UInt16.from(itemId).toNumber()
-    const item = itemsById.get(id)
-    if (!item) throw new Error(`Unknown item id: ${id}`)
-    return item
-}
-
-export function getItems(): Item[] {
-    return Array.from(itemsById.values())
-}
-
-export function __registerItemInternal(item: Item): void {
-    itemsById.set(item.id, item)
-}