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

package/server/MessageDigesterFactory/index.d.ts

@@ -1,29 +1,5 @@
 import type { MessageDigester } from "../../types/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.
@@ -42,8 +18,34 @@ export function getSHA512(): MessageDigester;
  * @author Magnus Lövgren
  * @since Sitevision 5.0.1
  */
-declare namespace messageDigesterFactory {
-  export { getMD5, getSHA1, getSHA256, getSHA512 };
+export interface MessageDigesterFactory {
+  /**
+   * Gets an instanceof a message digester that performs hash computation using the MD5 algorithm.
+   * @return a MD5 message digester
+   */
+  getMD5(): MessageDigester;
+
+  /**
+   * Gets an instanceof a message digester that performs hash computation using the SHA-1 algorithm.
+   * @return a SHA-1 message digester
+   */
+  getSHA1(): MessageDigester;
+
+  /**
+   * Gets an instanceof a message digester that performs hash computation using the SHA-256 algorithm.
+   * @return a SHA-256 message digester
+   */
+  getSHA256(): MessageDigester;
+
+  /**
+   * Gets an instanceof a message digester that performs hash computation using the SHA-512 algorithm.
+   * @return a SHA-512 message digester
+   */
+  getSHA512(): MessageDigester;
 }
 
+declare namespace MessageDigesterFactory {}
+
+declare var messageDigesterFactory: MessageDigesterFactory;
+
 export default messageDigesterFactory;

package/server/MetadataDefinitionUtil/index.d.ts

@@ -1,78 +1,5 @@
 import type { Node } from "../../types/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.
  *
@@ -105,14 +32,83 @@ export function removeAlternative(
  * @author Daniel Pyykkö
  * @since Sitevision 2.6.2_04
  */
-declare namespace metadataDefinitionUtil {
-  export {
-    getDefinition,
-    getDefinitions,
-    addAlternative,
-    renameAlternative,
-    removeAlternative,
-  };
+export interface MetadataDefinitionUtil {
+  /**
+   * 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.
+   */
+  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.
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  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
+   */
+  removeAlternative(
+    aNode: Node,
+    aDefinitionName: string,
+    aAlternativeName: string
+  ): void;
 }
 
+declare namespace MetadataDefinitionUtil {}
+
+declare var metadataDefinitionUtil: MetadataDefinitionUtil;
+
 export default metadataDefinitionUtil;