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

package/server/XSLTUtil/index.d.ts

@@ -1,32 +1,3 @@
-/**
- * Gets the default XSL template for cleanup of HTML sources.
- *
- * <p>
- *    The template strips all &lt;div&gt;'s, &lt;spans&gt;'s and removes all inline styling, classes and attributes
- *    that is not mandatory or needed for WCAG purposes.
- * </p>
- * <p>
- *    <em>Note!</em> The template supports a <em>sub-set</em> of HTML elements (the presumed most commonly used elements).
- *    All unsupported elements are completely discarded (i.e. they will not be included at all in the transformation result).
- * </p>
- * @return the default cleanup template for HTML sources
- */
-export function getDefaultCleanHtmlTemplate(): string;
-
-/**
- * Transforms a HTML/XML source using a XSL template.
- *
- * <p>
- *    <em>Note!</em> The contents of the XSL Template is always handled as UTF-8.
- * </p>
- * @param aSource the source that should be transformed, HTML, XHTML or XML. Must not be null
- * @param aXslTemplate the UTF-8 XSL template; a sv:file Node, a sv:temporaryFile Node, a sv:link Node that targets a sv:file, a char array or a CharSequence (typically a String). Must not be null
- * @return the transformation result
- * @throws IOException if the transformation fails (e.g. the aSource is really bad/interpretable HTML or aXslTemplate is invalid XSL)
- * @throws RepositoryException if aNode-operation on aXslTemplate fails
- */
-export function transform(aSource: string, aXslTemplate: unknown): string;
-
 /**
  * XSLT utility for transforming XML/HTML using a XSL template.
  *
@@ -55,8 +26,39 @@ export function transform(aSource: string, aXslTemplate: unknown): string;
  * @author Magnus Lövgren
  * @since Sitevision 4.5
  */
-declare namespace xSLTUtil {
-  export { getDefaultCleanHtmlTemplate, transform };
+export interface XSLTUtil {
+  /**
+   * Gets the default XSL template for cleanup of HTML sources.
+   *
+   * <p>
+   *    The template strips all &lt;div&gt;'s, &lt;spans&gt;'s and removes all inline styling, classes and attributes
+   *    that is not mandatory or needed for WCAG purposes.
+   * </p>
+   * <p>
+   *    <em>Note!</em> The template supports a <em>sub-set</em> of HTML elements (the presumed most commonly used elements).
+   *    All unsupported elements are completely discarded (i.e. they will not be included at all in the transformation result).
+   * </p>
+   * @return the default cleanup template for HTML sources
+   */
+  getDefaultCleanHtmlTemplate(): string;
+
+  /**
+   * Transforms a HTML/XML source using a XSL template.
+   *
+   * <p>
+   *    <em>Note!</em> The contents of the XSL Template is always handled as UTF-8.
+   * </p>
+   * @param aSource the source that should be transformed, HTML, XHTML or XML. Must not be null
+   * @param aXslTemplate the UTF-8 XSL template; a sv:file Node, a sv:temporaryFile Node, a sv:link Node that targets a sv:file, a char array or a CharSequence (typically a String). Must not be null
+   * @return the transformation result
+   * @throws IOException if the transformation fails (e.g. the aSource is really bad/interpretable HTML or aXslTemplate is invalid XSL)
+   * @throws RepositoryException if aNode-operation on aXslTemplate fails
+   */
+  transform(aSource: string, aXslTemplate: unknown): string;
 }
 
-export default xSLTUtil;
+declare namespace XSLTUtil {}
+
+declare var xSLTUtil: XSLTUtil;
+
+export = xSLTUtil;

package/server/XmlParserUtil/index.d.ts

@@ -1,49 +1,6 @@
-import type { XmlElementHandler } from "../../types/senselogic/sitevision/api/xml/XmlElementHandler";
+import type XmlElementHandler from "../../types/senselogic/sitevision/api/xml/XmlElementHandler";
 
-import type { Node } from "../../types/javax/jcr/Node";
-
-/**
- * Parse a XML string.
- * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
- * @param aXml the UTF-8 XML string
- * @param aXmlElementHandler the XmlElementHandler
- * @throws XmlParserException if an error occurs while parsing the XML
- */
-export function parse(
-  aElementSelection: string,
-  aXml: string,
-  aXmlElementHandler: XmlElementHandler
-): void;
-
-/**
- * Parse a file containing XML encoded using UTF-8.
- * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
- * @param aXmlFile the file containing XML encoded using UTF-8 (sv:file or sv:temporaryFile)
- * @param aXmlElementHandler the XmlElementHandler
- * @throws RepositoryException if an error occurs while accessing the file
- * @throws XmlParserException if an error occurs while parsing the XML
- */
-export function parse(
-  aElementSelection: string,
-  aXmlFile: Node,
-  aXmlElementHandler: XmlElementHandler
-): void;
-
-/**
- * Parse a file containing XML encoded with the supplied charset.
- * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
- * @param aXmlFile the file containing XML encoded using supplied encoding (sv:file or sv:temporaryFile)
- * @param aCharset the character encoding of the the file content (an IllegalArgument will be thrown if aCharset can not be resolved as a java.nio.charset.Charset)
- * @param aXmlElementHandler the XmlElementHandler
- * @throws RepositoryException if an error occurs while accessing the file
- * @throws XmlParserException if an error occurs while parsing the XML
- */
-export function parse(
-  aElementSelection: string,
-  aXmlFile: Node,
-  aCharset: string,
-  aXmlElementHandler: XmlElementHandler
-): void;
+import type Node from "../../types/javax/jcr/Node";
 
 /**
  * Utility interface for parsing XML.
@@ -112,8 +69,53 @@ export function parse(
  * @author Niclas Hedlund
  * @since Sitevision 5.1
  */
-declare namespace xmlParserUtil {
-  export { parse };
+export interface XmlParserUtil {
+  /**
+   * Parse a XML string.
+   * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
+   * @param aXml the UTF-8 XML string
+   * @param aXmlElementHandler the XmlElementHandler
+   * @throws XmlParserException if an error occurs while parsing the XML
+   */
+  parse(
+    aElementSelection: string,
+    aXml: string,
+    aXmlElementHandler: XmlElementHandler
+  ): void;
+
+  /**
+   * Parse a file containing XML encoded using UTF-8.
+   * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
+   * @param aXmlFile the file containing XML encoded using UTF-8 (sv:file or sv:temporaryFile)
+   * @param aXmlElementHandler the XmlElementHandler
+   * @throws RepositoryException if an error occurs while accessing the file
+   * @throws XmlParserException if an error occurs while parsing the XML
+   */
+  parse(
+    aElementSelection: string,
+    aXmlFile: Node,
+    aXmlElementHandler: XmlElementHandler
+  ): void;
+
+  /**
+   * Parse a file containing XML encoded with the supplied charset.
+   * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
+   * @param aXmlFile the file containing XML encoded using supplied encoding (sv:file or sv:temporaryFile)
+   * @param aCharset the character encoding of the the file content (an IllegalArgument will be thrown if aCharset can not be resolved as a java.nio.charset.Charset)
+   * @param aXmlElementHandler the XmlElementHandler
+   * @throws RepositoryException if an error occurs while accessing the file
+   * @throws XmlParserException if an error occurs while parsing the XML
+   */
+  parse(
+    aElementSelection: string,
+    aXmlFile: Node,
+    aCharset: string,
+    aXmlElementHandler: XmlElementHandler
+  ): void;
 }
 
-export default xmlParserUtil;
+declare namespace XmlParserUtil {}
+
+declare var xmlParserUtil: XmlParserUtil;
+
+export = xmlParserUtil;

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

@@ -7,7 +7,7 @@
  * @since JCR 2.0
  * @since Sitevision 3.5
  */
-export type Binary = {
+type Binary = {
   /**
    * Returns an {@link InputStream} representation of this value. Each call to
    * <code>getStream()</code> returns a new stream. The API consumer is
@@ -21,26 +21,6 @@ export type Binary = {
    */
   getStream(): unknown;
 
-  /**
-   * Reads successive bytes from the specified <code>position</code> in this
-   * <code>Binary</code> into the passed byte array until either the byte
-   * array is full or the end of the <code>Binary</code> is encountered.
-   * <p>
-   * If {@link #dispose()} has been called on this <code>Binary</code>
-   * object, then this method will throw the runtime exception
-   * {@link java.lang.IllegalStateException}.
-   *
-   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
-   * @param b the buffer into which the data is read.
-   * @param position the position in this Binary from which to start reading bytes.
-   * @return the number of bytes read into the buffer, or -1 if there is no more data because the end of the Binary has been reached.
-   * @throws IOException if an I/O error occurs.
-   * @throws NullPointerException if b is null.
-   * @throws IllegalArgumentException if offset is negative.
-   * @throws RepositoryException if another error occurs.
-   */
-  read(b: unknown, position: number): number;
-
   /**
    * Returns the size of this <code>Binary</code> value in bytes.
    * <p>
@@ -61,3 +41,5 @@ export type Binary = {
     */
   dispose(): void;
 };
+
+export = Binary;

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

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _default = {
   getStream: function getStream() {},
-  read: function read() {},
   getSize: function getSize() {},
   dispose: function dispose() {}
 };

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

@@ -6,6 +6,8 @@
  * GuestCredentials} for examples of such a class.
   
     */
-export type Credentials = {
+type Credentials = {
   undefined;
 };
+
+export = Credentials;

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

@@ -6,6 +6,32 @@
  * <p><strong>Sitevision note:</strong> Unsupported operation</p>
   
     */
-export type ImportUUIDBehavior = {
+type ImportUUIDBehavior = {
   undefined;
+
+  /**
+ * 
+  
+    */
+  IMPORT_UUID_CREATE_NEW: number;
+
+  /**
+ * 
+  
+    */
+  IMPORT_UUID_COLLISION_REMOVE_EXISTING: number;
+
+  /**
+ * 
+  
+    */
+  IMPORT_UUID_COLLISION_REPLACE_EXISTING: number;
+
+  /**
+ * 
+  
+    */
+  IMPORT_UUID_COLLISION_THROW: number;
 };
+
+export = ImportUUIDBehavior;

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

@@ -1,14 +1,14 @@
-import type { Node } from "../Node";
-import Session from "../../../../server/Session";
+import type Node from "../Node";
+import { Session } from "../../../../server/Session";
 
-import type { ItemVisitor } from "../ItemVisitor";
+import type ItemVisitor from "../ItemVisitor";
 
 /**
  * The <code>Item</code> is the base interface of <code>{@link Node}</code> and
  * <code>{@link Property}</code>.
   
     */
-export type Item = {
+type Item = {
   /**
    * Returns the normalized absolute path to this item.
    * @return the normalized absolute path of this <code>Item</code>.
@@ -25,31 +25,6 @@ export type Item = {
    */
   getName(): string;
 
-  /**
-   * Returns the ancestor of this <code>Item</code> at the specified depth. An
-   * ancestor of depth <i>x</i> is the <code>Item</code> that is <i>x</i>
-   * levels down along the path from the root node to <i>this</i>
-   * <code>Item</code>. <ul> <li><i>depth</i> = 0 returns the root node of a
-   * workspace. <li><i>depth</i> = 1 returns the child of the root node along
-   * the path to <i>this</i> <code>Item</code>. <li><i>depth</i> = 2 returns
-   * the grandchild of the root node along the path to <i>this</i>
-   * <code>Item</code>. <li>And so on to <i>depth</i> = <i>n</i>, where
-   * <i>n</i> is the depth of <i>this</i> <code>Item</code>, which returns
-   * <i>this</i> <code>Item</code> itself. </ul>
-   * <p>
-   * If this node has more than one path (i.e., if it is a descendant of a
-   * shared node) then the path used to define the ancestor is
-   * implementaion-dependent.
-   *
-   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
-   * @param depth An integer, 0 &lt;= <i>depth</i> &lt;= <i>n</i> where <i>n</i> is the depth of <i>this</i> <code>Item</code>.
-   * @return The ancestor of this <code>Item</code> at the specified <code>depth</code>.
-   * @throws ItemNotFoundException if <i>depth</i> &lt; 0 or <i>depth</i> &gt; <i>n</i> where <i>n</i> is the is the depth of this item.
-   * @throws AccessDeniedException if the current session does not have sufficent access to retrieve the specified node.
-   * @throws RepositoryException if another error occurs.
-   */
-  getAncestor(depth: number): Item;
-
   /**
    * Returns the parent of this <code>Item</code>.
    * @return The parent of this <code>Item</code>.
@@ -59,28 +34,6 @@ export type Item = {
    */
   getParent(): Node;
 
-  /**
-   * Returns the depth of this <code>Item</code> in the workspace item graph.
-   * <ul> <li>The root node returns 0. <li>A property or child node of the
-   * root node returns 1. <li>A property or child node of a child node of the
-   * root returns 2. <li>And so on to <i>this</i> <code>Item</code>. </ul>
-   *
-   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
-   * @return The depth of this <code>Item</code> in the workspace item graph.
-   * @throws RepositoryException if an error occurs.
-   */
-  getDepth(): number;
-
-  /**
-   * Returns the <code>Session</code> through which this <code>Item</code> was
-   * acquired.
-   *
-   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
-   * @return the <code>Session</code> through which this <code>Item</code> was acquired.
-   * @throws RepositoryException if an error occurs.
-   */
-  getSession(): Session;
-
   /**
    * Indicates whether this <code>Item</code> is a <code>Node</code> or a
    * <code>Property</code>. Returns <code>true</code> if this
@@ -90,74 +43,6 @@ export type Item = {
    */
   isNode(): boolean;
 
-  /**
-   * Returns <code>true</code> if this is a new item, meaning that it exists
-   * only in transient storage on the <code>Session</code> and has not yet
-   * been saved. Within a transaction, <code>isNew</code> on an
-   * <code>Item</code> may return <code>false</code> (because the item has
-   * been saved) even if that <code>Item</code> is not in persistent storage
-   * (because the transaction has not yet been committed).
-   * <p>
-   * Note that if an item returns <code>true</code> on <code>isNew</code>,
-   * then by definition is parent will return <code>true</code> on
-   * <code>isModified</code>.
-   * <p>
-   * Note that in read-only implementations, this method will always return
-   * <code>false</code>.
-   *
-   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
-   * @return <code>true</code> if this item is new; <code>false</code> otherwise.
-   */
-  isNew(): boolean;
-
-  /**
-   * Returns <code>true</code> if this <code>Item</code> has been saved but
-   * has subsequently been modified through the current session and therefore
-   * the state of this item as recorded in the session differs from the state
-   * of this item as saved. Within a transaction, <code>isModified</code> on
-   * an <code>Item</code> may return <code>false</code> (because the
-   * <code>Item</code> has been saved since the modification) even if the
-   * modification in question is not in persistent storage (because the
-   * transaction has not yet been committed).
-   * <p>
-   * Note that in read-only implementations, this method will always return
-   * <code>false</code>.
-   *
-   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
-   * @return <code>true</code> if this item is modified; <code>false</code> otherwise.
-   */
-  isModified(): boolean;
-
-  /**
-   * Returns <code>true</code> if this <code>Item</code> object (the Java
-   * object instance) represents the same actual workspace item as the object
-   * <code>otherItem</code>.
-   * <p>
-   * Two <code>Item</code> objects represent the same workspace item if and
-   * only if all the following are true: <ul> <li>Both objects were acquired
-   * through <code>Session</code> objects that were created by the same
-   * <code>Repository</code> object.</li> <li>Both objects were acquired
-   * through <code>Session</code> objects bound to the same repository
-   * workspace.</li> <li>The objects are either both <code>Node</code> objects
-   * or both <code>Property</code> objects.</li> <li>If they are
-   * <code>Node</code> objects, they have the same identifier.</li> <li>If
-   * they are <code>Property</code> objects they have identical names and
-   * <code>isSame</code> is true of their parent nodes.</li> </ul> This method
-   * does not compare the <i>states</i> of the two items. For example, if two
-   * <code>Item</code> objects representing the same actual workspace item
-   * have been retrieved through two different sessions and one has been
-   * modified, then this method will still return <code>true</code> when
-   * comparing these two objects. Note that if two <code>Item</code> objects
-   * representing the same workspace item are retrieved through the
-   * <i>same</i> session they will always reflect the same state.
-   *
-   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
-   * @param otherItem the <code>Item</code> object to be tested for identity with this <code>Item</code>.
-   * @return <code>true</code> if this <code>Item</code> object and <code>otherItem</code> represent the same actual repository item; <code>false</code> otherwise.
-   * @throws RepositoryException if an error occurs.
-   */
-  isSame(otherItem: Item): boolean;
-
   /**
    * Accepts an <code>ItemVisitor</code>. Calls the appropriate
    * <code>ItemVisitor</code> <code>visit</code> method of the according to
@@ -236,3 +121,5 @@ export type Item = {
    */
   remove(): void;
 };
+
+export = Item;

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

@@ -7,14 +7,8 @@ exports["default"] = void 0;
 var _default = {
   getPath: function getPath() {},
   getName: function getName() {},
-  getAncestor: function getAncestor() {},
   getParent: function getParent() {},
-  getDepth: function getDepth() {},
-  getSession: function getSession() {},
   isNode: function isNode() {},
-  isNew: function isNew() {},
-  isModified: function isModified() {},
-  isSame: function isSame() {},
   accept: function accept() {},
   save: function save() {},
   refresh: function refresh() {},

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

@@ -1,6 +1,6 @@
-import type { Property } from "../Property";
+import type Property from "../Property";
 
-import type { Node } from "../Node";
+import type Node from "../Node";
 
 /**
  * This interface defines two signatures of the <code>visit</code> method; one
@@ -15,7 +15,7 @@ import type { Node } from "../Node";
  * through the tree performing some operation on each <code>Item</code>.
   
     */
-export type ItemVisitor = {
+type ItemVisitor = {
   /**
    * This method is called when the <code>ItemVisitor</code> is passed to the
    * <code>accept</code> method of a <code>Property</code>. If this method
@@ -34,3 +34,5 @@ export type ItemVisitor = {
    */
   visit(node: Node): void;
 };
+
+export = ItemVisitor;

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

@@ -4,51 +4,10 @@
  * Workspace#getNamespaceRegistry}. The namespace registry contains the default
  * prefixes of the registered namespaces. The namespace registry may contain
  * namespaces that are not used in repository content, and there may be
- * repository content with namespaces that are not included in the registry.A constant for the predefined namespace prefix "jcr".A constant for the predefined namespace prefix "nt".A constant for the predefined namespace prefix "mix".A constant for the predefined namespace prefix "xml".A constant for the predefined namespace prefix "" (the empty prefix).A constant for the predefined namespace mapped by default to the prefix
- * "jcr".A constant for the predefined namespace mapped by default to the prefix
- * "nt".A constant for the predefined namespace mapped by default to the prefix
- * "mix".A constant for the predefined namespace mapped by default to the prefix
- * "xml".A constant for the predefined namespace mapped by default to the prefix
- * "" (the empty prefix).
+ * repository content with namespaces that are not included in the registry.
  * @see Workspace#getNamespaceRegistry
  */
-export type NamespaceRegistry = {
-  /**
-   * Sets a one-to-one mapping between <code>prefix</code> and
-   * <code>uri</code> in the global namespace registry of this repository.
-   * <p>
-   * Assigning a new prefix to a URI that already exists in the namespace
-   * registry erases the old prefix. In general this can almost always be
-   * done, though an implementation is free to prevent particular remappings
-   * by throwing a <code>NamespaceException</code>.
-   * <p>
-   * On the other hand, taking a prefix that is already assigned to a URI and
-   * re-assigning it to a new URI in effect unregisters that URI. Therefore,
-   * the same restrictions apply to this operation as to
-   * <code>NamespaceRegistry.unregisterNamespace</code>.
-   *
-   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
-   * @param prefix The prefix to be mapped.
-   * @param uri The URI to be mapped.
-   * @throws NamespaceException If an attempt is made to re-assign a built-in prefix to a new URI or, to register a namespace with a prefix that begins with the characters "<code>xml</code>" (in any combination of case) or, An attempt is made to perform a prefix re-assignment that is forbidden for implementation-specific reasons.
-   * @throws UnsupportedRepositoryOperationException if this repository does not support namespace registry changes.
-   * @throws AccessDeniedException if the current session does not have sufficent access to register the namespace.
-   * @throws RepositoryException if another error occurs.
-   */
-  registerNamespace(prefix: string, uri: string): void;
-
-  /**
-   * Removes a namespace mapping from the registry.
-   *
-   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
-   * @param prefix The prefix of the mapping to be removed.
-   * @throws NamespaceException if an attempt is made to unregister a built-in namespace or a namespace that is not currently registered or a namespace whose unregsitration is forbidden for implementation-specific reasons.
-   * @throws UnsupportedRepositoryOperationException if this repository does not support namespace registry changes.
-   * @throws AccessDeniedException if the current session does not have sufficent access to unregister the namespace.
-   * @throws RepositoryException if another error occurs.
-   */
-  unregisterNamespace(prefix: string): void;
-
+type NamespaceRegistry = {
   /**
    * Returns an array holding all currently registered prefixes.
    * @return a string array.
@@ -80,4 +39,71 @@ export type NamespaceRegistry = {
    * @throws RepositoryException if another error occurs.
    */
   getPrefix(uri: string): string;
+
+  /**
+ * A constant for the predefined namespace prefix "jcr".
+  
+    */
+  PREFIX_JCR: string;
+
+  /**
+ * A constant for the predefined namespace prefix "nt".
+  
+    */
+  PREFIX_NT: string;
+
+  /**
+ * A constant for the predefined namespace prefix "mix".
+  
+    */
+  PREFIX_MIX: string;
+
+  /**
+ * A constant for the predefined namespace prefix "xml".
+  
+    */
+  PREFIX_XML: string;
+
+  /**
+ * A constant for the predefined namespace prefix "" (the empty prefix).
+  
+    */
+  PREFIX_EMPTY: string;
+
+  /**
+ * A constant for the predefined namespace mapped by default to the prefix
+ * "jcr".
+  
+    */
+  NAMESPACE_JCR: string;
+
+  /**
+ * A constant for the predefined namespace mapped by default to the prefix
+ * "nt".
+  
+    */
+  NAMESPACE_NT: string;
+
+  /**
+ * A constant for the predefined namespace mapped by default to the prefix
+ * "mix".
+  
+    */
+  NAMESPACE_MIX: string;
+
+  /**
+ * A constant for the predefined namespace mapped by default to the prefix
+ * "xml".
+  
+    */
+  NAMESPACE_XML: string;
+
+  /**
+ * A constant for the predefined namespace mapped by default to the prefix
+ * "" (the empty prefix).
+  
+    */
+  NAMESPACE_EMPTY: string;
 };
+
+export = NamespaceRegistry;

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

@@ -5,8 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  registerNamespace: function registerNamespace() {},
-  unregisterNamespace: function unregisterNamespace() {},
   getPrefixes: function getPrefixes() {},
   getURIs: function getURIs() {},
   getURI: function getURI() {},