@jahia/javascript-modules-library 0.5.5 → 0.6.0

package/dist/org.jahia.services.content.d.ts

@@ -1,10 +1,12 @@
 declare module 'org.jahia.services.content' {
 import { ServletRequest } from 'javax.servlet';
+import { Iterable } from 'java.lang';
 import { Locale, List, Map, Date } from 'java.util';
 import { HttpServletRequest } from 'javax.servlet.http';
 import { QueryWrapper } from 'org.jahia.services.query';
 import { JCRSiteNode } from 'org.jahia.services.content.decorator';
 import { JahiaUser } from 'org.jahia.services.usermanager';
+import { ExtendedNodeType } from 'org.jahia.services.content.nodetypes';
 import { NodeIterator, Item, Node, PropertyIterator, Binary, Property } from 'javax.jcr';
 export class JCRCallback<T> {
   /**
@@ -163,7 +165,7 @@ export class JCRItemWrapper {
 /**
  * @author Christophe Laprun
 */
-export class JCRNodeIteratorWrapper {
+export class JCRNodeIteratorWrapper extends Iterable<JCRNodeWrapper> {
   /**
    * Returns the next Node in the iteration.
    *
@@ -173,6 +175,19 @@ export class JCRNodeIteratorWrapper {
    *          Nodes.
   */
   nextNode(): Node;
+  /**
+   * Returns the total number of of items available through this iterator. For
+   * example, for some node N, N.getNodes().getSize()
+   * returns the number of child nodes of N visible through the
+   * current Session. In some implementations precise information
+   * about the number of elements may not be available. In such cases this
+   * method must return -1. API clients will then be able to use
+   * RangeIterator.getNumberRemaining to get an estimate on the
+   * number of elements.
+   *
+   * @return a long
+  */
+  getSize(): number;
   /**
    * Returns `true` if the iteration has more elements.
    * (In other words, returns `true` if {@link #next} would
@@ -204,6 +219,12 @@ export class JCRNodeWrapper {
    * @return The wrapped property at relPath.
   */
   getProperty(relPath: string): JCRPropertyWrapper;
+  /**
+   * {@inheritDoc}
+   *
+   * @return an array of  ExtendedNodeType objects.
+  */
+  getMixinNodeTypes(): ExtendedNodeType[];
   /**
    * Checks if the current user has a permission or not
    *
@@ -387,6 +408,24 @@ export class JCRNodeWrapper {
    * {@inheritDoc}
   */
   getPath(): string;
+  /**
+   * Get the translation node
+   * Use only in un-localized session
+   *
+   * @param locale
+   * @return
+   * @throws RepositoryException in case of JCR-related errors
+  */
+  getI18N(locale: Locale): Node;
+  /**
+   * Get the translation node
+   * Use only in un-localized session
+   *
+   * @param locale
+   * @return
+   * @throws RepositoryException in case of JCR-related errors
+  */
+  getI18N(locale: Locale, fallback: boolean): Node;
   /**
    * Returns available translation sub-nodes of this node.
    *
@@ -1311,6 +1350,7 @@ export class JCRSessionWrapper {
   getNode(path: string): JCRNodeWrapper;
   getNode(path: string, checkVersion: boolean): JCRNodeWrapper;
   getUser(): JahiaUser;
+  getAliasedUser(): JahiaUser;
   getNodeByIdentifier(id: string): JCRNodeWrapper;
   getProperty(absPath: string): Property;
   nodeExists(absPath: string): boolean;

package/dist/org.jahia.services.content.decorator.d.ts

@@ -1,6 +1,6 @@
 declare module 'org.jahia.services.content.decorator' {
 import { Locale, Set, List } from 'java.util';
-import { JCRNodeWrapper } from 'org.jahia.services.content';
+import { JCRNodeWrapper, JCRNodeIteratorWrapper } from 'org.jahia.services.content';
 /**
  * JCR node representing the Jahia virtual site.
  *
@@ -8,7 +8,7 @@ import { JCRNodeWrapper } from 'org.jahia.services.content';
  * Date: Mar 30, 2010
  * Time: 12:37:45 PM
 */
-export class JCRSiteNode {
+export interface JCRSiteNode extends JCRNodeWrapper {
   /**
    * @return list of inactive live languages
   */
@@ -58,6 +58,7 @@ export class JCRSiteNode {
   getServerName(): string;
   getServerNameAliases(): string[];
   getAllServerNames(): string[];
+  getSiteKey(): string;
   getInstalledModules(): string[];
   /**
    * Returns a set of all installed modules for this site, their direct and transitive dependencies (the whole dependency tree).
@@ -87,6 +88,100 @@ export class JCRSiteNode {
    * @return true if this site is the default one on the server
   */
   isDefault(): boolean;
+  /**
+   * Returns a list holding the primary node type and all mixin node types for this node
+   *
+   * @return a list holding the primary node type and all mixin node types
+   * @throws RepositoryException in case of JCR-related errors
+  */
+  getNodeTypes(): string[];
+  /**
+   * {@inheritDoc}
+   *
+   * @return The wrapped node at relPath.
+  */
+  getNode(s: string): JCRNodeWrapper;
+  /**
+   * Returns all child nodes of this node accessible through the current
+   * Session. Does not include properties of this
+   * Node. The same reacquisition semantics apply as with {@link
+   * #getNode(String)}. If this node has no accessible child nodes, then an
+   * empty iterator is returned.
+   *
+   * @return A NodeIterator over all child Nodes of
+   *         this Node.
+   * @throws RepositoryException if an error occurs.
+  */
+  getNodes(): JCRNodeIteratorWrapper;
+  /**
+   * Gets all child nodes of this node accessible through the current
+   * Session that match namePattern. The pattern may
+   * be a full name or a partial name with one or more wildcard characters
+   * ("*"), or a disjunction (using the "|"
+   * character to represent logical OR) of these. For example,
+   * 
+   * N.getNodes("jcr:* | myapp:report | my doc")
+   * 
+   * would return a NodeIterator holding all accessible child
+   * nodes of N that are either called 'myapp:report',
+   * begin with the prefix 'jcr:' or are called 'my
+   * doc'.
+   * 
+   * The substrings within the pattern that are delimited by "|"
+   * characters and which may contain wildcard characters ("*")
+   * are called globs.
+   * 
+   * Note that leading and trailing whitespace around a glob is ignored, but
+   * whitespace within a disjunct forms part of the pattern to be matched.
+   * 
+   * The pattern is matched against the names (not the paths) of the immediate
+   * child nodes of this node.
+   * 
+   * If this node has no accessible matching child nodes, then an empty
+   * iterator is returned.
+   * 
+   * The same reacquisition semantics apply as with {@link
+   * #getNode(String)}.
+   *
+   * @param namePattern a name pattern.
+   * @return a NodeIterator.
+   * @throws RepositoryException if an unexpected error occurs.
+  */
+  getNodes(s: string): JCRNodeIteratorWrapper;
+  /**
+   * Gets all child nodes of this node accessible through the current
+   * Session that match one or more of the nameGlob
+   * strings in the passed array.
+   * 
+   * A glob may be a full name or a partial name with one or more wildcard
+   * characters ("*"). For example,
+   * 
+   * N.getNodes(new String[] {"jcr:*", "myapp:report", "my
+   * doc"})
+   * 
+   * would return a NodeIterator holding all accessible child
+   * nodes of N that are either called 'myapp:report',
+   * begin with the prefix 'jcr:' or are called 'my
+   * doc'.
+   * 
+   * Note that unlike in the case of the {@link #getNodes(String)} leading and
+   * trailing whitespace around a glob is not ignored.
+   * 
+   * The globs are matched against the names (not the paths) of the immediate
+   * child nodes of this node.
+   * 
+   * If this node has no accessible matching child nodes, then an empty
+   * iterator is returned.
+   * 
+   * The same reacquisition semantics apply as with {@link
+   * #getNode(String)}.
+   *
+   * @param nameGlobs an array of globbing strings.
+   * @return a NodeIterator.
+   * @throws RepositoryException if an unexpected error occurs.
+   * @since JCR 2.0
+  */
+  getNodes(nameGlobs: string[]): JCRNodeIteratorWrapper;
 }
 
 }

package/dist/org.jahia.services.render.d.ts

@@ -1,9 +1,12 @@
 declare module 'org.jahia.services.render' {
 import { Locale, Set, List, Map } from 'java.util';
 import { JCRNodeWrapper } from 'org.jahia.services.content';
+import { Serializable } from 'java.io';
 import { HttpServletRequest, HttpServletResponse } from 'javax.servlet.http';
+import { SettingsBean } from 'org.jahia.settings';
 import { JCRSiteNode } from 'org.jahia.services.content.decorator';
 import { JahiaUser } from 'org.jahia.services.usermanager';
+import { ExtendedNodeType } from 'org.jahia.services.content.nodetypes';
 /**
  * Template rendering context with the information about current request/response pair and optional template parameters.
  *
@@ -39,6 +42,7 @@ export class RenderContext {
   */
   getRedirect(): string;
   isEnterpriseEdition(): boolean;
+  getSettings(): SettingsBean;
   /**
    * @param node to check
    * @return true if the node is visible (in visibleTypes or without nonVisibleTypes)
@@ -89,7 +93,9 @@ export class Resource {
   getDependencies(): Set<string>;
   getRegexpDependencies(): Set<string>;
   getMissingResources(): string[];
+  getModuleParams(): Map<string, Serializable>;
   getPath(): string;
+  getResourceNodeType(): ExtendedNodeType;
   getNodePath(): string;
 }
 /**

package/dist/org.jahia.services.usermanager.d.ts

@@ -1,4 +1,5 @@
 declare module 'org.jahia.services.usermanager' {
+import { Properties } from 'java.util';
 /**
  * A JahiaUser represents a physical person who is defined by a username and
  * a password for authentication purpose. Every other property of a JahiaUser
@@ -22,6 +23,16 @@ export class JahiaUser {
    * @return the unique String identifier of this user.
   */
   getUserKey(): string;
+  /**
+   * Get user's properties list.
+   * The properties here should not be modified, as the modifications will
+   * not be serialized. Use the setProperty() method to modify a user's
+   * properties.
+   *
+   * @return Return a reference on the user's properties list, or null if no
+   *         property is present.
+  */
+  getProperties(): Properties;
   /**
    * Retrieve the requested user property.
    *

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "@jahia/javascript-modules-library",
-  "version": "0.5.5",
+  "version": "0.6.0",
+  "homepage": "https://github.com/Jahia/javascript-modules/tree/main/javascript-modules-library#readme",
+  "bugs": {
+    "url": "https://github.com/Jahia/javascript-modules/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com:Jahia/javascript-modules.git",

package/dist/core/server/hooks/useUrlBuilder.d.ts

@@ -1,52 +0,0 @@
-interface UrlBuilderType {
-    /**
-     * Builds a static URL for an asset.
-     *
-     * @returns The built URL.
-     */
-    buildStaticUrl(props: {
-        /** The path of the asset */
-        assetPath: string;
-        /**
-         * The name of the module used as prefix for the URL. If not provided, the current module is
-         * used.
-         */
-        moduleName?: string;
-        /** The parameters to append to the URL */
-        parameters?: Record<string, string>;
-    }): string;
-    /**
-     * Builds a URL for a JCR node.
-     *
-     * @returns {string} The built URL.
-     */
-    buildNodeUrl(props: {
-        /** The path of JCR node */
-        nodePath: string;
-        /** The extension to use to build the URL */
-        extension?: string;
-        /** The language to use to build the URL */
-        language?: string;
-        /** The mode to use to build the URL ('edit', 'preview', 'live') */
-        mode?: "edit" | "preview" | "live";
-        /** The parameters to append to the URL */
-        parameters?: Record<string, string>;
-    }): string;
-    /**
-     * Builds an HTML fragment URL for a JCR node.
-     *
-     * @returns {string} The built URL.
-     */
-    buildHtmlFragmentUrl(props: {
-        /** The path of JCR node */
-        nodePath: string;
-        /** The language to use to build the URL */
-        language?: string;
-        /** The mode to use to build the URL ('edit', 'preview', 'live') */
-        mode?: "edit" | "preview" | "live";
-        /** The parameters to append to the URL */
-        parameters?: Record<string, string>;
-    }): string;
-}
-export declare function useUrlBuilder(): UrlBuilderType;
-export {};

package/dist/core/server/utils/jcr/getNodeFromPathOrId.d.ts

@@ -1,14 +0,0 @@
-import type { JCRNodeWrapper, JCRSessionWrapper } from "org.jahia.services.content";
-/**
- * Returns a node from a path or identifier
- *
- * @param session - The JCR session.
- * @returns The node.
- */
-export declare function getNodeFromPathOrId(props: {
-    /** The node identifier */
-    identifier: string;
-} | {
-    /** The node path */
-    path: string;
-}, session: JCRSessionWrapper): JCRNodeWrapper | null;