Add Draftable contract

Author: oddvalue

README.md

@@ -92,15 +92,16 @@ return [
 
 #### Add the trait
 
-Add the `HasDrafts` trait to your model
+Add the `HasDrafts` trait and `Draftable` contact to your model
 
 ```php
 <?php
 
 use Illuminate\Database\Eloquent\Model;
 use Oddvalue\LaravelDrafts\Concerns\HasDrafts;
+use Oddvalue\LaravelDrafts\Contacts\Draftable;
 
-class Post extends Model
+class Post extends Model implements Draftable
 {
     use HasDrafts;
 

src/Commands/PublishScheduledDrafts.php

@@ -6,6 +6,7 @@
 use Illuminate\Database\Eloquent\Model;
 use InvalidArgumentException;
 use Oddvalue\LaravelDrafts\Concerns\HasDrafts;
+use Oddvalue\LaravelDrafts\Contacts\Draftable;
 
 class PublishScheduledDrafts extends Command
 {
@@ -27,7 +28,7 @@ public function handle(): int
             ->onlyDrafts()
             ->where($model->getWillPublishAtColumn(), '<', now())
             ->whereNull($model->getPublishedAtColumn())
-            ->each(function (Model $record): void {
+            ->each(function (Draftable $record): void {
                 $record->setLive();
                 $record->save();
             });

src/Concerns/HasDrafts.php

@@ -3,6 +3,7 @@
 namespace Oddvalue\LaravelDrafts\Concerns;
 
 use Carbon\CarbonInterface;
+use Closure;
 use Illuminate\Contracts\Database\Query\Builder;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
@@ -12,12 +13,13 @@
 use Illuminate\Database\Eloquent\Relations\MorphToMany;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Str;
+use Oddvalue\LaravelDrafts\Contacts\Draftable;
 use Oddvalue\LaravelDrafts\Facades\LaravelDrafts;
 
 /**
- * @method void Current(Builder $query)
- * @method void WithoutCurrent(Builder $query)
- * @method void ExcludeRevision(Builder $query, int | Model $exclude)
+ * @method \Illuminate\Database\Eloquent\Builder<Draftable> current()
+ * @method \Illuminate\Database\Eloquent\Builder<Draftable> withoutCurrent()
+ * @method \Illuminate\Database\Eloquent\Builder<Draftable> excludeRevision(int | Model $exclude)
  */
 trait HasDrafts
 {
@@ -43,7 +45,7 @@ public function initializeHasDrafts(): void
 
     public static function bootHasDrafts(): void
     {
-        static::creating(function ($model) {
+        static::creating(function (Draftable | Model $model) {
             $model->{$model->getIsCurrentColumn()} = true;
             $model->setPublisher();
             $model->generateUuid();
@@ -52,26 +54,26 @@ public static function bootHasDrafts(): void
             }
         });
 
-        static::updating(function ($model) {
+        static::updating(function (Draftable | Model $model) {
             $model->newRevision();
         });
 
-        static::publishing(function ($model) {
+        static::publishing(function (Draftable | Model $model) {
             $model->setLive();
         });
 
-        static::deleted(function ($model) {
+        static::deleted(function (Draftable | Model $model) {
             $model->revisions()->delete();
         });
 
         if (method_exists(static::class, 'restored')) {
-            static::restored(function ($model) {
+            static::restored(function (Draftable | Model $model) {
                 $model->revisions()->restore();
             });
         }
 
         if (method_exists(static::class, 'forceDeleted')) {
-            static::forceDeleted(function ($model) {
+            static::forceDeleted(function (Draftable | Model $model) {
                 $model->revisions()->forceDelete();
             });
         }
@@ -262,12 +264,12 @@ public function save(array $options = []): bool
         return parent::save($options);
     }
 
-    public static function savingAsDraft(string|\Closure $callback): void
+    public static function savingAsDraft(string | Closure $callback): void
     {
         static::registerModelEvent('savingAsDraft', $callback);
     }
 
-    public static function savedAsDraft(string|\Closure $callback): void
+    public static function savedAsDraft(string | Closure $callback): void
     {
         static::registerModelEvent('drafted', $callback);
     }

src/Contacts/Draftable.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Oddvalue\LaravelDrafts\Contacts;
+
+use Carbon\CarbonInterface;
+use Closure;
+use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
+use Illuminate\Contracts\Database\Query\Builder;
+
+interface Draftable
+{
+    public function publish(): static;
+
+    public function save(array $options = []): bool;
+
+    public function isPublished(): bool;
+
+    public static function publishing(string|Closure $callback): void;
+
+    public static function published(string|Closure $callback): void;
+
+    public function getPublishedAtColumn(): string;
+
+    public function getQualifiedPublishedAtColumn(): string;
+
+    public function getIsPublishedColumn(): string;
+
+    public function getQualifiedIsPublishedColumn(): string;
+
+    public function shouldCreateRevision(): bool;
+
+    public function generateUuid(): void;
+
+    public function setCurrent(): void;
+
+    public function setLive(): void;
+
+    public function schedulePublishing(CarbonInterface $date): static;
+
+    public function clearScheduledPublishing(): static;
+
+    public function getDraftableRelations(): array;
+
+    public function saveAsDraft(array $options = []): bool;
+
+    public function asDraft(): static;
+
+    public function shouldDraft(): bool;
+
+    public static function savingAsDraft(string|Closure $callback): void;
+
+    public static function savedAsDraft(string|Closure $callback): void;
+
+    public function updateAsDraft(array $attributes = [], array $options = []): bool;
+
+    public static function createDraft(...$attributes): self;
+
+    public function setPublisher(): static;
+
+    public function pruneRevisions(): void;
+
+    public function getPublisherColumns(): array;
+
+    public function getQualifiedPublisherColumns(): array;
+
+    public function getIsCurrentColumn(): string;
+
+    public function getWillPublishAtColumn(): string;
+
+    public function getUuidColumn(): string;
+
+    public function revisions(): HasMany;
+
+    public function drafts();
+
+    public function publisher(): MorphTo;
+
+    public function getDraftAttribute();
+}

src/Facades/LaravelDrafts.php

@@ -2,14 +2,17 @@
 
 namespace Oddvalue\LaravelDrafts\Facades;
 
+use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Facade;
 
 /**
  * @see \Oddvalue\LaravelDrafts\LaravelDrafts
+ * @method Model | Authenticatable getCurrentUser();
  */
 class LaravelDrafts extends Facade
 {
-    protected static function getFacadeAccessor()
+    protected static function getFacadeAccessor(): string
     {
         return 'laravel-drafts';
     }

src/LaravelDrafts.php

@@ -2,11 +2,13 @@
 
 namespace Oddvalue\LaravelDrafts;
 
+use Illuminate\Contracts\Auth\Authenticatable;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Auth;
 
 class LaravelDrafts
 {
-    public function getCurrentUser()
+    public function getCurrentUser(): Model | Authenticatable
     {
         return Auth::guard(config('drafts.auth.guard'))->user();
     }