diff --git a/.github/README.md b/.github/README.md index 03aa211..76be4e4 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,20 +1,18 @@ # Umbraco.Community.BackOfficeOrganiser -[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/umbraco.community.backofficeorganiser) -[![GitHub License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.BackOfficeOrganiser?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/blob/main/LICENSE) -[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.BackOfficeOrganiser?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.BackOfficeOrganiser/) +[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/Umbraco.Community.BackOfficeOrganiser) +[![License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.BackOfficeOrganiser?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser?tab=MIT-1-ov-file) +[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.BackOfficeOrganiser?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.BackOfficeOrganiser) [![Project Website](https://img.shields.io/badge/Project%20Website-jcdc.dev-jcdcdev?style=flat&color=3c4834&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0id2hpdGUiIGNsYXNzPSJiaSBiaS1wYy1kaXNwbGF5IiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik04IDFhMSAxIDAgMCAxIDEtMWg2YTEgMSAwIDAgMSAxIDF2MTRhMSAxIDAgMCAxLTEgMUg5YTEgMSAwIDAgMS0xLTF6bTEgMTMuNWEuNS41IDAgMSAwIDEgMCAuNS41IDAgMCAwLTEgMG0yIDBhLjUuNSAwIDEgMCAxIDAgLjUuNSAwIDAgMC0xIDBNOS41IDFhLjUuNSAwIDAgMCAwIDFoNWEuNS41IDAgMCAwIDAtMXpNOSAzLjVhLjUuNSAwIDAgMCAuNS41aDVhLjUuNSAwIDAgMCAwLTFoLTVhLjUuNSAwIDAgMC0uNS41TTEuNSAyQTEuNSAxLjUgMCAwIDAgMCAzLjV2N0ExLjUgMS41IDAgMCAwIDEuNSAxMkg2djJoLS41YS41LjUgMCAwIDAgMCAxSDd2LTRIMS41YS41LjUgMCAwIDEtLjUtLjV2LTdhLjUuNSAwIDAgMSAuNS0uNUg3VjJ6Ii8+Cjwvc3ZnPg==)](https://jcdc.dev/umbraco-packages/back-office-organiser) -Is your backoffice a bit untidy? + +Is your Backoffice a bit untidy? - Single-click (and opinionated) organiser for - Document Types - Media Types - Member Types - Data Types -- Automatically sorts on save (configurable) - -![A screenshot of the Back Office Organiser in action](https://raw.githubusercontent.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/v15/docs/screenshots/backoffice.png) ## Quick Start @@ -26,28 +24,17 @@ Is your backoffice a bit untidy? - Refresh your page and enjoy a cleaner backoffice ✨ ## Configuration + Add the following to your `appsettings.json` file -```JSON -{ - "BackOfficeOrganiser": { - "DataTypes": { - "InternalFolderName": "Internal", - "ThirdPartyFolderName": "Third Party", - "CustomFolderName": "Custom", - "OrganiseOnSave": true - }, - "ContentTypes": { - "OrganiseOnSave": true - }, - "MediaTypes": { - "OrganiseOnSave": true - }, - "MemberTypes": { - "OrganiseOnSave": true - } - } -} +```json title="appsettings.json" + "BackOfficeOrganiser": { + "DataTypes": { + "InternalFolderName": "Internal", + "ThirdPartyFolderName": "Third Party", + "CustomFolderName": "Custom" + } + } ``` ## Extending @@ -60,11 +47,10 @@ You can implement your own `Organise Action`, a method that determines where a t - `Data Types` => `IDataTypeOrganiseAction` ### Example -```csharp +```csharp title="ExampleContentTypeOrganiseAction.cs" using jcdcdev.Umbraco.Core.Extensions; using Umbraco.Cms.Core.Models; using Umbraco.Cms.Core.Services; -using Umbraco.Community.BackOfficeOrganiser.Core.OrganiseActions; namespace Umbraco.Community.BackOfficeOrganiser.Organisers.ContentTypes; @@ -113,8 +99,11 @@ public class Composer : IComposer ## Contributing -Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/blob/main/.github/CONTRIBUTING.md). +Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/contribute) page. + +## Acknowledgements (Thanks) + +- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) + -## Acknowledgments (thanks!) -- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) \ No newline at end of file diff --git a/SECURITY.md b/SECURITY.md index 903f4e9..f78d315 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,16 +2,22 @@ ## Supported Versions -The following table outlines the versions of the project that are currently supported with security updates: +The following table outlines the versions of the project that are currently supported with security & feature updates: -| Version | Supported | Umbraco Version | -| ------------------------------------------------------- | --------- | --------------- | -| [15.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v15) | ✅ | 15 | -| [14.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v14) | ✅ | 14 | -| [13.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v13) | ✅ | 13 | -| [10.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v10) | ✅ | 10 | -| [12.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v12) | ❌ | 12 | -| [0.1.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/main) | ❌ | 11 | +> [!NOTE] +> Once a version starts its security phase, it will no longer receive feature updates. Only critical bug fixes and security updates will be provided. + +| Package Version | Umbraco Version | Security Phase Start | End of Life | +| ---------------------------------------------------------------------------------- | --------------- | -------------------- | ----------- | +| [10.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v10) | 10 | 2024-06-16 | 2025-06-16 | +| [13.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v13) | 13 | 2025-12-14 | 2026-12-14 | +| [14.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v14) | 14 | 2025-03-02 | 2025-05-30 | +| [15.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v15) | 15 | 2025-08-14 | 2025-11-14 | +## Unsupported Versions + +| Package Version | Umbraco Version | End of Life | +| ---------------------------------------------------------------------------------- | --------------- | ----------- | +| [12.x](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/v12) | 12 | 2024-06-29 | ## Future Support @@ -25,7 +31,7 @@ Project maintainers plan to support all STS (Short-Term Support) and LTS (Long-T If you discover a vulnerability in this project, please follow one of these steps to report it: -- Create an [issue](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/security/advisories/new) +- Create an [issue](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/security/advisories/new) - Contact the project author privately at [jcdc.dev/contact](https://jcdc.dev/contact) ### Details @@ -36,21 +42,21 @@ Include as much information as possible about the vulnerability, including: - Potential impact - Any suggested fixes - ### Acknowledgment -You will receive an acknowledgment of your report as soon as possible. +You will receive an acknowledgment of your report as soon as possible. > [!NOTE] > Response times may vary depending on other commitments. ### Resolution -Once the vulnerability is confirmed, project maintainers will work to resolve it as quickly as possible. +Once the vulnerability is confirmed, project maintainers will work to resolve it as quickly as possible. -You will be notified once the issue has been resolved or rejected. +You will be notified once the issue has been resolved or rejected. > [!TIP] > If the vulnerability is accepted, you will receive credit in the release notes. Thank you for helping to keep this project secure! + diff --git a/docs/README_nuget.md b/docs/README_nuget.md index a427fab..5404302 100644 --- a/docs/README_nuget.md +++ b/docs/README_nuget.md @@ -1,12 +1,13 @@ # Umbraco.Community.BackOfficeOrganiser -[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/tree/main?tab=readme-ov-file#quick-start) -[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/umbraco.community.backofficeorganiser) -[![GitHub License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.BackOfficeOrganiser?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/blob/main/LICENSE) -[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.BackOfficeOrganiser?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.BackOfficeOrganiser/) +[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser#quick-start) +[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/Umbraco.Community.BackOfficeOrganiser) +[![License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.BackOfficeOrganiser?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser?tab=MIT-1-ov-file) +[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.BackOfficeOrganiser?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.BackOfficeOrganiser) [![Project Website](https://img.shields.io/badge/Project%20Website-jcdc.dev-jcdcdev?style=flat&color=3c4834&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0id2hpdGUiIGNsYXNzPSJiaSBiaS1wYy1kaXNwbGF5IiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik04IDFhMSAxIDAgMCAxIDEtMWg2YTEgMSAwIDAgMSAxIDF2MTRhMSAxIDAgMCAxLTEgMUg5YTEgMSAwIDAgMS0xLTF6bTEgMTMuNWEuNS41IDAgMSAwIDEgMCAuNS41IDAgMCAwLTEgMG0yIDBhLjUuNSAwIDEgMCAxIDAgLjUuNSAwIDAgMC0xIDBNOS41IDFhLjUuNSAwIDAgMCAwIDFoNWEuNS41IDAgMCAwIDAtMXpNOSAzLjVhLjUuNSAwIDAgMCAuNS41aDVhLjUuNSAwIDAgMCAwLTFoLTVhLjUuNSAwIDAgMC0uNS41TTEuNSAyQTEuNSAxLjUgMCAwIDAgMCAzLjV2N0ExLjUgMS41IDAgMCAwIDEuNSAxMkg2djJoLS41YS41LjUgMCAwIDAgMCAxSDd2LTRIMS41YS41LjUgMCAwIDEtLjUtLjV2LTdhLjUuNSAwIDAgMSAuNS0uNUg3VjJ6Ii8+Cjwvc3ZnPg==)](https://jcdc.dev/umbraco-packages/back-office-organiser) -Is your backoffice a bit untidy? + +Is your Backoffice a bit untidy? - Single-click (and opinionated) organiser for - Document Types @@ -14,12 +15,36 @@ Is your backoffice a bit untidy? - Member Types - Data Types -![A screenshot of the Back Office Organiser in action](https://raw.githubusercontent.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/v15/docs/screenshots/backoffice.png) +## Quick Start + +- Go to the backoffice +- Click `Settings` +- Click `Organise` +- Select the types you wish to organise +- Click submit and confirm +- Refresh your page and enjoy a cleaner backoffice ✨ + +## Configuration + +Add the following to your `appsettings.json` file + +```json title="appsettings.json" + "BackOfficeOrganiser": { + "DataTypes": { + "InternalFolderName": "Internal", + "ThirdPartyFolderName": "Third Party", + "CustomFolderName": "Custom" + } + } +``` ## Contributing -Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/blob/main/.github/CONTRIBUTING.md). +Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser/contribute) page. + +## Acknowledgements (Thanks) + +- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) + -## Acknowledgments (thanks!) -- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) \ No newline at end of file diff --git a/src/Umbraco.Community.BackOfficeOrganiser.Client/package-lock.json b/src/Umbraco.Community.BackOfficeOrganiser.Client/package-lock.json index c2c11f3..3a58635 100644 --- a/src/Umbraco.Community.BackOfficeOrganiser.Client/package-lock.json +++ b/src/Umbraco.Community.BackOfficeOrganiser.Client/package-lock.json @@ -14,7 +14,7 @@ "@hey-api/openapi-ts": "^0.66.5", "@umbraco-cms/backoffice": "^15.3.1", "typescript": "^5.8.3", - "vite": "^6.3.2" + "vite": "^6.3.4" } }, "node_modules/@esbuild/aix-ppc64": { @@ -3699,18 +3699,18 @@ } }, "node_modules/vite": { - "version": "6.3.2", - "resolved": "https://registry.npmjs.org/vite/-/vite-6.3.2.tgz", - "integrity": "sha512-ZSvGOXKGceizRQIZSz7TGJ0pS3QLlVY/9hwxVh17W3re67je1RKYzFHivZ/t0tubU78Vkyb9WnHPENSBCzbckg==", + "version": "6.3.4", + "resolved": "https://registry.npmjs.org/vite/-/vite-6.3.4.tgz", + "integrity": "sha512-BiReIiMS2fyFqbqNT/Qqt4CVITDU9M9vE+DKcVAsB+ZV0wvTKd+3hMbkpxz1b+NmEDMegpVbisKiAZOnvO92Sw==", "dev": true, "license": "MIT", "dependencies": { "esbuild": "^0.25.0", - "fdir": "^6.4.3", + "fdir": "^6.4.4", "picomatch": "^4.0.2", "postcss": "^8.5.3", "rollup": "^4.34.9", - "tinyglobby": "^0.2.12" + "tinyglobby": "^0.2.13" }, "bin": { "vite": "bin/vite.js" diff --git a/src/Umbraco.Community.BackOfficeOrganiser.Client/package.json b/src/Umbraco.Community.BackOfficeOrganiser.Client/package.json index c657193..c32baf3 100644 --- a/src/Umbraco.Community.BackOfficeOrganiser.Client/package.json +++ b/src/Umbraco.Community.BackOfficeOrganiser.Client/package.json @@ -16,7 +16,7 @@ "@hey-api/openapi-ts": "^0.66.5", "@umbraco-cms/backoffice": "^15.3.1", "typescript": "^5.8.3", - "vite": "^6.3.2" + "vite": "^6.3.4" }, "volta": { "node": "22.14.0"