@shipload/sdk 1.0.0-next.42 → 1.0.0-next.44

package/src/subscriptions/manager.cluster.test.ts

@@ -0,0 +1,46 @@
+import {afterEach, describe, expect, test} from 'bun:test'
+import {SubscriptionsManager} from './manager'
+import type {ServerMessage} from './types'
+
+function createManager(): SubscriptionsManager {
+    return new SubscriptionsManager({url: 'ws://localhost:0'})
+}
+
+function deliver(mgr: SubscriptionsManager, msg: ServerMessage) {
+    ;(mgr as unknown as {onMessage(m: ServerMessage): void}).onMessage(msg)
+}
+
+describe('cluster delta routing', () => {
+    let mgr: SubscriptionsManager | undefined
+
+    afterEach(() => {
+        mgr?.close()
+        mgr = undefined
+    })
+
+    test('routes a cluster frame to the matching entity subscription onCluster', () => {
+        mgr = createManager()
+        const received: unknown[] = []
+        const handle = mgr.subscribeEntity(42, {
+            onCluster: (p) => received.push(p),
+        })
+        deliver(mgr, {
+            type: 'cluster',
+            sub_id: handle.subId,
+            hub_id: 42,
+            seq: 7,
+            cells: [{gx: 0, gy: 1, entity: 99}],
+        })
+        expect(received).toEqual([
+            {hubId: 42, seq: 7, cells: [{gx: 0, gy: 1, entity: 99}], erased: false},
+        ])
+    })
+
+    test('an erased cluster frame yields cells:null, erased:true', () => {
+        mgr = createManager()
+        const received: unknown[] = []
+        const handle = mgr.subscribeEntity(42, {onCluster: (p) => received.push(p)})
+        deliver(mgr, {type: 'cluster', sub_id: handle.subId, hub_id: 42, seq: 8, erased: true})
+        expect(received).toEqual([{hubId: 42, seq: 8, cells: null, erased: true}])
+    })
+})

package/src/subscriptions/manager.ts

@@ -3,6 +3,8 @@ import type {
     BoundingBox,
     BoundsDeltaMessage,
     ClientMessage,
+    ClusterCellWire,
+    ClusterDeltaMessage,
     EntityDeletedMessage,
     ServerMessage,
     SnapshotMessage,
@@ -57,6 +59,12 @@ export interface EntitySubscriptionHandlers {
     ) => void
     onDeleted?: (id: string, meta: EntitySubscriptionMeta) => void
     onError?: (error: Error) => void
+    onCluster?: (payload: {
+        hubId: number
+        seq: number
+        cells: ClusterCellWire[] | null
+        erased: boolean
+    }) => void
 }
 
 export interface EntitiesSubscriptionHandle {
@@ -306,6 +314,9 @@ export class SubscriptionsManager {
             case 'entity_deleted':
                 this.handleEntityDeleted(msg)
                 break
+            case 'cluster':
+                this.handleCluster(msg)
+                break
             case 'error':
                 this.handleError(msg)
                 break
@@ -367,4 +378,15 @@ export class SubscriptionsManager {
         }
         sub.handlers.onDeleted?.(String(msg.entity_id), {seq: msg.seq})
     }
+
+    private handleCluster(msg: ClusterDeltaMessage) {
+        const sub = this.entitySubs.get(msg.sub_id)
+        if (!sub) return
+        sub.handlers.onCluster?.({
+            hubId: msg.hub_id,
+            seq: msg.seq,
+            cells: msg.erased ? null : (msg.cells ?? []),
+            erased: msg.erased === true,
+        })
+    }
 }

package/src/subscriptions/types.ts

@@ -139,6 +139,21 @@ export type ErrorMessage = {
     sub_id?: string
 }
 
+export interface ClusterCellWire {
+    gx: number
+    gy: number
+    entity: number
+}
+
+export type ClusterDeltaMessage = {
+    type: 'cluster'
+    sub_id: string
+    hub_id: number
+    seq: number
+    cells?: ClusterCellWire[]
+    erased?: boolean
+}
+
 export type ServerMessage =
     | AckMessage
     | SnapshotMessage
@@ -149,3 +164,4 @@ export type ServerMessage =
     | EventCatchupCompleteMessage
     | PongMessage
     | ErrorMessage
+    | ClusterDeltaMessage

package/src/types.ts

@@ -5,6 +5,7 @@ import {
     type UInt32,
     type UInt32Type,
     UInt64,
+    type UInt64Type,
 } from '@wharfkit/antelope'
 import {ServerContract} from './contracts'
 
@@ -25,6 +26,12 @@ export const BASE_ORBITAL_MASS = 100000
 export const MIN_TRANSFER_DISTANCE_PLANETARY_STRUCTURE = 100
 export const MIN_TRANSFER_DISTANCE_ORBITAL_VESSEL = 200
 
+export interface ClusterSlotType {
+    hub: UInt64Type
+    gx: number
+    gy: number
+}
+
 export interface ShipLike {
     coordinates: ServerContract.Types.coordinates
     hullmass?: UInt32