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

package/server/RedirectUtil/index.d.ts

@@ -1,63 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Gets all 301 redirect URIs registered for a specific node.
- * @param aNode a node, typically a <code>sv:page</code>
- * @return a set of 301 redirect URIs for <code>aNode</code>, never <code>null</code>
- */
-export function getRedirectURIs(aNode: Node): unknown;
-
-/**
- * Adds a relative URI that should trigger a 301 redirect to a specific node.
- *
- * <p>
- *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
- * </p>
- * @param aNode a node, typically a <code>sv:page</code>
- * @param aRelativeURI the relative URI that should trigger a 301 redirect to <code>aNode</code>.
- * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
- * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
- */
-export function addRedirectURI(aNode: Node, aRelativeURI: string): void;
-
-/**
- * Adds a collection of relative URIs that should trigger 301 redirects to a specific node.
- *
- * <p>
- *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
- * </p>
- * @param aNode a node, typically a <code>sv:page</code>
- * @param aRelativeURIs a collection of relative URIs that should trigger 301 redirects to <code>aNode</code>.
- * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, empty or doesn't contain any non-whitespace only or an non-absolute URI.
- * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
- */
-export function addRedirectURIs(aNode: Node, aRelativeURIs: unknown): void;
-
-/**
- * Removes a relative 301 redirect URI from a specific node.
- *
- * <p>
- *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
- * </p>
- * @param aNode a node, typically a <code>sv:page</code>
- * @param aRelativeURI the relative URI that should be removed from <code>aNode</code>.
- * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
- * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
- */
-export function removeRedirectURI(aNode: Node, aRelativeURI: string): void;
-
-/**
- * Removes all relative 301 redirect URIs from a specific node.
- *
- * <p>
- *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
- * </p>
- * @param aNode a node, typically a <code>sv:page</code>
- * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node,
- * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
- */
-export function removeAllRedirectURIs(aNode: Node): void;
-
 /**
  * Redirect utility interface (301 redirects for <em>"old urls"</em>).
  *
@@ -69,14 +11,68 @@ export function removeAllRedirectURIs(aNode: Node): void;
  * @author Magnus Lövgren
  * @since Sitevision 4.0.3
  */
-declare namespace redirectUtil {
-  export {
-    getRedirectURIs,
-    addRedirectURI,
-    addRedirectURIs,
-    removeRedirectURI,
-    removeAllRedirectURIs,
-  };
+export interface RedirectUtil {
+  /**
+   * Gets all 301 redirect URIs registered for a specific node.
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @return a set of 301 redirect URIs for <code>aNode</code>, never <code>null</code>
+   */
+  getRedirectURIs(aNode: Node): unknown;
+
+  /**
+   * Adds a relative URI that should trigger a 301 redirect to a specific node.
+   *
+   * <p>
+   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+   * </p>
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @param aRelativeURI the relative URI that should trigger a 301 redirect to <code>aNode</code>.
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
+   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+   */
+  addRedirectURI(aNode: Node, aRelativeURI: string): void;
+
+  /**
+   * Adds a collection of relative URIs that should trigger 301 redirects to a specific node.
+   *
+   * <p>
+   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+   * </p>
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @param aRelativeURIs a collection of relative URIs that should trigger 301 redirects to <code>aNode</code>.
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, empty or doesn't contain any non-whitespace only or an non-absolute URI.
+   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+   */
+  addRedirectURIs(aNode: Node, aRelativeURIs: unknown): void;
+
+  /**
+   * Removes a relative 301 redirect URI from a specific node.
+   *
+   * <p>
+   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+   * </p>
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @param aRelativeURI the relative URI that should be removed from <code>aNode</code>.
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
+   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+   */
+  removeRedirectURI(aNode: Node, aRelativeURI: string): void;
+
+  /**
+   * Removes all relative 301 redirect URIs from a specific node.
+   *
+   * <p>
+   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+   * </p>
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node,
+   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+   */
+  removeAllRedirectURIs(aNode: Node): void;
 }
 
+declare namespace RedirectUtil {}
+
+declare var redirectUtil: RedirectUtil;
+
 export default redirectUtil;

package/server/RelatedValueBuilder/index.d.ts

@@ -4,42 +4,6 @@ import type { Node } from "../../types/javax/jcr/Node";
 import type { RelatedValue } from "../../types/senselogic/sitevision/api/metadata/value/RelatedValue";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * Adds a link value.
- * @param aLinkValue the link value to add
- * @return this builder
- * @throws IllegalArgumentException if <code>aLinkValue</code> is <code>null</code> or not an instance created via {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder}
- */
-export function addLinkValue(aLinkValue: LinkValue): RelatedValueBuilder;
-
-/**
- * Adds a user value.
- * @param aUserNode the user node to add (a node with primary node type <em>sv:user</em> or <em>sv:simpleUser</em>)
- * @return this builder
- * @throws IllegalArgumentException if <code>aUserNode</code> is <code>null</code> or an invalid user node (e.g. sv:systemUser - <em>Anonymous</em>, <em>System</em>, <em>Indexer</em>, <em>Validator</em> or <em>Extractor</em>)
- */
-export function addUser(aUserNode: Node): RelatedValueBuilder;
-
-/**
- * Adds a text value.
- * @param aText the text to add. A <code>null</code> or whitespace-only value will be completely ignored.
- * @return this builder
- */
-export function addText(aText: string): RelatedValueBuilder;
-
-/**
- * Removes all currently added values.
- * @return this builder
- */
-export function clearValues(): RelatedValueBuilder;
-
-/**
- * Creates a RelatedValue instance using current state of this builder.
- * @return a related value
- * @throws IllegalStateException if the builder contains no values.
- */
-export function build(): RelatedValue;
-
 /**
  * Builder to create RelatedValue instances that can be used to set related metadata.
  *
@@ -85,8 +49,46 @@ export function build(): RelatedValue;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace relatedValueBuilder {
-  export { addLinkValue, addUser, addText, clearValues, build };
+export interface RelatedValueBuilder extends Builder {
+  /**
+   * Adds a link value.
+   * @param aLinkValue the link value to add
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aLinkValue</code> is <code>null</code> or not an instance created via {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder}
+   */
+  addLinkValue(aLinkValue: LinkValue): RelatedValueBuilder;
+
+  /**
+   * Adds a user value.
+   * @param aUserNode the user node to add (a node with primary node type <em>sv:user</em> or <em>sv:simpleUser</em>)
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aUserNode</code> is <code>null</code> or an invalid user node (e.g. sv:systemUser - <em>Anonymous</em>, <em>System</em>, <em>Indexer</em>, <em>Validator</em> or <em>Extractor</em>)
+   */
+  addUser(aUserNode: Node): RelatedValueBuilder;
+
+  /**
+   * Adds a text value.
+   * @param aText the text to add. A <code>null</code> or whitespace-only value will be completely ignored.
+   * @return this builder
+   */
+  addText(aText: string): RelatedValueBuilder;
+
+  /**
+   * Removes all currently added values.
+   * @return this builder
+   */
+  clearValues(): RelatedValueBuilder;
+
+  /**
+   * Creates a RelatedValue instance using current state of this builder.
+   * @return a related value
+   * @throws IllegalStateException if the builder contains no values.
+   */
+  build(): RelatedValue;
 }
 
+declare namespace RelatedValueBuilder {}
+
+declare var relatedValueBuilder: RelatedValueBuilder;
+
 export default relatedValueBuilder;

package/server/Requester/index.d.ts

@@ -1,126 +1,5 @@
 import type { RequesterChainable } from "../../types/senselogic/sitevision/api/script/RequesterChainable";
 
-/**
- * Execute a HTTP GET.
- * @param aURL the url
- * @return a chainable requester
- */
-export function get(aURL: string): RequesterChainable;
-
-/**
- * Execute a HTTP GET with options.
- * @param aURL the url
- * @param aOptions the options, <a href="#options">see options example above</a>
- * @return a chainable requester
- */
-export function get(aURL: string, aOptions: unknown): RequesterChainable;
-
-/**
- * Execute a HTTP PUT.
- * @param aURL the url
- * @return a chainable requester
- */
-export function put(aURL: string): RequesterChainable;
-
-/**
- * Execute a HTTP PUT with options.
- * @param aURL the url
- * @param aOptions the options, <a href="#options">see options example above</a>
- * @return a chainable requester
- */
-export function put(aURL: string, aOptions: unknown): RequesterChainable;
-
-/**
- * Execute a HTTP POST.
- * @param aURL the url
- * @return a chainable requester
- */
-export function post(aURL: string): RequesterChainable;
-
-/**
- * Execute a HTTP POST with options.
- * @param aURL the url
- * @param aOptions the options, <a href="#options">see options example above</a>
- * @return a chainable requester
- */
-export function post(aURL: string, aOptions: unknown): RequesterChainable;
-
-/**
- * Execute a HTTP DELETE.
- * @param aURL the url
- * @return a chainable requester
- */
-export function _delete(aURL: string): RequesterChainable;
-
-/**
- * Execute a HTTP DELETE with options.
- *
- * <p>aOptions extension for delete</p>
- * <ul>
- *    <li><em>deleteOptions (key/value) [@since Sitevision 4.5.3]</em> - options for delete
- *       <ul>
- *          <li><em>sendDataAsBody (boolean)</em> - send data in the request body</li>
- *       </ul>
- *    </li>
- * </ul>
- * @param aURL the url
- * @param aOptions the options, <a href="#options">see options example above</a>
- * @return a chainable requester
- */
-export function _delete(aURL: string, aOptions: unknown): RequesterChainable;
-
-/**
- * Execute a HTTP PATCH.
- *
- * <p>
- *    Note! The RFC5789 PATCH method is neither safe nor idempotent as defined by RFC2616.
- * </p>
- * @param aURL the url
- * @return a chainable requester
- * @since Sitevision 7.2.3
- */
-export function patch(aURL: string): RequesterChainable;
-
-/**
- * Execute a HTTP PATCH with options.
- *
- * <p>
- *    Note! The RFC5789 PATCH method is neither safe nor idempotent as defined by RFC2616.
- * </p>
- * @param aURL the url
- * @param aOptions the options, <a href="#options">see options example above</a>
- * @return a chainable requester
- * @since Sitevision 7.2.3
- */
-export function patch(aURL: string, aOptions: unknown): RequesterChainable;
-
-/**
- * Execute a HTTP HEAD.
- *
- * <p>
- *    Note! The response of a HEAD request does not have a body.
- * </p>
- * @param aURL the url
- * @return a chainable requester
- * @since Sitevision 7.2.3
- */
-export function head(aURL: string): RequesterChainable;
-
-/**
- * Execute a HTTP HEAD with options.
- *
- * <p>
- *    Note! The response of a HEAD request does not have a body.
- * </p>
- * @param aURL the url
- * @param aOptions the options, <a href="#options">see options example above</a>
- * @return a chainable requester
- * @since Sitevision 7.2.3
- */
-export function head(aURL: string, aOptions: unknown): RequesterChainable;
-
-export { _delete as delete };
-
 /**
  * Script utility for handling data (typically JSON) from an external website.
  *
@@ -418,8 +297,129 @@ export { _delete as delete };
  * @see RestApi
  * @see senselogic.sitevision.api.script.app.RestAppInvoker
  */
-declare namespace requester {
-  export { get, put, post, _delete as delete, patch, head };
+export interface Requester {
+  /**
+   * Execute a HTTP GET.
+   * @param aURL the url
+   * @return a chainable requester
+   */
+  get(aURL: string): RequesterChainable;
+
+  /**
+   * Execute a HTTP GET with options.
+   * @param aURL the url
+   * @param aOptions the options, <a href="#options">see options example above</a>
+   * @return a chainable requester
+   */
+  get(aURL: string, aOptions: unknown): RequesterChainable;
+
+  /**
+   * Execute a HTTP PUT.
+   * @param aURL the url
+   * @return a chainable requester
+   */
+  put(aURL: string): RequesterChainable;
+
+  /**
+   * Execute a HTTP PUT with options.
+   * @param aURL the url
+   * @param aOptions the options, <a href="#options">see options example above</a>
+   * @return a chainable requester
+   */
+  put(aURL: string, aOptions: unknown): RequesterChainable;
+
+  /**
+   * Execute a HTTP POST.
+   * @param aURL the url
+   * @return a chainable requester
+   */
+  post(aURL: string): RequesterChainable;
+
+  /**
+   * Execute a HTTP POST with options.
+   * @param aURL the url
+   * @param aOptions the options, <a href="#options">see options example above</a>
+   * @return a chainable requester
+   */
+  post(aURL: string, aOptions: unknown): RequesterChainable;
+
+  /**
+   * Execute a HTTP DELETE.
+   * @param aURL the url
+   * @return a chainable requester
+   */
+  delete(aURL: string): RequesterChainable;
+
+  /**
+   * Execute a HTTP DELETE with options.
+   *
+   * <p>aOptions extension for delete</p>
+   * <ul>
+   *    <li><em>deleteOptions (key/value) [@since Sitevision 4.5.3]</em> - options for delete
+   *       <ul>
+   *          <li><em>sendDataAsBody (boolean)</em> - send data in the request body</li>
+   *       </ul>
+   *    </li>
+   * </ul>
+   * @param aURL the url
+   * @param aOptions the options, <a href="#options">see options example above</a>
+   * @return a chainable requester
+   */
+  delete(aURL: string, aOptions: unknown): RequesterChainable;
+
+  /**
+   * Execute a HTTP PATCH.
+   *
+   * <p>
+   *    Note! The RFC5789 PATCH method is neither safe nor idempotent as defined by RFC2616.
+   * </p>
+   * @param aURL the url
+   * @return a chainable requester
+   * @since Sitevision 7.2.3
+   */
+  patch(aURL: string): RequesterChainable;
+
+  /**
+   * Execute a HTTP PATCH with options.
+   *
+   * <p>
+   *    Note! The RFC5789 PATCH method is neither safe nor idempotent as defined by RFC2616.
+   * </p>
+   * @param aURL the url
+   * @param aOptions the options, <a href="#options">see options example above</a>
+   * @return a chainable requester
+   * @since Sitevision 7.2.3
+   */
+  patch(aURL: string, aOptions: unknown): RequesterChainable;
+
+  /**
+   * Execute a HTTP HEAD.
+   *
+   * <p>
+   *    Note! The response of a HEAD request does not have a body.
+   * </p>
+   * @param aURL the url
+   * @return a chainable requester
+   * @since Sitevision 7.2.3
+   */
+  head(aURL: string): RequesterChainable;
+
+  /**
+   * Execute a HTTP HEAD with options.
+   *
+   * <p>
+   *    Note! The response of a HEAD request does not have a body.
+   * </p>
+   * @param aURL the url
+   * @param aOptions the options, <a href="#options">see options example above</a>
+   * @return a chainable requester
+   * @since Sitevision 7.2.3
+   */
+  head(aURL: string, aOptions: unknown): RequesterChainable;
 }
 
+declare namespace Requester {}
+
+declare var requester: Requester;
+
 export default requester;