@sitevision/api 2024.4.1 → 2024.7.1

package/index.d.ts

@@ -6,6 +6,7 @@ import './server/AuthenticationUtil';
 import './server/BookmarkUtil';
 import './server/BuddyIconRenderer';
 import './server/BuddyIconRenderer.BuddyIconSize';
+import './server/ChannelUtil';
 import './server/ClientUtil';
 import './server/CollaborationFactory';
 import './server/CollaborationGroupFolderUtil';
@@ -90,6 +91,7 @@ import './server/RelatedValueBuilder';
 import './server/Requester';
 import './server/ResourceLocatorUtil';
 import './server/RestApi';
+import './server/RestApiFactory';
 import './server/RestAppInvokerFactory';
 import './server/RoleAssignmentBuilder';
 import './server/RoleMatcherBuilder';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2024.4.1",
+  "version": "2024.7.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -30,5 +30,5 @@
     "access": "public",
     "directory": "dist"
   },
-  "gitHead": "0ef25a4ec69f61d6d22596673a57e0ad771edf70"
+  "gitHead": "fcd74122108f19e03a0a9db51efc16286fc7a802"
 }

package/server/ChannelUtil/index.d.ts

@@ -0,0 +1,73 @@
+import type { String } from "../../types/java/lang/String";
+
+import type { Node } from "../../types/javax/jcr/Node";
+
+/**
+ * Channel utility interface.
+ *
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link MessagesFactory#getChannelUtil()}.
+ *     See {@link MessagesFactory} for how to obtain an instance of the <code>MessagesFactory</code> interface.
+ *  </p>
+ * @author Elias Abrache
+ * @since Sitevision 2024.05.01
+ */
+export interface ChannelUtil {
+  /**
+   * Creates a channel.
+   *  <p>
+   *     A <code>ConstraintViolationException</code> will be thrown if social collaboration is not enabled
+   *     Or if current user is attempting to create a private channel without
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_PRIVATE_CHANNELS} permission.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>IllegalArgumentException</code> will be thrown if aName is null, blank or exceeds 80 characters.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>ItemExistsException</code> will be thrown if a channel with the same name already exists.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>RepositoryException</code> will be thrown If an error occurs while fetching channels
+   *  </p>
+   * @param aName the name of the channel (Must be unique and must not exceed 80 characters)
+   * @param aDescription the description of the channel
+   * @param aPrivate whether the channel should be private or not
+   * @throws RepositoryException if an error occurs.
+   * @return a channel wrapper for the newly created <code>channel</code>, or <code>null</code>.
+   */
+  createChannel(
+    aName: String | string,
+    aDescription: String | string,
+    aPrivate: boolean
+  ): Node;
+
+  /**
+   * Searches for a channel by name.
+   *
+   *  <p>
+   *     <em>Permission note</em> Private channels can only be found by members.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>ConstraintViolationException</code> will be thrown if social collaboration is not enabled.
+   *  </p>
+   *
+   *  <p>
+   *     A <code>RepositoryException</code> will be thrown if an error occurs while fetching channels.
+   *  </p>
+   * @return the channel node, or null.
+   * @param aChannelName the name of the channel to search for.
+   * @throws RepositoryException if an error occurs.
+   */
+  findChannelByName(aChannelName: String | string): Node;
+}
+
+declare namespace ChannelUtil {}
+
+declare var channelUtil: ChannelUtil;
+
+export default channelUtil;

package/server/ChannelUtil/index.js

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

package/server/ImageUtil/index.d.ts

@@ -266,6 +266,42 @@ export interface ImageUtil {
    * @since Sitevision 4.5.5.2
    */
   toBase64(aImage: Node): string;
+
+  /**
+   * Sets the alt property for an image Node.
+   *
+   *  <p>
+   *     <strong>Permission note!</strong> Current user (the invoker of this method) must have
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE} permission
+   *     on the image node that should be updated. <em>Updating an image for a <code>sv:userIdentity</code> requires
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES MANAGE_USER_IDENTITIES} permission
+   *     on current page.</em>
+   *  </p>
+   * @param aImage the sv:image Node, may not be null
+   * @param aAltText the alt text to set
+   * @throws ConstraintViolationException if aImage is not a sv:image or if current user is not authorized to alter the image node
+   * @throws RepositoryException if something else goes wrong
+   * @since Sitevision 2024.06.1
+   */
+  setAltText(aImage: Node, aAltText: String | string): void;
+
+  /**
+   * Sets the caption property for an image Node.
+   *
+   *  <p>
+   *     <strong>Permission note!</strong> Current user (the invoker of this method) must have
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE} permission
+   *     on the image node that should be updated. <em>Updating an image for a <code>sv:userIdentity</code> requires
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES MANAGE_USER_IDENTITIES} permission
+   *     on current page.</em>
+   *  </p>
+   * @param aImage the sv:image Node, may not be null
+   * @param aCaptionText the caption text to set
+   * @throws ConstraintViolationException if aImage is not a sv:image or if current user is not authorized to alter the image node
+   * @throws RepositoryException if something else goes wrong
+   * @since Sitevision 2024.06.1
+   */
+  setCaptionText(aImage: Node, aCaptionText: String | string): void;
 }
 
 declare namespace ImageUtil {}

package/server/ImageUtil/index.js

@@ -13,6 +13,8 @@ var _default = {
   updateBinaryContentFromBase64: function updateBinaryContentFromBase64() {},
   updateBinaryContentFromTemporary: function updateBinaryContentFromTemporary() {},
   renameImage: function renameImage() {},
-  toBase64: function toBase64() {}
+  toBase64: function toBase64() {},
+  setAltText: function setAltText() {},
+  setCaptionText: function setCaptionText() {}
 };
 exports["default"] = _default;

package/server/MessagesFactory/index.d.ts

@@ -1,3 +1,4 @@
+import type { ChannelUtil } from "../ChannelUtil";
 import type { Node } from "../../types/javax/jcr/Node";
 import type { ChannelWrapper } from "../../types/senselogic/sitevision/api/message/ChannelWrapper";
 
@@ -13,6 +14,13 @@ import type { ChannelWrapper } from "../../types/senselogic/sitevision/api/messa
  * @since Sitevision 2024.03.01
  */
 export interface MessagesFactory {
+  /**
+   * Gets an instance of a channel utility class.
+   * @return a channel utility class
+   * @since Sitevision 2024.05.01
+   */
+  getChannelUtil(): ChannelUtil;
+
   /**
    * Gets a wrapper for the specified channel.
    * @param aChannel the channel node (node of type sv:topic).

package/server/MessagesFactory/index.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
+  getChannelUtil: function getChannelUtil() {},
   getChannelWrapper: function getChannelWrapper() {}
 };
 exports["default"] = _default;

package/server/NodeTypeUtil/index.d.ts

@@ -1194,6 +1194,18 @@ export interface NodeTypeUtil extends NodeTypeUtilConstants {
    */
   WIDGET_CUSTOM_MODULE_TYPE: "sv:widgetCustomModule";
 
+  /**
+   * The primary node type name for the css rule repository type.
+   * @since Sitevision 2024.04.2
+   */
+  CSS_RULE_REPOSITORY_TYPE: "sv:cssRuleRepository";
+
+  /**
+   * The primary node type name for the css rule type.
+   * @since Sitevision 2024.04.2
+   */
+  CSS_RULE_TYPE: "sv:cssRule";
+
   /**
    * Checks if a node is a layout.
    * @param aNode the node to be checked

package/server/ResourceLocatorUtil/index.d.ts

@@ -467,6 +467,13 @@ export interface ResourceLocatorUtil {
    * @since Sitevision 2023.09.2
    */
   getWorkStatusTemplateRepository(): Node;
+
+  /**
+   * Gets the css rule repository (sv:cssRuleRepository) for the site of current node.
+   * @return the css rule repository, or null if indeterminable.
+   * @since Sitevision 2024.04.2
+   */
+  getCssRuleRepository(): Node;
 }
 
 declare namespace ResourceLocatorUtil {}

package/server/ResourceLocatorUtil/index.js

@@ -48,6 +48,7 @@ var _default = {
   getAliasRepository: function getAliasRepository() {},
   getSiteCookieRepository: function getSiteCookieRepository() {},
   getImageFilterRepository: function getImageFilterRepository() {},
-  getWorkStatusTemplateRepository: function getWorkStatusTemplateRepository() {}
+  getWorkStatusTemplateRepository: function getWorkStatusTemplateRepository() {},
+  getCssRuleRepository: function getCssRuleRepository() {}
 };
 exports["default"] = _default;

package/server/RestApi/index.d.ts

@@ -2,11 +2,11 @@ import type { Node } from "../../types/javax/jcr/Node";
 import type { String } from "../../types/java/lang/String";
 
 /**
- * Script utility for server-side invoke of the local Sitevision REST API.
+ * Script utility for server-side invoke of the local
+ *  <a href="https://developer.sitevision.se/docs/rest-api/model-rest-api" target="_blank">Sitevision REST API</a>.
  *
  *  <p>
- *     This is a local, server-side, inbound utility to invoke the
- *     <a href="https://developer.sitevision.se/docs/rest-api/model-rest-api" target="_blank">Sitevision REST API</a>
+ *     This is a local, server-side, inbound utility to invoke the Sitevision REST API
  *     of the local site without any outgoing http connections.
  *     This utility can be used regardless of the REST API of the local site is enabled or not!
  *  </p>
@@ -46,6 +46,10 @@ import type { String } from "../../types/java/lang/String";
  *  </p>
  *  <ul>
  *     <li>
+ *        To execute endpoints in the REST API with a <em>fixed version</em> (ONLINE / OFFLINE) should typically be handled via
+ *        {@link VersionedRestApi}.
+ *     </li>
+ *     <li>
  *        Server-side invoke of a <em>local RESTApp</em> should typically be handled via
  *        {@link senselogic.sitevision.api.script.app.RestAppInvoker}.
  *     </li>
@@ -57,6 +61,7 @@ import type { String } from "../../types/java/lang/String";
  * @param <O> script object
  * @author Magnus Lövgren
  * @since Sitevision 4.5
+ * @see VersionedRestApi
  * @see Requester
  * @see senselogic.sitevision.api.script.app.RestAppInvoker
  */

package/server/RestApiFactory/index.d.ts

@@ -0,0 +1,70 @@
+import type { RestApi } from "../RestApi";
+import type { VersionedRestApi } from "../../types/senselogic/sitevision/api/script/VersionedRestApi";
+
+/**
+ * Factory for creating server-side invokers of the local
+ *  <a href="https://developer.sitevision.se/docs/rest-api/model-rest-api" target="_blank">Sitevision REST API</a>.
+ *
+ *  <p>
+ *     <strong>REST siblings note!</strong>
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        Server-side invoke of a <em>local RESTApp</em> should typically be handled via
+ *        {@link senselogic.sitevision.api.script.app.RestAppInvoker}.
+ *     </li>
+ *     <li>
+ *        Invoking <em>external REST API:s</em> should typically be handled via
+ *        {@link senselogic.sitevision.api.script.Requester}.
+ *     </li>
+ *  </ul>
+ * @param <O> script object
+ * @author Magnus Lövgren
+ * @since Sitevision 2024.04.2
+ */
+export interface RestApiFactory {
+  /**
+   * Gets the RestApi utility.
+   *
+   *  <p>
+   *     The returned utility invokes the local REST API in
+   *     <strong>{@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion() current version}</strong>.
+   *  </p>
+   * @return the RestApi utility
+   */
+  getRestApi(): RestApi;
+
+  /**
+   * Gets the Versioned RestApi utility for the <strong>ONLINE</strong> version.
+   *
+   *  <p>
+   *     The returned utility always invokes the local REST API in the
+   *     <strong>{@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION ONLINE version}</strong>.
+   *  </p>
+   *  <p>
+   *     <em>Related info: URI prefix for the REST API in the ONLINE version is: <code>/rest-api/1/<strong>1</strong>/</code></em>
+   *  </p>
+   * @return the VersionedRestApi for the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION ONLINE version}
+   */
+  getOnlineRestApi(): VersionedRestApi;
+
+  /**
+   * Gets the Versioned RestApi utility for the <strong>OFFLINE</strong> version.
+   *
+   *  <p>
+   *     The returned utility always invokes the local REST API in the
+   *     <strong>{@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE version}</strong>.
+   *  </p>
+   *  <p>
+   *     <em>Related info: URI prefix for the REST API in the OFFLINE version is: <code>/rest-api/1/<strong>0</strong>/</code></em>
+   *  </p>
+   * @return the VersionedRestApi for the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE version}
+   */
+  getOfflineRestApi(): VersionedRestApi;
+}
+
+declare namespace RestApiFactory {}
+
+declare var restApiFactory: RestApiFactory;
+
+export default restApiFactory;

package/server/RestApiFactory/index.js

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

package/server/appData/index.d.ts

@@ -4,6 +4,7 @@ export interface AppData {
   get(...key: string[]): unknown;
   getNode(key: string): Node;
   getArray(key: string): Node[];
+  getNumber(key: string): number;
 }
 
 declare namespace AppData {}

package/server/appData/index.js

@@ -7,6 +7,7 @@ exports["default"] = void 0;
 var _default = {
   get: function get() {},
   getArray: function getArray() {},
-  getNode: function getNode() {}
+  getNode: function getNode() {},
+  getNumber: function getNumber() {}
 };
 exports["default"] = _default;

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

@@ -1,5 +1,6 @@
 import type { Node } from "../../../../../javax/jcr/Node";
 
+import type { String } from "../../../../../java/lang/String";
 import type { Wrapper } from "../../base/Wrapper";
 
 /**
@@ -34,8 +35,9 @@ export type ChannelWrapper = Wrapper & {
    *     <strong>Permission notes!</strong>
    *  </p>
    *  <p>
-   *     <em>Open channels</em> require the operating user to either have membership or the
-   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission.
+   *     <em>Open channels</em> require the operating user to have either membership or the
+   *      {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission
+   *      when adding members other than self.
    *  </p>
    *  <p>
    *     <em>Private channels</em> require the operating user to have membership.
@@ -88,4 +90,42 @@ export type ChannelWrapper = Wrapper & {
    * @return true if aUserIdentity was removed as member from the wrapped channel, false otherwise.&#xA; false is always returned if aUserIdentity is null or not a member of the wrapped channel.
    */
   removeMember(aUserIdentity: Node): boolean;
+
+  /**
+   * Checks if a user identity is a member of the wrapped channel.
+   * @param aUserIdentity a user identity (or user)
+   * @return true if aUserIdentity is a member of the wrapped channel, false otherwise.&#xA; false is always returned if aUserIdentity is null.
+   * @since Sitevision 2024.05.01
+   */
+  isMember(aUserIdentity: Node): boolean;
+
+  /**
+   * Alters the name of the wrapped channel.
+   *
+   *  <p>
+   *     <em>Permission note</em> Only the author or members with the
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission can alter the channel name.
+   *  </p>
+   *
+   *  <p>
+   *     The new channel name most not exceed 80 characters in length and must be unique otherwise false will be returned.
+   *  </p>
+   * @param aChannelName the new name of the channel
+   * @return true if channel could be renamed to aChannelName, false otherwise.
+   * @since Sitevision 2024.05.01
+   */
+  renameChannel(aChannelName: String | string): boolean;
+
+  /**
+   * Alters the description of the wrapped channel.
+   *
+   *  <p>
+   *     <em>Permission note</em> Only the author or members with the
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_CHANNELS} permission can alter the channel description.
+   *  </p>
+   * @param aChannelDescription the new description of the channel
+   * @return true if channel description was set to aChannelDescription, false otherwise.
+   * @since Sitevision 2024.05.01
+   */
+  setChannelDescription(aChannelDescription: String | string): boolean;
 };

package/types/senselogic/sitevision/api/message/ChannelWrapper/index.js

@@ -6,6 +6,9 @@ Object.defineProperty(exports, "__esModule", {
 exports["default"] = void 0;
 var _default = {
   addMember: function addMember() {},
-  removeMember: function removeMember() {}
+  removeMember: function removeMember() {},
+  isMember: function isMember() {},
+  renameChannel: function renameChannel() {},
+  setChannelDescription: function setChannelDescription() {}
 };
 exports["default"] = _default;

package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts

@@ -1324,4 +1324,18 @@ export type NodeTypeUtilConstants = {
    * @since Sitevision 2024.02.1
    */
   getWIDGET_CUSTOM_MODULE_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#CSS_RULE_REPOSITORY_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#CSS_RULE_REPOSITORY_TYPE}
+   * @since Sitevision 2024.04.2
+   */
+  getCSS_RULE_REPOSITORY_TYPE(): string;
+
+  /**
+   * Get accessor for {@link senselogic.sitevision.api.node.NodeTypeUtil#CSS_RULE_TYPE}.
+   * @return {@link senselogic.sitevision.api.node.NodeTypeUtil#CSS_RULE_TYPE}
+   * @since Sitevision 2024.04.2
+   */
+  getCSS_RULE_TYPE(): string;
 };

package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js

@@ -196,6 +196,8 @@ var _default = {
   getWORK_STATUS_TEMPLATE_TYPE: function getWORK_STATUS_TEMPLATE_TYPE() {},
   getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE: function getWORK_STATUS_TEMPLATE_REPOSITORY_TYPE() {},
   getDASHBOARD_TYPE: function getDASHBOARD_TYPE() {},
-  getWIDGET_CUSTOM_MODULE_TYPE: function getWIDGET_CUSTOM_MODULE_TYPE() {}
+  getWIDGET_CUSTOM_MODULE_TYPE: function getWIDGET_CUSTOM_MODULE_TYPE() {},
+  getCSS_RULE_REPOSITORY_TYPE: function getCSS_RULE_REPOSITORY_TYPE() {},
+  getCSS_RULE_TYPE: function getCSS_RULE_TYPE() {}
 };
 exports["default"] = _default;

package/types/senselogic/sitevision/api/script/VersionedRestApi/index.d.ts

@@ -0,0 +1,225 @@
+import type { String } from "../../../../../java/lang/String";
+
+/**
+ * Script utility for server-side invoke of the local
+ *  <a href="https://developer.sitevision.se/docs/rest-api/model-rest-api" target="_blank">Sitevision REST API</a> in a specific version.
+ *
+ *  <p>
+ *  <strong>Version note!</strong>
+ *  This is an exotic sibling interface to {@link RestApi RestApi} that can be used to invoke the local Sitevision REST API
+ *  in a specific version - regardless of what version your code are currently executing in.
+ *  If you don't know what a version is or haven't thought much about it, you would typically use {@link RestApi RestApi}
+ *  that invokes the local REST API in {@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion() current version}.
+ *  </p>
+ *
+ *  <p>
+ *  This utility can be used regardless of the REST API of the local site is enabled or not!
+ *  </p>
+ *
+ *  <p>
+ *  <strong>Performance note!</strong> {@link RestApi} will always outperform <code>VersionedRestApi</code> when executing
+ *  in the same version! Note that the method contracts of the interfaces differs. RestApi operates on Node objects and VersionedRestApi
+ *  operates on Strings (i.e. Node identifiers).
+ *  </p>
+ *
+ *  <p>
+ *  An instance of the Sitevision class implementing this interface can be obtained via
+ *  {@link RestApiFactory#getOfflineRestApi() RestApiFactory.getOfflineRestApi()} or
+ *  {@link RestApiFactory#getOnlineRestApi() RestApiFactory.getOnlineRestApi()}.
+ *  See {@link RestApiFactory} for how to obtain an instance of the <code>RestApiFactory</code> interface.
+ *  </p>
+ * @param <O> script object
+ * @author Magnus Lövgren
+ * @see RestApi
+ * @see RestApiFactory
+ * @since Sitevision 2024.04.2
+ */
+export type VersionedRestApi = {
+  /**
+   * Get the version that is used by this instance.
+   * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}&#xA; or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   */
+  getVersion(): number;
+
+  /**
+   * Executes a GET endpoint of the REST API.
+   *
+   *  <p>
+   *  Delegates execution to {@link RestApi#get(javax.jcr.Node, String) RestApi.get(Node,String)}
+   *  in the {@link #getVersion() version} specified by this instance.
+   *  </p>
+   * @param aContextNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint context Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationName the endpoint operation name/method
+   * @return the result of the {@link RestApi#get(javax.jcr.Node, String) RestApi.get(Node,String)} invocation
+   * @throws NullPointerException if aContextNodeIdentifier or aOperationName is null
+   * @throws IllegalArgumentException if aContextNodeIdentifier or aOperationName is empty or blank
+   */
+  get(
+    aContextNodeIdentifier: String | string,
+    aOperationName: String | string
+  ): unknown;
+
+  /**
+   * Executes a GET endpoint of the REST API.
+   *
+   *  <p>
+   *  Delegates execution to {@link RestApi#get(javax.jcr.Node, String, Object) RestApi.get(Node,String,Options)}
+   *  in the {@link #getVersion() version} specified by this instance.
+   *  </p>
+   * @param aContextNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint context Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationOptions the operation data/parameters
+   * @return the result of the {@link RestApi#get(javax.jcr.Node, String, Object) RestApi.get(Node,String,Options)} invocation
+   * @throws NullPointerException if aContextNodeIdentifier or aOperationName is null
+   * @throws IllegalArgumentException if aContextNodeIdentifier or aOperationName is empty or blank
+   */
+  get(
+    aContextNodeIdentifier: String | string,
+    aOperationName: String | string,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a GET endpoint of the REST API, targeting an instance of the context.
+   *
+   *  <p>
+   *  Delegates execution to {@link RestApi#get(javax.jcr.Node, String, javax.jcr.Node, Object) RestApi.get(Node,String,Node,Options)}
+   *  in the {@link #getVersion() version} specified by this instance.
+   *  </p>
+   * @param aContextNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint context Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint operation Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationOptions the operation data/parameters
+   * @return the result of the {@link RestApi#get(javax.jcr.Node, String, javax.jcr.Node, Object) RestApi.get(Node,String,Node,Options)} invocation
+   * @throws NullPointerException if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is null
+   * @throws IllegalArgumentException if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is empty or blank
+   */
+  get(
+    aContextNodeIdentifier: String | string,
+    aOperationName: String | string,
+    aOperationNodeIdentifier: String | string,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a POST endpoint of the REST API.
+   *
+   *  <p>
+   *  Delegates execution to {@link RestApi#post(javax.jcr.Node, String, Object) RestApi.post(Node,String,Options)}
+   *  in the {@link #getVersion() version} specified by this instance.
+   *  </p>
+   * @param aContextNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint context Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationOptions the operation data/parameters
+   * @return the result of the {@link RestApi#post(javax.jcr.Node, String, Object) RestApi.post(Node,String,Options)} invocation
+   * @throws NullPointerException if aContextNodeIdentifier or aOperationName is null
+   * @throws IllegalArgumentException if aContextNodeIdentifier or aOperationName is empty or blank
+   */
+  post(
+    aContextNodeIdentifier: String | string,
+    aOperationName: String | string,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a PUT endpoint of the REST API.
+   *
+   *  <p>
+   *  Delegates execution to {@link RestApi#put(javax.jcr.Node, String, Object) RestApi.put(Node,String,Options)}
+   *  in the {@link #getVersion() version} specified by this instance.
+   *  </p>
+   * @param aContextNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint context Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationOptions the operation data/parameters
+   * @return the result of the {@link RestApi#put(javax.jcr.Node, String, Object) RestApi.put(Node,String,Options)} invocation
+   * @throws NullPointerException if aContextNodeIdentifier or aOperationName is null
+   * @throws IllegalArgumentException if aContextNodeIdentifier or aOperationName is empty or blank
+   */
+  put(
+    aContextNodeIdentifier: String | string,
+    aOperationName: String | string,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a PUT endpoint of the REST API
+   *
+   *  <p>
+   *  Delegates execution to {@link RestApi#put(javax.jcr.Node, String, javax.jcr.Node, Object) RestApi.put(Node,String,Node,Options)}
+   *  in the {@link #getVersion() version} specified by this instance.
+   *  </p>
+   * @param aContextNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint context Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint operation Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationOptions the operation data/parameters
+   * @return the result of the {@link RestApi#put(javax.jcr.Node, String, javax.jcr.Node, Object) RestApi.put(Node,String,Node,Options)} invocation
+   * @throws NullPointerException if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is null
+   * @throws IllegalArgumentException if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is empty or blank
+   */
+  put(
+    aContextNodeIdentifier: String | string,
+    aOperationName: String | string,
+    aOperationNodeIdentifier: String | string,
+    aOperationOptions: unknown
+  ): unknown;
+
+  /**
+   * Executes a DELETE endpoint of the REST API.
+   *
+   *  <p>
+   *  Delegates execution to {@link RestApi#delete(javax.jcr.Node, String) RestApi.delete(Node,String)}
+   *  in the {@link #getVersion() version} specified by this instance.
+   *  </p>
+   * @param aContextNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint context Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationName the endpoint operation name/method
+   * @return the result of the {@link RestApi#delete(javax.jcr.Node, String) RestApi.delete(Node,String)} invocation
+   * @throws NullPointerException if aContextNodeIdentifier or aOperationName is null
+   * @throws IllegalArgumentException if aContextNodeIdentifier or aOperationName is empty or blank
+   */
+  delete(
+    aContextNodeIdentifier: String | string,
+    aOperationName: String | string
+  ): unknown;
+
+  /**
+   * Executes a DELETE endpoint of the REST API, targeting an instance of the context.
+   *
+   *  <p>
+   *  Delegates execution to {@link RestApi#delete(javax.jcr.Node, String, javax.jcr.Node) RestApi.delete(Node,String,Node)}
+   *  in the {@link #getVersion() version} specified by this instance.
+   *  </p>
+   * @param aContextNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint context Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint operation Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @return the result of the {@link RestApi#delete(javax.jcr.Node, String, javax.jcr.Node) RestApi.delete(Node,String,Node)} invocation
+   * @throws NullPointerException if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is null
+   * @throws IllegalArgumentException if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is empty or blank
+   */
+  delete(
+    aContextNodeIdentifier: String | string,
+    aOperationName: String | string,
+    aOperationNodeIdentifier: String | string
+  ): unknown;
+
+  /**
+   * Executes a DELETE endpoint of the REST API, targeting an instance of the context.
+   *
+   *  <p>
+   *  Delegates execution to {@link RestApi#delete(javax.jcr.Node, String, javax.jcr.Node, Object) RestApi.delete(Node,String,Node,Options)}
+   *  in the {@link #getVersion() version} specified by this instance.
+   *  </p>
+   * @param aContextNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint context Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationName the endpoint operation name/method
+   * @param aOperationNodeIdentifier the {@link javax.jcr.Node#getIdentifier() identifier} for the endpoint operation Node.&#xA; Note that there is no guarantee that such a Node exists in the version specified by this instance.
+   * @param aOperationOptions the operation data/parameters
+   * @return the result of the {@link RestApi#delete(javax.jcr.Node, String, javax.jcr.Node, Object) RestApi.delete(Node,String,Node,Options)}&#xA; invocation
+   * @throws NullPointerException if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is null
+   * @throws IllegalArgumentException if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is empty or blank
+   */
+  delete(
+    aContextNodeIdentifier: String | string,
+    aOperationName: String | string,
+    aOperationNodeIdentifier: String | string,
+    aOperationOptions: unknown
+  ): unknown;
+};

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

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