@sitevision/api 2024.8.1 → 2024.10.1

package/server/TagUtil/index.js

@@ -4,12 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getTagByName: function getTagByName() {},
   getOrCreateTagByName: function getOrCreateTagByName() {},
   addTag: function addTag() {},
   addTags: function addTags() {},
   removeTag: function removeTag() {},
   getTags: function getTags() {}
-};
-exports["default"] = _default;
+};

package/server/TargetAudienceUtil/index.d.ts

@@ -0,0 +1,55 @@
+import type { List } from "../../types/java/util/List";
+import type { Node } from "../../types/javax/jcr/Node";
+
+/**
+ * Target audience utility interface.
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getTargetAudienceUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
+ * @author Robin Lagren
+ * @since Sitevision 2024.09.2
+ */
+export interface TargetAudienceUtil {
+  /**
+   * Resolves target audiences (sv:targetAudience) for the current user.
+   *  This method determines which target audiences the current user belongs to by evaluating all available target audiences of the site.
+   * @return the list of target audiences that the current user belongs to
+   */
+  resolve(): List;
+
+  /**
+   * Resolves target audiences (sv:targetAudience) for the provided user.
+   *  This method determines which target audiences the provided user belongs to by evaluating all available target audiences of the site.
+   * @param aUser the user to evaluate target audiences for
+   * @return the list of target audiences that the provided user belongs to
+   */
+  resolveForUser(aUser: Node): List;
+
+  /**
+   * Resolves specific target audiences (sv:targetAudience) for the current user.
+   *  This method determines which target audiences from the provided list the current user belongs to.
+   * @param aTargetAudiences the list of target audiences to evaluate against the current user
+   * @return the list of target audiences from the provided list that the current user belongs to
+   * @throws IllegalArgumentException if aTargetAudiences is null or contains other than sv:targetAudience Nodes
+   */
+  resolveFrom(aTargetAudiences: List | unknown[]): List;
+
+  /**
+   * Resolves specific target audiences (sv:targetAudience) for the provided user.
+   *  This method determines which target audiences from the provided list the provided user belongs to.
+   * @param aUser the user to evaluate target audiences for
+   * @param aTargetAudiences the list of target audiences to evaluate against the provided user
+   * @return the list of target audiences from the provided list that the provided user belongs to
+   * @throws IllegalArgumentException if aTargetAudiences is null or contains other than sv:targetAudience Nodes
+   */
+  resolveForUserFrom(aUser: Node, aTargetAudiences: List | unknown[]): List;
+}
+
+declare namespace TargetAudienceUtil {}
+
+declare var targetAudienceUtil: TargetAudienceUtil;
+
+export default targetAudienceUtil;

package/server/TargetAudienceUtil/index.js

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

package/server/TemplateUtil/index.js

@@ -4,12 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getTemplateByName: function getTemplateByName() {},
   getTemplates: function getTemplates() {},
   getPageTemplateByName: function getPageTemplateByName() {},
   getPageTemplates: function getPageTemplates() {},
   isPageTemplate: function isPageTemplate() {},
   getContentAreaNames: function getContentAreaNames() {}
-};
-exports["default"] = _default;
+};

package/server/TemporaryFileNodeBuilder/index.js

@@ -4,9 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   setFileName: function setFileName() {},
   setFile: function setFile() {},
   build: function build() {}
-};
-exports["default"] = _default;
+};

package/server/TemporaryNodeBuilder/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   setName: function setName() {},
   addStringProperty: function addStringProperty() {},
   addDateProperty: function addDateProperty() {},
@@ -17,5 +17,4 @@ var _default = {
   addNodeProperty: function addNodeProperty() {},
   clearAll: function clearAll() {},
   build: function build() {}
-};
-exports["default"] = _default;
+};

package/server/TextModuleRendererBuilder/index.js

@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   setPage: function setPage() {},
   build: function build() {}
-};
-exports["default"] = _default;
+};

package/server/TimestampUtil/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getTimestamp: function getTimestamp() {},
   formatCurrent: function formatCurrent() {},
   format: function format() {},
@@ -16,5 +16,4 @@ var _default = {
   fromInstant: function fromInstant() {},
   toLocalDateTime: function toLocalDateTime() {},
   fromLocalDateTime: function fromLocalDateTime() {}
-};
-exports["default"] = _default;
+};

package/server/TranslationUtil/index.js

@@ -4,10 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getSiteTranslationLocales: function getSiteTranslationLocales() {},
   getTranslations: function getTranslations() {},
   getTranslatedFrom: function getTranslatedFrom() {},
   setTranslatedFrom: function setTranslatedFrom() {}
-};
-exports["default"] = _default;
+};

package/server/TrashcanUtil/index.js

@@ -4,10 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   moveNodeToTrashcan: function moveNodeToTrashcan() {},
   restoreNode: function restoreNode() {},
   deleteNodeFromTrashcan: function deleteNodeFromTrashcan() {},
   isInTrashcan: function isInTrashcan() {}
-};
-exports["default"] = _default;
+};

package/server/UserDataUtil/index.js

@@ -4,10 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getReadOnlyKeys: function getReadOnlyKeys() {},
   getUserData: function getUserData() {},
   setUserData: function setUserData() {},
   removeUserData: function removeUserData() {}
-};
-exports["default"] = _default;
+};

package/server/UserFactory/index.js

@@ -4,12 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getUserIdentityUtil: function getUserIdentityUtil() {},
   getUserIdentityWrapper: function getUserIdentityWrapper() {},
   getSystemUserUtil: function getSystemUserUtil() {},
   getUserUtil: function getUserUtil() {},
   getSimpleUserUtil: function getSimpleUserUtil() {},
   getUserDataUtil: function getUserDataUtil() {}
-};
-exports["default"] = _default;
+};

package/server/UserFieldRenderer/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   update: function update() {},
   isLoaded: function isLoaded() {},
   isRenderable: function isRenderable() {},
@@ -12,5 +12,4 @@ var _default = {
   render: function render() {},
   renderPlain: function renderPlain() {},
   getPlainUserFieldValueAsHtml: function getPlainUserFieldValueAsHtml() {}
-};
-exports["default"] = _default;
+};

package/server/UserIdentityUtil/index.js

@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getOrCreateUserIdentity: function getOrCreateUserIdentity() {},
   getUserIdentity: function getUserIdentity() {}
-};
-exports["default"] = _default;
+};

package/server/UserUtil/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   isMemberOfGroup: function isMemberOfGroup() {}
-};
-exports["default"] = _default;
+};

package/server/Utils/index.d.ts

@@ -86,6 +86,7 @@ import type { TextModuleRendererBuilder } from "../TextModuleRendererBuilder";
 import type { TagUtil } from "../TagUtil";
 import type { AliasUtil } from "../AliasUtil";
 import type { MessagesFactory } from "../MessagesFactory";
+import type { TargetAudienceUtil } from "../TargetAudienceUtil";
 
 /**
  * Main entry point to get instances of interfaces in the Sitevision Utility API.
@@ -752,9 +753,16 @@ export interface Utils {
   /**
    * Gets an instance of a messages factory class.
    * @return a messages factory class
-   * @since Sitevision 2024.03.01
+   * @since Sitevision 2024.03.1
    */
   getMessagesFactory(): MessagesFactory;
+
+  /**
+   * Gets an instance of a target audience utility class.
+   * @return a target audience utility class
+   * @since Sitevision 2024.09.2
+   */
+  getTargetAudienceUtil(): TargetAudienceUtil;
 }
 
 declare namespace Utils {}

package/server/Utils/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getPortletContextUtil: function getPortletContextUtil() {},
   getNodeIteratorUtil: function getNodeIteratorUtil() {},
   getNodeTreeUtil: function getNodeTreeUtil() {},
@@ -88,6 +88,6 @@ var _default = {
   getTextModuleRendererBuilder: function getTextModuleRendererBuilder() {},
   getTagUtil: function getTagUtil() {},
   getAliasUtil: function getAliasUtil() {},
-  getMessagesFactory: function getMessagesFactory() {}
-};
-exports["default"] = _default;
+  getMessagesFactory: function getMessagesFactory() {},
+  getTargetAudienceUtil: function getTargetAudienceUtil() {}
+};

package/server/VelocityRenderer/index.js

@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getVelocityContext: function getVelocityContext() {},
   render: function render() {}
-};
-exports["default"] = _default;
+};

package/server/VersionUtil/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getCurrentVersion: function getCurrentVersion() {}
-};
-exports["default"] = _default;
+};

package/server/WebContentUtil/index.js

@@ -4,12 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   updateContent: function updateContent() {},
   updateContentWithRawHtml: function updateContentWithRawHtml() {},
   appendContent: function appendContent() {},
   appendContentWithRawHtml: function appendContentWithRawHtml() {},
   resolveToResourceURL: function resolveToResourceURL() {},
   removeAllContent: function removeAllContent() {}
-};
-exports["default"] = _default;
+};

package/server/WebResourceFactory/index.js

@@ -4,12 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getArticleUtil: function getArticleUtil() {},
   getFileUtil: function getFileUtil() {},
   getImageUtil: function getImageUtil() {},
   getLinkPageUtil: function getLinkPageUtil() {},
   getLinkTargetBuilder: function getLinkTargetBuilder() {},
   getPageUtil: function getPageUtil() {}
-};
-exports["default"] = _default;
+};

package/server/XSLTUtil/index.js

@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getDefaultCleanHtmlTemplate: function getDefaultCleanHtmlTemplate() {},
   transform: function transform() {}
-};
-exports["default"] = _default;
+};

package/server/XmlParserUtil/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   parse: function parse() {}
-};
-exports["default"] = _default;
+};

package/server/appData/index.js

@@ -4,10 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   get: function get() {},
   getArray: function getArray() {},
   getNode: function getNode() {},
   getNumber: function getNumber() {}
-};
-exports["default"] = _default;
+};

package/server/appInfo/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   appVersion: '0.0.2',
   maxUploadSizeInMB: 64,
   appHelpURL: 'https://developer.sitevision.se',
@@ -34,5 +34,4 @@ var _default = {
   appType: 'WebApp',
   appImportDate: 1543475296847,
   'jcr:primaryType': 'sv:webApp'
-};
-exports["default"] = _default;
+};

package/server/appResource/index.js

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

package/server/cache/index.js

@@ -8,8 +8,7 @@ var cache = {
   get: function get() {},
   purge: function purge() {}
 };
-var _default = {
+var _default = exports["default"] = {
   getCache: cache,
   getSharedCache: cache
-};
-exports["default"] = _default;
+};

package/server/globalAppData/index.js

@@ -4,9 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   get: function get() {},
   getArray: function getArray() {},
   getNode: function getNode() {}
-};
-exports["default"] = _default;
+};

package/server/headless/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getHeadlessContent: function getHeadlessContent() {}
-};
-exports["default"] = _default;
+};

package/server/hooks/index.js

@@ -4,9 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   beforeRender: function beforeRender() {},
   getPageTitle: function getPageTitle() {},
   addHeadElement: function addHeadElement() {}
-};
-exports["default"] = _default;
+};

package/server/oauth2/index.js

@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   createLoginLink: function createLoginLink() {},
   getAccessTokenStatus: function getAccessTokenStatus() {}
-};
-exports["default"] = _default;
+};

package/server/privileged/index.js

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

package/server/storage/index.js

@@ -4,12 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getCollectionDataStore: function getCollectionDataStore() {
     return {};
   },
   getKeyValueDataStore: function getKeyValueDataStore() {
     return {};
   }
-};
-exports["default"] = _default;
+};

package/types/java/io/Closeable/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   close: function close() {}
-};
-exports["default"] = _default;
+};

package/types/java/io/File/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   getName: function getName() {},
   getParent: function getParent() {},
   getParentFile: function getParentFile() {},
@@ -46,5 +46,4 @@ var _default = {
   hashCode: function hashCode() {},
   toString: function toString() {},
   toPath: function toPath() {}
-};
-exports["default"] = _default;
+};

package/types/java/io/FileFilter/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   accept: function accept() {}
-};
-exports["default"] = _default;
+};

package/types/java/io/FilenameFilter/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   accept: function accept() {}
-};
-exports["default"] = _default;
+};

package/types/java/io/FilterOutputStream/index.js

@@ -4,9 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   write: function write() {},
   flush: function flush() {},
   close: function close() {}
-};
-exports["default"] = _default;
+};

package/types/java/io/Flushable/index.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   flush: function flush() {}
-};
-exports["default"] = _default;
+};

package/types/java/io/InputStream/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   read: function read() {},
   skip: function skip() {},
   available: function available() {},
@@ -12,5 +12,4 @@ var _default = {
   mark: function mark() {},
   reset: function reset() {},
   markSupported: function markSupported() {}
-};
-exports["default"] = _default;
+};

package/types/java/io/OutputStream/index.js

@@ -4,9 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   write: function write() {},
   flush: function flush() {},
   close: function close() {}
-};
-exports["default"] = _default;
+};

package/types/java/io/PrintStream/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   flush: function flush() {},
   close: function close() {},
   checkError: function checkError() {},
@@ -16,5 +16,4 @@ var _default = {
   printf: function printf() {},
   format: function format() {},
   append: function append() {}
-};
-exports["default"] = _default;
+};

package/types/java/io/PrintWriter/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _default = {
+var _default = exports["default"] = {
   flush: function flush() {},
   close: function close() {},
   checkError: function checkError() {},
@@ -16,5 +16,4 @@ var _default = {
   printf: function printf() {},
   format: function format() {},
   append: function append() {}
-};
-exports["default"] = _default;
+};