domain

type AllocatedQtys map[Source]int

type AvailableSources map[Source]int

type AvailableSourcesPerProduct map[ProductID]AvailableSources

type AvailableSourcesProvider interface {
	GetPossibleSources(ctx context.Context, product domain.BasicProduct, deliveryInfo *cartDomain.DeliveryInfo) ([]Source, error)
}

type DefaultSourcingService struct {
	// contains filtered or unexported fields
}

type ItemAllocation struct {
	AllocatedQtys map[ProductID]AllocatedQtys
	Error         error
}

type ItemAllocations map[ItemID]ItemAllocation

type ItemID string

type ProductID string

type Source struct {
	// LocationCode identifies the warehouse or stock location
	LocationCode string
	// ExternalLocationCode identifies the source location in an external system
	ExternalLocationCode string
}

type SourcingService interface {
	// AllocateItems returns Sources for the given item in the given cart
	// e.g. use this during place order to know
	// throws ErrInsufficientSourceQty if not enough stock is available for the amount of items in the cart
	// throws ErrNoSourceAvailable if no source is available at all for one of the items
	// throws ErrNeedMoreDetailsSourceCannotBeDetected if information on the cart (or delivery is missing)
	AllocateItems(ctx context.Context, decoratedCart *decorator.DecoratedCart) (ItemAllocations, error)

	// GetAvailableSources returns possible Sources for the product and the desired delivery.
	// Optional the existing cart can be passed so that existing items in the cart can be evaluated also (e.g. deduct stock)
	// e.g. use this before a product should be placed in the cart to know if and from where an item can be sourced
	// throws ErrNeedMoreDetailsSourceCannotBeDetected
	// throws ErrNoSourceAvailable if no source is available for the product and the given delivery
	GetAvailableSources(ctx context.Context, product domain.BasicProduct, deliveryInfo *cartDomain.DeliveryInfo, decoratedCart *decorator.DecoratedCart) (AvailableSourcesPerProduct, error)
}

type StockProvider interface {
	GetStock(ctx context.Context, product domain.BasicProduct, source Source, deliveryInfo *cartDomain.DeliveryInfo) (int, error)
}