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

package/server/ScriptUtil/index.d.ts

@@ -225,7 +225,7 @@ export function getInstance(aQualifiedClassName: string): unknown;
  * @return a list containing the array elements. If the array is <code>null</code>, <code>null</code> is returned
  * @since Sitevision 2.6_06
  */
-export function getList(anArray: unknown): unknown[];
+export function getList(anArray: unknown): unknown;
 
 /**
  * Gets the date format pattern used in the Sitevision editor for a specific Locale.
@@ -389,7 +389,7 @@ export function joinCollection(
  */
 export function messageFormat(
   aMessageFormatPattern: string,
-  anArguments: unknown[]
+  anArguments: unknown
 ): string;
 
 /**
@@ -466,200 +466,10 @@ export function flatten(aString: string): string;
  * <p>
  *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getScriptUtil()}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Gets the boolean true primitive.Gets the boolean false primitive.Gets the null reference.Gets an object that is ensured not to be null.
- *
- * <p>
- *    This is a convenience method that can be used to avoid unnecessary subsequent method invocations in Velocity.
- * </p>
- *
- * <p>
- *    Velocity ignores <code>null</code> assignments and trying to assign a null reference will be logged as a WARNING message.
- *    A common strategy to work around this is to use the the Velocity <code>#if</code> clause. It allows for easy non-null
- *    checks - a <code>null</code> object is considered to be <code>false</code>. The downside with this strategy is that it
- *    requires two subsequent method invocations. That can of course be a really bad thing if the method does costly things. This method
- *    can be used to avoid such problems.
- * </p>
- *
- * <p>
- *    <strong>An example</strong><br>
- *    This Velocity code:
- * </p>
- * <pre><code>    #if ($anObject.getPersonOrNull())
- *       #set ($person = $anObject.getPersonOrNull())
- *       $person.getName()
- *       ...
- *    #end</code></pre>
- * Can be better utilized as:
- * <pre><code>    #set ($scriptUtil = ...)
- *
- *    #set ($person = $scriptUtil.getNonNull(${anObject.getPersonOrNull()}))
- *    #if ($person)
- *       $person.getName()
- *       ...
- *    #end
- * </code></pre>Gets an object that is ensured not to be null or a whitespace only string.
- *
- * <p>
- *    This is a convenience method that can be used to avoid unnecessary subsequent method invocations in Velocity.
- * </p>
- *
- * <p>
- *    Velocity ignores <code>null</code> assignments and trying to assign a null reference will be logged as a WARNING message.
- *    A common strategy to work around this is to use the the Velocity <code>#if</code> clause. It allows for easy non-null
- *    checks - a <code>null</code> object is considered to be <code>false</code>. The downside with this strategy is that it
- *    requires two subsequent method invocations. That can of course be a really bad thing if the method does costly things. This method
- *    can be used to avoid such problems.
- * </p>
- *
- * <p>
- *    <strong>An example</strong><br>
- *    This Velocity code:
- * </p>
- * <pre><code>    #if ($anObject.getPersonNameThatCanBeNullOrEmptyOrWhitespaceOnly())
- *       #set ($name = $anObject.getPersonNameThatCanBeNullOrEmptyOrWhitespaceOnly())
- *       #if ($name.trim().length() &gt; 0)
- *          &lt;p&gt;
- *             $name
- *          &lt;/p&gt;
- *       #end
- *    #end</code></pre>
- * Can be better utilized as:
- * <pre><code>    #set ($scriptUtil = ...)
- *
- *    #set ($name = $scriptUtil.getNonBlank(${anObject.getPersonNameThatCanBeNullOrEmptyOrWhitespaceOnly()}))
- *    #if ($name)
- *       &lt;p&gt;
- *          $name
- *       &lt;/p&gt;
- *    #end
- * </code></pre>
- *
- * <p>
- *    <strong>A typical example when using {@link senselogic.sitevision.api.property.PropertyUtil} and whitespace is an issue</strong><br>
- *    This Velocity code:
- * </p>
- * <pre><code>    #if ($propertyUtil.getString($theNode, 'thePropertyName'))
- *       #set ($propertyValue = $propertyUtil.getString($theNode, 'thePropertyName'))
- *       #if ($propertyValue.trim().length() &gt; 0)
- *          &lt;p&gt;
- *             $propertyValue
- *          &lt;/p&gt;
- *       #end
- *    #end</code></pre>
- * Can be better utilized as:
- * <pre><code>    #set ($scriptUtil = ...)
- *
- *    #set ($propertyValue = $scriptUtil.getNonBlank(${propertyUtil.getString($theNode, 'thePropertyName')}))
- *    #if ($propertyValue)
- *       &lt;p&gt;
- *          $propertyValue
- *       &lt;/p&gt;
- *    #end
- * </code></pre>Gets a default value if an object is null.Gets a default value if a string is null or whitespace only.Checks if a string is not null and not empty.Checks if a string is null or empty.Checks if a string is not null, not empty and not whitespace only.Checks if a string is null, empty or whitespace only.Gets a system property. This method invokes the getProperty method of the java.lang.System class, i.e <code>System.getProperty(String)</code>.
- *
- * <p>
- *    <strong>Important note!</strong><br>
- *    This method can be used to reveal potential sensitive information about the server.
- * </p>
- * <p>
- *    Allowed properties:
- * </p>
- * <ul>
- *    <li>"sitevision.version" (5.1)</li>
- *    <li>"sitevision.build" (5.1)</li>
- *    <li>"sitevision.environment.type" (5.2.1)</li>
- * </ul>
- * <p>
- *    A legacy mode that enables the API to return all properties can be enabled using the following system property:<br>
- *    <em>sitevision.api.scriptutil.legacy_system_properties=true</em>
- * </p>
- *
- * <p>
- * A tip if you need to do backward compatibility workarounds: The Sitevision version is accessible as a system property
- * named <em>sitevision.version</em>.
- * </p>Creates and returns an instance of a Java class.Methods that wraps an array in a <code>List</code>. Arrays are sub optimal in Velocity and JavaScript.Gets the date format pattern used in the Sitevision editor for a specific Locale.Methods that formats a date according to a <code>SimpleDateFormat</code> patternMethods that formats the date of a calendar according to a <code>SimpleDateFormat</code> patternMethods that returns a human presentable size with an appropriate byte-suffix (bytes/kB/MB/GB/TB).
- * <p>
- * Note! This method uses two significant digits and 1024 as base. Some examples:<br>
- * &nbsp;&nbsp; <code>126</code> -&gt; "<code>130 bytes</code>"<br>
- * &nbsp;&nbsp; <code>126975</code> -&gt; "<code>120 kB</code>"<br>
- * &nbsp;&nbsp; <code>456456456</code> -&gt; "<code>440 MB</code>"
- * </p>Method that converts a string to an int.Method that converts a string to a long.Method that converts a string to a double.Method that converts a string to a float.Method that returns true for values that can be interpreted as the true value.Method that returns true for values that can be interpreted as the false value.Joins the elements of an array to a single String.
- *
- * <p>Some examples:</p>
- * <pre><code>
- *    joinArray(["one", "two", "three"], ";")   -&gt; "one;two;three"
- *    joinArray(["a", myTwoInteger], "-")       -&gt; "a-2"
- *    joinArray(["", null, "three"], "-")       -&gt; "--three"
- *    joinArray([], "-")                        -&gt; ""
- *    joinArray(null, "-")                      -&gt; null
- * </code></pre>Joins the items of a Collection to a single String.
- *
- * <p>
- * For examples, see {@link #joinArray(Object[], String)}
- * </p>A utility method to get a formatted string based on a pattern and some pattern arguments.
- *
- * <p>
- *    <strong>A Velocity example:</strong>
- * </p>
- * <pre><code>
- *    #set ($instanceCreatorUtil = ...)
- *    #set ($scriptUtil = ...)
- *    #set ($searchPhrase = ...)
- *
- *    <em>## Determine pattern</em>
- *    #if ($language == 'sv')
- *       #set ($pattern = 'Din sökning {0} gav inga träffar')
- *    #else
- *       #set ($pattern = 'No hits for your search {0}')
- *    #end
- *
- *    <em>## Set up pattern argument(s)</em>
- *    #set ($argsList = $instanceCreatorUtil.list)
- *    $scriptUtil.swallow(${argsList.add($searchPhrase)})
- *
- *    <em>## Format and print result</em>
- *    &lt;p&gt;$scriptUtil.messageFormat($pattern, $argsList)&lt;/p&gt;
- * </code></pre>A utility method that can be used to prevent method invocation return values to be added to the Velocity output.
- *
- * <p>
- *    <strong>An example:</strong><br>This Velocity code:
- * </p>
- * <pre><code>
- *    #set ($myList = $instanceCreatorUtil.list)
- *    $myList.add("Magnus Lövgren")
- *    $myList.add("Mikael Wikblom")
- * </code></pre>
- * will result in the following Velocity output (the <code>add</code> method of <code>ArrayList</code> returns a <code>boolean</code>):
- * <pre><code>true true</code></pre>
- * <p>
- *    If a non-void method is invoked and the return value isn't handled, it will be part of the Velocity output.
- *    The <code>swallow</code> method can be used to prevent that (i.e. use it to "swallow" the result):
- * </p>
- * <pre><code>
- *    #set ($myList = $instanceCreatorUtil.list)
- *    $scriptUtil.swallow(${myList.add("Magnus Lövgren")})
- *    $scriptUtil.swallow(${myList.add("Mikael Wikblom")})</code></pre>
- * <p>
- *    <em>Note! The code above is just an example that illustrates a common problem. When creating and working with a
- *    List from Velocity, you should probably use a {@link senselogic.sitevision.api.script.factory.ListWrapper} instead</em>
- * </p>Removes leading and ending control characters (char &lt;= 32) from a String and returns the result (<code>null</code>
- * if the string is empty or <code>null</code>).
- *
- * <p>
- *    The String is trimmed using <code>String.trim()</code>
- * </p>Removes leading and ending control characters (char &lt;= 32) from a String and returns the result (empty String (<code>""</code>)
- * if the string is empty or <code>null</code>).
- *
- * <p>
- *    The String is trimmed using <code>String.trim()</code>
- * </p>Flattens a multi-lined string to a trimmed single-line string.
- *
- * <p>
- *    This method replaces all whitespace (space, line break and such) with a space, but will never add multiple spaces.
  * </p>
  * @author Magnus Lövgren
  */
-declare namespace ScriptUtil {
+declare namespace scriptUtil {
   export {
     getTrue,
     getFalse,
@@ -693,4 +503,4 @@ declare namespace ScriptUtil {
   };
 }
 
-export default ScriptUtil;
+export default scriptUtil;

package/server/ScriptUtil/index.js

@@ -5,29 +5,34 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
-  flatten: function flatten() {},
+  getTrue: function getTrue() {},
   getFalse: function getFalse() {},
-  getHumanPresentableSize: function getHumanPresentableSize() {},
-  getList: function getList() {},
-  getNonBlank: function getNonBlank() {},
-  getNonNull: function getNonNull() {},
   getNull: function getNull() {},
-  getTrue: function getTrue() {},
-  isBlank: function isBlank() {},
+  getNonNull: function getNonNull() {},
+  getNonBlank: function getNonBlank() {},
+  isNotEmpty: function isNotEmpty() {},
   isEmpty: function isEmpty() {},
-  isFalse: function isFalse() {},
   isNotBlank: function isNotBlank() {},
-  isNotEmpty: function isNotEmpty() {},
+  isBlank: function isBlank() {},
+  getSystemProperty: function getSystemProperty() {},
+  getInstance: function getInstance() {},
+  getList: function getList() {},
+  getFormatPattern: function getFormatPattern() {},
+  getDateAsString: function getDateAsString() {},
+  getCalendarAsString: function getCalendarAsString() {},
+  getHumanPresentableSize: function getHumanPresentableSize() {},
+  stringToInt: function stringToInt() {},
+  stringToLong: function stringToLong() {},
+  stringToDouble: function stringToDouble() {},
+  stringToFloat: function stringToFloat() {},
   isTrue: function isTrue() {},
+  isFalse: function isFalse() {},
   joinArray: function joinArray() {},
   joinCollection: function joinCollection() {},
   messageFormat: function messageFormat() {},
-  stringToDouble: function stringToDouble() {},
-  stringToFloat: function stringToFloat() {},
-  stringToInt: function stringToInt() {},
-  stringToLong: function stringToLong() {},
   swallow: function swallow() {},
+  trimToNull: function trimToNull() {},
   trimToEmpty: function trimToEmpty() {},
-  trimToNull: function trimToNull() {}
+  flatten: function flatten() {}
 };
 exports["default"] = _default;

package/server/SearchFactory/index.d.ts

@@ -5,7 +5,7 @@ import IndexUtil from "../IndexUtil";
 import IndexingUtil from "../IndexingUtil";
 import SearcherBuilder from "../SearcherBuilder";
 import SortBuilder from "../SortBuilder";
-import SearchSortField from "../../hidden/senselogic/sitevision/api/search/SearchSortField";
+
 import SearchUtil from "../SearchUtil";
 import SpellCheckBuilder from "../SpellCheckBuilder";
 import StandardParserBuilder from "../StandardParserBuilder";
@@ -65,7 +65,7 @@ export function getSortBuilder(): SortBuilder;
 export function getSearchSortField(
   aField: string,
   aIsAscending: boolean
-): SearchSortField;
+): unknown;
 
 /**
  * Convenience method to get a SearchUtil instance.
@@ -106,13 +106,11 @@ export function getMonitorBuilder(): MonitorBuilder;
  * <p>
  *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getSearchFactory()}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Gets a ExtendedDismaxParserBuilder instance.Gets a FilterBuilder instance.Gets a HighlightBuilder instance.Gets an IndexUtil instance.Gets an IndexingUtil instance.Gets a SearcherBuilder instance.Gets a SortBuilder instance.Convenience method to get a SearchSortField instance.Convenience method to get a SearchUtil instance.
- *
- * <em>A SearchUtil instance can also be retrieved via the {@link senselogic.sitevision.api.Utils#getSearchUtil()}</em>Gets a SpellCheckBuilder instance.Gets a StandardParserBuilder instance.Gets a QueryStringUtil instance.Gets a MonitorBuilder instance.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace SearchFactory {
+declare namespace searchFactory {
   export {
     getExtendedDismaxParserBuilder,
     getFilterBuilder,
@@ -130,4 +128,4 @@ declare namespace SearchFactory {
   };
 }
 
-export default SearchFactory;
+export default searchFactory;

package/server/SearchFactory/index.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getExtendedDismaxParserBuilder: function getExtendedDismaxParserBuilder() {},
+  getFilterBuilder: function getFilterBuilder() {},
+  getHighlightBuilder: function getHighlightBuilder() {},
+  getIndexUtil: function getIndexUtil() {},
+  getIndexingUtil: function getIndexingUtil() {},
+  getSearcherBuilder: function getSearcherBuilder() {},
+  getSortBuilder: function getSortBuilder() {},
+  getSearchSortField: function getSearchSortField() {},
+  getSearchUtil: function getSearchUtil() {},
+  getSpellCheckBuilder: function getSpellCheckBuilder() {},
+  getStandardParserBuilder: function getStandardParserBuilder() {},
+  getQueryStringUtil: function getQueryStringUtil() {},
+  getMonitorBuilder: function getMonitorBuilder() {}
+};
+exports["default"] = _default;

package/server/SearchUtil/index.d.ts

@@ -1,4 +1,4 @@
-import SearchResult from "../../hidden/senselogic/sitevision/api/search/SearchResult";
+import type { SearchResult } from "../../types/senselogic/sitevision/api/search/SearchResult";
 
 /**
  * <p>
@@ -38,7 +38,7 @@ import SearchResult from "../../hidden/senselogic/sitevision/api/search/SearchRe
  */
 export function search(
   aQuery: string,
-  sortFields: unknown[],
+  sortFields: unknown,
   aStartAtHit: number,
   aMaxHitsToReturn: number
 ): SearchResult;
@@ -64,7 +64,7 @@ export function search(
 export function search(
   aQuery: string,
   aFieldName: string,
-  sortFields: unknown[],
+  sortFields: unknown,
   aStartAtHit: number,
   aMaxHitsToReturn: number
 ): SearchResult;
@@ -117,48 +117,13 @@ export function search(
  * <p>
  *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getSearchUtil()}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p><p>
- *    Searches the default index using the <em>multi-field</em> ("edismax") parser.
- * </p>
- *
- * <p>
- *    Here is a simple example written in server-side javascript:
- * </p>
- * <pre><code>
- * var searchUtil = request.getAttribute("sitevision.utils").getSearchUtil();
- * var result = searchUtil.search("test*", null, 0, 10);
- * if (result.hasHits()) {
- *    out.println("Approximate hit count: " + result.getApproximateCount() + "&lt;br/&gt;");
- *    var hits = result.getHits();
- *    while (hits.hasNext()) {
- *       var hit = hits.next();
- *       out.print("&lt;a href=\"" + hit.getField('uri') + "\" title=\"\"&gt;");
- *       out.print(hit.getField('title'));
- *       out.print("&lt;/a&gt;");
- *       out.println("&lt;br/&gt;");
- *    }
- * } else {
- *    out.println("No hits for query = '" + result.getQuery() + "'&lt;br/&gt;");
- * }
- * </code></pre>
- *
- * <p>
- *    <em>Note! <code>aQuery</code> will be stripped from Local params,
- *    see {@link senselogic.sitevision.api.search.query.QueryStringUtil#stripLocalParams(String)}.</em>
- * </p><p>
- *    Searches the default index using the <em>single-field</em> ("standard") parser with a specified default field.
- * </p>
- *
- * <p>
- *    <em>Note! <code>aQuery</code> will be stripped from Local params,
- *    see {@link senselogic.sitevision.api.search.query.QueryStringUtil#stripLocalParams(String)}.</em>
  * </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6_06
  * @see senselogic.sitevision.api.search.searcher.Searcher
  */
-declare namespace SearchUtil {
+declare namespace searchUtil {
   export { search };
 }
 
-export default SearchUtil;
+export default searchUtil;

package/server/SearchUtil/index.js

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

package/server/SearcherBuilder/index.d.ts

@@ -1,11 +1,12 @@
-import Filter from "../../hidden/senselogic/sitevision/api/search/searcher/component/Filter";
-import Highlight from "../../hidden/senselogic/sitevision/api/search/searcher/component/Highlight";
-import Node from "../../hidden/javax/jcr/Node";
-import Parser from "../../hidden/senselogic/sitevision/api/search/searcher/component/Parser";
-import Sort from "../../hidden/senselogic/sitevision/api/search/searcher/component/Sort";
-import SpellCheck from "../../hidden/senselogic/sitevision/api/search/searcher/component/SpellCheck";
-import Monitor from "../../hidden/senselogic/sitevision/api/search/searcher/component/Monitor";
-import Searcher from "../../hidden/senselogic/sitevision/api/search/searcher/Searcher";
+import type { Filter } from "../../types/senselogic/sitevision/api/search/searcher/component/Filter";
+import type { Highlight } from "../../types/senselogic/sitevision/api/search/searcher/component/Highlight";
+import type { Node } from "../../types/javax/jcr/Node";
+import type { Parser } from "../../types/senselogic/sitevision/api/search/searcher/component/Parser";
+import type { Sort } from "../../types/senselogic/sitevision/api/search/searcher/component/Sort";
+import type { SpellCheck } from "../../types/senselogic/sitevision/api/search/searcher/component/SpellCheck";
+import type { Monitor } from "../../types/senselogic/sitevision/api/search/searcher/component/Monitor";
+import type { Searcher } from "../../types/senselogic/sitevision/api/search/searcher/Searcher";
+import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
 /**
  * Sets the filter component.
@@ -201,50 +202,11 @@ export function build(): Searcher;
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link senselogic.sitevision.api.search.SearchFactory#getSearcherBuilder()}.
  *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>Sets the filter component.
- *
- * <p>
- *    A <code>Filter</code> instance is created via the {@link FilterBuilder#build()} method.
- * </p>Sets the highlight component.
- *
- * <p>
- *    A <code>Highlight</code> instance is created via the {@link HighlightBuilder#build()} method.
- * </p>Sets the index to search in.
- *
- * <p>
- *    <strong>Note!</strong> If no index is set, the <code>Searcher</code> that is constructed will use
- *    the <em>default node index</em> (i.e. the main index with pages/images/files etc.).
  * </p>
- *
- * <p>
- *    <strong>Tip!</strong> Use the {@link senselogic.sitevision.api.search.index.IndexUtil} utility to get an index.
- * </p>Sets the parser component.
- *
- * <p>
- *    A <code>Parser</code> instance is created via the {@link ExtendedDismaxParserBuilder#build()} method
- *    or the {@link StandardParserBuilder#build()} method.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> If no Parser is set, the <code>Searcher</code> that is constructed will use a <em>default multi-field
- *    parser</em> (that can be constructed via {@link ExtendedDismaxParserBuilder}).
- * </p>Sets the sort component.
- *
- * <p>
- *    A <code>Sort</code> instance is created via the {@link SortBuilder#build()} method.
- * </p>Sets the spell check (suggestions/did-you-mean) component.
- *
- * <p>
- *    A <code>SpellCheck</code> instance is created via the {@link SpellCheckBuilder#build()} method.
- * </p>Sets the monitor component.
- *
- * <p>
- *    A <code>Monitor</code> instance is created via the {@link MonitorBuilder#build()} method.
- * </p>Creates a Searcher instance using currently specified components.
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace SearcherBuilder {
+declare namespace searcherBuilder {
   export {
     setFilter,
     setHighlight,
@@ -257,4 +219,4 @@ declare namespace SearcherBuilder {
   };
 }
 
-export default SearcherBuilder;
+export default searcherBuilder;

package/server/SearcherBuilder/index.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  setFilter: function setFilter() {},
+  setHighlight: function setHighlight() {},
+  setIndex: function setIndex() {},
+  setParser: function setParser() {},
+  setSort: function setSort() {},
+  setSpellCheck: function setSpellCheck() {},
+  setMonitor: function setMonitor() {},
+  build: function build() {}
+};
+exports["default"] = _default;