DN-33: Added driver bundle to provide driver.js framework

gulpfile.js

@@ -121,7 +121,8 @@ gulp.task("build",
         gulp.parallel(
             "js-transpile",
             "rollup-build",
-            "themes-compile"
+            "themes-compile",
+            "css-compress"
         )
     )
 );

package.json

@@ -30,6 +30,13 @@
         "tsx": "^4.6.0",
         "typescript": "5.2.2",
         "vue": "2.7.15",
-        "vue-template-compiler": "2.7.15"
+        "vue-template-compiler": "2.7.15",
+        "driver.js": "^1.3.1",
+        "webpack": "^5.88.2",
+        "webpack-cli": "^5.1.4",
+        "babel-loader": "^9.1.3",
+        "source-map-loader": "4.0.1",
+        "css-loader": "^6.10.0",
+        "style-loader": "^3.3.4"
     }
 }

pom.xml

@@ -144,6 +144,14 @@
                     <configuration>
                         <nodeVersion>v20.9.0</nodeVersion>
                     </configuration>
+                    <executions>
+                        <execution>
+                            <id>run-webpack</id>
+                            <goals>
+                                <goal>webpack</goal>
+                            </goals>
+                        </execution>
+                    </executions>
                 </plugin>
                 <plugin>
                     <groupId>org.codehaus.mojo</groupId>

src/main/js/apps/sample/app.json

@@ -26,7 +26,8 @@
             "locator-store",
             "toc",
             "sample_helloworld",
-            "dn_intro"
+            "dn_intro",
+            "sample_toc_driver"
         ]
     },
     "bundles": {
@@ -90,6 +91,7 @@
                     {
                         "id": "mapview_tools",
                         "tools": [
+                            "tocTourTool",
                             "locateMeTool",
                             "zoomInTool",
                             "zoomOutTool",

src/main/js/bundles/driver/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) Kamran Ahmed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

src/main/js/bundles/driver/README.md

@@ -0,0 +1,3 @@
+# driver.js
+
+This bundle provides the driver.js framework (MIT Licensed (c), Kamran Ahmed) - https://driverjs.com/

src/main/js/bundles/driver/index.js

@@ -0,0 +1,17 @@
+/*
+ * Copyright (C) 2023 con terra GmbH ([email protected])
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import "driver.js/dist/driver.css";
+export * as driver from "driver.js";

src/main/js/bundles/driver/manifest.json

@@ -0,0 +1,17 @@
+{
+    "name": "driver",
+    "version": "1.3.1",
+    "author": "Kamran Ahmed",
+    "description": "Product tours, highlights, contextual help and more.",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/kamranahmedse/driver.js.git"
+    },
+    "bugs": {
+        "url": "https://github.com/kamranahmedse/driver.js/issues"
+    },
+    "main": "index.js",
+    "i18n": [],
+    "layer": ""
+}

webpack.config.js

@@ -0,0 +1,41 @@
+
+const path = require('path');
+
+module.exports = [
+    {
+        entry: {
+            index: "./src/main/js/bundles/driver/index.js"
+        },
+        mode: 'production',
+        output: {
+            path: path.resolve(__dirname, 'target/webapp/js/bundles/driver'),
+            filename: "index.js",
+            libraryTarget: 'amd'
+        },
+        module: {
+            rules: [
+                {
+                    test: /\.js$/,
+                    include: /node_modules/,
+                    use: {
+                        loader: "babel-loader",
+                        options: {
+                            presets: ["@babel/preset-env"]
+                        }
+                    }
+                },
+                {
+                    test: /.js$/,
+                    use: ["source-map-loader"],
+                    enforce: "pre"
+                },
+                {
+                    test: /\.css$/i,
+                    include: /node_modules/,
+                    use: ["style-loader", "css-loader"]
+                }
+            ]
+        }
+    }
+]
+