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

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;

package/server/storage/index.d.ts

@@ -1,15 +1,15 @@
-interface OrderByOptions {
+export interface OrderByOptions {
   field: string;
   order: 'ASC' | 'DESC';
 }
 
-interface FindOptions {
+export interface FindOptions {
   count?: number;
   skip?: number;
   orderBy?: OrderByOptions | OrderByOptions[];
 }
 
-interface CollectionDataStore {
+export interface CollectionDataStore {
   add(data: any): void;
   addAll(data: any[]): void;
   get(dsid: string): unknown;
@@ -39,7 +39,7 @@ interface CollectionDataStore {
 /**
  * @since 5.2
  */
-interface KeyValueDataStore {
+export interface KeyValueDataStore {
   /**
    * Stores data associated with a key.
    * Returns current data stored on the key.
@@ -68,7 +68,7 @@ interface KeyValueDataStore {
   remove(key: string): void;
 }
 
-interface SearchResult {
+export interface SearchResult {
   toArray(): unknown[];
   each(
     callback: (err: DataStoreError | undefined, data: unknown) => void
@@ -80,13 +80,13 @@ interface SearchResult {
   ): void;
 }
 
-interface DataStoreError {
+export interface DataStoreError {
   dataStore: string;
   type: DataStoreErrorType;
   message: string;
 }
 
-declare enum DataStoreErrorType {
+export enum DataStoreErrorType {
   validation_failed,
   read_only,
   item_not_found,
@@ -95,20 +95,22 @@ declare enum DataStoreErrorType {
   unknown,
 }
 
-/**
- * Get an instance of a CollectionDataStore
- * @param identifier The name of a data store
- */
-export function getCollectionDataStore(identifier: string): CollectionDataStore;
-
-/**
- * Get an instance of a KeyValueDataStore
- * @param identifier The name of a data store
- */
-export function getKeyValueDataStore(identifier: string): KeyValueDataStore;
+export interface Storage {
+  /**
+   * Get an instance of a CollectionDataStore
+   * @param identifier The name of a data store
+   */
+  getCollectionDataStore(identifier: string): CollectionDataStore;
 
-declare namespace storage {
-  export { getCollectionDataStore, getKeyValueDataStore };
+  /**
+   * Get an instance of a KeyValueDataStore
+   * @param identifier The name of a data store
+   */
+  getKeyValueDataStore(identifier: string): KeyValueDataStore;
 }
 
+declare namespace Storage {}
+
+declare const storage: Storage;
+
 export default storage;

package/types/javax/jcr/Binary/index.d.ts

@@ -7,7 +7,7 @@
  * @since JCR 2.0
  * @since Sitevision 3.5
  */
-type Binary = {
+export type Binary = {
   /**
    * Returns an {@link InputStream} representation of this value. Each call to
    * <code>getStream()</code> returns a new stream. The API consumer is
@@ -41,5 +41,3 @@ type Binary = {
     */
   dispose(): void;
 };
-
-export = Binary;

package/types/javax/jcr/Credentials/index.d.ts

@@ -6,8 +6,6 @@
  * GuestCredentials} for examples of such a class.
   
     */
-type Credentials = {
+export type Credentials = {
   undefined;
 };
-
-export = Credentials;

package/types/javax/jcr/ImportUUIDBehavior/index.d.ts

@@ -6,7 +6,7 @@
  * <p><strong>Sitevision note:</strong> Unsupported operation</p>
   
     */
-type ImportUUIDBehavior = {
+export type ImportUUIDBehavior = {
   undefined;
 
   /**
@@ -33,5 +33,3 @@ type ImportUUIDBehavior = {
     */
   IMPORT_UUID_COLLISION_THROW: number;
 };
-
-export = ImportUUIDBehavior;

package/types/javax/jcr/Item/index.d.ts

@@ -1,14 +1,14 @@
-import type Node from "../Node";
+import type { Node } from "../Node";
 import { Session } from "../../../../server/Session";
 
-import type ItemVisitor from "../ItemVisitor";
+import type { ItemVisitor } from "../ItemVisitor";
 
 /**
  * The <code>Item</code> is the base interface of <code>{@link Node}</code> and
  * <code>{@link Property}</code>.
   
     */
-type Item = {
+export type Item = {
   /**
    * Returns the normalized absolute path to this item.
    * @return the normalized absolute path of this <code>Item</code>.
@@ -121,5 +121,3 @@ type Item = {
    */
   remove(): void;
 };
-
-export = Item;

package/types/javax/jcr/ItemVisitor/index.d.ts

@@ -1,6 +1,6 @@
-import type Property from "../Property";
+import type { Property } from "../Property";
 
-import type Node from "../Node";
+import type { Node } from "../Node";
 
 /**
  * This interface defines two signatures of the <code>visit</code> method; one
@@ -15,7 +15,7 @@ import type Node from "../Node";
  * through the tree performing some operation on each <code>Item</code>.
   
     */
-type ItemVisitor = {
+export type ItemVisitor = {
   /**
    * This method is called when the <code>ItemVisitor</code> is passed to the
    * <code>accept</code> method of a <code>Property</code>. If this method
@@ -34,5 +34,3 @@ type ItemVisitor = {
    */
   visit(node: Node): void;
 };
-
-export = ItemVisitor;

package/types/javax/jcr/NamespaceRegistry/index.d.ts

@@ -7,7 +7,7 @@
  * repository content with namespaces that are not included in the registry.
  * @see Workspace#getNamespaceRegistry
  */
-type NamespaceRegistry = {
+export type NamespaceRegistry = {
   /**
    * Returns an array holding all currently registered prefixes.
    * @return a string array.
@@ -105,5 +105,3 @@ type NamespaceRegistry = {
     */
   NAMESPACE_EMPTY: string;
 };
-
-export = NamespaceRegistry;

package/types/javax/jcr/Node/index.d.ts

@@ -1,22 +1,22 @@
-import type Value from "../Value";
-import type Property from "../Property";
+import type { Value } from "../Value";
+import type { Property } from "../Property";
 
-import type Binary from "../Binary";
+import type { Binary } from "../Binary";
 
-import type NodeIterator from "../NodeIterator";
-import type PropertyIterator from "../PropertyIterator";
-import type Item from "../Item";
-import type NodeType from "../nodetype/NodeType";
-import type NodeDefinition from "../nodetype/NodeDefinition";
-import type Version from "../version/Version";
-import type VersionHistory from "../version/VersionHistory";
-import type Lock from "../lock/Lock";
+import type { NodeIterator } from "../NodeIterator";
+import type { PropertyIterator } from "../PropertyIterator";
+import type { Item } from "../Item";
+import type { NodeType } from "../nodetype/NodeType";
+import type { NodeDefinition } from "../nodetype/NodeDefinition";
+import type { Version } from "../version/Version";
+import type { VersionHistory } from "../version/VersionHistory";
+import type { Lock } from "../lock/Lock";
 
 /**
  * The <code>Node</code> interface represents a node in a workspace.
   
     */
-type Node = Item & {
+export type Node = Item & {
   /**
    * Sets the specified single-value property to the specified value. If the
    * property does not yet exist, it is created.
@@ -330,5 +330,3 @@ type Node = Item & {
    */
   JCR_FROZEN_NODE: string;
 };
-
-export = Node;

package/types/javax/jcr/NodeIterator/index.d.ts

@@ -1,5 +1,5 @@
-import type Node from "../Node";
-import type RangeIterator from "../RangeIterator";
+import type { Node } from "../Node";
+import type { RangeIterator } from "../RangeIterator";
 
 /**
  * Allows easy iteration through a list of <code>Node</code>s with
@@ -7,7 +7,7 @@ import type RangeIterator from "../RangeIterator";
  * <code>RangeIterator</code>.
   
     */
-type NodeIterator = RangeIterator & {
+export type NodeIterator = RangeIterator & {
   /**
    * Returns the next <code>Node</code> in the iteration.
    * @return the next <code>Node</code> in the iteration.
@@ -15,5 +15,3 @@ type NodeIterator = RangeIterator & {
    */
   nextNode(): Node;
 };
-
-export = NodeIterator;

package/types/javax/jcr/Property/index.d.ts

@@ -1,11 +1,11 @@
-import type Value from "../Value";
+import type { Value } from "../Value";
 
-import type Binary from "../Binary";
+import type { Binary } from "../Binary";
 
-import type Node from "../Node";
-import type PropertyDefinition from "../nodetype/PropertyDefinition";
+import type { Node } from "../Node";
+import type { PropertyDefinition } from "../nodetype/PropertyDefinition";
 
-import type Item from "../Item";
+import type { Item } from "../Item";
 
 /**
  * A <code>Property</code> object represents the smallest granularity of content
@@ -14,7 +14,7 @@ import type Item from "../Item";
  * all of the same type. See <code>{@link Value}</code>.
   
     */
-type Property = Item & {
+export type Property = Item & {
   /**
    * Returns the value of this  property as a <code>Value</code> object.
    * <p>
@@ -671,5 +671,3 @@ type Property = Item & {
    */
   JCR_STATEMENT: string;
 };
-
-export = Property;

package/types/javax/jcr/PropertyIterator/index.d.ts

@@ -1,12 +1,12 @@
-import type Property from "../Property";
-import type RangeIterator from "../RangeIterator";
+import type { Property } from "../Property";
+import type { RangeIterator } from "../RangeIterator";
 
 /**
  * Allows easy iteration through a list of <code>Property</code>s with
  * <code>nextProperty</code> as well as a <code>skip</code> method.
   
     */
-type PropertyIterator = RangeIterator & {
+export type PropertyIterator = RangeIterator & {
   /**
    * Returns the next <code>Property</code> in the iteration.
    * @return the next <code>Property</code> in the iteration.
@@ -14,5 +14,3 @@ type PropertyIterator = RangeIterator & {
    */
   nextProperty(): Property;
 };
-
-export = PropertyIterator;

package/types/javax/jcr/RangeIterator/index.d.ts

@@ -5,6 +5,4 @@
  * packages.
   
     */
-type RangeIterator = {};
-
-export = RangeIterator;
+export type RangeIterator = {};

package/types/javax/jcr/Repository/index.d.ts

@@ -1,5 +1,5 @@
-import type Value from "../Value";
-import type Credentials from "../Credentials";
+import type { Value } from "../Value";
+import type { Credentials } from "../Credentials";
 import { Session } from "../../../../server/Session";
 
 /**
@@ -7,7 +7,7 @@ import { Session } from "../../../../server/Session";
  * object is usually acquired through the {@link RepositoryFactory}.
   
     */
-type Repository = {
+export type Repository = {
   /**
    * Returns a string array holding all descriptor keys available for this
    * implementation, both the standard descriptors defined by the string
@@ -507,5 +507,3 @@ type Repository = {
    */
   QUERY_XPATH_DOC_ORDER: string;
 };
-
-export = Repository;

package/types/javax/jcr/RepositoryFactory/index.d.ts

@@ -1,4 +1,4 @@
-import type Repository from "../Repository";
+import type { Repository } from "../Repository";
 
 /**
  * <code>RepositoryFactory</code> is a factory for <code>Repository</code>
@@ -53,7 +53,7 @@ import type Repository from "../Repository";
  * @since Sitevision 3.5
  * @since JCR 2.0
  */
-type RepositoryFactory = {
+export type RepositoryFactory = {
   /**
    * Attempts to establish a connection to a repository using the given
    * <code>parameters</code>. <p> Parameters are passed in a <code>Map</code>
@@ -74,5 +74,3 @@ type RepositoryFactory = {
    */
   getRepository(parameters: unknown): Repository;
 };
-
-export = RepositoryFactory;

package/types/javax/jcr/Value/index.d.ts

@@ -1,4 +1,4 @@
-import type Binary from "../Binary";
+import type { Binary } from "../Binary";
 
 /**
  * A generic holder for the value of a property. A <code>Value</code> object can
@@ -52,7 +52,7 @@ import type Binary from "../Binary";
  * state change.
   
     */
-type Value = {
+export type Value = {
   /**
    * Returns a <code>String</code> representation of this value.
    * @return A <code>String</code> representation of the value of this property.
@@ -127,5 +127,3 @@ type Value = {
    */
   getType(): number;
 };
-
-export = Value;

package/types/javax/jcr/ValueFactory/index.d.ts

@@ -1,14 +1,14 @@
-import type Value from "../Value";
+import type { Value } from "../Value";
 
-import type Binary from "../Binary";
-import type Node from "../Node";
+import type { Binary } from "../Binary";
+import type { Node } from "../Node";
 
 /**
  * The <code>ValueFactory</code> object provides methods for the creation Value
  * objects that can then be used to set properties.
  * @since Sitevision 3.0
  */
-type ValueFactory = {
+export type ValueFactory = {
   /**
    * Returns a <code>Value</code> object of {@link PropertyType#STRING} with
    * the specified <code>value</code>.
@@ -70,5 +70,3 @@ type ValueFactory = {
    */
   createValue(value: Node): Value;
 };
-
-export = ValueFactory;