usePriceListVolumePricing

The usePriceListVolumePricing composable manages product-specific price break pricing rules and handles pricing mode changes with proper user confirmation prompts. It provides state management for the volume pricing editing panel and ensures safe mode transitions.

NOTE

This composable is specifically designed to work alongside other price list management composables, like usePriceListRules and usePriceListPreview.

Features

• Price break editing with panel state management
• Pricing mode change detection with user confirmation prompts
• Product-specific rule management with context tracking
• Safe mode transitions with base rule cleanup

Usage

Basic Usage

const {
  rulesToEdit,
  rulesPanelOpen,
  pricelistRulesMode,
  handleSaveRules,
  confirmModeChange,
} = usePriceListVolumePricing({
  globalRules,
  updateEntityRules,
  previewPriceList,
});

// Open volume pricing panel for a product
rulesProductId.value = 'product-123';
rulesProductName.value = 'Sample Product';
rulesToEdit.value = productQuantityRules;
rulesPanelOpen.value = true;

// Handle rule changes
handleSaveRules(updatedRules);

Options

UsePriceListVolumePricingOptions

interface UsePriceListVolumePricingOptions {
  globalRules: Ref<PriceListRule[]>;
  updateEntityRules: () => Promise<void>;
  previewPriceList: (message?: string) => Promise<void>;
}

• globalRules: Reactive reference to all global price list rules
• updateEntityRules: Function to synchronize rules with entity data
• previewPriceList: Function to refresh the price list preview

Properties and Methods

rulesToEdit

const rulesToEdit: Ref<PriceListRule[]>;

Array of rules currently being edited in the volume pricing panel.

rulesPanelOpen

const rulesPanelOpen: Ref<boolean>;

Controls the visibility of the volume pricing editing panel.

rulesProductId

const rulesProductId: Ref<string>;

ID of the product whose volume pricing are being edited.

rulesProductName

const rulesProductName: Ref<string>;

Name of the product whose volume pricing are being edited.

actualPriceListRulesMode

const actualPriceListRulesMode: Ref<PriceListRuleMode>;

The current pricing mode ('margin', 'discount', 'fixed', 'auto').

pendingModeChange

const pendingModeChange: Ref<PriceListRuleMode | null>;

Tracks a pending mode change that requires user confirmation.

rulesModeChangePrompt

const rulesModeChangePrompt: Ref<boolean>;

Controls the visibility of the mode change confirmation dialog.

priceListRulesMode

const pricelistRulesMode: ComputedRef<PriceListRuleMode>;

Computed property that handles pricing mode changes with confirmation prompts.

• Get: Returns the current actualPriceListRulesMode
• Set: Triggers confirmation prompt if base rules exist, otherwise changes immediately
• Behavior: Protects against accidentally removing base rules during mode changes

handleSaveRules

handleSaveRules(rules: PriceListRule[]): void

Processes saved price break rules and triggers preview update.

• Parameters:
  • rules: Array of updated price break rules
• Behavior:
  • Updates rulesToEdit with the new rules
  • Triggers price list preview with descriptive feedback message
  • Includes product context in the feedback

confirmModeChange

confirmModeChange(): Promise<void>

Confirms a pending pricing mode change and modifies global rules.

• Behavior:
  • Closes the confirmation prompt
  • Applies the pending mode change
  • Updates entity rules and refreshes preview

cancelModeChange

cancelModeChange(): void

Cancels a pending mode change and resets state.

• Behavior:
  • Closes the confirmation prompt
  • Clears the pending mode change
  • No changes are applied to rules or mode

Type Definitions

interface PriceListRule {
  _id?: string;
  internalId?: string;
  quantity?: number;
  margin?: number;
  discountPercent?: number;
  price?: number;
  applied?: boolean;
  global?: boolean;
  lastFieldChanged?: PriceListRuleField;
}

type PriceListRuleMode = 'margin' | 'discount' | 'fixed' | 'auto';