@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/server/MessageDigesterFactory/index.d.ts

@@ -0,0 +1,49 @@
+import MessageDigester from "../../hidden/senselogic/sitevision/api/security/MessageDigester";
+
+/**
+ * Gets an instanceof a message digester that performs hash computation using the MD5 algorithm.
+ * @return a MD5 message digester
+ */
+export function getMD5(): MessageDigester;
+
+/**
+ * Gets an instanceof a message digester that performs hash computation using the SHA-1 algorithm.
+ * @return a SHA-1 message digester
+ */
+export function getSHA1(): MessageDigester;
+
+/**
+ * Gets an instanceof a message digester that performs hash computation using the SHA-256 algorithm.
+ * @return a SHA-256 message digester
+ */
+export function getSHA256(): MessageDigester;
+
+/**
+ * Gets an instanceof a message digester that performs hash computation using the SHA-512 algorithm.
+ * @return a SHA-512 message digester
+ */
+export function getSHA512(): MessageDigester;
+
+/**
+ * Factory that provides message digester instances that can perform
+ * hash computation using a specific algorithm.
+ *
+ * <p>
+ *    Message digests are secure one-way hash functions that take arbitrary-sized
+ *    data and output a fixed-length hash value. This factory provides instances
+ *    that supports common message digest algorithms, such as MD5 and SHA-256.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getMessageDigesterFactory()}. See {@link senselogic.sitevision.api.Utils}
+ *    for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Gets an instanceof a message digester that performs hash computation using the MD5 algorithm.Gets an instanceof a message digester that performs hash computation using the SHA-1 algorithm.Gets an instanceof a message digester that performs hash computation using the SHA-256 algorithm.Gets an instanceof a message digester that performs hash computation using the SHA-512 algorithm.
+ * @author Magnus Lövgren
+ * @since Sitevision 5.0.1
+ */
+declare namespace MessageDigesterFactory {
+  export { getMD5, getSHA1, getSHA256, getSHA512 };
+}
+
+export default MessageDigesterFactory;

package/server/MetadataDefinitionUtil/index.d.ts

@@ -0,0 +1,118 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Gets a metadata definition as a {@code Node} from a {@code Node}.
+ * @param aNode the {@code Node} that has a metadata definition
+ * @param aDefinitionName the name of the metadata definition
+ * @return the value for {@code aDefinitionName} as a {@code Node}. If no definition exists or it is not a {@code Node}, {@code null} is returned.
+ */
+export function getDefinition(aNode: Node, aDefinitionName: string): Node;
+
+/**
+ * Gets a metadata definition as a {@code Node} from a {@code Node} with a fallback value if the definition does not exist.
+ * @param aNode the {@code Node} that has a metadata definition
+ * @param aDefinitionName the name of the metadata definition
+ * @param aDefaultValue fallback value if no definition exists
+ * @return the value for {@code aDefinitionName} as a {@code Node}. If no definition exists or it is not a {@code Node}, {@code aDefaultValue} is returned.
+ */
+export function getDefinition(
+  aNode: Node,
+  aDefinitionName: string,
+  aDefaultValue: Node
+): Node;
+
+/**
+ * Gets all metadata definitions available for the current user on a {@code Node}
+ * @param aNode the {@code Node} that has a metadata definition
+ * @return a list of definitions on {@code aNode}, or empty list
+ * @since Sitevision 4.2.3
+ */
+export function getDefinitions(aNode: Node): unknown[];
+
+/**
+ * Add an alternative to a definition
+ * @param aNode the {@code Node} where the metadata definition is located
+ * @param aDefinitionName the name of the metadata definition. May not be <code>null</code> or whitespace only
+ * @param aAlternativeName the name of the alternative (case in-sensitive). May not be <code>null</code> or whitespace only
+ * @throws RepositoryException if {@code aNode} is invalid, if {@code aNode} does not have a metadata definition named {@code aDefinitionName}, if it already contains an alternative named {@code aAlternativeName}, or if something else goes wrong
+ * @since Sitevision 4.2.3
+ */
+export function addAlternative(
+  aNode: Node,
+  aDefinitionName: string,
+  aAlternativeName: string
+): void;
+
+/**
+ * Rename an alternative for a definition
+ * @param aNode the {@code Node} where the metadata definition is located
+ * @param aDefinitionName the name of the metadata definition. May not be <code>null</code> or whitespace only
+ * @param aAlternativeName the name of the alternative (case in-sensitive). May not be <code>null</code> or whitespace only
+ * @param aNewAlternativeName the new name of the alternative. May not be <code>null</code> or whitespace only
+ * @throws RepositoryException if {@code aNode} is invalid, if {@code aNode} does not have a metadata definition named {@code aDefinitionName}, if it does not contain an alternative named {@code aAlternativeName}, if it already contains an alternative named {@code aNewAlternativeName}, or if something else goes wrong
+ * @since Sitevision 8.1
+ */
+export function renameAlternative(
+  aNode: Node,
+  aDefinitionName: string,
+  aAlternativeName: string,
+  aNewAlternativeName: string
+): void;
+
+/**
+ * Remove an alternative from a definition
+ * @param aNode the {@code Node} where the metadata definition is located
+ * @param aDefinitionName the name of the metadata definition. May not be <code>null</code> or whitespace only
+ * @param aAlternativeName the name of the alternative (case in-sensitive). May not be <code>null</code> or whitespace only
+ * @throws RepositoryException if {@code aNode} is invalid, if {@code aNode} does not have a metadata definition named {@code aDefinitionName}, if it does not contain an alternative named {@code aAlternativeName}, or if something else goes wrong
+ * @since Sitevision 8.1
+ */
+export function removeAlternative(
+  aNode: Node,
+  aDefinitionName: string,
+  aAlternativeName: string
+): void;
+
+/**
+ * Utility interface for getting metadata definitions.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getMetadataDefinitionUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ *
+ * <p>
+ *    <strong>Velocity example:</strong> This code gets all properties and nodes for a metadata definition named 'aMetadataName'.
+ * </p>
+ *
+ * <pre><code>
+ *   #set ($page = ...)
+ *
+ *   #set ($definitionUtil = $sitevisionUtils.metadataDefinitionUtil)
+ *   #set($definition = $definitionUtil.getDefinition($page, 'aMetadataName'))
+ *
+ *   #set($nodes = $definition.getNodes())
+ *   #foreach($node in $nodes)
+ *      $node
+ *   #end
+ *
+ *   #set($properties = $definition.getProperties())
+ *   #foreach($property in $properties)
+ *      $property
+ *   #end
+ * </code></pre>Gets a metadata definition as a {@code Node} from a {@code Node}.Gets a metadata definition as a {@code Node} from a {@code Node} with a fallback value if the definition does not exist.Gets all metadata definitions available for the current user on a {@code Node}Add an alternative to a definitionRename an alternative for a definitionRemove an alternative from a definition
+ * @author Daniel Pyykkö
+ * @since Sitevision 2.6.2_04
+ */
+declare namespace MetadataDefinitionUtil {
+  export {
+    getDefinition,
+    getDefinitions,
+    addAlternative,
+    renameAlternative,
+    removeAlternative,
+  };
+}
+
+export default MetadataDefinitionUtil;