InstantSearch migration (#706)

Author: royduin

composer.json

@@ -17,18 +17,21 @@
     "prefer-stable": true,
     "require": {
         "php": "^8.2",
-        "rapidez/laravel-multi-cache": "^2.0",
         "blade-ui-kit/blade-heroicons": "^2.6",
+        "blade-ui-kit/blade-icons": "^1.8",
+        "http-interop/http-factory-guzzle": "^1.2",
         "illuminate/database": "^11.0|^12.0",
         "illuminate/events": "^11.0|^12.0",
         "illuminate/queue": "^11.0|^12.0",
         "illuminate/support": "^11.0|^12.0",
         "justbetter/laravel-http3earlyhints": "^1.4",
+        "laravel/scout": "^10.14",
         "lcobucci/clock": "^2.0|^3.2",
         "lcobucci/jwt": "^4.0|^5.3",
-        "mailerlite/laravel-elasticsearch": "^11.2",
+        "matchish/laravel-scout-elasticsearch": "^7.11",
         "rapidez/blade-components": "^1.8",
         "rapidez/blade-directives": "^1.1",
+        "rapidez/laravel-multi-cache": "^2.0",
         "tormjens/eventy": "^0.8"
     },
     "require-dev": {
@@ -52,12 +55,16 @@
         }
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "php-http/discovery": true
+        }
     },
     "extra": {
         "laravel": {
             "providers": [
-                "Rapidez\\Core\\RapidezServiceProvider"
+                "Rapidez\\Core\\RapidezServiceProvider",
+                "Matchish\\ScoutElasticSearch\\ElasticSearchServiceProvider"
             ],
             "aliases": {
                 "Rapidez": "Rapidez\\Core\\Facades\\Rapidez"

config/rapidez/frontend.php

@@ -5,7 +5,6 @@
     'exposed' => [
         'store',
         'es_url',
-        'es_prefix',
         'media_url',
         'magento_url',
         'notifications',
@@ -21,38 +20,32 @@
     ],
 
     // The checkout steps which are used to name the steps
-    // in the url and in the progressbar on steps. You can
-    // add different steps for different stores. Keep
+    // in the url and in the progressbar on steps. Keep
     // them lowercase and do not include any spaces.
     'checkout_steps' => [
-        // 'default' => ['onestep'],
-        'default' => ['login', 'credentials', 'payment'],
+        'login', 'credentials', 'payment',
+        // 'onestep',
     ],
 
     'autocomplete' => [
         // Attach additional indexes to the autocomplete
         // Uses the views in rapidez::layouts.partials.header.autocomplete
         'additionals' => [
-            'categories' => ['name^3', 'description'],
+            'history'            => [],
+            'search-suggestions' => [],
+            'categories'         => [],
 
             // For example:
             // 'blogs' => [
-            //     'fields' => ['title^3', 'description'],  // Required
             //     'size' => 3,                             // Optional; Overrides the default `size` as defined below
-            //     'stores' => ['my_second_store'],         // Optional; Define this only if you want to specify which stores use this index
-            //     'sort' => ['date' => 'desc'],            // Optional; See: https://www.elastic.co/guide/en/elasticsearch/reference/7.17/sort-search-results.html)
             // ],
         ],
 
-        'debounce' => 500,
-        'size'     => 3,
+        'size' => 3,
     ],
 
-    // Link store codes to theme folders
     // The structure is `'store_code' => 'folder_path'`
-    'themes' => [
-        'default' => resource_path('themes/default'),
-    ],
+    'theme' => resource_path('themes/default'),
 
     // The fully qualified class names of the widgets.
     'widgets' => [

config/rapidez/indexer.php

@@ -0,0 +1,67 @@
+<?php
+
+// See: https://www.searchkit.co/docs/api-documentation/searchkit#search_settings-configuration
+return [
+    // Attributes that are used to highlight the search results.
+    'highlight_attributes' => [
+        'name',
+        'query_text',
+    ],
+
+    // Additional attributes that are used to search the results.
+    // This will be merged with the searchable
+    // attributes configured in Magento.
+    'search_attributes' => [
+        // ['field' => 'attribute_code', 'weight' => 4.0],
+    ],
+
+    // Attributes that are returned in the search result response.
+    // Don't want to keep track of this? An empty array will
+    // return all attributes, but that's not recommended!
+    'result_attributes' => [
+        'entity_id',
+        'name',
+        'sku',
+        'price',
+        'special_price',
+        'image',
+        'images',
+        'url',
+        'thumbnail',
+        'in_stock',
+        'children',
+        'super_*',
+        'reviews_count',
+        'reviews_score',
+        'parents',
+    ],
+
+    // Extra attributes that should be a range slider. Only supports numeric values.
+    'range_attributes' => [
+        // 'attribute_code'
+    ],
+
+    // Additional attributes that are used to create facets.
+    // From Magento only "Yes/No, Dropdown, Multiple Select and Price" attribute types
+    // can be configured as filter. If you'd like to have a filter for an attribute
+    // with, for example, the type of "Text", you can specify the attribute_code here.
+    'facet_attributes' => [
+        // ['attribute' => 'brand', 'field' => 'brand.keyword', 'type' => 'string'],
+    ],
+
+    // Attributes that are used to create filters.
+    // Required so that SearchKit can keep track of the type and field of each attribute.
+    'filter_attributes' => [
+        ['attribute' => 'entity_id', 'field' => 'entity_id', 'type' => 'numeric'],
+        ['attribute' => 'sku', 'field' => 'sku.keyword', 'type' => 'string'],
+        ['attribute' => 'category_ids', 'field' => 'category_ids', 'type' => 'numeric'],
+        ['attribute' => 'visibility', 'field' => 'visibility', 'type' => 'numeric'],
+    ],
+
+    // Additional sorting options to be added to the product listings
+    // Given directions can only be an array of 'asc' and/or 'desc'
+    // Order shown here will be the order shown in the dropdown (including the order of the given directions!)
+    'sorting' => [
+        'created_at' => ['desc'],
+    ],
+];

config/rapidez/searchkit.php

@@ -7,9 +7,6 @@
     // Elasticsearch url.
     'es_url' => env('ELASTICSEARCH_URL', 'http://localhost:9200'),
 
-    // Elasticsearch prefix.
-    'es_prefix' => env('ELASTICSEARCH_PREFIX', 'rapidez'),
-
     // Get Magento url from Database
     'magento_url_from_db' => env('GET_MAGENTO_URL_FROM_DATABASE', false),
 

config/rapidez/system.php

@@ -28,20 +28,23 @@
         'yes' => 'Yes',
     ],
 
-    'asc'       => 'asc',
-    'desc'      => 'desc',
+    'asc'       => 'ascending',
+    'desc'      => 'descending',
     'relevance' => 'Relevance',
-    'newest'    => 'Newest',
     'all'       => 'All',
 
+    'sorting' => [
+        'created_at' => [
+            'asc'  => 'Oldest',
+            'desc' => 'Newest',
+        ],
+        'name' => [
+            'asc'  => 'Name A-Z',
+            'desc' => 'Name Z-A',
+        ],
+    ],
+
     'search' => [
         'title' => 'Search for',
     ],
-
-    // 'sorting' => [
-    //     'attribute' => [
-    //         'asc' => 'Attribute asc',
-    //         'desc' => 'Attrribute desc',
-    //     ],
-    // ],
 ];

lang/en/frontend.php

@@ -7,14 +7,14 @@
     "Adding": "Aan het toevoegen",
     "Addition": "Toevoeging",
     "All rights reserved.": "Alle rechten voorbehouden.",
-    "Apply coupon code": "Kortingscode toepassen",
     "Apply": "Toepassen",
+    "Apply coupon code": "Kortingscode toepassen",
     "Billing address": "Factuuradres",
     "Cart": "Winkelwagen",
     "Categories": "Categorieën",
     "Category": "Categorie",
-    "Checkout": "Afrekenen",
     "Check the spelling of your search term": "De spelling van je zoekterm te controleren",
+    "Checkout": "Afrekenen",
     "City": "Stad",
     "Close": "Sluiten",
     "Company": "Bedrijf",
@@ -23,17 +23,21 @@
     "Country": "Land",
     "Create an account": "Account aanmaken",
     "Credentials": "Gegevens",
+    "Decrease": "Verlagen",
     "Description": "Beschrijving",
     "Email": "Email",
     "Fax": "Fax",
     "Filters": "Filters",
+    "First": "Eerste",
     "Firstname": "Voornaam",
     "Forgot your password?": "Wachtwoord vergeten?",
     "Go to home": "Naar de homepagina",
     "Have you tried:": "Heb je gedacht aan:",
     "Home": "Homepagina",
     "Housenumber": "Huisnummer",
+    "Increase": "Verhogen",
     "Items per page": "Producten per pagina",
+    "Last": "Laatste",
     "Lastname": "Achternaam",
     "Less options": "Minder opties",
     "Loading": "Aan het laden",
@@ -45,18 +49,19 @@
     "Middlename": "Tussenvoegsel",
     "More options": "Meer opties",
     "My billing and shipping address are the same": "Mijn factuur- en verzendadres zijn hetzelfde",
-    "Please enter a shipping address first": "Voer eerst een verzendadres in",
     "New address": "Nieuw adres",
     "Next": "Volgende",
     "No": "Nee",
     "No results found for :searchterm": "Geen resultaten voor :searchterm",
     "Order placed succesfully": "Bestelling succesvol geplaatst",
     "Orders": "Bestellingen",
+    "Out of stock": "Niet op voorraad",
     "page": "pagina",
     "Password": "Wachtwoord",
-    "Payment method": "Betaalmethode",
     "Payment": "Betalen",
+    "Payment method": "Betaalmethode",
     "Place order": "Bestelling plaatsen",
+    "Please enter a shipping address first": "Voer eerst een verzendadres in",
     "Please log in": "Log hier in",
     "Postcode": "Postcode",
     "Prefix": "Aanhef",
@@ -65,28 +70,28 @@
     "products": "producten",
     "Products": "Producten",
     "Quantity": "Hoeveelheid",
-    "Increase": "Verhogen",
-    "Decrease": "Verlagen",
     "Region": "Regio",
     "Related products": "Gerelateerde producten",
+    "Relevance": "Relevantie",
     "Remove": "Verwijderen",
     "Repeat password": "Wachtwoord herhalen",
     "Reset filters": "Filters resetten",
-    "Search for": "Zoeken naar",
     "Search": "Zoeken",
+    "Search for": "Zoeken naar",
     "Select": "Selecteer",
+    "Shipping": "Verzending",
     "Shipping & billing address": "Verzend- en factuuradres",
     "Shipping address": "Verzendadres",
     "Shipping method": "Verzendmethode",
-    "Shipping": "Verzending",
     "Show cart": "Bekijk winkelwagen",
-    "This product is out of stock, remove it to continue your order.": "Dit product is niet op voorraad, verwijder het om verder te gaan met je bestelling.",
-    "Out of stock": "Niet op voorraad",
     "Show results": "Bekijk resultaten",
     "Sign up for our newsletter to stay up to date.": "Meld je aan voor onze nieuwsbrief om op de hoogte te blijven.",
     "Sorry! No image": "Sorry! Geen afbeelding",
     "Sorry! This product is currently out of stock.": "Sorry! Dit product is momenteel niet op voorraad.",
-    "Sorry! We did not find any products.": "Sorry! We hebben geen producten gevonden.",
+    "No products found.": "Geen producten gevonden.",
+    "There are currently no products in this category.": "Er zijn momenteel geen producten in deze categorie.",
+    "Here are some suggestions:": "Hier zijn enkele suggesties:",
+    "Suggestions": "Suggesties",
     "Specifications": "Specificaties",
     "Street": "Straat",
     "Subscribe": "Inschrijven",
@@ -97,21 +102,33 @@
     "Tax ID": "Btw-id",
     "Telephone": "Telefoonnummer",
     "Thank you for subscribing!": "Bedankt voor het inschrijven!",
+    "This product is out of stock, remove it to continue your order.": "Dit product is niet op voorraad, verwijder het om verder te gaan met je bestelling.",
     "This product will be backordered": "Dit product zal worden nageleverd",
     "This website uses cookies": "Deze website maakt gebruik van cookies",
     "Total": "Totaal",
     "Update": "Update",
     "Use other search terms": "Andere zoektermen te gebruiken",
+    "Previous Searches": "Vorige zoekopdrachten",
     "View all products": "Bekijk alle producten",
-    "What are you looking for?": "Waar ben je naar op zoek?",
     "Want product news and updates?": "Wil je productnieuws en updates?",
     "We care about the protection of your data. Read our": "Wij geven om de bescherming van uw gegevens. Lees onze",
     "We found other products you might like!": "We hebben andere producten gevonden die je misschien leuk vindt!",
     "We will get to work for you right away": "Wij gaan meteen aan de slag",
     "We will send a confirmation of your order to": "Wij zullen een confirmatie sturen naar",
+    "What are you looking for?": "Waar ben je naar op zoek?",
     "Wishlist": "Wensenlijst",
     "Yes": "Ja",
     "You don't have anything in your cart.": "Je hebt geen producten in je winkelwagen.",
     "You have filtered for:": "Je hebt gefilterd op:",
-    "Your order is currently:": "Je bestelling is op dit moment:"
+    "Your order is currently:": "Je bestelling is op dit moment:",
+    "Search within the results": "Zoeken binnen resultaten",
+    "Selected filters": "Geselecteerde filters",
+    "First Page": "Eerste pagina",
+    "Previous Page": "Vorige pagina",
+    "Page": "Pagina",
+    "Next Page": "Volgende pagina",
+    "Last Page": "Laatste pagina",
+    "Clear the search query": "De zoekopdracht wissen",
+    "Sort options": "Sorteer opties",
+    "Searching...": "Zoeken..."
 }

lang/nl.json

@@ -26,21 +26,25 @@
     'asc'       => 'oplopend',
     'desc'      => 'aflopend',
     'relevance' => 'Relevantie',
-    'newest'    => 'Nieuwste',
     'all'       => 'Alles',
+    'price'     => 'Prijs',
 
     'search' => [
         'title' => 'Zoeken naar',
     ],
 
     'sorting' => [
-        'price' => [
-            'asc'  => 'Prijs oplopend',
-            'desc' => 'Prijs aflopend',
+        'created_at' => [
+            'asc'  => 'Oudste',
+            'desc' => 'Nieuwste',
         ],
         'name' => [
             'asc'  => 'Naam A-Z',
             'desc' => 'Naam Z-A',
         ],
     ],
+
+    'search' => [
+        'title' => 'Zoeken naar',
+    ],
 ];