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

package/hidden/senselogic/sitevision/api/node/builder/CompoundOrFilterBuilder/index.d.ts

@@ -1,53 +0,0 @@
-import Filter from "../../../base/Filter";
-import Builder from "../../../base/Builder";
-
-/**
- * Builds a compound filter that requires that <em>any</em> of the added filters matches.
- *
- * <p>
- *    <em>How a compound OR filter works:</em> If filter <em>A</em> and filter <em>B</em> is added to this builder,
- *    then the accept method of the built filter will return the result of the logical boolean evaluation of: <em>A.accept OR B.accept</em>.
- * </p>
- * <ul>
- *    <li>
- *       See {@link senselogic.sitevision.api.node.NodeFilterUtil} for an example of how to use a <code>CompoundOrFilterBuilder</code> in Velocity.
- *    </li>
- *    <li>
- *       See {@link senselogic.sitevision.api.base.Builder} for a comprehensive example of how to work with builders.
- *    </li>
- * </ul>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.node.NodeFilterUtil#getCompoundOrFilterBuilder()}.
- *    See {@link senselogic.sitevision.api.node.NodeFilterUtil} for how to obtain an instance of the <code>NodeFilterUtil</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6.2
- */
-
-interface CompoundOrFilterBuilder {
-  /**
-   * Adds a node filter to this builder.
-   *
-   * <p>
-   *    <em>Tip!</em> For best performance, it's likely a good idea to add the "cheapest" filter first!
-   * </p>
-   * @param aFilter the node filter to add, <code>null</code> will be ignored
-   * @return this builder
-   */
-  addFilter(aFilter: Filter): CompoundOrFilterBuilder;
-
-  /**
-   * Removes all previously added filters.
-   * @return this builder
-   */
-  clearFilters(): CompoundOrFilterBuilder;
-
-  /**
-   * Creates a node filter instance that will perform the <em>OR</em> operation for all currently specified filters.
-   * @return a node filter
-   * @throws IllegalStateException if this builder contains no filters.
-   */
-  build(): Filter;
-}

package/hidden/senselogic/sitevision/api/node/builder/TemporaryFileNodeBuilder/index.d.ts

@@ -1,57 +0,0 @@
-import Node from "../../../../../../javax/jcr/Node";
-import Builder from "../../../base/Builder";
-
-/**
- * Builds volatile and short-lived nodes with primary node type <em>sv:temporaryFile</em>.
- *
- * <p>
- *    The sole purpose of a <em>sv:temporaryFile</em> is to represent a <code>java.io.File</code> as <code>javax.jcr.Node</code>
- *    in order to support file-related operations in the API (e.g. {@link senselogic.sitevision.api.webresource.FileUtil}).
- * </p>
- *
- * <p>
- *    <strong>Important note!</strong> Temporary file nodes are very volatile and short-lived.
- *    They have no parent, nor any children.
- *    A temporary file node can never be looked up by its identifier and it should never be cached.
- *    Temporary file nodes should only be used for <em>temporary purposes</em>, typically during a single execution/render phase.
- * </p>
- *
- * <p>
- *    See {@link Builder} for a comprehensive example of how to work with builders.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.node.NodeFactoryUtil#getTemporaryFileNodeBuilder()}.
- *    See {@link senselogic.sitevision.api.node.NodeFactoryUtil} for how to obtain an instance of the <code>NodeFactoryUtil</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 4.5.4
- */
-
-interface TemporaryFileNodeBuilder {
-  /**
-   * Sets the name of the file.
-   *
-   * <p>
-   *    <em>The file name will also be used as the name of the Node that is built.</em>
-   * </p>
-   * @param aFileName the file name
-   * @return this builder
-   */
-  setFileName(aFileName: java.lang.String): TemporaryFileNodeBuilder;
-
-  /**
-   * Sets the file.
-   * @param aFile the file
-   * @return this builder
-   */
-  setFile(aFile: java.io.File): TemporaryFileNodeBuilder;
-
-  /**
-   * Creates a volatile and short-lived temporary file node using current state.
-   * @return a volatile and short-lived temporary file node
-   * @throws IllegalStateException if no file is set or no file name is set
-   */
-  build(): Node;
-}

package/hidden/senselogic/sitevision/api/node/builder/TemporaryNodeBuilder/index.d.ts

@@ -1,177 +0,0 @@
-import Node from "../../../../../../javax/jcr/Node";
-import Builder from "../../../base/Builder";
-
-/**
- * Builds volatile and short-lived nodes with primary node type <em>sv:temporaryNode</em>.
- *
- * <p>
- *    <strong>Important note!</strong> Temporary nodes are very volatile and short-lived.
- *    They have no parent, nor any children.
- *    A temporary node can never be looked up by its identifier and it should never be cached.
- *    Temporary nodes should only be used for <em>temporary purposes</em>, typically during a single rendering phase.
- * </p>
- *
- * <p>
- *    See {@link senselogic.sitevision.api.base.Builder} for a comprehensive example of how to work with builders.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.node.NodeFactoryUtil#getTemporaryNodeBuilder()}.
- *    See {@link senselogic.sitevision.api.node.NodeFactoryUtil} for how to obtain an instance of the <code>NodeFactoryUtil</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 4.1.2
- */
-
-interface TemporaryNodeBuilder {
-  /**
-   * Sets the name of the temporary node that can be built by this builder.
-   * @param aNodeName the name of the node
-   * @return this builder
-   */
-  setName(aNodeName: java.lang.String): TemporaryNodeBuilder;
-
-  /**
-   * Adds a String property to this builder.
-   *
-   * <p>
-   *    <em>Note!</em> Any previously added property with name <code>aName</code> will be overwritten with the value of this add operation.
-   * </p>
-   * @param aName the name of the property
-   * @param aString the property value
-   * @return this builder
-   */
-  addStringProperty(
-    aName: java.lang.String,
-    aString: java.lang.String
-  ): TemporaryNodeBuilder;
-
-  /**
-   * Adds a Date property to this builder.
-   *
-   * <p>
-   *    <em>Note!</em> Any previously added property with name <code>aName</code> will be overwritten with the value of this add operation.
-   * </p>
-   * @param aName the name of the property
-   * @param aDate the property value
-   * @return this builder
-   */
-  addDateProperty(
-    aName: java.lang.String,
-    aDate: java.util.Date
-  ): TemporaryNodeBuilder;
-
-  /**
-   * Adds a Calendar property to this builder.
-   *
-   * <p>
-   *    <em>Note!</em> Any previously added property with name <code>aName</code> will be overwritten with the value of this add operation.
-   * </p>
-   * @param aName the name of the property
-   * @param aCalendar the property value
-   * @return this builder
-   */
-  addCalendarProperty(
-    aName: java.lang.String,
-    aCalendar: java.util.Calendar
-  ): TemporaryNodeBuilder;
-
-  /**
-   * Adds a boolean property to this builder.
-   *
-   * <p>
-   *    <em>Note!</em> Any previously added property with name <code>aName</code> will be overwritten with the value of this add operation.
-   * </p>
-   * @param aName the name of the property
-   * @param aBoolean the property value
-   * @return this builder
-   */
-  addBooleanProperty(
-    aName: java.lang.String,
-    aBoolean: boolean
-  ): TemporaryNodeBuilder;
-
-  /**
-   * Adds a int property to this builder.
-   *
-   * <p>
-   *    <em>Note!</em> Any previously added property with name <code>aName</code> will be overwritten with the value of this add operation.
-   * </p>
-   * @param aName the name of the property
-   * @param aInt the property value
-   * @return this builder
-   */
-  addIntProperty(aName: java.lang.String, aInt: int): TemporaryNodeBuilder;
-
-  /**
-   * Adds a long property to this builder.
-   *
-   * <p>
-   *    <em>Note!</em> Any previously added property with name <code>aName</code> will be overwritten with the value of this add operation.
-   * </p>
-   * @param aName the name of the property
-   * @param aLong the property value
-   * @return this builder
-   */
-  addLongProperty(aName: java.lang.String, aLong: long): TemporaryNodeBuilder;
-
-  /**
-   * Adds a double property to this builder.
-   *
-   * <p>
-   *    <em>Note!</em> Any previously added property with name <code>aName</code> will be overwritten with the value of this add operation.
-   * </p>
-   * @param aName the name of the property
-   * @param aDouble the property value
-   * @return this builder
-   */
-  addDoubleProperty(
-    aName: java.lang.String,
-    aDouble: double
-  ): TemporaryNodeBuilder;
-
-  /**
-   * Adds a numeric property (typically: Integer, Long or Double) to this builder.
-   *
-   * <p>
-   *    <em>Note!</em> Any previously added property with name <code>aName</code> will be overwritten with the value of this add operation.
-   * </p>
-   * @param aName the name of the property
-   * @param aNumber the property value
-   * @return this builder
-   */
-  addNumericProperty(
-    aName: java.lang.String,
-    aNumber: java.lang.Number
-  ): TemporaryNodeBuilder;
-
-  /**
-   * Adds a Node property to this builder.
-   *
-   * <p>
-   *    <em>Note!</em> Any previously added property with name <code>aName</code> will be overwritten with the value of this add operation.
-   * </p>
-   * @param aName the name of the property
-   * @param aNode the property value
-   * @return this builder
-   */
-  addNodeProperty(aName: java.lang.String, aNode: Node): TemporaryNodeBuilder;
-
-  /**
-   * Clears the state of this builder.
-   *
-   * <p>
-   *    This method will set the name to <code>null</code> and remove all properties.
-   * </p>
-   * @return this builder
-   */
-  clearAll(): TemporaryNodeBuilder;
-
-  /**
-   * Creates a volatile and short-lived temporary node using current state (name and properties).
-   * @return a volatile and short-lived temporary node
-   * @throws IllegalStateException if no node name is set
-   */
-  build(): Node;
-}

package/hidden/senselogic/sitevision/api/property/OfflineVersionPropertyUtil/index.d.ts

@@ -1,31 +0,0 @@
-import VersionedPropertyUtil from "../VersionedPropertyUtil";
-
-/**
- * Utility interface for getting Node property values in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE_VERSION}.
- *
- * <p>
- *    <em><strong>Note!</strong> This is an exotic sibling interface to {@link PropertyUtil} that can be used to extract property values from the
- *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE_VERSION} - regardless of what version you are currently
- *    executing in. If you don't know what a version is or haven't thought much about it, you should typically use the common property extraction
- *    interface - {@link PropertyUtil}.</em>
- * </p>
- *
- * <p>
- *    See {@link senselogic.sitevision.api.property.VersionedPropertyUtil} for methods documentation and code examples.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getVersionedPropertyUtil(int)} using
- *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION} as argument.
- *    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
- * @see PropertyUtil
- * @see OnlineVersionPropertyUtil
- */
-
-interface OfflineVersionPropertyUtil {
-  undefined;
-}

package/hidden/senselogic/sitevision/api/property/OnlineVersionPropertyUtil/index.d.ts

@@ -1,31 +0,0 @@
-import VersionedPropertyUtil from "../VersionedPropertyUtil";
-
-/**
- * Utility interface for getting Node property values in the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION ONLINE_VERSION}.
- *
- * <p>
- *    <em><strong>Note!</strong> This is an exotic sibling interface to {@link PropertyUtil} that can be used to extract property values from the
- *    {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION ONLINE_VERSION} - regardless of what version you are currently
- *    executing in. If you don't know what a version is or haven't thought much about it, you should typically use the common property extraction
- *    interface - {@link PropertyUtil}.</em>
- * </p>
- *
- * <p>
- *    See {@link VersionedPropertyUtil} for methods documentation and code examples.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getVersionedPropertyUtil(int)} using
- *    {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION} as argument.
- *    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
- * @see PropertyUtil
- * @see OfflineVersionPropertyUtil
- */
-
-interface OnlineVersionPropertyUtil {
-  undefined;
-}

package/hidden/senselogic/sitevision/api/property/Properties/index.d.ts

@@ -1,176 +0,0 @@
-/**
- * Utility interface for getting multiple Node property values in server-side Javascript.
- *
- * <p>
- *    Extraction of property values from Nodes are typically performed using {@link PropertyUtil}
- *    but this utility is less obtrusive to work with in server-side script contexts (WebApps, RESTApps, Script module etc.).
- * </p>
- * <p>
- *    <strong>Property value types</strong><br>
- *    The value of a JCR Node property can be resolved as different types.
- *    For instance a property with primary type {@link javax.jcr.PropertyType#DATE} can be resolved as {@code Calendar} or as {@code String}.
- *    This utility returns values with a specific type:
- * </p>
- * <ul>
- *    <li>The numerical <em>timestamp</em> will be returned as value for properties of type {@link javax.jcr.PropertyType#DATE}.</li>
- *    <li>The Node <em>identifier</em> will be returned as value for properties of type {@link javax.jcr.PropertyType#WEAKREFERENCE}.</li>
- * </ul>
- *
- * <p>
- *    <strong>Example</strong><br>
- *    Below is an example that demonstrates the behaviour and usage of this utility.
- * </p><pre>   <strong>var</strong> properties = require('Properties');
- *   <em>...</em>
- *
- *   <em><strong>// get examples</strong></em>
- *
- *   <em>// Returns the identifier of the given Node, e.g: '4.540818ed12a6539aa3f80001645'</em>
- *   pageId = properties.get(pageNode);
- *
- *   <em>// Returns the URI property value of the given Node, e.g. '/4.540818ed12a6539aa3f80001645.html'</em>
- *   pageUri = properties.get(pageNode, 'URI');
- *
- *   <em>// Returns the displayName property value of the given Node, e.g. 'The page'</em>
- *   pageName = properties.get(pageNode, 'displayName');
- *   pageName = properties.get(pageId, 'displayName');
- *   pageName = properties.get(pageUri, 'displayName');
- *
- *   <em>// Returns a native script object with given properties (that exist) of the specified Node e.g:
- *   // {
- *   //    URI: '/4.540818ed12a6539aa3f80001645.html',
- *   //    displayName: 'The page',
- *   //    published: true,
- *   //    publishDate: 1227618333142
- *   // }</em>
- *   pageData = properties.get(pageNode, 'URI', 'displayName', 'published', 'publishDate', 'nameOfNonExistingProperty');
- *
- *   <em><strong>// getArray examples</strong></em>
- *
- *   <em>// Returns the identifier of the given Node as array, e.g: ['4.540818ed12a6539aa3f80001645']</em>
- *   pageIdArray = properties.getArray(pageNode);
- *
- *   <em>// Returns the identifier for the children of given Node as array, e.g:
- *   // [
- *   //    '19.540818ed12a6539aa3f80006889',
- *   //    '4.540818ed12a6539aa3f80001645_pageContent',
- *   //    ...
- *   // ]</em>
- *   childIdsArray = properties.getArray(pageNode.getNodes());
- *
- *   <em>// Returns the displayName for the nodes of a menu from a given Node as array, e.g:
- *   // [
- *   //    'The Page',
- *   //    'Another Page',
- *   //    ...
- *   // ]</em>
- *   menuNamesArray = properties.getArray(nodeIteratorUtil.getMenuItems(pageNode), 'displayName');
- *
- *   <em>// Returns the displayName and URI for the hits of a SearchResult as array, e.g:
- *   // [
- *   //    {
- *   //       displayName: 'Public API'
- *   //       URI: '/docs/public-api',
- *   //    },
- *   //    {
- *   //       displayName: 'REST API'
- *   //       URI: '/docs/rest-api',
- *   //    },
- *   //    ...
- *   // ]</em>
- *   hitsDataArray = properties.getArray(searchResult, 'displayName', 'URI');</pre>
- *
- * <p>
- *    <strong>Security reminder! All output should always be escaped to prevent XSS!</strong>
- * </p>
- * <ul>
- *    <li>
- *       When implementing a WebApp, you would typically use {@link #get(Object, String...)} or {@link #getArray(Object, String...)}
- *       and output the value with underscore escape (e.g. <code>&lt;%- theValueToEscape %&gt;</code>).
- *    </li>
- *    <li>
- *       In other server-side scripting contexts (e.g. the Script module) you would typically use {@link #getEscaped(Object, String...)} or
- *       {@link #getArrayEscaped(Object, String...)} and output the (already) escaped value using Velocity (e.g. <code>$theEscapedValue</code>).
- *    </li>
- * </ul>
- * @param <T> native script value
- * @author Magnus Lövgren
- * @since Sitevision 4.5.2
- */
-
-interface Properties {
-  /**
-   * Gets named properties from a given Node-resolvable object.
-   *
-   * <p>
-   *    <em>See code examples in the interface description above.</em>
-   * </p>
-   * @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
-   * @param aPropertyNames the names of the properties of interest
-   * @return the properties as a native Javascript object
-   * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
-   * @see #getEscaped(Object, String...)
-   */
-  get(
-    aJcrNodeResolvable: java.lang.Object,
-    aPropertyNames: java.lang.String
-  ): unknown;
-
-  /**
-   * Gets escaped named properties from a given Node-resolvable object.
-   *
-   * <p>
-   *    This method is equivalent with {@link #get(Object, String...)} except that all string values will be escaped.
-   * </p>
-   * @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
-   * @param aPropertyNames the names of the properties of interest
-   * @return the escaped properties as a native Javascript object
-   * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
-   * @since Sitevision 6.2
-   */
-  getEscaped(
-    aJcrNodeResolvable: java.lang.Object,
-    aPropertyNames: java.lang.String
-  ): unknown;
-
-  /**
-   * Processes an iterable object and returns an array of named properties for each Node-resolvable object that is iterated.
-   *
-   * <p>
-   *    This method is conceptually equivalent with the {@link #get(Object, String...) get} method but
-   *    the core functionality of this method is to process something that can be iterated in order to handle <em>multiple</em> nodes
-   *    and deliver properties for them as an array.
-   * </p>
-   *
-   * <p>
-   *    <em>See code examples in the interface description above.</em>
-   * </p>
-   * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
-   * @param aPropertyNames the names of the properties of interest
-   * @return a native Javascript array with properties
-   * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
-   * @see senselogic.sitevision.api.node.NodeIteratorUtil
-   * @see #getArrayEscaped(Object, String...)
-   * @since Sitevision 6.1
-   */
-  getArray(
-    aIterable: java.lang.Object,
-    aPropertyNames: java.lang.String
-  ): unknown;
-
-  /**
-   * Processes an iterable object and returns an array of escaped named properties for each Node-resolvable object that is iterated.
-   *
-   * <p>
-   *    This method is equivalent with {@link #getArray(Object, String...)} except that all string values will be escaped.
-   * </p>
-   * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
-   * @param aPropertyNames the names of the properties of interest
-   * @return a native Javascript array with escaped properties
-   * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
-   * @since Sitevision 6.2
-   */
-  getArrayEscaped(
-    aIterable: java.lang.Object,
-    aPropertyNames: java.lang.String
-  ): unknown;
-}