Merge branch 'v14/dev' into release/14.0

Author: iOvergaard

Directory.Packages.props

@@ -76,8 +76,6 @@
     <PackageVersion Include="Serilog.Sinks.Map" Version="1.0.2" />
     <PackageVersion Include="SixLabors.ImageSharp" Version="3.1.2" />
     <PackageVersion Include="SixLabors.ImageSharp.Web" Version="3.1.0" />
-    <PackageVersion Include="Smidge.InMemory" Version="4.3.0" />
-    <PackageVersion Include="Smidge.Nuglify" Version="4.3.0" />
     <PackageVersion Include="Swashbuckle.AspNetCore" Version="6.5.0" />
   </ItemGroup>
   <!-- Transitive pinned versions (only required because our direct dependencies have vulnerable versions of transitive dependencies) -->

build/azure-pipelines.yml

@@ -85,23 +85,6 @@ stages:
             retryCountOnTaskFailure: 3
             inputs:
               versionSpec: $(nodeVersion)
-          - task: Cache@2
-            displayName: Cache node_modules
-            inputs:
-              key: '"npm_client" | "$(Agent.OS)" | $(Build.SourcesDirectory)/src/Umbraco.Web.UI.Client/package-lock.json'
-              restoreKeys: |
-                "npm_client" | "$(Agent.OS)"
-                "npm_client"
-              path: $(npm_config_cache)
-          - script: npm ci --no-fund --no-audit --prefer-offline
-            workingDirectory:  src/Umbraco.Web.UI.Client
-            displayName: Run npm ci (Backoffice)
-          - task: gulp@0
-            displayName: Run gulp build (Backoffice)
-            inputs:
-              gulpFile: src/Umbraco.Web.UI.Client/gulpfile.js
-              targets: coreBuild
-              workingDirectory: src/Umbraco.Web.UI.Client
           - script: npm ci --no-fund --no-audit --prefer-offline
             displayName: Run npm ci (Login)
             workingDirectory: src/Umbraco.Web.UI.Login
@@ -111,6 +94,10 @@ stages:
           - script: npm ci --no-fund --no-audit --prefer-offline
             displayName: Run npm ci (Bellissima)
             workingDirectory: src/Umbraco.Web.UI.New.Client
+          - script: npm run generate:api-local
+            displayName: Generate API models (Bellissima)
+            workingDirectory: src/Umbraco.Web.UI.New.Client
+            enabled: false
           - script: npm run build:for:cms
             displayName: Run build (Bellissima)
             workingDirectory: src/Umbraco.Web.UI.New.Client
@@ -238,7 +225,7 @@ stages:
           - task: Cache@2
             displayName: Cache node_modules
             inputs:
-              key: '"npm_client" | "$(Agent.OS)"| $(Build.SourcesDirectory)/src/Umbraco.Web.UI.Client/package-lock.json | $(Build.SourcesDirectory)/src/Umbraco.Web.UI.New.Client/package-lock.json'
+              key: '"npm_client" | "$(Agent.OS)"| $(Build.SourcesDirectory)/src/Umbraco.Web.UI.New.Client/package-lock.json'
               restoreKeys: |
                 "npm_client" | "$(Agent.OS)"
                 "npm_client"

src/Umbraco.Cms.Api.Common/OpenApi/OperationIdSelector.cs

@@ -1,16 +1,36 @@
 using Asp.Versioning;
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
 using Microsoft.AspNetCore.Mvc.Controllers;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Extensions;
 
 namespace Umbraco.Cms.Api.Common.OpenApi;
 
 public class OperationIdSelector : IOperationIdSelector
 {
+    private readonly UmbracoOperationIdSettings _umbracoOperationIdSettings;
+
+    [Obsolete("Use non obsolete constructor")]
+    public OperationIdSelector() : this(StaticServiceProvider.Instance.GetRequiredService<IOptions<UmbracoOperationIdSettings>>())
+    {
+    }
+
+    public OperationIdSelector(IOptions<UmbracoOperationIdSettings> umbracoOperationIdSettings)
+    {
+        _umbracoOperationIdSettings = umbracoOperationIdSettings.Value;
+    }
+
     public virtual string? OperationId(ApiDescription apiDescription, ApiVersioningOptions apiVersioningOptions)
     {
-        if (apiDescription.ActionDescriptor is not ControllerActionDescriptor controllerActionDescriptor
-            || controllerActionDescriptor.ControllerTypeInfo.Namespace?.StartsWith("Umbraco.Cms.Api") is not true)
+        if (apiDescription.ActionDescriptor is not ControllerActionDescriptor controllerActionDescriptor)
+        {
+            return null;
+        }
+
+        var controllerTypeInfoNamespace = controllerActionDescriptor.ControllerTypeInfo.Namespace;
+        if (controllerTypeInfoNamespace is not null && _umbracoOperationIdSettings.NameSpacePrefixes.Any(prefix => controllerTypeInfoNamespace.StartsWith(prefix)) is false)
         {
             return null;
         }

src/Umbraco.Cms.Api.Common/OpenApi/UmbracoOperationIdSettings.cs

@@ -0,0 +1,16 @@
+namespace Umbraco.Cms.Api.Common.OpenApi;
+
+public class UmbracoOperationIdSettings
+{
+    private HashSet<string> _nameSpacePrefixes = new HashSet<string>()
+    {
+        "Umbraco.Cms.Api"
+    };
+
+    public IReadOnlySet<string> NameSpacePrefixes
+    {
+        get => _nameSpacePrefixes;
+    }
+
+    public bool AddNameSpacePrefix(string prefix) => _nameSpacePrefixes.Add(prefix);
+}

src/Umbraco.Cms.Api.Management/Configuration/ConfigureUmbracoManagementApiSwaggerGenOptions.cs

@@ -34,6 +34,11 @@ public void Configure(SwaggerGenOptions swaggerGenOptions)
         swaggerGenOptions.UseOneOfForPolymorphism();
         swaggerGenOptions.UseAllOfForInheritance();
 
+        // Ensure all types that implements the IOpenApiDiscriminator have a $type property in the OpenApi schema with the default value (The class name) that is expected by the server
+        swaggerGenOptions.SelectDiscriminatorNameUsing(type => typeof(IOpenApiDiscriminator).IsAssignableFrom(type) ? "$type" : null);
+        swaggerGenOptions.SelectDiscriminatorValueUsing(type => typeof(IOpenApiDiscriminator).IsAssignableFrom(type) ? type.Name : null);
+
+
         swaggerGenOptions.AddSecurityDefinition(
             ManagementApiConfiguration.ApiSecurityName,
             new OpenApiSecurityScheme
@@ -55,7 +60,7 @@ public void Configure(SwaggerGenOptions swaggerGenOptions)
 
         // Sets Security requirement on backoffice apis
         swaggerGenOptions.OperationFilter<BackOfficeSecurityRequirementsOperationFilter>();
+        swaggerGenOptions.OperationFilter<NotificationHeaderFilter>();
         swaggerGenOptions.SchemaFilter<RequireNonNullablePropertiesSchemaFilter>();
     }
-
 }

src/Umbraco.Cms.Api.Management/Controllers/DataType/DataTypeControllerBase.cs

@@ -16,46 +16,48 @@ namespace Umbraco.Cms.Api.Management.Controllers.DataType;
 public abstract class DataTypeControllerBase : ManagementApiControllerBase
 {
     protected IActionResult DataTypeOperationStatusResult(DataTypeOperationStatus status) =>
-        status switch
+        OperationStatusResult(status, problemDetailsBuilder => status switch
         {
-            DataTypeOperationStatus.InvalidConfiguration => BadRequest(new ProblemDetailsBuilder()
+            DataTypeOperationStatus.InvalidConfiguration => BadRequest(problemDetailsBuilder
                 .WithTitle("Invalid data type configuration")
                 .WithDetail("The supplied data type configuration was not valid. Please see the log for more details.")
                 .Build()),
-            DataTypeOperationStatus.NotFound => DataTypeNotFound(),
-            DataTypeOperationStatus.InvalidName => BadRequest(new ProblemDetailsBuilder()
+            DataTypeOperationStatus.NotFound => DataTypeNotFound(problemDetailsBuilder),
+            DataTypeOperationStatus.InvalidName => BadRequest(problemDetailsBuilder
                 .WithTitle("Invalid data type name")
                 .WithDetail("The data type name must be non-empty and no longer than 255 characters.")
                 .Build()),
-            DataTypeOperationStatus.ParentNotContainer => BadRequest(new ProblemDetailsBuilder()
+            DataTypeOperationStatus.ParentNotContainer => BadRequest(problemDetailsBuilder
                 .WithTitle("parent id is not a container")
                 .WithDetail("The parent id does not represent a container.")
                 .Build()),
-            DataTypeOperationStatus.DuplicateKey => BadRequest(new ProblemDetailsBuilder()
+            DataTypeOperationStatus.DuplicateKey => BadRequest(problemDetailsBuilder
                 .WithTitle("The id is already used")
                 .WithDetail("The data type id must be unique.")
                 .Build()),
-            DataTypeOperationStatus.CancelledByNotification => BadRequest(new ProblemDetailsBuilder()
+            DataTypeOperationStatus.CancelledByNotification => BadRequest(problemDetailsBuilder
                 .WithTitle("Cancelled by notification")
                 .WithDetail("A notification handler prevented the data type operation.")
                 .Build()),
-            DataTypeOperationStatus.PropertyEditorNotFound => NotFound(
-                new ProblemDetailsBuilder()
-                    .WithTitle("The targeted property editor was not found.")
-                    .Build()),
-            DataTypeOperationStatus.ParentNotFound => NotFound(new ProblemDetailsBuilder()
-                    .WithTitle("The targeted parent for the data type operation was not found.")
-                    .Build()),
-            DataTypeOperationStatus.NonDeletable => BadRequest(new ProblemDetailsBuilder()
+            DataTypeOperationStatus.PropertyEditorNotFound => NotFound(problemDetailsBuilder
+                .WithTitle("The targeted property editor was not found.")
+                .Build()),
+            DataTypeOperationStatus.ParentNotFound => NotFound(problemDetailsBuilder
+                .WithTitle("The targeted parent for the data type operation was not found.")
+                .Build()),
+            DataTypeOperationStatus.NonDeletable => BadRequest(problemDetailsBuilder
                 .WithTitle("The data type is non-deletable")
                 .WithDetail("The specified data type is required by the system and cannot be deleted.")
                 .Build()),
-            _ => StatusCode(StatusCodes.Status500InternalServerError, new ProblemDetailsBuilder()
+            _ => StatusCode(StatusCodes.Status500InternalServerError, problemDetailsBuilder
                 .WithTitle("Unknown data type operation status.")
                 .Build()),
-        };
+        });
+
+    protected IActionResult DataTypeNotFound() => OperationStatusResult(DataTypeOperationStatus.NotFound, DataTypeNotFound);
 
-    protected IActionResult DataTypeNotFound() => NotFound(new ProblemDetailsBuilder()
-        .WithTitle("The data type could not be found")
-        .Build());
+    private IActionResult DataTypeNotFound(ProblemDetailsBuilder problemDetailsBuilder)
+        => NotFound(problemDetailsBuilder
+            .WithTitle("The data type could not be found")
+            .Build());
 }

src/Umbraco.Cms.Api.Management/Controllers/DataType/Tree/ChildrenDataTypeTreeController.cs

@@ -3,7 +3,7 @@
 using Microsoft.AspNetCore.Mvc;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Api.Common.ViewModels.Pagination;
-using Umbraco.Cms.Api.Management.ViewModels.DataType.Item;
+using Umbraco.Cms.Api.Management.ViewModels.Tree;
 
 namespace Umbraco.Cms.Api.Management.Controllers.DataType.Tree;
 

src/Umbraco.Cms.Api.Management/Controllers/DataType/Tree/DataTypeTreeControllerBase.cs

@@ -6,7 +6,7 @@
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Api.Management.Controllers.Tree;
 using Umbraco.Cms.Api.Management.Routing;
-using Umbraco.Cms.Api.Management.ViewModels.DataType.Item;
+using Umbraco.Cms.Api.Management.ViewModels.Tree;
 using Umbraco.Cms.Web.Common.Authorization;
 using Umbraco.Extensions;
 

src/Umbraco.Cms.Api.Management/Controllers/Dictionary/AllDictionaryController.cs

@@ -25,10 +25,10 @@ public AllDictionaryController(IDictionaryItemService dictionaryItemService, IUm
     [HttpGet]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(PagedViewModel<DictionaryOverviewResponseModel>), StatusCodes.Status200OK)]
-    public async Task<ActionResult<PagedViewModel<DictionaryOverviewResponseModel>>> All(int skip = 0, int take = 100)
+    public async Task<ActionResult<PagedViewModel<DictionaryOverviewResponseModel>>> All(string? filter = null, int skip = 0, int take = 100)
     {
         // unfortunately we can't paginate here...we'll have to get all and paginate in memory
-        IDictionaryItem[] items = (await _dictionaryItemService.GetDescendantsAsync(Constants.System.RootKey)).ToArray();
+        IDictionaryItem[] items = (await _dictionaryItemService.GetDescendantsAsync(Constants.System.RootKey, filter)).ToArray();
         var model = new PagedViewModel<DictionaryOverviewResponseModel>
         {
             Total = items.Length,

src/Umbraco.Cms.Api.Management/Controllers/Dictionary/ByKeyDictionaryController.cs

@@ -29,7 +29,7 @@ public async Task<IActionResult> ByKey(Guid id)
         IDictionaryItem? dictionary = await _dictionaryItemService.GetAsync(id);
         if (dictionary == null)
         {
-            return DictionaryNotFound();
+            return DictionaryItemNotFound();
         }
 
         return Ok(await _dictionaryPresentationFactory.CreateDictionaryItemViewModelAsync(dictionary));