Merge pull request #1 from jcdcdev/dev

0.1.0

Author: jcdcdev

.github/README.md

@@ -1,15 +1,44 @@
 # Umbraco.Community.DataProtection
 
-[![Umbraco Version](https://img.shields.io/badge/Umbraco-10.4+-%233544B1?style=flat&logo=umbraco)](https://umbraco.com/products/umbraco-cms/)
+[![Umbraco Version](https://img.shields.io/badge/Umbraco-10.4+-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/umbraco.community.dataprotection)
 [![NuGet](https://img.shields.io/nuget/vpre/Umbraco.Community.DataProtection?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.DataProtection)
-[![GitHub license](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.DataProtection?color=8AB803)](../LICENSE)
+[![GitHub license](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.DataProtection?color=8AB803)](https://github.com/jcdcdev/Umbraco.Community.DataProtection/blob/main/LICENSE)
 [![Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.DataProtection?color=cc9900)](https://www.nuget.org/packages/Umbraco.Community.DataProtection/)
 
+Simple [ASP.NET Core Data Protection](https://learn.microsoft.com/en-us/aspnet/core/security/data-protection/introduction?view=aspnetcore-8.0) for Umbraco CMS.
+
+Data protection keys are stored in the Umbraco database.
+
+## Quick Start
+
+### Install
+
+```csharp
+dotnet add package Umbraco.Community.DataProtection
+```
+
+### Configure
+
+```csharp
+using Umbraco.Cms.Core.Composing;
+using Umbraco.Cms.Core.DependencyInjection;
+
+namespace Project.Web;
+
+public class Composer : IComposer
+{
+    public void Compose(IUmbracoBuilder builder)
+    {
+        builder.AddUmbracoDataProtection();
+    }
+}
+```
+
 ## Contributing
 
-Contributions to this package are most welcome! Please read the [Contributing Guidelines](CONTRIBUTING.md).
+Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.DataProtection/blob/main/.github/CONTRIBUTING.md).
 
 ## Acknowledgments (thanks!)
 
 - LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
-- jcdcdev - [jcdcdev.Umbraco.PackageTemplate](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate)
+- jcdcdev - [jcdcdev.Umbraco.PackageTemplate](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate)

.github/workflows/build.yml

@@ -12,6 +12,4 @@ jobs:
       - metadata
     with:
       project-name: ${{ needs.metadata.outputs.project-name }}
-      project-path: ${{ needs.metadata.outputs.project-path }}
-      npm-working-dir: ${{ needs.metadata.outputs.npm-working-dir }}
-      npm-enabled: true
+      project-path: ${{ needs.metadata.outputs.project-path }}

.github/workflows/release.yml

@@ -5,16 +5,14 @@ jobs:
   metadata:
     uses: jcdcdev/jcdcdev.Github.UmbracoSimpleDeploy/.github/workflows/generate-project-metadata.yml@main
   build:
-    uses: jcdcdev/jcdcdev.Github.UmbracoSimpleDeploy/.github/workflows/build-template.yml@main    
-    needs: 
+    uses: jcdcdev/jcdcdev.Github.UmbracoSimpleDeploy/.github/workflows/build-template.yml@main
+    needs:
       - metadata
     with:
       project-name: ${{ needs.metadata.outputs.project-name }}
       project-path: ${{ needs.metadata.outputs.project-path }}
-      npm-working-dir: ${{ needs.metadata.outputs.npm-working-dir }}
-      npm-enabled: true
   release:
-    needs: 
+    needs:
       - build
     permissions:
       contents: write

docs/icon.png

@@ -7,5 +7,6 @@ public class Composer : IComposer
 {
     public void Compose(IUmbracoBuilder builder)
     {
+        builder.AddUmbracoDataProtection();
     }
 }

src/TestSite.10/Composer.cs

@@ -1,19 +1,18 @@
-namespace TestSite.Ten
+namespace TestSite.Ten;
+
+public class Program
 {
-    public class Program
-    {
-        public static void Main(string[] args)
-            => CreateHostBuilder(args)
-                .Build()
-                .Run();
+    public static void Main(string[] args)
+        => CreateHostBuilder(args)
+            .Build()
+            .Run();
 
-        public static IHostBuilder CreateHostBuilder(string[] args) =>
-            Host.CreateDefaultBuilder(args)
-                .ConfigureUmbracoDefaults()
-                .ConfigureWebHostDefaults(webBuilder =>
-                {
-                    webBuilder.UseStaticWebAssets();
-                    webBuilder.UseStartup<Startup>();
-                });
-    }
+    public static IHostBuilder CreateHostBuilder(string[] args) =>
+        Host.CreateDefaultBuilder(args)
+            .ConfigureUmbracoDefaults()
+            .ConfigureWebHostDefaults(webBuilder =>
+            {
+                webBuilder.UseStaticWebAssets();
+                webBuilder.UseStartup<Startup>();
+            });
 }

src/TestSite.10/Program.cs

@@ -1,65 +1,64 @@
-namespace TestSite.Ten
+namespace TestSite.Ten;
+
+public class Startup
 {
-    public class Startup
+    private readonly IConfiguration _config;
+    private readonly IWebHostEnvironment _env;
+
+    /// <summary>
+    ///     Initializes a new instance of the <see cref="Startup" /> class.
+    /// </summary>
+    /// <param name="webHostEnvironment">The web hosting environment.</param>
+    /// <param name="config">The configuration.</param>
+    /// <remarks>
+    ///     Only a few services are possible to be injected here https://github.com/dotnet/aspnetcore/issues/9337.
+    /// </remarks>
+    public Startup(IWebHostEnvironment webHostEnvironment, IConfiguration config)
     {
-        private readonly IWebHostEnvironment _env;
-        private readonly IConfiguration _config;
+        _env = webHostEnvironment ?? throw new ArgumentNullException(nameof(webHostEnvironment));
+        _config = config ?? throw new ArgumentNullException(nameof(config));
+    }
 
-        /// <summary>
-        /// Initializes a new instance of the <see cref="Startup" /> class.
-        /// </summary>
-        /// <param name="webHostEnvironment">The web hosting environment.</param>
-        /// <param name="config">The configuration.</param>
-        /// <remarks>
-        /// Only a few services are possible to be injected here https://github.com/dotnet/aspnetcore/issues/9337.
-        /// </remarks>
-        public Startup(IWebHostEnvironment webHostEnvironment, IConfiguration config)
-        {
-            _env = webHostEnvironment ?? throw new ArgumentNullException(nameof(webHostEnvironment));
-            _config = config ?? throw new ArgumentNullException(nameof(config));
-        }
+    /// <summary>
+    ///     Configures the services.
+    /// </summary>
+    /// <param name="services">The services.</param>
+    /// <remarks>
+    ///     This method gets called by the runtime. Use this method to add services to the container.
+    ///     For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940.
+    /// </remarks>
+    public void ConfigureServices(IServiceCollection services)
+    {
+        services.AddUmbraco(_env, _config)
+            .AddBackOffice()
+            .AddWebsite()
+            .AddComposers()
+            .Build();
+    }
 
-        /// <summary>
-        /// Configures the services.
-        /// </summary>
-        /// <param name="services">The services.</param>
-        /// <remarks>
-        /// This method gets called by the runtime. Use this method to add services to the container.
-        /// For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940.
-        /// </remarks>
-        public void ConfigureServices(IServiceCollection services)
+    /// <summary>
+    ///     Configures the application.
+    /// </summary>
+    /// <param name="app">The application builder.</param>
+    /// <param name="env">The web hosting environment.</param>
+    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
+    {
+        if (env.IsDevelopment())
         {
-            services.AddUmbraco(_env, _config)
-                .AddBackOffice()
-                .AddWebsite()
-                .AddComposers()
-                .Build();
+            app.UseDeveloperExceptionPage();
         }
 
-        /// <summary>
-        /// Configures the application.
-        /// </summary>
-        /// <param name="app">The application builder.</param>
-        /// <param name="env">The web hosting environment.</param>
-        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
-        {
-            if (env.IsDevelopment())
+        app.UseUmbraco()
+            .WithMiddleware(u =>
             {
-                app.UseDeveloperExceptionPage();
-            }
-
-            app.UseUmbraco()
-                .WithMiddleware(u =>
-                {
-                    u.UseBackOffice();
-                    u.UseWebsite();
-                })
-                .WithEndpoints(u =>
-                {
-                    u.UseInstallerEndpoints();
-                    u.UseBackOfficeEndpoints();
-                    u.UseWebsiteEndpoints();
-                });
-        }
+                u.UseBackOffice();
+                u.UseWebsite();
+            })
+            .WithEndpoints(u =>
+            {
+                u.UseInstallerEndpoints();
+                u.UseBackOfficeEndpoints();
+                u.UseWebsiteEndpoints();
+            });
     }
 }

src/TestSite.10/Startup.cs

@@ -1,4 +1,3 @@
-@using Umbraco.Extensions
-@inherits Umbraco.Cms.Web.Common.Views.UmbracoViewPage<Umbraco.Cms.Core.Models.Blocks.BlockGridItem>
+@inherits UmbracoViewPage<Umbraco.Cms.Core.Models.Blocks.BlockGridItem>
 
 <h2 style="padding: 20px">@Model.Content.Value("headline")</h2>

src/TestSite.10/Views/Partials/blockgrid/Components/umbBlockGridDemoHeadlineBlock.cshtml

@@ -1,12 +1,14 @@
-@using Umbraco.Extensions
-@inherits Umbraco.Cms.Web.Common.Views.UmbracoViewPage<Umbraco.Cms.Core.Models.Blocks.BlockGridItem>
+@using Umbraco.Cms.Core.Models
+@inherits UmbracoViewPage<Umbraco.Cms.Core.Models.Blocks.BlockGridItem>
 
 @{
-    var typedMediaPickerSingle = Model.Content.Value<Umbraco.Cms.Core.Models.MediaWithCrops>("image");
+    var typedMediaPickerSingle = Model.Content.Value<MediaWithCrops>("image");
     if (typedMediaPickerSingle != null)
     {
         <img src="@typedMediaPickerSingle.MediaUrl()" style="object-fit:cover; width:100%; height:100%;"/>
-    } else {
+    }
+    else
+    {
         <p>Missing image</p>
     }
 }

src/TestSite.10/Views/Partials/blockgrid/Components/umbBlockGridDemoImageBlock.cshtml

@@ -1,6 +1,5 @@
-@using Umbraco.Extensions
-@inherits Umbraco.Cms.Web.Common.Views.UmbracoViewPage<Umbraco.Cms.Core.Models.Blocks.BlockGridItem>
+@inherits UmbracoViewPage<Umbraco.Cms.Core.Models.Blocks.BlockGridItem>
 
 <div style="padding: 20px">
-@Model.Content.Value("richText")
+    @Model.Content.Value("richText")
 </div>