@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/server/RestAppInvokerFactory/index.d.ts

@@ -1,45 +1,46 @@
+import type { String } from "../../types/java/lang/String";
 import type { RestAppInvoker } from "../../types/senselogic/sitevision/api/script/app/RestAppInvoker";
 import type { Node } from "../../types/javax/jcr/Node";
 
 /**
  * Creates RestAppInvoker instances.
  *
- * <h3>
- *    Some code examples
- * </h3>
- * <p>
- *    Below is an example of how to get a {@link RestAppInvoker} instance using the path (of the headless custom module).
- * </p><pre><code>   var restAppInvokerFactory = require('RestAppInvokerFactory'),
- *       restAppInvoker = restAppInvokerFactory.fromPath('/rest-api/my-rest-app');
+ *  <h3>
+ *     Some code examples
+ *  </h3>
+ *  <p>
+ *     Below is an example of how to get a {@link RestAppInvoker} instance using the path (of the headless custom module).
+ *  </p><pre><code>   var restAppInvokerFactory = require('RestAppInvokerFactory'),
+ *        restAppInvoker = restAppInvokerFactory.fromPath('/rest-api/my-rest-app');
  *
- *    if (restAppInvoker) {
- *       <em>// Use the RESTApp invoker...</em>
- *    }</code></pre>
+ *     if (restAppInvoker) {
+ *        <em>// Use the RESTApp invoker...</em>
+ *     }</code></pre>
  *
- * <p>
- *    Below is an example of how to get a {@link RestAppInvoker} instance using a Node. Note that the Node must be of type
- *    <code>sv:restApp</code>, <code>sv:headlessCustomModule</code> or <code>sv:marketplaceHeadlessCustomModule</code>.
- * </p><pre><code>   var restAppInvokerFactory = require('RestAppInvokerFactory'),
- *       restAppInvoker = restAppInvokerFactory.fromNode(aNode);
+ *  <p>
+ *     Below is an example of how to get a {@link RestAppInvoker} instance using a Node. Note that the Node must be of type
+ *     <code>sv:restApp</code>, <code>sv:headlessCustomModule</code> or <code>sv:marketplaceHeadlessCustomModule</code>.
+ *  </p><pre><code>   var restAppInvokerFactory = require('RestAppInvokerFactory'),
+ *        restAppInvoker = restAppInvokerFactory.fromNode(aNode);
  *
- *    if (restAppInvoker) {
- *       <em>// Use the RESTApp invoker...</em>
- *    }</code></pre>
+ *     if (restAppInvoker) {
+ *        <em>// Use the RESTApp invoker...</em>
+ *     }</code></pre>
  *
- * <p>
- *    Below is an example of how to get a {@link RestAppInvoker} instance using a Node identifier. Note that the identifier must be for a Node of type
- *    <code>sv:restApp</code>, <code>sv:headlessCustomModule</code> or <code>sv:marketplaceHeadlessCustomModule</code>
- *    (i.e. an identifier prefixed "361.", "188." or "211.").
- * </p><pre><code>   var restAppInvokerFactory = require('RestAppInvokerFactory'),
- *       restAppInvoker = restAppInvokerFactory.fromIdentifier(aIdentifier);
+ *  <p>
+ *     Below is an example of how to get a {@link RestAppInvoker} instance using a Node identifier. Note that the identifier must be for a Node of type
+ *     <code>sv:restApp</code>, <code>sv:headlessCustomModule</code> or <code>sv:marketplaceHeadlessCustomModule</code>
+ *     (i.e. an identifier prefixed "361.", "188." or "211.").
+ *  </p><pre><code>   var restAppInvokerFactory = require('RestAppInvokerFactory'),
+ *        restAppInvoker = restAppInvokerFactory.fromIdentifier(aIdentifier);
  *
- *    if (restAppInvoker) {
- *       <em>// Use the RESTApp invoker...</em>
- *    }</code></pre>
+ *     if (restAppInvoker) {
+ *        <em>// Use the RESTApp invoker...</em>
+ *     }</code></pre>
  *
- * <p>
- *    See {@link RestAppInvoker} for more code examples.
- * </p>
+ *  <p>
+ *     See {@link RestAppInvoker} for more code examples.
+ *  </p>
  * @param <O> script object
  * @author Magnus Lövgren
  * @since Sitevision 7
@@ -51,7 +52,7 @@ export interface RestAppInvokerFactory {
    * @param aPath the path of the Headless custom module (sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule)
    * @return the RestAppInvoker for the active RESTApp of the module, or null if no matching RESTApp could be found
    */
-  fromPath(aPath: string): RestAppInvoker;
+  fromPath(aPath: String | string): RestAppInvoker;
 
   /**
    * Creates a RestAppInvoker via a RESTApp Node or a Headless custom module Node.
@@ -62,10 +63,10 @@ export interface RestAppInvokerFactory {
 
   /**
    * Creates a RestAppInvoker via the Identifier of a RESTApp or a Headless custom module.
-   * @param aIdentifier the identifier of the RESTApp (sv:restApp) or the Headless custom module (sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule), i.e. an identifier prefixed with "361.", "188." or "211.".
+   * @param aIdentifier the identifier of the RESTApp (sv:restApp) or the Headless custom module&#xA; (sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule), i.e. an identifier&#xA; prefixed with "361.", "188." or "211.".
    * @return the RestAppInvoker for the resolved RESTApp, or null if no matching RESTApp could be found
    */
-  fromIdentifier(aIdentifier: string): RestAppInvoker;
+  fromIdentifier(aIdentifier: String | string): RestAppInvoker;
 }
 
 declare namespace RestAppInvokerFactory {}

package/server/RoleAssignmentBuilder/index.d.ts

@@ -5,16 +5,16 @@ import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder
 /**
  * Builder of RoleAssignment instances.
  *
- * <p>
- *    <em>Tip!</em> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
+ *  <p>
+ *     <em>Tip!</em> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *     more information about Builders and how to work with them!
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link RoleUtil#getRoleAssignmentBuilder()}.
- *    See {@link RoleUtil} for how to obtain an instance of the <code>RoleUtil</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link RoleUtil#getRoleAssignmentBuilder()}.
+ *     See {@link RoleUtil} for how to obtain an instance of the <code>RoleUtil</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 5.1
  * @see RoleAssignment
@@ -37,9 +37,9 @@ export interface RoleAssignmentBuilder extends Builder {
   /**
    * Clears the state of this builder.
    *
-   * <p>
-   *    Sets the <em>principal</em> and the <em>role</em> to null.
-   * </p>
+   *  <p>
+   *     Sets the <em>principal</em> and the <em>role</em> to null.
+   *  </p>
    * @return this builder
    */
   clear(): RoleAssignmentBuilder;

package/server/RoleMatcherBuilder/index.d.ts

@@ -5,16 +5,16 @@ import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder
 /**
  * Builder of RoleMatcher instances.
  *
- * <p>
- *    <em>Tip!</em> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
+ *  <p>
+ *     <em>Tip!</em> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *     more information about Builders and how to work with them!
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link RoleUtil#getRoleMatcherBuilder()}.
- *    See {@link RoleUtil} for how to obtain an instance of the <code>RoleUtil</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link RoleUtil#getRoleMatcherBuilder()}.
+ *     See {@link RoleUtil} for how to obtain an instance of the <code>RoleUtil</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 6.1
  */
@@ -36,9 +36,9 @@ export interface RoleMatcherBuilder extends Builder {
   /**
    * Clears the state of this builder.
    *
-   * <p>
-   *    Sets the <em>user</em> and the <em>roles</em> to null.
-   * </p>
+   *  <p>
+   *     Sets the <em>user</em> and the <em>roles</em> to null.
+   *  </p>
    * @return this builder
    */
   clear(): RoleMatcherBuilder;

package/server/RoleUtil/index.d.ts

@@ -1,16 +1,16 @@
 import type { RoleAssignmentBuilder } from "../RoleAssignmentBuilder";
 import type { RoleMatcherBuilder } from "../RoleMatcherBuilder";
-
+import type { String } from "../../types/java/lang/String";
 import type { Node } from "../../types/javax/jcr/Node";
 import type Permission from "../PermissionUtil.Permission";
 
 /**
  * Role utility interface.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getRoleUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getRoleUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 5.1
  * @see PermissionUtil
@@ -34,7 +34,7 @@ export interface RoleUtil {
    * @param aRoleName the name of the role
    * @return the role (sv:role) with name aRoleName, or null if no such role could be found
    */
-  getRoleByName(aRoleName: string): Node;
+  getRoleByName(aRoleName: String | string): Node;
 
   /**
    * Checks if a role contains a specific permission.