V3 Frontend Asset Tweaks (#1371)

* Check for "original" property

* Adjusting order of request validations

* Updates to Asset Injection Methods

* Fix assertViewIs is not working (#67)
Contribs By: Jackson Tong <[email protected]

* Tweaks for Auto Injection Options

* Test Updates - Frontend Assets

* Add ThirdParty Basic Header Tests

* Add Initial Debuggable DTO Test

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to `laravel-livewire-tables` will be documented in this file
 
+## [Unreleased] - 3.x - Updates to Injection Methods
+- Amend AutoInjection/FrontendAsset to ensure it returns the original content correctly
+- Remove errant disabling of Blade Directives when disabling auto-injection
+- Amended in-line config documentation
+
 ## [Unreleased] - 3.x - setSearchFieldAttributes
 - Add setSearchFieldAttributes() and getSearchFieldAttributes()
 

config/livewire-tables.php

@@ -6,26 +6,34 @@
      */
     'theme' => 'tailwind',
 
-    'cache_assets' => true,
     /**
-     * Enable or Disable automatic injection of assets
+     * Filter Frontend Asset Options
      */
-    'inject_assets' => true,
 
     /**
-     * Enable or Disable automatic injection of assets
+     * Cache Rappasoft Frontend Assets
      */
-    'inject_third_party_assets' => false,
+    'cache_assets' => false,
 
     /**
-     * Enable or Disable inclusion of published third-party assets
+     * Enable or Disable automatic injection of core assets
      */
-    'published_third_party_assets' => false,
+    'inject_core_assets_enabled' => true,
 
     /**
-     * Enable or Disable remote third-party assets
+     * Enable or Disable automatic injection of third-party assets
      */
-    'remote_third_party_assets' => true,
+    'inject_third_party_assets_enabled' => true,
+
+    /**
+     * Enable Blade Directives (Not required if automatically injecting or using bundler approaches)
+     */
+    'enable_blade_directives ' => false,
+
+    /**
+     * Filter Default Configuration Options
+     *
+     * */
 
     /**
      * Configuration options for DateFilter

resources/imports/laravel-livewire-tables-thirdparty.js

@@ -0,0 +1,2 @@
+import './css/laravel-livewire-tables-thirdparty.css'
+import './js/laravel-livewire-tables-thirdparty.min.js'

resources/imports/laravel-livewire-tables.js

@@ -0,0 +1,2 @@
+import './css/laravel-livewire-tables.css'
+import './js/laravel-livewire-tables.js'

src/Features/AutoInjectRappasoftAssets.php

@@ -14,52 +14,61 @@ class AutoInjectRappasoftAssets extends ComponentHook
 
     public static bool $forceAssetInjection = false;
 
+    public static bool $shouldInjectRappasoftThirdPartyAssets = false;
+
+    public static bool $shouldInjectRappasoftAssets = false;
+
     public static function provide(): void
     {
+        static::$shouldInjectRappasoftAssets = config('livewire-tables.inject_core_assets_enabled', true);
+        static::$shouldInjectRappasoftThirdPartyAssets = config('livewire-tables.inject_third_party_assets_enabled', true);
+
         on('flush-state', function () {
             static::$hasRenderedAComponentThisRequest = false;
             static::$forceAssetInjection = false;
         });
 
-        if (config('livewire-tables.inject_assets', true) === false) {
-            return;
+        if (static::$shouldInjectRappasoftAssets || static::$shouldInjectRappasoftThirdPartyAssets) {
+
+            app('events')->listen(RequestHandled::class, function (RequestHandled $handled) {
+
+                if (! static::$shouldInjectRappasoftAssets && ! static::$shouldInjectRappasoftThirdPartyAssets) {
+                    return;
+                }
+
+                // If All Scripts Have Been Rendered - Return
+                if (
+                    (
+                        ! static::$shouldInjectRappasoftAssets || app(RappasoftFrontendAssets::class)->hasRenderedRappsoftTableScripts
+                    ) &&
+                    (
+                        ! static::$shouldInjectRappasoftThirdPartyAssets || app(RappasoftFrontendAssets::class)->hasRenderedRappsoftTableThirdPartyScripts
+                    )
+                ) {
+                    return;
+                }
+
+                if (! str($handled->response->headers->get('content-type'))->contains('text/html')) {
+                    return;
+                }
+
+                if (! method_exists($handled->response, 'status') || ! method_exists($handled->response, 'getContent') || ! method_exists($handled->response, 'setContent') || ! method_exists($handled->response, 'getOriginalContent') || ! property_exists($handled->response, 'original')) {
+                    return;
+                }
+
+                if ($handled->response->status() !== 200) {
+                    return;
+                }
+
+                $html = $handled->response->getContent();
+
+                if (str($html)->contains('</html>')) {
+                    $original = $handled->response->getOriginalContent();
+                    $handled->response->setContent(static::injectAssets($html));
+                    $handled->response->original = $original;
+                }
+            });
         }
-
-        app('events')->listen(RequestHandled::class, function ($handled) {
-
-            if (! static::$forceAssetInjection && config('livewire-tables.inject_assets', true) === false) {
-                return;
-            }
-            if (! str($handled->response->headers->get('content-type'))->contains('text/html')) {
-                return;
-            }
-            if (! method_exists($handled->response, 'status') || $handled->response->status() !== 200) {
-                return;
-            }
-
-            if (! method_exists($handled->response, 'getContent') || ! method_exists($handled->response, 'setContent')) {
-                return;
-            }
-
-            if ((! static::$hasRenderedAComponentThisRequest) && (! static::$forceAssetInjection)) {
-                return;
-            }
-            if (config('livewire-tables.inject_assets', true) === false && config('livewire-tables.inject_third_party_assets', true) === false) {
-                return;
-            }
-            if (config('livewire-tables.inject_assets', true) === true && app(RappasoftFrontendAssets::class)->hasRenderedRappsoftTableScripts && config('livewire-tables.inject_third_party_assets', true) === true && app(RappasoftFrontendAssets::class)->hasRenderedRappsoftTableThirdPartyScripts) {
-                return;
-            } elseif (config('livewire-tables.inject_assets', true) === true && app(RappasoftFrontendAssets::class)->hasRenderedRappsoftTableScripts) {
-                return;
-            } elseif (config('livewire-tables.inject_third_party_assets', true) === true && app(RappasoftFrontendAssets::class)->hasRenderedRappsoftTableThirdPartyScripts) {
-                return;
-            }
-            $html = $handled->response->getContent();
-
-            if (str($html)->contains('</html>')) {
-                $handled->response->setContent(static::injectAssets($html));
-            }
-        });
     }
 
     public function dehydrate(): void
@@ -69,25 +78,24 @@ public function dehydrate(): void
 
     public static function injectAssets(mixed $html): string
     {
-        $rappasoftTableStyles = config('livewire-tables.inject_assets', true) ? RappasoftFrontendAssets::tableStyles() : '';
-        $rappasoftTableScripts = config('livewire-tables.inject_assets', true) ? RappasoftFrontendAssets::tableScripts() : '';
-        $rappasoftTableThirdPartyStyles = config('livewire-tables.inject_third_party_assets', true) ? RappasoftFrontendAssets::tableThirdPartyStyles() : '';
-        //$rappasoftTableThirdPartyStyles = '';
-        $rappasoftTableThirdPartyScripts = config('livewire-tables.inject_third_party_assets', true) ? RappasoftFrontendAssets::tableThirdPartyScripts() : '';
-        //$rappasoftTableThirdPartyScripts = '';
 
         $html = str($html);
+        $rappaStyles = ((static::$shouldInjectRappasoftAssets === true) ? RappasoftFrontendAssets::tableStyles() : '').' '.((static::$shouldInjectRappasoftThirdPartyAssets === true) ? RappasoftFrontendAssets::tableThirdPartyStyles() : '');
+        $rappaScripts = ((static::$shouldInjectRappasoftAssets === true) ? RappasoftFrontendAssets::tableScripts() : '').' '.((static::$shouldInjectRappasoftThirdPartyAssets === true) ? RappasoftFrontendAssets::tableThirdPartyScripts() : '');
 
         if ($html->test('/<\s*head(?:\s|\s[^>])*>/i') && $html->test('/<\s*\/\s*body\s*>/i')) {
+            static::$shouldInjectRappasoftAssets = static::$shouldInjectRappasoftThirdPartyAssets = false;
+
             return $html
-                ->replaceMatches('/(<\s*head(?:\s|\s[^>])*>)/i', '$1'.($rappasoftTableStyles.' '.$rappasoftTableThirdPartyStyles))
-                ->replaceMatches('/(<\s*\/\s*head\s*>)/i', ($rappasoftTableScripts.' '.$rappasoftTableThirdPartyScripts).'$1')
+                ->replaceMatches('/(<\s*head(?:\s|\s[^>])*>)/i', '$1'.$rappaStyles)
+                ->replaceMatches('/(<\s*\/\s*head\s*>)/i', $rappaScripts.'$1')
                 ->toString();
         }
+        static::$shouldInjectRappasoftAssets = static::$shouldInjectRappasoftThirdPartyAssets = false;
 
         return $html
-            ->replaceMatches('/(<\s*html(?:\s[^>])*>)/i', '$1'.($rappasoftTableStyles.' '.$rappasoftTableThirdPartyStyles))
-            ->replaceMatches('/(<\s*\/\s*head\s*>)/i', ($rappasoftTableScripts.' '.$rappasoftTableThirdPartyScripts).'$1')
+            ->replaceMatches('/(<\s*html(?:\s[^>])*>)/i', '$1'.$rappaStyles)
+            ->replaceMatches('/(<\s*\/\s*head\s*>)/i', $rappaScripts.'$1')
             ->toString();
     }
 }

src/LaravelLivewireTablesServiceProvider.php

@@ -24,6 +24,14 @@ public function boot(): void
 
         $this->loadViewsFrom(__DIR__.'/../resources/views', 'livewire-tables');
 
+        $this->consoleCommands();
+
+        (new RappasoftFrontendAssets)->boot();
+
+    }
+
+    public function consoleCommands()
+    {
         if ($this->app->runningInConsole()) {
             $this->publishes([
                 __DIR__.'/../resources/lang' => $this->app->langPath('livewire-tables'),
@@ -45,23 +53,17 @@ public function boot(): void
                 MakeCommand::class,
             ]);
         }
-
-        if (config('livewire-tables.inject_assets', true) === true) {
-
-            (new RappasoftFrontendAssets)->boot();
-        }
-
     }
 
     public function register(): void
     {
         $this->mergeConfigFrom(
             __DIR__.'/../config/livewire-tables.php', 'livewire-tables'
         );
-        if (config('livewire-tables.inject_assets', true) === true) {
 
-            (new RappasoftFrontendAssets)->register();
-            ComponentHookRegistry::register(AutoInjectRappasoftAssets::class);
-        }
+        (new RappasoftFrontendAssets)->register();
+
+        ComponentHookRegistry::register(AutoInjectRappasoftAssets::class);
+
     }
 }