Optionally use minified JS files for dynamic maps

doublesecretagency · Oct 18, 2023 · 8c338d7 · 8c338d7
1 parent b3a2112
commit 8c338d7
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ### Added
 - Address fields can now be added to the search index.
+- Optionally use minified JavaScript files for dynamic maps on the front-end.
 
 ## 1.1.0 - 2023-10-09
 

diff --git a/docs/getting-started/config.md b/docs/getting-started/config.md
@@ -22,8 +22,9 @@ return [
     // Mapbox Access Token (required)
     'accessToken' => getenv('MAPBOX_ACCESSTOKEN'),
 
-    // Whether to log JS progress to the console (when a map is rendered)
+    // Manage JS resources (when rendering a dynamic map on the front-end)
     'enableJsLogging' => true,
+    'minifyJsFiles' => false,
 
     // Additional optional parameters for configuring Address fields
     'fieldParams' => [
@@ -56,6 +57,17 @@ Whether to [log dynamic map progress](/dynamic-maps/troubleshooting/) to the Jav
 'enableJsLogging' => false
 ```
 
+### `minifyJsFiles`
+
+_bool_ - Defaults to `false`.
+
+Whether to use minified JavaScript files when rendering a dynamic map on the front-end.
+
+```php
+// Use minified JS files to render a map on the front-end
+'minifyJsFiles' => true
+```
+
 ### `fieldParams`
 
 _array_ - Defaults to the following array:

diff --git a/docs/models/settings-model.md b/docs/models/settings-model.md
@@ -23,3 +23,18 @@ _string_ - (Required) Your unique [Mapbox Access Token](/getting-started/access-
 ### `enableJsLogging`
 
 _bool_ - Whether to allow logging to the JavaScript console. Only relevant when displaying a dynamic map. Defaults to `true`.
+
+### `minifyJsFiles`
+
+_bool_ - Whether to use minified front-end JavaScript files. Only relevant when rendering a dynamic map. Defaults to `false`.
+
+### `fieldParams`
+
+_array_ - Additional optional parameters for configuring Address fields.
+
+---
+---
+
+:::warning Additional Details
+For more detailed information, check out the docs regarding the [PHP Config File...](/getting-started/config/)
+:::
diff --git a/src/config.php b/src/config.php
@@ -19,8 +19,9 @@
     // Mapbox Access Token (required)
     //'accessToken' => getenv('MAPBOX_ACCESSTOKEN'),
 
-    // Whether to log JS progress to the console (when a map is rendered)
+    // Manage JS resources (when rendering a dynamic map on the front-end)
     //'enableJsLogging' => true,
+    //'minifyJsFiles' => false,
 
     // Additional optional parameters for configuring Address fields
     //'fieldParams' => [

diff --git a/src/helpers/Mapbox.php b/src/helpers/Mapbox.php
@@ -14,6 +14,7 @@
 use Craft;
 use craft\base\Element;
 use craft\web\View;
+use doublesecretagency\mapbox\MapboxPlugin;
 use doublesecretagency\mapbox\models\DynamicMap;
 use doublesecretagency\mapbox\models\Location;
 use yii\base\Exception;
@@ -49,12 +50,18 @@ public static function getAssets(string $service, array $params = []): array
         $manager = Craft::$app->getAssetManager();
         $assets = '@doublesecretagency/mapbox/resources';
 
+        // Whether to use minified JavaScript files
+        $minifyJsFiles = (MapboxPlugin::$plugin->getSettings()->minifyJsFiles ?? false);
+
+        // Optionally use minified files
+        $min = ($minifyJsFiles ? 'min.' : '');
+
         // Link to API URL
         $files = [self::getApiUrl($service, $params)];
 
         // Append both JS files required by plugin
-        $files[] = $manager->getPublishedUrl($assets, true, 'js/mapbox.js');
-        $files[] = $manager->getPublishedUrl($assets, true, 'js/dynamicmap.js');
+        $files[] = $manager->getPublishedUrl($assets, true, "js/mapbox.{$min}js");
+        $files[] = $manager->getPublishedUrl($assets, true, "js/dynamicmap.{$min}js");
 
         // Return list of files
         return $files;

diff --git a/src/models/Settings.php b/src/models/Settings.php
@@ -30,6 +30,11 @@ class Settings extends Model
      */
     public bool $enableJsLogging = true;
 
+    /**
+     * @var bool Whether to use minified front-end JavaScript files. Only relevant when rendering a dynamic map.
+     */
+    public bool $minifyJsFiles = false;
+
     /**
      * @var array Additional optional parameters for configuring Address fields.
      */

diff --git a/src/resources/js/dynamicmap.min.js b/src/resources/js/dynamicmap.min.js
diff --git a/src/resources/js/mapbox.min.js b/src/resources/js/mapbox.min.js
diff --git a/src/web/assets/JsApiAsset.php b/src/web/assets/JsApiAsset.php
@@ -12,6 +12,7 @@
 namespace doublesecretagency\mapbox\web\assets;
 
 use craft\web\AssetBundle;
+use doublesecretagency\mapbox\MapboxPlugin;
 
 /**
  * Class JsApiAsset
@@ -32,9 +33,16 @@ public function init(): void
             MapboxAsset::class,
         ];
 
+        // Whether to use minified JavaScript files
+        $minifyJsFiles = (MapboxPlugin::$plugin->getSettings()->minifyJsFiles ?? false);
+
+        // Optionally use minified files
+        $min = ($minifyJsFiles ? 'min.' : '');
+
+        // Load JS files
         $this->js = [
-            'js/mapbox.js',
-            'js/dynamicmap.js',
+            "js/mapbox.{$min}js",
+            "js/dynamicmap.{$min}js",
         ];
     }