@webbycrown/strapi-advanced-sitemap 1.0.3

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2024 WebbyCrown
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+

package/README.md

@@ -0,0 +1,194 @@
+# 🚀 Strapi Advanced Sitemap
+
+[![npm version](https://badge.fury.io/js/%40webbycrown%2Fstrapi-advanced-sitemap.svg)](https://www.npmjs.com/package/@webbycrown/strapi-advanced-sitemap)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Strapi](https://img.shields.io/badge/Strapi-5.x-blue.svg)](https://strapi.io/)
+
+SEO-ready XML sitemaps for Strapi CMS. Create manual URL sets or sitemap indexes, generate dynamic feeds from collection types, and expose every endpoint behind role-based permissions—no external services required.
+
+📦 **NPM Package**: [@webbycrown/strapi-advanced-sitemap](https://www.npmjs.com/package/@webbycrown/strapi-advanced-sitemap)  
+💻 **Repository**: [GitHub – webbycrown/strapi-advanced-sitemap](https://github.com/webbycrown/strapi-advanced-sitemap)
+
+---
+
+## ✨ Features
+
+### 🗂️ Manual Sitemap Builder
+- **Single sitemap (`<urlset>`):** curate individual URLs with optional priority values  
+- **Sitemap index (`<sitemapindex>`):** reference other sitemap files (internal or external)  
+- **Automatic URL resolution:** combine relative paths with your site base URL  
+- **UI hints & validation:** friendly helper text, required field checks, URL previews
+
+### 🔁 Dynamic Collection Sitemaps
+- **Pattern-based URLs:** use tokens like `/blog/[slug]` (supports nested fields)  
+- **Entry prefix & base path:** compose clean URLs without extra middleware  
+- **Frequency, priority, lastmod:** configure crawl metadata per sitemap  
+- **Draft filtering:** includes only published entries from Draft & Publish collections
+
+### 🔒 Permission-Aware Delivery
+- **Role gating:** every endpoint maps to an action (`plugin::strapi-advanced-sitemap.controller.*`)  
+- **Public crawler control:** enable only the endpoints you want search engines to reach  
+- **API token support:** respect token-bound permissions for programmatic access
+
+### 🛠️ Admin-First Workflow
+- **Inline editing:** manage everything from Settings → Strapi Advanced Sitemap  
+- **Frontend base URL control:** store the live site origin once and reuse it across manual and collection previews  
+- **Instant feedback:** clear success/error messages plus live URL previews for every manual entry  
+- **No redeploys:** sitemap definitions are stored in Strapi entities
+
+---
+
+## 📸 Feature Screens
+
+### Configure Sitemap Page
+![Configure Sitemap Page](https://raw.githubusercontent.com/webbycrown/strapi-advanced-sitemap/main/assets/configure-sitemap-page.png)
+
+### Permissions in Public Role Screen
+![Permissions in Public Role Screen](https://raw.githubusercontent.com/webbycrown/strapi-advanced-sitemap/main/assets/permissions.png)
+
+### Manual Sitemap Settings (Sitemap Index)
+![Manual Sitemap Settings (Sitemap Index)](https://raw.githubusercontent.com/webbycrown/strapi-advanced-sitemap/main/assets/manual-sitemap-settings-sitemap-index.png)
+
+### Manual Sitemap Settings (URL Set)
+![Manual Sitemap Settings (Url Set)](https://raw.githubusercontent.com/webbycrown/strapi-advanced-sitemap/main/assets/manual-sitemap-settings-url-set.png)
+
+### Collection Sitemap Settings
+![Collection Sitemap Settings](https://raw.githubusercontent.com/webbycrown/strapi-advanced-sitemap/main/assets/collection-sitemap-settings.png)
+
+### Collection Sitemap Entry
+![Collection Sitemap Entry](https://raw.githubusercontent.com/webbycrown/strapi-advanced-sitemap/main/assets/collection-sitemap-entry.png)
+
+---
+
+## 🛠️ Installation
+
+### Via npm
+```bash
+npm install @webbycrown/strapi-advanced-sitemap
+```
+
+### Via yarn
+```bash
+yarn add @webbycrown/strapi-advanced-sitemap
+```
+
+### Enable the plugin
+Update `config/plugins.js`:
+```js
+module.exports = {
+  'strapi-advanced-sitemap': {
+    enabled: true,
+  },
+};
+```
+
+Restart Strapi and rebuild the admin panel:
+```bash
+npm run build
+npm run develop
+```
+
+---
+
+## ⚡ Quick Start
+
+1. **Open the admin panel** → *Settings → Strapi Advanced Sitemap*  
+2. **Add a manual sitemap** (single or index) and configure filename/base path  
+3. **Add entries**  
+   - Single sitemap: supply URLs (relative or absolute) + optional priorities  
+   - Index sitemap: supply links to other sitemap files  
+4. **Add a collection sitemap**: pick a collection type, define a pattern (e.g. `/articles/[slug]`), and adjust metadata  
+5. **Grant permissions**: Settings → Users & Permissions → Roles → Public (or another role) → enable the sitemap actions:
+   - `serveRootSitemap`
+   - `serveManualSitemapIndex`
+   - `serveManualSitemapFile`
+   - `serveCollectionSitemapFile`
+
+### Available Endpoints
+- `/sitemap.xml` – root sitemap index (manual + collection entries)  
+- `/sitemaps/manual-sitemaps` – manual sitemap index (if configured)  
+- `/sitemaps/{filename}.xml` – individual manual sitemap files  
+- `/api/strapi-advanced-sitemap/collection-sitemaps/{id}.xml` – collection XML (also linked from the root)
+
+---
+
+## 🧭 Manual Sitemap Types
+
+| Type | Emits | When to use | Entry expectations |
+|------|-------|-------------|--------------------|
+| **Single sitemap** | `<urlset>` | Hand-curated URLs (blogs, landing pages) | Each entry is a path or absolute URL; optional priority |
+| **Sitemap index** | `<sitemapindex>` | Aggregate internal/external sitemap files | Each entry points to another sitemap file |
+
+Relative paths are automatically combined with your configured base URL and per-sitemap base path.
+
+---
+
+## 🧱 Collection Sitemap Patterns
+
+- Use `[fieldName]` tokens (nested allowed: `[author.slug]`) to build URLs  
+- Combine with “Entry prefix” or “Base path” to match your routing strategy  
+- `lastmod` draws from `updatedAt`, `publishedAt`, or `createdAt`  
+- Draft entries are excluded when Draft & Publish is enabled
+
+Example pattern:
+```
+/articles/[slug]
+```
+
+---
+
+## 🔐 Permissions & Security
+
+- Actions live under `plugin::strapi-advanced-sitemap.*`  
+- Denied roles receive `401 Unauthorized` responses  
+- API tokens respect the same action mapping  
+- Manual sitemaps store relative paths only—final URLs are resolved server side
+
+---
+
+## 🧪 Troubleshooting
+
+| Symptom | Fix |
+|---------|-----|
+| Sitemap returns 401 | Enable the corresponding plugin actions for that role |
+| Manual sitemap URL 404s | Check filename + base path, ensure “Save changes” was clicked |
+| Collection sitemap empty | Verify entries are published and the pattern resolves without leftover tokens |
+| Admin UI stale | Run `npm run build` and restart Strapi |
+
+---
+
+## 📝 License
+
+MIT – see [LICENSE](LICENSE) for details.
+
+---
+
+## 🆘 Support
+
+- **Documentation**: [GitHub Wiki](https://github.com/webbycrown/strapi-advanced-sitemap/wiki)
+- **Issues**: [GitHub Issues](https://github.com/webbycrown/strapi-advanced-sitemap/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/webbycrown/strapi-advanced-sitemap/discussions)
+- **Email**: info@webbycrown.com
+
+## 🙏 Acknowledgments
+
+- Built for the amazing [Strapi](https://strapi.io/) community
+- Inspired by modern form design principles
+- Thanks to all contributors and users
+
+## 📊 Changelog
+
+### v1.0.0
+- ✨ Initial release of **Strapi Advanced Sitemap**
+- 🧭 Manual sitemap builder supporting URL sets and sitemap indexes
+- ⚙️ Dynamic collection sitemaps powered by pattern tokens
+- 🔐 Role-based access control for each sitemap endpoint
+- 🌍 Configurable frontend base URL with live preview inside the admin panel
+- 📦 Easy integration and management from Strapi settings
+- 🚀 Published to NPM: [@webbycrown/strapi-advanced-sitemap](https://www.npmjs.com/package/@webbycrown/strapi-advanced-sitemap)
+
+---
+
+<div align="center">
+  <strong>Made with ❤️ by <a href="https://webbycrown.com">WebbyCrown</a></strong>
+</div>