@sitevision/api 2.0.0-alpha.1 → 2023.2.1-alpha.0

package/server/RestApi/index.d.ts

@@ -1,139 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Executes a GET endpoint of the REST API.
- *
- * <p>
- *    <em>REST hint!</em> A <em>get</em> typically indicates a <em>read</em> of something.
- * </p>
- * @param aContextNode the endpoint context Node
- * @param aOperationName the endpoint operation name/method
- * @return a script object representing the response (properties: statusCode, statusMessage, body)
- */
-export function get(aContextNode: Node, aOperationName: string): unknown;
-
-/**
- * Executes a GET endpoint of the REST API.
- *
- * <p>
- *    <em>REST hint!</em> A <em>get</em> typically indicates a <em>read</em> of something.
- * </p>
- * @param aContextNode the endpoint context Node
- * @param aOperationName the endpoint operation name/method
- * @param aOperationOptions the operation data/parameters
- * @return a script object representing the response (properties: statusCode, statusMessage, body)
- */
-export function get(
-  aContextNode: Node,
-  aOperationName: string,
-  aOperationOptions: unknown
-): unknown;
-
-/**
- * Executes a GET endpoint of the REST API, targeting an instance of the context.
- *
- * <p>
- *    <em>REST hint!</em> A <em>get</em> typically indicates a <em>read</em> of something.
- * </p>
- * @param aContextNode the endpoint context Node
- * @param aOperationName the endpoint operation name/method
- * @param aOperationNode the operation Node of the context
- * @param aOperationOptions the operation data/parameters
- * @return a script object representing the response (properties: statusCode, statusMessage, body)
- */
-export function get(
-  aContextNode: Node,
-  aOperationName: string,
-  aOperationNode: Node,
-  aOperationOptions: unknown
-): unknown;
-
-/**
- * Executes a POST endpoint of the REST API.
- *
- * <p>
- *    <em>REST hint!</em> A <em>post</em> typically indicates the <em>creation</em> of something.
- * </p>
- * @param aContextNode the endpoint context Node
- * @param aOperationName the endpoint operation name/method
- * @param aOperationOptions the operation data/parameters
- * @return a script object representing the response (properties: statusCode, statusMessage, body)
- */
-export function post(
-  aContextNode: Node,
-  aOperationName: string,
-  aOperationOptions: unknown
-): unknown;
-
-/**
- * Executes a PUT endpoint of the REST API.
- *
- * <p>
- *    <em>REST hint!</em> A <em>put</em> typically indicates an <em>update</em> of something.
- * </p>
- * @param aContextNode the endpoint context Node
- * @param aOperationName the endpoint operation name/method
- * @param aOperationOptions the operation data/parameters
- * @return a script object representing the response (properties: statusCode, statusMessage, body)
- * @since Sitevision 5
- */
-export function put(
-  aContextNode: Node,
-  aOperationName: string,
-  aOperationOptions: unknown
-): unknown;
-
-/**
- * Executes a PUT endpoint of the REST API, targeting an instance of the context.
- *
- * <p>
- *    <em>REST hint!</em> A <em>put</em> typically indicates an <em>update</em> of something.
- * </p>
- * @param aContextNode the endpoint context Node
- * @param aOperationName the endpoint operation name/method
- * @param aOperationNode the operation Node of the context
- * @param aOperationOptions the operation data/parameters
- * @return a script object representing the response (properties: statusCode, statusMessage, body)
- */
-export function put(
-  aContextNode: Node,
-  aOperationName: string,
-  aOperationNode: Node,
-  aOperationOptions: unknown
-): unknown;
-
-/**
- * Executes a DELETE endpoint of the REST API.
- *
- * <p>
- *    <em>REST hint!</em> A <em>delete</em> typically indicates a <em>removal</em> of something.
- * </p>
- * @param aContextNode the endpoint context Node
- * @param aOperationName the endpoint operation name/method
- * @return a script object representing the response (properties: statusCode, statusMessage, body)
- * @since Sitevision 4.5.1
- */
-export function _delete(aContextNode: Node, aOperationName: string): unknown;
-
-/**
- * Executes a DELETE endpoint of the REST API, targeting an instance of the context.
- *
- * <p>
- *    <em>REST hint!</em> A <em>delete</em> typically indicates a <em>removal</em> of something.
- * </p>
- * @param aContextNode the endpoint context Node
- * @param aOperationName the endpoint operation name/method
- * @param aOperationNode the operation Node of the context
- * @return a script object representing the response (properties: statusCode, statusMessage, body)
- */
-export function _delete(
-  aContextNode: Node,
-  aOperationName: string,
-  aOperationNode: Node
-): unknown;
-
-export { _delete as delete };
-
 /**
  * Script utility for server-side invoke of the local Sitevision REST API.
  *
@@ -193,8 +59,162 @@ export { _delete as delete };
  * @see Requester
  * @see senselogic.sitevision.api.script.app.RestAppInvoker
  */
-declare namespace restApi {
-  export { get, post, put, _delete as delete };
+export interface RestApi {
+  /**
+   * Executes a GET endpoint of the REST API.
+   *
+   * <p>
+   *    <em>REST hint!</em> A <em>get</em> typically indicates a <em>read</em> of something.
+   * </p>
+   * @param aContextNode the endpoint context Node
+   * @param aOperationName the endpoint operation name/method
+   * @return a script object representing the response (properties: statusCode, statusMessage, body)
+   */
+  get(aContextNode: Node, aOperationName: string): unknown;
+
+  /**
+   * Executes a GET endpoint of the REST API.
+   *
+   * <p>
+   *    <em>REST hint!</em> A <em>get</em> typically indicates a <em>read</em> of something.
+   * </p>
+   * @param aContextNode the endpoint context Node
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationOptions the operation data/parameters
+   * @return a script object representing the response (properties: statusCode, statusMessage, body)
+   */
+  get(
+    aContextNode: Node,
+    aOperationName: string,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a GET endpoint of the REST API, targeting an instance of the context.
+   *
+   * <p>
+   *    <em>REST hint!</em> A <em>get</em> typically indicates a <em>read</em> of something.
+   * </p>
+   * @param aContextNode the endpoint context Node
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationNode the operation Node of the context
+   * @param aOperationOptions the operation data/parameters
+   * @return a script object representing the response (properties: statusCode, statusMessage, body)
+   */
+  get(
+    aContextNode: Node,
+    aOperationName: string,
+    aOperationNode: Node,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a POST endpoint of the REST API.
+   *
+   * <p>
+   *    <em>REST hint!</em> A <em>post</em> typically indicates the <em>creation</em> of something.
+   * </p>
+   * @param aContextNode the endpoint context Node
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationOptions the operation data/parameters
+   * @return a script object representing the response (properties: statusCode, statusMessage, body)
+   */
+  post(
+    aContextNode: Node,
+    aOperationName: string,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a PUT endpoint of the REST API.
+   *
+   * <p>
+   *    <em>REST hint!</em> A <em>put</em> typically indicates an <em>update</em> of something.
+   * </p>
+   * @param aContextNode the endpoint context Node
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationOptions the operation data/parameters
+   * @return a script object representing the response (properties: statusCode, statusMessage, body)
+   * @since Sitevision 5
+   */
+  put(
+    aContextNode: Node,
+    aOperationName: string,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a PUT endpoint of the REST API, targeting an instance of the context.
+   *
+   * <p>
+   *    <em>REST hint!</em> A <em>put</em> typically indicates an <em>update</em> of something.
+   * </p>
+   * @param aContextNode the endpoint context Node
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationNode the operation Node of the context
+   * @param aOperationOptions the operation data/parameters
+   * @return a script object representing the response (properties: statusCode, statusMessage, body)
+   */
+  put(
+    aContextNode: Node,
+    aOperationName: string,
+    aOperationNode: Node,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a DELETE endpoint of the REST API.
+   *
+   * <p>
+   *    <em>REST hint!</em> A <em>delete</em> typically indicates a <em>removal</em> of something.
+   * </p>
+   * @param aContextNode the endpoint context Node
+   * @param aOperationName the endpoint operation name/method
+   * @return a script object representing the response (properties: statusCode, statusMessage, body)
+   * @since Sitevision 4.5.1
+   */
+  delete(aContextNode: Node, aOperationName: string): unknown;
+
+  /**
+   * Executes a DELETE endpoint of the REST API, targeting an instance of the context.
+   *
+   * <p>
+   *    <em>REST hint!</em> A <em>delete</em> typically indicates a <em>removal</em> of something.
+   * </p>
+   * @param aContextNode the endpoint context Node
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationNode the operation Node of the context
+   * @return a script object representing the response (properties: statusCode, statusMessage, body)
+   */
+  delete(
+    aContextNode: Node,
+    aOperationName: string,
+    aOperationNode: Node
+  ): unknown;
+
+  /**
+   * Executes a DELETE endpoint of the REST API, targeting an instance of the context.
+   *
+   * <p>
+   *    <em>REST hint!</em> A <em>delete</em> typically indicates a <em>removal</em> of something.
+   * </p>
+   * @param aContextNode the endpoint context Node
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationNode the operation Node of the context
+   * @param aOperationOptions the operation data/parameters
+   * @return a script object representing the response (properties: statusCode, statusMessage, body)
+   * @since Sitevision 2023.01.1
+   */
+  delete(
+    aContextNode: Node,
+    aOperationName: string,
+    aOperationNode: Node,
+    aOperationOptions: unknown
+  ): unknown;
 }
 
+declare namespace RestApi {}
+
+declare var restApi: RestApi;
+
 export default restApi;

package/server/RestAppInvokerFactory/index.d.ts

@@ -1,27 +1,6 @@
 import type { RestAppInvoker } from "../../types/senselogic/sitevision/api/script/app/RestAppInvoker";
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Creates a RestAppInvoker via the Path of a Headless custom module.
- * @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
- */
-export function fromPath(aPath: string): RestAppInvoker;
-
-/**
- * Creates a RestAppInvoker via a RESTApp Node or a Headless custom module Node.
- * @param aNode the RESTApp (sv:restApp) or the Headless custom module (sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule)
- * @return the RestAppInvoker for the RESTApp, or null if no matching RESTApp could be found
- */
-export function fromNode(aNode: Node): RestAppInvoker;
-
-/**
- * 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.".
- * @return the RestAppInvoker for the resolved RESTApp, or null if no matching RESTApp could be found
- */
-export function fromIdentifier(aIdentifier: string): RestAppInvoker;
-
 /**
  * Creates RestAppInvoker instances.
  *
@@ -66,8 +45,31 @@ export function fromIdentifier(aIdentifier: string): RestAppInvoker;
  * @since Sitevision 7
  * @see RestAppInvoker
  */
-declare namespace restAppInvokerFactory {
-  export { fromPath, fromNode, fromIdentifier };
+export interface RestAppInvokerFactory {
+  /**
+   * Creates a RestAppInvoker via the Path of a Headless custom module.
+   * @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;
+
+  /**
+   * Creates a RestAppInvoker via a RESTApp Node or a Headless custom module Node.
+   * @param aNode the RESTApp (sv:restApp) or the Headless custom module (sv:headlessCustomModule or sv:marketplaceHeadlessCustomModule)
+   * @return the RestAppInvoker for the RESTApp, or null if no matching RESTApp could be found
+   */
+  fromNode(aNode: Node): RestAppInvoker;
+
+  /**
+   * 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.".
+   * @return the RestAppInvoker for the resolved RESTApp, or null if no matching RESTApp could be found
+   */
+  fromIdentifier(aIdentifier: string): RestAppInvoker;
 }
 
+declare namespace RestAppInvokerFactory {}
+
+declare var restAppInvokerFactory: RestAppInvokerFactory;
+
 export default restAppInvokerFactory;

package/server/RoleAssignmentBuilder/index.d.ts

@@ -2,37 +2,6 @@ import type { Node } from "../../types/javax/jcr/Node";
 import type { RoleAssignment } from "../../types/senselogic/sitevision/api/security/RoleAssignment";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * Sets the principal (sv:user, sv:simpleUser, sv:userGroup or sv:virtualGroup).
- * @param aPrincipal the principal
- * @return this builder
- */
-export function setPrincipal(aPrincipal: Node): RoleAssignmentBuilder;
-
-/**
- * Sets the role (sv:role).
- * @param aRole the role
- * @return this builder
- */
-export function setRole(aRole: Node): RoleAssignmentBuilder;
-
-/**
- * Clears the state of this builder.
- *
- * <p>
- *    Sets the <em>principal</em> and the <em>role</em> to null.
- * </p>
- * @return this builder
- */
-export function clear(): RoleAssignmentBuilder;
-
-/**
- * Creates a read-only RoleAssignment instance using current state of this builder.
- * @return a RoleAssignment instance
- * @throws IllegalStateException if role and/or principal is not properly set
- */
-export function build(): RoleAssignment;
-
 /**
  * Builder of RoleAssignment instances.
  *
@@ -50,8 +19,41 @@ export function build(): RoleAssignment;
  * @since Sitevision 5.1
  * @see RoleAssignment
  */
-declare namespace roleAssignmentBuilder {
-  export { setPrincipal, setRole, clear, build };
+export interface RoleAssignmentBuilder extends Builder {
+  /**
+   * Sets the principal (sv:user, sv:simpleUser, sv:userGroup or sv:virtualGroup).
+   * @param aPrincipal the principal
+   * @return this builder
+   */
+  setPrincipal(aPrincipal: Node): RoleAssignmentBuilder;
+
+  /**
+   * Sets the role (sv:role).
+   * @param aRole the role
+   * @return this builder
+   */
+  setRole(aRole: Node): RoleAssignmentBuilder;
+
+  /**
+   * Clears the state of this builder.
+   *
+   * <p>
+   *    Sets the <em>principal</em> and the <em>role</em> to null.
+   * </p>
+   * @return this builder
+   */
+  clear(): RoleAssignmentBuilder;
+
+  /**
+   * Creates a read-only RoleAssignment instance using current state of this builder.
+   * @return a RoleAssignment instance
+   * @throws IllegalStateException if role and/or principal is not properly set
+   */
+  build(): RoleAssignment;
 }
 
+declare namespace RoleAssignmentBuilder {}
+
+declare var roleAssignmentBuilder: RoleAssignmentBuilder;
+
 export default roleAssignmentBuilder;

package/server/RoleMatcherBuilder/index.d.ts

@@ -2,37 +2,6 @@ import type { Node } from "../../types/javax/jcr/Node";
 import type { RoleMatcher } from "../../types/senselogic/sitevision/api/security/RoleMatcher";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
-/**
- * Sets the user (sv:user, sv:simpleUser).
- * @param aUser the user
- * @return this builder
- */
-export function setUser(aUser: Node): RoleMatcherBuilder;
-
-/**
- * Adds a role (sv:role).
- * @param aRole the role to add
- * @return this builder
- */
-export function addRole(aRole: Node): RoleMatcherBuilder;
-
-/**
- * Clears the state of this builder.
- *
- * <p>
- *    Sets the <em>user</em> and the <em>roles</em> to null.
- * </p>
- * @return this builder
- */
-export function clear(): RoleMatcherBuilder;
-
-/**
- * Creates a read-only RoleMatcher instance using current state of this builder.
- * @return a RoleMatcher instance
- * @throws IllegalStateException if user is not properly set or if no roles are added
- */
-export function build(): RoleMatcher;
-
 /**
  * Builder of RoleMatcher instances.
  *
@@ -49,8 +18,41 @@ export function build(): RoleMatcher;
  * @author Magnus Lövgren
  * @since Sitevision 6.1
  */
-declare namespace roleMatcherBuilder {
-  export { setUser, addRole, clear, build };
+export interface RoleMatcherBuilder extends Builder {
+  /**
+   * Sets the user (sv:user, sv:simpleUser).
+   * @param aUser the user
+   * @return this builder
+   */
+  setUser(aUser: Node): RoleMatcherBuilder;
+
+  /**
+   * Adds a role (sv:role).
+   * @param aRole the role to add
+   * @return this builder
+   */
+  addRole(aRole: Node): RoleMatcherBuilder;
+
+  /**
+   * Clears the state of this builder.
+   *
+   * <p>
+   *    Sets the <em>user</em> and the <em>roles</em> to null.
+   * </p>
+   * @return this builder
+   */
+  clear(): RoleMatcherBuilder;
+
+  /**
+   * Creates a read-only RoleMatcher instance using current state of this builder.
+   * @return a RoleMatcher instance
+   * @throws IllegalStateException if user is not properly set or if no roles are added
+   */
+  build(): RoleMatcher;
 }
 
+declare namespace RoleMatcherBuilder {}
+
+declare var roleMatcherBuilder: RoleMatcherBuilder;
+
 export default roleMatcherBuilder;

package/server/RoleUtil/index.d.ts

@@ -1,35 +1,8 @@
-import RoleAssignmentBuilder from "../RoleAssignmentBuilder";
-import RoleMatcherBuilder from "../RoleMatcherBuilder";
+import type { RoleAssignmentBuilder } from "../RoleAssignmentBuilder";
+import type { RoleMatcherBuilder } from "../RoleMatcherBuilder";
 
 import type { Node } from "../../types/javax/jcr/Node";
-
-/**
- * Creates a RoleAssignmentBuilder instance.
- * @return a RoleAssignmentBuilder
- */
-export function getRoleAssignmentBuilder(): RoleAssignmentBuilder;
-
-/**
- * Creates a RoleMatcherBuilder instance.
- * @return a RoleMatcherBuilder
- * @since Sitevision 6.1
- */
-export function getRoleMatcherBuilder(): RoleMatcherBuilder;
-
-/**
- * Gets a role by name.
- * @param aRoleName the name of the role
- * @return the role (sv:role) with name aRoleName, or null if no such role could be found
- */
-export function getRoleByName(aRoleName: string): Node;
-
-/**
- * Checks if a role contains a specific permission.
- * @param aRole the role (sv:role)
- * @param aPermission the permission
- * @return true if aRole is a sv:role and contains aPermission, false otherwise
- */
-export function containsPermission(aRole: Node, aPermission: unknown): boolean;
+import type Permission from "../PermissionUtil.Permission";
 
 /**
  * Role utility interface.
@@ -42,13 +15,38 @@ export function containsPermission(aRole: Node, aPermission: unknown): boolean;
  * @since Sitevision 5.1
  * @see PermissionUtil
  */
-declare namespace roleUtil {
-  export {
-    getRoleAssignmentBuilder,
-    getRoleMatcherBuilder,
-    getRoleByName,
-    containsPermission,
-  };
+export interface RoleUtil {
+  /**
+   * Creates a RoleAssignmentBuilder instance.
+   * @return a RoleAssignmentBuilder
+   */
+  getRoleAssignmentBuilder(): RoleAssignmentBuilder;
+
+  /**
+   * Creates a RoleMatcherBuilder instance.
+   * @return a RoleMatcherBuilder
+   * @since Sitevision 6.1
+   */
+  getRoleMatcherBuilder(): RoleMatcherBuilder;
+
+  /**
+   * Gets a role by name.
+   * @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;
+
+  /**
+   * Checks if a role contains a specific permission.
+   * @param aRole the role (sv:role)
+   * @param aPermission the permission
+   * @return true if aRole is a sv:role and contains aPermission, false otherwise
+   */
+  containsPermission(aRole: Node, aPermission: Permission): boolean;
 }
 
+declare namespace RoleUtil {}
+
+declare var roleUtil: RoleUtil;
+
 export default roleUtil;