@sitevision/api 2023.2.1 → 2023.2.2-beta.1

package/types/javax/jcr/security/Privilege/index.d.ts

@@ -1,188 +1,190 @@
+import type { String } from "../../../../java/lang/String";
+
 /**
  * A privilege represents the capability of performing a particular set of
- * operations on items in the JCR repository. Each privilege is identified by a
- * JCR name. JCR defines a set of standard privileges in the <code>jcr</code>
- * namespace. Implementations may add additional privileges in namespaces other
- * than <code>jcr</code>.
- * <p>
- * A privilege may be an aggregate privilege. Aggregate privileges are sets of
- * other privileges. Granting, denying, or testing an aggregate privilege is
- * equivalent to individually granting, denying, or testing each privilege it
- * contains. The privileges contained by an aggregate privilege may themselves
- * be aggregate privileges if the resulting privilege graph is acyclic.
- * <p>
- * A privilege may be an abstract privilege. Abstract privileges cannot
- * themselves be granted or denied, but can be composed into aggregate
- * privileges which are granted or denied.
- * <p>
- * A privilege can be both aggregate and abstract.
+ *  operations on items in the JCR repository. Each privilege is identified by a
+ *  JCR name. JCR defines a set of standard privileges in the <code>jcr</code>
+ *  namespace. Implementations may add additional privileges in namespaces other
+ *  than <code>jcr</code>.
+ *  <p>
+ *  A privilege may be an aggregate privilege. Aggregate privileges are sets of
+ *  other privileges. Granting, denying, or testing an aggregate privilege is
+ *  equivalent to individually granting, denying, or testing each privilege it
+ *  contains. The privileges contained by an aggregate privilege may themselves
+ *  be aggregate privileges if the resulting privilege graph is acyclic.
+ *  <p>
+ *  A privilege may be an abstract privilege. Abstract privileges cannot
+ *  themselves be granted or denied, but can be composed into aggregate
+ *  privileges which are granted or denied.
+ *  <p>
+ *  A privilege can be both aggregate and abstract.
  *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+ *  <p><strong>Sitevision note:</strong> Unsupported operation</p>
  * @since JCR 2.0
  */
 export type Privilege = {
   /**
    * Returns the name of this privilege.
-   * <p>
-   * Since the privilege name is a JCR name, it must be returned
-   * in qualified form, according to the prevailing namespace-to-prefix
-   * mapping in the current <code>Session</code> (see the specification
-   * for details on JCR names).
+   *  <p>
+   *  Since the privilege name is a JCR name, it must be returned
+   *  in qualified form, according to the prevailing namespace-to-prefix
+   *  mapping in the current <code>Session</code> (see the specification
+   *  for details on JCR names).
    * @return the name of this privilege.
    */
   getName(): string;
 
   /**
    * Returns whether this privilege is an abstract privilege.
-   * @return <code>true</code> if this privilege is an abstract privilege; <code>false</code> otherwise.
+   * @return <code>true</code> if this privilege is an abstract privilege;&#xA; <code>false</code> otherwise.
    */
   isAbstract(): boolean;
 
   /**
    * Returns whether this privilege is an aggregate privilege.
-   * @return <code>true</code> if this privilege is an aggregate privilege; <code>false</code> otherwise.
+   * @return <code>true</code> if this privilege is an aggregate privilege;&#xA; <code>false</code> otherwise.
    */
   isAggregate(): boolean;
 
   /**
    * If this privilege is an aggregate privilege, returns the privileges
-   * directly contained by the aggregate privilege. Otherwise returns an empty
-   * array.
+   *  directly contained by the aggregate privilege. Otherwise returns an empty
+   *  array.
    * @return an array of <code>Privilege</code>s
    */
   getDeclaredAggregatePrivileges(): Privilege;
 
   /**
    * If this privilege is an aggregate privilege, returns the privileges it
-   * contains, the privileges contained by any aggregate privileges among
-   * those, and so on (the transitive closure of privileges contained by this
-   * privilege). Otherwise returns an empty array.
+   *  contains, the privileges contained by any aggregate privileges among
+   *  those, and so on (the transitive closure of privileges contained by this
+   *  privilege). Otherwise returns an empty array.
    * @return an array of <code>Privilege</code>s
    */
   getAggregatePrivileges(): Privilege;
 
   /**
  * A constant representing <code>jcr:read</code> (in expanded form), the
- * privilege to retrieve a node and get its properties and their values.
+ *  privilege to retrieve a node and get its properties and their values.
   
     */
   JCR_READ: string;
 
   /**
  * A constant representing <code>jcr:modifyProperties</code> (in expanded
- * form), the privilege to create, modify and remove the properties of a
- * node.
+ *  form), the privilege to create, modify and remove the properties of a
+ *  node.
   
     */
   JCR_MODIFY_PROPERTIES: string;
 
   /**
  * A constant representing <code>jcr:addChildNodes</code> (in expanded
- * form), the privilege to create child nodes of a node.
+ *  form), the privilege to create child nodes of a node.
   
     */
   JCR_ADD_CHILD_NODES: string;
 
   /**
  * A constant representing <code>jcr:removeNode</code> (in expanded form),
- * the privilege to remove a node.
- * <p>
- * In order to actually remove a node requires <code>jcr:removeNode</code>
- * on that node and <code>jcr:removeChildNodes</code> on the parent node.
- * <p>
- * The distinction is provided in order to reflect implementations that
- * internally model "remove" as a "delete" instead of a "unlink". A
- * repository that uses the "delete" model can have <code>jcr:removeChildNodes</code>
- * in every access control policy, so that removal is effectively controlled
- * by <code>jcr:removeNode</code>.
+ *  the privilege to remove a node.
+ *  <p>
+ *  In order to actually remove a node requires <code>jcr:removeNode</code>
+ *  on that node and <code>jcr:removeChildNodes</code> on the parent node.
+ *  <p>
+ *  The distinction is provided in order to reflect implementations that
+ *  internally model "remove" as a "delete" instead of a "unlink". A
+ *  repository that uses the "delete" model can have <code>jcr:removeChildNodes</code>
+ *  in every access control policy, so that removal is effectively controlled
+ *  by <code>jcr:removeNode</code>.
   
     */
   JCR_REMOVE_NODE: string;
 
   /**
  * A constant representing <code>jcr:removeChildNodes</code> (in expanded
- * form), the privilege to remove child nodes of a node. In order to
- * actually remove a node requires <code>jcr:removeNode</code> on that node
- * and <code>jcr:removeChildNodes</code> on the parent node.
- * <p>
- * The distinction is provided in order to reflect implementations that
- * internally model "remove" as a "unlink" instead of a "delete". A
- * repository that uses the "unlink" model can have <code>jcr:removeNode</code>
- * in every access control policy, so that removal is effectively controlled
- * by <code>jcr:removeChildNodes</code>.
+ *  form), the privilege to remove child nodes of a node. In order to
+ *  actually remove a node requires <code>jcr:removeNode</code> on that node
+ *  and <code>jcr:removeChildNodes</code> on the parent node.
+ *  <p>
+ *  The distinction is provided in order to reflect implementations that
+ *  internally model "remove" as a "unlink" instead of a "delete". A
+ *  repository that uses the "unlink" model can have <code>jcr:removeNode</code>
+ *  in every access control policy, so that removal is effectively controlled
+ *  by <code>jcr:removeChildNodes</code>.
   
     */
   JCR_REMOVE_CHILD_NODES: string;
 
   /**
  * A constant representing <code>jcr:write</code> (in expanded form), an
- * aggregate privilege that contains: <ul> <li><code>jcr:modifyProperties</code></li>
- * <li><code>jcr:addChildNodes</code></li> <li><code>jcr:removeNode</code></li>
- * <li><code>jcr:removeChildNodes</code></li> </ul>
+ *  aggregate privilege that contains: <ul> <li><code>jcr:modifyProperties</code></li>
+ *  <li><code>jcr:addChildNodes</code></li> <li><code>jcr:removeNode</code></li>
+ *  <li><code>jcr:removeChildNodes</code></li> </ul>
   
     */
   JCR_WRITE: string;
 
   /**
  * A constant representing <code>jcr:readAccessControl</code> (in expanded
- * form), the privilege to get the access control policy of a node.
+ *  form), the privilege to get the access control policy of a node.
   
     */
   JCR_READ_ACCESS_CONTROL: string;
 
   /**
  * A constant representing <code>jcr:modifyAccessControl</code> (in expanded
- * form), the privilege to modify the access control policies of a node.
+ *  form), the privilege to modify the access control policies of a node.
   
     */
   JCR_MODIFY_ACCESS_CONTROL: string;
 
   /**
  * A constant representing <code>jcr:lockManagement</code> (in expanded
- * form), the privilege to lock and unlock a node.
+ *  form), the privilege to lock and unlock a node.
   
     */
   JCR_LOCK_MANAGEMENT: string;
 
   /**
  * A constant representing <code>jcr:versionManagement</code> (in expanded
- * form), the privilege to perform versioning operations on a node.
+ *  form), the privilege to perform versioning operations on a node.
   
     */
   JCR_VERSION_MANAGEMENT: string;
 
   /**
  * A constant representing <code>jcr:nodeTypeManagement</code> (in expanded
- * form), the privilege to add and remove mixin node types and change the
- * primary node type of a node.
+ *  form), the privilege to add and remove mixin node types and change the
+ *  primary node type of a node.
   
     */
   JCR_NODE_TYPE_MANAGEMENT: string;
 
   /**
  * A constant representing <code>jcr:retentionManagement</code> (in expanded
- * form), the privilege to perform retention management operations on a
- * node.
+ *  form), the privilege to perform retention management operations on a
+ *  node.
   
     */
   JCR_RETENTION_MANAGEMENT: string;
 
   /**
  * A constant representing <code>jcr:lifecycleManagement</code> (in expanded
- * form), the privilege to perform lifecycle operations on a node.
+ *  form), the privilege to perform lifecycle operations on a node.
   
     */
   JCR_LIFECYCLE_MANAGEMENT: string;
 
   /**
  * A constant representing <code>jcr:all</code> (in expanded form), an
- * aggregate privilege that contains all predefined privileges. <ul>
- * <li><code>jcr:read</code></li> <li><code>jcr:write</code></li>
- * <li><code>jcr:readAccessControl</code></li> <li><code>jcr:modifyAccessControl</code></li>
- * <li><code>jcr:lockManagement</code></li> <li><code>jcr:versionManagement</code></li>
- * <li><code>jcr:nodeTypeManagement</code></li> <li><code>jcr:retentionManagement</code></li>
- * <li><code>jcr:lifecycleManagement</code></li> </ul> It should, in
- * addition, include all implementation-defined privileges.
+ *  aggregate privilege that contains all predefined privileges. <ul>
+ *  <li><code>jcr:read</code></li> <li><code>jcr:write</code></li>
+ *  <li><code>jcr:readAccessControl</code></li> <li><code>jcr:modifyAccessControl</code></li>
+ *  <li><code>jcr:lockManagement</code></li> <li><code>jcr:versionManagement</code></li>
+ *  <li><code>jcr:nodeTypeManagement</code></li> <li><code>jcr:retentionManagement</code></li>
+ *  <li><code>jcr:lifecycleManagement</code></li> </ul> It should, in
+ *  addition, include all implementation-defined privileges.
   
     */
   JCR_ALL: string;

package/types/javax/jcr/util/TraversingItemVisitor/index.d.ts

@@ -0,0 +1,87 @@
+import type { Property } from "../../Property";
+
+import type { Node } from "../../Node";
+import type { Object } from "../../../../java/lang/Object";
+import type { ItemVisitor } from "../../ItemVisitor";
+
+/**
+ * An implementation of <code>ItemVisitor</code>.
+ *  <p>
+ *  <code>TraversingItemVisitor</code> is an abstract utility class which allows
+ *  to easily traverse an <code>Item</code> hierarchy.
+ *  </p>
+ *  <p><code>TraversingItemVisitor</code> makes use of the Visitor Pattern as
+ *  described in the book 'Design Patterns' by the Gang Of Four (Gamma et al.).
+ *  </p>
+ *  <p>Tree traversal is done observing the left-to-right order of child
+ *  <code>Item</code>s if such an order is supported and exists.
+ *  </p>
+  
+    */
+export type TraversingItemVisitor = Object &
+  ItemVisitor & {
+    /**
+     * Implement this method to add behavior performed before a
+     *  <code>Property</code> is visited.
+     * @param property the <code>Property</code> that is accepting this&#xA; visitor.
+     * @param level hierarchy level of this property (the root node starts at&#xA; level 0).
+     * @throws RepositoryException if an error occurs.
+     */
+    entering(property: Property, level: number): void;
+
+    /**
+     * Implement this method to add behavior performed before a
+     *  <code>Node</code> is visited.
+     * @param node the <code>Node</code> that is accepting this visitor.
+     * @param level hierarchy level of this node (the root node starts at level&#xA; 0).
+     * @throws RepositoryException if an error occurs.
+     */
+    entering(node: Node, level: number): void;
+
+    /**
+     * Implement this method to add behavior performed after a
+     *  <code>Property</code> is visited.
+     * @param property the <code>Property</code> that is accepting this&#xA; visitor.
+     * @param level hierarchy level of this property (the root node starts at&#xA; level 0).
+     * @throws RepositoryException if an error occurs.
+     */
+    leaving(property: Property, level: number): void;
+
+    /**
+     * Implement this method to add behavior performed after a <code>Node</code>
+     *  is visited.
+     * @param node the <code>Node</code> that is accepting this visitor.
+     * @param level hierarchy level of this node (the root node starts at level&#xA; 0).
+     * @throws RepositoryException if an error occurs.
+     */
+    leaving(node: Node, level: number): void;
+
+    /**
+     * Called when the <code>Visitor</code> is passed to a
+     *  <code>Property</code>.
+     *  <p>
+     *  It calls <code>TraversingItemVisitor.entering(Property, int)</code>
+     *  followed by <code>TraversingItemVisitor.leaving(Property, int)</code>.
+     *  Implement these abstract methods to specify behavior on 'arrival at' and
+     *  'after leaving' the <code>Property</code>.
+     *  <p>
+     *  If this method throws, the visiting process is aborted.
+     * @param property the <code>Property</code> that is accepting this&#xA; visitor.
+     * @throws RepositoryException if an error occurs.
+     */
+    visit(property: Property): void;
+
+    /**
+     * Called when the <code>Visitor</code> is passed to a <code>Node</code>.
+     *  <p>
+     *  It calls <code>TraversingItemVisitor.entering(Node, int)</code> followed
+     *  by <code>TraversingItemVisitor.leaving(Node, int)</code>. Implement these
+     *  abstract methods to specify behavior on 'arrival at' and 'after leaving'
+     *  the <code>Node</code>.
+     *  <p>
+     *  If this method throws, the visiting process is aborted.
+     * @param node the <code>Node</code> that is accepting this visitor.
+     * @throws RepositoryException if an error occurs.
+     */
+    visit(node: Node): void;
+  };

package/types/javax/jcr/util/TraversingItemVisitor/index.js

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

package/types/javax/jcr/util/TraversingItemVisitor.Default/index.d.ts

@@ -0,0 +1,19 @@
+import type { Node } from "../../Node";
+
+import type { Property } from "../../Property";
+import type { TraversingItemVisitor } from "../TraversingItemVisitor";
+
+/**
+ * Convenience class providing default implementations of the abstract
+ *  methods of <code>TraversingItemVisitor</code>.
+  
+    */
+export type Default = TraversingItemVisitor & {
+  entering(node: Node, level: number): void;
+
+  entering(property: Property, level: number): void;
+
+  leaving(node: Node, level: number): void;
+
+  leaving(property: Property, level: number): void;
+};

package/types/javax/jcr/util/TraversingItemVisitor.Default/index.js

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

package/types/javax/jcr/version/ActivityViolationException/index.d.ts

@@ -0,0 +1,14 @@
+import type { VersionException } from "../VersionException";
+
+/**
+ * Exception will be thrown by <code>Node.checkout</code> and
+ *  <code>Node.checkpoint</code> if an activity A is present on the current
+ *  session and any of the following conditions is met: <ul> <li>There already is
+ *  a node in another workspace that has a checked-out node for the version
+ *  history of N whose jcr:activity references A.</li> <li>There is a version in
+ *  the version history of N that is not a predecessor of N but whose
+ *  jcr:activity references A.</li> </ul>
+ * @since Sitevision 3.5
+ * @since JCR 2.0
+ */
+export type ActivityViolationException = VersionException & {};

package/types/javax/jcr/version/ActivityViolationException/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/javax/jcr/version/LabelExistsVersionException/index.d.ts

@@ -0,0 +1,9 @@
+import type { VersionException } from "../VersionException";
+
+/**
+ * Exception thrown by <code>VersionHistory.addVersionLabel</code> if
+ *  <code>moveLabel</code> is set to <code>false</code> and an attempt is made to
+ *  add a label that already exists in the <code>VersionHistory</code>.
+ * @since JCR 2.0
+ */
+export type LabelExistsVersionException = VersionException & {};

package/types/javax/jcr/version/LabelExistsVersionException/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/javax/jcr/version/OnParentVersionAction/index.d.ts

@@ -0,0 +1,71 @@
+import type { String } from "../../../../java/lang/String";
+import type { Object } from "../../../../java/lang/Object";
+
+/**
+ * The possible actions specified by the <code>onParentVersion</code> attribute
+ *  in a property definition within a node type definition.
+ *  <p>
+ *  This interface defines the following actions: <UL> <LI><code>COPY</code>
+ *  <LI><code>VERSION</code> <LI><code>INITIALIZE</code> <LI><code>COMPUTE</code>
+ *  <LI><code>IGNORE</code> <LI><code>ABORT</code> </UL>
+ *  <p>
+ *  Every item (node or property) in the repository has a status indicator that
+ *  governs what happens to that item when its parent node is versioned. This
+ *  status is defined by the <code>onParentVersion</code> attribute in the
+ *  <code>PropertyDefinition</code> or <code>NodeDefinition</code> that applies
+ *  to the item in question.
+ * 
+ *  <p><strong>Sitevision note:</strong> Unsupported operation</p>
+  
+    */
+export type OnParentVersionAction = Object & {
+  /**
+   * Returns the name of the specified <code>action</code>, as used in
+   *  serialization.
+   * @param action the on-version action
+   * @return the name of the specified <code>action</code>
+   * @throws IllegalArgumentException if <code>action</code> is not a valid&#xA; on-version action.
+   */
+  nameFromValue(action: number): string;
+
+  /**
+   * Returns the numeric constant value of the on-version action with the
+   *  specified name.
+   * @param name the name of the on-version action
+   * @return the numeric constant value
+   * @throws IllegalArgumentException if <code>name</code> is not a valid&#xA; on-version action name.
+   */
+  valueFromName(name: String | string): number;
+
+  /**
+ * The action constants.
+  
+    */
+  COPY: number;
+
+  VERSION: number;
+
+  INITIALIZE: number;
+
+  COMPUTE: number;
+
+  IGNORE: number;
+
+  ABORT: number;
+
+  /**
+ * The names of the defined on-version actions, as used in serialization.
+  
+    */
+  ACTIONNAME_COPY: string;
+
+  ACTIONNAME_VERSION: string;
+
+  ACTIONNAME_INITIALIZE: string;
+
+  ACTIONNAME_COMPUTE: string;
+
+  ACTIONNAME_IGNORE: string;
+
+  ACTIONNAME_ABORT: string;
+};

package/types/javax/jcr/version/OnParentVersionAction/index.js

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

package/types/javax/jcr/version/Version/index.d.ts

@@ -1,43 +1,43 @@
 import type { VersionHistory } from "../VersionHistory";
-
+import type { Calendar } from "../../../../java/util/Calendar";
 import type { Node } from "../../Node";
 
 /**
  * A <code>Version</code> object wraps an <code>nt:version</code> node. It
- * provides convenient access to version information.
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+ *  provides convenient access to version information.
+ * 
+ *  <p><strong>Sitevision note:</strong> Unsupported operation</p>
   
     */
 export type Version = Node & {
   /**
    * Returns the <code>VersionHistory</code> that contains this
-   * <code>Version</code>.
-   * @return the <code>VersionHistory</code> that contains this <code>Version</code>.
+   *  <code>Version</code>.
+   * @return the <code>VersionHistory</code> that contains this&#xA; <code>Version</code>.
    * @throws RepositoryException if an error occurs.
    */
   getContainingHistory(): VersionHistory;
 
   /**
    * Returns the date this version was created. This corresponds to the value
-   * of the <code>jcr:created</code> property in the <code>nt:version</code>
-   * node that represents this version.
+   *  of the <code>jcr:created</code> property in the <code>nt:version</code>
+   *  node that represents this version.
    * @return a <code>Calendar</code> object
    * @throws RepositoryException if an error occurs.
    */
-  getCreated(): unknown;
+  getCreated(): Calendar;
 
   /**
    * Assuming that this <code>Version</code> object was acquired through a
-   * <code>Workspace</code> <code>W</code> and is within the
-   * <code>VersionHistory</code> <code>H</code>, this method returns the
-   * successor of this version along the same line of descent as is returned
-   * by <code>H.getAllLinearVersions()</code> where <code>H</code> was also
-   * acquired through <code>W</code>.
-   * <p>
-   * Note that under simple versioning the behavior of this method is
-   * equivalent to getting the unique successor (if any) of this version.
-   * @return a <code>Version</code> or <code>null</code> if no linear successor exists.
+   *  <code>Workspace</code> <code>W</code> and is within the
+   *  <code>VersionHistory</code> <code>H</code>, this method returns the
+   *  successor of this version along the same line of descent as is returned
+   *  by <code>H.getAllLinearVersions()</code> where <code>H</code> was also
+   *  acquired through <code>W</code>.
+   *  <p>
+   *  Note that under simple versioning the behavior of this method is
+   *  equivalent to getting the unique successor (if any) of this version.
+   * @return a <code>Version</code> or <code>null</code> if no linear&#xA; successor exists.
    * @throws RepositoryException if an error occurs.
    * @see VersionHistory#getAllLinearVersions
    */
@@ -45,11 +45,11 @@ export type Version = Node & {
 
   /**
    * Returns the successor versions of this version. This corresponds to
-   * returning all the <code>nt:version</code> nodes referenced by the
-   * <code>jcr:successors</code> multi-value property in the
-   * <code>nt:version</code> node that represents this version.
-   * <p>
-   * In a simple versioning repository this method
+   *  returning all the <code>nt:version</code> nodes referenced by the
+   *  <code>jcr:successors</code> multi-value property in the
+   *  <code>nt:version</code> node that represents this version.
+   *  <p>
+   *  In a simple versioning repository this method
    * @return a <code>Version</code> array.
    * @throws RepositoryException if an error occurs.
    */
@@ -57,15 +57,15 @@ export type Version = Node & {
 
   /**
    * Assuming that this <code>Version</code> object was acquired through a
-   * <code>Workspace</code> <code>W</code> and is within the
-   * <code>VersionHistory</code> <code>H</code>, this method returns the
-   * predecessor of this version along the same line of descent as is returned
-   * by <code>H.getAllLinearVersions()</code> where <code>H</code> was also
-   * acquired through <code>W</code>.
-   * <p>
-   * Note that under simple versioning the behavior of this method is
-   * equivalent to getting the unique predecessor (if any) of this version.
-   * @return a <code>Version</code> or <code>null</code> if no linear predecessor exists.
+   *  <code>Workspace</code> <code>W</code> and is within the
+   *  <code>VersionHistory</code> <code>H</code>, this method returns the
+   *  predecessor of this version along the same line of descent as is returned
+   *  by <code>H.getAllLinearVersions()</code> where <code>H</code> was also
+   *  acquired through <code>W</code>.
+   *  <p>
+   *  Note that under simple versioning the behavior of this method is
+   *  equivalent to getting the unique predecessor (if any) of this version.
+   * @return a <code>Version</code> or <code>null</code> if no linear&#xA; predecessor exists.
    * @throws RepositoryException if an error occurs.
    * @see VersionHistory#getAllLinearVersions
    */
@@ -73,10 +73,10 @@ export type Version = Node & {
 
   /**
    * In both simple and full versioning repositories, this method returns the
-   * predecessor versions of this version. This corresponds to returning all
-   * the <code>nt:version</code> nodes whose <code>jcr:successors</code>
-   * property includes a reference to the <code>nt:version</code> node that
-   * represents this version.
+   *  predecessor versions of this version. This corresponds to returning all
+   *  the <code>nt:version</code> nodes whose <code>jcr:successors</code>
+   *  property includes a reference to the <code>nt:version</code> node that
+   *  represents this version.
    * @return a <code>Version</code> array.
    * @throws RepositoryException if an error occurs.
    */