sfcc-sfra-models

SFRA Models Development Skill

This skill guides you through creating and extending models in Salesforce B2C Commerce SFRA.

IMPORTANT: Before developing SFRA models, consult the sfcc-performance skill for database optimization and index-friendly API usage.

Quick Checklist

[ ] Model returns pure JSON (no API objects)
[ ] Decorators mutate objects, never clone/return
[ ] Expensive properties use lazy loading or caching
[ ] Sensitive data is sanitized or excluded
[ ] Custom cartridge mirrors base structure
[ ] Unit tests cover constructor and edge cases

What Are SFRA Models?

SFRA models are a JSON transformation layer that:

• Convert SFCC Script API objects into pure JSON
• Apply business logic specific to the storefront
• Structure data for optimal template rendering
• Provide a consistent interface between controllers and views

Models are passed to templates via viewData (accessible as pdict in templates).

Model Design Principles

1. Pure JSON Output - Return only JSON-serializable data
2. Single Responsibility - Each model handles one domain
3. Composability - Models should be easily combinable
4. Performance - Minimize API calls and database queries
5. Testability - Models should be unit-testable with mock data

Basic Model Pattern

'use strict';

/**
 * Address Model
 * @param {dw.customer.OrderAddress} addressObject - Address from API
 * @constructor
 */
function Address(addressObject) {
    if (addressObject) {
        this.address = {
            firstName: addressObject.firstName,
            lastName: addressObject.lastName,
            address1: addressObject.address1,
            city: addressObject.city,
            postalCode: addressObject.postalCode,
            stateCode: addressObject.stateCode,
            countryCode: addressObject.countryCode.value,
            phone: addressObject.phone
        };
    }
}

module.exports = Address;

Decorator Pattern