Add generic type constraints in PHPDoc for improved type safety

Author: oddvalue

src/Concerns/HasDrafts.php

@@ -16,11 +16,13 @@
 use Oddvalue\LaravelDrafts\Facades\LaravelDrafts;
 
 /**
- * @method static Builder | Model current()
- * @method static Builder | Model withoutCurrent()
- * @method static Builder | Model excludeRevision(int | Model $exclude)
+ * @template TModel of Model
  *
- * @mixin Model
+ * @method static Builder<TModel> | TModel current()
+ * @method static Builder<TModel> | TModel withoutCurrent()
+ * @method static Builder<TModel> | TModel excludeRevision(int | TModel $exclude)
+ *
+ * @mixin TModel
  */
 trait HasDrafts
 {
@@ -472,7 +474,7 @@ public function drafts(): HasMany
     }
 
     /**
-     * @return MorphTo<Model, $this>
+     * @return MorphTo<Model, TModel>
      */
     public function publisher(): MorphTo
     {
@@ -489,7 +491,7 @@ public function publisher(): MorphTo
     */
 
     /**
-     * @param Builder<Model> $query
+     * @param Builder<TModel> $query
      */
     protected function scopeCurrent(Builder $query): void
     {
@@ -498,15 +500,15 @@ protected function scopeCurrent(Builder $query): void
     }
 
     /**
-     * @param Builder<Model> $query
+     * @param Builder<TModel> $query
      */
     protected function scopeWithoutCurrent(Builder $query): void
     {
         $query->where($this->getIsCurrentColumn(), false);
     }
 
     /**
-     * @param Builder<Model> $query
+     * @param Builder<TModel> $query
      */
     protected function scopeExcludeRevision(Builder $query, int | Model $exclude): void
     {
@@ -515,7 +517,7 @@ protected function scopeExcludeRevision(Builder $query, int | Model $exclude): v
 
     /**
      * @deprecated This doesn't actually work, will be removed in next version
-     * @param Builder<Model> $query
+     * @param Builder<TModel> $query
      */
     protected function scopeWithoutSelf(Builder $query): void
     {

src/Scopes/PublishingScope.php

@@ -7,6 +7,9 @@
 use Illuminate\Database\Eloquent\Scope;
 use Oddvalue\LaravelDrafts\Facades\LaravelDrafts;
 
+/**
+ * @template TModel of Model
+ */
 class PublishingScope implements Scope
 {
     /**
@@ -17,7 +20,8 @@ class PublishingScope implements Scope
     protected $extensions = [/*'Publish', 'Unpublish', 'Schedule', */'Published', 'WithDrafts', 'WithoutDrafts', 'OnlyDrafts'];
 
     /**
-     * @param Builder<Model> $builder
+     * @param Builder<TModel> $builder
+     * @param TModel $model
      */
     public function apply(Builder $builder, Model $model): void
     {
@@ -30,7 +34,7 @@ public function apply(Builder $builder, Model $model): void
     }
 
     /**
-     * @param Builder<Model> $builder
+     * @param Builder<TModel> $builder
      */
     public function extend(Builder $builder): void
     {
@@ -65,19 +69,19 @@ public function extend(Builder $builder): void
     //    }
 
     /**
-     * @param Builder<Model> $builder
+     * @param Builder<TModel> $builder
      */
     protected function addPublished(Builder $builder): void
     {
         $builder->macro(
             'published',
-            /** @param Builder<Model> $builder */
+            /** @param Builder<TModel> $builder */
             fn (Builder $builder, $withoutDrafts = true) => $builder->withDrafts(! $withoutDrafts),
         );
     }
 
     /**
-     * @param Builder<Model> $builder
+     * @param Builder<TModel> $builder
      */
     protected function addWithDrafts(Builder $builder): void
     {
@@ -91,7 +95,7 @@ protected function addWithDrafts(Builder $builder): void
     }
 
     /**
-     * @param Builder<Model> $builder
+     * @param Builder<TModel> $builder
      */
     protected function addWithoutDrafts(Builder $builder): void
     {
@@ -107,7 +111,7 @@ protected function addWithoutDrafts(Builder $builder): void
     }
 
     /**
-     * @param Builder<Model> $builder
+     * @param Builder<TModel> $builder
      */
     protected function addOnlyDrafts(Builder $builder): void
     {