@sitevision/api 1.1.0-alpha.2 → 2.0.0-alpha.1

package/server/headless/index.d.ts

@@ -0,0 +1,97 @@
+interface HeadlessContentParams {
+  textPortletFormat?: 'JSON' | 'PLAIN';
+}
+
+interface ImageContent {
+  mimeType: string;
+  displayName: string;
+  URL: string;
+  id?: string;
+  alt?: string;
+  URI?: string;
+}
+
+interface TextElement {
+  type: 'text';
+  content: string;
+}
+
+interface HtmlElement {
+  type: 'block' | 'inline';
+  htmlTag: string;
+  attributes?: Record<string, string>;
+  children: (HtmlElement | TextElement)[];
+}
+
+interface FileContent {
+  mimeType: string;
+  displayName: string;
+  URL: string;
+}
+
+interface VideoContent {
+  displayName: string;
+  mimeType: string;
+  URL: string;
+  id?: string;
+  streamURI?: string;
+  streamURL?: string;
+  URI?: string;
+}
+
+interface HeadlessContent {
+  type: string;
+}
+
+interface HeadlessImageContent extends HeadlessContent {
+  type: 'image';
+  properties: {
+    image: ImageContent;
+  };
+}
+
+interface HeadlessImagesContent extends HeadlessContent {
+  type: 'images';
+  properties: {
+    images: ImageContent[];
+  };
+}
+
+interface HeadlessVideoContent extends HeadlessContent {
+  type: 'video';
+  properties: {
+    video: VideoContent;
+  };
+}
+
+interface HeadlessTextContent extends HeadlessContent {
+  type: 'text';
+  properties: {
+    textContent: string | HtmlElement[];
+  };
+}
+
+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 default headless;

package/server/headless/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getHeadlessContent: function getHeadlessContent() {}
+};
+exports["default"] = _default;

package/server/hooks/index.d.ts

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

package/server/oauth2/index.d.ts

@@ -1,4 +1,9 @@
-import Node from '../../builtins/Node';
+import type { Node } from '../../types/javax/jcr/Node';
+
+interface AccessTokenStatus {
+  isValid: boolean;
+  scopes: string[];
+}
 
 export function createLoginLink(
   oauth2Config: Node,
@@ -6,7 +11,7 @@ export function createLoginLink(
   scopes: string[]
 ): string;
 
-export function getAccessTokenStatus(oauth2Config: Node): object;
+export function getAccessTokenStatus(oauth2Config: Node): AccessTokenStatus;
 
 declare namespace oauth2 {
   export { createLoginLink, getAccessTokenStatus };

package/server/privileged/index.d.ts

@@ -1,16 +1,18 @@
+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();
+export function isConfigured(): boolean;
 
 /**
  * Gets the user the privileged action will run as. Will be null if isConfigured is false
  *
  *  @since 7.0
  */
-export function getPrivilegedActionUser();
+export function getPrivilegedActionUser(): Node | null;
 
 /**
  * Executes a callback function as the privileged action user. Callback will be executed as current user if isConfigured is false

package/server/storage/index.d.ts

@@ -1,11 +1,27 @@
+interface OrderByOptions {
+  field: string;
+  order: 'ASC' | 'DESC';
+}
+
+interface FindOptions {
+  count?: number;
+  skip?: number;
+  orderBy?: OrderByOptions | OrderByOptions[];
+}
+
 interface CollectionDataStore {
   add(data: any): void;
   addAll(data: any[]): void;
-  get(dsid: string): any;
+  get(dsid: string): unknown;
   set(dsid: string, data: any): void;
   remove(dsid: string): void;
   removeAll(): void;
-  find(query: string, count: number, skip: number): SearchResult;
+
+  find(query: string, options?: FindOptions): SearchResult;
+  /**
+   * @deprecated
+   */
+  find(query: string, count?: number, skip?: number): SearchResult;
 
   /**
    * Performs instant indexing (blocking) of a collection data store post.
@@ -40,7 +56,7 @@ interface KeyValueDataStore {
    * @since 5.2
    * @param key A key to retrieve data from
    */
-  get(key: string): any;
+  get(key: string): unknown;
 
   /**
    * Removes data associated with a key.
@@ -53,11 +69,15 @@ interface KeyValueDataStore {
 }
 
 interface SearchResult {
-  toArray(): any[];
-  each(callback: (err: DataStoreError, data: any) => void): void;
+  toArray(): unknown[];
+  each(
+    callback: (err: DataStoreError | undefined, data: unknown) => void
+  ): void;
   hasNext(): boolean;
-  next(): any;
-  length(callback: (err: DataStoreError, length: number) => void): void;
+  next(): unknown;
+  length(
+    callback: (err: DataStoreError | undefined, length: number) => void
+  ): void;
 }
 
 interface DataStoreError {

package/{hidden → types}/javax/jcr/Binary/index.d.ts

@@ -3,32 +3,11 @@
  * <code>BINARY</code>. The <code>Binary</code> interface and the related
  * methods in {@link Property}, {@link Value} and {@link ValueFactory} replace
  * the deprecated {@link Value#getStream} and {@link Property#getStream}
- * methods.Returns an {@link InputStream} representation of this value. Each call to
- * <code>getStream()</code> returns a new stream. The API consumer is
- * responsible for calling <code>close()</code> on the returned stream.
- * <p>
- * If {@link #dispose()} has been called on this <code>Binary</code>
- * object, then this method will throw the runtime exception
- * {@link java.lang.IllegalStateException}.Reads successive bytes from the specified <code>position</code> in this
- * <code>Binary</code> into the passed byte array until either the byte
- * array is full or the end of the <code>Binary</code> is encountered.
- * <p>
- * If {@link #dispose()} has been called on this <code>Binary</code>
- * object, then this method will throw the runtime exception
- * {@link java.lang.IllegalStateException}.
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns the size of this <code>Binary</code> value in bytes.
- * <p>
- * If {@link #dispose()} has been called on this <code>Binary</code>
- * object, then this method will throw the runtime exception
- * {@link java.lang.IllegalStateException}.Releases all resources associated with this <code>Binary</code> object
- * and informs the repository that these resources may now be reclaimed.
- * An application should call this method when it is finished with the
- * <code>Binary</code> object.
+ * methods.
  * @since JCR 2.0
  * @since Sitevision 3.5
  */
-interface 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
@@ -81,6 +60,4 @@ interface Binary {
   
     */
   dispose(): void;
-}
-
-export default Binary;
+};

package/types/javax/jcr/Binary/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getStream: function getStream() {},
+  read: function read() {},
+  getSize: function getSize() {},
+  dispose: function dispose() {}
+};
+exports["default"] = _default;

package/{hidden → types}/javax/jcr/Credentials/index.d.ts

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

package/types/javax/jcr/Credentials/index.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {};
+exports["default"] = _default;

package/{hidden → types}/javax/jcr/ImportUUIDBehavior/index.d.ts

@@ -6,6 +6,6 @@
  * <p><strong>Sitevision note:</strong> Unsupported operation</p>
   
     */
-interface ImportUUIDBehavior {}
-
-export default ImportUUIDBehavior;
+export type ImportUUIDBehavior = {
+  undefined;
+};

package/types/javax/jcr/ImportUUIDBehavior/index.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {};
+exports["default"] = _default;

package/{hidden → types}/javax/jcr/Item/index.d.ts

@@ -1,127 +1,14 @@
-import Node from "../Node";
+import type { Node } from "../Node";
 import Session from "../../../../server/Session";
-import 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>.Returns the normalized absolute path to this item.Returns the name of this <code>Item</code> in qualified form. If this
- * <code>Item</code> is the root node of the workspace, an empty string is
- * returned.Returns the ancestor of this <code>Item</code> at the specified depth. An
- * ancestor of depth <i>x</i> is the <code>Item</code> that is <i>x</i>
- * levels down along the path from the root node to <i>this</i>
- * <code>Item</code>. <ul> <li><i>depth</i> = 0 returns the root node of a
- * workspace. <li><i>depth</i> = 1 returns the child of the root node along
- * the path to <i>this</i> <code>Item</code>. <li><i>depth</i> = 2 returns
- * the grandchild of the root node along the path to <i>this</i>
- * <code>Item</code>. <li>And so on to <i>depth</i> = <i>n</i>, where
- * <i>n</i> is the depth of <i>this</i> <code>Item</code>, which returns
- * <i>this</i> <code>Item</code> itself. </ul>
- * <p>
- * If this node has more than one path (i.e., if it is a descendant of a
- * shared node) then the path used to define the ancestor is
- * implementaion-dependent.
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns the parent of this <code>Item</code>.Returns the depth of this <code>Item</code> in the workspace item graph.
- * <ul> <li>The root node returns 0. <li>A property or child node of the
- * root node returns 1. <li>A property or child node of a child node of the
- * root returns 2. <li>And so on to <i>this</i> <code>Item</code>. </ul>
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns the <code>Session</code> through which this <code>Item</code> was
- * acquired.
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>Indicates whether this <code>Item</code> is a <code>Node</code> or a
- * <code>Property</code>. Returns <code>true</code> if this
- * <code>Item</code> is a <code>Node</code>; Returns <code>false</code> if
- * this <code>Item</code> is a <code>Property</code>.Returns <code>true</code> if this is a new item, meaning that it exists
- * only in transient storage on the <code>Session</code> and has not yet
- * been saved. Within a transaction, <code>isNew</code> on an
- * <code>Item</code> may return <code>false</code> (because the item has
- * been saved) even if that <code>Item</code> is not in persistent storage
- * (because the transaction has not yet been committed).
- * <p>
- * Note that if an item returns <code>true</code> on <code>isNew</code>,
- * then by definition is parent will return <code>true</code> on
- * <code>isModified</code>.
- * <p>
- * Note that in read-only implementations, this method will always return
- * <code>false</code>.
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns <code>true</code> if this <code>Item</code> has been saved but
- * has subsequently been modified through the current session and therefore
- * the state of this item as recorded in the session differs from the state
- * of this item as saved. Within a transaction, <code>isModified</code> on
- * an <code>Item</code> may return <code>false</code> (because the
- * <code>Item</code> has been saved since the modification) even if the
- * modification in question is not in persistent storage (because the
- * transaction has not yet been committed).
- * <p>
- * Note that in read-only implementations, this method will always return
- * <code>false</code>.
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns <code>true</code> if this <code>Item</code> object (the Java
- * object instance) represents the same actual workspace item as the object
- * <code>otherItem</code>.
- * <p>
- * Two <code>Item</code> objects represent the same workspace item if and
- * only if all the following are true: <ul> <li>Both objects were acquired
- * through <code>Session</code> objects that were created by the same
- * <code>Repository</code> object.</li> <li>Both objects were acquired
- * through <code>Session</code> objects bound to the same repository
- * workspace.</li> <li>The objects are either both <code>Node</code> objects
- * or both <code>Property</code> objects.</li> <li>If they are
- * <code>Node</code> objects, they have the same identifier.</li> <li>If
- * they are <code>Property</code> objects they have identical names and
- * <code>isSame</code> is true of their parent nodes.</li> </ul> This method
- * does not compare the <i>states</i> of the two items. For example, if two
- * <code>Item</code> objects representing the same actual workspace item
- * have been retrieved through two different sessions and one has been
- * modified, then this method will still return <code>true</code> when
- * comparing these two objects. Note that if two <code>Item</code> objects
- * representing the same workspace item are retrieved through the
- * <i>same</i> session they will always reflect the same state.
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>Accepts an <code>ItemVisitor</code>. Calls the appropriate
- * <code>ItemVisitor</code> <code>visit</code> method of the according to
- * whether <i>this</i> <code>Item</code> is a <code>Node</code> or a
- * <code>Property</code>.Validates all pending changes currently recorded in this
- * <code>Session</code> that apply to this <code>Item</code> or any of its
- * descendants (that is, the subgraph rooted at this Item). If validation of
- * <i>all</i> pending changes succeeds, then this change information is
- * cleared from the <code>Session</code>. If the <code>save</code> occurs
- * outside a transaction, the changes are persisted and thus made visible to
- * other <code>Sessions</code>. If the <code>save</code> occurs within a
- * transaction, the changes are not persisted until the transaction is
- * committed.
- * <p>
- * If validation fails, then no pending changes are saved and they remain
- * recorded on the <code>Session</code>. There is no best-effort or partial
- * save.
- * <p>
- * The item in persistent storage to which a transient item is saved isIf <code>keepChanges</code> is <code>false</code>, this method discards
- * all pending changes currently recorded in this <code>Session</code> that
- * apply to this Item or any of its descendants (that is, the subgraph
- * rooted at this Item)and returns all items to reflect the current saved
- * state. Outside a transaction this state is simple the current state of
- * persistent storage. Within a transaction, this state will reflect
- * persistent storage as modified by changes that have been saved but not
- * yet committed.
- * <p>
- * If <code>keepChanges</code> is true then pending change are not discarded
- * but items that do not have changes pending have their state refreshed to
- * reflect the current saved state, thus revealing changes made by other
- * sessions.Removes <code>this</code> item (and its subgraph).
- * <p>
- * To persist a removal, a <code>save</code> must be performed that includes
- * the (former) parent of the removed item within its scope.
- * <p>
- * If a node with same-name siblings is removed, this decrements by one the
- * indices of all the siblings with indices greater than that of the removed
- * node. In other words, a removal compacts the array of same-name siblings
- * and causes the minimal re-numbering required to maintain the original
- * order but leave no gaps in the numbering.
+ * <code>{@link Property}</code>.
   
     */
-interface Item {
+export type Item = {
   /**
    * Returns the normalized absolute path to this item.
    * @return the normalized absolute path of this <code>Item</code>.
@@ -348,6 +235,4 @@ interface Item {
    * @see javax.jcr.Session#removeItem(String)
    */
   remove(): void;
-}
-
-export default Item;
+};

package/types/javax/jcr/Item/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getPath: function getPath() {},
+  getName: function getName() {},
+  getAncestor: function getAncestor() {},
+  getParent: function getParent() {},
+  getDepth: function getDepth() {},
+  getSession: function getSession() {},
+  isNode: function isNode() {},
+  isNew: function isNew() {},
+  isModified: function isModified() {},
+  isSame: function isSame() {},
+  accept: function accept() {},
+  save: function save() {},
+  refresh: function refresh() {},
+  remove: function remove() {}
+};
+exports["default"] = _default;

package/{hidden → types}/javax/jcr/ItemVisitor/index.d.ts

@@ -1,5 +1,6 @@
-import Property from "../Property";
-import Node from "../Node";
+import type { Property } from "../Property";
+
+import type { Node } from "../Node";
 
 /**
  * This interface defines two signatures of the <code>visit</code> method; one
@@ -11,14 +12,10 @@ import Node from "../Node";
  * this interface can be written for different purposes. It is, for example,
  * possible for the <code>{@link #visit(Node node)}</code> method to call
  * <code>accept</code> on the children of the passed node and thus recurse
- * through the tree performing some operation on each <code>Item</code>.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
- * throws an exception the visiting process is aborted.This method is called when the <code>ItemVisitor</code> is passed to the
- * <code>accept</code> method of a <code>Node</code>. If this method throws
- * an exception the visiting process is aborted.
+ * through the tree performing some operation on each <code>Item</code>.
   
     */
-interface 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
@@ -36,6 +33,4 @@ interface ItemVisitor {
    * @throws RepositoryException if an error occurs
    */
   visit(node: Node): void;
-}
-
-export default ItemVisitor;
+};

package/types/javax/jcr/ItemVisitor/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  visit: function visit() {}
+};
+exports["default"] = _default;

package/{hidden → types}/javax/jcr/NamespaceRegistry/index.d.ts

@@ -4,22 +4,7 @@
  * Workspace#getNamespaceRegistry}. The namespace registry contains the default
  * prefixes of the registered namespaces. The namespace registry may contain
  * namespaces that are not used in repository content, and there may be
- * repository content with namespaces that are not included in the registry.Sets a one-to-one mapping between <code>prefix</code> and
- * <code>uri</code> in the global namespace registry of this repository.
- * <p>
- * Assigning a new prefix to a URI that already exists in the namespace
- * registry erases the old prefix. In general this can almost always be
- * done, though an implementation is free to prevent particular remappings
- * by throwing a <code>NamespaceException</code>.
- * <p>
- * On the other hand, taking a prefix that is already assigned to a URI and
- * re-assigning it to a new URI in effect unregisters that URI. Therefore,
- * the same restrictions apply to this operation as to
- * <code>NamespaceRegistry.unregisterNamespace</code>.
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>Removes a namespace mapping from the registry.
- *
- * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns an array holding all currently registered prefixes.Returns an array holding all currently registered URIs.Returns the URI to which the given <code>prefix</code> is mapped.Returns the prefix which is mapped to the given <code>uri</code>.A constant for the predefined namespace prefix "jcr".A constant for the predefined namespace prefix "nt".A constant for the predefined namespace prefix "mix".A constant for the predefined namespace prefix "xml".A constant for the predefined namespace prefix "" (the empty prefix).A constant for the predefined namespace mapped by default to the prefix
+ * repository content with namespaces that are not included in the registry.A constant for the predefined namespace prefix "jcr".A constant for the predefined namespace prefix "nt".A constant for the predefined namespace prefix "mix".A constant for the predefined namespace prefix "xml".A constant for the predefined namespace prefix "" (the empty prefix).A constant for the predefined namespace mapped by default to the prefix
  * "jcr".A constant for the predefined namespace mapped by default to the prefix
  * "nt".A constant for the predefined namespace mapped by default to the prefix
  * "mix".A constant for the predefined namespace mapped by default to the prefix
@@ -27,7 +12,7 @@
  * "" (the empty prefix).
  * @see Workspace#getNamespaceRegistry
  */
-interface NamespaceRegistry {
+export type NamespaceRegistry = {
   /**
    * Sets a one-to-one mapping between <code>prefix</code> and
    * <code>uri</code> in the global namespace registry of this repository.
@@ -95,6 +80,4 @@ interface NamespaceRegistry {
    * @throws RepositoryException if another error occurs.
    */
   getPrefix(uri: string): string;
-}
-
-export default NamespaceRegistry;
+};

package/types/javax/jcr/NamespaceRegistry/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  registerNamespace: function registerNamespace() {},
+  unregisterNamespace: function unregisterNamespace() {},
+  getPrefixes: function getPrefixes() {},
+  getURIs: function getURIs() {},
+  getURI: function getURI() {},
+  getPrefix: function getPrefix() {}
+};
+exports["default"] = _default;