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

package/server/LogUtil/index.d.ts

@@ -1,117 +1,3 @@
-/**
- * Checks if trace logging is enabled.
- *
- * <p>
- *    Appropriate to check first if you are about to do extensive/expensive trace logging.
- * </p>
- * @return <code>true</code> if trace logging is enabled, <code>false</code> otherwise
- * @since Sitevision 4.1
- */
-export function isTraceEnabled(): boolean;
-
-/**
- * Logs a trace message to the Sitevision server log.
- * @param aMessage a message.
- * @since Sitevision 4.1
- */
-export function trace(aMessage: string): void;
-
-/**
- * Logs a trace message to the Sitevision server log.
- * @param aMessage a message.
- * @param aThrowable a throwable.
- * @since Sitevision 4.1
- */
-export function trace(aMessage: string, aThrowable: unknown): void;
-
-/**
- * Checks if debug logging is enabled.
- *
- * <p>
- *    Appropriate to check first if you are about to do extensive/expensive debug logging.
- * </p>
- * @return <code>true</code> if debug logging is enabled, <code>false</code> otherwise
- * @since Sitevision 3.0
- */
-export function isDebugEnabled(): boolean;
-
-/**
- * Logs a debug message to the Sitevision server log.
- * @param aMessage a message.
- */
-export function debug(aMessage: string): void;
-
-/**
- * Logs a debug message to the Sitevision server log.
- * @param aMessage a message.
- * @param aThrowable a throwable.
- */
-export function debug(aMessage: string, aThrowable: unknown): void;
-
-/**
- * Checks if info logging is enabled.
- *
- * <p>
- *    Appropriate to check first if you are about to do extensive/expensive info logging.
- * </p>
- * @return <code>true</code> if info logging is enabled, <code>false</code> otherwise
- * @since Sitevision 4.1
- */
-export function isInfoEnabled(): boolean;
-
-/**
- * Logs an info message to the Sitevision server log.
- * @param aMessage a message.
- */
-export function info(aMessage: string): void;
-
-/**
- * Logs an info message to the Sitevision server log.
- * @param aMessage a message.
- * @param aThrowable a throwable.
- */
-export function info(aMessage: string, aThrowable: unknown): void;
-
-/**
- * Checks if warn logging is enabled.
- * @return <code>true</code> if warn logging is enabled, <code>false</code> otherwise
- * @since Sitevision 4.1
- */
-export function isWarnEnabled(): boolean;
-
-/**
- * Logs a warn message to the Sitevision server log.
- * @param aMessage a message.
- */
-export function warn(aMessage: string): void;
-
-/**
- * Logs a warn message to the Sitevision server log.
- * @param aMessage a message.
- * @param aThrowable a throwable.
- */
-export function warn(aMessage: string, aThrowable: unknown): void;
-
-/**
- * Checks if error logging is enabled.
- * @return <code>true</code> if error logging is enabled, <code>false</code> otherwise
- * @since Sitevision 4.1
- */
-export function isErrorEnabled(): boolean;
-
-/**
- * Logs an error message to the Sitevision server log.
- * @param aMessage a message.
- */
-export function error(aMessage: string): void;
-
-/**
- * Logs an error message to the Sitevision server log.
- * @param aMessage a message.
- * @param aThrowable a throwable.
- */
-export function error(aMessage: string, aThrowable: unknown): void;
-
 /**
  * Logging utility class for simple logging to the Sitevision server log.
  * <p>
@@ -124,19 +10,124 @@ export function error(aMessage: string, aThrowable: unknown): void;
  * </p>
  * @author Magnus Lövgren
  */
-declare namespace logUtil {
-  export {
-    isTraceEnabled,
-    trace,
-    isDebugEnabled,
-    debug,
-    isInfoEnabled,
-    info,
-    isWarnEnabled,
-    warn,
-    isErrorEnabled,
-    error,
-  };
+export interface LogUtil {
+  /**
+   * Checks if trace logging is enabled.
+   *
+   * <p>
+   *    Appropriate to check first if you are about to do extensive/expensive trace logging.
+   * </p>
+   * @return <code>true</code> if trace logging is enabled, <code>false</code> otherwise
+   * @since Sitevision 4.1
+   */
+  isTraceEnabled(): boolean;
+
+  /**
+   * Logs a trace message to the Sitevision server log.
+   * @param aMessage a message.
+   * @since Sitevision 4.1
+   */
+  trace(aMessage: string): void;
+
+  /**
+   * Logs a trace message to the Sitevision server log.
+   * @param aMessage a message.
+   * @param aThrowable a throwable.
+   * @since Sitevision 4.1
+   */
+  trace(aMessage: string, aThrowable: unknown): void;
+
+  /**
+   * Checks if debug logging is enabled.
+   *
+   * <p>
+   *    Appropriate to check first if you are about to do extensive/expensive debug logging.
+   * </p>
+   * @return <code>true</code> if debug logging is enabled, <code>false</code> otherwise
+   * @since Sitevision 3.0
+   */
+  isDebugEnabled(): boolean;
+
+  /**
+   * Logs a debug message to the Sitevision server log.
+   * @param aMessage a message.
+   */
+  debug(aMessage: string): void;
+
+  /**
+   * Logs a debug message to the Sitevision server log.
+   * @param aMessage a message.
+   * @param aThrowable a throwable.
+   */
+  debug(aMessage: string, aThrowable: unknown): void;
+
+  /**
+   * Checks if info logging is enabled.
+   *
+   * <p>
+   *    Appropriate to check first if you are about to do extensive/expensive info logging.
+   * </p>
+   * @return <code>true</code> if info logging is enabled, <code>false</code> otherwise
+   * @since Sitevision 4.1
+   */
+  isInfoEnabled(): boolean;
+
+  /**
+   * Logs an info message to the Sitevision server log.
+   * @param aMessage a message.
+   */
+  info(aMessage: string): void;
+
+  /**
+   * Logs an info message to the Sitevision server log.
+   * @param aMessage a message.
+   * @param aThrowable a throwable.
+   */
+  info(aMessage: string, aThrowable: unknown): void;
+
+  /**
+   * Checks if warn logging is enabled.
+   * @return <code>true</code> if warn logging is enabled, <code>false</code> otherwise
+   * @since Sitevision 4.1
+   */
+  isWarnEnabled(): boolean;
+
+  /**
+   * Logs a warn message to the Sitevision server log.
+   * @param aMessage a message.
+   */
+  warn(aMessage: string): void;
+
+  /**
+   * Logs a warn message to the Sitevision server log.
+   * @param aMessage a message.
+   * @param aThrowable a throwable.
+   */
+  warn(aMessage: string, aThrowable: unknown): void;
+
+  /**
+   * Checks if error logging is enabled.
+   * @return <code>true</code> if error logging is enabled, <code>false</code> otherwise
+   * @since Sitevision 4.1
+   */
+  isErrorEnabled(): boolean;
+
+  /**
+   * Logs an error message to the Sitevision server log.
+   * @param aMessage a message.
+   */
+  error(aMessage: string): void;
+
+  /**
+   * Logs an error message to the Sitevision server log.
+   * @param aMessage a message.
+   * @param aThrowable a throwable.
+   */
+  error(aMessage: string, aThrowable: unknown): void;
 }
 
+declare namespace LogUtil {}
+
+declare var logUtil: LogUtil;
+
 export default logUtil;

package/server/MailBuilder/index.d.ts

@@ -1,110 +1,6 @@
 import type { Mail } from "../../types/senselogic/sitevision/api/mail/Mail";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * Sets the from address.
- * @param aFromAddress the from address. A whitespace-only address will be ignored, default (null) will be set instead.
- * @return this builder
- */
-export function setFrom(aFromAddress: string): MailBuilder;
-
-/**
- * Adds a reply-to address.
- * @param aReplyToAddress a reply-to address. A null or whitespace-only address will be ignored.
- * @return this builder
- */
-export function addReplyTo(aReplyToAddress: string): MailBuilder;
-
-/**
- * Removes all previously added reply-to addresses.
- * @return this builder
- */
-export function clearReplyTos(): MailBuilder;
-
-/**
- * Sets the subject.
- * @param aSubject a subject
- * @return this builder
- */
-export function setSubject(aSubject: string): MailBuilder;
-
-/**
- * Sets the text message.
- * @param aTextMessage a text message
- * @return this builder
- */
-export function setTextMessage(aTextMessage: string): MailBuilder;
-
-/**
- * Sets the html message.
- * @param aHtmlMessage a html message
- * @return this builder
- * @since Sitevision 4.3
- */
-export function setHtmlMessage(aHtmlMessage: string): MailBuilder;
-
-/**
- * Adds a recipient address (TO).
- * @param aRecipientAddress a recipient address. A null or whitespace-only address will be ignored.
- * @return this builder
- */
-export function addRecipient(aRecipientAddress: string): MailBuilder;
-
-/**
- * Removes all previously added recipient addresses (TO).
- * @return this builder
- */
-export function clearRecipients(): MailBuilder;
-
-/**
- * Convenience method for removing all addresses for all recipient types (TO/CC/BCC).
- * @return this builder
- * @since Sitevision 3.6.3
- * @see #clearRecipients()
- * @see #clearCopyRecipients()
- * @see #clearBlindCopyRecipients()
- */
-export function clearAllRecipients(): MailBuilder;
-
-/**
- * Adds a carbon copy recipient address (CC).
- * @param aCopyRecipientAddress a carbon copy recipient address. A null or whitespace-only address will be ignored.
- * @return this builder
- * @since Sitevision 3.6.3
- */
-export function addCopyRecipient(aCopyRecipientAddress: string): MailBuilder;
-
-/**
- * Removes all previously added carbon copy recipient addresses (CC).
- * @return this builder
- * @since Sitevision 3.6.3
- */
-export function clearCopyRecipients(): MailBuilder;
-
-/**
- * Adds a blind carbon copy recipient address (BCC).
- * @param aBlindCopyRecipientAddress a blind carbon copy recipient address. A null or whitespace-only address will be ignored.
- * @return this builder
- * @since Sitevision 3.6.3
- */
-export function addBlindCopyRecipient(
-  aBlindCopyRecipientAddress: string
-): MailBuilder;
-
-/**
- * Removes all previously added blind carbon copy recipient addresses (BCC).
- * @return this builder
- * @since Sitevision 3.6.3
- */
-export function clearBlindCopyRecipients(): MailBuilder;
-
-/**
- * Creates a Mail instance using current state of this builder.
- * @return a mail that can be sent
- * @throws IllegalStateException will be thrown if subject is null, if there are no recipients or if a recipient address is invalid, if the from address, a copy address, blind copy address or reply-to address is invalid.
- */
-export function build(): Mail;
-
 /**
  * Builder to create a Mail instances that can be sent.
  *
@@ -217,23 +113,112 @@ export function build(): Mail;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace mailBuilder {
-  export {
-    setFrom,
-    addReplyTo,
-    clearReplyTos,
-    setSubject,
-    setTextMessage,
-    setHtmlMessage,
-    addRecipient,
-    clearRecipients,
-    clearAllRecipients,
-    addCopyRecipient,
-    clearCopyRecipients,
-    addBlindCopyRecipient,
-    clearBlindCopyRecipients,
-    build,
-  };
+export interface MailBuilder extends Builder {
+  /**
+   * Sets the from address.
+   * @param aFromAddress the from address. A whitespace-only address will be ignored, default (null) will be set instead.
+   * @return this builder
+   */
+  setFrom(aFromAddress: string): MailBuilder;
+
+  /**
+   * Adds a reply-to address.
+   * @param aReplyToAddress a reply-to address. A null or whitespace-only address will be ignored.
+   * @return this builder
+   */
+  addReplyTo(aReplyToAddress: string): MailBuilder;
+
+  /**
+   * Removes all previously added reply-to addresses.
+   * @return this builder
+   */
+  clearReplyTos(): MailBuilder;
+
+  /**
+   * Sets the subject.
+   * @param aSubject a subject
+   * @return this builder
+   */
+  setSubject(aSubject: string): MailBuilder;
+
+  /**
+   * Sets the text message.
+   * @param aTextMessage a text message
+   * @return this builder
+   */
+  setTextMessage(aTextMessage: string): MailBuilder;
+
+  /**
+   * Sets the html message.
+   * @param aHtmlMessage a html message
+   * @return this builder
+   * @since Sitevision 4.3
+   */
+  setHtmlMessage(aHtmlMessage: string): MailBuilder;
+
+  /**
+   * Adds a recipient address (TO).
+   * @param aRecipientAddress a recipient address. A null or whitespace-only address will be ignored.
+   * @return this builder
+   */
+  addRecipient(aRecipientAddress: string): MailBuilder;
+
+  /**
+   * Removes all previously added recipient addresses (TO).
+   * @return this builder
+   */
+  clearRecipients(): MailBuilder;
+
+  /**
+   * Convenience method for removing all addresses for all recipient types (TO/CC/BCC).
+   * @return this builder
+   * @since Sitevision 3.6.3
+   * @see #clearRecipients()
+   * @see #clearCopyRecipients()
+   * @see #clearBlindCopyRecipients()
+   */
+  clearAllRecipients(): MailBuilder;
+
+  /**
+   * Adds a carbon copy recipient address (CC).
+   * @param aCopyRecipientAddress a carbon copy recipient address. A null or whitespace-only address will be ignored.
+   * @return this builder
+   * @since Sitevision 3.6.3
+   */
+  addCopyRecipient(aCopyRecipientAddress: string): MailBuilder;
+
+  /**
+   * Removes all previously added carbon copy recipient addresses (CC).
+   * @return this builder
+   * @since Sitevision 3.6.3
+   */
+  clearCopyRecipients(): MailBuilder;
+
+  /**
+   * Adds a blind carbon copy recipient address (BCC).
+   * @param aBlindCopyRecipientAddress a blind carbon copy recipient address. A null or whitespace-only address will be ignored.
+   * @return this builder
+   * @since Sitevision 3.6.3
+   */
+  addBlindCopyRecipient(aBlindCopyRecipientAddress: string): MailBuilder;
+
+  /**
+   * Removes all previously added blind carbon copy recipient addresses (BCC).
+   * @return this builder
+   * @since Sitevision 3.6.3
+   */
+  clearBlindCopyRecipients(): MailBuilder;
+
+  /**
+   * Creates a Mail instance using current state of this builder.
+   * @return a mail that can be sent
+   * @throws IllegalStateException will be thrown if subject is null, if there are no recipients or if a recipient address is invalid, if the from address, a copy address, blind copy address or reply-to address is invalid.
+   */
+  build(): Mail;
 }
 
+declare namespace MailBuilder {}
+
+declare var mailBuilder: MailBuilder;
+
 export default mailBuilder;

package/server/MailUtil/index.d.ts

@@ -1,57 +1,4 @@
-import MailBuilder from "../MailBuilder";
-
-/**
- * Returns a mail builder for creating mails.
- * @return a mail builder
- */
-export function getMailBuilder(): MailBuilder;
-
-/**
- * Checks if a mail address has a valid format.
- * @param aMailAddress the address to check
- * @return <code>true</code> if <code>aMailAddress</code> has a valid format and can be used to create a <code>javax.mail.internet.InternetAddress</code>, <code>false</code> otherwise.
- */
-export function isValidAddress(aMailAddress: string): boolean;
-
-/**
- * Gets the mail address of the site responsible.
- *
- * <p>
- *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
- * </p>
- * @return the mail address of the site responsible, or <code>null</code> if there are no address or if it's whitespace only
- */
-export function getSiteResponsibleAddress(): string;
-
-/**
- * Gets the from mail address of current site.
- *
- * <p>
- *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
- * </p>
- * @return the from mail address of current site, or <code>null</code> if there are no address or if it's whitespace only
- */
-export function getSiteFromAddress(): string;
-
-/**
- * Gets the mail address of the server responsible.
- *
- * <p>
- *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
- * </p>
- * @return the mail address of the server responsible, or <code>null</code> if there are no address or if it's whitespace only
- */
-export function getServerResponsibleAddress(): string;
-
-/**
- * Gets the server from mail address.
- *
- * <p>
- *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
- * </p>
- * @return the server from mail address, or <code>null</code> if there are no address or if it's whitespace only
- */
-export function getServerFromAddress(): string;
+import type { MailBuilder } from "../MailBuilder";
 
 /**
  * Mail utility interface.
@@ -68,15 +15,63 @@ export function getServerFromAddress(): string;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace mailUtil {
-  export {
-    getMailBuilder,
-    isValidAddress,
-    getSiteResponsibleAddress,
-    getSiteFromAddress,
-    getServerResponsibleAddress,
-    getServerFromAddress,
-  };
+export interface MailUtil {
+  /**
+   * Returns a mail builder for creating mails.
+   * @return a mail builder
+   */
+  getMailBuilder(): MailBuilder;
+
+  /**
+   * Checks if a mail address has a valid format.
+   * @param aMailAddress the address to check
+   * @return <code>true</code> if <code>aMailAddress</code> has a valid format and can be used to create a <code>javax.mail.internet.InternetAddress</code>, <code>false</code> otherwise.
+   */
+  isValidAddress(aMailAddress: string): boolean;
+
+  /**
+   * Gets the mail address of the site responsible.
+   *
+   * <p>
+   *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
+   * </p>
+   * @return the mail address of the site responsible, or <code>null</code> if there are no address or if it's whitespace only
+   */
+  getSiteResponsibleAddress(): string;
+
+  /**
+   * Gets the from mail address of current site.
+   *
+   * <p>
+   *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
+   * </p>
+   * @return the from mail address of current site, or <code>null</code> if there are no address or if it's whitespace only
+   */
+  getSiteFromAddress(): string;
+
+  /**
+   * Gets the mail address of the server responsible.
+   *
+   * <p>
+   *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
+   * </p>
+   * @return the mail address of the server responsible, or <code>null</code> if there are no address or if it's whitespace only
+   */
+  getServerResponsibleAddress(): string;
+
+  /**
+   * Gets the server from mail address.
+   *
+   * <p>
+   *    <strong>Note!</strong> The returned address is <em>not</em> validated, i.e. it might be an invalid mail address.
+   * </p>
+   * @return the server from mail address, or <code>null</code> if there are no address or if it's whitespace only
+   */
+  getServerFromAddress(): string;
 }
 
+declare namespace MailUtil {}
+
+declare var mailUtil: MailUtil;
+
 export default mailUtil;