@jahia/javascript-modules-library 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,35 @@
+# javascript-modules-library
+Javascript Library for NPM Javascript Module Engine
+
+## Generated types
+
+This library contains types generated from Java source code. The types are generated using a tool called java-ts-bind
+that was forked here : https://github.com/Jahia/java-ts-bind/tree/finer-excludes . You don't need to checkout this 
+repository as the scripts will automatically do that for you but we mention it in case you need to make modifications
+to it.
+
+By default, the generated types are committed in this project, but if you need to rebuild/update them, you can do so by
+using the following steps:
+
+1. Change to the project directory :
+
+    `cd types/generated`
+
+2. Launch the script that will clone the java-ts-bind repository and build it from source code (it has never been released) :
+
+    `./build.sh`
+
+3. Update the classes and methods declared in [types/generated/package.json](types/generated/package.json) in case you added/removed classes or methods.
+
+4. Launch the script that will download all the required source code and JARs for the type generation and that will
+also compile the source to generated the required symbols JARs. Then it will generate the types, and finally apply
+some post-processing to the generated types to make  usable :
+
+    `./generate.sh`
+
+Note that the generation will take some time on the initial build as it needs to download all the required source code
+and JARs, and build the projects from the source code.
+
+Once completed, the generated types will be in the following directory : 
+
+    types/generated/build/types

package/core/index.js

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

package/core/server/components/AbsoluteArea.js

@@ -0,0 +1 @@
+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

@@ -0,0 +1 @@
+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

@@ -0,0 +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)}})}

package/core/server/components/Area.js

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

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

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

@@ -0,0 +1 @@
+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

@@ -0,0 +1 @@
+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

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

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

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

@@ -0,0 +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;

package/core/server/framework/defineJahiaComponent.js

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

package/core/server/framework/index.js

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

package/core/server/framework/register.js

@@ -0,0 +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)}))}

package/core/server/hooks/index.js

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

package/core/server/hooks/useGQLQuery.js

@@ -0,0 +1 @@
+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

@@ -0,0 +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)};

package/core/server/hooks/useServerContext.js

@@ -0,0 +1 @@
+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

@@ -0,0 +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})}}

package/core/server/index.js

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

package/core/server/utils/index.js

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

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

@@ -0,0 +1 @@
+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

@@ -0,0 +1 @@
+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

@@ -0,0 +1 @@
+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

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

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

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

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

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

@@ -0,0 +1 @@
+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

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

package/nav/index.js

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

package/nav/server/index.js

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

package/nav/server/navBuilder/index.js

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

package/nav/server/navBuilder/navBuilder.js

@@ -0,0 +1,24 @@
+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/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@jahia/javascript-modules-library",
+  "version": "0.0.1",
+  "main": "index.js",
+  "types": "types/index.d.ts",
+  "repository": "git@github.com:Jahia/javascript-modules.git",
+  "license": "MIT",
+  "scripts": {
+    "types:copy": "mkdir -p dist/types && ncp types/manual dist/types && ncp types/generated/build/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 .",
+    "lint:fix": "eslint --ext js,jsx,json,ts --fix .",
+    "prepack": "echo 'Please run 'mvn package' to create the tgz so the Maven version can be injected in the package.json' && exit 1"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "graphql": "^16.0.1",
+    "graphql-tag": "^2.12.6",
+    "i18next": "^23.10.1",
+    "prop-types": "^15.8.1",
+    "react": "^18.2.0",
+    "react-i18next": "^14.1.0"
+  },
+  "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",
+    "ncp": "^2.0.0",
+    "terser": "^5.36.0",
+    "typedoc": "^0.25.13",
+    "typescript": "^4.3.5"
+  },
+  "packageManager": "yarn@4.5.0"
+}

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

@@ -0,0 +1,60 @@
+import {ConfigHelper, GQLHelper, OSGiHelper, RegistryHelper, RenderHelper} from 'org.jahia.modules.npm.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/core/index.d.ts

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

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

@@ -0,0 +1,29 @@
+/**
+ * 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
+ */
+export function AbsoluteArea({ name, areaView, allowedTypes, numberOfItems, subNodesView, path, editable, level, areaType, limitedAbsoluteAreaEdit, parameters }: {
+    name?: string;
+    areaView?: string;
+    allowedTypes?: string[];
+    numberOfItems?: number;
+    subNodesView?: string;
+    path?: string;
+    editable?: boolean;
+    level?: number;
+    areaType?: string;
+    limitedAbsoluteAreaEdit?: boolean;
+    parameters?: object;
+}): JSX.Element;

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

@@ -0,0 +1,13 @@
+/**
+ * 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.
+ */
+export function AddContentButtons({ nodeTypes, childName, editCheck }: {
+    nodeTypes?: string;
+    childName?: string;
+    editCheck?: boolean;
+}): JSX.Element;

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

@@ -0,0 +1,31 @@
+/**
+ * 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.
+ */
+export function AddResources({ ...props }: {
+    insert?: boolean;
+    async?: boolean;
+    defer?: boolean;
+    type?: string;
+    resources?: string;
+    inlineResource?: string;
+    title?: string;
+    key?: string;
+    targetTag?: string;
+    rel?: string;
+    media?: string;
+    condition?: string;
+}): JSX.Element;

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

@@ -0,0 +1,27 @@
+/**
+ * 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
+ */
+export function Area({ name, areaView, allowedTypes, numberOfItems, subNodesView, path, editable, areaAsSubNode, areaType, parameters }: {
+    name?: string;
+    areaView?: string;
+    allowedTypes?: string[];
+    numberOfItems?: number;
+    subNodesView?: string;
+    path?: string;
+    editable?: boolean;
+    areaAsSubNode?: boolean;
+    areaType?: string;
+    parameters?: object;
+}): JSX.Element;

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

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