@sitevision/api 2023.9.2 → 2024.1.1

package/client/requester/index.js

@@ -4,10 +4,31 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
+/**
+ * Mocking interface for requester
+ * Bit of a hack, since it's really returns an $.ajax object.
+ * But $.ajax wraps a promise.
+ */
 var _default = {
-  doGet: function doGet() {},
-  doPost: function doPost() {},
-  doPut: function doPut() {},
-  doDelete: function doDelete() {}
+  doGet: function doGet() {
+    return new Promise(function (resolve) {
+      resolve();
+    });
+  },
+  doPost: function doPost() {
+    return new Promise(function (resolve) {
+      resolve();
+    });
+  },
+  doPut: function doPut() {
+    return new Promise(function (resolve) {
+      resolve();
+    });
+  },
+  doDelete: function doDelete() {
+    return new Promise(function (resolve) {
+      resolve();
+    });
+  }
 };
 exports["default"] = _default;

package/package.json

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

package/server/NodeTypeUtil/index.d.ts

@@ -523,6 +523,36 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   METADATA_MULTIPLE_TAG_DEFINITION_TYPE: "sv:metadataMultipleTagDefinition";
 
+  /**
+   * The primary node type name for the metadata date definition type.
+   * @since Sitevision 2024.01.1
+   */
+  METADATA_DATE_DEFINITION_TYPE: "sv:metadataDateDefinition";
+
+  /**
+   * The primary node type name for the metadata system image definition type.
+   * @since Sitevision 2024.01.1
+   */
+  METADATA_SYSTEM_IMAGE_DEFINITION_TYPE: "sv:metadataSystemImageDefinition";
+
+  /**
+   * The primary node type name for the metadata system integer definition type.
+   * @since Sitevision 2024.01.1
+   */
+  METADATA_SYSTEM_INTEGER_DEFINITION_TYPE: "sv:metadataSystemIntegerDefinition";
+
+  /**
+   * The primary node type name for the metadata system link definition type.
+   * @since Sitevision 2024.01.1
+   */
+  METADATA_SYSTEM_LINK_DEFINITION_TYPE: "sv:metadataSystemLinkDefinition";
+
+  /**
+   * The primary node type name for the metadata system text definition type.
+   * @since Sitevision 2024.01.1
+   */
+  METADATA_SYSTEM_TEXT_DEFINITION_TYPE: "sv:metadataSystemTextDefinition";
+
   /**
    * The primary node type name for the mobile app type.
    * @since Sitevision 3.6.3
@@ -1476,6 +1506,40 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   isAnyUserType(aNode: Node): boolean;
 
+  /**
+   * Convenience method that checks if a node is of "Metadata definition node" type.
+   *
+   *  <p>
+   *     "Metadata definition node" types are:
+   *  </p>
+   *  <ul>
+   *     <li>{@link #METADATA_TEXT_DEFINITION_TYPE sv:metadataTextDefinition}</li>
+   *     <li>{@link #METADATA_SINGLE_DEFINITION_TYPE sv:metadataSingleDefinition}</li>
+   *     <li>{@link #METADATA_MULTIPLE_DEFINITION_TYPE sv:metadataMultipleDefinition}</li>
+   *     <li>{@link #METADATA_INTEGER_DEFINITION_TYPE sv:metadataIntegerDefinition}</li>
+   *     <li>{@link #METADATA_DATE_DEFINITION_TYPE sv:metadataDateDefinition}</li>
+   *     <li>{@link #METADATA_USER_DEFINITION_TYPE sv:metadataUserDefinition}</li>
+   *     <li>{@link #METADATA_DIRECTORY_DEFINITION_TYPE sv:metadataDirectoryDefinition}</li>
+   *     <li>{@link #METADATA_LINK_DEFINITION_TYPE sv:metadataLinkDefinition}</li>
+   *     <li>{@link #METADATA_TEXT_PORTLET_DEFINITION_TYPE sv:metadataTextPortletDefinition}</li>
+   *     <li>{@link #METADATA_IMAGE_PORTLET_DEFINITION_TYPE sv:metadataImagePortletDefinition}</li>
+   *     <li>{@link #METADATA_MEDIA_PORTLET_DEFINITION_TYPE sv:metadataMediaPortletDefinition}</li>
+   *     <li>{@link #METADATA_RELATED_INFORMATION_DEFINITION_TYPE sv:metadataRelatedInformationDefinition}</li>
+   *     <li>{@link #METADATA_SINGLE_TAG_DEFINITION_TYPE sv:metadataSingleTagDefinition}</li>
+   *     <li>{@link #METADATA_MULTIPLE_TAG_DEFINITION_TYPE sv:metadataMultipleTagDefinition}</li>
+   *     <li>{@link #METADATA_KEYWORD_DEFINITION_TYPE sv:metadataKeywordDefinition}</li>
+   *     <li>{@link #METADATA_SYSTEM_DEFINITION_TYPE sv:metadataSystemDefinition}</li>
+   *     <li>{@link #METADATA_SYSTEM_IMAGE_DEFINITION_TYPE sv:metadataSystemImageDefinition}</li>
+   *     <li>{@link #METADATA_SYSTEM_INTEGER_DEFINITION_TYPE sv:metadataSystemIntegerDefinition}</li>
+   *     <li>{@link #METADATA_SYSTEM_LINK_DEFINITION_TYPE sv:metadataSystemLinkDefinition}</li>
+   *     <li>{@link #METADATA_SYSTEM_TEXT_DEFINITION_TYPE sv:metadataSystemTextDefinition}</li>
+   *  </ul>
+   * @param aNode the node to be checked
+   * @return whether aNode is a "metadata definition node" or not.
+   * @since Sitevision 2024.01.1
+   */
+  isAnyMetadataDefinitionType(aNode: Node): boolean;
+
   /**
    * Checks a node against a given node type name to see if they match.
    * @param aNode the node to be checked

package/server/NodeTypeUtil/index.js

@@ -42,6 +42,7 @@ var _default = {
   isAnyRenderableType: function isAnyRenderableType() {},
   isAnyContentType: function isAnyContentType() {},
   isAnyUserType: function isAnyUserType() {},
+  isAnyMetadataDefinitionType: function isAnyMetadataDefinitionType() {},
   isType: function isType() {},
   isTypeOf: function isTypeOf() {}
 };

package/server/PermissionUtil.Permission/index.d.ts

@@ -49,6 +49,9 @@ declare enum Permission {
   MANAGE_DOWNLOAD_PROTECTION,
   MANAGE_CHANNELS,
   CREATE_PRIVATE_CHANNELS,
+  MANAGE_PINNING,
+  MANAGE_TYPES_IDENTIFIERS,
+  MANAGE_CUSTOM_SEARCH_INDEX,
 }
 
 export default Permission;

package/server/PermissionUtil.Permission/index.js

@@ -33,6 +33,9 @@ var _default = {
   MANAGE_PUBLISHING_PROJECT: "MANAGE_PUBLISHING_PROJECT",
   MANAGE_DOWNLOAD_PROTECTION: "MANAGE_DOWNLOAD_PROTECTION",
   MANAGE_CHANNELS: "MANAGE_CHANNELS",
-  CREATE_PRIVATE_CHANNELS: "CREATE_PRIVATE_CHANNELS"
+  CREATE_PRIVATE_CHANNELS: "CREATE_PRIVATE_CHANNELS",
+  MANAGE_PINNING: "MANAGE_PINNING",
+  MANAGE_TYPES_IDENTIFIERS: "MANAGE_TYPES_IDENTIFIERS",
+  MANAGE_CUSTOM_SEARCH_INDEX: "MANAGE_CUSTOM_SEARCH_INDEX"
 };
 exports["default"] = _default;

package/server/Requester/index.d.ts

@@ -31,7 +31,16 @@ import type { RequesterChainable } from "../../types/senselogic/sitevision/api/s
  *           - request data type <em>(default is "application/x-www-form-urlencoded").</em>
  *           <ul>
  *              <li><em>"text/plain" - data will be sent as a string entity</em></li>
- *              <li><em>"application/json" - data will be sent as JSON</em></li>
+ *              <li>
+ *                 <em>"application/json" - data will be sent as JSON</em>
+ *                 <ul>
+ *                    <li>
+ *                       <em>When the targeted API expects "application/vnd.api+json",
+ *                       you should set the "contentType" option to "application/json" while ensuring that the
+ *                       <strong>headers</strong> options include the expected "Content-Type"</em>
+ *                    </li>
+ *                 </ul>
+ *              </li>
  *              <li><em>"multipart/form-data" [@since Sitevision 4.5.4] - request will be sent as multipart form entity</em></li>
  *           </ul>
  *        </li>

package/server/ResourceLocatorUtil/index.d.ts

@@ -13,6 +13,17 @@ import type { Object } from "../../types/java/lang/Object";
  * @author Magnus Lövgren
  */
 export interface ResourceLocatorUtil {
+  /**
+   * Gets the JCR Root Node for current Site.
+   *
+   *  <p>
+   *     <em>This is a non-throwing convenience for the {@link javax.jcr.Session#getRootNode() Session.getRootNode()} method.</em>
+   *  </p>
+   * @return the JCR Root Node, or null if indeterminable
+   * @since Sitevision 2023.11.1
+   */
+  getRootNode(): Node;
+
   /**
    * Gets current site (i.e. the site node of the page for the currently executing portlet).
    *

package/server/ResourceLocatorUtil/index.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
+  getRootNode: function getRootNode() {},
   getSite: function getSite() {},
   getSitePage: function getSitePage() {},
   getColorRepository: function getColorRepository() {},

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

@@ -561,6 +561,41 @@ export type NodeTypeUtilConstants = {
    */
   getMETADATA_MULTIPLE_TAG_DEFINITION_TYPE(): string;
 
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SYSTEM_IMAGE_DEFINITION_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SYSTEM_IMAGE_DEFINITION_TYPE}
+   * @since Sitevision 2024.01.1
+   */
+  getMETADATA_SYSTEM_IMAGE_DEFINITION_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SYSTEM_INTEGER_DEFINITION_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SYSTEM_INTEGER_DEFINITION_TYPE}
+   * @since Sitevision 2024.01.1
+   */
+  getMETADATA_SYSTEM_INTEGER_DEFINITION_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SYSTEM_LINK_DEFINITION_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SYSTEM_LINK_DEFINITION_TYPE}
+   * @since Sitevision 2024.01.1
+   */
+  getMETADATA_SYSTEM_LINK_DEFINITION_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SYSTEM_TEXT_DEFINITION_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_SYSTEM_TEXT_DEFINITION_TYPE}
+   * @since Sitevision 2024.01.1
+   */
+  getMETADATA_SYSTEM_TEXT_DEFINITION_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_DATE_DEFINITION_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#METADATA_DATE_DEFINITION_TYPE}
+   * @since Sitevision 2024.01.1
+   */
+  getMETADATA_DATE_DEFINITION_TYPE(): string;
+
   /**
    * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#MOBILE_APP_TYPE}.
    * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#MOBILE_APP_TYPE}

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

@@ -88,6 +88,11 @@ var _default = {
   getMETADATA_USER_DEFINITION_TYPE: function getMETADATA_USER_DEFINITION_TYPE() {},
   getMETADATA_SINGLE_TAG_DEFINITION_TYPE: function getMETADATA_SINGLE_TAG_DEFINITION_TYPE() {},
   getMETADATA_MULTIPLE_TAG_DEFINITION_TYPE: function getMETADATA_MULTIPLE_TAG_DEFINITION_TYPE() {},
+  getMETADATA_SYSTEM_IMAGE_DEFINITION_TYPE: function getMETADATA_SYSTEM_IMAGE_DEFINITION_TYPE() {},
+  getMETADATA_SYSTEM_INTEGER_DEFINITION_TYPE: function getMETADATA_SYSTEM_INTEGER_DEFINITION_TYPE() {},
+  getMETADATA_SYSTEM_LINK_DEFINITION_TYPE: function getMETADATA_SYSTEM_LINK_DEFINITION_TYPE() {},
+  getMETADATA_SYSTEM_TEXT_DEFINITION_TYPE: function getMETADATA_SYSTEM_TEXT_DEFINITION_TYPE() {},
+  getMETADATA_DATE_DEFINITION_TYPE: function getMETADATA_DATE_DEFINITION_TYPE() {},
   getMOBILE_APP_TYPE: function getMOBILE_APP_TYPE() {},
   getMULTIPLE_SELECTION_FIELD_TYPE: function getMULTIPLE_SELECTION_FIELD_TYPE() {},
   getNAMED_REFERENCE_TYPE: function getNAMED_REFERENCE_TYPE() {},