PhoenixKitWarehouse.ColumnConfig.Stock (PhoenixKitWarehouse v0.2.1)

Copy Markdown View Source

Column registry for the warehouse stock-balances ("In stock") flat list LiveView.

Operates on enriched flat stock maps of shape %{item, display_name, sku, catalogue_name, category_name, unit_label, quantity, unit_value, total_value, min_quantity, available, below_min?} where quantity, unit_value, total_value, min_quantity, and available are Decimal (or nil for value columns), below_min? is boolean, and the rest are strings.

min_quantity / available / below_min? come from PhoenixKitWarehouse.Deficits and PhoenixKitWarehouse.MinStockSettings (§5, deficit tracking) — deliberately global-per-item (summed across every warehouse), not scoped to the current warehouse_scope, same as Deficits.available_by_item/0 itself.

Summary

Functions

all_column_ids()
available_columns()

Ordered list of column metadata maps. Used by the picker modal.

column_metadata_map()

Map %{id => meta} for fast lookup during a single render pass.

default_columns()
scope()
validate_columns(ids)

Filter input list to known column ids, preserving order.

validate_filters(ids)

Filter input list to known filterable column ids, preserving order.

Functions

all_column_ids()

@spec all_column_ids() :: [String.t()]

available_columns()

@spec available_columns() :: [map()]

Ordered list of column metadata maps. Used by the picker modal.

column_metadata_map()

@spec column_metadata_map() :: %{required(String.t()) => map()}

Map %{id => meta} for fast lookup during a single render pass.

default_columns()

@spec default_columns() :: [String.t()]

scope()

@spec scope() :: String.t()

validate_columns(ids)

@spec validate_columns([String.t()]) :: [String.t()]

Filter input list to known column ids, preserving order.

validate_filters(ids)

@spec validate_filters([String.t()]) :: [String.t()]

Filter input list to known filterable column ids, preserving order.