This module is part of the Apache Sling project.
A Node JS (like) module loader for Apache Sling.
This module is considered experimental for now.
This module implements a Nashorn Apache Sling Script Engine for the “esx” extension.
It requires a function named render
in the esx
script that processes the request.
The org.apache.sling.fragment.nashorn
bundle must be installed before this bundle, to export the jdk.nashorn.api.scripting
package.
Currently this implementation requires java version “1.8.0_92” or higher
Once this bundle is active you can try the engine with this minimal (and not very interesting) example:
First create a node with some content:
curl -u admin:admin \ -F"sling:resourceType=foo" \ -Ftitle="Hello ESX" \ -Ftext="Here's some example text" \ http://localhost:8080/apps/foo
Then create an ESX script to render it:
$ cat << EOF > /tmp/foo.esx var foo = { render: function () { var output = \`<h1>\${currentNode.properties.title}</h1>\`; output += currentNode.properties.text; return output; } } module.exports = foo; EOF $ curl -u admin:admin -T /tmp/foo.esx http://localhost:8080/apps/foo/foo.esx $ curl http://localhost:8080/apps/foo.html <h1>Hello ESX</h1>Here's some example text
An ESX file is a regular java script file.
The NodeJS module resolution (https://nodejs.org/api/modules.html) is implemented to give access to the rich collection of Node modules.
There's currently no priority handling of global modules.
The engine searches for scripts in the following order, if the regular module resolution does not find a module: - /apps/esx/node_modules - /apps/esx/esx_modules - /libs/esx/node_modules - /libs/esx/esx_modules
Additionally, ESX will try to resolve the folder esx_modules prior to node_modules.
Require Extensions are deprecated (see https://nodejs.org/api/globals.html#globals_require_extensions), therefore we have not implemented/used the extension loaders api and .bin extension cannot be used.
We have borrowed the requirejs loader plugin syntax instead (see http://requirejs.org/docs/api.html#text). Additionally to the standard JS loader following two loaders are existing:
text (e.g. require("text!./templates/header.html"))
)
resource (e.g. require("resource!./content/blogposts)
) following will be exposed:
json loader (e.g. require("./dict/en.json
)
Currently the demo application is bundles with the engine bundle.
open http://localhost:8080/libs/esx/demo/content/demo.html
You can actually follow the NODE JS description on https://nodejs.org/api/modules.html for more detailed explanation.
A module has access to following variables:
Path: /apps/demo/components/test/helper/calculator/index.js
function calculate(a, b) { return a + b; } exports.math = calculate;
Path: /apps/demo/components/test/test.esx
var calculator = require("./helper/calculator"); exports.render = function () { return calculator.math(2,2); }