sfcc-dev-mcp 1.0.16 → 1.0.20

package/docs/sfra/price-tiered.md

@@ -1,117 +0,0 @@
-# SFRA Tiered Price Model
-
-## Overview
-
-The Tiered Price model represents quantity-based pricing in SFRA applications, where products have different prices based on the quantity purchased. This enables bulk discounts and volume pricing strategies.
-
-## Constructor
-
-```javascript
-function TieredPrice(priceTable, useSimplePrice)
-```
-
-Creates a Tiered Price model instance with quantity-based pricing tiers.
-
-### Parameters
-
-- `priceTable` (dw.catalog.ProductPriceTable) - Product price table from the API
-- `useSimplePrice` (boolean) - Flag indicating if this is for a product tile (optional)
-
-## Properties
-
-### type
-**Type:** string
-
-Always set to 'tiered' to identify this as a tiered price model.
-
-### useSimplePrice
-**Type:** boolean
-
-Flag indicating whether this price is intended for simplified display (e.g., product tiles). Defaults to false.
-
-### tiers
-**Type:** Array<Object>
-
-Array of pricing tier objects, each containing:
-- `quantity` (number) - Minimum quantity for this price tier
-- `price` (DefaultPrice) - Price object for this quantity tier
-
-### startingFromPrice
-**Type:** DefaultPrice
-
-The lowest price available across all tiers, representing the "starting from" price for marketing display. Access the formatted price via `.sales.formatted`.
-
-## Tier Structure
-
-Each tier object in the tiers array contains:
-
-### quantity
-Minimum quantity required to qualify for this price tier.
-
-### price
-### price
-Complete DefaultPrice object created with only the sales price for this tier (accessed via `.sales` property).
-
-## Usage Example
-
-```javascript
-var TieredPrice = require('*/cartridge/models/price/tiered');
-
-// Get tiered pricing from product
-var product = ProductMgr.getProduct('bulk-product-id');
-var priceTable = product.getPriceModel().getPriceTable();
-
-var tieredPrice = new TieredPrice(priceTable, false);
-
-console.log(tieredPrice.type);                    // "tiered"
-console.log('Starting from: ' + tieredPrice.startingFromPrice.sales.formatted);
-
-// Display all price tiers
-tieredPrice.tiers.forEach(function(tier) {
-    console.log('Buy ' + tier.quantity + '+ for ' + tier.price.sales.formatted + ' each');
-});
-
-// Example output:
-// Buy 1+ for $10.00 each
-// Buy 5+ for $9.00 each  
-// Buy 10+ for $8.00 each
-```
-
-## Price Calculation Logic
-
-The model automatically:
-1. **Processes all quantity breaks** from the price table using `collections.map`
-2. **Creates DefaultPrice instances** with only sales price for each tier
-3. **Identifies the lowest price** by comparing `price.sales.value` across all tiers
-4. **Sets startingFromPrice** to the best available price
-5. **Maintains tier order** based on quantity requirements
-6. **Converts quantities** to numeric values using `quantity.getValue()`
-
-## Display Modes
-
-### Full Pricing (useSimplePrice = false)
-- Shows all pricing tiers
-- Includes complete quantity break information
-- Used on product detail pages
-
-### Simple Pricing (useSimplePrice = true)
-- Optimized for product tiles and listings
-- Focuses on starting price and key tiers
-- Simplified display for grid views
-
-## Notes
-
-- Automatically calculates the best "starting from" price by comparing sales values
-- Each tier DefaultPrice is created with only sales price (access via `.sales` property)
-- Uses `collections.map` utility to process price table quantities
-- Supports unlimited number of quantity tiers
-- Each tier uses DefaultPrice for consistent formatting
-- Useful for B2B and bulk purchasing scenarios
-- Type property enables template conditional logic
-- `useSimplePrice` defaults to `false` if not provided
-
-## Related Models
-
-- **DefaultPrice Model** - Used for individual tier pricing
-- **RangePrice Model** - Alternative pricing model for price ranges
-- **Product Models** - Use tiered prices for bulk products

package/docs/sfra/product-bundle.md

@@ -1,164 +0,0 @@
-# SFRA Product Bundle Model
-
-## Overview
-
-The Product Bundle model represents bundled products in SFRA applications, where multiple products are sold together as a single unit. It provides comprehensive bundle information including individual bundled products, pricing, and bundle-specific functionality.
-
-## Module Function
-
-```javascript
-module.exports = function bundleProduct(product, apiProduct, options, factory)
-```
-
-Decorates a product object with bundle-specific information using various decorators.
-
-### Parameters
-
-- `product` (Object) - Product Model to be decorated
-- `apiProduct` (dw.catalog.Product) - Product information returned by the script API
-- `options` (Object) - Options object containing:
-  - `productType` (string) - Product type information
-  - `variationModel` (dw.catalog.ProductVariationModel) - Variation model returned by the API
-  - `options` (Object) - Options provided on the query string
-  - `optionModel` (dw.catalog.ProductOptionModel) - Options model returned by the API
-  - `promotions` (dw.util.Collection) - Active promotions for the product
-  - `quantity` (number) - Current selected quantity
-  - `variables` (Object) - Variables passed in on the query string
-- `factory` (Object) - Reference to product factory for creating bundled products
-
-### Returns
-
-Object - Decorated product model with bundle-specific information
-
-## Applied Decorators
-
-The product bundle model applies the following decorators in sequence:
-
-### Standard Product Decorators
-- **base** - Fundamental product information: `uuid`, `id`, `productName`, `productType`, `brand`
-- **price** - Bundle pricing: `price` and `renderedPrice` with promotions
-- **images** - Product images: `images` with large and small sizes
-- **quantity** - Quantity constraints: `selectedQuantity`, `minOrderQuantity`, `maxOrderQuantity`
-- **description** - Product descriptions: `longDescription` and `shortDescription` markup
-- **ratings** - Product rating: `rating` value calculated from product ID
-- **promotions** - Active promotions: `promotions` array with promotion details
-- **attributes** - Product attributes: `attributes` array with grouped attribute data
-- **availability** - Availability status: `availability` object with messages and stock status
-- **options** - Product options: `options` array with option configurations
-- **quantitySelector** - Quantity selection: `quantities` array with step quantity options
-
-### Bundle-Specific Decorators
-- **sizeChart** (conditional) - Size chart: `sizeChartId` if category has custom sizeChartID
-- **currentUrl** - Product URL: `selectedProductUrl` with variation and option parameters
-- **bundledProducts** - Bundle contents: `bundledProducts` array with individual product models
-- **bundleReadyToOrder** - Bundle readiness: `readyToOrder` boolean validation for entire bundle
-- **raw** - Raw API data: `raw` property (non-enumerable) with original API product
-- **pageMetaData** - SEO metadata: `pageTitle`, `pageDescription`, `pageKeywords`, `pageMetaTags`
-- **template** - Template info: `template` property for rendering
-
-## Bundle-Specific Features
-
-### Bundled Products Information
-The `bundledProducts` decorator adds:
-- List of individual products in the bundle
-- Quantities of each bundled product
-- Individual product pricing and availability
-- Product configuration options for each item
-
-### Bundle Readiness Validation
-The `bundleReadyToOrder` decorator provides:
-- Overall bundle availability status
-- Validation that all required bundled products are available
-- Bundle-specific ordering constraints
-
-### Bundle Pricing
-Bundle pricing includes:
-- Combined pricing of all bundled products
-- Bundle-level discounts and promotions
-- Individual product price contributions
-- Savings compared to individual purchases
-
-## Usage Example
-
-```javascript
-var bundleProductDecorator = require('*/cartridge/models/product/productBundle');
-var productFactory = require('*/cartridge/scripts/factories/product');
-
-// Prepare options for bundle
-var options = {
-    productType: 'bundle',
-    variationModel: variationModel,
-    optionModel: optionModel,
-    promotions: activePromotions,
-    quantity: 1,
-    variables: req.querystring,
-    options: req.httpParameterMap
-};
-
-// Create and decorate bundle product
-var product = {};
-var bundleProduct = bundleProductDecorator(product, apiProduct, options, productFactory);
-
-// Access bundle-specific information
-console.log(bundleProduct.bundledProducts.length);
-console.log(bundleProduct.price.sales.formatted);
-console.log(bundleProduct.readyToOrder);
-
-// Check individual bundled products
-bundleProduct.bundledProducts.forEach(function(bundledProduct) {
-    console.log(bundledProduct.productName + ' x ' + bundledProduct.quantity);
-});
-```
-
-## Bundle Structure
-
-After decoration, the bundle product contains:
-
-### Standard Product Properties
-- **uuid** - Product UUID
-- **id** - Product ID  
-- **productName** - Product name
-- **productType** - Product type
-- **brand** - Product brand
-- **price** - Comprehensive pricing with bundle discounts
-- **renderedPrice** - HTML-rendered price for display
-- **images** - Product images (large and small sizes)
-- **selectedQuantity** - Currently selected quantity
-- **minOrderQuantity** - Minimum order quantity
-- **maxOrderQuantity** - Maximum order quantity
-- **longDescription** - Product long description markup
-- **shortDescription** - Product short description markup
-- **rating** - Product rating value
-- **promotions** - Active promotion information
-- **attributes** - Product attribute groups and values
-- **availability** - Availability status and messages
-- **options** - Product option configurations
-- **quantities** - Available quantity selection options
-- **selectedProductUrl** - Current product URL with parameters
-
-### Bundle-Specific Properties
-- **bundledProducts** - Array of individual product models in the bundle
-- **readyToOrder** - Boolean indicating if the entire bundle can be ordered
-- **sizeChartId** - Size chart identifier (if applicable)
-- **pageTitle** - SEO page title
-- **pageDescription** - SEO page description  
-- **pageKeywords** - SEO page keywords
-- **pageMetaTags** - SEO meta tags array
-- **template** - Template identifier for rendering
-
-## Notes
-
-- Handles complex bundle pricing calculations
-- Validates availability for all bundled products
-- Supports bundle-specific promotions and discounts
-- Maintains individual product information within the bundle
-- Provides comprehensive bundle readiness validation
-- Includes size chart support if any bundled products have size charts
-- Optimized for bundle product detail pages
-
-## Related Models
-
-- **Product Factory** - Creates individual bundled product models
-- **Full Product Model** - Similar comprehensive decoration approach
-- **Product Set Model** - Alternative product grouping model
-- **Product Decorators** - Individual decoration functions

package/docs/sfra/product-full.md

@@ -1,179 +0,0 @@
-# SFRA Full Product Model
-
-## Overview
-
-The Full Product model represents a complete product with all detailed information, typically used on product detail pages (PDP). It provides comprehensive product data including pricing, images, variations, descriptions, ratings, promotions, and availability.
-
-## Module Function
-
-```javascript
-module.exports = function fullProduct(product, apiProduct, options)
-```
-
-Decorates a product object with comprehensive product information using multiple decorators.
-
-### Parameters
-
-- `product` (Object) - Product Model to be decorated
-- `apiProduct` (dw.catalog.Product) - Product information returned by the script API
-- `options` (Object) - Options object containing:
-  - `variationModel` (dw.catalog.ProductVariationModel) - Variation model returned by the API
-  - `options` (Object) - Options provided on the query string
-  - `optionModel` (dw.catalog.ProductOptionModel) - Options model returned by the API
-  - `promotions` (dw.util.Collection) - Active promotions for the product
-  - `quantity` (number) - Current selected quantity
-  - `variables` (Object) - Variables passed in on the query string
-
-### Returns
-
-Object - Decorated product model with comprehensive product information
-
-## Applied Decorators
-
-The full product model applies the following decorators:
-
-### base
-Adds fundamental product information including uuid, id, productName, productType, and brand.
-
-### price
-Adds comprehensive pricing information including promotional prices, with option model integration. Sets `price` and `renderedPrice` properties.
-
-### images
-Adds product images with full configuration:
-- **Types:** ['large', 'small'] - Multiple image sizes for different display contexts
-- **Quantity:** 'all' - All available images
-
-### quantity
-Adds quantity information and constraints: `selectedQuantity`, `minOrderQuantity`, and `maxOrderQuantity`.
-
-### variationAttributes
-Adds variation attribute information with full configuration:
-- **Attributes:** '*' - All variation attributes
-- **EndPoint:** 'Variation' - Endpoint for variation handling
-
-### description
-Adds product description: `longDescription` and `shortDescription` markup properties.
-
-### ratings
-Adds product rating information: `rating` value calculated from product ID.
-
-### promotions
-Adds active promotion information: `promotions` array with promotion details.
-
-### attributes
-Adds product attributes from the attribute model: `attributes` array with grouped attribute data.
-
-### availability
-Adds availability information: `availability` object with messages and stock status based on quantity and availability model.
-
-### options
-Adds product option information: `options` array including option model, variables, and quantity.
-
-### quantitySelector
-Adds quantity selector information: `quantities` array with step quantity and URL options.
-
-### sizeChart (conditional)
-Adds size chart information: `sizeChartId` property if the product's category has a custom sizeChartID attribute.
-
-### currentUrl
-Adds current product URL: `selectedProductUrl` property with variation and option parameters.
-
-### readyToOrder
-Adds order readiness status: `readyToOrder` boolean indicating if product can be ordered.
-
-### online
-Adds online status: `online` boolean indicating if product is available online.
-
-### raw
-Adds raw API product: `raw` property (non-enumerable) containing the original dw.catalog.Product object.
-
-### pageMetaData
-Adds SEO metadata: `pageTitle`, `pageDescription`, `pageKeywords`, and `pageMetaTags` properties.
-
-### template
-Adds template information: `template` property for rendering purposes.
-
-## Usage Example
-
-```javascript
-var fullProductDecorator = require('*/cartridge/models/product/fullProduct');
-var productFactory = require('*/cartridge/scripts/factories/product');
-
-// Prepare options
-var options = {
-    variationModel: variationModel,
-    optionModel: optionModel,
-    promotions: activePromotions,
-    quantity: 1,
-    variables: req.querystring,
-    options: req.httpParameterMap
-};
-
-// Create and decorate product
-var product = {};
-var fullProduct = fullProductDecorator(product, apiProduct, options);
-
-// Access comprehensive product information
-console.log(fullProduct.price.sales);
-console.log(fullProduct.images.large);
-console.log(fullProduct.availability.messages);
-console.log(fullProduct.variationAttributes);
-```
-
-## Typical Properties After Decoration
-
-After applying all decorators, the full product object contains:
-
-- **uuid** - Product UUID  
-- **id** - Product ID
-- **productName** - Product name and display information
-- **productType** - Product type
-- **brand** - Product brand
-- **price** - Comprehensive pricing with promotions
-- **renderedPrice** - HTML-rendered price for display
-- **images** - Large and small product images
-- **selectedQuantity** - Currently selected quantity
-- **minOrderQuantity** - Minimum order quantity
-- **maxOrderQuantity** - Maximum order quantity
-- **variationAttributes** - Complete variation attribute data
-- **longDescription** - Product long description markup
-- **shortDescription** - Product short description markup
-- **rating** - Product rating value
-- **promotions** - Active promotion information
-- **attributes** - Product attribute groups and values
-- **availability** - Availability status and messages
-- **options** - Product option configurations
-- **quantities** - Available quantity selection options
-- **sizeChartId** - Size chart identifier (if applicable)
-- **selectedProductUrl** - Current product URL with selected variations and options
-- **readyToOrder** - Boolean indicating if product can be ordered
-- **online** - Boolean indicating if product is available online
-- **pageTitle** - SEO page title
-- **pageDescription** - SEO page description
-- **pageKeywords** - SEO page keywords
-- **pageMetaTags** - SEO meta tags array
-- **template** - Template identifier for rendering
-
-## Size Chart Handling
-
-The model automatically checks for size chart information:
-1. Gets the product's primary category
-2. For variants/variation groups, uses the master product's primary category
-3. If the category has a custom `sizeChartID` attribute, applies the sizeChart decorator
-
-## Notes
-
-- Provides the most comprehensive product information available
-- Optimized for product detail pages with full functionality
-- Handles all product types including variants, masters, and sets
-- Includes promotional pricing and availability calculations
-- Supports product options and variations
-- Automatically handles size chart integration
-- Performance-optimized for single product display
-
-## Related Models
-
-- **Product Tile Model** - Simplified version for listings
-- **Product Bundle Model** - For bundled products
-- **Product Set Model** - For product sets
-- **Product Decorators** - Individual decoration functions

package/docs/sfra/product-line-items.md

@@ -1,147 +0,0 @@
-# SFRA Product Line Items Model
-
-## Overview
-
-The Product Line Items model represents a collection of product line items in a basket or order. It provides comprehensive information about each product in the cart including quantities, options, bonus products, and pricing details.
-
-## Constructor
-
-```javascript
-function ProductLineItems(productLineItems, view)
-```
-
-Creates a Product Line Items model with formatted line item information.
-
-### Parameters
-
-- `productLineItems` (dw.util.Collection<dw.order.ProductLineItem>) - Collection of product line items from basket or order
-- `view` (string) - View context ('basket' or 'order')
-
-## Properties
-
-### items
-**Type:** Array<Object>
-
-Array of formatted product line items. Each item contains:
-
-#### Standard Product Items
-- `id` (string) - Product ID
-- `productName` (string) - Product display name
-- `quantity` (number) - Item quantity
-- `UUID` (string) - Line item UUID
-- `product` (Object) - Full product model with pricing, images, attributes
-- `options` (Array) - Product options if applicable
-- `bonusProducts` (Array) - Associated bonus products if applicable
-
-#### Items Without Product (Unassigned Categories)
-- `id` (string) - Product ID
-- `productName` (string) - Product name
-- `quantity` (number) - Item quantity
-- `UUID` (string) - Line item UUID
-- `noProduct` (boolean) - Flag indicating missing product (true)
-- `images` (Object) - Default "no image" placeholder
-
-### totalQuantity
-**Type:** number
-
-Total quantity of all items in the collection.
-
-## Helper Functions
-
-### createProductLineItemsObject(allLineItems, view)
-Creates an array of formatted product line items with comprehensive product information.
-
-**Parameters:**
-- `allLineItems` (dw.util.Collection<dw.order.ProductLineItem>) - All product line items
-- `view` (string) - View context ('basket' or 'order')
-
-**Returns:** Array<Object> - Formatted line items array
-
-## Product Line Item Structure
-
-Each product line item in the items array contains:
-
-### Product Information
-- Complete product model created via ProductFactory
-- Includes pricing, images, availability, and attributes
-- Product options mapped with option IDs and selected values
-
-### Bonus Products
-- Automatically detected and included for qualifying items
-- Each bonus product includes full product information
-- Linked via custom attributes (bonusProductLineItemUUID, preOrderUUID)
-
-### Quantity and Identification
-- Line item quantity and UUID for cart operations
-- Product ID for catalog operations
-- Product name for display purposes
-
-## Usage Example
-
-```javascript
-var ProductLineItems = require('*/cartridge/models/productLineItems');
-var BasketMgr = require('dw/order/BasketMgr');
-
-var currentBasket = BasketMgr.getCurrentBasket();
-var lineItemsModel = new ProductLineItems(
-    currentBasket.productLineItems, 
-    'basket'
-);
-
-// Access line items
-console.log('Total items: ' + lineItemsModel.totalQuantity);
-
-lineItemsModel.items.forEach(function(item) {
-    if (item.noProduct) {
-        console.log('Missing product: ' + item.productName);
-    } else {
-        console.log(item.product.productName + ' x ' + item.quantity);
-        
-        // Check for options
-        if (item.options && item.options.length > 0) {
-            console.log('Options: ', item.options);
-        }
-        
-        // Check for bonus products
-        if (item.bonusProducts && item.bonusProducts.length > 0) {
-            console.log('Bonus products: ' + item.bonusProducts.length);
-        }
-    }
-});
-```
-
-## Special Handling
-
-### Missing Products
-When a product is no longer available or unassigned:
-- `noProduct` flag is set to true
-- Limited product information is available
-- Default "no image" placeholder is used
-- Product name and basic details are preserved
-
-### Bonus Products
-- Automatically detected based on custom attributes
-- Each bonus product gets full ProductFactory treatment
-- Maintains relationship to parent product line item
-- Includes all product options and configurations
-
-### Product Options
-- Maps option product line items to option configurations
-- Includes option ID and selected value ID for each option
-- Used for product configuration and pricing
-
-## Notes
-
-- Handles both basket and order contexts
-- Gracefully handles missing or invalid products
-- Includes comprehensive product information via ProductFactory
-- Supports complex product relationships (bundles, sets, bonuses)
-- Maintains line item UUIDs for cart operations
-- Provides fallback handling for catalog issues
-
-## Related Models
-
-- **Cart Model** - Uses product line items for cart display
-- **Order Model** - Uses product line items for order information
-- **Product Models** - Created via ProductFactory for each line item
-- **Totals Model** - Calculates totals based on line items