@salesforce/afv-skills 1.1.0 → 1.2.0

package/skills/salesforce-experience-lwr-site/docs/bootstrap-template-byo-lwr.md

@@ -0,0 +1,224 @@
+# Build Your Own (LWR) Template
+
+**Use when** creating a new site or retrieving default values for site metadata.
+
+## Table of Contents
+
+- Bootstrap Options
+- Default Values Reference
+
+## Bootstrap Options
+
+**IMPORTANT**: First site setup initializes services. Warn user - recommend Option 1 for first site.
+
+Ask user to choose:
+
+1. Create in org, then download metadata
+2. Scaffold locally before deploying
+
+### Option 1: Create in Org
+
+```bash
+sf community create --name "{siteName}" --template-name 'Build Your Own (LWR)' --url-path-prefix "{prefix}"
+```
+
+After creation, retrieve metadata using sf CLI.
+
+### Option 2: Scaffold Locally
+
+```bash
+sf template generate digital-experience site --name "{siteName}" --template-name 'Build Your Own (LWR)' --url-path-prefix "{prefix}"
+```
+
+Generates metadata with defaults: DigitalExperienceConfig, DigitalExperiences, Network, CustomSite, and content (route, view, themeLayout, etc.).
+
+#### Post-Creation Config
+
+After site metadata is generated, use MCP tool `execute_metadata_action` to fetch additional information about the template:
+
+```json
+{
+  "metadataType": "ExperienceSiteLwr",
+  "actionName": "getSiteTemplateMetadata",
+  "parameters": { "templateDevName": "talon-template-byo" }
+}
+```
+
+If result provides `disabledViews`, delete both view and route directories.
+
+**Example**: If `disabledViews` includes "tooManyRequests":
+
+- Delete: `digitalExperiences/site/{siteDevName}/sfdc_cms__view/tooManyRequests/`
+- Delete: `digitalExperiences/site/{siteDevName}/sfdc_cms__route/Too_Many_Requests/`
+
+---
+
+## Default Values Reference
+
+**Note**: CLI generates these. Listed for reference only - use CLI first.
+
+### Metadata Defaults
+
+**DigitalExperienceConfig**:
+
+```yaml
+label: {siteName}
+urlPathPrefix: {siteUrlPathPrefix}
+space: site/{siteName}1
+```
+
+**DigitalExperienceBundle**:
+
+```yaml
+label: {siteName}1
+modules: [sfdc_cms__collection, sfdc_cms__mobilePublisherConfig]
+```
+
+**Network**:
+
+```yaml
+allowInternalUserLogin: false
+allowMembersToFlag: false
+changePasswordTemplate: unfiled$public/CommunityChangePasswordEmailTemplate
+disableReputationRecordConversations: true
+emailSenderAddress: {adminEmailAddress}
+emailSenderName: {siteName}
+embeddedLoginEnabled: false
+enableApexCDNCaching: true
+enableCustomVFErrorPageOverrides: false
+enableDirectMessages: true
+enableExpFriendlyUrlsAsDefault: false
+enableExperienceBundleBasedSnaOverrideEnabled: true
+enableGuestChatter: false
+enableGuestFileAccess: false
+enableGuestMemberVisibility: false
+enableImageOptimizationCDN: true
+enableInvitation: false
+enableKnowledgeable: false
+enableLWRExperienceConnectedApp: true
+enableMemberVisibility: false
+enableNicknameDisplay: true
+enablePrivateMessages: false
+enableReputation: false
+enableShowAllNetworkSettings: false
+enableSiteAsContainer: true
+enableTalkingAboutStats: true
+enableTopicAssignmentRules: true
+enableTopicSuggestions: false
+enableUpDownVote: false
+forgotPasswordTemplate: unfiled$public/CommunityForgotPasswordEmailTemplate
+gatherCustomerSentimentData: false
+headlessForgotPasswordTemplate: unfiled$public/CommunityHeadlessForgotPasswordTemplate
+headlessRegistrationTemplate: unfiled$public/CommunityHeadlessRegistrationTemplate
+networkMemberGroups:
+  - profile: admin
+networkPageOverrides:
+  - changePasswordPageOverrideSetting: Standard
+  - forgotPasswordPageOverrideSetting: Designer
+  - homePageOverrideSetting: Designer
+  - loginPageOverrideSetting: Designer
+  - selfRegProfilePageOverrideSetting: Designer
+newSenderAddress: admin@company.com
+picassoSite: {siteName}1
+selfRegistration: false
+sendWelcomeEmail: true
+site: {siteName}
+siteArchiveStatus: NotArchived
+status: UnderConstruction
+tabs:
+  - defaultTab: home
+  - standardTab: Chatter
+urlPathPrefix: {siteUrlPathPrefix}vforcesite
+welcomeTemplate: unfiled$public/CommunityWelcomeEmailTemplate
+```
+
+**CustomSite**:
+
+```yaml
+active: true
+allowGuestPaymentsApi: false
+allowHomePage: false
+allowStandardAnswersPages: false
+allowStandardIdeasPages: false
+allowStandardLookups: false
+allowStandardPortalPages: true
+allowStandardSearch: false
+authorizationRequiredPage: CommunitiesLogin
+bandwidthExceededPage: BandwidthExceeded
+browserXssProtection: true
+cachePublicVisualforcePagesInProxyServers: true
+clickjackProtectionLevel: SameOriginOnly
+contentSniffingProtection: true
+enableAuraRequests: true
+fileNotFoundPage: FileNotFound
+genericErrorPage: Exception
+inMaintenancePage: InMaintenance
+indexPage: CommunitiesLanding
+masterLabel: {siteName}
+redirectToCustomDomain: false
+referrerPolicyOriginWhenCrossOrigin: true
+selfRegPage: CommunitiesSelfReg
+siteType: ChatterNetwork
+urlPathPrefix: {siteUrlPathPrefix}vforcesite
+```
+
+### Content Defaults
+
+apiNames and other metadata of site contents:
+
+**sfdc_cms__appPage**:
+
+- mainAppPage
+
+**sfdc_cms__brandingSet**:
+
+- Build_Your_Own_LWR
+
+**sfdc_cms__languageSettings**:
+
+- languages
+
+**sfdc_cms__mobilePublisherConfig**:
+
+- mobilePublisherConfig
+
+**sfdc_cms__theme**:
+
+- Build_Your_Own_LWR
+
+**sfdc_cms__route**:
+
+| Route | apiName | routeType | urlPrefix | urlName | viewId | configurationTags |
+|-------|---------|-----------|-----------|---------|--------|-------------------|
+| Home | Home | home | "" | home | home | |
+| Login | Login | login-main | login | login | login | |
+| Register | Register | self-register | SelfRegister | register | register | |
+| Forgot_Password | Forgot_Password | forgot-password | ForgotPassword | forgot-password | forgotPassword | |
+| Check_Password | Check_Password | check-password | CheckPasswordResetEmail | check-password | checkPasswordResetEmail | |
+| Error | Error | error | error | error | error | |
+| Service_Not_Available | Service_Not_Available | service-not-available | service-not-available | service-not-available | serviceNotAvailable | allow-in-static-site |
+| Too_Many_Requests | Too_Many_Requests | too-many-requests | too-many-requests | too-many-requests | tooManyRequests | too-many-requests, allow-in-static-site |
+| News_Detail__c | News_Detail__c | managed-content-sfdc_cms__news | news | news-detail | newsDetail | |
+
+**sfdc_cms__view**:
+
+| View | apiName | viewType | urlName | themeLayoutType |
+|------|---------|----------|---------|-----------------|
+| home | home | home | home | Inner |
+| login | login | login-main | login | Inner |
+| register | register | self-register | register | Inner |
+| forgotPassword | forgotPassword | forgot-password | forgot-password | Inner |
+| checkPasswordResetEmail | checkPasswordResetEmail | check-password | check-password | Inner |
+| error | error | error | error | Inner |
+| serviceNotAvailable | serviceNotAvailable | service-not-available | service-not-available | ServiceNotAvailable |
+| tooManyRequests | tooManyRequests | too-many-requests | too-many-requests | ServiceNotAvailable |
+| newsDetail | newsDetail | managed-content-sfdc_cms__news | news-detail | Inner |
+
+**sfdc_cms__site**:
+
+- {siteName}1
+
+**sfdc_cms__themeLayout**:
+
+- scopedHeaderAndFooter
+- snaThemeLayout

package/skills/salesforce-experience-lwr-site/docs/configure-content-brandingSet.md

@@ -0,0 +1,131 @@
+# Content Type: sfdc_cms__brandingSet
+
+**Use when** user explicitly requests creating/updating branding set.
+
+## Table of Contents
+
+- Core Principles
+- Generation Guidelines
+- Branding Property Patterns
+
+## Core Principles
+
+1. **Purpose**: Manage site-wide branding properties (colors, fonts, etc.).
+2. **Site Association**: Branding sets are linked to the site configuration.
+
+## Generation Guidelines
+
+### 1. Directory Structure
+
+1. **Location**: `digitalExperiences/site/[SITE_NAME]/sfdc_cms__brandingSet/[BRANDING_SET_NAME]/`
+2. **Required Files**:
+  - `_meta.json` - Metadata file defining the API name and type
+  - `content.json` - Content file defining the configuration and layout
+3. **Naming Convention**: Underscore-separated names (e.g., `Branding_Set`).
+
+### 2. _meta.json Structure
+
+The `_meta.json` file must contain:
+
+```json
+{
+  "apiName": "[BRANDING_SET_NAME]",
+  "type": "sfdc_cms__brandingSet",
+  "path": "brandingSets"
+}
+```
+
+**Rules**:
+
+- `apiName`: Must match the directory name exactly (e.g., `Branding_Set`)
+
+### 3. content.json Structure
+
+The `content.json` file must contain:
+
+```json
+{
+  "type": "sfdc_cms__brandingSet",
+  "title": "[DISPLAY_TITLE]",
+  "contentBody": {},
+  "urlName": "[URL_NAME]"
+}
+```
+
+**Field Definitions**:
+
+- `type`: **Required**. Represents the content type. The only supported value is `"sfdc_cms__brandingSet"`.
+- `title`: **Required**. Human-readable display title (e.g., Branding Set).
+  - Maximum length is **100 characters**.
+  - Must be **unique** within the space's brandingSet content items.
+- `contentBody`: Include all `required` properties from `schemaDefinition`. Use `examplesOfContentType` for reference.
+  - `brandingSetType`: Represents whether the color palette is for the entire site or a specific section.
+    - `APP`: The branding set applies to the entire site. There can be only one branding set of this type.
+    - `SCOPED`: A `SCOPED` branding set can be applied only to a section component for granular overrides.
+  - `definitionName`: **Required**. Represents the name for the branding set used in the site or template’s theme.
+    - **Build Your Own (LWR)**: uses `talon-template-byo:branding`
+    - **Microsite**: uses `microsite-template-marketing:branding`
+  - `values`: **Required**. Represents a map (object) of branding values (colors, fonts, etc.) that can be applied to a site.
+    - **Format**: An object containing key-value pairs that represent branding-set values.
+    - **Patterns**: See the "Branding Property Patterns" section for details on value relationships.
+- `urlName`: Lowercase with hyphens (e.g., `branding-set`)
+
+**Rules**:
+
+- Before any actions, *always* call `execute_metadata_action` to get the full schema and examples per the skill document.
+
+### 4. Naming Conventions Summary
+
+| Field | Format | Example |
+|-------|--------|--------|
+| Directory/apiName | Underscore-separated | `Branding_Set` |
+| title | Human-readable | `Branding Set` |
+| urlName | Lowercase-hyphens | `build-your-own-lwr` |
+
+### 5. Generation Checklist
+
+- [ ] Directory and `_meta.json` follow naming conventions (1, 2)
+- [ ] `content.json` has all required fields (3)
+- [ ] `contentBody` follows the schema provided by `execute_metadata_action`
+
+## Branding Property Patterns
+
+When generating or validating `contentBody.values`, follow these established patterns for consistency:
+
+### 1. Color Scaling Patterns (The "Rule of 3")
+
+Salesforce uses a numeric suffix system (`Color`, `Color1`, `Color2`, `Color3`) to create a tonal palette.
+
+- **Darkening Trend**: As the suffix number increases, the color becomes progressively darker.
+  - Example: `BackgroundColor` (#ffffff) → `_BackgroundColor1` (#ebebeb) → `_BackgroundColor2` (#c2c2c2) → `_BackgroundColor3` (#858585).
+- **Contrast/Foreground Colors**: Every base color has a corresponding `ForegroundColor` to ensure accessibility.
+  - **WCAG Compliance**: Ensure a color contrast ratio of at least **4.5:1** between the background and foreground colors for standard text.
+  - Dark base colors usually have white (#ffffff) foregrounds.
+  - Light base colors (like `_NeutralColor`) usually have black (#000000) foregrounds.
+
+### 2. Font Size Hierarchy
+
+- **Base vs. Small**: The `Small` variant is typically **75%** of the base size.
+  - Example: `BodyFontSize` (1rem) → `BodySmallFontSize` (0.75rem).
+- **Heading Scale**: Headings follow a standard typographic scale:
+  - `HeadingExtraLarge`: 2.5rem
+  - `HeadingLarge`: 1.75rem (~70% of XL)
+  - `HeadingMedium`: 1.25rem (~50% of XL)
+  - `HeadingSmall`: 1.125rem
+
+### 3. Design Token Mapping
+
+Prefer using **DXP Design Tokens** over hardcoded values where possible:
+
+- **Fonts**: Use `var(--dxp-s-html-font-family)` for base, body, and button fonts.
+- **Brand Alignment**: Use `var(--dxp-g-brand)` for primary brand colors and links.
+
+### 4. Component Consistency
+
+- **Buttons**: Maintain consistent `BorderRadius` (e.g., 4px) across all button sizes (Small, Medium, Large).
+- **Form Elements**: `FormElementLabelFontSize` and `FormElementTextFontSize` should match.
+
+### 5. Spacing and Ratios
+
+- **Device Ratios**: Desktop spacing (padding/spacers) is typically **1.33x** larger than mobile spacing.
+  - Example: `ColumnSpacerSizeDesktop` (1rem) vs `ColumnSpacerSizeMobile` (0.75rem).

package/skills/salesforce-experience-lwr-site/docs/configure-content-route.md

@@ -0,0 +1,232 @@
+# Content Type: sfdc_cms__route
+
+**Use when** user explicitly requests creating a new page. Not for editing existing routes.
+
+## Table of Contents
+
+- Generation Guidelines
+- Core Principles
+- Directory Structure (All Routes)
+- _meta.json Structure
+- Part A: CUSTOM PAGES
+- Part B: OBJECT PAGES
+
+## Generation Guidelines
+
+**PAGE TYPES**: These guidelines supports two types of pages:
+
+1. **Custom Pages** - Single route pages for custom content (e.g., About Us). **Note**: Standard pages (e.g., Home, Login) come pre-built with the site and cannot be created.
+2. **Object Pages** - Requires 3 routes: Detail, List, and Related List (e.g., Account, custom objects)
+
+## Core Principles
+
+1. **Purpose**: Generate new routes under the `sfdc_cms__route` directory.
+2. **View Association**: Each route must reference a corresponding view in the `sfdc_cms__view` directory.
+3. **CRITICAL**: The `routeType` in the route's `content.json` MUST exactly match the `viewType` in the corresponding view's `content.json`. This is a required validation rule.
+
+## Directory Structure (All Routes)
+
+1. **Location**: `digitalExperiences/site/[SITE_NAME]/sfdc_cms__route/[ROUTE_NAME]/`
+2. **Required Files**:
+  - `_meta.json` - Metadata file defining the API name and type
+  - `content.json` - Content file defining the configuration and layout
+3. **Naming Convention**: Underscore-separated names with "__c" suffix (About_Us__c, Account_Detail__c)
+
+## _meta.json Structure (All Routes)
+
+The `_meta.json` file must contain:
+
+```json
+{
+  "apiName": "[ROUTE_NAME]",
+  "type": "sfdc_cms__route",
+  "path": "routes"
+}
+```
+
+**Rules**:
+
+- `apiName`: Must match the route directory name exactly
+- `type`: Always `"sfdc_cms__route"`
+- `path`: Always `"routes"`
+
+## Part A: CUSTOM PAGES
+
+Use this section when creating single-route custom content pages.
+
+### A.1. content.json Structure
+
+The `content.json` file must contain:
+
+```json
+{
+  "type": "sfdc_cms__route",
+  "title": "[DISPLAY_TITLE]",
+  "contentBody": {},
+  "urlName": "[URL_NAME]"
+}
+```
+
+**Field Definitions**:
+
+- `type`: Always `"sfdc_cms__route"`
+- `title`: Human-readable display title (e.g., About Us)
+- `contentBody`: Include all `required` properties from `schemaDefinition`. Use `examplesOfContentType` for reference.
+- `urlName`: URL identifier (lowercase with hyphens, e.g., `about-us`)
+
+### A.2. Naming Conventions
+
+For a page named "About Us":
+
+| Field | Format | Example |
+|-------|--------|--------|
+| Directory Name | Underscore-separated + "__c" | `About_Us__c` |
+| apiName | Same as directory | `About_Us__c` |
+| title | Human-readable | `About Us` |
+| contentBody.activeViewId | Underscore-separated (no __c) | `About_Us` |
+| contentBody.routeType | "custom-" + lowercase hyphens | `custom-about-us` |
+| contentBody.urlPrefix | Lowercase hyphens | `about-us` |
+| urlName | Lowercase hyphens | `about-us` |
+
+**CRITICAL**: `routeType` MUST exactly match `viewType` in the corresponding view's `content.json`.
+
+### A.3. View Dependency
+
+- Before creating a route, ensure the corresponding view exists in `sfdc_cms__view/[view_name]/`
+- If the view doesn't exist, create it first following the view creation guidelines
+
+### A.4. Generation Checklist
+
+- [ ] Route directory and files created (see Directory Structure)
+- [ ] `_meta.json` follows structure (see _meta.json Structure)
+- [ ] `content.json` follows structure (see A.1)
+- [ ] All naming conventions applied (see A.2)
+- [ ] Corresponding view exists (see A.3)
+
+## Part B: OBJECT PAGES
+
+Use this section when creating object pages that require Detail, List, and Related List routes.
+
+### B.1. Overview
+
+Object pages require **three routes** to be created together:
+
+1. **Detail Route** - Displays a single record
+2. **List Route** - Displays a list of records
+3. **Related List Route** - Displays related records for a parent record
+
+**OBJECT TYPES**: Two types of Salesforce objects use different `routeType` formats:
+
+| Object Type | routeType Format | Example |
+|-------------|------------------|----------|
+| **Standard** (Account, Contact) | `[type]-[keyPrefix]` | `detail-001`, `list-001`, `relatedlist-001` |
+| **Custom** (Test_Object__c) | `[type]-[ObjectApiName]` | `detail-Test_Object__c`, `list-Test_Object__c` |
+
+- **keyPrefix**: 3-character identifier unique to each standard object (Account=001, Contact=003)
+- **ObjectApiName**: Custom object API name including the "__c" suffix
+
+Obtain object information from the `objectList` MCP output:
+
+```json
+[
+  ["Label", "ApiName", "KeyPrefix", "IsCustom"]
+]
+```
+
+### B.2. Required Routes
+
+Create three directories under `sfdc_cms__route/`:
+
+- `[OBJECT_NAME]_Detail__c/`
+- `[OBJECT_NAME]_List__c/`
+- `[OBJECT_NAME]_Related_List__c/`
+
+### B.3. content.json Structure
+
+Each route's `content.json` file must contain:
+
+```json
+{
+  "type": "sfdc_cms__route",
+  "title": "[OBJECT_NAME] [TYPE]",
+  "contentBody": {},
+  "urlName": "[object_name_lowercase]-[type]"
+}
+```
+
+**Field Definitions**:
+
+- `type`: Always `"sfdc_cms__route"`
+- `title`: Human-readable title (Account Detail, Account List)
+- `contentBody`: Include all `required` properties from `schemaDefinition`. Use `examplesOfContentType` for reference.
+- `contentBody.urlPrefix`: **CRITICAL**: Must be identical across all three object page views (Detail, List, and Related List) for the same object.
+- `urlName`: Lowercase with hyphens (account-detail, account-list)
+
+### B.4. Object Page Examples
+
+Use `[ObjectName]` as the object name (Account, Test_Object) and `[IDENTIFIER]` as:
+
+- **Standard objects**: keyPrefix (001 for Account, 003 for Contact)
+- **Custom objects**: ObjectApiName (Test_Object__c)
+
+#### content.json Template
+
+```json
+{
+  "type": "sfdc_cms__route",
+  "title": "[ObjectName] [Detail|List|Related List]",
+  "contentBody": {
+    "activeViewId": "[ObjectName]_[Detail|List|Related_List]",
+    "configurationTags": [],
+    "pageAccess": "UseParent",
+    "routeType": "[detail|list|relatedlist]-[IDENTIFIER]",
+    "urlPrefix": "[object-name-lowercase]"
+  },
+  "urlName": "[object-name-lowercase]-[detail|list|related-list]"
+}
+```
+
+**Rules**:
+
+- Before any actions, *always* call `execute_metadata_action` to get the full schema and examples per the skill document.
+
+#### routeType Examples
+
+| Route Type | Standard (Account) | Custom (Test_Object__c) |
+|------------|-------------------|------------------------|
+| Detail | `detail-001` | `detail-Test_Object__c` |
+| List | `list-001` | `list-Test_Object__c` |
+| Related List | `relatedlist-001` | `relatedlist-Test_Object__c` |
+
+### B.5. Naming Conventions
+
+For an object named "Account":
+
+| Field | Detail | List | Related List |
+|-------|--------|------|---------------|
+| Directory Name | `Account_Detail__c` | `Account_List__c` | `Account_Related_List__c` |
+| apiName | `Account_Detail__c` | `Account_List__c` | `Account_Related_List__c` |
+| title | `Account Detail` | `Account List` | `Account Related List` |
+| activeViewId | `Account_Detail` | `Account_List` | `Account_Related_List` |
+| routeType (Standard) | `detail-[keyPrefix]` | `list-[keyPrefix]` | `relatedlist-[keyPrefix]` |
+| routeType (Custom) | `detail-[ObjectApiName]` | `list-[ObjectApiName]` | `relatedlist-[ObjectApiName]` |
+| urlPrefix | `account` | `account` | `account` |
+| urlName | `account-detail` | `account-list` | `account-related-list` |
+
+**CRITICAL**: `routeType` MUST exactly match `viewType` in the corresponding view's `content.json`.
+
+### B.6. View Dependency
+
+- Before creating routes, ensure corresponding views exist in `sfdc_cms__view/`:
+  - `[ObjectName]_Detail/`, `[ObjectName]_List/`, `[ObjectName]_Related_List/`
+- `activeViewId` must match the view directory name exactly
+- `routeType` must exactly match `viewType` in the corresponding view
+- If views don't exist, create them first following the view creation guidelines
+
+### B.7. Generation Checklist
+
+- [ ] Object type determined (Standard or Custom) and identifier obtained (keyPrefix or ObjectApiName)
+- [ ] All three routes created: **Detail**, **List**, and **Related List**, each with `_meta.json` and `content.json`
+- [ ] All naming conventions applied (see B.5)
+- [ ] Corresponding views exist (see B.6)
+- [ ] `routeType` matches `viewType` for all three routes