algolia/scout-extended

What's Changed

• Upgrade Laravel Scout from v10 to v11 by @MarioAlexandruDan in #365

Full Changelog: v4.0.0...v5.0.0

Changed

• Laravel Scout minimum version raised to ^11.0.0. Scout v11 removes numericFilters in favour of the filters string parameter. Where conditions are now stored using Scout v11's structured ['field', 'operator', 'value'] format and $whereIns property, removing all manual $wheres manipulation.
• filters() return type changed from array to string. Any subclass overriding filters() must be updated to return a boolean expression string (e.g. field > 100 AND (id=1 OR id=2)) instead of an array.
• The engine now uses the filters key instead of numericFilters. Any manual ->with(['filters' => '...']) call will be overwritten by the engine's computed filters. Users combining ->with(['filters' => ...]) alongside where() clauses need to move all filter conditions into where() / whereIn() / whereNotIn() calls instead.

Removed

• Laravel Scout 10.x support dropped. Minimum version raised to ^11.0.0.

What's Changed

• Upgrade algoliasearch-php-client from v3 to v4 by @MarioAlexandruDan in #363

New Contributors

• @MarioAlexandruDan made their first contribution in #363

Full Changelog: v3.2.2...v4.0.0

Changed

• Algolia PHP client upgraded from v3 to v4 (algolia/algoliasearch-client-php: ^4.39.1). The v4 client uses a flat API — there are no more SearchIndex objects. All index operations (saveObjects, deleteObjects, getSettings, setSettings, clearObjects, deleteIndex, searchSingleIndex) now take $indexName as the first argument directly on the client.
• Search callback $algolia argument changed type. In v3, the first argument passed to Model::search() callbacks was a SearchIndex object. In v4, it is the SearchClient directly. Any callback using the index object's methods (e.g. ->search()) must be updated to use the flat client API (e.g. ->searchSingleIndex($indexName, $params)).

Deprecated

• deleteBy is deprecated. The scout.algolia.use_deprecated_delete_by config flag defaults to false. Deletion now uses browseObjects + deleteObjects instead.

Removed

• PHP 8.0 support dropped. Minimum version raised to ^8.1 (required by the v4 Algolia client).
• Laravel 9 support dropped. Minimum Laravel/Illuminate version is now ^10.0.
• Laravel Scout 9.x and 10.0–10.11.5 support dropped. Minimum version raised to ^10.11.6, which introduced Algolia4Engine required by the v4 client.

What's Changed

• Fix AggregatorObserver sync status by @qmeister in #356

New Contributors

• @qmeister made their first contribution in #356

Full Changelog: v3.2.1...v3.2.2

Fixed

• Fix AggregatorObserver sync status (#356)

What's Changed

• fix: check if index exists before force creating by @DevinCodes in #357

Full Changelog: v3.2.0...v3.2.1

Fixed

• Check if index exists before force creating (#357)

What's Changed

• feat: add Laravel 12 support by @DevinCodes in #355

Full Changelog: v3.1.3...v3.2.0

Added

• Laravel 12 support (#355)

chore: bump version to v3.1.3

Fixed

• Fix definition of WhereIn

What's Changed

• Support newer versions of laravel scout by @skylerkatz in #351

New Contributors

• @skylerkatz made their first contribution in #351

Full Changelog: v3.1.1...v3.1.2

Fixed

• Fix support for laravel/scout v10.11.6 and up (#351)

What's Changed

• Fix conflict with Laravel/Scout v10.11.6 and newer by @mariuscucuruz in #348

New Contributors

• @mariuscucuruz made their first contribution in #348

Full Changelog: v3.1.0...v3.1.1

Fixed

• Conflict with laravel/scout v10.11.6 and up (#348)

What's Changed

• Laravel 11.x Compatibility by @laravel-shift in #339

New Contributors

• @laravel-shift made their first contribution in #339

Full Changelog: v3.0.1...v3.1.0

Added

• Laravel 11 support (#339)

What's Changed

• Refactored the DeleteJob to use 'deleteObjects' instead of 'deleteBy' by @simonworkhouse in #334

New Contributors

• @simonworkhouse made their first contribution in #334

Full Changelog: v3.0.0...v3.0.1

Added

• Add configuration option to not use deleteBy (#334)

Added

• Laravel 10 support (#320)

Changed

• Removed final from all classes (#317)

Fixed

• Fix bug where aggregators with models without the Searchable model caused error (#310)

Added

• Implement lazyMap method (#307)

Fixed

• Aggregator collection macros being overwritten by models (#308)

Fixed

• Fixed bug where queued aggregator deletes failed (#287)

Fixed

• Fix potential race condition when reimporting large number of records (#300)

Added

• Add support for Laravel 9 (#296)

Changed

• Updated API key dealer in use for CI (#290)
• ObjectIDEncrypter is no longer final (#297)
• Updated CI images in use (#289)

Fixed

• Prevent aggregators from registering multiple observers when using the same models (#239)
• BC breaking: Fixed bug that always returned zero with paginate()->total() (#281)
  • AlgoliaEngine->mapIDs no longer returns the objectIDs, but the model IDs.

Added

• Add whereOptional helper to send optional filters (#284)

Fixed

• Allow toSearchableArray on traits (#283)

Changed

• Add support for laravel/scout v9.0 (#278)

Changed

• Update the Algolia API client version (#277)

Added

• Prepare support for Laravel Octance (#275)

Fixed

• Register macros and commands during provider boot (#274)

Added

• Add support for custom binding of LocalSettingsRepository using LocalSettingsRepositoryContract (#272)

Fixed

• Set the correct permission for LICENSE.md (#271)

Added

• Documentation on running the test suite locally (#267)

Fixed

• Bug with empty array when using whereIn method (#265)
• Failing test in SearchableFinderTest (#264)

Fixed

• Ignore import errors when scannig for searchables (#262)

Added

• Support for SearchableFinder to find Searchable classes outside of app/ (#175)

Added

• Support for PHP 8 (#256)

Changed

• Migrated from Travis CI to CircleCI (#255)

Chore

• Containerize repo (#252)

Added

• Support for Laravel 6 & 7 for the latest versions (#250)

Added

• Support to Laravel 8 (#248)

Changed

• Drops support for PHP 7.2

Added

• Support to Laravel 7 (#225)

Changed

• Drops PHP 7.1 and Laravel 5.x series (#225)

Added

• Support to _snippetResult in searchable metadata (#207) EngineManager

Added

• Support to laravel/framework:^6.0 (#198)

Fixed

• Empty searchable array got indexed when soft delete meta data is enabled (#193)

Added

• Allow eager loading relationships on aggregated models (#131)

Added

• Support to Lumen (#156)

Fixed

• No longer sets scout metadata on non searchable models (bb1cefb)

Added

• Algolia _highlightResult and _rankingInfo to Scout Metadata (#147)
• Support to Laravel 5.8 (#141)

Fixed

• Issue while making unsearchable multiple models (#143)

Added

• Support to Laravel Scout 7.0 (#137)

Added

• Added configurable settings path (#120)

Added

• Generated settings file docs example (1622cb0)

Added

• Method whereIn on the query builder (#115)

Fixed

• Warns the user to scout:reimport if objectID invalid (3048d74)

Fixed

• Exception when importing with no searchables with scout:import (#109)

Fixed

• Creation of search key using Algolia::searchKey (ba0afdf)

Fixed

• scout:reimport with indexes imported using laravel/scout (9aa9370)

Fixed

• User agent version (21eb42f)

Added

• First stable release

Fixed

• Using null on Model::search method (46c9405)

Fixed

• Missing Eager loading in search method (d98dcce)

Fixed

• AlgoliaEngine::map() returns searchable's collection (09ae017)

Added

• Builder::whereBetween method to Builder (4161a60)

Changed

• Custom splitters must implement Algolia\ScoutExtended\Contracts\SplitterContract.

Fixed

• Queuing aggregators (#77)

Changed

• Builder::where now accepts 3 arguments like Eloquent (d883ce1)

Changed

• Wheres gets mutated before sending it to Algolia (8075476)

Added

• Support to <, <=, =, !=, >=, > operators in Builder::where method (#69)

Changed

• Object gets mutated before sending it to Algolia (#68)

Added

• Algolia::searchKey method (1bbffa9)

Fixed

• No verification of shouldBeSearchable while calling makeAllSearchable in aggregators (62)
• No usage of scout.chunk.searchable while calling makeAllSearchable in aggregators (62)
• No usage of ModelsImported event while calling makeAllSearchable in aggregators (29c56a6)

Removed

• @scout directive (1bbffa9)

Fixed

• Updated order of settings in config.blade.php view (841c002)

Added

• Initial release