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

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

@@ -1,197 +0,0 @@
-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

@@ -1,59 +0,0 @@
-/**
- * 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

@@ -1,46 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,43 +0,0 @@
-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;
-}

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

@@ -1,34 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Utility interface for Icons.
- *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getIconUtil()}.
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Magnus Lövgren
- */
-
-interface IconUtil {
-  /**
-   * Gets the file icon node for a given file extension.
-   * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
-   * @return the file icon node for aFileExtension, or <code>null</code> if the extension has no icon mapping
-   */
-  getFileIcons(aFileExtension: java.lang.String): Node;
-
-  /**
-   * Gets the small file icon URI for a given file extension
-   * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
-   * @return the small file icon URI for aFileExtension, or <code>null</code> if no small icon is specified for the extension
-   */
-  getSmallFileIconURI(aFileExtension: java.lang.String): string;
-
-  /**
-   * Gets the large file icon URI for a given file extension
-   * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
-   * @return the large file icon URI for aFileExtension, or <code>null</code> if no large icon is specified for the extension
-   */
-  getLargeFileIconURI(aFileExtension: java.lang.String): string;
-}

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

@@ -1,88 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Utility interface for getting landing pages.
- *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getLandingPageUtil()}.
- * 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 3.5.1
- */
-
-interface LandingPageUtil {
-  /**
-   * Gets the error page (404) of current site.
-   * @return the error page, or null if current site has no such page specified.
-   */
-  getErrorPage(): Node;
-
-  /**
-   * Gets the login page (401) of current site.
-   * @return the login page, or null if current site has no such page specified.
-   */
-  getLoginPage(): Node;
-
-  /**
-   * Gets the profile page (information about current/specified user identity) of current site.
-   * @return the profile page, or null if current site has no such page specified.
-   */
-  getProfilePage(): Node;
-
-  /**
-   * Gets the contacts page (information about the contacts of current/specified user identity) of current site.
-   * @return the contact page, or null if current site has no such page specified.
-   * @since Sitevision 6.0.1
-   */
-  getContactsPage(): Node;
-
-  /**
-   * Gets the user identity search result page of current site.
-   * @return the user identity search result page, or null if current site has no such page specified.
-   * @since Sitevision 6.0.1
-   */
-  getUserIdentitySearchResultPage(): Node;
-
-  /**
-   * Gets the files page (information about the files of a collaboration group) of current site.
-   * @return the files page, or null if current site has no such page specified.
-   * @since Sitevision 6.0.1
-   */
-  getFilesPage(): Node;
-
-  /**
-   * Gets the collaboration groups page (lists all accessible collaboration groups) of current site.
-   * @return the collaboration groups page, or null if current site has no such page specified.
-   * @since Sitevision 6.0.1
-   */
-  getCollaborationGroupsPage(): Node;
-
-  /**
-   * Gets the members page (lists all members of a specified collaboration group) of current site.
-   * @return the members page, or null if current site has no such page specified.
-   * @since Sitevision 6.0.1
-   */
-  getMembersPage(): Node;
-
-  /**
-   * Gets the tag timeline page (displays the timeline for a specified tag) of current site.
-   * @return the tag timeline page, or null if current site has no such page specified.
-   * @since Sitevision 6.0.1
-   */
-  getTagTimelinePage(): Node;
-
-  /**
-   * Gets the timeline entry page (displays a single timeline entry) of current site.
-   * @return the timeline entry page, or null if current site has no such page specified.
-   * @since Sitevision 6.0.1
-   */
-  getTimelineEntryPage(): Node;
-
-  /**
-   * Gets the topic timeline page of current site.
-   * @return the topic timeline page, or null if current site has no such page specified.
-   * @since Sitevision 7.0
-   */
-  getTopicTimelinePage(): Node;
-}

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

@@ -1,32 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * <p>Portlet utility interface.</p>
- *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPortletUtil()}.
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>The personal portlet preferences type.
- * @author Mikael Wikblom
- * @since Sitevision 2.6_06
- */
-
-interface PortletUtil {
-  /**
-   * <p>Extracts the user specific <code>PortletPreferences</code> for the specified portlet.
-   * This method is a complement to the accessor provided by <code>PortletRequest.getPreferences</code>
-   * which returns the <code>PortletPreferences</code> for the current user.</p>
-   *
-   * <p>Note that this method only returns the portlet preferences that are stored. Any
-   * local modifications that has not yet been stored will be ignored.</p>
-   * @param portlet The <code>Node</code> corresponding to a portlet
-   * @param user The <code>Node</code> corresponding to a user
-   * @param portletPreferencesType The preferences type <em>(for now, only {@link #PORTLET_PREFERENCES_TYPE_USER} is allowed)</em>
-   * @return <code>PortletPreferences</code> that is effective for the provided user for the specified portlet
-   */
-  getPortletPreferences(
-    portlet: Node,
-    user: Node,
-    portletPreferencesType: int
-  ): unknown;
-}