@jahia/javascript-modules-library 0.4.0 → 0.5.1

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+export { RenderInBrowser } from "./core/server/components/render/RenderInBrowser.js";
+export { HydrateInBrowser } from "./core/server/components/render/HydrateInBrowser.js";
+export { Render } from "./core/server/components/render/Render.js";
+export { AbsoluteArea } from "./core/server/components/AbsoluteArea.js";
+export { AddContentButtons } from "./core/server/components/AddContentButtons.js";
+export { AddResources } from "./core/server/components/AddResources.js";
+export { Area } from "./core/server/components/Area.js";
+export { defineJahiaComponent } from "./core/server/framework/defineJahiaComponent.js";
+export { jahiaComponent } from "./core/server/framework/jahiaComponent.js";
+export { registerJahiaComponents } from "./core/server/framework/register.js";
+export { useGQLQuery } from "./core/server/hooks/useGQLQuery.js";
+export { useJCRQuery } from "./core/server/hooks/useJCRQuery.js";
+export { useServerContext, ServerContextProvider } from "./core/server/hooks/useServerContext.js";
+export { useUrlBuilder } from "./core/server/hooks/useUrlBuilder.js";
+export { getChildNodes } from "./core/server/utils/jcr/getChildNodes.js";
+export { getNodeFromPathOrId } from "./core/server/utils/jcr/getNodeFromPathOrId.js";
+export { getNodeProps } from "./core/server/utils/jcr/getNodeProps.js";
+export { getNodesByJCRQuery } from "./core/server/utils/jcr/getNodesByJCRQuery.js";
+export { buildUrl, initUrlBuilder } from "./core/server/utils/urlBuilder/urlBuilder.js";
+export { buildNavMenu } from "./nav/server/navBuilder/navBuilder.js";
+export { default as server } from "virtual:jahia-server";
+
+// Include declarations for all Java types
+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";

package/dist/index.js

@@ -0,0 +1,5 @@
+console.error(
+  "You cannot import and run '@jahia/javascript-modules-library' because it's a virtual module.\n" +
+  "Something is wrong with your build configuration: instead of bundling '@jahia/javascript-modules-library', it should be replaced with 'javascriptModulesLibraryBuilder.getSharedLibrary(\"@jahia/javascript-modules-library\")'."
+);
+export {};

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

@@ -0,0 +1,29 @@
+import type { JCRNodeWrapper } from "org.jahia.services.content";
+import type { RenderContext, Resource } from "org.jahia.services.render";
+interface MenuEntry {
+    /** The HTML rendered HTML menu entry */
+    render: string;
+    /** The node object for the menu entry */
+    node: 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[];
+}
+/**
+ * Build a navigation menu
+ *
+ * @param maxDepth The maximum depth of the menu
+ * @param base The base path of the menu
+ * @param menuEntryView The view to use for each menu entry
+ * @param startLevelValue The level at which to start the menu
+ * @param renderContext The current render context
+ * @param currentResource The current resource
+ * @returns An array of menu entries objects
+ */
+export declare function buildNavMenu(maxDepth: number, base: string, menuEntryView: string, startLevelValue: number, renderContext: RenderContext, currentResource: Resource): MenuEntry[];
+export {};

package/{types → dist}/org.jahia.modules.javascript.modules.engine.js.server.d.ts

@@ -5,8 +5,8 @@ import { Collection, List, Map } from 'java.util';
 import { JCRNodeWrapper, JCRCallback } from 'org.jahia.services.content';
 
 import { JCRSiteNode } from 'org.jahia.services.content.decorator';
+import { Promise } from 'org.jahia.modules.javascript.modules.engine.jsengine';
 import { RenderContext, Resource } from 'org.jahia.services.render';
-import { Promise, Registry, ContextProvider } from 'org.jahia.modules.javascript.modules.engine.jsengine';
 /**
  * Java helper to expose OSGi configuration values to Javascript code
 */
@@ -184,7 +184,6 @@ export class RegistryHelper {
    * @param key the key of the object to remove within the type
   */
   remove(type: string, key: string): void;
-  getRegistry(): Registry;
 }
 /**
  * Helper class to provide rendering functions to the Javascript engine

package/package.json

@@ -1,40 +1,47 @@
 {
   "name": "@jahia/javascript-modules-library",
-  "version": "0.4.0",
-  "main": "index.js",
-  "types": "types/index.d.ts",
-  "repository": "git@github.com:Jahia/javascript-modules.git",
+  "version": "0.5.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com:Jahia/javascript-modules.git",
+    "directory": "javascript-modules-library"
+  },
   "license": "MIT",
-  "scripts": {
-    "types:copy": "mkdir -p dist/types && ncp target/types dist/types",
-    "build:development": "run types:copy && tsc && node generate-index",
-    "build:production": "run build:development && run minify",
-    "build": "run build:production",
-    "minify": "node minify",
-    "doc": "typedoc",
-    "clean": "rm -rf dist",
-    "lint": "eslint --ext js,jsx,json,ts src/",
-    "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"
+  "type": "module",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js"
   },
   "bin": {
     "jahia-deploy": "bin/jahia-deploy.mjs"
   },
   "files": [
+    "bin",
     "dist"
   ],
+  "scripts": {
+    "build": "tsc && node post-build.js && mkdir -p dist && yarn pack --out dist/package.tgz && publint",
+    "clean": "rm -rf dist",
+    "lint": "yarn run --top-level lint"
+  },
   "dependencies": {
-    "dotenv": "^16.4.7",
-    "graphql": "^16.0.1",
-    "graphql-tag": "^2.12.6",
-    "prop-types": "^15.8.1"
+    "dotenv": "^16.4.7"
+  },
+  "devDependencies": {
+    "@types/react": "^19.0.8",
+    "devalue": "^5.1.1",
+    "graphql": "^16.10.0",
+    "i18next": "^23.10.1",
+    "publint": "^0.3.6",
+    "react-i18next": "^15.4.0",
+    "typescript": "^5.7.3"
   },
   "peerDependencies": {
-    "i18next": ">=23.0.0 <23.11.0",
-    "react": ">=18.0.0 <18.3.0",
-    "react-dom": ">=18.0.0 <18.3.0",
-    "react-i18next": ">=14.0.0 <14.2.0",
-    "styled-jsx": ">=5.0.0 <5.2.0"
+    "i18next": "^23.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "react-i18next": "^15.4.0",
+    "styled-jsx": "^5.0.0"
   },
   "peerDependenciesMeta": {
     "i18next": {
@@ -52,37 +59,5 @@
     "styled-jsx": {
       "optional": true
     }
-  },
-  "resolutions": {
-    "minimist": "^1.2.6",
-    "set-getter": "^0.1.1"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.23.4",
-    "@babel/core": "^7.23.7",
-    "@babel/preset-env": "^7.23.8",
-    "@babel/preset-react": "^7.23.3",
-    "@jahia/eslint-config": "^2.1.2",
-    "@types/node-fetch": "^2.6.11",
-    "@types/react": "^18.2.48",
-    "@typescript-eslint/eslint-plugin": "^4.29.3",
-    "@typescript-eslint/parser": "^4.29.3",
-    "babel-loader": "^9.1.3",
-    "babel-plugin-transform-react-jsx": "^6.24.1",
-    "eslint": "^7.32.0",
-    "eslint-plugin-cypress": "^2.11.3",
-    "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-json": "^3.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-react": "^7.32.2",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "i18next": "^23.10.1",
-    "ncp": "^2.0.0",
-    "react": "^18.2.0",
-    "react-i18next": "^14.1.0",
-    "terser": "^5.36.0",
-    "typedoc": "^0.25.13",
-    "typescript": "^4.3.5"
-  },
-  "packageManager": "yarn@4.5.0"
-}
+  }
+}

package/core/server/components/AbsoluteArea.js

@@ -1 +0,0 @@
-import React from"react";import{useServerContext}from"../hooks/useServerContext";import{server}from"@jahia/javascript-modules-library-private";export function AbsoluteArea({name:e,areaView:r,allowedTypes:t,numberOfItems:a,subNodesView:o,path:s,editable:n=!0,level:i,areaType:l="jnt:contentList",limitedAbsoluteAreaEdit:m,parameters:d}){const{renderContext:u}=useServerContext();return React.createElement("unwanteddiv",{dangerouslySetInnerHTML:{__html:server.render.renderAbsoluteArea({name:e,areaView:r,allowedTypes:t,numberOfItems:a,subNodesView:o,path:s,editable:n,level:i,areaType:l,limitedAbsoluteAreaEdit:m,parameters:d},u)}})}

package/core/server/components/AddContentButtons.js

@@ -1 +0,0 @@
-import React from"react";import{server}from"@jahia/javascript-modules-library-private";import{useServerContext}from"../hooks/useServerContext";export function AddContentButtons({nodeTypes:e,childName:t="*",editCheck:r=!1}){const{renderContext:n,currentResource:o}=useServerContext();return React.createElement("unwanteddiv",{dangerouslySetInnerHTML:{__html:server.render.createContentButtons(t,e,r,n,o)}})}

package/core/server/components/AddResources.js

@@ -1 +0,0 @@
-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/Area.js

@@ -1 +0,0 @@
-import React from"react";import{useServerContext}from"../hooks/useServerContext";import{server}from"@jahia/javascript-modules-library-private";export function Area({name:e,areaView:r,allowedTypes:a,numberOfItems:t,subNodesView:n,path:o,editable:s=!0,areaAsSubNode:m,areaType:i="jnt:contentList",parameters:d}){const{renderContext:p}=useServerContext();return React.createElement("unwanteddiv",{dangerouslySetInnerHTML:{__html:server.render.renderArea({name:e,areaView:r,allowedTypes:a,numberOfItems:t,subNodesView:n,path:o,editable:s,areaAsSubNode:m,areaType:i,parameters:d},p)}})}

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

@@ -1 +0,0 @@
-import React from"react";import InBrowser from"./internal/InBrowser";export function HydrateInBrowser({child:r,props:e}){return React.createElement(InBrowser,{preRender:!0,child:r,props:e,dataKey:"data-reacthydrate"})}

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

@@ -1 +0,0 @@
-import React from"react";import{server}from"@jahia/javascript-modules-library-private";import{useServerContext}from"../../hooks/useServerContext";export function Render({content:e,node:r,path:t,editable:n=!0,advanceRenderingConfig:a,templateType:o,view:i,parameters:d}){const{renderContext:p,currentResource:c}=useServerContext();return React.createElement("unwanteddiv",{dangerouslySetInnerHTML:{__html:server.render.render({content:e,node:r,path:t,editable:n,advanceRenderingConfig:a,templateType:o,view:i,parameters:d},p,c)}})}

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

@@ -1 +0,0 @@
-import React from"react";import InBrowser from"./internal/InBrowser";export function RenderInBrowser({child:r,props:e}){return React.createElement(InBrowser,{preRender:!1,child:r,props:e,dataKey:"data-reactrender"})}

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

@@ -1 +0,0 @@
-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/defineJahiaComponent.js

@@ -1 +0,0 @@
-export function defineJahiaComponent(n){return n}

package/core/server/framework/register.js

@@ -1 +0,0 @@
-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/useGQLQuery.js

@@ -1 +0,0 @@
-import{useServerContext}from"./useServerContext";import{server}from"@jahia/javascript-modules-library-private";export const useGQLQuery=({query:e,variables:r,operationName:t})=>{const{renderContext:o}=useServerContext();return server.gql.executeQuerySync({query:e,variables:r,operationName:t,renderContext:o})};

package/core/server/hooks/useJCRQuery.js

@@ -1 +0,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/useServerContext.js

@@ -1 +0,0 @@
-import React,{useContext}from"react";const ServerContext=React.createContext({});export function useServerContext(){return useContext(ServerContext)}export function ServerContextProvider({renderContext:e,currentResource:r,currentNode:t,mainNode:n,bundleKey:o,children:c}){return React.createElement(ServerContext.Provider,{value:{renderContext:e,currentResource:r,currentNode:t,mainNode:n,bundleKey:o}},c)}

package/core/server/hooks/useUrlBuilder.js

@@ -1 +0,0 @@
-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/core/server/utils/jcr/getChildNodes.js

@@ -1 +0,0 @@
-export function getChildNodes(e,o,t=0,n=void 0){let r=[];if(!e||!o)return console.warn("Missing one or more mandatory parameters (node, limit) to getChildNodes"),r;const s=e.getNodes();let i=0;for(;s.hasNext();){const e=s.nextNode();if(i<t)n&&!n(e)||i++;else if((!n||n(e))&&(r.push(e),o>0&&r.length===o))break}return r}

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

@@ -1 +0,0 @@
-export function getNodeFromPathOrId(e,t){return e.identifier?t.getNodeByIdentifier(e.identifier):e.path?t.getNode(e.path):null}

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

@@ -1 +0,0 @@
-const STRING=1,LONG=3,DOUBLE=4,DATE=5,BOOLEAN=6,NAME=7,PATH=8,REFERENCE=9,WEAKREFERENCE=10,URI=11,DECIMAL=12,extractProp=(e,t)=>{if(e.hasProperty(t)){const r=e.getProperty(t);if(r.isMultiple()){const t=r.getValues(),o=[];for(const s of t)o.push(extractPropValue(e.getSession(),s,r.getType()));return o}return extractPropValue(e.getSession(),r.getValue(),r.getType())}},extractPropValue=(e,t,r)=>{switch(r){case 1:case 5:case 7:case 8:case 11:case 12:return t.getString();case 3:return t.getLong();case 4:return t.getDouble();case 6:return t.getBoolean();case 9:case 10:try{return e.getNodeByIdentifier(t.getString())}catch(e){return}default:return}};export function getNodeProps(e,t){let r={};if(e&&t&&t.length>0)for(const o of t)e.hasProperty(o)&&(r[o]=extractProp(e,o));return r}

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

@@ -1 +0,0 @@
-export function getNodesByJCRQuery(e,t,r,o=0){let s=[];if(!e||!t||!r)return console.warn("Missing one or more mandatory parameters (session, query, limit) to getNodesByJCRQuery"),s;const n=e.getWorkspace().getQueryManager().createQuery(t,"JCR-SQL2");r>0&&n.setLimit(r),o&&o>0&&n.setOffset(o);const a=n.execute().getNodes();for(;a.hasNext();)s.push(a.nextNode());return s}

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

@@ -1 +0,0 @@
-import{getNodeFromPathOrId}from"../jcr/getNodeFromPathOrId";import{server}from"@jahia/javascript-modules-library-private";const absoluteUrlRegExp=/^(?:[a-z+]+:)?\/\//i,finalizeUrl=(e,r)=>absoluteUrlRegExp.test(e)?e:(e=e.startsWith("/")?r.getRequest().getContextPath()+e:e,r.getResponse().encodeURL(e));function appendParameters(e,r){const t=e.includes("?")?"&":"?";return`${e}${t}${Object.keys(r).map((e=>`${encodeURIComponent(e)}=${encodeURIComponent(r[e])}`)).join("&")}`}export function initUrlBuilder(){server.registry.add("urlBuilder","nt:file",{priority:1,buildURL:({jcrNode:e,mode:r,currentResource:t})=>"/files/"+(r?"edit"===r||"preview"===r?"default":"live":t.getWorkspace())+server.render.escapePath(e.getCanonicalPath())}),server.registry.add("urlBuilder","*",{priority:0,buildURL:({jcrNode:e,mode:r,language:t,extension:a,renderContext:n,currentResource:o})=>{let i,l;if(r)switch(r){case"edit":l="/cms/edit",i="default";break;case"preview":l="/cms/render",i="default";break;default:l="/cms/render",i="live"}else l=n.getServletPath(),i=o.getWorkspace();return l+"/"+i+"/"+(t||o.getLocale().toString())+server.render.escapePath(e.getPath())+(a||".html")}})}export function buildUrl(e,r,t){let a;if(e.path){let n;try{n=getNodeFromPathOrId({path:e.path},t.getNode().getSession())}catch(r){return console.warn(`Unable to find node for path: ${e.path}\n Replacing by #`),"#"}if(n){const o=server.registry.find({type:"urlBuilder"},"priority");for(const i of o)if("*"===i.key||n.isNodeType(i.key)){a=i.buildURL({jcrNode:n,mode:e.mode,language:e.language,extension:e.extension,renderContext:r,currentResource:t});break}}}else{if(!e.value)return console.warn("Missing parameter to build url, please provide either a content path using 'path' parameter, or a prebuild valid url using 'value' parameter\n replacing by #"),"#";a=e.value}return a?(e.parameters&&"[object Object]"===Object.prototype.toString.call(e.parameters)&&(a=appendParameters(a,e.parameters)),finalizeUrl(a,r)):(console.warn(`Unable to build url for: ${JSON.stringify(e)}\n Replacing by #`),"#")}

package/index.js

@@ -1 +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{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/nav/server/navBuilder/navBuilder.js

@@ -1,24 +0,0 @@
-import{server}from"@jahia/javascript-modules-library-private";import{print}from"graphql";import gql from"graphql-tag";const getPageAncestors=(e,t,r)=>{const n=server.gql.executeQuerySync({query:print(gql`
-            query ($workspace: Workspace!, $path: String!, $types: [String]!){
-                jcr(workspace: $workspace) {
-                    nodeByPath(path: $path) {
-                        ancestors(fieldFilter: {filters:[{fieldName:"isNodeType", value:"true"}]}) {
-                            path
-                            isNodeType(type: {types: $types})
-                        }
-                    }
-                }
-            }
-        `),variables:{workspace:e,path:t,types:r}});return n.data?n.data.jcr.nodeByPath.ancestors:[]},getMenuItemsChildren=(e,t,r)=>{const n=server.gql.executeQuerySync({query:print(gql`
-            query childrenOfType($workspace: Workspace!, $path: String!, $types: [String]!){
-                jcr(workspace: $workspace) {
-                    nodeByPath(path: $path) {
-                        children(typesFilter: {types:$types}) {
-                            nodes {
-                                path
-                            }
-                        }
-                    }
-                }
-            }
-        `),variables:{workspace:e,path:t,types:r}});return n.data?n.data.jcr.nodeByPath.children.nodes:[]},getBaseNode=(e,t,r)=>{const n=t.getMainResource().getNode(),a=getPageAncestors(r,n.getPath(),["jnt:page"]);if(!e||"home"===e)return t.getSite().getHome();if("currentPage"===e){if(t.getMainResource().getNode().isNodeType("jnt:page"))return n;if(a.length>0)return n.getSession().getNode(a.slice(-1)[0].path)}return n},buildMenu=(e,t,r,n)=>{let a=[];if(e){const s=e.getSession();n||(n=getMenuItemsChildren(r.workspace,e.getPath(),["jmix:navMenuItem"]));for(let e=0;e<n.length;e++){const o={},i=n[e].path,p=s.getNode(i),c=r.mainResourceNode.getPath()===i||r.mainResourceNode.getPath().startsWith(i+"/");let g=!1,u=!1,d=!0;if(p.isNodeType("jmix:nodeReference")){r.currentResource.getDependencies().add(p.getPropertyAsString("j:node"));const e=p.getProperty("j:node").getNode();e?g=r.mainResourceNode.getPath()===e.getPath():(g=!1,u=!0)}else g=r.mainResourceNode.getPath()===p.getPath();if(p.hasProperty["j:displayInMenuName"]&&(d=!1,p.getProperty("j:displayInMenuName").getValues().forEach((e=>{d=d||e.getString()===r.menuName}))),!u&&d&&(r.startLevelValue<t||c)){if(t<r.maxDepth){const e=getMenuItemsChildren(r.workspace,p.getPath(),["jmix:navMenuItem"]);e.length>0&&(o.children=buildMenu(p,t+1,r,e))}r.startLevelValue<t&&(r.currentResource.getDependencies().add(p.getCanonicalPath()),o.render=server.render.render({path:p.getPath(),view:r.menuEntryView||"menuElement"},r.renderContext,r.currentResource)),o.node=p,o.inPath=c,o.selected=g,o.level=t}a.push(o)}}return a};export function buildNavMenu(e,t,r,n,a,s){const o=a.isLiveMode()?"LIVE":"EDIT";return buildMenu(getBaseNode(t,a,o),1,{renderContext:a,mainResourceNode:a.getMainResource().getNode(),currentResource:s,workspace:o,menuName:s.getNode().getName(),startLevelValue:n,maxDepth:e,menuEntryView:r})}

package/types/@jahia/javascript-modules-library-private.d.ts

@@ -1,60 +0,0 @@
-import {ConfigHelper, GQLHelper, OSGiHelper, RegistryHelper, RenderHelper} from 'org.jahia.modules.javascript.modules.engine.js.server';
-import {JCRNodeWrapper} from 'org.jahia.services.content';
-import {Resource, RenderContext} from 'org.jahia.services.render';
-
-/**
- * This module is used for internal compilation of the project. It should not be used directly in your code.
- */
-declare module '@jahia/javascript-modules-library-private' {
-    /**
-     * 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
-    };
-
-    /**
-     * 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;
-    }
-}

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

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

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

@@ -1,19 +0,0 @@
-import React from 'react';
-/**
- * Generates add content buttons for a content object
- * @returns The add content buttons.
- */
-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;
-}>): React.JSX.Element;

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

@@ -1,31 +0,0 @@
-import React from 'react';
-/**
- * Adds a resources to the head tag of the HTML page.
- * @returns A React element that renders a script or link tag.
- */
-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;
-    /** 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;
-    /** 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;
-}>): React.JSX.Element;

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

@@ -1,17 +0,0 @@
-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.
- *
- * @returns The component to be rendered in the browser
- * */
-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 +0,0 @@
-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;

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

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

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/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[];