Property Editors: New Date Time property editors

src/Umbraco.Core/Constants-DataTypes.cs

@@ -111,6 +111,11 @@ public static class Guids
             /// </summary>
             public const string DatePickerWithTime = "e4d66c0f-b935-4200-81f0-025f7256b89a";
 
+            /// <summary>
+            ///     Guid for Date Time Picker (with Timezone) as string
+            /// </summary>
+            public const string DateTimePickerWithTimeZone = "88E8A052-30EE-4D44-A507-59F2CDFC769C";
+
             /// <summary>
             ///     Guid for Approved Color as string
             /// </summary>
@@ -296,6 +301,11 @@ public static class Guids
             /// </summary>
             public static readonly Guid DatePickerWithTimeGuid = new(DatePickerWithTime);
 
+            /// <summary>
+            ///     Guid for Date Time Picker (with Timezone).
+            /// </summary>
+            public static readonly Guid DateTimePickerWithTimeZoneGuid = new(DateTimePickerWithTimeZone);
+
             /// <summary>
             ///     Guid for Approved Color
             /// </summary>

src/Umbraco.Core/Constants-PropertyEditors.cs

@@ -75,6 +75,26 @@ public static class Aliases
             /// </summary>
             public const string DateTime = "Umbraco.DateTime";
 
+            /// <summary>
+            ///     Date Time (unspecified).
+            /// </summary>
+            public const string DateTimeUnspecified = "Umbraco.DateTimeUnspecified";
+
+            /// <summary>
+            ///     Date Time (with time zone).
+            /// </summary>
+            public const string DateTimeWithTimeZone = "Umbraco.DateTimeWithTimeZone";
+
+            /// <summary>
+            ///     Date Only.
+            /// </summary>
+            public const string DateOnly = "Umbraco.DateOnly";
+
+            /// <summary>
+            ///     Time Only.
+            /// </summary>
+            public const string TimeOnly = "Umbraco.TimeOnly";
+
             /// <summary>
             ///     DropDown List.
             /// </summary>

src/Umbraco.Core/EmbeddedResources/Lang/en.xml

@@ -376,6 +376,7 @@
     <key alias="invalidNull">Value cannot be null</key>
     <key alias="invalidEmpty">Value cannot be empty</key>
     <key alias="invalidPattern">Value is invalid, it does not match the correct pattern</key>
+    <key alias="invalidDate">Invalid date</key>
     <key alias="entriesShort"><![CDATA[Minimum %0% entries, requires <strong>%1%</strong> more.]]></key>
     <key alias="entriesExceed"><![CDATA[Maximum %0% entries, you have entered <strong>%1%</strong> too many.]]></key>
     <key alias="stringLengthExceeded">The string length exceeds the maximum length of %0% characters, %1% too many.</key>

src/Umbraco.Core/PropertyEditors/DateTimeConfiguration.cs

@@ -0,0 +1,49 @@
+// Copyright (c) Umbraco.
+// See LICENSE for more details.
+
+using System.Text.Json.Serialization;
+
+namespace Umbraco.Cms.Core.PropertyEditors;
+
+public class DateTimeConfiguration
+{
+    /// <summary>
+    /// Gets or sets the time zones configuration.
+    /// </summary>
+    [ConfigurationField("timeZones")]
+    public TimeZonesConfiguration? TimeZones { get; set; }
+
+    public class TimeZonesConfiguration
+    {
+        /// <summary>
+        /// The mode for time zones.
+        /// </summary>
+        public TimeZoneMode Mode { get; set; }
+
+        /// <summary>
+        /// A list of time zones to use when the mode is set to Custom.
+        /// </summary>
+        public List<string> TimeZones { get; set; } = [];
+    }
+
+    public enum TimeZoneMode
+    {
+        /// <summary>
+        /// Display all time zones.
+        /// </summary>
+        [JsonStringEnumMemberName("all")]
+        All,
+
+        /// <summary>
+        /// Display only the local time zone of the user.
+        /// </summary>
+        [JsonStringEnumMemberName("local")]
+        Local,
+
+        /// <summary>
+        /// Display a custom list of time zones defined in the configuration.
+        /// </summary>
+        [JsonStringEnumMemberName("custom")]
+        Custom,
+    }
+}

src/Umbraco.Core/PropertyEditors/IDateOnlyPropertyIndexValueFactory.cs

@@ -0,0 +1,6 @@
+namespace Umbraco.Cms.Core.PropertyEditors;
+
+/// <summary>
+/// Factory for creating index values for Date Only properties.
+/// </summary>
+public interface IDateOnlyPropertyIndexValueFactory : IPropertyIndexValueFactory;

src/Umbraco.Core/PropertyEditors/IDateTimeUnspecifiedPropertyIndexValueFactory.cs

@@ -0,0 +1,6 @@
+namespace Umbraco.Cms.Core.PropertyEditors;
+
+/// <summary>
+/// Factory for creating index values for Date Time Unspecified properties.
+/// </summary>
+public interface IDateTimeUnspecifiedPropertyIndexValueFactory : IPropertyIndexValueFactory;

src/Umbraco.Core/PropertyEditors/IDateTimeWithTimeZonePropertyIndexValueFactory.cs

@@ -0,0 +1,6 @@
+namespace Umbraco.Cms.Core.PropertyEditors;
+
+/// <summary>
+/// Factory for creating index values for Date Time with Time Zone properties.
+/// </summary>
+public interface IDateTimeWithTimeZonePropertyIndexValueFactory : IPropertyIndexValueFactory;

src/Umbraco.Core/PropertyEditors/ITimeOnlyPropertyIndexValueFactory.cs

@@ -0,0 +1,6 @@
+namespace Umbraco.Cms.Core.PropertyEditors;
+
+/// <summary>
+/// Factory for creating index values for Time Only properties.
+/// </summary>
+public interface ITimeOnlyPropertyIndexValueFactory : IPropertyIndexValueFactory;

src/Umbraco.Infrastructure/DependencyInjection/UmbracoBuilder.CoreServices.cs

@@ -263,6 +263,10 @@ public static IUmbracoBuilder AddPropertyIndexValueFactories(this IUmbracoBuilde
         builder.Services.AddSingleton<IBlockValuePropertyIndexValueFactory, BlockValuePropertyIndexValueFactory>();
         builder.Services.AddSingleton<ITagPropertyIndexValueFactory, TagPropertyIndexValueFactory>();
         builder.Services.AddSingleton<IRichTextPropertyIndexValueFactory, RichTextPropertyIndexValueFactory>();
+        builder.Services.AddSingleton<IDateOnlyPropertyIndexValueFactory, DateOnlyPropertyIndexValueFactory>();
+        builder.Services.AddSingleton<ITimeOnlyPropertyIndexValueFactory, TimeOnlyPropertyIndexValueFactory>();
+        builder.Services.AddSingleton<IDateTimeUnspecifiedPropertyIndexValueFactory, DateTimeUnspecifiedPropertyIndexValueFactory>();
+        builder.Services.AddSingleton<IDateTimeWithTimeZonePropertyIndexValueFactory, DateTimeWithTimeZonePropertyIndexValueFactory>();
 
         return builder;
     }

src/Umbraco.Infrastructure/Migrations/Install/DatabaseDataCreator.cs

@@ -863,6 +863,25 @@
             },
             Constants.DatabaseSchema.Tables.Node,
             "id");
+        ConditionalInsert(
+            Constants.Configuration.NamedOptions.InstallDefaultData.DataTypes,
+            Constants.DataTypes.Guids.DateTimePickerWithTimeZone,
+            new NodeDto
+            {
+                NodeId = 1055,
+                Trashed = false,
+                ParentId = -1,
+                UserId = -1,
+                Level = 1,
+                Path = "-1,1055",
+                SortOrder = 2,
+                UniqueId = Constants.DataTypes.Guids.DateTimePickerWithTimeZoneGuid,
+                Text = "Date Time Picker (with time zone)",
+                NodeObjectType = Constants.ObjectTypes.DataType,
+                CreateDate = DateTime.UtcNow,
+            },
+            Constants.DatabaseSchema.Tables.Node,
+            "id");
     }
 
     private void CreateNodeDataForMediaTypes()
@@ -2302,6 +2321,22 @@
                                     "\", \"multiple\": true}",
                 });
         }
+
+        if (_database.Exists<NodeDto>(1055))
+        {
+            _database.Insert(
+                Constants.DatabaseSchema.Tables.DataType,
+                "pk",
+                false,
+                new DataTypeDto
+                {
+                    NodeId = 1055,
+                    EditorAlias = Constants.PropertyEditors.Aliases.DateTimeWithTimeZone,
+                    EditorUiAlias = "Umb.PropertyEditorUi.DateTimeWithTimeZonePicker",
+                    DbType = "Ntext",
+                    Configuration = "{\"timeFormat\": \"HH:mm\", \"timeZones\": {\"mode\": \"all\"}}",
+                });
+        }
     }
 
     private void CreateRelationTypeData()

src/Umbraco.Infrastructure/Models/DateTimeEditorValue.cs

@@ -0,0 +1,13 @@
+using System.Runtime.Serialization;
+
+namespace Umbraco.Cms.Infrastructure.Models;
+
+[DataContract]
+public class DateTimeEditorValue
+{
+    [DataMember(Name = "date")]
+    public string? Date { get; set; }
+
+    [DataMember(Name = "timeZone")]
+    public string? TimeZone { get; set; }
+}

src/Umbraco.Infrastructure/PropertyEditors/DateOnlyPropertyEditor.cs

@@ -0,0 +1,36 @@
+// Copyright (c) Umbraco.
+// See LICENSE for more details.
+
+using System.Globalization;
+using Umbraco.Cms.Core.IO;
+using Umbraco.Cms.Core.PropertyEditors.ValueConverters;
+
+namespace Umbraco.Cms.Core.PropertyEditors;
+
+/// <summary>
+/// Represents a property editor for editing date-only values.
+/// </summary>
+/// <remarks>
+/// This is one of four property editors derived from <see cref="DateTimePropertyEditorBase"/> and storing their value as JSON with timezone information.
+/// </remarks>
+[DataEditor(
+    Constants.PropertyEditors.Aliases.DateOnly,
+    ValueType = ValueTypes.Json,
+    ValueEditorIsReusable = true)]
+public sealed class DateOnlyPropertyEditor : DateTimePropertyEditorBase
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DateOnlyPropertyEditor"/> class.
+    /// </summary>
+    public DateOnlyPropertyEditor(
+        IDataValueEditorFactory dataValueEditorFactory,
+        IIOHelper ioHelper,
+        IDateOnlyPropertyIndexValueFactory propertyIndexValueFactory)
+        : base(dataValueEditorFactory, ioHelper, propertyIndexValueFactory)
+    {
+    }
+
+    /// <inheritdoc />
+    protected override string MapDateToEditorFormat(DateTimeValueConverterBase.DateTimeDto dateTimeDto)
+        => dateTimeDto.Date.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture);
+}

src/Umbraco.Infrastructure/PropertyEditors/DateOnlyPropertyIndexValueFactory.cs

@@ -0,0 +1,28 @@
+using Microsoft.Extensions.Logging;
+using Umbraco.Cms.Core.Serialization;
+
+namespace Umbraco.Cms.Core.PropertyEditors;
+
+/// <summary>
+/// Provides a factory for creating property index values for date only datetimes.
+/// </summary>
+/// <remarks>
+/// This is one of four property index value factories derived from <see cref="DateTimePropertyIndexValueFactory"/> and storing their
+/// value as JSON with timezone information.
+/// </remarks>
+internal class DateOnlyPropertyIndexValueFactory : DateTimePropertyIndexValueFactory, IDateOnlyPropertyIndexValueFactory
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DateOnlyPropertyIndexValueFactory"/> class.
+    /// </summary>
+    public DateOnlyPropertyIndexValueFactory(
+        IJsonSerializer jsonSerializer,
+        ILogger<DateOnlyPropertyIndexValueFactory> logger)
+        : base(jsonSerializer, logger)
+    {
+    }
+
+    /// <inheritdoc/>
+    protected override string MapDateToIndexValueFormat(DateTimeOffset date)
+        => date.UtcDateTime.ToString("yyyy-MM-dd");
+}

src/Umbraco.Infrastructure/PropertyEditors/DateTimeConfigurationEditor.cs

@@ -0,0 +1,14 @@
+// Copyright (c) Umbraco.
+// See LICENSE for more details.
+
+using Umbraco.Cms.Core.IO;
+
+namespace Umbraco.Cms.Core.PropertyEditors;
+
+internal class DateTimeConfigurationEditor : ConfigurationEditor<DateTimeConfiguration>
+{
+    public DateTimeConfigurationEditor(IIOHelper ioHelper)
+        : base(ioHelper)
+    {
+    }
+}