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

package/client/requester/index.d.ts

@@ -1,13 +1,13 @@
-interface IRequesterOptions {
+interface RequesterOptions extends Record<string, any> {
   url: string;
-  data: any;
-  fileUpload: boolean;
+  data?: any;
+  fileUpload?: boolean;
 }
 
-export function doGet(options: IRequesterOptions): Promise<any>;
-export function doPut(options: IRequesterOptions): Promise<any>;
-export function doPost(options: IRequesterOptions): Promise<any>;
-export function doDelete(options: IRequesterOptions): Promise<any>;
+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 };

package/client/toasts/index.d.ts

@@ -1,10 +1,10 @@
 interface ToastOptions {
-  heading: string;
+  heading?: string;
   message: string;
-  type: string;
-  ttl: number;
-  callback: () => void;
-  checkmark: boolean;
+  type?: string;
+  ttl?: number;
+  callback?: () => void;
+  checkmark?: boolean;
 }
 
 export function publish(options: ToastOptions): void;

package/common/app/index.d.ts

@@ -23,7 +23,26 @@ export const webAppId: string;
  */
 export const webAppVersion: string;
 
-declare namespace app {
+/**
+ * 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 };
 }
 

package/common/events/index.d.ts

@@ -4,7 +4,10 @@
  * @param eventName The name of the event
  * @param callback The callback to trigger for the given event
  */
-export function on(eventName: string, callback: (options: any) => void): void;
+export function on(
+  eventName: string,
+  callback: (options: unknown) => void
+): void;
 /**
  * Emit a server side event
  *
@@ -13,7 +16,7 @@ export function on(eventName: string, callback: (options: any) => void): void;
  * @param eventName The name of the event to emit
  * @param options The options for the event
  */
-export function emit(eventName: string, options: any): void;
+export function emit(eventName: string, options: unknown): void;
 /**
  * Trigger a client side event
  *
@@ -22,7 +25,7 @@ export function emit(eventName: string, options: any): void;
  * @param eventName The name of the event to trigger
  * @param options The options for the event
  */
-export function trigger(eventName: string, options: any): void;
+export function trigger(eventName: string, options: unknown): void;
 
 declare namespace events {
   export { on, emit, trigger };

package/common/i18n/index.d.ts

@@ -1,4 +1,5 @@
 export function get(key: string): string;
+export function get(key: string, ...substitutions: string[]): string;
 
 declare namespace i18n {
   export { get };

package/common/router/index.d.ts

@@ -1,29 +1,49 @@
-export interface IRequest {
+import Node from '../../hidden/javax/jcr/Node';
+
+export interface Cookie {
+  name: string;
+  value: string;
+  httpOnly? = false;
+  secure? = false;
+  maxAge? = -1;
+  sameSite?: 'Strict' | 'Lax' | 'None' | undefined;
+}
+
+export interface Request {
   invalidateSession(): void;
-  header(headerName: string): void;
-  file(fileParameterName: string): void;
+  header(headerName: string): string | null;
+  file(fileParameterName: string): Node;
+  params: Record<string, string | number>;
+  cookies: Record<string, string>;
+  xhr: boolean;
+  session: any;
+  hostname: string;
+  protocol: string;
+  secure: boolean;
+  method: string;
+  path: string;
   /**
    * Can be populated in a hooks context and read from a render context
    */
-  context: any;
+  context: unknown | null;
 }
 
-interface IResponse {
+interface Response {
+  agnosticRender(html: string, initialData: unknown);
+  send(content: string): void;
+  json(data: unknown): void;
   set(name: string, value: string): Response;
   type(type: string): Response;
-  send(content: string): void;
-  sendFile(file: any): void;
+  sendFile(file: Node): void;
   status(status: number): Response;
-  agnosticRender(html: string, initialData: any);
-  json(data: any): void;
+  redirect(path: string, query?: string, status?: number): void;
+  cookie(cookie: Cookie): void;
+  clearCookie(name: string, path?: string): void;
+
   /**
    * This method will render a component with data
    */
-  render(route: string, data: any): void;
-  redirect(path: string, query: string, status: number): void;
-  cookie(cookie: any): void;
-  clearCookie(name: string, path: string): void;
-  sendError(errorCode: number, message: string): void;
+  render(route: string, data: unknown): void;
 }
 
 /**
@@ -36,7 +56,7 @@ interface IResponse {
  */
 export function get(
   route: string,
-  callback: (req: IRequest, res: IResponse) => void
+  callback: (req: Request, res: Response) => void
 ): void;
 /**
  * This method is triggered by a post request to a given route.
@@ -48,7 +68,7 @@ export function get(
  */
 export function post(
   route: string,
-  callback: (req: IRequest, res: IResponse) => void
+  callback: (req: Request, res: Response) => void
 ): void;
 /**
  * This method is triggered by a put request to a given route.
@@ -60,11 +80,11 @@ export function post(
  */
 export function put(
   route: string,
-  callback: (req: IRequest, res: IResponse) => void
+  callback: (req: Request, res: Response) => void
 ): void;
 declare function _delete(
   route: string,
-  callback: (req: IRequest, res: IResponse) => void
+  callback: (req: Request, res: Response) => void
 ): void;
 
 export { _delete as delete };
@@ -74,10 +94,12 @@ export { _delete as delete };
  *
  * @param callback The callback to trigger
  */
-export function use(callback: () => void): void;
+export function use(
+  callback: (req: Request, res: Response, next: Function) => void
+): void;
 
-export function getUrl(url: string): string;
-export function getStandaloneUrl(url: string): string;
+export function getUrl(path: string): string;
+export function getStandaloneUrl(path: string): string;
 
 /**
  * Note! Client side only

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

@@ -3,28 +3,7 @@
  * <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
  */

package/hidden/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/javax/jcr/Credentials/index.d.ts

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

package/hidden/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/javax/jcr/ImportUUIDBehavior/index.d.ts

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

package/hidden/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/javax/jcr/Item/index.d.ts

@@ -1,124 +1,11 @@
 import Node from "../Node";
 import Session from "../../../../server/Session";
+
 import 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 {

package/hidden/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/javax/jcr/ItemVisitor/index.d.ts

@@ -1,4 +1,5 @@
 import Property from "../Property";
+
 import Node from "../Node";
 
 /**
@@ -11,11 +12,7 @@ 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 {

package/hidden/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/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

package/hidden/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;