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

package/server/storage/index.d.ts

@@ -1,11 +1,27 @@
+interface OrderByOptions {
+  field: string;
+  order: 'ASC' | 'DESC';
+}
+
+interface FindOptions {
+  count?: number;
+  skip?: number;
+  orderBy?: OrderByOptions | OrderByOptions[];
+}
+
 interface CollectionDataStore {
   add(data: any): void;
   addAll(data: any[]): void;
-  get(dsid: string): any;
+  get(dsid: string): unknown;
   set(dsid: string, data: any): void;
   remove(dsid: string): void;
   removeAll(): void;
-  find(query: string, count: number, skip: number): SearchResult;
+
+  find(query: string, options?: FindOptions): SearchResult;
+  /**
+   * @deprecated
+   */
+  find(query: string, count?: number, skip?: number): SearchResult;
 
   /**
    * Performs instant indexing (blocking) of a collection data store post.
@@ -40,7 +56,7 @@ interface KeyValueDataStore {
    * @since 5.2
    * @param key A key to retrieve data from
    */
-  get(key: string): any;
+  get(key: string): unknown;
 
   /**
    * Removes data associated with a key.
@@ -53,11 +69,15 @@ interface KeyValueDataStore {
 }
 
 interface SearchResult {
-  toArray(): any[];
-  each(callback: (err: DataStoreError, data: any) => void): void;
+  toArray(): unknown[];
+  each(
+    callback: (err: DataStoreError | undefined, data: unknown) => void
+  ): void;
   hasNext(): boolean;
-  next(): any;
-  length(callback: (err: DataStoreError, length: number) => void): void;
+  next(): unknown;
+  length(
+    callback: (err: DataStoreError | undefined, length: number) => void
+  ): void;
 }
 
 interface DataStoreError {

package/hidden/senselogic/sitevision/api/render/BuddyIconRenderer/BuddyIconInfo/index.d.ts

@@ -1,51 +0,0 @@
-/**
- * Basic render information about current buddy icon of a BuddyIconRenderer.
- *
- * <p>
- *    This data is typically used for custom rendering of a buddy icon.
- * </p>
- *
- * <p>
- *    <em>
- *       Server-side Javascript example
- *       (a function that provides custom rendering of a 48x48 buddy icon image for a given sv:userIdentity Node):
- *    </em>
- * </p><pre><code>  function getHtmlImage(userIdentity) {
- *     const buddyIconRenderer = require('BuddyIconRenderer');
- *     const LARGE_SIZE = require('BuddyIconRenderer.BuddyIconSize.LARGE');
- *
- *     // Load renderer and set proper size
- *     buddyIconRenderer.update(userIdentity);
- *     buddyIconRenderer.setBuddyIconSize(LARGE_SIZE);
- *
- *     // Get BuddyIconInfo data
- *     const info = buddyIconRenderer.getBuddyIconInfo();
- *
- *     // Do custom render...
- *     return '&lt;img src="' + info.getURI() + '"&gt;';
- *  }</code></pre>The URI of current buddy icon.The width of current buddy icon.The height of current buddy icon.
- * @see BuddyIconRenderer#getBuddyIconInfo()
- * @author Magnus Lövgren
- * @since Sitevision 8.2
- */
-interface BuddyIconRenderer_BuddyIconInfo {
-  /**
-   * The URI of current buddy icon.
-   * @return the URI of the buddy icon, might be null
-   */
-  getURI(): string;
-
-  /**
-   * The width of current buddy icon.
-   * @return the width of the buddy icon, might be zero.
-   */
-  getWidth(): number;
-
-  /**
-   * The height of current buddy icon.
-   * @return the height of the buddy icon, might be zero.
-   */
-  getHeight(): number;
-}
-
-export default BuddyIconRenderer_BuddyIconInfo;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/ArticleUtilConstants/index.d.ts

@@ -1,85 +0,0 @@
-/**
- * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.webresource.ArticleUtil}.
- *
- * <p>
- *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.webresource.ArticleUtil}
- *    constants in Velocity, e.g: <code>$articleUtil.PROPERTY_LAST_MODIFIED_DATE</code>
- * </p>Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_VISIBLE_IN_MENUS}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_SHORTID}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LOCALE}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_ROBOTS_INDEX}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_CREATION_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_CREATED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_MODIFIED_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_MODIFIED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_PUBLISHED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_PUBLISH_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_PUBLISHED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_PUBLISH_DATE}.
- * @author Magnus Lövgren
- * @since Sitevision 3.6.2
- */
-interface VelocityAccess_ArticleUtilConstants {
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_VISIBLE_IN_MENUS}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_VISIBLE_IN_MENUS}
-   */
-  getPROPERTY_VISIBLE_IN_MENUS(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_SHORTID}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_SHORTID}
-   */
-  getPROPERTY_SHORTID(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LOCALE}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LOCALE}
-   */
-  getPROPERTY_LOCALE(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_ROBOTS_INDEX}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_ROBOTS_INDEX}
-   */
-  getPROPERTY_ROBOTS_INDEX(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_CREATION_DATE}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_CREATION_DATE}
-   */
-  getPROPERTY_CREATION_DATE(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_CREATED_BY}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_CREATED_BY}
-   */
-  getPROPERTY_CREATED_BY(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_MODIFIED_DATE}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_MODIFIED_DATE}
-   */
-  getPROPERTY_LAST_MODIFIED_DATE(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_MODIFIED_BY}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_MODIFIED_BY}
-   */
-  getPROPERTY_LAST_MODIFIED_BY(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_PUBLISHED_BY}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_PUBLISHED_BY}
-   */
-  getPROPERTY_LAST_PUBLISHED_BY(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_PUBLISH_DATE}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_LAST_PUBLISH_DATE}
-   */
-  getPROPERTY_LAST_PUBLISH_DATE(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_PUBLISHED_BY}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_PUBLISHED_BY}
-   */
-  getPROPERTY_PUBLISHED_BY(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_PUBLISH_DATE}.
-   * @return {@link senselogic.sitevision.api.webresource.ArticleUtil#PROPERTY_PUBLISH_DATE}
-   */
-  getPROPERTY_PUBLISH_DATE(): string;
-}
-
-export default VelocityAccess_ArticleUtilConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/ExceptionSuppressingProxyConstants/index.d.ts

@@ -1,31 +0,0 @@
-/**
- * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy}.
- *
- * <p>
- *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy}
- *    constants in Velocity, e.g: <code>$exceptionSuppressingProxy.EXCEPTION_THROWN_STATUS</code>
- * </p>Get accessor for {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy#NO_OBJECT_PROXIED_STATUS}.Get accessor for {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy#NO_EXCEPTION_THROWN_STATUS}.Get accessor for {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy#EXCEPTION_THROWN_STATUS}.
- * @author Magnus Lövgren
- * @since Sitevision 3.6.2
- */
-interface VelocityAccess_ExceptionSuppressingProxyConstants {
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy#NO_OBJECT_PROXIED_STATUS}.
-   * @return {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy#NO_OBJECT_PROXIED_STATUS}
-   */
-  getNO_OBJECT_PROXIED_STATUS(): number;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy#NO_EXCEPTION_THROWN_STATUS}.
-   * @return {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy#NO_EXCEPTION_THROWN_STATUS}
-   */
-  getNO_EXCEPTION_THROWN_STATUS(): number;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy#EXCEPTION_THROWN_STATUS}.
-   * @return {@link senselogic.sitevision.api.script.proxy.ExceptionSuppressingProxy#EXCEPTION_THROWN_STATUS}
-   */
-  getEXCEPTION_THROWN_STATUS(): number;
-}
-
-export default VelocityAccess_ExceptionSuppressingProxyConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/IndexingUtilConstants/index.d.ts

@@ -1,31 +0,0 @@
-/**
- * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.search.index.IndexingUtil}.
- *
- * <p>
- *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.search.index.IndexingUtil}
- *    constants in Velocity, e.g: <code>$indexingUtil.MAX_RESOURCE_PRIORITY</code>
- * </p>Get accessor for {@link senselogic.sitevision.api.search.index.IndexingUtil#MIN_RESOURCE_PRIORITY}.Get accessor for {@link senselogic.sitevision.api.search.index.IndexingUtil#DEFAULT_RESOURCE_PRIORITY}.Get accessor for {@link senselogic.sitevision.api.search.index.IndexingUtil#MAX_RESOURCE_PRIORITY}.
- * @author Magnus Lövgren
- * @since Sitevision 3.6.4
- */
-interface VelocityAccess_IndexingUtilConstants {
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.search.index.IndexingUtil#MIN_RESOURCE_PRIORITY}.
-   * @return {@link senselogic.sitevision.api.search.index.IndexingUtil#MIN_RESOURCE_PRIORITY}
-   */
-  getMIN_RESOURCE_PRIORITY(): number;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.search.index.IndexingUtil#DEFAULT_RESOURCE_PRIORITY}.
-   * @return {@link senselogic.sitevision.api.search.index.IndexingUtil#DEFAULT_RESOURCE_PRIORITY}
-   */
-  getDEFAULT_RESOURCE_PRIORITY(): number;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.search.index.IndexingUtil#MAX_RESOURCE_PRIORITY}.
-   * @return {@link senselogic.sitevision.api.search.index.IndexingUtil#MAX_RESOURCE_PRIORITY}
-   */
-  getMAX_RESOURCE_PRIORITY(): number;
-}
-
-export default VelocityAccess_IndexingUtilConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/LinkPageUtilConstants/index.d.ts

@@ -1,67 +0,0 @@
-/**
- * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.webresource.LinkPageUtil}.
- *
- * <p>
- *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.webresource.LinkPageUtil}
- *    constants in Velocity, e.g: <code>$linkPageUtil.PROPERTY_LAST_MODIFIED_DATE</code>
- * </p>Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_VISIBLE_IN_MENUS}.Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_CREATION_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_CREATED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_MODIFIED_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_MODIFIED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_PUBLISHED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_PUBLISH_DATE}.Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_PUBLISHED_BY}.Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_PUBLISH_DATE}.
- * @author Magnus Lövgren
- * @since Sitevision 4.2
- */
-interface VelocityAccess_LinkPageUtilConstants {
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_VISIBLE_IN_MENUS}.
-   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_VISIBLE_IN_MENUS}
-   */
-  getPROPERTY_VISIBLE_IN_MENUS(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_CREATION_DATE}.
-   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_CREATION_DATE}
-   */
-  getPROPERTY_CREATION_DATE(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_CREATED_BY}.
-   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_CREATED_BY}
-   */
-  getPROPERTY_CREATED_BY(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_MODIFIED_DATE}.
-   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_MODIFIED_DATE}
-   */
-  getPROPERTY_LAST_MODIFIED_DATE(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_MODIFIED_BY}.
-   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_MODIFIED_BY}
-   */
-  getPROPERTY_LAST_MODIFIED_BY(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_PUBLISHED_BY}.
-   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_PUBLISHED_BY}
-   */
-  getPROPERTY_LAST_PUBLISHED_BY(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_PUBLISH_DATE}.
-   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_LAST_PUBLISH_DATE}
-   */
-  getPROPERTY_LAST_PUBLISH_DATE(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_PUBLISHED_BY}.
-   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_PUBLISHED_BY}
-   */
-  getPROPERTY_PUBLISHED_BY(): string;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_PUBLISH_DATE}.
-   * @return {@link senselogic.sitevision.api.webresource.LinkPageUtil#PROPERTY_PUBLISH_DATE}
-   */
-  getPROPERTY_PUBLISH_DATE(): string;
-}
-
-export default VelocityAccess_LinkPageUtilConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/MathInstanceConstants/index.d.ts

@@ -1,25 +0,0 @@
-/**
- * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.script.factory.MathInstance}.
- *
- * <p>
- *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.script.factory.MathInstance}
- *    constants in Velocity, e.g: <code>$mathInstance.PI</code>
- * </p>Get accessor for {@link senselogic.sitevision.api.script.factory.MathInstance#E}.Get accessor for {@link senselogic.sitevision.api.script.factory.MathInstance#PI}.
- * @author Magnus Lövgren
- * @since Sitevision 3.6.2
- */
-interface VelocityAccess_MathInstanceConstants {
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.script.factory.MathInstance#E}.
-   * @return {@link senselogic.sitevision.api.script.factory.MathInstance#E}
-   */
-  getE(): number;
-
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.script.factory.MathInstance#PI}.
-   * @return {@link senselogic.sitevision.api.script.factory.MathInstance#PI}
-   */
-  getPI(): number;
-}
-
-export default VelocityAccess_MathInstanceConstants;

package/hidden/senselogic/sitevision/api/render/velocity/VelocityAccess/MimeTypeUtilConstants/index.d.ts

@@ -1,19 +0,0 @@
-/**
- * Get methods for accessing field constants defined in {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil}.
- *
- * <p>
- *    The sole purpose of this interface is to provide access to {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil}
- *    constants in Velocity, e.g: <code>$mimeTypeUtil.GENERIC_MIME_TYPE</code>
- * </p>Get accessor for {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil#GENERIC_MIME_TYPE}.
- * @author Magnus Lövgren
- * @since Sitevision 3.6.2
- */
-interface VelocityAccess_MimeTypeUtilConstants {
-  /**
-   * Get accessor for {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil#GENERIC_MIME_TYPE}.
-   * @return {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil#GENERIC_MIME_TYPE}
-   */
-  getGENERIC_MIME_TYPE(): string;
-}
-
-export default VelocityAccess_MimeTypeUtilConstants;