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

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

@@ -0,0 +1,74 @@
+import type Value from "../Value";
+
+import type Binary from "../Binary";
+import type Node from "../Node";
+
+/**
+ * The <code>ValueFactory</code> object provides methods for the creation Value
+ * objects that can then be used to set properties.
+ * @since Sitevision 3.0
+ */
+type ValueFactory = {
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#STRING} with
+   * the specified <code>value</code>.
+   * @param value a <code>String</code>
+   * @return a <code>Value</code> of {@link PropertyType#STRING}
+   */
+  createValue(value: string): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#LONG} with the
+   * specified <code>value</code>.
+   * @param value a <code>long</code>
+   * @return a <code>Value</code> of {@link PropertyType#LONG}
+   */
+  createValue(value: number): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#DOUBLE} with
+   * the specified <code>value</code>.
+   * @param value a <code>double</code>
+   * @return a <code>Value</code> of {@link PropertyType#DOUBLE}
+   */
+  createValue(value: number): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#DECIMAL} with
+   * the specified <code>value</code>.
+   * @param value a <code>double</code>
+   * @return a <code>Value</code> of {@link PropertyType#DECIMAL}
+   * @since JCR 2.0
+   */
+  createValue(value: unknown): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#BOOLEAN} with
+   * the specified <code>value</code>.
+   * @param value a <code>boolean</code>
+   * @return a <code>Value</code> of {@link PropertyType#BOOLEAN}
+   */
+  createValue(value: boolean): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#DATE} with the
+   * specified <code>value</code>.
+   * @param value a <code>Calendar</code>
+   * @return a <code>Value</code> of {@link PropertyType#DATE}
+   * @throws IllegalArgumentException if the specified <code>value</code> cannot be expressed in the ISO 8601-based format defined in the JCR 2.0 specification and the implementation does not support dates incompatible with that format.
+   */
+  createValue(value: unknown): Value;
+
+  /**
+   * Returns a <code>Value</code> object of {@link PropertyType#REFERENCE}
+   * that holds the identifier of the specified <code>Node</code>. This
+   * <code>Value</code> object can then be used to set a property that will be
+   * a reference to that <code>Node</code>.
+   * @param value a <code>Node</code>
+   * @return a <code>Value</code> of {@link PropertyType#REFERENCE}
+   * @throws RepositoryException if the specified <code>Node</code> is not referenceable, the current <code>Session</code> is no longer active, or another error occurs.
+   */
+  createValue(value: Node): Value;
+};
+
+export = ValueFactory;

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

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

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

@@ -0,0 +1,190 @@
+import { Session } from "../../../../server/Session";
+
+import type Version from "../version/Version";
+import type LockManager from "../lock/LockManager";
+import type QueryManager from "../query/QueryManager";
+import type NamespaceRegistry from "../NamespaceRegistry";
+import type NodeTypeManager from "../nodetype/NodeTypeManager";
+import type ObservationManager from "../observation/ObservationManager";
+import type VersionManager from "../version/VersionManager";
+
+/**
+ * A <code>Workspace</code> object represents a view onto a persitent workspace
+ * within a repository. This view is defined by the authorization settings of
+ * the <code>Session</code> object associated with the <code>Workspace</code>
+ * object. Each <code>Workspace</code> object is associated one-to-one with a
+ * <code>Session</code> object. The <code>Workspace</code> object can be
+ * acquired by calling <code>{@link Session#getWorkspace()}</code> on the
+ * associated <code>Session</code> object.
+  
+    */
+type Workspace = {
+  /**
+   * Returns the <code>Session</code> object through which this
+   * <code>Workspace</code> object was acquired.
+   * @return a <code>{@link Session}</code> object.
+   */
+  getSession(): Session;
+
+  /**
+   * Returns the name of the actual persistent workspace represented by this
+   * <code>Workspace</code> object. This the name used in
+   * <code>Repository.login</code>.
+   * @return the name of this workspace.
+   */
+  getName(): string;
+
+  /**
+   * Returns the <code>QueryManager</code> object, through search methods are
+   * accessed.
+   * @return the <code>QueryManager</code> object.
+   * @throws RepositoryException if an error occurs.
+   */
+  getQueryManager(): QueryManager;
+
+  /**
+   * Returns the <code>NamespaceRegistry</code> object, which is used to
+   * access the mapping between prefixes and namespaces. In level 2
+   * repositories the <code>NamespaceRegistry</code> can also be used to
+   * change the namespace mappings.
+   * @return the <code>NamespaceRegistry</code>.
+   * @throws RepositoryException if an error occurs.
+   */
+  getNamespaceRegistry(): NamespaceRegistry;
+
+  /**
+   * Returns the <code>NodeTypeManager</code> through which node type
+   * information can be queried. There is one node type registry per
+   * repository, therefore the <code>NodeTypeManager</code> is not
+   * workspace-specific; it provides introspection methods for the global,
+   * repository-wide set of available node types. In repositories that support
+   * it, the <code>NodeTypeManager</code> can also be used to register new
+   * node types.
+   * @return a <code>NodeTypeManager</code> object.
+   * @throws RepositoryException if an error occurs.
+   */
+  getNodeTypeManager(): NodeTypeManager;
+
+  /**
+   * Returns a string array containing the names of all workspaces in this
+   * repository that are accessible to this user, given the
+   * <code>Credentials</code> that were used to get the <code>Session</code>
+   * to which this <code>Workspace</code> is tied.
+   * <p>
+   * In order to access one of the listed workspaces, the user performs
+   * another {@link Repository#login}, specifying the name of the desired
+   * workspace, and receives a new <code>Session</code> object.
+   * @return string array of names of accessible workspaces.
+   * @throws RepositoryException if an error occurs
+   */
+  getAccessibleWorkspaceNames(): string;
+
+  /**
+   * A constant for the name of the workspace root node.
+   * @since JCR 2.0
+   */
+  NAME_WORKSPACE_ROOT: string;
+
+  /**
+   * A constant for the absolute path of the workspace root node.
+   * @since JCR 2.0
+   */
+  PATH_WORKSPACE_ROOT: string;
+
+  /**
+   * A constant for the name of the system node.
+   * @since JCR 2.0
+   */
+  NAME_SYSTEM_NODE: string;
+
+  /**
+   * A constant for the absolute path of the system node.
+   * @since JCR 2.0
+   */
+  PATH_SYSTEM_NODE: string;
+
+  /**
+   * A constant for the name of the node type definition storage node.
+   * @since JCR 2.0
+   */
+  NAME_NODE_TYPES_NODE: string;
+
+  /**
+   * A constant for the absolute path of the node type definition storage
+   * node.
+   * @since JCR 2.0
+   */
+  PATH_NODE_TYPES_NODE: string;
+
+  /**
+   * A constant for the name of the version storage node.
+   * @since JCR 2.0
+   */
+  NAME_VERSION_STORAGE_NODE: string;
+
+  /**
+   * A constant for the absolute path of the version storage node.
+   * @since JCR 2.0
+   */
+  PATH_VERSION_STORAGE_NODE: string;
+
+  /**
+   * A constant for the name of the activities node.
+   * @since JCR 2.0
+   */
+  NAME_ACTIVITIES_NODE: string;
+
+  /**
+   * A constant for the absolute path of the activities node.
+   * @since JCR 2.0
+   */
+  PATH_ACTIVITIES_NODE: string;
+
+  /**
+   * A constant for the name of the configurations node.
+   * @since JCR 2.0
+   */
+  NAME_CONFIGURATIONS_NODE: string;
+
+  /**
+   * A constant for the absolute path of the configurations node.
+   * @since JCR 2.0
+   */
+  PATH_CONFIGURATIONS_NODE: string;
+
+  /**
+   * A constant for the name of the unfiled storage node.
+   * @since JCR 2.0
+   */
+  NAME_UNFILED_NODE: string;
+
+  /**
+   * A constant for the absolute path of the unfiled storage node.
+   * @since JCR 2.0
+   */
+  PATH_UNFILED_NODE: string;
+
+  /**
+   * A constant for the name of the <code>jcr:xmltext</code> node produced on
+   * {@link #importXML}.
+   * @since JCR 2.0
+   */
+  NAME_JCR_XMLTEXT: string;
+
+  /**
+   * A constant for the name of the <code>jcr:xmlcharacters</code> property
+   * produced on {@link #importXML}.
+   * @since JCR 2.0
+   */
+  NAME_JCR_XMLCHARACTERS: string;
+
+  /**
+   * A constant for the relative path from the node representing the imported
+   * XML element of the <code>jcr:xmlcharacters</code> property produced on
+   * {@link #importXML}.
+   * @since JCR 2.0
+   */
+  RELPATH_JCR_XMLCHARACTERS: string;
+};
+
+export = Workspace;

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

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getSession: function getSession() {},
+  getName: function getName() {},
+  getQueryManager: function getQueryManager() {},
+  getNamespaceRegistry: function getNamespaceRegistry() {},
+  getNodeTypeManager: function getNodeTypeManager() {},
+  getAccessibleWorkspaceNames: function getAccessibleWorkspaceNames() {}
+};
+exports["default"] = _default;

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

@@ -1,4 +1,4 @@
-import Node from "../../Node";
+import type Node from "../../Node";
 
 /**
  * Represents a lock placed on an item.
@@ -6,7 +6,7 @@ import Node from "../../Node";
  * <p><strong>Sitevision note:</strong> Unsupported operation</p>
   
     */
-interface Lock {
+type Lock = {
   /**
    * Returns the value of the <code>jcr:lockOwner</code> property. This is
    * either the client supplied owner information (see {@link
@@ -101,6 +101,6 @@ interface Lock {
    * @throws RepositoryException if another error occurs.
    */
   refresh(): void;
-}
+};
 
-export default Lock;
+export = Lock;

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

@@ -1,4 +1,4 @@
-import Lock from "../Lock";
+import type Lock from "../Lock";
 
 /**
  * This interface encapsulates methods for the management of locks.
@@ -7,7 +7,7 @@ import Lock from "../Lock";
  * @since Sitevision 3.5
  * @since JCR 2.0
  */
-interface LockManager {
+type LockManager = {
   /**
    * Adds the specified lock token to the current <code>Session</code>.
    * Holding a lock token makes the current <code>Session</code> the owner of
@@ -152,6 +152,6 @@ interface LockManager {
    * @throws RepositoryException if another error occurs.
    */
   unlock(absPath: string): void;
-}
+};
 
-export default LockManager;
+export = LockManager;

package/types/javax/jcr/nodetype/ItemDefinition/index.d.ts

@@ -0,0 +1,29 @@
+import type NodeType from "../NodeType";
+
+/**
+ * Superclass of {@link NodeDefinition} and {@link PropertyDefinition}.
+  
+    */
+type ItemDefinition = {
+  /**
+   * Reports whether the child item is protected. In level 2 implementations,
+   * a protected item is one that cannot be removed (except by removing its
+   * parent) or modified through the the standard write methods of this API
+   * (that is, <code>Item.remove</code>, <code>Node.addNode</code>,
+   * <code>Node.setProperty</code> and <code>Property.setValue</code>).
+   * <p>
+   * A protected node may be removed or modified (in a level 2
+   * implementation), however, through some mechanism not defined by this
+   * specification or as a side-effect of operations other than the standard
+   * write methods of the API.
+   * <p>
+   * In implementations that support node type registration, if this
+   * <code>ItemDefinition</code> object is actually a newly-created empty
+   * <code>PropertyDefinitionTemplate</code> or <code>NodeDefinitionTemplate</code>,
+   * then this method will return <code>false</code>.
+   * @return a <code>boolean</code>.
+   */
+  isProtected(): boolean;
+};
+
+export = ItemDefinition;

package/types/javax/jcr/nodetype/ItemDefinition/index.js

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

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

@@ -1,13 +1,13 @@
-import NodeType from "../NodeType";
+import type NodeType from "../NodeType";
 
-import ItemDefinition from "../ItemDefinition";
+import type ItemDefinition from "../ItemDefinition";
 
 /**
  * A node definition. Used in node type definitions.
  * @see NodeType#getChildNodeDefinitions
  * @see javax.jcr.Node#getDefinition
  */
-interface NodeDefinition {
+type NodeDefinition = ItemDefinition & {
   /**
    * Gets the minimum set of primary node types that the child node must have.
    * Returns an array to support those implementations with multiple
@@ -97,6 +97,6 @@ interface NodeDefinition {
    * @return a boolean.
    */
   allowsSameNameSiblings(): boolean;
-}
+};
 
-export default NodeDefinition;
+export = NodeDefinition;

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

@@ -1,4 +1,4 @@
-import NodeDefinition from "../NodeDefinition";
+import type NodeDefinition from "../NodeDefinition";
 
 /**
  * The <code>NodeDefinitionTemplate</code> interface extends
@@ -14,7 +14,7 @@ import NodeDefinition from "../NodeDefinition";
  * <p><strong>Sitevision note:</strong> Unsupported operation</p>
  * @since JCR 2.0
  */
-interface NodeDefinitionTemplate {
+type NodeDefinitionTemplate = NodeDefinition & {
   /**
    * Sets the name of the node. This must be a JCR name in either
    * qualified or expanded form.
@@ -68,6 +68,6 @@ interface NodeDefinitionTemplate {
    * @param allowSameNameSiblings a <code>boolean</code>.
    */
   setSameNameSiblings(allowSameNameSiblings: boolean): void;
-}
+};
 
-export default NodeDefinitionTemplate;
+export = NodeDefinitionTemplate;