npm - @salesforce/afv-skills - Versions diffs - 1.6.7 → 1.6.8 - Mend

@salesforce/afv-skills 1.6.7 → 1.6.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

package/skills/generating-experience-lwr-site/docs/configure-content-brandingSet.md DELETED Viewed

@@ -1,141 +0,0 @@
-# Content Type: sfdc_cms__brandingSet
-**Use when** user explicitly requests creating/updating branding set.
-## Table of Contents
-- Core Principles
-- Generation Guidelines
-- Editing Existing Branding Sets
-- 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`.
-  1. **Seed**: Always call `execute_metadata_action` with `shouldIncludeExamples: true`. Copy the *entire* example object from `examplesOfContentType[0]` into `content.json`. **NEVER** start from a minimal stub.
-  2. **Recalculate (CRITICAL STOP)**: You MUST stop and perform explicit changes for dependent tokens BEFORE generating JSON.
-    - [] Refer to "Branding Property Patterns" for detailed calculations.
-  - `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`)
-### 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
-- [ ] `content.json` has all required fields
-- [ ] `contentBody` follows the schema provided by `execute_metadata_action`
-- [ ] **STOP AND VERIFY**: `contentBody.values` honors all **Branding Property Patterns** defined below and explicitly recalculated and updated all dependent tokens based on any token updates requested by the user.
-## Editing Existing Branding Sets
-Use this section when modifying existing branding sets under the `sfdc_cms__brandingSet` directory.
-### Editing Checklist
-- [ ] Ensure all modified branding properties honor the **Branding Property Patterns** defined below.
-## 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/generating-experience-lwr-site/docs/configure-content-route.md DELETED Viewed

@@ -1,232 +0,0 @@
-# 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

package/skills/generating-experience-lwr-site/docs/configure-content-themeLayout.md DELETED Viewed

@@ -1,145 +0,0 @@
-# Content Type: sfdc_cms__themeLayout
-**Use when** user explicitly requests creating a new layout.
-## Table of Contents
-- Directory Structure
-- Purpose A: Generate new theme layouts under the `sfdc_cms__themeLayout` directory.
-  - _meta.json Structure
-  - content.json Structure
-  - Naming Conventions
-  - Theme Sync After Creation
-  - Generation Checklist
-- Purpose B: Editing existing theme layouts under the `sfdc_cms__themeLayout` directory.
-## Directory Structure
-1. **Location**: `digitalExperiences/site/[SITE_NAME]/sfdc_cms__themeLayout/[THEME_LAYOUT_NAME]/`
-2. **Required Files**:
-- `_meta.json` - Metadata file defining the API name and type
-- `content.json` - Content file defining the configuration and layout
-## Purpose A: Generate New Theme Layouts
-**IMPORTANT**: These guidelines should ONLY be applied when the user explicitly requests creating a new layout for their site. Do not apply these guidelines automatically for other tasks or when editing existing layouts.
-### Order of operations
-If the user decides to create a new LWC, create the LWC first THEN the theme layout metadata.
-### _meta.json Structure
-The `_meta.json` file must contain:
-```json
-{
-  "apiName": "[THEME_LAYOUT_NAME]",
-  "type": "sfdc_cms__themeLayout",
-  "path": "themeLayouts"
-}
-```
-**Rules**:
-- `apiName`: Must match the themeLayout directory name exactly
-- `type`: Always `"sfdc_cms__themeLayout"`
-- `path`: Always `"themeLayouts"`
-### content.json Structure
-The `content.json` file must contain:
-```json
-{
-  "type": "sfdc_cms__themeLayout",
-  "title": "[DISPLAY_TITLE]",
-  "contentBody": {
-    "component": {
-        "attributes": { },
-        "children": [ "[regions in the layout]" ],
-        "definition": "[FQN of root layout component]",
-        "id": "[root component id]",
-        "type": "component"
-    }
-  },
-  "urlName": "[url name]"
-}
-```
-**Field Definitions**:
-- `type`: Always `"sfdc_cms__themeLayout"`
-- `title`: Human-readable display title, words separated by spaces (e.g. "Scoped Header and Footer")
-- `contentBody`: Include all `required` properties from `schemaDefinition`. Use `examplesOfContentType` for reference.
-- Do not add additional fields.
-- `urlName`: URL identifier (lowercase, words separated by dashes e.g., "scoped-header-and-footer")
-- `contentBody.compnent.definition`: The actual theme layout component that displays/renders the layout and includes theme region components.
-**Rules**:
-- Before any actions, *always* call `execute_metadata_action` to get the full schema and examples per the skill document.
-### Naming Conventions
-1. **Directory Name**: Should be in camelCase
-2. **apiName**: Must exactly match the directory name
-3. **title**: Human-readable title with spaces (e.g., "Service Not Available Theme Layout")
-4. **urlName**: Lowercase with hyphens for URL-friendly format (e.g., "new-layout")
-### Theme Sync After Creation
-After creating a new `sfdc_cms__themeLayout`, you MUST update:
-```
-digitalExperiences/site/[SITE_NAME]/sfdc_cms__theme/[THEME_API_NAME]/content.json
-```
-**Lookup**: To find the theme content.json for the current site:
-1. Navigate up from the current theme layout directory to the site directory.
-2. Look in sfdc_cms__theme/ (sibling directory to sfdc_cms__themeLayout/).
-3. Find the theme directory (typically one per site).
-4. Read the file: content.json.
-**Action (append-only)**:
-- ALWAYS append a new entry to `contentBody.layouts`.
-- Do NOT replace or remove existing `layouts` entries.
-- `layoutId` MUST exactly match the new theme layout `apiName`.
-- `layoutType` MUST be chosen based on intended view usage.
-  - **Default**: Generate a random 30-character alphanumeric string (e.g., `xEGgPxY5j5TForZe3J7SBguOfQicEy`) for the `layoutType`. Ensure this string is unique and does not match any existing `layoutType` in the list.
-**Example**:
-```json
-{
-  "contentBody": {
-    "layouts": [
-      { "layoutId": "existingLayoutA", "layoutType": "Inner" },
-      { "layoutId": "existingLayoutB", "layoutType": "ServiceNotAvailable" },
-      { "layoutId": "[NEW_THEME_LAYOUT_API_NAME]", "layoutType": "[30_CHAR_RANDOM_STRING]" }
-    ]
-  }
-}
-```
-### Generation Checklist
-When generating a new theme layout, ensure:
-- [ ] `_meta.json` created with correct `apiName`, `type`, and `path`
-- [ ] `content.json` created with all required fields
-- [ ] `urlName` uses lowercase with hyphens
-- [ ] `title` is human-readable
-- [ ] `sfdc_cms__theme/[THEME_API_NAME]/content.json` updated by appending a new `contentBody.layouts` mapping
-- [ ] **CRITICAL**: Complete all the UUID generation steps. See [handle-component-and-region-ids.md](docs/handle-component-and-region-ids.md)
-## Purpose B: Editing Existing Theme Layouts
-### Component Modifications
-When adding, removing, or configuring components in existing theme layouts, **always** refer to [handle-ui-components.md](docs/handle-ui-components.md) for placement hierarchy, component structure, column layout, and property configuration.
-**Note**: Theme layouts often define the overall structure (header/footer) surrounding the main content region. Ensure components are added to the correct region (e.g., `header`, `footer`).