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

package/{hidden → types}/senselogic/sitevision/api/script/RequesterChainable/index.d.ts

@@ -1,59 +1,14 @@
+import Requester from "../../../../../../server/Requester";
+
 /**
- * The chainable result of a {@link Requester} invocation.Invoked when a {@link Requester} was successfully executed.
- *
- * <p>
- *    The callback is invoked with three optional arguments:
- * </p>
- * <ol>
- *    <li>
- *       First argument is the <em>result</em> - typically a JSON object.
- *    </li>
- *    <li>
- *       Second argument [@since Sitevision 4.2.3] is the <em>statusCode</em> - the http response status code.
- *    </li>
- *    <li>
- *       Third argument [@since Sitevision 4.5.1] is the <em>headers</em> - the http response headers.
- *    </li>
- * </ol>Invoked when a {@link Requester} was unsuccessfully executed.
- *
- * <p>
- *    The callback is invoked with two optional arguments:
- * </p>
- * <ol>
- *    <li>
- *       First argument is the <em>message</em> - a string that describes the fail reason.
- *    </li>
- *    <li>
- *       Second argument [@since Sitevision 4.2.2] is the <em>status</em> - an object with four properties:
- *       <ul>
- *          <li>
- *             <em>statusCode</em> - the http response status code.<br>
- *             The value will typically be an official/RFC-standardized code
- *             (such as 400, 401, 404, 500 etc), but it can also be an unofficial/non-standardized one.
- *             A connection timeout will have value 1000 and the value will be 1001 if the connection pool is full/exhausted.
- *             An unknown/unspecified error will have value -1, such as unknown host, illegal url or network connection errors.
- *          </li>
- *          <li>
- *             <em>statusMessage</em> - the http response status code description.
- *          </li>
- *          <li>
- *             <em>body</em> [@since Sitevision 4.2.3] - the potential JSON body of the response.
- *             <em>(Note! Will only be available for responses that specifies application/json in the Content-Type header)</em>
- *          </li>
- *          <li>
- *             <em>headers</em> [@since Sitevision 4.5.1] - the potential response headers.
- *             <em>(Note! Will only be available for valid error responses, not for request errors, JSON parse errors or such)</em>
- *          </li>
- *       </ul>
- *    </li>
- * </ol>
+ * The chainable result of a {@link Requester} invocation.
  * @param <O> script object
  * @param <F> script function
  * @author Magnus Lövgren
  * @since Sitevision 4.2
  * @see Requester
  */
-interface RequesterChainable {
+export type RequesterChainable = {
   /**
    * Invoked when a {@link Requester} was successfully executed.
    *
@@ -114,6 +69,4 @@ interface RequesterChainable {
    * @return a chainable requester
    */
   fail(aCallback: unknown): RequesterChainable;
-}
-
-export default RequesterChainable;
+};

package/types/senselogic/sitevision/api/script/RequesterChainable/index.js

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

package/{hidden → types}/senselogic/sitevision/api/script/app/RestAppInvoker/index.d.ts

@@ -132,38 +132,6 @@
  * <p>
  *    An instance of the Sitevision class implementing this interface can be obtained via a method in
  *    {@link RestAppInvokerFactory}.
- * </p>Executes GET for a route of the RESTApp.
- *
- * <p>
- *    <em>REST hint!</em> A <em>get</em> typically indicates a <em>read</em> of something.
- * </p>Executes GET with options for a route of the RESTApp.
- *
- * <p>
- *    <em>REST hint!</em> A <em>get</em> typically indicates a <em>read</em> of something.
- * </p>Executes POST for a route of the RESTApp.
- *
- * <p>
- *    <em>REST hint!</em> A <em>post</em> typically indicates the <em>creation</em> of something.
- * </p>Executes POST with options for a route of the RESTApp.
- *
- * <p>
- *    <em>REST hint!</em> A <em>post</em> typically indicates the <em>creation</em> of something.
- * </p>Executes PUT for a route of the RESTApp.
- *
- * <p>
- *    <em>REST hint!</em> A <em>put</em> typically indicates an <em>update</em> of something.
- * </p>Executes PUT with options for a route of the RESTApp.
- *
- * <p>
- *    <em>REST hint!</em> A <em>put</em> typically indicates an <em>update</em> of something.
- * </p>Executes DELETE for a route of the RESTApp.
- *
- * <p>
- *    <em>REST hint!</em> A <em>delete</em> typically indicates a <em>removal</em> of something.
- * </p>Executes DELETE with options for a route of the RESTApp.
- *
- * <p>
- *    <em>REST hint!</em> A <em>delete</em> typically indicates a <em>removal</em> of something.
  * </p>
  * @param <O> script object
  * @author Magnus Lövgren
@@ -171,7 +139,7 @@
  * @see senselogic.sitevision.api.script.RestApi
  * @see senselogic.sitevision.api.script.Requester
  */
-interface RestAppInvoker {
+export type RestAppInvoker = {
   /**
    * Executes GET for a route of the RESTApp.
    *
@@ -267,6 +235,4 @@ interface RestAppInvoker {
    * @return a script object representing the response (properties: headers, statusCode, statusMessage, body)
    */
   delete(aRoute: string, aOptions: unknown): unknown;
-}
-
-export default RestAppInvoker;
+};

package/types/senselogic/sitevision/api/script/app/RestAppInvoker/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  get: function get() {},
+  post: function post() {},
+  put: function put() {},
+  "delete": function _delete() {}
+};
+exports["default"] = _default;

package/{hidden → types}/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts

@@ -22,11 +22,11 @@
  *
  * <p>
  *    See {@link InstanceCreatorUtil} for how to obtain an instance of the <code>InstanceCreatorUtil</code> interface.
- * </p>Gets the argument class.Gets the argument value.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.1
  */
-interface TypedArgument {
+export type TypedArgument = {
   /**
    * Gets the argument class.
    * @return the class of the argument
@@ -38,6 +38,4 @@ interface TypedArgument {
    * @return the value of the argument
    */
   getValue(): unknown;
-}
-
-export default TypedArgument;
+};

package/types/senselogic/sitevision/api/script/factory/TypedArgument/index.js

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

package/{hidden → types}/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts

@@ -79,16 +79,14 @@
  *      </p>
  *   #end
  *   </p>
- * </code></pre>Returns an exception suppressing iterator that ensures no exceptions will be thrown during iteration.
+ * </code></pre>
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */
-interface ExceptionSuppressingCollection {
+export type ExceptionSuppressingCollection = {
   /**
    * Returns an exception suppressing iterator that ensures no exceptions will be thrown during iteration.
    * @return a {@link ExceptionSuppressingIterator} that suppresses exceptions and returns proxied items
    */
   iterator(): unknown;
-}
-
-export default ExceptionSuppressingCollection;
+};

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.js

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

package/{hidden → types}/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts

@@ -1,4 +1,4 @@
-import ExceptionSuppressingProxy from "../ExceptionSuppressingProxy";
+import type { ExceptionSuppressingProxy } from "../ExceptionSuppressingProxy";
 
 /**
  * Decorates an iterator with exception suppressing behaviour and returns {@link ExceptionSuppressingProxy}s in order to ensure that no
@@ -24,44 +24,11 @@ import ExceptionSuppressingProxy from "../ExceptionSuppressingProxy";
  *    or indirectly via {@link senselogic.sitevision.api.Utils#getExceptionSuppressingCollection(java.util.Collection)}.
  *    You would typically use the latter if you should iterate a collection with the Velocity #foreach loop.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Returns <code>true</code> if decorated iterator has more elements. (In other words, returns <code>true</code>
- * if <code>next</code> would return an element rather than throwing an exception.)
- *
- * <p>
- * This method will never throw an exception
- * </p>Returns a proxy for the next element of the decorated iterator. Calling this method repeatedly until the {@link #hasNext()} method
- * returns <code>false</code> will return each element in the underlying collection exactly once.
- *
- * <p>
- *    <strong>Note!</strong> The returned element will be embedded in an <code>ExceptionSuppressingProxy</code> that will be reused for
- *    <em>all</em> next() invocations on this iterator. In other words, the proxied item of the returned element will change,
- *    but never the returned element itself. This implies that you shouldn't keep references to an item retrieved from a next()
- *    invocation during iteration. If you do, don't be surprised if the element contains something else than it did when you set the reference...
- * </p>
- *
- * <p>
- * This method will never throw an exception.
- * </p>
- * <p>
- *    <strong>Note! </strong>Be aware of <code>null</code> items since they're never proxied. If the underlying collection contains a
- *    <code>null</code> item, this iterator will just return <code>null</code>, not a proxy. In other words: even though this method
- *    won't throw any exceptions, invoking a method on the returned object might throw a <code>NullPointerException</code>.
- * </p>Tries to remove from the underlying collection the last element returned by decorated iterator (optional operation).
- * This method can be called only once per call to <code>next</code>. The behavior of an iterator is unspecified if
- * the underlying collection is modified while the iteration is in progress in any way other than by calling this method.
- *
- * <p>
- * This method will never throw an exception.
- * </p>
- * <p>
- * <strong>Note!</strong> Since exceptions are suppressed, you can never tell if the remove operation actually succeeded
- * or if the underlying collection doesn't support removal (i.e. <code>UnsupportedOperationException</code> thrown by the
- * decorated iterator is catched by this iterator).
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */
-interface ExceptionSuppressingIterator {
+export type ExceptionSuppressingIterator = {
   /**
    * Returns <code>true</code> if decorated iterator has more elements. (In other words, returns <code>true</code>
    * if <code>next</code> would return an element rather than throwing an exception.)
@@ -112,6 +79,4 @@ interface ExceptionSuppressingIterator {
   
     */
   remove(): void;
-}
-
-export default ExceptionSuppressingIterator;
+};

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.js

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

package/{hidden → types}/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts

@@ -63,11 +63,11 @@
  *
  *       $!proxy.thisMethodSometimesThrowsExceptions() <em>## Method invoked through a proxy, might return null</em>
  *    &lt;/p&gt;
- * </code></pre>Returns current statusReturns the exception that was thrown during last method invocation of the proxied object.Returns the proxied objectThe status indicating that this proxy has no object set, nothing to proxy.The status indicating that last method invocation did not throw an exception.The status indicating that last method invocation did throw an exception
+ * </code></pre>The status indicating that this proxy has no object set, nothing to proxy.The status indicating that last method invocation did not throw an exception.The status indicating that last method invocation did throw an exception
  * @author Magnus Lövgren
  * @since Sitevision 2.6.1_09
  */
-interface ExceptionSuppressingProxy {
+export type ExceptionSuppressingProxy = {
   /**
    * Returns current status
    * @return {@link #NO_OBJECT_PROXIED_STATUS} or {@link #NO_EXCEPTION_THROWN_STATUS} or {@link #EXCEPTION_THROWN_STATUS}
@@ -85,6 +85,4 @@ interface ExceptionSuppressingProxy {
    * @return the object that is proxied by an instance of this interface, or <code>null</code> if no proxied object is set
    */
   getProxiedObject(): unknown;
-}
-
-export default ExceptionSuppressingProxy;
+};

package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.js

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

package/{hidden → types}/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts

@@ -5,19 +5,7 @@
  *    <strong>Note!</strong> {@link senselogic.sitevision.api.search.SearchHit} has - as of Sitevision 3.0 - several typed <code>getField</code>
  *    methods that you would typically instead of this interface when you want to get "non-String" values!
  *    <a href="../../../../senselogic/sitevision/api/search/SearchHit.html#knowyourfields">More information about field values/types</a>
- * </p>Returns the Date for a string field that contains a date value generated via Lucene's DateTools class.Returns the Calendar for a string field that contains a date value generated via Lucene's DateTools class.Returns the Locale for a string field that contains a locale-based value that contains language ("en") or language and country ("en_US").
- *
- * <p>
- * A <code>toString()</code> on a english american locale returns the String <code>"en_US"</code>, but to create a locale
- * from that string you can NOT just create it by doing: <code>new Locale("en_US")</code>. You must split language (en)
- * and country (US) since the proper way of creating the Locale is: <code>new Locale("en", "US")</code>. Language must
- * be lowercased and country must be uppercased. This method will handle that (i.e. <code>aLocaleFieldValue == "EN_us"</code>
- * -&gt; <code>new Locale("en", "US")</code>).
  * </p>
- *
- * <p>
- * <strong>Note!</strong> This method does <em>NOT</em> handle variants!
- * </p>Returns the Integer for a string field that contains a integer value generated via Lucene's NumberTools (i.e. long) class.Returns the Long for a string field that contains a long value generated via Lucene's NumberTools class.Returns the Double for a string field that contains a double value generated to be a sortable search value.
  * @author Magnus Lövgren
  * @see senselogic.sitevision.api.search.SearchHit#getBooleanField(String)
  * @see senselogic.sitevision.api.search.SearchHit#getDateField(String)
@@ -26,7 +14,7 @@
  * @since Sitevision 2.6.2, 2.7_06
  * @deprecated use the typed methods in {@link senselogic.sitevision.api.search.SearchHit} instead when extracting values from a search result.
  */
-interface SearchFieldUtil {
+export type SearchFieldUtil = {
   /**
    * Returns the Date for a string field that contains a date value generated via Lucene's DateTools class.
    * @param aDateFieldValue the <code>String</code> that should be converted to a <code>Date</code>
@@ -84,6 +72,4 @@ interface SearchFieldUtil {
    * @since Sitevision 2.6.2, 2.7.2
    */
   doubleFieldToDouble(aDoubleFieldValue: string): number;
-}
-
-export default SearchFieldUtil;
+};

package/types/senselogic/sitevision/api/search/SearchFieldUtil/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  dateFieldToDate: function dateFieldToDate() {},
+  dateFieldToCalendar: function dateFieldToCalendar() {},
+  localeFieldToLocale: function localeFieldToLocale() {},
+  intFieldToInt: function intFieldToInt() {},
+  longFieldToLong: function longFieldToLong() {},
+  doubleFieldToDouble: function doubleFieldToDouble() {}
+};
+exports["default"] = _default;

package/{hidden → types}/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts

@@ -1,16 +1,16 @@
-import SearchHit from "../SearchHit";
+import type { SearchHit } from "../SearchHit";
 
 /**
  * <p>
  * This interface is deprecated and non-functional as of Sitevision 3.0. The Sitevision search engine has been replaced
  * (from Lucene to Solr) and highlighting of arbitrary fields in a search result via <code>SearchHighlighter</code> is no longer possible.
  * In Solr you should specify the field(-s) that should be highlighted when you execute the query.
- * </p>Returns a highlighted fragment for the default highlighting field.Returns a highlighted fragment for a specified field.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 2.7_06
  * @deprecated This interface will do absolutely nothing as of Sitevision 3.0 (search engine has been replaced). Interface methods will not do anything (i.e. always return <code>null</code>) and this interface will be completely removed in future releases of Sitevision.
  */
-interface SearchHighlighter {
+export type SearchHighlighter = {
   /**
    * Returns a highlighted fragment for the default highlighting field.
    * @param aHighlightPreElement the opening element to the left of a highlighted word(-s), e.g <code>"&lt;strong style=\"background-color:yellow\"&gt;"</code>
@@ -40,6 +40,4 @@ interface SearchHighlighter {
     aSearchHit: SearchHit,
     aHighlightingFieldName: string
   ): string;
-}
-
-export default SearchHighlighter;
+};

package/types/senselogic/sitevision/api/search/SearchHighlighter/index.js

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