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

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

@@ -1,5 +1,7 @@
 import type { Node } from "../../../../../javax/jcr/Node";
 
+import type { SearchHitConstants } from "../../render/velocity/VelocityAccess.SearchHitConstants";
+
 /**
  * <p>
  *    A <code>SearchHit</code> is a container for the search result returned from an Index as well
@@ -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 = {
+export type SearchHit = SearchHitConstants & {
   /**
    * <p>Checks if the value(-s) for a specified field contains a specific value.</p>
    *
@@ -774,4 +776,16 @@ 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;
 };

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

@@ -1,5 +1,7 @@
 import type { SearchHighlighter } from "../SearchHighlighter";
 
+import type { SearchResultConstants } from "../../render/velocity/VelocityAccess.SearchResultConstants";
+
 /**
  * <p>
  *    A <code>SearchResult</code> is a container for the hits returned by a search query. The object is lazy loaded
@@ -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 = {
+export 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,28 @@ 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;
 };

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

@@ -9,7 +9,7 @@ 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 = {
@@ -31,4 +31,34 @@ 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;
 };

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

@@ -22,7 +22,7 @@ import type { Wrapper } from "../../base/Wrapper";
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-export type UserIdentityWrapper = {
+export type UserIdentityWrapper = Wrapper & {
   /**
    * Gets the contacts of the wrapped user identity.
    * @return the contacts of the wrapped user identity. Never null.