SearchEditor: Enhance to configure user-defined condition metadata

Completer.js: Identify and populate `metadata` fields

Author: sukhwinder33445

asset/js/widget/Completer.js

@@ -279,7 +279,8 @@ define(["../notjQuery"], function ($) {
                 input.value = value;
 
                 for (let name in data) {
-                    let dataElement = input.form[input.name + '-' + name];
+                    let dataElement = input.form[input.name + '-' + name]
+                        ?? input.form[input.name + '-metadata-' + name];
                     if (typeof dataElement !== 'undefined') {
                         if (dataElement instanceof RadioNodeList) {
                             dataElement = dataElement[dataElement.length - 1];

src/Control/SearchEditor.php

@@ -55,6 +55,9 @@ class SearchEditor extends Form
     /** @var bool */
     protected $cleared = false;
 
+    /** @var string[] Additional `metadata` fields for the condition */
+    protected array $metadataFields = [];
+
     /**
      * Set the filter query string to populate the form with
      *
@@ -95,6 +98,22 @@ public function setSuggestionUrl(Url $url)
         return $this;
     }
 
+    /**
+     * Set additional `metadata` fields for the condition
+     *
+     * The value of these fields is populated to condition's `metadata`
+     *
+     * @param array $fields
+     *
+     * @return $this
+     */
+    public function setMetadataFields(array $fields): static
+    {
+        $this->metadataFields = $fields;
+
+        return $this;
+    }
+
     /**
      * Get the query string parser being used
      *
@@ -551,6 +570,19 @@ protected function createCondition(Filter\Condition $condition, $identifier)
             }]
         ]);
 
+        $metadataFields = new HtmlDocument();
+        foreach ($this->metadataFields as $fieldNameSuffix) {
+            $name = $identifier . '-column-metadata-' . $fieldNameSuffix;
+            $columnMetaInput = $this->createElement('hidden', $name, [
+                'value' => $condition->metaData()->get($fieldNameSuffix)
+            ]);
+            $this->registerElement($columnMetaInput);
+
+            $condition->metaData()->set($fieldNameSuffix, $this->getValue($name));
+
+            $metadataFields->addHtml($columnMetaInput);
+        }
+
         $operatorInput = $this->createElement('select', $identifier . '-operator', [
             'options'   => [
                 '~'     => '~',
@@ -588,6 +620,7 @@ protected function createCondition(Filter\Condition $condition, $identifier)
             $columnInput,
             $columnFakeInput,
             $columnSearchInput,
+            $metadataFields,
             $operatorInput,
             $valueInput
         );