@sitevision/api 1.0.9 → 1.0.12

package/common/events/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Listen to a given event
+ *
+ * @param eventName The name of the event
+ * @param callback The callback to trigger for the given event
+ */
+export function on(eventName: string, callback: (options: any) => void): void;
+/**
+ * Emit a server side event
+ *
+ * Note! Server side only
+ *
+ * @param eventName The name of the event to emit
+ * @param options The options for the event
+ */
+export function emit(eventName: string, options: any): void;
+/**
+ * Trigger a client side event
+ *
+ * Note! Client side only
+ *
+ * @param eventName The name of the event to trigger
+ * @param options The options for the event
+ */
+export function trigger(eventName: string, options: any): void;
+
+declare namespace events {
+  export { on, emit, trigger };
+}
+
+export default events;

package/{server → common}/events/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _default = {
   on: function on() {},
-  emit: function emit() {}
+  emit: function emit() {},
+  trigger: function trigger() {}
 };
 exports["default"] = _default;

package/index.d.ts

@@ -4,6 +4,7 @@ import './client/toasts';
 import './common/app';
 import './common/i18n';
 import './common/router';
+import './common/events';
 
 import './server/appData';
 import './server/appResource';
@@ -17,7 +18,6 @@ import './server/CollaborationGroupType';
 import './server/CollaborationGroupUtil';
 import './server/CollaborationGroupWrapper';
 import './server/DateUtil';
-import './server/events';
 import './server/globalAppData';
 import './server/hooks';
 import './server/LandingPageUtil';

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@sitevision/api",
-  "version": "1.0.9",
+  "version": "1.0.12",
   "author": "Sitevision AB",
   "license": "MIT",
   "types": "index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/sitevision/siteivision-apps.git",
+    "url": "https://github.com/sitevision/sitevision-apps.git",
     "directory": "packages/api"
   },
   "bugs": {
-    "url": "https://github.com/sitevision/siteivision-apps/issues"
+    "url": "https://github.com/sitevision/sitevision-apps/issues"
   },
   "scripts": {
     "prepare": "yarn build",
@@ -26,5 +26,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "2b76525fb1911135b26fcb3930552ae3756862d2"
+  "gitHead": "d514eb8b9219d901e11cbda190e5812a5522fbdc"
 }

package/server/ArticleUtil/index.d.ts

@@ -24,38 +24,51 @@ export const PROPERTY_SHORTID: string;
 export const PROPERTY_VISIBLE_IN_MENUS: string;
 
 /**
-* Creates an article as sub node to a specified parent.
-* @returns {Node} a sv:article node corresponding to the newly created article. Will never return null 
-* @param {Node} aParent - the parent node of the article. May not be null
-* @param {Node} aTemplate - the template used for the article. May not be null
-* @param {string} aName - the name of the sv:article. May not be null
-  */
-export function createArticle(aParent: Node, aTemplate: Node, aName: string): Node;
+ * Creates an article as sub node to a specified parent.
+ * @returns {Node} a sv:article node corresponding to the newly created article. Will never return null
+ * @param {Node} aParent - the parent node of the article. May not be null
+ * @param {Node} aTemplate - the template used for the article. May not be null
+ * @param {string} aName - the name of the sv:article. May not be null
+ */
+export function createArticle(
+  aParent: Node,
+  aTemplate: Node,
+  aName: string
+): Node;
 
 /**
-* Creates an article with properties and web content.
-* @returns {Node} a sv:article node corresponding to the newly created article. Will never return null 
-* @param {Node} aParent - the parent node of the article. May not be null
-* @param {Node} aTemplate - the sv:template node to be used for the article. May not be null
-* @param {string} aName - the name of the sv:article. May not be null
-* @param {Map<string, any>} properties - the article properties. May be null
-* @param {Map<string, string>} content - a map containing the HTML content. The keys must correspond to layout names on the node. May be null
-*/
-export function createArticle(aParent: Node, aTemplate: Node, aName: string, properties: Map<string, any>, content: Map<string, string>): Node;
+ * Creates an article with properties and web content.
+ * @returns {Node} a sv:article node corresponding to the newly created article. Will never return null
+ * @param {Node} aParent - the parent node of the article. May not be null
+ * @param {Node} aTemplate - the sv:template node to be used for the article. May not be null
+ * @param {string} aName - the name of the sv:article. May not be null
+ * @param {Map<string, any>} properties - the article properties. May be null
+ * @param {Map<string, string>} content - a map containing the HTML content. The keys must correspond to layout names on the node. May be null
+ */
+export function createArticle(
+  aParent: Node,
+  aTemplate: Node,
+  aName: string,
+  properties: Map<string, any>,
+  content: Map<string, string>
+): Node;
 
 /**
-* Alters the name of an article.
-* @param {Node} anArticle - the article that should be renamed. May not be null
-* @param {string} aName - the new name of the article. May not be null
-*/
+ * Alters the name of an article.
+ * @param {Node} anArticle - the article that should be renamed. May not be null
+ * @param {string} aName - the new name of the article. May not be null
+ */
 export function renameArticle(anArticle: Node, aName: string): void;
 
 /**
-* Updates the properties of an article.
-* @param {Node} anArticle - the sv:article that will be altered. May not be null
-* @param {Map<string, any>} properties - the article properties. May not be null
-*/
-export function updateArticle(anArticle: Node, properties: Map<string, any>): void;
+ * Updates the properties of an article.
+ * @param {Node} anArticle - the sv:article that will be altered. May not be null
+ * @param {Map<string, any>} properties - the article properties. May not be null
+ */
+export function updateArticle(
+  anArticle: Node,
+  properties: Map<string, any>
+): void;
 
 declare namespace articleUtil {
   export {
@@ -79,5 +92,3 @@ declare namespace articleUtil {
 }
 
 export default articleUtil;
-
-PROPERTY_CREATED_BY

package/server/BookmarkUtil/index.d.ts

@@ -0,0 +1,95 @@
+import List from '../../builtins/List';
+import Node from '../../builtins/Node';
+
+/**
+ * Returns a list of <code>Node</code> objects for all bookmarks belonging to
+ * the current user regardless of category. This method only returns valid bookmarks
+ * (existing, published objects)
+ *
+ * @return {List<Node>} a list of bookmark nodes. Is never <code>null</code>
+ */
+export function getBookmarks(): List<Node>;
+
+/**
+ * Returns a list of <code>Node</code> objects corresponding to the bookmarks for
+ * the current user and the provided categories. This method only returns valid bookmarks
+ * (existing, published objects)
+ *
+ * @param {string} category a comma separated list of categories or <code>null</code> for no category
+ * @return {List<Node>} a list of bookmark nodes. Is never <code>null</code>
+ */
+export function getBookmarks(category: string): List<Node>;
+
+/**
+ * Adds a bookmark for the current user. This operation is synchronized
+ *
+ * @param {Node} bookmark   the node to be bookmarked must be a <code>sv:page</code>,
+ *                   <code>sv:sitePage</code> or an <code>sv:article</code>
+ * @param {string} categories a comma separated list of categories to where this bookmark belongs
+ * @throws IllegalArgumentException if <code>bookmark</code> is node of wrong type
+ * @throws NullPointerException     if <code>bookmark</code> is <code>null</code>
+ * @deprecated Use {@link #add(javax.jcr.Node)}, categories will be resolved from metadata.
+ */
+export function add(bookmark: Node, categories: string): void;
+
+/**
+ * Adds a bookmark for the current user. This operation is synchronized
+ *
+ * @param {Node} bookmark the node to be bookmarked must be a <code>sv:page</code>,
+ *                 <code>sv:sitePage</code> or an <code>sv:article</code>
+ * @throws IllegalArgumentException if bookmark is node of wrong type
+ * @throws NullPointerException     if <code>bookmark</code> is <code>null</code>
+ */
+export function add(bookmark: Node): void;
+
+/**
+ * Removes a bookmark for the current user. This operation is synchronized
+ *
+ * @param {Node} bookmark the bookmark
+ * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
+ */
+export function remove(bookmark: Node): void;
+
+/**
+ * Checks if the current user has the provided bookmark
+ *
+ * @param {Node} bookmark the bookmark
+ * @return if the user has provided bookmark
+ * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
+ */
+export function contains(bookmark: Node): boolean;
+
+/**
+ * Accesses a <code>boolean</code> indicating if the current site has a limited number of bookmarks.
+ *
+ * To get the max number of bookmarks, use {@link #getMaxNofBookmarks()}.
+ *
+ * @return {boolean} a <code>boolean</code> indicating if the current site has a limited number of bookmarks
+ * @throws NullPointerException if current site is indeterminable
+ * @see #getMaxNofBookmarks()
+ * @since Sitevision 2.6.1_01
+ */
+export function getLimitNofBookmarks(): boolean;
+
+/**
+ * Accessor to max number of bookmarks for the current site.
+ *
+ * @return {number} max number of bookmarks for the current site
+ * @throws NullPointerException if current site is indeterminable
+ * @see #getLimitNofBookmarks()
+ * @since Sitevision 2.6.1_01
+ */
+export function getMaxNofBookmarks(): number;
+
+declare namespace bookmarkUtil {
+  export {
+    getBookmarks,
+    add,
+    remove,
+    contains,
+    getLimitNofBookmarks,
+    getMaxNofBookmarks,
+  };
+}
+
+export default bookmarkUtil;

package/server/BookmarkUtil/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getBookmarks: function getBookmarks() {},
+  add: function add() {},
+  remove: function remove() {},
+  contains: function contains() {},
+  getLimitNofBookmarks: function getLimitNofBookmarks() {},
+  getMaxNofBookmarks: function getMaxNofBookmarks() {}
+};
+exports["default"] = _default;

package/server/ClientUtil/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Gets the Internet Protocol (IP) address of the client (or last proxy) that initiated currently executing request.
+ *
+ * @return {string} a <code>String</code> containing the IP address of the client that sent the request, or <code>null</code> if indeterminable
+ */
+export function getClientAddress(): string;
+
+declare namespace clientUtil {
+  export { getClientAddress };
+}
+
+export default clientUtil;

package/server/ClientUtil/index.js

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

package/server/ColorUtil/index.d.ts

@@ -0,0 +1,44 @@
+import Node from '../../builtins/Node';
+
+/**
+ * Gets the color with a given name
+ *
+ * @param {string} aColorName the name of the font
+ * @return {Node} the first color with name aColorName, or <code>null</code> if no color matches
+ */
+export function getColorByName(aColorName: string): Node;
+
+/**
+ * Gets the color with a given name with a fallback value if no color matches
+ *
+ * @param {string} aColorName the name of the font
+ * @param {Node} aDefaultValue fallback value
+ * @return {Node} the first color with name aColorName, or aDefaultValue if no color matches
+ */
+export function getColorByName(aColorName: string, aDefaultValue: Node): Node;
+
+/**
+ * Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]).
+ *
+ * @param {string} aHexString the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])
+ * @return {Node} the first color with the corresponding hex string, or <code>null</code> if no color matches
+ */
+export function getColorByHtmlHexValue(aHexString: string): Node;
+
+/**
+ * Gets the color with a given html hex value (i.e. a '#' followed by 6 characters [0-9,a-f,A-F]) with a fallback value if no color matches.
+ *
+ * @param {string} aHexString the hex string value of the font (starts with a '#' and ends with 6 characters [0-9,a-f,A-F])
+ * @param {Node} aDefaultValue fallback value
+ * @return {Node} the first color with the corresponding hex string, or aDefaultValue if no color matches
+ */
+export function getColorByHtmlHexValue(
+  aHexString: string,
+  aDefaultValue: Node
+): Node;
+
+declare namespace colorUtil {
+  export { getColorByName, getColorByHtmlHexValue };
+}
+
+export default colorUtil;

package/server/ColorUtil/index.js

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

package/server/events/index.d.ts

@@ -1,8 +0,0 @@
-export function on(eventName: string, callback: (options: any) => void): void;
-export function emit(eventName: string, options: any): void;
-
-declare namespace events {
-  export { on, emit };
-}
-
-export default events;