@sitevision/api 1.0.8 → 1.0.9

package/builtins/Collection/index.d.ts

@@ -0,0 +1,3 @@
+interface Collection {}
+
+export default Collection;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "author": "Sitevision AB",
   "license": "MIT",
   "types": "index.d.ts",
@@ -26,5 +26,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "fc06935bd25748d28b264ee2b919d301536204d4"
+  "gitHead": "2b76525fb1911135b26fcb3930552ae3756862d2"
 }

package/server/VersionUtil/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * The offline version (i.e. the version used when editing in the Sitevision editor) marker
+ */
+export const OFFLINE_VERSION: number;
+/**
+ * The online version (i.e. the published version that visitors can access) marker
+ */
+export const ONLINE_VERSION: number;
+
+/**
+ * Gets current version
+ *
+ * @return {@link #OFFLINE_VERSION} or {@link #ONLINE_VERSION}. If current version is undeterminable, -1 is returned.
+ */
+export function getCurrentVersion(): number;
+
+declare namespace versionUtil {
+  export { OFFLINE_VERSION, ONLINE_VERSION, getCurrentVersion };
+}

package/server/VersionUtil/index.js

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

package/server/XSLTUtil/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 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 {string} 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 {string} aSource the source that should be transformed, HTML, XHTML or XML. Must not be null
+ * @param {any} 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 {string} 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: any): string;
+
+declare namespace xsltUtil {
+  export { getDefaultCleanHtmlTemplate, transform };
+}

package/server/XSLTUtil/index.js

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

package/server/XmlParserUtil/index.d.ts

@@ -0,0 +1,117 @@
+import Node from '../builtins/Node';
+import Collection from '../builtins/Collection';
+
+interface XmlElement {
+  /**
+   * Gets the name of the element
+   *
+   * @return {string} the element name
+   */
+  getName(): string;
+
+  /**
+   * Gets the text content of the element.
+   *
+   * @return {string} the text content of the element or null if no text content is available.
+   */
+  getText(): string;
+
+  /**
+   * Gets an attribute value of the element.
+   *
+   * @param {string} aName the attribute name
+   * @return {string} the attribute value or null if no value is associated with attribute
+   */
+  getAttribute(aName: string): string;
+
+  /**
+   * Check if a sub element with a specific name is available in the element.
+   *
+   * @param {string} aName name of the sub element of this element, must be non-null.
+   * @return {boolean} true if one or more sub elements with the specific name is available
+   */
+  hasElement(aName: string): boolean;
+
+  /**
+   * Gets the first sub element with a specific name of the element.
+   *
+   * @param {string} aName name of the sub element of this element, must be non-null.
+   * @return {XmlElement} the sub element or null if no sub element is found.
+   */
+  getElement(aName: string): XmlElement;
+
+  /**
+   * Gets all sub element with a specific name of the element.
+   *
+   * @param {string} aName name of the sub element of this element, must be non-null.
+   * @return {Collection<XmlElement>}the sub elements or an empty collection if no sub elements are available
+   */
+  getElements(aName: string): Collection<XmlElement>;
+
+  /**
+   * Gets all sub elements of the element.
+   *
+   * @return {Collection<XmlElement>} a list of all sub elements
+   */
+  getElements(): Collection<XmlElement>;
+}
+
+interface XmlElementHandler {
+  /**
+   * Called when a element matching the selection has been parsed.
+   *
+   * @param {XmlElement} aXmlElement the element
+   */
+  handleElement(aXmlElement: XmlElement): void;
+}
+
+/**
+ * Parse a XML string.
+ *
+ * @param {string} aElementSelection the elements in the XML that should be passed to the XmlElementHandler
+ * @param {string} aXml the UTF-8 XML string
+ * @param {XmlElementHandler} 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 {string} aElementSelection the elements in the XML that should be passed to the XmlElementHandler
+ * @param {Node} aXmlFile the file containing XML encoded using UTF-8 (sv:file or sv:temporaryFile)
+ * @param {XmlElementHandler} 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 {string} aElementSelection the elements in the XML that should be passed to the XmlElementHandler
+ * @param {Node} aXmlFile the file containing XML encoded using supplied encoding (sv:file or sv:temporaryFile)
+ * @param {string} 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 {XmlElementHandler} 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;
+
+declare namespace xmlParserUtil {
+  export { parse };
+}

package/server/XmlParserUtil/index.js

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