Merge pull request #496 from maartenpaauw/feature/eloquent-generic-typings

feat: add eloquent stored event generic types for collection and query builder

Author: freekmurze

src/StoredEvents/Models/EloquentStoredEvent.php

@@ -69,11 +69,17 @@ public function getMetaDataAttribute(): SchemalessAttributes
         return SchemalessAttributes::createForModel($this, 'meta_data');
     }
 
+    /**
+     * @return EloquentStoredEventQueryBuilder<$this>
+     */
     public function newEloquentBuilder($query): EloquentStoredEventQueryBuilder
     {
         return new EloquentStoredEventQueryBuilder($query);
     }
 
+    /**
+     * @return EloquentStoredEventCollection<$this>
+     */
     public function newCollection(array $models = []): EloquentStoredEventCollection
     {
         return new EloquentStoredEventCollection($models);

src/StoredEvents/Models/EloquentStoredEventCollection.php

@@ -5,6 +5,11 @@
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Support\Collection;
 
+/**
+ * @template TEloquentStoredEvent of EloquentStoredEvent
+ *
+ * @extends EloquentCollection<array-key, TEloquentStoredEvent>
+ */
 class EloquentStoredEventCollection extends EloquentCollection
 {
     /**

src/StoredEvents/Models/EloquentStoredEventQueryBuilder.php

@@ -6,7 +6,11 @@
 use Spatie\EventSourcing\StoredEvents\StoredEvent;
 
 /**
- * @method \Spatie\EventSourcing\StoredEvents\Models\EloquentStoredEventCollection get
+ * @template TEloquentStoredEvent of EloquentStoredEvent
+ *
+ * @method \Spatie\EventSourcing\StoredEvents\Models\EloquentStoredEventCollection<EloquentStoredEvent> get()
+ *
+ * @extends Builder<TEloquentStoredEvent>
  */
 class EloquentStoredEventQueryBuilder extends Builder
 {