@sitevision/api 2024.1.1 → 2024.1.2

package/index.d.ts

@@ -81,6 +81,7 @@ import './server/PortletUtil';
 import './server/PrincipalUtil';
 import './server/Properties';
 import './server/PropertyUtil';
+import './server/PublishStatus';
 import './server/PublishingUtil';
 import './server/QueryStringUtil';
 import './server/RedirectUtil';

package/package.json

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

package/server/ArticleUtil/index.d.ts

@@ -123,6 +123,33 @@ export interface ArticleUtil extends ArticleUtilConstants {
    */
   PROPERTY_PUBLISHED_BY: "publishedBy";
 
+  /**
+   * <p>
+   *     Name of the property specifying the last user to unpublish an article.
+   *     It corresponds to the sv:article property <code>lastUnpublishedBy</code>.
+   *  </p>
+   *
+   *  <p>
+   *     The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.
+   *  </p>
+   * @since Sitevision 2024.01.2
+   */
+  PROPERTY_LAST_UNPUBLISHED_BY: "lastUnpublishedBy";
+
+  /**
+   * <p>
+   *     Name of the property specifying the last unpublished date of an article.
+   *     It corresponds to the sv:article property <code>lastUnpublishDate</code>.
+   *  </p>
+   *
+   *  <p>
+   *     The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss,
+   *     where HH:mm:ss is optional (defaults to 00:00:00).
+   *  </p>
+   * @since Sitevision 2024.01.2
+   */
+  PROPERTY_LAST_UNPUBLISH_DATE: "lastUnpublishDate";
+
   /**
    * <p>Creates an article as sub node to a specified parent. The parent must be a node with primary
    *  node type sv:archive. If other parent is specified a <code>ConstraintViolationException</code> is thrown.</p>
@@ -212,6 +239,8 @@ export interface ArticleUtil extends ArticleUtilConstants {
    *  <li>{@link #PROPERTY_LAST_PUBLISHED_BY} - null (will not have a value)</li>
    *  <li>{@link #PROPERTY_PUBLISH_DATE} - null (will not have a value)</li>
    *  <li>{@link #PROPERTY_PUBLISHED_BY} - null (will not have a value)</li>
+   *  <li>{@link #PROPERTY_LAST_UNPUBLISHED_BY} - null (will not have a value)</li>
+   *  <li>{@link #PROPERTY_LAST_UNPUBLISH_DATE} - null (will not have a value)</li>
    *  </ul>
    *
    *  <p>The article content is specified using the
@@ -289,6 +318,12 @@ export interface ArticleUtil extends ArticleUtilConstants {
    *  <li>
    *     {@link #PROPERTY_PUBLISHED_BY}
    *  </li>
+   *  <li>
+   *     {@link #PROPERTY_LAST_UNPUBLISHED_BY}
+   *  </li>
+   *  <li>
+   *     {@link #PROPERTY_LAST_UNPUBLISH_DATE}
+   *  </li>
    *  </ul>
    *  <p>
    *     If an invalid value is provided for a property, an <code>IllegalArgumentException</code> is thrown.

package/server/LinkPageUtil/index.d.ts

@@ -116,6 +116,33 @@ export interface LinkPageUtil extends LinkPageUtilConstants {
     */
   PROPERTY_PUBLISHED_BY: "publishedBy";
 
+  /**
+   * <p>
+   *     Name of the property specifying the last user to unpublish a link page.
+   *     It corresponds to the sv:link property <code>lastUnpublishedBy</code>.
+   *  </p>
+   *
+   *  <p>
+   *     The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.
+   *  </p>
+   * @since Sitevision 2024.01.2
+   */
+  PROPERTY_LAST_UNPUBLISHED_BY: "lastUnpublishedBy";
+
+  /**
+   * <p>
+   *     Name of the property specifying the last unpublished date of a link page.
+   *     It corresponds to the sv:link property <code>lastUnpublishDate</code>.
+   *  </p>
+   *
+   *  <p>
+   *     The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss,
+   *     where HH:mm:ss is optional (defaults to 00:00:00).
+   *  </p>
+   * @since Sitevision 2024.01.2
+   */
+  PROPERTY_LAST_UNPUBLISH_DATE: "lastUnpublishDate";
+
   /**
    * <p>
    *     Creates a link page as sub node of a specified parent.
@@ -207,6 +234,8 @@ export interface LinkPageUtil extends LinkPageUtilConstants {
    *     <li>{@link #PROPERTY_LAST_PUBLISHED_BY}</li>
    *     <li>{@link #PROPERTY_PUBLISH_DATE}</li>
    *     <li>{@link #PROPERTY_PUBLISHED_BY}</li>
+   *     <li>{@link #PROPERTY_LAST_UNPUBLISHED_BY}</li>
+   *     <li>{@link #PROPERTY_LAST_UNPUBLISH_DATE}</li>
    *  </ul>
    *  <p>
    *     If an invalid value is provided for a property, an <code>IllegalArgumentException</code> is thrown
@@ -225,6 +254,8 @@ export interface LinkPageUtil extends LinkPageUtilConstants {
    *     <li>{@link #PROPERTY_LAST_PUBLISHED_BY} - null (will not have a value)</li>
    *     <li>{@link #PROPERTY_PUBLISH_DATE} - null (will not have a value)</li>
    *     <li>{@link #PROPERTY_PUBLISHED_BY} - null (will not have a value)</li>
+   *     <li>{@link #PROPERTY_LAST_UNPUBLISHED_BY} - null (will not have a value)</li>
+   *     <li>{@link #PROPERTY_LAST_UNPUBLISH_DATE} - null (will not have a value)</li>
    *  </ul>
    *
    *  <p>

package/server/PageUtil/index.d.ts

@@ -129,6 +129,33 @@ export interface PageUtil extends PageUtilConstants {
    */
   PROPERTY_PUBLISHED_BY: "publishedBy";
 
+  /**
+   * <p>
+   *     Name of the property specifying the last user to unpublish a page.
+   *     It corresponds to the sv:page property <code>lastUnpublishedBy</code>.
+   *  </p>
+   *
+   *  <p>
+   *     The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.
+   *  </p>
+   * @since Sitevision 2024.01.2
+   */
+  PROPERTY_LAST_UNPUBLISHED_BY: "lastUnpublishedBy";
+
+  /**
+   * <p>
+   *     Name of the property specifying the last unpublished date of a page.
+   *     It corresponds to the sv:page property <code>lastUnpublishDate</code>.
+   *  </p>
+   *
+   *  <p>
+   *     The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss,
+   *     where HH:mm:ss is optional (defaults to 00:00:00).
+   *  </p>
+   * @since Sitevision 2024.01.2
+   */
+  PROPERTY_LAST_UNPUBLISH_DATE: "lastUnpublishDate";
+
   /**
    * <p>
    *     Creates a page as sub node to the specified parent.
@@ -205,6 +232,8 @@ export interface PageUtil extends PageUtilConstants {
    *     <li>{@link #PROPERTY_LAST_PUBLISHED_BY} - null (will not have a value)</li>
    *     <li>{@link #PROPERTY_PUBLISH_DATE} - null (will not have a value)</li>
    *     <li>{@link #PROPERTY_PUBLISHED_BY} - null (will not have a value)</li>
+   *     <li>{@link #PROPERTY_LAST_UNPUBLISHED_BY} - null (will not have a value)</li>
+   *     <li>{@link #PROPERTY_LAST_UNPUBLISH_DATE} - null (will not have a value)</li>
    *  </ul>
    *
    *  <p>The page content is specified using the
@@ -261,6 +290,8 @@ export interface PageUtil extends PageUtilConstants {
    *     <li>{@link #PROPERTY_LAST_PUBLISHED_BY}</li>
    *     <li>{@link #PROPERTY_PUBLISH_DATE}</li>
    *     <li>{@link #PROPERTY_PUBLISHED_BY}</li>
+   *     <li>{@link #PROPERTY_LAST_UNPUBLISHED_BY}</li>
+   *     <li>{@link #PROPERTY_LAST_UNPUBLISH_DATE}</li>
    *  </ul>
    *  <p>If an invalid value is provided for a property, an <code>IllegalArgumentException</code> is thrown.</p>
    *

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

@@ -52,6 +52,7 @@ declare enum Permission {
   MANAGE_PINNING,
   MANAGE_TYPES_IDENTIFIERS,
   MANAGE_CUSTOM_SEARCH_INDEX,
+  MANAGE_PUBLISHING_LOCK,
 }
 
 export default Permission;

package/server/PermissionUtil.Permission/index.js

@@ -36,6 +36,7 @@ var _default = {
   CREATE_PRIVATE_CHANNELS: "CREATE_PRIVATE_CHANNELS",
   MANAGE_PINNING: "MANAGE_PINNING",
   MANAGE_TYPES_IDENTIFIERS: "MANAGE_TYPES_IDENTIFIERS",
-  MANAGE_CUSTOM_SEARCH_INDEX: "MANAGE_CUSTOM_SEARCH_INDEX"
+  MANAGE_CUSTOM_SEARCH_INDEX: "MANAGE_CUSTOM_SEARCH_INDEX",
+  MANAGE_PUBLISHING_LOCK: "MANAGE_PUBLISHING_LOCK"
 };
 exports["default"] = _default;

package/server/PublishStatus/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * <p>
+ *     Different statuses for nodes that can be published.
+ *  </p>
+ * @author Gustav Holmberg
+ * @see senselogic.sitevision.api.versioning.PublishingUtil#getPublishStatus(javax.jcr.Node)
+ * @since Sitevision 2024.01.2
+ */
+declare enum PublishStatus {
+  NOT_PUBLISHED,
+  PUBLISHED,
+  WORKFLOW_STARTED,
+  SCHEDULED_PUBLISH,
+  SCHEDULED_UNPUBLISH,
+  SCHEDULED_PUBLISH_BY_PUBLISHING_PROJECT,
+  BELONGS_TO_PUBLISHING_PROJECT,
+  LOCKED,
+}
+
+export default PublishStatus;

package/server/PublishStatus/index.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  NOT_PUBLISHED: "NOT_PUBLISHED",
+  PUBLISHED: "PUBLISHED",
+  WORKFLOW_STARTED: "WORKFLOW_STARTED",
+  SCHEDULED_PUBLISH: "SCHEDULED_PUBLISH",
+  SCHEDULED_UNPUBLISH: "SCHEDULED_UNPUBLISH",
+  SCHEDULED_PUBLISH_BY_PUBLISHING_PROJECT: "SCHEDULED_PUBLISH_BY_PUBLISHING_PROJECT",
+  BELONGS_TO_PUBLISHING_PROJECT: "BELONGS_TO_PUBLISHING_PROJECT",
+  LOCKED: "LOCKED"
+};
+exports["default"] = _default;

package/server/PublishingUtil/index.d.ts

@@ -1,6 +1,7 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
 import type { Date } from "../../types/java/util/Date";
+import type PublishStatus from "../PublishStatus";
 
 /**
  * Publishing/unpublishing utility interface.
@@ -256,6 +257,58 @@ export interface PublishingUtil {
    * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectivePublishPermission(Node, Node)
    */
   unpublishNode(aNode: Node, aDate: Date): void;
+
+  /**
+   * <p>
+   *     Gets the publish status of a node.
+   *  </p>
+   *
+   *  <p>
+   *     Valid nodes are <code>sv:sitePage</code>, <code>sv:page</code>, <code>sv:article</code>, <code>sv:collaborationGroupPage</code>,
+   *     <code>sv:template</code> and <code>sv:link</code> <em>(must be a "page link", a stand-alone link in the page tree)</em>.
+   *     If another node is specified an <code>IllegalArgumentException</code> is thrown.
+   *  </p>
+   *
+   *  <p>
+   *     If no node is specified a <code>NullPointerException</code> is thrown.
+   *  </p>
+   * @param aNode the node whose publish status is to be checked
+   * @return the publish status for aNode
+   * @throws NullPointerException if <code>aNode</code> is null
+   * @throws IllegalArgumentException if <code>aNode</code> is of invalid type
+   * @throws ConstraintViolationException if current user is not authorized to publish nodes
+   * @throws RepositoryException if something else goes wrong
+   * @since Sitevision 2024.01.2
+   */
+  getPublishStatus(aNode: Node): PublishStatus;
+
+  /**
+   * <p>
+   *     Clears the publish and unpublish schedule for a node.
+   *  </p>
+   *
+   *  <p>
+   *     Valid nodes are <code>sv:sitePage</code>, <code>sv:page</code>, <code>sv:article</code>, <code>sv:collaborationGroupPage</code>,
+   *     <code>sv:template</code> and <code>sv:link</code> <em>(must be a "page link", a stand-alone link in the page tree)</em>.
+   *     If another node is specified an <code>IllegalArgumentException</code> is thrown.
+   *  </p>
+   *
+   *  <p>
+   *     If no node is specified a <code>NullPointerException</code> is thrown.
+   *  </p>
+   *
+   *  <p>
+   *     The current user must be authorized to publish nodes and manage publishing locks or a <code>ConstraintViolationException</code>
+   *     will be thrown.
+   *  </p>
+   * @param aNode that is scheduled for either publishing, unpublishing or both
+   * @throws NullPointerException if <code>aNode</code> is null
+   * @throws IllegalArgumentException if <code>aNode</code> is of invalid type
+   * @throws ConstraintViolationException if current user is not authorized to clear the schedule for <code>aNode</code>
+   * @throws RepositoryException if something else goes wrong
+   * @since Sitevision 2024.01.2
+   */
+  clearPublishingSchedule(aNode: Node): void;
 }
 
 declare namespace PublishingUtil {}

package/server/PublishingUtil/index.js

@@ -7,6 +7,8 @@ exports["default"] = void 0;
 var _default = {
   publishNode: function publishNode() {},
   publishNodeWithNotification: function publishNodeWithNotification() {},
-  unpublishNode: function unpublishNode() {}
+  unpublishNode: function unpublishNode() {},
+  getPublishStatus: function getPublishStatus() {},
+  clearPublishingSchedule: function clearPublishingSchedule() {}
 };
 exports["default"] = _default;

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

@@ -82,4 +82,18 @@ export type ArticleUtilConstants = {
    * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_PUBLISH_DATE}
    */
   getPROPERTY_PUBLISH_DATE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_UNPUBLISHED_BY}.
+   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_UNPUBLISHED_BY}
+   * @since Sitevision 2024.01.2
+   */
+  getPROPERTY_LAST_UNPUBLISHED_BY(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_UNPUBLISH_DATE}.
+   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_UNPUBLISH_DATE}
+   * @since Sitevision 2024.01.2
+   */
+  getPROPERTY_LAST_UNPUBLISH_DATE(): string;
 };

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

@@ -16,6 +16,8 @@ var _default = {
   getPROPERTY_LAST_PUBLISHED_BY: function getPROPERTY_LAST_PUBLISHED_BY() {},
   getPROPERTY_LAST_PUBLISH_DATE: function getPROPERTY_LAST_PUBLISH_DATE() {},
   getPROPERTY_PUBLISHED_BY: function getPROPERTY_PUBLISHED_BY() {},
-  getPROPERTY_PUBLISH_DATE: function getPROPERTY_PUBLISH_DATE() {}
+  getPROPERTY_PUBLISH_DATE: function getPROPERTY_PUBLISH_DATE() {},
+  getPROPERTY_LAST_UNPUBLISHED_BY: function getPROPERTY_LAST_UNPUBLISHED_BY() {},
+  getPROPERTY_LAST_UNPUBLISH_DATE: function getPROPERTY_LAST_UNPUBLISH_DATE() {}
 };
 exports["default"] = _default;

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

@@ -64,4 +64,18 @@ export type LinkPageUtilConstants = {
    * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_PUBLISH_DATE}
    */
   getPROPERTY_PUBLISH_DATE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_UNPUBLISHED_BY}.
+   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_UNPUBLISHED_BY}
+   * @since Sitevision 2024.01.2
+   */
+  getPROPERTY_LAST_UNPUBLISHED_BY(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_UNPUBLISH_DATE}.
+   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_UNPUBLISH_DATE}
+   * @since Sitevision 2024.01.2
+   */
+  getPROPERTY_LAST_UNPUBLISH_DATE(): string;
 };

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

@@ -13,6 +13,8 @@ var _default = {
   getPROPERTY_LAST_PUBLISHED_BY: function getPROPERTY_LAST_PUBLISHED_BY() {},
   getPROPERTY_LAST_PUBLISH_DATE: function getPROPERTY_LAST_PUBLISH_DATE() {},
   getPROPERTY_PUBLISHED_BY: function getPROPERTY_PUBLISHED_BY() {},
-  getPROPERTY_PUBLISH_DATE: function getPROPERTY_PUBLISH_DATE() {}
+  getPROPERTY_PUBLISH_DATE: function getPROPERTY_PUBLISH_DATE() {},
+  getPROPERTY_LAST_UNPUBLISHED_BY: function getPROPERTY_LAST_UNPUBLISHED_BY() {},
+  getPROPERTY_LAST_UNPUBLISH_DATE: function getPROPERTY_LAST_UNPUBLISH_DATE() {}
 };
 exports["default"] = _default;

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

@@ -83,9 +83,23 @@ export type PageUtilConstants = {
    */
   getPROPERTY_PUBLISH_DATE(): string;
 
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_UNPUBLISHED_BY}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_UNPUBLISHED_BY}
+   */
+  getPROPERTY_LAST_UNPUBLISHED_BY(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_UNPUBLISH_DATE}.
+   * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_LAST_UNPUBLISH_DATE}
+   * @since Sitevision 2024.01.2
+   */
+  getPROPERTY_LAST_UNPUBLISH_DATE(): string;
+
   /**
    * Get accessor for {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_TITLE}.
    * @return {@link senselogic.sitevision.api.webresource.PageUtil#PROPERTY_TITLE}
+   * @since Sitevision 2024.01.2
    */
   getPROPERTY_TITLE(): string;
 };

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

@@ -17,6 +17,8 @@ var _default = {
   getPROPERTY_LAST_PUBLISH_DATE: function getPROPERTY_LAST_PUBLISH_DATE() {},
   getPROPERTY_PUBLISHED_BY: function getPROPERTY_PUBLISHED_BY() {},
   getPROPERTY_PUBLISH_DATE: function getPROPERTY_PUBLISH_DATE() {},
+  getPROPERTY_LAST_UNPUBLISHED_BY: function getPROPERTY_LAST_UNPUBLISHED_BY() {},
+  getPROPERTY_LAST_UNPUBLISH_DATE: function getPROPERTY_LAST_UNPUBLISH_DATE() {},
   getPROPERTY_TITLE: function getPROPERTY_TITLE() {}
 };
 exports["default"] = _default;