@salesforce/afv-skills 1.1.0 → 1.2.0

package/skills/deployment-readiness-check/scripts/check_metadata.sh

@@ -1,207 +0,0 @@
-#!/bin/bash
-# Metadata validation script for Salesforce deployments
-# Checks for common issues before deployment
-
-set -e
-
-# Colors for output
-RED='\033[0;31m'
-YELLOW='\033[1;33m'
-GREEN='\033[0;32m'
-NC='\033[0m' # No Color
-
-ERRORS=0
-WARNINGS=0
-
-echo "=========================================="
-echo "Salesforce Metadata Validation"
-echo "=========================================="
-echo ""
-
-# Check if we're in an SFDX project
-if [ ! -f "sfdx-project.json" ]; then
-    echo -e "${RED}ERROR: Not in an SFDX project directory${NC}"
-    echo "Please run this script from your project root"
-    exit 1
-fi
-
-echo "✓ Found SFDX project"
-echo ""
-
-# 1. Check XML format
-echo "Checking XML format..."
-XML_ERRORS=0
-
-find force-app -name "*.xml" -o -name "*.object" -o -name "*.layout" | while read file; do
-    if ! xmllint --noout "$file" 2>/dev/null; then
-        echo -e "${RED}✗ Invalid XML: $file${NC}"
-        XML_ERRORS=$((XML_ERRORS + 1))
-    fi
-done
-
-if [ $XML_ERRORS -eq 0 ]; then
-    echo -e "${GREEN}✓ All XML files are well-formed${NC}"
-else
-    echo -e "${RED}✗ Found $XML_ERRORS XML errors${NC}"
-    ERRORS=$((ERRORS + XML_ERRORS))
-fi
-echo ""
-
-# 2. Check API versions
-echo "Checking API versions..."
-MIN_API_VERSION=56.0
-
-find force-app -name "*.cls-meta.xml" -o -name "*.trigger-meta.xml" | while read file; do
-    VERSION=$(grep -o '<apiVersion>[0-9.]*</apiVersion>' "$file" | grep -o '[0-9.]*')
-    if [ -n "$VERSION" ] && (( $(echo "$VERSION < $MIN_API_VERSION" | bc -l) )); then
-        echo -e "${YELLOW}⚠ Old API version $VERSION in: $file${NC}"
-        WARNINGS=$((WARNINGS + 1))
-    fi
-done
-
-echo -e "${GREEN}✓ API version check complete${NC}"
-echo ""
-
-# 3. Check for deprecated features
-echo "Checking for deprecated features..."
-
-# Check for old-style custom settings
-DEPRECATED_SETTINGS=$(find force-app -name "*.object-meta.xml" -exec grep -l "customSettingsType>List" {} \; | wc -l)
-if [ $DEPRECATED_SETTINGS -gt 0 ]; then
-    echo -e "${YELLOW}⚠ Found $DEPRECATED_SETTINGS list custom settings (consider Custom Metadata Types)${NC}"
-    WARNINGS=$((WARNINGS + 1))
-fi
-
-# Check for old Aura components (should migrate to LWC)
-AURA_COMPONENTS=$(find force-app -name "*.cmp" | wc -l)
-if [ $AURA_COMPONENTS -gt 5 ]; then
-    echo -e "${YELLOW}⚠ Found $AURA_COMPONENTS Aura components (consider migrating to LWC)${NC}"
-    WARNINGS=$((WARNINGS + 1))
-fi
-
-echo -e "${GREEN}✓ Deprecation check complete${NC}"
-echo ""
-
-# 4. Check naming conventions
-echo "Checking naming conventions..."
-
-# Check for spaces in API names (not allowed)
-SPACE_ERRORS=$(find force-app -name "*.xml" -exec grep -l "fullName>.*\s.*<" {} \; | wc -l)
-if [ $SPACE_ERRORS -gt 0 ]; then
-    echo -e "${RED}✗ Found $SPACE_ERRORS files with spaces in API names${NC}"
-    ERRORS=$((ERRORS + SPACE_ERRORS))
-fi
-
-# Check for lowercase custom object names (should be PascalCase)
-LOWERCASE_OBJECTS=$(find force-app/main/default/objects -name "*.object-meta.xml" -exec basename {} \; | grep -E "^[a-z]" | wc -l)
-if [ $LOWERCASE_OBJECTS -gt 0 ]; then
-    echo -e "${YELLOW}⚠ Found $LOWERCASE_OBJECTS custom objects with lowercase names${NC}"
-    WARNINGS=$((WARNINGS + 1))
-fi
-
-echo -e "${GREEN}✓ Naming convention check complete${NC}"
-echo ""
-
-# 5. Check for hardcoded IDs or URLs
-echo "Checking for hardcoded values..."
-
-# Check for record IDs (15 or 18 character Salesforce IDs)
-HARDCODED_IDS=$(grep -r -E "'[a-zA-Z0-9]{15,18}'" force-app/main/default/classes force-app/main/default/triggers 2>/dev/null | wc -l)
-if [ $HARDCODED_IDS -gt 0 ]; then
-    echo -e "${YELLOW}⚠ Found $HARDCODED_IDS potential hardcoded record IDs in Apex${NC}"
-    echo "  Review and replace with custom settings or custom metadata"
-    WARNINGS=$((WARNINGS + 1))
-fi
-
-# Check for hardcoded URLs
-HARDCODED_URLS=$(grep -r "https://.*\.salesforce\.com" force-app/main/default/ 2>/dev/null | wc -l)
-if [ $HARDCODED_URLS -gt 0 ]; then
-    echo -e "${YELLOW}⚠ Found $HARDCODED_URLS hardcoded Salesforce URLs${NC}"
-    echo "  Consider using Named Credentials or Custom Settings"
-    WARNINGS=$((WARNINGS + 1))
-fi
-
-echo -e "${GREEN}✓ Hardcoded value check complete${NC}"
-echo ""
-
-# 6. Check meta.xml files
-echo "Checking for missing meta.xml files..."
-
-MISSING_META=0
-find force-app -name "*.cls" | while read file; do
-    if [ ! -f "${file}-meta.xml" ]; then
-        echo -e "${RED}✗ Missing meta.xml for: $file${NC}"
-        MISSING_META=$((MISSING_META + 1))
-    fi
-done
-
-if [ $MISSING_META -eq 0 ]; then
-    echo -e "${GREEN}✓ All source files have meta.xml files${NC}"
-else
-    echo -e "${RED}✗ Found $MISSING_META missing meta.xml files${NC}"
-    ERRORS=$((ERRORS + MISSING_META))
-fi
-echo ""
-
-# 7. Check for test classes
-echo "Checking test coverage..."
-
-TOTAL_CLASSES=$(find force-app -name "*.cls" | wc -l)
-TEST_CLASSES=$(find force-app -name "*Test.cls" -o -name "*_Test.cls" | wc -l)
-
-if [ $TOTAL_CLASSES -gt 0 ]; then
-    TEST_RATIO=$(echo "scale=2; $TEST_CLASSES / $TOTAL_CLASSES * 100" | bc)
-    echo "Test class ratio: $TEST_CLASSES/$TOTAL_CLASSES (${TEST_RATIO}%)"
-    
-    if (( $(echo "$TEST_RATIO < 50" | bc -l) )); then
-        echo -e "${YELLOW}⚠ Low test class coverage (${TEST_RATIO}%)${NC}"
-        echo "  Consider adding more test classes"
-        WARNINGS=$((WARNINGS + 1))
-    else
-        echo -e "${GREEN}✓ Good test class coverage (${TEST_RATIO}%)${NC}"
-    fi
-else
-    echo "No Apex classes found"
-fi
-echo ""
-
-# 8. Check package.xml
-echo "Checking package.xml..."
-
-if [ -f "manifest/package.xml" ]; then
-    echo -e "${GREEN}✓ Found package.xml${NC}"
-    
-    # Validate it's well-formed XML
-    if xmllint --noout manifest/package.xml 2>/dev/null; then
-        echo -e "${GREEN}✓ package.xml is valid XML${NC}"
-    else
-        echo -e "${RED}✗ package.xml is invalid XML${NC}"
-        ERRORS=$((ERRORS + 1))
-    fi
-else
-    echo -e "${YELLOW}⚠ No package.xml found in manifest/ directory${NC}"
-    WARNINGS=$((WARNINGS + 1))
-fi
-echo ""
-
-# Summary
-echo "=========================================="
-echo "Validation Summary"
-echo "=========================================="
-echo -e "Errors: ${RED}$ERRORS${NC}"
-echo -e "Warnings: ${YELLOW}$WARNINGS${NC}"
-echo ""
-
-if [ $ERRORS -eq 0 ] && [ $WARNINGS -eq 0 ]; then
-    echo -e "${GREEN}✓ Metadata validation passed!${NC}"
-    echo "Your metadata is ready for deployment."
-    exit 0
-elif [ $ERRORS -eq 0 ]; then
-    echo -e "${YELLOW}⚠ Validation passed with warnings${NC}"
-    echo "Review warnings before deploying."
-    exit 0
-else
-    echo -e "${RED}✗ Validation failed${NC}"
-    echo "Fix errors before deploying."
-    exit 1
-fi

package/skills/salesforce-experience-site/SKILL.md

@@ -1,178 +0,0 @@
----
-name: salesforce-experience-site
-description: Use this skill when users need to create, modify, or manage Salesforce Experience Cloud sites (LWR sites). Trigger when users mention Experience sites, LWR sites, DigitalExperience, Experience Cloud, community sites, portals, creating pages, adding routes, views, theme layouts, branding sets, or any DigitalExperience bundle work. Also use when users mention specific content types like sfdc_cms__route, sfdc_cms__view, sfdc_cms__themeLayout, or when troubleshooting site deployment. Always use this skill for any Experience Cloud or LWR site work.
----
-
-## When to Use This Skill
-
-Use this skill when you need to:
-- Create Experience Cloud sites or communities
-- Build LWR (Lightning Web Runtime) sites
-- Set up site configuration and settings
-- Generate Experience Site metadata
-- Troubleshoot deployment errors related to Experience Sites
-
-## Specification
-
-# Experience LWR Site Metadata Specification
-An LWR site can be represented by metadata DigitalExperienceConfig, DigitalExperienceBundle, Network, CustomSite, and CMS contents. Your purpose is to assist developers in creating and editing these metadata.
-
-## Supported Template Types
-
-Template name - Template DevName
-- Build Your Own (LWR) - talon-template-byo
-
-## Core Properties
-
-Before doing anything else, identify the following properties from the local project if available. Check with the user if any of the following is missing:
-- Site name: Required. (e.g., `'My Community'`).
-- URL path prefix: Optional. Alphanumeric characters only. Convert from site name if not provided (e.g., `'mycommunity'`) and verify with the user for the converted value.
-- Template type devName: Optional. Defaults to `talon-template-byo`.
-
-## General Tips
-
-TIP 1. When available, the site developer name can be found in the CustomSite filename (e.g., `sites/MySite.site-meta.xml` → developer name is `MySite`).
-
-## Project Structure in DigitalExperienceBundle Format
-
-### Site Metadata
-- DigitalExperienceConfig
-    - Path: `digitalExperienceConfigs/{siteName}1.digitalExperienceConfig-meta.xml`
-- DigitalExperienceBundle
-    - Path: `digitalExperiences/site/{siteName}1/{siteName}1.digitalExperience-meta.xml`
-- Network
-    - Path: `networks/{siteName}.network-meta.xml`
-- CustomSite
-    - Path: `sites/{siteName}.site-meta.xml`
-
-### DigitalExperience Contents
-- Path: `digitalExperiences/site/{siteName}1/sfdc_cms__*/{contentApiName}/*`
-- Description: These are the content components defining routes, views, theme layouts, etc. Each component must have a `_meta.json` and `content.json` file.
-
-#### Content Type Descriptions
-| Content Type | Description | When to Use |
-|-|-|-|
-| `sfdc_cms__site` | Root site configuration containing site-wide settings | Required for every site; one per site |
-| `sfdc_cms__appPage` | Application page container that groups routes and views | Required; defines the app shell |
-| `sfdc_cms__route` | URL routing definition mapping paths to views | Create one for each page/URL path |
-| `sfdc_cms__view` | Page layout and component structure | Create one for each route; defines page content. Also use to edit existing views (e.g., adding/removing components, updating theme layout) |
-| `sfdc_cms__brandingSet` | Brand colors, fonts, and styling tokens | Required; defines site-wide styling |
-| `sfdc_cms__languageSettings` | Language and localization configuration | Required; defines supported languages |
-| `sfdc_cms__mobilePublisherConfig` | Mobile app publishing settings | Required for mobile app deployment |
-| `sfdc_cms__theme` | Theme definition referencing layouts and branding | Required; one per site |
-| `sfdc_cms__themeLayout` | Page layout templates used by views | Create layouts for different page structures |
-
-**Important:** Creating any new pages require BOTH `sfdc_cms__route` AND `sfdc_cms__view`.
-
-## CUD Operations on DigitalExperience Contents
-- Users can perform create, update, delete operations on DigitalExperience Contents.
-- **IMPORTANT:** Before ANY modification (create, update, or delete) to content, ALWAYS call `execute_metadata_action` first to get the schema, examples, and instructions for that content type.
-- **Call once per content type per user request**: If you're creating/modifying multiple items of the same content type (e.g., creating 3 routes), you only need to call `execute_metadata_action` ONCE for that content type. Reuse the schema and examples for all items of that type within the same user request.
-- For each unique content type you need to work with, call `execute_metadata_action` using the following:
-```json
-{
-  "metadataType": "ExperienceSite",
-  "actionName": "getSiteContentMetadata",
-  "parameters": {
-    "contentType": "<content type from table above>",
-    "shouldIncludeExamples": true
-  }
-}
-```
-- Do not call the `execute_metadata_action` MCP tool with any other site actionName unless specified in this knowledge doc/instructions.
-
-## Retrieving Site URLs After Deployment
-
-After successfully deploying the site using `sf project deploy`, use the `execute_metadata_action` MCP tool to get the preview and builder URLs:
-```json
-{
-  "metadataType": "ExperienceSite",
-  "actionName": "getSiteUrls",
-  "parameters": {
-    "siteDevName": "<site developer name>"
-  }
-}
-```
-
-Refer to TIP 1 to get the site developer name.
-
-If the site is not found, an error message will be returned indicating that the site may not be deployed. Ensure the site has been successfully deployed before calling this action.
-
-## Enhancement Rules
-
-- If need to understand how site metadata should be configured, use the `get_metadata_api_context` MCP tool to get the schemas.
-
-- Use MCP tool `execute_metadata_action` with `getSiteTemplateMetadata` to get the knowledge document about the template and its default configurations if needed. **IMPORTANT:** This MUST be used for new site:
-```json
-{
-  "metadataType": "ExperienceSite",
-  "actionName": "getSiteTemplateMetadata",
-  "parameters": {
-    "templateDevName": "<template DevName, e.g. talon-template-byo>"
-  }
-}
-```
-
-- To validate Experience Site metadata, run CLI command `sf project deploy validate --metadata DigitalExperienceBundle DigitalExperience DigitalExperienceConfig Network CustomSite --target-org ${usernameOrAlias}`
-
-## Guest User Sharing Rules (Public Sites Only)
-
-**When to use**: Only create guest sharing rules when the user explicitly wants to make the site **public** (accessible to unauthenticated visitors). If the site is private/login-required, guest sharing rules are not needed.
-If sharingRules metadata is not available locally in force-app/main/default/sharingRules, retrieve it from the org before creating new rules.
-
-To get the full SharingRules schema, use the `get_metadata_api_context` MCP tool:
-```json
-{
-  "metadataType": "SharingRules"
-}
-```
-
-### XML Example
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<SharingRules xmlns="http://soap.sforce.com/2006/04/metadata">
-    <sharingGuestRules>
-        <fullName>ShareAccountsWithSiteGuest</fullName>
-        <accessLevel>Read</accessLevel>
-        <includeHVUOwnedRecords>false</includeHVUOwnedRecords>
-        <label>Share Accounts With Site Guest</label>
-        <sharedTo>
-            <guestUser>[site developer name]</guestUser>
-        </sharedTo>
-        <criteriaItems>
-            <field>Name</field>
-            <operation>notEqual</operation>
-            <value>null</value>
-      </criteriaItems>
-    </sharingGuestRules>
-</SharingRules>
-```
-Refer to TIP 1 to get the site developer name.
-
-### Critical Requirements
-
-1. **SharedTo Element**: Must use `<guestUser>{siteName}</guestUser>` where `{siteName}` is the Network name (not URL path prefix).
-2. **includeHVUOwnedRecords**: Required field. Set to `false` unless records owned by high-volume site users should be included.
-3. **One XML file per object**: Put all rules for a given object in one file. Do not create additional.
-
-### Common Mistakes
-
-- Using `<role>` or `<group>` instead of `<guestUser>` in sharedTo
-- Omitting the required `includeHVUOwnedRecords` field
-- Using `includeRecordsOwnedByAll` (that's for `sharingCriteriaRules`, not guest rules)
-
-## Workflows
-
-### Creating a new site
-
-- Verify with user on the value of site name, url path prefix, and site template type.
-- Retrieve template information from `getSiteTemplateMetadata` and strictly follow the rules of its knowledge document.
-- Proceed to the workflow of editing an existing site.
-
-### Editing an existing site
-
-- Identify the intent of the user and break it down into steps.
-- Make use of `get_metadata_api_context` if user wants to edit site metadata.
-- Use `getSiteContentMetadata` to understand how to edit site contents.
-- Once the tasks are done, perform site metadata validation.