Merge pull request #475 from leekelleher/v5/feature/data-picker-api-existing-items

Data Picker: Passes selected items to the `Search` endpoint

Author: leekelleher

src/Umbraco.Community.Contentment/DataEditors/DataPicker/DataPickerApiController.cs

@@ -66,14 +66,21 @@ array1[0] is JObject item1 &&
             return NotFound($"Unable to locate data source for data type: '{dataTypeKey}'");
         }
 
+        [Obsolete("Please call the `Search` endpoint using a POST method.")]
         [HttpGet]
-#pragma warning disable IDE0060 // Remove unused parameter
         public async Task<IActionResult> Search(string id, Guid dataTypeKey, int pageNumber = 1, int pageSize = 12, string query = "")
+            => await Search(id, dataTypeKey, pageNumber, pageSize, query, []);
+
+        [HttpPost]
+#pragma warning disable IDE0060 // Remove unused parameter
+        public async Task<IActionResult> Search(string id, Guid dataTypeKey, int pageNumber = 1, int pageSize = 12, string query = "", [FromBody] string[]? values = null)
 #pragma warning restore IDE0060 // Remove unused parameter
         {
             if (_lookup.TryGetValue(dataTypeKey, out var cached) == true)
             {
-                var results = await cached.Item1.SearchAsync(cached.Item2, pageNumber, pageSize, HttpUtility.UrlDecode(query));
+                var results = cached.Item1 is IDataPickerSource2 source2
+                    ? await source2.SearchAsync(cached.Item2, pageNumber, pageSize, HttpUtility.UrlDecode(query), values ?? [])
+                    : await cached.Item1.SearchAsync(cached.Item2, pageNumber, pageSize, HttpUtility.UrlDecode(query));
 
                 return Ok(results);
             }
@@ -92,7 +99,9 @@ tmp1 is JArray array1 &&
 
                     _ = _lookup.TryAdd(dataTypeKey, (source1, config1));
 
-                    var results = await source1.SearchAsync(config1, pageNumber, pageSize, HttpUtility.UrlDecode(query));
+                    var results = source1 is IDataPickerSource2 source2
+                        ? await source2.SearchAsync(config1, pageNumber, pageSize, HttpUtility.UrlDecode(query), values ?? [])
+                        : await source1.SearchAsync(config1, pageNumber, pageSize, HttpUtility.UrlDecode(query));
 
                     return Ok(results);
                 }

src/Umbraco.Community.Contentment/DataEditors/DataPicker/IDataPickerSource.cs

@@ -1,4 +1,4 @@
-/* Copyright © 2023 Lee Kelleher.
+/* Copyright © 2023 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/. */
@@ -11,6 +11,18 @@ public interface IDataPickerSource : IContentmentEditorItem
     {
         Task<IEnumerable<DataListItem>> GetItemsAsync(Dictionary<string, object> config, IEnumerable<string> values);
 
+        [Obsolete("Use `SearchAsync` with the additional `values` parameter instead. This method will be removed in Contentment 7.0.")]
         Task<PagedResult<DataListItem>> SearchAsync(Dictionary<string, object> config, int pageNumber = 1, int pageSize = 12, string query = "");
     }
+
+    // NOTE: Added as a separate interface, so not to break binary backwards-compatibility. [LK]
+    public interface IDataPickerSource2 : IDataPickerSource
+    {
+        Task<PagedResult<DataListItem>> SearchAsync(
+            Dictionary<string, object> config,
+            int pageNumber = 1,
+            int pageSize = 12,
+            string query = "",
+            IEnumerable<string>? values = null);
+    }
 }

src/Umbraco.Community.Contentment/DataEditors/DataPicker/data-picker.js

@@ -130,6 +130,7 @@ angular.module("umbraco").controller("Umbraco.Community.Contentment.DataEditors.
                     listType: config.displayMode,
                     maxItems: config.maxItems === 0 ? config.maxItems : config.maxItems - $scope.model.value.length,
                     pageSize: config.pageSize,
+                    selectedItems: $scope.model.value,
                 },
                 submit: function (selection) {
 

src/Umbraco.Community.Contentment/DataEditors/DataPicker/data-picker.overlay.js

@@ -21,6 +21,7 @@ angular.module("umbraco").controller("Umbraco.Community.Contentment.Overlays.Dat
             listType: "cards",
             maxItems: 0,
             pageSize: 12,
+            selectedItems: [],
         };
         var config = Object.assign({}, defaultConfig, $scope.model.config);
 
@@ -69,7 +70,7 @@ angular.module("umbraco").controller("Umbraco.Community.Contentment.Overlays.Dat
             vm.loading = true;
 
             umbRequestHelper.resourcePromise(
-                $http.get("backoffice/Contentment/DataPickerApi/Search", {
+                $http.post("backoffice/Contentment/DataPickerApi/Search", config.selectedItems, {
                     params: {
                         id: config.currentPageId,
                         dataTypeKey: vm.searchOptions.dataTypeKey,