Add OpenAPI, JS context, JS repository

Author: rickbutterfield

src/Umbraco.Community.Sustainability/ConfigureSwaggerGenOptions.cs

@@ -0,0 +1,24 @@
+#if NET8_0
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace Umbraco.Community.Sustainability
+{
+    public class ConfigureSwaggerGenOptions : IConfigureOptions<SwaggerGenOptions>
+    {
+        public void Configure(SwaggerGenOptions options)
+        {
+            options.SwaggerDoc(
+                "sustainability",
+                new OpenApiInfo
+                {
+                    Title = "Sustainability API",
+                    Version = "Latest",
+                    Description = "Umbraco.Community.Sustainability"
+                });
+        }
+    }
+}
+#endif

src/Umbraco.Community.Sustainability/Controllers/SustainabilityWorkspaceController.cs

@@ -0,0 +1,86 @@
+#if NET8_0
+using System.Text.Json;
+using Asp.Versioning;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.Models.PublishedContent;
+using Umbraco.Community.Sustainability.Models;
+using Umbraco.Community.Sustainability.Schemas;
+using Umbraco.Community.Sustainability.Services;
+using Umbraco.Extensions;
+
+namespace Umbraco.Community.Sustainability.Controllers
+{
+    [ApiVersion("1.0")]
+    [ApiExplorerSettings(GroupName = "sustainability")]
+    public class SustainabilityWorkspaceController : SustainabilityWorkspaceControllerBase
+    {
+        private readonly IPublishedContentQuery _contentQuery;
+        private readonly IPageMetricService _pageMetricService;
+        private readonly ISustainabilityService _sustainabilityService;
+
+        public SustainabilityWorkspaceController(
+            IPublishedContentQuery contentQuery,
+            IPageMetricService pageMetricService,
+            ISustainabilityService sustainabilityService)
+        {
+            _contentQuery = contentQuery;
+            _pageMetricService = pageMetricService;
+            _sustainabilityService = sustainabilityService;
+        }
+
+        [HttpGet("getPageData")]
+        [ProducesResponseType(typeof(string), 200)]
+        public async Task<IActionResult> GetPageData([FromQuery] int pageId)
+        {
+            var pageMetrics = await _pageMetricService.GetPageMetrics(pageId);
+            var mostRecent = pageMetrics.OrderByDescending(x => x.RequestDate).FirstOrDefault();
+            if (mostRecent?.PageData == null)
+            {
+                return Ok("No recent data found");
+            }
+
+            var sustainabilityData = JsonSerializer.Deserialize<SustainabilityResponse>(mostRecent.PageData);
+            return Ok(sustainabilityData);
+        }
+
+        [HttpGet("checkPage")]
+        public async Task<IActionResult> CheckPage([FromQuery] int pageId)
+        {
+            var contentItem = _contentQuery.Content(pageId);
+            if (contentItem == null)
+            {
+                return Ok("Page not found");
+            }
+
+            var url = contentItem.Url(mode: UrlMode.Absolute);
+            var sustainabilityData = await _sustainabilityService.GetSustainabilityData(url);
+
+            return Ok(sustainabilityData);
+        }
+
+        [HttpPost("savePageData")]
+        public async Task<IActionResult> SavePageData([FromQuery] int pageId, [FromBody] SustainabilityResponse data)
+        {
+            if (data.TotalSize == 0)
+            {
+                return Ok("Missing data to update");
+            }
+
+            var pageMetric = new PageMetric()
+            {
+                NodeId = pageId,
+                RequestedBy = "Admin",
+                RequestDate = data.LastRunDate,
+                TotalSize = data.TotalSize,
+                TotalEmissions = Convert.ToDecimal(data.TotalEmissions),
+                CarbonRating = data.CarbonRating,
+                PageData = JsonSerializer.Serialize(data),
+            };
+
+            await _pageMetricService.AddPageMetric(pageMetric);
+            return Ok(true);
+        }
+    }
+}
+#endif

src/Umbraco.Community.Sustainability/Controllers/SustainabilityWorkspaceControllerBase.cs

@@ -0,0 +1,17 @@
+#if NET8_0
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Umbraco.Cms.Web.Common.Authorization;
+using Umbraco.Cms.Web.Common.Routing;
+using Umbraco.Cms.Api.Common.Attributes;
+
+namespace Umbraco.Community.Sustainability.Controllers
+{
+    [ApiController]
+    [BackOfficeRoute("sustainability/api/v{version:apiVersion}")]
+    [Authorize(Policy = "New" + AuthorizationPolicies.BackOfficeAccess)]
+    [MapToApi("sustainability")]
+    public class SustainabilityWorkspaceControllerBase : Controller
+    { }
+}
+#endif

src/Umbraco.Community.Sustainability/SustainabilityComposer.cs

@@ -21,6 +21,10 @@ public void Compose(IUmbracoBuilder builder)
 
             builder.Services.AddSingleton<IPageMetricService, PageMetricService>();
             builder.Services.AddSingleton<ISustainabilityService, SustainabilityService>();
+
+#if NET8_0
+            builder.Services.ConfigureOptions<ConfigureSwaggerGenOptions>();
+#endif
         }
     }
 }

src/Umbraco.Community.Sustainability/Umbraco.Community.Sustainability.csproj

@@ -39,6 +39,7 @@
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
     <PackageReference Include="Umbraco.Cms.Web.Website" Version="[13.0.0, 15.0.0)" />
+    <PackageReference Include="Umbraco.Cms.Api.Common" Version="[13.0.0, 15.0.0)" />
     <PackageReference Include="Umbraco.Cms.Web.BackOffice" Version="[13.0.0, 15.0.0)" />
   </ItemGroup>
 

src/Umbraco.Community.Sustainability/assets/openapitools.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "7.2.0"
+  }
+}