Merge pull request #1551 from algolia/epic/MAGE-721

Epic/mage 721 - sync replica work with release

Author: cammonro

Api/Insights/EventsInterface.php renamed to Api/Insights/EventProcessorInterface.php

@@ -9,7 +9,7 @@
 use Magento\Sales\Model\Order;
 use Magento\Store\Model\StoreManagerInterface;
 
-interface EventsInterface
+interface EventProcessorInterface
 {
     /** @var string */
     public const EVENT_KEY_SUBTYPE = 'eventSubtype';
@@ -37,13 +37,13 @@ interface EventsInterface
     /** @var int */
     public const MAX_EVENTS_PER_REQUEST = 1000;
 
-    public function setInsightsClient(InsightsClient $client): EventsInterface;
+    public function setInsightsClient(InsightsClient $client): EventProcessorInterface;
 
-    public function setAuthenticatedUserToken(string $token): EventsInterface;
+    public function setAuthenticatedUserToken(string $token): EventProcessorInterface;
 
-    public function setAnonymousUserToken(string $token): EventsInterface;
+    public function setAnonymousUserToken(string $token): EventProcessorInterface;
 
-    public function setStoreManager(StoreManagerInterface $storeManager): EventsInterface;
+    public function setStoreManager(StoreManagerInterface $storeManager): EventProcessorInterface;
 
     /**
      * @param string $eventName

Api/Product/ReplicaManagerInterface.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Api\Product;
+
+use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
+use Algolia\AlgoliaSearch\Exceptions\ExceededRetriesException;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Exception\NoSuchEntityException;
+
+interface ReplicaManagerInterface
+{
+    public const SORT_ATTRIBUTE_PRICE = 'price';
+
+    public const SORT_KEY_ATTRIBUTE_NAME = 'attribute';
+    public const SORT_KEY_VIRTUAL_REPLICA = 'virtualReplica';
+    public const MAX_VIRTUAL_REPLICA_LIMIT = 20;
+
+    /**
+     * Configure replicas in Algolia based on the sorting configuration in Magento
+     *
+     * @param int $storeId
+     * @param array<string, mixed> $primaryIndexSettings
+     * @return void
+     *
+     * @throws AlgoliaException
+     * @throws ExceededRetriesException
+     * @throws LocalizedException
+     * @throws NoSuchEntityException
+     */
+    public function syncReplicasToAlgolia(int $storeId, array $primaryIndexSettings): void;
+
+    /**
+     * For standard Magento front end (e.g. Luma) replicas will likely only be needed if InstantSearch is enabled
+     * Headless implementations may wish to override this behavior via plugin
+     * @param int $storeId
+     * @return bool
+     */
+    public function isReplicaSyncEnabled(int $storeId): bool;
+
+    /**
+     * Return the number of virtual replicas permitted per index
+     * @link https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#differences
+     *
+     * @return int
+     */
+    public function getMaxVirtualReplicasPerIndex() : int;
+}