Replacing OOTB B2B Commerce Components with Open Code
This skill replaces OOTB (out-of-the-box) B2B Commerce component definitions in site metadata
files with their open source
equivalents, or looks up the equivalent open code component for given OOTB definitions without making changes. It uses an authoritative mapping loaded from
assets/ootb-to-open-code-mapping.json
.
Scope
Modes: Full replace runs the scan (Step 1), user selection if needed, then
updates (Step 2–3).
Lookup only (user asks for equivalents but not to change files): apply the mapping-authority rule and report OOTB →
for the named components or for definitions found in the scoped
—
do not call Write unless the user confirms replacement.
View-scoped work: limit file discovery and reads to
sfdc_cms__view/<ViewName>/
(or the path the user gives) instead of all views.
Prerequisites
Resolve
Read
and pick the active package directory. Extract
and use the entry with
; if no entry is flagged default, use the first entry. Use this value as
everywhere below. If
is missing or has no
, tell the user and abort.
Delegate setup
Before replacing components, delegate to the commerce-b2b-open-code-components-integrate skill to ensure:
- Open source repository is cloned at
.tmp/b2b-commerce-open-source-components
- Store is selected and site metadata is retrieved locally
- Open code components are copied to the store's site metadata
The integrating skill owns the
clone lifecycle (it prompts the user to reuse or re-clone an existing checkout); this skill assumes the clone is already present.
Send a plain-text chat reply to the user (per Rule 1): "Before replacing components, I need to verify that the open code components are set up in your store. Let me check..."
If any prerequisite is not met, the integrating skill will handle it. Once all checks pass, proceed to the replacement workflow.
Required state after prerequisites:
- Package dir — the value resolved above (e.g., )
- Store name — e.g.,
- Site metadata path —
<package-dir>/main/default/digitalExperiences/site/<store-name>/
Replacement Workflow
Step 1: Scan Site and Cross-Reference Mapping
This step is MANDATORY. Always scan the site first before attempting any replacements.
Send a plain-text chat reply to the user (per Rule 1): "I'm scanning your store's site metadata to find all OOTB commerce components currently in use and checking which have open code equivalents."
Step 1a — Find affected files (one command, simple literal match):
bash
grep -rl '"commerce' \
<package-dir>/main/default/digitalExperiences/site/<store-name>/sfdc_cms__view/ \
<package-dir>/main/default/digitalExperiences/site/<store-name>/sfdc_cms__themeLayout/ \
--include="content.json"
Step 1b — Read the mapping and parse the matched files. Read
assets/ootb-to-open-code-mapping.json
once into memory. Then, using the
Read tool, parse each matched file and extract all
values that start with
(e.g.,
commerce_builder:cartBadge
). Collect a deduplicated list of OOTB components across all files.
Step 1c — List repo components (one command):
bash
ls .tmp/b2b-commerce-open-source-components/force-app/main/default/sfdc_cms__lwc/
Using the parsed definitions, the
output, and the mapping table, categorize every discovered OOTB component into three groups:
Show the user a breakdown and a selectable list:
First, inform the user about skipped and unmapped components:
text
Found X OOTB components in your site:
In mapping table but NOT in repo (skipping):
- commerce_builder:quoteSummary → site:quoteSummary (not found in repo)
No mapping available (not in mapping table):
- commerce_builder:actionButtons
- commerce_builder:layoutHeaderOne
- commerce_builder:searchInputContainer
- commerce_builder:myAccountMegaMenu
Then present the replaceable components as a multi-select list so the user can pick from checkboxes instead of typing. Include an "All of the above" option:
text
Which components would you like to replace?
☐ commerce_builder:heading → site:productHeading
☐ commerce_builder:cartBadge → site:cartBadge
☐ commerce_builder:searchInput → site:searchInput
☐ All of the above
If user provided specific component name(s) in the original request, pre-filter to those and skip the selection prompt.
Step 2: Replace in content.json
Send a plain-text chat reply to the user (per Rule 1): "I'm now replacing the selected OOTB component definitions with their open code equivalents in your site's content.json files."
The affected files are already known from Step 1. For each file that contains selected components:
- Use the Read tool to read the file
- For each selected OOTB component, confirm again that the mapped target exists in the open code repo. Only proceed with replacements that pass this check.
- Replace all matching values with their mapped open code equivalents — always use the exact string from the mapping table
- Example:
"definition": "commerce_builder:heading"
→ "definition": "site:productHeading"
- Use the Write tool to save the updated file
- Preserve all other JSON properties — only values change
Batch efficiently: if a file contains multiple OOTB components, apply ALL replacements in a single Read → modify → Write pass. Do NOT read and write the same file multiple times.
Step 3: Report
text
✅ Replacement Complete!
Replaced X components across Y files:
- commerce_builder:heading → site:productHeading (3 files)
- commerce_builder:cartBadge → site:cartBadge (2 files)
- commerce_builder:searchInput → site:searchInput (4 files)
Skipped (not in repo):
- commerce_builder:quoteSummary
No mapping available (left unchanged):
- commerce_builder:actionButtons
- commerce_builder:layoutHeaderOne
- commerce_builder:searchInputContainer
Modified files:
- sfdc_cms__view/Home/content.json
- sfdc_cms__view/Product_Detail/content.json
- sfdc_cms__themeLayout/DefaultTheme/content.json
Next Steps:
1. Deploy: sf project deploy start -d <package-dir>/main/default/digitalExperiences/site/<store-name>
2. Test the store thoroughly in Experience Builder
3. Publish your site when ready
Example Interaction
User: "Replace OOTB components with open code versions"
Agent: "Before replacing components, I need to verify that the open code components are set up in your store. Let me check..."
- ✓ Open source repo cloned
- ✓ Store metadata available for My_B2B_Store1
- ✓ Open code components are integrated
Agent: "I'm scanning your store's site metadata to find all OOTB commerce components and checking which have open code equivalents."
(Runs grep -rl to find files with commerce definitions, Reads those files to extract component names, runs ls to list repo components, then cross-references with mapping table)
text
Found 8 OOTB components in your site:
No mapping available (not in mapping table):
- commerce_builder:searchInputContainer
- commerce_builder:layoutHeaderOne
- commerce_builder:myAccountMegaMenu
- commerce_builder:actionButtons
Agent (asks the user via a multi-select prompt):
text
Which components would you like to replace?
☐ commerce_builder:heading → site:productHeading
☐ commerce_builder:cartBadge → site:cartBadge
☐ commerce_builder:searchInput → site:searchInput
☐ commerce_builder:cartSummary → site:cartSummary
☐ All of the above
User: (selects heading and cartBadge)
Agent: "I'm now replacing the selected OOTB component definitions with their open code equivalents in your site's content.json files."
(Files already known from scan — one Read/Write pass per affected file, all replacements batched)
text
✅ Replacement Complete!
Replaced 2 components across 5 files:
- commerce_builder:heading → site:productHeading (3 files)
- commerce_builder:cartBadge → site:cartBadge (2 files)
No mapping available (left unchanged):
- commerce_builder:searchInputContainer
- commerce_builder:layoutHeaderOne
- commerce_builder:myAccountMegaMenu
- commerce_builder:actionButtons
Modified files:
- sfdc_cms__view/Home/content.json
- sfdc_cms__view/Product_Detail/content.json
- sfdc_cms__themeLayout/DefaultTheme/content.json
Next Steps:
1. Deploy: sf project deploy start -d force-app/main/default/digitalExperiences/site/My_B2B_Store1
2. Test the store thoroughly in Experience Builder
Rules
- Always explain in chat before executing. Before every Bash or Write tool call, send a plain-text reply in the conversation that says what the command will do and why. The explanation MUST appear as a normal chat message preceding the tool call. Do NOT embed it inside the command itself (no lines, no comments), do NOT prefix it to the command, and do NOT rely solely on the tool's parameter — that field is not guaranteed to be visible to the user. After the explanation, issue the tool call and wait for the user to approve it before continuing.
assets/ootb-to-open-code-mapping.json
is the only source of truth. Every OOTB → open-code mapping comes from that file; never guess, infer, or hallucinate component names. Each replacement's new MUST be the exact mapped value from the file, which always uses the namespace (e.g. ). Before writing, verify the mapped target exists in the cloned open code components repo (under .tmp/b2b-commerce-open-source-components/force-app/main/default/sfdc_cms__lwc/
); if it is not present, skip the replacement and report it under "not in repo".
- Use Read and Write tools for JSON files. Use the Read tool to parse files and the Write tool to update them. Do NOT use bash to parse or edit JSON — no sed, awk, perl, or regex on JSON content. Bash is only for simple file discovery (, , ) — never for extracting or modifying JSON values.
- Minimize commands. Batch work into as few commands as possible. Use a single grep to scan all files, a single ls to verify the repo, and one Read/Write pass per file. Do NOT run a separate command for every component or every directory.
Error Handling
| Error | Message | Action |
|---|
| Prerequisites not met | "Open code components are not integrated yet." | Run integrating skill first |
| No mapping found | "No mapping found for '{component}'." | Show available mappings, report as unmapped |
| Component not in repo | "Open code component '{name}' not found in cloned repo." | Skip and inform user |
| No OOTB components in site | "No OOTB commerce components found in site metadata." | Inform user, nothing to replace |
| No replaceable components | "All OOTB components found are unmapped — none can be replaced." | Show the unmapped list, suggest checking for updated mappings |
| content.json parse error | "Failed to parse content.json: {file}" | Show error, skip file, continue with remaining files |
Verification Checklist