@sitevision/api 2.0.0-alpha.2 → 2023.2.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/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

@@ -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;
@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitevision/api",
-  "version": "2.0.0-alpha.2",
+  "version": "2023.2.1",
   "author": "Sitevision AB",
   "license": "MIT",
   "type": "module",
@@ -14,6 +14,7 @@
     "url": "https://github.com/sitevision/sitevision-apps/issues"
   },
   "scripts": {
+    "prepack": "yarn build",
     "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/",
     "deploy": "yarn build && npm publish dist"
   },
@@ -26,5 +27,6 @@
   "publishConfig": {
     "access": "public",
     "directory": "dist"
-  }
+  },
+  "gitHead": "b50466b7c3cbae334f825e186338f42aef7980cc"
 }

package/server/AliasUtil/index.d.ts

@@ -1,4 +1,4 @@
-import type Node from "../../types/javax/jcr/Node";
+import type { Node } from "../../types/javax/jcr/Node";
 
 /**
  * Alias utility interface.
@@ -24,4 +24,4 @@ declare namespace AliasUtil {}
 
 declare var aliasUtil: AliasUtil;
 
-export = aliasUtil;
+export default aliasUtil;

package/server/ArchiveUtil/index.d.ts

@@ -1,4 +1,4 @@
-import type Node from "../../types/javax/jcr/Node";
+import type { Node } from "../../types/javax/jcr/Node";
 
 /**
  * Archive utility interface that handles nodes with primary node type <code>sv:archive</code>.
@@ -55,4 +55,4 @@ declare namespace ArchiveUtil {}
 
 declare var archiveUtil: ArchiveUtil;
 
-export = archiveUtil;
+export default archiveUtil;

package/server/ArraysInstance/index.d.ts

@@ -1688,4 +1688,4 @@ declare namespace ArraysInstance {}
 
 declare var arraysInstance: ArraysInstance;
 
-export = arraysInstance;
+export default arraysInstance;

package/server/ArticleUtil/index.d.ts

@@ -1,6 +1,6 @@
-import type Node from "../../types/javax/jcr/Node";
+import type { Node } from "../../types/javax/jcr/Node";
 
-import type ArticleUtilConstants from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants";
+import type { ArticleUtilConstants } from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants";
 
 /**
  * Article utility interface that handles nodes with primary node type <code>sv:article</code>.
@@ -324,4 +324,4 @@ declare namespace ArticleUtil {}
 
 declare var articleUtil: ArticleUtil;
 
-export = articleUtil;
+export default articleUtil;

package/server/AuthenticationUtil/index.d.ts

@@ -85,4 +85,4 @@ declare namespace AuthenticationUtil {}
 
 declare var authenticationUtil: AuthenticationUtil;
 
-export = authenticationUtil;
+export default authenticationUtil;

package/server/BookmarkUtil/index.d.ts

@@ -1,4 +1,4 @@
-import type Node from "../../types/javax/jcr/Node";
+import type { Node } from "../../types/javax/jcr/Node";
 
 /**
  * <p>Bookmark utility interface. Bookmarks are potentially clustered between sitevision instances.
@@ -89,4 +89,4 @@ declare namespace BookmarkUtil {}
 
 declare var bookmarkUtil: BookmarkUtil;
 
-export = bookmarkUtil;
+export default bookmarkUtil;

package/server/BuddyIconRenderer/index.d.ts

@@ -1,7 +1,7 @@
-import BuddyIconSize from "../BuddyIconRenderer.BuddyIconSize";
+import type BuddyIconSize from "../BuddyIconRenderer.BuddyIconSize";
 
-import type Node from "../../types/javax/jcr/Node";
-import type BuddyIconInfo from "../../types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo";
+import type { Node } from "../../types/javax/jcr/Node";
+import type { BuddyIconInfo } from "../../types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo";
 
 /**
  * BuddyIconRenderer is a stateful utility interface for rendering of buddy icons for user identities and collaboration groups.
@@ -189,4 +189,4 @@ declare namespace BuddyIconRenderer {}
 
 declare var buddyIconRenderer: BuddyIconRenderer;
 
-export = buddyIconRenderer;
+export default buddyIconRenderer;

package/server/ClientUtil/index.d.ts

@@ -25,4 +25,4 @@ declare namespace ClientUtil {}
 
 declare var clientUtil: ClientUtil;
 
-export = clientUtil;
+export default clientUtil;

package/server/CollaborationFactory/index.d.ts

@@ -1,8 +1,8 @@
-import type Node from "../../types/javax/jcr/Node";
-import type CollaborationGroupWrapper from "../../types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper";
-import CollaborationGroupUtil from "../CollaborationGroupUtil";
-import CollaborationGroupFolderUtil from "../CollaborationGroupFolderUtil";
-import CollaborationGroupTemplateUtil from "../CollaborationGroupTemplateUtil";
+import type { Node } from "../../types/javax/jcr/Node";
+import type { CollaborationGroupWrapper } from "../../types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper";
+import type { CollaborationGroupUtil } from "../CollaborationGroupUtil";
+import type { CollaborationGroupFolderUtil } from "../CollaborationGroupFolderUtil";
+import type { CollaborationGroupTemplateUtil } from "../CollaborationGroupTemplateUtil";
 
 /**
  * Factory for creating collaboration-related instances.
@@ -51,4 +51,4 @@ declare namespace CollaborationFactory {}
 
 declare var collaborationFactory: CollaborationFactory;
 
-export = collaborationFactory;
+export default collaborationFactory;

package/server/CollaborationGroupFolderUtil/index.d.ts

@@ -1,4 +1,4 @@
-import type Node from "../../types/javax/jcr/Node";
+import type { Node } from "../../types/javax/jcr/Node";
 
 /**
  * Collaboration group folder utility interface that handles nodes with primary node type <code>sv:collaborationGroupFolder</code>.
@@ -41,4 +41,4 @@ declare namespace CollaborationGroupFolderUtil {}
 
 declare var collaborationGroupFolderUtil: CollaborationGroupFolderUtil;
 
-export = collaborationGroupFolderUtil;
+export default collaborationGroupFolderUtil;

package/server/CollaborationGroupTemplateUtil/index.d.ts

@@ -1,4 +1,4 @@
-import type Node from "../../types/javax/jcr/Node";
+import type { Node } from "../../types/javax/jcr/Node";
 
 /**
  * Collaboration group template utility interface that handles nodes with primary node type <code>sv:collaborationGroupTemplate</code>.
@@ -60,4 +60,4 @@ declare namespace CollaborationGroupTemplateUtil {}
 
 declare var collaborationGroupTemplateUtil: CollaborationGroupTemplateUtil;
 
-export = collaborationGroupTemplateUtil;
+export default collaborationGroupTemplateUtil;