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

package/server/TemplateUtil/index.d.ts

@@ -1,114 +1,5 @@
 import type { Node } from "../../types/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): unknown;
-
 /**
  * Template utility interface that primarily handles nodes with primary node type <code>sv:template</code>.
  *
@@ -139,15 +30,119 @@ export function getContentAreaNames(aTemplate: Node): unknown;
  * @since Sitevision 2.6.1_04
  * @see senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil
  */
-declare namespace templateUtil {
-  export {
-    getTemplateByName,
-    getTemplates,
-    getPageTemplateByName,
-    getPageTemplates,
-    isPageTemplate,
-    getContentAreaNames,
-  };
+export interface TemplateUtil {
+  /**
+   * 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)
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  getContentAreaNames(aTemplate: Node): unknown;
 }
 
+declare namespace TemplateUtil {}
+
+declare var templateUtil: TemplateUtil;
+
 export default templateUtil;

package/server/TemporaryFileNodeBuilder/index.d.ts

@@ -1,31 +1,6 @@
 import type { Node } from "../../types/javax/jcr/Node";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * 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>.
  *
@@ -53,8 +28,35 @@ export function build(): Node;
  * @author Magnus Lövgren
  * @since Sitevision 4.5.4
  */
-declare namespace temporaryFileNodeBuilder {
-  export { setFileName, setFile, build };
+export interface TemporaryFileNodeBuilder extends Builder {
+  /**
+   * 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: string): TemporaryFileNodeBuilder;
+
+  /**
+   * Sets the file.
+   * @param aFile the file
+   * @return this builder
+   */
+  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
+   */
+  build(): Node;
 }
 
+declare namespace TemporaryFileNodeBuilder {}
+
+declare var temporaryFileNodeBuilder: TemporaryFileNodeBuilder;
+
 export default temporaryFileNodeBuilder;

package/server/TemporaryNodeBuilder/index.d.ts

@@ -1,165 +1,6 @@
 import type { Node } from "../../types/javax/jcr/Node";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * 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>.
  *
@@ -182,21 +23,142 @@ export function build(): Node;
  * @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 interface TemporaryNodeBuilder extends Builder {
+  /**
+   * 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: 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: 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
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  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;
 }
 
+declare namespace TemporaryNodeBuilder {}
+
+declare var temporaryNodeBuilder: TemporaryNodeBuilder;
+
 export default temporaryNodeBuilder;

package/server/TextModuleRendererBuilder/index.d.ts

@@ -2,20 +2,6 @@ import type { Node } from "../../types/javax/jcr/Node";
 import type { TextModuleRenderer } from "../../types/senselogic/sitevision/api/render/TextModuleRenderer";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * 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.
@@ -62,8 +48,24 @@ export function build(): TextModuleRenderer;
  * @author Magnus Lövgren
  * @since Sitevision 7
  */
-declare namespace textModuleRendererBuilder {
-  export { setPage, build };
+export interface TextModuleRendererBuilder extends Builder {
+  /**
+   * Sets the page of this builder.
+   * @param aPageNode a page (sv:page, sv:article, sv:sitePage)
+   * @return this builder
+   */
+  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
+   */
+  build(): TextModuleRenderer;
 }
 
+declare namespace TextModuleRendererBuilder {}
+
+declare var textModuleRendererBuilder: TextModuleRendererBuilder;
+
 export default textModuleRendererBuilder;