@shipload/sdk 2.0.0-rc7 → 2.0.0-rc8

package/package.json

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

package/src/data/colors.ts

@@ -1,7 +1,7 @@
 import type {ResourceCategory, ResourceTier} from '../types'
 
 export const categoryColors: Record<ResourceCategory, string> = {
-    metal: '#7B8D9E',
+    metal: '#5B9BD5',
     precious: '#D4A843',
     gas: '#7EC8E3',
     mineral: '#B8A9C9',
@@ -26,3 +26,22 @@ export const categoryIcons: Record<ResourceCategory, string> = {
 
 export const componentIcon = '▣'
 export const moduleIcon = '⬢'
+
+export const itemIcons: Record<number, string> = {
+    10001: 'HP',
+    10002: 'CL',
+    10003: 'CT',
+    10004: 'TC',
+    10005: 'PC',
+    10006: 'EN',
+    10007: 'GN',
+    10008: 'SH',
+    10009: 'DS',
+    10010: 'EP',
+    10011: 'CA',
+    10012: 'TB',
+    10013: 'RC',
+    10014: 'EX',
+    10015: 'LD',
+    10016: 'MF',
+}

package/src/data/recipes.ts

@@ -1,4 +1,4 @@
-import {MODULE_ENGINE, MODULE_GENERATOR, MODULE_EXTRACTOR, MODULE_LOADER, MODULE_CRAFTER, ITEM_ENGINE_T1, ITEM_GENERATOR_T1, ITEM_EXTRACTOR_T1, ITEM_LOADER_T1, ITEM_MANUFACTURING_T1} from '../capabilities/modules'
+import {MODULE_ANY, MODULE_ENGINE, MODULE_GENERATOR, MODULE_EXTRACTOR, MODULE_LOADER, MODULE_CRAFTER, ITEM_ENGINE_T1, ITEM_GENERATOR_T1, ITEM_EXTRACTOR_T1, ITEM_LOADER_T1, ITEM_MANUFACTURING_T1} from '../capabilities/modules'
 import type {ResourceCategory} from '../types'
 
 export {ITEM_ENGINE_T1, ITEM_GENERATOR_T1, ITEM_EXTRACTOR_T1, ITEM_LOADER_T1, ITEM_MANUFACTURING_T1}
@@ -38,6 +38,10 @@ export interface ComponentDefinition {
 	usedIn: {type: 'entity' | 'module'; name: string}[]
 }
 
+export interface ModuleSlot {
+	type: number
+}
+
 export interface EntityRecipe {
 	id: string
 	name: string
@@ -46,6 +50,7 @@ export interface EntityRecipe {
 	packedItemId: number
 	recipe: RecipeInput[]
 	stats: {key: string; sourceComponentId: number; sourceStatKey: string}[]
+	moduleSlots?: ModuleSlot[]
 }
 
 export interface CraftableItem {
@@ -98,7 +103,7 @@ export const components: ComponentDefinition[] = [
 			{key: 'thermal', source: 'gas'},
 		],
 		recipe: [{category: 'gas' as ResourceCategory, quantity: 32}],
-		usedIn: [{type: 'module', name: 'Engine Module T1'}],
+		usedIn: [{type: 'module', name: 'Engine'}],
 	},
 	{
 		id: ITEM_POWER_CELL,
@@ -111,7 +116,7 @@ export const components: ComponentDefinition[] = [
 			{key: 'clarity', source: 'mineral'},
 		],
 		recipe: [{category: 'mineral' as ResourceCategory, quantity: 20}],
-		usedIn: [{type: 'module', name: 'Generator Module T1'}],
+		usedIn: [{type: 'module', name: 'Generator'}],
 	},
 	{
 		id: ITEM_DRILL_SHAFT,
@@ -124,7 +129,7 @@ export const components: ComponentDefinition[] = [
 			{key: 'tolerance', source: 'metal'},
 		],
 		recipe: [{category: 'metal' as ResourceCategory, quantity: 15}],
-		usedIn: [{type: 'module', name: 'Extractor Module T1'}],
+		usedIn: [{type: 'module', name: 'Extractor'}],
 	},
 	{
 		id: ITEM_EXTRACTION_PROBE,
@@ -137,7 +142,7 @@ export const components: ComponentDefinition[] = [
 			{key: 'reflectivity', source: 'precious'},
 		],
 		recipe: [{category: 'precious' as ResourceCategory, quantity: 10}],
-		usedIn: [{type: 'module', name: 'Extractor Module T1'}],
+		usedIn: [{type: 'module', name: 'Extractor'}],
 	},
 	{
 		id: ITEM_CARGO_ARM,
@@ -150,7 +155,7 @@ export const components: ComponentDefinition[] = [
 			{key: 'insulation', source: 'organic'},
 		],
 		recipe: [{category: 'organic' as ResourceCategory, quantity: 32}],
-		usedIn: [{type: 'module', name: 'Loader Module T1'}],
+		usedIn: [{type: 'module', name: 'Loader'}],
 	},
 	{
 		id: ITEM_TOOL_BIT,
@@ -163,7 +168,7 @@ export const components: ComponentDefinition[] = [
 			{key: 'clarity', source: 'mineral'},
 		],
 		recipe: [{category: 'mineral' as ResourceCategory, quantity: 20}],
-		usedIn: [{type: 'module', name: 'Manufacturing Module T1'}],
+		usedIn: [{type: 'module', name: 'Manufacturing'}],
 	},
 	{
 		id: ITEM_REACTION_CHAMBER,
@@ -176,7 +181,7 @@ export const components: ComponentDefinition[] = [
 			{key: 'thermal', source: 'gas'},
 		],
 		recipe: [{category: 'gas' as ResourceCategory, quantity: 32}],
-		usedIn: [{type: 'module', name: 'Manufacturing Module T1'}],
+		usedIn: [{type: 'module', name: 'Manufacturing'}],
 	},
 ]
 
@@ -214,6 +219,13 @@ export const entityRecipes: EntityRecipe[] = [
 			{key: 'ductility', sourceComponentId: ITEM_CARGO_LINING, sourceStatKey: 'ductility'},
 			{key: 'purity', sourceComponentId: ITEM_CARGO_LINING, sourceStatKey: 'purity'},
 		],
+		moduleSlots: [
+			{type: MODULE_ANY},
+			{type: MODULE_ANY},
+			{type: MODULE_ANY},
+			{type: MODULE_ANY},
+			{type: MODULE_ANY},
+		],
 	},
 ]
 
@@ -231,7 +243,7 @@ export interface ModuleRecipe {
 export const moduleRecipes: ModuleRecipe[] = [
 	{
 		id: 'engine-t1',
-		name: 'Engine Module T1',
+		name: 'Engine',
 		description: 'Basic propulsion system. Converts volatile gases into thrust.',
 		color: '#E86344',
 		itemId: ITEM_ENGINE_T1,
@@ -244,7 +256,7 @@ export const moduleRecipes: ModuleRecipe[] = [
 	},
 	{
 		id: 'generator-t1',
-		name: 'Generator Module T1',
+		name: 'Generator',
 		description: 'Basic energy system. Stores and recharges energy from resonant minerals.',
 		color: '#7B5AE8',
 		itemId: ITEM_GENERATOR_T1,
@@ -257,7 +269,7 @@ export const moduleRecipes: ModuleRecipe[] = [
 	},
 	{
 		id: 'extractor-t1',
-		name: 'Extractor Module T1',
+		name: 'Extractor',
 		description: 'Basic extraction system. Drills and probes for raw resources.',
 		color: '#7B8D9E',
 		itemId: ITEM_EXTRACTOR_T1,
@@ -276,7 +288,7 @@ export const moduleRecipes: ModuleRecipe[] = [
 	},
 	{
 		id: 'loader-t1',
-		name: 'Loader Module T1',
+		name: 'Loader',
 		description: 'Basic cargo handling system. Loads and unloads cargo with articulated arms.',
 		color: '#6B8E5A',
 		itemId: ITEM_LOADER_T1,
@@ -292,7 +304,7 @@ export const moduleRecipes: ModuleRecipe[] = [
 	},
 	{
 		id: 'manufacturing-t1',
-		name: 'Manufacturing Module T1',
+		name: 'Manufacturing',
 		description: 'Basic crafting system. Processes materials using reaction chambers and cutting tools.',
 		color: '#7EC8E3',
 		itemId: ITEM_MANUFACTURING_T1,

package/src/index-module.ts

@@ -141,7 +141,7 @@ export * from './types/capabilities'
 export * from './types/entity'
 export * from './capabilities'
 
-export {categoryColors, tierColors, categoryIcons, componentIcon, moduleIcon} from './data/colors'
+export {categoryColors, tierColors, categoryIcons, componentIcon, moduleIcon, itemIcons} from './data/colors'
 
 export {
    components,
@@ -178,6 +178,7 @@ export type {
    RecipeInput,
    EntityRecipe,
    ModuleRecipe,
+   ModuleSlot,
    CraftableItem,
 } from './data/recipes'
 
@@ -205,4 +206,4 @@ export {
 } from './entities/ship-deploy'
 
 export {resolveItem} from './resolution/resolve-item'
-export type {ResolvedItem, ResolvedItemStat, ResolvedAttributeGroup, ResolvedItemType} from './resolution/resolve-item'
+export type {ResolvedItem, ResolvedItemStat, ResolvedAttributeGroup, ResolvedModuleSlot, ResolvedItemType} from './resolution/resolve-item'

package/src/resolution/resolve-item.ts

@@ -9,7 +9,7 @@ import {deriveResourceStats} from '../derivation/stratum'
 import {getStatDefinitions} from '../derivation/stats'
 import {computeShipHullCapabilities, computeEngineCapabilities, computeGeneratorCapabilities, computeExtractorCapabilities, computeLoaderCapabilities, computeManufacturingCapabilities} from '../entities/ship-deploy'
 import {computeContainerCapabilities} from '../entities/container'
-import {categoryColors, categoryIcons, componentIcon, moduleIcon} from '../data/colors'
+import {categoryColors, categoryIcons, componentIcon, moduleIcon, itemIcons} from '../data/colors'
 import {ServerContract} from '../contracts'
 
 export interface ResolvedItemStat {
@@ -29,6 +29,12 @@ export interface ResolvedAttributeGroup {
 
 export type ResolvedItemType = 'resource' | 'component' | 'module' | 'entity'
 
+export interface ResolvedModuleSlot {
+    name?: string
+    installed: boolean
+    attributes?: {label: string; value: number}[]
+}
+
 export interface ResolvedItem {
     itemId: number
     name: string
@@ -39,6 +45,7 @@ export interface ResolvedItem {
     itemType: ResolvedItemType
     stats?: ResolvedItemStat[]
     attributes?: ResolvedAttributeGroup[]
+    moduleSlots?: ResolvedModuleSlot[]
 }
 
 function toNum(v: UInt16Type): number {
@@ -107,7 +114,7 @@ function resolveComponent(id: number, seed?: UInt64Type): ResolvedItem {
     return {
         itemId: id,
         name: comp.name,
-        icon: componentIcon,
+        icon: itemIcons[id] ?? componentIcon,
         tier: 't1' as ResourceTier,
         mass: comp.mass,
         itemType: 'component',
@@ -172,7 +179,7 @@ function resolveModule(id: number, seed?: UInt64Type): ResolvedItem {
     return {
         itemId: id,
         name: recipe.name,
-        icon: moduleIcon,
+        icon: itemIcons[id] ?? moduleIcon,
         tier: 't1' as ResourceTier,
         mass: 0,
         itemType: 'module',
@@ -183,6 +190,8 @@ function resolveModule(id: number, seed?: UInt64Type): ResolvedItem {
 function resolveEntity(id: number, seed?: UInt64Type, modules?: ServerContract.Types.module_entry[]): ResolvedItem {
     const recipe = getEntityRecipeByItemId(id)!
     let attributes: ResolvedAttributeGroup[] | undefined
+    let moduleSlots: ResolvedModuleSlot[] | undefined
+
     if (seed !== undefined) {
         const stats = decodeCraftedItemStats(id, toBigSeed(seed))
         attributes = []
@@ -201,27 +210,37 @@ function resolveEntity(id: number, seed?: UInt64Type, modules?: ServerContract.T
                 {label: 'Capacity', value: containerCaps.capacity},
             ]})
         }
+    }
 
-        if (modules) {
-            for (const mod of modules) {
-                if (!mod.installed) continue
+    if (recipe.moduleSlots) {
+        moduleSlots = recipe.moduleSlots.map((slot, i) => {
+            const mod = modules?.[i]
+            if (mod?.installed) {
                 const modItemId = Number(mod.installed.item_id.value.toString())
                 const modSeed = BigInt(mod.installed.seed.toString())
                 const modStats = decodeCraftedItemStats(modItemId, modSeed)
                 const modType = getModuleCapabilityType(modItemId)
                 const group = computeCapabilityGroup(modType, modStats)
-                if (group) attributes.push(group)
+                const modRecipe = getModuleRecipeByItemId(modItemId)
+                return {
+                    name: modRecipe?.name ?? 'Module',
+                    installed: true,
+                    attributes: group?.attributes,
+                }
             }
-        }
+            return {installed: false}
+        })
     }
+
     return {
         itemId: id,
         name: recipe.name,
-        icon: componentIcon,
+        icon: itemIcons[id] ?? componentIcon,
         tier: 't1' as ResourceTier,
         mass: 0,
         itemType: 'entity',
         attributes,
+        moduleSlots,
     }
 }