feat(library)!: added getSiteLocales, removed getNodeFromPathOrId

jahia-test-module/src/react/server/views/testI18n/TestI18n.tsx

@@ -1,5 +1,6 @@
 import SampleI18n from "$client/components/SampleI18n";
 import {
+  getSiteLocales,
   HydrateInBrowser,
   jahiaComponent,
   RenderInBrowser,
@@ -34,6 +35,9 @@ jahiaComponent(
           props={{ placeholder: "We are rendered client side !" }}
         />
       </div>
+
+      <h3>getSiteLocales()</h3>
+      <div data-testid="getSiteLocales">{Object.keys(getSiteLocales()).join(",")}</div>
     </>
   ),
 );

javascript-create-module/template/src/components/LanguageSwitcher/default.server.tsx

@@ -1,4 +1,4 @@
-import { buildUrl, jahiaComponent } from "@jahia/javascript-modules-library";
+import { buildUrl, getSiteLocales, jahiaComponent } from "@jahia/javascript-modules-library";
 import { t } from "i18next";
 import { Fragment } from "react";
 import classes from "./component.module.css";
@@ -12,15 +12,11 @@ jahiaComponent(
     properties: { "cache.timeout": "0" },
   },
   (_, { renderContext, mainNode, currentResource }) => {
-    const locales = renderContext.isLiveMode()
-      ? renderContext.getSite().getActiveLiveLanguagesAsLocales()
-      : renderContext.getSite().getLanguagesAsLocales();
-    const currentLanguage = currentResource.getLocale().getLanguage();
+    const currentLanguage = currentResource.getLocale().toString();
     return (
       <p style={{ textAlign: "center" }}>
         {t("JI87mYV8J5pAEST4RIUcb")}{" "}
-        {locales.map((locale, i) => {
-          const language = locale.getLanguage();
+        {Object.entries(getSiteLocales()).map(([language, locale], i, { length }) => {
           const href = buildUrl(
             { path: mainNode.getPath(), language },
             renderContext,
@@ -35,7 +31,7 @@ jahiaComponent(
               >
                 {locale.getDisplayLanguage(locale)}
               </a>
-              {i < locales.length - 1 && " • "}
+              {i < length - 1 && " • "}
             </Fragment>
           );
         })}

javascript-modules-engine/tests/cypress/e2e/ui/testI18n.cy.ts

@@ -80,6 +80,8 @@ describe('Test i18n', () => {
                     true,
                 )
             })
+
+            cy.get('[data-testid="getSiteLocales"]').should('contain', 'de,en,fr,fr_LU')
         })
         cy.logout()
     })

javascript-modules-library/src/core/server/utils/i18n.ts

@@ -0,0 +1,19 @@
+import type { Locale } from "java.util";
+import { useServerContext } from "../hooks/useServerContext.js";
+import type { RenderContext } from "org.jahia.services.render";
+
+/**
+ * Returns the locales available on the site, as a record of language code (e.g. en_US) to locale
+ * object.
+ *
+ * If not provided, the `renderContext` is taken from the current server context.
+ */
+export function getSiteLocales(
+  { renderContext }: { renderContext: RenderContext } = useServerContext(),
+): Record<string, Locale> {
+  const locales = renderContext.isLiveMode()
+    ? renderContext.getSite().getActiveLiveLanguagesAsLocales()
+    : renderContext.getSite().getLanguagesAsLocales();
+
+  return Object.fromEntries(locales.map((locale) => [locale.toString(), locale]));
+}

javascript-modules-library/src/core/server/utils/urlBuilder/urlBuilder.ts

@@ -1,5 +1,4 @@
 import type { RenderContext, Resource } from "org.jahia.services.render";
-import { getNodeFromPathOrId } from "../jcr/getNodeFromPathOrId.js";
 import server from "virtual:jahia-server";
 import type { JCRNodeWrapper } from "org.jahia.services.content";
 
@@ -127,7 +126,7 @@ export function buildUrl(
   if (props.path) {
     let jcrNode: JCRNodeWrapper | null;
     try {
-      jcrNode = getNodeFromPathOrId({ path: props.path }, currentResource.getNode().getSession());
+      jcrNode = currentResource.getNode().getSession().getNode(props.path);
     } catch {
       console.warn(`Unable to find node for path: ${props.path}\n Replacing by #`);
       return "#";

javascript-modules-library/src/index.ts

@@ -22,13 +22,15 @@ export { useUrlBuilder } from "./core/server/hooks/useUrlBuilder.js";
 
 // JCR utils
 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";
 
 // URL builder
 export { buildUrl, initUrlBuilder } from "./core/server/utils/urlBuilder/urlBuilder.js";
 
+// I18n
+export { getSiteLocales } from "./core/server/utils/i18n.js";
+
 // Navigation
 export { buildNavMenu } from "./nav/server/navBuilder/navBuilder.js";
 export type { MenuEntry } from "./nav/server/navBuilder/navBuilder.js";