@enonic/nextjs-adapter 3.2.1 → 3.3.0-B1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enonic/nextjs-adapter",
-  "version": "3.2.1",
+  "version": "3.3.0-B1",
   "license": "Apache-2.0",
   "main": "index.js",
   "author": "Pavel Milkevich <pmi@enonic.com>",
@@ -25,6 +25,23 @@
     "utils",
     "views"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./views/*": {
+      "types": "./dist/views/*.d.ts",
+      "import": "./dist/views/*.jsx",
+      "require": "./dist/views/*.jsx"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "import": "./dist/*.js",
+      "require": "./dist/*.js"
+    }
+  },
   "keywords": [
     "enonic",
     "nextjs",
@@ -36,8 +53,8 @@
     "access": "public"
   },
   "scripts": {
-    "clean": "del-cli *.d.ts *.js.map baseMappings.* client.* server.* common coverage index.* enonic-nextjs-adapter-*.tgz guillotine i18n query types utils views dist server client",
     "build": "tsc",
+    "clean": "del-cli dist/ *.tgz",
     "check:types": "tsc --noEmit",
     "madge": "madge -i docs/madge.png -x '(constants|env)\\.ts' src/index.ts",
     "lint": "eslint --quiet --cache src",
@@ -50,43 +67,45 @@
     "test": "jest --no-cache --coverage"
   },
   "dependencies": {
-    "@enonic/react-components": "^5.0.1",
+    "@enonic/react-components": "^6.0.0-RC5",
     "@formatjs/intl-localematcher": "^0.6.1",
     "gqlmin": "^0.2.2",
-    "html-react-parser": "^5.2.2",
     "negotiator": "^1.0.0",
-    "next": "^15.2.4",
-    "react": "18.3.1",
-    "react-dom": "18.3.1",
     "unescape": "^1.0.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.26.10",
-    "@babel/preset-env": "^7.26.9",
+    "@babel/core": "^7.28.0",
+    "@babel/preset-env": "^7.28.0",
     "@edge-runtime/jest-environment": "^4.0.0",
-    "@enonic-types/core": "^7.15.1",
+    "@enonic-types/core": "^7.15.3",
     "@enonic/eslint-config": "^2.0.1",
-    "@testing-library/jest-dom": "^6.6.3",
-    "@testing-library/react": "^16.2.0",
-    "@types/negotiator": "^0.6.3",
-    "@types/node": "^22.13.14",
+    "@testing-library/jest-dom": "^6.6.4",
+    "@testing-library/react": "^16.3.0",
+    "@types/negotiator": "^0.6.4",
+    "@types/node": "^24.2.1",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
-    "@typescript-eslint/eslint-plugin": "^8.29.0",
-    "@typescript-eslint/parser": "^8.29.0",
-    "babel-jest": "^29.7.0",
-    "concurrently": "^9.1.2",
+    "@typescript-eslint/eslint-plugin": "^8.38.0",
+    "@typescript-eslint/parser": "^8.39.0",
+    "babel-jest": "^30.0.5",
+    "concurrently": "^9.2.0",
     "cpy-cli": "^5.0.0",
     "del-cli": "^6.0.0",
-    "eslint": "^9.16.0",
-    "eslint-plugin-react": "^7.37.4",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
+    "eslint": "^9.32.0",
+    "eslint-plugin-react": "^7.37.5",
+    "jest": "^30.0.5",
+    "jest-environment-jsdom": "^30.0.5",
     "madge": "^8.0.0",
     "mkdirp": "^3.0.1",
-    "ts-jest": "^29.3.0",
+    "ts-jest": "^29.4.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.3"
   },
-  "types": "index.d.ts"
+  "types": "index.d.ts",
+  "peerDependencies": {
+    "html-react-parser": "^5.2.6",
+    "next": "^15.4.5",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  }
 }

package/src/baseMappings.ts

@@ -13,41 +13,41 @@ import {getShortcutQuery} from './query/Shortcut';
 // Base Content Types
 
 ComponentRegistry.addContentType(FRAGMENT_CONTENTTYPE_NAME, {
-    view: FragmentView,
+    view: FragmentView
 });
 
 ComponentRegistry.addContentType('base:shortcut', {
-    query: getShortcutQuery,
+    query: getShortcutQuery
 });
 
 // Base Components
 
 ComponentRegistry.addComponent(XP_COMPONENT_TYPE.PAGE, {
-    view: BasePage,
+    view: BasePage
 });
 
 ComponentRegistry.addComponent(XP_COMPONENT_TYPE.PART, {
-    view: BasePart,
+    view: BasePart
 });
 
 ComponentRegistry.addComponent(XP_COMPONENT_TYPE.LAYOUT, {
-    view: BaseLayout,
+    view: BaseLayout
 });
 
 ComponentRegistry.addComponent(XP_COMPONENT_TYPE.FRAGMENT, {
-    view: FragmentView,
+    view: FragmentView
 });
 
 ComponentRegistry.addComponent(XP_COMPONENT_TYPE.TEXT, {
-    view: TextView,
+    view: TextView
 });
 
 // Macro mappings
 ComponentRegistry.addMacro('system:embed', {
     view: DefaultMacro,
-    configQuery: '{body}',
+    configQuery: '{body}'
 });
 ComponentRegistry.addMacro('system:disable', {
     view: DisableMacro,
-    configQuery: '{body}',
+    configQuery: '{body}'
 });

package/src/common/ComponentRegistry.ts

@@ -4,14 +4,11 @@ import type {
     ComponentDictionary,
     PageComponent,
     SelectedQueryMaybeVariablesFunc,
-    SelectorName,
+    SelectorName
 } from '../types';
 
 
-import {
-    CATCH_ALL,
-    XP_COMPONENT_TYPE,
-} from './constants';
+import {CATCH_ALL, XP_COMPONENT_TYPE} from './constants';
 
 
 function toSelectorName(type: XP_COMPONENT_TYPE): SelectorName | undefined {

package/src/common/constants.ts

@@ -4,7 +4,7 @@ export enum ENV_VARS {
     MAPPINGS = 'ENONIC_MAPPINGS',
     API_URL = 'ENONIC_API',
     APP_NAME = 'ENONIC_APP_NAME',
-    LOG = 'ENONIC_LOGGING',
+    LOG = 'ENONIC_LOGGING'
 }
 
 export const FRAGMENT_CONTENTTYPE_NAME = 'portal:fragment';
@@ -49,7 +49,7 @@ export enum GUILLOTINE_REQUEST_HEADERS {
     COOKIE = 'Cookie',
     LOCALE = 'locale',
     LOCALES = 'locales',
-    DEFAULT_LOCALE = 'default-locale',
+    DEFAULT_LOCALE = 'default-locale'
 }
 
 export const JSESSIONID_HEADER = 'jsessionid';
@@ -82,11 +82,11 @@ export enum XP_COMPONENT_TYPE {
     LAYOUT = 'layout',
     TEXT = 'text',
     FRAGMENT = 'fragment',
-    PAGE = 'page',
+    PAGE = 'page'
 }
 
 export enum XP_REQUEST_TYPE {
     COMPONENT = 'component',
     TYPE = 'type',
-    PAGE = 'page',
+    PAGE = 'page'
 }

package/src/common/env.ts

@@ -28,7 +28,7 @@ export const MAPPINGS = isServer ? process.env[ENV_VARS.MAPPINGS] : process.env[
 const requiredConstants = {
     [ENV_VARS.APP_NAME]: APP_NAME,
     [ENV_VARS.API_URL]: API_URL,
-    [ENV_VARS.MAPPINGS]: MAPPINGS,
+    [ENV_VARS.MAPPINGS]: MAPPINGS
 };
 
 // Verify required values on server-side only

package/src/guillotine/applyProcessors.ts

@@ -1,8 +1,4 @@
-import type {
-    ComponentDescriptor,
-    ContentResult,
-    Context,
-} from '../types';
+import type {ComponentDescriptor, ContentResult, Context} from '../types';
 
 
 import {getComponentConfig} from './getComponentConfig';
@@ -14,7 +10,7 @@ const NO_PROPS_PROCESSOR = async (props: any) => await props ?? {};
 export async function applyProcessors(
     componentDescriptors: ComponentDescriptor[],
     contentResults: ContentResult,
-    context: Context,
+    context: Context
 ): Promise < PromiseSettledResult < any > [] > {
 
     let dataCounter = 0;
@@ -35,4 +31,4 @@ export async function applyProcessors(
     });
 
     return Promise.allSettled(processorPromises);
-}
+}

package/src/guillotine/buildComponentTree.ts

@@ -9,7 +9,7 @@ import {getParentRegion} from './getParentRegion';
 export function buildComponentTree(
     comps: PageComponent[],
     rootComp: PageComponent,
-    contentType?: string,
+    contentType?: string
 ): PageComponent {
     const rootTree: RegionTree = {};
     const isFragmentType = contentType === FRAGMENT_CONTENTTYPE_NAME;

package/src/guillotine/buildErrorResponse.ts

@@ -12,7 +12,7 @@ export function buildErrorResponse(requestType: XP_REQUEST_TYPE, renderMode: REN
         return {
             error: {
                 code,
-                message,
+                message
             },
             page: null,
             common: null,
@@ -28,8 +28,8 @@ export function buildErrorResponse(requestType: XP_REQUEST_TYPE, renderMode: REN
                 apiUrl,
                 baseUrl,
                 locale,
-                defaultLocale,
-            },
+                defaultLocale
+            }
         };
     };
 }

package/src/guillotine/buildPage.ts

@@ -8,8 +8,8 @@ import {buildComponentTree} from './buildComponentTree';
 export function buildPage(contentType: string, comps: PageComponent[] = []): PageComponent {
     const page: PageComponent = {
         type: XP_COMPONENT_TYPE.PAGE,
-        path: '/',
+        path: '/'
     };
 
     return buildComponentTree(comps, page, contentType);
-}
+}

package/src/guillotine/collectComponentDescriptors.ts

@@ -1,16 +1,9 @@
-import type {
-    ComponentDescriptor,
-    Context,
-    PageComponent,
-} from '../types';
+import type {ComponentDescriptor, Context, PageComponent} from '../types';
 
 
 import {ComponentRegistry} from '../common/ComponentRegistry';
 import {XP_COMPONENT_TYPE} from '../common/constants';
-import {
-    APP_NAME,
-    APP_NAME_DASHED,
-} from '../common/env';
+import {APP_NAME, APP_NAME_DASHED} from '../common/env';
 import {processComponentConfig} from './processComponentConfig';
 import {getComponentConfig} from './getComponentConfig';
 import {getQueryAndVariables} from './getQueryAndVariables';
@@ -19,7 +12,7 @@ import {getQueryAndVariables} from './getQueryAndVariables';
 export function collectComponentDescriptors({
     components,
     xpContentPath,
-    context,
+    context
 }: {
     components: PageComponent[]
     xpContentPath: string
@@ -42,7 +35,7 @@ export function collectComponentDescriptors({
                     descriptors.push({
                         component: cmp,
                         type: cmpDef,
-                        queryAndVariables: queryAndVariables,
+                        queryAndVariables: queryAndVariables
                     });
                 }
             }
@@ -51,7 +44,7 @@ export function collectComponentDescriptors({
             const fragPartDescs = collectComponentDescriptors({
                 components: cmp.fragment?.fragment?.components,
                 xpContentPath,
-                context,
+                context
             });
             if (fragPartDescs.length) {
                 descriptors.push(...fragPartDescs);
@@ -60,4 +53,4 @@ export function collectComponentDescriptors({
     }
 
     return descriptors;
-}
+}

package/src/guillotine/combineMultipleQueries.ts

@@ -1,7 +1,4 @@
-import type {
-    ComponentDescriptor,
-    QueryAndVariables,
-} from '../types';
+import type {ComponentDescriptor, QueryAndVariables} from '../types';
 
 
 const ALIAS_PREFIX = 'request';
@@ -70,6 +67,6 @@ export function combineMultipleQueries(queriesWithVars: ComponentDescriptor[]):
 
     return {
         query: superQuery,
-        variables: superVars,
+        variables: superVars
     };
-}
+}

package/src/guillotine/createMetaData.ts

@@ -17,7 +17,7 @@ export function createMetaData({
                                    pageCmp, // Optional
                                    renderMode,
                                    requestedComponentPath,
-                                   requestType,
+    requestType
                                }: {
     apiUrl: string
     baseUrl: string
@@ -46,7 +46,7 @@ export function createMetaData({
         path: contentPath,
         renderMode: renderMode,
         requestType: requestType,
-        type: contentType,
+        type: contentType
     };
 
     if (requestedComponentPath) {

package/src/guillotine/fetchContent.ts

@@ -2,13 +2,7 @@ import type {ComponentDescriptor, Context, FetchContentResult} from '../types';
 
 import {draftMode, headers} from 'next/headers';
 import {ComponentRegistry} from '../common/ComponentRegistry';
-import {
-    PAGE_TEMPLATE_CONTENTTYPE_NAME,
-    PAGE_TEMPLATE_FOLDER,
-    RENDER_MODE,
-    XP_COMPONENT_TYPE,
-    XP_REQUEST_TYPE,
-} from '../common/constants';
+import {PAGE_TEMPLATE_CONTENTTYPE_NAME, PAGE_TEMPLATE_FOLDER, RENDER_MODE, XP_COMPONENT_TYPE, XP_REQUEST_TYPE} from '../common/constants';
 import {APP_NAME, APP_NAME_DASHED, IS_DEV_MODE} from '../common/env';
 import {getContentApiUrl} from '../utils/getContentApiUrl';
 import {getLocaleMapping} from '../utils/getLocaleMapping';
@@ -59,7 +53,7 @@ export async function fetchContent(context: Context): Promise<FetchContentResult
         context,
         defaultLocale,
         locale,
-        locales,
+        locales
     });
     const xpBaseUrl = getXpBaseUrl(context);
     const contentApiUrl = getContentApiUrl(context);
@@ -129,7 +123,7 @@ export async function fetchContent(context: Context): Promise<FetchContentResult
         if (contentQueryAndVars) {
             allDescriptors.push({
                 type: contentTypeDef,
-                queryAndVariables: contentQueryAndVars,
+                queryAndVariables: contentQueryAndVars
             });
         }
 
@@ -138,7 +132,7 @@ export async function fetchContent(context: Context): Promise<FetchContentResult
         if (commonQueryAndVars) {
             allDescriptors.push({
                 type: contentTypeDef,
-                queryAndVariables: commonQueryAndVars,
+                queryAndVariables: commonQueryAndVars
             });
         }
 
@@ -150,7 +144,7 @@ export async function fetchContent(context: Context): Promise<FetchContentResult
             const componentDescriptors = collectComponentDescriptors({
                 components,
                 xpContentPath: contentPath,
-                context,
+                context
             });
             if (componentDescriptors.length) {
                 allDescriptors.push(...componentDescriptors);
@@ -219,14 +213,14 @@ export async function fetchContent(context: Context): Promise<FetchContentResult
             pageCmp: page,
             renderMode,
             requestedComponentPath: componentPath,
-            requestType,
+            requestType
         });
 
         return {
             data: contentData,
             common,
             meta,
-            page,
+            page
         };
     } catch (e: any) {
         console.error(e);
@@ -237,7 +231,7 @@ export async function fetchContent(context: Context): Promise<FetchContentResult
         } catch (e2) {
             error = {
                 code: 'Local',
-                message: e.message,
+                message: e.message
             };
         }
         const errorResponse = buildErrorResponse(requestType, renderMode, contentApiUrl, xpBaseUrl, locale, defaultLocale, requestContentPath);

package/src/guillotine/fetchContentData.ts

@@ -1,10 +1,4 @@
-import type {
-    ContentApiBaseBody,
-    ContentApiBaseBodyVariables,
-    ContentResult,
-    LocaleMapping,
-    GuillotineRequestHeaders,
-} from '../types';
+import type {ContentApiBaseBody, ContentApiBaseBodyVariables, ContentResult, LocaleMapping, GuillotineRequestHeaders} from '../types';
 
 import {fetchGuillotine} from './fetchGuillotine';
 
@@ -15,7 +9,7 @@ export const fetchContentData = async <Content = Record<string, unknown>>(
     mapping: LocaleMapping,
     query: string,
     variables?: ContentApiBaseBodyVariables,
-    headers?: GuillotineRequestHeaders,
+    headers?: GuillotineRequestHeaders
 ): Promise<ContentResult> => {
     const body: ContentApiBaseBody = {query};
     if (variables && Object.keys(variables).length > 0) {
@@ -23,7 +17,7 @@ export const fetchContentData = async <Content = Record<string, unknown>>(
     }
     const contentResults = await fetchGuillotine<ContentResult<Content>>(contentApiUrl, mapping, {
         body,
-        headers,
+        headers
     });
 
     if (contentResults.error) {
@@ -31,7 +25,7 @@ export const fetchContentData = async <Content = Record<string, unknown>>(
     } else {
         return {
             // omit the aliases and return values
-            contents: Object.values(contentResults),
+            contents: Object.values(contentResults)
         };
     }
 };

package/src/guillotine/fetchContentPathsForAllLocales.ts

@@ -8,12 +8,12 @@ import {fetchContentPathsForLocale} from './fetchContentPathsForLocale';
 export async function fetchContentPathsForAllLocales(
     path: string,
     query: string = GET_STATIC_PATHS_QUERY,
-    countPerLocale = 999,
+    countPerLocale = 999
 ): Promise<ContentPathItem[]> {
     const promises = Object.values(getLocaleMappings()).map(
         config => fetchContentPathsForLocale(
-            path, config, query, countPerLocale,
-        ),
+            path, config, query, countPerLocale
+        )
     );
     return Promise.all(promises).then(results => {
         return results.reduce((all, localePaths) => all.concat(localePaths), []);

package/src/guillotine/fetchContentPathsForLocale.ts

@@ -10,32 +10,32 @@ export async function fetchContentPathsForLocale(
     path: string,
     config: LocaleMapping,
     query: string = GET_STATIC_PATHS_QUERY,
-    count = 999,
+    count = 999
 ): Promise<ContentPathItem[]> {
     const contentApiUrl = getContentApiUrl({
         contentPath: path,
-        locale: config.locale,
+        locale: config.locale
     });
     const body: ContentApiBaseBody = {
         query,
         variables: {
             path,
             pathRegex: `/content${config.site}/*`,
-            count,
-        },
+            count
+        }
     };
     return fetchGuillotine<ContentPathItem[]>(contentApiUrl, config, {body}).then((
-        results: GuillotineResult,
+        results: GuillotineResult
     ) => {
         return results.guillotine.queryDsl.reduce((
             prev: ContentPathItem[],
-            child: any,
+            child: any
         ) => {
             const regexp = new RegExp(`^/${child.site?._name ? `${child.site._name}/?` : ''}`);
             const contentPath = child._path.replace(regexp, '');
             prev.push({
                 contentPath: contentPath.split('/'),
-                locale: config.locale,
+                locale: config.locale
             });
             return prev;
         }, []);

package/src/guillotine/fetchFromApi.ts

@@ -4,7 +4,7 @@ import type {FetchOptions, GuillotineResponse, GuillotineResponseJson, LocaleMap
 export async function fetchFromApi<Data = Record<string, unknown>>(
     apiUrl: string,
     mapping: LocaleMapping,
-    options?: FetchOptions,
+    options?: FetchOptions
 ): Promise<GuillotineResponseJson> {
 
     const opts = {
@@ -12,7 +12,7 @@ export async function fetchFromApi<Data = Record<string, unknown>>(
         body: options?.body ? JSON.stringify(options?.body) : null,
         headers: mergeHeaders(mapping, options?.headers),
         next: options?.next,
-        cache: options?.cache,
+        cache: options?.cache
     };
 
     let res: GuillotineResponse<Data>;
@@ -22,14 +22,14 @@ export async function fetchFromApi<Data = Record<string, unknown>>(
         console.warn(apiUrl, e);
         throw new Error(JSON.stringify({
             code: 'API',
-            message: e.message,
+            message: e.message
         }));
     }
 
     if (!res.ok) {
         throw new Error(JSON.stringify({
             code: res.status,
-            message: `Data fetching failed (message: '${await res.text()}')`,
+            message: `Data fetching failed (message: '${await res.text()}')`
         }));
     }
 
@@ -39,21 +39,21 @@ export async function fetchFromApi<Data = Record<string, unknown>>(
     } catch (e) {
         throw new Error(JSON.stringify({
             code: 500,
-            message: `API call completed but with non-JSON data: ${JSON.stringify(await res.text())}`,
+            message: `API call completed but with non-JSON data: ${JSON.stringify(await res.text())}`
         }));
     }
 
     if (!json) {
         throw new Error(JSON.stringify({
             code: 500,
-            message: `API call completed but with unexpectedly empty data: ${JSON.stringify(await res.text())}`,
+            message: `API call completed but with unexpectedly empty data: ${JSON.stringify(await res.text())}`
         }));
     }
 
     if (Array.isArray(json)) {
         throw new Error(JSON.stringify({
             code: 500,
-            message: `API call completed but with unexpected array data: ${JSON.stringify(json)}`,
+            message: `API call completed but with unexpected array data: ${JSON.stringify(json)}`
         }));
     }
 
@@ -63,7 +63,7 @@ export async function fetchFromApi<Data = Record<string, unknown>>(
 function mergeHeaders(mapping: LocaleMapping, headers?: HeadersInit): Headers {
     const newHeaders = new Headers({
         'Accept': 'application/json',
-        'Content-Type': 'application/json',
+        'Content-Type': 'application/json'
     });
     if (headers) {
         Object.keys(headers).forEach((headersKey) => {