@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/server/RedirectUtil/index.d.ts

@@ -0,0 +1,98 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Gets all 301 redirect URIs registered for a specific node.
+ * @param aNode a node, typically a <code>sv:page</code>
+ * @return a set of 301 redirect URIs for <code>aNode</code>, never <code>null</code>
+ */
+export function getRedirectURIs(aNode: Node): Set<unknown>;
+
+/**
+ * Adds a relative URI that should trigger a 301 redirect to a specific node.
+ *
+ * <p>
+ *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+ * </p>
+ * @param aNode a node, typically a <code>sv:page</code>
+ * @param aRelativeURI the relative URI that should trigger a 301 redirect to <code>aNode</code>.
+ * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
+ * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+ */
+export function addRedirectURI(aNode: Node, aRelativeURI: string): void;
+
+/**
+ * Adds a collection of relative URIs that should trigger 301 redirects to a specific node.
+ *
+ * <p>
+ *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+ * </p>
+ * @param aNode a node, typically a <code>sv:page</code>
+ * @param aRelativeURIs a collection of relative URIs that should trigger 301 redirects to <code>aNode</code>.
+ * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, empty or doesn't contain any non-whitespace only or an non-absolute URI.
+ * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+ */
+export function addRedirectURIs(aNode: Node, aRelativeURIs: unknown): void;
+
+/**
+ * Removes a relative 301 redirect URI from a specific node.
+ *
+ * <p>
+ *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+ * </p>
+ * @param aNode a node, typically a <code>sv:page</code>
+ * @param aRelativeURI the relative URI that should be removed from <code>aNode</code>.
+ * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
+ * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+ */
+export function removeRedirectURI(aNode: Node, aRelativeURI: string): void;
+
+/**
+ * Removes all relative 301 redirect URIs from a specific node.
+ *
+ * <p>
+ *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+ * </p>
+ * @param aNode a node, typically a <code>sv:page</code>
+ * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node,
+ * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+ */
+export function removeAllRedirectURIs(aNode: Node): void;
+
+/**
+ * Redirect utility interface (301 redirects for <em>"old urls"</em>).
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getRedirectUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Gets all 301 redirect URIs registered for a specific node.Adds a relative URI that should trigger a 301 redirect to a specific node.
+ *
+ * <p>
+ *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+ * </p>Adds a collection of relative URIs that should trigger 301 redirects to a specific node.
+ *
+ * <p>
+ *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+ * </p>Removes a relative 301 redirect URI from a specific node.
+ *
+ * <p>
+ *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+ * </p>Removes all relative 301 redirect URIs from a specific node.
+ *
+ * <p>
+ *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.0.3
+ */
+declare namespace RedirectUtil {
+  export {
+    getRedirectURIs,
+    addRedirectURI,
+    addRedirectURIs,
+    removeRedirectURI,
+    removeAllRedirectURIs,
+  };
+}
+
+export default RedirectUtil;

package/server/RelatedValueBuilder/index.d.ts

@@ -1,48 +1,90 @@
-/**
-* A temporary representation of a link metadata value.
-*/
-interface LinkValue {}
+import LinkValue from "../../hidden/senselogic/sitevision/api/metadata/value/LinkValue";
+import Node from "../../hidden/javax/jcr/Node";
+import RelatedValue from "../../hidden/senselogic/sitevision/api/metadata/value/RelatedValue";
 
 /**
-* A temporary representation of a related metadata value.
-*/
-interface RelatedValue {}
+ * Adds a link value.
+ * @param aLinkValue the link value to add
+ * @return this builder
+ * @throws IllegalArgumentException if <code>aLinkValue</code> is <code>null</code> or not an instance created via {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder}
+ */
+export function addLinkValue(aLinkValue: LinkValue): RelatedValueBuilder;
 
-export interface RelatedValueBuilder {
-  /**
-  * Adds a link value.
-  * @returns {RelatedValueBuilder} this builder 
-  * @param {LinkValue} aLinkValue - the link value to add
-  */
-  addLinkValue(aLinkValue: LinkValue): RelatedValueBuilder;
+/**
+ * Adds a user value.
+ * @param aUserNode the user node to add (a node with primary node type <em>sv:user</em> or <em>sv:simpleUser</em>)
+ * @return this builder
+ * @throws IllegalArgumentException if <code>aUserNode</code> is <code>null</code> or an invalid user node (e.g. sv:systemUser - <em>Anonymous</em>, <em>System</em>, <em>Indexer</em>, <em>Validator</em> or <em>Extractor</em>)
+ */
+export function addUser(aUserNode: Node): RelatedValueBuilder;
 
-  /**
-  * Adds a text value.
-  * @returns {RelatedValueBuilder} this builder 
-  * @param {string} aText - the text to add. A null or whitespace-only value will be completely ignored.
-  */
-  addText(aText: string): RelatedValueBuilder;
+/**
+ * Adds a text value.
+ * @param aText the text to add. A <code>null</code> or whitespace-only value will be completely ignored.
+ * @return this builder
+ */
+export function addText(aText: string): RelatedValueBuilder;
 
-  /**
-  * Adds a user value.
-  * @returns {RelatedValueBuilder} this builder 
-  * @param {Node} aUserNode - the user node to add (a node with primary node type sv:user or sv:simpleUser)
-  */
-  addUser(aUserNode: Node): RelatedValueBuilder;
+/**
+ * Removes all currently added values.
+ * @return this builder
+ */
+export function clearValues(): RelatedValueBuilder;
 
-  /**
-  * Creates a RelatedValue instance using current state of this builder.
-  * @returns {RelatedValue} a related value 
-  */
-  build(): RelatedValue;
+/**
+ * Creates a RelatedValue instance using current state of this builder.
+ * @return a related value
+ * @throws IllegalStateException if the builder contains no values.
+ */
+export function build(): RelatedValue;
 
-  /**
-  * Removes all currently added values.
-  * @returns {RelatedValueBuilder} this builder 
-  */
-  clearValues(): RelatedValueBuilder;
+/**
+ * Builder to create RelatedValue instances that can be used to set related metadata.
+ *
+ * <p>
+ *    RelatedValueBuilder has one <strong>mandatory attribute</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>values</em> - The related values. Must be non-empty.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    Using the RelatedValueBuilder 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 RelatedValueBuilder</li>
+ *   <li>Add a value</li>
+ *   <li>Possibly add more values</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    When you have built a <code>RelatedValue</code> instance, you can re-use the RelatedValueBuilder to build more instances. Something like:
+ * </p>
+ * <ol>
+ *   <li>Clear values</li>
+ *   <li>Add a value</li>
+ *   <li>Possibly add more values</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!
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.metadata.MetadataUtil#getRelatedValueBuilder()}.
+ *    See {@link senselogic.sitevision.api.metadata.MetadataUtil} for how to obtain an instance of the <code>MetadataUtil</code> interface.
+ * </p>Adds a link value.Adds a user value.Adds a text value.Removes all currently added values.Creates a RelatedValue instance using current state of this builder.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+declare namespace RelatedValueBuilder {
+  export { addLinkValue, addUser, addText, clearValues, build };
 }
 
-const relatedValueBuilder: RelatedValueBuilder;
-export default relatedValueBuilder;
-
+export default RelatedValueBuilder;