@sitevision/api 2023.5.1 → 2023.8.1

package/common/events/index.d.ts

@@ -6,6 +6,13 @@ export interface Events {
    * @param callback The callback to trigger for the given event
    */
   on(eventName: string, callback: (options: unknown) => void): void;
+  /**
+   * Stop listening to a given event
+   *
+   * @param eventName The name of the event
+   * @param callback The callback to remove for the given event
+   */
+  off(eventName: string, callback: (options: unknown) => void): void;
   /**
    * Emit a server side event
    *

package/common/events/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _default = {
   on: function on() {},
+  off: function off() {},
   emit: function emit() {},
   trigger: function trigger() {}
 };

package/common/router/index.d.ts

@@ -25,6 +25,7 @@ export interface Request {
   params: { [key: string]: string };
   cookies: { [key: string]: string };
   xhr: boolean;
+  serverside: boolean;
   session: Session;
   hostname: string;
   protocol: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2023.5.1",
+  "version": "2023.8.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "ddeca0c97498ee5290598735c7d166eeda11fccc"
+  "gitHead": "84e58906704af5e7bcc97eae2a5b4b4c89a8031f"
 }

package/server/NodeTreeUtil/index.d.ts

@@ -54,6 +54,36 @@ export interface NodeTreeUtil {
    */
   isDescendantOf(aDescendantNode: Node, aParentNode: Node): boolean;
 
+  /**
+   * Returns a top-down list of all web nodes from the site page down to a specified page tree node.
+   *
+   *  <p>
+   *  This method traverses the site page tree and returns a list of all web nodes, from the site page to a descendant.
+   *  The tree traversal will use a maximum tree depth of 50. If the specified node is deeper down in the tree than that,
+   *  an incomplete list will be returned (top nodes will be missing).
+   *  </p>
+   *
+   *  <p>
+   *  <em>Note!</em> Mentioned "web nodes" are by this method considered to be all child nodes of the site page node you
+   *  can see in the Sitevision editor Navigator that are accessible from the location bar of a browser (e.g. pages and articles
+   *  but not folders and archives). File and image nodes are also recognized as web nodes - even if they are in the "site global"
+   *  archive (i.e. in the site tree, not actually in the site page tree).
+   *
+   *  In other words, though they are accessible from the location bar of a browser - a portlet node or layout node is <em>not</em>
+   *  considered to be a web node by this method.
+   *  </p>
+   *
+   *  <p>
+   *     <em>Tip! If you should render a linked "path to this page", consider using the <code>renderWebPathNodes</code>
+   *     utility of {@link senselogic.sitevision.api.render.OutputUtil}.</em>
+   *  </p>
+   * @param aDescendantNode a page tree node that is a descendant/child of the site page, typically a sv:page or sv:article
+   * @return a top-down list of the web nodes that are in the tree path from the site page node downto <code>aDescendantNode</code>&#xA; (the site page node and the descendant node are both included in the list).&#xA; An empty list will be returned if <code>aDescendantNode</code> is <code>null</code> or not a descendant of the site page.
+   * @since Sitevision 2.6.1_06
+   * @see senselogic.sitevision.api.render.OutputUtil#renderWebPathNodes(javax.jcr.Node, senselogic.sitevision.api.render.LinkRenderer, String)
+   */
+  getWebPathNodes(aDescendantNode: Node): List;
+
   /**
    * Find a portlet with a specific name on a page node.
    *
@@ -196,34 +226,129 @@ export interface NodeTreeUtil {
   ): List;
 
   /**
-   * Returns a top-down list of all web nodes from the site page down to a specified page tree node.
+   * Find all portlets on a page node and applies a node filter to the result.
    *
    *  <p>
-   *  This method traverses the site page tree and returns a list of all web nodes, from the site page to a descendant.
-   *  The tree traversal will use a maximum tree depth of 50. If the specified node is deeper down in the tree than that,
-   *  an incomplete list will be returned (top nodes will be missing).
+   *     <em>Tip!</em> {@link senselogic.sitevision.api.node.NodeFilterUtil} can be used to create a node filter.
    *  </p>
+   * @param aPageNode the page node that has content, typically a sv:page or sv:article
+   * @param aNodeFilter a node filter to refine the result of all portlets
+   * @return all occurrences of portlets that also applies to the aNodeFilter filter.&#xA; If no such portlets can be found or if aPageNode is not a page node, an empty List is returned
+   * @since Sitevision 2023.07.1
+   */
+  findPortlets(aPageNode: Node, aNodeFilter: Filter): List;
+
+  /**
+   * Find a layout with a specific name on a page node.
    *
    *  <p>
-   *  <em>Note!</em> Mentioned "web nodes" are by this method considered to be all child nodes of the site page node you
-   *  can see in the Sitevision editor Navigator that are accessible from the location bar of a browser (e.g. pages and articles
-   *  but not folders and archives). File and image nodes are also recognized as web nodes - even if they are in the "site global"
-   *  archive (i.e. in the site tree, not actually in the site page tree).
+   *     The <em>name</em> of the layout is determined by the <em>displayName</em> property.
+   *  </p>
+   *  <p>
+   *     This method handles layouts of container-type (layout nodes that can have children), such as:
+   *  </p>
+   *  <ul>
+   *     <li><code>sv:referenceLayout</code></li>
+   *     <li><code>sv:layout</code></li>
+   *     <li><code>sv:view</code></li>
+   *     <li><code>sv:profileView</code></li>
+   *  </ul>
+   *  <p>
+   *     <em>(i.e. this method does not handle the flat, non-container type <code>sv:linkedLayout</code>)</em>
+   *  </p>
+   * @param aPageNode the page node that has content, typically a sv:page or sv:article
+   * @param aLayoutName the name of the layout that should be found
+   * @return the first occurrence of a layout with name aLayoutName, or null if no such layout can be found&#xA; or if aPageNode is not a page node
+   * @see #findLayoutsByName(Node, String)
+   * @since Sitevision 2023.07.1
+   */
+  findLayoutByName(aPageNode: Node, aLayoutName: String | string): Node;
+
+  /**
+   * Find all layouts with a specific name on a page node.
    *
-   *  In other words, though they are accessible from the location bar of a browser - a portlet node or layout node is <em>not</em>
-   *  considered to be a web node by this method.
+   *  <p>
+   *     The <em>name</em> of the layout is determined by the <em>displayName</em> property.
+   *  </p>
+   *  <p>
+   *     This method handles layouts of container-type (layout nodes that can have children), such as:
    *  </p>
+   *  <ul>
+   *     <li><code>sv:referenceLayout</code></li>
+   *     <li><code>sv:layout</code></li>
+   *     <li><code>sv:view</code></li>
+   *     <li><code>sv:profileView</code></li>
+   *  </ul>
+   *  <p>
+   *     <em>(i.e. this method does not handle the flat, non-container type <code>sv:linkedLayout</code>)</em>
+   *  </p>
+   * @param aPageNode the page node that has content, typically a sv:page or sv:article
+   * @param aLayoutName the name of the layouts that should be found
+   * @return all occurrences of layouts with name aLayoutName. If no such layouts can be found or if aPageNode is not a page node,&#xA; an empty List is returned
+   * @see #findLayoutsByName(Node, String, Filter)
+   * @since Sitevision 2023.07.1
+   */
+  findLayoutsByName(aPageNode: Node, aLayoutName: String | string): List;
+
+  /**
+   * Find all layouts with a specific name on a page node and applies a node filter to the result.
    *
    *  <p>
-   *     <em>Tip! If you should render a linked "path to this page", consider using the <code>renderWebPathNodes</code>
-   *     utility of {@link senselogic.sitevision.api.render.OutputUtil}.</em>
+   *     The <em>name</em> of the layout is determined by the <em>displayName</em> property.
    *  </p>
-   * @param aDescendantNode a page tree node that is a descendant/child of the site page, typically a sv:page or sv:article
-   * @return a top-down list of the web nodes that are in the tree path from the site page node downto <code>aDescendantNode</code>&#xA; (the site page node and the descendant node are both included in the list).&#xA; An empty list will be returned if <code>aDescendantNode</code> is <code>null</code> or not a descendant of the site page.
-   * @since Sitevision 2.6.1_06
-   * @see senselogic.sitevision.api.render.OutputUtil#renderWebPathNodes(javax.jcr.Node, senselogic.sitevision.api.render.LinkRenderer, String)
+   *  <p>
+   *     This method handles layouts of container-type (layout nodes that can have children), such as:
+   *  </p>
+   *  <ul>
+   *     <li><code>sv:referenceLayout</code></li>
+   *     <li><code>sv:layout</code></li>
+   *     <li><code>sv:view</code></li>
+   *     <li><code>sv:profileView</code></li>
+   *  </ul>
+   *  <p>
+   *     <em>(i.e. this method does not handle the flat, non-container type <code>sv:linkedLayout</code>)</em>
+   *  </p>
+   *
+   *  <p>
+   *     <em>Tip!</em> {@link senselogic.sitevision.api.node.NodeFilterUtil} can be used to create a node filter.
+   *  </p>
+   * @param aPageNode the page node that has content, typically a sv:page or sv:article
+   * @param aLayoutName the name of the layouts that should be found
+   * @param aNodeFilter a node filter to refine the result of all layouts with matching name
+   * @return all occurrences of layouts with name aLayoutName that also applies to the aNodeFilter filter.&#xA; If no such layouts can be found or if aPageNode is not a page node, an empty List is returned
+   * @since Sitevision 2023.07.1
    */
-  getWebPathNodes(aDescendantNode: Node): List;
+  findLayoutsByName(
+    aPageNode: Node,
+    aLayoutName: String | string,
+    aNodeFilter: Filter
+  ): List;
+
+  /**
+   * Find all layouts on a page node and applies a node filter to the result.
+   *
+   *  <p>
+   *     This method handles layouts of container-type (layout nodes that can have children), such as:
+   *  </p>
+   *  <ul>
+   *     <li><code>sv:referenceLayout</code></li>
+   *     <li><code>sv:layout</code></li>
+   *     <li><code>sv:view</code></li>
+   *     <li><code>sv:profileView</code></li>
+   *  </ul>
+   *  <p>
+   *     <em>(i.e. this method does not handle the flat, non-container type <code>sv:linkedLayout</code>)</em>
+   *  </p>
+   *
+   *  <p>
+   *     <em>Tip!</em> {@link senselogic.sitevision.api.node.NodeFilterUtil} can be used to create a node filter.
+   *  </p>
+   * @param aPageNode the page node that has content, typically a sv:page or sv:article
+   * @param aNodeFilter a node filter to refine the result of all layouts
+   * @return all occurrences of layouts that also applies to the aNodeFilter filter.&#xA; If no such layouts can be found or if aPageNode is not a page node, an empty List is returned
+   * @since Sitevision 2023.07.1
+   */
+  findLayouts(aPageNode: Node, aNodeFilter: Filter): List;
 }
 
 declare namespace NodeTreeUtil {}

package/server/NodeTreeUtil/index.js

@@ -8,9 +8,13 @@ var _default = {
   getNode: function getNode() {},
   getParent: function getParent() {},
   isDescendantOf: function isDescendantOf() {},
+  getWebPathNodes: function getWebPathNodes() {},
   findPortletByName: function findPortletByName() {},
   findPortletsByName: function findPortletsByName() {},
   findPortletsByType: function findPortletsByType() {},
-  getWebPathNodes: function getWebPathNodes() {}
+  findPortlets: function findPortlets() {},
+  findLayoutByName: function findLayoutByName() {},
+  findLayoutsByName: function findLayoutsByName() {},
+  findLayouts: function findLayouts() {}
 };
 exports["default"] = _default;

package/server/hooks/index.d.ts

@@ -9,7 +9,7 @@ export interface HooksResponse {
    * @param url The URL to redirect to
    * @param statusCode The HTTP status code to use for the redirect. Defaults to 302. Introduced in Sitevision 2023.03.1.
    */
-  redirect(url: string, statusCode?: 301 | 302);
+  redirect(url: string, statusCode?: 301 | 302 | 303 | 307 | 308): void;
 }
 
 export interface Hooks {

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

@@ -786,7 +786,7 @@ export type SearchHit = SearchHitConstants & {
   getType(): number;
 
   /**
-   * Returns a jQuery expression with a token that enables tracking of search hit clicks.
+   * Returns a jQuery expression for tracking of clicks on this search hit.
    *
    *  <p>
    *     Tracking search hits clicks is a helpful tool when analyzing if visitors seems to find interesting information in their search results.
@@ -799,11 +799,18 @@ export type SearchHit = SearchHitConstants & {
    *     When rendering links to search hits with the {@link senselogic.sitevision.api.render.LinkRenderer}, apply the click tracking callback via
    *     {@link senselogic.sitevision.api.render.LinkRenderer#setOnclick(String)}
    *  </p>
-   * @return a click tracking callback jQuery expression
+   * @return a click tracking callback jQuery expression, or null if query logging inactive or unavailable
    * @since Sitevision 3.0
    */
   getClickTrackingCallback(): string;
 
+  /**
+   * Returns the uri for tracking of clicks on this search hit.
+   * @return a click tracking uri, or null if query logging inactive or unavailable
+   * @since Sitevision 2023.07.1
+   */
+  getClickTrackingUri(): string;
+
   /**
  * <p>Indicates that the hit is an internal resource managed by the Sitevision server</p>
   

package/types/senselogic/sitevision/api/search/SearchHit/index.js

@@ -30,6 +30,7 @@ var _default = {
   getScore: function getScore() {},
   isElevated: function isElevated() {},
   getType: function getType() {},
-  getClickTrackingCallback: function getClickTrackingCallback() {}
+  getClickTrackingCallback: function getClickTrackingCallback() {},
+  getClickTrackingUri: function getClickTrackingUri() {}
 };
 exports["default"] = _default;