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

package/server/WebResourceFactory/index.d.ts

@@ -1,45 +1,9 @@
-import ArticleUtil from "../ArticleUtil";
-import FileUtil from "../FileUtil";
-import ImageUtil from "../ImageUtil";
-import LinkPageUtil from "../LinkPageUtil";
-import LinkTargetBuilder from "../LinkTargetBuilder";
-import PageUtil from "../PageUtil";
-
-/**
- * Gets an instance of an article utility class
- * @return an article utility class
- */
-export function getArticleUtil(): ArticleUtil;
-
-/**
- * Gets an instance of a file utility class
- * @return a file utility class
- */
-export function getFileUtil(): FileUtil;
-
-/**
- * Gets an instance of an image utility class
- * @return an image utility class
- */
-export function getImageUtil(): ImageUtil;
-
-/**
- * Gets an instance of a link page utility class.
- * @return an instance of a link page utility class
- */
-export function getLinkPageUtil(): LinkPageUtil;
-
-/**
- * Gets an instance of a link target builder class.
- * @return an instance of a link target builder class
- */
-export function getLinkTargetBuilder(): LinkTargetBuilder;
-
-/**
- * Gets an instance of a page utility class
- * @return a page utility class
- */
-export function getPageUtil(): PageUtil;
+import type { ArticleUtil } from "../ArticleUtil";
+import type { FileUtil } from "../FileUtil";
+import type { ImageUtil } from "../ImageUtil";
+import type { LinkPageUtil } from "../LinkPageUtil";
+import type { LinkTargetBuilder } from "../LinkTargetBuilder";
+import type { PageUtil } from "../PageUtil";
 
 /**
  * Factory for creating instances of web resource utilities.
@@ -52,15 +16,46 @@ export function getPageUtil(): PageUtil;
  * @author Magnus Lövgren
  * @since Sitevision 4.2
  */
-declare namespace webResourceFactory {
-  export {
-    getArticleUtil,
-    getFileUtil,
-    getImageUtil,
-    getLinkPageUtil,
-    getLinkTargetBuilder,
-    getPageUtil,
-  };
+export interface WebResourceFactory {
+  /**
+   * Gets an instance of an article utility class
+   * @return an article utility class
+   */
+  getArticleUtil(): ArticleUtil;
+
+  /**
+   * Gets an instance of a file utility class
+   * @return a file utility class
+   */
+  getFileUtil(): FileUtil;
+
+  /**
+   * Gets an instance of an image utility class
+   * @return an image utility class
+   */
+  getImageUtil(): ImageUtil;
+
+  /**
+   * Gets an instance of a link page utility class.
+   * @return an instance of a link page utility class
+   */
+  getLinkPageUtil(): LinkPageUtil;
+
+  /**
+   * Gets an instance of a link target builder class.
+   * @return an instance of a link target builder class
+   */
+  getLinkTargetBuilder(): LinkTargetBuilder;
+
+  /**
+   * Gets an instance of a page utility class
+   * @return a page utility class
+   */
+  getPageUtil(): PageUtil;
 }
 
+declare namespace WebResourceFactory {}
+
+declare var webResourceFactory: WebResourceFactory;
+
 export default webResourceFactory;

package/server/XSLTUtil/index.d.ts

@@ -1,32 +1,3 @@
-/**
- * Gets the default XSL template for cleanup of HTML sources.
- *
- * <p>
- *    The template strips all &lt;div&gt;'s, &lt;spans&gt;'s and removes all inline styling, classes and attributes
- *    that is not mandatory or needed for WCAG purposes.
- * </p>
- * <p>
- *    <em>Note!</em> The template supports a <em>sub-set</em> of HTML elements (the presumed most commonly used elements).
- *    All unsupported elements are completely discarded (i.e. they will not be included at all in the transformation result).
- * </p>
- * @return the default cleanup template for HTML sources
- */
-export function getDefaultCleanHtmlTemplate(): string;
-
-/**
- * Transforms a HTML/XML source using a XSL template.
- *
- * <p>
- *    <em>Note!</em> The contents of the XSL Template is always handled as UTF-8.
- * </p>
- * @param aSource the source that should be transformed, HTML, XHTML or XML. Must not be null
- * @param aXslTemplate the UTF-8 XSL template; a sv:file Node, a sv:temporaryFile Node, a sv:link Node that targets a sv:file, a char array or a CharSequence (typically a String). Must not be null
- * @return the transformation result
- * @throws IOException if the transformation fails (e.g. the aSource is really bad/interpretable HTML or aXslTemplate is invalid XSL)
- * @throws RepositoryException if aNode-operation on aXslTemplate fails
- */
-export function transform(aSource: string, aXslTemplate: unknown): string;
-
 /**
  * XSLT utility for transforming XML/HTML using a XSL template.
  *
@@ -55,8 +26,39 @@ export function transform(aSource: string, aXslTemplate: unknown): string;
  * @author Magnus Lövgren
  * @since Sitevision 4.5
  */
-declare namespace xSLTUtil {
-  export { getDefaultCleanHtmlTemplate, transform };
+export interface XSLTUtil {
+  /**
+   * Gets the default XSL template for cleanup of HTML sources.
+   *
+   * <p>
+   *    The template strips all &lt;div&gt;'s, &lt;spans&gt;'s and removes all inline styling, classes and attributes
+   *    that is not mandatory or needed for WCAG purposes.
+   * </p>
+   * <p>
+   *    <em>Note!</em> The template supports a <em>sub-set</em> of HTML elements (the presumed most commonly used elements).
+   *    All unsupported elements are completely discarded (i.e. they will not be included at all in the transformation result).
+   * </p>
+   * @return the default cleanup template for HTML sources
+   */
+  getDefaultCleanHtmlTemplate(): string;
+
+  /**
+   * Transforms a HTML/XML source using a XSL template.
+   *
+   * <p>
+   *    <em>Note!</em> The contents of the XSL Template is always handled as UTF-8.
+   * </p>
+   * @param aSource the source that should be transformed, HTML, XHTML or XML. Must not be null
+   * @param aXslTemplate the UTF-8 XSL template; a sv:file Node, a sv:temporaryFile Node, a sv:link Node that targets a sv:file, a char array or a CharSequence (typically a String). Must not be null
+   * @return the transformation result
+   * @throws IOException if the transformation fails (e.g. the aSource is really bad/interpretable HTML or aXslTemplate is invalid XSL)
+   * @throws RepositoryException if aNode-operation on aXslTemplate fails
+   */
+  transform(aSource: string, aXslTemplate: unknown): string;
 }
 
+declare namespace XSLTUtil {}
+
+declare var xSLTUtil: XSLTUtil;
+
 export default xSLTUtil;

package/server/XmlParserUtil/index.d.ts

@@ -2,49 +2,6 @@ import type { XmlElementHandler } from "../../types/senselogic/sitevision/api/xm
 
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * Parse a XML string.
- * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
- * @param aXml the UTF-8 XML string
- * @param aXmlElementHandler the XmlElementHandler
- * @throws XmlParserException if an error occurs while parsing the XML
- */
-export function parse(
-  aElementSelection: string,
-  aXml: string,
-  aXmlElementHandler: XmlElementHandler
-): void;
-
-/**
- * Parse a file containing XML encoded using UTF-8.
- * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
- * @param aXmlFile the file containing XML encoded using UTF-8 (sv:file or sv:temporaryFile)
- * @param aXmlElementHandler the XmlElementHandler
- * @throws RepositoryException if an error occurs while accessing the file
- * @throws XmlParserException if an error occurs while parsing the XML
- */
-export function parse(
-  aElementSelection: string,
-  aXmlFile: Node,
-  aXmlElementHandler: XmlElementHandler
-): void;
-
-/**
- * Parse a file containing XML encoded with the supplied charset.
- * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
- * @param aXmlFile the file containing XML encoded using supplied encoding (sv:file or sv:temporaryFile)
- * @param aCharset the character encoding of the the file content (an IllegalArgument will be thrown if aCharset can not be resolved as a java.nio.charset.Charset)
- * @param aXmlElementHandler the XmlElementHandler
- * @throws RepositoryException if an error occurs while accessing the file
- * @throws XmlParserException if an error occurs while parsing the XML
- */
-export function parse(
-  aElementSelection: string,
-  aXmlFile: Node,
-  aCharset: string,
-  aXmlElementHandler: XmlElementHandler
-): void;
-
 /**
  * Utility interface for parsing XML.
  *
@@ -112,8 +69,53 @@ export function parse(
  * @author Niclas Hedlund
  * @since Sitevision 5.1
  */
-declare namespace xmlParserUtil {
-  export { parse };
+export interface XmlParserUtil {
+  /**
+   * Parse a XML string.
+   * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
+   * @param aXml the UTF-8 XML string
+   * @param aXmlElementHandler the XmlElementHandler
+   * @throws XmlParserException if an error occurs while parsing the XML
+   */
+  parse(
+    aElementSelection: string,
+    aXml: string,
+    aXmlElementHandler: XmlElementHandler
+  ): void;
+
+  /**
+   * Parse a file containing XML encoded using UTF-8.
+   * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
+   * @param aXmlFile the file containing XML encoded using UTF-8 (sv:file or sv:temporaryFile)
+   * @param aXmlElementHandler the XmlElementHandler
+   * @throws RepositoryException if an error occurs while accessing the file
+   * @throws XmlParserException if an error occurs while parsing the XML
+   */
+  parse(
+    aElementSelection: string,
+    aXmlFile: Node,
+    aXmlElementHandler: XmlElementHandler
+  ): void;
+
+  /**
+   * Parse a file containing XML encoded with the supplied charset.
+   * @param aElementSelection the elements in the XML that should be passed to the XmlElementHandler
+   * @param aXmlFile the file containing XML encoded using supplied encoding (sv:file or sv:temporaryFile)
+   * @param aCharset the character encoding of the the file content (an IllegalArgument will be thrown if aCharset can not be resolved as a java.nio.charset.Charset)
+   * @param aXmlElementHandler the XmlElementHandler
+   * @throws RepositoryException if an error occurs while accessing the file
+   * @throws XmlParserException if an error occurs while parsing the XML
+   */
+  parse(
+    aElementSelection: string,
+    aXmlFile: Node,
+    aCharset: string,
+    aXmlElementHandler: XmlElementHandler
+  ): void;
 }
 
+declare namespace XmlParserUtil {}
+
+declare var xmlParserUtil: XmlParserUtil;
+
 export default xmlParserUtil;

package/server/appData/index.d.ts

@@ -1,11 +1,13 @@
 import type { Node } from '../../types/javax/jcr/Node';
 
-export function get(key: string): unknown;
-export function getNode(key: string): Node;
-export function getArray(key: string): Node[];
-
-declare namespace appData {
-  export { get, getNode, getArray };
+export interface AppData {
+  get(key: string): unknown;
+  getNode(key: string): Node;
+  getArray(key: string): Node[];
 }
 
+declare namespace AppData {}
+
+declare var appData: AppData;
+
 export default appData;

package/server/appInfo/index.d.ts

@@ -1,4 +1,4 @@
-interface AppInfo {
+export interface AppInfo {
   appVersion: string;
   maxUploadSizeInMB: number;
   appHelpURL: string;
@@ -30,4 +30,8 @@ interface AppInfo {
   'jcr:primaryType': string;
 }
 
-export default {} as AppInfo;
+declare namespace AppInfo {}
+
+declare var appInfo: AppInfo;
+
+export default appInfo;

package/server/appResource/index.d.ts

@@ -1,28 +1,30 @@
 import type { Node } from '../../hidden/javax/jcr/Node';
 
-/**
- * Get the content of a resource as a string
- * @param key The name of the resource
- * @returns The content of the resource as a string
- */
-export function getContent(key: string): string;
+interface AppResource {
+  /**
+   * Get the content of a resource as a string
+   * @param key The name of the resource
+   * @returns The content of the resource as a string
+   */
+  getContent(key: string): string;
 
-/**
- * Get the content of a resource as a JCR-node
- * @param key The name of the resource
- * @returns The content of the resource as a javax.jcr.Node
- */
-export function getNode(key: string): Node;
+  /**
+   * Get the content of a resource as a JCR-node
+   * @param key The name of the resource
+   * @returns The content of the resource as a javax.jcr.Node
+   */
+  getNode(key: string): Node;
 
-/**
- * Get the content of a resource as a InputStream
- * @param key The name of the resource
- * @returns The content of the resource as a java.io.InputStream
- */
-export function getNode(key: string): unknown;
-
-declare namespace appResource {
-  export { getContent, getNode };
+  /**
+   * Get the content of a resource as a InputStream
+   * @param key The name of the resource
+   * @returns The content of the resource as a java.io.InputStream
+   */
+  getNode(key: string): unknown;
 }
 
+declare namespace AppResource {}
+
+declare var appResource: AppResource;
+
 export default appResource;

package/server/cache/index.d.ts

@@ -1,13 +1,15 @@
-interface Cache {
+export interface CacheEntry {
   get<A>(key: string, ttl: number, callback: () => A): A;
   purge(key: string): void;
 }
 
-export function getCache(): Cache;
-export function getSharedCache(aGlobalNamespace: string): Cache;
-
-declare namespace cache {
-  export { getCache, getSharedCache };
+export interface Cache {
+  getCache(): CacheEntry;
+  getSharedCache(aGlobalNamespace: string): CacheEntry;
 }
 
+declare namespace Cache {}
+
+declare var cache: Cache;
+
 export default cache;

package/server/globalAppData/index.d.ts

@@ -1,11 +1,13 @@
 import type { Node } from '../../types/javax/jcr/Node';
 
-export function get(key: string): unknown;
-export function getNode(key: string): Node;
-export function getArray(key: string): Node[];
-
-declare namespace globalAppData {
-  export { get, getNode, getArray };
+export interface GlobalAppData {
+  get(key: string): unknown;
+  getNode(key: string): Node;
+  getArray(key: string): Node[];
 }
 
+declare namespace GlobalAppData {}
+
+declare var globalAppData: GlobalAppData;
+
 export default globalAppData;

package/server/headless/index.d.ts

@@ -1,8 +1,8 @@
-interface HeadlessContentParams {
+export interface HeadlessContentParams {
   textPortletFormat?: 'JSON' | 'PLAIN';
 }
 
-interface ImageContent {
+export interface ImageContent {
   mimeType: string;
   displayName: string;
   URL: string;
@@ -11,25 +11,25 @@ interface ImageContent {
   URI?: string;
 }
 
-interface TextElement {
+export interface TextElement {
   type: 'text';
   content: string;
 }
 
-interface HtmlElement {
+export interface HtmlElement {
   type: 'block' | 'inline';
   htmlTag: string;
   attributes?: Record<string, string>;
   children: (HtmlElement | TextElement)[];
 }
 
-interface FileContent {
+export interface FileContent {
   mimeType: string;
   displayName: string;
   URL: string;
 }
 
-interface VideoContent {
+export interface VideoContent {
   displayName: string;
   mimeType: string;
   URL: string;
@@ -39,59 +39,61 @@ interface VideoContent {
   URI?: string;
 }
 
-interface HeadlessContent {
+export interface HeadlessContent {
   type: string;
 }
 
-interface HeadlessImageContent extends HeadlessContent {
+export interface HeadlessImageContent extends HeadlessContent {
   type: 'image';
   properties: {
     image: ImageContent;
   };
 }
 
-interface HeadlessImagesContent extends HeadlessContent {
+export interface HeadlessImagesContent extends HeadlessContent {
   type: 'images';
   properties: {
     images: ImageContent[];
   };
 }
 
-interface HeadlessVideoContent extends HeadlessContent {
+export interface HeadlessVideoContent extends HeadlessContent {
   type: 'video';
   properties: {
     video: VideoContent;
   };
 }
 
-interface HeadlessTextContent extends HeadlessContent {
+export interface HeadlessTextContent extends HeadlessContent {
   type: 'text';
   properties: {
     textContent: string | HtmlElement[];
   };
 }
 
-interface HeadlessFilesContent extends HeadlessContent {
+export interface HeadlessFilesContent extends HeadlessContent {
   type: 'files';
   properties: {
     files: FileContent[];
   };
 }
 
-export function getHeadlessContent(
-  callback: (
-    params: HeadlessContentParams
-  ) => (
-    | HeadlessImageContent
-    | HeadlessImagesContent
-    | HeadlessVideoContent
-    | HeadlessTextContent
-    | HeadlessFilesContent
-  )[]
-): void;
-
-declare namespace headless {
-  export { getHeadlessContent };
+export interface Headless {
+  getHeadlessContent(
+    callback: (
+      params: HeadlessContentParams
+    ) => (
+      | HeadlessImageContent
+      | HeadlessImagesContent
+      | HeadlessVideoContent
+      | HeadlessTextContent
+      | HeadlessFilesContent
+    )[]
+  ): void;
 }
 
+declare namespace Headless {}
+
+declare var headless: Headless;
+
 export default headless;

package/server/hooks/index.d.ts

@@ -1,21 +1,21 @@
 import { Cookie, Request } from '../../common/router';
 
-interface HooksResponse {
+export interface HooksResponse {
   set(name: string, value: string): void;
   cookie(cookie: Cookie): void;
   clearCookie(name: string);
   redirect(url: string);
 }
 
-export function beforeRender(
-  callback: (req: Request, res: HooksResponse) => void
-): void;
+export interface Hooks {
+  beforeRender(callback: (req: Request, res: HooksResponse) => void): void;
 
-export function getPageTitle(callback: (req: Request) => string);
-export function addHeadElement(callback: (req: Request) => string);
-
-declare namespace hooks {
-  export { beforeRender, getPageTitle, addHeadElement };
+  getPageTitle(callback: (req: Request) => string);
+  addHeadElement(callback: (req: Request) => string);
 }
 
+declare namespace Hooks {}
+
+declare var hooks: Hooks;
+
 export default hooks;

package/server/oauth2/index.d.ts

@@ -1,20 +1,22 @@
 import type { Node } from '../../types/javax/jcr/Node';
 
-interface AccessTokenStatus {
+export interface AccessTokenStatus {
   isValid: boolean;
   scopes: string[];
 }
 
-export function createLoginLink(
-  oauth2Config: Node,
-  redirectUrl: string,
-  scopes: string[]
-): string;
+export interface OAuth2 {
+  createLoginLink(
+    oauth2Config: Node,
+    redirectUrl: string,
+    scopes: string[]
+  ): string;
 
-export function getAccessTokenStatus(oauth2Config: Node): AccessTokenStatus;
-
-declare namespace oauth2 {
-  export { createLoginLink, getAccessTokenStatus };
+  getAccessTokenStatus(oauth2Config: Node): AccessTokenStatus;
 }
 
+declare namespace Oauth2 {}
+
+declare var oauth2: OAuth2;
+
 export default oauth2;

package/server/privileged/index.d.ts

@@ -1,29 +1,31 @@
 import type { Node } from '../../types/javax/jcr/Node';
 
-/**
- * Returns true if there are a service user configured for usage for the app. Returns false if not
- *
- * @since 7.0
- */
-export function isConfigured(): boolean;
+export interface Privileged {
+  /**
+   * Returns true if there are a service user configured for usage for the app. Returns false if not
+   *
+   * @since 7.0
+   */
+  isConfigured(): boolean;
 
-/**
- * Gets the user the privileged action will run as. Will be null if isConfigured is false
- *
- *  @since 7.0
- */
-export function getPrivilegedActionUser(): Node | null;
+  /**
+   * Gets the user the privileged action will run as. Will be null if isConfigured is false
+   *
+   *  @since 7.0
+   */
+  getPrivilegedActionUser(): Node | null;
 
-/**
- * Executes a callback function as the privileged action user. Callback will be executed as current user if isConfigured is false
- *
- * @since 7.0
- * @param callback The callback to trigger as the privileged action user
- */
-export function doPrivilegedAction(callback: () => void): void;
-
-declare namespace privileged {
-  export { isConfigured, getPrivilegedActionUser, doPrivilegedAction };
+  /**
+   * Executes a callback function as the privileged action user. Callback will be executed as current user if isConfigured is false
+   *
+   * @since 7.0
+   * @param callback The callback to trigger as the privileged action user
+   */
+  doPrivilegedAction(callback: () => void): void;
 }
 
+declare namespace Privileged {}
+
+declare var privileged: Privileged;
+
 export default privileged;