feat: revamp search (#3893)

* refactor: move gambits to frontend (#3885)
* refactor: move gambits to frontend
* test: GambitManager
* refactor: merge filterer and searcher concepts (#3892)
* chore: drop remaining backend regex gambits
* refactor: merge filterer & searcher concept
* refactor: adapt extenders
* refactor: no longer need to push gambits to `q`
* refactor: filters to gambits
* refactor: drop shred `Query` namespace
* chore: cleanup
* chore: leftover gambit references on the backend (#3894)
* chore: leftover gambit references on the backend
* chore: namespace
* feat: search driver backend extension API (#3902)
* feat: first iteration of search drivers
* feat: indexer API & tweaks
* feat: changes after POC driver
* fix: properly fire custom observables
* chore: remove debugging code
* fix: phpstan
* fix: custom eloquent events
* chore: drop POC usage
* test: indexer extender API
* fix: extension searcher fails without filters
* fix: phpstan
* fix: frontend created gambit
* feat: advanced page and localized driver settings (#3905)
* feat: allow getting total search results and replacing filters (#3906)
* feat: allow accessing total search results
* feat: allow replacing filters
* chore: phpstan

extensions/suspend/extend.php

@@ -10,6 +10,7 @@
 use Flarum\Api\Serializer\BasicUserSerializer;
 use Flarum\Api\Serializer\UserSerializer;
 use Flarum\Extend;
+use Flarum\Search\Database\DatabaseSearchDriver;
 use Flarum\Suspend\Access\UserPolicy;
 use Flarum\Suspend\AddUserSuspendAttributes;
 use Flarum\Suspend\Event\Suspended;
@@ -17,10 +18,9 @@ use Flarum\Suspend\Event\Unsuspended;
 use Flarum\Suspend\Listener;
 use Flarum\Suspend\Notification\UserSuspendedBlueprint;
 use Flarum\Suspend\Notification\UserUnsuspendedBlueprint;
-use Flarum\Suspend\Query\SuspendedFilterGambit;
+use Flarum\Suspend\Query\SuspendedFilter;
 use Flarum\Suspend\RevokeAccessFromSuspendedUsers;
 use Flarum\User\Event\Saving;
-use Flarum\User\Filter\UserFilterer;
 use Flarum\User\Search\UserSearcher;
 use Flarum\User\User;
 
@@ -58,11 +58,8 @@ return [
     (new Extend\User())
         ->permissionGroups(RevokeAccessFromSuspendedUsers::class),
 
-    (new Extend\Filter(UserFilterer::class))
-        ->addFilter(SuspendedFilterGambit::class),
-
-    (new Extend\SimpleFlarumSearch(UserSearcher::class))
-        ->addGambit(SuspendedFilterGambit::class),
+    (new Extend\SearchDriver(DatabaseSearchDriver::class))
+        ->addFilter(UserSearcher::class, SuspendedFilter::class),
 
     (new Extend\View())
         ->namespace('flarum-suspend', __DIR__.'/views'),

extensions/suspend/js/src/admin/extend.ts

@@ -0,0 +1 @@
+export { default as default } from '../common/extend';

extensions/suspend/js/src/admin/index.js

@@ -1,5 +1,7 @@
 import app from 'flarum/admin/app';
 
+export { default as extend } from './extend';
+
 app.initializers.add('flarum-suspend', () => {
   app.extensionData.for('flarum-suspend').registerPermission(
     {

extensions/suspend/js/src/common/extend.ts

@@ -0,0 +1,7 @@
+import Extend from 'flarum/common/extenders';
+import SuspendedGambit from './query/users/SuspendedGambit';
+
+export default [
+  new Extend.Search() //
+    .gambit('users', SuspendedGambit),
+];

extensions/suspend/js/src/common/query/users/SuspendedGambit.ts

@@ -0,0 +1,23 @@
+import IGambit from 'flarum/common/query/IGambit';
+
+export default class SuspendedGambit implements IGambit {
+  pattern(): string {
+    return 'is:suspended';
+  }
+
+  toFilter(_matches: string[], negate: boolean): Record<string, any> {
+    const key = (negate ? '-' : '') + 'suspended';
+
+    return {
+      [key]: true,
+    };
+  }
+
+  filterKey(): string {
+    return 'suspended';
+  }
+
+  fromFilter(value: string, negate: boolean): string {
+    return `${negate ? '-' : ''}is:suspended`;
+  }
+}

extensions/suspend/js/src/forum/extend.ts

@@ -2,10 +2,14 @@ import Extend from 'flarum/common/extenders';
 import User from 'flarum/common/models/User';
 import Model from 'flarum/common/Model';
 
+import commonExtend from '../common/extend';
+
 export default [
+  ...commonExtend,
+
   new Extend.Model(User)
     .attribute<boolean>('canSuspend')
-    .attribute<Date, string | null | undefined>('suspendedUntil', Model.transformDate)
+    .attribute<Date | null | undefined, string | null | undefined>('suspendedUntil', Model.transformDate)
     .attribute<string | null | undefined>('suspendReason')
     .attribute<string | null | undefined>('suspendMessage'),
 ];

extensions/suspend/src/Query/SuspendedFilter.php

@@ -10,52 +10,35 @@
 namespace Flarum\Suspend\Query;
 
 use Carbon\Carbon;
-use Flarum\Filter\FilterInterface;
-use Flarum\Filter\FilterState;
-use Flarum\Search\AbstractRegexGambit;
+use Flarum\Search\Database\DatabaseSearchState;
+use Flarum\Search\Filter\FilterInterface;
 use Flarum\Search\SearchState;
 use Flarum\User\Guest;
 use Flarum\User\UserRepository;
 use Illuminate\Database\Query\Builder;
 
-class SuspendedFilterGambit extends AbstractRegexGambit implements FilterInterface
+/**
+ * @implements FilterInterface<DatabaseSearchState>
+ */
+class SuspendedFilter implements FilterInterface
 {
     public function __construct(
         protected UserRepository $users
     ) {
     }
 
-    protected function getGambitPattern(): string
-    {
-        return 'is:suspended';
-    }
-
-    public function apply(SearchState $search, string $bit): bool
-    {
-        if (! $search->getActor()->can('suspend', new Guest())) {
-            return false;
-        }
-
-        return parent::apply($search, $bit);
-    }
-
-    protected function conditions(SearchState $search, array $matches, bool $negate): void
-    {
-        $this->constrain($search->getQuery(), $negate);
-    }
-
     public function getFilterKey(): string
     {
         return 'suspended';
     }
 
-    public function filter(FilterState $filterState, string|array $filterValue, bool $negate): void
+    public function filter(SearchState $state, string|array $value, bool $negate): void
     {
-        if (! $filterState->getActor()->can('suspend', new Guest())) {
+        if (! $state->getActor()->can('suspend', new Guest())) {
             return;
         }
 
-        $this->constrain($filterState->getQuery(), $negate);
+        $this->constrain($state->getQuery(), $negate);
     }
 
     protected function constrain(Builder $query, bool $negate): void