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

package/hidden/senselogic/sitevision/api/search/searcher/builder/StandardParserBuilder/index.d.ts

@@ -1,102 +0,0 @@
-import Parser from "../../component/Parser";
-import Builder from "../../../../base/Builder";
-
-/**
- * <p>
- *    Builder for creating a single-field {@link senselogic.sitevision.api.search.searcher.component.Parser} component with specific behaviour.
- * </p>
- *
- * <p>
- *    StandardParserBuilder has two <strong>optional attributes</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>default field (df)</em> - The field to query. Default is the field specified by the index configuration.
- *       <em>
- *          (Default field for the default Node index is <code>content.analyzed</code>)
- *       </em>
- *    </li>
- *    <li>
- *       <em>query operator (q.op)</em> - The query operator. Default is the operator specified by the index configuration.
- *    </li>
- * </ul>
- *
- * <p>
- *    Using the StandardParserBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
- *    would typically use it like this:
- * </p>
- * <ol>
- *   <li>Get the StandardParserBuilder</li>
- *   <li>Possibly set the default field</li>
- *   <li>Do build</li>
- * </ol>
- * <p>
- *    When you have built a <code>Parser</code> instance, you can re-use the StandardParserBuilder to build more instances. Typically like:
- * </p>
- * <ol>
- *   <li>(Re-)set the default field</li>
- *   <li>Do build</li>
- * </ol>
- * <p>
- *    <strong>Example of how this strategy could be implemented in Velocity:</strong>
- * </p>
- * <pre><code>
- *   <em>## Get the builder</em>
- *   #set ($searchFactory = $sitevisionUtils.searchFactory)
- *   #set ($standardBuilder = $searchFactory.standardParserBuilder)
- *
- *   <em>## Create a Parser</em>
- *   #set ($nameFieldParser = $standardBuilder.setDefaultField('name.analyzed').build())
- *
- *   <em>## Re-use the builder to create another Parser</em>
- *   #set ($titleFieldParser = $standardBuilder.setDefaultField('title.analyzed').build())
- * </code></pre>
- *
- * <p>
- *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
- *
- * <p>
- *    <em>Solr note: the defType param for this parser is 'standard' or 'lucene'</em>
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getStandardParserBuilder()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6
- */
-
-interface StandardParserBuilder {
-  /**
-   * Sets the default query field.
-   *
-   * <p>
-   *    <em>Solr note: this is the 'df' param.</em>
-   * </p>
-   * @param aDefaultField the name of the query field, <code>null</code> or whitespace-only values will be ignored
-   * @return this builder
-   */
-  setDefaultField(aDefaultField: java.lang.String): StandardParserBuilder;
-
-  /**
-   * Sets the query operator.
-   *
-   * <p>
-   *    <em>Solr note: this is the 'q.op' param. The value should typically be "AND" or "OR".</em>
-   * </p>
-   * @param aQueryOperator the query operator, all values except [null, "AND", "OR"] will be ignored
-   * @return this builder
-   * @since Sitevision 4.0.2
-   */
-  setQueryOperator(aQueryOperator: java.lang.String): StandardParserBuilder;
-
-  /**
-   * Creates a Parser component instance using currently specified state/behaviour.
-   * @return a Parser component.
-   */
-  build(): Parser;
-}

package/hidden/senselogic/sitevision/api/security/AuthenticationUtil/index.d.ts

@@ -1,103 +0,0 @@
-/**
- * <p>
- *    Authentication utility interface.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getAuthenticationUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Mikael Wikblom
- * @since Sitevision 2.6.1_03, Sitevision 2.7_01
- */
-
-interface AuthenticationUtil {
-  /**
-   * Logout current user based on a HttpServletRequest.
-   * @param aServletRequest the current servlet request
-   * @param invalidateHttpSession whether or not the session should be invalidated. This is normally not the case
-   */
-  logout(
-    aServletRequest: javax.servlet.http.HttpServletRequest,
-    invalidateHttpSession: boolean
-  ): void;
-
-  /**
-   * Logout current user based on a PortletRequest.
-   * @param aPortletRequest the current portlet request
-   * @param invalidateHttpSession whether or not the session should be invalidated. This is normally not the case
-   */
-  logout(
-    aPortletRequest: javax.portlet.PortletRequest,
-    invalidateHttpSession: boolean
-  ): void;
-
-  /**
-   * Authenticates a user based on a shared state map.
-   * @param aServletRequest the current servlet request
-   * @param sharedState a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"
-   * @throws LoginException if login fails
-   * @since Sitevision 2.6.2_06
-   */
-  login(
-    aServletRequest: javax.servlet.http.HttpServletRequest,
-    sharedState: java.util.Map
-  ): void;
-
-  /**
-   * Authenticates a user based on username and password.
-   * @param aServletRequest the current servlet request
-   * @param name a username
-   * @param password a password
-   * @throws LoginException if login fails
-   * @since Sitevision 2.6.2_06
-   */
-  login(
-    aServletRequest: javax.servlet.http.HttpServletRequest,
-    name: java.lang.String,
-    password: java.lang.String
-  ): void;
-
-  /**
-   * Re-authenticates a user based on a Subject already in the session.
-   * @param aServletRequest the current servlet request
-   * @throws LoginException if login fails
-   * @since Sitevision 2.6.2_06
-   */
-  reLogin(aServletRequest: javax.servlet.http.HttpServletRequest): void;
-
-  /**
-   * Authenticates a user based on a shared state map.
-   * @param aPortletRequest the current portlet request
-   * @param sharedState a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"
-   * @throws LoginException if login fails
-   * @since Sitevision 2.6.2_06
-   */
-  login(
-    aPortletRequest: javax.portlet.PortletRequest,
-    sharedState: java.util.Map
-  ): void;
-
-  /**
-   * Authenticates a user based on username and password.
-   * @param aPortletRequest the current portlet request
-   * @param name a username
-   * @param password a password
-   * @throws LoginException if login fails
-   * @since Sitevision 2.6.2_06
-   */
-  login(
-    aPortletRequest: javax.portlet.PortletRequest,
-    name: java.lang.String,
-    password: java.lang.String
-  ): void;
-
-  /**
-   * Re-authenticates a user based on a Subject already in the session.
-   * @param aPortletRequest the current portlet request
-   * @throws LoginException if login fails
-   * @since Sitevision 2.6.2_06
-   */
-  reLogin(aPortletRequest: javax.portlet.PortletRequest): void;
-}

package/hidden/senselogic/sitevision/api/security/DirectoryUtil/index.d.ts

@@ -1,98 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-import Property from "../../../../../javax/jcr/Property";
-
-/**
- * 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>
- * @author Magnus Lövgren
- * @since Sitevision 2.6
- */
-
-interface DirectoryUtil {
-  /**
-   * 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)
-   */
-  search(aSearchFilter: java.lang.String): unknown[];
-
-  /**
-   * 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)
-   */
-  search(aSearchFilter: java.lang.String, aDirectoryNode: Node): unknown[];
-
-  /**
-   * 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)
-   */
-  search(
-    aSearchFilter: java.lang.String,
-    aDirectoryNode: Node,
-    aSearchBase: java.lang.String
-  ): unknown[];
-
-  /**
-   * 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
-   */
-  getNodeByDN(aDirectoryObjectDN: java.lang.String): 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>)
-   */
-  getAttributeAsProperty(
-    aDirectoryObjectNode: Node,
-    anAttributeName: java.lang.String
-  ): Property;
-
-  /**
-   * 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
-   */
-  simpleSearch(
-    aSearchFilter: java.lang.String,
-    searchBase: java.lang.String,
-    attributes: java.util.List
-  ): Record<unknown, unknown>;
-}

package/hidden/senselogic/sitevision/api/security/JwtUtil/index.d.ts

@@ -1,143 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * JSON Web Token (JWT) utilities.
- *
- * <p>
- *    Technical information about JWT:
- * </p>
- * <ul>
- *    <li><a href="https://jwt.io/introduction/">Introduction to JSON Web Tokens</a></li>
- *    <li><a href="https://tools.ietf.org/html/rfc7519" target="_blank">RFC 7519: The JSON Web Token specification</a></li>
- * </ul>
- * @param <O> script object
- * @since Sitevision 5.1
- * @author Anders Sjöstrand
- */
-
-interface JwtUtil {
-  /**
-   * Create a JWT token with SHA hashing.
-   *
-   * <p>
-   *    When creating a JWT token, Sitevision always adds an IAT (issued at) claim. The IAT date is set to the time of creation.
-   *    Custom <em>claims</em> can be of the following types.
-   * </p>
-   * <ul>
-   *    <li>String</li>
-   *    <li>Boolean</li>
-   *    <li>Integer</li>
-   *    <li>Long</li>
-   *    <li>Array of String</li>
-   *    <li>Array of Long</li>
-   * </ul>
-   *
-   * <p>
-   *    JWT tokens signed using a pre-shared key can use an <em>algorithm</em> of the following types:
-   * </p>
-   * <ul>
-   *    <li>HS256</li>
-   *    <li>HS384</li>
-   *    <li>HS512</li>
-   * </ul>
-   * @param aClaims The claims to send as payload. Claim values can be of types String, Boolean, Integer, Long and also arrays of Strings or Longs
-   * @param aAlgorithm Hashing algorithm used, viable values are HS256, HS384 and HS512
-   * @param aPreSharedKey Pre-shared key used for hashing.
-   * @return A JWT token
-   * @throws JwtException If an error occurs when creating the JWT token
-   * @throws IllegalArgumentException If aPreSharedKey or aAlgorithm is blank.
-   */
-  createSHAToken(
-    aClaims: O,
-    aAlgorithm: java.lang.String,
-    aPreSharedKey: java.lang.String
-  ): string;
-
-  /**
-   * Create a JWT token signed with a RSA keypair.
-   *
-   * <p>
-   *    When creating a JWT token, Sitevision always adds an IAT (issued at) claim. The IAT date is set to the time of creation.
-   *    Custom <em>claims</em> can be of the following types.
-   * </p>
-   * <ul>
-   *    <li>String</li>
-   *    <li>Boolean</li>
-   *    <li>Integer</li>
-   *    <li>Long</li>
-   *    <li>Array of String</li>
-   *    <li>Array of Long</li>
-   * </ul>
-   *
-   * <p>
-   *    JWT tokens signed using a pre-shared key can use an <em>algorithm</em> of the following types:
-   * </p>
-   * <ul>
-   *    <li>RS256</li>
-   *    <li>RS384</li>
-   *    <li>RS512</li>
-   * </ul>
-   *
-   * <p>
-   *     When signing or decoding JWT using RSA keypair, Sitevision only support keys coded in standard PEM text format.
-   *     Private keys can use password, but if a key without password is used, an empty string as password must be supplied.
-   * </p>
-   * @param aClaims The claims to send as payload. Claim values can be of types String, Boolean, Integer, Long and also arrays of Strings or Longs
-   * @param aAlgorithm Signing algorithm used, viable values are RS256, RS384 and RS512
-   * @param aPrivateKey A sv:file or sv:temporaryFile with the PEM formatted RSA private key.
-   * @param aPassword Password for the private key, use an empty string if the key is not password protected.
-   * @return A JWT token
-   * @throws ConstraintViolationException If the private key cannot be found or accessed
-   * @throws JwtException If an error occurs when creating the JWT token
-   * @throws IllegalArgumentException If aPassword is null, aAlgorithm is blank, aPrivateKey is null or if aPrivateKey is not a RSA private key.
-   */
-  createRSAToken(
-    aClaims: O,
-    aAlgorithm: java.lang.String,
-    aPrivateKey: Node,
-    aPassword: java.lang.String
-  ): string;
-
-  /**
-   * Validate a JWT token created with SHA and a pre-shared key.
-   *
-   * <p>
-   *    The algorithm to decode is automatically detected by Sitevision from the token but it must be one of the following types:
-   * </p>
-   * <ul>
-   *    <li>HS256</li>
-   *    <li>HS384</li>
-   *    <li>HS512</li>
-   * </ul>
-   * @param aToken Token to validate
-   * @param aPreSharedKey Pre-shared key that the hash was created with
-   * @return A javascript object with the alg and payload if the token was correctly validated.
-   * @throws JwtException If an error occurs the decoding the JWT token
-   * @throws IllegalArgumentException If aToken or aPreSharedKey are blank.
-   */
-  decodeSHA(aToken: java.lang.String, aPreSharedKey: java.lang.String): unknown;
-
-  /**
-   * Validate a JWT token created using a RSA keypair.
-   *
-   * <p>
-   *    The algorithm to decode is automatically detected by Sitevision from the token but it must be one of the following types:
-   * </p>
-   * <ul>
-   *    <li>RS256</li>
-   *    <li>RS384</li>
-   *    <li>RS512</li>
-   * </ul>
-   *
-   * <p>
-   *     When signing or decoding JWT using RSA keypair, Sitevision only support keys coded in standard PEM text format.
-   * </p>
-   * @param aToken Token to validate.
-   * @param aPublicKey A sv:file or sv:temporaryFile containing the PEM formatted RSA public key for decrypting the JWT token.
-   * @return A javascript object with the alg and payload if the token was correctly validated.
-   * @throws ConstraintViolationException If the public key cannot be found or accessed
-   * @throws JwtException If an error occurs the decoding the JWT token
-   * @throws IllegalArgumentException If aToken is blank, aPublicKey is null or aPublicKey is not a RSA public key
-   */
-  decodeRSA(aToken: java.lang.String, aPublicKey: Node): unknown;
-}

package/hidden/senselogic/sitevision/api/security/MessageDigesterFactory/index.d.ts

@@ -1,46 +0,0 @@
-import MessageDigester from "../MessageDigester";
-
-/**
- * Factory that provides message digester instances that can perform
- * hash computation using a specific algorithm.
- *
- * <p>
- *    Message digests are secure one-way hash functions that take arbitrary-sized
- *    data and output a fixed-length hash value. This factory provides instances
- *    that supports common message digest algorithms, such as MD5 and SHA-256.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getMessageDigesterFactory()}. See {@link senselogic.sitevision.api.Utils}
- *    for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 5.0.1
- */
-
-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;
-}