feat: Add sortableAttributes property to index settings

Author: johnnynotsolucky

.github/workflows/create-release.yml

@@ -11,7 +11,7 @@
 		"rss": "https://github.com/fostercommerce/meilisearch-connect/releases.atom"
 	},
 	"require": {
-		"php": ">=8.1",
+		"php": "^8.1",
 		"craftcms/cms": "^4.6.0|^5.0.0",
 		"meilisearch/meilisearch-php": "^1.6.0"
 	},
@@ -36,18 +36,15 @@
 	},
 	"scripts": {
 		"phpstan": "phpstan --memory-limit=1G",
-		"ecs-check": "ecs check --ansi --memory-limit=1G",
-		"ecs-fix": "ecs check --ansi --fix --memory-limit=1G",
-		"rector": "rector process --config rector.php",
-		"rector-dry-run": "rector process --dry-run --config rector.php"
+		"ecs:check": "ecs check --ansi --memory-limit=1G",
+		"ecs:fix": "ecs check --ansi --fix --memory-limit=1G",
+		"rector:fix": "rector process --config rector.php",
+		"rector:dry-run": "rector process --dry-run --config rector.php"
 	},
 	"minimum-stability": "dev",
 	"prefer-stable": true,
 	"config": {
 		"sort-packages": true,
-		"platform": {
-			"php": "8.1"
-		},
 		"allow-plugins": {
 			"yiisoft/yii2-composer": true,
 			"craftcms/plugin-installer": true,

composer.json

@@ -6,24 +6,50 @@
 
 class IndexSettings extends Model
 {
-	public ?string $primaryKey = null;
+	public const DEFAULT_PRIMARY_KEY = 'id';
 
 	/**
+	 * Primary key of the index. If not specified, Meilisearch guesses your primary key from the first document you add to the index.
+	 *
+	 * This plugin defaults the primary key to `id` which matches most Craft elements.
+	 */
+	public ?string $primaryKey = self::DEFAULT_PRIMARY_KEY;
+
+	/**
+	 * Ranking rules are built-in rules that rank search results according to certain criteria. They are applied in the same order in which they appear in the `rankingRules` array.
+	 *
 	 * @var string[]
 	 */
 	public array $ranking = [];
 
 	/**
-	 * @var string[]
+	 * The values associated with attributes in the `searchableAttributes` list are searched for matching query words. The order of the list also determines the attribute ranking order.
+	 *
+	 * By default, the `searchableAttributes` array is equal to all fields in your dataset. This behavior is represented by the value `["*"]`.
+	 *
+	 * @var ?string[]
 	 */
-	public array $searchableAttributes = [];
+	public ?array $searchableAttributes = null;
 
 	/**
+	 * Attributes in the `filterableAttributes` list can be used as filters or facets.
+	 *
 	 * @var string[]
 	 */
 	public array $filterableAttributes = [];
 
 	/**
+	 * Attributes that can be used when sorting search results using the sort search parameter.
+	 *
+	 * @var string[]
+	 */
+	public array $sortableAttributes = [];
+
+	/**
+	 * With Meilisearch, you can create faceted search interfaces. This setting allows you to:
+	 * - Define the maximum number of values returned by the facets search parameter
+	 * - Sort facet values by value count or alphanumeric order
+	 *
 	 * @var array{maxValuesPerFacet?: int, sortFacetValuesBy?: array<non-empty-string, 'count'|'alpha'>}
 	 */
 	public array $faceting = [];

src/models/IndexSettings.php

@@ -5,14 +5,13 @@
 use fostercommerce\meilisearch\models\Index;
 use fostercommerce\meilisearch\models\Settings;
 use fostercommerce\meilisearch\Plugin;
+use Meilisearch\Exceptions\TimeOutException;
 use yii\base\Component;
 
 class Sync extends Component
 {
 	use Meili;
 
-	public const DEFAULT_PRIMARY_KEY = 'id';
-
 	private ?Settings $_settings = null;
 
 	public function init(): void
@@ -23,6 +22,9 @@ public function init(): void
 		$this->_settings = Plugin::getInstance()->settings;
 	}
 
+	/**
+	 * @throws TimeOutException
+	 */
 	public function syncSettings(?string $indexName = null): void
 	{
 		foreach ($this->getIndices($indexName) as $indexHandle => $indexConfig) {
@@ -33,8 +35,12 @@ public function syncSettings(?string $indexName = null): void
 			$indexSettings = $indexConfig->settings;
 
 			$index->updateRankingRules($indexSettings->ranking);
-			$index->updateSearchableAttributes($indexSettings->searchableAttributes);
+			if ($indexSettings->searchableAttributes !== null) {
+				$index->updateSearchableAttributes($indexSettings->searchableAttributes);
+			}
+
 			$index->updateFilterableAttributes($indexSettings->filterableAttributes);
+			$index->updateSortableAttributes($indexSettings->sortableAttributes);
 			$index->updateFaceting($indexSettings->faceting);
 		}
 	}
@@ -44,10 +50,7 @@ public function syncIndices(?string $indexName = null, ?string $identifier = nul
 		foreach ($this->getIndices($indexName) as $indexHandle => $indexConfig) {
 			$index = $this->meiliClient->index($indexHandle);
 			$fetch = $indexConfig->fetch;
-			$index->addDocuments(
-				$fetch($identifier),
-				$indexConfig->settings->primaryKey ?? self::DEFAULT_PRIMARY_KEY
-			);
+			$index->addDocuments($fetch($identifier), $indexConfig->settings->primaryKey);
 		}
 	}
 
@@ -57,10 +60,7 @@ public function refreshIndices(?string $indexName = null): void
 			$index = $this->meiliClient->index($indexHandle);
 			$index->deleteAllDocuments();
 			$fetch = $indexConfig->fetch;
-			$index->addDocuments(
-				$fetch(null),
-				$indexConfig->settings->primaryKey ?? self::DEFAULT_PRIMARY_KEY
-			);
+			$index->addDocuments($fetch(null), $indexConfig->settings->primaryKey);
 		}
 	}