@shipload/sdk 1.0.0-next.7 → 1.0.0-next.71

package/src/data/kind-registry.json

@@ -0,0 +1,212 @@
+{
+  "kinds": [
+    {
+      "kind": "ship",
+      "classification": "OrbitalVessel",
+      "capabilityFlags": 19,
+      "zCoord": 800,
+      "defaultLabel": "Ship"
+    },
+    {
+      "kind": "warehouse",
+      "classification": "OrbitalStructure",
+      "capabilityFlags": 20,
+      "zCoord": 0,
+      "defaultLabel": "Warehouse"
+    },
+    {
+      "kind": "extractor",
+      "classification": "OrbitalStructure",
+      "capabilityFlags": 20,
+      "zCoord": 0,
+      "defaultLabel": "Mining Rig"
+    },
+    {
+      "kind": "factory",
+      "classification": "OrbitalStructure",
+      "capabilityFlags": 20,
+      "zCoord": 0,
+      "defaultLabel": "Factory"
+    },
+    {
+      "kind": "mdriver",
+      "classification": "OrbitalStructure",
+      "capabilityFlags": 20,
+      "zCoord": 0,
+      "defaultLabel": "Mass Driver"
+    },
+    {
+      "kind": "mcatcher",
+      "classification": "OrbitalStructure",
+      "capabilityFlags": 28,
+      "zCoord": 0,
+      "defaultLabel": "Mass Catcher"
+    },
+    {
+      "kind": "container",
+      "classification": "OrbitalVessel",
+      "capabilityFlags": 3,
+      "zCoord": 300,
+      "defaultLabel": "Container"
+    },
+    {
+      "kind": "nexus",
+      "classification": "OrbitalStructure",
+      "capabilityFlags": 0,
+      "zCoord": 0,
+      "defaultLabel": "Nexus"
+    },
+    {
+      "kind": "plot",
+      "classification": "Plot",
+      "capabilityFlags": 0,
+      "zCoord": 0,
+      "defaultLabel": "Plot"
+    },
+    {
+      "kind": "hub",
+      "classification": "OrbitalStructure",
+      "capabilityFlags": 4,
+      "zCoord": 0,
+      "defaultLabel": "Station Hub"
+    },
+    {
+      "kind": "workshop",
+      "classification": "PlanetaryStructure",
+      "capabilityFlags": 0,
+      "zCoord": 0,
+      "defaultLabel": "Workshop"
+    },
+    {
+      "kind": "builddock",
+      "classification": "OrbitalStructure",
+      "capabilityFlags": 0,
+      "zCoord": 0,
+      "defaultLabel": "Construction Dock"
+    },
+    {
+      "kind": "depot",
+      "classification": "PlanetaryStructure",
+      "capabilityFlags": 32,
+      "zCoord": 0,
+      "defaultLabel": "Depot"
+    }
+  ],
+  "templates": [
+    {
+      "itemId": 10201,
+      "kind": "ship",
+      "displayLabel": "Ship"
+    },
+    {
+      "itemId": 10210,
+      "kind": "ship",
+      "displayLabel": "Roustabout"
+    },
+    {
+      "itemId": 10211,
+      "kind": "ship",
+      "displayLabel": "Prospector"
+    },
+    {
+      "itemId": 10212,
+      "kind": "ship",
+      "displayLabel": "Tender"
+    },
+    {
+      "itemId": 10213,
+      "kind": "ship",
+      "displayLabel": "Wright"
+    },
+    {
+      "itemId": 10214,
+      "kind": "ship",
+      "displayLabel": "Tug"
+    },
+    {
+      "itemId": 10215,
+      "kind": "ship",
+      "displayLabel": "Porter"
+    },
+    {
+      "itemId": 10218,
+      "kind": "ship",
+      "displayLabel": "Smith"
+    },
+    {
+      "itemId": 10202,
+      "kind": "warehouse",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 10203,
+      "kind": "extractor",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 10204,
+      "kind": "factory",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 10205,
+      "kind": "mdriver",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 10206,
+      "kind": "mcatcher",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 10200,
+      "kind": "container",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 11200,
+      "kind": "container",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 10207,
+      "kind": "hub",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 10208,
+      "kind": "workshop",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 10209,
+      "kind": "builddock",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 10216,
+      "kind": "nexus",
+      "displayLabel": ""
+    },
+    {
+      "itemId": 11212,
+      "kind": "ship",
+      "displayLabel": "Prospector"
+    },
+    {
+      "itemId": 11213,
+      "kind": "ship",
+      "displayLabel": "Prospector"
+    },
+    {
+      "itemId": 11214,
+      "kind": "ship",
+      "displayLabel": "Dredger"
+    },
+    {
+      "itemId": 10219,
+      "kind": "depot",
+      "displayLabel": ""
+    }
+  ]
+}

package/src/data/kind-registry.ts

@@ -0,0 +1,192 @@
+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 const CAP_STORE_CARGO = 0x20
+
+export enum EntityClass {
+    OrbitalVessel = 0,
+    PlanetaryStructure = 1,
+    Plot = 2,
+    OrbitalStructure = 3,
+}
+
+const CLASSIFICATION_BY_NAME: Record<string, EntityClass> = {
+    OrbitalVessel: EntityClass.OrbitalVessel,
+    PlanetaryStructure: EntityClass.PlanetaryStructure,
+    Plot: EntityClass.Plot,
+    OrbitalStructure: EntityClass.OrbitalStructure,
+}
+
+export type EntityTypeName =
+    | 'ship'
+    | 'warehouse'
+    | 'extractor'
+    | 'factory'
+    | 'builddock'
+    | 'workshop'
+    | 'container'
+    | 'nexus'
+    | 'plot'
+    | 'mdriver'
+    | 'mcatcher'
+    | 'hub'
+    | 'depot'
+
+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 canStoreCargo(kind: NameType | EntityTypeName): boolean {
+    return kindCan(kind, CAP_STORE_CARGO)
+}
+
+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_CONSTRUCTION_DOCK = Name.from('builddock')
+export const ENTITY_WORKSHOP = Name.from('workshop')
+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 const ENTITY_HUB = Name.from('hub')
+export const ENTITY_DEPOT = Name.from('depot')
+
+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 isConstructionDock(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_CONSTRUCTION_DOCK) ?? false
+}
+export function isWorkshop(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_WORKSHOP) ?? 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
+}
+export function isHub(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_HUB) ?? false
+}
+export function isDepot(entity: {type?: Name}): boolean {
+    return entity.type?.equals(ENTITY_DEPOT) ?? false
+}