sfcc-dev-mcp 1.0.19 → 1.0.20

package/docs/sfra/account.md

@@ -1,145 +0,0 @@
-# SFRA Account Model
-
-## Overview
-
-The Account model represents a customer's profile dashboard, containing profile information, addresses, payment instruments, and order history. It provides methods for handling customer account data in SFRA applications.
-
-## Constructor
-
-```javascript
-function account(currentCustomer, addressModel, orderModel)
-```
-
-Creates an Account model instance that represents the current customer's profile dashboard.
-
-### Parameters
-
-- `currentCustomer` (Object) - Current customer object
-- `addressModel` (Object) - The current customer's preferred address
-- `orderModel` (Object) - The current customer's order history
-
-## Properties
-
-### profile
-**Type:** Object | null
-
-Contains the customer's profile information including:
-- `firstName` (string) - Customer's first name
-- `lastName` (string) - Customer's last name  
-- `email` (string) - Customer's email address
-- `phone` (string) - Customer's phone number
-- `password` (string) - Masked password (always "********")
-
-### addresses
-**Type:** Array<Object>
-
-Array of customer's address book addresses. Each address object contains standard address fields.
-
-### preferredAddress
-**Type:** Object | null
-
-The customer's preferred/default address from their address book.
-
-### orderHistory
-**Type:** Object
-
-The customer's order history information.
-
-### payment
-**Type:** Object | null
-
-Primary payment instrument information including:
-- `maskedCreditCardNumber` (string) - Masked card number
-- `creditCardType` (string) - Type of credit card
-- `creditCardExpirationMonth` (number) - Expiration month
-- `creditCardExpirationYear` (number) - Expiration year
-
-### registeredUser
-**Type:** boolean
-
-Indicates if the customer is both authenticated and registered.
-
-### isExternallyAuthenticated
-**Type:** boolean
-
-Indicates if the customer is authenticated through an external provider.
-
-### customerPaymentInstruments
-**Type:** Array<Object> | null
-
-Array of customer's saved payment instruments. Each payment instrument contains:
-- `creditCardHolder` (string) - Name on the credit card
-- `maskedCreditCardNumber` (string) - Masked card number
-- `creditCardType` (string) - Type of credit card
-- `creditCardExpirationMonth` (number) - Expiration month
-- `creditCardExpirationYear` (number) - Expiration year
-- `UUID` (string) - Unique identifier
-- `cardTypeImage` (Object) - Image source and alt text for card type
-  - `src` (string) - Image source URL
-  - `alt` (string) - Alt text for the image
-
-## Helper Functions
-
-### getProfile(profile)
-Creates a plain object containing profile information.
-
-**Parameters:**
-- `profile` (Object) - Customer's profile object
-
-**Returns:** Object | null - Profile information or null if no profile
-
-### getAddresses(addressBook)
-Creates an array of address objects from the customer's address book.
-
-**Parameters:**
-- `addressBook` (Object) - Customer's address book
-
-**Returns:** Array<Object> - Array of address objects
-
-### getPreferredAddress(addressBook)
-Gets the customer's preferred address.
-
-**Parameters:**
-- `addressBook` (Object) - Customer's address book
-
-**Returns:** Object | null - Preferred address or null
-
-### getPayment(wallet)
-Gets the primary payment instrument information.
-
-**Parameters:**
-- `wallet` (Object) - Customer's wallet containing payment instruments
-
-**Returns:** Object | null - Payment instrument information or null
-
-### getCustomerPaymentInstruments(userPaymentInstruments)
-Creates an array of payment instrument objects with card type images.
-
-**Parameters:**
-- `userPaymentInstruments` (Array) - Array of customer's payment instruments
-
-**Returns:** Array<Object> - Array of formatted payment instruments
-
-## Usage Example
-
-```javascript
-var AccountModel = require('*/cartridge/models/account');
-var currentCustomer = customer;
-var addressModel = null; // or specific address model
-var orderModel = getOrderHistory();
-
-var account = new AccountModel(currentCustomer, addressModel, orderModel);
-
-// Access account properties
-console.log(account.profile.email);
-console.log(account.addresses.length);
-console.log(account.registeredUser);
-console.log(account.customerPaymentInstruments);
-console.log(account.payment);
-```
-
-## Related Models
-
-- **Address Model** - Used for address formatting
-- **Order Model** - Used for order history
-- **Payment Models** - Used for payment instrument handling

package/docs/sfra/address.md

@@ -1,84 +0,0 @@
-# SFRA Address Model
-
-## Overview
-
-The Address model represents an order address or customer address in SFRA applications. It provides a standardized way to handle address information across the application.
-
-## Constructor
-
-```javascript
-function address(addressObject)
-```
-
-Creates an Address model instance from an address object.
-
-### Parameters
-
-- `addressObject` (dw.order.OrderAddress) - User's address object from the API
-
-## Properties
-
-### address
-**Type:** Object | null
-
-Contains the formatted address information with the following properties:
-
-- `address1` (string) - Primary address line
-- `address2` (string) - Secondary address line
-- `city` (string) - City name
-- `firstName` (string) - First name
-- `lastName` (string) - Last name
-- `ID` (string | null) - Address ID
-- `addressId` (string | null) - Address identifier (same as ID)
-- `phone` (string) - Phone number
-- `postalCode` (string) - Postal/ZIP code
-- `stateCode` (string) - State or province code
-- `jobTitle` (string) - Job title
-- `postBox` (string) - Post office box
-- `salutation` (string) - Salutation (Mr., Mrs., etc.)
-- `secondName` (string) - Second/middle name
-- `companyName` (string) - Company name
-- `suffix` (string) - Name suffix
-- `suite` (string) - Suite number
-- `title` (string) - Title
-- `countryCode` (Object) - Country code object with:
-  - `displayValue` (string) - Display name of country
-  - `value` (string) - Country code in uppercase
-
-## Helper Functions
-
-### createAddressObject(addressObject)
-Creates a plain object containing standardized address information.
-
-**Parameters:**
-- `addressObject` (dw.order.OrderAddress) - Address object from the API
-
-**Returns:** Object | null - Formatted address object or null if no address provided
-
-## Usage Example
-
-```javascript
-var AddressModel = require('*/cartridge/models/address');
-
-// Create address model from API address object
-var customerAddress = customer.addressBook.preferredAddress;
-var addressModel = new AddressModel(customerAddress);
-
-// Access address properties
-console.log(addressModel.address.firstName);
-console.log(addressModel.address.city);
-console.log(addressModel.address.countryCode.value);
-```
-
-## Notes
-
-- If `stateCode` is 'undefined', it will be converted to an empty string
-- Country codes are automatically converted to uppercase
-- The model handles both customer addresses and order addresses
-- All address fields are optional and may be null or empty strings
-
-## Related Models
-
-- **Account Model** - Uses Address model for customer addresses
-- **Checkout Models** - Use Address model for billing and shipping addresses
-- **Order Models** - Use Address model for order address information

package/docs/sfra/billing.md

@@ -1,90 +0,0 @@
-# SFRA Billing Model
-
-## Overview
-
-The Billing model represents billing information for the current basket or order in SFRA applications. It provides a simple structure for managing billing address, payment information, and address associations.
-
-## Constructor
-
-```javascript
-function billing(addressModel, paymentModel, associatedAddressId)
-```
-
-Creates a Billing model instance with billing address, payment, and address association information.
-
-### Parameters
-
-- `addressModel` (Object) - The billing address of the current basket
-- `paymentModel` (Object) - Payment information for the current basket
-- `associatedAddressId` (string) - The matching ID of the shipping or customer address
-
-## Properties
-
-### billingAddress
-**Type:** Object
-
-The billing address model containing complete address information including:
-- Address lines, city, state, postal code
-- Customer name and contact information
-- Country code and other address details
-
-### payment
-**Type:** Object
-
-Payment model containing payment method information such as:
-- Credit card details (masked)
-- Payment processor information
-- Payment method type
-- Payment instrument details
-
-### matchingAddressId
-**Type:** string
-
-The ID that matches this billing address to either:
-- A shipping address (if billing and shipping are the same)
-- A saved customer address
-- null if it's a new address
-
-## Usage Example
-
-```javascript
-var BillingModel = require('*/cartridge/models/billing');
-var AddressModel = require('*/cartridge/models/address');
-var PaymentModel = require('*/cartridge/models/payment');
-
-// Create address and payment models
-var billingAddress = new AddressModel(basket.billingAddress);
-var paymentInfo = new PaymentModel(basket, customer);
-var matchingId = getMatchingAddressId(basket.billingAddress);
-
-// Create billing model
-var billing = new BillingModel(billingAddress, paymentInfo, matchingId);
-
-// Access billing properties
-console.log(billing.billingAddress.firstName);
-console.log(billing.payment.selectedPaymentInstruments);
-console.log(billing.matchingAddressId);
-```
-
-## Address Matching
-
-The `matchingAddressId` property helps determine:
-- If the billing address matches a shipping address
-- If the billing address matches a saved customer address
-- Whether to show "same as shipping" options in the UI
-- Address management and selection logic
-
-## Notes
-
-- Simple container model that aggregates billing-related information
-- Used extensively in checkout and order processing
-- Address matching enables UI optimizations like "same as shipping"
-- Works with both new and saved addresses
-- Integrates with payment processing workflows
-
-## Related Models
-
-- **AddressModel** - Used for billing address formatting
-- **PaymentModel** - Used for payment information
-- **OrderModel** - Uses billing model for order information
-- **Cart Model** - May include billing information during checkout

package/docs/sfra/cart.md

@@ -1,134 +0,0 @@
-# SFRA Cart Model
-
-## Overview
-
-The Cart model represents the current customer's shopping basket in SFRA applications. It provides comprehensive cart functionality including product line items, shipping methods, totals, discounts, and cart actions.
-
-## Constructor
-
-```javascript
-function CartModel(basket)
-```
-
-Creates a Cart model instance from a basket object.
-
-### Parameters
-
-- `basket` (dw.order.Basket) - Current user's basket
-
-## Properties
-
-### items
-**Type:** Array<Object>
-
-Array of product line items in the cart. Each item contains product information, quantity, pricing, and other details.
-
-### numItems
-**Type:** number
-
-Total number of items (quantity) in the cart.
-
-### totals
-**Type:** TotalsModel
-
-Totals model containing cart pricing information including subtotals, taxes, shipping costs, and grand total.
-
-### shipments
-**Type:** Array<Object>
-
-Array of shipment objects, each containing:
-- `shippingMethods` - Available shipping methods for the shipment
-- `selectedShippingMethod` - ID of the currently selected shipping method
-
-### numOfShipments
-**Type:** number
-
-Number of shipments in the cart.
-
-### hasBonusProduct
-**Type:** boolean
-
-Indicates whether the cart contains any bonus products from promotions.
-
-### actionUrls
-**Type:** Object
-
-Object containing URLs for cart actions:
-- `removeProductLineItemUrl` - URL to remove product line items
-- `updateQuantityUrl` - URL to update item quantities
-- `selectShippingUrl` - URL to select shipping methods
-- `submitCouponCodeUrl` - URL to add coupon codes
-- `removeCouponLineItem` - URL to remove coupon line items
-
-### approachingDiscounts
-**Type:** Array<Object>
-
-Array of approaching discount objects, each containing:
-- `discountMsg` - Message describing the approaching discount
-
-### valid
-**Type:** boolean
-
-Indicates whether the basket is valid based on validation hooks.
-
-### resources
-**Type:** Object
-
-Object containing localized resource strings:
-- `numberOfItems` - Formatted message showing number of items in cart
-- `minicartCountOfItems` - Formatted message for minicart count
-- `emptyCartMsg` - Message displayed when cart is empty
-
-## Helper Functions
-
-### getApproachingDiscounts(basket, discountPlan)
-Generates an object of approaching discounts based on current basket and discount plan.
-
-**Parameters:**
-- `basket` (dw.order.Basket) - Current user's basket
-- `discountPlan` (dw.campaign.DiscountPlan) - Set of applicable discounts
-
-**Returns:** Object - Object containing approaching discount information
-
-### getCartActionUrls()
-Generates an object of URLs used for cart actions.
-
-**Returns:** Object - Object containing cart action URLs in string format
-
-## Usage Example
-
-```javascript
-var CartModel = require('*/cartridge/models/cart');
-var BasketMgr = require('dw/order/BasketMgr');
-
-var currentBasket = BasketMgr.getCurrentBasket();
-var cart = new CartModel(currentBasket);
-
-// Access cart properties
-console.log(cart.numItems);
-console.log(cart.totals.grandTotal);
-console.log(cart.actionUrls.updateQuantityUrl);
-
-// Check if cart has items
-if (cart.items && cart.items.length > 0) {
-    // Process cart items
-    cart.items.forEach(function(item) {
-        console.log(item.productName);
-    });
-}
-```
-
-## Notes
-
-- If basket is null, the cart will have empty items array and numItems of 0
-- The model automatically calculates shipping methods for each shipment
-- Bonus products from promotions are tracked separately
-- Cart validation is performed using hooks
-- All action URLs are generated dynamically using URLUtils
-
-## Related Models
-
-- **TotalsModel** - Used for cart pricing calculations
-- **ProductLineItemsModel** - Used for product line item formatting
-- **Shipping Models** - Used for shipping method information
-- **Address Model** - Used for shipping addresses

package/docs/sfra/categories.md

@@ -1,124 +0,0 @@
-# SFRA Categories Model
-
-## Overview
-
-The Categories model represents a hierarchical structure of categories for navigation menus and category displays in SFRA applications. It provides formatted category information with URLs, subcategories, and menu display logic.
-
-## Constructor
-
-```javascript
-function categories(items)
-```
-
-Creates a Categories model instance from a collection of top-level categories.
-
-### Parameters
-
-- `items` (dw.util.ArrayList<dw.catalog.Category>) - Top level categories collection
-
-## Properties
-
-### categories
-**Type:** Array<Object>
-
-Array of formatted category objects that should be shown in menus. Each category contains:
-- `name` (string) - Category display name
-- `url` (string) - Category URL (custom alternative URL or search URL)
-- `id` (string) - Category ID
-- `subCategories` (Array<Object>) - Array of subcategory objects (if any)
-- `complexSubCategories` (boolean) - True if any subcategories have their own subcategories
-
-## Helper Functions
-
-### getCategoryUrl(category)
-Generates the appropriate URL for a category, preferring custom alternative URLs.
-
-**Parameters:**
-- `category` (dw.catalog.Category) - Category object
-
-**Returns:** string - Category URL (custom alternative URL or search URL)
-
-### categoryToObject(category)
-Converts a catalog category to a plain object with menu-appropriate formatting.
-
-**Parameters:**
-- `category` (dw.catalog.Category) - Single category to convert
-
-**Returns:** Object | null - Formatted category object or null if not shown in menu
-
-## Category Structure
-
-Each category object in the categories array contains:
-
-### Basic Properties
-- **name** - Category display name for menu labels
-- **url** - Properly formatted URL for category navigation
-- **id** - Category identifier for tracking and CSS classes
-
-### Hierarchical Properties
-- **subCategories** - Nested array of subcategory objects (same structure)
-- **complexSubCategories** - Boolean flag indicating multi-level nesting
-
-## Menu Display Logic
-
-Categories are included in the menu only if:
-1. Category has `custom.showInMenu` set to true
-2. Category has online products OR online subcategories
-3. Category meets the same criteria recursively for subcategories
-
-## URL Handling
-
-The model provides flexible URL generation:
-- **Custom URLs**: Uses `category.custom.alternativeUrl` if available
-- **Standard URLs**: Falls back to Search-Show with category ID parameter
-- **URL Cleaning**: Removes HTML entities (&amp; becomes &)
-
-## Usage Example
-
-```javascript
-var CategoriesModel = require('*/cartridge/models/categories');
-var CatalogMgr = require('dw/catalog/CatalogMgr');
-
-// Get site catalog and root categories
-var siteCatalog = CatalogMgr.getSiteCatalog();
-var topLevelCategories = siteCatalog.getRoot().getOnlineSubCategories();
-
-var categoriesModel = new CategoriesModel(topLevelCategories);
-
-// Access menu categories
-categoriesModel.categories.forEach(function(category) {
-    console.log(category.name + ' -> ' + category.url);
-    
-    if (category.subCategories) {
-        category.subCategories.forEach(function(subcat) {
-            console.log('  ' + subcat.name + ' -> ' + subcat.url);
-        });
-    }
-    
-    if (category.complexSubCategories) {
-        console.log('Category has multi-level navigation');
-    }
-});
-```
-
-## Recursive Structure
-
-The model handles deep category hierarchies:
-- Subcategories are processed recursively with the same logic
-- Each level maintains the same object structure
-- The `complexSubCategories` flag helps with menu rendering decisions
-
-## Notes
-
-- Only processes categories marked for menu display (`showInMenu`)
-- Filters out empty categories with no products or subcategories
-- Maintains hierarchical relationships for multi-level navigation
-- Provides clean URLs with proper entity handling
-- Supports both custom and standard URL patterns
-- Optimized for navigation menu rendering
-
-## Related Models
-
-- **Search Models** - Categories link to search results
-- **Product Models** - Categories contain products
-- **Content Models** - May reference category information

package/docs/sfra/content.md

@@ -1,133 +0,0 @@
-# SFRA Content Model
-
-## Overview
-
-The Content model represents a content asset in SFRA applications. It provides structured access to content information including body text, metadata, and rendering template information for content management and display.
-
-## Constructor
-
-```javascript
-function content(contentValue, renderingTemplate)
-```
-
-Creates a Content model instance from a content asset.
-
-### Parameters
-
-- `contentValue` (dw.content.Content) - Result of ContentMgr.getContent call
-- `renderingTemplate` (string) - Optional rendering template for the content
-
-### Returns
-
-Object - Content model instance, or null if content is not online
-
-## Properties
-
-### body
-**Type:** string | null
-
-The main content body text from the content asset's custom.body attribute.
-
-### UUID
-**Type:** string
-
-Unique identifier for the content asset.
-
-### ID
-**Type:** string
-
-Content asset ID for referencing and linking.
-
-### name
-**Type:** string
-
-Display name of the content asset.
-
-### template
-**Type:** string
-
-Rendering template path for the content. Uses either:
-- Content asset's specified template
-- Provided renderingTemplate parameter
-- Default: 'components/content/contentAssetInc'
-
-### pageTitle
-**Type:** string
-
-SEO page title for the content asset.
-
-### pageDescription
-**Type:** string
-
-SEO meta description for the content asset.
-
-### pageKeywords
-**Type:** string
-
-SEO meta keywords for the content asset.
-
-### pageMetaTags
-**Type:** Array
-
-Additional SEO meta tags for the content asset.
-
-## Content Availability
-
-The model only processes online content assets. If `contentValue.online` is false, the constructor returns null instead of a content object.
-
-## Template Resolution
-
-Template selection follows this priority:
-1. Content asset's own template property
-2. Provided renderingTemplate parameter
-3. Default template: 'components/content/contentAssetInc'
-
-## Usage Example
-
-```javascript
-var ContentModel = require('*/cartridge/models/content');
-var ContentMgr = require('dw/content/ContentMgr');
-
-// Get content asset
-var contentAsset = ContentMgr.getContent('privacy-policy');
-var customTemplate = 'pages/content/contentPage';
-
-var content = new ContentModel(contentAsset, customTemplate);
-
-if (content) {
-    // Access content properties
-    console.log(content.name);           // "Privacy Policy"
-    console.log(content.ID);             // "privacy-policy"
-    console.log(content.body);           // Content body HTML
-    console.log(content.template);       // Template path
-    
-    // Access SEO properties
-    console.log(content.pageTitle);      // SEO title
-    console.log(content.pageDescription); // SEO description
-} else {
-    console.log('Content is offline or not found');
-}
-```
-
-## SEO Support
-
-The model provides comprehensive SEO metadata:
-- **pageTitle** - For HTML title tag
-- **pageDescription** - For meta description
-- **pageKeywords** - For meta keywords
-- **pageMetaTags** - For additional custom meta tags
-
-## Notes
-
-- Only processes online content assets
-- Provides flexible template resolution
-- Includes comprehensive SEO metadata
-- Handles missing content gracefully (returns null)
-- Body content comes from custom.body attribute
-- Template fallback ensures content can always be rendered
-
-## Related Models
-
-- **Page Models** - May include content assets
-- **Search Models** - May return content in search results
-- **Category Models** - May reference related content