@shipload/sdk 1.0.0-next.4 → 1.0.0-next.40

package/src/data/kind-registry.ts

@@ -0,0 +1,165 @@
+import {Name, type NameType} from '@wharfkit/antelope'
+import kindRegistryJson from './kind-registry.json'
+
+export const CAP_WRAP = 0x01
+export const CAP_UNDEPLOY = 0x02
+export const CAP_DEMOLISH = 0x04
+export const CAP_CATCH = 0x08
+export const CAP_MODULES = 0x10
+
+export enum EntityClass {
+    OrbitalVessel = 0,
+    PlanetaryStructure = 1,
+    Plot = 2,
+}
+
+const CLASSIFICATION_BY_NAME: Record<string, EntityClass> = {
+    OrbitalVessel: EntityClass.OrbitalVessel,
+    PlanetaryStructure: EntityClass.PlanetaryStructure,
+    Plot: EntityClass.Plot,
+}
+
+export type EntityTypeName =
+    | 'ship'
+    | 'warehouse'
+    | 'extractor'
+    | 'factory'
+    | 'container'
+    | 'nexus'
+    | 'plot'
+    | 'mdriver'
+    | 'mcatcher'
+
+export interface KindMeta {
+    kind: Name
+    classification: EntityClass
+    capabilityFlags: number
+    zCoord: number
+    defaultLabel: string
+}
+
+export interface TemplateMeta {
+    itemId: number
+    kind: Name
+    displayLabel: string
+}
+
+interface RawKindEntry {
+    kind: string
+    classification: string
+    capabilityFlags: number
+    zCoord: number
+    defaultLabel: string
+}
+
+interface RawTemplateEntry {
+    itemId: number
+    kind: string
+    displayLabel: string
+}
+
+const KIND_META: Map<string, KindMeta> = (() => {
+    const m = new Map<string, KindMeta>()
+    for (const r of kindRegistryJson.kinds as RawKindEntry[]) {
+        const cls = CLASSIFICATION_BY_NAME[r.classification]
+        if (cls === undefined) {
+            throw new Error(
+                `kind-registry: unknown classification "${r.classification}" for kind ${r.kind}`
+            )
+        }
+        m.set(r.kind, {
+            kind: Name.from(r.kind),
+            classification: cls,
+            capabilityFlags: r.capabilityFlags,
+            zCoord: r.zCoord,
+            defaultLabel: r.defaultLabel,
+        })
+    }
+    return m
+})()
+
+export const ALL_ENTITY_TYPES: readonly EntityTypeName[] = Object.freeze([
+    ...KIND_META.keys(),
+] as EntityTypeName[])
+
+const TEMPLATE_BY_ITEM_ID: Map<number, TemplateMeta> = (() => {
+    const m = new Map<number, TemplateMeta>()
+    for (const r of kindRegistryJson.templates as RawTemplateEntry[]) {
+        m.set(r.itemId, {
+            itemId: r.itemId,
+            kind: Name.from(r.kind),
+            displayLabel: r.displayLabel,
+        })
+    }
+    return m
+})()
+
+function nameKey(kind: NameType | EntityTypeName): string {
+    if (typeof kind === 'string') return kind
+    return Name.from(kind).toString()
+}
+
+export function getKindMeta(kind: NameType | EntityTypeName): KindMeta | undefined {
+    return KIND_META.get(nameKey(kind))
+}
+
+export function getTemplateMeta(itemId: number): TemplateMeta | undefined {
+    return TEMPLATE_BY_ITEM_ID.get(itemId)
+}
+
+export function getPackedEntityType(itemId: number): Name | null {
+    return TEMPLATE_BY_ITEM_ID.get(itemId)?.kind ?? null
+}
+
+export function kindCan(kind: NameType | EntityTypeName, cap: number): boolean {
+    const m = KIND_META.get(nameKey(kind))
+    return m !== undefined && (m.capabilityFlags & cap) !== 0
+}
+
+export function canCatch(kind: NameType | EntityTypeName): boolean {
+    return kindCan(kind, CAP_CATCH)
+}
+
+export function getEntityClass(kind: NameType | EntityTypeName): EntityClass {
+    const m = KIND_META.get(nameKey(kind))
+    if (!m) throw new Error(`Entity type has no class: ${nameKey(kind)}`)
+    return m.classification
+}
+
+export const ENTITY_SHIP = Name.from('ship')
+export const ENTITY_WAREHOUSE = Name.from('warehouse')
+export const ENTITY_EXTRACTOR = Name.from('extractor')
+export const ENTITY_FACTORY = Name.from('factory')
+export const ENTITY_CONTAINER = Name.from('container')
+export const ENTITY_NEXUS = Name.from('nexus')
+export const ENTITY_PLOT = Name.from('plot')
+export const ENTITY_MASS_DRIVER = Name.from('mdriver')
+export const ENTITY_MASS_CATCHER = Name.from('mcatcher')
+
+export function isShip(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_SHIP) ?? false
+}
+export function isWarehouse(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_WAREHOUSE) ?? false
+}
+export function isExtractor(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_EXTRACTOR) ?? false
+}
+export function isFactory(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_FACTORY) ?? false
+}
+export function isContainer(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_CONTAINER) ?? false
+}
+export function isNexus(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_NEXUS) ?? false
+}
+export function isPlot(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_PLOT) ?? false
+}
+export function isMassDriver(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_MASS_DRIVER) ?? false
+}
+export function isMassCatcher(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_MASS_CATCHER) ?? false
+}

package/src/data/metadata.ts

@@ -11,7 +11,7 @@ export interface EntityMetadata {
 }
 
 export const itemMetadata: Record<number, ItemMetadata> = {
-    // === Resources (raw) ===
+    // === Resources / Ore ===
     101: {name: 'Ore', description: 'Crude metallic ore.', color: '#C26D3F'},
     102: {name: 'Ore', description: 'Refined metallic ore with improved purity.', color: '#C26D3F'},
     103: {
@@ -19,6 +19,15 @@ export const itemMetadata: Record<number, ItemMetadata> = {
         description: 'High-grade metallic ore with exceptional density.',
         color: '#C26D3F',
     },
+    104: {name: 'Ore', description: '', color: '#C26D3F'},
+    105: {name: 'Ore', description: '', color: '#C26D3F'},
+    106: {name: 'Ore', description: '', color: '#C26D3F'},
+    107: {name: 'Ore', description: '', color: '#C26D3F'},
+    108: {name: 'Ore', description: '', color: '#C26D3F'},
+    109: {name: 'Ore', description: '', color: '#C26D3F'},
+    110: {name: 'Ore', description: '', color: '#C26D3F'},
+
+    // === Resources / Crystal ===
     201: {name: 'Crystal', description: 'Raw resonant crystal.', color: '#4ADBFF'},
     202: {
         name: 'Crystal',
@@ -30,17 +39,35 @@ export const itemMetadata: Record<number, ItemMetadata> = {
         description: 'High-grade resonant crystal with exceptional purity.',
         color: '#4ADBFF',
     },
-    301: {name: 'Gas', description: 'Raw volatile gas.', color: '#B8E4A0'},
+    204: {name: 'Crystal', description: '', color: '#4ADBFF'},
+    205: {name: 'Crystal', description: '', color: '#4ADBFF'},
+    206: {name: 'Crystal', description: '', color: '#4ADBFF'},
+    207: {name: 'Crystal', description: '', color: '#4ADBFF'},
+    208: {name: 'Crystal', description: '', color: '#4ADBFF'},
+    209: {name: 'Crystal', description: '', color: '#4ADBFF'},
+    210: {name: 'Crystal', description: '', color: '#4ADBFF'},
+
+    // === Resources / Gas ===
+    301: {name: 'Gas', description: 'Raw volatile gas.', color: '#B877FF'},
     302: {
         name: 'Gas',
         description: 'Refined volatile gas with improved reactivity.',
-        color: '#B8E4A0',
+        color: '#B877FF',
     },
     303: {
         name: 'Gas',
         description: 'High-grade volatile gas with exceptional energy density.',
-        color: '#B8E4A0',
-    },
+        color: '#B877FF',
+    },
+    304: {name: 'Gas', description: '', color: '#B877FF'},
+    305: {name: 'Gas', description: '', color: '#B877FF'},
+    306: {name: 'Gas', description: '', color: '#B877FF'},
+    307: {name: 'Gas', description: '', color: '#B877FF'},
+    308: {name: 'Gas', description: '', color: '#B877FF'},
+    309: {name: 'Gas', description: '', color: '#B877FF'},
+    310: {name: 'Gas', description: '', color: '#B877FF'},
+
+    // === Resources / Regolith ===
     401: {name: 'Regolith', description: 'Crude regolith dust.', color: '#C4A57B'},
     402: {
         name: 'Regolith',
@@ -52,6 +79,15 @@ export const itemMetadata: Record<number, ItemMetadata> = {
         description: 'High-grade regolith with exceptional uniformity.',
         color: '#C4A57B',
     },
+    404: {name: 'Regolith', description: '', color: '#C4A57B'},
+    405: {name: 'Regolith', description: '', color: '#C4A57B'},
+    406: {name: 'Regolith', description: '', color: '#C4A57B'},
+    407: {name: 'Regolith', description: '', color: '#C4A57B'},
+    408: {name: 'Regolith', description: '', color: '#C4A57B'},
+    409: {name: 'Regolith', description: '', color: '#C4A57B'},
+    410: {name: 'Regolith', description: '', color: '#C4A57B'},
+
+    // === Resources / Biomass ===
     501: {name: 'Biomass', description: 'Crude organic biomass.', color: '#5A8B3E'},
     502: {
         name: 'Biomass',
@@ -63,60 +99,74 @@ export const itemMetadata: Record<number, ItemMetadata> = {
         description: 'High-grade biomass with exceptional saturation.',
         color: '#5A8B3E',
     },
+    504: {name: 'Biomass', description: '', color: '#5A8B3E'},
+    505: {name: 'Biomass', description: '', color: '#5A8B3E'},
+    506: {name: 'Biomass', description: '', color: '#5A8B3E'},
+    507: {name: 'Biomass', description: '', color: '#5A8B3E'},
+    508: {name: 'Biomass', description: '', color: '#5A8B3E'},
+    509: {name: 'Biomass', description: '', color: '#5A8B3E'},
+    510: {name: 'Biomass', description: '', color: '#5A8B3E'},
 
     // === Components (T1) ===
     10001: {
-        name: 'Hull Plates',
-        description: 'Structural plating formed from ore. Used in hulls, containers, and frames.',
+        name: 'Plate',
+        description:
+            'Structural plating formed from ore. Used in hulls, containers, and storage modules.',
         color: '#7B8D9E',
     },
     10002: {
-        name: 'Cargo Lining',
+        name: 'Frame',
         description:
-            'Composite lining formed from fine regolith bound in biomass polymer. Dense enough to seal cargo holds, flexible enough to absorb vibration.',
+            'Composite framing formed from fine regolith bound in biomass polymer. Dense enough to seal cargo holds, flexible enough to absorb vibration.',
         color: '#C4A57B',
     },
     10003: {
-        name: 'Thruster Core',
-        description: 'High-energy propulsion component formed from volatile gases.',
+        name: 'Plasma Cell',
+        description:
+            'High-energy gaseous storage cell. Volatile gas held under controlled thermal conditions.',
         color: '#E86344',
     },
     10004: {
-        name: 'Power Cell',
+        name: 'Resonator',
         description:
-            'Crystalline energy storage matrix. Resonant lattices retain and release charge.',
+            'Crystalline resonance lattice. Stores and releases charge through coherent oscillation.',
         color: '#4ADBFF',
     },
     10005: {
-        name: 'Matter Conduit',
-        description: 'Heavy-duty ore shaft used in gathering equipment.',
+        name: 'Beam',
+        description:
+            'Heavy-duty structural beam machined from refined ore. Strong enough to bear load, tolerant enough to survive harsh environments.',
         color: '#7B8D9E',
     },
     10006: {
-        name: 'Survey Probe',
-        description: 'Crystal-lattice sensor array for deep resource detection.',
+        name: 'Sensor',
+        description:
+            'Crystal-lattice sensing element with conductive and reflective properties. Reads signal and surface alike.',
         color: '#4ADBFF',
     },
     10007: {
-        name: 'Cargo Arm',
-        description: 'Flexible biomass composite arm for cargo handling.',
+        name: 'Polymer',
+        description:
+            'Pliable biomass-derived polymer with high insulation. Flexible, durable, electrically inert.',
         color: '#5A8B3E',
     },
     10008: {
-        name: 'Tool Bit',
-        description: 'Dense regolith cutting head for crafting operations.',
+        name: 'Ceramic',
+        description:
+            'Hardened fine-grained ceramic refined from regolith. Hard enough to cut, fine enough to finish.',
         color: '#C4A57B',
     },
     10009: {
-        name: 'Reaction Chamber',
-        description: 'Gas-pressurized vessel for controlled crafting reactions.',
-        color: '#B8E4A0',
+        name: 'Reactor',
+        description:
+            'Gas-pressurized vessel for controlled reactions. Vents heat and contains volatility.',
+        color: '#B877FF',
     },
     10010: {
-        name: 'Focusing Array',
+        name: 'Resin',
         description:
-            "Precision-formed crystal lens array. Routes the haul beam's energy efficiently to the target lock.",
-        color: '#4ADBFF',
+            'Saturated organic binder cured from biomass. A pliable matrix for haulage and field components.',
+        color: '#5A8B3E',
     },
 
     // === Modules (T1) ===
@@ -144,11 +194,11 @@ export const itemMetadata: Record<number, ItemMetadata> = {
         name: 'Crafter',
         description:
             'Basic crafting system. Processes materials using reaction chambers and cutting tools.',
-        color: '#B8E4A0',
+        color: '#B877FF',
     },
     10105: {
-        name: 'Storage',
-        description: 'Expands cargo capacity based on hull material quality.',
+        name: 'Cargo Bay',
+        description: 'Expanded cargo storage with reinforced internal holds.',
         color: '#8B7355',
     },
     10106: {
@@ -163,6 +213,16 @@ export const itemMetadata: Record<number, ItemMetadata> = {
             'Folds local space-time around the hull, projecting the ship across vast distances in a single discharge of the entire energy reserve.',
         color: '#9be4ff',
     },
+    10108: {
+        name: 'Battery Bank',
+        description: 'Stores additional charge produced by generators.',
+        color: '#4ADBFF',
+    },
+    10109: {
+        name: 'Drive Coil',
+        description: 'Accelerates and launches cargo payloads toward a remote mass catcher.',
+        color: '#E86344',
+    },
 
     // === Entities (packed, T1) ===
     10200: {
@@ -180,17 +240,39 @@ export const itemMetadata: Record<number, ItemMetadata> = {
         description: 'Massive stationary storage facility with a single loader module slot.',
         color: '#EAB308',
     },
+    10203: {
+        name: 'Extractor',
+        description:
+            'Planetary resource extraction facility with generator and gatherer module slots.',
+        color: '#D4726F',
+    },
+    10204: {
+        name: 'Factory',
+        description: 'Planetary fabrication facility with generator and crafter module slots.',
+        color: '#7BA7D4',
+    },
+    10205: {
+        name: 'Mass Driver',
+        description: 'Planetary launch platform with generator and drive coil module slots.',
+        color: '#E86344',
+    },
+    10206: {
+        name: 'Mass Catcher',
+        description:
+            'Planetary receiving platform with storage module slots; catches launched payloads.',
+        color: '#4AE898',
+    },
 
     // === Components (T2) ===
     20001: {
-        name: 'Hull Plates',
+        name: 'Plate',
         description: 'Advanced structural plating reinforced with tier 2 ore.',
         color: '#9BADB8',
     },
     20002: {
-        name: 'Cargo Lining',
+        name: 'Frame',
         description:
-            'Advanced composite lining reinforced with tier 2 regolith and biomass polymer.',
+            'Advanced composite framing reinforced with tier 2 regolith and biomass polymer.',
         color: '#C4A57B',
     },
 
@@ -205,6 +287,10 @@ export const itemMetadata: Record<number, ItemMetadata> = {
 export const entityMetadata: Record<number, EntityMetadata> = {
     10201: {moduleSlotLabels: ['Engine', 'Generator', 'Gatherer', 'Loader', 'Storage']},
     10202: {moduleSlotLabels: ['Loader', 'Storage', 'Storage', 'Storage', 'Storage']},
+    10203: {moduleSlotLabels: ['Generator', 'Gatherer']},
+    10204: {moduleSlotLabels: ['Generator', 'Crafter']},
+    10205: {moduleSlotLabels: ['Generator', 'Drive Coil']},
+    10206: {moduleSlotLabels: ['Storage', 'Storage', 'Storage']},
 }
 
 for (const item of items as Array<{id: number}>) {

package/src/data/recipes-runtime.ts

@@ -1,20 +1,12 @@
-import items from './items.json'
 import recipes from './recipes.json'
 import entities from './entities.json'
 
-import {getItem} from './catalog'
-import type {Item, ModuleType, ResourceCategory} from '../types'
+import type {ModuleType} from '../types'
 
-export interface RecipeInputItemId {
+export interface RecipeInput {
     itemId: number
     quantity: number
 }
-export interface RecipeInputCategory {
-    category: ResourceCategory
-    tier: number
-    quantity: number
-}
-export type RecipeInput = RecipeInputItemId | RecipeInputCategory
 
 export interface StatSlot {
     sources: {inputIndex: number; statIndex: number}[]
@@ -30,6 +22,7 @@ export interface Recipe {
 
 export interface EntitySlot {
     type: ModuleType
+    outputPct: number
 }
 
 export interface EntityLayout {
@@ -43,13 +36,6 @@ for (const r of recipes as any[]) recipesById.set(r.outputItemId, r as Recipe)
 const entitiesById = new Map<number, EntityLayout>()
 for (const e of entities as any[]) entitiesById.set(e.entityItemId, e as EntityLayout)
 
-const resourceByCategoryTier = new Map<string, Item>()
-for (const raw of items as any[]) {
-    if (raw.type === 'resource') {
-        resourceByCategoryTier.set(`${raw.category}:${raw.tier}`, getItem(raw.id))
-    }
-}
-
 export function getRecipe(outputItemId: number): Recipe | undefined {
     return recipesById.get(outputItemId)
 }
@@ -57,9 +43,3 @@ export function getRecipe(outputItemId: number): Recipe | undefined {
 export function getEntityLayout(entityItemId: number): EntityLayout | undefined {
     return entitiesById.get(entityItemId)
 }
-
-export function findItemByCategoryAndTier(category: ResourceCategory, tier: number): Item {
-    const item = resourceByCategoryTier.get(`${category}:${tier}`)
-    if (!item) throw new Error(`No resource found for category=${category} tier=${tier}`)
-    return item
-}