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

package/{hidden → types}/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts

@@ -18,6 +18,6 @@
  * @since Sitevision 3.6
  * @see senselogic.sitevision.api.metadata.builder.RelatedValueBuilder
  */
-interface RelatedValue {}
-
-export default RelatedValue;
+export type RelatedValue = {
+  undefined;
+};

package/types/senselogic/sitevision/api/metadata/value/RelatedValue/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 → types}/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts

@@ -1,4 +1,4 @@
-import Binary from "../../../../../javax/jcr/Binary";
+import type { Binary } from "../../../../../javax/jcr/Binary";
 
 /**
  * Utility interface for getting Node property values in a specific version.
@@ -46,202 +46,13 @@ import Binary from "../../../../../javax/jcr/Binary";
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link senselogic.sitevision.api.Utils#getVersionedPropertyUtil(int)}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Gets a String property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a String property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a String property from a potential "nested" Node's property in a specific version.
- * (i.e. the base <code>Node</code> has a property that is a <code>Node</code>,
- * and that "inner/nested" <code>Node</code> has a <code>String</code> property).
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aNodePropertyName</code> and <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a String property from a potential "nested" Node's property in a specific version - with a fallback value if the property doesn't exist.
- * (i.e. the base <code>Node</code> has a property that is a <code>Node</code>,
- * and that "inner/nested" <code>Node</code> has a <code>String</code> property).
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aNodePropertyName</code> and <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a <code>List</code> of property values from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a <code>List</code> of property values from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a <code>List</code> of property values from a potential "nested" Node's property in a specific version.
- * (i.e. the base <code>Node</code> has a property that is a <code>Node</code>,
- * and that "inner/nested" <code>Node</code> has a <code>String</code> property).
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aNodePropertyName</code> and <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a <code>List</code> of property values from a potential "nested" Node's property in a specific version
- * - with a fallback value if the property doesn't exist.
- * (i.e. the base <code>Node</code> has a property that is a <code>Node</code>,
- * and that "inner/nested" <code>Node</code> has a <code>String</code> property).
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aNodePropertyName</code> and <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets an int property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets an int property from a potential node in a specific version -  with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a boolean property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a boolean property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a Calendar property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a Calendar property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a double property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a double property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a Binary property from a potential Node in a specific version.
- *
- * <p>
- *    Ensure to always handle resources appropriately when working with Binary! If you get a stream via {@link javax.jcr.Binary#getStream()},
- *    you must also <code>close</code> the stream when you are done.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> The <code>Binary</code> support is limited, see {@link javax.jcr.Property#getBinary()} for more information!
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a Binary property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    Ensure to always handle resources appropriately when working with Binary! If you get a stream via {@link javax.jcr.Binary#getStream()},
- *    you must also <code>close</code> the stream when you are done.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> The <code>Binary</code> support is limited, see {@link javax.jcr.Property#getBinary()} for more information!
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.0
  * @see OfflineVersionPropertyUtil
  * @see OnlineVersionPropertyUtil
  */
-interface VersionedPropertyUtil {
+export type VersionedPropertyUtil = {
   /**
    * Gets a String property from a potential Node in a specific version.
    *
@@ -346,7 +157,7 @@ interface VersionedPropertyUtil {
    * @param aPropertyName the name of the property
    * @return the value for <code>aPropertyName</code> as <code>String</code>. If the property is single valued a list with one element is returned. If no node or property exists, <code>null</code> is returned.
    */
-  getStrings(aNodeIdentifier: string, aPropertyName: string): unknown[];
+  getStrings(aNodeIdentifier: string, aPropertyName: string): unknown;
 
   /**
    * Gets a <code>List</code> of property values from a potential Node in a specific version - with a fallback value if the property doesn't exist.
@@ -367,8 +178,8 @@ interface VersionedPropertyUtil {
   getStrings(
     aNodeIdentifier: string,
     aPropertyName: string,
-    aDefaultValue: unknown[]
-  ): unknown[];
+    aDefaultValue: unknown
+  ): unknown;
 
   /**
    * Gets a <code>List</code> of property values from a potential "nested" Node's property in a specific version.
@@ -392,7 +203,7 @@ interface VersionedPropertyUtil {
     aNodeIdentifier: string,
     aNodePropertyName: string,
     aPropertyName: string
-  ): unknown[];
+  ): unknown;
 
   /**
    * Gets a <code>List</code> of property values from a potential "nested" Node's property in a specific version
@@ -418,8 +229,8 @@ interface VersionedPropertyUtil {
     aNodeIdentifier: string,
     aNodePropertyName: string,
     aPropertyName: string,
-    aDefaultValue: unknown[]
-  ): unknown[];
+    aDefaultValue: unknown
+  ): unknown;
 
   /**
    * Gets an int property from a potential Node in a specific version.
@@ -637,6 +448,4 @@ interface VersionedPropertyUtil {
     aPropertyName: string,
     aDefaultValue: Binary
   ): Binary;
-}
-
-export default VersionedPropertyUtil;
+};

package/types/senselogic/sitevision/api/property/VersionedPropertyUtil/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getString: function getString() {},
+  getNestedString: function getNestedString() {},
+  getStrings: function getStrings() {},
+  getNestedStrings: function getNestedStrings() {},
+  getInt: function getInt() {},
+  getBoolean: function getBoolean() {},
+  getCalendar: function getCalendar() {},
+  getDouble: function getDouble() {},
+  getBinary: function getBinary() {}
+};
+exports["default"] = _default;

package/{hidden → types}/senselogic/sitevision/api/render/ImageScaler/index.d.ts

@@ -1,4 +1,4 @@
-import Node from "../../../../../javax/jcr/Node";
+import type { Node } from "../../../../../javax/jcr/Node";
 
 /**
  * The ImageScaler interface describes in which way images should be rescaled by an <code>ImageRenderer</code>.
@@ -7,22 +7,11 @@ import Node from "../../../../../javax/jcr/Node";
  * An immutable instance of the Sitevision class implementing this interface can be obtained via
  * {@link senselogic.sitevision.api.Utils#getImageScaler(int, int)}.
  * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Returns max width in pixels for images scaled with instances of this interface.Returns max height in pixels for images scaled with instances of this interface.Creates a scaled image using the width and height of this scaler.
- *
- * <p>
- *    <em>Note! SVG images can't be scaled, i.e. calling this method with a sv:image of svg type will always return null.</em>
- * </p>
- *
- * <p>
- *    <strong>Important Note!</strong> The scaled image is a very short-lived and volatile kind of node.
- *    Its parent/child relationship can never be relied upon. Hence the JCR Path (and tree-related operations)
- *    of the returned scaled image node should never be used
- *    <em>(i.e. only use the returned node to get the properties you are interested in)</em>.
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_08
  */
-interface ImageScaler {
+export type ImageScaler = {
   /**
    * Returns max width in pixels for images scaled with instances of this interface.
    * @return max width for scaled images
@@ -53,6 +42,4 @@ interface ImageScaler {
    * @since Sitevision 4.3
    */
   getScaledImage(aImageNode: Node): Node;
-}
-
-export default ImageScaler;
+};

package/types/senselogic/sitevision/api/render/ImageScaler/index.js

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

package/{hidden → types}/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts

@@ -1,4 +1,4 @@
-import Node from "../../../../../javax/jcr/Node";
+import type { Node } from "../../../../../javax/jcr/Node";
 
 /**
  * TextModuleRenderer is a stateful renderer of Sitevision Text modules on a specific page.
@@ -114,78 +114,11 @@ import Node from "../../../../../javax/jcr/Node";
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link TextModuleRendererBuilder#build()} .
  *    See {@link TextModuleRendererBuilder} for how to obtain an instance of the <code>TextModuleRendererBuilder</code> interface.
- * </p>Updates the state of this renderer (potentially "loads" a Text module for rendering) using a Text module Node.
- *
- * <p>
- *    <em>
- *       Note! If this state update fails (i.e. argument was null or not specifying a supported Text module that exists on the page
- *       this renderer was created for) there will be nothing to render. The state can always be checked via the
- *       {@link #isLoaded()} method.
- *    </em>
- * </p>Updates the state of this renderer (potentially "loads" a Text module for rendering) using the name of a Text module Node.
- *
- * <p>
- *    <em>
- *       Note! If this state update fails (i.e. argument was null or not specifying a supported Text module that exists on the page
- *       this renderer was created for) there will be nothing to render. The state can always be checked via the
- *       {@link #isLoaded()} method.
- *    </em>
- * </p>Updates the state of this renderer (potentially "loads" a Text module for rendering) using the identifier of a Text module Node.
- *
- * <p>
- *    <em>
- *       Note! If this state update fails (i.e. argument was null or not specifying a supported Text module that exists on the page
- *       this renderer was created for) there will be nothing to render. The state can always be checked via the
- *       {@link #isLoaded()} method.
- *    </em>
- * </p>Whether or not this renderer has been updated with a renderable text module.Renders full HTML for the loaded Text module.
- *
- * <p>
- *    <strong>Note!</strong> The returned value will always be empty string if the {@link #isLoaded()} state is <code>false</code>
- *    when invoking this render method <em>(i.e. you would typically always check the loaded state before calling this method).</em>
- * </p>
- *
- * <p>
- *    <em>
- *       This method is conceptually equivalent with
- *       {@link OutputUtil#getNodeOutput(Node, Node, int)
- *       OutputUtil.getNodeOutput(ThePageOfThisRenderer, TheLoadedTextModule, OutputUtil.CONTENT_TYPE_TEXT_HTML)}
- *    </em>
- * </p>Renders the text for the loaded Text module.
- *
- * <p>
- *    <strong>Note!</strong> The returned value will always be empty string if the {@link #isLoaded()} state is <code>false</code>
- *    when invoking this render method <em>(i.e. you would typically always check the loaded state before calling this method).</em>
- * </p>
- *
- * <p>
- *    <em>
- *       This method is conceptually equivalent with
- *       {@link OutputUtil#getNodeOutput(Node, Node, int)
- *       OutputUtil.getNodeOutput(ThePageOfThisRenderer, TheLoadedTextModule, OutputUtil.CONTENT_TYPE_TEXT_PLAIN)}
- *       but this method does not html encode/escape any chars, this method provides the "raw" text.
- *    </em>
- * </p>
- *
- * <p>
- *    <strong>Important security note!</strong><br>
- *    The result text of this method is <strong>not</strong> HTML encoded/escaped!
- *    Hence if you should output the text as part of a HTML page, you must escape/encode the text!
- *    Such escaping/encoding is provided by {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}.
- * </p>Renders the plain HTML for the loaded Text module.
- *
- * <p>
- *    <strong>Note!</strong> The returned value will always be empty string if the {@link #isLoaded()} state is <code>false</code>
- *    when invoking this render method <em>(i.e. you would typically always check the loaded state before calling this method).</em>
- * </p>
- *
- * <p>
- *    The <em>plain</em> HTML is a minimal and generic variant of the full Text module HTML (as of {@link #renderHtml()}).
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 7
  */
-interface TextModuleRenderer {
+export type TextModuleRenderer = {
   /**
    * Updates the state of this renderer (potentially "loads" a Text module for rendering) using a Text module Node.
    *
@@ -296,6 +229,4 @@ interface TextModuleRenderer {
    * @see #renderHtml()
    */
   renderPlainHtml(): string;
-}
-
-export default TextModuleRenderer;
+};

package/types/senselogic/sitevision/api/render/TextModuleRenderer/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  update: function update() {},
+  updateByName: function updateByName() {},
+  updateByIdentifier: function updateByIdentifier() {},
+  isLoaded: function isLoaded() {},
+  renderHtml: function renderHtml() {},
+  renderText: function renderText() {},
+  renderPlainHtml: function renderPlainHtml() {}
+};
+exports["default"] = _default;

package/{hidden → types}/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts

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

package/types/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 → types}/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts

@@ -4,13 +4,12 @@
  * <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
  */
-interface VelocityContext {
+export type VelocityContext = {
   /**
    * Adds a Name/Object mapping to the context.
    * Null key mappings will be ignored.
@@ -45,6 +44,4 @@ interface VelocityContext {
    * @return the Object mapped to aKey, or <code>null</code> if no mapping for aKey exist
    */
   remove(aKey: string): unknown;
-}
-
-export default VelocityContext;
+};

package/types/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 → types}/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts

@@ -4,47 +4,13 @@
  * <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
  * @since Sitevision 2.7_06
  * @since Sitevision 3.0
  */
-interface VelocityEvaluator {
+export type VelocityEvaluator = {
   /**
    * Renders a template that is parsed/evaluated by Velocity.
    *
@@ -84,6 +50,4 @@ interface VelocityEvaluator {
    * @param aTemplate a String containing the Velocity code to be parsed or a path to a velocity template file (suffix must be ".vm" and path must not contain any space character)
    */
   evaluate(aTemplate: string): void;
-}
-
-export default VelocityEvaluator;
+};

package/types/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;