@shipload/sdk 2.0.0-rc15 → 2.0.0-rc16

package/package.json

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

package/src/entities/entity-inventory.ts

@@ -18,7 +18,7 @@ export class EntityInventory extends ServerContract.Types.cargo_item {
     }
 
     get name(): string {
-        return this.item.name
+        return this.item.displayName
     }
 
     get unitMass(): UInt32 {

package/src/resolution/display-name.ts

@@ -1,36 +1,18 @@
 import type {ResolvedItem} from './resolve-item'
-import type {ResourceCategory} from '../types'
+import type {ResourceCategory, ResourceTier} from '../types'
+import {CATEGORY_LABELS, TIER_ADJECTIVES, tierNumber} from '../types'
 import {formatMass as defaultFormatMass} from '../format'
 
-const TIER_ADJECTIVES: Record<number, string> = {
-    1: 'Crude',
-    2: 'Dense',
-    3: 'Pure',
-    4: 'Prime',
-    5: 'Pristine',
-    6: 'Radiant',
-    7: 'Exotic',
-    8: 'Mythic',
-    9: 'Cosmic',
-    10: 'Ascendant',
+export interface DisplayNameInput {
+    itemType: 'resource' | 'component' | 'module' | 'entity' | string
+    tier: ResourceTier | string
+    category?: ResourceCategory
+    name: string
 }
 
-const CATEGORY_LABELS: Record<ResourceCategory, string> = {
-    ore: 'Ore',
-    crystal: 'Crystal',
-    gas: 'Gas',
-    regolith: 'Regolith',
-    biomass: 'Biomass',
-}
-
-function tierNumber(tier: string): number {
-    return Number(String(tier).replace(/^t/i, ''))
-}
-
-export function displayName(resolved: ResolvedItem): string {
+export function displayName(resolved: DisplayNameInput): string {
     if (resolved.itemType === 'resource') {
-        const tierNum = tierNumber(resolved.tier)
-        const adj = TIER_ADJECTIVES[tierNum] ?? 'Unknown'
+        const adj = TIER_ADJECTIVES[tierNumber(resolved.tier)] ?? 'Unknown'
         const cat = resolved.category ? CATEGORY_LABELS[resolved.category] : 'Resource'
         return `${adj} ${cat}`
     }

package/src/resolution/resolve-item.ts

@@ -100,7 +100,7 @@ function resolveResource(id: number, stats?: UInt64Type): ResolvedItem {
     }
     return {
         itemId: id,
-        name: String(item.name),
+        name: item.displayName,
         icon: categoryIcons[cat] ?? '⬡',
         abbreviation: null,
         category: cat,

package/src/types.ts

@@ -116,6 +116,31 @@ export interface Distance {
 export type ResourceCategory = 'ore' | 'crystal' | 'gas' | 'regolith' | 'biomass'
 export type ResourceTier = 't1' | 't2' | 't3' | 't4' | 't5'
 
+export const TIER_ADJECTIVES: Record<number, string> = {
+    1: 'Crude',
+    2: 'Dense',
+    3: 'Pure',
+    4: 'Prime',
+    5: 'Pristine',
+    6: 'Radiant',
+    7: 'Exotic',
+    8: 'Mythic',
+    9: 'Cosmic',
+    10: 'Ascendant',
+}
+
+export const CATEGORY_LABELS: Record<ResourceCategory, string> = {
+    ore: 'Ore',
+    crystal: 'Crystal',
+    gas: 'Gas',
+    regolith: 'Regolith',
+    biomass: 'Biomass',
+}
+
+export function tierNumber(tier: string): number {
+    return Number(String(tier).replace(/^t/i, ''))
+}
+
 @Struct.type('item')
 export class Item extends Struct {
     @Struct.field(UInt16)
@@ -132,4 +157,11 @@ export class Item extends Struct {
     tier!: ResourceTier
     @Struct.field('string')
     color!: string
+
+    get displayName(): string {
+        if (this.name && this.name.length > 0) return this.name
+        const adj = TIER_ADJECTIVES[tierNumber(this.tier)] ?? 'Unknown'
+        const cat = CATEGORY_LABELS[this.category] ?? 'Resource'
+        return `${adj} ${cat}`
+    }
 }