@jahia/javascript-modules-library 0.3.0 → 0.5.1

package/types/core/server/framework/defineJahiaComponent.d.ts

@@ -1,41 +0,0 @@
-/**
- * @typedef {Object} JahiaComponent
- * @property {string} [id] - The ID of the component (autogenerated but can be overridden)
- * @property {string} name - The name of the component.
- * @property {string} [displayName] - The display name of the component (in jahia's UI), optional.
- * @property {"template"|"view"} componentType - The type of the component.
- * @property {string} nodeType - The content node type the component applies to.
- * @property {Record<string, string>} [properties] - Properties to add on the component, optional.
- */
-/**
- * Using this function provides autocomplete on the jahiaComponent properties.
- * @param {JahiaComponent} jahiaComponent - An object containing the Jahia component to define.
- * @returns {JahiaComponent} The jahiaComponent object.
- */
-export function defineJahiaComponent(jahiaComponent: JahiaComponent): JahiaComponent;
-export type JahiaComponent = {
-    /**
-     * - The ID of the component (autogenerated but can be overridden)
-     */
-    id?: string;
-    /**
-     * - The name of the component.
-     */
-    name: string;
-    /**
-     * - The display name of the component (in jahia's UI), optional.
-     */
-    displayName?: string;
-    /**
-     * - The type of the component.
-     */
-    componentType: "template" | "view";
-    /**
-     * - The content node type the component applies to.
-     */
-    nodeType: string;
-    /**
-     * - Properties to add on the component, optional.
-     */
-    properties?: Record<string, string>;
-};

package/types/core/server/framework/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./register";
-export * from "./defineJahiaComponent";

package/types/core/server/framework/register.d.ts

@@ -1,7 +0,0 @@
-/**
- * Registers Jahia components into the global registry as views
- * @param {object} jahiaComponents an object containing the jahia components to register
- * @returns {void}
- * TODO We will probably want to revisit this function once we handle global component registration in ticket https://jira.jahia.org/browse/BACKLOG-22400
- */
-export function registerJahiaComponents(jahiaComponents: object): void;

package/types/core/server/hooks/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./useGQLQuery";
-export * from "./useJCRQuery";
-export * from "./useServerContext";
-export * from "./useUrlBuilder";

package/types/core/server/hooks/useGQLQuery.d.ts

@@ -1,5 +0,0 @@
-export function useGQLQuery({ query, variables, operationName }: {
-    query: string;
-    variables: object;
-    operationName: string;
-}): object;

package/types/core/server/hooks/useJCRQuery.d.ts

@@ -1,3 +0,0 @@
-export function useJCRQuery({ query }: {
-    query: string;
-}): object;

package/types/core/server/hooks/useServerContext.d.ts

@@ -1,14 +0,0 @@
-/**
- * Returns the current server context
- * @returns {import('@jahia/javascript-modules-library').ServerContext} the server context
- */
-export function useServerContext(): import('@jahia/javascript-modules-library').ServerContext;
-export function ServerContextProvider({ renderContext, currentResource, currentNode, mainNode, bundleKey, children }: {
-    renderContext: any;
-    currentResource: any;
-    currentNode: any;
-    mainNode: any;
-    bundleKey: any;
-    children: any;
-}): React.JSX.Element;
-import React from "react";

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

@@ -1,31 +0,0 @@
-/**
- * @typedef {Object} UrlBuilderType
- * @property {function({assetPath: string, moduleName?: string, parameters?: object}): string} buildStaticUrl
- * @property {function({nodePath: string, extension?: string, language?:string, mode?:string, parameters?: object}): string} buildNodeUrl
- * @property {function({nodePath: string, extension?: string, language?:string, mode?:string, parameters?: object}): string} buildHtmlFragmentUrl
- */
-/**
- * @returns {UrlBuilderType}
- */
-export function useUrlBuilder(): UrlBuilderType;
-export type UrlBuilderType = {
-    buildStaticUrl: (arg0: {
-        assetPath: string;
-        moduleName?: string;
-        parameters?: object;
-    }) => string;
-    buildNodeUrl: (arg0: {
-        nodePath: string;
-        extension?: string;
-        language?: string;
-        mode?: string;
-        parameters?: object;
-    }) => string;
-    buildHtmlFragmentUrl: (arg0: {
-        nodePath: string;
-        extension?: string;
-        language?: string;
-        mode?: string;
-        parameters?: object;
-    }) => string;
-};

package/types/core/server/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./components";
-export * from "./framework";
-export * from "./hooks";
-export * from "./utils";

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

@@ -1,2 +0,0 @@
-export * from "./jcr";
-export * from "./urlBuilder";

package/types/core/server/utils/jcr/getChildNodes.d.ts

@@ -1,9 +0,0 @@
-/**
- * Returns an array of child nodes of a given node.
- * @param {import("org.jahia.services.content").JCRNodeWrapper} node - The node to get the child nodes from.
- * @param {number} limit the maximum number of nodes to return (-1 to return all nodes, but be careful with this as it can be very slow and memory consuming, it's better to use a reasonable limit and use pagination if needed)
- * @param {number} [offset=0] the offset to start from
- * @param {function} [filter] - A function to filter the nodes to be returned.
- * @returns {import("org.jahia.services.content").JCRNodeWrapper[]} An array of child nodes.
- */
-export function getChildNodes(node: import("org.jahia.services.content").JCRNodeWrapper, limit: number, offset?: number, filter?: Function): import("org.jahia.services.content").JCRNodeWrapper[];

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

@@ -1,12 +0,0 @@
-/**
- * Returns a node from a path or identifier
- * @param {object} props - The properties object containing either the node identifier or the node path.
- * @param {string} [props.identifier] - The node identifier.
- * @param {string} [props.path] - The node path.
- * @param {import("org.jahia.services.content").JCRSessionWrapper} session - The JCR session.
- * @returns {import("org.jahia.services.content").JCRNodeWrapper} The node.
- */
-export function getNodeFromPathOrId(props: {
-    identifier?: string;
-    path?: string;
-}, session: import("org.jahia.services.content").JCRSessionWrapper): import("org.jahia.services.content").JCRNodeWrapper;

package/types/core/server/utils/jcr/getNodeProps.d.ts

@@ -1,7 +0,0 @@
-/**
- * Extracts the properties from a node
- * @param {import("org.jahia.services.content").JCRNodeWrapper} node the node on which to extract the properties
- * @param {Array} props the name of the properties to extract
- * @returns {Object} an object containing the property values
- */
-export function getNodeProps(node: import("org.jahia.services.content").JCRNodeWrapper, props: any[]): any;

package/types/core/server/utils/jcr/getNodesByJCRQuery.d.ts

@@ -1,9 +0,0 @@
-/**
- * Execute a JCR SQL2 query and return the result as an array of nodes
- * @param {import("org.jahia.services.content").JCRSessionWrapper} session the JCR session to use
- * @param {string} query the JCR SQL2 query to execute
- * @param {number} limit the maximum number of nodes to return (-1 to return all nodes, but be careful with this as it can be very slow and memory consuming, it's better to use a reasonable limit and use pagination if needed)
- * @param {number} [offset=0] the offset to start from
- * @returns {import('org.jahia.services.content').JCRNodeWrapper[]} an array containing the nodes returned by the query
- */
-export function getNodesByJCRQuery(session: import("org.jahia.services.content").JCRSessionWrapper, query: string, limit: number, offset?: number): import('org.jahia.services.content').JCRNodeWrapper[];

package/types/core/server/utils/jcr/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./getChildNodes";
-export * from "./getNodeFromPathOrId";
-export * from "./getNodeProps";
-export * from "./getNodesByJCRQuery";

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

@@ -1 +0,0 @@
-export * from "./urlBuilder";

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,19 +0,0 @@
-export * from "./core";
-export * from "./nav";
-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/index.d.ts

@@ -1 +0,0 @@
-export * from "./server";

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

@@ -1 +0,0 @@
-export * from "./navBuilder";

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

@@ -1 +0,0 @@
-export * from "./navBuilder";

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;
-}
-