@jahia/javascript-modules-library 0.3.0 → 0.4.0

package/bin/jahia-deploy.mjs

@@ -0,0 +1,14 @@
+import dotenv from 'dotenv';
+import { execSync } from 'child_process';
+import path from 'path';
+dotenv.config();
+const deployMethod = process.env.JAHIA_DEPLOY_METHOD;
+const packageFilePath = path.resolve('dist/package.tgz');
+if (deployMethod === 'curl') {
+    console.log('Deploying URL curl to Jahia bundles REST API...');
+    console.log(execSync(`curl -s --user ${process.env.JAHIA_USER} --form bundle=@${packageFilePath} --form start=true ${process.env.JAHIA_HOST}/modules/api/bundles`, { encoding: 'utf8' }));
+}
+else {
+    console.log('Deploying using Docker copy...');
+    console.log(execSync(`docker cp ${packageFilePath} ${process.env.JAHIA_DOCKER_NAME}:/var/jahia/modules`, { encoding: 'utf8' }));
+}

package/core/server/components/AddResources.js

@@ -1 +1 @@
-import React from"react";import{useServerContext}from"../hooks";import{server}from"@jahia/javascript-modules-library-private";export function AddResources({...e}){const{renderContext:r}=useServerContext();return React.createElement("unwanteddiv",{dangerouslySetInnerHTML:{__html:server.render.addResources(e,r)}})}
+import React from"react";import{server}from"@jahia/javascript-modules-library-private";import{useServerContext}from"../hooks/useServerContext";export function AddResources(e){const{renderContext:r}=useServerContext();return React.createElement("unwanteddiv",{dangerouslySetInnerHTML:{__html:server.render.addResources(e,r)}})}

package/core/server/components/render/internal/InBrowser.js

@@ -1 +1 @@
-import React from"react";import{useServerContext}from"../../../hooks/useServerContext";import{AddResources}from"../../AddResources";import{buildUrl}from"../../../utils/urlBuilder";import{I18nextProvider}from"react-i18next";import i18n from"i18next";const getClientI18nStoreScript=(e,t)=>{const r=i18n.getResourceBundle(e,t);if(r){const n={};return n[e]={},n[e][t]=r,`<script type="text/javascript">\n        if(!window.__APPSHELL_INIT_DATA__) {\n            window.__APPSHELL_INIT_DATA__ = {};\n        }\n        if(!window.__APPSHELL_INIT_DATA__.initialI18nStore) {\n            window.__APPSHELL_INIT_DATA__.initialI18nStore = [];\n        }\n        window.__APPSHELL_INIT_DATA__.initialI18nStore.push(${JSON.stringify(n)});\n    <\/script>`}},getAppShellInitData=e=>`<script type="text/javascript">\n        if(!window.__APPSHELL_INIT_DATA__) {\n            window.__APPSHELL_INIT_DATA__ = {};\n        }\n        window.__APPSHELL_INIT_DATA__.moduleBaseUrl = '${e}';\n    <\/script>`;function InBrowser({child:e,props:t,dataKey:r,preRender:n}){const{bundleKey:i,currentResource:o,renderContext:a}=useServerContext(),s=o.getLocale().getLanguage(),c=getAppShellInitData(buildUrl({value:"/modules"},a,o)),l=getClientI18nStoreScript(s,i),_=buildUrl({value:"/modules/"+i+"/javascript/client/remote.js"},a,o),d=buildUrl({value:"/modules/javascript-modules-engine/javascript/apps/reactAppShell.js"},a,o),p={};return p[r]=encodeURIComponent(JSON.stringify({name:e.name,lang:s,bundle:i,props:t||{}})),React.createElement(React.Fragment,null,React.createElement("div",{...p},n&&React.createElement(I18nextProvider,{i18n:i18n},React.createElement(e,{...t}))),l&&React.createElement(AddResources,{key:`i18n_initialStore_${i}`,insert:!0,inlineResource:l}),React.createElement(AddResources,{key:"npm-engine-appShellInitData",insert:!0,inlineResource:c}),React.createElement(AddResources,{insert:!0,type:"javascript",targetTag:"body",resources:_}),React.createElement(AddResources,{type:"javascript",targetTag:"body",resources:d}))}export default InBrowser;
+import React from"react";import{useServerContext}from"../../../hooks/useServerContext";import{AddResources}from"../../AddResources";import{I18nextProvider}from"react-i18next";import i18n from"i18next";import{buildUrl}from"../../../utils/urlBuilder/urlBuilder";const getClientI18nStoreScript=(e,t)=>{const r=i18n.getResourceBundle(e,t);if(r){const n={[e]:{[t]:r}};return`<script type="text/javascript">\n        if(!window.__APPSHELL_INIT_DATA__) {\n            window.__APPSHELL_INIT_DATA__ = {};\n        }\n        if(!window.__APPSHELL_INIT_DATA__.initialI18nStore) {\n            window.__APPSHELL_INIT_DATA__.initialI18nStore = [];\n        }\n        window.__APPSHELL_INIT_DATA__.initialI18nStore.push(${JSON.stringify(n)});\n    <\/script>`}},getAppShellInitData=e=>`<script type="text/javascript">\n        if(!window.__APPSHELL_INIT_DATA__) {\n            window.__APPSHELL_INIT_DATA__ = {};\n        }\n        window.__APPSHELL_INIT_DATA__.moduleBaseUrl = ${JSON.stringify(e)};\n    <\/script>`;function InBrowser({child:e,props:t,dataKey:r,preRender:n}){const{bundleKey:i,currentResource:o,renderContext:a}=useServerContext(),s=o.getLocale().getLanguage(),c=getAppShellInitData(buildUrl({value:"/modules"},a,o)),l=getClientI18nStoreScript(s,i),_=buildUrl({value:"/modules/"+i+"/javascript/client/remote.js"},a,o),d=buildUrl({value:"/modules/javascript-modules-engine/javascript/apps/reactAppShell.js"},a,o),u={[r]:encodeURIComponent(JSON.stringify({name:e.name,lang:s,bundle:i,props:t||{}}))};return React.createElement(React.Fragment,null,React.createElement("div",{...u},n&&React.createElement(I18nextProvider,{i18n:i18n},React.createElement(e,{...t}))),l&&React.createElement(AddResources,{key:`i18n_initialStore_${i}`,insert:!0,inlineResource:l}),React.createElement(AddResources,{key:"npm-engine-appShellInitData",insert:!0,inlineResource:c}),React.createElement(AddResources,{insert:!0,type:"javascript",targetTag:"body",resources:_}),React.createElement(AddResources,{type:"javascript",targetTag:"body",resources:d}))}export default InBrowser;

package/core/server/framework/register.js

@@ -1 +1 @@
-import{server}from"@jahia/javascript-modules-library-private";export function registerJahiaComponents(e){if(!bundle)return void console.error("registerJahiaComponents: bundle is not available, make sure you are using this function inside the initialization of the bundle");const n=bundle.getSymbolicName(),o=server.registry.get("view","react");Object.keys(e).forEach((t=>{let i;const r=e[t].jahiaComponent;if(!r||!r.nodeType||!r.componentType)return void console.warn(`registerJahiaComponents(bundle=${n}: Missing mandatory property nodeType and/or componentType, skipping component name=${r.name} nodeType=${r.nodeType} id=${r.id} registration`);i={name:"default",templateType:"html",component:null};let a=r.id;delete r.id,i.component=e[t];const p={...i,...r};a||(a=`${n}_${p.componentType}_${p.nodeType}_${p.name}`),server.registry.add("view",a,o,p)}))}
+import{server}from"@jahia/javascript-modules-library-private";export function registerJahiaComponents(e){if(!bundle)return void console.error("registerJahiaComponents: bundle is not available, make sure you are using this function inside the initialization of the bundle");const n=bundle.getSymbolicName(),o=server.registry.get("view","react");for(const t of Object.values(e)){const{id:e,...i}=t.jahiaComponent;if(!i.nodeType||!i.componentType)return void console.warn(`registerJahiaComponents(bundle=${n}: Missing mandatory property nodeType and/or componentType, skipping component name=${i.name} nodeType=${i.nodeType} id=${e} registration`);const r={name:"default",templateType:"html",component:t,...i};server.registry.add("view",e??`${n}_${r.componentType}_${r.nodeType}_${r.name}`,o,r)}}

package/core/server/hooks/useJCRQuery.js

@@ -1 +1 @@
-import{useServerContext}from"./useServerContext";import{getNodesByJCRQuery}from"../utils/jcr";export const useJCRQuery=({query:e})=>{const{renderContext:r}=useServerContext();return getNodesByJCRQuery(r.getMainResource().getNode().getSession(),e,-1,0)};
+import{useServerContext}from"./useServerContext";import{getNodesByJCRQuery}from"../utils/jcr/getNodesByJCRQuery";export const useJCRQuery=({query:e})=>{const{renderContext:r}=useServerContext();return getNodesByJCRQuery(r.getMainResource().getNode().getSession(),e,-1,0)};

package/core/server/hooks/useUrlBuilder.js

@@ -1 +1 @@
-import{useServerContext}from"./useServerContext";import{buildUrl as originalBuildUrl}from"../utils/urlBuilder";export function useUrlBuilder(){const{renderContext:e,currentResource:r}=useServerContext(),t=({nodePath:t,extension:a,language:l,mode:n,parameters:o})=>originalBuildUrl({path:t,extension:a,language:l,mode:n,parameters:o},e,r);return{buildStaticUrl:({assetPath:t,moduleName:a=e?.getURLGenerator()?.getCurrentModule(),parameters:l})=>{let n=a+"/static"+(t?.startsWith("/")?"":"/")+t;return originalBuildUrl({value:n,parameters:l},e,r)},buildNodeUrl:t,buildHtmlFragmentUrl:({nodePath:e,language:r,mode:a,parameters:l})=>t({nodePath:e,extension:".html.ajax",language:r,mode:a,parameters:l})}}
+import{useServerContext}from"./useServerContext";import{buildUrl as originalBuildUrl}from"../utils/urlBuilder/urlBuilder";export function useUrlBuilder(){const{renderContext:e,currentResource:r}=useServerContext(),t=({nodePath:t,extension:a,language:l,mode:n,parameters:u})=>originalBuildUrl({path:t,extension:a,language:l,mode:n,parameters:u},e,r);return{buildStaticUrl:({assetPath:t,moduleName:a=e?.getURLGenerator()?.getCurrentModule(),parameters:l})=>{let n=a+"/static"+(t?.startsWith("/")?"":"/")+t;return originalBuildUrl({value:n,parameters:l},e,r)},buildNodeUrl:t,buildHtmlFragmentUrl:({nodePath:e,language:r,mode:a,parameters:l})=>t({nodePath:e,extension:".html.ajax",language:r,mode:a,parameters:l})}}

package/index.js

@@ -1 +1 @@
-export*from"./core";export*from"./nav";
+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{useServerContext,ServerContextProvider}from"./core/server/hooks/useServerContext";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{buildUrl,initUrlBuilder}from"./core/server/utils/urlBuilder/urlBuilder";export{buildNavMenu}from"./nav/server/navBuilder/navBuilder";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/javascript-modules-library",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "main": "index.js",
   "types": "types/index.d.ts",
   "repository": "git@github.com:Jahia/javascript-modules.git",
@@ -17,10 +17,14 @@
     "lint:fix": "eslint --ext js,jsx,json,ts --fix src/",
     "prepack": "echo 'Please run 'mvn package' to create the tgz so the Maven version can be injected in the package.json' && exit 1"
   },
+  "bin": {
+    "jahia-deploy": "bin/jahia-deploy.mjs"
+  },
   "files": [
     "dist"
   ],
   "dependencies": {
+    "dotenv": "^16.4.7",
     "graphql": "^16.0.1",
     "graphql-tag": "^2.12.6",
     "prop-types": "^15.8.1"

package/types/bin/jahia-deploy.d.mts

@@ -0,0 +1 @@
+export {};

package/types/core/server/components/AbsoluteArea.d.ts

@@ -1,29 +1,35 @@
+import React from 'react';
 /**
  * Generates an absolute area in which editors may insert content objects.
- * @param {object} props The React properties for the component.
- * @param {string} [props.name] The name of the area.
- * @param {string} [props.areaView] The view to use for the area.
- * @param {string[]} [props.allowedTypes] The allowed types for the area.
- * @param {number} [props.numberOfItems] The number of items to display in the area.
- * @param {string} [props.subNodesView] The view to use for the subnodes.
- * @param {string} [props.path] Relative (to the current node) or absolute path to the node to include
- * @param {boolean} [props.editable] Enables or disables edition of this content in edit mode. Mainly used for absolute or references.
- * @param {number} [props.level] Ancestor level for absolute area - 0 is Home page, 1 first sub-pages, ...
- * @param {string} [props.areaType] Content type to be used to create the area (by default jnt:contentList)
- * @param {boolean} [props.limitedAbsoluteAreaEdit] Is the absolute area editable everywhere or only on the page containing its node.
- * @param {object} [props.parameters] the parameters to pass to the absolute area
- * @returns {JSX.Element} The AbsoluteArea component
+ * @returns The AbsoluteArea component
  */
-export function AbsoluteArea({ name, areaView, allowedTypes, numberOfItems, subNodesView, path, editable, level, areaType, limitedAbsoluteAreaEdit, parameters }: {
+export declare function AbsoluteArea({ name, areaView, allowedTypes, numberOfItems, subNodesView, path, editable, level, areaType, limitedAbsoluteAreaEdit, parameters }: Readonly<{
+    /** The name of the area. */
     name?: string;
+    /** The view to use for the area. */
     areaView?: string;
+    /** The allowed types for the area. */
     allowedTypes?: string[];
+    /** The number of items to display in the area. */
     numberOfItems?: number;
+    /** The view to use for the subnodes. */
     subNodesView?: string;
+    /** Relative (to the current node) or absolute path to the node to include. */
     path?: string;
+    /**
+     * Enables or disables edition of this content in edit mode. Mainly used for absolute or references.
+     * @default true
+     */
     editable?: boolean;
+    /** Ancestor level for absolute area - 0 is Home page, 1 first sub-pages, ... */
     level?: number;
+    /**
+     * Content type to be used to create the area
+     * @default jnt:contentList
+     */
     areaType?: string;
+    /** Is the absolute area editable everywhere or only on the page containing its node. */
     limitedAbsoluteAreaEdit?: boolean;
-    parameters?: object;
-}): JSX.Element;
+    /** The parameters to pass to the absolute area */
+    parameters?: Record<string, unknown>;
+}>): React.JSX.Element;

package/types/core/server/components/AddContentButtons.d.ts

@@ -1,13 +1,19 @@
+import React from 'react';
 /**
  * Generates add content buttons for a content object
- * @param {object} properties The React properties for the component.
- * @param {string} [properties.nodeTypes] The node types to add.
- * @param {string} [properties.childName='*'] The child name.
- * @param {boolean} [properties.editCheck=false] If true, the edit check will be performed.
- * @returns {JSX.Element} The add content buttons.
+ * @returns The add content buttons.
  */
-export function AddContentButtons({ nodeTypes, childName, editCheck }: {
+export declare function AddContentButtons({ nodeTypes, childName, editCheck }: Readonly<{
+    /** The node types to add. */
     nodeTypes?: string;
+    /**
+     * The child name.
+     * @default *
+     */
     childName?: string;
+    /**
+     * If true, the edit check will be performed.
+     * @default false
+     */
     editCheck?: boolean;
-}): JSX.Element;
+}>): React.JSX.Element;

package/types/core/server/components/AddResources.d.ts

@@ -1,31 +1,31 @@
+import React from 'react';
 /**
  * Adds a resources to the head tag of the HTML page.
- * @param {object} props - The properties for the component.
- * @param {boolean} [props.insert] - If true, the resource will be inserted into the document. Typically used for on-demand loading of resources.
- * @param {boolean} [props.async] - If true, the resource will be loaded asynchronously. For scripts, this means the script will be executed as soon as it's available, without blocking the rest of the page.
- * @param {boolean} [props.defer] - If true, the resource will be deferred, i.e., loaded after the document has been parsed. For scripts, this means the script will not be executed until after the page has loaded.
- * @param {string} [props.type] - The type of the resource. This could be 'javascript' for .js files, 'css' for .css files, etc.
- * @param {string} [props.resources] - The path to the resource file, relative to the module.
- * @param {string} [props.inlineResource] - Inline HTML that markup will be considered as resource.
- * @param {string} [props.title] - The title of the resource. This is typically not used for scripts or stylesheets, but may be used for other types of resources.
- * @param {string} [props.key] - A unique key for the resource. This could be used to prevent duplicate resources from being added to the document.
- * @param {string} [props.targetTag] - The HTML tag where the resource should be added. This could be 'head' for resources that should be added to the <head> tag, 'body' for resources that should be added to the <body> tag, etc.
- * @param {string} [props.rel] - The relationship of the resource to the document. This is typically 'stylesheet' for CSS files.
- * @param {string} [props.media] - The media for which the resource is intended. This is typically used for CSS files, with values like 'screen', 'print', etc.
- * @param {string} [props.condition] - A condition that must be met for the resource to be loaded. This could be used for conditional comments in IE, for example.
- * @returns {JSX.Element} A React element that renders a script or link tag.
+ * @returns A React element that renders a script or link tag.
  */
-export function AddResources({ ...props }: {
+export declare function AddResources(props: Readonly<{
+    /** If true, the resource will be inserted into the document. Typically used for on-demand loading of resources. */
     insert?: boolean;
+    /** If true, the resource will be loaded asynchronously. For scripts, this means the script will be executed as soon as it's available, without blocking the rest of the page. */
     async?: boolean;
+    /** If true, the resource will be deferred, i.e., loaded after the document has been parsed. For scripts, this means the script will not be executed until after the page has loaded. */
     defer?: boolean;
-    type?: string;
+    /** The type of the resource. This could be 'javascript' for .js files, 'css' for .css files, etc. */
+    type?: 'javascript' | 'css';
+    /** The path to the resource file, relative to the module. */
     resources?: string;
+    /** Inline HTML that markup will be considered as resource. */
     inlineResource?: string;
+    /** The title of the resource. This is typically not used for scripts or stylesheets, but may be used for other types of resources. */
     title?: string;
+    /** A unique key for the resource. This could be used to prevent duplicate resources from being added to the document. */
     key?: string;
-    targetTag?: string;
+    /** The HTML tag where the resource should be added. This could be 'head' for resources that should be added to the <head> tag, 'body' for resources that should be added to the <body> tag, etc. */
+    targetTag?: 'head' | 'body';
+    /** The relationship of the resource to the document. This is typically 'stylesheet' for CSS files. */
     rel?: string;
+    /** The media for which the resource is intended. This is typically used for CSS files, with values like 'screen', 'print', etc. */
     media?: string;
+    /** A condition that must be met for the resource to be loaded. This could be used for conditional comments in IE, for example. */
     condition?: string;
-}): JSX.Element;
+}>): React.JSX.Element;

package/types/core/server/components/Area.d.ts

@@ -1,27 +1,33 @@
+import React from 'react';
 /**
  * Generates an area in which editors may insert content objects.
- * @param {object} props The React properties for the component.
- * @param {string} [props.name] The name of the area.
- * @param {string} [props.areaView] The view to use for the area.
- * @param {string[]} [props.allowedTypes] The allowed types for the area.
- * @param {number} [props.numberOfItems] The number of items to display in the area.
- * @param {string} [props.subNodesView] The view to use for the subnodes.
- * @param {string} [props.path] Relative (to the current node) or absolute path to the node to include
- * @param {boolean} [props.editable] Enables or disables edition of this content in edit mode. Mainly used for absolute or references.
- * @param {boolean} [props.areaAsSubNode] Allows area to be stored as a subnode
- * @param {string} [props.areaType] Content type to be used to create the area (by default jnt:contentList)
- * @param {object} [props.parameters] the parameters to pass to the area
- * @returns {JSX.Element} The Area component
+ * @returns The Area component
  */
-export function Area({ name, areaView, allowedTypes, numberOfItems, subNodesView, path, editable, areaAsSubNode, areaType, parameters }: {
+export declare function Area({ name, areaView, allowedTypes, numberOfItems, subNodesView, path, editable, areaAsSubNode, areaType, parameters }: Readonly<{
+    /** The name of the area. */
     name?: string;
+    /** The view to use for the area. */
     areaView?: string;
+    /** The allowed types for the area. */
     allowedTypes?: string[];
+    /** The number of items to display in the area. */
     numberOfItems?: number;
+    /** The view to use for the subnodes. */
     subNodesView?: string;
+    /** Relative (to the current node) or absolute path to the node to include. */
     path?: string;
+    /**
+     * Enables or disables edition of this content in edit mode. Mainly used for absolute or references.
+     * @default true
+     */
     editable?: boolean;
+    /** Allow area to be stored as a subnode */
     areaAsSubNode?: boolean;
+    /**
+     * Content type to be used to create the area
+     * @default jnt:contentList
+     */
     areaType?: string;
-    parameters?: object;
-}): JSX.Element;
+    /** The parameters to pass to the area */
+    parameters?: Record<string, unknown>;
+}>): React.JSX.Element;

package/types/core/server/components/render/HydrateInBrowser.d.ts

@@ -1,13 +1,17 @@
+import React from 'react';
 /**
  * Will render the given React component server side and hydrate it in the browser to make it dynamic.
  * Be careful, the component will not have access to the '@jahia/javascript-modules-library' library from the browser.
  *
- * @param {object} params The React component.
- * @param {object} params.child The React component.
- * @param {object} [params.props] The React component props, this props will be serialized/deserialized to be usable server and client side. The serialization and deserialization is done using JSON.stringify server side and JSON.parse in the browser. Please make sure that the props are serializable.
- * @returns {JSX.Element} The component to be hydrated in the browser
+ * @returns The component to be hydrated in the browser
  */
-export function HydrateInBrowser({ child: Child, props }: {
-    child: object;
-    props?: object;
-}): JSX.Element;
+export declare function HydrateInBrowser<T>(props: Readonly<{
+    /** The React component. */
+    child: React.ComponentType<T>;
+    /** The React component props, these props will be serialized/deserialized to be usable server and client side. The serialization and deserialization is done using JSON.stringify server side and JSON.parse in the browser. Please make sure that the props are serializable. */
+    props: T & React.JSX.IntrinsicAttributes;
+}>): React.JSX.Element;
+export declare function HydrateInBrowser(props: Readonly<{
+    /** The React component. */
+    child: React.ComponentType;
+}>): React.JSX.Element;

package/types/core/server/components/render/Render.d.ts

@@ -1,23 +1,31 @@
+import React from 'react';
+import type { JCRNodeWrapper } from 'org.jahia.services.content';
 /**
  * Render a content node
- * @param {object} props the properties for the render
- * @param {object} [props.content] the content node to render
- * @param {object} [props.node] the node to render
- * @param {string} [props.path] the path to render
- * @param {boolean} [props.editable] if the content should be editable
- * @param {string} [props.advanceRenderingConfig] specifies if we should render a node or simply include a view. Acceptable values are : none, INCLUDE or OPTION
- * @param {string} [props.templateType] the template type to use (html, json, ...)
- * @param {string} [props.view] the name of the view variant to use
- * @param {object} [props.parameters] the parameters to pass to the view
- * @returns {JSX.Element} the rendered output of the view for the specified content
+ *
+ * @returns the rendered output of the view for the specified content
  */
-export function Render({ content, node, path, editable, advanceRenderingConfig, templateType, view, parameters }: {
-    content?: object;
-    node?: object;
+export declare function Render({ content, node, path, editable, advanceRenderingConfig, templateType, view, parameters }: Readonly<{
+    /** The content node to render */
+    content?: unknown;
+    /** The node to render */
+    node?: JCRNodeWrapper;
+    /** The path to render */
     path?: string;
+    /**
+     * If the content should be editable
+     * @default true
+     */
     editable?: boolean;
-    advanceRenderingConfig?: string;
+    /**
+     * Specifies if we should render a node or simply include a view.
+     * Acceptable values are : none, INCLUDE or OPTION
+     */
+    advanceRenderingConfig?: 'INCLUDE' | 'OPTION';
+    /** The template type to use (html, json, ...) */
     templateType?: string;
+    /** The name of the view variant to use */
     view?: string;
-    parameters?: object;
-}): JSX.Element;
+    /** The parameters to pass to the view */
+    parameters?: unknown;
+}>): React.JSX.Element;

package/types/core/server/components/render/RenderInBrowser.d.ts

@@ -1,13 +1,17 @@
+import React from 'react';
 /**
  * Will render the given React component in the browser.
  * Be careful, the component will not have access to the '@jahia/javascript-modules-library' library from the browser.
  *
- * @param {object} params The React component.
- * @param {object} params.child The React component.
- * @param {object} [params.props] The React component props, this props will be serialized/deserialized to be usable server and client side. The serialization and deserialization is done using JSON.stringify server side and JSON.parse in the browser. Please make sure that the props are serializable.
- * @returns {JSX.Element} The component to be rendered in the browser
+ * @returns The component to be rendered in the browser
  * */
-export function RenderInBrowser({ child: Child, props }: {
-    child: object;
-    props?: object;
-}): JSX.Element;
+export declare function RenderInBrowser<T>(props: Readonly<{
+    /** The React component */
+    child: React.ComponentType<T>;
+    /** The React component props, this props will be serialized/deserialized to be usable server and client side. The serialization and deserialization is done using JSON.stringify server side and JSON.parse in the browser. Please make sure that the props are serializable. */
+    props: T & React.JSX.IntrinsicAttributes;
+}>): React.JSX.Element;
+export declare function RenderInBrowser(props: Readonly<{
+    /** The React component */
+    child: React.ComponentType;
+}>): React.JSX.Element;

package/types/core/server/components/render/internal/InBrowser.d.ts

@@ -1,8 +1,8 @@
+import React from 'react';
+declare function InBrowser<T>({ child: Child, props, dataKey, preRender }: Readonly<{
+    child: React.ComponentType<T>;
+    props: T & React.JSX.IntrinsicAttributes;
+    dataKey: string;
+    preRender?: boolean;
+}>): React.JSX.Element;
 export default InBrowser;
-declare function InBrowser({ child: Child, props, dataKey, preRender }: {
-    child: any;
-    props: any;
-    dataKey: any;
-    preRender: any;
-}): React.JSX.Element;
-import React from "react";

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

@@ -1,41 +1,20 @@
-/**
- * @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)
-     */
+export interface JahiaComponent {
+    /** The ID of the component (autogenerated but can be overridden) */
     id?: string;
-    /**
-     * - The name of the component.
-     */
+    /** The name of the component. */
     name: string;
-    /**
-     * - The display name of the component (in jahia's UI), optional.
-     */
+    /** 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.
-     */
+    /** 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 to add on the component, optional. */
     properties?: Record<string, string>;
-};
+}
+/**
+ * Using this function provides autocomplete on the jahiaComponent properties.
+ * @param jahiaComponent - An object containing the Jahia component to define.
+ * @returns The jahiaComponent object.
+ */
+export declare function defineJahiaComponent(jahiaComponent: JahiaComponent): JahiaComponent;

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

@@ -1,7 +1,11 @@
+/// <reference types="react" />
+import type { JahiaComponent } from './defineJahiaComponent';
 /**
  * Registers Jahia components into the global registry as views
- * @param {object} jahiaComponents an object containing the jahia components to register
- * @returns {void}
+ * @param jahiaComponents an object containing the jahia components to register
  * 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;
+export declare function registerJahiaComponents(jahiaComponents: Record<string | number | symbol, {
+    (): React.JSX.Element;
+    jahiaComponent: JahiaComponent;
+}>): void;

package/types/index.d.ts

@@ -1,5 +1,22 @@
-export * from "./core";
-export * from "./nav";
+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';

package/core/index.js

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

package/core/server/components/index.js

@@ -1 +0,0 @@
-export*from"./AddContentButtons";export*from"./AddResources";export*from"./Area";export*from"./AbsoluteArea";export*from"./render";

package/core/server/components/render/index.js

@@ -1 +0,0 @@
-export*from"./Render";export*from"./HydrateInBrowser";export*from"./RenderInBrowser";

package/core/server/framework/index.js

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

package/core/server/hooks/index.js

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

package/core/server/index.js

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

package/core/server/utils/index.js

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

package/core/server/utils/jcr/index.js

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

package/core/server/utils/urlBuilder/index.js

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

package/nav/index.js

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

package/nav/server/index.js

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

package/nav/server/navBuilder/index.js

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

package/types/core/index.d.ts

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

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

@@ -1,5 +0,0 @@
-export * from "./AddContentButtons";
-export * from "./AddResources";
-export * from "./Area";
-export * from "./AbsoluteArea";
-export * from "./render";

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

@@ -1,3 +0,0 @@
-export * from "./Render";
-export * from "./HydrateInBrowser";
-export * from "./RenderInBrowser";

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

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

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/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/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/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";