@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/types/senselogic/sitevision/api/i18n/Currency/index.d.ts

@@ -1,13 +1,16 @@
+import type { String } from "../../../../../java/lang/String";
+import type { Locale } from "../../../../../java/util/Locale";
+
 /**
  * Representation of a currency.
  *
- * <p>
- *    <em>This interface is conceptually equivalent with the <code>java.util.Currency</code> class.</em>
- * </p>
+ *  <p>
+ *     <em>This interface is conceptually equivalent with the <code>java.util.Currency</code> class.</em>
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface is obtained via {@link CurrencyFactory}.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface is obtained via {@link CurrencyFactory}.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 6.1
  */
@@ -15,39 +18,39 @@ export type Currency = {
   /**
    * Gets the ISO 4217 currency code of this currency.
    *
-   * <p>
-   *    <a href="https://www.iso.org/iso-4217-currency-codes.html">
-   *       Currency codes are specified with a three-letter alphabetic code specified by ISO 4217
-   *    </a>
-   * </p>
+   *  <p>
+   *     <a href="https://www.iso.org/iso-4217-currency-codes.html">
+   *        Currency codes are specified with a three-letter alphabetic code specified by ISO 4217
+   *     </a>
+   *  </p>
    *
-   * <table>
-   *    <caption>Common currencies</caption>
-   *    <tr>
-   *       <th scope="col">Currency name</th>
-   *       <th scope="col">Currency code</th>
-   *    </tr>
-   *    <tr>
-   *       <td>US Dollar</td>
-   *       <td>USD</td>
-   *    </tr>
-   *    <tr>
-   *       <td>Euro</td>
-   *       <td>EUR</td>
-   *    </tr>
-   *    <tr>
-   *       <td>Brittish Pound</td>
-   *       <td>GBP</td>
-   *    </tr>
-   *    <tr>
-   *       <td>Swedish Krona</td>
-   *       <td>SEK</td>
-   *    </tr>
-   *    <tr>
-   *       <td>Norwegian Krone</td>
-   *       <td>NOK</td>
-   *    </tr>
-   * </table>
+   *  <table>
+   *     <caption>Common currencies</caption>
+   *     <tr>
+   *        <th scope="col">Currency name</th>
+   *        <th scope="col">Currency code</th>
+   *     </tr>
+   *     <tr>
+   *        <td>US Dollar</td>
+   *        <td>USD</td>
+   *     </tr>
+   *     <tr>
+   *        <td>Euro</td>
+   *        <td>EUR</td>
+   *     </tr>
+   *     <tr>
+   *        <td>Brittish Pound</td>
+   *        <td>GBP</td>
+   *     </tr>
+   *     <tr>
+   *        <td>Swedish Krona</td>
+   *        <td>SEK</td>
+   *     </tr>
+   *     <tr>
+   *        <td>Norwegian Krone</td>
+   *        <td>NOK</td>
+   *     </tr>
+   *  </table>
    * @return the ISO 4217 currency code of this currency.
    */
   getCurrencyCode(): string;
@@ -55,23 +58,23 @@ export type Currency = {
   /**
    * Gets the name that is suitable for displaying this currency for a specified locale.
    *
-   * If there is no suitable display name found for the specified locale, the ISO 4217 currency code is returned.
+   *  If there is no suitable display name found for the specified locale, the ISO 4217 currency code is returned.
    * @param aLocale the locale to use for display of this currency
    * @return the display name of this currency for aLocale
    * @throws NullPointerException if aLocale is null
    */
-  getDisplayName(aLocale: unknown): string;
+  getDisplayName(aLocale: Locale): string;
 
   /**
    * Gets the symbol of this currency for a specified locale.
    *
-   * For example, for the US Dollar, the symbol is "$" if the specified
-   * locale is the US, while for other locales it may be "US$".
+   *  For example, for the US Dollar, the symbol is "$" if the specified
+   *  locale is the US, while for other locales it may be "US$".
    *
-   * If no symbol can be determined, the ISO 4217 currency code is returned.
+   *  If no symbol can be determined, the ISO 4217 currency code is returned.
    * @param aLocale the locale to use for display of the symbol of this currency
    * @return the symbol of this currency for aLocale
    * @throws NullPointerException if aLocale is null
    */
-  getSymbol(aLocale: unknown): string;
+  getSymbol(aLocale: Locale): string;
 };

package/types/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts

@@ -1,3 +1,5 @@
+import type { String } from "../../../../../java/lang/String";
+import type { Locale } from "../../../../../java/util/Locale";
 import type { CustomLinkRenderData } from "../CustomLinkRenderData";
 import type { Filter } from "../../base/Filter";
 
@@ -10,25 +12,25 @@ export type CustomLinkProcessor = Filter & {
   /**
    * Validates a link URL accepted by this link processor.
    *
-   * <p>
-   *    Note! This method will only be called if {@link senselogic.sitevision.api.base.Filter#accept(Object)}
-   *    returns <code>true</code> for <code>aLinkURL</code>.
-   * </p>
+   *  <p>
+   *     Note! This method will only be called if {@link senselogic.sitevision.api.base.Filter#accept(Object)}
+   *     returns <code>true</code> for <code>aLinkURL</code>.
+   *  </p>
    * @param aLinkURL the link URL to validate
    * @param aLocale the Locale to use for potential validation error message
    * @return a localized validation error message, or <code>null</code> if validation passes
    */
-  validate(aLinkURL: string, aLocale: unknown): string;
+  validate(aLinkURL: String | string, aLocale: Locale): string;
 
   /**
    * Gets custom render data for a link URL accepted by this link processor.
    *
-   * <p>
-   *    Note! This method will only be called if {@link senselogic.sitevision.api.base.Filter#accept(Object)}
-   *    returns <code>true</code> for <code>aLinkURL</code>.
-   * </p>
+   *  <p>
+   *     Note! This method will only be called if {@link senselogic.sitevision.api.base.Filter#accept(Object)}
+   *     returns <code>true</code> for <code>aLinkURL</code>.
+   *  </p>
    * @param aLinkURL the link URL that should be rendered
    * @return custom render data, or <code>null</code> if no custom render data is to be used
    */
-  getRenderData(aLinkURL: string): CustomLinkRenderData;
+  getRenderData(aLinkURL: String | string): CustomLinkRenderData;
 };

package/types/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts

@@ -1,3 +1,5 @@
+import type { Map } from "../../../../../java/util/Map";
+
 /**
  * Custom link data that enables custom data attributes when rendering for specific link URLs.
  * @author Magnus Lövgren
@@ -8,31 +10,31 @@ export type CustomLinkRenderData = {
   /**
    * Returns the data attributes that should be used when rendering a link accepted by the {@link CustomLinkProcessor}.
    *
-   * <p>
-   *    Notes about entry <em>keys</em>:
-   * </p>
-   * <ul>
-   *    <li>
-   *       A key that is <code>null</code> or <em>whitespace-only</em> will be completely ignored, i.e. no data attribute will be rendered.
-   *    </li>
-   *    <li>
-   *       A key that isn't properly prefixed with <em>"data-"</em> will be prefixed when the data attribute is rendered.
-   *    </li>
-   * </ul>
+   *  <p>
+   *     Notes about entry <em>keys</em>:
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        A key that is <code>null</code> or <em>whitespace-only</em> will be completely ignored, i.e. no data attribute will be rendered.
+   *     </li>
+   *     <li>
+   *        A key that isn't properly prefixed with <em>"data-"</em> will be prefixed when the data attribute is rendered.
+   *     </li>
+   *  </ul>
    *
-   * <p>
-   *    Notes about entry <em>values</em>:
-   * </p>
-   * <ul>
-   *    <li>
-   *       A value that is <code>null</code> or <em>whitespace-only</em> will be rendered as a data attribute without value.
-   *    </li>
-   *    <li>
-   *       A value should not be escaped, it will be escaped when it is rendered
-   *       (typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}).
-   *    </li>
-   * </ul>
+   *  <p>
+   *     Notes about entry <em>values</em>:
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        A value that is <code>null</code> or <em>whitespace-only</em> will be rendered as a data attribute without value.
+   *     </li>
+   *     <li>
+   *        A value should not be escaped, it will be escaped when it is rendered
+   *        (typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)}).
+   *     </li>
+   *  </ul>
    * @return the data attributes that should be used when rendering a link accepted by the {@link CustomLinkProcessor}
    */
-  getDataAttributes(): unknown;
+  getDataAttributes(): Map;
 };

package/types/senselogic/sitevision/api/mail/Mail/index.d.ts

@@ -1,10 +1,10 @@
 /**
  * Mail to be sent.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.mail.MailBuilder#build()}.
- *    See {@link senselogic.sitevision.api.mail.MailBuilder} for how to obtain an instance of the <code>MailBuilder</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.mail.MailBuilder#build()}.
+ *     See {@link senselogic.sitevision.api.mail.MailBuilder} for how to obtain an instance of the <code>MailBuilder</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  * @see senselogic.sitevision.api.mail.MailBuilder
@@ -12,15 +12,15 @@
 export type Mail = {
   /**
    * Sends this mail synchronously.
-   * @return <code>true</code> if no error was reported from the Sitevision mail service, <code>false</code> otherwise. <strong><em>Important node!</em></strong> A <code>true</code> value implies that the mail is sent as far as the Sitevision mail service can tell, but it doesn't guarantee that the actual mail server (whose configuration is specified on the Sitevision server node) has done so. The mail might be queued, quarantined or silently ignored by the mail server.
+   * @return <code>true</code> if no error was reported from the Sitevision mail service, <code>false</code> otherwise.&#xA; <strong><em>Important node!</em></strong> A <code>true</code> value implies that the mail is sent as far as the Sitevision&#xA; mail service can tell, but it doesn't guarantee that the actual mail server (whose configuration is specified on the&#xA; Sitevision server node) has done so. The mail might be queued, quarantined or silently ignored by the mail server.
    */
   send(): boolean;
 
   /**
    * Sends this mail asynchronously.
    *
-   * No information is returned to as if the mail was really sent as far as the actual mail server (whose configuration is specified on the
-   * Sitevision server node). The mail might be queued, quarantined or silently ignored by the mail server.
+   *  No information is returned to as if the mail was really sent as far as the actual mail server (whose configuration is specified on the
+   *  Sitevision server node). The mail might be queued, quarantined or silently ignored by the mail server.
    * @since Sitevision 2022.05.1
    */
   sendAsync(): void;

package/types/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts

@@ -1,3 +1,5 @@
+import type { String } from "../../../../../java/lang/String";
+
 /**
  * Message text rendering interface that detects and creates links in plain message texts.
  * @author Magnus Lövgren
@@ -9,5 +11,5 @@ export type MessageTextLinker = {
    * @param aText the text that might contain links
    * @return a linked text, or empty string if <code>aText</code> is <code>null</code>
    */
-  autoLink(aText: string): string;
+  autoLink(aText: String | string): string;
 };

package/types/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts

@@ -1,23 +1,21 @@
 /**
  * A temporary representation of a link metadata value.
  *
- * <p>
- *    An instance of this interface can be used in MetadataUtil when setting a link metadata via the
- *    {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, String, Object)}
- *    or
- *    {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}
- * </p>
+ *  <p>
+ *     An instance of this interface can be used in MetadataUtil when setting a link metadata via the
+ *     {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, String, Object)}
+ *     or
+ *     {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder#build()}.
- *    See {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder} for how to obtain an instance of the
- *    <code>LinkValueBuilder</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder#build()}.
+ *     See {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder} for how to obtain an instance of the
+ *     <code>LinkValueBuilder</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  * @see senselogic.sitevision.api.metadata.builder.LinkValueBuilder
  */
-export type LinkValue = {
-  undefined;
-};
+export type LinkValue = {};

package/types/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts

@@ -1,23 +1,21 @@
 /**
  * A temporary representation of a related metadata value.
  *
- * <p>
- *    An instance of this interface can be used in MetadataUtil when setting a related metadata via the
- *    {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, String, Object)}
- *    or
- *    {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}
- * </p>
+ *  <p>
+ *     An instance of this interface can be used in MetadataUtil when setting a related metadata via the
+ *     {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, String, Object)}
+ *     or
+ *     {@link senselogic.sitevision.api.metadata.MetadataUtil#setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.metadata.builder.RelatedValueBuilder#build()}.
- *    See {@link senselogic.sitevision.api.metadata.builder.RelatedValueBuilder} for how to obtain an instance of the
- *    <code>RelatedValueBuilder</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.metadata.builder.RelatedValueBuilder#build()}.
+ *     See {@link senselogic.sitevision.api.metadata.builder.RelatedValueBuilder} for how to obtain an instance of the
+ *     <code>RelatedValueBuilder</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  * @see senselogic.sitevision.api.metadata.builder.RelatedValueBuilder
  */
-export type RelatedValue = {
-  undefined;
-};
+export type RelatedValue = {};

package/types/senselogic/sitevision/api/portlet/GenericConfigPortlet/index.d.ts

@@ -0,0 +1,228 @@
+import type { GenericSiteVisionPortlet } from "../GenericSiteVisionPortlet";
+import type { String } from "../../../../../java/lang/String";
+
+/**
+ * This class that can be extended when creating GenericPortlet-based portlets that uses the
+ *  Sitevision custom portlet mode CONFIG.
+ *
+ *  <p>
+ *     The dispatching of this class ensures that CONFIG mode requests are routed to separate methods
+ *     (<em>ActionRequest &raquo; processConfigAction,  RenderRequest &raquo; doConfig</em>).
+ *  </p>
+ *  <p>
+ *     For a basic VIEW portlet that should use the Sitevision custom portlet mode CONFIG, you would typically
+ *     extend this class and override the <code>doView</code>, <code>doConfig</code> and <code>processConfigAction</code> methods.
+ *  </p>
+ *
+ *  <p>
+ *     <strong>An example!</strong>
+ *  </p>
+ *  <p>
+ *     Below is an example of an implementation of a very simplistic portlet that allows editors
+ *     to update a portlet preference via the Sitevision custom portlet mode CONFIG:
+ *  </p>
+ *  <div style="border:1px dotted gray; padding-left:10px; padding-right:10px">
+ *  <pre><code> import senselogic.sitevision.api.portlet.GenericConfigPortlet;
+ *
+ *  import javax.portlet.*;
+ *  import java.io.IOException;
+ *  import java.io.PrintWriter;
+ *
+ *  public class HelloConfigPortlet extends GenericConfigPortlet {
+ *     private final static String CITY = "city"; <em>// Name of the preference that can be updated via CONFIG mode</em>
+ *
+ *     &#64;Override
+ *     protected void processConfigAction(ActionRequest anActionRequest, ActionResponse anActionResponse) throws PortletException, IOException {
+ *        <em>// GenericConfigPortlet ensures we got here safely, no need to check permissions...</em>
+ *        PortletPreferences preferences = anActionRequest.getPreferences();
+ *        String newValue = anActionRequest.getParameter(CITY);
+ *        if (newValue != null &amp;&amp; !newValue.equals(preferences.getValue(CITY, null))) {
+ *           preferences.setValue(CITY, newValue);
+ *           preferences.store();
+ *        }
+ *     }
+ *
+ *     &#64;Override
+ *     protected void doConfig(RenderRequest aRenderRequest, RenderResponse aRenderResponse) throws PortletException, IOException {
+ *        <em>// GenericConfigPortlet ensures we got here safely, no need to check permissions...</em>
+ *        PrintWriter writer = getWriter(aRenderResponse);
+ *
+ *        String currentValue = aRenderRequest.getPreferences().getValue(CITY, "");
+ *        writer.println("&lt;form action=\""+ aRenderResponse.createActionURL() +"\" method=\"post\"&gt;");
+ *        writer.println("   &lt;label for=\"anIdentifier\" class=\"portlet-form-label\"&gt;City:&lt;/label&gt;");
+ *        writer.println("   &lt;input id=\"anIdentifier\" class=\"portlet-form-input-field\" name=\""+ CITY +"\" value=\""+ currentValue +"\" /&gt;");
+ *        writer.println("   &lt;input class=\"portlet-form-button\" type=\"submit\" value=\"Save "+ CITY +" preference\" /&gt;");
+ *        writer.println("&lt;/form&gt;");
+ *     }
+ *
+ *     &#64;Override
+ *     protected void doView(RenderRequest aRenderRequest, RenderResponse aRenderResponse) throws PortletException, IOException {
+ *        PrintWriter writer = getWriter(aRenderResponse);
+ *
+ *        String currentValue = aRenderRequest.getPreferences().getValue(CITY, "");
+ *        writer.println("&lt;p class=\"portlet-class\"&gt;Favorite city is "+ currentValue +"&lt;/p&gt;");
+ *     }
+ *  }</code></pre></div>
+ *
+ *  <p>
+ *     Note that the <code>portlet.xml</code> for the portlet above <em>must specify that it is using the Sitevision custom portlet
+ *     mode CONFIG</em>! Below is an excerpt of how:
+ *  </p>
+ *  <div style="border:1px dotted gray; padding-left:10px; padding-right:10px"><pre><code> &lt;?xml version="1.0" encoding="UTF-8"?&gt;
+ *  &lt;portlet-app ...&gt;
+ *     &lt;portlet&gt;
+ *        ...
+ *        &lt;supports&gt;
+ *           &lt;mime-type&gt;text/html&lt;/mime-type&gt;
+ *           &lt;portlet-mode&gt;VIEW&lt;/portlet-mode&gt;
+ *           &lt;portlet-mode&gt;CONFIG&lt;/portlet-mode&gt;
+ *        &lt;/supports&gt;
+ *        ...
+ *     &lt;/portlet&gt;
+ *     &lt;custom-portlet-mode&gt;
+ *        &lt;description&gt;Sitevision config mode&lt;/description&gt;
+ *        &lt;portlet-mode&gt;CONFIG&lt;/portlet-mode&gt;
+ *     &lt;/custom-portlet-mode&gt;
+ *  &lt;/portlet-app&gt;</code></pre></div>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.0
+ */
+export type GenericConfigPortlet = GenericSiteVisionPortlet & {
+  /**
+   * This method routes the render requests to the proper rendering method.
+   *  <p>
+   *     The standard portlet modes are supported:
+   *  </p>
+   *  <ul>
+   *     <li>Render requests in <code>PortletMode.VIEW</code> will be routed to the <code>doView</code> method</li>
+   *     <li>Render requests in <code>PortletMode.EDIT</code> will be routed to the <code>doEdit</code> method</li>
+   *     <li>Render requests in <code>PortletMode.HELP</code> will be routed to the <code>doHelp</code> method</li>
+   *  </ul>
+   *
+   *  <p>
+   *     This method also supports routing of the Sitevision custom portlet mode {@link #CONFIG}.
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        Render requests in portlet mode {@link #CONFIG} will be routed to the
+   *        {@link #doConfig(javax.portlet.RenderRequest, javax.portlet.RenderResponse) doConfig} method
+   *     </li>
+   *  </ul>
+   *
+   *  <p>
+   *     If the window state of this portlet is <code>WindowState.MINIMIZED</code>, this method does <em>not</em> route
+   *     to any of the rendering methods.
+   *  </p>
+   *  <p>
+   *     <em>Note!</em> You can not use this class if your portlet should support other portlet modes than the above mentioned.
+   *     This method is final to ensure that routing/dispatching won't break.
+   *  </p>
+   * @param aRenderRequest the render request
+   * @param aRenderResponse the render response
+   * @throws PortletException if the portlet cannot fulfill the request
+   * @throws IOException if the streaming causes an I/O problem
+   */
+  doDispatch(aRenderRequest: unknown, aRenderResponse: unknown): void;
+
+  /**
+   * Called by the Sitevision portlet container to allow the portlet to process an action request.
+   *  This method is called if the client request was originated by a URL created (by the portlet) with the
+   *  <code>RenderResponse.createActionURL()</code> method.
+   *
+   *  This method routes the action requests to the proper rendering method.
+   *  <p>
+   *     The standard portlet modes are supported:
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        Action requests in <code>PortletMode.VIEW</code> will be routed to the
+   *        {@link #processStandardAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse) processStandardAction} method
+   *     </li>
+   *     <li>
+   *        Action requests in <code>PortletMode.EDIT</code> will be routed to the
+   *        {@link #processStandardAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse) processStandardAction} method
+   *     </li>
+   *     <li>
+   *        Action requests in <code>PortletMode.HELP</code> will be routed to the
+   *        {@link #processStandardAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse) processStandardAction} method
+   *     </li>
+   *  </ul>
+   *
+   *  <p>
+   *     This method also supports routing of the Sitevision custom portlet mode {@link #CONFIG}.
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        Action requests in portlet mode {@link #CONFIG} will be routed to the
+   *        {@link #processConfigAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)} processConfigAction} method
+   *     </li>
+   *  </ul>
+   *
+   *  <p>
+   *     <strong>Note!</strong> The portlet mode for a CONFIG request will always be re-set to <code>PortletMode.VIEW</code> when
+   *     execution of <code>processConfigAction</code> has completed (to ensure that VIEW will be used in the subsequent rendering phase).
+   *     This method is final to ensure that routing/dispatching won't break.
+   *  </p>
+   * @param aActionRequest the action request
+   * @param aActionResponse the action response
+   * @throws PortletException if the portlet cannot fulfill the request
+   * @throws IOException if the streaming causes an I/O problem
+   */
+  processAction(aActionRequest: unknown, aActionResponse: unknown): void;
+
+  /**
+   * This is the "processAction" method for the standard portlet modes (<code>VIEW</code>, <code>EDIT</code> and <code>HELP</code>).
+   *
+   *  <p>
+   *     The default implementation does absolutely nothing!
+   *     Override this method to implement custom behaviour.
+   *  </p>
+   * @param aActionRequest the action request
+   * @param aActionResponse the action response
+   * @throws PortletException if the portlet cannot fulfill the request
+   * @throws IOException if the streaming causes an I/O problem
+   * @see #processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
+   */
+  processStandardAction(
+    aActionRequest: unknown,
+    aActionResponse: unknown
+  ): void;
+
+  /**
+   * This is the "processAction" method for the Sitevision custom portlet mode {@link #CONFIG}.
+   *
+   *  <p>
+   *     <em>This method will only be executed if requesting user has sufficient rights!</em>
+   *  </p>
+   * @param aActionRequest the action request
+   * @param aActionResponse the action response
+   * @throws PortletException if the portlet cannot fulfill the request
+   * @throws IOException if the streaming causes an I/O problem
+   * @see #processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)
+   */
+  processConfigAction(aActionRequest: unknown, aActionResponse: unknown): void;
+
+  /**
+   * Renders the portlet configuration form that should be POST:ed using an <code>ActionURL</code>.
+   *  <p>
+   *     Invoked in the rendering phase when the portlet is in custom portlet mode {@link #CONFIG}.
+   *     E.g. when an editor with sufficient rights (write permission on the actual page the portlet instance resides)
+   *     double-clicks this portlet in the Sitevision editor.
+   *  </p>
+   *  <p>
+   *     <em>This method will only be executed if requesting user has sufficient rights!</em>
+   *  </p>
+   * @param aRenderRequest the render request
+   * @param aRenderResponse the render response
+   * @throws PortletException if the portlet cannot fulfill the request
+   * @throws IOException if the portlet is unavailable to perform render at this time
+   * @see #doDispatch(javax.portlet.RenderRequest, javax.portlet.RenderResponse)
+   */
+  doConfig(aRenderRequest: unknown, aRenderResponse: unknown): void;
+
+  /**
+ * Name of the Sitevision custom portlet mode CONFIG.
+  
+    */
+  CONFIG: string;
+};

package/types/senselogic/sitevision/api/portlet/GenericConfigPortlet/index.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  doDispatch: function doDispatch() {},
+  processAction: function processAction() {},
+  processStandardAction: function processStandardAction() {},
+  processConfigAction: function processConfigAction() {},
+  doConfig: function doConfig() {}
+};
+exports["default"] = _default;