@sitevision/api 2.0.0-alpha.1 → 2.0.0-alpha.2

package/server/FilterBuilder/index.d.ts

@@ -1,40 +1,5 @@
-import type { Filter } from "../../types/senselogic/sitevision/api/search/searcher/component/Filter";
-import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
-
-/**
- * Adds a filter query.
- *
- * <p>
- *    <em>Solr note: this is the 'fq' param</em>
- * </p>
- *
- * <p>
- *    <strong>Query syntax note! </strong>Query strings should be expressed according to the <em>Solr query syntax</em>.
- *    The syntax is basically the <em>
- *    <a href="http://lucene.apache.org/core/4_10_3/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">
- *    Lucene query syntax</a></em>
- *    with <em><a href="http://wiki.apache.org/solr/SolrQuerySyntax#Differences_From_Lucene_Query_Parser">some minor differences</a></em>.
- *    Also note that a general recommendation is to always use the <em>prefix operators</em> (<code>+</code>/<code>-</code>) instead of the
- *    <em>boolean keywords</em> (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example
- *    <a href="http://searchhub.org/2011/12/28/why-not-and-or-and-not/">Why Not AND, OR, And NOT?</a>.
- * </p>
- * @param aFilterQuery the filter query, a <code>null</code> or whitespace-only value will be ignored
- * @return this builder
- */
-export function addFilterQuery(aFilterQuery: string): FilterBuilder;
-
-/**
- * Removes all previously added filter queries.
- * @return this builder
- */
-export function clearFilterQueries(): FilterBuilder;
-
-/**
- * Creates a Filter component instance using currently specified state/behaviour.
- * @return a filter component
- * @throws IllegalStateException if no filter query exist
- */
-export function build(): Filter;
+import type Filter from "../../types/senselogic/sitevision/api/search/searcher/component/Filter";
+import type Builder from "../../types/senselogic/sitevision/api/base/Builder";
 
 /**
  * <p>
@@ -99,8 +64,45 @@ export function build(): Filter;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace filterBuilder {
-  export { addFilterQuery, clearFilterQueries, build };
+export interface FilterBuilder extends Builder {
+  /**
+   * Adds a filter query.
+   *
+   * <p>
+   *    <em>Solr note: this is the 'fq' param</em>
+   * </p>
+   *
+   * <p>
+   *    <strong>Query syntax note! </strong>Query strings should be expressed according to the <em>Solr query syntax</em>.
+   *    The syntax is basically the <em>
+   *    <a href="http://lucene.apache.org/core/4_10_3/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">
+   *    Lucene query syntax</a></em>
+   *    with <em><a href="http://wiki.apache.org/solr/SolrQuerySyntax#Differences_From_Lucene_Query_Parser">some minor differences</a></em>.
+   *    Also note that a general recommendation is to always use the <em>prefix operators</em> (<code>+</code>/<code>-</code>) instead of the
+   *    <em>boolean keywords</em> (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example
+   *    <a href="http://searchhub.org/2011/12/28/why-not-and-or-and-not/">Why Not AND, OR, And NOT?</a>.
+   * </p>
+   * @param aFilterQuery the filter query, a <code>null</code> or whitespace-only value will be ignored
+   * @return this builder
+   */
+  addFilterQuery(aFilterQuery: string): FilterBuilder;
+
+  /**
+   * Removes all previously added filter queries.
+   * @return this builder
+   */
+  clearFilterQueries(): FilterBuilder;
+
+  /**
+   * Creates a Filter component instance using currently specified state/behaviour.
+   * @return a filter component
+   * @throws IllegalStateException if no filter query exist
+   */
+  build(): Filter;
 }
 
-export default filterBuilder;
+declare namespace FilterBuilder {}
+
+declare var filterBuilder: FilterBuilder;
+
+export = filterBuilder;

package/server/FolderUtil/index.d.ts

@@ -1,94 +1,4 @@
-import type { Node } from "../../types/javax/jcr/Node";
-
-/**
- * <p>
- *    Creates a folder as sub node of the specified parent.
- * </p>
- * <p>
- *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}, {@code sv:collaborationGroupPage},
- *    {@code sv:imageRepository}, {@code sv:localImageRepository}, {@code sv:personalImageRepository},
- *    {@code sv:fileRepository}, {@code sv:localFileRepository}, {@code sv:personalFileRepository}
- *    or {@code sv:templateRepository}.
- *    If an other parent is specified an <code>ConstraintViolationException</code> is thrown.
- * </p>
- *
- * <p>Any name can be given the folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
- *
- * <p>The current user must be authorized to create folders and to do write operations on the parent node or
- * a <code>ConstraintViolationException</code> will be thrown.</p>
- *
- * <p>Note that a new folder inherits metadata and permissions from its parent.</p>
- * @param aParent the parent node of the sv:folder. May not be <code>null</code>
- * @param aName the name of the folder. May not be <code>null</code>
- * @return the newly created sv:folder node.
- * @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create a folder
- * @throws RepositoryException if something else goes wrong
- */
-export function createFolder(aParent: Node, aName: string): Node;
-
-/**
- * <p>Alters the name of a folder. If no folder is specified a <code>NullPointerException</code>
- * is thrown. If the node is not a sv:folder an <code>IllegalArgumentException</code> is thrown.</p>
- *
- * <p>Any name can be given a folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
- *
- * <p>The current user must be authorized to do write operations on the folder or
- * a <code>ConstraintViolationException</code> will be thrown.</p>
- * @param aFolder the sv:folder that should be renamed. May not be <code>null</code>
- * @param aName the new name of the folder. May not be <code>null</code>
- * @throws ConstraintViolationException if the current user is not authorized to alter the name of the folder
- * @throws RepositoryException if something else goes wrong
- */
-export function renameFolder(aFolder: Node, aName: string): void;
-
-/**
- * Modifies versioning for a file folder (versioning only applies to new files created in the file folder).
- *
- * <p>
- *    If no folder is specified a <code>NullPointerException</code> is thrown.
- *    If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
- * </p>
- *
- * <p>
- *    Current user must be authorized to do write operations on the folder or
- *    a <code>ConstraintViolationException</code> will be thrown.
- * </p>
- * @param aFolder the sv:folder. May not be null
- * @param aVersioned the new state of versioning for aFolder
- * @throws ConstraintViolationException if the current user is not authorized to mutate aFolder
- * @throws RepositoryException if something else goes wrong
- * @since Sitevision 9.1
- */
-export function setVersioned(aFolder: Node, aVersioned: boolean): void;
-
-/**
- * Modifies download protection for a file folder (download protection only applies to new files created in the file folder).
- *
- * <p>
- *    Current user (the invoker of this method) must have WRITE permission and MANAGE_DOWNLOAD_PROTECTION permission on the folder node that
- *    should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_DOWNLOAD_PROTECTION}).
- * </p>
- *
- * <p>
- *    If no folder is specified a <code>NullPointerException</code> is thrown.
- *    If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
- * </p>
- *
- * <p>
- *    <em>Tip! Use {@link senselogic.sitevision.api.property.PropertyUtil} or {@link senselogic.sitevision.api.property.Properties}
- *    to check current state, i.e. the "downloadProtected" boolean property.</em>
- * </p>
- * @param aFolder the sv:folder. May not be null
- * @param aDownloadProtected the new state of download protection for aFolder
- * @throws ConstraintViolationException if the current user is not authorized to mutate aFolder
- * @throws RepositoryException if something else goes wrong
- * @since Sitevision 2022.08.1
- */
-export function setDownloadProtected(
-  aFolder: Node,
-  aDownloadProtected: boolean
-): void;
+import type Node from "../../types/javax/jcr/Node";
 
 /**
  * Folder utility interface that handles nodes with primary node type <code>sv:folder</code>.
@@ -106,8 +16,97 @@ export function setDownloadProtected(
  * @author Mikael Wikblom
  * @since Sitevision 2.6.2
  */
-declare namespace folderUtil {
-  export { createFolder, renameFolder, setVersioned, setDownloadProtected };
+export interface FolderUtil {
+  /**
+   * <p>
+   *    Creates a folder as sub node of the specified parent.
+   * </p>
+   * <p>
+   *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}, {@code sv:collaborationGroupPage},
+   *    {@code sv:imageRepository}, {@code sv:localImageRepository}, {@code sv:personalImageRepository},
+   *    {@code sv:fileRepository}, {@code sv:localFileRepository}, {@code sv:personalFileRepository}
+   *    or {@code sv:templateRepository}.
+   *    If an other parent is specified an <code>ConstraintViolationException</code> is thrown.
+   * </p>
+   *
+   * <p>Any name can be given the folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *
+   * <p>The current user must be authorized to create folders and to do write operations on the parent node or
+   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   *
+   * <p>Note that a new folder inherits metadata and permissions from its parent.</p>
+   * @param aParent the parent node of the sv:folder. May not be <code>null</code>
+   * @param aName the name of the folder. May not be <code>null</code>
+   * @return the newly created sv:folder node.
+   * @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create a folder
+   * @throws RepositoryException if something else goes wrong
+   */
+  createFolder(aParent: Node, aName: string): Node;
+
+  /**
+   * <p>Alters the name of a folder. If no folder is specified a <code>NullPointerException</code>
+   * is thrown. If the node is not a sv:folder an <code>IllegalArgumentException</code> is thrown.</p>
+   *
+   * <p>Any name can be given a folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *
+   * <p>The current user must be authorized to do write operations on the folder or
+   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   * @param aFolder the sv:folder that should be renamed. May not be <code>null</code>
+   * @param aName the new name of the folder. May not be <code>null</code>
+   * @throws ConstraintViolationException if the current user is not authorized to alter the name of the folder
+   * @throws RepositoryException if something else goes wrong
+   */
+  renameFolder(aFolder: Node, aName: string): void;
+
+  /**
+   * Modifies versioning for a file folder (versioning only applies to new files created in the file folder).
+   *
+   * <p>
+   *    If no folder is specified a <code>NullPointerException</code> is thrown.
+   *    If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    Current user must be authorized to do write operations on the folder or
+   *    a <code>ConstraintViolationException</code> will be thrown.
+   * </p>
+   * @param aFolder the sv:folder. May not be null
+   * @param aVersioned the new state of versioning for aFolder
+   * @throws ConstraintViolationException if the current user is not authorized to mutate aFolder
+   * @throws RepositoryException if something else goes wrong
+   * @since Sitevision 9.1
+   */
+  setVersioned(aFolder: Node, aVersioned: boolean): void;
+
+  /**
+   * Modifies download protection for a file folder (download protection only applies to new files created in the file folder).
+   *
+   * <p>
+   *    Current user (the invoker of this method) must have WRITE permission and MANAGE_DOWNLOAD_PROTECTION permission on the folder node that
+   *    should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
+   *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_DOWNLOAD_PROTECTION}).
+   * </p>
+   *
+   * <p>
+   *    If no folder is specified a <code>NullPointerException</code> is thrown.
+   *    If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    <em>Tip! Use {@link senselogic.sitevision.api.property.PropertyUtil} or {@link senselogic.sitevision.api.property.Properties}
+   *    to check current state, i.e. the "downloadProtected" boolean property.</em>
+   * </p>
+   * @param aFolder the sv:folder. May not be null
+   * @param aDownloadProtected the new state of download protection for aFolder
+   * @throws ConstraintViolationException if the current user is not authorized to mutate aFolder
+   * @throws RepositoryException if something else goes wrong
+   * @since Sitevision 2022.08.1
+   */
+  setDownloadProtected(aFolder: Node, aDownloadProtected: boolean): void;
 }
 
-export default folderUtil;
+declare namespace FolderUtil {}
+
+declare var folderUtil: FolderUtil;
+
+export = folderUtil;

package/server/FontUtil/index.d.ts

@@ -1,37 +1,4 @@
-import type { Node } from "../../types/javax/jcr/Node";
-
-/**
- * Gets the font with a given font name
- * @param aFontName the name of the font
- * @return the first font with name aFontName, or <code>null</code> if no font matches
- */
-export function getFontByName(aFontName: string): Node;
-
-/**
- * Gets the font with a given font name with a fallback value if no font matches
- * @param aFontName the name of the font
- * @param aDefaultValue fallback value
- * @return the first font with name aFontName, or aDefaultValue if no font matches
- */
-export function getFontByName(aFontName: string, aDefaultValue: Node): Node;
-
-/**
- * Gets the font with a given class name
- * @param aClassName the class name of the font
- * @return the first font with class name aClassName, or <code>null</code> if no font matches
- */
-export function getFontByClassName(aClassName: string): Node;
-
-/**
- * Gets the font with a given class name with a fallback value if no font matches
- * @param aClassName the class name of the font
- * @param aDefaultValue fallback value
- * @return the first font with class name aClassName, or aDefaultValue if no font matches
- */
-export function getFontByClassName(
-  aClassName: string,
-  aDefaultValue: Node
-): Node;
+import type Node from "../../types/javax/jcr/Node";
 
 /**
  * Utility interface for Fonts.
@@ -42,8 +9,40 @@ export function getFontByClassName(
  * </p>
  * @author Magnus Lövgren
  */
-declare namespace fontUtil {
-  export { getFontByName, getFontByClassName };
+export interface FontUtil {
+  /**
+   * Gets the font with a given font name
+   * @param aFontName the name of the font
+   * @return the first font with name aFontName, or <code>null</code> if no font matches
+   */
+  getFontByName(aFontName: string): Node;
+
+  /**
+   * Gets the font with a given font name with a fallback value if no font matches
+   * @param aFontName the name of the font
+   * @param aDefaultValue fallback value
+   * @return the first font with name aFontName, or aDefaultValue if no font matches
+   */
+  getFontByName(aFontName: string, aDefaultValue: Node): Node;
+
+  /**
+   * Gets the font with a given class name
+   * @param aClassName the class name of the font
+   * @return the first font with class name aClassName, or <code>null</code> if no font matches
+   */
+  getFontByClassName(aClassName: string): Node;
+
+  /**
+   * Gets the font with a given class name with a fallback value if no font matches
+   * @param aClassName the class name of the font
+   * @param aDefaultValue fallback value
+   * @return the first font with class name aClassName, or aDefaultValue if no font matches
+   */
+  getFontByClassName(aClassName: string, aDefaultValue: Node): Node;
 }
 
-export default fontUtil;
+declare namespace FontUtil {}
+
+declare var fontUtil: FontUtil;
+
+export = fontUtil;

package/server/FormatterBuilderFactory/index.d.ts

@@ -1,80 +1,5 @@
-import type { NumericFormatterBuilder } from "../../types/senselogic/sitevision/api/format/NumericFormatterBuilder";
-import type { Currency } from "../../types/senselogic/sitevision/api/i18n/Currency";
-
-/**
- * Returns a builder for creating number formatters with a given Locale.
- *
- * <p>
- *    <em>The builder returned by this method will create instances that are conceptually equivalent with
- *    <code>java.text.NumberFormat.getNumberInstance(aLocale)</code>.</em>
- * </p>
- * @param aLocale the Locale
- * @return a NumericFormatterBuilder that creates number formatters
- * @throws NullPointerException if aLocale is null
- */
-export function getNumberFormatterBuilder(
-  aLocale: unknown
-): NumericFormatterBuilder;
-
-/**
- * Returns a builder for creating percent formatters with a given Locale.
- *
- * <p>
- *    <em>The builder returned by this method will create instances that are conceptually equivalent with
- *    <code>java.text.NumberFormat.getPercentInstance(aLocale)</code>.</em>
- * </p>
- * @param aLocale the Locale
- * @return a NumericFormatterBuilder that creates percent formatters
- * @throws NullPointerException if aLocale is null
- */
-export function getPercentFormatterBuilder(
-  aLocale: unknown
-): NumericFormatterBuilder;
-
-/**
- * Returns a builder for creating currency formatters with a given Locale.
- *
- * <p>
- *    <strong>Currency note!</strong> Currency typically depends on a <em>country</em>. A language-only Locale
- *    will typically be formatted without any specific currency. Use {@link #getCurrencyFormatterBuilder(Locale, Currency)}
- *    to actively specify what currency to use when using such locale.
- * </p>
- *
- * <p>
- *    <em>The builder returned by this method will create instances that are conceptually equivalent with
- *    <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code>.</em>
- * </p>
- * @param aLocale the Locale
- * @return a NumericFormatterBuilder that creates currency formatters
- * @throws NullPointerException if aLocale is null
- * @see #getCurrencyFormatterBuilder(Locale, Currency)
- */
-export function getCurrencyFormatterBuilder(
-  aLocale: unknown
-): NumericFormatterBuilder;
-
-/**
- * Returns a builder for creating currency formatters with a given Locale and Currency.
- *
- * <p>
- *    Currency instances are created via methods in {@link senselogic.sitevision.api.i18n.CurrencyFactory}.
- * </p>
- *
- * <p>
- *    <em>The builder returned by this method will create instances that are conceptually equivalent with
- *    <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code> with a
- *    <code>java.util.Currency.getInstance(aCurrencyCode)</code> set.</em>
- * </p>
- * @param aLocale the Locale
- * @param aCurrency the currency
- * @return a NumericFormatterBuilder that creates currency formatters
- * @throws NullPointerException if aLocale or aCurrency is null
- * @see senselogic.sitevision.api.i18n.CurrencyFactory
- */
-export function getCurrencyFormatterBuilder(
-  aLocale: unknown,
-  aCurrency: Currency
-): NumericFormatterBuilder;
+import type NumericFormatterBuilder from "../../types/senselogic/sitevision/api/format/NumericFormatterBuilder";
+import type Currency from "../../types/senselogic/sitevision/api/i18n/Currency";
 
 /**
  * Factory for creating formatter builders.
@@ -87,12 +12,79 @@ export function getCurrencyFormatterBuilder(
  * @author Magnus Lövgren
  * @since Sitevision 6.1
  */
-declare namespace formatterBuilderFactory {
-  export {
-    getNumberFormatterBuilder,
-    getPercentFormatterBuilder,
-    getCurrencyFormatterBuilder,
-  };
+export interface FormatterBuilderFactory {
+  /**
+   * Returns a builder for creating number formatters with a given Locale.
+   *
+   * <p>
+   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
+   *    <code>java.text.NumberFormat.getNumberInstance(aLocale)</code>.</em>
+   * </p>
+   * @param aLocale the Locale
+   * @return a NumericFormatterBuilder that creates number formatters
+   * @throws NullPointerException if aLocale is null
+   */
+  getNumberFormatterBuilder(aLocale: unknown): NumericFormatterBuilder;
+
+  /**
+   * Returns a builder for creating percent formatters with a given Locale.
+   *
+   * <p>
+   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
+   *    <code>java.text.NumberFormat.getPercentInstance(aLocale)</code>.</em>
+   * </p>
+   * @param aLocale the Locale
+   * @return a NumericFormatterBuilder that creates percent formatters
+   * @throws NullPointerException if aLocale is null
+   */
+  getPercentFormatterBuilder(aLocale: unknown): NumericFormatterBuilder;
+
+  /**
+   * Returns a builder for creating currency formatters with a given Locale.
+   *
+   * <p>
+   *    <strong>Currency note!</strong> Currency typically depends on a <em>country</em>. A language-only Locale
+   *    will typically be formatted without any specific currency. Use {@link #getCurrencyFormatterBuilder(Locale, Currency)}
+   *    to actively specify what currency to use when using such locale.
+   * </p>
+   *
+   * <p>
+   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
+   *    <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code>.</em>
+   * </p>
+   * @param aLocale the Locale
+   * @return a NumericFormatterBuilder that creates currency formatters
+   * @throws NullPointerException if aLocale is null
+   * @see #getCurrencyFormatterBuilder(Locale, Currency)
+   */
+  getCurrencyFormatterBuilder(aLocale: unknown): NumericFormatterBuilder;
+
+  /**
+   * Returns a builder for creating currency formatters with a given Locale and Currency.
+   *
+   * <p>
+   *    Currency instances are created via methods in {@link senselogic.sitevision.api.i18n.CurrencyFactory}.
+   * </p>
+   *
+   * <p>
+   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
+   *    <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code> with a
+   *    <code>java.util.Currency.getInstance(aCurrencyCode)</code> set.</em>
+   * </p>
+   * @param aLocale the Locale
+   * @param aCurrency the currency
+   * @return a NumericFormatterBuilder that creates currency formatters
+   * @throws NullPointerException if aLocale or aCurrency is null
+   * @see senselogic.sitevision.api.i18n.CurrencyFactory
+   */
+  getCurrencyFormatterBuilder(
+    aLocale: unknown,
+    aCurrency: Currency
+  ): NumericFormatterBuilder;
 }
 
-export default formatterBuilderFactory;
+declare namespace FormatterBuilderFactory {}
+
+declare var formatterBuilderFactory: FormatterBuilderFactory;
+
+export = formatterBuilderFactory;