Merge pull request #18 from Lombiq/issue/OSOE-856

OSOE-856: Update Shepherd to >=12.0.2 in Lombiq.Walkthroughs
Lombiq · Jun 16, 2024 · 9f9f612 · 9f9f612
2 parents f5751d1 + aefd705
commit 9f9f612
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 120 deletions.
diff --git a/Lombiq.Walkthroughs/Assets/Scripts/shepherd-to-window.js b/Lombiq.Walkthroughs/Assets/Scripts/shepherd-to-window.js
@@ -0,0 +1,4 @@
+/* eslint-disable */
+import Shepherd from '/Lombiq.Walkthroughs/shepherd.js/js/shepherd.mjs';
+
+window.Shepherd = Shepherd;
diff --git a/Lombiq.Walkthroughs/Constants/ResourceNames.cs b/Lombiq.Walkthroughs/Constants/ResourceNames.cs
@@ -6,4 +6,5 @@ public static class ResourceNames
 
     public const string Shepherd = Prefix + "shepherd.js";
     public const string Walkthroughs = nameof(Walkthroughs);
+    public const string ShepherdToWindow = "shepherd-to-window.js";
 }
diff --git a/Lombiq.Walkthroughs/ResourceManagementOptionsConfiguration.cs b/Lombiq.Walkthroughs/ResourceManagementOptionsConfiguration.cs
@@ -22,9 +22,17 @@ static ResourceManagementOptionsConfiguration()
 
         _manifest
             .DefineScript(Shepherd)
+            .SetAttribute("type", "module")
             .SetUrl(
-                "~/" + FeatureIds.Area + "/shepherd.js/js/shepherd.min.js",
-                "~/" + FeatureIds.Area + "/shepherd.js/js/shepherd.js");
+                "~/" + FeatureIds.Area + "/shepherd.js/js/shepherd.mjs");
+
+        _manifest
+            .DefineScript(ShepherdToWindow)
+            .SetAttribute("type", "module")
+            .SetUrl(
+                "~/" + FeatureIds.Area + "/js/shepherd-to-window.min.js",
+                "~/" + FeatureIds.Area + "/js/shepherd-to-window.js"
+            );
 
         _manifest
             .DefineScript(ResourceNames.Walkthroughs)

diff --git a/Lombiq.Walkthroughs/Services/ResourceFilters.cs b/Lombiq.Walkthroughs/Services/ResourceFilters.cs
@@ -10,5 +10,6 @@ public void AddResourceFilter(ResourceFilterBuilder builder)
         builder.Always().RegisterStylesheet(Shepherd);
         builder.Always().RegisterFootScript(Shepherd);
         builder.Always().RegisterFootScript(Constants.ResourceNames.Walkthroughs);
+        builder.Always().RegisterFootScript(ShepherdToWindow);
     }
 }
diff --git a/Lombiq.Walkthroughs/Views/WalkthroughsButton.cshtml b/Lombiq.Walkthroughs/Views/WalkthroughsButton.cshtml
@@ -1,5 +1,5 @@
 <div class="text-center">
-    <button id="walkthrough-selector-button" class="shepherd-button shepherd-button-primary">
+    <button id="walkthrough-selector-button" class="shepherd-button shepherd-button-primary" type="button">
         @T["Click here to select a walkthrough!"]
     </button>
 </div>
diff --git a/Lombiq.Walkthroughs/package-lock.json b/Lombiq.Walkthroughs/package-lock.json
diff --git a/Lombiq.Walkthroughs/package.json b/Lombiq.Walkthroughs/package.json
@@ -1,7 +1,7 @@
 {
   "private": true,
   "dependencies": {
-    "shepherd.js": "^11.2.0"
+    "shepherd.js": "12.0.6"
   },
   "scripts": {
     "build": "npm explore nodejs-extensions -- pnpm build",
@@ -19,7 +19,7 @@
       },
       {
         "sources": [
-          "node_modules/shepherd.js/dist/js"
+          "node_modules/shepherd.js/dist/esm"
         ],
         "pattern": "*",
         "target": "wwwroot/shepherd.js/js"

diff --git a/Lombiq.Walkthroughs/pnpm-lock.yaml b/Lombiq.Walkthroughs/pnpm-lock.yaml