@sitevision/api 1.0.20 → 1.1.0-alpha.2

package/hidden/senselogic/sitevision/api/xml/XmlElement/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * XML element.Gets the name of the elementGets the text content of the element.Gets an attribute value of the element.Check if a sub element with a specific name is available in the element.Gets the first sub element with a specific name of the element.Gets all sub element with a specific name of the element.Gets all sub elements of the element.
+ * @author Niclas Hedlund
+ * @see senselogic.sitevision.api.xml.XmlElementHandler
+ * @since Sitevision 5.1
+ */
+interface XmlElement {
+  /**
+   * Gets the name of the element
+   * @return the element name
+   */
+  getName(): string;
+
+  /**
+   * Gets the text content of the element.
+   * @return the text content of the element or null if no text content is available.
+   */
+  getText(): string;
+
+  /**
+   * Gets an attribute value of the element.
+   * @param aName the attribute name
+   * @return 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 aName name of the sub element of this element, must be non-null.
+   * @return 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 aName name of the sub element of this element, must be non-null.
+   * @return 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 aName name of the sub element of this element, must be non-null.
+   * @return the sub elements or an empty collection if no sub elements are available
+   */
+  getElements(aName: string): unknown;
+
+  /**
+   * Gets all sub elements of the element.
+   * @return a list of all sub elements
+   */
+  getElements(): unknown;
+}
+
+export default XmlElement;

package/hidden/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts

@@ -0,0 +1,17 @@
+import XmlElement from "../XmlElement";
+
+/**
+ * Handler that is used when parsing XML.Called when a element matching the selection has been parsed.
+ * @author Niclas Hedlund
+ * @see senselogic.sitevision.api.xml.XmlParserUtil
+ * @since Sitevision 5.1
+ */
+interface XmlElementHandler {
+  /**
+   * Called when a element matching the selection has been parsed.
+   * @param aXmlElement the element
+   */
+  handleElement(aXmlElement: XmlElement): void;
+}
+
+export default XmlElementHandler;

package/index.d.ts

@@ -6,31 +6,130 @@ import './common/i18n';
 import './common/router';
 import './common/events';
 
+import './server/AliasUtil';
 import './server/appData';
 import './server/appResource';
 import './server/ArchiveUtil';
+import './server/ArraysInstance';
 import './server/ArticleUtil';
+import './server/AuthenticationUtil';
+import './server/BookmarkUtil';
+import './server/BuddyIconRenderer';
+import './server/ClientUtil';
 import './server/CollaborationFactory';
 import './server/CollaborationGroupFolderUtil';
-import './server/CollaborationGroupState';
 import './server/CollaborationGroupTemplateUtil';
-import './server/CollaborationGroupType';
 import './server/CollaborationGroupUtil';
-import './server/CollaborationGroupWrapper';
+import './server/CollectionsInstance';
+import './server/ColorUtil';
+import './server/CompoundAndFilterBuilder';
+import './server/CompoundComparatorBuilder';
+import './server/CompoundOrFilterBuilder';
+import './server/ContentNodeUtil';
+import './server/CurrencyFactory';
 import './server/DateUtil';
+import './server/DecorationUtil';
+import './server/DeviceUtil';
+import './server/DirectoryUtil';
+import './server/DocTypeUtil';
+import './server/EndecUtil';
+import './server/ExtendedDismaxParserBuilder';
+import './server/FileIconRenderer';
+import './server/FileUtil';
+import './server/FilterBuilder';
+import './server/FolderUtil';
+import './server/FontUtil';
+import './server/FormatterBuilderFactory';
 import './server/globalAppData';
+import './server/HighlightBuilder';
 import './server/hooks';
+import './server/IconUtil';
+import './server/ImageLinkRenderer';
+import './server/ImageRenderer';
+import './server/ImageUtil';
+import './server/IndexingUtil';
+import './server/IndexUtil';
+import './server/InstanceCreatorUtil';
+import './server/InstanceTypeUtil';
+import './server/JwtUtil';
 import './server/LandingPageUtil';
-import './server/LocaleUtil';
+import './server/LinkPageUtil';
+import './server/LinkRenderer';
+import './server/LinkTargetBuilder';
+import './server/LinkValueBuilder';
+import './server/ListWrapper';
 import './server/LocaleUtil';
 import './server/LogUtil';
+import './server/MailBuilder';
+import './server/MailUtil';
+import './server/MathInstance';
+import './server/MessageDigesterFactory';
+import './server/MetadataDefinitionUtil';
+import './server/MetadataUtil';
+import './server/MimeTypeUtil';
+import './server/MonitorBuilder';
+import './server/NodeComparatorUtil';
+import './server/NodeFactoryUtil';
+import './server/NodeFilterUtil';
+import './server/NodeIteratorUtil';
+import './server/NodeResolverUtil';
+import './server/NodeTreeUtil';
+import './server/NodeTypeUtil';
 import './server/oauth2';
+import './server/OfflineVersionPropertyUtil';
+import './server/OnlineVersionPropertyUtil';
+import './server/OutputUtil';
+import './server/PageUtil';
+import './server/PermissionUtil';
 import './server/PortletContextUtil';
+import './server/PortletUtil';
+import './server/PrincipalUtil';
 import './server/privileged';
 import './server/Properties';
+import './server/PropertyUtil';
+import './server/PublishingUtil';
+import './server/QueryStringUtil';
+import './server/RedirectUtil';
+import './server/RelatedValueBuilder';
 import './server/Requester';
 import './server/ResourceLocatorUtil';
 import './server/RestApi';
+import './server/RestAppInvokerFactory';
+import './server/RoleAssignmentBuilder';
+import './server/RoleMatcherBuilder';
+import './server/RoleUtil';
+import './server/ScriptUtil';
+import './server/SearcherBuilder';
+import './server/SearchFactory';
+import './server/SearchUtil';
+import './server/Session';
+import './server/SimpleUserUtil';
+import './server/SiteCookieUtil';
+import './server/SortBuilder';
+import './server/SpellCheckBuilder';
+import './server/StandardParserBuilder';
 import './server/storage';
+import './server/StructureUtil';
+import './server/SubscriberUtil';
+import './server/SubscriptionUtil';
 import './server/SystemUserUtil';
+import './server/TagUtil';
+import './server/TemplateUtil';
+import './server/TemporaryFileNodeBuilder';
+import './server/TemporaryNodeBuilder';
+import './server/TextModuleRendererBuilder';
 import './server/TimestampUtil';
+import './server/TranslationUtil';
+import './server/TrashcanUtil';
+import './server/UserDataUtil';
+import './server/UserFactory';
+import './server/UserFieldRenderer';
+import './server/UserIdentityUtil';
+import './server/UserUtil';
+import './server/Utils';
+import './server/VelocityRenderer';
+import './server/VersionUtil';
+import './server/WebContentUtil';
+import './server/WebResourceFactory';
+import './server/XmlParserUtil';
+import './server/XSLTUtil';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "1.0.20",
+  "version": "1.1.0-alpha.2",
   "author": "Sitevision AB",
   "license": "MIT",
   "types": "index.d.ts",
@@ -13,7 +13,6 @@
     "url": "https://github.com/sitevision/sitevision-apps/issues"
   },
   "scripts": {
-    "prepare": "yarn build",
     "build": "rimraf dist/ && babel src --out-dir dist --copy-files && copyfiles package.json README.md dist/",
     "deploy": "yarn build && npm publish dist"
   },
@@ -25,6 +24,5 @@
   "publishConfig": {
     "access": "public",
     "directory": "dist"
-  },
-  "gitHead": "248d3b7c373c815deb730d304fa9a5a4cd46fc70"
+  }
 }

package/server/AliasUtil/index.d.ts

@@ -0,0 +1,25 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Gets the alias name for a given Node.
+ * @param aNode a Node that is the target of an alias, typically a sv:page, sv:article or sv:file
+ * @return the first found alias name for aNode, or null if aNode is null or no matching alias could be found
+ */
+export function getAliasName(aNode: Node): string;
+
+/**
+ * Alias utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getAliasUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Gets the alias name for a given Node.
+ * @author Magnus Lövgren
+ * @since Sitevision 2022.10.2
+ */
+declare namespace AliasUtil {
+  export { getAliasName };
+}
+
+export default AliasUtil;

package/server/AliasUtil/index.js

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

package/server/ArchiveUtil/index.d.ts

@@ -1,22 +1,76 @@
-import Node from '../../builtins/Node';
+import Node from "../../hidden/javax/jcr/Node";
 
 /**
-* Creates an archive as sub node of the specified parent.
-* @returns {Node} the newly created sv:archive node. 
-* @param {Node} aParent - the parent node of the sv:archive. May not be null
-* @param {string} aName - the name of the archive. May not be null
+ * <p>
+ *    Creates an archive as sub node of the specified parent.
+ * </p>
+ * <p>
+ *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}
+ *    or a {@code sv:collaborationGroupPage}.
+ *    If an other parent is specified a <code>ConstraintViolationException</code> is thrown.
+ * </p>
+ *
+ * <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to create archives and to do write operations on the parent node or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>
+ *
+ * <p>Note that a new archive inherits metadata and permissions from its parent.</p>
+ * @param aParent the parent node of the sv:archive. May not be <code>null</code>
+ * @param aName the name of the archive. May not be <code>null</code>
+ * @return the newly created sv:archive node.
+ * @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create an archive
+ * @throws RepositoryException if something else goes wrong
  */
 export function createArchive(aParent: Node, aName: string): Node;
 
 /**
-* Alters the name of an archive.
-* @param {Node} anArchive - the archive that should be renamed. May not be null
-* @param {string} aName - the new name of the archive. May not be null
-*/
+ * <p>Alters the name of an archive. If no archive is specified a <code>NullPointerException</code>
+ * is thrown. If the node is not a sv:archive an <code>IllegalArgumentException</code> is thrown.</p>
+ *
+ * <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to do write operations on the archive or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>
+ * @param anArchive the archive that should be renamed. May not be <code>null</code>
+ * @param aName the new name of the archive. May not be <code>null</code>
+ * @throws ConstraintViolationException if the current user is not authorized to alter the name of the archive
+ * @throws RepositoryException if something else goes wrong
+ */
 export function renameArchive(anArchive: Node, aName: string): void;
 
-declare namespace archiveUtil {
+/**
+ * Archive utility interface that handles nodes with primary node type <code>sv:archive</code>.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getArchiveUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p><p>
+ *    Creates an archive as sub node of the specified parent.
+ * </p>
+ * <p>
+ *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}
+ *    or a {@code sv:collaborationGroupPage}.
+ *    If an other parent is specified a <code>ConstraintViolationException</code> is thrown.
+ * </p>
+ *
+ * <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to create archives and to do write operations on the parent node or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>
+ *
+ * <p>Note that a new archive inherits metadata and permissions from its parent.</p><p>Alters the name of an archive. If no archive is specified a <code>NullPointerException</code>
+ * is thrown. If the node is not a sv:archive an <code>IllegalArgumentException</code> is thrown.</p>
+ *
+ * <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
+ *
+ * <p>The current user must be authorized to do write operations on the archive or
+ * a <code>ConstraintViolationException</code> will be thrown.</p>
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.2
+ */
+declare namespace ArchiveUtil {
   export { createArchive, renameArchive };
 }
 
-export default archiveUtil;
+export default ArchiveUtil;