@jahia/javascript-modules-library 0.0.1

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

@@ -0,0 +1,92 @@
+declare module 'org.jahia.services.content.decorator' {
+import { Locale, Set, List } from 'java.util';
+import { JCRNodeWrapper } from 'org.jahia.services.content';
+/**
+ * JCR node representing the Jahia virtual site.
+ *
+ * User: toto
+ * Date: Mar 30, 2010
+ * Time: 12:37:45 PM
+*/
+export class JCRSiteNode {
+  /**
+   * @return list of inactive live languages
+  */
+  getInactiveLiveLanguages(): Set<string>;
+  /**
+   * @return list of inactive languages
+  */
+  getInactiveLanguages(): Set<string>;
+  /**
+   * @deprecated use either {@link #getActiveLiveLanguagesAsLocales} or {@link #getActiveLiveLanguages()} methods instead
+  */
+  getActiveLanguagesAsLocales(): Locale[];
+  /**
+   * @deprecated use {@link #getActiveLiveLanguages} method instead
+  */
+  getActiveLanguages(): Set<string>;
+  /**
+   * Returns a set of active site languages
+   *
+   * @return a set of active site languages
+  */
+  getActiveLiveLanguages(): Set<string>;
+  /**
+   * Returns an List of active site language  ( as Locale ).
+   *
+   * @return a List of Locale elements
+  */
+  getActiveLiveLanguagesAsLocales(): Locale[];
+  /**
+   * Returns an List of inactive site language  ( as Locale ).
+   *
+   * @return a List of Locale elements
+  */
+  getInactiveLanguagesAsLocales(): Locale[];
+  getDefaultLanguage(): string;
+  getDescr(): string;
+  getHome(): JCRNodeWrapper;
+  getLanguages(): Set<string>;
+  /**
+   * Returns an List of site language  ( as Locale ).
+   *
+   * @return an List of Locale elements.
+  */
+  getLanguagesAsLocales(): Locale[];
+  getMandatoryLanguages(): Set<string>;
+  getResolveSite(): JCRSiteNode;
+  getServerName(): string;
+  getServerNameAliases(): string[];
+  getAllServerNames(): string[];
+  getInstalledModules(): string[];
+  /**
+   * Returns a set of all installed modules for this site, their direct and transitive dependencies (the whole dependency tree).
+   *
+   * @return a set of all installed modules for this site, their direct and transitive dependencies (the whole dependency tree)
+  */
+  getInstalledModulesWithAllDependencies(): Set<string>;
+  /**
+   * Get installed modules with their dependencies
+   * @return
+  */
+  getAllInstalledModules(): string[];
+  /**
+   * Returns the corresponding template set name of this virtual site.
+   *
+   * @return the corresponding template set name of this virtual site
+  */
+  getTemplatePackageName(): string;
+  getTitle(): string;
+  isHtmlMarkupFilteringEnabled(): boolean;
+  isMixLanguagesActive(): boolean;
+  isAllowsUnlistedLanguages(): boolean;
+  isWCAGComplianceCheckEnabled(): boolean;
+  /**
+   * Returns true if this site is the default one on the server.
+   *
+   * @return true if this site is the default one on the server
+  */
+  isDefault(): boolean;
+}
+
+}

package/types/org.jahia.services.query.d.ts

@@ -0,0 +1,35 @@
+declare module 'org.jahia.services.query' {
+import { JCRNodeIteratorWrapper } from 'org.jahia.services.content';
+import { Value } from 'javax.jcr';
+/**
+ * Wrapper for the JCR {@link QueryResult} adding facets and other methods.
+ *
+ * @author Thomas Draier
+*/
+export class QueryResultWrapper {
+  getApproxCount(): number;
+  /**
+   * Returns an iterator over all nodes that match the query. The nodes are
+   * returned according to the ordering specified in the query.
+   *
+   * @return a NodeIterator
+   * @throws RepositoryException if the query contains more than one selector,
+   *                             if this call is the second time either getRows or
+   *                             getNodes has been called on the same
+   *                             QueryResult object or if another error occurs.
+  */
+  getNodes(): JCRNodeIteratorWrapper;
+}
+/**
+ * An implementation of the JCR {@link Query} for multiple providers.
+ *
+ * @author Thomas Draier
+*/
+export class QueryWrapper {
+  execute(): QueryResultWrapper;
+  setLimit(limit: number): void;
+  setOffset(offset: number): void;
+  bindValue(varName: string, value: Value): void;
+}
+
+}

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

@@ -0,0 +1,168 @@
+declare module 'org.jahia.services.render' {
+import { Locale, Set, List, Map } from 'java.util';
+import { JCRNodeWrapper } from 'org.jahia.services.content';
+import { HttpServletRequest, HttpServletResponse } from 'javax.servlet.http';
+import { JCRSiteNode } from 'org.jahia.services.content.decorator';
+import { JahiaUser } from 'org.jahia.services.usermanager';
+/**
+ * Template rendering context with the information about current request/response pair and optional template parameters.
+ *
+ * @author toto
+*/
+export class RenderContext {
+  getRequest(): HttpServletRequest;
+  getResponse(): HttpServletResponse;
+  getUser(): JahiaUser;
+  getSite(): JCRSiteNode;
+  getURLGenerator(): URLGenerator;
+  getDisplayedModules(): Set<string>;
+  isEditMode(): boolean;
+  getMode(): string;
+  getEditModeConfigName(): string;
+  getServletPath(): string;
+  getWorkspace(): string;
+  isContributionMode(): boolean;
+  isLoggedIn(): boolean;
+  getTemplatesCacheExpiration(): Map<string, Map<string, number>>;
+  getMainResource(): Resource;
+  getContentType(): string;
+  getRenderedPaths(): Set<string>;
+  getMainResourceLocale(): Locale;
+  getUILocale(): Locale;
+  getFallbackLocale(): Locale;
+  isLiveMode(): boolean;
+  isPreviewMode(): boolean;
+  isAjaxRequest(): boolean;
+  getAjaxResource(): Resource;
+  /**
+   * @return the redirect
+  */
+  getRedirect(): string;
+  isEnterpriseEdition(): boolean;
+  /**
+   * @param node to check
+   * @return true if the node is visible (in visibleTypes or without nonVisibleTypes)
+   * @throws javax.jcr.RepositoryException
+  */
+  isVisible(node: JCRNodeWrapper): boolean;
+  /**
+   * @param node to check
+   * @return true if the node is editable (in editableTypes or without nonEditableTypes)
+   * @throws RepositoryException in case of JCR-related errors
+  */
+  isEditable(node: JCRNodeWrapper): boolean;
+  isForceUILocaleForJCRSession(): boolean;
+  isUgcEnabled(): boolean;
+  /**
+   * @return Whether the application is in read only mode, dependent on read only, full read only, and maintenance status currently activated/deactivated.
+  */
+  isReadOnly(): boolean;
+}
+/**
+ * A resource is the aggregation of a node and a specific template
+ * It's something that can be handled by the render engine to be displayed.
+ *
+ * @author toto
+*/
+export class Resource {
+  /**
+   * Get the node associated to the current resource, in case of a lazy resource the node will be load from jcr if it's null
+   * This function shouldn't not be call before the CacheFilter to avoid loading of node from JCR.
+   * Since CacheFilter is executed for each fragments now even if there are in cache.
+   *
+   * If the node is needed it should be requested after the CacheFilter or for cache key generation during aggregation
+   *
+   * @return The JCR Node if found, null if not
+  */
+  getNode(): JCRNodeWrapper;
+  /**
+   * Know if the JCR Node is available immediately, since the node may require lazy loading from JCR
+   * @return true if JCR Node is available immediately
+  */
+  isNodeLoaded(): boolean;
+  getTemplateType(): string;
+  getWorkspace(): string;
+  getLocale(): Locale;
+  getContextConfiguration(): string;
+  getResolvedTemplate(): string;
+  getTemplate(): string;
+  getDependencies(): Set<string>;
+  getRegexpDependencies(): Set<string>;
+  getMissingResources(): string[];
+  getPath(): string;
+  getNodePath(): string;
+}
+/**
+ * Main URL generation class. This class is exposed to the template developers to make it easy to them to access basic URLs such as ${url.edit}, ${url.userProfile}. User: toto Date: Sep 14, 2009 Time: 11:13:37 AM
+*/
+export class URLGenerator {
+  getResourcePath(): string;
+  getContext(): string;
+  getFiles(): string;
+  getFilesPlaceholders(): string;
+  getBase(): string;
+  getBasePlaceholders(): string;
+  getLive(): string;
+  getEdit(): string;
+  getPreview(): string;
+  getContribute(): string;
+  /**
+   * Returns the URL for the current resource in studio mode.
+   *
+   * @return the URL for the current resource in studio mode
+  */
+  getStudio(): string;
+  /**
+   * Returns the URL for the current resource in visual studio mode.
+   *
+   * @return the URL for the current resource in visual studio mode
+  */
+  getStudioVisual(): string;
+  getLogout(): string;
+  getCurrentModule(): string;
+  getCurrent(): string;
+  getLanguages(): Map<string, string>;
+  getLanguage(languageCode: string): string;
+  getTemplates(): Map<string, string>;
+  getTemplate(template: string): string;
+  getTemplateTypes(): Map<string, string>;
+  getTemplateType(templateType: string): string;
+  getBases(): Map<string, string>;
+  getBase(languageCode: string): string;
+  /**
+   * Returns the path to the templates folder.
+   *
+   * @return the path to the templates folder
+  */
+  getTemplatesPath(): string;
+  /**
+   * Returns the URL of the main resource (normally, page), depending on the current mode.
+   *
+   * @return the URL of the main resource (normally, page), depending on the current mode
+  */
+  getMainResource(): string;
+  getInitializers(): string;
+  getBaseContribute(): string;
+  getBaseEdit(): string;
+  getBaseLive(): string;
+  getBasePreview(): string;
+  getConvert(): string;
+  getBaseUserBoardEdit(): string;
+  getBaseUserBoardLive(): string;
+  getBaseUserBoardFrameEdit(): string;
+  getBaseUserBoardFrameLive(): string;
+  getRealResource(): string;
+  /**
+   * Returns the server URL, including scheme, host and port, depending on the current site. The URL is in the form :, e.g. http://www.jahia.org:8080. The port is omitted in case of standard
+   * HTTP (80) and HTTPS (443) ports.
+   * 
+   * If the site's server name is configured to be "localhost", then take the servername from the request.
+   *
+   * @return the server URL, including scheme, host and port, depending on the current site
+  */
+  getServer(): string;
+  getMyProfile(): string;
+  getLogin(): string;
+}
+
+}

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

@@ -0,0 +1,85 @@
+declare module 'org.jahia.services.usermanager' {
+/**
+ * A JahiaUser represents a physical person who is defined by a username and
+ * a password for authentication purpose. Every other property of a JahiaUser
+ * is stored in it's properties list, which hold key-value string pairs. For
+ * example email, firstname, lastname, ... information should be stored in this
+ * properties list.
+ *
+ * @author Fulco Houkes
+ * @author Khue Nguyen
+*/
+export class JahiaUser {
+  /**
+   * Return the user username.
+   *
+   * @return Return the username.
+  */
+  getUsername(): string;
+  /**
+   * Return the unique String identifier of this user.
+   *
+   * @return the unique String identifier of this user.
+  */
+  getUserKey(): string;
+  /**
+   * Retrieve the requested user property.
+   *
+   * @param key Property's name.
+   * @return Return the property's value of the specified key, or null if the
+   *         property does not exist.
+  */
+  getProperty(key: string): string;
+  /**
+   * Test if the user is member of the specified group.
+   *
+   * @param name   Groupname.
+   * @param siteID the site id
+   * @return Return true if the user is member of the specified group, or
+   *         false on any error.
+   * @deprecated
+  */
+  isMemberOfGroup(siteID: number, name: string): boolean;
+  /**
+   * Test if the user is an admin member
+   *
+   * @param siteID the site id
+   * @return Return true if the user is an admin member
+   *         false on any error.
+   * @deprecated
+  */
+  isAdminMember(siteID: number): boolean;
+  /**
+   * Test if the user is the root user
+   *
+   * @return Return true if the user is the root user
+   *         false on any error.
+  */
+  isRoot(): boolean;
+  /**
+   * Get the name of the provider of this user.
+   *
+   * @return String representation of the name of the provider of this user
+  */
+  getProviderName(): string;
+  /**
+   * Get the path of this user in the local store. For examle for LDAP user this will return the path of
+   * the user in the JCR with all necessary encoding.
+   *
+   * @return String representation of the name of the provider of this user
+  */
+  getLocalPath(): string;
+  /**
+   * Checks if the account is locked
+   *
+   * @return true if the account is locked
+  */
+  isAccountLocked(): boolean;
+  /**
+   * Get the realm name this user belongs to.
+   * @return
+  */
+  getRealm(): string;
+}
+
+}