Commerce agent messaging LWC custom components (#31)

Co-authored-by: Mike McMahon <[email protected]>

Author: syedshehrozhussain

.editorconfig

@@ -0,0 +1,13 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

.eslintrc.cjs

@@ -0,0 +1,49 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ * For full license text, see the LICENSE file in the repo
+ * root or https://opensource.org/licenses/apache-2.0/
+ */
+module.exports = {
+    extends: ['@salesforce/eslint-config-lwc/recommended', 'plugin:jsdoc/recommended'],
+    plugins: ['notice', 'prettier', 'jsdoc'],
+    rules: {
+        'notice/notice': [
+            'error',
+            {
+                mustMatch: 'Copyright \\(c\\) \\d{4}, salesforce.com, inc.',
+                template: [
+                    '/*',
+                    ' * Copyright (c) <%= YEAR %>, salesforce.com, inc.',
+                    ' * All rights reserved.',
+                    ' * SPDX-License-Identifier: Apache-2.0',
+                    ' * For full license text, see the LICENSE file in the repo',
+                    ' * root or https://opensource.org/licenses/apache-2-0/',
+                    ' */',
+                    '',
+                ].join('\n'),
+            },
+        ],
+        'prettier/prettier': 'error',
+        'jsdoc/check-tag-names': ['warn', { definedTags: ['slot'] }],
+        'no-unused-expressions': ['error', { allowShortCircuit: true, allowTernary: true }],
+    },
+    overrides: [
+        {
+            files: ['*.test.js'],
+            rules: {
+                '@lwc/lwc/no-unexpected-wire-adapter-usages': 'off',
+            },
+            env: {
+                node: true,
+            },
+        },
+        {
+            files: ['*.config.js', '.eslintrc.cjs'],
+            env: {
+                node: true,
+            },
+        },
+    ],
+};

.forceignore

@@ -0,0 +1,12 @@
+# List files or directories below to ignore them when running force:source:push, force:source:pull, and force:source:status
+# More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
+#
+
+package.xml
+
+# LWC configuration files
+**/jsconfig.json
+**/.eslintrc.json
+
+# LWC Jest
+**/__tests__/**

.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Comment line immediately above ownership line is reserved for related other information. Please be careful while editing.
+#ECCN:Open Source
+
+# Code Owners
+*       

.github/branch-protection.yml

@@ -0,0 +1,67 @@
+# Branch Protection Configuration
+# This file serves as documentation for required branch protection settings
+# Apply these settings in GitHub repository settings under Branches > Add rule
+
+branch_protection_rules:
+    main:
+        required_status_checks:
+            strict: true
+            contexts:
+                - 'Validate Code'
+                - 'Code Quality'
+                - 'Security Checks'
+                - 'Commit Message Check'
+
+        enforce_admins: true
+
+        required_pull_request_reviews:
+            required_approving_review_count: 2
+            dismiss_stale_reviews: true
+            require_code_owner_reviews: true
+            require_last_push_approval: true
+
+        restrictions:
+            users: []
+            teams: []
+
+        allow_force_pushes: false
+        allow_deletions: false
+
+        required_conversation_resolution: true
+        require_linear_history: true
+        require_signed_commits: false
+
+    develop:
+        required_status_checks:
+            strict: true
+            contexts:
+                - 'Validate Code'
+                - 'Code Quality'
+                - 'Security Checks'
+
+        enforce_admins: false
+
+        required_pull_request_reviews:
+            required_approving_review_count: 1
+            dismiss_stale_reviews: true
+            require_code_owner_reviews: false
+            require_last_push_approval: false
+
+        restrictions:
+            users: []
+            teams: []
+
+        allow_force_pushes: false
+        allow_deletions: false
+
+        required_conversation_resolution: true
+        require_linear_history: false
+        require_signed_commits: false
+# Quality Gates Summary:
+# 1. Code Coverage: Minimum 90% (enforced by Jest config)
+# 2. Linting: No ESLint errors (enforced by CI)
+# 3. Formatting: Prettier compliance (enforced by CI)
+# 4. Tests: All tests must pass (enforced by CI)
+# 5. Warnings: No console.warn/error (enforced by CI)
+# 6. Security: npm audit passes (enforced by CI)
+# 7. Commit Messages: Conventional commits (enforced by CI)

.github/workflows/pr-checks.yml

@@ -0,0 +1,223 @@
+name: Pull Request Checks
+
+on:
+    pull_request:
+        types: [opened, synchronize, reopened]
+    push:
+        branches: [main, develop]
+
+permissions:
+    contents: read
+    pull-requests: write
+
+jobs:
+    validate:
+        name: Validate Code
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0 # Fetch all history for better git operations
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18'
+                  cache: 'npm'
+
+            - name: Cache Jest
+              uses: actions/cache@v3
+              with:
+                  path: ~/.cache/jest
+                  key: ${{ runner.os }}-jest-${{ hashFiles('**/package-lock.json') }}
+                  restore-keys: |
+                      ${{ runner.os }}-jest-
+
+            - name: Install Dependencies
+              run: npm ci
+
+            - name: Run Linting
+              run: npm run lint
+              continue-on-error: false
+
+            - name: Check Code Formatting
+              run: npm run format:verify
+              continue-on-error: false
+
+            - name: Run Tests with Coverage and Check Warnings
+              run: |
+                  # Run tests and capture output
+                  TEST_OUTPUT=$(npm run test:unit:coverage:ci 2>&1)
+                  TEST_EXIT_CODE=$?
+
+                  # Display test output
+                  echo "$TEST_OUTPUT"
+
+                  # Check for test failures first
+                  if [ $TEST_EXIT_CODE -ne 0 ]; then
+                      echo "❌ Tests failed"
+                      exit 1
+                  fi
+
+                  # Check for unexpected warnings/errors
+                  UNEXPECTED_WARNINGS=$(echo "$TEST_OUTPUT" | grep -E "(console\.warn|console\.error|console\.log|Warning|Error)" | grep -v "grep -E" || true)
+
+                  if [ -n "$UNEXPECTED_WARNINGS" ]; then
+                      echo "❌ Unexpected test warnings or errors detected:"
+                      echo "$UNEXPECTED_WARNINGS"
+                      exit 1
+                  else
+                      echo "✅ No unexpected test warnings or errors detected"
+                  fi
+              env:
+                  CI: true # Ensures test output is optimized for CI
+              continue-on-error: false
+
+            - name: Upload Coverage Report
+              uses: actions/upload-artifact@v3
+              with:
+                  name: coverage-report
+                  path: coverage/
+                  retention-days: 7
+
+            - name: Check Coverage Threshold
+              run: |
+                  if [ -f "coverage/lcov-report/index.html" ]; then
+                      echo "Coverage report generated successfully"
+                  else
+                      echo "Coverage report not found"
+                      exit 1
+                  fi
+
+                  # Check if coverage meets thresholds (90% as defined in jest.config.js)
+                  COVERAGE_THRESHOLD=90
+
+                  # Extract coverage percentages from lcov.info
+                  if [ -f "coverage/lcov.info" ]; then
+                      echo "Checking coverage thresholds..."
+                      
+                      # Check statements coverage
+                      STATEMENTS_COVERAGE=$(grep -o "SF:[0-9]*" coverage/lcov.info | wc -l)
+                      STATEMENTS_HIT=$(grep -o "LH:[0-9]*" coverage/lcov.info | awk -F: '{sum+=$2} END {print sum}')
+                      if [ "$STATEMENTS_HIT" -eq 0 ]; then
+                          STATEMENTS_HIT=0
+                      fi
+                      STATEMENTS_PERCENT=$((STATEMENTS_HIT * 100 / STATEMENTS_COVERAGE))
+                      
+                      echo "Statements coverage: $STATEMENTS_PERCENT%"
+                      
+                      if [ "$STATEMENTS_PERCENT" -lt "$COVERAGE_THRESHOLD" ]; then
+                          echo "❌ Statements coverage ($STATEMENTS_PERCENT%) is below threshold ($COVERAGE_THRESHOLD%)"
+                          exit 1
+                      fi
+                      
+                      echo "✅ Coverage thresholds met"
+                  else
+                      echo "❌ Coverage report (lcov.info) not found"
+                      exit 1
+                  fi
+
+            - name: Comment PR with Coverage Report
+              if: github.event_name == 'pull_request'
+              uses: actions/github-script@v6
+              with:
+                  script: |
+                      const fs = require('fs');
+                      const path = require('path');
+
+                      try {
+                          const coveragePath = path.join(process.cwd(), 'coverage', 'lcov-report', 'index.html');
+                          if (fs.existsSync(coveragePath)) {
+                              const coverageContent = fs.readFileSync(coveragePath, 'utf8');
+                              const coverageMatch = coverageContent.match(/<span class="strong">(\d+\.?\d*)%<\/span>/);
+                              
+                              if (coverageMatch) {
+                                  const coverage = coverageMatch[1];
+                                  const comment = `## 📊 Code Coverage Report
+                                  
+                                  **Overall Coverage: ${coverage}%**
+                                  
+                                  ✅ Coverage meets the required threshold of 90%
+                                  
+                                  [View detailed coverage report](${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}/artifacts)`;
+                                  
+                                  github.rest.issues.createComment({
+                                      issue_number: context.issue.number,
+                                      owner: context.repo.owner,
+                                      repo: context.repo.repo,
+                                      body: comment
+                                  });
+                              }
+                          }
+                      } catch (error) {
+                          console.log('Could not create coverage comment:', error.message);
+                      }
+
+    code-quality:
+        name: Code Quality
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18'
+                  cache: 'npm'
+
+            - name: Install Dependencies
+              run: npm ci
+
+            - name: Check LWC Component Structure
+              run: |
+                  # Check if all LWC components have required files
+                  for dir in force-app/main/default/lwc/*/; do
+                    if [ ! -f "${dir}${dir%/}.js" ] || [ ! -f "${dir}${dir%/}.html" ]; then
+                      echo "Error: Component ${dir%/} is missing required files"
+                      exit 1
+                    fi
+                  done
+
+    security:
+        name: Security Checks
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18'
+                  cache: 'npm'
+
+            - name: Install Dependencies
+              run: npm ci
+
+            - name: Run npm audit
+              run: npm audit --production
+
+            - name: Run npm outdated
+              run: npm outdated || true # Don't fail the build if there are outdated packages
+
+    commit-message:
+        name: Commit Message Check
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0
+
+            - name: Setup Node.js
+              uses: actions/setup-node@v3
+              with:
+                  node-version: '18'
+                  cache: 'npm'
+
+            - name: Install Dependencies
+              run: npm ci
+
+            - name: Check Commit Messages
+              run: npx commitlint --from=HEAD~1 --to=HEAD