Add doc types and align method types across API

Author: stevebauman

src/Engine.php

@@ -10,6 +10,7 @@
 use DirectoryTree\OpenSearchScoutDriver\Factories\DocumentFactoryInterface;
 use DirectoryTree\OpenSearchScoutDriver\Factories\ModelFactoryInterface;
 use DirectoryTree\OpenSearchScoutDriver\Factories\SearchRequestFactoryInterface;
+use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Pagination\Cursor;
@@ -40,6 +41,8 @@ public function __construct(
 
     /**
      * Update the given models in the index.
+     *
+     * @param  Collection  $models
      */
     public function update($models): void
     {
@@ -56,6 +59,8 @@ public function update($models): void
 
     /**
      * Delete the given models from the index.
+     *
+     * @param  Collection  $models
      */
     public function delete($models): void
     {
@@ -82,6 +87,9 @@ public function search(Builder $builder): SearchResponse
 
     /**
      * Perform the given paginated search.
+     *
+     * @param  int  $perPage
+     * @param  int  $page
      */
     public function paginate(Builder $builder, $perPage, $page): SearchResponse
     {
@@ -95,8 +103,12 @@ public function paginate(Builder $builder, $perPage, $page): SearchResponse
 
     /**
      * Cursor paginate the given search using OpenSearch search_after values.
+     *
+     * @param  int|null  $perPage
+     * @param  string  $cursorName
+     * @param  Cursor|null  $cursor
      */
-    public function cursorPaginate(Builder $builder, $perPage = null, string $cursorName = 'cursor', Cursor|string|null $cursor = null): CursorPaginator
+    public function cursorPaginate(Builder $builder, $perPage = null, $cursorName = 'cursor', $cursor = null): CursorPaginator
     {
         $perPage = (int) ($perPage ?: $builder->model->getPerPage());
 
@@ -137,6 +149,9 @@ public function mapIds($results): BaseCollection
 
     /**
      * Map the search results to models.
+     *
+     * @param  SearchResponse  $results
+     * @param  Model  $model
      */
     public function map(Builder $builder, $results, $model): EloquentCollection
     {
@@ -145,6 +160,9 @@ public function map(Builder $builder, $results, $model): EloquentCollection
 
     /**
      * Lazily map the search results to models.
+     *
+     * @param  SearchResponse  $results
+     * @param  Model  $model
      */
     public function lazyMap(Builder $builder, $results, $model): LazyCollection
     {
@@ -153,6 +171,8 @@ public function lazyMap(Builder $builder, $results, $model): LazyCollection
 
     /**
      * Get the total count from the search results.
+     *
+     * @param  SearchResponse  $results
      */
     public function getTotalCount($results): ?int
     {
@@ -177,6 +197,8 @@ protected function searchAfterValuesByDocumentId(SearchResponse $response): arra
 
     /**
      * Remove all model records from the index.
+     *
+     * @param  Model  $model
      */
     public function flush($model): void
     {
@@ -189,6 +211,8 @@ public function flush($model): void
 
     /**
      * Create an index.
+     *
+     * @param  string  $name
      */
     public function createIndex($name, array $options = []): void
     {
@@ -201,6 +225,8 @@ public function createIndex($name, array $options = []): void
 
     /**
      * Delete an index.
+     *
+     * @param  string  $name
      */
     public function deleteIndex($name): void
     {