@sitevision/api 1.1.0-alpha.2 → 2.0.0-alpha.0

package/hidden/senselogic/sitevision/api/render/UserFieldRenderer/index.d.ts

@@ -0,0 +1,181 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * UserFieldRenderer is a stateful utility interface for rendering user field values for user identities.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getUserFieldRenderer()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ *
+ * <p>
+ *   Using the UserFieldRenderer is pretty straightforward, if you remember that it is <strong>stateful</strong> and that the previously loaded
+ *   user identity node will be cleared whenever you try to load a new one. Conceptually you would typically use it like this:
+ * </p>
+ * <ol>
+ *   <li>Get the UserFieldRenderer</li>
+ *   <li>Set a user identity node</li>
+ *   <li>Do render of a named user field</li>
+ *   <li>Do render of another named user field</li>
+ *   <li>...</li>
+ * </ol>
+ * <p>
+ * You can then re-use the UserFieldRenderer for another user identity until you are done. Something like:
+ * </p>
+ * <ol>
+ *   <li>Update the user identity node</li>
+ *   <li>Do render of a named user field</li>
+ *   <li>Do render of another named user field</li>
+ *   <li>...</li>
+ * </ol>
+ *
+ * <p>
+ *    <strong>Example of how this strategy could be implemented in Velocity:</strong><br>
+ *    (You want to do a simple listing of the user fields "Namn" and "E-postadress" for some user identities or users in $myList)
+ * </p>
+ * <pre><code>
+ *   <em>## Get UserFieldRenderer</em>
+ *   #set ($userFieldRenderer = $sitevisionUtils.userFieldRenderer)
+ *
+ *   <em>## Ensure at least one of the fields actually exist</em>
+ *   #if ($userFieldRenderer.isValidFieldName('Namn') || $userFieldRenderer.isValidFieldName('E-postadress'))
+ *     <em>## Iterate through the list and render fields for all valid nodes</em>
+ *     &lt;ul class="sv-no-list-style"&gt;
+ *     #foreach ($item in $myList)
+ *       <em>## Check if this node can be rendered</em>
+ *       #if ($userFieldRenderer.isRenderable($item))
+ *         <em>## Update the renderer and render</em>
+ *         $userFieldRenderer.update($item)
+ *         &lt;li&gt;
+ *           $userFieldRenderer.render('Namn')
+ *           $userFieldRenderer.render('E-postadress')
+ *         &lt;/li&gt;
+ *       #end
+ *     #end
+ *     &lt;/ul&gt;
+ *   #end
+ * </code></pre>
+ *
+ * <p>
+ *    <strong>Important rendering note!</strong> When rendering a user field value, you must specify the <em>name</em>
+ *    of the user field. See {@link #isValidFieldName(String)} for more information about how names are matched to user fields.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.5.3
+ */
+
+interface UserFieldRenderer {
+  /**
+   * Updates the renderer with a new user identity node.
+   *
+   * <p>
+   * If <code>aUserIdentity</code> is not a renderable node, the argument will be considered as <code>null</code>, i.e.
+   * the renderer will not have any renderable node in subsequent render execution.
+   * </p>
+   * @param aUserIdentity a user identity node, or a user that has an identity on current site
+   */
+  update(aUserIdentity: Node): void;
+
+  /**
+   * Whether or not this renderer contains a user identity.
+   * @return <code>true</code> if a renderable node is loaded, <code>false</code> if not.
+   */
+  isLoaded(): boolean;
+
+  /**
+   * Helper method to check if a certain node can be rendered.
+   *
+   * <p>
+   *    Nodes with the following primary node types are potentially renderable:
+   * </p>
+   * <ul>
+   *    <li><code>sv:userIdentity</code></li>
+   *    <li><code>sv:user</code> <em>(non-anonymous)</em> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+   *    <li><code>sv:simpleUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+   *    <li><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+   * </ul>
+   * @param aNode the node to check
+   * @return <code>true</code> if <code>aNode</code> is supported by this renderer, <code>false</code> if not
+   */
+  isRenderable(aNode: Node): boolean;
+
+  /**
+   * Helper method to check if a named user field is available.
+   *
+   * <p>
+   *    <strong>An important note about field names and user field lookup!</strong> A specific user field can be found
+   *    via <em>multiple</em> names:
+   * </p>
+   * <ol>
+   *    <li>Primarily user fields are found via their <em>UI name</em>.</li>
+   *    <li>Secondary user fields are found via their <em>Ldap name</em> (ldap-read fields only).</li>
+   *    <li>As last resort user fields are found via their <em>Index name</em>.</li>
+   * </ol>
+   * <p>
+   *    <em>First found match is used!</em>
+   * </p>
+   * <p>
+   *    This is a convenience to make user fields easier to find, but <em>beware of colliding names</em>! For instance,
+   *    if field A has Ldap name "X" and field B has UI name "X" - field B will be used.
+   * </p>
+   * @param aUserFieldName the name of the user field
+   * @return <code>true</code> if current site has a user field that can be found via <code>aUserFieldName</code>, <code>false</code> if not
+   */
+  isValidFieldName(aUserFieldName: java.lang.String): boolean;
+
+  /**
+   * Returns the value as html for a named user field for currently loaded user identity.
+   *
+   * <p>
+   *    The rendered output of the user field value is handled as:
+   * </p>
+   * <ul>
+   *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
+   *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
+   *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
+   * </ul>
+   *
+   * <p>
+   *    <em>Note! The result of this method is equivalent with calling {@link #getPlainUserFieldValueAsHtml(String)} with the
+   *    result of the {@link #renderPlain(String)} method, but this method is more efficient and should always be preferred.</em>
+   * </p>
+   * @param aUserFieldName the name of the user field, see: {@link #isValidFieldName(String)}
+   * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
+   */
+  render(aUserFieldName: java.lang.String): string;
+
+  /**
+   * Returns the value as plain text for a named user field for currently loaded user identity.
+   *
+   * <p>
+   *    <strong>Note!</strong> The rendered output is plain text and <em>must be escaped</em> if it should be part of the html output of a page!
+   * </p>
+   * @param aUserFieldName the name of the user field, see: {@link #isValidFieldName(String)}
+   * @return a plain string. Might be empty but never <code>null</code>.
+   * @since Sitevision 3.6
+   * @see #render(String)
+   */
+  renderPlain(aUserFieldName: java.lang.String): string;
+
+  /**
+   * Returns a plain text user field value as html.
+   *
+   * <p>
+   *    <strong>Note!</strong> This method is <em>stateless</em>, i.e. you don't have to have a user identity loaded to call this method.
+   *    Typically you would always use the {@link #render(String)} whenever possible. This method should only be used when you have a plain
+   *    text user field value, but no user identity (e.g. in large search results where you want to avoid loading lots of user identity objects).
+   * </p>
+   * <p>
+   *    The rendered output of the plain text user field value is handled as:
+   * </p>
+   * <ul>
+   *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
+   *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
+   *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
+   * </ul>
+   * @param aPlainUserFieldValue the plain text user field value
+   * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
+   * @since Sitevision 3.6
+   */
+  getPlainUserFieldValueAsHtml(aPlainUserFieldValue: java.lang.String): string;
+}

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts

@@ -3,6 +3,8 @@
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  */
-interface VelocityAccess {}
+interface VelocityAccess {
+  undefined;
+}
 
 export default VelocityAccess;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/index.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts

@@ -4,8 +4,7 @@
  * <p>
  *    An instance of the Sitevision class implementing this interface can be obtained via a <code>getVelocityContext</code>
  *    method in {@link senselogic.sitevision.api.render.velocity.VelocityRenderer}.
- * </p>Adds a Name/Object mapping to the context.
- * Null key mappings will be ignored.Returns the mapped object for a specified name.Checks whether a name has a mapping or not.Returns all names.Removes a Name/Object mapping.
+ * </p>
  * @author Magnus Lövgren
  * @see VelocityRenderer
  * @since Sitevision 3.0

package/hidden/senselogic/sitevision/api/render/velocity/VelocityContext/index.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  put: function put() {},
+  get: function get() {},
+  containsKey: function containsKey() {},
+  getKeys: function getKeys() {},
+  remove: function remove() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts

@@ -4,40 +4,6 @@
  * <p>
  *    An instance of this interface can never be directly created and all instances are heavily bound to the Velocity
  *    context they were created for.
- * </p>Renders a template that is parsed/evaluated by Velocity.
- *
- * <p>
- *    <strong>Note!</strong> This method is intended for usage from within Velocity only
- *    (e.g. <code>$aVelocityEvaluatorInstance.evaluate($aTemplateString)</code>),
- *    see {@link VelocityRenderer} for an example.
- * </p>
- *
- * <p>
- *    <em>
- *       <strong>Tip when evaluating velocity files in a custom portlet!</strong>
- *       The path to your portlet's velocity file(-s) are class loader dependant and therefore likely to have
- *       it's root from the "classes" folder of your war. An example, your portlet war looks like this:
- *    </em>
- * </p>
- * <pre><em>
- *    [META-INF]
- *      |- context.xml
- *    [WEB-INF]
- *      |- portlet.xml
- *      |- web.xml
- *      |- [classes]
- *      |      |- [com]
- *      |           |- [mycompany]
- *      |                  |- [myportlet]
- *      |                        |- MyPortlet.class
- *      |- [resources]
- *             |- myvelocityfile.vm
- * </em></pre>
- * <p>
- *    <em>
- *       If you want to use a VelocityEvaluator to evaluate the <code>myvelocityfile.vm</code> in the <code>MyPortlet.class</code>,
- *       your velocity file path would likely be <code>"../resources/myvelocityfile.vm"</code>.
- *    </em>
  * </p>
  * @author Magnus Lövgren
  * @see VelocityRenderer

package/hidden/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  evaluate: function evaluate() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityRenderer/index.d.ts

@@ -0,0 +1,197 @@
+import VelocityContext from "../VelocityContext";
+
+/**
+ * A renderer that can be used in custom portlets for rendering Velocity templates.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getVelocityRenderer()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ *
+ * <div style="margin-top:15px; border:1px dotted gray; padding-left:10px; padding-right:10px">
+ *      <p style="margin-bottom:10px">
+ *       <em><strong>Note!</strong> This renderer relies heavily on the internal Sitevision Velocity rendering facilities!</em>
+ *    </p>
+ *    <p style="margin-top:0; margin-bottom:10px">
+ *       <em>The upside of this is that you get caching and such "for free" and you don't have to include or use any Velocity jar
+ *       when creating your portlet application (war file). You will also avoid possible Velocity.init() caveats and such.
+ *       The possible downside is that the Velocity engine (currently version 1.7) potentially can be replaced at
+ *       any time (i.e. whenever Sitevision is updated).</em>
+ *    </p>
+ *    <p style="margin-top:0; margin-bottom:10px">
+ *       &rArr; <em>Ensure your Velocity template(-s) doesn't contain really "edgy" stuff or relies on bugs in currently used
+ *       Velocity version. If so, your code might potentially break in a future Sitevision update!</em>
+ *    </p>
+ * </div>
+ *
+ * <p>
+ *    Below is a simple example of how the VelocityRenderer can be used in a custom portlet:
+ * </p>
+ * <pre><code>
+ * import senselogic.sitevision.api.Utils;
+ * import senselogic.sitevision.api.portlet.GenericSiteVisionPortlet;
+ * import senselogic.sitevision.api.render.velocity.VelocityContext;
+ * import senselogic.sitevision.api.render.velocity.VelocityException;
+ * import senselogic.sitevision.api.render.velocity.VelocityRenderer;
+ *
+ * import javax.portlet.*;
+ * import java.io.IOException;
+ * import java.io.PrintWriter;
+ *
+ * public class HelloVelocityPortlet extends GenericSiteVisionPortlet {
+ *    private String template;    <em>// Never reassigned after init, ok to use as field</em>
+ *    private String subTemplate; <em>// Never reassigned after init, ok to use as field</em>
+ *
+ *    &#64;Override
+ *    public void init(PortletConfig portletConfig) throws PortletException {
+ *       super.init(portletConfig);
+ *
+ *       template =
+ *          " Current request is: $request &lt;br /&gt;                " +
+ *          " Utils is: $sitevisionUtils &lt;br /&gt;                  " +
+ *          " Session is: $jcrSession &lt;br /&gt;                     " +
+ *          " VelocityEvaluator is: $velocityEvaluator &lt;br /&gt;    " +
+ *          " &lt;br /&gt;                                             " +
+ *          " #set($count = 1)                                   " +
+ *          " This is written with the VelocityEvaluator: &lt;br /&gt; " +
+ *          " &lt;div style=\"margin:0 20px\"&gt;                      " +
+ *          "    $velocityEvaluator.evaluate($evaluateThis)      " +
+ *          " &lt;/div&gt;                                             ";
+ *
+ *       subTemplate =
+ *          " #if ($count)                                                           " +
+ *          "    count exists and is: $count                                         " +
+ *          " #else                                                                  " +
+ *          "    The 'count' reference is missing in the context I'm rendering in... " +
+ *          " #end                                                                   ";
+ *    }
+ *
+ *    &#64;Override
+ *    protected void doView(RenderRequest renderRequest, RenderResponse renderResponse) throws PortletException, IOException {
+ *       PrintWriter writer = getWriter(renderResponse);
+ *
+ *       <em>// Get the Velocity renderer</em>
+ *       Utils utils = getUtils(renderRequest);
+ *       VelocityRenderer velocityRenderer = utils.getVelocityRenderer();
+ *
+ *       <em>// Create a Sitevision API rendering context (i.e. $request, $sitevisionUtils, $jcrSession and $velocityEvaluator are added)</em>
+ *       VelocityContext context = velocityRenderer.getVelocityContext(renderRequest, writer);
+ *       context.put("evaluateThis", subTemplate); <em>// Add a 'evaluateThis' reference used by the $velocityEvaluator, see templates above</em>
+ *
+ *       <em>// Render!</em>
+ *       try {
+ *          velocityRenderer.render(context, template);
+ *       } catch (VelocityException e) {
+ *          utils.getLogUtil().debug("Exception occurred while rendering 'Hello Velocity' portlet template", e);
+ *       }
+ *    }
+ *
+ *    &#64;Override
+ *    public void destroy() {
+ *       template = null;
+ *       subTemplate = null;
+ *       super.destroy();
+ *    }
+ * }</code></pre>
+ *
+ * <p>
+ *    The portlet code above demonstrates the actual Java portlet code, but also gives some Velocity code examples.
+ *    Though, this example is probably somewhat non-realistic in the real world. When implementing a proper variant of this
+ *    portlet, you would typically put all of your Velocity code in separate .vm files instead of building massive concatenated
+ *    Java strings...
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.0
+ */
+
+interface VelocityRenderer {
+  /**
+   * Creates and returns an empty VelocityContext instance.
+   * @param aWriter the rendering output (typically RenderResponse.getWriter()), not <code>null</code>
+   * @return a VelocityContext instance that can be used in the render method
+   * @throws IllegalArgumentException if aWriter is <code>null</code>
+   */
+  getVelocityContext(aWriter: java.io.Writer): VelocityContext;
+
+  /**
+   * Creates and returns a VelocityContext instance with the default Sitevision API mappings.
+   *
+   * <table style="margin-top:20px; width:600px; border:1px solid black">
+   *    <caption style="text-align:left">Pre-added mappings in VelocityContext (if aPortletRequest is non-null)</caption>
+   *    <tr>
+   *       <th style="text-align:left; background-color:black; color:white">Name (available via $)</th>
+   *       <th style="text-align:left; background-color:black; color:white">Value (an object instance)</th>
+   *    </tr>
+   *    <tr>
+   *       <td><code>request</code></td>
+   *       <td>the <code>PortletRequest</code> instance</td>
+   *    </tr>
+   *    <tr>
+   *       <td><code>sitevisionUtils</code></td>
+   *       <td>an instance of {@link senselogic.sitevision.api.Utils}</td>
+   *    </tr>
+   *    <tr>
+   *       <td><code>jcrSession</code></td>
+   *       <td>an instance of {@link javax.jcr.Session}</td>
+   *    </tr>
+   *    <tr>
+   *       <td><code>velocityEvaluator</code></td>
+   *       <td>an instance of {@link VelocityEvaluator}</td>
+   *    </tr>
+   * </table>
+   * @param aPortletRequest the request to use as base for adding the default Sitevision API mappings. No mappings will be added if <code>null</code>.
+   * @param aWriter the rendering output <em>(typically RenderResponse.getWriter())</em>, not <code>null</code>
+   * @return a VelocityContext instance that can be used in the render method
+   * @throws IllegalArgumentException if aWriter is <code>null</code>
+   */
+  getVelocityContext(
+    aPortletRequest: javax.portlet.PortletRequest,
+    aWriter: java.io.Writer
+  ): VelocityContext;
+
+  /**
+   * Creates and returns a VelocityContext instance with the default Sitevision API mappings.
+   *
+   * <table style="margin-top:20px; width:600px; border:1px solid black">
+   *    <caption style="text-align:left">Pre-added mappings in VelocityContext (if aServletRequest is non-null)</caption>
+   *    <tr>
+   *       <th style="text-align:left; background-color:black; color:white">Name (available via $)</th>
+   *       <th style="text-align:left; background-color:black; color:white">Value (an object instance)</th>
+   *    </tr>
+   *    <tr>
+   *       <td><code>request</code></td>
+   *       <td>the <code>ServletRequest</code> instance</td>
+   *    </tr>
+   *    <tr>
+   *       <td><code>sitevisionUtils</code></td>
+   *       <td>an instance of {@link senselogic.sitevision.api.Utils}</td>
+   *    </tr>
+   *    <tr>
+   *       <td><code>jcrSession</code></td>
+   *       <td>an instance of {@link javax.jcr.Session}</td>
+   *    </tr>
+   *    <tr>
+   *       <td><code>velocityEvaluator</code></td>
+   *       <td>an instance of {@link VelocityEvaluator}</td>
+   *    </tr>
+   * </table>
+   * @param aServletRequest the request to use as base for adding the default Sitevision API mappings. No mappings will be added if <code>null</code>.
+   * @param aWriter the rendering output <em>(typically HttpServletResponse.getWriter())</em>, not <code>null</code>
+   * @return a VelocityContext instance that can be used in the render method
+   * @throws IllegalArgumentException if aWriter is <code>null</code>
+   */
+  getVelocityContext(
+    aServletRequest: javax.servlet.ServletRequest,
+    aWriter: java.io.Writer
+  ): VelocityContext;
+
+  /**
+   * Renders a Velocity template string.
+   * @param aContext a context with mappings needed by aTemplate (Note! this must be an instance created via any of the methods above, a custom VelocityContext implementation is not allowed).
+   * @param aTemplate the template string (i.e. if the actual template is in a file, you must read it and put it in a string that can be passed to this method)
+   * @throws IllegalArgumentException if aTemplate is <code>null</code>, if aContext is <code>null</code> or not created via VelocityRenderer
+   * @throws VelocityException if parsing/evaluation of aTemplate fails
+   * @throws IOException if an I/O exception occurs during the rendering process
+   */
+  render(aContext: VelocityContext, aTemplate: java.lang.String): void;
+}

package/hidden/senselogic/sitevision/api/render/xslt/XSLTUtil/index.d.ts

@@ -0,0 +1,59 @@
+/**
+ * XSLT utility for transforming XML/HTML using a XSL template.
+ *
+ * <p>
+ *    <em>Tip!</em> This utility can be combined with {@link senselogic.sitevision.api.render.OutputUtil} to produce modified versions of
+ *    the HTML produced by layouts or modules. Below is a simplistic example of how this can be done in server-side JavaScript.
+ * </p><pre>
+ *    var outputUtil = require('OutputUtil'),
+ *        xsltUtil = require('XSLTUtil'),
+ *        pageNode,
+ *        pageContentNode,
+ *        rawRenderResult,
+ *        transformedRenderResult;
+ *
+ *    pageNode = ...
+ *    pageContentNode = ...
+ *
+ *    rawRenderResult = outputUtil.getNodeOutput(pageNode, pageContentNode, outputUtil.CONTENT_TYPE_TEXT_HTML);
+ *    transformedRenderResult = xsltUtil.transform(rawRenderResult, xsltUtil.getDefaultCleanHtmlTemplate());
+ * </pre>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getXSLTUtil}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.5
+ */
+
+interface XSLTUtil {
+  /**
+   * Gets the default XSL template for cleanup of HTML sources.
+   *
+   * <p>
+   *    The template strips all &lt;div&gt;'s, &lt;spans&gt;'s and removes all inline styling, classes and attributes
+   *    that is not mandatory or needed for WCAG purposes.
+   * </p>
+   * <p>
+   *    <em>Note!</em> The template supports a <em>sub-set</em> of HTML elements (the presumed most commonly used elements).
+   *    All unsupported elements are completely discarded (i.e. they will not be included at all in the transformation result).
+   * </p>
+   * @return the default cleanup template for HTML sources
+   */
+  getDefaultCleanHtmlTemplate(): string;
+
+  /**
+   * Transforms a HTML/XML source using a XSL template.
+   *
+   * <p>
+   *    <em>Note!</em> The contents of the XSL Template is always handled as UTF-8.
+   * </p>
+   * @param aSource the source that should be transformed, HTML, XHTML or XML. Must not be null
+   * @param aXslTemplate the UTF-8 XSL template; a sv:file Node, a sv:temporaryFile Node, a sv:link Node that targets a sv:file, a char array or a CharSequence (typically a String). Must not be null
+   * @return the transformation result
+   * @throws IOException if the transformation fails (e.g. the aSource is really bad/interpretable HTML or aXslTemplate is invalid XSL)
+   * @throws RepositoryException if aNode-operation on aXslTemplate fails
+   */
+  transform(aSource: java.lang.String, aXslTemplate: java.lang.Object): string;
+}

package/hidden/senselogic/sitevision/api/resource/ColorUtil/index.d.ts

@@ -0,0 +1,46 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Utility interface for Colors.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getColorUtil()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ */
+
+interface ColorUtil {
+  /**
+   * Gets the color with a given name
+   * @param aColorName the name of the font
+   * @return the first color with name aColorName, or <code>null</code> if no color matches
+   */
+  getColorByName(aColorName: java.lang.String): Node;
+
+  /**
+   * Gets the color with a given name with a fallback value if no color matches
+   * @param aColorName the name of the font
+   * @param aDefaultValue fallback value
+   * @return the first color with name aColorName, or aDefaultValue if no color matches
+   */
+  getColorByName(aColorName: java.lang.String, aDefaultValue: Node): Node;
+
+  /**
+   * Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]).
+   * @param aHexString the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])
+   * @return the first color with the corresponding hex string, or <code>null</code> if no color matches
+   */
+  getColorByHtmlHexValue(aHexString: java.lang.String): Node;
+
+  /**
+   * Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]) with a fallback value if no color matches.
+   * @param aHexString the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])
+   * @param aDefaultValue fallback value
+   * @return the first color with the corresponding hex string, or aDefaultValue if no color matches
+   */
+  getColorByHtmlHexValue(
+    aHexString: java.lang.String,
+    aDefaultValue: Node
+  ): Node;
+}

package/hidden/senselogic/sitevision/api/resource/DecorationUtil/index.d.ts

@@ -0,0 +1,20 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Utility interface for Decorations.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDecorationUtil()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ */
+
+interface DecorationUtil {
+  /**
+   * Gets the decoration with a given name
+   * @param aDecorationName the name of the decoration
+   * @return the first decoration with name aDecorationName, or <code>null</code> if no decoration matches
+   */
+  getDecorationByName(aDecorationName: java.lang.String): Node;
+}

package/hidden/senselogic/sitevision/api/resource/FontUtil/index.d.ts

@@ -0,0 +1,43 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Utility interface for Fonts.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFontUtil()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ */
+
+interface FontUtil {
+  /**
+   * Gets the font with a given font name
+   * @param aFontName the name of the font
+   * @return the first font with name aFontName, or <code>null</code> if no font matches
+   */
+  getFontByName(aFontName: java.lang.String): Node;
+
+  /**
+   * Gets the font with a given font name with a fallback value if no font matches
+   * @param aFontName the name of the font
+   * @param aDefaultValue fallback value
+   * @return the first font with name aFontName, or aDefaultValue if no font matches
+   */
+  getFontByName(aFontName: java.lang.String, aDefaultValue: Node): Node;
+
+  /**
+   * Gets the font with a given class name
+   * @param aClassName the class name of the font
+   * @return the first font with class name aClassName, or <code>null</code> if no font matches
+   */
+  getFontByClassName(aClassName: java.lang.String): Node;
+
+  /**
+   * Gets the font with a given class name with a fallback value if no font matches
+   * @param aClassName the class name of the font
+   * @param aDefaultValue fallback value
+   * @return the first font with class name aClassName, or aDefaultValue if no font matches
+   */
+  getFontByClassName(aClassName: java.lang.String, aDefaultValue: Node): Node;
+}