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

package/server/InstanceTypeUtil/index.d.ts

@@ -1,166 +1,3 @@
-/**
- * Checks if an object is a <code>String</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.String</code> or not.
- */
-export function isString(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Boolean</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Boolean</code> or not.
- */
-export function isBoolean(aObject: unknown): boolean;
-
-/**
- * Checks if an object is an <code>Integer</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Integer</code> or not.
- */
-export function isInteger(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Long</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Long</code> or not.
- */
-export function isLong(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Double</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Double</code> or not.
- */
-export function isDouble(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Float</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Float</code> or not.
- */
-export function isFloat(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Number</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Number</code> or not.
- * @since Sitevision 4.2.3
- */
-export function isNumber(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Node</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>{@link javax.jcr.Node}</code> or not.
- * @see senselogic.sitevision.api.node.NodeTypeUtil
- */
-export function isNode(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Property</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>{@link javax.jcr.Property}</code> or not.
- */
-export function isProperty(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Date</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.util.Date</code> or not.
- */
-export function isDate(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Calendar</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Calendar</code> or not.
- * @since Sitevision 4.2.3
- */
-export function isCalendar(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>List</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.util.List</code> or not.
- */
-export function isList(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Map</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.util.Map</code> or not.
- */
-export function isMap(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Set</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.util.Set</code> or not.
- */
-export function isSet(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Collection</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.util.Collection</code> or not.
- */
-export function isCollection(aObject: unknown): boolean;
-
-/**
- * Checks if an object is an <code>Iterator</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.util.Iterator</code> or not.
- */
-export function isIterator(aObject: unknown): boolean;
-
-/**
- * Checks if an object is an <code>Iterable</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Iterable</code> or not.
- * @since Sitevision 4.2.3
- */
-export function isIterable(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Serializable</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.io.Serializable</code> or not.
- * @since Sitevision 4.2.3
- */
-export function isSerializable(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Comparator</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Comparator</code> or not.
- * @since Sitevision 4.2.3
- */
-export function isComparator(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Comparable</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Comparable</code> or not.
- * @since Sitevision 4.2.3
- */
-export function isComparable(aObject: unknown): boolean;
-
-/**
- * Checks if an object is an <code>Exception</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Exception</code> or not.
- * @since Sitevision 4.2.3
- */
-export function isException(aObject: unknown): boolean;
-
-/**
- * Checks if an object is a <code>Throwable</code>.
- * @param aObject the object to be checked
- * @return whether <code>aObject</code> is a <code>java.lang.Throwable</code> or not.
- * @since Sitevision 4.2.3
- */
-export function isThrowable(aObject: unknown): boolean;
-
 /**
  * Instance type utility interface.
  *
@@ -172,31 +9,173 @@ export function isThrowable(aObject: unknown): boolean;
  * @author Magnus Lövgren
  * @since Sitevision 2.6.2
  */
-declare namespace instanceTypeUtil {
-  export {
-    isString,
-    isBoolean,
-    isInteger,
-    isLong,
-    isDouble,
-    isFloat,
-    isNumber,
-    isNode,
-    isProperty,
-    isDate,
-    isCalendar,
-    isList,
-    isMap,
-    isSet,
-    isCollection,
-    isIterator,
-    isIterable,
-    isSerializable,
-    isComparator,
-    isComparable,
-    isException,
-    isThrowable,
-  };
+export interface InstanceTypeUtil {
+  /**
+   * Checks if an object is a <code>String</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.String</code> or not.
+   */
+  isString(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Boolean</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Boolean</code> or not.
+   */
+  isBoolean(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is an <code>Integer</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Integer</code> or not.
+   */
+  isInteger(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Long</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Long</code> or not.
+   */
+  isLong(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Double</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Double</code> or not.
+   */
+  isDouble(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Float</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Float</code> or not.
+   */
+  isFloat(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Number</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Number</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isNumber(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Node</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>{@link javax.jcr.Node}</code> or not.
+   * @see senselogic.sitevision.api.node.NodeTypeUtil
+   */
+  isNode(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Property</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>{@link javax.jcr.Property}</code> or not.
+   */
+  isProperty(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Date</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Date</code> or not.
+   */
+  isDate(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Calendar</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Calendar</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isCalendar(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>List</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.List</code> or not.
+   */
+  isList(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Map</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Map</code> or not.
+   */
+  isMap(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Set</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Set</code> or not.
+   */
+  isSet(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Collection</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Collection</code> or not.
+   */
+  isCollection(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is an <code>Iterator</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Iterator</code> or not.
+   */
+  isIterator(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is an <code>Iterable</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Iterable</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isIterable(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Serializable</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.io.Serializable</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isSerializable(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Comparator</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Comparator</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isComparator(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Comparable</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Comparable</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isComparable(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is an <code>Exception</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Exception</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isException(aObject: unknown): boolean;
+
+  /**
+   * Checks if an object is a <code>Throwable</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Throwable</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isThrowable(aObject: unknown): boolean;
 }
 
-export default instanceTypeUtil;
+declare namespace InstanceTypeUtil {}
+
+declare var instanceTypeUtil: InstanceTypeUtil;
+
+export = instanceTypeUtil;

package/server/JwtUtil/index.d.ts

@@ -1,129 +1,4 @@
-import type { Node } from "../../types/javax/jcr/Node";
-
-/**
- * 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.
- */
-export function createSHAToken(
-  aClaims: unknown,
-  aAlgorithm: string,
-  aPreSharedKey: 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.
- */
-export function createRSAToken(
-  aClaims: unknown,
-  aAlgorithm: string,
-  aPrivateKey: Node,
-  aPassword: 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.
- */
-export function decodeSHA(aToken: string, aPreSharedKey: 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
- */
-export function decodeRSA(aToken: string, aPublicKey: Node): unknown;
+import type Node from "../../types/javax/jcr/Node";
 
 /**
  * JSON Web Token (JWT) utilities.
@@ -139,8 +14,135 @@ export function decodeRSA(aToken: string, aPublicKey: Node): unknown;
  * @since Sitevision 5.1
  * @author Anders Sjöstrand
  */
-declare namespace jwtUtil {
-  export { createSHAToken, createRSAToken, decodeSHA, decodeRSA };
+export 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: unknown,
+    aAlgorithm: string,
+    aPreSharedKey: 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: unknown,
+    aAlgorithm: string,
+    aPrivateKey: Node,
+    aPassword: 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: string, aPreSharedKey: 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: string, aPublicKey: Node): unknown;
 }
 
-export default jwtUtil;
+declare namespace JwtUtil {}
+
+declare var jwtUtil: JwtUtil;
+
+export = jwtUtil;