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

package/client/requester/index.d.ts

@@ -1,16 +1,18 @@
-interface RequesterOptions extends Record<string, any> {
+export interface RequesterOptions extends Record<string, any> {
   url: string;
   data?: any;
   fileUpload?: boolean;
 }
 
-export function doGet(options: RequesterOptions): Promise<unknown>;
-export function doPut(options: RequesterOptions): Promise<unknown>;
-export function doPost(options: RequesterOptions): Promise<unknown>;
-export function doDelete(options: RequesterOptions): Promise<unknown>;
-
-declare namespace requester {
-  export { doGet, doPut, doPost, doDelete };
+export interface Requester {
+  doGet(options: RequesterOptions): Promise<unknown>;
+  doPut(options: RequesterOptions): Promise<unknown>;
+  doPost(options: RequesterOptions): Promise<unknown>;
+  doDelete(options: RequesterOptions): Promise<unknown>;
 }
 
+declare namespace Requester {}
+
+declare var requester: Requester;
+
 export default requester;

package/client/toasts/index.d.ts

@@ -1,4 +1,4 @@
-interface ToastOptions {
+export interface ToastOptions {
   heading?: string;
   message: string;
   type?: string;
@@ -7,10 +7,12 @@ interface ToastOptions {
   checkmark?: boolean;
 }
 
-export function publish(options: ToastOptions): void;
-
-declare namespace toasts {
-  export { publish };
+export interface Toasts {
+  publish(options: ToastOptions): void;
 }
 
+declare namespace Toasts {}
+
+declare var toasts: Toasts;
+
 export default toasts;

package/common/app/index.d.ts

@@ -1,49 +1,48 @@
-/**
- * The locale of the page being rendered
- */
-export const locale: string;
-
-/**
- * The default locale for the WebApp
- */
-export const defaultLocale: string;
-
-/**
- * The id of the portlet containing the WebApp
- */
-export const portletId: string;
-
-/**
- * The WebApp id
- */
-export const webAppId: string;
-
-/**
- * The WebApp version
- */
-export const webAppVersion: string;
-
-/**
- * Note! Client side only
- *
- * @param eventName The name of the event to trigger
- * @param options The options for the event
- */
-export function trigger(eventName: string, ...options: unknown[]): void;
-
-/**
- * Note! Client side only
- *
- * @param eventName The name of the event to listen to
- * @param options The options for the event
- */
-export function on(
-  eventName: string,
-  callback: (...options: unknown[]) => void
-): void;
-
-export declare namespace app {
-  export { locale, defaultLocale, portletId, webAppId, webAppVersion };
+export interface App {
+  /**
+   * The locale of the page being rendered
+   */
+  locale: string;
+
+  /**
+   * The default locale for the WebApp
+   */
+  defaultLocale: string;
+
+  /**
+   * The id of the portlet containing the WebApp
+   */
+  portletId: string;
+
+  /**
+   * The WebApp id
+   */
+  webAppId: string;
+
+  /**
+   * The WebApp version
+   */
+  webAppVersion: string;
+
+  /**
+   * Note! Client side only
+   *
+   * @param eventName The name of the event to trigger
+   * @param options The options for the event
+   */
+  trigger(eventName: string, ...options: unknown[]): void;
+
+  /**
+   * Note! Client side only
+   *
+   * @param eventName The name of the event to listen to
+   * @param options The options for the event
+   */
+  on(eventName: string, callback: (...options: unknown[]) => void): void;
 }
 
+declare namespace App {}
+
+declare var app: App;
+
 export default app;

package/common/events/index.d.ts

@@ -1,34 +1,33 @@
-/**
- * Listen to a given event
- *
- * @param eventName The name of the event
- * @param callback The callback to trigger for the given event
- */
-export function on(
-  eventName: string,
-  callback: (options: unknown) => void
-): void;
-/**
- * Emit a server side event
- *
- * Note! Server side only
- *
- * @param eventName The name of the event to emit
- * @param options The options for the event
- */
-export function emit(eventName: string, options: unknown): void;
-/**
- * Trigger a client side event
- *
- * Note! Client side only
- *
- * @param eventName The name of the event to trigger
- * @param options The options for the event
- */
-export function trigger(eventName: string, options: unknown): void;
-
-declare namespace events {
-  export { on, emit, trigger };
+export interface Events {
+  /**
+   * Listen to a given event
+   *
+   * @param eventName The name of the event
+   * @param callback The callback to trigger for the given event
+   */
+  on(eventName: string, callback: (options: unknown) => void): void;
+  /**
+   * Emit a server side event
+   *
+   * Note! Server side only
+   *
+   * @param eventName The name of the event to emit
+   * @param options The options for the event
+   */
+  emit(eventName: string, options: unknown): void;
+  /**
+   * Trigger a client side event
+   *
+   * Note! Client side only
+   *
+   * @param eventName The name of the event to trigger
+   * @param options The options for the event
+   */
+  trigger(eventName: string, options: unknown): void;
 }
 
+declare namespace Events {}
+
+declare var events: Events;
+
 export default events;

package/common/i18n/index.d.ts

@@ -1,8 +1,10 @@
-export function get(key: string): string;
-export function get(key: string, ...substitutions: string[]): string;
-
-declare namespace i18n {
-  export { get };
+export interface I18n {
+  get(key: string): string;
+  get(key: string, ...substitutions: string[]): string;
 }
 
+declare namespace I18n {}
+
+declare var i18n: I18n;
+
 export default i18n;

package/common/router/index.d.ts

@@ -28,7 +28,7 @@ export interface Request {
   context: unknown | null;
 }
 
-interface Response {
+export interface Response {
   agnosticRender(html: string, initialData: unknown);
   send(content: string): void;
   json(data: unknown): void;
@@ -46,88 +46,83 @@ interface Response {
   render(route: string, data: unknown): void;
 }
 
-/**
- * This method is triggered by a get request to a given route.
- *
- * Note! Server side only
- *
- * @param route The route which will trigger this method
- * @param callback The callback to trigger for the given route
- */
-export function get(
-  route: string,
-  callback: (req: Request, res: Response) => void
-): void;
-/**
- * This method is triggered by a post request to a given route.
- *
- * Note! Server side only
- *
- * @param route The route which will trigger this method
- * @param callback The callback to trigger for the given route
- */
-export function post(
-  route: string,
-  callback: (req: Request, res: Response) => void
-): void;
-/**
- * This method is triggered by a put request to a given route.
- *
- * Note! Server side only
- *
- * @param route The route which will trigger this method
- * @param callback The callback to trigger for the given route
- */
-export function put(
-  route: string,
-  callback: (req: Request, res: Response) => void
-): void;
-declare function _delete(
-  route: string,
-  callback: (req: Request, res: Response) => void
-): void;
+export interface Router {
+  /**
+   * This method is triggered by a get request to a given route.
+   *
+   * Note! Server side only
+   *
+   * @param route The route which will trigger this method
+   * @param callback The callback to trigger for the given route
+   */
+  get(route: string, callback: (req: Request, res: Response) => void): void;
+  /**
+   * This method is triggered by a post request to a given route.
+   *
+   * Note! Server side only
+   *
+   * @param route The route which will trigger this method
+   * @param callback The callback to trigger for the given route
+   */
+  post(route: string, callback: (req: Request, res: Response) => void): void;
+  /**
+   * This method is triggered by a put request to a given route.
+   *
+   * Note! Server side only
+   *
+   * @param route The route which will trigger this method
+   * @param callback The callback to trigger for the given route
+   */
+  put(route: string, callback: (req: Request, res: Response) => void): void;
 
-export { _delete as delete };
+  /**
+   * This method is triggered by a delete request to a given route.
+   *
+   * Note! Server side only
+   *
+   * @param route The route which will trigger this method
+   * @param callback The callback to trigger for the given route
+   */
+  delete(route: string, callback: (req: Request, res: Response) => void): void;
 
-/**
- * Note! Server side only
- *
- * @param callback The callback to trigger
- */
-export function use(
-  callback: (req: Request, res: Response, next: Function) => void
-): void;
+  /**
+   * This method is triggered by a patch request to a given route.
+   *
+   * Note! Server side only
+   * Note! RESTApps only
+   * @param route The route which will trigger this method
+   * @param callback The callback to trigger for the given route
+   * @since Sitevision 2023.02.1
+   */
+  patch(route: string, callback: (req: Request, res: Response) => void): void;
 
-export function getUrl(path: string): string;
-export function getStandaloneUrl(path: string): string;
+  /**
+   * Note! Server side only
+   *
+   * @param callback The callback to trigger
+   */
+  use(callback: (req: Request, res: Response, next: Function) => void): void;
 
-/**
- * Note! Client side only
- */
-export function on(event: string, callback: () => void, context: any): void;
-/**
- * Note! Client side only
- */
-export function off(event: string, callback: () => void, context: any): void;
+  getUrl(path: string): string;
+  getStandaloneUrl(path: string): string;
 
-/**
- * Note! Client side only
- */
-export function navigate(url: string, options: any): void;
+  /**
+   * Note! Client side only
+   */
+  on(event: string, callback: () => void, context: any): void;
+  /**
+   * Note! Client side only
+   */
+  off(event: string, callback: () => void, context: any): void;
 
-declare namespace router {
-  export {
-    get,
-    post,
-    put,
-    _delete as delete,
-    use,
-    getUrl,
-    getStandaloneUrl,
-    on,
-    off,
-    navigate,
-  };
+  /**
+   * Note! Client side only
+   */
+  navigate(url: string, options: any): void;
 }
 
+declare namespace Router {}
+
+declare var router: Router;
+
 export default router;

package/common/security/index.d.ts

@@ -1,24 +1,30 @@
-export declare namespace security {
-  export namespace csrf {
-    /**
-     * Used to acquire the current csrf-token. If the user is anonymous or if csrf-protection is disabled on the server this will return null.
-     *
-     * @returns {string} the current token as string or null for anonymous users.
-     */
-    export function getToken(): string;
-    /**
-     * Used to acquire the parameter name that should be used when passing the token as a form field.
-     *
-     * @returns {string} the name that should be used when passing the token as form data.
-     */
-    export function getParameterName(): string;
-    /**
-     * Used to acquire the header name that should be used when passing the token as a request header.
-     *
-     * @returns {string} the name that should be used when passing the token as a header.
-     */
-    export function getHeaderName(): string;
-  }
+export interface Csrf {
+  /**
+   * Used to acquire the current csrf-token. If the user is anonymous or if csrf-protection is disabled on the server this will return null.
+   *
+   * @returns {string} the current token as string or null for anonymous users.
+   */
+  getToken(): string;
+  /**
+   * Used to acquire the parameter name that should be used when passing the token as a form field.
+   *
+   * @returns {string} the name that should be used when passing the token as form data.
+   */
+  getParameterName(): string;
+  /**
+   * Used to acquire the header name that should be used when passing the token as a request header.
+   *
+   * @returns {string} the name that should be used when passing the token as a header.
+   */
+  getHeaderName(): string;
 }
 
+export interface Security {
+  csrf: Csrf;
+}
+
+declare namespace Security {}
+
+declare var security: Security;
+
 export default security;

package/index.d.ts

@@ -5,10 +5,13 @@ import './server/ArticleUtil';
 import './server/AuthenticationUtil';
 import './server/BookmarkUtil';
 import './server/BuddyIconRenderer';
+import './server/BuddyIconRenderer.BuddyIconSize';
 import './server/ClientUtil';
 import './server/CollaborationFactory';
 import './server/CollaborationGroupFolderUtil';
+import './server/CollaborationGroupState';
 import './server/CollaborationGroupTemplateUtil';
+import './server/CollaborationGroupType';
 import './server/CollaborationGroupUtil';
 import './server/CollectionsInstance';
 import './server/ColorUtil';
@@ -20,7 +23,9 @@ import './server/CurrencyFactory';
 import './server/DateUtil';
 import './server/DecorationUtil';
 import './server/DeviceUtil';
+import './server/DimensionMode';
 import './server/DirectoryUtil';
+import './server/DocType';
 import './server/DocTypeUtil';
 import './server/EndecUtil';
 import './server/ExtendedDismaxParserBuilder';
@@ -36,6 +41,7 @@ import './server/ImageLinkRenderer';
 import './server/ImageRenderer';
 import './server/ImageUtil';
 import './server/IndexUtil';
+import './server/IndexUtil.IndexType';
 import './server/IndexingUtil';
 import './server/InstanceCreatorUtil';
 import './server/InstanceTypeUtil';
@@ -68,6 +74,7 @@ import './server/OnlineVersionPropertyUtil';
 import './server/OutputUtil';
 import './server/PageUtil';
 import './server/PermissionUtil';
+import './server/PermissionUtil.Permission';
 import './server/PortletContextUtil';
 import './server/PortletUtil';
 import './server/PrincipalUtil';
@@ -92,6 +99,7 @@ import './server/Session';
 import './server/SimpleUserUtil';
 import './server/SiteCookieUtil';
 import './server/SortBuilder';
+import './server/SourceSetMode';
 import './server/SpellCheckBuilder';
 import './server/StandardParserBuilder';
 import './server/StructureUtil';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2.0.0-alpha.1",
+  "version": "2023.02.1-alpha.0",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",

package/server/AliasUtil/index.d.ts

@@ -1,12 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Gets the alias name for a given Node.
- * @param aNode a Node that is the target of an alias, typically a sv:page, sv:article or sv:file
- * @return the first found alias name for aNode, or null if aNode is null or no matching alias could be found
- */
-export function getAliasName(aNode: Node): string;
-
 /**
  * Alias utility interface.
  *
@@ -18,8 +11,17 @@ export function getAliasName(aNode: Node): string;
  * @author Magnus Lövgren
  * @since Sitevision 2022.10.2
  */
-declare namespace aliasUtil {
-  export { getAliasName };
+export interface AliasUtil {
+  /**
+   * Gets the alias name for a given Node.
+   * @param aNode a Node that is the target of an alias, typically a sv:page, sv:article or sv:file
+   * @return the first found alias name for aNode, or null if aNode is null or no matching alias could be found
+   */
+  getAliasName(aNode: Node): string;
 }
 
+declare namespace AliasUtil {}
+
+declare var aliasUtil: AliasUtil;
+
 export default aliasUtil;

package/server/ArchiveUtil/index.d.ts

@@ -1,44 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * <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>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>
- * @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 RepositoryException if something else goes wrong
- */
-export function createArchive(aParent: Node, aName: 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>
- *
- * <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>
- * @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 RepositoryException if something else goes wrong
- */
-export function renameArchive(anArchive: Node, aName: string): void;
-
 /**
  * Archive utility interface that handles nodes with primary node type <code>sv:archive</code>.
  *
@@ -49,8 +10,49 @@ export function renameArchive(anArchive: Node, aName: string): void;
  * @author Mikael Wikblom
  * @since Sitevision 2.6.2
  */
-declare namespace archiveUtil {
-  export { createArchive, renameArchive };
+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>
+   *
+   * <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>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 RepositoryException if something else goes wrong
+   */
+  createArchive(aParent: Node, aName: 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>
+   *
+   * <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>
+   * @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 RepositoryException if something else goes wrong
+   */
+  renameArchive(anArchive: Node, aName: string): void;
 }
 
+declare namespace ArchiveUtil {}
+
+declare var archiveUtil: ArchiveUtil;
+
 export default archiveUtil;