Package Datastar script

CHANGELOG.md

@@ -1,10 +1,11 @@
 # Release Notes for Spark
 
-## 1.0.0-alpha.2 - Unreleased
+## 1.0.0-alpha.2 - 2024-10-30
 
 ### Changed
 
 - Spark now requires Craft 5.0.0 or later.
+- The Datastar script is now packaged with the plugin, rather than served from a CDN.
 
 ## 1.0.0-alpha.1 - 2024-10-28
 

README.md

@@ -33,7 +33,7 @@ This plugin is licensed for free under the MIT License.
 
 ## Requirements
 
-This plugin requires [Craft CMS](https://craftcms.com/) 5.4.0 or later.
+This plugin requires [Craft CMS](https://craftcms.com/) 5.0.0 or later.
 
 ## Installation
 

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "putyourlightson/craft-spark",
   "description": "A real-time, template-driven hypermedia framework for Craft.",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.2",
   "type": "craft-plugin",
   "license": "proprietary",
   "require": {

src/Spark.php

@@ -9,6 +9,7 @@
 use craft\base\Plugin;
 use nystudio107\autocomplete\events\DefineGeneratorValuesEvent;
 use nystudio107\autocomplete\generators\AutocompleteTwigExtensionGenerator;
+use putyourlightson\spark\assets\DatastarAssetBundle;
 use putyourlightson\spark\models\SettingsModel;
 use putyourlightson\spark\models\StoreModel;
 use putyourlightson\spark\services\ResponseService;
@@ -74,13 +75,11 @@ private function registerScript(): void
             return;
         }
 
-        if (Craft::$app->getRequest()->getIsSiteRequest()) {
-            $url = 'https://cdn.jsdelivr.net/npm/@sudodevnull/datastar@' . self::DATASTAR_VERSION;
-            Craft::$app->getView()->registerJsFile($url, [
-                'type' => 'module',
-                'defer' => true,
-            ]);
-        }
+        $bundle = Craft::$app->getView()->registerAssetBundle(DatastarAssetBundle::class);
+
+        // Register the JS file explicitly so that it will be output when using template caching.
+        $url = Craft::$app->getView()->getAssetManager()->getAssetUrl($bundle, $bundle->js[0]);
+        Craft::$app->getView()->registerJsFile($url, $bundle->jsOptions);
     }
 
     private function registerAutocompleteEvent(): void

src/assets/DatastarAssetBundle.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace putyourlightson\spark\assets;
+
+use craft\web\AssetBundle;
+use putyourlightson\spark\Spark;
+
+class DatastarAssetBundle extends AssetBundle
+{
+    /**
+     * @inheritdoc
+     */
+    public $sourcePath = __DIR__ . '/../resources/lib/datastar/' . Spark::DATASTAR_VERSION;
+
+    /**
+     * @inheritdoc
+     */
+    public $js = [
+        'datastar.js',
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    public $jsOptions = [
+        'type' => 'module',
+        'defer' => true,
+    ];
+}