@jahia/javascript-modules-library 0.4.0 → 0.5.1

package/types/core/server/utils/urlBuilder/urlBuilder.d.ts

@@ -1,27 +0,0 @@
-/**
- * Initialize the registry with default url builders
- * @returns {void}
- */
-export function initUrlBuilder(): void;
-/**
- * Provide URL generation for contents/files
- * If parameters are not valid, or if a node couldn't be found, it will log an warning and return '#'
- * @param {object} props props used to build the URL
- * @param {string} [props.value] the value to use to build the URL
- * @param {string} [props.path] the path of the resource to build the URL for
- * @param {object} [props.parameters] the parameters to append to the URL
- * @param {string} [props.mode] the mode to use to build the URL
- * @param {string} [props.language] the language to use to build the URL
- * @param {string} [props.extension] the extension to use to build the URL
- * @param {import('org.jahia.services.render').RenderContext} renderContext the current renderContext
- * @param {import('org.jahia.services.render').Resource} currentResource the current resource
- * @returns {string} the final URL
- */
-export function buildUrl(props: {
-    value?: string;
-    path?: string;
-    parameters?: object;
-    mode?: string;
-    language?: string;
-    extension?: string;
-}, renderContext: import('org.jahia.services.render').RenderContext, currentResource: import('org.jahia.services.render').Resource): string;

package/types/globals.d.ts

@@ -1,11 +0,0 @@
-import {Bundle} from 'org.osgi.framework';
-
-/**
- * The global declarations, where top-level objects are exposed to server-side scripts
- */
-declare global {
-    /**
-     * Exposed only during the server-side initial script registration process, not available during rendering
-     */
-    export const bundle : Bundle;
-}

package/types/index.d.ts

@@ -1,36 +0,0 @@
-export { RenderInBrowser } from "./core/server/components/render/RenderInBrowser";
-export { HydrateInBrowser } from "./core/server/components/render/HydrateInBrowser";
-export { Render } from "./core/server/components/render/Render";
-export { AbsoluteArea } from "./core/server/components/AbsoluteArea";
-export { AddContentButtons } from "./core/server/components/AddContentButtons";
-export { AddResources } from "./core/server/components/AddResources";
-export { Area } from "./core/server/components/Area";
-export { defineJahiaComponent } from "./core/server/framework/defineJahiaComponent";
-export { registerJahiaComponents } from "./core/server/framework/register";
-export { useGQLQuery } from "./core/server/hooks/useGQLQuery";
-export { useJCRQuery } from "./core/server/hooks/useJCRQuery";
-export { useUrlBuilder } from "./core/server/hooks/useUrlBuilder";
-export { getChildNodes } from "./core/server/utils/jcr/getChildNodes";
-export { getNodeFromPathOrId } from "./core/server/utils/jcr/getNodeFromPathOrId";
-export { getNodeProps } from "./core/server/utils/jcr/getNodeProps";
-export { getNodesByJCRQuery } from "./core/server/utils/jcr/getNodesByJCRQuery";
-export { buildNavMenu } from "./nav/server/navBuilder/navBuilder";
-export { useServerContext, ServerContextProvider } from "./core/server/hooks/useServerContext";
-export { buildUrl, initUrlBuilder } from "./core/server/utils/urlBuilder/urlBuilder";
-export * from './globals';
-export * from './java.io';
-export * from './java.net';
-export * from './java.security';
-export * from './java.util';
-export * from './javax.jcr';
-export * from './javax.servlet';
-export * from './javax.servlet.http';
-export * from './org.jahia.modules.javascript.modules.engine.js.server';
-export * from './org.jahia.services.content';
-export * from './org.jahia.services.content.decorator';
-export * from './org.jahia.services.query';
-export * from './org.jahia.services.render';
-export * from './org.jahia.services.usermanager';
-export * from './org.osgi.framework';
-export * from './server';
-export * from './servercontext';

package/types/nav/server/navBuilder/navBuilder.d.ts

@@ -1,78 +0,0 @@
-/**
- * Build a navigation menu
- * @param {number} maxDepth the maximum depth of the menu
- * @param {string} base the base path of the menu
- * @param {string} menuEntryView the view to use for each menu entry
- * @param {number} startLevelValue the level at which to start the menu
- * @param {import('org.jahia.services.render').RenderContext} renderContext the current render context
- * @param {import('org.jahia.services.render').Resource} currentResource the current resource
- * @returns {MenuEntry[]} an array of menu entries objects
- */
-export function buildNavMenu(maxDepth: number, base: string, menuEntryView: string, startLevelValue: number, renderContext: import('org.jahia.services.render').RenderContext, currentResource: import('org.jahia.services.render').Resource): MenuEntry[];
-export type MenuItemChild = {
-    /**
-     * - The page of a menu item child node
-     */
-    path: string;
-};
-export type MenuEntry = {
-    /**
-     * - The HTML rendered HTML menu entry
-     */
-    render: string;
-    /**
-     * - The node object for the menu entry
-     */
-    node: import('org.jahia.services.content').JCRNodeWrapper;
-    /**
-     * - Whether the node is in the path.
-     */
-    inPath: boolean;
-    /**
-     * - Whether the node is selected.
-     */
-    selected: boolean;
-    /**
-     * - The level of the node.
-     */
-    level: number;
-    /**
-     * - The children of the node
-     */
-    children?: MenuEntry[];
-};
-export type MenuConfig = {
-    /**
-     * - The current render context
-     */
-    renderContext: import('org.jahia.services.render').RenderContext;
-    /**
-     * - The current resource
-     */
-    currentResource: import('org.jahia.services.render').Resource;
-    /**
-     * - The workspace to use: 'default' for the edit workspace, 'live' for the live workspace
-     */
-    workspace: string;
-    /**
-     * - The name of the menu, used to match with the displayInMenuName property to see if this
-     * entry should be displayed in this specified menu
-     */
-    menuName: string;
-    /**
-     * - The level at which to start the menu
-     */
-    startLevelValue: number;
-    /**
-     * - The maximum depth of the menu
-     */
-    maxDepth: number;
-    /**
-     * - The view to use for each menu entry
-     */
-    menuEntryView?: string;
-    /**
-     * - The main resource node
-     */
-    mainResourceNode: import('org.jahia.services.content').JCRNodeWrapper;
-};

package/types/server.d.ts

@@ -1,27 +0,0 @@
-import {ConfigHelper, GQLHelper, OSGiHelper, RegistryHelper, RenderHelper} from 'org.jahia.modules.javascript.modules.engine.js.server';
-
-/**
- * A set of helpers that provide common functionality provided by Jahia for Javascript server-side rendering
- */
-export const server: {
-    /**
-     * This helper provides access to OSGi configuration
-     */
-    config: ConfigHelper,
-    /**
-     * This helper provides access Jahia's GraphQL API, to execute queries and mutations
-     */
-    gql: GQLHelper,
-    /**
-     * This helper provides access to OSGi bundle for resource loading and service access
-     */
-    osgi: OSGiHelper,
-    /**
-     * This helper provides access to Jahia's registry API, to register new UI objects or retrieving existing ones
-     */
-    registry: RegistryHelper,
-    /**
-     * This helper provides rendering functions such as registering page resources, adding cache dependencies or rendering components
-     */
-    render: RenderHelper
-};

package/types/servercontext.d.ts

@@ -1,29 +0,0 @@
-import {RenderContext, Resource} from 'org.jahia.services.render';
-import {JCRNodeWrapper} from 'org.jahia.services.content';
-
-/**
- * A context object that gives access to the underlying Jahia Java objects that are part of the current rendering context
- */
-export interface ServerContext {
-    /**
-     * Jahia's rendering context, it provides access to all kinds of context information, such as the current request, response, user, mode, mainResource and more
-     */
-    renderContext : RenderContext;
-    /**
-     * The current resource being rendered, which is a combination of the current node and its template/view information
-     */
-    currentResource : Resource;
-    /**
-     * The current JCR node being rendered
-     */
-    currentNode : JCRNodeWrapper;
-    /**
-     * The main JCR node being rendered, which is the root node of the current page
-     */
-    mainNode : JCRNodeWrapper;
-    /**
-     * The OSGi bundle key of the current module being rendered
-     */
-    bundleKey : string;
-}
-