Skip to content

Commit 6f1ef5f

Browse files
author
Robotghost718
committed
Initial commit
0 parents  commit 6f1ef5f

17 files changed

Lines changed: 670 additions & 0 deletions

‎.forceignore‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# List files or directories below to ignore them when running force:source:push, force:source:pull, and force:source:status
2+
# More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
3+
#
4+
5+
package.xml
6+
7+
# LWC configuration files
8+
**/jsconfig.json
9+
**/.eslintrc.json
10+
11+
# LWC Jest
12+
**/__tests__/**

‎.github/workflows/salesforce-validation.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Salesforce Validation
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main, develop ]
8+
9+
jobs:
10+
validation:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v3
15+
with:
16+
fetch-depth: 0
17+
18+
- name: Setup Node.js
19+
uses: actions/setup-node@v3
20+
with:
21+
node-version: '18'
22+
23+
- name: Install SFDX
24+
run: npm install --global sfdx-cli
25+
26+
- name: Install dependencies
27+
run: npm install
28+
29+
- name: Lint JavaScript
30+
run: npm run lint --if-present
31+
continue-on-error: true
32+
33+
- name: Validate Salesforce metadata
34+
run: |
35+
sfdx force:source:convert -d mdapi_output
36+
continue-on-error: true
37+
38+
- name: Check for Salesforce metadata issues
39+
run: |
40+
echo "Salesforce metadata validation complete"

‎.gitignore‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
8+
# Dependencies
9+
node_modules/
10+
11+
# Salesforce DX
12+
.sfdx/
13+
.sf/
14+
.env
15+
.env.local
16+
.env.*.local
17+
18+
# IDE
19+
.vscode/
20+
.idea/
21+
*.swp
22+
*.swo
23+
*~
24+
.DS_Store
25+
26+
# SFDX related
27+
.sfdx
28+
.sf
29+
orgs/
30+
.env
31+
32+
# Force.com metadata API
33+
*.zip
34+
build/
35+
36+
# Logs
37+
logs/
38+
39+
# Cache
40+
.cache/
41+
42+
# Jest coverage
43+
coverage/
44+
45+
# OS
46+
.DS_Store
47+
Thumbs.db
48+
49+
# Local environment variables
50+
.env
51+
.env.local
52+
.env.*.local

‎CODE_OF_CONDUCT.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We are committed to providing a welcoming and inspiring community for all.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing opinions, viewpoints, and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
## Enforcement
18+
19+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated.
20+
21+
## Scope
22+
23+
This Code of Conduct applies within project spaces and public spaces when an individual is representing the project or its community.
24+
25+
For more information, please visit the [Contributor Covenant](https://www.contributor-covenant.org/).

‎CONTRIBUTING.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing to CMS Auto Margin Component
2+
3+
Thank you for your interest in contributing to this project! Here's how you can help:
4+
5+
## Getting Started
6+
7+
1. Fork the repository
8+
2. Clone your fork locally
9+
3. Create a new branch for your feature or bug fix
10+
11+
```bash
12+
git clone https://github.com/YOUR_USERNAME/cmsLWComponent.git
13+
cd cmsLWComponent
14+
git checkout -b feature/your-feature-name
15+
```
16+
17+
## Setting Up Development Environment
18+
19+
### Prerequisites
20+
- Node.js and npm
21+
- Salesforce CLI (`sfdx` or `sf`)
22+
- Visual Studio Code with Salesforce Extensions
23+
24+
### Installation
25+
26+
```bash
27+
npm install
28+
sfdx plugins:install @salesforce/cli
29+
```
30+
31+
## Making Changes
32+
33+
1. Make your changes in a feature branch
34+
2. Test thoroughly in a Salesforce scratch org
35+
3. Ensure your code follows best practices:
36+
- Use meaningful variable and function names
37+
- Add comments for complex logic
38+
- Follow Salesforce coding standards
39+
- Test your changes
40+
41+
## Submitting a Pull Request
42+
43+
1. Push your changes to your fork
44+
2. Submit a Pull Request with a clear description of:
45+
- What problem does it solve?
46+
- How does it solve it?
47+
- Any breaking changes?
48+
3. Respond to code review feedback
49+
50+
## Code Standards
51+
52+
- Use ESLint for JavaScript
53+
- Use consistent formatting
54+
- Add JSDoc comments for public methods
55+
- Write test cases when possible
56+
57+
## Reporting Issues
58+
59+
If you find a bug, please create an issue with:
60+
- Clear title and description
61+
- Steps to reproduce
62+
- Expected vs. actual behavior
63+
- Salesforce org setup if relevant
64+
65+
Thank you for contributing!

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
# CMS Auto Margin Component
2+
3+
A Salesforce Lightning Web Component (LWC) that automatically manages content from Salesforce CMS with intelligent image path conversion and margin normalization.
4+
5+
## Features
6+
7+
- 🎯 Fetches managed content from Salesforce CMS
8+
- 🖼️ Automatically converts Salesforce CMS media URLs to community paths
9+
- 📐 Normalizes margins on heading and paragraph elements
10+
- 🔗 Handles relative and absolute image paths intelligently
11+
- 📱 Responsive and lightweight
12+
13+
## Component Overview
14+
15+
This component displays CMS-managed content with automatic:
16+
17+
1. **Image URL Conversion**: Converts Salesforce absolute media URLs to community-relative paths for better portability
18+
2. **Margin Normalization**: Removes default margins from `h1-h5` and `p` elements for consistent styling
19+
3. **HTML Entity Decoding**: Properly decodes HTML entities in CMS content
20+
21+
## Installation
22+
23+
### Prerequisites
24+
- Salesforce DX (SFDX) or Salesforce CLI
25+
- Salesforce org with CMS enabled (Experience Cloud or Digital Experiences)
26+
- Node.js 14+ and npm
27+
28+
### Setup
29+
30+
1. Clone the repository:
31+
```bash
32+
git clone https://github.com/Roboghost718/cmsLWComponent.git
33+
cd cmsLWComponent
34+
```
35+
36+
2. Authorize your Salesforce org:
37+
```bash
38+
sf org login web --set-default
39+
# or (if using older SFDX)
40+
sfdx force:auth:web:login --setdefaultusername
41+
```
42+
43+
3. Deploy to your org:
44+
```bash
45+
sf project deploy start --metadata force-app
46+
# or (if using older SFDX)
47+
sfdx force:source:push
48+
```
49+
50+
## Usage
51+
52+
### Basic Implementation
53+
54+
Add the component to a Lightning page or Experience Cloud page:
55+
56+
```html
57+
<c-cms-auto-margin-comp content-id="YOUR_CONTENT_KEY"></c-cms-auto-margin-comp>
58+
```
59+
60+
### Input Parameters
61+
62+
| Parameter | Type | Required | Description |
63+
|-----------|------|----------|-------------|
64+
| `contentId` | String | Yes | The content key from Salesforce CMS |
65+
66+
### Example in Aura Component
67+
68+
```html
69+
<div>
70+
<c:cmsAutoMarginComp contentId="your-content-key-here" />
71+
</div>
72+
```
73+
74+
## Component Architecture
75+
76+
### JavaScript (`cmsAutoMarginComp.js`)
77+
- Uses `@wire` to fetch content via `ManagedContentController.getContent()`
78+
- Processes HTML and modifies image sources
79+
- Handles error states
80+
81+
### Apex Controller (`ManagedContentController.cls`)
82+
- `getContent()`: Fetches a specific content item by content key
83+
- `getContentList()`: Retrieves a list of managed content items
84+
- Both methods support pagination, language, and filtering
85+
86+
## Image URL Conversion Logic
87+
88+
The component intelligently handles three types of image URLs:
89+
90+
1. **Salesforce CMS Absolute URLs**
91+
- `https://*.lightning.force.com/cms/media/ABC123` → `/sfsites/c/cms/delivery/media/ABC123`
92+
93+
2. **Relative Paths**
94+
- `image.png` → `/sfsites/c/image.png`
95+
- `/images/photo.jpg` → `/sfsites/c/images/photo.jpg`
96+
97+
3. **External/Already Correct URLs** (unchanged)
98+
- `https://example.com/image.png`
99+
- `/sfsites/c/assets/image.png`
100+
- `data:image/png;base64,...`
101+
102+
## Supported Salesforce API Versions
103+
104+
- Source API Version: 65.0+
105+
- Tested with Summer '23 and later releases
106+
107+
## Troubleshooting
108+
109+
### Images not loading?
110+
- Verify the content is published in CMS
111+
- Check that image media files exist
112+
- Review browser console for detailed logs
113+
- Ensure your community has proper file serving configured
114+
115+
### Content not appearing?
116+
- Confirm the `contentId` (content key) is correct
117+
- Verify the CMS content is published
118+
- Check user permissions for CMS access
119+
- Review Apex debug logs for API errors
120+
121+
## Architecture & Design
122+
123+
### Security
124+
- Uses `with sharing` on Apex controller to respect Salesforce sharing rules
125+
- `@AuraEnabled(cacheable=true)` for performance
126+
- HTML content is parsed in DOM to prevent injection attacks
127+
128+
### Performance
129+
- Cacheable wire adapters reduce API calls
130+
- Single DOM parse operation
131+
- Minimal JavaScript bundle size
132+
133+
## Contributing
134+
135+
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
136+
137+
## Code of Conduct
138+
139+
Please review our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) before participating.
140+
141+
## License
142+
143+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
144+
145+
## Support
146+
147+
For issues and questions:
148+
- Open an [issue](https://github.com/yourusername/cmsLWComponent/issues)
149+
- Check existing issues for similar problems
150+
- Include your Salesforce API version and browser details
151+
152+
## Authors
153+
154+
- Robotghost718 (@Robotghost718)
155+
156+
## Changelog
157+
158+
### Version 1.0.0
159+
- Initial release
160+
- Image URL conversion
161+
- Margin normalization
162+
- HTML entity decoding
163+
164+
---
165+
166+
**Built with ❤️ for the Salesforce community**

‎config/project-scratch-def.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"orgName": "dan company",
3+
"edition": "Developer",
4+
"features": []
5+
}

0 commit comments

Comments
 (0)