Merge branch 'develop'

Author: leekelleher

.github/NUGET_README.md

@@ -0,0 +1,6 @@
+## Custom Value Converter for Umbraco
+
+A wrapper property-editor (for [Umbraco](https://github.com/umbraco/Umbraco-CMS/)) that lets you pick a custom/alternative `ValueConverter` for a specified data-type.
+
+For more information, please visit the GitHub repository:
+<https://github.com/leekelleher/umbraco-custom-valueconverter>

.github/README.md

@@ -1,4 +1,22 @@
 ## Custom Value Converter for Umbraco
 
-A wrapper property-editor that lets you pick a custom/alternative `ValueConverter`.
+A wrapper property-editor (for Umbraco) that lets you pick a custom/alternative `ValueConverter` for a specified data-type.
 
+
+### Installation
+
+_**Please note,**_ currently you can only install a package from the [NuGet package repository](https://www.nuget.org/packages/Our.Umbraco.Community.CustomValueConverter).
+
+ dotnet add package Our.Umbraco.Community.CustomValueConverter
+
+
+### License
+
+Copyright © [Lee Kelleher](https://leekelleher.com).
+
+All source code is licensed under the [Mozilla Public License](../LICENSE).
+
+
+#### Logo
+
+The package logo uses the [Replace](https://thenounproject.com/icon/replace-212135/) icon (by [Arthur Shlain](https://thenounproject.com/ArtZ91/)) icon from the [Noun Project](https://thenounproject.com), licensed under [CC BY 3.0 US](https://creativecommons.org/licenses/by/3.0/us/).

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release Package
+
+on:
+ push:
+ tags:
+ - "[0-9]+.[0-9]+.[0-9]+"
+
+jobs:
+ build:
+
+ runs-on: windows-latest
+
+ steps:
+
+ - name: Checkout repository
+ uses: actions/checkout@v3
+
+ - name: Setup .NET
+ uses: actions/setup-dotnet@v2
+ with:
+ dotnet-version: 5.0.x
+ 
+ - name: Build project
+ run: dotnet build src\Umbraco.Community.CustomValueConverter.csproj --configuration Release
+
+ - name: Push to NuGet
+ run: dotnet nuget push **\*.nupkg --api-key ${{secrets.NUGET_API_KEY}} --source https://api.nuget.org/v3/index.json
+
+ - name: Push to GitHub
+ run: dotnet nuget push **\*.nupkg --api-key ${{secrets.LK_GITHUB_PAT}} --source https://nuget.pkg.github.com/leekelleher/index.json

docs/assets/img/logo.png

@@ -3,4 +3,9 @@
  - License, v. 2.0. If a copy of the MPL was not distributed with this
  - file, You can obtain one at https://mozilla.org/MPL/2.0/. -->
 
-<div class="umb-readonlyvalue" ng-bind-html="model.config.notes | safe_html"></div>
+<div class="umb-readonlyvalue">
+ <details class="well well-small">
+ <summary><strong ng-bind="model.config.heading"></strong></summary>
+ <div ng-bind-html="model.config.message | safe_html"></div>
+ </details>
+</div>

docs/assets/img/logo.psd

@@ -0,0 +1,57 @@
+/* Copyright © 2022 Lee Kelleher.
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
+
+using System.Collections.Generic;
+
+#if NET472
+using Umbraco.Core;
+using Umbraco.Core.Deploy;
+using Umbraco.Core.Models;
+using Umbraco.Core.PropertyEditors;
+using Umbraco.Core.Serialization;
+#else
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.PropertyEditors;
+using Umbraco.Extensions;
+using Umbraco.Cms.Core.Models;
+using Umbraco.Cms.Core.Deploy;
+using Umbraco.Cms.Core.Serialization;
+#endif
+
+namespace Umbraco.Community.CustomValueConverter.DataEditor
+{
+ internal sealed class CustomValueConverterConfigurationConnector : IDataTypeConfigurationConnector
+ {
+ public IEnumerable<string> PropertyEditorAliases => new[] { CustomValueConverterDataEditor.DataEditorName };
+
+ private readonly IConfigurationEditorJsonSerializer _configurationEditorJsonSerializer;
+
+ public CustomValueConverterConfigurationConnector(IConfigurationEditorJsonSerializer configurationEditorJsonSerializer)
+ {
+ _configurationEditorJsonSerializer = configurationEditorJsonSerializer;
+ }
+
+ public object FromArtifact(IDataType dataType, string configuration)
+ {
+ var dataTypeConfigurationEditor = dataType.Editor.GetConfigurationEditor();
+ return dataTypeConfigurationEditor.FromDatabase(configuration, _configurationEditorJsonSerializer);
+ }
+
+ public string ToArtifact(IDataType dataType, ICollection<ArtifactDependency> dependencies)
+ {
+ if (dataType.Configuration is Dictionary<string, object> config &&
+ config.TryGetValueAs(CustomValueConverterConfigurationEditor.DataType, out GuidUdi udi) == true)
+ {
+ dependencies.Add(new ArtifactDependency(udi, false, ArtifactDependencyMode.Match));
+ }
+
+#if NET472
+ return ConfigurationEditor.ToDatabase(dataType.Configuration);
+#else
+ return ConfigurationEditor.ToDatabase(dataType.Configuration, _configurationEditorJsonSerializer);
+#endif
+ }
+ }
+}

src/App_Plugins/CustomValueConverter/notes.html

@@ -53,13 +53,11 @@ public CustomValueConverterConfigurationEditor(
  View = ioHelper.ResolveRelativeOrVirtualUrl(NotesViewPath),
  Config = new Dictionary<string, object>
  {
- { "notes", @"<details class=""well well-small"">
-<summary><strong>A note about changing the default value converter.</strong></summary>
-<p>Some of Umbraco's built-in value converters are designed to work explicitly with their associated property editor and data type configuration.</p>
+ { "heading", "A note about changing the default value converter." },
+ { "message", @"<p>Some of Umbraco's built-in value converters are designed to work explicitly with their associated property editor and data type configuration.</p>
 <p>This means they may not be hot-swappable. For example, the <code>MediaPicker</code> and <code>MultiNodeTreePicker</code> value converters will try to detect if the data type is configured for single or multiple use. So if you wanted to change the value converter for a textstring editor, then the target value converter would not be aware of the intended configuration, and potentially cause an error.</p>
 <p>For primitive values, e.g. integer, decimal, string, boolean. These should work as expected.</p>
-<p>If you are using you own custom value converter code, then you don't need to be concerned with this note, you will have full control over the value conversion.</p>
-</details>" },
+<p>If you are using you own custom value converter code, then you don't need to be concerned with this note, you will have full control over the value conversion.</p>" },
  },
  HideLabel = true,
  });

src/DataEditor/CustomValueConverterConfigurationConnector.cs

@@ -12,6 +12,8 @@
  <Company>Package Factory</Company>
  <Authors>Lee Kelleher</Authors>
  <Copyright>2022 © Lee Kelleher</Copyright>
+ <PackageIcon>icon.png</PackageIcon>
+ <PackageReadmeFile>README.md</PackageReadmeFile>
  <PackageLicenseExpression>MPL-2.0</PackageLicenseExpression>
  <PackageProjectUrl>https://github.com/leekelleher/umbraco-custom-valueconverter</PackageProjectUrl>
  <RepositoryUrl>https://github.com/leekelleher/umbraco-custom-valueconverter</RepositoryUrl>
@@ -43,10 +45,9 @@
  <ExcludeFromSingleFile>true</ExcludeFromSingleFile>
  <CopyToPublishDirectory>Always</CopyToPublishDirectory>
  </Content>
- <None Include="build\**\*.*">
- <Pack>True</Pack>
- <PackagePath>buildTransitive</PackagePath>
- </None>
+ <None Include="build\*.targets" Pack="true" PackagePath="buildTransitive" />
+ <None Include="..\docs\assets\img\logo.png" Pack="true" PackagePath="\icon.png" />
+ <None Include="..\.github\NUGET_README.md" Pack="true" PackagePath="\README.md" />
  </ItemGroup>
 
 </Project>