@sitevision/api 2023.8.1 → 2023.9.2

package/index.d.ts

@@ -73,6 +73,7 @@ import './server/OfflineVersionPropertyUtil';
 import './server/OnlineVersionPropertyUtil';
 import './server/OutputUtil';
 import './server/PageUtil';
+import './server/PermissionCheckBuilder';
 import './server/PermissionUtil';
 import './server/PermissionUtil.Permission';
 import './server/PortletContextUtil';

package/package.json

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

package/server/FilterBuilder/index.d.ts

@@ -75,13 +75,12 @@ export interface FilterBuilder extends Builder {
    *
    *  <p>
    *     <strong>Query syntax note! </strong>Query strings should be expressed according to the <em>Solr query syntax</em>.
-   *     The syntax is basically the <em>
+   *     The syntax is basically the<em>
    *     <a href="http://lucene.apache.org/core/4_10_3/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">
-   *     Lucene query syntax</a></em>
-   *     with <em><a href="http://wiki.apache.org/solr/SolrQuerySyntax#Differences_From_Lucene_Query_Parser">some minor differences</a></em>.
+   *     Lucene query syntax</a></em> with some minor differences (solr syntax allows open-ended range queries and pure negative queries).
    *     Also note that a general recommendation is to always use the <em>prefix operators</em> (<code>+</code>/<code>-</code>) instead of the
    *     <em>boolean keywords</em> (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example
-   *     <a href="http://searchhub.org/2011/12/28/why-not-and-or-and-not/">Why Not AND, OR, And NOT?</a>.
+   *     <a href="https://lucidworks.com/post/solr-boolean-operators/" target="_blank">Why Not AND, OR, And NOT?</a>.
    *  </p>
    * @param aFilterQuery the filter query, a <code>null</code> or whitespace-only value will be ignored
    * @return this builder

package/server/NodeTypeUtil/index.d.ts

@@ -361,6 +361,12 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   IMAGE_FILTER_TYPE: "sv:imageFilter";
 
+  /**
+   * The primary node type name for the image filter repository type.
+   * @since Sitevision 2023.09.1
+   */
+  IMAGE_FILTER_REPOSITORY_TYPE: "sv:imageFilterRepository";
+
   /**
    * The primary node type name for the image repository type.
    * @since Sitevision 3.6.3
@@ -1122,6 +1128,24 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   OAUTH2_CONFIGURATION_TYPE: "sv:oAuth2Configuration";
 
+  /**
+   * The primary node type name for the work status type.
+   * @since Sitevision 2023.09.2
+   */
+  WORK_STATUS_TYPE: "sv:workStatus";
+
+  /**
+   * The primary node type name for the work status template type.
+   * @since Sitevision 2023.09.2
+   */
+  WORK_STATUS_TEMPLATE_TYPE: "sv:workStatusTemplate";
+
+  /**
+   * The primary node type name for the work status template repository type.
+   * @since Sitevision 2023.09.2
+   */
+  WORK_STATUS_TEMPLATE_REPOSITORY_TYPE: "sv:workStatusTemplateRepository";
+
   /**
    * Checks if a node is a layout.
    * @param aNode the node to be checked

package/server/PermissionCheckBuilder/index.d.ts

@@ -0,0 +1,59 @@
+import type { PermissionStrategy } from "../../types/senselogic/sitevision/api/search/searcher/component/PermissionStrategy";
+import type { PermissionCheck } from "../../types/senselogic/sitevision/api/search/searcher/component/PermissionCheck";
+import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
+
+/**
+ * <p>
+ *     Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.PermissionCheck} component.
+ *  </p>
+ *
+ *  <p>
+ *     PermissionCheck has one <em>optional</em> attribute:
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        <em>permission strategy</em> - the permission checking strategy.
+ *        Default is {@link senselogic.sitevision.api.search.searcher.component.PermissionStrategy#EARLY_CHECK}.
+ *     </li>
+ *  </ul>
+ *
+ *  <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>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.search.SearchFactory#getPermissionCheckBuilder()}.
+ *     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 2023.09.1
+ */
+export interface PermissionCheckBuilder extends Builder {
+  /**
+   * Sets the permission strategy.
+   * @param aPermissionStrategy the permission strategy
+   * @return this builder
+   */
+  setPermissionStrategy(
+    aPermissionStrategy: PermissionStrategy
+  ): PermissionCheckBuilder;
+
+  /**
+   * Creates a PermissionCheck component instance using currently specified state/behaviour.
+   *
+   *  <p>
+   *     Default strategy {@link senselogic.sitevision.api.search.searcher.component.PermissionStrategy#EARLY_CHECK} will be used
+   *     if the component has no state (i.e. no {@link PermissionStrategy} explicitly set) when built.
+   *  </p>
+   * @return a permission check component
+   */
+  build(): PermissionCheck;
+}
+
+declare namespace PermissionCheckBuilder {}
+
+declare var permissionCheckBuilder: PermissionCheckBuilder;
+
+export default permissionCheckBuilder;

package/server/PermissionCheckBuilder/index.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  setPermissionStrategy: function setPermissionStrategy() {},
+  build: function build() {}
+};
+exports["default"] = _default;

package/server/ResourceLocatorUtil/index.d.ts

@@ -442,6 +442,20 @@ export interface ResourceLocatorUtil {
    * @see senselogic.sitevision.api.cookie.SiteCookieUtil
    */
   getSiteCookieRepository(): Node;
+
+  /**
+   * Gets the image filter repository (sv:imageFilterRepository) for the site of current node.
+   * @return the image filter repository, or null if indeterminable.
+   * @since Sitevision 2023.09.1
+   */
+  getImageFilterRepository(): Node;
+
+  /**
+   * Gets the work status template repository (sv:workStatusTemplateRepository) for the site of current node.
+   * @return the work status template repository, or null if indeterminable.
+   * @since Sitevision 2023.09.2
+   */
+  getWorkStatusTemplateRepository(): Node;
 }
 
 declare namespace ResourceLocatorUtil {}

package/server/ResourceLocatorUtil/index.js

@@ -45,6 +45,8 @@ var _default = {
   getTrashcan: function getTrashcan() {},
   getPrincipalRepository: function getPrincipalRepository() {},
   getAliasRepository: function getAliasRepository() {},
-  getSiteCookieRepository: function getSiteCookieRepository() {}
+  getSiteCookieRepository: function getSiteCookieRepository() {},
+  getImageFilterRepository: function getImageFilterRepository() {},
+  getWorkStatusTemplateRepository: function getWorkStatusTemplateRepository() {}
 };
 exports["default"] = _default;

package/server/SearchFactory/index.d.ts

@@ -13,6 +13,7 @@ import type { SpellCheckBuilder } from "../SpellCheckBuilder";
 import type { StandardParserBuilder } from "../StandardParserBuilder";
 import type { QueryStringUtil } from "../QueryStringUtil";
 import type { MonitorBuilder } from "../MonitorBuilder";
+import type { PermissionCheckBuilder } from "../PermissionCheckBuilder";
 
 /**
  * Factory for creating search-related instances.
@@ -112,6 +113,13 @@ export interface SearchFactory {
    * @since Sitevision 4.1
    */
   getMonitorBuilder(): MonitorBuilder;
+
+  /**
+   * Gets a PermissionCheckBuilder instance.
+   * @return a PermissionCheckBuilder instance
+   * @since Sitevision 2023.09.1
+   */
+  getPermissionCheckBuilder(): PermissionCheckBuilder;
 }
 
 declare namespace SearchFactory {}

package/server/SearchFactory/index.js

@@ -17,6 +17,7 @@ var _default = {
   getSpellCheckBuilder: function getSpellCheckBuilder() {},
   getStandardParserBuilder: function getStandardParserBuilder() {},
   getQueryStringUtil: function getQueryStringUtil() {},
-  getMonitorBuilder: function getMonitorBuilder() {}
+  getMonitorBuilder: function getMonitorBuilder() {},
+  getPermissionCheckBuilder: function getPermissionCheckBuilder() {}
 };
 exports["default"] = _default;

package/server/SearchUtil/index.d.ts

@@ -40,12 +40,10 @@ import type { SearchResult } from "../../types/senselogic/sitevision/api/search/
  *     <strong>Query syntax note! </strong>Query strings should be expressed according to the <em>Solr query syntax</em>.
  *     The syntax is basically the
  *     <em><a href="http://lucene.apache.org/core/4_10_3/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">
- *        Lucene query syntax</a></em>
- *     with <em><a href="http://wiki.apache.org/solr/SolrQuerySyntax#Differences_From_Lucene_Query_Parser">some minor differences</a></em>.
+ *     Lucene query syntax</a></em> with some minor differences (solr syntax allows open-ended range queries and pure negative queries).
  *     Also note that a general recommendation is to always use the <em>prefix operators</em> (<code>+</code>/<code>-</code>) instead of the
- *     <em>boolean keywords</em> (AND/OR/NOT)
- *     to avoid unexpected behaviour. For deeper understanding, see for example
- *     <a href="https://lucidworks.com/blog/2011/12/28/why-not-and-or-and-not/">Why Not AND, OR, And NOT?</a>.
+ *     <em>boolean keywords</em> (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example
+ *     <a href="https://lucidworks.com/post/solr-boolean-operators/" target="_blank">Why Not AND, OR, And NOT?</a>.
  *  </p>
  *
  *  <p>

package/server/SearcherBuilder/index.d.ts

@@ -5,6 +5,7 @@ import type { Parser } from "../../types/senselogic/sitevision/api/search/search
 import type { Sort } from "../../types/senselogic/sitevision/api/search/searcher/component/Sort";
 import type { SpellCheck } from "../../types/senselogic/sitevision/api/search/searcher/component/SpellCheck";
 import type { Monitor } from "../../types/senselogic/sitevision/api/search/searcher/component/Monitor";
+import type { PermissionCheck } from "../../types/senselogic/sitevision/api/search/searcher/component/PermissionCheck";
 import type { Searcher } from "../../types/senselogic/sitevision/api/search/searcher/Searcher";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
@@ -53,6 +54,12 @@ import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder
  *        </em>
  *        Default: <code>null</code> (i.e. no monitoring).
  *     </li>
+ *     <li>
+ *        {@link senselogic.sitevision.api.search.searcher.component.PermissionCheck}<em>
+ *           - how should permission checks be performed? (Note! Only applicable when querying a sv:nodeIndex)
+ *        </em>
+ *        Default: <code>null</code> (legacy default permission checking strategy will be used).
+ *     </li>
  *  </ul>
  *  <p>
  *     What <em>index</em> to query can also be specified. Default is the <em>default node index</em>
@@ -201,6 +208,34 @@ export interface SearcherBuilder extends Builder {
    */
   setMonitor(aMonitor: Monitor): SearcherBuilder;
 
+  /**
+   * Sets the permission check component.
+   *
+   *  <p>
+   *     <strong>Note! This component is only applicable when querying a Node index (<code>sv:nodeIndex</code>)!</strong>
+   *  </p>
+   *  <p>
+   *     When querying a Custom Node index that is populated with <em>external data</em>, you should typically set a permission check component
+   *     that specifies the {@link senselogic.sitevision.api.search.searcher.component.PermissionStrategy#EARLY_CHECK} strategy.
+   *  </p>
+   *  <p>
+   *     <em>
+   *        Legacy: a <code>Searcher</code> without any <code>PermissionCheck</code> component will use a legacy default strategy when checking
+   *        permissions. This strategy is a mix of <code>EARLY_CHECK</code> and <code>LATE_CHECK</code> that is kept as-is for legacy reasons only.
+   *        New search solutions with <code>Searcher</code> should typically specify a <code>PermissionCheck</code> component when querying
+   *        a <code>sv:nodeIndex</code>.
+   *     </em>
+   *  </p>
+   *  <p>
+   *     A <code>PermissionCheck</code> instance is created via the {@link PermissionCheckBuilder#build()} method.
+   *  </p>
+   * @param aPermissionCheck the permission check component
+   * @return this builder
+   * @see PermissionCheck
+   * @since Sitevision 2023.09.1
+   */
+  setPermissionCheck(aPermissionCheck: PermissionCheck): SearcherBuilder;
+
   /**
    * Creates a Searcher instance using currently specified components.
    * @return a Searcher instance

package/server/SearcherBuilder/index.js

@@ -12,6 +12,7 @@ var _default = {
   setSort: function setSort() {},
   setSpellCheck: function setSpellCheck() {},
   setMonitor: function setMonitor() {},
+  setPermissionCheck: function setPermissionCheck() {},
   build: function build() {}
 };
 exports["default"] = _default;

package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts

@@ -372,6 +372,13 @@ export type NodeTypeUtilConstants = {
    */
   getIMAGE_FILTER_TYPE(): string;
 
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#IMAGE_FILTER_REPOSITORY_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#IMAGE_FILTER_REPOSITORY_TYPE}
+   * @since Sitevision 2023.09.1
+   */
+  getIMAGE_FILTER_REPOSITORY_TYPE(): string;
+
   /**
    * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#IMAGE_REPOSITORY_TYPE}.
    * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#IMAGE_REPOSITORY_TYPE}
@@ -1240,4 +1247,25 @@ export type NodeTypeUtilConstants = {
    * @since Sitevision 7
    */
   getOAUTH2_CONFIGURATION_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#WORK_STATUS_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#WORK_STATUS_TYPE}
+   * @since Sitevision 2023.09.2
+   */
+  getWORK_STATUS_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#WORK_STATUS_TEMPLATE_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#WORK_STATUS_TEMPLATE_TYPE}
+   * @since Sitevision 2023.09.2
+   */
+  getWORK_STATUS_TEMPLATE_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#WORK_STATUS_TEMPLATE_REPOSITORY_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#WORK_STATUS_TEMPLATE_REPOSITORY_TYPE}
+   * @since Sitevision 2023.09.2
+   */
+  getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE(): string;
 };

package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js

@@ -61,6 +61,7 @@ var _default = {
   getGRADE_FIELD_TYPE: function getGRADE_FIELD_TYPE() {},
   getICON_REPOSITORY_TYPE: function getICON_REPOSITORY_TYPE() {},
   getIMAGE_FILTER_TYPE: function getIMAGE_FILTER_TYPE() {},
+  getIMAGE_FILTER_REPOSITORY_TYPE: function getIMAGE_FILTER_REPOSITORY_TYPE() {},
   getIMAGE_REPOSITORY_TYPE: function getIMAGE_REPOSITORY_TYPE() {},
   getLAYOUT_REPOSITORY_TYPE: function getLAYOUT_REPOSITORY_TYPE() {},
   getLIST_STYLE_TYPE: function getLIST_STYLE_TYPE() {},
@@ -184,6 +185,9 @@ var _default = {
   getEXTERNAL_TOPIC_TIMELINE_ENTRY_TYPE: function getEXTERNAL_TOPIC_TIMELINE_ENTRY_TYPE() {},
   getEXTERNAL_COMMENT_ENTRY_TYPE: function getEXTERNAL_COMMENT_ENTRY_TYPE() {},
   getOAUTH2_CONFIGURATION_REPOSITORY_TYPE: function getOAUTH2_CONFIGURATION_REPOSITORY_TYPE() {},
-  getOAUTH2_CONFIGURATION_TYPE: function getOAUTH2_CONFIGURATION_TYPE() {}
+  getOAUTH2_CONFIGURATION_TYPE: function getOAUTH2_CONFIGURATION_TYPE() {},
+  getWORK_STATUS_TYPE: function getWORK_STATUS_TYPE() {},
+  getWORK_STATUS_TEMPLATE_TYPE: function getWORK_STATUS_TEMPLATE_TYPE() {},
+  getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE: function getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE() {}
 };
 exports["default"] = _default;

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

@@ -47,6 +47,11 @@ import type { SearchResult } from "../../SearchResult";
  *           - how should querying be monitored? (e.g. should search query logging mode be on or off?)
  *        </em>
  *     </li>
+ *     <li>
+ *        {@link senselogic.sitevision.api.search.searcher.component.PermissionCheck}<em>
+ *           - how should permission checks be performed? (Note! Only applicable when querying a sv:nodeIndex)
+ *        </em>
+ *     </li>
  *  </ul>
  *  <p>
  *     All components are optional and are assembled using a {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder}.
@@ -135,11 +140,10 @@ import type { SearchResult } from "../../SearchResult";
  *     <strong>Query syntax note! </strong>Query strings should be expressed according to the <em>Solr query syntax</em>.
  *     The syntax is basically the
  *     <em><a href="http://lucene.apache.org/core/4_10_3/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">
- *        Lucene query syntax</a></em>
- *     with <em><a href="http://wiki.apache.org/solr/SolrQuerySyntax#Differences_From_Lucene_Query_Parser">some minor differences</a></em>.
+ *     Lucene query syntax</a></em> with some minor differences (solr syntax allows open-ended range queries and pure negative queries).
  *     Also note that a general recommendation is to always use the <em>prefix operators</em> (<code>+</code>/<code>-</code>) instead of the
  *     <em>boolean keywords</em> (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example
- *     <a href="https://lucidworks.com/blog/2011/12/28/why-not-and-or-and-not/">Why Not AND, OR, And NOT?</a>.
+ *     <a href="https://lucidworks.com/post/solr-boolean-operators/" target="_blank">Why Not AND, OR, And NOT?</a>.
  *  </p>
  *
  *  <p>

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

@@ -0,0 +1,27 @@
+/**
+ * <p>
+ *     A permission check component that defines permission checking behaviour for a {@link senselogic.sitevision.api.search.searcher.Searcher}.
+ *  </p>
+ *
+ *  <p>
+ *     <strong>Note! This component is only applicable when querying a Node index (<code>sv:nodeIndex</code>)!</strong>
+ *  </p>
+ *
+ *  <p>
+ *     The actual behaviour is specified when it is constructed using the
+ *     {@link senselogic.sitevision.api.search.searcher.builder.PermissionCheckBuilder}.
+ *     The component is applied to the <code>Searcher</code> via
+ *     {@link senselogic.sitevision.api.search.searcher.builder.SearcherBuilder#setPermissionCheck(PermissionCheck)}
+ *     when the <code>Searcher</code> is constructed.
+ *  </p>
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.search.searcher.builder.PermissionCheckBuilder#build()}.
+ *     See {@link senselogic.sitevision.api.search.searcher.builder.PermissionCheckBuilder} for how to obtain an instance of the
+ *     <code>PermissionCheck</code> interface.
+ *  </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 2023.09.1
+ */
+export type PermissionCheck = {};

package/types/senselogic/sitevision/api/search/searcher/component/PermissionCheck/index.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {};
+exports["default"] = _default;

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

@@ -0,0 +1,31 @@
+/**
+ * Permission strategy, determines how a {@link senselogic.sitevision.api.search.searcher.component.PermissionCheck}
+ *  component will perform its checks.
+ *
+ *  <p>
+ *     Example of how to get the {@link #EARLY_CHECK} state:
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        In a bundled <strong>WebApp/RESTApp</strong>:<pre><code>
+ *        import EARLY_CHECK from '@sitevision/api/server/PermissionStrategy.EARLY_CHECK';</code></pre>
+ *     </li>
+ *     <li>
+ *        Using server-side <strong>JavaScript</strong> in a Script module:<pre><code>
+ *        const earlyCheckEnum = require('PermissionStrategy.EARLY_CHECK');</code></pre>
+ *     </li>
+ *     <li>
+ *        Using <strong>Velocity</strong>:<pre><code>
+ *        #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
+ *        #set ($enumClassName = 'senselogic.sitevision.api.search.searcher.component.PermissionStrategy')
+ *        #set ($earlyCheckEnum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'EARLY_CHECK'))</code></pre>
+ *     </li>
+ *  </ul>
+ * @author Magnus Lövgren
+ * @since Sitevision 2023.09.1
+ * @see PermissionCheck
+ */
+export type PermissionStrategy = {
+  EARLY_CHECK: "EARLY_CHECK";
+  LATE_CHECK: "LATE_CHECK";
+};

package/types/senselogic/sitevision/api/search/searcher/component/PermissionStrategy/index.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  EARLY_CHECK: "EARLY_CHECK",
+  LATE_CHECK: "LATE_CHECK"
+};
+exports["default"] = _default;