@sitevision/api 2023.2.1-alpha.0 → 2023.2.2-beta.1

package/README.md

@@ -1,20 +1,5 @@
 # @sitevision/api
 
-Typescript definitions for Sitevision Public API. Project is under construction feel free to add more documentation.
+TypeScript definitions for Sitevision Public API.
 
-## How?
-
-- Create a folder for the class you would like to document.
-- Add an empty index.js.
-- Add index.d.ts and fill with declarations.
-
-### Folder structure
-
-- server
-  - Classes only available on the server
-- client
-  - Classes only available when on the client
-- common
-  - Interfaces shared between server and client
-
-More info on how to write TypeScript declarations can be found [here](https://www.typescriptlang.org/docs/handbook/declaration-files/by-example.html).
+For more information and documentation visit https://developer.sitevision.se

package/common/router/index.d.ts

@@ -13,8 +13,8 @@ export interface Request {
   invalidateSession(): void;
   header(headerName: string): string | null;
   file(fileParameterName: string): Node;
-  params: Record<string, string | number>;
-  cookies: Record<string, string>;
+  params: { [key: string]: string };
+  cookies: { [key: string]: string };
   xhr: boolean;
   session: any;
   hostname: string;

package/common/router/index.js

@@ -9,6 +9,7 @@ var _default = {
   put: function put() {},
   post: function post() {},
   "delete": function _delete() {},
+  patch: function patch() {},
   getUrl: function getUrl(path) {
     return path;
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2023.02.1-alpha.0",
+  "version": "2023.2.2-beta.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -15,13 +15,15 @@
   },
   "scripts": {
     "build": "rimraf dist/ && rimraf build/ && scripts/copysrc.sh && node scripts/generateindex.js && babel build --out-dir dist --copy-files && copyfiles package.json README.md dist/",
+    "test": "yarn build && tsc --noEmit dist/index.d.ts && echo 'No errors found.'",
     "deploy": "yarn build && npm publish dist"
   },
   "devDependencies": {
     "@babel/cli": "^7.19.3",
     "copyfiles": "^2.4.1",
     "fs-extra": "11.1.0",
-    "rimraf": "^3.0.2"
+    "rimraf": "^3.0.2",
+    "typescript": "^4.9.5"
   },
   "publishConfig": {
     "access": "public",

package/server/AliasUtil/index.d.ts

@@ -1,13 +1,14 @@
 import type { Node } from "../../types/javax/jcr/Node";
+import type { String } from "../../types/java/lang/String";
 
 /**
  * Alias utility interface.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getAliasUtil()}.
- *    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#getAliasUtil()}.
+ *     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 2022.10.2
  */

package/server/ArchiveUtil/index.d.ts

@@ -1,54 +1,55 @@
 import type { Node } from "../../types/javax/jcr/Node";
+import type { String } from "../../types/java/lang/String";
 
 /**
  * Archive utility interface that handles nodes with primary node type <code>sv:archive</code>.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getArchiveUtil()}.
- *    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#getArchiveUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6.2
  */
 export interface ArchiveUtil {
   /**
    * <p>
-   *    Creates an archive as sub node of the specified parent.
-   * </p>
-   * <p>
-   *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}
-   *    or a {@code sv:collaborationGroupPage}.
-   *    If an other parent is specified a <code>ConstraintViolationException</code> is thrown.
-   * </p>
+   *     Creates an archive as sub node of the specified parent.
+   *  </p>
+   *  <p>
+   *     The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}
+   *     or a {@code sv:collaborationGroupPage}.
+   *     If an other parent is specified a <code>ConstraintViolationException</code> is thrown.
+   *  </p>
    *
-   * <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *  <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
    *
-   * <p>The current user must be authorized to create archives and to do write operations on the parent node or
-   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   *  <p>The current user must be authorized to create archives and to do write operations on the parent node or
+   *  a <code>ConstraintViolationException</code> will be thrown.</p>
    *
-   * <p>Note that a new archive inherits metadata and permissions from its parent.</p>
+   *  <p>Note that a new archive inherits metadata and permissions from its parent.</p>
    * @param aParent the parent node of the sv:archive. May not be <code>null</code>
    * @param aName the name of the archive. May not be <code>null</code>
    * @return the newly created sv:archive node.
-   * @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create an archive
+   * @throws ConstraintViolationException if an invalid parent is specified or if the current user&#xA; is not authorized to create an archive
    * @throws RepositoryException if something else goes wrong
    */
-  createArchive(aParent: Node, aName: string): Node;
+  createArchive(aParent: Node, aName: String | string): Node;
 
   /**
    * <p>Alters the name of an archive. If no archive is specified a <code>NullPointerException</code>
-   * is thrown. If the node is not a sv:archive an <code>IllegalArgumentException</code> is thrown.</p>
+   *  is thrown. If the node is not a sv:archive an <code>IllegalArgumentException</code> is thrown.</p>
    *
-   * <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *  <p>Any name can be given an archive. If null is provided a <code>NullPointerException</code> is thrown.</p>
    *
-   * <p>The current user must be authorized to do write operations on the archive or
-   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   *  <p>The current user must be authorized to do write operations on the archive or
+   *  a <code>ConstraintViolationException</code> will be thrown.</p>
    * @param anArchive the archive that should be renamed. May not be <code>null</code>
    * @param aName the new name of the archive. May not be <code>null</code>
-   * @throws ConstraintViolationException if the current user is not authorized to alter the name of the archive
+   * @throws ConstraintViolationException if the current user is not authorized to alter the name of the&#xA; archive
    * @throws RepositoryException if something else goes wrong
    */
-  renameArchive(anArchive: Node, aName: string): void;
+  renameArchive(anArchive: Node, aName: String | string): void;
 }
 
 declare namespace ArchiveUtil {}