feat: support for custom module name (#525)

Author: baptistegrimaud

jahia-test-module/package.json

@@ -34,6 +34,7 @@
     "yarn": ">=4.0.0"
   },
   "jahia": {
+    "name": "JS Modules Engine Test Module",
     "maven": {
       "groupId": "org.jahia.test",
       "distributionManagement": {

javascript-create-module/templates/hello-world/package.json

@@ -48,6 +48,7 @@
     "node": ">=22.0.0"
   },
   "jahia": {
+    "name": "$MODULE",
     "snapshot": true,
     "module-dependencies": "default",
     "module-type": "templatesSet",

javascript-create-module/templates/module/package.json

@@ -42,6 +42,7 @@
     "node": ">=22.0.0"
   },
   "jahia": {
+    "name": "$MODULE",
     "snapshot": true,
     "module-dependencies": "default",
     "module-type": "module",

javascript-create-module/templates/template-set/package.json

@@ -45,6 +45,7 @@
     "node": ">=22.0.0"
   },
   "jahia": {
+    "name": "$MODULE",
     "snapshot": true,
     "module-dependencies": "default",
     "module-type": "templatesSet",

javascript-modules-engine-java/src/main/java/org/jahia/modules/javascript/modules/engine/jshandler/JavascriptProtocolConnection.java

@@ -190,11 +190,10 @@ private Properties generateInstructions(Map<String, Object> properties, Map<Stri
         // First let's setup Bundle headers
         instructions.put("Bundle-Category", jahiaProps.getOrDefault("category", "jahia-javascript-module"));
         setIfPresent(properties, "description", instructions, "Bundle-Description");
-        String name = (String) properties.get("name");
+        String name = StringUtils.defaultString((String) jahiaProps.get("name"), (String) properties.get("name"));
         instructions.put("Bundle-Name", name + " (javascript module)");
-        instructions.put("Bundle-SymbolicName", name.replace("@", "")
-                .replace('/', '-')
-                .replaceAll("[^a-zA-Z0-9\\-\\.\\s]", "_"));
+        instructions.put("Bundle-SymbolicName",
+                ((String) properties.get("name")).replace("@", "").replace('/', '-').replaceAll("[^a-zA-Z0-9\\-\\.\\s]", "_"));
         setIfPresent(properties, "author", instructions, "Bundle-Vendor");
         instructions.put("Bundle-Version", getBundleVersion(properties, jahiaProps));
         instructions.put("Implementation-Version", getImplementationVersion(properties, jahiaProps));

javascript-modules-engine/tests/cypress/e2e/module/moduleTransformationTest.cy.ts

@@ -5,22 +5,28 @@ describe("Check that the Javascript module has been transformed properly and has
     }).then((result) => {
       console.log(result);
       expect(result).to.contain("Bundle-Category: jahia-javascript-module");
-      expect(result).to.contain("Bundle-Description: Test module for Javascript Module Engine");
+      expect(result).to.contain(
+        "Bundle-Description: Test module for Javascript Module Engine"
+      );
       expect(result).to.contain("Jahia-GroupId: org.jahia.test");
       expect(result).to.contain("Bundle-License: MIT");
       expect(result).to.contain(
-        "Bundle-Name: javascript-modules-engine-test-module (javascript module)",
+        "Bundle-Name: JS Modules Engine Test Module (javascript module)"
+      );
+      expect(result).to.contain(
+        "Bundle-SymbolicName: javascript-modules-engine-test-module"
       );
-      expect(result).to.contain("Bundle-SymbolicName: javascript-modules-engine-test-module");
       expect(result).to.contain("Bundle-Vendor: Jahia Solutions Group SA");
       expect(result).to.contain("Bundle-Version: ");
       // TODO to enable once javascript-modules-engine >= 0.4.0 is included in jahia-pack
       // expect(result).to.contain('Jahia-Depends: default,legacy-default-components,javascript-modules-engine')
       expect(result).to.contain("Jahia-Module-Type: templatesSet");
-      expect(result).to.contain("Jahia-javascript-InitScript: dist/server/index.js");
+      expect(result).to.contain(
+        "Jahia-javascript-InitScript: dist/server/index.js"
+      );
       expect(result).to.contain("Jahia-Required-Version: 8.2.0.0-SNAPSHOT");
       expect(result).to.contain(
-        "Jahia-Static-Resources: /css,/javascript,/icons,/dist/client,/static",
+        "Jahia-Static-Resources: /css,/javascript,/icons,/dist/client,/static"
       );
     });
   });