sfcc-dev-mcp 1.0.16 → 1.0.20

package/docs/sfra/locale.md

@@ -1,126 +0,0 @@
-# SFRA Locale Model
-
-## Overview
-
-The Locale model represents current locale information and provides locale switching functionality for internationalized SFRA applications. It manages country codes, currency codes, language settings, and available locale options for site visitors.
-
-## Constructor
-
-```javascript
-function Locale(currentLocale, allowedLocales, siteId)
-```
-
-Creates a Locale model instance with current locale information and available locale options.
-
-### Parameters
-
-- `currentLocale` (dw.util.Locale) - Current locale of the request
-- `allowedLocales` (string) - List of allowed locales for the site
-- `siteId` (string) - ID of the current site
-
-## Properties
-
-### locale
-**Type:** Object
-
-Object containing comprehensive locale information:
-
-- `countryCode` (string) - Country code for the current locale
-- `name` (string) - Display name of the country
-- `currencyCode` (string) - Currency code for the locale
-- `displayName` (string) - Full display name of the locale
-- `language` (string) - Language code
-- `displayLanguage` (string) - Display name of the language
-- `localeLinks` (Array<Object>) - Available locale options for switching
-- `localLinks` (Array<Object>) - **Deprecated** - Same as localeLinks (kept for backward compatibility)
-
-### Locale Link Objects
-
-Each object in `localeLinks` contains:
-- `localID` (string) - Locale identifier
-- `country` (string) - Country code
-- `displayCountry` (string) - Country display name
-- `currencyCode` (string) - Currency code for the locale
-- `displayName` (string) - Full locale display name
-- `language` (string) - Language code
-- `displayLanguage` (string) - Language display name
-
-## Helper Functions
-
-### getLocaleLinks(allowedLocales, siteId, currentLocaleID)
-Returns available locale options for site locale switching.
-
-**Parameters:**
-- `allowedLocales` (string) - List of allowed locales for the site
-- `siteId` (string) - Current site ID
-- `currentLocaleID` (string) - Current locale ID
-
-**Returns:** Array<Object> - Array of available locale options (excluding current locale)
-
-### isLocaleValid(currentLocale)
-Validates that a locale object is properly formed.
-
-**Parameters:**
-- `currentLocale` (dw.util.Locale) - Locale to validate
-
-**Returns:** boolean - True if locale has required ID property
-
-## Usage Example
-
-```javascript
-var LocaleModel = require('*/cartridge/models/locale');
-var Site = require('dw/system/Site');
-
-var currentLocale = request.getLocale();
-var allowedLocales = Site.getCurrent().getAllowedLocales();
-var siteId = Site.getCurrent().getID();
-
-var localeModel = new LocaleModel(currentLocale, allowedLocales, siteId);
-
-// Access current locale information
-console.log(localeModel.locale.countryCode);      // "US"
-console.log(localeModel.locale.currencyCode);     // "USD"
-console.log(localeModel.locale.displayLanguage);  // "English"
-
-// Access available locale options
-localeModel.locale.localeLinks.forEach(function(link) {
-    console.log(link.displayName + ' (' + link.currencyCode + ')');
-    // Output: "English (United Kingdom) (GBP)", "Français (France) (EUR)", etc.
-});
-```
-
-## Backward Compatibility
-
-The model includes both `localeLinks` and `localLinks` properties:
-- **localeLinks** - Correct property name (use this)
-- **localLinks** - Deprecated typo maintained for backward compatibility
-
-**Note**: The SFRA team plans to remove the `localLinks` property in a future version.
-
-## Fallback Handling
-
-If the current locale is invalid or missing:
-- Falls back to the first country in the countries configuration
-- Ensures the model always has valid locale information
-- Prevents errors in locale-dependent functionality
-
-## Integration with Countries Configuration
-
-The model relies on a countries configuration file (`*/cartridge/config/countries`) that defines:
-- Available countries and locales
-- Currency codes for each locale
-- Locale-specific configurations
-
-## Notes
-
-- Excludes the current locale from the locale switching links
-- Provides comprehensive locale information for internationalization
-- Handles invalid locales gracefully with fallbacks
-- Supports multi-currency and multi-language sites
-- Integrates with SFCC's built-in locale system
-
-## Related Models
-
-- **Site Configuration** - Defines allowed locales
-- **Currency Models** - May use currency information
-- **Address Models** - May use country information for formatting

package/docs/sfra/order.md

@@ -1,219 +0,0 @@
-# SFRA Order Model
-
-## Overview
-
-The Order model represents an order or basket in SFRA applications, providing comprehensive or## Helper Functions
-
-### getCheckoutStepInformation(lineItemContainer)
-Returns checkout step completion status.
-
-**Parameters:**
-- `lineItemContainer` (dw.order.LineItemCtnr) - Order or basket
-
-**Returns:** Object - Checkout step status with shipping and billing completion flags
-
-### getFirstProductLineItem(productLineItemsModel)
-Returns image information for the first product line item.
-
-**Parameters:**
-- `productLineItemsModel` (Object) - Product line items model
-
-**Returns:** Object | null - Object with imageURL, alt, and title properties, or null
-
-### getAssociatedAddress(lineItemContainer, customer)
-Returns the matching address ID for a billing address.
-
-**Parameters:**
-- `lineItemContainer` (dw.order.LineItemCtnr) - Order or basket
-- `customer` (Object) - Customer model
-
-**Returns:** string | boolean - Matching shipment UUID or customer address ID, or false if no matchuding line items, totals, billing, shipping, and checkout step status. It's used for order confirmation pages, order history, and checkout processes.
-
-## Constructor
-
-```javascript
-function OrderModel(lineItemContainer, options)
-```
-
-Creates an Order model instance from a line item container (order or basket).
-
-### Parameters
-
-- `lineItemContainer` (dw.order.LineItemCtnr) - Order or basket object
-- `options` (Object) - Configuration options including:
-  - `config` (Object) - Configuration object with `numberOfLineItems` setting
-  - `countryCode` (string) - Current request country code
-  - `customer` (Object) - Customer object
-  - `containerView` (string) - View context ('order' or 'basket')
-  - `usingMultiShipping` (boolean) - Whether using multiple shipping addresses
-  - `shippable` (boolean) - Whether order contains shippable items
-
-## Properties
-
-### resources
-**Type:** Object
-
-Resource strings for order-related messaging and labels.
-
-### orderNumber
-**Type:** string | null
-
-The order number for completed orders, or null for baskets.
-
-### creationDate
-**Type:** Date | null
-
-Date when the order was created, or null for baskets.
-
-### orderEmail
-**Type:** string
-
-Customer email address associated with the order.
-
-### orderStatus
-**Type:** Object | null
-
-Order status information, or null for baskets.
-
-### usingMultiShipping
-**Type:** boolean
-
-Indicates whether the order uses multiple shipping addresses.
-
-### shippable
-**Type:** boolean
-
-Indicates whether the order contains shippable items.
-
-### priceTotal
-**Type:** string | null
-
-Formatted grand total amount from the totals model.
-
-### productQuantityTotal
-**Type:** number | null
-
-Total quantity of all products in the order.
-
-## Conditional Properties (when numberOfLineItems = '*')
-
-### totals
-**Type:** TotalsModel
-
-Order totals including subtotals, taxes, shipping costs, and grand total.
-
-### lineItemTotal
-**Type:** number | null
-
-Total number of line items in the order.
-
-### steps
-**Type:** Object | null
-
-Checkout step information with completion status.
-
-### items
-**Type:** ProductLineItemsModel
-
-Product line items model containing all order items with detailed product information.
-
-### billing
-**Type:** BillingModel
-
-Billing information including billing address and payment methods.
-
-### shipping
-**Type:** Array<Object>
-
-Array of shipping models containing shipping address and method information for each shipment.
-
-## Conditional Properties (when numberOfLineItems = 'single')
-
-### firstLineItem
-**Type:** Object | null
-
-Information about the first product line item including image details.
-
-### shippedToFirstName
-**Type:** string
-
-First name from the first shipment's shipping address.
-
-### shippedToLastName
-**Type:** string
-
-Last name from the first shipment's shipping address.
-
-## Helper Functions
-
-### getCheckoutStepInformation(lineItemContainer)
-Creates checkout step completion information.
-
-**Parameters:**
-- `lineItemContainer` (dw.order.LineItemCtnr) - Order or basket container
-
-**Returns:** Object - Checkout step status information
-
-### getFirstProductLineItem(productLineItemsModel)
-Returns image information for the first product line item.
-
-**Parameters:**
-- `productLineItemsModel` (Object) - Product line items model
-
-**Returns:** Object | null - First item image information or null
-
-### getAssociatedAddress(basket, customer)
-Returns the matching address ID for a billing address.
-
-**Parameters:**
-- `basket` (dw.order.Basket) - Customer's basket
-- `customer` (Object) - Customer model
-
-**Returns:** string | boolean - Matching address ID or false
-
-## Usage Example
-
-```javascript
-var OrderModel = require('*/cartridge/models/order');
-var OrderMgr = require('dw/order/OrderMgr');
-
-// For completed order
-var order = OrderMgr.getOrder('order-number');
-var orderModel = new OrderModel(order, { numberOfLineItems: '*' });
-
-// Access order properties
-console.log(orderModel.orderNumber);
-console.log(orderModel.totals.grandTotal);
-console.log(orderModel.billing.billingAddress);
-console.log(orderModel.items.length);
-
-// For checkout basket
-var currentBasket = BasketMgr.getCurrentBasket();
-var checkoutModel = new OrderModel(currentBasket);
-console.log(checkoutModel.checkoutStep.shipping.iscompleted);
-```
-
-## Configuration Options
-
-The model supports configuration through the options parameter:
-- **numberOfLineItems**: Controls how many line items to include
-  - `'*'` - Include all line items (default)
-  - Number - Include specific number of line items
-
-## Notes
-
-- Works with both orders and baskets (line item containers)
-- Automatically determines checkout step completion status
-- Includes comprehensive totals with all discount calculations
-- Provides first line item image for order thumbnails
-- Handles multiple shipments with individual shipping information
-- All monetary values are properly formatted for display
-- Includes extensive localized resources for UI display
-
-## Related Models
-
-- **TotalsModel** - Used for order total calculations
-- **ProductLineItemsModel** - Used for line item information
-- **BillingModel** - Used for billing information
-- **AddressModel** - Used for address formatting
-- **PaymentModel** - Used for payment information

package/docs/sfra/payment.md

@@ -1,131 +0,0 @@
-# SFRA Payment Model
-
-## Overview
-
-The Payment model represents payment information for the current basket in SFRA applications. It provides comprehensive payment method options, applicable payment cards, and selected payment instruments for checkout processing.
-
-## Constructor
-
-```javascript
-function Payment(currentBasket, currentCustomer, countryCode)
-```
-
-Creates a Payment model instance with applicable payment methods and current payment selections.
-
-### Parameters
-
-- `currentBasket` (dw.order.Basket) - The target Basket object
-- `currentCustomer` (dw.customer.Customer) - The associated Customer object
-- `countryCode` (string) - The associated Site country code
-
-## Properties
-
-### applicablePaymentMethods
-**Type:** Array<Object> | null
-
-Array of payment methods available for the current basket and customer. Each method object contains:
-- `ID` (string) - Payment method ID
-- `name` (string) - Display name of the payment method
-
-### applicablePaymentCards
-**Type:** Array<Object> | null
-
-Array of credit card types available for the current customer and basket. Each card object contains:
-- `cardType` (string) - Credit card type identifier
-- `name` (string) - Display name of the card type
-
-### selectedPaymentInstruments
-**Type:** Array<Object> | null
-
-Array of currently selected payment instruments for the basket. Each instrument object contains:
-- `paymentMethod` (string) - Payment method type
-- `amount` (number) - Payment amount value
-
-#### Credit Card Instruments
-For credit card payments, additional properties include:
-- `lastFour` (string) - Last four digits of the card number
-- `owner` (string) - Cardholder name
-- `expirationYear` (number) - Card expiration year
-- `type` (string) - Credit card type
-- `maskedCreditCardNumber` (string) - Masked card number
-- `expirationMonth` (number) - Card expiration month
-
-#### Gift Certificate Instruments
-For gift certificate payments, additional properties include:
-- `giftCertificateCode` (string) - Full gift certificate code
-- `maskedGiftCertificateCode` (string) - Masked gift certificate code
-
-## Helper Functions
-
-### applicablePaymentMethods(paymentMethods)
-Creates an array of applicable payment method objects.
-
-**Parameters:**
-- `paymentMethods` (dw.util.ArrayList<dw.order.PaymentMethod>) - Available payment methods
-
-**Returns:** Array<Object> - Formatted payment methods array
-
-### applicablePaymentCards(paymentCards)
-Creates an array of applicable credit card objects.
-
-**Parameters:**
-- `paymentCards` (dw.util.Collection<dw.order.PaymentCard>) - Available payment cards
-
-**Returns:** Array<Object> - Formatted payment cards array
-
-### getSelectedPaymentInstruments(selectedPaymentInstruments)
-Creates an array of selected payment instrument objects with method-specific properties.
-
-**Parameters:**
-- `selectedPaymentInstruments` (dw.util.ArrayList<dw.order.PaymentInstrument>) - Selected payment instruments
-
-**Returns:** Array<Object> - Formatted payment instruments array
-
-## Usage Example
-
-```javascript
-var PaymentModel = require('*/cartridge/models/payment');
-var BasketMgr = require('dw/order/BasketMgr');
-
-var currentBasket = BasketMgr.getCurrentBasket();
-var currentCustomer = req.currentCustomer.raw;
-var countryCode = 'US';
-
-var payment = new PaymentModel(currentBasket, currentCustomer, countryCode);
-
-// Access payment methods
-console.log(payment.applicablePaymentMethods);
-// [{ ID: 'CREDIT_CARD', name: 'Credit Card' }, { ID: 'PayPal', name: 'PayPal' }]
-
-// Access applicable cards
-console.log(payment.applicablePaymentCards);
-// [{ cardType: 'Visa', name: 'Visa' }, { cardType: 'MasterCard', name: 'MasterCard' }]
-
-// Check selected instruments
-if (payment.selectedPaymentInstruments) {
-    payment.selectedPaymentInstruments.forEach(function(instrument) {
-        console.log(instrument.paymentMethod + ': $' + instrument.amount);
-    });
-}
-```
-
-## Payment Method Support
-
-The model supports various payment methods including:
-- **Credit Cards** - With full card details and masking
-- **Gift Certificates** - With code masking
-- **Other Methods** - Basic method and amount information
-
-## Notes
-
-- Payment methods are filtered based on customer, country, and basket amount
-- Credit card information is automatically masked for security
-- Supports multiple payment instruments per basket
-- All monetary amounts are in the basket's currency
-- Payment method availability depends on site configuration and customer eligibility
-
-## Related Models
-
-- **BillingModel** - Uses payment model for billing information
-- **OrderModel** - Includes payment information in order data
-- **Cart Model** - May include payment selection during checkout

package/docs/sfra/price-default.md

@@ -1,118 +0,0 @@
-# SFRA Default Price Model
-
-## Overview
-
-The Default Price model represents standard product pricing in SFRA applications. It provides formatted price information including sales prices, list prices, and currency details for product display and calculations.
-
-## Constructor
-
-```javascript
-function DefaultPrice(salesPrice, listPrice)
-```
-
-Creates a Default Price model instance with sales and list pricing information.
-
-### Parameters
-
-- `salesPrice` (dw.value.Money) - Sales price from the API
-- `listPrice` (dw.value.Money) - List price from the API (optional)
-
-## Properties
-
-### sales
-**Type:** Object
-
-Sales price information containing:
-- `value` (number | null) - Decimal price value
-- `currency` (string | null) - Currency code
-- `formatted` (string | null) - Formatted price string for display
-- `decimalPrice` (string | null) - Decimal price as string
-
-### list
-**Type:** Object | null
-
-List price information (same structure as sales) or null if no list price provided.
-
-## Helper Functions
-
-### toPriceModel(price)
-Converts an API Money object to a structured price model.
-
-**Parameters:**
-- `price` (dw.value.Money) - Price object from the API
-
-**Returns:** Object - Formatted price object with value, currency, formatted string, and decimal price
-
-## Price Object Structure
-
-Each price object (sales/list) contains:
-
-### value
-Raw numeric price value for calculations and comparisons.
-
-### currency
-Three-letter currency code (e.g., "USD", "EUR").
-
-### formatted
-User-friendly formatted price string with currency symbol (e.g., "$29.99").
-
-### decimalPrice
-String representation of the decimal price for precise display.
-
-## Usage Example
-
-```javascript
-var DefaultPrice = require('*/cartridge/models/price/default');
-
-// Get prices from product
-var product = ProductMgr.getProduct('product-id');
-var salesPrice = product.getPriceModel().getPrice();
-var listPrice = product.getPriceModel().getPriceBookPrice('list-price-book');
-
-var price = new DefaultPrice(salesPrice, listPrice);
-
-// Access sales price
-console.log(price.sales.formatted);    // "$29.99"
-console.log(price.sales.value);        // 29.99
-console.log(price.sales.currency);     // "USD"
-
-// Check for list price (original/MSRP)
-if (price.list) {
-    console.log('Was: ' + price.list.formatted);
-    console.log('Now: ' + price.sales.formatted);
-    
-    // Calculate discount percentage
-    var discount = ((price.list.value - price.sales.value) / price.list.value) * 100;
-    console.log('Save ' + discount.toFixed(0) + '%');
-}
-```
-
-## Price Availability
-
-The model handles unavailable prices gracefully:
-- When price is not available, all properties return null
-- Prevents errors when price calculation fails
-- Provides consistent structure regardless of price availability
-
-## Currency Support
-
-The model supports international pricing:
-- Currency codes from the Money object
-- Formatted strings respect locale settings
-- Decimal representation for precise calculations
-
-## Notes
-
-- Handles both sales and list prices
-- Gracefully manages unavailable prices with null values
-- Provides multiple price formats for different use cases
-- Supports international currencies and formatting
-- List price is optional (may be null)
-- Decimal price provides precise string representation
-
-## Related Models
-
-- **Tiered Price Model** - For quantity-based pricing
-- **Range Price Model** - For price range displays
-- **Product Models** - Use price models for product pricing
-- **Cart Models** - Use price models for line item pricing

package/docs/sfra/price-range.md

@@ -1,77 +0,0 @@
-# SFRA Range Price Model
-
-## Overview
-
-The Range Price model represents price ranges in SFRA applications, typically used for product sets, bundles, or variable products where prices can vary between a minimum and maximum value.
-
-## Constructor
-
-```javascript
-function RangePrice(min, max)
-```
-
-Creates a Range Price model instance with minimum and maximum pricing.
-
-### Parameters
-
-- `min` (dw.value.Money) - Range minimum price
-- `max` (dw.value.Money) - Range maximum price
-
-## Properties
-
-### type
-**Type:** string
-
-Always set to 'range' to identify this as a range price model.
-
-### min
-**Type:** DefaultPrice
-
-Minimum price in the range, formatted as a DefaultPrice model with value, currency, and formatted properties. Created as `new DefaultPrice(min)` where only the sales price is provided.
-
-### max
-**Type:** DefaultPrice
-
-Maximum price in the range, formatted as a DefaultPrice model with value, currency, and formatted properties. Created as `new DefaultPrice(max)` where only the sales price is provided.
-
-## Usage Example
-
-```javascript
-var RangePrice = require('*/cartridge/models/price/range');
-
-// For a product bundle with varying prices
-var minPrice = new Money(19.99, 'USD');
-var maxPrice = new Money(49.99, 'USD');
-
-var rangePrice = new RangePrice(minPrice, maxPrice);
-
-console.log(rangePrice.type);              // "range"
-console.log(rangePrice.min.sales.formatted);     // "$19.99"
-console.log(rangePrice.max.sales.formatted);     // "$49.99"
-
-// Display price range
-console.log(rangePrice.min.sales.formatted + ' - ' + rangePrice.max.sales.formatted);
-// Output: "$19.99 - $49.99"
-```
-
-## Use Cases
-
-Range prices are commonly used for:
-- **Product Bundles** - When bundle contents affect total price
-- **Product Sets** - Collections with varying individual prices
-- **Variable Products** - Products with options that affect pricing
-- **Category Displays** - Showing price ranges for product collections
-
-## Notes
-
-- Both min and max are DefaultPrice models created with only the sales price (no list price)
-- Min and max prices are accessed via `.sales` property (e.g., `rangePrice.min.sales.formatted`)
-- Type property helps identify this as a range price in templates
-- Useful for displaying "from X to Y" pricing
-- Maintains currency and formatting consistency through DefaultPrice
-
-## Related Models
-
-- **DefaultPrice Model** - Used for min and max price formatting
-- **TieredPrice Model** - Alternative pricing model for quantity discounts
-- **Product Models** - May use range prices for variable products