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

package/server/LinkPageUtil/index.js

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

package/server/LinkRenderer/index.d.ts

@@ -885,216 +885,10 @@ export function clearUseCrossSiteTargetChecking(): void;
  * <p>
  *  <strong>Note/Tip!</strong> This interface helps rendering textual links. If you want to render <em>image</em> links, you would typically
  *  use the {@link senselogic.sitevision.api.render.ImageLinkRenderer} instead.
- * </p>Updates current state.Updates current state and removes previous title.Updates current state and removes previous title.Updates current state and removes previous title and text.
- *
- * <p>
- *    Note. If no text exists when rendering, the target Node will be used to determine an appropriate text
- *    (e.g. the display name if the node is a page).
- * </p>Updates current state and removes all optional attributes.Updates current state and removes all optional attributes and title.Updates current state and removes all optional attributes and title.Updates current state and removes all optional attributes, title and text.
- *
- * <p>
- *    Note. If no text exists when rendering, the target Node will be used to determine an appropriate text
- *    (e.g. the display name if the node is a page).
- * </p>Removes all optional settings.
- * In other words - executing this method has the same effect as executing:
- * <ul>
- *   <li><code>clearStyle()</code></li>
- *   <li><code>clearOnclick()</code></li>
- *   <li><code>clearId()</code></li>
- *   <li><code>clearTargetParameters()</code></li>
- *   <li><code>clearRel()</code></li>
- *   <li><code>clearAccessKey()</code></li>
- *   <li><code>clearOpenNewWindow()</code></li>
- *   <li><code>clearDataAttributes()</code></li>
- *   <li><code>clearUseDownload()</code></li>
- *   <li><code>clearLang()</code></li>
- *   <li><code>clearHrefLang()</code></li>
- * </ul>Builds a html link based on current state.
- *
- * <p>
- * <em>Note!</em> The render method is not thread safe, see <a href="#threadnote">thread note above</a>.
- * </p>Sets what the link target is, i.e "what the link links to" (href attribute on the a element).
- * The target attribute is mandatory when the result is rendered.Sets what the link target is, i.e "what the link links to" (href attribute on the a element).
- * The target attribute is mandatory when the result is rendered.Checks if a Node is a renderable target or not (node type accepted).
- *
- * <p>
- *    This method can be used to avoid updating this renderer with nodes that can't be rendered. Since nodes that aren't
- *    renderable will be ignored, updating the renderer with such nodes will result in rendering of previous target.
- * </p>
- *
- * <p>
- *    <code>LinkRenderer</code> will accept nodes with the following primary node type as targets
- *    (i.e. this method will return <code>true</code> for such nodes):
- * </p>
- * <ul>
- *    <li><code>sv:article</code></li>
- *    <li><code>sv:collaborationGroup</code></li>
- *    <li><code>sv:collaborationGroupPage</code></li>
- *    <li><code>sv:collaborationGroupTemplate</code></li>
- *    <li><code>sv:file</code></li>
- *    <li><code>sv:image</code></li>
- *    <li><code>sv:link</code> <em>(the actual target of the link must also be a valid target)</em></li>
- *    <li><code>sv:page</code></li>
- *    <li><code>sv:sitePage</code></li>
- *    <li><code>sv:structureLink</code> <em>(the actual target of the structure link must also be a valid target)</em></li>
- *    <li><code>sv:structurePage</code></li>
- *    <li><code>sv:systemUser</code> <em>(the system user must have a mail address)</em></li>
- *    <li><code>sv:template</code></li>
- *    <li><code>sv:user</code> <em>(the user must have a mail address)</em></li>
- *    <li><code>sv:userIdentity</code> <em>(the site must have a profile page, or backing user must have a mail address)</em></li>
- * </ul>
- *
- * <p>
- * Always use this method if you are not sure all nodes you are rendering will be accepted as targets.
- * </p>
- *
- * <p>
- * <strong>Example:</strong><br>
- * Velocity code like this:
- * </p>
- * <pre><code>&lt;ul style="list-style:none"&gt;
- * #foreach ($node in $myNodes)
- *    <em>## Update the renderer and render</em>
- *    $linkRenderer.update($node)
- *    &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
- *#end
- *&lt;/ul&gt;</code></pre>
- * could be replaced with Velocity code like this:<pre><code>&lt;ul style="list-style:none"&gt;
- * #foreach ($node in $myNodes)
- *    <em>## Ensure node actually can be rendered</em>
- *    #if ($linkRenderer.isRenderableTarget($node))
- *       <em>## Update the renderer and render</em>
- *       $linkRenderer.update($node)
- *       &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
- *    #end
- * #end
- * &lt;/ul&gt;</code></pre>
- *
- * <p>
- *    <em>Performance note!</em> Calling this method prior to calling an <code>update</code> method (or the <code>setTarget</code> method)
- *    will not have any noticeable negative performance impact. The result of this method is internally cached and the <code>update</code>
- *    methods (and the <code>setTarget</code> method) will re-use that cached data.
- * </p>Checks if a Node is a valid target or not (node type accepted and target is valid).
- *
- * <p>
- * This method is similar to the {@link senselogic.sitevision.api.render.LinkRenderer#isRenderableTarget(javax.jcr.Node)} method,
- * but this method does more extensive checking to ensure rendered links will be ok. <em>Note! "External" link targets (e.g.
- * a link to "www.whatever.com") of a sv:link Node will NOT be checked.</em>
- * </p>
- * <p>
- * This method can be used to avoid updating this renderer with nodes that can't be rendered or nodes that have invalid targets.
- * An invalid target is typically an existing link that has an empty or trashed target (i.e. target is in trashcan).
- * </p>
- *
- * <p>
- * <strong>Example:</strong><br>
- * Velocity code like this:
  * </p>
- * <pre><code>&lt;ul style="list-style:none"&gt;
- * #foreach ($node in $myNodes)
- *    <em>## Update the renderer and render</em>
- *    $linkRenderer.update($node)
- *    &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
- *#end
- *&lt;/ul&gt;</code></pre>
- * could be replaced with Velocity code like this:<pre><code>&lt;ul style="list-style:none"&gt;
- * #foreach ($node in $myNodes)
- *    <em>## Ensure node actually can be rendered</em>
- *    #if ($linkRenderer.isValidTarget($node))
- *       <em>## Update the renderer and render</em>
- *       $linkRenderer.update($node)
- *       &lt;li&gt;$linkRenderer.render()&lt;/li&gt;
- *    #end
- * #end
- * &lt;/ul&gt;</code></pre>
- *
- * <p>
- * <em>Performance note!</em> Avoid subsequent calls to this method for same <code>Node</code>. If performance is a top
- * priority, consider using {@link senselogic.sitevision.api.render.LinkRenderer#isRenderableTarget(javax.jcr.Node)} instead.
- * </p>Sets the class name the link should use (class attribute on the a element).
- * The fontClass attribute is mandatory when the result is rendered.Sets the class name the link should use (class attribute on an a element) based on a given font node.
- *
- * <p>
- *    The actual font class is extracted from aFontNode and if aFontNode is <code>null</code> or not a valid font node the
- *    font class will not be set.
- * </p>
- * <p>
- *    When subsequently setting the font class, use the {@link #setFontClass(String)} method instead for best performance.
- * </p>Sets the text that the link should display, i.e. "the text the user clicks on".
- * The text attribute is mandatory when the result is rendered.Sets the title the link should have (title attribute on the a element).
- *
- * <p>
- * If there are no title (i.e. it is <code>null</code>) when the result is rendered, it will get the same
- * value as text attribute if autoTitle is activated, otherwise it will be empty. Default is <code>null</code>.
- * </p>Removes the title, i.e. executes <code>setTitle(null)</code>Sets the css style the link should have (style attribute on the a element).
- * The style attribute is optional when the result is rendered. Default is <code>null</code>.Removes the style, i.e executes <code>setStyle(null)</code>Sets the lang attribute on the a element (defines the language of the element).Removes the lang, i.e executes <code>setLang(null)</code>Sets the hreflang attribute on the a element (hints at the language of the linked resource).Removes the hreflang, i.e executes <code>setHrefLang(null)</code>Adds target parameters (key=value) to the link target (href attribute on the a element).
- *
- * <p>
- *    Target parameters is optional when the result is rendered. Default is no target parameters.
- * </p>
- * <p>
- *    There can only be one target parameter per key (i.e. when a target parameter is added it will always replace the possibly existing
- *    target parameter that already use that key).
- * </p>Removes all existing target parametersShould target parameters be URL encoded or not?
- * Default is <code>true</code>.Utility method for executing <code>setUseParameterEncoding(true)</code>Utility method for executing <code>setUseParameterEncoding(false)</code>Adds an HTML5 data-* attribute to the link element.
- * Data attributes is optional when the result is rendered. Default is no data attributes.
- * <p>
- *    There can only be one data attribute per name (i.e. when a data attribute is added it will always replace the possibly existing
- *    data attribute that already use that name).
- * </p>
- *
- * <p>
- *    Notes about names and values:
- * </p>
- * <ul>
- *    <li>
- *       A <strong>name</strong> that is <code>null</code> or <em>whitespace-only</em> will be completely ignored,
- *       i.e. no data attribute will be rendered.
- *    </li>
- *    <li>
- *       A <strong>name</strong> that isn't properly prefixed with <em>"data-"</em> will be prefixed when the data attribute is rendered.
- *    </li>
- *    <li>
- *       A <strong>value</strong> that is <code>null</code> or <em>whitespace-only</em> will be rendered as a data attribute without value.
- *    </li>
- *    <li>
- *       A <strong>value</strong> should not be escaped/encoded. The <em>useEncoding</em> attribute will determine what to do
- *       when the data attributes are rendered.
- * </ul>Removes all existing data attributesSets what access key the link should have (accesskey attribute on the a element)
- * The accesskey attribute is optional when the result is rendered. Default is <code>null</code>.Removes the accesskey, i.e. executes <code>setAccessKey(null)</code>Sets the rel that should be used (rel attribute on the a element)
- * The rel attribute is optional when the result is rendered. Default is <code>null</code>.Removes the rel value, i.e executes <code>setRel(null)</code>Sets the onclick value (onclick attribute and onkeypress attribute on the a element), typically some kind of Javascript
- * The onclick attribute is optional when the result is rendered. Default is <code>null</code>.
- *
- * <p><em>Note!</em> The events (onclick, onkeypress) will be added with non-obtrusive javascript when render() is called.</p>Removes the onclick value, i.e executes <code>setOnclick(null)</code>Sets the id value (id attribute on the a element), most likely only needed if some kind of javascript/ajax code needs to access the
- * rendered link via its id.
- *
- * <p>
- *    The id attribute is optional when the result is rendered. Default is <code>null</code>.
- * </p>
- * <p>
- *    This method does <em>not</em> perform any checks of the id. All values will be accepted.
- *    <em>(Note! A valid id should be unique - i.e. should not appear more than once in a html/xhtml document - and not all characters are allowed.
- *    See <a href="http://www.w3.org/TR/2006/REC-xml-20060816/#sec-attribute-types">W3C 3.3.1 Attribute types</a>.)</em>
- * </p>Removes the id value, i.e executes <code>setId(null)</code>Use icons for "external", "new window" and "new window, external" according to Site's settings or not.
- * Default is <code>true</code>.Utility method for executing <code>setUseLinkDecorationSettings(true)</code>Utility method for executing <code>setUseLinkDecorationSettings(false)</code>Use icons/descriptions for known file types according to Site's settings or not.
- * Default is <code>true</code>.Utility method for executing <code>setUseResourceDecorationSettings(true)</code>Utility method for executing <code>setUseResourceDecorationSettings(false)</code>Should the link target be opened in a new window or not?
- * Default is <code>false</code>.Utility method for executing <code>setOpenNewWindow(true)</code>Utility method for executing <code>setOpenNewWindow(false)</code>Should the browser download the link target instead of navigating to it?
- * Default is <code>false</code>.Utility method for executing <code>setUseDownload(true)</code>Utility method for executing <code>setUseDownload(false)</code>Should text and attributes be properly encoded or not?
- * Default is <code>true</code>.Utility method for executing <code>setUseEncoding(true)</code>Utility method for executing <code>setUseEncoding(false)</code>Ensures title always will have a value. If non-existing, the title will be set to the title of the target target (or
- * the same as the linked text if the target isn't a page or the title of the page is lacking)
- * Default is <code>false</code>.Utility method for executing <code>setUseAutoTitle(true)</code>Utility method for executing <code>setUseAutoTitle(false)</code>Should cross-site internal Node links be handled or not?
- *
- * <p>
- *    Default is <code>false</code>.
- * </p>
- * <p>
- *    <em>Note! For best performance: enable only if your site actually contains internal links to
- *    pages on other sites (e.g. The System user creates an internal link and selects a page
- *    on another site in the target browse tree).</em>
- * </p>Utility method for executing <code>setUseCrossSiteTargetChecking(true)</code>Utility method for executing <code>seUseCrossSiteTargetChecking(false)</code>
  * @author Magnus Lövgren
  */
-declare namespace LinkRenderer {
+declare namespace linkRenderer {
   export {
     update,
     updateClean,
@@ -1154,4 +948,4 @@ declare namespace LinkRenderer {
   };
 }
 
-export default LinkRenderer;
+export default linkRenderer;

package/server/LinkRenderer/index.js

@@ -0,0 +1,64 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  update: function update() {},
+  updateClean: function updateClean() {},
+  clearAllOptional: function clearAllOptional() {},
+  render: function render() {},
+  setTarget: function setTarget() {},
+  setStringTarget: function setStringTarget() {},
+  isRenderableTarget: function isRenderableTarget() {},
+  isValidTarget: function isValidTarget() {},
+  setFontClass: function setFontClass() {},
+  setFont: function setFont() {},
+  setText: function setText() {},
+  setTitle: function setTitle() {},
+  removeTitle: function removeTitle() {},
+  setStyle: function setStyle() {},
+  clearStyle: function clearStyle() {},
+  setLang: function setLang() {},
+  clearLang: function clearLang() {},
+  setHrefLang: function setHrefLang() {},
+  clearHrefLang: function clearHrefLang() {},
+  addTargetParameter: function addTargetParameter() {},
+  clearTargetParameters: function clearTargetParameters() {},
+  setUseParameterEncoding: function setUseParameterEncoding() {},
+  forceUseParameterEncoding: function forceUseParameterEncoding() {},
+  clearUseParameterEncoding: function clearUseParameterEncoding() {},
+  addDataAttribute: function addDataAttribute() {},
+  clearDataAttributes: function clearDataAttributes() {},
+  setAccessKey: function setAccessKey() {},
+  clearAccessKey: function clearAccessKey() {},
+  setRel: function setRel() {},
+  clearRel: function clearRel() {},
+  setOnclick: function setOnclick() {},
+  clearOnclick: function clearOnclick() {},
+  setId: function setId() {},
+  clearId: function clearId() {},
+  setUseLinkDecorationSettings: function setUseLinkDecorationSettings() {},
+  forceUseLinkDecorationSettings: function forceUseLinkDecorationSettings() {},
+  clearUseLinkDecorationSettings: function clearUseLinkDecorationSettings() {},
+  setUseResourceDecorationSettings: function setUseResourceDecorationSettings() {},
+  forceUseResourceDecorationSettings: function forceUseResourceDecorationSettings() {},
+  clearUseResourceDecorationSettings: function clearUseResourceDecorationSettings() {},
+  setOpenNewWindow: function setOpenNewWindow() {},
+  forceOpenNewWindow: function forceOpenNewWindow() {},
+  clearOpenNewWindow: function clearOpenNewWindow() {},
+  setUseDownload: function setUseDownload() {},
+  forceUseDownload: function forceUseDownload() {},
+  clearUseDownload: function clearUseDownload() {},
+  setUseEncoding: function setUseEncoding() {},
+  forceUseEncoding: function forceUseEncoding() {},
+  clearUseEncoding: function clearUseEncoding() {},
+  setUseAutoTitle: function setUseAutoTitle() {},
+  forceUseAutoTitle: function forceUseAutoTitle() {},
+  clearUseAutoTitle: function clearUseAutoTitle() {},
+  setUseCrossSiteTargetChecking: function setUseCrossSiteTargetChecking() {},
+  forceUseCrossSiteTargetChecking: function forceUseCrossSiteTargetChecking() {},
+  clearUseCrossSiteTargetChecking: function clearUseCrossSiteTargetChecking() {}
+};
+exports["default"] = _default;

package/server/LinkTargetBuilder/index.d.ts

@@ -1,5 +1,7 @@
 import Node from "../../hidden/javax/jcr/Node";
+
 import LinkTarget from "../../hidden/senselogic/sitevision/api/webresource/LinkTarget";
+import Builder from "../../hidden/senselogic/sitevision/api/base/Builder";
 
 /**
  * Sets the target.
@@ -119,19 +121,12 @@ export function build(): LinkTarget;
  *    {@link senselogic.sitevision.api.webresource.WebResourceFactory#getLinkTargetBuilder()}.
  *    See {@link senselogic.sitevision.api.webresource.WebResourceFactory} for how to obtain an instance of the
  *    <code>WebResourceFactory</code> interface.
- * </p>Sets the target.Sets the target.Sets the target.Sets the target.Sets the description.Sets open in new window.Creates a LinkTarget instance using current state of this builder.
- *
- * <p>
- *    <em>
- *       Note! The 'open in new window' state is ignored when creating a LinkTarget with
- *       a mail or telephone target (these target types can never be opened in a new window).
- *    </em>
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 4.2
  * @see senselogic.sitevision.api.webresource.LinkPageUtil
  */
-declare namespace LinkTargetBuilder {
+declare namespace linkTargetBuilder {
   export {
     setInternalTarget,
     setExternalTarget,
@@ -143,4 +138,4 @@ declare namespace LinkTargetBuilder {
   };
 }
 
-export default LinkTargetBuilder;
+export default linkTargetBuilder;

package/server/LinkTargetBuilder/index.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  setInternalTarget: function setInternalTarget() {},
+  setExternalTarget: function setExternalTarget() {},
+  setMailTarget: function setMailTarget() {},
+  setPhoneTarget: function setPhoneTarget() {},
+  setDescription: function setDescription() {},
+  setOpenInNewWindow: function setOpenInNewWindow() {},
+  build: function build() {}
+};
+exports["default"] = _default;

package/server/LinkValueBuilder/index.d.ts

@@ -1,5 +1,7 @@
 import Node from "../../hidden/javax/jcr/Node";
+
 import LinkValue from "../../hidden/senselogic/sitevision/api/metadata/value/LinkValue";
+import Builder from "../../hidden/senselogic/sitevision/api/base/Builder";
 
 /**
  * Sets the target.
@@ -121,11 +123,11 @@ export function build(): LinkValue;
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link senselogic.sitevision.api.metadata.MetadataUtil#getLinkValueBuilder()}.
  *    See {@link senselogic.sitevision.api.metadata.MetadataUtil} for how to obtain an instance of the <code>MetadataUtil</code> interface.
- * </p>Sets the target.Sets the target.Sets the target.Sets the target.Sets the link name.Sets the link description.Sets open in new window.Creates a LinkValue instance using current state of this builder.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace LinkValueBuilder {
+declare namespace linkValueBuilder {
   export {
     setExternalTarget,
     setMailTarget,
@@ -138,4 +140,4 @@ declare namespace LinkValueBuilder {
   };
 }
 
-export default LinkValueBuilder;
+export default linkValueBuilder;

package/server/LinkValueBuilder/index.js

@@ -5,13 +5,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  build: function build() {},
-  setDescription: function setDescription() {},
   setExternalTarget: function setExternalTarget() {},
-  setInternalTarget: function setInternalTarget() {},
   setMailTarget: function setMailTarget() {},
+  setPhoneTarget: function setPhoneTarget() {},
+  setInternalTarget: function setInternalTarget() {},
   setName: function setName() {},
+  setDescription: function setDescription() {},
   setOpenInNewWindow: function setOpenInNewWindow() {},
-  setPhoneTarget: function setPhoneTarget() {}
+  build: function build() {}
 };
 exports["default"] = _default;

package/server/ListWrapper/index.d.ts

@@ -1,3 +1,5 @@
+import Wrapper from "../../hidden/senselogic/sitevision/api/base/Wrapper";
+
 /**
  * Appends the specified element (if non-null) to the end of the wrapped list.
  *
@@ -72,7 +74,7 @@ export function sort(aComparator: unknown): void;
  * Returns the wrapped List.
  * @return the List wrapped by this ListWrapper
  */
-export function unwrap(): unknown[];
+export function unwrap(): unknown;
 
 /**
  * An convenience <code>java.util.List</code> wrapper that delegates method calls to the wrapped list.
@@ -138,23 +140,11 @@ export function unwrap(): unknown[];
  * <p>
  *    An instance of the Sitevision class implementing this interface can be obtained via {@link InstanceCreatorUtil#getListWrapper()}.
  *    See {@link InstanceCreatorUtil} for how to obtain an instance of the <code>InstanceCreatorUtil</code> interface.
- * </p>Appends the specified element (if non-null) to the end of the wrapped list.
- *
- * <p>
- *    <strong>Important!</strong> Null values in lists are inherently bad. This method will <strong>not</strong>
- *    delegate any <code>null</code> to the wrapped list.
- *    If you <em>must</em> add a <code>null</code> value, you can explicitly do it to the wrapped list, i.e:
  * </p>
- * <pre><code>
- *    #set ($myList = $instanceCreatorUtil.listWrapper)
- *    ...
- *    $myList.add($anObject.aMethod())          <em>## Will only delegate non-nulls to the wrapped list</em>
- *    $myList.unwrap().add($anObject.aMethod()) <em>## Will add any value directly to the wrapped list</em>
- * </code></pre>Removes all of the elements from the wrapped list.Checks if the wrapped list contains a specified object.Returns the element at the specified position in the wrapped list.Whether or not the wrapped list is empty (contains no elements).Returns an iterator for the wrapped list.The size (number of elements) of the wrapped list.Returns an array containing all of the elements in the wrapped list.Sorts the wrapped list.Returns the wrapped List.
  * @author Magnus Lövgren
  * @since Sitevision 3.5
  */
-declare namespace ListWrapper {
+declare namespace listWrapper {
   export {
     add,
     clear,
@@ -169,4 +159,4 @@ declare namespace ListWrapper {
   };
 }
 
-export default ListWrapper;
+export default listWrapper;

package/server/ListWrapper/index.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  add: function add() {},
+  clear: function clear() {},
+  contains: function contains() {},
+  get: function get() {},
+  isEmpty: function isEmpty() {},
+  iterator: function iterator() {},
+  size: function size() {},
+  toArray: function toArray() {},
+  sort: function sort() {},
+  unwrap: function unwrap() {}
+};
+exports["default"] = _default;