@sitevision/api 2.0.0-alpha.0 → 2.0.0-alpha.2

package/types/javax/jcr/Node/index.d.ts

@@ -0,0 +1,334 @@
+import type Value from "../Value";
+import type Property from "../Property";
+
+import type Binary from "../Binary";
+
+import type NodeIterator from "../NodeIterator";
+import type PropertyIterator from "../PropertyIterator";
+import type Item from "../Item";
+import type NodeType from "../nodetype/NodeType";
+import type NodeDefinition from "../nodetype/NodeDefinition";
+import type Version from "../version/Version";
+import type VersionHistory from "../version/VersionHistory";
+import type Lock from "../lock/Lock";
+
+/**
+ * The <code>Node</code> interface represents a node in a workspace.
+  
+    */
+type Node = Item & {
+  /**
+   * Sets the specified single-value property to the specified value. If the
+   * property does not yet exist, it is created.
+   * <p>
+   * The behavior of this method is identical to that of {@link
+   * #setProperty(String name, String value)} except that the intended type of
+   * the property is explicitly specified by the <code>type</code> parameter.
+   * @param name the name of the property to be set.
+   * @param value a <code>String</code> object.
+   * @param type the type of the property.
+   * @return the <code>Property</code> object set, or <code>null</code> if this method was used to remove a property (by setting its value to <code>null</code>).
+   * @throws ValueFormatException if <code>value</code> cannot be converted to the specified type or if the property already exists and is multi-valued.
+   * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setProperty(name: string, value: string, type: number): Property;
+
+  /**
+   * The behavior of this method is identical to that of {@link
+   * #setProperty(String name, Value value)} except that the value is
+   * specified as a {@link InputStream} and, if possible, the type assigned to
+   * the property is <code>BINARY</code>, otherwise a best-effort conversion
+   * is attempted.
+   * <p>
+   * The passed stream is closed before this method returns either normally or
+   * because of an exception.
+   * <p>
+   * @param name The name of a property of this node
+   * @param value The value to assigned
+   * @return The updated <code>Property</code> object
+   * @throws ValueFormatException if <code>value</code> cannot be converted to the type of the specified property or if the property already exists and is multi-valued.
+   * @throws VersionException if this node is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the property and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   * @deprecated As of JCR 2.0, {@link #setProperty(String, Binary)} should be used instead.
+   */
+  setProperty(name: string, value: unknown): Property;
+
+  /**
+   * Returns the node at <code>relPath</code> relative to this node.
+   * <p>
+   * If <code>relPath</code> contains a path element that refers to a node
+   * with same-name sibling nodes without explicitly including an index using
+   * the array-style notation (<code>[x]</code>), then the index [1] is
+   * assumed (indexing of same name siblings begins at 1, not 0, in order to
+   * preserve compatibility with XPath).
+   * <p>
+   * Within the scope of a single <code>Session</code> object, if a
+   * <code>Node</code> object has been acquired, any subsequent call of
+   * <code>getNode</code> reacquiring the same node must return a
+   * <code>Node</code> object reflecting the same state as the earlier
+   * <code>Node</code> object. Whether this object is actually the same
+   * <code>Node</code> instance, or simply one wrapping the same state, is up
+   * to the implementation.
+   * @param relPath The relative path of the node to retrieve.
+   * @return The node at <code>relPath</code>.
+   * @throws PathNotFoundException if no node exists at the specified path or the current <code>Session</code> does not read access to the node at the specified path.
+   * @throws RepositoryException If another error occurs.
+   */
+  getNode(relPath: string): Node;
+
+  /**
+   * Returns all child nodes of this node accessible through the current
+   * <code>Session</code>. Does <i>not</i> include properties of this
+   * <code>Node</code>. The same reacquisition semantics apply as with {@link
+   * #getNode(String)}. If this node has no accessible child nodes, then an
+   * empty iterator is returned.
+   * @return A <code>NodeIterator</code> over all child <code>Node</code>s of this <code>Node</code>.
+   * @throws RepositoryException if an error occurs.
+   */
+  getNodes(): NodeIterator;
+
+  /**
+   * Gets all child nodes of this node accessible through the current
+   * <code>Session</code> that match <code>namePattern</code>. The pattern may
+   * be a full name or a partial name with one or more wildcard characters
+   * ("<code>*</code>"), or a disjunction (using the "<code>|</code>"
+   * character to represent logical <code>OR</code>) of these. For example,
+   * <p>
+   * <code>N.getNodes("jcr:* | myapp:report | my doc")</code>
+   * <p>
+   * would return a <code>NodeIterator</code> holding all accessible child
+   * nodes of <code>N</code> that are either called '<code>myapp:report</code>',
+   * begin with the prefix '<code>jcr:</code>' or are called '<code>my
+   * doc</code>'.
+   * <p>
+   * The substrings within the pattern that are delimited by "<code>|</code>"
+   * characters and which may contain wildcard characters ("<code>*</code>")
+   * are called <i>globs</i>.
+   * <p>
+   * Note that leading and trailing whitespace around a glob is ignored, but
+   * whitespace within a disjunct forms part of the pattern to be matched.
+   * <p>
+   * The pattern is matched against the names (not the paths) of the immediate
+   * child nodes of this node.
+   * <p>
+   * If this node has no accessible matching child nodes, then an empty
+   * iterator is returned.
+   * <p>
+   * The same reacquisition semantics apply as with <code>{@link
+   * #getNode(String)}</code>.
+   * @param namePattern a name pattern.
+   * @return a <code>NodeIterator</code>.
+   * @throws RepositoryException if an unexpected error occurs.
+   */
+  getNodes(namePattern: string): NodeIterator;
+
+  /**
+   * Returns the property at <code>relPath</code> relative to
+   * <code>this</code> node. The same reacquisition semantics apply as with
+   * <code>{@link #getNode(String)}</code>.
+   * @param relPath The relative path of the property to retrieve.
+   * @return The property at <code>relPath</code>.
+   * @throws PathNotFoundException if no property exists at the specified path or if the current <p> <code>Session</code> does not have read access to the specified property.
+   * @throws RepositoryException If another error occurs.
+   */
+  getProperty(relPath: string): Property;
+
+  /**
+   * Returns all properties of this node accessible through the current
+   * <code>Session</code>. Does <i>not</i> include child <i>nodes</i> of this
+   * node. The same reacquisition semantics apply as with <code>{@link
+   * #getNode(String)}</code>. If this node has no accessible properties, then
+   * an empty iterator is returned.
+   * @return A <code>PropertyIterator</code>.
+   * @throws RepositoryException if an error occurs.
+   */
+  getProperties(): PropertyIterator;
+
+  /**
+   * Gets all properties of this node accessible through the current
+   * <code>Session</code> that match <code>namePattern</code>.
+   *
+   * <p>The pattern may
+   * be a full name or a partial name with one or more wildcard characters
+   * ("<code>*</code>"), or a disjunction (using the "<code>|</code>"
+   * character to represent logical <code>OR</code>) of these. For example,
+   * </p><p>
+   *   <code>N.getProperties("jcr:* | myapp:name | my doc")</code>
+   * </p><p>
+   * would return a <code>PropertyIterator</code> holding all accessible
+   * properties of <code>N</code> that are either called
+   * '<code>myapp:name</code>', begin with the prefix '<code>jcr:</code>' or
+   * are called '<code>my doc</code>'.
+   * </p><p>
+   * The substrings within the pattern that are delimited by "<code>|</code>"
+   * characters and which may contain wildcard characters ("<code>*</code>")
+   * are called <i>globs</i>.
+   * </p><p>
+   * Note that leading and trailing whitespace around a glob is ignored, but
+   * whitespace within a disjunct forms part of the pattern to be matched.
+   * </p><p>
+   * The pattern is matched against the names (not the paths) of the immediate
+   * child properties of this node.
+   * </p><p>
+   * If this node has no accessible matching properties, then an empty
+   * iterator is returned.
+   * </p><p>
+   * The same reacquisition semantics apply as with <code>{@link #getNode(String)}</code>.
+   * </p>
+   * @param namePattern a name pattern.
+   * @return a <code>PropertyIterator</code>.
+   * @throws RepositoryException if an unexpected error occurs.
+   */
+  getProperties(namePattern: string): PropertyIterator;
+
+  /**
+   * Returns the UUID of this node as recorded in this node's
+   * <code>jcr:uuid</code> property. This method only works on nodes of mixin
+   * node type <code>mix:referenceable</code>.
+   * <p>
+   * On nonreferenceable nodes, this method throws an <code>UnsupportedRepositoryOperationException</code>.
+   * To avoid throwing an exception to determine whether a node has a UUID, a
+   * call to {@link #isNodeType(String) isNodeType("mix:referenceable")} can
+   * be made.
+   * @return the UUID of this node.
+   * @throws UnsupportedRepositoryOperationException if this node nonreferenceable.
+   * @throws RepositoryException if another error occurs.
+   * @deprecated As of JCR 2.0, {@link #getIdentifier()} should be used instead.
+   */
+  getUUID(): string;
+
+  /**
+   * Returns the identifier of this node. Applies to both referenceable and
+   * non-referenceable nodes.
+   * <p>
+   * A <code>RepositoryException</code> is thrown if an error occurs.
+   * @return the identifier of this node.
+   * @throws RepositoryException if an error occurs.
+   * @since JCR 2.0
+   */
+  getIdentifier(): string;
+
+  /**
+   * Indicates whether a node exists at <code>relPath</code> Returns
+   * <code>true</code> if a node accessible through the current
+   * <code>Session</code> exists at <code>relPath</code> and
+   * <code>false</code> otherwise.
+   * @param relPath The path of a (possible) node.
+   * @return <code>true</code> if a node exists at <code>relPath</code>; <code>false</code> otherwise.
+   * @throws RepositoryException if an error occurs.
+   */
+  hasNode(relPath: string): boolean;
+
+  /**
+   * Indicates whether a property exists at <code>relPath</code> Returns
+   * <code>true</code> if a property accessible through the current
+   * <code>Session</code> exists at <code>relPath</code> and
+   * <code>false</code> otherwise.
+   * @param relPath The path of a (possible) property.
+   * @return <code>true</code> if a property exists at <code>relPath</code>; <code>false</code> otherwise.
+   * @throws RepositoryException if an error occurs.
+   */
+  hasProperty(relPath: string): boolean;
+
+  /**
+   * Indicates whether this node has child nodes. Returns <code>true</code> if
+   * this node has one or more child nodes accessible through the current
+   * <code>Session</code>; <code>false</code> otherwise.
+   * @return <code>true</code> if this node has one or more child nodes; <code>false</code> otherwise.
+   * @throws RepositoryException if an error occurs.
+   */
+  hasNodes(): boolean;
+
+  /**
+   * Indicates whether this node has properties. Returns <code>true</code> if
+   * this node has one or more properties accessible through the current
+   * <code>Session</code>; <code>false</code> otherwise.
+   * @return <code>true</code> if this node has one or more properties; <code>false</code> otherwise.
+   * @throws RepositoryException if an error occurs.
+   */
+  hasProperties(): boolean;
+
+  /**
+   * Returns the primary node type in effect for this node. Which
+   * <code>NodeType</code> is returned when this method is called on the root
+   * node of a workspace is up to the implementation.
+   * @return a <code>NodeType</code> object.
+   * @throws RepositoryException if an error occurs
+   */
+  getPrimaryNodeType(): NodeType;
+
+  /**
+   * Returns an array of <code>NodeType</code> objects representing the mixin
+   * node types in effect for this node. This includes only those mixin types
+   * explicitly assigned to this node. It does not include mixin types
+   * inherited through the addition of supertypes to the primary type
+   * hierarchy or through the addition of supertypes to the type hierarchy of
+   * any of the declared mixin types.
+   * @return an array of <code>NodeType</code> objects.
+   * @throws RepositoryException if an error occurs
+   */
+  getMixinNodeTypes(): NodeType;
+
+  /**
+   * Returns <code>true</code> if this node is of the specified primary node
+   * type or mixin type, or a subtype thereof. Returns <code>false</code>
+   * otherwise.
+   * <p>
+   * This method respects the effective node type of the node.
+   * @param nodeTypeName the name of a node type.
+   * @return <code>true</code> If this node is of the specified primary node type or mixin type, or a subtype thereof. Returns <code>false</code> otherwise.
+   * @throws RepositoryException if an error occurs.
+   */
+  isNodeType(nodeTypeName: string): boolean;
+
+  /**
+   * A constant for the JCR name <code>jcr:content</code>. This is the name of
+   * a child node  declared in {@link NodeType#NT_FILE nt:file} and a property
+   * declared in {@link javax.jcr.nodetype.NodeType#NT_LINKED_FILE
+   * nt:linkedFile}.
+   * @since JCR 2.0
+   */
+  JCR_CONTENT: string;
+
+  /**
+   * A constant for the node name <code>jcr:propertyDefinition</code> declared
+   * in {@link NodeType#NT_FILE nt:nodeType}.
+   * @since JCR 2.0
+   */
+  JCR_PROPERTY_DEFINITION: string;
+
+  /**
+   * A constant for the node name <code>jcr:childNodeDefinition</code>
+   * declared in {@link NodeType#NT_FILE nt:nodeType}.
+   * @since JCR 2.0
+   */
+  JCR_CHILD_NODE_DEFINITION: string;
+
+  /**
+   * A constant for the node name <code>jcr:rootVersion</code> declared in
+   * {@link NodeType#NT_VERSION_HISTORY nt:versionHistory}.
+   * @since JCR 2.0
+   */
+  JCR_ROOT_VERSION: string;
+
+  /**
+   * A constant for the node name <code>jcr:versionLabels</code> declared in
+   * {@link NodeType#NT_VERSION_HISTORY nt:versionHistory}.
+   * @since JCR 2.0
+   */
+  JCR_VERSION_LABELS: string;
+
+  /**
+   * A constant for the node name <code>jcr:frozenNode</code> declared in
+   * {@link NodeType#NT_VERSION nt:version}.
+   * @since JCR 2.0
+   */
+  JCR_FROZEN_NODE: string;
+};
+
+export = Node;

package/types/javax/jcr/Node/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  setProperty: function setProperty() {},
+  getNode: function getNode() {},
+  getNodes: function getNodes() {},
+  getProperty: function getProperty() {},
+  getProperties: function getProperties() {},
+  getUUID: function getUUID() {},
+  getIdentifier: function getIdentifier() {},
+  hasNode: function hasNode() {},
+  hasProperty: function hasProperty() {},
+  hasNodes: function hasNodes() {},
+  hasProperties: function hasProperties() {},
+  getPrimaryNodeType: function getPrimaryNodeType() {},
+  getMixinNodeTypes: function getMixinNodeTypes() {},
+  isNodeType: function isNodeType() {}
+};
+exports["default"] = _default;

package/{hidden → types}/javax/jcr/NodeIterator/index.d.ts

@@ -1,5 +1,5 @@
-import Node from "../Node";
-import RangeIterator from "../RangeIterator";
+import type Node from "../Node";
+import type RangeIterator from "../RangeIterator";
 
 /**
  * Allows easy iteration through a list of <code>Node</code>s with
@@ -7,13 +7,13 @@ import RangeIterator from "../RangeIterator";
  * <code>RangeIterator</code>.
   
     */
-interface NodeIterator {
+type NodeIterator = RangeIterator & {
   /**
    * Returns the next <code>Node</code> in the iteration.
    * @return the next <code>Node</code> in the iteration.
    * @throws java.util.NoSuchElementException if iteration has no more <code>Node</code>s.
    */
   nextNode(): Node;
-}
+};
 
-export default NodeIterator;
+export = NodeIterator;