@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/server/TemplateUtil/index.d.ts

@@ -0,0 +1,217 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Gets first found template with a given name.
+ *
+ * <p>
+ *    <strong>Note!</strong> This methods returns the first matching template - regardless of its <em>type/state</em>.
+ *    It might be a <em>collaboration group template</em>, it might be a <em>page template</em> that can be used to create pages/articles of
+ *    and it might be a template that is a <em>sub-template</em> (i.e. a template that only can be used by other templates).
+ * </p>
+ * <ul>
+ *    <li>
+ *       Use {@link #getPageTemplateByName(String)} to get first <em>page template</em>.
+ *    </li>
+ *    <li>
+ *       Use {@link senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil#getCollaborationGroupTemplateByName(String)}
+ *       to get first <em>collaboration group template</em>.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    <em>Permission note!</em> Only the templates that current user has {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
+ *    on will be considered.
+ * </p>
+ * @param aTemplateName the name of the template
+ * @return the template, or <code>null</code> if indeterminable (e.g. no accessible template named <code>aTemplateName</code> could be found)
+ */
+export function getTemplateByName(aTemplateName: string): Node;
+
+/**
+ * Gets all templates.
+ *
+ * <p>
+ *    <strong>Note!</strong> This methods returns all templates - regardless of their <em>type/state</em>.
+ *    The result might contain <em>collaboration group templates</em>, it might contain <em>page templates</em> that can be used
+ *    to create pages/articles of and it might contain templates that are <em>sub-templates</em>
+ *    (i.e. templates that only can be used by other templates).
+ * </p>
+ * <ul>
+ *    <li>
+ *       Use {@link #getPageTemplates()} to get all <em>page templates</em>.
+ *    </li>
+ *    <li>
+ *       Use {@link senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil#getCollaborationGroupTemplates()}
+ *       to get all <em>collaboration group templates</em>.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    <em>Permission note!</em> The list will only contain page templates that current user has
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
+ * </p>
+ * @return all accessible templates, or empty list if there are no accessible page templates.
+ * @since Sitevision 4.1
+ */
+export function getTemplates(): unknown[];
+
+/**
+ * Gets first found page template with a given name.
+ *
+ * <p>
+ *    A <em>page template</em> is a <code>sv:template</code> that can be used to create pages/articles.
+ *    It typically contains one or more content areas.
+ * </p>
+ * <p>
+ *    <em>Permission note!</em> Only the page templates that current user has
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on will be considered.
+ * </p>
+ * @param aPageTemplateName the name of the page template
+ * @return the page template, or <code>null</code> if indeterminable (e.g. no accessible page template named <code>aPageTemplateName</code> could be found)
+ * @since Sitevision 4.1
+ */
+export function getPageTemplateByName(aPageTemplateName: string): Node;
+
+/**
+ * Gets the page templates.
+ *
+ * <p>
+ *    A <em>page template</em> is a <code>sv:template</code> that can be used to create pages/articles.
+ *    It typically contains one or more content areas.
+ * </p>
+ * <p>
+ *    <em>Permission note!</em> The list will only contain page templates that current user has
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
+ * </p>
+ * @return all accessible templates that can be used to create pages/articles, or empty list if there are no accessible page templates.
+ * @since Sitevision 4.1
+ */
+export function getPageTemplates(): unknown[];
+
+/**
+ * Whether or not a node is a page template.
+ *
+ * <p>
+ *    A <em>page template</em> is a <code>sv:template</code> that can be used to create pages/articles.
+ *    It typically contains one or more content areas.
+ * </p>
+ * @param aTemplate a template
+ * @return true if aTemplate can be used to create pages/articles, false otherwise
+ * @since Sitevision 4.1
+ */
+export function isPageTemplate(aTemplate: Node): boolean;
+
+/**
+ * Gets the names of the content areas in a template.
+ * @param aTemplate a template (sv:template or sv:collaborationGroupTemplate)
+ * @return the names of the content areas in aTemplate, or empty set
+ * @since Sitevision 4.1
+ */
+export function getContentAreaNames(aTemplate: Node): Set<unknown>;
+
+/**
+ * Template utility interface that primarily handles nodes with primary node type <code>sv:template</code>.
+ *
+ * <p>
+ *    Sitevision templates comes in different flavours:
+ * </p>
+ * <ul>
+ *    <li>
+ *       A <em>page template</em> is a <code>sv:template</code> that can be used to create a page/article.
+ *    </li>
+ *    <li>
+ *       A <em>sub template</em> is a <code>sv:template</code> that can only be used to create other templates.
+ *    </li>
+ *    <li>
+ *       A <em>collaboration group template</em> is a <code>sv:collaborationGroupTemplate</code> that can be used to create collaboration groups.
+ *    </li>
+ * </ul>
+ * <p>
+ *    <em>See method documentation to see what specific flavours each method supports.
+ *    Also see {@link senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil} when working with collaboration group templates.</em>
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getTemplateUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Gets first found template with a given name.
+ *
+ * <p>
+ *    <strong>Note!</strong> This methods returns the first matching template - regardless of its <em>type/state</em>.
+ *    It might be a <em>collaboration group template</em>, it might be a <em>page template</em> that can be used to create pages/articles of
+ *    and it might be a template that is a <em>sub-template</em> (i.e. a template that only can be used by other templates).
+ * </p>
+ * <ul>
+ *    <li>
+ *       Use {@link #getPageTemplateByName(String)} to get first <em>page template</em>.
+ *    </li>
+ *    <li>
+ *       Use {@link senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil#getCollaborationGroupTemplateByName(String)}
+ *       to get first <em>collaboration group template</em>.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    <em>Permission note!</em> Only the templates that current user has {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
+ *    on will be considered.
+ * </p>Gets all templates.
+ *
+ * <p>
+ *    <strong>Note!</strong> This methods returns all templates - regardless of their <em>type/state</em>.
+ *    The result might contain <em>collaboration group templates</em>, it might contain <em>page templates</em> that can be used
+ *    to create pages/articles of and it might contain templates that are <em>sub-templates</em>
+ *    (i.e. templates that only can be used by other templates).
+ * </p>
+ * <ul>
+ *    <li>
+ *       Use {@link #getPageTemplates()} to get all <em>page templates</em>.
+ *    </li>
+ *    <li>
+ *       Use {@link senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil#getCollaborationGroupTemplates()}
+ *       to get all <em>collaboration group templates</em>.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    <em>Permission note!</em> The list will only contain page templates that current user has
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
+ * </p>Gets first found page template with a given name.
+ *
+ * <p>
+ *    A <em>page template</em> is a <code>sv:template</code> that can be used to create pages/articles.
+ *    It typically contains one or more content areas.
+ * </p>
+ * <p>
+ *    <em>Permission note!</em> Only the page templates that current user has
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on will be considered.
+ * </p>Gets the page templates.
+ *
+ * <p>
+ *    A <em>page template</em> is a <code>sv:template</code> that can be used to create pages/articles.
+ *    It typically contains one or more content areas.
+ * </p>
+ * <p>
+ *    <em>Permission note!</em> The list will only contain page templates that current user has
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
+ * </p>Whether or not a node is a page template.
+ *
+ * <p>
+ *    A <em>page template</em> is a <code>sv:template</code> that can be used to create pages/articles.
+ *    It typically contains one or more content areas.
+ * </p>Gets the names of the content areas in a template.
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.1_04
+ * @see senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil
+ */
+declare namespace TemplateUtil {
+  export {
+    getTemplateByName,
+    getTemplates,
+    getPageTemplateByName,
+    getPageTemplates,
+    isPageTemplate,
+    getContentAreaNames,
+  };
+}
+
+export default TemplateUtil;

package/server/TemporaryFileNodeBuilder/index.d.ts

@@ -0,0 +1,63 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * 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
+ */
+export function setFileName(aFileName: string): TemporaryFileNodeBuilder;
+
+/**
+ * Sets the file.
+ * @param aFile the file
+ * @return this builder
+ */
+export function setFile(aFile: unknown): 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
+ */
+export function build(): Node;
+
+/**
+ * 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>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>Sets the file.Creates a volatile and short-lived temporary file node using current state.
+ * @author Magnus Lövgren
+ * @since Sitevision 4.5.4
+ */
+declare namespace TemporaryFileNodeBuilder {
+  export { setFileName, setFile, build };
+}
+
+export default TemporaryFileNodeBuilder;

package/server/TemporaryNodeBuilder/index.d.ts

@@ -0,0 +1,241 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Sets the name of the temporary node that can be built by this builder.
+ * @param aNodeName the name of the node
+ * @return this builder
+ */
+export function setName(aNodeName: 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
+ */
+export function addStringProperty(
+  aName: string,
+  aString: 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
+ */
+export function addDateProperty(
+  aName: string,
+  aDate: unknown
+): 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
+ */
+export function addCalendarProperty(
+  aName: string,
+  aCalendar: unknown
+): 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
+ */
+export function addBooleanProperty(
+  aName: 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
+ */
+export function addIntProperty(
+  aName: string,
+  aInt: number
+): 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
+ */
+export function addLongProperty(
+  aName: string,
+  aLong: number
+): 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
+ */
+export function addDoubleProperty(
+  aName: string,
+  aDouble: number
+): 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
+ */
+export function addNumericProperty(
+  aName: string,
+  aNumber: 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
+ */
+export function addNodeProperty(
+  aName: 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
+ */
+export function 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
+ */
+export function build(): Node;
+
+/**
+ * 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>Sets the name of the temporary node that can be built by this builder.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>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>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>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>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>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>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>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>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>Clears the state of this builder.
+ *
+ * <p>
+ *    This method will set the name to <code>null</code> and remove all properties.
+ * </p>Creates a volatile and short-lived temporary node using current state (name and properties).
+ * @author Magnus Lövgren
+ * @since Sitevision 4.1.2
+ */
+declare namespace TemporaryNodeBuilder {
+  export {
+    setName,
+    addStringProperty,
+    addDateProperty,
+    addCalendarProperty,
+    addBooleanProperty,
+    addIntProperty,
+    addLongProperty,
+    addDoubleProperty,
+    addNumericProperty,
+    addNodeProperty,
+    clearAll,
+    build,
+  };
+}
+
+export default TemporaryNodeBuilder;

package/server/TextModuleRendererBuilder/index.d.ts

@@ -0,0 +1,68 @@
+import Node from "../../hidden/javax/jcr/Node";
+import TextModuleRenderer from "../../hidden/senselogic/sitevision/api/render/TextModuleRenderer";
+
+/**
+ * Sets the page of this builder.
+ * @param aPageNode a page (sv:page, sv:article, sv:sitePage)
+ * @return this builder
+ */
+export function setPage(aPageNode: Node): TextModuleRendererBuilder;
+
+/**
+ * Creates a TextModuleRenderer instance for the page of this builder.
+ * @return a Text module renderer instance
+ * @throws IllegalStateException if no valid page is set
+ */
+export function build(): TextModuleRenderer;
+
+/**
+ * <p>
+ *    Builder for creating a {@link TextModuleRenderer} instance.
+ * </p>
+ *
+ * <p>
+ *    TextModuleRendererBuilder has one <strong>mandatory attribute</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>page</em> - The page (sv:page, sv:article, sv:sitePage) where the Text modules to render resides. Must be non-null.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    Using the TextModuleRendererBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
+ *    would typically use it like this:
+ * </p>
+ * <ol>
+ *   <li>Get the TextModuleRendererBuilder</li>
+ *   <li>Set the page</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    When you have built a <code>TextModuleRenderer</code> instance, you can re-use the TextModuleRendererBuilder to build more instances.
+ *    Typically like:
+ * </p>
+ * <ol>
+ *   <li>Set the page</li>
+ *   <li>Do build</li>
+ * </ol>
+ *
+ * <p>
+ *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *    more information about Builders and how to work with them and {@link TextModuleRenderer} has a code example of how
+ *    this builder and its result can be used.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getTextModuleRendererBuilder()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>TextModuleRendererBuilder</code> interface.
+ * </p>Sets the page of this builder.Creates a TextModuleRenderer instance for the page of this builder.
+ * @author Magnus Lövgren
+ * @since Sitevision 7
+ */
+declare namespace TextModuleRendererBuilder {
+  export { setPage, build };
+}
+
+export default TextModuleRendererBuilder;