@shipload/sdk 1.0.0-next.26 → 1.0.0-next.28

package/src/scheduling/availability.ts

@@ -0,0 +1,108 @@
+import type {ServerContract} from '../contracts'
+import {TaskType} from '../types'
+import * as schedule from './schedule'
+
+type Task = ServerContract.Types.task
+type CargoItem = ServerContract.Types.cargo_item
+
+export interface CargoEffect {
+    added: CargoItem[]
+    removed: CargoItem[]
+}
+
+export interface AvailabilityInput extends schedule.ScheduleData {
+    cargo: CargoItem[]
+}
+
+export function taskCargoEffect(task: Task): CargoEffect {
+    switch (task.type.toNumber()) {
+        case TaskType.LOAD:
+        case TaskType.UNWRAP:
+        case TaskType.UNDEPLOY:
+            return {added: task.cargo, removed: []}
+        case TaskType.UNLOAD:
+            return {added: [], removed: task.cargo}
+        case TaskType.GATHER:
+            return task.entitytarget ? {added: [], removed: []} : {added: task.cargo, removed: []}
+        case TaskType.CRAFT:
+            if (task.cargo.length === 0) return {added: [], removed: []}
+            return {added: [task.cargo[task.cargo.length - 1]], removed: task.cargo.slice(0, -1)}
+        case TaskType.DEPLOY:
+            return task.cargo.length > 0
+                ? {added: [], removed: [task.cargo[0]]}
+                : {added: [], removed: []}
+        default:
+            return {added: [], removed: []}
+    }
+}
+
+function cargoKey(item: CargoItem): string {
+    const base = `${item.item_id.toNumber()}:${item.stats.toString()}`
+    const modules = item.modules ?? []
+    const entityId = item.entity_id?.toString()
+    const normalizedEntityId = entityId && entityId !== '0' ? entityId : ''
+    if (modules.length === 0 && normalizedEntityId === '') return base
+    return `${base}:modules=${JSON.stringify(modules)}:entity=${normalizedEntityId}`
+}
+
+function cargoQuantity(item: CargoItem): bigint {
+    return BigInt(item.quantity.toString())
+}
+
+export function projectedCargoAvailableAt(
+    entity: AvailabilityInput,
+    at: Date
+): Map<string, bigint> {
+    const avail = new Map<string, bigint>()
+
+    for (const item of entity.cargo) {
+        const key = cargoKey(item)
+        avail.set(key, (avail.get(key) ?? 0n) + cargoQuantity(item))
+    }
+
+    // Every scheduled task reserves inputs against the unsettled cargo base, even already-elapsed ones.
+    const tasks = schedule.orderedTasks(entity)
+
+    for (const ordered of tasks) {
+        if (ordered.completesAt.getTime() >= at.getTime()) continue
+
+        for (const item of taskCargoEffect(ordered.task).added) {
+            const key = cargoKey(item)
+            avail.set(key, (avail.get(key) ?? 0n) + cargoQuantity(item))
+        }
+    }
+
+    for (const ordered of tasks) {
+        for (const item of taskCargoEffect(ordered.task).removed) {
+            const key = cargoKey(item)
+            const current = avail.get(key) ?? 0n
+            const quantity = cargoQuantity(item)
+            avail.set(key, current > quantity ? current - quantity : 0n)
+        }
+    }
+
+    return avail
+}
+
+// Latest completion among scheduled tasks producing any of the given inputs (a craft starts no earlier).
+export function cargoReadyAt(entity: AvailabilityInput, inputItemIds: readonly number[]): Date {
+    let readyMs = 0
+    for (const ordered of schedule.orderedTasks(entity)) {
+        for (const item of taskCargoEffect(ordered.task).added) {
+            if (inputItemIds.includes(item.item_id.toNumber())) {
+                readyMs = Math.max(readyMs, ordered.completesAt.getTime())
+                break
+            }
+        }
+    }
+    return new Date(readyMs)
+}
+
+export function availableForItem(avail: Map<string, bigint>, itemId: number): bigint {
+    const prefix = `${itemId}:`
+    let total = 0n
+    for (const [key, quantity] of avail) {
+        if (key.startsWith(prefix)) total += quantity
+    }
+    return total
+}

package/src/scheduling/energy.ts

@@ -1,6 +1,6 @@
 import {TaskType} from '../types'
 import {createProjectedEntity, type Projectable} from './projection'
-import {currentTaskIndex, currentTaskProgressFloat, isTaskComplete} from './schedule'
+import {orderedTasks} from './schedule'
 
 export function energyAtTime(entity: Projectable, now: Date): number {
     const projected = createProjectedEntity(entity)
@@ -13,24 +13,31 @@ export function energyAtTime(entity: Projectable, now: Date): number {
 
     let running = Number(projected.energy)
 
-    const tasks = entity.schedule?.tasks
-    if (!tasks || tasks.length === 0) return clamp(running)
+    const ordered = orderedTasks(entity)
+    if (ordered.length === 0) return clamp(running)
 
-    const activeIndex = currentTaskIndex(entity, now)
-    const activeProgress = currentTaskProgressFloat(entity, now)
+    const nowMs = now.getTime()
 
-    for (let i = 0; i < tasks.length; i++) {
-        const complete = isTaskComplete(entity, i, now)
-        if (!complete && i !== activeIndex) break
+    for (const {task, startsAt} of ordered) {
+        const duration = task.duration.toNumber()
+        const isReserved = task.type.toNumber() === TaskType.RESERVED
+        const elapsed = Math.min(
+            Math.max(0, Math.floor((nowMs - startsAt.getTime()) / 1000)),
+            duration
+        )
+        const complete = !isReserved && elapsed >= duration
+        const inProgress = !complete && elapsed > 0 && elapsed < duration
 
-        const fraction = complete ? 1 : activeProgress
+        if (!complete && !inProgress) continue
 
-        if (tasks[i].type.toNumber() === TaskType.RECHARGE) {
+        const fraction = complete ? 1 : duration === 0 ? 1 : elapsed / duration
+
+        if (task.type.toNumber() === TaskType.RECHARGE) {
             if (capacity !== undefined) {
                 running = complete ? capacity : running + (capacity - running) * fraction
             }
         } else {
-            const cost = Number(tasks[i].energy_cost ?? 0)
+            const cost = Number(task.energy_cost ?? 0)
             running -= cost * fraction
         }
 

package/src/scheduling/lane-core.ts

@@ -0,0 +1,130 @@
+import type {ServerContract} from '../contracts'
+import {TaskType} from '../types'
+
+type Schedule = ServerContract.Types.schedule
+type Task = ServerContract.Types.task
+
+export function laneDuration(schedule: Schedule): number {
+    return schedule.tasks.reduce((sum, task) => sum + task.duration.toNumber(), 0)
+}
+
+export function laneRawElapsed(schedule: Schedule, now: Date): number {
+    const started = schedule.started.toDate()
+    return Math.floor((now.getTime() - started.getTime()) / 1000)
+}
+
+export function laneElapsed(schedule: Schedule, now: Date): number {
+    return Math.max(0, laneRawElapsed(schedule, now))
+}
+
+export function laneStartsIn(schedule: Schedule, now: Date): number {
+    return Math.max(0, -laneRawElapsed(schedule, now))
+}
+
+export function laneRemaining(schedule: Schedule, now: Date): number {
+    return Math.max(0, laneDuration(schedule) - laneRawElapsed(schedule, now))
+}
+
+export function laneComplete(schedule: Schedule, now: Date): boolean {
+    if (schedule.tasks.length === 0) return false
+    if (schedule.tasks.some((t) => t.type.toNumber() === TaskType.RESERVED)) return false
+    return laneRemaining(schedule, now) === 0
+}
+
+export function laneProgress(schedule: Schedule, now: Date): number {
+    const duration = laneDuration(schedule)
+    if (duration === 0) return schedule.tasks.length > 0 ? 1 : 0
+    return Math.min(1, laneElapsed(schedule, now) / duration)
+}
+
+export function currentTaskIndexForLane(schedule: Schedule, now: Date): number {
+    if (schedule.tasks.length === 0) return -1
+    if (laneRawElapsed(schedule, now) < 0) return -1
+    const elapsed = laneElapsed(schedule, now)
+    let timeAccum = 0
+    for (let i = 0; i < schedule.tasks.length; i++) {
+        const taskDuration = schedule.tasks[i].duration.toNumber()
+        if (elapsed < timeAccum + taskDuration) return i
+        timeAccum += taskDuration
+    }
+    return -1
+}
+
+export function currentTask(schedule: Schedule, now: Date): Task | undefined {
+    const index = currentTaskIndexForLane(schedule, now)
+    if (index < 0) return undefined
+    return schedule.tasks[index]
+}
+
+export function currentTaskType(schedule: Schedule, now: Date): TaskType | undefined {
+    const task = currentTask(schedule, now)
+    return task ? (task.type.toNumber() as TaskType) : undefined
+}
+
+export function laneTaskStartTime(schedule: Schedule, index: number): number {
+    if (index < 0 || index >= schedule.tasks.length) return 0
+    let timeAccum = 0
+    for (let i = 0; i < index; i++) {
+        timeAccum += schedule.tasks[i].duration.toNumber()
+    }
+    return timeAccum
+}
+
+export function laneTaskElapsed(schedule: Schedule, index: number, now: Date): number {
+    if (index < 0 || index >= schedule.tasks.length) return 0
+    const elapsed = laneElapsed(schedule, now)
+    const taskStart = laneTaskStartTime(schedule, index)
+    const taskDuration = schedule.tasks[index].duration.toNumber()
+    if (elapsed <= taskStart) return 0
+    return Math.min(elapsed - taskStart, taskDuration)
+}
+
+export function laneTaskRemaining(schedule: Schedule, index: number, now: Date): number {
+    if (index < 0 || index >= schedule.tasks.length) return 0
+    const taskDuration = schedule.tasks[index].duration.toNumber()
+    return Math.max(0, taskDuration - laneTaskElapsed(schedule, index, now))
+}
+
+export function laneTaskComplete(schedule: Schedule, index: number, now: Date): boolean {
+    if (index < 0 || index >= schedule.tasks.length) return false
+    if (schedule.tasks[index].type.toNumber() === TaskType.RESERVED) return false
+    const taskDuration = schedule.tasks[index].duration.toNumber()
+    return laneTaskElapsed(schedule, index, now) >= taskDuration
+}
+
+export function laneTaskInProgress(schedule: Schedule, index: number, now: Date): boolean {
+    if (index < 0 || index >= schedule.tasks.length) return false
+    const taskElapsed = laneTaskElapsed(schedule, index, now)
+    const taskDuration = schedule.tasks[index].duration.toNumber()
+    return taskElapsed > 0 && taskElapsed < taskDuration
+}
+
+export function laneCompletesAt(schedule: Schedule, index: number): Date {
+    const startedMs = schedule.started.toDate().getTime()
+    const endSec =
+        laneTaskStartTime(schedule, index) + (schedule.tasks[index]?.duration.toNumber() ?? 0)
+    return new Date(startedMs + endSec * 1000)
+}
+
+export function currentTaskProgress(schedule: Schedule, now: Date): number {
+    const index = currentTaskIndexForLane(schedule, now)
+    if (index < 0) return 0
+    const elapsed = laneTaskElapsed(schedule, index, now)
+    const duration = schedule.tasks[index].duration.toNumber()
+    if (duration === 0) return 1
+    return Math.min(1, elapsed / duration)
+}
+
+export function currentTaskProgressFloatForLane(schedule: Schedule, now: Date): number {
+    if (schedule.tasks.length === 0) return 0
+    const index = currentTaskIndexForLane(schedule, now)
+    if (index < 0) return 0
+    const task = schedule.tasks[index]
+    const durationMs = task.duration.toNumber() * 1000
+    if (durationMs === 0) return 1
+    const startedMs = schedule.started.toDate().getTime()
+    const taskStartMs = startedMs + laneTaskStartTime(schedule, index) * 1000
+    const elapsedMs = now.getTime() - taskStartMs
+    if (elapsedMs <= 0) return 0
+    return Math.min(1, elapsedMs / durationMs)
+}

package/src/scheduling/lanes.ts

@@ -0,0 +1,60 @@
+import type {ServerContract} from '../contracts'
+import {getItem} from '../data/catalog'
+import type {ModuleType} from '../types'
+import {getLane, type ScheduleData} from './schedule'
+
+type ModuleEntry = ServerContract.Types.module_entry
+type Lane = ServerContract.Types.lane
+type Schedule = ServerContract.Types.schedule
+
+export function laneKeyForModule(slotIndex: number): number {
+    return slotIndex + 1
+}
+
+function laneIsFree(lanes: Lane[], laneKey: number): boolean {
+    const lane = lanes.find((entry) => entry.lane_key.toNumber() === laneKey)
+    return lane ? lane.schedule.tasks.length === 0 : true
+}
+
+export function workerLaneKey(
+    modules: ModuleEntry[],
+    moduleSubtype: ModuleType,
+    lanes: Lane[]
+): number {
+    const occupiedMatchingLaneKeys: number[] = []
+
+    for (let slotIndex = 0; slotIndex < modules.length; slotIndex++) {
+        const installed = modules[slotIndex].installed
+        if (!installed) continue
+        if (getItem(installed.item_id).moduleType !== moduleSubtype) continue
+
+        const laneKey = laneKeyForModule(slotIndex)
+        if (laneIsFree(lanes, laneKey)) return laneKey
+        occupiedMatchingLaneKeys.push(laneKey)
+    }
+
+    if (occupiedMatchingLaneKeys.length > 0) {
+        return Math.min(...occupiedMatchingLaneKeys)
+    }
+
+    throw new Error(`No installed ${moduleSubtype} worker module`)
+}
+
+export function rawScheduleEnd(schedule: Schedule): Date {
+    const durationSec = schedule.tasks.reduce((sum, task) => sum + task.duration.toNumber(), 0)
+    return new Date(schedule.started.toDate().getTime() + durationSec * 1000)
+}
+
+export function candidateLaneCompletesAt(
+    entity: ScheduleData,
+    laneKey: number,
+    durationSec: number,
+    now: Date
+): Date {
+    const lane = getLane(entity, laneKey)
+    const startMs = lane
+        ? Math.max(rawScheduleEnd(lane.schedule).getTime(), now.getTime())
+        : now.getTime()
+
+    return new Date(startMs + durationSec * 1000)
+}

package/src/scheduling/projection.ts

@@ -1,4 +1,4 @@
-import {Name, TimePoint, UInt16, UInt32, UInt64} from '@wharfkit/antelope'
+import {Name, UInt16, UInt32, UInt64} from '@wharfkit/antelope'
 import {ServerContract} from '../contracts'
 import {Coordinates, TaskType} from '../types'
 import {
@@ -333,50 +333,27 @@ export interface ProjectionOptions {
 
 export function projectEntity(entity: Projectable, options?: ProjectionOptions): ProjectedEntity {
     const projected = createProjectedEntity(entity)
-    if (!entity.schedule || entity.schedule.tasks.length === 0) return projected
+    const ordered = schedule.orderedTasks(entity)
+    if (ordered.length === 0) return projected
 
-    const tasks = entity.schedule.tasks
     const taskCount =
         options?.upToTaskIndex !== undefined
-            ? Math.max(0, Math.min(options.upToTaskIndex, tasks.length))
-            : tasks.length
+            ? Math.max(0, Math.min(options.upToTaskIndex, ordered.length))
+            : ordered.length
 
     for (let i = 0; i < taskCount; i++) {
-        applyTask(projected, tasks[i])
+        applyTask(projected, ordered[i].task)
     }
     return projected
 }
 
-export interface ProjectableSnapshot extends Projectable {
-    current_task?: ServerContract.Types.task
-    pending_tasks?: ServerContract.Types.task[]
-}
-
-function buildRemainingProjectable(snapshot: ProjectableSnapshot): Projectable | null {
-    if (!snapshot.schedule) return null
-    const remainingTasks: ServerContract.Types.task[] = []
-    if (snapshot.current_task) remainingTasks.push(snapshot.current_task)
-    if (snapshot.pending_tasks?.length) remainingTasks.push(...snapshot.pending_tasks)
-    if (remainingTasks.length === 0) return null
-
-    const completedCount = snapshot.schedule.tasks.length - remainingTasks.length
-    let startedMs = snapshot.schedule.started.toMilliseconds()
-    for (let i = 0; i < completedCount; i++) {
-        startedMs += snapshot.schedule.tasks[i].duration.toNumber() * 1000
-    }
-
-    return {
-        ...snapshot,
-        schedule: ServerContract.Types.schedule.from({
-            started: TimePoint.fromMilliseconds(startedMs),
-            tasks: remainingTasks,
-        }),
+export function projectRemainingAt(entity: Projectable, _now: Date): ProjectedEntity {
+    // Resolve is lazy/entity-global: completed tasks are unsettled until resolve, so replay all.
+    const projected = createProjectedEntity(entity)
+    for (const {task} of schedule.orderedTasks(entity)) {
+        applyTask(projected, task)
     }
-}
-
-export function projectFromCurrentState(snapshot: ProjectableSnapshot): ProjectedEntity {
-    const projectable = buildRemainingProjectable(snapshot)
-    return projectable ? projectEntity(projectable) : createProjectedEntity(snapshot)
+    return projected
 }
 
 function getRecipeInputsForOutput(outputItemId: number): RecipeInput[] | undefined {
@@ -438,10 +415,11 @@ function validateCraftTask(task: ServerContract.Types.task, projected: Projected
 }
 
 export function validateSchedule(entity: Projectable): void {
-    if (!entity.schedule || entity.schedule.tasks.length === 0) return
+    const ordered = schedule.orderedTasks(entity)
+    if (ordered.length === 0) return
 
     const projected = createProjectedEntity(entity)
-    for (const task of entity.schedule.tasks) {
+    for (const {task} of ordered) {
         if (task.type.toNumber() === TaskType.CRAFT) {
             validateCraftTask(task, projected)
         }
@@ -455,22 +433,28 @@ export function validateSchedule(entity: Projectable): void {
 export function projectEntityAt(entity: Projectable, now: Date): ProjectedEntity {
     const projected = createProjectedEntity(entity)
 
-    if (!entity.schedule || entity.schedule.tasks.length === 0) {
+    const ordered = schedule.orderedTasks(entity)
+    if (ordered.length === 0) {
         return projected
     }
 
-    for (let i = 0; i < entity.schedule.tasks.length; i++) {
-        const task = entity.schedule.tasks[i]
-        const taskComplete = schedule.isTaskComplete(entity, i, now)
-        const taskInProgress = schedule.isTaskInProgress(entity, i, now)
+    const nowMs = now.getTime()
+
+    for (const {task, startsAt} of ordered) {
+        const duration = task.duration.toNumber()
+        const isReserved = task.type.toNumber() === TaskType.RESERVED
+        const elapsed = Math.min(
+            Math.max(0, Math.floor((nowMs - startsAt.getTime()) / 1000)),
+            duration
+        )
+        const taskComplete = !isReserved && elapsed >= duration
+        const taskInProgress = elapsed > 0 && elapsed < duration
 
         if (!taskComplete && !taskInProgress) {
-            break
+            continue
         }
 
-        const progress = taskInProgress
-            ? schedule.getTaskElapsed(entity, i, now) / task.duration.toNumber()
-            : undefined
+        const progress = taskInProgress ? elapsed / duration : undefined
 
         switch (task.type.toNumber()) {
             case TaskType.RECHARGE:
@@ -504,11 +488,3 @@ export function projectEntityAt(entity: Projectable, now: Date): ProjectedEntity
 
     return projected
 }
-
-export function projectFromCurrentStateAt(
-    snapshot: ProjectableSnapshot,
-    now: Date
-): ProjectedEntity {
-    const projectable = buildRemainingProjectable(snapshot)
-    return projectable ? projectEntityAt(projectable, now) : createProjectedEntity(snapshot)
-}