Verifying backoffice model for property in new document

Author: lars-erik

Our.Umbraco.Test.Examples/DataEditors/DataEditor_Via_Hosted_Controller.Creates_Json_Model_For_New_Document.verified.txt

@@ -0,0 +1,26 @@
+{
+  variations: Nothing,
+  label: My property,
+  description: ,
+  view: /App_Plugins/MyEditor/editor.html,
+  hideLabel: false,
+  labelOnTop: false,
+  validation: {
+    mandatory: false,
+    mandatoryMessage: ,
+    pattern: ,
+    patternMessage: 
+  },
+  readonly: false,
+  id: 0,
+  dataTypeKey: Guid_1,
+  value: {
+    dataForBackoffice: Some extra data for the view
+  },
+  alias: myProperty,
+  editor: my.editor,
+  isSensitive: false,
+  culture: null,
+  segment: null,
+  supportsReadOnly: false
+}

Our.Umbraco.Test.Examples/DataEditors/DataEditor_Via_Hosted_Controller.cs

@@ -0,0 +1,142 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.Models;
+using Umbraco.Cms.Core.PropertyEditors;
+using Umbraco.Cms.Core.Serialization;
+using Umbraco.Cms.Core.Services;
+using Umbraco.Cms.Core.Strings;
+using Umbraco.Cms.Tests.Common.Builders;
+using Umbraco.Cms.Tests.Common.Builders.Extensions;
+using Umbraco.Cms.Tests.Integration.TestServerTest;
+using Umbraco.Cms.Web.BackOffice.Controllers;
+using Umbraco.Cms.Web.Common.Formatters;
+using Umbraco.Extensions;
+
+namespace Our.Umbraco.Test.Examples.DataEditors;
+
+public class DataEditor_Via_Hosted_Controller : UmbracoTestServerTestBase
+{
+    [Test]
+    public async Task Creates_Json_Model_For_New_Document()
+    {
+        var url = PrepareApiControllerUrl<ContentController>(x => x.GetEmpty("myDoctype", -1));
+
+        var response = await Client.GetAsync(url);
+
+        var json = await response.Content.ReadAsStringAsync();
+        json = json.TrimStart(AngularJsonMediaTypeFormatter.XsrfPrefix);
+        var model = JObject.Parse(json);
+
+        var property = model.SelectToken("variants[0].tabs[0].properties[0]")!;
+
+        await VerifyJson(property.ToString(Formatting.Indented));
+    }
+
+    [SetUp]
+    public void SetupSchema()
+    {
+        var dataType = new DataTypeBuilder()
+            .WithoutIdentity()
+            .WithKey(new Guid("87c4db0b-4cee-4c49-9668-7607bf93fdb2"))
+            .WithDatabaseType(ValueStorageType.Ntext)
+            .WithName("My editor")
+            .AddEditor()
+                .WithAlias("my.editor")
+                    .AddExplicitValueEditorBuilder()
+                    .WithValueType(ValueTypes.Json)
+                    .Done()
+                .Done()
+            .Build();
+
+        GetRequiredService<IDataTypeService>().Save(dataType);
+
+        var contentType = new ContentTypeBuilder()
+            .WithoutIdentity()
+            .WithName("My doctype")
+            .WithAlias("myDoctype")
+            .AddPropertyType()
+                .WithAlias("my.property")
+                .WithName("My property")
+                .WithPropertyEditorAlias("my.editor")
+                .WithDataTypeId(dataType.Id)
+                .Done()
+            .Build();
+
+        GetRequiredService<IContentTypeService>().Save(contentType);
+    }
+}
+
+public class MyEditor : IDataEditor
+{
+    public const string PreviewPath = "/App_Plugins/MyEditor/editor.html";
+
+    private readonly ILocalizedTextService localizedTextService;
+    private readonly IShortStringHelper shortStringHelper;
+    private readonly IJsonSerializer jsonSerializer;
+
+    public MyEditor(
+        ILocalizedTextService localizedTextService,
+        IShortStringHelper shortStringHelper,
+        IJsonSerializer jsonSerializer
+        )
+    {
+        this.localizedTextService = localizedTextService;
+        this.shortStringHelper = shortStringHelper;
+        this.jsonSerializer = jsonSerializer;
+    }
+
+    public IDataValueEditor GetValueEditor()
+    {
+        return GetValueEditor(null);
+    }
+
+    public IDataValueEditor GetValueEditor(object? configuration)
+    {
+        return new MyDataValueEditor(
+            localizedTextService,
+            shortStringHelper,
+            jsonSerializer
+        )
+        {
+            ValueType = ValueTypes.Json,
+            View = PreviewPath
+        };
+    }
+
+    public IConfigurationEditor GetConfigurationEditor()
+    {
+        return new ConfigurationEditor();
+    }
+
+    public string Alias => "my.editor";
+    public string Name => "My editor";
+    public EditorType Type => EditorType.PropertyValue;
+    public string Icon => "icon-user";
+    public string Group => Constants.PropertyEditors.Groups.Common;
+    public bool IsDeprecated => false;
+    public IDictionary<string, object>? DefaultConfiguration => new Dictionary<string, object>();
+    public IPropertyIndexValueFactory PropertyIndexValueFactory => new DefaultPropertyIndexValueFactory();
+
+}
+
+public class MyDataValueEditor : DataValueEditor
+{
+    public MyDataValueEditor(ILocalizedTextService localizedTextService, IShortStringHelper shortStringHelper, IJsonSerializer jsonSerializer)
+        : base(localizedTextService, shortStringHelper, jsonSerializer)
+    {
+    }
+
+    public override object? ToEditor(IProperty property, string? culture = null, string? segment = null)
+    {
+        var value = property.GetValue(culture, segment) as string;
+        var jObj = JObject.Parse(value ?? "{}");
+        if (!jObj.ContainsKey("dataForBackoffice"))
+        {
+            jObj["dataForBackoffice"] = "Some extra data for the view";
+        }
+
+        return jObj;
+    }
+}
+