[5.x] Improved fieldtype search using keywords (#11053)

package.json

@@ -52,7 +52,7 @@
     "codemirror": "^5.58.2",
     "cookies-js": "^1.2.2",
     "floating-vue": "^1.0.0-beta.19",
-    "fuse.js": "^3.4.6",
+    "fuse.js": "^7.0.0",
     "highlight.js": "^11.7.0",
     "imask": "^6.6.0-alpha.0",
     "laravel-echo": "^1.16.0",

resources/js/components/data-list/DataList.vue

@@ -135,7 +135,7 @@ export default {
                 keys: this.searchableColumns,
             });
 
-            return fuse.search(this.searchQuery);
+            return fuse.search(this.searchQuery).map(result => result.item);
         },
 
         sortRows(rows) {

resources/js/components/fields/FieldtypeSelector.vue

@@ -99,7 +99,7 @@ export default {
             if (!this.fieldtypesLoaded) return [];
 
             let options = this.fieldtypes.map(fieldtype => {
-                return {text: fieldtype.title, value: fieldtype.handle, categories: fieldtype.categories, icon: fieldtype.icon};
+                return {text: fieldtype.title, value: fieldtype.handle, categories: fieldtype.categories, keywords: fieldtype.keywords, icon: fieldtype.icon};
             });
 
             if (this.allowDate) options.unshift({text: __('Publish Date'), value: 'date', categories: ['system'], isMeta: true, icon: 'date'});
@@ -131,11 +131,14 @@ export default {
                 const fuse = new Fuse(options, {
                     findAllMatches: true,
                     threshold: 0.1,
-                    minMatchCharLength: 2,
-                    keys: ['text'],
+                    keys: [
+                        {name: 'text', weight: 1},
+                        {name: 'categories', weight: 0.1},
+                        {name: 'keywords', weight: 0.4},
+                    ],
                 });
 
-                options = fuse.search(this.search);
+                options = fuse.search(this.search).map(result => result.item);
             }
 
             return options;

src/Dictionaries/Countries.php

@@ -8,6 +8,7 @@ class Countries extends BasicDictionary
 {
     protected string $valueKey = 'iso3';
     protected array $searchable = ['name', 'iso3'];
+    protected array $keywords = ['countries', 'country'];
     private array $regions;
     private array $subregions;
 

src/Dictionaries/Currencies.php

@@ -5,6 +5,7 @@
 class Currencies extends BasicDictionary
 {
     protected string $valueKey = 'code';
+    protected array $keywords = ['currencies', 'currency', 'money', 'dollar'];
 
     protected function getItemLabel(array $item): string
     {

src/Dictionaries/Dictionary.php

@@ -15,6 +15,7 @@ abstract class Dictionary
 
     protected array $fields = [];
     protected array $config = [];
+    protected array $keywords = [];
 
     abstract public function options(?string $search = null): array;
 
@@ -75,4 +76,9 @@ public function optionItems(?string $search = null): array
             ->map(fn ($label, $value) => new Item($value, $label, $this->get($value)->extra()))
             ->all();
     }
+
+    public function keywords(): array
+    {
+        return $this->keywords;
+    }
 }

src/Dictionaries/File.php

@@ -7,6 +7,8 @@
 
 class File extends BasicDictionary
 {
+    protected array $keywords = ['files', 'file', 'json', 'csv', 'yaml', 'yml'];
+
     protected function fieldItems()
     {
         return [

src/Dictionaries/Timezones.php

@@ -8,6 +8,7 @@
 class Timezones extends BasicDictionary
 {
     protected string $valueKey = 'name';
+    protected array $keywords = ['timezone', 'tz', 'zone', 'time', 'date'];
 
     protected function getItemLabel(array $item): string
     {

src/Fields/Fieldtype.php

@@ -29,6 +29,7 @@ abstract class Fieldtype implements Arrayable
     protected $selectableInForms = false;
     protected $relationship = false;
     protected $categories = [];
+    protected $keywords = [];
     protected $rules = [];
     protected $extraRules = [];
     protected $defaultValue;
@@ -113,6 +114,11 @@ public function categories(): array
         return $this->categories;
     }
 
+    public function keywords(): array
+    {
+        return $this->keywords;
+    }
+
     public function filter()
     {
         return new FieldtypeFilter($this);
@@ -167,6 +173,7 @@ public function toArray(): array
             'validatable' => $this->validatable(),
             'defaultable' => $this->defaultable(),
             'categories' => $this->categories(),
+            'keywords' => $this->keywords(),
             'icon' => $this->icon(),
             'config' => $this->configFields()->toPublishArray(),
         ];

src/Fieldtypes/Assets/Assets.php

@@ -24,6 +24,7 @@
 class Assets extends Fieldtype
 {
     protected $categories = ['media', 'relationship'];
+    protected $keywords = ['file', 'files', 'image', 'images', 'video', 'videos', 'audio', 'upload'];
     protected $selectableInForms = true;
 
     protected function configFieldItems(): array

src/Fieldtypes/Bard.php

@@ -38,6 +38,7 @@ class Bard extends Replicator
     ];
 
     protected $categories = ['text', 'structured'];
+    protected $keywords = ['rich', 'richtext', 'rich text', 'editor', 'wysiwg', 'builder', 'page builder', 'gutenberg', 'content'];
     protected $rules = [];
 
     protected function configFieldItems(): array

src/Fieldtypes/Collections.php

@@ -10,6 +10,7 @@
 class Collections extends Relationship
 {
     protected $categories = ['relationship'];
+    protected $keywords = ['entries'];
     protected $canEdit = false;
     protected $canCreate = false;
     protected $canSearch = false;

src/Fieldtypes/Color.php

@@ -7,6 +7,7 @@
 class Color extends Fieldtype
 {
     protected $categories = ['special'];
+    protected $keywords = ['rgb', 'hex', 'colour'];
 
     protected function configFieldItems(): array
     {

src/Fieldtypes/Date.php

@@ -18,6 +18,7 @@
 class Date extends Fieldtype
 {
     protected $categories = ['special'];
+    protected $keywords = ['datetime', 'time'];
 
     const DEFAULT_DATE_FORMAT = 'Y-m-d';
     const DEFAULT_DATETIME_FORMAT = 'Y-m-d H:i';

src/Fieldtypes/Dictionary.php

@@ -170,4 +170,15 @@ public function addGqlTypes()
     {
         GraphQL::addType($this->dictionary()->getGqlType());
     }
+
+    public function keywords(): array
+    {
+        return \Statamic\Facades\Dictionary::all()
+            ->flatMap(fn ($dictionary) => [
+                str($dictionary->handle())->replace('_', ' ')->toString(),
+                ...$dictionary->keywords(),
+            ])
+            ->merge(['select', 'option', 'choice', 'dropdown', 'list'])
+            ->unique()->values()->all();
+    }
 }

src/Fieldtypes/Entries.php

@@ -32,6 +32,7 @@ class Entries extends Relationship
     use QueriesFilters;
 
     protected $categories = ['relationship'];
+    protected $keywords = ['entry'];
     protected $canEdit = true;
     protected $canCreate = true;
     protected $canSearch = true;

src/Fieldtypes/Markdown.php

@@ -10,6 +10,7 @@
 class Markdown extends Fieldtype
 {
     protected $categories = ['text'];
+    protected $keywords = ['md', 'content', 'html'];
 
     use Concerns\ResolvesStatamicUrls;
 

src/Fieldtypes/Replicator.php

@@ -17,6 +17,7 @@
 class Replicator extends Fieldtype
 {
     protected $categories = ['structured'];
+    protected $keywords = ['builder', 'page builder', 'content'];
     protected $rules = ['array'];
 
     protected function configFieldItems(): array

src/Fieldtypes/Select.php

@@ -9,6 +9,7 @@ class Select extends Fieldtype
     use HasSelectOptions;
 
     protected $categories = ['controls'];
+    protected $keywords = ['select', 'option', 'choice', 'dropdown', 'list'];
     protected $selectableInForms = true;
     protected $indexComponent = 'tags';
 

src/Fieldtypes/Toggle.php

@@ -9,6 +9,7 @@
 class Toggle extends Fieldtype
 {
     protected $categories = ['controls'];
+    protected $keywords = ['checkbox', 'bool', 'boolean'];
     protected $selectableInForms = true;
     protected $defaultValue = false;
 

src/Fieldtypes/Yaml.php

@@ -9,6 +9,7 @@
 class Yaml extends Fieldtype
 {
     protected $categories = ['special'];
+    protected $keywords = ['yml'];
 
     protected function configFieldItems(): array
     {

tests/Fields/FieldtypeTest.php

@@ -157,6 +157,7 @@ public function converts_to_an_array()
             'validatable' => true,
             'defaultable' => true,
             'categories' => [],
+            'keywords' => [],
             'icon' => 'test',
             'config' => [],
         ], $fieldtype->toArray());