@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/server/DateUtil/index.d.ts

@@ -1,107 +1,184 @@
-import Calendar from '../../builtins/Calendar';
-import Date from '../../builtins/Date';
-import Locale from '../../builtins/Locale';
-
 /**
-* Formats a calendar according to the ISO8601 specification.
-* @returns {string} aString the calendar date formatted as a ISO8601 string, or null if aCalendar is null 
-* @param {Calendar} aCalendar - a Calendar that needs to be formatted
-*/
-export function getCalendarAsISO8601String(aCalendar: Calendar): string;
+ * Formats a date according to the ISO8601 specification.
+ *
+ * <p>
+ *    <em>An example:</em> A date representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
+ *    ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
+ * </p>
+ * @param aDate a <code>Date</code> that needs to be formatted
+ * @return the date formatted as a ISO8601 string, or <code>null</code> if <code>aDate</code> is <code>null</code>
+ */
+export function getDateAsISO8601String(aDate: unknown): string;
 
 /**
-* Formats the date of a Calendar according to a SimpleDateFormat pattern.
-* @returns {string} returns a String representation of aCalendar according to aFormatPattern (and resolved Locale).Returns null if formatting fails or aCalendar is null 
-* @param {string} aFormatPattern - date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
-* @param {Calendar} aCalendar - the Calendar
-*/
-export function getCalendarAsString(aFormatPattern: string, aCalendar: Calendar): string;
+ * Formats a calendar according to the ISO8601 specification.
+ *
+ * <p>
+ *    <em>An example:</em> A calendar representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
+ *    ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
+ * </p>
+ * @param aCalendar a <code>Calendar</code> that needs to be formatted
+ * @return aString the calendar date formatted as a ISO8601 string, or <code>null</code> if <code>aCalendar</code> is <code>null</code>
+ */
+export function getCalendarAsISO8601String(aCalendar: unknown): string;
 
 /**
-* Formats the date of a Calendar according to a SimpleDateFormat pattern and a given Locale.
-* @returns {string} returns a String representation of aCalendar according to aFormatPattern (and resolved Locale).Returns null if formatting fails or aCalendar or aLocale is null 
-* @param {string} aFormatPattern - date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
-* @param {Calendar} aCalendar - the Calendar
-* @param {Locale} aLocale - the Locale
-*/
-export function getCalendarAsString(aFormatPattern: string, aCalendar: Calendar, aLocale: Locale): string;
+ * Gets the date format pattern used in the Sitevision editor for a specific Locale.
+ * @param aLocale the <code>Locale</code> that specifies the date format pattern
+ * @return the date format pattern used in the Sitevision editor that corresponds to <code>aLocale</code>. If <code>aLocale</code> is <code>null</code> then the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) is used to locate the format pattern. If no pattern exist for <code>aLocale</code> then the pattern that corresponds to <code>Locale.ENGLISH</code> will be returned.
+ */
+export function getEditorFormatPattern(aLocale: unknown): string;
 
 /**
-* Formats a date according to the ISO8601 specification.
-* @returns {string} the date formatted as a ISO8601 string, or null if aDate is null 
-* @param {Date} aDate - a Date that needs to be formatted
-*/
-export function getDateAsISO8601String(aDate: Date): string;
+ * Formats a Date according to a <code>SimpleDateFormat</code> pattern.
+ *
+ * <p>
+ *    <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
+ *    If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
+ * </p>
+ * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
+ * @param aDate the Date
+ * @return returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate is null
+ * @see #getDateAsString(String, Date, Locale)
+ */
+export function getDateAsString(aFormatPattern: string, aDate: unknown): string;
 
 /**
-* Formats a Date according to a SimpleDateFormat pattern.
-* @returns {string} returns a String representation of aDate according to aFormatPattern (and resolved Locale).Returns null if formatting fails or aDate is null 
-* @param {string} aFormatPattern - date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
-* @param {Date} aDate - the Date
-*/
-export function getDateAsString(aFormatPattern: string, aDate: Date): string;
+ * Formats a Date according to a <code>SimpleDateFormat</code> pattern using a given Locale.
+ * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
+ * @param aDate the Date
+ * @param aLocale the Locale
+ * @return returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate or aLocale is null
+ * @since Sitevision 8.2
+ */
+export function getDateAsString(
+  aFormatPattern: string,
+  aDate: unknown,
+  aLocale: unknown
+): string;
 
 /**
-* Formats a Date according to a SimpleDateFormat pattern using a given Locale.
-* @returns {string} returns a String representation of aDate according to aFormatPattern (and resolved Locale).Returns null if formatting fails or aDate or aLocale is null 
-* @param {string} aFormatPattern - date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
-* @param {Date} aDate - the Date
-* @param {Locale} aLocale - the Locale
-*/
-export function getDateAsString(aFormatPattern: string, aDate: Date, aLocale: Locale): string;
+ * Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern.
+ *
+ * <p>
+ *    <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
+ *    If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
+ * </p>
+ * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
+ * @param aCalendar the Calendar
+ * @return returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar is null
+ * @see #getCalendarAsString(String, Calendar, Locale)
+ */
+export function getCalendarAsString(
+  aFormatPattern: string,
+  aCalendar: unknown
+): string;
 
 /**
-* Gets the date format pattern used in the Sitevision editor for a specific Locale.
-* @returns {string} the date format pattern used in the Sitevision editor that corresponds to aLocale.If aLocale is null then the current locale (as ofPortletContextUtil.getCurrentLocale())is used to locate the format pattern. If no pattern exist for aLocale then the pattern that corresponds toLocale.ENGLISH will be returned. 
-* @param {Locale} aLocale - the Locale that specifies the date format pattern
-*/
-export function getEditorFormatPattern(aLocale: Locale): string;
+ * Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern and a given Locale.
+ * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
+ * @param aCalendar the Calendar
+ * @param aLocale the Locale
+ * @return returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar or aLocale is null
+ * @since Sitevision 8.2
+ */
+export function getCalendarAsString(
+  aFormatPattern: string,
+  aCalendar: unknown,
+  aLocale: unknown
+): string;
 
 /**
-* Converts a date string to a Date using a SimpleDateFormat pattern.
-* @returns {Date} a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern) is null or blank 
-* @param {string} aDateStr - the string representation of a Date
-* @param {string} aFormatPattern - string to date pattern according to SimpleDateFormat
-*/
-export function parseDate(aDateStr: string, aFormatPattern: string): Date;
+ * Converts a Date to a Calendar.
+ * @param aDate a Date
+ * @return a Calendar representing aDate, or null if aDate is null
+ * @since Sitevision 4.5.5
+ */
+export function toCalendar(aDate: unknown): unknown;
 
 /**
-* Converts a date string to a Date using a SimpleDateFormat pattern and a given Locale.
-* @returns {Date} a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern, aLocale) is null or blank 
-* @param {string} aDateStr - the string representation of a Date
-* @param {string} aFormatPattern - string to date pattern according to SimpleDateFormat
-* @param {Locale} aLocale - the Locale
-*/
-export function parseDate(aDateStr: string, aFormatPattern: string, aLocale: Locale): Date;
+ * Converts a Calendar to a Date.
+ * @param aCalendar a Calendar
+ * @return a Date representing aCalendar, or null if aCalendar is null
+ * @since Sitevision 4.5.5
+ */
+export function toDate(aCalendar: unknown): unknown;
 
 /**
-* Converts a Date to a Calendar.
-* @returns {Calendar} a Calendar representing aDate, or null if aDate is null 
-* @param {Date} aDate - a Date
-*/
-export function toCalendar(aDate: Date): Calendar;
+ * Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern.
+ *
+ * <p>
+ *    <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
+ *    If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
+ * </p>
+ * @param aDateStr the string representation of a Date
+ * @param aFormatPattern string to date pattern according to SimpleDateFormat
+ * @return a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern) is null or blank
+ * @since Sitevision 5.1
+ * @see #parseDate(String, String, Locale)
+ */
+export function parseDate(aDateStr: string, aFormatPattern: string): unknown;
 
 /**
-* Converts a Calendar to a Date.
-* @returns {Date} a Date representing aCalendar, or null if aCalendar is null 
-* @param {Calendar} aCalendar - a Calendar
-*/
-export function toDate(aCalendar: Calendar): Date;
+ * Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern and a given Locale.
+ * @param aDateStr the string representation of a Date
+ * @param aFormatPattern string to date pattern according to SimpleDateFormat
+ * @param aLocale the Locale
+ * @return a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern, aLocale) is null or blank
+ * @since Sitevision 8.2
+ */
+export function parseDate(
+  aDateStr: string,
+  aFormatPattern: string,
+  aLocale: unknown
+): unknown;
 
-declare namespace dateUtil {
+/**
+ * Date utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDateUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Formats a date according to the ISO8601 specification.
+ *
+ * <p>
+ *    <em>An example:</em> A date representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
+ *    ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
+ * </p>Formats a calendar according to the ISO8601 specification.
+ *
+ * <p>
+ *    <em>An example:</em> A calendar representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
+ *    ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
+ * </p>Gets the date format pattern used in the Sitevision editor for a specific Locale.Formats a Date according to a <code>SimpleDateFormat</code> pattern.
+ *
+ * <p>
+ *    <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
+ *    If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
+ * </p>Formats a Date according to a <code>SimpleDateFormat</code> pattern using a given Locale.Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern.
+ *
+ * <p>
+ *    <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
+ *    If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
+ * </p>Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern and a given Locale.Converts a Date to a Calendar.Converts a Calendar to a Date.Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern.
+ *
+ * <p>
+ *    <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
+ *    If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
+ * </p>Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern and a given Locale.
+ * @author Albin Öhrn
+ * @since Sitevision 3.5
+ */
+declare namespace DateUtil {
   export {
-    getCalendarAsISO8601String,
-    getCalendarAsString,
-    getCalendarAsString,
     getDateAsISO8601String,
-    getDateAsString,
-    getDateAsString,
+    getCalendarAsISO8601String,
     getEditorFormatPattern,
-    parseDate,
-    parseDate,
+    getDateAsString,
+    getCalendarAsString,
     toCalendar,
     toDate,
+    parseDate,
   };
 }
 
-export default dateUtil;
+export default DateUtil;

package/server/DecorationUtil/index.d.ts

@@ -0,0 +1,23 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Gets the decoration with a given name
+ * @param aDecorationName the name of the decoration
+ * @return the first decoration with name aDecorationName, or <code>null</code> if no decoration matches
+ */
+export function getDecorationByName(aDecorationName: string): Node;
+
+/**
+ * Utility interface for Decorations.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDecorationUtil()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Gets the decoration with a given name
+ * @author Magnus Lövgren
+ */
+declare namespace DecorationUtil {
+  export { getDecorationByName };
+}
+
+export default DecorationUtil;

package/server/DeviceUtil/index.d.ts

@@ -0,0 +1,36 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Checks if current execution/rendering is in a mobile view.
+ * @return <code>true</code> if current execution is rendering in a mobile view, <code>false</code> if not
+ * @deprecated As of Sitevision 10 this method always returns <code>false</code>
+ */
+export function isRenderingMobileView(): boolean;
+
+/**
+ * Checks if currently executing client is a mobile device.
+ * @param aPageNode a page node, typically the currently executing page (see {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage()}). Null is allowed but device checking will be more extensive with a proper value since it will also match against all configured devices for the site of the <code>aPageNode</code>.
+ * @return <code>true</code> if currently executing client is a mobile device, <code>false</code> if not
+ * @deprecated As of Sitevision 10 the parameter aPageNode is no longer used
+ */
+export function isMobileDevice(aPageNode: Node): boolean;
+
+/**
+ * Device utility interface.
+ *
+ * <p>
+ * Contains methods for retrieving device-related information.
+ * </p>
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDeviceUtil()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Checks if current execution/rendering is in a mobile view.Checks if currently executing client is a mobile device.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.0
+ */
+declare namespace DeviceUtil {
+  export { isRenderingMobileView, isMobileDevice };
+}
+
+export default DeviceUtil;

package/server/DirectoryUtil/index.d.ts

@@ -1,61 +1,121 @@
-import Property from "../../builtins/Property";
+import Node from "../../hidden/javax/jcr/Node";
+import Property from "../../hidden/javax/jcr/Property";
 
 /**
-* Gets a directory attribute value for a directory node object as Property.
-* @param {Node} aDirectoryObjectNode - a directory object node that has an attribute
-* @param {string} anAttributeName - the attribute name
-* @returns {Property} the attribute value as Property, or null if indeterminate(e.g. aDirectoryObjectNode is not a directory object nodeor aDirectoryObjectNode has no attribute named anAttributeName) 
-*/
-export function getAttributeAsProperty(aDirectoryObjectNode: Node, anAttributeName: string): Property;
+ * Searches for objects in all LDAP directories that are accessible in current context (i.e. current page).
+ * <p>
+ * Some examples of <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a> valid values for <code>aSearchFilter</code>:
+ * <ul>
+ * <li><code>"magnus"</code> - find all <em>magnus</em>, using the search base specified by the directories (usually common name) </li>
+ * <li><code>"(cn=magnus)"</code> - find all with common name (cn) <em>magnus</em></li>
+ * <li><code>"(cn=magnus*)"</code> - find all that has a common name (cn) that starts with <em>magnus</em></li>
+ * <li><code>"(&amp;(cn=magnus)(mail=*))"</code> - find all that has a mail address and <em>magnus</em> as common name (cn)</li>
+ * <li><code>"(|(cn=magnus)((sn=L*)))"</code> - find all with common name (cn) <em>magnus</em> or a surname (sn) that starts with <em>L</em></li>
+ * </ul>
+ * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
+ * @return the search result as a <code>List</code>. If there are no hits, an empty <code>List</code> is returned.
+ * @see #search(String,Node)
+ */
+export function search(aSearchFilter: string): unknown[];
 
 /**
-* Gets a directory node object with a specific distinguished name, dn.
-* @param {string} aDirectoryObjectDN - the directory dn for a directory object
-* @returns {Node} the directory object Node, or null if indeterminate 
-*/
-export function getNodeByDN(aDirectoryObjectDN: string): Node;
+ * Searches for objects in a specified LDAP directory.
+ * <p>
+ * <em>Tip!</em> The repository for all LDAP directory nodes can be located via the
+ * {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getDirectoryRepository() getDirectoryRepository()}
+ * method in {@link senselogic.sitevision.api.resource.ResourceLocatorUtil}
+ * </p>
+ * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
+ * @param aDirectoryNode a LDAP directory <code>Node</code>
+ * @return the search result as a <code>List</code>. If there are no hits, an empty <code>List</code> is returned.
+ * @see #search(String)
+ */
+export function search(aSearchFilter: string, aDirectoryNode: Node): unknown[];
 
 /**
-* Searches for objects in all LDAP directories that are accessible in current context (i.e. current page).
-* @param {string} aSearchFilter - LDAP search filter (as specified by RFC 2254)
-* @returns {List<Node>} the search result as a List. If there are no hits, an empty List is returned. 
-*/
-export function search(aSearchFilter: string): List<Node>;
+ * Searches for objects in a specified search base in a specified LDAP directory.
+ * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
+ * @param aDirectoryNode a LDAP directory <code>Node</code>
+ * @param aSearchBase a search base that exist in <code>aDirectoryNode</code>
+ * @return the search result as a <code>List</code>. If there are no hits, an empty <code>List</code> is returned.
+ * @see #search(String,Node)
+ */
+export function search(
+  aSearchFilter: string,
+  aDirectoryNode: Node,
+  aSearchBase: string
+): unknown[];
 
 /**
-* Searches for objects in a specified LDAP directory.
-* @param {string} aSearchFilter - LDAP search filter (as specified by RFC 2254)
-* @param {Node} aDirectoryNode - a LDAP directory Node
-* @returns {List<Node>} the search result as a List. If there are no hits, an empty List is returned. 
-*/
-export function search(aSearchFilter: string, aDirectoryNode: Node): List<Node>;
+ * Gets a directory node object with a specific distinguished name, dn.
+ * @param aDirectoryObjectDN the directory dn for a directory object
+ * @return the directory object <code>Node</code>, or null if indeterminate
+ */
+export function getNodeByDN(aDirectoryObjectDN: string): Node;
 
 /**
-* Searches for objects in a specified search base in a specified LDAP directory.
-* @param {string} aSearchFilter - LDAP search filter (as specified by RFC 2254)
-* @param {Node} aDirectoryNode - a LDAP directory Node
-* @param {string} aSearchBase - a search base that exist in aDirectoryNode
-* @returns {List<Node>} the search result as a List. If there are no hits, an empty List is returned. 
-*/
-export function search(aSearchFilter: string, aDirectoryNode: Node, aSearchBase: string): List<Node>;
+ * Gets a directory attribute value for a directory node object as <code>Property</code>.
+ * <p>
+ * The default properties for a directory node object adheres/corresponds to the attributes defined in the directory scheme.
+ * All attributes that are defined in the scheme are exposed as properties in the Sitevision JCR model. This method tries to
+ * find the attribute via the Sitevision JCR model but if no property can be found it executes LDAP queries
+ * to find the attribute. This makes it possible to find scheme-defined attributes, but also custom-defined ones.
+ * </p>
+ * @param aDirectoryObjectNode a directory object node that has an attribute
+ * @param anAttributeName the attribute name
+ * @return the attribute value as <code>Property</code>, or <code>null</code> if indeterminate (e.g. <code>aDirectoryObjectNode</code> is not a directory object node or <code>aDirectoryObjectNode</code> has no attribute named <code>anAttributeName</code>)
+ */
+export function getAttributeAsProperty(
+  aDirectoryObjectNode: Node,
+  anAttributeName: string
+): Property;
 
 /**
-* Searches for ids in a specified search base in all directories.
-* @param {string} aSearchFilter - LDAP search filter (as specified by RFC 2254)
-* @param {string} searchBase - search base for the search, if null all directories for current node will be searched
-* @param {List<string>} attributes - a List of return attributes
-* @returns {Map<string,Map<string,string>>} the search result as a Map. If there are no hits, an empty Map is returned.The Map contains ids as keys and a Map as values containing the returned attributes. 
-*/
-export function simpleSearch(aSearchFilter: string, searchBase: string, attributes: List<string>): Map<string, Map<string, string>>;
-
-declare namespace directoryUtil {
-  export {
-    getAttributeAsProperty,
-    getNodeByDN,
-    search,
-    simpleSearch,
-  };
-}
+ * Searches for ids in a specified search base in all directories.
+ * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
+ * @param searchBase search base for the search, if <code>null</code> all directories for current node will be searched
+ * @param attributes a <code>List</code> of return attributes
+ * @return the search result as a <code>Map</code>. If there are no hits, an empty <code>Map</code> is returned. The <code>Map</code> contains ids as keys and a <code>Map</code> as values containing the returned attributes.
+ * @since Sitevision 2.6.1_02
+ */
+export function simpleSearch(
+  aSearchFilter: string,
+  searchBase: string,
+  attributes: unknown[]
+): Record<unknown, unknown>;
 
-export default directoryUtil;
+/**
+ * LDAP directory utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDirectoryUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Searches for objects in all LDAP directories that are accessible in current context (i.e. current page).
+ * <p>
+ * Some examples of <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a> valid values for <code>aSearchFilter</code>:
+ * <ul>
+ * <li><code>"magnus"</code> - find all <em>magnus</em>, using the search base specified by the directories (usually common name) </li>
+ * <li><code>"(cn=magnus)"</code> - find all with common name (cn) <em>magnus</em></li>
+ * <li><code>"(cn=magnus*)"</code> - find all that has a common name (cn) that starts with <em>magnus</em></li>
+ * <li><code>"(&amp;(cn=magnus)(mail=*))"</code> - find all that has a mail address and <em>magnus</em> as common name (cn)</li>
+ * <li><code>"(|(cn=magnus)((sn=L*)))"</code> - find all with common name (cn) <em>magnus</em> or a surname (sn) that starts with <em>L</em></li>
+ * </ul>Searches for objects in a specified LDAP directory.
+ * <p>
+ * <em>Tip!</em> The repository for all LDAP directory nodes can be located via the
+ * {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getDirectoryRepository() getDirectoryRepository()}
+ * method in {@link senselogic.sitevision.api.resource.ResourceLocatorUtil}
+ * </p>Searches for objects in a specified search base in a specified LDAP directory.Gets a directory node object with a specific distinguished name, dn.Gets a directory attribute value for a directory node object as <code>Property</code>.
+ * <p>
+ * The default properties for a directory node object adheres/corresponds to the attributes defined in the directory scheme.
+ * All attributes that are defined in the scheme are exposed as properties in the Sitevision JCR model. This method tries to
+ * find the attribute via the Sitevision JCR model but if no property can be found it executes LDAP queries
+ * to find the attribute. This makes it possible to find scheme-defined attributes, but also custom-defined ones.
+ * </p>Searches for ids in a specified search base in all directories.
+ * @author Magnus Lövgren
+ * @since Sitevision 2.6
+ */
+declare namespace DirectoryUtil {
+  export { search, getNodeByDN, getAttributeAsProperty, simpleSearch };
+}
 
+export default DirectoryUtil;