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

package/types/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts

@@ -26,7 +26,7 @@
  * @author Magnus Lövgren
  * @since Sitevision 3.1
  */
-export type TypedArgument = {
+type TypedArgument = {
   /**
    * Gets the argument class.
    * @return the class of the argument
@@ -39,3 +39,5 @@ export type TypedArgument = {
    */
   getValue(): unknown;
 };
+
+export = TypedArgument;

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts

@@ -83,10 +83,12 @@
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */
-export type ExceptionSuppressingCollection = {
+type ExceptionSuppressingCollection = {
   /**
    * Returns an exception suppressing iterator that ensures no exceptions will be thrown during iteration.
    * @return a {@link ExceptionSuppressingIterator} that suppresses exceptions and returns proxied items
    */
   iterator(): unknown;
 };
+
+export = ExceptionSuppressingCollection;

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts

@@ -1,4 +1,4 @@
-import type { ExceptionSuppressingProxy } from "../ExceptionSuppressingProxy";
+import type ExceptionSuppressingProxy from "../ExceptionSuppressingProxy";
 
 /**
  * Decorates an iterator with exception suppressing behaviour and returns {@link ExceptionSuppressingProxy}s in order to ensure that no
@@ -28,7 +28,7 @@ import type { ExceptionSuppressingProxy } from "../ExceptionSuppressingProxy";
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */
-export type ExceptionSuppressingIterator = {
+type ExceptionSuppressingIterator = {
   /**
    * Returns <code>true</code> if decorated iterator has more elements. (In other words, returns <code>true</code>
    * if <code>next</code> would return an element rather than throwing an exception.)
@@ -80,3 +80,5 @@ export type ExceptionSuppressingIterator = {
     */
   remove(): void;
 };
+
+export = ExceptionSuppressingIterator;

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts

@@ -1,3 +1,5 @@
+import { ExceptionSuppressingProxyConstants } from "../../../render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants";
+
 /**
  * Proxies an object and delegates all interface method invocations to the proxied object in order to ensure that no invocation
  * will throw an exception.
@@ -63,11 +65,11 @@
  *
  *       $!proxy.thisMethodSometimesThrowsExceptions() <em>## Method invoked through a proxy, might return null</em>
  *    &lt;/p&gt;
- * </code></pre>The status indicating that this proxy has no object set, nothing to proxy.The status indicating that last method invocation did not throw an exception.The status indicating that last method invocation did throw an exception
+ * </code></pre>
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */
-export type ExceptionSuppressingProxy = {
+type ExceptionSuppressingProxy = ExceptionSuppressingProxyConstants & {
   /**
    * Returns current status
    * @return {@link #NO_OBJECT_PROXIED_STATUS} or {@link #NO_EXCEPTION_THROWN_STATUS} or {@link #EXCEPTION_THROWN_STATUS}
@@ -85,4 +87,24 @@ export type ExceptionSuppressingProxy = {
    * @return the object that is proxied by an instance of this interface, or <code>null</code> if no proxied object is set
    */
   getProxiedObject(): unknown;
+
+  /**
+ * The status indicating that this proxy has no object set, nothing to proxy.
+  
+    */
+  NO_OBJECT_PROXIED_STATUS: number;
+
+  /**
+ * The status indicating that last method invocation did not throw an exception.
+  
+    */
+  NO_EXCEPTION_THROWN_STATUS: number;
+
+  /**
+ * The status indicating that last method invocation did throw an exception
+  
+    */
+  EXCEPTION_THROWN_STATUS: number;
 };
+
+export = ExceptionSuppressingProxy;

package/types/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts

@@ -14,7 +14,7 @@
  * @since Sitevision 2.6.2, 2.7_06
  * @deprecated use the typed methods in {@link senselogic.sitevision.api.search.SearchHit} instead when extracting values from a search result.
  */
-export type SearchFieldUtil = {
+type SearchFieldUtil = {
   /**
    * Returns the Date for a string field that contains a date value generated via Lucene's DateTools class.
    * @param aDateFieldValue the <code>String</code> that should be converted to a <code>Date</code>
@@ -73,3 +73,5 @@ export type SearchFieldUtil = {
    */
   doubleFieldToDouble(aDoubleFieldValue: string): number;
 };
+
+export = SearchFieldUtil;

package/types/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts

@@ -1,4 +1,4 @@
-import type { SearchHit } from "../SearchHit";
+import type SearchHit from "../SearchHit";
 
 /**
  * <p>
@@ -10,7 +10,7 @@ import type { SearchHit } from "../SearchHit";
  * @since Sitevision 2.7_06
  * @deprecated This interface will do absolutely nothing as of Sitevision 3.0 (search engine has been replaced). Interface methods will not do anything (i.e. always return <code>null</code>) and this interface will be completely removed in future releases of Sitevision.
  */
-export type SearchHighlighter = {
+type SearchHighlighter = {
   /**
    * Returns a highlighted fragment for the default highlighting field.
    * @param aHighlightPreElement the opening element to the left of a highlighted word(-s), e.g <code>"&lt;strong style=\"background-color:yellow\"&gt;"</code>
@@ -41,3 +41,5 @@ export type SearchHighlighter = {
     aHighlightingFieldName: string
   ): string;
 };
+
+export = SearchHighlighter;

package/types/senselogic/sitevision/api/search/SearchHit/index.d.ts

@@ -1,4 +1,6 @@
-import type { Node } from "../../../../../javax/jcr/Node";
+import type Node from "../../../../../javax/jcr/Node";
+
+import { SearchHitConstants } from "../../render/velocity/VelocityAccess.SearchHitConstants";
 
 /**
  * <p>
@@ -17,11 +19,11 @@ import type { Node } from "../../../../../javax/jcr/Node";
  * <p>
  *    <em>This object is short lived in that sense that it is invalid after a specified timespan.
  *    Make sure it's handled correspondingly (i.e. do not cache it).</em>
- * </p><p>Indicates that the hit is an internal resource managed by the Sitevision server</p><p>Indicates that the hit is an external resource</p>
+ * </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6_06
  */
-export type SearchHit = {
+type SearchHit = SearchHitConstants & {
   /**
    * <p>Checks if the value(-s) for a specified field contains a specific value.</p>
    *
@@ -774,4 +776,18 @@ export type SearchHit = {
    * @since Sitevision 3.0
    */
   getClickTrackingCallback(): string;
+
+  /**
+ * <p>Indicates that the hit is an internal resource managed by the Sitevision server</p>
+  
+    */
+  TYPE_INTERNAL: number;
+
+  /**
+ * <p>Indicates that the hit is an external resource</p>
+  
+    */
+  TYPE_EXTERNAL: number;
 };
+
+export = SearchHit;

package/types/senselogic/sitevision/api/search/SearchResult/index.d.ts

@@ -1,4 +1,6 @@
-import type { SearchHighlighter } from "../SearchHighlighter";
+import type SearchHighlighter from "../SearchHighlighter";
+
+import { SearchResultConstants } from "../../render/velocity/VelocityAccess.SearchResultConstants";
 
 /**
  * <p>
@@ -9,15 +11,11 @@ import type { SearchHighlighter } from "../SearchHighlighter";
  * <p>
  *    <strong>Note!</strong> This object is short lived in that sense that it is invalid after a specified timespan.
  *    Make sure it's handled correspondingly (i.e. do <em>not</em> cache it).
- * </p>Search is successful.Search is unsuccessful due to a missing index.Search is unsuccessful due to an invalid search query.Search is unsuccessful due to an unexpected error.
+ * </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6_06
- * @see #getStatus()
- * @see #getStatus()
- * @see #getStatus()
- * @see #getStatus()
  */
-export type SearchResult = {
+type SearchResult = SearchResultConstants & {
   /**
    * <p>Accessor to the lazy loaded <code>Iterator</code> containing the search hits. Iterating the
    * <code>Iterator</code> potentially changes the status of the <code>SearchResult</code>object.</p>
@@ -274,4 +272,30 @@ export type SearchResult = {
    * @deprecated since Sitevision 3.0
    */
   getDateFormatter(aLocale: unknown): unknown;
+
+  /**
+   * Search is successful.
+   * @see #getStatus()
+   */
+  STATUS_OK: number;
+
+  /**
+   * Search is unsuccessful due to a missing index.
+   * @see #getStatus()
+   */
+  STATUS_INDEX_NOT_AVAILABLE: number;
+
+  /**
+   * Search is unsuccessful due to an invalid search query.
+   * @see #getStatus()
+   */
+  STATUS_PARSE_ERROR: number;
+
+  /**
+   * Search is unsuccessful due to an unexpected error.
+   * @see #getStatus()
+   */
+  STATUS_UNEXPECTED_ERROR: number;
 };
+
+export = SearchResult;

package/types/senselogic/sitevision/api/search/facet/SearchFacetField/index.d.ts

@@ -4,7 +4,7 @@
  * @since Sitevision 3.0
  * @see senselogic.sitevision.api.search.SearchResult#getFacetFields()
  */
-export type SearchFacetField = {
+type SearchFacetField = {
   /**
    * Returns the name of this facet field.
    * @return the facet field name
@@ -23,3 +23,5 @@ export type SearchFacetField = {
    */
   getValueCount(): number;
 };
+
+export = SearchFacetField;

package/types/senselogic/sitevision/api/search/facet/SearchFacetValue/index.d.ts

@@ -4,7 +4,7 @@
  * @since Sitevision 3.0
  * @see senselogic.sitevision.api.search.facet.SearchFacetField#getFacetValues()
  */
-export type SearchFacetValue = {
+type SearchFacetValue = {
   /**
    * Returns the number of occurrences (number of expected hits when searching with this facet value).
    * @return the number of occurrences for this facet value.
@@ -46,3 +46,5 @@ export type SearchFacetValue = {
    */
   isSelected(): boolean;
 };
+
+export = SearchFacetValue;

package/types/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts

@@ -1,4 +1,4 @@
-import type { SearchResult } from "../../SearchResult";
+import type SearchResult from "../../SearchResult";
 
 /**
  * <p>
@@ -149,7 +149,7 @@ import type { SearchResult } from "../../SearchResult";
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-export type Searcher = {
+type Searcher = {
   /**
    * Executes a search using the components/behaviour that was specified when the <code>Searcher</code> was created.
    *
@@ -239,3 +239,5 @@ export type Searcher = {
     aMaxHitsToReturn: number
   ): SearchResult;
 };
+
+export = Searcher;

package/types/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts

@@ -20,6 +20,8 @@
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-export type Filter = {
+type Filter = {
   undefined;
 };
+
+export = Filter;

package/types/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts

@@ -24,6 +24,8 @@
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-export type Highlight = {
+type Highlight = {
   undefined;
 };
+
+export = Highlight;

package/types/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts

@@ -20,6 +20,8 @@
  * @author Magnus Lövgren
  * @since Sitevision 4.1
  */
-export type Monitor = {
+type Monitor = {
   undefined;
 };
+
+export = Monitor;

package/types/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts

@@ -30,6 +30,8 @@
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-export type Parser = {
+type Parser = {
   undefined;
 };
+
+export = Parser;

package/types/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts

@@ -20,6 +20,8 @@
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-export type Sort = {
+type Sort = {
   undefined;
 };
+
+export = Sort;

package/types/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts

@@ -24,6 +24,8 @@
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-export type SpellCheck = {
+type SpellCheck = {
   undefined;
 };
+
+export = SpellCheck;

package/types/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts

@@ -5,7 +5,7 @@
  * @see senselogic.sitevision.api.search.SearchResult#getCustomSorts()
  * @since Sitevision 3.1
  */
-export type CustomSort = {
+type CustomSort = {
   /**
    * Gets the name of this custom sort.
    * @return the sort name
@@ -63,3 +63,5 @@ export type CustomSort = {
    */
   getSortQueryParams(): string;
 };
+
+export = CustomSort;

package/types/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts

@@ -4,7 +4,7 @@
  * @since Sitevision 3.0
  * @see senselogic.sitevision.api.search.SearchResult#getSuggestions()
  */
-export type SearchSuggestion = {
+type SearchSuggestion = {
   /**
    * Number of expected hits for this suggestion
    * @return number of expected hits, or <code>-1</code> if unavailable
@@ -17,3 +17,5 @@ export type SearchSuggestion = {
    */
   getName(): string;
 };
+
+export = SearchSuggestion;

package/types/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts

@@ -23,7 +23,7 @@
  * </p>
  * @author Karl Eklöf
  */
-export type DirectoryAttributes = {
+type DirectoryAttributes = {
   /**
    * Returns the directory attribute values for the given attribute name.
    * @param anAttributeName The attribute name for which to get the attribute value for.
@@ -63,3 +63,5 @@ export type DirectoryAttributes = {
    */
   getAttributeValue(anAttributeName: string, returnAsString: boolean): unknown;
 };
+
+export = DirectoryAttributes;

package/types/senselogic/sitevision/api/security/MessageDigester/index.d.ts

@@ -17,7 +17,7 @@
  * @since Sitevision 5.0.1
  * @see MessageDigesterFactory
  */
-export type MessageDigester = {
+type MessageDigester = {
   /**
    * Updates the digest with a byte.
    * @param aByte the byte.
@@ -44,3 +44,5 @@ export type MessageDigester = {
    */
   getAlgorithm(): string;
 };
+
+export = MessageDigester;

package/types/senselogic/sitevision/api/security/RoleAssignment/index.d.ts

@@ -1,4 +1,4 @@
-import type { Node } from "../../../../../javax/jcr/Node";
+import type Node from "../../../../../javax/jcr/Node";
 
 /**
  * Role assignment representation that can be applied on a node to update its roles setup.
@@ -16,7 +16,7 @@ import type { Node } from "../../../../../javax/jcr/Node";
  * @author Magnus Lövgren
  * @since Sitevision 5.1
  */
-export type RoleAssignment = {
+type RoleAssignment = {
   /**
    * Applies this role assignment on a given node.
    * @param aNode the node of the role assignment operation, typically a sv:page
@@ -59,3 +59,5 @@ export type RoleAssignment = {
    */
   revoke(aNode: Node): void;
 };
+
+export = RoleAssignment;

package/types/senselogic/sitevision/api/security/RoleMatcher/index.d.ts

@@ -1,4 +1,4 @@
-import type { Node } from "../../../../../javax/jcr/Node";
+import type Node from "../../../../../javax/jcr/Node";
 
 /**
  * Role matcher representation that can be matched on a node to check "is user in role".
@@ -10,7 +10,7 @@ import type { Node } from "../../../../../javax/jcr/Node";
  * @author Magnus Lövgren
  * @since Sitevision 6.1
  */
-export type RoleMatcher = {
+type RoleMatcher = {
   /**
    * Checks if matcher user is in all matcher roles on a given Node.
    * @param aNode the node, typically a sv:page
@@ -25,3 +25,5 @@ export type RoleMatcher = {
    */
   matchesAny(aNode: Node): boolean;
 };
+
+export = RoleMatcher;

package/types/senselogic/sitevision/api/security/SecretStore/index.d.ts

@@ -12,7 +12,7 @@
  * @author Rickard Öberg
  * @see Secret
  */
-export type SecretStore = {
+type SecretStore = {
   /**
    * Sets a secret for a specified key.
    * @param aKey the identifier for secret
@@ -51,3 +51,5 @@ export type SecretStore = {
     */
   removeAllSecrets(): void;
 };
+
+export = SecretStore;

package/types/senselogic/sitevision/api/security/UserUtil/index.d.ts

@@ -1,4 +1,4 @@
-import type { Node } from "../../../../../javax/jcr/Node";
+import type Node from "../../../../../javax/jcr/Node";
 
 /**
  * Deprecated interface that will be removed in a future Sitevision release.
@@ -6,7 +6,7 @@ import type { Node } from "../../../../../javax/jcr/Node";
  * @since Sitevision 3.0
  * @deprecated use {@link senselogic.sitevision.api.user.SystemUserUtil} and {@link senselogic.sitevision.api.user.UserIdentityUtil} instead
  */
-export type UserUtil = {
+type UserUtil = {
   /**
    * Checks if current user is anonymous (not authenticated).
    * @return <code>true</code> if current user is Anonymous (i.e. not authenticated), <code>false</code> otherwise
@@ -76,3 +76,5 @@ export type UserUtil = {
    */
   getUserIdentity(aUserNode: Node): Node;
 };
+
+export = UserUtil;

package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts

@@ -1,4 +1,4 @@
-import type { AuthenticationFilterChain } from "../AuthenticationFilterChain";
+import type AuthenticationFilterChain from "../AuthenticationFilterChain";
 
 /**
  * <p>
@@ -9,10 +9,10 @@ import type { AuthenticationFilterChain } from "../AuthenticationFilterChain";
  *    <strong>Important legacy note!</strong> As of Sitevision 3 this interface has been moved
  *    (from package senselogic.sitevision.security.jaas.filter.api).
  *    Previously implemented custom JAAS filters/modules using this interface must be re-compiled in order to run in Sitevision 3.
- * </em>The shared state username constant.The shared state password constant.The shared state auth type constant.The shared state client address constant.The shared state redirect constant.
+ * </em>
  * @author Rickard Öberg
  */
-export type AuthenticationFilter = {
+type AuthenticationFilter = {
   /**
    * A filter that can be used to populate the shared state and/or options for a JAAS login module.
    * @param aRequest the request
@@ -31,4 +31,36 @@ export type AuthenticationFilter = {
     anOptions: unknown,
     aChain: AuthenticationFilterChain
   ): void;
+
+  /**
+ * The shared state username constant.
+  
+    */
+  USERNAME: string;
+
+  /**
+ * The shared state password constant.
+  
+    */
+  PASSWORD: string;
+
+  /**
+ * The shared state auth type constant.
+  
+    */
+  AUTHTYPE: string;
+
+  /**
+ * The shared state client address constant.
+  
+    */
+  CLIENT_ADDRESS: string;
+
+  /**
+ * The shared state redirect constant.
+  
+    */
+  REDIRECT: string;
 };
+
+export = AuthenticationFilter;

package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts

@@ -10,7 +10,7 @@
  * </em>
  * @author Rickard Öberg
  */
-export type AuthenticationFilterChain = {
+type AuthenticationFilterChain = {
   /**
    * A filter chain that can be used to populate the shared state and/or options for a JAAS login module.
    * @param aRequest the request
@@ -28,3 +28,5 @@ export type AuthenticationFilterChain = {
     aChain: AuthenticationFilterChain
   ): void;
 };
+
+export = AuthenticationFilterChain;

package/types/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts

@@ -1,6 +1,6 @@
-import type { Node } from "../../../../../javax/jcr/Node";
+import type Node from "../../../../../javax/jcr/Node";
 
-import type { Wrapper } from "../../base/Wrapper";
+import type Wrapper from "../../base/Wrapper";
 
 /**
  * User identity wrapper interface.
@@ -22,7 +22,7 @@ import type { Wrapper } from "../../base/Wrapper";
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-export type UserIdentityWrapper = {
+type UserIdentityWrapper = Wrapper & {
   /**
    * Gets the contacts of the wrapped user identity.
    * @return the contacts of the wrapped user identity. Never null.
@@ -407,3 +407,5 @@ export type UserIdentityWrapper = {
    */
   getUserIdentity(): Node;
 };
+
+export = UserIdentityWrapper;

package/types/senselogic/sitevision/api/webresource/LinkTarget/index.d.ts

@@ -15,6 +15,8 @@
  * @since Sitevision 4.2
  * @see senselogic.sitevision.api.webresource.builder.LinkTargetBuilder
  */
-export type LinkTarget = {
+type LinkTarget = {
   undefined;
 };
+
+export = LinkTarget;

package/types/senselogic/sitevision/api/xml/XmlElement/index.d.ts

@@ -4,7 +4,7 @@
  * @see senselogic.sitevision.api.xml.XmlElementHandler
  * @since Sitevision 5.1
  */
-export type XmlElement = {
+type XmlElement = {
   /**
    * Gets the name of the element
    * @return the element name
@@ -51,3 +51,5 @@ export type XmlElement = {
    */
   getElements(): unknown;
 };
+
+export = XmlElement;

package/types/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts

@@ -1,4 +1,4 @@
-import type { XmlElement } from "../XmlElement";
+import type XmlElement from "../XmlElement";
 
 /**
  * Handler that is used when parsing XML.
@@ -6,10 +6,12 @@ import type { XmlElement } from "../XmlElement";
  * @see senselogic.sitevision.api.xml.XmlParserUtil
  * @since Sitevision 5.1
  */
-export type XmlElementHandler = {
+type XmlElementHandler = {
   /**
    * Called when a element matching the selection has been parsed.
    * @param aXmlElement the element
    */
   handleElement(aXmlElement: XmlElement): void;
 };
+
+export = XmlElementHandler;