Merge pull request #103 from pboivin/feat/internal-preview-url-config

[2.x] feat: Update internalPreviewUrl config entry and route
pboivin · Oct 10, 2023 · 9c9fd79 · 9c9fd79
2 parents fae5e3a + 2be130e
commit 9c9fd79
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 16 deletions.
diff --git a/config/filament-peek.php b/config/filament-peek.php
@@ -83,17 +83,19 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Use Internal Preview URL
+    | Internal Preview URL
     |--------------------------------------------------------------------------
     |
-    | Set this to `true` to render all Blade previews through an internal URL.
+    | Enable this option to render all Blade previews through an internal URL.
     | This improves the isolation of the iframe in the context of the page.
+    | Add additional middleware for this URL in the `middleware` array.
     |
     */
 
-    'useInternalPreviewUrl' => false,
-
-    'internalPreviewUrlMiddleWare' => [],
+    'internalPreviewUrl' => [
+        'enabled' => false,
+        'middleware' => [],
+    ],
 
     /*
     |--------------------------------------------------------------------------

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -21,7 +21,7 @@ Here are the main options you can configure:
 | `allowIframeOverflow` | `bool` | Allow the iframe dimensions to go beyond the capacity of the available preview modal area. |
 | `allowIframePointerEvents` | `bool` | Allow all pointer events within the iframe. By default, only scrolling is allowed. (Does not apply when using a preview URL. See [Pointer Events](./page-previews.md#preview-pointer-events)) |
 | `closeModalWithEscapeKey` | `bool` | Close the preview modal by pressing the Escape key. (Does not apply to Builder previews.) |
-| `useInternalPreviewUrl` | `bool` | Render Blade previews through an internal URL. |
+| `internalPreviewUrl` | `array` | Render Blade previews through an internal URL. |
 | `builderEditor` | `array` | Options related to the Editor sidebar in [Builder Previews](./builder-previews.md). |
 
 Builder Editor options:

diff --git a/routes/web.php → routes/preview.php b/routes/web.php → routes/preview.php
@@ -4,9 +4,9 @@
 use Illuminate\Support\Facades\Route;
 use Pboivin\FilamentPeek\CachedPreview;
 
-if (config('filament-peek.useInternalPreviewUrl', false)) {
+if (config('filament-peek.internalPreviewUrl.enabled', false)) {
     Route::prefix('filament-peek')
-        ->middleware(config('filament-peek.internalPreviewUrlMiddleWare', []))
+        ->middleware(config('filament-peek.internalPreviewUrl.middleware', []))
         ->group(function () {
             Route::get('preview', function () {
                 abort_unless($token = Request::query('token'), 404);

diff --git a/src/FilamentPeekServiceProvider.php b/src/FilamentPeekServiceProvider.php
@@ -13,6 +13,6 @@ public function configurePackage(Package $package): void
             ->hasTranslations()
             ->hasConfigFile()
             ->hasViews()
-            ->hasRoute('web');
+            ->hasRoute('preview');
     }
 }
diff --git a/src/Livewire/BuilderEditor.php b/src/Livewire/BuilderEditor.php
@@ -255,10 +255,7 @@ protected function getPreviewModalHtmlContent(): ?string
 
     protected function shouldUseInternalPreviewUrl()
     {
-        if (! is_null($config = config('filament-peek.builderEditor.useInternalPreviewUrl'))) {
-            return $config;
-        }
-
-        return config('filament-peek.useInternalPreviewUrl', false);
+        return config('filament-peek.builderEditor.useInternalPreviewUrl', true)
+            && config('filament-peek.internalPreviewUrl.enabled', false);
     }
 }
diff --git a/src/Pages/Concerns/HasPreviewModal.php b/src/Pages/Concerns/HasPreviewModal.php
@@ -88,7 +88,7 @@ public function openPreviewModal(): void
             if ($previewModalUrl = $this->getPreviewModalUrl()) {
                 // pass
             } elseif ($view = $this->getPreviewModalView()) {
-                if (config('filament-peek.useInternalPreviewUrl', false)) {
+                if (config('filament-peek.internalPreviewUrl.enabled', false)) {
                     $token = app(Support\Cache::class)->createPreviewToken();
 
                     CachedPreview::make(static::class, $view, $this->previewModalData)->put($token);

diff --git a/tests/src/TestCaseWithPreviewUrl.php b/tests/src/TestCaseWithPreviewUrl.php
@@ -8,7 +8,7 @@ class TestCaseWithPreviewUrl extends TestCase
 {
     protected function configurePackageProviders($app)
     {
-        Config::set('filament-peek.useInternalPreviewUrl', true);
+        Config::set('filament-peek.internalPreviewUrl.enabled', true);
 
         TestPanelProvider::$should_load_plugin_assets = false;
     }