Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,29 @@ public function boot(): void
}
```

### `LibraryFileRestored`

[`Tapp\FilamentLibrary\Events\LibraryFileRestored`](src/Events/LibraryFileRestored.php) is fired after a soft-deleted `LibraryItem` of type `file` is restored (for example via Filament's Restore action).

The event exposes:

- `$libraryItem` — the restored [`LibraryItem`](src/Models/LibraryItem.php)
- `$media` — the item's first [`Media`](https://github.com/spatie/laravel-medialibrary) record, or `null` if none is attached

Example listener registration in `AppServiceProvider`:

```php
use Illuminate\Support\Facades\Event;
use Tapp\FilamentLibrary\Events\LibraryFileRestored;

public function boot(): void
{
Event::listen(LibraryFileRestored::class, function (LibraryFileRestored $event): void {
// e.g. re-index or re-ingest RAG chunks here
});
}
```

## Testing

```bash
Expand Down
23 changes: 23 additions & 0 deletions src/Events/LibraryFileRestored.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

namespace Tapp\FilamentLibrary\Events;

use Illuminate\Foundation\Events\Dispatchable;
use Illuminate\Queue\SerializesModels;
use Spatie\MediaLibrary\MediaCollections\Models\Media;
use Tapp\FilamentLibrary\Models\LibraryItem;

/**
* Fired after a soft-deleted {@see LibraryItem} of type "file" was restored.
* Host applications may listen to run search indexing, RAG re-ingestion, etc.
*/
class LibraryFileRestored
{
use Dispatchable;
use SerializesModels;

public function __construct(
public LibraryItem $libraryItem,
public ?Media $media = null
) {}
}
26 changes: 26 additions & 0 deletions src/FilamentLibraryServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@
use Filament\Support\Facades\FilamentAsset;
use Filament\Support\Facades\FilamentIcon;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Schema;
use Spatie\LaravelPackageTools\Commands\InstallCommand;
use Spatie\LaravelPackageTools\Package;
use Spatie\LaravelPackageTools\PackageServiceProvider;
use Spatie\MediaLibrary\MediaCollections\Models\Media;
use Tapp\FilamentLibrary\Commands\FilamentLibraryCommand;
use Tapp\FilamentLibrary\Commands\SeedLibraryCommand;
use Tapp\FilamentLibrary\Events\LibraryFileRestored;
use Tapp\FilamentLibrary\Events\LibraryFileStored;
use Tapp\FilamentLibrary\Middleware\RedirectToCorrectEditPage;
use Tapp\FilamentLibrary\Models\LibraryItem;
Expand Down Expand Up @@ -99,6 +101,7 @@ public function packageBooted(): void
$this->loadViewsFrom(__DIR__ . '/Resources/views', static::$viewNamespace);

$this->registerLibraryFileStoredEvent();
$this->registerLibraryFileRestoredEvent();

// Publish views manually (optional)
$this->publishes([
Expand Down Expand Up @@ -200,6 +203,29 @@ protected function registerLibraryFileStoredEvent(): void
});
}

/**
* When a soft-deleted library file is restored, notify host apps (e.g. for RAG re-ingestion).
*/
protected function registerLibraryFileRestoredEvent(): void
{
$libraryItemModel = FilamentLibraryPlugin::libraryItemModelClass();

$libraryItemModel::restored(function (LibraryItem $item): void {
if ($item->type !== 'file') {
return;
}

$media = null;

if (class_exists(Media::class) && Schema::hasTable('media')) {
$firstMedia = $item->getFirstMedia();
$media = $firstMedia instanceof Media ? $firstMedia : null;
}

event(new LibraryFileRestored($item, $media));
});
}

/**
* @return array<string>
*/
Expand Down
43 changes: 43 additions & 0 deletions tests/Unit/LibraryFileRestoredEventTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<?php

use Illuminate\Support\Facades\Event;
use Tapp\FilamentLibrary\Events\LibraryFileRestored;
use Tapp\FilamentLibrary\Models\LibraryItem;

test('LibraryFileRestored is dispatched when a library file is restored', function (): void {
Event::fake([LibraryFileRestored::class]);

$item = LibraryItem::query()->create([
'name' => 'Restored brief.pdf',
'slug' => 'restored-brief-' . uniqid('', true),
'type' => 'file',
'created_by' => 1,
'updated_by' => 1,
'general_access' => 'private',
]);

$item->delete();
$item->restore();

Event::assertDispatched(LibraryFileRestored::class, function (LibraryFileRestored $event) use ($item): bool {
return $event->libraryItem->is($item);
});
});

test('LibraryFileRestored is not dispatched when a folder is restored', function (): void {
Event::fake([LibraryFileRestored::class]);

$item = LibraryItem::query()->create([
'name' => 'Restored folder',
'slug' => 'restored-folder-' . uniqid('', true),
'type' => 'folder',
'created_by' => 1,
'updated_by' => 1,
'general_access' => 'private',
]);

$item->delete();
$item->restore();

Event::assertNotDispatched(LibraryFileRestored::class);
});