dockware-core/ai.dockware.core.shipments/ShipmentsRepository

ShipmentsRepository

interface ShipmentsRepository

Core repository for managing Dockware shipments, scans, and associated entries.

This repository serves as the single source of truth for shipment data, providing reactive streams (StateFlow) for UI observation and suspended functions for data manipulation and API interaction.

Types

Companion

object Companion

UpdateShipmentScanRequest

data class UpdateShipmentScanRequest(val body: Map<String, Any?> = emptyMap())

Properties

sharedShipments

abstract val sharedShipments: StateFlow<List<Shipment>>

sharingLinks

abstract val sharingLinks: StateFlow<ShipmentSharingLinks>

shipmentEntries

abstract val shipmentEntries: StateFlow<Map<String, List<ShipmentEntry>>>

shipments

abstract val shipments: StateFlow<List<Shipment>>

shipmentScans

abstract val shipmentScans: StateFlow<Map<String, List<ShipmentScan>>>

shipmentTrees

abstract val shipmentTrees: StateFlow<List<ShipmentTree>>

Functions

archiveShipment

abstract suspend fun archiveShipment(shipmentId: String): Result<Shipment>

Soft-deletes a shipment, moving it to the archive.

archiveShipments

abstract suspend fun archiveShipments(shipmentIds: List<String>): Result<List<Shipment>>

Batch soft-deletes multiple shipments.

archiveShipmentScan

abstract suspend fun archiveShipmentScan(shipmentScanId: String): Result<ShipmentScan>

Deletes a specific scan record.

clearShipments

abstract fun clearShipments()

createPickTicketShipmentEntry

abstract suspend fun createPickTicketShipmentEntry(shipmentId: String, shipmentScanId: String, jobId: String, fileName: String): Result<ShipmentEntry>

Creates an entry linking a previously uploaded pick ticket to a specific shipment and scan.

createShipment

abstract suspend fun createShipment(title: String, metadata: Map<String, Any>? = null): Result<Shipment>

Creates a new shipment.

createShipmentScan

abstract suspend fun createShipmentScan(shipmentId: String, title: String, dimensions: Dimensions?, weight: Float?, freightClass: String?, locationData: LocationData?, notes: String?, status: String?, scanType: ShipmentScanType = ShipmentScanType.DOCUMENT): Result<ShipmentScan>

Records a new scan event for a shipment.

downloadImageFile

abstract suspend fun downloadImageFile(storagePath: String): Result<ByteArray>

downloadPLYFile

abstract suspend fun downloadPLYFile(storagePath: String): Result<ByteArray>

downloadUrl

abstract suspend fun downloadUrl(url: String): Result<ByteArray>

Downloads the image bytes of a URL.

fetchAllShipmentData

abstract suspend fun fetchAllShipmentData(pollScansEvery: Long? = POLLING_INTERVAL_MS, updatedAfter: String? = null, updatedBefore: String? = null): Result<List<ShipmentTree>>

Triggers a full refresh of all shipment data, including scans and entries.

fetchMostRecentShipmentEntries

abstract suspend fun fetchMostRecentShipmentEntries(shipmentIds: List<String>): Result<Map<String, List<ShipmentEntry>>>

Fetches the most recent entries for a list of shipments (e.g., latest thumbnail and PLY file).

fetchSharingLinksCreatedByMe

abstract suspend fun fetchSharingLinksCreatedByMe(): Result<List<ShipmentSharing>>

Fetches shipment sharing links that the user created to share with others.

fetchSharingLinksSharedWithMe

abstract suspend fun fetchSharingLinksSharedWithMe(): Result<List<ShipmentSharing>>

Fetches shipment sharing links where the user is the recipient.

fetchShipmentAndScans

abstract suspend fun fetchShipmentAndScans(shipmentId: String): Result<Pair<Shipment, List<ShipmentScan>>>

Fetches both the shipment details and its scans in parallel.

fetchShipmentEntries

abstract suspend fun fetchShipmentEntries(shipmentScanId: String): Result<List<ShipmentEntry>>

Fetches all entries (files, images, point clouds) attached to a specific scan.

fetchShipmentScans

abstract suspend fun fetchShipmentScans(shipmentId: String): Result<List<ShipmentScan>>

Fetches all scans associated with a specific shipment.

abstract suspend fun fetchShipmentScans(shipmentIds: List<String>): Result<Map<String, List<ShipmentScan>>>

Fetches scans for multiple shipments in a single request.

fetchShipmentTrees

abstract suspend fun fetchShipmentTrees(pollScansEvery: Long? = POLLING_INTERVAL_MS, updatedAfter: String? = null, updatedBefore: String? = null): Result<ShipmentWithSharing>

Fetches the latest shipment hierarchy from the server.

pollShipmentTillProcessed

abstract suspend fun pollShipmentTillProcessed(shipmentId: String, interval: Long = DEFAULT_PROCESSING_POLLING_INTERVAL): Result<List<ShipmentScan>>

Polls for scans of a shipment until all scans have a completion status (processed or error), saving the state in this repository.

processCloudDimensions

abstract suspend fun processCloudDimensions(snapshotZipData: ByteArray, shipmentId: String, shipmentScanId: String, progressCallback: (String) -> Unit?, validation: SnapshotValidation): Result<Boolean>

Submits captured snapshot data to the cloud for volumetric dimensioning.

renameShipment

abstract suspend fun renameShipment(shipmentId: String, newTitle: String): Result<Shipment>

Updates the title of an existing shipment.

shareShipment

abstract suspend fun shareShipment(shipmentId: String, recipientEmail: String, expiration: String? = null): Result<ShipmentSharing>

Shares a shipment with another user via email.

unarchiveShipment

abstract suspend fun unarchiveShipment(shipmentId: String): Result<Shipment>

Restores a soft-deleted shipment from the archive.

updateShipmentMetadata

abstract suspend fun updateShipmentMetadata(shipmentId: String, metadata: Map<String, Any?>): Result<Shipment>

Updates custom metadata for a shipment without overwriting existing fields.

updateShipmentScan

abstract suspend fun updateShipmentScan(shipmentScanId: String, request: ShipmentsRepository.UpdateShipmentScanRequest): Result<ShipmentScan>

Updates a specific scan with a request built using UpdateShipmentScanRequest.Builder.

abstract suspend fun updateShipmentScan(shipmentScanId: String, metadata: Map<String, Any?>): Result<ShipmentScan>

Updates raw metadata for a specific scan.

updateShipmentScanManualDimensions

abstract suspend fun updateShipmentScanManualDimensions(shipmentScanId: String, dimensions: Dimensions): Result<ShipmentScan>

Updates a scan with manually measured dimensions.

updateShipmentScanQualityApprovedByUser

abstract suspend fun updateShipmentScanQualityApprovedByUser(scanId: String, approved: Boolean, currentMetadata: Map<String, Any?>): Result<ShipmentScan>

Updates the quality approval status for a scan, usually triggered by manual user review.

updateShipmentScanReviewed

abstract suspend fun updateShipmentScanReviewed(scanId: String, shipmentId: String, reviewed: Boolean, approved: Boolean, currentMetadata: Map<String, Any?>): Result<ShipmentScan>

Updates a review status for a scan in the metadata, additionally updating a user approval key.

updateShipmentScanType

abstract suspend fun updateShipmentScanType(scanId: String, scanType: ShipmentScanType): Result<ShipmentScan>

Changes the classification type of an existing scan.

updateShipmentScanUserDimensions

abstract suspend fun updateShipmentScanUserDimensions(shipmentScanId: String, dimensions: Dimensions, newCenter: Point3): Result<ShipmentScan>

Updates the bounding box/user-adjusted dimensions for a 3D scan.

updateShipmentScanWeight

abstract suspend fun updateShipmentScanWeight(shipmentScanId: String, weight: Float?): Result<ShipmentScan>

Updates the weight of the scanned object.

uploadBarcodes

abstract suspend fun uploadBarcodes(barcodeData: List<BaseBarcode>, shipmentId: String, shipmentScanId: String, progressCallback: (String) -> Unit?): Result<Shipment>

Uploads detected barcode data and associates it with the specified scan.

uploadImages

abstract suspend fun uploadImages(images: List<ByteArray>, shipmentId: String, shipmentScanId: String, progressCallback: (String) -> Unit?): List<Result<ShipmentStorageEntry?>>

Uploads a list of images as JPG entries for a specific scan.